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.ade.sitemap.shared;
029
030import org.opencms.ade.detailpage.CmsDetailPageInfo;
031import org.opencms.util.CmsUUID;
032
033import java.io.Serializable;
034import java.util.ArrayList;
035import java.util.Collection;
036import java.util.Collections;
037import java.util.HashMap;
038import java.util.List;
039import java.util.Map;
040import java.util.stream.Collectors;
041
042/**
043 * A data structure for managing the detail page ordering for different types in a given sitemap.<p>
044 *
045 * @since 8.0.0
046 */
047public class CmsDetailPageTable implements Cloneable, Serializable {
048
049    /** A type indicating the status of a page. */
050    public static enum Status {
051        /** default detail page. */
052        firstDetailPage,
053        /** no detail page. */
054        noDetailPage,
055        /** non-default detail page. */
056        otherDetailPage
057    }
058
059    /** ID for serialization. */
060    private static final long serialVersionUID = -4561142050519767250L;
061
062    /** The detail page info beans indexed by id. */
063    private Map<CmsUUID, CmsDetailPageInfo> m_infoById = new HashMap<CmsUUID, CmsDetailPageInfo>();
064
065    /** The detail page info beans, indexed by type. */
066    private Map<String, List<CmsDetailPageInfo>> m_map = new HashMap<>();
067
068    /**
069     * Creates a detail page table from a list of detail page info bean.<p>
070     *
071     * @param infos the detail page info beans
072     */
073    public CmsDetailPageTable(List<CmsDetailPageInfo> infos) {
074
075        for (CmsDetailPageInfo info : infos) {
076            m_map.compute(info.getType(), (k, vs) -> vs == null ? new ArrayList<>() : vs).add(info);
077            m_infoById.put(info.getId(), info);
078        }
079    }
080
081    /**
082     * Empty default constructor for serialization.<p>
083     */
084    protected CmsDetailPageTable() {
085
086        // for serialization
087    }
088
089    /**
090     * Adds a new detail page information bean to the detail page table.<p>
091     *
092     * @param info the detail page info to add
093     */
094    public void add(CmsDetailPageInfo info) {
095
096        m_map.computeIfAbsent(info.getType(), type -> new ArrayList<>()).add(info);
097        m_infoById.put(info.getId(), info);
098    }
099
100    /**
101     * Checks if the entry for the given id can be made the default detail page entry for its type.
102     *
103     * @param id the id to check
104     * @return true if the entry can be made the default detail page entry
105     */
106    public boolean canMakeDefault(CmsUUID id) {
107
108        if (isDefaultDetailPage(id)) {
109            return false;
110        }
111        CmsDetailPageInfo info = m_infoById.get(id);
112        if ((info == null) || info.isInherited()) {
113            return false;
114        }
115        return true;
116    }
117
118    /**
119     * Returns true if the detail page table contains a page with a given id.<p>
120     *
121     * @param id the page id
122     * @return true if the detail page table contains the page with the given id
123     */
124    public boolean contains(CmsUUID id) {
125
126        return m_infoById.containsKey(id);
127    }
128
129    /**
130     * Copies the detail page table.<p>
131     *
132     * @return the copy of the detail page table
133     */
134    public CmsDetailPageTable copy() {
135
136        List<CmsDetailPageInfo> infos = toList();
137        CmsDetailPageTable result = new CmsDetailPageTable();
138        for (CmsDetailPageInfo info : infos) {
139            result.add(info);
140        }
141        return result;
142    }
143
144    /**
145     * Returns the detail page info for a given page id.<p>
146     *
147     * @param id a page id
148     * @return the detail page info for the given page id
149     */
150    public CmsDetailPageInfo get(CmsUUID id) {
151
152        return m_infoById.get(id);
153    }
154
155    /**
156     * Returns the page ids of all detail pages. <p>
157     *
158     * @return the page ids of all detail pages
159     */
160    public Collection<CmsUUID> getAllIds() {
161
162        return m_infoById.keySet();
163    }
164
165    /**
166     * Returns the list of detail page info beans for a given type.<p>
167     *
168     * @param type the type for which the detail page beans should be retrieved
169     *
170     * @return the detail page beans for that type
171     */
172    public List<CmsDetailPageInfo> getInfosForType(String type) {
173
174        return new ArrayList<CmsDetailPageInfo>(m_map.computeIfAbsent(type, k -> new ArrayList<>()));
175    }
176
177    /**
178     * Returns the page status for the page with the given id.<p>
179     *
180     * @param id the id for which the page status should be checked
181     *
182     * @return the status of the page with the given id
183     */
184    public Status getStatus(CmsUUID id) {
185
186        CmsDetailPageInfo info = m_infoById.get(id);
187        if (info == null) {
188            return Status.noDetailPage;
189        }
190        String type = info.getType();
191        List<CmsDetailPageInfo> pagesWithNoQualifier = m_map.computeIfAbsent(
192            type,
193            k -> new ArrayList<>()).stream().filter(detailPage -> detailPage.getQualifier() == null).collect(
194                Collectors.toList());
195        int index = pagesWithNoQualifier.indexOf(info);
196        // if info has a qualifier, index will be -1, but it's still in the list of other detail pages
197        if (index == 0) {
198            return Status.firstDetailPage;
199        }
200        return Status.otherDetailPage;
201    }
202
203    /**
204     * Returns true if the page with the given id is the default detail page for its type.<p>
205     *
206     * @param id a page id
207     *
208     * @return true if the detail page for the page id is the default detail page
209     */
210    public boolean isDefaultDetailPage(CmsUUID id) {
211
212        CmsDetailPageInfo info = m_infoById.get(id);
213        if (info == null) {
214            return false;
215        }
216        CmsDetailPageInfo firstUnqualifiedEntry = m_map.get(info.getType()).stream().filter(
217            page -> page.getQualifier() == null).findFirst().orElse(null);
218        return (firstUnqualifiedEntry != null) && firstUnqualifiedEntry.getId().equals(id);
219    }
220
221    /**
222     * Moves the detail page information for a given page to the front of the detail pages for the same type.<p>
223     *
224     * @param id a page id
225     *
226     * @return the original position of the detail page entry in the list for the same type
227     */
228    public int makeDefault(CmsUUID id) {
229
230        CmsDetailPageInfo info = m_infoById.get(id);
231        if (info == null) {
232            throw new IllegalArgumentException();
233        }
234
235        CmsDetailPageInfo infoToSave = info;
236        // Making a detail page the default detail page should discard the qualifier
237
238        if (info.getQualifier() != null) {
239            CmsDetailPageInfo info2 = new CmsDetailPageInfo(
240                info.getId(),
241                info.getUri(),
242                info.getType(),
243                null,
244                Collections.emptyList(),
245                info.getIconClasses());
246            m_infoById.put(id, info2);
247            if (info.isInherited()) {
248                // this case should be prevented by the GUI, we handle it just to make sure the entry is not saved
249                infoToSave = info2.copyAsInherited();
250            } else {
251                infoToSave = info2;
252            }
253        }
254        String type = info.getType();
255        List<CmsDetailPageInfo> infos = m_map.computeIfAbsent(type, k -> new ArrayList<>());
256        int oldPos = infos.indexOf(info);
257        infos.remove(oldPos);
258        infos.add(0, infoToSave);
259        return oldPos;
260    }
261
262    /**
263     * Removes the detail page with the given id.<p>
264     *
265     * @param id the id of the detail page to remove
266     *
267     * @return the original position of the detail page in the list for its type
268     */
269    public int remove(CmsUUID id) {
270
271        CmsDetailPageInfo info = m_infoById.get(id);
272        if (info == null) {
273            throw new IllegalArgumentException();
274        }
275        String type = info.getType();
276        List<CmsDetailPageInfo> infos = m_map.get(type);
277        int pos = infos.indexOf(info);
278        infos.remove(pos);
279        m_infoById.remove(id);
280        return pos;
281
282    }
283
284    /**
285     * The number of configured detail pages.<p>
286     *
287     * @return the number of detail pages
288     */
289    public int size() {
290
291        return m_infoById.size();
292    }
293
294    /**
295     * Returns a flat list containing all detail pages for all types which preserves the order of detail pages from each type list.<p>
296     *
297     * @return a list of all detail page info beans
298     */
299    public List<CmsDetailPageInfo> toList() {
300
301        List<CmsDetailPageInfo> result = new ArrayList<CmsDetailPageInfo>();
302        for (String key : m_map.keySet()) {
303            for (CmsDetailPageInfo info : m_map.get(key)) {
304                result.add(info);
305            }
306        }
307        return result;
308    }
309
310}