Clover icon

Google Sitemap Module 2.5

  1. Project Clover database Tue Nov 14 2017 13:12:18 CET
  2. Package info.magnolia.module.googlesitemap.config

File SiteMapVirtualUriMapping.java

 

Coverage histogram

../../../../../img/srcFileCovDistChart10.png
0% of files have more coverage

Code metrics

6
22
5
1
136
80
10
0.45
4.4
5
2
10.8% of code in this file is excluded from these metrics.

Classes

Class Line # Actions
SiteMapVirtualUriMapping 66 22 10.8% 10 2
0.9393939493.9%
 

Contributing tests

No tests hitting this source file were found.

Source view

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.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.apache.commons.lang3.StringUtils;
55    import org.slf4j.Logger;
56    import org.slf4j.LoggerFactory;
57   
58    /**
59    * Virtual URI mapping that compares source URI to names of sitemaps available in google-sitemap workspace
60    * and prepends the prefix.
61    *
62    * @deprecated since 2.5, SiteMapVirtualUriMapping has been relocated to the {@link info.magnolia.module.googlesitemap.config.mapping.SiteMapVirtualUriMapping}.
63    * Because virtual URI mappings have been relocated to the virtual-uri module (see MAGNOLIA-3349, MAGNOLIA-7016).
64    */
65    @Deprecated
 
66    public class SiteMapVirtualUriMapping extends RegexpVirtualURIMapping {
67   
68    public static final String XML_EXTENSION = ".xml";
69   
70    private Logger log = LoggerFactory.getLogger(getClass());
71   
72    private SystemContext context;
73   
74    private Map<String, String> siteMapUrlMappings = new HashMap<String, String>();
75   
76    private String prefix;
77   
78    private AbstractPredicate<Node> siteMapNodePredicate = new AbstractPredicate<Node>() {
 
79  27 toggle @Override
80    public boolean evaluateTyped(Node node) {
81  27 try {
82  27 return NodeUtil.isNodeType(node, SiteMapNodeTypes.SiteMap.NAME);
83    } catch (RepositoryException e) {
84  0 return false;
85    }
86    }
87    };
88   
 
89  2 toggle @Inject
90    public SiteMapVirtualUriMapping(SystemContext context) {
91  2 this.context = context;
92  2 ObservationUtil.registerChangeListener(GoogleSiteMapConfiguration.WORKSPACE, "/", true, new EventListener() {
 
93  6 toggle @Override
94    public void onEvent(EventIterator events) {
95  6 reloadSiteMapNames();
96    }
97    });
98  2 reloadSiteMapNames();
99    }
100   
 
101  8 toggle private void reloadSiteMapNames() {
102  8 try {
103  8 siteMapUrlMappings.clear();
104  8 Node root = context.getJCRSession(GoogleSiteMapConfiguration.WORKSPACE).getRootNode();
105  8 final Iterator<Node> it = NodeUtil.collectAllChildren(root, siteMapNodePredicate).iterator();
106  26 while (it.hasNext()) {
107  18 Node node = it.next();
108  18 if (SiteMapNodeTypes.SiteMap.getUrl(node) != null) {
109  12 siteMapUrlMappings.put(SiteMapNodeTypes.SiteMap.getUrl(node), node.getPath() + XML_EXTENSION);
110    }
111    }
112    } catch (RepositoryException e) {
113  0 log.warn("Failed to collect sitemap names: ", e.getMessage());
114    }
115    }
116   
 
117  3 toggle @Override
118    public MappingResult mapURI(String uri) {
119  3 if (siteMapUrlMappings.containsKey(uri)) {
120  1 MappingResult result = new MappingResult();
121  1 result.setLevel(uri.length());
122  1 result.setToURI(prefix + siteMapUrlMappings.get(uri));
123  1 return result;
124    }
125  2 return null;
126    }
127   
 
128    toggle @Override
129    public boolean isValid() {
130    return StringUtils.isNotEmpty(prefix);
131    }
132   
 
133    toggle public void setPrefix(String prefix) {
134    this.prefix = prefix;
135    }
136    }