View Javadoc
1   /**
2    * This file Copyright (c) 2013-2017 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.module.googlesitemap.service;
35  
36  import info.magnolia.module.googlesitemap.SiteMapNodeTypes;
37  import info.magnolia.module.googlesitemap.bean.SiteMapEntry;
38  import info.magnolia.module.googlesitemap.bean.SiteMapEntryList;
39  import info.magnolia.module.googlesitemap.config.SiteMapType;
40  
41  import java.io.StringWriter;
42  import java.util.ArrayList;
43  import java.util.Iterator;
44  import java.util.List;
45  import java.util.Stack;
46  
47  import javax.inject.Provider;
48  import javax.inject.Singleton;
49  import javax.jcr.Node;
50  import javax.jcr.RepositoryException;
51  import javax.xml.bind.JAXBContext;
52  import javax.xml.bind.JAXBException;
53  import javax.xml.bind.Marshaller;
54  import javax.xml.bind.PropertyException;
55  import javax.xml.stream.XMLOutputFactory;
56  import javax.xml.stream.XMLStreamException;
57  import javax.xml.stream.XMLStreamWriter;
58  
59  import org.slf4j.Logger;
60  import org.slf4j.LoggerFactory;
61  
62  import com.google.inject.Inject;
63  
64  /**
65   * Implementation of {@link SiteMapXMLUtil}.
66   */
67  @Singleton
68  public class SiteMapXMLUtilImpl implements SiteMapXMLUtil {
69  
70      public static final String MOBILE_SCHEMA_URL = "http://www.google.com/schemas/sitemap-mobile/1.0";
71  
72      /**
73       * Tag indicating feature phone sitemaps
74       * <strong>(should not be used for smartphone versions)</strong>.
75       */
76      public static final String MOBILE_ELEMENT_NAME = "mobile";
77  
78      public static final String MOBILE_PREFIX = "mobile";
79  
80      public static final String URL_ELEMENT_NAME = "url";
81  
82      private Logger log = LoggerFactory.getLogger(getClass());
83  
84      private Provider<SiteMapService> service;
85  
86      @Inject
87      public SiteMapXMLUtilImpl(Provider<SiteMapService> service) {
88          this.service = service;
89      }
90  
91      /**
92       * Builds the XML representation of a give node's sitemap and returns it as a string.
93       * <br><br>
94       * Resulting XML is only compliant to <a href="http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd">definition</a> for
95       * non-"mobile" sitemaps, where "mobile" refers to <a href="https://support.google.com/webmasters/answer/6082207?rd=1">feature phone websites</a>.
96       */
97      @Override
98      public String generateSiteMapXML(Node siteMapNode) throws RepositoryException, JAXBException {
99          List<SiteMapEntry> entries = new ArrayList<SiteMapEntry>();
100         Iterator<SiteMapEntry> entryIt = service.get().getSiteMapBeans(siteMapNode);
101         while (entryIt.hasNext()) {
102             entries.add(entryIt.next());
103         }
104         String type = SiteMapNodeTypes.SiteMap.getType(siteMapNode) != null ? SiteMapNodeTypes.SiteMap.getType(siteMapNode) : SiteMapType.Standard.name();
105         return marshalSiteMapEntries(entries, SiteMapType.valueOf(type));
106     }
107 
108     private String marshalSiteMapEntries(List<SiteMapEntry> entries, final SiteMapType type) throws JAXBException {
109         JAXBContext jaxbContext = JAXBContext.newInstance(SiteMapEntry.class, SiteMapEntryList.class);
110         StringWriter sw = new StringWriter();
111         Marshaller marshaller = jaxbContext.createMarshaller();
112         marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
113         marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
114 
115         try {
116             SiteMapEntryList list = new SiteMapEntryList(entries);
117             final XMLStreamWriter writer = XMLOutputFactory.newInstance().createXMLStreamWriter(sw);
118             final XMLStreamWriter delWriter = new DelegatingXMLStreamWriter(writer) {
119                 Stack<String> namespaceStack = new Stack<>();
120 
121                 @Override
122                 public void writeStartElement(String prefix, String namespace, String localName) throws XMLStreamException {
123                     super.writeStartElement(prefix, namespace, localName);
124                     namespaceStack.push(namespace);
125                 }
126 
127                 @Override
128                 public void writeEndElement() throws XMLStreamException {
129                     if (URL_ELEMENT_NAME.equals(namespaceStack.pop()) && SiteMapType.Mobile == type) {
130                         writeEmptyElement(MOBILE_PREFIX, MOBILE_ELEMENT_NAME, "");
131                     }
132                     super.writeEndElement();
133                 }
134 
135                 @Override
136                 public void writeNamespace(String prefix, String localName) throws XMLStreamException {
137                     super.writeNamespace(prefix, localName);
138                     if (type == SiteMapType.Mobile) {
139                         super.writeNamespace(MOBILE_PREFIX, MOBILE_SCHEMA_URL);
140                     }
141                 }
142             };
143             marshaller.marshal(list, delWriter);
144         } catch (PropertyException e) {
145             log.error("Failed to rebind marshaller's namespace prefix mapper, did the implementation of JAXB change?", e);
146         } catch (XMLStreamException e) {
147             log.error("Failed to marshal sitemap", e);
148         }
149         return sw.toString();
150     }
151 
152 }