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