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 $inboxes = common_config('inboxes', 'enabled');
232 if ($inboxes === true || $inboxes == 'transitional') {
236 $user->created = common_sql_now();
237 $user->uri = common_user_uri($user);
239 $result = $user->insert();
242 common_log_db_error($user, 'INSERT', __FILE__);
246 // Everyone is subscribed to themself
248 $subscription = new Subscription();
249 $subscription->subscriber = $user->id;
250 $subscription->subscribed = $user->id;
251 $subscription->created = $user->created;
253 $result = $subscription->insert();
256 common_log_db_error($subscription, 'INSERT', __FILE__);
260 if (!empty($email) && !$user->email) {
262 $confirm = new Confirm_address();
263 $confirm->code = common_confirmation_code(128);
264 $confirm->user_id = $user->id;
265 $confirm->address = $email;
266 $confirm->address_type = 'email';
268 $result = $confirm->insert();
270 common_log_db_error($confirm, 'INSERT', __FILE__);
275 if (!empty($code) && $user->email) {
276 $user->emailChanged();
279 // Default system subscription
281 $defnick = common_config('newuser', 'default');
283 if (!empty($defnick)) {
284 $defuser = User::staticGet('nickname', $defnick);
285 if (empty($defuser)) {
286 common_log(LOG_WARNING, sprintf("Default user %s does not exist.", $defnick),
289 $defsub = new Subscription();
290 $defsub->subscriber = $user->id;
291 $defsub->subscribed = $defuser->id;
292 $defsub->created = $user->created;
294 $result = $defsub->insert();
297 common_log_db_error($defsub, 'INSERT', __FILE__);
303 $profile->query('COMMIT');
305 if ($email && !$user->email) {
306 mail_confirm_address($user, $confirm->code, $profile->nickname, $email);
311 $welcome = common_config('newuser', 'welcome');
313 if (!empty($welcome)) {
314 $welcomeuser = User::staticGet('nickname', $welcome);
315 if (empty($welcomeuser)) {
316 common_log(LOG_WARNING, sprintf("Welcome user %s does not exist.", $defnick),
319 $notice = Notice::saveNew($welcomeuser->id,
320 sprintf(_('Welcome to %1$s, @%2$s!'),
321 common_config('site', 'name'),
330 // Things we do when the email changes
332 function emailChanged()
335 $invites = new Invitation();
336 $invites->address = $this->email;
337 $invites->address_type = 'email';
339 if ($invites->find()) {
340 while ($invites->fetch()) {
341 $other = User::staticGet($invites->user_id);
342 subs_subscribe_to($other, $this);
347 function hasFave($notice)
349 $cache = common_memcache();
351 // XXX: Kind of a hack.
354 // This is the stream of favorite notices, in rev chron
355 // order. This forces it into cache.
357 $ids = Fave::stream($this->id, 0, NOTICE_CACHE_WINDOW);
359 // If it's in the list, then it's a fave
361 if (in_array($notice->id, $ids)) {
365 // If we're not past the end of the cache window,
366 // then the cache has all available faves, so this one
369 if (count($ids) < NOTICE_CACHE_WINDOW) {
373 // Otherwise, cache doesn't have all faves;
374 // fall through to the default
377 $fave = Fave::pkeyGet(array('user_id' => $this->id,
378 'notice_id' => $notice->id));
379 return ((is_null($fave)) ? false : true);
382 function mutuallySubscribed($other)
384 return $this->isSubscribed($other) &&
385 $other->isSubscribed($this);
388 function mutuallySubscribedUsers()
390 // 3-way join; probably should get cached
391 $UT = common_config('db','type')=='pgsql'?'"user"':'user';
392 $qry = "SELECT $UT.* " .
393 "FROM subscription sub1 JOIN $UT ON sub1.subscribed = $UT.id " .
394 "JOIN subscription sub2 ON $UT.id = sub2.subscriber " .
395 'WHERE sub1.subscriber = %d and sub2.subscribed = %d ' .
396 "ORDER BY $UT.nickname";
398 $user->query(sprintf($qry, $this->id, $this->id));
403 function getReplies($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0, $since=null)
405 $ids = Reply::stream($this->id, $offset, $limit, $since_id, $before_id, $since);
406 return Notice::getStreamByIds($ids);
409 function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0, $since=null) {
410 $profile = $this->getProfile();
414 return $profile->getTaggedNotices($tag, $offset, $limit, $since_id, $before_id, $since);
418 function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0, $since=null)
420 $profile = $this->getProfile();
424 return $profile->getNotices($offset, $limit, $since_id, $before_id, $since);
428 function favoriteNotices($offset=0, $limit=NOTICES_PER_PAGE, $own=false)
430 $ids = Fave::stream($this->id, $offset, $limit, $own);
431 return Notice::getStreamByIds($ids);
434 function noticesWithFriends($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0, $since=null)
436 $enabled = common_config('inboxes', 'enabled');
438 // Complicated code, depending on whether we support inboxes yet
439 // XXX: make this go away when inboxes become mandatory
441 if ($enabled === false ||
442 ($enabled == 'transitional' && $this->inboxed == 0)) {
445 'FROM notice JOIN subscription ON notice.profile_id = subscription.subscribed ' .
446 'WHERE subscription.subscriber = %d ' .
447 'AND notice.is_local != ' . Notice::GATEWAY;
448 return Notice::getStream(sprintf($qry, $this->id),
449 'user:notices_with_friends:' . $this->id,
450 $offset, $limit, $since_id, $before_id,
452 } else if ($enabled === true ||
453 ($enabled == 'transitional' && $this->inboxed == 1)) {
455 $ids = Notice_inbox::stream($this->id, $offset, $limit, $since_id, $before_id, $since, false);
457 return Notice::getStreamByIds($ids);
461 function noticeInbox($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0, $since=null)
463 $enabled = common_config('inboxes', 'enabled');
465 // Complicated code, depending on whether we support inboxes yet
466 // XXX: make this go away when inboxes become mandatory
468 if ($enabled === false ||
469 ($enabled == 'transitional' && $this->inboxed == 0)) {
472 'FROM notice JOIN subscription ON notice.profile_id = subscription.subscribed ' .
473 'WHERE subscription.subscriber = %d ';
474 return Notice::getStream(sprintf($qry, $this->id),
475 'user:notices_with_friends:' . $this->id,
476 $offset, $limit, $since_id, $before_id,
478 } else if ($enabled === true ||
479 ($enabled == 'transitional' && $this->inboxed == 1)) {
481 $ids = Notice_inbox::stream($this->id, $offset, $limit, $since_id, $before_id, $since, true);
483 return Notice::getStreamByIds($ids);
487 function blowFavesCache()
489 $cache = common_memcache();
491 // Faves don't happen chronologically, so we need to blow
493 $cache->delete(common_cache_key('fave:ids_by_user:'.$this->id));
494 $cache->delete(common_cache_key('fave:ids_by_user:'.$this->id.';last'));
495 $cache->delete(common_cache_key('fave:ids_by_user_own:'.$this->id));
496 $cache->delete(common_cache_key('fave:ids_by_user_own:'.$this->id.';last'));
498 $profile = $this->getProfile();
499 $profile->blowFaveCount();
502 function getSelfTags()
504 return Profile_tag::getTags($this->id, $this->id);
507 function setSelfTags($newtags)
509 return Profile_tag::setTags($this->id, $this->id, $newtags);
512 function block($other)
514 // Add a new block record
516 $block = new Profile_block();
518 // Begin a transaction
520 $block->query('BEGIN');
522 $block->blocker = $this->id;
523 $block->blocked = $other->id;
525 $result = $block->insert();
528 common_log_db_error($block, 'INSERT', __FILE__);
532 // Cancel their subscription, if it exists
534 $sub = Subscription::pkeyGet(array('subscriber' => $other->id,
535 'subscribed' => $this->id));
538 $result = $sub->delete();
540 common_log_db_error($sub, 'DELETE', __FILE__);
545 $block->query('COMMIT');
550 function unblock($other)
552 // Get the block record
554 $block = Profile_block::get($this->id, $other->id);
560 $result = $block->delete();
563 common_log_db_error($block, 'DELETE', __FILE__);
570 function isMember($group)
572 $profile = $this->getProfile();
573 return $profile->isMember($group);
576 function isAdmin($group)
578 $profile = $this->getProfile();
579 return $profile->isAdmin($group);
582 function getGroups($offset=0, $limit=null)
585 'SELECT user_group.* ' .
586 'FROM user_group JOIN group_member '.
587 'ON user_group.id = group_member.group_id ' .
588 'WHERE group_member.profile_id = %d ' .
589 'ORDER BY group_member.created DESC ';
592 if (common_config('db','type') == 'pgsql') {
593 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
595 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
599 $groups = new User_group();
601 $cnt = $groups->query(sprintf($qry, $this->id));
606 function getSubscriptions($offset=0, $limit=null)
608 $profile = $this->getProfile();
609 assert(!empty($profile));
610 return $profile->getSubscriptions($offset, $limit);
613 function getSubscribers($offset=0, $limit=null)
615 $profile = $this->getProfile();
616 assert(!empty($profile));
617 return $profile->getSubscribers($offset, $limit);
620 function getTaggedSubscribers($tag, $offset=0, $limit=null)
623 'SELECT profile.* ' .
624 'FROM profile JOIN subscription ' .
625 'ON profile.id = subscription.subscriber ' .
626 'JOIN profile_tag ON (profile_tag.tagged = subscription.subscriber ' .
627 'AND profile_tag.tagger = subscription.subscribed) ' .
628 'WHERE subscription.subscribed = %d ' .
629 "AND profile_tag.tag = '%s' " .
630 'AND subscription.subscribed != subscription.subscriber ' .
631 'ORDER BY subscription.created DESC ';
634 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
637 $profile = new Profile();
639 $cnt = $profile->query(sprintf($qry, $this->id, $tag));
644 function getTaggedSubscriptions($tag, $offset=0, $limit=null)
647 'SELECT profile.* ' .
648 'FROM profile JOIN subscription ' .
649 'ON profile.id = subscription.subscribed ' .
650 'JOIN profile_tag on (profile_tag.tagged = subscription.subscribed ' .
651 'AND profile_tag.tagger = subscription.subscriber) ' .
652 'WHERE subscription.subscriber = %d ' .
653 "AND profile_tag.tag = '%s' " .
654 'AND subscription.subscribed != subscription.subscriber ' .
655 'ORDER BY subscription.created DESC ';
657 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
659 $profile = new Profile();
661 $profile->query(sprintf($qry, $this->id, $tag));
668 return Design::staticGet('id', $this->design_id);
671 function hasRole($name)
673 $role = User_role::pkeyGet(array('user_id' => $this->id,
675 return (!empty($role));
678 function grantRole($name)
680 $role = new User_role();
682 $role->user_id = $this->id;
684 $role->created = common_sql_now();
686 $result = $role->insert();
689 common_log_db_error($role, 'INSERT', __FILE__);
696 function revokeRole($name)
698 $role = User_role::pkeyGet(array('user_id' => $this->id,
702 throw new Exception('Cannot revoke role "'.$name.'" for user #'.$this->id.'; does not exist.');
705 $result = $role->delete();
708 common_log_db_error($role, 'DELETE', __FILE__);
709 throw new Exception('Cannot revoke role "'.$name.'" for user #'.$this->id.'; database error.');
716 * Does this user have the right to do X?
718 * With our role-based authorization, this is merely a lookup for whether the user
719 * has a particular role. The implementation currently uses a switch statement
720 * to determine if the user has the pre-defined role to exercise the right. Future
721 * implementations may allow per-site roles, and different mappings of roles to rights.
723 * @param $right string Name of the right, usually a constant in class Right
724 * @return boolean whether the user has the right in question
727 function hasRight($right)
730 if (Event::handle('UserRightsCheck', array($this, $right, &$result))) {
733 case Right::deleteOthersNotice:
734 $result = $this->hasRole('moderator');
746 $profile = $this->getProfile();
749 $related = array('Fave',
757 if (common_config('inboxes', 'enabled')) {
758 $related[] = 'Notice_inbox';
761 foreach ($related as $cls) {
763 $inst->user_id = $this->id;
767 $this->_deleteTags();
768 $this->_deleteBlocks();
773 function _deleteTags()
775 $tag = new Profile_tag();
776 $tag->tagger = $this->id;
780 function _deleteBlocks()
782 $block = new Profile_block();
783 $block->blocker = $this->id;
785 // XXX delete group block? Reset blocker?