1 /**
2 * \file Exporter.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
5 *
6 * \author unknown
7 * \author Alfredo Braunstein
8 * \author Lars Gullik Bjønnes
9 * \author Jean Marc Lasgouttes
10 * \author Angus Leeming
11 * \author John Levon
12 * \author André Pönitz
13 *
14 * Full author contact details are available in file CREDITS.
15 */
16
17 #include <config.h>
18
19 #include "Exporter.h"
20
21 #include "Mover.h"
22
23 #include "frontends/alert.h"
24
25 #include "support/filetools.h"
26 #include "support/gettext.h"
27 #include "support/lstrings.h"
28 #include "support/Package.h"
29
30 #include <algorithm>
31
32 using namespace std;
33 using namespace lyx::support;
34
35 namespace lyx {
36
37 namespace Alert = frontend::Alert;
38
39 /// Ask the user what to do if a file already exists
checkOverwrite(FileName const & filename)40 static int checkOverwrite(FileName const & filename)
41 {
42 if (!filename.exists())
43 return 1;
44
45 docstring text = bformat(_("The file %1$s already exists.\n\n"
46 "Do you want to overwrite that file?"),
47 makeDisplayPath(filename.absFileName()));
48 return Alert::prompt(_("Overwrite file?"),
49 text, 0, 3,
50 _("&Keep file"), _("&Overwrite"),
51 _("Overwrite &all"), _("&Cancel export"));
52 }
53
54
55 /** copy file \p sourceFile to \p destFile. If \p force is false, the user
56 * will be asked before existing files are overwritten. If \p only_tmp
57 * is true, then only copy files that are in our tmp dir (to avoid other files
58 * overwriting themselves).
59 * \return
60 * - SUCCESS if this file got copied
61 * - FORCE if subsequent calls should not ask for confirmation before
62 * overwriting files anymore.
63 * - CANCEL if the export should be cancelled
64 */
copyFile(string const & format,FileName const & sourceFile,FileName const & destFile,string const & latexFile,bool force,bool only_tmp)65 CopyStatus copyFile(string const & format,
66 FileName const & sourceFile, FileName const & destFile,
67 string const & latexFile, bool force, bool only_tmp)
68 {
69 CopyStatus ret = force ? FORCE : SUCCESS;
70
71 // This check could be changed to
72 // boost::filesystem::equivalent(sourceFile, destFile) if export to
73 // other directories than the document directory is desired.
74 // Also don't overwrite files that already exist and are identical
75 // to the source files.
76 if ((only_tmp && !prefixIs(onlyPath(sourceFile.absFileName()), package().temp_dir().absFileName()))
77 || sourceFile.checksum() == destFile.checksum())
78 return ret;
79
80 if (!force) {
81 switch(checkOverwrite(destFile)) {
82 case 0:
83 return SUCCESS;
84 case 1:
85 ret = SUCCESS;
86 break;
87 case 2:
88 ret = FORCE;
89 break;
90 default:
91 return CANCEL;
92 }
93 }
94
95 Mover const & mover = getMover(format);
96 if (!mover.copy(sourceFile, destFile, latexFile))
97 Alert::error(_("Couldn't copy file"),
98 bformat(_("Copying %1$s to %2$s failed."),
99 makeDisplayPath(sourceFile.absFileName()),
100 makeDisplayPath(destFile.absFileName())));
101
102 return ret;
103 }
104
105
ExportedFile(FileName const & s,string const & e)106 ExportedFile::ExportedFile(FileName const & s, string const & e)
107 : sourceName(s), exportName(e)
108 {}
109
110
operator ==(ExportedFile const & f1,ExportedFile const & f2)111 bool operator==(ExportedFile const & f1, ExportedFile const & f2)
112 {
113 return f1.sourceName == f2.sourceName &&
114 f1.exportName == f2.exportName;
115
116 }
117
118
addExternalFile(string const & format,FileName const & sourceName,string const & exportName)119 void ExportData::addExternalFile(string const & format,
120 FileName const & sourceName,
121 string const & exportName)
122 {
123 // Make sure that we have every file only once, otherwise copyFile()
124 // would ask several times if it should overwrite a file.
125 vector<ExportedFile> & files = externalfiles_[format];
126 ExportedFile file(sourceName, exportName);
127 if (find(files.begin(), files.end(), file) == files.end())
128 files.push_back(file);
129 }
130
131
addExternalFile(string const & format,FileName const & sourceName)132 void ExportData::addExternalFile(string const & format,
133 FileName const & sourceName)
134 {
135 addExternalFile(format, sourceName, onlyFileName(sourceName.absFileName()));
136 }
137
138
139 vector<ExportedFile> const
externalFiles(string const & format) const140 ExportData::externalFiles(string const & format) const
141 {
142 FileMap::const_iterator cit = externalfiles_.find(format);
143 if (cit != externalfiles_.end())
144 return cit->second;
145 return vector<ExportedFile>();
146 }
147
148
149 } // namespace lyx
150