This repository has been archived on 2024-06-26. You can view files and clone it, but cannot push or open issues or pull requests.
sakura/app/ActionCode.php

85 lines
2.1 KiB
PHP
Raw Normal View History

<?php
2016-02-03 22:22:56 +00:00
/**
* Holds the action code handling class.
2016-03-08 23:07:58 +00:00
*
2016-02-03 22:22:56 +00:00
* @package Sakura
*/
namespace Sakura;
/**
2016-02-02 21:04:15 +00:00
* Used to generate one-time keys for user automatic user actions e.g. account activation.
2016-03-08 23:07:58 +00:00
*
* @package Sakura
2016-02-02 21:04:15 +00:00
* @author Julian van de Groep <me@flash.moe>
*/
2015-12-09 20:21:08 +00:00
class ActionCode
{
2016-02-02 21:04:15 +00:00
/**
* Generate an Action Code.
2016-03-08 23:07:58 +00:00
*
2016-02-02 21:04:15 +00:00
* @param string $action The identifier of the action.
* @param int $user The user this action code is intended for (leave 0 for universal).
2016-03-08 23:07:58 +00:00
*
2016-02-02 21:04:15 +00:00
* @return string The action code given to the user.
*/
2016-01-09 21:57:54 +00:00
public static function generate($action, $user = 0)
{
2016-01-09 21:57:54 +00:00
// Generate a code
$code = uniqid();
// Insert it
2016-02-25 16:06:29 +00:00
DB::table('actioncodes')
->insert(
2016-03-17 19:09:00 +00:00
[
'code_action' => $action,
'user_id' => $user,
'action_code' => $code,
]
2016-02-25 16:06:29 +00:00
);
2016-01-09 21:57:54 +00:00
// Return the code
return $code;
}
2016-02-02 21:04:15 +00:00
/**
* Validate an action code.
2016-03-08 23:07:58 +00:00
*
2016-02-02 21:04:15 +00:00
* @param string $action The action identifier.
* @param string $code The action code.
* @param int $user The id of the user validating this code.
* @param bool $invalidate Set if the code should be invalidated once validated.
2016-03-08 23:07:58 +00:00
*
2016-02-02 21:04:15 +00:00
* @return bool Boolean indicating success.
*/
2016-01-09 21:57:54 +00:00
public static function validate($action, $code, $user = 0, $invalidate = true)
{
2016-01-09 21:57:54 +00:00
// Fetch the code from the db
2016-02-25 16:06:29 +00:00
$get = DB::table('actioncodes')
->where('code_action', $action)
->where('action_code', $code)
->where('user_id', $user)
->count();
2016-01-09 21:57:54 +00:00
// Invalidate the code if requested
2016-02-25 16:06:29 +00:00
if ($get && $invalidate) {
2016-01-09 21:57:54 +00:00
self::invalidate($code);
}
// Return the result
2016-02-18 23:28:44 +00:00
return $get > 0;
}
2016-02-02 21:04:15 +00:00
/**
* Make a code invalid.
2016-03-08 23:07:58 +00:00
*
2016-02-02 21:04:15 +00:00
* @param string $code The code that is being invalidated.
*/
2016-01-09 21:57:54 +00:00
public static function invalidate($code)
{
2016-02-25 16:06:29 +00:00
DB::table('actioncodes')
2016-03-19 15:29:47 +00:00
->where('action_code', $code)
2016-02-25 16:06:29 +00:00
->delete();
}
}