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 function allowed_nickname($nickname)
119 // XXX: should already be validated for size, content, etc.
121 $blacklist = array();
123 //all directory and file names should be blacklisted
124 $d = dir(INSTALLDIR);
125 while (false !== ($entry = $d->read())) {
129 $merged = array_merge($blacklist, common_config('nickname', 'blacklist'));
130 return !in_array($nickname, $merged);
133 function getCurrentNotice($dt=null)
135 $profile = $this->getProfile();
139 return $profile->getCurrentNotice($dt);
142 function getCarrier()
144 return Sms_carrier::staticGet('id', $this->carrier);
147 function subscribeTo($other)
149 $sub = new Subscription();
150 $sub->subscriber = $this->id;
151 $sub->subscribed = $other->id;
153 $sub->created = common_sql_now(); // current time
155 if (!$sub->insert()) {
162 function hasBlocked($other)
165 $block = Profile_block::get($this->id, $other->id);
167 if (is_null($block)) {
177 static function register($fields) {
179 // MAGICALLY put fields into current scope
183 $profile = new Profile();
185 $profile->query('BEGIN');
187 $profile->nickname = $nickname;
188 $profile->profileurl = common_profile_url($nickname);
190 if (!empty($fullname)) {
191 $profile->fullname = $fullname;
193 if (!empty($homepage)) {
194 $profile->homepage = $homepage;
197 $profile->bio = $bio;
199 if (!empty($location)) {
200 $profile->location = $location;
203 $profile->created = common_sql_now();
205 $id = $profile->insert();
208 common_log_db_error($profile, 'INSERT', __FILE__);
215 $user->nickname = $nickname;
217 if (!empty($password)) { // may not have a password for OpenID users
218 $user->password = common_munge_password($password, $id);
221 // Users who respond to invite email have proven their ownership of that address
224 $invite = Invitation::staticGet($code);
225 if ($invite && $invite->address && $invite->address_type == 'email' && $invite->address == $email) {
226 $user->email = $invite->address;
230 // This flag is ignored but still set to 1
234 $user->created = common_sql_now();
235 $user->uri = common_user_uri($user);
237 $result = $user->insert();
240 common_log_db_error($user, 'INSERT', __FILE__);
244 // Everyone is subscribed to themself
246 $subscription = new Subscription();
247 $subscription->subscriber = $user->id;
248 $subscription->subscribed = $user->id;
249 $subscription->created = $user->created;
251 $result = $subscription->insert();
254 common_log_db_error($subscription, 'INSERT', __FILE__);
258 if (!empty($email) && !$user->email) {
260 $confirm = new Confirm_address();
261 $confirm->code = common_confirmation_code(128);
262 $confirm->user_id = $user->id;
263 $confirm->address = $email;
264 $confirm->address_type = 'email';
266 $result = $confirm->insert();
268 common_log_db_error($confirm, 'INSERT', __FILE__);
273 if (!empty($code) && $user->email) {
274 $user->emailChanged();
277 // Default system subscription
279 $defnick = common_config('newuser', 'default');
281 if (!empty($defnick)) {
282 $defuser = User::staticGet('nickname', $defnick);
283 if (empty($defuser)) {
284 common_log(LOG_WARNING, sprintf("Default user %s does not exist.", $defnick),
287 $defsub = new Subscription();
288 $defsub->subscriber = $user->id;
289 $defsub->subscribed = $defuser->id;
290 $defsub->created = $user->created;
292 $result = $defsub->insert();
295 common_log_db_error($defsub, 'INSERT', __FILE__);
301 $profile->query('COMMIT');
303 if ($email && !$user->email) {
304 mail_confirm_address($user, $confirm->code, $profile->nickname, $email);
309 $welcome = common_config('newuser', 'welcome');
311 if (!empty($welcome)) {
312 $welcomeuser = User::staticGet('nickname', $welcome);
313 if (empty($welcomeuser)) {
314 common_log(LOG_WARNING, sprintf("Welcome user %s does not exist.", $defnick),
317 $notice = Notice::saveNew($welcomeuser->id,
318 sprintf(_('Welcome to %1$s, @%2$s!'),
319 common_config('site', 'name'),
328 // Things we do when the email changes
330 function emailChanged()
333 $invites = new Invitation();
334 $invites->address = $this->email;
335 $invites->address_type = 'email';
337 if ($invites->find()) {
338 while ($invites->fetch()) {
339 $other = User::staticGet($invites->user_id);
340 subs_subscribe_to($other, $this);
345 function hasFave($notice)
347 $cache = common_memcache();
349 // XXX: Kind of a hack.
352 // This is the stream of favorite notices, in rev chron
353 // order. This forces it into cache.
355 $ids = Fave::stream($this->id, 0, NOTICE_CACHE_WINDOW);
357 // If it's in the list, then it's a fave
359 if (in_array($notice->id, $ids)) {
363 // If we're not past the end of the cache window,
364 // then the cache has all available faves, so this one
367 if (count($ids) < NOTICE_CACHE_WINDOW) {
371 // Otherwise, cache doesn't have all faves;
372 // fall through to the default
375 $fave = Fave::pkeyGet(array('user_id' => $this->id,
376 'notice_id' => $notice->id));
377 return ((is_null($fave)) ? false : true);
380 function mutuallySubscribed($other)
382 return $this->isSubscribed($other) &&
383 $other->isSubscribed($this);
386 function mutuallySubscribedUsers()
388 // 3-way join; probably should get cached
389 $UT = common_config('db','type')=='pgsql'?'"user"':'user';
390 $qry = "SELECT $UT.* " .
391 "FROM subscription sub1 JOIN $UT ON sub1.subscribed = $UT.id " .
392 "JOIN subscription sub2 ON $UT.id = sub2.subscriber " .
393 'WHERE sub1.subscriber = %d and sub2.subscribed = %d ' .
394 "ORDER BY $UT.nickname";
396 $user->query(sprintf($qry, $this->id, $this->id));
401 function getReplies($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0, $since=null)
403 $ids = Reply::stream($this->id, $offset, $limit, $since_id, $before_id, $since);
404 return Notice::getStreamByIds($ids);
407 function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0, $since=null) {
408 $profile = $this->getProfile();
412 return $profile->getTaggedNotices($tag, $offset, $limit, $since_id, $before_id, $since);
416 function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0, $since=null)
418 $profile = $this->getProfile();
422 return $profile->getNotices($offset, $limit, $since_id, $before_id, $since);
426 function favoriteNotices($offset=0, $limit=NOTICES_PER_PAGE, $own=false)
428 $ids = Fave::stream($this->id, $offset, $limit, $own);
429 return Notice::getStreamByIds($ids);
432 function noticesWithFriends($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0, $since=null)
434 $ids = Notice_inbox::stream($this->id, $offset, $limit, $since_id, $before_id, $since, false);
436 return Notice::getStreamByIds($ids);
439 function noticeInbox($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0, $since=null)
441 $ids = Notice_inbox::stream($this->id, $offset, $limit, $since_id, $before_id, $since, true);
443 return Notice::getStreamByIds($ids);
446 function blowFavesCache()
448 $cache = common_memcache();
450 // Faves don't happen chronologically, so we need to blow
452 $cache->delete(common_cache_key('fave:ids_by_user:'.$this->id));
453 $cache->delete(common_cache_key('fave:ids_by_user:'.$this->id.';last'));
454 $cache->delete(common_cache_key('fave:ids_by_user_own:'.$this->id));
455 $cache->delete(common_cache_key('fave:ids_by_user_own:'.$this->id.';last'));
457 $profile = $this->getProfile();
458 $profile->blowFaveCount();
461 function getSelfTags()
463 return Profile_tag::getTags($this->id, $this->id);
466 function setSelfTags($newtags)
468 return Profile_tag::setTags($this->id, $this->id, $newtags);
471 function block($other)
473 // Add a new block record
475 $block = new Profile_block();
477 // Begin a transaction
479 $block->query('BEGIN');
481 $block->blocker = $this->id;
482 $block->blocked = $other->id;
484 $result = $block->insert();
487 common_log_db_error($block, 'INSERT', __FILE__);
491 // Cancel their subscription, if it exists
493 $sub = Subscription::pkeyGet(array('subscriber' => $other->id,
494 'subscribed' => $this->id));
497 $result = $sub->delete();
499 common_log_db_error($sub, 'DELETE', __FILE__);
504 $block->query('COMMIT');
509 function unblock($other)
511 // Get the block record
513 $block = Profile_block::get($this->id, $other->id);
519 $result = $block->delete();
522 common_log_db_error($block, 'DELETE', __FILE__);
529 function isMember($group)
531 $profile = $this->getProfile();
532 return $profile->isMember($group);
535 function isAdmin($group)
537 $profile = $this->getProfile();
538 return $profile->isAdmin($group);
541 function getGroups($offset=0, $limit=null)
544 'SELECT user_group.* ' .
545 'FROM user_group JOIN group_member '.
546 'ON user_group.id = group_member.group_id ' .
547 'WHERE group_member.profile_id = %d ' .
548 'ORDER BY group_member.created DESC ';
551 if (common_config('db','type') == 'pgsql') {
552 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
554 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
558 $groups = new User_group();
560 $cnt = $groups->query(sprintf($qry, $this->id));
565 function getSubscriptions($offset=0, $limit=null)
567 $profile = $this->getProfile();
568 assert(!empty($profile));
569 return $profile->getSubscriptions($offset, $limit);
572 function getSubscribers($offset=0, $limit=null)
574 $profile = $this->getProfile();
575 assert(!empty($profile));
576 return $profile->getSubscribers($offset, $limit);
579 function getTaggedSubscribers($tag, $offset=0, $limit=null)
582 'SELECT profile.* ' .
583 'FROM profile JOIN subscription ' .
584 'ON profile.id = subscription.subscriber ' .
585 'JOIN profile_tag ON (profile_tag.tagged = subscription.subscriber ' .
586 'AND profile_tag.tagger = subscription.subscribed) ' .
587 'WHERE subscription.subscribed = %d ' .
588 "AND profile_tag.tag = '%s' " .
589 'AND subscription.subscribed != subscription.subscriber ' .
590 'ORDER BY subscription.created DESC ';
593 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
596 $profile = new Profile();
598 $cnt = $profile->query(sprintf($qry, $this->id, $tag));
603 function getTaggedSubscriptions($tag, $offset=0, $limit=null)
606 'SELECT profile.* ' .
607 'FROM profile JOIN subscription ' .
608 'ON profile.id = subscription.subscribed ' .
609 'JOIN profile_tag on (profile_tag.tagged = subscription.subscribed ' .
610 'AND profile_tag.tagger = subscription.subscriber) ' .
611 'WHERE subscription.subscriber = %d ' .
612 "AND profile_tag.tag = '%s' " .
613 'AND subscription.subscribed != subscription.subscriber ' .
614 'ORDER BY subscription.created DESC ';
616 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
618 $profile = new Profile();
620 $profile->query(sprintf($qry, $this->id, $tag));
627 return Design::staticGet('id', $this->design_id);
630 function hasRole($name)
632 $role = User_role::pkeyGet(array('user_id' => $this->id,
634 return (!empty($role));
637 function grantRole($name)
639 $role = new User_role();
641 $role->user_id = $this->id;
643 $role->created = common_sql_now();
645 $result = $role->insert();
648 common_log_db_error($role, 'INSERT', __FILE__);
655 function revokeRole($name)
657 $role = User_role::pkeyGet(array('user_id' => $this->id,
661 throw new Exception('Cannot revoke role "'.$name.'" for user #'.$this->id.'; does not exist.');
664 $result = $role->delete();
667 common_log_db_error($role, 'DELETE', __FILE__);
668 throw new Exception('Cannot revoke role "'.$name.'" for user #'.$this->id.'; database error.');
675 * Does this user have the right to do X?
677 * With our role-based authorization, this is merely a lookup for whether the user
678 * has a particular role. The implementation currently uses a switch statement
679 * to determine if the user has the pre-defined role to exercise the right. Future
680 * implementations may allow per-site roles, and different mappings of roles to rights.
682 * @param $right string Name of the right, usually a constant in class Right
683 * @return boolean whether the user has the right in question
686 function hasRight($right)
689 if (Event::handle('UserRightsCheck', array($this, $right, &$result))) {
692 case Right::deleteOthersNotice:
693 $result = $this->hasRole('moderator');
705 $profile = $this->getProfile();
708 $related = array('Fave',
717 foreach ($related as $cls) {
719 $inst->user_id = $this->id;
723 $this->_deleteTags();
724 $this->_deleteBlocks();
729 function _deleteTags()
731 $tag = new Profile_tag();
732 $tag->tagger = $this->id;
736 function _deleteBlocks()
738 $block = new Profile_block();
739 $block->blocker = $this->id;
741 // XXX delete group block? Reset blocker?