3 * Laconica - a distributed open-source microblogging tool
4 * Copyright (C) 2008, Controlez-Vous, Inc.
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.
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.
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/>.
20 if (!defined('LACONICA')) { exit(1); }
23 * Table Definition for notice
25 require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
27 /* We keep the first three 20-notice pages, plus one for pagination check,
28 * in the memcached cache. */
30 define('NOTICE_CACHE_WINDOW', 61);
32 class Notice extends Memcached_DataObject
35 /* the code below is auto generated do not remove the above tag */
37 public $__table = 'notice'; // table name
38 public $id; // int(4) primary_key not_null
39 public $profile_id; // int(4) not_null
40 public $uri; // varchar(255) unique_key
41 public $content; // varchar(140)
42 public $rendered; // text()
43 public $url; // varchar(255)
44 public $created; // datetime() not_null
45 public $modified; // timestamp() not_null default_CURRENT_TIMESTAMP
46 public $reply_to; // int(4)
47 public $is_local; // tinyint(1)
48 public $source; // varchar(32)
51 function staticGet($k,$v=NULL) {
52 return Memcached_DataObject::staticGet('Notice',$k,$v);
55 /* the code above is auto generated do not remove the tag below */
60 return Profile::staticGet('id', $this->profile_id);
65 $this->blowCaches(true);
66 $this->blowFavesCache(true);
67 $this->blowSubsCache(true);
69 $this->query('BEGIN');
70 //Null any notices that are replies to this notice
71 $this->query(sprintf("UPDATE notice set reply_to = null WHERE reply_to = %d", $this->id));
72 $related = array('Reply',
77 if (common_config('inboxes', 'enabled')) {
78 $related[] = 'Notice_inbox';
80 foreach ($related as $cls) {
82 $inst->notice_id = $this->id;
85 $result = parent::delete();
86 $this->query('COMMIT');
91 /* extract all #hastags */
92 $count = preg_match_all('/(?:^|\s)#([A-Za-z0-9_\-\.]{1,64})/', strtolower($this->content), $match);
97 /* Add them to the database */
98 foreach(array_unique($match[1]) as $hashtag) {
99 /* elide characters we don't want in the tag */
100 $this->saveTag($hashtag);
105 function saveTag($hashtag)
107 $hashtag = common_canonical_tag($hashtag);
109 $tag = new Notice_tag();
110 $tag->notice_id = $this->id;
111 $tag->tag = $hashtag;
112 $tag->created = $this->created;
113 $id = $tag->insert();
116 throw new ServerException(sprintf(_('DB error inserting hashtag: %s'),
117 $last_error->message));
122 static function saveNew($profile_id, $content, $source=null, $is_local=1, $reply_to=null, $uri=null) {
124 $profile = Profile::staticGet($profile_id);
126 $final = common_shorten_links($content);
129 common_log(LOG_ERR, 'Problem saving notice. Unknown user.');
130 return _('Problem saving notice. Unknown user.');
133 if (common_config('throttle', 'enabled') && !Notice::checkEditThrottle($profile_id)) {
134 common_log(LOG_WARNING, 'Excessive posting by profile #' . $profile_id . '; throttled.');
135 return _('Too many notices too fast; take a breather and post again in a few minutes.');
138 if (common_config('site', 'dupelimit') > 0 && !Notice::checkDupes($profile_id, $final)) {
139 common_log(LOG_WARNING, 'Dupe posting by profile #' . $profile_id . '; throttled.');
140 return _('Too many duplicate messages too quickly; take a breather and post again in a few minutes.');
143 $banned = common_config('profile', 'banned');
145 if ( in_array($profile_id, $banned) || in_array($profile->nickname, $banned)) {
146 common_log(LOG_WARNING, "Attempted post from banned user: $profile->nickname (user id = $profile_id).");
147 return _('You are banned from posting notices on this site.');
150 $notice = new Notice();
151 $notice->profile_id = $profile_id;
153 $blacklist = common_config('public', 'blacklist');
154 $autosource = common_config('public', 'autosource');
156 # Blacklisted are non-false, but not 1, either
158 if (($blacklist && in_array($profile_id, $blacklist)) ||
159 ($source && $autosource && in_array($source, $autosource))) {
160 $notice->is_local = -1;
162 $notice->is_local = $is_local;
165 $notice->query('BEGIN');
167 $notice->reply_to = $reply_to;
168 $notice->created = common_sql_now();
169 $notice->content = $final;
170 $notice->rendered = common_render_content($final, $notice);
171 $notice->source = $source;
174 if (Event::handle('StartNoticeSave', array(&$notice))) {
176 $id = $notice->insert();
179 common_log_db_error($notice, 'INSERT', __FILE__);
180 return _('Problem saving notice.');
183 # Update the URI after the notice is in the database
185 $orig = clone($notice);
186 $notice->uri = common_notice_uri($notice);
188 if (!$notice->update($orig)) {
189 common_log_db_error($notice, 'UPDATE', __FILE__);
190 return _('Problem saving notice.');
194 # XXX: do we need to change this for remote users?
196 $notice->saveReplies();
198 $notice->saveGroups();
200 $notice->addToInboxes();
201 $notice->query('COMMIT');
203 Event::handle('EndNoticeSave', array($notice));
206 # Clear the cache for subscribed users, so they'll update at next request
207 # XXX: someone clever could prepend instead of clearing the cache
209 if (common_config('memcached', 'enabled')) {
210 $notice->blowCaches();
216 static function checkDupes($profile_id, $content) {
217 $profile = Profile::staticGet($profile_id);
221 $notice = $profile->getNotices(0, NOTICE_CACHE_WINDOW);
224 while ($notice->fetch()) {
225 if (time() - strtotime($notice->created) >= common_config('site', 'dupelimit')) {
227 } else if ($notice->content == $content) {
232 # If we get here, oldest item in cache window is not
233 # old enough for dupe limit; do direct check against DB
234 $notice = new Notice();
235 $notice->profile_id = $profile_id;
236 $notice->content = $content;
237 if (common_config('db','type') == 'pgsql')
238 $notice->whereAdd('extract(epoch from now() - created) < ' . common_config('site', 'dupelimit'));
240 $notice->whereAdd('now() - created < ' . common_config('site', 'dupelimit'));
242 $cnt = $notice->count();
246 static function checkEditThrottle($profile_id) {
247 $profile = Profile::staticGet($profile_id);
252 $notice = $profile->getNotices(common_config('throttle', 'count') - 1, 1);
253 if ($notice && $notice->fetch()) {
254 # If the Nth notice was posted less than timespan seconds ago
255 if (time() - strtotime($notice->created) <= common_config('throttle', 'timespan')) {
260 # Either not N notices in the stream, OR the Nth was not posted within timespan seconds
264 function blowCaches($blowLast=false)
266 $this->blowSubsCache($blowLast);
267 $this->blowNoticeCache($blowLast);
268 $this->blowRepliesCache($blowLast);
269 $this->blowPublicCache($blowLast);
270 $this->blowTagCache($blowLast);
271 $this->blowGroupCache($blowLast);
274 function blowGroupCache($blowLast=false)
276 $cache = common_memcache();
278 $group_inbox = new Group_inbox();
279 $group_inbox->notice_id = $this->id;
280 if ($group_inbox->find()) {
281 while ($group_inbox->fetch()) {
282 $cache->delete(common_cache_key('group:notices:'.$group_inbox->group_id));
284 $cache->delete(common_cache_key('group:notices:'.$group_inbox->group_id.';last'));
286 $member = new Group_member();
287 $member->group_id = $group_inbox->group_id;
288 if ($member->find()) {
289 while ($member->fetch()) {
290 $cache->delete(common_cache_key('user:notices_with_friends:' . $member->profile_id));
292 $cache->delete(common_cache_key('user:notices_with_friends:' . $member->profile_id . ';last'));
298 $group_inbox->free();
303 function blowTagCache($blowLast=false)
305 $cache = common_memcache();
307 $tag = new Notice_tag();
308 $tag->notice_id = $this->id;
310 while ($tag->fetch()) {
311 $cache->delete(common_cache_key('notice_tag:notice_stream:' . $tag->tag));
313 $cache->delete(common_cache_key('notice_tag:notice_stream:' . $tag->tag . ';last'));
322 function blowSubsCache($blowLast=false)
324 $cache = common_memcache();
328 $UT = common_config('db','type')=='pgsql'?'"user"':'user';
329 $user->query('SELECT id ' .
331 "FROM $UT JOIN subscription ON $UT.id = subscription.subscriber " .
332 'WHERE subscription.subscribed = ' . $this->profile_id);
334 while ($user->fetch()) {
335 $cache->delete(common_cache_key('user:notices_with_friends:' . $user->id));
337 $cache->delete(common_cache_key('user:notices_with_friends:' . $user->id . ';last'));
345 function blowNoticeCache($blowLast=false)
347 if ($this->is_local) {
348 $cache = common_memcache();
350 $cache->delete(common_cache_key('profile:notices:'.$this->profile_id));
352 $cache->delete(common_cache_key('profile:notices:'.$this->profile_id.';last'));
358 function blowRepliesCache($blowLast=false)
360 $cache = common_memcache();
362 $reply = new Reply();
363 $reply->notice_id = $this->id;
364 if ($reply->find()) {
365 while ($reply->fetch()) {
366 $cache->delete(common_cache_key('user:replies:'.$reply->profile_id));
368 $cache->delete(common_cache_key('user:replies:'.$reply->profile_id.';last'));
377 function blowPublicCache($blowLast=false)
379 if ($this->is_local == 1) {
380 $cache = common_memcache();
382 $cache->delete(common_cache_key('public'));
384 $cache->delete(common_cache_key('public').';last');
390 function blowFavesCache($blowLast=false)
392 $cache = common_memcache();
395 $fave->notice_id = $this->id;
397 while ($fave->fetch()) {
398 $cache->delete(common_cache_key('user:faves:'.$fave->user_id));
400 $cache->delete(common_cache_key('user:faves:'.$fave->user_id.';last'));
409 # XXX: too many args; we need to move to named params or even a separate
410 # class for notice streams
412 static function getStream($qry, $cachekey, $offset=0, $limit=20, $since_id=0, $before_id=0, $order=null, $since=null) {
414 if (common_config('memcached', 'enabled')) {
416 # Skip the cache if this is a since, since_id or before_id qry
417 if ($since_id > 0 || $before_id > 0 || $since) {
418 return Notice::getStreamDirect($qry, $offset, $limit, $since_id, $before_id, $order, $since);
420 return Notice::getCachedStream($qry, $cachekey, $offset, $limit, $order);
424 return Notice::getStreamDirect($qry, $offset, $limit, $since_id, $before_id, $order, $since);
427 static function getStreamDirect($qry, $offset, $limit, $since_id, $before_id, $order, $since) {
432 if (preg_match('/\bWHERE\b/i', $qry)) {
446 $qry .= ' notice.id > ' . $since_id;
449 if ($before_id > 0) {
458 $qry .= ' notice.id < ' . $before_id;
470 $qry .= ' notice.created > \'' . date('Y-m-d H:i:s', $since) . '\'';
473 # Allow ORDER override
478 $qry .= ' ORDER BY notice.created DESC, notice.id DESC ';
481 if (common_config('db','type') == 'pgsql') {
482 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
484 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
487 $notice = new Notice();
489 $notice->query($qry);
494 # XXX: this is pretty long and should probably be broken up into
495 # some helper functions
497 static function getCachedStream($qry, $cachekey, $offset, $limit, $order) {
499 # If outside our cache window, just go to the DB
501 if ($offset + $limit > NOTICE_CACHE_WINDOW) {
502 return Notice::getStreamDirect($qry, $offset, $limit, null, null, $order, null);
505 # Get the cache; if we can't, just go to the DB
507 $cache = common_memcache();
510 return Notice::getStreamDirect($qry, $offset, $limit, null, null, $order, null);
513 # Get the notices out of the cache
515 $notices = $cache->get(common_cache_key($cachekey));
517 # On a cache hit, return a DB-object-like wrapper
519 if ($notices !== false) {
520 $wrapper = new ArrayWrapper(array_slice($notices, $offset, $limit));
524 # If the cache was invalidated because of new data being
525 # added, we can try and just get the new stuff. We keep an additional
526 # copy of the data at the key + ';last'
528 # No cache hit. Try to get the *last* cached version
530 $last_notices = $cache->get(common_cache_key($cachekey) . ';last');
534 # Reverse-chron order, so last ID is last.
536 $last_id = $last_notices[0]->id;
538 # XXX: this assumes monotonically increasing IDs; a fair
541 $new_notice = Notice::getStreamDirect($qry, 0, NOTICE_CACHE_WINDOW,
542 $last_id, null, $order, null);
545 $new_notices = array();
546 while ($new_notice->fetch()) {
547 $new_notices[] = clone($new_notice);
550 $notices = array_slice(array_merge($new_notices, $last_notices),
551 0, NOTICE_CACHE_WINDOW);
553 # Store the array in the cache for next time
555 $result = $cache->set(common_cache_key($cachekey), $notices);
556 $result = $cache->set(common_cache_key($cachekey) . ';last', $notices);
558 # return a wrapper of the array for use now
560 return new ArrayWrapper(array_slice($notices, $offset, $limit));
564 # Otherwise, get the full cache window out of the DB
566 $notice = Notice::getStreamDirect($qry, 0, NOTICE_CACHE_WINDOW, null, null, $order, null);
568 # If there are no hits, just return the value
574 # Pack results into an array
578 while ($notice->fetch()) {
579 $notices[] = clone($notice);
584 # Store the array in the cache for next time
586 $result = $cache->set(common_cache_key($cachekey), $notices);
587 $result = $cache->set(common_cache_key($cachekey) . ';last', $notices);
589 # return a wrapper of the array for use now
591 $wrapper = new ArrayWrapper(array_slice($notices, $offset, $limit));
596 function publicStream($offset=0, $limit=20, $since_id=0, $before_id=0, $since=null)
601 $qry = 'SELECT * FROM notice ';
603 if (common_config('public', 'localonly')) {
604 $parts[] = 'is_local = 1';
607 $parts[] = 'is_local != -1';
611 $qry .= ' WHERE ' . implode(' AND ', $parts);
614 return Notice::getStream($qry,
616 $offset, $limit, $since_id, $before_id, null, $since);
619 function addToInboxes()
621 $enabled = common_config('inboxes', 'enabled');
623 if ($enabled === true || $enabled === 'transitional') {
624 $inbox = new Notice_inbox();
625 $UT = common_config('db','type')=='pgsql'?'"user"':'user';
626 $qry = 'INSERT INTO notice_inbox (user_id, notice_id, created) ' .
627 "SELECT $UT.id, " . $this->id . ", '" . $this->created . "' " .
628 "FROM $UT JOIN subscription ON $UT.id = subscription.subscriber " .
629 'WHERE subscription.subscribed = ' . $this->profile_id . ' ' .
630 'AND NOT EXISTS (SELECT user_id, notice_id ' .
631 'FROM notice_inbox ' .
632 "WHERE user_id = $UT.id " .
633 'AND notice_id = ' . $this->id . ' )';
634 if ($enabled === 'transitional') {
635 $qry .= " AND $UT.inboxed = 1";
642 function saveGroups()
644 $enabled = common_config('inboxes', 'enabled');
645 if ($enabled !== true && $enabled !== 'transitional') {
649 /* extract all !group */
650 $count = preg_match_all('/(?:^|\s)!([A-Za-z0-9]{1,64})/',
651 strtolower($this->content),
657 $profile = $this->getProfile();
659 /* Add them to the database */
661 foreach (array_unique($match[1]) as $nickname) {
662 /* XXX: remote groups. */
663 $group = User_group::staticGet('nickname', $nickname);
669 // we automatically add a tag for every group name, too
671 $tag = Notice_tag::pkeyGet(array('tag' => common_canonical_tag($nickname),
672 'notice_id' => $this->id));
675 $this->saveTag($nickname);
678 if ($profile->isMember($group)) {
680 $gi = new Group_inbox();
682 $gi->group_id = $group->id;
683 $gi->notice_id = $this->id;
684 $gi->created = common_sql_now();
686 $result = $gi->insert();
689 common_log_db_error($gi, 'INSERT', __FILE__);
692 // FIXME: do this in an offline daemon
694 $inbox = new Notice_inbox();
695 $UT = common_config('db','type')=='pgsql'?'"user"':'user';
696 $qry = 'INSERT INTO notice_inbox (user_id, notice_id, created, source) ' .
697 "SELECT $UT.id, " . $this->id . ", '" . $this->created . "', 2 " .
698 "FROM $UT JOIN group_member ON $UT.id = group_member.profile_id " .
699 'WHERE group_member.group_id = ' . $group->id . ' ' .
700 'AND NOT EXISTS (SELECT user_id, notice_id ' .
701 'FROM notice_inbox ' .
702 "WHERE user_id = $UT.id " .
703 'AND notice_id = ' . $this->id . ' )';
704 if ($enabled === 'transitional') {
705 $qry .= " AND $UT.inboxed = 1";
707 $result = $inbox->query($qry);
712 function saveReplies()
714 // Alternative reply format
716 if (preg_match('/^T ([A-Z0-9]{1,64}) /', $this->content, $match)) {
719 // extract all @messages
720 $cnt = preg_match_all('/(?:^|\s)@([a-z0-9]{1,64})/', $this->content, $match);
724 if ($cnt || $tname) {
725 // XXX: is there another way to make an array copy?
726 $names = ($tname) ? array_unique(array_merge(array(strtolower($tname)), $match[1])) : array_unique($match[1]);
729 $sender = Profile::staticGet($this->profile_id);
733 // store replied only for first @ (what user/notice what the reply directed,
734 // we assume first @ is it)
736 for ($i=0; $i<count($names); $i++) {
737 $nickname = $names[$i];
738 $recipient = common_relative_profile($sender, $nickname, $this->created);
742 if ($i == 0 && ($recipient->id != $sender->id) && !$this->reply_to) { // Don't save reply to self
743 $reply_for = $recipient;
744 $recipient_notice = $reply_for->getCurrentNotice();
745 if ($recipient_notice) {
746 $orig = clone($this);
747 $this->reply_to = $recipient_notice->id;
748 $this->update($orig);
751 // Don't save replies from blocked profile to local user
752 $recipient_user = User::staticGet('id', $recipient->id);
753 if ($recipient_user && $recipient_user->hasBlocked($sender)) {
756 $reply = new Reply();
757 $reply->notice_id = $this->id;
758 $reply->profile_id = $recipient->id;
759 $id = $reply->insert();
761 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
762 common_log(LOG_ERR, 'DB error inserting reply: ' . $last_error->message);
763 common_server_error(sprintf(_('DB error inserting reply: %s'), $last_error->message));
766 $replied[$recipient->id] = 1;
770 // Hash format replies, too
771 $cnt = preg_match_all('/(?:^|\s)@#([a-z0-9]{1,64})/', $this->content, $match);
773 foreach ($match[1] as $tag) {
774 $tagged = Profile_tag::getTagged($sender->id, $tag);
775 foreach ($tagged as $t) {
776 if (!$replied[$t->id]) {
777 // Don't save replies from blocked profile to local user
778 $t_user = User::staticGet('id', $t->id);
779 if ($t_user && $t_user->hasBlocked($sender)) {
782 $reply = new Reply();
783 $reply->notice_id = $this->id;
784 $reply->profile_id = $t->id;
785 $id = $reply->insert();
787 common_log_db_error($reply, 'INSERT', __FILE__);
790 $replied[$recipient->id] = 1;
797 foreach (array_keys($replied) as $recipient) {
798 $user = User::staticGet('id', $recipient);
800 mail_notify_attn($user, $this);
805 function asAtomEntry($namespace=false, $source=false)
807 $profile = $this->getProfile();
809 $xs = new XMLStringer(true);
812 $attrs = array('xmlns' => 'http://www.w3.org/2005/Atom',
813 'xmlns:thr' => 'http://purl.org/syndication/thread/1.0');
818 $xs->elementStart('entry', $attrs);
821 $xs->elementStart('source');
822 $xs->element('title', null, $profile->nickname . " - " . common_config('site', 'name'));
823 $xs->element('link', array('href' => $profile->profileurl));
824 $user = User::staticGet('id', $profile->id);
826 $atom_feed = common_local_url('api',
827 array('apiaction' => 'statuses',
828 'method' => 'user_timeline',
829 'argument' => $profile->nickname.'.atom'));
830 $xs->element('link', array('rel' => 'self',
831 'type' => 'application/atom+xml',
832 'href' => $profile->profileurl));
833 $xs->element('link', array('rel' => 'license',
834 'href' => common_config('license', 'url')));
837 $xs->element('icon', null, $profile->avatarUrl(AVATAR_PROFILE_SIZE));
840 $xs->elementStart('author');
841 $xs->element('name', null, $profile->nickname);
842 $xs->element('uri', null, $profile->profileurl);
843 $xs->elementEnd('author');
846 $xs->elementEnd('source');
849 $xs->element('title', null, $this->content);
850 $xs->element('summary', null, $this->content);
852 $xs->element('link', array('rel' => 'alternate',
853 'href' => $this->bestUrl()));
855 $xs->element('id', null, $this->uri);
857 $xs->element('published', null, common_date_w3dtf($this->created));
858 $xs->element('updated', null, common_date_w3dtf($this->modified));
860 if ($this->reply_to) {
861 $reply_notice = Notice::staticGet('id', $this->reply_to);
862 if (!empty($reply_notice)) {
863 $xs->element('link', array('rel' => 'related',
864 'href' => $reply_notice->bestUrl()));
865 $xs->element('thr:in-reply-to',
866 array('ref' => $reply_notice->uri,
867 'href' => $reply_notice->bestUrl()));
871 $xs->element('content', array('type' => 'html'), $this->rendered);
873 $tag = new Notice_tag();
874 $tag->notice_id = $this->id;
876 while ($tag->fetch()) {
877 $xs->element('category', array('term' => $tag->tag));
882 $xs->elementEnd('entry');
884 return $xs->getString();
889 if (!empty($this->url)) {
891 } else if (!empty($this->uri) && preg_match('/^https?:/', $this->uri)) {
894 return common_local_url('shownotice',
895 array('notice' => $this->id));