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"
41 #include <QTemporaryFile>
43 #include "support/lassert.h"
44 #include "support/regex.h"
75 bool isLyXFileName(string const & filename)
77 return suffixIs(ascii_lowercase(filename), ".lyx");
81 bool isSGMLFileName(string const & filename)
83 return suffixIs(ascii_lowercase(filename), ".sgml");
87 bool isValidLaTeXFileName(string const & filename)
89 string const invalid_chars("#%\"");
90 return filename.find_first_of(invalid_chars) == string::npos;
94 bool isValidDVIFileName(string const & filename)
96 string const invalid_chars("${}()[]^");
97 return filename.find_first_of(invalid_chars) == string::npos;
101 bool isBinaryFile(FileName const & filename)
103 bool isbinary = false;
104 if (filename.empty() || !filename.exists())
108 magic_t magic_cookie = magic_open(MAGIC_MIME_ENCODING);
110 bool detected = true;
111 if (magic_load(magic_cookie, NULL) != 0) {
112 LYXERR(Debug::FILES, "isBinaryFile: "
113 "Could not load magic database - "
114 << magic_error(magic_cookie));
117 char const *charset = magic_file(magic_cookie,
118 filename.toFilesystemEncoding().c_str());
119 isbinary = contains(charset, "binary");
121 magic_close(magic_cookie);
126 // Try by looking for binary chars at the beginning of the file.
127 // Note that this is formally not correct, since count_bin_chars
128 // expects utf8, and the passed string can be anything: plain text
129 // in any encoding, or really binary data. In practice it works,
130 // since QString::fromUtf8() drops invalid utf8 sequences, and
131 // while the exact number may not be correct, we still get a high
132 // number for truly binary files.
134 ifstream ifs(filename.toFilesystemEncoding().c_str());
138 // Maximum strings to read
139 int const max_count = 50;
141 // Maximum number of binary chars allowed
142 int const max_bin = 5;
147 while (count++ < max_count && !ifs.eof()) {
149 binchars += count_bin_chars(str);
151 return binchars > max_bin;
155 string const latex_path(string const & original_path,
156 latex_path_extension extension,
157 latex_path_dots dots)
159 // On cygwin, we may need windows or posix style paths.
160 string path = os::latex_path(original_path);
161 path = subst(path, "~", "\\string~");
162 if (path.find(' ') != string::npos) {
163 // We can't use '"' because " is sometimes active (e.g. if
164 // babel is loaded with the "german" option)
165 if (extension == EXCLUDE_EXTENSION) {
166 // changeExtension calls os::internal_path internally
167 // so don't use it to remove the extension.
168 string const ext = getExtension(path);
169 string const base = ext.empty() ?
171 path.substr(0, path.length() - ext.length() - 1);
172 // changeExtension calls os::internal_path internally
173 // so don't use it to re-add the extension.
174 path = "\\string\"" + base + "\\string\"." + ext;
176 path = "\\string\"" + path + "\\string\"";
180 if (dots != ESCAPE_DOTS)
183 // Replace dots with the lyxdot macro, but only in the file name,
184 // not the directory part.
185 // addName etc call os::internal_path internally
186 // so don't use them for path manipulation
187 // The directory separator is always '/' for LaTeX.
188 string::size_type pos = path.rfind('/');
189 if (pos == string::npos)
190 return subst(path, ".", "\\lyxdot ");
191 return path.substr(0, pos) + subst(path.substr(pos), ".", "\\lyxdot ");
195 // Substitutes spaces with underscores in filename (and path)
196 FileName const makeLatexName(FileName const & file)
198 string name = file.onlyFileName();
199 string const path = file.onlyPath().absFileName() + "/";
201 // ok so we scan through the string twice, but who cares.
202 // FIXME: in Unicode time this will break for sure! There is
203 // a non-latin world out there...
204 string const keep = "abcdefghijklmnopqrstuvwxyz"
205 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
206 "@!'()*+,-./0123456789:;<=>?[]`|";
208 string::size_type pos = 0;
209 while ((pos = name.find_first_not_of(keep, pos)) != string::npos)
212 FileName latex_name(path + name);
213 latex_name.changeExtension(".tex");
218 string const quoteName(string const & name, quote_style style)
222 // This does not work on native Windows for filenames
223 // containing the following characters < > : " / \ | ? *
224 // Moreover, it can't be made to work, as, according to
225 // http://msdn.microsoft.com/en-us/library/aa365247(VS.85).aspx
226 // those are reserved characters, and thus are forbidden.
227 // Please, also note that the command-line parser in
228 // ForkedCall::generateChild cannot deal with filenames
229 // containing " or ', therefore we don't pass user filenames
230 // to child processes if possible. We store them in a python
231 // script instead, where we don't have these limitations.
233 return (os::shell() == os::UNIX) ?
234 '\'' + subst(name, "'", "\'\\\'\'") + '\'' :
237 // According to the QProcess parser, a single double
238 // quote is represented by three consecutive ones.
239 // Here we simply escape the double quote and let our
240 // simple parser in Systemcall.cpp do the substitution.
241 return '"' + subst(name, "\"", "\\\"") + '"';
243 case quote_shell_filename:
244 return quoteName(os::external_path(name), quote_shell);
246 return "\"" + subst(subst(name, "\\", "\\\\"), "\"", "\\\"")
249 // shut up stupid compiler
255 // Uses a string of paths separated by ";"s to find a file to open.
256 // Can't cope with pathnames with a ';' in them. Returns full path to file.
257 // If path entry begins with $$LyX/, use system_lyxdir
258 // If path entry begins with $$User/, use user_lyxdir
259 // Example: "$$User/doc;$$LyX/doc"
260 FileName const fileOpenSearch(string const & path, string const & name,
265 bool notfound = true;
266 string tmppath = split(path, path_element, ';');
268 while (notfound && !path_element.empty()) {
269 path_element = os::internal_path(path_element);
270 if (!suffixIs(path_element, '/'))
272 path_element = subst(path_element, "$$LyX",
273 package().system_support().absFileName());
274 path_element = subst(path_element, "$$User",
275 package().user_support().absFileName());
277 real_file = fileSearch(path_element, name, ext);
279 if (real_file.empty()) {
281 tmppath = split(tmppath, path_element, ';');
282 } while (!tmppath.empty() && path_element.empty());
292 // Returns the real name of file name in directory path, with optional
294 FileName const fileSearch(string const & path, string const & name,
295 string const & ext, search_mode mode)
297 // if `name' is an absolute path, we ignore the setting of `path'
298 // Expand Environmentvariables in 'name'
299 string const tmpname = replaceEnvironmentPath(name);
300 FileName fullname(makeAbsPath(tmpname, path));
301 // search first without extension, then with it.
302 if (fullname.isReadableFile())
306 return mode == may_not_exist ? fullname : FileName();
307 // Only add the extension if it is not already the extension of
309 if (getExtension(fullname.absFileName()) != ext) {
310 if (mode == check_hidpi) {
311 FileName fullname2x = FileName(addExtension(fullname.absFileName() + "@2x", ext));
312 if (fullname2x.isReadableFile())
315 fullname = FileName(addExtension(fullname.absFileName(), ext));
317 if (fullname.isReadableFile() || mode == may_not_exist)
323 // Search the file name.ext in the subdirectory dir of
325 // 2) build_lyxdir (if not empty)
327 FileName const libFileSearch(string const & dir, string const & name,
328 string const & ext, search_mode mode)
330 FileName fullname = fileSearch(addPath(package().user_support().absFileName(), dir),
332 if (!fullname.empty())
335 if (!package().build_support().empty())
336 fullname = fileSearch(addPath(package().build_support().absFileName(), dir),
338 if (!fullname.empty())
341 return fileSearch(addPath(package().system_support().absFileName(), dir),
346 FileName const i18nLibFileSearch(string const & dir, string const & name,
349 /* The highest priority value is the `LANGUAGE' environment
350 variable. But we don't use the value if the currently
351 selected locale is the C locale. This is a GNU extension.
353 Otherwise, w use a trick to guess what support/gettext.has done:
354 each po file is able to tell us its name. (JMarc)
357 string lang = getGuiMessages().language();
358 string const language = getEnv("LANGUAGE");
359 if (!lang.empty() && !language.empty())
363 lang = split(lang, l, ':');
366 // First try with the full name
367 tmp = libFileSearch(addPath(dir, l), name, ext);
371 // Then the name without country code
372 string const shortl = token(l, '_', 0);
374 tmp = libFileSearch(addPath(dir, shortl), name, ext);
380 // For compatibility, to be removed later (JMarc)
381 tmp = libFileSearch(dir, token(l, '_', 0) + '_' + name,
384 lyxerr << "i18nLibFileSearch: File `" << tmp
385 << "' has been found by the old method" <<endl;
389 lang = split(lang, l, ':');
392 return libFileSearch(dir, name, ext);
396 FileName const imageLibFileSearch(string & dir, string const & name,
397 string const & ext, search_mode mode)
399 if (!lyx::lyxrc.icon_set.empty()) {
400 string const imagedir = addPath(dir, lyx::lyxrc.icon_set);
401 FileName const fn = libFileSearch(imagedir, name, ext, mode);
407 return libFileSearch(dir, name, ext, mode);
411 int iconScaleFactor(FileName const & image)
413 int imgsize = QImage(toqstr(image.absFileName())).height();
420 string dir = "images";
421 FileName const fn = imageLibFileSearch(dir, "iconsize.png");
423 iconsize = QImage(toqstr(fn.absFileName())).height();
425 return (100 * iconsize + imgsize / 2)/imgsize;
429 string const commandPrep(string const & command_in)
431 static string const token_scriptpath = "$$s/";
432 string const python_call = "python -tt";
434 string command = command_in;
435 if (prefixIs(command_in, python_call))
436 command = os::python() + command_in.substr(python_call.length());
438 // Find the starting position of "$$s/"
439 string::size_type const pos1 = command.find(token_scriptpath);
440 if (pos1 == string::npos)
442 // Find the end of the "$$s/some_subdir/some_script" word within
443 // command. Assumes that the script name does not contain spaces.
444 string::size_type const start_script = pos1 + 4;
445 string::size_type const pos2 = command.find(' ', start_script);
446 string::size_type const size_script = pos2 == string::npos?
447 (command.size() - start_script) : pos2 - start_script;
449 // Does this script file exist?
450 string const script =
451 libFileSearch(".", command.substr(start_script, size_script)).absFileName();
453 if (script.empty()) {
454 // Replace "$$s/" with ""
455 command.erase(pos1, 4);
457 quote_style style = quote_shell;
458 if (prefixIs(command, os::python()))
459 style = quote_python;
461 // Replace "$$s/foo/some_script" with "<path to>/some_script".
462 string::size_type const size_replace = size_script + 4;
463 command.replace(pos1, size_replace, quoteName(script, style));
470 static string createTempFile(QString const & mask)
472 // FIXME: This is not safe. QTemporaryFile creates a file in open(),
473 // but the file is deleted when qt_tmp goes out of scope.
474 // Therefore the next call to createTempFile() may create the
475 // same file again. To make this safe the QTemporaryFile object
476 // needs to be kept for the whole life time of the temp file name.
477 // This could be achieved by creating a class TempDir (like
478 // TempFile, but using a currentlky non-existing
479 // QTemporaryDirectory object).
480 QTemporaryFile qt_tmp(mask + ".XXXXXXXXXXXX");
482 string const temp_file = fromqstr(qt_tmp.fileName());
483 LYXERR(Debug::FILES, "Temporary file `" << temp_file << "' created.");
486 LYXERR(Debug::FILES, "Unable to create temporary file with following template: "
487 << qt_tmp.fileTemplate());
492 static FileName createTmpDir(FileName const & tempdir, string const & mask)
494 LYXERR(Debug::FILES, "createTmpDir: tempdir=`" << tempdir << "'\n"
495 << "createTmpDir: mask=`" << mask << '\'');
497 QFileInfo tmp_fi(QDir(toqstr(tempdir.absFileName())), toqstr(mask));
498 FileName const tmpfl(createTempFile(tmp_fi.absoluteFilePath()));
500 if (tmpfl.empty() || !tmpfl.createDirectory(0700)) {
501 LYXERR0("LyX could not create temporary directory in " << tempdir
510 FileName const createLyXTmpDir(FileName const & deflt)
512 if (deflt.empty() || deflt == package().system_temp_dir())
513 return createTmpDir(package().system_temp_dir(), "lyx_tmpdir");
515 if (deflt.createDirectory(0777))
518 if (deflt.isDirWritable()) {
519 // deflt could not be created because it
520 // did exist already, so let's create our own
522 return createTmpDir(deflt, "lyx_tmpdir");
524 // some other error occurred.
525 return createTmpDir(package().system_temp_dir(), "lyx_tmpdir");
530 // Strip filename from path name
531 string const onlyPath(string const & filename)
533 // If empty filename, return empty
534 if (filename.empty())
537 // Find last / or start of filename
538 size_t j = filename.rfind('/');
539 return j == string::npos ? "./" : filename.substr(0, j + 1);
543 // Convert relative path into absolute path based on a basepath.
544 // If relpath is absolute, just use that.
545 // If basepath is empty, use CWD as base.
546 // Note that basePath can be a relative path, in the sense that it may
547 // not begin with "/" (e.g.), but it should NOT contain such constructs
549 // FIXME It might be nice if the code didn't simply assume that.
550 FileName const makeAbsPath(string const & relPath, string const & basePath)
552 // checks for already absolute path
553 if (FileName::isAbsolute(relPath))
554 return FileName(relPath);
556 // Copies given paths
557 string tempRel = os::internal_path(relPath);
558 // Since TempRel is NOT absolute, we can safely replace "//" with "/"
559 tempRel = subst(tempRel, "//", "/");
563 if (FileName::isAbsolute(basePath))
566 tempBase = addPath(FileName::getcwd().absFileName(), basePath);
568 // Handle /./ at the end of the path
569 while (suffixIs(tempBase, "/./"))
570 tempBase.erase(tempBase.length() - 2);
572 // processes relative path
573 string rTemp = tempRel;
576 // Check for a leading "~"
578 rTemp = split(rTemp, temp, '/');
580 tempBase = Package::get_home_dir().absFileName();
585 while (!rTemp.empty()) {
587 rTemp = split(rTemp, temp, '/');
589 if (temp == ".") continue;
591 // Remove one level of TempBase
592 if (tempBase.length() <= 1) {
593 //this is supposed to be an absolute path, so...
597 //erase a trailing slash if there is one
598 if (suffixIs(tempBase, "/"))
599 tempBase.erase(tempBase.length() - 1, string::npos);
601 string::size_type i = tempBase.length() - 1;
602 while (i > 0 && tempBase[i] != '/')
605 tempBase.erase(i, string::npos);
608 } else if (temp.empty() && !rTemp.empty()) {
609 tempBase = os::current_root() + rTemp;
612 // Add this piece to TempBase
613 if (!suffixIs(tempBase, '/'))
619 // returns absolute path
620 return FileName(tempBase);
624 // Correctly append filename to the pathname.
625 // If pathname is '.', then don't use pathname.
626 // Chops any path of filename.
627 string const addName(string const & path, string const & fname)
629 string const basename = onlyFileName(fname);
632 if (path != "." && path != "./" && !path.empty()) {
633 buf = os::internal_path(path);
634 if (!suffixIs(path, '/'))
638 return buf + basename;
642 // Strips path from filename
643 string const onlyFileName(string const & fname)
648 string::size_type j = fname.rfind('/');
649 if (j == string::npos) // no '/' in fname
653 return fname.substr(j + 1);
657 // Create absolute path. If impossible, don't do anything
658 // Supports ./ and ~/. Later we can add support for ~logname/. (Asger)
659 string const expandPath(string const & path)
661 // checks for already absolute path
662 string rTemp = replaceEnvironmentPath(path);
663 if (FileName::isAbsolute(rTemp))
667 string const copy = rTemp;
670 rTemp = split(rTemp, temp, '/');
673 return FileName::getcwd().absFileName() + '/' + rTemp;
676 return Package::get_home_dir().absFileName() + '/' + rTemp;
679 return makeAbsPath(copy).absFileName();
681 // Don't know how to handle this
686 // Search the string for ${VAR} and $VAR and replace VAR using getenv.
687 string const replaceEnvironmentPath(string const & path)
689 // ${VAR} is defined as
690 // $\{[A-Za-z_][A-Za-z_0-9]*\}
691 static string const envvar_br = "[$]\\{([A-Za-z_][A-Za-z_0-9]*)\\}";
693 // $VAR is defined as:
694 // $[A-Za-z_][A-Za-z_0-9]*
695 static string const envvar = "[$]([A-Za-z_][A-Za-z_0-9]*)";
697 static regex const envvar_br_re("(.*)" + envvar_br + "(.*)");
698 static regex const envvar_re("(.*)" + envvar + "(.*)");
699 string result = path;
702 if (!regex_match(result, what, envvar_br_re)) {
703 if (!regex_match(result, what, envvar_re))
706 string env_var = getEnv(what.str(2));
707 result = what.str(1) + env_var + what.str(3);
713 // Return a command prefix for setting the environment of the TeX engine.
714 string latexEnvCmdPrefix(string const & path)
716 if (path.empty() || lyxrc.texinputs_prefix.empty())
719 string const texinputs_prefix = os::latex_path_list(
720 replaceCurdirPath(path, lyxrc.texinputs_prefix));
721 string const sep = string(1, os::path_separator(os::TEXENGINE));
722 string const texinputs = getEnv("TEXINPUTS");
724 if (os::shell() == os::UNIX)
725 return "env TEXINPUTS=\"." + sep + texinputs_prefix
726 + sep + texinputs + "\" ";
729 return "cmd /d /c set \"TEXINPUTS=."
730 + sep + texinputs_prefix
731 + sep + texinputs + "\"&";
733 return "cmd /d /c set \"\"\"TEXINPUTS=."
734 + sep + texinputs_prefix
735 + 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 const head = dstr.substr(0, threshold / 2 - 3);
948 docstring::size_type len = dstr.length();
949 docstring const tail =
950 dstr.substr(len - threshold / 2 - 2, len - 1);
951 dstr = head + from_ascii("...") + tail;
954 return from_utf8(os::external_path(prefix + to_utf8(dstr)));
959 bool readLink(FileName const & file, FileName & link)
961 string const encoded = file.toFilesystemEncoding();
962 #ifdef HAVE_DEF_PATH_MAX
963 char linkbuffer[PATH_MAX + 1];
964 ssize_t const nRead = ::readlink(encoded.c_str(),
965 linkbuffer, sizeof(linkbuffer) - 1);
968 linkbuffer[nRead] = '\0'; // terminator
970 vector<char> buf(1024);
974 nRead = ::readlink(encoded.c_str(), &buf[0], buf.size() - 1);
978 if (static_cast<size_t>(nRead) < buf.size() - 1) {
981 buf.resize(buf.size() * 2);
983 buf[nRead] = '\0'; // terminator
984 const char * linkbuffer = &buf[0];
986 link = makeAbsPath(linkbuffer, onlyPath(file.absFileName()));
990 bool readLink(FileName const &, FileName &)
997 cmd_ret const runCommand(string const & cmd)
999 // FIXME: replace all calls to RunCommand with ForkedCall
1000 // (if the output is not needed) or the code in ISpell.cpp
1001 // (if the output is needed).
1003 // One question is if we should use popen or
1004 // create our own popen based on fork, exec, pipe
1005 // of course the best would be to have a
1006 // pstream (process stream), with the
1007 // variants ipstream, opstream
1009 #if defined (_WIN32)
1011 STARTUPINFO startup;
1012 PROCESS_INFORMATION process;
1013 SECURITY_ATTRIBUTES security;
1016 bool err2out = false;
1018 string const infile = trim(split(cmd, command, '<'), " \"");
1019 command = rtrim(command);
1020 if (suffixIs(command, "2>&1")) {
1021 command = rtrim(command, "2>&1");
1024 string const cmdarg = "/d /c " + command;
1025 string const comspec = getEnv("COMSPEC");
1027 security.nLength = sizeof(SECURITY_ATTRIBUTES);
1028 security.bInheritHandle = TRUE;
1029 security.lpSecurityDescriptor = NULL;
1031 if (CreatePipe(&in, &out, &security, 0)) {
1032 memset(&startup, 0, sizeof(STARTUPINFO));
1033 memset(&process, 0, sizeof(PROCESS_INFORMATION));
1035 startup.cb = sizeof(STARTUPINFO);
1036 startup.dwFlags = STARTF_USESTDHANDLES;
1038 startup.hStdError = err2out ? out : GetStdHandle(STD_ERROR_HANDLE);
1039 startup.hStdInput = infile.empty()
1040 ? GetStdHandle(STD_INPUT_HANDLE)
1041 : CreateFile(infile.c_str(), GENERIC_READ,
1042 FILE_SHARE_READ, &security, OPEN_EXISTING,
1043 FILE_ATTRIBUTE_NORMAL, NULL);
1044 startup.hStdOutput = out;
1046 if (startup.hStdInput != INVALID_HANDLE_VALUE &&
1047 CreateProcess(comspec.c_str(), (LPTSTR)cmdarg.c_str(),
1048 &security, &security, TRUE, CREATE_NO_WINDOW,
1049 0, 0, &startup, &process)) {
1051 CloseHandle(process.hThread);
1052 fno = _open_osfhandle((long)in, _O_RDONLY);
1054 inf = _fdopen(fno, "r");
1057 #elif defined (HAVE_POPEN)
1058 FILE * inf = ::popen(cmd.c_str(), os::popen_read_mode());
1059 #elif defined (HAVE__POPEN)
1060 FILE * inf = ::_popen(cmd.c_str(), os::popen_read_mode());
1062 #error No popen() function.
1065 // (Claus Hentschel) Check if popen was successful ;-)
1067 lyxerr << "RunCommand:: could not start child process" << endl;
1068 return make_pair(-1, string());
1074 ret += static_cast<char>(c);
1078 #if defined (_WIN32)
1079 WaitForSingleObject(process.hProcess, INFINITE);
1080 if (!infile.empty())
1081 CloseHandle(startup.hStdInput);
1082 CloseHandle(process.hProcess);
1083 int const pret = fclose(inf);
1084 #elif defined (HAVE_PCLOSE)
1085 int const pret = pclose(inf);
1086 #elif defined (HAVE__PCLOSE)
1087 int const pret = _pclose(inf);
1089 #error No pclose() function.
1093 perror("RunCommand:: could not terminate child process");
1095 return make_pair(pret, ret);
1099 FileName const findtexfile(string const & fil, string const & /*format*/)
1101 /* There is no problem to extend this function too use other
1102 methods to look for files. It could be setup to look
1103 in environment paths and also if wanted as a last resort
1104 to a recursive find. One of the easier extensions would
1105 perhaps be to use the LyX file lookup methods. But! I am
1106 going to implement this until I see some demand for it.
1110 // If the file can be found directly, we just return a
1111 // absolute path version of it.
1112 FileName const absfile(makeAbsPath(fil));
1113 if (absfile.exists())
1116 // Now we try to find it using kpsewhich.
1117 // It seems from the kpsewhich manual page that it is safe to use
1118 // kpsewhich without --format: "When the --format option is not
1119 // given, the search path used when looking for a file is inferred
1120 // from the name given, by looking for a known extension. If no
1121 // known extension is found, the search path for TeX source files
1123 // However, we want to take advantage of the format sine almost all
1124 // the different formats has environment variables that can be used
1125 // to controll which paths to search. f.ex. bib looks in
1126 // BIBINPUTS and TEXBIB. Small list follows:
1127 // bib - BIBINPUTS, TEXBIB
1129 // graphic/figure - TEXPICTS, TEXINPUTS
1130 // ist - TEXINDEXSTYLE, INDEXSTYLE
1131 // pk - PROGRAMFONTS, PKFONTS, TEXPKS, GLYPHFONTS, TEXFONTS
1133 // tfm - TFMFONTS, TEXFONTS
1134 // This means that to use kpsewhich in the best possible way we
1135 // should help it by setting additional path in the approp. envir.var.
1136 string const kpsecmd = "kpsewhich " + fil;
1138 cmd_ret const c = runCommand(kpsecmd);
1140 LYXERR(Debug::LATEX, "kpse status = " << c.first << '\n'
1141 << "kpse result = `" << rtrim(c.second, "\n\r") << '\'');
1143 return FileName(rtrim(to_utf8(from_filesystem8bit(c.second)), "\n\r"));
1149 int compare_timestamps(FileName const & file1, FileName const & file2)
1151 // If the original is newer than the copy, then copy the original
1152 // to the new directory.
1155 if (file1.exists() && file2.exists()) {
1156 double const tmp = difftime(file1.lastModified(), file2.lastModified());
1158 cmp = tmp > 0 ? 1 : -1;
1160 } else if (file1.exists()) {
1162 } else if (file2.exists()) {
1170 bool prefs2prefs(FileName const & filename, FileName const & tempfile, bool lfuns)
1172 FileName const script = libFileSearch("scripts", "prefs2prefs.py");
1173 if (script.empty()) {
1174 LYXERR0("Could not find bind file conversion "
1175 "script prefs2prefs.py.");
1179 ostringstream command;
1180 command << os::python() << ' ' << quoteName(script.toFilesystemEncoding())
1181 << ' ' << (lfuns ? "-l" : "-p") << ' '
1182 << quoteName(filename.toFilesystemEncoding())
1183 << ' ' << quoteName(tempfile.toFilesystemEncoding());
1184 string const command_str = command.str();
1186 LYXERR(Debug::FILES, "Running `" << command_str << '\'');
1188 cmd_ret const ret = runCommand(command_str);
1189 if (ret.first != 0) {
1190 LYXERR0("Could not run file conversion script prefs2prefs.py.");
1197 bool configFileNeedsUpdate(string const & file)
1199 // We cannot initialize configure_script directly because the package
1200 // is not initialized yet when static objects are constructed.
1201 static FileName configure_script;
1202 static bool firstrun = true;
1205 FileName(addName(package().system_support().absFileName(),
1211 FileName(addName(package().user_support().absFileName(), file));
1212 return !absfile.exists()
1213 || configure_script.lastModified() > absfile.lastModified();
1217 int fileLock(const char * lock_file)
1220 #if defined(HAVE_LOCKF)
1221 fd = open(lock_file, O_CREAT|O_APPEND|O_SYNC|O_RDWR, 0666);
1222 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