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 $sms; // varchar(64) unique_key
52 public $carrier; // int(4)
53 public $smsnotify; // tinyint(1)
54 public $smsreplies; // tinyint(1)
55 public $smsemail; // varchar(255)
56 public $uri; // varchar(255) unique_key
57 public $autosubscribe; // tinyint(1)
58 public $urlshorteningservice; // varchar(50) default_ur1.ca
59 public $inboxed; // tinyint(1)
60 public $design_id; // int(4)
61 public $viewdesigns; // tinyint(1) default_1
62 public $created; // datetime() not_null
63 public $modified; // timestamp() not_null default_CURRENT_TIMESTAMP
66 function staticGet($k,$v=NULL) { return Memcached_DataObject::staticGet('User',$k,$v); }
68 /* the code above is auto generated do not remove the tag below */
73 $profile = Profile::staticGet('id', $this->id);
74 if (empty($profile)) {
75 throw new UserNoProfileException($this);
80 function isSubscribed($other)
82 return Subscription::exists($this->getProfile(), $other);
85 // 'update' won't write key columns, so we have to do it ourselves.
87 function updateKeys(&$orig)
91 foreach (array('nickname', 'email', '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);
136 * Get the most recent notice posted by this user, if any.
138 * @return mixed Notice or null
140 function getCurrentNotice()
142 $profile = $this->getProfile();
143 return $profile->getCurrentNotice();
146 function getCarrier()
148 return Sms_carrier::staticGet('id', $this->carrier);
152 * @deprecated use Subscription::start($sub, $other);
154 function subscribeTo($other)
156 return Subscription::start($this->getProfile(), $other);
159 function hasBlocked($other)
161 $profile = $this->getProfile();
162 return $profile->hasBlocked($other);
166 * Register a new user account and profile and set up default subscriptions.
167 * If a new-user welcome message is configured, this will be sent.
169 * @param array $fields associative array of optional properties
172 * bool 'email_confirmed' pass true to mark email as pre-confirmed
175 * string 'location' informal string description of geolocation
176 * float 'lat' decimal latitude for geolocation
177 * float 'lon' decimal longitude for geolocation
178 * int 'location_id' geoname identifier
179 * int 'location_ns' geoname namespace to interpret location_id
180 * string 'nickname' REQUIRED
181 * string 'password' (may be missing for eg OpenID registrations)
182 * string 'code' invite code
183 * ?string 'uri' permalink to notice; defaults to local notice URL
184 * @return mixed User object or false on failure
186 static function register($fields) {
188 // MAGICALLY put fields into current scope
192 $profile = new Profile();
196 $email = common_canonical_email($email);
199 $nickname = common_canonical_nickname($nickname);
200 $profile->nickname = $nickname;
201 if(! User::allowed_nickname($nickname)){
202 common_log(LOG_WARNING, sprintf("Attempted to register a nickname that is not allowed: %s", $profile->nickname),
206 $profile->profileurl = common_profile_url($nickname);
208 if (!empty($fullname)) {
209 $profile->fullname = $fullname;
211 if (!empty($homepage)) {
212 $profile->homepage = $homepage;
215 $profile->bio = $bio;
217 if (!empty($location)) {
218 $profile->location = $location;
220 $loc = Location::fromName($location);
223 $profile->lat = $loc->lat;
224 $profile->lon = $loc->lon;
225 $profile->location_id = $loc->location_id;
226 $profile->location_ns = $loc->location_ns;
230 $profile->created = common_sql_now();
234 $user->nickname = $nickname;
236 // Users who respond to invite email have proven their ownership of that address
239 $invite = Invitation::staticGet($code);
240 if ($invite && $invite->address && $invite->address_type == 'email' && $invite->address == $email) {
241 $user->email = $invite->address;
245 if(isset($email_confirmed) && $email_confirmed) {
246 $user->email = $email;
249 // This flag is ignored but still set to 1
253 $user->created = common_sql_now();
255 if (Event::handle('StartUserRegister', array(&$user, &$profile))) {
257 $profile->query('BEGIN');
259 $id = $profile->insert();
262 common_log_db_error($profile, 'INSERT', __FILE__);
267 $user->uri = common_user_uri($user);
268 if (!empty($password)) { // may not have a password for OpenID users
269 $user->password = common_munge_password($password, $id);
272 $result = $user->insert();
275 common_log_db_error($user, 'INSERT', __FILE__);
279 // Everyone gets an inbox
281 $inbox = new Inbox();
283 $inbox->user_id = $user->id;
284 $inbox->notice_ids = '';
286 $result = $inbox->insert();
289 common_log_db_error($inbox, 'INSERT', __FILE__);
293 // Everyone is subscribed to themself
295 $subscription = new Subscription();
296 $subscription->subscriber = $user->id;
297 $subscription->subscribed = $user->id;
298 $subscription->created = $user->created;
300 $result = $subscription->insert();
303 common_log_db_error($subscription, 'INSERT', __FILE__);
307 if (!empty($email) && !$user->email) {
309 $confirm = new Confirm_address();
310 $confirm->code = common_confirmation_code(128);
311 $confirm->user_id = $user->id;
312 $confirm->address = $email;
313 $confirm->address_type = 'email';
315 $result = $confirm->insert();
318 common_log_db_error($confirm, 'INSERT', __FILE__);
323 if (!empty($code) && $user->email) {
324 $user->emailChanged();
327 // Default system subscription
329 $defnick = common_config('newuser', 'default');
331 if (!empty($defnick)) {
332 $defuser = User::staticGet('nickname', $defnick);
333 if (empty($defuser)) {
334 common_log(LOG_WARNING, sprintf("Default user %s does not exist.", $defnick),
337 Subscription::start($user, $defuser);
341 $profile->query('COMMIT');
343 if (!empty($email) && !$user->email) {
344 mail_confirm_address($user, $confirm->code, $profile->nickname, $email);
349 $welcome = common_config('newuser', 'welcome');
351 if (!empty($welcome)) {
352 $welcomeuser = User::staticGet('nickname', $welcome);
353 if (empty($welcomeuser)) {
354 common_log(LOG_WARNING, sprintf("Welcome user %s does not exist.", $defnick),
357 $notice = Notice::saveNew($welcomeuser->id,
358 sprintf(_('Welcome to %1$s, @%2$s!'),
359 common_config('site', 'name'),
366 Event::handle('EndUserRegister', array(&$profile, &$user));
372 // Things we do when the email changes
374 function emailChanged()
377 $invites = new Invitation();
378 $invites->address = $this->email;
379 $invites->address_type = 'email';
381 if ($invites->find()) {
382 while ($invites->fetch()) {
383 $other = User::staticGet($invites->user_id);
384 subs_subscribe_to($other, $this);
389 function hasFave($notice)
391 $cache = common_memcache();
393 // XXX: Kind of a hack.
396 // This is the stream of favorite notices, in rev chron
397 // order. This forces it into cache.
399 $ids = Fave::stream($this->id, 0, NOTICE_CACHE_WINDOW);
401 // If it's in the list, then it's a fave
403 if (in_array($notice->id, $ids)) {
407 // If we're not past the end of the cache window,
408 // then the cache has all available faves, so this one
411 if (count($ids) < NOTICE_CACHE_WINDOW) {
415 // Otherwise, cache doesn't have all faves;
416 // fall through to the default
419 $fave = Fave::pkeyGet(array('user_id' => $this->id,
420 'notice_id' => $notice->id));
421 return ((is_null($fave)) ? false : true);
424 function mutuallySubscribed($other)
426 return $this->isSubscribed($other) &&
427 $other->isSubscribed($this);
430 function mutuallySubscribedUsers()
432 // 3-way join; probably should get cached
433 $UT = common_config('db','type')=='pgsql'?'"user"':'user';
434 $qry = "SELECT $UT.* " .
435 "FROM subscription sub1 JOIN $UT ON sub1.subscribed = $UT.id " .
436 "JOIN subscription sub2 ON $UT.id = sub2.subscriber " .
437 'WHERE sub1.subscriber = %d and sub2.subscribed = %d ' .
438 "ORDER BY $UT.nickname";
440 $user->query(sprintf($qry, $this->id, $this->id));
445 function getReplies($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
447 $ids = Reply::stream($this->id, $offset, $limit, $since_id, $before_id);
448 return Notice::getStreamByIds($ids);
451 function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0) {
452 $profile = $this->getProfile();
453 return $profile->getTaggedNotices($tag, $offset, $limit, $since_id, $before_id);
456 function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
458 $profile = $this->getProfile();
459 return $profile->getNotices($offset, $limit, $since_id, $before_id);
462 function favoriteNotices($offset=0, $limit=NOTICES_PER_PAGE, $own=false)
464 $ids = Fave::stream($this->id, $offset, $limit, $own);
465 return Notice::getStreamByIds($ids);
468 function noticesWithFriends($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
470 return Inbox::streamNotices($this->id, $offset, $limit, $since_id, $before_id, false);
473 function noticeInbox($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
475 return Inbox::streamNotices($this->id, $offset, $limit, $since_id, $before_id, true);
478 function friendsTimeline($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
480 return Inbox::streamNotices($this->id, $offset, $limit, $since_id, $before_id, false);
483 function ownFriendsTimeline($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
485 return Inbox::streamNotices($this->id, $offset, $limit, $since_id, $before_id, true);
488 function blowFavesCache()
490 $cache = common_memcache();
492 // Faves don't happen chronologically, so we need to blow
494 $cache->delete(common_cache_key('fave:ids_by_user:'.$this->id));
495 $cache->delete(common_cache_key('fave:ids_by_user:'.$this->id.';last'));
496 $cache->delete(common_cache_key('fave:ids_by_user_own:'.$this->id));
497 $cache->delete(common_cache_key('fave:ids_by_user_own:'.$this->id.';last'));
499 $profile = $this->getProfile();
500 $profile->blowFaveCount();
503 function getSelfTags()
505 return Profile_tag::getTags($this->id, $this->id);
508 function setSelfTags($newtags)
510 return Profile_tag::setTags($this->id, $this->id, $newtags);
513 function block($other)
515 // Add a new block record
517 // no blocking (and thus unsubbing from) yourself
519 if ($this->id == $other->id) {
520 common_log(LOG_WARNING,
522 "Profile ID %d (%s) tried to block his or herself.",
530 $block = new Profile_block();
532 // Begin a transaction
534 $block->query('BEGIN');
536 $block->blocker = $this->id;
537 $block->blocked = $other->id;
539 $result = $block->insert();
542 common_log_db_error($block, 'INSERT', __FILE__);
546 // Cancel their subscription, if it exists
548 $otherUser = User::staticGet('id', $other->id);
550 if (!empty($otherUser)) {
551 subs_unsubscribe_to($otherUser, $this->getProfile());
554 $block->query('COMMIT');
559 function unblock($other)
561 // Get the block record
563 $block = Profile_block::get($this->id, $other->id);
569 $result = $block->delete();
572 common_log_db_error($block, 'DELETE', __FILE__);
579 function isMember($group)
581 $profile = $this->getProfile();
582 return $profile->isMember($group);
585 function isAdmin($group)
587 $profile = $this->getProfile();
588 return $profile->isAdmin($group);
591 function getGroups($offset=0, $limit=null)
593 $profile = $this->getProfile();
594 return $profile->getGroups($offset, $limit);
597 function getSubscriptions($offset=0, $limit=null)
599 $profile = $this->getProfile();
600 return $profile->getSubscriptions($offset, $limit);
603 function getSubscribers($offset=0, $limit=null)
605 $profile = $this->getProfile();
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 hasRight($right)
662 $profile = $this->getProfile();
663 return $profile->hasRight($right);
668 $profile = $this->getProfile();
671 $related = array('Fave',
677 Event::handle('UserDeleteRelated', array($this, &$related));
679 foreach ($related as $cls) {
681 $inst->user_id = $this->id;
685 $this->_deleteTags();
686 $this->_deleteBlocks();
691 function _deleteTags()
693 $tag = new Profile_tag();
694 $tag->tagger = $this->id;
698 function _deleteBlocks()
700 $block = new Profile_block();
701 $block->blocker = $this->id;
703 // XXX delete group block? Reset blocker?
706 function hasRole($name)
708 $profile = $this->getProfile();
709 return $profile->hasRole($name);
712 function grantRole($name)
714 $profile = $this->getProfile();
715 return $profile->grantRole($name);
718 function revokeRole($name)
720 $profile = $this->getProfile();
721 return $profile->revokeRole($name);
724 function isSandboxed()
726 $profile = $this->getProfile();
727 return $profile->isSandboxed();
730 function isSilenced()
732 $profile = $this->getProfile();
733 return $profile->isSilenced();
736 function repeatedByMe($offset=0, $limit=20, $since_id=null, $max_id=null)
738 $ids = Notice::stream(array($this, '_repeatedByMeDirect'),
740 'user:repeated_by_me:'.$this->id,
741 $offset, $limit, $since_id, $max_id, null);
743 return Notice::getStreamByIds($ids);
746 function _repeatedByMeDirect($offset, $limit, $since_id, $max_id)
748 $notice = new Notice();
750 $notice->selectAdd(); // clears it
751 $notice->selectAdd('id');
753 $notice->profile_id = $this->id;
754 $notice->whereAdd('repeat_of IS NOT NULL');
756 $notice->orderBy('id DESC');
758 if (!is_null($offset)) {
759 $notice->limit($offset, $limit);
762 if ($since_id != 0) {
763 $notice->whereAdd('id > ' . $since_id);
767 $notice->whereAdd('id <= ' . $max_id);
772 if ($notice->find()) {
773 while ($notice->fetch()) {
774 $ids[] = $notice->id;
784 function repeatsOfMe($offset=0, $limit=20, $since_id=null, $max_id=null)
786 $ids = Notice::stream(array($this, '_repeatsOfMeDirect'),
788 'user:repeats_of_me:'.$this->id,
789 $offset, $limit, $since_id, $max_id);
791 return Notice::getStreamByIds($ids);
794 function _repeatsOfMeDirect($offset, $limit, $since_id, $max_id)
797 'SELECT DISTINCT original.id AS id ' .
798 'FROM notice original JOIN notice rept ON original.id = rept.repeat_of ' .
799 'WHERE original.profile_id = ' . $this->id . ' ';
801 if ($since_id != 0) {
802 $qry .= 'AND original.id > ' . $since_id . ' ';
806 $qry .= 'AND original.id <= ' . $max_id . ' ';
809 // NOTE: we sort by fave time, not by notice time!
811 $qry .= 'ORDER BY original.id DESC ';
813 if (!is_null($offset)) {
814 $qry .= "LIMIT $limit OFFSET $offset";
819 $notice = new Notice();
821 $notice->query($qry);
823 while ($notice->fetch()) {
824 $ids[] = $notice->id;
833 function repeatedToMe($offset=0, $limit=20, $since_id=null, $max_id=null)
835 throw new Exception("Not implemented since inbox change.");
838 function shareLocation()
840 $cfg = common_config('location', 'share');
842 if ($cfg == 'always') {
844 } else if ($cfg == 'never') {
849 $prefs = User_location_prefs::staticGet('user_id', $this->id);
852 $share = common_config('location', 'sharedefault');
854 $share = $prefs->share_location;
862 static function siteOwner()
864 $owner = self::cacheGet('user:site_owner');
866 if ($owner === false) { // cache miss
868 $pr = new Profile_role();
870 $pr->role = Profile_role::OWNER;
872 $pr->orderBy('created');
876 if ($pr->find(true)) {
877 $owner = User::staticGet('id', $pr->profile_id);
882 self::cacheSet('user:site_owner', $owner);