123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228 |
- <?php
- /**
- * StatusNet - the distributed open-source microblogging tool
- * Copyright (C) 2011, StatusNet, Inc.
- *
- * Show a stream of notices in a particular conversation
- *
- * PHP version 5
- *
- * 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 Evan Prodromou <evan@status.net>
- * @copyright 2011 StatusNet, Inc.
- * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
- * @link http://status.net/
- */
- if (!defined('STATUSNET')) {
- // This check helps protect against security problems;
- // your code file can't be executed directly from the web.
- exit(1);
- }
- /**
- * Show a stream of notices in a particular conversation
- *
- * @category API
- * @package StatusNet
- * @author Evan Prodromou <evan@status.net>
- * @copyright 2011 StatusNet, Inc.
- * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
- * @link http://status.net/
- */
- class ApiconversationAction extends ApiAuthAction
- {
- protected $conversation = null;
- protected $notices = null;
- protected function prepare(array $args=array())
- {
- parent::prepare($args);
- $convId = $this->trimmed('id');
- if (empty($convId)) {
- // TRANS: Client exception thrown when no conversation ID is given.
- throw new ClientException(_('No conversation ID.'));
- }
- $this->conversation = Conversation::getKV('id', $convId);
- if (empty($this->conversation)) {
- // TRANS: Client exception thrown when referring to a non-existing conversation ID (%d).
- throw new ClientException(sprintf(_('No conversation with ID %d.'), $convId),
- 404);
- }
- $stream = new ConversationNoticeStream($convId, $this->scoped);
- $notice = $stream->getNotices(($this->page-1) * $this->count,
- $this->count,
- $this->since_id,
- $this->max_id);
- $this->notices = $notice->fetchAll();
- return true;
- }
- /**
- * Handler method
- *
- * @param array $argarray is ignored since it's now passed in in prepare()
- *
- * @return void
- */
- function handle($argarray=null)
- {
- $sitename = common_config('site', 'name');
- // TRANS: Title for conversion timeline.
- $title = _m('TITLE', 'Conversation');
- $id = common_local_url('apiconversation', array('id' => $this->conversation->id, 'format' => $this->format));
- $link = common_local_url('conversation', array('id' => $this->conversation->id));
- $self = $id;
- switch($this->format) {
- case 'xml':
- $this->showXmlTimeline($this->notices);
- break;
- case 'rss':
- $this->showRssTimeline(
- $this->notices,
- $title,
- $link,
- null,
- null,
- null,
- $self
- );
- break;
- case 'atom':
- header('Content-Type: application/atom+xml; charset=utf-8');
- $atom = new AtomNoticeFeed($this->auth_user);
- $atom->setId($id);
- $atom->setTitle($title);
- $atom->setUpdated('now');
- $atom->addLink($link);
- $atom->setSelfLink($self);
- $atom->addEntryFromNotices($this->notices);
- $this->raw($atom->getString());
- break;
- case 'json':
- $this->showJsonTimeline($this->notices);
- break;
- case 'as':
- header('Content-Type: ' . ActivityStreamJSONDocument::CONTENT_TYPE);
- $doc = new ActivityStreamJSONDocument($this->auth_user);
- $doc->setTitle($title);
- $doc->addLink($link, 'alternate', 'text/html');
- $doc->addItemsFromNotices($this->notices);
- $this->raw($doc->asString());
- break;
- default:
- // TRANS: Client error displayed when coming across a non-supported API method.
- $this->clientError(_('API method not found.'), $code = 404);
- break;
- }
- }
- /**
- * Return true if read only.
- *
- * MAY override
- *
- * @param array $args other arguments
- *
- * @return boolean is read only action?
- */
- function isReadOnly($args)
- {
- if ($_SERVER['REQUEST_METHOD'] == 'GET' ||
- $_SERVER['REQUEST_METHOD'] == 'HEAD') {
- return true;
- } else {
- return false;
- }
- }
- /**
- * Return last modified, if applicable.
- *
- * MAY override
- *
- * @return string last modified http header
- */
- function lastModified()
- {
- if (!empty($this->notices) && (count($this->notices) > 0)) {
- return strtotime($this->notices[0]->created);
- }
- return null;
- }
- /**
- * Return etag, if applicable.
- *
- * MAY override
- *
- * @return string etag http header
- */
- function etag()
- {
- if (!empty($this->notices) && (count($this->notices) > 0)) {
- $last = count($this->notices) - 1;
- return '"' . implode(
- ':',
- array($this->arg('action'),
- common_user_cache_hash($this->auth_user),
- common_language(),
- $this->user->id,
- strtotime($this->notices[0]->created),
- strtotime($this->notices[$last]->created))
- )
- . '"';
- }
- return null;
- }
- /**
- * Does this require authentication?
- *
- * @return boolean true if delete, else false
- */
- function requiresAuth()
- {
- if ($_SERVER['REQUEST_METHOD'] == 'GET' ||
- $_SERVER['REQUEST_METHOD'] == 'HEAD') {
- return false;
- } else {
- return true;
- }
- }
- }
|