WEB-INF/lib/ttRegistrator.class.php

   1 <?php
   2 // +----------------------------------------------------------------------+
   3 // | Anuko Time Tracker
   4 // +----------------------------------------------------------------------+
   5 // | Copyright (c) Anuko International Ltd. (https://www.anuko.com)
   6 // +----------------------------------------------------------------------+
   7 // | LIBERAL FREEWARE LICENSE: This source code document may be used
   8 // | by anyone for any purpose, and freely redistributed alone or in
   9 // | combination with other software, provided that the license is obeyed.
  10 // |
  11 // | There are only two ways to violate the license:
  12 // |
  13 // | 1. To redistribute this code in source form, with the copyright
  14 // |    notice or license removed or altered. (Distributing in compiled
  15 // |    forms without embedded copyright notices is permitted).
  16 // |
  17 // | 2. To redistribute modified versions of this code in *any* form
  18 // |    that bears insufficient indications that the modifications are
  19 // |    not the work of the original author(s).
  20 // |
  21 // | This license applies to this document only, not any other software
  22 // | that it may be combined with.
  23 // |
  24 // +----------------------------------------------------------------------+
  25 // | Contributors:
  26 // | https://www.anuko.com/time_tracker/credits.htm
  27 // +----------------------------------------------------------------------+
  28
  29 // ttRegistrator class is used to register a user in Time Tracker.
  30 class ttRegistrator {
  31   var $user_name = null;  // User name.
  32   var $login = null;      // User login.
  33   var $password = null;   // User password.
  34   var $email = null;      // User email.
  35   var $group_name = null; // Group name.
  36   var $currency = null;   // Currency.
  37   var $lang = null;       // Language.
  38   var $group_id = null;   // Group id, set after we create a group.
  39   var $role_id = null;    // Role id for top managers.
  40   var $user_id = null;    // User id after registration.
  41   var $err = null;        // Error object, passed to us as reference.
  42                           // We use it to communicate errors to caller.
  43
  44   // Constructor.
  45   function __construct($fields, &$err) {
  46     $this->user_name = $fields['user_name'];
  47     $this->login = $fields['login'];
  48     $this->password1 = $fields['password1'];
  49     $this->password2 = $fields['password2'];
  50     $this->email = $fields['email'];
  51     $this->group_name = $fields['group_name'];
  52     $this->currency = $fields['currency'];
  53     $this->lang = $fields['lang'];
  54     if (!$this->lang) $this->lang = 'en';
  55     $this->err = $err;
  56
  57     // Validate passed in parameters.
  58     $this->validate();
  59   }
  60
  61   function validate() {
  62     global $i18n;
  63
  64     if (!ttValidString($this->group_name, true))
  65       $this->err->add($i18n->get('error.field'), $i18n->get('label.group_name'));
  66     if (!ttValidString($this->currency, true))
  67       $this->err->add($i18n->get('error.field'), $i18n->get('label.currency'));
  68     if (!ttValidString($this->user_name))
  69       $this->err->add($i18n->get('error.field'), $i18n->get('label.manager_name'));
  70     if (!ttValidString($this->login))
  71       $this->err->add($i18n->get('error.field'), $i18n->get('label.manager_login'));
  72     if (!ttValidString($this->password1))
  73       $this->err->add($i18n->get('error.field'), $i18n->get('label.password'));
  74     if (!ttValidString($this->password2))
  75       $this->err->add($i18n->get('error.field'), $i18n->get('label.confirm_password'));
  76     if ($this->password1 !== $this->password2)
  77       $this->err->add($i18n->get('error.not_equal'), $i18n->get('label.password'), $i18n->get('label.confirm_password'));
  78     if (!ttValidEmail($this->email, true))
  79       $this->err->add($i18n->get('error.field'), $i18n->get('label.email'));
  80   }
  81
  82   // The register function registers a user in Time Tracker.
  83   function register() {
  84     if ($this->err->yes()) return false; // There are errors, do not proceed.
  85
  86     global $i18n;
  87     global $user;
  88
  89     // Protection from too many recent bot registrations from user IP.
  90     if (!$user->can('administer_site')) { // No problems for site admin.
  91       if ($this->registeredRecently()) {
  92         $this->err->add($i18n->get('error.access_denied'));
  93         return false;
  94       }
  95     }
  96
  97     import('ttUserHelper');
  98     if (ttUserHelper::getUserByLogin($this->login)) {
  99       // User login already exists.
 100       $this->err->add($i18n->get('error.user_exists'));
 101       return false;
 102     }
 103
 104     // Create a new group.
 105     $this->group_id = $this->createGroup();
 106     if (!$this->group_id) {
 107       $this->err->add($i18n->get('error.db'));
 108       return false;
 109     }
 110
 111     import('ttRoleHelper');
 112     if (!ttRoleHelper::createPredefinedRoles($this->group_id, $this->lang)) {
 113       $err->add($i18n->get('error.db'));
 114       return false;
 115     }
 116     $this->role_id = ttRoleHelper::getTopManagerRoleID();
 117     $this->user_id = $this->createUser();
 118
 119     if (!$this->user_id) {
 120       $err->add($i18n->get('error.db'));
 121       return false;
 122     }
 123
 124     // Set created_by appropriately (admin or self).
 125     $created_by = $user->can('administer_site') ? $user->id : $this->user_id;
 126     if (!$this->setCreatedBy($created_by))
 127       return false;
 128
 129     return true;
 130   }
 131
 132   // The createGroup function creates a group in Time Tracker as part
 133   // of user registration process. This is a top group for user as top manager.
 134   function createGroup() {
 135     $mdb2 = getConnection();
 136
 137     $name = $mdb2->quote($this->group_name);
 138     $currency = $mdb2->quote($this->currency);
 139     $lang = $mdb2->quote($this->lang);
 140     $created = 'now()';
 141     $created_ip = $mdb2->quote($_SERVER['REMOTE_ADDR']);
 142
 143     $sql = "insert into tt_groups (name, currency, lang, created, created_ip) values($name, $currency, $lang, $created, $created_ip)";
 144     $affected = $mdb2->exec($sql);
 145     if (is_a($affected, 'PEAR_Error')) return false;
 146
 147     $group_id = $mdb2->lastInsertID('tt_groups', 'id');
 148
 149     // Update org_id with group_id.
 150     $sql = "update tt_groups set org_id = $group_id where org_id is NULL and id = $group_id";
 151     $affected = $mdb2->exec($sql);
 152     if (is_a($affected, 'PEAR_Error')) return false;
 153
 154     return $group_id;
 155   }
 156
 157   // The createUser creates a user in database as part of registration process.
 158   function createUser() {
 159     $mdb2 = getConnection();
 160
 161     $login = $mdb2->quote($this->login);
 162     $password = 'md5('.$mdb2->quote($this->password1).')';
 163     $name = $mdb2->quote($this->user_name);
 164     $email = $mdb2->quote($this->email);
 165     $created = 'now()';
 166     $created_ip = $mdb2->quote($_SERVER['REMOTE_ADDR']);
 167     $values = "values($login, $password, $name, $this->group_id, $this->group_id, $this->role_id, $email, $created, $created_ip)";
 168
 169     $sql = 'insert into tt_users (login, password, name, group_id, org_id, role_id, email, created, created_ip) '.$values;
 170     $affected = $mdb2->exec($sql);
 171     if (!is_a($affected, 'PEAR_Error')) {
 172       $user_id = $mdb2->lastInsertID('tt_users', 'id');
 173       return $user_id;
 174     }
 175     return false;
 176   }
 177
 178   // The setCreatedBy sets created_by field for both group and user to passed in user_id.
 179   function setCreatedBy($user_id) {
 180     if ($this->err->yes()) return false; // There are errors, do not proceed.
 181
 182     global $i18n;
 183     $mdb2 = getConnection();
 184
 185     // Update group.
 186     $sql = "update tt_groups set created_by = $user_id where id = $this->group_id";
 187     $affected = $mdb2->exec($sql);
 188     if (is_a($affected, 'PEAR_Error')) {
 189       $this->err->add($i18n->get('error.db'));
 190       return false;
 191     }
 192
 193     // Update top manager.
 194     $sql = "update tt_users set created_by = $user_id where id = $this->user_id and group_id = $this->group_id";
 195     $affected = $mdb2->exec($sql);
 196     if (is_a($affected, 'PEAR_Error')) {
 197       $this->err->add($i18n->get('error.db'));
 198       return false;
 199     }
 200
 201     return true;
 202   }
 203
 204   // registeredRecently determines if we already have a successful recent registration from user IP.
 205   // "recent" means "within the last minute" and is set in a query by the following condition:
 206   // "and created > now() - interval 1 minute". Change if necessary.
 207   function registeredRecently() {
 208     $mdb2 = getConnection();
 209
 210     $ip_part = ' created_ip = '.$mdb2->quote($_SERVER['REMOTE_ADDR']);
 211     $sql = 'select created from tt_groups where '.$ip_part.' and created > now() - interval 1 minute';
 212     $res = $mdb2->query($sql);
 213     if (is_a($res, 'PEAR_Error'))
 214       return false;
 215     $val = $res->fetchRow();
 216     if ($val)
 217       return true;
 218
 219     return false;
 220   }
 221 }