Clover icon

Magnolia Imaging Module 3.4.2-SUPPORT-10161

  1. Project Clover database Tue Jul 16 2019 23:33:19 EEST
  2. Package info.magnolia.imaging.parameters

File AbstractWorkspaceAndUuidParameterProviderFactory.java

 

Coverage histogram

../../../../img/srcFileCovDistChart0.png
78% of files have more coverage

Code metrics

4
13
1
1
94
41
5
0.38
13
1
5
10% of code in this file is excluded from these metrics.

Classes

Class Line # Actions
AbstractWorkspaceAndUuidParameterProviderFactory 57 13 10% 5 18
0.00%
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /**
2    * This file Copyright (c) 2010-2018 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.ImagingRuntimeException;
38    import info.magnolia.imaging.ParameterProvider;
39    import info.magnolia.imaging.ParameterProviderFactory;
40    import info.magnolia.imaging.util.PathSplitter;
41   
42    import javax.jcr.ItemNotFoundException;
43    import javax.jcr.NoSuchWorkspaceException;
44    import javax.jcr.PathNotFoundException;
45    import javax.jcr.RepositoryException;
46    import javax.jcr.Session;
47    import javax.servlet.http.HttpServletRequest;
48   
49    /**
50    * AbstractWorkspaceAndUuidParameterProviderFactory. This class extracts workspace and uuid from the path.
51    * Everything after the uuid is ignored so that one can pass e.g. a properly named filename to the image.
52    *
53    * @param <PT> type of ParameterProvider's parameter
54    * @deprecated since 3.2 - use {@link info.magnolia.imaging.parameters.AbstractJcrWorkspaceAndIdentifierParameterProviderFactory} instead.
55    */
56    @Deprecated
 
57    public abstract class AbstractWorkspaceAndUuidParameterProviderFactory<PT> implements ParameterProviderFactory<HttpServletRequest, PT> {
58   
59    private boolean trimExtension = true;
60   
 
61  0 toggle @Override
62    public ParameterProvider<PT> newParameterProviderFor(HttpServletRequest request) {
63  0 String pathInfo = request.getPathInfo();
64  0 if (pathInfo == null) {
65  0 throw new ImagingRuntimeException("Can't determine node, no pathInfo is available for uri " + request.getRequestURI());
66    }
67   
68    // 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.
69    // Can we do better ?
70  0 final PathSplitter pathSplitter = new PathSplitter(pathInfo, trimExtension);
71  0 if (pathSplitter.count() < 2) {
72  0 throw new ImagingRuntimeException("Can't determine node from pathInfo: " + pathInfo);
73   
74    }
75  0 final String workspaceName = pathSplitter.skipTo(1);
76  0 final String uuid = pathSplitter.skipTo(2);
77   
78  0 try {
79  0 final Session session = MgnlContext.getJCRSession(workspaceName);
80  0 return newParameterProviderForUuid(session, uuid);
81    } catch (NoSuchWorkspaceException | ItemNotFoundException | PathNotFoundException e) {
82  0 throw new ImagingRuntimeException("Can't load source from " + uuid + " from workspace " + workspaceName, e);
83    } catch (RepositoryException e) {
84  0 throw new RuntimeException("Can't load source from " + uuid + " from workspace " + workspaceName, e); // TODO
85    }
86    }
87   
88    abstract protected ParameterProvider<PT> newParameterProviderForUuid(Session session, String uuid) throws RepositoryException;
89   
 
90    toggle public void setTrimExtension(boolean trimExtension) {
91    this.trimExtension = trimExtension;
92    }
93   
94    }