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