ModTracker_ModTrackerHandler_Handler::entityAfterDelete() - Code Metrics - Inspection of "Improved record tracker" - YetiForceCompany/YetiForceCRM - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — developer ( 9bdcd9...f81d2e )

by Radosław
created 2023-03-03 12:55 UTC
entityAfterDelete() A

↳ Parent: ModTracker_ModTrackerHandler_Handler
Complexity

Conditions	2
Paths	2
Size

Total Lines	12
Code Lines	9
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	6
Importance

Changes
Metric	Value
eloc	9
dl	0
loc	12
ccs	0
cts	0
cp	0
rs	9.9666
c	0
b	0
f	0
cc	2
nc	2
nop	1
crap	6
<?php
/* +**********************************************************************************
 * The contents of this file are subject to the vtiger CRM Public License Version 1.0
 * ("License"); You may not use this file except in compliance with the License
 * The Original Code is:  vtiger CRM Open Source
 * The Initial Developer of the Original Code is vtiger.
 * Portions created by vtiger are Copyright (C) vtiger.
 * All Rights Reserved.
 * Contributor(s): YetiForce S.A.
 * ********************************************************************************** */
require_once __DIR__ . '/../ModTracker.php';

class ModTracker_ModTrackerHandler_Handler
{
	/**
	 * EntityAfterSave function.
	 *
	 * @param App\EventHandler $eventHandler
	 */
	public function entityAfterSave(App\EventHandler $eventHandler)
	{
		if (!ModTracker::isTrackingEnabledForModule($eventHandler->getModuleName())) {
			return false;
		}
		$recordModel = $eventHandler->getRecordModel();
		if ($recordModel->isNew()) {
			$delta = array_intersect_key($recordModel->getData(), $recordModel->getModule()->getFields());
			$delta = array_fill_keys(array_keys($delta), null);
			if ($recordModel->getModule()->isInventory() && ($invData = $recordModel->getInventoryData())) {
				$delta['inventory'] = array_fill_keys(array_keys($invData), []);
			}
			unset($delta['createdtime'], $delta['modifiedtime'], $delta['modifiedby']);
			$status = ModTracker::$CREATED;
			$watchdogTitle = 'LBL_CREATED';
			$watchdogMessage = '$(record : ChangesListValues)$';
		} elseif (isset($recordModel->ext['modificationType'], ModTracker::getAllActionsTypes()[$recordModel->ext['modificationType']])) {
			$delta = $recordModel->getChanges();
			$status = $recordModel->ext['modificationType'];
			$watchdogTitle = $status === ModTracker::$TRANSFER_EDIT ? ModTracker_Record_Model::$statusLabel[$status] : '';
			$watchdogMessage = '';
		} else {
			$delta = $recordModel->getChanges();
			$status = ModTracker::$UPDATED;
			$watchdogTitle = 'LBL_UPDATED';
			$watchdogMessage = '$(record : ChangesListValues)$';
		}
		if ($skipFields = $recordModel->ext['ModTrackerSkipFields'] ?? []) {
			foreach ($delta as $fieldName => $preValue) {
				if (\in_array($fieldName, $skipFields)) {
					unset($delta[$fieldName]);
				}
			}
		}
		if (empty($delta)) {
			return false;
		}
		$recordId = $recordModel->getId();
		$db = \App\Db::getInstance();
		$db->createCommand()->insert('vtiger_modtracker_basic', [
			'crmid' => $recordId,
			'module' => $eventHandler->getModuleName(),
			'whodid' => App\User::getCurrentUserRealId(),
			'changedon' => $recordModel->get('modifiedtime'),
			'status' => $status,
			'last_reviewed_users' => '#' . App\User::getCurrentUserRealId() . '#',
		])->execute();
		$id = $db->getLastInsertID('vtiger_modtracker_basic_id_seq');
		if (!$recordModel->isNew()) {
			ModTracker_Record_Model::unsetReviewed($recordId, App\User::getCurrentUserRealId(), $id);
		}
		if (isset($delta['inventory'])) {
			$inventoryData = [];
			foreach ($delta['inventory'] as $key => $invData) {
				$item = $recordModel->getInventoryItem($key) ?? [];
				$itemId = $invData['id'] ?? $item['id'];
				$inventoryData[$itemId]['item'] = $invData['name'] ?? $item['name'];
				$inventoryData[$itemId]['prevalue'] = $invData;
				$inventoryData[$itemId]['postvalue'] = $invData ? array_intersect_key($item, $invData) : $item;
			}
			$db->createCommand()->insert('u_#__modtracker_inv', ['id' => $id, 'changes' => \App\Json::encode($inventoryData)])->execute();
			unset($delta['inventory']);
		}
		$insertedData = [];
		foreach ($delta as $fieldName => $preValue) {
			$newValue = $recordModel->get($fieldName);
			$fieldModel = $recordModel->getField($fieldName);
			if (empty($preValue) && empty($newValue)) {
				continue;
			}
			if (\is_object($newValue)) {
				throw new App\Exceptions\AppException("Incorrect data type in $fieldName: Value can not be the object of " . \get_class($newValue));
			}
			if (\is_array($newValue)) {
				$newValue = implode(',', $newValue);
			}
			if (!$fieldModel) {
				\App\Log::warning($fieldName . ' field does not exist in the module ' . $eventHandler->getModuleName(), __METHOD__);
			} elseif ('text' === $fieldModel->getFieldDataType()) {
				$preValue = empty($preValue) ? $preValue : \App\TextUtils::textTruncate($preValue, 65532);
				$newValue = empty($newValue) ? $newValue : \App\TextUtils::textTruncate($newValue, 65532);
			}
			if ($fieldModel && \in_array(\App\Anonymization::MODTRACKER_DB, $fieldModel->getAnonymizationTarget())) {
				$preValue = $newValue = '****';
			}
			$insertedData[] = [$id, $fieldName, $preValue, $newValue];
		}
		if ($insertedData) {
			$db->createCommand()
				->batchInsert('vtiger_modtracker_detail', ['id', 'fieldname', 'prevalue', 'postvalue'], $insertedData)
				->execute();
		}
		$this->addNotification($eventHandler->getModuleName(), $recordId, $watchdogTitle, $watchdogMessage);
	}

