luci-app-adblock: fix frontend typo
[project/luci.git] / applications / luci-app-adblock / luasrc / model / cbi / adblock / overview_tab.lua
index e2ef1ef..aef0a9f 100644 (file)
@@ -1,4 +1,4 @@
--- Copyright 2017 Dirk Brenken (dev@brenken.org)
+-- Copyright 2017-2018 Dirk Brenken (dev@brenken.org)
 -- This is free software, licensed under the Apache License, Version 2.0
 
 local fs       = require("nixio.fs")
@@ -9,9 +9,9 @@ local dump     = util.ubus("network.interface", "dump", {})
 local json     = require("luci.jsonc")
 local adbinput = uci.get("adblock", "global", "adb_rtfile") or "/tmp/adb_runtime.json"
 
-if not uci:get_first("adblock", "adblock", "adb_trigger") then
-       m = SimpleForm("error", nil, translate("Please update your adblock config file to use this package. ")
-       .. translatef("In OPKG use the '--force-maintainer' option to overwrite the pre-existing config file or download a fresh default config from "
+if not uci:get("adblock", "extra") then
+       m = SimpleForm("", nil, translate("Please update your adblock config file to use this package.<br />")
+       .. translatef("During opkg package installation use the '--force-maintainer' option to overwrite the pre-existing config file or download a fresh default config from "
        .. "<a href=\"%s\" target=\"_blank\">"
        .. "here</a>", "https://raw.githubusercontent.com/openwrt/packages/master/net/adblock/files/adblock.conf"))
        m.submit = false
@@ -23,16 +23,10 @@ m = Map("adblock", translate("Adblock"),
        translate("Configuration of the adblock package to block ad/abuse domains by using DNS. ")
        .. translatef("For further information "
        .. "<a href=\"%s\" target=\"_blank\">"
-       .. "see online documentation</a>", "https://github.com/openwrt/packages/blob/master/net/adblock/files/README.md"))
+       .. "check the online documentation</a>", "https://github.com/openwrt/packages/blob/master/net/adblock/files/README.md"))
 
 function m.on_after_commit(self)
-       function e4.validate(self, value)
-               if value == "0" then
-                       luci.sys.call("/etc/init.d/adblock reload >/dev/null 2>&1")
-               else
-                       luci.sys.call("/etc/init.d/adblock start >/dev/null 2>&1")
-               end
-       end
+       luci.sys.call("/etc/init.d/adblock reload >/dev/null 2>&1")
        luci.http.redirect(luci.dispatcher.build_url("admin", "services", "adblock"))
 end
 
@@ -44,7 +38,7 @@ local parse = json.parse(fs.readfile(adbinput) or "")
 if parse then
        status  = parse.data.adblock_status
        version = parse.data.adblock_version
-       domains = parse.data.blocked_domains
+       domains = parse.data.overall_domains
        fetch   = parse.data.fetch_utility
        backend = parse.data.dns_backend
        rundate = parse.data.last_rundate
@@ -80,35 +74,45 @@ end
 o2 = s:option(ListValue, "adb_dns", translate("DNS Backend (DNS Directory)"),
        translate("List of supported DNS backends with their default list export directory.<br />")
        .. translate("To overwrite the default path use the 'DNS Directory' option in the extra section below."))
-o2:value("dnsmasq", "dnsmasq (/tmp/dnsmasq.d)")
+o2:value("dnsmasq", "dnsmasq (/tmp)")
 o2:value("unbound", "unbound (/var/lib/unbound)")
-o2:value("named", "bind (/var/lib/bind)")
+o2:value("named", "named (/var/lib/bind)")
 o2:value("kresd", "kresd (/etc/kresd)")
 o2:value("dnscrypt-proxy","dnscrypt-proxy (/tmp)")
-o2.default = "dnsmasq"
+o2.default = "dnsmasq (/tmp)"
 o2.rmempty = false
 
