ProcessMaker-BE "Role and User (Endpoints)"

- Se han implementado los siguientes Endpoints:
    GET    /api/1.0/{workspace}/role/{rol_uid}/users?filter={filter}&start={start}&limit={limit}
    GET    /api/1.0/{workspace}/role/{rol_uid}/available-users?filter={filter}&start={start}&limit={limit}
    POST   /api/1.0/{workspace}/role/{rol_uid}/user
    DELETE /api/1.0/{workspace}/role/{rol_uid}/user/{usr_uid}

workflow/engine/src/ProcessMaker/BusinessModel/Role.php

@@ -62,7 +62,7 @@ class Role
      *
      * return void
      */
-    public function setArrayFieldNameForException($arrayData)
+    public function setArrayFieldNameForException(array $arrayData)
     {
         try {
             foreach ($arrayData as $key => $value) {
@@ -191,9 +191,9 @@ class Role
     public function throwExceptionIfNotExistsRole($roleUid, $fieldNameForException)
     {
         try {
-            $role = \RolesPeer::retrieveByPK($roleUid);
+            $obj = \RolesPeer::retrieveByPK($roleUid);
 
-            if (is_null($role)) {
+            if (is_null($obj)) {
                 throw new \Exception(\G::LoadTranslation("ID_ROLE_DOES_NOT_EXIST", array($fieldNameForException, $roleUid)));
             }
         } catch (\Exception $e) {
@@ -251,7 +251,7 @@ class Role
      *
      * return void Throw exception if data has an invalid value
      */
-    public function throwExceptionIfDataIsInvalid($roleUid, $arrayData)
+    public function throwExceptionIfDataIsInvalid($roleUid, array $arrayData)
     {
         try {
             //Set variables
@@ -289,7 +289,7 @@ class Role
      *
      * return array Return data of the new Role created
      */
-    public function create($arrayData)
+    public function create(array $arrayData)
     {
         try {
             //Verify data
@@ -335,7 +335,7 @@ class Role
      *
      * return array Return data of the Role updated
      */
-    public function update($roleUid, $arrayData)
+    public function update($roleUid, array $arrayData)
     {
         try {
             $arrayDataBackup = $arrayData;
@@ -445,7 +445,7 @@ class Role
      *
      * return array Return an array with data Role
      */
-    public function getRoleDataFromRecord($record)
+    public function getRoleDataFromRecord(array $record)
     {
         try {
             $conf = new \Configurations();
@@ -487,7 +487,7 @@ class Role
      *
      * return array Return an array with all Roles
      */
-    public function getRoles($arrayFilterData = null, $sortField = null, $sortDir = null, $start = null, $limit = null)
+    public function getRoles(array $arrayFilterData = null, $sortField = null, $sortDir = null, $start = null, $limit = null)
     {
         try {
             $arrayRole = array();

workflow/engine/src/ProcessMaker/BusinessModel/Role/User.php

@@ -0,0 +1,408 @@
+<?php
+namespace ProcessMaker\BusinessModel\Role;
+
+class User
+{
+    private $arrayFieldDefinition = array(
+        "ROL_UID" => array("type" => "string", "required" => false, "empty" => false, "defaultValues" => array(), "fieldNameAux" => "roleUid"),
+        "USR_UID" => array("type" => "string", "required" => true,  "empty" => false, "defaultValues" => array(), "fieldNameAux" => "userUid")
+    );
+
+    private $formatFieldNameInUppercase = true;
+
+    private $arrayFieldNameForException = array(
+        "filter" => "FILTER",
+        "start"  => "START",
+        "limit"  => "LIMIT"
+    );
+
+    /**
+     * Constructor of the class
+     *
+     * return void
+     */
+    public function __construct()
+    {
+        try {
+            foreach ($this->arrayFieldDefinition as $key => $value) {
+                $this->arrayFieldNameForException[$value["fieldNameAux"]] = $key;
+            }
+        } catch (\Exception $e) {
+            throw $e;
+        }
+    }
+
+    /**
+     * Set the format of the fields name (uppercase, lowercase)
+     *
+     * @param bool $flag Value that set the format
+     *
+     * return void
+     */
+    public function setFormatFieldNameInUppercase($flag)
+    {
+        try {
+            $this->formatFieldNameInUppercase = $flag;
+
+            $this->setArrayFieldNameForException($this->arrayFieldNameForException);
+        } catch (\Exception $e) {
+            throw $e;
+        }
+    }
+
+    /**
+     * Set exception messages for fields
+     *
+     * @param array $arrayData Data with the fields
+     *
+     * return void
+     */
+    public function setArrayFieldNameForException(array $arrayData)
+    {
+        try {
+            foreach ($arrayData as $key => $value) {
+                $this->arrayFieldNameForException[$key] = $this->getFieldNameByFormatFieldName($value);
+            }
+        } catch (\Exception $e) {
+            throw $e;
+        }
+    }
+
+    /**
+     * Get the name of the field according to the format
+     *
+     * @param string $fieldName Field name
+     *
+     * return string Return the field name according the format
+     */
+    public function getFieldNameByFormatFieldName($fieldName)
+    {
+        try {
+            return ($this->formatFieldNameInUppercase)? strtoupper($fieldName) : strtolower($fieldName);
+        } catch (\Exception $e) {
+            throw $e;
+        }
+    }
+
+    /**
+     * Verify if it's assigned the User to Role
+     *
+     * @param string $roleUid               Unique id of Role
+     * @param string $userUid               Unique id of User
+     * @param string $fieldNameForException Field name for the exception
+     *
+     * return void Throw exception if it's assigned the User to Role
+     */
+    public function throwExceptionIfItsAssignedUserToRole($roleUid, $userUid, $fieldNameForException)
+    {
+        try {
+            $obj = \UsersRolesPeer::retrieveByPK($userUid, $roleUid);
+
+            if (!is_null($obj)) {
+                throw new \Exception(\G::LoadTranslation("ID_ROLE_USER_IS_ALREADY_ASSIGNED", array($fieldNameForException, $userUid)));
+            }
+        } catch (\Exception $e) {
+            throw $e;
+        }
+    }
+
+    /**
+     * Verify if not it's assigned the User to Role
+     *
+     * @param string $roleUid               Unique id of Role
+     * @param string $userUid               Unique id of User
+     * @param string $fieldNameForException Field name for the exception
+     *
+     * return void Throw exception if not it's assigned the User to Role
+     */
+    public function throwExceptionIfNotItsAssignedUserToRole($roleUid, $userUid, $fieldNameForException)
+    {
+        try {
+            $obj = \UsersRolesPeer::retrieveByPK($userUid, $roleUid);
+
+            if (is_null($obj)) {
+                throw new \Exception(\G::LoadTranslation("ID_ROLE_USER_IS_NOT_ASSIGNED", array($fieldNameForException, $userUid)));
+            }
+        } catch (\Exception $e) {
+            throw $e;
+        }
+    }
+
+    /**
+     * Assign User to Role
+     *
+     * @param string $roleUid   Unique id of Role
+     * @param array  $arrayData Data
+     *
+     * return array Return data of the User assigned to Role
+     */
+    public function create($roleUid, array $arrayData)
+    {
+        try {
+            //Verify data
+            $process = new \ProcessMaker\BusinessModel\Process();
+            $validator = new \ProcessMaker\BusinessModel\Validator();
+
+            $validator->throwExceptionIfDataIsNotArray($arrayData, "\$arrayData");
+            $validator->throwExceptionIfDataIsEmpty($arrayData, "\$arrayData");
+
+            //Set data
+            $arrayData = array_change_key_case($arrayData, CASE_UPPER);
+
+            unset($arrayData["ROL_UID"]);
+
+            //Verify data
+            $role = new \ProcessMaker\BusinessModel\Role();
+
+            $role->throwExceptionIfNotExistsRole($roleUid, $this->arrayFieldNameForException["roleUid"]);
+
+            $process->throwExceptionIfDataNotMetFieldDefinition($arrayData, $this->arrayFieldDefinition, $this->arrayFieldNameForException, true);
+
+            $process->throwExceptionIfNotExistsUser($arrayData["USR_UID"], $this->arrayFieldNameForException["userUid"]);
+
+            $this->throwExceptionIfItsAssignedUserToRole($roleUid, $arrayData["USR_UID"], $this->arrayFieldNameForException["userUid"]);
+
+            if ($arrayData["USR_UID"] == "00000000000000000000000000000001") {
+                throw new \Exception(\G::LoadTranslation("ID_ADMINISTRATOR_ROLE_CANT_CHANGED"));
+            }
+
+            //Create
+            $role = new \Roles();
+
+            $arrayData = array_merge(array("ROL_UID" => $roleUid), $arrayData);
+
+            $role->assignUserToRole($arrayData);
+
+            //Return
+            if (!$this->formatFieldNameInUppercase) {
+                $arrayData = array_change_key_case($arrayData, CASE_LOWER);
+            }
+
+            return $arrayData;
+        } catch (\Exception $e) {
+            throw $e;
+        }
+    }
+
+    /**
+     * Unassign User of the Role
+     *
+     * @param string $roleUid  Unique id of Role
+     * @param string $userUid  Unique id of User
+     *
+     * return void
+     */
+    public function delete($roleUid, $userUid)
+    {
+        try {
+            //Verify data
+            $process = new \ProcessMaker\BusinessModel\Process();
+            $role = new \ProcessMaker\BusinessModel\Role();
+
+            $role->throwExceptionIfNotExistsRole($roleUid, $this->arrayFieldNameForException["roleUid"]);
+
+            $process->throwExceptionIfNotExistsUser($userUid, $this->arrayFieldNameForException["userUid"]);
+
+            $this->throwExceptionIfNotItsAssignedUserToRole($roleUid, $userUid, $this->arrayFieldNameForException["userUid"]);
+
+            if ($roleUid == "00000000000000000000000000000002" && $userUid == "00000000000000000000000000000001") {
+                throw new \Exception(\G::LoadTranslation("ID_ADMINISTRATOR_ROLE_CANT_CHANGED"));
+            }
+
+            //Delete
+            $role = new \Roles();
+
+            $role->deleteUserRole($roleUid, $userUid);
+        } catch (\Exception $e) {
+            throw $e;
+        }
+    }
+
+    /**
+     * Get criteria for User
+     *
+     * @param string $roleUid             Unique id of Role
+     * @param array  $arrayUserUidExclude Unique id of Users to exclude
+     *
+     * return object
+     */
+    public function getUserCriteria($roleUid, array $arrayUserUidExclude = null)
+    {
+        try {
+            $criteria = new \Criteria("rbac");
+
+            $criteria->addSelectColumn(\RbacUsersPeer::USR_UID);
+            $criteria->addSelectColumn(\RbacUsersPeer::USR_USERNAME);
+            $criteria->addSelectColumn(\RbacUsersPeer::USR_FIRSTNAME);
+            $criteria->addSelectColumn(\RbacUsersPeer::USR_LASTNAME);
+            $criteria->addSelectColumn(\RbacUsersPeer::USR_STATUS);
+
+            if ($roleUid != "") {
+                $criteria->addJoin(\UsersRolesPeer::USR_UID, \RbacUsersPeer::USR_UID, \Criteria::LEFT_JOIN);
+                $criteria->add(\UsersRolesPeer::ROL_UID, $roleUid, \Criteria::EQUAL);
+            }
+
+            $criteria->add(\RbacUsersPeer::USR_USERNAME, "", \Criteria::NOT_EQUAL);
+
+            if (!is_null($arrayUserUidExclude) && is_array($arrayUserUidExclude)) {
+                $criteria->add(\RbacUsersPeer::USR_UID, $arrayUserUidExclude, \Criteria::NOT_IN);
+            }
+
+            return $criteria;
+        } catch (\Exception $e) {
+            throw $e;
+        }
+    }
+
+    /**
+     * Get data of a User from a record
+     *
+     * @param array $record Record
+     *
+     * return array Return an array with data User
+     */
+    public function getUserDataFromRecord(array $record)
+    {
+        try {
+            return array(
+                $this->getFieldNameByFormatFieldName("USR_UID")       => $record["USR_UID"],
+                $this->getFieldNameByFormatFieldName("USR_USERNAME")  => $record["USR_USERNAME"],
+                $this->getFieldNameByFormatFieldName("USR_FIRSTNAME") => $record["USR_FIRSTNAME"] . "",
+                $this->getFieldNameByFormatFieldName("USR_LASTNAME")  => $record["USR_LASTNAME"] . "",
+                $this->getFieldNameByFormatFieldName("USR_STATUS")    => ($record["USR_STATUS"] . "" == "1")? "ACTIVE" : "INACTIVE"
+            );
+        } catch (\Exception $e) {
+            throw $e;
+        }
+    }
+
+    /**
+     * Get all Users of a Role
+     *
+     * @param string $roleUid         Unique id of Role
+     * @param string $option          Option (USERS, AVAILABLE-USERS)
+     * @param array  $arrayFilterData Data of the filters
+     * @param string $sortField       Field name to sort
+     * @param string $sortDir         Direction of sorting (ASC, DESC)
+     * @param int    $start           Start
+     * @param int    $limit           Limit
+     *
+     * return array Return an array with all Users of a Role
+     */
+    public function getUsers($roleUid, $option, array $arrayFilterData = null, $sortField = null, $sortDir = null, $start = null, $limit = null)
+    {
+        try {
+            $arrayUser = array();
+
+            //Verify data
+            $process = new \ProcessMaker\BusinessModel\Process();
+            $role    = new \ProcessMaker\BusinessModel\Role();
+
+            $role->throwExceptionIfNotExistsRole($roleUid, $this->arrayFieldNameForException["roleUid"]);
+
+            $process->throwExceptionIfDataNotMetFieldDefinition(
+                array("OPTION" => $option),
+                array("OPTION" => array("type" => "string", "required" => true, "empty" => false, "defaultValues" => array("USERS", "AVAILABLE-USERS"), "fieldNameAux" => "option")),
+                array("option" => "\$option"),
+                true
+            );
+
+            $process->throwExceptionIfDataNotMetPagerVarDefinition(array("start" => $start, "limit" => $limit), $this->arrayFieldNameForException);
+
+            //Get data
+            if (!is_null($limit) && $limit . "" == "0") {
+                return $arrayUser;
+            }
+
+            //SQL
+            switch ($option) {
+                case "USERS":
+                    //Criteria
+                    $criteria = $this->getUserCriteria($roleUid);
+                    break;
+                case "AVAILABLE-USERS":
+                    //Get Uids
+                    $arrayUid = array();
+
+                    $criteria = $this->getUserCriteria($roleUid);
+
+                    $rsCriteria = \RbacUsersPeer::doSelectRS($criteria);
+                    $rsCriteria->setFetchmode(\ResultSet::FETCHMODE_ASSOC);
+
+                    while ($rsCriteria->next()) {
+                        $row = $rsCriteria->getRow();
+
+                        $arrayUid[] = $row["USR_UID"];
+                    }
+
+                    //Criteria
+                    $criteria = $this->getUserCriteria("", $arrayUid);
+                    break;
+            }
+
+            if (!is_null($arrayFilterData) && is_array($arrayFilterData) && isset($arrayFilterData["filter"]) && trim($arrayFilterData["filter"]) != "") {
+                $criteria->add(
+                    $criteria->getNewCriterion(\RbacUsersPeer::USR_USERNAME, "%" . $arrayFilterData["filter"] . "%", \Criteria::LIKE)->addOr(
+                    $criteria->getNewCriterion(\RbacUsersPeer::USR_FIRSTNAME, "%" . $arrayFilterData["filter"] . "%", \Criteria::LIKE)->addOr(
+                    $criteria->getNewCriterion(\RbacUsersPeer::USR_LASTNAME, "%" . $arrayFilterData["filter"] . "%", \Criteria::LIKE)))
+                );
+            }
+
+            //Number records total
+            $criteriaCount = clone $criteria;
+
+            $criteriaCount->clearSelectColumns();
+            $criteriaCount->addAsColumn("NUM_REC", "COUNT(" . \RbacUsersPeer::USR_UID . ")");
+
+            $rsCriteriaCount = \RbacUsersPeer::doSelectRS($criteriaCount);
+            $rsCriteriaCount->setFetchmode(\ResultSet::FETCHMODE_ASSOC);
+
+            $rsCriteriaCount->next();
+            $row = $rsCriteriaCount->getRow();
+
+            $numRecTotal = $row["NUM_REC"];
+
+            //SQL
+            if (!is_null($sortField) && trim($sortField) != "") {
+                $sortField = strtoupper($sortField);
+
+                if (in_array($sortField, array("USR_UID", "USR_USERNAME", "USR_FIRSTNAME", "USR_LASTNAME", "USR_STATUS"))) {
+                    $sortField = \RbacUsersPeer::TABLE_NAME . "." . $sortField;
+                } else {
+                    $sortField = \RbacUsersPeer::USR_USERNAME;
+                }
+            } else {
+                $sortField = \RbacUsersPeer::USR_USERNAME;
+            }
+
+            if (!is_null($sortDir) && trim($sortDir) != "" && strtoupper($sortDir) == "DESC") {
+                $criteria->addDescendingOrderByColumn($sortField);
+            } else {
+                $criteria->addAscendingOrderByColumn($sortField);
+            }
+
+            if (!is_null($start)) {
+                $criteria->setOffset((int)($start));
+            }
+
+            if (!is_null($limit)) {
+                $criteria->setLimit((int)($limit));
+            }
+
+            $rsCriteria = \RbacUsersPeer::doSelectRS($criteria);
+            $rsCriteria->setFetchmode(\ResultSet::FETCHMODE_ASSOC);
+
+            while ($rsCriteria->next()) {
+                $row = $rsCriteria->getRow();
+
+                $arrayUser[] = $this->getUserDataFromRecord($row);
+            }
+
+            //Return
+            return $arrayUser;
+        } catch (\Exception $e) {
+            throw $e;
+        }
+    }
+}
+

workflow/engine/src/ProcessMaker/BusinessModel/WebEntry.php

@@ -67,7 +67,7 @@ class WebEntry
      *
      * return void
      */
-    public function setArrayFieldNameForException($arrayData)
+    public function setArrayFieldNameForException(array $arrayData)
     {
         try {
             foreach ($arrayData as $key => $value) {
@@ -175,9 +175,9 @@ class WebEntry
     public function throwExceptionIfNotExistsWebEntry($webEntryUid, $fieldNameForException)
     {
         try {
-            $webEntry = \WebEntryPeer::retrieveByPK($webEntryUid);
+            $obj = \WebEntryPeer::retrieveByPK($webEntryUid);
 
-            if (is_null($webEntry)) {
+            if (is_null($obj)) {
                 throw new \Exception(\G::LoadTranslation("ID_WEB_ENTRY_DOES_NOT_EXIST", array($fieldNameForException, $webEntryUid)));
             }
         } catch (\Exception $e) {
@@ -215,7 +215,7 @@ class WebEntry
      *
      * return void Throw exception if data has an invalid value
      */
-    public function throwExceptionIfDataIsInvalid($webEntryUid, $processUid, $arrayData)
+    public function throwExceptionIfDataIsInvalid($webEntryUid, $processUid, array $arrayData)
     {
         try {
             //Set variables
@@ -537,7 +537,7 @@ class WebEntry
      *
      * return array Return data of the new Web Entry created
      */
-    public function create($processUid, $userUidCreator, $arrayData)
+    public function create($processUid, $userUidCreator, array $arrayData)
     {
         try {
             //Verify data
@@ -622,7 +622,7 @@ class WebEntry
      *
      * return array Return data of the Web Entry updated
      */
-    public function update($webEntryUid, $userUidUpdater, $arrayData)
+    public function update($webEntryUid, $userUidUpdater, array $arrayData)
     {
         try {
             //Verify data
@@ -797,7 +797,7 @@ class WebEntry
      *
      * return array Return an array with data Web Entry
      */
-    public function getWebEntryDataFromRecord($record)
+    public function getWebEntryDataFromRecord(array $record)
     {
         try {
             if ($record["WE_METHOD"] == "WS") {

workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntry.php

@@ -71,7 +71,7 @@ class WebEntry extends Api
      *
      * @status 201
      */
-    public function doPostWebEntry($prj_uid, $request_data)
+    public function doPostWebEntry($prj_uid, array $request_data)
     {
         try {
             $arrayData = $this->webEntry->create($prj_uid, $this->getUserId(), $request_data);
@@ -91,7 +91,7 @@ class WebEntry extends Api
      * @param string $we_uid       {@min 32}{@max 32}
      * @param array  $request_data
      */
-    public function doPutWebEntry($prj_uid, $we_uid, $request_data)
+    public function doPutWebEntry($prj_uid, $we_uid, array $request_data)
     {
         try {
             $arrayData = $this->webEntry->update($we_uid, $this->getUserId(), $request_data);

workflow/engine/src/ProcessMaker/Services/Api/Role.php

@@ -66,7 +66,7 @@ class Role extends Api
      *
      * @status 201
      */
-    public function doPost($request_data)
+    public function doPost(array $request_data)
     {
         try {
             $arrayData = $this->role->create($request_data);
@@ -85,7 +85,7 @@ class Role extends Api
      * @param string $rol_uid      {@min 32}{@max 32}
      * @param array  $request_data
      */
-    public function doPut($rol_uid, $request_data)
+    public function doPut($rol_uid, array $request_data)
     {
         try {
             $arrayData = $this->role->update($rol_uid, $request_data);

workflow/engine/src/ProcessMaker/Services/Api/Role/User.php

@@ -0,0 +1,81 @@
+<?php
+namespace ProcessMaker\Services\Api\Role;
+
+use \ProcessMaker\Services\Api;
+use \Luracast\Restler\RestException;
+
+/**
+ * Role\User Api Controller
+ *
+ * @protected
+ */
+class User extends Api
+{
+    private $roleUser;
+
+    /**
+     * Constructor of the class
+     *
+     * return void
+     */
+    public function __construct()
+    {
+        try {
+            $this->roleUser = new \ProcessMaker\BusinessModel\Role\User();
+
+            $this->roleUser->setFormatFieldNameInUppercase(false);
+        } catch (\Exception $e) {
+            throw new RestException(Api::STAT_APP_EXCEPTION, $e->getMessage());
+        }
+    }
+
+    /**
+     * @url GET /:rol_uid/users
+     * @url GET /:rol_uid/available-users
+     *
+     * @param string $rol_uid {@min 32}{@max 32}
+     */
+    public function doGetUsers($rol_uid, $filter = null, $start = null, $limit = null)
+    {
+        try {
+            $response = $this->roleUser->getUsers($rol_uid, (preg_match("/^.*\/users$/", $this->restler->url))? "USERS" : "AVAILABLE-USERS", array("filter" => $filter), null, null, $start, $limit);
+
+            return $response;
+        } catch (\Exception $e) {
+            throw new RestException(Api::STAT_APP_EXCEPTION, $e->getMessage());
+        }
+    }
+
+    /**
+     * @url POST /:rol_uid/user
+     *
+     * @param string $rol_uid      {@min 32}{@max 32}
+     * @param array  $request_data
+     *
+     * @status 201
+     */
+    public function doPostUser($rol_uid, array $request_data)
+    {
+        try {
+            $arrayData = $this->roleUser->create($rol_uid, $request_data);
+        } catch (\Exception $e) {
+            throw new RestException(Api::STAT_APP_EXCEPTION, $e->getMessage());
+        }
+    }
+
+    /**
+     * @url DELETE /:rol_uid/user/:usr_uid
+     *
+     * @param string $rol_uid {@min 32}{@max 32}
+     * @param string $usr_uid {@min 32}{@max 32}
+     */
+    public function doDeleteUser($rol_uid, $usr_uid)
+    {
+        try {
+            $this->roleUser->delete($rol_uid, $usr_uid);
+        } catch (\Exception $e) {
+            throw new RestException(Api::STAT_APP_EXCEPTION, $e->getMessage());
+        }
+    }
+}
+