View Javadoc

1   /**
2    * This file Copyright (c) 2010-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.info/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.module.groovy.console;
35  
36  import java.io.Serializable;
37  
38  import info.magnolia.cms.beans.config.ContentRepository;
39  import info.magnolia.cms.core.Content;
40  import info.magnolia.cms.core.HierarchyManager;
41  import info.magnolia.cms.util.HierarchyManagerWrapper;
42  import info.magnolia.context.Context;
43  import info.magnolia.context.ContextDecorator;
44  import info.magnolia.context.DefaultRepositoryStrategy;
45  import info.magnolia.context.RepositoryAcquiringStrategy;
46  import info.magnolia.context.SystemContext;
47  import info.magnolia.context.SystemRepositoryStrategy;
48  import info.magnolia.context.UserContext;
49  import info.magnolia.module.groovy.support.nodes.MgnlGroovyNode;
50  
51  
52  /**
53   * Custom context which returns a special version of {@link HierarchyManager} wrapping content as {@link MgnlGroovyNode}.
54   * @author pbaerfuss
55   * @version $Id$
56   *
57   */
58  public class MgnlGroovyConsoleContext extends ContextDecorator {
59  
60      private static final class InternalHierarchyManagerWrapper extends
61          HierarchyManagerWrapper {
62          private InternalHierarchyManagerWrapper(HierarchyManager wrappedHM) {
63              super(wrappedHM);
64          }
65  
66          @Override
67          protected Content wrap(Content content) {
68              return new MgnlGroovyNode(content);
69          }
70      }
71      //need this to avoid warning when setting strategy as session attribute in context
72      private static final class SerializableRepositoryStrategy extends DefaultRepositoryStrategy implements Serializable {
73          private static final long serialVersionUID = 1L;
74  
75          public SerializableRepositoryStrategy(UserContext context) {
76              super(context);
77          }
78      }
79  
80      private static final long serialVersionUID = 1L;
81  
82      private static final String STRATEGY_ATTRIBUTE = MgnlGroovyConsole.class.getName() + ".strategy";
83  
84      public MgnlGroovyConsoleContext(Context ctx) {
85          super(ctx);
86      }
87  
88      public RepositoryAcquiringStrategy getRepositoryStrategy() {
89  
90          RepositoryAcquiringStrategy strategy = (RepositoryAcquiringStrategy) getAttribute(STRATEGY_ATTRIBUTE, Context.SESSION_SCOPE);
91          if (strategy == null) {
92              //this is only needed by the the MgnlGroovyRescueServlet (that is in exceptional cases, when you're in dire straits)
93              //as operations there are executed in SystemContext
94              if(SystemContext.class.isAssignableFrom(ctx.getClass())){
95                  strategy = new SystemRepositoryStrategy((SystemContext) ctx);
96              } else {
97                  strategy = new SerializableRepositoryStrategy((UserContext) ctx);
98              }
99              setAttribute(STRATEGY_ATTRIBUTE, strategy, Context.SESSION_SCOPE);
100         }
101         return strategy;
102     }
103 
104     @Override
105     public HierarchyManager getHierarchyManager(String repositoryId) {
106         final HierarchyManager hm = getHierarchyManager(repositoryId, ContentRepository.getDefaultWorkspace(repositoryId));
107         return new InternalHierarchyManagerWrapper(hm);
108     }
109 
110     @Override
111     public HierarchyManager getHierarchyManager(String repositoryId, String workspaceId) {
112         return getRepositoryStrategy().getHierarchyManager(repositoryId, workspaceId);
113     }
114 
115 }