View Javadoc
1   /**
2    * This file Copyright (c) 2013-2014 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.config;
35  
36  import info.magnolia.cms.beans.config.RegexpVirtualURIMapping;
37  import info.magnolia.cms.util.ObservationUtil;
38  import info.magnolia.context.SystemContext;
39  import info.magnolia.jcr.predicate.AbstractPredicate;
40  import info.magnolia.jcr.util.NodeUtil;
41  import info.magnolia.module.googlesitemap.GoogleSiteMapConfiguration;
42  import info.magnolia.module.googlesitemap.SiteMapNodeTypes;
43  
44  import java.util.HashMap;
45  import java.util.Iterator;
46  import java.util.Map;
47  
48  import javax.inject.Inject;
49  import javax.jcr.Node;
50  import javax.jcr.RepositoryException;
51  import javax.jcr.observation.EventIterator;
52  import javax.jcr.observation.EventListener;
53  
54  import org.slf4j.Logger;
55  import org.slf4j.LoggerFactory;
56  
57  /**
58   * Virtual URI mapping that compares source URI to names of sitemaps available in google-sitemap workspace
59   * and prepends the prefix.
60   */
61  public class SiteMapVirtualUriMapping extends RegexpVirtualURIMapping {
62  
63      public static final String XML_EXTENSION = ".xml";
64  
65      private Logger log = LoggerFactory.getLogger(getClass());
66  
67      private SystemContext context;
68  
69      private Map<String, String> siteMapUrlMappings = new HashMap<String, String>();
70  
71      private String prefix;
72  
73      private AbstractPredicate<Node> siteMapNodePredicate  = new AbstractPredicate<Node>() {
74          @Override
75          public boolean evaluateTyped(Node node) {
76              try {
77                  return NodeUtil.isNodeType(node, SiteMapNodeTypes.SiteMap.NAME);
78              } catch (RepositoryException e) {
79                  return false;
80              }
81          }
82      };
83  
84      @Inject
85      public SiteMapVirtualUriMapping(SystemContext context) {
86          this.context = context;
87          ObservationUtil.registerChangeListener(GoogleSiteMapConfiguration.WORKSPACE, "/", true, new EventListener() {
88              @Override
89              public void onEvent(EventIterator events) {
90                  reloadSiteMapNames();
91              }
92          });
93          reloadSiteMapNames();
94      }
95  
96      private void reloadSiteMapNames() {
97          try {
98              siteMapUrlMappings.clear();
99              Node root = context.getJCRSession(GoogleSiteMapConfiguration.WORKSPACE).getRootNode();
100             final Iterator<Node> it = NodeUtil.collectAllChildren(root, siteMapNodePredicate).iterator();
101             while (it.hasNext()) {
102                 Node node = it.next();
103                 if (SiteMapNodeTypes.SiteMap.getUrl(node) != null) {
104                     siteMapUrlMappings.put(SiteMapNodeTypes.SiteMap.getUrl(node), node.getPath() + XML_EXTENSION);
105                 }
106             }
107         } catch (RepositoryException e) {
108             log.warn("Failed to collect sitemap names: ", e.getMessage());
109         }
110     }
111 
112     @Override
113     public MappingResult mapURI(String uri) {
114         if (siteMapUrlMappings.containsKey(uri)) {
115             MappingResult result = new MappingResult();
116             result.setLevel(uri.length());
117             result.setToURI(prefix + siteMapUrlMappings.get(uri));
118             return result;
119         }
120         return null;
121     }
122 
123     public void setPrefix(String prefix) {
124         this.prefix = prefix;
125     }
126 }