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