move path_expand() and search_path_expand() into libpbd, and use them to expand searc...
[ardour.git] / libs / ardour / utils.cc
index c1192c4fe123acd645572cddd1bd08acbd54b6b6..aedc78988fb293a137536ad7e01a48d66ea15c5e 100644 (file)
@@ -25,6 +25,7 @@
 
 #include <cstdio> /* for sprintf */
 #include <cstring>
+#include <climits>
 #include <cstdlib>
 #include <cmath>
 #include <cctype>
 #include <fcntl.h>
 #include <dirent.h>
 #include <errno.h>
+#include <regex.h>
 
 #include <glibmm/miscutils.h>
 #include <glibmm/fileutils.h>
 
-#ifdef HAVE_WORDEXP
-#include <wordexp.h>
-#endif
-
 #include "pbd/cpus.h"
 #include "pbd/error.h"
 #include "pbd/stacktrace.h"
 #include "pbd/xml++.h"
 #include "pbd/basename.h"
 #include "pbd/strsplit.h"
+#include "pbd/replace_all.h"
 
 #include "ardour/utils.h"
 #include "ardour/rc_configuration.h"
@@ -61,17 +60,91 @@ using namespace ARDOUR;
 using namespace std;
 using namespace PBD;
 
+static string
+replace_chars (const string& str, const string& illegal_chars)
+{
+       string::size_type pos;
+       Glib::ustring legal;
+
+       /* this is the one place in Ardour where we need to iterate across
+        * potential multibyte characters, and thus we need Glib::ustring
+        */
+
+       legal = str;
+       pos = 0;
+
+       while ((pos = legal.find_first_of (illegal_chars, pos)) != string::npos) {
+               legal.replace (pos, 1, "_");
+               pos += 1;
+       }
+
+       return string (legal);
+}
+/** take an arbitrary string as an argument, and return a version of it
+ * suitable for use as a path (directory/folder name). This is the Ardour 3.X
+ * and later version of this code. It defines a very small number of characters
+ * that are not allowed in a path on the build target filesystem (basically,
+ * POSIX or Windows) and replaces any instances of them with an underscore.
+ *
+ * NOTE: this is intended only to legalize for the filesystem that Ardour
+ * is running on. Export should use legalize_for_universal_path() since
+ * the goal there is to be legal across filesystems.
+ */
 string
 legalize_for_path (const string& str)
