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.jsp.util;
029
030import org.opencms.file.CmsObject;
031import org.opencms.main.CmsLog;
032import org.opencms.util.CmsMacroResolver;
033import org.opencms.util.CmsStringUtil;
034import org.opencms.widgets.CmsSelectWidgetOption;
035import org.opencms.xml.content.CmsXmlContentProperty;
036import org.opencms.xml.content.CmsXmlContentProperty.Visibility;
037import org.opencms.xml.content.CmsXmlContentPropertyHelper;
038
039import java.util.ArrayList;
040import java.util.HashMap;
041import java.util.List;
042import java.util.Locale;
043import java.util.Map;
044import java.util.Set;
045import java.util.function.Function;
046import java.util.stream.Collectors;
047
048import org.apache.commons.beanutils.BeanUtils;
049import org.apache.commons.logging.Log;
050
051/**
052 * Wrapper used to access element setting definition information in JSP code.
053 */
054public class CmsSettingDefinitionWrapper implements I_CmsInfoWrapper {
055
056    /** Logger instance for this class. */
057    private static final Log LOG = CmsLog.getLog(CmsSettingDefinitionWrapper.class);
058
059    /** The CmsObject used. */
060    private CmsObject m_cms;
061
062    /** The definition. containing the original message keys.*/
063    private CmsXmlContentProperty m_definitionWithKeys;
064
065    /** The raw setting definition (unresolved macros). */
066    private CmsXmlContentProperty m_rawDefinition;
067
068    /** The resolved definition. */
069    private CmsXmlContentProperty m_resolvedDefinition;
070
071    /** Resolved definitions by locale. */
072    private Map<Locale, CmsXmlContentProperty> m_resolvedDefsByLocale = new HashMap<>();
073
074    /** Used for accessing locale-specific macro resolvers. */
075    private Function<Locale, CmsMacroResolver> m_resolverProvider;
076
077    /**
078     * Creates a new instance.
079     *
080     * @param cms the current CMS context
081     * @param settingDef the raw setting definition
082     * @param resolverProvider provides macro resolvers for a particular locale
083     *
084     */
085    public CmsSettingDefinitionWrapper(
086        CmsObject cms,
087        CmsXmlContentProperty settingDef,
088        Function<Locale, CmsMacroResolver> resolverProvider) {
089
090        m_resolverProvider = resolverProvider;
091        m_rawDefinition = settingDef;
092        m_cms = cms;
093        m_resolvedDefinition = resolveDefinition(cms.getRequestContext().getLocale());
094        CmsKeyDummyMacroResolver keyResolver = new CmsKeyDummyMacroResolver(
095            resolverProvider.apply(cms.getRequestContext().getLocale()));
096        m_definitionWithKeys = CmsXmlContentPropertyHelper.resolveMacrosInProperty(settingDef, keyResolver);
097
098    }
099
100    /**
101     * Gets the default value.
102     *
103     * @return the default value
104     */
105    public String getDefaultValue() {
106
107        return m_resolvedDefinition.getDefault();
108    }
109
110    /**
111     * Gets the description.
112     *
113     * @return the description
114     */
115    public String getDescription() {
116
117        return m_resolvedDefinition.getDescription();
118    }
119
120    /**
121     * Gets the localized description for a particular locale.
122     *
123     * @param locale the locale
124     * @return the localized description
125     */
126    public String getDescription(Locale locale) {
127
128        CmsXmlContentProperty resolvedDef = resolveDefinition(locale);
129        return resolvedDef.getDescription();
130    }
131
132    /**
133     * Gets the description key.
134     *
135     * @return the description key
136     */
137    public String getDescriptionKey() {
138
139        return CmsKeyDummyMacroResolver.getKey(m_definitionWithKeys.getDescription());
140    }
141
142    /**
143     * Gets the raw description configured for the setting.
144     *
145     * @return the raw description
146     */
147    public String getDescriptionRaw() {
148
149        return m_rawDefinition.getDescription();
150    }
151
152    /**
153     * Gets the display name.
154     *
155     * @return the display name
156     */
157    public String getDisplayName() {
158
159        return m_resolvedDefinition.getNiceName();
160    }
161
162    /**
163     * Gets the display name key.
164     *
165     * @return the display name key
166     */
167    public String getDisplayNameKey() {
168
169        return CmsKeyDummyMacroResolver.getKey(m_definitionWithKeys.getNiceName());
170    }
171
172    /**
173     * Gets the raw configured display name.
174     *
175     * @return the raw display name
176     */
177    public String getDisplayNameRaw() {
178
179        return m_rawDefinition.getNiceName();
180    }
181
182    /**
183     * Tries to interpret the widget configuration as a select option configuration and returns the list of select options if this succeeds, and null otherwise.
184     *
185     * @return the list of parsed select options, or null if the widget configuration couldn't be interpreted that way
186     */
187    public List<CmsSelectWidgetOption> getParsedSelectOptions() {
188
189        String widgetConfig = getWidgetConfig();
190        if (CmsStringUtil.isEmptyOrWhitespaceOnly(widgetConfig)) {
191            // passing an empty/null configuration to parseOptions would result in an empty list, not null, and we want null here
192            return null;
193        }
194        try {
195            List<CmsSelectWidgetOption> options = org.opencms.widgets.CmsSelectWidgetOption.parseOptions(widgetConfig);
196            List<CmsSelectWidgetOption> result = new ArrayList<>();
197            Set<String> values = options.stream().map(option -> option.getValue()).collect(Collectors.toSet());
198            String defaultValue = getDefaultValue();
199            Locale locale = m_cms.getRequestContext().getLocale();
200            if (CmsStringUtil.isEmptyOrWhitespaceOnly(defaultValue) || !values.contains(defaultValue)) {
201                CmsSelectWidgetOption noValue = new CmsSelectWidgetOption(
202                    "",
203                    true,
204                    org.opencms.gwt.Messages.get().getBundle(locale).key(
205                        org.opencms.gwt.Messages.GUI_SELECTBOX_EMPTY_SELECTION_0));
206                result.add(noValue);
207            }
208
209            result.addAll(options);
210            return result;
211        } catch (Exception e) {
212            LOG.info(e.getLocalizedMessage(), e);
213            return null;
214        }
215    }
216
217    /**
218     * Gets the property name.
219     *
220     * @return the property name
221     */
222    public String getPropertyName() {
223
224        return m_resolvedDefinition.getName();
225    }
226
227    /**
228     * Gets the visibility.
229     *
230     * @return the visibility
231     */
232    public String getVisibility() {
233
234        return "" + m_resolvedDefinition.getVisibility(Visibility.elementAndParentIndividual);
235    }
236
237    /**
238     * Gets the widget.
239     *
240     * @return the widget
241     */
242    public String getWidget() {
243
244        return m_resolvedDefinition.getWidget();
245    }
246
247    /**
248     * Gets the widget config.
249     *
250     * @return the widget config
251     */
252    public String getWidgetConfig() {
253
254        return m_resolvedDefinition.getWidgetConfiguration();
255    }
256
257    /**
258     * @see java.lang.Object#toString()
259     */
260    @Override
261    public String toString() {
262
263        // for debugging
264        try {
265            return BeanUtils.describe(this).toString();
266        } catch (Exception e) {
267            e.printStackTrace();
268            return "???";
269        }
270
271    }
272
273    /**
274     * Localizes the setting definition for a given locale.
275     *
276     * @param locale the locale to use
277     * @return the localized setting definition
278     */
279    private CmsXmlContentProperty resolveDefinition(Locale locale) {
280
281        return m_resolvedDefsByLocale.computeIfAbsent(locale, loc -> {
282            CmsMacroResolver resolver = m_resolverProvider.apply(loc);
283            return CmsXmlContentPropertyHelper.resolveMacrosInProperty(m_rawDefinition, resolver);
284        });
285
286    }
287
288}