1 /**
2 * This file Copyright (c) 2010-2015 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.imaging.parameters;
35
36 import info.magnolia.context.MgnlContext;
37 import info.magnolia.imaging.ParameterProvider;
38 import info.magnolia.imaging.ParameterProviderFactory;
39 import info.magnolia.imaging.util.PathSplitter;
40
41 import javax.jcr.RepositoryException;
42 import javax.jcr.Session;
43 import javax.servlet.http.HttpServletRequest;
44
45 /**
46 * AbstractWorkspaceAndUuidParameterProviderFactory. This class extracts workspace and uuid from the path.
47 * Everything after the uuid is ignored so that one can pass e.g. a properly named filename to the image.
48 *
49 * @param <PT> type of ParameterProvider's parameter
50 * @deprecated since 3.2 - use {@link info.magnolia.imaging.parameters.AbstractWorkspaceAndIdentifierParameterProviderFactory} instead.
51 */
52 @Deprecated
53 public abstract class AbstractWorkspaceAndUuidParameterProviderFactory<PT> implements ParameterProviderFactory<HttpServletRequest, PT> {
54
55 private boolean trimExtension = true;
56
57 @Override
58 public ParameterProvider<PT> newParameterProviderFor(HttpServletRequest request) {
59 String pathInfo = request.getPathInfo();
60 if (pathInfo == null) {
61 throw new IllegalArgumentException("Can't determine node, no pathInfo is available for uri " + request.getRequestURI());
62 }
63
64 // TODO - here we assume that the first path element is the ImageGenerator name, which is in fact something that is currently the business of the ImagingServlet.
65 // Can we do better ?
66 final PathSplitter pathSplitter = new PathSplitter(pathInfo, trimExtension);
67 if (pathSplitter.count() < 2) {
68 throw new IllegalArgumentException("Can't determine node from pathInfo: " + pathInfo);
69
70 }
71 final String workspaceName = pathSplitter.skipTo(1);
72 final String uuid = pathSplitter.skipTo(2);
73
74 try {
75 final Session session = MgnlContext.getJCRSession(workspaceName);
76 return newParameterProviderForUuid(session, uuid);
77 } catch (RepositoryException e) {
78 throw new RuntimeException("Can't load source from " + uuid + " from workspace " + workspaceName, e); // TODO
79 }
80 }
81
82 abstract protected ParameterProvider<PT> newParameterProviderForUuid(Session session, String uuid) throws RepositoryException;
83
84 public void setTrimExtension(boolean trimExtension) {
85 this.trimExtension = trimExtension;
86 }
87
88 }