Bug #4346 : Gessing Ms Office version with editon tool, using the registry.

Author: Emmanuel Hugonnet

src/main/java/org/silverpeas/openoffice/OfficeLauncher.java

@@ -59,20 +59,20 @@ public class OfficeLauncher {
   public static int launch(MsOfficeType type, String url, AuthenticationInfo authInfo,
       boolean useDeconnectedMode) throws IOException, InterruptedException, OfficeNotFoundException {
     OfficeFinder finder = FinderFactory.getFinder(type);
-    logger.log(Level.INFO, "Are we using Office 2007 : {0}", finder.isMicrosoftOffice());
+    logger.log(Level.INFO, "Are we using Office : {0}", finder.isMicrosoftOffice());
     logger.log(Level.INFO, "We are on {0} OS", OsEnum.getOS());
     boolean modeDisconnected = ((OsEnum.isWindows() && useDeconnectedMode) || OsEnum.getOS()
         == OsEnum.MAC_OSX) && finder.isMicrosoftOffice();    
     switch (type) {
       case EXCEL:
-        return launch(finder.findSpreadsheet(), url, modeDisconnected, authInfo);
+        return launch(type, finder.findSpreadsheet(), url, modeDisconnected, authInfo);
       case POWERPOINT:
-        return launch(finder.findPresentation(), url, modeDisconnected, authInfo);
+        return launch(type, finder.findPresentation(), url, modeDisconnected, authInfo);
       case WORD:
-        return launch(finder.findWordEditor(), url, modeDisconnected, authInfo);
+        return launch(type, finder.findWordEditor(), url, modeDisconnected, authInfo);
       case NONE:
       default:
-        return launch(finder.findOther(), url, modeDisconnected, authInfo);
+        return launch(type, finder.findOther(), url, modeDisconnected, authInfo);
     }
   }
 
@@ -87,7 +87,7 @@ public static int launch(MsOfficeType type, String url, AuthenticationInfo authI
    * @throws IOException
    * @throws InterruptedException
    */
-  public static int launch(String path, String url, boolean modeDisconnected,
+  protected static int launch(MsOfficeType type, String path, String url, boolean modeDisconnected,
       AuthenticationInfo auth) throws IOException, InterruptedException {
     logger.log(Level.INFO, "The path: {0}", path);
     logger.log(Level.INFO, "The url: {0}", url);
@@ -116,7 +116,7 @@ public static int launch(String path, String url, boolean modeDisconnected,
     } else {
       // Standard mode : just open it
       String webdavUrl = url;
-      if(OsEnum.isWindows() && MsOfficeVersion.isOldOffice()) {
+      if(OsEnum.isWindows() && MsOfficeVersion.isOldOffice(type)) {
         webdavUrl = webdavUrl.replace("/repository/", "/repository2000/");
       }
       logger.log(Level.INFO, "The exact exec line: {0} {2}", new Object[]{path, webdavUrl});

src/main/java/org/silverpeas/openoffice/util/MsOfficeType.java

@@ -33,12 +33,15 @@
  */
 public enum MsOfficeType {
 
-  NONE(""), EXCEL("application/vnd.ms-excel"), WORD("application/vnd.ms-word"), POWERPOINT(
-      "application/vnd.ms-powerpoint");
+  NONE("", RegistryApplicationKey.NONE), 
+  EXCEL("application/vnd.ms-excel", RegistryApplicationKey.EXCEL), 
+  WORD("application/vnd.ms-word", RegistryApplicationKey.WORD), 
+  POWERPOINT("application/vnd.ms-powerpoint", RegistryApplicationKey.POWERPOINT);
   private String contentType;
-
-  private MsOfficeType(String contentType) {
+  private RegistryApplicationKey registryKey;
+  private MsOfficeType(String contentType, RegistryApplicationKey registryKey) {
     this.contentType = contentType;
+    this.registryKey = registryKey;
   }
 
   public static MsOfficeType valueOfMimeType(String mimeType) {
@@ -53,6 +56,15 @@ public static MsOfficeType valueOfMimeType(String mimeType) {
     }
     return NONE;
   }
+  
+  public RegistryApplicationKey getRegistryApplicationKey() {
+    return this.registryKey;
+  }
+
+  
+  public String getApplicationKey() {
+    return this.registryKey.getApplicationKey();
+  }
 
   public boolean isMsOfficeCompatible() {
     return this != NONE;

src/main/java/org/silverpeas/openoffice/util/RegistryApplicationKey.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright (C) 2000 - 2013 Silverpeas
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * As a special exception to the terms and conditions of version 3.0 of
+ * the GPL, you may redistribute this Program in connection withWriter Free/Libre
+ * Open Source Software ("FLOSS") applications as described in Silverpeas's
+ * FLOSS exception.  You should have recieved a copy of the text describing
+ * the FLOSS exception, and it is also available here:
+ * "http://www.silverpeas.org/legal/licensing"
+ *
+ * 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package org.silverpeas.openoffice.util;
+
+/**
+ *
+ * @author ehugonnet
+ */
+public enum RegistryApplicationKey {
+
+  EXCEL("Excel.Application"), OUTLOOK("Outlook.Application"), WORD("Word.Application"),
+  POWERPOINT("Powerpoint.Application"), FRONTPAGE("FrontPage.Application"), ACCESS(
+  "Access.Application"), NONE("");
+  
+  private final String applicationKey;
+
+  private RegistryApplicationKey(String applicationKey) {
+    this.applicationKey = applicationKey;
+  }
+
+  public String getApplicationKey() {
+    return this.applicationKey;
+  }
+}

src/main/java/org/silverpeas/openoffice/windows/MsOfficeRegistryHelper.java

@@ -27,32 +27,30 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
+import org.silverpeas.openoffice.util.RegistryApplicationKey;
+
 /**
  * @author Emmanuel Hugonnet
  */
 public class MsOfficeRegistryHelper implements OfficeFinder {
 
   static final Logger logger = Logger.getLogger(MsOfficeRegistryHelper.class.getName());
   static final OfficeFinder msOfficeFinder = new MsOfficePathFinder();
-  static final String ACCESS = "Access.Application";
-  static final String EXCEL = "Excel.Application";
-  static final String OUTLOOK = "Outlook.Application";
-  static final String POWERPOINT = "Powerpoint.Application";
-  static final String WORD = "Word.Application";
-  static final String FRONTPAGE = "FrontPage.Application";
   static final String BASE_KEY_OFFICE = "\"HKEY_LOCAL_MACHINE\\Software\\Microsoft\\Office\\";
-  static final String BASE_APPLICATION_KEY = "\"HKEY_LOCAL_MACHINE\\Software\\Classes\\";
+  public static final String BASE_APPLICATION_KEY = "\"HKEY_LOCAL_MACHINE\\Software\\Classes\\";
   static final String BASE_KEY_64_CLSID =
       "\"HKEY_LOCAL_MACHINE\\Software\\Wow6432Node\\Classes\\CLSID\\";
   static final String BASE_KEY_CLSID = "\"HKEY_LOCAL_MACHINE\\Software\\Classes\\CLSID\\";
   static final Pattern AUTOMATION = Pattern.compile(
       "\\s*/[aA][uU][tT][oO][mM][aA][tT][iI][oO][nN]\\s*");
 
-  protected String getClsid(String type) {
-    return RegistryKeyReader.readKey(BASE_APPLICATION_KEY + type + "\\CLSID\"");
+  protected String getClsid(RegistryApplicationKey type) {
+    return RegistryKeyReader.readKey(BASE_APPLICATION_KEY + type.getApplicationKey() + "\\CLSID\"");
   }
 
-  protected String getPath(String type) {
+ 
+
+  protected String getPath(RegistryApplicationKey type) {
     String clsid = getClsid(type);
     if (clsid != null) {
       String path = RegistryKeyReader.readKey(BASE_KEY_CLSID + clsid + "\\LocalServer32\"");
@@ -81,7 +79,7 @@ protected String extractPath(String path) {
 
   @Override
   public String findSpreadsheet() throws OfficeNotFoundException {
-    String msPath = getPath(EXCEL);
+    String msPath = getPath(RegistryApplicationKey.EXCEL);
     if (msPath == null) {
       msPath = msOfficeFinder.findSpreadsheet();
     }
@@ -90,7 +88,7 @@ public String findSpreadsheet() throws OfficeNotFoundException {
 
   @Override
   public String findPresentation() throws OfficeNotFoundException {
-    String msPath = getPath(POWERPOINT);
+    String msPath = getPath(RegistryApplicationKey.POWERPOINT);
     if (msPath == null) {
       msPath = msOfficeFinder.findPresentation();
     }
@@ -99,7 +97,7 @@ public String findPresentation() throws OfficeNotFoundException {
 
   @Override
   public String findWordEditor() throws OfficeNotFoundException {
-    String msPath = getPath(WORD);
+    String msPath = getPath(RegistryApplicationKey.WORD);
     if (msPath == null) {
       msPath = msOfficeFinder.findWordEditor();
     } else {
@@ -115,6 +113,7 @@ public String findOther() throws OfficeNotFoundException {
 
   @Override
   public boolean isMicrosoftOffice() {
-    return getPath(EXCEL) != null || getPath(POWERPOINT) != null || getPath(WORD) != null;
+    return getPath(RegistryApplicationKey.EXCEL) != null || getPath(
+        RegistryApplicationKey.POWERPOINT) != null || getPath(RegistryApplicationKey.WORD) != null;
   }
 }

src/main/java/org/silverpeas/openoffice/windows/MsOfficeVersion.java

@@ -0,0 +1,72 @@
+/*
+ * Copyright (C) 2000 - 2013 Silverpeas
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * As a special exception to the terms and conditions of version 3.0 of
+ * the GPL, you may redistribute this Program in connection withWriter Free/Libre
+ * Open Source Software ("FLOSS") applications as described in Silverpeas's
+ * FLOSS exception.  You should have recieved a copy of the text describing
+ * the FLOSS exception, and it is also available here:
+ * "http://www.silverpeas.org/legal/licensing"
+ *
+ * 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package org.silverpeas.openoffice.windows;
+
+import org.silverpeas.openoffice.util.MsOfficeType;
+import org.silverpeas.openoffice.util.RegistryApplicationKey;
+import org.silverpeas.openoffice.util.RegistryKeyReader;
+
+/**
+ *
+ * @author ehugonnet
+ */
+public enum MsOfficeVersion {
+
+  Office95(7), Office97(8), Office2000(9), OfficeXP(10), Office2003(11),
+  Office2007(12), Office2010(14);
+  private final int numeralVersion;
+
+  private MsOfficeVersion(int numeralVersion) {
+    this.numeralVersion = numeralVersion;
+  }
+
+  public static MsOfficeVersion fromNumeralVersion(int version) {
+    for (MsOfficeVersion officeVersion : MsOfficeVersion.values()) {
+      if (version == officeVersion.numeralVersion) {
+        return officeVersion;
+      }
+    }
+    return Office2000;
+  }
+
+  public static MsOfficeVersion detectMsOffice(MsOfficeType type) {
+    return getOfficeVersion(type.getRegistryApplicationKey());
+  }
+
+  protected static MsOfficeVersion getOfficeVersion(RegistryApplicationKey type) {
+    String key = RegistryKeyReader.readKey(MsOfficeRegistryHelper.BASE_APPLICATION_KEY
+        + type.getApplicationKey() + "\\CurVer\"");
+    if (key != null) {
+      int version = Integer.parseInt(key.substring(type.getApplicationKey().length() + 1));
+      return MsOfficeVersion.fromNumeralVersion(version);
+    }
+    return MsOfficeVersion.Office2000;
+  }
+
+  public static boolean isOldOffice(MsOfficeType type) {
+    MsOfficeVersion currentVersion = detectMsOffice(type);
+    return OfficeXP == currentVersion || Office2000 == currentVersion || Office95 == currentVersion
+        || Office97 == currentVersion;
+  }
+}