mirror of
https://github.com/pierre42100/ComunicAPI
synced 2024-11-23 22:09:29 +00:00
512 lines
14 KiB
PHP
512 lines
14 KiB
PHP
<?php
|
|
/**
|
|
* Main user class
|
|
*
|
|
* @author Pierre HUBER
|
|
*/
|
|
|
|
class User{
|
|
|
|
/**
|
|
* @var String $userTable The name of the user table
|
|
*/
|
|
private $userTable = "utilisateurs";
|
|
|
|
/**
|
|
* @var String $userLoginAPItable The name of the table that contains logins performed on the API
|
|
*/
|
|
private $userLoginAPItable = "";
|
|
|
|
/**
|
|
* Pages visiblity levels
|
|
*/
|
|
const USER_PAGE_PRIVATE = 0;
|
|
const USER_PAGE_PUBLIC = 1;
|
|
const USER_PAGE_OPEN = 2;
|
|
|
|
|
|
/**
|
|
* Public constructor
|
|
*/
|
|
public function __construct(){
|
|
$this->userLoginAPItable = CS::get()->config->get("dbprefix")."API_userLoginToken";
|
|
}
|
|
|
|
/**
|
|
* Try to login user with returning a service token
|
|
*
|
|
* @param string $email The e-mail address of the user
|
|
* @param string $password The password of the user
|
|
* @param int $serviceID The ID of the service
|
|
* @return array Tokens if success, false if fails
|
|
*/
|
|
public function generateUserLoginTokens(string $email, string $password, int $serviceID) : array{
|
|
//Try to find user ID in the database
|
|
$conditions = "WHERE mail = ? AND password = ?";
|
|
$values = array(
|
|
$email,
|
|
$this->cryptPassword($password)
|
|
);
|
|
$userInfos = CS::get()->db->select($this->userTable, $conditions, $values);
|
|
|
|
//Check if there is anything
|
|
if(count($userInfos) == 0)
|
|
return array(); //Not any account was found
|
|
|
|
//Extract first value ID
|
|
$userID = $userInfos[0]['ID'];
|
|
|
|
//Check if any other token already exists
|
|
$existingTokens = $this->getUserLoginTokenByIDs($userID, $serviceID, CS::get()->db);
|
|
|
|
if(is_array($existingTokens)){
|
|
//Return result
|
|
return $existingTokens;
|
|
}
|
|
|
|
//Generate random tokens
|
|
$token1 = random_str(75);
|
|
$token2 = random_str(75);
|
|
|
|
//Insert token in the database
|
|
$tableName = $this->userLoginAPItable;
|
|
$insertValues = array(
|
|
"ID_utilisateurs" => $userID,
|
|
"ID_".CS::get()->config->get("dbprefix")."API_ServicesToken" => $serviceID,
|
|
"token1" => $token1,
|
|
"token2" => $token2
|
|
);
|
|
if(!CS::get()->db->addLine($tableName, $insertValues))
|
|
return array(); //Something went wrong
|
|
|
|
//We can return tokens
|
|
return array($token1, $token2);
|
|
}
|
|
|
|
/**
|
|
* Get token with the help of userID and serviceID
|
|
*
|
|
* @param int $userID The ID of the user
|
|
* @param int $serviceID The ID of the service
|
|
* @return FALSE if it fails, or tokens if success
|
|
*/
|
|
private function getUserLoginTokenByIDs(int $userID, int $serviceID) {
|
|
//Prepare database request
|
|
$conditions = "WHERE ID_utilisateurs = ? AND ID_".CS::get()->config->get("dbprefix")."API_ServicesToken = ?";
|
|
$values = array(
|
|
$userID,
|
|
$serviceID
|
|
);
|
|
$tokenInfos = CS::get()->db->select($this->userLoginAPItable, $conditions, $values);
|
|
|
|
if(count($tokenInfos) == 0)
|
|
return false; //There is nobody at this address
|
|
else {
|
|
//Return tokens
|
|
$token1 = $tokenInfos[0]['token1'];
|
|
$token2 = $tokenInfos[0]['token2'];
|
|
return array($token1, $token2);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Delete token from given informations
|
|
*
|
|
* @param int $userID The ID of the user to delete
|
|
* @param string $serviceID The service ID
|
|
* @return bool False if it fails
|
|
*/
|
|
public function deleteUserLoginToken(int $userID, string $serviceID) : bool {
|
|
|
|
//Prepare database request
|
|
$condition = "ID_utilisateurs = ? AND ID_".CS::get()->config->get("dbprefix")."API_ServicesToken = ?";
|
|
$values = array(
|
|
$userID,
|
|
$serviceID
|
|
);
|
|
|
|
//Try to perform request
|
|
if(!CS::get()->db->deleteEntry($this->userLoginAPItable, $condition, $values))
|
|
return false; //Something went wrong during the request
|
|
|
|
//Everything is ok
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Get User ID from token
|
|
*
|
|
* @param int $serviceID The ID of the service
|
|
* @param array $tokens The user login tokens
|
|
* @return int User ID (0 for a failure)
|
|
*/
|
|
public function getUserIDfromToken(int $serviceID, array $tokens) : int {
|
|
//Check token number
|
|
if(count($tokens) != 2)
|
|
return 0;
|
|
|
|
//Prepare database request
|
|
$tablesName = $this->userLoginAPItable;
|
|
$conditions = "WHERE ".$this->userLoginAPItable.".ID_".CS::get()->config->get("dbprefix")."API_ServicesToken = ? AND ".$this->userLoginAPItable.".token1 = ? AND ".$this->userLoginAPItable.".token2 = ?";
|
|
$conditionsValues = array(
|
|
$serviceID,
|
|
$tokens[0],
|
|
$tokens[1]
|
|
);
|
|
|
|
//Perform request
|
|
$userInfos = CS::get()->db->select($tablesName, $conditions, $conditionsValues);
|
|
|
|
//Check if result is correct or not
|
|
if(count($userInfos) == 0)
|
|
return 0; //No result
|
|
|
|
//Return ID
|
|
return $userInfos[0]["ID_utilisateurs"];
|
|
}
|
|
|
|
|
|
/**
|
|
* Get Single User Infos
|
|
*
|
|
* @param int $userID The user ID
|
|
* @param bool $advanced Get advanced informations about user, for its page for example
|
|
* @return Array The result of the function (user informations) (empty one if it fails)
|
|
*/
|
|
public function getUserInfos(int $userID, bool $advanced = false) : array {
|
|
//Prepare database request
|
|
$tablesName = $this->userTable;
|
|
$conditions = "WHERE utilisateurs.ID = ?";
|
|
$conditionsValues = array(
|
|
$userID*1,
|
|
);
|
|
|
|
//Perform request
|
|
$userInfos = CS::get()->db->select($tablesName, $conditions, $conditionsValues);
|
|
|
|
//Check if result is correct or not
|
|
if(count($userInfos) == 0)
|
|
return array(); //No result
|
|
|
|
//Return result
|
|
return $this->generateUserInfosArray($userInfos[0], $advanced);
|
|
}
|
|
|
|
/**
|
|
* Get Multiple Users Infos
|
|
*
|
|
* @param Array $usersID The users ID
|
|
* @return Array The result of the function (user informations) (empty one if it fails)
|
|
*/
|
|
public function getMultipleUserInfos(array $usersID) : array {
|
|
//Prepare database request
|
|
$tablesName = $this->userTable;
|
|
$conditions = "WHERE (utilisateurs.ID < 0)";
|
|
$conditionsValues = array();
|
|
|
|
//Process users
|
|
foreach($usersID as $i=>$process){
|
|
$conditions .= " OR utilisateurs.ID = ?";
|
|
$conditionsValues[] = $process*1;
|
|
}
|
|
|
|
//Perform request
|
|
$usersInfos = CS::get()->db->select($tablesName, $conditions, $conditionsValues);
|
|
|
|
//Check if result is correct or not
|
|
if(count($usersInfos) == 0)
|
|
return array(); //No result
|
|
|
|
//Process result
|
|
foreach($usersInfos as $processUser){
|
|
$result[$processUser['ID']] = $this->generateUserInfosArray($processUser);
|
|
}
|
|
|
|
//Return result
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Generate and return an array containing informations about a user
|
|
* given the database entry
|
|
*
|
|
* @param array $userInfos The user entry in the database
|
|
* @param bool $advanced Get advanced informations about user or not (to display its profile for example)
|
|
* @return array The informations ready to be returned
|
|
*/
|
|
private function generateUserInfosArray(array $userInfos, bool $advanced = false) : array{
|
|
//Prepare return
|
|
$return = array();
|
|
$return['userID'] = $userInfos['ID'];
|
|
$return['firstName'] = $userInfos['prenom'];
|
|
$return['lastName'] = $userInfos['nom'];
|
|
$return['publicPage'] = $userInfos['public'] == 1;
|
|
$return['openPage'] = $userInfos['pageouverte'] == 1;
|
|
$return['virtualDirectory'] = $userInfos['sous_repertoire'];
|
|
|
|
//Add account image url
|
|
$return['accountImage'] = CS::get()->components->accountImage->getPath($return['userID']);
|
|
|
|
//Check if we have to fetch advanced informations
|
|
if($advanced){
|
|
|
|
//Public friend list
|
|
$return['friend_list_public'] = $userInfos['liste_amis_publique'] == 1;
|
|
|
|
//Personnal website
|
|
$return['personnalWebsite'] = $userInfos['site_web'];
|
|
|
|
//Block comment his his page ?
|
|
$return['noCommentOnHisPage'] = $userInfos['bloquecommentaire'] == 1;
|
|
|
|
//Allow user to post informations on his page
|
|
$return['allowPostFromFriendOnHisPage'] = $userInfos['autoriser_post_amis'] == 1;
|
|
|
|
//Account creation date
|
|
$return['account_creation_time'] = strtotime($userInfos['date_creation']);
|
|
|
|
//Add background image url
|
|
$return['backgroundImage'] = CS::get()->components->backgroundImage->getPath($return['userID']);
|
|
|
|
//Get the number of likes of the page
|
|
$return['pageLikes'] = CS::get()->components->likes->count($return['userID'], Likes::LIKE_USER);
|
|
|
|
}
|
|
|
|
//Return result
|
|
return $return;
|
|
}
|
|
|
|
/**
|
|
* Update last user activity time on the network
|
|
*
|
|
* @param int $userID The ID of the user to update
|
|
* @return bool True for a success
|
|
*/
|
|
public function updateLastActivity(int $userID) : bool{
|
|
|
|
//Perform a request on the database
|
|
$tableName = $this->userTable;
|
|
$conditions = "ID = ?";
|
|
$whereValues = array(userID);
|
|
$modifs = array(
|
|
"last_activity" => time()
|
|
);
|
|
|
|
if(!CS::get()->db->updateDB($tableName, $conditions, $modifs, $whereValues))
|
|
return false;
|
|
|
|
//Success
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Check if a user exists or not
|
|
*
|
|
* @param int $userID The ID of the user to check
|
|
* @return bool Depends of the existence of the user
|
|
*/
|
|
public function exists(int $userID) : bool {
|
|
//Perform a request on the database
|
|
$tableName = $this->userTable;
|
|
$condition = "WHERE ID = ?";
|
|
$condValues = array($userID);
|
|
$requiredFields = array("ID");
|
|
|
|
//Try to perform request
|
|
$result = CS::get()->db->select($tableName, $condition, $condValues, $requiredFields);
|
|
|
|
//Check for errors
|
|
if($result === false)
|
|
return false; //An error occured
|
|
|
|
//Check and return result
|
|
return count($result) !== 0;
|
|
}
|
|
|
|
/**
|
|
* Find the user specified by a folder name
|
|
*
|
|
* @param string $folder The folder of the research
|
|
* @return int 0 if no user was found or the ID of the user in case of success
|
|
*/
|
|
public function findByFolder(string $folder) : int {
|
|
|
|
//Perform a request on the database
|
|
$tableName = $this->userTable;
|
|
$condition = "WHERE sous_repertoire = ?";
|
|
$condValues = array($folder);
|
|
$requiredFields = array("ID");
|
|
|
|
//Try to perform the request
|
|
$result = CS::get()->db->select($tableName, $condition, $condValues, $requiredFields);
|
|
|
|
//Check for errors
|
|
if($result === false){
|
|
return 0;
|
|
}
|
|
|
|
if(count($result) == 0)
|
|
return 0; //There is no result
|
|
|
|
//Return result
|
|
return $result[0]["ID"];
|
|
|
|
}
|
|
|
|
/**
|
|
* Get a user page visibility level
|
|
*
|
|
* @param int $id The ID of the user to fetch
|
|
* @return int The visibility level of the user page
|
|
* - -1 : In case of failure (will make the protection level elevated)
|
|
* - 0 : The page is private (for user friends)
|
|
* - 1 : The page is public (for signed in users)
|
|
* - 2 : The page is open (for everyone)
|
|
*/
|
|
public function getVisibility(int $userID) : int {
|
|
|
|
//Perform a request on the database
|
|
$tableName = $this->userTable;
|
|
$condition = "WHERE ID = ?";
|
|
$condValues = array($userID);
|
|
|
|
$requiredFields = array(
|
|
"public",
|
|
"pageouverte"
|
|
);
|
|
|
|
//Perform the request
|
|
$result = CS::get()->db->select($tableName, $condition, $condValues, $requiredFields);
|
|
|
|
if($result === false){
|
|
return -1;
|
|
}
|
|
|
|
//Check for a result
|
|
if(count($result) == 0){
|
|
return -1;
|
|
}
|
|
|
|
//Check if the page is public
|
|
if($result[0]["public"] == 0)
|
|
return $this::USER_PAGE_PRIVATE;
|
|
|
|
//Check if the page is open or not
|
|
if($result[0]["pageouverte"] == 1)
|
|
return $this::USER_PAGE_OPEN; //Page open
|
|
else
|
|
return $this::USER_PAGE_PUBLIC; //Public page
|
|
|
|
}
|
|
|
|
/**
|
|
* Check if a user is allowed to access another user page content
|
|
*
|
|
* @param int $userID The ID of the user attempting to get user informations (0 = no user)
|
|
* @param int $targetUser Target user for the research
|
|
* @return bool TRUE if the user is allowed to see the page / FALSE else
|
|
*/
|
|
public function userAllowed(int $userID, int $targetUser) : bool {
|
|
|
|
//Check if the requested user is the current user
|
|
if($userID == $targetUser)
|
|
return true; //A user can access to its own page !
|
|
|
|
//Get the visibility level of the page
|
|
$visibility = $this->getVisibility($targetUser);
|
|
|
|
//Check for errors
|
|
if($visibility == -1)
|
|
return FALSE; //An error occured
|
|
|
|
//Check if the page is open
|
|
if($visibility == User::USER_PAGE_OPEN)
|
|
return true;
|
|
|
|
if($userID == 0)
|
|
return false;
|
|
|
|
if($visibility == User::USER_PAGE_PUBLIC)
|
|
return true;
|
|
|
|
if(CS::get()->components->friends->are_friend($userID, $targetUser))
|
|
return true;
|
|
else
|
|
return false;
|
|
|
|
}
|
|
|
|
/**
|
|
* Check if a user can create a post on another user page
|
|
*
|
|
* @param int $userID The ID of the user who could create post
|
|
* @param int $targetID The ID of the user who could receive new posts
|
|
* @return bool True if the user is allowed to create post / false else
|
|
*/
|
|
public function canCreatePosts(int $userID, int $targetID){
|
|
|
|
//If the user is signed out, the response is NO by default
|
|
if($userID == 0)
|
|
return FALSE;
|
|
|
|
//If the two user are friends, the response is yes by default
|
|
if($userID === $targetID)
|
|
return TRUE;
|
|
|
|
//Check if the user is allowed to access user page
|
|
if(!$this->userAllowed($userID, $targetID))
|
|
return FALSE;
|
|
|
|
//Check if the friendship of the users allow them to create posts
|
|
if(!CS::get()->components->friends->can_post_text($userID, $targetID))
|
|
return FALSE;
|
|
|
|
//Else the user is allowed
|
|
return TRUE;
|
|
|
|
}
|
|
|
|
/**
|
|
* Check whether a user allow comments on his page or not
|
|
*
|
|
* @param int $userID The ID of the user
|
|
* @return bool True if comments are allowed / False else
|
|
*/
|
|
public function allowComments(int $userID) : bool {
|
|
|
|
//Fetch the information in the database
|
|
$conditions = "WHERE ID = ?";
|
|
$condValues = array($userID);
|
|
$fields = array("bloquecommentaire");
|
|
|
|
//Perform the request
|
|
$result = CS::get()->db->select(
|
|
$this->userTable,
|
|
$conditions,
|
|
$condValues,
|
|
$fields
|
|
);
|
|
|
|
//Check for errors
|
|
if(count($result) == 0)
|
|
return FAlSE;
|
|
|
|
//Return result
|
|
return $result[0]["bloquecommentaire"] == 0;
|
|
}
|
|
|
|
/**
|
|
* Crypt user password
|
|
*
|
|
* @param string $userPassword The password to crypt
|
|
* @return string The encrypted password
|
|
*/
|
|
public function cryptPassword(string $userPassword) : string {
|
|
return crypt(sha1($userPassword), sha1($userPassword));
|
|
}
|
|
|
|
}
|
|
|
|
//Register class
|
|
Components::register("user", new User()); |