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 $profile = Profile::staticGet('id', $this->id);
79 if (empty($profile)) {
80 throw new UserNoProfileException($this);
85 function isSubscribed($other)
87 return Subscription::exists($this->getProfile(), $other);
90 // 'update' won't write key columns, so we have to do it ourselves.
92 function updateKeys(&$orig)
96 foreach (array('nickname', 'email', 'jabber', 'incomingemail', 'sms', 'carrier', 'smsemail', 'language', 'timezone') as $k) {
97 if (strcmp($this->$k, $orig->$k) != 0) {
98 $parts[] = $k . ' = ' . $this->_quote($this->$k);
101 if (count($parts) == 0) {
105 $toupdate = implode(', ', $parts);
107 $table = common_database_tablename($this->tableName());
108 $qry = 'UPDATE ' . $table . ' SET ' . $toupdate .
109 ' WHERE id = ' . $this->id;
111 $result = $this->query($qry);
118 static function allowed_nickname($nickname)
120 // XXX: should already be validated for size, content, etc.
121 $blacklist = common_config('nickname', 'blacklist');
123 //all directory and file names should be blacklisted
124 $d = dir(INSTALLDIR);
125 while (false !== ($entry = $d->read())) {
130 //all top level names in the router should be blacklisted
131 $router = Router::get();
132 foreach(array_keys($router->m->getPaths()) as $path){
133 if(preg_match('/^\/(.*?)[\/\?]/',$path,$matches)){
134 $blacklist[]=$matches[1];
137 return !in_array($nickname, $blacklist);
141 * Get the most recent notice posted by this user, if any.
143 * @return mixed Notice or null
145 function getCurrentNotice()
147 $profile = $this->getProfile();
148 return $profile->getCurrentNotice();
151 function getCarrier()
153 return Sms_carrier::staticGet('id', $this->carrier);
157 * @deprecated use Subscription::start($sub, $other);
159 function subscribeTo($other)
161 return Subscription::start($this->getProfile(), $other);
164 function hasBlocked($other)
166 $profile = $this->getProfile();
167 return $profile->hasBlocked($other);
171 * Register a new user account and profile and set up default subscriptions.
172 * If a new-user welcome message is configured, this will be sent.
174 * @param array $fields associative array of optional properties
177 * bool 'email_confirmed' pass true to mark email as pre-confirmed
180 * string 'location' informal string description of geolocation
181 * float 'lat' decimal latitude for geolocation
182 * float 'lon' decimal longitude for geolocation
183 * int 'location_id' geoname identifier
184 * int 'location_ns' geoname namespace to interpret location_id
185 * string 'nickname' REQUIRED
186 * string 'password' (may be missing for eg OpenID registrations)
187 * string 'code' invite code
188 * ?string 'uri' permalink to notice; defaults to local notice URL
189 * @return mixed User object or false on failure
191 static function register($fields) {
193 // MAGICALLY put fields into current scope
197 $profile = new Profile();
201 $email = common_canonical_email($email);
204 $nickname = common_canonical_nickname($nickname);
205 $profile->nickname = $nickname;
206 if(! User::allowed_nickname($nickname)){
207 common_log(LOG_WARNING, sprintf("Attempted to register a nickname that is not allowed: %s", $profile->nickname),
211 $profile->profileurl = common_profile_url($nickname);
213 if (!empty($fullname)) {
214 $profile->fullname = $fullname;
216 if (!empty($homepage)) {
217 $profile->homepage = $homepage;
220 $profile->bio = $bio;
222 if (!empty($location)) {
223 $profile->location = $location;
225 $loc = Location::fromName($location);
228 $profile->lat = $loc->lat;
229 $profile->lon = $loc->lon;
230 $profile->location_id = $loc->location_id;
231 $profile->location_ns = $loc->location_ns;
235 $profile->created = common_sql_now();
239 $user->nickname = $nickname;
241 // Users who respond to invite email have proven their ownership of that address
244 $invite = Invitation::staticGet($code);
245 if ($invite && $invite->address && $invite->address_type == 'email' && $invite->address == $email) {
246 $user->email = $invite->address;
250 if(isset($email_confirmed) && $email_confirmed) {
251 $user->email = $email;
254 // This flag is ignored but still set to 1
258 // Set default-on options here, otherwise they'll be disabled
259 // initially for sites using caching, since the initial encache
260 // doesn't know about the defaults in the database.
261 $user->emailnotifysub = 1;
262 $user->emailnotifyfav = 1;
263 $user->emailnotifynudge = 1;
264 $user->emailnotifymsg = 1;
265 $user->emailnotifyattn = 1;
266 $user->emailmicroid = 1;
267 $user->emailpost = 1;
268 $user->jabbermicroid = 1;
269 $user->viewdesigns = 1;
271 $user->created = common_sql_now();
273 if (Event::handle('StartUserRegister', array(&$user, &$profile))) {
275 $profile->query('BEGIN');
277 $id = $profile->insert();
280 common_log_db_error($profile, 'INSERT', __FILE__);
285 $user->uri = common_user_uri($user);
286 if (!empty($password)) { // may not have a password for OpenID users
287 $user->password = common_munge_password($password, $id);
290 $result = $user->insert();
293 common_log_db_error($user, 'INSERT', __FILE__);
297 // Everyone gets an inbox
299 $inbox = new Inbox();
301 $inbox->user_id = $user->id;
302 $inbox->notice_ids = '';
304 $result = $inbox->insert();
307 common_log_db_error($inbox, 'INSERT', __FILE__);
311 // Everyone is subscribed to themself
313 $subscription = new Subscription();
314 $subscription->subscriber = $user->id;
315 $subscription->subscribed = $user->id;
316 $subscription->created = $user->created;
318 $result = $subscription->insert();
321 common_log_db_error($subscription, 'INSERT', __FILE__);
325 if (!empty($email) && !$user->email) {
327 $confirm = new Confirm_address();
328 $confirm->code = common_confirmation_code(128);
329 $confirm->user_id = $user->id;
330 $confirm->address = $email;
331 $confirm->address_type = 'email';
333 $result = $confirm->insert();
336 common_log_db_error($confirm, 'INSERT', __FILE__);
341 if (!empty($code) && $user->email) {
342 $user->emailChanged();
345 // Default system subscription
347 $defnick = common_config('newuser', 'default');
349 if (!empty($defnick)) {
350 $defuser = User::staticGet('nickname', $defnick);
351 if (empty($defuser)) {
352 common_log(LOG_WARNING, sprintf("Default user %s does not exist.", $defnick),
355 Subscription::start($user, $defuser);
359 $profile->query('COMMIT');
361 if (!empty($email) && !$user->email) {
362 mail_confirm_address($user, $confirm->code, $profile->nickname, $email);
367 $welcome = common_config('newuser', 'welcome');
369 if (!empty($welcome)) {
370 $welcomeuser = User::staticGet('nickname', $welcome);
371 if (empty($welcomeuser)) {
372 common_log(LOG_WARNING, sprintf("Welcome user %s does not exist.", $defnick),
375 $notice = Notice::saveNew($welcomeuser->id,
376 // TRANS: Notice given on user registration.
377 // TRANS: %1$s is the sitename, $2$s is the registering user's nickname.
378 sprintf(_('Welcome to %1$s, @%2$s!'),
379 common_config('site', 'name'),
385 Event::handle('EndUserRegister', array(&$profile, &$user));
391 // Things we do when the email changes
392 function emailChanged()
395 $invites = new Invitation();
396 $invites->address = $this->email;
397 $invites->address_type = 'email';
399 if ($invites->find()) {
400 while ($invites->fetch()) {
401 $other = User::staticGet($invites->user_id);
402 subs_subscribe_to($other, $this);
407 function hasFave($notice)
409 $cache = common_memcache();
411 // XXX: Kind of a hack.
414 // This is the stream of favorite notices, in rev chron
415 // order. This forces it into cache.
417 $ids = Fave::stream($this->id, 0, NOTICE_CACHE_WINDOW);
419 // If it's in the list, then it's a fave
421 if (in_array($notice->id, $ids)) {
425 // If we're not past the end of the cache window,
426 // then the cache has all available faves, so this one
429 if (count($ids) < NOTICE_CACHE_WINDOW) {
433 // Otherwise, cache doesn't have all faves;
434 // fall through to the default
437 $fave = Fave::pkeyGet(array('user_id' => $this->id,
438 'notice_id' => $notice->id));
439 return ((is_null($fave)) ? false : true);
442 function mutuallySubscribed($other)
444 return $this->isSubscribed($other) &&
445 $other->isSubscribed($this);
448 function mutuallySubscribedUsers()
450 // 3-way join; probably should get cached
451 $UT = common_config('db','type')=='pgsql'?'"user"':'user';
452 $qry = "SELECT $UT.* " .
453 "FROM subscription sub1 JOIN $UT ON sub1.subscribed = $UT.id " .
454 "JOIN subscription sub2 ON $UT.id = sub2.subscriber " .
455 'WHERE sub1.subscriber = %d and sub2.subscribed = %d ' .
456 "ORDER BY $UT.nickname";
458 $user->query(sprintf($qry, $this->id, $this->id));
463 function getReplies($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
465 $ids = Reply::stream($this->id, $offset, $limit, $since_id, $before_id);
466 return Notice::getStreamByIds($ids);
469 function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0) {
470 $profile = $this->getProfile();
471 return $profile->getTaggedNotices($tag, $offset, $limit, $since_id, $before_id);
474 function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
476 $profile = $this->getProfile();
477 return $profile->getNotices($offset, $limit, $since_id, $before_id);
480 function favoriteNotices($own=false, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
482 $ids = Fave::stream($this->id, $offset, $limit, $own, $since_id, $max_id);
483 return Notice::getStreamByIds($ids);
486 function noticesWithFriends($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
488 return Inbox::streamNotices($this->id, $offset, $limit, $since_id, $before_id, false);
491 function noticeInbox($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
493 return Inbox::streamNotices($this->id, $offset, $limit, $since_id, $before_id, true);
496 function friendsTimeline($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
498 return Inbox::streamNotices($this->id, $offset, $limit, $since_id, $before_id, false);
501 function ownFriendsTimeline($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
503 return Inbox::streamNotices($this->id, $offset, $limit, $since_id, $before_id, true);
506 function blowFavesCache()
508 $cache = common_memcache();
510 // Faves don't happen chronologically, so we need to blow
512 $cache->delete(common_cache_key('fave:ids_by_user:'.$this->id));
513 $cache->delete(common_cache_key('fave:ids_by_user:'.$this->id.';last'));
514 $cache->delete(common_cache_key('fave:ids_by_user_own:'.$this->id));
515 $cache->delete(common_cache_key('fave:ids_by_user_own:'.$this->id.';last'));
517 $profile = $this->getProfile();
518 $profile->blowFaveCount();
521 function getSelfTags()
523 return Profile_tag::getTags($this->id, $this->id);
526 function setSelfTags($newtags)
528 return Profile_tag::setTags($this->id, $this->id, $newtags);
531 function block($other)
533 // Add a new block record
535 // no blocking (and thus unsubbing from) yourself
537 if ($this->id == $other->id) {
538 common_log(LOG_WARNING,
540 "Profile ID %d (%s) tried to block themself.",
548 $block = new Profile_block();
550 // Begin a transaction
552 $block->query('BEGIN');
554 $block->blocker = $this->id;
555 $block->blocked = $other->id;
557 $result = $block->insert();
560 common_log_db_error($block, 'INSERT', __FILE__);
564 $self = $this->getProfile();
565 if (Subscription::exists($other, $self)) {
566 Subscription::cancel($other, $self);
568 if (Subscription::exists($self, $other)) {
569 Subscription::cancel($self, $other);
572 $block->query('COMMIT');
577 function unblock($other)
579 // Get the block record
581 $block = Profile_block::get($this->id, $other->id);
587 $result = $block->delete();
590 common_log_db_error($block, 'DELETE', __FILE__);
597 function isMember($group)
599 $profile = $this->getProfile();
600 return $profile->isMember($group);
603 function isAdmin($group)
605 $profile = $this->getProfile();
606 return $profile->isAdmin($group);
609 function getGroups($offset=0, $limit=null)
611 $profile = $this->getProfile();
612 return $profile->getGroups($offset, $limit);
615 function getSubscriptions($offset=0, $limit=null)
617 $profile = $this->getProfile();
618 return $profile->getSubscriptions($offset, $limit);
621 function getSubscribers($offset=0, $limit=null)
623 $profile = $this->getProfile();
624 return $profile->getSubscribers($offset, $limit);
627 function getTaggedSubscribers($tag, $offset=0, $limit=null)
630 'SELECT profile.* ' .
631 'FROM profile JOIN subscription ' .
632 'ON profile.id = subscription.subscriber ' .
633 'JOIN profile_tag ON (profile_tag.tagged = subscription.subscriber ' .
634 'AND profile_tag.tagger = subscription.subscribed) ' .
635 'WHERE subscription.subscribed = %d ' .
636 "AND profile_tag.tag = '%s' " .
637 'AND subscription.subscribed != subscription.subscriber ' .
638 'ORDER BY subscription.created DESC ';
641 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
644 $profile = new Profile();
646 $cnt = $profile->query(sprintf($qry, $this->id, $tag));
651 function getTaggedSubscriptions($tag, $offset=0, $limit=null)
654 'SELECT profile.* ' .
655 'FROM profile JOIN subscription ' .
656 'ON profile.id = subscription.subscribed ' .
657 'JOIN profile_tag on (profile_tag.tagged = subscription.subscribed ' .
658 'AND profile_tag.tagger = subscription.subscriber) ' .
659 'WHERE subscription.subscriber = %d ' .
660 "AND profile_tag.tag = '%s' " .
661 'AND subscription.subscribed != subscription.subscriber ' .
662 'ORDER BY subscription.created DESC ';
664 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
666 $profile = new Profile();
668 $profile->query(sprintf($qry, $this->id, $tag));
675 return Design::staticGet('id', $this->design_id);
678 function hasRight($right)
680 $profile = $this->getProfile();
681 return $profile->hasRight($right);
687 $profile = $this->getProfile();
689 } catch (UserNoProfileException $unp) {
690 common_log(LOG_INFO, "User {$this->nickname} has no profile; continuing deletion.");
693 $related = array('Fave',
700 Event::handle('UserDeleteRelated', array($this, &$related));
702 foreach ($related as $cls) {
704 $inst->user_id = $this->id;
708 $this->_deleteTags();
709 $this->_deleteBlocks();
714 function _deleteTags()
716 $tag = new Profile_tag();
717 $tag->tagger = $this->id;
721 function _deleteBlocks()
723 $block = new Profile_block();
724 $block->blocker = $this->id;
726 // XXX delete group block? Reset blocker?
729 function hasRole($name)
731 $profile = $this->getProfile();
732 return $profile->hasRole($name);
735 function grantRole($name)
737 $profile = $this->getProfile();
738 return $profile->grantRole($name);
741 function revokeRole($name)
743 $profile = $this->getProfile();
744 return $profile->revokeRole($name);
747 function isSandboxed()
749 $profile = $this->getProfile();
750 return $profile->isSandboxed();
753 function isSilenced()
755 $profile = $this->getProfile();
756 return $profile->isSilenced();
759 function repeatedByMe($offset=0, $limit=20, $since_id=null, $max_id=null)
761 $ids = Notice::stream(array($this, '_repeatedByMeDirect'),
763 'user:repeated_by_me:'.$this->id,
764 $offset, $limit, $since_id, $max_id, null);
766 return Notice::getStreamByIds($ids);
769 function _repeatedByMeDirect($offset, $limit, $since_id, $max_id)
771 $notice = new Notice();
773 $notice->selectAdd(); // clears it
774 $notice->selectAdd('id');
776 $notice->profile_id = $this->id;
777 $notice->whereAdd('repeat_of IS NOT NULL');
779 $notice->orderBy('id DESC');
781 if (!is_null($offset)) {
782 $notice->limit($offset, $limit);
785 if ($since_id != 0) {
786 $notice->whereAdd('id > ' . $since_id);
790 $notice->whereAdd('id <= ' . $max_id);
795 if ($notice->find()) {
796 while ($notice->fetch()) {
797 $ids[] = $notice->id;
807 function repeatsOfMe($offset=0, $limit=20, $since_id=null, $max_id=null)
809 $ids = Notice::stream(array($this, '_repeatsOfMeDirect'),
811 'user:repeats_of_me:'.$this->id,
812 $offset, $limit, $since_id, $max_id);
814 return Notice::getStreamByIds($ids);
817 function _repeatsOfMeDirect($offset, $limit, $since_id, $max_id)
820 'SELECT DISTINCT original.id AS id ' .
821 'FROM notice original JOIN notice rept ON original.id = rept.repeat_of ' .
822 'WHERE original.profile_id = ' . $this->id . ' ';
824 if ($since_id != 0) {
825 $qry .= 'AND original.id > ' . $since_id . ' ';
829 $qry .= 'AND original.id <= ' . $max_id . ' ';
832 // NOTE: we sort by fave time, not by notice time!
834 $qry .= 'ORDER BY original.id DESC ';
836 if (!is_null($offset)) {
837 $qry .= "LIMIT $limit OFFSET $offset";
842 $notice = new Notice();
844 $notice->query($qry);
846 while ($notice->fetch()) {
847 $ids[] = $notice->id;
856 function repeatedToMe($offset=0, $limit=20, $since_id=null, $max_id=null)
858 throw new Exception("Not implemented since inbox change.");
861 function shareLocation()
863 $cfg = common_config('location', 'share');
865 if ($cfg == 'always') {
867 } else if ($cfg == 'never') {
872 $prefs = User_location_prefs::staticGet('user_id', $this->id);
875 $share = common_config('location', 'sharedefault');
877 $share = $prefs->share_location;
885 static function siteOwner()
887 $owner = self::cacheGet('user:site_owner');
889 if ($owner === false) { // cache miss
891 $pr = new Profile_role();
893 $pr->role = Profile_role::OWNER;
895 $pr->orderBy('created');
899 if ($pr->find(true)) {
900 $owner = User::staticGet('id', $pr->profile_id);
905 self::cacheSet('user:site_owner', $owner);