cmsadminmoduleproperties.java

内容管理

/*
* File   : $Source: /usr/local/cvs/opencms/src/com/opencms/workplace/CmsAdminModuleProperties.java,v $
* Date   : $Date: 2003/01/20 23:59:19 $
* Version: $Revision: 1.9 $
*
* 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.boot.I_CmsLogChannels;
import com.opencms.core.A_OpenCms;
import com.opencms.core.CmsException;
import com.opencms.core.I_CmsConstants;
import com.opencms.core.I_CmsSession;
import com.opencms.file.CmsObject;
import com.opencms.file.I_CmsRegistry;
import com.opencms.template.CmsXmlTemplateFile;
import com.opencms.util.Utils;

import java.util.Hashtable;
import java.util.Vector;

/**
 * Template class for displaying the properties of a module.
 * Creation date: (07.09.00 11:30:26)
 * @author Hanjo Riege
 */
public class CmsAdminModuleProperties extends CmsWorkplaceDefault implements I_CmsConstants {
    
    /**
     * the different template views.
     */
    private final String C_DESCRIPTION = "description";
    private final String C_VIEW = "view";
    private final String C_MODULENAME = "module";
    private final String C_PARAMETER = "parameter";
    private final String C_CHANGE_PARAMETER = "changeparameter";
    private final String C_NEW_VALUE = "newvalue";
    private final String C_FROMERRORPAGE = "fromerrorpage";
    
    // sessionentry
    private final String C_SESSION_MODULENAME = "modulename_error";
    private final String C_SESSION_PARAMETER = "moduleparameter_error";
    
