org.jodconverter.office.LocalOfficeUtils Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jodconverter-local Show documentation
Show all versions of jodconverter-local Show documentation
Module required in order to process local conversions for the Java OpenDocument Converter (JODConverter) project.
/*
* Copyright 2004 - 2012 Mirko Nasato and contributors
* 2016 - 2018 Simon Braconnier and contributors
*
* This file is part of JODConverter - Java OpenDocument Converter.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.jodconverter.office;
import java.io.File;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.stream.Stream;
import org.apache.commons.lang3.ArrayUtils;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.SystemUtils;
import com.sun.star.beans.PropertyValue;
import org.jodconverter.process.MacProcessManager;
import org.jodconverter.process.ProcessManager;
import org.jodconverter.process.PureJavaProcessManager;
import org.jodconverter.process.UnixProcessManager;
import org.jodconverter.process.WindowsProcessManager;
public final class LocalOfficeUtils {
private static final String EXECUTABLE_DEFAULT = "program/soffice.bin";
private static final String EXECUTABLE_MAC = "program/soffice";
private static final String EXECUTABLE_MAC_41 = "MacOS/soffice";
private static final String EXECUTABLE_WINDOWS = "program/soffice.exe";
// This class is required in order to create a default office home
// only on demand, as explained by the Initialization-on-demand holder idiom:
// https://www.wikiwand.com/en/Initialization-on-demand_holder_idiom
private static class DefaultOfficeHomeHolder { // NOSONAR
static final File INSTANCE;
static {
if (StringUtils.isNotBlank(System.getProperty("office.home"))) {
INSTANCE = new File(System.getProperty("office.home"));
} else if (SystemUtils.IS_OS_WINDOWS) {
// Try to find the most recent version of LibreOffice or OpenOffice,
// starting with the 64-bit version. %ProgramFiles(x86)% on 64-bit
// machines; %ProgramFiles% on 32-bit ones
final String programFiles64 = System.getenv("ProgramFiles");
final String programFiles32 = System.getenv("ProgramFiles(x86)");
INSTANCE =
findOfficeHome(
EXECUTABLE_WINDOWS,
programFiles64 + File.separator + "LibreOffice 5",
programFiles32 + File.separator + "LibreOffice 5",
programFiles32 + File.separator + "OpenOffice 4",
programFiles64 + File.separator + "LibreOffice 4",
programFiles32 + File.separator + "LibreOffice 4",
programFiles64 + File.separator + "LibreOffice 3",
programFiles32 + File.separator + "LibreOffice 3",
programFiles32 + File.separator + "OpenOffice.org 3");
} else if (SystemUtils.IS_OS_MAC) {
File homeDir =
findOfficeHome(
EXECUTABLE_MAC_41,
"/Applications/LibreOffice.app/Contents",
"/Applications/OpenOffice.org.app/Contents");
if (homeDir == null) {
homeDir =
findOfficeHome(
EXECUTABLE_MAC,
"/Applications/LibreOffice.app/Contents",
"/Applications/OpenOffice.org.app/Contents");
}
INSTANCE = homeDir;
} else {
// UNIX
// Linux or other *nix variants
INSTANCE =
findOfficeHome(
EXECUTABLE_DEFAULT,
"/usr/lib64/libreoffice",
"/usr/lib/libreoffice",
"/opt/libreoffice",
"/usr/lib64/openoffice",
"/usr/lib64/openoffice.org3",
"/usr/lib64/openoffice.org",
"/usr/lib/openoffice",
"/usr/lib/openoffice.org3",
"/usr/lib/openoffice.org",
"/opt/openoffice.org3");
}
}
private static File findOfficeHome(final String executablePath, final String... homePaths) {
return Stream.of(homePaths)
.map(File::new)
.filter(homeDir -> new File(homeDir, executablePath).isFile())
.findFirst()
.orElse(null);
}
}
/**
* Find the best process manager that will be used to retrieve a process PID and to kill a process
* by PID.
*
* @return The best process manager according to the current OS.
*/
public static ProcessManager findBestProcessManager() {
if (SystemUtils.IS_OS_MAC) {
return MacProcessManager.getDefault();
} else if (SystemUtils.IS_OS_UNIX) {
return UnixProcessManager.getDefault();
} else if (SystemUtils.IS_OS_WINDOWS) {
final WindowsProcessManager windowsProcessManager = WindowsProcessManager.getDefault();
return windowsProcessManager.isUsable()
? windowsProcessManager
: PureJavaProcessManager.getDefault();
} else {
// NOTE: UnixProcessManager can't be trusted to work on Solaris
// because of the 80-char limit on ps output there
return PureJavaProcessManager.getDefault();
}
}
/**
* Builds an array of {@link OfficeUrl} from an array of port numbers and an array of pipe names.
*
* @param portNumbers The port numbers from which office URLs will be created, may be null.
* @param pipeNames The pipe names from which office URLs will be created, may be null.
* @return an array of office URL. If both arguments are null, then an array is returned with a
* single office URL, using the default port number 2002.
*/
public static OfficeUrl[] buildOfficeUrls(final int[] portNumbers, final String[] pipeNames) {
// Assign default value if no pipe names or port numbers have been specified.
if (portNumbers == null && pipeNames == null) {
return new OfficeUrl[] {new OfficeUrl(2002)};
}
// Build the office URL list and return it
final List officeUrls =
new ArrayList<>(ArrayUtils.getLength(portNumbers) + ArrayUtils.getLength(pipeNames));
Optional.ofNullable(pipeNames)
.map(Stream::of)
.ifPresent(stream -> stream.map(OfficeUrl::new).forEach(officeUrls::add));
// We cannot do the same for an int[]
if (portNumbers != null) {
Arrays.stream(portNumbers).forEach(portNumber -> officeUrls.add(new OfficeUrl(portNumber)));
}
return officeUrls.toArray(new OfficeUrl[0]);
}
/**
* Gets the default office home directory, which is auto-detected.
*
* @return A {@code File} instance that is the directory where lives the first detected office
* installation.
*/
public static File getDefaultOfficeHome() {
return DefaultOfficeHomeHolder.INSTANCE;
}
/**
* Gets the office executable within an office installation.
*
* @param officeHome The root (home) directory of the office installation.
* @return A instance of the executable file.
*/
public static File getOfficeExecutable(final File officeHome) {
// Mac
if (SystemUtils.IS_OS_MAC) {
// Starting with LibreOffice 4.1 the location of the executable has changed on Mac.
// It's now in program/soffice. Handle both cases!
File executableFile = new File(officeHome, EXECUTABLE_MAC_41);
if (!executableFile.isFile()) {
executableFile = new File(officeHome, EXECUTABLE_MAC);
}
return executableFile;
}
// Windows
if (SystemUtils.IS_OS_WINDOWS) {
return new File(officeHome, EXECUTABLE_WINDOWS);
}
// Everything else
return new File(officeHome, EXECUTABLE_DEFAULT);
}
/**
* Creates a {@code PropertyValue} with the specified name and value.
*
* @param name The property name.
* @param value The property value.
* @return The created {@code PropertyValue}.
*/
public static PropertyValue property(final String name, final Object value) {
final PropertyValue prop = new PropertyValue(); // NOSONAR
prop.Name = name;
prop.Value = value;
return prop;
}
/**
* Stops an OfficeManager unconditionally.
*
* Equivalent to {@link OfficeManager#stop()}, except any exceptions will be ignored. This is
* typically used in finally blocks.
*
*
Example code:
*
*
* OfficeManager manager = null;
* try {
* manager = LocalOfficeManager().make();
* manager.start();
*
* // process manager
*
* } catch (Exception e) {
* // error handling
* } finally {
* OfficeUtils.stopQuietly(manager);
* }
*
*
* @param manager the manager to stop, may be null or already stopped.
* @deprecated Use {@link OfficeUtils#stopQuietly(OfficeManager)} instead.
*/
public static void stopQuietly(final OfficeManager manager) {
OfficeUtils.stopQuietly(manager);
}
/**
* Converts a regular java map to an array of {@code PropertyValue}, usable as arguments with UNO
* interface types.
*
* @param properties The map to convert.
* @return An array of {@code PropertyValue}.
*/
public static PropertyValue[] toUnoProperties(final Map properties) {
final List propertyValues = new ArrayList<>(properties.size());
for (final Map.Entry entry : properties.entrySet()) {
Object value = entry.getValue();
if (value instanceof Map) {
@SuppressWarnings("unchecked")
final Map subProperties = (Map) value;
value = toUnoProperties(subProperties);
}
propertyValues.add(property((String) entry.getKey(), value));
}
return propertyValues.toArray(new PropertyValue[0]);
}
/**
* Constructs an URL from the specified file as expected by office.
*
* @param file The file for which an URL will be constructed.
* @return A valid office URL.
*/
public static String toUrl(final File file) {
final String path = file.toURI().getRawPath();
final String url = path.startsWith("//") ? "file:" + path : "file://" + path;
return url.endsWith("/") ? url.substring(0, url.length() - 1) : url;
}
/**
* Validates that the specified File instance is a valid office home directory.
*
* @param officeHome The home to validate.
* @exception IllegalStateException If the specified directory if not a valid office home
* directory.
*/
public static void validateOfficeHome(final File officeHome) {
if (officeHome == null) {
throw new IllegalStateException("officeHome not set and could not be auto-detected");
}
if (!officeHome.isDirectory()) {
throw new IllegalStateException(
"officeHome doesn't exist or is not a directory: " + officeHome);
}
if (!getOfficeExecutable(officeHome).isFile()) {
throw new IllegalStateException(
"Invalid officeHome: it doesn't contain soffice.bin: " + officeHome);
}
}
/**
* Validates that the specified File instance is a valid office template profile directory.
*
* @param templateProfileDir The directory to validate.
* @exception IllegalStateException If the specified directory if not a valid office template
* profile directory.
*/
public static void validateOfficeTemplateProfileDirectory(final File templateProfileDir) {
// Template profile directory is not required.
if (templateProfileDir == null || new File(templateProfileDir, "user").isDirectory()) {
return;
}
throw new IllegalStateException(
"templateProfileDir doesn't appear to contain a user profile: " + templateProfileDir);
}
/**
* Validates that the specified File instance is a valid office working directory.
*
* @param workingDir The directory to validate.
* @exception IllegalStateException If the specified directory if not a valid office working
* directory.
*/
public static void validateOfficeWorkingDirectory(final File workingDir) {
if (!workingDir.isDirectory()) {
throw new IllegalStateException(
"workingDir doesn't exist or is not a directory: " + workingDir);
}
}
// Suppresses default constructor, ensuring non-instantiability.
private LocalOfficeUtils() {
throw new AssertionError("Utility class must not be instantiated");
}
}