classes/Notice.php

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