YetiForceCompany /
YetiForceCRM
| Total Complexity | 41 |
| Total Lines | 163 |
| Duplicated Lines | 0 % |
| Changes | 0 | ||
Complex classes like Privilege often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Privilege, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 18 | class Privilege |
||
| 19 | { |
||
| 20 | /** |
||
| 21 | * Permissions based on user. |
||
| 22 | */ |
||
| 23 | const USER_PERMISSIONS = 1; |
||
| 24 | /** |
||
| 25 | * All records of account assigned directly to contact. |
||
| 26 | */ |
||
| 27 | const ACCOUNTS_RELATED_RECORDS = 2; |
||
| 28 | /** |
||
| 29 | * All related records of account assigned directly to contact and accounts lower in hierarchy. |
||
| 30 | */ |
||
| 31 | const ACCOUNTS_RELATED_RECORDS_AND_LOWER_IN_HIERARCHY = 3; |
||
| 32 | /** |
||
| 33 | * All related records of account assigned directly to contact and accounts from hierarchy. |
||
| 34 | */ |
||
| 35 | const ACCOUNTS_RELATED_RECORDS_IN_HIERARCHY = 4; |
||
| 36 | |||
| 37 | /** |
||
| 38 | * Function to check permission for a Module/Action/Record. |
||
| 39 | * |
||
| 40 | * @param string $moduleName |
||
| 41 | * @param string $actionName |
||
| 42 | * @param bool|int $record |
||
| 43 | * @param mixed $userId |
||
| 44 | * |
||
| 45 | * @throws \Api\Core\Exception |
||
| 46 | * |
||
| 47 | * @return bool |
||
| 48 | */ |
||
| 49 | public static function isPermitted(string $moduleName, $actionName = null, $record = false, $userId = false) |
||
| 50 | { |
||
| 51 | if (!$userId) { |
||
| 52 | $user = \App\User::getCurrentUserModel(); |
||
| 53 | } else { |
||
| 54 | $user = \App\User::getUserModel($userId); |
||
| 55 | } |
||
| 56 | $userId = $user->getId(); |
||
| 57 | if (empty($record) || !$user->has('permission_type')) { |
||
| 58 | return \App\Privilege::checkPermission($moduleName, $actionName, $record, $userId); |
||
| 59 | } |
||
| 60 | switch ($user->get('permission_type')) { |
||
| 61 | case self::USER_PERMISSIONS: |
||
| 62 | return \App\Privilege::checkPermission($moduleName, $actionName, $record, $userId); |
||
| 63 | case self::ACCOUNTS_RELATED_RECORDS: |
||
| 64 | $parentRecordId = \App\Record::getParentRecord($user->get('permission_crmid')); |
||
| 65 | break; |
||
| 66 | case self::ACCOUNTS_RELATED_RECORDS_AND_LOWER_IN_HIERARCHY: |
||
| 67 | case self::ACCOUNTS_RELATED_RECORDS_IN_HIERARCHY: |
||
| 68 | $parentRecordId = static::getParentCrmId($user); |
||
| 69 | break; |
||
| 70 | default: |
||
| 71 | throw new \Api\Core\Exception('Invalid permissions ', 400); |
||
| 72 | } |
||
| 73 | if ('ModComments' !== $moduleName && !($permissionFieldInfo = \Api\Core\Module::getApiFieldPermission($moduleName, $user->get('permission_app')))) { |
||
| 74 | \App\Privilege::$isPermittedLevel = 'FIELD_PERMISSION_NOT_EXISTS'; |
||
| 75 | return false; |
||
| 76 | } |
||
| 77 | if (!\App\Privilege::checkPermission($moduleName, $actionName, $record, $userId)) { |
||
| 78 | return false; |
||
| 79 | } |
||
| 80 | if (0 === \App\ModuleHierarchy::getModuleLevel($moduleName)) { |
||
| 81 | $permission = $parentRecordId === $record; |
||
| 82 | \App\Privilege::$isPermittedLevel = 'RECORD_HIERARCHY_LEVEL_' . ($permission ? 'YES' : 'NO'); |
||
| 83 | return $permission; |
||
| 84 | } |
||
| 85 | $recordModel = \Vtiger_Record_Model::getInstanceById($record, $moduleName); |
||
| 86 | if ('ModComments' !== $moduleName && !$recordModel->get($permissionFieldInfo['fieldname'])) { |
||
|
Comprehensibility
Best Practice
introduced
by
|
|||
| 87 | \App\Privilege::$isPermittedLevel = "FIELD_PERMISSION_NO {$permissionFieldInfo['fieldname']}: {$recordModel->get($permissionFieldInfo['fieldname'])}"; |
||
| 88 | return false; |
||
| 89 | } |
||
| 90 | |||
| 91 | $parentModule = \App\Record::getType($parentRecordId) ?? ''; |
||
| 92 | $moduleModel = $recordModel->getModule(); |
||
| 93 | if (\in_array($moduleName, ['Products', 'Services'])) { |
||
| 94 | \App\Privilege::$isPermittedLevel = $moduleName . '_SPECIAL_PERMISSION_YES'; |
||
| 95 | return true; |
||
| 96 | } |
||
| 97 | $fieldsForParent = $moduleModel->getReferenceFieldsForModule($parentModule); |
||
| 98 | if ($fieldsForParent) { |
||
| 99 | foreach ($fieldsForParent as $referenceField) { |
||
| 100 | if ($recordModel->get($referenceField->getName()) === $parentRecordId) { |
||
| 101 | \App\Privilege::$isPermittedLevel = 'RECORD_RELATED_YES'; |
||
| 102 | return true; |
||
| 103 | } |
||
| 104 | } |
||
| 105 | \App\Privilege::$isPermittedLevel = 'RECORD_RELATED_NO'; |
||
| 106 | return false; |
||
| 107 | } |
||
| 108 | foreach (array_keys(\App\Relation::getByModule($parentModule, true, $moduleName)) as $relationId) { |
||
| 109 | $relationModel = \Vtiger_Relation_Model::getInstanceById($relationId); |
||
| 110 | $relationModel->set('parentRecord', \Vtiger_Record_Model::getInstanceById($parentRecordId, $parentModule)); |
||
| 111 | $queryGenerator = $relationModel->getQuery(); |
||
| 112 | $queryGenerator->permissions = false; |
||
| 113 | $queryGenerator->clearFields()->setFields(['id'])->addCondition('id', $record, 'e'); |
||
| 114 | if ($queryGenerator->createQuery()->exists()) { |
||
| 115 | \App\Privilege::$isPermittedLevel = $moduleName . '_RELATED_YES'; |
||
| 116 | return true; |
||
| 117 | } |
||
| 118 | } |
||
| 119 | if ($fields = $moduleModel->getFieldsByReference()) { |
||
| 120 | foreach ($fields as $fieldModel) { |
||
| 121 | if (!$fieldModel->isActiveField() || $recordModel->isEmpty($fieldModel->getName())) { |
||
| 122 | continue; |
||
| 123 | } |
||
| 124 | $relRecordId = $recordModel->get($fieldModel->getName()); |
||
| 125 | foreach ($fieldModel->getReferenceList() as $relModuleName) { |
||
| 126 | if ('Users' === $relModuleName || $relModuleName === $parentModule || $relModuleName === $moduleName) { |
||
| 127 | continue; |
||
| 128 | } |
||
| 129 | $relModuleModel = \Vtiger_Module_Model::getInstance($relModuleName); |
||
| 130 | foreach ($relModuleModel->getReferenceFieldsForModule($parentModule) as $referenceField) { |
||
| 131 | if (\App\Record::isExists($relRecordId, $relModuleName) && \App\Record::getType($relRecordId) === $relModuleName && \Vtiger_Record_Model::getInstanceById($relRecordId, $relModuleName)->get($referenceField->getName()) === $parentRecordId) { |
||
| 132 | \App\Privilege::$isPermittedLevel = $moduleName . '_RELATED_SL_YES'; |
||
| 133 | return true; |
||
| 134 | } |
||
| 135 | } |
||
| 136 | } |
||
| 137 | } |
||
| 138 | } |
||
| 139 | if ('Documents' === $moduleName) { |
||
| 140 | foreach (\Documents_Record_Model::getReferenceModuleByDocId($record) as $parentModuleName) { |
||
| 141 | $relationListView = \Vtiger_RelationListView_Model::getInstance($recordModel, $parentModuleName); |
||
| 142 | $relationListView->setFields([]); |
||
| 143 | $relationListView->getQueryGenerator()->setFields(['id'])->setLimit(10)->permissions = false; |
||
| 144 | $dataReader = $relationListView->getRelationQuery()->createCommand()->query(); |
||
| 145 | while ($id = $dataReader->readColumn(0)) { |
||
| 146 | if (\App\Privilege::isPermitted($parentModuleName, 'DetailView', $id, $user->getId())) { |
||
| 147 | \App\Privilege::$isPermittedLevel = "PERMISSION_{$parentModuleName}_YES-{$id}"; |
||
| 148 | return true; |
||
| 149 | } |
||
| 150 | } |
||
| 151 | } |
||
| 152 | } |
||
| 153 | |||
| 154 | \App\Privilege::$isPermittedLevel = 'ALL_PERMISSION_NO'; |
||
| 155 | return false; |
||
| 156 | } |
||
| 157 | |||
| 158 | /** |
||
| 159 | * Gets parent ID. |
||
| 160 | * |
||
| 161 | * @param \App\User $user |
||
| 162 | * |
||
| 163 | * @return int |
||
| 164 | */ |
||
| 165 | public static function getParentCrmId(\App\User $user): int |
||
| 181 | } |
||
| 182 | } |
||
| 183 |
Loading history...
