cmsfilelist.java

内容管理

/*
* File   : $Source: /usr/local/cvs/opencms/src/com/opencms/workplace/CmsFileList.java,v $
* Date   : $Date: 2003/03/02 18:43:54 $
* Version: $Revision: 1.60 $
*
* 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 com.opencms.core.CmsException;
import com.opencms.core.I_CmsConstants;
import com.opencms.core.I_CmsSession;
import com.opencms.file.CmsGroup;
import com.opencms.file.CmsObject;
import com.opencms.file.CmsResource;
import com.opencms.file.CmsUser;
import com.opencms.file.I_CmsResourceType;
import com.opencms.template.A_CmsXmlContent;
import com.opencms.util.Encoder;

import java.util.Calendar;
import java.util.Date;
import java.util.Enumeration;
import java.util.GregorianCalendar;
import java.util.Hashtable;
import java.util.Vector;

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.60 $ $Date: 2003/03/02 18:43:54 $
 * @see com.opencms.workplace.CmsXmlWpTemplateFile
 */

public class CmsFileList extends A_CmsWpElement implements I_CmsWpElement,I_CmsWpConstants,I_CmsConstants {


    /** 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 {
        boolean access = false;
        int accessflags = res.getAccessFlags();

        // First check if the user may have access by one of his groups.
        boolean groupAccess = false;
        Enumeration allGroups = cms.getGroupsOfUser(cms.getRequestContext().currentUser().getName()).elements();
        while((!groupAccess) && allGroups.hasMoreElements()) {
            groupAccess = cms.readGroup(res).equals((CmsGroup)allGroups.nextElement());
        }
        if(((accessflags & C_ACCESS_PUBLIC_VISIBLE) > 0) || (cms.readOwner(res).equals(cms.getRequestContext().currentUser()) && (accessflags & C_ACCESS_OWNER_VISIBLE) > 0) || (groupAccess && (accessflags & C_ACCESS_GROUP_VISIBLE) > 0) || (cms.getRequestContext().currentUser().getName().equals(C_USER_ADMIN))) {
            access = true;
        }
        return access;
    }

    /**
     * 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 & C_FILELIST_NAME) == 0) {
            template.setData(C_FILELIST_COLUMN_NAME + suffix, "");
        }
        if((filelist & C_FILELIST_TITLE) == 0) {
            template.setData(C_FILELIST_COLUMN_TITLE + suffix, "");
        }
        if((filelist & C_FILELIST_TYPE) == 0) {
            template.setData(C_FILELIST_COLUMN_TYPE + suffix, "");
        }
        if((filelist & C_FILELIST_STATE) == 0) {
            template.setData(C_FILELIST_COLUMN_STATE + suffix, "");
        }
        if((filelist & C_FILELIST_CHANGED) == 0) {
            template.setData(C_FILELIST_COLUMN_CHANGED + suffix, "");
        }
        if((filelist & C_FILELIST_SIZE) == 0) {
            template.setData(C_FILELIST_COLUMN_SIZE + suffix, "");
        }
        if((filelist & C_FILELIST_OWNER) == 0) {
            template.setData(C_FILELIST_COLUMN_OWNER + suffix, "");
        }
        if((filelist & C_FILELIST_GROUP) == 0) {
            template.setData(C_FILELIST_COLUMN_GROUP + suffix, "");
        }
        if((filelist & C_FILELIST_ACCESS) == 0) {
            template.setData(C_FILELIST_COLUMN_ACCESS + suffix, "");
        }
        if((filelist & C_FILELIST_LOCKED) == 0) {
            template.setData(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.
     */

    private String getAccessFlags(int access) {
        StringBuffer accessFlags = new StringBuffer();
        if((access & C_ACCESS_OWNER_READ) > 0) {
            accessFlags.append("r");
        }
        else {
            accessFlags.append("-");
        }
        if((access & C_ACCESS_OWNER_WRITE) > 0) {
            accessFlags.append("w");
        }
        else {
            accessFlags.append("-");
        }
        if((access & C_ACCESS_OWNER_VISIBLE) > 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");