cmsfilelist.java

cms是开源的框架

/*
* File   : $Source: /usr/local/cvs/opencms/src-modules/com/opencms/workplace/CmsFileList.java,v $
* Date   : $Date: 2005/06/27 23:22:07 $
* Version: $Revision: 1.3 $
*
* This library is part of OpenCms -
* the Open Source Content Mananagement System
*
* Copyright (C) 2001  The OpenCms Group
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
* Lesser General Public License for more details.
*
* For further information about OpenCms, please see the
* OpenCms Website: http://www.opencms.org 
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/


package com.opencms.workplace;

import org.opencms.db.CmsUserSettings;
import org.opencms.file.CmsObject;
import org.opencms.file.CmsPropertyDefinition;
import org.opencms.file.CmsResource;
import org.opencms.file.types.I_CmsResourceType;
import org.opencms.i18n.CmsEncoder;
import org.opencms.lock.CmsLock;
import org.opencms.main.CmsException;
import org.opencms.main.OpenCms;
import org.opencms.security.CmsPermissionSet;
import org.opencms.util.CmsUUID;
import org.opencms.workplace.CmsWorkplace;

import com.opencms.legacy.CmsLegacyException;
import com.opencms.legacy.CmsXmlTemplateLoader;
import com.opencms.template.A_CmsXmlContent;

import java.util.Calendar;
import java.util.Date;
import java.util.GregorianCalendar;
import java.util.Hashtable;
import java.util.Iterator;
import java.util.List;

import org.w3c.dom.Element;

/**
 * Class for building a file list. <BR>
 * Called by CmsXmlTemplateFile for handling the special XML tag <code>&lt;FILELIST&gt;</code>.
 * <P>
 * Any template class using the workplace filelist has to implement <code>I_CmsFileListUsers</code>.
 * The given argument <code>callingObject</code> will be checked for this implementation
 * before starting to generate the file list. See <code>I_CmsFileListUsers</code> for
 * more details.
 *
 * @author Michael Emmerich
 * @author Alexander Lucas
 * @author Mario Stanke
 * @version $Revision: 1.3 $ $Date: 2005/06/27 23:22:07 $
 * @see com.opencms.workplace.CmsXmlWpTemplateFile
 * 
 * @deprecated Will not be supported past the OpenCms 6 release.
 */

public class CmsFileList extends A_CmsWpElement {


    /** The head of the file list */
    private final static String C_LIST_HEAD = "list_head";


    /** The entry of the file list */
    private final static String C_LIST_ENTRY = "list_entry";


    /** The lockedby value column */
    private final static String C_LOCKED_VALUE_NOLOCK = "column_lock_value_nolock";


    /** The lockedby value column */
    private final static String C_LOCKED_VALUE_OWN = "column_lock_value_own";


    /** The lockedby value column */
    private final static String C_LOCKED_VALUE_USER = "column_lock_value_user";


    /** The name value column */
    private final static String C_NAME_VALUE_FILE = "column_name_value_file";


    /** The name value column */
    private final static String C_NAME_VALUE_FOLDER = "column_name_value_folder";


    /** The lockedby key */
    private final static String C_LOCKEDBY = "lockedby";


    /** The filefolder key */
    private final static String C_NAME_FILEFOLDER = "name_filefolder";


    /** The style for unchanged files or folders */
    private final static String C_STYLE_UNCHANGED = "dateingeandert";


    /** The style for files or folders not in project*/
    private final static String C_STYLE_NOTINPROJECT = "dateintprojekt";


    /** The style for new files or folders */
    private final static String C_STYLE_NEW = "dateineu";


    /** The style for deleted files or folders */
    private final static String C_STYLE_DELETED = "dateigeloescht";


    /** The style for changed files or folders */
    private final static String C_STYLE_CHANGED = "dateigeaendert";


    /** The default context menu */
    private final static String C_DEFAULT_CONTEXTMENU = "online";


    /** The default context menu */
    private final static String C_DEFAULT_CONTEXTMENUFOLDER = "onlinefolder";


    /** The context link */
    private final static String C_CONTEXT_LINK = "context_link";


    /** The context menu */
    private final static String C_CONTEXT_MENU = "context_menu";


    /** The context menu number */
    private final static String C_CONTEXT_NUMBER = "context_number";


    /** The context menu postfix for lock*/
    private final static String C_CONTEXT_LOCK = "lock";


    /** The context menu postfix for lock user*/
    private final static String C_CONTEXT_LOCKUSER = "user";


    /** Storage for caching icons */
    private Hashtable m_iconCache = new Hashtable();

    /**
     * Check if this resource should be displayed in the filelist.
     * @param cms The CmsObject
     * @param res The resource to be checked.
     * @return True or false.
     * @throws CmsException if something goes wrong.
     */

