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($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));
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()) {
479 $other = Profile::getKV('id', $invites->user_id);
480 if (!($other instanceof Profile)) { // remove when getKV throws exceptions
483 Subscription::start($other, $this->getProfile());
484 } catch (Exception $e) {
491 function hasFave($notice)
493 $profile = $this->getProfile();
494 return $profile->hasFave($notice);
497 function mutuallySubscribed($other)
499 $profile = $this->getProfile();
500 return $profile->mutuallySubscribed($other);
503 function mutuallySubscribedUsers()
505 // 3-way join; probably should get cached
506 $UT = common_config('db','type')=='pgsql'?'"user"':'user';
507 $qry = "SELECT $UT.* " .
508 "FROM subscription sub1 JOIN $UT ON sub1.subscribed = $UT.id " .
509 "JOIN subscription sub2 ON $UT.id = sub2.subscriber " .
510 'WHERE sub1.subscriber = %d and sub2.subscribed = %d ' .
511 "ORDER BY $UT.nickname";
513 $user->query(sprintf($qry, $this->id, $this->id));
518 function getReplies($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
520 return Reply::stream($this->id, $offset, $limit, $since_id, $before_id);
523 function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0) {
524 $profile = $this->getProfile();
525 return $profile->getTaggedNotices($tag, $offset, $limit, $since_id, $before_id);
528 function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
530 $profile = $this->getProfile();
531 return $profile->getNotices($offset, $limit, $since_id, $before_id);
534 function favoriteNotices($own=false, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
536 return Fave::stream($this->id, $offset, $limit, $own, $since_id, $max_id);
539 function noticeInbox($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
541 $stream = new InboxNoticeStream($this);
542 return $stream->getNotices($offset, $limit, $since_id, $before_id);
545 // DEPRECATED, use noticeInbox()
547 function noticesWithFriends($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 noticesWithFriendsThreaded($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 noticeInboxThreaded($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 friendsTimeline($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
570 return $this->noticeInbox($offset, $limit, $since_id, $before_id);
573 // DEPRECATED, use noticeInbox()
575 function ownFriendsTimeline($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
577 $this->noticeInbox($offset, $limit, $since_id, $before_id);
580 function blowFavesCache()
582 $profile = $this->getProfile();
583 $profile->blowFavesCache();
586 function getSelfTags()
588 return Profile_tag::getTagsArray($this->id, $this->id, $this->id);
591 function setSelfTags($newtags, $privacy)
593 return Profile_tag::setTags($this->id, $this->id, $newtags, $privacy);
596 function block(Profile $other)
598 // Add a new block record
600 // no blocking (and thus unsubbing from) yourself
602 if ($this->id == $other->id) {
603 common_log(LOG_WARNING,
605 "Profile ID %d (%s) tried to block themself.",
613 $block = new Profile_block();
615 // Begin a transaction
617 $block->query('BEGIN');
619 $block->blocker = $this->id;
620 $block->blocked = $other->id;
622 $result = $block->insert();
625 common_log_db_error($block, 'INSERT', __FILE__);
629 $self = $this->getProfile();
630 if (Subscription::exists($other, $self)) {
631 Subscription::cancel($other, $self);
633 if (Subscription::exists($self, $other)) {
634 Subscription::cancel($self, $other);
637 $block->query('COMMIT');
642 function unblock(Profile $other)
644 // Get the block record
646 $block = Profile_block::exists($this->getProfile(), $other);
652 $result = $block->delete();
655 common_log_db_error($block, 'DELETE', __FILE__);
662 function isMember($group)
664 $profile = $this->getProfile();
665 return $profile->isMember($group);
668 function isAdmin($group)
670 $profile = $this->getProfile();
671 return $profile->isAdmin($group);
674 function getGroups($offset=0, $limit=null)
676 $profile = $this->getProfile();
677 return $profile->getGroups($offset, $limit);
681 * Request to join the given group.
682 * May throw exceptions on failure.
684 * @param User_group $group
685 * @return Group_member
687 function joinGroup(User_group $group)
689 $profile = $this->getProfile();
690 return $profile->joinGroup($group);
694 * Leave a group that this user is a member of.
696 * @param User_group $group
698 function leaveGroup(User_group $group)
700 $profile = $this->getProfile();
701 return $profile->leaveGroup($group);
704 function getSubscribed($offset=0, $limit=null)
706 $profile = $this->getProfile();
707 return $profile->getSubscribed($offset, $limit);
710 function getSubscribers($offset=0, $limit=null)
712 $profile = $this->getProfile();
713 return $profile->getSubscribers($offset, $limit);
716 function getTaggedSubscribers($tag, $offset=0, $limit=null)
719 'SELECT profile.* ' .
720 'FROM profile JOIN subscription ' .
721 'ON profile.id = subscription.subscriber ' .
722 'JOIN profile_tag ON (profile_tag.tagged = subscription.subscriber ' .
723 'AND profile_tag.tagger = subscription.subscribed) ' .
724 'WHERE subscription.subscribed = %d ' .
725 "AND profile_tag.tag = '%s' " .
726 'AND subscription.subscribed != subscription.subscriber ' .
727 'ORDER BY subscription.created DESC ';
730 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
733 $profile = new Profile();
735 $cnt = $profile->query(sprintf($qry, $this->id, $profile->escape($tag)));
740 function getTaggedSubscriptions($tag, $offset=0, $limit=null)
743 'SELECT profile.* ' .
744 'FROM profile JOIN subscription ' .
745 'ON profile.id = subscription.subscribed ' .
746 'JOIN profile_tag on (profile_tag.tagged = subscription.subscribed ' .
747 'AND profile_tag.tagger = subscription.subscriber) ' .
748 'WHERE subscription.subscriber = %d ' .
749 "AND profile_tag.tag = '%s' " .
750 'AND subscription.subscribed != subscription.subscriber ' .
751 'ORDER BY subscription.created DESC ';
753 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
755 $profile = new Profile();
757 $profile->query(sprintf($qry, $this->id, $profile->escape($tag)));
762 function hasRight($right)
764 $profile = $this->getProfile();
765 return $profile->hasRight($right);
771 $profile = $this->getProfile();
773 } catch (UserNoProfileException $unp) {
774 common_log(LOG_INFO, "User {$this->nickname} has no profile; continuing deletion.");
777 $related = array('Fave',
784 Event::handle('UserDeleteRelated', array($this, &$related));
786 foreach ($related as $cls) {
788 $inst->user_id = $this->id;
792 $this->_deleteTags();
793 $this->_deleteBlocks();
798 function _deleteTags()
800 $tag = new Profile_tag();
801 $tag->tagger = $this->id;
805 function _deleteBlocks()
807 $block = new Profile_block();
808 $block->blocker = $this->id;
810 // XXX delete group block? Reset blocker?
813 function hasRole($name)
815 $profile = $this->getProfile();
816 return $profile->hasRole($name);
819 function grantRole($name)
821 $profile = $this->getProfile();
822 return $profile->grantRole($name);
825 function revokeRole($name)
827 $profile = $this->getProfile();
828 return $profile->revokeRole($name);
831 function isSandboxed()
833 $profile = $this->getProfile();
834 return $profile->isSandboxed();
837 function isSilenced()
839 $profile = $this->getProfile();
840 return $profile->isSilenced();
843 function repeatedByMe($offset=0, $limit=20, $since_id=null, $max_id=null)
845 $stream = new RepeatedByMeNoticeStream($this);
846 return $stream->getNotices($offset, $limit, $since_id, $max_id);
850 function repeatsOfMe($offset=0, $limit=20, $since_id=null, $max_id=null)
852 $stream = new RepeatsOfMeNoticeStream($this);
854 return $stream->getNotices($offset, $limit, $since_id, $max_id);
858 function repeatedToMe($offset=0, $limit=20, $since_id=null, $max_id=null)
860 // TRANS: Exception thrown when trying view "repeated to me".
861 throw new Exception(_('Not implemented since inbox change.'));
864 function shareLocation()
866 $cfg = common_config('location', 'share');
868 if ($cfg == 'always') {
870 } else if ($cfg == 'never') {
873 $share = common_config('location', 'sharedefault');
875 // Check if user has a personal setting for this
876 $prefs = User_location_prefs::getKV('user_id', $this->id);
878 if (!empty($prefs)) {
879 $share = $prefs->share_location;
887 static function siteOwner()
889 $owner = self::cacheGet('user:site_owner');
891 if ($owner === false) { // cache miss
893 $pr = new Profile_role();
895 $pr->role = Profile_role::OWNER;
897 $pr->orderBy('created');
901 if ($pr->find(true)) {
902 $owner = User::getKV('id', $pr->profile_id);
907 self::cacheSet('user:site_owner', $owner);
914 * Pull the primary site account to use in single-user mode.
915 * If a valid user nickname is listed in 'singleuser':'nickname'
916 * in the config, this will be used; otherwise the site owner
917 * account is taken by default.
920 * @throws ServerException if no valid single user account is present
921 * @throws ServerException if called when not in single-user mode
923 static function singleUser()
925 if (common_config('singleuser', 'enabled')) {
929 $nickname = common_config('singleuser', 'nickname');
931 if (!empty($nickname)) {
932 $user = User::getKV('nickname', $nickname);
935 // if there was no nickname or no user by that nickname,
936 // try the site owner.
939 $user = User::siteOwner();
945 // TRANS: Server exception.
946 throw new ServerException(_('No single user defined for single-user mode.'));
949 // TRANS: Server exception.
950 throw new ServerException(_('Single-user mode code called when not enabled.'));
955 * This is kind of a hack for using external setup code that's trying to
956 * build single-user sites.
958 * Will still return a username if the config singleuser/nickname is set
959 * even if the account doesn't exist, which normally indicates that the
960 * site is horribly misconfigured.
962 * At the moment, we need to let it through so that router setup can
963 * complete, otherwise we won't be able to create the account.
965 * This will be easier when we can more easily create the account and
966 * *then* switch the site to 1user mode without jumping through hoops.
969 * @throws ServerException if no valid single user account is present
970 * @throws ServerException if called when not in single-user mode
972 static function singleUserNickname()
975 $user = User::singleUser();
976 return $user->nickname;
977 } catch (Exception $e) {
978 if (common_config('singleuser', 'enabled') && common_config('singleuser', 'nickname')) {
979 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.");
980 return common_config('singleuser', 'nickname');
987 * Find and shorten links in the given text using this user's URL shortening
990 * By default, links will be left untouched if the text is shorter than the
991 * configured maximum notice length. Pass true for the $always parameter
992 * to force all links to be shortened regardless.
994 * Side effects: may save file and file_redirection records for referenced URLs.
996 * @param string $text
997 * @param boolean $always
1000 public function shortenLinks($text, $always=false)
1002 return common_shorten_links($text, $always, $this);
1006 * Get a list of OAuth client applications that have access to this
1009 function getConnectedApps($offset = 0, $limit = null)
1013 'FROM oauth_application_user u, oauth_application a ' .
1014 'WHERE u.profile_id = %d ' .
1015 'AND a.id = u.application_id ' .
1016 'AND u.access_type > 0 ' .
1017 'ORDER BY u.created DESC ';
1020 if (common_config('db','type') == 'pgsql') {
1021 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
1023 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
1027 $apps = new Oauth_application_user();
1029 $cnt = $apps->query(sprintf($qry, $this->id));
1035 * Magic function called at serialize() time.
1037 * We use this to drop a couple process-specific references
1038 * from DB_DataObject which can cause trouble in future
1041 * @return array of variable names to include in serialization.
1046 $vars = parent::__sleep();
1047 $skip = array('_profile');
1048 return array_diff($vars, $skip);
1051 static function recoverPassword($nore)
1053 $user = User::getKV('email', common_canonical_email($nore));
1057 $user = User::getKV('nickname', common_canonical_nickname($nore));
1058 } catch (NicknameException $e) {
1063 // See if it's an unconfirmed email address
1066 // Warning: it may actually be legit to have multiple folks
1067 // who have claimed, but not yet confirmed, the same address.
1068 // We'll only send to the first one that comes up.
1069 $confirm_email = new Confirm_address();
1070 $confirm_email->address = common_canonical_email($nore);
1071 $confirm_email->address_type = 'email';
1072 $confirm_email->find();
1073 if ($confirm_email->fetch()) {
1074 $user = User::getKV($confirm_email->user_id);
1076 $confirm_email = null;
1079 $confirm_email = null;
1083 // TRANS: Information on password recovery form if no known username or e-mail address was specified.
1084 throw new ClientException(_('No user with that email address or username.'));
1088 // Try to get an unconfirmed email address if they used a user name
1090 if (!$user->email && !$confirm_email) {
1091 $confirm_email = new Confirm_address();
1092 $confirm_email->user_id = $user->id;
1093 $confirm_email->address_type = 'email';
1094 $confirm_email->find();
1095 if (!$confirm_email->fetch()) {
1096 $confirm_email = null;
1100 if (!$user->email && !$confirm_email) {
1101 // TRANS: Client error displayed on password recovery form if a user does not have a registered e-mail address.
1102 throw new ClientException(_('No registered email address for that user.'));
1106 // Success! We have a valid user and a confirmed or unconfirmed email address
1108 $confirm = new Confirm_address();
1109 $confirm->code = common_confirmation_code(128);
1110 $confirm->address_type = 'recover';
1111 $confirm->user_id = $user->id;
1112 $confirm->address = (!empty($user->email)) ? $user->email : $confirm_email->address;
1114 if (!$confirm->insert()) {
1115 common_log_db_error($confirm, 'INSERT', __FILE__);
1116 // TRANS: Server error displayed if e-mail address confirmation fails in the database on the password recovery form.
1117 throw new ServerException(_('Error saving address confirmation.'));
1121 // @todo FIXME: needs i18n.
1122 $body = "Hey, $user->nickname.";
1124 $body .= 'Someone just asked for a new password ' .
1125 'for this account on ' . common_config('site', 'name') . '.';
1127 $body .= 'If it was you, and you want to confirm, use the URL below:';
1129 $body .= "\t".common_local_url('recoverpassword',
1130 array('code' => $confirm->code));
1132 $body .= 'If not, just ignore this message.';
1134 $body .= 'Thanks for your time, ';
1136 $body .= common_config('site', 'name');
1139 $headers = _mail_prepare_headers('recoverpassword', $user->nickname, $user->nickname);
1140 // TRANS: Subject for password recovery e-mail.
1141 mail_to_user($user, _('Password recovery requested'), $body, $headers, $confirm->address);
1144 function streamModeOnly()
1146 if (common_config('oldschool', 'enabled')) {
1147 $osp = Old_school_prefs::getKV('user_id', $this->id);
1149 return $osp->stream_mode_only;
1156 function conversationTree()
1158 if (common_config('oldschool', 'enabled')) {
1159 $osp = Old_school_prefs::getKV('user_id', $this->id);
1161 return $osp->conversation_tree;
1168 function streamNicknames()
1170 if (common_config('oldschool', 'enabled')) {
1171 $osp = Old_school_prefs::getKV('user_id', $this->id);
1173 return $osp->stream_nicknames;
1179 function registrationActivity()
1181 $profile = $this->getProfile();
1183 $service = new ActivityObject();
1185 $service->type = ActivityObject::SERVICE;
1186 $service->title = common_config('site', 'name');
1187 $service->link = common_root_url();
1188 $service->id = $service->link;
1190 $act = new Activity();
1192 $act->actor = ActivityObject::fromProfile($profile);
1193 $act->verb = ActivityVerb::JOIN;
1195 $act->objects[] = $service;
1197 $act->id = TagURI::mint('user:register:%d',
1200 $act->time = strtotime($this->created);
1202 $act->title = _("Register");
1204 $act->content = sprintf(_('%1$s joined %2$s.'),
1205 $profile->getBestName(),