3rd Party Service admin (OpenOffice, SWFTools, ImageMagick)

- All supporting classes moved out to thirdparty subsystem - Open Office service automatically started if available - All utility locations editable via JMX (and subsystem can be reinitialized with new values without rebooting tomcat) - New ContentTransformerWorker interface introduced in order to allow separation between ContentTransformer registry and third party utilities - Existing JMX query capabilities preserved git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@13860 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2025-08-07 17:49:17 +00:00 · 2009-04-06 16:31:33 +00:00
parent 132fdb81cb
commit a166add97f
31 changed files with 966 additions and 559 deletions
--- a/source/java/org/alfresco/repo/content/metadata/DefaultOpenOfficeMetadataWorker.java
+++ b/source/java/org/alfresco/repo/content/metadata/DefaultOpenOfficeMetadataWorker.java
@@ -0,0 +1,147 @@
+/*
+ * Copyright (C) 2005-2009 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 received a copy of the text describing 
+ * the FLOSS exception, and it is also available here: 
+ * http://www.alfresco.com/legal/licensing"
+ */
+package org.alfresco.repo.content.metadata;
+
+import java.io.File;
+import java.io.FileNotFoundException;
+import java.io.Serializable;
+import java.net.ConnectException;
+import java.util.HashMap;
+import java.util.Map;
+
+import net.sf.jooreports.openoffice.connection.OpenOfficeConnection;
+
+import org.alfresco.service.cmr.repository.ContentReader;
+import org.alfresco.service.cmr.repository.MimetypeService;
+import org.alfresco.util.TempFileProvider;
+
+import com.sun.star.beans.PropertyValue;
+import com.sun.star.beans.XPropertySet;
+import com.sun.star.document.XDocumentInfoSupplier;
+import com.sun.star.frame.XComponentLoader;
+import com.sun.star.lang.XComponent;
+import com.sun.star.ucb.XFileIdentifierConverter;
+import com.sun.star.uno.UnoRuntime;
+
+/**
+ * The class doing the actual work of the OpenOfficeMetadataExtracter, based around an OpenOffice connection.
+ * 
+ * @author dward
+ */
+public class DefaultOpenOfficeMetadataWorker implements OpenOfficeMetadataWorker
+{
+    private static final String KEY_AUTHOR = "author";
+    private static final String KEY_TITLE = "title";
+    private static final String KEY_DESCRIPTION = "description";
+
+    private OpenOfficeConnection connection;
+    private MimetypeService mimetypeService;
+
+    public void setConnection(OpenOfficeConnection connection)
+    {
+        this.connection = connection;
+    }
+
+    /*
+     * @param mimetypeService the mimetype service. Set this if required.
+     */
+    public void setMimetypeService(MimetypeService mimetypeService)
+    {
+        this.mimetypeService = mimetypeService;
+    }
+
+    /**
+     * @return Returns true if a connection to the Uno server could be established
+     */
+    public boolean isConnected()
+    {
+        return connection.isConnected();
+    }
+
+    /*
+     * (non-Javadoc)
+     * @seeorg.alfresco.repo.content.metadata.OpenOfficeMetadataWorker#extractRaw(org.alfresco.service.cmr.repository.
+     * ContentReader)
+     */
+    public Map<String, Serializable> extractRaw(ContentReader reader) throws Throwable
+    {
+        Map<String, Serializable> rawProperties = new HashMap<String, Serializable>(17);
+
+        String sourceMimetype = reader.getMimetype();
+
+        // create temporary files to convert from and to
+        File tempFromFile = TempFileProvider.createTempFile("OpenOfficeMetadataExtracter-", "."
+                + this.mimetypeService.getExtension(sourceMimetype));
+
+        // download the content from the source reader
+        reader.getContent(tempFromFile);
+
+        String sourceUrl = toUrl(tempFromFile, connection);
+
+        // UNO Interprocess Bridge *should* be thread-safe, but...
+        XComponentLoader desktop = connection.getDesktop();
+        XComponent document = desktop.loadComponentFromURL(sourceUrl, "_blank", 0, new PropertyValue[]
+        {
+            property("Hidden", Boolean.TRUE)
+        });
+        if (document == null)
+        {
+            throw new FileNotFoundException("could not open source document: " + sourceUrl);
+        }
+        try
+        {
+            XDocumentInfoSupplier infoSupplier = (XDocumentInfoSupplier) UnoRuntime.queryInterface(
+                    XDocumentInfoSupplier.class, document);
+            XPropertySet propSet = (XPropertySet) UnoRuntime.queryInterface(XPropertySet.class, infoSupplier
+                    .getDocumentInfo());
+
+            rawProperties.put(KEY_TITLE, propSet.getPropertyValue("Title").toString());
+            rawProperties.put(KEY_DESCRIPTION, propSet.getPropertyValue("Subject").toString());
+            rawProperties.put(KEY_AUTHOR, propSet.getPropertyValue("Author").toString());
+        }
+        finally
+        {
+            document.dispose();
+        }
+        // Done
+        return rawProperties;
+    }
+
+    public String toUrl(File file, OpenOfficeConnection connection) throws ConnectException
+    {
+        Object fcp = connection.getFileContentProvider();
+        XFileIdentifierConverter fic = (XFileIdentifierConverter) UnoRuntime.queryInterface(
+                XFileIdentifierConverter.class, fcp);
+        return fic.getFileURLFromSystemPath("", file.getAbsolutePath());
+    }
+
+    private static PropertyValue property(String name, Object value)
+    {
+        PropertyValue property = new PropertyValue();
+        property.Name = name;
+        property.Value = value;
+        return property;
+    }
+}
--- a/source/java/org/alfresco/repo/content/metadata/OpenOfficeMetadataExtracter.java
+++ b/source/java/org/alfresco/repo/content/metadata/OpenOfficeMetadataExtracter.java
@@ -22,28 +22,14 @@
 * http://www.alfresco.com/legal/licensing" */
 package org.alfresco.repo.content.metadata;

