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->getID();
 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         unset($content);    // garbage collect
 861
 862         // Maybe a missing act-time should be fatal if the actor is not local?
 863         if (!empty($act->time)) {
 864             $stored->created = common_sql_date($act->time);
 865         } else {
 866             $stored->created = common_sql_now();
 867         }
 868
 869         $reply = null;  // this will store the in-reply-to Notice if found
 870         $replyUris = [];    // this keeps a list of possible URIs to look up
 871         if ($act->context instanceof ActivityContext && !empty($act->context->replyToID)) {
 872             $replyUris[] = $act->context->replyToID;
 873         }
 874         if ($act->target instanceof ActivityObject && !empty($act->target->id)) {
 875             $replyUris[] = $act->target->id;
 876         }
 877         foreach (array_unique($replyUris) as $replyUri) {
 878             $reply = self::getKV('uri', $replyUri);
 879             // Only do remote fetching if we're not a private site
 880             if (!common_config('site', 'private') && !$reply instanceof Notice) {
 881                 // the URI is the object we're looking for, $actor is a
 882                 // Profile that surely knows of it and &$reply where it
 883                 // will be stored when fetched
 884                 Event::handle('FetchRemoteNotice', array($replyUri, $actor, &$reply));
 885             }
 886             // we got what we're in-reply-to now, so let's move on
 887             if ($reply instanceof Notice) {
 888                 break;
 889             }
 890             // otherwise reset whatever we might've gotten from the event
 891             $reply = null;
 892         }
 893         unset($replyUris);  // garbage collect
 894
 895         if ($reply instanceof Notice) {
 896             if (!$reply->inScope($actor)) {
 897                 // TRANS: Client error displayed when trying to reply to a notice a the target has no access to.
 898                 // TRANS: %1$s is a user nickname, %2$d is a notice ID (number).
 899                 throw new ClientException(sprintf(_m('%1$s has no right to reply to notice %2$d.'), $actor->getNickname(), $reply->id), 403);
 900             }
 901
 902             $stored->reply_to     = $reply->id;
 903             $stored->conversation = $reply->conversation;
 904
 905             // If the original is private to a group, and notice has no group specified,
 906             // make it to the same group(s)
 907             if (empty($groups) && ($reply->scope & Notice::GROUP_SCOPE)) {
 908                 $replyGroups = $reply->getGroups();
 909                 foreach ($replyGroups as $group) {
 910                     if ($actor->isMember($group)) {
 911                         $groups[] = $group->id;
 912                     }
 913                 }
 914             }
 915
 916             if (is_null($scope)) {
 917                 $scope = $reply->scope;
 918             }
 919         } else {
 920             // If we don't know the reply, we might know the conversation!
 921             // This will happen if a known remote user replies to an
 922             // unknown remote user - within a known conversation.
 923             if (empty($stored->conversation) and !empty($act->context->conversation)) {
 924                 $conv = Conversation::getKV('uri', $act->context->conversation);
 925                 if ($conv instanceof Conversation) {
 926                     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.').');
 927                 } else {
 928                     // Conversation entry with specified URI was not found, so we must create it.
 929                     common_debug('Conversation URI not found, so we will create it with the URI given in the context of the activity: '.$act->context->conversation);
 930                     // The insert in Conversation::create throws exception on failure
 931                     $conv = Conversation::create($act->context->conversation, $stored->created);
 932                 }
 933                 $stored->conversation = $conv->getID();
 934                 unset($conv);
 935             }
 936         }
 937         unset($reply);  // garbage collect
 938
 939         // If it's not part of a conversation, it's the beginning of a new conversation.
 940         if (empty($stored->conversation)) {
 941             $conv = Conversation::create();
 942             $stored->conversation = $conv->getID();
 943             unset($conv);
 944         }
 945
 946         $notloc = null;
 947         if ($act->context instanceof ActivityContext) {
 948             if ($act->context->location instanceof Location) {
 949                 $notloc = Notice_location::fromLocation($act->context->location);
 950             }
 951         } else {
 952             $act->context = new ActivityContext();
 953         }
 954
 955         if (array_key_exists('http://activityschema.org/collection/public', $act->context->attention)) {
 956             $stored->scope = Notice::PUBLIC_SCOPE;
 957             // TODO: maybe we should actually keep this? if the saveAttentions thing wants to use it...
 958             unset($act->context->attention['http://activityschema.org/collection/public']);
 959         } else {
 960             $stored->scope = self::figureOutScope($actor, $groups, $scope);
 961         }
 962
 963         foreach ($act->categories as $cat) {
 964             if ($cat->term) {
 965                 $term = common_canonical_tag($cat->term);
 966                 if (!empty($term)) {
 967                     $tags[] = $term;
 968                 }
 969             }
 970         }
 971
 972         foreach ($act->enclosures as $href) {
 973             // @todo FIXME: Save these locally or....?
 974             $urls[] = $href;
 975         }
 976
 977         if (ActivityUtils::compareVerbs($stored->verb, array(ActivityVerb::POST))) {
 978             if (empty($act->objects[0]->type)) {
 979                 // Default type for the post verb is 'note', but we know it's
 980                 // a 'comment' if it is in reply to something.
 981                 $stored->object_type = empty($stored->reply_to) ? ActivityObject::NOTE : ActivityObject::COMMENT;
 982             } else {
 983                 //TODO: Is it safe to always return a relative URI? The
 984                 // JSON version of ActivityStreams always use it, so we
 985                 // should definitely be able to handle it...
 986                 $stored->object_type = ActivityUtils::resolveUri($act->objects[0]->type, true);
 987             }
 988         }
 989
 990         if (Event::handle('StartNoticeSave', array(&$stored))) {
 991             // XXX: some of these functions write to the DB
 992
 993             try {
 994                 $result = $stored->insert();    // throws exception on error
 995
 996                 if ($notloc instanceof Notice_location) {
 997                     $notloc->notice_id = $stored->getID();
 998                     $notloc->insert();
 999                 }
1000
1001                 $orig = clone($stored); // for updating later in this try clause
1002
1003                 $object = null;
1004                 Event::handle('StoreActivityObject', array($act, $stored, $options, &$object));
1005                 if (empty($object)) {
1006                     throw new NoticeSaveException('Unsuccessful call to StoreActivityObject '._ve($stored->getUri()) . ': '._ve($act->asString()));
1007                 }
1008                 unset($object);
1009
1010                 // If something changed in the Notice during StoreActivityObject
1011                 $stored->update($orig);
1012             } catch (Exception $e) {
1013                 if (empty($stored->id)) {
1014                     common_debug('Failed to save stored object entry in database ('.$e->getMessage().')');
1015                 } else {
1016                     common_debug('Failed to store activity object in database ('.$e->getMessage().'), deleting notice id '.$stored->id);
1017                     $stored->delete();
1018                 }
1019                 throw $e;
1020             }
1021         }
1022         unset($notloc); // garbage collect
1023
1024         if (!$stored instanceof Notice) {
1025             throw new ServerException('StartNoticeSave did not give back a Notice.');
1026         } elseif (empty($stored->id)) {
1027             throw new ServerException('Supposedly saved Notice has no ID.');
1028         }
1029
1030         // Only save 'attention' and metadata stuff (URLs, tags...) stuff if
1031         // the activityverb is a POST (since stuff like repeat, favorite etc.
1032         // reasonably handle notifications themselves.
1033         if (ActivityUtils::compareVerbs($stored->verb, array(ActivityVerb::POST))) {
1034
1035             if (!empty($tags)) {
1036                 $stored->saveKnownTags($tags);
1037             } else {
1038                 $stored->saveTags();
1039             }
1040
1041             // Note: groups may save tags, so must be run after tags are saved
1042             // to avoid errors on duplicates.
1043             $stored->saveAttentions($act->context->attention);
1044
1045             if (!empty($urls)) {
1046                 $stored->saveKnownUrls($urls);
1047             } else {
1048                 $stored->saveUrls();
1049             }
1050         }
1051
1052         if ($distribute) {
1053             // Prepare inbox delivery, may be queued to background.
1054             $stored->distribute();
1055         }
1056
1057         return $stored;
1058     }
1059
1060     static public function figureOutScope(Profile $actor, array $groups, $scope=null) {
1061         $scope = is_null($scope) ? self::defaultScope() : intval($scope);
1062
1063         // For private streams
1064         try {
1065             $user = $actor->getUser();
1066             // FIXME: We can't do bit comparison with == (Legacy StatusNet thing. Let's keep it for now.)
1067             if ($user->private_stream && ($scope === Notice::PUBLIC_SCOPE || $scope === Notice::SITE_SCOPE)) {
1068                 $scope |= Notice::FOLLOWER_SCOPE;
1069             }
1070         } catch (NoSuchUserException $e) {
1071             // TODO: Not a local user, so we don't know about scope preferences... yet!
1072         }
1073
1074         // Force the scope for private groups
1075         foreach ($groups as $group_id) {
1076             try {
1077                 $group = User_group::getByID($group_id);
1078                 if ($group->force_scope) {
1079                     $scope |= Notice::GROUP_SCOPE;
1080                     break;
1081                 }
1082             } catch (Exception $e) {
1083                 common_log(LOG_ERR, 'Notice figureOutScope threw exception: '.$e->getMessage());
1084             }
1085         }
1086
1087         return $scope;
1088     }
1089
1090     function blowOnInsert($conversation = false)
1091     {
1092         $this->blowStream('profile:notice_ids:%d', $this->profile_id);
1093
1094         if ($this->isPublic()) {
1095             $this->blowStream('public');
1096             $this->blowStream('networkpublic');
1097         }
1098
1099         if ($this->conversation) {
1100             self::blow('notice:list-ids:conversation:%s', $this->conversation);
1101             self::blow('conversation:notice_count:%d', $this->conversation);
1102         }
1103
1104         if ($this->isRepeat()) {
1105             // XXX: we should probably only use one of these
1106             $this->blowStream('notice:repeats:%d', $this->repeat_of);
1107             self::blow('notice:list-ids:repeat_of:%d', $this->repeat_of);
1108         }
1109
1110         $original = Notice::getKV('id', $this->repeat_of);
1111
1112         if ($original instanceof Notice) {
1113             $originalUser = User::getKV('id', $original->profile_id);
1114             if ($originalUser instanceof User) {
1115                 $this->blowStream('user:repeats_of_me:%d', $originalUser->id);
1116             }
1117         }
1118
1119         $profile = Profile::getKV($this->profile_id);
1120
1121         if ($profile instanceof Profile) {
1122             $profile->blowNoticeCount();
1123         }
1124
1125         $ptags = $this->getProfileTags();
1126         foreach ($ptags as $ptag) {
1127             $ptag->blowNoticeStreamCache();
1128         }
1129     }
1130
1131     /**
1132      * Clear cache entries related to this notice at delete time.
1133      * Necessary to avoid breaking paging on public, profile timelines.
1134      */
1135     function blowOnDelete()
1136     {
1137         $this->blowOnInsert();
1138
1139         self::blow('profile:notice_ids:%d;last', $this->profile_id);
1140
1141         if ($this->isPublic()) {
1142             self::blow('public;last');
1143             self::blow('networkpublic;last');
1144         }
1145
1146         self::blow('fave:by_notice', $this->id);
1147
1148         if ($this->conversation) {
1149             // In case we're the first, will need to calc a new root.
1150             self::blow('notice:conversation_root:%d', $this->conversation);
1151         }
1152
1153         $ptags = $this->getProfileTags();
1154         foreach ($ptags as $ptag) {
1155             $ptag->blowNoticeStreamCache(true);
1156         }
1157     }
1158
1159     function blowStream()
1160     {
1161         $c = self::memcache();
1162
1163         if (empty($c)) {
1164             return false;
1165         }
1166
1167         $args = func_get_args();
1168         $format = array_shift($args);
1169         $keyPart = vsprintf($format, $args);
1170         $cacheKey = Cache::key($keyPart);
1171         $c->delete($cacheKey);
1172
1173         // delete the "last" stream, too, if this notice is
1174         // older than the top of that stream
1175
1176         $lastKey = $cacheKey.';last';
1177
1178         $lastStr = $c->get($lastKey);
1179
1180         if ($lastStr !== false) {
1181             $window     = explode(',', $lastStr);
1182             $lastID     = $window[0];
1183             $lastNotice = Notice::getKV('id', $lastID);
1184             if (!$lastNotice instanceof Notice // just weird
1185                 || strtotime($lastNotice->created) >= strtotime($this->created)) {
1186                 $c->delete($lastKey);
1187             }
1188         }
1189     }
1190
1191     /** save all urls in the notice to the db
1192      *
1193      * follow redirects and save all available file information
1194      * (mimetype, date, size, oembed, etc.)
1195      *
1196      * @return void
1197      */
1198     function saveUrls() {
1199         if (common_config('attachments', 'process_links')) {
1200             common_replace_urls_callback($this->content, array($this, 'saveUrl'), $this);
1201         }
1202     }
1203
1204     /**
1205      * Save the given URLs as related links/attachments to the db
1206      *
1207      * follow redirects and save all available file information
1208      * (mimetype, date, size, oembed, etc.)
1209      *
1210      * @return void
1211      */
1212     function saveKnownUrls($urls)
1213     {
1214         if (common_config('attachments', 'process_links')) {
1215             // @fixme validation?
1216             foreach (array_unique($urls) as $url) {
1217                 $this->saveUrl($url, $this);
1218             }
1219         }
1220     }
1221
1222     /**
1223      * @private callback
1224      */
1225     function saveUrl($url, Notice $notice) {
1226         try {
1227             File::processNew($url, $notice);
1228         } catch (ServerException $e) {
1229             // Could not save URL. Log it?
1230         }
1231     }
1232
1233     static function checkDupes($profile_id, $content) {
1234         $profile = Profile::getKV($profile_id);
1235         if (!$profile instanceof Profile) {
1236             return false;
1237         }
1238         $notice = $profile->getNotices(0, CachingNoticeStream::CACHE_WINDOW);
1239         if (!empty($notice)) {
1240             $last = 0;
1241             while ($notice->fetch()) {
1242                 if (time() - strtotime($notice->created) >= common_config('site', 'dupelimit')) {
1243                     return true;
1244                 } else if ($notice->content == $content) {
1245                     return false;
1246                 }
1247             }
1248         }
1249         // If we get here, oldest item in cache window is not
1250         // old enough for dupe limit; do direct check against DB
1251         $notice = new Notice();
1252         $notice->profile_id = $profile_id;
1253         $notice->content = $content;
1254         $threshold = common_sql_date(time() - common_config('site', 'dupelimit'));
1255         $notice->whereAdd(sprintf("created > '%s'", $notice->escape($threshold)));
1256
1257         $cnt = $notice->count();
1258         return ($cnt == 0);
1259     }
1260
1261     static function checkEditThrottle($profile_id) {
1262         $profile = Profile::getKV($profile_id);
1263         if (!$profile instanceof Profile) {
1264             return false;
1265         }
1266         // Get the Nth notice
1267         $notice = $profile->getNotices(common_config('throttle', 'count') - 1, 1);
1268         if ($notice && $notice->fetch()) {
1269             // If the Nth notice was posted less than timespan seconds ago
1270             if (time() - strtotime($notice->created) <= common_config('throttle', 'timespan')) {
1271                 // Then we throttle
1272                 return false;
1273             }
1274         }
1275         // Either not N notices in the stream, OR the Nth was not posted within timespan seconds
1276         return true;
1277     }
1278
1279         protected $_attachments = array();
1280
1281     function attachments() {
1282                 if (isset($this->_attachments[$this->id])) {
1283             return $this->_attachments[$this->id];
1284         }
1285
1286         $f2ps = File_to_post::listGet('post_id', array($this->id));
1287                 $ids = array();
1288                 foreach ($f2ps[$this->id] as $f2p) {
1289             $ids[] = $f2p->file_id;
1290         }
1291
1292         return $this->_setAttachments(File::multiGet('id', $ids)->fetchAll());
1293     }
1294
1295         public function _setAttachments(array $attachments)
1296         {
1297             return $this->_attachments[$this->id] = $attachments;
1298         }
1299
1300     static function publicStream($offset=0, $limit=20, $since_id=null, $max_id=null)
1301     {
1302         $stream = new PublicNoticeStream();
1303         return $stream->getNotices($offset, $limit, $since_id, $max_id);
1304     }
1305
1306     static function conversationStream($id, $offset=0, $limit=20, $since_id=null, $max_id=null, Profile $scoped=null)
1307     {
1308         $stream = new ConversationNoticeStream($id, $scoped);
1309         return $stream->getNotices($offset, $limit, $since_id, $max_id);
1310     }
1311
1312     /**
1313      * Is this notice part of an active conversation?
1314      *
1315      * @return boolean true if other messages exist in the same
1316      *                 conversation, false if this is the only one
1317      */
1318     function hasConversation()
1319     {
1320         if (empty($this->conversation)) {
1321             // this notice is not part of a conversation apparently
1322             // FIXME: all notices should have a conversation value, right?
1323             return false;
1324         }
1325
1326         //FIXME: Get the Profile::current() stuff some other way
1327         // to avoid confusion between queue processing and session.
1328         $notice = self::conversationStream($this->conversation, 1, 1, null, null, Profile::current());
1329
1330         // if our "offset 1, limit 1" query got a result, return true else false
1331         return $notice->N > 0;
1332     }
1333
1334     /**
1335      * Grab the earliest notice from this conversation.
1336      *
1337      * @return Notice or null
1338      */
1339     function conversationRoot($profile=-1)
1340     {
1341         // XXX: can this happen?
1342
1343         if (empty($this->conversation)) {
1344             return null;
1345         }
1346
1347         // Get the current profile if not specified
1348
1349         if (is_int($profile) && $profile == -1) {
1350             $profile = Profile::current();
1351         }
1352
1353         // If this notice is out of scope, no root for you!
1354
1355         if (!$this->inScope($profile)) {
1356             return null;
1357         }
1358
1359         // If this isn't a reply to anything, then it's its own
1360         // root if it's the earliest notice in the conversation:
1361
1362         if (empty($this->reply_to)) {
1363             $root = new Notice;
1364             $root->conversation = $this->conversation;
1365             $root->orderBy('notice.created ASC');
1366             $root->find(true);  // true means "fetch first result"
1367             $root->free();
1368             return $root;
1369         }
1370
1371         if (is_null($profile)) {
1372             $keypart = sprintf('notice:conversation_root:%d:null', $this->id);
1373         } else {
1374             $keypart = sprintf('notice:conversation_root:%d:%d',
1375                                $this->id,
1376                                $profile->id);
1377         }
1378
1379         $root = self::cacheGet($keypart);
1380
1381         if ($root !== false && $root->inScope($profile)) {
1382             return $root;
1383         }
1384
1385         $last = $this;
1386         while (true) {
1387             try {
1388                 $parent = $last->getParent();
1389                 if ($parent->inScope($profile)) {
1390                     $last = $parent;
1391                     continue;
1392                 }
1393             } catch (NoParentNoticeException $e) {
1394                 // Latest notice has no parent
1395             } catch (NoResultException $e) {
1396                 // Notice was not found, so we can't go further up in the tree.
1397                 // FIXME: Maybe we should do this in a more stable way where deleted
1398                 // notices won't break conversation chains?
1399             }
1400             // No parent, or parent out of scope
1401             $root = $last;
1402             break;
1403         }
1404
1405         self::cacheSet($keypart, $root);
1406
1407         return $root;
1408     }
1409
1410     /**
1411      * Pull up a full list of local recipients who will be getting
1412      * this notice in their inbox. Results will be cached, so don't
1413      * change the input data wily-nilly!
1414      *
1415      * @param array $groups optional list of Group objects;
1416      *              if left empty, will be loaded from group_inbox records
1417      * @param array $recipient optional list of reply profile ids
1418      *              if left empty, will be loaded from reply records
1419      * @return array associating recipient user IDs with an inbox source constant
1420      */
1421     function whoGets(array $groups=null, array $recipients=null)
1422     {
1423         $c = self::memcache();
1424
1425         if (!empty($c)) {
1426             $ni = $c->get(Cache::key('notice:who_gets:'.$this->id));
1427             if ($ni !== false) {
1428                 return $ni;
1429             }
1430         }
1431
1432         if (is_null($recipients)) {
1433             $recipients = $this->getReplies();
1434         }
1435
1436         $ni = array();
1437
1438         // Give plugins a chance to add folks in at start...
1439         if (Event::handle('StartNoticeWhoGets', array($this, &$ni))) {
1440
1441             $users = $this->getSubscribedUsers();
1442             foreach ($users as $id) {
1443                 $ni[$id] = NOTICE_INBOX_SOURCE_SUB;
1444             }
1445
1446             if (is_null($groups)) {
1447                 $groups = $this->getGroups();
1448             }
1449             foreach ($groups as $group) {
1450                 $users = $group->getUserMembers();
1451                 foreach ($users as $id) {
1452                     if (!array_key_exists($id, $ni)) {
1453                         $ni[$id] = NOTICE_INBOX_SOURCE_GROUP;
1454                     }
1455                 }
1456             }
1457
1458             $ptAtts = $this->getAttentionsFromProfileTags();
1459             foreach ($ptAtts as $key=>$val) {
1460                 if (!array_key_exists($key, $ni)) {
1461                     $ni[$key] = $val;
1462                 }
1463             }
1464
1465             foreach ($recipients as $recipient) {
1466                 if (!array_key_exists($recipient, $ni)) {
1467                     $ni[$recipient] = NOTICE_INBOX_SOURCE_REPLY;
1468                 }
1469             }
1470
1471             // Exclude any deleted, non-local, or blocking recipients.
1472             $profile = $this->getProfile();
1473             $originalProfile = null;
1474             if ($this->isRepeat()) {
1475                 // Check blocks against the original notice's poster as well.
1476                 $original = Notice::getKV('id', $this->repeat_of);
1477                 if ($original instanceof Notice) {
1478                     $originalProfile = $original->getProfile();
1479                 }
1480             }
1481
1482             foreach ($ni as $id => $source) {
1483                 try {
1484                     $user = User::getKV('id', $id);
1485                     if (!$user instanceof User ||
1486                         $user->hasBlocked($profile) ||
1487                         ($originalProfile && $user->hasBlocked($originalProfile))) {
1488                         unset($ni[$id]);
1489                     }
1490                 } catch (UserNoProfileException $e) {
1491                     // User doesn't have a profile; invalid; skip them.
1492                     unset($ni[$id]);
1493                 }
1494             }
1495
1496             // Give plugins a chance to filter out...
1497             Event::handle('EndNoticeWhoGets', array($this, &$ni));
1498         }
1499
1500         if (!empty($c)) {
1501             // XXX: pack this data better
1502             $c->set(Cache::key('notice:who_gets:'.$this->id), $ni);
1503         }
1504
1505         return $ni;
1506     }
1507
1508     function getSubscribedUsers()
1509     {
1510         $user = new User();
1511
1512         if(common_config('db','quote_identifiers'))
1513           $user_table = '"user"';
1514         else $user_table = 'user';
1515
1516         $qry =
1517           'SELECT id ' .
1518           'FROM '. $user_table .' JOIN subscription '.
1519           'ON '. $user_table .'.id = subscription.subscriber ' .
1520           'WHERE subscription.subscribed = %d ';
1521
1522         $user->query(sprintf($qry, $this->profile_id));
1523
1524         $ids = array();
1525
1526         while ($user->fetch()) {
1527             $ids[] = $user->id;
1528         }
1529
1530         $user->free();
1531
1532         return $ids;
1533     }
1534
1535     function getProfileTags()
1536     {
1537         $profile = $this->getProfile();
1538         $list    = $profile->getOtherTags($profile);
1539         $ptags   = array();
1540
1541         while($list->fetch()) {
1542             $ptags[] = clone($list);
1543         }
1544
1545         return $ptags;
1546     }
1547
1548     public function getAttentionsFromProfileTags()
1549     {
1550         $ni = array();
1551         $ptags = $this->getProfileTags();
1552         foreach ($ptags as $ptag) {
1553             $users = $ptag->getUserSubscribers();
1554             foreach ($users as $id) {
1555                 $ni[$id] = NOTICE_INBOX_SOURCE_PROFILE_TAG;
1556             }
1557         }
1558         return $ni;
1559     }
1560
1561     /**
1562      * Record this notice to the given group inboxes for delivery.
1563      * Overrides the regular parsing of !group markup.
1564      *
1565      * @param string $group_ids
1566      * @fixme might prefer URIs as identifiers, as for replies?
1567      *        best with generalizations on user_group to support
1568      *        remote groups better.
1569      */
1570     function saveKnownGroups(array $group_ids)
1571     {
1572         $groups = array();
1573         foreach (array_unique($group_ids) as $id) {
1574             $group = User_group::getKV('id', $id);
1575             if ($group instanceof User_group) {
1576                 common_log(LOG_DEBUG, "Local delivery to group id $id, $group->nickname");
1577                 $result = $this->addToGroupInbox($group);
1578                 if (!$result) {
1579                     common_log_db_error($gi, 'INSERT', __FILE__);
1580                 }
1581
1582                 if (common_config('group', 'addtag')) {
1583                     // we automatically add a tag for every group name, too
1584
1585                     $tag = Notice_tag::pkeyGet(array('tag' => common_canonical_tag($group->nickname),
1586                                                      'notice_id' => $this->id));
1587
1588                     if (is_null($tag)) {
1589                         $this->saveTag($group->nickname);
1590                     }
1591                 }
1592
1593                 $groups[] = clone($group);
1594             } else {
1595                 common_log(LOG_ERR, "Local delivery to group id $id skipped, doesn't exist");
1596             }
1597         }
1598
1599         return $groups;
1600     }
1601
1602     function addToGroupInbox(User_group $group)
1603     {
1604         $gi = Group_inbox::pkeyGet(array('group_id' => $group->id,
1605                                          'notice_id' => $this->id));
1606
1607         if (!$gi instanceof Group_inbox) {
1608
1609             $gi = new Group_inbox();
1610
1611             $gi->group_id  = $group->id;
1612             $gi->notice_id = $this->id;
1613             $gi->created   = $this->created;
1614
1615             $result = $gi->insert();
1616
1617             if (!$result) {
1618                 common_log_db_error($gi, 'INSERT', __FILE__);
1619                 // TRANS: Server exception thrown when an update for a group inbox fails.
1620                 throw new ServerException(_('Problem saving group inbox.'));
1621             }
1622
1623             self::blow('user_group:notice_ids:%d', $gi->group_id);
1624         }
1625
1626         return true;
1627     }
1628
1629     function saveAttentions(array $uris)
1630     {
1631         foreach ($uris as $uri=>$type) {
1632             try {
1633                 $target = Profile::fromUri($uri);
1634             } catch (UnknownUriException $e) {
1635                 common_log(LOG_WARNING, "Unable to determine profile for URI '$uri'");
1636                 continue;
1637             }
1638
1639             try {
1640                 $this->saveAttention($target);
1641             } catch (AlreadyFulfilledException $e) {
1642                 common_debug('Attention already exists: '.var_export($e->getMessage(),true));
1643             } catch (Exception $e) {
1644                 common_log(LOG_ERR, "Could not save notice id=={$this->getID()} attention for profile id=={$target->getID()}: {$e->getMessage()}");
1645             }
1646         }
1647     }
1648
1649     /**
1650      * Saves an attention for a profile (user or group) which means
1651      * it shows up in their home feed and such.
1652      */
1653     function saveAttention(Profile $target, $reason=null)
1654     {
1655         if ($target->isGroup()) {
1656             // FIXME: Make sure we check (for both local and remote) users are in the groups they send to!
1657
1658             // legacy notification method, will still be in use for quite a while I think
1659             $this->addToGroupInbox($target->getGroup());
1660         } else {
1661             if ($target->hasBlocked($this->getProfile())) {
1662                 common_log(LOG_INFO, "Not saving reply to profile {$target->id} ($uri) from sender {$sender->id} because of a block.");
1663                 return false;
1664             }
1665         }
1666
1667         if ($target->isLocal()) {
1668             // legacy notification method, will still be in use for quite a while I think
1669             $this->saveReply($target->getID());
1670         }
1671
1672         $att = Attention::saveNew($this, $target, $reason);
1673         return true;
1674     }
1675
1676     /**
1677      * Save reply records indicating that this notice needs to be
1678      * delivered to the local users with the given URIs.
1679      *
1680      * Since this is expected to be used when saving foreign-sourced
1681      * messages, we won't deliver to any remote targets as that's the
1682      * source service's responsibility.
1683      *
1684      * Mail notifications etc will be handled later.
1685      *
1686      * @param array  $uris   Array of unique identifier URIs for recipients
1687      */
1688     function saveKnownReplies(array $uris)
1689     {
1690         if (empty($uris)) {
1691             return;
1692         }
1693
1694         $sender = $this->getProfile();
1695
1696         foreach (array_unique($uris) as $uri) {
1697             try {
1698                 $profile = Profile::fromUri($uri);
1699             } catch (UnknownUriException $e) {
1700                 common_log(LOG_WARNING, "Unable to determine profile for URI '$uri'");
1701                 continue;
1702             }
1703
1704             if ($profile->hasBlocked($sender)) {
1705                 common_log(LOG_INFO, "Not saving reply to profile {$profile->id} ($uri) from sender {$sender->id} because of a block.");
1706                 continue;
1707             }
1708
1709             $this->saveReply($profile->getID());
1710             self::blow('reply:stream:%d', $profile->getID());
1711         }
1712     }
1713
1714     /**
1715      * Pull @-replies from this message's content in StatusNet markup format
1716      * and save reply records indicating that this message needs to be
1717      * delivered to those users.
1718      *
1719      * Mail notifications to local profiles will be sent later.
1720      *
1721      * @return array of integer profile IDs
1722      */
1723
1724     function saveReplies()
1725     {
1726         $sender = $this->getProfile();
1727
1728         $replied = array();
1729
1730         // If it's a reply, save for the replied-to author
1731         try {
1732             $parent = $this->getParent();
1733             $parentauthor = $parent->getProfile();
1734             $this->saveReply($parentauthor->getID());
1735             $replied[$parentauthor->getID()] = 1;
1736             self::blow('reply:stream:%d', $parentauthor->getID());
1737         } catch (NoParentNoticeException $e) {
1738             // Not a reply, since it has no parent!
1739             $parent = null;
1740         } catch (NoResultException $e) {
1741             // Parent notice was probably deleted
1742             $parent = null;
1743         }
1744
1745         // @todo ideally this parser information would only
1746         // be calculated once.
1747
1748         $mentions = common_find_mentions($this->content, $sender, $parent);
1749
1750         foreach ($mentions as $mention) {
1751
1752             foreach ($mention['mentioned'] as $mentioned) {
1753
1754                 // skip if they're already covered
1755                 if (array_key_exists($mentioned->id, $replied)) {
1756                     continue;
1757                 }
1758
1759                 // Don't save replies from blocked profile to local user
1760                 if ($mentioned->hasBlocked($sender)) {
1761                     continue;
1762                 }
1763
1764                 $this->saveReply($mentioned->id);
1765                 $replied[$mentioned->id] = 1;
1766                 self::blow('reply:stream:%d', $mentioned->id);
1767             }
1768         }
1769
1770         $recipientIds = array_keys($replied);
1771
1772         return $recipientIds;
1773     }
1774
1775     function saveReply($profileId)
1776     {
1777         $reply = new Reply();
1778
1779         $reply->notice_id  = $this->id;
1780         $reply->profile_id = $profileId;
1781         $reply->modified   = $this->created;
1782
1783         $reply->insert();
1784
1785         return $reply;
1786     }
1787
1788     protected $_attentionids = array();
1789
1790     /**
1791      * Pull the complete list of known activity context attentions for this notice.
1792      *
1793      * @return array of integer profile ids (also group profiles)
1794      */
1795     function getAttentionProfileIDs()
1796     {
1797         if (!isset($this->_attentionids[$this->getID()])) {
1798             $atts = Attention::multiGet('notice_id', array($this->getID()));
1799             // (array)null means empty array
1800             $this->_attentionids[$this->getID()] = (array)$atts->fetchAll('profile_id');
1801         }
1802         return $this->_attentionids[$this->getID()];
1803     }
1804
1805     protected $_replies = array();
1806
1807     /**
1808      * Pull the complete list of @-mentioned profile IDs for this notice.
1809      *
1810      * @return array of integer profile ids
1811      */
1812     function getReplies()
1813     {
1814         if (!isset($this->_replies[$this->getID()])) {
1815             $mentions = Reply::multiGet('notice_id', array($this->getID()));
1816             $this->_replies[$this->getID()] = $mentions->fetchAll('profile_id');
1817         }
1818         return $this->_replies[$this->getID()];
1819     }
1820
1821     function _setReplies($replies)
1822     {
1823         $this->_replies[$this->getID()] = $replies;
1824     }
1825
1826     /**
1827      * Pull the complete list of @-reply targets for this notice.
1828      *
1829      * @return array of Profiles
1830      */
1831     function getAttentionProfiles()
1832     {
1833         $ids = array_unique(array_merge($this->getReplies(), $this->getGroupProfileIDs(), $this->getAttentionProfileIDs()));
1834
1835         $profiles = Profile::multiGet('id', (array)$ids);
1836
1837         return $profiles->fetchAll();
1838     }
1839
1840     /**
1841      * Send e-mail notifications to local @-reply targets.
1842      *
1843      * Replies must already have been saved; this is expected to be run
1844      * from the distrib queue handler.
1845      */
1846     function sendReplyNotifications()
1847     {
1848         // Don't send reply notifications for repeats
1849         if ($this->isRepeat()) {
1850             return array();
1851         }
1852
1853         $recipientIds = $this->getReplies();
1854         if (Event::handle('StartNotifyMentioned', array($this, &$recipientIds))) {
1855             require_once INSTALLDIR.'/lib/mail.php';
1856
1857             foreach ($recipientIds as $recipientId) {
1858                 try {
1859                     $user = User::getByID($recipientId);
1860                     mail_notify_attn($user->getProfile(), $this);
1861                 } catch (NoResultException $e) {
1862                     // No such user
1863                 }
1864             }
1865             Event::handle('EndNotifyMentioned', array($this, $recipientIds));
1866         }
1867     }
1868
1869     /**
1870      * Pull list of Profile IDs of groups this notice addresses.
1871      *
1872      * @return array of Group _profile_ IDs
1873      */
1874
1875     function getGroupProfileIDs()
1876     {
1877         $ids = array();
1878
1879                 foreach ($this->getGroups() as $group) {
1880                     $ids[] = $group->profile_id;
1881                 }
1882
1883         return $ids;
1884     }
1885
1886     /**
1887      * Pull list of groups this notice needs to be delivered to,
1888      * as previously recorded by saveKnownGroups().
1889      *
1890      * @return array of Group objects
1891      */
1892
1893     protected $_groups = array();
1894
1895     function getGroups()
1896     {
1897         // Don't save groups for repeats
1898
1899         if (!empty($this->repeat_of)) {
1900             return array();
1901         }
1902
1903         if (isset($this->_groups[$this->id])) {
1904             return $this->_groups[$this->id];
1905         }
1906
1907         $gis = Group_inbox::listGet('notice_id', array($this->id));
1908
1909         $ids = array();
1910
1911                 foreach ($gis[$this->id] as $gi) {
1912                     $ids[] = $gi->group_id;
1913                 }
1914
1915                 $groups = User_group::multiGet('id', $ids);
1916                 $this->_groups[$this->id] = $groups->fetchAll();
1917                 return $this->_groups[$this->id];
1918     }
1919
1920     function _setGroups($groups)
1921     {
1922         $this->_groups[$this->id] = $groups;
1923     }
1924
1925     /**
1926      * Convert a notice into an activity for export.
1927      *
1928      * @param Profile $scoped   The currently logged in/scoped profile
1929      *
1930      * @return Activity activity object representing this Notice.
1931      */
1932
1933     function asActivity(Profile $scoped=null)
1934     {
1935         $act = self::cacheGet(Cache::codeKey('notice:as-activity:'.$this->id));
1936
1937         if ($act instanceof Activity) {
1938             return $act;
1939         }
1940         $act = new Activity();
1941
1942         if (Event::handle('StartNoticeAsActivity', array($this, $act, $scoped))) {
1943
1944             $act->id      = $this->uri;
1945             $act->time    = strtotime($this->created);
1946             try {
1947                 $act->link    = $this->getUrl();
1948             } catch (InvalidUrlException $e) {
1949                 // The notice is probably a share or similar, which don't
1950                 // have a representational URL of their own.
1951             }
1952             $act->content = common_xml_safe_str($this->getRendered());
1953
1954             $profile = $this->getProfile();
1955
1956             $act->actor            = $profile->asActivityObject();
1957             $act->actor->extra[]   = $profile->profileInfo($scoped);
1958
1959             $act->verb = $this->verb;
1960
1961             if (!$this->repeat_of) {
1962                 $act->objects[] = $this->asActivityObject();
1963             }
1964
1965             // XXX: should this be handled by default processing for object entry?
1966
1967             // Categories
1968
1969             $tags = $this->getTags();
1970
1971             foreach ($tags as $tag) {
1972                 $cat       = new AtomCategory();
1973                 $cat->term = $tag;
1974
1975                 $act->categories[] = $cat;
1976             }
1977
1978             // Enclosures
1979             // XXX: use Atom Media and/or File activity objects instead
1980
1981             $attachments = $this->attachments();
1982
1983             foreach ($attachments as $attachment) {
1984                 // Include local attachments in Activity
1985                 if (!empty($attachment->filename)) {
1986                     $act->enclosures[] = $attachment->getEnclosure();
1987                 }
1988             }
1989
1990             $ctx = new ActivityContext();
1991
1992             try {
1993                 $reply = $this->getParent();
1994                 $ctx->replyToID  = $reply->getUri();
1995                 $ctx->replyToUrl = $reply->getUrl(true);    // true for fallback to local URL, less messy
1996             } catch (NoParentNoticeException $e) {
1997                 // This is not a reply to something
1998             } catch (NoResultException $e) {
1999                 // Parent notice was probably deleted
2000             }
2001
2002             try {
2003                 $ctx->location = Notice_location::locFromStored($this);
2004             } catch (ServerException $e) {
2005                 $ctx->location = null;
2006             }
2007
2008             $conv = null;
2009
2010             if (!empty($this->conversation)) {
2011                 $conv = Conversation::getKV('id', $this->conversation);
2012                 if ($conv instanceof Conversation) {
2013                     $ctx->conversation = $conv->uri;
2014                 }
2015             }
2016
2017             // This covers the legacy getReplies and getGroups too which get their data
2018             // from entries stored via Notice::saveNew (which we want to move away from)...
2019             foreach ($this->getAttentionProfiles() as $target) {
2020                 // User and group profiles which get the attention of this notice
2021                 $ctx->attention[$target->getUri()] = $target->getObjectType();
2022             }
2023
2024             switch ($this->scope) {
2025             case Notice::PUBLIC_SCOPE:
2026                 $ctx->attention[ActivityContext::ATTN_PUBLIC] = ActivityObject::COLLECTION;
2027                 break;
2028             case Notice::FOLLOWER_SCOPE:
2029                 $surl = common_local_url("subscribers", array('nickname' => $profile->nickname));
2030                 $ctx->attention[$surl] = ActivityObject::COLLECTION;
2031                 break;
2032             }
2033
2034             $act->context = $ctx;
2035
2036             $source = $this->getSource();
2037
2038             if ($source instanceof Notice_source) {
2039                 $act->generator = ActivityObject::fromNoticeSource($source);
2040             }
2041
2042             // Source
2043
2044             $atom_feed = $profile->getAtomFeed();
2045
2046             if (!empty($atom_feed)) {
2047
2048                 $act->source = new ActivitySource();
2049
2050                 // XXX: we should store the actual feed ID
2051
2052                 $act->source->id = $atom_feed;
2053
2054                 // XXX: we should store the actual feed title
2055
2056                 $act->source->title = $profile->getBestName();
2057
2058                 $act->source->links['alternate'] = $profile->profileurl;
2059                 $act->source->links['self']      = $atom_feed;
2060
2061                 $act->source->icon = $profile->avatarUrl(AVATAR_PROFILE_SIZE);
2062
2063                 $notice = $profile->getCurrentNotice();
2064
2065                 if ($notice instanceof Notice) {
2066                     $act->source->updated = self::utcDate($notice->created);
2067                 }
2068
2069                 $user = User::getKV('id', $profile->id);
2070
2071                 if ($user instanceof User) {
2072                     $act->source->links['license'] = common_config('license', 'url');
2073                 }
2074             }
2075
2076             if ($this->isLocal()) {
2077                 $act->selfLink = common_local_url('ApiStatusesShow', array('id' => $this->id,
2078                                                                            'format' => 'atom'));
2079                 $act->editLink = $act->selfLink;
2080             }
2081
2082             Event::handle('EndNoticeAsActivity', array($this, $act, $scoped));
2083         }
2084
2085         self::cacheSet(Cache::codeKey('notice:as-activity:'.$this->id), $act);
2086
2087         return $act;
2088     }
2089
2090     // This has gotten way too long. Needs to be sliced up into functional bits
2091     // or ideally exported to a utility class.
2092
2093     function asAtomEntry($namespace=false,
2094                          $source=false,
2095                          $author=true,
2096                          Profile $scoped=null)
2097     {
2098         $act = $this->asActivity($scoped);
2099         $act->extra[] = $this->noticeInfo($scoped);
2100         return $act->asString($namespace, $author, $source);
2101     }
2102
2103     /**
2104      * Extra notice info for atom entries
2105      *
2106      * Clients use some extra notice info in the atom stream.
2107      * This gives it to them.
2108      *
2109      * @param Profile $scoped   The currently logged in/scoped profile
2110      *
2111      * @return array representation of <statusnet:notice_info> element
2112      */
2113
2114     function noticeInfo(Profile $scoped=null)
2115     {
2116         // local notice ID (useful to clients for ordering)
2117
2118         $noticeInfoAttr = array('local_id' => $this->id);
2119
2120         // notice source
2121
2122         $ns = $this->getSource();
2123
2124         if ($ns instanceof Notice_source) {
2125             $noticeInfoAttr['source'] =  $ns->code;
2126             if (!empty($ns->url)) {
2127                 $noticeInfoAttr['source_link'] = $ns->url;
2128                 if (!empty($ns->name)) {
2129                     $noticeInfoAttr['source'] =  '<a href="'
2130                         . htmlspecialchars($ns->url)
2131                         . '" rel="nofollow">'
2132                         . htmlspecialchars($ns->name)
2133                         . '</a>';
2134                 }
2135             }
2136         }
2137
2138         // favorite and repeated
2139
2140         if ($scoped instanceof Profile) {
2141             $noticeInfoAttr['repeated'] = ($scoped->hasRepeated($this)) ? "true" : "false";
2142         }
2143
2144         if (!empty($this->repeat_of)) {
2145             $noticeInfoAttr['repeat_of'] = $this->repeat_of;
2146         }
2147
2148         Event::handle('StatusNetApiNoticeInfo', array($this, &$noticeInfoAttr, $scoped));
2149
2150         return array('statusnet:notice_info', $noticeInfoAttr, null);
2151     }
2152
2153     /**
2154      * Returns an XML string fragment with a reference to a notice as an
2155      * Activity Streams noun object with the given element type.
2156      *
2157      * Assumes that 'activity' namespace has been previously defined.
2158      *
2159      * @param string $element one of 'subject', 'object', 'target'
2160      * @return string
2161      */
2162
2163     function asActivityNoun($element)
2164     {
2165         $noun = $this->asActivityObject();
2166         return $noun->asString('activity:' . $element);
2167     }
2168
2169     public function asActivityObject()
2170     {
2171         $object = new ActivityObject();
2172
2173         if (Event::handle('StartActivityObjectFromNotice', array($this, &$object))) {
2174             $object->type    = $this->object_type ?: ActivityObject::NOTE;
2175             $object->id      = $this->getUri();
2176             //FIXME: = $object->title ?: sprintf(... because we might get a title from StartActivityObjectFromNotice
2177             $object->title   = sprintf('New %1$s by %2$s', ActivityObject::canonicalType($object->type), $this->getProfile()->getNickname());
2178             $object->content = $this->getRendered();
2179             $object->link    = $this->getUrl();
2180
2181             $object->extra[] = array('status_net', array('notice_id' => $this->id));
2182
2183             Event::handle('EndActivityObjectFromNotice', array($this, &$object));
2184         }
2185
2186         if (!$object instanceof ActivityObject) {
2187             common_log(LOG_ERR, 'Notice asActivityObject created something else for uri=='._ve($this->getUri()).': '._ve($object));
2188             throw new ServerException('Notice asActivityObject created something else.');
2189         }
2190
2191         return $object;
2192     }
2193
2194     /**
2195      * Determine which notice, if any, a new notice is in reply to.
2196      *
2197      * For conversation tracking, we try to see where this notice fits
2198      * in the tree. Beware that this may very well give false positives
2199      * and add replies to wrong threads (if there have been newer posts
2200      * by the same user as we're replying to).
2201      *
2202      * @param Profile $sender     Author profile
2203      * @param string  $content    Final notice content
2204      *
2205      * @return integer ID of replied-to notice, or null for not a reply.
2206      */
2207
2208     static function getInlineReplyTo(Profile $sender, $content)
2209     {
2210         // Is there an initial @ or T?
2211         if (preg_match('/^T ([A-Z0-9]{1,64}) /', $content, $match)
2212                 || preg_match('/^@([a-z0-9]{1,64})\s+/', $content, $match)) {
2213             $nickname = common_canonical_nickname($match[1]);
2214         } else {
2215             return null;
2216         }
2217
2218         // Figure out who that is.
2219         $recipient = common_relative_profile($sender, $nickname, common_sql_now());
2220
2221         if ($recipient instanceof Profile) {
2222             // Get their last notice
2223             $last = $recipient->getCurrentNotice();
2224             if ($last instanceof Notice) {
2225                 return $last;
2226             }
2227             // Maybe in the future we want to handle something else below
2228             // so don't return getCurrentNotice() immediately.
2229         }
2230
2231         return null;
2232     }
2233
2234     static function maxContent()
2235     {
2236         $contentlimit = common_config('notice', 'contentlimit');
2237         // null => use global limit (distinct from 0!)
2238         if (is_null($contentlimit)) {
2239             $contentlimit = common_config('site', 'textlimit');
2240         }
2241         return $contentlimit;
2242     }
2243
2244     static function contentTooLong($content)
2245     {
2246         $contentlimit = self::maxContent();
2247         return ($contentlimit > 0 && !empty($content) && (mb_strlen($content) > $contentlimit));
2248     }
2249
2250     /**
2251      * Convenience function for posting a repeat of an existing message.
2252      *
2253      * @param Profile $repeater Profile which is doing the repeat
2254      * @param string $source: posting source key, eg 'web', 'api', etc
2255      * @return Notice
2256      *
2257      * @throws Exception on failure or permission problems
2258      */
2259     function repeat(Profile $repeater, $source)
2260     {
2261         $author = $this->getProfile();
2262
2263         // TRANS: Message used to repeat a notice. RT is the abbreviation of 'retweet'.
2264         // TRANS: %1$s is the repeated user's name, %2$s is the repeated notice.
2265         $content = sprintf(_('RT @%1$s %2$s'),
2266                            $author->getNickname(),
2267                            $this->content);
2268
2269         $maxlen = self::maxContent();
2270         if ($maxlen > 0 && mb_strlen($content) > $maxlen) {
2271             // Web interface and current Twitter API clients will
2272             // pull the original notice's text, but some older
2273             // clients and RSS/Atom feeds will see this trimmed text.
2274             //
2275             // Unfortunately this is likely to lose tags or URLs
2276             // at the end of long notices.
2277             $content = mb_substr($content, 0, $maxlen - 4) . ' ...';
2278         }
2279
2280
2281         // Scope is same as this one's
2282         return self::saveNew($repeater->id,
2283                              $content,
2284                              $source,
2285                              array('repeat_of' => $this->id,
2286                                    'scope' => $this->scope));
2287     }
2288
2289     // These are supposed to be in chron order!
2290
2291     function repeatStream($limit=100)
2292     {
2293         $cache = Cache::instance();
2294
2295         if (empty($cache)) {
2296             $ids = $this->_repeatStreamDirect($limit);
2297         } else {
2298             $idstr = $cache->get(Cache::key('notice:repeats:'.$this->id));
2299             if ($idstr !== false) {
2300                 if (empty($idstr)) {
2301                         $ids = array();
2302                 } else {
2303                         $ids = explode(',', $idstr);
2304                 }
2305             } else {
2306                 $ids = $this->_repeatStreamDirect(100);
2307                 $cache->set(Cache::key('notice:repeats:'.$this->id), implode(',', $ids));
2308             }
2309             if ($limit < 100) {
2310                 // We do a max of 100, so slice down to limit
2311                 $ids = array_slice($ids, 0, $limit);
2312             }
2313         }
2314
2315         return NoticeStream::getStreamByIds($ids);
2316     }
2317
2318     function _repeatStreamDirect($limit)
2319     {
2320         $notice = new Notice();
2321
2322         $notice->selectAdd(); // clears it
2323         $notice->selectAdd('id');
2324
2325         $notice->repeat_of = $this->id;
2326
2327         $notice->orderBy('created, id'); // NB: asc!
2328
2329         if (!is_null($limit)) {
2330             $notice->limit(0, $limit);
2331         }
2332
2333         return $notice->fetchAll('id');
2334     }
2335
2336     static function locationOptions($lat, $lon, $location_id, $location_ns, $profile = null)
2337     {
2338         $options = array();
2339
2340         if (!empty($location_id) && !empty($location_ns)) {
2341             $options['location_id'] = $location_id;
2342             $options['location_ns'] = $location_ns;
2343
2344             $location = Location::fromId($location_id, $location_ns);
2345
2346             if ($location instanceof Location) {
2347                 $options['lat'] = $location->lat;
2348                 $options['lon'] = $location->lon;
2349             }
2350
2351         } else if (!empty($lat) && !empty($lon)) {
2352             $options['lat'] = $lat;
2353             $options['lon'] = $lon;
2354
2355             $location = Location::fromLatLon($lat, $lon);
2356
2357             if ($location instanceof Location) {
2358                 $options['location_id'] = $location->location_id;
2359                 $options['location_ns'] = $location->location_ns;
2360             }
2361         } else if (!empty($profile)) {
2362             if (isset($profile->lat) && isset($profile->lon)) {
2363                 $options['lat'] = $profile->lat;
2364                 $options['lon'] = $profile->lon;
2365             }
2366
2367             if (isset($profile->location_id) && isset($profile->location_ns)) {
2368                 $options['location_id'] = $profile->location_id;
2369                 $options['location_ns'] = $profile->location_ns;
2370             }
2371         }
2372
2373         return $options;
2374     }
2375
2376     function clearAttentions()
2377     {
2378         $att = new Attention();
2379         $att->notice_id = $this->getID();
2380
2381         if ($att->find()) {
2382             while ($att->fetch()) {
2383                 // Can't do delete() on the object directly since it won't remove all of it
2384                 $other = clone($att);
2385                 $other->delete();
2386             }
2387         }
2388     }
2389
2390     function clearReplies()
2391     {
2392         $replyNotice = new Notice();
2393         $replyNotice->reply_to = $this->id;
2394
2395         //Null any notices that are replies to this notice
2396
2397         if ($replyNotice->find()) {
2398             while ($replyNotice->fetch()) {
2399                 $orig = clone($replyNotice);
2400                 $replyNotice->reply_to = null;
2401                 $replyNotice->update($orig);
2402             }
2403         }
2404
2405         // Reply records
2406
2407         $reply = new Reply();
2408         $reply->notice_id = $this->id;
2409
2410         if ($reply->find()) {
2411             while($reply->fetch()) {
2412                 self::blow('reply:stream:%d', $reply->profile_id);
2413                 $reply->delete();
2414             }
2415         }
2416
2417         $reply->free();
2418     }
2419
2420     function clearLocation()
2421     {
2422         $loc = new Notice_location();
2423         $loc->notice_id = $this->id;
2424
2425         if ($loc->find()) {
2426             $loc->delete();
2427         }
2428     }
2429
2430     function clearFiles()
2431     {
2432         $f2p = new File_to_post();
2433
2434         $f2p->post_id = $this->id;
2435
2436         if ($f2p->find()) {
2437             while ($f2p->fetch()) {
2438                 $f2p->delete();
2439             }
2440         }
2441         // FIXME: decide whether to delete File objects
2442         // ...and related (actual) files
2443     }
2444
2445     function clearRepeats()
2446     {
2447         $repeatNotice = new Notice();
2448         $repeatNotice->repeat_of = $this->id;
2449
2450         //Null any notices that are repeats of this notice
2451
2452         if ($repeatNotice->find()) {
2453             while ($repeatNotice->fetch()) {
2454                 $orig = clone($repeatNotice);
2455                 $repeatNotice->repeat_of = null;
2456                 $repeatNotice->update($orig);
2457             }
2458         }
2459     }
2460
2461     function clearTags()
2462     {
2463         $tag = new Notice_tag();
2464         $tag->notice_id = $this->id;
2465
2466         if ($tag->find()) {
2467             while ($tag->fetch()) {
2468                 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, Cache::keyize($tag->tag));
2469                 self::blow('profile:notice_ids_tagged:%d:%s;last', $this->profile_id, Cache::keyize($tag->tag));
2470                 self::blow('notice_tag:notice_ids:%s', Cache::keyize($tag->tag));
2471                 self::blow('notice_tag:notice_ids:%s;last', Cache::keyize($tag->tag));
2472                 $tag->delete();
2473             }
2474         }
2475
2476         $tag->free();
2477     }
2478
2479     function clearGroupInboxes()
2480     {
2481         $gi = new Group_inbox();
2482
2483         $gi->notice_id = $this->id;
2484
2485         if ($gi->find()) {
2486             while ($gi->fetch()) {
2487                 self::blow('user_group:notice_ids:%d', $gi->group_id);
2488                 $gi->delete();
2489             }
2490         }
2491
2492         $gi->free();
2493     }
2494
2495     function distribute()
2496     {
2497         // We always insert for the author so they don't
2498         // have to wait
2499         Event::handle('StartNoticeDistribute', array($this));
2500
2501         // If there's a failure, we want to _force_
2502         // distribution at this point.
2503         try {
2504             $json = json_encode((object)array('id' => $this->getID(),
2505                                               'type' => 'Notice',
2506                                               ));
2507             $qm = QueueManager::get();
2508             $qm->enqueue($json, 'distrib');
2509         } catch (Exception $e) {
2510             // If the exception isn't transient, this
2511             // may throw more exceptions as DQH does
2512             // its own enqueueing. So, we ignore them!
2513             try {
2514                 $handler = new DistribQueueHandler();
2515                 $handler->handle($this);
2516             } catch (Exception $e) {
2517                 common_log(LOG_ERR, "emergency redistribution resulted in " . $e->getMessage());
2518             }
2519             // Re-throw so somebody smarter can handle it.
2520             throw $e;
2521         }
2522     }
2523
2524     function insert()
2525     {
2526         $result = parent::insert();
2527
2528         if ($result === false) {
2529             common_log_db_error($this, 'INSERT', __FILE__);
2530             // TRANS: Server exception thrown when a stored object entry cannot be saved.
2531             throw new ServerException('Could not save Notice');
2532         }
2533
2534         // Profile::hasRepeated() abuses pkeyGet(), so we
2535         // have to clear manually
2536         if (!empty($this->repeat_of)) {
2537             $c = self::memcache();
2538             if (!empty($c)) {
2539                 $ck = self::multicacheKey('Notice',
2540                                           array('profile_id' => $this->profile_id,
2541                                                 'repeat_of' => $this->repeat_of));
2542                 $c->delete($ck);
2543             }
2544         }
2545
2546         // Update possibly ID-dependent columns: URI, conversation
2547         // (now that INSERT has added the notice's local id)
2548         $orig = clone($this);
2549         $changed = false;
2550
2551         // We can only get here if it's a local notice, since remote notices
2552         // should've bailed out earlier due to lacking a URI.
2553         if (empty($this->uri)) {
2554             $this->uri = sprintf('%s%s=%d:%s=%s',
2555                                 TagURI::mint(),
2556                                 'noticeId', $this->id,
2557                                 'objectType', $this->getObjectType(true));
2558             $changed = true;
2559         }
2560
2561         if ($changed && $this->update($orig) === false) {
2562             common_log_db_error($notice, 'UPDATE', __FILE__);
2563             // TRANS: Server exception thrown when a notice cannot be updated.
2564             throw new ServerException(_('Problem saving notice.'));
2565         }
2566
2567         $this->blowOnInsert();
2568
2569         return $result;
2570     }
2571
2572     /**
2573      * Get the source of the notice
2574      *
2575      * @return Notice_source $ns A notice source object. 'code' is the only attribute
2576      *                           guaranteed to be populated.
2577      */
2578     function getSource()
2579     {
2580         if (empty($this->source)) {
2581             return false;
2582         }
2583
2584         $ns = new Notice_source();
2585         switch ($this->source) {
2586         case 'web':
2587         case 'xmpp':
2588         case 'mail':
2589         case 'omb':
2590         case 'system':
2591         case 'api':
2592             $ns->code = $this->source;
2593             break;
2594         default:
2595             $ns = Notice_source::getKV($this->source);
2596             if (!$ns) {
2597                 $ns = new Notice_source();
2598                 $ns->code = $this->source;
2599                 $app = Oauth_application::getKV('name', $this->source);
2600                 if ($app) {
2601                     $ns->name = $app->name;
2602                     $ns->url  = $app->source_url;
2603                 }
2604             }
2605             break;
2606         }
2607
2608         return $ns;
2609     }
2610
2611     /**
2612      * Determine whether the notice was locally created
2613      *
2614      * @return boolean locality
2615      */
2616
2617     public function isLocal()
2618     {
2619         $is_local = intval($this->is_local);
2620         return ($is_local === self::LOCAL_PUBLIC || $is_local === self::LOCAL_NONPUBLIC);
2621     }
2622
2623     public function getScope()
2624     {
2625         return intval($this->scope);
2626     }
2627
2628     public function isRepeat()
2629     {
2630         return !empty($this->repeat_of);
2631     }
2632
2633     /**
2634      * Get the list of hash tags saved with this notice.
2635      *
2636      * @return array of strings
2637      */
2638     public function getTags()
2639     {
2640         $tags = array();
2641
2642         $keypart = sprintf('notice:tags:%d', $this->id);
2643
2644         $tagstr = self::cacheGet($keypart);
2645
2646         if ($tagstr !== false) {
2647             $tags = explode(',', $tagstr);
2648         } else {
2649             $tag = new Notice_tag();
2650             $tag->notice_id = $this->id;
2651             if ($tag->find()) {
2652                 while ($tag->fetch()) {
2653                     $tags[] = $tag->tag;
2654                 }
2655             }
2656             self::cacheSet($keypart, implode(',', $tags));
2657         }
2658
2659         return $tags;
2660     }
2661
2662     static private function utcDate($dt)
2663     {
2664         $dateStr = date('d F Y H:i:s', strtotime($dt));
2665         $d = new DateTime($dateStr, new DateTimeZone('UTC'));
2666         return $d->format(DATE_W3C);
2667     }
2668
2669     /**
2670      * Look up the creation timestamp for a given notice ID, even
2671      * if it's been deleted.
2672      *
2673      * @param int $id
2674      * @return mixed string recorded creation timestamp, or false if can't be found
2675      */
2676     public static function getAsTimestamp($id)
2677     {
2678         if (empty($id)) {
2679             throw new EmptyIdException('Notice');
2680         }
2681
2682         $timestamp = null;
2683         if (Event::handle('GetNoticeSqlTimestamp', array($id, &$timestamp))) {
2684             // getByID throws exception if $id isn't found
2685             $notice = Notice::getByID($id);
2686             $timestamp = $notice->created;
2687         }
2688
2689         if (empty($timestamp)) {
2690             throw new ServerException('No timestamp found for Notice with id=='._ve($id));
2691         }
2692         return $timestamp;
2693     }
2694
2695     /**
2696      * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2697      * parameter, matching notices posted after the given one (exclusive).
2698      *
2699      * If the referenced notice can't be found, will return false.
2700      *
2701      * @param int $id
2702      * @param string $idField
2703      * @param string $createdField
2704      * @return mixed string or false if no match
2705      */
2706     public static function whereSinceId($id, $idField='id', $createdField='created')
2707     {
2708         try {
2709             $since = Notice::getAsTimestamp($id);
2710         } catch (Exception $e) {
2711             return false;
2712         }
2713         return sprintf("($createdField = '%s' and $idField > %d) or ($createdField > '%s')", $since, $id, $since);
2714     }
2715
2716     /**
2717      * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2718      * parameter, matching notices posted after the given one (exclusive), and
2719      * if necessary add it to the data object's query.
2720      *
2721      * @param DB_DataObject $obj
2722      * @param int $id
2723      * @param string $idField
2724      * @param string $createdField
2725      * @return mixed string or false if no match
2726      */
2727     public static function addWhereSinceId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2728     {
2729         $since = self::whereSinceId($id, $idField, $createdField);
2730         if ($since) {
2731             $obj->whereAdd($since);
2732         }
2733     }
2734
2735     /**
2736      * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2737      * parameter, matching notices posted before the given one (inclusive).
2738      *
2739      * If the referenced notice can't be found, will return false.
2740      *
2741      * @param int $id
2742      * @param string $idField
2743      * @param string $createdField
2744      * @return mixed string or false if no match
2745      */
2746     public static function whereMaxId($id, $idField='id', $createdField='created')
2747     {
2748         try {
2749             $max = Notice::getAsTimestamp($id);
2750         } catch (Exception $e) {
2751             return false;
2752         }
2753         return sprintf("($createdField < '%s') or ($createdField = '%s' and $idField <= %d)", $max, $max, $id);
2754     }
2755
2756     /**
2757      * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2758      * parameter, matching notices posted before the given one (inclusive), and
2759      * if necessary add it to the data object's query.
2760      *
2761      * @param DB_DataObject $obj
2762      * @param int $id
2763      * @param string $idField
2764      * @param string $createdField
2765      * @return mixed string or false if no match
2766      */
2767     public static function addWhereMaxId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2768     {
2769         $max = self::whereMaxId($id, $idField, $createdField);
2770         if ($max) {
2771             $obj->whereAdd($max);
2772         }
2773     }
2774
2775     public function isPublic()
2776     {
2777         $is_local = intval($this->is_local);
2778         return !($is_local === Notice::LOCAL_NONPUBLIC || $is_local === Notice::GATEWAY);
2779     }
2780
2781     /**
2782      * Check that the given profile is allowed to read, respond to, or otherwise
2783      * act on this notice.
2784      *
2785      * The $scope member is a bitmask of scopes, representing a logical AND of the
2786      * scope requirement. So, 0x03 (Notice::ADDRESSEE_SCOPE | Notice::SITE_SCOPE) means
2787      * "only visible to people who are mentioned in the notice AND are users on this site."
2788      * Users on the site who are not mentioned in the notice will not be able to see the
2789      * notice.
2790      *
2791      * @param Profile $profile The profile to check; pass null to check for public/unauthenticated users.
2792      *
2793      * @return boolean whether the profile is in the notice's scope
2794      */
2795     function inScope($profile)
2796     {
2797         if (is_null($profile)) {
2798             $keypart = sprintf('notice:in-scope-for:%d:null', $this->id);
2799         } else {
2800             $keypart = sprintf('notice:in-scope-for:%d:%d', $this->id, $profile->id);
2801         }
2802
2803         $result = self::cacheGet($keypart);
2804
2805         if ($result === false) {
2806             $bResult = false;
2807             if (Event::handle('StartNoticeInScope', array($this, $profile, &$bResult))) {
2808                 $bResult = $this->_inScope($profile);
2809                 Event::handle('EndNoticeInScope', array($this, $profile, &$bResult));
2810             }
2811             $result = ($bResult) ? 1 : 0;
2812             self::cacheSet($keypart, $result, 0, 300);
2813         }
2814
2815         return ($result == 1) ? true : false;
2816     }
2817
2818     protected function _inScope($profile)
2819     {
2820         $scope = is_null($this->scope) ? self::defaultScope() : $this->getScope();
2821
2822         if ($scope === 0 && !$this->getProfile()->isPrivateStream()) { // Not scoping, so it is public.
2823             return !$this->isHiddenSpam($profile);
2824         }
2825
2826         // If there's scope, anon cannot be in scope
2827         if (empty($profile)) {
2828             return false;
2829         }
2830
2831         // Author is always in scope
2832         if ($this->profile_id == $profile->id) {
2833             return true;
2834         }
2835
2836         // Only for users on this site
2837         if (($scope & Notice::SITE_SCOPE) && !$profile->isLocal()) {
2838             return false;
2839         }
2840
2841         // Only for users mentioned in the notice
2842         if ($scope & Notice::ADDRESSEE_SCOPE) {
2843
2844             $reply = Reply::pkeyGet(array('notice_id' => $this->id,
2845                                          'profile_id' => $profile->id));
2846
2847             if (!$reply instanceof Reply) {
2848                 return false;
2849             }
2850         }
2851
2852         // Only for members of the given group
2853         if ($scope & Notice::GROUP_SCOPE) {
2854
2855             // XXX: just query for the single membership
2856
2857             $groups = $this->getGroups();
2858
2859             $foundOne = false;
2860
2861             foreach ($groups as $group) {
2862                 if ($profile->isMember($group)) {
2863                     $foundOne = true;
2864                     break;
2865                 }
2866             }
2867
2868             if (!$foundOne) {
2869                 return false;
2870             }
2871         }
2872
2873         if ($scope & Notice::FOLLOWER_SCOPE || $this->getProfile()->isPrivateStream()) {
2874
2875             if (!Subscription::exists($profile, $this->getProfile())) {
2876                 return false;
2877             }
2878         }
2879
2880         return !$this->isHiddenSpam($profile);
2881     }
2882
2883     function isHiddenSpam($profile) {
2884
2885         // Hide posts by silenced users from everyone but moderators.
2886
2887         if (common_config('notice', 'hidespam')) {
2888
2889             try {
2890                 $author = $this->getProfile();
2891             } catch(Exception $e) {
2892                 // If we can't get an author, keep it hidden.
2893                 // XXX: technically not spam, but, whatever.
2894                 return true;
2895             }
2896
2897             if ($author->hasRole(Profile_role::SILENCED)) {
2898                 if (!$profile instanceof Profile || (($profile->id !== $author->id) && (!$profile->hasRight(Right::REVIEWSPAM)))) {
2899                     return true;
2900                 }
2901             }
2902         }
2903
2904         return false;
2905     }
2906
2907     public function hasParent()
2908     {
2909         try {
2910             $this->getParent();
2911         } catch (NoParentNoticeException $e) {
2912             return false;
2913         }
2914         return true;
2915     }
2916
2917     public function getParent()
2918     {
2919         $reply_to_id = null;
2920
2921         if (empty($this->reply_to)) {
2922             throw new NoParentNoticeException($this);
2923         }
2924
2925         // The reply_to ID in the table Notice could exist with a number
2926         // however, the replied to notice might not exist in the database.
2927         // Thus we need to catch the exception and throw the NoParentNoticeException else
2928         // the timeline will not display correctly.
2929         try {
2930             $reply_to_id = self::getByID($this->reply_to);
2931         } catch(Exception $e){
2932             throw new NoParentNoticeException($this);
2933         }
2934
2935         return $reply_to_id;
2936     }
2937
2938     /**
2939      * Magic function called at serialize() time.
2940      *
2941      * We use this to drop a couple process-specific references
2942      * from DB_DataObject which can cause trouble in future
2943      * processes.
2944      *
2945      * @return array of variable names to include in serialization.
2946      */
2947
2948     function __sleep()
2949     {
2950         $vars = parent::__sleep();
2951         $skip = array('_profile', '_groups', '_attachments', '_faves', '_replies', '_repeats');
2952         return array_diff($vars, $skip);
2953     }
2954
2955     static function defaultScope()
2956     {
2957         $scope = common_config('notice', 'defaultscope');
2958         if (is_null($scope)) {
2959                 if (common_config('site', 'private')) {
2960                         $scope = 1;
2961                 } else {
2962                         $scope = 0;
2963                 }
2964         }
2965         return $scope;
2966     }
2967
2968         static function fillProfiles($notices)
2969         {
2970                 $map = self::getProfiles($notices);
2971                 foreach ($notices as $entry=>$notice) {
2972             try {
2973                         if (array_key_exists($notice->profile_id, $map)) {
2974                                 $notice->_setProfile($map[$notice->profile_id]);
2975                         }
2976             } catch (NoProfileException $e) {
2977                 common_log(LOG_WARNING, "Failed to fill profile in Notice with non-existing entry for profile_id: {$e->profile_id}");
2978                 unset($notices[$entry]);
2979             }
2980                 }
2981
2982                 return array_values($map);
2983         }
2984
2985         static function getProfiles(&$notices)
2986         {
2987                 $ids = array();
2988                 foreach ($notices as $notice) {
2989                         $ids[] = $notice->profile_id;
2990                 }
2991                 $ids = array_unique($ids);
2992                 return Profile::pivotGet('id', $ids);
2993         }
2994
2995         static function fillGroups(&$notices)
2996         {
2997         $ids = self::_idsOf($notices);
2998         $gis = Group_inbox::listGet('notice_id', $ids);
2999         $gids = array();
3000
3001                 foreach ($gis as $id => $gi) {
3002                     foreach ($gi as $g)
3003                     {
3004                         $gids[] = $g->group_id;
3005                     }
3006                 }
3007
3008                 $gids = array_unique($gids);
3009                 $group = User_group::pivotGet('id', $gids);
3010                 foreach ($notices as $notice)
3011                 {
3012                         $grps = array();
3013                         $gi = $gis[$notice->id];
3014                         foreach ($gi as $g) {
3015                             $grps[] = $group[$g->group_id];
3016                         }
3017                     $notice->_setGroups($grps);
3018                 }
3019         }
3020
3021     static function _idsOf(array &$notices)
3022     {
3023                 $ids = array();
3024                 foreach ($notices as $notice) {
3025                         $ids[$notice->id] = true;
3026                 }
3027                 return array_keys($ids);
3028     }
3029
3030     static function fillAttachments(&$notices)
3031     {
3032         $ids = self::_idsOf($notices);
3033         $f2pMap = File_to_post::listGet('post_id', $ids);
3034                 $fileIds = array();
3035                 foreach ($f2pMap as $noticeId => $f2ps) {
3036             foreach ($f2ps as $f2p) {
3037                 $fileIds[] = $f2p->file_id;
3038             }
3039         }
3040
3041         $fileIds = array_unique($fileIds);
3042                 $fileMap = File::pivotGet('id', $fileIds);
3043                 foreach ($notices as $notice)
3044                 {
3045                         $files = array();
3046                         $f2ps = $f2pMap[$notice->id];
3047                         foreach ($f2ps as $f2p) {
3048                 if (!isset($fileMap[$f2p->file_id])) {
3049                     // We have probably deleted value from fileMap since
3050                     // it as a NULL entry (see the following elseif).
3051                     continue;
3052                 } elseif (is_null($fileMap[$f2p->file_id])) {
3053                     // If the file id lookup returned a NULL value, it doesn't
3054                     // exist in our file table! So this is a remnant file_to_post
3055                     // entry that is no longer valid and should be removed.
3056                     common_debug('ATTACHMENT deleting f2p for post_id='.$f2p->post_id.' file_id='.$f2p->file_id);
3057                     $f2p->delete();
3058                     unset($fileMap[$f2p->file_id]);
3059                     continue;
3060                 }
3061                             $files[] = $fileMap[$f2p->file_id];
3062                         }
3063                     $notice->_setAttachments($files);
3064                 }
3065     }
3066
3067     static function fillReplies(&$notices)
3068     {
3069         $ids = self::_idsOf($notices);
3070         $replyMap = Reply::listGet('notice_id', $ids);
3071         foreach ($notices as $notice) {
3072             $replies = $replyMap[$notice->id];
3073             $ids = array();
3074             foreach ($replies as $reply) {
3075                 $ids[] = $reply->profile_id;
3076             }
3077             $notice->_setReplies($ids);
3078         }
3079     }
3080
3081     static public function beforeSchemaUpdate()
3082     {
3083         $table = strtolower(get_called_class());
3084         $schema = Schema::get();
3085         $schemadef = $schema->getTableDef($table);
3086
3087         // 2015-09-04 We move Notice location data to Notice_location
3088         // First we see if we have to do this at all
3089         if (!isset($schemadef['fields']['lat'])
3090                 && !isset($schemadef['fields']['lon'])
3091                 && !isset($schemadef['fields']['location_id'])
3092                 && !isset($schemadef['fields']['location_ns'])) {
3093             // We have already removed the location fields, so no need to migrate.
3094             return;
3095         }
3096         // Then we make sure the Notice_location table is created!
3097         $schema->ensureTable('notice_location', Notice_location::schemaDef());
3098
3099         // Then we continue on our road to migration!
3100         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)";
3101
3102         $notice = new Notice();
3103         $notice->query(sprintf('SELECT id, lat, lon, location_id, location_ns FROM %1$s ' .
3104                              'WHERE lat IS NOT NULL ' .
3105                                 'OR lon IS NOT NULL ' .
3106                                 'OR location_id IS NOT NULL ' .
3107                                 'OR location_ns IS NOT NULL',
3108                              $schema->quoteIdentifier($table)));
3109         print "\nFound {$notice->N} notices with location data, inserting";
3110         while ($notice->fetch()) {
3111             $notloc = Notice_location::getKV('notice_id', $notice->id);
3112             if ($notloc instanceof Notice_location) {
3113                 print "-";
3114                 continue;
3115             }
3116             $notloc = new Notice_location();
3117             $notloc->notice_id = $notice->id;
3118             $notloc->lat= $notice->lat;
3119             $notloc->lon= $notice->lon;
3120             $notloc->location_id= $notice->location_id;
3121             $notloc->location_ns= $notice->location_ns;
3122             $notloc->insert();
3123             print ".";
3124         }
3125         print "\n";
3126     }
3127 }