[server] Server API: ddoc_cmd

Author: Alexander Shorin <kxepal@gmail.com> Patched by: Iblis Lin <iblis@hs.ntnu.edu.tw> Reference: #268 See Also: #276
djc · iblislin · Mar 22, 2016 · May 13, 2016 · May 9, 2016 · May 14, 2016
commit d4f7a01ba3f64478de92b44c999acfb7df290786
diff --git a/couchdb/server/__init__.py b/couchdb/server/__init__.py
@@ -371,6 +371,35 @@ def reset(self, config=None):
             return self._process_request(['reset', config])
         return self._process_request(['reset'])
 
+    def ddoc_cmd(self, ddoc_id, cmd, func_path, func_args):
+        """Runs ``ddoc`` command.
+        Requires teached ddoc by :meth:`add_ddoc`.
+
+        :param ddoc_id: DDoc id.
+        :type ddoc_id: str
+
+        :param cmd: Command name.
+        :type cmd: str
+
+        :param func_path: List of keys which holds filter function within ddoc.
+        :type func_path: list
+
+        :param func_args: List of design function arguments.
+        :type func_args: list
+
+        :return: Returned value depended from executed command.
+
+        .. versionadded:: 0.11.0
+        """
+        if not func_path or func_path[0] != cmd:
+            func_path.insert(0, cmd)
+        return self._process_request(['ddoc', ddoc_id, func_path, func_args])
+
+    @property
+    def ddocs(self):
+        """Returns dict with registered ddocs"""
+        return self.commands['ddoc']
+
     @property
     def query_config(self):
         """Returns query server config which :meth:`reset` operates with"""

diff --git a/couchdb/server/ddoc.py b/couchdb/server/ddoc.py
@@ -58,3 +58,52 @@ def add_ddoc(self, server, ddoc_id, ddoc):
         log.debug('Cache design document `%s`', ddoc_id)
         self.cache[ddoc_id] = ddoc
         return True
+
+    def run_ddoc_func(self, server, ddoc_id, fun_path, fun_args):
+        """
+        :param server: Query server instance.
+        :type server: :class:`~couchdb.server.BaseQueryServer`
+
+        :param ddoc_id: Design document id, holder of requested function.
+        :type ddoc_id: unicode
+
+        :param fun_path: List of key by which request function could be found
+                         within ddoc object. First element of this list is
+                         ddoc command.
+        :type fun_path: list
+
+        :param fun_args: List of function arguments.
+        :type fun_args: list
+
+        :return: Result of called design function if any available.
+                 For example, lists doesn't explicitly returns any value.
+
+        .. versionadded:: 0.11.0
+        """
+        ddoc = self.cache.get(ddoc_id)
+        if ddoc is None:
+            msg = 'Uncached design document: {0}'.format(ddoc_id)
+            log.error(msg)
+            raise FatalError('query_protocol_error', msg)
+        cmd = fun_path[0]
+        if cmd not in self.commands:
+            msg = 'Unknown ddoc command `{0}`'.format(cmd)
+            log.error(msg)
+            raise FatalError('unknown_command', msg)
+        handler = self.commands[cmd]
+        point = ddoc
+        for item in fun_path:
+            prev, point = point, point.get(item)
+            if point is None:
+                msg = 'Missed function `%s` in design doc `%s` by path: %s'
+                args = (item, ddoc_id, '/'.join(fun_path))
+                log.error(msg, *args)
+                raise Error('not_found', msg % args)
+        else:
+            func = point
+            if not isinstance(func, FunctionType):
+                func = server.compile(func, ddoc)
+                prev[item] = func
+        log.debug('Run %s in design doc `%s` by path: %s',
+                  func, ddoc_id, '/'.join(fun_path))
+        return handler(server, func, *fun_args)