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  /**
59   * @author Sameer Charles
60   * @author Fabrizio Giustina
61   */
62  public class QueryResultImpl implements QueryResult {
63  
64      /**
65       * Logger.
66       */
67      private static Logger log = LoggerFactory.getLogger(QueryResultImpl.class);
68  
69      /**
70       * Unfiltered result object
71       */
72      protected javax.jcr.query.QueryResult result;
73  
74      /**
75       * caches all previously queried objects
76       */
77      protected Map<String, Collection<Content>> objectStore = new Hashtable<String, Collection<Content>>();
78  
79      /**
80       * @deprecated
81       */
82      private AccessManager accessManager;
83  
84      protected HierarchyManager hm;
85  
86      protected Map<String, String> dirtyHandles = new Hashtable<String, String>();
87  
88      protected QueryResultImpl(javax.jcr.query.QueryResult result, HierarchyManager hm) {
89          this.result = result;
90          this.hm = hm;
91          this.accessManager = hm.getAccessManager();
92      }
93  
94      /**
95       * @deprecated
96       * @return
97       */
98      public AccessManager getAccessManager() {
99          return accessManager;
100     }
101 
102     public javax.jcr.query.QueryResult getJcrResult() {
103         return result;
104     }
105 
106     /**
107      * Build required result objects
108      */
109     protected void build(String nodeType, Collection<Content> collection) throws RepositoryException {
110         this.objectStore.put(nodeType, collection);
111         NodeIterator nodeIterator = this.result.getNodes();
112 
113         // whitespace separated list (can't hurt since a single nodetype name can't contain a space)
114         String[] nodeTypes = StringUtils.split(nodeType);
115 
116         while (nodeIterator.hasNext()) {
117             Node node = nodeIterator.nextNode();
118             try {
119                 build(node, nodeTypes, collection);
120             }
121             catch (RepositoryException re) {
122                 log.error("{} caught while iterating on query results: {}", re.getClass().getName(), re.getMessage());
123                 if (log.isDebugEnabled()) {
124                     log.debug(
125                         re.getClass().getName() + " caught while iterating on query results: " + re.getMessage(),
126                         re);
127                 }
128             }
129         }
130     }
131 
132     /**
133      * Build required result objects
134      */
135     protected void build(Node node, String[] nodeType, Collection<Content> collection) throws RepositoryException {
136         /**
137          * All custom node types
138          */
139         if ((nodeType== null || nodeType.length == 0) || isNodeType(node, nodeType) && !node.isNodeType(ItemType.NT_RESOURCE)) {
140             if (this.dirtyHandles.get(node.getPath()) == null) {
141                 boolean isAllowed = this.hm.getAccessManager().isGranted(Path.getAbsolutePath(node.getPath()), Permission.READ);
142                 if (isAllowed) {
143                     collection.add(new DefaultContent(node, this.hm));
144                     this.dirtyHandles.put(node.getPath(), StringUtils.EMPTY);
145                 }
146             }
147             return;
148         }
149         if (node.getDepth() > 0) {
150             this.build(node.getParent(), nodeType, collection);
151         }
152     }
153 
154     /**
155      * @see info.magnolia.cms.core.search.QueryResult#getContent()
156      */
157     public Collection<Content> getContent() {
158         return getContent(ItemType.CONTENT.getSystemName());
159     }
160 
161     /**
162      * @see info.magnolia.cms.core.search.QueryResult#getContent(java.lang.String)
163      */
164     public Collection<Content> getContent(String nodeType) {
165         Collection<Content> resultSet = this.objectStore.get(nodeType);
166         if (resultSet == null) {
167             /* build it first time */
168             resultSet = new ArrayList<Content>();
169             try {
170                 this.build(nodeType, resultSet);
171             }
172             catch (RepositoryException re) {
173                 log.error(re.getMessage());
174             }
175         }
176         return resultSet;
177     }
178 
179     private boolean isNodeType(Node node, String[] nodeType) throws RepositoryException {
180 
181         for (String nt : nodeType) {
182             if (node.isNodeType(nt)) {
183                 return true;
184             }
185         }
186         return false;
187     }
188 }