classes/User.php

   1 <?php
   2 /*
   3  * Laconica - a distributed open-source microblogging tool
   4  * Copyright (C) 2008, Controlez-Vous, 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('LACONICA')) { exit(1); }
  21 /**
  22  * Table Definition for user
  23  */
  24 require_once 'DB/DataObject.php';
  25 require_once 'Validate.php';
  26
  27 class User extends DB_DataObject
  28 {
  29     ###START_AUTOCODE
  30     /* the code below is auto generated do not remove the above tag */
  31
  32     public $__table = 'user';                            // table name
  33     public $id;                              // int(4)  primary_key not_null
  34     public $nickname;                        // varchar(64)  unique_key
  35     public $password;                        // varchar(255)
  36     public $email;                           // varchar(255)  unique_key
  37     public $incomingemail;                   // varchar(255)  unique_key
  38     public $emailnotifysub;                  // tinyint(1)   default_1
  39     public $emailmicroid;                    // tinyint(1)   default_1
  40     public $language;                        // varchar(50)
  41     public $timezone;                        // varchar(50)
  42     public $emailpost;                       // tinyint(1)   default_1
  43     public $jabber;                          // varchar(255)  unique_key
  44     public $jabbernotify;                    // tinyint(1)
  45     public $jabberreplies;                   // tinyint(1)
  46     public $jabbermicroid;                   // tinyint(1)   default_1
  47     public $updatefrompresence;              // tinyint(1)
  48     public $sms;                             // varchar(64)  unique_key
  49     public $carrier;                         // int(4)
  50     public $smsnotify;                       // tinyint(1)
  51     public $smsreplies;                      // tinyint(1)
  52     public $smsemail;                        // varchar(255)
  53     public $uri;                             // varchar(255)  unique_key
  54     public $autosubscribe;                   // tinyint(1)
  55     public $created;                         // datetime()   not_null
  56     public $modified;                        // timestamp()   not_null default_CURRENT_TIMESTAMP
  57
  58     /* Static get */
  59     function staticGet($k,$v=NULL) { return DB_DataObject::staticGet('User',$k,$v); }
  60
  61     /* the code above is auto generated do not remove the tag below */
  62     ###END_AUTOCODE
  63
  64         function getProfile() {
  65                 $profile = DB_DataObject::factory('profile');
  66                 $profile->id = $this->id;
  67                 if ($profile->find()) {
  68                         $profile->fetch();
  69                         return $profile;
  70                 }
  71                 return NULL;
  72         }
  73
  74         function isSubscribed($other) {
  75                 assert(!is_null($other));
  76                 $sub = DB_DataObject::factory('subscription');
  77                 $sub->subscriber = $this->id;
  78                 $sub->subscribed = $other->id;
  79                 return $sub->find();
  80         }
  81
  82         # 'update' won't write key columns, so we have to do it ourselves.
  83
  84         function updateKeys(&$orig) {
  85                 $parts = array();
  86                 foreach (array('nickname', 'email', 'jabber', 'incomingemail', 'sms', 'carrier', 'smsemail', 'language', 'timezone') as $k) {
  87                         if (strcmp($this->$k, $orig->$k) != 0) {
  88                                 $parts[] = $k . ' = ' . $this->_quote($this->$k);
  89                         }
  90                 }
  91                 if (count($parts) == 0) {
  92                         # No changes
  93                         return true;
  94                 }
  95                 $toupdate = implode(', ', $parts);
  96                 $qry = 'UPDATE ' . $this->tableName() . ' SET ' . $toupdate .
  97                   ' WHERE id = ' . $this->id;
  98                 return $this->query($qry);
  99         }
 100
 101         function allowed_nickname($nickname) {
 102                 # XXX: should already be validated for size, content, etc.
 103                 static $blacklist = array('rss', 'xrds', 'doc', 'main',
 104                                                                   'settings', 'notice', 'user',
 105                                                                   'search', 'avatar');
 106                 $merged = array_merge($blacklist, common_config('nickname', 'blacklist'));
 107                 return !in_array($nickname, $merged);
 108         }
 109
 110         function getCurrentNotice($dt=NULL) {
 111                 $profile = $this->getProfile();
 112                 if (!$profile) {
 113                         return NULL;
 114                 }
 115                 return $profile->getCurrentNotice($dt);
 116         }
 117
 118         function getCarrier() {
 119                 return Sms_carrier::staticGet($this->carrier);
 120         }
 121
 122         function subscribeTo($other) {
 123                 $sub = new Subscription();
 124                 $sub->subscriber = $this->id;
 125                 $sub->subscribed = $other->id;
 126
 127                 $sub->created = DB_DataObject_Cast::dateTime(); # current time
 128
 129                 if (!$sub->insert()) {
 130                         return false;
 131                 }
 132
 133                 return true;
 134         }
 135
 136         function noticesWithFriends($offset=0, $limit=20) {
 137
 138                 $notice = new Notice();
 139
 140                 $notice->query('SELECT notice.* ' .
 141                                            'FROM notice JOIN subscription on notice.profile_id = subscription.subscribed ' .
 142                                            'WHERE subscription.subscriber = ' . $this->id . ' ' .
 143                                            'ORDER BY created DESC, notice.id DESC ' .
 144                                            'LIMIT ' . $offset . ', ' . $limit);
 145
 146                 return $notice;
 147         }
 148
 149         static function register($fields) {
 150
 151                 # MAGICALLY put fields into current scope
 152
 153                 extract($fields);
 154
 155                 $profile = new Profile();
 156
 157                 $profile->query('BEGIN');
 158
 159                 $profile->nickname = $nickname;
 160                 $profile->profileurl = common_profile_url($nickname);
 161
 162                 if ($fullname) {
 163                         $profile->fullname = $fullname;
 164                 }
 165                 if ($homepage) {
 166                         $profile->homepage = $homepage;
 167                 }
 168                 if ($bio) {
 169                         $profile->bio = $bio;
 170                 }
 171                 if ($location) {
 172                         $profile->location = $location;
 173                 }
 174
 175                 $profile->created = common_sql_now();
 176
 177                 $id = $profile->insert();
 178
 179                 if (!$id) {
 180                         common_log_db_error($profile, 'INSERT', __FILE__);
 181                     return FALSE;
 182                 }
 183
 184                 $user = new User();
 185
 186                 $user->id = $id;
 187                 $user->nickname = $nickname;
 188
 189                 if ($password) { # may not have a password for OpenID users
 190                         $user->password = common_munge_password($password, $id);
 191                 }
 192
 193                 $user->created = common_sql_now();
 194                 $user->uri = common_user_uri($user);
 195
 196                 $result = $user->insert();
 197
 198                 if (!$result) {
 199                         common_log_db_error($user, 'INSERT', __FILE__);
 200                         return FALSE;
 201                 }
 202
 203                 # Everyone is subscribed to themself
 204
 205                 $subscription = new Subscription();
 206                 $subscription->subscriber = $user->id;
 207                 $subscription->subscribed = $user->id;
 208                 $subscription->created = $user->created;
 209
 210                 $result = $subscription->insert();
 211
 212                 if (!$result) {
 213                         common_log_db_error($subscription, 'INSERT', __FILE__);
 214                         return FALSE;
 215                 }
 216
 217                 if ($email) {
 218
 219                         $confirm = new Confirm_address();
 220                         $confirm->code = common_confirmation_code(128);
 221                         $confirm->user_id = $user->id;
 222                         $confirm->address = $email;
 223                         $confirm->address_type = 'email';
 224
 225                         $result = $confirm->insert();
 226                         if (!$result) {
 227                                 common_log_db_error($confirm, 'INSERT', __FILE__);
 228                                 return FALSE;
 229                         }
 230                 }
 231
 232                 $profile->query('COMMIT');
 233
 234                 if ($email) {
 235                         mail_confirm_address($confirm->code,
 236                                                                  $profile->nickname,
 237                                                                  $email);
 238                 }
 239
 240                 return $user;
 241         }
 242 }