Commits

P_W999  committed 5b455a4

- using Apache Commons Exec for launching ExifTool
- committing some uncommitted code

  • Participants
  • Parent commits 7422f1d

Comments (0)

Files changed (10)

 			<attribute name="javadoc_location" value="jar:platform:/resource/j-exiftool/lib/cal10n-0.7.4/cal10n-api-0.7.4-javadoc.jar!/"/>
 		</attributes>
 	</classpathentry>
+	<classpathentry kind="lib" path="lib/commons-exec/commons-exec-1.1.jar" sourcepath="lib/commons-exec/commons-exec-1.1-sources.jar">
+		<attributes>
+			<attribute name="javadoc_location" value="jar:platform:/resource/J-ExifTool/lib/commons-exec/commons-exec-1.1-javadoc.jar!/"/>
+		</attributes>
+	</classpathentry>
 	<classpathentry kind="output" path="bin"/>
 </classpath>

File lib/commons-exec/LICENSE.txt

+/*
+ *                                 Apache License
+ *                           Version 2.0, January 2004
+ *                        http://www.apache.org/licenses/
+ *
+ *   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+ *
+ *   1. Definitions.
+ *
+ *      "License" shall mean the terms and conditions for use, reproduction,
+ *      and distribution as defined by Sections 1 through 9 of this document.
+ *
+ *      "Licensor" shall mean the copyright owner or entity authorized by
+ *      the copyright owner that is granting the License.
+ *
+ *      "Legal Entity" shall mean the union of the acting entity and all
+ *      other entities that control, are controlled by, or are under common
+ *      control with that entity. For the purposes of this definition,
+ *      "control" means (i) the power, direct or indirect, to cause the
+ *      direction or management of such entity, whether by contract or
+ *      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ *      outstanding shares, or (iii) beneficial ownership of such entity.
+ *
+ *      "You" (or "Your") shall mean an individual or Legal Entity
+ *      exercising permissions granted by this License.
+ *
+ *      "Source" form shall mean the preferred form for making modifications,
+ *      including but not limited to software source code, documentation
+ *      source, and configuration files.
+ *
+ *      "Object" form shall mean any form resulting from mechanical
+ *      transformation or translation of a Source form, including but
+ *      not limited to compiled object code, generated documentation,
+ *      and conversions to other media types.
+ *
+ *      "Work" shall mean the work of authorship, whether in Source or
+ *      Object form, made available under the License, as indicated by a
+ *      copyright notice that is included in or attached to the work
+ *      (an example is provided in the Appendix below).
+ *
+ *      "Derivative Works" shall mean any work, whether in Source or Object
+ *      form, that is based on (or derived from) the Work and for which the
+ *      editorial revisions, annotations, elaborations, or other modifications
+ *      represent, as a whole, an original work of authorship. For the purposes
+ *      of this License, Derivative Works shall not include works that remain
+ *      separable from, or merely link (or bind by name) to the interfaces of,
+ *      the Work and Derivative Works thereof.
+ *
+ *      "Contribution" shall mean any work of authorship, including
+ *      the original version of the Work and any modifications or additions
+ *      to that Work or Derivative Works thereof, that is intentionally
+ *      submitted to Licensor for inclusion in the Work by the copyright owner
+ *      or by an individual or Legal Entity authorized to submit on behalf of
+ *      the copyright owner. For the purposes of this definition, "submitted"
+ *      means any form of electronic, verbal, or written communication sent
+ *      to the Licensor or its representatives, including but not limited to
+ *      communication on electronic mailing lists, source code control systems,
+ *      and issue tracking systems that are managed by, or on behalf of, the
+ *      Licensor for the purpose of discussing and improving the Work, but
+ *      excluding communication that is conspicuously marked or otherwise
+ *      designated in writing by the copyright owner as "Not a Contribution."
+ *
+ *      "Contributor" shall mean Licensor and any individual or Legal Entity
+ *      on behalf of whom a Contribution has been received by Licensor and
+ *      subsequently incorporated within the Work.
+ *
+ *   2. Grant of Copyright License. Subject to the terms and conditions of
+ *      this License, each Contributor hereby grants to You a perpetual,
+ *      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ *      copyright license to reproduce, prepare Derivative Works of,
+ *      publicly display, publicly perform, sublicense, and distribute the
+ *      Work and such Derivative Works in Source or Object form.
+ *
+ *   3. Grant of Patent License. Subject to the terms and conditions of
+ *      this License, each Contributor hereby grants to You a perpetual,
+ *      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ *      (except as stated in this section) patent license to make, have made,
+ *      use, offer to sell, sell, import, and otherwise transfer the Work,
+ *      where such license applies only to those patent claims licensable
+ *      by such Contributor that are necessarily infringed by their
+ *      Contribution(s) alone or by combination of their Contribution(s)
+ *      with the Work to which such Contribution(s) was submitted. If You
+ *      institute patent litigation against any entity (including a
+ *      cross-claim or counterclaim in a lawsuit) alleging that the Work
+ *      or a Contribution incorporated within the Work constitutes direct
+ *      or contributory patent infringement, then any patent licenses
+ *      granted to You under this License for that Work shall terminate
+ *      as of the date such litigation is filed.
+ *
+ *   4. Redistribution. You may reproduce and distribute copies of the
+ *      Work or Derivative Works thereof in any medium, with or without
+ *      modifications, and in Source or Object form, provided that You
+ *      meet the following conditions:
+ *
+ *      (a) You must give any other recipients of the Work or
+ *          Derivative Works a copy of this License; and
+ *
+ *      (b) You must cause any modified files to carry prominent notices
+ *          stating that You changed the files; and
+ *
+ *      (c) You must retain, in the Source form of any Derivative Works
+ *          that You distribute, all copyright, patent, trademark, and
+ *          attribution notices from the Source form of the Work,
+ *          excluding those notices that do not pertain to any part of
+ *          the Derivative Works; and
+ *
+ *      (d) If the Work includes a "NOTICE" text file as part of its
+ *          distribution, then any Derivative Works that You distribute must
+ *          include a readable copy of the attribution notices contained
+ *          within such NOTICE file, excluding those notices that do not
+ *          pertain to any part of the Derivative Works, in at least one
+ *          of the following places: within a NOTICE text file distributed
+ *          as part of the Derivative Works; within the Source form or
+ *          documentation, if provided along with the Derivative Works; or,
+ *          within a display generated by the Derivative Works, if and
+ *          wherever such third-party notices normally appear. The contents
+ *          of the NOTICE file are for informational purposes only and
+ *          do not modify the License. You may add Your own attribution
+ *          notices within Derivative Works that You distribute, alongside
+ *          or as an addendum to the NOTICE text from the Work, provided
+ *          that such additional attribution notices cannot be construed
+ *          as modifying the License.
+ *
+ *      You may add Your own copyright statement to Your modifications and
+ *      may provide additional or different license terms and conditions
+ *      for use, reproduction, or distribution of Your modifications, or
+ *      for any such Derivative Works as a whole, provided Your use,
+ *      reproduction, and distribution of the Work otherwise complies with
+ *      the conditions stated in this License.
+ *
+ *   5. Submission of Contributions. Unless You explicitly state otherwise,
+ *      any Contribution intentionally submitted for inclusion in the Work
+ *      by You to the Licensor shall be under the terms and conditions of
+ *      this License, without any additional terms or conditions.
+ *      Notwithstanding the above, nothing herein shall supersede or modify
+ *      the terms of any separate license agreement you may have executed
+ *      with Licensor regarding such Contributions.
+ *
+ *   6. Trademarks. This License does not grant permission to use the trade
+ *      names, trademarks, service marks, or product names of the Licensor,
+ *      except as required for reasonable and customary use in describing the
+ *      origin of the Work and reproducing the content of the NOTICE file.
+ *
+ *   7. Disclaimer of Warranty. Unless required by applicable law or
+ *      agreed to in writing, Licensor provides the Work (and each
+ *      Contributor provides its Contributions) on an "AS IS" BASIS,
+ *      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ *      implied, including, without limitation, any warranties or conditions
+ *      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ *      PARTICULAR PURPOSE. You are solely responsible for determining the
+ *      appropriateness of using or redistributing the Work and assume any
+ *      risks associated with Your exercise of permissions under this License.
+ *
+ *   8. Limitation of Liability. In no event and under no legal theory,
+ *      whether in tort (including negligence), contract, or otherwise,
+ *      unless required by applicable law (such as deliberate and grossly
+ *      negligent acts) or agreed to in writing, shall any Contributor be
+ *      liable to You for damages, including any direct, indirect, special,
+ *      incidental, or consequential damages of any character arising as a
+ *      result of this License or out of the use or inability to use the
+ *      Work (including but not limited to damages for loss of goodwill,
+ *      work stoppage, computer failure or malfunction, or any and all
+ *      other commercial damages or losses), even if such Contributor
+ *      has been advised of the possibility of such damages.
+ *
+ *   9. Accepting Warranty or Additional Liability. While redistributing
+ *      the Work or Derivative Works thereof, You may choose to offer,
+ *      and charge a fee for, acceptance of support, warranty, indemnity,
+ *      or other liability obligations and/or rights consistent with this
+ *      License. However, in accepting such obligations, You may act only
+ *      on Your own behalf and on Your sole responsibility, not on behalf
+ *      of any other Contributor, and only if You agree to indemnify,
+ *      defend, and hold each Contributor harmless for any liability
+ *      incurred by, or claims asserted against, such Contributor by reason
+ *      of your accepting any such warranty or additional liability.
+ *
+ *   END OF TERMS AND CONDITIONS
+ *
+ *   APPENDIX: How to apply the Apache License to your work.
+ *
+ *      To apply the Apache License to your work, attach the following
+ *      boilerplate notice, with the fields enclosed by brackets "[]"
+ *      replaced with your own identifying information. (Don't include
+ *      the brackets!)  The text should be enclosed in the appropriate
+ *      comment syntax for the file format. We also recommend that a
+ *      file or class name and description of purpose be included on the
+ *      same "printed page" as the copyright notice for easier
+ *      identification within third-party archives.
+ *
+ *   Copyright [yyyy] [name of copyright owner]
+ *
+ *   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.
+ */

