X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fgraphics%2FGraphicsConverter.C;h=941aeb2a0ff1c531b28fb20c7b6c4c0d94b3fdfb;hb=f5fbef2d8f3fde203fc04626856c2578ce1d3103;hp=370f26f791e9ee1372d629415e8dd696bc43349c;hpb=481937ef954df2738823c00e8fe4bcce2040afad;p=lyx.git

diff --git a/src/graphics/GraphicsConverter.C b/src/graphics/GraphicsConverter.C
index 370f26f791..941aeb2a0f 100644
--- a/src/graphics/GraphicsConverter.C
+++ b/src/graphics/GraphicsConverter.C
@@ -1,189 +1,351 @@
-/*
+/**
  * \file GraphicsConverter.C
- * Copyright 2002 the LyX Team
- * Read the file COPYING
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
+ *
+ * \author Angus Leeming
  *
- * \author Angus Leeming <a.leeming@ic.ac.uk>
+ * Full author contact details are available in file CREDITS.
  */
 
 #include <config.h>
 
-#ifdef __GNUG__
-#pragma implementation
-#endif
-
 #include "GraphicsConverter.h"
 
 #include "converter.h"
 #include "debug.h"
-#include "gettext.h"
+#include "format.h"
 
 #include "support/filetools.h"
-#include "support/forkedcall.h"
-#include "support/path.h"
+#include "support/forkedcallqueue.h"
+#include "support/convert.h"
+#include "support/lstrings.h"
+#include "support/lyxlib.h"
 
 #include <boost/bind.hpp>
 
+#include <sstream>
 #include <fstream>
 
