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 * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
33 * @license GNU Affero General Public License http://www.gnu.org/licenses/
36 if (!defined('STATUSNET') && !defined('LACONICA')) {
41 * Table Definition for notice
43 require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
45 /* We keep 200 notices, the max number of notices available per API request,
46 * in the memcached cache. */
48 define('NOTICE_CACHE_WINDOW', CachingNoticeStream::CACHE_WINDOW);
50 define('MAX_BOXCARS', 128);
52 class Notice extends Memcached_DataObject
55 /* the code below is auto generated do not remove the above tag */
57 public $__table = 'notice'; // table name
58 public $id; // int(4) primary_key not_null
59 public $profile_id; // int(4) multiple_key not_null
60 public $uri; // varchar(255) unique_key
61 public $content; // text
62 public $rendered; // text
63 public $url; // varchar(255)
64 public $created; // datetime multiple_key not_null default_0000-00-00%2000%3A00%3A00
65 public $modified; // timestamp not_null default_CURRENT_TIMESTAMP
66 public $reply_to; // int(4)
67 public $is_local; // int(4)
68 public $source; // varchar(32)
69 public $conversation; // int(4)
70 public $lat; // decimal(10,7)
71 public $lon; // decimal(10,7)
72 public $location_id; // int(4)
73 public $location_ns; // int(4)
74 public $repeat_of; // int(4)
75 public $object_type; // varchar(255)
78 function staticGet($k,$v=NULL)
80 return Memcached_DataObject::staticGet('Notice',$k,$v);
83 /* the code above is auto generated do not remove the tag below */
87 const LOCAL_PUBLIC = 1;
89 const LOCAL_NONPUBLIC = -1;
94 $profile = Profile::staticGet('id', $this->profile_id);
96 if (empty($profile)) {
97 // TRANS: Server exception thrown when a user profile for a notice cannot be found.
98 // TRANS: %1$d is a profile ID (number), %2$d is a notice ID (number).
99 throw new ServerException(sprintf(_('No such profile (%1$d) for notice (%2$d).'), $this->profile_id, $this->id));
107 // For auditing purposes, save a record that the notice
110 // @fixme we have some cases where things get re-run and so the
112 $deleted = Deleted_notice::staticGet('id', $this->id);
115 $deleted = Deleted_notice::staticGet('uri', $this->uri);
119 $deleted = new Deleted_notice();
121 $deleted->id = $this->id;
122 $deleted->profile_id = $this->profile_id;
123 $deleted->uri = $this->uri;
124 $deleted->created = $this->created;
125 $deleted->deleted = common_sql_now();
130 if (Event::handle('NoticeDeleteRelated', array($this))) {
132 // Clear related records
134 $this->clearReplies();
135 $this->clearRepeats();
138 $this->clearGroupInboxes();
141 // NOTE: we don't clear inboxes
142 // NOTE: we don't clear queue items
145 $result = parent::delete();
147 $this->blowOnDelete();
152 * Extract #hashtags from this notice's content and save them to the database.
156 /* extract all #hastags */
157 $count = preg_match_all('/(?:^|\s)#([\pL\pN_\-\.]{1,64})/u', strtolower($this->content), $match);
162 /* Add them to the database */
163 return $this->saveKnownTags($match[1]);
167 * Record the given set of hash tags in the db for this notice.
168 * Given tag strings will be normalized and checked for dupes.
170 function saveKnownTags($hashtags)
172 //turn each into their canonical tag
173 //this is needed to remove dupes before saving e.g. #hash.tag = #hashtag
174 for($i=0; $i<count($hashtags); $i++) {
175 /* elide characters we don't want in the tag */
176 $hashtags[$i] = common_canonical_tag($hashtags[$i]);
179 foreach(array_unique($hashtags) as $hashtag) {
180 $this->saveTag($hashtag);
181 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, $hashtag);
187 * Record a single hash tag as associated with this notice.
188 * Tag format and uniqueness must be validated by caller.
190 function saveTag($hashtag)
192 $tag = new Notice_tag();
193 $tag->notice_id = $this->id;
194 $tag->tag = $hashtag;
195 $tag->created = $this->created;
196 $id = $tag->insert();
199 // TRANS: Server exception. %s are the error details.
200 throw new ServerException(sprintf(_('Database error inserting hashtag: %s'),
201 $last_error->message));
205 // if it's saved, blow its cache
206 $tag->blowCache(false);
210 * Save a new notice and push it out to subscribers' inboxes.
211 * Poster's permissions are checked before sending.
213 * @param int $profile_id Profile ID of the poster
214 * @param string $content source message text; links may be shortened
215 * per current user's preference
216 * @param string $source source key ('web', 'api', etc)
217 * @param array $options Associative array of optional properties:
218 * string 'created' timestamp of notice; defaults to now
219 * int 'is_local' source/gateway ID, one of:
220 * Notice::LOCAL_PUBLIC - Local, ok to appear in public timeline
221 * Notice::REMOTE_OMB - Sent from a remote OMB service;
222 * hide from public timeline but show in
223 * local "and friends" timelines
224 * Notice::LOCAL_NONPUBLIC - Local, but hide from public timeline
225 * Notice::GATEWAY - From another non-OMB service;
226 * will not appear in public views
227 * float 'lat' decimal latitude for geolocation
228 * float 'lon' decimal longitude for geolocation
229 * int 'location_id' geoname identifier
230 * int 'location_ns' geoname namespace to interpret location_id
231 * int 'reply_to'; notice ID this is a reply to
232 * int 'repeat_of'; notice ID this is a repeat of
233 * string 'uri' unique ID for notice; defaults to local notice URL
234 * string 'url' permalink to notice; defaults to local notice URL
235 * string 'rendered' rendered HTML version of content
236 * array 'replies' list of profile URIs for reply delivery in
237 * place of extracting @-replies from content.
238 * array 'groups' list of group IDs to deliver to, in place of
239 * extracting ! tags from content
240 * array 'tags' list of hashtag strings to save with the notice
241 * in place of extracting # tags from content
242 * array 'urls' list of attached/referred URLs to save with the
243 * notice in place of extracting links from content
244 * boolean 'distribute' whether to distribute the notice, default true
245 * string 'object_type' URL of the associated object type (default ActivityObject::NOTE)
247 * @fixme tag override
250 * @throws ClientException
252 static function saveNew($profile_id, $content, $source, $options=null) {
253 $defaults = array('uri' => null,
257 'distribute' => true);
259 if (!empty($options)) {
260 $options = $options + $defaults;
266 if (!isset($is_local)) {
267 $is_local = Notice::LOCAL_PUBLIC;
270 $profile = Profile::staticGet('id', $profile_id);
271 $user = User::staticGet('id', $profile_id);
273 // Use the local user's shortening preferences, if applicable.
274 $final = $user->shortenLinks($content);
276 $final = common_shorten_links($content);
279 if (Notice::contentTooLong($final)) {
280 // TRANS: Client exception thrown if a notice contains too many characters.
281 throw new ClientException(_('Problem saving notice. Too long.'));
284 if (empty($profile)) {
285 // TRANS: Client exception thrown when trying to save a notice for an unknown user.
286 throw new ClientException(_('Problem saving notice. Unknown user.'));
289 if (common_config('throttle', 'enabled') && !Notice::checkEditThrottle($profile_id)) {
290 common_log(LOG_WARNING, 'Excessive posting by profile #' . $profile_id . '; throttled.');
291 // TRANS: Client exception thrown when a user tries to post too many notices in a given time frame.
292 throw new ClientException(_('Too many notices too fast; take a breather '.
293 'and post again in a few minutes.'));
296 if (common_config('site', 'dupelimit') > 0 && !Notice::checkDupes($profile_id, $final)) {
297 common_log(LOG_WARNING, 'Dupe posting by profile #' . $profile_id . '; throttled.');
298 // TRANS: Client exception thrown when a user tries to post too many duplicate notices in a given time frame.
299 throw new ClientException(_('Too many duplicate messages too quickly;'.
300 ' take a breather and post again in a few minutes.'));
303 if (!$profile->hasRight(Right::NEWNOTICE)) {
304 common_log(LOG_WARNING, "Attempted post from user disallowed to post: " . $profile->nickname);
306 // TRANS: Client exception thrown when a user tries to post while being banned.
307 throw new ClientException(_('You are banned from posting notices on this site.'), 403);
310 $notice = new Notice();
311 $notice->profile_id = $profile_id;
313 $autosource = common_config('public', 'autosource');
315 // Sandboxed are non-false, but not 1, either
317 if (!$profile->hasRight(Right::PUBLICNOTICE) ||
318 ($source && $autosource && in_array($source, $autosource))) {
319 $notice->is_local = Notice::LOCAL_NONPUBLIC;
321 $notice->is_local = $is_local;
324 if (!empty($created)) {
325 $notice->created = $created;
327 $notice->created = common_sql_now();
330 $notice->content = $final;
332 $notice->source = $source;
336 // Handle repeat case
338 if (isset($repeat_of)) {
339 $notice->repeat_of = $repeat_of;
341 $notice->reply_to = self::getReplyTo($reply_to, $profile_id, $source, $final);
344 if (!empty($notice->reply_to)) {
345 $reply = Notice::staticGet('id', $notice->reply_to);
346 $notice->conversation = $reply->conversation;
349 if (!empty($lat) && !empty($lon)) {
354 if (!empty($location_ns) && !empty($location_id)) {
355 $notice->location_id = $location_id;
356 $notice->location_ns = $location_ns;
359 if (!empty($rendered)) {
360 $notice->rendered = $rendered;
362 $notice->rendered = common_render_content($final, $notice);
365 if (empty($object_type)) {
366 $notice->object_type = (empty($notice->reply_to)) ? ActivityObject::NOTE : ActivityObject::COMMENT;
368 $notice->object_type = $object_type;
371 if (Event::handle('StartNoticeSave', array(&$notice))) {
373 // XXX: some of these functions write to the DB
375 $id = $notice->insert();
378 common_log_db_error($notice, 'INSERT', __FILE__);
379 // TRANS: Server exception thrown when a notice cannot be saved.
380 throw new ServerException(_('Problem saving notice.'));
383 // Update ID-dependent columns: URI, conversation
385 $orig = clone($notice);
390 $notice->uri = common_notice_uri($notice);
394 // If it's not part of a conversation, it's
395 // the beginning of a new conversation.
397 if (empty($notice->conversation)) {
398 $conv = Conversation::create();
399 $notice->conversation = $conv->id;
404 if (!$notice->update($orig)) {
405 common_log_db_error($notice, 'UPDATE', __FILE__);
406 // TRANS: Server exception thrown when a notice cannot be updated.
407 throw new ServerException(_('Problem saving notice.'));
413 // Clear the cache for subscribed users, so they'll update at next request
414 // XXX: someone clever could prepend instead of clearing the cache
416 $notice->blowOnInsert();
418 // Save per-notice metadata...
420 if (isset($replies)) {
421 $notice->saveKnownReplies($replies);
423 $notice->saveReplies();
427 $notice->saveKnownTags($tags);
432 // Note: groups may save tags, so must be run after tags are saved
433 // to avoid errors on duplicates.
434 if (isset($groups)) {
435 $notice->saveKnownGroups($groups);
437 $notice->saveGroups();
441 $notice->saveKnownUrls($urls);
447 // Prepare inbox delivery, may be queued to background.
448 $notice->distribute();
454 function blowOnInsert($conversation = false)
456 self::blow('profile:notice_ids:%d', $this->profile_id);
458 if ($this->isPublic()) {
459 self::blow('public');
462 // XXX: Before we were blowing the casche only if the notice id
463 // was not the root of the conversation. What to do now?
465 self::blow('notice:conversation_ids:%d', $this->conversation);
467 if (!empty($this->repeat_of)) {
468 self::blow('notice:repeats:%d', $this->repeat_of);
471 $original = Notice::staticGet('id', $this->repeat_of);
473 if (!empty($original)) {
474 $originalUser = User::staticGet('id', $original->profile_id);
475 if (!empty($originalUser)) {
476 self::blow('user:repeats_of_me:%d', $originalUser->id);
480 $profile = Profile::staticGet($this->profile_id);
481 if (!empty($profile)) {
482 $profile->blowNoticeCount();
487 * Clear cache entries related to this notice at delete time.
488 * Necessary to avoid breaking paging on public, profile timelines.
490 function blowOnDelete()
492 $this->blowOnInsert();
494 self::blow('profile:notice_ids:%d;last', $this->profile_id);
496 if ($this->isPublic()) {
497 self::blow('public;last');
500 self::blow('fave:by_notice', $this->id);
502 if ($this->conversation) {
503 // In case we're the first, will need to calc a new root.
504 self::blow('notice:conversation_root:%d', $this->conversation);
508 /** save all urls in the notice to the db
510 * follow redirects and save all available file information
511 * (mimetype, date, size, oembed, etc.)
515 function saveUrls() {
516 if (common_config('attachments', 'process_links')) {
517 common_replace_urls_callback($this->content, array($this, 'saveUrl'), $this->id);
522 * Save the given URLs as related links/attachments to the db
524 * follow redirects and save all available file information
525 * (mimetype, date, size, oembed, etc.)
529 function saveKnownUrls($urls)
531 if (common_config('attachments', 'process_links')) {
532 // @fixme validation?
533 foreach (array_unique($urls) as $url) {
534 File::processNew($url, $this->id);
542 function saveUrl($url, $notice_id) {
543 File::processNew($url, $notice_id);
546 static function checkDupes($profile_id, $content) {
547 $profile = Profile::staticGet($profile_id);
548 if (empty($profile)) {
551 $notice = $profile->getNotices(0, CachingNoticeStream::CACHE_WINDOW);
552 if (!empty($notice)) {
554 while ($notice->fetch()) {
555 if (time() - strtotime($notice->created) >= common_config('site', 'dupelimit')) {
557 } else if ($notice->content == $content) {
562 // If we get here, oldest item in cache window is not
563 // old enough for dupe limit; do direct check against DB
564 $notice = new Notice();
565 $notice->profile_id = $profile_id;
566 $notice->content = $content;
567 $threshold = common_sql_date(time() - common_config('site', 'dupelimit'));
568 $notice->whereAdd(sprintf("created > '%s'", $notice->escape($threshold)));
570 $cnt = $notice->count();
574 static function checkEditThrottle($profile_id) {
575 $profile = Profile::staticGet($profile_id);
576 if (empty($profile)) {
579 // Get the Nth notice
580 $notice = $profile->getNotices(common_config('throttle', 'count') - 1, 1);
581 if ($notice && $notice->fetch()) {
582 // If the Nth notice was posted less than timespan seconds ago
583 if (time() - strtotime($notice->created) <= common_config('throttle', 'timespan')) {
588 // Either not N notices in the stream, OR the Nth was not posted within timespan seconds
592 function getUploadedAttachment() {
594 $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"';
595 $post->query($query);
597 if (empty($post->up) || empty($post->i)) {
600 $ret = array($post->up, $post->i);
606 function hasAttachments() {
608 $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);
609 $post->query($query);
611 $n_attachments = intval($post->n_attachments);
613 return $n_attachments;
616 function attachments() {
619 $f2p = new File_to_post;
620 $f2p->post_id = $this->id;
622 while ($f2p->fetch()) {
623 $f = File::staticGet($f2p->file_id);
633 function publicStream($offset=0, $limit=20, $since_id=0, $max_id=0)
635 $stream = new PublicNoticeStream();
636 return $stream->getNotices($offset, $limit, $since_id, $max_id);
640 function conversationStream($id, $offset=0, $limit=20, $since_id=0, $max_id=0)
642 $stream = new ConversationNoticeStream($id);
644 return $stream->getNotices($offset, $limit, $since_id, $max_id);
648 * Is this notice part of an active conversation?
650 * @return boolean true if other messages exist in the same
651 * conversation, false if this is the only one
653 function hasConversation()
655 if (!empty($this->conversation)) {
656 $conversation = Notice::conversationStream(
662 if ($conversation->N > 0) {
670 * Grab the earliest notice from this conversation.
672 * @return Notice or null
674 function conversationRoot()
676 if (!empty($this->conversation)) {
677 $c = self::memcache();
679 $key = Cache::key('notice:conversation_root:' . $this->conversation);
680 $notice = $c->get($key);
685 $notice = new Notice();
686 $notice->conversation = $this->conversation;
687 $notice->orderBy('CREATED');
692 $c->set($key, $notice);
699 * Pull up a full list of local recipients who will be getting
700 * this notice in their inbox. Results will be cached, so don't
701 * change the input data wily-nilly!
703 * @param array $groups optional list of Group objects;
704 * if left empty, will be loaded from group_inbox records
705 * @param array $recipient optional list of reply profile ids
706 * if left empty, will be loaded from reply records
707 * @return array associating recipient user IDs with an inbox source constant
709 function whoGets($groups=null, $recipients=null)
711 $c = self::memcache();
714 $ni = $c->get(Cache::key('notice:who_gets:'.$this->id));
720 if (is_null($groups)) {
721 $groups = $this->getGroups();
724 if (is_null($recipients)) {
725 $recipients = $this->getReplies();
728 $users = $this->getSubscribedUsers();
730 // FIXME: kind of ignoring 'transitional'...
731 // we'll probably stop supporting inboxless mode
736 // Give plugins a chance to add folks in at start...
737 if (Event::handle('StartNoticeWhoGets', array($this, &$ni))) {
739 foreach ($users as $id) {
740 $ni[$id] = NOTICE_INBOX_SOURCE_SUB;
743 foreach ($groups as $group) {
744 $users = $group->getUserMembers();
745 foreach ($users as $id) {
746 if (!array_key_exists($id, $ni)) {
747 $ni[$id] = NOTICE_INBOX_SOURCE_GROUP;
752 foreach ($recipients as $recipient) {
753 if (!array_key_exists($recipient, $ni)) {
754 $ni[$recipient] = NOTICE_INBOX_SOURCE_REPLY;
758 // Exclude any deleted, non-local, or blocking recipients.
759 $profile = $this->getProfile();
760 $originalProfile = null;
761 if ($this->repeat_of) {
762 // Check blocks against the original notice's poster as well.
763 $original = Notice::staticGet('id', $this->repeat_of);
765 $originalProfile = $original->getProfile();
768 foreach ($ni as $id => $source) {
769 $user = User::staticGet('id', $id);
770 if (empty($user) || $user->hasBlocked($profile) ||
771 ($originalProfile && $user->hasBlocked($originalProfile))) {
776 // Give plugins a chance to filter out...
777 Event::handle('EndNoticeWhoGets', array($this, &$ni));
781 // XXX: pack this data better
782 $c->set(Cache::key('notice:who_gets:'.$this->id), $ni);
789 * Adds this notice to the inboxes of each local user who should receive
790 * it, based on author subscriptions, group memberships, and @-replies.
792 * Warning: running a second time currently will make items appear
793 * multiple times in users' inboxes.
795 * @fixme make more robust against errors
796 * @fixme break up massive deliveries to smaller background tasks
798 * @param array $groups optional list of Group objects;
799 * if left empty, will be loaded from group_inbox records
800 * @param array $recipient optional list of reply profile ids
801 * if left empty, will be loaded from reply records
803 function addToInboxes($groups=null, $recipients=null)
805 $ni = $this->whoGets($groups, $recipients);
807 $ids = array_keys($ni);
809 // We remove the author (if they're a local user),
810 // since we'll have already done this in distribute()
812 $i = array_search($this->profile_id, $ids);
820 Inbox::bulkInsert($this->id, $ids);
825 function getSubscribedUsers()
829 if(common_config('db','quote_identifiers'))
830 $user_table = '"user"';
831 else $user_table = 'user';
835 'FROM '. $user_table .' JOIN subscription '.
836 'ON '. $user_table .'.id = subscription.subscriber ' .
837 'WHERE subscription.subscribed = %d ';
839 $user->query(sprintf($qry, $this->profile_id));
843 while ($user->fetch()) {
853 * Record this notice to the given group inboxes for delivery.
854 * Overrides the regular parsing of !group markup.
856 * @param string $group_ids
857 * @fixme might prefer URIs as identifiers, as for replies?
858 * best with generalizations on user_group to support
859 * remote groups better.
861 function saveKnownGroups($group_ids)
863 if (!is_array($group_ids)) {
864 // TRANS: Server exception thrown when no array is provided to the method saveKnownGroups().
865 throw new ServerException(_('Bad type provided to saveKnownGroups.'));
869 foreach (array_unique($group_ids) as $id) {
870 $group = User_group::staticGet('id', $id);
872 common_log(LOG_ERR, "Local delivery to group id $id, $group->nickname");
873 $result = $this->addToGroupInbox($group);
875 common_log_db_error($gi, 'INSERT', __FILE__);
878 // @fixme should we save the tags here or not?
879 $groups[] = clone($group);
881 common_log(LOG_ERR, "Local delivery to group id $id skipped, doesn't exist");
889 * Parse !group delivery and record targets into group_inbox.
890 * @return array of Group objects
892 function saveGroups()
894 // Don't save groups for repeats
896 if (!empty($this->repeat_of)) {
902 /* extract all !group */
903 $count = preg_match_all('/(?:^|\s)!(' . Nickname::DISPLAY_FMT . ')/',
904 strtolower($this->content),
910 $profile = $this->getProfile();
912 /* Add them to the database */
914 foreach (array_unique($match[1]) as $nickname) {
915 /* XXX: remote groups. */
916 $group = User_group::getForNickname($nickname, $profile);
922 // we automatically add a tag for every group name, too
924 $tag = Notice_tag::pkeyGet(array('tag' => common_canonical_tag($nickname),
925 'notice_id' => $this->id));
928 $this->saveTag($nickname);
931 if ($profile->isMember($group)) {
933 $result = $this->addToGroupInbox($group);
936 common_log_db_error($gi, 'INSERT', __FILE__);
939 $groups[] = clone($group);
946 function addToGroupInbox($group)
948 $gi = Group_inbox::pkeyGet(array('group_id' => $group->id,
949 'notice_id' => $this->id));
953 $gi = new Group_inbox();
955 $gi->group_id = $group->id;
956 $gi->notice_id = $this->id;
957 $gi->created = $this->created;
959 $result = $gi->insert();
962 common_log_db_error($gi, 'INSERT', __FILE__);
963 // TRANS: Server exception thrown when an update for a group inbox fails.
964 throw new ServerException(_('Problem saving group inbox.'));
967 self::blow('user_group:notice_ids:%d', $gi->group_id);
974 * Save reply records indicating that this notice needs to be
975 * delivered to the local users with the given URIs.
977 * Since this is expected to be used when saving foreign-sourced
978 * messages, we won't deliver to any remote targets as that's the
979 * source service's responsibility.
981 * Mail notifications etc will be handled later.
983 * @param array of unique identifier URIs for recipients
985 function saveKnownReplies($uris)
991 $sender = Profile::staticGet($this->profile_id);
993 foreach (array_unique($uris) as $uri) {
995 $profile = Profile::fromURI($uri);
997 if (empty($profile)) {
998 common_log(LOG_WARNING, "Unable to determine profile for URI '$uri'");
1002 if ($profile->hasBlocked($sender)) {
1003 common_log(LOG_INFO, "Not saving reply to profile {$profile->id} ($uri) from sender {$sender->id} because of a block.");
1007 $reply = new Reply();
1009 $reply->notice_id = $this->id;
1010 $reply->profile_id = $profile->id;
1011 $reply->modified = $this->created;
1013 common_log(LOG_INFO, __METHOD__ . ": saving reply: notice $this->id to profile $profile->id");
1015 $id = $reply->insert();
1022 * Pull @-replies from this message's content in StatusNet markup format
1023 * and save reply records indicating that this message needs to be
1024 * delivered to those users.
1026 * Mail notifications to local profiles will be sent later.
1028 * @return array of integer profile IDs
1031 function saveReplies()
1033 // Don't save reply data for repeats
1035 if (!empty($this->repeat_of)) {
1039 $sender = Profile::staticGet($this->profile_id);
1041 // @todo ideally this parser information would only
1042 // be calculated once.
1044 $mentions = common_find_mentions($this->content, $this);
1048 // store replied only for first @ (what user/notice what the reply directed,
1049 // we assume first @ is it)
1051 foreach ($mentions as $mention) {
1053 foreach ($mention['mentioned'] as $mentioned) {
1055 // skip if they're already covered
1057 if (!empty($replied[$mentioned->id])) {
1061 // Don't save replies from blocked profile to local user
1063 $mentioned_user = User::staticGet('id', $mentioned->id);
1064 if (!empty($mentioned_user) && $mentioned_user->hasBlocked($sender)) {
1068 $reply = new Reply();
1070 $reply->notice_id = $this->id;
1071 $reply->profile_id = $mentioned->id;
1072 $reply->modified = $this->created;
1074 $id = $reply->insert();
1077 common_log_db_error($reply, 'INSERT', __FILE__);
1078 // TRANS: Server exception thrown when a reply cannot be saved.
1079 // TRANS: %1$d is a notice ID, %2$d is the ID of the mentioned user.
1080 throw new ServerException(sprintf(_('Could not save reply for %1$d, %2$d.'), $this->id, $mentioned->id));
1082 $replied[$mentioned->id] = 1;
1083 self::blow('reply:stream:%d', $mentioned->id);
1088 $recipientIds = array_keys($replied);
1090 return $recipientIds;
1094 * Pull the complete list of @-reply targets for this notice.
1096 * @return array of integer profile ids
1098 function getReplies()
1104 $reply = new Reply();
1105 $reply->selectAdd();
1106 $reply->selectAdd('profile_id');
1107 $reply->notice_id = $this->id;
1109 if ($reply->find()) {
1110 while($reply->fetch()) {
1111 $ids[] = $reply->profile_id;
1121 * Send e-mail notifications to local @-reply targets.
1123 * Replies must already have been saved; this is expected to be run
1124 * from the distrib queue handler.
1126 function sendReplyNotifications()
1128 // Don't send reply notifications for repeats
1130 if (!empty($this->repeat_of)) {
1134 $recipientIds = $this->getReplies();
1136 foreach ($recipientIds as $recipientId) {
1137 $user = User::staticGet('id', $recipientId);
1138 if (!empty($user)) {
1139 mail_notify_attn($user, $this);
1145 * Pull list of groups this notice needs to be delivered to,
1146 * as previously recorded by saveGroups() or saveKnownGroups().
1148 * @return array of Group objects
1150 function getGroups()
1152 // Don't save groups for repeats
1154 if (!empty($this->repeat_of)) {
1162 $gi = new Group_inbox();
1165 $gi->selectAdd('group_id');
1167 $gi->notice_id = $this->id;
1170 while ($gi->fetch()) {
1171 $group = User_group::staticGet('id', $gi->group_id);
1184 * Convert a notice into an activity for export.
1186 * @param User $cur Current user
1188 * @return Activity activity object representing this Notice.
1191 function asActivity($cur)
1193 $act = self::cacheGet(Cache::codeKey('notice:as-activity:'.$this->id));
1198 $act = new Activity();
1200 if (Event::handle('StartNoticeAsActivity', array($this, &$act))) {
1202 $profile = $this->getProfile();
1204 $act->actor = ActivityObject::fromProfile($profile);
1205 $act->actor->extra[] = $profile->profileInfo($cur);
1206 $act->verb = ActivityVerb::POST;
1207 $act->objects[] = ActivityObject::fromNotice($this);
1209 // XXX: should this be handled by default processing for object entry?
1211 $act->time = strtotime($this->created);
1212 $act->link = $this->bestUrl();
1214 $act->content = common_xml_safe_str($this->rendered);
1215 $act->id = $this->uri;
1216 $act->title = common_xml_safe_str($this->content);
1220 $tags = $this->getTags();
1222 foreach ($tags as $tag) {
1223 $cat = new AtomCategory();
1226 $act->categories[] = $cat;
1230 // XXX: use Atom Media and/or File activity objects instead
1232 $attachments = $this->attachments();
1234 foreach ($attachments as $attachment) {
1235 $enclosure = $attachment->getEnclosure();
1237 $act->enclosures[] = $enclosure;
1241 $ctx = new ActivityContext();
1243 if (!empty($this->reply_to)) {
1244 $reply = Notice::staticGet('id', $this->reply_to);
1245 if (!empty($reply)) {
1246 $ctx->replyToID = $reply->uri;
1247 $ctx->replyToUrl = $reply->bestUrl();
1251 $ctx->location = $this->getLocation();
1255 if (!empty($this->conversation)) {
1256 $conv = Conversation::staticGet('id', $this->conversation);
1257 if (!empty($conv)) {
1258 $ctx->conversation = $conv->uri;
1262 $reply_ids = $this->getReplies();
1264 foreach ($reply_ids as $id) {
1265 $profile = Profile::staticGet('id', $id);
1266 if (!empty($profile)) {
1267 $ctx->attention[] = $profile->getUri();
1271 $groups = $this->getGroups();
1273 foreach ($groups as $group) {
1274 $ctx->attention[] = $group->getUri();
1277 // XXX: deprecated; use ActivityVerb::SHARE instead
1281 if (!empty($this->repeat_of)) {
1282 $repeat = Notice::staticGet('id', $this->repeat_of);
1283 $ctx->forwardID = $repeat->uri;
1284 $ctx->forwardUrl = $repeat->bestUrl();
1287 $act->context = $ctx;
1291 $atom_feed = $profile->getAtomFeed();
1293 if (!empty($atom_feed)) {
1295 $act->source = new ActivitySource();
1297 // XXX: we should store the actual feed ID
1299 $act->source->id = $atom_feed;
1301 // XXX: we should store the actual feed title
1303 $act->source->title = $profile->getBestName();
1305 $act->source->links['alternate'] = $profile->profileurl;
1306 $act->source->links['self'] = $atom_feed;
1308 $act->source->icon = $profile->avatarUrl(AVATAR_PROFILE_SIZE);
1310 $notice = $profile->getCurrentNotice();
1312 if (!empty($notice)) {
1313 $act->source->updated = self::utcDate($notice->created);
1316 $user = User::staticGet('id', $profile->id);
1318 if (!empty($user)) {
1319 $act->source->links['license'] = common_config('license', 'url');
1323 if ($this->isLocal()) {
1324 $act->selfLink = common_local_url('ApiStatusesShow', array('id' => $this->id,
1325 'format' => 'atom'));
1326 $act->editLink = $act->selfLink;
1329 Event::handle('EndNoticeAsActivity', array($this, &$act));
1332 self::cacheSet(Cache::codeKey('notice:as-activity:'.$this->id), $act);
1337 // This has gotten way too long. Needs to be sliced up into functional bits
1338 // or ideally exported to a utility class.
1340 function asAtomEntry($namespace=false,
1345 $act = $this->asActivity($cur);
1346 $act->extra[] = $this->noticeInfo($cur);
1347 return $act->asString($namespace, $author, $source);
1351 * Extra notice info for atom entries
1353 * Clients use some extra notice info in the atom stream.
1354 * This gives it to them.
1356 * @param User $cur Current user
1358 * @return array representation of <statusnet:notice_info> element
1361 function noticeInfo($cur)
1363 // local notice ID (useful to clients for ordering)
1365 $noticeInfoAttr = array('local_id' => $this->id);
1369 $ns = $this->getSource();
1372 $noticeInfoAttr['source'] = $ns->code;
1373 if (!empty($ns->url)) {
1374 $noticeInfoAttr['source_link'] = $ns->url;
1375 if (!empty($ns->name)) {
1376 $noticeInfoAttr['source'] = '<a href="'
1377 . htmlspecialchars($ns->url)
1378 . '" rel="nofollow">'
1379 . htmlspecialchars($ns->name)
1385 // favorite and repeated
1388 $noticeInfoAttr['favorite'] = ($cur->hasFave($this)) ? "true" : "false";
1389 $cp = $cur->getProfile();
1390 $noticeInfoAttr['repeated'] = ($cp->hasRepeated($this->id)) ? "true" : "false";
1393 if (!empty($this->repeat_of)) {
1394 $noticeInfoAttr['repeat_of'] = $this->repeat_of;
1397 return array('statusnet:notice_info', $noticeInfoAttr, null);
1401 * Returns an XML string fragment with a reference to a notice as an
1402 * Activity Streams noun object with the given element type.
1404 * Assumes that 'activity' namespace has been previously defined.
1406 * @param string $element one of 'subject', 'object', 'target'
1410 function asActivityNoun($element)
1412 $noun = ActivityObject::fromNotice($this);
1413 return $noun->asString('activity:' . $element);
1418 if (!empty($this->url)) {
1420 } else if (!empty($this->uri) && preg_match('/^https?:/', $this->uri)) {
1423 return common_local_url('shownotice',
1424 array('notice' => $this->id));
1430 * Determine which notice, if any, a new notice is in reply to.
1432 * For conversation tracking, we try to see where this notice fits
1433 * in the tree. Rough algorithm is:
1435 * if (reply_to is set and valid) {
1437 * } else if ((source not API or Web) and (content starts with "T NAME" or "@name ")) {
1438 * return ID of last notice by initial @name in content;
1441 * Note that all @nickname instances will still be used to save "reply" records,
1442 * so the notice shows up in the mentioned users' "replies" tab.
1444 * @param integer $reply_to ID passed in by Web or API
1445 * @param integer $profile_id ID of author
1446 * @param string $source Source tag, like 'web' or 'gwibber'
1447 * @param string $content Final notice content
1449 * @return integer ID of replied-to notice, or null for not a reply.
1452 static function getReplyTo($reply_to, $profile_id, $source, $content)
1454 static $lb = array('xmpp', 'mail', 'sms', 'omb');
1456 // If $reply_to is specified, we check that it exists, and then
1457 // return it if it does
1459 if (!empty($reply_to)) {
1460 $reply_notice = Notice::staticGet('id', $reply_to);
1461 if (!empty($reply_notice)) {
1466 // If it's not a "low bandwidth" source (one where you can't set
1467 // a reply_to argument), we return. This is mostly web and API
1470 if (!in_array($source, $lb)) {
1474 // Is there an initial @ or T?
1476 if (preg_match('/^T ([A-Z0-9]{1,64}) /', $content, $match) ||
1477 preg_match('/^@([a-z0-9]{1,64})\s+/', $content, $match)) {
1478 $nickname = common_canonical_nickname($match[1]);
1483 // Figure out who that is.
1485 $sender = Profile::staticGet('id', $profile_id);
1486 if (empty($sender)) {
1490 $recipient = common_relative_profile($sender, $nickname, common_sql_now());
1492 if (empty($recipient)) {
1496 // Get their last notice
1498 $last = $recipient->getCurrentNotice();
1500 if (!empty($last)) {
1505 static function maxContent()
1507 $contentlimit = common_config('notice', 'contentlimit');
1508 // null => use global limit (distinct from 0!)
1509 if (is_null($contentlimit)) {
1510 $contentlimit = common_config('site', 'textlimit');
1512 return $contentlimit;
1515 static function contentTooLong($content)
1517 $contentlimit = self::maxContent();
1518 return ($contentlimit > 0 && !empty($content) && (mb_strlen($content) > $contentlimit));
1521 function getLocation()
1525 if (!empty($this->location_id) && !empty($this->location_ns)) {
1526 $location = Location::fromId($this->location_id, $this->location_ns);
1529 if (is_null($location)) { // no ID, or Location::fromId() failed
1530 if (!empty($this->lat) && !empty($this->lon)) {
1531 $location = Location::fromLatLon($this->lat, $this->lon);
1538 function repeat($repeater_id, $source)
1540 $author = Profile::staticGet('id', $this->profile_id);
1542 // TRANS: Message used to repeat a notice. RT is the abbreviation of 'retweet'.
1543 // TRANS: %1$s is the repeated user's name, %2$s is the repeated notice.
1544 $content = sprintf(_('RT @%1$s %2$s'),
1548 $maxlen = common_config('site', 'textlimit');
1549 if ($maxlen > 0 && mb_strlen($content) > $maxlen) {
1550 // Web interface and current Twitter API clients will
1551 // pull the original notice's text, but some older
1552 // clients and RSS/Atom feeds will see this trimmed text.
1554 // Unfortunately this is likely to lose tags or URLs
1555 // at the end of long notices.
1556 $content = mb_substr($content, 0, $maxlen - 4) . ' ...';
1559 return self::saveNew($repeater_id, $content, $source,
1560 array('repeat_of' => $this->id));
1563 // These are supposed to be in chron order!
1565 function repeatStream($limit=100)
1567 $cache = Cache::instance();
1569 if (empty($cache)) {
1570 $ids = $this->_repeatStreamDirect($limit);
1572 $idstr = $cache->get(Cache::key('notice:repeats:'.$this->id));
1573 if ($idstr !== false) {
1574 $ids = explode(',', $idstr);
1576 $ids = $this->_repeatStreamDirect(100);
1577 $cache->set(Cache::key('notice:repeats:'.$this->id), implode(',', $ids));
1580 // We do a max of 100, so slice down to limit
1581 $ids = array_slice($ids, 0, $limit);
1585 return NoticeStream::getStreamByIds($ids);
1588 function _repeatStreamDirect($limit)
1590 $notice = new Notice();
1592 $notice->selectAdd(); // clears it
1593 $notice->selectAdd('id');
1595 $notice->repeat_of = $this->id;
1597 $notice->orderBy('created, id'); // NB: asc!
1599 if (!is_null($limit)) {
1600 $notice->limit(0, $limit);
1605 if ($notice->find()) {
1606 while ($notice->fetch()) {
1607 $ids[] = $notice->id;
1617 function locationOptions($lat, $lon, $location_id, $location_ns, $profile = null)
1621 if (!empty($location_id) && !empty($location_ns)) {
1622 $options['location_id'] = $location_id;
1623 $options['location_ns'] = $location_ns;
1625 $location = Location::fromId($location_id, $location_ns);
1627 if (!empty($location)) {
1628 $options['lat'] = $location->lat;
1629 $options['lon'] = $location->lon;
1632 } else if (!empty($lat) && !empty($lon)) {
1633 $options['lat'] = $lat;
1634 $options['lon'] = $lon;
1636 $location = Location::fromLatLon($lat, $lon);
1638 if (!empty($location)) {
1639 $options['location_id'] = $location->location_id;
1640 $options['location_ns'] = $location->location_ns;
1642 } else if (!empty($profile)) {
1643 if (isset($profile->lat) && isset($profile->lon)) {
1644 $options['lat'] = $profile->lat;
1645 $options['lon'] = $profile->lon;
1648 if (isset($profile->location_id) && isset($profile->location_ns)) {
1649 $options['location_id'] = $profile->location_id;
1650 $options['location_ns'] = $profile->location_ns;
1657 function clearReplies()
1659 $replyNotice = new Notice();
1660 $replyNotice->reply_to = $this->id;
1662 //Null any notices that are replies to this notice
1664 if ($replyNotice->find()) {
1665 while ($replyNotice->fetch()) {
1666 $orig = clone($replyNotice);
1667 $replyNotice->reply_to = null;
1668 $replyNotice->update($orig);
1674 $reply = new Reply();
1675 $reply->notice_id = $this->id;
1677 if ($reply->find()) {
1678 while($reply->fetch()) {
1679 self::blow('reply:stream:%d', $reply->profile_id);
1687 function clearFiles()
1689 $f2p = new File_to_post();
1691 $f2p->post_id = $this->id;
1694 while ($f2p->fetch()) {
1698 // FIXME: decide whether to delete File objects
1699 // ...and related (actual) files
1702 function clearRepeats()
1704 $repeatNotice = new Notice();
1705 $repeatNotice->repeat_of = $this->id;
1707 //Null any notices that are repeats of this notice
1709 if ($repeatNotice->find()) {
1710 while ($repeatNotice->fetch()) {
1711 $orig = clone($repeatNotice);
1712 $repeatNotice->repeat_of = null;
1713 $repeatNotice->update($orig);
1718 function clearFaves()
1721 $fave->notice_id = $this->id;
1723 if ($fave->find()) {
1724 while ($fave->fetch()) {
1725 self::blow('fave:ids_by_user_own:%d', $fave->user_id);
1726 self::blow('fave:ids_by_user_own:%d;last', $fave->user_id);
1727 self::blow('fave:ids_by_user:%d', $fave->user_id);
1728 self::blow('fave:ids_by_user:%d;last', $fave->user_id);
1736 function clearTags()
1738 $tag = new Notice_tag();
1739 $tag->notice_id = $this->id;
1742 while ($tag->fetch()) {
1743 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, Cache::keyize($tag->tag));
1744 self::blow('profile:notice_ids_tagged:%d:%s;last', $this->profile_id, Cache::keyize($tag->tag));
1745 self::blow('notice_tag:notice_ids:%s', Cache::keyize($tag->tag));
1746 self::blow('notice_tag:notice_ids:%s;last', Cache::keyize($tag->tag));
1754 function clearGroupInboxes()
1756 $gi = new Group_inbox();
1758 $gi->notice_id = $this->id;
1761 while ($gi->fetch()) {
1762 self::blow('user_group:notice_ids:%d', $gi->group_id);
1770 function distribute()
1772 // We always insert for the author so they don't
1774 Event::handle('StartNoticeDistribute', array($this));
1776 $user = User::staticGet('id', $this->profile_id);
1777 if (!empty($user)) {
1778 Inbox::insertNotice($user->id, $this->id);
1781 if (common_config('queue', 'inboxes')) {
1782 // If there's a failure, we want to _force_
1783 // distribution at this point.
1785 $qm = QueueManager::get();
1786 $qm->enqueue($this, 'distrib');
1787 } catch (Exception $e) {
1788 // If the exception isn't transient, this
1789 // may throw more exceptions as DQH does
1790 // its own enqueueing. So, we ignore them!
1792 $handler = new DistribQueueHandler();
1793 $handler->handle($this);
1794 } catch (Exception $e) {
1795 common_log(LOG_ERR, "emergency redistribution resulted in " . $e->getMessage());
1797 // Re-throw so somebody smarter can handle it.
1801 $handler = new DistribQueueHandler();
1802 $handler->handle($this);
1808 $result = parent::insert();
1811 // Profile::hasRepeated() abuses pkeyGet(), so we
1812 // have to clear manually
1813 if (!empty($this->repeat_of)) {
1814 $c = self::memcache();
1816 $ck = self::multicacheKey('Notice',
1817 array('profile_id' => $this->profile_id,
1818 'repeat_of' => $this->repeat_of));
1828 * Get the source of the notice
1830 * @return Notice_source $ns A notice source object. 'code' is the only attribute
1831 * guaranteed to be populated.
1833 function getSource()
1835 $ns = new Notice_source();
1836 if (!empty($this->source)) {
1837 switch ($this->source) {
1844 $ns->code = $this->source;
1847 $ns = Notice_source::staticGet($this->source);
1849 $ns = new Notice_source();
1850 $ns->code = $this->source;
1851 $app = Oauth_application::staticGet('name', $this->source);
1853 $ns->name = $app->name;
1854 $ns->url = $app->source_url;
1864 * Determine whether the notice was locally created
1866 * @return boolean locality
1869 public function isLocal()
1871 return ($this->is_local == Notice::LOCAL_PUBLIC ||
1872 $this->is_local == Notice::LOCAL_NONPUBLIC);
1876 * Get the list of hash tags saved with this notice.
1878 * @return array of strings
1880 public function getTags()
1883 $tag = new Notice_tag();
1884 $tag->notice_id = $this->id;
1886 while ($tag->fetch()) {
1887 $tags[] = $tag->tag;
1894 static private function utcDate($dt)
1896 $dateStr = date('d F Y H:i:s', strtotime($dt));
1897 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1898 return $d->format(DATE_W3C);
1902 * Look up the creation timestamp for a given notice ID, even
1903 * if it's been deleted.
1906 * @return mixed string recorded creation timestamp, or false if can't be found
1908 public static function getAsTimestamp($id)
1914 $notice = Notice::staticGet('id', $id);
1916 return $notice->created;
1919 $deleted = Deleted_notice::staticGet('id', $id);
1921 return $deleted->created;
1928 * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
1929 * parameter, matching notices posted after the given one (exclusive).
1931 * If the referenced notice can't be found, will return false.
1934 * @param string $idField
1935 * @param string $createdField
1936 * @return mixed string or false if no match
1938 public static function whereSinceId($id, $idField='id', $createdField='created')
1940 $since = Notice::getAsTimestamp($id);
1942 return sprintf("($createdField = '%s' and $idField > %d) or ($createdField > '%s')", $since, $id, $since);
1948 * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
1949 * parameter, matching notices posted after the given one (exclusive), and
1950 * if necessary add it to the data object's query.
1952 * @param DB_DataObject $obj
1954 * @param string $idField
1955 * @param string $createdField
1956 * @return mixed string or false if no match
1958 public static function addWhereSinceId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
1960 $since = self::whereSinceId($id, $idField, $createdField);
1962 $obj->whereAdd($since);
1967 * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
1968 * parameter, matching notices posted before the given one (inclusive).
1970 * If the referenced notice can't be found, will return false.
1973 * @param string $idField
1974 * @param string $createdField
1975 * @return mixed string or false if no match
1977 public static function whereMaxId($id, $idField='id', $createdField='created')
1979 $max = Notice::getAsTimestamp($id);
1981 return sprintf("($createdField < '%s') or ($createdField = '%s' and $idField <= %d)", $max, $max, $id);
1987 * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
1988 * parameter, matching notices posted before the given one (inclusive), and
1989 * if necessary add it to the data object's query.
1991 * @param DB_DataObject $obj
1993 * @param string $idField
1994 * @param string $createdField
1995 * @return mixed string or false if no match
1997 public static function addWhereMaxId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
1999 $max = self::whereMaxId($id, $idField, $createdField);
2001 $obj->whereAdd($max);
2007 if (common_config('public', 'localonly')) {
2008 return ($this->is_local == Notice::LOCAL_PUBLIC);
2010 return (($this->is_local != Notice::LOCAL_NONPUBLIC) &&
2011 ($this->is_local != Notice::GATEWAY));