File lib/commons-exec/NOTICE.txt

+Apache Commons Exec
+Copyright 2005-2010 The Apache Software Foundation
+
+This product includes software developed by
+The Apache Software Foundation (http://www.apache.org/).

File lib/commons-exec/commons-exec-1.1-javadoc.jar

Binary file added.

File lib/commons-exec/commons-exec-1.1-sources.jar

Binary file added.

File lib/commons-exec/commons-exec-1.1.jar

Binary file added.

File src/be/pw/jexif/JExifTool.java

  ******************************************************************************/
 package be.pw.jexif;
 
-import java.io.BufferedReader;
 import java.io.File;
 import java.io.FileWriter;
 import java.io.IOException;
-import java.io.InputStreamReader;
 import java.text.MessageFormat;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
 
+import org.apache.commons.exec.CommandLine;
+import org.apache.commons.exec.DefaultExecuteResultHandler;
+import org.apache.commons.exec.DefaultExecutor;
+import org.apache.commons.exec.ExecuteWatchdog;
+import org.apache.commons.exec.Executor;
+import org.apache.commons.exec.PumpStreamHandler;
+import org.apache.commons.exec.ShutdownHookProcessDestroyer;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import be.pw.jexif.internal.action.impl.ActionFactory;
 import be.pw.jexif.internal.constants.ExecutionConstant;
 import be.pw.jexif.internal.result.ResultHandler;
-import be.pw.jexif.internal.thread.RunnableReader;
+import be.pw.jexif.internal.thread.JExifOutputStream;
 import be.pw.jexif.internal.thread.event.DebugHandler;
 import be.pw.jexif.internal.thread.event.EventHandler;
 import be.pw.jexif.internal.util.Cal10nUtil;
 	 */
 	private final int deadLock = Integer.getInteger(ExecutionConstant.EXIFTOOLDEADLOCK, 4000);
 	/**
-	 * This will hold a reference to the ExifTool.exe process.
-	 */
-	private Process p;
-	/**
 	 * The guava EventBuss will be used to handle the output- and error-streams from the ExifTool process.
 	 */
 	private final EventBus bus = new EventBus();
 	 * The logger for this class.
 	 */
 	private static final Logger LOG = LoggerFactory.getLogger(JExifTool.class);
-	/**
-	 * The thread which will handle the output from the ExifTool process.
-	 */
-	private Thread inputReaderThread;
-	/**
-	 * The thread which will handle the error output from the ExifTool process.
-	 */
-	private Thread errorReaderThread;
+
+	private DefaultExecuteResultHandler resultHandler = null;
+
+	private Executor executor = null;
 
 	/**
 	 * Default constructor. <br />
 	}
 
 	/**
-	 * Starts the ExifTool process and several sub-threads to handle the in- and output streams.<br />
-	 * This method is automatically called when a new instance of JExifTool is created.
+	 * Starts the ExifTool process using Apache Commons Exec This method is automatically called when a new instance of JExifTool is created.
 	 */
 	private synchronized void start() {
 		LOG.trace("Using exifToolPath in: " + exifToolPath.getAbsolutePath());
 			argsWriter = new FileWriter(argsFile);
 			argsWriter.write("");
 			argsWriter.flush();
-			/*
-			 * The "master" thread which is responsible for the ExifTool process and the two sub-threads for handling the output.
-			 */
-			final Thread exifThread = new Thread(new Runnable() {
-				@Override
-				public synchronized void run() {
-					try {
-						String claFormat;
-						String cla;
-						if (System.getProperty("os.name").toLowerCase().contains("windows")) {
-							LOG.trace("Running windows: always putting CLA between \" \"");
-							claFormat = ExecutionConstant.WINDOWS_CLA;
-						} else {
-							if (argsFile.getCanonicalPath().contains(" ")) {
-								claFormat = ExecutionConstant.MAC_CLA;
-							} else {
-								claFormat = ExecutionConstant.LINUX_CLA;
-							}
-						}
-						cla = MessageFormat.format(claFormat, exifToolPath.getCanonicalPath(), argsFile.getCanonicalPath());
-						LOG.trace("Starting ExifTool with command line arguments {}", cla);
-						p = Runtime.getRuntime().exec(cla);
-						BufferedReader bri = new BufferedReader(new InputStreamReader(p.getInputStream()));
-						BufferedReader bre = new BufferedReader(new InputStreamReader(p.getErrorStream()));
-						DebugHandler debug = new DebugHandler();
-						bus.register(debug);
-						inputReaderThread = new Thread(new RunnableReader(bri, bus, false));
-						inputReaderThread.setName("inputReaderThread");
-						inputReaderThread.start();
-						errorReaderThread = new Thread(new RunnableReader(bre, bus, true));
-						errorReaderThread.setName("errorReaderThread");
-						errorReaderThread.start();
-						notify();
-						LOG.trace("Left the monitor");
-					} catch (Exception e) {
-						LOG.error(Cal10nUtil.get(Errors.EXIFTHREAD), e);
-					}
-				}
-			});
 
-			synchronized (exifThread) {
-				exifThread.setName("ExifTool-thread");
-				exifThread.start();
-				exifThread.wait(); // wait unconditionally for the notify, we must be sure all the threads are running.
-				// also: starting the ExifTool process normally takes long enough so that the wait can be reached before the notify is called.
+			String claFormat;
+			String cla;
+			if (System.getProperty("os.name").toLowerCase().contains("windows")) {
+				LOG.trace("Running windows: always putting CLA between \" \"");
+				claFormat = ExecutionConstant.WINDOWS_CLA;
+			} else {
+				if (argsFile.getCanonicalPath().contains(" ")) {
+					claFormat = ExecutionConstant.MAC_CLA;
+				} else {
+					claFormat = ExecutionConstant.LINUX_CLA;
+				}
 			}
-			LOG.debug("ExifTool-thread and subthreads started");
+			cla = MessageFormat.format(claFormat, exifToolPath.getCanonicalPath(), argsFile.getCanonicalPath());
+			LOG.trace("Starting ExifTool with command line arguments {}", cla);
+
+			DebugHandler debug = new DebugHandler();
+			bus.register(debug);
+
+			CommandLine cl = CommandLine.parse(cla); // TODO: make better use of CommandLine
+			resultHandler = new DefaultExecuteResultHandler();
+			executor = new DefaultExecutor();
+			executor.setWatchdog(new ExecuteWatchdog(ExecuteWatchdog.INFINITE_TIMEOUT));
+			executor.setStreamHandler(new PumpStreamHandler(new JExifOutputStream(bus, false), new JExifOutputStream(bus, true)));
+			executor.setProcessDestroyer(new ShutdownHookProcessDestroyer());
+			executor.execute(cl, resultHandler);
+			LOG.info("ExifTool was started");
+			Thread.sleep(500);	//wait a bit to ensure process has started
 		} catch (IOException e) {
 			LOG.error(Cal10nUtil.get(Errors.IO_ARGSFILE), e);
 		} catch (InterruptedException e) {
-			LOG.error("Failed to join exifThread", e);
+			LOG.error(Cal10nUtil.get(Errors.INTERRUPTED_SLEEP), e);
 		}
 	}
 
 	/**
-	 * Starts the ExifTool process if needed (if eg. it auto-closed itself after 10 minutes).
+	 * Starts the ExifTool process if needed
 	 */
 	private synchronized void startIfNecessary() {
-		if (p != null) {
-			try {
-				p.exitValue();
-			} catch (IllegalThreadStateException e) {
-				LOG.debug("ExifTool process was still running");
-				return;
+		if (resultHandler != null) {
+			LOG.trace("Using apache commons-exec");
+			if (resultHandler.hasResult() || executor.getWatchdog().killedProcess()) {
+				LOG.info("ExifTool is not running anymore, restarting it");
+				start();
 			}
+		} else {
+			LOG.info("ExifTool process was not running");
+			start();
 		}
-		LOG.info("ExifTool process was not running, re-starting it");
-		inputReaderThread.interrupt();
-		errorReaderThread.interrupt();
-		start();
 	}
 
 	/**
 	 * @throws JExifException if it failed to stop (there is a Thread.sleep which may throw an InterruptedException).
 	 */
 	@Beta
-	public void stop() throws JExifException {
+	public synchronized void stop() throws JExifException {
 		try {
-			LOG.trace("Stopping ExifTool process");
+			LOG.info("Stopping ExifTool process");
 			argsWriter.append(ExecutionConstant.STAY_OPEN).append("\r\n");
 			argsWriter.append("false\n");
-			argsWriter.flush();
-			boolean stopped = false;
-			while (!stopped) {
-				try {
-					p.exitValue();
-					stopped = true;
-				} catch (IllegalThreadStateException e) {
-					stopped = false;
-					try {
-						Thread.sleep(10);
-					} catch (InterruptedException e1) {
-						LOG.error("An error occured while sleeping while stopping ExifTool process", e);
-						throw new JExifException(e1);
-					}
-				}
-			}
-			LOG.debug("ExifTool process should have stopped");
+			argsWriter.flush();	
+			executor.setWatchdog(new ExecuteWatchdog(1500));
+			while (!resultHandler.hasResult());	//wait for ExifTool to stop
+			LOG.trace("Process stopped");
 		} catch (IOException e) {
 			LOG.error(Cal10nUtil.get(Errors.IO_CLOSING), e);
 		}

File src/be/pw/jexif/internal/thread/JExifOutputStream.java

+package be.pw.jexif.internal.thread;
+
+import java.io.IOException;
+import java.io.OutputStream;
+
+import be.pw.jexif.internal.thread.event.ErrorEvent;
+import be.pw.jexif.internal.thread.event.InputEvent;
+
+import com.google.common.eventbus.EventBus;
+
+public class JExifOutputStream extends OutputStream {
+
+	private EventBus bus;
+	private boolean error;
+	private String buff = null;
+	
+	public JExifOutputStream(EventBus bus, boolean error) throws IOException {
+		this.bus = bus;
+		this.error = error;
+	}
+	
+	@Override
+	public void write(int b) throws IOException {
+		
+	}
+	
+	@Override
+	public void write(byte[] b, int off, int len) throws IOException {
+		StringBuilder build = new StringBuilder();
+		if (buff != null) {
+			build.append(buff);
+		}
+		for (int i = 0; i < len; ++i) {	//not newline character
+			if (b[i] != '\r' && b[i] != '\n') {
+				build.append((char)b[i]);
+			} else if ((i+1) == len || (b[i+1] != '\r' && b[i+1] != '\n')) {	//current = newline, next isn't newline OR at the end of buffer
+				if (error) {
+					bus.post(new ErrorEvent(build.toString()));
+				} else {
+					bus.post(new InputEvent(build.toString()));
+				}
+				build = new StringBuilder();
+			} 
+		}
+		if (!build.toString().isEmpty()) {
+			buff = build.toString();
+		} else {
+			buff = null;
+		}
+	}
+
+}

File src/log4j.properties

 
 #log4j.logger.be.pw=DEBUG
 log4j.logger.be.pw.jexif.internal.thread.event.DebugHandler=FATAL
+log4j.logger.be.pw.jexif.DemoApp=INFO
+log4j.logger.be.pw.jexif.JExifTool=WARN
 
 
 #------------------------------------------------------------------------------

File test/be/pw/jexif/internal/util/GPSUtilTest.java

+package be.pw.jexif.internal.util;
+
+import static org.fest.assertions.Assertions.assertThat;
+
+import org.testng.annotations.Test;
+
+public class GPSUtilTest {
+
+	@Test
+	public void DMSToDecimal() {
+		assertThat(GPSUtil.DMSToDecimal("87 43 41")).isEqualTo("87.72805555555556");
+	}
+}