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