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