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 GROUP_SCOPE = 4;
96 const FOLLOWER_SCOPE = 8;
100 $profile = Profile::staticGet('id', $this->profile_id);
102 if (empty($profile)) {
103 // TRANS: Server exception thrown when a user profile for a notice cannot be found.
104 // TRANS: %1$d is a profile ID (number), %2$d is a notice ID (number).
105 throw new ServerException(sprintf(_('No such profile (%1$d) for notice (%2$d).'), $this->profile_id, $this->id));
113 // For auditing purposes, save a record that the notice
116 // @fixme we have some cases where things get re-run and so the
118 $deleted = Deleted_notice::staticGet('id', $this->id);
121 $deleted = Deleted_notice::staticGet('uri', $this->uri);
125 $deleted = new Deleted_notice();
127 $deleted->id = $this->id;
128 $deleted->profile_id = $this->profile_id;
129 $deleted->uri = $this->uri;
130 $deleted->created = $this->created;
131 $deleted->deleted = common_sql_now();
136 if (Event::handle('NoticeDeleteRelated', array($this))) {
138 // Clear related records
140 $this->clearReplies();
141 $this->clearRepeats();
144 $this->clearGroupInboxes();
147 // NOTE: we don't clear inboxes
148 // NOTE: we don't clear queue items
151 $result = parent::delete();
153 $this->blowOnDelete();
158 * Extract #hashtags from this notice's content and save them to the database.
162 /* extract all #hastags */
163 $count = preg_match_all('/(?:^|\s)#([\pL\pN_\-\.]{1,64})/u', strtolower($this->content), $match);
168 /* Add them to the database */
169 return $this->saveKnownTags($match[1]);
173 * Record the given set of hash tags in the db for this notice.
174 * Given tag strings will be normalized and checked for dupes.
176 function saveKnownTags($hashtags)
178 //turn each into their canonical tag
179 //this is needed to remove dupes before saving e.g. #hash.tag = #hashtag
180 for($i=0; $i<count($hashtags); $i++) {
181 /* elide characters we don't want in the tag */
182 $hashtags[$i] = common_canonical_tag($hashtags[$i]);
185 foreach(array_unique($hashtags) as $hashtag) {
186 $this->saveTag($hashtag);
187 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, $hashtag);
193 * Record a single hash tag as associated with this notice.
194 * Tag format and uniqueness must be validated by caller.
196 function saveTag($hashtag)
198 $tag = new Notice_tag();
199 $tag->notice_id = $this->id;
200 $tag->tag = $hashtag;
201 $tag->created = $this->created;
202 $id = $tag->insert();
205 // TRANS: Server exception. %s are the error details.
206 throw new ServerException(sprintf(_('Database error inserting hashtag: %s'),
207 $last_error->message));
211 // if it's saved, blow its cache
212 $tag->blowCache(false);
216 * Save a new notice and push it out to subscribers' inboxes.
217 * Poster's permissions are checked before sending.
219 * @param int $profile_id Profile ID of the poster
220 * @param string $content source message text; links may be shortened
221 * per current user's preference
222 * @param string $source source key ('web', 'api', etc)
223 * @param array $options Associative array of optional properties:
224 * string 'created' timestamp of notice; defaults to now
225 * int 'is_local' source/gateway ID, one of:
226 * Notice::LOCAL_PUBLIC - Local, ok to appear in public timeline
227 * Notice::REMOTE_OMB - Sent from a remote OMB service;
228 * hide from public timeline but show in
229 * local "and friends" timelines
230 * Notice::LOCAL_NONPUBLIC - Local, but hide from public timeline
231 * Notice::GATEWAY - From another non-OMB service;
232 * will not appear in public views
233 * float 'lat' decimal latitude for geolocation
234 * float 'lon' decimal longitude for geolocation
235 * int 'location_id' geoname identifier
236 * int 'location_ns' geoname namespace to interpret location_id
237 * int 'reply_to'; notice ID this is a reply to
238 * int 'repeat_of'; notice ID this is a repeat of
239 * string 'uri' unique ID for notice; defaults to local notice URL
240 * string 'url' permalink to notice; defaults to local notice URL
241 * string 'rendered' rendered HTML version of content
242 * array 'replies' list of profile URIs for reply delivery in
243 * place of extracting @-replies from content.
244 * array 'groups' list of group IDs to deliver to, in place of
245 * extracting ! tags from content
246 * array 'tags' list of hashtag strings to save with the notice
247 * in place of extracting # tags from content
248 * array 'urls' list of attached/referred URLs to save with the
249 * notice in place of extracting links from content
250 * boolean 'distribute' whether to distribute the notice, default true
251 * string 'object_type' URL of the associated object type (default ActivityObject::NOTE)
253 * @fixme tag override
256 * @throws ClientException
258 static function saveNew($profile_id, $content, $source, $options=null) {
259 $defaults = array('uri' => null,
263 'distribute' => true);
265 if (!empty($options)) {
266 $options = $options + $defaults;
272 if (!isset($is_local)) {
273 $is_local = Notice::LOCAL_PUBLIC;
276 $profile = Profile::staticGet('id', $profile_id);
277 $user = User::staticGet('id', $profile_id);
279 // Use the local user's shortening preferences, if applicable.
280 $final = $user->shortenLinks($content);
282 $final = common_shorten_links($content);
285 if (Notice::contentTooLong($final)) {
286 // TRANS: Client exception thrown if a notice contains too many characters.
287 throw new ClientException(_('Problem saving notice. Too long.'));
290 if (empty($profile)) {
291 // TRANS: Client exception thrown when trying to save a notice for an unknown user.
292 throw new ClientException(_('Problem saving notice. Unknown user.'));
295 if (common_config('throttle', 'enabled') && !Notice::checkEditThrottle($profile_id)) {
296 common_log(LOG_WARNING, 'Excessive posting by profile #' . $profile_id . '; throttled.');
297 // TRANS: Client exception thrown when a user tries to post too many notices in a given time frame.
298 throw new ClientException(_('Too many notices too fast; take a breather '.
299 'and post again in a few minutes.'));
302 if (common_config('site', 'dupelimit') > 0 && !Notice::checkDupes($profile_id, $final)) {
303 common_log(LOG_WARNING, 'Dupe posting by profile #' . $profile_id . '; throttled.');
304 // TRANS: Client exception thrown when a user tries to post too many duplicate notices in a given time frame.
305 throw new ClientException(_('Too many duplicate messages too quickly;'.
306 ' take a breather and post again in a few minutes.'));
309 if (!$profile->hasRight(Right::NEWNOTICE)) {
310 common_log(LOG_WARNING, "Attempted post from user disallowed to post: " . $profile->nickname);
312 // TRANS: Client exception thrown when a user tries to post while being banned.
313 throw new ClientException(_('You are banned from posting notices on this site.'), 403);
316 $notice = new Notice();
317 $notice->profile_id = $profile_id;
319 $autosource = common_config('public', 'autosource');
321 // Sandboxed are non-false, but not 1, either
323 if (!$profile->hasRight(Right::PUBLICNOTICE) ||
324 ($source && $autosource && in_array($source, $autosource))) {
325 $notice->is_local = Notice::LOCAL_NONPUBLIC;
327 $notice->is_local = $is_local;
330 if (!empty($created)) {
331 $notice->created = $created;
333 $notice->created = common_sql_now();
336 $notice->content = $final;
338 $notice->source = $source;
342 // Handle repeat case
344 if (isset($repeat_of)) {
345 $notice->repeat_of = $repeat_of;
347 $notice->reply_to = self::getReplyTo($reply_to, $profile_id, $source, $final);
350 if (!empty($notice->reply_to)) {
351 $reply = Notice::staticGet('id', $notice->reply_to);
352 $notice->conversation = $reply->conversation;
355 if (!empty($lat) && !empty($lon)) {
360 if (!empty($location_ns) && !empty($location_id)) {
361 $notice->location_id = $location_id;
362 $notice->location_ns = $location_ns;
365 if (!empty($rendered)) {
366 $notice->rendered = $rendered;
368 $notice->rendered = common_render_content($final, $notice);
371 if (empty($object_type)) {
372 $notice->object_type = (empty($notice->reply_to)) ? ActivityObject::NOTE : ActivityObject::COMMENT;
374 $notice->object_type = $object_type;
377 if (Event::handle('StartNoticeSave', array(&$notice))) {
379 // XXX: some of these functions write to the DB
381 $id = $notice->insert();
384 common_log_db_error($notice, 'INSERT', __FILE__);
385 // TRANS: Server exception thrown when a notice cannot be saved.
386 throw new ServerException(_('Problem saving notice.'));
389 // Update ID-dependent columns: URI, conversation
391 $orig = clone($notice);
396 $notice->uri = common_notice_uri($notice);
400 // If it's not part of a conversation, it's
401 // the beginning of a new conversation.
403 if (empty($notice->conversation)) {
404 $conv = Conversation::create();
405 $notice->conversation = $conv->id;
410 if (!$notice->update($orig)) {
411 common_log_db_error($notice, 'UPDATE', __FILE__);
412 // TRANS: Server exception thrown when a notice cannot be updated.
413 throw new ServerException(_('Problem saving notice.'));
419 // Clear the cache for subscribed users, so they'll update at next request
420 // XXX: someone clever could prepend instead of clearing the cache
422 $notice->blowOnInsert();
424 // Save per-notice metadata...
426 if (isset($replies)) {
427 $notice->saveKnownReplies($replies);
429 $notice->saveReplies();
433 $notice->saveKnownTags($tags);
438 // Note: groups may save tags, so must be run after tags are saved
439 // to avoid errors on duplicates.
440 if (isset($groups)) {
441 $notice->saveKnownGroups($groups);
443 $notice->saveGroups();
447 $notice->saveKnownUrls($urls);
453 // Prepare inbox delivery, may be queued to background.
454 $notice->distribute();
460 function blowOnInsert($conversation = false)
462 self::blow('profile:notice_ids:%d', $this->profile_id);
464 if ($this->isPublic()) {
465 self::blow('public');
468 // XXX: Before we were blowing the casche only if the notice id
469 // was not the root of the conversation. What to do now?
471 self::blow('notice:conversation_ids:%d', $this->conversation);
473 if (!empty($this->repeat_of)) {
474 self::blow('notice:repeats:%d', $this->repeat_of);
477 $original = Notice::staticGet('id', $this->repeat_of);
479 if (!empty($original)) {
480 $originalUser = User::staticGet('id', $original->profile_id);
481 if (!empty($originalUser)) {
482 self::blow('user:repeats_of_me:%d', $originalUser->id);
486 $profile = Profile::staticGet($this->profile_id);
487 if (!empty($profile)) {
488 $profile->blowNoticeCount();
493 * Clear cache entries related to this notice at delete time.
494 * Necessary to avoid breaking paging on public, profile timelines.
496 function blowOnDelete()
498 $this->blowOnInsert();
500 self::blow('profile:notice_ids:%d;last', $this->profile_id);
502 if ($this->isPublic()) {
503 self::blow('public;last');
506 self::blow('fave:by_notice', $this->id);
508 if ($this->conversation) {
509 // In case we're the first, will need to calc a new root.
510 self::blow('notice:conversation_root:%d', $this->conversation);
514 /** save all urls in the notice to the db
516 * follow redirects and save all available file information
517 * (mimetype, date, size, oembed, etc.)
521 function saveUrls() {
522 if (common_config('attachments', 'process_links')) {
523 common_replace_urls_callback($this->content, array($this, 'saveUrl'), $this->id);
528 * Save the given URLs as related links/attachments to the db
530 * follow redirects and save all available file information
531 * (mimetype, date, size, oembed, etc.)
535 function saveKnownUrls($urls)
537 if (common_config('attachments', 'process_links')) {
538 // @fixme validation?
539 foreach (array_unique($urls) as $url) {
540 File::processNew($url, $this->id);
548 function saveUrl($url, $notice_id) {
549 File::processNew($url, $notice_id);
552 static function checkDupes($profile_id, $content) {
553 $profile = Profile::staticGet($profile_id);
554 if (empty($profile)) {
557 $notice = $profile->getNotices(0, NOTICE_CACHE_WINDOW);
558 if (!empty($notice)) {
560 while ($notice->fetch()) {
561 if (time() - strtotime($notice->created) >= common_config('site', 'dupelimit')) {
563 } else if ($notice->content == $content) {
568 // If we get here, oldest item in cache window is not
569 // old enough for dupe limit; do direct check against DB
570 $notice = new Notice();
571 $notice->profile_id = $profile_id;
572 $notice->content = $content;
573 $threshold = common_sql_date(time() - common_config('site', 'dupelimit'));
574 $notice->whereAdd(sprintf("created > '%s'", $notice->escape($threshold)));
576 $cnt = $notice->count();
580 static function checkEditThrottle($profile_id) {
581 $profile = Profile::staticGet($profile_id);
582 if (empty($profile)) {
585 // Get the Nth notice
586 $notice = $profile->getNotices(common_config('throttle', 'count') - 1, 1);
587 if ($notice && $notice->fetch()) {
588 // If the Nth notice was posted less than timespan seconds ago
589 if (time() - strtotime($notice->created) <= common_config('throttle', 'timespan')) {
594 // Either not N notices in the stream, OR the Nth was not posted within timespan seconds
598 function getUploadedAttachment() {
600 $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"';
601 $post->query($query);
603 if (empty($post->up) || empty($post->i)) {
606 $ret = array($post->up, $post->i);
612 function hasAttachments() {
614 $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);
615 $post->query($query);
617 $n_attachments = intval($post->n_attachments);
619 return $n_attachments;
622 function attachments() {
625 $f2p = new File_to_post;
626 $f2p->post_id = $this->id;
628 while ($f2p->fetch()) {
629 $f = File::staticGet($f2p->file_id);
638 function getStreamByIds($ids)
640 $cache = Cache::instance();
642 if (!empty($cache)) {
644 foreach ($ids as $id) {
645 $n = Notice::staticGet('id', $id);
650 return new ArrayWrapper($notices);
652 $notice = new Notice();
654 //if no IDs requested, just return the notice object
657 $notice->whereAdd('id in (' . implode(', ', $ids) . ')');
663 while ($notice->fetch()) {
664 $temp[$notice->id] = clone($notice);
669 foreach ($ids as $id) {
670 if (array_key_exists($id, $temp)) {
671 $wrapped[] = $temp[$id];
675 return new ArrayWrapper($wrapped);
679 function publicStream($offset=0, $limit=20, $since_id=0, $max_id=0)
681 $ids = Notice::stream(array('Notice', '_publicStreamDirect'),
684 $offset, $limit, $since_id, $max_id);
685 return Notice::getStreamByIds($ids);
688 function _publicStreamDirect($offset=0, $limit=20, $since_id=0, $max_id=0)
690 $notice = new Notice();
692 $notice->selectAdd(); // clears it
693 $notice->selectAdd('id');
695 $notice->orderBy('created DESC, id DESC');
697 if (!is_null($offset)) {
698 $notice->limit($offset, $limit);
701 if (common_config('public', 'localonly')) {
702 $notice->whereAdd('is_local = ' . Notice::LOCAL_PUBLIC);
704 // -1 == blacklisted, -2 == gateway (i.e. Twitter)
705 $notice->whereAdd('is_local !='. Notice::LOCAL_NONPUBLIC);
706 $notice->whereAdd('is_local !='. Notice::GATEWAY);
709 Notice::addWhereSinceId($notice, $since_id);
710 Notice::addWhereMaxId($notice, $max_id);
714 if ($notice->find()) {
715 while ($notice->fetch()) {
716 $ids[] = $notice->id;
726 function conversationStream($id, $offset=0, $limit=20, $since_id=0, $max_id=0)
728 $ids = Notice::stream(array('Notice', '_conversationStreamDirect'),
730 'notice:conversation_ids:'.$id,
731 $offset, $limit, $since_id, $max_id);
733 return Notice::getStreamByIds($ids);
736 function _conversationStreamDirect($id, $offset=0, $limit=20, $since_id=0, $max_id=0)
738 $notice = new Notice();
740 $notice->selectAdd(); // clears it
741 $notice->selectAdd('id');
743 $notice->conversation = $id;
745 $notice->orderBy('created DESC, id DESC');
747 if (!is_null($offset)) {
748 $notice->limit($offset, $limit);
751 Notice::addWhereSinceId($notice, $since_id);
752 Notice::addWhereMaxId($notice, $max_id);
756 if ($notice->find()) {
757 while ($notice->fetch()) {
758 $ids[] = $notice->id;
769 * Is this notice part of an active conversation?
771 * @return boolean true if other messages exist in the same
772 * conversation, false if this is the only one
774 function hasConversation()
776 if (!empty($this->conversation)) {
777 $conversation = Notice::conversationStream(
783 if ($conversation->N > 0) {
791 * Grab the earliest notice from this conversation.
793 * @return Notice or null
795 function conversationRoot()
797 if (!empty($this->conversation)) {
798 $c = self::memcache();
800 $key = Cache::key('notice:conversation_root:' . $this->conversation);
801 $notice = $c->get($key);
806 $notice = new Notice();
807 $notice->conversation = $this->conversation;
808 $notice->orderBy('CREATED');
813 $c->set($key, $notice);
820 * Pull up a full list of local recipients who will be getting
821 * this notice in their inbox. Results will be cached, so don't
822 * change the input data wily-nilly!
824 * @param array $groups optional list of Group objects;
825 * if left empty, will be loaded from group_inbox records
826 * @param array $recipient optional list of reply profile ids
827 * if left empty, will be loaded from reply records
828 * @return array associating recipient user IDs with an inbox source constant
830 function whoGets($groups=null, $recipients=null)
832 $c = self::memcache();
835 $ni = $c->get(Cache::key('notice:who_gets:'.$this->id));
841 if (is_null($groups)) {
842 $groups = $this->getGroups();
845 if (is_null($recipients)) {
846 $recipients = $this->getReplies();
849 $users = $this->getSubscribedUsers();
851 // FIXME: kind of ignoring 'transitional'...
852 // we'll probably stop supporting inboxless mode
857 // Give plugins a chance to add folks in at start...
858 if (Event::handle('StartNoticeWhoGets', array($this, &$ni))) {
860 foreach ($users as $id) {
861 $ni[$id] = NOTICE_INBOX_SOURCE_SUB;
864 foreach ($groups as $group) {
865 $users = $group->getUserMembers();
866 foreach ($users as $id) {
867 if (!array_key_exists($id, $ni)) {
868 $ni[$id] = NOTICE_INBOX_SOURCE_GROUP;
873 foreach ($recipients as $recipient) {
874 if (!array_key_exists($recipient, $ni)) {
875 $ni[$recipient] = NOTICE_INBOX_SOURCE_REPLY;
879 // Exclude any deleted, non-local, or blocking recipients.
880 $profile = $this->getProfile();
881 $originalProfile = null;
882 if ($this->repeat_of) {
883 // Check blocks against the original notice's poster as well.
884 $original = Notice::staticGet('id', $this->repeat_of);
886 $originalProfile = $original->getProfile();
889 foreach ($ni as $id => $source) {
890 $user = User::staticGet('id', $id);
891 if (empty($user) || $user->hasBlocked($profile) ||
892 ($originalProfile && $user->hasBlocked($originalProfile))) {
897 // Give plugins a chance to filter out...
898 Event::handle('EndNoticeWhoGets', array($this, &$ni));
902 // XXX: pack this data better
903 $c->set(Cache::key('notice:who_gets:'.$this->id), $ni);
910 * Adds this notice to the inboxes of each local user who should receive
911 * it, based on author subscriptions, group memberships, and @-replies.
913 * Warning: running a second time currently will make items appear
914 * multiple times in users' inboxes.
916 * @fixme make more robust against errors
917 * @fixme break up massive deliveries to smaller background tasks
919 * @param array $groups optional list of Group objects;
920 * if left empty, will be loaded from group_inbox records
921 * @param array $recipient optional list of reply profile ids
922 * if left empty, will be loaded from reply records
924 function addToInboxes($groups=null, $recipients=null)
926 $ni = $this->whoGets($groups, $recipients);
928 $ids = array_keys($ni);
930 // We remove the author (if they're a local user),
931 // since we'll have already done this in distribute()
933 $i = array_search($this->profile_id, $ids);
941 Inbox::bulkInsert($this->id, $ids);
946 function getSubscribedUsers()
950 if(common_config('db','quote_identifiers'))
951 $user_table = '"user"';
952 else $user_table = 'user';
956 'FROM '. $user_table .' JOIN subscription '.
957 'ON '. $user_table .'.id = subscription.subscriber ' .
958 'WHERE subscription.subscribed = %d ';
960 $user->query(sprintf($qry, $this->profile_id));
964 while ($user->fetch()) {
974 * Record this notice to the given group inboxes for delivery.
975 * Overrides the regular parsing of !group markup.
977 * @param string $group_ids
978 * @fixme might prefer URIs as identifiers, as for replies?
979 * best with generalizations on user_group to support
980 * remote groups better.
982 function saveKnownGroups($group_ids)
984 if (!is_array($group_ids)) {
985 // TRANS: Server exception thrown when no array is provided to the method saveKnownGroups().
986 throw new ServerException(_('Bad type provided to saveKnownGroups.'));
990 foreach (array_unique($group_ids) as $id) {
991 $group = User_group::staticGet('id', $id);
993 common_log(LOG_ERR, "Local delivery to group id $id, $group->nickname");
994 $result = $this->addToGroupInbox($group);
996 common_log_db_error($gi, 'INSERT', __FILE__);
999 // @fixme should we save the tags here or not?
1000 $groups[] = clone($group);
1002 common_log(LOG_ERR, "Local delivery to group id $id skipped, doesn't exist");
1010 * Parse !group delivery and record targets into group_inbox.
1011 * @return array of Group objects
1013 function saveGroups()
1015 // Don't save groups for repeats
1017 if (!empty($this->repeat_of)) {
1023 /* extract all !group */
1024 $count = preg_match_all('/(?:^|\s)!(' . Nickname::DISPLAY_FMT . ')/',
1025 strtolower($this->content),
1031 $profile = $this->getProfile();
1033 /* Add them to the database */
1035 foreach (array_unique($match[1]) as $nickname) {
1036 /* XXX: remote groups. */
1037 $group = User_group::getForNickname($nickname, $profile);
1039 if (empty($group)) {
1043 // we automatically add a tag for every group name, too
1045 $tag = Notice_tag::pkeyGet(array('tag' => common_canonical_tag($nickname),
1046 'notice_id' => $this->id));
1048 if (is_null($tag)) {
1049 $this->saveTag($nickname);
1052 if ($profile->isMember($group)) {
1054 $result = $this->addToGroupInbox($group);
1057 common_log_db_error($gi, 'INSERT', __FILE__);
1060 $groups[] = clone($group);
1067 function addToGroupInbox($group)
1069 $gi = Group_inbox::pkeyGet(array('group_id' => $group->id,
1070 'notice_id' => $this->id));
1074 $gi = new Group_inbox();
1076 $gi->group_id = $group->id;
1077 $gi->notice_id = $this->id;
1078 $gi->created = $this->created;
1080 $result = $gi->insert();
1083 common_log_db_error($gi, 'INSERT', __FILE__);
1084 // TRANS: Server exception thrown when an update for a group inbox fails.
1085 throw new ServerException(_('Problem saving group inbox.'));
1088 self::blow('user_group:notice_ids:%d', $gi->group_id);
1095 * Save reply records indicating that this notice needs to be
1096 * delivered to the local users with the given URIs.
1098 * Since this is expected to be used when saving foreign-sourced
1099 * messages, we won't deliver to any remote targets as that's the
1100 * source service's responsibility.
1102 * Mail notifications etc will be handled later.
1104 * @param array of unique identifier URIs for recipients
1106 function saveKnownReplies($uris)
1112 $sender = Profile::staticGet($this->profile_id);
1114 foreach (array_unique($uris) as $uri) {
1116 $profile = Profile::fromURI($uri);
1118 if (empty($profile)) {
1119 common_log(LOG_WARNING, "Unable to determine profile for URI '$uri'");
1123 if ($profile->hasBlocked($sender)) {
1124 common_log(LOG_INFO, "Not saving reply to profile {$profile->id} ($uri) from sender {$sender->id} because of a block.");
1128 $reply = new Reply();
1130 $reply->notice_id = $this->id;
1131 $reply->profile_id = $profile->id;
1132 $reply->modified = $this->created;
1134 common_log(LOG_INFO, __METHOD__ . ": saving reply: notice $this->id to profile $profile->id");
1136 $id = $reply->insert();
1143 * Pull @-replies from this message's content in StatusNet markup format
1144 * and save reply records indicating that this message needs to be
1145 * delivered to those users.
1147 * Mail notifications to local profiles will be sent later.
1149 * @return array of integer profile IDs
1152 function saveReplies()
1154 // Don't save reply data for repeats
1156 if (!empty($this->repeat_of)) {
1160 $sender = Profile::staticGet($this->profile_id);
1162 // @todo ideally this parser information would only
1163 // be calculated once.
1165 $mentions = common_find_mentions($this->content, $this);
1169 // store replied only for first @ (what user/notice what the reply directed,
1170 // we assume first @ is it)
1172 foreach ($mentions as $mention) {
1174 foreach ($mention['mentioned'] as $mentioned) {
1176 // skip if they're already covered
1178 if (!empty($replied[$mentioned->id])) {
1182 // Don't save replies from blocked profile to local user
1184 $mentioned_user = User::staticGet('id', $mentioned->id);
1185 if (!empty($mentioned_user) && $mentioned_user->hasBlocked($sender)) {
1189 $reply = new Reply();
1191 $reply->notice_id = $this->id;
1192 $reply->profile_id = $mentioned->id;
1193 $reply->modified = $this->created;
1195 $id = $reply->insert();
1198 common_log_db_error($reply, 'INSERT', __FILE__);
1199 // TRANS: Server exception thrown when a reply cannot be saved.
1200 // TRANS: %1$d is a notice ID, %2$d is the ID of the mentioned user.
1201 throw new ServerException(sprintf(_('Could not save reply for %1$d, %2$d.'), $this->id, $mentioned->id));
1203 $replied[$mentioned->id] = 1;
1204 self::blow('reply:stream:%d', $mentioned->id);
1209 $recipientIds = array_keys($replied);
1211 return $recipientIds;
1215 * Pull the complete list of @-reply targets for this notice.
1217 * @return array of integer profile ids
1219 function getReplies()
1225 $reply = new Reply();
1226 $reply->selectAdd();
1227 $reply->selectAdd('profile_id');
1228 $reply->notice_id = $this->id;
1230 if ($reply->find()) {
1231 while($reply->fetch()) {
1232 $ids[] = $reply->profile_id;
1242 * Send e-mail notifications to local @-reply targets.
1244 * Replies must already have been saved; this is expected to be run
1245 * from the distrib queue handler.
1247 function sendReplyNotifications()
1249 // Don't send reply notifications for repeats
1251 if (!empty($this->repeat_of)) {
1255 $recipientIds = $this->getReplies();
1257 foreach ($recipientIds as $recipientId) {
1258 $user = User::staticGet('id', $recipientId);
1259 if (!empty($user)) {
1260 mail_notify_attn($user, $this);
1266 * Pull list of groups this notice needs to be delivered to,
1267 * as previously recorded by saveGroups() or saveKnownGroups().
1269 * @return array of Group objects
1271 function getGroups()
1273 // Don't save groups for repeats
1275 if (!empty($this->repeat_of)) {
1283 $gi = new Group_inbox();
1286 $gi->selectAdd('group_id');
1288 $gi->notice_id = $this->id;
1291 while ($gi->fetch()) {
1292 $group = User_group::staticGet('id', $gi->group_id);
1305 * Convert a notice into an activity for export.
1307 * @param User $cur Current user
1309 * @return Activity activity object representing this Notice.
1312 function asActivity($cur)
1314 $act = self::cacheGet(Cache::codeKey('notice:as-activity:'.$this->id));
1319 $act = new Activity();
1321 if (Event::handle('StartNoticeAsActivity', array($this, &$act))) {
1323 $profile = $this->getProfile();
1325 $act->actor = ActivityObject::fromProfile($profile);
1326 $act->actor->extra[] = $profile->profileInfo($cur);
1327 $act->verb = ActivityVerb::POST;
1328 $act->objects[] = ActivityObject::fromNotice($this);
1330 // XXX: should this be handled by default processing for object entry?
1332 $act->time = strtotime($this->created);
1333 $act->link = $this->bestUrl();
1335 $act->content = common_xml_safe_str($this->rendered);
1336 $act->id = $this->uri;
1337 $act->title = common_xml_safe_str($this->content);
1341 $tags = $this->getTags();
1343 foreach ($tags as $tag) {
1344 $cat = new AtomCategory();
1347 $act->categories[] = $cat;
1351 // XXX: use Atom Media and/or File activity objects instead
1353 $attachments = $this->attachments();
1355 foreach ($attachments as $attachment) {
1356 $enclosure = $attachment->getEnclosure();
1358 $act->enclosures[] = $enclosure;
1362 $ctx = new ActivityContext();
1364 if (!empty($this->reply_to)) {
1365 $reply = Notice::staticGet('id', $this->reply_to);
1366 if (!empty($reply)) {
1367 $ctx->replyToID = $reply->uri;
1368 $ctx->replyToUrl = $reply->bestUrl();
1372 $ctx->location = $this->getLocation();
1376 if (!empty($this->conversation)) {
1377 $conv = Conversation::staticGet('id', $this->conversation);
1378 if (!empty($conv)) {
1379 $ctx->conversation = $conv->uri;
1383 $reply_ids = $this->getReplies();
1385 foreach ($reply_ids as $id) {
1386 $profile = Profile::staticGet('id', $id);
1387 if (!empty($profile)) {
1388 $ctx->attention[] = $profile->getUri();
1392 $groups = $this->getGroups();
1394 foreach ($groups as $group) {
1395 $ctx->attention[] = $group->getUri();
1398 // XXX: deprecated; use ActivityVerb::SHARE instead
1402 if (!empty($this->repeat_of)) {
1403 $repeat = Notice::staticGet('id', $this->repeat_of);
1404 $ctx->forwardID = $repeat->uri;
1405 $ctx->forwardUrl = $repeat->bestUrl();
1408 $act->context = $ctx;
1412 $atom_feed = $profile->getAtomFeed();
1414 if (!empty($atom_feed)) {
1416 $act->source = new ActivitySource();
1418 // XXX: we should store the actual feed ID
1420 $act->source->id = $atom_feed;
1422 // XXX: we should store the actual feed title
1424 $act->source->title = $profile->getBestName();
1426 $act->source->links['alternate'] = $profile->profileurl;
1427 $act->source->links['self'] = $atom_feed;
1429 $act->source->icon = $profile->avatarUrl(AVATAR_PROFILE_SIZE);
1431 $notice = $profile->getCurrentNotice();
1433 if (!empty($notice)) {
1434 $act->source->updated = self::utcDate($notice->created);
1437 $user = User::staticGet('id', $profile->id);
1439 if (!empty($user)) {
1440 $act->source->links['license'] = common_config('license', 'url');
1444 if ($this->isLocal()) {
1445 $act->selfLink = common_local_url('ApiStatusesShow', array('id' => $this->id,
1446 'format' => 'atom'));
1447 $act->editLink = $act->selfLink;
1450 Event::handle('EndNoticeAsActivity', array($this, &$act));
1453 self::cacheSet(Cache::codeKey('notice:as-activity:'.$this->id), $act);
1458 // This has gotten way too long. Needs to be sliced up into functional bits
1459 // or ideally exported to a utility class.
1461 function asAtomEntry($namespace=false,
1466 $act = $this->asActivity($cur);
1467 $act->extra[] = $this->noticeInfo($cur);
1468 return $act->asString($namespace, $author, $source);
1472 * Extra notice info for atom entries
1474 * Clients use some extra notice info in the atom stream.
1475 * This gives it to them.
1477 * @param User $cur Current user
1479 * @return array representation of <statusnet:notice_info> element
1482 function noticeInfo($cur)
1484 // local notice ID (useful to clients for ordering)
1486 $noticeInfoAttr = array('local_id' => $this->id);
1490 $ns = $this->getSource();
1493 $noticeInfoAttr['source'] = $ns->code;
1494 if (!empty($ns->url)) {
1495 $noticeInfoAttr['source_link'] = $ns->url;
1496 if (!empty($ns->name)) {
1497 $noticeInfoAttr['source'] = '<a href="'
1498 . htmlspecialchars($ns->url)
1499 . '" rel="nofollow">'
1500 . htmlspecialchars($ns->name)
1506 // favorite and repeated
1509 $noticeInfoAttr['favorite'] = ($cur->hasFave($this)) ? "true" : "false";
1510 $cp = $cur->getProfile();
1511 $noticeInfoAttr['repeated'] = ($cp->hasRepeated($this->id)) ? "true" : "false";
1514 if (!empty($this->repeat_of)) {
1515 $noticeInfoAttr['repeat_of'] = $this->repeat_of;
1518 return array('statusnet:notice_info', $noticeInfoAttr, null);
1522 * Returns an XML string fragment with a reference to a notice as an
1523 * Activity Streams noun object with the given element type.
1525 * Assumes that 'activity' namespace has been previously defined.
1527 * @param string $element one of 'subject', 'object', 'target'
1531 function asActivityNoun($element)
1533 $noun = ActivityObject::fromNotice($this);
1534 return $noun->asString('activity:' . $element);
1539 if (!empty($this->url)) {
1541 } else if (!empty($this->uri) && preg_match('/^https?:/', $this->uri)) {
1544 return common_local_url('shownotice',
1545 array('notice' => $this->id));
1549 function stream($fn, $args, $cachekey, $offset=0, $limit=20, $since_id=0, $max_id=0, $profile=0)
1551 if ($profile === 0) {
1552 $user = common_current_user();
1556 $profile = $user->getProfile();
1560 $cache = Cache::instance();
1562 if (empty($cache) ||
1563 $since_id != 0 || $max_id != 0 ||
1565 ($offset + $limit) > NOTICE_CACHE_WINDOW) {
1566 return call_user_func_array($fn, array_merge($args, array($offset, $limit, $since_id,
1570 $idkey = Cache::key($cachekey);
1572 $idstr = $cache->get($idkey);
1574 if ($idstr !== false) {
1575 // Cache hit! Woohoo!
1576 $window = explode(',', $idstr);
1577 $ids = array_slice($window, $offset, $limit);
1581 $laststr = $cache->get($idkey.';last');
1583 if ($laststr !== false) {
1584 $window = explode(',', $laststr);
1585 $last_id = $window[0];
1586 $new_ids = call_user_func_array($fn, array_merge($args, array(0, NOTICE_CACHE_WINDOW,
1587 $last_id, 0, null)));
1589 $new_window = array_merge($new_ids, $window);
1591 $new_windowstr = implode(',', $new_window);
1593 $result = $cache->set($idkey, $new_windowstr);
1594 $result = $cache->set($idkey . ';last', $new_windowstr);
1596 $ids = array_slice($new_window, $offset, $limit);
1601 $window = call_user_func_array($fn, array_merge($args, array(0, NOTICE_CACHE_WINDOW,
1604 $windowstr = implode(',', $window);
1606 $result = $cache->set($idkey, $windowstr);
1607 $result = $cache->set($idkey . ';last', $windowstr);
1609 $ids = array_slice($window, $offset, $limit);
1615 * Determine which notice, if any, a new notice is in reply to.
1617 * For conversation tracking, we try to see where this notice fits
1618 * in the tree. Rough algorithm is:
1620 * if (reply_to is set and valid) {
1622 * } else if ((source not API or Web) and (content starts with "T NAME" or "@name ")) {
1623 * return ID of last notice by initial @name in content;
1626 * Note that all @nickname instances will still be used to save "reply" records,
1627 * so the notice shows up in the mentioned users' "replies" tab.
1629 * @param integer $reply_to ID passed in by Web or API
1630 * @param integer $profile_id ID of author
1631 * @param string $source Source tag, like 'web' or 'gwibber'
1632 * @param string $content Final notice content
1634 * @return integer ID of replied-to notice, or null for not a reply.
1637 static function getReplyTo($reply_to, $profile_id, $source, $content)
1639 static $lb = array('xmpp', 'mail', 'sms', 'omb');
1641 // If $reply_to is specified, we check that it exists, and then
1642 // return it if it does
1644 if (!empty($reply_to)) {
1645 $reply_notice = Notice::staticGet('id', $reply_to);
1646 if (!empty($reply_notice)) {
1651 // If it's not a "low bandwidth" source (one where you can't set
1652 // a reply_to argument), we return. This is mostly web and API
1655 if (!in_array($source, $lb)) {
1659 // Is there an initial @ or T?
1661 if (preg_match('/^T ([A-Z0-9]{1,64}) /', $content, $match) ||
1662 preg_match('/^@([a-z0-9]{1,64})\s+/', $content, $match)) {
1663 $nickname = common_canonical_nickname($match[1]);
1668 // Figure out who that is.
1670 $sender = Profile::staticGet('id', $profile_id);
1671 if (empty($sender)) {
1675 $recipient = common_relative_profile($sender, $nickname, common_sql_now());
1677 if (empty($recipient)) {
1681 // Get their last notice
1683 $last = $recipient->getCurrentNotice();
1685 if (!empty($last)) {
1690 static function maxContent()
1692 $contentlimit = common_config('notice', 'contentlimit');
1693 // null => use global limit (distinct from 0!)
1694 if (is_null($contentlimit)) {
1695 $contentlimit = common_config('site', 'textlimit');
1697 return $contentlimit;
1700 static function contentTooLong($content)
1702 $contentlimit = self::maxContent();
1703 return ($contentlimit > 0 && !empty($content) && (mb_strlen($content) > $contentlimit));
1706 function getLocation()
1710 if (!empty($this->location_id) && !empty($this->location_ns)) {
1711 $location = Location::fromId($this->location_id, $this->location_ns);
1714 if (is_null($location)) { // no ID, or Location::fromId() failed
1715 if (!empty($this->lat) && !empty($this->lon)) {
1716 $location = Location::fromLatLon($this->lat, $this->lon);
1723 function repeat($repeater_id, $source)
1725 $author = Profile::staticGet('id', $this->profile_id);
1727 // TRANS: Message used to repeat a notice. RT is the abbreviation of 'retweet'.
1728 // TRANS: %1$s is the repeated user's name, %2$s is the repeated notice.
1729 $content = sprintf(_('RT @%1$s %2$s'),
1733 $maxlen = common_config('site', 'textlimit');
1734 if ($maxlen > 0 && mb_strlen($content) > $maxlen) {
1735 // Web interface and current Twitter API clients will
1736 // pull the original notice's text, but some older
1737 // clients and RSS/Atom feeds will see this trimmed text.
1739 // Unfortunately this is likely to lose tags or URLs
1740 // at the end of long notices.
1741 $content = mb_substr($content, 0, $maxlen - 4) . ' ...';
1744 return self::saveNew($repeater_id, $content, $source,
1745 array('repeat_of' => $this->id));
1748 // These are supposed to be in chron order!
1750 function repeatStream($limit=100)
1752 $cache = Cache::instance();
1754 if (empty($cache)) {
1755 $ids = $this->_repeatStreamDirect($limit);
1757 $idstr = $cache->get(Cache::key('notice:repeats:'.$this->id));
1758 if ($idstr !== false) {
1759 $ids = explode(',', $idstr);
1761 $ids = $this->_repeatStreamDirect(100);
1762 $cache->set(Cache::key('notice:repeats:'.$this->id), implode(',', $ids));
1765 // We do a max of 100, so slice down to limit
1766 $ids = array_slice($ids, 0, $limit);
1770 return Notice::getStreamByIds($ids);
1773 function _repeatStreamDirect($limit)
1775 $notice = new Notice();
1777 $notice->selectAdd(); // clears it
1778 $notice->selectAdd('id');
1780 $notice->repeat_of = $this->id;
1782 $notice->orderBy('created, id'); // NB: asc!
1784 if (!is_null($limit)) {
1785 $notice->limit(0, $limit);
1790 if ($notice->find()) {
1791 while ($notice->fetch()) {
1792 $ids[] = $notice->id;
1802 function locationOptions($lat, $lon, $location_id, $location_ns, $profile = null)
1806 if (!empty($location_id) && !empty($location_ns)) {
1807 $options['location_id'] = $location_id;
1808 $options['location_ns'] = $location_ns;
1810 $location = Location::fromId($location_id, $location_ns);
1812 if (!empty($location)) {
1813 $options['lat'] = $location->lat;
1814 $options['lon'] = $location->lon;
1817 } else if (!empty($lat) && !empty($lon)) {
1818 $options['lat'] = $lat;
1819 $options['lon'] = $lon;
1821 $location = Location::fromLatLon($lat, $lon);
1823 if (!empty($location)) {
1824 $options['location_id'] = $location->location_id;
1825 $options['location_ns'] = $location->location_ns;
1827 } else if (!empty($profile)) {
1828 if (isset($profile->lat) && isset($profile->lon)) {
1829 $options['lat'] = $profile->lat;
1830 $options['lon'] = $profile->lon;
1833 if (isset($profile->location_id) && isset($profile->location_ns)) {
1834 $options['location_id'] = $profile->location_id;
1835 $options['location_ns'] = $profile->location_ns;
1842 function clearReplies()
1844 $replyNotice = new Notice();
1845 $replyNotice->reply_to = $this->id;
1847 //Null any notices that are replies to this notice
1849 if ($replyNotice->find()) {
1850 while ($replyNotice->fetch()) {
1851 $orig = clone($replyNotice);
1852 $replyNotice->reply_to = null;
1853 $replyNotice->update($orig);
1859 $reply = new Reply();
1860 $reply->notice_id = $this->id;
1862 if ($reply->find()) {
1863 while($reply->fetch()) {
1864 self::blow('reply:stream:%d', $reply->profile_id);
1872 function clearFiles()
1874 $f2p = new File_to_post();
1876 $f2p->post_id = $this->id;
1879 while ($f2p->fetch()) {
1883 // FIXME: decide whether to delete File objects
1884 // ...and related (actual) files
1887 function clearRepeats()
1889 $repeatNotice = new Notice();
1890 $repeatNotice->repeat_of = $this->id;
1892 //Null any notices that are repeats of this notice
1894 if ($repeatNotice->find()) {
1895 while ($repeatNotice->fetch()) {
1896 $orig = clone($repeatNotice);
1897 $repeatNotice->repeat_of = null;
1898 $repeatNotice->update($orig);
1903 function clearFaves()
1906 $fave->notice_id = $this->id;
1908 if ($fave->find()) {
1909 while ($fave->fetch()) {
1910 self::blow('fave:ids_by_user_own:%d', $fave->user_id);
1911 self::blow('fave:ids_by_user_own:%d;last', $fave->user_id);
1912 self::blow('fave:ids_by_user:%d', $fave->user_id);
1913 self::blow('fave:ids_by_user:%d;last', $fave->user_id);
1921 function clearTags()
1923 $tag = new Notice_tag();
1924 $tag->notice_id = $this->id;
1927 while ($tag->fetch()) {
1928 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, Cache::keyize($tag->tag));
1929 self::blow('profile:notice_ids_tagged:%d:%s;last', $this->profile_id, Cache::keyize($tag->tag));
1930 self::blow('notice_tag:notice_ids:%s', Cache::keyize($tag->tag));
1931 self::blow('notice_tag:notice_ids:%s;last', Cache::keyize($tag->tag));
1939 function clearGroupInboxes()
1941 $gi = new Group_inbox();
1943 $gi->notice_id = $this->id;
1946 while ($gi->fetch()) {
1947 self::blow('user_group:notice_ids:%d', $gi->group_id);
1955 function distribute()
1957 // We always insert for the author so they don't
1959 Event::handle('StartNoticeDistribute', array($this));
1961 $user = User::staticGet('id', $this->profile_id);
1962 if (!empty($user)) {
1963 Inbox::insertNotice($user->id, $this->id);
1966 if (common_config('queue', 'inboxes')) {
1967 // If there's a failure, we want to _force_
1968 // distribution at this point.
1970 $qm = QueueManager::get();
1971 $qm->enqueue($this, 'distrib');
1972 } catch (Exception $e) {
1973 // If the exception isn't transient, this
1974 // may throw more exceptions as DQH does
1975 // its own enqueueing. So, we ignore them!
1977 $handler = new DistribQueueHandler();
1978 $handler->handle($this);
1979 } catch (Exception $e) {
1980 common_log(LOG_ERR, "emergency redistribution resulted in " . $e->getMessage());
1982 // Re-throw so somebody smarter can handle it.
1986 $handler = new DistribQueueHandler();
1987 $handler->handle($this);
1993 $result = parent::insert();
1996 // Profile::hasRepeated() abuses pkeyGet(), so we
1997 // have to clear manually
1998 if (!empty($this->repeat_of)) {
1999 $c = self::memcache();
2001 $ck = self::multicacheKey('Notice',
2002 array('profile_id' => $this->profile_id,
2003 'repeat_of' => $this->repeat_of));
2013 * Get the source of the notice
2015 * @return Notice_source $ns A notice source object. 'code' is the only attribute
2016 * guaranteed to be populated.
2018 function getSource()
2020 $ns = new Notice_source();
2021 if (!empty($this->source)) {
2022 switch ($this->source) {
2029 $ns->code = $this->source;
2032 $ns = Notice_source::staticGet($this->source);
2034 $ns = new Notice_source();
2035 $ns->code = $this->source;
2036 $app = Oauth_application::staticGet('name', $this->source);
2038 $ns->name = $app->name;
2039 $ns->url = $app->source_url;
2049 * Determine whether the notice was locally created
2051 * @return boolean locality
2054 public function isLocal()
2056 return ($this->is_local == Notice::LOCAL_PUBLIC ||
2057 $this->is_local == Notice::LOCAL_NONPUBLIC);
2061 * Get the list of hash tags saved with this notice.
2063 * @return array of strings
2065 public function getTags()
2068 $tag = new Notice_tag();
2069 $tag->notice_id = $this->id;
2071 while ($tag->fetch()) {
2072 $tags[] = $tag->tag;
2079 static private function utcDate($dt)
2081 $dateStr = date('d F Y H:i:s', strtotime($dt));
2082 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
2083 return $d->format(DATE_W3C);
2087 * Look up the creation timestamp for a given notice ID, even
2088 * if it's been deleted.
2091 * @return mixed string recorded creation timestamp, or false if can't be found
2093 public static function getAsTimestamp($id)
2099 $notice = Notice::staticGet('id', $id);
2101 return $notice->created;
2104 $deleted = Deleted_notice::staticGet('id', $id);
2106 return $deleted->created;
2113 * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2114 * parameter, matching notices posted after the given one (exclusive).
2116 * If the referenced notice can't be found, will return false.
2119 * @param string $idField
2120 * @param string $createdField
2121 * @return mixed string or false if no match
2123 public static function whereSinceId($id, $idField='id', $createdField='created')
2125 $since = Notice::getAsTimestamp($id);
2127 return sprintf("($createdField = '%s' and $idField > %d) or ($createdField > '%s')", $since, $id, $since);
2133 * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2134 * parameter, matching notices posted after the given one (exclusive), and
2135 * if necessary add it to the data object's query.
2137 * @param DB_DataObject $obj
2139 * @param string $idField
2140 * @param string $createdField
2141 * @return mixed string or false if no match
2143 public static function addWhereSinceId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2145 $since = self::whereSinceId($id, $idField, $createdField);
2147 $obj->whereAdd($since);
2152 * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2153 * parameter, matching notices posted before the given one (inclusive).
2155 * If the referenced notice can't be found, will return false.
2158 * @param string $idField
2159 * @param string $createdField
2160 * @return mixed string or false if no match
2162 public static function whereMaxId($id, $idField='id', $createdField='created')
2164 $max = Notice::getAsTimestamp($id);
2166 return sprintf("($createdField < '%s') or ($createdField = '%s' and $idField <= %d)", $max, $max, $id);
2172 * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2173 * parameter, matching notices posted before the given one (inclusive), and
2174 * if necessary add it to the data object's query.
2176 * @param DB_DataObject $obj
2178 * @param string $idField
2179 * @param string $createdField
2180 * @return mixed string or false if no match
2182 public static function addWhereMaxId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2184 $max = self::whereMaxId($id, $idField, $createdField);
2186 $obj->whereAdd($max);
2192 if (common_config('public', 'localonly')) {
2193 return ($this->is_local == Notice::LOCAL_PUBLIC);
2195 return (($this->is_local != Notice::LOCAL_NONPUBLIC) &&
2196 ($this->is_local != Notice::GATEWAY));
2201 * Check that the given profile is allowed to read, respond to, or otherwise
2202 * act on this notice.
2204 * The $scope member is a bitmask of scopes, representing a logical AND of the
2205 * scope requirement. So, 0x03 (Notice::ADDRESSEE_SCOPE | Notice::SITE_SCOPE) means
2206 * "only visible to people who are mentioned in the notice AND are users on this site."
2207 * Users on the site who are not mentioned in the notice will not be able to see the
2210 * @param Profile $profile The profile to check
2212 * @return boolean whether the profile is in the notice's scope
2215 function inScope($profile)
2217 // If there's any scope, and there's no logged-in user,
2220 if ($this->scope > 0 && empty($profile)) {
2224 // Only for users on this site
2226 if ($this->scope & Notice::SITE_SCOPE) {
2227 $user = $profile->getUser();
2233 // Only for users mentioned in the notice
2235 if ($this->scope & Notice::ADDRESSEE_SCOPE) {
2237 // XXX: just query for the single reply
2239 $replies = $this->getReplies();
2241 if (!in_array($profile->id, $replies)) {
2246 // Only for members of the given group
2248 if ($this->scope & Notice::GROUP_SCOPE) {
2250 // XXX: just query for the single membership
2252 $groups = $this->getGroups();
2256 foreach ($groups as $group) {
2257 if ($profile->isMember($group)) {
2268 // Only for followers of the author
2270 if ($this->scope & Notice::FOLLOWER_SCOPE) {
2271 $author = $this->getProfile();
2272 if (!Subscription::exists($profile, $author)) {