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