alfresco-community-repo/source/java/org/alfresco/web/bean/wcm/WebProject.java

/*
 * Copyright (C) 2005-2007 Alfresco Software Limited.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.

 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

 * As a special exception to the terms and conditions of version 2.0 of 
 * the GPL, you may redistribute this Program in connection with Free/Libre 
 * and Open Source Software ("FLOSS") applications as described in Alfresco's 
 * FLOSS exception.  You should have recieved a copy of the text describing 
 * the FLOSS exception, and it is also available here: 
 * http://www.alfresco.com/legal/licensing"
 */
package org.alfresco.web.bean.wcm;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import javax.faces.context.FacesContext;

import org.alfresco.error.AlfrescoRuntimeException;
import org.alfresco.model.ContentModel;
import org.alfresco.model.WCMAppModel;
import org.alfresco.sandbox.SandboxConstants;
import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.avm.AVMService;
import org.alfresco.service.cmr.dictionary.DataTypeDefinition;
import org.alfresco.service.cmr.repository.ChildAssociationRef;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.cmr.search.ResultSet;
import org.alfresco.service.cmr.search.ResultSetRow;
import org.alfresco.service.cmr.search.SearchParameters;
import org.alfresco.service.cmr.search.SearchService;
import org.alfresco.service.namespace.NamespaceService;
import org.alfresco.service.namespace.RegexQNamePattern;
import org.alfresco.web.app.Application;
import org.alfresco.web.app.servlet.FacesHelper;
import org.alfresco.web.bean.repository.Repository;
import org.alfresco.web.bean.repository.User;
import org.alfresco.web.data.IDataContainer;
import org.alfresco.web.data.QuickSort;
import org.alfresco.web.forms.Form;
import org.alfresco.web.forms.FormImpl;
import org.alfresco.web.forms.FormNotFoundException;
import org.alfresco.web.forms.FormsService;
import org.alfresco.web.forms.RenderingEngineTemplate;
import org.alfresco.web.forms.RenderingEngineTemplateImpl;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

/**
 * Provides configured data for a web project.
 *
 * @author Ariel Backenroth
 */
public class WebProject implements Serializable
{
   /////////////////////////////////////////////////////////////////////////////

   private static final long serialVersionUID = 2480625511643744703L;
   
   /**
    * Wraps a form object to provide overridden values at the web project level
    */
   private class FormWrapper extends FormImpl
   {
      private static final long serialVersionUID = 1L;
      
      private final NodeRef formNodeRef;
      private Form baseForm;
      private NodeRef defaultWorkflowNodeRef;

      private FormWrapper(final Form form, 
                          final NodeRef formNodeRef,
                          final FormsService formsService)
      {
         super(((FormImpl)form).getNodeRef(), formsService);
         this.formNodeRef = formNodeRef;
      }

      @Override
      public String getTitle()
      {
         final NodeService nodeService = this.getServiceRegistry().getNodeService();
         return (String)nodeService.getProperty(this.formNodeRef,
                                                ContentModel.PROP_TITLE);
      }

      @Override
      public String getDescription()
      {
         final NodeService nodeService = this.getServiceRegistry().getNodeService();
         return (String)nodeService.getProperty(this.formNodeRef,
                                                ContentModel.PROP_DESCRIPTION);
      }

      @Override
      public String getOutputPathPattern()
      {
         final NodeService nodeService = this.getServiceRegistry().getNodeService();
         final String result = (String)
            nodeService.getProperty(this.formNodeRef,
                                    WCMAppModel.PROP_OUTPUT_PATH_PATTERN);
         return (result != null ? result : this.baseForm.getOutputPathPattern());
      }

      @Override
      protected NodeRef getDefaultWorkflowNodeRef()
      {
         if (this.defaultWorkflowNodeRef == null)
         {
            final NodeService nodeService = this.getServiceRegistry().getNodeService();
            final List<ChildAssociationRef> workflowRefs = 
               nodeService.getChildAssocs(this.formNodeRef,
                                          WCMAppModel.ASSOC_WORKFLOWDEFAULTS,
                                          RegexQNamePattern.MATCH_ALL);
            if (workflowRefs.size() == 0)
            {
               return null;
            }
               
            this.defaultWorkflowNodeRef = workflowRefs.get(0).getChildRef();
         }
         return this.defaultWorkflowNodeRef;
      }

