001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software GmbH & Co. KG, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.workplace.tools.database;
029
030import org.opencms.jsp.CmsJspActionElement;
031import org.opencms.main.OpenCms;
032import org.opencms.report.I_CmsReportThread;
033import org.opencms.workplace.list.A_CmsListReport;
034import org.opencms.workplace.threads.CmsDatabaseImportThread;
035
036import javax.servlet.http.HttpServletRequest;
037import javax.servlet.http.HttpServletResponse;
038import javax.servlet.jsp.PageContext;
039
040/**
041 * Provides a report for importing zipped files or folder to the OpenCms VFS.<p>
042 *
043 * @since 6.0.0
044 */
045public class CmsDatabaseImportReport extends A_CmsListReport {
046
047    /** The keep permissions flag. */
048    private String m_keepPermissions;
049
050    /** Request parameter for the file name to import. */
051    private String m_paramFile;
052
053    /**
054     * Public constructor with JSP action element.<p>
055     *
056     * @param jsp an initialized JSP action element
057     */
058    public CmsDatabaseImportReport(CmsJspActionElement jsp) {
059
060        super(jsp);
061    }
062
063    /**
064     * Public constructor with JSP variables.<p>
065     *
066     * @param context the JSP page context
067     * @param req the JSP request
068     * @param res the JSP response
069     */
070    public CmsDatabaseImportReport(PageContext context, HttpServletRequest req, HttpServletResponse res) {
071
072        this(new CmsJspActionElement(context, req, res));
073    }
074
075    /**
076     * Returns the keepPermissions parameter.<p>
077     *
078     * @return the keepPermissions parameter
079     */
080    public String getKeepPermissions() {
081
082        return m_keepPermissions;
083    }
084
085    /**
086     * Returns the request parameter value for the file name to import.<p>
087     *
088     * @return the request parameter value for the file name to import
089     */
090    public String getParamFile() {
091
092        return m_paramFile;
093    }
094
095    /**
096     *
097     * @see org.opencms.workplace.list.A_CmsListReport#initializeThread()
098     */
099    @Override
100    public I_CmsReportThread initializeThread() {
101
102        String importFile = OpenCms.getSystemInfo().getPackagesRfsPath() + getParamFile();
103        boolean keepPermissions = Boolean.valueOf(getKeepPermissions()).booleanValue();
104
105        I_CmsReportThread importThread = new CmsDatabaseImportThread(getCms(), importFile, keepPermissions);
106
107        return importThread;
108    }
109
110    /**
111     * Sets the keepPermissions parameter.<p>
112     *
113     * @param keepPermissions the keepPermissions parameter
114     */
115    public void setKeepPermissions(String keepPermissions) {
116
117        m_keepPermissions = keepPermissions;
118    }
119
120    /**
121     * Sets the request parameter value for the file name to import.<p>
122     *
123     * @param file the request parameter value for the file name to import
124     */
125    public void setParamFile(String file) {
126
127        m_paramFile = file;
128    }
129
130    /**
131     * Sets the keepPermissions parameter.<p>
132     *
133     * @param keepPermissions the keepPermissions parameter
134     */
135    public void setParamKeepPermissions(String keepPermissions) {
136
137        setKeepPermissions(keepPermissions);
138    }
139
140}