plugins/OStatus/actions/usersalmon.php

   1 <?php
   2 /*
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2010, StatusNet, Inc.
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU Affero General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU Affero General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Affero General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 /**
  21  * @package OStatusPlugin
  22  * @author James Walker <james@status.net>
  23  */
  24
  25 if (!defined('STATUSNET')) {
  26     exit(1);
  27 }
  28
  29 class UsersalmonAction extends SalmonAction
  30 {
  31     function prepare($args)
  32     {
  33         parent::prepare($args);
  34
  35         $id = $this->trimmed('id');
  36
  37         if (!$id) {
  38             $this->clientError(_('No ID.'));
  39         }
  40
  41         $this->user = User::staticGet('id', $id);
  42
  43         if (empty($this->user)) {
  44             $this->clientError(_('No such user.'));
  45         }
  46
  47         return true;
  48     }
  49
  50     /**
  51      * We've gotten a post event on the Salmon backchannel, probably a reply.
  52      *
  53      * @todo validate if we need to handle this post, then call into
  54      * ostatus_profile's general incoming-post handling.
  55      */
  56     function handlePost()
  57     {
  58         common_log(LOG_INFO, "Received post of '{$this->activity->objects[0]->id}' from '{$this->activity->actor->id}'");
  59
  60         // @fixme: process all activity objects?
  61         switch ($this->activity->objects[0]->type) {
  62         case ActivityObject::ARTICLE:
  63         case ActivityObject::BLOGENTRY:
  64         case ActivityObject::NOTE:
  65         case ActivityObject::STATUS:
  66         case ActivityObject::COMMENT:
  67             break;
  68         default:
  69             throw new ClientException("Can't handle that kind of post.");
  70         }
  71
  72         // Notice must either be a) in reply to a notice by this user
  73         // or b) to the attention of this user
  74         // or c) in reply to a notice to the attention of this user
  75
  76         $context = $this->activity->context;
  77
  78         if (!empty($context->replyToID)) {
  79             common_log(LOG_DEBUG, "Got a notice in reply to '{$context->replyToID}' ({$context->replyToUrl})");
  80             $notice = Notice::staticGet('uri', $context->replyToID);
  81             if (empty($notice)) {
  82                 throw new ClientException("In reply to unknown notice");
  83             }
  84             if ($notice->profile_id != $this->user->id &&
  85                 !in_array($this->user->id, $notice->getReplies())) {
  86                 throw new ClientException("In reply to a notice not by this user and not mentioning this user");
  87             }
  88         } else if (!empty($context->attention)) {
  89             if (!in_array($this->user->uri, $context->attention) &&
  90                 !in_array(common_profile_url($this->user->nickname), $context->attention)) {
  91                 common_log(LOG_ERR, "{$this->user->uri} not in attention list (".implode(',', $context->attention).")");
  92                 throw new ClientException("To the attention of user(s) not including this one!");
  93             }
  94         } else {
  95             throw new ClientException("Not to anyone in reply to anything!");
  96         }
  97
  98         $existing = Notice::staticGet('uri', $this->activity->objects[0]->id);
  99
 100         if (!empty($existing)) {
 101             common_log(LOG_ERR, "Not saving notice '{$existing->uri}'; already exists.");
 102             return;
 103         }
 104
 105         $this->saveNotice();
 106     }
 107
 108     /**
 109      * We've gotten a follow/subscribe notification from a remote user.
 110      * Save a subscription relationship for them.
 111      */
 112
 113     function handleFollow()
 114     {
 115         $oprofile = $this->ensureProfile();
 116         if ($oprofile) {
 117             common_log(LOG_INFO, "Setting up subscription from remote {$oprofile->uri} to local {$this->user->nickname}");
 118             Subscription::start($oprofile->localProfile(),
 119                                 $this->user->getProfile());
 120         } else {
 121             common_log(LOG_INFO, "Can't set up subscription from remote; missing profile.");
 122         }
 123     }
 124
 125     /**
 126      * We've gotten an unfollow/unsubscribe notification from a remote user.
 127      * Check if we have a subscription relationship for them and kill it.
 128      *
 129      * @fixme probably catch exceptions on fail?
 130      */
 131     function handleUnfollow()
 132     {
 133         $oprofile = $this->ensureProfile();
 134         if ($oprofile) {
 135             common_log(LOG_INFO, "Canceling subscription from remote {$oprofile->uri} to local {$this->user->nickname}");
 136             Subscription::cancel($oprofile->localProfile(), $this->user->getProfile());
 137         } else {
 138             common_log(LOG_ERR, "Can't cancel subscription from remote, didn't find the profile");
 139         }
 140     }
 141
 142     /**
 143      * Remote user likes one of our posts.
 144      * Confirm the post is ours, and save a local favorite event.
 145      */
 146
 147     function handleFavorite()
 148     {
 149         $notice = $this->getNotice($this->activity->objects[0]);
 150         $profile = $this->ensureProfile()->localProfile();
 151
 152         $old = Fave::pkeyGet(array('user_id' => $profile->id,
 153                                    'notice_id' => $notice->id));
 154
 155         if (!empty($old)) {
 156             throw new ClientException("We already know that's a fave!");
 157         }
 158
 159         if (!Fave::addNew($profile, $notice)) {
 160             throw new ClientException("Could not save new favorite.");
 161         }
 162     }
 163
 164     /**
 165      * Remote user doesn't like one of our posts after all!
 166      * Confirm the post is ours, and save a local favorite event.
 167      */
 168     function handleUnfavorite()
 169     {
 170         $notice = $this->getNotice($this->activity->objects[0]);
 171         $profile = $this->ensureProfile()->localProfile();
 172
 173         $fave = Fave::pkeyGet(array('user_id' => $profile->id,
 174                                    'notice_id' => $notice->id));
 175         if (empty($fave)) {
 176             throw new ClientException("Notice wasn't favorited!");
 177         }
 178
 179         $fave->delete();
 180     }
 181
 182     /**
 183      * @param ActivityObject $object
 184      * @return Notice
 185      * @throws ClientException on invalid input
 186      */
 187     function getNotice($object)
 188     {
 189         if (!$object) {
 190             throw new ClientException("Can't favorite/unfavorite without an object.");
 191         }
 192
 193         switch ($object->type) {
 194         case ActivityObject::ARTICLE:
 195         case ActivityObject::BLOGENTRY:
 196         case ActivityObject::NOTE:
 197         case ActivityObject::STATUS:
 198         case ActivityObject::COMMENT:
 199             break;
 200         default:
 201             throw new ClientException("Can't handle that kind of object for liking/faving.");
 202         }
 203
 204         $notice = Notice::staticGet('uri', $object->id);
 205
 206         if (empty($notice)) {
 207             throw new ClientException("Notice with ID $object->id unknown.");
 208         }
 209
 210         if ($notice->profile_id != $this->user->id) {
 211             throw new ClientException("Notice with ID $object->id not posted by $this->user->id.");
 212         }
 213
 214         return $notice;
 215     }
 216
 217 }