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 $emailpost;                       // tinyint(1)   default_1
  40     public $jabber;                          // varchar(255)  unique_key
  41     public $jabbernotify;                    // tinyint(1)
  42     public $jabberreplies;                   // tinyint(1)
  43     public $updatefrompresence;              // tinyint(1)
  44     public $sms;                             // varchar(64)  unique_key
  45     public $carrier;                         // int(4)
  46     public $smsnotify;                       // tinyint(1)
  47     public $uri;                             // varchar(255)  unique_key
  48     public $autosubscribe;                   // tinyint(1)
  49     public $created;                         // datetime()   not_null
  50     public $modified;                        // timestamp()   not_null default_CURRENT_TIMESTAMP
  51
  52     /* Static get */
  53     function staticGet($k,$v=NULL) { return DB_DataObject::staticGet('User',$k,$v); }
  54
  55     /* the code above is auto generated do not remove the tag below */
  56     ###END_AUTOCODE
  57
  58         function getProfile() {
  59                 $profile = DB_DataObject::factory('profile');
  60                 $profile->id = $this->id;
  61                 if ($profile->find()) {
  62                         $profile->fetch();
  63                         return $profile;
  64                 }
  65                 return NULL;
  66         }
  67
  68         function isSubscribed($other) {
  69                 assert(!is_null($other));
  70                 $sub = DB_DataObject::factory('subscription');
  71                 $sub->subscriber = $this->id;
  72                 $sub->subscribed = $other->id;
  73                 return $sub->find();
  74         }
  75
  76         # 'update' won't write key columns, so we have to do it ourselves.
  77
  78         function updateKeys(&$orig) {
  79                 $parts = array();
  80                 foreach (array('nickname', 'email', 'jabber', 'sms', 'carrier') as $k) {
  81                         if (strcmp($this->$k, $orig->$k) != 0) {
  82                                 $parts[] = $k . ' = ' . $this->_quote($this->$k);
  83                         }
  84                 }
  85                 if (count($parts) == 0) {
  86                         # No changes
  87                         return true;
  88                 }
  89                 $toupdate = implode(', ', $parts);
  90                 $qry = 'UPDATE ' . $this->tableName() . ' SET ' . $toupdate .
  91                   ' WHERE id = ' . $this->id;
  92                 return $this->query($qry);
  93         }
  94
  95         function allowed_nickname($nickname) {
  96                 # XXX: should already be validated for size, content, etc.
  97                 static $blacklist = array('rss', 'xrds', 'doc', 'main',
  98                                                                   'settings', 'notice', 'user',
  99                                                                   'search', 'avatar');
 100                 $merged = array_merge($blacklist, common_config('nickname', 'blacklist'));
 101                 return !in_array($nickname, $merged);
 102         }
 103
 104         function getCurrentNotice($dt=NULL) {
 105                 $profile = $this->getProfile();
 106                 if (!$profile) {
 107                         return NULL;
 108                 }
 109                 return $profile->getCurrentNotice($dt);
 110         }
 111
 112         function getCarrier() {
 113                 return Sms_carrier::staticGet($this->carrier);
 114         }
 115
 116         function subscribeTo($other) {
 117                 $sub = new Subscription();
 118                 $sub->subscriber = $this->id;
 119                 $sub->subscribed = $other->id;
 120
 121                 $sub->created = DB_DataObject_Cast::dateTime(); # current time
 122
 123                 if (!$sub->insert()) {
 124                         return false;
 125                 }
 126
 127                 return true;
 128         }
 129 }