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 /* elide characters we don't want in the tag */
152 $hashtags[$i] = common_canonical_tag($hashtags[$i]);
155 foreach(array_unique($hashtags) as $hashtag) {
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();
377 $notice->saveKnownTags($tags);
382 // Note: groups may save tags, so must be run after tags are saved
383 // to avoid errors on duplicates.
384 if (isset($groups)) {
385 $notice->saveKnownGroups($groups);
387 $notice->saveGroups();
391 $notice->saveKnownUrls($urls);
396 // Prepare inbox delivery, may be queued to background.
397 $notice->distribute();
402 function blowOnInsert($conversation = false)
404 self::blow('profile:notice_ids:%d', $this->profile_id);
405 self::blow('public');
407 // XXX: Before we were blowing the casche only if the notice id
408 // was not the root of the conversation. What to do now?
410 self::blow('notice:conversation_ids:%d', $this->conversation);
412 if (!empty($this->repeat_of)) {
413 self::blow('notice:repeats:%d', $this->repeat_of);
416 $original = Notice::staticGet('id', $this->repeat_of);
418 if (!empty($original)) {
419 $originalUser = User::staticGet('id', $original->profile_id);
420 if (!empty($originalUser)) {
421 self::blow('user:repeats_of_me:%d', $originalUser->id);
425 $profile = Profile::staticGet($this->profile_id);
426 if (!empty($profile)) {
427 $profile->blowNoticeCount();
432 * Clear cache entries related to this notice at delete time.
433 * Necessary to avoid breaking paging on public, profile timelines.
435 function blowOnDelete()
437 $this->blowOnInsert();
439 self::blow('profile:notice_ids:%d;last', $this->profile_id);
440 self::blow('public;last');
443 /** save all urls in the notice to the db
445 * follow redirects and save all available file information
446 * (mimetype, date, size, oembed, etc.)
450 function saveUrls() {
451 common_replace_urls_callback($this->content, array($this, 'saveUrl'), $this->id);
455 * Save the given URLs as related links/attachments to the db
457 * follow redirects and save all available file information
458 * (mimetype, date, size, oembed, etc.)
462 function saveKnownUrls($urls)
464 // @fixme validation?
465 foreach ($urls as $url) {
466 File::processNew($url, $this->id);
473 function saveUrl($data) {
474 list($url, $notice_id) = $data;
475 File::processNew($url, $notice_id);
478 static function checkDupes($profile_id, $content) {
479 $profile = Profile::staticGet($profile_id);
480 if (empty($profile)) {
483 $notice = $profile->getNotices(0, NOTICE_CACHE_WINDOW);
484 if (!empty($notice)) {
486 while ($notice->fetch()) {
487 if (time() - strtotime($notice->created) >= common_config('site', 'dupelimit')) {
489 } else if ($notice->content == $content) {
494 # If we get here, oldest item in cache window is not
495 # old enough for dupe limit; do direct check against DB
496 $notice = new Notice();
497 $notice->profile_id = $profile_id;
498 $notice->content = $content;
499 if (common_config('db','type') == 'pgsql')
500 $notice->whereAdd('extract(epoch from now() - created) < ' . common_config('site', 'dupelimit'));
502 $notice->whereAdd('now() - created < ' . common_config('site', 'dupelimit'));
504 $cnt = $notice->count();
508 static function checkEditThrottle($profile_id) {
509 $profile = Profile::staticGet($profile_id);
510 if (empty($profile)) {
514 $notice = $profile->getNotices(common_config('throttle', 'count') - 1, 1);
515 if ($notice && $notice->fetch()) {
516 # If the Nth notice was posted less than timespan seconds ago
517 if (time() - strtotime($notice->created) <= common_config('throttle', 'timespan')) {
522 # Either not N notices in the stream, OR the Nth was not posted within timespan seconds
526 function getUploadedAttachment() {
528 $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"';
529 $post->query($query);
531 if (empty($post->up) || empty($post->i)) {
534 $ret = array($post->up, $post->i);
540 function hasAttachments() {
542 $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);
543 $post->query($query);
545 $n_attachments = intval($post->n_attachments);
547 return $n_attachments;
550 function attachments() {
553 $f2p = new File_to_post;
554 $f2p->post_id = $this->id;
556 while ($f2p->fetch()) {
557 $f = File::staticGet($f2p->file_id);
564 function getStreamByIds($ids)
566 $cache = common_memcache();
568 if (!empty($cache)) {
570 foreach ($ids as $id) {
571 $n = Notice::staticGet('id', $id);
576 return new ArrayWrapper($notices);
578 $notice = new Notice();
580 //if no IDs requested, just return the notice object
583 $notice->whereAdd('id in (' . implode(', ', $ids) . ')');
589 while ($notice->fetch()) {
590 $temp[$notice->id] = clone($notice);
595 foreach ($ids as $id) {
596 if (array_key_exists($id, $temp)) {
597 $wrapped[] = $temp[$id];
601 return new ArrayWrapper($wrapped);
605 function publicStream($offset=0, $limit=20, $since_id=0, $max_id=0)
607 $ids = Notice::stream(array('Notice', '_publicStreamDirect'),
610 $offset, $limit, $since_id, $max_id);
611 return Notice::getStreamByIds($ids);
614 function _publicStreamDirect($offset=0, $limit=20, $since_id=0, $max_id=0)
616 $notice = new Notice();
618 $notice->selectAdd(); // clears it
619 $notice->selectAdd('id');
621 $notice->orderBy('id DESC');
623 if (!is_null($offset)) {
624 $notice->limit($offset, $limit);
627 if (common_config('public', 'localonly')) {
628 $notice->whereAdd('is_local = ' . Notice::LOCAL_PUBLIC);
630 # -1 == blacklisted, -2 == gateway (i.e. Twitter)
631 $notice->whereAdd('is_local !='. Notice::LOCAL_NONPUBLIC);
632 $notice->whereAdd('is_local !='. Notice::GATEWAY);
635 if ($since_id != 0) {
636 $notice->whereAdd('id > ' . $since_id);
640 $notice->whereAdd('id <= ' . $max_id);
645 if ($notice->find()) {
646 while ($notice->fetch()) {
647 $ids[] = $notice->id;
657 function conversationStream($id, $offset=0, $limit=20, $since_id=0, $max_id=0)
659 $ids = Notice::stream(array('Notice', '_conversationStreamDirect'),
661 'notice:conversation_ids:'.$id,
662 $offset, $limit, $since_id, $max_id);
664 return Notice::getStreamByIds($ids);
667 function _conversationStreamDirect($id, $offset=0, $limit=20, $since_id=0, $max_id=0)
669 $notice = new Notice();
671 $notice->selectAdd(); // clears it
672 $notice->selectAdd('id');
674 $notice->conversation = $id;
676 $notice->orderBy('id DESC');
678 if (!is_null($offset)) {
679 $notice->limit($offset, $limit);
682 if ($since_id != 0) {
683 $notice->whereAdd('id > ' . $since_id);
687 $notice->whereAdd('id <= ' . $max_id);
692 if ($notice->find()) {
693 while ($notice->fetch()) {
694 $ids[] = $notice->id;
705 * Is this notice part of an active conversation?
707 * @return boolean true if other messages exist in the same
708 * conversation, false if this is the only one
710 function hasConversation()
712 if (!empty($this->conversation)) {
713 $conversation = Notice::conversationStream(
718 if ($conversation->N > 0) {
726 * @param $groups array of Group *objects*
727 * @param $recipients array of profile *ids*
729 function whoGets($groups=null, $recipients=null)
731 $c = self::memcache();
734 $ni = $c->get(common_cache_key('notice:who_gets:'.$this->id));
740 if (is_null($groups)) {
741 $groups = $this->getGroups();
744 if (is_null($recipients)) {
745 $recipients = $this->getReplies();
748 $users = $this->getSubscribedUsers();
750 // FIXME: kind of ignoring 'transitional'...
751 // we'll probably stop supporting inboxless mode
756 foreach ($users as $id) {
757 $ni[$id] = NOTICE_INBOX_SOURCE_SUB;
760 $profile = $this->getProfile();
762 foreach ($groups as $group) {
763 $users = $group->getUserMembers();
764 foreach ($users as $id) {
765 if (!array_key_exists($id, $ni)) {
766 $user = User::staticGet('id', $id);
767 if (!$user->hasBlocked($profile)) {
768 $ni[$id] = NOTICE_INBOX_SOURCE_GROUP;
774 foreach ($recipients as $recipient) {
776 if (!array_key_exists($recipient, $ni)) {
777 $recipientUser = User::staticGet('id', $recipient);
778 if (!empty($recipientUser)) {
779 $ni[$recipient] = NOTICE_INBOX_SOURCE_REPLY;
785 // XXX: pack this data better
786 $c->set(common_cache_key('notice:who_gets:'.$this->id), $ni);
793 * Adds this notice to the inboxes of each local user who should receive
794 * it, based on author subscriptions, group memberships, and @-replies.
796 * Warning: running a second time currently will make items appear
797 * multiple times in users' inboxes.
799 * @fixme make more robust against errors
800 * @fixme break up massive deliveries to smaller background tasks
802 * @param array $groups optional list of Group objects;
803 * if left empty, will be loaded from group_inbox records
804 * @param array $recipient optional list of reply profile ids
805 * if left empty, will be loaded from reply records
807 function addToInboxes($groups=null, $recipients=null)
809 $ni = $this->whoGets($groups, $recipients);
811 $ids = array_keys($ni);
813 // We remove the author (if they're a local user),
814 // since we'll have already done this in distribute()
816 $i = array_search($this->profile_id, $ids);
824 Inbox::bulkInsert($this->id, $ids);
829 function getSubscribedUsers()
833 if(common_config('db','quote_identifiers'))
834 $user_table = '"user"';
835 else $user_table = 'user';
839 'FROM '. $user_table .' JOIN subscription '.
840 'ON '. $user_table .'.id = subscription.subscriber ' .
841 'WHERE subscription.subscribed = %d ';
843 $user->query(sprintf($qry, $this->profile_id));
847 while ($user->fetch()) {
857 * Record this notice to the given group inboxes for delivery.
858 * Overrides the regular parsing of !group markup.
860 * @param string $group_ids
861 * @fixme might prefer URIs as identifiers, as for replies?
862 * best with generalizations on user_group to support
863 * remote groups better.
865 function saveKnownGroups($group_ids)
867 if (!is_array($group_ids)) {
868 throw new ServerException("Bad type provided to saveKnownGroups");
872 foreach ($group_ids as $id) {
873 $group = User_group::staticGet('id', $id);
875 common_log(LOG_ERR, "Local delivery to group id $id, $group->nickname");
876 $result = $this->addToGroupInbox($group);
878 common_log_db_error($gi, 'INSERT', __FILE__);
881 // @fixme should we save the tags here or not?
882 $groups[] = clone($group);
884 common_log(LOG_ERR, "Local delivery to group id $id skipped, doesn't exist");
892 * Parse !group delivery and record targets into group_inbox.
893 * @return array of Group objects
895 function saveGroups()
897 // Don't save groups for repeats
899 if (!empty($this->repeat_of)) {
905 /* extract all !group */
906 $count = preg_match_all('/(?:^|\s)!([A-Za-z0-9]{1,64})/',
907 strtolower($this->content),
913 $profile = $this->getProfile();
915 /* Add them to the database */
917 foreach (array_unique($match[1]) as $nickname) {
918 /* XXX: remote groups. */
919 $group = User_group::getForNickname($nickname, $profile);
925 // we automatically add a tag for every group name, too
927 $tag = Notice_tag::pkeyGet(array('tag' => common_canonical_tag($nickname),
928 'notice_id' => $this->id));
931 $this->saveTag($nickname);
934 if ($profile->isMember($group)) {
936 $result = $this->addToGroupInbox($group);
939 common_log_db_error($gi, 'INSERT', __FILE__);
942 $groups[] = clone($group);
949 function addToGroupInbox($group)
951 $gi = Group_inbox::pkeyGet(array('group_id' => $group->id,
952 'notice_id' => $this->id));
956 $gi = new Group_inbox();
958 $gi->group_id = $group->id;
959 $gi->notice_id = $this->id;
960 $gi->created = $this->created;
962 $result = $gi->insert();
965 common_log_db_error($gi, 'INSERT', __FILE__);
966 throw new ServerException(_('Problem saving group inbox.'));
969 self::blow('user_group:notice_ids:%d', $gi->group_id);
976 * Save reply records indicating that this notice needs to be
977 * delivered to the local users with the given URIs.
979 * Since this is expected to be used when saving foreign-sourced
980 * messages, we won't deliver to any remote targets as that's the
981 * source service's responsibility.
983 * Mail notifications etc will be handled later.
985 * @param array of unique identifier URIs for recipients
987 function saveKnownReplies($uris)
992 $sender = Profile::staticGet($this->profile_id);
994 foreach ($uris as $uri) {
996 $user = User::staticGet('uri', $uri);
999 if ($user->hasBlocked($sender)) {
1003 $reply = new Reply();
1005 $reply->notice_id = $this->id;
1006 $reply->profile_id = $user->id;
1008 $id = $reply->insert();
1016 * Pull @-replies from this message's content in StatusNet markup format
1017 * and save reply records indicating that this message needs to be
1018 * delivered to those users.
1020 * Mail notifications to local profiles will be sent later.
1022 * @return array of integer profile IDs
1025 function saveReplies()
1027 // Don't save reply data for repeats
1029 if (!empty($this->repeat_of)) {
1033 $sender = Profile::staticGet($this->profile_id);
1035 // @todo ideally this parser information would only
1036 // be calculated once.
1038 $mentions = common_find_mentions($this->content, $this);
1042 // store replied only for first @ (what user/notice what the reply directed,
1043 // we assume first @ is it)
1045 foreach ($mentions as $mention) {
1047 foreach ($mention['mentioned'] as $mentioned) {
1049 // skip if they're already covered
1051 if (!empty($replied[$mentioned->id])) {
1055 // Don't save replies from blocked profile to local user
1057 $mentioned_user = User::staticGet('id', $mentioned->id);
1058 if (!empty($mentioned_user) && $mentioned_user->hasBlocked($sender)) {
1062 $reply = new Reply();
1064 $reply->notice_id = $this->id;
1065 $reply->profile_id = $mentioned->id;
1067 $id = $reply->insert();
1070 common_log_db_error($reply, 'INSERT', __FILE__);
1071 throw new ServerException("Couldn't save reply for {$this->id}, {$mentioned->id}");
1073 $replied[$mentioned->id] = 1;
1074 self::blow('reply:stream:%d', $mentioned->id);
1079 $recipientIds = array_keys($replied);
1081 return $recipientIds;
1085 * Pull the complete list of @-reply targets for this notice.
1087 * @return array of integer profile ids
1089 function getReplies()
1095 $reply = new Reply();
1096 $reply->selectAdd();
1097 $reply->selectAdd('profile_id');
1098 $reply->notice_id = $this->id;
1100 if ($reply->find()) {
1101 while($reply->fetch()) {
1102 $ids[] = $reply->profile_id;
1112 * Send e-mail notifications to local @-reply targets.
1114 * Replies must already have been saved; this is expected to be run
1115 * from the distrib queue handler.
1117 function sendReplyNotifications()
1119 // Don't send reply notifications for repeats
1121 if (!empty($this->repeat_of)) {
1125 $recipientIds = $this->getReplies();
1127 foreach ($recipientIds as $recipientId) {
1128 $user = User::staticGet('id', $recipientId);
1129 if (!empty($user)) {
1130 mail_notify_attn($user, $this);
1136 * Pull list of groups this notice needs to be delivered to,
1137 * as previously recorded by saveGroups() or saveKnownGroups().
1139 * @return array of Group objects
1141 function getGroups()
1143 // Don't save groups for repeats
1145 if (!empty($this->repeat_of)) {
1153 $gi = new Group_inbox();
1156 $gi->selectAdd('group_id');
1158 $gi->notice_id = $this->id;
1161 while ($gi->fetch()) {
1162 $group = User_group::staticGet('id', $gi->group_id);
1174 function asAtomEntry($namespace=false, $source=false, $author=true, $cur=null)
1176 $profile = $this->getProfile();
1178 $xs = new XMLStringer(true);
1181 $attrs = array('xmlns' => 'http://www.w3.org/2005/Atom',
1182 'xmlns:thr' => 'http://purl.org/syndication/thread/1.0',
1183 'xmlns:georss' => 'http://www.georss.org/georss',
1184 'xmlns:activity' => 'http://activitystrea.ms/spec/1.0/',
1185 'xmlns:media' => 'http://purl.org/syndication/atommedia',
1186 'xmlns:poco' => 'http://portablecontacts.net/spec/1.0',
1187 'xmlns:ostatus' => 'http://ostatus.org/schema/1.0',
1188 'xmlns:statusnet' => 'http://status.net/ont/');
1193 $xs->elementStart('entry', $attrs);
1196 $xs->elementStart('source');
1197 $xs->element('id', null, $profile->profileurl);
1198 $xs->element('title', null, $profile->nickname . " - " . common_config('site', 'name'));
1199 $xs->element('link', array('href' => $profile->profileurl));
1200 $user = User::staticGet('id', $profile->id);
1201 if (!empty($user)) {
1202 $atom_feed = common_local_url('ApiTimelineUser',
1203 array('format' => 'atom',
1204 'id' => $profile->nickname));
1205 $xs->element('link', array('rel' => 'self',
1206 'type' => 'application/atom+xml',
1207 'href' => $profile->profileurl));
1208 $xs->element('link', array('rel' => 'license',
1209 'href' => common_config('license', 'url')));
1212 $xs->element('icon', null, $profile->avatarUrl(AVATAR_PROFILE_SIZE));
1213 $xs->element('updated', null, common_date_w3dtf($this->created));
1217 $xs->elementEnd('source');
1220 $xs->element('title', null, common_xml_safe_str($this->content));
1223 $xs->raw($profile->asAtomAuthor());
1224 $xs->raw($profile->asActivityActor());
1227 $xs->element('link', array('rel' => 'alternate',
1228 'type' => 'text/html',
1229 'href' => $this->bestUrl()));
1231 $xs->element('id', null, $this->uri);
1233 $xs->element('published', null, common_date_w3dtf($this->created));
1234 $xs->element('updated', null, common_date_w3dtf($this->created));
1236 $noticeInfoAttr = array(
1237 'local_id' => $this->id, // local notice ID (useful to clients for ordering)
1238 'source' => $this->source // the client name (source attribution)
1241 $ns = $this->getSource();
1243 if (!empty($ns->url)) {
1244 $noticeInfoAttr['source_link'] = $ns->url;
1249 $noticeInfoAttr['favorited'] = ($cur->hasFave($this)) ? 'true' : 'false';
1252 $xs->element('statusnet:notice_info', $noticeInfoAttr, null);
1254 if ($this->reply_to) {
1255 $reply_notice = Notice::staticGet('id', $this->reply_to);
1256 if (!empty($reply_notice)) {
1257 $xs->element('link', array('rel' => 'related',
1258 'href' => $reply_notice->bestUrl()));
1259 $xs->element('thr:in-reply-to',
1260 array('ref' => $reply_notice->uri,
1261 'href' => $reply_notice->bestUrl()));
1265 if (!empty($this->conversation)) {
1267 $conv = Conversation::staticGet('id', $this->conversation);
1269 if (!empty($conv)) {
1272 'rel' => 'ostatus:conversation',
1273 'href' => $conv->uri
1279 $reply_ids = $this->getReplies();
1281 foreach ($reply_ids as $id) {
1282 $profile = Profile::staticGet('id', $id);
1283 if (!empty($profile)) {
1286 'rel' => 'ostatus:attention',
1287 'href' => $profile->getUri()
1293 $groups = $this->getGroups();
1295 foreach ($groups as $group) {
1298 'rel' => 'ostatus:attention',
1299 'href' => $group->permalink()
1304 if (!empty($this->repeat_of)) {
1305 $repeat = Notice::staticGet('id', $this->repeat_of);
1306 if (!empty($repeat)) {
1309 array('ref' => $repeat->uri, 'href' => $repeat->bestUrl())
1316 array('type' => 'html'),
1317 common_xml_safe_str($this->rendered)
1320 $tag = new Notice_tag();
1321 $tag->notice_id = $this->id;
1323 while ($tag->fetch()) {
1324 $xs->element('category', array('term' => $tag->tag));
1330 $attachments = $this->attachments();
1332 foreach($attachments as $attachment){
1333 $enclosure=$attachment->getEnclosure();
1335 $attributes = array('rel'=>'enclosure','href'=>$enclosure->url,'type'=>$enclosure->mimetype,'length'=>$enclosure->size);
1336 if($enclosure->title){
1337 $attributes['title']=$enclosure->title;
1339 $xs->element('link', $attributes, null);
1344 if (!empty($this->lat) && !empty($this->lon)) {
1345 $xs->element('georss:point', null, $this->lat . ' ' . $this->lon);
1348 $xs->elementEnd('entry');
1350 return $xs->getString();
1354 * Returns an XML string fragment with a reference to a notice as an
1355 * Activity Streams noun object with the given element type.
1357 * Assumes that 'activity' namespace has been previously defined.
1359 * @param string $element one of 'subject', 'object', 'target'
1362 function asActivityNoun($element)
1364 $noun = ActivityObject::fromNotice($this);
1365 return $noun->asString('activity:' . $element);
1370 if (!empty($this->url)) {
1372 } else if (!empty($this->uri) && preg_match('/^https?:/', $this->uri)) {
1375 return common_local_url('shownotice',
1376 array('notice' => $this->id));
1380 function stream($fn, $args, $cachekey, $offset=0, $limit=20, $since_id=0, $max_id=0)
1382 $cache = common_memcache();
1384 if (empty($cache) ||
1385 $since_id != 0 || $max_id != 0 ||
1387 ($offset + $limit) > NOTICE_CACHE_WINDOW) {
1388 return call_user_func_array($fn, array_merge($args, array($offset, $limit, $since_id,
1392 $idkey = common_cache_key($cachekey);
1394 $idstr = $cache->get($idkey);
1396 if ($idstr !== false) {
1397 // Cache hit! Woohoo!
1398 $window = explode(',', $idstr);
1399 $ids = array_slice($window, $offset, $limit);
1403 $laststr = $cache->get($idkey.';last');
1405 if ($laststr !== false) {
1406 $window = explode(',', $laststr);
1407 $last_id = $window[0];
1408 $new_ids = call_user_func_array($fn, array_merge($args, array(0, NOTICE_CACHE_WINDOW,
1409 $last_id, 0, null)));
1411 $new_window = array_merge($new_ids, $window);
1413 $new_windowstr = implode(',', $new_window);
1415 $result = $cache->set($idkey, $new_windowstr);
1416 $result = $cache->set($idkey . ';last', $new_windowstr);
1418 $ids = array_slice($new_window, $offset, $limit);
1423 $window = call_user_func_array($fn, array_merge($args, array(0, NOTICE_CACHE_WINDOW,
1426 $windowstr = implode(',', $window);
1428 $result = $cache->set($idkey, $windowstr);
1429 $result = $cache->set($idkey . ';last', $windowstr);
1431 $ids = array_slice($window, $offset, $limit);
1437 * Determine which notice, if any, a new notice is in reply to.
1439 * For conversation tracking, we try to see where this notice fits
1440 * in the tree. Rough algorithm is:
1442 * if (reply_to is set and valid) {
1444 * } else if ((source not API or Web) and (content starts with "T NAME" or "@name ")) {
1445 * return ID of last notice by initial @name in content;
1448 * Note that all @nickname instances will still be used to save "reply" records,
1449 * so the notice shows up in the mentioned users' "replies" tab.
1451 * @param integer $reply_to ID passed in by Web or API
1452 * @param integer $profile_id ID of author
1453 * @param string $source Source tag, like 'web' or 'gwibber'
1454 * @param string $content Final notice content
1456 * @return integer ID of replied-to notice, or null for not a reply.
1459 static function getReplyTo($reply_to, $profile_id, $source, $content)
1461 static $lb = array('xmpp', 'mail', 'sms', 'omb');
1463 // If $reply_to is specified, we check that it exists, and then
1464 // return it if it does
1466 if (!empty($reply_to)) {
1467 $reply_notice = Notice::staticGet('id', $reply_to);
1468 if (!empty($reply_notice)) {
1473 // If it's not a "low bandwidth" source (one where you can't set
1474 // a reply_to argument), we return. This is mostly web and API
1477 if (!in_array($source, $lb)) {
1481 // Is there an initial @ or T?
1483 if (preg_match('/^T ([A-Z0-9]{1,64}) /', $content, $match) ||
1484 preg_match('/^@([a-z0-9]{1,64})\s+/', $content, $match)) {
1485 $nickname = common_canonical_nickname($match[1]);
1490 // Figure out who that is.
1492 $sender = Profile::staticGet('id', $profile_id);
1493 if (empty($sender)) {
1497 $recipient = common_relative_profile($sender, $nickname, common_sql_now());
1499 if (empty($recipient)) {
1503 // Get their last notice
1505 $last = $recipient->getCurrentNotice();
1507 if (!empty($last)) {
1512 static function maxContent()
1514 $contentlimit = common_config('notice', 'contentlimit');
1515 // null => use global limit (distinct from 0!)
1516 if (is_null($contentlimit)) {
1517 $contentlimit = common_config('site', 'textlimit');
1519 return $contentlimit;
1522 static function contentTooLong($content)
1524 $contentlimit = self::maxContent();
1525 return ($contentlimit > 0 && !empty($content) && (mb_strlen($content) > $contentlimit));
1528 function getLocation()
1532 if (!empty($this->location_id) && !empty($this->location_ns)) {
1533 $location = Location::fromId($this->location_id, $this->location_ns);
1536 if (is_null($location)) { // no ID, or Location::fromId() failed
1537 if (!empty($this->lat) && !empty($this->lon)) {
1538 $location = Location::fromLatLon($this->lat, $this->lon);
1545 function repeat($repeater_id, $source)
1547 $author = Profile::staticGet('id', $this->profile_id);
1549 $content = sprintf(_('RT @%1$s %2$s'),
1553 $maxlen = common_config('site', 'textlimit');
1554 if ($maxlen > 0 && mb_strlen($content) > $maxlen) {
1555 // Web interface and current Twitter API clients will
1556 // pull the original notice's text, but some older
1557 // clients and RSS/Atom feeds will see this trimmed text.
1559 // Unfortunately this is likely to lose tags or URLs
1560 // at the end of long notices.
1561 $content = mb_substr($content, 0, $maxlen - 4) . ' ...';
1564 return self::saveNew($repeater_id, $content, $source,
1565 array('repeat_of' => $this->id));
1568 // These are supposed to be in chron order!
1570 function repeatStream($limit=100)
1572 $cache = common_memcache();
1574 if (empty($cache)) {
1575 $ids = $this->_repeatStreamDirect($limit);
1577 $idstr = $cache->get(common_cache_key('notice:repeats:'.$this->id));
1578 if ($idstr !== false) {
1579 $ids = explode(',', $idstr);
1581 $ids = $this->_repeatStreamDirect(100);
1582 $cache->set(common_cache_key('notice:repeats:'.$this->id), implode(',', $ids));
1585 // We do a max of 100, so slice down to limit
1586 $ids = array_slice($ids, 0, $limit);
1590 return Notice::getStreamByIds($ids);
1593 function _repeatStreamDirect($limit)
1595 $notice = new Notice();
1597 $notice->selectAdd(); // clears it
1598 $notice->selectAdd('id');
1600 $notice->repeat_of = $this->id;
1602 $notice->orderBy('created'); // NB: asc!
1604 if (!is_null($offset)) {
1605 $notice->limit($offset, $limit);
1610 if ($notice->find()) {
1611 while ($notice->fetch()) {
1612 $ids[] = $notice->id;
1622 function locationOptions($lat, $lon, $location_id, $location_ns, $profile = null)
1626 if (!empty($location_id) && !empty($location_ns)) {
1628 $options['location_id'] = $location_id;
1629 $options['location_ns'] = $location_ns;
1631 $location = Location::fromId($location_id, $location_ns);
1633 if (!empty($location)) {
1634 $options['lat'] = $location->lat;
1635 $options['lon'] = $location->lon;
1638 } else if (!empty($lat) && !empty($lon)) {
1640 $options['lat'] = $lat;
1641 $options['lon'] = $lon;
1643 $location = Location::fromLatLon($lat, $lon);
1645 if (!empty($location)) {
1646 $options['location_id'] = $location->location_id;
1647 $options['location_ns'] = $location->location_ns;
1649 } else if (!empty($profile)) {
1651 if (isset($profile->lat) && isset($profile->lon)) {
1652 $options['lat'] = $profile->lat;
1653 $options['lon'] = $profile->lon;
1656 if (isset($profile->location_id) && isset($profile->location_ns)) {
1657 $options['location_id'] = $profile->location_id;
1658 $options['location_ns'] = $profile->location_ns;
1665 function clearReplies()
1667 $replyNotice = new Notice();
1668 $replyNotice->reply_to = $this->id;
1670 //Null any notices that are replies to this notice
1672 if ($replyNotice->find()) {
1673 while ($replyNotice->fetch()) {
1674 $orig = clone($replyNotice);
1675 $replyNotice->reply_to = null;
1676 $replyNotice->update($orig);
1682 $reply = new Reply();
1683 $reply->notice_id = $this->id;
1685 if ($reply->find()) {
1686 while($reply->fetch()) {
1687 self::blow('reply:stream:%d', $reply->profile_id);
1695 function clearRepeats()
1697 $repeatNotice = new Notice();
1698 $repeatNotice->repeat_of = $this->id;
1700 //Null any notices that are repeats of this notice
1702 if ($repeatNotice->find()) {
1703 while ($repeatNotice->fetch()) {
1704 $orig = clone($repeatNotice);
1705 $repeatNotice->repeat_of = null;
1706 $repeatNotice->update($orig);
1711 function clearFaves()
1714 $fave->notice_id = $this->id;
1716 if ($fave->find()) {
1717 while ($fave->fetch()) {
1718 self::blow('fave:ids_by_user_own:%d', $fave->user_id);
1719 self::blow('fave:ids_by_user_own:%d;last', $fave->user_id);
1720 self::blow('fave:ids_by_user:%d', $fave->user_id);
1721 self::blow('fave:ids_by_user:%d;last', $fave->user_id);
1729 function clearTags()
1731 $tag = new Notice_tag();
1732 $tag->notice_id = $this->id;
1735 while ($tag->fetch()) {
1736 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, common_keyize($tag->tag));
1737 self::blow('profile:notice_ids_tagged:%d:%s;last', $this->profile_id, common_keyize($tag->tag));
1738 self::blow('notice_tag:notice_ids:%s', common_keyize($tag->tag));
1739 self::blow('notice_tag:notice_ids:%s;last', common_keyize($tag->tag));
1747 function clearGroupInboxes()
1749 $gi = new Group_inbox();
1751 $gi->notice_id = $this->id;
1754 while ($gi->fetch()) {
1755 self::blow('user_group:notice_ids:%d', $gi->group_id);
1763 function distribute()
1765 // We always insert for the author so they don't
1768 $user = User::staticGet('id', $this->profile_id);
1769 if (!empty($user)) {
1770 Inbox::insertNotice($user->id, $this->id);
1773 if (common_config('queue', 'inboxes')) {
1774 // If there's a failure, we want to _force_
1775 // distribution at this point.
1777 $qm = QueueManager::get();
1778 $qm->enqueue($this, 'distrib');
1779 } catch (Exception $e) {
1780 // If the exception isn't transient, this
1781 // may throw more exceptions as DQH does
1782 // its own enqueueing. So, we ignore them!
1784 $handler = new DistribQueueHandler();
1785 $handler->handle($this);
1786 } catch (Exception $e) {
1787 common_log(LOG_ERR, "emergency redistribution resulted in " . $e->getMessage());
1789 // Re-throw so somebody smarter can handle it.
1793 $handler = new DistribQueueHandler();
1794 $handler->handle($this);
1800 $result = parent::insert();
1803 // Profile::hasRepeated() abuses pkeyGet(), so we
1804 // have to clear manually
1805 if (!empty($this->repeat_of)) {
1806 $c = self::memcache();
1808 $ck = self::multicacheKey('Notice',
1809 array('profile_id' => $this->profile_id,
1810 'repeat_of' => $this->repeat_of));
1820 * Get the source of the notice
1822 * @return Notice_source $ns A notice source object. 'code' is the only attribute
1823 * guaranteed to be populated.
1825 function getSource()
1827 $ns = new Notice_source();
1828 if (!empty($this->source)) {
1829 switch ($this->source) {
1836 $ns->code = $this->source;
1839 $ns = Notice_source::staticGet($this->source);
1841 $ns = new Notice_source();
1842 $ns->code = $this->source;
1843 $app = Oauth_application::staticGet('name', $this->source);
1845 $ns->name = $app->name;
1846 $ns->url = $app->source_url;