1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/dolibarr_ynh.git synced 2024-09-03 18:35:53 +02:00
dolibarr_ynh/sources/dolibarr/htdocs/includes/restler/User.php
Laurent Peuch e6008fc691 init
2015-09-28 22:09:38 +02:00

100 lines
2.9 KiB
PHP

<?php
namespace Luracast\Restler;
/**
* Information gathered about the api user is kept here using static methods
* and properties for other classes to make use of them.
* Typically Authentication classes populate them
*
* @category Framework
* @package restler
* @author R.Arul Kumaran <arul@luracast.com>
* @copyright 2010 Luracast
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @link http://luracast.com/products/restler/
* @version 3.0.0rc5
*/
class User implements iIdentifyUser
{
private static $initialized = false;
public static $id = null;
public static $cacheId = null;
public static $ip;
public static $browser = '';
public static $platform = '';
public static function init()
{
static::$initialized = true;
static::$ip = static::getIpAddress();
}
public static function getUniqueIdentifier($includePlatform = false)
{
if (!static::$initialized) static::init();
return static::$id ? : base64_encode('ip:' . ($includePlatform
? static::$ip . '-' . static::$platform
: static::$ip
));
}
public static function getIpAddress($ignoreProxies = false)
{
foreach (array('HTTP_CLIENT_IP', 'HTTP_X_FORWARDED_FOR',
'HTTP_X_FORWARDED', 'HTTP_X_CLUSTER_CLIENT_IP',
'HTTP_FORWARDED_FOR', 'HTTP_FORWARDED',
'REMOTE_ADDR') as $key) {
if (array_key_exists($key, $_SERVER) === true) {
foreach (explode(',', $_SERVER[$key]) as $ip) {
$ip = trim($ip); // just to be safe
if (filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4
| FILTER_FLAG_NO_PRIV_RANGE
| FILTER_FLAG_NO_RES_RANGE) !== false
) {
return $ip;
}
}
}
}
}
/**
* Authentication classes should call this method
*
* @param string $id user id as identified by the authentication classes
*
* @return void
*/
public static function setUniqueIdentifier($id)
{
static::$id = $id;
}
/**
* User identity to be used for caching purpose
*
* When the dynamic cache service places an object in the cache, it needs to
* label it with a unique identifying string known as a cache ID. This
* method gives that identifier
*
* @return string
*/
public static function getCacheIdentifier()
{
return static::$cacheId ?: static::$id;
}
/**
* User identity for caching purpose
*
* In a role based access control system this will be based on role
*
* @param $id
*
* @return void
*/
public static function setCacheIdentifier($id)
{
static::$cacheId = $id;
}
}