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