New action for tag timelines in the API
This commit is contained in:
Zach Copley
parent
f7688bec0d
commit
8d284ca82c
212
actions/apitimelinetag.php
Normal file
212
actions/apitimelinetag.php
Normal file
|
|
@ -0,0 +1,212 @@
|
||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* StatusNet, the distributed open-source microblogging tool
|
||||||
|
*
|
||||||
|
* Show the latest notices for a given tag
|
||||||
|
*
|
||||||
|
* 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 the 20 most recent notices tagged by a given tag
|
||||||
|
*
|
||||||
|
* @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 ApiTimelineTagAction extends TwitterapiAction
|
||||||
|
{
|
||||||
|
|
||||||
|
var $notices = null;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Take arguments for running
|
||||||
|
*
|
||||||
|
* @param array $args $_REQUEST args
|
||||||
|
*
|
||||||
|
* @return boolean success flag
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
function prepare($args)
|
||||||
|
{
|
||||||
|
parent::prepare($args);
|
||||||
|
|
||||||
|
$this->page = (int)$this->arg('page', 1);
|
||||||
|
$this->count = (int)$this->arg('count', 20);
|
||||||
|
$this->tag = $this->arg('tag');
|
||||||
|
$this->format = $this->arg('format');
|
||||||
|
|
||||||
|
$this->notices = $this->getNotices();
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handle the request
|
||||||
|
*
|
||||||
|
* Just show the notices
|
||||||
|
*
|
||||||
|
* @param array $args $_REQUEST data (unused)
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
|
||||||
|
function handle($args)
|
||||||
|
{
|
||||||
|
parent::handle($args);
|
||||||
|
$this->showTimeline();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Show the timeline of notices
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
|
||||||
|
function showTimeline()
|
||||||
|
{
|
||||||
|
$sitename = common_config('site', 'name');
|
||||||
|
$title = sprintf(_("Notices tagged with %s"), $this->tag);
|
||||||
|
$link = common_local_url('tag',
|
||||||
|
array('tag' => $this->tag));
|
||||||
|
$subtitle = sprintf(_('Updates tagged with %1$s on %2$s!'),
|
||||||
|
$this->tag, $sitename);
|
||||||
|
$taguribase = common_config('integration', 'taguri');
|
||||||
|
$id = "tag:$taguribase:TagTimeline:".$tag;
|
||||||
|
|
||||||
|
switch($this->format) {
|
||||||
|
case 'xml':
|
||||||
|
$this->show_xml_timeline($this->notices);
|
||||||
|
break;
|
||||||
|
case 'rss':
|
||||||
|
$this->show_rss_timeline($this->notices, $title, $link, $subtitle);
|
||||||
|
break;
|
||||||
|
case 'atom':
|
||||||
|
$selfuri = common_root_url() .
|
||||||
|
'api/statusnet/tags/timeline/' .
|
||||||
|
$this->tag . '.atom';
|
||||||
|
$this->show_atom_timeline(
|
||||||
|
$this->notices, $title, $id, $link,
|
||||||
|
$subtitle, null, $selfuri
|
||||||
|
);
|
||||||
|
break;
|
||||||
|
case 'json':
|
||||||
|
$this->show_json_timeline($this->notices);
|
||||||
|
break;
|
||||||
|
default:
|
||||||
|
$this->clientError(_('API method not found!'), $code = 404);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get notices
|
||||||
|
*
|
||||||
|
* @return array notices
|
||||||
|
*/
|
||||||
|
|
||||||
|
function getNotices()
|
||||||
|
{
|
||||||
|
$notices = array();
|
||||||
|
|
||||||
|
$notice = Notice_tag::getStream(
|
||||||
|
$this->tag,
|
||||||
|
($this->page - 1) * $this->count,
|
||||||
|
$this->count + 1
|
||||||
|
);
|
||||||
|
|
||||||
|
while ($notice->fetch()) {
|
||||||
|
$notices[] = clone($notice);
|
||||||
|
}
|
||||||
|
|
||||||
|
return $notices;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Is this action read only?
|
||||||
|
*
|
||||||
|
* @param array $args other arguments
|
||||||
|
*
|
||||||
|
* @return boolean true
|
||||||
|
*/
|
||||||
|
|
||||||
|
function isReadOnly($args)
|
||||||
|
{
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* When was this feed last modified?
|
||||||
|
*
|
||||||
|
* @return string datestamp of the latest notice in the stream
|
||||||
|
*/
|
||||||
|
|
||||||
|
function lastModified()
|
||||||
|
{
|
||||||
|
if (!empty($this->notices) && (count($this->notices) > 0)) {
|
||||||
|
return strtotime($this->notices[0]->created);
|
||||||
|
}
|
||||||
|
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An entity tag for this stream
|
||||||
|
*
|
||||||
|
* Returns an Etag based on the action name, language, and
|
||||||
|
* timestamps of the first and last notice in the timeline
|
||||||
|
*
|
||||||
|
* @return string etag
|
||||||
|
*/
|
||||||
|
|
||||||
|
function etag()
|
||||||
|
{
|
||||||
|
if (!empty($this->notices) && (count($this->notices) > 0)) {
|
||||||
|
|
||||||
|
$last = count($this->notices) - 1;
|
||||||
|
|
||||||
|
return '"' . implode(
|
||||||
|
':',
|
||||||
|
array($this->arg('action'),
|
||||||
|
common_language(),
|
||||||
|
$this->tag,
|
||||||
|
strtotime($this->notices[0]->created),
|
||||||
|
strtotime($this->notices[$last]->created))
|
||||||
|
)
|
||||||
|
. '"';
|
||||||
|
}
|
||||||
|
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
@ -1,113 +0,0 @@
|
||||||
<?php
|
|
||||||
/**
|
|
||||||
* StatusNet, the distributed open-source microblogging tool
|
|
||||||
*
|
|
||||||
* StatusNet extensions to the Twitter-like API for groups
|
|
||||||
*
|
|
||||||
* 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 Craig Andrews <candrews@integralblue.com>
|
|
||||||
* @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') && !defined('LACONICA')) {
|
|
||||||
exit(1);
|
|
||||||
}
|
|
||||||
|
|
||||||
require_once INSTALLDIR.'/lib/twitterapi.php';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Group-specific API methods
|
|
||||||
*
|
|
||||||
* This class handles StatusNet group API methods.
|
|
||||||
*
|
|
||||||
* @category Twitter
|
|
||||||
* @package StatusNet
|
|
||||||
* @author Craig Andrews <candrews@integralblue.com>
|
|
||||||
* @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/
|
|
||||||
*/
|
|
||||||
|
|
||||||
class TwitapitagsAction extends TwitterapiAction
|
|
||||||
{
|
|
||||||
|
|
||||||
function timeline($args, $apidata)
|
|
||||||
{
|
|
||||||
parent::handle($args);
|
|
||||||
|
|
||||||
common_debug("in tags api action");
|
|
||||||
|
|
||||||
$this->auth_user = $apidata['user'];
|
|
||||||
$tag = $apidata['api_arg'];
|
|
||||||
|
|
||||||
if (empty($tag)) {
|
|
||||||
$this->clientError('Not Found', 404, $apidata['content-type']);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
$sitename = common_config('site', 'name');
|
|
||||||
$title = sprintf(_("Notices tagged with %s"), $tag);
|
|
||||||
$taguribase = common_config('integration', 'taguri');
|
|
||||||
$id = "tag:$taguribase:TagTimeline:".$tag;
|
|
||||||
$link = common_local_url('tag',
|
|
||||||
array('tag' => $tag));
|
|
||||||
$subtitle = sprintf(_('Updates tagged with %1$s on %2$s!'),
|
|
||||||
$tag, $sitename);
|
|
||||||
|
|
||||||
$page = (int)$this->arg('page', 1);
|
|
||||||
$count = (int)$this->arg('count', 20);
|
|
||||||
$max_id = (int)$this->arg('max_id', 0);
|
|
||||||
$since_id = (int)$this->arg('since_id', 0);
|
|
||||||
$since = $this->arg('since');
|
|
||||||
|
|
||||||
# XXX: support max_id, since_id, and since arguments
|
|
||||||
$notice = Notice_tag::getStream($tag, ($page-1)*$count, $count + 1);
|
|
||||||
|
|
||||||
switch($apidata['content-type']) {
|
|
||||||
case 'xml':
|
|
||||||
$this->show_xml_timeline($notice);
|
|
||||||
break;
|
|
||||||
case 'rss':
|
|
||||||
$this->show_rss_timeline($notice, $title, $link, $subtitle);
|
|
||||||
break;
|
|
||||||
case 'atom':
|
|
||||||
if (isset($apidata['api_arg'])) {
|
|
||||||
$selfuri = common_root_url() .
|
|
||||||
'api/statusnet/tags/timeline/' .
|
|
||||||
$apidata['api_arg'] . '.atom';
|
|
||||||
} else {
|
|
||||||
$selfuri = common_root_url() .
|
|
||||||
'api/statusnet/tags/timeline.atom';
|
|
||||||
}
|
|
||||||
$this->show_atom_timeline($notice, $title, $id, $link,
|
|
||||||
$subtitle, null, $selfuri);
|
|
||||||
break;
|
|
||||||
case 'json':
|
|
||||||
$this->show_json_timeline($notice);
|
|
||||||
break;
|
|
||||||
default:
|
|
||||||
$this->clientError(_('API method not found!'), $code = 404);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
@ -532,13 +532,9 @@ class Router
|
||||||
'apiaction' => 'groups'));
|
'apiaction' => 'groups'));
|
||||||
|
|
||||||
// Tags
|
// Tags
|
||||||
$m->connect('api/statusnet/tags/:method/:argument',
|
$m->connect('api/statusnet/tags/timeline/:tag.:format',
|
||||||
array('action' => 'api',
|
array('action' => 'ApiTimelineTag',
|
||||||
'apiaction' => 'tags'));
|
'format' => '(xmljson|rss|atom)'));
|
||||||
|
|
||||||
$m->connect('api/statusnet/tags/:method',
|
|
||||||
array('action' => 'api',
|
|
||||||
'apiaction' => 'tags'));
|
|
||||||
|
|
||||||
// search
|
// search
|
||||||
$m->connect('api/search.atom', array('action' => 'twitapisearchatom'));
|
$m->connect('api/search.atom', array('action' => 'twitapisearchatom'));
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue
Block a user