Passed
Branch master (74fd33)
by James
04:45
created

WebServer::getActiveConfig()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 12
Code Lines 5

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 5
CRAP Score 1

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 12
ccs 5
cts 5
cp 1
rs 9.4285
cc 1
eloc 5
nc 1
nop 1
crap 1
1
<?php
2
3
/**
4
 * This file is, guess what, part of WebHelper.
5
 *
6
 * (c) James <[email protected]>
7
 *
8
 * For the full copyright and license information, please view the LICENSE
9
 * file that was distributed with this source code.
10
 */
11
12
namespace JamesRezo\WebHelper\WebServer;
13
14
use Symfony\Component\Process\Process;
15
16
/**
17
 * Base class for webserver classes.
18
 *
19
 * name can be either apache, nginx, lighttpd, php or other webserver name
20
 *
21
 * @author james <[email protected]>
22
 */
23
abstract class WebServer implements WebServerInterface
24
{
25
    /**
26
     * the name of a webserver.
27
     *
28
     * @var string the name of a webserver
29
     */
30
    private $name;
31
32
    /**
33
     * the version of a webserver.
34
     *
35
     * @var string the version of a webserver
36
     */
37
    private $version;
38
39
    /**
40
     * binaries that can be used to control the webserver.
41
     *
42
     * @var array
43
     */
44
    private $binaries = [];
45
46
    /**
47
     * the parameter string to use to detect version and config file.
48
     *
49
     * @var string
50
     */
51
    private $detectionParameter = '';
52
53
    /**
54
     * Constructor.
55
     *
56
     * @param string $name    the name of a webserver
57
     * @param string $version the version of a webserver
58
     */
59 29
    public function __construct($name, $version = '')
60
    {
61 29
        $this->name = $name;
62 29
        $this->version = $version;
63 29
    }
64
65
    /**
66
     * Gets the name of a webserver.
67
     *
68
     * @return string the name of the webserver
69
     */
70 4
    public function getName()
71
    {
72 4
        return $this->name;
73
    }
74
75
    /**
76
     * Gets the version of a webserver.
77
     *
78
     * @return string the version of the webserver
79
     */
80 4
    public function getVersion()
81
    {
82 4
        return $this->version;
83
    }
84
85
    /**
86
     * Gets the list of binaries that can be run to analyze.
87
     *
88
     * @return array the list of binaries that can be run
89
     */
90 5
    public function getBinaries()
91
    {
92 5
        return $this->binaries;
93
    }
94
95 18
    public function setBinaries(array $binaries)
96
    {
97 18
        $this->binaries = $binaries;
98
99 18
        return $this;
100
    }
101
102 18
    public function setDetectionParameter($parameter = '')
103
    {
104 18
        $this->detectionParameter = $parameter;
105
106 18
        return $this;
107
    }
108
109 1
    public function getSettings($fullPathBinary)
110
    {
111 1
        $process = new Process($fullPathBinary.$this->detectionParameter);
112 1
        $process->run();
113 1
        return $process->getOutput();
114
    }
115
116
    abstract public function extractVersion($settings = '');
117
118
    abstract public function extractRootConfigurationFile($settings = '');
119
120
    /**
121
     * Finds and return a specific information in a string.
122
     *
123
     * the regexp must contain delimiters.
124
     * 
125
     * @param  string $regexp   a regular expression to find
126
     * @param  string $settings a string where to find
127
     * @return string           the found value or an empty string
128
     */
129 9
    protected function match($regexp, $settings)
130
    {
131 9
        $matches = [];
132
133 9
        if (preg_match($regexp, $settings, $matches)) {
134 5
            return $matches[1];
135
        }
136
137 4
        return '';
138
    }
139
140
    /**
141
     * Loads et cleans a config file.
142
     *
143
     * @param  string $file a Configuration file
144
     * @return string       the cleaned directives a the config file
145
     */
146 2
    public function getActiveConfig($file = '')
147
    {
148 2
        $activeConfig = file_get_contents($file);
149
150
        #Comon to both apache and nginx
151
        #delete commented lines
152 2
        $activeConfig = preg_replace('/^\s*#(.+)?/m', '', $activeConfig);
153
        #delete blank lines
154 2
        $activeConfig = preg_replace('/^\h*\v+/m', '', $activeConfig);
155
156 2
        return $activeConfig;
157
    }
158
}
159