vendor/pierre-granger/apidae-membres/src/ApidaeMembres.php line 36

  1. <?php
  3. /**
  4.  * Documentation pour le fichier ApidaeMembres.php
  5.  * 
  6.  * 
  7.  */
  9. namespace PierreGranger;
  11. /**
  12.  * Documentation pour la classe ApidaeMembres
  13.  * 
  14.  * @author    Pierre Granger    <pierre@pierre-granger.fr>
  15.  * 
  16.  * 
  17.  */
  18. class ApidaeMembres extends ApidaeCore
  19. {
  21.     protected $projet_consultation_projetId = null;
  22.     protected $projet_consultation_apiKey = null;
  24.     private $servicesMU = [
  25.         'GET' => ['utilisateur/get-by-id', 'utilisateur/get-by-mail', 'utilisateur/get-by-membre', 'utilisateur/get-all-utilisateurs', 'membre/get-by-id'],
  26.         'POST' => ['membre/get-membres']
  27.     ];
  29.     const EXCEPTION_NOT_IN_MEMBRES = 1;
  30.     const EXCEPTION_NOT_FILLEUL = 2;
  31.     const EXCEPTION_NO_PERMISSION = 3;
  33.     public function __construct(array $params = null)
  34.     {
  36.         parent::__construct($params);
  38.         $this->timeout = 30;
  40.         if (isset($params['projet_consultation_projetId']) && preg_match('#^[0-9]+$#', $params['projet_consultation_projetId']))
  41.             $this->projet_consultation_projetId = $params['projet_consultation_projetId'];
  42.         else
  43.             throw new \Exception('missing projet_consultation_projetId');
  45.         if (isset($params['projet_consultation_apiKey']) && preg_match('#^[a-zA-Z0-9]{1,20}$#', $params['projet_consultation_apiKey']))
  46.             $this->projet_consultation_apiKey = $params['projet_consultation_apiKey'];
  47.         else
  48.             throw new \Exception('missing projet_consultation_apiKey');
  49.     }
  51.     /**
  52.      * Récupère un Array des membres selon le $filter
  53.      * 
  54.      * @since    1.0
  55.      * 
  56.      * @return    array    Tableau associatif des membres
  57.      */
  58.     public function getMembres(array $filter, $responseFields = null)
  59.     {
  60.         $query = [
  61.             'projetId' => $this->projet_consultation_projetId,
  62.             'apiKey' => $this->projet_consultation_apiKey,
  63.             'filter' => $filter
  64.         ];
  65.         if (isset($responseFields) && $responseFields != null)
  66.             $query['responseFields'] = is_array($responseFields) ? json_encode($responseFields) : $responseFields;
  68.         return $this->apidaeCurlMU('membre/get-membres', $query);
  69.     }
  71.     /**
  72.      * Récupère la liste des filleuls selon l'idParrain
  73.      * 
  74.      * @param int $idParrain    int    Identifiant du membre parrain
  75.      * @return array Tableau associatif des membres filleuls
  76.      */
  77.     public function getFilleuls(int $idParrain, array $types = null)
  78.     {
  79.         $filter = ['idParrain' => $idParrain];
  80.         if ($types == null || !is_array($types)) $types = ['Contributeur Généraliste'];
  81.         if (is_array($types) && sizeof($types) > 0) $filter['types'] = $types;
  82.         $responseFields = json_encode(["UTILISATEURS"]);
  83.         return $this->getMembres($filter, $responseFields);
  84.     }
  85.     /**
  86.      * Récupération d'un utilisateur par son identifiant, via le service get-by-id de l'API Membres/utilisateurs d'Apidae
  87.      * @param int    $id_user
  88.      * @return array 
  89.      */
  90.     public function getUserById(int $id_user)
  91.     {
  92.         if (!preg_match('#^[0-9]+$#', $id_user)) throw new \Exception(__LINE__ . " Invalid id_user for getUserById : " . $id_user);
  94.         $query = [
  95.             'projetId' => $this->projet_consultation_projetId,
  96.             'apiKey' => $this->projet_consultation_apiKey
  97.         ];
  99.         return $this->apidaeCurlMU('utilisateur/get-by-id', $query, $id_user);
  100.     }
  101.     public function getUtilisateur($var)
  102.     {
  103.         return $this->getUser($var);
  104.     }
  106.     public function getUser($var)
  107.     {
  108.         if (is_int($var)) return $this->getUserById($var);
  109.         elseif ((strpos($var, '@')) !== false) return $this->getUserByMail($var);
  110.         return false;
  111.     }
  113.     /**
  114.      * Récupération d'un utilisateur par son adresse mail, via le service get-by-mail de l'API Membres/utilisateurs d'Apidae
  115.      * @param string    $mail_user
  116.      * @return array 
  117.      */
  118.     public function getUserByMail(string $mail_user)
  119.     {
  120.         if (false === filter_var($mail_user, FILTER_VALIDATE_EMAIL)) throw new \Exception(__LINE__ . " Invalid mail_user for getUserByMail : " . $mail_user);
  122.         $params = [
  123.             'projetId' => $this->projet_consultation_projetId,
  124.             'apiKey' => $this->projet_consultation_apiKey
  125.         ];
  127.         return $this->apidaeCurlMU('utilisateur/get-by-mail', $params, $mail_user);
  128.     }
  130.     /**
  131.      * Récupération de la liste des utilisateurs d'un membre par son identifiant, via le service get-by-membre de l'API Membres/utilisateurs d'Apidae
  132.      * @param int    $id_membre
  133.      * @return array 
  134.      */
  135.     public function getUsersByMember(int $id_membre)
  136.     {
  137.         if (!preg_match('#^[0-9]+$#', $id_membre)) throw new \Exception(__LINE__ . ' Invalid id_membre for ' . __FUNCTION__ . ' : ' . $id_membre);
  139.         $params = [
  140.             'projetId' => $this->projet_consultation_projetId,
  141.             'apiKey' => $this->projet_consultation_apiKey
  142.         ];
  144.         return $this->apidaeCurlMU('utilisateur/get-by-membre', $params, $id_membre);
  145.     }
  147.     /**
  148.      *    Récupère un membre en fonction de son identifiant
  149.      *     @param int $id_membre
  150.      *     @return array
  151.      */
  152.     public function getMembreById(int $id_membre, array $responseFields = null)
  153.     {
  154.         if (!preg_match('#^[0-9]+$#', $id_membre)) throw new \Exception(__LINE__ . ' Invalid id_membre for ' . __FUNCTION__ . ' : ' . $id_membre);
  156.         $query = [
  157.             'projetId' => $this->projet_consultation_projetId,
  158.             'apiKey' => $this->projet_consultation_apiKey
  159.         ];
  160.         if (isset($responseFields) && $responseFields != null && is_array($responseFields))
  161.             $query['responseFields'] = json_encode($responseFields);
  163.         return $this->apidaeCurlMU('membre/get-by-id', $query, $id_membre);
  164.     }
  165.     public function getMembre(int $id_membre, array $responseFields = null)
  166.     {
  167.         return $this->getMembreById($id_membre, $responseFields);
  168.     }
  170.     /**
  171.      * Cet appel ne liste pas les utilisateurs enregistrés ou parrainés.
  172.      */
  173.     public function getAllUtilisateurs()
  174.     {
  175.         $this->timeout = 600;
  176.         $query = [
  177.             'projetId' => $this->projet_consultation_projetId,
  178.             'apiKey' => $this->projet_consultation_apiKey
  179.         ];
  180.         $ret = $this->apidaeCurlMU('utilisateur/get-all-utilisateurs', $query);
  181.         $this->timeout = 15;
  182.         return $ret;
  183.     }
  185.     /**
  186.      * Gestion des appels cURL aux API membres et utilisateurs d'Apidae
  187.      * 
  188.      * @param    string    $service    Service (chemin relatif)
  189.      * @param    array    $params    Liste de paramètres qui seront envoyées en cURL : en POST elles seront converties via json_encode, en GET elles seront converties via http_build_query.
  190.      */
  191.     private function apidaeCurlMU(string $service, array $params = null, string $page = null)
  192.     {
  193.         $debug = $this->debug;
  195.         $method = null;
  196.         if (in_array($service, $this->servicesMU['GET'])) $method = 'GET';
  197.         elseif (in_array($service, $this->servicesMU['POST'])) $method = 'POST';
  198.         else throw new \Exception(__LINE__ . " Invalid function for apidaeCurl : " . $service);
  200.         $url_base = '/api/v002/' . $service . '/';
  201.         $url = $url_base;
  202.         if ($page !== null && preg_match('#^[a-zA-Z0-9\@\.-]+$#', $page)) $url .= $page;
  204.         /**
  205.          * 19/02/2021 Fun fact syntaxe responseFields :
  206.          * Méthode en GET :
  207.          * get-membres/?query={"projetId":X,"apiKey":"Y","filter":{"idProjet":Z},"responseFields":["PROJETS"]}
  208.          * $params["responseFields"] doit être DEJA json_encode, sinon il faut l'encoder ici
  209.          * Méthode en POST
  210.          * get-by-id/1157?projetId=X&apiKey=Y&responseFields=["PROJETS"]
  211.          * $params["responseFields"] ne doit PAS être json_encode
  212.          * Sinon on se retrouve avec responseFields="[\"PROJETS\"]"
  213.          */
  215.         // On ne demande pas forcément du json, parce que la réponse peut être une 404 (donc format incorrect)
  216.         //$request_params = Array('format' => 'json') ;
  218.         $request_params = [];
  220.         if ($method == 'GET') {
  221.             if (isset($params['responseFields']) && is_array($params['responseFields']))
  222.                 $params['responseFields'] = json_encode($params['responseFields']);
  224.             $url .= '?' . http_build_query($params);
  225.         }
  227.         if ($method == 'POST') {
  228.             if (isset($params['responseFields']) && !is_array($params['responseFields'])) {
  229.                 $test = json_decode($params['responseFields'], true);
  230.                 if (json_last_error() == JSON_ERROR_NONE)
  231.                     $params['responseFields'] = $test;
  232.             }
  234.             // Force filter to {} instead of [] if empty
  235.             if (isset($params['filter']) && is_array($params['filter']))
  236.                 $params['filter'] = (object)$params['filter'];
  238.             $request_params['POST'] = 1;
  239.             $request_params['POSTFIELDS'] = 'query=' . json_encode($params);
  240.         }
  242.         $result = $this->request($url, $request_params);
  244.         if ($result['code'] == 204) return false;
  246.         if ($result['code'] != 200) {
  247.             $details = [];
  248.             if ($this->debug) {
  249.                 $details['params'] = $params;
  250.                 $details['url'] = $url;
  251.                 $details['result'] = $result;
  252.             }
  253.             throw new ApidaeException(__CLASS__ . ':' . $service . ' : incorrect http_code ' . $result['code'], ApidaeException::INVALID_HTTPCODE, $details);
  254.         }
  256.         return json_decode($result['body'], true);
  257.     }
  259.     /**
  260.      * L'utilisateur a-t-il les droits demandés ?
  261.      * @param    $utilisateurApidae    Array    Utilisateur Apidae défini par l'authentification SSO
  262.      * @param    $droits    Array    Droits qu'on va rechercher sur cet utilisateur
  263.      *                             $droits['membres']    Array    Le membre de l'utilisateur est-il dans la liste $droits['membres'] ? (liste d'identifiants numériques)
  264.      *                             $droits['filleuls']    Integer    Le membre de l'utilisateur est-il filleur du membre $droits['filleuls'] ?
  265.      *                             $droits['permissions']    Array    L'utilisateur a-t-il les permissions $droits['permissions'] ? (liste de string)
  266.      * 
  267.      */
  268.     public function droits($utilisateurApidae, $droits)
  269.     {
  271.         $return = true;
  273.         foreach ($droits as $droit => $valeurs) {
  274.             if ($droit == 'membres') {
  275.                 if (!in_array($utilisateurApidae['membre']['id'], $valeurs))
  276.                     return false;
  277.             }
  279.             if ($droit == 'filleuls') {
  280.                 $filleuls = $this->getFilleuls($valeurs);
  281.                 if (!in_array($utilisateurApidae['membre']['id'], $filleuls))
  282.                     return false;
  283.             }
  285.             if ($droit == 'permissions') {
  286.                 $usr = $this->getUserById($utilisateurApidae['id']);
  287.                 foreach ($valeurs as $p) {
  288.                     if (!in_array($p, $usr['permissions']))
  289.                         return false;
  290.                 }
  291.             }
  292.         }
  294.         return $return;
  295.     }
  296. }