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.loader;
029
030import org.opencms.configuration.CmsParameterConfiguration;
031import org.opencms.file.CmsObject;
032import org.opencms.file.CmsResource;
033import org.opencms.flex.CmsFlexCache;
034import org.opencms.flex.CmsFlexController;
035import org.opencms.flex.CmsFlexRequest;
036import org.opencms.flex.CmsFlexResponse;
037import org.opencms.main.CmsException;
038import org.opencms.main.CmsLog;
039import org.opencms.main.CmsRuntimeException;
040import org.opencms.main.OpenCms;
041
042import java.util.Locale;
043
044import javax.servlet.ServletRequest;
045import javax.servlet.ServletResponse;
046import javax.servlet.http.HttpServletRequest;
047import javax.servlet.http.HttpServletResponse;
048
049/**
050 * Loader for HTML redirects.<p>
051 */
052public class CmsRedirectLoader implements I_CmsResourceLoader, I_CmsFlexCacheEnabledLoader {
053
054    /** The loader id. */
055    public static final int LOADER_ID = 13;
056
057    /** Empty configuration. */
058    private static final CmsParameterConfiguration CONFIG = new CmsParameterConfiguration();
059
060    /** The CmsFlexCache used to store generated cache entries in. */
061    private CmsFlexCache m_cache;
062
063    /**
064     * @see org.opencms.configuration.I_CmsConfigurationParameterHandler#addConfigurationParameter(java.lang.String, java.lang.String)
065     */
066    public void addConfigurationParameter(String paramName, String paramValue) {
067
068        // nothing to do
069    }
070
071    /**
072     * @see org.opencms.loader.I_CmsResourceLoader#destroy()
073     */
074    public void destroy() {
075
076        // nothing to do
077    }
078
079    /**
080     * @see org.opencms.loader.I_CmsResourceLoader#dump(org.opencms.file.CmsObject, org.opencms.file.CmsResource, java.lang.String, java.util.Locale, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
081     */
082    public byte[] dump(
083        CmsObject cms,
084        CmsResource resource,
085        String element,
086        Locale locale,
087        HttpServletRequest req,
088        HttpServletResponse res) throws CmsException {
089
090        return cms.readFile(resource).getContents();
091    }
092
093    /**
094     * @see org.opencms.loader.I_CmsResourceLoader#export(org.opencms.file.CmsObject, org.opencms.file.CmsResource, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
095     */
096    public byte[] export(CmsObject cms, CmsResource resource, HttpServletRequest req, HttpServletResponse res) {
097
098        throw new CmsRuntimeException(
099            Messages.get().container(Messages.ERR_EXPORT_UNSUPPORTED_1, getClass().getName()));
100    }
101
102    /**
103     * @see org.opencms.configuration.I_CmsConfigurationParameterHandler#getConfiguration()
104     */
105    public CmsParameterConfiguration getConfiguration() {
106
107        return CONFIG;
108    }
109
110    /**
111     * @see org.opencms.loader.I_CmsResourceLoader#getLoaderId()
112     */
113    public int getLoaderId() {
114
115        return LOADER_ID;
116    }
117
118    /**
119     * @see org.opencms.loader.I_CmsResourceLoader#getResourceLoaderInfo()
120     */
121    public String getResourceLoaderInfo() {
122
123        return Messages.get().getBundle().key(Messages.GUI_LOADER_HTMLREDIRECT_DEFAULT_DESC_0);
124    }
125
126    /**
127     * @see org.opencms.configuration.I_CmsConfigurationParameterHandler#initConfiguration()
128     */
129    public void initConfiguration() {
130
131        if (CmsLog.INIT.isInfoEnabled()) {
132            CmsLog.INIT.info(
133                Messages.get().getBundle().key(Messages.INIT_LOADER_INITIALIZED_1, this.getClass().getName()));
134        }
135    }
136
137    /**
138     * @see org.opencms.loader.I_CmsResourceLoader#isStaticExportEnabled()
139     */
140    public boolean isStaticExportEnabled() {
141
142        return false;
143    }
144
145    /**
146     * @see org.opencms.loader.I_CmsResourceLoader#isStaticExportProcessable()
147     */
148    public boolean isStaticExportProcessable() {
149
150        return false;
151    }
152
153    /**
154     * @see org.opencms.loader.I_CmsResourceLoader#isUsableForTemplates()
155     */
156    public boolean isUsableForTemplates() {
157
158        return false;
159    }
160
161    /**
162     * @see org.opencms.loader.I_CmsResourceLoader#isUsingUriWhenLoadingTemplate()
163     */
164    public boolean isUsingUriWhenLoadingTemplate() {
165
166        return false;
167    }
168
169    /**
170     * @see org.opencms.loader.I_CmsResourceLoader#load(org.opencms.file.CmsObject, org.opencms.file.CmsResource, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
171     */
172    public void load(CmsObject cms, CmsResource resource, HttpServletRequest req, HttpServletResponse res)
173    throws CmsException {
174
175        getController(cms, resource, req, res, false, true);
176        OpenCms.getADEManager().handleHtmlRedirect(cms, req, res, cms.getSitePath(resource));
177        CmsFlexController.removeController(req);
178    }
179
180    /**
181     * @see org.opencms.loader.I_CmsResourceLoader#service(org.opencms.file.CmsObject, org.opencms.file.CmsResource, javax.servlet.ServletRequest, javax.servlet.ServletResponse)
182     */
183    public void service(CmsObject cms, CmsResource resource, ServletRequest req, ServletResponse res) {
184
185        throw new CmsRuntimeException(
186            Messages.get().container(Messages.ERR_SERVICE_UNSUPPORTED_1, getClass().getName()));
187    }
188
189    /**
190     * @see org.opencms.loader.I_CmsFlexCacheEnabledLoader#setFlexCache(org.opencms.flex.CmsFlexCache)
191     */
192    public void setFlexCache(CmsFlexCache cache) {
193
194        m_cache = cache;
195    }
196
197    /**
198     * Delivers a Flex controller, either by creating a new one, or by re-using an existing one.<p>
199     *
200     * @param cms the initial CmsObject to wrap in the controller
201     * @param resource the resource requested
202     * @param req the current request
203     * @param res the current response
204     * @param streaming indicates if the response is streaming
205     * @param top indicates if the response is the top response
206     *
207     * @return a Flex controller
208     */
209    protected CmsFlexController getController(
210        CmsObject cms,
211        CmsResource resource,
212        HttpServletRequest req,
213        HttpServletResponse res,
214        boolean streaming,
215        boolean top) {
216
217        CmsFlexController controller = null;
218        if (top) {
219            // only check for existing controller if this is the "top" request/response
220            controller = CmsFlexController.getController(req);
221        }
222        if (controller == null) {
223            // create new request / response wrappers
224            controller = new CmsFlexController(cms, resource, m_cache, req, res, streaming, top);
225            CmsFlexController.setController(req, controller);
226            CmsFlexRequest f_req = new CmsFlexRequest(req, controller);
227            CmsFlexResponse f_res = new CmsFlexResponse(res, controller, streaming, true);
228            controller.push(f_req, f_res);
229        } else if (controller.isForwardMode()) {
230            // reset CmsObject (because of URI) if in forward mode
231            controller = new CmsFlexController(cms, controller);
232            CmsFlexController.setController(req, controller);
233        }
234        return controller;
235    }
236}