View Javadoc

1   /**
2    * This file Copyright (c) 2007-2011 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.delta;
35  
36  import info.magnolia.cms.util.WorkspaceXmlUtil;
37  
38  import java.util.List;
39  
40  /**
41   * A utility class for workspace.xml related conditions, which will add
42   * conditions to a given list of tasks based on some conditions.
43   *
44   * @version $Id$
45   */
46  public class WorkspaceXmlConditionsUtil {
47      private final List<Condition> conditions;
48  
49      public WorkspaceXmlConditionsUtil(List<Condition> conditions) {
50          this.conditions = conditions;
51      }
52  
53      /**
54       * @deprecated since 4.5 - use {@link #textFilterClassesAreNotSet()} instead.
55       */
56      public void workspaceHasOldIndexer() {
57          textFilterClassesAreNotSet();
58      }
59  
60      public void textFilterClassesAreNotSet() {
61          List<String> names =  WorkspaceXmlUtil.getWorkspaceNamesMatching("/Workspace/SearchIndex/param[@name='textFilterClasses']/@value");
62  
63          if (names.size() > 0) {
64              for (int i = 0; i < names.size(); i++) {
65                  conditions.add(new FalseCondition("workspace.xml updates",
66                          "Workspace definition in workspace " + names.get(i) +
67                                  " references indexer which has changed; please update value of parameter named" +
68                                  " textFilterClasses in your workspace.xml file."));
69              }
70          }
71      }
72  
73      /**
74       * Until https://issues.apache.org/jira/browse/JCR-3236 is fixed the param "analyzer" should not be around.
75       */
76      public void paramAnalyzerIsNotSet() {
77          List<String> names = WorkspaceXmlUtil.getWorkspaceNamesMatching("/Workspace/SearchIndex/param[@name='analyzer']/@value");
78          if (names.size() > 0) {
79              for (int i = 0; i < names.size(); i++) {
80                  conditions.add(new WarnCondition("workspace.xml updates",
81                          "Workspace definition in workspace " + names.get(i) +
82                                  " Should not have an analyzer set - this will lead to error-logs when strarting up your server."));
83              }
84          }
85      }
86  
87      public void accessControlProviderIsSet() {
88          List<String> names = WorkspaceXmlUtil.getWorkspaceNames("/Workspace/WorkspaceSecurity/AccessControlProvider/@class", null);
89          if (names.size() > 0) {
90              for (int i = 0; i < names.size(); i++) {
91                  conditions.add(new FalseCondition("workspace.xml updates",
92                          "Workspace definition in workspace " + names.get(i) +
93                                  " must have an AccessControlProvider set."));
94              }
95          }
96      }
97  }