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