-namespace {
+namespace support = lyx::support;
 
-string const move_file(string const & from_file, string const & to_file)
-{
-	if (from_file == to_file)
-		return string();
+using support::changeExtension;
+using support::Forkedcall;
+using support::ForkedCallQueue;
+using support::libFileSearch;
+using support::libScriptSearch;
+using support::onlyPath;
+using support::onlyFilename;
+using support::quoteName;
+using support::subst;
+using support::tempName;
+using support::unlink;
 
-	ostringstream command;
-	command << "fromfile=" << from_file << "\n"
-		<< "tofile="   << to_file << "\n\n"
-		<< "'mv' -f ${fromfile} ${tofile}\n"
-		<< "if [ $? -ne 0 ]; then\n"
-		<< "\t'cp' -f ${fromfile} ${tofile}\n"
-		<< "\tif [ $? -ne 0 ]; then\n"
-		<< "\t\texit 1\n"
-		<< "\tfi\n"
-		<< "\t'rm' -f ${fromfile}\n"
-		<< "fi\n";
-
-	return command.str().c_str();
+using std::endl;
+using std::ostream;
+using std::ostringstream;
+using std::string;
+
+
+namespace lyx {
+namespace graphics {
+
+class Converter::Impl : public boost::signals::trackable {
+public:
+	///
+	Impl(string const &, string const &, string const &, string const &);
+
+	///
+	void startConversion();
+
+	/** This method is connected to a signal passed to the forked call
+	 *  class, passing control back here when the conversion is completed.
+	 *  Cleans-up the temporary files, emits the finishedConversion
+	 *  signal and removes the Converter from the list of all processes.
+	 */
+	void converted(pid_t pid, int retval);
+
+	/** At the end of the conversion process inform the outside world
+	 *  by emitting a signal.
+	 */
+	typedef boost::signal<void(bool)> SignalType;
+	///
+	SignalType finishedConversion;
+
+	///
+	string script_command_;
+	///
+	string script_file_;
+	///
+	string to_file_;
+	///
+	bool valid_process_;
+	///
+	bool finished_;
+};
+
+
+bool Converter::isReachable(string const & from_format_name,
+			    string const & to_format_name)
+{
+	return converters.isReachable(from_format_name, to_format_name);
 }
 
-} // namespace anon
 
+Converter::Converter(string const & from_file,   string const & to_file_base,
+		     string const & from_format, string const & to_format)
+	: pimpl_(new Impl(from_file, to_file_base, from_format, to_format))
+{}
+
+
+// Empty d-tor out-of-line to keep boost::scoped_ptr happy.
+Converter::~Converter()
+{}
 
-namespace grfx {
 
-GConverter & GConverter::get()
+void Converter::startConversion() const
 {
-	static GConverter singleton;
-	return singleton;
+	pimpl_->startConversion();
 }
 
 
-bool GConverter::isReachable(string const & from_format_name,
-			     string const & to_format_name) const
+boost::signals::connection Converter::connect(slot_type const & slot) const
 {
-	return converters.isReachable(from_format_name, to_format_name);
+	return pimpl_->finishedConversion.connect(slot);
 }
 
 
-void GConverter::convert(string const & from_file, string const & to_file_base,
-			 string const & from_format, string const & to_format,
-			 SignalTypePtr on_finish)
+string const & Converter::convertedFile() const
 {
-	lyxerr[Debug::GRAPHICS] << "[GraphicsConverter::convert]\n"
-		<< "\tfrom_file:    " << from_file
+	static string const empty;
+	return pimpl_->finished_ ? pimpl_->to_file_ : empty;
+}
+
+} // namespace graphics
+} // namespace lyx
+
+
+//------------------------------
+// Implementation details follow
+//------------------------------
+
+namespace {
+
+/** Build the conversion script, returning true if able to build it.
+ *  The script is output to the ostringstream 'script'.
+ */
+bool build_script(string const & from_file, string const & to_file_base,
+		  string const & from_format, string const & to_format,
+		  ostream & script);
+
+} // namespace anon
+
+
+namespace lyx {
+namespace graphics {
+
+Converter::Impl::Impl(string const & from_file,   string const & to_file_base,
+		      string const & from_format, string const & to_format)
+	: valid_process_(false), finished_(false)
+{
+	lyxerr[Debug::GRAPHICS] << "Converter c-tor:\n"
+		<< "\tfrom_file:      " << from_file
 		<< "\n\tto_file_base: " << to_file_base
 		<< "\n\tfrom_format:  " << from_format
 		<< "\n\tto_format:    " << to_format << endl;
+
+	// The converted image is to be stored in this file (we do not
+	// use ChangeExtension because this is a basename which may
+	// nevertheless contain a '.')
+	to_file_ = to_file_base + '.' +  formats.extension(to_format);
+
 	// The conversion commands are stored in a stringstream
 	ostringstream script;
-	script << "#!/bin/sh\n";
-	string script_command;
-	string script_file;
-
-	bool success = build_script(from_file, to_file_base,
-				     from_format, to_format, script);
+	script << "#!/usr/bin/env python\n"
+		   << "import os, sys\n\n"
+		   << "def unlinkNoThrow(file):\n"
+		   << "  ''' remove a file, do not throw if an error occurs '''\n"
+		   << "  try:\n"
+		   << "    os.unlink(file)\n"
+		   << "  except:\n"
+		   << "    pass\n\n";
+
+	bool const success = build_script(from_file, to_file_base,
+					  from_format, to_format, script);
 
-	if (success) {
-		lyxerr[Debug::GRAPHICS] << "\tConversion script:\n"
-			<< "--------------------------------------\n"
-			<< script.str().c_str() 
+	if (!success) {
+		script_command_ =
+			"python " +
+			quoteName(libFileSearch("scripts", "convertDefault.py")) +
+			' ' +
+			quoteName((from_format.empty() ? "" : from_format + ':') + from_file) +
+			' ' +
+			quoteName(to_format + ':' + to_file_);
+
+		lyxerr[Debug::GRAPHICS]
+			<< "\tNo converter defined! I use convertDefault.py\n\t"
+			<< script_command_ << endl;
+
+	} else {
+
+		lyxerr[Debug::GRAPHICS] << "\tConversion script:"
+			<< "\n--------------------------------------\n"
+			<< script.str()
 			<< "\n--------------------------------------\n";
 
 		// Output the script to file.
 		static int counter = 0;
-		script_file = OnlyPath(to_file_base) + "lyxconvert" +
-			tostr(counter++) + ".sh";
+		script_file_ = onlyPath(to_file_base) + "lyxconvert" +
+			convert<string>(counter++) + ".py";
 
-		std::ofstream fs(script_file.c_str());
+		std::ofstream fs(script_file_.c_str());
 		if (!fs.good()) {
-			// Unable to output the conversion script to file.
-			success = false;
-		} else {
-
-			fs << script.str().c_str();
-			fs.close();
-
-			// Create a dummy command for ease of understanding of the
-			// list of forked processes.
-			// Note that 'sh ' is absolutely essential, or execvp will fail.
-			script_command =
-				"sh " + script_file + " " +
-				OnlyFilename(from_file) + " " + to_format;
+			lyxerr << "Unable to write the conversion script to \""
+			       << script_file_ << '\n'
+			       << "Please check your directory permissions."
+			       << std::endl;
+			return;
 		}
-	}
 
-	string const to_file =
-		ChangeExtension(to_file_base, formats.extension(to_format));
+		fs << script.str();
+		fs.close();
 
-	if (!success) {
-		script_file = string();
-		script_command = 
-			"convert -depth 8 " +
-			from_format + ':' + from_file + ' ' +
-			to_format + ':' + to_file;
-		lyxerr[Debug::GRAPHICS] 
-			<< "\tNo converter defined! I use convert from ImageMagic:\n\t"
-			<< script_command << endl;
-	}	
-
-	// Launch the conversion process.
-	ConvProcessPtr shared_ptr;
-	shared_ptr.reset(new ConvProcess(script_file, script_command,
-					 to_file, on_finish));
-	all_processes_.push_back(shared_ptr);
+		// The command needed to run the conversion process
+		// We create a dummy command for ease of understanding of the
+		// list of forked processes.
+		// Note: 'sh ' is absolutely essential, or execvp will fail.
+		script_command_ = "python " + quoteName(script_file_) + ' ' +
+			quoteName(onlyFilename(from_file)) + ' ' +
+			quoteName(to_format);
+	}
+	// All is ready to go
+	valid_process_ = true;
 }
 
 
-namespace {
+void Converter::Impl::startConversion()
+{
+	if (!valid_process_) {
+		converted(0, 1);
+		return;
+	}
 
-typedef boost::shared_ptr<ConvProcess> ConvProcessPtr;
+	Forkedcall::SignalTypePtr
+		ptr = ForkedCallQueue::get().add(script_command_);
 
-class Find_Ptr {
-public:
-	Find_Ptr(ConvProcess * ptr) : ptr_(ptr) {}
+	ptr->connect(boost::bind(&Impl::converted, this, _1, _2));
 
-	bool operator()(ConvProcessPtr const & ptr)
-	{
-		return ptr.get() == ptr_;
-	}
+}
 
-private:
-	ConvProcess * ptr_;
-};
+void Converter::Impl::converted(pid_t /* pid */, int retval)
+{
+	if (finished_)
+		// We're done already!
+		return;
 
-} // namespace anon
+	finished_ = true;
+	// Clean-up behind ourselves
+	unlink(script_file_);
+
+	if (retval > 0) {
+		unlink(to_file_);
+		to_file_.erase();
+		finishedConversion(false);
+	} else {
+		finishedConversion(true);
+	}
+}
 
+} // namespace graphics
+} // namespace lyx
 
-void GConverter::erase(ConvProcess * process)
-{
-	std::list<ConvProcessPtr>::iterator begin = all_processes_.begin();
-	std::list<ConvProcessPtr>::iterator end   = all_processes_.end();
-	std::list<ConvProcessPtr>::iterator it =
-		std::find_if(begin, end, Find_Ptr(process));
+namespace {
 
-	if (it == end)
-		return;
+string const move_file(string const & from_file, string const & to_file)
+{
+	if (from_file == to_file)
+		return string();
 
-	all_processes_.erase(it);
+	ostringstream command;
+	command << "fromfile = " << from_file << "\n"
+		<< "tofile = "   << to_file << "\n\n"
+		<< "try:\n"
+		<< "  os.rename(fromfile, tofile)\n"
+		<< "except:\n"
+		<< "  import shutil\n"
+		<< "  try:\n"
+		<< "    shutil.copy(fromfile, tofile)\n"
+		<< "  except:\n"
+		<< "    sys.exit(1)\n"
+		<< "  unlinkNoThrow(fromfile)\n";
+
+	return command.str();
 }
 
 
-bool GConverter::build_script(string const & from_file,
-			      string const & to_file_base,
-			      string const & from_format,
-			      string const & to_format,
-			      ostringstream & script) const
+/*
+A typical script looks like:
+
+#!/usr/bin/env python
+import os, sys
+
+def unlinkNoThrow(file):
+  ''' remove a file, do not throw if error occurs '''
+  try:
+    os.unlink(file)
+  except:
+    pass
+
+infile = '/home/username/Figure3a.eps'
+infile_base = '/home/username/Figure3a'
+outfile = '/tmp/lyx_tmpdir12992hUwBqt/gconvert0129929eUBPm.pdf'
+
+if os.system(r'epstopdf ' + '"' + infile + '"' + ' --output ' + '"' + outfile + '"' + '') != 0:
+  unlinkNoThrow(outfile)
+  sys.exit(1)
+
+if not os.path.isfile(outfile):
+  if os.path.isfile(outfile + '.0'):
+    os.rename(outfile + '.0', outfile)
+    import glob
+    for file in glob.glob(outfile + '.?'):
+      unlinkNoThrow(file)
+  else:
+    sys.exit(1)
+
+fromfile = outfile
+tofile = '/tmp/lyx_tmpdir12992hUwBqt/Figure3a129927ByaCl.ppm'
+
+try:
+  os.rename(fromfile, tofile)
+except:
+  import shutil
+  try:
+    shutil.copy(fromfile, tofile)
+  except:
+    sys.exit(1)
+  unlinkNoThrow(fromfile)
+
+*/
+bool build_script(string const & from_file,
+		  string const & to_file_base,
+		  string const & from_format,
+		  string const & to_format,
+		  ostream & script)
 {
-	lyxerr[Debug::GRAPHICS] << "[GraphicsConverter::build_script] ... ";
+	lyxerr[Debug::GRAPHICS] << "build_script ... ";
 	typedef Converters::EdgePath EdgePath;
 
-	string const to_file = ChangeExtension(to_file_base,
-					       formats.extension(to_format));
+	if (from_format.empty())
+		return false;
+
+	// we do not use ChangeExtension because this is a basename
+	// which may nevertheless contain a '.'
+	string const to_file = to_file_base + '.'
+		+ formats.extension(to_format);
 
 	if (from_format == to_format) {
-		script << move_file(QuoteName(from_file), QuoteName(to_file));
+		script << move_file(quoteName(from_file), quoteName(to_file));
 		lyxerr[Debug::GRAPHICS] << "ready (from == to)" << endl;
 		return true;
 	}
@@ -198,9 +360,9 @@ bool GConverter::build_script(string const & from_file,
 	// Create a temporary base file-name for all intermediate steps.
 	// Remember to remove the temp file because we only want the name...
 	static int counter = 0;
-	string const tmp = "gconvert" + tostr(counter++);
-	string const to_base = lyx::tempName(string(), tmp);
-	lyx::unlink(to_base);
+	string const tmp = "gconvert" + convert<string>(counter++);
+	string const to_base = tempName(string(), tmp);
+	unlink(to_base);
 
 	string outfile = from_file;
 
@@ -212,98 +374,59 @@ bool GConverter::build_script(string const & from_file,
 
 	EdgePath::const_iterator it  = edgepath.begin();
 	EdgePath::const_iterator end = edgepath.end();
+
 	for (; it != end; ++it) {
-		Converter const & conv = converters.get(*it);
+		::Converter const & conv = converters.get(*it);
 
 		// Build the conversion command
 		string const infile      = outfile;
-		string const infile_base = ChangeExtension(infile, string());
-		outfile = ChangeExtension(to_base, conv.To->extension());
+		string const infile_base = changeExtension(infile, string());
+		outfile = changeExtension(to_base, conv.To->extension());
 
 		// Store these names in the shell script
-		script << "infile="      << QuoteName(infile) << '\n'
-		       << "infile_base=" << QuoteName(infile_base) << '\n'
-		       << "outfile="     << QuoteName(outfile) << '\n';
+		script << "infile = "      << quoteName(infile) << '\n'
+		       << "infile_base = " << quoteName(infile_base) << '\n'
+		       << "outfile = "     << quoteName(outfile) << '\n';
 
 		string command = conv.command;
-		command = subst(command, token_from, "${infile}");
-		command = subst(command, token_base, "${infile_base}");
-		command = subst(command, token_to,   "${outfile}");
+		command = subst(command, token_from, "' + '\"' + infile + '\"' + '");
+		command = subst(command, token_base, "' + '\"' + infile_base + '\"' + '");
+		command = subst(command, token_to,   "' + '\"' + outfile + '\"' + '");
+		command = libScriptSearch(command);
 
 		// Store in the shell script
-		script << "\n" << command << "\n\n";
+		script << "\nif os.system(r'" << command << "') != 0:\n";
 
 		// Test that this was successful. If not, remove
 		// ${outfile} and exit the shell script
-		script << "if [ $? -ne 0 ]; then\n"
-		       << "\t'rm' -f ${outfile}\n"
-		       << "\texit 1\n"
-		       << "fi\n\n";
+		script << "  unlinkNoThrow(outfile)\n"
+		       << "  sys.exit(1)\n\n";
 
 		// Test that the outfile exists.
 		// ImageMagick's convert will often create ${outfile}.0,
 		// ${outfile}.1.
 		// If this occurs, move ${outfile}.0 to ${outfile}
-		// and delete ${outfile}.?
-		script << "if [ ! -f ${outfile} ]; then\n"
-		       << "\tif [ -f ${outfile}.0 ]; then\n"
-		       << "\t\t'mv' -f ${outfile}.0 ${outfile}\n"
-		       << "\t\t'rm' -f ${outfile}.?\n"
-		       << "\telse\n"
-		       << "\t\texit 1\n"
-		       << "\tfi\n"
-		       << "fi\n\n";
+		// and delete ${outfile}.? (ignore errors)
+		script << "if not os.path.isfile(outfile):\n"
+		       << "  if os.path.isfile(outfile + '.0'):\n"
+		       << "    os.rename(outfile + '.0', outfile)\n"
+			   << "    import glob\n"
+		       << "    for file in glob.glob(outfile + '.?'):\n"
+			   << "      unlinkNoThrow(file)\n"
+		       << "  else:\n"
+		       << "    sys.exit(1)\n\n";
 
 		// Delete the infile, if it isn't the original, from_file.
 		if (infile != from_file) {
-			script << "'rm' -f ${infile}\n\n";
+			script << "unlinkNoThrow(infile)\n\n";
 		}
 	}
 
 	// Move the final outfile to to_file
-	script << move_file("${outfile}", QuoteName(to_file));
+	script << move_file("outfile", quoteName(to_file));
 	lyxerr[Debug::GRAPHICS] << "ready!" << endl;
 
 	return true;
 }
 
-
-ConvProcess::ConvProcess(string const & script_file,
-			 string const & script_command,
-			 string const & to_file, SignalTypePtr on_finish)
-	: script_file_(script_file), to_file_(to_file), on_finish_(on_finish)
-{
-	Forkedcall::SignalTypePtr convert_ptr;
-	convert_ptr.reset(new Forkedcall::SignalType);
-
-	convert_ptr->connect(boost::bind(&ConvProcess::converted, this, _1, _2, _3));
-
-	Forkedcall call;
-	int retval = call.startscript(script_command, convert_ptr);
-	if (retval > 0) {
-		// Unable to even start the script, so clean-up the mess!
-		converted(string(), 0, 1);
-	}
-}
-
-
-void ConvProcess::converted(string const &/* cmd */,
-			    pid_t /* pid */, int retval)
-{
-	// Clean-up behind ourselves
-	lyx::unlink(script_file_);
-
-	if (retval > 0) {
-		lyx::unlink(to_file_);
-		to_file_.erase();
-	}
-
-	if (on_finish_.get()) {
-		on_finish_->operator()(to_file_);
-	}
-
-	grfx::GConverter::get().erase(this);
-}
-
-
-} // namespace grfx
+} // namespace anon