Patch service I18N. Added permission data patch for AR-344. Bumped up schema version to 3.

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@2206 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

config/alfresco/core-services-context.xml

@@ -93,6 +93,7 @@
     			<value>alfresco.messages.coci-service</value>
     			<value>alfresco.messages.template-service</value>
     			<value>alfresco.messages.lock-service</value>
+    			<value>alfresco.messages.patch-service</value>
     		</list>
     	</property>
     </bean>

config/alfresco/messages/patch-service.properties

@@ -0,0 +1,14 @@
+# PatchService messages
+patch.service.not_relevant=Not relevant to schema {0}
+patch.executer.not_executed=Applied patch (not executed): \nID: {0}\nRESULT: \n{1}
+patch.executer.executed=Applied patch: \nID: {0}\nRESULT: \n{1}
+patch.executer.failed=Failed to apply patch: \nID: {0}\nRESULT: \n{1}
+
+# Individual patch messages
+
+patch.savedSearchesFolder.description=Ensures the existence of the 'Saved Searches' folder.
+patch.savedSearchesFolder.result.exists=The saved searches folder already exists: {0}
+patch.savedSearchesFolder.result.created=The saved searches folder successfully created: {0}
+
+patch.updatePermissionData.description=Update permission entries from 'folder' to 'cmobject'.
+patch.updatePermissionData.result=Created the following permission reference names: {0}. \nUpdated {1} permission entries.

config/alfresco/patch/patch-services-context.xml

@@ -79,7 +79,7 @@
     <!-- patch definitions -->
     <bean id="patch.savedSearchesFolder" class="org.alfresco.repo.admin.patch.impl.SavedSearchFolderPatch" parent="basePatch" >
         <property name="id"><value>patch.savedSearchesFolder</value></property>
-        <property name="description"><value>Ensures the existence of the 'Saved Searches' folder</value></property>
+        <property name="description"><value>patch.savedSearchesFolder.description</value></property>
         <property name="fixesFromSchema"><value>0</value></property>
         <property name="fixesToSchema"><value>1</value></property>
         <property name="targetSchema"><value>2</value></property>
@@ -97,6 +97,17 @@
             <ref bean="nodeService"/>
         </property>
     </bean>
+    <bean id="patch.updatePermissionData" class="org.alfresco.repo.admin.patch.impl.PermissionDataPatch" parent="basePatch" >
+        <property name="id"><value>patch.updatePermissionData</value></property>
+        <property name="description"><value>patch.updatePermissionData.description</value></property>
+        <property name="fixesFromSchema"><value>0</value></property>
+        <property name="fixesToSchema"><value>2</value></property>
+        <property name="targetSchema"><value>3</value></property>
+        <!-- helper beans -->
+        <property name="sessionFactory">
+            <ref bean="sessionFactory" />
+        </property>
+    </bean>
 
     <!-- This component ensures that patches get applied on startup -->
     <!-- The order is important here.  All the self-registering patches must be defined before this bean -->

config/alfresco/version.properties

@@ -15,4 +15,4 @@ version.edition=Open Source
 
 # Schema number
 
-version.schema=2
+version.schema=3

source/java/org/alfresco/repo/admin/patch/AbstractPatch.java

@@ -268,7 +268,7 @@ public abstract class AbstractPatch implements Patch
                     return report;
                 };
             };
-            String report = TransactionUtil.executeInUserTransaction(transactionService, patchWork);
+            String report = TransactionUtil.executeInNonPropagatingUserTransaction(transactionService, patchWork);
             // the patch was successfully applied
             applied = true;
             // done

source/java/org/alfresco/repo/admin/patch/PatchExecuter.java

@@ -20,6 +20,7 @@ import java.util.Date;
 import java.util.List;
 
 import org.alfresco.error.AlfrescoRuntimeException;
