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
24 #include "support/filetools.h"
29 #include "support/convert.h"
30 #include "support/debug.h"
31 #include "support/environment.h"
32 #include "support/gettext.h"
33 #include "support/lstrings.h"
34 #include "support/os.h"
35 #include "support/Messages.h"
36 #include "support/Package.h"
37 #include "support/PathChanger.h"
38 #include "support/Systemcall.h"
39 #include "support/qstring_helpers.h"
40 #include "support/TempFile.h"
44 #include "support/lassert.h"
77 bool isLyXFileName(string const & filename)
79 return suffixIs(ascii_lowercase(filename), ".lyx");
83 bool isSGMLFileName(string const & filename)
85 return suffixIs(ascii_lowercase(filename), ".sgml");
89 bool isValidLaTeXFileName(string const & filename)
91 string const invalid_chars("#%\"");
92 return filename.find_first_of(invalid_chars) == string::npos;
96 bool isValidDVIFileName(string const & filename)
98 string const invalid_chars("${}()[]^");
99 return filename.find_first_of(invalid_chars) == string::npos;
103 bool isBinaryFile(FileName const & filename)
105 bool isbinary = false;
106 if (filename.empty() || !filename.exists())
110 magic_t magic_cookie = magic_open(MAGIC_MIME_ENCODING);
112 bool detected = true;
113 if (magic_load(magic_cookie, nullptr) != 0) {
114 LYXERR(Debug::FILES, "isBinaryFile: "
115 "Could not load magic database - "
116 << magic_error(magic_cookie));
119 char const *charset = magic_file(magic_cookie,
120 filename.toFilesystemEncoding().c_str());
121 isbinary = contains(charset, "binary");
123 magic_close(magic_cookie);
128 // Try by looking for binary chars at the beginning of the file.
129 // Note that this is formally not correct, since count_bin_chars
130 // expects utf8, and the passed string can be anything: plain text
131 // in any encoding, or really binary data. In practice it works,
132 // since QString::fromUtf8() drops invalid utf8 sequences, and
133 // while the exact number may not be correct, we still get a high
134 // number for truly binary files.
136 ifstream ifs(filename.toFilesystemEncoding().c_str());
140 // Maximum strings to read
141 int const max_count = 50;
143 // Maximum number of binary chars allowed
144 int const max_bin = 5;
149 while (count++ < max_count && !ifs.eof()) {
151 binchars += count_bin_chars(str);
153 return binchars > max_bin;
157 string const latex_path(string const & original_path,
158 latex_path_extension extension,
159 latex_path_dots dots)
161 // On cygwin, we may need windows or posix style paths.
162 string path = os::latex_path(original_path);
163 path = subst(path, "~", "\\string~");
164 if (path.find(' ') != string::npos) {
165 // We can't use '"' because " is sometimes active (e.g. if
166 // babel is loaded with the "german" option)
167 if (extension == EXCLUDE_EXTENSION) {
168 // changeExtension calls os::internal_path internally
169 // so don't use it to remove the extension.
170 string const ext = getExtension(path);
171 string const base = ext.empty() ?
173 path.substr(0, path.length() - ext.length() - 1);
174 // changeExtension calls os::internal_path internally
175 // so don't use it to re-add the extension.
176 path = "\\string\"" + base + "\\string\"." + ext;
178 path = "\\string\"" + path + "\\string\"";
182 if (dots != ESCAPE_DOTS)
185 // Replace dots with the lyxdot macro, but only in the file name,
186 // not the directory part.
187 // addName etc call os::internal_path internally
188 // so don't use them for path manipulation
189 // The directory separator is always '/' for LaTeX.
190 string::size_type pos = path.rfind('/');
191 if (pos == string::npos)
192 return subst(path, ".", "\\lyxdot ");
193 return path.substr(0, pos) + subst(path.substr(pos), ".", "\\lyxdot ");
197 // Substitutes spaces with underscores in filename (and path)
198 FileName const makeLatexName(FileName const & file)
200 string name = file.onlyFileName();
201 string const path = file.onlyPath().absFileName() + "/";
203 // ok so we scan through the string twice, but who cares.
204 // FIXME: in Unicode time this will break for sure! There is
205 // a non-latin world out there...
206 string const keep = "abcdefghijklmnopqrstuvwxyz"
207 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
208 "@!'()*+,-./0123456789:;<=>?[]`|";
210 string::size_type pos = 0;
211 while ((pos = name.find_first_not_of(keep, pos)) != string::npos)
214 FileName latex_name(path + name);
215 latex_name.changeExtension(".tex");
220 string const quoteName(string const & name, quote_style style)
224 // This does not work on native Windows for filenames
225 // containing the following characters < > : " / \ | ? *
226 // Moreover, it can't be made to work, as, according to
227 // http://msdn.microsoft.com/en-us/library/aa365247(VS.85).aspx
228 // those are reserved characters, and thus are forbidden.
229 // Please, also note that the command-line parser in
230 // ForkedCall::generateChild cannot deal with filenames
231 // containing " or ', therefore we don't pass user filenames
232 // to child processes if possible. We store them in a python
233 // script instead, where we don't have these limitations.
235 return (os::shell() == os::UNIX) ?
236 '\'' + subst(name, "'", "\'\\\'\'") + '\'' :
239 // According to the QProcess parser, a single double
240 // quote is represented by three consecutive ones.
241 // Here we simply escape the double quote and let our
242 // simple parser in Systemcall.cpp do the substitution.
243 return '"' + subst(name, "\"", "\\\"") + '"';
245 case quote_shell_filename:
246 return quoteName(os::external_path(name), quote_shell);
248 return "\"" + subst(subst(name, "\\", "\\\\"), "\"", "\\\"")
251 // shut up stupid compiler
257 // Uses a string of paths separated by ";"s to find a file to open.
258 // Can't cope with pathnames with a ';' in them. Returns full path to file.
259 // If path entry begins with $$LyX/, use system_lyxdir
260 // If path entry begins with $$User/, use user_lyxdir
261 // Example: "$$User/doc;$$LyX/doc"
262 FileName const fileOpenSearch(string const & path, string const & name,
267 bool notfound = true;
268 string tmppath = split(path, path_element, ';');
270 while (notfound && !path_element.empty()) {
271 path_element = os::internal_path(path_element);
272 if (!suffixIs(path_element, '/'))
274 path_element = subst(path_element, "$$LyX",
275 package().system_support().absFileName());
276 path_element = subst(path_element, "$$User",
277 package().user_support().absFileName());
279 real_file = fileSearch(path_element, name, ext);
281 if (real_file.empty()) {
283 tmppath = split(tmppath, path_element, ';');
284 } while (!tmppath.empty() && path_element.empty());
294 // Returns the real name of file name in directory path, with optional
296 FileName const fileSearch(string const & path, string const & name,
297 string const & exts, search_mode mode)
299 // if `name' is an absolute path, we ignore the setting of `path'
300 // Expand Environmentvariables in 'name'
301 string const tmpname = replaceEnvironmentPath(name);
302 FileName fullname(makeAbsPath(tmpname, path));
303 // search first without extension, then with it.
304 if (fullname.isReadableFile())
308 return mode == may_not_exist ? fullname : FileName();
310 string ext = token(exts, ',', n);
311 while (!ext.empty()) {
312 // Only add the extension if it is not already the extension of
314 bool addext = getExtension(fullname.absFileName()) != ext;
316 if (mode == check_hidpi) {
317 FileName fullname2x = FileName(addExtension(fullname.absFileName() + "@2x", ext));
318 if (fullname2x.isReadableFile())
321 fullname = FileName(addExtension(fullname.absFileName(), ext));
323 if (fullname.isReadableFile() || mode == may_not_exist)
326 fullname.changeExtension("");
327 ext = token(exts, ',', ++n);
333 // Search the file name.ext in the subdirectory dir of
335 // 2) build_lyxdir (if not empty)
337 FileName const libFileSearch(string const & dir, string const & name,
338 string const & ext, search_mode mode,
339 bool const only_global)
343 fullname = fileSearch(addPath(package().user_support().absFileName(), dir),
345 if (!fullname.empty())
349 if (!package().build_support().empty())
350 fullname = fileSearch(addPath(package().build_support().absFileName(), dir),
352 if (!fullname.empty())
355 return fileSearch(addPath(package().system_support().absFileName(), dir),
360 FileName const i18nLibFileSearch(string const & dir, string const & name,
363 // if the LANGUAGE variable is set, use it as a fallback for searching for files.
364 string lang = getGuiMessages().language();
365 string const language = getEnv("LANGUAGE");
366 if (!language.empty())
367 lang += ":" + language;
369 for (auto const & l : getVectorFromString(lang, ":")) {
371 // First try with the full name
372 // `en' files are not in a subdirectory
374 tmp = libFileSearch(dir, name, ext);
376 tmp = libFileSearch(addPath(dir, l), name, ext);
380 // Then the name without country code
381 string const shortl = token(l, '_', 0);
383 tmp = libFileSearch(addPath(dir, shortl), name, ext);
389 return libFileSearch(dir, name, ext);
393 FileName const imageLibFileSearch(string & dir, string const & name,
394 string const & ext, search_mode mode)
396 if (!lyx::lyxrc.icon_set.empty()) {
397 string const imagedir = addPath(dir, lyx::lyxrc.icon_set);
398 FileName const fn = libFileSearch(imagedir, name, ext, mode);
404 return libFileSearch(dir, name, ext, mode);
408 string const commandPrep(string const & command_in)
410 static string const token_scriptpath = "$$s/";
411 string const python_call = "python -tt";
413 string command = command_in;
414 if (prefixIs(command_in, python_call))
415 command = os::python() + command_in.substr(python_call.length());
417 // Find the starting position of "$$s/"
418 string::size_type const pos1 = command.find(token_scriptpath);
419 if (pos1 == string::npos)
421 // Find the end of the "$$s/some_subdir/some_script" word within
422 // command. Assumes that the script name does not contain spaces.
423 string::size_type const start_script = pos1 + 4;
424 string::size_type const pos2 = command.find(' ', start_script);
425 string::size_type const size_script = pos2 == string::npos?
426 (command.size() - start_script) : pos2 - start_script;
428 // Does this script file exist?
429 string const script =
430 libFileSearch(".", command.substr(start_script, size_script)).absFileName();
432 if (script.empty()) {
433 // Replace "$$s/" with ""
434 command.erase(pos1, 4);
436 quote_style style = quote_shell;
437 if (prefixIs(command, os::python()))
438 style = quote_python;
440 // Replace "$$s/foo/some_script" with "<path to>/some_script".
441 string::size_type const size_replace = size_script + 4;
442 command.replace(pos1, size_replace, quoteName(script, style));
449 FileName const tempFileName(FileName const & tempdir, string const & mask, bool const dir)
451 return tempFileName(TempFile(tempdir, mask).name(), dir);
455 FileName const tempFileName(string const & mask, bool const dir)
457 return tempFileName(TempFile(mask).name(), dir);
461 FileName const tempFileName(FileName tempfile, bool const dir)
463 // Since the QTemporaryFile object is destroyed at function return
464 // (which is what is intended here), the next call to this function
465 // may return the same file name again.
466 // Thus, in order to prevent race conditions, we track returned names
467 // and create our own unique names if QTemporaryFile returns a name again.
468 if (tmp_names_.find(tempfile.absFileName()) == tmp_names_.end()) {
469 tmp_names_.insert(tempfile.absFileName());
473 // OK, we need another name. Simply append digits.
474 FileName tmp = tempfile;
477 // Store and remove extensions
478 ext = "." + tempfile.extension();
479 tmp.changeExtension("");
481 for (int i = 1; i < INT_MAX ;++i) {
482 // Append digit to filename and re-add extension
483 string const new_fn =
484 tmp.absFileName() + convert<string>(i) + ext;
485 if (tmp_names_.find(new_fn) == tmp_names_.end()) {
486 tmp_names_.insert(new_fn);
487 tempfile.set(new_fn);
492 // This should not happen!
493 LYXERR0("tempFileName(): Could not create unique temp file name!");
498 void removeTempFile(FileName const & fn)
503 string const abs = fn.absFileName();
504 tmp_names_.erase(abs);
509 static FileName createTmpDir(FileName const & tempdir, string const & mask)
511 LYXERR(Debug::FILES, "createTmpDir: tempdir=`" << tempdir << "'\n"
512 << "createTmpDir: mask=`" << mask << '\'');
514 QFileInfo tmp_fi(QDir(toqstr(tempdir.absFileName())), toqstr(mask));
515 FileName const tmpfl =
516 tempFileName(FileName(fromqstr(tmp_fi.absolutePath())),
517 fromqstr(tmp_fi.fileName()) + ".XXXXXXXXXXXX", true);
519 if (tmpfl.empty() || !tmpfl.createDirectory(0700)) {
520 LYXERR0("LyX could not create temporary directory in " << tempdir
529 FileName const createLyXTmpDir(FileName const & deflt)
531 if (deflt.empty() || deflt == package().system_temp_dir())
532 return createTmpDir(package().system_temp_dir(), "lyx_tmpdir");
534 if (deflt.createDirectory(0777))
537 if (deflt.isDirWritable()) {
538 // deflt could not be created because it
539 // did exist already, so let's create our own
541 return createTmpDir(deflt, "lyx_tmpdir");
543 // some other error occurred.
544 return createTmpDir(package().system_temp_dir(), "lyx_tmpdir");
549 // Strip filename from path name
550 string const onlyPath(string const & filename)
552 // If empty filename, return empty
553 if (filename.empty())
556 // Find last / or start of filename
557 size_t j = filename.rfind('/');
558 return j == string::npos ? "./" : filename.substr(0, j + 1);
562 // Convert relative path into absolute path based on a basepath.
563 // If relpath is absolute, just use that.
564 // If basepath is empty, use CWD as base.
565 // Note that basePath can be a relative path, in the sense that it may
566 // not begin with "/" (e.g.), but it should NOT contain such constructs
568 // FIXME It might be nice if the code didn't simply assume that.
569 FileName const makeAbsPath(string const & relPath, string const & basePath)
571 // checks for already absolute path
572 if (FileName::isAbsolute(relPath))
573 return FileName(relPath);
575 // Copies given paths
576 string tempRel = os::internal_path(relPath);
577 // Since TempRel is NOT absolute, we can safely replace "//" with "/"
578 tempRel = subst(tempRel, "//", "/");
582 if (FileName::isAbsolute(basePath))
585 tempBase = addPath(FileName::getcwd().absFileName(), basePath);
587 // Handle /./ at the end of the path
588 while (suffixIs(tempBase, "/./"))
589 tempBase.erase(tempBase.length() - 2);
591 // processes relative path
592 string rTemp = tempRel;
595 // Check for a leading "~"
597 rTemp = split(rTemp, temp, '/');
599 tempBase = Package::get_home_dir().absFileName();
604 while (!rTemp.empty()) {
606 rTemp = split(rTemp, temp, '/');
608 if (temp == ".") continue;
610 // Remove one level of TempBase
611 if (tempBase.length() <= 1) {
612 //this is supposed to be an absolute path, so...
616 //erase a trailing slash if there is one
617 if (suffixIs(tempBase, "/"))
618 tempBase.erase(tempBase.length() - 1, string::npos);
620 string::size_type i = tempBase.length() - 1;
621 while (i > 0 && tempBase[i] != '/')
624 tempBase.erase(i, string::npos);
627 } else if (temp.empty() && !rTemp.empty()) {
628 tempBase = os::current_root() + rTemp;
631 // Add this piece to TempBase
632 if (!suffixIs(tempBase, '/'))
638 // returns absolute path
639 return FileName(tempBase);
643 // Correctly append filename to the pathname.
644 // If pathname is '.', then don't use pathname.
645 // Chops any path of filename.
646 string const addName(string const & path, string const & fname)
648 string const basename = onlyFileName(fname);
651 if (path != "." && path != "./" && !path.empty()) {
652 buf = os::internal_path(path);
653 if (!suffixIs(buf, '/'))
657 return buf + basename;
661 string const addPathName(std::string const & path, std::string const & fname)
663 string const pathpart = onlyPath(fname);
664 string const namepart = onlyFileName(fname);
665 string newpath = path;
666 if (!pathpart.empty())
667 newpath = addPath(newpath, pathpart);
668 if (!namepart.empty())
669 newpath = addName(newpath, namepart);
674 // Strips path from filename
675 string const onlyFileName(string const & fname)
680 string::size_type j = fname.rfind('/');
681 if (j == string::npos) // no '/' in fname
685 return fname.substr(j + 1);
689 // Search the string for ${VAR} and $VAR and replace VAR using getenv.
690 // If VAR does not exist, ${VAR} and $VAR are left as is in the string.
691 string const replaceEnvironmentPath(string const & path)
693 if (!contains(path, '$'))
696 // ${VAR} is defined as
697 // $\{[A-Za-z_][A-Za-z_0-9]*\}
698 static string const envvar_br = "[$]\\{([A-Za-z_][A-Za-z_0-9]*)\\}";
700 // $VAR is defined as:
701 // $[A-Za-z_][A-Za-z_0-9]*
702 static string const envvar = "[$]([A-Za-z_][A-Za-z_0-9]*)";
704 // Coverity thinks that the regex constructor can return an
705 // exception. We know that it is not true since our regex are
706 // hardcoded, but we have to protect against that nevertheless.
708 static regex const envvar_br_re("(.*)" + envvar_br + "(.*)");
709 static regex const envvar_re("(.*)" + envvar + "(.*)");
710 string result = path;
713 bool brackets = true;
714 if (!regex_match(result, what, envvar_br_re)) {
716 if (!regex_match(result, what, envvar_re))
719 string env_var = getEnv(what.str(2));
720 if (env_var.empty()) {
721 // temporarily use alert/bell (0x07) in place of $
723 env_var = "\a{" + what.str(2) + '}';
725 env_var = "\a" + what.str(2);
727 result = what.str(1) + env_var + what.str(3);
729 return subst(result, '\a', '$');
730 } catch (exception const & e) {
731 LYXERR0("Something is very wrong: " << e.what());
737 // Return a command prefix for setting the environment of the TeX engine.
738 string latexEnvCmdPrefix(string const & path, string const & lpath)
740 bool use_lpath = !(lpath.empty() || lpath == "." || lpath == "./");
742 if (path.empty() || (lyxrc.texinputs_prefix.empty() && !use_lpath))
745 string texinputs_prefix = lyxrc.texinputs_prefix.empty() ? string()
746 : os::latex_path_list(
747 replaceCurdirPath(path, lyxrc.texinputs_prefix));
748 string const allother_prefix = os::latex_path_list(path);
749 string const sep = string(1, os::path_separator(os::TEXENGINE));
750 string const texinputs = getEnv("TEXINPUTS");
751 string const bibinputs = getEnv("BIBINPUTS");
752 string const bstinputs = getEnv("BSTINPUTS");
753 string const texfonts = getEnv("TEXFONTS");
756 string const abslpath = FileName::isAbsolute(lpath)
757 ? os::latex_path(lpath)
758 : os::latex_path(FileName(path + "/" + lpath).realPath());
759 if (texinputs_prefix.empty())
760 texinputs_prefix = abslpath;
761 else if (suffixIs(texinputs_prefix, sep))
762 texinputs_prefix.append(abslpath + sep);
764 texinputs_prefix.append(sep + abslpath);
767 if (os::shell() == os::UNIX)
768 return "env TEXINPUTS=\"." + sep + texinputs_prefix
769 + sep + texinputs + "\" "
770 + "BIBINPUTS=\"." + sep + allother_prefix
771 + sep + bibinputs + "\" "
772 + "BSTINPUTS=\"." + sep + allother_prefix
773 + sep + bstinputs + "\" "
774 + "TEXFONTS=\"." + sep + allother_prefix
775 + sep + texfonts + "\" ";
777 // NOTE: the dummy blank dirs are necessary to force the
778 // QProcess parser to quote the argument (see bug 9453)
779 return "cmd /d /c set \"TEXINPUTS=." + sep + " "
780 + sep + texinputs_prefix
781 + sep + texinputs + "\" & "
782 + "set \"BIBINPUTS=." + sep + " "
783 + sep + allother_prefix
784 + sep + bibinputs + "\" & "
785 + "set \"BSTINPUTS=." + sep + " "
786 + sep + allother_prefix
787 + sep + bstinputs + "\" & "
788 + "set \"TEXFONTS=." + sep + " "
789 + sep + allother_prefix
790 + sep + texfonts + "\" & ";
794 // Replace current directory in all elements of a path list with a given path.
795 string const replaceCurdirPath(string const & path, string const & pathlist)
797 string const oldpathlist = replaceEnvironmentPath(pathlist);
798 char const sep = os::path_separator();
801 for (size_t i = 0, k = 0; i != string::npos; k = i) {
802 i = oldpathlist.find(sep, i);
803 string p = oldpathlist.substr(k, i - k);
804 if (FileName::isAbsolute(p)) {
810 } else if (prefixIs(p, "./")) {
812 while (p[offset] == '/')
815 newpathlist += addPath(path, p.substr(offset));
816 if (suffixIs(p, "//"))
819 if (i != string::npos) {
821 // Stop here if the last element is empty
822 if (++i == oldpathlist.length())
830 // Make relative path out of two absolute paths
831 docstring const makeRelPath(docstring const & abspath, docstring const & basepath)
832 // Makes relative path out of absolute path. If it is deeper than basepath,
833 // it's easy. If basepath and abspath share something (they are all deeper
834 // than some directory), it'll be rendered using ..'s. If they are completely
835 // different, then the absolute path will be used as relative path.
837 docstring::size_type const abslen = abspath.length();
838 docstring::size_type const baselen = basepath.length();
840 docstring::size_type i = os::common_path(abspath, basepath);
843 // actually no match - cannot make it relative
847 // Count how many dirs there are in basepath above match
848 // and append as many '..''s into relpath
850 docstring::size_type j = i;
851 while (j < baselen) {
852 if (basepath[j] == '/') {
853 if (j + 1 == baselen)
860 // Append relative stuff from common directory to abspath
861 if (abspath[i] == '/')
863 for (; i < abslen; ++i)
866 if (suffixIs(buf, '/'))
867 buf.erase(buf.length() - 1);
868 // Substitute empty with .
875 // Append sub-directory(ies) to a path in an intelligent way
876 string const addPath(string const & path, string const & path_2)
879 string const path2 = os::internal_path(path_2);
881 if (!path.empty() && path != "." && path != "./") {
882 buf = os::internal_path(path);
883 if (path[path.length() - 1] != '/')
887 if (!path2.empty()) {
888 string::size_type const p2start = path2.find_first_not_of('/');
889 string::size_type const p2end = path2.find_last_not_of('/');
890 string const tmp = path2.substr(p2start, p2end - p2start + 1);
897 string const changeExtension(string const & oldname, string const & extension)
899 string::size_type const last_slash = oldname.rfind('/');
900 string::size_type last_dot = oldname.rfind('.');
901 if (last_dot < last_slash && last_slash != string::npos)
902 last_dot = string::npos;
905 // Make sure the extension starts with a dot
906 if (!extension.empty() && extension[0] != '.')
907 ext= '.' + extension;
911 return os::internal_path(oldname.substr(0, last_dot) + ext);
915 string const removeExtension(string const & name)
917 return changeExtension(name, string());
921 string const addExtension(string const & name, string const & extension)
923 if (!extension.empty() && extension[0] != '.')
924 return name + '.' + extension;
925 return name + extension;
929 /// Return the extension of the file (not including the .)
930 string const getExtension(string const & name)
932 string::size_type const last_slash = name.rfind('/');
933 string::size_type const last_dot = name.rfind('.');
934 if (last_dot != string::npos &&
935 (last_slash == string::npos || last_dot > last_slash))
936 return name.substr(last_dot + 1,
937 name.length() - (last_dot + 1));
943 string const unzippedFileName(string const & zipped_file)
945 string const ext = getExtension(zipped_file);
946 if (ext == "gz" || ext == "z" || ext == "Z")
947 return changeExtension(zipped_file, string());
948 else if (ext == "svgz")
949 return changeExtension(zipped_file, "svg");
950 return onlyPath(zipped_file) + "unzipped_" + onlyFileName(zipped_file);
954 FileName const unzipFile(FileName const & zipped_file, string const & unzipped_file)
956 FileName const tempfile = FileName(unzipped_file.empty() ?
957 unzippedFileName(zipped_file.toFilesystemEncoding()) :
960 string const command = "gunzip -c \"" +
961 zipped_file.toFilesystemEncoding() + "\" > \"" +
962 tempfile.toFilesystemEncoding() + "\"";
964 one.startscript(Systemcall::Wait, command);
965 // test that command was executed successfully (anon)
966 // yes, please do. (Lgb)
971 docstring const makeDisplayPath(string const & path, unsigned int threshold)
975 // Recode URL encoded chars.
976 str = from_percent_encoding(str);
978 // If file is from LyXDir, display it as if it were relative.
979 string const system = package().system_support().absFileName();
980 if (prefixIs(str, system) && str != system)
981 return from_utf8("[" + str.erase(0, system.length()) + "]");
983 // replace /home/blah with ~/
984 string const home = Package::get_home_dir().absFileName();
985 if (!home.empty() && prefixIs(str, home))
986 str = subst(str, home, "~");
988 if (str.length() <= threshold)
989 return from_utf8(os::external_path(str));
991 string const prefix = ".../";
992 docstring dstr = from_utf8(str);
995 while (dstr.length() > threshold)
996 dstr = split(dstr, temp, '/');
998 // Did we shorten everything away?
1000 // Yes, filename itself is too long.
1001 // Pick the start and the end of the filename.
1002 docstring fstr = from_utf8(onlyFileName(path));
1004 if (support::truncateWithEllipsis(dstr, threshold / 2))
1005 dstr += fstr.substr(fstr.length() - threshold / 2 - 2,
1009 return from_utf8(os::external_path(prefix + to_utf8(dstr)));
1013 #ifdef HAVE_READLINK
1014 bool readLink(FileName const & file, FileName & link)
1016 string const encoded = file.toFilesystemEncoding();
1017 #ifdef HAVE_DEF_PATH_MAX
1018 char linkbuffer[PATH_MAX + 1];
1019 ssize_t const nRead = ::readlink(encoded.c_str(),
1020 linkbuffer, sizeof(linkbuffer) - 1);
1023 linkbuffer[nRead] = '\0'; // terminator
1025 vector<char> buf(1024);
1029 nRead = ::readlink(encoded.c_str(), &buf[0], buf.size() - 1);
1033 if (static_cast<size_t>(nRead) < buf.size() - 1) {
1036 buf.resize(buf.size() * 2);
1038 buf[nRead] = '\0'; // terminator
1039 const char * linkbuffer = &buf[0];
1041 link = makeAbsPath(linkbuffer, onlyPath(file.absFileName()));
1045 bool readLink(FileName const &, FileName &)
1052 cmd_ret const runCommand(string const & cmd)
1054 // FIXME: replace all calls to RunCommand with ForkedCall
1055 // (if the output is not needed) or the code in ISpell.cpp
1056 // (if the output is needed).
1058 // One question is if we should use popen or
1059 // create our own popen based on fork, exec, pipe
1060 // of course the best would be to have a
1061 // pstream (process stream), with the
1062 // variants ipstream, opstream
1065 lyxerr << "\nRunning: " << cmd << endl;
1067 LYXERR(Debug::INFO,"Running: " << cmd);
1069 #if defined (_WIN32)
1070 STARTUPINFO startup;
1071 PROCESS_INFORMATION process;
1072 SECURITY_ATTRIBUTES security;
1075 bool err2out = false;
1077 string const infile = trim(split(cmd, command, '<'), " \"");
1078 command = rtrim(command);
1079 if (suffixIs(command, "2>&1")) {
1080 command = rtrim(command, "2>&1");
1083 string const cmdarg = "/d /c \"" + command + "\"";
1084 string const comspec = getEnv("COMSPEC");
1086 security.nLength = sizeof(SECURITY_ATTRIBUTES);
1087 security.bInheritHandle = TRUE;
1088 security.lpSecurityDescriptor = NULL;
1090 if (CreatePipe(&in, &out, &security, 0)) {
1091 memset(&startup, 0, sizeof(STARTUPINFO));
1092 memset(&process, 0, sizeof(PROCESS_INFORMATION));
1094 startup.cb = sizeof(STARTUPINFO);
1095 startup.dwFlags = STARTF_USESTDHANDLES;
1097 startup.hStdError = err2out ? out : GetStdHandle(STD_ERROR_HANDLE);
1098 startup.hStdInput = infile.empty()
1099 ? GetStdHandle(STD_INPUT_HANDLE)
1100 : CreateFile(infile.c_str(), GENERIC_READ,
1101 FILE_SHARE_READ, &security, OPEN_EXISTING,
1102 FILE_ATTRIBUTE_NORMAL, NULL);
1103 startup.hStdOutput = out;
1105 if (startup.hStdInput != INVALID_HANDLE_VALUE &&
1106 CreateProcess(comspec.c_str(), (LPTSTR)cmdarg.c_str(),
1107 &security, &security, TRUE, CREATE_NO_WINDOW,
1108 0, 0, &startup, &process)) {
1110 CloseHandle(process.hThread);
1111 int fno = _open_osfhandle((intptr_t)in, _O_RDONLY);
1113 inf = _fdopen(fno, "r");
1116 #elif defined (HAVE_POPEN)
1117 FILE * inf = ::popen(cmd.c_str(), os::popen_read_mode());
1118 #elif defined (HAVE__POPEN)
1119 FILE * inf = ::_popen(cmd.c_str(), os::popen_read_mode());
1121 #error No popen() function.
1124 // (Claus Hentschel) Check if popen was successful ;-)
1126 lyxerr << "RunCommand: could not start child process" << endl;
1127 return { false, string() };
1133 result += static_cast<char>(c);
1137 #if defined (_WIN32)
1138 WaitForSingleObject(process.hProcess, INFINITE);
1140 BOOL success = GetExitCodeProcess(process.hProcess, &pret);
1141 bool valid = (pret == 0) && success;
1142 if (!infile.empty())
1143 CloseHandle(startup.hStdInput);
1144 CloseHandle(process.hProcess);
1145 if (fclose(inf) != 0)
1147 #elif defined (HAVE_PCLOSE)
1148 int const pret = pclose(inf);
1149 bool const valid = (pret != -1);
1150 #elif defined (HAVE__PCLOSE)
1151 int const pret = _pclose(inf);
1152 bool const valid = (pret != -1);
1154 #error No pclose() function.
1158 perror("RunCommand: could not terminate child process");
1160 return { valid, result };
1164 FileName const findtexfile(string const & fil, string const & /*format*/,
1165 bool const onlykpse)
1167 /* There is no problem to extend this function to use other
1168 methods to look for files. It could be setup to look
1169 in environment paths and also if wanted as a last resort
1170 to a recursive find. One of the easier extensions would
1171 perhaps be to use the LyX file lookup methods. But! I am
1172 going to implement this until I see some demand for it.
1176 // If the file can be found directly, we just return a
1177 // absolute path version of it.
1179 FileName const absfile(makeAbsPath(fil));
1180 if (absfile.exists())
1184 // Now we try to find it using kpsewhich.
1185 // It seems from the kpsewhich manual page that it is safe to use
1186 // kpsewhich without --format: "When the --format option is not
1187 // given, the search path used when looking for a file is inferred
1188 // from the name given, by looking for a known extension. If no
1189 // known extension is found, the search path for TeX source files
1191 // However, we want to take advantage of the format sine almost all
1192 // the different formats has environment variables that can be used
1193 // to control which paths to search. f.ex. bib looks in
1194 // BIBINPUTS and TEXBIB. Small list follows:
1195 // bib - BIBINPUTS, TEXBIB
1197 // graphic/figure - TEXPICTS, TEXINPUTS
1198 // ist - TEXINDEXSTYLE, INDEXSTYLE
1199 // pk - PROGRAMFONTS, PKFONTS, TEXPKS, GLYPHFONTS, TEXFONTS
1201 // tfm - TFMFONTS, TEXFONTS
1202 // This means that to use kpsewhich in the best possible way we
1203 // should help it by setting additional path in the approp. envir.var.
1204 string const kpsecmd = "kpsewhich " + fil;
1206 cmd_ret const c = runCommand(kpsecmd);
1208 LYXERR(Debug::LATEX, "kpse status = " << c.valid << '\n'
1209 << "kpse result = `" << rtrim(c.result, "\n\r") << '\'');
1211 return FileName(rtrim(to_utf8(from_filesystem8bit(c.result)), "\n\r"));
1217 int compare_timestamps(FileName const & file1, FileName const & file2)
1219 // If the original is newer than the copy, then copy the original
1220 // to the new directory.
1223 if (file1.exists() && file2.exists()) {
1224 double const tmp = difftime(file1.lastModified(), file2.lastModified());
1226 cmp = tmp > 0 ? 1 : -1;
1228 } else if (file1.exists()) {
1230 } else if (file2.exists()) {
1238 bool prefs2prefs(FileName const & filename, FileName const & tempfile, bool lfuns)
1240 FileName const script = libFileSearch("scripts", "prefs2prefs.py");
1241 if (script.empty()) {
1242 LYXERR0("Could not find bind file conversion "
1243 "script prefs2prefs.py.");
1247 ostringstream command;
1248 command << os::python() << ' ' << quoteName(script.toFilesystemEncoding())
1249 << ' ' << (lfuns ? "-l" : "-p") << ' '
1250 << quoteName(filename.toFilesystemEncoding())
1251 << ' ' << quoteName(tempfile.toFilesystemEncoding());
1252 string const command_str = command.str();
1254 LYXERR(Debug::FILES, "Running `" << command_str << '\'');
1256 cmd_ret const ret = runCommand(command_str);
1258 LYXERR0("Could not run file conversion script prefs2prefs.py.");
1265 bool configFileNeedsUpdate(string const & file)
1267 // We cannot initialize configure_script directly because the package
1268 // is not initialized yet when static objects are constructed.
1269 static FileName configure_script;
1270 static bool firstrun = true;
1273 FileName(addName(package().system_support().absFileName(),
1279 FileName(addName(package().user_support().absFileName(), file));
1280 return !absfile.exists()
1281 || configure_script.lastModified() > absfile.lastModified();
1285 int fileLock(const char * lock_file)
1288 #if defined(HAVE_LOCKF)
1289 fd = open(lock_file, O_CREAT|O_APPEND|O_SYNC|O_RDWR, 0666);
1292 if (lockf(fd, F_LOCK, 0) != 0) {
1301 void fileUnlock(int fd, const char * /* lock_file*/)
1303 #if defined(HAVE_LOCKF)
1305 if (lockf(fd, F_ULOCK, 0))
1306 LYXERR0("Can't unlock the file.");
1312 } //namespace support