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