View Javadoc

1   /**
2    * This file Copyright (c) 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.module.googlesitemap.service;
35  
36  import info.magnolia.jcr.util.PropertyUtil;
37  import info.magnolia.module.googlesitemap.GoogleSiteMapConfiguration;
38  import info.magnolia.module.googlesitemap.bean.SiteMapEntry;
39  import info.magnolia.module.googlesitemap.bean.SiteMapEntryList;
40  import info.magnolia.module.googlesitemap.config.SiteMapType;
41  
42  import java.io.StringWriter;
43  import java.util.ArrayList;
44  import java.util.Iterator;
45  import java.util.List;
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      public static final String MOBILE_ELEMENT_NAME = "mobile";
73  
74      public static final String MOBILE_PREFIX = "mobile";
75  
76      public static final String URL_ELEMENT_NAME = "url";
77  
78      private Logger log = LoggerFactory.getLogger(getClass());
79  
80      private Provider<SiteMapService> service;
81  
82      @Inject
83      public SiteMapXMLUtilImpl(Provider<SiteMapService> service) {
84          this.service = service;
85      }
86  
87      @Override
88      public String generateSiteMapXML(Node siteMapNode) throws RepositoryException, JAXBException {
89          List<SiteMapEntry> entries = new ArrayList<SiteMapEntry>();
90          Iterator<SiteMapEntry> entryIt = service.get().getSiteMapBeans(siteMapNode);
91          while (entryIt.hasNext()) {
92              entries.add(entryIt.next());
93          }
94          SiteMapType type = SiteMapType.valueOf(PropertyUtil.getString(siteMapNode, GoogleSiteMapConfiguration.TYPE_PROPERTY, SiteMapType.Standard.name()));
95          return marshalSiteMapEntries(entries, type);
96      }
97  
98      private String marshalSiteMapEntries(List<SiteMapEntry> entries, final SiteMapType type) throws JAXBException {
99          JAXBContext jaxbContext = JAXBContext.newInstance(SiteMapEntry.class, SiteMapEntryList.class);
100         StringWriter sw = new StringWriter();
101         Marshaller marshaller = jaxbContext.createMarshaller();
102         marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
103         marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
104 
105         try {
106             SiteMapEntryList list = new SiteMapEntryList(entries);
107             final XMLStreamWriter writer = XMLOutputFactory.newInstance().createXMLStreamWriter(sw);
108             final XMLStreamWriter delWriter = new DelegatingXMLStreamWriter(writer) {
109                 @Override
110                 public void writeStartElement(String prefix, String namespace, String localName) throws XMLStreamException {
111                     super.writeStartElement(prefix, namespace, localName);
112                     if (URL_ELEMENT_NAME.equals(namespace) && SiteMapType.Mobile == type) {
113                         writeEmptyElement(MOBILE_PREFIX, MOBILE_ELEMENT_NAME, "");
114                     }
115                 }
116 
117                 @Override
118                 public void writeNamespace(String prefix, String localName) throws XMLStreamException {
119                     super.writeNamespace(prefix, localName);
120                     if (type == SiteMapType.Mobile) {
121                         super.writeNamespace(MOBILE_PREFIX, MOBILE_SCHEMA_URL);
122                     }
123                 }
124             };
125             marshaller.marshal(list, delWriter);
126         } catch (PropertyException e) {
127             log.error("Failed to rebind marshaller's namespace prefix mapper, did the implementation of JAXB change?", e);
128         } catch (XMLStreamException e) {
129             log.error("Failed to marshal sitemap", e);
130         }
131         return sw.toString();
132     }
133 
134 }