Merge branch 'feature-issue58'

* feature-issue58:
  * Implemented support for 'pattern' attribute, Validator::GetPattern() and SetPattern() & tests. * Also updated documentation for 'pattern' attribute. For issue #58.
  Moved Validator::GetDriveLetter() and Validator::GetDrivePath() to DriveClass.h.
  Updated documentation of 'inverse' attribute regarding 'class' attribute of <visibility> and <validity> elements. For issue #58.
  Added missing elements in User Manual TOC. Fixed minor issues in the USer Manual documentation.
  Updated documentation about fileextensions and unit tests.
  Updated documentation for 'class' attribute of <visibility> and <validity> elements. For issue #58.
  Implemented parsing of 'class' attribute for <visibility> and <validity> elements. For issue #58.
  Implemented support for 'class' attribute, Validator::GetClass() and SetClass() & tests. For issue #58.
  Moved GetDriveLetter() and GetDrivePath() functions from Context.cpp to Validator class. These functions will be required for Implementing the Validator's 'class' attribute. Moved validation code in Validator::Validate() of each attributes into their own functions. This is to allow reusability and to reduce the complexity of the Validator::Validate() function.
  Code cleanup.
  The function `WildcardMatch()` have a new algorithm which is much faster and simpler to understand. Modified unit tests to test both `WildcardSolve()` and `WildcardMatch()`. Completed Wildcard.h functions for issue #58.
  Code cleanup. Also updated WildcardSolve() function to use size_t instead of int. Fixed a minor bug in the solving algorithm.
  Partially reverted 17b6225 back to a98b66d (with some variations)
  Partial implementation for WildcardMatch() function.
  Completed documentation of Wildcard.h
  First draft of wildcard functions. For issue #58.
  Enalbed building of branch feature-issue58 on appveyor.
  Updated user manual for properties `selection.drive.letter` and  `selection.drive.path`. For issue #58.
  Created properties `selection.drive.letter` and  `selection.drive.path`. For issue #58.

Author: end2endzone

CHANGES

@@ -8,6 +8,7 @@ Changes for 0.5.0
 * Fixed issue #51: Action "Open command prompt here" from default.xml configuration does not work.
 * Fixed issue #52: Define a specific property for use as separator for handling multiple file selection.
 * Fixed issue #55: Menu name maximum length limit and escape string.
+* Fixed issue #58: More useful features: class and pattern attributes for validity / visibility.
 * Fixed issue #61: Support for WIX installer.
 * Fixed issue #66: Github don't identify the repository LICENSE as MIT.
 * Fixed issue #68: INSTALL.md mentions that 'application does not provides pre-build binaries' which is incorrect.

UserManual.md

@@ -94,6 +94,26 @@ namespace shellanything
     /// </summary>
     void SetFileExists(const std::string & iFileExists);
 
+    /// <summary>
+    /// Getter for the 'class' parameter.
+    /// </summary>
+    const std::string & GetClass() const;
+
+    /// <summary>
+    /// Setter for the 'class' parameter.
+    /// </summary>
+    void SetClass(const std::string & iClass);
+
+    /// <summary>
+    /// Getter for the 'pattern' parameter.
+    /// </summary>
+    const std::string & GetPattern() const;
+
+    /// <summary>
+    /// Setter for the 'pattern' parameter.
+    /// </summary>
+    void SetPattern(const std::string & iPattern);
+
     /// <summary>
     /// Getter for the 'inserve' parameter.
     /// </summary>
@@ -125,12 +145,22 @@ namespace shellanything
     /// <returns>Returns true if the given context is valid against the set of constraints. Returns false otherwise.</returns>
     bool Validate(const Context & iContext) const;
 
+  private:
+    bool ValidateProperties(const Context & context, const std::string & properties, bool inversed) const;
+    bool ValidateFileExtensions(const Context & context, const std::string & file_extensions, bool inversed) const;
+    bool ValidateExists(const Context & context, const std::string & file_exists, bool inversed) const;
+    bool ValidateClass(const Context & context, const std::string & class_, bool inversed) const;
+    bool ValidateClassSingle(const Context & context, const std::string & class_, bool inversed) const;
+    bool ValidatePattern(const Context & context, const std::string & pattern, bool inversed) const;
+
   private:
     int mMaxFiles;
     int mMaxDirectories;
     std::string mProperties;
     std::string mFileExtensions;
     std::string mFileExists;
+    std::string mClass;
+    std::string mPattern;
     std::string mInverse;
   };
 

include/shellanything/Validator.h

