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