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