classes/Notice.php

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