View Javadoc

1   /**
2    * This file Copyright (c) 2003-2010 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.cms.core.search;
35  
36  import info.magnolia.cms.core.Content;
37  import info.magnolia.cms.core.DefaultContent;
38  import info.magnolia.cms.core.HierarchyManager;
39  import info.magnolia.cms.core.ItemType;
40  import info.magnolia.cms.core.Path;
41  import info.magnolia.cms.security.AccessManager;
42  import info.magnolia.cms.security.Permission;
43  
44  import java.util.ArrayList;
45  import java.util.Collection;
46  import java.util.Hashtable;
47  import java.util.Map;
48  
49  import javax.jcr.Node;
50  import javax.jcr.NodeIterator;
51  import javax.jcr.RepositoryException;
52  
53  import org.apache.commons.lang.StringUtils;
54  import org.slf4j.Logger;
55  import org.slf4j.LoggerFactory;
56  
57  /**
58   * Wrapping a JCR {@link javax.jcr.query.QueryResult}. This class will filter
59   * the result according to the user's ACLs. You can use
60   * {@link #getContent(String)} to retrieve nodes of a certain type. If the
61   * node's type doesn't match the nearest matching ancestors is add instead. This
62   * allows to search in paragraph content while retrieving  a list of pages.
63   *
64   * @author Sameer Charles
65   * @author Fabrizio Giustina
66   */
67  public class QueryResultImpl implements QueryResult {
68  
69      /**
70       * Logger.
71       */
72      private static Logger log = LoggerFactory.getLogger(QueryResultImpl.class);
73  
74      /**
75       * Unfiltered result object.
76       */
77      protected javax.jcr.query.QueryResult result;
78  
79      /**
80       * caches all previously queried objects.
81       */
82      protected Map<String, Collection<Content>> objectStore = new Hashtable<String, Collection<Content>>();
83  
84      /**
85       * @deprecated
86       */
87      private AccessManager accessManager;
88  
89      protected HierarchyManager hm;
90  
91      protected Map<String, String> dirtyHandles = new Hashtable<String, String>();
92  
93      protected QueryResultImpl(javax.jcr.query.QueryResult result, HierarchyManager hm) {
94          this.result = result;
95          this.hm = hm;
96          this.accessManager = hm.getAccessManager();
97      }
98  
99      /**
100      * @deprecated
101      * @return
102      */
103     public AccessManager getAccessManager() {
104         return accessManager;
105     }
106 
107     public javax.jcr.query.QueryResult getJcrResult() {
108         return result;
109     }
110 
111     /**
112      * Adds all found nodes of a certain type. If the type doesn't match it will traverse the ancestors and add them instead.
113      */
114     protected void build(String nodeType, Collection<Content> collection) throws RepositoryException {
115         this.objectStore.put(nodeType, collection);
116         NodeIterator nodeIterator = this.result.getNodes();
117 
118         // whitespace separated list (can't hurt since a single nodetype name can't contain a space)
119         String[] nodeTypes = StringUtils.split(nodeType);
120 
121         while (nodeIterator.hasNext()) {
122             Node node = nodeIterator.nextNode();
123             try {
124                 build(node, nodeTypes, collection);
125             }
126             catch (RepositoryException re) {
127                 log.error("{} caught while iterating on query results: {}", re.getClass().getName(), re.getMessage());
128                 if (log.isDebugEnabled()) {
129                     log.debug(
130                         re.getClass().getName() + " caught while iterating on query results: " + re.getMessage(),
131                         re);
132                 }
133             }
134         }
135     }
136 
137     /**
138      * Traverses the hierarchy from the current node to the root until the node's type matches.
139      */
140     protected void build(Node node, String[] nodeType, Collection<Content> collection) throws RepositoryException {
141         /**
142          * All custom node types
143          */
144         if ((nodeType== null || nodeType.length == 0) || isNodeType(node, nodeType) && !node.isNodeType(ItemType.NT_RESOURCE)) {
145             if (this.dirtyHandles.get(node.getPath()) == null) {
146                 boolean isAllowed = this.hm.getAccessManager().isGranted(Path.getAbsolutePath(node.getPath()), Permission.READ);
147                 if (isAllowed) {
148                     collection.add(new DefaultContent(node, this.hm));
149                     this.dirtyHandles.put(node.getPath(), StringUtils.EMPTY);
150                 }
151             }
152             return;
153         }
154         if (node.getDepth() > 0) {
155             this.build(node.getParent(), nodeType, collection);
156         }
157     }
158 
159     public Collection<Content> getContent() {
160         return getContent(ItemType.CONTENT.getSystemName());
161     }
162 
163     public Collection<Content> getContent(String nodeType) {
164         Collection<Content> resultSet = this.objectStore.get(nodeType);
165         if (resultSet == null) {
166             /* build it first time */
167             resultSet = new ArrayList<Content>();
168             try {
169                 this.build(nodeType, resultSet);
170             }
171             catch (RepositoryException re) {
172                 log.error(re.getMessage());
173             }
174         }
175         return resultSet;
176     }
177 
178     private boolean isNodeType(Node node, String[] nodeType) throws RepositoryException {
179 
180         for (String nt : nodeType) {
181             if (node.isNodeType(nt)) {
182                 return true;
183             }
184         }
185         return false;
186     }
187 }