3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * parts Copyright 1985, 1990, 1993 Free Software Foundation, Inc.
8 * \author Ivan Schreter
9 * \author Dirk Niggemann
10 * \author Asger Alstrup
11 * \author Lars Gullik Bjønnes
12 * \author Jean-Marc Lasgouttes
13 * \author Angus Leeming
17 * Full author contact details are available in file CREDITS.
19 * General path-mangling functions
26 #include "support/filetools.h"
28 #include "support/debug.h"
29 #include "support/environment.h"
30 #include "support/gettext.h"
31 #include "support/lstrings.h"
32 #include "support/os.h"
33 #include "support/Messages.h"
34 #include "support/Package.h"
35 #include "support/PathChanger.h"
36 #include "support/Systemcall.h"
37 #include "support/qstring_helpers.h"
40 #include <QTemporaryFile>
42 #include "support/lassert.h"
43 #include "support/regex.h"
74 bool isLyXFileName(string const & filename)
76 return suffixIs(ascii_lowercase(filename), ".lyx");
80 bool isSGMLFileName(string const & filename)
82 return suffixIs(ascii_lowercase(filename), ".sgml");
86 bool isValidLaTeXFileName(string const & filename)
88 string const invalid_chars("#%\"");
89 return filename.find_first_of(invalid_chars) == string::npos;
93 bool isValidDVIFileName(string const & filename)
95 string const invalid_chars("${}()[]^");
96 return filename.find_first_of(invalid_chars) == string::npos;
100 bool isBinaryFile(FileName const & filename)
102 bool isbinary = false;
103 if (filename.empty() || !filename.exists())
107 magic_t magic_cookie = magic_open(MAGIC_MIME_ENCODING);
109 bool detected = true;
110 if (magic_load(magic_cookie, NULL) != 0) {
111 LYXERR(Debug::FILES, "isBinaryFile: "
112 "Could not load magic database - "
113 << magic_error(magic_cookie));
116 char const *charset = magic_file(magic_cookie,
117 filename.toFilesystemEncoding().c_str());
118 isbinary = contains(charset, "binary");
120 magic_close(magic_cookie);
125 // Try by looking for binary chars at the beginning of the file.
126 // Note that this is formally not correct, since count_bin_chars
127 // expects utf8, and the passed string can be anything: plain text
128 // in any encoding, or really binary data. In practice it works,
129 // since QString::fromUtf8() drops invalid utf8 sequences, and
130 // while the exact number may not be correct, we still get a high
131 // number for truly binary files.
133 ifstream ifs(filename.toFilesystemEncoding().c_str());
137 // Maximum strings to read
138 int const max_count = 50;
140 // Maximum number of binary chars allowed
141 int const max_bin = 5;
146 while (count++ < max_count && !ifs.eof()) {
148 binchars += count_bin_chars(str);
150 return binchars > max_bin;
154 string const latex_path(string const & original_path,
155 latex_path_extension extension,
156 latex_path_dots dots)
158 // On cygwin, we may need windows or posix style paths.
159 string path = os::latex_path(original_path);
160 path = subst(path, "~", "\\string~");
161 if (path.find(' ') != string::npos) {
162 // We can't use '"' because " is sometimes active (e.g. if
163 // babel is loaded with the "german" option)
164 if (extension == EXCLUDE_EXTENSION) {
165 // changeExtension calls os::internal_path internally
166 // so don't use it to remove the extension.
167 string const ext = getExtension(path);
168 string const base = ext.empty() ?
170 path.substr(0, path.length() - ext.length() - 1);
171 // changeExtension calls os::internal_path internally
172 // so don't use it to re-add the extension.
173 path = "\\string\"" + base + "\\string\"." + ext;
175 path = "\\string\"" + path + "\\string\"";
179 if (dots != ESCAPE_DOTS)
182 // Replace dots with the lyxdot macro, but only in the file name,
183 // not the directory part.
184 // addName etc call os::internal_path internally
185 // so don't use them for path manipulation
186 // The directory separator is always '/' for LaTeX.
187 string::size_type pos = path.rfind('/');
188 if (pos == string::npos)
189 return subst(path, ".", "\\lyxdot ");
190 return path.substr(0, pos) + subst(path.substr(pos), ".", "\\lyxdot ");
194 // Substitutes spaces with underscores in filename (and path)
195 FileName const makeLatexName(FileName const & file)
197 string name = file.onlyFileName();
198 string const path = file.onlyPath().absFileName() + "/";
200 // ok so we scan through the string twice, but who cares.
201 // FIXME: in Unicode time this will break for sure! There is
202 // a non-latin world out there...
203 string const keep = "abcdefghijklmnopqrstuvwxyz"
204 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
205 "@!'()*+,-./0123456789:;<=>?[]`|";
207 string::size_type pos = 0;
208 while ((pos = name.find_first_not_of(keep, pos)) != string::npos)
211 FileName latex_name(path + name);
212 latex_name.changeExtension(".tex");
217 string const quoteName(string const & name, quote_style style)
221 // This does not work on native Windows for filenames
222 // containing the following characters < > : " / \ | ? *
223 // Moreover, it can't be made to work, as, according to
224 // http://msdn.microsoft.com/en-us/library/aa365247(VS.85).aspx
225 // those are reserved characters, and thus are forbidden.
226 // Please, also note that the command-line parser in
227 // ForkedCall::generateChild cannot deal with filenames
228 // containing " or ', therefore we don't pass user filenames
229 // to child processes if possible. We store them in a python
230 // script instead, where we don't have these limitations.
232 return (os::shell() == os::UNIX) ?
233 '\'' + subst(name, "'", "\'\\\'\'") + '\'' :
236 // According to the QProcess parser, a single double
237 // quote is represented by three consecutive ones.
238 // Here we simply escape the double quote and let our
239 // simple parser in Systemcall.cpp do the substitution.
240 return '"' + subst(name, "\"", "\\\"") + '"';
242 case quote_shell_filename:
243 return quoteName(os::external_path(name), quote_shell);
245 return "\"" + subst(subst(name, "\\", "\\\\"), "\"", "\\\"")
248 // shut up stupid compiler
254 // Uses a string of paths separated by ";"s to find a file to open.
255 // Can't cope with pathnames with a ';' in them. Returns full path to file.
256 // If path entry begins with $$LyX/, use system_lyxdir
257 // If path entry begins with $$User/, use user_lyxdir
258 // Example: "$$User/doc;$$LyX/doc"
259 FileName const fileOpenSearch(string const & path, string const & name,
264 bool notfound = true;
265 string tmppath = split(path, path_element, ';');
267 while (notfound && !path_element.empty()) {
268 path_element = os::internal_path(path_element);
269 if (!suffixIs(path_element, '/'))
271 path_element = subst(path_element, "$$LyX",
272 package().system_support().absFileName());
273 path_element = subst(path_element, "$$User",
274 package().user_support().absFileName());
276 real_file = fileSearch(path_element, name, ext);
278 if (real_file.empty()) {
280 tmppath = split(tmppath, path_element, ';');
281 } while (!tmppath.empty() && path_element.empty());
291 // Returns the real name of file name in directory path, with optional
293 FileName const fileSearch(string const & path, string const & name,
294 string const & exts, search_mode mode)
296 // if `name' is an absolute path, we ignore the setting of `path'
297 // Expand Environmentvariables in 'name'
298 string const tmpname = replaceEnvironmentPath(name);
299 FileName fullname(makeAbsPath(tmpname, path));
300 // search first without extension, then with it.
301 if (fullname.isReadableFile())
305 return mode == may_not_exist ? fullname : FileName();
307 string ext = token(exts, ',', n);
308 while (!ext.empty()) {
309 // Only add the extension if it is not already the extension of
311 bool addext = getExtension(fullname.absFileName()) != ext;
313 if (mode == check_hidpi) {
314 FileName fullname2x = FileName(addExtension(fullname.absFileName() + "@2x", ext));
315 if (fullname2x.isReadableFile())
318 fullname = FileName(addExtension(fullname.absFileName(), ext));
320 if (fullname.isReadableFile() || mode == may_not_exist)
323 fullname.changeExtension("");
324 ext = token(exts, ',', ++n);
330 // Search the file name.ext in the subdirectory dir of
332 // 2) build_lyxdir (if not empty)
334 FileName const libFileSearch(string const & dir, string const & name,
335 string const & ext, search_mode mode)
337 FileName fullname = fileSearch(addPath(package().user_support().absFileName(), dir),
339 if (!fullname.empty())
342 if (!package().build_support().empty())
343 fullname = fileSearch(addPath(package().build_support().absFileName(), dir),
345 if (!fullname.empty())
348 return fileSearch(addPath(package().system_support().absFileName(), dir),
353 FileName const i18nLibFileSearch(string const & dir, string const & name,
356 /* The highest priority value is the `LANGUAGE' environment
357 variable. But we don't use the value if the currently
358 selected locale is the C locale. This is a GNU extension.
360 Otherwise, w use a trick to guess what support/gettext.has done:
361 each po file is able to tell us its name. (JMarc)
364 string lang = getGuiMessages().language();
365 string const language = getEnv("LANGUAGE");
366 if (!lang.empty() && !language.empty())
370 lang = split(lang, l, ':');
373 // First try with the full name
374 tmp = libFileSearch(addPath(dir, l), name, ext);
378 // Then the name without country code
379 string const shortl = token(l, '_', 0);
381 tmp = libFileSearch(addPath(dir, shortl), name, ext);
387 // For compatibility, to be removed later (JMarc)
388 tmp = libFileSearch(dir, token(l, '_', 0) + '_' + name,
391 lyxerr << "i18nLibFileSearch: File `" << tmp
392 << "' has been found by the old method" <<endl;
396 lang = split(lang, l, ':');
399 return libFileSearch(dir, name, ext);
403 FileName const imageLibFileSearch(string & dir, string const & name,
404 string const & ext, search_mode mode)
406 if (!lyx::lyxrc.icon_set.empty()) {
407 string const imagedir = addPath(dir, lyx::lyxrc.icon_set);
408 FileName const fn = libFileSearch(imagedir, name, ext, mode);
414 return libFileSearch(dir, name, ext, mode);
418 string const commandPrep(string const & command_in)
420 static string const token_scriptpath = "$$s/";
421 string const python_call = "python -tt";
423 string command = command_in;
424 if (prefixIs(command_in, python_call))
425 command = os::python() + command_in.substr(python_call.length());
427 // Find the starting position of "$$s/"
428 string::size_type const pos1 = command.find(token_scriptpath);
429 if (pos1 == string::npos)
431 // Find the end of the "$$s/some_subdir/some_script" word within
432 // command. Assumes that the script name does not contain spaces.
433 string::size_type const start_script = pos1 + 4;
434 string::size_type const pos2 = command.find(' ', start_script);
435 string::size_type const size_script = pos2 == string::npos?
436 (command.size() - start_script) : pos2 - start_script;
438 // Does this script file exist?
439 string const script =
440 libFileSearch(".", command.substr(start_script, size_script)).absFileName();
442 if (script.empty()) {
443 // Replace "$$s/" with ""
444 command.erase(pos1, 4);
446 quote_style style = quote_shell;
447 if (prefixIs(command, os::python()))
448 style = quote_python;
450 // Replace "$$s/foo/some_script" with "<path to>/some_script".
451 string::size_type const size_replace = size_script + 4;
452 command.replace(pos1, size_replace, quoteName(script, style));
459 static string createTempFile(QString const & mask)
461 // FIXME: This is not safe. QTemporaryFile creates a file in open(),
462 // but the file is deleted when qt_tmp goes out of scope.
463 // Therefore the next call to createTempFile() may create the
464 // same file again. To make this safe the QTemporaryFile object
465 // needs to be kept for the whole life time of the temp file name.
466 // This could be achieved by creating a class TempDir (like
467 // TempFile, but using a currentlky non-existing
468 // QTemporaryDirectory object).
469 QTemporaryFile qt_tmp(mask + ".XXXXXXXXXXXX");
471 string const temp_file = fromqstr(qt_tmp.fileName());
472 LYXERR(Debug::FILES, "Temporary file `" << temp_file << "' created.");
475 LYXERR(Debug::FILES, "Unable to create temporary file with following template: "
476 << qt_tmp.fileTemplate());
481 static FileName createTmpDir(FileName const & tempdir, string const & mask)
483 LYXERR(Debug::FILES, "createTmpDir: tempdir=`" << tempdir << "'\n"
484 << "createTmpDir: mask=`" << mask << '\'');
486 QFileInfo tmp_fi(QDir(toqstr(tempdir.absFileName())), toqstr(mask));
487 FileName const tmpfl(createTempFile(tmp_fi.absoluteFilePath()));
489 if (tmpfl.empty() || !tmpfl.createDirectory(0700)) {
490 LYXERR0("LyX could not create temporary directory in " << tempdir
499 FileName const createLyXTmpDir(FileName const & deflt)
501 if (deflt.empty() || deflt == package().system_temp_dir())
502 return createTmpDir(package().system_temp_dir(), "lyx_tmpdir");
504 if (deflt.createDirectory(0777))
507 if (deflt.isDirWritable()) {
508 // deflt could not be created because it
509 // did exist already, so let's create our own
511 return createTmpDir(deflt, "lyx_tmpdir");
513 // some other error occurred.
514 return createTmpDir(package().system_temp_dir(), "lyx_tmpdir");
519 // Strip filename from path name
520 string const onlyPath(string const & filename)
522 // If empty filename, return empty
523 if (filename.empty())
526 // Find last / or start of filename
527 size_t j = filename.rfind('/');
528 return j == string::npos ? "./" : filename.substr(0, j + 1);
532 // Convert relative path into absolute path based on a basepath.
533 // If relpath is absolute, just use that.
534 // If basepath is empty, use CWD as base.
535 // Note that basePath can be a relative path, in the sense that it may
536 // not begin with "/" (e.g.), but it should NOT contain such constructs
538 // FIXME It might be nice if the code didn't simply assume that.
539 FileName const makeAbsPath(string const & relPath, string const & basePath)
541 // checks for already absolute path
542 if (FileName::isAbsolute(relPath))
543 return FileName(relPath);
545 // Copies given paths
546 string tempRel = os::internal_path(relPath);
547 // Since TempRel is NOT absolute, we can safely replace "//" with "/"
548 tempRel = subst(tempRel, "//", "/");
552 if (FileName::isAbsolute(basePath))
555 tempBase = addPath(FileName::getcwd().absFileName(), basePath);
557 // Handle /./ at the end of the path
558 while (suffixIs(tempBase, "/./"))
559 tempBase.erase(tempBase.length() - 2);
561 // processes relative path
562 string rTemp = tempRel;
565 // Check for a leading "~"
567 rTemp = split(rTemp, temp, '/');
569 tempBase = Package::get_home_dir().absFileName();
574 while (!rTemp.empty()) {
576 rTemp = split(rTemp, temp, '/');
578 if (temp == ".") continue;
580 // Remove one level of TempBase
581 if (tempBase.length() <= 1) {
582 //this is supposed to be an absolute path, so...
586 //erase a trailing slash if there is one
587 if (suffixIs(tempBase, "/"))
588 tempBase.erase(tempBase.length() - 1, string::npos);
590 string::size_type i = tempBase.length() - 1;
591 while (i > 0 && tempBase[i] != '/')
594 tempBase.erase(i, string::npos);
597 } else if (temp.empty() && !rTemp.empty()) {
598 tempBase = os::current_root() + rTemp;
601 // Add this piece to TempBase
602 if (!suffixIs(tempBase, '/'))
608 // returns absolute path
609 return FileName(tempBase);
613 // Correctly append filename to the pathname.
614 // If pathname is '.', then don't use pathname.
615 // Chops any path of filename.
616 string const addName(string const & path, string const & fname)
618 string const basename = onlyFileName(fname);
621 if (path != "." && path != "./" && !path.empty()) {
622 buf = os::internal_path(path);
623 if (!suffixIs(path, '/'))
627 return buf + basename;
631 // Strips path from filename
632 string const onlyFileName(string const & fname)
637 string::size_type j = fname.rfind('/');
638 if (j == string::npos) // no '/' in fname
642 return fname.substr(j + 1);
646 // Create absolute path. If impossible, don't do anything
647 // Supports ./ and ~/. Later we can add support for ~logname/. (Asger)
648 string const expandPath(string const & path)
650 // checks for already absolute path
651 string rTemp = replaceEnvironmentPath(path);
652 if (FileName::isAbsolute(rTemp))
656 string const copy = rTemp;
659 rTemp = split(rTemp, temp, '/');
662 return FileName::getcwd().absFileName() + '/' + rTemp;
665 return Package::get_home_dir().absFileName() + '/' + rTemp;
668 return makeAbsPath(copy).absFileName();
670 // Don't know how to handle this
675 // Search the string for ${VAR} and $VAR and replace VAR using getenv.
676 string const replaceEnvironmentPath(string const & path)
678 // ${VAR} is defined as
679 // $\{[A-Za-z_][A-Za-z_0-9]*\}
680 static string const envvar_br = "[$]\\{([A-Za-z_][A-Za-z_0-9]*)\\}";
682 // $VAR is defined as:
683 // $[A-Za-z_][A-Za-z_0-9]*
684 static string const envvar = "[$]([A-Za-z_][A-Za-z_0-9]*)";
686 static regex const envvar_br_re("(.*)" + envvar_br + "(.*)");
687 static regex const envvar_re("(.*)" + envvar + "(.*)");
688 string result = path;
691 if (!regex_match(result, what, envvar_br_re)) {
692 if (!regex_match(result, what, envvar_re))
695 string env_var = getEnv(what.str(2));
696 result = what.str(1) + env_var + what.str(3);
702 // Return a command prefix for setting the environment of the TeX engine.
703 string latexEnvCmdPrefix(string const & path)
705 if (path.empty() || lyxrc.texinputs_prefix.empty())
708 string const texinputs_prefix = os::latex_path_list(
709 replaceCurdirPath(path, lyxrc.texinputs_prefix));
710 string const sep = string(1, os::path_separator(os::TEXENGINE));
711 string const texinputs = getEnv("TEXINPUTS");
713 if (os::shell() == os::UNIX)
714 return "env TEXINPUTS=\"." + sep + texinputs_prefix
715 + sep + texinputs + "\" ";
717 // NOTE: the dummy blank dir is necessary to force the
718 // QProcess parser to quote the argument (see bug 9453)
719 return "cmd /d /c set \"TEXINPUTS=." + sep + " "
720 + sep + texinputs_prefix
721 + sep + texinputs + "\" & ";
725 // Replace current directory in all elements of a path list with a given path.
726 string const replaceCurdirPath(string const & path, string const & pathlist)
728 string const oldpathlist = replaceEnvironmentPath(pathlist);
729 char const sep = os::path_separator();
732 for (size_t i = 0, k = 0; i != string::npos; k = i) {
733 i = oldpathlist.find(sep, i);
734 string p = oldpathlist.substr(k, i - k);
735 if (FileName::isAbsolute(p)) {
741 } else if (prefixIs(p, "./")) {
743 while (p[offset] == '/')
746 newpathlist += addPath(path, p.substr(offset));
747 if (suffixIs(p, "//"))
750 if (i != string::npos) {
752 // Stop here if the last element is empty
753 if (++i == oldpathlist.length())
761 // Make relative path out of two absolute paths
762 docstring const makeRelPath(docstring const & abspath, docstring const & basepath)
763 // Makes relative path out of absolute path. If it is deeper than basepath,
764 // it's easy. If basepath and abspath share something (they are all deeper
765 // than some directory), it'll be rendered using ..'s. If they are completely
766 // different, then the absolute path will be used as relative path.
768 docstring::size_type const abslen = abspath.length();
769 docstring::size_type const baselen = basepath.length();
771 docstring::size_type i = os::common_path(abspath, basepath);
774 // actually no match - cannot make it relative
778 // Count how many dirs there are in basepath above match
779 // and append as many '..''s into relpath
781 docstring::size_type j = i;
782 while (j < baselen) {
783 if (basepath[j] == '/') {
784 if (j + 1 == baselen)
791 // Append relative stuff from common directory to abspath
792 if (abspath[i] == '/')
794 for (; i < abslen; ++i)
797 if (suffixIs(buf, '/'))
798 buf.erase(buf.length() - 1);
799 // Substitute empty with .
806 // Append sub-directory(ies) to a path in an intelligent way
807 string const addPath(string const & path, string const & path_2)
810 string const path2 = os::internal_path(path_2);
812 if (!path.empty() && path != "." && path != "./") {
813 buf = os::internal_path(path);
814 if (path[path.length() - 1] != '/')
818 if (!path2.empty()) {
819 string::size_type const p2start = path2.find_first_not_of('/');
820 string::size_type const p2end = path2.find_last_not_of('/');
821 string const tmp = path2.substr(p2start, p2end - p2start + 1);
828 string const changeExtension(string const & oldname, string const & extension)
830 string::size_type const last_slash = oldname.rfind('/');
831 string::size_type last_dot = oldname.rfind('.');
832 if (last_dot < last_slash && last_slash != string::npos)
833 last_dot = string::npos;
836 // Make sure the extension starts with a dot
837 if (!extension.empty() && extension[0] != '.')
838 ext= '.' + extension;
842 return os::internal_path(oldname.substr(0, last_dot) + ext);
846 string const removeExtension(string const & name)
848 return changeExtension(name, string());
852 string const addExtension(string const & name, string const & extension)
854 if (!extension.empty() && extension[0] != '.')
855 return name + '.' + extension;
856 return name + extension;
860 /// Return the extension of the file (not including the .)
861 string const getExtension(string const & name)
863 string::size_type const last_slash = name.rfind('/');
864 string::size_type const last_dot = name.rfind('.');
865 if (last_dot != string::npos &&
866 (last_slash == string::npos || last_dot > last_slash))
867 return name.substr(last_dot + 1,
868 name.length() - (last_dot + 1));
874 string const unzippedFileName(string const & zipped_file)
876 string const ext = getExtension(zipped_file);
877 if (ext == "gz" || ext == "z" || ext == "Z")
878 return changeExtension(zipped_file, string());
879 else if (ext == "svgz")
880 return changeExtension(zipped_file, "svg");
881 return onlyPath(zipped_file) + "unzipped_" + onlyFileName(zipped_file);
885 FileName const unzipFile(FileName const & zipped_file, string const & unzipped_file)
887 FileName const tempfile = FileName(unzipped_file.empty() ?
888 unzippedFileName(zipped_file.toFilesystemEncoding()) :
891 string const command = "gunzip -c " +
892 zipped_file.toFilesystemEncoding() + " > " +
893 tempfile.toFilesystemEncoding();
895 one.startscript(Systemcall::Wait, command);
896 // test that command was executed successfully (anon)
897 // yes, please do. (Lgb)
902 docstring const makeDisplayPath(string const & path, unsigned int threshold)
906 // If file is from LyXDir, display it as if it were relative.
907 string const system = package().system_support().absFileName();
908 if (prefixIs(str, system) && str != system)
909 return from_utf8("[" + str.erase(0, system.length()) + "]");
911 // replace /home/blah with ~/
912 string const home = Package::get_home_dir().absFileName();
913 if (!home.empty() && prefixIs(str, home))
914 str = subst(str, home, "~");
916 if (str.length() <= threshold)
917 return from_utf8(os::external_path(str));
919 string const prefix = ".../";
920 docstring dstr = from_utf8(str);
923 while (dstr.length() > threshold)
924 dstr = split(dstr, temp, '/');
926 // Did we shorten everything away?
928 // Yes, filename itself is too long.
929 // Pick the start and the end of the filename.
930 dstr = from_utf8(onlyFileName(path));
931 docstring const head = dstr.substr(0, threshold / 2 - 3);
933 docstring::size_type len = dstr.length();
934 docstring const tail =
935 dstr.substr(len - threshold / 2 - 2, len - 1);
936 dstr = head + from_ascii("...") + tail;
939 return from_utf8(os::external_path(prefix + to_utf8(dstr)));
944 bool readLink(FileName const & file, FileName & link)
946 string const encoded = file.toFilesystemEncoding();
947 #ifdef HAVE_DEF_PATH_MAX
948 char linkbuffer[PATH_MAX + 1];
949 ssize_t const nRead = ::readlink(encoded.c_str(),
950 linkbuffer, sizeof(linkbuffer) - 1);
953 linkbuffer[nRead] = '\0'; // terminator
955 vector<char> buf(1024);
959 nRead = ::readlink(encoded.c_str(), &buf[0], buf.size() - 1);
963 if (static_cast<size_t>(nRead) < buf.size() - 1) {
966 buf.resize(buf.size() * 2);
968 buf[nRead] = '\0'; // terminator
969 const char * linkbuffer = &buf[0];
971 link = makeAbsPath(linkbuffer, onlyPath(file.absFileName()));
975 bool readLink(FileName const &, FileName &)
982 cmd_ret const runCommand(string const & cmd)
984 // FIXME: replace all calls to RunCommand with ForkedCall
985 // (if the output is not needed) or the code in ISpell.cpp
986 // (if the output is needed).
988 // One question is if we should use popen or
989 // create our own popen based on fork, exec, pipe
990 // of course the best would be to have a
991 // pstream (process stream), with the
992 // variants ipstream, opstream
997 PROCESS_INFORMATION process;
998 SECURITY_ATTRIBUTES security;
1001 bool err2out = false;
1003 string const infile = trim(split(cmd, command, '<'), " \"");
1004 command = rtrim(command);
1005 if (suffixIs(command, "2>&1")) {
1006 command = rtrim(command, "2>&1");
1009 string const cmdarg = "/d /c " + command;
1010 string const comspec = getEnv("COMSPEC");
1012 security.nLength = sizeof(SECURITY_ATTRIBUTES);
1013 security.bInheritHandle = TRUE;
1014 security.lpSecurityDescriptor = NULL;
1016 if (CreatePipe(&in, &out, &security, 0)) {
1017 memset(&startup, 0, sizeof(STARTUPINFO));
1018 memset(&process, 0, sizeof(PROCESS_INFORMATION));
1020 startup.cb = sizeof(STARTUPINFO);
1021 startup.dwFlags = STARTF_USESTDHANDLES;
1023 startup.hStdError = err2out ? out : GetStdHandle(STD_ERROR_HANDLE);
1024 startup.hStdInput = infile.empty()
1025 ? GetStdHandle(STD_INPUT_HANDLE)
1026 : CreateFile(infile.c_str(), GENERIC_READ,
1027 FILE_SHARE_READ, &security, OPEN_EXISTING,
1028 FILE_ATTRIBUTE_NORMAL, NULL);
1029 startup.hStdOutput = out;
1031 if (startup.hStdInput != INVALID_HANDLE_VALUE &&
1032 CreateProcess(comspec.c_str(), (LPTSTR)cmdarg.c_str(),
1033 &security, &security, TRUE, CREATE_NO_WINDOW,
1034 0, 0, &startup, &process)) {
1036 CloseHandle(process.hThread);
1037 fno = _open_osfhandle((long)in, _O_RDONLY);
1039 inf = _fdopen(fno, "r");
1042 #elif defined (HAVE_POPEN)
1043 FILE * inf = ::popen(cmd.c_str(), os::popen_read_mode());
1044 #elif defined (HAVE__POPEN)
1045 FILE * inf = ::_popen(cmd.c_str(), os::popen_read_mode());
1047 #error No popen() function.
1050 // (Claus Hentschel) Check if popen was successful ;-)
1052 lyxerr << "RunCommand:: could not start child process" << endl;
1053 return make_pair(-1, string());
1059 ret += static_cast<char>(c);
1063 #if defined (_WIN32)
1064 WaitForSingleObject(process.hProcess, INFINITE);
1065 if (!infile.empty())
1066 CloseHandle(startup.hStdInput);
1067 CloseHandle(process.hProcess);
1068 int const pret = fclose(inf);
1069 #elif defined (HAVE_PCLOSE)
1070 int const pret = pclose(inf);
1071 #elif defined (HAVE__PCLOSE)
1072 int const pret = _pclose(inf);
1074 #error No pclose() function.
1078 perror("RunCommand:: could not terminate child process");
1080 return make_pair(pret, ret);
1084 FileName const findtexfile(string const & fil, string const & /*format*/)
1086 /* There is no problem to extend this function too use other
1087 methods to look for files. It could be setup to look
1088 in environment paths and also if wanted as a last resort
1089 to a recursive find. One of the easier extensions would
1090 perhaps be to use the LyX file lookup methods. But! I am
1091 going to implement this until I see some demand for it.
1095 // If the file can be found directly, we just return a
1096 // absolute path version of it.
1097 FileName const absfile(makeAbsPath(fil));
1098 if (absfile.exists())
1101 // Now we try to find it using kpsewhich.
1102 // It seems from the kpsewhich manual page that it is safe to use
1103 // kpsewhich without --format: "When the --format option is not
1104 // given, the search path used when looking for a file is inferred
1105 // from the name given, by looking for a known extension. If no
1106 // known extension is found, the search path for TeX source files
1108 // However, we want to take advantage of the format sine almost all
1109 // the different formats has environment variables that can be used
1110 // to controll which paths to search. f.ex. bib looks in
1111 // BIBINPUTS and TEXBIB. Small list follows:
1112 // bib - BIBINPUTS, TEXBIB
1114 // graphic/figure - TEXPICTS, TEXINPUTS
1115 // ist - TEXINDEXSTYLE, INDEXSTYLE
1116 // pk - PROGRAMFONTS, PKFONTS, TEXPKS, GLYPHFONTS, TEXFONTS
1118 // tfm - TFMFONTS, TEXFONTS
1119 // This means that to use kpsewhich in the best possible way we
1120 // should help it by setting additional path in the approp. envir.var.
1121 string const kpsecmd = "kpsewhich " + fil;
1123 cmd_ret const c = runCommand(kpsecmd);
1125 LYXERR(Debug::LATEX, "kpse status = " << c.first << '\n'
1126 << "kpse result = `" << rtrim(c.second, "\n\r") << '\'');
1128 return FileName(rtrim(to_utf8(from_filesystem8bit(c.second)), "\n\r"));
1134 int compare_timestamps(FileName const & file1, FileName const & file2)
1136 // If the original is newer than the copy, then copy the original
1137 // to the new directory.
1140 if (file1.exists() && file2.exists()) {
1141 double const tmp = difftime(file1.lastModified(), file2.lastModified());
1143 cmp = tmp > 0 ? 1 : -1;
1145 } else if (file1.exists()) {
1147 } else if (file2.exists()) {
1155 bool prefs2prefs(FileName const & filename, FileName const & tempfile, bool lfuns)
1157 FileName const script = libFileSearch("scripts", "prefs2prefs.py");
1158 if (script.empty()) {
1159 LYXERR0("Could not find bind file conversion "
1160 "script prefs2prefs.py.");
1164 ostringstream command;
1165 command << os::python() << ' ' << quoteName(script.toFilesystemEncoding())
1166 << ' ' << (lfuns ? "-l" : "-p") << ' '
1167 << quoteName(filename.toFilesystemEncoding())
1168 << ' ' << quoteName(tempfile.toFilesystemEncoding());
1169 string const command_str = command.str();
1171 LYXERR(Debug::FILES, "Running `" << command_str << '\'');
1173 cmd_ret const ret = runCommand(command_str);
1174 if (ret.first != 0) {
1175 LYXERR0("Could not run file conversion script prefs2prefs.py.");
1182 bool configFileNeedsUpdate(string const & file)
1184 // We cannot initialize configure_script directly because the package
1185 // is not initialized yet when static objects are constructed.
1186 static FileName configure_script;
1187 static bool firstrun = true;
1190 FileName(addName(package().system_support().absFileName(),
1196 FileName(addName(package().user_support().absFileName(), file));
1197 return !absfile.exists()
1198 || configure_script.lastModified() > absfile.lastModified();
1202 int fileLock(const char * lock_file)
1205 #if defined(HAVE_LOCKF)
1206 fd = open(lock_file, O_CREAT|O_APPEND|O_SYNC|O_RDWR, 0666);
1207 if (lockf(fd, F_LOCK, 0) != 0) {
1215 void fileUnlock(int fd, const char * /* lock_file*/)
1217 #if defined(HAVE_LOCKF)
1219 if (lockf(fd, F_ULOCK, 0))
1220 LYXERR0("Can't unlock the file.");
1226 } //namespace support