@@ -70,12 +70,16 @@ add_library(shellanything STATIC
   Unicode.h
   Unicode.cpp
   Validator.cpp
+  DriveClass.h
+  DriveClass.cpp
   ErrorManager.h
   ErrorManager.cpp
   PropertyManager.h
   PropertyManager.cpp
   Win32Clipboard.h
   Win32Clipboard.cpp
+  Wildcard.cpp
+  Wildcard.h
 )
 
 add_library(shellext SHARED

src/CMakeLists.txt

@@ -23,7 +23,9 @@
  *********************************************************************************/
 
 #include "shellanything/Context.h"
+#include "shellanything/Validator.h"
 #include "PropertyManager.h"
+#include "DriveClass.h"
 
 #include "rapidassist/filesystem_utf8.h"
 #include "rapidassist/environment_utf8.h"
@@ -74,6 +76,8 @@ namespace shellanything
     std::string selection_filename       ;
     std::string selection_filename_noext ;
     std::string selection_filename_ext   ;
+    std::string selection_drive_letter   ;
+    std::string selection_drive_path     ;
 
     // Get the separator string for multiple selection 
     const std::string & selection_multi_separator = pmgr.GetProperty(Context::MULTI_SELECTION_SEPARATOR_PROPERTY_NAME);
@@ -97,23 +101,28 @@ namespace shellanything
       std::string element_selection_filename        = ra::filesystem::GetFilename(element_selection_path.c_str());
       std::string element_selection_filename_noext  = ra::filesystem::GetFilenameWithoutExtension(element_selection_path.c_str());
       std::string element_selection_filename_ext    = ra::filesystem::GetFileExtention(element_selection_filename);
+      std::string element_selection_drive_letter    = GetDriveLetter(element);
+      std::string element_selection_drive_path      = GetDrivePath(element);
 
-      // Append this specific element properties to the global property string
- 
-      // Add a newline if the property value is not empty. This allows printing all file path on individual lines
+      // Add a separator between values
       if (!selection_path           .empty()) selection_path            .append( selection_multi_separator );
       if (!selection_parent_path    .empty()) selection_parent_path     .append( selection_multi_separator );
       if (!selection_parent_filename.empty()) selection_parent_filename .append( selection_multi_separator );
       if (!selection_filename       .empty()) selection_filename        .append( selection_multi_separator );
       if (!selection_filename_noext .empty()) selection_filename_noext  .append( selection_multi_separator );
       if (!selection_filename_ext   .empty()) selection_filename_ext    .append( selection_multi_separator );
- 
+      if (!selection_drive_letter   .empty()) selection_drive_letter    .append( selection_multi_separator );
+      if (!selection_drive_path     .empty()) selection_drive_path      .append( selection_multi_separator );
+
+      // Append this specific element properties to the global property string
       selection_path           .append( element_selection_path            );
       selection_parent_path    .append( element_selection_parent_path     );
       selection_parent_filename.append( element_selection_parent_filename );
       selection_filename       .append( element_selection_filename        );
       selection_filename_noext .append( element_selection_filename_noext  );
       selection_filename_ext   .append( element_selection_filename_ext    );
+      selection_drive_letter   .append( element_selection_drive_letter    );
+      selection_drive_path     .append( element_selection_drive_path      );
     }
 
     pmgr.SetProperty("selection.path"               , selection_path           );
@@ -122,6 +131,8 @@ namespace shellanything
     pmgr.SetProperty("selection.filename"           , selection_filename       );
     pmgr.SetProperty("selection.filename.noext"     , selection_filename_noext );
     pmgr.SetProperty("selection.filename.extension" , selection_filename_ext   );
+    pmgr.SetProperty("selection.drive.letter"       , selection_drive_letter   );
+    pmgr.SetProperty("selection.drive.path"         , selection_drive_path     );
   }
 
   void Context::UnregisterProperties() const
@@ -133,6 +144,8 @@ namespace shellanything
     pmgr.ClearProperty("selection.filename"           );
     pmgr.ClearProperty("selection.filename.noext"     );
     pmgr.ClearProperty("selection.filename.extension" );
+    pmgr.ClearProperty("selection.drive.letter"       );
+    pmgr.ClearProperty("selection.drive.path"         );
   }
 
   const Context::ElementList & Context::GetElements() const

src/Context.cpp

