Skip to content

Commit

Permalink
Settings overview dashboard
Browse files Browse the repository at this point in the history
  • Loading branch information
@jokob-sk
jokob-sk committed Oct 22, 2023
1 parent ae7533c commit 138a899
Show file tree
Hide file tree
Showing 3 changed files with 219 additions and 14 deletions.
11 changes: 9 additions & 2 deletions front/php/templates/language/en_us.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -472,8 +472,15 @@
"settings_missing" : "Not all settings loaded, refresh the page! This is probably caused by a high load on the database or app startup sequence.",
"settings_missing_block" : "You can not save your settings without specifying all setting keys. Refresh the page. This is probably caused by a high load on the database.",
"settings_old" : "Importing settings and re-initializing...",
"settings_saved" : "<br/>Settings saved to the <code>pialert.conf</code> file.<br/><br/>A time-stamped backup of the previous file created. <br/><br/> Reloading...<br/>",
"settings_imported" : "Last time settings were imported from the pialert.conf file:",
"settings_saved" : "<br/>Settings saved to the <code>pialert.conf</code> file.<br/><br/>A time-stamped backup of the previous file created. <br/><br/> Reloading...<br/>",
"settings_imported_label" : "Settings imported",
"settings_imported" : "Last time settings were imported from the pialert.conf file",
"settings_scanners_enabled_label" : "Enabled scanners",
"settings_scanners_enabled" : "All plugins of the scanner type that are currently enabled.",
"settings_device_scanners_label" : "Device scanners",
"settings_device_scanners" : "Device scanners used to discover devices that write into the CurrentScan database table.",
"settings_publishers_enabled_label" : "Enabled publishers",
"settings_publishers_enabled" : "Enabled notification gateways - publishers, that will send a notification depending on your settings.",
"settings_expand_all" : "Expand all",
"Setting_Override" : "Override value",
"Setting_Override_Description" : "Enabling this option will override an App supplied default value with the value specified above.",
Expand Down
2 changes: 1 addition & 1 deletion front/plugins/arp_scan/config.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -341,7 +341,7 @@
"description": [
{
"language_code": "en_us",
"string": "Arguments to run arps-scan with. Recommended and tested only with the setting <code>sudo arp-scan --ignoredups --retry=6</code>."
"string": "Arguments to run arps-scan with. Recommended and tested only with the setting: <br/> <code>sudo arp-scan --ignoredups --retry=6</code>."
}
]
}
Expand Down
220 changes: 209 additions & 11 deletions front/settings.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,29 @@
</span>
</a>
</h1>
<div class="settingsImported"><?= lang("settings_imported");?> <span id="lastImportedTime"></span></div>

<div class="col-sm-2 " title="<?= lang("settings_imported");?> ">
<div class="settingsImported">
<?= lang("settings_imported_label");?>
</div>
</div>
<div class="col-sm-10">
<span id="lastImportedTime"></span>
</div>


</section>
<section class="content-header">

<div id="settingsOverview" class ="bg-white color-palette box panel panel-default col-sm-12 box-default box-info" >
<!-- Settings imported time -->




</section>


<div class="content settingswrap " id="accordion_gen">

<div class ="bg-grey-dark color-palette box panel panel-default col-sm-12 box-default box-info" >
Expand Down Expand Up @@ -123,27 +144,130 @@


<script>

// -------------------------------------------------------------------
// Get plugin type base on prefix
function getPluginType(pluginsData, prefix)
{

result = "core_content"
result = "core"

pluginsData.forEach((plug) => {

if (plug.unique_prefix == prefix ) {
id = plug.plugin_type + "_content"
id = plug.plugin_type;

console.log(id)
result = plug.plugin_type + "_content";
// console.log(id)
result = plug.plugin_type;
}
});

return result;
}


// -------------------------------------------------------------------
// Generate plugin HTML card based on prefixes in an array
function pluginCards(prefixesOfEnabledPlugins, includeSettings)
{
html = ""

prefixesOfEnabledPlugins.forEach((prefix) => {

includeSettings_html = ''

includeSettings.forEach((set) => {

includeSettings_html += `<div><code>${getSetting(prefix+set)}</code></div>`

});

html += `<div class="col-sm-3 ">
<div class="info-box bg-aqua">
<span class="info-box-icon"> ${getString(prefix+"_icon")} </span>
<div class="info-box-content">
<span class="info-box-text">
${getString(prefix+"_display_name")}
${includeSettings_html}
</span>
</div>
</div>
</div>`
});

return html;
}

