]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - classes/User.php
Converted all ActivityObject::fromProfile to $profile->asActivityObject
[quix0rs-gnu-social.git] / classes / User.php
1 <?php
2 /*
3  * StatusNet - the distributed open-source microblogging tool
4  * Copyright (C) 2008, 2009, StatusNet, Inc.
5  *
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.
10  *
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.
15  *
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/>.
18  */
19
20 if (!defined('GNUSOCIAL')) { exit(1); }
21
22 /**
23  * Table Definition for user
24  */
25
26 class User extends Managed_DataObject
27 {
28     const SUBSCRIBE_POLICY_OPEN = 0;
29     const SUBSCRIBE_POLICY_MODERATE = 1;
30
31     ###START_AUTOCODE
32     /* the code below is auto generated do not remove the above tag */
33
34     public $__table = 'user';                            // table name
35     public $id;                              // int(4)  primary_key not_null
36     public $nickname;                        // varchar(64)  unique_key
37     public $password;                        // varchar(255)
38     public $email;                           // varchar(255)  unique_key
39     public $incomingemail;                   // varchar(255)  unique_key
40     public $emailnotifysub;                  // tinyint(1)   default_1
41     public $emailnotifyfav;                  // tinyint(1)   default_1
42     public $emailnotifynudge;                // tinyint(1)   default_1
43     public $emailnotifymsg;                  // tinyint(1)   default_1
44     public $emailnotifyattn;                 // tinyint(1)   default_1
45     public $emailmicroid;                    // tinyint(1)   default_1
46     public $language;                        // varchar(50)
47     public $timezone;                        // varchar(50)
48     public $emailpost;                       // tinyint(1)   default_1
49     public $sms;                             // varchar(64)  unique_key
50     public $carrier;                         // int(4)
51     public $smsnotify;                       // tinyint(1)
52     public $smsreplies;                      // tinyint(1)
53     public $smsemail;                        // varchar(255)
54     public $uri;                             // varchar(255)  unique_key
55     public $autosubscribe;                   // tinyint(1)
56     public $subscribe_policy;                // tinyint(1)
57     public $urlshorteningservice;            // varchar(50)   default_ur1.ca
58     public $private_stream;                  // tinyint(1)   default_0
59     public $created;                         // datetime()   not_null
60     public $modified;                        // timestamp()   not_null default_CURRENT_TIMESTAMP
61
62     /* the code above is auto generated do not remove the tag below */
63     ###END_AUTOCODE
64
65     public static function schemaDef()
66     {
67         return array(
68             'description' => 'local users',
69             'fields' => array(
70                 'id' => array('type' => 'int', 'not null' => true, 'description' => 'foreign key to profile table'),
71                 'nickname' => array('type' => 'varchar', 'length' => 64, 'description' => 'nickname or username, duped in profile'),
72                 'password' => array('type' => 'varchar', 'length' => 255, 'description' => 'salted password, can be null for OpenID users'),
73                 'email' => array('type' => 'varchar', 'length' => 255, 'description' => 'email address for password recovery etc.'),
74                 'incomingemail' => array('type' => 'varchar', 'length' => 255, 'description' => 'email address for post-by-email'),
75                 'emailnotifysub' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of subscriptions'),
76                 'emailnotifyfav' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of favorites'),
77                 'emailnotifynudge' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of nudges'),
78                 'emailnotifymsg' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of direct messages'),
79                 'emailnotifyattn' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of @-replies'),
80                 'emailmicroid' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'whether to publish email microid'),
81                 'language' => array('type' => 'varchar', 'length' => 50, 'description' => 'preferred language'),
82                 'timezone' => array('type' => 'varchar', 'length' => 50, 'description' => 'timezone'),
83                 'emailpost' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Post by email'),
84                 'sms' => array('type' => 'varchar', 'length' => 64, 'description' => 'sms phone number'),
85                 'carrier' => array('type' => 'int', 'description' => 'foreign key to sms_carrier'),
86                 'smsnotify' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'whether to send notices to SMS'),
87                 'smsreplies' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'whether to send notices to SMS on replies'),
88                 'smsemail' => array('type' => 'varchar', 'length' => 255, 'description' => 'built from sms and carrier'),
89                 'uri' => array('type' => 'varchar', 'length' => 255, 'description' => 'universally unique identifier, usually a tag URI'),
90                 'autosubscribe' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'automatically subscribe to users who subscribe to us'),
91                 'subscribe_policy' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => '0 = anybody can subscribe; 1 = require approval'),
92                 'urlshorteningservice' => array('type' => 'varchar', 'length' => 50, 'default' => 'internal', 'description' => 'service to use for auto-shortening URLs'),
93                 'private_stream' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'whether to limit all notices to followers only'),
94
95                 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'),
96                 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
97             ),
98             'primary key' => array('id'),
99             'unique keys' => array(
100                 'user_nickname_key' => array('nickname'),
101                 'user_email_key' => array('email'),
102                 'user_incomingemail_key' => array('incomingemail'),
103                 'user_sms_key' => array('sms'),
104                 'user_uri_key' => array('uri'),
105             ),
106             'foreign keys' => array(
107                 'user_id_fkey' => array('profile', array('id' => 'id')),
108                 'user_carrier_fkey' => array('sms_carrier', array('carrier' => 'id')),
109             ),
110             'indexes' => array(
111                 'user_smsemail_idx' => array('smsemail'),
112             ),
113         );
114     }
115
116     protected $_profile = array();
117
118     /**
119      * @return Profile
120      *
121      * @throws UserNoProfileException if user has no profile
122      */
123     public function getProfile()
124     {
125         if (!isset($this->_profile[$this->id])) {
126             $profile = Profile::getKV('id', $this->id);
127             if (!$profile instanceof Profile) {
128                 throw new UserNoProfileException($this);
129             }
130             $this->_profile[$this->id] = $profile;
131         }
132         return $this->_profile[$this->id];
133     }
134
135     public function getUri()
136     {
137         return $this->uri;
138     }
139
140     public function getNickname()
141     {
142         return $this->getProfile()->getNickname();
143     }
144
145     function isSubscribed(Profile $other)
146     {
147         return $this->getProfile()->isSubscribed($other);
148     }
149
150     function hasPendingSubscription(Profile $other)
151     {
152         return $this->getProfile()->hasPendingSubscription($other);
153     }
154
155     // 'update' won't write key columns, so we have to do it ourselves.
156
157     function updateKeys(&$orig)
158     {
159         $this->_connect();
160         $parts = array();
161         foreach (array('nickname', 'email', 'incomingemail', 'sms', 'carrier', 'smsemail') as $k) {
162             if (strcmp($this->$k, $orig->$k) != 0) {
163                 $parts[] = $k . ' = ' . $this->_quote($this->$k);
164             }
165         }
166         if (count($parts) == 0) {
167             // No changes
168             return true;
169         }
170         $toupdate = implode(', ', $parts);
171
172         $table = common_database_tablename($this->tableName());
173         $qry = 'UPDATE ' . $table . ' SET ' . $toupdate .
174           ' WHERE id = ' . $this->id;
175         $orig->decache();
176         $result = $this->query($qry);
177         if ($result) {
178             $this->encache();
179         }
180         return $result;
181     }
182
183     /**
184      * Get the most recent notice posted by this user, if any.
185      *
186      * @return mixed Notice or null
187      */
188     function getCurrentNotice()
189     {
190         return $this->getProfile()->getCurrentNotice();
191     }
192
193     function getCarrier()
194     {
195         return Sms_carrier::getKV('id', $this->carrier);
196     }
197
198     function hasBlocked($other)
199     {
200         return $this->getProfile()->hasBlocked($other);
201     }
202
203     /**
204      * Register a new user account and profile and set up default subscriptions.
205      * If a new-user welcome message is configured, this will be sent.
206      *
207      * @param array $fields associative array of optional properties
208      *              string 'bio'
209      *              string 'email'
210      *              bool 'email_confirmed' pass true to mark email as pre-confirmed
211      *              string 'fullname'
212      *              string 'homepage'
213      *              string 'location' informal string description of geolocation
214      *              float 'lat' decimal latitude for geolocation
215      *              float 'lon' decimal longitude for geolocation
216      *              int 'location_id' geoname identifier
217      *              int 'location_ns' geoname namespace to interpret location_id
218      *              string 'nickname' REQUIRED
219      *              string 'password' (may be missing for eg OpenID registrations)
220      *              string 'code' invite code
221      *              ?string 'uri' permalink to notice; defaults to local notice URL
222      * @return mixed User object or false on failure
223      */
224     static function register(array $fields) {
225
226         // MAGICALLY put fields into current scope
227
228         extract($fields);
229
230         $profile = new Profile();
231
232         if (!empty($email)) {
233             $email = common_canonical_email($email);
234         }
235
236         try {
237             $profile->nickname = Nickname::normalize($nickname, true);
238         } catch (NicknameException $e) {
239             common_log(LOG_WARNING, sprintf('Bad nickname during User registration for %s: %s', $nickname, $e->getMessage()), __FILE__);
240             return false;
241         }
242
243         $profile->profileurl = common_profile_url($profile->nickname);
244
245         if (!empty($fullname)) {
246             $profile->fullname = $fullname;
247         }
248         if (!empty($homepage)) {
249             $profile->homepage = $homepage;
250         }
251         if (!empty($bio)) {
252             $profile->bio = $bio;
253         }
254         if (!empty($location)) {
255             $profile->location = $location;
256
257             $loc = Location::fromName($location);
258
259             if (!empty($loc)) {
260                 $profile->lat         = $loc->lat;
261                 $profile->lon         = $loc->lon;
262                 $profile->location_id = $loc->location_id;
263                 $profile->location_ns = $loc->location_ns;
264             }
265         }
266
267         $profile->created = common_sql_now();
268
269         $user = new User();
270
271         $user->nickname = $profile->nickname;
272
273         $invite = null;
274
275         // Users who respond to invite email have proven their ownership of that address
276
277         if (!empty($code)) {
278             $invite = Invitation::getKV($code);
279             if ($invite && $invite->address && $invite->address_type == 'email' && $invite->address == $email) {
280                 $user->email = $invite->address;
281             }
282         }
283
284         if(isset($email_confirmed) && $email_confirmed) {
285             $user->email = $email;
286         }
287
288         // Set default-on options here, otherwise they'll be disabled
289         // initially for sites using caching, since the initial encache
290         // doesn't know about the defaults in the database.
291         $user->emailnotifysub = 1;
292         $user->emailnotifyfav = 1;
293         $user->emailnotifynudge = 1;
294         $user->emailnotifymsg = 1;
295         $user->emailnotifyattn = 1;
296         $user->emailmicroid = 1;
297         $user->emailpost = 1;
298         $user->jabbermicroid = 1;
299
300         $user->created = common_sql_now();
301
302         if (Event::handle('StartUserRegister', array($profile))) {
303
304             $profile->query('BEGIN');
305
306             $id = $profile->insert();
307             if ($id === false) {
308                 common_log_db_error($profile, 'INSERT', __FILE__);
309                 return false;
310             }
311
312             $user->id = $id;
313
314             if (!empty($uri)) {
315                 $user->uri = $uri;
316             } else {
317                 $user->uri = common_user_uri($user);
318             }
319
320             if (!empty($password)) { // may not have a password for OpenID users
321                 $user->password = common_munge_password($password, $id);
322             }
323
324             $result = $user->insert();
325
326             if ($result === false) {
327                 common_log_db_error($user, 'INSERT', __FILE__);
328                 $profile->query('ROLLBACK');
329                 return false;
330             }
331
332             // Everyone is subscribed to themself
333
334             $subscription = new Subscription();
335             $subscription->subscriber = $user->id;
336             $subscription->subscribed = $user->id;
337             $subscription->created = $user->created;
338
339             $result = $subscription->insert();
340
341             if (!$result) {
342                 common_log_db_error($subscription, 'INSERT', __FILE__);
343                 $profile->query('ROLLBACK');
344                 return false;
345             }
346
347             // Mark that this invite was converted
348
349             if (!empty($invite)) {
350                 $invite->convert($user);
351             }
352
353             if (!empty($email) && !$user->email) {
354
355                 $confirm = new Confirm_address();
356                 $confirm->code = common_confirmation_code(128);
357                 $confirm->user_id = $user->id;
358                 $confirm->address = $email;
359                 $confirm->address_type = 'email';
360
361                 $result = $confirm->insert();
362
363                 if (!$result) {
364                     common_log_db_error($confirm, 'INSERT', __FILE__);
365                     $profile->query('ROLLBACK');
366                     return false;
367                 }
368             }
369
370             if (!empty($code) && $user->email) {
371                 $user->emailChanged();
372             }
373
374             // Default system subscription
375
376             $defnick = common_config('newuser', 'default');
377
378             if (!empty($defnick)) {
379                 $defuser = User::getKV('nickname', $defnick);
380                 if (empty($defuser)) {
381                     common_log(LOG_WARNING, sprintf("Default user %s does not exist.", $defnick),
382                                __FILE__);
383                 } else {
384                     Subscription::start($profile, $defuser->getProfile());
385                 }
386             }
387
388             $profile->query('COMMIT');
389
390             if (!empty($email) && !$user->email) {
391                 mail_confirm_address($user, $confirm->code, $profile->nickname, $email);
392             }
393
394             // Welcome message
395
396             $welcome = common_config('newuser', 'welcome');
397
398             if (!empty($welcome)) {
399                 $welcomeuser = User::getKV('nickname', $welcome);
400                 if (empty($welcomeuser)) {
401                     common_log(LOG_WARNING, sprintf("Welcome user %s does not exist.", $defnick),
402                                __FILE__);
403                 } else {
404                     $notice = Notice::saveNew($welcomeuser->id,
405                                               // TRANS: Notice given on user registration.
406                                               // TRANS: %1$s is the sitename, $2$s is the registering user's nickname.
407                                               sprintf(_('Welcome to %1$s, @%2$s!'),
408                                                       common_config('site', 'name'),
409                                                       $user->nickname),
410                                               'system');
411                 }
412             }
413
414             Event::handle('EndUserRegister', array($profile));
415         }
416
417         return $user;
418     }
419
420     // Things we do when the email changes
421     function emailChanged()
422     {
423
424         $invites = new Invitation();
425         $invites->address = $this->email;
426         $invites->address_type = 'email';
427
428         if ($invites->find()) {
429             while ($invites->fetch()) {
430                 try {
431                     $other = Profile::getKV('id', $invites->user_id);
432                     if (!($other instanceof Profile)) {    // remove when getKV throws exceptions
433                         continue;
434                     }
435                     Subscription::start($other, $this->getProfile());
436                 } catch (Exception $e) {
437                     continue;
438                 }
439             }
440         }
441     }
442
443     function mutuallySubscribed(Profile $other)
444     {
445         return $this->getProfile()->mutuallySubscribed($other);
446     }
447
448     function mutuallySubscribedUsers()
449     {
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";
457         $user = new User();
458         $user->query(sprintf($qry, $this->id, $this->id));
459
460         return $user;
461     }
462
463     function getReplies($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
464     {
465         return Reply::stream($this->id, $offset, $limit, $since_id, $before_id);
466     }
467
468     function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0) {
469         return $this->getProfile()->getTaggedNotices($tag, $offset, $limit, $since_id, $before_id);
470     }
471
472     function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
473     {
474         return $this->getProfile()->getNotices($offset, $limit, $since_id, $before_id);
475     }
476
477     function getSelfTags()
478     {
479         return Profile_tag::getTagsArray($this->id, $this->id, $this->id);
480     }
481
482     function setSelfTags($newtags, $privacy)
483     {
484         return Profile_tag::setTags($this->id, $this->id, $newtags, $privacy);
485     }
486
487     function block(Profile $other)
488     {
489         // Add a new block record
490
491         // no blocking (and thus unsubbing from) yourself
492
493         if ($this->id == $other->id) {
494             common_log(LOG_WARNING,
495                 sprintf(
496                     "Profile ID %d (%s) tried to block themself.",
497                     $this->id,
498                     $this->nickname
499                 )
500             );
501             return false;
502         }
503
504         $block = new Profile_block();
505
506         // Begin a transaction
507
508         $block->query('BEGIN');
509
510         $block->blocker = $this->id;
511         $block->blocked = $other->id;
512
513         $result = $block->insert();
514
515         if (!$result) {
516             common_log_db_error($block, 'INSERT', __FILE__);
517             return false;
518         }
519
520         $self = $this->getProfile();
521         if (Subscription::exists($other, $self)) {
522             Subscription::cancel($other, $self);
523         }
524         if (Subscription::exists($self, $other)) {
525             Subscription::cancel($self, $other);
526         }
527
528         $block->query('COMMIT');
529
530         return true;
531     }
532
533     function unblock(Profile $other)
534     {
535         // Get the block record
536
537         $block = Profile_block::exists($this->getProfile(), $other);
538
539         if (!$block) {
540             return false;
541         }
542
543         $result = $block->delete();
544
545         if (!$result) {
546             common_log_db_error($block, 'DELETE', __FILE__);
547             return false;
548         }
549
550         return true;
551     }
552
553     function isMember(User_group $group)
554     {
555         return $this->getProfile()->isMember($group);
556     }
557
558     function isAdmin(User_group $group)
559     {
560         return $this->getProfile()->isAdmin($group);
561     }
562
563     function getGroups($offset=0, $limit=null)
564     {
565         return $this->getProfile()->getGroups($offset, $limit);
566     }
567
568     /**
569      * Request to join the given group.
570      * May throw exceptions on failure.
571      *
572      * @param User_group $group
573      * @return Group_member
574      */
575     function joinGroup(User_group $group)
576     {
577         return $this->getProfile()->joinGroup($group);
578     }
579
580     /**
581      * Leave a group that this user is a member of.
582      *
583      * @param User_group $group
584      */
585     function leaveGroup(User_group $group)
586     {
587         return $this->getProfile()->leaveGroup($group);
588     }
589
590     function getSubscribed($offset=0, $limit=null)
591     {
592         return $this->getProfile()->getSubscribed($offset, $limit);
593     }
594
595     function getSubscribers($offset=0, $limit=null)
596     {
597         return $this->getProfile()->getSubscribers($offset, $limit);
598     }
599
600     function getTaggedSubscribers($tag, $offset=0, $limit=null)
601     {
602         return $this->getProfile()->getTaggedSubscribers($tag, $offset, $limit);
603     }
604
605     function getTaggedSubscriptions($tag, $offset=0, $limit=null)
606     {
607         return $this->getProfile()->getTaggedSubscriptions($tag, $offset, $limit);
608     }
609
610     function hasRight($right)
611     {
612         return $this->getProfile()->hasRight($right);
613     }
614
615     function delete($useWhere=false)
616     {
617         if (empty($this->id)) {
618             common_log(LOG_WARNING, "Ambiguous User->delete(); skipping related tables.");
619             return parent::delete($useWhere);
620         }
621
622         try {
623             $profile = $this->getProfile();
624             $profile->delete();
625         } catch (UserNoProfileException $unp) {
626             common_log(LOG_INFO, "User {$this->nickname} has no profile; continuing deletion.");
627         }
628
629         $related = array(
630                          'Confirm_address',
631                          'Remember_me',
632                          'Foreign_link',
633                          'Invitation',
634                          );
635
636         Event::handle('UserDeleteRelated', array($this, &$related));
637
638         foreach ($related as $cls) {
639             $inst = new $cls();
640             $inst->user_id = $this->id;
641             $inst->delete();
642         }
643
644         $this->_deleteTags();
645         $this->_deleteBlocks();
646
647         return parent::delete($useWhere);
648     }
649
650     function _deleteTags()
651     {
652         $tag = new Profile_tag();
653         $tag->tagger = $this->id;
654         $tag->delete();
655     }
656
657     function _deleteBlocks()
658     {
659         $block = new Profile_block();
660         $block->blocker = $this->id;
661         $block->delete();
662         // XXX delete group block? Reset blocker?
663     }
664
665     function hasRole($name)
666     {
667         return $this->getProfile()->hasRole($name);
668     }
669
670     function grantRole($name)
671     {
672         return $this->getProfile()->grantRole($name);
673     }
674
675     function revokeRole($name)
676     {
677         return $this->getProfile()->revokeRole($name);
678     }
679
680     function isSandboxed()
681     {
682         return $this->getProfile()->isSandboxed();
683     }
684
685     function isSilenced()
686     {
687         return $this->getProfile()->isSilenced();
688     }
689
690     function repeatedByMe($offset=0, $limit=20, $since_id=null, $max_id=null)
691     {
692         $stream = new RepeatedByMeNoticeStream($this);
693         return $stream->getNotices($offset, $limit, $since_id, $max_id);
694     }
695
696
697     function repeatsOfMe($offset=0, $limit=20, $since_id=null, $max_id=null)
698     {
699         $stream = new RepeatsOfMeNoticeStream($this);
700
701         return $stream->getNotices($offset, $limit, $since_id, $max_id);
702     }
703
704
705     function repeatedToMe($offset=0, $limit=20, $since_id=null, $max_id=null)
706     {
707         // TRANS: Exception thrown when trying view "repeated to me".
708         throw new Exception(_('Not implemented since inbox change.'));
709     }
710
711     public static function siteOwner()
712     {
713         $owner = self::cacheGet('user:site_owner');
714
715         if ($owner === false) { // cache miss
716
717             $pr = new Profile_role();
718             $pr->role = Profile_role::OWNER;
719             $pr->orderBy('created');
720             $pr->limit(1);
721
722             if (!$pr->find(true)) {
723                 throw new NoResultException($pr);
724             }
725
726             $owner = User::getKV('id', $pr->profile_id);
727
728             self::cacheSet('user:site_owner', $owner);
729         }
730
731         if ($owner instanceof User) {
732             return $owner;
733         }
734
735         throw new ServerException(_('No site owner configured.'));
736     }
737
738     /**
739      * Pull the primary site account to use in single-user mode.
740      * If a valid user nickname is listed in 'singleuser':'nickname'
741      * in the config, this will be used; otherwise the site owner
742      * account is taken by default.
743      *
744      * @return User
745      * @throws ServerException if no valid single user account is present
746      * @throws ServerException if called when not in single-user mode
747      */
748     public static function singleUser()
749     {
750         if (!common_config('singleuser', 'enabled')) {
751             // TRANS: Server exception.
752             throw new ServerException(_('Single-user mode code called when not enabled.'));
753         }
754
755         if ($nickname = common_config('singleuser', 'nickname')) {
756             $user = User::getKV('nickname', $nickname);
757             if ($user instanceof User) {
758                 return $user;
759             }
760         }
761
762         // If there was no nickname or no user by that nickname,
763         // try the site owner. Throws exception if not configured.
764         return User::siteOwner();
765     }
766
767     /**
768      * This is kind of a hack for using external setup code that's trying to
769      * build single-user sites.
770      *
771      * Will still return a username if the config singleuser/nickname is set
772      * even if the account doesn't exist, which normally indicates that the
773      * site is horribly misconfigured.
774      *
775      * At the moment, we need to let it through so that router setup can
776      * complete, otherwise we won't be able to create the account.
777      *
778      * This will be easier when we can more easily create the account and
779      * *then* switch the site to 1user mode without jumping through hoops.
780      *
781      * @return string
782      * @throws ServerException if no valid single user account is present
783      * @throws ServerException if called when not in single-user mode
784      */
785     static function singleUserNickname()
786     {
787         try {
788             $user = User::singleUser();
789             return $user->nickname;
790         } catch (Exception $e) {
791             if (common_config('singleuser', 'enabled') && common_config('singleuser', 'nickname')) {
792                 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.");
793                 return common_config('singleuser', 'nickname');
794             }
795             throw $e;
796         }
797     }
798
799     /**
800      * Find and shorten links in the given text using this user's URL shortening
801      * settings.
802      *
803      * By default, links will be left untouched if the text is shorter than the
804      * configured maximum notice length. Pass true for the $always parameter
805      * to force all links to be shortened regardless.
806      *
807      * Side effects: may save file and file_redirection records for referenced URLs.
808      *
809      * @param string $text
810      * @param boolean $always
811      * @return string
812      */
813     public function shortenLinks($text, $always=false)
814     {
815         return common_shorten_links($text, $always, $this);
816     }
817
818     /*
819      * Get a list of OAuth client applications that have access to this
820      * user's account.
821      */
822     function getConnectedApps($offset = 0, $limit = null)
823     {
824         $qry =
825           'SELECT u.* ' .
826           'FROM oauth_application_user u, oauth_application a ' .
827           'WHERE u.profile_id = %d ' .
828           'AND a.id = u.application_id ' .
829           'AND u.access_type > 0 ' .
830           'ORDER BY u.created DESC ';
831
832         if ($offset > 0) {
833             if (common_config('db','type') == 'pgsql') {
834                 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
835             } else {
836                 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
837             }
838         }
839
840         $apps = new Oauth_application_user();
841
842         $cnt = $apps->query(sprintf($qry, $this->id));
843
844         return $apps;
845     }
846
847     /**
848      * Magic function called at serialize() time.
849      *
850      * We use this to drop a couple process-specific references
851      * from DB_DataObject which can cause trouble in future
852      * processes.
853      *
854      * @return array of variable names to include in serialization.
855      */
856
857     function __sleep()
858     {
859         $vars = parent::__sleep();
860         $skip = array('_profile');
861         return array_diff($vars, $skip);
862     }
863
864     static function recoverPassword($nore)
865     {
866         $user = User::getKV('email', common_canonical_email($nore));
867
868         if (!$user) {
869             try {
870                 $user = User::getKV('nickname', common_canonical_nickname($nore));
871             } catch (NicknameException $e) {
872                 // invalid
873             }
874         }
875
876         // See if it's an unconfirmed email address
877
878         if (!$user) {
879             // Warning: it may actually be legit to have multiple folks
880             // who have claimed, but not yet confirmed, the same address.
881             // We'll only send to the first one that comes up.
882             $confirm_email = new Confirm_address();
883             $confirm_email->address = common_canonical_email($nore);
884             $confirm_email->address_type = 'email';
885             $confirm_email->find();
886             if ($confirm_email->fetch()) {
887                 $user = User::getKV($confirm_email->user_id);
888             } else {
889                 $confirm_email = null;
890             }
891         } else {
892             $confirm_email = null;
893         }
894
895         if (!$user) {
896             // TRANS: Information on password recovery form if no known username or e-mail address was specified.
897             throw new ClientException(_('No user with that email address or username.'));
898             return;
899         }
900
901         // Try to get an unconfirmed email address if they used a user name
902
903         if (!$user->email && !$confirm_email) {
904             $confirm_email = new Confirm_address();
905             $confirm_email->user_id = $user->id;
906             $confirm_email->address_type = 'email';
907             $confirm_email->find();
908             if (!$confirm_email->fetch()) {
909                 $confirm_email = null;
910             }
911         }
912
913         if (!$user->email && !$confirm_email) {
914             // TRANS: Client error displayed on password recovery form if a user does not have a registered e-mail address.
915             throw new ClientException(_('No registered email address for that user.'));
916             return;
917         }
918
919         // Success! We have a valid user and a confirmed or unconfirmed email address
920
921         $confirm = new Confirm_address();
922         $confirm->code = common_confirmation_code(128);
923         $confirm->address_type = 'recover';
924         $confirm->user_id = $user->id;
925         $confirm->address = (!empty($user->email)) ? $user->email : $confirm_email->address;
926
927         if (!$confirm->insert()) {
928             common_log_db_error($confirm, 'INSERT', __FILE__);
929             // TRANS: Server error displayed if e-mail address confirmation fails in the database on the password recovery form.
930             throw new ServerException(_('Error saving address confirmation.'));
931             return;
932         }
933
934          // @todo FIXME: needs i18n.
935         $body = "Hey, $user->nickname.";
936         $body .= "\n\n";
937         $body .= 'Someone just asked for a new password ' .
938                  'for this account on ' . common_config('site', 'name') . '.';
939         $body .= "\n\n";
940         $body .= 'If it was you, and you want to confirm, use the URL below:';
941         $body .= "\n\n";
942         $body .= "\t".common_local_url('recoverpassword',
943                                    array('code' => $confirm->code));
944         $body .= "\n\n";
945         $body .= 'If not, just ignore this message.';
946         $body .= "\n\n";
947         $body .= 'Thanks for your time, ';
948         $body .= "\n";
949         $body .= common_config('site', 'name');
950         $body .= "\n";
951
952         $headers = _mail_prepare_headers('recoverpassword', $user->nickname, $user->nickname);
953         // TRANS: Subject for password recovery e-mail.
954         mail_to_user($user, _('Password recovery requested'), $body, $headers, $confirm->address);
955     }
956
957     function streamModeOnly()
958     {
959         if (common_config('oldschool', 'enabled')) {
960             $osp = Old_school_prefs::getKV('user_id', $this->id);
961             if (!empty($osp)) {
962                 return $osp->stream_mode_only;
963             }
964         }
965
966         return false;
967     }
968
969     function streamNicknames()
970     {
971         if (common_config('oldschool', 'enabled')) {
972             $osp = Old_school_prefs::getKV('user_id', $this->id);
973             if (!empty($osp)) {
974                 return $osp->stream_nicknames;
975             }
976         }
977         return false;
978     }
979
980     function registrationActivity()
981     {
982         $profile = $this->getProfile();
983
984         $service = new ActivityObject();
985
986         $service->type  = ActivityObject::SERVICE;
987         $service->title = common_config('site', 'name');
988         $service->link  = common_root_url();
989         $service->id    = $service->link;
990
991         $act = new Activity();
992
993         $act->actor = $profile->asActivityObject();
994         $act->verb = ActivityVerb::JOIN;
995
996         $act->objects[] = $service;
997
998         $act->id = TagURI::mint('user:register:%d',
999                                 $this->id);
1000
1001         $act->time = strtotime($this->created);
1002
1003         $act->title = _("Register");
1004
1005         $act->content = sprintf(_('%1$s joined %2$s.'),
1006                                 $profile->getBestName(),
1007                                 $service->title);
1008         return $act;
1009     }
1010 }