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 Managed_DataObject
33 const SUBSCRIBE_POLICY_OPEN = 0;
34 const SUBSCRIBE_POLICY_MODERATE = 1;
37 /* the code below is auto generated do not remove the above tag */
39 public $__table = 'user'; // table name
40 public $id; // int(4) primary_key not_null
41 public $nickname; // varchar(64) unique_key
42 public $password; // varchar(255)
43 public $email; // varchar(255) unique_key
44 public $incomingemail; // varchar(255) unique_key
45 public $emailnotifysub; // tinyint(1) default_1
46 public $emailnotifyfav; // tinyint(1) default_1
47 public $emailnotifynudge; // tinyint(1) default_1
48 public $emailnotifymsg; // tinyint(1) default_1
49 public $emailnotifyattn; // tinyint(1) default_1
50 public $emailmicroid; // tinyint(1) default_1
51 public $language; // varchar(50)
52 public $timezone; // varchar(50)
53 public $emailpost; // tinyint(1) default_1
54 public $sms; // varchar(64) unique_key
55 public $carrier; // int(4)
56 public $smsnotify; // tinyint(1)
57 public $smsreplies; // tinyint(1)
58 public $smsemail; // varchar(255)
59 public $uri; // varchar(255) unique_key
60 public $autosubscribe; // tinyint(1)
61 public $subscribe_policy; // tinyint(1)
62 public $urlshorteningservice; // varchar(50) default_ur1.ca
63 public $inboxed; // tinyint(1)
64 public $private_stream; // tinyint(1) default_0
65 public $created; // datetime() not_null
66 public $modified; // timestamp() not_null default_CURRENT_TIMESTAMP
68 /* the code above is auto generated do not remove the tag below */
71 public static function schemaDef()
74 'description' => 'local users',
76 'id' => array('type' => 'int', 'not null' => true, 'description' => 'foreign key to profile table'),
77 'nickname' => array('type' => 'varchar', 'length' => 64, 'description' => 'nickname or username, duped in profile'),
78 'password' => array('type' => 'varchar', 'length' => 255, 'description' => 'salted password, can be null for OpenID users'),
79 'email' => array('type' => 'varchar', 'length' => 255, 'description' => 'email address for password recovery etc.'),
80 'incomingemail' => array('type' => 'varchar', 'length' => 255, 'description' => 'email address for post-by-email'),
81 'emailnotifysub' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of subscriptions'),
82 'emailnotifyfav' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of favorites'),
83 'emailnotifynudge' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of nudges'),
84 'emailnotifymsg' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of direct messages'),
85 'emailnotifyattn' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of @-replies'),
86 'emailmicroid' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'whether to publish email microid'),
87 'language' => array('type' => 'varchar', 'length' => 50, 'description' => 'preferred language'),
88 'timezone' => array('type' => 'varchar', 'length' => 50, 'description' => 'timezone'),
89 'emailpost' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Post by email'),
90 'sms' => array('type' => 'varchar', 'length' => 64, 'description' => 'sms phone number'),
91 'carrier' => array('type' => 'int', 'description' => 'foreign key to sms_carrier'),
92 'smsnotify' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'whether to send notices to SMS'),
93 'smsreplies' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'whether to send notices to SMS on replies'),
94 'smsemail' => array('type' => 'varchar', 'length' => 255, 'description' => 'built from sms and carrier'),
95 'uri' => array('type' => 'varchar', 'length' => 255, 'description' => 'universally unique identifier, usually a tag URI'),
96 'autosubscribe' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'automatically subscribe to users who subscribe to us'),
97 'subscribe_policy' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => '0 = anybody can subscribe; 1 = require approval'),
98 'urlshorteningservice' => array('type' => 'varchar', 'length' => 50, 'default' => 'internal', 'description' => 'service to use for auto-shortening URLs'),
99 'inboxed' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'has an inbox been created for this user?'),
100 'private_stream' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'whether to limit all notices to followers only'),
102 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'),
103 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
105 'primary key' => array('id'),
106 'unique keys' => array(
107 'user_nickname_key' => array('nickname'),
108 'user_email_key' => array('email'),
109 'user_incomingemail_key' => array('incomingemail'),
110 'user_sms_key' => array('sms'),
111 'user_uri_key' => array('uri'),
113 'foreign keys' => array(
114 'user_id_fkey' => array('profile', array('id' => 'id')),
115 'user_carrier_fkey' => array('sms_carrier', array('carrier' => 'id')),
118 'user_smsemail_idx' => array('smsemail'),
123 protected $_profile = -1;
128 function getProfile()
130 if (is_int($this->_profile) && $this->_profile == -1) { // invalid but distinct from null
131 $this->_profile = Profile::getKV('id', $this->id);
132 if (empty($this->_profile)) {
133 throw new UserNoProfileException($this);
137 return $this->_profile;
140 function isSubscribed($other)
142 $profile = $this->getProfile();
143 return $profile->isSubscribed($other);
146 function hasPendingSubscription($other)
148 $profile = $this->getProfile();
149 return $profile->hasPendingSubscription($other);
152 // 'update' won't write key columns, so we have to do it ourselves.
154 function updateKeys(&$orig)
158 foreach (array('nickname', 'email', 'incomingemail', 'sms', 'carrier', 'smsemail', 'language', 'timezone') as $k) {
159 if (strcmp($this->$k, $orig->$k) != 0) {
160 $parts[] = $k . ' = ' . $this->_quote($this->$k);
163 if (count($parts) == 0) {
167 $toupdate = implode(', ', $parts);
169 $table = common_database_tablename($this->tableName());
170 $qry = 'UPDATE ' . $table . ' SET ' . $toupdate .
171 ' WHERE id = ' . $this->id;
173 $result = $this->query($qry);
181 * Check whether the given nickname is potentially usable, or if it's
182 * excluded by any blacklists on this system.
184 * WARNING: INPUT IS NOT VALIDATED OR NORMALIZED. NON-NORMALIZED INPUT
185 * OR INVALID INPUT MAY LEAD TO FALSE RESULTS.
187 * @param string $nickname
188 * @return boolean true if clear, false if blacklisted
190 static function allowed_nickname($nickname)
192 // XXX: should already be validated for size, content, etc.
193 $blacklist = common_config('nickname', 'blacklist');
195 //all directory and file names should be blacklisted
196 $d = dir(INSTALLDIR);
197 while (false !== ($entry = $d->read())) {
202 //all top level names in the router should be blacklisted
203 $router = Router::get();
204 foreach(array_keys($router->m->getPaths()) as $path){
205 if(preg_match('/^\/(.*?)[\/\?]/',$path,$matches)){
206 $blacklist[]=$matches[1];
209 return !in_array($nickname, $blacklist);
213 * Get the most recent notice posted by this user, if any.
215 * @return mixed Notice or null
217 function getCurrentNotice()
219 $profile = $this->getProfile();
220 return $profile->getCurrentNotice();
223 function getCarrier()
225 return Sms_carrier::getKV('id', $this->carrier);
228 function hasBlocked($other)
230 $profile = $this->getProfile();
231 return $profile->hasBlocked($other);
235 * Register a new user account and profile and set up default subscriptions.
236 * If a new-user welcome message is configured, this will be sent.
238 * @param array $fields associative array of optional properties
241 * bool 'email_confirmed' pass true to mark email as pre-confirmed
244 * string 'location' informal string description of geolocation
245 * float 'lat' decimal latitude for geolocation
246 * float 'lon' decimal longitude for geolocation
247 * int 'location_id' geoname identifier
248 * int 'location_ns' geoname namespace to interpret location_id
249 * string 'nickname' REQUIRED
250 * string 'password' (may be missing for eg OpenID registrations)
251 * string 'code' invite code
252 * ?string 'uri' permalink to notice; defaults to local notice URL
253 * @return mixed User object or false on failure
255 static function register(array $fields) {
257 // MAGICALLY put fields into current scope
261 $profile = new Profile();
265 $email = common_canonical_email($email);
268 $nickname = common_canonical_nickname($nickname);
269 $profile->nickname = $nickname;
270 if(! User::allowed_nickname($nickname)){
271 common_log(LOG_WARNING, sprintf("Attempted to register a nickname that is not allowed: %s", $profile->nickname),
275 $profile->profileurl = common_profile_url($nickname);
277 if (!empty($fullname)) {
278 $profile->fullname = $fullname;
280 if (!empty($homepage)) {
281 $profile->homepage = $homepage;
284 $profile->bio = $bio;
286 if (!empty($location)) {
287 $profile->location = $location;
289 $loc = Location::fromName($location);
292 $profile->lat = $loc->lat;
293 $profile->lon = $loc->lon;
294 $profile->location_id = $loc->location_id;
295 $profile->location_ns = $loc->location_ns;
299 $profile->created = common_sql_now();
303 $user->nickname = $nickname;
307 // Users who respond to invite email have proven their ownership of that address
310 $invite = Invitation::getKV($code);
311 if ($invite && $invite->address && $invite->address_type == 'email' && $invite->address == $email) {
312 $user->email = $invite->address;
316 if(isset($email_confirmed) && $email_confirmed) {
317 $user->email = $email;
320 // This flag is ignored but still set to 1
324 // Set default-on options here, otherwise they'll be disabled
325 // initially for sites using caching, since the initial encache
326 // doesn't know about the defaults in the database.
327 $user->emailnotifysub = 1;
328 $user->emailnotifyfav = 1;
329 $user->emailnotifynudge = 1;
330 $user->emailnotifymsg = 1;
331 $user->emailnotifyattn = 1;
332 $user->emailmicroid = 1;
333 $user->emailpost = 1;
334 $user->jabbermicroid = 1;
336 $user->created = common_sql_now();
338 if (Event::handle('StartUserRegister', array(&$user, &$profile))) {
340 $profile->query('BEGIN');
342 $id = $profile->insert();
345 common_log_db_error($profile, 'INSERT', __FILE__);
354 $user->uri = common_user_uri($user);
357 if (!empty($password)) { // may not have a password for OpenID users
358 $user->password = common_munge_password($password, $id);
361 $result = $user->insert();
364 common_log_db_error($user, 'INSERT', __FILE__);
368 // Everyone gets an inbox
370 $inbox = new Inbox();
372 $inbox->user_id = $user->id;
373 $inbox->notice_ids = '';
375 $result = $inbox->insert();
378 common_log_db_error($inbox, 'INSERT', __FILE__);
382 // Everyone is subscribed to themself
384 $subscription = new Subscription();
385 $subscription->subscriber = $user->id;
386 $subscription->subscribed = $user->id;
387 $subscription->created = $user->created;
389 $result = $subscription->insert();
392 common_log_db_error($subscription, 'INSERT', __FILE__);
396 // Mark that this invite was converted
398 if (!empty($invite)) {
399 $invite->convert($user);
402 if (!empty($email) && !$user->email) {
404 $confirm = new Confirm_address();
405 $confirm->code = common_confirmation_code(128);
406 $confirm->user_id = $user->id;
407 $confirm->address = $email;
408 $confirm->address_type = 'email';
410 $result = $confirm->insert();
413 common_log_db_error($confirm, 'INSERT', __FILE__);
418 if (!empty($code) && $user->email) {
419 $user->emailChanged();
422 // Default system subscription
424 $defnick = common_config('newuser', 'default');
426 if (!empty($defnick)) {
427 $defuser = User::getKV('nickname', $defnick);
428 if (empty($defuser)) {
429 common_log(LOG_WARNING, sprintf("Default user %s does not exist.", $defnick),
432 Subscription::start($profile, $defuser->getProfile());
436 $profile->query('COMMIT');
438 if (!empty($email) && !$user->email) {
439 mail_confirm_address($user, $confirm->code, $profile->nickname, $email);
444 $welcome = common_config('newuser', 'welcome');
446 if (!empty($welcome)) {
447 $welcomeuser = User::getKV('nickname', $welcome);
448 if (empty($welcomeuser)) {
449 common_log(LOG_WARNING, sprintf("Welcome user %s does not exist.", $defnick),
452 $notice = Notice::saveNew($welcomeuser->id,
453 // TRANS: Notice given on user registration.
454 // TRANS: %1$s is the sitename, $2$s is the registering user's nickname.
455 sprintf(_('Welcome to %1$s, @%2$s!'),
456 common_config('site', 'name'),
462 Event::handle('EndUserRegister', array(&$profile, &$user));
468 // Things we do when the email changes
469 function emailChanged()
472 $invites = new Invitation();
473 $invites->address = $this->email;
474 $invites->address_type = 'email';
476 if ($invites->find()) {
477 while ($invites->fetch()) {
478 $other = User::getKV($invites->user_id);
479 subs_subscribe_to($other, $this);
484 function hasFave($notice)
486 $profile = $this->getProfile();
487 return $profile->hasFave($notice);
490 function mutuallySubscribed($other)
492 $profile = $this->getProfile();
493 return $profile->mutuallySubscribed($other);
496 function mutuallySubscribedUsers()
498 // 3-way join; probably should get cached
499 $UT = common_config('db','type')=='pgsql'?'"user"':'user';
500 $qry = "SELECT $UT.* " .
501 "FROM subscription sub1 JOIN $UT ON sub1.subscribed = $UT.id " .
502 "JOIN subscription sub2 ON $UT.id = sub2.subscriber " .
503 'WHERE sub1.subscriber = %d and sub2.subscribed = %d ' .
504 "ORDER BY $UT.nickname";
506 $user->query(sprintf($qry, $this->id, $this->id));
511 function getReplies($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
513 return Reply::stream($this->id, $offset, $limit, $since_id, $before_id);
516 function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0) {
517 $profile = $this->getProfile();
518 return $profile->getTaggedNotices($tag, $offset, $limit, $since_id, $before_id);
521 function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
523 $profile = $this->getProfile();
524 return $profile->getNotices($offset, $limit, $since_id, $before_id);
527 function favoriteNotices($own=false, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
529 return Fave::stream($this->id, $offset, $limit, $own, $since_id, $max_id);
532 function noticeInbox($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
534 $stream = new InboxNoticeStream($this);
535 return $stream->getNotices($offset, $limit, $since_id, $before_id);
538 // DEPRECATED, use noticeInbox()
540 function noticesWithFriends($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
542 return $this->noticeInbox($offset, $limit, $since_id, $before_id);
545 // DEPRECATED, use noticeInbox()
547 function noticesWithFriendsThreaded($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
549 return $this->noticeInbox($offset, $limit, $since_id, $before_id);
552 // DEPRECATED, use noticeInbox()
554 function noticeInboxThreaded($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
556 return $this->noticeInbox($offset, $limit, $since_id, $before_id);
559 // DEPRECATED, use noticeInbox()
561 function friendsTimeline($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
563 return $this->noticeInbox($offset, $limit, $since_id, $before_id);
566 // DEPRECATED, use noticeInbox()
568 function ownFriendsTimeline($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
570 $this->noticeInbox($offset, $limit, $since_id, $before_id);
573 function blowFavesCache()
575 $profile = $this->getProfile();
576 $profile->blowFavesCache();
579 function getSelfTags()
581 return Profile_tag::getTagsArray($this->id, $this->id, $this->id);
584 function setSelfTags($newtags, $privacy)
586 return Profile_tag::setTags($this->id, $this->id, $newtags, $privacy);
589 function block(Profile $other)
591 // Add a new block record
593 // no blocking (and thus unsubbing from) yourself
595 if ($this->id == $other->id) {
596 common_log(LOG_WARNING,
598 "Profile ID %d (%s) tried to block themself.",
606 $block = new Profile_block();
608 // Begin a transaction
610 $block->query('BEGIN');
612 $block->blocker = $this->id;
613 $block->blocked = $other->id;
615 $result = $block->insert();
618 common_log_db_error($block, 'INSERT', __FILE__);
622 $self = $this->getProfile();
623 if (Subscription::exists($other, $self)) {
624 Subscription::cancel($other, $self);
626 if (Subscription::exists($self, $other)) {
627 Subscription::cancel($self, $other);
630 $block->query('COMMIT');
635 function unblock(Profile $other)
637 // Get the block record
639 $block = Profile_block::exists($this->getProfile(), $other);
645 $result = $block->delete();
648 common_log_db_error($block, 'DELETE', __FILE__);
655 function isMember($group)
657 $profile = $this->getProfile();
658 return $profile->isMember($group);
661 function isAdmin($group)
663 $profile = $this->getProfile();
664 return $profile->isAdmin($group);
667 function getGroups($offset=0, $limit=null)
669 $profile = $this->getProfile();
670 return $profile->getGroups($offset, $limit);
674 * Request to join the given group.
675 * May throw exceptions on failure.
677 * @param User_group $group
678 * @return Group_member
680 function joinGroup(User_group $group)
682 $profile = $this->getProfile();
683 return $profile->joinGroup($group);
687 * Leave a group that this user is a member of.
689 * @param User_group $group
691 function leaveGroup(User_group $group)
693 $profile = $this->getProfile();
694 return $profile->leaveGroup($group);
697 function getSubscriptions($offset=0, $limit=null)
699 $profile = $this->getProfile();
700 return $profile->getSubscriptions($offset, $limit);
703 function getSubscribers($offset=0, $limit=null)
705 $profile = $this->getProfile();
706 return $profile->getSubscribers($offset, $limit);
709 function getTaggedSubscribers($tag, $offset=0, $limit=null)
712 'SELECT profile.* ' .
713 'FROM profile JOIN subscription ' .
714 'ON profile.id = subscription.subscriber ' .
715 'JOIN profile_tag ON (profile_tag.tagged = subscription.subscriber ' .
716 'AND profile_tag.tagger = subscription.subscribed) ' .
717 'WHERE subscription.subscribed = %d ' .
718 "AND profile_tag.tag = '%s' " .
719 'AND subscription.subscribed != subscription.subscriber ' .
720 'ORDER BY subscription.created DESC ';
723 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
726 $profile = new Profile();
728 $cnt = $profile->query(sprintf($qry, $this->id, $profile->escape($tag)));
733 function getTaggedSubscriptions($tag, $offset=0, $limit=null)
736 'SELECT profile.* ' .
737 'FROM profile JOIN subscription ' .
738 'ON profile.id = subscription.subscribed ' .
739 'JOIN profile_tag on (profile_tag.tagged = subscription.subscribed ' .
740 'AND profile_tag.tagger = subscription.subscriber) ' .
741 'WHERE subscription.subscriber = %d ' .
742 "AND profile_tag.tag = '%s' " .
743 'AND subscription.subscribed != subscription.subscriber ' .
744 'ORDER BY subscription.created DESC ';
746 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
748 $profile = new Profile();
750 $profile->query(sprintf($qry, $this->id, $profile->escape($tag)));
755 function hasRight($right)
757 $profile = $this->getProfile();
758 return $profile->hasRight($right);
764 $profile = $this->getProfile();
766 } catch (UserNoProfileException $unp) {
767 common_log(LOG_INFO, "User {$this->nickname} has no profile; continuing deletion.");
770 $related = array('Fave',
777 Event::handle('UserDeleteRelated', array($this, &$related));
779 foreach ($related as $cls) {
781 $inst->user_id = $this->id;
785 $this->_deleteTags();
786 $this->_deleteBlocks();
791 function _deleteTags()
793 $tag = new Profile_tag();
794 $tag->tagger = $this->id;
798 function _deleteBlocks()
800 $block = new Profile_block();
801 $block->blocker = $this->id;
803 // XXX delete group block? Reset blocker?
806 function hasRole($name)
808 $profile = $this->getProfile();
809 return $profile->hasRole($name);
812 function grantRole($name)
814 $profile = $this->getProfile();
815 return $profile->grantRole($name);
818 function revokeRole($name)
820 $profile = $this->getProfile();
821 return $profile->revokeRole($name);
824 function isSandboxed()
826 $profile = $this->getProfile();
827 return $profile->isSandboxed();
830 function isSilenced()
832 $profile = $this->getProfile();
833 return $profile->isSilenced();
836 function repeatedByMe($offset=0, $limit=20, $since_id=null, $max_id=null)
838 $stream = new RepeatedByMeNoticeStream($this);
839 return $stream->getNotices($offset, $limit, $since_id, $max_id);
843 function repeatsOfMe($offset=0, $limit=20, $since_id=null, $max_id=null)
845 $stream = new RepeatsOfMeNoticeStream($this);
847 return $stream->getNotices($offset, $limit, $since_id, $max_id);
851 function repeatedToMe($offset=0, $limit=20, $since_id=null, $max_id=null)
853 // TRANS: Exception thrown when trying view "repeated to me".
854 throw new Exception(_('Not implemented since inbox change.'));
857 function shareLocation()
859 $cfg = common_config('location', 'share');
861 if ($cfg == 'always') {
863 } else if ($cfg == 'never') {
866 $share = common_config('location', 'sharedefault');
868 // Check if user has a personal setting for this
869 $prefs = User_location_prefs::getKV('user_id', $this->id);
871 if (!empty($prefs)) {
872 $share = $prefs->share_location;
880 static function siteOwner()
882 $owner = self::cacheGet('user:site_owner');
884 if ($owner === false) { // cache miss
886 $pr = new Profile_role();
888 $pr->role = Profile_role::OWNER;
890 $pr->orderBy('created');
894 if ($pr->find(true)) {
895 $owner = User::getKV('id', $pr->profile_id);
900 self::cacheSet('user:site_owner', $owner);
907 * Pull the primary site account to use in single-user mode.
908 * If a valid user nickname is listed in 'singleuser':'nickname'
909 * in the config, this will be used; otherwise the site owner
910 * account is taken by default.
913 * @throws ServerException if no valid single user account is present
914 * @throws ServerException if called when not in single-user mode
916 static function singleUser()
918 if (common_config('singleuser', 'enabled')) {
922 $nickname = common_config('singleuser', 'nickname');
924 if (!empty($nickname)) {
925 $user = User::getKV('nickname', $nickname);
928 // if there was no nickname or no user by that nickname,
929 // try the site owner.
932 $user = User::siteOwner();
938 // TRANS: Server exception.
939 throw new ServerException(_('No single user defined for single-user mode.'));
942 // TRANS: Server exception.
943 throw new ServerException(_('Single-user mode code called when not enabled.'));
948 * This is kind of a hack for using external setup code that's trying to
949 * build single-user sites.
951 * Will still return a username if the config singleuser/nickname is set
952 * even if the account doesn't exist, which normally indicates that the
953 * site is horribly misconfigured.
955 * At the moment, we need to let it through so that router setup can
956 * complete, otherwise we won't be able to create the account.
958 * This will be easier when we can more easily create the account and
959 * *then* switch the site to 1user mode without jumping through hoops.
962 * @throws ServerException if no valid single user account is present
963 * @throws ServerException if called when not in single-user mode
965 static function singleUserNickname()
968 $user = User::singleUser();
969 return $user->nickname;
970 } catch (Exception $e) {
971 if (common_config('singleuser', 'enabled') && common_config('singleuser', 'nickname')) {
972 common_log(LOG_WARNING, "Warning: code attempting to pull single-user nickname when the account does not exist. If this is not setup time, this is probably a bug.");
973 return common_config('singleuser', 'nickname');
980 * Find and shorten links in the given text using this user's URL shortening
983 * By default, links will be left untouched if the text is shorter than the
984 * configured maximum notice length. Pass true for the $always parameter
985 * to force all links to be shortened regardless.
987 * Side effects: may save file and file_redirection records for referenced URLs.
989 * @param string $text
990 * @param boolean $always
993 public function shortenLinks($text, $always=false)
995 return common_shorten_links($text, $always, $this);
999 * Get a list of OAuth client applications that have access to this
1002 function getConnectedApps($offset = 0, $limit = null)
1006 'FROM oauth_application_user u, oauth_application a ' .
1007 'WHERE u.profile_id = %d ' .
1008 'AND a.id = u.application_id ' .
1009 'AND u.access_type > 0 ' .
1010 'ORDER BY u.created DESC ';
1013 if (common_config('db','type') == 'pgsql') {
1014 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
1016 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
1020 $apps = new Oauth_application_user();
1022 $cnt = $apps->query(sprintf($qry, $this->id));
1028 * Magic function called at serialize() time.
1030 * We use this to drop a couple process-specific references
1031 * from DB_DataObject which can cause trouble in future
1034 * @return array of variable names to include in serialization.
1039 $vars = parent::__sleep();
1040 $skip = array('_profile');
1041 return array_diff($vars, $skip);
1044 static function recoverPassword($nore)
1046 $user = User::getKV('email', common_canonical_email($nore));
1050 $user = User::getKV('nickname', common_canonical_nickname($nore));
1051 } catch (NicknameException $e) {
1056 // See if it's an unconfirmed email address
1059 // Warning: it may actually be legit to have multiple folks
1060 // who have claimed, but not yet confirmed, the same address.
1061 // We'll only send to the first one that comes up.
1062 $confirm_email = new Confirm_address();
1063 $confirm_email->address = common_canonical_email($nore);
1064 $confirm_email->address_type = 'email';
1065 $confirm_email->find();
1066 if ($confirm_email->fetch()) {
1067 $user = User::getKV($confirm_email->user_id);
1069 $confirm_email = null;
1072 $confirm_email = null;
1076 // TRANS: Information on password recovery form if no known username or e-mail address was specified.
1077 throw new ClientException(_('No user with that email address or username.'));
1081 // Try to get an unconfirmed email address if they used a user name
1083 if (!$user->email && !$confirm_email) {
1084 $confirm_email = new Confirm_address();
1085 $confirm_email->user_id = $user->id;
1086 $confirm_email->address_type = 'email';
1087 $confirm_email->find();
1088 if (!$confirm_email->fetch()) {
1089 $confirm_email = null;
1093 if (!$user->email && !$confirm_email) {
1094 // TRANS: Client error displayed on password recovery form if a user does not have a registered e-mail address.
1095 throw new ClientException(_('No registered email address for that user.'));
1099 // Success! We have a valid user and a confirmed or unconfirmed email address
1101 $confirm = new Confirm_address();
1102 $confirm->code = common_confirmation_code(128);
1103 $confirm->address_type = 'recover';
1104 $confirm->user_id = $user->id;
1105 $confirm->address = (!empty($user->email)) ? $user->email : $confirm_email->address;
1107 if (!$confirm->insert()) {
1108 common_log_db_error($confirm, 'INSERT', __FILE__);
1109 // TRANS: Server error displayed if e-mail address confirmation fails in the database on the password recovery form.
1110 throw new ServerException(_('Error saving address confirmation.'));
1114 // @todo FIXME: needs i18n.
1115 $body = "Hey, $user->nickname.";
1117 $body .= 'Someone just asked for a new password ' .
1118 'for this account on ' . common_config('site', 'name') . '.';
1120 $body .= 'If it was you, and you want to confirm, use the URL below:';
1122 $body .= "\t".common_local_url('recoverpassword',
1123 array('code' => $confirm->code));
1125 $body .= 'If not, just ignore this message.';
1127 $body .= 'Thanks for your time, ';
1129 $body .= common_config('site', 'name');
1132 $headers = _mail_prepare_headers('recoverpassword', $user->nickname, $user->nickname);
1133 // TRANS: Subject for password recovery e-mail.
1134 mail_to_user($user, _('Password recovery requested'), $body, $headers, $confirm->address);
1137 function streamModeOnly()
1139 if (common_config('oldschool', 'enabled')) {
1140 $osp = Old_school_prefs::getKV('user_id', $this->id);
1142 return $osp->stream_mode_only;
1149 function conversationTree()
1151 if (common_config('oldschool', 'enabled')) {
1152 $osp = Old_school_prefs::getKV('user_id', $this->id);
1154 return $osp->conversation_tree;
1161 function streamNicknames()
1163 if (common_config('oldschool', 'enabled')) {
1164 $osp = Old_school_prefs::getKV('user_id', $this->id);
1166 return $osp->stream_nicknames;
1172 function registrationActivity()
1174 $profile = $this->getProfile();
1176 $service = new ActivityObject();
1178 $service->type = ActivityObject::SERVICE;
1179 $service->title = common_config('site', 'name');
1180 $service->link = common_root_url();
1181 $service->id = $service->link;
1183 $act = new Activity();
1185 $act->actor = ActivityObject::fromProfile($profile);
1186 $act->verb = ActivityVerb::JOIN;
1188 $act->objects[] = $service;
1190 $act->id = TagURI::mint('user:register:%d',
1193 $act->time = strtotime($this->created);
1195 $act->title = _("Register");
1197 $act->content = sprintf(_('%1$s joined %2$s.'),
1198 $profile->getBestName(),