. Checkpoint of WCM UI

- First pass of the Staging/User Sandboxes view for an AVM website folder
   - Basic layout and component structure only, nothing works yet
   - Panel for each user sandbox, collapsing area for change files (nothing in it yet)

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/WCM-DEV2/root@3782 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/web/ui/wcm/WebResources.java

@@ -0,0 +1,26 @@
+/*
+ * Copyright (C) 2005 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the
+ * License.
+ */
+package org.alfresco.web.ui.wcm;
+
+/**
+ * @author Kevin Roast
+ */
+public class WebResources extends org.alfresco.web.ui.repo.WebResources
+{
+   // Image paths
+   public static final String IMAGE_SANDBOX_32 = "/images/icons/sandbox_large.gif";
+}

source/java/org/alfresco/web/ui/wcm/component/UIUserSandboxes.java

@@ -0,0 +1,246 @@
+/*
+ * Copyright (C) 2005 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the
+ * License.
+ */
+package org.alfresco.web.ui.wcm.component;
+
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+import javax.faces.component.NamingContainer;
+import javax.faces.component.UIComponent;
+import javax.faces.context.FacesContext;
+import javax.faces.context.ResponseWriter;
+import javax.faces.el.ValueBinding;
+import javax.transaction.UserTransaction;
+
+import org.alfresco.model.ContentModel;
+import org.alfresco.service.cmr.avm.AVMService;
+import org.alfresco.service.cmr.avm.AVMStoreDescriptor;
+import org.alfresco.service.cmr.repository.NodeRef;
+import org.alfresco.service.cmr.repository.NodeService;
+import org.alfresco.service.namespace.QName;
+import org.alfresco.web.app.Application;
+import org.alfresco.web.bean.repository.Repository;
+import org.alfresco.web.bean.wcm.AVMConstants;
+import org.alfresco.web.ui.common.PanelGenerator;
+import org.alfresco.web.ui.common.Utils;
+import org.alfresco.web.ui.common.component.SelfRenderingComponent;
+import org.alfresco.web.ui.wcm.WebResources;
+import org.springframework.web.jsf.FacesContextUtils;
+
+/**
+ * @author Kevin Roast
+ */
+public class UIUserSandboxes extends SelfRenderingComponent
+{
+   private static final String MSG_USERNAME = "username";
+   
+   /** website to show sandboxes for */
+   private NodeRef value;
+   
+   private Set<String> expandedPanels = new HashSet<String>();
+   
+   
+   // ------------------------------------------------------------------------------
+   // Component implementation
+   
+   /**
+    * @see javax.faces.component.UIComponent#getFamily()
+    */
+   public String getFamily()
+   {
+      return "org.alfresco.faces.UserSandboxes";
+   }
+   
+   public void restoreState(FacesContext context, Object state)
+   {
+      Object values[] = (Object[])state;
+      // standard component attributes are restored by the super class
+      super.restoreState(context, values[0]);
+      this.value = (NodeRef)values[1];
+      this.expandedPanels = (Set)values[2];
+   }
+   
+   public Object saveState(FacesContext context)
+   {
+      Object values[] = new Object[3];
+      // standard component attributes are saved by the super class
+      values[0] = super.saveState(context);
+      values[1] = this.value;
+      values[2] = this.expandedPanels;
+      return values;
+   }
+
+   /**
+    * @see javax.faces.component.UIComponentBase#decode(javax.faces.context.FacesContext)
+    */
+   public void decode(FacesContext context)
+   {
+      Map requestMap = context.getExternalContext().getRequestParameterMap();
+      Map valuesMap = context.getExternalContext().getRequestParameterValuesMap();
+      String fieldId = getClientId(context);
+      String value = (String)requestMap.get(fieldId);
+      
+      if (value != null && value.length() != 0)
+      {
+         // expand/collapse the specified users panel
+         if (this.expandedPanels.contains(value) == true)
+         {
+            // collapse by removing from expanded list 
+            this.expandedPanels.remove(value);
+         }
+         else
+         {
+            // add to expanded panel set
+            this.expandedPanels.add(value);
+         }
+      }
+   }
+   
+   /**
+    * @see javax.faces.component.UIComponentBase#encodeBegin(javax.faces.context.FacesContext)
+    */
+   @SuppressWarnings("unchecked")
+   public void encodeBegin(FacesContext context) throws IOException
+   {
+      if (isRendered() == false)
+      {
+         return;
+      }
+      
+      ResponseWriter out = context.getResponseWriter();
+      
+      if (getChildCount() == 0)
+      {
+         // create any sub-component for the first time
+      }
+      
+      AVMService avmService = getAVMService(context);
+      NodeService nodeService = getNodeService(context);
+      UserTransaction tx = null;
+      try
+      {
+         tx = Repository.getUserTransaction(FacesContext.getCurrentInstance(), true);
+         tx.begin();
+         
+         NodeRef websiteRef = getValue();
+         if (value == null)
+         {
+            throw new IllegalArgumentException("Website NodeRef must be specified.");
+         }
+         String storeRoot = (String)nodeService.getProperty(websiteRef, ContentModel.PROP_AVMSTORE);
+         
+         // find the list of users who have a sandbox in the website
+         List<String> users = (List<String>)nodeService.getProperty(websiteRef, ContentModel.PROP_USERSANDBOXES);
+         for (int i=0; i<users.size(); i++)
+         {
+            String username = users.get(i);
+            
+            String mainStore = storeRoot + '-' + username + AVMConstants.STORE_MAIN;
+            AVMStoreDescriptor store = avmService.getAVMStore(mainStore);
+            
+            // for each user sandbox, generate an outer panel table
+            PanelGenerator.generatePanelStart(out,
+                  context.getExternalContext().getRequestContextPath(),
+                  "white",
+                  "white");
+            
+            // components for the current username, preview, browse and modified items inner list
+            out.write("<table cellspacing=2 cellpadding=2 border=0 width=100%><tr><td>");
+            out.write(Utils.buildImageTag(context, WebResources.IMAGE_SANDBOX_32, 32, 32, ""));
+            out.write("</td><td width=100%>");
+            out.write("<b>");
+            out.write(Application.getMessage(context, MSG_USERNAME));
+            out.write(":</b>&nbsp;");
+            out.write(username); // TODO: convert to full name
+            out.write("</td><td><nobr>");
+            // direct actions for a sandbox
+            // TODO: add actions for a sandbox
+            out.write("(Preview) (Create) (Browse)");
+            out.write("</nobr></td></tr>");
+            // modified items panel
+            out.write("<tr><td></td><td colspan=2>");
+            String panelImage = this.expandedPanels.contains(username) ? WebResources.IMAGE_EXPANDED : WebResources.IMAGE_COLLAPSED;
+            out.write(Utils.buildImageTag(context, panelImage, 11, 11, "",
+                  Utils.generateFormSubmit(context, this, getClientId(context), username)));
+            out.write("&nbsp;<b>Modified Items (3)</b>");
+            out.write("</td></tr></table>");
+            
+            // end the outer panel for this sandbox
+            PanelGenerator.generatePanelEnd(out,
+                  context.getExternalContext().getRequestContextPath(),
+                  "white");
+            
+            // spacer row
+            if (i < users.size() - 1)
+            {
+               out.write("<div style='padding:4px'></div>");
+            }
+         }
+         
+         tx.commit();
+      }
+      catch (Throwable err)
+      {
+         try { if (tx != null) {tx.rollback();} } catch (Exception tex) {}
+         throw new RuntimeException(err);
+      }
+   }
+   
+   private AVMService getAVMService(FacesContext fc)
+   {
+      return (AVMService)FacesContextUtils.getRequiredWebApplicationContext(fc).getBean("AVMService");
+   }
+   
+   private NodeService getNodeService(FacesContext fc)
+   {
+      return Repository.getServiceRegistry(fc).getNodeService();
+   }
+   
+   
+   // ------------------------------------------------------------------------------
+   // Strongly typed component property accessors
+
+   /**
+    * Returns the NodeRef to the website to show the sandboxes for
+    *
+    * @return The website NodeRef instance
+    */
+   public NodeRef getValue()
+   {
+      ValueBinding vb = getValueBinding("value");
+      if (vb != null)
+      {
+         this.value = (NodeRef)vb.getValue(getFacesContext());
+      }
+      
+      return this.value;
+   }
+   
+   /**
+    * Sets the NodeRef to the website to show the sandboxes for
+    *
+    * @param value   The NodeRef to the website to show the sandboxes for
+    */
+   public void setValue(NodeRef value)
+   {
+      this.value = value;
+   }
+}