      @Override
      protected Map<String, RenderingEngineTemplate> loadRenderingEngineTemplates()
      {
         final Map<String, RenderingEngineTemplate> allRets = super.loadRenderingEngineTemplates();

         final NodeService nodeService = this.getServiceRegistry().getNodeService();
         final List<ChildAssociationRef> retNodeRefs = 
            nodeService.getChildAssocs(this.formNodeRef,
                                       WCMAppModel.ASSOC_WEBFORMTEMPLATE,
                                       RegexQNamePattern.MATCH_ALL);
         final Map<String, RenderingEngineTemplate> result = 
            new HashMap<String, RenderingEngineTemplate>(retNodeRefs.size(), 1.0f);
         for (ChildAssociationRef car : retNodeRefs)
         {
            final String renderingEngineTemplateName = (String)
               nodeService.getProperty(car.getChildRef(), 
                                       WCMAppModel.PROP_BASE_RENDERING_ENGINE_TEMPLATE_NAME);
            final String outputPathPattern = (String)
               nodeService.getProperty(car.getChildRef(), WCMAppModel.PROP_OUTPUT_PATH_PATTERN);
            final RenderingEngineTemplateImpl ret = (RenderingEngineTemplateImpl)
               allRets.get(renderingEngineTemplateName);
            result.put(ret.getName(), 
                       new RenderingEngineTemplateImpl(ret.getNodeRef(),
                                                       ret.getRenditionPropertiesNodeRef(),
                                                       this.getFormsService())
                       {
                          private static final long serialVersionUID = -5498865830153013192L;
                          
                          @Override
                          public String getOutputPathPattern()
                          {
                             return outputPathPattern;
                          }
                       });

         }
         return result;
      }
   }

   /////////////////////////////////////////////////////////////////////////////

   private final static Log LOGGER = LogFactory.getLog(WebProject.class); 
   
   private static NodeRef websitesFolder;
   private final NodeRef nodeRef;
   private String storeId = null;
   private Boolean hasWorkflow = null;
   private Map<String, String> userRoles = new HashMap<String, String>(16, 1.0f);
   
   public WebProject(final NodeRef nodeRef)
   {
      if (nodeRef == null)
      {
         throw new NullPointerException();
      }

      final NodeService nodeService = getServiceRegistry().getNodeService();
      if (!WCMAppModel.TYPE_AVMWEBFOLDER.equals(nodeService.getType(nodeRef)))
      {
         throw new IllegalArgumentException(nodeRef + " is not a " + WCMAppModel.TYPE_AVMWEBFOLDER);
      }

      this.nodeRef = nodeRef;
   }

   public WebProject(final String avmPath)
   {
      if (avmPath == null)
      {
         throw new NullPointerException();
      }
      
      final String stagingStore = AVMUtil.buildStagingStoreName(AVMUtil.getStoreId(AVMUtil.getStoreName(avmPath)));
      final AVMService avmService = this.getServiceRegistry().getAVMService();
      this.nodeRef = (NodeRef)
         avmService.getStoreProperty(stagingStore, 
                                     SandboxConstants.PROP_WEB_PROJECT_NODE_REF).getValue(DataTypeDefinition.NODE_REF);
   }

   /**
    * Returns the noderef for the webproject
    *
    * @return the noderef for the webproject.
    */
   public NodeRef getNodeRef()
   {
      return this.nodeRef;
   }

   /**
    * Returns the name of the web project.
    *
    * @return the name of the web project.
    */
   public String getName()
   {
      final NodeService nodeService = this.getServiceRegistry().getNodeService();
      return (String)nodeService.getProperty(this.nodeRef, ContentModel.PROP_NAME);
   }

   /**
    * Returns the title of the web project.
    *
    * @return the title of the web project.
    */
   public String getTitle()
   {
      final NodeService nodeService = this.getServiceRegistry().getNodeService();
      return (String)nodeService.getProperty(this.nodeRef, ContentModel.PROP_TITLE);
   }

   /**
    * Returns the description of the web project.
    *
    * @return the description of the web project.
    */
   public String getDescription()
   {
      final NodeService nodeService = this.getServiceRegistry().getNodeService();
      return (String)nodeService.getProperty(this.nodeRef, ContentModel.PROP_DESCRIPTION);
   }

   /**
    * Returns the store id for this web project.
    *
    * @return the store id for this web project.
    */
   public String getStoreId()
   {
      if (this.storeId == null)
      {
          final NodeService nodeService = this.getServiceRegistry().getNodeService();
          this.storeId = (String)nodeService.getProperty(this.nodeRef, WCMAppModel.PROP_AVMSTORE);
      }
      return this.storeId;
   }
   
   /**
    * Returns the staging store name.
    *
    * @return the staging store name.
    */
   public String getStagingStore()
   {
      return AVMUtil.buildStagingStoreName(this.getStoreId());
   }

   /**
    * Returns the forms configured for this web project.
    *
    * @return the forms configured for this web project.
    */
   public List<Form> getForms()
   {
      final List forms = new ArrayList(this.getFormsImpl().values());
      final QuickSort sorter = new QuickSort(forms, "name", true, IDataContainer.SORT_CASEINSENSITIVE);
      sorter.sort();
      return Collections.unmodifiableList(forms);
   }

