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