Completed
Push — master ( 7d9761...77615c )
by Tony
02:53
created

RRDXport::csvSerialize()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 16
Code Lines 11

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 2
eloc 11
nc 2
nop 0
dl 0
loc 16
rs 9.4285
c 0
b 0
f 0
1
<?php
2
/**
3
 * RRDXport.php
4
 *
5
 * -Description-
6
 *
7
 * This program is free software: you can redistribute it and/or modify
8
 * it under the terms of the GNU General Public License as published by
9
 * the Free Software Foundation, either version 3 of the License, or
10
 * (at your option) any later version.
11
 *
12
 * This program is distributed in the hope that it will be useful,
13
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
15
 * GNU General Public License for more details.
16
 *
17
 * You should have received a copy of the GNU General Public License
18
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
19
 *
20
 * @package    LibreNMS
21
 * @link       http://librenms.org
22
 * @copyright  2016 Tony Murray
23
 * @author     Tony Murray <[email protected]>
24
 */
25
26
namespace App\Data;
27
28
use Carbon\Carbon;
29
30
class RRDXport extends RRD implements \JsonSerializable
31
{
32
    protected $supported_formats = ['json', 'csv'];
33
    private $output;
34
    private $headers;
35
36
    /**
37
     * RRDXport constructor.
38
     *
39
     * @param string $definition rrdtool definition
40
     * @param array $headers headers for rrdtool
41
     * @param string $start start time
42
     * @param string $end end time
43
     */
44
    public function __construct($definition, $headers, $start, $end)
45
    {
46
        $args = " xport --json -s $start -e $end $definition";
47
        parent::__construct($args);
48
49
        $this->headers = $headers;
50
    }
51
52
    /**
53
     * Return the output from this data source
54
     * May be base64 encoded PNG, Json Data, or CSV Data
55
     *
56
     * @param string $format png, json, or csv
57
     * @return string
58
     */
59
    public function fetch($format)
60
    {
61
        $this->checkFormatSupported($format);
62
63
        if ($format == 'json') {
64
            return $this->jsonSerialize();
65
        } elseif ($format == 'csv') {
66
            return $this->csvSerialize();
67
        }
68
        return null;  // shouldn't get here
69
    }
70
71
    /**
72
     * Get and cache the output of rrdtool as a json object
73
     *
74
     * @return mixed
75
     */
76
    private function getOutput()
77
    {
78
        if (!isset($this->output)) {
79
            $output = $this->run();
80
            $output = preg_replace('/\'/', '"', $output);
81
            $output = preg_replace('/about\:/', '"meta":', $output);
82
            $output = preg_replace('/meta\:/', '"meta":', $output);
83
            $this->output = json_decode($output);
84
        }
85
86
        return $this->output;
87
    }
88
89
    public function jsonSerialize()
90
    {
91
        $response = $this->getOutput();
92
        $step = $response->meta->step;
93
        $start = $response->meta->start;
94
//        $end = $response->meta->end;
0 ignored issues
show
Unused Code Comprehensibility introduced by
46% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
95
        $cur_time = $start;
96
        $tmp_data = [];
97
98
        foreach ($response->data as $data) {
99
            $tmp_data[] = [$cur_time] + array_map('intval', $data);
100
            $cur_time += $step;
101
        }
102
103
        return json_encode([
104
            'data'   => $tmp_data,
105
            'labels' => $this->headers,
106
        ]);
107
    }
108
109
    public function csvSerialize()
110
    {
111
        $response = $this->getOutput();
112
        $step = $response->meta->step;
113
        $start = $response->meta->start;
114
//        $end = $response->meta->end;
0 ignored issues
show
Unused Code Comprehensibility introduced by
46% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
115
        $cur_time = $start;
116
        $output = 'Date, '.implode(',', $this->headers).PHP_EOL;
117
118
        foreach ($response->data as $data) {
119
            $output .= Carbon::createFromTimestamp($cur_time).',';
120
            $output .= implode(',', array_map('intval', $data)).PHP_EOL;
121
            $cur_time += $step;
122
        }
123
        return $output;
124
    }
125
}
126