   /**
    * Returns the form with the given name or <tt>null</tt> if not found.
    *
    * @param name the name of the form
    * @return the form or <tt>null</tt> if not found.
    * @exception NullPointerException if the name is <tt>null</tt>.
    */
   public Form getForm(final String name)
      throws FormNotFoundException
   {
      if (name == null)
      {
         throw new NullPointerException();
      }
      final Form result = this.getFormsImpl().get(name);
      if (result == null || !name.equals(result.getName()))
      {
         if (result != null)
         {
            LOGGER.debug("removing " + name + 
                         " from cache as it doesn't match mapped form " + result.getName());
            this.getFormsImpl().remove(name);
         }
         throw new FormNotFoundException(name, this);
      }
      return result;
   }
   
   /**
    * @return true if this WebProject has any workflows assigned directly to the website or
    *         assigned to any of the forms attached to it
    */
   public boolean hasWorkflow()
   {
      if (this.hasWorkflow == null)
      {
         final NodeService nodeService = this.getServiceRegistry().getNodeService();
         List<ChildAssociationRef> webWorkflowRefs = nodeService.getChildAssocs(
               this.nodeRef, WCMAppModel.ASSOC_WEBWORKFLOWDEFAULTS, RegexQNamePattern.MATCH_ALL);
         this.hasWorkflow = (webWorkflowRefs.size() != 0);
         if (!this.hasWorkflow)
         {
            // might have a workflow assigned to one of the forms used in the website
            Map<String, Form> forms = getFormsImpl();
            for (Form form : forms.values())
            {
               if (form.getDefaultWorkflow() != null)
               {
                  this.hasWorkflow = Boolean.TRUE;
                  break;
               }
            }
         }
      }
      return this.hasWorkflow.booleanValue();
   }

   /**
    * Returns <tt>true</tt> if the user is a manager of this web project.
    *
    * @param user the user
    * @return <tt>true</tt> if the user is a manager, <tt>false</tt> otherwise.
    * @exception NullPointerException if the user is null.
    */
   public boolean isManager(final User user)
   {
      String userrole;
      String username = user.getUserName();
      synchronized (userRoles)
      {
         userrole = userRoles.get(username);
         if (userrole == null)
         {
            userrole = WebProject.getWebProjectUserRole(nodeRef, user);
            userRoles.put(username, userrole);
         }
      }
      return AVMUtil.ROLE_CONTENT_MANAGER.equals(userrole);
   }
   
   /**
    * @return the role of this user in the given Web Project, or null for no assigned role
    */
   public static String getWebProjectUserRole(NodeRef webProjectRef, User user)
   {
      String userrole = null;
      
      long start = 0;
      if (LOGGER.isDebugEnabled())
      {
         start = System.currentTimeMillis();
      }
      
      if (user.isAdmin())
      {
         // fake the Content Manager role for an admin user
         userrole = AVMUtil.ROLE_CONTENT_MANAGER;
      }
      else
      {
         NodeService nodeService = WebProject.getServiceRegistry().getNodeService();
         
         NodeRef roleRef = findUserRoleNodeRef(webProjectRef, user);
         if (roleRef != null)
         {
            userrole = (String)nodeService.getProperty(roleRef, WCMAppModel.PROP_WEBUSERROLE);
         }
         else
         {
            LOGGER.warn("getWebProjectUserRole: user role not found for " + user);
         }
      }
      
      if (LOGGER.isDebugEnabled())
      {
         LOGGER.debug("getWebProjectUserRole: " + user.getUserName() + " " + userrole + " in " + (System.currentTimeMillis()-start) + " ms");
      }
      
      return userrole;
   }

   /**
    * Perform a Lucene search to return a NodeRef to the node representing the the User Role
    * within the given WebProject. 
    * 
    * @param webProjectRef      Web Project to search against
    * @param user               User to test against
    * 
    * @return NodeRef of the User Role node or null if none found
    */
   public static NodeRef findUserRoleNodeRef(NodeRef webProjectRef, User user)
   {
      SearchService searchService = WebProject.getServiceRegistry().getSearchService();
      
      StringBuilder query = new StringBuilder(128);
      query.append("+PARENT:\"").append(webProjectRef).append("\" ");
      query.append("+TYPE:\"").append(WCMAppModel.TYPE_WEBUSER).append("\" ");
      query.append("+@").append(NamespaceService.WCMAPP_MODEL_PREFIX).append("\\:username:\"");
      query.append(user.getUserName());
      query.append("\"");
      
      ResultSet resultSet = searchService.query(
            Repository.getStoreRef(),
            SearchService.LANGUAGE_LUCENE,
            query.toString());            
      List<NodeRef> nodes = resultSet.getNodeRefs();
      
      return (nodes.size() == 1 ? nodes.get(0) : null);
   }

