View Javadoc

1   /**
2    * This file Copyright (c) 2011-2013 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.templating.elements;
35  
36  import info.magnolia.cms.beans.config.ServerConfiguration;
37  import info.magnolia.cms.core.Content;
38  import info.magnolia.cms.gui.i18n.I18nAuthoringSupport;
39  import info.magnolia.cms.gui.misc.Sources;
40  import info.magnolia.cms.i18n.I18nContentSupport;
41  import info.magnolia.cms.i18n.I18nContentSupportFactory;
42  import info.magnolia.cms.security.Permission;
43  import info.magnolia.cms.security.PermissionUtil;
44  import info.magnolia.context.MgnlContext;
45  import info.magnolia.link.LinkUtil;
46  import info.magnolia.rendering.context.RenderingContext;
47  import info.magnolia.rendering.engine.RenderException;
48  import info.magnolia.rendering.template.TemplateDefinition;
49  import info.magnolia.templating.freemarker.AreaDirective;
50  
51  import java.io.IOException;
52  import java.util.ArrayList;
53  import java.util.List;
54  import java.util.Locale;
55  
56  import javax.jcr.Node;
57  import javax.jcr.RepositoryException;
58  
59  import org.apache.commons.lang.StringUtils;
60  import org.slf4j.Logger;
61  import org.slf4j.LoggerFactory;
62  
63  
64  /**
65   * Embeds js and css needed while authoring pages.
66   *
67   * @version $Id$
68   */
69  public class InitElement extends AbstractContentTemplatingElement {
70  
71      public static final String PAGE_EDITOR_JS_SOURCE =  MgnlContext.getContextPath() + "/.resources/editor/info.magnolia.templating.editor.PageEditor/info.magnolia.templating.editor.PageEditor.nocache.js";
72      public static final String PAGE_EDITOR_CSS =  MgnlContext.getContextPath() + "/.resources/magnolia-templating-editor/css/editor.css";
73      private static final String CMS_PAGE_TAG = "cms:page";
74      private static final Logger log = LoggerFactory.getLogger(InitElement.class);
75  
76      private final I18nContentSupport i18nContentSupport = I18nContentSupportFactory.getI18nSupport();
77      private final I18nAuthoringSupport i18nAuthoringSupport = I18nAuthoringSupport.Factory.getInstance();
78      private String dialog;
79  
80      public InitElement(ServerConfiguration server, RenderingContext renderingContext) {
81          super(server, renderingContext);
82      }
83  
84      @Override
85      public void begin(Appendable out) throws IOException, RenderException {
86          if (!isAdmin()) {
87              return;
88          }
89  
90          Node content = getPassedContent();
91          if(content == null){
92              content = currentContent();
93          }
94  
95          TemplateDefinition templateDefinition = getRequiredTemplateDefinition();
96  
97          dialog = resolveDialog(templateDefinition);
98  
99          Sources src = new Sources(MgnlContext.getContextPath());
100         MarkupHelper helper = new MarkupHelper(out);
101         helper.append("<!-- begin js and css added by @cms.init -->\n");
102         helper.append("<meta name=\"gwt:property\" content=\"locale=" + i18nContentSupport.getLocale() +"\"/>\n");
103         helper.append(src.getHtmlCss());
104         helper.append(src.getHtmlJs(true)); // exclude calendar resources
105         helper.append("<link rel=\"stylesheet\" type=\"text/css\" href=\"" + PAGE_EDITOR_CSS + "\"></link>\n");
106         helper.append("<script type=\"text/javascript\" src=\"" + PAGE_EDITOR_JS_SOURCE + "\"></script>\n");
107 
108         try {
109             if (content != null) {
110                 if (!PermissionUtil.isGranted(content, Permission.WRITE)) {
111                     return;
112                 }
113             }
114         } catch (RepositoryException e) {
115             log.error("Can't read users permissions for node [" + content + "]. PageBar will not be rendered.");
116             return;
117         }
118         helper.openComment(CMS_PAGE_TAG);
119         if(content != null) {
120             helper.attribute(AreaDirective.CONTENT_ATTRIBUTE, getNodePath(content));
121         }
122         helper.attribute("dialog", dialog);
123         helper.attribute("preview", String.valueOf(MgnlContext.getAggregationState().isPreviewMode()));
124 
125         //here we provide the page editor with the available locales and their respective URI for the current page
126         if (i18nAuthoringSupport.isEnabled() && i18nContentSupport.isEnabled() && i18nContentSupport.getLocales().size()>1){
127 
128             Content currentPage = MgnlContext.getAggregationState().getMainContent();
129             String currentUri = createURI(currentPage, i18nContentSupport.getLocale());
130             helper.attribute("currentURI", currentUri);
131 
132             List<String> availableLocales =  new ArrayList<String>();
133 
134             for (Locale locale : i18nContentSupport.getLocales()) {
135                 String uri = createURI(currentPage, locale);
136                 String label = StringUtils.capitalize(locale.getDisplayLanguage(locale));
137                 if(StringUtils.isNotEmpty(locale.getCountry())){
138                     label += " (" + StringUtils.capitalize(locale.getDisplayCountry()) + ")";
139                 }
140                 availableLocales.add(label + ":" + uri);
141             }
142 
143             helper.attribute("availableLocales", StringUtils.join(availableLocales, ","));
144         }
145 
146         helper.append(" -->\n");
147         helper.closeComment(CMS_PAGE_TAG);
148     }
149 
150     @Override
151     public void end(Appendable out) throws IOException, RenderException {
152         if (!isAdmin()) {
153             return;
154         }
155         MarkupHelper helper = new MarkupHelper(out);
156         helper.append("\n<!-- end js and css added by @cms.init -->\n");
157     }
158 
159     public void setDialog(String dialog) {
160         this.dialog = dialog;
161     }
162 
163     private TemplateDefinition getRequiredTemplateDefinition() {
164         return (TemplateDefinition) getRenderingContext().getRenderableDefinition();
165     }
166 
167     private String resolveDialog(TemplateDefinition component) {
168         if (StringUtils.isNotEmpty(this.dialog)) {
169             return this.dialog;
170         }
171         String dialog = component.getDialog();
172         if (StringUtils.isNotEmpty(dialog)) {
173             return dialog;
174         }
175         return null;
176     }
177 
178     private String createURI(Content currentPage, Locale locale) {
179         // we are going to change the context language, this is ugly but is safe as only the current Thread is modified
180         Locale currentLocale = i18nContentSupport.getLocale();
181         String uri=null;
182         try {
183             // this is going to set the local in the aggregation state and hence wont change the i18nSupport object itself
184             i18nContentSupport.setLocale(locale);
185             uri = LinkUtil.createAbsoluteLink(currentPage);
186         }
187         // make sure that we always reset to the original locale
188         finally{
189             i18nContentSupport.setLocale(currentLocale);
190         }
191         return uri;
192     }
193 
194 }