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