    private boolean checkAccess(CmsObject cms, CmsResource res) throws CmsException {

		return cms.hasPermissions(res, CmsPermissionSet.ACCESS_VIEW);
		
    }

    /**
     * Checks which columns in the file list must be displayed.
     * Tests which flags in the user preferences are NOT set and delete those columns in
     * the table generating the file list.
     * @param filelist The filelist flags of the user.
     * @param template The file list template
     * @return Updated file list template.
     */

    private CmsXmlWpTemplateFile checkDisplayedColumns(int filelist,
            CmsXmlWpTemplateFile template, String suffix) {
        if((filelist & CmsUserSettings.FILELIST_NAME) == 0) {
            template.setData(CmsWorkplaceDefault.C_FILELIST_COLUMN_NAME + suffix, "");
        }
        if((filelist & CmsUserSettings.FILELIST_TITLE) == 0) {
            template.setData(CmsWorkplaceDefault.C_FILELIST_COLUMN_TITLE + suffix, "");
        }
        if((filelist & CmsUserSettings.FILELIST_TYPE) == 0) {
            template.setData(CmsWorkplaceDefault.C_FILELIST_COLUMN_TYPE + suffix, "");
        }
        if((filelist & CmsUserSettings.FILELIST_STATE) == 0) {
            template.setData(CmsWorkplaceDefault.C_FILELIST_COLUMN_STATE + suffix, "");
        }
        if((filelist & CmsUserSettings.FILELIST_DATE_LASTMODIFIED) == 0) {
            template.setData(CmsWorkplaceDefault.C_FILELIST_COLUMN_CHANGED + suffix, "");
        }
        if((filelist & CmsUserSettings.FILELIST_SIZE) == 0) {
            template.setData(CmsWorkplaceDefault.C_FILELIST_COLUMN_SIZE + suffix, "");
        }
        if((filelist & CmsUserSettings.FILELIST_USER_CREATED) == 0) {
            template.setData(CmsWorkplaceDefault.C_FILELIST_COLUMN_OWNER + suffix, "");
        }
        if((filelist & CmsWorkplaceDefault.C_FILELIST_GROUP) == 0) {
            template.setData(CmsWorkplaceDefault.C_FILELIST_COLUMN_GROUP + suffix, "");
        }
        if((filelist & CmsUserSettings.FILELIST_PERMISSIONS) == 0) {
            template.setData(CmsWorkplaceDefault.C_FILELIST_COLUMN_ACCESS + suffix, "");
        }
        if((filelist & CmsUserSettings.FILELIST_LOCKEDBY) == 0) {
            template.setData(CmsWorkplaceDefault.C_FILELIST_COLUMN_LOCKED + suffix, "");
        }
        return template;
    }

    /**
     * Gets a formated access right string form a int access value.
     * @param time The access value as an int.
     * @return Formated access right string.
     */
    // TODO: cw remove after switch to acl
    /*
    private String getAccessFlags(int access) {
        StringBuffer accessFlags = new StringBuffer();
        if((access & C_PERMISSION_READ) > 0) {
            accessFlags.append("r");
        }
        else {
            accessFlags.append("-");
        }
        if((access & C_PERMISSION_WRITE) > 0) {
            accessFlags.append("w");
        }
        else {
            accessFlags.append("-");
        }
        if((access & C_PERMISSION_VIEW) > 0) {
            accessFlags.append("v");
        }
        else {
            accessFlags.append("-");
        }
        if((access & C_ACCESS_GROUP_READ) > 0) {
            accessFlags.append("r");
        }
        else {
            accessFlags.append("-");
        }
        if((access & C_ACCESS_GROUP_WRITE) > 0) {
            accessFlags.append("w");
        }
        else {
            accessFlags.append("-");
        }
        if((access & C_ACCESS_GROUP_VISIBLE) > 0) {
            accessFlags.append("v");
        }
        else {
            accessFlags.append("-");
        }
        if((access & C_ACCESS_PUBLIC_READ) > 0) {
            accessFlags.append("r");
        }
        else {
            accessFlags.append("-");
        }
        if((access & C_ACCESS_PUBLIC_WRITE) > 0) {
            accessFlags.append("w");
        }
        else {
            accessFlags.append("-");
        }
        if((access & C_ACCESS_PUBLIC_VISIBLE) > 0) {
            accessFlags.append("v");
        }
        else {
            accessFlags.append("-");
        }
        if((access & C_ACCESS_INTERNAL_READ) > 0) {
            accessFlags.append("i");
        }
        else {
            accessFlags.append("-");
        }
        return accessFlags.toString();
    }
	*/
    /**
     * Selects the context menue displayed for this entry iin the file list.