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();
123 $this->blowOnDelete();
128 * Extract #hashtags from this notice's content and save them to the database.
132 /* extract all #hastags */
133 $count = preg_match_all('/(?:^|\s)#([\pL\pN_\-\.]{1,64})/', strtolower($this->content), $match);
138 /* Add them to the database */
139 return $this->saveKnownTags($match[1]);
143 * Record the given set of hash tags in the db for this notice.
144 * Given tag strings will be normalized and checked for dupes.
146 function saveKnownTags($hashtags)
148 //turn each into their canonical tag
149 //this is needed to remove dupes before saving e.g. #hash.tag = #hashtag
150 for($i=0; $i<count($hashtags); $i++) {
151 $hashtags[$i] = common_canonical_tag($hashtags[$i]);
154 foreach(array_unique($hashtags) as $hashtag) {
155 /* elide characters we don't want in the tag */
156 $this->saveTag($hashtag);
157 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, $hashtag);
163 * Record a single hash tag as associated with this notice.
164 * Tag format and uniqueness must be validated by caller.
166 function saveTag($hashtag)
168 $tag = new Notice_tag();
169 $tag->notice_id = $this->id;
170 $tag->tag = $hashtag;
171 $tag->created = $this->created;
172 $id = $tag->insert();
175 throw new ServerException(sprintf(_('DB error inserting hashtag: %s'),
176 $last_error->message));
180 // if it's saved, blow its cache
181 $tag->blowCache(false);
185 * Save a new notice and push it out to subscribers' inboxes.
186 * Poster's permissions are checked before sending.
188 * @param int $profile_id Profile ID of the poster
189 * @param string $content source message text; links may be shortened
190 * per current user's preference
191 * @param string $source source key ('web', 'api', etc)
192 * @param array $options Associative array of optional properties:
193 * string 'created' timestamp of notice; defaults to now
194 * int 'is_local' source/gateway ID, one of:
195 * Notice::LOCAL_PUBLIC - Local, ok to appear in public timeline
196 * Notice::REMOTE_OMB - Sent from a remote OMB service;
197 * hide from public timeline but show in
198 * local "and friends" timelines
199 * Notice::LOCAL_NONPUBLIC - Local, but hide from public timeline
200 * Notice::GATEWAY - From another non-OMB service;
201 * will not appear in public views
202 * float 'lat' decimal latitude for geolocation
203 * float 'lon' decimal longitude for geolocation
204 * int 'location_id' geoname identifier
205 * int 'location_ns' geoname namespace to interpret location_id
206 * int 'reply_to'; notice ID this is a reply to
207 * int 'repeat_of'; notice ID this is a repeat of
208 * string 'uri' unique ID for notice; defaults to local notice URL
209 * string 'url' permalink to notice; defaults to local notice URL
210 * string 'rendered' rendered HTML version of content
211 * array 'replies' list of profile URIs for reply delivery in
212 * place of extracting @-replies from content.
213 * array 'groups' list of group IDs to deliver to, in place of
214 * extracting ! tags from content
215 * array 'tags' list of hashtag strings to save with the notice
216 * in place of extracting # tags from content
217 * array 'urls' list of attached/referred URLs to save with the
218 * notice in place of extracting links from content
219 * @fixme tag override
222 * @throws ClientException
224 static function saveNew($profile_id, $content, $source, $options=null) {
225 $defaults = array('uri' => null,
228 'repeat_of' => null);
230 if (!empty($options)) {
231 $options = $options + $defaults;
235 if (!isset($is_local)) {
236 $is_local = Notice::LOCAL_PUBLIC;
239 $profile = Profile::staticGet($profile_id);
241 $final = common_shorten_links($content);
243 if (Notice::contentTooLong($final)) {
244 throw new ClientException(_('Problem saving notice. Too long.'));
247 if (empty($profile)) {
248 throw new ClientException(_('Problem saving notice. Unknown user.'));
251 if (common_config('throttle', 'enabled') && !Notice::checkEditThrottle($profile_id)) {
252 common_log(LOG_WARNING, 'Excessive posting by profile #' . $profile_id . '; throttled.');
253 throw new ClientException(_('Too many notices too fast; take a breather '.
254 'and post again in a few minutes.'));
257 if (common_config('site', 'dupelimit') > 0 && !Notice::checkDupes($profile_id, $final)) {
258 common_log(LOG_WARNING, 'Dupe posting by profile #' . $profile_id . '; throttled.');
259 throw new ClientException(_('Too many duplicate messages too quickly;'.
260 ' take a breather and post again in a few minutes.'));
263 if (!$profile->hasRight(Right::NEWNOTICE)) {
264 common_log(LOG_WARNING, "Attempted post from user disallowed to post: " . $profile->nickname);
265 throw new ClientException(_('You are banned from posting notices on this site.'));
268 $notice = new Notice();
269 $notice->profile_id = $profile_id;
271 $autosource = common_config('public', 'autosource');
273 # Sandboxed are non-false, but not 1, either
275 if (!$profile->hasRight(Right::PUBLICNOTICE) ||
276 ($source && $autosource && in_array($source, $autosource))) {
277 $notice->is_local = Notice::LOCAL_NONPUBLIC;
279 $notice->is_local = $is_local;
282 if (!empty($created)) {
283 $notice->created = $created;
285 $notice->created = common_sql_now();
288 $notice->content = $final;
290 $notice->source = $source;
294 // Handle repeat case
296 if (isset($repeat_of)) {
297 $notice->repeat_of = $repeat_of;
299 $notice->reply_to = self::getReplyTo($reply_to, $profile_id, $source, $final);
302 if (!empty($notice->reply_to)) {
303 $reply = Notice::staticGet('id', $notice->reply_to);
304 $notice->conversation = $reply->conversation;
307 if (!empty($lat) && !empty($lon)) {
312 if (!empty($location_ns) && !empty($location_id)) {
313 $notice->location_id = $location_id;
314 $notice->location_ns = $location_ns;
317 if (!empty($rendered)) {
318 $notice->rendered = $rendered;
320 $notice->rendered = common_render_content($final, $notice);
323 if (Event::handle('StartNoticeSave', array(&$notice))) {
325 // XXX: some of these functions write to the DB
327 $id = $notice->insert();
330 common_log_db_error($notice, 'INSERT', __FILE__);
331 throw new ServerException(_('Problem saving notice.'));
334 // Update ID-dependent columns: URI, conversation
336 $orig = clone($notice);
341 $notice->uri = common_notice_uri($notice);
345 // If it's not part of a conversation, it's
346 // the beginning of a new conversation.
348 if (empty($notice->conversation)) {
349 $conv = Conversation::create();
350 $notice->conversation = $conv->id;
355 if (!$notice->update($orig)) {
356 common_log_db_error($notice, 'UPDATE', __FILE__);
357 throw new ServerException(_('Problem saving notice.'));
363 # Clear the cache for subscribed users, so they'll update at next request
364 # XXX: someone clever could prepend instead of clearing the cache
366 $notice->blowOnInsert();
368 // Save per-notice metadata...
370 if (isset($replies)) {
371 $notice->saveKnownReplies($replies);
373 $notice->saveReplies();
376 if (isset($groups)) {
377 $notice->saveKnownGroups($groups);
379 $notice->saveGroups();
383 $notice->saveKnownTags($tags);
389 $notice->saveKnownUrls($urls);
394 // Prepare inbox delivery, may be queued to background.
395 $notice->distribute();
400 function blowOnInsert($conversation = false)
402 self::blow('profile:notice_ids:%d', $this->profile_id);
403 self::blow('public');
405 // XXX: Before we were blowing the casche only if the notice id
406 // was not the root of the conversation. What to do now?
408 self::blow('notice:conversation_ids:%d', $this->conversation);
410 if (!empty($this->repeat_of)) {
411 self::blow('notice:repeats:%d', $this->repeat_of);
414 $original = Notice::staticGet('id', $this->repeat_of);
416 if (!empty($original)) {
417 $originalUser = User::staticGet('id', $original->profile_id);
418 if (!empty($originalUser)) {
419 self::blow('user:repeats_of_me:%d', $originalUser->id);
423 $profile = Profile::staticGet($this->profile_id);
424 $profile->blowNoticeCount();
428 * Clear cache entries related to this notice at delete time.
429 * Necessary to avoid breaking paging on public, profile timelines.
431 function blowOnDelete()
433 $this->blowOnInsert();
435 self::blow('profile:notice_ids:%d;last', $this->profile_id);
436 self::blow('public;last');
439 /** save all urls in the notice to the db
441 * follow redirects and save all available file information
442 * (mimetype, date, size, oembed, etc.)
446 function saveUrls() {
447 common_replace_urls_callback($this->content, array($this, 'saveUrl'), $this->id);
451 * Save the given URLs as related links/attachments to the db
453 * follow redirects and save all available file information
454 * (mimetype, date, size, oembed, etc.)
458 function saveKnownUrls($urls)
460 // @fixme validation?
461 foreach ($urls as $url) {
462 File::processNew($url, $this->id);
469 function saveUrl($data) {
470 list($url, $notice_id) = $data;
471 File::processNew($url, $notice_id);
474 static function checkDupes($profile_id, $content) {
475 $profile = Profile::staticGet($profile_id);
476 if (empty($profile)) {
479 $notice = $profile->getNotices(0, NOTICE_CACHE_WINDOW);
480 if (!empty($notice)) {
482 while ($notice->fetch()) {
483 if (time() - strtotime($notice->created) >= common_config('site', 'dupelimit')) {
485 } else if ($notice->content == $content) {
490 # If we get here, oldest item in cache window is not
491 # old enough for dupe limit; do direct check against DB
492 $notice = new Notice();
493 $notice->profile_id = $profile_id;
494 $notice->content = $content;
495 if (common_config('db','type') == 'pgsql')
496 $notice->whereAdd('extract(epoch from now() - created) < ' . common_config('site', 'dupelimit'));
498 $notice->whereAdd('now() - created < ' . common_config('site', 'dupelimit'));
500 $cnt = $notice->count();
504 static function checkEditThrottle($profile_id) {
505 $profile = Profile::staticGet($profile_id);
506 if (empty($profile)) {
510 $notice = $profile->getNotices(common_config('throttle', 'count') - 1, 1);
511 if ($notice && $notice->fetch()) {
512 # If the Nth notice was posted less than timespan seconds ago
513 if (time() - strtotime($notice->created) <= common_config('throttle', 'timespan')) {
518 # Either not N notices in the stream, OR the Nth was not posted within timespan seconds
522 function getUploadedAttachment() {
524 $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"';
525 $post->query($query);
527 if (empty($post->up) || empty($post->i)) {
530 $ret = array($post->up, $post->i);
536 function hasAttachments() {
538 $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);
539 $post->query($query);
541 $n_attachments = intval($post->n_attachments);
543 return $n_attachments;
546 function attachments() {
549 $f2p = new File_to_post;
550 $f2p->post_id = $this->id;
552 while ($f2p->fetch()) {
553 $f = File::staticGet($f2p->file_id);
560 function getStreamByIds($ids)
562 $cache = common_memcache();
564 if (!empty($cache)) {
566 foreach ($ids as $id) {
567 $n = Notice::staticGet('id', $id);
572 return new ArrayWrapper($notices);
574 $notice = new Notice();
576 //if no IDs requested, just return the notice object
579 $notice->whereAdd('id in (' . implode(', ', $ids) . ')');
585 while ($notice->fetch()) {
586 $temp[$notice->id] = clone($notice);
591 foreach ($ids as $id) {
592 if (array_key_exists($id, $temp)) {
593 $wrapped[] = $temp[$id];
597 return new ArrayWrapper($wrapped);
601 function publicStream($offset=0, $limit=20, $since_id=0, $max_id=0)
603 $ids = Notice::stream(array('Notice', '_publicStreamDirect'),
606 $offset, $limit, $since_id, $max_id);
607 return Notice::getStreamByIds($ids);
610 function _publicStreamDirect($offset=0, $limit=20, $since_id=0, $max_id=0)
612 $notice = new Notice();
614 $notice->selectAdd(); // clears it
615 $notice->selectAdd('id');
617 $notice->orderBy('id DESC');
619 if (!is_null($offset)) {
620 $notice->limit($offset, $limit);
623 if (common_config('public', 'localonly')) {
624 $notice->whereAdd('is_local = ' . Notice::LOCAL_PUBLIC);
626 # -1 == blacklisted, -2 == gateway (i.e. Twitter)
627 $notice->whereAdd('is_local !='. Notice::LOCAL_NONPUBLIC);
628 $notice->whereAdd('is_local !='. Notice::GATEWAY);
631 if ($since_id != 0) {
632 $notice->whereAdd('id > ' . $since_id);
636 $notice->whereAdd('id <= ' . $max_id);
641 if ($notice->find()) {
642 while ($notice->fetch()) {
643 $ids[] = $notice->id;
653 function conversationStream($id, $offset=0, $limit=20, $since_id=0, $max_id=0)
655 $ids = Notice::stream(array('Notice', '_conversationStreamDirect'),
657 'notice:conversation_ids:'.$id,
658 $offset, $limit, $since_id, $max_id);
660 return Notice::getStreamByIds($ids);
663 function _conversationStreamDirect($id, $offset=0, $limit=20, $since_id=0, $max_id=0)
665 $notice = new Notice();
667 $notice->selectAdd(); // clears it
668 $notice->selectAdd('id');
670 $notice->conversation = $id;
672 $notice->orderBy('id DESC');
674 if (!is_null($offset)) {
675 $notice->limit($offset, $limit);
678 if ($since_id != 0) {
679 $notice->whereAdd('id > ' . $since_id);
683 $notice->whereAdd('id <= ' . $max_id);
688 if ($notice->find()) {
689 while ($notice->fetch()) {
690 $ids[] = $notice->id;
701 * @param $groups array of Group *objects*
702 * @param $recipients array of profile *ids*
704 function whoGets($groups=null, $recipients=null)
706 $c = self::memcache();
709 $ni = $c->get(common_cache_key('notice:who_gets:'.$this->id));
715 if (is_null($groups)) {
716 $groups = $this->getGroups();
719 if (is_null($recipients)) {
720 $recipients = $this->getReplies();
723 $users = $this->getSubscribedUsers();
725 // FIXME: kind of ignoring 'transitional'...
726 // we'll probably stop supporting inboxless mode
731 foreach ($users as $id) {
732 $ni[$id] = NOTICE_INBOX_SOURCE_SUB;
735 $profile = $this->getProfile();
737 foreach ($groups as $group) {
738 $users = $group->getUserMembers();
739 foreach ($users as $id) {
740 if (!array_key_exists($id, $ni)) {
741 $user = User::staticGet('id', $id);
742 if (!$user->hasBlocked($profile)) {
743 $ni[$id] = NOTICE_INBOX_SOURCE_GROUP;
749 foreach ($recipients as $recipient) {
751 if (!array_key_exists($recipient, $ni)) {
752 $recipientUser = User::staticGet('id', $recipient);
753 if (!empty($recipientUser)) {
754 $ni[$recipient] = NOTICE_INBOX_SOURCE_REPLY;
760 // XXX: pack this data better
761 $c->set(common_cache_key('notice:who_gets:'.$this->id), $ni);
768 * Adds this notice to the inboxes of each local user who should receive
769 * it, based on author subscriptions, group memberships, and @-replies.
771 * Warning: running a second time currently will make items appear
772 * multiple times in users' inboxes.
774 * @fixme make more robust against errors
775 * @fixme break up massive deliveries to smaller background tasks
777 * @param array $groups optional list of Group objects;
778 * if left empty, will be loaded from group_inbox records
779 * @param array $recipient optional list of reply profile ids
780 * if left empty, will be loaded from reply records
782 function addToInboxes($groups=null, $recipients=null)
784 $ni = $this->whoGets($groups, $recipients);
786 $ids = array_keys($ni);
788 // We remove the author (if they're a local user),
789 // since we'll have already done this in distribute()
791 $i = array_search($this->profile_id, $ids);
799 Inbox::bulkInsert($this->id, $ids);
804 function getSubscribedUsers()
808 if(common_config('db','quote_identifiers'))
809 $user_table = '"user"';
810 else $user_table = 'user';
814 'FROM '. $user_table .' JOIN subscription '.
815 'ON '. $user_table .'.id = subscription.subscriber ' .
816 'WHERE subscription.subscribed = %d ';
818 $user->query(sprintf($qry, $this->profile_id));
822 while ($user->fetch()) {
832 * Record this notice to the given group inboxes for delivery.
833 * Overrides the regular parsing of !group markup.
835 * @param string $group_ids
836 * @fixme might prefer URIs as identifiers, as for replies?
837 * best with generalizations on user_group to support
838 * remote groups better.
840 function saveKnownGroups($group_ids)
842 if (!is_array($group_ids)) {
843 throw new ServerException("Bad type provided to saveKnownGroups");
847 foreach ($group_ids as $id) {
848 $group = User_group::staticGet('id', $id);
850 common_log(LOG_ERR, "Local delivery to group id $id, $group->nickname");
851 $result = $this->addToGroupInbox($group);
853 common_log_db_error($gi, 'INSERT', __FILE__);
856 // @fixme should we save the tags here or not?
857 $groups[] = clone($group);
859 common_log(LOG_ERR, "Local delivery to group id $id skipped, doesn't exist");
867 * Parse !group delivery and record targets into group_inbox.
868 * @return array of Group objects
870 function saveGroups()
872 // Don't save groups for repeats
874 if (!empty($this->repeat_of)) {
880 /* extract all !group */
881 $count = preg_match_all('/(?:^|\s)!([A-Za-z0-9]{1,64})/',
882 strtolower($this->content),
888 $profile = $this->getProfile();
890 /* Add them to the database */
892 foreach (array_unique($match[1]) as $nickname) {
893 /* XXX: remote groups. */
894 $group = User_group::getForNickname($nickname, $profile);
900 // we automatically add a tag for every group name, too
902 $tag = Notice_tag::pkeyGet(array('tag' => common_canonical_tag($nickname),
903 'notice_id' => $this->id));
906 $this->saveTag($nickname);
909 if ($profile->isMember($group)) {
911 $result = $this->addToGroupInbox($group);
914 common_log_db_error($gi, 'INSERT', __FILE__);
917 $groups[] = clone($group);
924 function addToGroupInbox($group)
926 $gi = Group_inbox::pkeyGet(array('group_id' => $group->id,
927 'notice_id' => $this->id));
931 $gi = new Group_inbox();
933 $gi->group_id = $group->id;
934 $gi->notice_id = $this->id;
935 $gi->created = $this->created;
937 $result = $gi->insert();
940 common_log_db_error($gi, 'INSERT', __FILE__);
941 throw new ServerException(_('Problem saving group inbox.'));
944 self::blow('user_group:notice_ids:%d', $gi->group_id);
951 * Save reply records indicating that this notice needs to be
952 * delivered to the local users with the given URIs.
954 * Since this is expected to be used when saving foreign-sourced
955 * messages, we won't deliver to any remote targets as that's the
956 * source service's responsibility.
958 * @fixme Unlike saveReplies() there's no mail notification here.
959 * Move that to distrib queue handler?
961 * @param array of unique identifier URIs for recipients
963 function saveKnownReplies($uris)
965 foreach ($uris as $uri) {
967 $user = User::staticGet('uri', $uri);
971 $reply = new Reply();
973 $reply->notice_id = $this->id;
974 $reply->profile_id = $user->id;
976 $id = $reply->insert();
978 self::blow('reply:stream:%d', $user->id);
986 * Pull @-replies from this message's content in StatusNet markup format
987 * and save reply records indicating that this message needs to be
988 * delivered to those users.
990 * Side effect: local recipients get e-mail notifications here.
991 * @fixme move mail notifications to distrib?
993 * @return array of integer profile IDs
996 function saveReplies()
998 // Don't save reply data for repeats
1000 if (!empty($this->repeat_of)) {
1004 $sender = Profile::staticGet($this->profile_id);
1006 // @todo ideally this parser information would only
1007 // be calculated once.
1009 $mentions = common_find_mentions($this->content, $this);
1013 // store replied only for first @ (what user/notice what the reply directed,
1014 // we assume first @ is it)
1016 foreach ($mentions as $mention) {
1018 foreach ($mention['mentioned'] as $mentioned) {
1020 // skip if they're already covered
1022 if (!empty($replied[$mentioned->id])) {
1026 // Don't save replies from blocked profile to local user
1028 $mentioned_user = User::staticGet('id', $mentioned->id);
1029 if (!empty($mentioned_user) && $mentioned_user->hasBlocked($sender)) {
1033 $reply = new Reply();
1035 $reply->notice_id = $this->id;
1036 $reply->profile_id = $mentioned->id;
1038 $id = $reply->insert();
1041 common_log_db_error($reply, 'INSERT', __FILE__);
1042 throw new ServerException("Couldn't save reply for {$this->id}, {$mentioned->id}");
1044 $replied[$mentioned->id] = 1;
1049 $recipientIds = array_keys($replied);
1051 foreach ($recipientIds as $recipientId) {
1052 $user = User::staticGet('id', $recipientId);
1053 if (!empty($user)) {
1054 self::blow('reply:stream:%d', $reply->profile_id);
1055 mail_notify_attn($user, $this);
1059 return $recipientIds;
1062 function getReplies()
1068 $reply = new Reply();
1069 $reply->selectAdd();
1070 $reply->selectAdd('profile_id');
1071 $reply->notice_id = $this->id;
1073 if ($reply->find()) {
1074 while($reply->fetch()) {
1075 $ids[] = $reply->profile_id;
1085 * Pull list of groups this notice needs to be delivered to,
1086 * as previously recorded by saveGroups() or saveKnownGroups().
1088 * @return array of Group objects
1090 function getGroups()
1092 // Don't save groups for repeats
1094 if (!empty($this->repeat_of)) {
1102 $gi = new Group_inbox();
1105 $gi->selectAdd('group_id');
1107 $gi->notice_id = $this->id;
1110 while ($gi->fetch()) {
1111 $group = User_group::staticGet('id', $gi->group_id);
1123 function asAtomEntry($namespace=false, $source=false, $author=true)
1125 $profile = $this->getProfile();
1127 $xs = new XMLStringer(true);
1130 $attrs = array('xmlns' => 'http://www.w3.org/2005/Atom',
1131 'xmlns:thr' => 'http://purl.org/syndication/thread/1.0',
1132 'xmlns:georss' => 'http://www.georss.org/georss',
1133 'xmlns:activity' => 'http://activitystrea.ms/spec/1.0/',
1134 'xmlns:media' => 'http://purl.org/syndication/atommedia',
1135 'xmlns:poco' => 'http://portablecontacts.net/spec/1.0',
1136 'xmlns:ostatus' => 'http://ostatus.org/schema/1.0');
1141 $xs->elementStart('entry', $attrs);
1144 $xs->elementStart('source');
1145 $xs->element('id', null, $profile->profileurl);
1146 $xs->element('title', null, $profile->nickname . " - " . common_config('site', 'name'));
1147 $xs->element('link', array('href' => $profile->profileurl));
1148 $user = User::staticGet('id', $profile->id);
1149 if (!empty($user)) {
1150 $atom_feed = common_local_url('ApiTimelineUser',
1151 array('format' => 'atom',
1152 'id' => $profile->nickname));
1153 $xs->element('link', array('rel' => 'self',
1154 'type' => 'application/atom+xml',
1155 'href' => $profile->profileurl));
1156 $xs->element('link', array('rel' => 'license',
1157 'href' => common_config('license', 'url')));
1160 $xs->element('icon', null, $profile->avatarUrl(AVATAR_PROFILE_SIZE));
1161 $xs->element('updated', null, common_date_w3dtf($this->created));
1165 $xs->elementEnd('source');
1168 $xs->element('title', null, common_xml_safe_str($this->content));
1171 $xs->raw($profile->asAtomAuthor());
1172 $xs->raw($profile->asActivityActor());
1175 $xs->element('link', array('rel' => 'alternate',
1176 'type' => 'text/html',
1177 'href' => $this->bestUrl()));
1179 $xs->element('id', null, $this->uri);
1181 $xs->element('published', null, common_date_w3dtf($this->created));
1182 $xs->element('updated', null, common_date_w3dtf($this->created));
1184 if ($this->reply_to) {
1185 $reply_notice = Notice::staticGet('id', $this->reply_to);
1186 if (!empty($reply_notice)) {
1187 $xs->element('link', array('rel' => 'related',
1188 'href' => $reply_notice->bestUrl()));
1189 $xs->element('thr:in-reply-to',
1190 array('ref' => $reply_notice->uri,
1191 'href' => $reply_notice->bestUrl()));
1195 if (!empty($this->conversation)) {
1197 $conv = Conversation::staticGet('id', $this->conversation);
1199 if (!empty($conv)) {
1202 'rel' => 'ostatus:conversation',
1203 'href' => $conv->uri
1209 $reply_ids = $this->getReplies();
1211 foreach ($reply_ids as $id) {
1212 $profile = Profile::staticGet('id', $id);
1213 if (!empty($profile)) {
1216 'rel' => 'ostatus:attention',
1217 'href' => $profile->getUri()
1223 $groups = $this->getGroups();
1225 foreach ($groups as $group) {
1228 'rel' => 'ostatus:attention',
1229 'href' => $group->permalink()
1234 if (!empty($this->repeat_of)) {
1235 $repeat = Notice::staticGet('id', $this->repeat_of);
1236 if (!empty($repeat)) {
1239 array('ref' => $repeat->uri, 'href' => $repeat->bestUrl())
1246 array('type' => 'html'),
1247 common_xml_safe_str($this->rendered)
1250 $tag = new Notice_tag();
1251 $tag->notice_id = $this->id;
1253 while ($tag->fetch()) {
1254 $xs->element('category', array('term' => $tag->tag));
1260 $attachments = $this->attachments();
1262 foreach($attachments as $attachment){
1263 $enclosure=$attachment->getEnclosure();
1265 $attributes = array('rel'=>'enclosure','href'=>$enclosure->url,'type'=>$enclosure->mimetype,'length'=>$enclosure->size);
1266 if($enclosure->title){
1267 $attributes['title']=$enclosure->title;
1269 $xs->element('link', $attributes, null);
1274 if (!empty($this->lat) && !empty($this->lon)) {
1275 $xs->element('georss:point', null, $this->lat . ' ' . $this->lon);
1278 $xs->elementEnd('entry');
1280 return $xs->getString();
1284 * Returns an XML string fragment with a reference to a notice as an
1285 * Activity Streams noun object with the given element type.
1287 * Assumes that 'activity' namespace has been previously defined.
1289 * @param string $element one of 'subject', 'object', 'target'
1292 function asActivityNoun($element)
1294 $noun = ActivityObject::fromNotice($this);
1295 return $noun->asString('activity:' . $element);
1300 if (!empty($this->url)) {
1302 } else if (!empty($this->uri) && preg_match('/^https?:/', $this->uri)) {
1305 return common_local_url('shownotice',
1306 array('notice' => $this->id));
1310 function stream($fn, $args, $cachekey, $offset=0, $limit=20, $since_id=0, $max_id=0)
1312 $cache = common_memcache();
1314 if (empty($cache) ||
1315 $since_id != 0 || $max_id != 0 ||
1317 ($offset + $limit) > NOTICE_CACHE_WINDOW) {
1318 return call_user_func_array($fn, array_merge($args, array($offset, $limit, $since_id,
1322 $idkey = common_cache_key($cachekey);
1324 $idstr = $cache->get($idkey);
1326 if ($idstr !== false) {
1327 // Cache hit! Woohoo!
1328 $window = explode(',', $idstr);
1329 $ids = array_slice($window, $offset, $limit);
1333 $laststr = $cache->get($idkey.';last');
1335 if ($laststr !== false) {
1336 $window = explode(',', $laststr);
1337 $last_id = $window[0];
1338 $new_ids = call_user_func_array($fn, array_merge($args, array(0, NOTICE_CACHE_WINDOW,
1339 $last_id, 0, null)));
1341 $new_window = array_merge($new_ids, $window);
1343 $new_windowstr = implode(',', $new_window);
1345 $result = $cache->set($idkey, $new_windowstr);
1346 $result = $cache->set($idkey . ';last', $new_windowstr);
1348 $ids = array_slice($new_window, $offset, $limit);
1353 $window = call_user_func_array($fn, array_merge($args, array(0, NOTICE_CACHE_WINDOW,
1356 $windowstr = implode(',', $window);
1358 $result = $cache->set($idkey, $windowstr);
1359 $result = $cache->set($idkey . ';last', $windowstr);
1361 $ids = array_slice($window, $offset, $limit);
1367 * Determine which notice, if any, a new notice is in reply to.
1369 * For conversation tracking, we try to see where this notice fits
1370 * in the tree. Rough algorithm is:
1372 * if (reply_to is set and valid) {
1374 * } else if ((source not API or Web) and (content starts with "T NAME" or "@name ")) {
1375 * return ID of last notice by initial @name in content;
1378 * Note that all @nickname instances will still be used to save "reply" records,
1379 * so the notice shows up in the mentioned users' "replies" tab.
1381 * @param integer $reply_to ID passed in by Web or API
1382 * @param integer $profile_id ID of author
1383 * @param string $source Source tag, like 'web' or 'gwibber'
1384 * @param string $content Final notice content
1386 * @return integer ID of replied-to notice, or null for not a reply.
1389 static function getReplyTo($reply_to, $profile_id, $source, $content)
1391 static $lb = array('xmpp', 'mail', 'sms', 'omb');
1393 // If $reply_to is specified, we check that it exists, and then
1394 // return it if it does
1396 if (!empty($reply_to)) {
1397 $reply_notice = Notice::staticGet('id', $reply_to);
1398 if (!empty($reply_notice)) {
1403 // If it's not a "low bandwidth" source (one where you can't set
1404 // a reply_to argument), we return. This is mostly web and API
1407 if (!in_array($source, $lb)) {
1411 // Is there an initial @ or T?
1413 if (preg_match('/^T ([A-Z0-9]{1,64}) /', $content, $match) ||
1414 preg_match('/^@([a-z0-9]{1,64})\s+/', $content, $match)) {
1415 $nickname = common_canonical_nickname($match[1]);
1420 // Figure out who that is.
1422 $sender = Profile::staticGet('id', $profile_id);
1423 if (empty($sender)) {
1427 $recipient = common_relative_profile($sender, $nickname, common_sql_now());
1429 if (empty($recipient)) {
1433 // Get their last notice
1435 $last = $recipient->getCurrentNotice();
1437 if (!empty($last)) {
1442 static function maxContent()
1444 $contentlimit = common_config('notice', 'contentlimit');
1445 // null => use global limit (distinct from 0!)
1446 if (is_null($contentlimit)) {
1447 $contentlimit = common_config('site', 'textlimit');
1449 return $contentlimit;
1452 static function contentTooLong($content)
1454 $contentlimit = self::maxContent();
1455 return ($contentlimit > 0 && !empty($content) && (mb_strlen($content) > $contentlimit));
1458 function getLocation()
1462 if (!empty($this->location_id) && !empty($this->location_ns)) {
1463 $location = Location::fromId($this->location_id, $this->location_ns);
1466 if (is_null($location)) { // no ID, or Location::fromId() failed
1467 if (!empty($this->lat) && !empty($this->lon)) {
1468 $location = Location::fromLatLon($this->lat, $this->lon);
1475 function repeat($repeater_id, $source)
1477 $author = Profile::staticGet('id', $this->profile_id);
1479 $content = sprintf(_('RT @%1$s %2$s'),
1483 $maxlen = common_config('site', 'textlimit');
1484 if ($maxlen > 0 && mb_strlen($content) > $maxlen) {
1485 // Web interface and current Twitter API clients will
1486 // pull the original notice's text, but some older
1487 // clients and RSS/Atom feeds will see this trimmed text.
1489 // Unfortunately this is likely to lose tags or URLs
1490 // at the end of long notices.
1491 $content = mb_substr($content, 0, $maxlen - 4) . ' ...';
1494 return self::saveNew($repeater_id, $content, $source,
1495 array('repeat_of' => $this->id));
1498 // These are supposed to be in chron order!
1500 function repeatStream($limit=100)
1502 $cache = common_memcache();
1504 if (empty($cache)) {
1505 $ids = $this->_repeatStreamDirect($limit);
1507 $idstr = $cache->get(common_cache_key('notice:repeats:'.$this->id));
1508 if ($idstr !== false) {
1509 $ids = explode(',', $idstr);
1511 $ids = $this->_repeatStreamDirect(100);
1512 $cache->set(common_cache_key('notice:repeats:'.$this->id), implode(',', $ids));
1515 // We do a max of 100, so slice down to limit
1516 $ids = array_slice($ids, 0, $limit);
1520 return Notice::getStreamByIds($ids);
1523 function _repeatStreamDirect($limit)
1525 $notice = new Notice();
1527 $notice->selectAdd(); // clears it
1528 $notice->selectAdd('id');
1530 $notice->repeat_of = $this->id;
1532 $notice->orderBy('created'); // NB: asc!
1534 if (!is_null($offset)) {
1535 $notice->limit($offset, $limit);
1540 if ($notice->find()) {
1541 while ($notice->fetch()) {
1542 $ids[] = $notice->id;
1552 function locationOptions($lat, $lon, $location_id, $location_ns, $profile = null)
1556 if (!empty($location_id) && !empty($location_ns)) {
1558 $options['location_id'] = $location_id;
1559 $options['location_ns'] = $location_ns;
1561 $location = Location::fromId($location_id, $location_ns);
1563 if (!empty($location)) {
1564 $options['lat'] = $location->lat;
1565 $options['lon'] = $location->lon;
1568 } else if (!empty($lat) && !empty($lon)) {
1570 $options['lat'] = $lat;
1571 $options['lon'] = $lon;
1573 $location = Location::fromLatLon($lat, $lon);
1575 if (!empty($location)) {
1576 $options['location_id'] = $location->location_id;
1577 $options['location_ns'] = $location->location_ns;
1579 } else if (!empty($profile)) {
1581 if (isset($profile->lat) && isset($profile->lon)) {
1582 $options['lat'] = $profile->lat;
1583 $options['lon'] = $profile->lon;
1586 if (isset($profile->location_id) && isset($profile->location_ns)) {
1587 $options['location_id'] = $profile->location_id;
1588 $options['location_ns'] = $profile->location_ns;
1595 function clearReplies()
1597 $replyNotice = new Notice();
1598 $replyNotice->reply_to = $this->id;
1600 //Null any notices that are replies to this notice
1602 if ($replyNotice->find()) {
1603 while ($replyNotice->fetch()) {
1604 $orig = clone($replyNotice);
1605 $replyNotice->reply_to = null;
1606 $replyNotice->update($orig);
1612 $reply = new Reply();
1613 $reply->notice_id = $this->id;
1615 if ($reply->find()) {
1616 while($reply->fetch()) {
1617 self::blow('reply:stream:%d', $reply->profile_id);
1625 function clearRepeats()
1627 $repeatNotice = new Notice();
1628 $repeatNotice->repeat_of = $this->id;
1630 //Null any notices that are repeats of this notice
1632 if ($repeatNotice->find()) {
1633 while ($repeatNotice->fetch()) {
1634 $orig = clone($repeatNotice);
1635 $repeatNotice->repeat_of = null;
1636 $repeatNotice->update($orig);
1641 function clearFaves()
1644 $fave->notice_id = $this->id;
1646 if ($fave->find()) {
1647 while ($fave->fetch()) {
1648 self::blow('fave:ids_by_user_own:%d', $fave->user_id);
1649 self::blow('fave:ids_by_user_own:%d;last', $fave->user_id);
1650 self::blow('fave:ids_by_user:%d', $fave->user_id);
1651 self::blow('fave:ids_by_user:%d;last', $fave->user_id);
1659 function clearTags()
1661 $tag = new Notice_tag();
1662 $tag->notice_id = $this->id;
1665 while ($tag->fetch()) {
1666 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, common_keyize($tag->tag));
1667 self::blow('profile:notice_ids_tagged:%d:%s;last', $this->profile_id, common_keyize($tag->tag));
1668 self::blow('notice_tag:notice_ids:%s', common_keyize($tag->tag));
1669 self::blow('notice_tag:notice_ids:%s;last', common_keyize($tag->tag));
1677 function clearGroupInboxes()
1679 $gi = new Group_inbox();
1681 $gi->notice_id = $this->id;
1684 while ($gi->fetch()) {
1685 self::blow('user_group:notice_ids:%d', $gi->group_id);
1693 function distribute()
1695 // We always insert for the author so they don't
1698 $user = User::staticGet('id', $this->profile_id);
1699 if (!empty($user)) {
1700 Inbox::insertNotice($user->id, $this->id);
1703 if (common_config('queue', 'inboxes')) {
1704 // If there's a failure, we want to _force_
1705 // distribution at this point.
1707 $qm = QueueManager::get();
1708 $qm->enqueue($this, 'distrib');
1709 } catch (Exception $e) {
1710 // If the exception isn't transient, this
1711 // may throw more exceptions as DQH does
1712 // its own enqueueing. So, we ignore them!
1714 $handler = new DistribQueueHandler();
1715 $handler->handle($this);
1716 } catch (Exception $e) {
1717 common_log(LOG_ERR, "emergency redistribution resulted in " . $e->getMessage());
1719 // Re-throw so somebody smarter can handle it.
1723 $handler = new DistribQueueHandler();
1724 $handler->handle($this);
1730 $result = parent::insert();
1733 // Profile::hasRepeated() abuses pkeyGet(), so we
1734 // have to clear manually
1735 if (!empty($this->repeat_of)) {
1736 $c = self::memcache();
1738 $ck = self::multicacheKey('Notice',
1739 array('profile_id' => $this->profile_id,
1740 'repeat_of' => $this->repeat_of));