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