source/java/org/alfresco/web/ui/wcm/tag/UserSandboxesTag.java

@@ -0,0 +1,75 @@
+/*
+ * Copyright (C) 2005 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the
+ * License.
+ */
+package org.alfresco.web.ui.wcm.tag;
+
+import javax.faces.component.UIComponent;
+
+import org.alfresco.web.ui.common.tag.BaseComponentTag;
+
+/**
+ * @author Kevin Roast
+ */
+public class UserSandboxesTag extends BaseComponentTag
+{
+   /**
+    * @see javax.faces.webapp.UIComponentTag#getComponentType()
+    */
+   public String getComponentType()
+   {
+      return "org.alfresco.faces.UserSandboxes";
+   }
+
+   /**
+    * @see javax.faces.webapp.UIComponentTag#getRendererType()
+    */
+   public String getRendererType()
+   {
+      return null;
+   }
+   
+   /**
+    * @see javax.faces.webapp.UIComponentTag#setProperties(javax.faces.component.UIComponent)
+    */
+   protected void setProperties(UIComponent component)
+   {
+      super.setProperties(component);
+      
+      setStringProperty(component, "value", this.value);
+   }
+   
+   /**
+    * @see org.alfresco.web.ui.common.tag.HtmlComponentTag#release()
+    */
+   public void release()
+   {
+      super.release();
+      this.value = null;
+   }
+   
+   /**
+    * Set the value (root store name to display sandboxes for)
+    *
+    * @param value     the value
+    */
+   public void setValue(String value)
+   {
+      this.value = value;
+   }
+   
+   /** the value (root store name to display sandboxes for) */
+   private String value;
+}