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"
71 bool isLyXFileName(string const & filename)
73 return suffixIs(ascii_lowercase(filename), ".lyx");
77 bool isSGMLFileName(string const & filename)
79 return suffixIs(ascii_lowercase(filename), ".sgml");
83 bool isValidLaTeXFileName(string const & filename)
85 string const invalid_chars("#%\"");
86 return filename.find_first_of(invalid_chars) == string::npos;
90 bool isValidDVIFileName(string const & filename)
92 string const invalid_chars("${}()[]^");
93 return filename.find_first_of(invalid_chars) == string::npos;
97 bool isBinaryFile(FileName const & filename)
99 bool isbinary = false;
100 if (filename.empty() || !filename.exists())
104 magic_t magic_cookie = magic_open(MAGIC_MIME_ENCODING);
106 bool detected = true;
107 if (magic_load(magic_cookie, NULL) != 0) {
108 LYXERR(Debug::FILES, "isBinaryFile: "
109 "Could not load magic database - "
110 << magic_error(magic_cookie));
113 char const *charset = magic_file(magic_cookie,
114 filename.toFilesystemEncoding().c_str());
115 isbinary = contains(charset, "binary");
117 magic_close(magic_cookie);
122 // Try by looking for binary chars at the beginning of the file.
123 // Note that this is formally not correct, since count_bin_chars
124 // expects utf8, and the passed string can be anything: plain text
125 // in any encoding, or really binary data. In practice it works,
126 // since QString::fromUtf8() drops invalid utf8 sequences, and
127 // while the exact number may not be correct, we still get a high
128 // number for truly binary files.
130 ifstream ifs(filename.toFilesystemEncoding().c_str());
134 // Maximum strings to read
135 int const max_count = 50;
137 // Maximum number of binary chars allowed
138 int const max_bin = 5;
143 while (count++ < max_count && !ifs.eof()) {
145 binchars += count_bin_chars(str);
147 return binchars > max_bin;
151 string const latex_path(string const & original_path,
152 latex_path_extension extension,
153 latex_path_dots dots)
155 // On cygwin, we may need windows or posix style paths.
156 string path = os::latex_path(original_path);
157 path = subst(path, "~", "\\string~");
158 if (path.find(' ') != string::npos) {
159 // We can't use '"' because " is sometimes active (e.g. if
160 // babel is loaded with the "german" option)
161 if (extension == EXCLUDE_EXTENSION) {
162 // changeExtension calls os::internal_path internally
163 // so don't use it to remove the extension.
164 string const ext = getExtension(path);
165 string const base = ext.empty() ?
167 path.substr(0, path.length() - ext.length() - 1);
168 // changeExtension calls os::internal_path internally
169 // so don't use it to re-add the extension.
170 path = "\\string\"" + base + "\\string\"." + ext;
172 path = "\\string\"" + path + "\\string\"";
176 if (dots != ESCAPE_DOTS)
179 // Replace dots with the lyxdot macro, but only in the file name,
180 // not the directory part.
181 // addName etc call os::internal_path internally
182 // so don't use them for path manipulation
183 // The directory separator is always '/' for LaTeX.
184 string::size_type pos = path.rfind('/');
185 if (pos == string::npos)
186 return subst(path, ".", "\\lyxdot ");
187 return path.substr(0, pos) + subst(path.substr(pos), ".", "\\lyxdot ");
191 // Substitutes spaces with underscores in filename (and path)
192 FileName const makeLatexName(FileName const & file)
194 string name = file.onlyFileName();
195 string const path = file.onlyPath().absFileName() + "/";
197 // ok so we scan through the string twice, but who cares.
198 // FIXME: in Unicode time this will break for sure! There is
199 // a non-latin world out there...
200 string const keep = "abcdefghijklmnopqrstuvwxyz"
201 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
202 "@!'()*+,-./0123456789:;<=>?[]`|";
204 string::size_type pos = 0;
205 while ((pos = name.find_first_not_of(keep, pos)) != string::npos)
208 FileName latex_name(path + name);
209 latex_name.changeExtension(".tex");
214 string const quoteName(string const & name, quote_style style)
218 // This does not work on native Windows for filenames
219 // containing the following characters < > : " / \ | ? *
220 // Moreover, it can't be made to work, as, according to
221 // http://msdn.microsoft.com/en-us/library/aa365247(VS.85).aspx
222 // those are reserved characters, and thus are forbidden.
223 // Please, also note that the command-line parser in
224 // ForkedCall::generateChild cannot deal with filenames
225 // containing " or ', therefore we don't pass user filenames
226 // to child processes if possible. We store them in a python
227 // script instead, where we don't have these limitations.
229 return (os::shell() == os::UNIX) ?
230 '\'' + subst(name, "'", "\'\\\'\'") + '\'' :
233 // According to the QProcess parser, a single double
234 // quote is represented by three consecutive ones.
235 // Here we simply escape the double quote and let our
236 // simple parser in Systemcall.cpp do the substitution.
237 return '"' + subst(name, "\"", "\\\"") + '"';
239 case quote_shell_filename:
240 return quoteName(os::external_path(name), quote_shell);
242 return "\"" + subst(subst(name, "\\", "\\\\"), "\"", "\\\"")
245 // shut up stupid compiler
251 // Uses a string of paths separated by ";"s to find a file to open.
252 // Can't cope with pathnames with a ';' in them. Returns full path to file.
253 // If path entry begins with $$LyX/, use system_lyxdir
254 // If path entry begins with $$User/, use user_lyxdir
255 // Example: "$$User/doc;$$LyX/doc"
256 FileName const fileOpenSearch(string const & path, string const & name,
261 bool notfound = true;
262 string tmppath = split(path, path_element, ';');
264 while (notfound && !path_element.empty()) {
265 path_element = os::internal_path(path_element);
266 if (!suffixIs(path_element, '/'))
268 path_element = subst(path_element, "$$LyX",
269 package().system_support().absFileName());
270 path_element = subst(path_element, "$$User",
271 package().user_support().absFileName());
273 real_file = fileSearch(path_element, name, ext);
275 if (real_file.empty()) {
277 tmppath = split(tmppath, path_element, ';');
278 } while (!tmppath.empty() && path_element.empty());
288 // Returns the real name of file name in directory path, with optional
290 FileName const fileSearch(string const & path, string const & name,
291 string const & ext, search_mode mode)
293 // if `name' is an absolute path, we ignore the setting of `path'
294 // Expand Environmentvariables in 'name'
295 string const tmpname = replaceEnvironmentPath(name);
296 FileName fullname(makeAbsPath(tmpname, path));
297 // search first without extension, then with it.
298 if (fullname.isReadableFile())
302 return mode == may_not_exist ? fullname : FileName();
303 // Only add the extension if it is not already the extension of
305 if (getExtension(fullname.absFileName()) != ext) {
306 if (mode == check_hidpi) {
307 FileName fullname2x = FileName(addExtension(fullname.absFileName() + "@2x", ext));
308 if (fullname2x.isReadableFile())
311 fullname = FileName(addExtension(fullname.absFileName(), ext));
313 if (fullname.isReadableFile() || mode == may_not_exist)
319 // Search the file name.ext in the subdirectory dir of
321 // 2) build_lyxdir (if not empty)
323 FileName const libFileSearch(string const & dir, string const & name,
324 string const & ext, search_mode mode)
326 FileName fullname = fileSearch(addPath(package().user_support().absFileName(), dir),
328 if (!fullname.empty())
331 if (!package().build_support().empty())
332 fullname = fileSearch(addPath(package().build_support().absFileName(), dir),
334 if (!fullname.empty())
337 return fileSearch(addPath(package().system_support().absFileName(), dir),
342 FileName const i18nLibFileSearch(string const & dir, string const & name,
345 /* The highest priority value is the `LANGUAGE' environment
346 variable. But we don't use the value if the currently
347 selected locale is the C locale. This is a GNU extension.
349 Otherwise, w use a trick to guess what support/gettext.has done:
350 each po file is able to tell us its name. (JMarc)
353 string lang = getGuiMessages().language();
354 string const language = getEnv("LANGUAGE");
355 if (!lang.empty() && !language.empty())
359 lang = split(lang, l, ':');
362 // First try with the full name
363 tmp = libFileSearch(addPath(dir, l), name, ext);
367 // Then the name without country code
368 string const shortl = token(l, '_', 0);
370 tmp = libFileSearch(addPath(dir, shortl), name, ext);
376 // For compatibility, to be removed later (JMarc)
377 tmp = libFileSearch(dir, token(l, '_', 0) + '_' + name,
380 lyxerr << "i18nLibFileSearch: File `" << tmp
381 << "' has been found by the old method" <<endl;
385 lang = split(lang, l, ':');
388 return libFileSearch(dir, name, ext);
392 FileName const imageLibFileSearch(string & dir, string const & name,
393 string const & ext, search_mode mode)
395 if (!lyx::lyxrc.icon_set.empty()) {
396 string const imagedir = addPath(dir, lyx::lyxrc.icon_set);
397 FileName const fn = libFileSearch(imagedir, name, ext, mode);
403 return libFileSearch(dir, name, ext, mode);
407 string const commandPrep(string const & command_in)
409 static string const token_scriptpath = "$$s/";
410 string const python_call = "python -tt";
412 string command = command_in;
413 if (prefixIs(command_in, python_call))
414 command = os::python() + command_in.substr(python_call.length());
416 // Find the starting position of "$$s/"
417 string::size_type const pos1 = command.find(token_scriptpath);
418 if (pos1 == string::npos)
420 // Find the end of the "$$s/some_subdir/some_script" word within
421 // command. Assumes that the script name does not contain spaces.
422 string::size_type const start_script = pos1 + 4;
423 string::size_type const pos2 = command.find(' ', start_script);
424 string::size_type const size_script = pos2 == string::npos?
425 (command.size() - start_script) : pos2 - start_script;
427 // Does this script file exist?
428 string const script =
429 libFileSearch(".", command.substr(start_script, size_script)).absFileName();
431 if (script.empty()) {
432 // Replace "$$s/" with ""
433 command.erase(pos1, 4);
435 quote_style style = quote_shell;
436 if (prefixIs(command, os::python()))
437 style = quote_python;
439 // Replace "$$s/foo/some_script" with "<path to>/some_script".
440 string::size_type const size_replace = size_script + 4;
441 command.replace(pos1, size_replace, quoteName(script, style));
448 static string createTempFile(QString const & mask)
450 // FIXME: This is not safe. QTemporaryFile creates a file in open(),
451 // but the file is deleted when qt_tmp goes out of scope.
452 // Therefore the next call to createTempFile() may create the
453 // same file again. To make this safe the QTemporaryFile object
454 // needs to be kept for the whole life time of the temp file name.
455 // This could be achieved by creating a class TempDir (like
456 // TempFile, but using a currentlky non-existing
457 // QTemporaryDirectory object).
458 QTemporaryFile qt_tmp(mask + ".XXXXXXXXXXXX");
460 string const temp_file = fromqstr(qt_tmp.fileName());
461 LYXERR(Debug::FILES, "Temporary file `" << temp_file << "' created.");
464 LYXERR(Debug::FILES, "Unable to create temporary file with following template: "
465 << qt_tmp.fileTemplate());
470 static FileName createTmpDir(FileName const & tempdir, string const & mask)
472 LYXERR(Debug::FILES, "createTmpDir: tempdir=`" << tempdir << "'\n"
473 << "createTmpDir: mask=`" << mask << '\'');
475 QFileInfo tmp_fi(QDir(toqstr(tempdir.absFileName())), toqstr(mask));
476 FileName const tmpfl(createTempFile(tmp_fi.absoluteFilePath()));
478 if (tmpfl.empty() || !tmpfl.createDirectory(0700)) {
479 LYXERR0("LyX could not create temporary directory in " << tempdir
488 FileName const createLyXTmpDir(FileName const & deflt)
490 if (deflt.empty() || deflt == package().system_temp_dir())
491 return createTmpDir(package().system_temp_dir(), "lyx_tmpdir");
493 if (deflt.createDirectory(0777))
496 if (deflt.isDirWritable()) {
497 // deflt could not be created because it
498 // did exist already, so let's create our own
500 return createTmpDir(deflt, "lyx_tmpdir");
502 // some other error occured.
503 return createTmpDir(package().system_temp_dir(), "lyx_tmpdir");
508 // Strip filename from path name
509 string const onlyPath(string const & filename)
511 // If empty filename, return empty
512 if (filename.empty())
515 // Find last / or start of filename
516 size_t j = filename.rfind('/');
517 return j == string::npos ? "./" : filename.substr(0, j + 1);
521 // Convert relative path into absolute path based on a basepath.
522 // If relpath is absolute, just use that.
523 // If basepath is empty, use CWD as base.
524 // Note that basePath can be a relative path, in the sense that it may
525 // not begin with "/" (e.g.), but it should NOT contain such constructs
527 // FIXME It might be nice if the code didn't simply assume that.
528 FileName const makeAbsPath(string const & relPath, string const & basePath)
530 // checks for already absolute path
531 if (FileName::isAbsolute(relPath))
532 return FileName(relPath);
534 // Copies given paths
535 string tempRel = os::internal_path(relPath);
536 // Since TempRel is NOT absolute, we can safely replace "//" with "/"
537 tempRel = subst(tempRel, "//", "/");
541 if (FileName::isAbsolute(basePath))
544 tempBase = addPath(FileName::getcwd().absFileName(), basePath);
546 // Handle /./ at the end of the path
547 while (suffixIs(tempBase, "/./"))
548 tempBase.erase(tempBase.length() - 2);
550 // processes relative path
551 string rTemp = tempRel;
554 // Check for a leading "~"
556 rTemp = split(rTemp, temp, '/');
558 tempBase = Package::get_home_dir().absFileName();
563 while (!rTemp.empty()) {
565 rTemp = split(rTemp, temp, '/');
567 if (temp == ".") continue;
569 // Remove one level of TempBase
570 if (tempBase.length() <= 1) {
571 //this is supposed to be an absolute path, so...
575 //erase a trailing slash if there is one
576 if (suffixIs(tempBase, "/"))
577 tempBase.erase(tempBase.length() - 1, string::npos);
579 string::size_type i = tempBase.length() - 1;
580 while (i > 0 && tempBase[i] != '/')
583 tempBase.erase(i, string::npos);
586 } else if (temp.empty() && !rTemp.empty()) {
587 tempBase = os::current_root() + rTemp;
590 // Add this piece to TempBase
591 if (!suffixIs(tempBase, '/'))
597 // returns absolute path
598 return FileName(tempBase);
602 // Correctly append filename to the pathname.
603 // If pathname is '.', then don't use pathname.
604 // Chops any path of filename.
605 string const addName(string const & path, string const & fname)
607 string const basename = onlyFileName(fname);
610 if (path != "." && path != "./" && !path.empty()) {
611 buf = os::internal_path(path);
612 if (!suffixIs(path, '/'))
616 return buf + basename;
620 // Strips path from filename
621 string const onlyFileName(string const & fname)
626 string::size_type j = fname.rfind('/');
627 if (j == string::npos) // no '/' in fname
631 return fname.substr(j + 1);
635 // Create absolute path. If impossible, don't do anything
636 // Supports ./ and ~/. Later we can add support for ~logname/. (Asger)
637 string const expandPath(string const & path)
639 // checks for already absolute path
640 string rTemp = replaceEnvironmentPath(path);
641 if (FileName::isAbsolute(rTemp))
645 string const copy = rTemp;
648 rTemp = split(rTemp, temp, '/');
651 return FileName::getcwd().absFileName() + '/' + rTemp;
654 return Package::get_home_dir().absFileName() + '/' + rTemp;
657 return makeAbsPath(copy).absFileName();
659 // Don't know how to handle this
664 // Search the string for ${VAR} and $VAR and replace VAR using getenv.
665 string const replaceEnvironmentPath(string const & path)
667 // ${VAR} is defined as
668 // $\{[A-Za-z_][A-Za-z_0-9]*\}
669 static string const envvar_br = "[$]\\{([A-Za-z_][A-Za-z_0-9]*)\\}";
671 // $VAR is defined as:
672 // $[A-Za-z_][A-Za-z_0-9]*
673 static string const envvar = "[$]([A-Za-z_][A-Za-z_0-9]*)";
675 static regex const envvar_br_re("(.*)" + envvar_br + "(.*)");
676 static regex const envvar_re("(.*)" + envvar + "(.*)");
677 string result = path;
680 if (!regex_match(result, what, envvar_br_re)) {
681 if (!regex_match(result, what, envvar_re))
684 string env_var = getEnv(what.str(2));
685 result = what.str(1) + env_var + what.str(3);
691 // Return a command prefix for setting the environment of the TeX engine.
692 string latexEnvCmdPrefix(string const & path)
694 if (path.empty() || lyxrc.texinputs_prefix.empty())
697 string const texinputs_prefix = os::latex_path_list(
698 replaceCurdirPath(path, lyxrc.texinputs_prefix));
699 string const sep = string(1, os::path_separator(os::TEXENGINE));
700 string const texinputs = getEnv("TEXINPUTS");
702 if (os::shell() == os::UNIX)
703 return "env TEXINPUTS=\"." + sep + texinputs_prefix
704 + sep + texinputs + "\" ";
707 return "cmd /d /c set \"TEXINPUTS=."
708 + sep + texinputs_prefix
709 + sep + texinputs + "\"&";
711 return "cmd /d /c set \"\"\"TEXINPUTS=."
712 + sep + texinputs_prefix
713 + sep + texinputs + "\"\"\"&";
718 // Replace current directory in all elements of a path list with a given path.
719 string const replaceCurdirPath(string const & path, string const & pathlist)
721 string const oldpathlist = replaceEnvironmentPath(pathlist);
722 char const sep = os::path_separator();
725 for (size_t i = 0, k = 0; i != string::npos; k = i) {
726 i = oldpathlist.find(sep, i);
727 string p = oldpathlist.substr(k, i - k);
728 if (FileName::isAbsolute(p)) {
734 } else if (prefixIs(p, "./")) {
736 while (p[offset] == '/')
739 newpathlist += addPath(path, p.substr(offset));
740 if (suffixIs(p, "//"))
743 if (i != string::npos) {
745 // Stop here if the last element is empty
746 if (++i == oldpathlist.length())
754 // Make relative path out of two absolute paths
755 docstring const makeRelPath(docstring const & abspath, docstring const & basepath)
756 // Makes relative path out of absolute path. If it is deeper than basepath,
757 // it's easy. If basepath and abspath share something (they are all deeper
758 // than some directory), it'll be rendered using ..'s. If they are completely
759 // different, then the absolute path will be used as relative path.
761 docstring::size_type const abslen = abspath.length();
762 docstring::size_type const baselen = basepath.length();
764 docstring::size_type i = os::common_path(abspath, basepath);
767 // actually no match - cannot make it relative
771 // Count how many dirs there are in basepath above match
772 // and append as many '..''s into relpath
774 docstring::size_type j = i;
775 while (j < baselen) {
776 if (basepath[j] == '/') {
777 if (j + 1 == baselen)
784 // Append relative stuff from common directory to abspath
785 if (abspath[i] == '/')
787 for (; i < abslen; ++i)
790 if (suffixIs(buf, '/'))
791 buf.erase(buf.length() - 1);
792 // Substitute empty with .
799 // Append sub-directory(ies) to a path in an intelligent way
800 string const addPath(string const & path, string const & path_2)
803 string const path2 = os::internal_path(path_2);
805 if (!path.empty() && path != "." && path != "./") {
806 buf = os::internal_path(path);
807 if (path[path.length() - 1] != '/')
811 if (!path2.empty()) {
812 string::size_type const p2start = path2.find_first_not_of('/');
813 string::size_type const p2end = path2.find_last_not_of('/');
814 string const tmp = path2.substr(p2start, p2end - p2start + 1);
821 string const changeExtension(string const & oldname, string const & extension)
823 string::size_type const last_slash = oldname.rfind('/');
824 string::size_type last_dot = oldname.rfind('.');
825 if (last_dot < last_slash && last_slash != string::npos)
826 last_dot = string::npos;
829 // Make sure the extension starts with a dot
830 if (!extension.empty() && extension[0] != '.')
831 ext= '.' + extension;
835 return os::internal_path(oldname.substr(0, last_dot) + ext);
839 string const removeExtension(string const & name)
841 return changeExtension(name, string());
845 string const addExtension(string const & name, string const & extension)
847 if (!extension.empty() && extension[0] != '.')
848 return name + '.' + extension;
849 return name + extension;
853 /// Return the extension of the file (not including the .)
854 string const getExtension(string const & name)
856 string::size_type const last_slash = name.rfind('/');
857 string::size_type const last_dot = name.rfind('.');
858 if (last_dot != string::npos &&
859 (last_slash == string::npos || last_dot > last_slash))
860 return name.substr(last_dot + 1,
861 name.length() - (last_dot + 1));
867 string const unzippedFileName(string const & zipped_file)
869 string const ext = getExtension(zipped_file);
870 if (ext == "gz" || ext == "z" || ext == "Z")
871 return changeExtension(zipped_file, string());
872 return onlyPath(zipped_file) + "unzipped_" + onlyFileName(zipped_file);
876 FileName const unzipFile(FileName const & zipped_file, string const & unzipped_file)
878 FileName const tempfile = FileName(unzipped_file.empty() ?
879 unzippedFileName(zipped_file.toFilesystemEncoding()) :
882 string const command = "gunzip -c " +
883 zipped_file.toFilesystemEncoding() + " > " +
884 tempfile.toFilesystemEncoding();
886 one.startscript(Systemcall::Wait, command);
887 // test that command was executed successfully (anon)
888 // yes, please do. (Lgb)
893 docstring const makeDisplayPath(string const & path, unsigned int threshold)
897 // If file is from LyXDir, display it as if it were relative.
898 string const system = package().system_support().absFileName();
899 if (prefixIs(str, system) && str != system)
900 return from_utf8("[" + str.erase(0, system.length()) + "]");
902 // replace /home/blah with ~/
903 string const home = Package::get_home_dir().absFileName();
904 if (!home.empty() && prefixIs(str, home))
905 str = subst(str, home, "~");
907 if (str.length() <= threshold)
908 return from_utf8(os::external_path(str));
910 string const prefix = ".../";
911 docstring dstr = from_utf8(str);
914 while (dstr.length() > threshold)
915 dstr = split(dstr, temp, '/');
917 // Did we shorten everything away?
919 // Yes, filename itself is too long.
920 // Pick the start and the end of the filename.
921 dstr = from_utf8(onlyFileName(path));
922 docstring const head = dstr.substr(0, threshold / 2 - 3);
924 docstring::size_type len = dstr.length();
925 docstring const tail =
926 dstr.substr(len - threshold / 2 - 2, len - 1);
927 dstr = head + from_ascii("...") + tail;
930 return from_utf8(os::external_path(prefix + to_utf8(dstr)));
935 bool readLink(FileName const & file, FileName & link)
937 string const encoded = file.toFilesystemEncoding();
938 #ifdef HAVE_DEF_PATH_MAX
939 char linkbuffer[PATH_MAX + 1];
940 ssize_t const nRead = ::readlink(encoded.c_str(),
941 linkbuffer, sizeof(linkbuffer) - 1);
944 linkbuffer[nRead] = '\0'; // terminator
946 vector<char> buf(1024);
950 nRead = ::readlink(encoded.c_str(), &buf[0], buf.size() - 1);
954 if (static_cast<size_t>(nRead) < buf.size() - 1) {
957 buf.resize(buf.size() * 2);
959 buf[nRead] = '\0'; // terminator
960 const char * linkbuffer = &buf[0];
962 link = makeAbsPath(linkbuffer, onlyPath(file.absFileName()));
966 bool readLink(FileName const &, FileName &)
973 cmd_ret const runCommand(string const & cmd)
975 // FIXME: replace all calls to RunCommand with ForkedCall
976 // (if the output is not needed) or the code in ISpell.cpp
977 // (if the output is needed).
979 // One question is if we should use popen or
980 // create our own popen based on fork, exec, pipe
981 // of course the best would be to have a
982 // pstream (process stream), with the
983 // variants ipstream, opstream
988 PROCESS_INFORMATION process;
989 SECURITY_ATTRIBUTES security;
992 bool err2out = false;
994 string const infile = trim(split(cmd, command, '<'), " \"");
995 command = rtrim(command);
996 if (suffixIs(command, "2>&1")) {
997 command = rtrim(command, "2>&1");
1000 string const cmdarg = "/d /c " + command;
1001 string const comspec = getEnv("COMSPEC");
1003 security.nLength = sizeof(SECURITY_ATTRIBUTES);
1004 security.bInheritHandle = TRUE;
1005 security.lpSecurityDescriptor = NULL;
1007 if (CreatePipe(&in, &out, &security, 0)) {
1008 memset(&startup, 0, sizeof(STARTUPINFO));
1009 memset(&process, 0, sizeof(PROCESS_INFORMATION));
1011 startup.cb = sizeof(STARTUPINFO);
1012 startup.dwFlags = STARTF_USESTDHANDLES;
1014 startup.hStdError = err2out ? out : GetStdHandle(STD_ERROR_HANDLE);
1015 startup.hStdInput = infile.empty()
1016 ? GetStdHandle(STD_INPUT_HANDLE)
1017 : CreateFile(infile.c_str(), GENERIC_READ,
1018 FILE_SHARE_READ, &security, OPEN_EXISTING,
1019 FILE_ATTRIBUTE_NORMAL, NULL);
1020 startup.hStdOutput = out;
1022 if (startup.hStdInput != INVALID_HANDLE_VALUE &&
1023 CreateProcess(comspec.c_str(), (LPTSTR)cmdarg.c_str(),
1024 &security, &security, TRUE, CREATE_NO_WINDOW,
1025 0, 0, &startup, &process)) {
1027 CloseHandle(process.hThread);
1028 fno = _open_osfhandle((long)in, _O_RDONLY);
1030 inf = _fdopen(fno, "r");
1033 #elif defined (HAVE_POPEN)
1034 FILE * inf = ::popen(cmd.c_str(), os::popen_read_mode());
1035 #elif defined (HAVE__POPEN)
1036 FILE * inf = ::_popen(cmd.c_str(), os::popen_read_mode());
1038 #error No popen() function.
1041 // (Claus Hentschel) Check if popen was successful ;-)
1043 lyxerr << "RunCommand:: could not start child process" << endl;
1044 return make_pair(-1, string());
1050 ret += static_cast<char>(c);
1054 #if defined (_WIN32)
1055 WaitForSingleObject(process.hProcess, INFINITE);
1056 if (!infile.empty())
1057 CloseHandle(startup.hStdInput);
1058 CloseHandle(process.hProcess);
1059 int const pret = fclose(inf);
1060 #elif defined (HAVE_PCLOSE)
1061 int const pret = pclose(inf);
1062 #elif defined (HAVE__PCLOSE)
1063 int const pret = _pclose(inf);
1065 #error No pclose() function.
1069 perror("RunCommand:: could not terminate child process");
1071 return make_pair(pret, ret);
1075 FileName const findtexfile(string const & fil, string const & /*format*/)
1077 /* There is no problem to extend this function too use other
1078 methods to look for files. It could be setup to look
1079 in environment paths and also if wanted as a last resort
1080 to a recursive find. One of the easier extensions would
1081 perhaps be to use the LyX file lookup methods. But! I am
1082 going to implement this until I see some demand for it.
1086 // If the file can be found directly, we just return a
1087 // absolute path version of it.
1088 FileName const absfile(makeAbsPath(fil));
1089 if (absfile.exists())
1092 // Now we try to find it using kpsewhich.
1093 // It seems from the kpsewhich manual page that it is safe to use
1094 // kpsewhich without --format: "When the --format option is not
1095 // given, the search path used when looking for a file is inferred
1096 // from the name given, by looking for a known extension. If no
1097 // known extension is found, the search path for TeX source files
1099 // However, we want to take advantage of the format sine almost all
1100 // the different formats has environment variables that can be used
1101 // to controll which paths to search. f.ex. bib looks in
1102 // BIBINPUTS and TEXBIB. Small list follows:
1103 // bib - BIBINPUTS, TEXBIB
1105 // graphic/figure - TEXPICTS, TEXINPUTS
1106 // ist - TEXINDEXSTYLE, INDEXSTYLE
1107 // pk - PROGRAMFONTS, PKFONTS, TEXPKS, GLYPHFONTS, TEXFONTS
1109 // tfm - TFMFONTS, TEXFONTS
1110 // This means that to use kpsewhich in the best possible way we
1111 // should help it by setting additional path in the approp. envir.var.
1112 string const kpsecmd = "kpsewhich " + fil;
1114 cmd_ret const c = runCommand(kpsecmd);
1116 LYXERR(Debug::LATEX, "kpse status = " << c.first << '\n'
1117 << "kpse result = `" << rtrim(c.second, "\n\r") << '\'');
1119 return FileName(rtrim(to_utf8(from_filesystem8bit(c.second)), "\n\r"));
1125 int compare_timestamps(FileName const & file1, FileName const & file2)
1127 // If the original is newer than the copy, then copy the original
1128 // to the new directory.
1131 if (file1.exists() && file2.exists()) {
1132 double const tmp = difftime(file1.lastModified(), file2.lastModified());
1134 cmp = tmp > 0 ? 1 : -1;
1136 } else if (file1.exists()) {
1138 } else if (file2.exists()) {
1146 bool prefs2prefs(FileName const & filename, FileName const & tempfile, bool lfuns)
1148 FileName const script = libFileSearch("scripts", "prefs2prefs.py");
1149 if (script.empty()) {
1150 LYXERR0("Could not find bind file conversion "
1151 "script prefs2prefs.py.");
1155 ostringstream command;
1156 command << os::python() << ' ' << quoteName(script.toFilesystemEncoding())
1157 << ' ' << (lfuns ? "-l" : "-p") << ' '
1158 << quoteName(filename.toFilesystemEncoding())
1159 << ' ' << quoteName(tempfile.toFilesystemEncoding());
1160 string const command_str = command.str();
1162 LYXERR(Debug::FILES, "Running `" << command_str << '\'');
1164 cmd_ret const ret = runCommand(command_str);
1165 if (ret.first != 0) {
1166 LYXERR0("Could not run file conversion script prefs2prefs.py.");
1172 int fileLock(const char * lock_file)
1175 #if defined(HAVE_LOCKF)
1176 fd = open(lock_file, O_CREAT|O_APPEND|O_SYNC|O_RDWR, 0666);
1177 if (lockf(fd, F_LOCK, 0) != 0) {
1185 void fileUnlock(int fd, const char * /* lock_file*/)
1187 #if defined(HAVE_LOCKF)
1189 if (lockf(fd, F_ULOCK, 0))
1190 LYXERR0("Can't unlock the file.");
1196 } //namespace support