FreeBusy::getLocalFreeBusyMessage() - Code Metrics - Inspection of "mapi-header-php 1.5" - grommunio/mapi-header-php - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 6ab1bb...29373f )

unknown

created 2025-01-23 00:49 UTC

FreeBusy::getLocalFreeBusyMessage() B

↳ Parent: FreeBusy

Complexity

Conditions	7
Paths	6

Size

Total Lines	67
Code Lines	32

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	1	Features	0

Metric	Value
cc	7
eloc	32
nc	6
nop	1
dl	0
loc	67
rs	8.4746
c	3
b	1
f	0

How to fix Long Method

<?php
/*
 * SPDX-License-Identifier: AGPL-3.0-only
 * SPDX-FileCopyrightText: Copyright 2005-2016 Zarafa Deutschland GmbH
 * SPDX-FileCopyrightText: Copyright 2020-2024 grommunio GmbH
 */

/**
 * This class is just static class and will not be instantiate and
 * It contains the functionality to get freebusy message and folder.
 */
class FreeBusy {
	/**
	 *  PR_FREEBUSY_ENTRYIDS contains 4 entryids
	 *	PR_FREEBUSY_ENTRYIDS[0] gives associated freebusy folder in calendar
	 *	PR_FREEBUSY_ENTRYIDS[1] Localfreebusy (used for delegate properties)
	 *	PR_FREEBUSY_ENTRYIDS[2] global Freebusydata in public store
	 *	PR_FREEBUSY_ENTRYIDS[3] Freebusydata in IPM_SUBTREE.
	 */
	public const ASSOCIATED_FREEBUSY_FOLDER = 0;
	public const DELEGATE_PROPERTIES = 1;
	public const GLOBAL_FREEBUSYDATA = 2;
	public const FREEBUSYDATA_IPM_SUBTREE = 3;

	/**
	 * Function will return resource of the local freebusy message of the user's store.
	 *
	 * @param mixed $store (optional) user's store
	 *
	 * @return bool|resource local freebusy message, otherwise false if message not found
	 */
	public static function getLocalFreeBusyMessage($store = false) {
		if (!$store) {
			error_log("getLocalFreeBusyMessage: store not available");

			return false;
		}

		// Check for mapi_freebusy_openmsg function,
		// If yes then use mapi function to get freebusy message.
		if (function_exists('mapi_freebusy_openmsg')) {
			return mapi_freebusy_openmsg($store);
		}

		// Get 'LocalFreeBusy' message from FreeBusy Store
		$root = mapi_msgstore_openentry($store);
		$storeProps = mapi_getprops($root, [PR_FREEBUSY_ENTRYIDS]);
		$localFreeBusyEntryids = $storeProps[PR_FREEBUSY_ENTRYIDS];

		try {
			return mapi_msgstore_openentry($store, $localFreeBusyEntryids[self::DELEGATE_PROPERTIES]);

		}
		catch (MAPIException $e) {
			// Either user store have malformed entryid in PR_FREEBUSY_ENTRYIDS or
			// No message found of given entryid in 'Freebusy Data' folder.
			if ($e->getCode() == MAPI_E_NOT_FOUND || $e->getCode() == MAPI_E_INVALID_ENTRYID) {
				$freeBusyFolder = mapi_msgstore_openentry($store, $localFreeBusyEntryids[self::FREEBUSYDATA_IPM_SUBTREE]);
				$table = mapi_folder_getcontentstable($freeBusyFolder);
				mapi_table_restrict(
					$table,
					[
						RES_CONTENT,
						[
							FUZZYLEVEL => FL_PREFIX,
							ULPROPTAG => PR_MESSAGE_CLASS,
							VALUE => [PR_MESSAGE_CLASS => "IPM.Microsoft.ScheduleData.FreeBusy"],
						],
					]
				);

				$items = mapi_table_queryallrows($table, [PR_ENTRYID]);
				if (empty($items)) {
					// FIXME recreate local freebusy message in 'Freebusy Data' folder.
					error_log("Unable to find local free busy message in 'Freebusy Data' folder");

					return false;
				}

				$localFreeBusyEntryids[1] = $items[0][PR_ENTRYID];

				// Updating the entryid in the PR_FREEBUSY_ENTRYIDS property of user store.
				mapi_setprops($root, [PR_FREEBUSY_ENTRYIDS => $localFreeBusyEntryids]);
				mapi_savechanges($root);

				return mapi_msgstore_openentry($store, $localFreeBusyEntryids[self::DELEGATE_PROPERTIES]);

			}

			// Ensure to return false if an exception occurs
			error_log("getLocalFreeBusyMessage: unhandled MAPIException " . $e->getMessage());

			return false;

		}

		// Fallback, should not typically reach here.
		error_log("getLocalFreeBusyMessage: reached unexpected code path");
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}

