calendar_owner_etemplate_widget::beforeSendToClient() - Code Metrics - Inspection of "Fix calendar participants validation error, caused..." - EGroupware/egroupware - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 16.1 ( c4b782...6c2a65 )

by Hadi

created 2017-06-26 13:35 UTC

beforeSendToClient() C

↳ Parent: calendar_owner_etemplate_widget

Complexity

Conditions	11
Paths	60

Size

Total Lines	75
Code Lines	38

Duplication

Lines	4
Ratio	5.33 %

Importance

Changes

Metric	Value
cc	11
eloc	38
nc	60
nop	2
dl	4
loc	75
rs	5.4893
c	0
b	0
f	0

How to fix Long Method Complexity

<?php
/**
 * EGroupware - eTemplate serverside of owner list widget
 *
 * @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
 * @package etemplate
 * @subpackage api
 * @link http://www.egroupware.org
 * @author Nathan Gray
 * @copyright 2016 Nathan Gray
 * @version $Id$
 */

use EGroupware\Api;
use EGroupware\Api\Link;
use EGroupware\Api\Framework;
use EGroupware\Api\Etemplate;

/**
 * eTemplate tag list widget
 *
 * The naming convention is <appname>_<subtype>_etemplate_widget
 */
class calendar_owner_etemplate_widget extends Etemplate\Widget\Taglist
{

	/**
	 *  Make sure all the needed select options are there
	 *
	 * @param string $cname
	 * @param array $expand values for keys 'c', 'row', 'c_', 'row_', 'cont'
	 */
	public function beforeSendToClient($cname, array $expand=null)
	{

		Framework::includeJS('.','et2_widget_owner','calendar');
		Framework::includeCSS('calendar','calendar');

		$bo = new calendar_bo();

		$form_name = self::form_name($cname, $this->id, $expand);

		$value =& self::get_array(self::$request->content, $form_name);

		if (!is_array(self::$request->sel_options[$form_name]))
		{
			self::$request->sel_options[$form_name] = array();
		}
		$sel_options =& self::$request->sel_options[$form_name];

		// Get user accounts, formatted nicely for grouping and matching
		// the ajax call calendar_uiforms->ajax_owner() - users first
		$accounts = array();
		$list = array('accounts', 'owngroups');
		foreach($list as $type)
		{
			$account_options = array('account_type' => $type);
			$accounts_type = Api\Accounts::link_query('',$account_options);
			if($type == 'accounts')
			{
				$accounts_type = array_intersect_key($accounts_type, $GLOBALS['egw']->acl->get_grants('calendar'));
			}
			$accounts += $accounts_type;
		}
		$sel_options += array_map(
			function($account_id, $account_name) {
				return array(
					'value' => ''.$account_id,
					'label' => $account_name,
					'app' => lang('api-accounts')
				);
			},
			array_keys($accounts), $accounts
		);

		if(!is_array($value))
		{
			// set value with an empty string only if sel options are not
			// loaded, for example: setting calendar owner via URL when
			// calendar app is not yet loaded.
			$value = !empty($sel_options) ? array(): explode(',', $value);
		}
		
		// Add external owners that a select account widget will not find
		foreach($value as &$owner)
		{
			$label = self::get_owner_label($owner);
			$info = array();
			if(!is_numeric($owner))
			{
				$resource = $bo->resources[substr($owner, 0,1)];
				if($resource['info'] && !($info = $bo->resource_info($owner)))
				{
					continue;	// ignore that resource, we would get a PHP Fatal: Unsupported operand types
				}
			}
			else if (!in_array($owner, array_keys($accounts)))
			{
				$resource = array('app'=> 'api-accounts');
			}
			else
			{
				continue;
			}
			$sel_options[] = array('value' => $owner, 'label' => $label, 'app' => lang($resource['app'])) + $info;
		}
	}

