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); }
54 /* the code above is auto generated do not remove the tag below */
59 return Profile::staticGet('id', $this->profile_id);
64 $this->blowCaches(true);
65 $this->blowFavesCache(true);
66 $this->blowSubsCache(true);
68 $this->query('BEGIN');
69 $related = array('Reply',
74 if (common_config('inboxes', 'enabled')) {
75 $related[] = 'Notice_inbox';
77 foreach ($related as $cls) {
79 $inst->notice_id = $this->id;
82 $result = parent::delete();
83 $this->query('COMMIT');
88 /* extract all #hastags */
89 $count = preg_match_all('/(?:^|\s)#([A-Za-z0-9_\-\.]{1,64})/', strtolower($this->content), $match);
94 /* Add them to the database */
95 foreach(array_unique($match[1]) as $hashtag) {
96 /* elide characters we don't want in the tag */
97 $hashtag = common_canonical_tag($hashtag);
99 $tag = DB_DataObject::factory('Notice_tag');
100 $tag->notice_id = $this->id;
101 $tag->tag = $hashtag;
102 $tag->created = $this->created;
103 $id = $tag->insert();
105 $last_error = PEAR::getStaticProperty('DB_DataObject','lastError');
106 common_log(LOG_ERR, 'DB error inserting hashtag: ' . $last_error->message);
107 common_server_error(sprintf(_('DB error inserting hashtag: %s'), $last_error->message));
114 static function saveNew($profile_id, $content, $source=null, $is_local=1, $reply_to=null, $uri=null) {
116 $profile = Profile::staticGet($profile_id);
119 common_log(LOG_ERR, 'Problem saving notice. Unknown user.');
120 return _('Problem saving notice. Unknown user.');
123 if (common_config('throttle', 'enabled') && !Notice::checkEditThrottle($profile_id)) {
124 common_log(LOG_WARNING, 'Excessive posting by profile #' . $profile_id . '; throttled.');
125 return _('Too many notices too fast; take a breather and post again in a few minutes.');
128 $banned = common_config('profile', 'banned');
130 if ( in_array($profile_id, $banned) || in_array($profile->nickname, $banned)) {
131 common_log(LOG_WARNING, "Attempted post from banned user: $profile->nickname (user id = $profile_id).");
132 return _('You are banned from posting notices on this site.');
135 $notice = new Notice();
136 $notice->profile_id = $profile_id;
138 $blacklist = common_config('public', 'blacklist');
140 # Blacklisted are non-false, but not 1, either
142 if ($blacklist && in_array($profile_id, $blacklist)) {
143 $notice->is_local = -1;
145 $notice->is_local = $is_local;
148 $notice->query('BEGIN');
150 $notice->reply_to = $reply_to;
151 $notice->created = common_sql_now();
152 $notice->content = common_shorten_links($content);
153 $notice->rendered = common_render_content($notice->content, $notice);
154 $notice->source = $source;
157 $id = $notice->insert();
160 common_log_db_error($notice, 'INSERT', __FILE__);
161 return _('Problem saving notice.');
164 # Update the URI after the notice is in the database
166 $orig = clone($notice);
167 $notice->uri = common_notice_uri($notice);
169 if (!$notice->update($orig)) {
170 common_log_db_error($notice, 'UPDATE', __FILE__);
171 return _('Problem saving notice.');
175 # XXX: do we need to change this for remote users?
177 $notice->saveReplies();
179 $notice->saveGroups();
181 $notice->addToInboxes();
182 $notice->query('COMMIT');
184 # Clear the cache for subscribed users, so they'll update at next request
185 # XXX: someone clever could prepend instead of clearing the cache
187 if (common_config('memcached', 'enabled')) {
188 $notice->blowCaches();
194 static function checkEditThrottle($profile_id) {
195 $profile = Profile::staticGet($profile_id);
200 $notice = $profile->getNotices(common_config('throttle', 'count') - 1, 1);
201 if ($notice && $notice->fetch()) {
202 # If the Nth notice was posted less than timespan seconds ago
203 if (time() - strtotime($notice->created) <= common_config('throttle', 'timespan')) {
208 # Either not N notices in the stream, OR the Nth was not posted within timespan seconds
212 function blowCaches($blowLast=false)
214 $this->blowSubsCache($blowLast);
215 $this->blowNoticeCache($blowLast);
216 $this->blowRepliesCache($blowLast);
217 $this->blowPublicCache($blowLast);
218 $this->blowTagCache($blowLast);
219 $this->blowGroupCache($blowLast);
222 function blowGroupCache($blowLast=false)
224 $cache = common_memcache();
226 $group_inbox = new Group_inbox();
227 $group_inbox->notice_id = $this->id;
228 if ($group_inbox->find()) {
229 while ($group_inbox->fetch()) {
230 $cache->delete(common_cache_key('group:notices:'.$group_inbox->group_id));
232 $cache->delete(common_cache_key('group:notices:'.$group_inbox->group_id.';last'));
234 $member = new Group_member();
235 $member->group_id = $group_inbox->group_id;
236 if ($member->find()) {
237 while ($member->fetch()) {
238 $cache->delete(common_cache_key('user:notices_with_friends:' . $member->profile_id));
240 $cache->delete(common_cache_key('user:notices_with_friends:' . $member->profile_id . ';last'));
246 $group_inbox->free();
251 function blowTagCache($blowLast=false)
253 $cache = common_memcache();
255 $tag = new Notice_tag();
256 $tag->notice_id = $this->id;
258 while ($tag->fetch()) {
259 $cache->delete(common_cache_key('notice_tag:notice_stream:' . $tag->tag));
261 $cache->delete(common_cache_key('notice_tag:notice_stream:' . $tag->tag . ';last'));
270 function blowSubsCache($blowLast=false)
272 $cache = common_memcache();
276 $UT = common_config('db','type')=='pgsql'?'"user"':'user';
277 $user->query('SELECT id ' .
279 "FROM $UT JOIN subscription ON $UT.id = subscription.subscriber " .
280 'WHERE subscription.subscribed = ' . $this->profile_id);
282 while ($user->fetch()) {
283 $cache->delete(common_cache_key('user:notices_with_friends:' . $user->id));
285 $cache->delete(common_cache_key('user:notices_with_friends:' . $user->id . ';last'));
293 function blowNoticeCache($blowLast=false)
295 if ($this->is_local) {
296 $cache = common_memcache();
298 $cache->delete(common_cache_key('profile:notices:'.$this->profile_id));
300 $cache->delete(common_cache_key('profile:notices:'.$this->profile_id.';last'));
306 function blowRepliesCache($blowLast=false)
308 $cache = common_memcache();
310 $reply = new Reply();
311 $reply->notice_id = $this->id;
312 if ($reply->find()) {
313 while ($reply->fetch()) {
314 $cache->delete(common_cache_key('user:replies:'.$reply->profile_id));
316 $cache->delete(common_cache_key('user:replies:'.$reply->profile_id.';last'));
325 function blowPublicCache($blowLast=false)
327 if ($this->is_local == 1) {
328 $cache = common_memcache();
330 $cache->delete(common_cache_key('public'));
332 $cache->delete(common_cache_key('public').';last');
338 function blowFavesCache($blowLast=false)
340 $cache = common_memcache();
343 $fave->notice_id = $this->id;
345 while ($fave->fetch()) {
346 $cache->delete(common_cache_key('user:faves:'.$fave->user_id));
348 $cache->delete(common_cache_key('user:faves:'.$fave->user_id.';last'));
357 # XXX: too many args; we need to move to named params or even a separate
358 # class for notice streams
360 static function getStream($qry, $cachekey, $offset=0, $limit=20, $since_id=0, $before_id=0, $order=null, $since=null) {
362 if (common_config('memcached', 'enabled')) {
364 # Skip the cache if this is a since, since_id or before_id qry
365 if ($since_id > 0 || $before_id > 0 || $since) {
366 return Notice::getStreamDirect($qry, $offset, $limit, $since_id, $before_id, $order, $since);
368 return Notice::getCachedStream($qry, $cachekey, $offset, $limit, $order);
372 return Notice::getStreamDirect($qry, $offset, $limit, $since_id, $before_id, $order, $since);
375 static function getStreamDirect($qry, $offset, $limit, $since_id, $before_id, $order, $since) {
380 if (preg_match('/\bWHERE\b/i', $qry)) {
394 $qry .= ' notice.id > ' . $since_id;
397 if ($before_id > 0) {
406 $qry .= ' notice.id < ' . $before_id;
418 $qry .= ' notice.created > \'' . date('Y-m-d H:i:s', $since) . '\'';
421 # Allow ORDER override
426 $qry .= ' ORDER BY notice.created DESC, notice.id DESC ';
429 if (common_config('db','type') == 'pgsql') {
430 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
432 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
435 $notice = new Notice();
437 $notice->query($qry);
442 # XXX: this is pretty long and should probably be broken up into
443 # some helper functions
445 static function getCachedStream($qry, $cachekey, $offset, $limit, $order) {
447 # If outside our cache window, just go to the DB
449 if ($offset + $limit > NOTICE_CACHE_WINDOW) {
450 return Notice::getStreamDirect($qry, $offset, $limit, null, null, $order, null);
453 # Get the cache; if we can't, just go to the DB
455 $cache = common_memcache();
458 return Notice::getStreamDirect($qry, $offset, $limit, null, null, $order, null);
461 # Get the notices out of the cache
463 $notices = $cache->get(common_cache_key($cachekey));
465 # On a cache hit, return a DB-object-like wrapper
467 if ($notices !== false) {
468 $wrapper = new ArrayWrapper(array_slice($notices, $offset, $limit));
472 # If the cache was invalidated because of new data being
473 # added, we can try and just get the new stuff. We keep an additional
474 # copy of the data at the key + ';last'
476 # No cache hit. Try to get the *last* cached version
478 $last_notices = $cache->get(common_cache_key($cachekey) . ';last');
482 # Reverse-chron order, so last ID is last.
484 $last_id = $last_notices[0]->id;
486 # XXX: this assumes monotonically increasing IDs; a fair
489 $new_notice = Notice::getStreamDirect($qry, 0, NOTICE_CACHE_WINDOW,
490 $last_id, null, $order, null);
493 $new_notices = array();
494 while ($new_notice->fetch()) {
495 $new_notices[] = clone($new_notice);
498 $notices = array_slice(array_merge($new_notices, $last_notices),
499 0, NOTICE_CACHE_WINDOW);
501 # Store the array in the cache for next time
503 $result = $cache->set(common_cache_key($cachekey), $notices);
504 $result = $cache->set(common_cache_key($cachekey) . ';last', $notices);
506 # return a wrapper of the array for use now
508 return new ArrayWrapper(array_slice($notices, $offset, $limit));
512 # Otherwise, get the full cache window out of the DB
514 $notice = Notice::getStreamDirect($qry, 0, NOTICE_CACHE_WINDOW, null, null, $order, null);
516 # If there are no hits, just return the value
522 # Pack results into an array
526 while ($notice->fetch()) {
527 $notices[] = clone($notice);
532 # Store the array in the cache for next time
534 $result = $cache->set(common_cache_key($cachekey), $notices);
535 $result = $cache->set(common_cache_key($cachekey) . ';last', $notices);
537 # return a wrapper of the array for use now
539 $wrapper = new ArrayWrapper(array_slice($notices, $offset, $limit));
544 function publicStream($offset=0, $limit=20, $since_id=0, $before_id=0, $since=null)
549 $qry = 'SELECT * FROM notice ';
551 if (common_config('public', 'localonly')) {
552 $parts[] = 'is_local = 1';
555 $parts[] = 'is_local != -1';
559 $qry .= ' WHERE ' . implode(' AND ', $parts);
562 return Notice::getStream($qry,
564 $offset, $limit, $since_id, $before_id, null, $since);
567 function addToInboxes()
569 $enabled = common_config('inboxes', 'enabled');
571 if ($enabled === true || $enabled === 'transitional') {
572 $inbox = new Notice_inbox();
573 $UT = common_config('db','type')=='pgsql'?'"user"':'user';
574 $qry = 'INSERT INTO notice_inbox (user_id, notice_id, created) ' .
575 "SELECT $UT.id, " . $this->id . ', "' . $this->created . '" ' .
576 "FROM $UT JOIN subscription ON $UT.id = subscription.subscriber " .
577 'WHERE subscription.subscribed = ' . $this->profile_id . ' ' .
578 'AND NOT EXISTS (SELECT user_id, notice_id ' .
579 'FROM notice_inbox ' .
580 "WHERE user_id = $UT.id " .
581 'AND notice_id = ' . $this->id . ' )';
582 if ($enabled === 'transitional') {
583 $qry .= " AND $UT.inboxed = 1";
590 function saveGroups()
592 $enabled = common_config('inboxes', 'enabled');
593 if ($enabled !== true && $enabled !== 'transitional') {
597 /* extract all !group */
598 $count = preg_match_all('/(?:^|\s)!([A-Za-z0-9]{1,64})/',
599 strtolower($this->content),
605 $profile = $this->getProfile();
607 /* Add them to the database */
609 foreach (array_unique($match[1]) as $nickname) {
610 /* XXX: remote groups. */
611 $group = User_group::staticGet('nickname', $nickname);
617 if ($profile->isMember($group)) {
619 $gi = new Group_inbox();
621 $gi->group_id = $group->id;
622 $gi->notice_id = $this->id;
623 $gi->created = common_sql_now();
625 $result = $gi->insert();
628 common_log_db_error($gi, 'INSERT', __FILE__);
631 // FIXME: do this in an offline daemon
633 $inbox = new Notice_inbox();
634 $UT = common_config('db','type')=='pgsql'?'"user"':'user';
635 $qry = 'INSERT INTO notice_inbox (user_id, notice_id, created, source) ' .
636 "SELECT $UT.id, " . $this->id . ', "' . $this->created . '", 2 ' .
637 "FROM $UT JOIN group_member ON $UT.id = group_member.profile_id " .
638 'WHERE group_member.group_id = ' . $group->id . ' ' .
639 'AND NOT EXISTS (SELECT user_id, notice_id ' .
640 'FROM notice_inbox ' .
641 "WHERE user_id = $UT.id " .
642 'AND notice_id = ' . $this->id . ' )';
643 if ($enabled === 'transitional') {
644 $qry .= " AND $UT.inboxed = 1";
646 $result = $inbox->query($qry);
651 function saveReplies()
653 // Alternative reply format
655 if (preg_match('/^T ([A-Z0-9]{1,64}) /', $this->content, $match)) {
658 // extract all @messages
659 $cnt = preg_match_all('/(?:^|\s)@([a-z0-9]{1,64})/', $this->content, $match);
663 if ($cnt || $tname) {
664 // XXX: is there another way to make an array copy?
665 $names = ($tname) ? array_unique(array_merge(array(strtolower($tname)), $match[1])) : array_unique($match[1]);
668 $sender = Profile::staticGet($this->profile_id);
672 // store replied only for first @ (what user/notice what the reply directed,
673 // we assume first @ is it)
675 for ($i=0; $i<count($names); $i++) {
676 $nickname = $names[$i];
677 $recipient = common_relative_profile($sender, $nickname, $this->created);
681 if ($i == 0 && ($recipient->id != $sender->id) && !$this->reply_to) { // Don't save reply to self
682 $reply_for = $recipient;
683 $recipient_notice = $reply_for->getCurrentNotice();
684 if ($recipient_notice) {
685 $orig = clone($this);
686 $this->reply_to = $recipient_notice->id;
687 $this->update($orig);
690 // Don't save replies from blocked profile to local user
691 $recipient_user = User::staticGet('id', $recipient->id);
692 if ($recipient_user && $recipient_user->hasBlocked($sender)) {
695 $reply = new Reply();
696 $reply->notice_id = $this->id;
697 $reply->profile_id = $recipient->id;
698 $id = $reply->insert();
700 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
701 common_log(LOG_ERR, 'DB error inserting reply: ' . $last_error->message);
702 common_server_error(sprintf(_('DB error inserting reply: %s'), $last_error->message));
705 $replied[$recipient->id] = 1;
709 // Hash format replies, too
710 $cnt = preg_match_all('/(?:^|\s)@#([a-z0-9]{1,64})/', $this->content, $match);
712 foreach ($match[1] as $tag) {
713 $tagged = Profile_tag::getTagged($sender->id, $tag);
714 foreach ($tagged as $t) {
715 if (!$replied[$t->id]) {
716 // Don't save replies from blocked profile to local user
717 $t_user = User::staticGet('id', $t->id);
718 if ($t_user && $t_user->hasBlocked($sender)) {
721 $reply = new Reply();
722 $reply->notice_id = $this->id;
723 $reply->profile_id = $t->id;
724 $id = $reply->insert();
726 common_log_db_error($reply, 'INSERT', __FILE__);