From: Zach Copley <zach@status.net>
Date: Thu, 8 Oct 2009 22:45:45 +0000 (-0700)
Subject: New actions for statusnet config and version API methods
X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=62059fec832014411f604d9cc669b7d3201a60d5;p=quix0rs-gnu-social.git

New actions for statusnet config and version API methods
---

diff --git a/actions/apistatusnetconfig.php b/actions/apistatusnetconfig.php
new file mode 100644
index 0000000000..94bd5b4b3f
--- /dev/null
+++ b/actions/apistatusnetconfig.php
@@ -0,0 +1,143 @@
+<?php
+/**
+ * StatusNet, the distributed open-source microblogging tool
+ *
+ * Dump of configuration variables
+ *
+ * PHP version 5
+ *
+ * LICENCE: This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @category  API
+ * @package   StatusNet
+ * @author    Zach Copley <zach@status.net>
+ * @copyright 2009 StatusNet, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link      http://status.net/
+ */
+
+if (!defined('STATUSNET')) {
+    exit(1);
+}
+
+require_once INSTALLDIR . '/lib/twitterapi.php';
+
+/**
+ * Gives a full dump of configuration variables for this instance
+ * of StatusNet, minus variables that may be security-sensitive (like
+ * passwords).
+ * URL: http://identi.ca/api/statusnet/config.(xml|json)
+ * Formats: xml, json
+ *
+ * @category API
+ * @package  StatusNet
+ * @author   Zach Copley <zach@status.net>
+ * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link     http://status.net/
+ */
+
+class ApiStatusnetConfigAction extends TwitterApiAction
+{
+    var $format = null;
+
+    var $keys = array(
+        'site' => array('name', 'server', 'theme', 'path', 'fancy', 'language',
+                        'email', 'broughtby', 'broughtbyurl', 'closed',
+                        'inviteonly', 'private'),
+        'license' => array('url', 'title', 'image'),
+        'nickname' => array('featured'),
+        'throttle' => array('enabled', 'count', 'timespan'),
+        'xmpp' => array('enabled', 'server', 'user')
+    );
+
+    /**
+     * Take arguments for running
+     *
+     * @param array $args $_REQUEST args
+     *
+     * @return boolean success flag
+     *
+     */
+
+    function prepare($args)
+    {
+        parent::prepare($args);
+        $this->format = $this->arg('format');
+        return true;
+    }
+
+    /**
+     * Handle the request
+     *
+     * @param array $args $_REQUEST data (unused)
+     *
+     * @return void
+     */
+
+    function handle($args)
+    {
+        parent::handle($args);
+
+        switch ($this->format) {
+        case 'xml':
+            $this->init_document('xml');
+            $this->elementStart('config');
+
+            // XXX: check that all sections and settings are legal XML elements
+
+            common_debug(var_export($this->keys, true));
+
+            foreach ($this->keys as $section => $settings) {
+                $this->elementStart($section);
+                foreach ($settings as $setting) {
+                    $value = common_config($section, $setting);
+                    if (is_array($value)) {
+                        $value = implode(',', $value);
+                    } else if ($value === false) {
+                        $value = 'false';
+                    } else if ($value === true) {
+                        $value = 'true';
+                    }
+                    $this->element($setting, null, $value);
+                }
+                $this->elementEnd($section);
+            }
+            $this->elementEnd('config');
+            $this->end_document('xml');
+            break;
+        case 'json':
+            $result = array();
+            foreach ($this->keys as $section => $settings) {
+                $result[$section] = array();
+                foreach ($settings as $setting) {
+                    $result[$section][$setting]
+                        = common_config($section, $setting);
+                }
+            }
+            $this->init_document('json');
+            $this->show_json_objects($result);
+            $this->end_document('json');
+            break;
+        default:
+            $this->clientError(
+                _('API method not found!'),
+                404,
+                $this->format
+            );
+            break;
+        }
+    }
+
+}
+
diff --git a/actions/apistatusnetversion.php b/actions/apistatusnetversion.php
new file mode 100644
index 0000000000..471297ad55
--- /dev/null
+++ b/actions/apistatusnetversion.php
@@ -0,0 +1,103 @@
+<?php
+/**
+ * StatusNet, the distributed open-source microblogging tool
+ *
+ * A version stamp for the API
+ *
+ * PHP version 5
+ *
+ * LICENCE: This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @category  API
+ * @package   StatusNet
+ * @author    Zach Copley <zach@status.net>
+ * @copyright 2009 StatusNet, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link      http://status.net/
+ */
+
+if (!defined('STATUSNET')) {
+    exit(1);
+}
+
+require_once INSTALLDIR . '/lib/twitterapi.php';
+
+/**
+ * Returns a version number for this version of StatusNet, which
+ * should make things a bit easier for upgrades.
+ * URL: http://identi.ca/api/statusnet/version.(xml|json)
+ * Formats: xml, js
+ *
+ * @category API
+ * @package  StatusNet
+ * @author   Zach Copley <zach@status.net>
+ * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link     http://status.net/
+ */
+
+class ApiStatusnetVersionAction extends TwitterApiAction
+{
+    var $format = null;
+
+    /**
+     * Take arguments for running
+     *
+     * @param array $args $_REQUEST args
+     *
+     * @return boolean success flag
+     *
+     */
+
+    function prepare($args)
+    {
+        parent::prepare($args);
+        $this->format = $this->arg('format');
+        return true;
+    }
+
+    /**
+     * Handle the request
+     *
+     * @param array $args $_REQUEST data (unused)
+     *
+     * @return void
+     */
+
+    function handle($args)
+    {
+        parent::handle($args);
+
+        switch ($this->format) {
+        case 'xml':
+            $this->init_document('xml');
+            $this->element('version', null, STATUSNET_VERSION);
+            $this->end_document('xml');
+            break;
+        case 'json':
+            $this->init_document('json');
+            print '"'.STATUSNET_VERSION.'"';
+            $this->end_document('json');
+            break;
+        default:
+            $this->clientError(
+                _('API method not found!'), 
+                404, 
+                $this->format
+            );
+            break;
+        }
+    }
+
+}
+
diff --git a/actions/twitapistatusnet.php b/actions/twitapistatusnet.php
deleted file mode 100644
index 490f11dce2..0000000000
--- a/actions/twitapistatusnet.php
+++ /dev/null
@@ -1,175 +0,0 @@
-<?php
-/**
- * StatusNet, the distributed open-source microblogging tool
- *
- * StatusNet-only extensions to the Twitter-like API
- *
- * PHP version 5
- *
- * LICENCE: This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- *
- * @category  Twitter
- * @package   StatusNet
- * @author    Evan Prodromou <evan@status.net>
- * @copyright 2008 StatusNet, Inc.
- * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
- * @link      http://status.net/
- */
-
-if (!defined('STATUSNET') && !defined('LACONICA')) {
-    exit(1);
-}
-
-require_once INSTALLDIR.'/lib/twitterapi.php';
-
-/**
- * StatusNet-specific API methods
- *
- * This class handles all /statusnet/ API methods.
- *
- * @category  Twitter
- * @package   StatusNet
- * @author    Evan Prodromou <evan@status.net>
- * @copyright 2008 StatusNet, Inc.
- * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
- * @link      http://status.net/
- */
-
-class TwitapistatusnetAction extends TwitterapiAction
-{
-    /**
-     * A version stamp for the API
-     *
-     * Returns a version number for this version of StatusNet, which
-     * should make things a bit easier for upgrades.
-     * URL: http://identi.ca/api/statusnet/version.(xml|json)
-     * Formats: xml, json
-     *
-     * @param array $args    Web arguments
-     * @param array $apidata Twitter API data
-     *
-     * @return void
-     *
-     * @see ApiAction::process_command()
-     */
-
-    function version($args, $apidata)
-    {
-        parent::handle($args);
-        switch ($apidata['content-type']) {
-         case 'xml':
-            $this->init_document('xml');
-            $this->element('version', null, STATUSNET_VERSION);
-            $this->end_document('xml');
-            break;
-         case 'json':
-            $this->init_document('json');
-            print '"'.STATUSNET_VERSION.'"';
-            $this->end_document('json');
-            break;
-         default:
-            $this->clientError(_('API method not found!'), $code=404);
-        }
-    }
-
-    /**
-     * Dump of configuration variables
-     *
-     * Gives a full dump of configuration variables for this instance
-     * of StatusNet, minus variables that may be security-sensitive (like
-     * passwords).
-     * URL: http://identi.ca/api/statusnet/config.(xml|json)
-     * Formats: xml, json
-     *
-     * @param array $args    Web arguments
-     * @param array $apidata Twitter API data
-     *
-     * @return void
-     *
-     * @see ApiAction::process_command()
-     */
-
-    function config($args, $apidata)
-    {
-        static $keys = array('site' => array('name', 'server', 'theme', 'path', 'fancy', 'language',
-                                             'email', 'broughtby', 'broughtbyurl', 'closed',
-                                             'inviteonly', 'private'),
-                             'license' => array('url', 'title', 'image'),
-                             'nickname' => array('featured'),
-                             'throttle' => array('enabled', 'count', 'timespan'),
-                             'xmpp' => array('enabled', 'server', 'user'));
-
-        parent::handle($args);
-
-        switch ($apidata['content-type']) {
-         case 'xml':
-            $this->init_document('xml');
-            $this->elementStart('config');
-            // XXX: check that all sections and settings are legal XML elements
-            foreach ($keys as $section => $settings) {
-                $this->elementStart($section);
-                foreach ($settings as $setting) {
-                    $value = common_config($section, $setting);
-                    if (is_array($value)) {
-                        $value = implode(',', $value);
-                    } else if ($value === false) {
-                        $value = 'false';
-                    } else if ($value === true) {
-                        $value = 'true';
-                    }
-                    $this->element($setting, null, $value);
-                }
-                $this->elementEnd($section);
-            }
-            $this->elementEnd('config');
-            $this->end_document('xml');
-            break;
-         case 'json':
-            $result = array();
-            foreach ($keys as $section => $settings) {
-                $result[$section] = array();
-                foreach ($settings as $setting) {
-                    $result[$section][$setting] = common_config($section, $setting);
-                }
-            }
-            $this->init_document('json');
-            $this->show_json_objects($result);
-            $this->end_document('json');
-            break;
-         default:
-            $this->clientError(_('API method not found!'), $code=404);
-        }
-    }
-
-    /**
-     * WADL description of the API
-     *
-     * Gives a WADL description of the API provided by this version of the
-     * software.
-     *
-     * @param array $args    Web arguments
-     * @param array $apidata Twitter API data
-     *
-     * @return void
-     *
-     * @see ApiAction::process_command()
-     */
-
-    function wadl($args, $apidata)
-    {
-        parent::handle($args);
-        $this->serverError(_('API method under construction.'), 501);
-    }
-
-}
diff --git a/lib/router.php b/lib/router.php
index 1ea5885dac..3c50fb25ec 100644
--- a/lib/router.php
+++ b/lib/router.php
@@ -486,15 +486,23 @@ class Router
 
         // statusnet
 
-        $m->connect('api/statusnet/:method',
-                    array('action' => 'api',
-                          'apiaction' => 'statusnet'));
+        $m->connect('api/statusnet/version.:format',
+                    array('action' => 'ApiStatusnetVersion',
+                          'format' => '(xml|json)'));
+
+        $m->connect('api/statusnet/config.:format',
+                    array('action' => 'ApiStatusnetConfig',
+                   'format' => '(xml|json)'));
 
         // For older methods, we provide "laconica" base action
 
-        $m->connect('api/laconica/:method',
-                    array('action' => 'api',
-                          'apiaction' => 'statusnet'));
+        $m->connect('api/laconica/version.:format',
+                    array('action' => 'ApiStatusnetVersion',
+                          'format' => '(xml|json)'));
+
+        $m->connect('api/laconica/config.:format',
+                    array('action' => 'ApiStatusnetConfig',
+                    'format' => '(xml|json)'));
 
         // Groups and tags are newer than 0.8.1 so no backward-compatibility
         // necessary