classes/Notice.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2008-2011 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  * @category Notices
  20  * @package  StatusNet
  21  * @author   Brenda Wallace <shiny@cpan.org>
  22  * @author   Christopher Vollick <psycotica0@gmail.com>
  23  * @author   CiaranG <ciaran@ciarang.com>
  24  * @author   Craig Andrews <candrews@integralblue.com>
  25  * @author   Evan Prodromou <evan@controlezvous.ca>
  26  * @author   Gina Haeussge <osd@foosel.net>
  27  * @author   Jeffery To <jeffery.to@gmail.com>
  28  * @author   Mike Cochrane <mikec@mikenz.geek.nz>
  29  * @author   Robin Millette <millette@controlyourself.ca>
  30  * @author   Sarven Capadisli <csarven@controlyourself.ca>
  31  * @author   Tom Adams <tom@holizz.com>
  32  * @author   Mikael Nordfeldth <mmn@hethane.se>
  33  * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
  34  * @license  GNU Affero General Public License http://www.gnu.org/licenses/
  35  */
  36
  37 if (!defined('GNUSOCIAL')) { exit(1); }
  38
  39 /**
  40  * Table Definition for notice
  41  */
  42
  43 /* We keep 200 notices, the max number of notices available per API request,
  44  * in the memcached cache. */
  45
  46 define('NOTICE_CACHE_WINDOW', CachingNoticeStream::CACHE_WINDOW);
  47
  48 define('MAX_BOXCARS', 128);
  49
  50 class Notice extends Managed_DataObject
  51 {
  52     ###START_AUTOCODE
  53     /* the code below is auto generated do not remove the above tag */
  54
  55     public $__table = 'notice';                          // table name
  56     public $id;                              // int(4)  primary_key not_null
  57     public $profile_id;                      // int(4)  multiple_key not_null
  58     public $uri;                             // varchar(191)  unique_key   not 255 because utf8mb4 takes more space
  59     public $content;                         // text
  60     public $rendered;                        // text
  61     public $url;                             // varchar(191)   not 255 because utf8mb4 takes more space
  62     public $created;                         // datetime  multiple_key not_null default_0000-00-00%2000%3A00%3A00
  63     public $modified;                        // timestamp   not_null default_CURRENT_TIMESTAMP
  64     public $reply_to;                        // int(4)
  65     public $is_local;                        // int(4)
  66     public $source;                          // varchar(32)
  67     public $conversation;                    // int(4)
  68     public $lat;                             // decimal(10,7)
  69     public $lon;                             // decimal(10,7)
  70     public $location_id;                     // int(4)
  71     public $location_ns;                     // int(4)
  72     public $repeat_of;                       // int(4)
  73     public $verb;                            // varchar(191)   not 255 because utf8mb4 takes more space
  74     public $object_type;                     // varchar(191)   not 255 because utf8mb4 takes more space
  75     public $scope;                           // int(4)
  76
  77     /* the code above is auto generated do not remove the tag below */
  78     ###END_AUTOCODE
  79
  80     public static function schemaDef()
  81     {
  82         $def = array(
  83             'fields' => array(
  84                 'id' => array('type' => 'serial', 'not null' => true, 'description' => 'unique identifier'),
  85                 'profile_id' => array('type' => 'int', 'not null' => true, 'description' => 'who made the update'),
  86                 'uri' => array('type' => 'varchar', 'length' => 191, 'description' => 'universally unique identifier, usually a tag URI'),
  87                 'content' => array('type' => 'text', 'description' => 'update content', 'collate' => 'utf8mb4_general_ci'),
  88                 'rendered' => array('type' => 'text', 'description' => 'HTML version of the content'),
  89                 'url' => array('type' => 'varchar', 'length' => 191, 'description' => 'URL of any attachment (image, video, bookmark, whatever)'),
  90                 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'),
  91                 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
  92                 'reply_to' => array('type' => 'int', 'description' => 'notice replied to (usually a guess)'),
  93                 'is_local' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'notice was generated by a user'),
  94                 'source' => array('type' => 'varchar', 'length' => 32, 'description' => 'source of comment, like "web", "im", or "clientname"'),
  95                 'conversation' => array('type' => 'int', 'description' => 'id of root notice in this conversation'),
  96                 'lat' => array('type' => 'numeric', 'precision' => 10, 'scale' => 7, 'description' => 'latitude'),
  97                 'lon' => array('type' => 'numeric', 'precision' => 10, 'scale' => 7, 'description' => 'longitude'),
  98                 'location_id' => array('type' => 'int', 'description' => 'location id if possible'),
  99                 'location_ns' => array('type' => 'int', 'description' => 'namespace for location'),
 100                 'repeat_of' => array('type' => 'int', 'description' => 'notice this is a repeat of'),
 101                 'object_type' => array('type' => 'varchar', 'length' => 191, 'description' => 'URI representing activity streams object type', 'default' => 'http://activitystrea.ms/schema/1.0/note'),
 102                 'verb' => array('type' => 'varchar', 'length' => 191, 'description' => 'URI representing activity streams verb', 'default' => 'http://activitystrea.ms/schema/1.0/post'),
 103                 'scope' => array('type' => 'int',
 104                                  'description' => 'bit map for distribution scope; 0 = everywhere; 1 = this server only; 2 = addressees; 4 = followers; null = default'),
 105             ),
 106             'primary key' => array('id'),
 107             'unique keys' => array(
 108                 'notice_uri_key' => array('uri'),
 109             ),
 110             'foreign keys' => array(
 111                 'notice_profile_id_fkey' => array('profile', array('profile_id' => 'id')),
 112                 'notice_reply_to_fkey' => array('notice', array('reply_to' => 'id')),
 113                 'notice_conversation_fkey' => array('conversation', array('conversation' => 'id')), # note... used to refer to notice.id
 114                 'notice_repeat_of_fkey' => array('notice', array('repeat_of' => 'id')), # @fixme: what about repeats of deleted notices?
 115             ),
 116             'indexes' => array(
 117                 'notice_created_id_is_local_idx' => array('created', 'id', 'is_local'),
 118                 'notice_profile_id_idx' => array('profile_id', 'created', 'id'),
 119                 'notice_repeat_of_created_id_idx' => array('repeat_of', 'created', 'id'),
 120                 'notice_conversation_created_id_idx' => array('conversation', 'created', 'id'),
 121                 'notice_replyto_idx' => array('reply_to')
 122             )
 123         );
 124
 125         if (common_config('search', 'type') == 'fulltext') {
 126             $def['fulltext indexes'] = array('content' => array('content'));
 127         }
 128
 129         return $def;
 130     }
 131
 132     /* Notice types */
 133     const LOCAL_PUBLIC    =  1;
 134     const REMOTE          =  0;
 135     const LOCAL_NONPUBLIC = -1;
 136     const GATEWAY         = -2;
 137
 138     const PUBLIC_SCOPE    = 0; // Useful fake constant
 139     const SITE_SCOPE      = 1;
 140     const ADDRESSEE_SCOPE = 2;
 141     const GROUP_SCOPE     = 4;
 142     const FOLLOWER_SCOPE  = 8;
 143
 144     protected $_profile = array();
 145
 146     /**
 147      * Will always return a profile, if anything fails it will
 148      * (through _setProfile) throw a NoProfileException.
 149      */
 150     public function getProfile()
 151     {
 152         if (!isset($this->_profile[$this->profile_id])) {
 153             // We could've sent getKV directly to _setProfile, but occasionally we get
 154             // a "false" (instead of null), likely because it indicates a cache miss.
 155             $profile = Profile::getKV('id', $this->profile_id);
 156             $this->_setProfile($profile instanceof Profile ? $profile : null);
 157         }
 158         return $this->_profile[$this->profile_id];
 159     }
 160
 161     public function _setProfile(Profile $profile=null)
 162     {
 163         if (!$profile instanceof Profile) {
 164             throw new NoProfileException($this->profile_id);
 165         }
 166         $this->_profile[$this->profile_id] = $profile;
 167     }
 168
 169     function delete($useWhere=false)
 170     {
 171         // For auditing purposes, save a record that the notice
 172         // was deleted.
 173
 174         // @fixme we have some cases where things get re-run and so the
 175         // insert fails.
 176         $deleted = Deleted_notice::getKV('id', $this->id);
 177
 178         if (!$deleted instanceof Deleted_notice) {
 179             $deleted = Deleted_notice::getKV('uri', $this->uri);
 180         }
 181
 182         if (!$deleted instanceof Deleted_notice) {
 183             $deleted = new Deleted_notice();
 184
 185             $deleted->id         = $this->id;
 186             $deleted->profile_id = $this->profile_id;
 187             $deleted->uri        = $this->uri;
 188             $deleted->created    = $this->created;
 189             $deleted->deleted    = common_sql_now();
 190
 191             $deleted->insert();
 192         }
 193
 194         if (Event::handle('NoticeDeleteRelated', array($this))) {
 195
 196             // Clear related records
 197
 198             $this->clearReplies();
 199             $this->clearRepeats();
 200             $this->clearTags();
 201             $this->clearGroupInboxes();
 202             $this->clearFiles();
 203             $this->clearAttentions();
 204
 205             // NOTE: we don't clear queue items
 206         }
 207
 208         $result = parent::delete($useWhere);
 209
 210         $this->blowOnDelete();
 211         return $result;
 212     }
 213
 214     public function getUri()
 215     {
 216         return $this->uri;
 217     }
 218
 219     /*
 220      * Get a Notice object by URI. Will call external plugins for help
 221      * using the event StartGetNoticeFromURI.
 222      *
 223      * @param string $uri A unique identifier for a resource (notice in this case)
 224      */
 225     static function fromUri($uri)
 226     {
 227         $notice = null;
 228
 229         if (Event::handle('StartGetNoticeFromUri', array($uri, &$notice))) {
 230             $notice = Notice::getKV('uri', $uri);
 231             Event::handle('EndGetNoticeFromUri', array($uri, $notice));
 232         }
 233
 234         if (!$notice instanceof Notice) {
 235             throw new UnknownUriException($uri);
 236         }
 237
 238         return $notice;
 239     }
 240
 241     /*
 242      * @param $root boolean If true, link to just the conversation root.
 243      *
 244      * @return URL to conversation
 245      */
 246     public function getConversationUrl($anchor=true)
 247     {
 248         return Conversation::getUrlFromNotice($this, $anchor);
 249     }
 250
 251     /*
 252      * Get the local representation URL of this notice.
 253      */
 254     public function getLocalUrl()
 255     {
 256         return common_local_url('shownotice', array('notice' => $this->id), null, null, false);
 257     }
 258
 259     public function getTitle()
 260     {
 261         $title = null;
 262         if (Event::handle('GetNoticeTitle', array($this, &$title))) {
 263             // TRANS: Title of a notice posted without a title value.
 264             // TRANS: %1$s is a user name, %2$s is the notice creation date/time.
 265             $title = sprintf(_('%1$s\'s status on %2$s'),
 266                              $this->getProfile()->getFancyName(),
 267                              common_exact_date($this->created));
 268         }
 269         return $title;
 270     }
 271
 272     public function getContent()
 273     {
 274         return $this->content;
 275     }
 276
 277     /*
 278      * Get the original representation URL of this notice.
 279      *
 280      * @param boolean $fallback     Whether to fall back to generate a local URL or throw InvalidUrlException
 281      */
 282     public function getUrl($fallback=false)
 283     {
 284         // The risk is we start having empty urls and non-http uris...
 285         // and we can't really handle any other protocol right now.
 286         switch (true) {
 287         case common_valid_http_url($this->url): // should we allow non-http/https URLs?
 288             return $this->url;
 289         case !$this->isLocal() && common_valid_http_url($this->uri): // Sometimes we only have the URI for remote posts.
 290             return $this->uri;
 291         case $this->isLocal() || $fallback:
 292             // let's generate a valid link to our locally available notice on demand
 293             return common_local_url('shownotice', array('notice' => $this->id), null, null, false);
 294         default:
 295             common_debug('No URL available for notice: id='.$this->id);
 296             throw new InvalidUrlException($this->url);
 297         }
 298     }
 299
 300     public function get_object_type($canonical=false) {
 301         return $canonical
 302                 ? ActivityObject::canonicalType($this->object_type)
 303                 : $this->object_type;
 304     }
 305
 306     public static function getByUri($uri)
 307     {
 308         $notice = new Notice();
 309         $notice->uri = $uri;
 310         if (!$notice->find(true)) {
 311             throw new NoResultException($notice);
 312         }
 313         return $notice;
 314     }
 315
 316     /**
 317      * Extract #hashtags from this notice's content and save them to the database.
 318      */
 319     function saveTags()
 320     {
 321         /* extract all #hastags */
 322         $count = preg_match_all('/(?:^|\s)#([\pL\pN_\-\.]{1,64})/u', strtolower($this->content), $match);
 323         if (!$count) {
 324             return true;
 325         }
 326
 327         /* Add them to the database */
 328         return $this->saveKnownTags($match[1]);
 329     }
 330
 331     /**
 332      * Record the given set of hash tags in the db for this notice.
 333      * Given tag strings will be normalized and checked for dupes.
 334      */
 335     function saveKnownTags($hashtags)
 336     {
 337         //turn each into their canonical tag
 338         //this is needed to remove dupes before saving e.g. #hash.tag = #hashtag
 339         for($i=0; $i<count($hashtags); $i++) {
 340             /* elide characters we don't want in the tag */
 341             $hashtags[$i] = common_canonical_tag($hashtags[$i]);
 342         }
 343
 344         foreach(array_unique($hashtags) as $hashtag) {
 345             $this->saveTag($hashtag);
 346             self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, $hashtag);
 347         }
 348         return true;
 349     }
 350
 351     /**
 352      * Record a single hash tag as associated with this notice.
 353      * Tag format and uniqueness must be validated by caller.
 354      */
 355     function saveTag($hashtag)
 356     {
 357         $tag = new Notice_tag();
 358         $tag->notice_id = $this->id;
 359         $tag->tag = $hashtag;
 360         $tag->created = $this->created;
 361         $id = $tag->insert();
 362
 363         if (!$id) {
 364             // TRANS: Server exception. %s are the error details.
 365             throw new ServerException(sprintf(_('Database error inserting hashtag: %s.'),
 366                                               $last_error->message));
 367             return;
 368         }
 369
 370         // if it's saved, blow its cache
 371         $tag->blowCache(false);
 372     }
 373
 374     /**
 375      * Save a new notice and push it out to subscribers' inboxes.
 376      * Poster's permissions are checked before sending.
 377      *
 378      * @param int $profile_id Profile ID of the poster
 379      * @param string $content source message text; links may be shortened
 380      *                        per current user's preference
 381      * @param string $source source key ('web', 'api', etc)
 382      * @param array $options Associative array of optional properties:
 383      *              string 'created' timestamp of notice; defaults to now
 384      *              int 'is_local' source/gateway ID, one of:
 385      *                  Notice::LOCAL_PUBLIC    - Local, ok to appear in public timeline
 386      *                  Notice::REMOTE          - Sent from a remote service;
 387      *                                            hide from public timeline but show in
 388      *                                            local "and friends" timelines
 389      *                  Notice::LOCAL_NONPUBLIC - Local, but hide from public timeline
 390      *                  Notice::GATEWAY         - From another non-OStatus service;
 391      *                                            will not appear in public views
 392      *              float 'lat' decimal latitude for geolocation
 393      *              float 'lon' decimal longitude for geolocation
 394      *              int 'location_id' geoname identifier
 395      *              int 'location_ns' geoname namespace to interpret location_id
 396      *              int 'reply_to'; notice ID this is a reply to
 397      *              int 'repeat_of'; notice ID this is a repeat of
 398      *              string 'uri' unique ID for notice; a unique tag uri (can be url or anything too)
 399      *              string 'url' permalink to notice; defaults to local notice URL
 400      *              string 'rendered' rendered HTML version of content
 401      *              array 'replies' list of profile URIs for reply delivery in
 402      *                              place of extracting @-replies from content.
 403      *              array 'groups' list of group IDs to deliver to, in place of
 404      *                              extracting ! tags from content
 405      *              array 'tags' list of hashtag strings to save with the notice
 406      *                           in place of extracting # tags from content
 407      *              array 'urls' list of attached/referred URLs to save with the
 408      *                           notice in place of extracting links from content
 409      *              boolean 'distribute' whether to distribute the notice, default true
 410      *              string 'object_type' URL of the associated object type (default ActivityObject::NOTE)
 411      *              string 'verb' URL of the associated verb (default ActivityVerb::POST)
 412      *              int 'scope' Scope bitmask; default to SITE_SCOPE on private sites, 0 otherwise
 413      *
 414      * @fixme tag override
 415      *
 416      * @return Notice
 417      * @throws ClientException
 418      */
 419     static function saveNew($profile_id, $content, $source, array $options=null) {
 420         $defaults = array('uri' => null,
 421                           'url' => null,
 422                           'conversation' => null,   // URI of conversation
 423                           'reply_to' => null,       // This will override convo URI if the parent is known
 424                           'repeat_of' => null,      // This will override convo URI if the repeated notice is known
 425                           'scope' => null,
 426                           'distribute' => true,
 427                           'object_type' => null,
 428                           'verb' => null);
 429
 430         if (!empty($options) && is_array($options)) {
 431             $options = array_merge($defaults, $options);
 432             extract($options);
 433         } else {
 434             extract($defaults);
 435         }
 436
 437         if (!isset($is_local)) {
 438             $is_local = Notice::LOCAL_PUBLIC;
 439         }
 440
 441         $profile = Profile::getKV('id', $profile_id);
 442         if (!$profile instanceof Profile) {
 443             // TRANS: Client exception thrown when trying to save a notice for an unknown user.
 444             throw new ClientException(_('Problem saving notice. Unknown user.'));
 445         }
 446
 447         $user = User::getKV('id', $profile_id);
 448         if ($user instanceof User) {
 449             // Use the local user's shortening preferences, if applicable.
 450             $final = $user->shortenLinks($content);
 451         } else {
 452             $final = common_shorten_links($content);
 453         }
 454
 455         if (Notice::contentTooLong($final)) {
 456             // TRANS: Client exception thrown if a notice contains too many characters.
 457             throw new ClientException(_('Problem saving notice. Too long.'));
 458         }
 459
 460         if (common_config('throttle', 'enabled') && !Notice::checkEditThrottle($profile_id)) {
 461             common_log(LOG_WARNING, 'Excessive posting by profile #' . $profile_id . '; throttled.');
 462             // TRANS: Client exception thrown when a user tries to post too many notices in a given time frame.
 463             throw new ClientException(_('Too many notices too fast; take a breather '.
 464                                         'and post again in a few minutes.'));
 465         }
 466
 467         if (common_config('site', 'dupelimit') > 0 && !Notice::checkDupes($profile_id, $final)) {
 468             common_log(LOG_WARNING, 'Dupe posting by profile #' . $profile_id . '; throttled.');
 469             // TRANS: Client exception thrown when a user tries to post too many duplicate notices in a given time frame.
 470             throw new ClientException(_('Too many duplicate messages too quickly;'.
 471                                         ' take a breather and post again in a few minutes.'));
 472         }
 473
 474         if (!$profile->hasRight(Right::NEWNOTICE)) {
 475             common_log(LOG_WARNING, "Attempted post from user disallowed to post: " . $profile->nickname);
 476
 477             // TRANS: Client exception thrown when a user tries to post while being banned.
 478             throw new ClientException(_('You are banned from posting notices on this site.'), 403);
 479         }
 480
 481         $notice = new Notice();
 482         $notice->profile_id = $profile_id;
 483
 484         $autosource = common_config('public', 'autosource');
 485
 486         // Sandboxed are non-false, but not 1, either
 487
 488         if (!$profile->hasRight(Right::PUBLICNOTICE) ||
 489             ($source && $autosource && in_array($source, $autosource))) {
 490             $notice->is_local = Notice::LOCAL_NONPUBLIC;
 491         } else {
 492             $notice->is_local = $is_local;
 493         }
 494
 495         if (!empty($created)) {
 496             $notice->created = $created;
 497         } else {
 498             $notice->created = common_sql_now();
 499         }
 500
 501         if (!$notice->isLocal()) {
 502             // Only do these checks for non-local notices. Local notices will generate these values later.
 503             if (!common_valid_http_url($url)) {
 504                 common_debug('Bad notice URL: ['.$url.'], URI: ['.$uri.']. Cannot link back to original! This is normal for shared notices etc.');
 505             }
 506             if (empty($uri)) {
 507                 throw new ServerException('No URI for remote notice. Cannot accept that.');
 508             }
 509         }
 510
 511         $notice->content = $final;
 512
 513         $notice->source = $source;
 514         $notice->uri = $uri;
 515         $notice->url = $url;
 516
 517         // Get the groups here so we can figure out replies and such
 518         if (!isset($groups)) {
 519             $groups = User_group::idsFromText($notice->content, $profile);
 520         }
 521
 522         $reply = null;
 523
 524         // Handle repeat case
 525
 526         if (isset($repeat_of)) {
 527
 528             // Check for a private one
 529
 530             $repeat = Notice::getKV('id', $repeat_of);
 531
 532             if (!($repeat instanceof Notice)) {
 533                 // TRANS: Client exception thrown in notice when trying to repeat a missing or deleted notice.
 534                 throw new ClientException(_('Cannot repeat; original notice is missing or deleted.'));
 535             }
 536
 537             if ($profile->id == $repeat->profile_id) {
 538                 // TRANS: Client error displayed when trying to repeat an own notice.
 539                 throw new ClientException(_('You cannot repeat your own notice.'));
 540             }
 541
 542             if ($repeat->scope != Notice::SITE_SCOPE &&
 543                 $repeat->scope != Notice::PUBLIC_SCOPE) {
 544                 // TRANS: Client error displayed when trying to repeat a non-public notice.
 545                 throw new ClientException(_('Cannot repeat a private notice.'), 403);
 546             }
 547
 548             if (!$repeat->inScope($profile)) {
 549                 // The generic checks above should cover this, but let's be sure!
 550                 // TRANS: Client error displayed when trying to repeat a notice you cannot access.
 551                 throw new ClientException(_('Cannot repeat a notice you cannot read.'), 403);
 552             }
 553
 554             if ($profile->hasRepeated($repeat)) {
 555                 // TRANS: Client error displayed when trying to repeat an already repeated notice.
 556                 throw new ClientException(_('You already repeated that notice.'));
 557             }
 558
 559             $notice->repeat_of = $repeat->id;
 560             $notice->conversation = $repeat->conversation;
 561         } else {
 562             $reply = null;
 563
 564             // If $reply_to is specified, we check that it exists, and then
 565             // return it if it does
 566             if (!empty($reply_to)) {
 567                 $reply = Notice::getKV('id', $reply_to);
 568             } elseif (in_array($source, array('xmpp', 'mail', 'sms'))) {
 569                 // If the source lacks capability of sending the "reply_to"
 570                 // metadata, let's try to find an inline replyto-reference.
 571                 $reply = self::getInlineReplyTo($profile, $final);
 572             }
 573
 574             if ($reply instanceof Notice) {
 575                 if (!$reply->inScope($profile)) {
 576                     // TRANS: Client error displayed when trying to reply to a notice a the target has no access to.
 577                     // TRANS: %1$s is a user nickname, %2$d is a notice ID (number).
 578                     throw new ClientException(sprintf(_('%1$s has no access to notice %2$d.'),
 579                                                       $profile->nickname, $reply->id), 403);
 580                 }
 581
 582                 // If it's a repeat, the reply_to should be to the original
 583                 if ($reply->isRepeat()) {
 584                     $notice->reply_to = $reply->repeat_of;
 585                 } else {
 586                     $notice->reply_to = $reply->id;
 587                 }
 588                 // But the conversation ought to be the same :)
 589                 $notice->conversation = $reply->conversation;
 590
 591                 // If the original is private to a group, and notice has
 592                 // no group specified, make it to the same group(s)
 593
 594                 if (empty($groups) && ($reply->scope & Notice::GROUP_SCOPE)) {
 595                     $groups = array();
 596                     $replyGroups = $reply->getGroups();
 597                     foreach ($replyGroups as $group) {
 598                         if ($profile->isMember($group)) {
 599                             $groups[] = $group->id;
 600                         }
 601                     }
 602                 }
 603
 604                 // Scope set below
 605             }
 606
 607             // If we don't know the reply, we might know the conversation!
 608             // This will happen if a known remote user replies to an
 609             // unknown remote user - within a known conversation.
 610             if (empty($notice->conversation) and !empty($options['conversation'])) {
 611                 $conv = Conversation::getKV('uri', $options['conversation']);
 612                 if ($conv instanceof Conversation) {
 613                     common_debug('Conversation stitched together from (probably) reply to unknown remote user. Activity creation time ('.$notice->created.') should maybe be compared to conversation creation time ('.$conv->created.').');
 614                     $notice->conversation = $conv->id;
 615                 } else {
 616                     // Conversation URI was not found, so we must create it. But we can't create it
 617                     // until we have a Notice ID because of the database layout...
 618                     $notice->tmp_conv_uri = $options['conversation'];
 619                 }
 620             } else {
 621                 // If we're not using the attached conversation URI let's remove it
 622                 // so we don't mistake ourselves later, when creating our own Conversation.
 623                 // This implies that the notice knows which conversation it belongs to.
 624                 $options['conversation'] = null;
 625             }
 626         }
 627
 628         if (!empty($lat) && !empty($lon)) {
 629             $notice->lat = $lat;
 630             $notice->lon = $lon;
 631         }
 632
 633         if (!empty($location_ns) && !empty($location_id)) {
 634             $notice->location_id = $location_id;
 635             $notice->location_ns = $location_ns;
 636         }
 637
 638         if (!empty($rendered)) {
 639             $notice->rendered = $rendered;
 640         } else {
 641             $notice->rendered = common_render_content($final, $notice);
 642         }
 643
 644         if (empty($verb)) {
 645             if ($notice->isRepeat()) {
 646                 $notice->verb        = ActivityVerb::SHARE;
 647                 $notice->object_type = ActivityObject::ACTIVITY;
 648             } else {
 649                 $notice->verb        = ActivityVerb::POST;
 650             }
 651         } else {
 652             $notice->verb = $verb;
 653         }
 654
 655         if (empty($object_type)) {
 656             $notice->object_type = (empty($notice->reply_to)) ? ActivityObject::NOTE : ActivityObject::COMMENT;
 657         } else {
 658             $notice->object_type = $object_type;
 659         }
 660
 661         if (is_null($scope) && $reply instanceof Notice) {
 662             $notice->scope = $reply->scope;
 663         } else {
 664             $notice->scope = $scope;
 665         }
 666
 667         $notice->scope = self::figureOutScope($profile, $groups, $notice->scope);
 668
 669         if (Event::handle('StartNoticeSave', array(&$notice))) {
 670
 671             // XXX: some of these functions write to the DB
 672
 673             try {
 674                 $notice->insert();  // throws exception on failure
 675                 // If it's not part of a conversation, it's
 676                 // the beginning of a new conversation.
 677                 if (empty($notice->conversation)) {
 678                     $orig = clone($notice);
 679                     // $act->context->conversation will be null if it was not provided
 680                     $conv = Conversation::create($notice, $options['conversation']);
 681                     $notice->conversation = $conv->id;
 682                     $notice->update($orig);
 683                 }
 684             } catch (Exception $e) {
 685                 // Let's test if we managed initial insert, which would imply
 686                 // failing on some update-part (check 'insert()'). Delete if
 687                 // something had been stored to the database.
 688                 if (!empty($notice->id)) {
 689                     $notice->delete();
 690                 }
 691                 throw $e;
 692             }
 693         }
 694
 695         // Clear the cache for subscribed users, so they'll update at next request
 696         // XXX: someone clever could prepend instead of clearing the cache
 697
 698         // Save per-notice metadata...
 699
 700         if (isset($replies)) {
 701             $notice->saveKnownReplies($replies);
 702         } else {
 703             $notice->saveReplies();
 704         }
 705
 706         if (isset($tags)) {
 707             $notice->saveKnownTags($tags);
 708         } else {
 709             $notice->saveTags();
 710         }
 711
 712         // Note: groups may save tags, so must be run after tags are saved
 713         // to avoid errors on duplicates.
 714         // Note: groups should always be set.
 715
 716         $notice->saveKnownGroups($groups);
 717
 718         if (isset($urls)) {
 719             $notice->saveKnownUrls($urls);
 720         } else {
 721             $notice->saveUrls();
 722         }
 723
 724         if ($distribute) {
 725             // Prepare inbox delivery, may be queued to background.
 726             $notice->distribute();
 727         }
 728
 729         return $notice;
 730     }
 731
 732     static function saveActivity(Activity $act, Profile $actor, array $options=array())
 733     {
 734         // First check if we're going to let this Activity through from the specific actor
 735         if (!$actor->hasRight(Right::NEWNOTICE)) {
 736             common_log(LOG_WARNING, "Attempted post from user disallowed to post: " . $actor->getNickname());
 737
 738             // TRANS: Client exception thrown when a user tries to post while being banned.
 739             throw new ClientException(_m('You are banned from posting notices on this site.'), 403);
 740         }
 741         if (common_config('throttle', 'enabled') && !self::checkEditThrottle($actor->id)) {
 742             common_log(LOG_WARNING, 'Excessive posting by profile #' . $actor->id . '; throttled.');
 743             // TRANS: Client exception thrown when a user tries to post too many notices in a given time frame.
 744             throw new ClientException(_m('Too many notices too fast; take a breather '.
 745                                         'and post again in a few minutes.'));
 746         }
 747
 748         // Get ActivityObject properties
 749         if (!empty($act->id)) {
 750             // implied object
 751             $options['uri'] = $act->id;
 752             $options['url'] = $act->link;
 753         } else {
 754             $actobj = count($act->objects)==1 ? $act->objects[0] : null;
 755             if (!is_null($actobj) && !empty($actobj->id)) {
 756                 $options['uri'] = $actobj->id;
 757                 if ($actobj->link) {
 758                     $options['url'] = $actobj->link;
 759                 } elseif (preg_match('!^https?://!', $actobj->id)) {
 760                     $options['url'] = $actobj->id;
 761                 }
 762             }
 763         }
 764
 765         $defaults = array(
 766                           'groups'   => array(),
 767                           'is_local' => self::LOCAL_PUBLIC,
 768                           'mentions' => array(),
 769                           'reply_to' => null,
 770                           'repeat_of' => null,
 771                           'scope' => null,
 772                           'source' => 'unknown',
 773                           'tags' => array(),
 774                           'uri' => null,
 775                           'url' => null,
 776                           'urls' => array(),
 777                           'distribute' => true);
 778
 779         // options will have default values when nothing has been supplied
 780         $options = array_merge($defaults, $options);
 781         foreach (array_keys($defaults) as $key) {
 782             // Only convert the keynames we specify ourselves from 'defaults' array into variables
 783             $$key = $options[$key];
 784         }
 785         extract($options, EXTR_SKIP);
 786
 787         $stored = new Notice();
 788         if (!empty($uri)) {
 789             $stored->uri = $uri;
 790             if ($stored->find()) {
 791                 common_debug('cannot create duplicate Notice URI: '.$stored->uri);
 792                 throw new Exception('Notice URI already exists');
 793             }
 794         }
 795
 796         $stored->profile_id = $actor->id;
 797         $stored->source = $source;
 798         $stored->uri = $uri;
 799         $stored->url = $url;
 800         $stored->verb = $act->verb;
 801
 802         // Use the local user's shortening preferences, if applicable.
 803         $stored->rendered = $actor->isLocal()
 804                                 ? $actor->shortenLinks($act->content)
 805                                 : $act->content;
 806         $stored->content = common_strip_html($stored->rendered);
 807
 808         $autosource = common_config('public', 'autosource');
 809
 810         // Sandboxed are non-false, but not 1, either
 811         if (!$actor->hasRight(Right::PUBLICNOTICE) ||
 812             ($source && $autosource && in_array($source, $autosource))) {
 813             $stored->is_local = Notice::LOCAL_NONPUBLIC;
 814         }
 815
 816         // Maybe a missing act-time should be fatal if the actor is not local?
 817         if (!empty($act->time)) {
 818             $stored->created = common_sql_date($act->time);
 819         } else {
 820             $stored->created = common_sql_now();
 821         }
 822
 823         $reply = null;
 824         if ($act->context instanceof ActivityContext && !empty($act->context->replyToID)) {
 825             $reply = self::getKV('uri', $act->context->replyToID);
 826         }
 827         if (!$reply instanceof Notice && $act->target instanceof ActivityObject) {
 828             $reply = self::getKV('uri', $act->target->id);
 829         }
 830
 831         if ($reply instanceof Notice) {
 832             if (!$reply->inScope($actor)) {
 833                 // TRANS: Client error displayed when trying to reply to a notice a the target has no access to.
 834                 // TRANS: %1$s is a user nickname, %2$d is a notice ID (number).
 835                 throw new ClientException(sprintf(_m('%1$s has no right to reply to notice %2$d.'), $actor->getNickname(), $reply->id), 403);
 836             }
 837
 838             $stored->reply_to     = $reply->id;
 839             $stored->conversation = $reply->conversation;
 840
 841             // If the original is private to a group, and notice has no group specified,
 842             // make it to the same group(s)
 843             if (empty($groups) && ($reply->scope & Notice::GROUP_SCOPE)) {
 844                 $groups = array();
 845                 $replyGroups = $reply->getGroups();
 846                 foreach ($replyGroups as $group) {
 847                     if ($actor->isMember($group)) {
 848                         $groups[] = $group->id;
 849                     }
 850                 }
 851             }
 852
 853             if (is_null($scope)) {
 854                 $scope = $reply->scope;
 855             }
 856         }
 857
 858         if ($act->context instanceof ActivityContext) {
 859             $location = $act->context->location;
 860             if ($location) {
 861                 $stored->lat = $location->lat;
 862                 $stored->lon = $location->lon;
 863                 if ($location->location_id) {
 864                     $stored->location_ns = $location->location_ns;
 865                     $stored->location_id = $location->location_id;
 866                 }
 867             }
 868         } else {
 869             $act->context = new ActivityContext();
 870         }
 871
 872         $stored->scope = self::figureOutScope($actor, $groups, $scope);
 873
 874         foreach ($act->categories as $cat) {
 875             if ($cat->term) {
 876                 $term = common_canonical_tag($cat->term);
 877                 if (!empty($term)) {
 878                     $tags[] = $term;
 879                 }
 880             }
 881         }
 882
 883         foreach ($act->enclosures as $href) {
 884             // @todo FIXME: Save these locally or....?
 885             $urls[] = $href;
 886         }
 887
 888         if (Event::handle('StartNoticeSave', array(&$stored))) {
 889             // XXX: some of these functions write to the DB
 890
 891             try {
 892                 $stored->insert();    // throws exception on error
 893                 $orig = clone($stored); // for updating later in this try clause
 894
 895                 $object = null;
 896                 Event::handle('StoreActivityObject', array($act, $stored, $options, &$object));
 897                 if (empty($object)) {
 898                     throw new ServerException('Unsuccessful call to StoreActivityObject '.$stored->uri . ': '.$act->asString());
 899                 }
 900
 901                 // If it's not part of a conversation, it's
 902                 // the beginning of a new conversation.
 903                 if (empty($stored->conversation)) {
 904                     // $act->context->conversation will be null if it was not provided
 905                     $conv = Conversation::create($stored, $act->context->conversation);
 906                     $stored->conversation = $conv->id;
 907                 }
 908
 909                 $stored->update($orig);
 910             } catch (Exception $e) {
 911                 if (empty($stored->id)) {
 912                     common_debug('Failed to save stored object entry in database ('.$e->getMessage().')');
 913                 } else {
 914                     common_debug('Failed to store activity object in database ('.$e->getMessage().'), deleting notice id '.$stored->id);
 915                     $stored->delete();
 916                 }
 917                 throw $e;
 918             }
 919         }
 920         if (!$stored instanceof Notice) {
 921             throw new ServerException('StartNoticeSave did not give back a Notice');
 922         }
 923
 924         // Save per-notice metadata...
 925         $mentions = array();
 926         $groups   = array();
 927
 928         // This event lets plugins filter out non-local recipients (attentions we don't care about)
 929         // Used primarily for OStatus (and if we don't federate, all attentions would be local anyway)
 930         Event::handle('GetLocalAttentions', array($actor, $act->context->attention, &$mentions, &$groups));
 931
 932         if (!empty($mentions)) {
 933             $stored->saveKnownReplies($mentions);
 934         } else {
 935             $stored->saveReplies();
 936         }
 937
 938         if (!empty($tags)) {
 939             $stored->saveKnownTags($tags);
 940         } else {
 941             $stored->saveTags();
 942         }
 943
 944         // Note: groups may save tags, so must be run after tags are saved
 945         // to avoid errors on duplicates.
 946         // Note: groups should always be set.
 947
 948         $stored->saveKnownGroups($groups);
 949
 950         if (!empty($urls)) {
 951             $stored->saveKnownUrls($urls);
 952         } else {
 953             $stored->saveUrls();
 954         }
 955
 956         if ($distribute) {
 957             // Prepare inbox delivery, may be queued to background.
 958             $stored->distribute();
 959         }
 960
 961         return $stored;
 962     }
 963
 964     static public function figureOutScope(Profile $actor, array $groups, $scope=null) {
 965         if (is_null($scope)) {
 966             $scope = self::defaultScope();
 967         }
 968
 969         // For private streams
 970         try {
 971             $user = $actor->getUser();
 972             // FIXME: We can't do bit comparison with == (Legacy StatusNet thing. Let's keep it for now.)
 973             if ($user->private_stream && ($scope == Notice::PUBLIC_SCOPE || $scope == Notice::SITE_SCOPE)) {
 974                 $scope |= Notice::FOLLOWER_SCOPE;
 975             }
 976         } catch (NoSuchUserException $e) {
 977             // TODO: Not a local user, so we don't know about scope preferences... yet!
 978         }
 979
 980         // Force the scope for private groups
 981         foreach ($groups as $group_id) {
 982             try {
 983                 $group = User_group::getByID($group_id);
 984                 if ($group->force_scope) {
 985                     $scope |= Notice::GROUP_SCOPE;
 986                     break;
 987                 }
 988             } catch (Exception $e) {
 989                 common_log(LOG_ERR, 'Notice figureOutScope threw exception: '.$e->getMessage());
 990             }
 991         }
 992
 993         return $scope;
 994     }
 995
 996     function blowOnInsert($conversation = false)
 997     {
 998         $this->blowStream('profile:notice_ids:%d', $this->profile_id);
 999
1000         if ($this->isPublic()) {
1001             $this->blowStream('public');
1002             $this->blowStream('networkpublic');
1003         }
1004
1005         self::blow('notice:list-ids:conversation:%s', $this->conversation);
1006         self::blow('conversation:notice_count:%d', $this->conversation);
1007
1008         if ($this->isRepeat()) {
1009             // XXX: we should probably only use one of these
1010             $this->blowStream('notice:repeats:%d', $this->repeat_of);
1011             self::blow('notice:list-ids:repeat_of:%d', $this->repeat_of);
1012         }
1013
1014         $original = Notice::getKV('id', $this->repeat_of);
1015
1016         if ($original instanceof Notice) {
1017             $originalUser = User::getKV('id', $original->profile_id);
1018             if ($originalUser instanceof User) {
1019                 $this->blowStream('user:repeats_of_me:%d', $originalUser->id);
1020             }
1021         }
1022
1023         $profile = Profile::getKV($this->profile_id);
1024
1025         if ($profile instanceof Profile) {
1026             $profile->blowNoticeCount();
1027         }
1028
1029         $ptags = $this->getProfileTags();
1030         foreach ($ptags as $ptag) {
1031             $ptag->blowNoticeStreamCache();
1032         }
1033     }
1034
1035     /**
1036      * Clear cache entries related to this notice at delete time.
1037      * Necessary to avoid breaking paging on public, profile timelines.
1038      */
1039     function blowOnDelete()
1040     {
1041         $this->blowOnInsert();
1042
1043         self::blow('profile:notice_ids:%d;last', $this->profile_id);
1044
1045         if ($this->isPublic()) {
1046             self::blow('public;last');
1047             self::blow('networkpublic;last');
1048         }
1049
1050         self::blow('fave:by_notice', $this->id);
1051
1052         if ($this->conversation) {
1053             // In case we're the first, will need to calc a new root.
1054             self::blow('notice:conversation_root:%d', $this->conversation);
1055         }
1056
1057         $ptags = $this->getProfileTags();
1058         foreach ($ptags as $ptag) {
1059             $ptag->blowNoticeStreamCache(true);
1060         }
1061     }
1062
1063     function blowStream()
1064     {
1065         $c = self::memcache();
1066
1067         if (empty($c)) {
1068             return false;
1069         }
1070
1071         $args = func_get_args();
1072         $format = array_shift($args);
1073         $keyPart = vsprintf($format, $args);
1074         $cacheKey = Cache::key($keyPart);
1075         $c->delete($cacheKey);
1076
1077         // delete the "last" stream, too, if this notice is
1078         // older than the top of that stream
1079
1080         $lastKey = $cacheKey.';last';
1081
1082         $lastStr = $c->get($lastKey);
1083
1084         if ($lastStr !== false) {
1085             $window     = explode(',', $lastStr);
1086             $lastID     = $window[0];
1087             $lastNotice = Notice::getKV('id', $lastID);
1088             if (!$lastNotice instanceof Notice // just weird
1089                 || strtotime($lastNotice->created) >= strtotime($this->created)) {
1090                 $c->delete($lastKey);
1091             }
1092         }
1093     }
1094
1095     /** save all urls in the notice to the db
1096      *
1097      * follow redirects and save all available file information
1098      * (mimetype, date, size, oembed, etc.)
1099      *
1100      * @return void
1101      */
1102     function saveUrls() {
1103         if (common_config('attachments', 'process_links')) {
1104             common_replace_urls_callback($this->content, array($this, 'saveUrl'), $this);
1105         }
1106     }
1107
1108     /**
1109      * Save the given URLs as related links/attachments to the db
1110      *
1111      * follow redirects and save all available file information
1112      * (mimetype, date, size, oembed, etc.)
1113      *
1114      * @return void
1115      */
1116     function saveKnownUrls($urls)
1117     {
1118         if (common_config('attachments', 'process_links')) {
1119             // @fixme validation?
1120             foreach (array_unique($urls) as $url) {
1121                 $this->saveUrl($url, $this);
1122             }
1123         }
1124     }
1125
1126     /**
1127      * @private callback
1128      */
1129     function saveUrl($url, Notice $notice) {
1130         try {
1131             File::processNew($url, $notice);
1132         } catch (ServerException $e) {
1133             // Could not save URL. Log it?
1134         }
1135     }
1136
1137     static function checkDupes($profile_id, $content) {
1138         $profile = Profile::getKV($profile_id);
1139         if (!$profile instanceof Profile) {
1140             return false;
1141         }
1142         $notice = $profile->getNotices(0, CachingNoticeStream::CACHE_WINDOW);
1143         if (!empty($notice)) {
1144             $last = 0;
1145             while ($notice->fetch()) {
1146                 if (time() - strtotime($notice->created) >= common_config('site', 'dupelimit')) {
1147                     return true;
1148                 } else if ($notice->content == $content) {
1149                     return false;
1150                 }
1151             }
1152         }
1153         // If we get here, oldest item in cache window is not
1154         // old enough for dupe limit; do direct check against DB
1155         $notice = new Notice();
1156         $notice->profile_id = $profile_id;
1157         $notice->content = $content;
1158         $threshold = common_sql_date(time() - common_config('site', 'dupelimit'));
1159         $notice->whereAdd(sprintf("created > '%s'", $notice->escape($threshold)));
1160
1161         $cnt = $notice->count();
1162         return ($cnt == 0);
1163     }
1164
1165     static function checkEditThrottle($profile_id) {
1166         $profile = Profile::getKV($profile_id);
1167         if (!$profile instanceof Profile) {
1168             return false;
1169         }
1170         // Get the Nth notice
1171         $notice = $profile->getNotices(common_config('throttle', 'count') - 1, 1);
1172         if ($notice && $notice->fetch()) {
1173             // If the Nth notice was posted less than timespan seconds ago
1174             if (time() - strtotime($notice->created) <= common_config('throttle', 'timespan')) {
1175                 // Then we throttle
1176                 return false;
1177             }
1178         }
1179         // Either not N notices in the stream, OR the Nth was not posted within timespan seconds
1180         return true;
1181     }
1182
1183         protected $_attachments = array();
1184
1185     function attachments() {
1186                 if (isset($this->_attachments[$this->id])) {
1187             return $this->_attachments[$this->id];
1188         }
1189
1190         $f2ps = File_to_post::listGet('post_id', array($this->id));
1191                 $ids = array();
1192                 foreach ($f2ps[$this->id] as $f2p) {
1193             $ids[] = $f2p->file_id;
1194         }
1195
1196                 $files = File::multiGet('id', $ids);
1197                 $this->_attachments[$this->id] = $files->fetchAll();
1198         return $this->_attachments[$this->id];
1199     }
1200
1201         function _setAttachments($attachments)
1202         {
1203             $this->_attachments[$this->id] = $attachments;
1204         }
1205
1206     static function publicStream($offset=0, $limit=20, $since_id=null, $max_id=null)
1207     {
1208         $stream = new PublicNoticeStream();
1209         return $stream->getNotices($offset, $limit, $since_id, $max_id);
1210     }
1211
1212     static function conversationStream($id, $offset=0, $limit=20, $since_id=null, $max_id=null)
1213     {
1214         $stream = new ConversationNoticeStream($id);
1215         return $stream->getNotices($offset, $limit, $since_id, $max_id);
1216     }
1217
1218     /**
1219      * Is this notice part of an active conversation?
1220      *
1221      * @return boolean true if other messages exist in the same
1222      *                 conversation, false if this is the only one
1223      */
1224     function hasConversation()
1225     {
1226         if (empty($this->conversation)) {
1227             // this notice is not part of a conversation apparently
1228             // FIXME: all notices should have a conversation value, right?
1229             return false;
1230         }
1231
1232         $stream = new ConversationNoticeStream($this->conversation);
1233         $notices = $stream->getNotices(/*offset*/ 1, /*limit*/ 1);
1234
1235         // if our "offset 1, limit 1" query got a result, return true else false
1236         return $notice->N > 0;
1237     }
1238
1239     /**
1240      * Grab the earliest notice from this conversation.
1241      *
1242      * @return Notice or null
1243      */
1244     function conversationRoot($profile=-1)
1245     {
1246         // XXX: can this happen?
1247
1248         if (empty($this->conversation)) {
1249             return null;
1250         }
1251
1252         // Get the current profile if not specified
1253
1254         if (is_int($profile) && $profile == -1) {
1255             $profile = Profile::current();
1256         }
1257
1258         // If this notice is out of scope, no root for you!
1259
1260         if (!$this->inScope($profile)) {
1261             return null;
1262         }
1263
1264         // If this isn't a reply to anything, then it's its own
1265         // root if it's the earliest notice in the conversation:
1266
1267         if (empty($this->reply_to)) {
1268             $root = new Notice;
1269             $root->conversation = $this->conversation;
1270             $root->orderBy('notice.created ASC');
1271             $root->find(true);  // true means "fetch first result"
1272             $root->free();
1273             return $root;
1274         }
1275
1276         if (is_null($profile)) {
1277             $keypart = sprintf('notice:conversation_root:%d:null', $this->id);
1278         } else {
1279             $keypart = sprintf('notice:conversation_root:%d:%d',
1280                                $this->id,
1281                                $profile->id);
1282         }
1283
1284         $root = self::cacheGet($keypart);
1285
1286         if ($root !== false && $root->inScope($profile)) {
1287             return $root;
1288         }
1289
1290         $last = $this;
1291         while (true) {
1292             try {
1293                 $parent = $last->getParent();
1294                 if ($parent->inScope($profile)) {
1295                     $last = $parent;
1296                     continue;
1297                 }
1298             } catch (NoParentNoticeException $e) {
1299                 // Latest notice has no parent
1300             }
1301             // No parent, or parent out of scope
1302             $root = $last;
1303             break;
1304         }
1305
1306         self::cacheSet($keypart, $root);
1307
1308         return $root;
1309     }
1310
1311     /**
1312      * Pull up a full list of local recipients who will be getting
1313      * this notice in their inbox. Results will be cached, so don't
1314      * change the input data wily-nilly!
1315      *
1316      * @param array $groups optional list of Group objects;
1317      *              if left empty, will be loaded from group_inbox records
1318      * @param array $recipient optional list of reply profile ids
1319      *              if left empty, will be loaded from reply records
1320      * @return array associating recipient user IDs with an inbox source constant
1321      */
1322     function whoGets(array $groups=null, array $recipients=null)
1323     {
1324         $c = self::memcache();
1325
1326         if (!empty($c)) {
1327             $ni = $c->get(Cache::key('notice:who_gets:'.$this->id));
1328             if ($ni !== false) {
1329                 return $ni;
1330             }
1331         }
1332
1333         if (is_null($recipients)) {
1334             $recipients = $this->getReplies();
1335         }
1336
1337         $ni = array();
1338
1339         // Give plugins a chance to add folks in at start...
1340         if (Event::handle('StartNoticeWhoGets', array($this, &$ni))) {
1341
1342             $users = $this->getSubscribedUsers();
1343             foreach ($users as $id) {
1344                 $ni[$id] = NOTICE_INBOX_SOURCE_SUB;
1345             }
1346
1347             if (is_null($groups)) {
1348                 $groups = $this->getGroups();
1349             }
1350             foreach ($groups as $group) {
1351                 $users = $group->getUserMembers();
1352                 foreach ($users as $id) {
1353                     if (!array_key_exists($id, $ni)) {
1354                         $ni[$id] = NOTICE_INBOX_SOURCE_GROUP;
1355                     }
1356                 }
1357             }
1358
1359             $ptAtts = $this->getAttentionsFromProfileTags();
1360             foreach ($ptAtts as $key=>$val) {
1361                 if (!array_key_exists($key, $ni)) {
1362                     $ni[$key] = $val;
1363                 }
1364             }
1365
1366             foreach ($recipients as $recipient) {
1367                 if (!array_key_exists($recipient, $ni)) {
1368                     $ni[$recipient] = NOTICE_INBOX_SOURCE_REPLY;
1369                 }
1370             }
1371
1372             // Exclude any deleted, non-local, or blocking recipients.
1373             $profile = $this->getProfile();
1374             $originalProfile = null;
1375             if ($this->isRepeat()) {
1376                 // Check blocks against the original notice's poster as well.
1377                 $original = Notice::getKV('id', $this->repeat_of);
1378                 if ($original instanceof Notice) {
1379                     $originalProfile = $original->getProfile();
1380                 }
1381             }
1382
1383             foreach ($ni as $id => $source) {
1384                 try {
1385                     $user = User::getKV('id', $id);
1386                     if (!$user instanceof User ||
1387                         $user->hasBlocked($profile) ||
1388                         ($originalProfile && $user->hasBlocked($originalProfile))) {
1389                         unset($ni[$id]);
1390                     }
1391                 } catch (UserNoProfileException $e) {
1392                     // User doesn't have a profile; invalid; skip them.
1393                     unset($ni[$id]);
1394                 }
1395             }
1396
1397             // Give plugins a chance to filter out...
1398             Event::handle('EndNoticeWhoGets', array($this, &$ni));
1399         }
1400
1401         if (!empty($c)) {
1402             // XXX: pack this data better
1403             $c->set(Cache::key('notice:who_gets:'.$this->id), $ni);
1404         }
1405
1406         return $ni;
1407     }
1408
1409     function getSubscribedUsers()
1410     {
1411         $user = new User();
1412
1413         if(common_config('db','quote_identifiers'))
1414           $user_table = '"user"';
1415         else $user_table = 'user';
1416
1417         $qry =
1418           'SELECT id ' .
1419           'FROM '. $user_table .' JOIN subscription '.
1420           'ON '. $user_table .'.id = subscription.subscriber ' .
1421           'WHERE subscription.subscribed = %d ';
1422
1423         $user->query(sprintf($qry, $this->profile_id));
1424
1425         $ids = array();
1426
1427         while ($user->fetch()) {
1428             $ids[] = $user->id;
1429         }
1430
1431         $user->free();
1432
1433         return $ids;
1434     }
1435
1436     function getProfileTags()
1437     {
1438         $profile = $this->getProfile();
1439         $list    = $profile->getOtherTags($profile);
1440         $ptags   = array();
1441
1442         while($list->fetch()) {
1443             $ptags[] = clone($list);
1444         }
1445
1446         return $ptags;
1447     }
1448
1449     public function getAttentionsFromProfileTags()
1450     {
1451         $ni = array();
1452         $ptags = $this->getProfileTags();
1453         foreach ($ptags as $ptag) {
1454             $users = $ptag->getUserSubscribers();
1455             foreach ($users as $id) {
1456                 $ni[$id] = NOTICE_INBOX_SOURCE_PROFILE_TAG;
1457             }
1458         }
1459         return $ni;
1460     }
1461
1462     /**
1463      * Record this notice to the given group inboxes for delivery.
1464      * Overrides the regular parsing of !group markup.
1465      *
1466      * @param string $group_ids
1467      * @fixme might prefer URIs as identifiers, as for replies?
1468      *        best with generalizations on user_group to support
1469      *        remote groups better.
1470      */
1471     function saveKnownGroups($group_ids)
1472     {
1473         if (!is_array($group_ids)) {
1474             // TRANS: Server exception thrown when no array is provided to the method saveKnownGroups().
1475             throw new ServerException(_('Bad type provided to saveKnownGroups.'));
1476         }
1477
1478         $groups = array();
1479         foreach (array_unique($group_ids) as $id) {
1480             $group = User_group::getKV('id', $id);
1481             if ($group instanceof User_group) {
1482                 common_log(LOG_DEBUG, "Local delivery to group id $id, $group->nickname");
1483                 $result = $this->addToGroupInbox($group);
1484                 if (!$result) {
1485                     common_log_db_error($gi, 'INSERT', __FILE__);
1486                 }
1487
1488                 if (common_config('group', 'addtag')) {
1489                     // we automatically add a tag for every group name, too
1490
1491                     $tag = Notice_tag::pkeyGet(array('tag' => common_canonical_tag($group->nickname),
1492                                                      'notice_id' => $this->id));
1493
1494                     if (is_null($tag)) {
1495                         $this->saveTag($group->nickname);
1496                     }
1497                 }
1498
1499                 $groups[] = clone($group);
1500             } else {
1501                 common_log(LOG_ERR, "Local delivery to group id $id skipped, doesn't exist");
1502             }
1503         }
1504
1505         return $groups;
1506     }
1507
1508     function addToGroupInbox(User_group $group)
1509     {
1510         $gi = Group_inbox::pkeyGet(array('group_id' => $group->id,
1511                                          'notice_id' => $this->id));
1512
1513         if (!$gi instanceof Group_inbox) {
1514
1515             $gi = new Group_inbox();
1516
1517             $gi->group_id  = $group->id;
1518             $gi->notice_id = $this->id;
1519             $gi->created   = $this->created;
1520
1521             $result = $gi->insert();
1522
1523             if (!$result) {
1524                 common_log_db_error($gi, 'INSERT', __FILE__);
1525                 // TRANS: Server exception thrown when an update for a group inbox fails.
1526                 throw new ServerException(_('Problem saving group inbox.'));
1527             }
1528
1529             self::blow('user_group:notice_ids:%d', $gi->group_id);
1530         }
1531
1532         return true;
1533     }
1534
1535     /**
1536      * Save reply records indicating that this notice needs to be
1537      * delivered to the local users with the given URIs.
1538      *
1539      * Since this is expected to be used when saving foreign-sourced
1540      * messages, we won't deliver to any remote targets as that's the
1541      * source service's responsibility.
1542      *
1543      * Mail notifications etc will be handled later.
1544      *
1545      * @param array  $uris   Array of unique identifier URIs for recipients
1546      */
1547     function saveKnownReplies(array $uris)
1548     {
1549         if (empty($uris)) {
1550             return;
1551         }
1552
1553         $sender = Profile::getKV($this->profile_id);
1554
1555         foreach (array_unique($uris) as $uri) {
1556             try {
1557                 $profile = Profile::fromUri($uri);
1558             } catch (UnknownUriException $e) {
1559                 common_log(LOG_WARNING, "Unable to determine profile for URI '$uri'");
1560                 continue;
1561             }
1562
1563             if ($profile->hasBlocked($sender)) {
1564                 common_log(LOG_INFO, "Not saving reply to profile {$profile->id} ($uri) from sender {$sender->id} because of a block.");
1565                 continue;
1566             }
1567
1568             $this->saveReply($profile->id);
1569             self::blow('reply:stream:%d', $profile->id);
1570         }
1571
1572         return;
1573     }
1574
1575     /**
1576      * Pull @-replies from this message's content in StatusNet markup format
1577      * and save reply records indicating that this message needs to be
1578      * delivered to those users.
1579      *
1580      * Mail notifications to local profiles will be sent later.
1581      *
1582      * @return array of integer profile IDs
1583      */
1584
1585     function saveReplies()
1586     {
1587         // Don't save reply data for repeats
1588
1589         if ($this->isRepeat()) {
1590             return array();
1591         }
1592
1593         $sender = $this->getProfile();
1594
1595         $replied = array();
1596
1597         // If it's a reply, save for the replied-to author
1598         try {
1599             $parent = $this->getParent();
1600             $parentauthor = $parent->getProfile();
1601             $this->saveReply($parentauthor->id);
1602             $replied[$parentauthor->id] = 1;
1603             self::blow('reply:stream:%d', $parentauthor->id);
1604         } catch (NoParentNoticeException $e) {
1605             // Not a reply, since it has no parent!
1606         }
1607
1608         // @todo ideally this parser information would only
1609         // be calculated once.
1610
1611         $mentions = common_find_mentions($this->content, $this);
1612
1613         // store replied only for first @ (what user/notice what the reply directed,
1614         // we assume first @ is it)
1615
1616         foreach ($mentions as $mention) {
1617
1618             foreach ($mention['mentioned'] as $mentioned) {
1619
1620                 // skip if they're already covered
1621                 if (array_key_exists($mentioned->id, $replied)) {
1622                     continue;
1623                 }
1624
1625                 // Don't save replies from blocked profile to local user
1626
1627                 $mentioned_user = User::getKV('id', $mentioned->id);
1628                 if ($mentioned_user instanceof User && $mentioned_user->hasBlocked($sender)) {
1629                     continue;
1630                 }
1631
1632                 $this->saveReply($mentioned->id);
1633                 $replied[$mentioned->id] = 1;
1634                 self::blow('reply:stream:%d', $mentioned->id);
1635             }
1636         }
1637
1638         $recipientIds = array_keys($replied);
1639
1640         return $recipientIds;
1641     }
1642
1643     function saveReply($profileId)
1644     {
1645         $reply = new Reply();
1646
1647         $reply->notice_id  = $this->id;
1648         $reply->profile_id = $profileId;
1649         $reply->modified   = $this->created;
1650
1651         $reply->insert();
1652
1653         return $reply;
1654     }
1655
1656     protected $_replies = array();
1657
1658     /**
1659      * Pull the complete list of @-reply targets for this notice.
1660      *
1661      * @return array of integer profile ids
1662      */
1663     function getReplies()
1664     {
1665         if (isset($this->_replies[$this->id])) {
1666             return $this->_replies[$this->id];
1667         }
1668
1669         $replyMap = Reply::listGet('notice_id', array($this->id));
1670
1671         $ids = array();
1672
1673         foreach ($replyMap[$this->id] as $reply) {
1674             $ids[] = $reply->profile_id;
1675         }
1676
1677         $this->_replies[$this->id] = $ids;
1678
1679         return $ids;
1680     }
1681
1682     function _setReplies($replies)
1683     {
1684         $this->_replies[$this->id] = $replies;
1685     }
1686
1687     /**
1688      * Pull the complete list of @-reply targets for this notice.
1689      *
1690      * @return array of Profiles
1691      */
1692     function getReplyProfiles()
1693     {
1694         $ids = $this->getReplies();
1695
1696         $profiles = Profile::multiGet('id', $ids);
1697
1698         return $profiles->fetchAll();
1699     }
1700
1701     /**
1702      * Send e-mail notifications to local @-reply targets.
1703      *
1704      * Replies must already have been saved; this is expected to be run
1705      * from the distrib queue handler.
1706      */
1707     function sendReplyNotifications()
1708     {
1709         // Don't send reply notifications for repeats
1710
1711         if ($this->isRepeat()) {
1712             return array();
1713         }
1714
1715         $recipientIds = $this->getReplies();
1716         if (Event::handle('StartNotifyMentioned', array($this, &$recipientIds))) {
1717             require_once INSTALLDIR.'/lib/mail.php';
1718
1719             foreach ($recipientIds as $recipientId) {
1720                 $user = User::getKV('id', $recipientId);
1721                 if ($user instanceof User) {
1722                     mail_notify_attn($user, $this);
1723                 }
1724             }
1725             Event::handle('EndNotifyMentioned', array($this, $recipientIds));
1726         }
1727     }
1728
1729     /**
1730      * Pull list of groups this notice needs to be delivered to,
1731      * as previously recorded by saveKnownGroups().
1732      *
1733      * @return array of Group objects
1734      */
1735
1736     protected $_groups = array();
1737
1738     function getGroups()
1739     {
1740         // Don't save groups for repeats
1741
1742         if (!empty($this->repeat_of)) {
1743             return array();
1744         }
1745
1746         if (isset($this->_groups[$this->id])) {
1747             return $this->_groups[$this->id];
1748         }
1749
1750         $gis = Group_inbox::listGet('notice_id', array($this->id));
1751
1752         $ids = array();
1753
1754                 foreach ($gis[$this->id] as $gi) {
1755                     $ids[] = $gi->group_id;
1756                 }
1757
1758                 $groups = User_group::multiGet('id', $ids);
1759                 $this->_groups[$this->id] = $groups->fetchAll();
1760                 return $this->_groups[$this->id];
1761     }
1762
1763     function _setGroups($groups)
1764     {
1765         $this->_groups[$this->id] = $groups;
1766     }
1767
1768     /**
1769      * Convert a notice into an activity for export.
1770      *
1771      * @param Profile $scoped   The currently logged in/scoped profile
1772      *
1773      * @return Activity activity object representing this Notice.
1774      */
1775
1776     function asActivity(Profile $scoped=null)
1777     {
1778         $act = self::cacheGet(Cache::codeKey('notice:as-activity:'.$this->id));
1779
1780         if ($act instanceof Activity) {
1781             return $act;
1782         }
1783         $act = new Activity();
1784
1785         if (Event::handle('StartNoticeAsActivity', array($this, $act, $scoped))) {
1786
1787             $act->id      = $this->uri;
1788             $act->time    = strtotime($this->created);
1789             try {
1790                 $act->link    = $this->getUrl();
1791             } catch (InvalidUrlException $e) {
1792                 // The notice is probably a share or similar, which don't
1793                 // have a representational URL of their own.
1794             }
1795             $act->content = common_xml_safe_str($this->rendered);
1796
1797             $profile = $this->getProfile();
1798
1799             $act->actor            = $profile->asActivityObject();
1800             $act->actor->extra[]   = $profile->profileInfo($scoped);
1801
1802             $act->verb = $this->verb;
1803
1804             if (!$this->repeat_of) {
1805                 $act->objects[] = $this->asActivityObject();
1806             }
1807
1808             // XXX: should this be handled by default processing for object entry?
1809
1810             // Categories
1811
1812             $tags = $this->getTags();
1813
1814             foreach ($tags as $tag) {
1815                 $cat       = new AtomCategory();
1816                 $cat->term = $tag;
1817
1818                 $act->categories[] = $cat;
1819             }
1820
1821             // Enclosures
1822             // XXX: use Atom Media and/or File activity objects instead
1823
1824             $attachments = $this->attachments();
1825
1826             foreach ($attachments as $attachment) {
1827                 // Include local attachments in Activity
1828                 if (!empty($attachment->filename)) {
1829                     $act->enclosures[] = $attachment->getEnclosure();
1830                 }
1831             }
1832
1833             $ctx = new ActivityContext();
1834
1835             try {
1836                 $reply = $this->getParent();
1837                 $ctx->replyToID  = $reply->getUri();
1838                 $ctx->replyToUrl = $reply->getUrl(true);    // true for fallback to local URL, less messy
1839             } catch (NoParentNoticeException $e) {
1840                 // This is not a reply to something
1841             }
1842
1843             $ctx->location = $this->getLocation();
1844
1845             $conv = null;
1846
1847             if (!empty($this->conversation)) {
1848                 $conv = Conversation::getKV('id', $this->conversation);
1849                 if ($conv instanceof Conversation) {
1850                     $ctx->conversation = $conv->uri;
1851                 }
1852             }
1853
1854             $reply_ids = $this->getReplies();
1855
1856             foreach ($reply_ids as $id) {
1857                 $rprofile = Profile::getKV('id', $id);
1858                 if ($rprofile instanceof Profile) {
1859                     $ctx->attention[$rprofile->getUri()] = ActivityObject::PERSON;
1860                 }
1861             }
1862
1863             $groups = $this->getGroups();
1864
1865             foreach ($groups as $group) {
1866                 $ctx->attention[$group->getUri()] = ActivityObject::GROUP;
1867             }
1868
1869             switch ($this->scope) {
1870             case Notice::PUBLIC_SCOPE:
1871                 $ctx->attention[ActivityContext::ATTN_PUBLIC] = ActivityObject::COLLECTION;
1872                 break;
1873             case Notice::FOLLOWER_SCOPE:
1874                 $surl = common_local_url("subscribers", array('nickname' => $profile->nickname));
1875                 $ctx->attention[$surl] = ActivityObject::COLLECTION;
1876                 break;
1877             }
1878
1879             $act->context = $ctx;
1880
1881             $source = $this->getSource();
1882
1883             if ($source instanceof Notice_source) {
1884                 $act->generator = ActivityObject::fromNoticeSource($source);
1885             }
1886
1887             // Source
1888
1889             $atom_feed = $profile->getAtomFeed();
1890
1891             if (!empty($atom_feed)) {
1892
1893                 $act->source = new ActivitySource();
1894
1895                 // XXX: we should store the actual feed ID
1896
1897                 $act->source->id = $atom_feed;
1898
1899                 // XXX: we should store the actual feed title
1900
1901                 $act->source->title = $profile->getBestName();
1902
1903                 $act->source->links['alternate'] = $profile->profileurl;
1904                 $act->source->links['self']      = $atom_feed;
1905
1906                 $act->source->icon = $profile->avatarUrl(AVATAR_PROFILE_SIZE);
1907
1908                 $notice = $profile->getCurrentNotice();
1909
1910                 if ($notice instanceof Notice) {
1911                     $act->source->updated = self::utcDate($notice->created);
1912                 }
1913
1914                 $user = User::getKV('id', $profile->id);
1915
1916                 if ($user instanceof User) {
1917                     $act->source->links['license'] = common_config('license', 'url');
1918                 }
1919             }
1920
1921             if ($this->isLocal()) {
1922                 $act->selfLink = common_local_url('ApiStatusesShow', array('id' => $this->id,
1923                                                                            'format' => 'atom'));
1924                 $act->editLink = $act->selfLink;
1925             }
1926
1927             Event::handle('EndNoticeAsActivity', array($this, $act, $scoped));
1928         }
1929
1930         self::cacheSet(Cache::codeKey('notice:as-activity:'.$this->id), $act);
1931
1932         return $act;
1933     }
1934
1935     // This has gotten way too long. Needs to be sliced up into functional bits
1936     // or ideally exported to a utility class.
1937
1938     function asAtomEntry($namespace=false,
1939                          $source=false,
1940                          $author=true,
1941                          Profile $scoped=null)
1942     {
1943         $act = $this->asActivity($scoped);
1944         $act->extra[] = $this->noticeInfo($scoped);
1945         return $act->asString($namespace, $author, $source);
1946     }
1947
1948     /**
1949      * Extra notice info for atom entries
1950      *
1951      * Clients use some extra notice info in the atom stream.
1952      * This gives it to them.
1953      *
1954      * @param Profile $scoped   The currently logged in/scoped profile
1955      *
1956      * @return array representation of <statusnet:notice_info> element
1957      */
1958
1959     function noticeInfo(Profile $scoped=null)
1960     {
1961         // local notice ID (useful to clients for ordering)
1962
1963         $noticeInfoAttr = array('local_id' => $this->id);
1964
1965         // notice source
1966
1967         $ns = $this->getSource();
1968
1969         if ($ns instanceof Notice_source) {
1970             $noticeInfoAttr['source'] =  $ns->code;
1971             if (!empty($ns->url)) {
1972                 $noticeInfoAttr['source_link'] = $ns->url;
1973                 if (!empty($ns->name)) {
1974                     $noticeInfoAttr['source'] =  '<a href="'
1975                         . htmlspecialchars($ns->url)
1976                         . '" rel="nofollow">'
1977                         . htmlspecialchars($ns->name)
1978                         . '</a>';
1979                 }
1980             }
1981         }
1982
1983         // favorite and repeated
1984
1985         if ($scoped instanceof Profile) {
1986             $noticeInfoAttr['repeated'] = ($scoped->hasRepeated($this)) ? "true" : "false";
1987         }
1988
1989         if (!empty($this->repeat_of)) {
1990             $noticeInfoAttr['repeat_of'] = $this->repeat_of;
1991         }
1992
1993         Event::handle('StatusNetApiNoticeInfo', array($this, &$noticeInfoAttr, $scoped));
1994
1995         return array('statusnet:notice_info', $noticeInfoAttr, null);
1996     }
1997
1998     /**
1999      * Returns an XML string fragment with a reference to a notice as an
2000      * Activity Streams noun object with the given element type.
2001      *
2002      * Assumes that 'activity' namespace has been previously defined.
2003      *
2004      * @param string $element one of 'subject', 'object', 'target'
2005      * @return string
2006      */
2007
2008     function asActivityNoun($element)
2009     {
2010         $noun = $this->asActivityObject();
2011         return $noun->asString('activity:' . $element);
2012     }
2013
2014     public function asActivityObject()
2015     {
2016         $object = new ActivityObject();
2017
2018         if (Event::handle('StartActivityObjectFromNotice', array($this, &$object))) {
2019             $object->type    = $this->object_type ?: ActivityObject::NOTE;
2020             $object->id      = $this->getUri();
2021             $object->title   = sprintf('New %1$s by %2$s', ActivityObject::canonicalType($object->type), $this->getProfile()->getNickname());
2022             $object->content = $this->rendered;
2023             $object->link    = $this->getUrl();
2024
2025             $object->extra[] = array('status_net', array('notice_id' => $this->id));
2026
2027             Event::handle('EndActivityObjectFromNotice', array($this, &$object));
2028         }
2029
2030         return $object;
2031     }
2032
2033     /**
2034      * Determine which notice, if any, a new notice is in reply to.
2035      *
2036      * For conversation tracking, we try to see where this notice fits
2037      * in the tree. Beware that this may very well give false positives
2038      * and add replies to wrong threads (if there have been newer posts
2039      * by the same user as we're replying to).
2040      *
2041      * @param Profile $sender     Author profile
2042      * @param string  $content    Final notice content
2043      *
2044      * @return integer ID of replied-to notice, or null for not a reply.
2045      */
2046
2047     static function getInlineReplyTo(Profile $sender, $content)
2048     {
2049         // Is there an initial @ or T?
2050         if (preg_match('/^T ([A-Z0-9]{1,64}) /', $content, $match)
2051                 || preg_match('/^@([a-z0-9]{1,64})\s+/', $content, $match)) {
2052             $nickname = common_canonical_nickname($match[1]);
2053         } else {
2054             return null;
2055         }
2056
2057         // Figure out who that is.
2058         $recipient = common_relative_profile($sender, $nickname, common_sql_now());
2059
2060         if ($recipient instanceof Profile) {
2061             // Get their last notice
2062             $last = $recipient->getCurrentNotice();
2063             if ($last instanceof Notice) {
2064                 return $last;
2065             }
2066             // Maybe in the future we want to handle something else below
2067             // so don't return getCurrentNotice() immediately.
2068         }
2069
2070         return null;
2071     }
2072
2073     static function maxContent()
2074     {
2075         $contentlimit = common_config('notice', 'contentlimit');
2076         // null => use global limit (distinct from 0!)
2077         if (is_null($contentlimit)) {
2078             $contentlimit = common_config('site', 'textlimit');
2079         }
2080         return $contentlimit;
2081     }
2082
2083     static function contentTooLong($content)
2084     {
2085         $contentlimit = self::maxContent();
2086         return ($contentlimit > 0 && !empty($content) && (mb_strlen($content) > $contentlimit));
2087     }
2088
2089     function getLocation()
2090     {
2091         $location = null;
2092
2093         if (!empty($this->location_id) && !empty($this->location_ns)) {
2094             $location = Location::fromId($this->location_id, $this->location_ns);
2095         }
2096
2097         if (is_null($location)) { // no ID, or Location::fromId() failed
2098             if (!empty($this->lat) && !empty($this->lon)) {
2099                 $location = Location::fromLatLon($this->lat, $this->lon);
2100             }
2101         }
2102
2103         return $location;
2104     }
2105
2106     /**
2107      * Convenience function for posting a repeat of an existing message.
2108      *
2109      * @param Profile $repeater Profile which is doing the repeat
2110      * @param string $source: posting source key, eg 'web', 'api', etc
2111      * @return Notice
2112      *
2113      * @throws Exception on failure or permission problems
2114      */
2115     function repeat(Profile $repeater, $source)
2116     {
2117         $author = $this->getProfile();
2118
2119         // TRANS: Message used to repeat a notice. RT is the abbreviation of 'retweet'.
2120         // TRANS: %1$s is the repeated user's name, %2$s is the repeated notice.
2121         $content = sprintf(_('RT @%1$s %2$s'),
2122                            $author->getNickname(),
2123                            $this->content);
2124
2125         $maxlen = self::maxContent();
2126         if ($maxlen > 0 && mb_strlen($content) > $maxlen) {
2127             // Web interface and current Twitter API clients will
2128             // pull the original notice's text, but some older
2129             // clients and RSS/Atom feeds will see this trimmed text.
2130             //
2131             // Unfortunately this is likely to lose tags or URLs
2132             // at the end of long notices.
2133             $content = mb_substr($content, 0, $maxlen - 4) . ' ...';
2134         }
2135
2136
2137         // Scope is same as this one's
2138         return self::saveNew($repeater->id,
2139                              $content,
2140                              $source,
2141                              array('repeat_of' => $this->id,
2142                                    'scope' => $this->scope));
2143     }
2144
2145     // These are supposed to be in chron order!
2146
2147     function repeatStream($limit=100)
2148     {
2149         $cache = Cache::instance();
2150
2151         if (empty($cache)) {
2152             $ids = $this->_repeatStreamDirect($limit);
2153         } else {
2154             $idstr = $cache->get(Cache::key('notice:repeats:'.$this->id));
2155             if ($idstr !== false) {
2156                 if (empty($idstr)) {
2157                         $ids = array();
2158                 } else {
2159                         $ids = explode(',', $idstr);
2160                 }
2161             } else {
2162                 $ids = $this->_repeatStreamDirect(100);
2163                 $cache->set(Cache::key('notice:repeats:'.$this->id), implode(',', $ids));
2164             }
2165             if ($limit < 100) {
2166                 // We do a max of 100, so slice down to limit
2167                 $ids = array_slice($ids, 0, $limit);
2168             }
2169         }
2170
2171         return NoticeStream::getStreamByIds($ids);
2172     }
2173
2174     function _repeatStreamDirect($limit)
2175     {
2176         $notice = new Notice();
2177
2178         $notice->selectAdd(); // clears it
2179         $notice->selectAdd('id');
2180
2181         $notice->repeat_of = $this->id;
2182
2183         $notice->orderBy('created, id'); // NB: asc!
2184
2185         if (!is_null($limit)) {
2186             $notice->limit(0, $limit);
2187         }
2188
2189         return $notice->fetchAll('id');
2190     }
2191
2192     static function locationOptions($lat, $lon, $location_id, $location_ns, $profile = null)
2193     {
2194         $options = array();
2195
2196         if (!empty($location_id) && !empty($location_ns)) {
2197             $options['location_id'] = $location_id;
2198             $options['location_ns'] = $location_ns;
2199
2200             $location = Location::fromId($location_id, $location_ns);
2201
2202             if ($location instanceof Location) {
2203                 $options['lat'] = $location->lat;
2204                 $options['lon'] = $location->lon;
2205             }
2206
2207         } else if (!empty($lat) && !empty($lon)) {
2208             $options['lat'] = $lat;
2209             $options['lon'] = $lon;
2210
2211             $location = Location::fromLatLon($lat, $lon);
2212
2213             if ($location instanceof Location) {
2214                 $options['location_id'] = $location->location_id;
2215                 $options['location_ns'] = $location->location_ns;
2216             }
2217         } else if (!empty($profile)) {
2218             if (isset($profile->lat) && isset($profile->lon)) {
2219                 $options['lat'] = $profile->lat;
2220                 $options['lon'] = $profile->lon;
2221             }
2222
2223             if (isset($profile->location_id) && isset($profile->location_ns)) {
2224                 $options['location_id'] = $profile->location_id;
2225                 $options['location_ns'] = $profile->location_ns;
2226             }
2227         }
2228
2229         return $options;
2230     }
2231
2232     function clearAttentions()
2233     {
2234         $att = new Attention();
2235         $att->notice_id = $this->getID();
2236
2237         if ($att->find()) {
2238             while ($att->fetch()) {
2239                 // Can't do delete() on the object directly since it won't remove all of it
2240                 $other = clone($att);
2241                 $other->delete();
2242             }
2243         }
2244     }
2245
2246     function clearReplies()
2247     {
2248         $replyNotice = new Notice();
2249         $replyNotice->reply_to = $this->id;
2250
2251         //Null any notices that are replies to this notice
2252
2253         if ($replyNotice->find()) {
2254             while ($replyNotice->fetch()) {
2255                 $orig = clone($replyNotice);
2256                 $replyNotice->reply_to = null;
2257                 $replyNotice->update($orig);
2258             }
2259         }
2260
2261         // Reply records
2262
2263         $reply = new Reply();
2264         $reply->notice_id = $this->id;
2265
2266         if ($reply->find()) {
2267             while($reply->fetch()) {
2268                 self::blow('reply:stream:%d', $reply->profile_id);
2269                 $reply->delete();
2270             }
2271         }
2272
2273         $reply->free();
2274     }
2275
2276     function clearFiles()
2277     {
2278         $f2p = new File_to_post();
2279
2280         $f2p->post_id = $this->id;
2281
2282         if ($f2p->find()) {
2283             while ($f2p->fetch()) {
2284                 $f2p->delete();
2285             }
2286         }
2287         // FIXME: decide whether to delete File objects
2288         // ...and related (actual) files
2289     }
2290
2291     function clearRepeats()
2292     {
2293         $repeatNotice = new Notice();
2294         $repeatNotice->repeat_of = $this->id;
2295
2296         //Null any notices that are repeats of this notice
2297
2298         if ($repeatNotice->find()) {
2299             while ($repeatNotice->fetch()) {
2300                 $orig = clone($repeatNotice);
2301                 $repeatNotice->repeat_of = null;
2302                 $repeatNotice->update($orig);
2303             }
2304         }
2305     }
2306
2307     function clearTags()
2308     {
2309         $tag = new Notice_tag();
2310         $tag->notice_id = $this->id;
2311
2312         if ($tag->find()) {
2313             while ($tag->fetch()) {
2314                 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, Cache::keyize($tag->tag));
2315                 self::blow('profile:notice_ids_tagged:%d:%s;last', $this->profile_id, Cache::keyize($tag->tag));
2316                 self::blow('notice_tag:notice_ids:%s', Cache::keyize($tag->tag));
2317                 self::blow('notice_tag:notice_ids:%s;last', Cache::keyize($tag->tag));
2318                 $tag->delete();
2319             }
2320         }
2321
2322         $tag->free();
2323     }
2324
2325     function clearGroupInboxes()
2326     {
2327         $gi = new Group_inbox();
2328
2329         $gi->notice_id = $this->id;
2330
2331         if ($gi->find()) {
2332             while ($gi->fetch()) {
2333                 self::blow('user_group:notice_ids:%d', $gi->group_id);
2334                 $gi->delete();
2335             }
2336         }
2337
2338         $gi->free();
2339     }
2340
2341     function distribute()
2342     {
2343         // We always insert for the author so they don't
2344         // have to wait
2345         Event::handle('StartNoticeDistribute', array($this));
2346
2347         // If there's a failure, we want to _force_
2348         // distribution at this point.
2349         try {
2350             $qm = QueueManager::get();
2351             $qm->enqueue($this, 'distrib');
2352         } catch (Exception $e) {
2353             // If the exception isn't transient, this
2354             // may throw more exceptions as DQH does
2355             // its own enqueueing. So, we ignore them!
2356             try {
2357                 $handler = new DistribQueueHandler();
2358                 $handler->handle($this);
2359             } catch (Exception $e) {
2360                 common_log(LOG_ERR, "emergency redistribution resulted in " . $e->getMessage());
2361             }
2362             // Re-throw so somebody smarter can handle it.
2363             throw $e;
2364         }
2365     }
2366
2367     function insert()
2368     {
2369         $result = parent::insert();
2370
2371         if ($result === false) {
2372             common_log_db_error($this, 'INSERT', __FILE__);
2373             // TRANS: Server exception thrown when a stored object entry cannot be saved.
2374             throw new ServerException('Could not save Notice');
2375         }
2376
2377         // Profile::hasRepeated() abuses pkeyGet(), so we
2378         // have to clear manually
2379         if (!empty($this->repeat_of)) {
2380             $c = self::memcache();
2381             if (!empty($c)) {
2382                 $ck = self::multicacheKey('Notice',
2383                                           array('profile_id' => $this->profile_id,
2384                                                 'repeat_of' => $this->repeat_of));
2385                 $c->delete($ck);
2386             }
2387         }
2388
2389         // Update possibly ID-dependent columns: URI, conversation
2390         // (now that INSERT has added the notice's local id)
2391         $orig = clone($this);
2392         $changed = false;
2393
2394         // We can only get here if it's a local notice, since remote notices
2395         // should've bailed out earlier due to lacking a URI.
2396         if (empty($this->uri)) {
2397             $this->uri = sprintf('%s%s=%d:%s=%s',
2398                                 TagURI::mint(),
2399                                 'noticeId', $this->id,
2400                                 'objectType', $this->get_object_type(true));
2401             $changed = true;
2402         }
2403
2404         if ($changed && $this->update($orig) === false) {
2405             common_log_db_error($notice, 'UPDATE', __FILE__);
2406             // TRANS: Server exception thrown when a notice cannot be updated.
2407             throw new ServerException(_('Problem saving notice.'));
2408         }
2409
2410         $this->blowOnInsert();
2411
2412         return $result;
2413     }
2414
2415     /**
2416      * Get the source of the notice
2417      *
2418      * @return Notice_source $ns A notice source object. 'code' is the only attribute
2419      *                           guaranteed to be populated.
2420      */
2421     function getSource()
2422     {
2423         if (empty($this->source)) {
2424             return false;
2425         }
2426
2427         $ns = new Notice_source();
2428         switch ($this->source) {
2429         case 'web':
2430         case 'xmpp':
2431         case 'mail':
2432         case 'omb':
2433         case 'system':
2434         case 'api':
2435             $ns->code = $this->source;
2436             break;
2437         default:
2438             $ns = Notice_source::getKV($this->source);
2439             if (!$ns) {
2440                 $ns = new Notice_source();
2441                 $ns->code = $this->source;
2442                 $app = Oauth_application::getKV('name', $this->source);
2443                 if ($app) {
2444                     $ns->name = $app->name;
2445                     $ns->url  = $app->source_url;
2446                 }
2447             }
2448             break;
2449         }
2450
2451         return $ns;
2452     }
2453
2454     /**
2455      * Determine whether the notice was locally created
2456      *
2457      * @return boolean locality
2458      */
2459
2460     public function isLocal()
2461     {
2462         return ($this->is_local == Notice::LOCAL_PUBLIC ||
2463                 $this->is_local == Notice::LOCAL_NONPUBLIC);
2464     }
2465
2466     public function isRepeat()
2467     {
2468         return !empty($this->repeat_of);
2469     }
2470
2471     /**
2472      * Get the list of hash tags saved with this notice.
2473      *
2474      * @return array of strings
2475      */
2476     public function getTags()
2477     {
2478         $tags = array();
2479
2480         $keypart = sprintf('notice:tags:%d', $this->id);
2481
2482         $tagstr = self::cacheGet($keypart);
2483
2484         if ($tagstr !== false) {
2485             $tags = explode(',', $tagstr);
2486         } else {
2487             $tag = new Notice_tag();
2488             $tag->notice_id = $this->id;
2489             if ($tag->find()) {
2490                 while ($tag->fetch()) {
2491                     $tags[] = $tag->tag;
2492                 }
2493             }
2494             self::cacheSet($keypart, implode(',', $tags));
2495         }
2496
2497         return $tags;
2498     }
2499
2500     static private function utcDate($dt)
2501     {
2502         $dateStr = date('d F Y H:i:s', strtotime($dt));
2503         $d = new DateTime($dateStr, new DateTimeZone('UTC'));
2504         return $d->format(DATE_W3C);
2505     }
2506
2507     /**
2508      * Look up the creation timestamp for a given notice ID, even
2509      * if it's been deleted.
2510      *
2511      * @param int $id
2512      * @return mixed string recorded creation timestamp, or false if can't be found
2513      */
2514     public static function getAsTimestamp($id)
2515     {
2516         if (!$id) {
2517             return false;
2518         }
2519
2520         $notice = Notice::getKV('id', $id);
2521         if ($notice) {
2522             return $notice->created;
2523         }
2524
2525         $deleted = Deleted_notice::getKV('id', $id);
2526         if ($deleted) {
2527             return $deleted->created;
2528         }
2529
2530         return false;
2531     }
2532
2533     /**
2534      * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2535      * parameter, matching notices posted after the given one (exclusive).
2536      *
2537      * If the referenced notice can't be found, will return false.
2538      *
2539      * @param int $id
2540      * @param string $idField
2541      * @param string $createdField
2542      * @return mixed string or false if no match
2543      */
2544     public static function whereSinceId($id, $idField='id', $createdField='created')
2545     {
2546         $since = Notice::getAsTimestamp($id);
2547         if ($since) {
2548             return sprintf("($createdField = '%s' and $idField > %d) or ($createdField > '%s')", $since, $id, $since);
2549         }
2550         return false;
2551     }
2552
2553     /**
2554      * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2555      * parameter, matching notices posted after the given one (exclusive), and
2556      * if necessary add it to the data object's query.
2557      *
2558      * @param DB_DataObject $obj
2559      * @param int $id
2560      * @param string $idField
2561      * @param string $createdField
2562      * @return mixed string or false if no match
2563      */
2564     public static function addWhereSinceId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2565     {
2566         $since = self::whereSinceId($id, $idField, $createdField);
2567         if ($since) {
2568             $obj->whereAdd($since);
2569         }
2570     }
2571
2572     /**
2573      * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2574      * parameter, matching notices posted before the given one (inclusive).
2575      *
2576      * If the referenced notice can't be found, will return false.
2577      *
2578      * @param int $id
2579      * @param string $idField
2580      * @param string $createdField
2581      * @return mixed string or false if no match
2582      */
2583     public static function whereMaxId($id, $idField='id', $createdField='created')
2584     {
2585         $max = Notice::getAsTimestamp($id);
2586         if ($max) {
2587             return sprintf("($createdField < '%s') or ($createdField = '%s' and $idField <= %d)", $max, $max, $id);
2588         }
2589         return false;
2590     }
2591
2592     /**
2593      * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2594      * parameter, matching notices posted before the given one (inclusive), and
2595      * if necessary add it to the data object's query.
2596      *
2597      * @param DB_DataObject $obj
2598      * @param int $id
2599      * @param string $idField
2600      * @param string $createdField
2601      * @return mixed string or false if no match
2602      */
2603     public static function addWhereMaxId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2604     {
2605         $max = self::whereMaxId($id, $idField, $createdField);
2606         if ($max) {
2607             $obj->whereAdd($max);
2608         }
2609     }
2610
2611     function isPublic()
2612     {
2613         return (($this->is_local != Notice::LOCAL_NONPUBLIC) &&
2614                 ($this->is_local != Notice::GATEWAY));
2615     }
2616
2617     /**
2618      * Check that the given profile is allowed to read, respond to, or otherwise
2619      * act on this notice.
2620      *
2621      * The $scope member is a bitmask of scopes, representing a logical AND of the
2622      * scope requirement. So, 0x03 (Notice::ADDRESSEE_SCOPE | Notice::SITE_SCOPE) means
2623      * "only visible to people who are mentioned in the notice AND are users on this site."
2624      * Users on the site who are not mentioned in the notice will not be able to see the
2625      * notice.
2626      *
2627      * @param Profile $profile The profile to check; pass null to check for public/unauthenticated users.
2628      *
2629      * @return boolean whether the profile is in the notice's scope
2630      */
2631     function inScope($profile)
2632     {
2633         if (is_null($profile)) {
2634             $keypart = sprintf('notice:in-scope-for:%d:null', $this->id);
2635         } else {
2636             $keypart = sprintf('notice:in-scope-for:%d:%d', $this->id, $profile->id);
2637         }
2638
2639         $result = self::cacheGet($keypart);
2640
2641         if ($result === false) {
2642             $bResult = false;
2643             if (Event::handle('StartNoticeInScope', array($this, $profile, &$bResult))) {
2644                 $bResult = $this->_inScope($profile);
2645                 Event::handle('EndNoticeInScope', array($this, $profile, &$bResult));
2646             }
2647             $result = ($bResult) ? 1 : 0;
2648             self::cacheSet($keypart, $result, 0, 300);
2649         }
2650
2651         return ($result == 1) ? true : false;
2652     }
2653
2654     protected function _inScope($profile)
2655     {
2656         if (!is_null($this->scope)) {
2657             $scope = $this->scope;
2658         } else {
2659             $scope = self::defaultScope();
2660         }
2661
2662         if ($scope == 0 && !$this->getProfile()->isPrivateStream()) { // Not scoping, so it is public.
2663             return !$this->isHiddenSpam($profile);
2664         }
2665
2666         // If there's scope, anon cannot be in scope
2667         if (empty($profile)) {
2668             return false;
2669         }
2670
2671         // Author is always in scope
2672         if ($this->profile_id == $profile->id) {
2673             return true;
2674         }
2675
2676         // Only for users on this site
2677         if (($scope & Notice::SITE_SCOPE) && !$profile->isLocal()) {
2678             return false;
2679         }
2680
2681         // Only for users mentioned in the notice
2682         if ($scope & Notice::ADDRESSEE_SCOPE) {
2683
2684             $reply = Reply::pkeyGet(array('notice_id' => $this->id,
2685                                          'profile_id' => $profile->id));
2686
2687             if (!$reply instanceof Reply) {
2688                 return false;
2689             }
2690         }
2691
2692         // Only for members of the given group
2693         if ($scope & Notice::GROUP_SCOPE) {
2694
2695             // XXX: just query for the single membership
2696
2697             $groups = $this->getGroups();
2698
2699             $foundOne = false;
2700
2701             foreach ($groups as $group) {
2702                 if ($profile->isMember($group)) {
2703                     $foundOne = true;
2704                     break;
2705                 }
2706             }
2707
2708             if (!$foundOne) {
2709                 return false;
2710             }
2711         }
2712
2713         if ($scope & Notice::FOLLOWER_SCOPE || $this->getProfile()->isPrivateStream()) {
2714
2715             if (!Subscription::exists($profile, $this->getProfile())) {
2716                 return false;
2717             }
2718         }
2719
2720         return !$this->isHiddenSpam($profile);
2721     }
2722
2723     function isHiddenSpam($profile) {
2724
2725         // Hide posts by silenced users from everyone but moderators.
2726
2727         if (common_config('notice', 'hidespam')) {
2728
2729             try {
2730                 $author = $this->getProfile();
2731             } catch(Exception $e) {
2732                 // If we can't get an author, keep it hidden.
2733                 // XXX: technically not spam, but, whatever.
2734                 return true;
2735             }
2736
2737             if ($author->hasRole(Profile_role::SILENCED)) {
2738                 if (!$profile instanceof Profile || (($profile->id !== $author->id) && (!$profile->hasRight(Right::REVIEWSPAM)))) {
2739                     return true;
2740                 }
2741             }
2742         }
2743
2744         return false;
2745     }
2746
2747     public function getParent()
2748     {
2749         if (empty($this->reply_to)) {
2750             throw new NoParentNoticeException($this);
2751         }
2752         return self::getByID($this->reply_to);
2753     }
2754
2755     /**
2756      * Magic function called at serialize() time.
2757      *
2758      * We use this to drop a couple process-specific references
2759      * from DB_DataObject which can cause trouble in future
2760      * processes.
2761      *
2762      * @return array of variable names to include in serialization.
2763      */
2764
2765     function __sleep()
2766     {
2767         $vars = parent::__sleep();
2768         $skip = array('_profile', '_groups', '_attachments', '_faves', '_replies', '_repeats');
2769         return array_diff($vars, $skip);
2770     }
2771
2772     static function defaultScope()
2773     {
2774         $scope = common_config('notice', 'defaultscope');
2775         if (is_null($scope)) {
2776                 if (common_config('site', 'private')) {
2777                         $scope = 1;
2778                 } else {
2779                         $scope = 0;
2780                 }
2781         }
2782         return $scope;
2783     }
2784
2785         static function fillProfiles($notices)
2786         {
2787                 $map = self::getProfiles($notices);
2788                 foreach ($notices as $entry=>$notice) {
2789             try {
2790                         if (array_key_exists($notice->profile_id, $map)) {
2791                                 $notice->_setProfile($map[$notice->profile_id]);
2792                         }
2793             } catch (NoProfileException $e) {
2794                 common_log(LOG_WARNING, "Failed to fill profile in Notice with non-existing entry for profile_id: {$e->profile_id}");
2795                 unset($notices[$entry]);
2796             }
2797                 }
2798
2799                 return array_values($map);
2800         }
2801
2802         static function getProfiles(&$notices)
2803         {
2804                 $ids = array();
2805                 foreach ($notices as $notice) {
2806                         $ids[] = $notice->profile_id;
2807                 }
2808                 $ids = array_unique($ids);
2809                 return Profile::pivotGet('id', $ids);
2810         }
2811
2812         static function fillGroups(&$notices)
2813         {
2814         $ids = self::_idsOf($notices);
2815         $gis = Group_inbox::listGet('notice_id', $ids);
2816         $gids = array();
2817
2818                 foreach ($gis as $id => $gi) {
2819                     foreach ($gi as $g)
2820                     {
2821                         $gids[] = $g->group_id;
2822                     }
2823                 }
2824
2825                 $gids = array_unique($gids);
2826                 $group = User_group::pivotGet('id', $gids);
2827                 foreach ($notices as $notice)
2828                 {
2829                         $grps = array();
2830                         $gi = $gis[$notice->id];
2831                         foreach ($gi as $g) {
2832                             $grps[] = $group[$g->group_id];
2833                         }
2834                     $notice->_setGroups($grps);
2835                 }
2836         }
2837
2838     static function _idsOf(array &$notices)
2839     {
2840                 $ids = array();
2841                 foreach ($notices as $notice) {
2842                         $ids[$notice->id] = true;
2843                 }
2844                 return array_keys($ids);
2845     }
2846
2847     static function fillAttachments(&$notices)
2848     {
2849         $ids = self::_idsOf($notices);
2850         $f2pMap = File_to_post::listGet('post_id', $ids);
2851                 $fileIds = array();
2852                 foreach ($f2pMap as $noticeId => $f2ps) {
2853             foreach ($f2ps as $f2p) {
2854                 $fileIds[] = $f2p->file_id;
2855             }
2856         }
2857
2858         $fileIds = array_unique($fileIds);
2859                 $fileMap = File::pivotGet('id', $fileIds);
2860                 foreach ($notices as $notice)
2861                 {
2862                         $files = array();
2863                         $f2ps = $f2pMap[$notice->id];
2864                         foreach ($f2ps as $f2p) {
2865                             $files[] = $fileMap[$f2p->file_id];
2866                         }
2867                     $notice->_setAttachments($files);
2868                 }
2869     }
2870
2871     static function fillReplies(&$notices)
2872     {
2873         $ids = self::_idsOf($notices);
2874         $replyMap = Reply::listGet('notice_id', $ids);
2875         foreach ($notices as $notice) {
2876             $replies = $replyMap[$notice->id];
2877             $ids = array();
2878             foreach ($replies as $reply) {
2879                 $ids[] = $reply->profile_id;
2880             }
2881             $notice->_setReplies($ids);
2882         }
2883     }
2884 }