]> git.lyx.org Git - features.git/blobdiff - src/support/filetools.C
Replace LString.h with support/std_string.h,
[features.git] / src / support / filetools.C
index df147fa0666ad63cd213ece8f5cd3dd4fe1d00d9..e0d333b0967be3a5b44d44926118d53ce8a4eaae 100644 (file)
  * \author Asger Alstrup
  * \author Lars Gullik Bjønnes
  * \author Jean-Marc Lasgouttes
+ * \author Angus Leeming
+ * \author John Levon
+ * \author Herbert Voss
  *
- * Full author contact details are available in file CREDITS
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
  * General path-mangling functions
  */
 #include <config.h>
 
 #include "debug.h"
-#include "support/lstrings.h"
+#include "support/tostr.h"
 #include "support/systemcall.h"
+#include "support/LAssert.h"
 
 #include "filetools.h"
 #include "lstrings.h"
-#include "frontends/Alert.h"
 #include "FileInfo.h"
-#include "support/path.h"        // I know it's OS/2 specific (SMiyata)
+#include "path.h"
+#include "path_defines.h"
 #include "gettext.h"
 #include "lyxlib.h"
 #include "os.h"
 
-#include "Lsstream.h"
+#include "support/std_sstream.h"
 
+#include <boost/cregex.hpp>
 #include <cctype>
 #include <cstdlib>
 #include <cstdio>
@@ -74,10 +80,9 @@ using std::ifstream;
 using std::vector;
 using std::getline;
 
-extern string system_lyxdir;
-extern string build_lyxdir;
-extern string user_lyxdir;
 
