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 if (common_config('queue', 'enabled')) {
201 $notice->addToAuthorInbox();
203 $notice->addToInboxes();
206 $notice->query('COMMIT');
208 Event::handle('EndNoticeSave', array($notice));
211 # Clear the cache for subscribed users, so they'll update at next request
212 # XXX: someone clever could prepend instead of clearing the cache
214 if (common_config('memcached', 'enabled')) {
215 if (common_config('queue', 'enabled')) {
216 $notice->blowAuthorCaches();
218 $notice->blowCaches();
225 static function checkDupes($profile_id, $content) {
226 $profile = Profile::staticGet($profile_id);
230 $notice = $profile->getNotices(0, NOTICE_CACHE_WINDOW);
233 while ($notice->fetch()) {
234 if (time() - strtotime($notice->created) >= common_config('site', 'dupelimit')) {
236 } else if ($notice->content == $content) {
241 # If we get here, oldest item in cache window is not
242 # old enough for dupe limit; do direct check against DB
243 $notice = new Notice();
244 $notice->profile_id = $profile_id;
245 $notice->content = $content;
246 if (common_config('db','type') == 'pgsql')
247 $notice->whereAdd('extract(epoch from now() - created) < ' . common_config('site', 'dupelimit'));
249 $notice->whereAdd('now() - created < ' . common_config('site', 'dupelimit'));
251 $cnt = $notice->count();
255 static function checkEditThrottle($profile_id) {
256 $profile = Profile::staticGet($profile_id);
261 $notice = $profile->getNotices(common_config('throttle', 'count') - 1, 1);
262 if ($notice && $notice->fetch()) {
263 # If the Nth notice was posted less than timespan seconds ago
264 if (time() - strtotime($notice->created) <= common_config('throttle', 'timespan')) {
269 # Either not N notices in the stream, OR the Nth was not posted within timespan seconds
273 function blowCaches($blowLast=false)
275 $this->blowSubsCache($blowLast);
276 $this->blowNoticeCache($blowLast);
277 $this->blowRepliesCache($blowLast);
278 $this->blowPublicCache($blowLast);
279 $this->blowTagCache($blowLast);
280 $this->blowGroupCache($blowLast);
283 function blowAuthorCaches($blowLast=false)
285 // Clear the user's cache
286 $cache = common_memcache();
287 if (!empty($cache)) {
288 $cache->delete(common_cache_key('user:notices_with_friends:' . $this->profile_id));
290 $this->blowNoticeCache($blowLast);
291 $this->blowPublicCache($blowLast);
294 function blowGroupCache($blowLast=false)
296 $cache = common_memcache();
298 $group_inbox = new Group_inbox();
299 $group_inbox->notice_id = $this->id;
300 if ($group_inbox->find()) {
301 while ($group_inbox->fetch()) {
302 $cache->delete(common_cache_key('group:notices:'.$group_inbox->group_id));
304 $cache->delete(common_cache_key('group:notices:'.$group_inbox->group_id.';last'));
306 $member = new Group_member();
307 $member->group_id = $group_inbox->group_id;
308 if ($member->find()) {
309 while ($member->fetch()) {
310 $cache->delete(common_cache_key('user:notices_with_friends:' . $member->profile_id));
312 $cache->delete(common_cache_key('user:notices_with_friends:' . $member->profile_id . ';last'));
318 $group_inbox->free();
323 function blowTagCache($blowLast=false)
325 $cache = common_memcache();
327 $tag = new Notice_tag();
328 $tag->notice_id = $this->id;
330 while ($tag->fetch()) {
331 $cache->delete(common_cache_key('notice_tag:notice_stream:' . $tag->tag));
333 $cache->delete(common_cache_key('notice_tag:notice_stream:' . $tag->tag . ';last'));
342 function blowSubsCache($blowLast=false)
344 $cache = common_memcache();
348 $UT = common_config('db','type')=='pgsql'?'"user"':'user';
349 $user->query('SELECT id ' .
351 "FROM $UT JOIN subscription ON $UT.id = subscription.subscriber " .
352 'WHERE subscription.subscribed = ' . $this->profile_id);
354 while ($user->fetch()) {
355 $cache->delete(common_cache_key('user:notices_with_friends:' . $user->id));
357 $cache->delete(common_cache_key('user:notices_with_friends:' . $user->id . ';last'));
365 function blowNoticeCache($blowLast=false)
367 if ($this->is_local) {
368 $cache = common_memcache();
370 $cache->delete(common_cache_key('profile:notices:'.$this->profile_id));
372 $cache->delete(common_cache_key('profile:notices:'.$this->profile_id.';last'));
378 function blowRepliesCache($blowLast=false)
380 $cache = common_memcache();
382 $reply = new Reply();
383 $reply->notice_id = $this->id;
384 if ($reply->find()) {
385 while ($reply->fetch()) {
386 $cache->delete(common_cache_key('user:replies:'.$reply->profile_id));
388 $cache->delete(common_cache_key('user:replies:'.$reply->profile_id.';last'));
397 function blowPublicCache($blowLast=false)
399 if ($this->is_local == 1) {
400 $cache = common_memcache();
402 $cache->delete(common_cache_key('public'));
404 $cache->delete(common_cache_key('public').';last');
410 function blowFavesCache($blowLast=false)
412 $cache = common_memcache();
415 $fave->notice_id = $this->id;
417 while ($fave->fetch()) {
418 $cache->delete(common_cache_key('user:faves:'.$fave->user_id));
420 $cache->delete(common_cache_key('user:faves:'.$fave->user_id.';last'));
429 # XXX: too many args; we need to move to named params or even a separate
430 # class for notice streams
432 static function getStream($qry, $cachekey, $offset=0, $limit=20, $since_id=0, $before_id=0, $order=null, $since=null) {
434 if (common_config('memcached', 'enabled')) {
436 # Skip the cache if this is a since, since_id or before_id qry
437 if ($since_id > 0 || $before_id > 0 || $since) {
438 return Notice::getStreamDirect($qry, $offset, $limit, $since_id, $before_id, $order, $since);
440 return Notice::getCachedStream($qry, $cachekey, $offset, $limit, $order);
444 return Notice::getStreamDirect($qry, $offset, $limit, $since_id, $before_id, $order, $since);
447 static function getStreamDirect($qry, $offset, $limit, $since_id, $before_id, $order, $since) {
452 if (preg_match('/\bWHERE\b/i', $qry)) {
466 $qry .= ' notice.id > ' . $since_id;
469 if ($before_id > 0) {
478 $qry .= ' notice.id < ' . $before_id;
490 $qry .= ' notice.created > \'' . date('Y-m-d H:i:s', $since) . '\'';
493 # Allow ORDER override
498 $qry .= ' ORDER BY notice.created DESC, notice.id DESC ';
501 if (common_config('db','type') == 'pgsql') {
502 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
504 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
507 $notice = new Notice();
509 $notice->query($qry);
514 # XXX: this is pretty long and should probably be broken up into
515 # some helper functions
517 static function getCachedStream($qry, $cachekey, $offset, $limit, $order) {
519 # If outside our cache window, just go to the DB
521 if ($offset + $limit > NOTICE_CACHE_WINDOW) {
522 return Notice::getStreamDirect($qry, $offset, $limit, null, null, $order, null);
525 # Get the cache; if we can't, just go to the DB
527 $cache = common_memcache();
530 return Notice::getStreamDirect($qry, $offset, $limit, null, null, $order, null);
533 # Get the notices out of the cache
535 $notices = $cache->get(common_cache_key($cachekey));
537 # On a cache hit, return a DB-object-like wrapper
539 if ($notices !== false) {
540 $wrapper = new ArrayWrapper(array_slice($notices, $offset, $limit));
544 # If the cache was invalidated because of new data being
545 # added, we can try and just get the new stuff. We keep an additional
546 # copy of the data at the key + ';last'
548 # No cache hit. Try to get the *last* cached version
550 $last_notices = $cache->get(common_cache_key($cachekey) . ';last');
554 # Reverse-chron order, so last ID is last.
556 $last_id = $last_notices[0]->id;
558 # XXX: this assumes monotonically increasing IDs; a fair
561 $new_notice = Notice::getStreamDirect($qry, 0, NOTICE_CACHE_WINDOW,
562 $last_id, null, $order, null);
565 $new_notices = array();
566 while ($new_notice->fetch()) {
567 $new_notices[] = clone($new_notice);
570 $notices = array_slice(array_merge($new_notices, $last_notices),
571 0, NOTICE_CACHE_WINDOW);
573 # Store the array in the cache for next time
575 $result = $cache->set(common_cache_key($cachekey), $notices);
576 $result = $cache->set(common_cache_key($cachekey) . ';last', $notices);
578 # return a wrapper of the array for use now
580 return new ArrayWrapper(array_slice($notices, $offset, $limit));
584 # Otherwise, get the full cache window out of the DB
586 $notice = Notice::getStreamDirect($qry, 0, NOTICE_CACHE_WINDOW, null, null, $order, null);
588 # If there are no hits, just return the value
594 # Pack results into an array
598 while ($notice->fetch()) {
599 $notices[] = clone($notice);
604 # Store the array in the cache for next time
606 $result = $cache->set(common_cache_key($cachekey), $notices);
607 $result = $cache->set(common_cache_key($cachekey) . ';last', $notices);
609 # return a wrapper of the array for use now
611 $wrapper = new ArrayWrapper(array_slice($notices, $offset, $limit));
616 function publicStream($offset=0, $limit=20, $since_id=0, $before_id=0, $since=null)
621 $qry = 'SELECT * FROM notice ';
623 if (common_config('public', 'localonly')) {
624 $parts[] = 'is_local = 1';
627 $parts[] = 'is_local != -1';
631 $qry .= ' WHERE ' . implode(' AND ', $parts);
634 return Notice::getStream($qry,
636 $offset, $limit, $since_id, $before_id, null, $since);
639 function addToInboxes()
641 $enabled = common_config('inboxes', 'enabled');
643 if ($enabled === true || $enabled === 'transitional') {
644 $inbox = new Notice_inbox();
645 $UT = common_config('db','type')=='pgsql'?'"user"':'user';
646 $qry = 'INSERT INTO notice_inbox (user_id, notice_id, created) ' .
647 "SELECT $UT.id, " . $this->id . ", '" . $this->created . "' " .
648 "FROM $UT JOIN subscription ON $UT.id = subscription.subscriber " .
649 'WHERE subscription.subscribed = ' . $this->profile_id . ' ' .
650 'AND NOT EXISTS (SELECT user_id, notice_id ' .
651 'FROM notice_inbox ' .
652 "WHERE user_id = $UT.id " .
653 'AND notice_id = ' . $this->id . ' )';
654 if ($enabled === 'transitional') {
655 $qry .= " AND $UT.inboxed = 1";
662 function addToAuthorInbox()
664 $enabled = common_config('inboxes', 'enabled');
666 if ($enabled === true || $enabled === 'transitional') {
667 $user = User::staticGet('id', $this->profile_id);
671 $inbox = new Notice_inbox();
672 $UT = common_config('db','type')=='pgsql'?'"user"':'user';
673 $qry = 'INSERT INTO notice_inbox (user_id, notice_id, created) ' .
674 "SELECT $UT.id, " . $this->id . ", '" . $this->created . "' " .
676 "WHERE $UT.id = " . $this->profile_id . ' ' .
677 'AND NOT EXISTS (SELECT user_id, notice_id ' .
678 'FROM notice_inbox ' .
679 "WHERE user_id = " . $this->profile_id . ' '.
680 'AND notice_id = ' . $this->id . ' )';
681 if ($enabled === 'transitional') {
682 $qry .= " AND $UT.inboxed = 1";
689 function saveGroups()
691 $enabled = common_config('inboxes', 'enabled');
692 if ($enabled !== true && $enabled !== 'transitional') {
696 /* extract all !group */
697 $count = preg_match_all('/(?:^|\s)!([A-Za-z0-9]{1,64})/',
698 strtolower($this->content),
704 $profile = $this->getProfile();
706 /* Add them to the database */
708 foreach (array_unique($match[1]) as $nickname) {
709 /* XXX: remote groups. */
710 $group = User_group::staticGet('nickname', $nickname);
716 // we automatically add a tag for every group name, too
718 $tag = Notice_tag::pkeyGet(array('tag' => common_canonical_tag($nickname),
719 'notice_id' => $this->id));
722 $this->saveTag($nickname);
725 if ($profile->isMember($group)) {
727 $gi = new Group_inbox();
729 $gi->group_id = $group->id;
730 $gi->notice_id = $this->id;
731 $gi->created = common_sql_now();
733 $result = $gi->insert();
736 common_log_db_error($gi, 'INSERT', __FILE__);
739 // FIXME: do this in an offline daemon
741 $this->addToGroupInboxes($group);
746 function addToGroupInboxes($group)
748 $inbox = new Notice_inbox();
749 $UT = common_config('db','type')=='pgsql'?'"user"':'user';
750 $qry = 'INSERT INTO notice_inbox (user_id, notice_id, created, source) ' .
751 "SELECT $UT.id, " . $this->id . ", '" . $this->created . "', 2 " .
752 "FROM $UT JOIN group_member ON $UT.id = group_member.profile_id " .
753 'WHERE group_member.group_id = ' . $group->id . ' ' .
754 'AND NOT EXISTS (SELECT user_id, notice_id ' .
755 'FROM notice_inbox ' .
756 "WHERE user_id = $UT.id " .
757 'AND notice_id = ' . $this->id . ' )';
758 if ($enabled === 'transitional') {
759 $qry .= " AND $UT.inboxed = 1";
761 $result = $inbox->query($qry);
764 function saveReplies()
766 // Alternative reply format
768 if (preg_match('/^T ([A-Z0-9]{1,64}) /', $this->content, $match)) {
771 // extract all @messages
772 $cnt = preg_match_all('/(?:^|\s)@([a-z0-9]{1,64})/', $this->content, $match);
776 if ($cnt || $tname) {
777 // XXX: is there another way to make an array copy?
778 $names = ($tname) ? array_unique(array_merge(array(strtolower($tname)), $match[1])) : array_unique($match[1]);
781 $sender = Profile::staticGet($this->profile_id);
785 // store replied only for first @ (what user/notice what the reply directed,
786 // we assume first @ is it)
788 for ($i=0; $i<count($names); $i++) {
789 $nickname = $names[$i];
790 $recipient = common_relative_profile($sender, $nickname, $this->created);
794 if ($i == 0 && ($recipient->id != $sender->id) && !$this->reply_to) { // Don't save reply to self
795 $reply_for = $recipient;
796 $recipient_notice = $reply_for->getCurrentNotice();
797 if ($recipient_notice) {
798 $orig = clone($this);
799 $this->reply_to = $recipient_notice->id;
800 $this->update($orig);
803 // Don't save replies from blocked profile to local user
804 $recipient_user = User::staticGet('id', $recipient->id);
805 if ($recipient_user && $recipient_user->hasBlocked($sender)) {
808 $reply = new Reply();
809 $reply->notice_id = $this->id;
810 $reply->profile_id = $recipient->id;
811 $id = $reply->insert();
813 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
814 common_log(LOG_ERR, 'DB error inserting reply: ' . $last_error->message);
815 common_server_error(sprintf(_('DB error inserting reply: %s'), $last_error->message));
818 $replied[$recipient->id] = 1;
822 // Hash format replies, too
823 $cnt = preg_match_all('/(?:^|\s)@#([a-z0-9]{1,64})/', $this->content, $match);
825 foreach ($match[1] as $tag) {
826 $tagged = Profile_tag::getTagged($sender->id, $tag);
827 foreach ($tagged as $t) {
828 if (!$replied[$t->id]) {
829 // Don't save replies from blocked profile to local user
830 $t_user = User::staticGet('id', $t->id);
831 if ($t_user && $t_user->hasBlocked($sender)) {
834 $reply = new Reply();
835 $reply->notice_id = $this->id;
836 $reply->profile_id = $t->id;
837 $id = $reply->insert();
839 common_log_db_error($reply, 'INSERT', __FILE__);
842 $replied[$recipient->id] = 1;
849 foreach (array_keys($replied) as $recipient) {
850 $user = User::staticGet('id', $recipient);
852 mail_notify_attn($user, $this);
857 function asAtomEntry($namespace=false, $source=false)
859 $profile = $this->getProfile();
861 $xs = new XMLStringer(true);
864 $attrs = array('xmlns' => 'http://www.w3.org/2005/Atom',
865 'xmlns:thr' => 'http://purl.org/syndication/thread/1.0');
870 $xs->elementStart('entry', $attrs);
873 $xs->elementStart('source');
874 $xs->element('title', null, $profile->nickname . " - " . common_config('site', 'name'));
875 $xs->element('link', array('href' => $profile->profileurl));
876 $user = User::staticGet('id', $profile->id);
878 $atom_feed = common_local_url('api',
879 array('apiaction' => 'statuses',
880 'method' => 'user_timeline',
881 'argument' => $profile->nickname.'.atom'));
882 $xs->element('link', array('rel' => 'self',
883 'type' => 'application/atom+xml',
884 'href' => $profile->profileurl));
885 $xs->element('link', array('rel' => 'license',
886 'href' => common_config('license', 'url')));
889 $xs->element('icon', null, $profile->avatarUrl(AVATAR_PROFILE_SIZE));
892 $xs->elementStart('author');
893 $xs->element('name', null, $profile->nickname);
894 $xs->element('uri', null, $profile->profileurl);
895 $xs->elementEnd('author');
898 $xs->elementEnd('source');
901 $xs->element('title', null, $this->content);
902 $xs->element('summary', null, $this->content);
904 $xs->element('link', array('rel' => 'alternate',
905 'href' => $this->bestUrl()));
907 $xs->element('id', null, $this->uri);
909 $xs->element('published', null, common_date_w3dtf($this->created));
910 $xs->element('updated', null, common_date_w3dtf($this->modified));
912 if ($this->reply_to) {
913 $reply_notice = Notice::staticGet('id', $this->reply_to);
914 if (!empty($reply_notice)) {
915 $xs->element('link', array('rel' => 'related',
916 'href' => $reply_notice->bestUrl()));
917 $xs->element('thr:in-reply-to',
918 array('ref' => $reply_notice->uri,
919 'href' => $reply_notice->bestUrl()));
923 $xs->element('content', array('type' => 'html'), $this->rendered);
925 $tag = new Notice_tag();
926 $tag->notice_id = $this->id;
928 while ($tag->fetch()) {
929 $xs->element('category', array('term' => $tag->tag));
934 $xs->elementEnd('entry');
936 return $xs->getString();
941 if (!empty($this->url)) {
943 } else if (!empty($this->uri) && preg_match('/^https?:/', $this->uri)) {
946 return common_local_url('shownotice',
947 array('notice' => $this->id));