    /**
     *  Checks if the type of the value is correct and returns the converted value or null.
     *  @param type the type that the value should have..
     *  @param value the value to check.
     */
    private String checkType(String type, String value) {
        type = type.toLowerCase();
        try {
            if("string".equals(type)) {
                if((value != null) && (value.indexOf("\"") < 0)) {
                    return value;
                }
                else {
                    return null;
                }
            }
            else {
                if("int".equals(type) || "integer".equals(type)) {
                    value = "" + Integer.parseInt(value);
                    return value;
                }
                else {
                    if("float".equals(type)) {
                        value = "" + Float.valueOf(value);
                        return value;
                    }
                    else {
                        if("boolean".equals(type)) {
                            value = "" + Boolean.valueOf(value);
                            return value;
                        }
                        else {
                            if("long".equals(type)) {
                                value = "" + Long.valueOf(value);
                                return value;
                            }
                            else {
                                if("double".equals(type)) {
                                    value = "" + Double.valueOf(value);
                                    return value;
                                }
                                else {
                                    if("byte".equals(type)) {
                                        value = "" + Byte.valueOf(value);
                                        return value;
                                    }
                                    else {
                                        
                                        // the type dosen't exist
                                        return null;
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
        catch(Exception exc) {
            
            // the type of the value was wrong
            return null;
        }
    }
    
    /**
     * 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(I_CmsLogChannels.C_PREPROCESSOR_IS_LOGGING && A_OpenCms.isLogging() && C_DEBUG) {
            A_OpenCms.log(C_OPENCMS_DEBUG, this.getClassName() + "getting content of element " + ((elementName == null) ? "<root>" : elementName));
            A_OpenCms.log(C_OPENCMS_DEBUG, this.getClassName() + "template file is: " + templateFile);
            A_OpenCms.log(C_OPENCMS_DEBUG, this.getClassName() + "selected template section is: " + ((templateSelector == null) ? "<default>" : templateSelector));
        }
        CmsXmlTemplateFile xmlTemplateDocument = getOwnTemplateFile(cms, templateFile, elementName, parameters, templateSelector);
        I_CmsSession session = cms.getRequestContext().getSession(true);
        I_CmsRegistry reg = cms.getRegistry();
        String view = (String)parameters.get(C_VIEW);
        String module = (String)parameters.get(C_MODULENAME);
        if((view != null) && (C_DESCRIPTION.equals(view))) {
            
            // set the values in the template "description"
            xmlTemplateDocument.setData("name", module);
            xmlTemplateDocument.setData("version", "" + reg.getModuleVersion(module));
            xmlTemplateDocument.setData("descriptiontext", reg.getModuleDescription(module));
            xmlTemplateDocument.setData("author", reg.getModuleAuthor(module));
            xmlTemplateDocument.setData("email", reg.getModuleAuthorEmail(module));
            xmlTemplateDocument.setData("createdate", Utils.getNiceDate(reg.getModuleCreateDate(module)));
            xmlTemplateDocument.setData("uploadfrom", reg.getModuleUploadedBy(module));
            xmlTemplateDocument.setData("uploaddate", Utils.getNiceDate(reg.getModuleUploadDate(module)));
            xmlTemplateDocument.setData("view", reg.getModuleViewName(module));
            String docu = reg.getModuleDocumentPath(module);
            if((docu != null) && (docu.length() > 1)) {
                xmlTemplateDocument.setData("documentation", docu.substring(1));
            }
            else {
                xmlTemplateDocument.setData("documentation", "");
            }
            Vector depNames = new Vector();
            Vector minVersion = new Vector();
            Vector maxVersion = new Vector();
            int deps = reg.getModuleDependencies(module, depNames, minVersion, maxVersion);
            String dependences = "";
            for(int i = 0;i < deps;i++) {
                String max = (String)maxVersion.elementAt(i);
                if("-1".equals(max)) {
                    dependences += (String)depNames.elementAt(i) + "  " + (String)minVersion.elementAt(i) + " - " + "*" + "\n";
                }
                else {
                    dependences += (String)depNames.elementAt(i) + "  " + (String)minVersion.elementAt(i) + " - " + max + "\n";
                }
            }
            xmlTemplateDocument.setData("dependences", dependences);
            String[] repositorys = reg.getModuleRepositories(module);
            String outputRep = "";
            for(int i = 0;i < repositorys.length;i++) {
                outputRep += repositorys[i] + "\n";
            }
            xmlTemplateDocument.setData("repository", outputRep);
            
            // set the correct templateselector
            templateSelector = C_DESCRIPTION;
        }
        else {
            if((view != null) && (C_PARAMETER.equals(view))) {
                
                // set the values in the template "parameter"
                xmlTemplateDocument.setData("name", module);
                xmlTemplateDocument.setData("version", "" + reg.getModuleVersion(module));
                String[] parameterNames = reg.getModuleParameterNames(module);
                String allParameter = "";
                for(int i = 0;i < parameterNames.length;i++) {
                    xmlTemplateDocument.setData("paraname", parameterNames[i]);
                    xmlTemplateDocument.setData("paravalue", reg.getModuleParameter(module, parameterNames[i]));
                    allParameter += xmlTemplateDocument.getProcessedDataValue("parameterentry");
                }
                xmlTemplateDocument.setData("allparameter", allParameter);
                
                // set the correct templateselector
                templateSelector = C_PARAMETER;
            }
            else {
                if((view != null) && (C_CHANGE_PARAMETER.equals(view))) {
                    
                    // set the values in the template "changeparameter"
                    String parameter = (String)parameters.get("selectpara");
                    String fromError = (String)parameters.get(C_FROMERRORPAGE);
                    if(fromError != null) {
                        module = (String)session.getValue(C_SESSION_MODULENAME);
                        parameter = (String)session.getValue(C_SESSION_PARAMETER);
                        session.removeValue(C_SESSION_MODULENAME);
                        session.removeValue(C_SESSION_PARAMETER);
                    }
                    xmlTemplateDocument.setData("name", module);
                    xmlTemplateDocument.setData("version", "" + reg.getModuleVersion(module));
                    xmlTemplateDocument.setData("paraname", parameter);
                    xmlTemplateDocument.setData("paratext", reg.getModuleParameterDescription(module, parameter));
                    xmlTemplateDocument.setData("paratype", reg.getModuleParameterType(module, parameter));
                    xmlTemplateDocument.setData("paravalue", reg.getModuleParameter(module, parameter));
                    
                    // set the correct templateselector
                    templateSelector = C_CHANGE_PARAMETER;
                }
                else {
                    if((view != null) && (C_NEW_VALUE.equals(view))) {
                        
                        // Now we can finaly change the value.
                        String parameter = (String)parameters.get("parameter");
                        String value = (String)parameters.get("parawert");
                        xmlTemplateDocument.setData("name", module);
                        templateSelector = "done";
                        String newValue = checkType(reg.getModuleParameterType(module, parameter), value);
                        if(newValue != null) {
                            reg.setModuleParameter(module, parameter, newValue);
                        }
                        else {
                            
                            // wrong value
                            session.putValue(C_SESSION_MODULENAME, module);
                            session.putValue(C_SESSION_PARAMETER, parameter);
                            templateSelector = "error";
                            xmlTemplateDocument.setData("paraname", parameter);
                            xmlTemplateDocument.setData("DETAILS", "");
                        }
                    }
                }
            }
        }
        
        // Now load the template file and start the processing
        return startProcessing(cms, xmlTemplateDocument, elementName, parameters, templateSelector);
    }
    
    /**
     * Indicates if the results of this class are cacheable.
     * 
     * @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.
     * @return <EM>true</EM> if cacheable, <EM>false</EM> otherwise.
     */
    public boolean isCacheable(CmsObject cms, String templateFile, String elementName, Hashtable parameters, String templateSelector) {
        return false;
    }
}