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