cmsadminmoduleadmin.java

cms是开源的框架

/*
* File   : $Source: /usr/local/cvs/opencms/src-modules/com/opencms/workplace/CmsAdminModuleAdmin.java,v $
* Date   : $Date: 2005/06/27 23:22:07 $
* Version: $Revision: 1.4 $
*
* 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.file.CmsObject;
import org.opencms.file.types.CmsResourceTypeFolder;
import org.opencms.main.CmsException;
import org.opencms.main.CmsLog;
import org.opencms.main.OpenCms;
import org.opencms.module.CmsModule;
import org.opencms.module.CmsModuleDependency;
import org.opencms.module.CmsModuleVersion;
import org.opencms.util.CmsDateUtil;

import com.opencms.core.I_CmsSession;
import com.opencms.legacy.CmsXmlTemplateLoader;
import com.opencms.template.CmsXmlTemplateFile;

import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.Hashtable;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.StringTokenizer;
import java.util.Vector;

/**
 * Template class for displaying OpenCms workplace administration module administration.
 *
 * Creation date: (29.10.00 10:28:08)
 * @author Hanjo Riege
 * @author Thomas Weckert
 * 
 * @deprecated Will not be supported past the OpenCms 6 release.
 */
public class CmsAdminModuleAdmin extends CmsWorkplaceDefault {
    private final String C_FROM = "from";
    private final String C_VERSION = "version";
    private final String C_GROUP = "group";
    private final String C_MODULENAME = "modulename";
    private final String C_DESCRIPTION = "description";
    private final String C_MAINTENANCE = "maintenance";
    private final String C_PUBLISHCLASS = "publishclass";
    private final String C_AUTHOR = "author";
    private final String C_EMAIL = "email";
    private final String C_DATE = "date";
    private final String C_DEPENDENCY = "dependencies";
    private final String C_ALLDEPS = "alldeps";
    private final String C_ONEDEP = "dependentry";
    private final String C_OPTIONENTRY = "optionentry";
    private final String C_NAME_PARAMETER = "module";

    /**
     * fills the data from the module in the hashtable.
     * Creation date: (30.10.00 14:22:22)
     * @param param java.lang.String
     * @return java.util.Hashtable
     */
    private void fillHashtable(CmsObject cms, Hashtable table, String module) {
        table.put(CmsWorkplaceDefault.C_MODULE_PACKETNAME, module);
        table.put(C_VERSION, getStringValue(OpenCms.getModuleManager().getModule(module).getVersion().toString()));
        table.put(C_GROUP, getStringValue(OpenCms.getModuleManager().getModule(module).getGroup()));
        table.put(C_MODULENAME, getStringValue(OpenCms.getModuleManager().getModule(module).getNiceName()));
        table.put(C_DESCRIPTION, getStringValue(OpenCms.getModuleManager().getModule(module).getDescription()));
        table.put(C_MAINTENANCE, getStringValue(OpenCms.getModuleManager().getModule(module).getActionClass()));
        table.put(C_PUBLISHCLASS, getStringValue(OpenCms.getModuleManager().getModule(module).getActionClass()));
        table.put(C_AUTHOR, getStringValue(OpenCms.getModuleManager().getModule(module).getAuthorName()));
        table.put(C_EMAIL, getStringValue(OpenCms.getModuleManager().getModule(module).getAuthorEmail()));
        table.put(C_DATE, getStringValue(CmsDateUtil.getDateShort(OpenCms.getModuleManager().getModule(module).getDateCreated())));

        // get the dependencies
        Vector stringDeps = new Vector();
        List moduleDependencies = OpenCms.getModuleManager().getModule(module).getDependencies();
        for (int i=0; i<moduleDependencies.size(); i++) {
            CmsModuleDependency dep = (CmsModuleDependency)moduleDependencies.get(i);
            stringDeps.addElement(dep.getName() + "  Version:" + dep.getVersion() + " - *");
        }
        table.put(C_DEPENDENCY, stringDeps);

        // handle the properties
        Vector paraNames = new Vector();
        Vector paraDescr = new Vector();
        Vector paraTyp = new Vector();
        Vector paraVal = new Vector();
        Map params = OpenCms.getModuleManager().getModule(module).getParameters();
        Iterator it = params.keySet().iterator();
        while(it.hasNext()) {
            String key = (String)it.next();
            String value = (String)params.get(key);
            paraNames.addElement(key);
            paraDescr.addElement("");
            paraVal.addElement(getStringValue(value));
            paraTyp.addElement("");
        }
        table.put(CmsWorkplaceDefault.C_SESSION_MODULE_ADMIN_PROP_NAMES, paraNames);
        table.put(CmsWorkplaceDefault.C_SESSION_MODULE_ADMIN_PROP_DESCR, paraDescr);
        table.put(CmsWorkplaceDefault.C_SESSION_MODULE_ADMIN_PROP_TYP, paraTyp);
        table.put(CmsWorkplaceDefault.C_SESSION_MODULE_ADMIN_PROP_VAL, paraVal);        
    }

