Manage struct plugin.

See https://www.dokuwiki.org/plugin:struct:remote_api for details.

Author: fmenabe

doc/source/index.rst

@@ -42,6 +42,12 @@ Medias
     :members: changes, list, get, set, info, add, delete
     :member-order: bysource
 
+Structs
+~~~~~~~
+.. autoclass:: _Structs
+    :members: get_data, save_data, get_schema, get_aggregation_data
+    :member-order: bysource
+
 Dataentries
 ~~~~~~~~~~~
 .. autoclass:: Dataentry

dokuwiki.py

@@ -96,6 +96,7 @@ def __init__(self, url, user, password, **kwargs):
         # Set "namespaces" for pages and medias functions.
         self.pages = _Pages(weakref.ref(self)())
         self.medias = _Medias(weakref.ref(self)())
+        self.structs = _Structs(weakref.ref(self)())
 
     def send(self, command, *args, **kwargs):
         """Generic method for executing an XML-RPC *command*. *args* and
@@ -379,6 +380,29 @@ def delete(self, media):
         return self._dokuwiki.send('wiki.deleteAttachment', media)
 
 
+class _Structs(object):
+    def __init__(self, dokuwiki):
+        """Get the structured data of a given page."""
+        self._dokuwiki = dokuwiki
+
+    def get_data(self, page, schema, timestamp=0):
+        """Get the structured data of a given page."""
+        return self._dokuwiki.send('plugin.struct.getData', page, schema, timestamp)
+
+    def save_data(self, page, data, summary=''):
+        """Saves data for a given page (creates a new revision)."""
+        return self._dokuwiki.send('plugin.struct.saveData', page, data, summary)
+
+    def get_schema(self, name=''):
+        """Get info about existing schemas columns."""
+        return self._dokuwiki.send('plugin.struct.getSchema', name)
+
+    def get_aggregation_data(self, schemas, columns, data_filter=[], sort=''):
+        """Get the data that would be shown in an aggregation."""
+        return self._dokuwiki.send(
+            'plugin.struct.getAggregationData', schemas, columns, data_filter, sort)
+
+
 class Dataentry(object):
     """Object that manage `data entries <https://www.dokuwiki.org/plugin:data>`_."""