	/**
	 * Validate input
	 *
	 * @param string $cname current namespace
	 * @param array $expand values for keys 'c', 'row', 'c_', 'row_', 'cont'
	 * @param array $content
	 * @param array &$validated=array() validated content
	 */
	public function validate($cname, array $expand, array $content, &$validated=array())
	{
		$form_name = self::form_name($cname, $this->id, $expand);

		if (!$this->is_readonly($cname, $form_name))
		{
			$value = $value_in =& self::get_array($content, $form_name);
			if(!is_array($value))
			{
				$value = Array($value);
			}

			$valid =& self::get_array($validated, $form_name, true);
			if (true) $valid = $value;
		}
	}
	/**
	 * Handle ajax searches for owner across all supported resources
	 *
	 * @return Array List of matching results
	 */
	public static function ajax_owner($id = null)
	{
		// Handle a request for a single ID
		if($id)
		{
			$label = self::get_owner_label($id);
			Api\Json\Response::get()->data($label);
			return $label;
		}

		$bo = new calendar_bo();
		$query = $_REQUEST['query'];

		// Arbitrarily limited to 50 / resource
		$options = array('start' => 0, 'num_rows' => 50,
			// Filter accounts out of addressbook
			'filter' => array('account_id' => null)) +
			array_diff_key($_REQUEST, array_flip(array('menuaction','query')));
		$results = array();

		// Contacts matching accounts the user does not have permission for cause
		// confusion as user selects the contact and there's nothing there, so
		// we remove those contacts
		$remove_contacts = array();

		$resources = array_merge(array('' => $bo->resources['']),$bo->resources);
		foreach($resources as $type => $data)
		{
			$mapped = array();
			$_results = array();

			// Handle Api\Accounts seperately
			if($type == '')
			{
				$account_options = $options + array('account_type' => 'both');
				$_results += $remove_contacts = Api\Accounts::link_query($query, $account_options);
				if (!empty($_REQUEST['checkgrants']))
				{
					$grants = $GLOBALS['egw']->acl->get_grants('calendar');
					$_results = array_intersect_key($_results, $grants);
				}
			}
			// App provides a custom search function
			else if ($data['app'] && $data['search'])
			{
				$_results = call_user_func_array($data['search'], array($query, $options));
			}
			// Use standard link registry
			else if ($data['app'] && Link::get_registry($data['app'], 'query'))
			{
				$_results = Link::query($data['app'], $query,$options);
			}

			// There are always special cases
			switch ($type)
			{
				case 'l':
					// Include mailing lists
					$contacts_obj = new Api\Contacts();
					$lists = array_filter(
						$contacts_obj->get_lists(Api\Acl::READ),
						function($element) use($query) {
							return (stripos($element, $query) !== false);
						}
					);
					foreach($lists as $list_id => $list)
					{
						$_results[$list_id] = array(
							'label' => $list,
							'resources' => $bo->enum_mailing_list($type.$list_id)
						);
					}
					break;
			}
			if(!$_results)
			{
				continue;
			}

			foreach(array_unique($_results, SORT_REGULAR) as $id => $title)
			{
				if($id && $title)
				{
					// Magicsuggest uses id, not value.
					$value = array(
						'id' => $type.$id,
						'value'=> $type.$id,
						'label' => $title,
						'app'	=> lang($data['app'])
					);
					if(is_array($value['label']))
					{
						$value = array_merge($value, $value['label']);
					}
					$mapped[] = $value;
				}
			}
			if(count($mapped))
			{
				$results = array_merge($results, $mapped);
			}
		}

		// switch regular JSON response handling off
		Api\Json\Request::isJSONRequest(false);

		header('Content-Type: application/json; charset=utf-8');
		echo json_encode($results);
		exit();
	}

	/**
	 * Get just the label for a single owner
	 * @param string $id
	 */
	public static function get_owner_label($id)
	{
		static $bo;
		if(!$bo) $bo = new calendar_bo();

		$id = ''.$id;
		if(!is_numeric($id))
		{
			$resource = $bo->resources[substr($id, 0,1)];
			$label = Link::title($resource['app'], substr($id,1));

			// Could not get via link, try via resources info
			if($label === false)
			{
				$info = ExecMethod($resource['info'], substr($id,1));

				$label = $info[0]['name'];
			}
		}
		else
		{
			$label = Link::title('api-accounts',$id);
		}
		return $label;
	}
}


