View Javadoc
1   /**
2    * This file Copyright (c) 2013-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.ui.mediaeditor;
35  
36  import info.magnolia.config.source.ConfigurationSourceFactory;
37  import info.magnolia.jcr.predicate.AbstractPredicate;
38  import info.magnolia.jcr.wrapper.ExtendingNodeWrapper;
39  import info.magnolia.module.ModuleLifecycle;
40  import info.magnolia.module.ModuleLifecycleContext;
41  import info.magnolia.ui.dialog.definition.ConfiguredFormDialogDefinition;
42  import info.magnolia.ui.mediaeditor.definition.MediaEditorDefinition;
43  import info.magnolia.ui.mediaeditor.registry.ConfiguredMediaEditorDefinitionManager;
44  import info.magnolia.ui.mediaeditor.registry.MediaEditorRegistry;
45  
46  import javax.inject.Inject;
47  import javax.jcr.Node;
48  import javax.jcr.RepositoryException;
49  
50  /**
51   * Binds {@link MediaEditorRegistry} to JCR and Yaml config sources.
52   */
53  public class MediaEditorModule implements ModuleLifecycle {
54  
55      private ConfigurationSourceFactory configSourceFactory;
56  
57      private MediaEditorRegistry registry;
58  
59      @Inject
60      public MediaEditorModule(ConfigurationSourceFactory configSourceFactory, MediaEditorRegistry registry) {
61          this.configSourceFactory = configSourceFactory;
62          this.registry = registry;
63      }
64  
65      @Override
66      public void start(ModuleLifecycleContext context) {
67          if (context.getPhase() == ModuleLifecycleContext.PHASE_SYSTEM_STARTUP) {
68  
69              configSourceFactory.jcr().withFilter(new IsMediaEditor()).withModulePath("mediaEditors").bindTo(registry);
70              configSourceFactory.yaml().bindWithDefaults(registry);
71          }
72      }
73  
74      @Override
75      public void stop(ModuleLifecycleContext moduleLifecycleContext) {
76      }
77  
78      /**
79       * Check if this node can be handled as an {@link MediaEditorDefinition}.
80       * Prior to 5.4, this was in {@link ConfiguredMediaEditorDefinitionManager}.
81       */
82      private static class IsMediaEditor extends AbstractPredicate<Node> {
83  
84          @Override
85          public boolean evaluateTyped(Node node) {
86              try {
87                  if (node.hasProperty(ConfiguredFormDialogDefinition.EXTEND_PROPERTY_NAME)) {
88                      node = new ExtendingNodeWrapper(node);
89                  }
90                  return "mediaEditors".equalsIgnoreCase(node.getParent().getName());
91              } catch (RepositoryException e) {
92                  throw new RuntimeException(e);
93              }
94          }
95      }
96  }