alfresco-community-repo/source/java/org/alfresco/web/bean/wcm/InviteWebsiteUsersWizard.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.HashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Set;

import javax.faces.context.FacesContext;

import org.alfresco.model.WCMAppModel;
import org.alfresco.service.cmr.repository.ChildAssociationRef;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.security.AuthorityType;
import org.alfresco.service.namespace.QName;
import org.alfresco.service.namespace.RegexQNamePattern;
import org.alfresco.web.app.Application;
import org.alfresco.web.bean.repository.Node;
import org.alfresco.web.bean.wizard.BaseInviteUsersWizard;
import org.alfresco.web.ui.common.Utils;

/**
 * Bean providing the ability to invite users to a web project space.
 * 
 * @author kevinr
 */
public class InviteWebsiteUsersWizard extends BaseInviteUsersWizard
{
   private static final long serialVersionUID = -8128781845465773847L;

   /** Cache of available folder permissions */
   Set<String> folderPermissions = null;
   
   /** the node representing the website */
   private Node website;
   
   /** root AVM store the users are invited into */
   private String avmStore;
   
   /** assume we are launching the wizard standalone */
   private boolean standalone = true;
   
   /** AVM Browse Bean reference */
   protected AVMBrowseBean avmBrowseBean;

   /** Data for virtualization server notification  */
   private List<SandboxInfo> sandboxInfoList;
   
   
   /**
    * @param avmBrowseBean    The AVMBrowseBean to set.
    */
   public void setAvmBrowseBean(AVMBrowseBean avmBrowseBean)
   {
      this.avmBrowseBean = avmBrowseBean;
   }
   
   /**
    * @see org.alfresco.web.bean.wizard.BaseInviteUsersWizard#init(java.util.Map)
    */
   @Override
   public void init(Map<String, String> parameters)
   {
      super.init(parameters);
      // only allow one selection per authority
      this.allowDuplicateAuthorities = false;
      this.website = null;
      this.avmStore = null;
      this.standalone = true;
   }
   
   public void reset()
   {
      this.isFinished = false;
      this.allowDuplicateAuthorities = false;
      this.website = null;
      this.avmStore = null;
      this.standalone = true;
   }
   
   /**
    * @see org.alfresco.web.bean.wizard.BaseInviteUsersWizard#finishImpl(javax.faces.context.FacesContext, java.lang.String)
    */
   @Override
   protected String finishImpl(FacesContext context, String outcome) throws Exception
   {
      super.finishImpl(context, outcome);
      
      // create a sandbox for each user appropriately with permissions based on role
      // build a list of managers who will have full permissions on ALL staging areas
      List<String> managers = new ArrayList<String>(4);
      Set<String> existingUsers = new HashSet(8);
      if (isStandalone() == false)
      {
         // no website created yet - so we need to build the list of managers from the
         // invited users and the power user who is executing the create web project wizard 
         boolean foundCurrentUser = false;
         String currentUser = Application.getCurrentUser(context).getUserName();
         
         for (UserGroupRole userRole : this.userGroupRoles)
         {
            for (String userAuth : findNestedUserAuthorities(userRole.getAuthority()))
            {
               if (currentUser.equals(userAuth))
               {
                  foundCurrentUser = true;
               }
               if (AVMUtil.ROLE_CONTENT_MANAGER.equals(userRole.getRole()))
               {
                  managers.add(userAuth);
               }
            }
         }
         
         if (foundCurrentUser == false)
         {
            this.userGroupRoles.add(new UserGroupRole(currentUser, AVMUtil.ROLE_CONTENT_MANAGER, null));
            managers.add(currentUser);
         }
      }
      else
      {
         // website already exists - we are only adding to the existing sandboxes
         // so retrieve the list of managers from the existing users and the selected invitees
         for (UserGroupRole userRole : this.userGroupRoles)
         {
            for (String userAuth : findNestedUserAuthorities(userRole.getAuthority()))
            {
               if (AVMUtil.ROLE_CONTENT_MANAGER.equals(userRole.getRole()))
               {
                  managers.add(userAuth);
               }
            }
         }
         
         List<ChildAssociationRef> userInfoRefs = this.getNodeService().getChildAssocs(
            getNode().getNodeRef(), WCMAppModel.ASSOC_WEBUSER, RegexQNamePattern.MATCH_ALL);
         for (ChildAssociationRef ref : userInfoRefs)
         {
            NodeRef userInfoRef = ref.getChildRef();
            String username = (String)getNodeService().getProperty(userInfoRef, WCMAppModel.PROP_WEBUSERNAME);
            String userrole = (String)getNodeService().getProperty(userInfoRef, WCMAppModel.PROP_WEBUSERROLE);
            
            if (AVMUtil.ROLE_CONTENT_MANAGER.equals(userrole) &&
                managers.contains(username) == false)
            {
               managers.add(username);
            }
            
            // add each existing user to the exclude this - we cannot add them more than once!
            existingUsers.add(username);
         }
      }
      
      // build the sandboxes now we have the manager list and complete user list
      // and create an association to a node to represent each invited user
      this.sandboxInfoList = new LinkedList<SandboxInfo>();

      boolean managersUpdateRequired = false;
      for (UserGroupRole userRole : this.userGroupRoles)
      {
         for (String userAuth : findNestedUserAuthorities(userRole.getAuthority()))
         {
            // create the sandbox if the invited user does not already have one
            if (existingUsers.contains(userAuth) == false)
            {
               SandboxInfo info = SandboxFactory.createUserSandbox(
                     getAvmStore(), managers, userAuth, userRole.getRole());
               
               this.sandboxInfoList.add(info);
               
               // create an app:webuser instance for each authority and assoc to the website node
               Map<QName, Serializable> props = new HashMap<QName, Serializable>(2, 1.0f);
               props.put(WCMAppModel.PROP_WEBUSERNAME, userAuth);
               props.put(WCMAppModel.PROP_WEBUSERROLE, userRole.getRole());
               this.getNodeService().createNode(getNode().getNodeRef(),
                     WCMAppModel.ASSOC_WEBUSER,
                     WCMAppModel.ASSOC_WEBUSER,
                     WCMAppModel.TYPE_WEBUSER,
                     props);
               
               // if this new user is a manager, we'll need to update the manager permissions applied
               // to each existing user sandbox - to ensure that new managers have access to them
               managersUpdateRequired |= (AVMUtil.ROLE_CONTENT_MANAGER.equals(userRole.getRole()));
            }
         }
      }
      
      if (isStandalone() == true && managersUpdateRequired == true)
      {
         // walk existing sandboxes and reapply manager permissions to include any new manager users
         List<ChildAssociationRef> userInfoRefs = this.getNodeService().getChildAssocs(
            getNode().getNodeRef(), WCMAppModel.ASSOC_WEBUSER, RegexQNamePattern.MATCH_ALL);
         for (ChildAssociationRef ref : userInfoRefs)
         {
            NodeRef userInfoRef = ref.getChildRef();
            String username = (String)getNodeService().getProperty(userInfoRef, WCMAppModel.PROP_WEBUSERNAME);
            if (existingUsers.contains(username))
            {
               // only need to modify the sandboxes we haven't just created
               SandboxFactory.updateSandboxManagers(getAvmStore(), managers, username);
            }
         }
         SandboxFactory.updateStagingAreaManagers(getAvmStore(), getNode().getNodeRef(), managers);
      }
      
      return outcome;
   }
   