	/**
	 * EntityAfterLink handler function.
	 *
	 * @param App\EventHandler $eventHandler
	 */
	public function entityAfterLink(App\EventHandler $eventHandler)
	{
		$params = $eventHandler->getParams();
		if (!ModTracker::isTrackingEnabledForModule($params['sourceModule'])) {
			return false;
		}
		ModTracker::linkRelation($params['sourceModule'], $params['sourceRecordId'], $params['destinationModule'], $params['destinationRecordId']);
		if (App\Config::module('ModTracker', 'WATCHDOG')) {
			$watchdogTitle = 'LBL_ADDED';
			$watchdogMessage = '<a href="index.php?module=' . $params['sourceModule'] . '&view=Detail&record=' . $params['sourceRecordId'] . '">' . vtlib\Functions::getCRMRecordLabel($params['sourceRecordId']) . '</a>';
			$watchdogMessage = '<a href="index.php?module=' . $params['sourceModule'] . '&view=Detail&record=' . $params['sourceRecordId'] . '">' . /** @scrutinizer ignore-type */ vtlib\Functions::getCRMRecordLabel($params['sourceRecordId']) . '</a>';
			$watchdogMessage .= ' $(translate : LBL_WITH)$ ';
			$watchdogMessage .= '<a href="index.php?module=' . $params['destinationModule'] . '&view=Detail&record=' . $params['destinationRecordId'] . '">$(record : RecordLabel)$</a>';
			$this->addNotification($params['destinationModule'], $params['destinationRecordId'], $watchdogTitle, $watchdogMessage);
		}
	}

