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', 200);
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)
77 function staticGet($k,$v=NULL)
79 return Memcached_DataObject::staticGet('Notice',$k,$v);
82 /* the code above is auto generated do not remove the tag below */
86 const LOCAL_PUBLIC = 1;
88 const LOCAL_NONPUBLIC = -1;
93 $profile = Profile::staticGet('id', $this->profile_id);
95 if (empty($profile)) {
96 // TRANS: Server exception thrown when a user profile for a notice cannot be found.
97 // TRANS: %1$d is a profile ID (number), %2$d is a notice ID (number).
98 throw new ServerException(sprintf(_('No such profile (%1$d) for notice (%2$d).'), $this->profile_id, $this->id));
106 // For auditing purposes, save a record that the notice
109 // @fixme we have some cases where things get re-run and so the
111 $deleted = Deleted_notice::staticGet('id', $this->id);
114 $deleted = Deleted_notice::staticGet('uri', $this->uri);
118 $deleted = new Deleted_notice();
120 $deleted->id = $this->id;
121 $deleted->profile_id = $this->profile_id;
122 $deleted->uri = $this->uri;
123 $deleted->created = $this->created;
124 $deleted->deleted = common_sql_now();
129 if (Event::handle('NoticeDeleteRelated', array($this))) {
131 // Clear related records
133 $this->clearReplies();
134 $this->clearRepeats();
137 $this->clearGroupInboxes();
140 // NOTE: we don't clear inboxes
141 // NOTE: we don't clear queue items
144 $result = parent::delete();
146 $this->blowOnDelete();
151 * Extract #hashtags from this notice's content and save them to the database.
155 /* extract all #hastags */
156 $count = preg_match_all('/(?:^|\s)#([\pL\pN_\-\.]{1,64})/', strtolower($this->content), $match);
161 /* Add them to the database */
162 return $this->saveKnownTags($match[1]);
166 * Record the given set of hash tags in the db for this notice.
167 * Given tag strings will be normalized and checked for dupes.
169 function saveKnownTags($hashtags)
171 //turn each into their canonical tag
172 //this is needed to remove dupes before saving e.g. #hash.tag = #hashtag
173 for($i=0; $i<count($hashtags); $i++) {
174 /* elide characters we don't want in the tag */
175 $hashtags[$i] = common_canonical_tag($hashtags[$i]);
178 foreach(array_unique($hashtags) as $hashtag) {
179 $this->saveTag($hashtag);
180 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, $hashtag);
186 * Record a single hash tag as associated with this notice.
187 * Tag format and uniqueness must be validated by caller.
189 function saveTag($hashtag)
191 $tag = new Notice_tag();
192 $tag->notice_id = $this->id;
193 $tag->tag = $hashtag;
194 $tag->created = $this->created;
195 $id = $tag->insert();
198 // TRANS: Server exception. %s are the error details.
199 throw new ServerException(sprintf(_('Database error inserting hashtag: %s'),
200 $last_error->message));
204 // if it's saved, blow its cache
205 $tag->blowCache(false);
209 * Save a new notice and push it out to subscribers' inboxes.
210 * Poster's permissions are checked before sending.
212 * @param int $profile_id Profile ID of the poster
213 * @param string $content source message text; links may be shortened
214 * per current user's preference
215 * @param string $source source key ('web', 'api', etc)
216 * @param array $options Associative array of optional properties:
217 * string 'created' timestamp of notice; defaults to now
218 * int 'is_local' source/gateway ID, one of:
219 * Notice::LOCAL_PUBLIC - Local, ok to appear in public timeline
220 * Notice::REMOTE_OMB - Sent from a remote OMB service;
221 * hide from public timeline but show in
222 * local "and friends" timelines
223 * Notice::LOCAL_NONPUBLIC - Local, but hide from public timeline
224 * Notice::GATEWAY - From another non-OMB service;
225 * will not appear in public views
226 * float 'lat' decimal latitude for geolocation
227 * float 'lon' decimal longitude for geolocation
228 * int 'location_id' geoname identifier
229 * int 'location_ns' geoname namespace to interpret location_id
230 * int 'reply_to'; notice ID this is a reply to
231 * int 'repeat_of'; notice ID this is a repeat of
232 * string 'uri' unique ID for notice; defaults to local notice URL
233 * string 'url' permalink to notice; defaults to local notice URL
234 * string 'rendered' rendered HTML version of content
235 * array 'replies' list of profile URIs for reply delivery in
236 * place of extracting @-replies from content.
237 * array 'groups' list of group IDs to deliver to, in place of
238 * extracting ! tags from content
239 * array 'tags' list of hashtag strings to save with the notice
240 * in place of extracting # tags from content
241 * array 'urls' list of attached/referred URLs to save with the
242 * notice in place of extracting links from content
243 * boolean 'distribute' whether to distribute the notice, default true
245 * @fixme tag override
248 * @throws ClientException
250 static function saveNew($profile_id, $content, $source, $options=null) {
251 $defaults = array('uri' => null,
255 'distribute' => true);
257 if (!empty($options)) {
258 $options = $options + $defaults;
264 if (!isset($is_local)) {
265 $is_local = Notice::LOCAL_PUBLIC;
268 $profile = Profile::staticGet('id', $profile_id);
269 $user = User::staticGet('id', $profile_id);
271 // Use the local user's shortening preferences, if applicable.
272 $final = $user->shortenLinks($content);
274 $final = common_shorten_links($content);
277 if (Notice::contentTooLong($final)) {
278 // TRANS: Client exception thrown if a notice contains too many characters.
279 throw new ClientException(_('Problem saving notice. Too long.'));
282 if (empty($profile)) {
283 // TRANS: Client exception thrown when trying to save a notice for an unknown user.
284 throw new ClientException(_('Problem saving notice. Unknown user.'));
287 if (common_config('throttle', 'enabled') && !Notice::checkEditThrottle($profile_id)) {
288 common_log(LOG_WARNING, 'Excessive posting by profile #' . $profile_id . '; throttled.');
289 // TRANS: Client exception thrown when a user tries to post too many notices in a given time frame.
290 throw new ClientException(_('Too many notices too fast; take a breather '.
291 'and post again in a few minutes.'));
294 if (common_config('site', 'dupelimit') > 0 && !Notice::checkDupes($profile_id, $final)) {
295 common_log(LOG_WARNING, 'Dupe posting by profile #' . $profile_id . '; throttled.');
296 // TRANS: Client exception thrown when a user tries to post too many duplicate notices in a given time frame.
297 throw new ClientException(_('Too many duplicate messages too quickly;'.
298 ' take a breather and post again in a few minutes.'));
301 if (!$profile->hasRight(Right::NEWNOTICE)) {
302 common_log(LOG_WARNING, "Attempted post from user disallowed to post: " . $profile->nickname);
304 // TRANS: Client exception thrown when a user tries to post while being banned.
305 throw new ClientException(_('You are banned from posting notices on this site.'), 403);
308 $notice = new Notice();
309 $notice->profile_id = $profile_id;
311 $autosource = common_config('public', 'autosource');
313 # Sandboxed are non-false, but not 1, either
315 if (!$profile->hasRight(Right::PUBLICNOTICE) ||
316 ($source && $autosource && in_array($source, $autosource))) {
317 $notice->is_local = Notice::LOCAL_NONPUBLIC;
319 $notice->is_local = $is_local;
322 if (!empty($created)) {
323 $notice->created = $created;
325 $notice->created = common_sql_now();
328 $notice->content = $final;
330 $notice->source = $source;
334 // Handle repeat case
336 if (isset($repeat_of)) {
337 $notice->repeat_of = $repeat_of;
339 $notice->reply_to = self::getReplyTo($reply_to, $profile_id, $source, $final);
342 if (!empty($notice->reply_to)) {
343 $reply = Notice::staticGet('id', $notice->reply_to);
344 $notice->conversation = $reply->conversation;
347 if (!empty($lat) && !empty($lon)) {
352 if (!empty($location_ns) && !empty($location_id)) {
353 $notice->location_id = $location_id;
354 $notice->location_ns = $location_ns;
357 if (!empty($rendered)) {
358 $notice->rendered = $rendered;
360 $notice->rendered = common_render_content($final, $notice);
363 if (Event::handle('StartNoticeSave', array(&$notice))) {
365 // XXX: some of these functions write to the DB
367 $id = $notice->insert();
370 common_log_db_error($notice, 'INSERT', __FILE__);
371 // TRANS: Server exception thrown when a notice cannot be saved.
372 throw new ServerException(_('Problem saving notice.'));
375 // Update ID-dependent columns: URI, conversation
377 $orig = clone($notice);
382 $notice->uri = common_notice_uri($notice);
386 // If it's not part of a conversation, it's
387 // the beginning of a new conversation.
389 if (empty($notice->conversation)) {
390 $conv = Conversation::create();
391 $notice->conversation = $conv->id;
396 if (!$notice->update($orig)) {
397 common_log_db_error($notice, 'UPDATE', __FILE__);
398 // TRANS: Server exception thrown when a notice cannot be updated.
399 throw new ServerException(_('Problem saving notice.'));
405 # Clear the cache for subscribed users, so they'll update at next request
406 # XXX: someone clever could prepend instead of clearing the cache
408 $notice->blowOnInsert();
410 // Save per-notice metadata...
412 if (isset($replies)) {
413 $notice->saveKnownReplies($replies);
415 $notice->saveReplies();
419 $notice->saveKnownTags($tags);
424 // Note: groups may save tags, so must be run after tags are saved
425 // to avoid errors on duplicates.
426 if (isset($groups)) {
427 $notice->saveKnownGroups($groups);
429 $notice->saveGroups();
433 $notice->saveKnownUrls($urls);
439 // Prepare inbox delivery, may be queued to background.
440 $notice->distribute();
446 function blowOnInsert($conversation = false)
448 self::blow('profile:notice_ids:%d', $this->profile_id);
449 self::blow('public');
451 // XXX: Before we were blowing the casche only if the notice id
452 // was not the root of the conversation. What to do now?
454 self::blow('notice:conversation_ids:%d', $this->conversation);
456 if (!empty($this->repeat_of)) {
457 self::blow('notice:repeats:%d', $this->repeat_of);
460 $original = Notice::staticGet('id', $this->repeat_of);
462 if (!empty($original)) {
463 $originalUser = User::staticGet('id', $original->profile_id);
464 if (!empty($originalUser)) {
465 self::blow('user:repeats_of_me:%d', $originalUser->id);
469 $profile = Profile::staticGet($this->profile_id);
470 if (!empty($profile)) {
471 $profile->blowNoticeCount();
476 * Clear cache entries related to this notice at delete time.
477 * Necessary to avoid breaking paging on public, profile timelines.
479 function blowOnDelete()
481 $this->blowOnInsert();
483 self::blow('profile:notice_ids:%d;last', $this->profile_id);
484 self::blow('public;last');
487 /** save all urls in the notice to the db
489 * follow redirects and save all available file information
490 * (mimetype, date, size, oembed, etc.)
494 function saveUrls() {
495 if (common_config('attachments', 'process_links')) {
496 common_replace_urls_callback($this->content, array($this, 'saveUrl'), $this->id);
501 * Save the given URLs as related links/attachments to the db
503 * follow redirects and save all available file information
504 * (mimetype, date, size, oembed, etc.)
508 function saveKnownUrls($urls)
510 if (common_config('attachments', 'process_links')) {
511 // @fixme validation?
512 foreach (array_unique($urls) as $url) {
513 File::processNew($url, $this->id);
521 function saveUrl($url, $notice_id) {
522 File::processNew($url, $notice_id);
525 static function checkDupes($profile_id, $content) {
526 $profile = Profile::staticGet($profile_id);
527 if (empty($profile)) {
530 $notice = $profile->getNotices(0, NOTICE_CACHE_WINDOW);
531 if (!empty($notice)) {
533 while ($notice->fetch()) {
534 if (time() - strtotime($notice->created) >= common_config('site', 'dupelimit')) {
536 } else if ($notice->content == $content) {
541 # If we get here, oldest item in cache window is not
542 # old enough for dupe limit; do direct check against DB
543 $notice = new Notice();
544 $notice->profile_id = $profile_id;
545 $notice->content = $content;
546 $threshold = common_sql_date(time() - common_config('site', 'dupelimit'));
547 $notice->whereAdd(sprintf("created > '%s'", $notice->escape($threshold)));
549 $cnt = $notice->count();
553 static function checkEditThrottle($profile_id) {
554 $profile = Profile::staticGet($profile_id);
555 if (empty($profile)) {
559 $notice = $profile->getNotices(common_config('throttle', 'count') - 1, 1);
560 if ($notice && $notice->fetch()) {
561 # If the Nth notice was posted less than timespan seconds ago
562 if (time() - strtotime($notice->created) <= common_config('throttle', 'timespan')) {
567 # Either not N notices in the stream, OR the Nth was not posted within timespan seconds
571 function getUploadedAttachment() {
573 $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"';
574 $post->query($query);
576 if (empty($post->up) || empty($post->i)) {
579 $ret = array($post->up, $post->i);
585 function hasAttachments() {
587 $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);
588 $post->query($query);
590 $n_attachments = intval($post->n_attachments);
592 return $n_attachments;
595 function attachments() {
598 $f2p = new File_to_post;
599 $f2p->post_id = $this->id;
601 while ($f2p->fetch()) {
602 $f = File::staticGet($f2p->file_id);
611 function getStreamByIds($ids)
613 $cache = common_memcache();
615 if (!empty($cache)) {
617 foreach ($ids as $id) {
618 $n = Notice::staticGet('id', $id);
623 return new ArrayWrapper($notices);
625 $notice = new Notice();
627 //if no IDs requested, just return the notice object
630 $notice->whereAdd('id in (' . implode(', ', $ids) . ')');
636 while ($notice->fetch()) {
637 $temp[$notice->id] = clone($notice);
642 foreach ($ids as $id) {
643 if (array_key_exists($id, $temp)) {
644 $wrapped[] = $temp[$id];
648 return new ArrayWrapper($wrapped);
652 function publicStream($offset=0, $limit=20, $since_id=0, $max_id=0)
654 $ids = Notice::stream(array('Notice', '_publicStreamDirect'),
657 $offset, $limit, $since_id, $max_id);
658 return Notice::getStreamByIds($ids);
661 function _publicStreamDirect($offset=0, $limit=20, $since_id=0, $max_id=0)
663 $notice = new Notice();
665 $notice->selectAdd(); // clears it
666 $notice->selectAdd('id');
668 $notice->orderBy('created DESC, id DESC');
670 if (!is_null($offset)) {
671 $notice->limit($offset, $limit);
674 if (common_config('public', 'localonly')) {
675 $notice->whereAdd('is_local = ' . Notice::LOCAL_PUBLIC);
677 # -1 == blacklisted, -2 == gateway (i.e. Twitter)
678 $notice->whereAdd('is_local !='. Notice::LOCAL_NONPUBLIC);
679 $notice->whereAdd('is_local !='. Notice::GATEWAY);
682 Notice::addWhereSinceId($notice, $since_id);
683 Notice::addWhereMaxId($notice, $max_id);
687 if ($notice->find()) {
688 while ($notice->fetch()) {
689 $ids[] = $notice->id;
699 function conversationStream($id, $offset=0, $limit=20, $since_id=0, $max_id=0)
701 $ids = Notice::stream(array('Notice', '_conversationStreamDirect'),
703 'notice:conversation_ids:'.$id,
704 $offset, $limit, $since_id, $max_id);
706 return Notice::getStreamByIds($ids);
709 function _conversationStreamDirect($id, $offset=0, $limit=20, $since_id=0, $max_id=0)
711 $notice = new Notice();
713 $notice->selectAdd(); // clears it
714 $notice->selectAdd('id');
716 $notice->conversation = $id;
718 $notice->orderBy('created DESC, id DESC');
720 if (!is_null($offset)) {
721 $notice->limit($offset, $limit);
724 Notice::addWhereSinceId($notice, $since_id);
725 Notice::addWhereMaxId($notice, $max_id);
729 if ($notice->find()) {
730 while ($notice->fetch()) {
731 $ids[] = $notice->id;
742 * Is this notice part of an active conversation?
744 * @return boolean true if other messages exist in the same
745 * conversation, false if this is the only one
747 function hasConversation()
749 if (!empty($this->conversation)) {
750 $conversation = Notice::conversationStream(
756 if ($conversation->N > 0) {
764 * Pull up a full list of local recipients who will be getting
765 * this notice in their inbox. Results will be cached, so don't
766 * change the input data wily-nilly!
768 * @param array $groups optional list of Group objects;
769 * if left empty, will be loaded from group_inbox records
770 * @param array $recipient optional list of reply profile ids
771 * if left empty, will be loaded from reply records
772 * @return array associating recipient user IDs with an inbox source constant
774 function whoGets($groups=null, $recipients=null)
776 $c = self::memcache();
779 $ni = $c->get(common_cache_key('notice:who_gets:'.$this->id));
785 if (is_null($groups)) {
786 $groups = $this->getGroups();
789 if (is_null($recipients)) {
790 $recipients = $this->getReplies();
793 $users = $this->getSubscribedUsers();
795 // FIXME: kind of ignoring 'transitional'...
796 // we'll probably stop supporting inboxless mode
801 foreach ($users as $id) {
802 $ni[$id] = NOTICE_INBOX_SOURCE_SUB;
805 foreach ($groups as $group) {
806 $users = $group->getUserMembers();
807 foreach ($users as $id) {
808 if (!array_key_exists($id, $ni)) {
809 $ni[$id] = NOTICE_INBOX_SOURCE_GROUP;
814 foreach ($recipients as $recipient) {
815 if (!array_key_exists($recipient, $ni)) {
816 $ni[$recipient] = NOTICE_INBOX_SOURCE_REPLY;
820 // Exclude any deleted, non-local, or blocking recipients.
821 $profile = $this->getProfile();
822 foreach ($ni as $id => $source) {
823 $user = User::staticGet('id', $id);
824 if (empty($user) || $user->hasBlocked($profile)) {
830 // XXX: pack this data better
831 $c->set(common_cache_key('notice:who_gets:'.$this->id), $ni);
838 * Adds this notice to the inboxes of each local user who should receive
839 * it, based on author subscriptions, group memberships, and @-replies.
841 * Warning: running a second time currently will make items appear
842 * multiple times in users' inboxes.
844 * @fixme make more robust against errors
845 * @fixme break up massive deliveries to smaller background tasks
847 * @param array $groups optional list of Group objects;
848 * if left empty, will be loaded from group_inbox records
849 * @param array $recipient optional list of reply profile ids
850 * if left empty, will be loaded from reply records
852 function addToInboxes($groups=null, $recipients=null)
854 $ni = $this->whoGets($groups, $recipients);
856 $ids = array_keys($ni);
858 // We remove the author (if they're a local user),
859 // since we'll have already done this in distribute()
861 $i = array_search($this->profile_id, $ids);
869 Inbox::bulkInsert($this->id, $ids);
874 function getSubscribedUsers()
878 if(common_config('db','quote_identifiers'))
879 $user_table = '"user"';
880 else $user_table = 'user';
884 'FROM '. $user_table .' JOIN subscription '.
885 'ON '. $user_table .'.id = subscription.subscriber ' .
886 'WHERE subscription.subscribed = %d ';
888 $user->query(sprintf($qry, $this->profile_id));
892 while ($user->fetch()) {
902 * Record this notice to the given group inboxes for delivery.
903 * Overrides the regular parsing of !group markup.
905 * @param string $group_ids
906 * @fixme might prefer URIs as identifiers, as for replies?
907 * best with generalizations on user_group to support
908 * remote groups better.
910 function saveKnownGroups($group_ids)
912 if (!is_array($group_ids)) {
913 // TRANS: Server exception thrown when no array is provided to the method saveKnownGroups().
914 throw new ServerException(_('Bad type provided to saveKnownGroups.'));
918 foreach (array_unique($group_ids) as $id) {
919 $group = User_group::staticGet('id', $id);
921 common_log(LOG_ERR, "Local delivery to group id $id, $group->nickname");
922 $result = $this->addToGroupInbox($group);
924 common_log_db_error($gi, 'INSERT', __FILE__);
927 // @fixme should we save the tags here or not?
928 $groups[] = clone($group);
930 common_log(LOG_ERR, "Local delivery to group id $id skipped, doesn't exist");
938 * Parse !group delivery and record targets into group_inbox.
939 * @return array of Group objects
941 function saveGroups()
943 // Don't save groups for repeats
945 if (!empty($this->repeat_of)) {
951 /* extract all !group */
952 $count = preg_match_all('/(?:^|\s)!([A-Za-z0-9]{1,64})/',
953 strtolower($this->content),
959 $profile = $this->getProfile();
961 /* Add them to the database */
963 foreach (array_unique($match[1]) as $nickname) {
964 /* XXX: remote groups. */
965 $group = User_group::getForNickname($nickname, $profile);
971 // we automatically add a tag for every group name, too
973 $tag = Notice_tag::pkeyGet(array('tag' => common_canonical_tag($nickname),
974 'notice_id' => $this->id));
977 $this->saveTag($nickname);
980 if ($profile->isMember($group)) {
982 $result = $this->addToGroupInbox($group);
985 common_log_db_error($gi, 'INSERT', __FILE__);
988 $groups[] = clone($group);
995 function addToGroupInbox($group)
997 $gi = Group_inbox::pkeyGet(array('group_id' => $group->id,
998 'notice_id' => $this->id));
1002 $gi = new Group_inbox();
1004 $gi->group_id = $group->id;
1005 $gi->notice_id = $this->id;
1006 $gi->created = $this->created;
1008 $result = $gi->insert();
1011 common_log_db_error($gi, 'INSERT', __FILE__);
1012 // TRANS: Server exception thrown when an update for a group inbox fails.
1013 throw new ServerException(_('Problem saving group inbox.'));
1016 self::blow('user_group:notice_ids:%d', $gi->group_id);
1023 * Save reply records indicating that this notice needs to be
1024 * delivered to the local users with the given URIs.
1026 * Since this is expected to be used when saving foreign-sourced
1027 * messages, we won't deliver to any remote targets as that's the
1028 * source service's responsibility.
1030 * Mail notifications etc will be handled later.
1032 * @param array of unique identifier URIs for recipients
1034 function saveKnownReplies($uris)
1040 $sender = Profile::staticGet($this->profile_id);
1042 foreach (array_unique($uris) as $uri) {
1044 $profile = Profile::fromURI($uri);
1046 if (empty($profile)) {
1047 common_log(LOG_WARNING, "Unable to determine profile for URI '$uri'");
1051 if ($profile->hasBlocked($sender)) {
1052 common_log(LOG_INFO, "Not saving reply to profile {$profile->id} ($uri) from sender {$sender->id} because of a block.");
1056 $reply = new Reply();
1058 $reply->notice_id = $this->id;
1059 $reply->profile_id = $profile->id;
1061 common_log(LOG_INFO, __METHOD__ . ": saving reply: notice $this->id to profile $profile->id");
1063 $id = $reply->insert();
1070 * Pull @-replies from this message's content in StatusNet markup format
1071 * and save reply records indicating that this message needs to be
1072 * delivered to those users.
1074 * Mail notifications to local profiles will be sent later.
1076 * @return array of integer profile IDs
1079 function saveReplies()
1081 // Don't save reply data for repeats
1083 if (!empty($this->repeat_of)) {
1087 $sender = Profile::staticGet($this->profile_id);
1089 // @todo ideally this parser information would only
1090 // be calculated once.
1092 $mentions = common_find_mentions($this->content, $this);
1096 // store replied only for first @ (what user/notice what the reply directed,
1097 // we assume first @ is it)
1099 foreach ($mentions as $mention) {
1101 foreach ($mention['mentioned'] as $mentioned) {
1103 // skip if they're already covered
1105 if (!empty($replied[$mentioned->id])) {
1109 // Don't save replies from blocked profile to local user
1111 $mentioned_user = User::staticGet('id', $mentioned->id);
1112 if (!empty($mentioned_user) && $mentioned_user->hasBlocked($sender)) {
1116 $reply = new Reply();
1118 $reply->notice_id = $this->id;
1119 $reply->profile_id = $mentioned->id;
1121 $id = $reply->insert();
1124 common_log_db_error($reply, 'INSERT', __FILE__);
1125 // TRANS: Server exception thrown when a reply cannot be saved.
1126 // TRANS: %1$d is a notice ID, %2$d is the ID of the mentioned user.
1127 throw new ServerException(sprintf(_('Could not save reply for %1$d, %2$d.'), $this->id, $mentioned->id));
1129 $replied[$mentioned->id] = 1;
1130 self::blow('reply:stream:%d', $mentioned->id);
1135 $recipientIds = array_keys($replied);
1137 return $recipientIds;
1141 * Pull the complete list of @-reply targets for this notice.
1143 * @return array of integer profile ids
1145 function getReplies()
1151 $reply = new Reply();
1152 $reply->selectAdd();
1153 $reply->selectAdd('profile_id');
1154 $reply->notice_id = $this->id;
1156 if ($reply->find()) {
1157 while($reply->fetch()) {
1158 $ids[] = $reply->profile_id;
1168 * Send e-mail notifications to local @-reply targets.
1170 * Replies must already have been saved; this is expected to be run
1171 * from the distrib queue handler.
1173 function sendReplyNotifications()
1175 // Don't send reply notifications for repeats
1177 if (!empty($this->repeat_of)) {
1181 $recipientIds = $this->getReplies();
1183 foreach ($recipientIds as $recipientId) {
1184 $user = User::staticGet('id', $recipientId);
1185 if (!empty($user)) {
1186 mail_notify_attn($user, $this);
1192 * Pull list of groups this notice needs to be delivered to,
1193 * as previously recorded by saveGroups() or saveKnownGroups().
1195 * @return array of Group objects
1197 function getGroups()
1199 // Don't save groups for repeats
1201 if (!empty($this->repeat_of)) {
1209 $gi = new Group_inbox();
1212 $gi->selectAdd('group_id');
1214 $gi->notice_id = $this->id;
1217 while ($gi->fetch()) {
1218 $group = User_group::staticGet('id', $gi->group_id);
1231 * Convert a notice into an activity for export.
1233 * @param User $cur Current user
1235 * @return Activity activity object representing this Notice.
1238 function asActivity()
1240 $act = self::cacheGet(Cache::codeKey('notice:as-activity:'.$this->id));
1246 $act = new Activity();
1248 if (Event::handle('StartNoticeAsActivity', array($this, &$act))) {
1250 $profile = $this->getProfile();
1252 $act->actor = ActivityObject::fromProfile($profile);
1253 $act->verb = ActivityVerb::POST;
1254 $act->objects[] = ActivityObject::fromNotice($this);
1256 // XXX: should this be handled by default processing for object entry?
1258 $act->time = strtotime($this->created);
1259 $act->link = $this->bestUrl();
1261 $act->content = common_xml_safe_str($this->rendered);
1262 $act->id = $this->uri;
1263 $act->title = common_xml_safe_str($this->content);
1267 $tags = $this->getTags();
1269 foreach ($tags as $tag) {
1270 $cat = new AtomCategory();
1273 $act->categories[] = $cat;
1277 // XXX: use Atom Media and/or File activity objects instead
1279 $attachments = $this->attachments();
1281 foreach ($attachments as $attachment) {
1282 $enclosure = $attachment->getEnclosure();
1284 $act->enclosures[] = $enclosure;
1288 $ctx = new ActivityContext();
1290 if (!empty($this->reply_to)) {
1291 $reply = Notice::staticGet('id', $this->reply_to);
1292 if (!empty($reply)) {
1293 $ctx->replyToID = $reply->uri;
1294 $ctx->replyToUrl = $reply->bestUrl();
1298 $ctx->location = $this->getLocation();
1302 if (!empty($this->conversation)) {
1303 $conv = Conversation::staticGet('id', $this->conversation);
1304 if (!empty($conv)) {
1305 $ctx->conversation = $conv->uri;
1309 $reply_ids = $this->getReplies();
1311 foreach ($reply_ids as $id) {
1312 $profile = Profile::staticGet('id', $id);
1313 if (!empty($profile)) {
1314 $ctx->attention[] = $profile->getUri();
1318 $groups = $this->getGroups();
1320 foreach ($groups as $group) {
1321 $ctx->attention[] = $group->uri;
1324 // XXX: deprecated; use ActivityVerb::SHARE instead
1328 if (!empty($this->repeat_of)) {
1329 $repeat = Notice::staticGet('id', $this->repeat_of);
1330 $ctx->forwardID = $repeat->uri;
1331 $ctx->forwardUrl = $repeat->bestUrl();
1334 $act->context = $ctx;
1338 $atom_feed = $profile->getAtomFeed();
1340 if (!empty($atom_feed)) {
1342 $act->source = new ActivitySource();
1344 // XXX: we should store the actual feed ID
1346 $act->source->id = $atom_feed;
1348 // XXX: we should store the actual feed title
1350 $act->source->title = $profile->getBestName();
1352 $act->source->links['alternate'] = $profile->profileurl;
1353 $act->source->links['self'] = $atom_feed;
1355 $act->source->icon = $profile->avatarUrl(AVATAR_PROFILE_SIZE);
1357 $notice = $profile->getCurrentNotice();
1359 if (!empty($notice)) {
1360 $act->source->updated = self::utcDate($notice->created);
1363 $user = User::staticGet('id', $profile->id);
1365 if (!empty($user)) {
1366 $act->source->links['license'] = common_config('license', 'url');
1370 if ($this->isLocal()) {
1371 $act->selfLink = common_local_url('ApiStatusesShow', array('id' => $this->id,
1372 'format' => 'atom'));
1373 $act->editLink = $act->selfLink;
1376 Event::handle('EndNoticeAsActivity', array($this, &$act));
1379 self::cacheSet(Cache::codeKey('notice:as-activity:'.$this->id), $act);
1384 // This has gotten way too long. Needs to be sliced up into functional bits
1385 // or ideally exported to a utility class.
1387 function asAtomEntry($namespace=false,
1392 $act = $this->asActivity();
1393 $act->extra[] = $this->noticeInfo($cur);
1394 return $act->asString($namespace, $author, $source);
1398 * Extra notice info for atom entries
1400 * Clients use some extra notice info in the atom stream.
1401 * This gives it to them.
1403 * @param User $cur Current user
1405 * @return array representation of <statusnet:notice_info> element
1408 function noticeInfo($cur)
1410 // local notice ID (useful to clients for ordering)
1412 $noticeInfoAttr = array('local_id' => $this->id);
1416 $ns = $this->getSource();
1419 $noticeInfoAttr['source'] = $ns->code;
1420 if (!empty($ns->url)) {
1421 $noticeInfoAttr['source_link'] = $ns->url;
1422 if (!empty($ns->name)) {
1423 $noticeInfoAttr['source'] = '<a href="'
1424 . htmlspecialchars($ns->url)
1425 . '" rel="nofollow">'
1426 . htmlspecialchars($ns->name)
1432 // favorite and repeated
1435 $noticeInfoAttr['favorite'] = ($cur->hasFave($this)) ? "true" : "false";
1436 $cp = $cur->getProfile();
1437 $noticeInfoAttr['repeated'] = ($cp->hasRepeated($this->id)) ? "true" : "false";
1440 if (!empty($this->repeat_of)) {
1441 $noticeInfoAttr['repeat_of'] = $this->repeat_of;
1444 return array('statusnet:notice_info', $noticeInfoAttr, null);
1448 * Returns an XML string fragment with a reference to a notice as an
1449 * Activity Streams noun object with the given element type.
1451 * Assumes that 'activity' namespace has been previously defined.
1453 * @param string $element one of 'subject', 'object', 'target'
1457 function asActivityNoun($element)
1459 $noun = ActivityObject::fromNotice($this);
1460 return $noun->asString('activity:' . $element);
1465 if (!empty($this->url)) {
1467 } else if (!empty($this->uri) && preg_match('/^https?:/', $this->uri)) {
1470 return common_local_url('shownotice',
1471 array('notice' => $this->id));
1475 function stream($fn, $args, $cachekey, $offset=0, $limit=20, $since_id=0, $max_id=0)
1477 $cache = common_memcache();
1479 if (empty($cache) ||
1480 $since_id != 0 || $max_id != 0 ||
1482 ($offset + $limit) > NOTICE_CACHE_WINDOW) {
1483 return call_user_func_array($fn, array_merge($args, array($offset, $limit, $since_id,
1487 $idkey = common_cache_key($cachekey);
1489 $idstr = $cache->get($idkey);
1491 if ($idstr !== false) {
1492 // Cache hit! Woohoo!
1493 $window = explode(',', $idstr);
1494 $ids = array_slice($window, $offset, $limit);
1498 $laststr = $cache->get($idkey.';last');
1500 if ($laststr !== false) {
1501 $window = explode(',', $laststr);
1502 $last_id = $window[0];
1503 $new_ids = call_user_func_array($fn, array_merge($args, array(0, NOTICE_CACHE_WINDOW,
1504 $last_id, 0, null)));
1506 $new_window = array_merge($new_ids, $window);
1508 $new_windowstr = implode(',', $new_window);
1510 $result = $cache->set($idkey, $new_windowstr);
1511 $result = $cache->set($idkey . ';last', $new_windowstr);
1513 $ids = array_slice($new_window, $offset, $limit);
1518 $window = call_user_func_array($fn, array_merge($args, array(0, NOTICE_CACHE_WINDOW,
1521 $windowstr = implode(',', $window);
1523 $result = $cache->set($idkey, $windowstr);
1524 $result = $cache->set($idkey . ';last', $windowstr);
1526 $ids = array_slice($window, $offset, $limit);
1532 * Determine which notice, if any, a new notice is in reply to.
1534 * For conversation tracking, we try to see where this notice fits
1535 * in the tree. Rough algorithm is:
1537 * if (reply_to is set and valid) {
1539 * } else if ((source not API or Web) and (content starts with "T NAME" or "@name ")) {
1540 * return ID of last notice by initial @name in content;
1543 * Note that all @nickname instances will still be used to save "reply" records,
1544 * so the notice shows up in the mentioned users' "replies" tab.
1546 * @param integer $reply_to ID passed in by Web or API
1547 * @param integer $profile_id ID of author
1548 * @param string $source Source tag, like 'web' or 'gwibber'
1549 * @param string $content Final notice content
1551 * @return integer ID of replied-to notice, or null for not a reply.
1554 static function getReplyTo($reply_to, $profile_id, $source, $content)
1556 static $lb = array('xmpp', 'mail', 'sms', 'omb');
1558 // If $reply_to is specified, we check that it exists, and then
1559 // return it if it does
1561 if (!empty($reply_to)) {
1562 $reply_notice = Notice::staticGet('id', $reply_to);
1563 if (!empty($reply_notice)) {
1568 // If it's not a "low bandwidth" source (one where you can't set
1569 // a reply_to argument), we return. This is mostly web and API
1572 if (!in_array($source, $lb)) {
1576 // Is there an initial @ or T?
1578 if (preg_match('/^T ([A-Z0-9]{1,64}) /', $content, $match) ||
1579 preg_match('/^@([a-z0-9]{1,64})\s+/', $content, $match)) {
1580 $nickname = common_canonical_nickname($match[1]);
1585 // Figure out who that is.
1587 $sender = Profile::staticGet('id', $profile_id);
1588 if (empty($sender)) {
1592 $recipient = common_relative_profile($sender, $nickname, common_sql_now());
1594 if (empty($recipient)) {
1598 // Get their last notice
1600 $last = $recipient->getCurrentNotice();
1602 if (!empty($last)) {
1607 static function maxContent()
1609 $contentlimit = common_config('notice', 'contentlimit');
1610 // null => use global limit (distinct from 0!)
1611 if (is_null($contentlimit)) {
1612 $contentlimit = common_config('site', 'textlimit');
1614 return $contentlimit;
1617 static function contentTooLong($content)
1619 $contentlimit = self::maxContent();
1620 return ($contentlimit > 0 && !empty($content) && (mb_strlen($content) > $contentlimit));
1623 function getLocation()
1627 if (!empty($this->location_id) && !empty($this->location_ns)) {
1628 $location = Location::fromId($this->location_id, $this->location_ns);
1631 if (is_null($location)) { // no ID, or Location::fromId() failed
1632 if (!empty($this->lat) && !empty($this->lon)) {
1633 $location = Location::fromLatLon($this->lat, $this->lon);
1640 function repeat($repeater_id, $source)
1642 $author = Profile::staticGet('id', $this->profile_id);
1644 // TRANS: Message used to repeat a notice. RT is the abbreviation of 'retweet'.
1645 // TRANS: %1$s is the repeated user's name, %2$s is the repeated notice.
1646 $content = sprintf(_('RT @%1$s %2$s'),
1650 $maxlen = common_config('site', 'textlimit');
1651 if ($maxlen > 0 && mb_strlen($content) > $maxlen) {
1652 // Web interface and current Twitter API clients will
1653 // pull the original notice's text, but some older
1654 // clients and RSS/Atom feeds will see this trimmed text.
1656 // Unfortunately this is likely to lose tags or URLs
1657 // at the end of long notices.
1658 $content = mb_substr($content, 0, $maxlen - 4) . ' ...';
1661 return self::saveNew($repeater_id, $content, $source,
1662 array('repeat_of' => $this->id));
1665 // These are supposed to be in chron order!
1667 function repeatStream($limit=100)
1669 $cache = common_memcache();
1671 if (empty($cache)) {
1672 $ids = $this->_repeatStreamDirect($limit);
1674 $idstr = $cache->get(common_cache_key('notice:repeats:'.$this->id));
1675 if ($idstr !== false) {
1676 $ids = explode(',', $idstr);
1678 $ids = $this->_repeatStreamDirect(100);
1679 $cache->set(common_cache_key('notice:repeats:'.$this->id), implode(',', $ids));
1682 // We do a max of 100, so slice down to limit
1683 $ids = array_slice($ids, 0, $limit);
1687 return Notice::getStreamByIds($ids);
1690 function _repeatStreamDirect($limit)
1692 $notice = new Notice();
1694 $notice->selectAdd(); // clears it
1695 $notice->selectAdd('id');
1697 $notice->repeat_of = $this->id;
1699 $notice->orderBy('created, id'); // NB: asc!
1701 if (!is_null($limit)) {
1702 $notice->limit(0, $limit);
1707 if ($notice->find()) {
1708 while ($notice->fetch()) {
1709 $ids[] = $notice->id;
1719 function locationOptions($lat, $lon, $location_id, $location_ns, $profile = null)
1723 if (!empty($location_id) && !empty($location_ns)) {
1724 $options['location_id'] = $location_id;
1725 $options['location_ns'] = $location_ns;
1727 $location = Location::fromId($location_id, $location_ns);
1729 if (!empty($location)) {
1730 $options['lat'] = $location->lat;
1731 $options['lon'] = $location->lon;
1734 } else if (!empty($lat) && !empty($lon)) {
1735 $options['lat'] = $lat;
1736 $options['lon'] = $lon;
1738 $location = Location::fromLatLon($lat, $lon);
1740 if (!empty($location)) {
1741 $options['location_id'] = $location->location_id;
1742 $options['location_ns'] = $location->location_ns;
1744 } else if (!empty($profile)) {
1745 if (isset($profile->lat) && isset($profile->lon)) {
1746 $options['lat'] = $profile->lat;
1747 $options['lon'] = $profile->lon;
1750 if (isset($profile->location_id) && isset($profile->location_ns)) {
1751 $options['location_id'] = $profile->location_id;
1752 $options['location_ns'] = $profile->location_ns;
1759 function clearReplies()
1761 $replyNotice = new Notice();
1762 $replyNotice->reply_to = $this->id;
1764 //Null any notices that are replies to this notice
1766 if ($replyNotice->find()) {
1767 while ($replyNotice->fetch()) {
1768 $orig = clone($replyNotice);
1769 $replyNotice->reply_to = null;
1770 $replyNotice->update($orig);
1776 $reply = new Reply();
1777 $reply->notice_id = $this->id;
1779 if ($reply->find()) {
1780 while($reply->fetch()) {
1781 self::blow('reply:stream:%d', $reply->profile_id);
1789 function clearFiles()
1791 $f2p = new File_to_post();
1793 $f2p->post_id = $this->id;
1796 while ($f2p->fetch()) {
1800 // FIXME: decide whether to delete File objects
1801 // ...and related (actual) files
1804 function clearRepeats()
1806 $repeatNotice = new Notice();
1807 $repeatNotice->repeat_of = $this->id;
1809 //Null any notices that are repeats of this notice
1811 if ($repeatNotice->find()) {
1812 while ($repeatNotice->fetch()) {
1813 $orig = clone($repeatNotice);
1814 $repeatNotice->repeat_of = null;
1815 $repeatNotice->update($orig);
1820 function clearFaves()
1823 $fave->notice_id = $this->id;
1825 if ($fave->find()) {
1826 while ($fave->fetch()) {
1827 self::blow('fave:ids_by_user_own:%d', $fave->user_id);
1828 self::blow('fave:ids_by_user_own:%d;last', $fave->user_id);
1829 self::blow('fave:ids_by_user:%d', $fave->user_id);
1830 self::blow('fave:ids_by_user:%d;last', $fave->user_id);
1838 function clearTags()
1840 $tag = new Notice_tag();
1841 $tag->notice_id = $this->id;
1844 while ($tag->fetch()) {
1845 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, common_keyize($tag->tag));
1846 self::blow('profile:notice_ids_tagged:%d:%s;last', $this->profile_id, common_keyize($tag->tag));
1847 self::blow('notice_tag:notice_ids:%s', common_keyize($tag->tag));
1848 self::blow('notice_tag:notice_ids:%s;last', common_keyize($tag->tag));
1856 function clearGroupInboxes()
1858 $gi = new Group_inbox();
1860 $gi->notice_id = $this->id;
1863 while ($gi->fetch()) {
1864 self::blow('user_group:notice_ids:%d', $gi->group_id);
1872 function distribute()
1874 // We always insert for the author so they don't
1876 Event::handle('StartNoticeDistribute', array($this));
1878 $user = User::staticGet('id', $this->profile_id);
1879 if (!empty($user)) {
1880 Inbox::insertNotice($user->id, $this->id);
1883 if (common_config('queue', 'inboxes')) {
1884 // If there's a failure, we want to _force_
1885 // distribution at this point.
1887 $qm = QueueManager::get();
1888 $qm->enqueue($this, 'distrib');
1889 } catch (Exception $e) {
1890 // If the exception isn't transient, this
1891 // may throw more exceptions as DQH does
1892 // its own enqueueing. So, we ignore them!
1894 $handler = new DistribQueueHandler();
1895 $handler->handle($this);
1896 } catch (Exception $e) {
1897 common_log(LOG_ERR, "emergency redistribution resulted in " . $e->getMessage());
1899 // Re-throw so somebody smarter can handle it.
1903 $handler = new DistribQueueHandler();
1904 $handler->handle($this);
1910 $result = parent::insert();
1913 // Profile::hasRepeated() abuses pkeyGet(), so we
1914 // have to clear manually
1915 if (!empty($this->repeat_of)) {
1916 $c = self::memcache();
1918 $ck = self::multicacheKey('Notice',
1919 array('profile_id' => $this->profile_id,
1920 'repeat_of' => $this->repeat_of));
1930 * Get the source of the notice
1932 * @return Notice_source $ns A notice source object. 'code' is the only attribute
1933 * guaranteed to be populated.
1935 function getSource()
1937 $ns = new Notice_source();
1938 if (!empty($this->source)) {
1939 switch ($this->source) {
1946 $ns->code = $this->source;
1949 $ns = Notice_source::staticGet($this->source);
1951 $ns = new Notice_source();
1952 $ns->code = $this->source;
1953 $app = Oauth_application::staticGet('name', $this->source);
1955 $ns->name = $app->name;
1956 $ns->url = $app->source_url;
1966 * Determine whether the notice was locally created
1968 * @return boolean locality
1971 public function isLocal()
1973 return ($this->is_local == Notice::LOCAL_PUBLIC ||
1974 $this->is_local == Notice::LOCAL_NONPUBLIC);
1977 public function getTags()
1980 $tag = new Notice_tag();
1981 $tag->notice_id = $this->id;
1983 while ($tag->fetch()) {
1984 $tags[] = $tag->tag;
1991 static private function utcDate($dt)
1993 $dateStr = date('d F Y H:i:s', strtotime($dt));
1994 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1995 return $d->format(DATE_W3C);
1999 * Look up the creation timestamp for a given notice ID, even
2000 * if it's been deleted.
2003 * @return mixed string recorded creation timestamp, or false if can't be found
2005 public static function getAsTimestamp($id)
2011 $notice = Notice::staticGet('id', $id);
2013 return $notice->created;
2016 $deleted = Deleted_notice::staticGet('id', $id);
2018 return $deleted->created;
2025 * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2026 * parameter, matching notices posted after the given one (exclusive).
2028 * If the referenced notice can't be found, will return false.
2031 * @param string $idField
2032 * @param string $createdField
2033 * @return mixed string or false if no match
2035 public static function whereSinceId($id, $idField='id', $createdField='created')
2037 $since = Notice::getAsTimestamp($id);
2039 return sprintf("($createdField = '%s' and $idField > %d) or ($createdField > '%s')", $since, $id, $since);
2045 * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2046 * parameter, matching notices posted after the given one (exclusive), and
2047 * if necessary add it to the data object's query.
2049 * @param DB_DataObject $obj
2051 * @param string $idField
2052 * @param string $createdField
2053 * @return mixed string or false if no match
2055 public static function addWhereSinceId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2057 $since = self::whereSinceId($id, $idField, $createdField);
2059 $obj->whereAdd($since);
2064 * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2065 * parameter, matching notices posted before the given one (inclusive).
2067 * If the referenced notice can't be found, will return false.
2070 * @param string $idField
2071 * @param string $createdField
2072 * @return mixed string or false if no match
2074 public static function whereMaxId($id, $idField='id', $createdField='created')
2076 $max = Notice::getAsTimestamp($id);
2078 return sprintf("($createdField < '%s') or ($createdField = '%s' and $idField <= %d)", $max, $max, $id);
2084 * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2085 * parameter, matching notices posted before the given one (inclusive), and
2086 * if necessary add it to the data object's query.
2088 * @param DB_DataObject $obj
2090 * @param string $idField
2091 * @param string $createdField
2092 * @return mixed string or false if no match
2094 public static function addWhereMaxId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2096 $max = self::whereMaxId($id, $idField, $createdField);
2098 $obj->whereAdd($max);