Merge branch 'api6'

ampache · Aug 30, 2023 · d64fd3c · d64fd3c
2 parents 4d56560 + fc7a851
commit d64fd3c
Show file tree

Hide file tree

Showing 6 changed files with 71 additions and 1 deletion.
diff --git a/docs/json-responses/system_preference.json b/docs/json-responses/system_preference.json
@@ -0,0 +1,10 @@
+{
+    "id": 123,
+    "name": "ajax_load",
+    "level": 25,
+    "description": "Ajax page load",
+    "value": "1",
+    "type": "boolean",
+    "category": "interface",
+    "subcategory": null
+}
diff --git a/docs/json-responses/user_preference.json b/docs/json-responses/user_preference.json
@@ -0,0 +1,10 @@
+{
+    "id": 123,
+    "name": "ajax_load",
+    "level": 25,
+    "description": "Ajax page load",
+    "value": "1",
+    "type": "boolean",
+    "category": "interface",
+    "subcategory": null
+}
diff --git a/docs/xml-responses/system_preference.xml b/docs/xml-responses/system_preference.xml
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<root>
+  <preference id="123">
+    <name><![CDATA[ajax_load]]></name>
+    <level>25</level>
+    <description><![CDATA[Ajax page load]]></description>
+    <value>1</value>
+    <type><![CDATA[boolean]]></type>
+    <category><![CDATA[interface]]></category>
+    <subcategory><![CDATA[]]></subcategory>
+  </preference>
+</root>
diff --git a/docs/xml-responses/user_preference.xml b/docs/xml-responses/user_preference.xml
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<root>
+  <preference id="123">
+    <name><![CDATA[ajax_load]]></name>
+    <level>25</level>
+    <description><![CDATA[Ajax page load]]></description>
+    <value>1</value>
+    <type><![CDATA[boolean]]></type>
+    <category><![CDATA[interface]]></category>
+    <subcategory><![CDATA[]]></subcategory>
+  </preference>
+</root>
diff --git a/src/_meta.py b/src/_meta.py
@@ -14,6 +14,6 @@
 """
 
 __author__ = "Lachlan de Waard (lachlan-00)"
-__version__ = "6.0.1"
+__version__ = "6.1.0"
 
 DEBUG = False
diff --git a/src/ampache.py b/src/ampache.py
@@ -1721,6 +1721,32 @@ def catalog_file(self, file, task, catalog_id):
             return False
         return self.return_data(ampache_response)
 
+    def catalog_folder(self, folder, task, catalog_id):
+        """ catalog_folder
+            MINIMUM_API_VERSION=6.0.0
+
+            Perform actions on local catalog folders.
+            Single folder versions of catalog add, clean and verify.
+            Make sure you remember to urlencode those folder names!
+
+            INPUTS
+            * folder        = (string) urlencode(FULL path to local folder)
+            * task        = (string) 'add'|'clean'|'verify'|'remove'
+            * catalog_id  = (integer) $catalog_id
+        """
+        ampache_url = self.AMPACHE_URL + '/server/' + self.AMPACHE_API + '.server.php'
+        data = {'action': 'catalog_folder',
+                'auth': self.AMPACHE_SESSION,
+                'folder': folder,
+                'task': task,
+                'catalog': catalog_id}
+        data = urllib.parse.urlencode(data)
+        full_url = ampache_url + '?' + data
+        ampache_response = self.fetch_url(full_url, self.AMPACHE_API, 'catalog_action')
+        if not ampache_response:
+            return False
+        return self.return_data(ampache_response)
+
     def podcasts(self, filter_str: str = False,
                  exact: int = False, offset=0, limit=0):
         """ podcasts