3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2008, 2009, StatusNet, 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/>.
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/
35 if (!defined('STATUSNET') && !defined('LACONICA')) {
40 * Table Definition for notice
42 require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
44 /* We keep the first three 20-notice pages, plus one for pagination check,
45 * in the memcached cache. */
47 define('NOTICE_CACHE_WINDOW', 61);
49 define('MAX_BOXCARS', 128);
51 class Notice extends Memcached_DataObject
54 /* the code below is auto generated do not remove the above tag */
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)
76 function staticGet($k,$v=NULL)
78 return Memcached_DataObject::staticGet('Notice',$k,$v);
81 /* the code above is auto generated do not remove the tag below */
85 const LOCAL_PUBLIC = 1;
87 const LOCAL_NONPUBLIC = -1;
92 return Profile::staticGet('id', $this->profile_id);
97 // For auditing purposes, save a record that the notice
100 $deleted = new Deleted_notice();
102 $deleted->id = $this->id;
103 $deleted->profile_id = $this->profile_id;
104 $deleted->uri = $this->uri;
105 $deleted->created = $this->created;
106 $deleted->deleted = common_sql_now();
110 // Clear related records
112 $this->clearReplies();
113 $this->clearRepeats();
116 $this->clearGroupInboxes();
118 // NOTE: we don't clear inboxes
119 // NOTE: we don't clear queue items
121 $result = parent::delete();
125 * Extract #hashtags from this notice's content and save them to the database.
129 /* extract all #hastags */
130 $count = preg_match_all('/(?:^|\s)#([\pL\pN_\-\.]{1,64})/', strtolower($this->content), $match);
135 /* Add them to the database */
136 return $this->saveKnownTags($match[1]);
140 * Record the given set of hash tags in the db for this notice.
141 * Given tag strings will be normalized and checked for dupes.
143 function saveKnownTags($hashtags)
145 //turn each into their canonical tag
146 //this is needed to remove dupes before saving e.g. #hash.tag = #hashtag
147 for($i=0; $i<count($hashtags); $i++) {
148 $hashtags[$i] = common_canonical_tag($hashtags[$i]);
151 foreach(array_unique($hashtags) as $hashtag) {
152 /* elide characters we don't want in the tag */
153 $this->saveTag($hashtag);
154 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, $hashtag);
160 * Record a single hash tag as associated with this notice.
161 * Tag format and uniqueness must be validated by caller.
163 function saveTag($hashtag)
165 $tag = new Notice_tag();
166 $tag->notice_id = $this->id;
167 $tag->tag = $hashtag;
168 $tag->created = $this->created;
169 $id = $tag->insert();
172 throw new ServerException(sprintf(_('DB error inserting hashtag: %s'),
173 $last_error->message));
177 // if it's saved, blow its cache
178 $tag->blowCache(false);
182 * Save a new notice and push it out to subscribers' inboxes.
183 * Poster's permissions are checked before sending.
185 * @param int $profile_id Profile ID of the poster
186 * @param string $content source message text; links may be shortened
187 * per current user's preference
188 * @param string $source source key ('web', 'api', etc)
189 * @param array $options Associative array of optional properties:
190 * string 'created' timestamp of notice; defaults to now
191 * int 'is_local' source/gateway ID, one of:
192 * Notice::LOCAL_PUBLIC - Local, ok to appear in public timeline
193 * Notice::REMOTE_OMB - Sent from a remote OMB service;
194 * hide from public timeline but show in
195 * local "and friends" timelines
196 * Notice::LOCAL_NONPUBLIC - Local, but hide from public timeline
197 * Notice::GATEWAY - From another non-OMB service;
198 * will not appear in public views
199 * float 'lat' decimal latitude for geolocation
200 * float 'lon' decimal longitude for geolocation
201 * int 'location_id' geoname identifier
202 * int 'location_ns' geoname namespace to interpret location_id
203 * int 'reply_to'; notice ID this is a reply to
204 * int 'repeat_of'; notice ID this is a repeat of
205 * string 'uri' unique ID for notice; defaults to local notice URL
206 * string 'url' permalink to notice; defaults to local notice URL
207 * string 'rendered' rendered HTML version of content
208 * array 'replies' list of profile URIs for reply delivery in
209 * place of extracting @-replies from content.
210 * array 'groups' list of group IDs to deliver to, in place of
211 * extracting ! tags from content
212 * array 'tags' list of hashtag strings to save with the notice
213 * in place of extracting # tags from content
214 * array 'urls' list of attached/referred URLs to save with the
215 * notice in place of extracting links from content
216 * @fixme tag override
219 * @throws ClientException
221 static function saveNew($profile_id, $content, $source, $options=null) {
222 $defaults = array('uri' => null,
225 'repeat_of' => null);
227 if (!empty($options)) {
228 $options = $options + $defaults;
232 if (!isset($is_local)) {
233 $is_local = Notice::LOCAL_PUBLIC;
236 $profile = Profile::staticGet($profile_id);
238 $final = common_shorten_links($content);
240 if (Notice::contentTooLong($final)) {
241 throw new ClientException(_('Problem saving notice. Too long.'));
244 if (empty($profile)) {
245 throw new ClientException(_('Problem saving notice. Unknown user.'));
248 if (common_config('throttle', 'enabled') && !Notice::checkEditThrottle($profile_id)) {
249 common_log(LOG_WARNING, 'Excessive posting by profile #' . $profile_id . '; throttled.');
250 throw new ClientException(_('Too many notices too fast; take a breather '.
251 'and post again in a few minutes.'));
254 if (common_config('site', 'dupelimit') > 0 && !Notice::checkDupes($profile_id, $final)) {
255 common_log(LOG_WARNING, 'Dupe posting by profile #' . $profile_id . '; throttled.');
256 throw new ClientException(_('Too many duplicate messages too quickly;'.
257 ' take a breather and post again in a few minutes.'));
260 if (!$profile->hasRight(Right::NEWNOTICE)) {
261 common_log(LOG_WARNING, "Attempted post from user disallowed to post: " . $profile->nickname);
262 throw new ClientException(_('You are banned from posting notices on this site.'));
265 $notice = new Notice();
266 $notice->profile_id = $profile_id;
268 $autosource = common_config('public', 'autosource');
270 # Sandboxed are non-false, but not 1, either
272 if (!$profile->hasRight(Right::PUBLICNOTICE) ||
273 ($source && $autosource && in_array($source, $autosource))) {
274 $notice->is_local = Notice::LOCAL_NONPUBLIC;
276 $notice->is_local = $is_local;
279 if (!empty($created)) {
280 $notice->created = $created;
282 $notice->created = common_sql_now();
285 $notice->content = $final;
287 $notice->source = $source;
291 // Handle repeat case
293 if (isset($repeat_of)) {
294 $notice->repeat_of = $repeat_of;
296 $notice->reply_to = self::getReplyTo($reply_to, $profile_id, $source, $final);
299 if (!empty($notice->reply_to)) {
300 $reply = Notice::staticGet('id', $notice->reply_to);
301 $notice->conversation = $reply->conversation;
304 if (!empty($lat) && !empty($lon)) {
309 if (!empty($location_ns) && !empty($location_id)) {
310 $notice->location_id = $location_id;
311 $notice->location_ns = $location_ns;
314 if (!empty($rendered)) {
315 $notice->rendered = $rendered;
317 $notice->rendered = common_render_content($final, $notice);
320 if (Event::handle('StartNoticeSave', array(&$notice))) {
322 // XXX: some of these functions write to the DB
324 $id = $notice->insert();
327 common_log_db_error($notice, 'INSERT', __FILE__);
328 throw new ServerException(_('Problem saving notice.'));
331 // Update ID-dependent columns: URI, conversation
333 $orig = clone($notice);
338 $notice->uri = common_notice_uri($notice);
342 // If it's not part of a conversation, it's
343 // the beginning of a new conversation.
345 if (empty($notice->conversation)) {
346 $conv = Conversation::create();
347 $notice->conversation = $conv->id;
352 if (!$notice->update($orig)) {
353 common_log_db_error($notice, 'UPDATE', __FILE__);
354 throw new ServerException(_('Problem saving notice.'));
360 # Clear the cache for subscribed users, so they'll update at next request
361 # XXX: someone clever could prepend instead of clearing the cache
363 $notice->blowOnInsert();
365 // Save per-notice metadata...
367 if (isset($replies)) {
368 $notice->saveKnownReplies($replies);
370 $notice->saveReplies();
373 if (isset($groups)) {
374 $notice->saveKnownGroups($groups);
376 $notice->saveGroups();
380 $notice->saveKnownTags($tags);
386 $notice->saveKnownUrls($urls);
391 // Prepare inbox delivery, may be queued to background.
392 $notice->distribute();
397 function blowOnInsert($conversation = false)
399 self::blow('profile:notice_ids:%d', $this->profile_id);
400 self::blow('public');
402 // XXX: Before we were blowing the casche only if the notice id
403 // was not the root of the conversation. What to do now?
405 self::blow('notice:conversation_ids:%d', $this->conversation);
407 if (!empty($this->repeat_of)) {
408 self::blow('notice:repeats:%d', $this->repeat_of);
411 $original = Notice::staticGet('id', $this->repeat_of);
413 if (!empty($original)) {
414 $originalUser = User::staticGet('id', $original->profile_id);
415 if (!empty($originalUser)) {
416 self::blow('user:repeats_of_me:%d', $originalUser->id);
420 $profile = Profile::staticGet($this->profile_id);
421 $profile->blowNoticeCount();
424 /** save all urls in the notice to the db
426 * follow redirects and save all available file information
427 * (mimetype, date, size, oembed, etc.)
431 function saveUrls() {
432 common_replace_urls_callback($this->content, array($this, 'saveUrl'), $this->id);
436 * Save the given URLs as related links/attachments to the db
438 * follow redirects and save all available file information
439 * (mimetype, date, size, oembed, etc.)
443 function saveKnownUrls($urls)
445 // @fixme validation?
446 foreach ($urls as $url) {
447 File::processNew($url, $this->id);
454 function saveUrl($data) {
455 list($url, $notice_id) = $data;
456 File::processNew($url, $notice_id);
459 static function checkDupes($profile_id, $content) {
460 $profile = Profile::staticGet($profile_id);
461 if (empty($profile)) {
464 $notice = $profile->getNotices(0, NOTICE_CACHE_WINDOW);
465 if (!empty($notice)) {
467 while ($notice->fetch()) {
468 if (time() - strtotime($notice->created) >= common_config('site', 'dupelimit')) {
470 } else if ($notice->content == $content) {
475 # If we get here, oldest item in cache window is not
476 # old enough for dupe limit; do direct check against DB
477 $notice = new Notice();
478 $notice->profile_id = $profile_id;
479 $notice->content = $content;
480 if (common_config('db','type') == 'pgsql')
481 $notice->whereAdd('extract(epoch from now() - created) < ' . common_config('site', 'dupelimit'));
483 $notice->whereAdd('now() - created < ' . common_config('site', 'dupelimit'));
485 $cnt = $notice->count();
489 static function checkEditThrottle($profile_id) {
490 $profile = Profile::staticGet($profile_id);
491 if (empty($profile)) {
495 $notice = $profile->getNotices(common_config('throttle', 'count') - 1, 1);
496 if ($notice && $notice->fetch()) {
497 # If the Nth notice was posted less than timespan seconds ago
498 if (time() - strtotime($notice->created) <= common_config('throttle', 'timespan')) {
503 # Either not N notices in the stream, OR the Nth was not posted within timespan seconds
507 function getUploadedAttachment() {
509 $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"';
510 $post->query($query);
512 if (empty($post->up) || empty($post->i)) {
515 $ret = array($post->up, $post->i);
521 function hasAttachments() {
523 $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);
524 $post->query($query);
526 $n_attachments = intval($post->n_attachments);
528 return $n_attachments;
531 function attachments() {
534 $f2p = new File_to_post;
535 $f2p->post_id = $this->id;
537 while ($f2p->fetch()) {
538 $f = File::staticGet($f2p->file_id);
545 function getStreamByIds($ids)
547 $cache = common_memcache();
549 if (!empty($cache)) {
551 foreach ($ids as $id) {
552 $n = Notice::staticGet('id', $id);
557 return new ArrayWrapper($notices);
559 $notice = new Notice();
561 //if no IDs requested, just return the notice object
564 $notice->whereAdd('id in (' . implode(', ', $ids) . ')');
570 while ($notice->fetch()) {
571 $temp[$notice->id] = clone($notice);
576 foreach ($ids as $id) {
577 if (array_key_exists($id, $temp)) {
578 $wrapped[] = $temp[$id];
582 return new ArrayWrapper($wrapped);
586 function publicStream($offset=0, $limit=20, $since_id=0, $max_id=0)
588 $ids = Notice::stream(array('Notice', '_publicStreamDirect'),
591 $offset, $limit, $since_id, $max_id);
593 return Notice::getStreamByIds($ids);
596 function _publicStreamDirect($offset=0, $limit=20, $since_id=0, $max_id=0)
598 $notice = new Notice();
600 $notice->selectAdd(); // clears it
601 $notice->selectAdd('id');
603 $notice->orderBy('id DESC');
605 if (!is_null($offset)) {
606 $notice->limit($offset, $limit);
609 if (common_config('public', 'localonly')) {
610 $notice->whereAdd('is_local = ' . Notice::LOCAL_PUBLIC);
612 # -1 == blacklisted, -2 == gateway (i.e. Twitter)
613 $notice->whereAdd('is_local !='. Notice::LOCAL_NONPUBLIC);
614 $notice->whereAdd('is_local !='. Notice::GATEWAY);
617 if ($since_id != 0) {
618 $notice->whereAdd('id > ' . $since_id);
622 $notice->whereAdd('id <= ' . $max_id);
627 if ($notice->find()) {
628 while ($notice->fetch()) {
629 $ids[] = $notice->id;
639 function conversationStream($id, $offset=0, $limit=20, $since_id=0, $max_id=0)
641 $ids = Notice::stream(array('Notice', '_conversationStreamDirect'),
643 'notice:conversation_ids:'.$id,
644 $offset, $limit, $since_id, $max_id);
646 return Notice::getStreamByIds($ids);
649 function _conversationStreamDirect($id, $offset=0, $limit=20, $since_id=0, $max_id=0)
651 $notice = new Notice();
653 $notice->selectAdd(); // clears it
654 $notice->selectAdd('id');
656 $notice->conversation = $id;
658 $notice->orderBy('id DESC');
660 if (!is_null($offset)) {
661 $notice->limit($offset, $limit);
664 if ($since_id != 0) {
665 $notice->whereAdd('id > ' . $since_id);
669 $notice->whereAdd('id <= ' . $max_id);
674 if ($notice->find()) {
675 while ($notice->fetch()) {
676 $ids[] = $notice->id;
687 * @param $groups array of Group *objects*
688 * @param $recipients array of profile *ids*
690 function whoGets($groups=null, $recipients=null)
692 $c = self::memcache();
695 $ni = $c->get(common_cache_key('notice:who_gets:'.$this->id));
701 if (is_null($groups)) {
702 $groups = $this->getGroups();
705 if (is_null($recipients)) {
706 $recipients = $this->getReplies();
709 $users = $this->getSubscribedUsers();
711 // FIXME: kind of ignoring 'transitional'...
712 // we'll probably stop supporting inboxless mode
717 foreach ($users as $id) {
718 $ni[$id] = NOTICE_INBOX_SOURCE_SUB;
721 $profile = $this->getProfile();
723 foreach ($groups as $group) {
724 $users = $group->getUserMembers();
725 foreach ($users as $id) {
726 if (!array_key_exists($id, $ni)) {
727 $user = User::staticGet('id', $id);
728 if (!$user->hasBlocked($profile)) {
729 $ni[$id] = NOTICE_INBOX_SOURCE_GROUP;
735 foreach ($recipients as $recipient) {
737 if (!array_key_exists($recipient, $ni)) {
738 $recipientUser = User::staticGet('id', $recipient);
739 if (!empty($recipientUser)) {
740 $ni[$recipient] = NOTICE_INBOX_SOURCE_REPLY;
746 // XXX: pack this data better
747 $c->set(common_cache_key('notice:who_gets:'.$this->id), $ni);
754 * Adds this notice to the inboxes of each local user who should receive
755 * it, based on author subscriptions, group memberships, and @-replies.
757 * Warning: running a second time currently will make items appear
758 * multiple times in users' inboxes.
760 * @fixme make more robust against errors
761 * @fixme break up massive deliveries to smaller background tasks
763 * @param array $groups optional list of Group objects;
764 * if left empty, will be loaded from group_inbox records
765 * @param array $recipient optional list of reply profile ids
766 * if left empty, will be loaded from reply records
768 function addToInboxes($groups=null, $recipients=null)
770 $ni = $this->whoGets($groups, $recipients);
772 $ids = array_keys($ni);
774 // We remove the author (if they're a local user),
775 // since we'll have already done this in distribute()
777 $i = array_search($this->profile_id, $ids);
785 Inbox::bulkInsert($this->id, $ids);
790 function getSubscribedUsers()
794 if(common_config('db','quote_identifiers'))
795 $user_table = '"user"';
796 else $user_table = 'user';
800 'FROM '. $user_table .' JOIN subscription '.
801 'ON '. $user_table .'.id = subscription.subscriber ' .
802 'WHERE subscription.subscribed = %d ';
804 $user->query(sprintf($qry, $this->profile_id));
808 while ($user->fetch()) {
818 * Record this notice to the given group inboxes for delivery.
819 * Overrides the regular parsing of !group markup.
821 * @param string $group_ids
822 * @fixme might prefer URIs as identifiers, as for replies?
823 * best with generalizations on user_group to support
824 * remote groups better.
826 function saveKnownGroups($group_ids)
828 if (!is_array($group_ids)) {
829 throw new ServerException("Bad type provided to saveKnownGroups");
833 foreach ($group_ids as $id) {
834 $group = User_group::staticGet('id', $id);
836 common_log(LOG_ERR, "Local delivery to group id $id, $group->nickname");
837 $result = $this->addToGroupInbox($group);
839 common_log_db_error($gi, 'INSERT', __FILE__);
842 // @fixme should we save the tags here or not?
843 $groups[] = clone($group);
845 common_log(LOG_ERR, "Local delivery to group id $id skipped, doesn't exist");
853 * Parse !group delivery and record targets into group_inbox.
854 * @return array of Group objects
856 function saveGroups()
858 // Don't save groups for repeats
860 if (!empty($this->repeat_of)) {
866 /* extract all !group */
867 $count = preg_match_all('/(?:^|\s)!([A-Za-z0-9]{1,64})/',
868 strtolower($this->content),
874 $profile = $this->getProfile();
876 /* Add them to the database */
878 foreach (array_unique($match[1]) as $nickname) {
879 /* XXX: remote groups. */
880 $group = User_group::getForNickname($nickname);
886 // we automatically add a tag for every group name, too
888 $tag = Notice_tag::pkeyGet(array('tag' => common_canonical_tag($nickname),
889 'notice_id' => $this->id));
892 $this->saveTag($nickname);
895 if ($profile->isMember($group)) {
897 $result = $this->addToGroupInbox($group);
900 common_log_db_error($gi, 'INSERT', __FILE__);
903 $groups[] = clone($group);
910 function addToGroupInbox($group)
912 $gi = Group_inbox::pkeyGet(array('group_id' => $group->id,
913 'notice_id' => $this->id));
917 $gi = new Group_inbox();
919 $gi->group_id = $group->id;
920 $gi->notice_id = $this->id;
921 $gi->created = $this->created;
923 $result = $gi->insert();
926 common_log_db_error($gi, 'INSERT', __FILE__);
927 throw new ServerException(_('Problem saving group inbox.'));
930 self::blow('user_group:notice_ids:%d', $gi->group_id);
937 * Save reply records indicating that this notice needs to be
938 * delivered to the local users with the given URIs.
940 * Since this is expected to be used when saving foreign-sourced
941 * messages, we won't deliver to any remote targets as that's the
942 * source service's responsibility.
944 * @fixme Unlike saveReplies() there's no mail notification here.
945 * Move that to distrib queue handler?
947 * @param array of unique identifier URIs for recipients
949 function saveKnownReplies($uris)
951 foreach ($uris as $uri) {
953 $user = User::staticGet('uri', $uri);
957 $reply = new Reply();
959 $reply->notice_id = $this->id;
960 $reply->profile_id = $user->id;
962 $id = $reply->insert();
964 self::blow('reply:stream:%d', $user->id);
972 * Pull @-replies from this message's content in StatusNet markup format
973 * and save reply records indicating that this message needs to be
974 * delivered to those users.
976 * Side effect: local recipients get e-mail notifications here.
977 * @fixme move mail notifications to distrib?
979 * @return array of integer profile IDs
982 function saveReplies()
984 // Don't save reply data for repeats
986 if (!empty($this->repeat_of)) {
990 $sender = Profile::staticGet($this->profile_id);
992 // @todo ideally this parser information would only
993 // be calculated once.
995 $mentions = common_find_mentions($this->content, $this);
999 // store replied only for first @ (what user/notice what the reply directed,
1000 // we assume first @ is it)
1002 foreach ($mentions as $mention) {
1004 foreach ($mention['mentioned'] as $mentioned) {
1006 // skip if they're already covered
1008 if (!empty($replied[$mentioned->id])) {
1012 // Don't save replies from blocked profile to local user
1014 $mentioned_user = User::staticGet('id', $mentioned->id);
1015 if (!empty($mentioned_user) && $mentioned_user->hasBlocked($sender)) {
1019 $reply = new Reply();
1021 $reply->notice_id = $this->id;
1022 $reply->profile_id = $mentioned->id;
1024 $id = $reply->insert();
1027 common_log_db_error($reply, 'INSERT', __FILE__);
1028 throw new ServerException("Couldn't save reply for {$this->id}, {$mentioned->id}");
1030 $replied[$mentioned->id] = 1;
1035 $recipientIds = array_keys($replied);
1037 foreach ($recipientIds as $recipientId) {
1038 $user = User::staticGet('id', $recipientId);
1039 if (!empty($user)) {
1040 self::blow('reply:stream:%d', $reply->profile_id);
1041 mail_notify_attn($user, $this);
1045 return $recipientIds;
1048 function getReplies()
1054 $reply = new Reply();
1055 $reply->selectAdd();
1056 $reply->selectAdd('profile_id');
1057 $reply->notice_id = $this->id;
1059 if ($reply->find()) {
1060 while($reply->fetch()) {
1061 $ids[] = $reply->profile_id;
1071 * Pull list of groups this notice needs to be delivered to,
1072 * as previously recorded by saveGroups() or saveKnownGroups().
1074 * @return array of Group objects
1076 function getGroups()
1078 // Don't save groups for repeats
1080 if (!empty($this->repeat_of)) {
1088 $gi = new Group_inbox();
1091 $gi->selectAdd('group_id');
1093 $gi->notice_id = $this->id;
1096 while ($gi->fetch()) {
1097 $group = User_group::staticGet('id', $gi->group_id);
1109 function asAtomEntry($namespace=false, $source=false)
1111 $profile = $this->getProfile();
1113 $xs = new XMLStringer(true);
1116 $attrs = array('xmlns' => 'http://www.w3.org/2005/Atom',
1117 'xmlns:thr' => 'http://purl.org/syndication/thread/1.0',
1118 'xmlns:georss' => 'http://www.georss.org/georss',
1119 'xmlns:activity' => 'http://activitystrea.ms/spec/1.0/',
1120 'xmlns:media' => 'http://purl.org/syndication/atommedia',
1121 'xmlns:poco' => 'http://portablecontacts.net/spec/1.0',
1122 'xmlns:ostatus' => 'http://ostatus.org/schema/1.0');
1127 $xs->elementStart('entry', $attrs);
1130 $xs->elementStart('source');
1131 $xs->element('title', null, $profile->nickname . " - " . common_config('site', 'name'));
1132 $xs->element('link', array('href' => $profile->profileurl));
1133 $user = User::staticGet('id', $profile->id);
1134 if (!empty($user)) {
1135 $atom_feed = common_local_url('ApiTimelineUser',
1136 array('format' => 'atom',
1137 'id' => $profile->nickname));
1138 $xs->element('link', array('rel' => 'self',
1139 'type' => 'application/atom+xml',
1140 'href' => $profile->profileurl));
1141 $xs->element('link', array('rel' => 'license',
1142 'href' => common_config('license', 'url')));
1145 $xs->element('icon', null, $profile->avatarUrl(AVATAR_PROFILE_SIZE));
1149 $xs->elementEnd('source');
1152 $xs->element('title', null, $this->content);
1154 $xs->raw($profile->asAtomAuthor());
1155 $xs->raw($profile->asActivityActor());
1157 $xs->element('link', array('rel' => 'alternate',
1158 'type' => 'text/html',
1159 'href' => $this->bestUrl()));
1161 $xs->element('id', null, $this->uri);
1163 $xs->element('published', null, common_date_w3dtf($this->created));
1164 $xs->element('updated', null, common_date_w3dtf($this->created));
1166 if ($this->reply_to) {
1167 $reply_notice = Notice::staticGet('id', $this->reply_to);
1168 if (!empty($reply_notice)) {
1169 $xs->element('link', array('rel' => 'related',
1170 'href' => $reply_notice->bestUrl()));
1171 $xs->element('thr:in-reply-to',
1172 array('ref' => $reply_notice->uri,
1173 'href' => $reply_notice->bestUrl()));
1177 if (!empty($this->conversation)) {
1179 $conv = Conversation::staticGet('id', $this->conversation);
1181 if (!empty($conv)) {
1184 'rel' => 'ostatus:conversation',
1185 'href' => $conv->uri
1191 $reply_ids = $this->getReplies();
1193 foreach ($reply_ids as $id) {
1194 $profile = Profile::staticGet('id', $id);
1195 if (!empty($profile)) {
1198 'rel' => 'ostatus:attention',
1199 'href' => $profile->getUri()
1205 $groups = $this->getGroups();
1207 foreach ($groups as $group) {
1210 'rel' => 'ostatus:attention',
1211 'href' => $group->permalink()
1216 if (!empty($this->repeat_of)) {
1217 $repeat = Notice::staticGet('id', $this->repeat_of);
1218 if (!empty($repeat)) {
1221 array('ref' => $repeat->uri, 'href' => $repeat->bestUrl())
1226 $xs->element('content', array('type' => 'html'), $this->rendered);
1228 $tag = new Notice_tag();
1229 $tag->notice_id = $this->id;
1231 while ($tag->fetch()) {
1232 $xs->element('category', array('term' => $tag->tag));
1238 $attachments = $this->attachments();
1240 foreach($attachments as $attachment){
1241 $enclosure=$attachment->getEnclosure();
1243 $attributes = array('rel'=>'enclosure','href'=>$enclosure->url,'type'=>$enclosure->mimetype,'length'=>$enclosure->size);
1244 if($enclosure->title){
1245 $attributes['title']=$enclosure->title;
1247 $xs->element('link', $attributes, null);
1252 if (!empty($this->lat) && !empty($this->lon)) {
1253 $xs->element('georss:point', null, $this->lat . ' ' . $this->lon);
1256 $xs->elementEnd('entry');
1258 return $xs->getString();
1262 * Returns an XML string fragment with a reference to a notice as an
1263 * Activity Streams noun object with the given element type.
1265 * Assumes that 'activity' namespace has been previously defined.
1267 * @param string $element one of 'subject', 'object', 'target'
1270 function asActivityNoun($element)
1272 $noun = ActivityObject::fromNotice($this);
1273 return $noun->asString('activity:' . $element);
1278 if (!empty($this->url)) {
1280 } else if (!empty($this->uri) && preg_match('/^https?:/', $this->uri)) {
1283 return common_local_url('shownotice',
1284 array('notice' => $this->id));
1288 function stream($fn, $args, $cachekey, $offset=0, $limit=20, $since_id=0, $max_id=0)
1290 $cache = common_memcache();
1292 if (empty($cache) ||
1293 $since_id != 0 || $max_id != 0 ||
1295 ($offset + $limit) > NOTICE_CACHE_WINDOW) {
1296 return call_user_func_array($fn, array_merge($args, array($offset, $limit, $since_id,
1300 $idkey = common_cache_key($cachekey);
1302 $idstr = $cache->get($idkey);
1304 if ($idstr !== false) {
1305 // Cache hit! Woohoo!
1306 $window = explode(',', $idstr);
1307 $ids = array_slice($window, $offset, $limit);
1311 $laststr = $cache->get($idkey.';last');
1313 if ($laststr !== false) {
1314 $window = explode(',', $laststr);
1315 $last_id = $window[0];
1316 $new_ids = call_user_func_array($fn, array_merge($args, array(0, NOTICE_CACHE_WINDOW,
1317 $last_id, 0, null)));
1319 $new_window = array_merge($new_ids, $window);
1321 $new_windowstr = implode(',', $new_window);
1323 $result = $cache->set($idkey, $new_windowstr);
1324 $result = $cache->set($idkey . ';last', $new_windowstr);
1326 $ids = array_slice($new_window, $offset, $limit);
1331 $window = call_user_func_array($fn, array_merge($args, array(0, NOTICE_CACHE_WINDOW,
1334 $windowstr = implode(',', $window);
1336 $result = $cache->set($idkey, $windowstr);
1337 $result = $cache->set($idkey . ';last', $windowstr);
1339 $ids = array_slice($window, $offset, $limit);
1345 * Determine which notice, if any, a new notice is in reply to.
1347 * For conversation tracking, we try to see where this notice fits
1348 * in the tree. Rough algorithm is:
1350 * if (reply_to is set and valid) {
1352 * } else if ((source not API or Web) and (content starts with "T NAME" or "@name ")) {
1353 * return ID of last notice by initial @name in content;
1356 * Note that all @nickname instances will still be used to save "reply" records,
1357 * so the notice shows up in the mentioned users' "replies" tab.
1359 * @param integer $reply_to ID passed in by Web or API
1360 * @param integer $profile_id ID of author
1361 * @param string $source Source tag, like 'web' or 'gwibber'
1362 * @param string $content Final notice content
1364 * @return integer ID of replied-to notice, or null for not a reply.
1367 static function getReplyTo($reply_to, $profile_id, $source, $content)
1369 static $lb = array('xmpp', 'mail', 'sms', 'omb');
1371 // If $reply_to is specified, we check that it exists, and then
1372 // return it if it does
1374 if (!empty($reply_to)) {
1375 $reply_notice = Notice::staticGet('id', $reply_to);
1376 if (!empty($reply_notice)) {
1381 // If it's not a "low bandwidth" source (one where you can't set
1382 // a reply_to argument), we return. This is mostly web and API
1385 if (!in_array($source, $lb)) {
1389 // Is there an initial @ or T?
1391 if (preg_match('/^T ([A-Z0-9]{1,64}) /', $content, $match) ||
1392 preg_match('/^@([a-z0-9]{1,64})\s+/', $content, $match)) {
1393 $nickname = common_canonical_nickname($match[1]);
1398 // Figure out who that is.
1400 $sender = Profile::staticGet('id', $profile_id);
1401 if (empty($sender)) {
1405 $recipient = common_relative_profile($sender, $nickname, common_sql_now());
1407 if (empty($recipient)) {
1411 // Get their last notice
1413 $last = $recipient->getCurrentNotice();
1415 if (!empty($last)) {
1420 static function maxContent()
1422 $contentlimit = common_config('notice', 'contentlimit');
1423 // null => use global limit (distinct from 0!)
1424 if (is_null($contentlimit)) {
1425 $contentlimit = common_config('site', 'textlimit');
1427 return $contentlimit;
1430 static function contentTooLong($content)
1432 $contentlimit = self::maxContent();
1433 return ($contentlimit > 0 && !empty($content) && (mb_strlen($content) > $contentlimit));
1436 function getLocation()
1440 if (!empty($this->location_id) && !empty($this->location_ns)) {
1441 $location = Location::fromId($this->location_id, $this->location_ns);
1444 if (is_null($location)) { // no ID, or Location::fromId() failed
1445 if (!empty($this->lat) && !empty($this->lon)) {
1446 $location = Location::fromLatLon($this->lat, $this->lon);
1453 function repeat($repeater_id, $source)
1455 $author = Profile::staticGet('id', $this->profile_id);
1457 $content = sprintf(_('RT @%1$s %2$s'),
1461 $maxlen = common_config('site', 'textlimit');
1462 if ($maxlen > 0 && mb_strlen($content) > $maxlen) {
1463 // Web interface and current Twitter API clients will
1464 // pull the original notice's text, but some older
1465 // clients and RSS/Atom feeds will see this trimmed text.
1467 // Unfortunately this is likely to lose tags or URLs
1468 // at the end of long notices.
1469 $content = mb_substr($content, 0, $maxlen - 4) . ' ...';
1472 return self::saveNew($repeater_id, $content, $source,
1473 array('repeat_of' => $this->id));
1476 // These are supposed to be in chron order!
1478 function repeatStream($limit=100)
1480 $cache = common_memcache();
1482 if (empty($cache)) {
1483 $ids = $this->_repeatStreamDirect($limit);
1485 $idstr = $cache->get(common_cache_key('notice:repeats:'.$this->id));
1486 if ($idstr !== false) {
1487 $ids = explode(',', $idstr);
1489 $ids = $this->_repeatStreamDirect(100);
1490 $cache->set(common_cache_key('notice:repeats:'.$this->id), implode(',', $ids));
1493 // We do a max of 100, so slice down to limit
1494 $ids = array_slice($ids, 0, $limit);
1498 return Notice::getStreamByIds($ids);
1501 function _repeatStreamDirect($limit)
1503 $notice = new Notice();
1505 $notice->selectAdd(); // clears it
1506 $notice->selectAdd('id');
1508 $notice->repeat_of = $this->id;
1510 $notice->orderBy('created'); // NB: asc!
1512 if (!is_null($offset)) {
1513 $notice->limit($offset, $limit);
1518 if ($notice->find()) {
1519 while ($notice->fetch()) {
1520 $ids[] = $notice->id;
1530 function locationOptions($lat, $lon, $location_id, $location_ns, $profile = null)
1534 if (!empty($location_id) && !empty($location_ns)) {
1536 $options['location_id'] = $location_id;
1537 $options['location_ns'] = $location_ns;
1539 $location = Location::fromId($location_id, $location_ns);
1541 if (!empty($location)) {
1542 $options['lat'] = $location->lat;
1543 $options['lon'] = $location->lon;
1546 } else if (!empty($lat) && !empty($lon)) {
1548 $options['lat'] = $lat;
1549 $options['lon'] = $lon;
1551 $location = Location::fromLatLon($lat, $lon);
1553 if (!empty($location)) {
1554 $options['location_id'] = $location->location_id;
1555 $options['location_ns'] = $location->location_ns;
1557 } else if (!empty($profile)) {
1559 if (isset($profile->lat) && isset($profile->lon)) {
1560 $options['lat'] = $profile->lat;
1561 $options['lon'] = $profile->lon;
1564 if (isset($profile->location_id) && isset($profile->location_ns)) {
1565 $options['location_id'] = $profile->location_id;
1566 $options['location_ns'] = $profile->location_ns;
1573 function clearReplies()
1575 $replyNotice = new Notice();
1576 $replyNotice->reply_to = $this->id;
1578 //Null any notices that are replies to this notice
1580 if ($replyNotice->find()) {
1581 while ($replyNotice->fetch()) {
1582 $orig = clone($replyNotice);
1583 $replyNotice->reply_to = null;
1584 $replyNotice->update($orig);
1590 $reply = new Reply();
1591 $reply->notice_id = $this->id;
1593 if ($reply->find()) {
1594 while($reply->fetch()) {
1595 self::blow('reply:stream:%d', $reply->profile_id);
1603 function clearRepeats()
1605 $repeatNotice = new Notice();
1606 $repeatNotice->repeat_of = $this->id;
1608 //Null any notices that are repeats of this notice
1610 if ($repeatNotice->find()) {
1611 while ($repeatNotice->fetch()) {
1612 $orig = clone($repeatNotice);
1613 $repeatNotice->repeat_of = null;
1614 $repeatNotice->update($orig);
1619 function clearFaves()
1622 $fave->notice_id = $this->id;
1624 if ($fave->find()) {
1625 while ($fave->fetch()) {
1626 self::blow('fave:ids_by_user_own:%d', $fave->user_id);
1627 self::blow('fave:ids_by_user_own:%d;last', $fave->user_id);
1628 self::blow('fave:ids_by_user:%d', $fave->user_id);
1629 self::blow('fave:ids_by_user:%d;last', $fave->user_id);
1637 function clearTags()
1639 $tag = new Notice_tag();
1640 $tag->notice_id = $this->id;
1643 while ($tag->fetch()) {
1644 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, common_keyize($tag->tag));
1645 self::blow('profile:notice_ids_tagged:%d:%s;last', $this->profile_id, common_keyize($tag->tag));
1646 self::blow('notice_tag:notice_ids:%s', common_keyize($tag->tag));
1647 self::blow('notice_tag:notice_ids:%s;last', common_keyize($tag->tag));
1655 function clearGroupInboxes()
1657 $gi = new Group_inbox();
1659 $gi->notice_id = $this->id;
1662 while ($gi->fetch()) {
1663 self::blow('user_group:notice_ids:%d', $gi->group_id);
1671 function distribute()
1673 // We always insert for the author so they don't
1676 $user = User::staticGet('id', $this->profile_id);
1677 if (!empty($user)) {
1678 Inbox::insertNotice($user->id, $this->id);
1681 if (common_config('queue', 'inboxes')) {
1682 // If there's a failure, we want to _force_
1683 // distribution at this point.
1685 $qm = QueueManager::get();
1686 $qm->enqueue($this, 'distrib');
1687 } catch (Exception $e) {
1688 // If the exception isn't transient, this
1689 // may throw more exceptions as DQH does
1690 // its own enqueueing. So, we ignore them!
1692 $handler = new DistribQueueHandler();
1693 $handler->handle($this);
1694 } catch (Exception $e) {
1695 common_log(LOG_ERR, "emergency redistribution resulted in " . $e->getMessage());
1697 // Re-throw so somebody smarter can handle it.
1701 $handler = new DistribQueueHandler();
1702 $handler->handle($this);
1708 $result = parent::insert();
1711 // Profile::hasRepeated() abuses pkeyGet(), so we
1712 // have to clear manually
1713 if (!empty($this->repeat_of)) {
1714 $c = self::memcache();
1716 $ck = self::multicacheKey('Notice',
1717 array('profile_id' => $this->profile_id,
1718 'repeat_of' => $this->repeat_of));