1 /**
2 * This file Copyright (c) 2003-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.cms.core;
35
36 import info.magnolia.cms.security.AccessManager;
37 import info.magnolia.jcr.util.NodeTypes;
38 import info.magnolia.jcr.util.PropertyUtil;
39 import info.magnolia.repository.RepositoryConstants;
40
41 import java.util.Calendar;
42 import java.util.GregorianCalendar;
43 import java.util.Map;
44 import java.util.TimeZone;
45 import java.util.concurrent.ConcurrentHashMap;
46
47 import javax.jcr.Node;
48 import javax.jcr.PathNotFoundException;
49 import javax.jcr.Property;
50 import javax.jcr.RepositoryException;
51
52 import org.apache.commons.lang3.StringUtils;
53 import org.slf4j.Logger;
54 import org.slf4j.LoggerFactory;
55
56 /**
57 * Represents the meta data of a node, its creation date, modification date, assigned template etc.
58 *
59 * As of 5.0 the meta data is stored directly on the node itself using mixins rather than in a subnode named MetaData.
60 * With this change this class was deprecated and replaced with corresponding methods in
61 * {@link info.magnolia.jcr.util.NodeUtil}.
62 *
63 * @deprecated since 5.0 - use instead the corresponding methods in NodeUtil
64 */
65 public class MetaData {
66 private static final Logger log = LoggerFactory.getLogger(MetaData.class);
67
68 /**
69 * Top level atoms viewed as metadata of the specified content these must be set by the authoring system itself, but
70 * could be changed via custom templates if necessary.
71 */
72
73 /**
74 * @deprecated since 5.0 - no longer supported
75 */
76 public static final String TITLE = "title";
77
78 /**
79 * @deprecated since 5.0 - use {@link info.magnolia.jcr.util.NodeTypes.Created#CREATED} instead
80 */
81 public static final String CREATION_DATE = "creationdate";
82
83 /**
84 * @deprecated since 5.0 - use {@link info.magnolia.jcr.util.NodeTypes.LastModified#LAST_MODIFIED} instead
85 */
86 public static final String LAST_MODIFIED = "lastmodified";
87
88 /**
89 * @deprecated since 5.0 - use {@link info.magnolia.jcr.util.NodeTypes.Activatable#LAST_ACTIVATED} instead
90 */
91 public static final String LAST_ACTION = "lastaction";
92
93 /**
94 * @deprecated since 5.0 - use {@link info.magnolia.jcr.util.NodeTypes.LastModified#LAST_MODIFIED_BY} instead
95 */
96 public static final String AUTHOR_ID = "authorid";
97
98 /**
99 * @deprecated since 5.0 - use {@link info.magnolia.jcr.util.NodeTypes.Activatable#LAST_ACTIVATED_BY} instead
100 */
101 public static final String ACTIVATOR_ID = "activatorid";
102
103 /**
104 * Template assigned to the node.
105 *
106 * @deprecated since 5.0 - use {@link info.magnolia.jcr.util.NodeTypes.Renderable#TEMPLATE} instead
107 */
108 public static final String TEMPLATE = "template";
109
110 /**
111 * @deprecated since 5.0 - no longer supported
112 */
113 public static final String TEMPLATE_TYPE = "templatetype";
114
115 /**
116 * @deprecated since 5.0 - use {@link info.magnolia.jcr.util.NodeTypes.Activatable#ACTIVATION_STATUS} instead
117 */
118 public static final String ACTIVATED = "activated";
119
120 /**
121 * Name of the node hosting the MetaData.
122 *
123 * @deprecated since 5.0 - there's no longer such a subnode
124 */
125 public static final String DEFAULT_META_NODE = "MetaData";
126
127 /**
128 * @deprecated since 5.0 - use {@link info.magnolia.jcr.util.NodeTypes.Activatable#ACTIVATION_STATUS_NOT_ACTIVATED} instead
129 */
130 public static final int ACTIVATION_STATUS_NOT_ACTIVATED = NodeTypes.Activatable.ACTIVATION_STATUS_NOT_ACTIVATED;
131
132 /**
133 * @deprecated since 5.0 - use {@link info.magnolia.jcr.util.NodeTypes.Activatable#ACTIVATION_STATUS_MODIFIED} instead
134 */
135 public static final int ACTIVATION_STATUS_MODIFIED = NodeTypes.Activatable.ACTIVATION_STATUS_MODIFIED;
136
137 /**
138 * @deprecated since 5.0 - use {@link info.magnolia.jcr.util.NodeTypes.Activatable#ACTIVATION_STATUS_ACTIVATED} instead
139 */
140 public static final int ACTIVATION_STATUS_ACTIVATED = NodeTypes.Activatable.ACTIVATION_STATUS_ACTIVATED;
141
142 /**
143 * Since 5.0 this is the working node itself.
144 */
145 private Node node;
146
147 /**
148 * @param workingNode current <code>Node</code> on which <code>MetaData</code> is requested
149 * @param ignoredAccessManager no longer required hence use other constructor.
150 * @deprecated since 4.5 use MetaData(Node) instead.
151 */
152 protected MetaData(Node workingNode, AccessManager ignoredAccessManager) {
153 this(workingNode);
154 }
155
156 /**
157 * @param workingNode current <code>Node</code> on which <code>MetaData</code> is requested
158 */
159 public MetaData(Node workingNode) {
160 this.node = workingNode;
161 }
162
163 /**
164 * Maps property names from the names used when we had a MetaData sub node to their replacements on mixins on the
165 * working node itself.
166 */
167 private static Map<String, String> propertyMappings = new ConcurrentHashMap<String, String>();
168
169 static {
170 propertyMappings.put(RepositoryConstants.NAMESPACE_PREFIX + ":" + CREATION_DATE, NodeTypes.Created.CREATED);
171 propertyMappings.put(RepositoryConstants.NAMESPACE_PREFIX + ":" + LAST_MODIFIED, NodeTypes.LastModified.LAST_MODIFIED);
172 propertyMappings.put(RepositoryConstants.NAMESPACE_PREFIX + ":" + LAST_ACTION, NodeTypes.Activatable.LAST_ACTIVATED);
173 propertyMappings.put(RepositoryConstants.NAMESPACE_PREFIX + ":" + AUTHOR_ID, NodeTypes.LastModified.LAST_MODIFIED_BY);
174 propertyMappings.put(RepositoryConstants.NAMESPACE_PREFIX + ":" + ACTIVATOR_ID, NodeTypes.Activatable.LAST_ACTIVATED_BY);
175 propertyMappings.put(RepositoryConstants.NAMESPACE_PREFIX + ":" + TEMPLATE, NodeTypes.Renderable.TEMPLATE);
176 propertyMappings.put(RepositoryConstants.NAMESPACE_PREFIX + ":" + ACTIVATED, NodeTypes.Activatable.ACTIVATION_STATUS);
177 propertyMappings.put(RepositoryConstants.NAMESPACE_PREFIX + ":comment", NodeTypes.Versionable.COMMENT);
178 }
179
180 /**
181 * Returns the property name to use including its prefix.
182 *
183 * @return name with namespace prefix
184 */
185 private String getInternalPropertyName(String name) {
186 if (StringUtils.indexOf(name, ":") < 0) {
187 name = RepositoryConstants.NAMESPACE_PREFIX + ":" + name;
188 }
189
190 String newName = propertyMappings.get(name);
191
192 if (newName == null) {
193 throw new IllegalArgumentException("Unsupported meta data property: " + name);
194 }
195
196 return newName;
197 }
198
199 /**
200 * @return value of property TITLE if it's around on working node
201 * @deprecated since 5.0 - only for backwards compatibility.
202 */
203 public String getTitle() {
204 return getStringProperty(TITLE);
205 }
206
207 /**
208 * Will set value of property TITLE on working node.
209 *
210 * @deprecated since 5.0 - only for backwards compatibility.
211 */
212 public void setTitle(String value) {
213 setProperty(TITLE, value);
214 }
215
216 /**
217 * Part of metadata, adds creation date of the current node.
218 *
219 * @deprecated since 5.0 - use {@link info.magnolia.jcr.util.NodeTypes.Created#set(Node)}
220 */
221 public void setCreationDate() {
222 Calendar value = new GregorianCalendar(TimeZone.getDefault());
223 setProperty(CREATION_DATE, value);
224 }
225
226 /**
227 * Part of metadata, get creation date of the current node.
228 *
229 * @deprecated since 5.0 - use {@link info.magnolia.jcr.util.NodeTypes.Created#getCreated(Node)}
230 */
231 public Calendar getCreationDate() {
232 return this.getDateProperty(CREATION_DATE);
233 }
234
235 /**
236 * Part of metadata, adds activated status of the current node.
237 *
238 * @deprecated since 5.0 - use {@link info.magnolia.jcr.util.NodeTypes.Activatable#update(javax.jcr.Node, String, boolean)}
239 */
240 public void setActivated() {
241 setProperty(ACTIVATED, true);
242 }
243
244 /**
245 * Part of metadata, adds activated status of the current node.
246 *
247 * @deprecated since 5.0 - use {@link info.magnolia.jcr.util.NodeTypes.Activatable#update(javax.jcr.Node, String, boolean)}
248 */
249 public void setUnActivated() {
250 setProperty(ACTIVATED, false);
251 }
252
253 /**
254 * Part of metadata, get last activated status of the current node.
255 *
256 * @deprecated since 5.0 - use {@link info.magnolia.jcr.util.NodeTypes.Activatable#isActivated(javax.jcr.Node)}
257 */
258 public boolean getIsActivated() {
259 return getBooleanProperty(ACTIVATED);
260 }
261
262 /**
263 * Returns one of the ACTIVATION_STATUS_* constants.
264 *
265 * @deprecated since 5.0 - use {@link info.magnolia.jcr.util.NodeTypes.Activatable#getActivationStatus(javax.jcr.Node)}
266 */
267 public int getActivationStatus() {
268 if (getIsActivated()) {
269 if (getModificationDate() != null && getModificationDate().after(getLastActionDate())) {
270 // node has been modified after last activation
271 return ACTIVATION_STATUS_MODIFIED;
272 }
273 // activated and not modified ever since
274 return ACTIVATION_STATUS_ACTIVATED;
275 }
276 // never activated or deactivated
277 return ACTIVATION_STATUS_NOT_ACTIVATED;
278 }
279
280 /**
281 * Part of metadata, adds activated date of the current node.
282 *
283 * @deprecated since 5.0 - use {@link info.magnolia.jcr.util.NodeTypes.Activatable#update(javax.jcr.Node, String, boolean)}
284 */
285 public void setLastActivationActionDate() {
286 Calendar value = new GregorianCalendar(TimeZone.getDefault());
287 setProperty(LAST_ACTION, value);
288 }
289
290 /**
291 * Part of metadata, get last activated/de- date of the current node.
292 *
293 * @deprecated since 5.0 - use {@link info.magnolia.jcr.util.NodeTypes.Activatable#getLastActivated(javax.jcr.Node)}
294 */
295 public Calendar getLastActionDate() {
296 return getDateProperty(LAST_ACTION);
297 }
298
299 /**
300 * Part of metadata, adds modification date of the current node.
301 *
302 * @deprecated since 5.0 - use {@link info.magnolia.jcr.util.NodeTypes.LastModified#update(javax.jcr.Node)}
303 */
304 public void setModificationDate() {
305 Calendar value = new GregorianCalendar(TimeZone.getDefault());
306 setProperty(LAST_MODIFIED, value);
307 }
308
309 /**
310 * Get last modified date of the node to which this meta data belongs or creation date in case content was not
311 * modified since.
312 *
313 * @deprecated since 5.0 - use {@link info.magnolia.jcr.util.NodeTypes.LastModified#getLastModified(Node)}
314 */
315 public Calendar getModificationDate() {
316 Calendar modDate = getDateProperty(LAST_MODIFIED);
317 if (modDate == null) {
318 modDate = getCreationDate();
319 }
320 return modDate;
321 }
322
323 /**
324 * Part of metadata, last known author of this node.
325 *
326 * @deprecated since 5.0 - use {@link info.magnolia.jcr.util.NodeTypes.LastModified#getLastModifiedBy(javax.jcr.Node)}
327 */
328 public String getAuthorId() {
329 return getStringProperty(AUTHOR_ID);
330 }
331
332 /**
333 * Part of metadata, current logged-in author who did some action on this page.
334 *
335 * @deprecated since 5.0 - use {@link info.magnolia.jcr.util.NodeTypes.LastModified#update(javax.jcr.Node, String, java.util.Calendar)}
336 */
337 public void setAuthorId(String value) {
338 setProperty(AUTHOR_ID, value);
339 }
340
341 /**
342 * Part of metadata, last known activator of this node.
343 *
344 * @deprecated since 5.0 - use {@link info.magnolia.jcr.util.NodeTypes.Activatable#getLastActivatedBy(javax.jcr.Node)}
345 */
346 public String getActivatorId() {
347 return getStringProperty(ACTIVATOR_ID);
348 }
349
350 /**
351 * Part of metadata, current logged-in author who last activated this page.
352 *
353 * @deprecated since 5.0 - use {@link info.magnolia.jcr.util.NodeTypes.Activatable#update(javax.jcr.Node, String, boolean)} to directly set userName and true false.
354 */
355 public void setActivatorId(String value) {
356 setProperty(ACTIVATOR_ID, value);
357 }
358
359 /**
360 * Part of metadata, template which will be used to render content of this node.
361 *
362 * @deprecated since 5.0 - use {@link info.magnolia.jcr.util.NodeTypes.Renderable#getTemplate(javax.jcr.Node)}
363 */
364 public String getTemplate() {
365 return getStringProperty(TEMPLATE);
366 }
367
368 /**
369 * Part of metadata, template which will be used to render content of this node.
370 *
371 * @deprecated since 5.0 - use {@link info.magnolia.jcr.util.NodeTypes.Renderable#set(javax.jcr.Node, String)}
372 */
373 public void setTemplate(String value) {
374 setProperty(TEMPLATE, value);
375 }
376
377 public void setProperty(String name, String value) {
378 setJCRProperty(name, value);
379 }
380
381 public void setProperty(String name, long value) {
382 setJCRProperty(name, value);
383 }
384
385 public void setProperty(String name, double value) {
386 setJCRProperty(name, value);
387 }
388
389 public void setProperty(String name, boolean value) {
390 setJCRProperty(name, value);
391 }
392
393 public void setProperty(String name, Calendar value) {
394 setJCRProperty(name, value);
395 }
396
397 private void setJCRProperty(String name, Object value) {
398 final String propName = this.getInternalPropertyName(name);
399 try {
400 PropertyUtil.setProperty(node, propName, value);
401 } catch (RepositoryException re) {
402 log.error(re.getMessage(), re);
403 }
404 }
405
406 public boolean getBooleanProperty(String name) {
407 try {
408 final Property property = getJCRProperty(name);
409 if (property != null) {
410 return property.getBoolean();
411 }
412 } catch (RepositoryException re) {
413 log.error(re.getMessage(), re);
414 }
415 return false;
416 }
417
418 public double getDoubleProperty(String name) {
419 try {
420 final Property property = getJCRProperty(name);
421 if (property != null) {
422 return property.getDouble();
423 }
424 } catch (RepositoryException re) {
425 log.error(re.getMessage(), re);
426 }
427 return 0d;
428 }
429
430 public long getLongProperty(String name) {
431 try {
432 final Property property = getJCRProperty(name);
433 if (property != null) {
434 return property.getLong();
435 }
436 } catch (RepositoryException re) {
437 log.error(re.getMessage(), re);
438 }
439 return 0L;
440 }
441
442 public String getStringProperty(String name) {
443 try {
444 final Property property = getJCRProperty(name);
445 if (property != null) {
446 return property.getString();
447 }
448 } catch (RepositoryException re) {
449 log.error(re.getMessage(), re);
450 }
451 return StringUtils.EMPTY;
452 }
453
454 public Calendar getDateProperty(String name) {
455 try {
456 final Property property = getJCRProperty(name);
457 if (property != null) {
458 return property.getDate();
459 }
460 } catch (RepositoryException re) {
461 log.error(re.getMessage(), re);
462 }
463 return null;
464 }
465
466 /**
467 * remove specified property.
468 *
469 * @param name of the property to be removed
470 * @throws PathNotFoundException if property does not exist
471 * @throws RepositoryException if unable to remove
472 */
473 public void removeProperty(String name) throws PathNotFoundException, RepositoryException {
474 this.node.getProperty(this.getInternalPropertyName(name)).remove();
475 }
476
477 private Property getJCRProperty(String name) throws RepositoryException {
478 final String propName = this.getInternalPropertyName(name);
479 try {
480 return node.getProperty(propName);
481 } catch (PathNotFoundException re) {
482 log.debug("PathNotFoundException for property [{}] in node {}", propName, node);
483 }
484 return null;
485 }
486 }