plugins/OStatus/lib/salmon.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2010, StatusNet, Inc.
   5  *
   6  * A sample module to show best practices for StatusNet plugins
   7  *
   8  * PHP version 5
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @package   StatusNet
  24  * @author    James Walker <james@status.net>
  25  * @copyright 2010 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  27  * @link      http://status.net/
  28  */
  29 class Salmon
  30 {
  31     const REL_SALMON = 'salmon';
  32     const REL_MENTIONED = 'mentioned';
  33
  34     // XXX: these are deprecated
  35     const NS_REPLIES = "http://salmon-protocol.org/ns/salmon-replies";
  36     const NS_MENTIONS = "http://salmon-protocol.org/ns/salmon-mention";
  37
  38     /**
  39      * Sign and post the given Atom entry as a Salmon message.
  40      *
  41      * Side effects: may generate a keypair on-demand for the given user,
  42      * which can be very slow on some systems (like those without php5-gmp).
  43      *
  44      * @param string $endpoint_uri
  45      * @param string $xml string representation of payload
  46      * @param Profile $user profile whose keys we sign with (must be a local user)
  47      * @return boolean success
  48      */
  49     public static function post($endpoint_uri, $xml, Profile $actor, Profile $target=null)
  50     {
  51         if (empty($endpoint_uri)) {
  52             common_debug('No endpoint URI for Salmon post to '.$actor->getUri());
  53             return false;
  54         }
  55
  56         try {
  57             $magic_env = MagicEnvelope::signAsUser($xml, $actor->getUser());
  58         } catch (Exception $e) {
  59             common_log(LOG_ERR, "Salmon unable to sign: " . $e->getMessage());
  60             return false;
  61         }
  62
  63         // $target is so far only used in Diaspora, so it can be null
  64         if (Event::handle('SalmonSlap', array($endpoint_uri, $magic_env, $target))) {
  65             return false;
  66             //throw new ServerException('Could not distribute salmon slap as no plugin completed the event.');
  67         }
  68
  69         return true;
  70     }
  71 }