mirror of
https://github.com/librenms/librenms.git
synced 2024-10-07 16:52:45 +00:00
d5a52ca4eb
* Ping only device doesn't display
if os was set to something, ping os wasn't loaded and we try to get overview graphs from it.
* Fix snmp_disable device page load error
When other os is set.
* Revamp os setting loading
the only safe way to access is Config::getOsSetting()
* Remove getOsSetting fallback behavior
Most instances don't use it and it can have unexpected results Config::getOsSetting('blah', 'group') == 'librenms'
* refactor and remove unneeded load_os/loadOs calls now since getOsSetting automatically loads it.
* restore unix overview graphs, they are different
small cleanups
* fix
546 lines
17 KiB
PHP
546 lines
17 KiB
PHP
<?php
|
|
/**
|
|
* Url.php
|
|
*
|
|
* -Description-
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
* @package LibreNMS
|
|
* @link http://librenms.org
|
|
* @copyright 2018 Tony Murray
|
|
* @author Tony Murray <murraytony@gmail.com>
|
|
*/
|
|
|
|
namespace LibreNMS\Util;
|
|
|
|
use App\Models\Device;
|
|
use App\Models\Port;
|
|
use Auth;
|
|
use Carbon\Carbon;
|
|
use Carbon\CarbonImmutable;
|
|
use Illuminate\Support\Str;
|
|
use LibreNMS\Config;
|
|
use Symfony\Component\HttpFoundation\ParameterBag;
|
|
|
|
class Url
|
|
{
|
|
/**
|
|
* @param Device $device
|
|
* @param string $text
|
|
* @param array $vars
|
|
* @param int $start
|
|
* @param int $end
|
|
* @param int $escape_text
|
|
* @param int $overlib
|
|
* @return string
|
|
*/
|
|
public static function deviceLink($device, $text = null, $vars = [], $start = 0, $end = 0, $escape_text = 1, $overlib = 1)
|
|
{
|
|
if (is_null($device)) {
|
|
return '';
|
|
}
|
|
|
|
if (!$device->canAccess(Auth::user())) {
|
|
return $device->displayName();
|
|
}
|
|
|
|
if (!$start) {
|
|
$start = Carbon::now()->subDay()->timestamp;
|
|
}
|
|
|
|
if (!$end) {
|
|
$end = Carbon::now()->timestamp;
|
|
}
|
|
|
|
if (!$text) {
|
|
$text = $device->displayName();
|
|
}
|
|
|
|
if ($escape_text) {
|
|
$text = htmlentities($text);
|
|
}
|
|
|
|
$class = self::deviceLinkDisplayClass($device);
|
|
$graphs = Graph::getOverviewGraphsForDevice($device);
|
|
$url = Url::deviceUrl($device, $vars);
|
|
|
|
// beginning of overlib box contains large hostname followed by hardware & OS details
|
|
$contents = '<div><span class="list-large">' . $device->displayName() . '</span>';
|
|
if ($device->hardware) {
|
|
$contents .= ' - ' . htmlentities($device->hardware);
|
|
}
|
|
|
|
if ($device->os) {
|
|
$contents .= ' - ' . htmlentities(Config::getOsSetting($device->os, 'text'));
|
|
}
|
|
|
|
if ($device->version) {
|
|
$contents .= ' ' . htmlentities($device->version);
|
|
}
|
|
|
|
if ($device->features) {
|
|
$contents .= ' (' . htmlentities($device->features) . ')';
|
|
}
|
|
|
|
if ($device->location_id) {
|
|
$contents .= ' - ' . htmlentities($device->location);
|
|
}
|
|
|
|
$contents .= '</div>';
|
|
|
|
foreach ((array)$graphs as $entry) {
|
|
$graph = isset($entry['graph']) ? $entry['graph'] : 'unknown';
|
|
$graphhead = isset($entry['text']) ? $entry['text'] : 'unknown';
|
|
$contents .= '<div class="overlib-box">';
|
|
$contents .= '<span class="overlib-title">' . $graphhead . '</span><br />';
|
|
$contents .= Url::minigraphImage($device, $start, $end, $graph);
|
|
$contents .= Url::minigraphImage($device, Carbon::now()->subWeek()->timestamp, $end, $graph);
|
|
$contents .= '</div>';
|
|
}
|
|
|
|
if ($overlib == 0) {
|
|
$link = $contents;
|
|
} else {
|
|
$contents = self::escapeBothQuotes($contents);
|
|
$link = Url::overlibLink($url, $text, $contents, $class);
|
|
}
|
|
|
|
return $link;
|
|
}
|
|
|
|
/**
|
|
* @param Port $port
|
|
* @param string $text
|
|
* @param string $type
|
|
* @param boolean $overlib
|
|
* @param boolean $single_graph
|
|
* @return mixed|string
|
|
*/
|
|
public static function portLink($port, $text = null, $type = null, $overlib = true, $single_graph = false)
|
|
{
|
|
|
|
$label = Rewrite::normalizeIfName($port->getLabel());
|
|
if (!$text) {
|
|
$text = $label;
|
|
}
|
|
|
|
$content = '<div class=list-large>' . addslashes(htmlentities($port->device->displayName() . ' - ' . $label)) . '</div>';
|
|
if ($port->ifAlias) {
|
|
$content .= addslashes(htmlentities($port->ifAlias)) . '<br />';
|
|
}
|
|
|
|
$content .= "<div style=\'width: 850px\'>";
|
|
$graph_array = [
|
|
'type' => $type ?: 'port_bits',
|
|
'legend' => 'yes',
|
|
'height' => 100,
|
|
'width' => 340,
|
|
'to' => Carbon::now()->timestamp,
|
|
'from' => Carbon::now()->subDay()->timestamp,
|
|
'id' => $port->port_id,
|
|
];
|
|
|
|
$content .= self::graphTag($graph_array);
|
|
if (!$single_graph) {
|
|
$graph_array['from'] = Carbon::now()->subWeek()->timestamp;
|
|
$content .= self::graphTag($graph_array);
|
|
$graph_array['from'] = Carbon::now()->subMonth()->timestamp;
|
|
$content .= self::graphTag($graph_array);
|
|
$graph_array['from'] = Carbon::now()->subYear()->timestamp;
|
|
$content .= self::graphTag($graph_array);
|
|
}
|
|
|
|
$content .= '</div>';
|
|
|
|
if (!$overlib) {
|
|
return $content;
|
|
} elseif ($port->canAccess(Auth::user())) {
|
|
return self::overlibLink(self::portUrl($port), $text, $content, self::portLinkDisplayClass($port));
|
|
}
|
|
|
|
return Rewrite::normalizeIfName($text);
|
|
}
|
|
|
|
/**
|
|
* @param Sensor $sensor
|
|
* @param string $text
|
|
* @param string $type
|
|
* @param boolean $overlib
|
|
* @param boolean $single_graph
|
|
* @return mixed|string
|
|
*/
|
|
public static function sensorLink($sensor, $text = null, $type = null, $overlib = true, $single_graph = false)
|
|
{
|
|
|
|
$label = $sensor->sensor_descr;
|
|
if (!$text) {
|
|
$text = $label;
|
|
}
|
|
|
|
$content = '<div class=list-large>' . addslashes(htmlentities($sensor->device->displayName() . ' - ' . $label)) . '</div>';
|
|
|
|
$content .= "<div style=\'width: 850px\'>";
|
|
$graph_array = [
|
|
'type' => $type ?: 'sensor_' . $sensor->sensor_class,
|
|
'legend' => 'yes',
|
|
'height' => 100,
|
|
'width' => 340,
|
|
'to' => Carbon::now()->timestamp,
|
|
'from' => Carbon::now()->subDay()->timestamp,
|
|
'id' => $sensor->sensor_id,
|
|
];
|
|
|
|
$content .= self::graphTag($graph_array);
|
|
if (!$single_graph) {
|
|
$graph_array['from'] = Carbon::now()->subWeek()->timestamp;
|
|
$content .= self::graphTag($graph_array);
|
|
$graph_array['from'] = Carbon::now()->subMonth()->timestamp;
|
|
$content .= self::graphTag($graph_array);
|
|
$graph_array['from'] = Carbon::now()->subYear()->timestamp;
|
|
$content .= self::graphTag($graph_array);
|
|
}
|
|
|
|
$content .= '</div>';
|
|
|
|
if (!$overlib) {
|
|
return $content;
|
|
}
|
|
return self::overlibLink(self::sensorUrl($sensor), $text, $content, self::sensorLinkDisplayClass($sensor));
|
|
}
|
|
|
|
/**
|
|
* @param int|Device $device
|
|
* @param array $vars
|
|
* @return string
|
|
*/
|
|
public static function deviceUrl($device, $vars = [])
|
|
{
|
|
$routeParams = [is_int($device) ? $device : $device->device_id];
|
|
if (isset($vars['tab'])) {
|
|
$routeParams[] = $vars['tab'];
|
|
unset($vars['tab']);
|
|
}
|
|
|
|
return route('device', $routeParams) . self::urlParams($vars);
|
|
}
|
|
|
|
public static function portUrl($port, $vars = [])
|
|
{
|
|
return self::generate(['page' => 'device', 'device' => $port->device_id, 'tab' => 'port', 'port' => $port->port_id], $vars);
|
|
}
|
|
|
|
public static function sensorUrl($sensor, $vars = [])
|
|
{
|
|
return self::generate(['page' => 'device', 'device' => $sensor->device_id, 'tab' => 'health' , 'metric' => $sensor->sensor_class], $vars);
|
|
}
|
|
|
|
/**
|
|
* @param Port $port
|
|
* @return string
|
|
*/
|
|
public static function portThumbnail($port)
|
|
{
|
|
$graph_array = [
|
|
'port_id' => $port->port_id,
|
|
'graph_type' => 'port_bits',
|
|
'from' => Carbon::now()->subDay()->timestamp,
|
|
'to' => Carbon::now()->timestamp,
|
|
'width' => 150,
|
|
'height' => 21,
|
|
];
|
|
|
|
return self::portImage($graph_array);
|
|
}
|
|
|
|
public static function portImage($args)
|
|
{
|
|
if (empty($args['bg'])) {
|
|
$args['bg'] = 'FFFFFF00';
|
|
}
|
|
|
|
return '<img src="' . url('graph.php') . '?type=' . $args['graph_type'] . '&id=' . $args['port_id'] . '&from=' . $args['from'] . '&to=' . $args['to'] . '&width=' . $args['width'] . '&height=' . $args['height'] . '&bg=' . $args['bg'] . '">';
|
|
}
|
|
|
|
public static function generate($vars, $new_vars = [])
|
|
{
|
|
$vars = array_merge($vars, $new_vars);
|
|
|
|
$url = url($vars['page'] . '');
|
|
unset($vars['page']);
|
|
|
|
return $url . self::urlParams($vars);
|
|
}
|
|
|
|
/**
|
|
* Generate url parameters to append to url
|
|
* $prefix will only be prepended if there are parameters
|
|
*
|
|
* @param array $vars
|
|
* @param string $prefix
|
|
* @return string
|
|
*/
|
|
private static function urlParams($vars, $prefix = '/')
|
|
{
|
|
$url = empty($vars) ? '' : $prefix;
|
|
foreach ($vars as $var => $value) {
|
|
if ($value == '0' || $value != '' && !Str::contains($var, 'opt') && !is_numeric($var)) {
|
|
$url .= $var . '=' . urlencode($value) . '/';
|
|
}
|
|
}
|
|
|
|
return $url;
|
|
}
|
|
|
|
/**
|
|
* @param array $args
|
|
* @return string
|
|
*/
|
|
public static function graphTag($args)
|
|
{
|
|
$urlargs = [];
|
|
foreach ($args as $key => $arg) {
|
|
$urlargs[] = $key . '=' . urlencode($arg);
|
|
}
|
|
|
|
return '<img src="' . url('graph.php') . '?' . implode('&', $urlargs) . '" style="border:0;" />';
|
|
}
|
|
|
|
public static function graphPopup($args)
|
|
{
|
|
// Take $args and print day,week,month,year graphs in overlib, hovered over graph
|
|
$original_from = $args['from'];
|
|
$now = CarbonImmutable::now();
|
|
|
|
$graph = self::graphTag($args);
|
|
$content = '<div class=list-large>' . $args['popup_title'] . '</div>';
|
|
$content .= '<div style="width: 850px">';
|
|
$args['width'] = 340;
|
|
$args['height'] = 100;
|
|
$args['legend'] = 'yes';
|
|
$args['from'] = $now->subDay()->timestamp;
|
|
$content .= self::graphTag($args);
|
|
$args['from'] = $now->subWeek()->timestamp;
|
|
$content .= self::graphTag($args);
|
|
$args['from'] = $now->subMonth()->timestamp;
|
|
$content .= self::graphTag($args);
|
|
$args['from'] = $now->subYear()->timestamp;
|
|
$content .= self::graphTag($args);
|
|
$content .= '</div>';
|
|
|
|
$args['from'] = $original_from;
|
|
|
|
$args['link'] = self::generate($args, ['page' => 'graphs', 'height' => null, 'width' => null, 'bg' => null]);
|
|
|
|
return self::overlibLink($args['link'], $graph, $content, null);
|
|
}
|
|
|
|
public static function lazyGraphTag($args)
|
|
{
|
|
$urlargs = [];
|
|
|
|
foreach ($args as $key => $arg) {
|
|
$urlargs[] = $key . "=" . urlencode($arg);
|
|
}
|
|
|
|
|
|
if (Config::get('enable_lazy_load', true)) {
|
|
return '<img class="lazy img-responsive" data-original="' . url('graph.php') . '?' . implode('&', $urlargs) . '" style="border:0;" />';
|
|
}
|
|
|
|
return '<img class="img-responsive" src="' . url('graph.php') . '?' . implode('&', $urlargs) . '" style="border:0;" />';
|
|
}
|
|
|
|
public static function overlibLink($url, $text, $contents, $class = null)
|
|
{
|
|
$contents = "<div class=\'overlib-contents\'>" . $contents . '</div>';
|
|
$contents = str_replace('"', "\'", $contents);
|
|
if ($class === null) {
|
|
$output = '<a href="' . $url . '"';
|
|
} else {
|
|
$output = '<a class="' . $class . '" href="' . $url . '"';
|
|
}
|
|
|
|
if (Config::get('web_mouseover', true)) {
|
|
$defaults = Config::get('overlib_defaults', ",FGCOLOR,'#ffffff', BGCOLOR, '#e5e5e5', BORDER, 5, CELLPAD, 4, CAPCOLOR, '#555555', TEXTCOLOR, '#3e3e3e'");
|
|
$output .= " onmouseover=\"return overlib('$contents'$defaults,WRAP,HAUTO,VAUTO); \" onmouseout=\"return nd();\">";
|
|
} else {
|
|
$output .= '>';
|
|
}
|
|
|
|
$output .= $text . '</a>';
|
|
|
|
return $output;
|
|
}
|
|
|
|
public static function overlibContent($graph_array, $text)
|
|
{
|
|
$overlib_content = '<div class=overlib><span class=overlib-text>' . $text . '</span><br />';
|
|
|
|
$now = Carbon::now();
|
|
|
|
foreach ([1, 7, 30, 365] as $days) {
|
|
$graph_array['from'] = $now->subDays($days)->timestamp;
|
|
$overlib_content .= self::escapeBothQuotes(self::graphTag($graph_array));
|
|
}
|
|
|
|
$overlib_content .= '</div>';
|
|
|
|
return $overlib_content;
|
|
}
|
|
|
|
/**
|
|
* Generate minigraph image url
|
|
*
|
|
* @param Device $device
|
|
* @param int $start
|
|
* @param int $end
|
|
* @param string $type
|
|
* @param string $legend
|
|
* @param int $width
|
|
* @param int $height
|
|
* @param string $sep
|
|
* @param string $class
|
|
* @param int $absolute_size
|
|
* @return string
|
|
*/
|
|
public static function minigraphImage($device, $start, $end, $type, $legend = 'no', $width = 275, $height = 100, $sep = '&', $class = 'minigraph-image', $absolute_size = 0)
|
|
{
|
|
$vars = ['device=' . $device->device_id, "from=$start", "to=$end", "width=$width", "height=$height", "type=$type", "legend=$legend", "absolute=$absolute_size"];
|
|
return '<img class="' . $class . '" width="' . $width . '" height="' . $height . '" src="' . url('graph.php') . '?' . implode($sep, $vars) . '">';
|
|
}
|
|
|
|
/**
|
|
* @param Device $device
|
|
* @return string
|
|
*/
|
|
private static function deviceLinkDisplayClass($device)
|
|
{
|
|
if ($device->disabled) {
|
|
return 'list-device-disabled';
|
|
}
|
|
|
|
if ($device->ignore) {
|
|
return $device->status ? 'list-device-ignored-up' : 'list-device-ignored';
|
|
}
|
|
|
|
return $device->status ? 'list-device' : 'list-device-down';
|
|
}
|
|
|
|
/**
|
|
* Get html class for a port using ifAdminStatus and ifOperStatus
|
|
*
|
|
* @param Port $port
|
|
* @return string
|
|
*/
|
|
public static function portLinkDisplayClass($port)
|
|
{
|
|
if ($port->ifAdminStatus == "down") {
|
|
return "interface-admindown";
|
|
}
|
|
|
|
if ($port->ifAdminStatus == "up" && $port->ifOperStatus != "up") {
|
|
return "interface-updown";
|
|
}
|
|
|
|
return "interface-upup";
|
|
}
|
|
|
|
/**
|
|
* Get html class for a sensor
|
|
*
|
|
* @param \App\Models\Sensor $sensor
|
|
* @return string
|
|
*/
|
|
public static function sensorLinkDisplayClass($sensor)
|
|
{
|
|
if ($sensor->sensor_current > $sensor->sensor_limit) {
|
|
return "sensor-high";
|
|
}
|
|
|
|
if ($sensor->sensor_current < $sensor->sensor_limit_low) {
|
|
return "sensor-low";
|
|
}
|
|
|
|
return 'sensor-ok';
|
|
}
|
|
|
|
/**
|
|
* @param string $os
|
|
* @param string $feature
|
|
* @param string $icon
|
|
* @param string $dir directory to search in (images/os/ or images/logos)
|
|
* @return string
|
|
*/
|
|
public static function findOsImage($os, $feature, $icon = null, $dir = 'images/os/')
|
|
{
|
|
$possibilities = [$icon];
|
|
|
|
if ($os) {
|
|
if ($os == "linux") {
|
|
// first, prefer the first word of $feature
|
|
$distro = Str::before(strtolower(trim($feature)), ' ');
|
|
$possibilities[] = "$distro.svg";
|
|
$possibilities[] = "$distro.png";
|
|
|
|
// second, prefer the first two words of $feature (i.e. 'Red Hat' becomes 'redhat')
|
|
if (strpos($feature, ' ') !== false) {
|
|
$distro = Str::replaceFirst(' ', null, strtolower(trim($feature)));
|
|
$distro = Str::before($distro, ' ');
|
|
$possibilities[] = "$distro.svg";
|
|
$possibilities[] = "$distro.png";
|
|
}
|
|
}
|
|
$os_icon = Config::getOsSetting($os, 'icon', $os);
|
|
$possibilities[] = "$os_icon.svg";
|
|
$possibilities[] = "$os_icon.png";
|
|
}
|
|
|
|
foreach ($possibilities as $file) {
|
|
if (is_file(Config::get('html_dir') . "/$dir" . $file)) {
|
|
return $file;
|
|
}
|
|
}
|
|
|
|
// fallback to the generic icon
|
|
return 'generic.svg';
|
|
}
|
|
|
|
/**
|
|
* parse a legacy path (one without ? or &)
|
|
*
|
|
* @param string $path
|
|
* @return ParameterBag
|
|
*/
|
|
public static function parseLegacyPath($path)
|
|
{
|
|
$parts = array_filter(explode('/', $path), function ($part) {
|
|
return Str::contains($part, '=');
|
|
});
|
|
|
|
$vars = [];
|
|
foreach ($parts as $part) {
|
|
[$key, $value] = explode('=', $part);
|
|
$vars[$key] = $value;
|
|
}
|
|
|
|
return new ParameterBag($vars);
|
|
}
|
|
|
|
private static function escapeBothQuotes($string)
|
|
{
|
|
return str_replace(["'", '"'], "\'", $string);
|
|
}
|
|
}
|