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