X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=actions%2Fapitimelineuser.php;h=26c960fa0429b9e1d176713cd4e65e60be43ddfa;hb=68df780c59b99ef5ba6ba6af1d4fc47821dd7927;hp=69cd9c2cb45af293c3669466b374ae4236b1bf2e;hpb=b60b9b4fa2863a398291706350b3f68f725f7687;p=quix0rs-gnu-social.git diff --git a/actions/apitimelineuser.php b/actions/apitimelineuser.php index 69cd9c2cb4..26c960fa04 100644 --- a/actions/apitimelineuser.php +++ b/actions/apitimelineuser.php @@ -38,8 +38,6 @@ if (!defined('STATUSNET')) { exit(1); } -require_once INSTALLDIR . '/lib/apibareauth.php'; - /** * Returns the most recent notices (default 20) posted by the authenticating * user. Another user's timeline can be requested via the id parameter. This @@ -57,30 +55,28 @@ require_once INSTALLDIR . '/lib/apibareauth.php'; * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0 * @link http://status.net/ */ - class ApiTimelineUserAction extends ApiBareAuthAction { - var $notices = null; + var $next_id = null; + /** * Take arguments for running * * @param array $args $_REQUEST args * * @return boolean success flag - * */ - - function prepare($args) + protected function prepare(array $args=array()) { parent::prepare($args); - $this->user = $this->getTargetUser($this->arg('id')); + $this->target = $this->getTargetProfile($this->arg('id')); - if (empty($this->user)) { - $this->clientError(_('No such user.'), 404, $this->format); - return; + if (!($this->target instanceof Profile)) { + // TRANS: Client error displayed requesting most recent notices for a non-existing user. + $this->clientError(_('No such user.'), 404); } $this->notices = $this->getNotices(); @@ -93,14 +89,11 @@ class ApiTimelineUserAction extends ApiBareAuthAction * * Just show the notices * - * @param array $args $_REQUEST data (unused) - * * @return void */ - - function handle($args) + protected function handle() { - parent::handle($args); + parent::handle(); if ($this->isPost()) { $this->handlePost(); @@ -114,18 +107,15 @@ class ApiTimelineUserAction extends ApiBareAuthAction * * @return void */ - function showTimeline() { - $profile = $this->user->getProfile(); - // We'll use the shared params from the Atom stub // for other feed types. - $atom = new AtomUserNoticeFeed($this->user, $this->auth_user); + $atom = new AtomUserNoticeFeed($this->target->getUser(), $this->auth_user); $link = common_local_url( 'showstream', - array('nickname' => $this->user->nickname) + array('nickname' => $this->target->nickname) ); $self = $this->getSelfUri(); @@ -133,9 +123,32 @@ class ApiTimelineUserAction extends ApiBareAuthAction // FriendFeed's SUP protocol // Also added RSS and Atom feeds - $suplink = common_local_url('sup', null, null, $this->user->id); + $suplink = common_local_url('sup', null, null, $this->target->id); header('X-SUP-ID: ' . $suplink); + + // paging links + $nextUrl = !empty($this->next_id) + ? common_local_url('ApiTimelineUser', + array('format' => $this->format, + 'id' => $this->target->id), + array('max_id' => $this->next_id)) + : null; + + $prevExtra = array(); + if (!empty($this->notices)) { + assert($this->notices[0] instanceof Notice); + $prevExtra['since_id'] = $this->notices[0]->id; + } + + $prevUrl = common_local_url('ApiTimelineUser', + array('format' => $this->format, + 'id' => $this->target->id), + $prevExtra); + $firstUrl = common_local_url('ApiTimelineUser', + array('format' => $this->format, + 'id' => $this->target->id)); + switch($this->format) { case 'xml': $this->showXmlTimeline($this->notices); @@ -152,7 +165,6 @@ class ApiTimelineUserAction extends ApiBareAuthAction ); break; case 'atom': - header('Content-Type: application/atom+xml; charset=utf-8'); $atom->setId($self); @@ -163,37 +175,18 @@ class ApiTimelineUserAction extends ApiBareAuthAction // change too quickly! if (!empty($this->next_id)) { - $nextUrl = common_local_url('ApiTimelineUser', - array('format' => 'atom', - 'id' => $this->user->id), - array('max_id' => $this->next_id)); - $atom->addLink($nextUrl, array('rel' => 'next', 'type' => 'application/atom+xml')); } if (($this->page > 1 || !empty($this->max_id)) && !empty($this->notices)) { - - $lastNotice = $this->notices[0]; - $lastId = $lastNotice->id; - - $prevUrl = common_local_url('ApiTimelineUser', - array('format' => 'atom', - 'id' => $this->user->id), - array('since_id' => $lastId)); - $atom->addLink($prevUrl, array('rel' => 'prev', 'type' => 'application/atom+xml')); } if ($this->page > 1 || !empty($this->since_id) || !empty($this->max_id)) { - - $firstUrl = common_local_url('ApiTimelineUser', - array('format' => 'atom', - 'id' => $this->user->id)); - $atom->addLink($firstUrl, array('rel' => 'first', 'type' => 'application/atom+xml')); @@ -207,11 +200,37 @@ class ApiTimelineUserAction extends ApiBareAuthAction case 'json': $this->showJsonTimeline($this->notices); break; - default: - $this->clientError(_('API method not found.'), $code = 404); + case 'as': + header('Content-Type: ' . ActivityStreamJSONDocument::CONTENT_TYPE); + $doc = new ActivityStreamJSONDocument($this->auth_user); + $doc->setTitle($atom->title); + $doc->addLink($link, 'alternate', 'text/html'); + $doc->addItemsFromNotices($this->notices); + + if (!empty($this->next_id)) { + $doc->addLink($nextUrl, + array('rel' => 'next', + 'type' => ActivityStreamJSONDocument::CONTENT_TYPE)); + } + + if (($this->page > 1 || !empty($this->max_id)) && !empty($this->notices)) { + $doc->addLink($prevUrl, + array('rel' => 'prev', + 'type' => ActivityStreamJSONDocument::CONTENT_TYPE)); + } + + if ($this->page > 1 || !empty($this->since_id) || !empty($this->max_id)) { + $doc->addLink($firstUrl, + array('rel' => 'first', + 'type' => ActivityStreamJSONDocument::CONTENT_TYPE)); + } + + $this->raw($doc->asString()); break; + default: + // TRANS: Client error displayed when coming across a non-supported API method. + $this->clientError(_('API method not found.'), 404); } - } /** @@ -219,15 +238,15 @@ class ApiTimelineUserAction extends ApiBareAuthAction * * @return array notices */ - function getNotices() { $notices = array(); - $notice = $this->user->getNotices(($this->page-1) * $this->count, + $notice = $this->target->getNotices(($this->page-1) * $this->count, $this->count + 1, $this->since_id, - $this->max_id); + $this->max_id, + $this->scoped); while ($notice->fetch()) { if (count($notices) < $this->count) { @@ -242,7 +261,7 @@ class ApiTimelineUserAction extends ApiBareAuthAction } /** - * Is this action read only? + * We expose AtomPub here, so non-GET/HEAD reqs must be read/write. * * @param array $args other arguments * @@ -251,7 +270,7 @@ class ApiTimelineUserAction extends ApiBareAuthAction function isReadOnly($args) { - return true; + return ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD'); } /** @@ -259,7 +278,6 @@ class ApiTimelineUserAction extends ApiBareAuthAction * * @return string datestamp of the latest notice in the stream */ - function lastModified() { if (!empty($this->notices) && (count($this->notices) > 0)) { @@ -277,11 +295,9 @@ class ApiTimelineUserAction extends ApiBareAuthAction * * @return string etag */ - function etag() { if (!empty($this->notices) && (count($this->notices) > 0)) { - $last = count($this->notices) - 1; return '"' . implode( @@ -289,7 +305,7 @@ class ApiTimelineUserAction extends ApiBareAuthAction array($this->arg('action'), common_user_cache_hash($this->auth_user), common_language(), - $this->user->id, + $this->target->id, strtotime($this->notices[0]->created), strtotime($this->notices[$last]->created)) ) @@ -302,43 +318,75 @@ class ApiTimelineUserAction extends ApiBareAuthAction function handlePost() { if (empty($this->auth_user) || - $this->auth_user->id != $this->user->id) { - $this->clientError(_("Only the user can add to their own timeline.")); - return; + $this->auth_user->id != $this->target->id) { + // TRANS: Client error displayed trying to add a notice to another user's timeline. + $this->clientError(_('Only the user can add to their own timeline.')); } + // Only handle posts for Atom if ($this->format != 'atom') { - // Only handle posts for Atom - $this->clientError(_("Only accept AtomPub for atom feeds.")); - return; + // TRANS: Client error displayed when using another format than AtomPub. + $this->clientError(_('Only accept AtomPub for Atom feeds.')); } - $xml = file_get_contents('php://input'); + $xml = trim(file_get_contents('php://input')); + if (empty($xml)) { + // TRANS: Client error displayed attempting to post an empty API notice. + $this->clientError(_('Atom post must not be empty.')); + } - $dom = DOMDocument::loadXML($xml); + $old = error_reporting(error_reporting() & ~(E_WARNING | E_NOTICE)); + $dom = new DOMDocument(); + $ok = $dom->loadXML($xml); + error_reporting($old); + if (!$ok) { + // TRANS: Client error displayed attempting to post an API that is not well-formed XML. + $this->clientError(_('Atom post must be well-formed XML.')); + } if ($dom->documentElement->namespaceURI != Activity::ATOM || $dom->documentElement->localName != 'entry') { + // TRANS: Client error displayed when not using an Atom entry. $this->clientError(_('Atom post must be an Atom entry.')); - return; } $activity = new Activity($dom->documentElement); - if ($activity->verb != ActivityVerb::POST) { - $this->clientError(_('Can only handle post activities.')); - return; - } + $saved = null; - $note = $activity->objects[0]; + if (Event::handle('StartAtomPubNewActivity', array(&$activity, $this->target->getUser(), &$saved))) { + if ($activity->verb != ActivityVerb::POST) { + // TRANS: Client error displayed when not using the POST verb. Do not translate POST. + $this->clientError(_('Can only handle POST activities.')); + } + + $note = $activity->objects[0]; + + if (!in_array($note->type, array(ActivityObject::NOTE, + ActivityObject::BLOGENTRY, + ActivityObject::STATUS))) { + // TRANS: Client error displayed when using an unsupported activity object type. + // TRANS: %s is the unsupported activity object type. + $this->clientError(sprintf(_('Cannot handle activity object type "%s".'), + $note->type)); + } - if (!in_array($note->type, array(ActivityObject::NOTE, - ActivityObject::BLOGENTRY, - ActivityObject::STATUS))) { - $this->clientError(sprintf(_('Cannot handle activity object type "%s"', - $note->type))); - return; + $saved = $this->postNote($activity); + + Event::handle('EndAtomPubNewActivity', array($activity, $this->target->getUser(), $saved)); + } + + if (!empty($saved)) { + header('HTTP/1.1 201 Created'); + header("Location: " . common_local_url('ApiStatusesShow', array('id' => $saved->id, + 'format' => 'atom'))); + $this->showSingleAtomStatus($saved); } + } + + function postNote($activity) + { + $note = $activity->objects[0]; // Use summary as fallback for content @@ -350,17 +398,17 @@ class ApiTimelineUserAction extends ApiBareAuthAction $sourceContent = $note->title; } else { // @fixme fetch from $sourceUrl? - // @todo i18n FIXME: use sprintf and add i18n. - $this->clientError("No content for notice {$note->id}."); - return; + // TRANS: Client error displayed when posting a notice without content through the API. + // TRANS: %d is the notice ID (number). + $this->clientError(sprintf(_('No content for notice %d.'), $note->id)); } // Get (safe!) HTML and text versions of the content $rendered = $this->purify($sourceContent); - $content = html_entity_decode(strip_tags($rendered), ENT_QUOTES, 'UTF-8'); + $content = common_strip_html($rendered); - $shortened = common_shorten_links($content); + $shortened = $this->auth_user->shortenLinks($content); $options = array('is_local' => Notice::LOCAL_PUBLIC, 'rendered' => $rendered, @@ -374,12 +422,12 @@ class ApiTimelineUserAction extends ApiBareAuthAction common_debug("Note ID is {$note->id}"); if (!empty($note->id)) { - $notice = Notice::staticGet('uri', trim($note->id)); + $notice = Notice::getKV('uri', trim($note->id)); if (!empty($notice)) { - $this->clientError(sprintf(_('Notice with URI "%s" already exists.'), - $note->id)); - return; + // TRANS: Client error displayed when using another format than AtomPub. + // TRANS: %s is the notice URI. + $this->clientError(sprintf(_('Notice with URI "%s" already exists.'), $note->id)); } common_log(LOG_NOTICE, "Saving client-supplied notice URI '$note->id'"); $options['uri'] = $note->id; @@ -394,22 +442,18 @@ class ApiTimelineUserAction extends ApiBareAuthAction // Check for optional attributes... - if (!empty($activity->context)) { - - foreach ($activity->context->attention as $uri) { - - $profile = Profile::fromURI($uri); + if ($activity->context instanceof ActivityContext) { - if (!empty($profile)) { - $options['replies'] = $uri; - } else { - $group = User_group::staticGet('uri', $uri); - if (!empty($group)) { - $options['groups'] = $uri; + foreach ($activity->context->attention as $uri=>$type) { + try { + $profile = Profile::fromUri($uri); + if ($profile->isGroup()) { + $options['groups'][] = $profile->id; } else { - // @fixme: hook for discovery here - common_log(LOG_WARNING, sprintf(_('AtomPub post with unknown attention URI %s'), $uri)); + $options['replies'][] = $uri; } + } catch (UnknownUriException $e) { + common_log(LOG_WARNING, sprintf('AtomPub post with unknown attention URI %s', $uri)); } } @@ -417,7 +461,7 @@ class ApiTimelineUserAction extends ApiBareAuthAction // @fixme what about conversation ID? if (!empty($activity->context->replyToID)) { - $orig = Notice::staticGet('uri', + $orig = Notice::getKV('uri', $activity->context->replyToID); if (!empty($orig)) { $options['reply_to'] = $orig->id; @@ -453,16 +497,12 @@ class ApiTimelineUserAction extends ApiBareAuthAction $options['urls'][] = $href; } - $saved = Notice::saveNew($this->user->id, + $saved = Notice::saveNew($this->target->id, $content, 'atompub', // TODO: deal with this $options); - if (!empty($saved)) { - header("Location: " . common_local_url('ApiStatusesShow', array('notice_id' => $saved->id, - 'format' => 'atom'))); - $this->showSingleAtomStatus($saved); - } + return $saved; } function purify($content)