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  * @license  GNU Affero General Public License http://www.gnu.org/licenses/
  33  */
  34
  35 if (!defined('STATUSNET') && !defined('LACONICA')) {
  36     exit(1);
  37 }
  38
  39 /**
  40  * Table Definition for notice
  41  */
  42 require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
  43
  44 /* We keep the first three 20-notice pages, plus one for pagination check,
  45  * in the memcached cache. */
  46
  47 define('NOTICE_CACHE_WINDOW', 61);
  48
  49 define('MAX_BOXCARS', 128);
  50
  51 class Notice extends Memcached_DataObject
  52 {
  53     ###START_AUTOCODE
  54     /* the code below is auto generated do not remove the above tag */
  55
  56     public $__table = 'notice';                          // table name
  57     public $id;                              // int(4)  primary_key not_null
  58     public $profile_id;                      // int(4)  multiple_key not_null
  59     public $uri;                             // varchar(255)  unique_key
  60     public $content;                         // text
  61     public $rendered;                        // text
  62     public $url;                             // varchar(255)
  63     public $created;                         // datetime  multiple_key not_null default_0000-00-00%2000%3A00%3A00
  64     public $modified;                        // timestamp   not_null default_CURRENT_TIMESTAMP
  65     public $reply_to;                        // int(4)
  66     public $is_local;                        // int(4)
  67     public $source;                          // varchar(32)
  68     public $conversation;                    // int(4)
  69     public $lat;                             // decimal(10,7)
  70     public $lon;                             // decimal(10,7)
  71     public $location_id;                     // int(4)
  72     public $location_ns;                     // int(4)
  73     public $repeat_of;                       // int(4)
  74
  75     /* Static get */
  76     function staticGet($k,$v=NULL)
  77     {
  78         return Memcached_DataObject::staticGet('Notice',$k,$v);
  79     }
  80
  81     /* the code above is auto generated do not remove the tag below */
  82     ###END_AUTOCODE
  83
  84     /* Notice types */
  85     const LOCAL_PUBLIC    =  1;
  86     const REMOTE_OMB      =  0;
  87     const LOCAL_NONPUBLIC = -1;
  88     const GATEWAY         = -2;
  89
  90     function getProfile()
  91     {
  92         return Profile::staticGet('id', $this->profile_id);
  93     }
  94
  95     function delete()
  96     {
  97         // For auditing purposes, save a record that the notice
  98         // was deleted.
  99
 100         $deleted = new Deleted_notice();
 101
 102         $deleted->id         = $this->id;
 103         $deleted->profile_id = $this->profile_id;
 104         $deleted->uri        = $this->uri;
 105         $deleted->created    = $this->created;
 106         $deleted->deleted    = common_sql_now();
 107
 108         $deleted->insert();
 109
 110         // Clear related records
 111
 112         $this->clearReplies();
 113         $this->clearRepeats();
 114         $this->clearFaves();
 115         $this->clearTags();
 116         $this->clearGroupInboxes();
 117
 118         // NOTE: we don't clear inboxes
 119         // NOTE: we don't clear queue items
 120
 121         $result = parent::delete();
 122     }
 123
 124     function saveTags()
 125     {
 126         /* extract all #hastags */
 127         $count = preg_match_all('/(?:^|\s)#([\pL\pN_\-\.]{1,64})/', strtolower($this->content), $match);
 128         if (!$count) {
 129             return true;
 130         }
 131
 132         //turn each into their canonical tag
 133         //this is needed to remove dupes before saving e.g. #hash.tag = #hashtag
 134         $hashtags = array();
 135         for($i=0; $i<count($match[1]); $i++) {
 136             $hashtags[] = common_canonical_tag($match[1][$i]);
 137         }
 138
 139         /* Add them to the database */
 140         foreach(array_unique($hashtags) as $hashtag) {
 141             /* elide characters we don't want in the tag */
 142             $this->saveTag($hashtag);
 143             self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, $tag->tag);
 144         }
 145         return true;
 146     }
 147
 148     function saveTag($hashtag)
 149     {
 150         $tag = new Notice_tag();
 151         $tag->notice_id = $this->id;
 152         $tag->tag = $hashtag;
 153         $tag->created = $this->created;
 154         $id = $tag->insert();
 155
 156         if (!$id) {
 157             throw new ServerException(sprintf(_('DB error inserting hashtag: %s'),
 158                                               $last_error->message));
 159             return;
 160         }
 161
 162         // if it's saved, blow its cache
 163         $tag->blowCache(false);
 164     }
 165
 166     /**
 167      * Save a new notice and push it out to subscribers' inboxes.
 168      * Poster's permissions are checked before sending.
 169      *
 170      * @param int $profile_id Profile ID of the poster
 171      * @param string $content source message text; links may be shortened
 172      *                        per current user's preference
 173      * @param string $source source key ('web', 'api', etc)
 174      * @param array $options Associative array of optional properties:
 175      *              string 'created' timestamp of notice; defaults to now
 176      *              int 'is_local' source/gateway ID, one of:
 177      *                  Notice::LOCAL_PUBLIC    - Local, ok to appear in public timeline
 178      *                  Notice::REMOTE_OMB      - Sent from a remote OMB service;
 179      *                                            hide from public timeline but show in
 180      *                                            local "and friends" timelines
 181      *                  Notice::LOCAL_NONPUBLIC - Local, but hide from public timeline
 182      *                  Notice::GATEWAY         - From another non-OMB service;
 183      *                                            will not appear in public views
 184      *              float 'lat' decimal latitude for geolocation
 185      *              float 'lon' decimal longitude for geolocation
 186      *              int 'location_id' geoname identifier
 187      *              int 'location_ns' geoname namespace to interpret location_id
 188      *              int 'reply_to'; notice ID this is a reply to
 189      *              int 'repeat_of'; notice ID this is a repeat of
 190      *              string 'uri' permalink to notice; defaults to local notice URL
 191      *
 192      * @return Notice
 193      * @throws ClientException
 194      */
 195     static function saveNew($profile_id, $content, $source, $options=null) {
 196         $defaults = array('uri' => null,
 197                           'reply_to' => null,
 198                           'repeat_of' => null);
 199
 200         if (!empty($options)) {
 201             $options = $options + $defaults;
 202             extract($options);
 203         }
 204
 205         if (!isset($is_local)) {
 206             $is_local = Notice::LOCAL_PUBLIC;
 207         }
 208
 209         $profile = Profile::staticGet($profile_id);
 210
 211         $final = common_shorten_links($content);
 212
 213         if (Notice::contentTooLong($final)) {
 214             throw new ClientException(_('Problem saving notice. Too long.'));
 215         }
 216
 217         if (empty($profile)) {
 218             throw new ClientException(_('Problem saving notice. Unknown user.'));
 219         }
 220
 221         if (common_config('throttle', 'enabled') && !Notice::checkEditThrottle($profile_id)) {
 222             common_log(LOG_WARNING, 'Excessive posting by profile #' . $profile_id . '; throttled.');
 223             throw new ClientException(_('Too many notices too fast; take a breather '.
 224                                         'and post again in a few minutes.'));
 225         }
 226
 227         if (common_config('site', 'dupelimit') > 0 && !Notice::checkDupes($profile_id, $final)) {
 228             common_log(LOG_WARNING, 'Dupe posting by profile #' . $profile_id . '; throttled.');
 229             throw new ClientException(_('Too many duplicate messages too quickly;'.
 230                                         ' take a breather and post again in a few minutes.'));
 231         }
 232
 233         if (!$profile->hasRight(Right::NEWNOTICE)) {
 234             common_log(LOG_WARNING, "Attempted post from user disallowed to post: " . $profile->nickname);
 235             throw new ClientException(_('You are banned from posting notices on this site.'));
 236         }
 237
 238         $notice = new Notice();
 239         $notice->profile_id = $profile_id;
 240
 241         $autosource = common_config('public', 'autosource');
 242
 243         # Sandboxed are non-false, but not 1, either
 244
 245         if (!$profile->hasRight(Right::PUBLICNOTICE) ||
 246             ($source && $autosource && in_array($source, $autosource))) {
 247             $notice->is_local = Notice::LOCAL_NONPUBLIC;
 248         } else {
 249             $notice->is_local = $is_local;
 250         }
 251
 252         if (!empty($created)) {
 253             $notice->created = $created;
 254         } else {
 255             $notice->created = common_sql_now();
 256         }
 257
 258         $notice->content = $final;
 259         $notice->rendered = common_render_content($final, $notice);
 260         $notice->source = $source;
 261         $notice->uri = $uri;
 262
 263         // Handle repeat case
 264
 265         if (isset($repeat_of)) {
 266             $notice->repeat_of = $repeat_of;
 267         } else {
 268             $notice->reply_to = self::getReplyTo($reply_to, $profile_id, $source, $final);
 269         }
 270
 271         if (!empty($notice->reply_to)) {
 272             $reply = Notice::staticGet('id', $notice->reply_to);
 273             $notice->conversation = $reply->conversation;
 274         }
 275
 276         if (!empty($lat) && !empty($lon)) {
 277             $notice->lat = $lat;
 278             $notice->lon = $lon;
 279         }
 280
 281         if (!empty($location_ns) && !empty($location_id)) {
 282             $notice->location_id = $location_id;
 283             $notice->location_ns = $location_ns;
 284         }
 285
 286         if (Event::handle('StartNoticeSave', array(&$notice))) {
 287
 288             // XXX: some of these functions write to the DB
 289
 290             $id = $notice->insert();
 291
 292             if (!$id) {
 293                 common_log_db_error($notice, 'INSERT', __FILE__);
 294                 throw new ServerException(_('Problem saving notice.'));
 295             }
 296
 297             // Update ID-dependent columns: URI, conversation
 298
 299             $orig = clone($notice);
 300
 301             $changed = false;
 302
 303             if (empty($uri)) {
 304                 $notice->uri = common_notice_uri($notice);
 305                 $changed = true;
 306             }
 307
 308             // If it's not part of a conversation, it's
 309             // the beginning of a new conversation.
 310
 311             if (empty($notice->conversation)) {
 312                 $notice->conversation = $notice->id;
 313                 $changed = true;
 314             }
 315
 316             if ($changed) {
 317                 if (!$notice->update($orig)) {
 318                     common_log_db_error($notice, 'UPDATE', __FILE__);
 319                     throw new ServerException(_('Problem saving notice.'));
 320                 }
 321             }
 322
 323         }
 324
 325         # Clear the cache for subscribed users, so they'll update at next request
 326         # XXX: someone clever could prepend instead of clearing the cache
 327         $notice->blowOnInsert();
 328
 329         $qm = QueueManager::get();
 330
 331         $qm->enqueue($notice, 'distrib');
 332
 333         return $notice;
 334     }
 335
 336     function blowOnInsert()
 337     {
 338         self::blow('profile:notice_ids:%d', $this->profile_id);
 339         self::blow('public');
 340
 341         if ($this->conversation != $this->id) {
 342             self::blow('notice:conversation_ids:%d', $this->conversation);
 343         }
 344
 345         if (!empty($this->repeat_of)) {
 346             self::blow('notice:repeats:%d', $this->repeat_of);
 347         }
 348
 349         $original = Notice::staticGet('id', $this->repeat_of);
 350
 351         if (!empty($original)) {
 352             $originalUser = User::staticGet('id', $original->profile_id);
 353             if (!empty($originalUser)) {
 354                 self::blow('user:repeats_of_me:%d', $originalUser->id);
 355             }
 356         }
 357
 358         $profile = Profile::staticGet($this->profile_id);
 359         $profile->blowNoticeCount();
 360     }
 361
 362     /** save all urls in the notice to the db
 363      *
 364      * follow redirects and save all available file information
 365      * (mimetype, date, size, oembed, etc.)
 366      *
 367      * @return void
 368      */
 369     function saveUrls() {
 370         common_replace_urls_callback($this->content, array($this, 'saveUrl'), $this->id);
 371     }
 372
 373     function saveUrl($data) {
 374         list($url, $notice_id) = $data;
 375         File::processNew($url, $notice_id);
 376     }
 377
 378     static function checkDupes($profile_id, $content) {
 379         $profile = Profile::staticGet($profile_id);
 380         if (empty($profile)) {
 381             return false;
 382         }
 383         $notice = $profile->getNotices(0, NOTICE_CACHE_WINDOW);
 384         if (!empty($notice)) {
 385             $last = 0;
 386             while ($notice->fetch()) {
 387                 if (time() - strtotime($notice->created) >= common_config('site', 'dupelimit')) {
 388                     return true;
 389                 } else if ($notice->content == $content) {
 390                     return false;
 391                 }
 392             }
 393         }
 394         # If we get here, oldest item in cache window is not
 395         # old enough for dupe limit; do direct check against DB
 396         $notice = new Notice();
 397         $notice->profile_id = $profile_id;
 398         $notice->content = $content;
 399         if (common_config('db','type') == 'pgsql')
 400           $notice->whereAdd('extract(epoch from now() - created) < ' . common_config('site', 'dupelimit'));
 401         else
 402           $notice->whereAdd('now() - created < ' . common_config('site', 'dupelimit'));
 403
 404         $cnt = $notice->count();
 405         return ($cnt == 0);
 406     }
 407
 408     static function checkEditThrottle($profile_id) {
 409         $profile = Profile::staticGet($profile_id);
 410         if (empty($profile)) {
 411             return false;
 412         }
 413         # Get the Nth notice
 414         $notice = $profile->getNotices(common_config('throttle', 'count') - 1, 1);
 415         if ($notice && $notice->fetch()) {
 416             # If the Nth notice was posted less than timespan seconds ago
 417             if (time() - strtotime($notice->created) <= common_config('throttle', 'timespan')) {
 418                 # Then we throttle
 419                 return false;
 420             }
 421         }
 422         # Either not N notices in the stream, OR the Nth was not posted within timespan seconds
 423         return true;
 424     }
 425
 426     function getUploadedAttachment() {
 427         $post = clone $this;
 428         $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"';
 429         $post->query($query);
 430         $post->fetch();
 431         if (empty($post->up) || empty($post->i)) {
 432             $ret = false;
 433         } else {
 434             $ret = array($post->up, $post->i);
 435         }
 436         $post->free();
 437         return $ret;
 438     }
 439
 440     function hasAttachments() {
 441         $post = clone $this;
 442         $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);
 443         $post->query($query);
 444         $post->fetch();
 445         $n_attachments = intval($post->n_attachments);
 446         $post->free();
 447         return $n_attachments;
 448     }
 449
 450     function attachments() {
 451         // XXX: cache this
 452         $att = array();
 453         $f2p = new File_to_post;
 454         $f2p->post_id = $this->id;
 455         if ($f2p->find()) {
 456             while ($f2p->fetch()) {
 457                 $f = File::staticGet($f2p->file_id);
 458                 $att[] = clone($f);
 459             }
 460         }
 461         return $att;
 462     }
 463
 464     function getStreamByIds($ids)
 465     {
 466         $cache = common_memcache();
 467
 468         if (!empty($cache)) {
 469             $notices = array();
 470             foreach ($ids as $id) {
 471                 $n = Notice::staticGet('id', $id);
 472                 if (!empty($n)) {
 473                     $notices[] = $n;
 474                 }
 475             }
 476             return new ArrayWrapper($notices);
 477         } else {
 478             $notice = new Notice();
 479             if (empty($ids)) {
 480                 //if no IDs requested, just return the notice object
 481                 return $notice;
 482             }
 483             $notice->whereAdd('id in (' . implode(', ', $ids) . ')');
 484
 485             $notice->find();
 486
 487             $temp = array();
 488
 489             while ($notice->fetch()) {
 490                 $temp[$notice->id] = clone($notice);
 491             }
 492
 493             $wrapped = array();
 494
 495             foreach ($ids as $id) {
 496                 if (array_key_exists($id, $temp)) {
 497                     $wrapped[] = $temp[$id];
 498                 }
 499             }
 500
 501             return new ArrayWrapper($wrapped);
 502         }
 503     }
 504
 505     function publicStream($offset=0, $limit=20, $since_id=0, $max_id=0, $since=null)
 506     {
 507         $ids = Notice::stream(array('Notice', '_publicStreamDirect'),
 508                               array(),
 509                               'public',
 510                               $offset, $limit, $since_id, $max_id, $since);
 511
 512         return Notice::getStreamByIds($ids);
 513     }
 514
 515     function _publicStreamDirect($offset=0, $limit=20, $since_id=0, $max_id=0, $since=null)
 516     {
 517         $notice = new Notice();
 518
 519         $notice->selectAdd(); // clears it
 520         $notice->selectAdd('id');
 521
 522         $notice->orderBy('id DESC');
 523
 524         if (!is_null($offset)) {
 525             $notice->limit($offset, $limit);
 526         }
 527
 528         if (common_config('public', 'localonly')) {
 529             $notice->whereAdd('is_local = ' . Notice::LOCAL_PUBLIC);
 530         } else {
 531             # -1 == blacklisted, -2 == gateway (i.e. Twitter)
 532             $notice->whereAdd('is_local !='. Notice::LOCAL_NONPUBLIC);
 533             $notice->whereAdd('is_local !='. Notice::GATEWAY);
 534         }
 535
 536         if ($since_id != 0) {
 537             $notice->whereAdd('id > ' . $since_id);
 538         }
 539
 540         if ($max_id != 0) {
 541             $notice->whereAdd('id <= ' . $max_id);
 542         }
 543
 544         if (!is_null($since)) {
 545             $notice->whereAdd('created > \'' . date('Y-m-d H:i:s', $since) . '\'');
 546         }
 547
 548         $ids = array();
 549
 550         if ($notice->find()) {
 551             while ($notice->fetch()) {
 552                 $ids[] = $notice->id;
 553             }
 554         }
 555
 556         $notice->free();
 557         $notice = NULL;
 558
 559         return $ids;
 560     }
 561
 562     function conversationStream($id, $offset=0, $limit=20, $since_id=0, $max_id=0, $since=null)
 563     {
 564         $ids = Notice::stream(array('Notice', '_conversationStreamDirect'),
 565                               array($id),
 566                               'notice:conversation_ids:'.$id,
 567                               $offset, $limit, $since_id, $max_id, $since);
 568
 569         return Notice::getStreamByIds($ids);
 570     }
 571
 572     function _conversationStreamDirect($id, $offset=0, $limit=20, $since_id=0, $max_id=0, $since=null)
 573     {
 574         $notice = new Notice();
 575
 576         $notice->selectAdd(); // clears it
 577         $notice->selectAdd('id');
 578
 579         $notice->conversation = $id;
 580
 581         $notice->orderBy('id DESC');
 582
 583         if (!is_null($offset)) {
 584             $notice->limit($offset, $limit);
 585         }
 586
 587         if ($since_id != 0) {
 588             $notice->whereAdd('id > ' . $since_id);
 589         }
 590
 591         if ($max_id != 0) {
 592             $notice->whereAdd('id <= ' . $max_id);
 593         }
 594
 595         if (!is_null($since)) {
 596             $notice->whereAdd('created > \'' . date('Y-m-d H:i:s', $since) . '\'');
 597         }
 598
 599         $ids = array();
 600
 601         if ($notice->find()) {
 602             while ($notice->fetch()) {
 603                 $ids[] = $notice->id;
 604             }
 605         }
 606
 607         $notice->free();
 608         $notice = NULL;
 609
 610         return $ids;
 611     }
 612
 613     /**
 614      * @param $groups array of Group *objects*
 615      * @param $recipients array of profile *ids*
 616      */
 617     function whoGets($groups=null, $recipients=null)
 618     {
 619         $c = self::memcache();
 620
 621         if (!empty($c)) {
 622             $ni = $c->get(common_cache_key('notice:who_gets:'.$this->id));
 623             if ($ni !== false) {
 624                 return $ni;
 625             }
 626         }
 627
 628         if (is_null($groups)) {
 629             $groups = $this->getGroups();
 630         }
 631
 632         if (is_null($recipients)) {
 633             $recipients = $this->getReplies();
 634         }
 635
 636         $users = $this->getSubscribedUsers();
 637
 638         // FIXME: kind of ignoring 'transitional'...
 639         // we'll probably stop supporting inboxless mode
 640         // in 0.9.x
 641
 642         $ni = array();
 643
 644         foreach ($users as $id) {
 645             $ni[$id] = NOTICE_INBOX_SOURCE_SUB;
 646         }
 647
 648         $profile = $this->getProfile();
 649
 650         foreach ($groups as $group) {
 651             $users = $group->getUserMembers();
 652             foreach ($users as $id) {
 653                 if (!array_key_exists($id, $ni)) {
 654                     $user = User::staticGet('id', $id);
 655                     if (!$user->hasBlocked($profile)) {
 656                         $ni[$id] = NOTICE_INBOX_SOURCE_GROUP;
 657                     }
 658                 }
 659             }
 660         }
 661
 662         foreach ($recipients as $recipient) {
 663
 664             if (!array_key_exists($recipient, $ni)) {
 665                 $recipientUser = User::staticGet('id', $recipient);
 666                 if (!empty($recipientUser)) {
 667                     $ni[$recipient] = NOTICE_INBOX_SOURCE_REPLY;
 668                 }
 669             }
 670         }
 671
 672         if (!empty($c)) {
 673             // XXX: pack this data better
 674             $c->set(common_cache_key('notice:who_gets:'.$this->id), $ni);
 675         }
 676
 677         return $ni;
 678     }
 679
 680     function addToInboxes($groups, $recipients)
 681     {
 682         $ni = $this->whoGets($groups, $recipients);
 683
 684         Inbox::bulkInsert($this->id, array_keys($ni));
 685
 686         return;
 687     }
 688
 689     function getSubscribedUsers()
 690     {
 691         $user = new User();
 692
 693         if(common_config('db','quote_identifiers'))
 694           $user_table = '"user"';
 695         else $user_table = 'user';
 696
 697         $qry =
 698           'SELECT id ' .
 699           'FROM '. $user_table .' JOIN subscription '.
 700           'ON '. $user_table .'.id = subscription.subscriber ' .
 701           'WHERE subscription.subscribed = %d ';
 702
 703         $user->query(sprintf($qry, $this->profile_id));
 704
 705         $ids = array();
 706
 707         while ($user->fetch()) {
 708             $ids[] = $user->id;
 709         }
 710
 711         $user->free();
 712
 713         return $ids;
 714     }
 715
 716     /**
 717      * @return array of Group objects
 718      */
 719     function saveGroups()
 720     {
 721         // Don't save groups for repeats
 722
 723         if (!empty($this->repeat_of)) {
 724             return array();
 725         }
 726
 727         $groups = array();
 728
 729         /* extract all !group */
 730         $count = preg_match_all('/(?:^|\s)!([A-Za-z0-9]{1,64})/',
 731                                 strtolower($this->content),
 732                                 $match);
 733         if (!$count) {
 734             return $groups;
 735         }
 736
 737         $profile = $this->getProfile();
 738
 739         /* Add them to the database */
 740
 741         foreach (array_unique($match[1]) as $nickname) {
 742             /* XXX: remote groups. */
 743             $group = User_group::getForNickname($nickname);
 744
 745             if (empty($group)) {
 746                 continue;
 747             }
 748
 749             // we automatically add a tag for every group name, too
 750
 751             $tag = Notice_tag::pkeyGet(array('tag' => common_canonical_tag($nickname),
 752                                              'notice_id' => $this->id));
 753
 754             if (is_null($tag)) {
 755                 $this->saveTag($nickname);
 756             }
 757
 758             if ($profile->isMember($group)) {
 759
 760                 $result = $this->addToGroupInbox($group);
 761
 762                 if (!$result) {
 763                     common_log_db_error($gi, 'INSERT', __FILE__);
 764                 }
 765
 766                 $groups[] = clone($group);
 767             }
 768         }
 769
 770         return $groups;
 771     }
 772
 773     function addToGroupInbox($group)
 774     {
 775         $gi = Group_inbox::pkeyGet(array('group_id' => $group->id,
 776                                          'notice_id' => $this->id));
 777
 778         if (empty($gi)) {
 779
 780             $gi = new Group_inbox();
 781
 782             $gi->group_id  = $group->id;
 783             $gi->notice_id = $this->id;
 784             $gi->created   = $this->created;
 785
 786             $result = $gi->insert();
 787
 788             if (!result) {
 789                 common_log_db_error($gi, 'INSERT', __FILE__);
 790                 throw new ServerException(_('Problem saving group inbox.'));
 791             }
 792
 793             self::blow('user_group:notice_ids:%d', $gi->group_id);
 794         }
 795
 796         return true;
 797     }
 798
 799     /**
 800      * @return array of integer profile IDs
 801      */
 802     function saveReplies()
 803     {
 804         // Don't save reply data for repeats
 805
 806         if (!empty($this->repeat_of)) {
 807             return array();
 808         }
 809
 810         // Alternative reply format
 811         $tname = false;
 812         if (preg_match('/^T ([A-Z0-9]{1,64}) /', $this->content, $match)) {
 813             $tname = $match[1];
 814         }
 815         // extract all @messages
 816         $cnt = preg_match_all('/(?:^|\s)@([a-z0-9]{1,64})/', $this->content, $match);
 817
 818         $names = array();
 819
 820         if ($cnt || $tname) {
 821             // XXX: is there another way to make an array copy?
 822             $names = ($tname) ? array_unique(array_merge(array(strtolower($tname)), $match[1])) : array_unique($match[1]);
 823         }
 824
 825         $sender = Profile::staticGet($this->profile_id);
 826
 827         $replied = array();
 828
 829         // store replied only for first @ (what user/notice what the reply directed,
 830         // we assume first @ is it)
 831
 832         for ($i=0; $i<count($names); $i++) {
 833             $nickname = $names[$i];
 834             $recipient = common_relative_profile($sender, $nickname, $this->created);
 835             if (empty($recipient)) {
 836                 continue;
 837             }
 838             // Don't save replies from blocked profile to local user
 839             $recipient_user = User::staticGet('id', $recipient->id);
 840             if (!empty($recipient_user) && $recipient_user->hasBlocked($sender)) {
 841                 continue;
 842             }
 843             $reply = new Reply();
 844             $reply->notice_id = $this->id;
 845             $reply->profile_id = $recipient->id;
 846             $id = $reply->insert();
 847             if (!$id) {
 848                 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
 849                 common_log(LOG_ERR, 'DB error inserting reply: ' . $last_error->message);
 850                 common_server_error(sprintf(_('DB error inserting reply: %s'), $last_error->message));
 851                 return array();
 852             } else {
 853                 $replied[$recipient->id] = 1;
 854             }
 855         }
 856
 857         // Hash format replies, too
 858         $cnt = preg_match_all('/(?:^|\s)@#([a-z0-9]{1,64})/', $this->content, $match);
 859         if ($cnt) {
 860             foreach ($match[1] as $tag) {
 861                 $tagged = Profile_tag::getTagged($sender->id, $tag);
 862                 foreach ($tagged as $t) {
 863                     if (!$replied[$t->id]) {
 864                         // Don't save replies from blocked profile to local user
 865                         $t_user = User::staticGet('id', $t->id);
 866                         if ($t_user && $t_user->hasBlocked($sender)) {
 867                             continue;
 868                         }
 869                         $reply = new Reply();
 870                         $reply->notice_id = $this->id;
 871                         $reply->profile_id = $t->id;
 872                         $id = $reply->insert();
 873                         if (!$id) {
 874                             common_log_db_error($reply, 'INSERT', __FILE__);
 875                             return array();
 876                         } else {
 877                             $replied[$recipient->id] = 1;
 878                         }
 879                     }
 880                 }
 881             }
 882         }
 883
 884         $recipientIds = array_keys($replied);
 885
 886         foreach ($recipientIds as $recipientId) {
 887             $user = User::staticGet('id', $recipientId);
 888             if (!empty($user)) {
 889                 self::blow('reply:stream:%d', $reply->profile_id);
 890                 mail_notify_attn($user, $this);
 891             }
 892         }
 893
 894         return $recipientIds;
 895     }
 896
 897     function getReplies()
 898     {
 899         // XXX: cache me
 900
 901         $ids = array();
 902
 903         $reply = new Reply();
 904         $reply->selectAdd();
 905         $reply->selectAdd('profile_id');
 906         $reply->notice_id = $this->id;
 907
 908         if ($reply->find()) {
 909             while($reply->fetch()) {
 910                 $ids[] = $reply->profile_id;
 911             }
 912         }
 913
 914         $reply->free();
 915
 916         return $ids;
 917     }
 918
 919     /**
 920      * Same calculation as saveGroups but without the saving
 921      * @fixme merge the functions
 922      * @return array of Group objects
 923      */
 924     function getGroups()
 925     {
 926         // Don't save groups for repeats
 927
 928         if (!empty($this->repeat_of)) {
 929             return array();
 930         }
 931
 932         // XXX: cache me
 933
 934         $groups = array();
 935
 936         $gi = new Group_inbox();
 937
 938         $gi->selectAdd();
 939         $gi->selectAdd('group_id');
 940
 941         $gi->notice_id = $this->id;
 942
 943         if ($gi->find()) {
 944             while ($gi->fetch()) {
 945                 $groups[] = clone($gi);
 946             }
 947         }
 948
 949         $gi->free();
 950
 951         return $groups;
 952     }
 953
 954     function asAtomEntry($namespace=false, $source=false)
 955     {
 956         $profile = $this->getProfile();
 957
 958         $xs = new XMLStringer(true);
 959
 960         if ($namespace) {
 961             $attrs = array('xmlns' => 'http://www.w3.org/2005/Atom',
 962                            'xmlns:thr' => 'http://purl.org/syndication/thread/1.0');
 963         } else {
 964             $attrs = array();
 965         }
 966
 967         $xs->elementStart('entry', $attrs);
 968
 969         if ($source) {
 970             $xs->elementStart('source');
 971             $xs->element('title', null, $profile->nickname . " - " . common_config('site', 'name'));
 972             $xs->element('link', array('href' => $profile->profileurl));
 973             $user = User::staticGet('id', $profile->id);
 974             if (!empty($user)) {
 975                 $atom_feed = common_local_url('ApiTimelineUser',
 976                                               array('format' => 'atom',
 977                                                     'id' => $profile->nickname));
 978                 $xs->element('link', array('rel' => 'self',
 979                                            'type' => 'application/atom+xml',
 980                                            'href' => $profile->profileurl));
 981                 $xs->element('link', array('rel' => 'license',
 982                                            'href' => common_config('license', 'url')));
 983             }
 984
 985             $xs->element('icon', null, $profile->avatarUrl(AVATAR_PROFILE_SIZE));
 986         }
 987
 988         $xs->elementStart('author');
 989         $xs->element('name', null, $profile->nickname);
 990         $xs->element('uri', null, $profile->profileurl);
 991         $xs->elementEnd('author');
 992
 993         if ($source) {
 994             $xs->elementEnd('source');
 995         }
 996
 997         $xs->element('title', null, $this->content);
 998         $xs->element('summary', null, $this->content);
 999
1000         $xs->element('link', array('rel' => 'alternate',
1001                                    'href' => $this->bestUrl()));
1002
1003         $xs->element('id', null, $this->uri);
1004
1005         $xs->element('published', null, common_date_w3dtf($this->created));
1006         $xs->element('updated', null, common_date_w3dtf($this->created));
1007
1008         if ($this->reply_to) {
1009             $reply_notice = Notice::staticGet('id', $this->reply_to);
1010             if (!empty($reply_notice)) {
1011                 $xs->element('link', array('rel' => 'related',
1012                                            'href' => $reply_notice->bestUrl()));
1013                 $xs->element('thr:in-reply-to',
1014                              array('ref' => $reply_notice->uri,
1015                                    'href' => $reply_notice->bestUrl()));
1016             }
1017         }
1018
1019         $xs->element('content', array('type' => 'html'), $this->rendered);
1020
1021         $tag = new Notice_tag();
1022         $tag->notice_id = $this->id;
1023         if ($tag->find()) {
1024             while ($tag->fetch()) {
1025                 $xs->element('category', array('term' => $tag->tag));
1026             }
1027         }
1028         $tag->free();
1029
1030         # Enclosures
1031         $attachments = $this->attachments();
1032         if($attachments){
1033             foreach($attachments as $attachment){
1034                 $enclosure=$attachment->getEnclosure();
1035                 if ($enclosure) {
1036                     $attributes = array('rel'=>'enclosure','href'=>$enclosure->url,'type'=>$enclosure->mimetype,'length'=>$enclosure->size);
1037                     if($enclosure->title){
1038                         $attributes['title']=$enclosure->title;
1039                     }
1040                     $xs->element('link', $attributes, null);
1041                 }
1042             }
1043         }
1044
1045         if (!empty($this->lat) && !empty($this->lon)) {
1046             $xs->elementStart('geo', array('xmlns:georss' => 'http://www.georss.org/georss'));
1047             $xs->element('georss:point', null, $this->lat . ' ' . $this->lon);
1048             $xs->elementEnd('geo');
1049         }
1050
1051         $xs->elementEnd('entry');
1052
1053         return $xs->getString();
1054     }
1055
1056     function bestUrl()
1057     {
1058         if (!empty($this->url)) {
1059             return $this->url;
1060         } else if (!empty($this->uri) && preg_match('/^https?:/', $this->uri)) {
1061             return $this->uri;
1062         } else {
1063             return common_local_url('shownotice',
1064                                     array('notice' => $this->id));
1065         }
1066     }
1067
1068     function stream($fn, $args, $cachekey, $offset=0, $limit=20, $since_id=0, $max_id=0, $since=null)
1069     {
1070         $cache = common_memcache();
1071
1072         if (empty($cache) ||
1073             $since_id != 0 || $max_id != 0 || (!is_null($since) && $since > 0) ||
1074             is_null($limit) ||
1075             ($offset + $limit) > NOTICE_CACHE_WINDOW) {
1076             return call_user_func_array($fn, array_merge($args, array($offset, $limit, $since_id,
1077                                                                       $max_id, $since)));
1078         }
1079
1080         $idkey = common_cache_key($cachekey);
1081
1082         $idstr = $cache->get($idkey);
1083
1084         if ($idstr !== false) {
1085             // Cache hit! Woohoo!
1086             $window = explode(',', $idstr);
1087             $ids = array_slice($window, $offset, $limit);
1088             return $ids;
1089         }
1090
1091         $laststr = $cache->get($idkey.';last');
1092
1093         if ($laststr !== false) {
1094             $window = explode(',', $laststr);
1095             $last_id = $window[0];
1096             $new_ids = call_user_func_array($fn, array_merge($args, array(0, NOTICE_CACHE_WINDOW,
1097                                                                           $last_id, 0, null)));
1098
1099             $new_window = array_merge($new_ids, $window);
1100
1101             $new_windowstr = implode(',', $new_window);
1102
1103             $result = $cache->set($idkey, $new_windowstr);
1104             $result = $cache->set($idkey . ';last', $new_windowstr);
1105
1106             $ids = array_slice($new_window, $offset, $limit);
1107
1108             return $ids;
1109         }
1110
1111         $window = call_user_func_array($fn, array_merge($args, array(0, NOTICE_CACHE_WINDOW,
1112                                                                      0, 0, null)));
1113
1114         $windowstr = implode(',', $window);
1115
1116         $result = $cache->set($idkey, $windowstr);
1117         $result = $cache->set($idkey . ';last', $windowstr);
1118
1119         $ids = array_slice($window, $offset, $limit);
1120
1121         return $ids;
1122     }
1123
1124     /**
1125      * Determine which notice, if any, a new notice is in reply to.
1126      *
1127      * For conversation tracking, we try to see where this notice fits
1128      * in the tree. Rough algorithm is:
1129      *
1130      * if (reply_to is set and valid) {
1131      *     return reply_to;
1132      * } else if ((source not API or Web) and (content starts with "T NAME" or "@name ")) {
1133      *     return ID of last notice by initial @name in content;
1134      * }
1135      *
1136      * Note that all @nickname instances will still be used to save "reply" records,
1137      * so the notice shows up in the mentioned users' "replies" tab.
1138      *
1139      * @param integer $reply_to   ID passed in by Web or API
1140      * @param integer $profile_id ID of author
1141      * @param string  $source     Source tag, like 'web' or 'gwibber'
1142      * @param string  $content    Final notice content
1143      *
1144      * @return integer ID of replied-to notice, or null for not a reply.
1145      */
1146
1147     static function getReplyTo($reply_to, $profile_id, $source, $content)
1148     {
1149         static $lb = array('xmpp', 'mail', 'sms', 'omb');
1150
1151         // If $reply_to is specified, we check that it exists, and then
1152         // return it if it does
1153
1154         if (!empty($reply_to)) {
1155             $reply_notice = Notice::staticGet('id', $reply_to);
1156             if (!empty($reply_notice)) {
1157                 return $reply_to;
1158             }
1159         }
1160
1161         // If it's not a "low bandwidth" source (one where you can't set
1162         // a reply_to argument), we return. This is mostly web and API
1163         // clients.
1164
1165         if (!in_array($source, $lb)) {
1166             return null;
1167         }
1168
1169         // Is there an initial @ or T?
1170
1171         if (preg_match('/^T ([A-Z0-9]{1,64}) /', $content, $match) ||
1172             preg_match('/^@([a-z0-9]{1,64})\s+/', $content, $match)) {
1173             $nickname = common_canonical_nickname($match[1]);
1174         } else {
1175             return null;
1176         }
1177
1178         // Figure out who that is.
1179
1180         $sender = Profile::staticGet('id', $profile_id);
1181         $recipient = common_relative_profile($sender, $nickname, common_sql_now());
1182
1183         if (empty($recipient)) {
1184             return null;
1185         }
1186
1187         // Get their last notice
1188
1189         $last = $recipient->getCurrentNotice();
1190
1191         if (!empty($last)) {
1192             return $last->id;
1193         }
1194     }
1195
1196     static function maxContent()
1197     {
1198         $contentlimit = common_config('notice', 'contentlimit');
1199         // null => use global limit (distinct from 0!)
1200         if (is_null($contentlimit)) {
1201             $contentlimit = common_config('site', 'textlimit');
1202         }
1203         return $contentlimit;
1204     }
1205
1206     static function contentTooLong($content)
1207     {
1208         $contentlimit = self::maxContent();
1209         return ($contentlimit > 0 && !empty($content) && (mb_strlen($content) > $contentlimit));
1210     }
1211
1212     function getLocation()
1213     {
1214         $location = null;
1215
1216         if (!empty($this->location_id) && !empty($this->location_ns)) {
1217             $location = Location::fromId($this->location_id, $this->location_ns);
1218         }
1219
1220         if (is_null($location)) { // no ID, or Location::fromId() failed
1221             if (!empty($this->lat) && !empty($this->lon)) {
1222                 $location = Location::fromLatLon($this->lat, $this->lon);
1223             }
1224         }
1225
1226         return $location;
1227     }
1228
1229     function repeat($repeater_id, $source)
1230     {
1231         $author = Profile::staticGet('id', $this->profile_id);
1232
1233         $content = sprintf(_('RT @%1$s %2$s'),
1234                            $author->nickname,
1235                            $this->content);
1236
1237         $maxlen = common_config('site', 'textlimit');
1238         if ($maxlen > 0 && mb_strlen($content) > $maxlen) {
1239             // Web interface and current Twitter API clients will
1240             // pull the original notice's text, but some older
1241             // clients and RSS/Atom feeds will see this trimmed text.
1242             //
1243             // Unfortunately this is likely to lose tags or URLs
1244             // at the end of long notices.
1245             $content = mb_substr($content, 0, $maxlen - 4) . ' ...';
1246         }
1247
1248         return self::saveNew($repeater_id, $content, $source,
1249                              array('repeat_of' => $this->id));
1250     }
1251
1252     // These are supposed to be in chron order!
1253
1254     function repeatStream($limit=100)
1255     {
1256         $cache = common_memcache();
1257
1258         if (empty($cache)) {
1259             $ids = $this->_repeatStreamDirect($limit);
1260         } else {
1261             $idstr = $cache->get(common_cache_key('notice:repeats:'.$this->id));
1262             if ($idstr !== false) {
1263                 $ids = explode(',', $idstr);
1264             } else {
1265                 $ids = $this->_repeatStreamDirect(100);
1266                 $cache->set(common_cache_key('notice:repeats:'.$this->id), implode(',', $ids));
1267             }
1268             if ($limit < 100) {
1269                 // We do a max of 100, so slice down to limit
1270                 $ids = array_slice($ids, 0, $limit);
1271             }
1272         }
1273
1274         return Notice::getStreamByIds($ids);
1275     }
1276
1277     function _repeatStreamDirect($limit)
1278     {
1279         $notice = new Notice();
1280
1281         $notice->selectAdd(); // clears it
1282         $notice->selectAdd('id');
1283
1284         $notice->repeat_of = $this->id;
1285
1286         $notice->orderBy('created'); // NB: asc!
1287
1288         if (!is_null($offset)) {
1289             $notice->limit($offset, $limit);
1290         }
1291
1292         $ids = array();
1293
1294         if ($notice->find()) {
1295             while ($notice->fetch()) {
1296                 $ids[] = $notice->id;
1297             }
1298         }
1299
1300         $notice->free();
1301         $notice = NULL;
1302
1303         return $ids;
1304     }
1305
1306     function locationOptions($lat, $lon, $location_id, $location_ns, $profile = null)
1307     {
1308         $options = array();
1309
1310         if (!empty($location_id) && !empty($location_ns)) {
1311
1312             $options['location_id'] = $location_id;
1313             $options['location_ns'] = $location_ns;
1314
1315             $location = Location::fromId($location_id, $location_ns);
1316
1317             if (!empty($location)) {
1318                 $options['lat'] = $location->lat;
1319                 $options['lon'] = $location->lon;
1320             }
1321
1322         } else if (!empty($lat) && !empty($lon)) {
1323
1324             $options['lat'] = $lat;
1325             $options['lon'] = $lon;
1326
1327             $location = Location::fromLatLon($lat, $lon);
1328
1329             if (!empty($location)) {
1330                 $options['location_id'] = $location->location_id;
1331                 $options['location_ns'] = $location->location_ns;
1332             }
1333         } else if (!empty($profile)) {
1334
1335             if (isset($profile->lat) && isset($profile->lon)) {
1336                 $options['lat'] = $profile->lat;
1337                 $options['lon'] = $profile->lon;
1338             }
1339
1340             if (isset($profile->location_id) && isset($profile->location_ns)) {
1341                 $options['location_id'] = $profile->location_id;
1342                 $options['location_ns'] = $profile->location_ns;
1343             }
1344         }
1345
1346         return $options;
1347     }
1348
1349     function clearReplies()
1350     {
1351         $replyNotice = new Notice();
1352         $replyNotice->reply_to = $this->id;
1353
1354         //Null any notices that are replies to this notice
1355
1356         if ($replyNotice->find()) {
1357             while ($replyNotice->fetch()) {
1358                 $orig = clone($replyNotice);
1359                 $replyNotice->reply_to = null;
1360                 $replyNotice->update($orig);
1361             }
1362         }
1363
1364         // Reply records
1365
1366         $reply = new Reply();
1367         $reply->notice_id = $this->id;
1368
1369         if ($reply->find()) {
1370             while($reply->fetch()) {
1371                 self::blow('reply:stream:%d', $reply->profile_id);
1372                 $reply->delete();
1373             }
1374         }
1375
1376         $reply->free();
1377
1378         return $ids;
1379     }
1380
1381     function clearRepeats()
1382     {
1383         $repeatNotice = new Notice();
1384         $repeatNotice->repeat_of = $this->id;
1385
1386         //Null any notices that are repeats of this notice
1387
1388         if ($repeatNotice->find()) {
1389             while ($repeatNotice->fetch()) {
1390                 $orig = clone($repeatNotice);
1391                 $repeatNotice->repeat_of = null;
1392                 $repeatNotice->update($orig);
1393             }
1394         }
1395     }
1396
1397     function clearFaves()
1398     {
1399         $fave = new Fave();
1400         $fave->notice_id = $this->id;
1401
1402         if ($fave->find()) {
1403             while ($fave->fetch()) {
1404                 self::blow('fave:ids_by_user_own:%d', $fave->user_id);
1405                 self::blow('fave:ids_by_user_own:%d;last', $fave->user_id);
1406                 self::blow('fave:ids_by_user:%d', $fave->user_id);
1407                 self::blow('fave:ids_by_user:%d;last', $fave->user_id);
1408                 $fave->delete();
1409             }
1410         }
1411
1412         $fave->free();
1413     }
1414
1415     function clearTags()
1416     {
1417         $tag = new Notice_tag();
1418         $tag->notice_id = $this->id;
1419
1420         if ($tag->find()) {
1421             while ($tag->fetch()) {
1422                 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, common_keyize($tag->tag));
1423                 self::blow('profile:notice_ids_tagged:%d:%s;last', $this->profile_id, common_keyize($tag->tag));
1424                 self::blow('notice_tag:notice_ids:%s', common_keyize($tag->tag));
1425                 self::blow('notice_tag:notice_ids:%s;last', common_keyize($tag->tag));
1426                 $tag->delete();
1427             }
1428         }
1429
1430         $tag->free();
1431     }
1432
1433     function clearGroupInboxes()
1434     {
1435         $gi = new Group_inbox();
1436
1437         $gi->notice_id = $this->id;
1438
1439         if ($gi->find()) {
1440             while ($gi->fetch()) {
1441                 self::blow('user_group:notice_ids:%d', $gi->group_id);
1442                 $gi->delete();
1443             }
1444         }
1445
1446         $gi->free();
1447     }
1448 }