classes/Notice.php

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