classes/Notice.php

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