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