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