We are no longer offering accounts on this server. Consider https://gitlab.freedesktop.org/ as a place to host projects.

Commit 62059fec authored by Zach Copley's avatar Zach Copley

New actions for statusnet config and version API methods

parent 08de0f1e
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
/** /**
* StatusNet, the distributed open-source microblogging tool * StatusNet, the distributed open-source microblogging tool
* *
* StatusNet-only extensions to the Twitter-like API * Dump of configuration variables
* *
* PHP version 5 * PHP version 5
* *
...@@ -19,105 +19,86 @@ ...@@ -19,105 +19,86 @@
* You should have received a copy of the GNU Affero General Public License * 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/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
* *
* @category Twitter * @category API
* @package StatusNet * @package StatusNet
* @author Evan Prodromou <evan@status.net> * @author Zach Copley <zach@status.net>
* @copyright 2008 StatusNet, Inc. * @copyright 2009 StatusNet, Inc.
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://status.net/ * @link http://status.net/
*/ */
if (!defined('STATUSNET') && !defined('LACONICA')) { if (!defined('STATUSNET')) {
exit(1); exit(1);
} }
require_once INSTALLDIR.'/lib/twitterapi.php'; require_once INSTALLDIR . '/lib/twitterapi.php';
/** /**
* StatusNet-specific API methods * 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
* *
* This class handles all /statusnet/ API methods. * @category API
* * @package StatusNet
* @category Twitter * @author Zach Copley <zach@status.net>
* @package StatusNet * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @author Evan Prodromou <evan@status.net> * @link http://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 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')
);
/** /**
* A version stamp for the API * Take arguments for running
*
* 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 $args $_REQUEST args
* @param array $apidata Twitter API data
* *
* @return void * @return boolean success flag
* *
* @see ApiAction::process_command()
*/ */
function version($args, $apidata) function prepare($args)
{ {
parent::handle($args); parent::prepare($args);
switch ($apidata['content-type']) { $this->format = $this->arg('format');
case 'xml': return true;
$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 * Handle the request
* *
* Gives a full dump of configuration variables for this instance * @param array $args $_REQUEST data (unused)
* 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 * @return void
*
* @see ApiAction::process_command()
*/ */
function config($args, $apidata) function handle($args)
{ {
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); parent::handle($args);
switch ($apidata['content-type']) { switch ($this->format) {
case 'xml': case 'xml':
$this->init_document('xml'); $this->init_document('xml');
$this->elementStart('config'); $this->elementStart('config');
// XXX: check that all sections and settings are legal XML elements // XXX: check that all sections and settings are legal XML elements
foreach ($keys as $section => $settings) {
common_debug(var_export($this->keys, true));
foreach ($this->keys as $section => $settings) {
$this->elementStart($section); $this->elementStart($section);
foreach ($settings as $setting) { foreach ($settings as $setting) {
$value = common_config($section, $setting); $value = common_config($section, $setting);
...@@ -135,41 +116,28 @@ class TwitapistatusnetAction extends TwitterapiAction ...@@ -135,41 +116,28 @@ class TwitapistatusnetAction extends TwitterapiAction
$this->elementEnd('config'); $this->elementEnd('config');
$this->end_document('xml'); $this->end_document('xml');
break; break;
case 'json': case 'json':
$result = array(); $result = array();
foreach ($keys as $section => $settings) { foreach ($this->keys as $section => $settings) {
$result[$section] = array(); $result[$section] = array();
foreach ($settings as $setting) { foreach ($settings as $setting) {
$result[$section][$setting] = common_config($section, $setting); $result[$section][$setting]
= common_config($section, $setting);
} }
} }
$this->init_document('json'); $this->init_document('json');
$this->show_json_objects($result); $this->show_json_objects($result);
$this->end_document('json'); $this->end_document('json');
break; break;
default: default:
$this->clientError(_('API method not found!'), $code=404); $this->clientError(
_('API method not found!'),
404,
$this->format
);
break;
} }
} }
/**
* 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);
}
} }
<?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;
}
}
}
...@@ -486,15 +486,23 @@ class Router ...@@ -486,15 +486,23 @@ class Router
// statusnet // statusnet
$m->connect('api/statusnet/:method', $m->connect('api/statusnet/version.:format',
array('action' => 'api', array('action' => 'ApiStatusnetVersion',
'apiaction' => 'statusnet')); 'format' => '(xml|json)'));
$m->connect('api/statusnet/config.:format',
array('action' => 'ApiStatusnetConfig',
'format' => '(xml|json)'));
// For older methods, we provide "laconica" base action // For older methods, we provide "laconica" base action
$m->connect('api/laconica/:method', $m->connect('api/laconica/version.:format',
array('action' => 'api', array('action' => 'ApiStatusnetVersion',
'apiaction' => 'statusnet')); '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 // Groups and tags are newer than 0.8.1 so no backward-compatibility
// necessary // necessary
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment