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