		return false;

	}

	/**
	 * Function will return resource of the freebusy folder of the user's store.
	 *
	 * @param mixed $store (optional) user's store
	 *
	 * @return bool|resource freebusy folder
	 */
	public static function getLocalFreeBusyFolder($store = false) {
		if (!$store) {
			error_log("getLocalFreeBusyFolder: store not available");

			return false;
		}
		// Get 'LocalFreeBusy' message from FreeBusy Store
		$root = mapi_msgstore_openentry($store);
		$storeProps = mapi_getprops($root, [PR_FREEBUSY_ENTRYIDS]);

		return mapi_msgstore_openentry($store, $storeProps[PR_FREEBUSY_ENTRYIDS][self::FREEBUSYDATA_IPM_SUBTREE]);

	}
}


1			<?php
2			/*
3			* SPDX-License-Identifier: AGPL-3.0-only
4			* SPDX-FileCopyrightText: Copyright 2005-2016 Zarafa Deutschland GmbH
5			* SPDX-FileCopyrightText: Copyright 2020-2024 grommunio GmbH
6			*/
7
8			/**
9			* This class is just static class and will not be instantiate and
10			* It contains the functionality to get freebusy message and folder.
11			*/
12			class FreeBusy {
13			/**
14			* PR_FREEBUSY_ENTRYIDS contains 4 entryids
15			* PR_FREEBUSY_ENTRYIDS[0] gives associated freebusy folder in calendar
16			* PR_FREEBUSY_ENTRYIDS[1] Localfreebusy (used for delegate properties)
17			* PR_FREEBUSY_ENTRYIDS[2] global Freebusydata in public store
18			* PR_FREEBUSY_ENTRYIDS[3] Freebusydata in IPM_SUBTREE.
19			*/
20			public const ASSOCIATED_FREEBUSY_FOLDER = 0;
21			public const DELEGATE_PROPERTIES = 1;
22			public const GLOBAL_FREEBUSYDATA = 2;
23			public const FREEBUSYDATA_IPM_SUBTREE = 3;
24
25			/**
26			* Function will return resource of the local freebusy message of the user's store.
27			*
28			* @param mixed $store (optional) user's store
29			*
30			* @return bool\|resource local freebusy message, otherwise false if message not found
31			*/
32			public static function getLocalFreeBusyMessage($store = false) {
33			if (!$store) {
34			error_log("getLocalFreeBusyMessage: store not available");
35
36			return false;
37			}
38
39			// Check for mapi_freebusy_openmsg function,
40			// If yes then use mapi function to get freebusy message.
41			if (function_exists('mapi_freebusy_openmsg')) {
42			return mapi_freebusy_openmsg($store);
43			}
44
45			// Get 'LocalFreeBusy' message from FreeBusy Store
46			$root = mapi_msgstore_openentry($store);
47			$storeProps = mapi_getprops($root, [PR_FREEBUSY_ENTRYIDS]);
48			$localFreeBusyEntryids = $storeProps[PR_FREEBUSY_ENTRYIDS];
49
50			try {
51			return mapi_msgstore_openentry($store, $localFreeBusyEntryids[self::DELEGATE_PROPERTIES]);
			0 ignored issues – show Bug Best Practice introduced 2024-06-07 17:17 UTC by Report Bug Copy Issue Report The expression `return mapi_msgstore_ope...::DELEGATE_PROPERTIES])` returns the type `resource` which is incompatible with the documented return type `boolean\|resource`. Loading history...
52			}
53			catch (MAPIException $e) {
54			// Either user store have malformed entryid in PR_FREEBUSY_ENTRYIDS or
55			// No message found of given entryid in 'Freebusy Data' folder.
56			if ($e->getCode() == MAPI_E_NOT_FOUND \|\| $e->getCode() == MAPI_E_INVALID_ENTRYID) {
57			$freeBusyFolder = mapi_msgstore_openentry($store, $localFreeBusyEntryids[self::FREEBUSYDATA_IPM_SUBTREE]);
58			$table = mapi_folder_getcontentstable($freeBusyFolder);
59			mapi_table_restrict(
60			$table,
61			[
62			RES_CONTENT,
63			[
64			FUZZYLEVEL => FL_PREFIX,
65			ULPROPTAG => PR_MESSAGE_CLASS,
66			VALUE => [PR_MESSAGE_CLASS => "IPM.Microsoft.ScheduleData.FreeBusy"],
67			],
68			]
69			);
70
71			$items = mapi_table_queryallrows($table, [PR_ENTRYID]);
72			if (empty($items)) {
73			// FIXME recreate local freebusy message in 'Freebusy Data' folder.
74			error_log("Unable to find local free busy message in 'Freebusy Data' folder");
75
76			return false;
77			}
78
79			$localFreeBusyEntryids[1] = $items[0][PR_ENTRYID];
80
81			// Updating the entryid in the PR_FREEBUSY_ENTRYIDS property of user store.
82			mapi_setprops($root, [PR_FREEBUSY_ENTRYIDS => $localFreeBusyEntryids]);
83			mapi_savechanges($root);
84
85			return mapi_msgstore_openentry($store, $localFreeBusyEntryids[self::DELEGATE_PROPERTIES]);
			0 ignored issues – show Bug Best Practice introduced 2024-06-07 17:17 UTC by Report Bug Copy Issue Report The expression `return mapi_msgstore_ope...::DELEGATE_PROPERTIES])` returns the type `resource` which is incompatible with the documented return type `boolean\|resource`. Loading history...
86			}
87
88			// Ensure to return false if an exception occurs
89			error_log("getLocalFreeBusyMessage: unhandled MAPIException " . $e->getMessage());
90
91			return false;
92
93			}
94
95			// Fallback, should not typically reach here.
96			error_log("getLocalFreeBusyMessage: reached unexpected code path");
			0 ignored issues – show Unused Code introduced 2024-05-04 16:59 UTC by Report Bug Copy Issue Report `error_log('getLocalFreeB... unexpected code path')` is not reachable. This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed. Unreachable code is most often the result of `return`, `die` or `exit` statements that have been added for debug purposes. function fx() { try { doSomething(); return true; } catch (\Exception $e) { return false; } return false; } In the above example, the last `return false` will never be executed, because a return statement has already been met in every possible execution path. Loading history...
97
98			return false;
99
100			}
101
102			/**
103			* Function will return resource of the freebusy folder of the user's store.
104			*
105			* @param mixed $store (optional) user's store
106			*
107			* @return bool\|resource freebusy folder
108			*/
109			public static function getLocalFreeBusyFolder($store = false) {
110			if (!$store) {
111			error_log("getLocalFreeBusyFolder: store not available");
112
113			return false;
114			}
115			// Get 'LocalFreeBusy' message from FreeBusy Store
116			$root = mapi_msgstore_openentry($store);
117			$storeProps = mapi_getprops($root, [PR_FREEBUSY_ENTRYIDS]);
118
119			return mapi_msgstore_openentry($store, $storeProps[PR_FREEBUSY_ENTRYIDS][self::FREEBUSYDATA_IPM_SUBTREE]);
			0 ignored issues – show Bug Best Practice introduced 2024-06-07 17:17 UTC by Report Bug Copy Issue Report The expression `return mapi_msgstore_ope...EBUSYDATA_IPM_SUBTREE])` returns the type `resource` which is incompatible with the documented return type `boolean\|resource`. Loading history...
120			}
121			}
122

grommunio / mapi-header-php

Push — master ( 6ab1bb...29373f )

FreeBusy::getLocalFreeBusyMessage() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like