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 GmbH & Co. KG, 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;
029
030import org.opencms.file.CmsObject;
031import org.opencms.flex.CmsFlexController;
032import org.opencms.i18n.CmsMessages;
033import org.opencms.main.CmsLog;
034import org.opencms.main.OpenCms;
035
036import javax.servlet.ServletRequest;
037import javax.servlet.jsp.JspException;
038import javax.servlet.jsp.tagext.BodyContent;
039import javax.servlet.jsp.tagext.BodyTagSupport;
040
041import org.apache.commons.logging.Log;
042
043/**
044 * Provides access to the labels stored in the
045 * language files of the OpenCms workplace.<p>
046 *
047 * Instead of using the XML based workplace tags one should
048 * consider using standard Java resource bundles to provide language independent
049 * implementations.<p>
050 *
051 * @since 6.0.0
052 */
053public class CmsJspTagLabel extends BodyTagSupport {
054
055    /** The log object for this class. */
056    private static final Log LOG = CmsLog.getLog(CmsJspTagLabel.class);
057
058    /** Serial version UID required for safe serialization. */
059    private static final long serialVersionUID = 5720473164730803034L;
060
061    /**
062     * Internal action method.<p>
063     *
064     * @param label the label to look up
065     * @param req the current request
066     * @return String the value of the selected label
067     */
068    public static String wpLabelTagAction(String label, ServletRequest req) {
069
070        CmsObject cms = CmsFlexController.getCmsObject(req);
071        CmsMessages messages = OpenCms.getWorkplaceManager().getMessages(cms.getRequestContext().getLocale());
072        return messages.key(label);
073    }
074
075    /**
076     * @see javax.servlet.jsp.tagext.IterationTag#doAfterBody()
077     */
078    @Override
079    public int doAfterBody() throws JspException {
080
081        ServletRequest req = pageContext.getRequest();
082
083        // This will always be true if the page is called through OpenCms
084        if (CmsFlexController.isCmsRequest(req)) {
085            try {
086
087                // Get label string from the body and reset body
088                BodyContent body = getBodyContent();
089                String label = body.getString();
090                body.clearBody();
091
092                // Get the result...
093                String result = wpLabelTagAction(label, req);
094                getPreviousOut().print(result);
095
096            } catch (Exception ex) {
097                if (LOG.isErrorEnabled()) {
098                    LOG.error(Messages.get().getBundle().key(Messages.ERR_PROCESS_TAG_1, "label"), ex);
099                }
100                throw new javax.servlet.jsp.JspException(ex);
101            }
102        }
103        return SKIP_BODY;
104    }
105
106}