+import org.alfresco.i18n.I18NUtil;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 
@@ -31,6 +32,10 @@ import org.apache.commons.logging.LogFactory;
  */
 public class PatchExecuter
 {
+    private static final String MSG_NOT_EXECUTED = "patch.executer.not_executed";
+    private static final String MSG_EXECUTED = "patch.executer.executed";
+    private static final String MSG_FAILED = "patch.executer.failed";
+    
     private static Log logger = LogFactory.getLog(PatchExecuter.class);
     
     private PatchService patchService;
@@ -72,22 +77,16 @@ public class PatchExecuter
                 if (!patchInfo.getWasExecuted())
                 {
                     // the patch was not executed
-                    logger.debug("Applied patch (not executed): \n" +
+                    logger.debug(I18NUtil.getMessage(MSG_NOT_EXECUTED, patchInfo.getId(), patchInfo.getReport()));
-                            "   ID:     " + patchInfo.getId() + "\n" +
-                            "   RESULT: " + patchInfo.getReport());
                 }
                 else if (patchInfo.getSucceeded())
                 {
-                    logger.info("Applied patch: \n" +
+                    logger.info(I18NUtil.getMessage(MSG_EXECUTED, patchInfo.getId(), patchInfo.getReport()));
-                            "   ID:     " + patchInfo.getId() + "\n" +
-                            "   RESULT: " + patchInfo.getReport());
                 }
                 else
                 {
                     succeeded = false;
-                    logger.error("Failed to apply patch: \n" +
+                    logger.error(I18NUtil.getMessage(MSG_FAILED, patchInfo.getId(), patchInfo.getReport()));
-                            "   ID:     " + patchInfo.getId() + "\n" +
-                            "   RESULT: " + patchInfo.getReport());
                }
             }
             // generate an error if there was a failure

source/java/org/alfresco/repo/admin/patch/PatchServiceImpl.java

@@ -22,6 +22,7 @@ import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
+import org.alfresco.i18n.I18NUtil;
 import org.alfresco.repo.domain.AppliedPatch;
 import org.alfresco.service.cmr.admin.PatchException;
 import org.alfresco.service.descriptor.Descriptor;
@@ -41,6 +42,8 @@ import org.apache.commons.logging.LogFactory;
  */
 public class PatchServiceImpl implements PatchService
 {
+    private static final String MSG_NOT_RELEVANT = "patch.service.not_relevant";
+    
     private static final Date ZERO_DATE = new Date(0L);
     private static final Date INFINITE_DATE = new Date(Long.MAX_VALUE);
     
@@ -171,9 +174,7 @@ public class PatchServiceImpl implements PatchService
         if (!applies)
         {
             // create a dummy report
-            StringBuilder sb = new StringBuilder(128);
+            report = I18NUtil.getMessage(MSG_NOT_RELEVANT, repoDescriptor.getSchema());
-            sb.append("Not relevant to schema " + repoDescriptor.getSchema());
-            report = sb.toString();
             success = true;             // this succeeded because it didn't need to be applied
         }
         else
@@ -201,7 +202,7 @@ public class PatchServiceImpl implements PatchService
             appliedPatch = patchDaoService.newAppliedPatch(patch.getId());
         }
         // fill in the record's details
-        appliedPatch.setDescription(patch.getDescription());
+        appliedPatch.setDescription(I18NUtil.getMessage(patch.getDescription()));
         appliedPatch.setFixesFromSchema(patch.getFixesFromSchema());
         appliedPatch.setFixesToSchema(patch.getFixesToSchema());
         appliedPatch.setTargetSchema(patch.getTargetSchema());       // the schema the server is expecting

source/java/org/alfresco/repo/admin/patch/impl/PermissionDataPatch.java

