System - Handle Quoted Arguments in Environment::exec (#38)

* System - Handle Quoted Arguments in Environment::exec

* Helpers - Remove trailing quotes in splitArgs

* Update CHANGELOG.md

* Update CHANGELOG.md

Author: nlogozzo

CHANGELOG.md

@@ -5,9 +5,13 @@
 None
 ### New APIs
 - Added support for `macOS` across the library
-- `Nickvision::Systems::SuspendInhibitor` class
+#### Helpers
+- `Nickvision::Helpers::StringHelpers::splitArgs()`
+#### System
+- `Nickvision::System::SuspendInhibitor` class
 ### Fixes
-None
+#### System
+- `Nickvision::System::Environment::exec()` now correctly handles quotes args
 
 ## 2024.6.6
 ### Breaking Changes

docs/helpers.md

@@ -96,6 +96,12 @@ Path: `Nickvision::Helpers::StringHelpers`
     - Returns: A list of the splits of s on delimiter and casted to type T. 
     - Note: T requires the `StringImplicitlyConstructible` concept defined as: `std::is_constructible_v<T, std::string> && std::is_convertible_v<std::string, T>`.
     - Ex: `StringHelpers::split<std::string>("1,2,3,4", ",")` will return `std::vector<std::string>{ "1", "2", "3", "4" }`.
+- ```cpp
+  std::vector<std::string> splitArgs(std::string s)
+  ```
+    - Accepts: A string parameter, s.
+    - Returns: A list of the splits of s on argument delimiters.
+    - Ex: `StringHelpers::splitArgs("echo \"Hello World\"")` will return `std::vector<std::string>{ "echo", "Hello World" }`.
 - ```cpp
   std::string str(const std::wstring& s)
   ```

include/helpers/stringhelpers.h

@@ -92,6 +92,12 @@ namespace Nickvision::Helpers::StringHelpers
         }
         return splits;
     }
+    /**
+     * @brief Splits a string based on argument delimiters.
+     * @param s The string to split
+     * @return The splits of the argument string
+     */
+    std::vector<std::string> splitArgs(std::string s);
     /**
      * @brief Converts the wstring to a string.
      * @param s The wstring to convert

src/helpers/stringhelpers.cpp

@@ -212,6 +212,28 @@ namespace Nickvision::Helpers
         return s;
     }
 
+    std::vector<std::string> StringHelpers::splitArgs(std::string s)
+    {
+        std::vector<std::string> args;
+        std::regex regex{ "((?:[^\\s'\"]+|\"[^\"]*\"|'[^']*')+)" };
+        std::smatch match;
+        while (std::regex_search(s, match, regex))
+        {
+            std::string arg{ match.str() };
+            if((arg[0] == '\'' && arg[arg.size() - 1] == '\'') || (arg[0] == '"' && arg[arg.size() - 1] == '"'))
+            {
+                arg = arg.substr(1, arg.size() - 2);
+            }
+            args.push_back(arg);
+            s = match.suffix();
+        }
+        if(!s.empty())
+        {
+            args.push_back(s);
+        }
+        return args;
+    }
+
     std::string StringHelpers::str(const std::wstring& s)
     {
         std::wstring_convert<std::codecvt_utf8<wchar_t>> converter;
@@ -273,13 +295,13 @@ namespace Nickvision::Helpers
         }
         std::string result{ s };
         result.erase(std::find_if(result.rbegin(), result.rend(), [delimiter](char ch)
-            {
-                return ch != delimiter;
-            }).base(), result.end());
+        {
+            return ch != delimiter;
+        }).base(), result.end());
         result.erase(result.begin(), std::find_if(result.begin(), result.end(), [delimiter](char ch)
-            {
+        {
                 return ch != delimiter;
-            }));
+        }));
         return result;
     }
 

src/notifications/shellnotification.cpp

@@ -2,10 +2,8 @@
 #include <filesystem>
 #include <memory>
 #include <string>
-#include <vector>
 #include "app/aura.h"
 #include "system/environment.h"
-#include "system/process.h"
 #ifdef _WIN32
 #include "notifications/notifyicon.h"
 #include "notifications/notifyiconmenu.h"
@@ -74,9 +72,7 @@ namespace Nickvision::Notifications
 #elif defined(__APPLE__)
     void ShellNotification::send(const ShellNotificationSentEventArgs& e)
     {
-        std::vector<std::string> args{ "-e", "display notification \"" + e.getMessage() + "\" with title \"" + e.getTitle() + "\"" };
-        Process process{ "osascript", args };
-        process.start();
+        Environment::exec("osascript -e 'display notification \"" + e.getMessage() + "\" with title \"" + e.getTitle() + "\"'");
     }
 #endif
 }

src/system/environment.cpp

@@ -40,10 +40,10 @@ namespace Nickvision::System
         {
             return "";
         }
+        std::vector<std::string> args{ StringHelpers::splitArgs(command) };
 #ifdef _WIN32
-        Process process{ "cmd.exe", { "/C", "\"" + command + "\"" } };
+        Process process{ "cmd.exe", { "/C", StringHelpers::join(args, " ", false) } };
 #else
-        std::vector<std::string> args{ StringHelpers::split(command, " ") };
         std::string cmd{ args[0] };
         args.erase(args.begin());
         Process process{ cmd, args };
@@ -52,7 +52,7 @@ namespace Nickvision::System
         {
             process.waitForExit();
             return process.getOutput();
-        }        
+        }
         return "";
     }
 }

tests/stringtests.cpp

@@ -51,6 +51,25 @@ TEST(StringTests, Split1)
     ASSERT_EQ(cmd[3], "-y");
 }
 
+TEST(StringTests, Split2)
+{
+    std::vector<std::string> cmd{ StringHelpers::splitArgs("libnick -t 'fg sg' \"Hello World\"")};
+    ASSERT_EQ(cmd.size(), 4);
+    ASSERT_EQ(cmd[0], "libnick");
+    ASSERT_EQ(cmd[1], "-t");
+    ASSERT_EQ(cmd[2], "fg sg");
+    ASSERT_EQ(cmd[3], "Hello World");
+}
+
+TEST(StringTests, Split3)
+{
+    std::vector<std::string> cmd{ StringHelpers::splitArgs("osascript -e 'display notification \"Message\" with title \"Title\"'")};
+    ASSERT_EQ(cmd.size(), 3);
+    ASSERT_EQ(cmd[0], "osascript");
+    ASSERT_EQ(cmd[1], "-e");
+    ASSERT_EQ(cmd[2], "display notification \"Message\" with title \"Title\"");
+}
+
 TEST(StringTests, Guid1)
 {
     std::string s;

tests/systemtests.cpp

@@ -41,9 +41,9 @@ TEST_F(SystemTest, ClearTestVar)
 TEST_F(SystemTest, Exec)
 {
 #ifdef _WIN32
-    ASSERT_EQ(Environment::exec("echo Hello World"), "Hello World\r\n");
+    ASSERT_EQ(Environment::exec("echo \"Hello World\""), "Hello World\r\n");
 #else
-    ASSERT_EQ(Environment::exec("echo Hello World"), "Hello World\n");
+    ASSERT_EQ(Environment::exec("echo \"Hello World\""), "Hello World\n");
 #endif
 }