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, 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.ui.apps.filehistory;
029
030import org.opencms.main.OpenCms;
031import org.opencms.report.A_CmsReportThread;
032import org.opencms.ui.A_CmsUI;
033import org.opencms.ui.CmsVaadinUtils;
034import org.opencms.ui.apps.Messages;
035import org.opencms.ui.components.CmsDateField;
036import org.opencms.ui.report.CmsReportWidget;
037import org.opencms.util.CmsStringUtil;
038
039import java.util.ArrayList;
040import java.util.List;
041
042import com.vaadin.ui.Button;
043import com.vaadin.ui.Button.ClickEvent;
044import com.vaadin.ui.Button.ClickListener;
045import com.vaadin.ui.Panel;
046import com.vaadin.v7.shared.ui.label.ContentMode;
047import com.vaadin.v7.ui.AbstractSelect.NewItemHandler;
048import com.vaadin.v7.ui.ComboBox;
049import com.vaadin.v7.ui.Label;
050import com.vaadin.v7.ui.OptionGroup;
051import com.vaadin.v7.ui.VerticalLayout;
052
053/**
054 * Class for the clear file history dialog and execution.<p>
055 */
056public class CmsFileHistoryClear extends VerticalLayout {
057
058    /**vaadin serial id.*/
059    private static final long serialVersionUID = 1484327372474823882L;
060
061    /**Option for maximal count of versions.*/
062    private static final int VERSIONS_MAX = 50;
063
064    /**Vaadin component.*/
065    ComboBox m_numberVersionsToKeep;
066
067    /**Vaadin component.*/
068    private CmsDateField m_dateField;
069
070    /**Vaadin component.*/
071    private OptionGroup m_mode;
072
073    /**Vaadin component.*/
074    private Button m_ok;
075
076    /**Vaadin component.*/
077    private Panel m_optionPanel;
078
079    /**Vaadin component.*/
080    private Panel m_reportPanel;
081
082    /**Vaadin component.*/
083    private Label m_settedVersions;
084
085    /**
086     * public constructor.<p>
087     *
088     * @param app instance of calling app
089     */
090    public CmsFileHistoryClear(final CmsFileHistoryClearApp app) {
091
092        CmsVaadinUtils.readAndLocalizeDesign(this, CmsVaadinUtils.getWpMessagesForCurrentLocale(), null);
093
094        //Setup ui components
095        setupVersionSettingsLabel();
096        setupVersionsToKeepComboBox();
097        setupModeOptions();
098
099        m_ok.addClickListener(new ClickListener() {
100
101            private static final long serialVersionUID = -6314367378702836242L;
102
103            public void buttonClick(ClickEvent event) {
104
105                startCleanAndShowReport();
106            }
107        });
108    }
109
110    /**
111     * Starts the clean thread and shows the report.<p>
112     * Hides other formular elements, except for cancel button.<p>
113     */
114    void startCleanAndShowReport() {
115
116        //Start clean process in thread
117        A_CmsReportThread thread = startThread();
118
119        //Update UI
120        m_optionPanel.setVisible(false);
121        m_reportPanel.setVisible(true);
122
123        CmsReportWidget report = new CmsReportWidget(thread);
124        report.setWidth("100%");
125        report.setHeight("700px");
126
127        m_reportPanel.setContent(report);
128
129        m_ok.setEnabled(false);
130    }
131
132    /**
133     * Sets up the OptionGroup for the mode for deleted resources.<p>
134     */
135    private void setupModeOptions() {
136
137        int versionsDeleted = OpenCms.getSystemInfo().getHistoryVersionsAfterDeletion();
138
139        String mode;
140
141        if (versionsDeleted == 0) {
142            mode = CmsFileHistoryApp.MODE_DISABLED;
143        } else if (versionsDeleted == 1) {
144            mode = CmsFileHistoryApp.MODE_WITHOUTVERSIONS;
145        } else if ((versionsDeleted > 1) || (versionsDeleted == -1)) {
146            mode = CmsFileHistoryApp.MODE_WITHVERSIONS;
147        } else {
148            mode = CmsFileHistoryApp.MODE_DISABLED;
149        }
150        m_mode.setValue(mode);
151    }
152
153    /**
154     * Sets the label showing maximal version number from settings.<p>
155     */
156    private void setupVersionSettingsLabel() {
157
158        int numberHistoryVersions = OpenCms.getSystemInfo().getHistoryVersions();
159
160        //Convert int number to readable Text
161        String numberString = String.valueOf(numberHistoryVersions);
162        if (numberHistoryVersions == CmsFileHistoryApp.NUMBER_VERSIONS_DISABLED) {
163            numberString = CmsVaadinUtils.getMessageText(Messages.GUI_FILEHISTORY_SETTINGS_VERSIONS_DISABLED_0);
164        }
165        if (numberHistoryVersions == CmsFileHistoryApp.NUMBER_VERSIONS_UNLIMITED) {
166            numberString = CmsVaadinUtils.getMessageText(Messages.GUI_FILEHISTORY_SETTINGS_VERSIONS_UNLIMITED_0);
167        }
168        m_settedVersions.setContentMode(ContentMode.HTML);
169        m_settedVersions.setValue(
170            CmsVaadinUtils.getMessageText(Messages.GUI_FILEHISTORY_DELETE_VERSIONINFO_1, numberString));
171    }
172
173    /**
174     * Sets up the combo box for the amount of versions to keep.<p>
175     */
176    private void setupVersionsToKeepComboBox() {
177
178        final List<Integer> items = new ArrayList<Integer>();
179
180        //Add default values to ComboBox
181        for (int i = 0; i < 10; i++) {
182            m_numberVersionsToKeep.addItem(new Integer(i));
183            items.add(new Integer(i));
184        }
185        for (int i = 10; i <= VERSIONS_MAX; i += 5) {
186            m_numberVersionsToKeep.addItem(new Integer(i));
187            items.add(new Integer(i));
188        }
189        m_numberVersionsToKeep.setPageLength(m_numberVersionsToKeep.size());
190        m_numberVersionsToKeep.setNullSelectionAllowed(false);
191        m_numberVersionsToKeep.setTextInputAllowed(true);
192
193        //Alow user to enter other values
194        m_numberVersionsToKeep.setNewItemsAllowed(true);
195        m_numberVersionsToKeep.setNewItemHandler(new NewItemHandler() {
196
197            private static final long serialVersionUID = -1962380117946789444L;
198
199            public void addNewItem(String newItemCaption) {
200
201                int num = CmsStringUtil.getIntValue(newItemCaption, -1, "user entered version number is not a number");
202                if ((num > 1) && !items.contains(new Integer(num))) {
203                    m_numberVersionsToKeep.addItem(new Integer(num));
204                    m_numberVersionsToKeep.select(new Integer(num));
205                }
206            }
207        });
208
209        //Select the value which correspons to current history setting.
210        int numberHistoryVersions = OpenCms.getSystemInfo().getHistoryVersions();
211        if (numberHistoryVersions == CmsFileHistoryApp.NUMBER_VERSIONS_DISABLED) {
212            numberHistoryVersions = 0;
213        }
214        if (numberHistoryVersions == CmsFileHistoryApp.NUMBER_VERSIONS_UNLIMITED) {
215            numberHistoryVersions = VERSIONS_MAX;
216        }
217        m_numberVersionsToKeep.select(new Integer(numberHistoryVersions));
218    }
219
220    /**
221     * Starts the thread for deleting versions.<p>
222     *
223     * @return started thread
224     */
225    private A_CmsReportThread startThread() {
226
227        //Maximal count of versions for current resources.
228        int versions = ((Integer)m_numberVersionsToKeep.getValue()).intValue();
229
230        //Maximal count of versions for deleted resources.
231        int versionsDeleted = versions;
232
233        if (m_mode.getValue().equals(CmsFileHistoryApp.MODE_DISABLED)) {
234            versionsDeleted = 0;
235        }
236        if (m_mode.getValue().equals(CmsFileHistoryApp.MODE_WITHOUTVERSIONS)) {
237            versionsDeleted = 1;
238        }
239
240        long date = m_dateField.getValue() != null ? m_dateField.getDate().getTime() : 0;
241
242        CmsHistoryClearThread thread = new CmsHistoryClearThread(
243            A_CmsUI.getCmsObject(),
244            versions,
245            versionsDeleted,
246            date);
247        thread.start();
248        return thread;
249    }
250}