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.main.CmsLog;
031import org.opencms.util.CmsMacroResolver;
032import org.opencms.util.CmsStringUtil;
033import org.opencms.util.CmsUUID;
034
035import java.util.ArrayList;
036import java.util.HashMap;
037import java.util.List;
038import java.util.Map;
039import java.util.regex.Matcher;
040import java.util.regex.Pattern;
041
042import org.apache.commons.logging.Log;
043
044/**
045 * Macro resolver used to temporarily replace localization message macros with random UUIDs and then replace the UUIDs
046 * with the original key after all other macro processing has happened.
047 *
048 * <p>We need this because we want to preserve the message key, but evaluate macros they may be nested in.
049 */
050public class CmsKeyDummyMacroResolver extends CmsMacroResolver {
051
052    /** Pattern to match message key macros. */
053    public static final Pattern PATTERN_MESSAGE = Pattern.compile("^%\\(key\\.([^\\)]++)\\)$");
054
055    /** Pattern to match message key macros. */
056    public static final Pattern PATTERN_MESSAGE_UNANCHORED = Pattern.compile("%\\(key\\.([^\\)]++)\\)\\s*");
057
058    /** Logger instance for this class. */
059    private static final Log LOG = CmsLog.getLog(CmsKeyDummyMacroResolver.class);
060
061    /** Pattern to match UUIDs. */
062    private static final Pattern UUID_PATTERN = Pattern.compile(CmsUUID.UUID_REGEX);
063
064    /** The macro resolver to delegate to. */
065    private CmsMacroResolver m_delegate;
066
067    /** The map containing the original string for each ID it was replaced with. */
068    private Map<CmsUUID, String> m_keys = new HashMap<>();
069
070    /**
071     * Creates a new instance
072     *
073     * @param delegate the macro resolver to delegate to
074     */
075    public CmsKeyDummyMacroResolver(CmsMacroResolver delegate) {
076
077        m_delegate = delegate;
078    }
079
080    /**
081     * Extracts the message from a string of the form %(key.{message}), or returns null if the input string
082     * does not have this form.
083     *
084     * @param s the input string
085     * @return the key the extracted message key
086     */
087    public static String getKey(String s) {
088
089        if (s == null) {
090            return null;
091        }
092        Matcher matcher = PATTERN_MESSAGE.matcher(s);
093        if (matcher.matches()) {
094            return matcher.group(1);
095        } else {
096            return null;
097        }
098    }
099
100    /**
101     * Gets the localization key name of a (potentially nested) key macro in a base string.<p>
102     *
103     *
104     * @param s the base string
105     * @param delegate the macro resolver used to resolve macros which the key macro may be nested in
106     * @return the localization key
107     */
108    public static String getKey(String s, CmsMacroResolver delegate) {
109
110        List<String> keys = getKeys(s, delegate);
111        if ((keys != null) && (keys.size() > 0)) {
112            return keys.get(0);
113        } else {
114            return null;
115        }
116
117    }
118
119    /**
120     * Gets the localization keys from a string consisting solely of localization key macros (only whitespace is allowed between them).
121     * 
122     * @param s the string to extract the localization keys from 
123     * @param delegate the macro resolver to use for non-localization macros
124     */
125    public static List<String> getKeys(String s, CmsMacroResolver delegate) {
126
127        if (s == null) {
128            return null;
129        }
130        CmsKeyDummyMacroResolver resolver = new CmsKeyDummyMacroResolver(delegate);
131        String resolved = resolver.resolveMacros(s);
132        return parseKeys(resolved);
133
134    }
135
136    /**
137     * Parses a string that is a sequence of %(key....) macros and extracts the corresponding keys.
138     *
139     * <p>There may be additional whitespace before or after the macros, but nothing else. If anything else is found,
140     * null will be returned.
141     *
142     * @param s the input string
143     * @return the sequence of extracted keys
144     */
145    public static List<String> parseKeys(String s) {
146
147        if (s == null) {
148            LOG.debug("Not a sequence of key macros: [" + s + "]");
149            return null;
150        }
151        s = s.trim();
152        Matcher matcher = PATTERN_MESSAGE_UNANCHORED.matcher(s);
153        int offset = 0;
154        List<String> keys = new ArrayList<>();
155
156        while (matcher.find()) {
157            if (matcher.start() != offset) {
158                LOG.debug("Not a sequence of key macros: [" + s + "]");
159                return null;
160            }
161            keys.add(matcher.group(1));
162            offset = matcher.end();
163        }
164
165        if (offset != s.length()) {
166            LOG.debug("Not a sequence of key macros: [" + s + "]");
167            return null;
168        }
169        return keys;
170    }
171
172    /**
173     * @see org.opencms.util.CmsMacroResolver#getMacroValue(java.lang.String)
174     */
175    @Override
176    public String getMacroValue(String macro) {
177
178        if (macro.startsWith(CmsMacroResolver.KEY_LOCALIZED_PREFIX)) {
179            String key = macro.substring(CmsMacroResolver.KEY_LOCALIZED_PREFIX.length());
180            CmsUUID id = new CmsUUID();
181            m_keys.put(id, key);
182            return id.toString();
183        } else {
184            String result = m_delegate.getMacroValue(macro);
185            return result;
186        }
187    }
188
189    /**
190     * @see org.opencms.util.CmsMacroResolver#resolveMacros(java.lang.String)
191     */
192    @Override
193    public String resolveMacros(String input) {
194
195        String processedInput = super.resolveMacros(input);
196        String result = CmsStringUtil.substitute(UUID_PATTERN, processedInput, (s, matcher) -> {
197            CmsUUID id = new CmsUUID(matcher.group());
198            if (m_keys.containsKey(id)) {
199                return "%(key." + m_keys.get(id) + ")";
200            } else {
201                return matcher.group();
202            }
203        });
204        return result;
205    }
206
207}