alfresco-community-repo/source/java/org/alfresco/web/bean/wcm/DeleteSandboxDialog.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.text.MessageFormat;
import java.util.List;

import javax.faces.context.FacesContext;

import org.alfresco.model.WCMAppModel;
import org.alfresco.service.cmr.avm.AVMService;
import org.alfresco.service.cmr.avm.locking.AVMLockingService;
import org.alfresco.service.cmr.repository.ChildAssociationRef;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.namespace.RegexQNamePattern;
import org.alfresco.web.app.AlfrescoNavigationHandler;
import org.alfresco.web.app.Application;
import org.alfresco.web.bean.dialog.BaseDialogBean;
import org.alfresco.web.bean.repository.Node;
import org.alfresco.web.bean.repository.Repository;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

/**
 * Bean implementation for the AVM "Delete Sandbox" dialog
 * 
 * @author kevinr
 */
public class DeleteSandboxDialog extends BaseDialogBean
{
   private static final long serialVersionUID = 6139801947722234685L;

   private static final Log logger = LogFactory.getLog(DeleteSandboxDialog.class);
   
   transient private AVMService avmService;
   protected AVMBrowseBean avmBrowseBean;
   transient private AVMLockingService avmLockingService;
   
   
   // ------------------------------------------------------------------------------
   // Bean property getters and setters 
   
   /**
    * @param avmBrowseBean The avmBrowseBean to set.
    */
   public void setAvmBrowseBean(AVMBrowseBean avmBrowseBean)
   {
      this.avmBrowseBean = avmBrowseBean;
   }

   /**
    * @param avmService    The avmService to set.
    */
   public void setAvmService(AVMService avmService)
   {
      this.avmService = avmService;
   }
   
   protected AVMService getAvmService()
   {
      if (avmService == null)
      {
         avmService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getAVMService();
      }
      return avmService;
   }
   
   /**
    * @param avmLockingService The AVMLockingService to set
    */
   public void setAvmLockingService(AVMLockingService avmLockingService)
   {
      this.avmLockingService = avmLockingService;
   }
   
   protected AVMLockingService getAvmLockingService()
   {
      if (avmLockingService == null)
      {
         avmLockingService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getAVMLockingService();
      }
      return avmLockingService;
   }
   
   
   // ------------------------------------------------------------------------------
   // Dialog implementation
   
   @Override
   protected String finishImpl(FacesContext context, String outcome)
         throws Exception
   {
      // the username for the sandbox to delete
      String username = this.avmBrowseBean.getUsername();
      if (username != null)
      {
         Node website = this.avmBrowseBean.getWebsite();
         String storeRoot = (String)website.getProperties().get(WCMAppModel.PROP_AVMSTORE);
         String mainStore   = AVMUtil.buildUserMainStoreName(storeRoot, username);
         
         // remove the store reference from the website folder meta-data
         List<ChildAssociationRef> userInfoRefs = this.getNodeService().getChildAssocs(
                  website.getNodeRef(),
                  WCMAppModel.ASSOC_WEBUSER, RegexQNamePattern.MATCH_ALL);
         for (ChildAssociationRef ref : userInfoRefs)
         {
            NodeRef userInfoRef = ref.getChildRef();
            String user = (String)getNodeService().getProperty(userInfoRef, WCMAppModel.PROP_WEBUSERNAME);
            
            if (username.equals(user))
            {
               // found the sandbox to remove
               String path      = AVMUtil.buildStoreWebappPath(mainStore, this.avmBrowseBean.getWebapp());

               // Notify virtualisation server about removing this sandbox.
               //
               // Implementation note:
               //
               //     Because the removal of virtual webapps in the 
               //     virtualization server is recursive,  it only
               //     needs to be given the name of the main store.  
               //
               //     This notification must occur *prior* to purging content
               //     within the AVM because the virtualization server must list
               //     the avm_webapps dir in each store to discover which 
               //     virtual webapps must be unloaded.  The virtualization 
               //     server traverses the sandbox's stores in most-to-least 
               //     dependent order, so clients don't have to worry about
               //     accessing a preview layer whose main layer has been torn
               //     out from under it.
               AVMUtil.removeAllVServerWebapps(path, true);
               
               // TODO: Use the .sandbox-id.  property to delete all sandboxes,
               //       rather than assume a sandbox always had a single preview
               //       layer attached.
               
               // purge the user main sandbox store from the system
               this.getAvmService().purgeStore(mainStore);
               // remove any locks this user may have
               this.getAvmLockingService().removeStoreLocks(mainStore);
               
               // purge the user preview sandbox store from the system
               String previewStore = AVMUtil.buildUserPreviewStoreName(storeRoot, username);
               this.getAvmService().purgeStore(previewStore);
               // remove any locks this user may have
               this.getAvmLockingService().removeStoreLocks(previewStore);
               
               // remove the association to this web project user meta-data
               this.getNodeService().removeChild(website.getNodeRef(), ref.getChildRef());
               
               break;
            }
         }
         
         // if the sandbox is allocated to a test server release it
         NodeRef testServer = DeploymentUtil.findAllocatedTestServer(mainStore);
         if (testServer != null)
         {
            getNodeService().setProperty(testServer, WCMAppModel.PROP_DEPLOYSERVERALLOCATEDTO, null);
            
            if (logger.isDebugEnabled())
               logger.debug("Released test server from user sandbox: " + mainStore);
         }
      }
      
      return outcome;
   }
      
   @Override
   protected String doPostCommitProcessing(FacesContext context, String outcome)
   {
      return AlfrescoNavigationHandler.CLOSE_DIALOG_OUTCOME;
   }
   
   @Override
   protected String getErrorMessageId()
   {
      return "error_delete_sandbox";
   }

   @Override
   public boolean getFinishButtonDisabled()
   {
      return false;
   }
   
   
   // ------------------------------------------------------------------------------
   // Bean Getters and Setters

   /**
    * Returns the confirmation to display to the user before deleting the user sandbox.
    * 
    * @return The formatted message to display
    */
   public String getConfirmMessage()
   {
      String fileConfirmMsg = Application.getMessage(FacesContext.getCurrentInstance(), 
               "delete_sandbox_confirm");
      
      return MessageFormat.format(fileConfirmMsg, 
            new Object[] {this.avmBrowseBean.getUsername()});
   }
}