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, string const & lpath)
705 bool use_lpath = !(lpath.empty() || lpath == "." || lpath == "./");
707 if (path.empty() || (lyxrc.texinputs_prefix.empty() && !use_lpath))
710 string texinputs_prefix = lyxrc.texinputs_prefix.empty() ? string()
711 : os::latex_path_list(
712 replaceCurdirPath(path, lyxrc.texinputs_prefix));
713 string const sep = string(1, os::path_separator(os::TEXENGINE));
714 string const texinputs = getEnv("TEXINPUTS");
717 string const abslpath = FileName::isAbsolute(lpath)
718 ? os::latex_path(lpath)
719 : os::latex_path(FileName(path + "/" + lpath).realPath());
720 if (texinputs_prefix.empty())
721 texinputs_prefix = abslpath;
722 else if (suffixIs(texinputs_prefix, sep))
723 texinputs_prefix.append(abslpath + sep);
725 texinputs_prefix.append(sep + abslpath);
728 if (os::shell() == os::UNIX)
729 return "env TEXINPUTS=\"." + sep + texinputs_prefix
730 + sep + texinputs + "\" ";
732 // NOTE: the dummy blank dir is necessary to force the
733 // QProcess parser to quote the argument (see bug 9453)
734 return "cmd /d /c set \"TEXINPUTS=." + sep + " "
735 + sep + texinputs_prefix
736 + sep + texinputs + "\" & ";
740 // Replace current directory in all elements of a path list with a given path.
741 string const replaceCurdirPath(string const & path, string const & pathlist)
743 string const oldpathlist = replaceEnvironmentPath(pathlist);
744 char const sep = os::path_separator();
747 for (size_t i = 0, k = 0; i != string::npos; k = i) {
748 i = oldpathlist.find(sep, i);
749 string p = oldpathlist.substr(k, i - k);
750 if (FileName::isAbsolute(p)) {
756 } else if (prefixIs(p, "./")) {
758 while (p[offset] == '/')
761 newpathlist += addPath(path, p.substr(offset));
762 if (suffixIs(p, "//"))
765 if (i != string::npos) {
767 // Stop here if the last element is empty
768 if (++i == oldpathlist.length())
776 // Make relative path out of two absolute paths
777 docstring const makeRelPath(docstring const & abspath, docstring const & basepath)
778 // Makes relative path out of absolute path. If it is deeper than basepath,
779 // it's easy. If basepath and abspath share something (they are all deeper
780 // than some directory), it'll be rendered using ..'s. If they are completely
781 // different, then the absolute path will be used as relative path.
783 docstring::size_type const abslen = abspath.length();
784 docstring::size_type const baselen = basepath.length();
786 docstring::size_type i = os::common_path(abspath, basepath);
789 // actually no match - cannot make it relative
793 // Count how many dirs there are in basepath above match
794 // and append as many '..''s into relpath
796 docstring::size_type j = i;
797 while (j < baselen) {
798 if (basepath[j] == '/') {
799 if (j + 1 == baselen)
806 // Append relative stuff from common directory to abspath
807 if (abspath[i] == '/')
809 for (; i < abslen; ++i)
812 if (suffixIs(buf, '/'))
813 buf.erase(buf.length() - 1);
814 // Substitute empty with .
821 // Append sub-directory(ies) to a path in an intelligent way
822 string const addPath(string const & path, string const & path_2)
825 string const path2 = os::internal_path(path_2);
827 if (!path.empty() && path != "." && path != "./") {
828 buf = os::internal_path(path);
829 if (path[path.length() - 1] != '/')
833 if (!path2.empty()) {
834 string::size_type const p2start = path2.find_first_not_of('/');
835 string::size_type const p2end = path2.find_last_not_of('/');
836 string const tmp = path2.substr(p2start, p2end - p2start + 1);
843 string const changeExtension(string const & oldname, string const & extension)
845 string::size_type const last_slash = oldname.rfind('/');
846 string::size_type last_dot = oldname.rfind('.');
847 if (last_dot < last_slash && last_slash != string::npos)
848 last_dot = string::npos;
851 // Make sure the extension starts with a dot
852 if (!extension.empty() && extension[0] != '.')
853 ext= '.' + extension;
857 return os::internal_path(oldname.substr(0, last_dot) + ext);
861 string const removeExtension(string const & name)
863 return changeExtension(name, string());
867 string const addExtension(string const & name, string const & extension)
869 if (!extension.empty() && extension[0] != '.')
870 return name + '.' + extension;
871 return name + extension;
875 /// Return the extension of the file (not including the .)
876 string const getExtension(string const & name)
878 string::size_type const last_slash = name.rfind('/');
879 string::size_type const last_dot = name.rfind('.');
880 if (last_dot != string::npos &&
881 (last_slash == string::npos || last_dot > last_slash))
882 return name.substr(last_dot + 1,
883 name.length() - (last_dot + 1));
889 string const unzippedFileName(string const & zipped_file)
891 string const ext = getExtension(zipped_file);
892 if (ext == "gz" || ext == "z" || ext == "Z")
893 return changeExtension(zipped_file, string());
894 else if (ext == "svgz")
895 return changeExtension(zipped_file, "svg");
896 return onlyPath(zipped_file) + "unzipped_" + onlyFileName(zipped_file);
900 FileName const unzipFile(FileName const & zipped_file, string const & unzipped_file)
902 FileName const tempfile = FileName(unzipped_file.empty() ?
903 unzippedFileName(zipped_file.toFilesystemEncoding()) :
906 string const command = "gunzip -c " +
907 zipped_file.toFilesystemEncoding() + " > " +
908 tempfile.toFilesystemEncoding();
910 one.startscript(Systemcall::Wait, command);
911 // test that command was executed successfully (anon)
912 // yes, please do. (Lgb)
917 docstring const makeDisplayPath(string const & path, unsigned int threshold)
921 // If file is from LyXDir, display it as if it were relative.
922 string const system = package().system_support().absFileName();
923 if (prefixIs(str, system) && str != system)
924 return from_utf8("[" + str.erase(0, system.length()) + "]");
926 // replace /home/blah with ~/
927 string const home = Package::get_home_dir().absFileName();
928 if (!home.empty() && prefixIs(str, home))
929 str = subst(str, home, "~");
931 if (str.length() <= threshold)
932 return from_utf8(os::external_path(str));
934 string const prefix = ".../";
935 docstring dstr = from_utf8(str);
938 while (dstr.length() > threshold)
939 dstr = split(dstr, temp, '/');
941 // Did we shorten everything away?
943 // Yes, filename itself is too long.
944 // Pick the start and the end of the filename.
945 dstr = from_utf8(onlyFileName(path));
946 docstring::size_type const len = dstr.length();
947 if (len >= threshold)
948 dstr = support::truncateWithEllipsis(dstr, threshold / 2) +
949 dstr.substr(len - threshold / 2 - 2, len - 1);
952 return from_utf8(os::external_path(prefix + to_utf8(dstr)));
957 bool readLink(FileName const & file, FileName & link)
959 string const encoded = file.toFilesystemEncoding();
960 #ifdef HAVE_DEF_PATH_MAX
961 char linkbuffer[PATH_MAX + 1];
962 ssize_t const nRead = ::readlink(encoded.c_str(),
963 linkbuffer, sizeof(linkbuffer) - 1);
966 linkbuffer[nRead] = '\0'; // terminator
968 vector<char> buf(1024);
972 nRead = ::readlink(encoded.c_str(), &buf[0], buf.size() - 1);
976 if (static_cast<size_t>(nRead) < buf.size() - 1) {
979 buf.resize(buf.size() * 2);
981 buf[nRead] = '\0'; // terminator
982 const char * linkbuffer = &buf[0];
984 link = makeAbsPath(linkbuffer, onlyPath(file.absFileName()));
988 bool readLink(FileName const &, FileName &)
995 cmd_ret const runCommand(string const & cmd)
997 // FIXME: replace all calls to RunCommand with ForkedCall
998 // (if the output is not needed) or the code in ISpell.cpp
999 // (if the output is needed).
1001 // One question is if we should use popen or
1002 // create our own popen based on fork, exec, pipe
1003 // of course the best would be to have a
1004 // pstream (process stream), with the
1005 // variants ipstream, opstream
1007 #if defined (_WIN32)
1008 STARTUPINFO startup;
1009 PROCESS_INFORMATION process;
1010 SECURITY_ATTRIBUTES security;
1013 bool err2out = false;
1015 string const infile = trim(split(cmd, command, '<'), " \"");
1016 command = rtrim(command);
1017 if (suffixIs(command, "2>&1")) {
1018 command = rtrim(command, "2>&1");
1021 string const cmdarg = "/d /c " + command;
1022 string const comspec = getEnv("COMSPEC");
1024 security.nLength = sizeof(SECURITY_ATTRIBUTES);
1025 security.bInheritHandle = TRUE;
1026 security.lpSecurityDescriptor = NULL;
1028 if (CreatePipe(&in, &out, &security, 0)) {
1029 memset(&startup, 0, sizeof(STARTUPINFO));
1030 memset(&process, 0, sizeof(PROCESS_INFORMATION));
1032 startup.cb = sizeof(STARTUPINFO);
1033 startup.dwFlags = STARTF_USESTDHANDLES;
1035 startup.hStdError = err2out ? out : GetStdHandle(STD_ERROR_HANDLE);
1036 startup.hStdInput = infile.empty()
1037 ? GetStdHandle(STD_INPUT_HANDLE)
1038 : CreateFile(infile.c_str(), GENERIC_READ,
1039 FILE_SHARE_READ, &security, OPEN_EXISTING,
1040 FILE_ATTRIBUTE_NORMAL, NULL);
1041 startup.hStdOutput = out;
1043 if (startup.hStdInput != INVALID_HANDLE_VALUE &&
1044 CreateProcess(comspec.c_str(), (LPTSTR)cmdarg.c_str(),
1045 &security, &security, TRUE, CREATE_NO_WINDOW,
1046 0, 0, &startup, &process)) {
1048 CloseHandle(process.hThread);
1049 int fno = _open_osfhandle((long)in, _O_RDONLY);
1051 inf = _fdopen(fno, "r");
1054 #elif defined (HAVE_POPEN)
1055 FILE * inf = ::popen(cmd.c_str(), os::popen_read_mode());
1056 #elif defined (HAVE__POPEN)
1057 FILE * inf = ::_popen(cmd.c_str(), os::popen_read_mode());
1059 #error No popen() function.
1062 // (Claus Hentschel) Check if popen was successful ;-)
1064 lyxerr << "RunCommand:: could not start child process" << endl;
1065 return make_pair(-1, string());
1071 ret += static_cast<char>(c);
1075 #if defined (_WIN32)
1076 WaitForSingleObject(process.hProcess, INFINITE);
1077 if (!infile.empty())
1078 CloseHandle(startup.hStdInput);
1079 CloseHandle(process.hProcess);
1080 int const pret = fclose(inf);
1081 #elif defined (HAVE_PCLOSE)
1082 int const pret = pclose(inf);
1083 #elif defined (HAVE__PCLOSE)
1084 int const pret = _pclose(inf);
1086 #error No pclose() function.
1090 perror("RunCommand:: could not terminate child process");
1092 return make_pair(pret, ret);
1096 FileName const findtexfile(string const & fil, string const & /*format*/)
1098 /* There is no problem to extend this function too use other
1099 methods to look for files. It could be setup to look
1100 in environment paths and also if wanted as a last resort
1101 to a recursive find. One of the easier extensions would
1102 perhaps be to use the LyX file lookup methods. But! I am
1103 going to implement this until I see some demand for it.
1107 // If the file can be found directly, we just return a
1108 // absolute path version of it.
1109 FileName const absfile(makeAbsPath(fil));
1110 if (absfile.exists())
1113 // Now we try to find it using kpsewhich.
1114 // It seems from the kpsewhich manual page that it is safe to use
1115 // kpsewhich without --format: "When the --format option is not
1116 // given, the search path used when looking for a file is inferred
1117 // from the name given, by looking for a known extension. If no
1118 // known extension is found, the search path for TeX source files
1120 // However, we want to take advantage of the format sine almost all
1121 // the different formats has environment variables that can be used
1122 // to controll which paths to search. f.ex. bib looks in
1123 // BIBINPUTS and TEXBIB. Small list follows:
1124 // bib - BIBINPUTS, TEXBIB
1126 // graphic/figure - TEXPICTS, TEXINPUTS
1127 // ist - TEXINDEXSTYLE, INDEXSTYLE
1128 // pk - PROGRAMFONTS, PKFONTS, TEXPKS, GLYPHFONTS, TEXFONTS
1130 // tfm - TFMFONTS, TEXFONTS
1131 // This means that to use kpsewhich in the best possible way we
1132 // should help it by setting additional path in the approp. envir.var.
1133 string const kpsecmd = "kpsewhich " + fil;
1135 cmd_ret const c = runCommand(kpsecmd);
1137 LYXERR(Debug::LATEX, "kpse status = " << c.first << '\n'
1138 << "kpse result = `" << rtrim(c.second, "\n\r") << '\'');
1140 return FileName(rtrim(to_utf8(from_filesystem8bit(c.second)), "\n\r"));
1146 int compare_timestamps(FileName const & file1, FileName const & file2)
1148 // If the original is newer than the copy, then copy the original
1149 // to the new directory.
1152 if (file1.exists() && file2.exists()) {
1153 double const tmp = difftime(file1.lastModified(), file2.lastModified());
1155 cmp = tmp > 0 ? 1 : -1;
1157 } else if (file1.exists()) {
1159 } else if (file2.exists()) {
1167 bool prefs2prefs(FileName const & filename, FileName const & tempfile, bool lfuns)
1169 FileName const script = libFileSearch("scripts", "prefs2prefs.py");
1170 if (script.empty()) {
1171 LYXERR0("Could not find bind file conversion "
1172 "script prefs2prefs.py.");
1176 ostringstream command;
1177 command << os::python() << ' ' << quoteName(script.toFilesystemEncoding())
1178 << ' ' << (lfuns ? "-l" : "-p") << ' '
1179 << quoteName(filename.toFilesystemEncoding())
1180 << ' ' << quoteName(tempfile.toFilesystemEncoding());
1181 string const command_str = command.str();
1183 LYXERR(Debug::FILES, "Running `" << command_str << '\'');
1185 cmd_ret const ret = runCommand(command_str);
1186 if (ret.first != 0) {
1187 LYXERR0("Could not run file conversion script prefs2prefs.py.");
1194 bool configFileNeedsUpdate(string const & file)
1196 // We cannot initialize configure_script directly because the package
1197 // is not initialized yet when static objects are constructed.
1198 static FileName configure_script;
1199 static bool firstrun = true;
1202 FileName(addName(package().system_support().absFileName(),
1208 FileName(addName(package().user_support().absFileName(), file));
1209 return !absfile.exists()
1210 || configure_script.lastModified() > absfile.lastModified();
1214 int fileLock(const char * lock_file)
1217 #if defined(HAVE_LOCKF)
1218 fd = open(lock_file, O_CREAT|O_APPEND|O_SYNC|O_RDWR, 0666);
1221 if (lockf(fd, F_LOCK, 0) != 0) {
1230 void fileUnlock(int fd, const char * /* lock_file*/)
1232 #if defined(HAVE_LOCKF)
1234 if (lockf(fd, F_ULOCK, 0))
1235 LYXERR0("Can't unlock the file.");
1241 } //namespace support