3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2008, 2009, StatusNet, Inc.
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.
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.
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/>.
20 if (!defined('STATUSNET') && !defined('LACONICA')) {
25 * Table Definition for user
28 require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
29 require_once 'Validate.php';
31 class User extends Memcached_DataObject
34 /* the code below is auto generated do not remove the above tag */
36 public $__table = 'user'; // table name
37 public $id; // int(4) primary_key not_null
38 public $nickname; // varchar(64) unique_key
39 public $password; // varchar(255)
40 public $email; // varchar(255) unique_key
41 public $incomingemail; // varchar(255) unique_key
42 public $emailnotifysub; // tinyint(1) default_1
43 public $emailnotifyfav; // tinyint(1) default_1
44 public $emailnotifynudge; // tinyint(1) default_1
45 public $emailnotifymsg; // tinyint(1) default_1
46 public $emailnotifyattn; // tinyint(1) default_1
47 public $emailmicroid; // tinyint(1) default_1
48 public $language; // varchar(50)
49 public $timezone; // varchar(50)
50 public $emailpost; // tinyint(1) default_1
51 public $jabber; // varchar(255) unique_key
52 public $jabbernotify; // tinyint(1)
53 public $jabberreplies; // tinyint(1)
54 public $jabbermicroid; // tinyint(1) default_1
55 public $updatefrompresence; // tinyint(1)
56 public $sms; // varchar(64) unique_key
57 public $carrier; // int(4)
58 public $smsnotify; // tinyint(1)
59 public $smsreplies; // tinyint(1)
60 public $smsemail; // varchar(255)
61 public $uri; // varchar(255) unique_key
62 public $autosubscribe; // tinyint(1)
63 public $urlshorteningservice; // varchar(50) default_ur1.ca
64 public $inboxed; // tinyint(1)
65 public $design_id; // int(4)
66 public $viewdesigns; // tinyint(1) default_1
67 public $created; // datetime() not_null
68 public $modified; // timestamp() not_null default_CURRENT_TIMESTAMP
71 function staticGet($k,$v=NULL) { return Memcached_DataObject::staticGet('User',$k,$v); }
73 /* the code above is auto generated do not remove the tag below */
78 return Profile::staticGet('id', $this->id);
81 function isSubscribed($other)
83 assert(!is_null($other));
84 // XXX: cache results of this query
85 $sub = Subscription::pkeyGet(array('subscriber' => $this->id,
86 'subscribed' => $other->id));
87 return (is_null($sub)) ? false : true;
90 // 'update' won't write key columns, so we have to do it ourselves.
92 function updateKeys(&$orig)
95 foreach (array('nickname', 'email', 'jabber', 'incomingemail', 'sms', 'carrier', 'smsemail', 'language', 'timezone') as $k) {
96 if (strcmp($this->$k, $orig->$k) != 0) {
97 $parts[] = $k . ' = ' . $this->_quote($this->$k);
100 if (count($parts) == 0) {
104 $toupdate = implode(', ', $parts);
106 $table = common_database_tablename($this->tableName());
107 $qry = 'UPDATE ' . $table . ' SET ' . $toupdate .
108 ' WHERE id = ' . $this->id;
110 $result = $this->query($qry);
117 static function allowed_nickname($nickname)
119 // XXX: should already be validated for size, content, etc.
120 $blacklist = common_config('nickname', 'blacklist');
122 //all directory and file names should be blacklisted
123 $d = dir(INSTALLDIR);
124 while (false !== ($entry = $d->read())) {
129 //all top level names in the router should be blacklisted
130 $router = Router::get();
131 foreach(array_keys($router->m->getPaths()) as $path){
132 if(preg_match('/^\/(.*?)[\/\?]/',$path,$matches)){
133 $blacklist[]=$matches[1];
136 return !in_array($nickname, $blacklist);
139 function getCurrentNotice($dt=null)
141 $profile = $this->getProfile();
145 return $profile->getCurrentNotice($dt);
148 function getCarrier()
150 return Sms_carrier::staticGet('id', $this->carrier);
153 function subscribeTo($other)
155 $sub = new Subscription();
156 $sub->subscriber = $this->id;
157 $sub->subscribed = $other->id;
159 $sub->created = common_sql_now(); // current time
161 if (!$sub->insert()) {
168 function hasBlocked($other)
171 $block = Profile_block::get($this->id, $other->id);
173 if (is_null($block)) {
183 static function register($fields) {
185 // MAGICALLY put fields into current scope
189 $profile = new Profile();
191 $profile->query('BEGIN');
195 $email = common_canonical_email($email);
198 $nickname = common_canonical_nickname($nickname);
199 $profile->nickname = $nickname;
200 if(! User::allowed_nickname($nickname)){
201 common_log(LOG_WARNING, sprintf("Attempted to register a nickname that is not allowed: %s", $profile->nickname),
204 $profile->profileurl = common_profile_url($nickname);
206 if (!empty($fullname)) {
207 $profile->fullname = $fullname;
209 if (!empty($homepage)) {
210 $profile->homepage = $homepage;
213 $profile->bio = $bio;
215 if (!empty($location)) {
216 $profile->location = $location;
218 $loc = Location::fromName($location);
221 $profile->lat = $loc->lat;
222 $profile->lon = $loc->lon;
223 $profile->location_id = $loc->location_id;
224 $profile->location_ns = $loc->location_ns;
228 $profile->created = common_sql_now();
230 $id = $profile->insert();
233 common_log_db_error($profile, 'INSERT', __FILE__);
240 $user->nickname = $nickname;
242 if (!empty($password)) { // may not have a password for OpenID users
243 $user->password = common_munge_password($password, $id);
246 // Users who respond to invite email have proven their ownership of that address
249 $invite = Invitation::staticGet($code);
250 if ($invite && $invite->address && $invite->address_type == 'email' && $invite->address == $email) {
251 $user->email = $invite->address;
255 if(isset($email_confirmed) && $email_confirmed) {
256 $user->email = $email;
259 // This flag is ignored but still set to 1
263 $user->created = common_sql_now();
264 $user->uri = common_user_uri($user);
266 $result = $user->insert();
269 common_log_db_error($user, 'INSERT', __FILE__);
273 // Everyone is subscribed to themself
275 $subscription = new Subscription();
276 $subscription->subscriber = $user->id;
277 $subscription->subscribed = $user->id;
278 $subscription->created = $user->created;
280 $result = $subscription->insert();
283 common_log_db_error($subscription, 'INSERT', __FILE__);
287 if (!empty($email) && !$user->email) {
289 $confirm = new Confirm_address();
290 $confirm->code = common_confirmation_code(128);
291 $confirm->user_id = $user->id;
292 $confirm->address = $email;
293 $confirm->address_type = 'email';
295 $result = $confirm->insert();
297 common_log_db_error($confirm, 'INSERT', __FILE__);
302 if (!empty($code) && $user->email) {
303 $user->emailChanged();
306 // Default system subscription
308 $defnick = common_config('newuser', 'default');
310 if (!empty($defnick)) {
311 $defuser = User::staticGet('nickname', $defnick);
312 if (empty($defuser)) {
313 common_log(LOG_WARNING, sprintf("Default user %s does not exist.", $defnick),
316 $defsub = new Subscription();
317 $defsub->subscriber = $user->id;
318 $defsub->subscribed = $defuser->id;
319 $defsub->created = $user->created;
321 $result = $defsub->insert();
324 common_log_db_error($defsub, 'INSERT', __FILE__);
330 $profile->query('COMMIT');
332 if ($email && !$user->email) {
333 mail_confirm_address($user, $confirm->code, $profile->nickname, $email);
338 $welcome = common_config('newuser', 'welcome');
340 if (!empty($welcome)) {
341 $welcomeuser = User::staticGet('nickname', $welcome);
342 if (empty($welcomeuser)) {
343 common_log(LOG_WARNING, sprintf("Welcome user %s does not exist.", $defnick),
346 $notice = Notice::saveNew($welcomeuser->id,
347 sprintf(_('Welcome to %1$s, @%2$s!'),
348 common_config('site', 'name'),
351 common_broadcast_notice($notice);
358 // Things we do when the email changes
360 function emailChanged()
363 $invites = new Invitation();
364 $invites->address = $this->email;
365 $invites->address_type = 'email';
367 if ($invites->find()) {
368 while ($invites->fetch()) {
369 $other = User::staticGet($invites->user_id);
370 subs_subscribe_to($other, $this);
375 function hasFave($notice)
377 $cache = common_memcache();
379 // XXX: Kind of a hack.
382 // This is the stream of favorite notices, in rev chron
383 // order. This forces it into cache.
385 $ids = Fave::stream($this->id, 0, NOTICE_CACHE_WINDOW);
387 // If it's in the list, then it's a fave
389 if (in_array($notice->id, $ids)) {
393 // If we're not past the end of the cache window,
394 // then the cache has all available faves, so this one
397 if (count($ids) < NOTICE_CACHE_WINDOW) {
401 // Otherwise, cache doesn't have all faves;
402 // fall through to the default
405 $fave = Fave::pkeyGet(array('user_id' => $this->id,
406 'notice_id' => $notice->id));
407 return ((is_null($fave)) ? false : true);
410 function mutuallySubscribed($other)
412 return $this->isSubscribed($other) &&
413 $other->isSubscribed($this);
416 function mutuallySubscribedUsers()
418 // 3-way join; probably should get cached
419 $UT = common_config('db','type')=='pgsql'?'"user"':'user';
420 $qry = "SELECT $UT.* " .
421 "FROM subscription sub1 JOIN $UT ON sub1.subscribed = $UT.id " .
422 "JOIN subscription sub2 ON $UT.id = sub2.subscriber " .
423 'WHERE sub1.subscriber = %d and sub2.subscribed = %d ' .
424 "ORDER BY $UT.nickname";
426 $user->query(sprintf($qry, $this->id, $this->id));
431 function getReplies($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0, $since=null)
433 $ids = Reply::stream($this->id, $offset, $limit, $since_id, $before_id, $since);
434 return Notice::getStreamByIds($ids);
437 function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0, $since=null) {
438 $profile = $this->getProfile();
442 return $profile->getTaggedNotices($tag, $offset, $limit, $since_id, $before_id, $since);
446 function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0, $since=null)
448 $profile = $this->getProfile();
452 return $profile->getNotices($offset, $limit, $since_id, $before_id, $since);
456 function favoriteNotices($offset=0, $limit=NOTICES_PER_PAGE, $own=false)
458 $ids = Fave::stream($this->id, $offset, $limit, $own);
459 return Notice::getStreamByIds($ids);
462 function noticesWithFriends($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0, $since=null)
464 $ids = Notice_inbox::stream($this->id, $offset, $limit, $since_id, $before_id, $since, false);
466 return Notice::getStreamByIds($ids);
469 function noticeInbox($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0, $since=null)
471 $ids = Notice_inbox::stream($this->id, $offset, $limit, $since_id, $before_id, $since, true);
473 return Notice::getStreamByIds($ids);
476 function friendsTimeline($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0, $since=null)
478 $ids = Notice::stream(array($this, '_friendsTimelineDirect'),
480 'user:friends_timeline:'.$this->id,
481 $offset, $limit, $since_id, $before_id, $since);
483 return Notice::getStreamByIds($ids);
486 function ownFriendsTimeline($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0, $since=null)
488 $ids = Notice::stream(array($this, '_friendsTimelineDirect'),
490 'user:friends_timeline_own:'.$this->id,
491 $offset, $limit, $since_id, $before_id, $since);
493 return Notice::getStreamByIds($ids);
496 function _friendsTimelineDirect($own, $offset, $limit, $since_id, $max_id, $since)
499 'SELECT notice.id AS id ' .
500 'FROM notice JOIN notice_inbox ON notice.id = notice_inbox.notice_id ' .
501 'WHERE notice_inbox.user_id = ' . $this->id . ' ' .
502 'AND notice.repeat_of IS NULL ';
505 // XXX: autoload notice inbox for constant
506 $inbox = new Notice_inbox();
508 $qry .= 'AND notice_inbox.source != ' . NOTICE_INBOX_SOURCE_GATEWAY . ' ';
511 if ($since_id != 0) {
512 $qry .= 'AND notice.id > ' . $since_id . ' ';
516 $qry .= 'AND notice.id <= ' . $max_id . ' ';
519 if (!is_null($since)) {
520 $qry .= 'AND notice.modified > \'' . date('Y-m-d H:i:s', $since) . '\' ';
523 // NOTE: we sort by fave time, not by notice time!
525 $qry .= 'ORDER BY notice.id DESC ';
527 if (!is_null($offset)) {
528 $qry .= "LIMIT $limit OFFSET $offset";
533 $notice = new Notice();
535 $notice->query($qry);
537 while ($notice->fetch()) {
538 $ids[] = $notice->id;
547 function blowFavesCache()
549 $cache = common_memcache();
551 // Faves don't happen chronologically, so we need to blow
553 $cache->delete(common_cache_key('fave:ids_by_user:'.$this->id));
554 $cache->delete(common_cache_key('fave:ids_by_user:'.$this->id.';last'));
555 $cache->delete(common_cache_key('fave:ids_by_user_own:'.$this->id));
556 $cache->delete(common_cache_key('fave:ids_by_user_own:'.$this->id.';last'));
558 $profile = $this->getProfile();
559 $profile->blowFaveCount();
562 function getSelfTags()
564 return Profile_tag::getTags($this->id, $this->id);
567 function setSelfTags($newtags)
569 return Profile_tag::setTags($this->id, $this->id, $newtags);
572 function block($other)
574 // Add a new block record
576 // no blocking (and thus unsubbing from) yourself
578 if ($this->id == $other->id) {
579 common_log(LOG_WARNING,
581 "Profile ID %d (%s) tried to block his or herself.",
589 $block = new Profile_block();
591 // Begin a transaction
593 $block->query('BEGIN');
595 $block->blocker = $this->id;
596 $block->blocked = $other->id;
598 $result = $block->insert();
601 common_log_db_error($block, 'INSERT', __FILE__);
605 // Cancel their subscription, if it exists
607 subs_unsubscribe_to($other->getUser(),$this->getProfile());
609 $block->query('COMMIT');
614 function unblock($other)
616 // Get the block record
618 $block = Profile_block::get($this->id, $other->id);
624 $result = $block->delete();
627 common_log_db_error($block, 'DELETE', __FILE__);
634 function isMember($group)
636 $profile = $this->getProfile();
637 return $profile->isMember($group);
640 function isAdmin($group)
642 $profile = $this->getProfile();
643 return $profile->isAdmin($group);
646 function getGroups($offset=0, $limit=null)
649 'SELECT user_group.* ' .
650 'FROM user_group JOIN group_member '.
651 'ON user_group.id = group_member.group_id ' .
652 'WHERE group_member.profile_id = %d ' .
653 'ORDER BY group_member.created DESC ';
655 if ($offset>0 && !is_null($limit)) {
657 if (common_config('db','type') == 'pgsql') {
658 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
660 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
665 $groups = new User_group();
667 $cnt = $groups->query(sprintf($qry, $this->id));
672 function getSubscriptions($offset=0, $limit=null)
674 $profile = $this->getProfile();
675 assert(!empty($profile));
676 return $profile->getSubscriptions($offset, $limit);
679 function getSubscribers($offset=0, $limit=null)
681 $profile = $this->getProfile();
682 assert(!empty($profile));
683 return $profile->getSubscribers($offset, $limit);
686 function getTaggedSubscribers($tag, $offset=0, $limit=null)
689 'SELECT profile.* ' .
690 'FROM profile JOIN subscription ' .
691 'ON profile.id = subscription.subscriber ' .
692 'JOIN profile_tag ON (profile_tag.tagged = subscription.subscriber ' .
693 'AND profile_tag.tagger = subscription.subscribed) ' .
694 'WHERE subscription.subscribed = %d ' .
695 "AND profile_tag.tag = '%s' " .
696 'AND subscription.subscribed != subscription.subscriber ' .
697 'ORDER BY subscription.created DESC ';
700 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
703 $profile = new Profile();
705 $cnt = $profile->query(sprintf($qry, $this->id, $tag));
710 function getTaggedSubscriptions($tag, $offset=0, $limit=null)
713 'SELECT profile.* ' .
714 'FROM profile JOIN subscription ' .
715 'ON profile.id = subscription.subscribed ' .
716 'JOIN profile_tag on (profile_tag.tagged = subscription.subscribed ' .
717 'AND profile_tag.tagger = subscription.subscriber) ' .
718 'WHERE subscription.subscriber = %d ' .
719 "AND profile_tag.tag = '%s' " .
720 'AND subscription.subscribed != subscription.subscriber ' .
721 'ORDER BY subscription.created DESC ';
723 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
725 $profile = new Profile();
727 $profile->query(sprintf($qry, $this->id, $tag));
734 return Design::staticGet('id', $this->design_id);
737 function hasRight($right)
739 $profile = $this->getProfile();
740 return $profile->hasRight($right);
745 $profile = $this->getProfile();
750 $related = array('Fave',
757 Event::handle('UserDeleteRelated', array($this, &$related));
759 foreach ($related as $cls) {
761 $inst->user_id = $this->id;
765 $this->_deleteTags();
766 $this->_deleteBlocks();
771 function _deleteTags()
773 $tag = new Profile_tag();
774 $tag->tagger = $this->id;
778 function _deleteBlocks()
780 $block = new Profile_block();
781 $block->blocker = $this->id;
783 // XXX delete group block? Reset blocker?
786 function hasRole($name)
788 $profile = $this->getProfile();
789 return $profile->hasRole($name);
792 function grantRole($name)
794 $profile = $this->getProfile();
795 return $profile->grantRole($name);
798 function revokeRole($name)
800 $profile = $this->getProfile();
801 return $profile->revokeRole($name);
804 function isSandboxed()
806 $profile = $this->getProfile();
807 return $profile->isSandboxed();
810 function isSilenced()
812 $profile = $this->getProfile();
813 return $profile->isSilenced();
816 function repeatedByMe($offset=0, $limit=20, $since_id=null, $max_id=null)
818 $ids = Notice::stream(array($this, '_repeatedByMeDirect'),
820 'user:repeated_by_me:'.$this->id,
821 $offset, $limit, $since_id, $max_id, null);
823 return Notice::getStreamByIds($ids);
826 function _repeatedByMeDirect($offset, $limit, $since_id, $max_id, $since)
828 $notice = new Notice();
830 $notice->selectAdd(); // clears it
831 $notice->selectAdd('id');
833 $notice->profile_id = $this->id;
834 $notice->whereAdd('repeat_of IS NOT NULL');
836 $notice->orderBy('id DESC');
838 if (!is_null($offset)) {
839 $notice->limit($offset, $limit);
842 if ($since_id != 0) {
843 $notice->whereAdd('id > ' . $since_id);
847 $notice->whereAdd('id <= ' . $max_id);
850 if (!is_null($since)) {
851 $notice->whereAdd('created > \'' . date('Y-m-d H:i:s', $since) . '\'');
856 if ($notice->find()) {
857 while ($notice->fetch()) {
858 $ids[] = $notice->id;
868 function repeatsOfMe($offset=0, $limit=20, $since_id=null, $max_id=null)
870 $ids = Notice::stream(array($this, '_repeatsOfMeDirect'),
872 'user:repeats_of_me:'.$this->id,
873 $offset, $limit, $since_id, $max_id, null);
875 return Notice::getStreamByIds($ids);
878 function _repeatsOfMeDirect($offset, $limit, $since_id, $max_id, $since)
881 'SELECT DISTINCT original.id AS id ' .
882 'FROM notice original JOIN notice rept ON original.id = rept.repeat_of ' .
883 'WHERE original.profile_id = ' . $this->id . ' ';
885 if ($since_id != 0) {
886 $qry .= 'AND original.id > ' . $since_id . ' ';
890 $qry .= 'AND original.id <= ' . $max_id . ' ';
893 if (!is_null($since)) {
894 $qry .= 'AND original.modified > \'' . date('Y-m-d H:i:s', $since) . '\' ';
897 // NOTE: we sort by fave time, not by notice time!
899 $qry .= 'ORDER BY original.id DESC ';
901 if (!is_null($offset)) {
902 $qry .= "LIMIT $limit OFFSET $offset";
907 $notice = new Notice();
909 $notice->query($qry);
911 while ($notice->fetch()) {
912 $ids[] = $notice->id;
921 function repeatedToMe($offset=0, $limit=20, $since_id=null, $max_id=null)
923 $ids = Notice::stream(array($this, '_repeatedToMeDirect'),
925 'user:repeated_to_me:'.$this->id,
926 $offset, $limit, $since_id, $max_id, null);
928 return Notice::getStreamByIds($ids);
931 function _repeatedToMeDirect($offset, $limit, $since_id, $max_id, $since)
934 'SELECT notice.id AS id ' .
935 'FROM notice JOIN notice_inbox ON notice.id = notice_inbox.notice_id ' .
936 'WHERE notice_inbox.user_id = ' . $this->id . ' ' .
937 'AND notice.repeat_of IS NOT NULL ';
939 if ($since_id != 0) {
940 $qry .= 'AND notice.id > ' . $since_id . ' ';
944 $qry .= 'AND notice.id <= ' . $max_id . ' ';
947 if (!is_null($since)) {
948 $qry .= 'AND notice.modified > \'' . date('Y-m-d H:i:s', $since) . '\' ';
951 // NOTE: we sort by fave time, not by notice time!
953 $qry .= 'ORDER BY notice.id DESC ';
955 if (!is_null($offset)) {
956 $qry .= "LIMIT $limit OFFSET $offset";
961 $notice = new Notice();
963 $notice->query($qry);
965 while ($notice->fetch()) {
966 $ids[] = $notice->id;