Bug #4393 :

SilverYoCha · SilverYoCha · commit 1c5484338b95 · 2013-06-20T16:33:04.000+02:00
- modifying the treatment that computing technical domain database name (replacing each sequence of special characters by one underscore and modifying the maximum length of database table/column name from 42 to 30 (due to Oracle limitations))
- fixing the non deletion of domain property file when a domain is deleted
diff --git a/lib-core/src/main/java/com/stratelia/silverpeas/domains/sqldriver/SQLSettings.java b/lib-core/src/main/java/com/stratelia/silverpeas/domains/sqldriver/SQLSettings.java
@@ -35,6 +35,11 @@
  */
 
 public class SQLSettings extends DriverSettings {
+
+  // Definitions of max lengths due to limitations on Oracle databases
+  public static final int DATABASE_TABLE_NAME_MAX_LENGTH = 30;
+  public static final int DATABASE_COLUMN_NAME_MAX_LENGTH = 30;
+
   // For DB Access
   protected String SQLClassName = "";
   protected String SQLJDBCUrl = "";
diff --git a/lib-core/src/main/java/org/silverpeas/admin/domain/SQLDomainService.java b/lib-core/src/main/java/org/silverpeas/admin/domain/SQLDomainService.java
@@ -24,31 +24,31 @@
 
 package org.silverpeas.admin.domain;
 
-import java.io.File;
-import java.io.FileWriter;
-import java.io.IOException;
-import java.io.PrintWriter;
-
-import javax.annotation.PostConstruct;
-import javax.inject.Inject;
-import javax.inject.Named;
-
-import org.silverpeas.admin.domain.exception.DomainAuthenticationPropertiesAlreadyExistsException;
-import org.silverpeas.admin.domain.exception.DomainConflictException;
-import org.silverpeas.admin.domain.exception.DomainCreationException;
-import org.silverpeas.admin.domain.exception.DomainDeletionException;
-import org.silverpeas.admin.domain.exception.DomainPropertiesAlreadyExistsException;
-import org.silverpeas.admin.domain.repository.SQLDomainRepository;
-
 import com.silverpeas.util.StringUtil;
 import com.silverpeas.util.template.SilverpeasTemplate;
 import com.silverpeas.util.template.SilverpeasTemplateFactory;
+import com.stratelia.silverpeas.domains.sqldriver.SQLSettings;
 import com.stratelia.silverpeas.silvertrace.SilverTrace;
 import com.stratelia.webactiv.beans.admin.AdminException;
 import com.stratelia.webactiv.beans.admin.Domain;
 import com.stratelia.webactiv.util.FileRepositoryManager;
 import com.stratelia.webactiv.util.FileServerUtils;
 import com.stratelia.webactiv.util.ResourceLocator;
+import org.silverpeas.admin.domain.exception.DomainAuthenticationPropertiesAlreadyExistsException;
+import org.silverpeas.admin.domain.exception.DomainConflictException;
+import org.silverpeas.admin.domain.exception.DomainCreationException;
+import org.silverpeas.admin.domain.exception.DomainDeletionException;
+import org.silverpeas.admin.domain.exception.DomainPropertiesAlreadyExistsException;
+import org.silverpeas.admin.domain.repository.SQLDomainRepository;
+
+import javax.annotation.PostConstruct;
+import javax.inject.Inject;
+import javax.inject.Named;
+import java.io.File;
+import java.io.FileWriter;
+import java.io.IOException;
+import java.io.PrintWriter;
+import java.text.Normalizer;
 
 @Named("sqlDomainService")
 public class SQLDomainService extends AbstractDomainService {
@@ -66,7 +66,9 @@ void init() {
     adminSettings = new ResourceLocator("org.silverpeas.beans.admin.admin", "");
   }
   
-   private void checkFileName(String fileDomainName) throws DomainAuthenticationPropertiesAlreadyExistsException, DomainPropertiesAlreadyExistsException {
+  private void checkFileName(String fileDomainName)
+      throws DomainAuthenticationPropertiesAlreadyExistsException,
+      DomainPropertiesAlreadyExistsException {
      // Check properties files availability
      // org.silverpeas.domains.domain<domainName>.properties
      // org.silverpeas.authentication.autDomain<domainName>.properties
@@ -83,23 +85,25 @@ private void checkFileName(String fileDomainName) throws DomainAuthenticationPro
      }
    }
    
-   //transformation du nom du domaine, nécessaire pour pouvoir créer les fichiers sur le fileSystem 
-   //et créer les tables dans la BD
+  /**
+   * Gets a file name without special characters and without accentued characters in the aim to
+   * create domain property files safely on file system.
+   * @param domainName domain name with maybe some special characters and/or accentued characters
+   * @return
+   */
    private String getCorrectDomainFileName(String domainName) {
-     //remplace les caractères accentués non compatibles avec les fichiers fileSystem et les noms de tables BD par les caractères non accentués correspondants
+
+    // Normalizing (accents, puissance, ...)
      String fileDomainName = FileServerUtils.replaceAccentChars(domainName);
+    fileDomainName = Normalizer.normalize(fileDomainName, Normalizer.Form.NFKD);
      
-     //remplace les caractères spéciaux et les espaces non compatibles avec les fichiers fileSystem et les noms de tables BD par caractère '_'
-     fileDomainName =  fileDomainName.replaceAll("[^A-Za-z0-9]", "_");
+    // Replacing of each sequence of special characters by one underscore
+    fileDomainName = fileDomainName.replaceAll("[^\\p{Alnum}]+", "_");
      
-     //tronque le nom à 42 caractères pour être compatible avec les noms de tables BD
-     if (fileDomainName.length()>42) {
-       fileDomainName = fileDomainName.substring(0, 42);
+    // Limitations of some databases on length of table or column names
+    return StringUtil.left(fileDomainName, SQLSettings.DATABASE_TABLE_NAME_MAX_LENGTH);
      }
      
-     return fileDomainName;
-   }
-
   @Override
   public String createDomain(Domain domainToCreate) throws DomainConflictException,
       DomainCreationException {
@@ -168,9 +172,16 @@ public String createDomain(Domain domainToCreate) throws DomainConflictException
   @Override
   public String deleteDomain(Domain domainToRemove) throws DomainDeletionException {
 
-    //set nouveau nom pour le fileSystem et la BD
-    String domainPropertiesPath = domainToRemove.getPropFileName();
-    String fileDomainName = domainPropertiesPath.substring(29); //supprime org.silverpeas.domains.domain
+    // Retrieve the prefix of a domain property file name
+    String separator = "#@#@#@#@#";
+    String domainPropertyPrefix = new File(
+        FileRepositoryManager.getDomainPropertiesPath(separator).replaceAll(separator + ".*$", ""))
+        .getName();
+    // Get the domain property file name without the package
+    String domainPropertyFileName =
+        domainToRemove.getPropFileName().replaceAll("[\\p{Alnum}]+\\.+", "");
+    // Compute the common property file name by removing the prefix of a domain property file name
+    String fileDomainName = domainPropertyFileName.replaceFirst(domainPropertyPrefix, "");
     domainToRemove.setName(fileDomainName);
     
     // unregister new Domain dans st_domain
@@ -210,10 +221,7 @@ private void removePropertiesFiles(String domainName) {
    * @throws DomainCreationException
    */
   private void generateDomainPropertiesFile(Domain domainToCreate) throws DomainCreationException {
-    SilverTrace
-        .info(
-        "admin",
-        "SQLDomainService.generateDomainPropertiesFile()",
+    SilverTrace.info("admin", "SQLDomainService.generateDomainPropertiesFile()",
         "root.MSG_GEN_ENTER_METHOD");
 
     String domainName = domainToCreate.getName();
@@ -252,10 +260,7 @@ private void generateDomainPropertiesFile(Domain domainToCreate) throws DomainCr
    */
   private void generateDomainAuthenticationPropertiesFile(Domain domainToCreate)
       throws DomainCreationException {
-    SilverTrace
-        .info(
-        "admin",
-        "SQLDomainService.generateDomainAuthenticationPropertiesFile()",
+    SilverTrace.info("admin", "SQLDomainService.generateDomainAuthenticationPropertiesFile()",
         "root.MSG_GEN_ENTER_METHOD");
 
     String domainName = domainToCreate.getName();
@@ -287,20 +292,19 @@ private void generateDomainAuthenticationPropertiesFile(Domain domainToCreate)
           "SQLDomainService.generateDomainAuthenticationPropertiesFile()", domainToCreate
           .toString(), e);
     } finally {
+      if (out != null) {
       out.close();
     }
   }
+  }
 
   /**
    * Remove domain authentication and settings properties file
    * @param domainToRemove domain to remove
    * @throws DomainDeletionException
    */
   private void removeDomainPropertiesFile(Domain domainToRemove) {
-    SilverTrace
-        .info(
-        "admin",
-        "SQLDomainService.removeDomainAuthenticationPropertiesFile()",
+    SilverTrace.info("admin", "SQLDomainService.removeDomainAuthenticationPropertiesFile()",
         "root.MSG_GEN_ENTER_METHOD");
 
     String domainName = domainToRemove.getName();
@@ -314,11 +318,8 @@ private void removeDomainPropertiesFile(Domain domainToRemove) {
     boolean domainPropertiesFileDeleted = domainPropertiesFile.delete();
     boolean authenticationPropertiesFileDeleted = authenticationPropertiesFile.delete();
 
-    if ((!domainPropertiesFileDeleted) || (!authenticationPropertiesFileDeleted)) {
-      SilverTrace
-          .warn(
-          "admin",
-          "SQLDomainService.removeDomainAuthenticationPropertiesFile()",
+    if (!(domainPropertiesFileDeleted && authenticationPropertiesFileDeleted)) {
+      SilverTrace.warn("admin", "SQLDomainService.removeDomainAuthenticationPropertiesFile()",
           "admin.EX_DELETE_DOMAIN_PROPERTIES", "domainPropertiesFileDeleted:" +
           domainPropertiesFileDeleted + ", authenticationPropertiesFileDeleted:" +
           authenticationPropertiesFileDeleted);
diff --git a/lib-core/src/main/java/org/silverpeas/admin/domain/repository/SQLInternalDomainRepository.java b/lib-core/src/main/java/org/silverpeas/admin/domain/repository/SQLInternalDomainRepository.java
@@ -26,19 +26,21 @@
 
 import com.stratelia.webactiv.beans.admin.Domain;
 import com.stratelia.webactiv.util.FileRepositoryManager;
-import java.io.FileInputStream;
-import java.io.FileNotFoundException;
-import java.io.IOException;
-import java.util.Properties;
-import javax.inject.Named;
-import javax.sql.DataSource;
+import org.apache.commons.io.IOUtils;
 import org.silverpeas.admin.domain.exception.SQLDomainDAOException;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.jdbc.core.JdbcTemplate;
 import org.springframework.stereotype.Repository;
 import org.springframework.transaction.annotation.Propagation;
 import org.springframework.transaction.annotation.Transactional;
 
+import javax.inject.Named;
+import javax.sql.DataSource;
+import java.io.FileInputStream;
+import java.io.FileNotFoundException;
+import java.io.IOException;
+import java.util.Properties;
+
 @Repository
 @Named("sqlInternalDomainRepository")
 public class SQLInternalDomainRepository implements SQLDomainRepository {
@@ -117,7 +119,13 @@ private String generateGroupTableDropStatement(String domainName) {
   private String generateUserTableCreateStatement(String domainName) throws FileNotFoundException,
       IOException {
     Properties props = new Properties();
-    props.load(new FileInputStream(FileRepositoryManager.getDomainPropertiesPath(domainName)));
+    FileInputStream fis = null;
+    try {
+      fis = new FileInputStream(FileRepositoryManager.getDomainPropertiesPath(domainName));
+      props.load(fis);
+    } finally {
+      IOUtils.closeQuietly(fis);
+    }
     int numberOfColumns = Integer.parseInt(props.getProperty("property.Number"));
 
     StringBuilder createStatement = new StringBuilder();
