Classes/class-paneluser.php

   1 <?php
   2 /** Relating to Panel Access: Can add, delete and edit users. Big boss. */
   3 define('PERMISSION_MANAGE_USERS', 'manage_users');
   4 /** Relating to Users tab: Can ban users connected to IRC */
   5 define('PERMISSION_BAN_USERS', 'ban_users');
   6 /** Change properties of a user, i.e. vhost, modes and more */
   7 define('PERMISSION_EDIT_USER', 'edit_user');
   8 /** Change properties of a channel, i.e. topic, modes and more */
   9 define('PERMISSION_EDIT_CHANNEL', 'edit_channel');
  10 /** Change properties of a user on a channel i.e give/remove voice or ops and more */
  11 define('PERMISSION_EDIT_CHANNEL_USER', 'edit_channel_user');
  12 /** Can add manual bans, including G-Lines, Z-Lines and more */
  13 define('PERMISSION_SERVER_BAN_ADD', 'tkl_add');
  14 /** Can remove set bans, including G-Lines, Z-Lines and more */
  15 define('PERMISSION_SERVER_BAN_DEL', 'tkl_del');
  16 /** Can add Name Bans (Q-Lines) */
  17 define('PERMISSION_NAME_BAN_ADD', 'nb_add');
  18 /** Can delete Name Bans (Q-Lines) */
  19 define('PERMISSION_NAME_BAN_DEL', 'nb_del');
  20 /** Can add ban exceptions (E-Lines) */
  21 define('PERMISSION_BAN_EXCEPTION_ADD', 'be_add');
  22 /** Can delete ban exceptions (E-Lines) */
  23 define('PERMISSION_BAN_EXCEPTION_DEL', 'be_del');
  24 /** Can add spamfilter entries */
  25 define('PERMISSION_SPAMFILTER_ADD', 'sf_add');
  26 /** Can delete spamfilter entries */
  27 define('PERMISSION_SPAMFILTER_DEL', 'sf_del');
  28 /** Can rehash servers */
  29 define('PERMISSION_REHASH', 'rhs');
  30 /**
  31  * PanelUser
  32  * This is the User class for the SQL_Auth plugin
  33  */
  34 class PanelUser
  35 {
  36         public $id = NULL;
  37         public $username = NULL;
  38         private $passhash = NULL;
  39         public $first_name = NULL;
  40         public $last_name = NULL;
  41         public $created = NULL;
  42         public $user_meta = [];
  43         public $bio = NULL;
  44         public $email = NULL;
  45
  46         /**
  47          * Find a user in the database by name or ID
  48          * @param string $name
  49          * @param mixed $id
  50          */
  51         function __construct(string $name = NULL, int $id = NULL)
  52         {
  53                 $user["name"] = $name;
  54                 $user["id"] = $id;
  55                 $user["object"] = NULL;
  56                 Hook::run(HOOKTYPE_USER_LOOKUP, $user);
  57                 foreach ($user['object'] as $key => $value)
  58                         $this->$key = $value;
  59         }
  60
  61         /**
  62          * Verify a user's password
  63          * @param string $input
  64          * @return bool
  65          */
  66         function password_verify(string $input) : bool
  67         {
  68                 if (password_verify($input, $this->passhash))
  69                         return true;
  70                 return false;
  71         }
  72
  73         /**
  74          * Add user meta data
  75          * @param string $key
  76          * @param string $value
  77          */
  78         function add_meta(string $key, string $value)
  79         {
  80
  81                 if (!$key || !$value)
  82                         return false;
  83
  84                 $meta = [
  85                         "id" => $this->id,
  86                         "key" => $key,
  87                         "value" => $value
  88                 ];
  89
  90                 $array['meta'] = $meta;
  91                 $array['user'] = $this;
  92                 Hook::run(HOOKTYPE_USERMETA_ADD, $array);
  93
  94         }
  95
  96         /**
  97          * Delete user meta data by key
  98          * @param string $key
  99          */
 100         function delete_meta(string $key)
 101         {
 102                 if (!$key )
 103                         return false;
 104
 105                 $meta = [
 106                         "id" => $this->id,
 107                         "key" => $key,
 108                 ];
 109                 Hook::run(HOOKTYPE_USERMETA_DEL, $meta);
 110
 111         }
 112
 113         /** PERMISSIONS */
 114
 115         function add_permission($permission)
 116         {
 117                 $meta = (isset($this->user_meta['permissions'])) ? unserialize($this->user_meta['permissions']) : [];
 118                 if (!in_array($permission,$meta))
 119                         $meta[] = $permission;
 120                 $this->add_meta("permissions", serialize($meta)); // updet de dettabess
 121                 $this->user_meta['permissions'] = serialize($meta); // put it back in our object in case it still needs to be used
 122         }
 123         function delete_permission($permission)
 124         {
 125                 $meta = (isset($this->user_meta['permissions'])) ? unserialize($this->user_meta['permissions']) : [];
 126                 foreach($meta as $key => $value)
 127                 {
 128                         if (!strcmp($permission, $value))
 129                                 unset($meta[$key]);
 130                 }
 131                 $this->add_meta("permissions", serialize($meta));
 132                 $this->user_meta['permissions'] = serialize($meta);
 133         }
 134
 135         /** Updates core user info.
 136          * CAUTION: Updating a non-existent column will crash
 137          * your shit
 138          */
 139         function update_core_info($array)
 140         {
 141                 $arr = ['info' => $array, 'user' => $this];
 142                 Hook::run(HOOKTYPE_EDIT_USER, $arr);
 143         }
 144 }
 145
 146
 147 /**
 148  * This class looks up and returns any user meta.
 149  * This is used by PanelUser, so you won't need to
 150  * call it separately from PanelUser.
 151  */
 152 class PanelUser_Meta
 153 {
 154         public $list = [];
 155         function __construct($id)
 156         {
 157                 $array = [];
 158                 $arr["id"] = $id;
 159                 $arr['meta'] = &$array;
 160                 Hook::run(HOOKTYPE_USERMETA_GET, $arr);
 161                 $this->list = $arr['meta'];
 162
 163         }
 164 }
 165
 166 /**
 167  * Array of user
 168  *
 169  * Required:
 170  * user_name
 171  * user_pass
 172  *
 173  * Optional:
 174  * user_fname
 175  * user_lname
 176  *
 177  * @param array $user
 178  * @throws Exception
 179  * @return bool
 180  */
 181 function create_new_user(array &$user) : bool
 182 {
 183         if (!isset($user['user_name']) || !isset($user['user_pass']))
 184                 throw new Exception("Attempted to add user without specifying user_name or user_pass");
 185
 186         $user['user_name'] = htmlspecialchars($user['user_name']);
 187         $user['user_pass'] = password_hash($user['user_pass'], PASSWORD_ARGON2ID);
 188         $user['fname'] = (isset($user['fname'])) ? htmlspecialchars($user['fname']) : NULL;
 189         $last['lname'] = (isset($user['lname'])) ? htmlspecialchars($user['lname']) : NULL;
 190         $user['user_bio'] = (isset($user['user_bio'])) ? htmlspecialchars($user['user_bio']) : NULL;
 191         $user['email'] = (isset($user['user_email'])) ? htmlspecialchars($user['user_email']) : NULL;
 192
 193         if (($u = new PanelUser($user['user_name']))->id)
 194         {
 195                 $user['err'] = "User already exists";
 196                 return false;
 197         }
 198         // internal use
 199         $user['success'] = false;
 200         $user['errmsg'] = [];
 201
 202         Hook::run(HOOKTYPE_USER_CREATE, $user);
 203         if (!$user['success'])
 204                 return false;
 205
 206         return true;
 207 }
 208
 209 /**
 210  * Gets the user object for the current session
 211  * @return PanelUser|bool
 212  */
 213 function unreal_get_current_user() : PanelUser|bool
 214 {
 215         if (!isset($_SESSION))
 216         {
 217                 session_set_cookie_params(3600);
 218                 session_start();
 219         }
 220         if (isset($_SESSION['id']))
 221         {
 222                 $user = new PanelUser(NULL, $_SESSION['id']);
 223                 if ($user->id)
 224                         return $user;
 225         }
 226         return false;
 227 }
 228
 229 /**
 230  * Checks if a user can do something
 231  * @param string $permission
 232  * @return bool
 233  */
 234 function current_user_can($permission) : bool
 235 {
 236         if (!is_auth_provided()) // if there is no auth plugin, assume the user handles logins themselves
 237                 return true;
 238         $user = unreal_get_current_user();
 239         if (!$user)
 240                 return false;
 241         return user_can($user, $permission);
 242 }
 243
 244 /**
 245  * Checks if a user can do something
 246  * @param string $permission
 247  * @return bool
 248  */
 249 function user_can(PanelUser $user, $permission) : bool
 250 {
 251         if (!$user)
 252                 return false;
 253
 254         if (isset($user->user_meta['permissions']))
 255         {
 256                 $perms = unserialize($user->user_meta['permissions']);
 257                 if (in_array($permission, $perms))
 258                         return true;
 259         }
 260         return false;
 261 }
 262
 263 /**
 264  * Delete a user and related meta
 265  * @param int $id The ID of the user in the SQL database.
 266  * @param array $info This will fill with a response.
 267  * @return int
 268  *
 269  * Return values:
 270  *  1   The user was successfully deleted.
 271  *  0   The user was not found
 272  *  -1  The admin does not have permission to delete users [TODO]
 273  */
 274 function delete_user(int $id, &$info = []) : int
 275 {
 276         $user = new PanelUser(NULL, $id);
 277         if (!$user->id) {
 278                 $info[] = "Could not find user";
 279                 return 0;
 280         }
 281         $arr = ["user" => $user, "info" => &$info, "boolint" => 0];
 282         Hook::run(HOOKTYPE_USER_DELETE, $arr);
 283         return $arr["boolint"];
 284 }
 285
 286 function get_panel_user_permission_list()
 287 {
 288         $list = [
 289                 "Can add/delete/edit Admin Panel users" => PERMISSION_MANAGE_USERS,
 290                 "Can ban/kill IRC users" => PERMISSION_BAN_USERS,
 291                 "Can change properties of a user, i.e. vhost, modes and more" => PERMISSION_EDIT_USER,
 292                 "Can change properties of a channel, i.e. topic, modes and more" => PERMISSION_EDIT_CHANNEL,
 293                 "Can change properties of a user on a channel i.e give/remove voice or ops and more" => PERMISSION_EDIT_CHANNEL_USER,
 294                 "Can add manual bans, including G-Lines, Z-Lines and more" => PERMISSION_SERVER_BAN_ADD,
 295                 "Can remove set bans, including G-Lines, Z-Lines and more" => PERMISSION_SERVER_BAN_DEL,
 296                 "Can forbid usernames and channels" => PERMISSION_NAME_BAN_ADD,
 297                 "Can unforbid usernames and channels" => PERMISSION_NAME_BAN_DEL,
 298                 "Can add server ban exceptions" => PERMISSION_BAN_EXCEPTION_ADD,
 299                 "Can remove server ban exceptions" => PERMISSION_BAN_EXCEPTION_DEL,
 300                 "Can add Spamfilter entries" => PERMISSION_SPAMFILTER_ADD,
 301                 "Can remove Spamfilter entries" => PERMISSION_SPAMFILTER_DEL
 302         ];
 303         Hook::run(HOOKTYPE_USER_PERMISSION_LIST, $list); // so plugin writers can add their own permissions
 304         return $list;
 305 }
 306
 307 function generate_panel_user_permission_table($user)
 308 {
 309
 310         $list = get_panel_user_permission_list();
 311         foreach($list as $desc => $slug)
 312         {
 313                 $attributes = "";
 314                 $attributes .= (current_user_can(PERMISSION_MANAGE_USERS)) ? "" : "disabled ";
 315                 ?>
 316                 <div class="input-group">
 317                         <div class="input-group-prepend">
 318                                 <div class="input-group-text">
 319                                         <input <?php
 320                                                 $attributes .= (user_can($user, $slug)) ? "checked" : "";
 321                                                 echo $attributes;
 322                                         ?> name="permissions[]" value="<?php echo $slug; ?>" type="checkbox">
 323                                 </div>
 324                         </div>
 325                         <input type="text" readonly  class="form-control" value="<?php echo "$desc ($slug)"; ?>">
 326                 </div>
 327
 328                 <?php
 329         }
 330 }