classes/Notice.php

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