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();
139 // NOTE: we don't clear inboxes
140 // NOTE: we don't clear queue items
143 $result = parent::delete();
145 $this->blowOnDelete();
150 * Extract #hashtags from this notice's content and save them to the database.
154 /* extract all #hastags */
155 $count = preg_match_all('/(?:^|\s)#([\pL\pN_\-\.]{1,64})/', strtolower($this->content), $match);
160 /* Add them to the database */
161 return $this->saveKnownTags($match[1]);
165 * Record the given set of hash tags in the db for this notice.
166 * Given tag strings will be normalized and checked for dupes.
168 function saveKnownTags($hashtags)
170 //turn each into their canonical tag
171 //this is needed to remove dupes before saving e.g. #hash.tag = #hashtag
172 for($i=0; $i<count($hashtags); $i++) {
173 /* elide characters we don't want in the tag */
174 $hashtags[$i] = common_canonical_tag($hashtags[$i]);
177 foreach(array_unique($hashtags) as $hashtag) {
178 $this->saveTag($hashtag);
179 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, $hashtag);
185 * Record a single hash tag as associated with this notice.
186 * Tag format and uniqueness must be validated by caller.
188 function saveTag($hashtag)
190 $tag = new Notice_tag();
191 $tag->notice_id = $this->id;
192 $tag->tag = $hashtag;
193 $tag->created = $this->created;
194 $id = $tag->insert();
197 // TRANS: Server exception. %s are the error details.
198 throw new ServerException(sprintf(_('Database error inserting hashtag: %s'),
199 $last_error->message));
203 // if it's saved, blow its cache
204 $tag->blowCache(false);
208 * Save a new notice and push it out to subscribers' inboxes.
209 * Poster's permissions are checked before sending.
211 * @param int $profile_id Profile ID of the poster
212 * @param string $content source message text; links may be shortened
213 * per current user's preference
214 * @param string $source source key ('web', 'api', etc)
215 * @param array $options Associative array of optional properties:
216 * string 'created' timestamp of notice; defaults to now
217 * int 'is_local' source/gateway ID, one of:
218 * Notice::LOCAL_PUBLIC - Local, ok to appear in public timeline
219 * Notice::REMOTE_OMB - Sent from a remote OMB service;
220 * hide from public timeline but show in
221 * local "and friends" timelines
222 * Notice::LOCAL_NONPUBLIC - Local, but hide from public timeline
223 * Notice::GATEWAY - From another non-OMB service;
224 * will not appear in public views
225 * float 'lat' decimal latitude for geolocation
226 * float 'lon' decimal longitude for geolocation
227 * int 'location_id' geoname identifier
228 * int 'location_ns' geoname namespace to interpret location_id
229 * int 'reply_to'; notice ID this is a reply to
230 * int 'repeat_of'; notice ID this is a repeat of
231 * string 'uri' unique ID for notice; defaults to local notice URL
232 * string 'url' permalink to notice; defaults to local notice URL
233 * string 'rendered' rendered HTML version of content
234 * array 'replies' list of profile URIs for reply delivery in
235 * place of extracting @-replies from content.
236 * array 'groups' list of group IDs to deliver to, in place of
237 * extracting ! tags from content
238 * array 'tags' list of hashtag strings to save with the notice
239 * in place of extracting # tags from content
240 * array 'urls' list of attached/referred URLs to save with the
241 * notice in place of extracting links from content
242 * boolean 'distribute' whether to distribute the notice, default true
244 * @fixme tag override
247 * @throws ClientException
249 static function saveNew($profile_id, $content, $source, $options=null) {
250 $defaults = array('uri' => null,
254 'distribute' => true);
256 if (!empty($options)) {
257 $options = $options + $defaults;
263 if (!isset($is_local)) {
264 $is_local = Notice::LOCAL_PUBLIC;
267 $profile = Profile::staticGet('id', $profile_id);
268 $user = User::staticGet('id', $profile_id);
270 // Use the local user's shortening preferences, if applicable.
271 $final = $user->shortenLinks($content);
273 $final = common_shorten_links($content);
276 if (Notice::contentTooLong($final)) {
277 // TRANS: Client exception thrown if a notice contains too many characters.
278 throw new ClientException(_('Problem saving notice. Too long.'));
281 if (empty($profile)) {
282 // TRANS: Client exception thrown when trying to save a notice for an unknown user.
283 throw new ClientException(_('Problem saving notice. Unknown user.'));
286 if (common_config('throttle', 'enabled') && !Notice::checkEditThrottle($profile_id)) {
287 common_log(LOG_WARNING, 'Excessive posting by profile #' . $profile_id . '; throttled.');
288 // TRANS: Client exception thrown when a user tries to post too many notices in a given time frame.
289 throw new ClientException(_('Too many notices too fast; take a breather '.
290 'and post again in a few minutes.'));
293 if (common_config('site', 'dupelimit') > 0 && !Notice::checkDupes($profile_id, $final)) {
294 common_log(LOG_WARNING, 'Dupe posting by profile #' . $profile_id . '; throttled.');
295 // TRANS: Client exception thrown when a user tries to post too many duplicate notices in a given time frame.
296 throw new ClientException(_('Too many duplicate messages too quickly;'.
297 ' take a breather and post again in a few minutes.'));
300 if (!$profile->hasRight(Right::NEWNOTICE)) {
301 common_log(LOG_WARNING, "Attempted post from user disallowed to post: " . $profile->nickname);
303 // TRANS: Client exception thrown when a user tries to post while being banned.
304 throw new ClientException(_('You are banned from posting notices on this site.'), 403);
307 $notice = new Notice();
308 $notice->profile_id = $profile_id;
310 $autosource = common_config('public', 'autosource');
312 # Sandboxed are non-false, but not 1, either
314 if (!$profile->hasRight(Right::PUBLICNOTICE) ||
315 ($source && $autosource && in_array($source, $autosource))) {
316 $notice->is_local = Notice::LOCAL_NONPUBLIC;
318 $notice->is_local = $is_local;
321 if (!empty($created)) {
322 $notice->created = $created;
324 $notice->created = common_sql_now();
327 $notice->content = $final;
329 $notice->source = $source;
333 // Handle repeat case
335 if (isset($repeat_of)) {
336 $notice->repeat_of = $repeat_of;
338 $notice->reply_to = self::getReplyTo($reply_to, $profile_id, $source, $final);
341 if (!empty($notice->reply_to)) {
342 $reply = Notice::staticGet('id', $notice->reply_to);
343 $notice->conversation = $reply->conversation;
346 if (!empty($lat) && !empty($lon)) {
351 if (!empty($location_ns) && !empty($location_id)) {
352 $notice->location_id = $location_id;
353 $notice->location_ns = $location_ns;
356 if (!empty($rendered)) {
357 $notice->rendered = $rendered;
359 $notice->rendered = common_render_content($final, $notice);
362 if (Event::handle('StartNoticeSave', array(&$notice))) {
364 // XXX: some of these functions write to the DB
366 $id = $notice->insert();
369 common_log_db_error($notice, 'INSERT', __FILE__);
370 // TRANS: Server exception thrown when a notice cannot be saved.
371 throw new ServerException(_('Problem saving notice.'));
374 // Update ID-dependent columns: URI, conversation
376 $orig = clone($notice);
381 $notice->uri = common_notice_uri($notice);
385 // If it's not part of a conversation, it's
386 // the beginning of a new conversation.
388 if (empty($notice->conversation)) {
389 $conv = Conversation::create();
390 $notice->conversation = $conv->id;
395 if (!$notice->update($orig)) {
396 common_log_db_error($notice, 'UPDATE', __FILE__);
397 // TRANS: Server exception thrown when a notice cannot be updated.
398 throw new ServerException(_('Problem saving notice.'));
404 # Clear the cache for subscribed users, so they'll update at next request
405 # XXX: someone clever could prepend instead of clearing the cache
407 $notice->blowOnInsert();
409 // Save per-notice metadata...
411 if (isset($replies)) {
412 $notice->saveKnownReplies($replies);
414 $notice->saveReplies();
418 $notice->saveKnownTags($tags);
423 // Note: groups may save tags, so must be run after tags are saved
424 // to avoid errors on duplicates.
425 if (isset($groups)) {
426 $notice->saveKnownGroups($groups);
428 $notice->saveGroups();
432 $notice->saveKnownUrls($urls);
438 // Prepare inbox delivery, may be queued to background.
439 $notice->distribute();
445 function blowOnInsert($conversation = false)
447 self::blow('profile:notice_ids:%d', $this->profile_id);
448 self::blow('public');
450 // XXX: Before we were blowing the casche only if the notice id
451 // was not the root of the conversation. What to do now?
453 self::blow('notice:conversation_ids:%d', $this->conversation);
455 if (!empty($this->repeat_of)) {
456 self::blow('notice:repeats:%d', $this->repeat_of);
459 $original = Notice::staticGet('id', $this->repeat_of);
461 if (!empty($original)) {
462 $originalUser = User::staticGet('id', $original->profile_id);
463 if (!empty($originalUser)) {
464 self::blow('user:repeats_of_me:%d', $originalUser->id);
468 $profile = Profile::staticGet($this->profile_id);
469 if (!empty($profile)) {
470 $profile->blowNoticeCount();
475 * Clear cache entries related to this notice at delete time.
476 * Necessary to avoid breaking paging on public, profile timelines.
478 function blowOnDelete()
480 $this->blowOnInsert();
482 self::blow('profile:notice_ids:%d;last', $this->profile_id);
483 self::blow('public;last');
486 /** save all urls in the notice to the db
488 * follow redirects and save all available file information
489 * (mimetype, date, size, oembed, etc.)
493 function saveUrls() {
494 if (common_config('attachments', 'process_links')) {
495 common_replace_urls_callback($this->content, array($this, 'saveUrl'), $this->id);
500 * Save the given URLs as related links/attachments to the db
502 * follow redirects and save all available file information
503 * (mimetype, date, size, oembed, etc.)
507 function saveKnownUrls($urls)
509 if (common_config('attachments', 'process_links')) {
510 // @fixme validation?
511 foreach (array_unique($urls) as $url) {
512 File::processNew($url, $this->id);
520 function saveUrl($url, $notice_id) {
521 File::processNew($url, $notice_id);
524 static function checkDupes($profile_id, $content) {
525 $profile = Profile::staticGet($profile_id);
526 if (empty($profile)) {
529 $notice = $profile->getNotices(0, NOTICE_CACHE_WINDOW);
530 if (!empty($notice)) {
532 while ($notice->fetch()) {
533 if (time() - strtotime($notice->created) >= common_config('site', 'dupelimit')) {
535 } else if ($notice->content == $content) {
540 # If we get here, oldest item in cache window is not
541 # old enough for dupe limit; do direct check against DB
542 $notice = new Notice();
543 $notice->profile_id = $profile_id;
544 $notice->content = $content;
545 $threshold = common_sql_date(time() - common_config('site', 'dupelimit'));
546 $notice->whereAdd(sprintf("created > '%s'", $notice->escape($threshold)));
548 $cnt = $notice->count();
552 static function checkEditThrottle($profile_id) {
553 $profile = Profile::staticGet($profile_id);
554 if (empty($profile)) {
558 $notice = $profile->getNotices(common_config('throttle', 'count') - 1, 1);
559 if ($notice && $notice->fetch()) {
560 # If the Nth notice was posted less than timespan seconds ago
561 if (time() - strtotime($notice->created) <= common_config('throttle', 'timespan')) {
566 # Either not N notices in the stream, OR the Nth was not posted within timespan seconds
570 function getUploadedAttachment() {
572 $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"';
573 $post->query($query);
575 if (empty($post->up) || empty($post->i)) {
578 $ret = array($post->up, $post->i);
584 function hasAttachments() {
586 $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);
587 $post->query($query);
589 $n_attachments = intval($post->n_attachments);
591 return $n_attachments;
594 function attachments() {
597 $f2p = new File_to_post;
598 $f2p->post_id = $this->id;
600 while ($f2p->fetch()) {
601 $f = File::staticGet($f2p->file_id);
610 function getStreamByIds($ids)
612 $cache = Cache::instance();
614 if (!empty($cache)) {
616 foreach ($ids as $id) {
617 $n = Notice::staticGet('id', $id);
622 return new ArrayWrapper($notices);
624 $notice = new Notice();
626 //if no IDs requested, just return the notice object
629 $notice->whereAdd('id in (' . implode(', ', $ids) . ')');
635 while ($notice->fetch()) {
636 $temp[$notice->id] = clone($notice);
641 foreach ($ids as $id) {
642 if (array_key_exists($id, $temp)) {
643 $wrapped[] = $temp[$id];
647 return new ArrayWrapper($wrapped);
651 function publicStream($offset=0, $limit=20, $since_id=0, $max_id=0)
653 $ids = Notice::stream(array('Notice', '_publicStreamDirect'),
656 $offset, $limit, $since_id, $max_id);
657 return Notice::getStreamByIds($ids);
660 function _publicStreamDirect($offset=0, $limit=20, $since_id=0, $max_id=0)
662 $notice = new Notice();
664 $notice->selectAdd(); // clears it
665 $notice->selectAdd('id');
667 $notice->orderBy('created DESC, id DESC');
669 if (!is_null($offset)) {
670 $notice->limit($offset, $limit);
673 if (common_config('public', 'localonly')) {
674 $notice->whereAdd('is_local = ' . Notice::LOCAL_PUBLIC);
676 # -1 == blacklisted, -2 == gateway (i.e. Twitter)
677 $notice->whereAdd('is_local !='. Notice::LOCAL_NONPUBLIC);
678 $notice->whereAdd('is_local !='. Notice::GATEWAY);
681 Notice::addWhereSinceId($notice, $since_id);
682 Notice::addWhereMaxId($notice, $max_id);
686 if ($notice->find()) {
687 while ($notice->fetch()) {
688 $ids[] = $notice->id;
698 function conversationStream($id, $offset=0, $limit=20, $since_id=0, $max_id=0)
700 $ids = Notice::stream(array('Notice', '_conversationStreamDirect'),
702 'notice:conversation_ids:'.$id,
703 $offset, $limit, $since_id, $max_id);
705 return Notice::getStreamByIds($ids);
708 function _conversationStreamDirect($id, $offset=0, $limit=20, $since_id=0, $max_id=0)
710 $notice = new Notice();
712 $notice->selectAdd(); // clears it
713 $notice->selectAdd('id');
715 $notice->conversation = $id;
717 $notice->orderBy('created DESC, id DESC');
719 if (!is_null($offset)) {
720 $notice->limit($offset, $limit);
723 Notice::addWhereSinceId($notice, $since_id);
724 Notice::addWhereMaxId($notice, $max_id);
728 if ($notice->find()) {
729 while ($notice->fetch()) {
730 $ids[] = $notice->id;
741 * Is this notice part of an active conversation?
743 * @return boolean true if other messages exist in the same
744 * conversation, false if this is the only one
746 function hasConversation()
748 if (!empty($this->conversation)) {
749 $conversation = Notice::conversationStream(
755 if ($conversation->N > 0) {
763 * Pull up a full list of local recipients who will be getting
764 * this notice in their inbox. Results will be cached, so don't
765 * change the input data wily-nilly!
767 * @param array $groups optional list of Group objects;
768 * if left empty, will be loaded from group_inbox records
769 * @param array $recipient optional list of reply profile ids
770 * if left empty, will be loaded from reply records
771 * @return array associating recipient user IDs with an inbox source constant
773 function whoGets($groups=null, $recipients=null)
775 $c = self::memcache();
778 $ni = $c->get(Cache::key('notice:who_gets:'.$this->id));
784 if (is_null($groups)) {
785 $groups = $this->getGroups();
788 if (is_null($recipients)) {
789 $recipients = $this->getReplies();
792 $users = $this->getSubscribedUsers();
794 // FIXME: kind of ignoring 'transitional'...
795 // we'll probably stop supporting inboxless mode
800 foreach ($users as $id) {
801 $ni[$id] = NOTICE_INBOX_SOURCE_SUB;
804 foreach ($groups as $group) {
805 $users = $group->getUserMembers();
806 foreach ($users as $id) {
807 if (!array_key_exists($id, $ni)) {
808 $ni[$id] = NOTICE_INBOX_SOURCE_GROUP;
813 foreach ($recipients as $recipient) {
814 if (!array_key_exists($recipient, $ni)) {
815 $ni[$recipient] = NOTICE_INBOX_SOURCE_REPLY;
819 // Exclude any deleted, non-local, or blocking recipients.
820 $profile = $this->getProfile();
821 foreach ($ni as $id => $source) {
822 $user = User::staticGet('id', $id);
823 if (empty($user) || $user->hasBlocked($profile)) {
829 // XXX: pack this data better
830 $c->set(Cache::key('notice:who_gets:'.$this->id), $ni);
837 * Adds this notice to the inboxes of each local user who should receive
838 * it, based on author subscriptions, group memberships, and @-replies.
840 * Warning: running a second time currently will make items appear
841 * multiple times in users' inboxes.
843 * @fixme make more robust against errors
844 * @fixme break up massive deliveries to smaller background tasks
846 * @param array $groups optional list of Group objects;
847 * if left empty, will be loaded from group_inbox records
848 * @param array $recipient optional list of reply profile ids
849 * if left empty, will be loaded from reply records
851 function addToInboxes($groups=null, $recipients=null)
853 $ni = $this->whoGets($groups, $recipients);
855 $ids = array_keys($ni);
857 // We remove the author (if they're a local user),
858 // since we'll have already done this in distribute()
860 $i = array_search($this->profile_id, $ids);
868 Inbox::bulkInsert($this->id, $ids);
873 function getSubscribedUsers()
877 if(common_config('db','quote_identifiers'))
878 $user_table = '"user"';
879 else $user_table = 'user';
883 'FROM '. $user_table .' JOIN subscription '.
884 'ON '. $user_table .'.id = subscription.subscriber ' .
885 'WHERE subscription.subscribed = %d ';
887 $user->query(sprintf($qry, $this->profile_id));
891 while ($user->fetch()) {
901 * Record this notice to the given group inboxes for delivery.
902 * Overrides the regular parsing of !group markup.
904 * @param string $group_ids
905 * @fixme might prefer URIs as identifiers, as for replies?
906 * best with generalizations on user_group to support
907 * remote groups better.
909 function saveKnownGroups($group_ids)
911 if (!is_array($group_ids)) {
912 // TRANS: Server exception thrown when no array is provided to the method saveKnownGroups().
913 throw new ServerException(_('Bad type provided to saveKnownGroups.'));
917 foreach (array_unique($group_ids) as $id) {
918 $group = User_group::staticGet('id', $id);
920 common_log(LOG_ERR, "Local delivery to group id $id, $group->nickname");
921 $result = $this->addToGroupInbox($group);
923 common_log_db_error($gi, 'INSERT', __FILE__);
926 // @fixme should we save the tags here or not?
927 $groups[] = clone($group);
929 common_log(LOG_ERR, "Local delivery to group id $id skipped, doesn't exist");
937 * Parse !group delivery and record targets into group_inbox.
938 * @return array of Group objects
940 function saveGroups()
942 // Don't save groups for repeats
944 if (!empty($this->repeat_of)) {
950 /* extract all !group */
951 $count = preg_match_all('/(?:^|\s)!([A-Za-z0-9]{1,64})/',
952 strtolower($this->content),
958 $profile = $this->getProfile();
960 /* Add them to the database */
962 foreach (array_unique($match[1]) as $nickname) {
963 /* XXX: remote groups. */
964 $group = User_group::getForNickname($nickname, $profile);
970 // we automatically add a tag for every group name, too
972 $tag = Notice_tag::pkeyGet(array('tag' => common_canonical_tag($nickname),
973 'notice_id' => $this->id));
976 $this->saveTag($nickname);
979 if ($profile->isMember($group)) {
981 $result = $this->addToGroupInbox($group);
984 common_log_db_error($gi, 'INSERT', __FILE__);
987 $groups[] = clone($group);
994 function addToGroupInbox($group)
996 $gi = Group_inbox::pkeyGet(array('group_id' => $group->id,
997 'notice_id' => $this->id));
1001 $gi = new Group_inbox();
1003 $gi->group_id = $group->id;
1004 $gi->notice_id = $this->id;
1005 $gi->created = $this->created;
1007 $result = $gi->insert();
1010 common_log_db_error($gi, 'INSERT', __FILE__);
1011 // TRANS: Server exception thrown when an update for a group inbox fails.
1012 throw new ServerException(_('Problem saving group inbox.'));
1015 self::blow('user_group:notice_ids:%d', $gi->group_id);
1022 * Save reply records indicating that this notice needs to be
1023 * delivered to the local users with the given URIs.
1025 * Since this is expected to be used when saving foreign-sourced
1026 * messages, we won't deliver to any remote targets as that's the
1027 * source service's responsibility.
1029 * Mail notifications etc will be handled later.
1031 * @param array of unique identifier URIs for recipients
1033 function saveKnownReplies($uris)
1039 $sender = Profile::staticGet($this->profile_id);
1041 foreach (array_unique($uris) as $uri) {
1043 $profile = Profile::fromURI($uri);
1045 if (empty($profile)) {
1046 common_log(LOG_WARNING, "Unable to determine profile for URI '$uri'");
1050 if ($profile->hasBlocked($sender)) {
1051 common_log(LOG_INFO, "Not saving reply to profile {$profile->id} ($uri) from sender {$sender->id} because of a block.");
1055 $reply = new Reply();
1057 $reply->notice_id = $this->id;
1058 $reply->profile_id = $profile->id;
1060 common_log(LOG_INFO, __METHOD__ . ": saving reply: notice $this->id to profile $profile->id");
1062 $id = $reply->insert();
1069 * Pull @-replies from this message's content in StatusNet markup format
1070 * and save reply records indicating that this message needs to be
1071 * delivered to those users.
1073 * Mail notifications to local profiles will be sent later.
1075 * @return array of integer profile IDs
1078 function saveReplies()
1080 // Don't save reply data for repeats
1082 if (!empty($this->repeat_of)) {
1086 $sender = Profile::staticGet($this->profile_id);
1088 // @todo ideally this parser information would only
1089 // be calculated once.
1091 $mentions = common_find_mentions($this->content, $this);
1095 // store replied only for first @ (what user/notice what the reply directed,
1096 // we assume first @ is it)
1098 foreach ($mentions as $mention) {
1100 foreach ($mention['mentioned'] as $mentioned) {
1102 // skip if they're already covered
1104 if (!empty($replied[$mentioned->id])) {
1108 // Don't save replies from blocked profile to local user
1110 $mentioned_user = User::staticGet('id', $mentioned->id);
1111 if (!empty($mentioned_user) && $mentioned_user->hasBlocked($sender)) {
1115 $reply = new Reply();
1117 $reply->notice_id = $this->id;
1118 $reply->profile_id = $mentioned->id;
1120 $id = $reply->insert();
1123 common_log_db_error($reply, 'INSERT', __FILE__);
1124 // TRANS: Server exception thrown when a reply cannot be saved.
1125 // TRANS: %1$d is a notice ID, %2$d is the ID of the mentioned user.
1126 throw new ServerException(sprintf(_('Could not save reply for %1$d, %2$d.'), $this->id, $mentioned->id));
1128 $replied[$mentioned->id] = 1;
1129 self::blow('reply:stream:%d', $mentioned->id);
1134 $recipientIds = array_keys($replied);
1136 return $recipientIds;
1140 * Pull the complete list of @-reply targets for this notice.
1142 * @return array of integer profile ids
1144 function getReplies()
1150 $reply = new Reply();
1151 $reply->selectAdd();
1152 $reply->selectAdd('profile_id');
1153 $reply->notice_id = $this->id;
1155 if ($reply->find()) {
1156 while($reply->fetch()) {
1157 $ids[] = $reply->profile_id;
1167 * Send e-mail notifications to local @-reply targets.
1169 * Replies must already have been saved; this is expected to be run
1170 * from the distrib queue handler.
1172 function sendReplyNotifications()
1174 // Don't send reply notifications for repeats
1176 if (!empty($this->repeat_of)) {
1180 $recipientIds = $this->getReplies();
1182 foreach ($recipientIds as $recipientId) {
1183 $user = User::staticGet('id', $recipientId);
1184 if (!empty($user)) {
1185 mail_notify_attn($user, $this);
1191 * Pull list of groups this notice needs to be delivered to,
1192 * as previously recorded by saveGroups() or saveKnownGroups().
1194 * @return array of Group objects
1196 function getGroups()
1198 // Don't save groups for repeats
1200 if (!empty($this->repeat_of)) {
1208 $gi = new Group_inbox();
1211 $gi->selectAdd('group_id');
1213 $gi->notice_id = $this->id;
1216 while ($gi->fetch()) {
1217 $group = User_group::staticGet('id', $gi->group_id);
1230 * Convert a notice into an activity for export.
1232 * @param User $cur Current user
1234 * @return Activity activity object representing this Notice.
1237 function asActivity()
1239 $act = self::cacheGet(Cache::codeKey('notice:as-activity:'.$this->id));
1245 $act = new Activity();
1247 if (Event::handle('StartNoticeAsActivity', array($this, &$act))) {
1249 $profile = $this->getProfile();
1251 $act->actor = ActivityObject::fromProfile($profile);
1252 $act->verb = ActivityVerb::POST;
1253 $act->objects[] = ActivityObject::fromNotice($this);
1255 // XXX: should this be handled by default processing for object entry?
1257 $act->time = strtotime($this->created);
1258 $act->link = $this->bestUrl();
1260 $act->content = common_xml_safe_str($this->rendered);
1261 $act->id = $this->uri;
1262 $act->title = common_xml_safe_str($this->content);
1266 $tags = $this->getTags();
1268 foreach ($tags as $tag) {
1269 $cat = new AtomCategory();
1272 $act->categories[] = $cat;
1276 // XXX: use Atom Media and/or File activity objects instead
1278 $attachments = $this->attachments();
1280 foreach ($attachments as $attachment) {
1281 $enclosure = $attachment->getEnclosure();
1283 $act->enclosures[] = $enclosure;
1287 $ctx = new ActivityContext();
1289 if (!empty($this->reply_to)) {
1290 $reply = Notice::staticGet('id', $this->reply_to);
1291 if (!empty($reply)) {
1292 $ctx->replyToID = $reply->uri;
1293 $ctx->replyToUrl = $reply->bestUrl();
1297 $ctx->location = $this->getLocation();
1301 if (!empty($this->conversation)) {
1302 $conv = Conversation::staticGet('id', $this->conversation);
1303 if (!empty($conv)) {
1304 $ctx->conversation = $conv->uri;
1308 $reply_ids = $this->getReplies();
1310 foreach ($reply_ids as $id) {
1311 $profile = Profile::staticGet('id', $id);
1312 if (!empty($profile)) {
1313 $ctx->attention[] = $profile->getUri();
1317 $groups = $this->getGroups();
1319 foreach ($groups as $group) {
1320 $ctx->attention[] = $group->uri;
1323 // XXX: deprecated; use ActivityVerb::SHARE instead
1327 if (!empty($this->repeat_of)) {
1328 $repeat = Notice::staticGet('id', $this->repeat_of);
1329 $ctx->forwardID = $repeat->uri;
1330 $ctx->forwardUrl = $repeat->bestUrl();
1333 $act->context = $ctx;
1337 $atom_feed = $profile->getAtomFeed();
1339 if (!empty($atom_feed)) {
1341 $act->source = new ActivitySource();
1343 // XXX: we should store the actual feed ID
1345 $act->source->id = $atom_feed;
1347 // XXX: we should store the actual feed title
1349 $act->source->title = $profile->getBestName();
1351 $act->source->links['alternate'] = $profile->profileurl;
1352 $act->source->links['self'] = $atom_feed;
1354 $act->source->icon = $profile->avatarUrl(AVATAR_PROFILE_SIZE);
1356 $notice = $profile->getCurrentNotice();
1358 if (!empty($notice)) {
1359 $act->source->updated = self::utcDate($notice->created);
1362 $user = User::staticGet('id', $profile->id);
1364 if (!empty($user)) {
1365 $act->source->links['license'] = common_config('license', 'url');
1369 if ($this->isLocal()) {
1370 $act->selfLink = common_local_url('ApiStatusesShow', array('id' => $this->id,
1371 'format' => 'atom'));
1372 $act->editLink = $act->selfLink;
1375 Event::handle('EndNoticeAsActivity', array($this, &$act));
1378 self::cacheSet(Cache::codeKey('notice:as-activity:'.$this->id), $act);
1383 // This has gotten way too long. Needs to be sliced up into functional bits
1384 // or ideally exported to a utility class.
1386 function asAtomEntry($namespace=false,
1391 $act = $this->asActivity();
1392 $act->extra[] = $this->noticeInfo($cur);
1393 return $act->asString($namespace, $author, $source);
1397 * Extra notice info for atom entries
1399 * Clients use some extra notice info in the atom stream.
1400 * This gives it to them.
1402 * @param User $cur Current user
1404 * @return array representation of <statusnet:notice_info> element
1407 function noticeInfo($cur)
1409 // local notice ID (useful to clients for ordering)
1411 $noticeInfoAttr = array('local_id' => $this->id);
1415 $ns = $this->getSource();
1418 $noticeInfoAttr['source'] = $ns->code;
1419 if (!empty($ns->url)) {
1420 $noticeInfoAttr['source_link'] = $ns->url;
1421 if (!empty($ns->name)) {
1422 $noticeInfoAttr['source'] = '<a href="'
1423 . htmlspecialchars($ns->url)
1424 . '" rel="nofollow">'
1425 . htmlspecialchars($ns->name)
1431 // favorite and repeated
1434 $noticeInfoAttr['favorite'] = ($cur->hasFave($this)) ? "true" : "false";
1435 $cp = $cur->getProfile();
1436 $noticeInfoAttr['repeated'] = ($cp->hasRepeated($this->id)) ? "true" : "false";
1439 if (!empty($this->repeat_of)) {
1440 $noticeInfoAttr['repeat_of'] = $this->repeat_of;
1443 return array('statusnet:notice_info', $noticeInfoAttr, null);
1447 * Returns an XML string fragment with a reference to a notice as an
1448 * Activity Streams noun object with the given element type.
1450 * Assumes that 'activity' namespace has been previously defined.
1452 * @param string $element one of 'subject', 'object', 'target'
1456 function asActivityNoun($element)
1458 $noun = ActivityObject::fromNotice($this);
1459 return $noun->asString('activity:' . $element);
1464 if (!empty($this->url)) {
1466 } else if (!empty($this->uri) && preg_match('/^https?:/', $this->uri)) {
1469 return common_local_url('shownotice',
1470 array('notice' => $this->id));
1474 function stream($fn, $args, $cachekey, $offset=0, $limit=20, $since_id=0, $max_id=0)
1476 $cache = Cache::instance();
1478 if (empty($cache) ||
1479 $since_id != 0 || $max_id != 0 ||
1481 ($offset + $limit) > NOTICE_CACHE_WINDOW) {
1482 return call_user_func_array($fn, array_merge($args, array($offset, $limit, $since_id,
1486 $idkey = Cache::key($cachekey);
1488 $idstr = $cache->get($idkey);
1490 if ($idstr !== false) {
1491 // Cache hit! Woohoo!
1492 $window = explode(',', $idstr);
1493 $ids = array_slice($window, $offset, $limit);
1497 $laststr = $cache->get($idkey.';last');
1499 if ($laststr !== false) {
1500 $window = explode(',', $laststr);
1501 $last_id = $window[0];
1502 $new_ids = call_user_func_array($fn, array_merge($args, array(0, NOTICE_CACHE_WINDOW,
1503 $last_id, 0, null)));
1505 $new_window = array_merge($new_ids, $window);
1507 $new_windowstr = implode(',', $new_window);
1509 $result = $cache->set($idkey, $new_windowstr);
1510 $result = $cache->set($idkey . ';last', $new_windowstr);
1512 $ids = array_slice($new_window, $offset, $limit);
1517 $window = call_user_func_array($fn, array_merge($args, array(0, NOTICE_CACHE_WINDOW,
1520 $windowstr = implode(',', $window);
1522 $result = $cache->set($idkey, $windowstr);
1523 $result = $cache->set($idkey . ';last', $windowstr);
1525 $ids = array_slice($window, $offset, $limit);
1531 * Determine which notice, if any, a new notice is in reply to.
1533 * For conversation tracking, we try to see where this notice fits
1534 * in the tree. Rough algorithm is:
1536 * if (reply_to is set and valid) {
1538 * } else if ((source not API or Web) and (content starts with "T NAME" or "@name ")) {
1539 * return ID of last notice by initial @name in content;
1542 * Note that all @nickname instances will still be used to save "reply" records,
1543 * so the notice shows up in the mentioned users' "replies" tab.
1545 * @param integer $reply_to ID passed in by Web or API
1546 * @param integer $profile_id ID of author
1547 * @param string $source Source tag, like 'web' or 'gwibber'
1548 * @param string $content Final notice content
1550 * @return integer ID of replied-to notice, or null for not a reply.
1553 static function getReplyTo($reply_to, $profile_id, $source, $content)
1555 static $lb = array('xmpp', 'mail', 'sms', 'omb');
1557 // If $reply_to is specified, we check that it exists, and then
1558 // return it if it does
1560 if (!empty($reply_to)) {
1561 $reply_notice = Notice::staticGet('id', $reply_to);
1562 if (!empty($reply_notice)) {
1567 // If it's not a "low bandwidth" source (one where you can't set
1568 // a reply_to argument), we return. This is mostly web and API
1571 if (!in_array($source, $lb)) {
1575 // Is there an initial @ or T?
1577 if (preg_match('/^T ([A-Z0-9]{1,64}) /', $content, $match) ||
1578 preg_match('/^@([a-z0-9]{1,64})\s+/', $content, $match)) {
1579 $nickname = common_canonical_nickname($match[1]);
1584 // Figure out who that is.
1586 $sender = Profile::staticGet('id', $profile_id);
1587 if (empty($sender)) {
1591 $recipient = common_relative_profile($sender, $nickname, common_sql_now());
1593 if (empty($recipient)) {
1597 // Get their last notice
1599 $last = $recipient->getCurrentNotice();
1601 if (!empty($last)) {
1606 static function maxContent()
1608 $contentlimit = common_config('notice', 'contentlimit');
1609 // null => use global limit (distinct from 0!)
1610 if (is_null($contentlimit)) {
1611 $contentlimit = common_config('site', 'textlimit');
1613 return $contentlimit;
1616 static function contentTooLong($content)
1618 $contentlimit = self::maxContent();
1619 return ($contentlimit > 0 && !empty($content) && (mb_strlen($content) > $contentlimit));
1622 function getLocation()
1626 if (!empty($this->location_id) && !empty($this->location_ns)) {
1627 $location = Location::fromId($this->location_id, $this->location_ns);
1630 if (is_null($location)) { // no ID, or Location::fromId() failed
1631 if (!empty($this->lat) && !empty($this->lon)) {
1632 $location = Location::fromLatLon($this->lat, $this->lon);
1639 function repeat($repeater_id, $source)
1641 $author = Profile::staticGet('id', $this->profile_id);
1643 // TRANS: Message used to repeat a notice. RT is the abbreviation of 'retweet'.
1644 // TRANS: %1$s is the repeated user's name, %2$s is the repeated notice.
1645 $content = sprintf(_('RT @%1$s %2$s'),
1649 $maxlen = common_config('site', 'textlimit');
1650 if ($maxlen > 0 && mb_strlen($content) > $maxlen) {
1651 // Web interface and current Twitter API clients will
1652 // pull the original notice's text, but some older
1653 // clients and RSS/Atom feeds will see this trimmed text.
1655 // Unfortunately this is likely to lose tags or URLs
1656 // at the end of long notices.
1657 $content = mb_substr($content, 0, $maxlen - 4) . ' ...';
1660 return self::saveNew($repeater_id, $content, $source,
1661 array('repeat_of' => $this->id));
1664 // These are supposed to be in chron order!
1666 function repeatStream($limit=100)
1668 $cache = Cache::instance();
1670 if (empty($cache)) {
1671 $ids = $this->_repeatStreamDirect($limit);
1673 $idstr = $cache->get(Cache::key('notice:repeats:'.$this->id));
1674 if ($idstr !== false) {
1675 $ids = explode(',', $idstr);
1677 $ids = $this->_repeatStreamDirect(100);
1678 $cache->set(Cache::key('notice:repeats:'.$this->id), implode(',', $ids));
1681 // We do a max of 100, so slice down to limit
1682 $ids = array_slice($ids, 0, $limit);
1686 return Notice::getStreamByIds($ids);
1689 function _repeatStreamDirect($limit)
1691 $notice = new Notice();
1693 $notice->selectAdd(); // clears it
1694 $notice->selectAdd('id');
1696 $notice->repeat_of = $this->id;
1698 $notice->orderBy('created, id'); // NB: asc!
1700 if (!is_null($limit)) {
1701 $notice->limit(0, $limit);
1706 if ($notice->find()) {
1707 while ($notice->fetch()) {
1708 $ids[] = $notice->id;
1718 function locationOptions($lat, $lon, $location_id, $location_ns, $profile = null)
1722 if (!empty($location_id) && !empty($location_ns)) {
1723 $options['location_id'] = $location_id;
1724 $options['location_ns'] = $location_ns;
1726 $location = Location::fromId($location_id, $location_ns);
1728 if (!empty($location)) {
1729 $options['lat'] = $location->lat;
1730 $options['lon'] = $location->lon;
1733 } else if (!empty($lat) && !empty($lon)) {
1734 $options['lat'] = $lat;
1735 $options['lon'] = $lon;
1737 $location = Location::fromLatLon($lat, $lon);
1739 if (!empty($location)) {
1740 $options['location_id'] = $location->location_id;
1741 $options['location_ns'] = $location->location_ns;
1743 } else if (!empty($profile)) {
1744 if (isset($profile->lat) && isset($profile->lon)) {
1745 $options['lat'] = $profile->lat;
1746 $options['lon'] = $profile->lon;
1749 if (isset($profile->location_id) && isset($profile->location_ns)) {
1750 $options['location_id'] = $profile->location_id;
1751 $options['location_ns'] = $profile->location_ns;
1758 function clearReplies()
1760 $replyNotice = new Notice();
1761 $replyNotice->reply_to = $this->id;
1763 //Null any notices that are replies to this notice
1765 if ($replyNotice->find()) {
1766 while ($replyNotice->fetch()) {
1767 $orig = clone($replyNotice);
1768 $replyNotice->reply_to = null;
1769 $replyNotice->update($orig);
1775 $reply = new Reply();
1776 $reply->notice_id = $this->id;
1778 if ($reply->find()) {
1779 while($reply->fetch()) {
1780 self::blow('reply:stream:%d', $reply->profile_id);
1788 function clearRepeats()
1790 $repeatNotice = new Notice();
1791 $repeatNotice->repeat_of = $this->id;
1793 //Null any notices that are repeats of this notice
1795 if ($repeatNotice->find()) {
1796 while ($repeatNotice->fetch()) {
1797 $orig = clone($repeatNotice);
1798 $repeatNotice->repeat_of = null;
1799 $repeatNotice->update($orig);
1804 function clearFaves()
1807 $fave->notice_id = $this->id;
1809 if ($fave->find()) {
1810 while ($fave->fetch()) {
1811 self::blow('fave:ids_by_user_own:%d', $fave->user_id);
1812 self::blow('fave:ids_by_user_own:%d;last', $fave->user_id);
1813 self::blow('fave:ids_by_user:%d', $fave->user_id);
1814 self::blow('fave:ids_by_user:%d;last', $fave->user_id);
1822 function clearTags()
1824 $tag = new Notice_tag();
1825 $tag->notice_id = $this->id;
1828 while ($tag->fetch()) {
1829 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, Cache::keyize($tag->tag));
1830 self::blow('profile:notice_ids_tagged:%d:%s;last', $this->profile_id, Cache::keyize($tag->tag));
1831 self::blow('notice_tag:notice_ids:%s', Cache::keyize($tag->tag));
1832 self::blow('notice_tag:notice_ids:%s;last', Cache::keyize($tag->tag));
1840 function clearGroupInboxes()
1842 $gi = new Group_inbox();
1844 $gi->notice_id = $this->id;
1847 while ($gi->fetch()) {
1848 self::blow('user_group:notice_ids:%d', $gi->group_id);
1856 function distribute()
1858 // We always insert for the author so they don't
1860 Event::handle('StartNoticeDistribute', array($this));
1862 $user = User::staticGet('id', $this->profile_id);
1863 if (!empty($user)) {
1864 Inbox::insertNotice($user->id, $this->id);
1867 if (common_config('queue', 'inboxes')) {
1868 // If there's a failure, we want to _force_
1869 // distribution at this point.
1871 $qm = QueueManager::get();
1872 $qm->enqueue($this, 'distrib');
1873 } catch (Exception $e) {
1874 // If the exception isn't transient, this
1875 // may throw more exceptions as DQH does
1876 // its own enqueueing. So, we ignore them!
1878 $handler = new DistribQueueHandler();
1879 $handler->handle($this);
1880 } catch (Exception $e) {
1881 common_log(LOG_ERR, "emergency redistribution resulted in " . $e->getMessage());
1883 // Re-throw so somebody smarter can handle it.
1887 $handler = new DistribQueueHandler();
1888 $handler->handle($this);
1894 $result = parent::insert();
1897 // Profile::hasRepeated() abuses pkeyGet(), so we
1898 // have to clear manually
1899 if (!empty($this->repeat_of)) {
1900 $c = self::memcache();
1902 $ck = self::multicacheKey('Notice',
1903 array('profile_id' => $this->profile_id,
1904 'repeat_of' => $this->repeat_of));
1914 * Get the source of the notice
1916 * @return Notice_source $ns A notice source object. 'code' is the only attribute
1917 * guaranteed to be populated.
1919 function getSource()
1921 $ns = new Notice_source();
1922 if (!empty($this->source)) {
1923 switch ($this->source) {
1930 $ns->code = $this->source;
1933 $ns = Notice_source::staticGet($this->source);
1935 $ns = new Notice_source();
1936 $ns->code = $this->source;
1937 $app = Oauth_application::staticGet('name', $this->source);
1939 $ns->name = $app->name;
1940 $ns->url = $app->source_url;
1950 * Determine whether the notice was locally created
1952 * @return boolean locality
1955 public function isLocal()
1957 return ($this->is_local == Notice::LOCAL_PUBLIC ||
1958 $this->is_local == Notice::LOCAL_NONPUBLIC);
1961 public function getTags()
1964 $tag = new Notice_tag();
1965 $tag->notice_id = $this->id;
1967 while ($tag->fetch()) {
1968 $tags[] = $tag->tag;
1975 static private function utcDate($dt)
1977 $dateStr = date('d F Y H:i:s', strtotime($dt));
1978 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1979 return $d->format(DATE_W3C);
1983 * Look up the creation timestamp for a given notice ID, even
1984 * if it's been deleted.
1987 * @return mixed string recorded creation timestamp, or false if can't be found
1989 public static function getAsTimestamp($id)
1995 $notice = Notice::staticGet('id', $id);
1997 return $notice->created;
2000 $deleted = Deleted_notice::staticGet('id', $id);
2002 return $deleted->created;
2009 * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2010 * parameter, matching notices posted after the given one (exclusive).
2012 * If the referenced notice can't be found, will return false.
2015 * @param string $idField
2016 * @param string $createdField
2017 * @return mixed string or false if no match
2019 public static function whereSinceId($id, $idField='id', $createdField='created')
2021 $since = Notice::getAsTimestamp($id);
2023 return sprintf("($createdField = '%s' and $idField > %d) or ($createdField > '%s')", $since, $id, $since);
2029 * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2030 * parameter, matching notices posted after the given one (exclusive), and
2031 * if necessary add it to the data object's query.
2033 * @param DB_DataObject $obj
2035 * @param string $idField
2036 * @param string $createdField
2037 * @return mixed string or false if no match
2039 public static function addWhereSinceId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2041 $since = self::whereSinceId($id, $idField, $createdField);
2043 $obj->whereAdd($since);
2048 * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2049 * parameter, matching notices posted before the given one (inclusive).
2051 * If the referenced notice can't be found, will return false.
2054 * @param string $idField
2055 * @param string $createdField
2056 * @return mixed string or false if no match
2058 public static function whereMaxId($id, $idField='id', $createdField='created')
2060 $max = Notice::getAsTimestamp($id);
2062 return sprintf("($createdField < '%s') or ($createdField = '%s' and $idField <= %d)", $max, $max, $id);
2068 * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2069 * parameter, matching notices posted before the given one (inclusive), and
2070 * if necessary add it to the data object's query.
2072 * @param DB_DataObject $obj
2074 * @param string $idField
2075 * @param string $createdField
2076 * @return mixed string or false if no match
2078 public static function addWhereMaxId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2080 $max = self::whereMaxId($id, $idField, $createdField);
2082 $obj->whereAdd($max);