-o3 = s:option(ListValue, "adb_trigger", translate("Startup Trigger"),
-       translate("List of available network interfaces. By default the startup will be triggered by the 'wan' interface.<br />")
+o3 = s:option(ListValue, "adb_fetchutil", translate("Download Utility"),
+translate("List of supported and fully pre-configured download utilities."))
+o3:value("uclient-fetch")
+o3:value("wget")
+o3:value("curl")
+o3:value("aria2c")
+o3:value("wget-nossl", "wget-nossl (noSSL)")
+o3:value("busybox", "wget-busybox (noSSL)")
+o3.default = "uclient-fetch"
+o3.rmempty = false
+
+o4 = s:option(ListValue, "adb_trigger", translate("Startup Trigger"),
+       translate("List of available network interfaces. Usually the startup will be triggered by the 'wan' interface.<br />")
        .. translate("Choose 'none' to disable automatic startups, 'timed' to use a classic timeout (default 30 sec.) or select another trigger interface."))
-o3:value("none")
-o3:value("timed")
+o4:value("none")
+o4:value("timed")
 if dump then
        local i, v
        for i, v in ipairs(dump.interface) do
                if v.interface ~= "loopback" then
-                       o3:value(v.interface)
+                       o4:value(v.interface)
                end
        end
 end
-o3.rmempty = false
+o4.rmempty = false
 
 -- Runtime information
 
-ds = s:option(DummyValue, "", translate("Runtime Information"))
-ds.template = "cbi/nullsection"
+ds = m:section(NamedSection, "global", "adblock", translate("Runtime Information"))
 
-dv1 = s:option(DummyValue, "", translate("Adblock Status"))
+dv1 = ds:option(DummyValue, "", translate("Adblock Status"))
 dv1.template = "adblock/runtime"
 if parse == nil then
        dv1.value = translate("n/a")
@@ -119,12 +123,14 @@ else
                dv1.value = translate("disabled")
        elseif status == "paused" then
                dv1.value = translate("paused")
+       elseif status == "running" then
+               dv1.value = translate("running")
        else
                dv1.value = translate("enabled")
        end
 end
 
-dv2 = s:option(DummyValue, "", translate("Adblock Version"))
+dv2 = ds:option(DummyValue, "", translate("Adblock Version"))
 dv2.template = "adblock/runtime"
 if parse == nil then
        dv2.value = translate("n/a")
@@ -132,8 +138,8 @@ else
        dv2.value = version
 end
 
-dv3 = s:option(DummyValue, "", translate("Download Utility (SSL Library)"),
-       translate("For SSL protected blocklist sources you need a suitable SSL library, e.g. 'libustream-ssl' or the wget 'built-in'."))
+dv3 = ds:option(DummyValue, "", translate("Download Utility (SSL Library)"),
+       translate("For SSL protected blocklist sources you need a suitable SSL library, e.g. 'libustream-ssl' or 'built-in'."))
 dv3.template = "adblock/runtime"
 if parse == nil then
        dv3.value = translate("n/a")
@@ -141,7 +147,7 @@ else
        dv3.value = fetch
 end
 
-dv4 = s:option(DummyValue, "", translate("DNS Backend (DNS Directory)"))
+dv4 = ds:option(DummyValue, "", translate("DNS Backend (DNS Directory)"))
 dv4.template = "adblock/runtime"
 if parse == nil then
        dv4.value = translate("n/a")
@@ -149,7 +155,7 @@ else
        dv4.value = backend
 end
 
-dv5 = s:option(DummyValue, "", translate("Overall Blocked Domains"))
+dv5 = ds:option(DummyValue, "", translate("Overall Domains"))
 dv5.template = "adblock/runtime"
 if parse == nil then
        dv5.value = translate("n/a")
@@ -157,7 +163,7 @@ else
        dv5.value = domains
 end
 
-dv6 = s:option(DummyValue, "", translate("Last Run"))
+dv6 = ds:option(DummyValue, "", translate("Last Run"))
 dv6.template = "adblock/runtime"
 if parse == nil then
        dv6.value = translate("n/a")
@@ -170,8 +176,8 @@ end
 bl = m:section(TypedSection, "source", translate("Blocklist Sources"),
        translate("Available blocklist sources. ")
        .. translate("List URLs and Shallalist category selections are configurable in the 'Advanced' section.<br />")
-       .. translate("Caution: Please don't select big lists or many lists at once on low memory devices to prevent OOM exceptions!"))
-bl.template = "cbi/tblsection"
+       .. translate("Caution: To prevent OOM exceptions on low memory devices with less than 64 MB free RAM, please do not select more than five blocklist sources!"))
+bl.template = "adblock/blocklist"
 
 name = bl:option(Flag, "enabled", translate("Enabled"))
 name.rmempty = false
@@ -185,12 +191,11 @@ function ssl.cfgvalue(self, section)
                return translate("No")
        end
 end
-
 des = bl:option(DummyValue, "adb_src_desc", translate("Description"))
 
 -- Extra options
 
