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