ListModule::search()

Complexity

Conditions	26
Paths	9226

Size

Total Lines	186
Code Lines	96

Duplication

Lines	0
Ratio	0 %

Importance

Changes

0

<?php
	public function search($store, $entryid, $action, $actionType) {
		$useSearchFolder = $action["use_searchfolder"] ?? false;
		if (!$useSearchFolder) {
			/*
			 * store doesn't support search folders so we can't use this
			 * method instead we will pass restriction to messageList and
			 * it will give us the restricted results
			 */
			return $this->messageList($store, $entryid, $action, "list");

Are you sure the usage of $this->messageList($store, $entryid, $action, 'list') targeting ListModule::messageList() seems to always return null.

$action of type object is incompatible with the type array expected by parameter $action of ListModule::messageList().

		}

		$this->searchFolderList = true; // Set to indicate this is not the normal folder, but a search folder
		$this->restriction = false;

It seems like false of type false is incompatible with the declared type array of property $restriction.

		$searchInTodoList = $GLOBALS['entryid']->compareEntryIds(bin2hex($entryid), bin2hex(TodoList::getEntryId()));

		// Parse Restriction
		$this->parseRestriction($action);
		if ($this->restriction == false) {
			// if error in creating restriction then send error to client
			$errorInfo = [];
			$errorInfo["error_message"] = _("Error in search, please try again") . ".";
			$errorInfo["original_error_message"] = "Error in parsing restrictions.";

			return $this->sendSearchErrorToClient($store, $entryid, $action, $errorInfo);

$errorInfo of type array is incompatible with the type object expected by parameter $errorInfo of ListModule::sendSearchErrorToClient().

$entryid of type string is incompatible with the type hexString expected by parameter $entryid of ListModule::sendSearchErrorToClient().

		}

		if ($searchInTodoList) {
			// Since we cannot search in a search folder, we will combine the search restriction
			// with the search restriction of the to-do list to mimic searching in the To-do list
			$this->restriction = [
				RES_AND,
				[
					$this->restriction,
					TodoList::_createRestriction(),
				],
			];

			// When searching in the To-do list we will actually always search in the IPM subtree, so
			// set the entryid to that.
			$userStore = WebAppAuthentication::getMAPISession()->getDefaultMessageStore();
			$props = mapi_getprops($userStore, [PR_IPM_SUBTREE_ENTRYID]);
			$entryid = $props[PR_IPM_SUBTREE_ENTRYID];
		}

		$isSetSearchFolderEntryId = isset($action['search_folder_entryid']);
		if ($isSetSearchFolderEntryId) {
			$this->sessionData['searchFolderEntryId'] = $action['search_folder_entryid'];
		}

		if (isset($action['forceCreateSearchFolder']) && $action['forceCreateSearchFolder']) {
			$isSetSearchFolderEntryId = false;
		}

		// create or open search folder
		$searchFolder = $this->createSearchFolder($store, $isSetSearchFolderEntryId);
		if ($searchFolder === false) {
			// if error in creating search folder then send error to client
			$errorInfo = [];

			$errorInfo["error_message"] = match (mapi_last_hresult()) {
				MAPI_E_NO_ACCESS => _("Unable to perform search query, no permissions to create search folder."),
				MAPI_E_NOT_FOUND => _("Unable to perform search query, search folder not found."),
				default => _("Unable to perform search query, store might not support searching."),
			};

			$errorInfo["original_error_message"] = _("Error in creating search folder.");

			return $this->sendSearchErrorToClient($store, $entryid, $action, $errorInfo);

$errorInfo of type array is incompatible with the type object expected by parameter $errorInfo of ListModule::sendSearchErrorToClient().

		}

		$subfolder_flag = 0;
		if ($searchInTodoList || (isset($action["subfolders"]) && $action["subfolders"] == "true")) {
			$subfolder_flag = RECURSIVE_SEARCH;
		}

		if (!is_array($entryid)) {
			$entryids = [$entryid];
		}
		else {
			$entryids = $entryid;
		}

		$searchFolderEntryId = $this->sessionData['searchFolderEntryId'];

		// check if searchcriteria has changed
		$restrictionCheck = md5(serialize($this->restriction) . $searchFolderEntryId . $subfolder_flag);

		// check if there is need to set searchcriteria again
		if (!isset($this->sessionData['searchCriteriaCheck']) || $restrictionCheck != $this->sessionData['searchCriteriaCheck']) {
			if (!empty($this->sessionData['searchOriginalEntryids'])) {
				// get entryids of original folders, and use it to set new search criteria
				$entryids = [];
				for ($index = 0; $index < count($this->sessionData['searchOriginalEntryids']); ++$index) {

It seems like you are calling the size function count() as part of the test condition. You might want to compute the size beforehand, and not on each iteration.

					$entryids[] = hex2bin((string) $this->sessionData['searchOriginalEntryids'][$index]);
				}
			}
			else {
				// store entryids of original folders, so that can be used for re-setting the search criteria if needed
				$this->sessionData['searchOriginalEntryids'] = [];
				for ($index = 0, $len = count($entryids); $index < $len; ++$index) {
					$this->sessionData['searchOriginalEntryids'][] = bin2hex((string) $entryids[$index]);
				}
			}

			mapi_folder_setsearchcriteria($searchFolder, $this->restriction, $entryids, $subfolder_flag);
			$this->sessionData['searchCriteriaCheck'] = $restrictionCheck;
		}

		if (isset($this->sessionData['searchCriteriaCheck']) || $restrictionCheck == $this->sessionData['searchCriteriaCheck']) {
			$folderEntryid = bin2hex((string) $entryid);
			if ($this->sessionData['searchOriginalEntryids'][0] !== $folderEntryid) {
				$this->sessionData['searchOriginalEntryids'][0] = $folderEntryid;
				mapi_folder_setsearchcriteria($searchFolder, $this->restriction, [$entryid], $subfolder_flag);
			}
		}

		unset($action["restriction"]);

		// Sort
		$this->parseSortOrder($action);

		// Create the data array, which will be send back to the client
		$data = [];

		// Wait until we have some data, no point in returning before we have data. Stop waiting after 10 seconds
		$start = time();
		$table = mapi_folder_getcontentstable($searchFolder, MAPI_DEFERRED_ERRORS);

		sleep(1);

		while (time() - $start < 10) {
			$count = mapi_table_getrowcount($table);
			$result = mapi_folder_getsearchcriteria($searchFolder);

			// Stop looping if we have data or the search is finished
			if ($count > 0) {
				break;
			}

			if (($result["searchstate"] & SEARCH_REBUILD) == 0) {
				break;
			} // Search is done

			sleep(1);
		}

		// Get the table and merge the arrays
		$table = $GLOBALS["operations"]->getTable($store, hex2bin((string) $searchFolderEntryId), $this->properties, $this->sort, $this->start);
		$data = array_merge($data, $table);

		$this->getDelegateFolderInfo($store);

$store of type object is incompatible with the type resource expected by parameter $store of ListModule::getDelegateFolderInfo().

		$data = $this->filterPrivateItems($data);

		// remember which entryid's are send to the client
		$searchResults = [];
		foreach ($table["item"] as $item) {
			// store entryid => last_modification_time mapping
			$searchResults[$item["entryid"]] = $item["props"]["last_modification_time"];
		}

		// store search results into session data
		if (!isset($this->sessionData['searchResults'])) {
			$this->sessionData['searchResults'] = [];
		}
		$this->sessionData['searchResults'][$searchFolderEntryId] = $searchResults;

		$result = mapi_folder_getsearchcriteria($searchFolder);

		$data["search_meta"] = [];
		$data["search_meta"]["searchfolder_entryid"] = $searchFolderEntryId;
		$data["search_meta"]["search_store_entryid"] = $action["store_entryid"];
		$data["search_meta"]["searchstate"] = $result["searchstate"];
		$data["search_meta"]["results"] = count($searchResults);

		// Reopen the search folder, because otherwise the suggestion property will
		// not have been updated
		$searchFolder = $this->createSearchFolder($store, true);
		$storeProps = mapi_getprops($searchFolder, [PR_EC_SUGGESTION]);
		if (isset($storeProps[PR_EC_SUGGESTION])) {
			$data["search_meta"]["suggestion"] = $storeProps[PR_EC_SUGGESTION];
		}

		$this->addActionData("search", $data);
		$GLOBALS["bus"]->addData($this->getResponseData());

		return true;
	}