3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
7 * \author Alfredo Braunstein
8 * \author Lars Gullik Bjønnes
9 * \author Jean Marc Lasgouttes
10 * \author Angus Leeming
12 * \author André Pönitz
14 * Full author contact details are available in file CREDITS.
22 #include "buffer_funcs.h"
23 #include "BufferParams.h"
24 #include "Converter.h"
29 #include "output_plaintext.h"
30 #include "OutputParams.h"
31 #include "frontends/alert.h"
33 #include "support/filetools.h"
34 #include "support/lyxlib.h"
35 #include "support/Package.h"
37 #include <boost/filesystem/operations.hpp>
46 using support::addName;
47 using support::bformat;
48 using support::changeExtension;
49 using support::contains;
50 using support::FileName;
51 using support::makeAbsPath;
52 using support::makeDisplayPath;
53 using support::onlyFilename;
54 using support::onlyPath;
55 using support::package;
56 using support::prefixIs;
58 namespace Alert = frontend::Alert;
59 namespace fs = boost::filesystem;
63 vector<string> const Backends(Buffer const & buffer)
66 if (buffer.params().getTextClass().isTeXClassAvailable()) {
67 v.push_back(bufferFormat(buffer));
68 // FIXME: Don't hardcode format names here, but use a flag
69 if (v.back() == "latex")
70 v.push_back("pdflatex");
78 /// ask the user what to do if a file already exists
79 int checkOverwrite(FileName const & filename)
81 if (fs::exists(filename.toFilesystemEncoding())) {
82 docstring text = bformat(_("The file %1$s already exists.\n\n"
83 "Do you want to overwrite that file?"),
84 makeDisplayPath(filename.absFilename()));
85 return Alert::prompt(_("Overwrite file?"),
87 _("&Overwrite"), _("Overwrite &all"),
101 /** copy file \p sourceFile to \p destFile. If \p force is false, the user
102 * will be asked before existing files are overwritten.
104 * - SUCCESS if this file got copied
105 * - FORCE if subsequent calls should not ask for confirmation before
106 * overwriting files anymore.
107 * - CANCEL if the export should be cancelled
109 CopyStatus copyFile(string const & format,
110 FileName const & sourceFile, FileName const & destFile,
111 string const & latexFile, bool force)
113 CopyStatus ret = force ? FORCE : SUCCESS;
115 // Only copy files that are in our tmp dir, all other files would
116 // overwrite themselves. This check could be changed to
117 // boost::filesystem::equivalent(sourceFile, destFile) if export to
118 // other directories than the document directory is desired.
119 if (!prefixIs(onlyPath(sourceFile.absFilename()), package().temp_dir().absFilename()))
123 switch(checkOverwrite(destFile)) {
135 Mover const & mover = getMover(format);
136 if (!mover.copy(sourceFile, destFile, latexFile))
137 Alert::error(_("Couldn't copy file"),
138 bformat(_("Copying %1$s to %2$s failed."),
139 makeDisplayPath(sourceFile.absFilename()),
140 makeDisplayPath(destFile.absFilename())));
148 bool Exporter::Export(Buffer * buffer, string const & format,
149 bool put_in_tempdir, string & result_file)
151 string backend_format;
152 OutputParams runparams(&buffer->params().encoding());
153 runparams.flavor = OutputParams::LATEX;
154 runparams.linelen = lyxrc.plaintext_linelen;
155 vector<string> backends = Backends(*buffer);
156 if (find(backends.begin(), backends.end(), format) == backends.end()) {
157 // Get shortest path to format
158 Graph::EdgePath path;
159 for (vector<string>::const_iterator it = backends.begin();
160 it != backends.end(); ++it) {
161 Graph::EdgePath p = theConverters().getPath(*it, format);
162 if (!p.empty() && (path.empty() || p.size() < path.size())) {
163 backend_format = *it;
168 runparams.flavor = theConverters().getFlavor(path);
170 Alert::error(_("Couldn't export file"),
171 bformat(_("No information for exporting the format %1$s."),
172 formats.prettyName(format)));
176 backend_format = format;
177 // FIXME: Don't hardcode format names here, but use a flag
178 if (backend_format == "pdflatex")
179 runparams.flavor = OutputParams::PDFLATEX;
182 string filename = buffer->getLatexName(false);
183 filename = addName(buffer->temppath(), filename);
184 filename = changeExtension(filename,
185 formats.extension(backend_format));
187 // Plain text backend
188 if (backend_format == "text")
189 writePlaintextFile(*buffer, FileName(filename), runparams);
191 else if (backend_format == "lyx")
192 buffer->writeFile(FileName(filename));
194 else if (buffer->isDocBook()) {
195 runparams.nice = !put_in_tempdir;
196 buffer->makeDocBookFile(FileName(filename), runparams);
199 else if (backend_format == format) {
200 runparams.nice = true;
201 if (!buffer->makeLaTeXFile(FileName(filename), string(), runparams))
203 } else if (!lyxrc.tex_allows_spaces
204 && contains(buffer->filePath(), ' ')) {
205 Alert::error(_("File name error"),
206 _("The directory path to the document cannot contain spaces."));
209 runparams.nice = false;
210 if (!buffer->makeLaTeXFile(FileName(filename), buffer->filePath(), runparams))
214 string const error_type = (format == "program")? "Build" : bufferFormat(*buffer);
215 string const ext = formats.extension(format);
216 FileName const tmp_result_file(changeExtension(filename, ext));
217 bool const success = theConverters().convert(buffer, FileName(filename),
218 tmp_result_file, FileName(buffer->fileName()), backend_format, format,
219 buffer->errorList(error_type));
220 // Emit the signal to show the error list.
221 if (format != backend_format)
222 buffer->errors(error_type);
227 result_file = tmp_result_file.absFilename();
229 result_file = changeExtension(buffer->fileName(), ext);
230 // We need to copy referenced files (e. g. included graphics
231 // if format == "dvi") to the result dir.
232 vector<ExportedFile> const files =
233 runparams.exportdata->externalFiles(format);
234 string const dest = onlyPath(result_file);
235 CopyStatus status = SUCCESS;
236 for (vector<ExportedFile>::const_iterator it = files.begin();
237 it != files.end() && status != CANCEL; ++it) {
239 formats.getFormatFromFile(it->sourceName);
240 status = copyFile(fmt, it->sourceName,
241 makeAbsPath(it->exportName, dest),
242 it->exportName, status == FORCE);
244 if (status == CANCEL) {
245 buffer->message(_("Document export cancelled."));
246 } else if (fs::exists(tmp_result_file.toFilesystemEncoding())) {
247 // Finally copy the main file
248 status = copyFile(format, tmp_result_file,
249 FileName(result_file), result_file,
251 buffer->message(bformat(_("Document exported as %1$s "
253 formats.prettyName(format),
254 makeDisplayPath(result_file)));
256 // This must be a dummy converter like fax (bug 1888)
257 buffer->message(bformat(_("Document exported as %1$s"),
258 formats.prettyName(format)));
266 bool Exporter::Export(Buffer * buffer, string const & format,
270 return Export(buffer, format, put_in_tempdir, result_file);
274 bool Exporter::preview(Buffer * buffer, string const & format)
277 if (!Export(buffer, format, true, result_file))
279 return formats.view(*buffer, FileName(result_file), format);
283 bool Exporter::isExportable(Buffer const & buffer, string const & format)
285 vector<string> backends = Backends(buffer);
286 for (vector<string>::const_iterator it = backends.begin();
287 it != backends.end(); ++it)
288 if (theConverters().isReachable(*it, format))
294 vector<Format const *> const
295 Exporter::getExportableFormats(Buffer const & buffer, bool only_viewable)
297 vector<string> backends = Backends(buffer);
298 vector<Format const *> result =
299 theConverters().getReachable(backends[0], only_viewable, true);
300 for (vector<string>::const_iterator it = backends.begin() + 1;
301 it != backends.end(); ++it) {
302 vector<Format const *> r =
303 theConverters().getReachable(*it, only_viewable, false);
304 result.insert(result.end(), r.begin(), r.end());
310 ExportedFile::ExportedFile(FileName const & s, string const & e) :
311 sourceName(s), exportName(e) {}
314 bool operator==(ExportedFile const & f1, ExportedFile const & f2)
316 return f1.sourceName == f2.sourceName &&
317 f1.exportName == f2.exportName;
322 void ExportData::addExternalFile(string const & format,
323 FileName const & sourceName,
324 string const & exportName)
326 // Make sure that we have every file only once, otherwise copyFile()
327 // would ask several times if it should overwrite a file.
328 vector<ExportedFile> & files = externalfiles[format];
329 ExportedFile file(sourceName, exportName);
330 if (find(files.begin(), files.end(), file) == files.end())
331 files.push_back(file);
335 void ExportData::addExternalFile(string const & format,
336 FileName const & sourceName)
338 addExternalFile(format, sourceName, onlyFilename(sourceName.absFilename()));
342 vector<ExportedFile> const
343 ExportData::externalFiles(string const & format) const
345 FileMap::const_iterator cit = externalfiles.find(format);
346 if (cit != externalfiles.end())
348 return vector<ExportedFile>();