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
27 #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"
45 #include "support/regex.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, NULL) != 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)
340 FileName fullname = fileSearch(addPath(package().user_support().absFileName(), dir),
342 if (!fullname.empty())
345 if (!package().build_support().empty())
346 fullname = fileSearch(addPath(package().build_support().absFileName(), dir),
348 if (!fullname.empty())
351 return fileSearch(addPath(package().system_support().absFileName(), dir),
356 FileName const i18nLibFileSearch(string const & dir, string const & name,
359 /* The highest priority value is the `LANGUAGE' environment
360 variable. But we don't use the value if the currently
361 selected locale is the C locale. This is a GNU extension.
363 Otherwise, w use a trick to guess what support/gettext.has done:
364 each po file is able to tell us its name. (JMarc)
367 string lang = getGuiMessages().language();
368 string const language = getEnv("LANGUAGE");
369 if (!lang.empty() && !language.empty())
373 lang = split(lang, l, ':');
376 // First try with the full name
377 tmp = libFileSearch(addPath(dir, l), name, ext);
381 // Then the name without country code
382 string const shortl = token(l, '_', 0);
384 tmp = libFileSearch(addPath(dir, shortl), name, ext);
390 // For compatibility, to be removed later (JMarc)
391 tmp = libFileSearch(dir, token(l, '_', 0) + '_' + name,
394 lyxerr << "i18nLibFileSearch: File `" << tmp
395 << "' has been found by the old method" <<endl;
399 lang = split(lang, l, ':');
402 return libFileSearch(dir, name, ext);
406 FileName const imageLibFileSearch(string & dir, string const & name,
407 string const & ext, search_mode mode)
409 if (!lyx::lyxrc.icon_set.empty()) {
410 string const imagedir = addPath(dir, lyx::lyxrc.icon_set);
411 FileName const fn = libFileSearch(imagedir, name, ext, mode);
417 return libFileSearch(dir, name, ext, mode);
421 string const commandPrep(string const & command_in)
423 static string const token_scriptpath = "$$s/";
424 string const python_call = "python -tt";
426 string command = command_in;
427 if (prefixIs(command_in, python_call))
428 command = os::python() + command_in.substr(python_call.length());
430 // Find the starting position of "$$s/"
431 string::size_type const pos1 = command.find(token_scriptpath);
432 if (pos1 == string::npos)
434 // Find the end of the "$$s/some_subdir/some_script" word within
435 // command. Assumes that the script name does not contain spaces.
436 string::size_type const start_script = pos1 + 4;
437 string::size_type const pos2 = command.find(' ', start_script);
438 string::size_type const size_script = pos2 == string::npos?
439 (command.size() - start_script) : pos2 - start_script;
441 // Does this script file exist?
442 string const script =
443 libFileSearch(".", command.substr(start_script, size_script)).absFileName();
445 if (script.empty()) {
446 // Replace "$$s/" with ""
447 command.erase(pos1, 4);
449 quote_style style = quote_shell;
450 if (prefixIs(command, os::python()))
451 style = quote_python;
453 // Replace "$$s/foo/some_script" with "<path to>/some_script".
454 string::size_type const size_replace = size_script + 4;
455 command.replace(pos1, size_replace, quoteName(script, style));
462 FileName const tempFileName(string const & mask, bool const dir)
464 FileName tempfile = TempFile(mask).name();
465 // Since the QTemporaryFile object is destroyed at function return
466 // (which is what is intended here), the next call to this function
467 // may return the same file name again.
468 // Thus, in order to prevent race conditions, we track returned names
469 // and create our own unique names if QTemporaryFile returns a name again.
470 if (tmp_names_.find(tempfile.absFileName()) == tmp_names_.end()) {
471 tmp_names_.insert(tempfile.absFileName());
475 // OK, we need another name. Simply append digits.
476 FileName tmp = tempfile;
479 // Store and remove extensions
480 ext = "." + tempfile.extension();
481 tmp.changeExtension("");
483 for (int i = 1; i < INT_MAX ;++i) {
484 // Append digit to filename and re-add extension
485 string const new_fn =
486 tmp.absFileName() + convert<string>(i) + ext;
487 if (tmp_names_.find(new_fn) == tmp_names_.end()) {
488 tmp_names_.insert(new_fn);
489 tempfile.set(new_fn);
494 // This should not happen!
495 LYXERR0("tempFileName(): Could not create unique temp file name!");
500 void removeTempFile(FileName const & fn)
505 string const abs = fn.absFileName();
506 if (tmp_names_.find(abs) != tmp_names_.end())
507 tmp_names_.erase(abs);
512 static FileName createTmpDir(FileName const & tempdir, string const & mask)
514 LYXERR(Debug::FILES, "createTmpDir: tempdir=`" << tempdir << "'\n"
515 << "createTmpDir: mask=`" << mask << '\'');
517 QFileInfo tmp_fi(QDir(toqstr(tempdir.absFileName())), toqstr(mask));
518 FileName const tmpfl =
519 tempFileName(fromqstr(tmp_fi.absoluteFilePath()) + ".XXXXXXXXXXXX", true);
521 if (tmpfl.empty() || !tmpfl.createDirectory(0700)) {
522 LYXERR0("LyX could not create temporary directory in " << tempdir
531 FileName const createLyXTmpDir(FileName const & deflt)
533 if (deflt.empty() || deflt == package().system_temp_dir())
534 return createTmpDir(package().system_temp_dir(), "lyx_tmpdir");
536 if (deflt.createDirectory(0777))
539 if (deflt.isDirWritable()) {
540 // deflt could not be created because it
541 // did exist already, so let's create our own
543 return createTmpDir(deflt, "lyx_tmpdir");
545 // some other error occurred.
546 return createTmpDir(package().system_temp_dir(), "lyx_tmpdir");
551 // Strip filename from path name
552 string const onlyPath(string const & filename)
554 // If empty filename, return empty
555 if (filename.empty())
558 // Find last / or start of filename
559 size_t j = filename.rfind('/');
560 return j == string::npos ? "./" : filename.substr(0, j + 1);
564 // Convert relative path into absolute path based on a basepath.
565 // If relpath is absolute, just use that.
566 // If basepath is empty, use CWD as base.
567 // Note that basePath can be a relative path, in the sense that it may
568 // not begin with "/" (e.g.), but it should NOT contain such constructs
570 // FIXME It might be nice if the code didn't simply assume that.
571 FileName const makeAbsPath(string const & relPath, string const & basePath)
573 // checks for already absolute path
574 if (FileName::isAbsolute(relPath))
575 return FileName(relPath);
577 // Copies given paths
578 string tempRel = os::internal_path(relPath);
579 // Since TempRel is NOT absolute, we can safely replace "//" with "/"
580 tempRel = subst(tempRel, "//", "/");
584 if (FileName::isAbsolute(basePath))
587 tempBase = addPath(FileName::getcwd().absFileName(), basePath);
589 // Handle /./ at the end of the path
590 while (suffixIs(tempBase, "/./"))
591 tempBase.erase(tempBase.length() - 2);
593 // processes relative path
594 string rTemp = tempRel;
597 // Check for a leading "~"
599 rTemp = split(rTemp, temp, '/');
601 tempBase = Package::get_home_dir().absFileName();
606 while (!rTemp.empty()) {
608 rTemp = split(rTemp, temp, '/');
610 if (temp == ".") continue;
612 // Remove one level of TempBase
613 if (tempBase.length() <= 1) {
614 //this is supposed to be an absolute path, so...
618 //erase a trailing slash if there is one
619 if (suffixIs(tempBase, "/"))
620 tempBase.erase(tempBase.length() - 1, string::npos);
622 string::size_type i = tempBase.length() - 1;
623 while (i > 0 && tempBase[i] != '/')
626 tempBase.erase(i, string::npos);
629 } else if (temp.empty() && !rTemp.empty()) {
630 tempBase = os::current_root() + rTemp;
633 // Add this piece to TempBase
634 if (!suffixIs(tempBase, '/'))
640 // returns absolute path
641 return FileName(tempBase);
645 // Correctly append filename to the pathname.
646 // If pathname is '.', then don't use pathname.
647 // Chops any path of filename.
648 string const addName(string const & path, string const & fname)
650 string const basename = onlyFileName(fname);
653 if (path != "." && path != "./" && !path.empty()) {
654 buf = os::internal_path(path);
655 if (!suffixIs(path, '/'))
659 return buf + basename;
663 // Strips path from filename
664 string const onlyFileName(string const & fname)
669 string::size_type j = fname.rfind('/');
670 if (j == string::npos) // no '/' in fname
674 return fname.substr(j + 1);
678 // Search the string for ${VAR} and $VAR and replace VAR using getenv.
679 string const replaceEnvironmentPath(string const & path)
681 // ${VAR} is defined as
682 // $\{[A-Za-z_][A-Za-z_0-9]*\}
683 static string const envvar_br = "[$]\\{([A-Za-z_][A-Za-z_0-9]*)\\}";
685 // $VAR is defined as:
686 // $[A-Za-z_][A-Za-z_0-9]*
687 static string const envvar = "[$]([A-Za-z_][A-Za-z_0-9]*)";
689 // Coverity thinks that the regex constructor can return an
690 // exception. We know that it is not true since our regex are
691 // hardcoded, but we have to protect against that nevertheless.
693 static regex const envvar_br_re("(.*)" + envvar_br + "(.*)");
694 static regex const envvar_re("(.*)" + envvar + "(.*)");
695 string result = path;
698 if (!regex_match(result, what, envvar_br_re)) {
699 if (!regex_match(result, what, envvar_re))
702 string env_var = getEnv(what.str(2));
703 result = what.str(1) + env_var + what.str(3);
706 } catch (exception const & e) {
707 LYXERR0("Something is very wrong: " << e.what());
713 // Return a command prefix for setting the environment of the TeX engine.
714 string latexEnvCmdPrefix(string const & path, string const & lpath)
716 bool use_lpath = !(lpath.empty() || lpath == "." || lpath == "./");
718 if (path.empty() || (lyxrc.texinputs_prefix.empty() && !use_lpath))
721 string texinputs_prefix = lyxrc.texinputs_prefix.empty() ? string()
722 : os::latex_path_list(
723 replaceCurdirPath(path, lyxrc.texinputs_prefix));
724 string const allother_prefix = os::latex_path_list(path);
725 string const sep = string(1, os::path_separator(os::TEXENGINE));
726 string const texinputs = getEnv("TEXINPUTS");
727 string const bibinputs = getEnv("BIBINPUTS");
728 string const bstinputs = getEnv("BSTINPUTS");
729 string const texfonts = getEnv("TEXFONTS");
732 string const abslpath = FileName::isAbsolute(lpath)
733 ? os::latex_path(lpath)
734 : os::latex_path(FileName(path + "/" + lpath).realPath());
735 if (texinputs_prefix.empty())
736 texinputs_prefix = abslpath;
737 else if (suffixIs(texinputs_prefix, sep))
738 texinputs_prefix.append(abslpath + sep);
740 texinputs_prefix.append(sep + abslpath);
743 if (os::shell() == os::UNIX)
744 return "env TEXINPUTS=\"." + sep + texinputs_prefix
745 + sep + texinputs + "\" "
746 + "BIBINPUTS=\"." + sep + allother_prefix
747 + sep + bibinputs + "\" "
748 + "BSTINPUTS=\"." + sep + allother_prefix
749 + sep + bstinputs + "\" "
750 + "TEXFONTS=\"." + sep + allother_prefix
751 + sep + texfonts + "\" ";
753 // NOTE: the dummy blank dirs are necessary to force the
754 // QProcess parser to quote the argument (see bug 9453)
755 return "cmd /d /c set \"TEXINPUTS=." + sep + " "
756 + sep + texinputs_prefix
757 + sep + texinputs + "\" & "
758 + "set \"BIBINPUTS=." + sep + " "
759 + sep + allother_prefix
760 + sep + bibinputs + "\" & "
761 + "set \"BSTINPUTS=." + sep + " "
762 + sep + allother_prefix
763 + sep + bstinputs + "\" & "
764 + "set \"TEXFONTS=." + sep + " "
765 + sep + allother_prefix
766 + sep + texfonts + "\" & ";
770 // Replace current directory in all elements of a path list with a given path.
771 string const replaceCurdirPath(string const & path, string const & pathlist)
773 string const oldpathlist = replaceEnvironmentPath(pathlist);
774 char const sep = os::path_separator();
777 for (size_t i = 0, k = 0; i != string::npos; k = i) {
778 i = oldpathlist.find(sep, i);
779 string p = oldpathlist.substr(k, i - k);
780 if (FileName::isAbsolute(p)) {
786 } else if (prefixIs(p, "./")) {
788 while (p[offset] == '/')
791 newpathlist += addPath(path, p.substr(offset));
792 if (suffixIs(p, "//"))
795 if (i != string::npos) {
797 // Stop here if the last element is empty
798 if (++i == oldpathlist.length())
806 // Make relative path out of two absolute paths
807 docstring const makeRelPath(docstring const & abspath, docstring const & basepath)
808 // Makes relative path out of absolute path. If it is deeper than basepath,
809 // it's easy. If basepath and abspath share something (they are all deeper
810 // than some directory), it'll be rendered using ..'s. If they are completely
811 // different, then the absolute path will be used as relative path.
813 docstring::size_type const abslen = abspath.length();
814 docstring::size_type const baselen = basepath.length();
816 docstring::size_type i = os::common_path(abspath, basepath);
819 // actually no match - cannot make it relative
823 // Count how many dirs there are in basepath above match
824 // and append as many '..''s into relpath
826 docstring::size_type j = i;
827 while (j < baselen) {
828 if (basepath[j] == '/') {
829 if (j + 1 == baselen)
836 // Append relative stuff from common directory to abspath
837 if (abspath[i] == '/')
839 for (; i < abslen; ++i)
842 if (suffixIs(buf, '/'))
843 buf.erase(buf.length() - 1);
844 // Substitute empty with .
851 // Append sub-directory(ies) to a path in an intelligent way
852 string const addPath(string const & path, string const & path_2)
855 string const path2 = os::internal_path(path_2);
857 if (!path.empty() && path != "." && path != "./") {
858 buf = os::internal_path(path);
859 if (path[path.length() - 1] != '/')
863 if (!path2.empty()) {
864 string::size_type const p2start = path2.find_first_not_of('/');
865 string::size_type const p2end = path2.find_last_not_of('/');
866 string const tmp = path2.substr(p2start, p2end - p2start + 1);
873 string const changeExtension(string const & oldname, string const & extension)
875 string::size_type const last_slash = oldname.rfind('/');
876 string::size_type last_dot = oldname.rfind('.');
877 if (last_dot < last_slash && last_slash != string::npos)
878 last_dot = string::npos;
881 // Make sure the extension starts with a dot
882 if (!extension.empty() && extension[0] != '.')
883 ext= '.' + extension;
887 return os::internal_path(oldname.substr(0, last_dot) + ext);
891 string const removeExtension(string const & name)
893 return changeExtension(name, string());
897 string const addExtension(string const & name, string const & extension)
899 if (!extension.empty() && extension[0] != '.')
900 return name + '.' + extension;
901 return name + extension;
905 /// Return the extension of the file (not including the .)
906 string const getExtension(string const & name)
908 string::size_type const last_slash = name.rfind('/');
909 string::size_type const last_dot = name.rfind('.');
910 if (last_dot != string::npos &&
911 (last_slash == string::npos || last_dot > last_slash))
912 return name.substr(last_dot + 1,
913 name.length() - (last_dot + 1));
919 string const unzippedFileName(string const & zipped_file)
921 string const ext = getExtension(zipped_file);
922 if (ext == "gz" || ext == "z" || ext == "Z")
923 return changeExtension(zipped_file, string());
924 else if (ext == "svgz")
925 return changeExtension(zipped_file, "svg");
926 return onlyPath(zipped_file) + "unzipped_" + onlyFileName(zipped_file);
930 FileName const unzipFile(FileName const & zipped_file, string const & unzipped_file)
932 FileName const tempfile = FileName(unzipped_file.empty() ?
933 unzippedFileName(zipped_file.toFilesystemEncoding()) :
936 string const command = "gunzip -c " +
937 zipped_file.toFilesystemEncoding() + " > " +
938 tempfile.toFilesystemEncoding();
940 one.startscript(Systemcall::Wait, command);
941 // test that command was executed successfully (anon)
942 // yes, please do. (Lgb)
947 docstring const makeDisplayPath(string const & path, unsigned int threshold)
951 // If file is from LyXDir, display it as if it were relative.
952 string const system = package().system_support().absFileName();
953 if (prefixIs(str, system) && str != system)
954 return from_utf8("[" + str.erase(0, system.length()) + "]");
956 // replace /home/blah with ~/
957 string const home = Package::get_home_dir().absFileName();
958 if (!home.empty() && prefixIs(str, home))
959 str = subst(str, home, "~");
961 if (str.length() <= threshold)
962 return from_utf8(os::external_path(str));
964 string const prefix = ".../";
965 docstring dstr = from_utf8(str);
968 while (dstr.length() > threshold)
969 dstr = split(dstr, temp, '/');
971 // Did we shorten everything away?
973 // Yes, filename itself is too long.
974 // Pick the start and the end of the filename.
975 docstring fstr = from_utf8(onlyFileName(path));
977 if (support::truncateWithEllipsis(dstr, threshold / 2))
978 dstr += fstr.substr(fstr.length() - threshold / 2 - 2,
982 return from_utf8(os::external_path(prefix + to_utf8(dstr)));
987 bool readLink(FileName const & file, FileName & link)
989 string const encoded = file.toFilesystemEncoding();
990 #ifdef HAVE_DEF_PATH_MAX
991 char linkbuffer[PATH_MAX + 1];
992 ssize_t const nRead = ::readlink(encoded.c_str(),
993 linkbuffer, sizeof(linkbuffer) - 1);
996 linkbuffer[nRead] = '\0'; // terminator
998 vector<char> buf(1024);
1002 nRead = ::readlink(encoded.c_str(), &buf[0], buf.size() - 1);
1006 if (static_cast<size_t>(nRead) < buf.size() - 1) {
1009 buf.resize(buf.size() * 2);
1011 buf[nRead] = '\0'; // terminator
1012 const char * linkbuffer = &buf[0];
1014 link = makeAbsPath(linkbuffer, onlyPath(file.absFileName()));
1018 bool readLink(FileName const &, FileName &)
1025 cmd_ret const runCommand(string const & cmd)
1027 // FIXME: replace all calls to RunCommand with ForkedCall
1028 // (if the output is not needed) or the code in ISpell.cpp
1029 // (if the output is needed).
1031 // One question is if we should use popen or
1032 // create our own popen based on fork, exec, pipe
1033 // of course the best would be to have a
1034 // pstream (process stream), with the
1035 // variants ipstream, opstream
1038 lyxerr << "\nRunning: " << cmd << endl;
1040 LYXERR(Debug::INFO,"Running: " << cmd);
1042 #if defined (_WIN32)
1043 STARTUPINFO startup;
1044 PROCESS_INFORMATION process;
1045 SECURITY_ATTRIBUTES security;
1048 bool err2out = false;
1050 string const infile = trim(split(cmd, command, '<'), " \"");
1051 command = rtrim(command);
1052 if (suffixIs(command, "2>&1")) {
1053 command = rtrim(command, "2>&1");
1056 string const cmdarg = "/d /c " + command;
1057 string const comspec = getEnv("COMSPEC");
1059 security.nLength = sizeof(SECURITY_ATTRIBUTES);
1060 security.bInheritHandle = TRUE;
1061 security.lpSecurityDescriptor = NULL;
1063 if (CreatePipe(&in, &out, &security, 0)) {
1064 memset(&startup, 0, sizeof(STARTUPINFO));
1065 memset(&process, 0, sizeof(PROCESS_INFORMATION));
1067 startup.cb = sizeof(STARTUPINFO);
1068 startup.dwFlags = STARTF_USESTDHANDLES;
1070 startup.hStdError = err2out ? out : GetStdHandle(STD_ERROR_HANDLE);
1071 startup.hStdInput = infile.empty()
1072 ? GetStdHandle(STD_INPUT_HANDLE)
1073 : CreateFile(infile.c_str(), GENERIC_READ,
1074 FILE_SHARE_READ, &security, OPEN_EXISTING,
1075 FILE_ATTRIBUTE_NORMAL, NULL);
1076 startup.hStdOutput = out;
1078 if (startup.hStdInput != INVALID_HANDLE_VALUE &&
1079 CreateProcess(comspec.c_str(), (LPTSTR)cmdarg.c_str(),
1080 &security, &security, TRUE, CREATE_NO_WINDOW,
1081 0, 0, &startup, &process)) {
1083 CloseHandle(process.hThread);
1084 int fno = _open_osfhandle((intptr_t)in, _O_RDONLY);
1086 inf = _fdopen(fno, "r");
1089 #elif defined (HAVE_POPEN)
1090 FILE * inf = ::popen(cmd.c_str(), os::popen_read_mode());
1091 #elif defined (HAVE__POPEN)
1092 FILE * inf = ::_popen(cmd.c_str(), os::popen_read_mode());
1094 #error No popen() function.
1097 // (Claus Hentschel) Check if popen was successful ;-)
1099 lyxerr << "RunCommand:: could not start child process" << endl;
1100 return make_pair(-1, string());
1106 ret += static_cast<char>(c);
1110 #if defined (_WIN32)
1111 WaitForSingleObject(process.hProcess, INFINITE);
1113 if (!GetExitCodeProcess(process.hProcess, &pret))
1115 if (!infile.empty())
1116 CloseHandle(startup.hStdInput);
1117 CloseHandle(process.hProcess);
1118 if (fclose(inf) != 0)
1120 #elif defined (HAVE_PCLOSE)
1121 int const pret = pclose(inf);
1122 #elif defined (HAVE__PCLOSE)
1123 int const pret = _pclose(inf);
1125 #error No pclose() function.
1129 perror("RunCommand:: could not terminate child process");
1131 return make_pair(pret, ret);
1135 FileName const findtexfile(string const & fil, string const & /*format*/,
1136 bool const onlykpse)
1138 /* There is no problem to extend this function too use other
1139 methods to look for files. It could be setup to look
1140 in environment paths and also if wanted as a last resort
1141 to a recursive find. One of the easier extensions would
1142 perhaps be to use the LyX file lookup methods. But! I am
1143 going to implement this until I see some demand for it.
1147 // If the file can be found directly, we just return a
1148 // absolute path version of it.
1150 FileName const absfile(makeAbsPath(fil));
1151 if (absfile.exists())
1155 // Now we try to find it using kpsewhich.
1156 // It seems from the kpsewhich manual page that it is safe to use
1157 // kpsewhich without --format: "When the --format option is not
1158 // given, the search path used when looking for a file is inferred
1159 // from the name given, by looking for a known extension. If no
1160 // known extension is found, the search path for TeX source files
1162 // However, we want to take advantage of the format sine almost all
1163 // the different formats has environment variables that can be used
1164 // to controll which paths to search. f.ex. bib looks in
1165 // BIBINPUTS and TEXBIB. Small list follows:
1166 // bib - BIBINPUTS, TEXBIB
1168 // graphic/figure - TEXPICTS, TEXINPUTS
1169 // ist - TEXINDEXSTYLE, INDEXSTYLE
1170 // pk - PROGRAMFONTS, PKFONTS, TEXPKS, GLYPHFONTS, TEXFONTS
1172 // tfm - TFMFONTS, TEXFONTS
1173 // This means that to use kpsewhich in the best possible way we
1174 // should help it by setting additional path in the approp. envir.var.
1175 string const kpsecmd = "kpsewhich " + fil;
1177 cmd_ret const c = runCommand(kpsecmd);
1179 LYXERR(Debug::LATEX, "kpse status = " << c.first << '\n'
1180 << "kpse result = `" << rtrim(c.second, "\n\r") << '\'');
1182 return FileName(rtrim(to_utf8(from_filesystem8bit(c.second)), "\n\r"));
1188 int compare_timestamps(FileName const & file1, FileName const & file2)
1190 // If the original is newer than the copy, then copy the original
1191 // to the new directory.
1194 if (file1.exists() && file2.exists()) {
1195 double const tmp = difftime(file1.lastModified(), file2.lastModified());
1197 cmp = tmp > 0 ? 1 : -1;
1199 } else if (file1.exists()) {
1201 } else if (file2.exists()) {
1209 bool prefs2prefs(FileName const & filename, FileName const & tempfile, bool lfuns)
1211 FileName const script = libFileSearch("scripts", "prefs2prefs.py");
1212 if (script.empty()) {
1213 LYXERR0("Could not find bind file conversion "
1214 "script prefs2prefs.py.");
1218 ostringstream command;
1219 command << os::python() << ' ' << quoteName(script.toFilesystemEncoding())
1220 << ' ' << (lfuns ? "-l" : "-p") << ' '
1221 << quoteName(filename.toFilesystemEncoding())
1222 << ' ' << quoteName(tempfile.toFilesystemEncoding());
1223 string const command_str = command.str();
1225 LYXERR(Debug::FILES, "Running `" << command_str << '\'');
1227 cmd_ret const ret = runCommand(command_str);
1228 if (ret.first != 0) {
1229 LYXERR0("Could not run file conversion script prefs2prefs.py.");
1236 bool configFileNeedsUpdate(string const & file)
1238 // We cannot initialize configure_script directly because the package
1239 // is not initialized yet when static objects are constructed.
1240 static FileName configure_script;
1241 static bool firstrun = true;
1244 FileName(addName(package().system_support().absFileName(),
1250 FileName(addName(package().user_support().absFileName(), file));
1251 return !absfile.exists()
1252 || configure_script.lastModified() > absfile.lastModified();
1256 int fileLock(const char * lock_file)
1259 #if defined(HAVE_LOCKF)
1260 fd = open(lock_file, O_CREAT|O_APPEND|O_SYNC|O_RDWR, 0666);
1263 if (lockf(fd, F_LOCK, 0) != 0) {
1272 void fileUnlock(int fd, const char * /* lock_file*/)
1274 #if defined(HAVE_LOCKF)
1276 if (lockf(fd, F_ULOCK, 0))
1277 LYXERR0("Can't unlock the file.");
1283 } //namespace support