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 if (!defined('GNUSOCIAL')) { exit(1); }
  21
  22 /**
  23  * @package OStatusPlugin
  24  * @author James Walker <james@status.net>
  25  */
  26 class UsersalmonAction extends SalmonAction
  27 {
  28     protected function prepare(array $args=array())
  29     {
  30         parent::prepare($args);
  31
  32         $id = $this->trimmed('id');
  33
  34         if (!$id) {
  35             // TRANS: Client error displayed trying to perform an action without providing an ID.
  36             $this->clientError(_m('No ID.'));
  37         }
  38
  39         $this->user = User::getKV('id', $id);
  40
  41         if (!$this->user instanceof User) {
  42             // TRANS: Client error displayed when referring to a non-existing user.
  43             $this->clientError(_m('No such user.'));
  44         }
  45
  46         $this->target = $this->user->getProfile();
  47
  48         return true;
  49     }
  50
  51     /**
  52      * We've gotten a post event on the Salmon backchannel, probably a reply.
  53      *
  54      * @todo validate if we need to handle this post, then call into
  55      * ostatus_profile's general incoming-post handling.
  56      */
  57     function handlePost()
  58     {
  59         common_log(LOG_INFO, "Received post of '{$this->activity->objects[0]->id}' from '{$this->activity->actor->id}'");
  60
  61         // @fixme: process all activity objects?
  62         switch ($this->activity->objects[0]->type) {
  63         case ActivityObject::ARTICLE:
  64         case ActivityObject::BLOGENTRY:
  65         case ActivityObject::NOTE:
  66         case ActivityObject::STATUS:
  67         case ActivityObject::COMMENT:
  68             break;
  69         default:
  70             // TRANS: Client exception thrown when an undefied activity is performed.
  71             throw new ClientException(_m('Cannot handle that kind of post.'));
  72         }
  73
  74         // Notice must either be a) in reply to a notice by this user
  75         // or b) in reply to a notice to the attention of this user
  76         // or c) to the attention of this user
  77
  78         $context = $this->activity->context;
  79         $notice = false;
  80
  81         if (!empty($context->replyToID)) {
  82             $notice = Notice::getKV('uri', $context->replyToID);
  83         }
  84
  85         if ($notice instanceof Notice &&
  86             ($notice->profile_id == $this->target->id ||
  87              array_key_exists($this->target->id, $notice->getReplies())))
  88         {
  89             // In reply to a notice either from or mentioning this user.
  90         } elseif (!empty($context->attention) &&
  91                    array_key_exists($this->target->getUri(), $context->attention)) {
  92             // To the attention of this user.
  93         } else {
  94             // TRANS: Client exception.
  95             throw new ClientException(_m('Not to anyone in reply to anything.'));
  96         }
  97
  98         $existing = Notice::getKV('uri', $this->activity->objects[0]->id);
  99         if ($existing instanceof Notice) {
 100             common_log(LOG_ERR, "Not saving notice with duplicate URI '".$existing->getUri()."' (seems it 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     function handleFollow()
 112     {
 113         $oprofile = $this->ensureProfile();
 114         if ($oprofile instanceof Ostatus_profile) {
 115             common_log(LOG_INFO, sprintf('Setting up subscription from remote %s to local %s', $oprofile->getUri(), $this->target->getNickname()));
 116             Subscription::start($oprofile->localProfile(),
 117                                 $this->target);
 118         } else {
 119             common_log(LOG_INFO, "Can't set up subscription from remote; missing profile.");
 120         }
 121     }
 122
 123     /**
 124      * We've gotten an unfollow/unsubscribe notification from a remote user.
 125      * Check if we have a subscription relationship for them and kill it.
 126      *
 127      * @fixme probably catch exceptions on fail?
 128      */
 129     function handleUnfollow()
 130     {
 131         $oprofile = $this->ensureProfile();
 132         if ($oprofile instanceof Ostatus_profile) {
 133             common_log(LOG_INFO, sprintf('Canceling subscription from remote %s to local %s', $oprofile->getUri(), $this->target->getNickname()));
 134             try {
 135                 Subscription::cancel($oprofile->localProfile(), $this->target);
 136             } catch (NoProfileException $e) {
 137                 common_debug('Could not find profile for Subscription: '.$e->getMessage());
 138             } catch (AlreadyFulfilledException $e) {
 139                 common_debug('Subscription did not exist, so there was nothing to cancel');
 140             }
 141         } else {
 142             common_log(LOG_ERR, "Can't cancel subscription from remote, didn't find the profile");
 143         }
 144     }
 145
 146     /**
 147      * Remote user likes one of our posts.
 148      * Confirm the post is ours, and save a local favorite event.
 149      */
 150
 151     function handleFavorite()
 152     {
 153         $notice = $this->getNotice($this->activity->objects[0]);
 154         $profile = $this->ensureProfile()->localProfile();
 155
 156         $old = Fave::pkeyGet(array('user_id' => $profile->id,
 157                                    'notice_id' => $notice->id));
 158
 159         if ($old instanceof Fave) {
 160             // TRANS: Client exception.
 161             throw new ClientException(_m('This is already a favorite.'));
 162         }
 163
 164         if (!Fave::addNew($profile, $notice)) {
 165            // TRANS: Client exception.
 166            throw new ClientException(_m('Could not save new favorite.'));
 167         }
 168     }
 169
 170     /**
 171      * Remote user doesn't like one of our posts after all!
 172      * Confirm the post is ours, and save a local favorite event.
 173      */
 174     function handleUnfavorite()
 175     {
 176         $notice = $this->getNotice($this->activity->objects[0]);
 177         $profile = $this->ensureProfile()->localProfile();
 178
 179         $fave = Fave::pkeyGet(array('user_id' => $profile->id,
 180                                    'notice_id' => $notice->id));
 181         if (!$fave instanceof Fave) {
 182             // TRANS: Client exception.
 183             throw new ClientException(_m('Notice was not favorited!'));
 184         }
 185
 186         $fave->delete();
 187     }
 188
 189     function handleTag()
 190     {
 191         if ($this->activity->target->type == ActivityObject::_LIST) {
 192             if ($this->activity->objects[0]->type != ActivityObject::PERSON) {
 193                 // TRANS: Client exception.
 194                 throw new ClientException(_m('Not a person object.'));
 195             }
 196             // this is a peopletag
 197             $tagged = User::getKV('uri', $this->activity->objects[0]->id);
 198
 199             if (!$tagged instanceof User) {
 200                 // TRANS: Client exception.
 201                 throw new ClientException(_m('Unidentified profile being listed.'));
 202             }
 203
 204             if ($tagged->id !== $this->target->id) {
 205                 // TRANS: Client exception.
 206                 throw new ClientException(_m('This user is not the one being listed.'));
 207             }
 208
 209             // save the list
 210             $tagger = $this->ensureProfile();
 211             $list   = Ostatus_profile::ensureActivityObjectProfile($this->activity->target);
 212
 213             $ptag = $list->localPeopletag();
 214             $result = Profile_tag::setTag($ptag->tagger, $tagged->id, $ptag->tag);
 215             if (!$result) {
 216                 // TRANS: Client exception.
 217                 throw new ClientException(_m('The listing could not be saved.'));
 218             }
 219         }
 220     }
 221
 222     function handleUntag()
 223     {
 224         if ($this->activity->target->type == ActivityObject::_LIST) {
 225             if ($this->activity->objects[0]->type != ActivityObject::PERSON) {
 226                 // TRANS: Client exception.
 227                 throw new ClientException(_m('Not a person object.'));
 228                 return false;
 229             }
 230             // this is a peopletag
 231             $tagged = User::getKV('uri', $this->activity->objects[0]->id);
 232
 233             if (!$tagged instanceof User) {
 234                 // TRANS: Client exception.
 235                 throw new ClientException(_m('Unidentified profile being unlisted.'));
 236             }
 237
 238             if ($tagged->id !== $this->target->id) {
 239                 // TRANS: Client exception.
 240                 throw new ClientException(_m('This user is not the one being unlisted.'));
 241             }
 242
 243             // save the list
 244             $tagger = $this->ensureProfile();
 245             $list   = Ostatus_profile::ensureActivityObjectProfile($this->activity->target);
 246
 247             $ptag = $list->localPeopletag();
 248             $result = Profile_tag::unTag($ptag->tagger, $tagged->id, $ptag->tag);
 249
 250             if (!$result) {
 251                 // TRANS: Client exception.
 252                 throw new ClientException(_m('The listing could not be deleted.'));
 253             }
 254         }
 255     }
 256
 257     /**
 258      * @param ActivityObject $object
 259      * @return Notice
 260      * @throws ClientException on invalid input
 261      */
 262     function getNotice(ActivityObject $object)
 263     {
 264         switch ($object->type) {
 265         case ActivityObject::ARTICLE:
 266         case ActivityObject::BLOGENTRY:
 267         case ActivityObject::NOTE:
 268         case ActivityObject::STATUS:
 269         case ActivityObject::COMMENT:
 270             break;
 271         default:
 272             // TRANS: Client exception.
 273             throw new ClientException(_m('Cannot handle that kind of object for liking/faving.'));
 274         }
 275
 276         $notice = Notice::getKV('uri', $object->id);
 277
 278         if (!$notice instanceof Notice) {
 279             // TRANS: Client exception. %s is an object ID.
 280             throw new ClientException(sprintf(_m('Notice with ID %s unknown.'),$object->id));
 281         }
 282
 283         if ($notice->profile_id != $this->target->id) {
 284             // TRANS: Client exception. %1$s is a notice ID, %2$s is a user ID.
 285             throw new ClientException(sprintf(_m('Notice with ID %1$s not posted by %2$s.'), $object->id, $this->target->id));
 286         }
 287
 288         return $notice;
 289     }
 290 }