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
 723         $keypart = sprintf('notice:file_ids:%d', $this->id);
 724
 725         $idstr = self::cacheGet($keypart);
 726
 727         if ($idstr !== false) {
 728             $ids = explode(',', $idstr);
 729         } else {
 730             $ids = array();
 731             $f2p = new File_to_post;
 732             $f2p->post_id = $this->id;
 733             if ($f2p->find()) {
 734                 while ($f2p->fetch()) {
 735                     $ids[] = $f2p->file_id;
 736                 }
 737             }
 738             self::cacheSet($keypart, implode(',', $ids));
 739         }
 740
 741         $att = array();
 742
 743         foreach ($ids as $id) {
 744             $f = File::staticGet('id', $id);
 745             if (!empty($f)) {
 746                 $att[] = clone($f);
 747             }
 748         }
 749
 750         return $att;
 751     }
 752
 753
 754     function publicStream($offset=0, $limit=20, $since_id=0, $max_id=0)
 755     {
 756         $stream = new PublicNoticeStream();
 757         return $stream->getNotices($offset, $limit, $since_id, $max_id);
 758     }
 759
 760
 761     function conversationStream($id, $offset=0, $limit=20, $since_id=0, $max_id=0)
 762     {
 763         $stream = new ConversationNoticeStream($id);
 764
 765         return $stream->getNotices($offset, $limit, $since_id, $max_id);
 766     }
 767
 768     /**
 769      * Is this notice part of an active conversation?
 770      *
 771      * @return boolean true if other messages exist in the same
 772      *                 conversation, false if this is the only one
 773      */
 774     function hasConversation()
 775     {
 776         if (!empty($this->conversation)) {
 777             $conversation = Notice::conversationStream(
 778                 $this->conversation,
 779                 1,
 780                 1
 781             );
 782
 783             if ($conversation->N > 0) {
 784                 return true;
 785             }
 786         }
 787         return false;
 788     }
 789
 790     /**
 791      * Grab the earliest notice from this conversation.
 792      *
 793      * @return Notice or null
 794      */
 795     function conversationRoot()
 796     {
 797         if (!empty($this->conversation)) {
 798             $c = self::memcache();
 799
 800             $key = Cache::key('notice:conversation_root:' . $this->conversation);
 801             $notice = $c->get($key);
 802             if ($notice) {
 803                 return $notice;
 804             }
 805
 806             $notice = new Notice();
 807             $notice->conversation = $this->conversation;
 808             $notice->orderBy('CREATED');
 809             $notice->limit(1);
 810             $notice->find(true);
 811
 812             if ($notice->N) {
 813                 $c->set($key, $notice);
 814                 return $notice;
 815             }
 816         }
 817         return null;
 818     }
 819     /**
 820      * Pull up a full list of local recipients who will be getting
 821      * this notice in their inbox. Results will be cached, so don't
 822      * change the input data wily-nilly!
 823      *
 824      * @param array $groups optional list of Group objects;
 825      *              if left empty, will be loaded from group_inbox records
 826      * @param array $recipient optional list of reply profile ids
 827      *              if left empty, will be loaded from reply records
 828      * @return array associating recipient user IDs with an inbox source constant
 829      */
 830     function whoGets($groups=null, $recipients=null)
 831     {
 832         $c = self::memcache();
 833
 834         if (!empty($c)) {
 835             $ni = $c->get(Cache::key('notice:who_gets:'.$this->id));
 836             if ($ni !== false) {
 837                 return $ni;
 838             }
 839         }
 840
 841         if (is_null($groups)) {
 842             $groups = $this->getGroups();
 843         }
 844
 845         if (is_null($recipients)) {
 846             $recipients = $this->getReplies();
 847         }
 848
 849         $users = $this->getSubscribedUsers();
 850
 851         // FIXME: kind of ignoring 'transitional'...
 852         // we'll probably stop supporting inboxless mode
 853         // in 0.9.x
 854
 855         $ni = array();
 856
 857         // Give plugins a chance to add folks in at start...
 858         if (Event::handle('StartNoticeWhoGets', array($this, &$ni))) {
 859
 860             foreach ($users as $id) {
 861                 $ni[$id] = NOTICE_INBOX_SOURCE_SUB;
 862             }
 863
 864             foreach ($groups as $group) {
 865                 $users = $group->getUserMembers();
 866                 foreach ($users as $id) {
 867                     if (!array_key_exists($id, $ni)) {
 868                         $ni[$id] = NOTICE_INBOX_SOURCE_GROUP;
 869                     }
 870                 }
 871             }
 872
 873             foreach ($recipients as $recipient) {
 874                 if (!array_key_exists($recipient, $ni)) {
 875                     $ni[$recipient] = NOTICE_INBOX_SOURCE_REPLY;
 876                 }
 877             }
 878
 879             // Exclude any deleted, non-local, or blocking recipients.
 880             $profile = $this->getProfile();
 881             $originalProfile = null;
 882             if ($this->repeat_of) {
 883                 // Check blocks against the original notice's poster as well.
 884                 $original = Notice::staticGet('id', $this->repeat_of);
 885                 if ($original) {
 886                     $originalProfile = $original->getProfile();
 887                 }
 888             }
 889             foreach ($ni as $id => $source) {
 890                 $user = User::staticGet('id', $id);
 891                 if (empty($user) || $user->hasBlocked($profile) ||
 892                     ($originalProfile && $user->hasBlocked($originalProfile))) {
 893                     unset($ni[$id]);
 894                 }
 895             }
 896
 897             // Give plugins a chance to filter out...
 898             Event::handle('EndNoticeWhoGets', array($this, &$ni));
 899         }
 900
 901         if (!empty($c)) {
 902             // XXX: pack this data better
 903             $c->set(Cache::key('notice:who_gets:'.$this->id), $ni);
 904         }
 905
 906         return $ni;
 907     }
 908
 909     /**
 910      * Adds this notice to the inboxes of each local user who should receive
 911      * it, based on author subscriptions, group memberships, and @-replies.
 912      *
 913      * Warning: running a second time currently will make items appear
 914      * multiple times in users' inboxes.
 915      *
 916      * @fixme make more robust against errors
 917      * @fixme break up massive deliveries to smaller background tasks
 918      *
 919      * @param array $groups optional list of Group objects;
 920      *              if left empty, will be loaded from group_inbox records
 921      * @param array $recipient optional list of reply profile ids
 922      *              if left empty, will be loaded from reply records
 923      */
 924     function addToInboxes($groups=null, $recipients=null)
 925     {
 926         $ni = $this->whoGets($groups, $recipients);
 927
 928         $ids = array_keys($ni);
 929
 930         // We remove the author (if they're a local user),
 931         // since we'll have already done this in distribute()
 932
 933         $i = array_search($this->profile_id, $ids);
 934
 935         if ($i !== false) {
 936             unset($ids[$i]);
 937         }
 938
 939         // Bulk insert
 940
 941         Inbox::bulkInsert($this->id, $ids);
 942
 943         return;
 944     }
 945
 946     function getSubscribedUsers()
 947     {
 948         $user = new User();
 949
 950         if(common_config('db','quote_identifiers'))
 951           $user_table = '"user"';
 952         else $user_table = 'user';
 953
 954         $qry =
 955           'SELECT id ' .
 956           'FROM '. $user_table .' JOIN subscription '.
 957           'ON '. $user_table .'.id = subscription.subscriber ' .
 958           'WHERE subscription.subscribed = %d ';
 959
 960         $user->query(sprintf($qry, $this->profile_id));
 961
 962         $ids = array();
 963
 964         while ($user->fetch()) {
 965             $ids[] = $user->id;
 966         }
 967
 968         $user->free();
 969
 970         return $ids;
 971     }
 972
 973     /**
 974      * Record this notice to the given group inboxes for delivery.
 975      * Overrides the regular parsing of !group markup.
 976      *
 977      * @param string $group_ids
 978      * @fixme might prefer URIs as identifiers, as for replies?
 979      *        best with generalizations on user_group to support
 980      *        remote groups better.
 981      */
 982     function saveKnownGroups($group_ids)
 983     {
 984         if (!is_array($group_ids)) {
 985             // TRANS: Server exception thrown when no array is provided to the method saveKnownGroups().
 986             throw new ServerException(_('Bad type provided to saveKnownGroups.'));
 987         }
 988
 989         $groups = array();
 990         foreach (array_unique($group_ids) as $id) {
 991             $group = User_group::staticGet('id', $id);
 992             if ($group) {
 993                 common_log(LOG_ERR, "Local delivery to group id $id, $group->nickname");
 994                 $result = $this->addToGroupInbox($group);
 995                 if (!$result) {
 996                     common_log_db_error($gi, 'INSERT', __FILE__);
 997                 }
 998
 999                 // we automatically add a tag for every group name, too
1000
1001                 $tag = Notice_tag::pkeyGet(array('tag' => common_canonical_tag($group->nickname),
1002                                                  'notice_id' => $this->id));
1003
1004                 if (is_null($tag)) {
1005                     $this->saveTag($group->nickname);
1006                 }
1007
1008                 $groups[] = clone($group);
1009             } else {
1010                 common_log(LOG_ERR, "Local delivery to group id $id skipped, doesn't exist");
1011             }
1012         }
1013
1014         return $groups;
1015     }
1016
1017     /**
1018      * Parse !group delivery and record targets into group_inbox.
1019      * @return array of Group objects
1020      */
1021     function saveGroups()
1022     {
1023         // Don't save groups for repeats
1024
1025         if (!empty($this->repeat_of)) {
1026             return array();
1027         }
1028
1029         $profile = $this->getProfile();
1030
1031         $groups = self::groupsFromText($this->content, $profile);
1032
1033         /* Add them to the database */
1034
1035         foreach ($groups as $group) {
1036             /* XXX: remote groups. */
1037
1038             if (empty($group)) {
1039                 continue;
1040             }
1041
1042
1043             if ($profile->isMember($group)) {
1044
1045                 $result = $this->addToGroupInbox($group);
1046
1047                 if (!$result) {
1048                     common_log_db_error($gi, 'INSERT', __FILE__);
1049                 }
1050
1051                 $groups[] = clone($group);
1052             }
1053         }
1054
1055         return $groups;
1056     }
1057
1058     function addToGroupInbox($group)
1059     {
1060         $gi = Group_inbox::pkeyGet(array('group_id' => $group->id,
1061                                          'notice_id' => $this->id));
1062
1063         if (empty($gi)) {
1064
1065             $gi = new Group_inbox();
1066
1067             $gi->group_id  = $group->id;
1068             $gi->notice_id = $this->id;
1069             $gi->created   = $this->created;
1070
1071             $result = $gi->insert();
1072
1073             if (!$result) {
1074                 common_log_db_error($gi, 'INSERT', __FILE__);
1075                 // TRANS: Server exception thrown when an update for a group inbox fails.
1076                 throw new ServerException(_('Problem saving group inbox.'));
1077             }
1078
1079             self::blow('user_group:notice_ids:%d', $gi->group_id);
1080         }
1081
1082         return true;
1083     }
1084
1085     /**
1086      * Save reply records indicating that this notice needs to be
1087      * delivered to the local users with the given URIs.
1088      *
1089      * Since this is expected to be used when saving foreign-sourced
1090      * messages, we won't deliver to any remote targets as that's the
1091      * source service's responsibility.
1092      *
1093      * Mail notifications etc will be handled later.
1094      *
1095      * @param array of unique identifier URIs for recipients
1096      */
1097     function saveKnownReplies($uris)
1098     {
1099         if (empty($uris)) {
1100             return;
1101         }
1102
1103         $sender = Profile::staticGet($this->profile_id);
1104
1105         foreach (array_unique($uris) as $uri) {
1106
1107             $profile = Profile::fromURI($uri);
1108
1109             if (empty($profile)) {
1110                 common_log(LOG_WARNING, "Unable to determine profile for URI '$uri'");
1111                 continue;
1112             }
1113
1114             if ($profile->hasBlocked($sender)) {
1115                 common_log(LOG_INFO, "Not saving reply to profile {$profile->id} ($uri) from sender {$sender->id} because of a block.");
1116                 continue;
1117             }
1118
1119             $reply = new Reply();
1120
1121             $reply->notice_id  = $this->id;
1122             $reply->profile_id = $profile->id;
1123             $reply->modified   = $this->created;
1124
1125             common_log(LOG_INFO, __METHOD__ . ": saving reply: notice $this->id to profile $profile->id");
1126
1127             $id = $reply->insert();
1128         }
1129
1130         return;
1131     }
1132
1133     /**
1134      * Pull @-replies from this message's content in StatusNet markup format
1135      * and save reply records indicating that this message needs to be
1136      * delivered to those users.
1137      *
1138      * Mail notifications to local profiles will be sent later.
1139      *
1140      * @return array of integer profile IDs
1141      */
1142
1143     function saveReplies()
1144     {
1145         // Don't save reply data for repeats
1146
1147         if (!empty($this->repeat_of)) {
1148             return array();
1149         }
1150
1151         $sender = Profile::staticGet($this->profile_id);
1152
1153         // @todo ideally this parser information would only
1154         // be calculated once.
1155
1156         $mentions = common_find_mentions($this->content, $this);
1157
1158         $replied = array();
1159
1160         // store replied only for first @ (what user/notice what the reply directed,
1161         // we assume first @ is it)
1162
1163         foreach ($mentions as $mention) {
1164
1165             foreach ($mention['mentioned'] as $mentioned) {
1166
1167                 // skip if they're already covered
1168
1169                 if (!empty($replied[$mentioned->id])) {
1170                     continue;
1171                 }
1172
1173                 // Don't save replies from blocked profile to local user
1174
1175                 $mentioned_user = User::staticGet('id', $mentioned->id);
1176                 if (!empty($mentioned_user) && $mentioned_user->hasBlocked($sender)) {
1177                     continue;
1178                 }
1179
1180                 $reply = new Reply();
1181
1182                 $reply->notice_id  = $this->id;
1183                 $reply->profile_id = $mentioned->id;
1184                 $reply->modified   = $this->created;
1185
1186                 $id = $reply->insert();
1187
1188                 if (!$id) {
1189                     common_log_db_error($reply, 'INSERT', __FILE__);
1190                     // TRANS: Server exception thrown when a reply cannot be saved.
1191                     // TRANS: %1$d is a notice ID, %2$d is the ID of the mentioned user.
1192                     throw new ServerException(sprintf(_('Could not save reply for %1$d, %2$d.'), $this->id, $mentioned->id));
1193                 } else {
1194                     $replied[$mentioned->id] = 1;
1195                     self::blow('reply:stream:%d', $mentioned->id);
1196                 }
1197             }
1198         }
1199
1200         $recipientIds = array_keys($replied);
1201
1202         return $recipientIds;
1203     }
1204
1205     /**
1206      * Pull the complete list of @-reply targets for this notice.
1207      *
1208      * @return array of integer profile ids
1209      */
1210     function getReplies()
1211     {
1212         $keypart = sprintf('notice:reply_ids:%d', $this->id);
1213
1214         $idstr = self::cacheGet($keypart);
1215
1216         if ($idstr !== false) {
1217             $ids = explode(',', $idstr);
1218         } else {
1219             $ids = array();
1220
1221             $reply = new Reply();
1222             $reply->selectAdd();
1223             $reply->selectAdd('profile_id');
1224             $reply->notice_id = $this->id;
1225
1226             if ($reply->find()) {
1227                 while($reply->fetch()) {
1228                     $ids[] = $reply->profile_id;
1229                 }
1230             }
1231             self::cacheSet($keypart, implode(',', $ids));
1232         }
1233
1234         return $ids;
1235     }
1236
1237     /**
1238      * Send e-mail notifications to local @-reply targets.
1239      *
1240      * Replies must already have been saved; this is expected to be run
1241      * from the distrib queue handler.
1242      */
1243     function sendReplyNotifications()
1244     {
1245         // Don't send reply notifications for repeats
1246
1247         if (!empty($this->repeat_of)) {
1248             return array();
1249         }
1250
1251         $recipientIds = $this->getReplies();
1252
1253         foreach ($recipientIds as $recipientId) {
1254             $user = User::staticGet('id', $recipientId);
1255             if (!empty($user)) {
1256                 mail_notify_attn($user, $this);
1257             }
1258         }
1259     }
1260
1261     /**
1262      * Pull list of groups this notice needs to be delivered to,
1263      * as previously recorded by saveGroups() or saveKnownGroups().
1264      *
1265      * @return array of Group objects
1266      */
1267     function getGroups()
1268     {
1269         // Don't save groups for repeats
1270
1271         if (!empty($this->repeat_of)) {
1272             return array();
1273         }
1274
1275         $ids = array();
1276
1277         $keypart = sprintf('notice:groups:%d', $this->id);
1278
1279         $idstr = self::cacheGet($keypart);
1280
1281         if ($idstr !== false) {
1282             $ids = explode(',', $idstr);
1283         } else {
1284             $gi = new Group_inbox();
1285
1286             $gi->selectAdd();
1287             $gi->selectAdd('group_id');
1288
1289             $gi->notice_id = $this->id;
1290
1291             if ($gi->find()) {
1292                 while ($gi->fetch()) {
1293                     $ids[] = $gi->group_id;
1294                 }
1295             }
1296
1297             self::cacheSet($keypart, implode(',', $ids));
1298         }
1299
1300         $groups = array();
1301
1302         foreach ($ids as $id) {
1303             $group = User_group::staticGet('id', $id);
1304             if ($group) {
1305                 $groups[] = $group;
1306             }
1307         }
1308
1309         return $groups;
1310     }
1311
1312     /**
1313      * Convert a notice into an activity for export.
1314      *
1315      * @param User $cur Current user
1316      *
1317      * @return Activity activity object representing this Notice.
1318      */
1319
1320     function asActivity($cur)
1321     {
1322         $act = self::cacheGet(Cache::codeKey('notice:as-activity:'.$this->id));
1323
1324         if (!empty($act)) {
1325             return $act;
1326         }
1327         $act = new Activity();
1328
1329         if (Event::handle('StartNoticeAsActivity', array($this, &$act))) {
1330
1331             $profile = $this->getProfile();
1332
1333             $act->actor            = ActivityObject::fromProfile($profile);
1334             $act->actor->extra[]   = $profile->profileInfo($cur);
1335             $act->verb             = ActivityVerb::POST;
1336             $act->objects[]        = ActivityObject::fromNotice($this);
1337
1338             // XXX: should this be handled by default processing for object entry?
1339
1340             $act->time    = strtotime($this->created);
1341             $act->link    = $this->bestUrl();
1342
1343             $act->content = common_xml_safe_str($this->rendered);
1344             $act->id      = $this->uri;
1345             $act->title   = common_xml_safe_str($this->content);
1346
1347             // Categories
1348
1349             $tags = $this->getTags();
1350
1351             foreach ($tags as $tag) {
1352                 $cat       = new AtomCategory();
1353                 $cat->term = $tag;
1354
1355                 $act->categories[] = $cat;
1356             }
1357
1358             // Enclosures
1359             // XXX: use Atom Media and/or File activity objects instead
1360
1361             $attachments = $this->attachments();
1362
1363             foreach ($attachments as $attachment) {
1364                 $enclosure = $attachment->getEnclosure();
1365                 if ($enclosure) {
1366                     $act->enclosures[] = $enclosure;
1367                 }
1368             }
1369
1370             $ctx = new ActivityContext();
1371
1372             if (!empty($this->reply_to)) {
1373                 $reply = Notice::staticGet('id', $this->reply_to);
1374                 if (!empty($reply)) {
1375                     $ctx->replyToID  = $reply->uri;
1376                     $ctx->replyToUrl = $reply->bestUrl();
1377                 }
1378             }
1379
1380             $ctx->location = $this->getLocation();
1381
1382             $conv = null;
1383
1384             if (!empty($this->conversation)) {
1385                 $conv = Conversation::staticGet('id', $this->conversation);
1386                 if (!empty($conv)) {
1387                     $ctx->conversation = $conv->uri;
1388                 }
1389             }
1390
1391             $reply_ids = $this->getReplies();
1392
1393             foreach ($reply_ids as $id) {
1394                 $rprofile = Profile::staticGet('id', $id);
1395                 if (!empty($rprofile)) {
1396                     $ctx->attention[] = $rprofile->getUri();
1397                 }
1398             }
1399
1400             $groups = $this->getGroups();
1401
1402             foreach ($groups as $group) {
1403                 $ctx->attention[] = $group->getUri();
1404             }
1405
1406             // XXX: deprecated; use ActivityVerb::SHARE instead
1407
1408             $repeat = null;
1409
1410             if (!empty($this->repeat_of)) {
1411                 $repeat = Notice::staticGet('id', $this->repeat_of);
1412                 $ctx->forwardID  = $repeat->uri;
1413                 $ctx->forwardUrl = $repeat->bestUrl();
1414             }
1415
1416             $act->context = $ctx;
1417
1418             // Source
1419
1420             $atom_feed = $profile->getAtomFeed();
1421
1422             if (!empty($atom_feed)) {
1423
1424                 $act->source = new ActivitySource();
1425
1426                 // XXX: we should store the actual feed ID
1427
1428                 $act->source->id = $atom_feed;
1429
1430                 // XXX: we should store the actual feed title
1431
1432                 $act->source->title = $profile->getBestName();
1433
1434                 $act->source->links['alternate'] = $profile->profileurl;
1435                 $act->source->links['self']      = $atom_feed;
1436
1437                 $act->source->icon = $profile->avatarUrl(AVATAR_PROFILE_SIZE);
1438
1439                 $notice = $profile->getCurrentNotice();
1440
1441                 if (!empty($notice)) {
1442                     $act->source->updated = self::utcDate($notice->created);
1443                 }
1444
1445                 $user = User::staticGet('id', $profile->id);
1446
1447                 if (!empty($user)) {
1448                     $act->source->links['license'] = common_config('license', 'url');
1449                 }
1450             }
1451
1452             if ($this->isLocal()) {
1453                 $act->selfLink = common_local_url('ApiStatusesShow', array('id' => $this->id,
1454                                                                            'format' => 'atom'));
1455                 $act->editLink = $act->selfLink;
1456             }
1457
1458             Event::handle('EndNoticeAsActivity', array($this, &$act));
1459         }
1460
1461         self::cacheSet(Cache::codeKey('notice:as-activity:'.$this->id), $act);
1462
1463         return $act;
1464     }
1465
1466     // This has gotten way too long. Needs to be sliced up into functional bits
1467     // or ideally exported to a utility class.
1468
1469     function asAtomEntry($namespace=false,
1470                          $source=false,
1471                          $author=true,
1472                          $cur=null)
1473     {
1474         $act = $this->asActivity($cur);
1475         $act->extra[] = $this->noticeInfo($cur);
1476         return $act->asString($namespace, $author, $source);
1477     }
1478
1479     /**
1480      * Extra notice info for atom entries
1481      *
1482      * Clients use some extra notice info in the atom stream.
1483      * This gives it to them.
1484      *
1485      * @param User $cur Current user
1486      *
1487      * @return array representation of <statusnet:notice_info> element
1488      */
1489
1490     function noticeInfo($cur)
1491     {
1492         // local notice ID (useful to clients for ordering)
1493
1494         $noticeInfoAttr = array('local_id' => $this->id);
1495
1496         // notice source
1497
1498         $ns = $this->getSource();
1499
1500         if (!empty($ns)) {
1501             $noticeInfoAttr['source'] =  $ns->code;
1502             if (!empty($ns->url)) {
1503                 $noticeInfoAttr['source_link'] = $ns->url;
1504                 if (!empty($ns->name)) {
1505                     $noticeInfoAttr['source'] =  '<a href="'
1506                         . htmlspecialchars($ns->url)
1507                         . '" rel="nofollow">'
1508                         . htmlspecialchars($ns->name)
1509                         . '</a>';
1510                 }
1511             }
1512         }
1513
1514         // favorite and repeated
1515
1516         if (!empty($cur)) {
1517             $noticeInfoAttr['favorite'] = ($cur->hasFave($this)) ? "true" : "false";
1518             $cp = $cur->getProfile();
1519             $noticeInfoAttr['repeated'] = ($cp->hasRepeated($this->id)) ? "true" : "false";
1520         }
1521
1522         if (!empty($this->repeat_of)) {
1523             $noticeInfoAttr['repeat_of'] = $this->repeat_of;
1524         }
1525
1526         return array('statusnet:notice_info', $noticeInfoAttr, null);
1527     }
1528
1529     /**
1530      * Returns an XML string fragment with a reference to a notice as an
1531      * Activity Streams noun object with the given element type.
1532      *
1533      * Assumes that 'activity' namespace has been previously defined.
1534      *
1535      * @param string $element one of 'subject', 'object', 'target'
1536      * @return string
1537      */
1538
1539     function asActivityNoun($element)
1540     {
1541         $noun = ActivityObject::fromNotice($this);
1542         return $noun->asString('activity:' . $element);
1543     }
1544
1545     function bestUrl()
1546     {
1547         if (!empty($this->url)) {
1548             return $this->url;
1549         } else if (!empty($this->uri) && preg_match('/^https?:/', $this->uri)) {
1550             return $this->uri;
1551         } else {
1552             return common_local_url('shownotice',
1553                                     array('notice' => $this->id));
1554         }
1555     }
1556
1557
1558     /**
1559      * Determine which notice, if any, a new notice is in reply to.
1560      *
1561      * For conversation tracking, we try to see where this notice fits
1562      * in the tree. Rough algorithm is:
1563      *
1564      * if (reply_to is set and valid) {
1565      *     return reply_to;
1566      * } else if ((source not API or Web) and (content starts with "T NAME" or "@name ")) {
1567      *     return ID of last notice by initial @name in content;
1568      * }
1569      *
1570      * Note that all @nickname instances will still be used to save "reply" records,
1571      * so the notice shows up in the mentioned users' "replies" tab.
1572      *
1573      * @param integer $reply_to   ID passed in by Web or API
1574      * @param integer $profile_id ID of author
1575      * @param string  $source     Source tag, like 'web' or 'gwibber'
1576      * @param string  $content    Final notice content
1577      *
1578      * @return integer ID of replied-to notice, or null for not a reply.
1579      */
1580
1581     static function getReplyTo($reply_to, $profile_id, $source, $content)
1582     {
1583         static $lb = array('xmpp', 'mail', 'sms', 'omb');
1584
1585         // If $reply_to is specified, we check that it exists, and then
1586         // return it if it does
1587
1588         if (!empty($reply_to)) {
1589             $reply_notice = Notice::staticGet('id', $reply_to);
1590             if (!empty($reply_notice)) {
1591                 return $reply_notice;
1592             }
1593         }
1594
1595         // If it's not a "low bandwidth" source (one where you can't set
1596         // a reply_to argument), we return. This is mostly web and API
1597         // clients.
1598
1599         if (!in_array($source, $lb)) {
1600             return null;
1601         }
1602
1603         // Is there an initial @ or T?
1604
1605         if (preg_match('/^T ([A-Z0-9]{1,64}) /', $content, $match) ||
1606             preg_match('/^@([a-z0-9]{1,64})\s+/', $content, $match)) {
1607             $nickname = common_canonical_nickname($match[1]);
1608         } else {
1609             return null;
1610         }
1611
1612         // Figure out who that is.
1613
1614         $sender = Profile::staticGet('id', $profile_id);
1615         if (empty($sender)) {
1616             return null;
1617         }
1618
1619         $recipient = common_relative_profile($sender, $nickname, common_sql_now());
1620
1621         if (empty($recipient)) {
1622             return null;
1623         }
1624
1625         // Get their last notice
1626
1627         $last = $recipient->getCurrentNotice();
1628
1629         if (!empty($last)) {
1630             return $last;
1631         }
1632
1633         return null;
1634     }
1635
1636     static function maxContent()
1637     {
1638         $contentlimit = common_config('notice', 'contentlimit');
1639         // null => use global limit (distinct from 0!)
1640         if (is_null($contentlimit)) {
1641             $contentlimit = common_config('site', 'textlimit');
1642         }
1643         return $contentlimit;
1644     }
1645
1646     static function contentTooLong($content)
1647     {
1648         $contentlimit = self::maxContent();
1649         return ($contentlimit > 0 && !empty($content) && (mb_strlen($content) > $contentlimit));
1650     }
1651
1652     function getLocation()
1653     {
1654         $location = null;
1655
1656         if (!empty($this->location_id) && !empty($this->location_ns)) {
1657             $location = Location::fromId($this->location_id, $this->location_ns);
1658         }
1659
1660         if (is_null($location)) { // no ID, or Location::fromId() failed
1661             if (!empty($this->lat) && !empty($this->lon)) {
1662                 $location = Location::fromLatLon($this->lat, $this->lon);
1663             }
1664         }
1665
1666         return $location;
1667     }
1668
1669     /**
1670      * Convenience function for posting a repeat of an existing message.
1671      *
1672      * @param int $repeater_id: profile ID of user doing the repeat
1673      * @param string $source: posting source key, eg 'web', 'api', etc
1674      * @return Notice
1675      *
1676      * @throws Exception on failure or permission problems
1677      */
1678     function repeat($repeater_id, $source)
1679     {
1680         $author = Profile::staticGet('id', $this->profile_id);
1681
1682         // TRANS: Message used to repeat a notice. RT is the abbreviation of 'retweet'.
1683         // TRANS: %1$s is the repeated user's name, %2$s is the repeated notice.
1684         $content = sprintf(_('RT @%1$s %2$s'),
1685                            $author->nickname,
1686                            $this->content);
1687
1688         $maxlen = common_config('site', 'textlimit');
1689         if ($maxlen > 0 && mb_strlen($content) > $maxlen) {
1690             // Web interface and current Twitter API clients will
1691             // pull the original notice's text, but some older
1692             // clients and RSS/Atom feeds will see this trimmed text.
1693             //
1694             // Unfortunately this is likely to lose tags or URLs
1695             // at the end of long notices.
1696             $content = mb_substr($content, 0, $maxlen - 4) . ' ...';
1697         }
1698
1699         // Scope is same as this one's
1700
1701         return self::saveNew($repeater_id,
1702                              $content,
1703                              $source,
1704                              array('repeat_of' => $this->id,
1705                                    'scope' => $this->scope));
1706     }
1707
1708     // These are supposed to be in chron order!
1709
1710     function repeatStream($limit=100)
1711     {
1712         $cache = Cache::instance();
1713
1714         if (empty($cache)) {
1715             $ids = $this->_repeatStreamDirect($limit);
1716         } else {
1717             $idstr = $cache->get(Cache::key('notice:repeats:'.$this->id));
1718             if ($idstr !== false) {
1719                 $ids = explode(',', $idstr);
1720             } else {
1721                 $ids = $this->_repeatStreamDirect(100);
1722                 $cache->set(Cache::key('notice:repeats:'.$this->id), implode(',', $ids));
1723             }
1724             if ($limit < 100) {
1725                 // We do a max of 100, so slice down to limit
1726                 $ids = array_slice($ids, 0, $limit);
1727             }
1728         }
1729
1730         return NoticeStream::getStreamByIds($ids);
1731     }
1732
1733     function _repeatStreamDirect($limit)
1734     {
1735         $notice = new Notice();
1736
1737         $notice->selectAdd(); // clears it
1738         $notice->selectAdd('id');
1739
1740         $notice->repeat_of = $this->id;
1741
1742         $notice->orderBy('created, id'); // NB: asc!
1743
1744         if (!is_null($limit)) {
1745             $notice->limit(0, $limit);
1746         }
1747
1748         $ids = array();
1749
1750         if ($notice->find()) {
1751             while ($notice->fetch()) {
1752                 $ids[] = $notice->id;
1753             }
1754         }
1755
1756         $notice->free();
1757         $notice = NULL;
1758
1759         return $ids;
1760     }
1761
1762     function locationOptions($lat, $lon, $location_id, $location_ns, $profile = null)
1763     {
1764         $options = array();
1765
1766         if (!empty($location_id) && !empty($location_ns)) {
1767             $options['location_id'] = $location_id;
1768             $options['location_ns'] = $location_ns;
1769
1770             $location = Location::fromId($location_id, $location_ns);
1771
1772             if (!empty($location)) {
1773                 $options['lat'] = $location->lat;
1774                 $options['lon'] = $location->lon;
1775             }
1776
1777         } else if (!empty($lat) && !empty($lon)) {
1778             $options['lat'] = $lat;
1779             $options['lon'] = $lon;
1780
1781             $location = Location::fromLatLon($lat, $lon);
1782
1783             if (!empty($location)) {
1784                 $options['location_id'] = $location->location_id;
1785                 $options['location_ns'] = $location->location_ns;
1786             }
1787         } else if (!empty($profile)) {
1788             if (isset($profile->lat) && isset($profile->lon)) {
1789                 $options['lat'] = $profile->lat;
1790                 $options['lon'] = $profile->lon;
1791             }
1792
1793             if (isset($profile->location_id) && isset($profile->location_ns)) {
1794                 $options['location_id'] = $profile->location_id;
1795                 $options['location_ns'] = $profile->location_ns;
1796             }
1797         }
1798
1799         return $options;
1800     }
1801
1802     function clearReplies()
1803     {
1804         $replyNotice = new Notice();
1805         $replyNotice->reply_to = $this->id;
1806
1807         //Null any notices that are replies to this notice
1808
1809         if ($replyNotice->find()) {
1810             while ($replyNotice->fetch()) {
1811                 $orig = clone($replyNotice);
1812                 $replyNotice->reply_to = null;
1813                 $replyNotice->update($orig);
1814             }
1815         }
1816
1817         // Reply records
1818
1819         $reply = new Reply();
1820         $reply->notice_id = $this->id;
1821
1822         if ($reply->find()) {
1823             while($reply->fetch()) {
1824                 self::blow('reply:stream:%d', $reply->profile_id);
1825                 $reply->delete();
1826             }
1827         }
1828
1829         $reply->free();
1830     }
1831
1832     function clearFiles()
1833     {
1834         $f2p = new File_to_post();
1835
1836         $f2p->post_id = $this->id;
1837
1838         if ($f2p->find()) {
1839             while ($f2p->fetch()) {
1840                 $f2p->delete();
1841             }
1842         }
1843         // FIXME: decide whether to delete File objects
1844         // ...and related (actual) files
1845     }
1846
1847     function clearRepeats()
1848     {
1849         $repeatNotice = new Notice();
1850         $repeatNotice->repeat_of = $this->id;
1851
1852         //Null any notices that are repeats of this notice
1853
1854         if ($repeatNotice->find()) {
1855             while ($repeatNotice->fetch()) {
1856                 $orig = clone($repeatNotice);
1857                 $repeatNotice->repeat_of = null;
1858                 $repeatNotice->update($orig);
1859             }
1860         }
1861     }
1862
1863     function clearFaves()
1864     {
1865         $fave = new Fave();
1866         $fave->notice_id = $this->id;
1867
1868         if ($fave->find()) {
1869             while ($fave->fetch()) {
1870                 self::blow('fave:ids_by_user_own:%d', $fave->user_id);
1871                 self::blow('fave:ids_by_user_own:%d;last', $fave->user_id);
1872                 self::blow('fave:ids_by_user:%d', $fave->user_id);
1873                 self::blow('fave:ids_by_user:%d;last', $fave->user_id);
1874                 $fave->delete();
1875             }
1876         }
1877
1878         $fave->free();
1879     }
1880
1881     function clearTags()
1882     {
1883         $tag = new Notice_tag();
1884         $tag->notice_id = $this->id;
1885
1886         if ($tag->find()) {
1887             while ($tag->fetch()) {
1888                 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, Cache::keyize($tag->tag));
1889                 self::blow('profile:notice_ids_tagged:%d:%s;last', $this->profile_id, Cache::keyize($tag->tag));
1890                 self::blow('notice_tag:notice_ids:%s', Cache::keyize($tag->tag));
1891                 self::blow('notice_tag:notice_ids:%s;last', Cache::keyize($tag->tag));
1892                 $tag->delete();
1893             }
1894         }
1895
1896         $tag->free();
1897     }
1898
1899     function clearGroupInboxes()
1900     {
1901         $gi = new Group_inbox();
1902
1903         $gi->notice_id = $this->id;
1904
1905         if ($gi->find()) {
1906             while ($gi->fetch()) {
1907                 self::blow('user_group:notice_ids:%d', $gi->group_id);
1908                 $gi->delete();
1909             }
1910         }
1911
1912         $gi->free();
1913     }
1914
1915     function distribute()
1916     {
1917         // We always insert for the author so they don't
1918         // have to wait
1919         Event::handle('StartNoticeDistribute', array($this));
1920
1921         $user = User::staticGet('id', $this->profile_id);
1922         if (!empty($user)) {
1923             Inbox::insertNotice($user->id, $this->id);
1924         }
1925
1926         if (common_config('queue', 'inboxes')) {
1927             // If there's a failure, we want to _force_
1928             // distribution at this point.
1929             try {
1930                 $qm = QueueManager::get();
1931                 $qm->enqueue($this, 'distrib');
1932             } catch (Exception $e) {
1933                 // If the exception isn't transient, this
1934                 // may throw more exceptions as DQH does
1935                 // its own enqueueing. So, we ignore them!
1936                 try {
1937                     $handler = new DistribQueueHandler();
1938                     $handler->handle($this);
1939                 } catch (Exception $e) {
1940                     common_log(LOG_ERR, "emergency redistribution resulted in " . $e->getMessage());
1941                 }
1942                 // Re-throw so somebody smarter can handle it.
1943                 throw $e;
1944             }
1945         } else {
1946             $handler = new DistribQueueHandler();
1947             $handler->handle($this);
1948         }
1949     }
1950
1951     function insert()
1952     {
1953         $result = parent::insert();
1954
1955         if ($result) {
1956             // Profile::hasRepeated() abuses pkeyGet(), so we
1957             // have to clear manually
1958             if (!empty($this->repeat_of)) {
1959                 $c = self::memcache();
1960                 if (!empty($c)) {
1961                     $ck = self::multicacheKey('Notice',
1962                                               array('profile_id' => $this->profile_id,
1963                                                     'repeat_of' => $this->repeat_of));
1964                     $c->delete($ck);
1965                 }
1966             }
1967         }
1968
1969         return $result;
1970     }
1971
1972     /**
1973      * Get the source of the notice
1974      *
1975      * @return Notice_source $ns A notice source object. 'code' is the only attribute
1976      *                           guaranteed to be populated.
1977      */
1978     function getSource()
1979     {
1980         $ns = new Notice_source();
1981         if (!empty($this->source)) {
1982             switch ($this->source) {
1983             case 'web':
1984             case 'xmpp':
1985             case 'mail':
1986             case 'omb':
1987             case 'system':
1988             case 'api':
1989                 $ns->code = $this->source;
1990                 break;
1991             default:
1992                 $ns = Notice_source::staticGet($this->source);
1993                 if (!$ns) {
1994                     $ns = new Notice_source();
1995                     $ns->code = $this->source;
1996                     $app = Oauth_application::staticGet('name', $this->source);
1997                     if ($app) {
1998                         $ns->name = $app->name;
1999                         $ns->url  = $app->source_url;
2000                     }
2001                 }
2002                 break;
2003             }
2004         }
2005         return $ns;
2006     }
2007
2008     /**
2009      * Determine whether the notice was locally created
2010      *
2011      * @return boolean locality
2012      */
2013
2014     public function isLocal()
2015     {
2016         return ($this->is_local == Notice::LOCAL_PUBLIC ||
2017                 $this->is_local == Notice::LOCAL_NONPUBLIC);
2018     }
2019
2020     /**
2021      * Get the list of hash tags saved with this notice.
2022      *
2023      * @return array of strings
2024      */
2025     public function getTags()
2026     {
2027         $tags = array();
2028
2029         $keypart = sprintf('notice:tags:%d', $this->id);
2030
2031         $tagstr = self::cacheGet($keypart);
2032
2033         if ($tagstr !== false) {
2034             $tags = explode(',', $tagstr);
2035         } else {
2036             $tag = new Notice_tag();
2037             $tag->notice_id = $this->id;
2038             if ($tag->find()) {
2039                 while ($tag->fetch()) {
2040                     $tags[] = $tag->tag;
2041                 }
2042             }
2043             self::cacheSet($keypart, implode(',', $tags));
2044         }
2045
2046         return $tags;
2047     }
2048
2049     static private function utcDate($dt)
2050     {
2051         $dateStr = date('d F Y H:i:s', strtotime($dt));
2052         $d = new DateTime($dateStr, new DateTimeZone('UTC'));
2053         return $d->format(DATE_W3C);
2054     }
2055
2056     /**
2057      * Look up the creation timestamp for a given notice ID, even
2058      * if it's been deleted.
2059      *
2060      * @param int $id
2061      * @return mixed string recorded creation timestamp, or false if can't be found
2062      */
2063     public static function getAsTimestamp($id)
2064     {
2065         if (!$id) {
2066             return false;
2067         }
2068
2069         $notice = Notice::staticGet('id', $id);
2070         if ($notice) {
2071             return $notice->created;
2072         }
2073
2074         $deleted = Deleted_notice::staticGet('id', $id);
2075         if ($deleted) {
2076             return $deleted->created;
2077         }
2078
2079         return false;
2080     }
2081
2082     /**
2083      * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2084      * parameter, matching notices posted after the given one (exclusive).
2085      *
2086      * If the referenced notice can't be found, will return false.
2087      *
2088      * @param int $id
2089      * @param string $idField
2090      * @param string $createdField
2091      * @return mixed string or false if no match
2092      */
2093     public static function whereSinceId($id, $idField='id', $createdField='created')
2094     {
2095         $since = Notice::getAsTimestamp($id);
2096         if ($since) {
2097             return sprintf("($createdField = '%s' and $idField > %d) or ($createdField > '%s')", $since, $id, $since);
2098         }
2099         return false;
2100     }
2101
2102     /**
2103      * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2104      * parameter, matching notices posted after the given one (exclusive), and
2105      * if necessary add it to the data object's query.
2106      *
2107      * @param DB_DataObject $obj
2108      * @param int $id
2109      * @param string $idField
2110      * @param string $createdField
2111      * @return mixed string or false if no match
2112      */
2113     public static function addWhereSinceId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2114     {
2115         $since = self::whereSinceId($id, $idField, $createdField);
2116         if ($since) {
2117             $obj->whereAdd($since);
2118         }
2119     }
2120
2121     /**
2122      * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2123      * parameter, matching notices posted before the given one (inclusive).
2124      *
2125      * If the referenced notice can't be found, will return false.
2126      *
2127      * @param int $id
2128      * @param string $idField
2129      * @param string $createdField
2130      * @return mixed string or false if no match
2131      */
2132     public static function whereMaxId($id, $idField='id', $createdField='created')
2133     {
2134         $max = Notice::getAsTimestamp($id);
2135         if ($max) {
2136             return sprintf("($createdField < '%s') or ($createdField = '%s' and $idField <= %d)", $max, $max, $id);
2137         }
2138         return false;
2139     }
2140
2141     /**
2142      * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2143      * parameter, matching notices posted before the given one (inclusive), and
2144      * if necessary add it to the data object's query.
2145      *
2146      * @param DB_DataObject $obj
2147      * @param int $id
2148      * @param string $idField
2149      * @param string $createdField
2150      * @return mixed string or false if no match
2151      */
2152     public static function addWhereMaxId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2153     {
2154         $max = self::whereMaxId($id, $idField, $createdField);
2155         if ($max) {
2156             $obj->whereAdd($max);
2157         }
2158     }
2159
2160     function isPublic()
2161     {
2162         if (common_config('public', 'localonly')) {
2163             return ($this->is_local == Notice::LOCAL_PUBLIC);
2164         } else {
2165             return (($this->is_local != Notice::LOCAL_NONPUBLIC) &&
2166                     ($this->is_local != Notice::GATEWAY));
2167         }
2168     }
2169
2170     /**
2171      * Check that the given profile is allowed to read, respond to, or otherwise
2172      * act on this notice.
2173      *
2174      * The $scope member is a bitmask of scopes, representing a logical AND of the
2175      * scope requirement. So, 0x03 (Notice::ADDRESSEE_SCOPE | Notice::SITE_SCOPE) means
2176      * "only visible to people who are mentioned in the notice AND are users on this site."
2177      * Users on the site who are not mentioned in the notice will not be able to see the
2178      * notice.
2179      *
2180      * @param Profile $profile The profile to check; pass null to check for public/unauthenticated users.
2181      *
2182      * @return boolean whether the profile is in the notice's scope
2183      */
2184     function inScope($profile)
2185     {
2186         $keypart = sprintf('notice:in-scope-for:%d:%d', $this->id, $profile->id);
2187
2188         $result = self::cacheGet($keypart);
2189
2190         if ($result === false) {
2191             $bResult = $this->_inScope($profile);
2192             $result = ($bResult) ? 1 : 0;
2193             self::cacheSet($keypart, $result, 0, 300);
2194         }
2195
2196         return ($result == 1) ? true : false;
2197     }
2198
2199     protected function _inScope($profile)
2200     {
2201         // If there's no scope, anyone (even anon) is in scope.
2202
2203         if ($this->scope == 0) {
2204             return true;
2205         }
2206
2207         // If there's scope, anon cannot be in scope
2208
2209         if (empty($profile)) {
2210             return false;
2211         }
2212
2213         // Author is always in scope
2214
2215         if ($this->profile_id == $profile->id) {
2216             return true;
2217         }
2218
2219         // Only for users on this site
2220
2221         if ($this->scope & Notice::SITE_SCOPE) {
2222             $user = $profile->getUser();
2223             if (empty($user)) {
2224                 return false;
2225             }
2226         }
2227
2228         // Only for users mentioned in the notice
2229
2230         if ($this->scope & Notice::ADDRESSEE_SCOPE) {
2231
2232             // XXX: just query for the single reply
2233
2234             $replies = $this->getReplies();
2235
2236             if (!in_array($profile->id, $replies)) {
2237                 return false;
2238             }
2239         }
2240
2241         // Only for members of the given group
2242
2243         if ($this->scope & Notice::GROUP_SCOPE) {
2244
2245             // XXX: just query for the single membership
2246
2247             $groups = $this->getGroups();
2248
2249             $foundOne = false;
2250
2251             foreach ($groups as $group) {
2252                 if ($profile->isMember($group)) {
2253                     $foundOne = true;
2254                     break;
2255                 }
2256             }
2257
2258             if (!$foundOne) {
2259                 return false;
2260             }
2261         }
2262
2263         // Only for followers of the author
2264
2265         if ($this->scope & Notice::FOLLOWER_SCOPE) {
2266             $author = $this->getProfile();
2267             if (!Subscription::exists($profile, $author)) {
2268                 return false;
2269             }
2270         }
2271
2272         return true;
2273     }
2274
2275     static function groupsFromText($text, $profile)
2276     {
2277         $groups = array();
2278
2279         /* extract all !group */
2280         $count = preg_match_all('/(?:^|\s)!(' . Nickname::DISPLAY_FMT . ')/',
2281                                 strtolower($text),
2282                                 $match);
2283
2284         if (!$count) {
2285             return $groups;
2286         }
2287
2288         foreach (array_unique($match[1]) as $nickname) {
2289             $group = User_group::getForNickname($nickname, $profile);
2290             if (!empty($group) && $profile->isMember($group)) {
2291                 $groups[] = $group->id;
2292             }
2293         }
2294
2295         return $groups;
2296     }
2297 }