classes/Notice.php

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