classes/Notice.php

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