PSStatus   B
last analyzed

Complexity

Total Complexity 36

Size/Duplication

Total Lines 148
Duplicated Lines 14.86 %

Coupling/Cohesion

Components 1
Dependencies 3

Importance

Changes 0
Metric Value
dl 22
loc 148
rs 8.8
c 0
b 0
f 0
wmc 36
lcom 1
cbo 3

4 Methods

Rating   Name   Duplication   Size   Complexity  
C __construct() 17 55 17
C execute() 5 30 11
A xml() 0 10 3
B _recursiveinarray() 0 10 5

How to fix   Duplicated Code   

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

1
<?php
2
/**
3
 * PSStatus Plugin
4
 *
5
 * PHP version 5
6
 *
7
 * @category  PHP
8
 * @package   PSI_Plugin_PSStatus
9
 * @author    Michael Cramer <[email protected]>
10
 * @copyright 2009 phpSysInfo
11
 * @license   http://opensource.org/licenses/gpl-2.0.php GNU General Public License
12
 * @version   SVN: $Id: class.psstatus.inc.php 692 2012-09-08 17:12:08Z namiltd $
13
 * @link      http://phpsysinfo.sourceforge.net
14
 */
15
 /**
16
 * process Plugin, which displays the status of configured processes
17
 * a simple view which shows a process name and the status
18
 * status determined by calling the "pidof" command line utility, another way is to provide
19
 * a file with the output of the pidof utility, so there is no need to run a executeable by the
20
 * webserver, the format of the command is written down in the phpsysinfo.ini file, where also
21
 * the method of getting the information is configured
22
 * processes that should be checked are also defined in phpsysinfo.ini
23
 *
24
 * @category  PHP
25
 * @package   PSI_Plugin_PSStatus
26
 * @author    Michael Cramer <[email protected]>
27
 * @copyright 2009 phpSysInfo
28
 * @license   http://opensource.org/licenses/gpl-2.0.php GNU General Public License
29
 * @version   Release: 3.0
30
 * @link      http://phpsysinfo.sourceforge.net
31
 */
32
class PSStatus extends PSI_Plugin
0 ignored issues
show
Coding Style Compatibility introduced by
PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

You can fix this by adding a namespace to your class:

namespace YourVendor;

class YourClass { }

When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries.

Loading history...
33
{
34
    /**
35
     * variable, which holds the content of the command
36
     * @var array
37
     */
38
    private $_filecontent = array();
39
40
    /**
41
     * variable, which holds the result before the xml is generated out of this array
42
     * @var array
43
     */
44
    private $_result = array();
45
46
    /**
47
     * read the data into an internal array and also call the parent constructor
48
     *
49
     * @param String $enc target encoding
50
     */
51
    public function __construct($enc)
52
    {
53
        parent::__construct(__CLASS__, $enc);
54
        switch (strtolower(PSI_PLUGIN_PSSTATUS_ACCESS)) {
55
        case 'command':
56
            if (PSI_OS == 'WINNT') {
57
                try {
58
                    $objLocator = new COM("WbemScripting.SWbemLocator");
0 ignored issues
show
Unused Code introduced by
The call to com::__construct() has too many arguments starting with 'WbemScripting.SWbemLocator'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
59
                    $wmi = $objLocator->ConnectServer();
60
                    $process_wmi = $wmi->InstancesOf('Win32_Process');
61
                    foreach ($process_wmi as $process) {
62
                        $this->_filecontent[] = array(strtolower(trim($process->Caption)), trim($process->ProcessId));
63
                    }
64
                } catch (Exception $e) {
0 ignored issues
show
Coding Style Comprehensibility introduced by
Consider adding a comment why this CATCH block is empty.
Loading history...
65
                }
66
            } else {
67
                if (defined('PSI_PLUGIN_PSSTATUS_PROCESSES') && is_string(PSI_PLUGIN_PSSTATUS_PROCESSES)) {
68 View Code Duplication
                    if (preg_match(ARRAY_EXP, PSI_PLUGIN_PSSTATUS_PROCESSES)) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
69
                        $processes = eval(PSI_PLUGIN_PSSTATUS_PROCESSES);
0 ignored issues
show
Coding Style introduced by
It is generally not recommended to use eval unless absolutely required.

On one hand, eval might be exploited by malicious users if they somehow manage to inject dynamic content. On the other hand, with the emergence of faster PHP runtimes like the HHVM, eval prevents some optimization that they perform.

Loading history...
70
                    } else {
71
                        $processes = array(PSI_PLUGIN_PSSTATUS_PROCESSES);
72
                    }
73
                    if (defined('PSI_PLUGIN_PSSTATUS_USE_REGEX') && PSI_PLUGIN_PSSTATUS_USE_REGEX === true) {
74 View Code Duplication
                        foreach ($processes as $process) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
75
                            CommonFunctions::executeProgram("pgrep", "-n -x ".$process, $buffer, PSI_DEBUG);
76
                            if (strlen($buffer) > 0) {
77
                                $this->_filecontent[] = array($process, $buffer);
78
                            }
79
                        }
80
                    } else {
81 View Code Duplication
                        foreach ($processes as $process) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
82
                            CommonFunctions::executeProgram("pidof", "-s ".$process, $buffer, PSI_DEBUG);
83
                            if (strlen($buffer) > 0) {
84
                                $this->_filecontent[] = array($process, $buffer);
85
                            }
86
                        }
87
                    }
88
                }
89
            }
