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             $notice = Notice::staticGet('uri', $context->replyToID);
  80             if (empty($notice)) {
  81                 throw new ClientException("In reply to unknown notice");
  82             }
  83             if ($notice->profile_id != $this->user->id &&
  84                 !in_array($this->user->id, $notice->getReplies())) {
  85                 throw new ClientException("In reply to a notice not by this user and not mentioning this user");
  86             }
  87         } else if (!empty($context->attention)) {
  88             if (!in_array($this->user->uri, $context->attention) &&
  89                 !in_array(common_profile_url($this->user->nickname), $context->attention)) {
  90                 common_log(LOG_ERR, "{$this->user->uri} not in attention list (".implode(',', $context->attention).")");
  91                 throw new ClientException("To the attention of user(s) not including this one!");
  92             }
  93         } else {
  94             throw new ClientException("Not to anyone in reply to anything!");
  95         }
  96
  97         $existing = Notice::staticGet('uri', $this->activity->objects[0]->id);
  98
  99         if (!empty($existing)) {
 100             common_log(LOG_ERR, "Not saving notice '{$existing->uri}'; already exists.");
 101             return;
 102         }
 103
 104         $this->saveNotice();
 105     }
 106
 107     /**
 108      * We've gotten a follow/subscribe notification from a remote user.
 109      * Save a subscription relationship for them.
 110      */
 111
 112     function handleFollow()
 113     {
 114         $oprofile = $this->ensureProfile();
 115         if ($oprofile) {
 116             common_log(LOG_INFO, "Setting up subscription from remote {$oprofile->uri} to local {$this->user->nickname}");
 117             Subscription::start($oprofile->localProfile(),
 118                                 $this->user->getProfile());
 119         } else {
 120             common_log(LOG_INFO, "Can't set up subscription from remote; missing profile.");
 121         }
 122     }
 123
 124     /**
 125      * We've gotten an unfollow/unsubscribe notification from a remote user.
 126      * Check if we have a subscription relationship for them and kill it.
 127      *
 128      * @fixme probably catch exceptions on fail?
 129      */
 130     function handleUnfollow()
 131     {
 132         $oprofile = $this->ensureProfile();
 133         if ($oprofile) {
 134             common_log(LOG_INFO, "Canceling subscription from remote {$oprofile->uri} to local {$this->user->nickname}");
 135             Subscription::cancel($oprofile->localProfile(), $this->user->getProfile());
 136         } else {
 137             common_log(LOG_ERR, "Can't cancel subscription from remote, didn't find the profile");
 138         }
 139     }
 140
 141     /**
 142      * Remote user likes one of our posts.
 143      * Confirm the post is ours, and save a local favorite event.
 144      */
 145
 146     function handleFavorite()
 147     {
 148         $notice = $this->getNotice($this->activity->objects[0]);
 149         $profile = $this->ensureProfile()->localProfile();
 150
 151         $old = Fave::pkeyGet(array('user_id' => $profile->id,
 152                                    'notice_id' => $notice->id));
 153
 154         if (!empty($old)) {
 155             throw new ClientException("We already know that's a fave!");
 156         }
 157
 158         if (!Fave::addNew($profile, $notice)) {
 159             throw new ClientException("Could not save new favorite.");
 160         }
 161     }
 162
 163     /**
 164      * Remote user doesn't like one of our posts after all!
 165      * Confirm the post is ours, and save a local favorite event.
 166      */
 167     function handleUnfavorite()
 168     {
 169         $notice = $this->getNotice($this->activity->objects[0]);
 170         $profile = $this->ensureProfile()->localProfile();
 171
 172         $fave = Fave::pkeyGet(array('user_id' => $profile->id,
 173                                    'notice_id' => $notice->id));
 174         if (empty($fave)) {
 175             throw new ClientException("Notice wasn't favorited!");
 176         }
 177
 178         $fave->delete();
 179     }
 180
 181     /**
 182      * @param ActivityObject $object
 183      * @return Notice
 184      * @throws ClientException on invalid input
 185      */
 186     function getNotice($object)
 187     {
 188         if (!$object) {
 189             throw new ClientException("Can't favorite/unfavorite without an object.");
 190         }
 191
 192         switch ($object->type) {
 193         case ActivityObject::ARTICLE:
 194         case ActivityObject::BLOGENTRY:
 195         case ActivityObject::NOTE:
 196         case ActivityObject::STATUS:
 197         case ActivityObject::COMMENT:
 198             break;
 199         default:
 200             throw new ClientException("Can't handle that kind of object for liking/faving.");
 201         }
 202
 203         $notice = Notice::staticGet('uri', $object->id);
 204
 205         if (empty($notice)) {
 206             throw new ClientException("Notice with ID $object->id unknown.");
 207         }
 208
 209         if ($notice->profile_id != $this->user->id) {
 210             throw new ClientException("Notice with ID $object->id not posted by $this->user->id.");
 211         }
 212
 213         return $notice;
 214     }
 215
 216 }