Make path quoting algorithm available for external use

Needed in libappimage.

Author: TheAssassin

include/XdgUtils/DesktopEntry/DesktopEntryExecValue.h

@@ -48,6 +48,13 @@ namespace XdgUtils {
              */
             void remove(int pos);
 
+            /**
+             * Quote path for use in desktop entry.
+             * For use with keys like Exec, TryExec.
+             * @param string
+             */
+            static std::string quotePath(const std::string& string);
+
         private:
             struct Priv;
             std::unique_ptr<Priv> priv;

src/DesktopEntry/DesktopEntryExecValue.cpp

@@ -5,14 +5,12 @@
 
 // local
 #include <XdgUtils/DesktopEntry/DesktopEntryExecValue.h>
-#include <set>
+#include <algorithm>
 
 namespace XdgUtils {
     namespace DesktopEntry {
         struct DesktopEntryExecValue::Priv {
             std::vector<std::string> sections;
-            std::string escapedCharacters = "\"`$\\";
-            std::string reservedCharacters = " \t\n\"\'\\<>~|&;$*?#()`";
 
             void parse(const std::string& value) {
                 // marks when the next char was escaped
@@ -66,38 +64,21 @@ namespace XdgUtils {
 
             std::string dump() {
                 bool firstSection = true;
+
                 std::stringstream res;
+
                 for (const auto& section: sections) {
-                    if (firstSection)
+                    if (firstSection) {
                         firstSection = false;
-                    else
+                    } else {
                         res << " ";
+                    }
 
-                    if (containsReservedCharacter(section)) {
-                        // dump escaped section
-                        res << "\"";
-                        for (const auto& c: section) {
-                            if (escapedCharacters.find(c) != std::string::npos)
-                                res << "\\";
-                            res << c;
-                        }
-                        res << "\"";
-
-                    } else
-                        res << section;
-
+                    res << quotePath(section);
                 }
-                return res.str();
-            }
 
-            bool containsReservedCharacter(const std::string& string) {
-                for (const auto& c: string)
-                    if (reservedCharacters.find(c) != std::string::npos)
-                        return true;
-
-                return false;
+                return res.str();
             }
-
         };
 
         DesktopEntryExecValue::DesktopEntryExecValue() : priv(new Priv()) {}
@@ -127,6 +108,37 @@ namespace XdgUtils {
         void DesktopEntryExecValue::remove(int pos) {
             priv->sections.erase(priv->sections.begin() + pos);
         }
+
+        std::string DesktopEntryExecValue::quotePath(const std::string& string) {
+            // these characters need to be escaped with a backslash (\)
+            static const std::string charactersToEscape = "\"`$\\";
+            // the following characters don't require escaping but can be used fine with simple quoting
+            static const std::string charactersWhichRequireQuoting = " \t\n\'<>~|&;*?#()";
+            // we may need the combined list more than once and therefore cache it in a variable
+            static const std::string reservedCharacters = charactersWhichRequireQuoting + charactersToEscape;
+
+            std::ostringstream res;
+
+            // some paths don't need to be quoted
+            // in that case, we don't prepend/append quotes
+            bool needsToBeQuoted = std::find_if(string.begin(), string.end(), [](const char c) {
+                return reservedCharacters.find(c) != std::string::npos;
+            }) != string.end();
+
+            if (!needsToBeQuoted) {
+                return string;
+            }
+
+            res << "\"";
+            for (const auto& c: string) {
+                if (charactersToEscape.find(c) != std::string::npos)
+                    res << "\\";
+                res << c;
+            }
+            res << "\"";
+
+            return res.str();
+        }
     }
 }
 

tests/DesktopEntry/TestDesktopEntryExecValue.cpp

@@ -55,3 +55,23 @@ TEST(TestDesktopDesktopEntryExecValue, remove) {
     ASSERT_EQ(stringList.size(), 1);
     ASSERT_EQ(stringList[0], "2");
 }
+
+TEST(TestDesktopDesktopEntryExecValue, testQuoteComplexPath) {
+    const std::string testPath = "/home/abc/Applications/a \t <>~ | % ;#()? \" b c $ `.AppImage";
+    const std::string expectedQuotedPath = "\"/home/abc/Applications/a \t <>~ | % ;#()? \\\" b c \\$ \\`.AppImage\"";
+
+    const auto quotedPath = DesktopEntryExecValue::quotePath(testPath);
+
+    std::cout << quotedPath << std::endl;
+    std::cout << expectedQuotedPath << std::endl;
+
+    EXPECT_EQ(quotedPath, expectedQuotedPath);
+}
+
+TEST(TestDesktopDesktopEntryExecValue, testQuoteSimplePath) {
+    const std::string testPath = R"(/home/abc/Applications/abc.AppImage)";
+
+    const auto quotedPath = DesktopEntryExecValue::quotePath(testPath);
+
+    EXPECT_EQ(quotedPath, testPath);
+}