90
            break;
91
        case 'data':
92
            CommonFunctions::rfts(APP_ROOT."/data/psstatus.txt", $buffer);
93
            $processes = preg_split("/\n/", $buffer, -1, PREG_SPLIT_NO_EMPTY);
94
            foreach ($processes as $process) {
95
                $ps = preg_split("/[\s]?\|[\s]?/", $process, -1, PREG_SPLIT_NO_EMPTY);
96
                if (count($ps) == 2) {
97
                    $this->_filecontent[] = array(trim($ps[0]), trim($ps[1]));
98
                }
99
            }
100
            break;
101
        default:
102
            $this->global_error->addError("switch(PSI_PLUGIN_PSSTATUS_ACCESS)", "Bad psstatus configuration in phpsysinfo.ini");
103
            break;
104
        }
105
    }
106
107
    /**
108
     * doing all tasks to get the required informations that the plugin needs
109
     * result is stored in an internal array<br>the array is build like a tree,
110
     * so that it is possible to get only a specific process with the childs
111
     *
112
     * @return void
113
     */
114
    public function execute()
115
    {
116
        if (empty($this->_filecontent)) {
117
            return;
118
        }
119
        if (defined('PSI_PLUGIN_PSSTATUS_PROCESSES') && is_string(PSI_PLUGIN_PSSTATUS_PROCESSES)) {
120 View Code Duplication
            if (preg_match(ARRAY_EXP, PSI_PLUGIN_PSSTATUS_PROCESSES)) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
121
                $processes = eval(PSI_PLUGIN_PSSTATUS_PROCESSES);
0 ignored issues
show
Coding Style introduced by
It is generally not recommended to use eval unless absolutely required.

On one hand, eval might be exploited by malicious users if they somehow manage to inject dynamic content. On the other hand, with the emergence of faster PHP runtimes like the HHVM, eval prevents some optimization that they perform.

Loading history...
122
            } else {
123
                $processes = array(PSI_PLUGIN_PSSTATUS_PROCESSES);
124
            }
125
            if ((PSI_OS == 'WINNT') && (strtolower(PSI_PLUGIN_PSSTATUS_ACCESS) == 'command')) {
126
                foreach ($processes as $process) {
127
                    if ($this->_recursiveinarray(strtolower($process), $this->_filecontent)) {
128
                        $this->_result[] = array($process, true);
129
                    } else {
130
                        $this->_result[] = array($process, false);
131
                    }
132
                }
133
            } else {
134
                foreach ($processes as $process) {
135
                    if ($this->_recursiveinarray($process, $this->_filecontent)) {
136
                        $this->_result[] = array($process, true);
137
                    } else {
138
                        $this->_result[] = array($process, false);
139
                    }
140
                }
141
            }
142
        }
143
    }
144
145
    /**
146
     * generates the XML content for the plugin
147
     *
148
     * @return SimpleXMLElement entire XML content for the plugin
149
     */
150
    public function xml()
151
    {
152
        foreach ($this->_result as $ps) {
153
            $xmlps = $this->xml->addChild("Process");
154
            $xmlps->addAttribute("Name", $ps[0]);
155
            $xmlps->addAttribute("Status", $ps[1] ? 1 : 0);
156
        }
157
158
        return $this->xml->getSimpleXmlElement();
0 ignored issues
show
Bug Best Practice introduced by
The return type of return $this->xml->getSimpleXmlElement(); (SimpleXMLElement) is incompatible with the return type declared by the interface PSI_Interface_Plugin::xml of type SimpleXMLObject.

If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.

Let’s take a look at an example:

class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

Our function my_function expects a Post object, and outputs the author of the post. The base class Post returns a simple string and outputting a simple string will work just fine. However, the child class BlogPost which is a sub-type of Post instead decided to return an object, and is therefore violating the SOLID principles. If a BlogPost were passed to my_function, PHP would not complain, but ultimately fail when executing the strtoupper call in its body.

Loading history...
159
    }
160
161
    /**
162
     * checks an array recursive if an value is in, extended version of in_array()
163
     *
164
     * @param mixed $needle   what to find
165
     * @param array $haystack where to find
166
     *
167
     * @return boolean true - found<br>false - not found
168
     */
169
    private function _recursiveinarray($needle, $haystack)
170
    {
171
        foreach ($haystack as $stalk) {
172
            if ($needle == $stalk || (is_array($stalk) && $this->_recursiveinarray($needle, $stalk))) {
173
                return true;
174
            }
175
        }
176
177
        return false;
178
    }
179
}
180