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