Add migration guide for switch from v1.x.x to v2.x.x

.editorconfig

@@ -7,3 +7,7 @@ indent_style = tab
 trim_trailing_whitespace = true
 end_of_line = lf
 insert_final_newline = true
+
+[*.md]
+indent_style = space
+indent_size = 4

Database/MySQL.sql

@@ -1,25 +1,25 @@
 CREATE TABLE IF NOT EXISTS `users` (
   `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
-  `email` varchar(254) NOT NULL,
+  `email` varchar(249) COLLATE utf8mb4_unicode_ci NOT NULL,
   `password` varchar(255) CHARACTER SET latin1 COLLATE latin1_general_cs NOT NULL,
-  `username` varchar(100) DEFAULT NULL,
+  `username` varchar(100) COLLATE utf8mb4_unicode_ci DEFAULT NULL,
   `verified` tinyint(1) unsigned NOT NULL DEFAULT '0',
   `registered` int(10) unsigned NOT NULL,
   `last_login` int(10) unsigned DEFAULT NULL,
   PRIMARY KEY (`id`),
   UNIQUE KEY `email` (`email`)
-) ENGINE=MyISAM DEFAULT CHARSET=utf8;
+) ENGINE=MyISAM DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
 
 CREATE TABLE IF NOT EXISTS `users_confirmations` (
   `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
-  `email` varchar(254) NOT NULL,
+  `email` varchar(249) COLLATE utf8mb4_unicode_ci NOT NULL,
   `selector` varchar(16) CHARACTER SET latin1 COLLATE latin1_general_cs NOT NULL,
   `token` varchar(255) CHARACTER SET latin1 COLLATE latin1_general_cs NOT NULL,
   `expires` int(10) unsigned NOT NULL,
   PRIMARY KEY (`id`),
   UNIQUE KEY `selector` (`selector`),
   KEY `email_expires` (`email`,`expires`)
-) ENGINE=MyISAM DEFAULT CHARSET=utf8;
+) ENGINE=MyISAM DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
 
 CREATE TABLE IF NOT EXISTS `users_remembered` (
   `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
@@ -30,7 +30,7 @@ CREATE TABLE IF NOT EXISTS `users_remembered` (
   PRIMARY KEY (`id`),
   UNIQUE KEY `selector` (`selector`),
   KEY `user` (`user`)
-) ENGINE=MyISAM DEFAULT CHARSET=utf8;
+) ENGINE=MyISAM DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
 
 CREATE TABLE IF NOT EXISTS `users_resets` (
   `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
@@ -41,14 +41,14 @@ CREATE TABLE IF NOT EXISTS `users_resets` (
   PRIMARY KEY (`id`),
   UNIQUE KEY `selector` (`selector`),
   KEY `user` (`user`)
-) ENGINE=MyISAM DEFAULT CHARSET=utf8;
+) ENGINE=MyISAM DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
 
 CREATE TABLE IF NOT EXISTS `users_throttling` (
   `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
-  `action_type` enum('login','register','confirm_email') NOT NULL,
+  `action_type` enum('login','register','confirm_email') COLLATE utf8mb4_unicode_ci NOT NULL,
   `selector` varchar(44) CHARACTER SET latin1 COLLATE latin1_general_cs DEFAULT NULL,
   `time_bucket` int(10) unsigned NOT NULL,
   `attempts` mediumint(8) unsigned NOT NULL DEFAULT '1',
   PRIMARY KEY (`id`),
   UNIQUE KEY `action_type_selector_time_bucket` (`action_type`,`selector`,`time_bucket`)
-) ENGINE=MyISAM DEFAULT CHARSET=utf8;
+) ENGINE=MyISAM DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;

Migration.md

@@ -0,0 +1,35 @@
+# Migration
+
+ * `v1.x.x` to `v2.x.x`
+   * The MySQL schema has been changed from charset `utf8` to charset `utf8mb4` and from collation `utf8_general_ci` to collation `utf8mb4_unicode_ci`. Use the statements below to update the database schema:
+
+     ```sql
+     ALTER TABLE `users` CHANGE `email` `email` VARCHAR(249) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL;
+     ALTER TABLE `users_confirmations` CHANGE `email` `email` VARCHAR(249) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL;
+
+     -- ALTER DATABASE `<DATABASE_NAME>` CHARACTER SET = utf8mb4 COLLATE = utf8mb4_unicode_ci;
+
+     ALTER TABLE `users` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
+     ALTER TABLE `users_confirmations` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
+     ALTER TABLE `users_remembered` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
+     ALTER TABLE `users_resets` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
+     ALTER TABLE `users_throttling` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
+
+     ALTER TABLE `users` CHANGE `email` `email` VARCHAR(249) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL;
+     ALTER TABLE `users` CHANGE `username` `username` VARCHAR(100) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NULL DEFAULT NULL;
+
+     ALTER TABLE `users_confirmations` CHANGE `email` `email` VARCHAR(249) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL;
+
+     ALTER TABLE `users_throttling` CHANGE `action_type` `action_type` ENUM('login','register','confirm_email') CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL;
+
+     REPAIR TABLE users;
+     OPTIMIZE TABLE users;
+     REPAIR TABLE users_confirmations;
+     OPTIMIZE TABLE users_confirmations;
+     REPAIR TABLE users_remembered;
+     OPTIMIZE TABLE users_remembered;
+     REPAIR TABLE users_resets;
+     OPTIMIZE TABLE users_resets;
+     REPAIR TABLE users_throttling;
+     OPTIMIZE TABLE users_throttling;
+     ```

README.md

@@ -43,7 +43,7 @@ Completely framework-agnostic and database-agnostic.
 ### Create a new instance
 
 ```php
-// $db = new PDO('mysql:dbname=database;host=localhost;charset=utf8', 'username', 'password');
+// $db = new PDO('mysql:dbname=database;host=localhost;charset=utf8mb4', 'username', 'password');
 // $db->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
 
 $auth = new \Delight\Auth\Auth($db);

src/Auth.php

@@ -118,7 +118,7 @@ class Auth {
 				// if both selector and token were found
 				if (isset($parts[0]) && isset($parts[1])) {
 					$stmt = $this->db->prepare("SELECT a.user, a.token, a.expires, b.email, b.username FROM users_remembered AS a JOIN users AS b ON a.user = b.id WHERE a.selector = :selector");
-					$stmt->bindParam(':selector', $parts[0], \PDO::PARAM_STR);
+					$stmt->bindValue(':selector', $parts[0], \PDO::PARAM_STR);
 					if ($stmt->execute()) {
 						$rememberData = $stmt->fetch(\PDO::FETCH_ASSOC);
 						if ($rememberData !== false) {
@@ -168,16 +168,15 @@ class Auth {
 		}
 
 		$username = isset($username) ? trim($username) : null;
-		$registered = time();
 		$password = password_hash($password, PASSWORD_DEFAULT);
 		$verified = isset($emailConfirmationCallback) && is_callable($emailConfirmationCallback) ? 0 : 1;
 
 		$stmt = $this->db->prepare("INSERT INTO users (email, password, username, verified, registered) VALUES (:email, :password, :username, :verified, :registered)");
-		$stmt->bindParam(':email', $email, \PDO::PARAM_STR);
-		$stmt->bindParam(':password', $password, \PDO::PARAM_STR);
-		$stmt->bindParam(':username', $username, \PDO::PARAM_STR);
-		$stmt->bindParam(':verified', $verified, \PDO::PARAM_INT);
-		$stmt->bindParam(':registered', $registered, \PDO::PARAM_INT);
+		$stmt->bindValue(':email', $email, \PDO::PARAM_STR);
+		$stmt->bindValue(':password', $password, \PDO::PARAM_STR);
+		$stmt->bindValue(':username', $username, \PDO::PARAM_STR);
+		$stmt->bindValue(':verified', $verified, \PDO::PARAM_INT);
+		$stmt->bindValue(':registered', time(), \PDO::PARAM_INT);
 
 		try {
 			$result = $stmt->execute();
@@ -198,7 +197,7 @@ class Auth {
 		if ($result) {
 			// get the ID of the user that we've just created
 			$stmt = $this->db->prepare("SELECT id FROM users WHERE email = :email");
-			$stmt->bindParam(':email', $email, \PDO::PARAM_STR);
+			$stmt->bindValue(':email', $email, \PDO::PARAM_STR);
 
 			if ($result = $stmt->execute()) {
 				$newUserId = $stmt->fetchColumn();
@@ -235,10 +234,10 @@ class Auth {
 		$expires = time() + 3600 * 24;
 
 		$stmt = $this->db->prepare("INSERT INTO users_confirmations (email, selector, token, expires) VALUES (:email, :selector, :token, :expires)");
-		$stmt->bindParam(':email', $email, \PDO::PARAM_STR);
-		$stmt->bindParam(':selector', $selector, \PDO::PARAM_STR);
-		$stmt->bindParam(':token', $tokenHashed, \PDO::PARAM_STR);
-		$stmt->bindParam(':expires', $expires, \PDO::PARAM_INT);
+		$stmt->bindValue(':email', $email, \PDO::PARAM_STR);
+		$stmt->bindValue(':selector', $selector, \PDO::PARAM_STR);
+		$stmt->bindValue(':token', $tokenHashed, \PDO::PARAM_STR);
+		$stmt->bindValue(':expires', $expires, \PDO::PARAM_INT);
 
 		if ($stmt->execute()) {
 			if (isset($emailConfirmationCallback) && is_callable($emailConfirmationCallback)) {
@@ -284,7 +283,7 @@ class Auth {
 		}
 
 		$stmt = $this->db->prepare("SELECT id, password, verified, username FROM users WHERE email = :email");
-		$stmt->bindParam(':email', $email, \PDO::PARAM_STR);
+		$stmt->bindValue(':email', $email, \PDO::PARAM_STR);
 		if ($stmt->execute()) {
 			$userData = $stmt->fetch(\PDO::FETCH_ASSOC);
 			if ($userData !== false) {
@@ -334,10 +333,10 @@ class Auth {
 		$expires = time() + 3600 * 24 * 28;
 
 		$stmt = $this->db->prepare("INSERT INTO users_remembered (user, selector, token, expires) VALUES (:user, :selector, :token, :expires)");
-		$stmt->bindParam(':user', $userId, \PDO::PARAM_INT);
-		$stmt->bindParam(':selector', $selector, \PDO::PARAM_STR);
-		$stmt->bindParam(':token', $tokenHashed, \PDO::PARAM_STR);
-		$stmt->bindParam(':expires', $expires, \PDO::PARAM_INT);
+		$stmt->bindValue(':user', $userId, \PDO::PARAM_INT);
+		$stmt->bindValue(':selector', $selector, \PDO::PARAM_STR);
+		$stmt->bindValue(':token', $tokenHashed, \PDO::PARAM_STR);
+		$stmt->bindValue(':expires', $expires, \PDO::PARAM_INT);
 
 		if ($stmt->execute()) {
 			$this->setRememberCookie($selector, $token, $expires);
@@ -357,7 +356,7 @@ class Auth {
 	 */
 	private function deleteRememberDirective($userId) {
 		$stmt = $this->db->prepare("DELETE FROM users_remembered WHERE user = :user");
-		$stmt->bindParam(':user', $userId, \PDO::PARAM_INT);
+		$stmt->bindValue(':user', $userId, \PDO::PARAM_INT);
 
 		if ($stmt->execute()) {
 			$this->setRememberCookie(null, null, time() - 3600);
@@ -405,11 +404,9 @@ class Auth {
 	 * @param bool $remembered whether the user was remembered ("remember me") or logged in actively
 	 */
 	private function onLoginSuccessful($userId, $email, $username, $remembered) {
-		$lastLogin = time();
-
 		$stmt = $this->db->prepare("UPDATE users SET last_login = :lastLogin WHERE id = :id");
-		$stmt->bindParam(':lastLogin', $lastLogin, \PDO::PARAM_INT);
-		$stmt->bindParam(':id', $userId, \PDO::PARAM_INT);
+		$stmt->bindValue(':lastLogin', time(), \PDO::PARAM_INT);
+		$stmt->bindValue(':id', $userId, \PDO::PARAM_INT);
 		$stmt->execute();
 
 		// re-generate the session ID to prevent session fixation attacks
@@ -483,20 +480,18 @@ class Auth {
 		$this->throttle(self::THROTTLE_ACTION_CONFIRM_EMAIL, $selector);
 
 		$stmt = $this->db->prepare("SELECT id, email, token, expires FROM users_confirmations WHERE selector = :selector");
-		$stmt->bindParam(':selector', $selector, \PDO::PARAM_STR);
+		$stmt->bindValue(':selector', $selector, \PDO::PARAM_STR);
 		if ($stmt->execute()) {
 			$confirmationData = $stmt->fetch(\PDO::FETCH_ASSOC);
 			if ($confirmationData !== false) {
 				if (password_verify($token, $confirmationData['token'])) {
 					if ($confirmationData['expires'] >= time()) {
-						$verified = 1;
-
 						$stmt = $this->db->prepare("UPDATE users SET verified = :verified WHERE email = :email");
-						$stmt->bindParam(':verified', $verified, \PDO::PARAM_INT);
-						$stmt->bindParam(':email', $confirmationData['email'], \PDO::PARAM_STR);
+						$stmt->bindValue(':verified', 1, \PDO::PARAM_INT);
+						$stmt->bindValue(':email', $confirmationData['email'], \PDO::PARAM_STR);
 						if ($stmt->execute()) {
 							$stmt = $this->db->prepare("DELETE FROM users_confirmations WHERE id = :id");
-							$stmt->bindParam(':id', $confirmationData['id'], \PDO::PARAM_INT);
+							$stmt->bindValue(':id', $confirmationData['id'], \PDO::PARAM_INT);
 							if ($stmt->execute()) {
 								return;
 							}
@@ -549,7 +544,7 @@ class Auth {
 			$userId = $this->getUserId();
 
 			$stmt = $this->db->prepare("SELECT password FROM users WHERE id = :userId");
-			$stmt->bindParam(':userId', $userId, \PDO::PARAM_INT);
+			$stmt->bindValue(':userId', $userId, \PDO::PARAM_INT);
 			if ($stmt->execute()) {
 				$passwordInDatabase = $stmt->fetchColumn();
 				if (password_verify($oldPassword, $passwordInDatabase)) {
@@ -580,8 +575,8 @@ class Auth {
 		$newPassword = password_hash($newPassword, PASSWORD_DEFAULT);
 
 		$stmt = $this->db->prepare("UPDATE users SET password = :password WHERE id = :userId");
-		$stmt->bindParam(':password', $newPassword, \PDO::PARAM_STR);
-		$stmt->bindParam(':userId', $userId, \PDO::PARAM_INT);
+		$stmt->bindValue(':password', $newPassword, \PDO::PARAM_STR);
+		$stmt->bindValue(':userId', $userId, \PDO::PARAM_INT);
 		$stmt->execute();
 	}
 
@@ -767,9 +762,9 @@ class Auth {
 		$timeBucket = self::getTimeBucket();
 
 		$stmt = $this->db->prepare('INSERT INTO users_throttling (action_type, selector, time_bucket, attempts) VALUES (:actionType, :selector, :timeBucket, 1)');
-		$stmt->bindParam(':actionType', $actionType, \PDO::PARAM_STR);
-		$stmt->bindParam(':selector', $selector, \PDO::PARAM_STR);
-		$stmt->bindParam(':timeBucket', $timeBucket, \PDO::PARAM_INT);
+		$stmt->bindValue(':actionType', $actionType, \PDO::PARAM_STR);
+		$stmt->bindValue(':selector', $selector, \PDO::PARAM_STR);
+		$stmt->bindValue(':timeBucket', $timeBucket, \PDO::PARAM_INT);
 		try {
 			$stmt->execute();
 		}
@@ -778,9 +773,9 @@ class Auth {
 			if ($e->getCode() == '23000') {
 				// update the old entry
 				$stmt = $this->db->prepare('UPDATE users_throttling SET attempts = attempts+1 WHERE action_type = :actionType AND selector = :selector AND time_bucket = :timeBucket');
-				$stmt->bindParam(':actionType', $actionType, \PDO::PARAM_STR);
-				$stmt->bindParam(':selector', $selector, \PDO::PARAM_STR);
-				$stmt->bindParam(':timeBucket', $timeBucket, \PDO::PARAM_INT);
+				$stmt->bindValue(':actionType', $actionType, \PDO::PARAM_STR);
+				$stmt->bindValue(':selector', $selector, \PDO::PARAM_STR);
+				$stmt->bindValue(':timeBucket', $timeBucket, \PDO::PARAM_INT);
 				$stmt->execute();
 			}
 			// if we have another error
@@ -791,9 +786,9 @@ class Auth {
 		}
 
 		$stmt = $this->db->prepare('SELECT attempts FROM users_throttling WHERE action_type = :actionType AND selector = :selector AND time_bucket = :timeBucket');
-		$stmt->bindParam(':actionType', $actionType, \PDO::PARAM_STR);
-		$stmt->bindParam(':selector', $selector, \PDO::PARAM_STR);
-		$stmt->bindParam(':timeBucket', $timeBucket, \PDO::PARAM_INT);
+		$stmt->bindValue(':actionType', $actionType, \PDO::PARAM_STR);
+		$stmt->bindValue(':selector', $selector, \PDO::PARAM_STR);
+		$stmt->bindValue(':timeBucket', $timeBucket, \PDO::PARAM_INT);
 		if ($stmt->execute()) {
 			$attempts = $stmt->fetchColumn();
 

tests/index.php

@@ -20,7 +20,7 @@ header('Content-type: text/html; charset=utf-8');
 error_reporting(E_ALL);
 ini_set('display_errors', 'stdout');
 
-$db = new PDO('mysql:dbname=php_auth;host=127.0.0.1;charset=utf8', 'root', '');
+$db = new PDO('mysql:dbname=php_auth;host=127.0.0.1;charset=utf8mb4', 'root', '');
 $db->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
 
 require __DIR__.'/../src/Auth.php';