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, "\"", "\\\"") + '"';
240 return "\"" + subst(subst(name, "\\", "\\\\"), "\"", "\\\"")
243 // shut up stupid compiler
249 // Uses a string of paths separated by ";"s to find a file to open.
250 // Can't cope with pathnames with a ';' in them. Returns full path to file.
251 // If path entry begins with $$LyX/, use system_lyxdir
252 // If path entry begins with $$User/, use user_lyxdir
253 // Example: "$$User/doc;$$LyX/doc"
254 FileName const fileOpenSearch(string const & path, string const & name,
259 bool notfound = true;
260 string tmppath = split(path, path_element, ';');
262 while (notfound && !path_element.empty()) {
263 path_element = os::internal_path(path_element);
264 if (!suffixIs(path_element, '/'))
266 path_element = subst(path_element, "$$LyX",
267 package().system_support().absFileName());
268 path_element = subst(path_element, "$$User",
269 package().user_support().absFileName());
271 real_file = fileSearch(path_element, name, ext);
273 if (real_file.empty()) {
275 tmppath = split(tmppath, path_element, ';');
276 } while (!tmppath.empty() && path_element.empty());
286 // Returns the real name of file name in directory path, with optional
288 FileName const fileSearch(string const & path, string const & name,
289 string const & ext, search_mode mode)
291 // if `name' is an absolute path, we ignore the setting of `path'
292 // Expand Environmentvariables in 'name'
293 string const tmpname = replaceEnvironmentPath(name);
294 FileName fullname(makeAbsPath(tmpname, path));
295 // search first without extension, then with it.
296 if (fullname.isReadableFile())
300 return mode == may_not_exist ? fullname : FileName();
301 // Only add the extension if it is not already the extension of
303 if (getExtension(fullname.absFileName()) != ext) {
304 if (mode == check_hidpi) {
305 FileName fullname2x = FileName(addExtension(fullname.absFileName() + "@2x", ext));
306 if (fullname2x.isReadableFile())
309 fullname = FileName(addExtension(fullname.absFileName(), ext));
311 if (fullname.isReadableFile() || mode == may_not_exist)
317 // Search the file name.ext in the subdirectory dir of
319 // 2) build_lyxdir (if not empty)
321 FileName const libFileSearch(string const & dir, string const & name,
322 string const & ext, search_mode mode)
324 FileName fullname = fileSearch(addPath(package().user_support().absFileName(), dir),
326 if (!fullname.empty())
329 if (!package().build_support().empty())
330 fullname = fileSearch(addPath(package().build_support().absFileName(), dir),
332 if (!fullname.empty())
335 return fileSearch(addPath(package().system_support().absFileName(), dir),
340 FileName const i18nLibFileSearch(string const & dir, string const & name,
343 /* The highest priority value is the `LANGUAGE' environment
344 variable. But we don't use the value if the currently
345 selected locale is the C locale. This is a GNU extension.
347 Otherwise, w use a trick to guess what support/gettext.has done:
348 each po file is able to tell us its name. (JMarc)
351 string lang = getGuiMessages().language();
352 string const language = getEnv("LANGUAGE");
353 if (!lang.empty() && !language.empty())
357 lang = split(lang, l, ':');
360 // First try with the full name
361 tmp = libFileSearch(addPath(dir, l), name, ext);
365 // Then the name without country code
366 string const shortl = token(l, '_', 0);
368 tmp = libFileSearch(addPath(dir, shortl), name, ext);
374 // For compatibility, to be removed later (JMarc)
375 tmp = libFileSearch(dir, token(l, '_', 0) + '_' + name,
378 lyxerr << "i18nLibFileSearch: File `" << tmp
379 << "' has been found by the old method" <<endl;
383 lang = split(lang, l, ':');
386 return libFileSearch(dir, name, ext);
390 FileName const imageLibFileSearch(string & dir, string const & name,
391 string const & ext, search_mode mode)
393 if (!lyx::lyxrc.icon_set.empty()) {
394 string const imagedir = addPath(dir, lyx::lyxrc.icon_set);
395 FileName const fn = libFileSearch(imagedir, name, ext, mode);
401 return libFileSearch(dir, name, ext, mode);
405 string const commandPrep(string const & command_in)
407 static string const token_scriptpath = "$$s/";
408 string const python_call = "python -tt";
410 string command = command_in;
411 if (prefixIs(command_in, python_call))
412 command = os::python() + command_in.substr(python_call.length());
414 // Find the starting position of "$$s/"
415 string::size_type const pos1 = command.find(token_scriptpath);
416 if (pos1 == string::npos)
418 // Find the end of the "$$s/some_subdir/some_script" word within
419 // command. Assumes that the script name does not contain spaces.
420 string::size_type const start_script = pos1 + 4;
421 string::size_type const pos2 = command.find(' ', start_script);
422 string::size_type const size_script = pos2 == string::npos?
423 (command.size() - start_script) : pos2 - start_script;
425 // Does this script file exist?
426 string const script =
427 libFileSearch(".", command.substr(start_script, size_script)).absFileName();
429 if (script.empty()) {
430 // Replace "$$s/" with ""
431 command.erase(pos1, 4);
433 quote_style style = quote_shell;
434 if (prefixIs(command, os::python()))
435 style = quote_python;
437 // Replace "$$s/foo/some_script" with "<path to>/some_script".
438 string::size_type const size_replace = size_script + 4;
439 command.replace(pos1, size_replace, quoteName(script, style));
446 static string createTempFile(QString const & mask)
448 // FIXME: This is not safe. QTemporaryFile creates a file in open(),
449 // but the file is deleted when qt_tmp goes out of scope.
450 // Therefore the next call to createTempFile() may create the
451 // same file again. To make this safe the QTemporaryFile object
452 // needs to be kept for the whole life time of the temp file name.
453 // This could be achieved by creating a class TempDir (like
454 // TempFile, but using a currentlky non-existing
455 // QTemporaryDirectory object).
456 QTemporaryFile qt_tmp(mask + ".XXXXXXXXXXXX");
458 string const temp_file = fromqstr(qt_tmp.fileName());
459 LYXERR(Debug::FILES, "Temporary file `" << temp_file << "' created.");
462 LYXERR(Debug::FILES, "Unable to create temporary file with following template: "
463 << qt_tmp.fileTemplate());
468 static FileName createTmpDir(FileName const & tempdir, string const & mask)
470 LYXERR(Debug::FILES, "createTmpDir: tempdir=`" << tempdir << "'\n"
471 << "createTmpDir: mask=`" << mask << '\'');
473 QFileInfo tmp_fi(QDir(toqstr(tempdir.absFileName())), toqstr(mask));
474 FileName const tmpfl(createTempFile(tmp_fi.absoluteFilePath()));
476 if (tmpfl.empty() || !tmpfl.createDirectory(0700)) {
477 LYXERR0("LyX could not create temporary directory in " << tempdir
486 FileName const createLyXTmpDir(FileName const & deflt)
488 if (deflt.empty() || deflt == package().system_temp_dir())
489 return createTmpDir(package().system_temp_dir(), "lyx_tmpdir");
491 if (deflt.createDirectory(0777))
494 if (deflt.isDirWritable()) {
495 // deflt could not be created because it
496 // did exist already, so let's create our own
498 return createTmpDir(deflt, "lyx_tmpdir");
500 // some other error occured.
501 return createTmpDir(package().system_temp_dir(), "lyx_tmpdir");
506 // Strip filename from path name
507 string const onlyPath(string const & filename)
509 // If empty filename, return empty
510 if (filename.empty())
513 // Find last / or start of filename
514 size_t j = filename.rfind('/');
515 return j == string::npos ? "./" : filename.substr(0, j + 1);
519 // Convert relative path into absolute path based on a basepath.
520 // If relpath is absolute, just use that.
521 // If basepath is empty, use CWD as base.
522 // Note that basePath can be a relative path, in the sense that it may
523 // not begin with "/" (e.g.), but it should NOT contain such constructs
525 // FIXME It might be nice if the code didn't simply assume that.
526 FileName const makeAbsPath(string const & relPath, string const & basePath)
528 // checks for already absolute path
529 if (FileName::isAbsolute(relPath))
530 return FileName(relPath);
532 // Copies given paths
533 string tempRel = os::internal_path(relPath);
534 // Since TempRel is NOT absolute, we can safely replace "//" with "/"
535 tempRel = subst(tempRel, "//", "/");
539 if (FileName::isAbsolute(basePath))
542 tempBase = addPath(FileName::getcwd().absFileName(), basePath);
544 // Handle /./ at the end of the path
545 while (suffixIs(tempBase, "/./"))
546 tempBase.erase(tempBase.length() - 2);
548 // processes relative path
549 string rTemp = tempRel;
552 // Check for a leading "~"
554 rTemp = split(rTemp, temp, '/');
556 tempBase = Package::get_home_dir().absFileName();
561 while (!rTemp.empty()) {
563 rTemp = split(rTemp, temp, '/');
565 if (temp == ".") continue;
567 // Remove one level of TempBase
568 if (tempBase.length() <= 1) {
569 //this is supposed to be an absolute path, so...
573 //erase a trailing slash if there is one
574 if (suffixIs(tempBase, "/"))
575 tempBase.erase(tempBase.length() - 1, string::npos);
577 string::size_type i = tempBase.length() - 1;
578 while (i > 0 && tempBase[i] != '/')
581 tempBase.erase(i, string::npos);
584 } else if (temp.empty() && !rTemp.empty()) {
585 tempBase = os::current_root() + rTemp;
588 // Add this piece to TempBase
589 if (!suffixIs(tempBase, '/'))
595 // returns absolute path
596 return FileName(tempBase);
600 // Correctly append filename to the pathname.
601 // If pathname is '.', then don't use pathname.
602 // Chops any path of filename.
603 string const addName(string const & path, string const & fname)
605 string const basename = onlyFileName(fname);
608 if (path != "." && path != "./" && !path.empty()) {
609 buf = os::internal_path(path);
610 if (!suffixIs(path, '/'))
614 return buf + basename;
618 // Strips path from filename
619 string const onlyFileName(string const & fname)
624 string::size_type j = fname.rfind('/');
625 if (j == string::npos) // no '/' in fname
629 return fname.substr(j + 1);
633 // Create absolute path. If impossible, don't do anything
634 // Supports ./ and ~/. Later we can add support for ~logname/. (Asger)
635 string const expandPath(string const & path)
637 // checks for already absolute path
638 string rTemp = replaceEnvironmentPath(path);
639 if (FileName::isAbsolute(rTemp))
643 string const copy = rTemp;
646 rTemp = split(rTemp, temp, '/');
649 return FileName::getcwd().absFileName() + '/' + rTemp;
652 return Package::get_home_dir().absFileName() + '/' + rTemp;
655 return makeAbsPath(copy).absFileName();
657 // Don't know how to handle this
662 // Search the string for ${VAR} and $VAR and replace VAR using getenv.
663 string const replaceEnvironmentPath(string const & path)
665 // ${VAR} is defined as
666 // $\{[A-Za-z_][A-Za-z_0-9]*\}
667 static string const envvar_br = "[$]\\{([A-Za-z_][A-Za-z_0-9]*)\\}";
669 // $VAR is defined as:
670 // $[A-Za-z_][A-Za-z_0-9]*
671 static string const envvar = "[$]([A-Za-z_][A-Za-z_0-9]*)";
673 static regex const envvar_br_re("(.*)" + envvar_br + "(.*)");
674 static regex const envvar_re("(.*)" + envvar + "(.*)");
675 string result = path;
678 if (!regex_match(result, what, envvar_br_re)) {
679 if (!regex_match(result, what, envvar_re))
682 string env_var = getEnv(what.str(2));
683 result = what.str(1) + env_var + what.str(3);
689 // Return a command prefix for setting the environment of the TeX engine.
690 string latexEnvCmdPrefix(string const & path)
692 if (path.empty() || lyxrc.texinputs_prefix.empty())
695 string const texinputs_prefix = os::latex_path_list(
696 replaceCurdirPath(path, lyxrc.texinputs_prefix));
697 string const sep = string(1, os::path_separator(os::TEXENGINE));
698 string const texinputs = getEnv("TEXINPUTS");
700 if (os::shell() == os::UNIX)
701 return "env TEXINPUTS=\"." + sep + texinputs_prefix
702 + sep + texinputs + "\" ";
704 return "cmd /d /c set TEXINPUTS=." + sep + texinputs_prefix
705 + sep + texinputs + "&";
709 // Replace current directory in all elements of a path list with a given path.
710 string const replaceCurdirPath(string const & path, string const & pathlist)
712 string const oldpathlist = replaceEnvironmentPath(pathlist);
713 char const sep = os::path_separator();
716 for (size_t i = 0, k = 0; i != string::npos; k = i) {
717 i = oldpathlist.find(sep, i);
718 string p = oldpathlist.substr(k, i - k);
719 if (FileName::isAbsolute(p)) {
725 } else if (prefixIs(p, "./")) {
727 while (p[offset] == '/')
730 newpathlist += addPath(path, p.substr(offset));
731 if (suffixIs(p, "//"))
734 if (i != string::npos) {
736 // Stop here if the last element is empty
737 if (++i == oldpathlist.length())
745 // Make relative path out of two absolute paths
746 docstring const makeRelPath(docstring const & abspath, docstring const & basepath)
747 // Makes relative path out of absolute path. If it is deeper than basepath,
748 // it's easy. If basepath and abspath share something (they are all deeper
749 // than some directory), it'll be rendered using ..'s. If they are completely
750 // different, then the absolute path will be used as relative path.
752 docstring::size_type const abslen = abspath.length();
753 docstring::size_type const baselen = basepath.length();
755 docstring::size_type i = os::common_path(abspath, basepath);
758 // actually no match - cannot make it relative
762 // Count how many dirs there are in basepath above match
763 // and append as many '..''s into relpath
765 docstring::size_type j = i;
766 while (j < baselen) {
767 if (basepath[j] == '/') {
768 if (j + 1 == baselen)
775 // Append relative stuff from common directory to abspath
776 if (abspath[i] == '/')
778 for (; i < abslen; ++i)
781 if (suffixIs(buf, '/'))
782 buf.erase(buf.length() - 1);
783 // Substitute empty with .
790 // Append sub-directory(ies) to a path in an intelligent way
791 string const addPath(string const & path, string const & path_2)
794 string const path2 = os::internal_path(path_2);
796 if (!path.empty() && path != "." && path != "./") {
797 buf = os::internal_path(path);
798 if (path[path.length() - 1] != '/')
802 if (!path2.empty()) {
803 string::size_type const p2start = path2.find_first_not_of('/');
804 string::size_type const p2end = path2.find_last_not_of('/');
805 string const tmp = path2.substr(p2start, p2end - p2start + 1);
812 string const changeExtension(string const & oldname, string const & extension)
814 string::size_type const last_slash = oldname.rfind('/');
815 string::size_type last_dot = oldname.rfind('.');
816 if (last_dot < last_slash && last_slash != string::npos)
817 last_dot = string::npos;
820 // Make sure the extension starts with a dot
821 if (!extension.empty() && extension[0] != '.')
822 ext= '.' + extension;
826 return os::internal_path(oldname.substr(0, last_dot) + ext);
830 string const removeExtension(string const & name)
832 return changeExtension(name, string());
836 string const addExtension(string const & name, string const & extension)
838 if (!extension.empty() && extension[0] != '.')
839 return name + '.' + extension;
840 return name + extension;
844 /// Return the extension of the file (not including the .)
845 string const getExtension(string const & name)
847 string::size_type const last_slash = name.rfind('/');
848 string::size_type const last_dot = name.rfind('.');
849 if (last_dot != string::npos &&
850 (last_slash == string::npos || last_dot > last_slash))
851 return name.substr(last_dot + 1,
852 name.length() - (last_dot + 1));
858 string const unzippedFileName(string const & zipped_file)
860 string const ext = getExtension(zipped_file);
861 if (ext == "gz" || ext == "z" || ext == "Z")
862 return changeExtension(zipped_file, string());
863 return onlyPath(zipped_file) + "unzipped_" + onlyFileName(zipped_file);
867 FileName const unzipFile(FileName const & zipped_file, string const & unzipped_file)
869 FileName const tempfile = FileName(unzipped_file.empty() ?
870 unzippedFileName(zipped_file.toFilesystemEncoding()) :
873 string const command = "gunzip -c " +
874 zipped_file.toFilesystemEncoding() + " > " +
875 tempfile.toFilesystemEncoding();
877 one.startscript(Systemcall::Wait, command);
878 // test that command was executed successfully (anon)
879 // yes, please do. (Lgb)
884 docstring const makeDisplayPath(string const & path, unsigned int threshold)
888 // If file is from LyXDir, display it as if it were relative.
889 string const system = package().system_support().absFileName();
890 if (prefixIs(str, system) && str != system)
891 return from_utf8("[" + str.erase(0, system.length()) + "]");
893 // replace /home/blah with ~/
894 string const home = Package::get_home_dir().absFileName();
895 if (!home.empty() && prefixIs(str, home))
896 str = subst(str, home, "~");
898 if (str.length() <= threshold)
899 return from_utf8(os::external_path(str));
901 string const prefix = ".../";
902 docstring dstr = from_utf8(str);
905 while (dstr.length() > threshold)
906 dstr = split(dstr, temp, '/');
908 // Did we shorten everything away?
910 // Yes, filename itself is too long.
911 // Pick the start and the end of the filename.
912 dstr = from_utf8(onlyFileName(path));
913 docstring const head = dstr.substr(0, threshold / 2 - 3);
915 docstring::size_type len = dstr.length();
916 docstring const tail =
917 dstr.substr(len - threshold / 2 - 2, len - 1);
918 dstr = head + from_ascii("...") + tail;
921 return from_utf8(os::external_path(prefix + to_utf8(dstr)));
926 bool readLink(FileName const & file, FileName & link)
928 string const encoded = file.toFilesystemEncoding();
929 #ifdef HAVE_DEF_PATH_MAX
930 char linkbuffer[PATH_MAX + 1];
931 ssize_t const nRead = ::readlink(encoded.c_str(),
932 linkbuffer, sizeof(linkbuffer) - 1);
935 linkbuffer[nRead] = '\0'; // terminator
937 vector<char> buf(1024);
941 nRead = ::readlink(encoded.c_str(), &buf[0], buf.size() - 1);
945 if (static_cast<size_t>(nRead) < buf.size() - 1) {
948 buf.resize(buf.size() * 2);
950 buf[nRead] = '\0'; // terminator
951 const char * linkbuffer = &buf[0];
953 link = makeAbsPath(linkbuffer, onlyPath(file.absFileName()));
957 bool readLink(FileName const &, FileName &)
964 cmd_ret const runCommand(string const & cmd)
966 // FIXME: replace all calls to RunCommand with ForkedCall
967 // (if the output is not needed) or the code in ISpell.cpp
968 // (if the output is needed).
970 // One question is if we should use popen or
971 // create our own popen based on fork, exec, pipe
972 // of course the best would be to have a
973 // pstream (process stream), with the
974 // variants ipstream, opstream
979 PROCESS_INFORMATION process;
980 SECURITY_ATTRIBUTES security;
983 bool err2out = false;
985 string const infile = trim(split(cmd, command, '<'), " \"");
986 command = rtrim(command);
987 if (suffixIs(command, "2>&1")) {
988 command = rtrim(command, "2>&1");
991 string const cmdarg = "/d /c " + command;
992 string const comspec = getEnv("COMSPEC");
994 security.nLength = sizeof(SECURITY_ATTRIBUTES);
995 security.bInheritHandle = TRUE;
996 security.lpSecurityDescriptor = NULL;
998 if (CreatePipe(&in, &out, &security, 0)) {
999 memset(&startup, 0, sizeof(STARTUPINFO));
1000 memset(&process, 0, sizeof(PROCESS_INFORMATION));
1002 startup.cb = sizeof(STARTUPINFO);
1003 startup.dwFlags = STARTF_USESTDHANDLES;
1005 startup.hStdError = err2out ? out : GetStdHandle(STD_ERROR_HANDLE);
1006 startup.hStdInput = infile.empty()
1007 ? GetStdHandle(STD_INPUT_HANDLE)
1008 : CreateFile(infile.c_str(), GENERIC_READ,
1009 FILE_SHARE_READ, &security, OPEN_EXISTING,
1010 FILE_ATTRIBUTE_NORMAL, NULL);
1011 startup.hStdOutput = out;
1013 if (startup.hStdInput != INVALID_HANDLE_VALUE &&
1014 CreateProcess(comspec.c_str(), (LPTSTR)cmdarg.c_str(),
1015 &security, &security, TRUE, CREATE_NO_WINDOW,
1016 0, 0, &startup, &process)) {
1018 CloseHandle(process.hThread);
1019 fno = _open_osfhandle((long)in, _O_RDONLY);
1021 inf = _fdopen(fno, "r");
1024 #elif defined (HAVE_POPEN)
1025 FILE * inf = ::popen(cmd.c_str(), os::popen_read_mode());
1026 #elif defined (HAVE__POPEN)
1027 FILE * inf = ::_popen(cmd.c_str(), os::popen_read_mode());
1029 #error No popen() function.
1032 // (Claus Hentschel) Check if popen was successful ;-)
1034 lyxerr << "RunCommand:: could not start child process" << endl;
1035 return make_pair(-1, string());
1041 ret += static_cast<char>(c);
1045 #if defined (_WIN32)
1046 WaitForSingleObject(process.hProcess, INFINITE);
1047 if (!infile.empty())
1048 CloseHandle(startup.hStdInput);
1049 CloseHandle(process.hProcess);
1050 int const pret = fclose(inf);
1051 #elif defined (HAVE_PCLOSE)
1052 int const pret = pclose(inf);
1053 #elif defined (HAVE__PCLOSE)
1054 int const pret = _pclose(inf);
1056 #error No pclose() function.
1060 perror("RunCommand:: could not terminate child process");
1062 return make_pair(pret, ret);
1066 FileName const findtexfile(string const & fil, string const & /*format*/)
1068 /* There is no problem to extend this function too use other
1069 methods to look for files. It could be setup to look
1070 in environment paths and also if wanted as a last resort
1071 to a recursive find. One of the easier extensions would
1072 perhaps be to use the LyX file lookup methods. But! I am
1073 going to implement this until I see some demand for it.
1077 // If the file can be found directly, we just return a
1078 // absolute path version of it.
1079 FileName const absfile(makeAbsPath(fil));
1080 if (absfile.exists())
1083 // Now we try to find it using kpsewhich.
1084 // It seems from the kpsewhich manual page that it is safe to use
1085 // kpsewhich without --format: "When the --format option is not
1086 // given, the search path used when looking for a file is inferred
1087 // from the name given, by looking for a known extension. If no
1088 // known extension is found, the search path for TeX source files
1090 // However, we want to take advantage of the format sine almost all
1091 // the different formats has environment variables that can be used
1092 // to controll which paths to search. f.ex. bib looks in
1093 // BIBINPUTS and TEXBIB. Small list follows:
1094 // bib - BIBINPUTS, TEXBIB
1096 // graphic/figure - TEXPICTS, TEXINPUTS
1097 // ist - TEXINDEXSTYLE, INDEXSTYLE
1098 // pk - PROGRAMFONTS, PKFONTS, TEXPKS, GLYPHFONTS, TEXFONTS
1100 // tfm - TFMFONTS, TEXFONTS
1101 // This means that to use kpsewhich in the best possible way we
1102 // should help it by setting additional path in the approp. envir.var.
1103 string const kpsecmd = "kpsewhich " + fil;
1105 cmd_ret const c = runCommand(kpsecmd);
1107 LYXERR(Debug::LATEX, "kpse status = " << c.first << '\n'
1108 << "kpse result = `" << rtrim(c.second, "\n\r") << '\'');
1110 return FileName(rtrim(to_utf8(from_filesystem8bit(c.second)), "\n\r"));
1116 int compare_timestamps(FileName const & file1, FileName const & file2)
1118 // If the original is newer than the copy, then copy the original
1119 // to the new directory.
1122 if (file1.exists() && file2.exists()) {
1123 double const tmp = difftime(file1.lastModified(), file2.lastModified());
1125 cmp = tmp > 0 ? 1 : -1;
1127 } else if (file1.exists()) {
1129 } else if (file2.exists()) {
1137 bool prefs2prefs(FileName const & filename, FileName const & tempfile, bool lfuns)
1139 FileName const script = libFileSearch("scripts", "prefs2prefs.py");
1140 if (script.empty()) {
1141 LYXERR0("Could not find bind file conversion "
1142 "script prefs2prefs.py.");
1146 ostringstream command;
1147 command << os::python() << ' ' << quoteName(script.toFilesystemEncoding())
1148 << ' ' << (lfuns ? "-l" : "-p") << ' '
1149 << quoteName(filename.toFilesystemEncoding())
1150 << ' ' << quoteName(tempfile.toFilesystemEncoding());
1151 string const command_str = command.str();
1153 LYXERR(Debug::FILES, "Running `" << command_str << '\'');
1155 cmd_ret const ret = runCommand(command_str);
1156 if (ret.first != 0) {
1157 LYXERR0("Could not run file conversion script prefs2prefs.py.");
1163 int fileLock(const char * lock_file)
1166 #if defined(HAVE_LOCKF)
1167 fd = open(lock_file, O_CREAT|O_APPEND|O_SYNC|O_RDWR, 0666);
1168 if (lockf(fd, F_LOCK, 0) != 0) {
1176 void fileUnlock(int fd, const char * /* lock_file*/)
1178 #if defined(HAVE_LOCKF)
1180 if (lockf(fd, F_ULOCK, 0))
1181 LYXERR0("Can't unlock the file.");
1187 } //namespace support