cmslinkbrowser.java

cms是开源的框架

/*
* File   : $Source: /usr/local/cvs/opencms/src-modules/com/opencms/workplace/CmsLinkBrowser.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.CmsFile;
import org.opencms.file.CmsObject;
import org.opencms.file.CmsPropertyDefinition;
import org.opencms.file.CmsResource;
import org.opencms.i18n.CmsEncoder;
import org.opencms.main.CmsException;
import org.opencms.main.CmsLog;

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

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

/**
 * Template class for displaying OpenCms picture browser.
 * <P>
 * Reads template files of the content type <code>CmsXmlWpTemplateFile</code>.
 *
 * @author Edna Falkenhan
 * @version $Revision: 1.4 $ $Date: 2005/06/27 23:22:07 $
 * @see com.opencms.workplace.CmsXmlWpTemplateFile
 * 
 * @deprecated Will not be supported past the OpenCms 6 release.
 */

public class CmsLinkBrowser extends CmsWorkplaceDefault {

    /**
     * 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));
        }
        I_CmsSession session = CmsXmlTemplateLoader.getSession(cms.getRequestContext(), true);
        CmsXmlWpTemplateFile xmlTemplateDocument = (CmsXmlWpTemplateFile)getOwnTemplateFile(cms,
                templateFile, elementName, parameters, templateSelector);

        // test whether the links folder exists at all
        try {
            cms.readResource(CmsWorkplaceDefault.C_VFS_GALLERY_EXTERNALLINKS);
        } catch(CmsException e) {
            xmlTemplateDocument.setData("ERRORDETAILS", CmsException.getStackTraceAsString(e));
            templateSelector = "error";
        }
        if(!"error".equals(templateSelector)) {
            if(parameters.get(CmsWorkplaceDefault.C_PARA_INITIAL) != null) {
                session.removeValue(CmsWorkplaceDefault.C_PARA_FOLDER);
                session.removeValue("linkBrowser_for_ext_nav");
            }
            String setOnClick = (String)parameters.get("setonclick");
            if(setOnClick != null){
                session.putValue("linkBrowser_for_ext_nav", setOnClick);
            }
            setOnClick = (String)session.getValue("linkBrowser_for_ext_nav");
            String folder = (String)parameters.get(CmsWorkplaceDefault.C_PARA_FOLDER);
            if(folder != null) {
                session.putValue(CmsWorkplaceDefault.C_PARA_FOLDER, folder);
            }
            folder = (String)session.getValue(CmsWorkplaceDefault.C_PARA_FOLDER);
            if(folder == null || "".equals(folder)) {
                List galleries = cms.getSubFolders(CmsWorkplaceDefault.C_VFS_GALLERY_EXTERNALLINKS);
                if(galleries.size() > 0) {

                    // take the first gallery
                    folder = cms.getSitePath((CmsResource)galleries.get(0));
                    session.putValue(CmsWorkplaceDefault.C_PARA_FOLDER, folder);
                } else {

                    // there was a C_VFS_GALLERY_EXTERNALLINKS - folder but no galery in it
                    templateSelector = "error_no_gallery";
                }
            }
            if(!"error_no_gallery".equals(templateSelector)) {
                String pageText = (String)parameters.get(CmsWorkplaceDefault.C_PARA_PAGE);
                String filter = (String)parameters.get(CmsWorkplaceDefault.C_PARA_FILTER);

                // Check if the user requested a special page
                if(pageText == null || "".equals(pageText)) {
                    pageText = "1";
                    parameters.put(CmsWorkplaceDefault.C_PARA_PAGE, pageText);
                }

                // Check if the user requested a filter
                if(filter == null) {
                    filter = "";
                    parameters.put(CmsWorkplaceDefault.C_PARA_FILTER, filter);
                }

                // Compute the maximum page number
                Vector filteredLinks = getFilteredLinkList(cms, folder, filter);
                int maxpage = ((filteredLinks.size() - 1) / CmsWorkplaceDefault.C_PICBROWSER_MAXIMAGES) + 1;

                // Now set the appropriate datablocks
                xmlTemplateDocument.setData(CmsWorkplaceDefault.C_PARA_FOLDER, CmsEncoder.escape(folder,
                    cms.getRequestContext().getEncoding()));
                xmlTemplateDocument.setData(CmsWorkplaceDefault.C_PARA_PAGE, pageText);
                xmlTemplateDocument.setData(CmsWorkplaceDefault.C_PARA_FILTER, filter);
                xmlTemplateDocument.setData(CmsWorkplaceDefault.C_PARA_MAXPAGE, "" + maxpage);
                if(setOnClick == null || !"true".equals(setOnClick)){
                    xmlTemplateDocument.setData("setonclick", "");
                }else{
                    xmlTemplateDocument.setData("setonclick", "true");
                }
                parameters.put("_LINKLIST_", filteredLinks);
            }
        }

        // Start the processing
        return startProcessing(cms, xmlTemplateDocument, elementName, parameters, templateSelector);
    }

    /**
     * Internal method for getting a vector of all links using
     * a given filter.
     * @param cms Cms object for accessing system resources.
     * @param folder Folder to look for links.
     * @param filter Search pattern that should be used.
     * @return Vector of CmsFile objects.
     */

    protected Vector getFilteredLinkList(CmsObject cms, String folder, String filter) throws CmsException {

        // Get all links in the given folder using the cms object
        List allLinks = cms.getFilesInFolder(folder);

        // Filter the links
        Vector filteredLinks = new Vector();
        for(int i = 0;i < allLinks.size();i++) {
            CmsFile file = (CmsFile)allLinks.get(i);
            String filename = file.getName();
            String title = cms.readProperty(cms.getSitePath(file), CmsPropertyDefinition.PROPERTY_TITLE);
            boolean filenameFilter = inFilter(filename, filter);
            boolean titleFilter = ((title == null) || ("".equals(title))) ? false : inFilter(title, filter);
            if((filenameFilter || titleFilter)) {
                filteredLinks.addElement(file);
            }
        }
        return filteredLinks;
    }

    /**
     * Gets the filenames of all picture galleries
     * <P>
     * The given vectors <code>names</code> and <code>values</code> will
     * be filled with the appropriate information to be used for building
     * a select box. The values will be the paths to the galleries.
     *
     * @param cms CmsObject Object for accessing system resources.
     * @param names Vector to be filled with the appropriate values in this method.
     * @param values Vector to be filled with the appropriate values in this method.
     * @param parameters Hashtable containing all user parameters <em>(not used here)</em>.
     * @return Index of the selected Gallery