3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2008, 2009, StatusNet, Inc.
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Affero General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Affero General Public License for more details.
16 * You should have received a copy of the GNU Affero General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
21 * @author Brenda Wallace <shiny@cpan.org>
22 * @author Christopher Vollick <psycotica0@gmail.com>
23 * @author CiaranG <ciaran@ciarang.com>
24 * @author Craig Andrews <candrews@integralblue.com>
25 * @author Evan Prodromou <evan@controlezvous.ca>
26 * @author Gina Haeussge <osd@foosel.net>
27 * @author Jeffery To <jeffery.to@gmail.com>
28 * @author Mike Cochrane <mikec@mikenz.geek.nz>
29 * @author Robin Millette <millette@controlyourself.ca>
30 * @author Sarven Capadisli <csarven@controlyourself.ca>
31 * @author Tom Adams <tom@holizz.com>
32 * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
33 * @license GNU Affero General Public License http://www.gnu.org/licenses/
36 if (!defined('STATUSNET') && !defined('LACONICA')) {
41 * Table Definition for notice
43 require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
45 /* We keep 200 notices, the max number of notices available per API request,
46 * in the memcached cache. */
48 define('NOTICE_CACHE_WINDOW', 200);
50 define('MAX_BOXCARS', 128);
52 class Notice extends Memcached_DataObject
55 /* the code below is auto generated do not remove the above tag */
57 public $__table = 'notice'; // table name
58 public $id; // int(4) primary_key not_null
59 public $profile_id; // int(4) multiple_key not_null
60 public $uri; // varchar(255) unique_key
61 public $content; // text
62 public $rendered; // text
63 public $url; // varchar(255)
64 public $created; // datetime multiple_key not_null default_0000-00-00%2000%3A00%3A00
65 public $modified; // timestamp not_null default_CURRENT_TIMESTAMP
66 public $reply_to; // int(4)
67 public $is_local; // int(4)
68 public $source; // varchar(32)
69 public $conversation; // int(4)
70 public $lat; // decimal(10,7)
71 public $lon; // decimal(10,7)
72 public $location_id; // int(4)
73 public $location_ns; // int(4)
74 public $repeat_of; // int(4)
77 function staticGet($k,$v=NULL)
79 return Memcached_DataObject::staticGet('Notice',$k,$v);
82 /* the code above is auto generated do not remove the tag below */
86 const LOCAL_PUBLIC = 1;
88 const LOCAL_NONPUBLIC = -1;
93 $profile = Profile::staticGet('id', $this->profile_id);
95 if (empty($profile)) {
96 // TRANS: Server exception thrown when a user profile for a notice cannot be found.
97 // TRANS: %1$d is a profile ID (number), %2$d is a notice ID (number).
98 throw new ServerException(sprintf(_('No such profile (%1$d) for notice (%2$d).'), $this->profile_id, $this->id));
106 // For auditing purposes, save a record that the notice
109 // @fixme we have some cases where things get re-run and so the
111 $deleted = Deleted_notice::staticGet('id', $this->id);
113 $deleted = new Deleted_notice();
115 $deleted->id = $this->id;
116 $deleted->profile_id = $this->profile_id;
117 $deleted->uri = $this->uri;
118 $deleted->created = $this->created;
119 $deleted->deleted = common_sql_now();
124 if (Event::handle('NoticeDeleteRelated', array($this))) {
126 // Clear related records
128 $this->clearReplies();
129 $this->clearRepeats();
132 $this->clearGroupInboxes();
134 // NOTE: we don't clear inboxes
135 // NOTE: we don't clear queue items
138 $result = parent::delete();
140 $this->blowOnDelete();
145 * Extract #hashtags from this notice's content and save them to the database.
149 /* extract all #hastags */
150 $count = preg_match_all('/(?:^|\s)#([\pL\pN_\-\.]{1,64})/', strtolower($this->content), $match);
155 /* Add them to the database */
156 return $this->saveKnownTags($match[1]);
160 * Record the given set of hash tags in the db for this notice.
161 * Given tag strings will be normalized and checked for dupes.
163 function saveKnownTags($hashtags)
165 //turn each into their canonical tag
166 //this is needed to remove dupes before saving e.g. #hash.tag = #hashtag
167 for($i=0; $i<count($hashtags); $i++) {
168 /* elide characters we don't want in the tag */
169 $hashtags[$i] = common_canonical_tag($hashtags[$i]);
172 foreach(array_unique($hashtags) as $hashtag) {
173 $this->saveTag($hashtag);
174 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, $hashtag);
180 * Record a single hash tag as associated with this notice.
181 * Tag format and uniqueness must be validated by caller.
183 function saveTag($hashtag)
185 $tag = new Notice_tag();
186 $tag->notice_id = $this->id;
187 $tag->tag = $hashtag;
188 $tag->created = $this->created;
189 $id = $tag->insert();
192 // TRANS: Server exception. %s are the error details.
193 throw new ServerException(sprintf(_('Database error inserting hashtag: %s'),
194 $last_error->message));
198 // if it's saved, blow its cache
199 $tag->blowCache(false);
203 * Save a new notice and push it out to subscribers' inboxes.
204 * Poster's permissions are checked before sending.
206 * @param int $profile_id Profile ID of the poster
207 * @param string $content source message text; links may be shortened
208 * per current user's preference
209 * @param string $source source key ('web', 'api', etc)
210 * @param array $options Associative array of optional properties:
211 * string 'created' timestamp of notice; defaults to now
212 * int 'is_local' source/gateway ID, one of:
213 * Notice::LOCAL_PUBLIC - Local, ok to appear in public timeline
214 * Notice::REMOTE_OMB - Sent from a remote OMB service;
215 * hide from public timeline but show in
216 * local "and friends" timelines
217 * Notice::LOCAL_NONPUBLIC - Local, but hide from public timeline
218 * Notice::GATEWAY - From another non-OMB service;
219 * will not appear in public views
220 * float 'lat' decimal latitude for geolocation
221 * float 'lon' decimal longitude for geolocation
222 * int 'location_id' geoname identifier
223 * int 'location_ns' geoname namespace to interpret location_id
224 * int 'reply_to'; notice ID this is a reply to
225 * int 'repeat_of'; notice ID this is a repeat of
226 * string 'uri' unique ID for notice; defaults to local notice URL
227 * string 'url' permalink to notice; defaults to local notice URL
228 * string 'rendered' rendered HTML version of content
229 * array 'replies' list of profile URIs for reply delivery in
230 * place of extracting @-replies from content.
231 * array 'groups' list of group IDs to deliver to, in place of
232 * extracting ! tags from content
233 * array 'tags' list of hashtag strings to save with the notice
234 * in place of extracting # tags from content
235 * array 'urls' list of attached/referred URLs to save with the
236 * notice in place of extracting links from content
237 * @fixme tag override
240 * @throws ClientException
242 static function saveNew($profile_id, $content, $source, $options=null) {
243 $defaults = array('uri' => null,
246 'repeat_of' => null);
248 if (!empty($options)) {
249 $options = $options + $defaults;
255 if (!isset($is_local)) {
256 $is_local = Notice::LOCAL_PUBLIC;
259 $profile = Profile::staticGet($profile_id);
261 $final = common_shorten_links($content);
263 if (Notice::contentTooLong($final)) {
264 // TRANS: Client exception thrown if a notice contains too many characters.
265 throw new ClientException(_('Problem saving notice. Too long.'));
268 if (empty($profile)) {
269 // TRANS: Client exception thrown when trying to save a notice for an unknown user.
270 throw new ClientException(_('Problem saving notice. Unknown user.'));
273 if (common_config('throttle', 'enabled') && !Notice::checkEditThrottle($profile_id)) {
274 common_log(LOG_WARNING, 'Excessive posting by profile #' . $profile_id . '; throttled.');
275 // TRANS: Client exception thrown when a user tries to post too many notices in a given time frame.
276 throw new ClientException(_('Too many notices too fast; take a breather '.
277 'and post again in a few minutes.'));
280 if (common_config('site', 'dupelimit') > 0 && !Notice::checkDupes($profile_id, $final)) {
281 common_log(LOG_WARNING, 'Dupe posting by profile #' . $profile_id . '; throttled.');
282 // TRANS: Client exception thrown when a user tries to post too many duplicate notices in a given time frame.
283 throw new ClientException(_('Too many duplicate messages too quickly;'.
284 ' take a breather and post again in a few minutes.'));
287 if (!$profile->hasRight(Right::NEWNOTICE)) {
288 common_log(LOG_WARNING, "Attempted post from user disallowed to post: " . $profile->nickname);
290 // TRANS: Client exception thrown when a user tries to post while being banned.
291 throw new ClientException(_('You are banned from posting notices on this site.'), 403);
294 $notice = new Notice();
295 $notice->profile_id = $profile_id;
297 $autosource = common_config('public', 'autosource');
299 # Sandboxed are non-false, but not 1, either
301 if (!$profile->hasRight(Right::PUBLICNOTICE) ||
302 ($source && $autosource && in_array($source, $autosource))) {
303 $notice->is_local = Notice::LOCAL_NONPUBLIC;
305 $notice->is_local = $is_local;
308 if (!empty($created)) {
309 $notice->created = $created;
311 $notice->created = common_sql_now();
314 $notice->content = $final;
316 $notice->source = $source;
320 // Handle repeat case
322 if (isset($repeat_of)) {
323 $notice->repeat_of = $repeat_of;
325 $notice->reply_to = self::getReplyTo($reply_to, $profile_id, $source, $final);
328 if (!empty($notice->reply_to)) {
329 $reply = Notice::staticGet('id', $notice->reply_to);
330 $notice->conversation = $reply->conversation;
333 if (!empty($lat) && !empty($lon)) {
338 if (!empty($location_ns) && !empty($location_id)) {
339 $notice->location_id = $location_id;
340 $notice->location_ns = $location_ns;
343 if (!empty($rendered)) {
344 $notice->rendered = $rendered;
346 $notice->rendered = common_render_content($final, $notice);
349 if (Event::handle('StartNoticeSave', array(&$notice))) {
351 // XXX: some of these functions write to the DB
353 $id = $notice->insert();
356 common_log_db_error($notice, 'INSERT', __FILE__);
357 // TRANS: Server exception thrown when a notice cannot be saved.
358 throw new ServerException(_('Problem saving notice.'));
361 // Update ID-dependent columns: URI, conversation
363 $orig = clone($notice);
368 $notice->uri = common_notice_uri($notice);
372 // If it's not part of a conversation, it's
373 // the beginning of a new conversation.
375 if (empty($notice->conversation)) {
376 $conv = Conversation::create();
377 $notice->conversation = $conv->id;
382 if (!$notice->update($orig)) {
383 common_log_db_error($notice, 'UPDATE', __FILE__);
384 // TRANS: Server exception thrown when a notice cannot be updated.
385 throw new ServerException(_('Problem saving notice.'));
391 # Clear the cache for subscribed users, so they'll update at next request
392 # XXX: someone clever could prepend instead of clearing the cache
394 $notice->blowOnInsert();
396 // Save per-notice metadata...
398 if (isset($replies)) {
399 $notice->saveKnownReplies($replies);
401 $notice->saveReplies();
405 $notice->saveKnownTags($tags);
410 // Note: groups may save tags, so must be run after tags are saved
411 // to avoid errors on duplicates.
412 if (isset($groups)) {
413 $notice->saveKnownGroups($groups);
415 $notice->saveGroups();
419 $notice->saveKnownUrls($urls);
424 // Prepare inbox delivery, may be queued to background.
425 $notice->distribute();
430 function blowOnInsert($conversation = false)
432 self::blow('profile:notice_ids:%d', $this->profile_id);
433 self::blow('public');
435 // XXX: Before we were blowing the casche only if the notice id
436 // was not the root of the conversation. What to do now?
438 self::blow('notice:conversation_ids:%d', $this->conversation);
440 if (!empty($this->repeat_of)) {
441 self::blow('notice:repeats:%d', $this->repeat_of);
444 $original = Notice::staticGet('id', $this->repeat_of);
446 if (!empty($original)) {
447 $originalUser = User::staticGet('id', $original->profile_id);
448 if (!empty($originalUser)) {
449 self::blow('user:repeats_of_me:%d', $originalUser->id);
453 $profile = Profile::staticGet($this->profile_id);
454 if (!empty($profile)) {
455 $profile->blowNoticeCount();
460 * Clear cache entries related to this notice at delete time.
461 * Necessary to avoid breaking paging on public, profile timelines.
463 function blowOnDelete()
465 $this->blowOnInsert();
467 self::blow('profile:notice_ids:%d;last', $this->profile_id);
468 self::blow('public;last');
471 /** save all urls in the notice to the db
473 * follow redirects and save all available file information
474 * (mimetype, date, size, oembed, etc.)
478 function saveUrls() {
479 if (common_config('attachments', 'process_links')) {
480 common_replace_urls_callback($this->content, array($this, 'saveUrl'), $this->id);
485 * Save the given URLs as related links/attachments to the db
487 * follow redirects and save all available file information
488 * (mimetype, date, size, oembed, etc.)
492 function saveKnownUrls($urls)
494 if (common_config('attachments', 'process_links')) {
495 // @fixme validation?
496 foreach (array_unique($urls) as $url) {
497 File::processNew($url, $this->id);
505 function saveUrl($data) {
506 list($url, $notice_id) = $data;
507 File::processNew($url, $notice_id);
510 static function checkDupes($profile_id, $content) {
511 $profile = Profile::staticGet($profile_id);
512 if (empty($profile)) {
515 $notice = $profile->getNotices(0, NOTICE_CACHE_WINDOW);
516 if (!empty($notice)) {
518 while ($notice->fetch()) {
519 if (time() - strtotime($notice->created) >= common_config('site', 'dupelimit')) {
521 } else if ($notice->content == $content) {
526 # If we get here, oldest item in cache window is not
527 # old enough for dupe limit; do direct check against DB
528 $notice = new Notice();
529 $notice->profile_id = $profile_id;
530 $notice->content = $content;
531 $threshold = common_sql_date(time() - common_config('site', 'dupelimit'));
532 $notice->whereAdd(sprintf("created > '%s'", $notice->escape($threshold)));
534 $cnt = $notice->count();
538 static function checkEditThrottle($profile_id) {
539 $profile = Profile::staticGet($profile_id);
540 if (empty($profile)) {
544 $notice = $profile->getNotices(common_config('throttle', 'count') - 1, 1);
545 if ($notice && $notice->fetch()) {
546 # If the Nth notice was posted less than timespan seconds ago
547 if (time() - strtotime($notice->created) <= common_config('throttle', 'timespan')) {
552 # Either not N notices in the stream, OR the Nth was not posted within timespan seconds
556 function getUploadedAttachment() {
558 $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"';
559 $post->query($query);
561 if (empty($post->up) || empty($post->i)) {
564 $ret = array($post->up, $post->i);
570 function hasAttachments() {
572 $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);
573 $post->query($query);
575 $n_attachments = intval($post->n_attachments);
577 return $n_attachments;
580 function attachments() {
583 $f2p = new File_to_post;
584 $f2p->post_id = $this->id;
586 while ($f2p->fetch()) {
587 $f = File::staticGet($f2p->file_id);
596 function getStreamByIds($ids)
598 $cache = common_memcache();
600 if (!empty($cache)) {
602 foreach ($ids as $id) {
603 $n = Notice::staticGet('id', $id);
608 return new ArrayWrapper($notices);
610 $notice = new Notice();
612 //if no IDs requested, just return the notice object
615 $notice->whereAdd('id in (' . implode(', ', $ids) . ')');
621 while ($notice->fetch()) {
622 $temp[$notice->id] = clone($notice);
627 foreach ($ids as $id) {
628 if (array_key_exists($id, $temp)) {
629 $wrapped[] = $temp[$id];
633 return new ArrayWrapper($wrapped);
637 function publicStream($offset=0, $limit=20, $since_id=0, $max_id=0)
639 $ids = Notice::stream(array('Notice', '_publicStreamDirect'),
642 $offset, $limit, $since_id, $max_id);
643 return Notice::getStreamByIds($ids);
646 function _publicStreamDirect($offset=0, $limit=20, $since_id=0, $max_id=0)
648 $notice = new Notice();
650 $notice->selectAdd(); // clears it
651 $notice->selectAdd('id');
653 $notice->orderBy('id DESC');
655 if (!is_null($offset)) {
656 $notice->limit($offset, $limit);
659 if (common_config('public', 'localonly')) {
660 $notice->whereAdd('is_local = ' . Notice::LOCAL_PUBLIC);
662 # -1 == blacklisted, -2 == gateway (i.e. Twitter)
663 $notice->whereAdd('is_local !='. Notice::LOCAL_NONPUBLIC);
664 $notice->whereAdd('is_local !='. Notice::GATEWAY);
667 if ($since_id != 0) {
668 $notice->whereAdd('id > ' . $since_id);
672 $notice->whereAdd('id <= ' . $max_id);
677 if ($notice->find()) {
678 while ($notice->fetch()) {
679 $ids[] = $notice->id;
689 function conversationStream($id, $offset=0, $limit=20, $since_id=0, $max_id=0)
691 $ids = Notice::stream(array('Notice', '_conversationStreamDirect'),
693 'notice:conversation_ids:'.$id,
694 $offset, $limit, $since_id, $max_id);
696 return Notice::getStreamByIds($ids);
699 function _conversationStreamDirect($id, $offset=0, $limit=20, $since_id=0, $max_id=0)
701 $notice = new Notice();
703 $notice->selectAdd(); // clears it
704 $notice->selectAdd('id');
706 $notice->conversation = $id;
708 $notice->orderBy('id DESC');
710 if (!is_null($offset)) {
711 $notice->limit($offset, $limit);
714 if ($since_id != 0) {
715 $notice->whereAdd('id > ' . $since_id);
719 $notice->whereAdd('id <= ' . $max_id);
724 if ($notice->find()) {
725 while ($notice->fetch()) {
726 $ids[] = $notice->id;
737 * Is this notice part of an active conversation?
739 * @return boolean true if other messages exist in the same
740 * conversation, false if this is the only one
742 function hasConversation()
744 if (!empty($this->conversation)) {
745 $conversation = Notice::conversationStream(
751 if ($conversation->N > 0) {
759 * Pull up a full list of local recipients who will be getting
760 * this notice in their inbox. Results will be cached, so don't
761 * change the input data wily-nilly!
763 * @param array $groups optional list of Group objects;
764 * if left empty, will be loaded from group_inbox records
765 * @param array $recipient optional list of reply profile ids
766 * if left empty, will be loaded from reply records
767 * @return array associating recipient user IDs with an inbox source constant
769 function whoGets($groups=null, $recipients=null)
771 $c = self::memcache();
774 $ni = $c->get(common_cache_key('notice:who_gets:'.$this->id));
780 if (is_null($groups)) {
781 $groups = $this->getGroups();
784 if (is_null($recipients)) {
785 $recipients = $this->getReplies();
788 $users = $this->getSubscribedUsers();
790 // FIXME: kind of ignoring 'transitional'...
791 // we'll probably stop supporting inboxless mode
796 foreach ($users as $id) {
797 $ni[$id] = NOTICE_INBOX_SOURCE_SUB;
800 foreach ($groups as $group) {
801 $users = $group->getUserMembers();
802 foreach ($users as $id) {
803 if (!array_key_exists($id, $ni)) {
804 $ni[$id] = NOTICE_INBOX_SOURCE_GROUP;
809 foreach ($recipients as $recipient) {
810 if (!array_key_exists($recipient, $ni)) {
811 $ni[$recipient] = NOTICE_INBOX_SOURCE_REPLY;
815 // Exclude any deleted, non-local, or blocking recipients.
816 $profile = $this->getProfile();
817 foreach ($ni as $id => $source) {
818 $user = User::staticGet('id', $id);
819 if (empty($user) || $user->hasBlocked($profile)) {
825 // XXX: pack this data better
826 $c->set(common_cache_key('notice:who_gets:'.$this->id), $ni);
833 * Adds this notice to the inboxes of each local user who should receive
834 * it, based on author subscriptions, group memberships, and @-replies.
836 * Warning: running a second time currently will make items appear
837 * multiple times in users' inboxes.
839 * @fixme make more robust against errors
840 * @fixme break up massive deliveries to smaller background tasks
842 * @param array $groups optional list of Group objects;
843 * if left empty, will be loaded from group_inbox records
844 * @param array $recipient optional list of reply profile ids
845 * if left empty, will be loaded from reply records
847 function addToInboxes($groups=null, $recipients=null)
849 $ni = $this->whoGets($groups, $recipients);
851 $ids = array_keys($ni);
853 // We remove the author (if they're a local user),
854 // since we'll have already done this in distribute()
856 $i = array_search($this->profile_id, $ids);
864 Inbox::bulkInsert($this->id, $ids);
869 function getSubscribedUsers()
873 if(common_config('db','quote_identifiers'))
874 $user_table = '"user"';
875 else $user_table = 'user';
879 'FROM '. $user_table .' JOIN subscription '.
880 'ON '. $user_table .'.id = subscription.subscriber ' .
881 'WHERE subscription.subscribed = %d ';
883 $user->query(sprintf($qry, $this->profile_id));
887 while ($user->fetch()) {
897 * Record this notice to the given group inboxes for delivery.
898 * Overrides the regular parsing of !group markup.
900 * @param string $group_ids
901 * @fixme might prefer URIs as identifiers, as for replies?
902 * best with generalizations on user_group to support
903 * remote groups better.
905 function saveKnownGroups($group_ids)
907 if (!is_array($group_ids)) {
908 // TRANS: Server exception thrown when no array is provided to the method saveKnownGroups().
909 throw new ServerException(_('Bad type provided to saveKnownGroups.'));
913 foreach (array_unique($group_ids) as $id) {
914 $group = User_group::staticGet('id', $id);
916 common_log(LOG_ERR, "Local delivery to group id $id, $group->nickname");
917 $result = $this->addToGroupInbox($group);
919 common_log_db_error($gi, 'INSERT', __FILE__);
922 // @fixme should we save the tags here or not?
923 $groups[] = clone($group);
925 common_log(LOG_ERR, "Local delivery to group id $id skipped, doesn't exist");
933 * Parse !group delivery and record targets into group_inbox.
934 * @return array of Group objects
936 function saveGroups()
938 // Don't save groups for repeats
940 if (!empty($this->repeat_of)) {
946 /* extract all !group */
947 $count = preg_match_all('/(?:^|\s)!([A-Za-z0-9]{1,64})/',
948 strtolower($this->content),
954 $profile = $this->getProfile();
956 /* Add them to the database */
958 foreach (array_unique($match[1]) as $nickname) {
959 /* XXX: remote groups. */
960 $group = User_group::getForNickname($nickname, $profile);
966 // we automatically add a tag for every group name, too
968 $tag = Notice_tag::pkeyGet(array('tag' => common_canonical_tag($nickname),
969 'notice_id' => $this->id));
972 $this->saveTag($nickname);
975 if ($profile->isMember($group)) {
977 $result = $this->addToGroupInbox($group);
980 common_log_db_error($gi, 'INSERT', __FILE__);
983 $groups[] = clone($group);
990 function addToGroupInbox($group)
992 $gi = Group_inbox::pkeyGet(array('group_id' => $group->id,
993 'notice_id' => $this->id));
997 $gi = new Group_inbox();
999 $gi->group_id = $group->id;
1000 $gi->notice_id = $this->id;
1001 $gi->created = $this->created;
1003 $result = $gi->insert();
1006 common_log_db_error($gi, 'INSERT', __FILE__);
1007 // TRANS: Server exception thrown when an update for a group inbox fails.
1008 throw new ServerException(_('Problem saving group inbox.'));
1011 self::blow('user_group:notice_ids:%d', $gi->group_id);
1018 * Save reply records indicating that this notice needs to be
1019 * delivered to the local users with the given URIs.
1021 * Since this is expected to be used when saving foreign-sourced
1022 * messages, we won't deliver to any remote targets as that's the
1023 * source service's responsibility.
1025 * Mail notifications etc will be handled later.
1027 * @param array of unique identifier URIs for recipients
1029 function saveKnownReplies($uris)
1035 $sender = Profile::staticGet($this->profile_id);
1037 foreach (array_unique($uris) as $uri) {
1039 $profile = Profile::fromURI($uri);
1041 if (empty($profile)) {
1042 common_log(LOG_WARNING, "Unable to determine profile for URI '$uri'");
1046 if ($profile->hasBlocked($sender)) {
1047 common_log(LOG_INFO, "Not saving reply to profile {$profile->id} ($uri) from sender {$sender->id} because of a block.");
1051 $reply = new Reply();
1053 $reply->notice_id = $this->id;
1054 $reply->profile_id = $profile->id;
1056 common_log(LOG_INFO, __METHOD__ . ": saving reply: notice $this->id to profile $profile->id");
1058 $id = $reply->insert();
1065 * Pull @-replies from this message's content in StatusNet markup format
1066 * and save reply records indicating that this message needs to be
1067 * delivered to those users.
1069 * Mail notifications to local profiles will be sent later.
1071 * @return array of integer profile IDs
1074 function saveReplies()
1076 // Don't save reply data for repeats
1078 if (!empty($this->repeat_of)) {
1082 $sender = Profile::staticGet($this->profile_id);
1084 // @todo ideally this parser information would only
1085 // be calculated once.
1087 $mentions = common_find_mentions($this->content, $this);
1091 // store replied only for first @ (what user/notice what the reply directed,
1092 // we assume first @ is it)
1094 foreach ($mentions as $mention) {
1096 foreach ($mention['mentioned'] as $mentioned) {
1098 // skip if they're already covered
1100 if (!empty($replied[$mentioned->id])) {
1104 // Don't save replies from blocked profile to local user
1106 $mentioned_user = User::staticGet('id', $mentioned->id);
1107 if (!empty($mentioned_user) && $mentioned_user->hasBlocked($sender)) {
1111 $reply = new Reply();
1113 $reply->notice_id = $this->id;
1114 $reply->profile_id = $mentioned->id;
1116 $id = $reply->insert();
1119 common_log_db_error($reply, 'INSERT', __FILE__);
1120 // TRANS: Server exception thrown when a reply cannot be saved.
1121 // TRANS: %1$d is a notice ID, %2$d is the ID of the mentioned user.
1122 throw new ServerException(sprintf(_('Could not save reply for %1$d, %2$d.'), $this->id, $mentioned->id));
1124 $replied[$mentioned->id] = 1;
1125 self::blow('reply:stream:%d', $mentioned->id);
1130 $recipientIds = array_keys($replied);
1132 return $recipientIds;
1136 * Pull the complete list of @-reply targets for this notice.
1138 * @return array of integer profile ids
1140 function getReplies()
1146 $reply = new Reply();
1147 $reply->selectAdd();
1148 $reply->selectAdd('profile_id');
1149 $reply->notice_id = $this->id;
1151 if ($reply->find()) {
1152 while($reply->fetch()) {
1153 $ids[] = $reply->profile_id;
1163 * Send e-mail notifications to local @-reply targets.
1165 * Replies must already have been saved; this is expected to be run
1166 * from the distrib queue handler.
1168 function sendReplyNotifications()
1170 // Don't send reply notifications for repeats
1172 if (!empty($this->repeat_of)) {
1176 $recipientIds = $this->getReplies();
1178 foreach ($recipientIds as $recipientId) {
1179 $user = User::staticGet('id', $recipientId);
1180 if (!empty($user)) {
1181 mail_notify_attn($user, $this);
1187 * Pull list of groups this notice needs to be delivered to,
1188 * as previously recorded by saveGroups() or saveKnownGroups().
1190 * @return array of Group objects
1192 function getGroups()
1194 // Don't save groups for repeats
1196 if (!empty($this->repeat_of)) {
1204 $gi = new Group_inbox();
1207 $gi->selectAdd('group_id');
1209 $gi->notice_id = $this->id;
1212 while ($gi->fetch()) {
1213 $group = User_group::staticGet('id', $gi->group_id);
1225 function asActivity()
1227 $profile = $this->getProfile();
1229 $act = new Activity();
1231 $act->actor = ActivityObject::fromProfile($profile);
1232 $act->verb = ActivityVerb::POST;
1233 $act->objects[] = ActivityObject::fromNotice($this);
1235 $act->time = strtotime($this->created);
1236 $act->link = $this->bestUrl();
1238 $act->content = common_xml_safe_str($this->rendered);
1239 $act->id = $this->uri;
1240 $act->title = common_xml_safe_str($this->content);
1242 $ctx = new ActivityContext();
1244 if (!empty($this->reply_to)) {
1245 $reply = Notice::staticGet('id', $this->reply_to);
1246 if (!empty($reply)) {
1247 $ctx->replyToID = $reply->uri;
1248 $ctx->replyToUrl = $reply->bestUrl();
1252 $ctx->location = $this->getLocation();
1256 if (!empty($this->conversation)) {
1257 $conv = Conversation::staticGet('id', $this->conversation);
1258 if (!empty($conv)) {
1259 $ctx->conversation = $conv->uri;
1263 $reply_ids = $this->getReplies();
1265 foreach ($reply_ids as $id) {
1266 $profile = Profile::staticGet('id', $id);
1267 if (!empty($profile)) {
1268 $ctx->attention[] = $profile->getUri();
1272 $groups = $this->getGroups();
1274 foreach ($groups as $group) {
1275 $ctx->attention[] = $group->uri;
1278 $act->context = $ctx;
1283 // This has gotten way too long. Needs to be sliced up into functional bits
1284 // or ideally exported to a utility class.
1286 function asAtomEntry($namespace=false, $source=false, $author=true, $cur=null)
1288 $profile = $this->getProfile();
1290 $xs = new XMLStringer(true);
1293 $attrs = array('xmlns' => 'http://www.w3.org/2005/Atom',
1294 'xmlns:thr' => 'http://purl.org/syndication/thread/1.0',
1295 'xmlns:georss' => 'http://www.georss.org/georss',
1296 'xmlns:activity' => 'http://activitystrea.ms/spec/1.0/',
1297 'xmlns:media' => 'http://purl.org/syndication/atommedia',
1298 'xmlns:poco' => 'http://portablecontacts.net/spec/1.0',
1299 'xmlns:ostatus' => 'http://ostatus.org/schema/1.0',
1300 'xmlns:statusnet' => 'http://status.net/schema/api/1/');
1305 if (Event::handle('StartActivityStart', array(&$this, &$xs, &$attrs))) {
1306 $xs->elementStart('entry', $attrs);
1307 Event::handle('EndActivityStart', array(&$this, &$xs, &$attrs));
1310 if (Event::handle('StartActivitySource', array(&$this, &$xs))) {
1312 $atom_feed = $profile->getAtomFeed();
1314 if (!empty($atom_feed)) {
1315 $xs->elementStart('source');
1317 // XXX: we should store the actual feed ID
1319 $xs->element('id', null, $atom_feed);
1321 // XXX: we should store the actual feed title
1323 $xs->element('title', null, $profile->getBestName());
1325 $xs->element('link', array('rel' => 'alternate',
1326 'type' => 'text/html',
1327 'href' => $profile->profileurl));
1329 $xs->element('link', array('rel' => 'self',
1330 'type' => 'application/atom+xml',
1331 'href' => $atom_feed));
1333 $xs->element('icon', null, $profile->avatarUrl(AVATAR_PROFILE_SIZE));
1335 $notice = $profile->getCurrentNotice();
1337 if (!empty($notice)) {
1338 $xs->element('updated', null, self::utcDate($notice->created));
1341 $user = User::staticGet('id', $profile->id);
1343 if (!empty($user)) {
1344 $xs->element('link', array('rel' => 'license',
1345 'href' => common_config('license', 'url')));
1348 $xs->elementEnd('source');
1351 Event::handle('EndActivitySource', array(&$this, &$xs));
1354 $title = common_xml_safe_str($this->content);
1356 if (Event::handle('StartActivityTitle', array(&$this, &$xs, &$title))) {
1357 $xs->element('title', null, $title);
1358 Event::handle('EndActivityTitle', array($this, &$xs, $title));
1364 $atomAuthor = $profile->asAtomAuthor($cur);
1367 if (Event::handle('StartActivityAuthor', array(&$this, &$xs, &$atomAuthor))) {
1368 if (!empty($atomAuthor)) {
1369 $xs->raw($atomAuthor);
1370 Event::handle('EndActivityAuthor', array(&$this, &$xs, &$atomAuthor));
1377 $actor = $profile->asActivityActor();
1380 if (Event::handle('StartActivityActor', array(&$this, &$xs, &$actor))) {
1381 if (!empty($actor)) {
1383 Event::handle('EndActivityActor', array(&$this, &$xs, &$actor));
1387 $url = $this->bestUrl();
1389 if (Event::handle('StartActivityLink', array(&$this, &$xs, &$url))) {
1390 $xs->element('link', array('rel' => 'alternate',
1391 'type' => 'text/html',
1393 Event::handle('EndActivityLink', array(&$this, &$xs, $url));
1398 if (Event::handle('StartActivityId', array(&$this, &$xs, &$id))) {
1399 $xs->element('id', null, $id);
1400 Event::handle('EndActivityId', array(&$this, &$xs, $id));
1403 $published = self::utcDate($this->created);
1405 if (Event::handle('StartActivityPublished', array(&$this, &$xs, &$published))) {
1406 $xs->element('published', null, $published);
1407 Event::handle('EndActivityPublished', array(&$this, &$xs, $published));
1410 $updated = $published; // XXX: notices are usually immutable
1412 if (Event::handle('StartActivityUpdated', array(&$this, &$xs, &$updated))) {
1413 $xs->element('updated', null, $updated);
1414 Event::handle('EndActivityUpdated', array(&$this, &$xs, $updated));
1417 $content = common_xml_safe_str($this->rendered);
1419 if (Event::handle('StartActivityContent', array(&$this, &$xs, &$content))) {
1420 $xs->element('content', array('type' => 'html'), $content);
1421 Event::handle('EndActivityContent', array(&$this, &$xs, $content));
1424 // Most of our notices represent POSTing a NOTE. This is the default verb
1425 // for activity streams, so we normally just leave it out.
1427 $verb = ActivityVerb::POST;
1429 if (Event::handle('StartActivityVerb', array(&$this, &$xs, &$verb))) {
1430 $xs->element('activity:verb', null, $verb);
1431 Event::handle('EndActivityVerb', array(&$this, &$xs, $verb));
1434 // We use the default behavior for activity streams: if there's no activity:object,
1435 // then treat the entry itself as the object. Here, you can set the type of that object,
1436 // which is normally a NOTE.
1438 $type = ActivityObject::NOTE;
1440 if (Event::handle('StartActivityDefaultObjectType', array(&$this, &$xs, &$type))) {
1441 $xs->element('activity:object-type', null, $type);
1442 Event::handle('EndActivityDefaultObjectType', array(&$this, &$xs, $type));
1445 // Since we usually use the entry itself as an object, we don't have an explicit
1446 // object. Some extensions may want to add them (for photo, event, music, etc.).
1450 if (Event::handle('StartActivityObjects', array(&$this, &$xs, &$objects))) {
1451 foreach ($objects as $object) {
1452 $xs->raw($object->asString());
1454 Event::handle('EndActivityObjects', array(&$this, &$xs, $objects));
1457 $noticeInfoAttr = array('local_id' => $this->id); // local notice ID (useful to clients for ordering)
1459 $ns = $this->getSource();
1462 $noticeInfoAttr['source'] = $ns->code;
1463 if (!empty($ns->url)) {
1464 $noticeInfoAttr['source_link'] = $ns->url;
1465 if (!empty($ns->name)) {
1466 $noticeInfoAttr['source'] = '<a href="'
1467 . htmlspecialchars($ns->url)
1468 . '" rel="nofollow">'
1469 . htmlspecialchars($ns->name)
1476 $noticeInfoAttr['favorite'] = ($cur->hasFave($this)) ? "true" : "false";
1477 $profile = $cur->getProfile();
1478 $noticeInfoAttr['repeated'] = ($profile->hasRepeated($this->id)) ? "true" : "false";
1481 if (!empty($this->repeat_of)) {
1482 $noticeInfoAttr['repeat_of'] = $this->repeat_of;
1485 if (Event::handle('StartActivityNoticeInfo', array(&$this, &$xs, &$noticeInfoAttr))) {
1486 $xs->element('statusnet:notice_info', $noticeInfoAttr, null);
1487 Event::handle('EndActivityNoticeInfo', array(&$this, &$xs, $noticeInfoAttr));
1490 $replyNotice = null;
1492 if ($this->reply_to) {
1493 $replyNotice = Notice::staticGet('id', $this->reply_to);
1496 if (Event::handle('StartActivityInReplyTo', array(&$this, &$xs, &$replyNotice))) {
1497 if (!empty($replyNotice)) {
1498 $xs->element('link', array('rel' => 'related',
1499 'href' => $replyNotice->bestUrl()));
1500 $xs->element('thr:in-reply-to',
1501 array('ref' => $replyNotice->uri,
1502 'href' => $replyNotice->bestUrl()));
1503 Event::handle('EndActivityInReplyTo', array(&$this, &$xs, $replyNotice));
1509 if (!empty($this->conversation)) {
1510 $conv = Conversation::staticGet('id', $this->conversation);
1513 if (Event::handle('StartActivityConversation', array(&$this, &$xs, &$conv))) {
1514 if (!empty($conv)) {
1515 $xs->element('link', array('rel' => 'ostatus:conversation',
1516 'href' => $conv->uri));
1518 Event::handle('EndActivityConversation', array(&$this, &$xs, $conv));
1521 $replyProfiles = array();
1523 $reply_ids = $this->getReplies();
1525 foreach ($reply_ids as $id) {
1526 $profile = Profile::staticGet('id', $id);
1527 if (!empty($profile)) {
1528 $replyProfiles[] = $profile;
1532 if (Event::handle('StartActivityAttentionProfiles', array(&$this, &$xs, &$replyProfiles))) {
1533 foreach ($replyProfiles as $profile) {
1534 $xs->element('link', array('rel' => 'ostatus:attention',
1535 'href' => $profile->getUri()));
1536 $xs->element('link', array('rel' => 'mentioned',
1537 'href' => $profile->getUri()));
1539 Event::handle('EndActivityAttentionProfiles', array(&$this, &$xs, $replyProfiles));
1542 $groups = $this->getGroups();
1544 if (Event::handle('StartActivityAttentionGroups', array(&$this, &$xs, &$groups))) {
1545 foreach ($groups as $group) {
1546 $xs->element('link', array('rel' => 'ostatus:attention',
1547 'href' => $group->permalink()));
1548 $xs->element('link', array('rel' => 'mentioned',
1549 'href' => $group->permalink()));
1551 Event::handle('EndActivityAttentionGroups', array(&$this, &$xs, $groups));
1556 if (!empty($this->repeat_of)) {
1557 $repeat = Notice::staticGet('id', $this->repeat_of);
1560 if (Event::handle('StartActivityForward', array(&$this, &$xs, &$repeat))) {
1561 if (!empty($repeat)) {
1562 $xs->element('ostatus:forward',
1563 array('ref' => $repeat->uri,
1564 'href' => $repeat->bestUrl()));
1567 Event::handle('EndActivityForward', array(&$this, &$xs, $repeat));
1570 $tags = $this->getTags();
1572 if (Event::handle('StartActivityCategories', array(&$this, &$xs, &$tags))) {
1573 foreach ($tags as $tag) {
1574 $xs->element('category', array('term' => $tag));
1576 Event::handle('EndActivityCategories', array(&$this, &$xs, $tags));
1581 $enclosures = array();
1583 $attachments = $this->attachments();
1585 foreach ($attachments as $attachment) {
1586 $enclosure = $attachment->getEnclosure();
1588 $enclosures[] = $enclosure;
1592 if (Event::handle('StartActivityEnclosures', array(&$this, &$xs, &$enclosures))) {
1593 foreach ($enclosures as $enclosure) {
1594 $attributes = array('rel' => 'enclosure',
1595 'href' => $enclosure->url,
1596 'type' => $enclosure->mimetype,
1597 'length' => $enclosure->size);
1599 if ($enclosure->title) {
1600 $attributes['title'] = $enclosure->title;
1603 $xs->element('link', $attributes, null);
1605 Event::handle('EndActivityEnclosures', array(&$this, &$xs, $enclosures));
1611 if (Event::handle('StartActivityGeo', array(&$this, &$xs, &$lat, &$lon))) {
1612 if (!empty($lat) && !empty($lon)) {
1613 $xs->element('georss:point', null, $lat . ' ' . $lon);
1615 Event::handle('EndActivityGeo', array(&$this, &$xs, $lat, $lon));
1618 // @fixme check this logic
1620 if ($this->isLocal()) {
1622 $selfUrl = common_local_url('ApiStatusesShow', array('id' => $this->id,
1623 'format' => 'atom'));
1625 if (Event::handle('StartActivityRelSelf', array(&$this, &$xs, &$selfUrl))) {
1626 $xs->element('link', array('rel' => 'self',
1627 'type' => 'application/atom+xml',
1628 'href' => $selfUrl));
1629 Event::handle('EndActivityRelSelf', array(&$this, &$xs, $selfUrl));
1632 if (!empty($cur) && $cur->id == $this->profile_id) {
1634 // note: $selfUrl may have been changed by a plugin
1635 $relEditUrl = common_local_url('ApiStatusesShow', array('id' => $this->id,
1636 'format' => 'atom'));
1638 if (Event::handle('StartActivityRelEdit', array(&$this, &$xs, &$relEditUrl))) {
1639 $xs->element('link', array('rel' => 'edit',
1640 'type' => 'application/atom+xml',
1641 'href' => $relEditUrl));
1642 Event::handle('EndActivityRelEdit', array(&$this, &$xs, $relEditUrl));
1647 if (Event::handle('StartActivityEnd', array(&$this, &$xs))) {
1648 $xs->elementEnd('entry');
1649 Event::handle('EndActivityEnd', array(&$this, &$xs));
1652 return $xs->getString();
1656 * Returns an XML string fragment with a reference to a notice as an
1657 * Activity Streams noun object with the given element type.
1659 * Assumes that 'activity' namespace has been previously defined.
1661 * @param string $element one of 'subject', 'object', 'target'
1664 function asActivityNoun($element)
1666 $noun = ActivityObject::fromNotice($this);
1667 return $noun->asString('activity:' . $element);
1672 if (!empty($this->url)) {
1674 } else if (!empty($this->uri) && preg_match('/^https?:/', $this->uri)) {
1677 return common_local_url('shownotice',
1678 array('notice' => $this->id));
1682 function stream($fn, $args, $cachekey, $offset=0, $limit=20, $since_id=0, $max_id=0)
1684 $cache = common_memcache();
1686 if (empty($cache) ||
1687 $since_id != 0 || $max_id != 0 ||
1689 ($offset + $limit) > NOTICE_CACHE_WINDOW) {
1690 return call_user_func_array($fn, array_merge($args, array($offset, $limit, $since_id,
1694 $idkey = common_cache_key($cachekey);
1696 $idstr = $cache->get($idkey);
1698 if ($idstr !== false) {
1699 // Cache hit! Woohoo!
1700 $window = explode(',', $idstr);
1701 $ids = array_slice($window, $offset, $limit);
1705 $laststr = $cache->get($idkey.';last');
1707 if ($laststr !== false) {
1708 $window = explode(',', $laststr);
1709 $last_id = $window[0];
1710 $new_ids = call_user_func_array($fn, array_merge($args, array(0, NOTICE_CACHE_WINDOW,
1711 $last_id, 0, null)));
1713 $new_window = array_merge($new_ids, $window);
1715 $new_windowstr = implode(',', $new_window);
1717 $result = $cache->set($idkey, $new_windowstr);
1718 $result = $cache->set($idkey . ';last', $new_windowstr);
1720 $ids = array_slice($new_window, $offset, $limit);
1725 $window = call_user_func_array($fn, array_merge($args, array(0, NOTICE_CACHE_WINDOW,
1728 $windowstr = implode(',', $window);
1730 $result = $cache->set($idkey, $windowstr);
1731 $result = $cache->set($idkey . ';last', $windowstr);
1733 $ids = array_slice($window, $offset, $limit);
1739 * Determine which notice, if any, a new notice is in reply to.
1741 * For conversation tracking, we try to see where this notice fits
1742 * in the tree. Rough algorithm is:
1744 * if (reply_to is set and valid) {
1746 * } else if ((source not API or Web) and (content starts with "T NAME" or "@name ")) {
1747 * return ID of last notice by initial @name in content;
1750 * Note that all @nickname instances will still be used to save "reply" records,
1751 * so the notice shows up in the mentioned users' "replies" tab.
1753 * @param integer $reply_to ID passed in by Web or API
1754 * @param integer $profile_id ID of author
1755 * @param string $source Source tag, like 'web' or 'gwibber'
1756 * @param string $content Final notice content
1758 * @return integer ID of replied-to notice, or null for not a reply.
1761 static function getReplyTo($reply_to, $profile_id, $source, $content)
1763 static $lb = array('xmpp', 'mail', 'sms', 'omb');
1765 // If $reply_to is specified, we check that it exists, and then
1766 // return it if it does
1768 if (!empty($reply_to)) {
1769 $reply_notice = Notice::staticGet('id', $reply_to);
1770 if (!empty($reply_notice)) {
1775 // If it's not a "low bandwidth" source (one where you can't set
1776 // a reply_to argument), we return. This is mostly web and API
1779 if (!in_array($source, $lb)) {
1783 // Is there an initial @ or T?
1785 if (preg_match('/^T ([A-Z0-9]{1,64}) /', $content, $match) ||
1786 preg_match('/^@([a-z0-9]{1,64})\s+/', $content, $match)) {
1787 $nickname = common_canonical_nickname($match[1]);
1792 // Figure out who that is.
1794 $sender = Profile::staticGet('id', $profile_id);
1795 if (empty($sender)) {
1799 $recipient = common_relative_profile($sender, $nickname, common_sql_now());
1801 if (empty($recipient)) {
1805 // Get their last notice
1807 $last = $recipient->getCurrentNotice();
1809 if (!empty($last)) {
1814 static function maxContent()
1816 $contentlimit = common_config('notice', 'contentlimit');
1817 // null => use global limit (distinct from 0!)
1818 if (is_null($contentlimit)) {
1819 $contentlimit = common_config('site', 'textlimit');
1821 return $contentlimit;
1824 static function contentTooLong($content)
1826 $contentlimit = self::maxContent();
1827 return ($contentlimit > 0 && !empty($content) && (mb_strlen($content) > $contentlimit));
1830 function getLocation()
1834 if (!empty($this->location_id) && !empty($this->location_ns)) {
1835 $location = Location::fromId($this->location_id, $this->location_ns);
1838 if (is_null($location)) { // no ID, or Location::fromId() failed
1839 if (!empty($this->lat) && !empty($this->lon)) {
1840 $location = Location::fromLatLon($this->lat, $this->lon);
1847 function repeat($repeater_id, $source)
1849 $author = Profile::staticGet('id', $this->profile_id);
1851 // TRANS: Message used to repeat a notice. RT is the abbreviation of 'retweet'.
1852 // TRANS: %1$s is the repeated user's name, %2$s is the repeated notice.
1853 $content = sprintf(_('RT @%1$s %2$s'),
1857 $maxlen = common_config('site', 'textlimit');
1858 if ($maxlen > 0 && mb_strlen($content) > $maxlen) {
1859 // Web interface and current Twitter API clients will
1860 // pull the original notice's text, but some older
1861 // clients and RSS/Atom feeds will see this trimmed text.
1863 // Unfortunately this is likely to lose tags or URLs
1864 // at the end of long notices.
1865 $content = mb_substr($content, 0, $maxlen - 4) . ' ...';
1868 return self::saveNew($repeater_id, $content, $source,
1869 array('repeat_of' => $this->id));
1872 // These are supposed to be in chron order!
1874 function repeatStream($limit=100)
1876 $cache = common_memcache();
1878 if (empty($cache)) {
1879 $ids = $this->_repeatStreamDirect($limit);
1881 $idstr = $cache->get(common_cache_key('notice:repeats:'.$this->id));
1882 if ($idstr !== false) {
1883 $ids = explode(',', $idstr);
1885 $ids = $this->_repeatStreamDirect(100);
1886 $cache->set(common_cache_key('notice:repeats:'.$this->id), implode(',', $ids));
1889 // We do a max of 100, so slice down to limit
1890 $ids = array_slice($ids, 0, $limit);
1894 return Notice::getStreamByIds($ids);
1897 function _repeatStreamDirect($limit)
1899 $notice = new Notice();
1901 $notice->selectAdd(); // clears it
1902 $notice->selectAdd('id');
1904 $notice->repeat_of = $this->id;
1906 $notice->orderBy('created'); // NB: asc!
1908 if (!is_null($offset)) {
1909 $notice->limit($offset, $limit);
1914 if ($notice->find()) {
1915 while ($notice->fetch()) {
1916 $ids[] = $notice->id;
1926 function locationOptions($lat, $lon, $location_id, $location_ns, $profile = null)
1930 if (!empty($location_id) && !empty($location_ns)) {
1931 $options['location_id'] = $location_id;
1932 $options['location_ns'] = $location_ns;
1934 $location = Location::fromId($location_id, $location_ns);
1936 if (!empty($location)) {
1937 $options['lat'] = $location->lat;
1938 $options['lon'] = $location->lon;
1941 } else if (!empty($lat) && !empty($lon)) {
1942 $options['lat'] = $lat;
1943 $options['lon'] = $lon;
1945 $location = Location::fromLatLon($lat, $lon);
1947 if (!empty($location)) {
1948 $options['location_id'] = $location->location_id;
1949 $options['location_ns'] = $location->location_ns;
1951 } else if (!empty($profile)) {
1952 if (isset($profile->lat) && isset($profile->lon)) {
1953 $options['lat'] = $profile->lat;
1954 $options['lon'] = $profile->lon;
1957 if (isset($profile->location_id) && isset($profile->location_ns)) {
1958 $options['location_id'] = $profile->location_id;
1959 $options['location_ns'] = $profile->location_ns;
1966 function clearReplies()
1968 $replyNotice = new Notice();
1969 $replyNotice->reply_to = $this->id;
1971 //Null any notices that are replies to this notice
1973 if ($replyNotice->find()) {
1974 while ($replyNotice->fetch()) {
1975 $orig = clone($replyNotice);
1976 $replyNotice->reply_to = null;
1977 $replyNotice->update($orig);
1983 $reply = new Reply();
1984 $reply->notice_id = $this->id;
1986 if ($reply->find()) {
1987 while($reply->fetch()) {
1988 self::blow('reply:stream:%d', $reply->profile_id);
1996 function clearRepeats()
1998 $repeatNotice = new Notice();
1999 $repeatNotice->repeat_of = $this->id;
2001 //Null any notices that are repeats of this notice
2003 if ($repeatNotice->find()) {
2004 while ($repeatNotice->fetch()) {
2005 $orig = clone($repeatNotice);
2006 $repeatNotice->repeat_of = null;
2007 $repeatNotice->update($orig);
2012 function clearFaves()
2015 $fave->notice_id = $this->id;
2017 if ($fave->find()) {
2018 while ($fave->fetch()) {
2019 self::blow('fave:ids_by_user_own:%d', $fave->user_id);
2020 self::blow('fave:ids_by_user_own:%d;last', $fave->user_id);
2021 self::blow('fave:ids_by_user:%d', $fave->user_id);
2022 self::blow('fave:ids_by_user:%d;last', $fave->user_id);
2030 function clearTags()
2032 $tag = new Notice_tag();
2033 $tag->notice_id = $this->id;
2036 while ($tag->fetch()) {
2037 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, common_keyize($tag->tag));
2038 self::blow('profile:notice_ids_tagged:%d:%s;last', $this->profile_id, common_keyize($tag->tag));
2039 self::blow('notice_tag:notice_ids:%s', common_keyize($tag->tag));
2040 self::blow('notice_tag:notice_ids:%s;last', common_keyize($tag->tag));
2048 function clearGroupInboxes()
2050 $gi = new Group_inbox();
2052 $gi->notice_id = $this->id;
2055 while ($gi->fetch()) {
2056 self::blow('user_group:notice_ids:%d', $gi->group_id);
2064 function distribute()
2066 // We always insert for the author so they don't
2068 Event::handle('StartNoticeDistribute', array($this));
2070 $user = User::staticGet('id', $this->profile_id);
2071 if (!empty($user)) {
2072 Inbox::insertNotice($user->id, $this->id);
2075 if (common_config('queue', 'inboxes')) {
2076 // If there's a failure, we want to _force_
2077 // distribution at this point.
2079 $qm = QueueManager::get();
2080 $qm->enqueue($this, 'distrib');
2081 } catch (Exception $e) {
2082 // If the exception isn't transient, this
2083 // may throw more exceptions as DQH does
2084 // its own enqueueing. So, we ignore them!
2086 $handler = new DistribQueueHandler();
2087 $handler->handle($this);
2088 } catch (Exception $e) {
2089 common_log(LOG_ERR, "emergency redistribution resulted in " . $e->getMessage());
2091 // Re-throw so somebody smarter can handle it.
2095 $handler = new DistribQueueHandler();
2096 $handler->handle($this);
2102 $result = parent::insert();
2105 // Profile::hasRepeated() abuses pkeyGet(), so we
2106 // have to clear manually
2107 if (!empty($this->repeat_of)) {
2108 $c = self::memcache();
2110 $ck = self::multicacheKey('Notice',
2111 array('profile_id' => $this->profile_id,
2112 'repeat_of' => $this->repeat_of));
2122 * Get the source of the notice
2124 * @return Notice_source $ns A notice source object. 'code' is the only attribute
2125 * guaranteed to be populated.
2127 function getSource()
2129 $ns = new Notice_source();
2130 if (!empty($this->source)) {
2131 switch ($this->source) {
2138 $ns->code = $this->source;
2141 $ns = Notice_source::staticGet($this->source);
2143 $ns = new Notice_source();
2144 $ns->code = $this->source;
2145 $app = Oauth_application::staticGet('name', $this->source);
2147 $ns->name = $app->name;
2148 $ns->url = $app->source_url;
2158 * Determine whether the notice was locally created
2160 * @return boolean locality
2163 public function isLocal()
2165 return ($this->is_local == Notice::LOCAL_PUBLIC ||
2166 $this->is_local == Notice::LOCAL_NONPUBLIC);
2169 public function getTags()
2172 $tag = new Notice_tag();
2173 $tag->notice_id = $this->id;
2175 while ($tag->fetch()) {
2176 $tags[] = $tag->tag;
2183 static private function utcDate($dt)
2185 $dateStr = date('d F Y H:i:s', strtotime($dt));
2186 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
2187 return $d->format(DATE_W3C);