-import java.io.File;
-import java.io.FileNotFoundException;
 import java.io.Serializable;
-import java.net.ConnectException;
 import java.util.Arrays;
 import java.util.HashSet;
 import java.util.Map;

-import net.sf.jooreports.openoffice.connection.OpenOfficeConnection;
-
 import org.alfresco.repo.content.MimetypeMap;
 import org.alfresco.service.cmr.repository.ContentReader;
 import org.alfresco.util.PropertyCheck;
-import org.alfresco.util.TempFileProvider;
-
-import com.sun.star.beans.PropertyValue;
-import com.sun.star.beans.XPropertySet;
-import com.sun.star.document.XDocumentInfoSupplier;
-import com.sun.star.frame.XComponentLoader;
-import com.sun.star.lang.XComponent;
-import com.sun.star.ucb.XFileIdentifierConverter;
-import com.sun.star.uno.UnoRuntime;

 /**
 * Extracts values from Star Office documents into the following:
@@ -55,12 +41,8 @@ import com.sun.star.uno.UnoRuntime;
 * 
 * @author Jesper Steen Møller
 */
-public class OpenOfficeMetadataExtracter extends AbstractMappingMetadataExtracter
+public class OpenOfficeMetadataExtracter extends AbstractMappingMetadataExtracter implements OpenOfficeMetadataWorker
 {
-    private static final String KEY_AUTHOR = "author";
-    private static final String KEY_TITLE = "title";
-    private static final String KEY_DESCRIPTION = "description";
-
    public static String[] SUPPORTED_MIMETYPES = new String[] {
        MimetypeMap.MIMETYPE_STAROFFICE5_WRITER,
        MimetypeMap.MIMETYPE_STAROFFICE5_IMPRESS,
@@ -68,16 +50,16 @@ public class OpenOfficeMetadataExtracter extends AbstractMappingMetadataExtracte
        MimetypeMap.MIMETYPE_OPENOFFICE1_IMPRESS
    };

-    private OpenOfficeConnection connection;
+    private OpenOfficeMetadataWorker worker;

    public OpenOfficeMetadataExtracter()
    {
        super(new HashSet<String>(Arrays.asList(SUPPORTED_MIMETYPES)));
    }

-    public void setConnection(OpenOfficeConnection connection)
+    public void setWorker(OpenOfficeMetadataWorker worker)
    {
-        this.connection = connection;
+        this.worker = worker;
    }
    
    /**
@@ -86,19 +68,18 @@ public class OpenOfficeMetadataExtracter extends AbstractMappingMetadataExtracte
    @Override
    public synchronized void init()
    {
-        PropertyCheck.mandatory("OpenOfficeMetadataExtracter", "connection", connection);
+        PropertyCheck.mandatory("OpenOfficeMetadataExtracter", "worker", worker);
        
        // Base initialization
        super.init();
    }

-    /**
-     * @return Returns true if a connection to the Uno server could be
-     *         established
+    /* (non-Javadoc)
+     * @see org.alfresco.repo.content.metadata.OpenOfficeMetadataWorker#isConnected()
     */
    public boolean isConnected()
    {
-        return connection.isConnected();
+        return worker.isConnected();
    }

    /**
@@ -114,67 +95,18 @@ public class OpenOfficeMetadataExtracter extends AbstractMappingMetadataExtracte
        return super.isSupported(sourceMimetype);
    }

+    /* (non-Javadoc)
+     * @see org.alfresco.repo.content.metadata.OpenOfficeMetadataWorker#extractRaw(org.alfresco.service.cmr.repository.ContentReader)
+     */
    @Override
    public Map<String, Serializable> extractRaw(ContentReader reader) throws Throwable
    {
        Map<String, Serializable> rawProperties = newRawMap();
-
-        String sourceMimetype = reader.getMimetype();
-
-        // create temporary files to convert from and to
-        File tempFromFile = TempFileProvider.createTempFile(
-                "OpenOfficeMetadataExtracter-", "."
-                + getMimetypeService().getExtension(sourceMimetype));
-        // download the content from the source reader
-        reader.getContent(tempFromFile);
-
-        String sourceUrl = toUrl(tempFromFile, connection);
-
-        // UNO Interprocess Bridge *should* be thread-safe, but...
-        XComponentLoader desktop = connection.getDesktop();
-        XComponent document = desktop.loadComponentFromURL(
-                sourceUrl,
-                "_blank",
-                0,
-                new PropertyValue[] { property("Hidden", Boolean.TRUE) });
-        if (document == null)
+        Map<String, Serializable> result = this.worker.extractRaw(reader);
+        for (Map.Entry<String, Serializable> entry : result.entrySet())
        {
-            throw new FileNotFoundException("could not open source document: " + sourceUrl);
+            putRawValue(entry.getKey(), entry.getValue(), rawProperties);
        }
-        try
-        {
-            XDocumentInfoSupplier infoSupplier = (XDocumentInfoSupplier) UnoRuntime.queryInterface(
-                    XDocumentInfoSupplier.class, document);
-            XPropertySet propSet = (XPropertySet) UnoRuntime.queryInterface(
-                    XPropertySet.class,
-                    infoSupplier
-                    .getDocumentInfo());
-
-            putRawValue(KEY_TITLE, propSet.getPropertyValue("Title").toString(), rawProperties);
-            putRawValue(KEY_DESCRIPTION, propSet.getPropertyValue("Subject").toString(), rawProperties);
-            putRawValue(KEY_AUTHOR, propSet.getPropertyValue("Author").toString(), rawProperties);
-        }
-        finally
-        {
-            document.dispose();
-        }
-        // Done
        return rawProperties;
    }
-
-    public String toUrl(File file, OpenOfficeConnection connection) throws ConnectException
-    {
-        Object fcp = connection.getFileContentProvider();
-        XFileIdentifierConverter fic = (XFileIdentifierConverter) UnoRuntime.queryInterface(
-                XFileIdentifierConverter.class, fcp);
-        return fic.getFileURLFromSystemPath("", file.getAbsolutePath());
-    }
-
-    private static PropertyValue property(String name, Object value)
-    {
-        PropertyValue property = new PropertyValue();
-        property.Name = name;
-        property.Value = value;
-        return property;
-    }
 }