-e = m:section(NamedSection, "global", "adblock", translate("Extra Options"),
+e = m:section(NamedSection, "extra", "adblock", translate("Extra Options"),
        translate("Options for further tweaking in case the defaults are not suitable for you."))
 
 e1 = e:option(Flag, "adb_debug", translate("Verbose Debug Logging"),
@@ -204,34 +209,73 @@ e2.default = e2.disabled
 e2.rmempty = false
 
 e3 = e:option(Flag, "adb_forcesrt", translate("Force Overall Sort"),
-       translate("Enable memory intense overall sort / duplicate removal on low memory devices (&lt; 64 MB RAM)"))
+       translate("Enable memory intense overall sort / duplicate removal on low memory devices (&lt; 64 MB free RAM)"))
 e3.default = e3.disabled
 e3.rmempty = false
 
-e4 = e:option(Flag, "adb_manmode", translate("Manual / Backup mode"),
-       translate("Do not automatically update blocklists during startup, use blocklist backups instead."))
+e4 = e:option(Flag, "adb_backup", translate("Enable Blocklist Backup"),
+       translate("Create compressed blocklist backups, they will be used in case of download errors or during startup in backup mode."))
 e4.default = e4.disabled
 e4.rmempty = false
 
-e5 = e:option(Flag, "adb_backup", translate("Enable Blocklist Backup"),
-       translate("Create compressed blocklist backups, they will be used in case of download errors or during startup in manual mode."))
-e5.default = e5.disabled
-e5.rmempty = false
-
-e6 = e:option(Value, "adb_backupdir", translate("Backup Directory"),
-       translate("Target directory for adblock backups. Please use only non-volatile disks, no ram/tmpfs drives."))
-e6.datatype = "directory"
-e6.default = "/mnt"
-e6.rmempty = false
+e5 = e:option(Value, "adb_backupdir", translate("Backup Directory"),
+       translate("Target directory for adblock backups. Please use only non-volatile disks, e.g. an external usb stick."))
+e5:depends("adb_backup", 1)
+e5.datatype = "directory"
+e5.default = "/mnt"
+e5.rmempty = true
 
-e7 = e:option(Value, "adb_dnsdir", translate("DNS Directory"),
+e6 = e:option(Flag, "adb_backup_mode", translate("Backup Mode"),
+       translate("Do not automatically update blocklists during startup, use blocklist backups instead."))
+e6:depends("adb_backup", 1)
+e6.default = e6.disabled
+e6.rmempty = true
+
+e7 = e:option(Value, "adb_maxqueue", translate("Max. Download Queue"),
+       translate("Size of the download queue to handle downloads &amp; list processing in parallel (default '4').<br />")
+       .. translate("For further performance improvements you can raise this value, e.g. '8' or '16' should be safe."))
+e7.default = 4
+e7.datatype = "range(1,32)"
+e7.rmempty = false
+
+e8 = e:option(Flag, "adb_jail", translate("'Jail' Blocklist Creation"),
+       translate("Builds an additional 'Jail' list (/tmp/adb_list.jail) to block access to all domains except those listed in the whitelist file.<br />")
+       .. translate("You can use this restrictive blocklist manually e.g. for guest wifi or kidsafe configurations."))
+e8.default = e8.disabled
+e8.rmempty = true
+
+e9 = e:option(Flag, "adb_dnsflush", translate("Flush DNS Cache"),
+       translate("Flush DNS Cache after adblock processing."))
+e9.default = e9.disabled
+e9.rmempty = true
+
+e10 = e:option(Flag, "adb_notify", translate("Email Notification"),
+       translate("Send notification emails in case of a processing error or if domain count is &le; 0.<br />")
+       .. translate("Please note: this needs additional 'msmtp' package installation and setup."))
+e10.default = e10.disabled
+e10.rmempty = true
+
+e11 = e:option(Value, "adb_notifycnt", translate("Email Notification Count"),
+       translate("Raise the minimum email notification count, to get emails if the overall count is less or equal to the given limit (default 0),<br />")
+       .. translate("e.g. to receive an email notification with every adblock update set this value to 150000."))
+e11.default = 0
+e11.datatype = "min(0)"
+e11.optional = true
+
+e12 = e:option(Value, "adb_dnsdir", translate("DNS Directory"),
        translate("Target directory for the generated blocklist 'adb_list.overall'."))
-e7.datatype = "directory"
-e7.optional = true
+e12.datatype = "directory"
+e12.optional = true
+
+e13 = e:option(Value, "adb_whitelist", translate("Whitelist File"),
+       translate("Full path to the whitelist file."))
+e13.datatype = "file"
+e13.default = "/etc/adblock/adblock.whitelist"
+e13.optional = true
 
-e8 = e:option(Value, "adb_triggerdelay", translate("Trigger Delay"),
+e14 = e:option(Value, "adb_triggerdelay", translate("Trigger Delay"),
        translate("Additional trigger delay in seconds before adblock processing begins."))
-e8.datatype = "range(1,60)"
-e8.optional = true
+e14.datatype = "range(1,60)"
+e14.optional = true
 
 return m