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 return Subscription::exists($this->getProfile(), $other);
86 // 'update' won't write key columns, so we have to do it ourselves.
88 function updateKeys(&$orig)
91 foreach (array('nickname', 'email', 'jabber', 'incomingemail', 'sms', 'carrier', 'smsemail', 'language', 'timezone') as $k) {
92 if (strcmp($this->$k, $orig->$k) != 0) {
93 $parts[] = $k . ' = ' . $this->_quote($this->$k);
96 if (count($parts) == 0) {
100 $toupdate = implode(', ', $parts);
102 $table = common_database_tablename($this->tableName());
103 $qry = 'UPDATE ' . $table . ' SET ' . $toupdate .
104 ' WHERE id = ' . $this->id;
106 $result = $this->query($qry);
113 static function allowed_nickname($nickname)
115 // XXX: should already be validated for size, content, etc.
116 $blacklist = common_config('nickname', 'blacklist');
118 //all directory and file names should be blacklisted
119 $d = dir(INSTALLDIR);
120 while (false !== ($entry = $d->read())) {
125 //all top level names in the router should be blacklisted
126 $router = Router::get();
127 foreach(array_keys($router->m->getPaths()) as $path){
128 if(preg_match('/^\/(.*?)[\/\?]/',$path,$matches)){
129 $blacklist[]=$matches[1];
132 return !in_array($nickname, $blacklist);
135 function getCurrentNotice($dt=null)
137 $profile = $this->getProfile();
141 return $profile->getCurrentNotice($dt);
144 function getCarrier()
146 return Sms_carrier::staticGet('id', $this->carrier);
149 function subscribeTo($other)
151 $sub = new Subscription();
152 $sub->subscriber = $this->id;
153 $sub->subscribed = $other->id;
155 $sub->created = common_sql_now(); // current time
157 if (!$sub->insert()) {
164 function hasBlocked($other)
166 $profile = $this->getProfile();
167 return $profile->hasBlocked($other);
171 * Register a new user account and profile and set up default subscriptions.
172 * If a new-user welcome message is configured, this will be sent.
174 * @param array $fields associative array of optional properties
177 * bool 'email_confirmed' pass true to mark email as pre-confirmed
180 * string 'location' informal string description of geolocation
181 * float 'lat' decimal latitude for geolocation
182 * float 'lon' decimal longitude for geolocation
183 * int 'location_id' geoname identifier
184 * int 'location_ns' geoname namespace to interpret location_id
185 * string 'nickname' REQUIRED
186 * string 'password' (may be missing for eg OpenID registrations)
187 * string 'code' invite code
188 * ?string 'uri' permalink to notice; defaults to local notice URL
189 * @return mixed User object or false on failure
191 static function register($fields) {
193 // MAGICALLY put fields into current scope
197 $profile = new Profile();
201 $email = common_canonical_email($email);
204 $nickname = common_canonical_nickname($nickname);
205 $profile->nickname = $nickname;
206 if(! User::allowed_nickname($nickname)){
207 common_log(LOG_WARNING, sprintf("Attempted to register a nickname that is not allowed: %s", $profile->nickname),
211 $profile->profileurl = common_profile_url($nickname);
213 if (!empty($fullname)) {
214 $profile->fullname = $fullname;
216 if (!empty($homepage)) {
217 $profile->homepage = $homepage;
220 $profile->bio = $bio;
222 if (!empty($location)) {
223 $profile->location = $location;
225 $loc = Location::fromName($location);
228 $profile->lat = $loc->lat;
229 $profile->lon = $loc->lon;
230 $profile->location_id = $loc->location_id;
231 $profile->location_ns = $loc->location_ns;
235 $profile->created = common_sql_now();
239 $user->nickname = $nickname;
241 // Users who respond to invite email have proven their ownership of that address
244 $invite = Invitation::staticGet($code);
245 if ($invite && $invite->address && $invite->address_type == 'email' && $invite->address == $email) {
246 $user->email = $invite->address;
250 if(isset($email_confirmed) && $email_confirmed) {
251 $user->email = $email;
254 // This flag is ignored but still set to 1
258 $user->created = common_sql_now();
260 if (Event::handle('StartUserRegister', array(&$user, &$profile))) {
262 $profile->query('BEGIN');
264 $id = $profile->insert();
267 common_log_db_error($profile, 'INSERT', __FILE__);
272 $user->uri = common_user_uri($user);
273 if (!empty($password)) { // may not have a password for OpenID users
274 $user->password = common_munge_password($password, $id);
277 $result = $user->insert();
280 common_log_db_error($user, 'INSERT', __FILE__);
284 // Everyone gets an inbox
286 $inbox = new Inbox();
288 $inbox->user_id = $user->id;
289 $inbox->notice_ids = '';
291 $result = $inbox->insert();
294 common_log_db_error($inbox, 'INSERT', __FILE__);
298 // Everyone is subscribed to themself
300 $subscription = new Subscription();
301 $subscription->subscriber = $user->id;
302 $subscription->subscribed = $user->id;
303 $subscription->created = $user->created;
305 $result = $subscription->insert();
308 common_log_db_error($subscription, 'INSERT', __FILE__);
312 if (!empty($email) && !$user->email) {
314 $confirm = new Confirm_address();
315 $confirm->code = common_confirmation_code(128);
316 $confirm->user_id = $user->id;
317 $confirm->address = $email;
318 $confirm->address_type = 'email';
320 $result = $confirm->insert();
323 common_log_db_error($confirm, 'INSERT', __FILE__);
328 if (!empty($code) && $user->email) {
329 $user->emailChanged();
332 // Default system subscription
334 $defnick = common_config('newuser', 'default');
336 if (!empty($defnick)) {
337 $defuser = User::staticGet('nickname', $defnick);
338 if (empty($defuser)) {
339 common_log(LOG_WARNING, sprintf("Default user %s does not exist.", $defnick),
342 $defsub = new Subscription();
343 $defsub->subscriber = $user->id;
344 $defsub->subscribed = $defuser->id;
345 $defsub->created = $user->created;
347 $result = $defsub->insert();
350 common_log_db_error($defsub, 'INSERT', __FILE__);
356 $profile->query('COMMIT');
358 if (!empty($email) && !$user->email) {
359 mail_confirm_address($user, $confirm->code, $profile->nickname, $email);
364 $welcome = common_config('newuser', 'welcome');
366 if (!empty($welcome)) {
367 $welcomeuser = User::staticGet('nickname', $welcome);
368 if (empty($welcomeuser)) {
369 common_log(LOG_WARNING, sprintf("Welcome user %s does not exist.", $defnick),
372 $notice = Notice::saveNew($welcomeuser->id,
373 sprintf(_('Welcome to %1$s, @%2$s!'),
374 common_config('site', 'name'),
381 Event::handle('EndUserRegister', array(&$profile, &$user));
387 // Things we do when the email changes
389 function emailChanged()
392 $invites = new Invitation();
393 $invites->address = $this->email;
394 $invites->address_type = 'email';
396 if ($invites->find()) {
397 while ($invites->fetch()) {
398 $other = User::staticGet($invites->user_id);
399 subs_subscribe_to($other, $this);
404 function hasFave($notice)
406 $cache = common_memcache();
408 // XXX: Kind of a hack.
411 // This is the stream of favorite notices, in rev chron
412 // order. This forces it into cache.
414 $ids = Fave::stream($this->id, 0, NOTICE_CACHE_WINDOW);
416 // If it's in the list, then it's a fave
418 if (in_array($notice->id, $ids)) {
422 // If we're not past the end of the cache window,
423 // then the cache has all available faves, so this one
426 if (count($ids) < NOTICE_CACHE_WINDOW) {
430 // Otherwise, cache doesn't have all faves;
431 // fall through to the default
434 $fave = Fave::pkeyGet(array('user_id' => $this->id,
435 'notice_id' => $notice->id));
436 return ((is_null($fave)) ? false : true);
439 function mutuallySubscribed($other)
441 return $this->isSubscribed($other) &&
442 $other->isSubscribed($this);
445 function mutuallySubscribedUsers()
447 // 3-way join; probably should get cached
448 $UT = common_config('db','type')=='pgsql'?'"user"':'user';
449 $qry = "SELECT $UT.* " .
450 "FROM subscription sub1 JOIN $UT ON sub1.subscribed = $UT.id " .
451 "JOIN subscription sub2 ON $UT.id = sub2.subscriber " .
452 'WHERE sub1.subscriber = %d and sub2.subscribed = %d ' .
453 "ORDER BY $UT.nickname";
455 $user->query(sprintf($qry, $this->id, $this->id));
460 function getReplies($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
462 $ids = Reply::stream($this->id, $offset, $limit, $since_id, $before_id);
463 return Notice::getStreamByIds($ids);
466 function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0) {
467 $profile = $this->getProfile();
471 return $profile->getTaggedNotices($tag, $offset, $limit, $since_id, $before_id);
475 function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
477 $profile = $this->getProfile();
481 return $profile->getNotices($offset, $limit, $since_id, $before_id);
485 function favoriteNotices($offset=0, $limit=NOTICES_PER_PAGE, $own=false)
487 $ids = Fave::stream($this->id, $offset, $limit, $own);
488 return Notice::getStreamByIds($ids);
491 function noticesWithFriends($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
493 return Inbox::streamNotices($this->id, $offset, $limit, $since_id, $before_id, false);
496 function noticeInbox($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
498 return Inbox::streamNotices($this->id, $offset, $limit, $since_id, $before_id, true);
501 function friendsTimeline($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
503 return Inbox::streamNotices($this->id, $offset, $limit, $since_id, $before_id, false);
506 function ownFriendsTimeline($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
508 return Inbox::streamNotices($this->id, $offset, $limit, $since_id, $before_id, true);
511 function blowFavesCache()
513 $cache = common_memcache();
515 // Faves don't happen chronologically, so we need to blow
517 $cache->delete(common_cache_key('fave:ids_by_user:'.$this->id));
518 $cache->delete(common_cache_key('fave:ids_by_user:'.$this->id.';last'));
519 $cache->delete(common_cache_key('fave:ids_by_user_own:'.$this->id));
520 $cache->delete(common_cache_key('fave:ids_by_user_own:'.$this->id.';last'));
522 $profile = $this->getProfile();
523 $profile->blowFaveCount();
526 function getSelfTags()
528 return Profile_tag::getTags($this->id, $this->id);
531 function setSelfTags($newtags)
533 return Profile_tag::setTags($this->id, $this->id, $newtags);
536 function block($other)
538 // Add a new block record
540 // no blocking (and thus unsubbing from) yourself
542 if ($this->id == $other->id) {
543 common_log(LOG_WARNING,
545 "Profile ID %d (%s) tried to block his or herself.",
553 $block = new Profile_block();
555 // Begin a transaction
557 $block->query('BEGIN');
559 $block->blocker = $this->id;
560 $block->blocked = $other->id;
562 $result = $block->insert();
565 common_log_db_error($block, 'INSERT', __FILE__);
569 // Cancel their subscription, if it exists
571 $otherUser = User::staticGet('id', $other->id);
573 if (!empty($otherUser)) {
574 subs_unsubscribe_to($otherUser, $this->getProfile());
577 $block->query('COMMIT');
582 function unblock($other)
584 // Get the block record
586 $block = Profile_block::get($this->id, $other->id);
592 $result = $block->delete();
595 common_log_db_error($block, 'DELETE', __FILE__);
602 function isMember($group)
604 $profile = $this->getProfile();
605 return $profile->isMember($group);
608 function isAdmin($group)
610 $profile = $this->getProfile();
611 return $profile->isAdmin($group);
614 function getGroups($offset=0, $limit=null)
617 'SELECT user_group.* ' .
618 'FROM user_group JOIN group_member '.
619 'ON user_group.id = group_member.group_id ' .
620 'WHERE group_member.profile_id = %d ' .
621 'ORDER BY group_member.created DESC ';
623 if ($offset>0 && !is_null($limit)) {
625 if (common_config('db','type') == 'pgsql') {
626 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
628 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
633 $groups = new User_group();
635 $cnt = $groups->query(sprintf($qry, $this->id));
640 function getSubscriptions($offset=0, $limit=null)
642 $profile = $this->getProfile();
643 assert(!empty($profile));
644 return $profile->getSubscriptions($offset, $limit);
647 function getSubscribers($offset=0, $limit=null)
649 $profile = $this->getProfile();
650 assert(!empty($profile));
651 return $profile->getSubscribers($offset, $limit);
654 function getTaggedSubscribers($tag, $offset=0, $limit=null)
657 'SELECT profile.* ' .
658 'FROM profile JOIN subscription ' .
659 'ON profile.id = subscription.subscriber ' .
660 'JOIN profile_tag ON (profile_tag.tagged = subscription.subscriber ' .
661 'AND profile_tag.tagger = subscription.subscribed) ' .
662 'WHERE subscription.subscribed = %d ' .
663 "AND profile_tag.tag = '%s' " .
664 'AND subscription.subscribed != subscription.subscriber ' .
665 'ORDER BY subscription.created DESC ';
668 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
671 $profile = new Profile();
673 $cnt = $profile->query(sprintf($qry, $this->id, $tag));
678 function getTaggedSubscriptions($tag, $offset=0, $limit=null)
681 'SELECT profile.* ' .
682 'FROM profile JOIN subscription ' .
683 'ON profile.id = subscription.subscribed ' .
684 'JOIN profile_tag on (profile_tag.tagged = subscription.subscribed ' .
685 'AND profile_tag.tagger = subscription.subscriber) ' .
686 'WHERE subscription.subscriber = %d ' .
687 "AND profile_tag.tag = '%s' " .
688 'AND subscription.subscribed != subscription.subscriber ' .
689 'ORDER BY subscription.created DESC ';
691 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
693 $profile = new Profile();
695 $profile->query(sprintf($qry, $this->id, $tag));
702 return Design::staticGet('id', $this->design_id);
705 function hasRight($right)
707 $profile = $this->getProfile();
708 return $profile->hasRight($right);
713 $profile = $this->getProfile();
718 $related = array('Fave',
724 Event::handle('UserDeleteRelated', array($this, &$related));
726 foreach ($related as $cls) {
728 $inst->user_id = $this->id;
732 $this->_deleteTags();
733 $this->_deleteBlocks();
738 function _deleteTags()
740 $tag = new Profile_tag();
741 $tag->tagger = $this->id;
745 function _deleteBlocks()
747 $block = new Profile_block();
748 $block->blocker = $this->id;
750 // XXX delete group block? Reset blocker?
753 function hasRole($name)
755 $profile = $this->getProfile();
756 return $profile->hasRole($name);
759 function grantRole($name)
761 $profile = $this->getProfile();
762 return $profile->grantRole($name);
765 function revokeRole($name)
767 $profile = $this->getProfile();
768 return $profile->revokeRole($name);
771 function isSandboxed()
773 $profile = $this->getProfile();
774 return $profile->isSandboxed();
777 function isSilenced()
779 $profile = $this->getProfile();
780 return $profile->isSilenced();
783 function repeatedByMe($offset=0, $limit=20, $since_id=null, $max_id=null)
785 $ids = Notice::stream(array($this, '_repeatedByMeDirect'),
787 'user:repeated_by_me:'.$this->id,
788 $offset, $limit, $since_id, $max_id, null);
790 return Notice::getStreamByIds($ids);
793 function _repeatedByMeDirect($offset, $limit, $since_id, $max_id)
795 $notice = new Notice();
797 $notice->selectAdd(); // clears it
798 $notice->selectAdd('id');
800 $notice->profile_id = $this->id;
801 $notice->whereAdd('repeat_of IS NOT NULL');
803 $notice->orderBy('id DESC');
805 if (!is_null($offset)) {
806 $notice->limit($offset, $limit);
809 if ($since_id != 0) {
810 $notice->whereAdd('id > ' . $since_id);
814 $notice->whereAdd('id <= ' . $max_id);
819 if ($notice->find()) {
820 while ($notice->fetch()) {
821 $ids[] = $notice->id;
831 function repeatsOfMe($offset=0, $limit=20, $since_id=null, $max_id=null)
833 $ids = Notice::stream(array($this, '_repeatsOfMeDirect'),
835 'user:repeats_of_me:'.$this->id,
836 $offset, $limit, $since_id, $max_id);
838 return Notice::getStreamByIds($ids);
841 function _repeatsOfMeDirect($offset, $limit, $since_id, $max_id)
844 'SELECT DISTINCT original.id AS id ' .
845 'FROM notice original JOIN notice rept ON original.id = rept.repeat_of ' .
846 'WHERE original.profile_id = ' . $this->id . ' ';
848 if ($since_id != 0) {
849 $qry .= 'AND original.id > ' . $since_id . ' ';
853 $qry .= 'AND original.id <= ' . $max_id . ' ';
856 // NOTE: we sort by fave time, not by notice time!
858 $qry .= 'ORDER BY original.id DESC ';
860 if (!is_null($offset)) {
861 $qry .= "LIMIT $limit OFFSET $offset";
866 $notice = new Notice();
868 $notice->query($qry);
870 while ($notice->fetch()) {
871 $ids[] = $notice->id;
880 function repeatedToMe($offset=0, $limit=20, $since_id=null, $max_id=null)
882 throw new Exception("Not implemented since inbox change.");
885 function shareLocation()
887 $cfg = common_config('location', 'share');
889 if ($cfg == 'always') {
891 } else if ($cfg == 'never') {
896 $prefs = User_location_prefs::staticGet('user_id', $this->id);
899 $share = common_config('location', 'sharedefault');
901 $share = $prefs->share_location;
909 static function siteOwner()
911 $owner = self::cacheGet('user:site_owner');
913 if ($owner === false) { // cache miss
915 $pr = new Profile_role();
917 $pr->role = Profile_role::OWNER;
919 $pr->orderBy('created');
923 if ($pr->find(true)) {
924 $owner = User::staticGet('id', $pr->profile_id);
929 self::cacheSet('user:site_owner', $owner);