]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - classes/User.php
Update/add translator documentation.
[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('STATUSNET') && !defined('LACONICA')) {
21     exit(1);
22 }
23
24 /**
25  * Table Definition for user
26  */
27
28 require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
29 require_once 'Validate.php';
30
31 class User extends Memcached_DataObject
32 {
33     const SUBSCRIBE_POLICY_OPEN = 0;
34     const SUBSCRIBE_POLICY_MODERATE = 1;
35
36     ###START_AUTOCODE
37     /* the code below is auto generated do not remove the above tag */
38
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 $design_id;                       // int(4)
65     public $viewdesigns;                     // tinyint(1)   default_1
66     public $private_stream;                  // tinyint(1)   default_0
67     public $created;                         // datetime()   not_null
68     public $modified;                        // timestamp()   not_null default_CURRENT_TIMESTAMP
69
70     /* Static get */
71     function staticGet($k,$v=NULL) { return Memcached_DataObject::staticGet('User',$k,$v); }
72
73     /* the code above is auto generated do not remove the tag below */
74     ###END_AUTOCODE
75
76     protected $_profile = -1;
77
78     /**
79      * @return Profile
80      */
81     function getProfile()
82     {
83         if (is_int($this->_profile) && $this->_profile == -1) { // invalid but distinct from null
84             $this->_profile = Profile::staticGet('id', $this->id);
85             if (empty($this->_profile)) {
86                 throw new UserNoProfileException($this);
87             }
88         }
89
90         return $this->_profile;
91     }
92
93     function isSubscribed($other)
94     {
95         $profile = $this->getProfile();
96         return $profile->isSubscribed($other);
97     }
98
99     function hasPendingSubscription($other)
100     {
101         $profile = $this->getProfile();
102         return $profile->hasPendingSubscription($other);
103     }
104
105     // 'update' won't write key columns, so we have to do it ourselves.
106
107     function updateKeys(&$orig)
108     {
109         $this->_connect();
110         $parts = array();
111         foreach (array('nickname', 'email', 'incomingemail', 'sms', 'carrier', 'smsemail', 'language', 'timezone') as $k) {
112             if (strcmp($this->$k, $orig->$k) != 0) {
113                 $parts[] = $k . ' = ' . $this->_quote($this->$k);
114             }
115         }
116         if (count($parts) == 0) {
117             // No changes
118             return true;
119         }
120         $toupdate = implode(', ', $parts);
121
122         $table = common_database_tablename($this->tableName());
123         $qry = 'UPDATE ' . $table . ' SET ' . $toupdate .
124           ' WHERE id = ' . $this->id;
125         $orig->decache();
126         $result = $this->query($qry);
127         if ($result) {
128             $this->encache();
129         }
130         return $result;
131     }
132
133     /**
134      * Check whether the given nickname is potentially usable, or if it's
135      * excluded by any blacklists on this system.
136      *
137      * WARNING: INPUT IS NOT VALIDATED OR NORMALIZED. NON-NORMALIZED INPUT
138      * OR INVALID INPUT MAY LEAD TO FALSE RESULTS.
139      *
140      * @param string $nickname
141      * @return boolean true if clear, false if blacklisted
142      */
143     static function allowed_nickname($nickname)
144     {
145         // XXX: should already be validated for size, content, etc.
146         $blacklist = common_config('nickname', 'blacklist');
147
148         //all directory and file names should be blacklisted
149         $d = dir(INSTALLDIR);
150         while (false !== ($entry = $d->read())) {
151             $blacklist[]=$entry;
152         }
153         $d->close();
154
155         //all top level names in the router should be blacklisted
156         $router = Router::get();
157         foreach(array_keys($router->m->getPaths()) as $path){
158             if(preg_match('/^\/(.*?)[\/\?]/',$path,$matches)){
159                 $blacklist[]=$matches[1];
160             }
161         }
162         return !in_array($nickname, $blacklist);
163     }
164
165     /**
166      * Get the most recent notice posted by this user, if any.
167      *
168      * @return mixed Notice or null
169      */
170     function getCurrentNotice()
171     {
172         $profile = $this->getProfile();
173         return $profile->getCurrentNotice();
174     }
175
176     function getCarrier()
177     {
178         return Sms_carrier::staticGet('id', $this->carrier);
179     }
180
181     /**
182      * @deprecated use Subscription::start($sub, $other);
183      */
184     function subscribeTo($other)
185     {
186         return Subscription::start($this->getProfile(), $other);
187     }
188
189     function hasBlocked($other)
190     {
191         $profile = $this->getProfile();
192         return $profile->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($fields) {
217
218         // MAGICALLY put fields into current scope
219
220         extract($fields);
221
222         $profile = new Profile();
223
224         if(!empty($email))
225         {
226             $email = common_canonical_email($email);
227         }
228
229         $nickname = common_canonical_nickname($nickname);
230         $profile->nickname = $nickname;
231         if(! User::allowed_nickname($nickname)){
232             common_log(LOG_WARNING, sprintf("Attempted to register a nickname that is not allowed: %s", $profile->nickname),
233                        __FILE__);
234             return false;
235         }
236         $profile->profileurl = common_profile_url($nickname);
237
238         if (!empty($fullname)) {
239             $profile->fullname = $fullname;
240         }
241         if (!empty($homepage)) {
242             $profile->homepage = $homepage;
243         }
244         if (!empty($bio)) {
245             $profile->bio = $bio;
246         }
247         if (!empty($location)) {
248             $profile->location = $location;
249
250             $loc = Location::fromName($location);
251
252             if (!empty($loc)) {
253                 $profile->lat         = $loc->lat;
254                 $profile->lon         = $loc->lon;
255                 $profile->location_id = $loc->location_id;
256                 $profile->location_ns = $loc->location_ns;
257             }
258         }
259
260         $profile->created = common_sql_now();
261
262         $user = new User();
263
264         $user->nickname = $nickname;
265
266         // Users who respond to invite email have proven their ownership of that address
267
268         if (!empty($code)) {
269             $invite = Invitation::staticGet($code);
270             if ($invite && $invite->address && $invite->address_type == 'email' && $invite->address == $email) {
271                 $user->email = $invite->address;
272             }
273         }
274
275         if(isset($email_confirmed) && $email_confirmed) {
276             $user->email = $email;
277         }
278
279         // This flag is ignored but still set to 1
280
281         $user->inboxed = 1;
282
283         // Set default-on options here, otherwise they'll be disabled
284         // initially for sites using caching, since the initial encache
285         // doesn't know about the defaults in the database.
286         $user->emailnotifysub = 1;
287         $user->emailnotifyfav = 1;
288         $user->emailnotifynudge = 1;
289         $user->emailnotifymsg = 1;
290         $user->emailnotifyattn = 1;
291         $user->emailmicroid = 1;
292         $user->emailpost = 1;
293         $user->jabbermicroid = 1;
294         $user->viewdesigns = 1;
295
296         $user->created = common_sql_now();
297
298         if (Event::handle('StartUserRegister', array(&$user, &$profile))) {
299
300             $profile->query('BEGIN');
301
302             $id = $profile->insert();
303
304             if (empty($id)) {
305                 common_log_db_error($profile, 'INSERT', __FILE__);
306                 return false;
307             }
308
309             $user->id = $id;
310
311             if (!empty($uri)) {
312                 $user->uri = $uri;
313             } else {
314                 $user->uri = common_user_uri($user);
315             }
316
317             if (!empty($password)) { // may not have a password for OpenID users
318                 $user->password = common_munge_password($password, $id);
319             }
320
321             $result = $user->insert();
322
323             if (!$result) {
324                 common_log_db_error($user, 'INSERT', __FILE__);
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                 return false;
354             }
355
356             if (!empty($email) && !$user->email) {
357
358                 $confirm = new Confirm_address();
359                 $confirm->code = common_confirmation_code(128);
360                 $confirm->user_id = $user->id;
361                 $confirm->address = $email;
362                 $confirm->address_type = 'email';
363
364                 $result = $confirm->insert();
365
366                 if (!$result) {
367                     common_log_db_error($confirm, 'INSERT', __FILE__);
368                     return false;
369                 }
370             }
371
372             if (!empty($code) && $user->email) {
373                 $user->emailChanged();
374             }
375
376             // Default system subscription
377
378             $defnick = common_config('newuser', 'default');
379
380             if (!empty($defnick)) {
381                 $defuser = User::staticGet('nickname', $defnick);
382                 if (empty($defuser)) {
383                     common_log(LOG_WARNING, sprintf("Default user %s does not exist.", $defnick),
384                                __FILE__);
385                 } else {
386                     Subscription::start($user, $defuser);
387                 }
388             }
389
390             $profile->query('COMMIT');
391
392             if (!empty($email) && !$user->email) {
393                 mail_confirm_address($user, $confirm->code, $profile->nickname, $email);
394             }
395
396             // Welcome message
397
398             $welcome = common_config('newuser', 'welcome');
399
400             if (!empty($welcome)) {
401                 $welcomeuser = User::staticGet('nickname', $welcome);
402                 if (empty($welcomeuser)) {
403                     common_log(LOG_WARNING, sprintf("Welcome user %s does not exist.", $defnick),
404                                __FILE__);
405                 } else {
406                     $notice = Notice::saveNew($welcomeuser->id,
407                                               // TRANS: Notice given on user registration.
408                                               // TRANS: %1$s is the sitename, $2$s is the registering user's nickname.
409                                               sprintf(_('Welcome to %1$s, @%2$s!'),
410                                                       common_config('site', 'name'),
411                                                       $user->nickname),
412                                               'system');
413                 }
414             }
415
416             Event::handle('EndUserRegister', array(&$profile, &$user));
417         }
418
419         return $user;
420     }
421
422     // Things we do when the email changes
423     function emailChanged()
424     {
425
426         $invites = new Invitation();
427         $invites->address = $this->email;
428         $invites->address_type = 'email';
429
430         if ($invites->find()) {
431             while ($invites->fetch()) {
432                 $other = User::staticGet($invites->user_id);
433                 subs_subscribe_to($other, $this);
434             }
435         }
436     }
437
438     function hasFave($notice)
439     {
440         $profile = $this->getProfile();
441         return $profile->hasFave($notice);
442     }
443
444     function mutuallySubscribed($other)
445     {
446         $profile = $this->getProfile();
447         return $profile->mutuallySubscribed($other);
448     }
449
450     function mutuallySubscribedUsers()
451     {
452         // 3-way join; probably should get cached
453         $UT = common_config('db','type')=='pgsql'?'"user"':'user';
454         $qry = "SELECT $UT.* " .
455           "FROM subscription sub1 JOIN $UT ON sub1.subscribed = $UT.id " .
456           "JOIN subscription sub2 ON $UT.id = sub2.subscriber " .
457           'WHERE sub1.subscriber = %d and sub2.subscribed = %d ' .
458           "ORDER BY $UT.nickname";
459         $user = new User();
460         $user->query(sprintf($qry, $this->id, $this->id));
461
462         return $user;
463     }
464
465     function getReplies($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
466     {
467         return Reply::stream($this->id, $offset, $limit, $since_id, $before_id);
468     }
469
470     function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0) {
471         $profile = $this->getProfile();
472         return $profile->getTaggedNotices($tag, $offset, $limit, $since_id, $before_id);
473     }
474
475     function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
476     {
477         $profile = $this->getProfile();
478         return $profile->getNotices($offset, $limit, $since_id, $before_id);
479     }
480
481     function favoriteNotices($own=false, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
482     {
483         return Fave::stream($this->id, $offset, $limit, $own, $since_id, $max_id);
484     }
485
486     function noticeInbox($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
487     {
488         $stream = new InboxNoticeStream($this);
489         return $stream->getNotices($offset, $limit, $since_id, $before_id);
490     }
491
492     // DEPRECATED, use noticeInbox()
493
494     function noticesWithFriends($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
495     {
496         return $this->noticeInbox($offset, $limit, $since_id, $before_id);
497     }
498
499     // DEPRECATED, use noticeInbox()
500
501     function noticesWithFriendsThreaded($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
502     {
503         return $this->noticeInbox($offset, $limit, $since_id, $before_id);
504     }
505
506     // DEPRECATED, use noticeInbox()
507
508     function noticeInboxThreaded($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
509     {
510         return $this->noticeInbox($offset, $limit, $since_id, $before_id);
511     }
512
513     // DEPRECATED, use noticeInbox()
514
515     function friendsTimeline($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
516     {
517         return $this->noticeInbox($offset, $limit, $since_id, $before_id);
518     }
519
520     // DEPRECATED, use noticeInbox()
521
522     function ownFriendsTimeline($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
523     {
524         $this->noticeInbox($offset, $limit, $since_id, $before_id);
525     }
526
527     function blowFavesCache()
528     {
529         $profile = $this->getProfile();
530         $profile->blowFavesCache();
531     }
532
533     function getSelfTags()
534     {
535         return Profile_tag::getTagsArray($this->id, $this->id, $this->id);
536     }
537
538     function setSelfTags($newtags, $privacy)
539     {
540         return Profile_tag::setTags($this->id, $this->id, $newtags, $privacy);
541     }
542
543     function block($other)
544     {
545         // Add a new block record
546
547         // no blocking (and thus unsubbing from) yourself
548
549         if ($this->id == $other->id) {
550             common_log(LOG_WARNING,
551                 sprintf(
552                     "Profile ID %d (%s) tried to block themself.",
553                     $this->id,
554                     $this->nickname
555                 )
556             );
557             return false;
558         }
559
560         $block = new Profile_block();
561
562         // Begin a transaction
563
564         $block->query('BEGIN');
565
566         $block->blocker = $this->id;
567         $block->blocked = $other->id;
568
569         $result = $block->insert();
570
571         if (!$result) {
572             common_log_db_error($block, 'INSERT', __FILE__);
573             return false;
574         }
575
576         $self = $this->getProfile();
577         if (Subscription::exists($other, $self)) {
578             Subscription::cancel($other, $self);
579         }
580         if (Subscription::exists($self, $other)) {
581             Subscription::cancel($self, $other);
582         }
583
584         $block->query('COMMIT');
585
586         return true;
587     }
588
589     function unblock($other)
590     {
591         // Get the block record
592
593         $block = Profile_block::get($this->id, $other->id);
594
595         if (!$block) {
596             return false;
597         }
598
599         $result = $block->delete();
600
601         if (!$result) {
602             common_log_db_error($block, 'DELETE', __FILE__);
603             return false;
604         }
605
606         return true;
607     }
608
609     function isMember($group)
610     {
611         $profile = $this->getProfile();
612         return $profile->isMember($group);
613     }
614
615     function isAdmin($group)
616     {
617         $profile = $this->getProfile();
618         return $profile->isAdmin($group);
619     }
620
621     function getGroups($offset=0, $limit=null)
622     {
623         $profile = $this->getProfile();
624         return $profile->getGroups($offset, $limit);
625     }
626
627     /**
628      * Request to join the given group.
629      * May throw exceptions on failure.
630      *
631      * @param User_group $group
632      * @return Group_member
633      */
634     function joinGroup(User_group $group)
635     {
636         $profile = $this->getProfile();
637         return $profile->joinGroup($group);
638     }
639
640     /**
641      * Leave a group that this user is a member of.
642      *
643      * @param User_group $group
644      */
645     function leaveGroup(User_group $group)
646     {
647         $profile = $this->getProfile();
648         return $profile->leaveGroup($group);
649     }
650
651     function getSubscriptions($offset=0, $limit=null)
652     {
653         $profile = $this->getProfile();
654         return $profile->getSubscriptions($offset, $limit);
655     }
656
657     function getSubscribers($offset=0, $limit=null)
658     {
659         $profile = $this->getProfile();
660         return $profile->getSubscribers($offset, $limit);
661     }
662
663     function getTaggedSubscribers($tag, $offset=0, $limit=null)
664     {
665         $qry =
666           'SELECT profile.* ' .
667           'FROM profile JOIN subscription ' .
668           'ON profile.id = subscription.subscriber ' .
669           'JOIN profile_tag ON (profile_tag.tagged = subscription.subscriber ' .
670           'AND profile_tag.tagger = subscription.subscribed) ' .
671           'WHERE subscription.subscribed = %d ' .
672           "AND profile_tag.tag = '%s' " .
673           'AND subscription.subscribed != subscription.subscriber ' .
674           'ORDER BY subscription.created DESC ';
675
676         if ($offset) {
677             $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
678         }
679
680         $profile = new Profile();
681
682         $cnt = $profile->query(sprintf($qry, $this->id, $tag));
683
684         return $profile;
685     }
686
687     function getTaggedSubscriptions($tag, $offset=0, $limit=null)
688     {
689         $qry =
690           'SELECT profile.* ' .
691           'FROM profile JOIN subscription ' .
692           'ON profile.id = subscription.subscribed ' .
693           'JOIN profile_tag on (profile_tag.tagged = subscription.subscribed ' .
694           'AND profile_tag.tagger = subscription.subscriber) ' .
695           'WHERE subscription.subscriber = %d ' .
696           "AND profile_tag.tag = '%s' " .
697           'AND subscription.subscribed != subscription.subscriber ' .
698           'ORDER BY subscription.created DESC ';
699
700         $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
701
702         $profile = new Profile();
703
704         $profile->query(sprintf($qry, $this->id, $tag));
705
706         return $profile;
707     }
708
709     function getDesign()
710     {
711         return Design::staticGet('id', $this->design_id);
712     }
713
714     function hasRight($right)
715     {
716         $profile = $this->getProfile();
717         return $profile->hasRight($right);
718     }
719
720     function delete()
721     {
722         try {
723             $profile = $this->getProfile();
724             $profile->delete();
725         } catch (UserNoProfileException $unp) {
726             common_log(LOG_INFO, "User {$this->nickname} has no profile; continuing deletion.");
727         }
728
729         $related = array('Fave',
730                          'Confirm_address',
731                          'Remember_me',
732                          'Foreign_link',
733                          'Invitation',
734                          );
735
736         Event::handle('UserDeleteRelated', array($this, &$related));
737
738         foreach ($related as $cls) {
739             $inst = new $cls();
740             $inst->user_id = $this->id;
741             $inst->delete();
742         }
743
744         $this->_deleteTags();
745         $this->_deleteBlocks();
746
747         parent::delete();
748     }
749
750     function _deleteTags()
751     {
752         $tag = new Profile_tag();
753         $tag->tagger = $this->id;
754         $tag->delete();
755     }
756
757     function _deleteBlocks()
758     {
759         $block = new Profile_block();
760         $block->blocker = $this->id;
761         $block->delete();
762         // XXX delete group block? Reset blocker?
763     }
764
765     function hasRole($name)
766     {
767         $profile = $this->getProfile();
768         return $profile->hasRole($name);
769     }
770
771     function grantRole($name)
772     {
773         $profile = $this->getProfile();
774         return $profile->grantRole($name);
775     }
776
777     function revokeRole($name)
778     {
779         $profile = $this->getProfile();
780         return $profile->revokeRole($name);
781     }
782
783     function isSandboxed()
784     {
785         $profile = $this->getProfile();
786         return $profile->isSandboxed();
787     }
788
789     function isSilenced()
790     {
791         $profile = $this->getProfile();
792         return $profile->isSilenced();
793     }
794
795     function repeatedByMe($offset=0, $limit=20, $since_id=null, $max_id=null)
796     {
797         $stream = new RepeatedByMeNoticeStream($this);
798         return $stream->getNotices($offset, $limit, $since_id, $max_id);
799     }
800
801
802     function repeatsOfMe($offset=0, $limit=20, $since_id=null, $max_id=null)
803     {
804         $stream = new RepeatsOfMeNoticeStream($this);
805
806         return $stream->getNotices($offset, $limit, $since_id, $max_id);
807     }
808
809
810     function repeatedToMe($offset=0, $limit=20, $since_id=null, $max_id=null)
811     {
812         // TRANS: Exception thrown when trying view "repeated to me".
813         throw new Exception(_('Not implemented since inbox change.'));
814     }
815
816     function shareLocation()
817     {
818         $cfg = common_config('location', 'share');
819
820         if ($cfg == 'always') {
821             return true;
822         } else if ($cfg == 'never') {
823             return false;
824         } else { // user
825             $share = true;
826
827             $prefs = User_location_prefs::staticGet('user_id', $this->id);
828
829             if (empty($prefs)) {
830                 $share = common_config('location', 'sharedefault');
831             } else {
832                 $share = $prefs->share_location;
833                 $prefs->free();
834             }
835
836             return $share;
837         }
838     }
839
840     static function siteOwner()
841     {
842         $owner = self::cacheGet('user:site_owner');
843
844         if ($owner === false) { // cache miss
845
846             $pr = new Profile_role();
847
848             $pr->role = Profile_role::OWNER;
849
850             $pr->orderBy('created');
851
852             $pr->limit(1);
853
854             if ($pr->find(true)) {
855                 $owner = User::staticGet('id', $pr->profile_id);
856             } else {
857                 $owner = null;
858             }
859
860             self::cacheSet('user:site_owner', $owner);
861         }
862
863         return $owner;
864     }
865
866     /**
867      * Pull the primary site account to use in single-user mode.
868      * If a valid user nickname is listed in 'singleuser':'nickname'
869      * in the config, this will be used; otherwise the site owner
870      * account is taken by default.
871      *
872      * @return User
873      * @throws ServerException if no valid single user account is present
874      * @throws ServerException if called when not in single-user mode
875      */
876     static function singleUser()
877     {
878         if (common_config('singleuser', 'enabled')) {
879
880             $user = null;
881
882             $nickname = common_config('singleuser', 'nickname');
883
884             if (!empty($nickname)) {
885                 $user = User::staticGet('nickname', $nickname);
886             }
887
888             // if there was no nickname or no user by that nickname,
889             // try the site owner.
890
891             if (empty($user)) {
892                 $user = User::siteOwner();
893             }
894
895             if (!empty($user)) {
896                 return $user;
897             } else {
898                 // TRANS: Server exception.
899                 throw new ServerException(_('No single user defined for single-user mode.'));
900             }
901         } else {
902             // TRANS: Server exception.
903             throw new ServerException(_('Single-user mode code called when not enabled.'));
904         }
905     }
906
907     /**
908      * This is kind of a hack for using external setup code that's trying to
909      * build single-user sites.
910      *
911      * Will still return a username if the config singleuser/nickname is set
912      * even if the account doesn't exist, which normally indicates that the
913      * site is horribly misconfigured.
914      *
915      * At the moment, we need to let it through so that router setup can
916      * complete, otherwise we won't be able to create the account.
917      *
918      * This will be easier when we can more easily create the account and
919      * *then* switch the site to 1user mode without jumping through hoops.
920      *
921      * @return string
922      * @throws ServerException if no valid single user account is present
923      * @throws ServerException if called when not in single-user mode
924      */
925     static function singleUserNickname()
926     {
927         try {
928             $user = User::singleUser();
929             return $user->nickname;
930         } catch (Exception $e) {
931             if (common_config('singleuser', 'enabled') && common_config('singleuser', 'nickname')) {
932                 common_log(LOG_WARN, "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.");
933                 return common_config('singleuser', 'nickname');
934             }
935             throw $e;
936         }
937     }
938
939     /**
940      * Find and shorten links in the given text using this user's URL shortening
941      * settings.
942      *
943      * By default, links will be left untouched if the text is shorter than the
944      * configured maximum notice length. Pass true for the $always parameter
945      * to force all links to be shortened regardless.
946      *
947      * Side effects: may save file and file_redirection records for referenced URLs.
948      *
949      * @param string $text
950      * @param boolean $always
951      * @return string
952      */
953     public function shortenLinks($text, $always=false)
954     {
955         return common_shorten_links($text, $always, $this);
956     }
957
958     /*
959      * Get a list of OAuth client applications that have access to this
960      * user's account.
961      */
962     function getConnectedApps($offset = 0, $limit = null)
963     {
964         $qry =
965           'SELECT u.* ' .
966           'FROM oauth_application_user u, oauth_application a ' .
967           'WHERE u.profile_id = %d ' .
968           'AND a.id = u.application_id ' .
969           'AND u.access_type > 0 ' .
970           'ORDER BY u.created DESC ';
971
972         if ($offset > 0) {
973             if (common_config('db','type') == 'pgsql') {
974                 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
975             } else {
976                 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
977             }
978         }
979
980         $apps = new Oauth_application_user();
981
982         $cnt = $apps->query(sprintf($qry, $this->id));
983
984         return $apps;
985     }
986 }