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)) {
183 static function register($fields) {
185 // MAGICALLY put fields into current scope
189 $profile = new Profile();
191 $profile->query('BEGIN');
195 $email = common_canonical_email($email);
198 $nickname = common_canonical_nickname($nickname);
199 $profile->nickname = $nickname;
200 if(! User::allowed_nickname($nickname)){
201 common_log(LOG_WARNING, sprintf("Attempted to register a nickname that is not allowed: %s", $profile->nickname),
204 $profile->profileurl = common_profile_url($nickname);
206 if (!empty($fullname)) {
207 $profile->fullname = $fullname;
209 if (!empty($homepage)) {
210 $profile->homepage = $homepage;
213 $profile->bio = $bio;
215 if (!empty($location)) {
216 $profile->location = $location;
218 $loc = Location::fromName($location);
221 $profile->lat = $loc->lat;
222 $profile->lon = $loc->lon;
223 $profile->location_id = $loc->location_id;
224 $profile->location_ns = $loc->location_ns;
228 $profile->created = common_sql_now();
230 $id = $profile->insert();
233 common_log_db_error($profile, 'INSERT', __FILE__);
240 $user->nickname = $nickname;
242 if (!empty($password)) { // may not have a password for OpenID users
243 $user->password = common_munge_password($password, $id);
246 // Users who respond to invite email have proven their ownership of that address
249 $invite = Invitation::staticGet($code);
250 if ($invite && $invite->address && $invite->address_type == 'email' && $invite->address == $email) {
251 $user->email = $invite->address;
255 if(isset($email_confirmed) && $email_confirmed) {
256 $user->email = $email;
259 // This flag is ignored but still set to 1
263 $user->created = common_sql_now();
264 $user->uri = common_user_uri($user);
266 $result = $user->insert();
269 common_log_db_error($user, 'INSERT', __FILE__);
273 // Everyone is subscribed to themself
275 $subscription = new Subscription();
276 $subscription->subscriber = $user->id;
277 $subscription->subscribed = $user->id;
278 $subscription->created = $user->created;
280 $result = $subscription->insert();
283 common_log_db_error($subscription, 'INSERT', __FILE__);
287 if (!empty($email) && !$user->email) {
289 $confirm = new Confirm_address();
290 $confirm->code = common_confirmation_code(128);
291 $confirm->user_id = $user->id;
292 $confirm->address = $email;
293 $confirm->address_type = 'email';
295 $result = $confirm->insert();
297 common_log_db_error($confirm, 'INSERT', __FILE__);
302 if (!empty($code) && $user->email) {
303 $user->emailChanged();
306 // Default system subscription
308 $defnick = common_config('newuser', 'default');
310 if (!empty($defnick)) {
311 $defuser = User::staticGet('nickname', $defnick);
312 if (empty($defuser)) {
313 common_log(LOG_WARNING, sprintf("Default user %s does not exist.", $defnick),
316 $defsub = new Subscription();
317 $defsub->subscriber = $user->id;
318 $defsub->subscribed = $defuser->id;
319 $defsub->created = $user->created;
321 $result = $defsub->insert();
324 common_log_db_error($defsub, 'INSERT', __FILE__);
330 $profile->query('COMMIT');
332 if ($email && !$user->email) {
333 mail_confirm_address($user, $confirm->code, $profile->nickname, $email);
338 $welcome = common_config('newuser', 'welcome');
340 if (!empty($welcome)) {
341 $welcomeuser = User::staticGet('nickname', $welcome);
342 if (empty($welcomeuser)) {
343 common_log(LOG_WARNING, sprintf("Welcome user %s does not exist.", $defnick),
346 $notice = Notice::saveNew($welcomeuser->id,
347 sprintf(_('Welcome to %1$s, @%2$s!'),
348 common_config('site', 'name'),
351 common_broadcast_notice($notice);
358 // Things we do when the email changes
360 function emailChanged()
363 $invites = new Invitation();
364 $invites->address = $this->email;
365 $invites->address_type = 'email';
367 if ($invites->find()) {
368 while ($invites->fetch()) {
369 $other = User::staticGet($invites->user_id);
370 subs_subscribe_to($other, $this);
375 function hasFave($notice)
377 $cache = common_memcache();
379 // XXX: Kind of a hack.
382 // This is the stream of favorite notices, in rev chron
383 // order. This forces it into cache.
385 $ids = Fave::stream($this->id, 0, NOTICE_CACHE_WINDOW);
387 // If it's in the list, then it's a fave
389 if (in_array($notice->id, $ids)) {
393 // If we're not past the end of the cache window,
394 // then the cache has all available faves, so this one
397 if (count($ids) < NOTICE_CACHE_WINDOW) {
401 // Otherwise, cache doesn't have all faves;
402 // fall through to the default
405 $fave = Fave::pkeyGet(array('user_id' => $this->id,
406 'notice_id' => $notice->id));
407 return ((is_null($fave)) ? false : true);
410 function mutuallySubscribed($other)
412 return $this->isSubscribed($other) &&
413 $other->isSubscribed($this);
416 function mutuallySubscribedUsers()
418 // 3-way join; probably should get cached
419 $UT = common_config('db','type')=='pgsql'?'"user"':'user';
420 $qry = "SELECT $UT.* " .
421 "FROM subscription sub1 JOIN $UT ON sub1.subscribed = $UT.id " .
422 "JOIN subscription sub2 ON $UT.id = sub2.subscriber " .
423 'WHERE sub1.subscriber = %d and sub2.subscribed = %d ' .
424 "ORDER BY $UT.nickname";
426 $user->query(sprintf($qry, $this->id, $this->id));
431 function getReplies($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0, $since=null)
433 $ids = Reply::stream($this->id, $offset, $limit, $since_id, $before_id, $since);
434 return Notice::getStreamByIds($ids);
437 function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0, $since=null) {
438 $profile = $this->getProfile();
442 return $profile->getTaggedNotices($tag, $offset, $limit, $since_id, $before_id, $since);
446 function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0, $since=null)
448 $profile = $this->getProfile();
452 return $profile->getNotices($offset, $limit, $since_id, $before_id, $since);
456 function favoriteNotices($offset=0, $limit=NOTICES_PER_PAGE, $own=false)
458 $ids = Fave::stream($this->id, $offset, $limit, $own);
459 return Notice::getStreamByIds($ids);
462 function noticesWithFriends($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0, $since=null)
464 $ids = Notice_inbox::stream($this->id, $offset, $limit, $since_id, $before_id, $since, false);
466 return Notice::getStreamByIds($ids);
469 function noticeInbox($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0, $since=null)
471 $ids = Notice_inbox::stream($this->id, $offset, $limit, $since_id, $before_id, $since, true);
473 return Notice::getStreamByIds($ids);
476 function blowFavesCache()
478 $cache = common_memcache();
480 // Faves don't happen chronologically, so we need to blow
482 $cache->delete(common_cache_key('fave:ids_by_user:'.$this->id));
483 $cache->delete(common_cache_key('fave:ids_by_user:'.$this->id.';last'));
484 $cache->delete(common_cache_key('fave:ids_by_user_own:'.$this->id));
485 $cache->delete(common_cache_key('fave:ids_by_user_own:'.$this->id.';last'));
487 $profile = $this->getProfile();
488 $profile->blowFaveCount();
491 function getSelfTags()
493 return Profile_tag::getTags($this->id, $this->id);
496 function setSelfTags($newtags)
498 return Profile_tag::setTags($this->id, $this->id, $newtags);
501 function block($other)
503 // Add a new block record
505 $block = new Profile_block();
507 // Begin a transaction
509 $block->query('BEGIN');
511 $block->blocker = $this->id;
512 $block->blocked = $other->id;
514 $result = $block->insert();
517 common_log_db_error($block, 'INSERT', __FILE__);
521 // Cancel their subscription, if it exists
523 $sub = Subscription::pkeyGet(array('subscriber' => $other->id,
524 'subscribed' => $this->id));
527 $result = $sub->delete();
529 common_log_db_error($sub, 'DELETE', __FILE__);
534 $block->query('COMMIT');
539 function unblock($other)
541 // Get the block record
543 $block = Profile_block::get($this->id, $other->id);
549 $result = $block->delete();
552 common_log_db_error($block, 'DELETE', __FILE__);
559 function isMember($group)
561 $profile = $this->getProfile();
562 return $profile->isMember($group);
565 function isAdmin($group)
567 $profile = $this->getProfile();
568 return $profile->isAdmin($group);
571 function getGroups($offset=0, $limit=null)
574 'SELECT user_group.* ' .
575 'FROM user_group JOIN group_member '.
576 'ON user_group.id = group_member.group_id ' .
577 'WHERE group_member.profile_id = %d ' .
578 'ORDER BY group_member.created DESC ';
581 if (common_config('db','type') == 'pgsql') {
582 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
584 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
588 $groups = new User_group();
590 $cnt = $groups->query(sprintf($qry, $this->id));
595 function getSubscriptions($offset=0, $limit=null)
597 $profile = $this->getProfile();
598 assert(!empty($profile));
599 return $profile->getSubscriptions($offset, $limit);
602 function getSubscribers($offset=0, $limit=null)
604 $profile = $this->getProfile();
605 assert(!empty($profile));
606 return $profile->getSubscribers($offset, $limit);
609 function getTaggedSubscribers($tag, $offset=0, $limit=null)
612 'SELECT profile.* ' .
613 'FROM profile JOIN subscription ' .
614 'ON profile.id = subscription.subscriber ' .
615 'JOIN profile_tag ON (profile_tag.tagged = subscription.subscriber ' .
616 'AND profile_tag.tagger = subscription.subscribed) ' .
617 'WHERE subscription.subscribed = %d ' .
618 "AND profile_tag.tag = '%s' " .
619 'AND subscription.subscribed != subscription.subscriber ' .
620 'ORDER BY subscription.created DESC ';
623 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
626 $profile = new Profile();
628 $cnt = $profile->query(sprintf($qry, $this->id, $tag));
633 function getTaggedSubscriptions($tag, $offset=0, $limit=null)
636 'SELECT profile.* ' .
637 'FROM profile JOIN subscription ' .
638 'ON profile.id = subscription.subscribed ' .
639 'JOIN profile_tag on (profile_tag.tagged = subscription.subscribed ' .
640 'AND profile_tag.tagger = subscription.subscriber) ' .
641 'WHERE subscription.subscriber = %d ' .
642 "AND profile_tag.tag = '%s' " .
643 'AND subscription.subscribed != subscription.subscriber ' .
644 'ORDER BY subscription.created DESC ';
646 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
648 $profile = new Profile();
650 $profile->query(sprintf($qry, $this->id, $tag));
657 return Design::staticGet('id', $this->design_id);
660 function hasRole($name)
662 $role = User_role::pkeyGet(array('user_id' => $this->id,
664 return (!empty($role));
667 function grantRole($name)
669 $role = new User_role();
671 $role->user_id = $this->id;
673 $role->created = common_sql_now();
675 $result = $role->insert();
678 common_log_db_error($role, 'INSERT', __FILE__);
685 function revokeRole($name)
687 $role = User_role::pkeyGet(array('user_id' => $this->id,
691 throw new Exception('Cannot revoke role "'.$name.'" for user #'.$this->id.'; does not exist.');
694 $result = $role->delete();
697 common_log_db_error($role, 'DELETE', __FILE__);
698 throw new Exception('Cannot revoke role "'.$name.'" for user #'.$this->id.'; database error.');
705 * Does this user have the right to do X?
707 * With our role-based authorization, this is merely a lookup for whether the user
708 * has a particular role. The implementation currently uses a switch statement
709 * to determine if the user has the pre-defined role to exercise the right. Future
710 * implementations may allow per-site roles, and different mappings of roles to rights.
712 * @param $right string Name of the right, usually a constant in class Right
713 * @return boolean whether the user has the right in question
716 function hasRight($right)
719 if (Event::handle('UserRightsCheck', array($this, $right, &$result))) {
722 case Right::DELETEOTHERSNOTICE:
723 $result = $this->hasRole(User_role::MODERATOR);
725 case Right::CONFIGURESITE:
726 $result = $this->hasRole(User_role::ADMINISTRATOR);
737 $profile = $this->getProfile();
742 $related = array('Fave',
749 Event::handle('UserDeleteRelated', array($this, &$related));
751 foreach ($related as $cls) {
753 $inst->user_id = $this->id;
757 $this->_deleteTags();
758 $this->_deleteBlocks();
763 function _deleteTags()
765 $tag = new Profile_tag();
766 $tag->tagger = $this->id;
770 function _deleteBlocks()
772 $block = new Profile_block();
773 $block->blocker = $this->id;
775 // XXX delete group block? Reset blocker?