Subversion Repositories php_users

Rev

Rev 10 | Rev 16 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
10 rodolico 1 
====== PHP Users Class ======
2 
 
3 
I got frustrated trying to find a class or library to authenticate user logins in PHP. The ones I found were either too simplistic, or required me to "join" some project just to have access to purportedly open source software.
4 
 
5 
So, I decided to dust off the neurons and see if I could build one. I decided to make it as flexible as possible, with only the very basics, but able to be enhanced via data calls. I also decided to make the data access independent of the class itself so data access classes could be (re)written for tasks other than MySQL using the mysqli library.
6 
 
6 rodolico 7 
By itself, the users class (with a data access class usersDataSource like the included UsersDataSourceMySQLi class) handles basic login/logout/editing functions.
4 rodolico 8 
 
9 
The class(es) were, however, designed for extensibility and customization in mind. Some design considerations were made with this in mind.
10 
 
10 rodolico 11 
NOTE: This code uses the ternary and null coelescing shortcuts ?: and ??. I THINK these were introduced in PHP 5.3, but not sure. This code will not work on versions which do not have these shortcuts. See https://www.php.net/manual/en/language.operators.comparison.php
4 rodolico 12 
 
6 rodolico 13 
You can get a copy of this from our subversion repository
10 rodolico 14 
<code bash>
6 rodolico 15 
svn co http://svn.dailydata.net/svn/php_users/stable php_users
10 rodolico 16 
</code>
6 rodolico 17 
My working copy is at
18 
http://svn.dailydata.net/svn/php_users/trunk
19 
but I recommend NOT using that as I use trunk as my personal playground and will commit broken code to it regularly
20 
 
10 rodolico 21 
==== Basic System ====
4 rodolico 22 
 
23 
With no modification, the system will store username, password and two booleans, isAdmin and enabled. The default table is created as
24 
 
25 
<code sql>
26 
create or replace table _users (
27 
   _user_id    int unsigned not null auto_increment,
28 
   login       varchar(64),
29 
   password    varchar(128),
10 rodolico 30 
   isAdmin     boolean DEFAULT 1,
31 
   enabled     boolean DEFAULT 1,
4 rodolico 32 
   primary key (_user_id)
33 
);
34 
</code>
35 
 
10 rodolico 36 
  * login is filtered to alpha-numerics and the underscore character
37 
  * password is stored as a hash using PHP's password_hash
38 
  * users with isAdmin set will be able to add/edit other users
39 
  * users with enabled set to false (0) will not be able to log in
4 rodolico 40 
 
6 rodolico 41 
NOTE: the usersDataSource class has a public function, buildTable, which will build the table, so installation involves simply calling that function.
4 rodolico 42 
 
43 
IMPORTANT: to allow the Users class to work with a wide variety of data types, it does no data access itself. It requires a data access class.
44 
 
45 
Basic use in a script involves instantiating a data access class object, then instantiating a Users class object.
46 
 
47 
Example:
48 
 
49 
<code php>
50 
<?php
51 
   include_once( 'UsersDataSourceMySQLi.class.php' );
52 
   include_once( 'Users.class.php' );
53 
   session_start();
54 
   $connection = new usersDataSource(
55 
         null,
56 
         null,
57 
         array( 'username' => 'test', 'password' => 'test', 'database' => 'test' )
58 
      );
59 
   //$connection->buildTable( 'admin', 'admin' ); die;
60 
   // ensure we always have a (possibly invalid) instance of user
61 
   if ( ! isset( $_SESSION['user'] ) ) {
62 
      $_SESSION['user'] = new Users( );
63 
   }
64 
?>
65 
<html>
66 
   <body>
67 
      <div class="login">
68 
         <?php
69 
            if ( isset( $_SESSION['user'] ) )
70 
               print $_SESSION['user']->HTML($connection);
71 
         ?>
72 
      </div>
73 
   </body>
74 
</html>
75 
</code>
76 
 
6 rodolico 77 
This example is using the usersDataSource definition of  data access (included)
4 rodolico 78 
 
79 
If you run it the first time with <code php>$connection->buildTable( 'admin', 'admin' ); die;</code> uncommented, it will build the table. Comment that line out on the next run and you will be presented with a login screen.
80 
 