--- a/source/java/org/alfresco/repo/content/metadata/OpenOfficeMetadataExtracterTest.java
+++ b/source/java/org/alfresco/repo/content/metadata/OpenOfficeMetadataExtracterTest.java
@@ -41,7 +41,10 @@ public class OpenOfficeMetadataExtracterTest extends AbstractMetadataExtracterTe
        extracter = new OpenOfficeMetadataExtracter();
        extracter.setMimetypeService(mimetypeMap);
        extracter.setDictionaryService(dictionaryService);
-        extracter.setConnection(connection);
+        DefaultOpenOfficeMetadataWorker worker = new DefaultOpenOfficeMetadataWorker();
+        worker.setConnection(connection);
+        worker.setMimetypeService(mimetypeMap);
+        extracter.setWorker(worker);
        extracter.init();
    }

--- a/source/java/org/alfresco/repo/content/metadata/OpenOfficeMetadataWorker.java
+++ b/source/java/org/alfresco/repo/content/metadata/OpenOfficeMetadataWorker.java
@@ -0,0 +1,46 @@
+/*
+ * Copyright (C) 2005-2009 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 received a copy of the text describing 
+ * the FLOSS exception, and it is also available here: 
+ * http://www.alfresco.com/legal/licensing"
+ */
+package org.alfresco.repo.content.metadata;
+
+import java.io.Serializable;
+import java.util.Map;
+
+import org.alfresco.service.cmr.repository.ContentReader;
+
+/**
+ * An interface that allows separation between the metadata extractor registry and the third party subsystem owning the
+ * open office connection.
+ * 
+ * @author dward
+ */
+public interface OpenOfficeMetadataWorker
+{
+    /**
+     * @return Returns true if a connection to the Uno server could be established
+     */
+    public boolean isConnected();
+
+    public Map<String, Serializable> extractRaw(ContentReader reader) throws Throwable;
+}