+{
+       return replace_chars (str, "/\\");
+}
+
+/** take an arbitrary string as an argument, and return a version of it
+ * suitable for use as a path (directory/folder name). This is the Ardour 3.X
+ * and later version of this code. It defines a small number
+ * of characters that are not allowed in a path on any of our target
+ * filesystems, and replaces any instances of them with an underscore.
+ *
+ * NOTE: this is intended to create paths that should be legal on
+ * ANY filesystem.
+ */
+string
+legalize_for_universal_path (const string& str)
+{
+       return replace_chars (str, "<>:\"/\\|?*");
+}
+
+/** Legalize for a URI path component.  This is like
+ * legalize_for_universal_path, but stricter, disallowing spaces and hash.
+ * This avoids %20 escapes in URIs, but probably needs work to be more strictly
+ * correct.
+ */
+string
+legalize_for_uri (const string& str)
+{
+       return replace_chars (str, "<>:\"/\\|?* #");
+}
+
+/** take an arbitrary string as an argument, and return a version of it
+ * suitable for use as a path (directory/folder name). This is the Ardour 2.X
+ * version of this code, which used an approach that came to be seen as
+ * problematic: defining the characters that were allowed and replacing all
+ * others with underscores. See legalize_for_path() for the 3.X and later
+ * version.
+ */
+
+string 
+legalize_for_path_2X (const string& str)
 {
        string::size_type pos;
-       string illegal_chars = "/\\"; /* DOS, POSIX. Yes, we're going to ignore HFS */
-       string legal;
+       string legal_chars = "abcdefghijklmnopqrtsuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_+=: ";
+        Glib::ustring legal;
+       
+       /* this is the one place in Ardour where we need to iterate across
+        * potential multibyte characters, and thus we need Glib::ustring
+        */
 
        legal = str;
        pos = 0;
 
-       while ((pos = legal.find_first_of (illegal_chars, pos)) != string::npos) {
+       while ((pos = legal.find_first_not_of (legal_chars, pos)) != string::npos) {
                legal.replace (pos, 1, "_");
                pos += 1;
        }
@@ -121,46 +194,6 @@ bump_name_once (const std::string& name, char delimiter)
 
 }
 
-bool
-could_be_a_valid_path (const string& path)
-{
-        vector<string> posix_dirs;
-        vector<string> dos_dirs;
-        string testpath;
-
-        split (path, posix_dirs, '/');
-        split (path, dos_dirs, '\\');
-
-        /* remove the last component of each */
-
-        posix_dirs.erase (--posix_dirs.end());
-        dos_dirs.erase (--dos_dirs.end());
-
-        if (G_DIR_SEPARATOR == '/') {
-                for (vector<string>::iterator x = posix_dirs.begin(); x != posix_dirs.end(); ++x) {
-                        testpath = Glib::build_filename (testpath, *x);
-                        cerr << "Testing " << testpath << endl;
-                        if (!Glib::file_test (testpath, Glib::FILE_TEST_IS_DIR|Glib::FILE_TEST_EXISTS)) {
-                                return false;
-                        }
-                }
-        }
-
-        if (G_DIR_SEPARATOR == '\\') {
-                testpath = "";
-                for (vector<string>::iterator x = dos_dirs.begin(); x != dos_dirs.end(); ++x) {
-                        testpath = Glib::build_filename (testpath, *x);
-                        cerr << "Testing " << testpath << endl;
-                        if (!Glib::file_test (testpath, Glib::FILE_TEST_IS_DIR|Glib::FILE_TEST_EXISTS)) {
-                                return false;
-                        }
-                }
-        }
-
-        return true;
-}
-
-
 XMLNode *
 find_named_node (const XMLNode& node, string name)
 {
@@ -274,66 +307,6 @@ path_is_paired (string path, string& pair_base)
        return false;
 }
 
-string
-path_expand (string path)
-{
-        if (path.empty()) {
-                return path;
-        }
-
-#ifdef HAVE_WORDEXP
-       /* Handle tilde and environment variable expansion in session path */
-       string ret = path;
-
-       wordexp_t expansion;
-       
-       /* force field expansion to avoid use whitespace, since we know this is
-        * a path
-        */
-
-       char *oifs = getenv ("IFS");
-       setenv ("IFS", "/", 1);
-       int result = wordexp (path.c_str(), &expansion, WRDE_NOCMD|WRDE_UNDEF);
-       if (oifs) {
-               setenv ("IFS", oifs, 1);
-       } else {
-               unsetenv ("IFS");
-       }
-
-       switch (result) {
-       case 0:
-               break;
-       case WRDE_NOSPACE:
-               /* see docs on wordexp() */
-               wordfree (&expansion);
-               /* fallthru */
-       default:
-               error << string_compose (_("illegal or badly-formed string used for path (%1)"), path) << endmsg;
-               goto out;
-       }
-
-       if (expansion.we_wordc > 1) {
-               string all;
-               for (unsigned int i = 0; i < expansion.we_wordc; ++i) {
-                       if (i > 0) {
-                               all += " | ";
-                       } 
-                       all += expansion.we_wordv[i];
-               }
-               error << string_compose (_("path (%1) is ambiguous: %2"), path, all) << endmsg;
-               goto out;
-       }
-
-       ret = expansion.we_wordv[0];
-  out:
-       wordfree (&expansion);
-       return ret;
-
-#else
-       return path;
-#endif
-}
-
 #if __APPLE__
 string
 CFStringRefToStdString(CFStringRef stringRef)
@@ -446,7 +419,14 @@ sync_source_to_string (SyncSource src, bool sh)
                }
 
        case MIDIClock:
-               return _("MIDI Clock");
+               if (sh) {
+                       return _("M-Clock");
+               } else {
+                       return _("MIDI Clock");
+               }
+
+       case LTC:
+               return _("LTC");
        }
        /* GRRRR .... stupid, stupid gcc - you can't get here from there, all enum values are handled */
        return _("JACK");
@@ -582,25 +562,6 @@ bool_as_string (bool yn)
        return (yn ? "yes" : "no");
 }
 
-bool
-string_is_affirmative (const std::string& str)
-{
-       /* to be used only with XML data - not intended to handle user input */
-
-       if (str.empty ()) {
-               return false;
-       }
-
-       /* the use of g_strncasecmp() is solely to get around issues with
-        * charsets posed by trying to use C++ for the same
-        * comparison. switching a std::string to its lower- or upper-case
-        * version has several issues, but handled by default
-        * in the way we desire when doing it in C.
-        */
-
-       return str == "1" || str == "y" || str == "Y" || (!g_strncasecmp(str.c_str(), "yes", str.length()));
-}
-
 const char*
 native_header_format_extension (HeaderFormat hf, const DataType& type)
 {