classes/Notice.php

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