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.threads;
029
030import org.opencms.db.CmsUserSettings;
031import org.opencms.file.CmsObject;
032import org.opencms.report.A_CmsReportThread;
033import org.opencms.report.I_CmsReport;
034import org.opencms.synchronize.CmsSynchronize;
035import org.opencms.synchronize.CmsSynchronizeSettings;
036
037/**
038 * Synchronizes a VFS folder with a folder form the "real" file system.<p>
039 *
040 * @since 6.0.0
041 */
042public class CmsSynchronizeThread extends A_CmsReportThread {
043
044    /** An error that occurred during the report. */
045    private Throwable m_error;
046
047    /** The current users synchonize settings. */
048    private CmsSynchronizeSettings m_settings;
049
050    /**
051     * Creates the synchronize Thread.<p>
052     *
053     * @param cms the current OpenCms context object
054     */
055    public CmsSynchronizeThread(CmsObject cms) {
056
057        super(
058            cms,
059            Messages.get().getBundle().key(
060                Messages.GUI_SYNCHRONIZE_THREAD_NAME_1,
061                cms.getRequestContext().getCurrentProject().getName()));
062        initHtmlReport(cms.getRequestContext().getLocale());
063        m_settings = new CmsUserSettings(cms).getSynchronizeSettings();
064    }
065
066    /**
067     * @see org.opencms.report.A_CmsReportThread#getError()
068     */
069    @Override
070    public Throwable getError() {
071
072        return m_error;
073    }
074
075    /**
076     * @see org.opencms.report.A_CmsReportThread#getReportUpdate()
077     */
078    @Override
079    public String getReportUpdate() {
080
081        return getReport().getReportUpdate();
082    }
083
084    /**
085     * @see java.lang.Runnable#run()
086     */
087    @Override
088    public void run() {
089
090        I_CmsReport report = getReport();
091
092        report.println(Messages.get().container(Messages.RPT_SYNCHRONIZE_BEGIN_0), I_CmsReport.FORMAT_HEADLINE);
093        try {
094            new CmsSynchronize(getCms(), m_settings, getReport());
095        } catch (Throwable e) {
096            m_error = e;
097            report.println(e);
098        }
099        report.println(Messages.get().container(Messages.RPT_SYNCHRONIZE_END_0), I_CmsReport.FORMAT_HEADLINE);
100    }
101}