mirror of
https://github.com/librenms/librenms.git
synced 2024-10-07 16:52:45 +00:00
a37efd2876
* Device Ports settings * Save port settings per user * style * Delete user pref if it matches the defaults * Because we are saving settings now, we must explicitly set to make the links work
429 lines
15 KiB
PHP
429 lines
15 KiB
PHP
<?php
|
|
/**
|
|
* PortsController.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 <https://www.gnu.org/licenses/>.
|
|
*
|
|
* @link https://www.librenms.org
|
|
*
|
|
* @copyright 2020 Tony Murray
|
|
* @author Tony Murray <murraytony@gmail.com>
|
|
*/
|
|
|
|
namespace App\Http\Controllers\Device\Tabs;
|
|
|
|
use App\Models\Device;
|
|
use App\Models\Link;
|
|
use App\Models\Port;
|
|
use App\Models\Pseudowire;
|
|
use App\Models\UserPref;
|
|
use Illuminate\Database\Eloquent\Builder;
|
|
use Illuminate\Http\Request;
|
|
use Illuminate\Pagination\LengthAwarePaginator;
|
|
use Illuminate\Support\Collection;
|
|
use Illuminate\Support\Facades\Auth;
|
|
use Illuminate\Support\Facades\Validator;
|
|
use LibreNMS\Config;
|
|
use LibreNMS\Interfaces\UI\DeviceTab;
|
|
|
|
class PortsController implements DeviceTab
|
|
{
|
|
private bool $detail = false;
|
|
private array $settings = [];
|
|
private array $defaults = [
|
|
'perPage' => 32,
|
|
'sort' => 'ifIndex',
|
|
'order' => 'asc',
|
|
'disabled' => false,
|
|
'ignored' => false,
|
|
'admin' => 'up',
|
|
'status' => 'any',
|
|
];
|
|
|
|
public function visible(Device $device): bool
|
|
{
|
|
return $device->ports()->exists();
|
|
}
|
|
|
|
public function slug(): string
|
|
{
|
|
return 'ports';
|
|
}
|
|
|
|
public function icon(): string
|
|
{
|
|
return 'fa-link';
|
|
}
|
|
|
|
public function name(): string
|
|
{
|
|
return __('Ports');
|
|
}
|
|
|
|
public function data(Device $device, Request $request): array
|
|
{
|
|
Validator::validate($request->all(), [
|
|
'page' => 'int',
|
|
'perPage' => ['regex:/^(\d+|all)$/'],
|
|
'sort' => 'in:media,mac,port,traffic,speed',
|
|
'order' => 'in:asc,desc',
|
|
'disabled' => 'in:0,1',
|
|
'ignored' => 'in:0,1',
|
|
'admin' => 'in:up,down,testing,any',
|
|
'status' => 'in:up,down,testing,unknown,dormant,notPresent,lowerLayerDown,any',
|
|
'type' => 'in:bits,upkts,nupkts,errors,etherlike',
|
|
'from' => ['regex:/^(int|[+-]\d+[hdmy])$/'],
|
|
'to' => ['regex:/^(int|[+-]\d+[hdmy])$/'],
|
|
]);
|
|
|
|
$this->loadSettings($request);
|
|
$tab = $this->parseTab($request);
|
|
$this->detail = $tab == 'detail';
|
|
$data = match ($tab) {
|
|
'links' => $this->linksData($device),
|
|
'xdsl' => $this->xdslData($device),
|
|
'graphs', 'mini_graphs' => $this->graphData($device, $request),
|
|
default => $this->portData($device, $request),
|
|
};
|
|
|
|
return array_merge([
|
|
'tab' => $tab,
|
|
'details' => $this->detail,
|
|
'submenu' => [
|
|
$this->getTabs($device),
|
|
__('Graphs') => $this->getGraphLinks(),
|
|
],
|
|
'page_links' => $this->pageLinks($request),
|
|
'perPage' => $this->settings['perPage'],
|
|
'sort' => $this->settings['sort'],
|
|
'next_order' => $this->settings['order'] == 'asc' ? 'desc' : 'asc',
|
|
], $data);
|
|
}
|
|
|
|
private function portData(Device $device, Request $request): array
|
|
{
|
|
$relationships = ['groups', 'ipv4', 'ipv6', 'vlans', 'adsl', 'vdsl'];
|
|
if ($this->detail) {
|
|
$relationships[] = 'links';
|
|
$relationships[] = 'pseudowires.endpoints';
|
|
$relationships[] = 'ipv4Networks.ipv4';
|
|
$relationships[] = 'ipv6Networks.ipv6';
|
|
}
|
|
|
|
/** @var Collection<Port>|LengthAwarePaginator<Port> $ports */
|
|
$ports = $this->getFilteredPortsQuery($device, $relationships)
|
|
->paginate(fn ($total) => $this->settings['perPage'] == 'all' ? $total : (int) $this->settings['perPage']) // @phpstan-ignore-line missing closure type
|
|
->appends('perPage', $this->settings['perPage']);
|
|
|
|
$data = [
|
|
'ports' => $ports,
|
|
'neighbors' => $ports->keyBy('port_id')->map(fn (Port $port) => $this->findPortNeighbors($port)),
|
|
'graphs' => [
|
|
'bits' => [['type' => 'port_bits', 'title' => trans('Traffic'), 'vars' => [['from' => '-1d'], ['from' => '-7d'], ['from' => '-30d'], ['from' => '-1y']]]],
|
|
'upkts' => [['type' => 'port_upkts', 'title' => trans('Packets (Unicast)'), 'vars' => [['from' => '-1d'], ['from' => '-7d'], ['from' => '-30d'], ['from' => '-1y']]]],
|
|
'errors' => [['type' => 'port_errors', 'title' => trans('Errors'), 'vars' => [['from' => '-1d'], ['from' => '-7d'], ['from' => '-30d'], ['from' => '-1y']]]],
|
|
],
|
|
];
|
|
|
|
if ($this->detail) {
|
|
$data['neighbor_ports'] = Port::with('device')
|
|
->hasAccess(Auth::user())
|
|
->whereIn('port_id', $data['neighbors']->map(fn ($a) => array_keys($a))->flatten())
|
|
->get()->keyBy('port_id');
|
|
}
|
|
|
|
return $data;
|
|
}
|
|
|
|
public function findPortNeighbors(Port $port): array
|
|
{
|
|
// only do for detail
|
|
if (! $this->detail) {
|
|
return [];
|
|
}
|
|
|
|
// skip ports that cannot have neighbors
|
|
if (in_array($port->ifType, ['softwareLoopback', 'rs232'])) {
|
|
return [];
|
|
}
|
|
|
|
$neighbors = [];
|
|
|
|
// Links always included
|
|
// fa-plus black portlink on devicelink
|
|
foreach ($port->links as $link) {
|
|
/** @var Link $link */
|
|
if ($link->remote_port_id) {
|
|
$this->addPortNeighbor($neighbors, 'link', $link->remote_port_id);
|
|
}
|
|
}
|
|
|
|
if ($this->detail) {
|
|
// IPv4 + IPv6 subnet if detailed
|
|
// fa-arrow-right green portlink on devicelink
|
|
if ($port->ipv4Networks->isNotEmpty()) {
|
|
$ids = $port->ipv4Networks->map(fn ($net) => $net->ipv4->pluck('port_id'))->flatten();
|
|
foreach ($ids as $port_id) {
|
|
if ($port_id !== $port->port_id) {
|
|
$this->addPortNeighbor($neighbors, 'ipv4_network', $port_id);
|
|
}
|
|
}
|
|
}
|
|
|
|
if ($port->ipv6Networks->isNotEmpty()) {
|
|
$ids = $port->ipv6Networks->map(fn ($net) => $net->ipv6->pluck('port_id'))->flatten();
|
|
foreach ($ids as $port_id) {
|
|
if ($port_id !== $port->port_id) {
|
|
$this->addPortNeighbor($neighbors, 'ipv6_network', $port_id);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// pseudowires
|
|
// fa-cube green portlink on devicelink: cpwVcID
|
|
/** @var Pseudowire $pseudowire */
|
|
foreach ($port->pseudowires as $pseudowire) {
|
|
foreach ($pseudowire->endpoints as $endpoint) {
|
|
if ($endpoint->port_id != $port->port_id) {
|
|
$this->addPortNeighbor($neighbors, 'pseudowire', $endpoint->port_id);
|
|
}
|
|
}
|
|
}
|
|
|
|
// port stack
|
|
// fa-expand portlink: local is low port
|
|
// fa-compress portlink: local is high portPort
|
|
$stacks = \DB::table('ports_stack')->where('device_id', $port->device_id)
|
|
->where(fn ($q) => $q->where('port_id_high', $port->port_id)->orWhere('port_id_low', $port->port_id))->get();
|
|
foreach ($stacks as $stack) {
|
|
if ($stack->port_id_low) {
|
|
$this->addPortNeighbor($neighbors, 'stack_low', $stack->port_id_low);
|
|
}
|
|
if ($stack->port_id_high) {
|
|
$this->addPortNeighbor($neighbors, 'stack_high', $stack->port_id_high);
|
|
}
|
|
}
|
|
|
|
// PAGP members/parent
|
|
// fa-cube portlink: pagpGroupIfIndex = ifIndex parent
|
|
// fa-cube portlink: if (not parent, pagpGroupIfIndex != ifIndex) ifIndex = pagpGroupIfIndex member
|
|
if ($port->pagpGroupIfIndex) {
|
|
if ($port->pagpGroupIfIndex == $port->ifIndex) {
|
|
$this->addPortNeighbor($neighbors, 'pagp', $port->port_id);
|
|
} else {
|
|
$this->addPortNeighbor($neighbors, 'pagp', $port->pagpParent->port_id);
|
|
}
|
|
}
|
|
|
|
return $neighbors;
|
|
}
|
|
|
|
private function addPortNeighbor(array &$neighbors, string $type, int $port_id): void
|
|
{
|
|
if (empty($neighbors[$port_id])) {
|
|
$neighbors[$port_id] = [
|
|
'port_id' => $port_id,
|
|
];
|
|
}
|
|
|
|
$neighbors[$port_id][$type] = 1;
|
|
}
|
|
|
|
private function graphData(Device $device, Request $request): array
|
|
{
|
|
return [
|
|
'graph_type' => 'port_' . $request->get('type'),
|
|
'ports' => $this->getFilteredPortsQuery($device)->get(),
|
|
];
|
|
}
|
|
|
|
private function xdslData(Device $device): array
|
|
{
|
|
$device->portsAdsl->load('port');
|
|
$device->portsVdsl->load('port');
|
|
|
|
return [
|
|
'adsl' => $device->portsAdsl->sortBy('port.ifIndex'),
|
|
'vdsl' => $device->portsVdsl->sortBy('port.ifIndex'),
|
|
];
|
|
}
|
|
|
|
private function linksData(Device $device): array
|
|
{
|
|
$device->links->load(['port', 'remotePort', 'remoteDevice']);
|
|
|
|
return ['links' => $device->links];
|
|
}
|
|
|
|
private function getTabs(Device $device): array
|
|
{
|
|
$tabs = [
|
|
['name' => __('Basic'), 'url' => 'basic'],
|
|
['name' => __('Detail'), 'url' => ''],
|
|
];
|
|
|
|
if ($device->macs()->exists()) {
|
|
$tabs[] = ['name' => __('port.tabs.arp'), 'url' => 'arp'];
|
|
}
|
|
|
|
if ($device->portsFdb()->exists()) {
|
|
$tabs[] = ['name' => __('port.tabs.fdb'), 'url' => 'fdb'];
|
|
}
|
|
|
|
if ($device->links()->exists()) {
|
|
$tabs[] = ['name' => __('port.tabs.links'), 'url' => 'links'];
|
|
}
|
|
|
|
if ($device->portsAdsl()->exists() || $device->portsVdsl()->exists()) {
|
|
$tabs[] = ['name' => __('port.tabs.xdsl'), 'url' => 'xdsl'];
|
|
}
|
|
|
|
return $tabs;
|
|
}
|
|
|
|
/**
|
|
* @return array[]
|
|
*/
|
|
private function getGraphLinks(): array
|
|
{
|
|
$graph_links = [
|
|
[
|
|
'name' => __('port.graphs.bits'),
|
|
'url' => 'graphs?type=bits',
|
|
'sub_name' => __('Mini'),
|
|
'sub_url' => 'mini_graphs?type=bits',
|
|
],
|
|
[
|
|
'name' => __('port.graphs.upkts'),
|
|
'url' => 'graphs?type=upkts',
|
|
'sub_name' => __('Mini'),
|
|
'sub_url' => 'mini_graphs?type=upkts',
|
|
],
|
|
[
|
|
'name' => __('port.graphs.nupkts'),
|
|
'url' => 'graphs?type=nupkts',
|
|
'sub_name' => __('Mini'),
|
|
'sub_url' => 'mini_graphs?type=nupkts',
|
|
],
|
|
[
|
|
'name' => __('port.graphs.errors'),
|
|
'url' => 'graphs?type=errors',
|
|
'sub_name' => __('Mini'),
|
|
'sub_url' => 'mini_graphs?type=errors',
|
|
],
|
|
];
|
|
|
|
if (Config::get('enable_ports_etherlike')) {
|
|
$graph_links[] = [
|
|
'name' => __('port.graphs.etherlike'),
|
|
'url' => 'graphs?type=etherlike',
|
|
'sub_name' => __('Mini'),
|
|
'sub_url' => 'mini_graphs?type=etherlike',
|
|
];
|
|
}
|
|
|
|
return $graph_links;
|
|
}
|
|
|
|
private function loadSettings(Request $request): void
|
|
{
|
|
$input = $request->only(['perPage', 'sort', 'order', 'disabled', 'ignored', 'admin', 'status']);
|
|
$saved = UserPref::getPref($request->user(), 'ports_ui_settings') ?? [];
|
|
|
|
$this->settings = $input + $saved + $this->defaults;
|
|
|
|
if ($this->settings != $saved) {
|
|
if ($this->settings == $this->defaults) {
|
|
UserPref::forgetPref($request->user(), 'ports_ui_settings');
|
|
} else {
|
|
UserPref::setPref($request->user(), 'ports_ui_settings', $this->settings);
|
|
}
|
|
}
|
|
}
|
|
|
|
private function getFilteredPortsQuery(Device $device, array $relationships = []): Builder
|
|
{
|
|
$orderBy = match ($this->settings['sort']) {
|
|
'traffic' => \DB::raw('ports.ifInOctets_rate + ports.ifOutOctets_rate'),
|
|
'speed' => 'ifSpeed',
|
|
'media' => 'ifType',
|
|
'mac' => 'ifPhysAddress',
|
|
'port' => 'ifName',
|
|
default => 'ifIndex',
|
|
};
|
|
|
|
return Port::where('device_id', $device->device_id)
|
|
->isNotDeleted()
|
|
->hasAccess(Auth::user())->with($relationships)
|
|
->when(! $this->settings['disabled'], fn (Builder $q, $disabled) => $q->where('disabled', 0))
|
|
->when(! $this->settings['ignored'], fn (Builder $q, $disabled) => $q->where('ignore', 0))
|
|
->when($this->settings['admin'] != 'any', fn (Builder $q, $admin) => $q->where('ifAdminStatus', $this->settings['admin']))
|
|
->when($this->settings['status'] != 'any', fn (Builder $q, $admin) => $q->where('ifOperStatus', $this->settings['status']))
|
|
->orderBy($orderBy, $this->settings['order']);
|
|
}
|
|
|
|
/**
|
|
* get the ports sub tab name including handling legacy urls
|
|
*/
|
|
private function parseTab(Request $request): string
|
|
{
|
|
if (preg_match('#view=([^/]+)#', $request->fullUrl(), $matches)) {
|
|
return match ($matches[1]) {
|
|
'neighbours' => 'links',
|
|
default => $matches[1],
|
|
};
|
|
}
|
|
|
|
return $request->route('vars', 'detail'); // fourth segment is called vars to handle legacy urls
|
|
}
|
|
|
|
private function pageLinks(Request $request): array
|
|
{
|
|
$disabled = $this->settings['disabled'];
|
|
$ignored = $this->settings['ignored'];
|
|
$admin = $this->settings['admin'] == 'any';
|
|
$status = $this->settings['status'] == 'up';
|
|
|
|
return [
|
|
[
|
|
'icon' => $status ? 'fa-regular fa-square-check' : 'fa-regular fa-square',
|
|
'url' => $request->fullUrlWithQuery(['status' => $status ? $this->defaults['status'] : 'up']),
|
|
'title' => __('port.filters.status_up'),
|
|
'external' => false,
|
|
],
|
|
[
|
|
'icon' => $admin ? 'fa-regular fa-square-check' : 'fa-regular fa-square',
|
|
'url' => $request->fullUrlWithQuery(['admin' => $admin ? $this->defaults['admin'] : 'any']),
|
|
'title' => __('port.filters.admin_down'),
|
|
'external' => false,
|
|
],
|
|
[
|
|
'icon' => $disabled ? 'fa-regular fa-square-check' : 'fa-regular fa-square',
|
|
'url' => $request->fullUrlWithQuery(['disabled' => ! $disabled]),
|
|
'title' => __('port.filters.disabled'),
|
|
'external' => false,
|
|
],
|
|
[
|
|
'icon' => $ignored ? 'fa-regular fa-square-check' : 'fa-regular fa-square',
|
|
'url' => $request->fullUrlWithQuery(['ignored' => ! $ignored]),
|
|
'title' => __('port.filters.ignored'),
|
|
'external' => false,
|
|
],
|
|
];
|
|
}
|
|
}
|