81 
Class function HTML() displays various things to allow login, then quits displaying anything. Setting $_REQUEST['logout'] = 1 before calling HTML() will initiate a log out which will destroy the session variable
82 
 
10 rodolico 83 
==== Full Functionality ====
4 rodolico 84 
 
85 
Calling the class method admin and displaying the repeatedly will generate output allowing the user to change their username, password and any other fields which do not have the 'restrict' attribute set to true
86 
 
87 
If the user has admin rights set, it will also display a list of logins and allow you to select one to edit or, add a new user. Editing someone else shows all fields, whether or not the 'restrict' attribute is set to true.
88 
 
10 rodolico 89 
==== CSS ====
4 rodolico 90 
 
10 rodolico 91 
I tried to not put any HTML layout into the code, relying instead on CSS (Thanks, Randell). Everything is supposed to have a class and be wrapped in a <div> with a class. Following are the classes I have in the code (I THINK).
4 rodolico 92 
* login_field = This is the class of all INPUT fields, and div's surrounding them
93 
* login_form  = the class for all <form definitions
94 
* login_list  = the class of the unsigned list (ul) which displays the links to edit other users for admin's
95 
* login       = NOT in code, but used in example as a div around the div around the login area
96 
 
10 rodolico 97 
==== Extended Functionality ====
4 rodolico 98 
 
99 
First, everything is pretty basic. I tried to limit the number of fields to the absolute minimum, but also set it up to allow additional fields to be added programmatically. The example does this.
100 
 
101 
If you open the class source, you'll find the private member $dbDefinition, which defines everything in the code (I hope). When you create a new instance, you can pass the constructor an array which will be merged with this member, optionally increasing the number and definition of the fields.
102 
 
6 rodolico 103 
WARNING: if you add new fields to the Users class, you must also add them to class usersDataSource. See below
4 rodolico 104 
 
105 
Let's add a new field, say we want to store the users e-mail address. In our PHP, create an array as follows:
106 
 
107 
<code php>
108 
   $customFields = array(
109 
      'tables' => array(
110 
         'users' => array(
111 
            'fields' => array(
112 
               'email' => array(
113 
                     // == For Users class ==
114 
                     // this will be the display label on the form
115 
                     'label'  => 'E-Mail',
116 
                     // the input type to use for data entry
117 
                     'html type' => 'text',
118 
                     // you can only edit this if an admin and changing someone
119 
                     // else' record
120 
                     'restrict' => false,
121 
                     // will be displayed on a hover in HTML5 (ie, title=)
122 
                     'instructions' => 'Enter your e-mail address (WARNING, not verified)',
123 
                     // this is entered in an empty box, ie placeholder=
124 
                     'hint'     => 'E-Mail Address',
125 
                     // a regex to run it against to verify it is ok
11 rodolico 126 
                     'filter'   => '/^[-_a-z0-9.]+@[_a-z0-9]+\.[a-z0-9]+$/i',
4 rodolico 127 
 
128 
                     // == for Data Source ==
129 
                     'dbColumn'  =>  'email',
130 
                     // actual mySQL column type
131 
                     'type'      => 'varchar(64)',
132 
                     // set it to not null if we build the table ourselves
133 
                     'required'  => false
134 
                     )
135 
                  )
136 
               )
137 
            )
138 
      );
139 
 ?>
140 
 </code>
141 
 
6 rodolico 142 
 Now, when we instantiate a new object of class Users AND class usersDataSource, we simply pass this array in.
4 rodolico 143 
 
144 
 <code php>
145 
    $connection = new usersDataSource(
146 
         null,
147 
         $customFields,
148 
         array( 'username' => 'test', 'password' => 'test', 'database' => 'test' )
149 
      );
150 
   if ( ! isset( $_SESSION['user'] ) ) {
151 
      $_SESSION['user'] = new Users( $customFields );
152 
   }
10 rodolico 153 
</code>
4 rodolico 154 
 
6 rodolico 155 
Note that since we replicated the basic structure of $dbDefinition in Users and usersDataSource, we can use the same hash to pass into both; they will store, but ignore values not relevant to them.
4 rodolico 156 
 
157 
When the usersDataSource and Users objects are created, $customFields will be merged, with duplicates overwritten by the $customFields value.
158 
 
159 
This is not limited to adding new columns; you can modify the display definitions also, ie how the information is stored on the screen, to some extent.
6 rodolico 160 
 