   /**
    * Returns the default webapp for this web project.
    *
    * @return the default webapp for this web project.
    */
   public String getDefaultWebapp()
   {
      final ServiceRegistry serviceRegistry = this.getServiceRegistry();
      final NodeService nodeService = serviceRegistry.getNodeService();
      return (String)
         nodeService.getProperty(this.nodeRef, WCMAppModel.PROP_DEFAULTWEBAPP);
   }

   /**
    * Helper to get the ID of the 'Websites' system folder
    * 
    * @return ID of the 'Websites' system folder
    * 
    * @throws AlfrescoRuntimeException if unable to find the required folder
    */
   public synchronized static NodeRef getWebsitesFolder()
   {
      if (WebProject.websitesFolder == null)
      {
         // get the template from the special Content Templates folder
         final FacesContext fc = FacesContext.getCurrentInstance();
         final String xpath = Application.getRootPath(fc) + "/" + Application.getWebsitesFolderName(fc);
         
         final NodeRef rootNodeRef = WebProject.getServiceRegistry().getNodeService().getRootNode(Repository.getStoreRef());
         final NamespaceService resolver = Repository.getServiceRegistry(fc).getNamespaceService();
         final List<NodeRef> results = WebProject.getServiceRegistry().getSearchService().selectNodes(rootNodeRef, xpath, null, resolver, false);
         if (results.size() == 1)
         {
            WebProject.websitesFolder = new NodeRef(Repository.getStoreRef(), results.get(0).getId());
         }
         else
         {
            throw new AlfrescoRuntimeException("Unable to find 'Websites' system folder at: " + xpath);
         }
      }
      
      return WebProject.websitesFolder;
   }

   public static List<WebProject> getWebProjects()
   {
      final ServiceRegistry serviceRegistry = WebProject.getServiceRegistry();
      final SearchParameters sp = new SearchParameters();
      sp.addStore(Repository.getStoreRef());
      sp.setLanguage(SearchService.LANGUAGE_LUCENE);
      sp.setQuery("+TYPE:\"" + WCMAppModel.TYPE_AVMWEBFOLDER + 
                  "\" +PARENT:\"" + WebProject.getWebsitesFolder() + "\"");
      if (LOGGER.isDebugEnabled())
         LOGGER.debug("running query [" + sp.getQuery() + "]");
      final ResultSet rs = serviceRegistry.getSearchService().query(sp);
      if (LOGGER.isDebugEnabled())
         LOGGER.debug("received " + rs.length() + " results");
      final List<WebProject> result = new ArrayList<WebProject>(rs.length());
      for (ResultSetRow row : rs)
      {
         result.add(new WebProject(row.getNodeRef()));
      }
      QuickSort sorter = new QuickSort((List)result, "name", true, IDataContainer.SORT_CASEINSENSITIVE);
      sorter.sort();
      return result;
   }

   private Map<String, Form> getFormsImpl()
   {
      final ServiceRegistry serviceRegistry = this.getServiceRegistry();
      final NodeService nodeService = serviceRegistry.getNodeService();
      final FormsService formsService = WebProject.getFormsService();
      final List<ChildAssociationRef> formRefs = 
         nodeService.getChildAssocs(this.nodeRef,
                                    WCMAppModel.ASSOC_WEBFORM,
                                    RegexQNamePattern.MATCH_ALL);
      Map<String, Form> result = new HashMap<String, Form>(formRefs.size(), 1.0f);
      for (final ChildAssociationRef ref : formRefs)
      {
         final String formName = (String)
            nodeService.getProperty(ref.getChildRef(), WCMAppModel.PROP_FORMNAME);
         try
         {
            final Form baseForm = formsService.getWebForm(formName);
            result.put(formName, new FormWrapper(baseForm, ref.getChildRef(), formsService));
         }
         catch (FormNotFoundException fnfe)
         {
            LOGGER.debug("got exception " + fnfe.getMessage() + 
                         " while loading web forms for project " + this.getName());
         }
      }
      return result;
   }

   private static FormsService getFormsService()
   {
      return (FormsService)FacesHelper.getManagedBean(FacesContext.getCurrentInstance(),
                                                      "FormsService");
   }

   private static ServiceRegistry getServiceRegistry()
   {
      final FacesContext fc = FacesContext.getCurrentInstance();
      return Repository.getServiceRegistry(fc);
   }

   public boolean equals(final Object other)
   {
      return (other != null && 
              other instanceof WebProject && 
              this.getNodeRef().equals(((WebProject)other).getNodeRef()));
   }

   public int hashCode()
   {
      return this.nodeRef.hashCode();
   }
}