classes/Notice.php

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