View Javadoc
1   /**
2    * This file Copyright (c) 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.pages.app;
35  
36  import info.magnolia.cms.core.Path;
37  import info.magnolia.context.SystemContext;
38  import info.magnolia.i18nsystem.SimpleTranslator;
39  import info.magnolia.jcr.util.NodeTypes;
40  import info.magnolia.objectfactory.ComponentProvider;
41  import info.magnolia.rendering.template.TemplateAvailability;
42  import info.magnolia.rendering.template.TemplateDefinition;
43  import info.magnolia.rendering.template.registry.TemplateDefinitionRegistry;
44  import info.magnolia.repository.RepositoryConstants;
45  import info.magnolia.ui.api.app.AppContext;
46  import info.magnolia.ui.api.app.AppView;
47  import info.magnolia.ui.api.location.Location;
48  import info.magnolia.ui.api.overlay.AlertCallback;
49  import info.magnolia.ui.contentapp.ContentApp;
50  import info.magnolia.ui.vaadin.overlay.MessageStyleTypeEnum;
51  
52  import java.util.Iterator;
53  
54  import javax.inject.Inject;
55  import javax.jcr.Node;
56  import javax.jcr.RepositoryException;
57  import javax.jcr.Session;
58  
59  import org.slf4j.Logger;
60  import org.slf4j.LoggerFactory;
61  
62  /**
63   * The Pages content app displays an alert when no templates are installed to help beginners.
64   *
65   * @see ContentApp
66   */
67  public class PagesContentApp extends ContentApp {
68  
69      private static final Logger log = LoggerFactory.getLogger(PagesContentApp.class);
70  
71      private final TemplateDefinitionRegistry templateDefinitionRegistry;
72      private final TemplateAvailability templateAvailability;
73      private final SimpleTranslator i18n;
74      private final SystemContext systemContext;
75  
76      private static final String HELP_URL = "https://documentation.magnolia-cms.com/display/DOCS54/Get+templates";
77  
78      @Inject
79      public PagesContentApp(AppContext appContext, AppView view, ComponentProvider componentProvider, TemplateDefinitionRegistry templateDefinitionRegistry, TemplateAvailability templateAvailability, SimpleTranslator i18n, SystemContext systemContext) {
80          super(appContext, view, componentProvider);
81          this.templateDefinitionRegistry = templateDefinitionRegistry;
82          this.templateAvailability = templateAvailability;
83          this.i18n = i18n;
84          this.systemContext = systemContext;
85      }
86  
87      @Override
88      public void start(Location location) {
89          super.start(location);
90  
91          // Display an alert with a help message if no page templates are available.
92          if (!hasAvailablePageTemplates()) {
93              final String templateAvailabilityMessage = i18n.translate("pages.noAvailableTemplatesAlert.templateAvailabilityMessage");
94              final String createTemplateLink = i18n.translate("pages.noAvailableTemplatesAlert.createTemplateLink", HELP_URL);
95              final String message = templateAvailabilityMessage + createTemplateLink;
96              getAppContext().openAlert(MessageStyleTypeEnum.INFO, i18n.translate("pages.noAvailableTemplatesAlert.title"), message, i18n.translate("button.ok"), new AlertCallback() {
97                  @Override
98                  public void onOk() {
99                      // Do nothing.
100                 }
101             });
102         }
103     }
104 
105     /**
106      * Returns whether any page templates are available.
107      */
108     protected boolean hasAvailablePageTemplates() {
109         boolean hasAvailablePageTemplates = false;
110 
111         try {
112             // Get root node
113             final Session session = systemContext.getJCRSession(RepositoryConstants.WEBSITE);
114             final Node websiteRootNode = session.getRootNode();
115 
116             // Create tmp node
117             final String tempNodeName = Path.getUniqueLabel(websiteRootNode, "tmp");
118             final Node tempNode = websiteRootNode.addNode(tempNodeName, NodeTypes.Page.NAME);
119 
120             // Test availability on tmp node
121             final Iterator<TemplateDefinition> iterator = templateDefinitionRegistry.getAllDefinitions().iterator();
122 
123             while (iterator.hasNext()) {
124                 final TemplateDefinition templateDefinition = iterator.next();
125                 if (templateAvailability.isAvailable(tempNode, templateDefinition)) {
126                     hasAvailablePageTemplates = true;
127                     break;
128                 }
129             }
130 
131             // Remove tmp node
132             session.removeItem(tempNode.getPath());
133         } catch (RepositoryException e) {
134             log.error("Failed to retrieve website workspace or create temporary node when trying to determine available page templates.", e);
135         }
136 
137         return hasAvailablePageTemplates;
138     }
139 
140 }