+namespace lyx {
+namespace support {
 
 bool IsLyXFilename(string const & filename)
 {
@@ -153,12 +158,12 @@ bool IsDirWriteable(string const & path)
 {
        lyxerr[Debug::FILES] << "IsDirWriteable: " << path << endl;
 
-       string const tmpfl(lyx::tempName(path, "lyxwritetest"));
+       string const tmpfl(tempName(path, "lyxwritetest"));
 
        if (tmpfl.empty())
                return false;
 
-       lyx::unlink(tmpfl);
+       unlink(tmpfl);
        return true;
 }
 
@@ -180,8 +185,8 @@ string const FileOpenSearch(string const & path, string const & name,
                path_element = os::slashify_path(path_element);
                if (!suffixIs(path_element, '/'))
                        path_element+= '/';
-               path_element = subst(path_element, "$$LyX", system_lyxdir);
-               path_element = subst(path_element, "$$User", user_lyxdir);
+               path_element = subst(path_element, "$$LyX", system_lyxdir());
+               path_element = subst(path_element, "$$User", user_lyxdir());
 
                real_file = FileSearch(path_element, name, ext);
 
@@ -286,16 +291,16 @@ string const FileSearch(string const & path, string const & name,
 string const LibFileSearch(string const & dir, string const & name,
                           string const & ext)
 {
-       string fullname = FileSearch(AddPath(user_lyxdir, dir), name, ext);
+       string fullname = FileSearch(AddPath(user_lyxdir(), dir), name, ext);
        if (!fullname.empty())
                return fullname;
 
-       if (!build_lyxdir.empty())
-               fullname = FileSearch(AddPath(build_lyxdir, dir), name, ext);
+       if (!build_lyxdir().empty())
+               fullname = FileSearch(AddPath(build_lyxdir(), dir), name, ext);
        if (!fullname.empty())
                return fullname;
 
-       return FileSearch(AddPath(system_lyxdir, dir), name, ext);
+       return FileSearch(AddPath(system_lyxdir(), dir), name, ext);
 }
 
 
@@ -333,18 +338,35 @@ i18nLibFileSearch(string const & dir, string const & name,
 }
 
 
-string const LibScriptSearch(string const & command)
+string const LibScriptSearch(string const & command_in)
 {
-       string script;
-       string args = command;
-       args = split(args, script, ' ');
-       script = LibFileSearch("scripts", script);
-       if (script.empty())
+       string const token_scriptpath("$$s/");
+
+       string command = command_in;
+       // Find the starting position of "$$s/"
+       string::size_type const pos1 = command.find(token_scriptpath);
+       if (pos1 == string::npos)
                return command;
-       else if (args.empty())
-               return script;
-       else
-               return script + ' ' + args;
+       // Find the end of the "$$s/some_script" word within command
+       string::size_type const start_script = pos1 + 4;
+       string::size_type const pos2 = command.find(' ', start_script);
+       string::size_type const size_script = pos2 == string::npos?
+               (command.size() - start_script) : pos2 - start_script;
+
+       // Does this script file exist?
+       string const script =
+               LibFileSearch("scripts", command.substr(start_script, size_script));
+
+       if (script.empty()) {
+               // Replace "$$s/" with ""
+               command.erase(pos1, 4);
+       } else {
+               // Replace "$$s/some_script" with "$LYX_SCRIPT_PATH/some_script"
+               string::size_type const size_replace = size_script + 4;
+               command.replace(pos1, size_replace, script);
+       }
+
+       return command;
 }
 
 
@@ -368,53 +390,6 @@ string const GetEnvPath(string const & name)
 }
 
 
-bool PutEnv(string const & envstr)
-{
-       // CHECK Look at and fix this.
-       // f.ex. what about error checking?
-
-#if HAVE_PUTENV
-       // this leaks, but what can we do about it?
-       //   Is doing a getenv() and a free() of the older value
-       //   a good idea? (JMarc)
-       // Actually we don't have to leak...calling putenv like this
-       // should be enough: ... and this is obviously not enough if putenv
-       // does not make a copy of the string. It is also not very wise to
-       // put a string on the free store. If we have to leak we should do it
-       // like this:
-       char * leaker = new char[envstr.length() + 1];
-       envstr.copy(leaker, envstr.length());
-       leaker[envstr.length()] = '\0';
-       int const retval = lyx::putenv(leaker);
-
-       // If putenv does not make a copy of the char const * this
-       // is very dangerous. OTOH if it does take a copy this is the
-       // best solution.
-       // The  only implementation of putenv that I have seen does not
-       // allocate memory. _And_ after testing the putenv in glibc it
-       // seems that we need to make a copy of the string contents.
-       // I will enable the above.
-       //int retval = lyx::putenv(envstr.c_str());
-#else
-#ifdef HAVE_SETENV
-       string varname;
-       string const str = envstr.split(varname,'=');
-       int const retval = ::setenv(varname.c_str(), str.c_str(), true);
-#else
-       // No environment setting function. Can this happen?
-       int const retval = 1; //return an error condition.
-#endif
-#endif
-       return retval == 0;
-}
-
-
-bool PutEnvPath(string const & envstr)
-{
-       return PutEnv(envstr);
-}
-
-
 namespace {
 
 int DeleteAllFilesInDir(string const & path)
@@ -426,7 +401,6 @@ int DeleteAllFilesInDir(string const & path)
        // directory_iterator dit(path);
        // directory_iterator dend;
        // if (dit == dend) {
-       //         Alert::err_alert(_("Error! Cannot open directory:"), path);
        //         return -1;
        // }
        // for (; dit != dend; ++dit) {
@@ -434,16 +408,13 @@ int DeleteAllFilesInDir(string const & path)
        //         if (filename == "." || filename == "..")
        //                 continue;
        //         string unlinkpath(AddName(path, filename));
-       //         if (lyx::unlink(unlinkpath))
-       //                 Alert::err_alert(_("Error! Could not remove file:"),
-       //                              unlinkpath);
+       //         lyx::unlink(unlinkpath);
        // }
        // return 0;
        DIR * dir = ::opendir(path.c_str());
-       if (!dir) {
-               Alert::err_alert (_("Error! Cannot open directory:"), path);
+       if (!dir)
                return -1;
-       }
+
        struct dirent * de;
        int return_value = 0;
        while ((de = readdir(dir))) {
@@ -459,12 +430,9 @@ int DeleteAllFilesInDir(string const & path)
                FileInfo fi(unlinkpath);
                if (fi.isOK() && fi.isDir())
                        deleted = (DeleteAllFilesInDir(unlinkpath) == 0);
-               deleted &= (lyx::unlink(unlinkpath) == 0);
-               if (!deleted) {
-                       Alert::err_alert(_("Error! Could not remove file:"),
-                               unlinkpath);
+               deleted &= (unlink(unlinkpath) == 0);
+               if (!deleted)
                        return_value = -1;
-               }
        }
        closedir(dir);
        return return_value;
@@ -477,40 +445,36 @@ string const CreateTmpDir(string const & tempdir, string const & mask)
                << "CreateTmpDir: tempdir=`" << tempdir << "'\n"
                << "CreateTmpDir:    mask=`" << mask << '\'' << endl;
 
-       string const tmpfl(lyx::tempName(tempdir, mask));
+       string const tmpfl(tempName(tempdir, mask));
        // lyx::tempName actually creates a file to make sure that it
        // stays unique. So we have to delete it before we can create
        // a dir with the same name. Note also that we are not thread
        // safe because of the gap between unlink and mkdir. (Lgb)
-       lyx::unlink(tmpfl.c_str());
+       unlink(tmpfl);
 
-       if (tmpfl.empty() || lyx::mkdir(tmpfl, 0700)) {
-               Alert::err_alert(_("Error! Couldn't create temporary directory:"),
-                            tempdir);
+       if (tmpfl.empty() || mkdir(tmpfl, 0700))
                return string();
-       }
+
        return MakeAbsPath(tmpfl);
 }
 
+} // namespace anon
+
 
-int DestroyTmpDir(string const & tmpdir, bool Allfiles)
+int destroyDir(string const & tmpdir)
 {
 #ifdef __EMX__
-       Path p(user_lyxdir);
+       Path p(user_lyxdir());
 #endif
-       if (Allfiles && DeleteAllFilesInDir(tmpdir)) {
+       if (DeleteAllFilesInDir(tmpdir))
                return -1;
-       }
-       if (lyx::rmdir(tmpdir)) {
-               Alert::err_alert(_("Error! Couldn't delete temporary directory:"),
-                            tmpdir);
+
+       if (rmdir(tmpdir))
                return -1;
-       }
+
        return 0;
 }
 
-} // namespace anon
-
 
 string const CreateBufferTmpDir(string const & pathfor)
 {
@@ -520,62 +484,41 @@ string const CreateBufferTmpDir(string const & pathfor)
        // In fact I wrote this code to circumvent a problematic behaviour (bug?)
        // of EMX mkstemp().
        string const tmpfl = tmpdir + "/lyx_tmpbuf" + tostr(count++);
-       if (lyx::mkdir(tmpfl, 0777)) {
-               Alert::err_alert(_("Error! Couldn't create temporary directory:"),
-                            tmpdir);
+       if (mkdir(tmpfl, 0777)) {
                return string();
        }
        return tmpfl;
 }
 
 
-int DestroyBufferTmpDir(string const & tmpdir)
-{
-       return DestroyTmpDir(tmpdir, true);
-}
-
-
 string const CreateLyXTmpDir(string const & deflt)
 {
        if ((!deflt.empty()) && (deflt  != "/tmp")) {
-               if (lyx::mkdir(deflt, 0777)) {
+               if (mkdir(deflt, 0777)) {
 #ifdef __EMX__
-               Path p(user_lyxdir);
+               Path p(user_lyxdir());
 #endif
                        return CreateTmpDir(deflt, "lyx_tmpdir");
                } else
                        return deflt;
        } else {
 #ifdef __EMX__
-               Path p(user_lyxdir);
+               Path p(user_lyxdir());
 #endif
                return CreateTmpDir("/tmp", "lyx_tmpdir");
        }
 }
 
 
-// FIXME: no need for separate method like this ...
-int DestroyLyXTmpDir(string const & tmpdir)
-{
-       return DestroyTmpDir(tmpdir, true);
-}
-
-
-// Creates directory. Returns true if succesfull
 bool createDirectory(string const & path, int permission)
 {
        string temp(rtrim(os::slashify_path(path), "/"));
 
-       if (temp.empty()) {
-               Alert::alert(_("Internal error!"),
-                          _("Call to createDirectory with invalid name"));
-               return false;
-       }
+       Assert(!temp.empty());
 
-       if (lyx::mkdir(temp, permission)) {
-               Alert::err_alert (_("Error! Couldn't create directory:"), temp);
+       if (mkdir(temp, permission))
                return false;
-       }
+
        return true;
 }
 
@@ -613,7 +556,7 @@ string const MakeAbsPath(string const & RelPath, string const & BasePath)
        if (os::is_absolute_path(BasePath))
                TempBase = BasePath;
        else
-               TempBase = AddPath(lyx::getcwd(), BasePath);
+               TempBase = AddPath(getcwd(), BasePath);
 
        // Handle /./ at the end of the path
        while (suffixIs(TempBase, "/./"))
@@ -718,7 +661,7 @@ string const ExpandPath(string const & path)
        RTemp = split(RTemp, Temp, '/');
 
        if (Temp == ".") {
-               return lyx::getcwd() /*GetCWD()*/ + '/' + RTemp;
+               return getcwd() + '/' + RTemp;
        }
        if (Temp == "~") {
                return GetEnvPath("HOME") + '/' + RTemp;
@@ -734,6 +677,7 @@ string const ExpandPath(string const & path)
 // Normalize a path
 // Constracts path/../path
 // Can't handle "../../" or "/../" (Asger)
+// Also converts paths like /foo//bar ==> /foo/bar
 string const NormalizePath(string const & path)
 {
        string TempBase;
@@ -746,6 +690,10 @@ string const NormalizePath(string const & path)
                // Make implicit current directory explicit
                RTemp = "./" +path;
 
+       // Normalise paths like /foo//bar ==> /foo/bar
+       boost::RegEx regex("/{2,}");
+       RTemp = STRCONV(regex.Merge(STRCONV(RTemp), "/"));
+
        while (!RTemp.empty()) {
                // Split by next /
                RTemp = split(RTemp, Temp, '/');
@@ -1007,9 +955,9 @@ string const GetExtension(string const & name)
 //      ...static char *...
 // XWD \000\000\000\151        (0x00006900) decimal 105
 //
-// GZIP        \037\213\010\010...     http://www.ietf.org/rfc/rfc1952.txt
+// GZIP        \037\213        http://www.ietf.org/rfc/rfc1952.txt
 // ZIP PK...                   http://www.halyava.ru/document/ind_arch.htm
-// Z   \037\177                UNIX compress
+// Z   \037\235                UNIX compress
 
 /// return the "extension" which belongs to the contents.
 /// for no knowing contents return the extension. Without
@@ -1027,13 +975,13 @@ string const getExtFromContents(string const & filename)
                return string();
 
        // gnuzip
-       string const gzipStamp = "\037\213\010\010";
+       string const gzipStamp = "\037\213";
 
        // PKZIP
        string const zipStamp = "PK";
 
        // compress
-       string const compressStamp = "\037\177";
+       string const compressStamp = "\037\235";
 
        // Maximum strings to read
        int const max_count = 50;
@@ -1186,10 +1134,18 @@ bool zippedFile(string const & name)
 }
 
 
+string const unzippedFileName(string const & zipped_file)
+{
+       string const ext = GetExtension(zipped_file);
+       if (ext == "gz" || ext == "z" || ext == "Z")
+               return ChangeExtension(zipped_file, string());
+       return "unzipped_" + zipped_file;
+}
+
+
 string const unzipFile(string const & zipped_file)
 {
-       string const file = ChangeExtension(zipped_file, string());
-       string  const tempfile = lyx::tempName(string(), file);
+       string  const tempfile = unzippedFileName(zipped_file);
        // Run gunzip
        string const command = "gunzip -c " + zipped_file + " > " + tempfile;
        Systemcall one;
@@ -1200,54 +1156,39 @@ string const unzipFile(string const & zipped_file)
 }
 
 
-// Creates a nice compact path for displaying
-string const
-MakeDisplayPath (string const & path, unsigned int threshold)
+string const MakeDisplayPath(string const & path, unsigned int threshold)
 {
-       string::size_type const l1 = path.length();
+       string str = path;
 
-       // First, we try a relative path compared to home
        string const home(GetEnvPath("HOME"));
-       string relhome = MakeRelPath(path, home);
-
-       string::size_type l2 = relhome.length();
 
-       string prefix;
-
-       // If we backup from home or don't have a relative path,
-       // this try is no good
-       if (prefixIs(relhome, "../") || os::is_absolute_path(relhome)) {
-               // relative path was no good, just use the original path
-               relhome = path;
-               l2 = l1;
-       } else {
-               prefix = "~/";
-       }
+       // replace /home/blah with ~/
+       if (prefixIs(str, home))
+               str = subst(str, home, "~");
 
-       // Is the path too long?
-       if (l2 > threshold) {
-               // Yes, shortend it
-               prefix += ".../";
+       if (str.length() <= threshold)
+               return str;
 
-               string temp;
+       string const prefix = ".../";
+       string temp;
 
-               while (relhome.length() > threshold)
-                       relhome = split(relhome, temp, '/');
+       while (str.length() > threshold)
+               str = split(str, temp, '/');
 
-               // Did we shortend everything away?
-               if (relhome.empty()) {
-                       // Yes, filename in itself is too long.
-                       // Pick the start and the end of the filename.
-                       relhome = OnlyFilename(path);
-                       string const head = relhome.substr(0, threshold/2 - 3);
+       // Did we shorten everything away?
+       if (str.empty()) {
+               // Yes, filename itself is too long.
+               // Pick the start and the end of the filename.
+               str = OnlyFilename(path);
+               string const head = str.substr(0, threshold / 2 - 3);
 
-                       l2 = relhome.length();
-                       string const tail =
-                               relhome.substr(l2 - threshold/2 - 2, l2 - 1);
-                       relhome = head + "..." + tail;
-               }
+               string::size_type len = str.length();
+               string const tail =
+                       str.substr(len - threshold / 2 - 2, len - 1);
+               str = head + "..." + tail;
        }
-       return prefix + relhome;
+
+       return prefix + str;
 }
 
 
@@ -1350,11 +1291,8 @@ void removeAutosaveFile(string const & filename)
        a += OnlyFilename(filename);
        a += '#';
        FileInfo const fileinfo(a);
-       if (fileinfo.exist()) {
-               if (lyx::unlink(a) != 0) {
-                       Alert::err_alert(_("Could not delete auto-save file!"), a);
-               }
-       }
+       if (fileinfo.exist())
+               unlink(a);
 }
 
 
@@ -1363,8 +1301,9 @@ void readBB_lyxerrMessage(string const & file, bool & zipped,
 {
        lyxerr[Debug::GRAPHICS] << "[readBB_from_PSFile] "
                << message << std::endl;
+#warning Why is this func deleting a file? (Lgb)
        if (zipped)
-               lyx::unlink(file);
+               unlink(file);
 }
 
 
@@ -1400,3 +1339,32 @@ string const readBB_from_PSFile(string const & file)
        readBB_lyxerrMessage(file_, zipped, "no bb found");
        return string();
 }
+
+
+int compare_timestamps(string const & file1, string const & file2)
+{
+       Assert(AbsolutePath(file1) && AbsolutePath(file2));
+
+       // If the original is newer than the copy, then copy the original
+       // to the new directory.
+       FileInfo f1(file1);
+       FileInfo f2(file2);
+
+       int cmp = 0;
+       if (f1.exist() && f2.exist()) {
+               double const tmp = difftime(f1.getModificationTime(),
+                                           f2.getModificationTime());
+               if (tmp != 0)
+                       cmp = tmp > 0 ? 1 : -1;
+
+       } else if (f1.exist()) {
+               cmp = 1;
+       } else if (f2.exist()) {
+               cmp = -1;
+       }
+
+       return cmp;
+}
+
+} //namespace support
+} // namespace lyx