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