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;
029
030import org.opencms.json.JSONArray;
031import org.opencms.json.JSONException;
032import org.opencms.json.JSONObject;
033import org.opencms.main.CmsLog;
034import org.opencms.ui.components.CmsResourceTableProperty;
035
036import java.io.Serializable;
037import java.util.ArrayList;
038import java.util.Collections;
039import java.util.List;
040import java.util.Map;
041
042import org.apache.commons.logging.Log;
043
044import com.google.common.collect.Lists;
045
046/**
047 * Stores the file explorer settings.<p>
048 */
049public class CmsFileExplorerSettings implements Serializable, I_CmsAppSettings {
050
051    /** JSON key. */
052    private static final String COLLAPSED_COLUMNS_KEY = "collapsed_collumns";
053
054    /** Log instance for this class. */
055    private static final Log LOG = CmsLog.getLog(CmsFileExplorerSettings.class);
056
057    /** The serial version id. */
058    private static final long serialVersionUID = 1L;
059
060    /** JSON key. */
061    private static final String SORT_COLUMN_KEY = "sort_column";
062
063    /** JSON key. */
064    private static final String SORT_ORDER_KEY = "sort_order";
065
066    /** JSON key. */
067    private static final String UNCOLLAPSED = "uncollapsed";
068
069    /** The collapsed column ids. */
070    private List<CmsResourceTableProperty> m_collapsedColumns;
071
072    /** The sort order. */
073    private boolean m_sortAscending;
074
075    /** The sort column id. */
076    private CmsResourceTableProperty m_sortColumnId;
077
078    /** The uncollapsed columns (might be null). */
079    private List<CmsResourceTableProperty> m_uncollapsedColumns;
080
081    /**
082     * Constructor.<p>
083     * Will initialize the default settings.<p>
084     */
085    public CmsFileExplorerSettings() {
086
087        // initialize with the default settings
088        m_sortColumnId = CmsResourceTableProperty.PROPERTY_RESOURCE_NAME;
089        m_sortAscending = true;
090        m_collapsedColumns = new ArrayList<>();
091        Collections.addAll(
092            m_collapsedColumns,
093            CmsResourceTableProperty.PROPERTY_NAVIGATION_TEXT,
094            CmsResourceTableProperty.PROPERTY_PERMISSIONS,
095            CmsResourceTableProperty.PROPERTY_USER_MODIFIED,
096            CmsResourceTableProperty.PROPERTY_DATE_CREATED,
097            CmsResourceTableProperty.PROPERTY_USER_CREATED,
098            CmsResourceTableProperty.PROPERTY_INTERNAL_RESOURCE_TYPE,
099            CmsResourceTableProperty.PROPERTY_STATE_NAME,
100            CmsResourceTableProperty.PROPERTY_USER_LOCKED);
101    }
102
103    /**
104     * Returns the collapsed column ids.
105     *
106     * @return the collapsed column ids
107     */
108    public List<CmsResourceTableProperty> getCollapsedColumns() {
109
110        return m_collapsedColumns;
111    }
112
113    /**
114     * @see org.opencms.ui.apps.I_CmsAppSettings#getSettingsString()
115     */
116    public String getSettingsString() {
117
118        JSONObject json = new JSONObject();
119        try {
120            json.put(SORT_ORDER_KEY, m_sortAscending);
121            json.put(SORT_COLUMN_KEY, m_sortColumnId.getId());
122            List<String> collapsed = Lists.newArrayList();
123            for (CmsResourceTableProperty column : m_collapsedColumns) {
124                collapsed.add(column.getId());
125            }
126            json.put(COLLAPSED_COLUMNS_KEY, new JSONArray(collapsed));
127            if (m_uncollapsedColumns != null) {
128                JSONArray uncollapsed = new JSONArray();
129                json.put(UNCOLLAPSED, uncollapsed);
130                for (CmsResourceTableProperty column : m_uncollapsedColumns) {
131                    uncollapsed.put(column.getId());
132                }
133            }
134        } catch (JSONException e) {
135            LOG.error(e.getLocalizedMessage(), e);
136        }
137
138        return json.toString();
139    }
140
141    /**
142     * Gets the sort column id.<p>
143     *
144     * @return the sort column id
145     */
146    public CmsResourceTableProperty getSortColumnId() {
147
148        return m_sortColumnId;
149    }
150
151    /**
152     * Gets the uncollapsed column ids, or null if they are not set.
153     *
154     * @return the uncollapsed columns
155     */
156    public List<CmsResourceTableProperty> getUncollapsedColumns() {
157
158        return m_uncollapsedColumns;
159    }
160
161    /**
162     * Returns the sort order.<p>
163     *
164     * @return the sort order
165     */
166    public boolean isSortAscending() {
167
168        return m_sortAscending;
169    }
170
171    /**
172     * @see org.opencms.ui.apps.I_CmsAppSettings#restoreSettings(java.lang.String)
173     */
174    public void restoreSettings(String storedSettings) {
175
176        Map<String, CmsResourceTableProperty> columnMap = CmsResourceTableProperty.getDefaultColumnsByName();
177
178        try {
179            JSONObject json = new JSONObject(storedSettings);
180            if (json.has(SORT_ORDER_KEY)) {
181                m_sortAscending = json.getBoolean(SORT_ORDER_KEY);
182            }
183            if (json.has(SORT_COLUMN_KEY)) {
184                m_sortColumnId = columnMap.get(json.getString(SORT_COLUMN_KEY));
185            }
186            if (json.has(COLLAPSED_COLUMNS_KEY)) {
187                List<CmsResourceTableProperty> collapsed = new ArrayList<CmsResourceTableProperty>();
188                JSONArray array = json.getJSONArray(COLLAPSED_COLUMNS_KEY);
189
190                for (int i = 0; i < array.length(); i++) {
191                    collapsed.add(columnMap.get(array.getString(i)));
192                }
193                m_collapsedColumns = collapsed;
194            }
195
196            if (json.has(UNCOLLAPSED)) {
197                JSONArray array = json.getJSONArray(UNCOLLAPSED);
198                List<CmsResourceTableProperty> uncollapsed = new ArrayList<>();
199                for (int i = 0; i < array.length(); i++) {
200                    uncollapsed.add(columnMap.get(array.getString(i)));
201                }
202                m_uncollapsedColumns = uncollapsed;
203            }
204        } catch (JSONException e) {
205            LOG.error("Failed to restore file explorer settings from '" + storedSettings + "'", e);
206        }
207    }
208
209    /**
210     * Sets the collapsed columns.<p>
211     *
212     * @param collapsedColumns the collapsed columns
213     */
214    public void setCollapsedColumns(List<CmsResourceTableProperty> collapsedColumns) {
215
216        m_collapsedColumns = collapsedColumns;
217    }
218
219    /**
220     * Sets the sort order.<p>
221     *
222     * @param sortAscending the sort order
223     */
224    public void setSortAscending(boolean sortAscending) {
225
226        m_sortAscending = sortAscending;
227    }
228
229    /**
230     * Sets the sort column.<p>
231     *
232     * @param sortColumnId the sort column
233     */
234    public void setSortColumnId(CmsResourceTableProperty sortColumnId) {
235
236        m_sortColumnId = sortColumnId;
237    }
238
239    /**
240     * Sets the uncollapsed columns.
241     *
242     * @param uncollapsedColumns the uncollapsed columns
243     */
244    public void setUncollapsedColumns(List<CmsResourceTableProperty> uncollapsedColumns) {
245
246        m_uncollapsedColumns = uncollapsedColumns;
247    }
248}