   /**
    * Handle notification to the virtualization server 
    * (this needs to occur after the sandbox is created in the main txn).
    */
   @Override
   protected String doPostCommitProcessing(FacesContext context, String outcome)
   {     
      // reload virtualisation server for webapp in this web project
      if (isStandalone())
      {
         for (SandboxInfo sandboxInfo : this.sandboxInfoList)
         {
            String newlyInvitedStoreName = AVMUtil.buildStagingStoreName(
                  sandboxInfo.getMainStoreName());
            
            String path = AVMUtil.buildStoreWebappPath(
                     newlyInvitedStoreName, this.avmBrowseBean.getWebapp());
            
            AVMUtil.updateVServerWebapp(path, true);
         }
      }
      return outcome;
   }
   
   /**
    * Find all nested user authorities contained with an authority
    * 
    * @param authority     The authority to search, USER authorities are returned immediately, GROUP authorites
    *                      are recursively scanned for contained USER authorities.
    * 
    * @return a Set of USER authorities
    */
   private Set<String> findNestedUserAuthorities(String authority)
   {
      Set<String> users;
      
      AuthorityType authType = AuthorityType.getAuthorityType(authority);
      if (authType.equals(AuthorityType.USER))
      {
         users = new HashSet<String>(1, 1.0f);
         if (this.getPersonService().personExists(authority) == true)
         {
            users.add(authority); 
         }
      }
      else if (authType.equals(AuthorityType.GROUP))
      {
         // walk each member of the group
         users = this.getAuthorityService().getContainedAuthorities(AuthorityType.USER, authority, false);
         for (String userAuth : users)
         {
            if (this.getPersonService().personExists(userAuth) == false)
            {
               users.remove(authType);
            }
         }
      }
      else
      {
         users = Collections.<String>emptySet();
      }
      
      return users;
   }
   
   /**
    * @return summary text for the wizard
    */
   public String getSummary()
   {
      FacesContext fc = FacesContext.getCurrentInstance();
      
      // build a summary section to list the invited users and there roles
      StringBuilder buf = new StringBuilder(128);
      String currentUser = Application.getCurrentUser(fc).getUserName();
      boolean foundCurrentUser = false;
      for (UserGroupRole userRole : this.userGroupRoles)
      {
         if (currentUser.equals(userRole.getAuthority()))
         {
            foundCurrentUser = true;
         }
         buf.append(Utils.encode(userRole.getLabel()));
         buf.append("<br>");
      }
      if (isStandalone() == false && foundCurrentUser == false)
      {
         buf.append(buildLabelForUserAuthorityRole(
               currentUser, AVMUtil.ROLE_CONTENT_MANAGER));
      }
      
      return buildSummary(
            new String[] {Application.getMessage(fc, MSG_USERROLES)},
            new String[] {buf.toString()});
   }

   @Override
   protected Set<String> getPermissionsForType()
   {
      if (this.folderPermissions == null)
      {
         // get permissions and roles for a website folder type
         this.folderPermissions = this.getPermissionService().getSettablePermissions(WCMAppModel.TYPE_AVMWEBFOLDER);
      }
       
      return this.folderPermissions;
   }

   protected void setNode(Node node)
   {
      this.website = node;
   }
   
   @Override
   protected Node getNode()
   {
      if (this.website != null)
      {
         return this.website;
      }
      else
      {
         return this.browseBean.getActionSpace();
      }
   }

   /**
    * @return Returns the root AVM store.
    */
   public String getAvmStore()
   {
      if (this.avmStore == null)
      {
         this.avmStore = (String)getNode().getProperties().get(WCMAppModel.PROP_AVMSTORE);
      }
      return this.avmStore;
   }

   /**
    * @param avmStore The root AVM store to set.
    */
   public void setAvmStore(String avmStore)
   {
      this.avmStore = avmStore;
   }

   /**
    * @return Returns the edit mode.
    */
   public boolean isStandalone()
   {
      return this.standalone;
   }

   /**
    * @param editMode The edit mode to set.
    */
   public void setStandalone(boolean editMode)
   {
      this.standalone = editMode;
   }
}