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)
75 public $object_type; // varchar(255)
76 public $scope; // int(4)
79 function staticGet($k,$v=NULL)
81 return Memcached_DataObject::staticGet('Notice',$k,$v);
84 /* the code above is auto generated do not remove the tag below */
88 const LOCAL_PUBLIC = 1;
90 const LOCAL_NONPUBLIC = -1;
94 const ADDRESSEE_SCOPE = 2;
95 const FOLLOWER_SCOPE = 4;
99 $profile = Profile::staticGet('id', $this->profile_id);
101 if (empty($profile)) {
102 // TRANS: Server exception thrown when a user profile for a notice cannot be found.
103 // TRANS: %1$d is a profile ID (number), %2$d is a notice ID (number).
104 throw new ServerException(sprintf(_('No such profile (%1$d) for notice (%2$d).'), $this->profile_id, $this->id));
112 // For auditing purposes, save a record that the notice
115 // @fixme we have some cases where things get re-run and so the
117 $deleted = Deleted_notice::staticGet('id', $this->id);
120 $deleted = Deleted_notice::staticGet('uri', $this->uri);
124 $deleted = new Deleted_notice();
126 $deleted->id = $this->id;
127 $deleted->profile_id = $this->profile_id;
128 $deleted->uri = $this->uri;
129 $deleted->created = $this->created;
130 $deleted->deleted = common_sql_now();
135 if (Event::handle('NoticeDeleteRelated', array($this))) {
137 // Clear related records
139 $this->clearReplies();
140 $this->clearRepeats();
143 $this->clearGroupInboxes();
146 // NOTE: we don't clear inboxes
147 // NOTE: we don't clear queue items
150 $result = parent::delete();
152 $this->blowOnDelete();
157 * Extract #hashtags from this notice's content and save them to the database.
161 /* extract all #hastags */
162 $count = preg_match_all('/(?:^|\s)#([\pL\pN_\-\.]{1,64})/u', strtolower($this->content), $match);
167 /* Add them to the database */
168 return $this->saveKnownTags($match[1]);
172 * Record the given set of hash tags in the db for this notice.
173 * Given tag strings will be normalized and checked for dupes.
175 function saveKnownTags($hashtags)
177 //turn each into their canonical tag
178 //this is needed to remove dupes before saving e.g. #hash.tag = #hashtag
179 for($i=0; $i<count($hashtags); $i++) {
180 /* elide characters we don't want in the tag */
181 $hashtags[$i] = common_canonical_tag($hashtags[$i]);
184 foreach(array_unique($hashtags) as $hashtag) {
185 $this->saveTag($hashtag);
186 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, $hashtag);
192 * Record a single hash tag as associated with this notice.
193 * Tag format and uniqueness must be validated by caller.
195 function saveTag($hashtag)
197 $tag = new Notice_tag();
198 $tag->notice_id = $this->id;
199 $tag->tag = $hashtag;
200 $tag->created = $this->created;
201 $id = $tag->insert();
204 // TRANS: Server exception. %s are the error details.
205 throw new ServerException(sprintf(_('Database error inserting hashtag: %s'),
206 $last_error->message));
210 // if it's saved, blow its cache
211 $tag->blowCache(false);
215 * Save a new notice and push it out to subscribers' inboxes.
216 * Poster's permissions are checked before sending.
218 * @param int $profile_id Profile ID of the poster
219 * @param string $content source message text; links may be shortened
220 * per current user's preference
221 * @param string $source source key ('web', 'api', etc)
222 * @param array $options Associative array of optional properties:
223 * string 'created' timestamp of notice; defaults to now
224 * int 'is_local' source/gateway ID, one of:
225 * Notice::LOCAL_PUBLIC - Local, ok to appear in public timeline
226 * Notice::REMOTE_OMB - Sent from a remote OMB service;
227 * hide from public timeline but show in
228 * local "and friends" timelines
229 * Notice::LOCAL_NONPUBLIC - Local, but hide from public timeline
230 * Notice::GATEWAY - From another non-OMB service;
231 * will not appear in public views
232 * float 'lat' decimal latitude for geolocation
233 * float 'lon' decimal longitude for geolocation
234 * int 'location_id' geoname identifier
235 * int 'location_ns' geoname namespace to interpret location_id
236 * int 'reply_to'; notice ID this is a reply to
237 * int 'repeat_of'; notice ID this is a repeat of
238 * string 'uri' unique ID for notice; defaults to local notice URL
239 * string 'url' permalink to notice; defaults to local notice URL
240 * string 'rendered' rendered HTML version of content
241 * array 'replies' list of profile URIs for reply delivery in
242 * place of extracting @-replies from content.
243 * array 'groups' list of group IDs to deliver to, in place of
244 * extracting ! tags from content
245 * array 'tags' list of hashtag strings to save with the notice
246 * in place of extracting # tags from content
247 * array 'urls' list of attached/referred URLs to save with the
248 * notice in place of extracting links from content
249 * boolean 'distribute' whether to distribute the notice, default true
250 * string 'object_type' URL of the associated object type (default ActivityObject::NOTE)
252 * @fixme tag override
255 * @throws ClientException
257 static function saveNew($profile_id, $content, $source, $options=null) {
258 $defaults = array('uri' => null,
262 'distribute' => true);
264 if (!empty($options)) {
265 $options = $options + $defaults;
271 if (!isset($is_local)) {
272 $is_local = Notice::LOCAL_PUBLIC;
275 $profile = Profile::staticGet('id', $profile_id);
276 $user = User::staticGet('id', $profile_id);
278 // Use the local user's shortening preferences, if applicable.
279 $final = $user->shortenLinks($content);
281 $final = common_shorten_links($content);
284 if (Notice::contentTooLong($final)) {
285 // TRANS: Client exception thrown if a notice contains too many characters.
286 throw new ClientException(_('Problem saving notice. Too long.'));
289 if (empty($profile)) {
290 // TRANS: Client exception thrown when trying to save a notice for an unknown user.
291 throw new ClientException(_('Problem saving notice. Unknown user.'));
294 if (common_config('throttle', 'enabled') && !Notice::checkEditThrottle($profile_id)) {
295 common_log(LOG_WARNING, 'Excessive posting by profile #' . $profile_id . '; throttled.');
296 // TRANS: Client exception thrown when a user tries to post too many notices in a given time frame.
297 throw new ClientException(_('Too many notices too fast; take a breather '.
298 'and post again in a few minutes.'));
301 if (common_config('site', 'dupelimit') > 0 && !Notice::checkDupes($profile_id, $final)) {
302 common_log(LOG_WARNING, 'Dupe posting by profile #' . $profile_id . '; throttled.');
303 // TRANS: Client exception thrown when a user tries to post too many duplicate notices in a given time frame.
304 throw new ClientException(_('Too many duplicate messages too quickly;'.
305 ' take a breather and post again in a few minutes.'));
308 if (!$profile->hasRight(Right::NEWNOTICE)) {
309 common_log(LOG_WARNING, "Attempted post from user disallowed to post: " . $profile->nickname);
311 // TRANS: Client exception thrown when a user tries to post while being banned.
312 throw new ClientException(_('You are banned from posting notices on this site.'), 403);
315 $notice = new Notice();
316 $notice->profile_id = $profile_id;
318 $autosource = common_config('public', 'autosource');
320 // Sandboxed are non-false, but not 1, either
322 if (!$profile->hasRight(Right::PUBLICNOTICE) ||
323 ($source && $autosource && in_array($source, $autosource))) {
324 $notice->is_local = Notice::LOCAL_NONPUBLIC;
326 $notice->is_local = $is_local;
329 if (!empty($created)) {
330 $notice->created = $created;
332 $notice->created = common_sql_now();
335 $notice->content = $final;
337 $notice->source = $source;
341 // Handle repeat case
343 if (isset($repeat_of)) {
344 $notice->repeat_of = $repeat_of;
346 $notice->reply_to = self::getReplyTo($reply_to, $profile_id, $source, $final);
349 if (!empty($notice->reply_to)) {
350 $reply = Notice::staticGet('id', $notice->reply_to);
351 $notice->conversation = $reply->conversation;
354 if (!empty($lat) && !empty($lon)) {
359 if (!empty($location_ns) && !empty($location_id)) {
360 $notice->location_id = $location_id;
361 $notice->location_ns = $location_ns;
364 if (!empty($rendered)) {
365 $notice->rendered = $rendered;
367 $notice->rendered = common_render_content($final, $notice);
370 if (empty($object_type)) {
371 $notice->object_type = (empty($notice->reply_to)) ? ActivityObject::NOTE : ActivityObject::COMMENT;
373 $notice->object_type = $object_type;
376 if (Event::handle('StartNoticeSave', array(&$notice))) {
378 // XXX: some of these functions write to the DB
380 $id = $notice->insert();
383 common_log_db_error($notice, 'INSERT', __FILE__);
384 // TRANS: Server exception thrown when a notice cannot be saved.
385 throw new ServerException(_('Problem saving notice.'));
388 // Update ID-dependent columns: URI, conversation
390 $orig = clone($notice);
395 $notice->uri = common_notice_uri($notice);
399 // If it's not part of a conversation, it's
400 // the beginning of a new conversation.
402 if (empty($notice->conversation)) {
403 $conv = Conversation::create();
404 $notice->conversation = $conv->id;
409 if (!$notice->update($orig)) {
410 common_log_db_error($notice, 'UPDATE', __FILE__);
411 // TRANS: Server exception thrown when a notice cannot be updated.
412 throw new ServerException(_('Problem saving notice.'));
418 // Clear the cache for subscribed users, so they'll update at next request
419 // XXX: someone clever could prepend instead of clearing the cache
421 $notice->blowOnInsert();
423 // Save per-notice metadata...
425 if (isset($replies)) {
426 $notice->saveKnownReplies($replies);
428 $notice->saveReplies();
432 $notice->saveKnownTags($tags);
437 // Note: groups may save tags, so must be run after tags are saved
438 // to avoid errors on duplicates.
439 if (isset($groups)) {
440 $notice->saveKnownGroups($groups);
442 $notice->saveGroups();
446 $notice->saveKnownUrls($urls);
452 // Prepare inbox delivery, may be queued to background.
453 $notice->distribute();
459 function blowOnInsert($conversation = false)
461 self::blow('profile:notice_ids:%d', $this->profile_id);
463 if ($this->isPublic()) {
464 self::blow('public');
467 // XXX: Before we were blowing the casche only if the notice id
468 // was not the root of the conversation. What to do now?
470 self::blow('notice:conversation_ids:%d', $this->conversation);
472 if (!empty($this->repeat_of)) {
473 self::blow('notice:repeats:%d', $this->repeat_of);
476 $original = Notice::staticGet('id', $this->repeat_of);
478 if (!empty($original)) {
479 $originalUser = User::staticGet('id', $original->profile_id);
480 if (!empty($originalUser)) {
481 self::blow('user:repeats_of_me:%d', $originalUser->id);
485 $profile = Profile::staticGet($this->profile_id);
486 if (!empty($profile)) {
487 $profile->blowNoticeCount();
492 * Clear cache entries related to this notice at delete time.
493 * Necessary to avoid breaking paging on public, profile timelines.
495 function blowOnDelete()
497 $this->blowOnInsert();
499 self::blow('profile:notice_ids:%d;last', $this->profile_id);
501 if ($this->isPublic()) {
502 self::blow('public;last');
505 self::blow('fave:by_notice', $this->id);
507 if ($this->conversation) {
508 // In case we're the first, will need to calc a new root.
509 self::blow('notice:conversation_root:%d', $this->conversation);
513 /** save all urls in the notice to the db
515 * follow redirects and save all available file information
516 * (mimetype, date, size, oembed, etc.)
520 function saveUrls() {
521 if (common_config('attachments', 'process_links')) {
522 common_replace_urls_callback($this->content, array($this, 'saveUrl'), $this->id);
527 * Save the given URLs as related links/attachments to the db
529 * follow redirects and save all available file information
530 * (mimetype, date, size, oembed, etc.)
534 function saveKnownUrls($urls)
536 if (common_config('attachments', 'process_links')) {
537 // @fixme validation?
538 foreach (array_unique($urls) as $url) {
539 File::processNew($url, $this->id);
547 function saveUrl($url, $notice_id) {
548 File::processNew($url, $notice_id);
551 static function checkDupes($profile_id, $content) {
552 $profile = Profile::staticGet($profile_id);
553 if (empty($profile)) {
556 $notice = $profile->getNotices(0, NOTICE_CACHE_WINDOW);
557 if (!empty($notice)) {
559 while ($notice->fetch()) {
560 if (time() - strtotime($notice->created) >= common_config('site', 'dupelimit')) {
562 } else if ($notice->content == $content) {
567 // If we get here, oldest item in cache window is not
568 // old enough for dupe limit; do direct check against DB
569 $notice = new Notice();
570 $notice->profile_id = $profile_id;
571 $notice->content = $content;
572 $threshold = common_sql_date(time() - common_config('site', 'dupelimit'));
573 $notice->whereAdd(sprintf("created > '%s'", $notice->escape($threshold)));
575 $cnt = $notice->count();
579 static function checkEditThrottle($profile_id) {
580 $profile = Profile::staticGet($profile_id);
581 if (empty($profile)) {
584 // Get the Nth notice
585 $notice = $profile->getNotices(common_config('throttle', 'count') - 1, 1);
586 if ($notice && $notice->fetch()) {
587 // If the Nth notice was posted less than timespan seconds ago
588 if (time() - strtotime($notice->created) <= common_config('throttle', 'timespan')) {
593 // Either not N notices in the stream, OR the Nth was not posted within timespan seconds
597 function getUploadedAttachment() {
599 $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"';
600 $post->query($query);
602 if (empty($post->up) || empty($post->i)) {
605 $ret = array($post->up, $post->i);
611 function hasAttachments() {
613 $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);
614 $post->query($query);
616 $n_attachments = intval($post->n_attachments);
618 return $n_attachments;
621 function attachments() {
624 $f2p = new File_to_post;
625 $f2p->post_id = $this->id;
627 while ($f2p->fetch()) {
628 $f = File::staticGet($f2p->file_id);
637 function getStreamByIds($ids)
639 $cache = Cache::instance();
641 if (!empty($cache)) {
643 foreach ($ids as $id) {
644 $n = Notice::staticGet('id', $id);
649 return new ArrayWrapper($notices);
651 $notice = new Notice();
653 //if no IDs requested, just return the notice object
656 $notice->whereAdd('id in (' . implode(', ', $ids) . ')');
662 while ($notice->fetch()) {
663 $temp[$notice->id] = clone($notice);
668 foreach ($ids as $id) {
669 if (array_key_exists($id, $temp)) {
670 $wrapped[] = $temp[$id];
674 return new ArrayWrapper($wrapped);
678 function publicStream($offset=0, $limit=20, $since_id=0, $max_id=0)
680 $ids = Notice::stream(array('Notice', '_publicStreamDirect'),
683 $offset, $limit, $since_id, $max_id);
684 return Notice::getStreamByIds($ids);
687 function _publicStreamDirect($offset=0, $limit=20, $since_id=0, $max_id=0)
689 $notice = new Notice();
691 $notice->selectAdd(); // clears it
692 $notice->selectAdd('id');
694 $notice->orderBy('created DESC, id DESC');
696 if (!is_null($offset)) {
697 $notice->limit($offset, $limit);
700 if (common_config('public', 'localonly')) {
701 $notice->whereAdd('is_local = ' . Notice::LOCAL_PUBLIC);
703 // -1 == blacklisted, -2 == gateway (i.e. Twitter)
704 $notice->whereAdd('is_local !='. Notice::LOCAL_NONPUBLIC);
705 $notice->whereAdd('is_local !='. Notice::GATEWAY);
708 Notice::addWhereSinceId($notice, $since_id);
709 Notice::addWhereMaxId($notice, $max_id);
713 if ($notice->find()) {
714 while ($notice->fetch()) {
715 $ids[] = $notice->id;
725 function conversationStream($id, $offset=0, $limit=20, $since_id=0, $max_id=0)
727 $ids = Notice::stream(array('Notice', '_conversationStreamDirect'),
729 'notice:conversation_ids:'.$id,
730 $offset, $limit, $since_id, $max_id);
732 return Notice::getStreamByIds($ids);
735 function _conversationStreamDirect($id, $offset=0, $limit=20, $since_id=0, $max_id=0)
737 $notice = new Notice();
739 $notice->selectAdd(); // clears it
740 $notice->selectAdd('id');
742 $notice->conversation = $id;
744 $notice->orderBy('created DESC, id DESC');
746 if (!is_null($offset)) {
747 $notice->limit($offset, $limit);
750 Notice::addWhereSinceId($notice, $since_id);
751 Notice::addWhereMaxId($notice, $max_id);
755 if ($notice->find()) {
756 while ($notice->fetch()) {
757 $ids[] = $notice->id;
768 * Is this notice part of an active conversation?
770 * @return boolean true if other messages exist in the same
771 * conversation, false if this is the only one
773 function hasConversation()
775 if (!empty($this->conversation)) {
776 $conversation = Notice::conversationStream(
782 if ($conversation->N > 0) {
790 * Grab the earliest notice from this conversation.
792 * @return Notice or null
794 function conversationRoot()
796 if (!empty($this->conversation)) {
797 $c = self::memcache();
799 $key = Cache::key('notice:conversation_root:' . $this->conversation);
800 $notice = $c->get($key);
805 $notice = new Notice();
806 $notice->conversation = $this->conversation;
807 $notice->orderBy('CREATED');
812 $c->set($key, $notice);
819 * Pull up a full list of local recipients who will be getting
820 * this notice in their inbox. Results will be cached, so don't
821 * change the input data wily-nilly!
823 * @param array $groups optional list of Group objects;
824 * if left empty, will be loaded from group_inbox records
825 * @param array $recipient optional list of reply profile ids
826 * if left empty, will be loaded from reply records
827 * @return array associating recipient user IDs with an inbox source constant
829 function whoGets($groups=null, $recipients=null)
831 $c = self::memcache();
834 $ni = $c->get(Cache::key('notice:who_gets:'.$this->id));
840 if (is_null($groups)) {
841 $groups = $this->getGroups();
844 if (is_null($recipients)) {
845 $recipients = $this->getReplies();
848 $users = $this->getSubscribedUsers();
850 // FIXME: kind of ignoring 'transitional'...
851 // we'll probably stop supporting inboxless mode
856 // Give plugins a chance to add folks in at start...
857 if (Event::handle('StartNoticeWhoGets', array($this, &$ni))) {
859 foreach ($users as $id) {
860 $ni[$id] = NOTICE_INBOX_SOURCE_SUB;
863 foreach ($groups as $group) {
864 $users = $group->getUserMembers();
865 foreach ($users as $id) {
866 if (!array_key_exists($id, $ni)) {
867 $ni[$id] = NOTICE_INBOX_SOURCE_GROUP;
872 foreach ($recipients as $recipient) {
873 if (!array_key_exists($recipient, $ni)) {
874 $ni[$recipient] = NOTICE_INBOX_SOURCE_REPLY;
878 // Exclude any deleted, non-local, or blocking recipients.
879 $profile = $this->getProfile();
880 $originalProfile = null;
881 if ($this->repeat_of) {
882 // Check blocks against the original notice's poster as well.
883 $original = Notice::staticGet('id', $this->repeat_of);
885 $originalProfile = $original->getProfile();
888 foreach ($ni as $id => $source) {
889 $user = User::staticGet('id', $id);
890 if (empty($user) || $user->hasBlocked($profile) ||
891 ($originalProfile && $user->hasBlocked($originalProfile))) {
896 // Give plugins a chance to filter out...
897 Event::handle('EndNoticeWhoGets', array($this, &$ni));
901 // XXX: pack this data better
902 $c->set(Cache::key('notice:who_gets:'.$this->id), $ni);
909 * Adds this notice to the inboxes of each local user who should receive
910 * it, based on author subscriptions, group memberships, and @-replies.
912 * Warning: running a second time currently will make items appear
913 * multiple times in users' inboxes.
915 * @fixme make more robust against errors
916 * @fixme break up massive deliveries to smaller background tasks
918 * @param array $groups optional list of Group objects;
919 * if left empty, will be loaded from group_inbox records
920 * @param array $recipient optional list of reply profile ids
921 * if left empty, will be loaded from reply records
923 function addToInboxes($groups=null, $recipients=null)
925 $ni = $this->whoGets($groups, $recipients);
927 $ids = array_keys($ni);
929 // We remove the author (if they're a local user),
930 // since we'll have already done this in distribute()
932 $i = array_search($this->profile_id, $ids);
940 Inbox::bulkInsert($this->id, $ids);
945 function getSubscribedUsers()
949 if(common_config('db','quote_identifiers'))
950 $user_table = '"user"';
951 else $user_table = 'user';
955 'FROM '. $user_table .' JOIN subscription '.
956 'ON '. $user_table .'.id = subscription.subscriber ' .
957 'WHERE subscription.subscribed = %d ';
959 $user->query(sprintf($qry, $this->profile_id));
963 while ($user->fetch()) {
973 * Record this notice to the given group inboxes for delivery.
974 * Overrides the regular parsing of !group markup.
976 * @param string $group_ids
977 * @fixme might prefer URIs as identifiers, as for replies?
978 * best with generalizations on user_group to support
979 * remote groups better.
981 function saveKnownGroups($group_ids)
983 if (!is_array($group_ids)) {
984 // TRANS: Server exception thrown when no array is provided to the method saveKnownGroups().
985 throw new ServerException(_('Bad type provided to saveKnownGroups.'));
989 foreach (array_unique($group_ids) as $id) {
990 $group = User_group::staticGet('id', $id);
992 common_log(LOG_ERR, "Local delivery to group id $id, $group->nickname");
993 $result = $this->addToGroupInbox($group);
995 common_log_db_error($gi, 'INSERT', __FILE__);
998 // @fixme should we save the tags here or not?
999 $groups[] = clone($group);
1001 common_log(LOG_ERR, "Local delivery to group id $id skipped, doesn't exist");
1009 * Parse !group delivery and record targets into group_inbox.
1010 * @return array of Group objects
1012 function saveGroups()
1014 // Don't save groups for repeats
1016 if (!empty($this->repeat_of)) {
1022 /* extract all !group */
1023 $count = preg_match_all('/(?:^|\s)!(' . Nickname::DISPLAY_FMT . ')/',
1024 strtolower($this->content),
1030 $profile = $this->getProfile();
1032 /* Add them to the database */
1034 foreach (array_unique($match[1]) as $nickname) {
1035 /* XXX: remote groups. */
1036 $group = User_group::getForNickname($nickname, $profile);
1038 if (empty($group)) {
1042 // we automatically add a tag for every group name, too
1044 $tag = Notice_tag::pkeyGet(array('tag' => common_canonical_tag($nickname),
1045 'notice_id' => $this->id));
1047 if (is_null($tag)) {
1048 $this->saveTag($nickname);
1051 if ($profile->isMember($group)) {
1053 $result = $this->addToGroupInbox($group);
1056 common_log_db_error($gi, 'INSERT', __FILE__);
1059 $groups[] = clone($group);
1066 function addToGroupInbox($group)
1068 $gi = Group_inbox::pkeyGet(array('group_id' => $group->id,
1069 'notice_id' => $this->id));
1073 $gi = new Group_inbox();
1075 $gi->group_id = $group->id;
1076 $gi->notice_id = $this->id;
1077 $gi->created = $this->created;
1079 $result = $gi->insert();
1082 common_log_db_error($gi, 'INSERT', __FILE__);
1083 // TRANS: Server exception thrown when an update for a group inbox fails.
1084 throw new ServerException(_('Problem saving group inbox.'));
1087 self::blow('user_group:notice_ids:%d', $gi->group_id);
1094 * Save reply records indicating that this notice needs to be
1095 * delivered to the local users with the given URIs.
1097 * Since this is expected to be used when saving foreign-sourced
1098 * messages, we won't deliver to any remote targets as that's the
1099 * source service's responsibility.
1101 * Mail notifications etc will be handled later.
1103 * @param array of unique identifier URIs for recipients
1105 function saveKnownReplies($uris)
1111 $sender = Profile::staticGet($this->profile_id);
1113 foreach (array_unique($uris) as $uri) {
1115 $profile = Profile::fromURI($uri);
1117 if (empty($profile)) {
1118 common_log(LOG_WARNING, "Unable to determine profile for URI '$uri'");
1122 if ($profile->hasBlocked($sender)) {
1123 common_log(LOG_INFO, "Not saving reply to profile {$profile->id} ($uri) from sender {$sender->id} because of a block.");
1127 $reply = new Reply();
1129 $reply->notice_id = $this->id;
1130 $reply->profile_id = $profile->id;
1131 $reply->modified = $this->created;
1133 common_log(LOG_INFO, __METHOD__ . ": saving reply: notice $this->id to profile $profile->id");
1135 $id = $reply->insert();
1142 * Pull @-replies from this message's content in StatusNet markup format
1143 * and save reply records indicating that this message needs to be
1144 * delivered to those users.
1146 * Mail notifications to local profiles will be sent later.
1148 * @return array of integer profile IDs
1151 function saveReplies()
1153 // Don't save reply data for repeats
1155 if (!empty($this->repeat_of)) {
1159 $sender = Profile::staticGet($this->profile_id);
1161 // @todo ideally this parser information would only
1162 // be calculated once.
1164 $mentions = common_find_mentions($this->content, $this);
1168 // store replied only for first @ (what user/notice what the reply directed,
1169 // we assume first @ is it)
1171 foreach ($mentions as $mention) {
1173 foreach ($mention['mentioned'] as $mentioned) {
1175 // skip if they're already covered
1177 if (!empty($replied[$mentioned->id])) {
1181 // Don't save replies from blocked profile to local user
1183 $mentioned_user = User::staticGet('id', $mentioned->id);
1184 if (!empty($mentioned_user) && $mentioned_user->hasBlocked($sender)) {
1188 $reply = new Reply();
1190 $reply->notice_id = $this->id;
1191 $reply->profile_id = $mentioned->id;
1192 $reply->modified = $this->created;
1194 $id = $reply->insert();
1197 common_log_db_error($reply, 'INSERT', __FILE__);
1198 // TRANS: Server exception thrown when a reply cannot be saved.
1199 // TRANS: %1$d is a notice ID, %2$d is the ID of the mentioned user.
1200 throw new ServerException(sprintf(_('Could not save reply for %1$d, %2$d.'), $this->id, $mentioned->id));
1202 $replied[$mentioned->id] = 1;
1203 self::blow('reply:stream:%d', $mentioned->id);
1208 $recipientIds = array_keys($replied);
1210 return $recipientIds;
1214 * Pull the complete list of @-reply targets for this notice.
1216 * @return array of integer profile ids
1218 function getReplies()
1224 $reply = new Reply();
1225 $reply->selectAdd();
1226 $reply->selectAdd('profile_id');
1227 $reply->notice_id = $this->id;
1229 if ($reply->find()) {
1230 while($reply->fetch()) {
1231 $ids[] = $reply->profile_id;
1241 * Send e-mail notifications to local @-reply targets.
1243 * Replies must already have been saved; this is expected to be run
1244 * from the distrib queue handler.
1246 function sendReplyNotifications()
1248 // Don't send reply notifications for repeats
1250 if (!empty($this->repeat_of)) {
1254 $recipientIds = $this->getReplies();
1256 foreach ($recipientIds as $recipientId) {
1257 $user = User::staticGet('id', $recipientId);
1258 if (!empty($user)) {
1259 mail_notify_attn($user, $this);
1265 * Pull list of groups this notice needs to be delivered to,
1266 * as previously recorded by saveGroups() or saveKnownGroups().
1268 * @return array of Group objects
1270 function getGroups()
1272 // Don't save groups for repeats
1274 if (!empty($this->repeat_of)) {
1282 $gi = new Group_inbox();
1285 $gi->selectAdd('group_id');
1287 $gi->notice_id = $this->id;
1290 while ($gi->fetch()) {
1291 $group = User_group::staticGet('id', $gi->group_id);
1304 * Convert a notice into an activity for export.
1306 * @param User $cur Current user
1308 * @return Activity activity object representing this Notice.
1311 function asActivity($cur)
1313 $act = self::cacheGet(Cache::codeKey('notice:as-activity:'.$this->id));
1318 $act = new Activity();
1320 if (Event::handle('StartNoticeAsActivity', array($this, &$act))) {
1322 $profile = $this->getProfile();
1324 $act->actor = ActivityObject::fromProfile($profile);
1325 $act->actor->extra[] = $profile->profileInfo($cur);
1326 $act->verb = ActivityVerb::POST;
1327 $act->objects[] = ActivityObject::fromNotice($this);
1329 // XXX: should this be handled by default processing for object entry?
1331 $act->time = strtotime($this->created);
1332 $act->link = $this->bestUrl();
1334 $act->content = common_xml_safe_str($this->rendered);
1335 $act->id = $this->uri;
1336 $act->title = common_xml_safe_str($this->content);
1340 $tags = $this->getTags();
1342 foreach ($tags as $tag) {
1343 $cat = new AtomCategory();
1346 $act->categories[] = $cat;
1350 // XXX: use Atom Media and/or File activity objects instead
1352 $attachments = $this->attachments();
1354 foreach ($attachments as $attachment) {
1355 $enclosure = $attachment->getEnclosure();
1357 $act->enclosures[] = $enclosure;
1361 $ctx = new ActivityContext();
1363 if (!empty($this->reply_to)) {
1364 $reply = Notice::staticGet('id', $this->reply_to);
1365 if (!empty($reply)) {
1366 $ctx->replyToID = $reply->uri;
1367 $ctx->replyToUrl = $reply->bestUrl();
1371 $ctx->location = $this->getLocation();
1375 if (!empty($this->conversation)) {
1376 $conv = Conversation::staticGet('id', $this->conversation);
1377 if (!empty($conv)) {
1378 $ctx->conversation = $conv->uri;
1382 $reply_ids = $this->getReplies();
1384 foreach ($reply_ids as $id) {
1385 $profile = Profile::staticGet('id', $id);
1386 if (!empty($profile)) {
1387 $ctx->attention[] = $profile->getUri();
1391 $groups = $this->getGroups();
1393 foreach ($groups as $group) {
1394 $ctx->attention[] = $group->getUri();
1397 // XXX: deprecated; use ActivityVerb::SHARE instead
1401 if (!empty($this->repeat_of)) {
1402 $repeat = Notice::staticGet('id', $this->repeat_of);
1403 $ctx->forwardID = $repeat->uri;
1404 $ctx->forwardUrl = $repeat->bestUrl();
1407 $act->context = $ctx;
1411 $atom_feed = $profile->getAtomFeed();
1413 if (!empty($atom_feed)) {
1415 $act->source = new ActivitySource();
1417 // XXX: we should store the actual feed ID
1419 $act->source->id = $atom_feed;
1421 // XXX: we should store the actual feed title
1423 $act->source->title = $profile->getBestName();
1425 $act->source->links['alternate'] = $profile->profileurl;
1426 $act->source->links['self'] = $atom_feed;
1428 $act->source->icon = $profile->avatarUrl(AVATAR_PROFILE_SIZE);
1430 $notice = $profile->getCurrentNotice();
1432 if (!empty($notice)) {
1433 $act->source->updated = self::utcDate($notice->created);
1436 $user = User::staticGet('id', $profile->id);
1438 if (!empty($user)) {
1439 $act->source->links['license'] = common_config('license', 'url');
1443 if ($this->isLocal()) {
1444 $act->selfLink = common_local_url('ApiStatusesShow', array('id' => $this->id,
1445 'format' => 'atom'));
1446 $act->editLink = $act->selfLink;
1449 Event::handle('EndNoticeAsActivity', array($this, &$act));
1452 self::cacheSet(Cache::codeKey('notice:as-activity:'.$this->id), $act);
1457 // This has gotten way too long. Needs to be sliced up into functional bits
1458 // or ideally exported to a utility class.
1460 function asAtomEntry($namespace=false,
1465 $act = $this->asActivity($cur);
1466 $act->extra[] = $this->noticeInfo($cur);
1467 return $act->asString($namespace, $author, $source);
1471 * Extra notice info for atom entries
1473 * Clients use some extra notice info in the atom stream.
1474 * This gives it to them.
1476 * @param User $cur Current user
1478 * @return array representation of <statusnet:notice_info> element
1481 function noticeInfo($cur)
1483 // local notice ID (useful to clients for ordering)
1485 $noticeInfoAttr = array('local_id' => $this->id);
1489 $ns = $this->getSource();
1492 $noticeInfoAttr['source'] = $ns->code;
1493 if (!empty($ns->url)) {
1494 $noticeInfoAttr['source_link'] = $ns->url;
1495 if (!empty($ns->name)) {
1496 $noticeInfoAttr['source'] = '<a href="'
1497 . htmlspecialchars($ns->url)
1498 . '" rel="nofollow">'
1499 . htmlspecialchars($ns->name)
1505 // favorite and repeated
1508 $noticeInfoAttr['favorite'] = ($cur->hasFave($this)) ? "true" : "false";
1509 $cp = $cur->getProfile();
1510 $noticeInfoAttr['repeated'] = ($cp->hasRepeated($this->id)) ? "true" : "false";
1513 if (!empty($this->repeat_of)) {
1514 $noticeInfoAttr['repeat_of'] = $this->repeat_of;
1517 return array('statusnet:notice_info', $noticeInfoAttr, null);
1521 * Returns an XML string fragment with a reference to a notice as an
1522 * Activity Streams noun object with the given element type.
1524 * Assumes that 'activity' namespace has been previously defined.
1526 * @param string $element one of 'subject', 'object', 'target'
1530 function asActivityNoun($element)
1532 $noun = ActivityObject::fromNotice($this);
1533 return $noun->asString('activity:' . $element);
1538 if (!empty($this->url)) {
1540 } else if (!empty($this->uri) && preg_match('/^https?:/', $this->uri)) {
1543 return common_local_url('shownotice',
1544 array('notice' => $this->id));
1548 function stream($fn, $args, $cachekey, $offset=0, $limit=20, $since_id=0, $max_id=0)
1550 $cache = Cache::instance();
1552 if (empty($cache) ||
1553 $since_id != 0 || $max_id != 0 ||
1555 ($offset + $limit) > NOTICE_CACHE_WINDOW) {
1556 return call_user_func_array($fn, array_merge($args, array($offset, $limit, $since_id,
1560 $idkey = Cache::key($cachekey);
1562 $idstr = $cache->get($idkey);
1564 if ($idstr !== false) {
1565 // Cache hit! Woohoo!
1566 $window = explode(',', $idstr);
1567 $ids = array_slice($window, $offset, $limit);
1571 $laststr = $cache->get($idkey.';last');
1573 if ($laststr !== false) {
1574 $window = explode(',', $laststr);
1575 $last_id = $window[0];
1576 $new_ids = call_user_func_array($fn, array_merge($args, array(0, NOTICE_CACHE_WINDOW,
1577 $last_id, 0, null)));
1579 $new_window = array_merge($new_ids, $window);
1581 $new_windowstr = implode(',', $new_window);
1583 $result = $cache->set($idkey, $new_windowstr);
1584 $result = $cache->set($idkey . ';last', $new_windowstr);
1586 $ids = array_slice($new_window, $offset, $limit);
1591 $window = call_user_func_array($fn, array_merge($args, array(0, NOTICE_CACHE_WINDOW,
1594 $windowstr = implode(',', $window);
1596 $result = $cache->set($idkey, $windowstr);
1597 $result = $cache->set($idkey . ';last', $windowstr);
1599 $ids = array_slice($window, $offset, $limit);
1605 * Determine which notice, if any, a new notice is in reply to.
1607 * For conversation tracking, we try to see where this notice fits
1608 * in the tree. Rough algorithm is:
1610 * if (reply_to is set and valid) {
1612 * } else if ((source not API or Web) and (content starts with "T NAME" or "@name ")) {
1613 * return ID of last notice by initial @name in content;
1616 * Note that all @nickname instances will still be used to save "reply" records,
1617 * so the notice shows up in the mentioned users' "replies" tab.
1619 * @param integer $reply_to ID passed in by Web or API
1620 * @param integer $profile_id ID of author
1621 * @param string $source Source tag, like 'web' or 'gwibber'
1622 * @param string $content Final notice content
1624 * @return integer ID of replied-to notice, or null for not a reply.
1627 static function getReplyTo($reply_to, $profile_id, $source, $content)
1629 static $lb = array('xmpp', 'mail', 'sms', 'omb');
1631 // If $reply_to is specified, we check that it exists, and then
1632 // return it if it does
1634 if (!empty($reply_to)) {
1635 $reply_notice = Notice::staticGet('id', $reply_to);
1636 if (!empty($reply_notice)) {
1641 // If it's not a "low bandwidth" source (one where you can't set
1642 // a reply_to argument), we return. This is mostly web and API
1645 if (!in_array($source, $lb)) {
1649 // Is there an initial @ or T?
1651 if (preg_match('/^T ([A-Z0-9]{1,64}) /', $content, $match) ||
1652 preg_match('/^@([a-z0-9]{1,64})\s+/', $content, $match)) {
1653 $nickname = common_canonical_nickname($match[1]);
1658 // Figure out who that is.
1660 $sender = Profile::staticGet('id', $profile_id);
1661 if (empty($sender)) {
1665 $recipient = common_relative_profile($sender, $nickname, common_sql_now());
1667 if (empty($recipient)) {
1671 // Get their last notice
1673 $last = $recipient->getCurrentNotice();
1675 if (!empty($last)) {
1680 static function maxContent()
1682 $contentlimit = common_config('notice', 'contentlimit');
1683 // null => use global limit (distinct from 0!)
1684 if (is_null($contentlimit)) {
1685 $contentlimit = common_config('site', 'textlimit');
1687 return $contentlimit;
1690 static function contentTooLong($content)
1692 $contentlimit = self::maxContent();
1693 return ($contentlimit > 0 && !empty($content) && (mb_strlen($content) > $contentlimit));
1696 function getLocation()
1700 if (!empty($this->location_id) && !empty($this->location_ns)) {
1701 $location = Location::fromId($this->location_id, $this->location_ns);
1704 if (is_null($location)) { // no ID, or Location::fromId() failed
1705 if (!empty($this->lat) && !empty($this->lon)) {
1706 $location = Location::fromLatLon($this->lat, $this->lon);
1713 function repeat($repeater_id, $source)
1715 $author = Profile::staticGet('id', $this->profile_id);
1717 // TRANS: Message used to repeat a notice. RT is the abbreviation of 'retweet'.
1718 // TRANS: %1$s is the repeated user's name, %2$s is the repeated notice.
1719 $content = sprintf(_('RT @%1$s %2$s'),
1723 $maxlen = common_config('site', 'textlimit');
1724 if ($maxlen > 0 && mb_strlen($content) > $maxlen) {
1725 // Web interface and current Twitter API clients will
1726 // pull the original notice's text, but some older
1727 // clients and RSS/Atom feeds will see this trimmed text.
1729 // Unfortunately this is likely to lose tags or URLs
1730 // at the end of long notices.
1731 $content = mb_substr($content, 0, $maxlen - 4) . ' ...';
1734 return self::saveNew($repeater_id, $content, $source,
1735 array('repeat_of' => $this->id));
1738 // These are supposed to be in chron order!
1740 function repeatStream($limit=100)
1742 $cache = Cache::instance();
1744 if (empty($cache)) {
1745 $ids = $this->_repeatStreamDirect($limit);
1747 $idstr = $cache->get(Cache::key('notice:repeats:'.$this->id));
1748 if ($idstr !== false) {
1749 $ids = explode(',', $idstr);
1751 $ids = $this->_repeatStreamDirect(100);
1752 $cache->set(Cache::key('notice:repeats:'.$this->id), implode(',', $ids));
1755 // We do a max of 100, so slice down to limit
1756 $ids = array_slice($ids, 0, $limit);
1760 return Notice::getStreamByIds($ids);
1763 function _repeatStreamDirect($limit)
1765 $notice = new Notice();
1767 $notice->selectAdd(); // clears it
1768 $notice->selectAdd('id');
1770 $notice->repeat_of = $this->id;
1772 $notice->orderBy('created, id'); // NB: asc!
1774 if (!is_null($limit)) {
1775 $notice->limit(0, $limit);
1780 if ($notice->find()) {
1781 while ($notice->fetch()) {
1782 $ids[] = $notice->id;
1792 function locationOptions($lat, $lon, $location_id, $location_ns, $profile = null)
1796 if (!empty($location_id) && !empty($location_ns)) {
1797 $options['location_id'] = $location_id;
1798 $options['location_ns'] = $location_ns;
1800 $location = Location::fromId($location_id, $location_ns);
1802 if (!empty($location)) {
1803 $options['lat'] = $location->lat;
1804 $options['lon'] = $location->lon;
1807 } else if (!empty($lat) && !empty($lon)) {
1808 $options['lat'] = $lat;
1809 $options['lon'] = $lon;
1811 $location = Location::fromLatLon($lat, $lon);
1813 if (!empty($location)) {
1814 $options['location_id'] = $location->location_id;
1815 $options['location_ns'] = $location->location_ns;
1817 } else if (!empty($profile)) {
1818 if (isset($profile->lat) && isset($profile->lon)) {
1819 $options['lat'] = $profile->lat;
1820 $options['lon'] = $profile->lon;
1823 if (isset($profile->location_id) && isset($profile->location_ns)) {
1824 $options['location_id'] = $profile->location_id;
1825 $options['location_ns'] = $profile->location_ns;
1832 function clearReplies()
1834 $replyNotice = new Notice();
1835 $replyNotice->reply_to = $this->id;
1837 //Null any notices that are replies to this notice
1839 if ($replyNotice->find()) {
1840 while ($replyNotice->fetch()) {
1841 $orig = clone($replyNotice);
1842 $replyNotice->reply_to = null;
1843 $replyNotice->update($orig);
1849 $reply = new Reply();
1850 $reply->notice_id = $this->id;
1852 if ($reply->find()) {
1853 while($reply->fetch()) {
1854 self::blow('reply:stream:%d', $reply->profile_id);
1862 function clearFiles()
1864 $f2p = new File_to_post();
1866 $f2p->post_id = $this->id;
1869 while ($f2p->fetch()) {
1873 // FIXME: decide whether to delete File objects
1874 // ...and related (actual) files
1877 function clearRepeats()
1879 $repeatNotice = new Notice();
1880 $repeatNotice->repeat_of = $this->id;
1882 //Null any notices that are repeats of this notice
1884 if ($repeatNotice->find()) {
1885 while ($repeatNotice->fetch()) {
1886 $orig = clone($repeatNotice);
1887 $repeatNotice->repeat_of = null;
1888 $repeatNotice->update($orig);
1893 function clearFaves()
1896 $fave->notice_id = $this->id;
1898 if ($fave->find()) {
1899 while ($fave->fetch()) {
1900 self::blow('fave:ids_by_user_own:%d', $fave->user_id);
1901 self::blow('fave:ids_by_user_own:%d;last', $fave->user_id);
1902 self::blow('fave:ids_by_user:%d', $fave->user_id);
1903 self::blow('fave:ids_by_user:%d;last', $fave->user_id);
1911 function clearTags()
1913 $tag = new Notice_tag();
1914 $tag->notice_id = $this->id;
1917 while ($tag->fetch()) {
1918 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, Cache::keyize($tag->tag));
1919 self::blow('profile:notice_ids_tagged:%d:%s;last', $this->profile_id, Cache::keyize($tag->tag));
1920 self::blow('notice_tag:notice_ids:%s', Cache::keyize($tag->tag));
1921 self::blow('notice_tag:notice_ids:%s;last', Cache::keyize($tag->tag));
1929 function clearGroupInboxes()
1931 $gi = new Group_inbox();
1933 $gi->notice_id = $this->id;
1936 while ($gi->fetch()) {
1937 self::blow('user_group:notice_ids:%d', $gi->group_id);
1945 function distribute()
1947 // We always insert for the author so they don't
1949 Event::handle('StartNoticeDistribute', array($this));
1951 $user = User::staticGet('id', $this->profile_id);
1952 if (!empty($user)) {
1953 Inbox::insertNotice($user->id, $this->id);
1956 if (common_config('queue', 'inboxes')) {
1957 // If there's a failure, we want to _force_
1958 // distribution at this point.
1960 $qm = QueueManager::get();
1961 $qm->enqueue($this, 'distrib');
1962 } catch (Exception $e) {
1963 // If the exception isn't transient, this
1964 // may throw more exceptions as DQH does
1965 // its own enqueueing. So, we ignore them!
1967 $handler = new DistribQueueHandler();
1968 $handler->handle($this);
1969 } catch (Exception $e) {
1970 common_log(LOG_ERR, "emergency redistribution resulted in " . $e->getMessage());
1972 // Re-throw so somebody smarter can handle it.
1976 $handler = new DistribQueueHandler();
1977 $handler->handle($this);
1983 $result = parent::insert();
1986 // Profile::hasRepeated() abuses pkeyGet(), so we
1987 // have to clear manually
1988 if (!empty($this->repeat_of)) {
1989 $c = self::memcache();
1991 $ck = self::multicacheKey('Notice',
1992 array('profile_id' => $this->profile_id,
1993 'repeat_of' => $this->repeat_of));
2003 * Get the source of the notice
2005 * @return Notice_source $ns A notice source object. 'code' is the only attribute
2006 * guaranteed to be populated.
2008 function getSource()
2010 $ns = new Notice_source();
2011 if (!empty($this->source)) {
2012 switch ($this->source) {
2019 $ns->code = $this->source;
2022 $ns = Notice_source::staticGet($this->source);
2024 $ns = new Notice_source();
2025 $ns->code = $this->source;
2026 $app = Oauth_application::staticGet('name', $this->source);
2028 $ns->name = $app->name;
2029 $ns->url = $app->source_url;
2039 * Determine whether the notice was locally created
2041 * @return boolean locality
2044 public function isLocal()
2046 return ($this->is_local == Notice::LOCAL_PUBLIC ||
2047 $this->is_local == Notice::LOCAL_NONPUBLIC);
2051 * Get the list of hash tags saved with this notice.
2053 * @return array of strings
2055 public function getTags()
2058 $tag = new Notice_tag();
2059 $tag->notice_id = $this->id;
2061 while ($tag->fetch()) {
2062 $tags[] = $tag->tag;
2069 static private function utcDate($dt)
2071 $dateStr = date('d F Y H:i:s', strtotime($dt));
2072 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
2073 return $d->format(DATE_W3C);
2077 * Look up the creation timestamp for a given notice ID, even
2078 * if it's been deleted.
2081 * @return mixed string recorded creation timestamp, or false if can't be found
2083 public static function getAsTimestamp($id)
2089 $notice = Notice::staticGet('id', $id);
2091 return $notice->created;
2094 $deleted = Deleted_notice::staticGet('id', $id);
2096 return $deleted->created;
2103 * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2104 * parameter, matching notices posted after the given one (exclusive).
2106 * If the referenced notice can't be found, will return false.
2109 * @param string $idField
2110 * @param string $createdField
2111 * @return mixed string or false if no match
2113 public static function whereSinceId($id, $idField='id', $createdField='created')
2115 $since = Notice::getAsTimestamp($id);
2117 return sprintf("($createdField = '%s' and $idField > %d) or ($createdField > '%s')", $since, $id, $since);
2123 * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2124 * parameter, matching notices posted after the given one (exclusive), and
2125 * if necessary add it to the data object's query.
2127 * @param DB_DataObject $obj
2129 * @param string $idField
2130 * @param string $createdField
2131 * @return mixed string or false if no match
2133 public static function addWhereSinceId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2135 $since = self::whereSinceId($id, $idField, $createdField);
2137 $obj->whereAdd($since);
2142 * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2143 * parameter, matching notices posted before the given one (inclusive).
2145 * If the referenced notice can't be found, will return false.
2148 * @param string $idField
2149 * @param string $createdField
2150 * @return mixed string or false if no match
2152 public static function whereMaxId($id, $idField='id', $createdField='created')
2154 $max = Notice::getAsTimestamp($id);
2156 return sprintf("($createdField < '%s') or ($createdField = '%s' and $idField <= %d)", $max, $max, $id);
2162 * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2163 * parameter, matching notices posted before the given one (inclusive), and
2164 * if necessary add it to the data object's query.
2166 * @param DB_DataObject $obj
2168 * @param string $idField
2169 * @param string $createdField
2170 * @return mixed string or false if no match
2172 public static function addWhereMaxId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2174 $max = self::whereMaxId($id, $idField, $createdField);
2176 $obj->whereAdd($max);
2182 if (common_config('public', 'localonly')) {
2183 return ($this->is_local == Notice::LOCAL_PUBLIC);
2185 return (($this->is_local != Notice::LOCAL_NONPUBLIC) &&
2186 ($this->is_local != Notice::GATEWAY));