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