@@ -0,0 +1,168 @@
+/**********************************************************************************
+ * MIT License
+ * 
+ * Copyright (c) 2018 Antoine Beauchamp
+ * 
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *********************************************************************************/
+
+#include "DriveClass.h"
+#include "shellanything/Validator.h"
+
+#include <Windows.h>
+
+namespace shellanything
+{
+
+  inline bool IsDriveLetter(char c)
+  {
+    if (  (c >= 'a' && c <= 'z') ||
+          (c >= 'A' && c <= 'Z')    )
+      return true;
+    return false;
+  }
+
+  std::string GetDriveLetter(const std::string & element)
+  {
+    std::string letter;
+    if (element.size() >= 2 && element[1] == ':' && IsDriveLetter(element[0]))
+      letter.append(1, element[0]);
+    return letter;
+  }
+
+  std::string GetDrivePath(const std::string & element)
+  {
+    std::string letter;
+    if (element.size() >= 3 && element[1] == ':' && IsDriveLetter(element[0]) && element[2] == '\\')
+      letter.append(element.c_str(), 3);
+    return letter;
+  }
+
+  bool IsNetworkPath(const std::string & path)
+  {
+    if (path.size() >= 2 && path.substr(0, 2) == "\\\\")
+    {
+      // The path starts with \\
+      // Extract hostname
+      const char * hostname = &path[2];
+      if (hostname[0] != '\0')
+      {
+        // Get first character of hostname
+        char first = hostname[0];
+        if ((first >= 'a' && first <= 'z') ||
+            (first >= 'A' && first <= 'Z') ||
+            (first >= '0' && first <= '9')  )
+        {
+          return true;
+        }
+      }
+    }
+    return false;
+  }
+
+  DRIVE_CLASS GetDriveClassFromPath(const std::string & path)
+  {
+    // Patch for DRIVE_CLASS_NETWORK.
+    // The function GetDriveTypeA() will return DRIVE_UNKNOWN when the given path is a network path.
+    // For example \\localhost\shared\public will be reported as DRIVE_UNKNOWN.
+    // To get the expected DRIVE_REMOTE returned value, the shared directory 'shared' must be mapped to a drive letter.
+    // For example, mapping \\localhost\shared to Z:, calling GetDriveTypeA("Z:\public") will return DRIVE_REMOTE.
+    // This is not what we want. The value DRIVE_CLASS_NETWORK is expected when the given path is a network path.
+    if (IsNetworkPath(path))
+      return DRIVE_CLASS_NETWORK;
+
+    UINT dwDriveType = GetDriveTypeA(path.c_str());
+    switch(dwDriveType)
+    {
+    case DRIVE_NO_ROOT_DIR:
+      {
+        // The function GetDriveTypeA() returns DRIVE_NO_ROOT_DIR on a path that does not exist,
+        // if the given path is a file, or if the given path is a directory that is not the root directory.
+        // The functions returns DRIVE_NO_ROOT_DIR even if the drive letter, of the given non-existing path, is a CD-ROM or DVD-Drive.
+        // However, the function will return DRIVE_CDROM is the root path of the same path is used, even if there are no disk in the optical drive.
+        // To work around these issues, try to resolve with the root path of the drive.
+        std::string root_path = GetDrivePath(path);
+        if (root_path.empty() || // We may be dealing with a network path
+            root_path == path  ) // We are already using a root drive path
+        {
+          // There is nothing we can do.
+          return DRIVE_CLASS_UNKNOWN;
+        }
+        
+        // Try to resolve with the root path instead
+        DRIVE_CLASS resolved = GetDriveClassFromPath(root_path);
+        return resolved;
+      }
+      break;
+    case DRIVE_REMOVABLE:
+      return DRIVE_CLASS_REMOVABLE;
+    case DRIVE_FIXED:
+      return DRIVE_CLASS_FIXED;
+    case DRIVE_REMOTE:
+      return DRIVE_CLASS_NETWORK;
+    case DRIVE_CDROM:
+      return DRIVE_CLASS_OPTICAL;
+    case DRIVE_RAMDISK:
+      return DRIVE_CLASS_RAMDISK;
+
+    default:
+      return DRIVE_CLASS_UNKNOWN;
+    };
+  }
+
+  DRIVE_CLASS GetDriveClassFromString(const std::string & value)
+  {
+    if (value == "drive:removable")
+      return DRIVE_CLASS_REMOVABLE;
+    if (value == "drive:fixed")
+      return DRIVE_CLASS_FIXED;
+    if (value == "drive:network")
+      return DRIVE_CLASS_NETWORK;
+    if (value == "drive:optical")
+      return DRIVE_CLASS_OPTICAL;
+    if (value == "drive:ramdisk")
+      return DRIVE_CLASS_RAMDISK;
+    if (value == "drive:unknown")
+      return DRIVE_CLASS_UNKNOWN;
+
+    return DRIVE_CLASS_UNKNOWN;
+  }
+
+  const char * ToString(DRIVE_CLASS & value)
+  {
+    switch(value)
+    {
+    case DRIVE_CLASS_REMOVABLE:
+      return "drive:removable";
+    case DRIVE_CLASS_FIXED:
+      return "drive:fixed";
+    case DRIVE_CLASS_NETWORK:
+      return "drive:network";
+    case DRIVE_CLASS_OPTICAL:
+      return "drive:optical";
+    case DRIVE_CLASS_RAMDISK:
+      return "drive:ramdisk";
+    default:
+      return "drive:unknown";
+    };
+  }
+
+
+
+} //namespace shellanything