	/**
	 * EntityAfterLinkForSource handler function.
	 *
	 * @param App\EventHandler $eventHandler
	 */
	public function entityAfterLinkForSource(App\EventHandler $eventHandler)
	{
		['sourceModule' => $sourceModule, 'sourceRecordId' => $sourceRecordId,'destinationModule' => $destinationModule,'destinationRecordId' => $destinationRecordId, 'relationId' => $relationId] = $eventHandler->getParams();
		if (!ModTracker::isTrackingEnabledForModule($destinationModule) || Vtiger_Relation_Model::getInstanceById($relationId)->isDirectRelation()) {
			return false;
		}
		ModTracker::linkRelation($destinationModule, $destinationRecordId, $sourceModule, $sourceRecordId);
		if (\App\Config::module('ModTracker', 'WATCHDOG')) {
			$watchdogTitle = 'LBL_ADDED';
			$watchdogMessage = '<a href="index.php?module=' . $destinationModule . '&view=Detail&record=' . $destinationRecordId . '">' . vtlib\Functions::getCRMRecordLabel($destinationRecordId) . '</a>';
			$watchdogMessage = '<a href="index.php?module=' . $destinationModule . '&view=Detail&record=' . $destinationRecordId . '">' . /** @scrutinizer ignore-type */ vtlib\Functions::getCRMRecordLabel($destinationRecordId) . '</a>';
			$watchdogMessage .= ' $(translate : LBL_WITH)$ ';
			$watchdogMessage .= '<a href="index.php?module=' . $sourceModule . '&view=Detail&record=' . $sourceRecordId . '">$(record : RecordLabel)$</a>';
			$this->addNotification($sourceModule, $sourceRecordId, $watchdogTitle, $watchdogMessage);
		}
	}

	/**
	 * EntityAfterUnLink handler function.
	 *
	 * @param App\EventHandler $eventHandler
	 */
	public function entityAfterUnLink(App\EventHandler $eventHandler)
	{
		$params = $eventHandler->getParams();
		if (!ModTracker::isTrackingEnabledForModule($params['sourceModule'])) {
			return false;
		}
		ModTracker::unLinkRelation($params['sourceModule'], $params['sourceRecordId'], $params['destinationModule'], $params['destinationRecordId']);
		if (App\Config::module('ModTracker', 'WATCHDOG')) {
			$watchdogTitle = 'LBL_UNLINK';
			$watchdogMessage = '<a href="index.php?module=' . $params['sourceModule'] . '&view=Detail&record=' . $params['sourceRecordId'] . '">' . vtlib\Functions::getCRMRecordLabel($params['sourceRecordId']) . '</a>';
			$watchdogMessage = '<a href="index.php?module=' . $params['sourceModule'] . '&view=Detail&record=' . $params['sourceRecordId'] . '">' . /** @scrutinizer ignore-type */ vtlib\Functions::getCRMRecordLabel($params['sourceRecordId']) . '</a>';
			$watchdogMessage .= ' $(translate : LBL_WITH)$ ';
			$watchdogMessage .= '<a href="index.php?module=' . $params['destinationModule'] . '&view=Detail&record=' . $params['destinationRecordId'] . '">$(record : RecordLabel)$</a>';
			$this->addNotification($params['destinationModule'], $params['destinationRecordId'], $watchdogTitle, $watchdogMessage);
		}
	}

	/**
	 * EntityAfterUnLinkForSource handler function.
	 *
	 * @param App\EventHandler $eventHandler
	 */
	public function entityAfterUnLinkForSource(App\EventHandler $eventHandler)
	{
		['sourceModule' => $sourceModule, 'sourceRecordId' => $sourceRecordId,'destinationModule' => $destinationModule,'destinationRecordId' => $destinationRecordId, 'relationId' => $relationId] = $eventHandler->getParams();
		if (!ModTracker::isTrackingEnabledForModule($destinationModule) || Vtiger_Relation_Model::getInstanceById($relationId)->isDirectRelation()) {
			return false;
		}

		ModTracker::unLinkRelation($destinationModule, $destinationRecordId, $sourceModule, $sourceRecordId);
		if (App\Config::module('ModTracker', 'WATCHDOG')) {
			$watchdogTitle = 'LBL_UNLINK';
			$watchdogMessage = '<a href="index.php?module=' . $destinationModule . '&view=Detail&record=' . $destinationRecordId . '">' . vtlib\Functions::getCRMRecordLabel($destinationRecordId) . '</a>';
			$watchdogMessage = '<a href="index.php?module=' . $destinationModule . '&view=Detail&record=' . $destinationRecordId . '">' . /** @scrutinizer ignore-type */ vtlib\Functions::getCRMRecordLabel($destinationRecordId) . '</a>';
			$watchdogMessage .= ' $(translate : LBL_WITH)$ ';
			$watchdogMessage .= '<a href="index.php?module=' . $sourceModule . '&view=Detail&record=' . $sourceRecordId . '">$(record : RecordLabel)$</a>';
			$this->addNotification($sourceModule, $sourceRecordId, $watchdogTitle, $watchdogMessage);
		}
	}

