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