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