@@ -0,0 +1,118 @@
+/*
+ * 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.repo.admin.patch.impl;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.alfresco.i18n.I18NUtil;
+import org.alfresco.repo.admin.patch.AbstractPatch;
+import org.alfresco.repo.security.permissions.impl.hibernate.PermissionReference;
+import org.alfresco.repo.security.permissions.impl.hibernate.PermissionReferenceImpl;
+import org.alfresco.service.namespace.NamespaceService;
+import org.hibernate.Query;
+import org.hibernate.Session;
+import org.hibernate.SessionFactory;
+import org.springframework.orm.hibernate3.HibernateCallback;
+import org.springframework.orm.hibernate3.support.HibernateDaoSupport;
+
+/**
+ * The roles defined in permissionsDefinition.xml moved from <b>cm:folder</b> to <b>cm:cmobject</b>.
+ * This effects the data stored in the <b>node_perm_entry</b> table.
+ * <p>
+ * JIRA: {@link http://www.alfresco.org/jira/browse/AR-344 AR-344}
+ * 
+ * @author Derek Hulley
+ */
+public class PermissionDataPatch extends AbstractPatch
+{
+    private static final String MSG_SUCCESS = "patch.updatePermissionData.result";
+    
+    private HibernateHelper helper;
+    
+    public PermissionDataPatch()
+    {
+        helper = new HibernateHelper();
+    }
+    
+    public void setSessionFactory(SessionFactory sessionFactory)
+    {
+        this.helper.setSessionFactory(sessionFactory);
+    }
+    
+    @Override
+    protected String applyInternal() throws Exception
+    {
+        List<String> createdNames = helper.createPermissionReferences();
+        int updatedEntries = helper.updatePermissionEntries();
+        
+        // build the result message
+        String msg = I18NUtil.getMessage(MSG_SUCCESS, createdNames, updatedEntries);
+        // done
+        return msg;
+    }
+
+    private static class HibernateHelper extends HibernateDaoSupport
+    {
+        private static final String TYPE_NAME_OLD = "folder";
+        private static final String TYPE_NAME_NEW = "cmobject";
+        private static final String[] NAMES = new String[] {"Coordinator", "Contributor", "Editor", "Guest"};
+        private static final String QUERY_UPDATE_PERM_ENTRY_TYPENAME = "permission.patch.UpdatePermissionEntryTypeName";
+        
+        public List<String> createPermissionReferences()
+        {
+            List<String> createdNames = new ArrayList<String>(4);
+            for (String name : NAMES)
+            {
+                // create permission references as required, double checking for their existence first
+                PermissionReference ref = new PermissionReferenceImpl();
+                ref.setTypeUri(NamespaceService.CONTENT_MODEL_1_0_URI);
+                ref.setTypeName(TYPE_NAME_NEW);
+                ref.setName(name);
+
+                // it acts as its own key
+                PermissionReference found = (PermissionReference) getHibernateTemplate().get(PermissionReferenceImpl.class, ref);
+
+                if (found == null)
+                {
+                    // it was not found, so create it
+                    getHibernateTemplate().save(ref);
+                    createdNames.add(name);
+                }
+            }
+            return createdNames;
+        }
+        
+        public int updatePermissionEntries()
+        {
+            HibernateCallback callback = new HibernateCallback()
+            {
+                public Object doInHibernate(Session session)
+                {
+                    Query query = session.getNamedQuery(HibernateHelper.QUERY_UPDATE_PERM_ENTRY_TYPENAME);
+                    query.setString("typeNameNew", TYPE_NAME_NEW)
+                         .setString("typeNameOld", TYPE_NAME_OLD);
+                    int updateCount = query.executeUpdate();
+                    return new Integer(updateCount);
+                }
+            };
+            Integer updateCount = (Integer) getHibernateTemplate().execute(callback);
+            // done
+            return updateCount.intValue();
+        }
+    }
+}

source/java/org/alfresco/repo/admin/patch/impl/SavedSearchFolderPatch.java

@@ -22,6 +22,7 @@ import java.util.List;
 import java.util.Map;
 import java.util.Properties;
 
+import org.alfresco.i18n.I18NUtil;
 import org.alfresco.model.ContentModel;
 import org.alfresco.repo.admin.patch.AbstractPatch;
 import org.alfresco.repo.importer.ImporterBootstrap;
@@ -49,8 +50,8 @@ import org.alfresco.service.namespace.QName;
  */
 public class SavedSearchFolderPatch extends AbstractPatch
 {
-    private static final String MSG_EXISTS = "The saved searches folder already exists: %s.";
+    private static final String MSG_EXISTS = "patch.savedSearchesFolder.result.exists";
-    private static final String MSG_CREATED = "The saved searches folder successfully created: %s.";
+    private static final String MSG_CREATED = "patch.savedSearchesFolder.result.created";
     
     private static final String PROPERTY_COMPANY_HOME_CHILDNAME = "spaces.company_home.childname";
     private static final String PROPERTY_DICTIONARY_CHILDNAME = "spaces.dictionary.childname";
@@ -166,13 +167,13 @@ public class SavedSearchFolderPatch extends AbstractPatch
         if (nodeRefs.size() == 1)
         {
             // it already exists
-            msg = String.format(MSG_EXISTS, new Object[] {nodeRefs.get(0)});
+            msg = I18NUtil.getMessage(MSG_EXISTS, nodeRefs.get(0));
         }
         else
         {
             // create it
             NodeRef savedSearchesFolderNodeRef = createFolder(dictionaryNodeRef, configuration);
-            msg = String.format(MSG_CREATED, new Object[] {savedSearchesFolderNodeRef});
+            msg = I18NUtil.getMessage(MSG_CREATED, savedSearchesFolderNodeRef);
         }
         // done
         return msg;

source/java/org/alfresco/repo/security/permissions/impl/hibernate/Permission.hbm.xml

@@ -140,4 +140,14 @@
          recipient = :recipientKey 
    </query>
    
+   <query name="permission.patch.UpdatePermissionEntryTypeName" >
+      update
+         org.alfresco.repo.security.permissions.impl.hibernate.PermissionEntryImpl as entry
+      set
+         typeName = :typeNameNew
+      where
+         typeName = :typeNameOld and
+         name in ('Coordinator', 'Contributor', 'Editor', 'Guest')
+   </query>
+    
 </hibernate-mapping>