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 if (!empty($profile)) {
425 $profile->blowNoticeCount();
430 * Clear cache entries related to this notice at delete time.
431 * Necessary to avoid breaking paging on public, profile timelines.
433 function blowOnDelete()
435 $this->blowOnInsert();
437 self::blow('profile:notice_ids:%d;last', $this->profile_id);
438 self::blow('public;last');
441 /** save all urls in the notice to the db
443 * follow redirects and save all available file information
444 * (mimetype, date, size, oembed, etc.)
448 function saveUrls() {
449 common_replace_urls_callback($this->content, array($this, 'saveUrl'), $this->id);
453 * Save the given URLs as related links/attachments to the db
455 * follow redirects and save all available file information
456 * (mimetype, date, size, oembed, etc.)
460 function saveKnownUrls($urls)
462 // @fixme validation?
463 foreach ($urls as $url) {
464 File::processNew($url, $this->id);
471 function saveUrl($data) {
472 list($url, $notice_id) = $data;
473 File::processNew($url, $notice_id);
476 static function checkDupes($profile_id, $content) {
477 $profile = Profile::staticGet($profile_id);
478 if (empty($profile)) {
481 $notice = $profile->getNotices(0, NOTICE_CACHE_WINDOW);
482 if (!empty($notice)) {
484 while ($notice->fetch()) {
485 if (time() - strtotime($notice->created) >= common_config('site', 'dupelimit')) {
487 } else if ($notice->content == $content) {
492 # If we get here, oldest item in cache window is not
493 # old enough for dupe limit; do direct check against DB
494 $notice = new Notice();
495 $notice->profile_id = $profile_id;
496 $notice->content = $content;
497 if (common_config('db','type') == 'pgsql')
498 $notice->whereAdd('extract(epoch from now() - created) < ' . common_config('site', 'dupelimit'));
500 $notice->whereAdd('now() - created < ' . common_config('site', 'dupelimit'));
502 $cnt = $notice->count();
506 static function checkEditThrottle($profile_id) {
507 $profile = Profile::staticGet($profile_id);
508 if (empty($profile)) {
512 $notice = $profile->getNotices(common_config('throttle', 'count') - 1, 1);
513 if ($notice && $notice->fetch()) {
514 # If the Nth notice was posted less than timespan seconds ago
515 if (time() - strtotime($notice->created) <= common_config('throttle', 'timespan')) {
520 # Either not N notices in the stream, OR the Nth was not posted within timespan seconds
524 function getUploadedAttachment() {
526 $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"';
527 $post->query($query);
529 if (empty($post->up) || empty($post->i)) {
532 $ret = array($post->up, $post->i);
538 function hasAttachments() {
540 $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);
541 $post->query($query);
543 $n_attachments = intval($post->n_attachments);
545 return $n_attachments;
548 function attachments() {
551 $f2p = new File_to_post;
552 $f2p->post_id = $this->id;
554 while ($f2p->fetch()) {
555 $f = File::staticGet($f2p->file_id);
562 function getStreamByIds($ids)
564 $cache = common_memcache();
566 if (!empty($cache)) {
568 foreach ($ids as $id) {
569 $n = Notice::staticGet('id', $id);
574 return new ArrayWrapper($notices);
576 $notice = new Notice();
578 //if no IDs requested, just return the notice object
581 $notice->whereAdd('id in (' . implode(', ', $ids) . ')');
587 while ($notice->fetch()) {
588 $temp[$notice->id] = clone($notice);
593 foreach ($ids as $id) {
594 if (array_key_exists($id, $temp)) {
595 $wrapped[] = $temp[$id];
599 return new ArrayWrapper($wrapped);
603 function publicStream($offset=0, $limit=20, $since_id=0, $max_id=0)
605 $ids = Notice::stream(array('Notice', '_publicStreamDirect'),
608 $offset, $limit, $since_id, $max_id);
609 return Notice::getStreamByIds($ids);
612 function _publicStreamDirect($offset=0, $limit=20, $since_id=0, $max_id=0)
614 $notice = new Notice();
616 $notice->selectAdd(); // clears it
617 $notice->selectAdd('id');
619 $notice->orderBy('id DESC');
621 if (!is_null($offset)) {
622 $notice->limit($offset, $limit);
625 if (common_config('public', 'localonly')) {
626 $notice->whereAdd('is_local = ' . Notice::LOCAL_PUBLIC);
628 # -1 == blacklisted, -2 == gateway (i.e. Twitter)
629 $notice->whereAdd('is_local !='. Notice::LOCAL_NONPUBLIC);
630 $notice->whereAdd('is_local !='. Notice::GATEWAY);
633 if ($since_id != 0) {
634 $notice->whereAdd('id > ' . $since_id);
638 $notice->whereAdd('id <= ' . $max_id);
643 if ($notice->find()) {
644 while ($notice->fetch()) {
645 $ids[] = $notice->id;
655 function conversationStream($id, $offset=0, $limit=20, $since_id=0, $max_id=0)
657 $ids = Notice::stream(array('Notice', '_conversationStreamDirect'),
659 'notice:conversation_ids:'.$id,
660 $offset, $limit, $since_id, $max_id);
662 return Notice::getStreamByIds($ids);
665 function _conversationStreamDirect($id, $offset=0, $limit=20, $since_id=0, $max_id=0)
667 $notice = new Notice();
669 $notice->selectAdd(); // clears it
670 $notice->selectAdd('id');
672 $notice->conversation = $id;
674 $notice->orderBy('id DESC');
676 if (!is_null($offset)) {
677 $notice->limit($offset, $limit);
680 if ($since_id != 0) {
681 $notice->whereAdd('id > ' . $since_id);
685 $notice->whereAdd('id <= ' . $max_id);
690 if ($notice->find()) {
691 while ($notice->fetch()) {
692 $ids[] = $notice->id;
703 * @param $groups array of Group *objects*
704 * @param $recipients array of profile *ids*
706 function whoGets($groups=null, $recipients=null)
708 $c = self::memcache();
711 $ni = $c->get(common_cache_key('notice:who_gets:'.$this->id));
717 if (is_null($groups)) {
718 $groups = $this->getGroups();
721 if (is_null($recipients)) {
722 $recipients = $this->getReplies();
725 $users = $this->getSubscribedUsers();
727 // FIXME: kind of ignoring 'transitional'...
728 // we'll probably stop supporting inboxless mode
733 foreach ($users as $id) {
734 $ni[$id] = NOTICE_INBOX_SOURCE_SUB;
737 $profile = $this->getProfile();
739 foreach ($groups as $group) {
740 $users = $group->getUserMembers();
741 foreach ($users as $id) {
742 if (!array_key_exists($id, $ni)) {
743 $user = User::staticGet('id', $id);
744 if (!$user->hasBlocked($profile)) {
745 $ni[$id] = NOTICE_INBOX_SOURCE_GROUP;
751 foreach ($recipients as $recipient) {
753 if (!array_key_exists($recipient, $ni)) {
754 $recipientUser = User::staticGet('id', $recipient);
755 if (!empty($recipientUser)) {
756 $ni[$recipient] = NOTICE_INBOX_SOURCE_REPLY;
762 // XXX: pack this data better
763 $c->set(common_cache_key('notice:who_gets:'.$this->id), $ni);
770 * Adds this notice to the inboxes of each local user who should receive
771 * it, based on author subscriptions, group memberships, and @-replies.
773 * Warning: running a second time currently will make items appear
774 * multiple times in users' inboxes.
776 * @fixme make more robust against errors
777 * @fixme break up massive deliveries to smaller background tasks
779 * @param array $groups optional list of Group objects;
780 * if left empty, will be loaded from group_inbox records
781 * @param array $recipient optional list of reply profile ids
782 * if left empty, will be loaded from reply records
784 function addToInboxes($groups=null, $recipients=null)
786 $ni = $this->whoGets($groups, $recipients);
788 $ids = array_keys($ni);
790 // We remove the author (if they're a local user),
791 // since we'll have already done this in distribute()
793 $i = array_search($this->profile_id, $ids);
801 Inbox::bulkInsert($this->id, $ids);
806 function getSubscribedUsers()
810 if(common_config('db','quote_identifiers'))
811 $user_table = '"user"';
812 else $user_table = 'user';
816 'FROM '. $user_table .' JOIN subscription '.
817 'ON '. $user_table .'.id = subscription.subscriber ' .
818 'WHERE subscription.subscribed = %d ';
820 $user->query(sprintf($qry, $this->profile_id));
824 while ($user->fetch()) {
834 * Record this notice to the given group inboxes for delivery.
835 * Overrides the regular parsing of !group markup.
837 * @param string $group_ids
838 * @fixme might prefer URIs as identifiers, as for replies?
839 * best with generalizations on user_group to support
840 * remote groups better.
842 function saveKnownGroups($group_ids)
844 if (!is_array($group_ids)) {
845 throw new ServerException("Bad type provided to saveKnownGroups");
849 foreach ($group_ids as $id) {
850 $group = User_group::staticGet('id', $id);
852 common_log(LOG_ERR, "Local delivery to group id $id, $group->nickname");
853 $result = $this->addToGroupInbox($group);
855 common_log_db_error($gi, 'INSERT', __FILE__);
858 // @fixme should we save the tags here or not?
859 $groups[] = clone($group);
861 common_log(LOG_ERR, "Local delivery to group id $id skipped, doesn't exist");
869 * Parse !group delivery and record targets into group_inbox.
870 * @return array of Group objects
872 function saveGroups()
874 // Don't save groups for repeats
876 if (!empty($this->repeat_of)) {
882 /* extract all !group */
883 $count = preg_match_all('/(?:^|\s)!([A-Za-z0-9]{1,64})/',
884 strtolower($this->content),
890 $profile = $this->getProfile();
892 /* Add them to the database */
894 foreach (array_unique($match[1]) as $nickname) {
895 /* XXX: remote groups. */
896 $group = User_group::getForNickname($nickname, $profile);
902 // we automatically add a tag for every group name, too
904 $tag = Notice_tag::pkeyGet(array('tag' => common_canonical_tag($nickname),
905 'notice_id' => $this->id));
908 $this->saveTag($nickname);
911 if ($profile->isMember($group)) {
913 $result = $this->addToGroupInbox($group);
916 common_log_db_error($gi, 'INSERT', __FILE__);
919 $groups[] = clone($group);
926 function addToGroupInbox($group)
928 $gi = Group_inbox::pkeyGet(array('group_id' => $group->id,
929 'notice_id' => $this->id));
933 $gi = new Group_inbox();
935 $gi->group_id = $group->id;
936 $gi->notice_id = $this->id;
937 $gi->created = $this->created;
939 $result = $gi->insert();
942 common_log_db_error($gi, 'INSERT', __FILE__);
943 throw new ServerException(_('Problem saving group inbox.'));
946 self::blow('user_group:notice_ids:%d', $gi->group_id);
953 * Save reply records indicating that this notice needs to be
954 * delivered to the local users with the given URIs.
956 * Since this is expected to be used when saving foreign-sourced
957 * messages, we won't deliver to any remote targets as that's the
958 * source service's responsibility.
960 * @fixme Unlike saveReplies() there's no mail notification here.
961 * Move that to distrib queue handler?
963 * @param array of unique identifier URIs for recipients
965 function saveKnownReplies($uris)
970 $sender = Profile::staticGet($this->profile_id);
972 foreach ($uris as $uri) {
974 $user = User::staticGet('uri', $uri);
977 if ($user->hasBlocked($sender)) {
981 $reply = new Reply();
983 $reply->notice_id = $this->id;
984 $reply->profile_id = $user->id;
986 $id = $reply->insert();
988 self::blow('reply:stream:%d', $user->id);
996 * Pull @-replies from this message's content in StatusNet markup format
997 * and save reply records indicating that this message needs to be
998 * delivered to those users.
1000 * Side effect: local recipients get e-mail notifications here.
1001 * @fixme move mail notifications to distrib?
1003 * @return array of integer profile IDs
1006 function saveReplies()
1008 // Don't save reply data for repeats
1010 if (!empty($this->repeat_of)) {
1014 $sender = Profile::staticGet($this->profile_id);
1016 // @todo ideally this parser information would only
1017 // be calculated once.
1019 $mentions = common_find_mentions($this->content, $this);
1023 // store replied only for first @ (what user/notice what the reply directed,
1024 // we assume first @ is it)
1026 foreach ($mentions as $mention) {
1028 foreach ($mention['mentioned'] as $mentioned) {
1030 // skip if they're already covered
1032 if (!empty($replied[$mentioned->id])) {
1036 // Don't save replies from blocked profile to local user
1038 $mentioned_user = User::staticGet('id', $mentioned->id);
1039 if (!empty($mentioned_user) && $mentioned_user->hasBlocked($sender)) {
1043 $reply = new Reply();
1045 $reply->notice_id = $this->id;
1046 $reply->profile_id = $mentioned->id;
1048 $id = $reply->insert();
1051 common_log_db_error($reply, 'INSERT', __FILE__);
1052 throw new ServerException("Couldn't save reply for {$this->id}, {$mentioned->id}");
1054 $replied[$mentioned->id] = 1;
1059 $recipientIds = array_keys($replied);
1061 foreach ($recipientIds as $recipientId) {
1062 $user = User::staticGet('id', $recipientId);
1063 if (!empty($user)) {
1064 self::blow('reply:stream:%d', $reply->profile_id);
1065 mail_notify_attn($user, $this);
1069 return $recipientIds;
1072 function getReplies()
1078 $reply = new Reply();
1079 $reply->selectAdd();
1080 $reply->selectAdd('profile_id');
1081 $reply->notice_id = $this->id;
1083 if ($reply->find()) {
1084 while($reply->fetch()) {
1085 $ids[] = $reply->profile_id;
1095 * Pull list of groups this notice needs to be delivered to,
1096 * as previously recorded by saveGroups() or saveKnownGroups().
1098 * @return array of Group objects
1100 function getGroups()
1102 // Don't save groups for repeats
1104 if (!empty($this->repeat_of)) {
1112 $gi = new Group_inbox();
1115 $gi->selectAdd('group_id');
1117 $gi->notice_id = $this->id;
1120 while ($gi->fetch()) {
1121 $group = User_group::staticGet('id', $gi->group_id);
1133 function asAtomEntry($namespace=false, $source=false, $author=true)
1135 $profile = $this->getProfile();
1137 $xs = new XMLStringer(true);
1140 $attrs = array('xmlns' => 'http://www.w3.org/2005/Atom',
1141 'xmlns:thr' => 'http://purl.org/syndication/thread/1.0',
1142 'xmlns:georss' => 'http://www.georss.org/georss',
1143 'xmlns:activity' => 'http://activitystrea.ms/spec/1.0/',
1144 'xmlns:media' => 'http://purl.org/syndication/atommedia',
1145 'xmlns:poco' => 'http://portablecontacts.net/spec/1.0',
1146 'xmlns:ostatus' => 'http://ostatus.org/schema/1.0');
1151 $xs->elementStart('entry', $attrs);
1154 $xs->elementStart('source');
1155 $xs->element('id', null, $profile->profileurl);
1156 $xs->element('title', null, $profile->nickname . " - " . common_config('site', 'name'));
1157 $xs->element('link', array('href' => $profile->profileurl));
1158 $user = User::staticGet('id', $profile->id);
1159 if (!empty($user)) {
1160 $atom_feed = common_local_url('ApiTimelineUser',
1161 array('format' => 'atom',
1162 'id' => $profile->nickname));
1163 $xs->element('link', array('rel' => 'self',
1164 'type' => 'application/atom+xml',
1165 'href' => $profile->profileurl));
1166 $xs->element('link', array('rel' => 'license',
1167 'href' => common_config('license', 'url')));
1170 $xs->element('icon', null, $profile->avatarUrl(AVATAR_PROFILE_SIZE));
1171 $xs->element('updated', null, common_date_w3dtf($this->created));
1175 $xs->elementEnd('source');
1178 $xs->element('title', null, common_xml_safe_str($this->content));
1181 $xs->raw($profile->asAtomAuthor());
1182 $xs->raw($profile->asActivityActor());
1185 $xs->element('link', array('rel' => 'alternate',
1186 'type' => 'text/html',
1187 'href' => $this->bestUrl()));
1189 $xs->element('id', null, $this->uri);
1191 $xs->element('published', null, common_date_w3dtf($this->created));
1192 $xs->element('updated', null, common_date_w3dtf($this->created));
1194 if ($this->reply_to) {
1195 $reply_notice = Notice::staticGet('id', $this->reply_to);
1196 if (!empty($reply_notice)) {
1197 $xs->element('link', array('rel' => 'related',
1198 'href' => $reply_notice->bestUrl()));
1199 $xs->element('thr:in-reply-to',
1200 array('ref' => $reply_notice->uri,
1201 'href' => $reply_notice->bestUrl()));
1205 if (!empty($this->conversation)) {
1207 $conv = Conversation::staticGet('id', $this->conversation);
1209 if (!empty($conv)) {
1212 'rel' => 'ostatus:conversation',
1213 'href' => $conv->uri
1219 $reply_ids = $this->getReplies();
1221 foreach ($reply_ids as $id) {
1222 $profile = Profile::staticGet('id', $id);
1223 if (!empty($profile)) {
1226 'rel' => 'ostatus:attention',
1227 'href' => $profile->getUri()
1233 $groups = $this->getGroups();
1235 foreach ($groups as $group) {
1238 'rel' => 'ostatus:attention',
1239 'href' => $group->permalink()
1244 if (!empty($this->repeat_of)) {
1245 $repeat = Notice::staticGet('id', $this->repeat_of);
1246 if (!empty($repeat)) {
1249 array('ref' => $repeat->uri, 'href' => $repeat->bestUrl())
1256 array('type' => 'html'),
1257 common_xml_safe_str($this->rendered)
1260 $tag = new Notice_tag();
1261 $tag->notice_id = $this->id;
1263 while ($tag->fetch()) {
1264 $xs->element('category', array('term' => $tag->tag));
1270 $attachments = $this->attachments();
1272 foreach($attachments as $attachment){
1273 $enclosure=$attachment->getEnclosure();
1275 $attributes = array('rel'=>'enclosure','href'=>$enclosure->url,'type'=>$enclosure->mimetype,'length'=>$enclosure->size);
1276 if($enclosure->title){
1277 $attributes['title']=$enclosure->title;
1279 $xs->element('link', $attributes, null);
1284 if (!empty($this->lat) && !empty($this->lon)) {
1285 $xs->element('georss:point', null, $this->lat . ' ' . $this->lon);
1288 $xs->elementEnd('entry');
1290 return $xs->getString();
1294 * Returns an XML string fragment with a reference to a notice as an
1295 * Activity Streams noun object with the given element type.
1297 * Assumes that 'activity' namespace has been previously defined.
1299 * @param string $element one of 'subject', 'object', 'target'
1302 function asActivityNoun($element)
1304 $noun = ActivityObject::fromNotice($this);
1305 return $noun->asString('activity:' . $element);
1310 if (!empty($this->url)) {
1312 } else if (!empty($this->uri) && preg_match('/^https?:/', $this->uri)) {
1315 return common_local_url('shownotice',
1316 array('notice' => $this->id));
1320 function stream($fn, $args, $cachekey, $offset=0, $limit=20, $since_id=0, $max_id=0)
1322 $cache = common_memcache();
1324 if (empty($cache) ||
1325 $since_id != 0 || $max_id != 0 ||
1327 ($offset + $limit) > NOTICE_CACHE_WINDOW) {
1328 return call_user_func_array($fn, array_merge($args, array($offset, $limit, $since_id,
1332 $idkey = common_cache_key($cachekey);
1334 $idstr = $cache->get($idkey);
1336 if ($idstr !== false) {
1337 // Cache hit! Woohoo!
1338 $window = explode(',', $idstr);
1339 $ids = array_slice($window, $offset, $limit);
1343 $laststr = $cache->get($idkey.';last');
1345 if ($laststr !== false) {
1346 $window = explode(',', $laststr);
1347 $last_id = $window[0];
1348 $new_ids = call_user_func_array($fn, array_merge($args, array(0, NOTICE_CACHE_WINDOW,
1349 $last_id, 0, null)));
1351 $new_window = array_merge($new_ids, $window);
1353 $new_windowstr = implode(',', $new_window);
1355 $result = $cache->set($idkey, $new_windowstr);
1356 $result = $cache->set($idkey . ';last', $new_windowstr);
1358 $ids = array_slice($new_window, $offset, $limit);
1363 $window = call_user_func_array($fn, array_merge($args, array(0, NOTICE_CACHE_WINDOW,
1366 $windowstr = implode(',', $window);
1368 $result = $cache->set($idkey, $windowstr);
1369 $result = $cache->set($idkey . ';last', $windowstr);
1371 $ids = array_slice($window, $offset, $limit);
1377 * Determine which notice, if any, a new notice is in reply to.
1379 * For conversation tracking, we try to see where this notice fits
1380 * in the tree. Rough algorithm is:
1382 * if (reply_to is set and valid) {
1384 * } else if ((source not API or Web) and (content starts with "T NAME" or "@name ")) {
1385 * return ID of last notice by initial @name in content;
1388 * Note that all @nickname instances will still be used to save "reply" records,
1389 * so the notice shows up in the mentioned users' "replies" tab.
1391 * @param integer $reply_to ID passed in by Web or API
1392 * @param integer $profile_id ID of author
1393 * @param string $source Source tag, like 'web' or 'gwibber'
1394 * @param string $content Final notice content
1396 * @return integer ID of replied-to notice, or null for not a reply.
1399 static function getReplyTo($reply_to, $profile_id, $source, $content)
1401 static $lb = array('xmpp', 'mail', 'sms', 'omb');
1403 // If $reply_to is specified, we check that it exists, and then
1404 // return it if it does
1406 if (!empty($reply_to)) {
1407 $reply_notice = Notice::staticGet('id', $reply_to);
1408 if (!empty($reply_notice)) {
1413 // If it's not a "low bandwidth" source (one where you can't set
1414 // a reply_to argument), we return. This is mostly web and API
1417 if (!in_array($source, $lb)) {
1421 // Is there an initial @ or T?
1423 if (preg_match('/^T ([A-Z0-9]{1,64}) /', $content, $match) ||
1424 preg_match('/^@([a-z0-9]{1,64})\s+/', $content, $match)) {
1425 $nickname = common_canonical_nickname($match[1]);
1430 // Figure out who that is.
1432 $sender = Profile::staticGet('id', $profile_id);
1433 if (empty($sender)) {
1437 $recipient = common_relative_profile($sender, $nickname, common_sql_now());
1439 if (empty($recipient)) {
1443 // Get their last notice
1445 $last = $recipient->getCurrentNotice();
1447 if (!empty($last)) {
1452 static function maxContent()
1454 $contentlimit = common_config('notice', 'contentlimit');
1455 // null => use global limit (distinct from 0!)
1456 if (is_null($contentlimit)) {
1457 $contentlimit = common_config('site', 'textlimit');
1459 return $contentlimit;
1462 static function contentTooLong($content)
1464 $contentlimit = self::maxContent();
1465 return ($contentlimit > 0 && !empty($content) && (mb_strlen($content) > $contentlimit));
1468 function getLocation()
1472 if (!empty($this->location_id) && !empty($this->location_ns)) {
1473 $location = Location::fromId($this->location_id, $this->location_ns);
1476 if (is_null($location)) { // no ID, or Location::fromId() failed
1477 if (!empty($this->lat) && !empty($this->lon)) {
1478 $location = Location::fromLatLon($this->lat, $this->lon);
1485 function repeat($repeater_id, $source)
1487 $author = Profile::staticGet('id', $this->profile_id);
1489 $content = sprintf(_('RT @%1$s %2$s'),
1493 $maxlen = common_config('site', 'textlimit');
1494 if ($maxlen > 0 && mb_strlen($content) > $maxlen) {
1495 // Web interface and current Twitter API clients will
1496 // pull the original notice's text, but some older
1497 // clients and RSS/Atom feeds will see this trimmed text.
1499 // Unfortunately this is likely to lose tags or URLs
1500 // at the end of long notices.
1501 $content = mb_substr($content, 0, $maxlen - 4) . ' ...';
1504 return self::saveNew($repeater_id, $content, $source,
1505 array('repeat_of' => $this->id));
1508 // These are supposed to be in chron order!
1510 function repeatStream($limit=100)
1512 $cache = common_memcache();
1514 if (empty($cache)) {
1515 $ids = $this->_repeatStreamDirect($limit);
1517 $idstr = $cache->get(common_cache_key('notice:repeats:'.$this->id));
1518 if ($idstr !== false) {
1519 $ids = explode(',', $idstr);
1521 $ids = $this->_repeatStreamDirect(100);
1522 $cache->set(common_cache_key('notice:repeats:'.$this->id), implode(',', $ids));
1525 // We do a max of 100, so slice down to limit
1526 $ids = array_slice($ids, 0, $limit);
1530 return Notice::getStreamByIds($ids);
1533 function _repeatStreamDirect($limit)
1535 $notice = new Notice();
1537 $notice->selectAdd(); // clears it
1538 $notice->selectAdd('id');
1540 $notice->repeat_of = $this->id;
1542 $notice->orderBy('created'); // NB: asc!
1544 if (!is_null($offset)) {
1545 $notice->limit($offset, $limit);
1550 if ($notice->find()) {
1551 while ($notice->fetch()) {
1552 $ids[] = $notice->id;
1562 function locationOptions($lat, $lon, $location_id, $location_ns, $profile = null)
1566 if (!empty($location_id) && !empty($location_ns)) {
1568 $options['location_id'] = $location_id;
1569 $options['location_ns'] = $location_ns;
1571 $location = Location::fromId($location_id, $location_ns);
1573 if (!empty($location)) {
1574 $options['lat'] = $location->lat;
1575 $options['lon'] = $location->lon;
1578 } else if (!empty($lat) && !empty($lon)) {
1580 $options['lat'] = $lat;
1581 $options['lon'] = $lon;
1583 $location = Location::fromLatLon($lat, $lon);
1585 if (!empty($location)) {
1586 $options['location_id'] = $location->location_id;
1587 $options['location_ns'] = $location->location_ns;
1589 } else if (!empty($profile)) {
1591 if (isset($profile->lat) && isset($profile->lon)) {
1592 $options['lat'] = $profile->lat;
1593 $options['lon'] = $profile->lon;
1596 if (isset($profile->location_id) && isset($profile->location_ns)) {
1597 $options['location_id'] = $profile->location_id;
1598 $options['location_ns'] = $profile->location_ns;
1605 function clearReplies()
1607 $replyNotice = new Notice();
1608 $replyNotice->reply_to = $this->id;
1610 //Null any notices that are replies to this notice
1612 if ($replyNotice->find()) {
1613 while ($replyNotice->fetch()) {
1614 $orig = clone($replyNotice);
1615 $replyNotice->reply_to = null;
1616 $replyNotice->update($orig);
1622 $reply = new Reply();
1623 $reply->notice_id = $this->id;
1625 if ($reply->find()) {
1626 while($reply->fetch()) {
1627 self::blow('reply:stream:%d', $reply->profile_id);
1635 function clearRepeats()
1637 $repeatNotice = new Notice();
1638 $repeatNotice->repeat_of = $this->id;
1640 //Null any notices that are repeats of this notice
1642 if ($repeatNotice->find()) {
1643 while ($repeatNotice->fetch()) {
1644 $orig = clone($repeatNotice);
1645 $repeatNotice->repeat_of = null;
1646 $repeatNotice->update($orig);
1651 function clearFaves()
1654 $fave->notice_id = $this->id;
1656 if ($fave->find()) {
1657 while ($fave->fetch()) {
1658 self::blow('fave:ids_by_user_own:%d', $fave->user_id);
1659 self::blow('fave:ids_by_user_own:%d;last', $fave->user_id);
1660 self::blow('fave:ids_by_user:%d', $fave->user_id);
1661 self::blow('fave:ids_by_user:%d;last', $fave->user_id);
1669 function clearTags()
1671 $tag = new Notice_tag();
1672 $tag->notice_id = $this->id;
1675 while ($tag->fetch()) {
1676 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, common_keyize($tag->tag));
1677 self::blow('profile:notice_ids_tagged:%d:%s;last', $this->profile_id, common_keyize($tag->tag));
1678 self::blow('notice_tag:notice_ids:%s', common_keyize($tag->tag));
1679 self::blow('notice_tag:notice_ids:%s;last', common_keyize($tag->tag));
1687 function clearGroupInboxes()
1689 $gi = new Group_inbox();
1691 $gi->notice_id = $this->id;
1694 while ($gi->fetch()) {
1695 self::blow('user_group:notice_ids:%d', $gi->group_id);
1703 function distribute()
1705 // We always insert for the author so they don't
1708 $user = User::staticGet('id', $this->profile_id);
1709 if (!empty($user)) {
1710 Inbox::insertNotice($user->id, $this->id);
1713 if (common_config('queue', 'inboxes')) {
1714 // If there's a failure, we want to _force_
1715 // distribution at this point.
1717 $qm = QueueManager::get();
1718 $qm->enqueue($this, 'distrib');
1719 } catch (Exception $e) {
1720 // If the exception isn't transient, this
1721 // may throw more exceptions as DQH does
1722 // its own enqueueing. So, we ignore them!
1724 $handler = new DistribQueueHandler();
1725 $handler->handle($this);
1726 } catch (Exception $e) {
1727 common_log(LOG_ERR, "emergency redistribution resulted in " . $e->getMessage());
1729 // Re-throw so somebody smarter can handle it.
1733 $handler = new DistribQueueHandler();
1734 $handler->handle($this);
1740 $result = parent::insert();
1743 // Profile::hasRepeated() abuses pkeyGet(), so we
1744 // have to clear manually
1745 if (!empty($this->repeat_of)) {
1746 $c = self::memcache();
1748 $ck = self::multicacheKey('Notice',
1749 array('profile_id' => $this->profile_id,
1750 'repeat_of' => $this->repeat_of));