classes/Notice.php

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