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