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