upstream/opnsense-plugins
1
0
Fork 0
mirror of https://github.com/opnsense/plugins.git synced 2026-06-08 16:34:18 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

sysutils/hw-probe: New plugin (#2075)

Browse source
This commit is contained in:
Michael 2020-10-22 09:19:32 +02:00 committed by GitHub
parent 2871ba1546
commit 02269d96af
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
12 changed files with 264 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
sysutils/hw-probe/Makefile Normal file
View file

@ -0,0 +1,8 @@
PLUGIN_NAME= hw-probe
PLUGIN_VERSION= 0.1
PLUGIN_COMMENT= Collect hardware diagnostics
PLUGIN_DEPENDS= hw-probe
PLUGIN_MAINTAINER= m.muenz@gmail.com
PLUGIN_DEVEL= yes
.include "../../Mk/plugins.mk"

1
sysutils/hw-probe/pkg-descr Normal file
View file

@ -0,0 +1 @@
Send anonymized hardware diagnostics to https://bsd-hardware.info

37
sysutils/hw-probe/src/opnsense/mvc/app/controllers/OPNsense/Hwprobe/Api/GeneralController.php Normal file
View file

@ -0,0 +1,37 @@
<?php
/*
* Copyright (C) 2020 Michael Muenz <m.muenz@gmail.com>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
* AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
* OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
namespace OPNsense\Hwprobe\Api;
use OPNsense\Base\ApiMutableModelControllerBase;
class GeneralController extends ApiMutableModelControllerBase
{
protected static $internalModelClass = '\OPNsense\Hwprobe\General';
protected static $internalModelName = 'general';
}

51
sysutils/hw-probe/src/opnsense/mvc/app/controllers/OPNsense/Hwprobe/Api/ServiceController.php Normal file
View file

@ -0,0 +1,51 @@
<?php
/*
* Copyright (C) 2020 Michael Muenz <m.muenz@gmail.com>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
* AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
* OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
namespace OPNsense\Hwprobe\Api;
use OPNsense\Base\ApiMutableServiceControllerBase;
use OPNsense\Core\Backend;
class ServiceController extends ApiMutableServiceControllerBase
{
protected static $internalServiceClass = '\OPNsense\Hwprobe\General';
protected static $internalServiceTemplate = 'OPNsense/Hwprobe';
protected static $internalServiceEnabled = 'enabled';
protected static $internalServiceName = 'hwprobe';
/**
* generate report
* @return array
*/
public function reportAction()
{
$backend = new Backend();
$response = $backend->configdRun("hwprobe report");
return array("response" => $response);
}
}

38
sysutils/hw-probe/src/opnsense/mvc/app/controllers/OPNsense/Hwprobe/GeneralController.php Normal file
View file

@ -0,0 +1,38 @@
<?php
/*
* Copyright (C) 2020 Michael Muenz <m.muenz@gmail.com>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
* AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
* OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
namespace OPNsense\Hwprobe;
class GeneralController extends \OPNsense\Base\IndexController
{
public function indexAction()
{
$this->view->generalForm = $this->getForm('general');
$this->view->pick('OPNsense/Hwprobe/general');
}
}

8
sysutils/hw-probe/src/opnsense/mvc/app/controllers/OPNsense/Hwprobe/forms/general.xml Normal file
View file

@ -0,0 +1,8 @@
<form>
<field>
<id>general.enabled</id>
<label>Enable</label>
<type>checkbox</type>
<help>Enable HW-Probe.</help>
</field>
</form>

9
sysutils/hw-probe/src/opnsense/mvc/app/models/OPNsense/Hwprobe/ACL/ACL.xml Normal file
View file

@ -0,0 +1,9 @@
<acl>
<page-services-hwprobe>
<name>Services: HWProbe</name>
<patterns>
<pattern>ui/hwprobe/*</pattern>
<pattern>api/hwprobe/*</pattern>
</patterns>
</page-services-hwprobe>
</acl>

35
sysutils/hw-probe/src/opnsense/mvc/app/models/OPNsense/Hwprobe/General.php Normal file
View file

@ -0,0 +1,35 @@
<?php
/*
* Copyright (C) 2020 Michael Muenz <m.muenz@gmail.com>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
* AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
* OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
namespace OPNsense\Hwprobe;
use OPNsense\Base\BaseModel;
class General extends BaseModel
{
}

11
sysutils/hw-probe/src/opnsense/mvc/app/models/OPNsense/Hwprobe/General.xml Normal file
View file

@ -0,0 +1,11 @@
<model>
<mount>//OPNsense/hwprobe/general</mount>
<description>HWProbe configuration</description>
<version>0.0.1</version>
<items>
<enabled type="BooleanField">
<default>0</default>
<Required>Y</Required>
</enabled>
</items>
</model>

7
sysutils/hw-probe/src/opnsense/mvc/app/models/OPNsense/Hwprobe/Menu/Menu.xml Normal file
View file

@ -0,0 +1,7 @@
<menu>
<Services>
<HWProbe cssClass="fa fa-thermometer-half">
<General url="/ui/hwprobe/general/index"/>
</HWProbe>
</Services>
</menu>

54
sysutils/hw-probe/src/opnsense/mvc/app/views/OPNsense/Hwprobe/general.volt Normal file
View file

@ -0,0 +1,54 @@
{#
# Copyright (c) 2020 Deciso B.V.
# Copyright (c) 2020 Michael Muenz <m.muenz@gmail.com>
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without modification,
# are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES,
# INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
# AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
# AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
# OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#}
<div class="content-box" style="padding-bottom: 1.5em;">
<div class="col-md-12">
<hr />
</div>
<div id="hourly" class="tab-pane col-md-12 fade in">
<pre id="listreport"></pre>
</div>
<div class="col-md-12">
<hr />
<button class="btn btn-primary" id="reportAct" type="button"><b>{{ lang._('Generate') }}</b> <i id="reportAct_progress"></i></button>
</div>
</div>
<script>
$(function() {
// link save button to API set action
$("#reportAct").click(function(){
$("#reportAct_progress").addClass("fa fa-spinner fa-pulse");
ajaxCall(url="/api/hwprobe/service/report", sendData={}, callback=function(data,status) {
$("#listreport").text(data['response']);
$("#reportAct_progress").removeClass("fa fa-spinner fa-pulse");
});
});
});
</script>

5
sysutils/hw-probe/src/opnsense/service/conf/actions.d/actions_hwprobe.conf Normal file
View file

@ -0,0 +1,5 @@
[report]
command:/usr/local/bin/hw-probe
parameters:
type:script_output
message:collecting hardware diagnostics