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