lib/activitycontext.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * An activity
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Feed
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @author    Zach Copley <zach@status.net>
  26  * @copyright 2010 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     exit(1);
  33 }
  34
  35 class ActivityContext
  36 {
  37     public $replyToID;
  38     public $replyToUrl;
  39     public $location;
  40     public $attention = array();
  41     public $attentionType = array();
  42     public $conversation;
  43     public $forwardID; // deprecated, use ActivityVerb::SHARE instead
  44     public $forwardUrl; // deprecated, use ActivityVerb::SHARE instead
  45     public $scope;
  46
  47     const THR     = 'http://purl.org/syndication/thread/1.0';
  48     const GEORSS  = 'http://www.georss.org/georss';
  49     const OSTATUS = 'http://ostatus.org/schema/1.0';
  50
  51     const INREPLYTO = 'in-reply-to';
  52     const REF       = 'ref';
  53     const HREF      = 'href';
  54
  55     const POINT     = 'point';
  56
  57     const MENTIONED    = 'mentioned';
  58     const CONVERSATION = 'ostatus:conversation';
  59
  60     function __construct($element = null)
  61     {
  62         if (empty($element)) {
  63             return;
  64         }
  65
  66         $replyToEl = ActivityUtils::child($element, self::INREPLYTO, self::THR);
  67
  68         if (!empty($replyToEl)) {
  69             $this->replyToID  = $replyToEl->getAttribute(self::REF);
  70             $this->replyToUrl = $replyToEl->getAttribute(self::HREF);
  71         }
  72
  73         $this->location = $this->getLocation($element);
  74
  75         $this->conversation = ActivityUtils::getLink($element, self::CONVERSATION);
  76
  77         // Multiple attention links allowed
  78
  79         $links = $element->getElementsByTagNameNS(ActivityUtils::ATOM, ActivityUtils::LINK);
  80
  81         $attention = array();
  82         for ($i = 0; $i < $links->length; $i++) {
  83             $link = $links->item($i);
  84
  85             $linkRel = $link->getAttribute(ActivityUtils::REL);
  86
  87             if ($linkRel == self::MENTIONED) {
  88                 $attention[] = $link->getAttribute(self::HREF);
  89             }
  90         }
  91         $this->attention = array_unique($attention);
  92     }
  93
  94     /**
  95      * Parse location given as a GeoRSS-simple point, if provided.
  96      * http://www.georss.org/simple
  97      *
  98      * @param feed item $entry
  99      * @return mixed Location or false
 100      */
 101     function getLocation($dom)
 102     {
 103         $points = $dom->getElementsByTagNameNS(self::GEORSS, self::POINT);
 104
 105         for ($i = 0; $i < $points->length; $i++) {
 106             $point = $points->item($i)->textContent;
 107             return self::locationFromPoint($point);
 108         }
 109
 110         return null;
 111     }
 112
 113     // XXX: Move to ActivityUtils or Location?
 114     static function locationFromPoint($point)
 115     {
 116         $point = str_replace(',', ' ', $point); // per spec "treat commas as whitespace"
 117         $point = preg_replace('/\s+/', ' ', $point);
 118         $point = trim($point);
 119         $coords = explode(' ', $point);
 120         if (count($coords) == 2) {
 121             list($lat, $lon) = $coords;
 122             if (is_numeric($lat) && is_numeric($lon)) {
 123                 common_log(LOG_INFO, "Looking up location for $lat $lon from georss point");
 124                 return Location::fromLatLon($lat, $lon);
 125             }
 126         }
 127         common_log(LOG_ERR, "Ignoring bogus georss:point value $point");
 128         return null;
 129     }
 130
 131     /**
 132      * Returns context (StatusNet stuff) as an array suitable for serializing
 133      * in JSON. Right now context stuff is an extension to Activity.
 134      *
 135      * @return array the context
 136      */
 137
 138     function asArray()
 139     {
 140         $context = array();
 141
 142         $context['inReplyTo']    = $this->getInReplyToArray();
 143         $context['conversation'] = $this->conversation;
 144         $context['forwardId']    = $this->forwardID;
 145         $context['forwardUrl']   = $this->forwardUrl;
 146
 147         return array_filter($context);
 148     }
 149
 150     /**
 151      * Returns an array of arrays representing Activity Objects (intended to be
 152      * serialized in JSON) that represent WHO the Activity is supposed to
 153      * be received by. This is not really specified but appears in an example
 154      * of the current spec as an extension. We might want to figure out a JSON
 155      * serialization for OStatus and use that to express mentions instead.
 156      *
 157      * XXX: People's ideas on how to do this are all over the place
 158      *
 159      * @return array the array of recipients
 160      */
 161
 162     function getToArray()
 163     {
 164         $tos = array();
 165
 166         foreach ($this->attention as $attnUrl) {
 167             if (array_key_exists($attnUrl, $this->attentionType)) {
 168                 $type = ActivityObject::canonicalType($this->attentionType[$attnUrl]);
 169             } else {
 170                 $type = ActivityObject::canonicalType(ActivityObject::PERSON);
 171             }
 172             $to = array(
 173                 'objectType' => $type,
 174                 'id'         => $attnUrl
 175             );
 176             $tos[] = $to;
 177         }
 178
 179         return $tos;
 180     }
 181
 182     /**
 183      * Return an array for the notices this notice is a reply to
 184      * suitable for serializing as JSON note objects.
 185      *
 186      * @return array the array of notes
 187      */
 188
 189      function getInReplyToArray()
 190      {
 191          if (empty($this->replyToID) && empty($this->replyToUrl)) {
 192              return null;
 193          }
 194
 195          $replyToObj = array('objectType' => 'note');
 196
 197          // XXX: Possibly shorten this to just the numeric ID?
 198          //      Currently, it's the full URI of the notice.
 199          if (!empty($this->replyToID)) {
 200              $replyToObj['id'] = $this->replyToID;
 201          }
 202          if (!empty($this->replyToUrl)) {
 203              $replyToObj['url'] = $this->replyToUrl;
 204          }
 205
 206          return $replyToObj;
 207      }
 208
 209 }
 210