1		<?php
2		/**
3		* EGroupware - eTemplate serverside of owner list widget
4		*
5		* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
6		* @package etemplate
7		* @subpackage api
8		* @link http://www.egroupware.org
9		* @author Nathan Gray
10		* @copyright 2016 Nathan Gray
11		* @version $Id$
12		*/
13
14		use EGroupware\Api;
15		use EGroupware\Api\Link;
16		use EGroupware\Api\Framework;
17		use EGroupware\Api\Etemplate;
18
19		/**
20		* eTemplate tag list widget
21		*
22		* The naming convention is <appname>_<subtype>_etemplate_widget
23		*/
24		class calendar_owner_etemplate_widget extends Etemplate\Widget\Taglist
25		{
26
27		/**
28		* Make sure all the needed select options are there
29		*
30		* @param string $cname
31		* @param array $expand values for keys 'c', 'row', 'c_', 'row_', 'cont'
32		*/
33		public function beforeSendToClient($cname, array $expand=null)
34		{
35
36		Framework::includeJS('.','et2_widget_owner','calendar');
37		Framework::includeCSS('calendar','calendar');
38
39		$bo = new calendar_bo();
40
41		$form_name = self::form_name($cname, $this->id, $expand);
42
43		$value =& self::get_array(self::$request->content, $form_name);
44
45	View Code Duplication	if (!is_array(self::$request->sel_options[$form_name]))
46		{
47		self::$request->sel_options[$form_name] = array();
48		}
49		$sel_options =& self::$request->sel_options[$form_name];
50
51		// Get user accounts, formatted nicely for grouping and matching
52		// the ajax call calendar_uiforms->ajax_owner() - users first
53		$accounts = array();
54		$list = array('accounts', 'owngroups');
55		foreach($list as $type)
56		{
57		$account_options = array('account_type' => $type);
58		$accounts_type = Api\Accounts::link_query('',$account_options);
59		if($type == 'accounts')
60		{
61		$accounts_type = array_intersect_key($accounts_type, $GLOBALS['egw']->acl->get_grants('calendar'));
62		}
63		$accounts += $accounts_type;
64		}
65		$sel_options += array_map(
66		function($account_id, $account_name) {
67		return array(
68		'value' => ''.$account_id,
69		'label' => $account_name,
70		'app' => lang('api-accounts')
71		);
72		},
73		array_keys($accounts), $accounts
74		);
75
76		if(!is_array($value))
77		{
78		// set value with an empty string only if sel options are not
79		// loaded, for example: setting calendar owner via URL when
80		// calendar app is not yet loaded.
81		$value = !empty($sel_options) ? array(): explode(',', $value);
82		}
83
84		// Add external owners that a select account widget will not find
85		foreach($value as &$owner)
86		{
87		$label = self::get_owner_label($owner);
88		$info = array();
89		if(!is_numeric($owner))
90		{
91		$resource = $bo->resources[substr($owner, 0,1)];
92		if($resource['info'] && !($info = $bo->resource_info($owner)))
93		{
94		continue; // ignore that resource, we would get a PHP Fatal: Unsupported operand types
95		}
96		}
97		else if (!in_array($owner, array_keys($accounts)))
98		{
99		$resource = array('app'=> 'api-accounts');
100		}
101		else
102		{
103		continue;
104		}
105		$sel_options[] = array('value' => $owner, 'label' => $label, 'app' => lang($resource['app'])) + $info;
106		}
107		}
108
109		/**
110		* Validate input
111		*
112		* @param string $cname current namespace
113		* @param array $expand values for keys 'c', 'row', 'c_', 'row_', 'cont'
114		* @param array $content
115		* @param array &$validated=array() validated content
116		*/
117		public function validate($cname, array $expand, array $content, &$validated=array())
118		{
119		$form_name = self::form_name($cname, $this->id, $expand);
120
121		if (!$this->is_readonly($cname, $form_name))
122		{
123		$value = $value_in =& self::get_array($content, $form_name);
124		if(!is_array($value))
125		{
126		$value = Array($value);
127		}
128
129		$valid =& self::get_array($validated, $form_name, true);
130		if (true) $valid = $value;
131		}
132		}
133		/**
134		* Handle ajax searches for owner across all supported resources
135		*
136		* @return Array List of matching results
137		*/
138		public static function ajax_owner($id = null)
139		{
140		// Handle a request for a single ID
141		if($id)
142		{
143		$label = self::get_owner_label($id);
144		Api\Json\Response::get()->data($label);
145		return $label;
146		}
147
148		$bo = new calendar_bo();
149		$query = $_REQUEST['query'];
150
151		// Arbitrarily limited to 50 / resource
152		$options = array('start' => 0, 'num_rows' => 50,
153		// Filter accounts out of addressbook
154		'filter' => array('account_id' => null)) +
155		array_diff_key($_REQUEST, array_flip(array('menuaction','query')));
156		$results = array();
157
158		// Contacts matching accounts the user does not have permission for cause
159		// confusion as user selects the contact and there's nothing there, so
160		// we remove those contacts
161		$remove_contacts = array();
162
163		$resources = array_merge(array('' => $bo->resources['']),$bo->resources);
164		foreach($resources as $type => $data)
165		{
166		$mapped = array();
167		$_results = array();
168
169		// Handle Api\Accounts seperately
170		if($type == '')
171		{
172		$account_options = $options + array('account_type' => 'both');
173		$_results += $remove_contacts = Api\Accounts::link_query($query, $account_options);
174		if (!empty($_REQUEST['checkgrants']))
175		{
176		$grants = $GLOBALS['egw']->acl->get_grants('calendar');
177		$_results = array_intersect_key($_results, $grants);
178		}
179		}
180		// App provides a custom search function
181		else if ($data['app'] && $data['search'])
182		{
183		$_results = call_user_func_array($data['search'], array($query, $options));
184		}
185		// Use standard link registry
186		else if ($data['app'] && Link::get_registry($data['app'], 'query'))
187		{
188		$_results = Link::query($data['app'], $query,$options);
189		}
190
191		// There are always special cases
192		switch ($type)
193		{
194		case 'l':
195		// Include mailing lists
196		$contacts_obj = new Api\Contacts();
197		$lists = array_filter(
198		$contacts_obj->get_lists(Api\Acl::READ),
199		function($element) use($query) {
200		return (stripos($element, $query) !== false);
201		}
202		);
203		foreach($lists as $list_id => $list)
204		{
205		$_results[$list_id] = array(
206		'label' => $list,
207		'resources' => $bo->enum_mailing_list($type.$list_id)
208		);
209		}
210		break;
211		}
212		if(!$_results)
213		{
214		continue;
215		}
216
217		foreach(array_unique($_results, SORT_REGULAR) as $id => $title)
218		{
219		if($id && $title)
220		{
221		// Magicsuggest uses id, not value.
222		$value = array(
223		'id' => $type.$id,
224		'value'=> $type.$id,
225		'label' => $title,
226		'app' => lang($data['app'])
227		);
228		if(is_array($value['label']))
229		{
230		$value = array_merge($value, $value['label']);
231		}
232		$mapped[] = $value;
233		}
234		}
235		if(count($mapped))
236		{
237		$results = array_merge($results, $mapped);
238		}
239		}
240
241		// switch regular JSON response handling off
242		Api\Json\Request::isJSONRequest(false);
243
244		header('Content-Type: application/json; charset=utf-8');
245		echo json_encode($results);
246		exit();
247		}
248
249		/**
250		* Get just the label for a single owner
251		* @param string $id
252		*/
253		public static function get_owner_label($id)
254		{
255		static $bo;
256		if(!$bo) $bo = new calendar_bo();
257
258		$id = ''.$id;
259		if(!is_numeric($id))
260		{
261		$resource = $bo->resources[substr($id, 0,1)];
262		$label = Link::title($resource['app'], substr($id,1));
263
264		// Could not get via link, try via resources info
265		if($label === false)
266		{
267		$info = ExecMethod($resource['info'], substr($id,1));
		0 ignored issues – show Deprecated Code introduced 2016-05-29 12:40 UTC by Report Bug Copy Issue Report The function `ExecMethod()` has been deprecated with message: use autoloadable class-names, instanciate and call method or use static methods This function has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the function will be removed from the class and what other function to use instead. Loading history...
268		$label = $info[0]['name'];
269		}
270		}
271		else
272		{
273		$label = Link::title('api-accounts',$id);
274		}
275		return $label;
276		}
277		}
278

EGroupware / egroupware

Push — 16.1 ( c4b782...6c2a65 )

beforeSendToClient() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like