Add getValidQueues function to parser utilities

src/webqueue2api/parser/utilities.py

@@ -1,7 +1,14 @@
 """A collection of utilities to be used throughout the webqueue2 API.
 """
+import re, os
+
+
+#------------------------------------------------------------------------------#
+# Configuration
+#------------------------------------------------------------------------------#
+queueDirectory = "/home/pier/e/queue/Mail"
+
 
-import re
 
 def isValidItemName(name: str) -> bool:
     """Returns true if file name is a valid item name
@@ -17,4 +24,26 @@ def isValidItemName(name: str) -> bool:
             bool: Name is valid item name.
     """
     itemPattern = re.compile("^[0123456789]{1,3}$")
-    return True if itemPattern.match(name) else False
+    return True if itemPattern.match(name) else False
+
+queuesToIgnore = ["archives", "drafts", "inbox", "coral"]
+def getValidQueues() -> list:
+    """Returns a list of queues on the filesystem excluding ignored queues.
+
+    Example:
+            ["bidc", "me", "ce"]
+
+    Returns:
+            list: Valid queues
+    """
+    queues = []
+
+    for file in os.listdir(queueDirectory):
+        currentFile = queueDirectory + "/" + file
+        isDirectory = os.path.isdir(currentFile)
+        isValid = file not in queuesToIgnore
+
+        if isDirectory and isValid:
+            queues.append(file)
+
+    return queues