Clover icon

Magnolia Imaging Module Compatibility 3.4.2-SUPPORT-10161

  1. Project Clover database Tue Jul 16 2019 23:37:35 EEST
  2. Package info.magnolia.imaging.caching

File AbstractContentBasedCachingStrategy.java

 

Coverage histogram

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

Code metrics

4
12
3
1
104
40
6
0.5
4
3
2

Classes

Class Line # Actions
AbstractContentBasedCachingStrategy 55 12 0% 6 19
0.00%
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /**
2    * This file Copyright (c) 2009-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.caching;
35   
36    import info.magnolia.cms.core.Content;
37    import info.magnolia.cms.core.NodeData;
38    import info.magnolia.imaging.ImageGenerator;
39    import info.magnolia.imaging.ParameterProvider;
40    import info.magnolia.jcr.util.NodeTypes;
41   
42    import java.util.Calendar;
43   
44    import javax.jcr.Property;
45    import javax.jcr.RepositoryException;
46   
47   
48    /**
49    * Superclass for {@link Content} based {@link CachingStrategy}/ies.
50    *
51    * @param <P> type of ParameterProvider's parameter
52    * @deprecated since 3.2 use {@link AbstractNodeBasedCachingStrategy}
53    */
54    @Deprecated
 
55    public abstract class AbstractContentBasedCachingStrategy<P> implements CachingStrategy<P> {
56   
 
57  0 toggle @Override
58    public String getCachePath(ImageGenerator<ParameterProvider<P>> generator, ParameterProvider<P> parameterProvider) {
59  0 final P param = parameterProvider.getParameter();
60  0 return "/" + generator.getName() + "/" + getWorkspaceName(param) + getPathOf(param);
61    }
62   
63    /**
64    * The default implementation simply delegates this decision to ParameterProvider.
65    *
66    * @return true if the image should be regenerated.
67    *
68    * @deprecated since 3.3 - use {@link #shouldRegenerate(Property, ParameterProvider)} instead.
69    */
 
70  0 toggle @Deprecated
71    public boolean shouldRegenerate(NodeData cachedBinary, ParameterProvider<P> parameterProvider) {
72  0 try {
73  0 return shouldRegenerate(cachedBinary.getJCRProperty(), parameterProvider);
74    } catch (RepositoryException e) {
75  0 throw new IllegalStateException("Unable to get JCR Property from NodeData " + cachedBinary, e);
76    }
77    }
78   
 
79  0 toggle @Override
80    public boolean shouldRegenerate(Property cachedBinary, ParameterProvider<P> parameterProvider) throws RepositoryException {
81    // this is assuming the cached node's metadata was updated, not just the binary
82  0 final Calendar cacheLastMod = NodeTypes.LastModified.getLastModified(cachedBinary.getParent());
83   
84    // this is assuming our parameter's mgnl:metaData was updated when updating any of its properties/binaries
85  0 final Calendar srcLastMod = getContent(parameterProvider.getParameter()).getMetaData().getModificationDate();
86   
87    //we should always check for the other one anyway since getModificationDate() _can_ return null
88  0 if (srcLastMod == null) {
89    // no srcLastMod update, means likely also no source at all ...
90  0 return false;
91  0 } else if (cacheLastMod == null) {
92    // no cacheLstMod update, means that the copy is stale or not created properly
93  0 return true;
94    } else {
95  0 return cacheLastMod.before(srcLastMod);
96    }
97    }
98   
99    abstract protected String getWorkspaceName(P param);
100   
101    abstract protected Content getContent(P param);
102   
103    abstract protected String getPathOf(P param);
104    }