Total Complexity | 46 |
Total Lines | 390 |
Duplicated Lines | 0 % |
Changes | 4 | ||
Bugs | 0 | Features | 0 |
Complex classes like StatusController 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 StatusController, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
15 | class StatusController extends TrapsController |
||
16 | { |
||
17 | public function indexAction() |
||
18 | { |
||
19 | $this->prepareTabs()->activate('status'); |
||
20 | |||
21 | /************ Trapdb ***********/ |
||
22 | try |
||
23 | { |
||
24 | $dbConn = $this->getUIDatabase()->getDbConn(); |
||
25 | if ($dbConn === null) throw new \ErrorException('uncatched db error'); |
||
26 | $query = $dbConn->select()->from( |
||
27 | $this->getModuleConfig()->getTrapTableName(), |
||
28 | array('COUNT(*)') |
||
29 | ); |
||
30 | $this->view->trap_count=$dbConn->fetchOne($query); |
||
31 | $query = $dbConn->select()->from( |
||
32 | $this->getModuleConfig()->getTrapDataTableName(), |
||
33 | array('COUNT(*)') |
||
34 | ); |
||
35 | $this->view->trap_object_count=$dbConn->fetchOne($query); |
||
36 | $query = $dbConn->select()->from( |
||
37 | $this->getModuleConfig()->getTrapRuleName(), |
||
38 | array('COUNT(*)') |
||
39 | ); |
||
40 | $this->view->rule_count=$dbConn->fetchOne($query); |
||
41 | |||
42 | $this->view->trap_days_delete=$this->getUIDatabase()->getDBConfigValue('db_remove_days'); |
||
43 | |||
44 | } |
||
45 | catch (Exception $e) |
||
46 | { |
||
47 | $this->displayExitError('status',$e->getMessage()); |
||
48 | } |
||
49 | |||
50 | /*************** Log destination *******************/ |
||
51 | |||
52 | try |
||
53 | { |
||
54 | $this->view->currentLogDestination=$this->getUIDatabase()->getDBConfigValue('log_destination'); |
||
55 | $this->view->logDestinations=$this->getModuleConfig()->getLogDestinations(); |
||
56 | $this->view->currentLogFile=$this->getUIDatabase()->getDBConfigValue('log_file'); |
||
57 | $this->view->logLevels=$this->getModuleConfig()->getlogLevels(); |
||
58 | $this->view->currentLogLevel=$this->getUIDatabase()->getDBConfigValue('log_level'); |
||
59 | } |
||
60 | catch (Exception $e) |
||
61 | { |
||
62 | $this->displayExitError('status',$e->getMessage()); |
||
63 | } |
||
64 | |||
65 | /*************** SNMP configuration ****************/ |
||
66 | try |
||
67 | { |
||
68 | $this->view->useSnmpTrapAddess= ( $this->getUIDatabase()->getDBConfigValue('use_SnmpTrapAddess') == 1 ) ? TRUE : FALSE; |
||
69 | $this->view->SnmpTrapAddressOID=$this->getUIDatabase()->getDBConfigValue('SnmpTrapAddess_oid'); |
||
70 | $this->view->SnmpTrapAddressOIDDefault = ($this->view->SnmpTrapAddressOID == $this->getModuleConfig()->getDBConfigDefaults()['SnmpTrapAddess_oid'] ) ? TRUE : FALSE; |
||
71 | |||
72 | } |
||
73 | catch (Exception $e) |
||
74 | { |
||
75 | $this->displayExitError('status',$e->getMessage()); |
||
76 | } |
||
77 | |||
78 | } |
||
79 | |||
80 | /** Mib management |
||
81 | * Post param : action=update_mib_db : update mib database |
||
82 | * Post param : ation=check_update : check if mib update is finished |
||
83 | * File post : mibfile -> save mib file |
||
84 | */ |
||
85 | public function mibAction() |
||
231 | //$this->view->form= new Form('upload-form'); |
||
232 | |||
233 | |||
234 | } |
||
235 | |||
236 | /** UI options */ |
||
237 | public function uimgtAction() |
||
238 | { |
||
239 | $this->prepareTabs()->activate('uimgt'); |
||
240 | |||
241 | $this->view->setError=''; |
||
242 | $this->view->setOKMsg=''; |
||
243 | |||
244 | //max_rows=25&row_update=update |
||
245 | if ( $this->getRequest()->getParam('max_rows',NULL) !== NULL ) |
||
246 | { |
||
247 | $maxRows = $this->getRequest()->getParam('max_rows'); |
||
248 | if (!preg_match('/^[0-9]+$/', $maxRows) || $maxRows < 1) |
||
249 | { |
||
250 | $this->view->setError='Max rows must be a number'; |
||
251 | } |
||
252 | else |
||
253 | { |
||
254 | $this->setitemListDisplay($maxRows); |
||
255 | $this->view->setOKMsg='Set max rows to ' . $maxRows; |
||
256 | } |
||
257 | } |
||
258 | |||
259 | if ( $this->getRequest()->getParam('add_category',NULL) !== NULL ) |
||
260 | { |
||
261 | $addCat = $this->getRequest()->getParam('add_category'); |
||
262 | $this->addHandlersCategory($addCat); |
||
263 | } |
||
264 | |||
265 | if ( $this->getRequest()->getPost('type',NULL) !== NULL ) |
||
266 | { |
||
267 | $type = $this->getRequest()->getPost('type',NULL); |
||
268 | $index = $this->getRequest()->getPost('index',NULL); |
||
269 | $newname = $this->getRequest()->getPost('newname',NULL); |
||
270 | |||
271 | if (!preg_match('/^[0-9]+$/', $index) || $index < 1) |
||
272 | $this->_helper->json(array('status'=>'Bad index')); |
||
273 | |||
274 | switch ($type) |
||
275 | { |
||
276 | case 'delete': |
||
277 | $this->delHandlersCategory($index); |
||
278 | $this->_helper->json(array('status'=>'OK')); |
||
279 | return; |
||
280 | break; |
||
|
|||
281 | case 'rename': |
||
282 | $this->renameHandlersCategory($index, $newname); |
||
283 | $this->_helper->json(array('status'=>'OK')); |
||
284 | return; |
||
285 | break; |
||
286 | default: |
||
287 | $this->_helper->json(array('status'=>'Unknwon command')); |
||
288 | return; |
||
289 | break; |
||
290 | } |
||
291 | } |
||
292 | |||
293 | $this->view->maxRows = $this->itemListDisplay(); |
||
294 | |||
295 | $this->view->categories = $this->getHandlersCategory(); |
||
296 | |||
297 | |||
298 | |||
299 | } |
||
300 | |||
301 | /** Create services and templates |
||
302 | * Create template for trap service |
||
303 | * |
||
304 | */ |
||
305 | public function servicesAction() |
||
306 | { |
||
307 | $this->prepareTabs()->activate('services'); |
||
308 | |||
309 | /*if (!$this->isDirectorInstalled()) |
||
310 | { |
||
311 | $this->displayExitError("Status -> Services","Director is not installed, template & services install are not available"); |
||
312 | } |
||
313 | */ |
||
314 | // Check if data was sent : |
||
315 | $postData=$this->getRequest()->getPost(); |
||
316 | $this->view->templateForm_output=''; |
||
317 | if (isset($postData['template_name']) && isset($postData['template_revert_time'])) |
||
318 | { |
||
319 | $template_create = 'icingacli director service create --json \'{ "check_command": "dummy", '; |
||
320 | $template_create .= '"check_interval": "' .$postData['template_revert_time']. '", "check_timeout": "20", "disabled": false, "enable_active_checks": true, "enable_event_handler": true, "enable_notifications": true, "enable_passive_checks": true, "enable_perfdata": true, "max_check_attempts": "1", '; |
||
321 | $template_create .= '"object_name": "'.$postData['template_name'].'", "object_type": "template", "retry_interval": "'.$postData['template_revert_time'].'"}\''; |
||
322 | $output=array(); |
||
323 | $ret_code=0; |
||
324 | exec($template_create,$output,$ret_code); |
||
325 | if ($ret_code != 0) |
||
326 | { |
||
327 | $this->displayExitError("Status -> Services","Error creating template : ".$output[0].'<br>Command was : '.$template_create); |
||
328 | } |
||
329 | exec('icingacli director config deploy',$output,$ret_code); |
||
330 | $this->view->templateForm_output='Template '.$postData['template_name']. ' created'; |
||
331 | } |
||
332 | |||
333 | // template creation form |
||
334 | $this->view->templateForm_URL=Url::fromRequest()->__toString(); |
||
335 | $this->view->templateForm_name="trapdirector_main_template"; |
||
336 | $this->view->templateForm_interval="3600"; |
||
337 | } |
||
338 | |||
339 | /** |
||
340 | * Plugins display and activation |
||
341 | */ |
||
342 | public function pluginsAction() |
||
343 | { |
||
344 | $this->prepareTabs()->activate('plugins'); |
||
345 | |||
346 | require_once($this->Module()->getBaseDir() .'/bin/trap_class.php'); |
||
347 | $icingaweb2_etc=$this->Config()->get('config', 'icingaweb2_etc'); |
||
348 | $Trap = new Trap($icingaweb2_etc,4); |
||
349 | |||
350 | $this->view->pluginLoaded = htmlentities($Trap->pluginClass->registerAllPlugins(false)); |
||
351 | |||
352 | $enabledPlugins = $Trap->pluginClass->getEnabledPlugins(); |
||
353 | |||
354 | $pluginList = $Trap->pluginClass->pluginList(); |
||
355 | |||
356 | // Plugin list and fill function name list |
||
357 | $functionList=array(); |
||
358 | $this->view->pluginArray=array(); |
||
359 | foreach ($pluginList as $plugin) |
||
360 | { |
||
361 | $pluginDetails=$Trap->pluginClass->pluginDetails($plugin); |
||
362 | $pluginDetails->enabled = (in_array($plugin, $enabledPlugins)) ? true : false; |
||
363 | $pluginDetails->catchAllTraps = ($pluginDetails->catchAllTraps === true )? 'Yes' : 'No'; |
||
364 | $pluginDetails->processTraps = ($pluginDetails->processTraps === true )? 'Yes' : 'No'; |
||
365 | $pluginDetails->description = htmlentities($pluginDetails->description); |
||
366 | $pluginDetails->description = preg_replace('/\n/','<br>',$pluginDetails->description); |
||
367 | array_push($this->view->pluginArray, $pluginDetails); |
||
368 | // Get functions for function details |
||
369 | foreach ($pluginDetails->funcArray as $function) |
||
370 | { |
||
371 | array_push($functionList,$function); |
||
372 | } |
||
373 | } |
||
374 | |||
375 | // Function list with details |
||
376 | $this->view->functionList=array(); |
||
377 | foreach ($functionList as $function) |
||
378 | { |
||
379 | $functionDetail = $Trap->pluginClass->getFunctionDetails($function); |
||
380 | $functionDetail->params = htmlentities($functionDetail->params); |
||
381 | $functionDetail->description = htmlentities($functionDetail->description); |
||
382 | $functionDetail->description = preg_replace('/\n/','<br>',$functionDetail->description); |
||
383 | array_push($this->view->functionList, $functionDetail); |
||
384 | } |
||
385 | |||
386 | } |
||
387 | |||
388 | protected function prepareTabs() |
||
405 | ); |
||
406 | } |
||
407 | } |
||
408 | |||
429 |
The
break
statement is not necessary if it is preceded for example by areturn
statement:If you would like to keep this construct to be consistent with other
case
statements, you can safely mark this issue as a false-positive.