    /**
     * Gets the content of a defined section in a given template file and its subtemplates
     * with the given parameters.
     *
     * @see #getContent(CmsObject, String, String, Hashtable, String)
     * @param cms CmsObject Object for accessing system resources.
     * @param templateFile Filename of the template file.
     * @param elementName Element name of this template in our parent template.
     * @param parameters Hashtable with all template class parameters.
     * @param templateSelector template section that should be processed.
     */
    public byte[] getContent(CmsObject cms, String templateFile, String elementName, Hashtable parameters, String templateSelector) throws CmsException {
        if(CmsLog.getLog(this).isDebugEnabled() && C_DEBUG) {
            CmsLog.getLog(this).debug("Getting content of element " + ((elementName==null)?"<root>":elementName));
            CmsLog.getLog(this).debug("Template file is: " + templateFile);
            CmsLog.getLog(this).debug("Selected template section is: " + ((templateSelector==null)?"<default>":templateSelector));
        }
        CmsXmlTemplateFile templateDocument = getOwnTemplateFile(cms, templateFile, elementName, parameters, templateSelector);
        I_CmsSession session = CmsXmlTemplateLoader.getSession(cms.getRequestContext(), true);
        String stepTo = "";
        String from = (String)parameters.get(C_FROM);
        String packetName = (String)parameters.get(C_NAME_PARAMETER);
        Hashtable sessionData = new Hashtable();
        if((from == null) || "".equals(from)) {

            // first call; clear session
            session.removeValue(CmsWorkplaceDefault.C_SESSION_MODULE_ADMIN_DATA);
            fillHashtable(cms, sessionData, packetName);
            session.putValue(CmsWorkplaceDefault.C_SESSION_MODULE_ADMIN_DATA, sessionData);
            stepTo = "firstpage";
        }else {
            sessionData = (Hashtable)session.getValue(CmsWorkplaceDefault.C_SESSION_MODULE_ADMIN_DATA);
            if("first".equals(from)) {

                //  put the data in the session
                sessionData.put(C_VERSION, getStringValue((String)parameters.get(C_VERSION)));
                sessionData.put(C_MODULENAME, getStringValue((String)parameters.get(C_MODULENAME)));
                sessionData.put(C_DESCRIPTION, getStringValue((String)parameters.get(C_DESCRIPTION)));
                sessionData.put(C_MAINTENANCE, getStringValue((String)parameters.get(C_MAINTENANCE)));
                sessionData.put(C_PUBLISHCLASS, getStringValue((String)parameters.get(C_PUBLISHCLASS)));
                sessionData.put(C_AUTHOR, getStringValue((String)parameters.get(C_AUTHOR)));
                sessionData.put(C_EMAIL, getStringValue((String)parameters.get(C_EMAIL)));
                sessionData.put(C_DATE, getStringValue((String)parameters.get(C_DATE)));
    
                session.putValue(CmsWorkplaceDefault.C_SESSION_MODULE_ADMIN_DATA, sessionData);
                stepTo = "deps";
            }
            if("deps".equals(from)) {

                // put the data in the session
                String allData = (String)parameters.get(C_ALLDEPS);
                Vector allDeps = new Vector();
                allDeps = parseAllDeps(getStringValue(allData));
                sessionData.put(C_DEPENDENCY, allDeps);
                session.putValue(CmsWorkplaceDefault.C_SESSION_MODULE_ADMIN_DATA, sessionData);

                // decide if we are going back or forward => set stepTo
                String back = (String)parameters.get("back");
                if((back == null) || ("".equals(back))) {
                    stepTo = "props";
                }
                else {
                    stepTo = "firstpage";
                }
            }
            if("props".equals(from)) {
                stepTo = "deps";
            }