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/>.
20 if (!defined('STATUSNET') && !defined('LACONICA')) {
25 * Table Definition for user
28 require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
29 require_once 'Validate.php';
31 class User extends Memcached_DataObject
34 /* the code below is auto generated do not remove the above tag */
36 public $__table = 'user'; // table name
37 public $id; // int(4) primary_key not_null
38 public $nickname; // varchar(64) unique_key
39 public $password; // varchar(255)
40 public $email; // varchar(255) unique_key
41 public $incomingemail; // varchar(255) unique_key
42 public $emailnotifysub; // tinyint(1) default_1
43 public $emailnotifyfav; // tinyint(1) default_1
44 public $emailnotifynudge; // tinyint(1) default_1
45 public $emailnotifymsg; // tinyint(1) default_1
46 public $emailnotifyattn; // tinyint(1) default_1
47 public $emailmicroid; // tinyint(1) default_1
48 public $language; // varchar(50)
49 public $timezone; // varchar(50)
50 public $emailpost; // tinyint(1) default_1
51 public $jabber; // varchar(255) unique_key
52 public $jabbernotify; // tinyint(1)
53 public $jabberreplies; // tinyint(1)
54 public $jabbermicroid; // tinyint(1) default_1
55 public $updatefrompresence; // tinyint(1)
56 public $sms; // varchar(64) unique_key
57 public $carrier; // int(4)
58 public $smsnotify; // tinyint(1)
59 public $smsreplies; // tinyint(1)
60 public $smsemail; // varchar(255)
61 public $uri; // varchar(255) unique_key
62 public $autosubscribe; // tinyint(1)
63 public $urlshorteningservice; // varchar(50) default_ur1.ca
64 public $inboxed; // tinyint(1)
65 public $design_id; // int(4)
66 public $viewdesigns; // tinyint(1) default_1
67 public $created; // datetime() not_null
68 public $modified; // timestamp() not_null default_CURRENT_TIMESTAMP
71 function staticGet($k,$v=NULL) { return Memcached_DataObject::staticGet('User',$k,$v); }
73 /* the code above is auto generated do not remove the tag below */
78 return Profile::staticGet('id', $this->id);
81 function isSubscribed($other)
83 assert(!is_null($other));
84 // XXX: cache results of this query
85 $sub = Subscription::pkeyGet(array('subscriber' => $this->id,
86 'subscribed' => $other->id));
87 return (is_null($sub)) ? false : true;
90 // 'update' won't write key columns, so we have to do it ourselves.
92 function updateKeys(&$orig)
95 foreach (array('nickname', 'email', 'jabber', 'incomingemail', 'sms', 'carrier', 'smsemail', 'language', 'timezone') as $k) {
96 if (strcmp($this->$k, $orig->$k) != 0) {
97 $parts[] = $k . ' = ' . $this->_quote($this->$k);
100 if (count($parts) == 0) {
104 $toupdate = implode(', ', $parts);
106 $table = common_database_tablename($this->tableName());
107 $qry = 'UPDATE ' . $table . ' SET ' . $toupdate .
108 ' WHERE id = ' . $this->id;
110 $result = $this->query($qry);
117 static function allowed_nickname($nickname)
119 // XXX: should already be validated for size, content, etc.
120 $blacklist = common_config('nickname', 'blacklist');
122 //all directory and file names should be blacklisted
123 $d = dir(INSTALLDIR);
124 while (false !== ($entry = $d->read())) {
129 //all top level names in the router should be blacklisted
130 $router = Router::get();
131 foreach(array_keys($router->m->getPaths()) as $path){
132 if(preg_match('/^\/(.*?)[\/\?]/',$path,$matches)){
133 $blacklist[]=$matches[1];
136 return !in_array($nickname, $blacklist);
139 function getCurrentNotice($dt=null)
141 $profile = $this->getProfile();
145 return $profile->getCurrentNotice($dt);
148 function getCarrier()
150 return Sms_carrier::staticGet('id', $this->carrier);
153 function subscribeTo($other)
155 $sub = new Subscription();
156 $sub->subscriber = $this->id;
157 $sub->subscribed = $other->id;
159 $sub->created = common_sql_now(); // current time
161 if (!$sub->insert()) {
168 function hasBlocked($other)
171 $block = Profile_block::get($this->id, $other->id);
173 if (is_null($block)) {
184 * Register a new user account and profile and set up default subscriptions.
185 * If a new-user welcome message is configured, this will be sent.
187 * @param array $fields associative array of optional properties
190 * bool 'email_confirmed' pass true to mark email as pre-confirmed
193 * string 'location' informal string description of geolocation
194 * float 'lat' decimal latitude for geolocation
195 * float 'lon' decimal longitude for geolocation
196 * int 'location_id' geoname identifier
197 * int 'location_ns' geoname namespace to interpret location_id
198 * string 'nickname' REQUIRED
199 * string 'password' (may be missing for eg OpenID registrations)
200 * string 'code' invite code
201 * ?string 'uri' permalink to notice; defaults to local notice URL
202 * @return mixed User object or false on failure
204 static function register($fields) {
206 // MAGICALLY put fields into current scope
210 $profile = new Profile();
212 $profile->query('BEGIN');
216 $email = common_canonical_email($email);
219 $nickname = common_canonical_nickname($nickname);
220 $profile->nickname = $nickname;
221 if(! User::allowed_nickname($nickname)){
222 common_log(LOG_WARNING, sprintf("Attempted to register a nickname that is not allowed: %s", $profile->nickname),
225 $profile->profileurl = common_profile_url($nickname);
227 if (!empty($fullname)) {
228 $profile->fullname = $fullname;
230 if (!empty($homepage)) {
231 $profile->homepage = $homepage;
234 $profile->bio = $bio;
236 if (!empty($location)) {
237 $profile->location = $location;
239 $loc = Location::fromName($location);
242 $profile->lat = $loc->lat;
243 $profile->lon = $loc->lon;
244 $profile->location_id = $loc->location_id;
245 $profile->location_ns = $loc->location_ns;
249 $profile->created = common_sql_now();
251 $id = $profile->insert();
254 common_log_db_error($profile, 'INSERT', __FILE__);
261 $user->nickname = $nickname;
263 if (!empty($password)) { // may not have a password for OpenID users
264 $user->password = common_munge_password($password, $id);
267 // Users who respond to invite email have proven their ownership of that address
270 $invite = Invitation::staticGet($code);
271 if ($invite && $invite->address && $invite->address_type == 'email' && $invite->address == $email) {
272 $user->email = $invite->address;
276 if(isset($email_confirmed) && $email_confirmed) {
277 $user->email = $email;
280 // This flag is ignored but still set to 1
284 $user->created = common_sql_now();
285 $user->uri = common_user_uri($user);
287 $result = $user->insert();
290 common_log_db_error($user, 'INSERT', __FILE__);
294 // Everyone gets an inbox
296 $inbox = new Inbox();
298 $inbox->user_id = $user->id;
300 $result = $inbox->insert();
303 common_log_db_error($inbox, 'INSERT', __FILE__);
307 // Everyone is subscribed to themself
309 $subscription = new Subscription();
310 $subscription->subscriber = $user->id;
311 $subscription->subscribed = $user->id;
312 $subscription->created = $user->created;
314 $result = $subscription->insert();
317 common_log_db_error($subscription, 'INSERT', __FILE__);
321 if (!empty($email) && !$user->email) {
323 $confirm = new Confirm_address();
324 $confirm->code = common_confirmation_code(128);
325 $confirm->user_id = $user->id;
326 $confirm->address = $email;
327 $confirm->address_type = 'email';
329 $result = $confirm->insert();
331 common_log_db_error($confirm, 'INSERT', __FILE__);
336 if (!empty($code) && $user->email) {
337 $user->emailChanged();
340 // Default system subscription
342 $defnick = common_config('newuser', 'default');
344 if (!empty($defnick)) {
345 $defuser = User::staticGet('nickname', $defnick);
346 if (empty($defuser)) {
347 common_log(LOG_WARNING, sprintf("Default user %s does not exist.", $defnick),
350 $defsub = new Subscription();
351 $defsub->subscriber = $user->id;
352 $defsub->subscribed = $defuser->id;
353 $defsub->created = $user->created;
355 $result = $defsub->insert();
358 common_log_db_error($defsub, 'INSERT', __FILE__);
364 $profile->query('COMMIT');
366 if (!empty($email) && !$user->email) {
367 mail_confirm_address($user, $confirm->code, $profile->nickname, $email);
372 $welcome = common_config('newuser', 'welcome');
374 if (!empty($welcome)) {
375 $welcomeuser = User::staticGet('nickname', $welcome);
376 if (empty($welcomeuser)) {
377 common_log(LOG_WARNING, sprintf("Welcome user %s does not exist.", $defnick),
380 $notice = Notice::saveNew($welcomeuser->id,
381 sprintf(_('Welcome to %1$s, @%2$s!'),
382 common_config('site', 'name'),
385 common_broadcast_notice($notice);
392 // Things we do when the email changes
394 function emailChanged()
397 $invites = new Invitation();
398 $invites->address = $this->email;
399 $invites->address_type = 'email';
401 if ($invites->find()) {
402 while ($invites->fetch()) {
403 $other = User::staticGet($invites->user_id);
404 subs_subscribe_to($other, $this);
409 function hasFave($notice)
411 $cache = common_memcache();
413 // XXX: Kind of a hack.
416 // This is the stream of favorite notices, in rev chron
417 // order. This forces it into cache.
419 $ids = Fave::stream($this->id, 0, NOTICE_CACHE_WINDOW);
421 // If it's in the list, then it's a fave
423 if (in_array($notice->id, $ids)) {
427 // If we're not past the end of the cache window,
428 // then the cache has all available faves, so this one
431 if (count($ids) < NOTICE_CACHE_WINDOW) {
435 // Otherwise, cache doesn't have all faves;
436 // fall through to the default
439 $fave = Fave::pkeyGet(array('user_id' => $this->id,
440 'notice_id' => $notice->id));
441 return ((is_null($fave)) ? false : true);
444 function mutuallySubscribed($other)
446 return $this->isSubscribed($other) &&
447 $other->isSubscribed($this);
450 function mutuallySubscribedUsers()
452 // 3-way join; probably should get cached
453 $UT = common_config('db','type')=='pgsql'?'"user"':'user';
454 $qry = "SELECT $UT.* " .
455 "FROM subscription sub1 JOIN $UT ON sub1.subscribed = $UT.id " .
456 "JOIN subscription sub2 ON $UT.id = sub2.subscriber " .
457 'WHERE sub1.subscriber = %d and sub2.subscribed = %d ' .
458 "ORDER BY $UT.nickname";
460 $user->query(sprintf($qry, $this->id, $this->id));
465 function getReplies($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0, $since=null)
467 $ids = Reply::stream($this->id, $offset, $limit, $since_id, $before_id, $since);
468 return Notice::getStreamByIds($ids);
471 function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0, $since=null) {
472 $profile = $this->getProfile();
476 return $profile->getTaggedNotices($tag, $offset, $limit, $since_id, $before_id, $since);
480 function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0, $since=null)
482 $profile = $this->getProfile();
486 return $profile->getNotices($offset, $limit, $since_id, $before_id, $since);
490 function favoriteNotices($offset=0, $limit=NOTICES_PER_PAGE, $own=false)
492 $ids = Fave::stream($this->id, $offset, $limit, $own);
493 return Notice::getStreamByIds($ids);
496 function noticesWithFriends($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0, $since=null)
498 $ids = Inbox::stream($this->id, $offset, $limit, $since_id, $before_id, $since, false);
499 return Notice::getStreamByIds($ids);
502 function noticeInbox($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0, $since=null)
504 $ids = Inbox::stream($this->id, $offset, $limit, $since_id, $before_id, $since, true);
505 return Notice::getStreamByIds($ids);
508 function friendsTimeline($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0, $since=null)
510 $ids = Inbox::stream($this->id, $offset, $limit, $since_id, $before_id, $since, false);
512 return Notice::getStreamByIds($ids);
515 function ownFriendsTimeline($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0, $since=null)
517 $ids = Inbox::stream($this->id, $offset, $limit, $since_id, $before_id, $since, true);
519 return Notice::getStreamByIds($ids);
522 function blowFavesCache()
524 $cache = common_memcache();
526 // Faves don't happen chronologically, so we need to blow
528 $cache->delete(common_cache_key('fave:ids_by_user:'.$this->id));
529 $cache->delete(common_cache_key('fave:ids_by_user:'.$this->id.';last'));
530 $cache->delete(common_cache_key('fave:ids_by_user_own:'.$this->id));
531 $cache->delete(common_cache_key('fave:ids_by_user_own:'.$this->id.';last'));
533 $profile = $this->getProfile();
534 $profile->blowFaveCount();
537 function getSelfTags()
539 return Profile_tag::getTags($this->id, $this->id);
542 function setSelfTags($newtags)
544 return Profile_tag::setTags($this->id, $this->id, $newtags);
547 function block($other)
549 // Add a new block record
551 // no blocking (and thus unsubbing from) yourself
553 if ($this->id == $other->id) {
554 common_log(LOG_WARNING,
556 "Profile ID %d (%s) tried to block his or herself.",
564 $block = new Profile_block();
566 // Begin a transaction
568 $block->query('BEGIN');
570 $block->blocker = $this->id;
571 $block->blocked = $other->id;
573 $result = $block->insert();
576 common_log_db_error($block, 'INSERT', __FILE__);
580 // Cancel their subscription, if it exists
582 $otherUser = User::staticGet('id', $other->id);
584 if (!empty($otherUser)) {
585 subs_unsubscribe_to($otherUser, $this->getProfile());
588 $block->query('COMMIT');
593 function unblock($other)
595 // Get the block record
597 $block = Profile_block::get($this->id, $other->id);
603 $result = $block->delete();
606 common_log_db_error($block, 'DELETE', __FILE__);
613 function isMember($group)
615 $profile = $this->getProfile();
616 return $profile->isMember($group);
619 function isAdmin($group)
621 $profile = $this->getProfile();
622 return $profile->isAdmin($group);
625 function getGroups($offset=0, $limit=null)
628 'SELECT user_group.* ' .
629 'FROM user_group JOIN group_member '.
630 'ON user_group.id = group_member.group_id ' .
631 'WHERE group_member.profile_id = %d ' .
632 'ORDER BY group_member.created DESC ';
634 if ($offset>0 && !is_null($limit)) {
636 if (common_config('db','type') == 'pgsql') {
637 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
639 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
644 $groups = new User_group();
646 $cnt = $groups->query(sprintf($qry, $this->id));
651 function getSubscriptions($offset=0, $limit=null)
653 $profile = $this->getProfile();
654 assert(!empty($profile));
655 return $profile->getSubscriptions($offset, $limit);
658 function getSubscribers($offset=0, $limit=null)
660 $profile = $this->getProfile();
661 assert(!empty($profile));
662 return $profile->getSubscribers($offset, $limit);
665 function getTaggedSubscribers($tag, $offset=0, $limit=null)
668 'SELECT profile.* ' .
669 'FROM profile JOIN subscription ' .
670 'ON profile.id = subscription.subscriber ' .
671 'JOIN profile_tag ON (profile_tag.tagged = subscription.subscriber ' .
672 'AND profile_tag.tagger = subscription.subscribed) ' .
673 'WHERE subscription.subscribed = %d ' .
674 "AND profile_tag.tag = '%s' " .
675 'AND subscription.subscribed != subscription.subscriber ' .
676 'ORDER BY subscription.created DESC ';
679 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
682 $profile = new Profile();
684 $cnt = $profile->query(sprintf($qry, $this->id, $tag));
689 function getTaggedSubscriptions($tag, $offset=0, $limit=null)
692 'SELECT profile.* ' .
693 'FROM profile JOIN subscription ' .
694 'ON profile.id = subscription.subscribed ' .
695 'JOIN profile_tag on (profile_tag.tagged = subscription.subscribed ' .
696 'AND profile_tag.tagger = subscription.subscriber) ' .
697 'WHERE subscription.subscriber = %d ' .
698 "AND profile_tag.tag = '%s' " .
699 'AND subscription.subscribed != subscription.subscriber ' .
700 'ORDER BY subscription.created DESC ';
702 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
704 $profile = new Profile();
706 $profile->query(sprintf($qry, $this->id, $tag));
713 return Design::staticGet('id', $this->design_id);
716 function hasRight($right)
718 $profile = $this->getProfile();
719 return $profile->hasRight($right);
724 $profile = $this->getProfile();
729 $related = array('Fave',
735 Event::handle('UserDeleteRelated', array($this, &$related));
737 foreach ($related as $cls) {
739 $inst->user_id = $this->id;
743 $this->_deleteTags();
744 $this->_deleteBlocks();
749 function _deleteTags()
751 $tag = new Profile_tag();
752 $tag->tagger = $this->id;
756 function _deleteBlocks()
758 $block = new Profile_block();
759 $block->blocker = $this->id;
761 // XXX delete group block? Reset blocker?
764 function hasRole($name)
766 $profile = $this->getProfile();
767 return $profile->hasRole($name);
770 function grantRole($name)
772 $profile = $this->getProfile();
773 return $profile->grantRole($name);
776 function revokeRole($name)
778 $profile = $this->getProfile();
779 return $profile->revokeRole($name);
782 function isSandboxed()
784 $profile = $this->getProfile();
785 return $profile->isSandboxed();
788 function isSilenced()
790 $profile = $this->getProfile();
791 return $profile->isSilenced();
794 function repeatedByMe($offset=0, $limit=20, $since_id=null, $max_id=null)
796 $ids = Notice::stream(array($this, '_repeatedByMeDirect'),
798 'user:repeated_by_me:'.$this->id,
799 $offset, $limit, $since_id, $max_id, null);
801 return Notice::getStreamByIds($ids);
804 function _repeatedByMeDirect($offset, $limit, $since_id, $max_id, $since)
806 $notice = new Notice();
808 $notice->selectAdd(); // clears it
809 $notice->selectAdd('id');
811 $notice->profile_id = $this->id;
812 $notice->whereAdd('repeat_of IS NOT NULL');
814 $notice->orderBy('id DESC');
816 if (!is_null($offset)) {
817 $notice->limit($offset, $limit);
820 if ($since_id != 0) {
821 $notice->whereAdd('id > ' . $since_id);
825 $notice->whereAdd('id <= ' . $max_id);
828 if (!is_null($since)) {
829 $notice->whereAdd('created > \'' . date('Y-m-d H:i:s', $since) . '\'');
834 if ($notice->find()) {
835 while ($notice->fetch()) {
836 $ids[] = $notice->id;
846 function repeatsOfMe($offset=0, $limit=20, $since_id=null, $max_id=null)
848 $ids = Notice::stream(array($this, '_repeatsOfMeDirect'),
850 'user:repeats_of_me:'.$this->id,
851 $offset, $limit, $since_id, $max_id, null);
853 return Notice::getStreamByIds($ids);
856 function _repeatsOfMeDirect($offset, $limit, $since_id, $max_id, $since)
859 'SELECT DISTINCT original.id AS id ' .
860 'FROM notice original JOIN notice rept ON original.id = rept.repeat_of ' .
861 'WHERE original.profile_id = ' . $this->id . ' ';
863 if ($since_id != 0) {
864 $qry .= 'AND original.id > ' . $since_id . ' ';
868 $qry .= 'AND original.id <= ' . $max_id . ' ';
871 if (!is_null($since)) {
872 $qry .= 'AND original.modified > \'' . date('Y-m-d H:i:s', $since) . '\' ';
875 // NOTE: we sort by fave time, not by notice time!
877 $qry .= 'ORDER BY original.id DESC ';
879 if (!is_null($offset)) {
880 $qry .= "LIMIT $limit OFFSET $offset";
885 $notice = new Notice();
887 $notice->query($qry);
889 while ($notice->fetch()) {
890 $ids[] = $notice->id;
899 function repeatedToMe($offset=0, $limit=20, $since_id=null, $max_id=null)
901 $ids = Notice::stream(array($this, '_repeatedToMeDirect'),
903 'user:repeated_to_me:'.$this->id,
904 $offset, $limit, $since_id, $max_id, null);
906 return Notice::getStreamByIds($ids);
909 function _repeatedToMeDirect($offset, $limit, $since_id, $max_id, $since)
912 'SELECT notice.id AS id ' .
913 'FROM notice JOIN notice_inbox ON notice.id = notice_inbox.notice_id ' .
914 'WHERE notice_inbox.user_id = ' . $this->id . ' ' .
915 'AND notice.repeat_of IS NOT NULL ';
917 if ($since_id != 0) {
918 $qry .= 'AND notice.id > ' . $since_id . ' ';
922 $qry .= 'AND notice.id <= ' . $max_id . ' ';
925 if (!is_null($since)) {
926 $qry .= 'AND notice.modified > \'' . date('Y-m-d H:i:s', $since) . '\' ';
929 // NOTE: we sort by fave time, not by notice time!
931 $qry .= 'ORDER BY notice.id DESC ';
933 if (!is_null($offset)) {
934 $qry .= "LIMIT $limit OFFSET $offset";
939 $notice = new Notice();
941 $notice->query($qry);
943 while ($notice->fetch()) {
944 $ids[] = $notice->id;
953 function shareLocation()
955 $cfg = common_config('location', 'share');
957 if ($cfg == 'always') {
959 } else if ($cfg == 'never') {
964 $prefs = User_location_prefs::staticGet('user_id', $this->id);
967 $share = common_config('location', 'sharedefault');
969 $share = $prefs->share_location;