	/**
	 * EntityAfterTransferLink handler function.
	 *
	 * @param App\EventHandler $eventHandler
	 *
	 * @return bool
	 */
	public function entityAfterTransferLink(App\EventHandler $eventHandler)
	{
		$params = $eventHandler->getParams();
		if (!ModTracker::isTrackingEnabledForModule($eventHandler->getModuleName())) {
			return false;
		}
		ModTracker::transferRelation($eventHandler->getModuleName(), $params['sourceRecordId'], $params['destinationModule'], $params['destinationRecordId'], ModTracker::$TRANSFER_LINK);
	}

	/**
	 * @param App\EventHandler $eventHandler
	 *
	 * @return bool
	 */
	public function entityAfterTransferUnLink(App\EventHandler $eventHandler)
	{
		$params = $eventHandler->getParams();
		if (!ModTracker::isTrackingEnabledForModule($eventHandler->getModuleName())) {
			return false;
		}
		ModTracker::transferRelation($eventHandler->getModuleName(), $params['sourceRecordId'], $params['destinationModule'], $params['destinationRecordId'], ModTracker::$TRANSFER_UNLINK);
	}

	/**
	 * DetailViewBefore handler function.
	 *
	 * @param App\EventHandler $eventHandler
	 */
	public function detailViewBefore(App\EventHandler $eventHandler)
	{
		if (!ModTracker::isTrackingEnabledForModule($eventHandler->getModuleName())) {
			return false;
		}
		\App\Db::getInstance()->createCommand()->insert('vtiger_modtracker_basic', [
			'crmid' => $eventHandler->getRecordModel()->getId(),
			'module' => $eventHandler->getModuleName(),
			'whodid' => \App\User::getCurrentUserRealId(),
			'changedon' => date('Y-m-d H:i:s'),
			'status' => ModTracker::$DISPLAYED,
		])->execute();
	}

	/**
	 * EntityChangeState handler function.
	 *
	 * @param App\EventHandler $eventHandler
	 */
	public function entityChangeState(App\EventHandler $eventHandler)
	{
		if (!ModTracker::isTrackingEnabledForModule($eventHandler->getModuleName())) {
			return false;
		}
		$recordModel = $eventHandler->getRecordModel();
		$recordId = $recordModel->getId();
		$status = 0;
		if (isset($recordModel->ext['modificationType'], ModTracker::getAllActionsTypes()[$recordModel->ext['modificationType']])) {
			$status = $recordModel->ext['modificationType'];
		} elseif (is_numeric($state = $recordModel->get('deleted'))) {
			switch ($state) {
				case \App\Record::STATE_ACTIVE:
					$status = ModTracker::$ACTIVE;
					break;
				case \App\Record::STATE_TRASH:
					$status = ModTracker::$TRASH;
					break;
				case \App\Record::STATE_ARCHIVED:
					$status = ModTracker::$ARCHIVED;
					break;
				default:
					break;
			}
		}
		$db = \App\Db::getInstance();
		$db->createCommand()->insert('vtiger_modtracker_basic', [
			'crmid' => $recordId,
			'module' => $eventHandler->getModuleName(),
			'whodid' => \App\User::getCurrentUserRealId(),
			'changedon' => date('Y-m-d H:i:s'),
			'status' => $status,
			'last_reviewed_users' => '#' . \App\User::getCurrentUserRealId() . '#',
		])->execute();
		$id = $db->getLastInsertID('vtiger_modtracker_basic_id_seq');
		ModTracker_Record_Model::unsetReviewed($recordId, \App\User::getCurrentUserRealId(), $id);
		$isExists = (new \App\Db\Query())->from('vtiger_crmentity')->where(['crmid' => $recordId])->andWhere(['<>', 'smownerid', \App\User::getCurrentUserRealId()])->exists();
		if ($isExists) {
			$db->createCommand()->update('vtiger_crmentity', ['was_read' => 0], ['crmid' => $recordId])->execute();
		}
		$this->addNotification($eventHandler->getModuleName(), $recordId, ModTracker_Record_Model::$statusLabel[$status]);
	}

