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