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 // Set default-on options here, otherwise they'll be disabled
254 // initially for sites using caching, since the initial encache
255 // doesn't know about the defaults in the database.
256 $user->emailnotifysub = 1;
257 $user->emailnotifyfav = 1;
258 $user->emailnotifynudge = 1;
259 $user->emailnotifymsg = 1;
260 $user->emailnotifyattn = 1;
261 $user->emailmicroid = 1;
262 $user->emailpost = 1;
263 $user->jabbermicroid = 1;
264 $user->viewdesigns = 1;
266 $user->created = common_sql_now();
268 if (Event::handle('StartUserRegister', array(&$user, &$profile))) {
270 $profile->query('BEGIN');
272 $id = $profile->insert();
275 common_log_db_error($profile, 'INSERT', __FILE__);
284 $user->uri = common_user_uri($user);
287 if (!empty($password)) { // may not have a password for OpenID users
288 $user->password = common_munge_password($password, $id);
291 $result = $user->insert();
294 common_log_db_error($user, 'INSERT', __FILE__);
298 // Everyone gets an inbox
300 $inbox = new Inbox();
302 $inbox->user_id = $user->id;
303 $inbox->notice_ids = '';
305 $result = $inbox->insert();
308 common_log_db_error($inbox, 'INSERT', __FILE__);
312 // Everyone is subscribed to themself
314 $subscription = new Subscription();
315 $subscription->subscriber = $user->id;
316 $subscription->subscribed = $user->id;
317 $subscription->created = $user->created;
319 $result = $subscription->insert();
322 common_log_db_error($subscription, 'INSERT', __FILE__);
326 if (!empty($email) && !$user->email) {
328 $confirm = new Confirm_address();
329 $confirm->code = common_confirmation_code(128);
330 $confirm->user_id = $user->id;
331 $confirm->address = $email;
332 $confirm->address_type = 'email';
334 $result = $confirm->insert();
337 common_log_db_error($confirm, 'INSERT', __FILE__);
342 if (!empty($code) && $user->email) {
343 $user->emailChanged();
346 // Default system subscription
348 $defnick = common_config('newuser', 'default');
350 if (!empty($defnick)) {
351 $defuser = User::staticGet('nickname', $defnick);
352 if (empty($defuser)) {
353 common_log(LOG_WARNING, sprintf("Default user %s does not exist.", $defnick),
356 Subscription::start($user, $defuser);
360 $profile->query('COMMIT');
362 if (!empty($email) && !$user->email) {
363 mail_confirm_address($user, $confirm->code, $profile->nickname, $email);
368 $welcome = common_config('newuser', 'welcome');
370 if (!empty($welcome)) {
371 $welcomeuser = User::staticGet('nickname', $welcome);
372 if (empty($welcomeuser)) {
373 common_log(LOG_WARNING, sprintf("Welcome user %s does not exist.", $defnick),
376 $notice = Notice::saveNew($welcomeuser->id,
377 // TRANS: Notice given on user registration.
378 // TRANS: %1$s is the sitename, $2$s is the registering user's nickname.
379 sprintf(_('Welcome to %1$s, @%2$s!'),
380 common_config('site', 'name'),
386 Event::handle('EndUserRegister', array(&$profile, &$user));
392 // Things we do when the email changes
393 function emailChanged()
396 $invites = new Invitation();
397 $invites->address = $this->email;
398 $invites->address_type = 'email';
400 if ($invites->find()) {
401 while ($invites->fetch()) {
402 $other = User::staticGet($invites->user_id);
403 subs_subscribe_to($other, $this);
408 function hasFave($notice)
410 $profile = $this->getProfile();
411 return $profile->hasFave($notice);
414 function mutuallySubscribed($other)
416 return $this->isSubscribed($other) &&
417 $other->isSubscribed($this);
420 function mutuallySubscribedUsers()
422 // 3-way join; probably should get cached
423 $UT = common_config('db','type')=='pgsql'?'"user"':'user';
424 $qry = "SELECT $UT.* " .
425 "FROM subscription sub1 JOIN $UT ON sub1.subscribed = $UT.id " .
426 "JOIN subscription sub2 ON $UT.id = sub2.subscriber " .
427 'WHERE sub1.subscriber = %d and sub2.subscribed = %d ' .
428 "ORDER BY $UT.nickname";
430 $user->query(sprintf($qry, $this->id, $this->id));
435 function getReplies($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
437 $ids = Reply::stream($this->id, $offset, $limit, $since_id, $before_id);
438 return Notice::getStreamByIds($ids);
441 function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0) {
442 $profile = $this->getProfile();
443 return $profile->getTaggedNotices($tag, $offset, $limit, $since_id, $before_id);
446 function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
448 $profile = $this->getProfile();
449 return $profile->getNotices($offset, $limit, $since_id, $before_id);
452 function favoriteNotices($own=false, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
454 $ids = Fave::stream($this->id, $offset, $limit, $own, $since_id, $max_id);
455 return Notice::getStreamByIds($ids);
458 function noticesWithFriends($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
460 return Inbox::streamNotices($this->id, $offset, $limit, $since_id, $before_id, false);
463 function noticeInbox($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
465 return Inbox::streamNotices($this->id, $offset, $limit, $since_id, $before_id, true);
468 function friendsTimeline($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 ownFriendsTimeline($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 blowFavesCache()
480 $profile = $this->getProfile();
481 $profile->blowFavesCache();
484 function getSelfTags()
486 return Profile_tag::getTags($this->id, $this->id);
489 function setSelfTags($newtags)
491 return Profile_tag::setTags($this->id, $this->id, $newtags);
494 function block($other)
496 // Add a new block record
498 // no blocking (and thus unsubbing from) yourself
500 if ($this->id == $other->id) {
501 common_log(LOG_WARNING,
503 "Profile ID %d (%s) tried to block themself.",
511 $block = new Profile_block();
513 // Begin a transaction
515 $block->query('BEGIN');
517 $block->blocker = $this->id;
518 $block->blocked = $other->id;
520 $result = $block->insert();
523 common_log_db_error($block, 'INSERT', __FILE__);
527 $self = $this->getProfile();
528 if (Subscription::exists($other, $self)) {
529 Subscription::cancel($other, $self);
531 if (Subscription::exists($self, $other)) {
532 Subscription::cancel($self, $other);
535 $block->query('COMMIT');
540 function unblock($other)
542 // Get the block record
544 $block = Profile_block::get($this->id, $other->id);
550 $result = $block->delete();
553 common_log_db_error($block, 'DELETE', __FILE__);
560 function isMember($group)
562 $profile = $this->getProfile();
563 return $profile->isMember($group);
566 function isAdmin($group)
568 $profile = $this->getProfile();
569 return $profile->isAdmin($group);
572 function getGroups($offset=0, $limit=null)
574 $profile = $this->getProfile();
575 return $profile->getGroups($offset, $limit);
578 function getSubscriptions($offset=0, $limit=null)
580 $profile = $this->getProfile();
581 return $profile->getSubscriptions($offset, $limit);
584 function getSubscribers($offset=0, $limit=null)
586 $profile = $this->getProfile();
587 return $profile->getSubscribers($offset, $limit);
590 function getTaggedSubscribers($tag, $offset=0, $limit=null)
593 'SELECT profile.* ' .
594 'FROM profile JOIN subscription ' .
595 'ON profile.id = subscription.subscriber ' .
596 'JOIN profile_tag ON (profile_tag.tagged = subscription.subscriber ' .
597 'AND profile_tag.tagger = subscription.subscribed) ' .
598 'WHERE subscription.subscribed = %d ' .
599 "AND profile_tag.tag = '%s' " .
600 'AND subscription.subscribed != subscription.subscriber ' .
601 'ORDER BY subscription.created DESC ';
604 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
607 $profile = new Profile();
609 $cnt = $profile->query(sprintf($qry, $this->id, $tag));
614 function getTaggedSubscriptions($tag, $offset=0, $limit=null)
617 'SELECT profile.* ' .
618 'FROM profile JOIN subscription ' .
619 'ON profile.id = subscription.subscribed ' .
620 'JOIN profile_tag on (profile_tag.tagged = subscription.subscribed ' .
621 'AND profile_tag.tagger = subscription.subscriber) ' .
622 'WHERE subscription.subscriber = %d ' .
623 "AND profile_tag.tag = '%s' " .
624 'AND subscription.subscribed != subscription.subscriber ' .
625 'ORDER BY subscription.created DESC ';
627 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
629 $profile = new Profile();
631 $profile->query(sprintf($qry, $this->id, $tag));
638 return Design::staticGet('id', $this->design_id);
641 function hasRight($right)
643 $profile = $this->getProfile();
644 return $profile->hasRight($right);
650 $profile = $this->getProfile();
652 } catch (UserNoProfileException $unp) {
653 common_log(LOG_INFO, "User {$this->nickname} has no profile; continuing deletion.");
656 $related = array('Fave',
663 Event::handle('UserDeleteRelated', array($this, &$related));
665 foreach ($related as $cls) {
667 $inst->user_id = $this->id;
671 $this->_deleteTags();
672 $this->_deleteBlocks();
677 function _deleteTags()
679 $tag = new Profile_tag();
680 $tag->tagger = $this->id;
684 function _deleteBlocks()
686 $block = new Profile_block();
687 $block->blocker = $this->id;
689 // XXX delete group block? Reset blocker?
692 function hasRole($name)
694 $profile = $this->getProfile();
695 return $profile->hasRole($name);
698 function grantRole($name)
700 $profile = $this->getProfile();
701 return $profile->grantRole($name);
704 function revokeRole($name)
706 $profile = $this->getProfile();
707 return $profile->revokeRole($name);
710 function isSandboxed()
712 $profile = $this->getProfile();
713 return $profile->isSandboxed();
716 function isSilenced()
718 $profile = $this->getProfile();
719 return $profile->isSilenced();
722 function repeatedByMe($offset=0, $limit=20, $since_id=null, $max_id=null)
724 $ids = Notice::stream(array($this, '_repeatedByMeDirect'),
726 'user:repeated_by_me:'.$this->id,
727 $offset, $limit, $since_id, $max_id, null);
729 return Notice::getStreamByIds($ids);
732 function _repeatedByMeDirect($offset, $limit, $since_id, $max_id)
734 $notice = new Notice();
736 $notice->selectAdd(); // clears it
737 $notice->selectAdd('id');
739 $notice->profile_id = $this->id;
740 $notice->whereAdd('repeat_of IS NOT NULL');
742 $notice->orderBy('id DESC');
744 if (!is_null($offset)) {
745 $notice->limit($offset, $limit);
748 if ($since_id != 0) {
749 $notice->whereAdd('id > ' . $since_id);
753 $notice->whereAdd('id <= ' . $max_id);
758 if ($notice->find()) {
759 while ($notice->fetch()) {
760 $ids[] = $notice->id;
770 function repeatsOfMe($offset=0, $limit=20, $since_id=null, $max_id=null)
772 $ids = Notice::stream(array($this, '_repeatsOfMeDirect'),
774 'user:repeats_of_me:'.$this->id,
775 $offset, $limit, $since_id, $max_id);
777 return Notice::getStreamByIds($ids);
780 function _repeatsOfMeDirect($offset, $limit, $since_id, $max_id)
783 'SELECT DISTINCT original.id AS id ' .
784 'FROM notice original JOIN notice rept ON original.id = rept.repeat_of ' .
785 'WHERE original.profile_id = ' . $this->id . ' ';
787 if ($since_id != 0) {
788 $qry .= 'AND original.id > ' . $since_id . ' ';
792 $qry .= 'AND original.id <= ' . $max_id . ' ';
795 // NOTE: we sort by fave time, not by notice time!
797 $qry .= 'ORDER BY original.id DESC ';
799 if (!is_null($offset)) {
800 $qry .= "LIMIT $limit OFFSET $offset";
805 $notice = new Notice();
807 $notice->query($qry);
809 while ($notice->fetch()) {
810 $ids[] = $notice->id;
819 function repeatedToMe($offset=0, $limit=20, $since_id=null, $max_id=null)
821 throw new Exception("Not implemented since inbox change.");
824 function shareLocation()
826 $cfg = common_config('location', 'share');
828 if ($cfg == 'always') {
830 } else if ($cfg == 'never') {
835 $prefs = User_location_prefs::staticGet('user_id', $this->id);
838 $share = common_config('location', 'sharedefault');
840 $share = $prefs->share_location;
848 static function siteOwner()
850 $owner = self::cacheGet('user:site_owner');
852 if ($owner === false) { // cache miss
854 $pr = new Profile_role();
856 $pr->role = Profile_role::OWNER;
858 $pr->orderBy('created');
862 if ($pr->find(true)) {
863 $owner = User::staticGet('id', $pr->profile_id);
868 self::cacheSet('user:site_owner', $owner);