	/**
	 * EntityAfterDelete handler function.
	 *
	 * @param \App\EventHandler $eventHandler
	 */
	public function entityAfterDelete(App\EventHandler $eventHandler)
	{
		if (!ModTracker::isTrackingEnabledForModule($eventHandler->getModuleName())) {
			return false;
		}
		\App\Db::getInstance()->createCommand()->insert('vtiger_modtracker_basic', [
			'crmid' => $eventHandler->getRecordModel()->getId(),
			'module' => $eventHandler->getModuleName(),
			'whodid' => \App\User::getCurrentUserRealId(),
			'changedon' => date('Y-m-d H:i:s'),
			'status' => ModTracker::$DELETED,
		])->execute();
	}

	/**
	 * Show hidden data handler function.
	 *
	 * @param App\EventHandler $eventHandler
	 */
	public function entityAfterShowHiddenData(App\EventHandler $eventHandler)
	{
		if (!ModTracker::isTrackingEnabledForModule($eventHandler->getModuleName())) {
			return false;
		}
		$recordModel = $eventHandler->getRecordModel();
		\App\Db::getInstance()->createCommand()->insert('vtiger_modtracker_basic', [
			'crmid' => $recordModel->getId(),
			'module' => $eventHandler->getModuleName(),
			'whodid' => \App\User::getCurrentUserRealId(),
			'changedon' => date('Y-m-d H:i:s'),
			'status' => ModTracker::$SHOW_HIDDEN_DATA,
		])->execute();
	}

	/**
	 * Add notification in handler.
	 *
	 * @param string $moduleName
	 * @param int    $recordId
	 * @param string $watchdogTitle
	 * @param string $watchdogMessage
	 */
	public function addNotification($moduleName, $recordId, $watchdogTitle, $watchdogMessage = '')
	{
		if ($watchdogTitle) {
			$watchdog = Vtiger_Watchdog_Model::getInstanceById($recordId, $moduleName);
			$users = $watchdog->getWatchingUsers([\App\User::getCurrentUserRealId()]);
			if (!empty($users)) {
				$watchdogTitle = '$(translate : ModTracker|' . $watchdogTitle . ')$ $(record : RecordLabel)$';
				$watchdogTitle = \App\Fields\Owner::getUserLabel(\App\User::getCurrentUserId()) . ' ' . $watchdogTitle;
				$relatedField = \App\ModuleHierarchy::getMappingRelatedField($moduleName);
				if ($relatedField) {
					$notification = Vtiger_Record_Model::getCleanInstance('Notification');
					$notification->set('shownerid', $users);
					$notification->set($relatedField, $recordId);
					$notification->set('title', $watchdogTitle);
					$notification->set('description', $watchdogMessage);
					$notification->set('notification_type', $watchdog->noticeDefaultType);
					$notification->set('notification_status', 'PLL_UNREAD');
					$notification->setHandlerExceptions(['disableHandlerClasses' => ['ModTracker_ModTrackerHandler_Handler']]);
					$notification->save();
				}
			}
		}
	}
}

YetiForceCompany / YetiForceCRM

Push — developer ( 9bdcd9...f81d2e )

entityAfterDelete() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
