classes/Notice.php

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