// -------------------------------------------------------------------
// Gets scanners that write into the CurrentScan table
function getMappedToCurrentScan(prefixesOfEnabledPlugins, pluginsData, onlyEnabled)
{
plug_schedules = []
plug_prefixes = []

prefixesOfEnabledPlugins.forEach((prefix) => {
pluginsData.forEach((plug) => {

// enabled plugin is mapping to the CurrentScan table -> save the data to check the schedule
if (plug.unique_prefix == prefix && plug.mapped_to_table == "CurrentScan") {

shouldContinue = true;

// skip if not enabled and should return only enabled
if(onlyEnabled && getSetting(prefix+"_RUN") != 'schedule')
{
shouldContinue = false
}

if(shouldContinue)
{
plug_prefixes.push(prefix)
plug_schedules.push(getSetting(prefix+"_RUN_SCHD").replace(/\s/g, "")) // replace all white characters to compare them easier

}
}

});
});

return plug_prefixes;
}

// // -------------------------------------------------------------------
// // Gets scanners that write into the CurrentScan table
// function getMappedToCurrentScan(prefixesOfEnabledPlugins, pluginsData, onlyEnabled)
// {
// plug_schedules = []
// plug_prefixes = []

// prefixesOfEnabledPlugins.forEach((prefix) => {
// pluginsData.forEach((plug) => {

// // enabled plugin is mapping to the CurrentScan table -> save the data to check the schedule
// if (plug.unique_prefix == prefix && plug.mapped_to_table == "CurrentScan") {

// shouldContinue = true;

// // skip if not enabled and should return only enabled
// if(onlyEnabled && getSetting(prefix+"_RUN") != 'schedule')
// {
// shouldContinue = false
// }

// if(shouldContinue)
// {
// plug_prefixes.push(prefix)
// plug_schedules.push(getSetting(prefix+"_RUN_SCHD").replace(/\s/g, "")) // replace all white characters to compare them easier

// }
// }

// });
// });

// return plug_prefixes;
// }

// -------------------------------------------------------------------
// Get plugin and settings data from API endpoints
function getData(){

$.get('api/table_settings.json?nocache=' + Date.now(), function(res) {
Expand All @@ -159,25 +283,99 @@ function getData(){
})
}

// -------------------------------------------------------------------
// main initialization function
function initSettingsPage(settingsData, pluginsData){

const settingGroups = [];

const enabledScanners = [];

const enabledPublishers = [];
const pluginTypes = [];
const settingKeyOfLists = [];

// core groups are the ones not generated by plugins
const settingCoreGroups = ['General'];

// Loop through the settingsArray and collect unique settingGroups
// Loop through the settingsArray and:
// - collect unique settingGroups
// - collect enabled plugins

settingsData.forEach((set) => {
// settingGroups
if (!settingGroups.includes(set.Group)) {
settingGroups.push(set.Group);
settingGroups.push(set.Group); // = Unique plugin prefix
}
// check if NOT disabled
if (set.Code_Name.endsWith("_RUN") && set.Value != 'disabled') {

switch(getPluginType(pluginsData, set.Group))
{
case "scanner":
enabledScanners.push(set.Group);
break;
case "publisher":
enabledPublishers.push(set.Group);
break;
default:
break;
}
}
});

const enabledDeviceScanners = getMappedToCurrentScan(enabledScanners, pluginsData, true);

// Init the overview section
overviewSections = [
'scanners_enabled',
'publishers_enabled',
'device_scanners'
]
overviewSectionsHtml = [
pluginCards(enabledScanners, []),
pluginCards(enabledPublishers, []),
pluginCards(enabledDeviceScanners,['_RUN', '_RUN_SCHD'])
]

// "settings_device_scanners_label"
// <!-- Enabled scanners -->
// <div class="col-sm-2" title="<?= lang("settings_scanners_enabled");?> ">
// <div class="">
// <?= lang("settings_scanners_enabled_label");?>
// </div>
// </div>
// <div class="col-sm-10" id="enabledScanners">

// </div>

index = 0
overviewSections_html = ''

overviewSections.forEach((section) => {

overviewSections_html += `<div>
<div class="col-sm-2 " title="${getString("settings_"+section)}">
<div class="">
${getString("settings_"+section+"_label")}
</div>
</div>
<div class="col-sm-10">
${overviewSectionsHtml[index]}
</div>
</div>`

index++;

});


// checkSchedules(enabledScanners, pluginsData)

console.log(settingGroups);
$('#settingsOverview').append(overviewSections_html);


// Start constructing the main settings HTML
let pluginHtml = `
<div class="row table_row">
<div class="table_cell bold">
Expand Down Expand Up @@ -209,7 +407,7 @@ function initSettingsPage(settingsData, pluginsData){
isIn = ' '; // open the first panel only by default on page load

// generate headers/sections
$('#'+getPluginType(pluginsData, group)).append(headerHtml);
$('#'+getPluginType(pluginsData, group) + "_content").append(headerHtml);
}


Expand Down

0 comments on commit 138a899

Please sign in to comment.