classes/Notice.php

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