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