#include "support/convert.h"
#include "support/lstrings.h"
#include "support/lyxlib.h"
+#include "support/os.h"
#include <boost/bind.hpp>
namespace support = lyx::support;
-using support::ChangeExtension;
+using support::addExtension;
+using support::changeExtension;
+using support::FileName;
using support::Forkedcall;
using support::ForkedCallQueue;
-using support::LibFileSearch;
-using support::LibScriptSearch;
-using support::OnlyPath;
-using support::OnlyFilename;
-using support::QuoteName;
+using support::getExtension;
+using support::libScriptSearch;
+using support::onlyPath;
+using support::onlyFilename;
+using support::quoteName;
+using support::quote_python;
using support::subst;
using support::tempName;
using support::unlink;
class Converter::Impl : public boost::signals::trackable {
public:
///
- Impl(string const &, string const &, string const &, string const &);
+ Impl(FileName const &, string const &, string const &, string const &);
///
void startConversion();
///
string script_command_;
///
- string script_file_;
+ FileName script_file_;
///
- string to_file_;
+ FileName to_file_;
///
bool valid_process_;
///
bool Converter::isReachable(string const & from_format_name,
string const & to_format_name)
{
- return converters.isReachable(from_format_name, to_format_name);
+ return theConverters().isReachable(from_format_name, to_format_name);
}
-Converter::Converter(string const & from_file, string const & to_file_base,
+Converter::Converter(FileName 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))
{}
}
-string const & Converter::convertedFile() const
+FileName const & Converter::convertedFile() const
{
- static string const empty;
+ static FileName 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'.
+/** Build the conversion script.
+ * The script is output to the stream \p script.
*/
-bool build_script(string const & from_file, string const & to_file_base,
+static void build_script(FileName 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,
+Converter::Impl::Impl(FileName const & from_file, string const & to_file_base,
string const & from_format, string const & to_format)
: valid_process_(false), finished_(false)
{
// 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);
+ to_file_ = FileName(to_file_base + '.' + formats.extension(to_format));
// The conversion commands are stored in a stringstream
ostringstream script;
- script << "#!/bin/sh\n";
- bool const success = build_script(from_file, to_file_base,
- from_format, to_format, script);
-
- if (!success) {
- script_command_ =
- "sh " +
- QuoteName(LibFileSearch("scripts", "convertDefault.sh")) +
- ' ' +
- QuoteName((from_format.empty() ? "" : from_format + ':') + from_file) +
- ' ' +
- QuoteName(to_format + ':' + to_file_);
+ build_script(from_file, to_file_base, from_format, to_format, script);
+ lyxerr[Debug::GRAPHICS] << "\tConversion script:"
+ << "\n--------------------------------------\n"
+ << script.str()
+ << "\n--------------------------------------\n";
- lyxerr[Debug::GRAPHICS]
- << "\tNo converter defined! I use convertDefault.sh\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" +
- convert<string>(counter++) + ".sh";
-
- std::ofstream fs(script_file_.c_str());
- if (!fs.good()) {
- lyxerr << "Unable to write the conversion script to \""
- << script_file_ << '\n'
- << "Please check your directory permissions."
- << std::endl;
- return;
- }
-
- fs << script.str();
- fs.close();
-
- // 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_ = "sh " + QuoteName(script_file_) + ' ' +
- QuoteName(OnlyFilename(from_file)) + ' ' +
- QuoteName(to_format);
+ // Output the script to file.
+ static int counter = 0;
+ script_file_ = FileName(onlyPath(to_file_base) + "lyxconvert" +
+ convert<string>(counter++) + ".py");
+
+ std::ofstream fs(script_file_.toFilesystemEncoding().c_str());
+ if (!fs.good()) {
+ lyxerr << "Unable to write the conversion script to \""
+ << script_file_ << '\n'
+ << "Please check your directory permissions."
+ << std::endl;
+ return;
}
+
+ fs << script.str();
+ fs.close();
+
+ // The command needed to run the conversion process
+ // We create a dummy command for ease of understanding of the
+ // list of forked processes.
+ // Note: 'python ' is absolutely essential, or execvp will fail.
+ script_command_ = support::os::python() + ' ' +
+ quoteName(script_file_.toFilesystemEncoding()) + ' ' +
+ quoteName(onlyFilename(from_file.toFilesystemEncoding())) + ' ' +
+ quoteName(to_format);
// All is ready to go
valid_process_ = true;
}
}
}
-} // namespace graphics
-} // namespace lyx
-
-namespace {
-string const move_file(string const & from_file, string const & to_file)
+static string const move_file(string const & from_file, string const & to_file)
{
if (from_file == to_file)
return string();
ostringstream command;
- command << "fromfile=" << from_file << "\n"
- << "tofile=" << to_file << "\n\n"
- << "'mv' -f \"${fromfile}\" \"${tofile}\" ||\n"
- << "{\n"
- << "\t'cp' -f \"${fromfile}\" \"${tofile}\" ||\n"
- << "\t{\n"
- << "\t\texit 1\n"
- << "\t}\n"
- << "\t'rm' -f \"${fromfile}\"\n"
- << "}\n";
+ command << "fromfile = " << from_file << "\n"
+ << "tofile = " << to_file << "\n\n"
+ << "try:\n"
+ << " os.rename(fromfile, tofile)\n"
+ << "except:\n"
+ << " try:\n"
+ << " shutil.copy(fromfile, tofile)\n"
+ << " except:\n"
+ << " sys.exit(1)\n"
+ << " unlinkNoThrow(fromfile)\n";
return command.str();
}
-bool build_script(string const & from_file,
+static void build_conversion_command(string const & command, ostream & script)
+{
+ // Store in the python script
+ script << "\nif os.system(r'" << command << "') != 0:\n";
+
+ // Test that this was successful. If not, remove
+ // ${outfile} and exit the python script
+ 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}.? (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
+ script << "unlinkNoThrow(infile)\n\n";
+}
+
+
+static void build_script(FileName const & from_file,
string const & to_file_base,
string const & from_format,
string const & to_format,
ostream & script)
{
+ BOOST_ASSERT(from_format != to_format);
lyxerr[Debug::GRAPHICS] << "build_script ... ";
typedef Converters::EdgePath EdgePath;
- if (from_format.empty())
- return false;
+ script << "#!/usr/bin/env python\n"
+ "# -*- coding: utf-8 -*-\n"
+ "import os, shutil, sys, locale\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"
+ "def utf8ToDefaultEncoding(file):\n"
+ " ''' if possible, convert to the default encoding '''\n"
+ " try:\n"
+ " language, output_encoding = locale.getdefaultlocale()\n"
+ " if output_encoding == None:\n"
+ " output_encoding = 'latin1'\n"
+ " return unicode(file, 'utf8').encode(output_encoding)\n"
+ " except:\n"
+ " return file\n\n";
// 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));
- lyxerr[Debug::GRAPHICS] << "ready (from == to)" << endl;
- return true;
- }
-
- EdgePath edgepath = converters.getPath(from_format, to_format);
-
- if (edgepath.empty()) {
- lyxerr[Debug::GRAPHICS] << "ready (edgepath.empty())" << endl;
- return false;
- }
+ EdgePath const edgepath = from_format.empty() ?
+ EdgePath() :
+ theConverters().getPath(from_format, to_format);
// 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" + convert<string>(counter++);
- string const to_base = tempName(string(), tmp);
+ FileName const to_base(tempName(FileName(), tmp));
unlink(to_base);
- string outfile = from_file;
+ // Create a copy of the file in case the original name contains
+ // problematic characters like ' or ". We can work around that problem
+ // in python, but the converters might be shell scripts and have more
+ // troubles with it.
+ string outfile = addExtension(to_base.absFilename(), getExtension(from_file.absFilename()));
+ script << "infile = utf8ToDefaultEncoding("
+ << quoteName(from_file.absFilename(), quote_python)
+ << ")\n"
+ "outfile = " << quoteName(outfile, quote_python) << "\n"
+ "shutil.copy(infile, outfile)\n";
+
+ // Some converters (e.g. lilypond) can only output files to the
+ // current directory, so we need to change the current directory.
+ // This has the added benefit that all other files that may be
+ // generated by the converter are deleted when LyX closes and do not
+ // clutter the real working directory.
+ script << "os.chdir(" << quoteName(onlyPath(outfile)) << ")\n";
+
+ if (edgepath.empty()) {
+ // Either from_format is unknown or we don't have a
+ // converter path from from_format to to_format, so we use
+ // the default converter.
+ script << "infile = outfile\n"
+ << "outfile = " << quoteName(to_file, quote_python)
+ << '\n';
+
+ ostringstream os;
+ os << support::os::python() << ' '
+ << libScriptSearch("$$s/scripts/convertDefault.py",
+ quote_python) << ' ';
+ if (!from_format.empty())
+ os << from_format << ':';
+ // The extra " quotes around infile and outfile are needed
+ // because the filename may contain spaces and it is used
+ // as argument of os.system().
+ os << "' + '\"' + infile + '\"' + ' "
+ << to_format << ":' + '\"' + outfile + '\"' + '";
+ string const command = os.str();
+
+ lyxerr[Debug::GRAPHICS]
+ << "\tNo converter defined! I use convertDefault.py\n\t"
+ << command << endl;
+
+ build_conversion_command(command, script);
+ }
// The conversion commands may contain these tokens that need to be
// changed to infile, infile_base, outfile respectively.
EdgePath::const_iterator end = edgepath.end();
for (; it != end; ++it) {
- ::Converter const & conv = converters.get(*it);
+ lyx::Converter const & conv = theConverters().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 = addExtension(to_base.absFilename(), 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';
+ // Store these names in the python script
+ script << "infile = " << quoteName(infile, quote_python) << "\n"
+ "infile_base = " << quoteName(infile_base, quote_python) << "\n"
+ "outfile = " << quoteName(outfile, quote_python) << '\n';
+ // See comment about extra " quotes above (although that
+ // applies only for the first loop run here).
string command = conv.command;
- 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";
-
- // Test that this was successful. If not, remove
- // ${outfile} and exit the shell script
- script << "{\n"
- << "\t'rm' -f \"${outfile}\"\n"
- << "\texit 1\n"
- << "}\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";
-
- // Delete the infile, if it isn't the original, from_file.
- if (infile != from_file) {
- script << "'rm' -f \"${infile}\"\n\n";
- }
+ command = subst(command, token_from, "' + '\"' + infile + '\"' + '");
+ command = subst(command, token_base, "' + '\"' + infile_base + '\"' + '");
+ command = subst(command, token_to, "' + '\"' + outfile + '\"' + '");
+ command = libScriptSearch(command, quote_python);
+
+ build_conversion_command(command, script);
}
// Move the final outfile to to_file
- script << move_file("\"${outfile}\"", QuoteName(to_file));
+ script << move_file("outfile", quoteName(to_file, quote_python));
lyxerr[Debug::GRAPHICS] << "ready!" << endl;
-
- return true;
}
-} // namespace anon
+} // namespace graphics
+
+} // namespace lyx