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