10 rodolico 161 
=== New Column Definitions ===
162 
 
163 
Note: If a new column is defined with the name (see below) of 'last password change', anytime a password is changed, it will be updated to the current date/time in YYYYMMDDHHMMSS format, which can be directly plugged into MySQL. The code is in there, but to not overpopulate the tables with columns that may not be necessary, I did not include this column in the default table structure.
164 
 
165 
The structure of a new column only requires a value for
166 
  * type
167 
  * html type
168 
  * dbColumn
169 
Defaults (generally empty strings) will be used for anything else.
170 
 
171 
== key name ==
172 
The key is used throughout the program to identify what column we are working on. It can be any value that can be used as a PHP hash key.
173 
 
174 
== html type (required) ==
175 
This determines how the field is displayed and processed during editing. Accepted values are:
176 
  * text - standard text input field, corresponds to SQL varchar or char field
177 
  * textarea - multi-line strings of arbitrary lenght, corresponds to mysql text field
178 
  * boolean - displayed as checkbox, corresponds to mysql bool and/or tinyint (ie, 0 and 1 only)
179 
  * password - displayed as a type='password' field, not pre-populated or displayed when typing. Uses varchar(128) in mysql for the length of the hash created
180 
Any value not in the list above will probably result in weird errors.
181 
 
182 
== dbColumn (required) ==
183 
This is the column name in the database for this field, and all sql uses this value when accessing a column.
184 
 
185 
== type (required for creating tables) ==
186 
this is a valid MySQL database type used by the buildTable function to create the table, ie varchar, char,
187 
 
188 
== label ==
189 
If set, will be the label for the input screens. If not defined, the label defaults to the key.
190 
 
191 
== instructions ==
192 
Replaces the html TITLE attribute for an INPUT, which is displayed by default on a hover. If not set, defaults to an empty string.
193 
 
194 
== hint ==
195 
Placed in the PLACEHODER attribute for an INPUT. Displayed in an empty text field most of the time. If not set, defaults to an empty string.
196 
 
197 
== restrict ==
198 
If set to true, will not be displayed when a user is editing their own record (so, not updateable by a user). Examples would be admin and enabled, which would not be something a user should change themselves. If an admin is editing a different user, these fields are available.
199 
 
200 
== filter ==
11 rodolico 201 
If set, this is assumed to be a regular express. The result of the input is checked against the regex. If it does not match the regex, the update is declined and an error message displayed. By default, the username can only be alpha-numeric and an underscore, so the regex '/^[a-zA-Z0-9_]+$/' is set as the filter. If a user puts a period in their password, it will be rejected. Validity of the regex is not checked.
10 rodolico 202 
 
203 
== size ==
204 
For database creation, if set, will create a column (like varchar) with this size, ie size='128' in a varchar field will result in varchar(128)
205 
 
206 
== required ==
207 
For database creation, sets the NOT NULL attribute to the column
208 
 
209 
== default ==
210 
For database creation, sets the DEFAULT attribute for the column
211 
 
6 rodolico 212 
==== usersDataSource ====
213 
 
214 
This is our data access class. It really doesn't matter what it is called, though I plan to call it the same when I add more data access objects.
215 
 
216 
This code accesses the data (duh), and is consistently called $connection in the Users class. The only requirement is that it must be able to implement the following functions
217 
 
218 
getPassword( $username ) returns encrypted password
219 
getRecord( $username ) returns array containing the values for a user
220 
getAllUsers() returns an array of all user id's and names
221 
getARecord( array of key value pairs to limit what is retrieved ) returns all values
222 
update( array of key value pairs ) returns true/false on success/failure
223 
 
224 
It is also nice is it can A) handle new columns and B) create and initialize the necessary storage
225 
 
226 
I separated this out from the Users class because not all programs need database access. For instance, the favorites_urls app uses file based storage, so by writing a new access class for it, we will hopefully be able to get the same functionality, but with a different storage back end.
227 
 
228 
==== Future ====
10 rodolico 229 
  * I think I have a way of making it match things like INPUT TYPE='color' and INPUT TYPE='email'. I'm going to check that out.
230 
  * This is only the initial part of this particular project. I now intend to extend both classes to allow boolean permissions which will be integrated into our new version of CAMP, giving very granular rights to users. It will be available as a second set of files in this repository and is planned for release by October 2021.