001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (https://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: https://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: https://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.widgets;
029
030import org.opencms.ade.galleries.shared.I_CmsGalleryProviderConstants;
031import org.opencms.file.CmsObject;
032import org.opencms.file.types.CmsResourceTypeBinary;
033import org.opencms.file.types.CmsResourceTypeImage;
034import org.opencms.i18n.CmsMessages;
035import org.opencms.json.JSONException;
036import org.opencms.json.JSONObject;
037import org.opencms.main.OpenCms;
038
039/**
040 * ADE download gallery widget implementations.<p>
041 *
042 * @since 8.0.0
043 */
044public class CmsAdeDownloadGalleryWidget extends A_CmsAdeGalleryWidget {
045
046    /** The gallery name. */
047    private static final String GALLERY_NAME = "download";
048
049    /**
050     * Constructor.<p>
051     */
052    public CmsAdeDownloadGalleryWidget() {
053
054        this("");
055    }
056
057    /**
058     * Creates a new gallery widget with the given configuration.<p>
059     *
060     * @param configuration the configuration to use
061     */
062    protected CmsAdeDownloadGalleryWidget(String configuration) {
063
064        super(configuration);
065    }
066
067    /**
068     * @see org.opencms.widgets.A_CmsAdeGalleryWidget#getGalleryName()
069     */
070    @Override
071    public String getGalleryName() {
072
073        return GALLERY_NAME;
074    }
075
076    /**
077     * @see org.opencms.widgets.I_CmsADEWidget#getWidgetName()
078     */
079    @Override
080    public String getWidgetName() {
081
082        return CmsAdeDownloadGalleryWidget.class.getName();
083    }
084
085    /**
086     * @see org.opencms.widgets.I_CmsWidget#newInstance()
087     */
088    public I_CmsWidget newInstance() {
089
090        return new CmsAdeDownloadGalleryWidget(getConfiguration());
091    }
092
093    /**
094     * @see org.opencms.widgets.A_CmsAdeGalleryWidget#getAdditionalGalleryInfo(org.opencms.file.CmsObject, java.lang.String, org.opencms.i18n.CmsMessages, org.opencms.widgets.I_CmsWidgetParameter)
095     */
096    @Override
097    protected JSONObject getAdditionalGalleryInfo(
098        CmsObject cms,
099        String resource,
100        CmsMessages messages,
101        I_CmsWidgetParameter param)
102    throws JSONException {
103
104        JSONObject result = new JSONObject();
105        result.put(I_CmsGalleryProviderConstants.CONFIG_TAB_CONFIG, "selectDoc");
106        String uploadFolder = OpenCms.getWorkplaceManager().getRepositoryFolderHandler().getRepositoryFolder(
107            cms,
108            resource,
109            GALLERY_NAME + "gallery");
110        if (uploadFolder != null) {
111            result.put(I_CmsGalleryProviderConstants.CONFIG_UPLOAD_FOLDER, uploadFolder);
112        }
113        return result;
114    }
115
116    /**
117     * @see org.opencms.widgets.A_CmsAdeGalleryWidget#getGalleryStoragePrefix()
118     */
119    @Override
120    protected String getGalleryStoragePrefix() {
121
122        return "binary";
123    }
124
125    /**
126     * @see org.opencms.widgets.A_CmsAdeGalleryWidget#getGalleryTypes()
127     */
128    @Override
129    protected String getGalleryTypes() {
130
131        return CmsResourceTypeBinary.getStaticTypeName() + "," + CmsResourceTypeImage.getStaticTypeName();
132    }
133}