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