--- Copyright 2017 Dirk Brenken (dev@brenken.org)
+-- Copyright 2017-2019 Dirk Brenken (dev@brenken.org)
-- This is free software, licensed under the Apache License, Version 2.0
-local fs = require("nixio.fs")
-local uci = require("luci.model.uci").cursor()
-local sys = require("luci.sys")
-local util = require("luci.util")
-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("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
- m.reset = false
- return m
-end
+local fs = require("nixio.fs")
+local uci = require("luci.model.uci").cursor()
+local util = require("luci.util")
+local net = require "luci.model.network".init()
+local dump = util.ubus("network.interface", "dump", {})
m = Map("adblock", translate("Adblock"),
translate("Configuration of the adblock package to block ad/abuse domains by using DNS. ")
- .. translatef("For further information "
+ ..translatef("For further information "
.. "<a href=\"%s\" target=\"_blank\">"
.. "check the online documentation</a>", "https://github.com/openwrt/packages/blob/master/net/adblock/files/README.md"))
-function m.on_after_commit(self)
- luci.sys.call("/etc/init.d/adblock reload >/dev/null 2>&1")
- luci.http.redirect(luci.dispatcher.build_url("admin", "services", "adblock"))
-end
-
-- Main adblock options
s = m:section(NamedSection, "global", "adblock")
-local parse = json.parse(fs.readfile(adbinput) or "")
-if parse then
- status = parse.data.adblock_status
- version = parse.data.adblock_version
- domains = parse.data.overall_domains
- fetch = parse.data.fetch_utility
- backend = parse.data.dns_backend
- rundate = parse.data.last_rundate
-end
-
o1 = s:option(Flag, "adb_enabled", translate("Enable Adblock"))
o1.default = o1.disabled
o1.rmempty = false
-btn = s:option(Button, "", translate("Suspend / Resume Adblock"))
-if parse and status == "enabled" then
- btn.inputtitle = translate("Suspend")
- btn.inputstyle = "reset"
- btn.disabled = false
- function btn.write()
- luci.sys.call("/etc/init.d/adblock suspend >/dev/null 2>&1")
- luci.http.redirect(luci.dispatcher.build_url("admin", "services", "adblock"))
- end
-elseif parse and status == "paused" then
- btn.inputtitle = translate("Resume")
- btn.inputstyle = "apply"
- btn.disabled = false
- function btn.write()
- luci.sys.call("/etc/init.d/adblock resume >/dev/null 2>&1")
- luci.http.redirect(luci.dispatcher.build_url("admin", "services", "adblock"))
- end
-else
- btn.inputtitle = translate("-------")
- btn.inputstyle = "button"
- btn.disabled = true
-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."))
+ translate("List of supported DNS backends with their default list export directory. ")
+ ..translate("To overwrite the default path use the 'DNS Directory' option in the extra section below."))
o2:value("dnsmasq", "dnsmasq (/tmp)")
o2:value("unbound", "unbound (/var/lib/unbound)")
o2:value("named", "named (/var/lib/bind)")
o2:value("kresd", "kresd (/etc/kresd)")
o2:value("dnscrypt-proxy","dnscrypt-proxy (/tmp)")
+o2.default = "dnsmasq (/tmp)"
o2.rmempty = false
-o3 = 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")
+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. ")
+ ..translate("Choose 'none' to disable automatic startups, 'timed' to use a classic timeout (default 30 sec.) or select another trigger interface."))
+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)
+ local device = v.l3_device or v.device or "-"
+ o4:value(v.interface, v.interface.. " (" ..device.. ")")
end
end
end
-o3.rmempty = false
+o4.rmempty = false
-- Runtime information
-ds = m:section(NamedSection, "global", "adblock", translate("Runtime Information"))
-
-dv1 = ds:option(DummyValue, "", translate("Adblock Status"))
-dv1.template = "adblock/runtime"
-if parse == nil then
- dv1.value = translate("n/a")
-else
- if status == "error" then
- dv1.value = translate("error")
- elseif status == "disabled" then
- dv1.value = translate("disabled")
- elseif status == "paused" then
- dv1.value = translate("paused")
- else
- dv1.value = translate("enabled")
- end
-end
-
-dv2 = ds:option(DummyValue, "", translate("Adblock Version"))
-dv2.template = "adblock/runtime"
-if parse == nil then
- dv2.value = translate("n/a")
-else
- dv2.value = version
-end
-
-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 the wget 'built-in'."))
-dv3.template = "adblock/runtime"
-if parse == nil then
- dv3.value = translate("n/a")
-else
- dv3.value = fetch
-end
-
-dv4 = ds:option(DummyValue, "", translate("DNS Backend (DNS Directory)"))
-dv4.template = "adblock/runtime"
-if parse == nil then
- dv4.value = translate("n/a")
-else
- dv4.value = backend
-end
-
-dv5 = ds:option(DummyValue, "", translate("Overall Domains"))
-dv5.template = "adblock/runtime"
-if parse == nil then
- dv5.value = translate("n/a")
-else
- dv5.value = domains
-end
-
-dv6 = ds:option(DummyValue, "", translate("Last Run"))
-dv6.template = "adblock/runtime"
-if parse == nil then
- dv6.value = translate("n/a")
-else
- dv6.value = rundate
-end
+ds = s:option(DummyValue, "_dummy")
+ds.template = "adblock/runtime"
-- Blocklist table
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: To prevent OOM exceptions on low memory devices with less than 64 MB free RAM, please do not select too many lists - 5-6 should be sufficient!"))
-bl.template = "cbi/tblsection"
+ translate("<b>Caution:</b> To prevent OOM exceptions on low memory devices with less than 64 MB free RAM, please only select a few of them!"))
+bl.template = "adblock/blocklist"
name = bl:option(Flag, "enabled", translate("Enabled"))
name.rmempty = false
return translate("No")
end
end
+
des = bl:option(DummyValue, "adb_src_desc", translate("Description"))
+cat = bl:option(DynamicList, "adb_src_cat", translate("Archive Categories"))
+cat.datatype = "uciname"
+cat.optional = true
+
-- Extra options
e = m:section(NamedSection, "extra", "adblock", translate("Extra Options"),
e1 = e:option(Flag, "adb_debug", translate("Verbose Debug Logging"),
translate("Enable verbose debug logging in case of any processing error."))
-e1.default = e1.disabled
e1.rmempty = false
-e2 = e:option(Flag, "adb_forcedns", translate("Force Local DNS"),
- translate("Redirect all DNS queries from 'lan' zone to the local resolver."))
-e2.default = e2.disabled
+e2 = e:option(Flag, "adb_nice", translate("Low Priority Service"),
+ translate("Set the nice level to 'low priority' and the adblock background processing will take less resources from the system. ")
+ ..translate("This change requires a manual service stop/re-start to take effect."))
+e2.disabled = "0"
+e2.enabled = "10"
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 (< 64 MB free RAM)"))
-e3.default = e3.disabled
+e3 = e:option(Flag, "adb_forcedns", translate("Force Local DNS"),
+ translate("Redirect all DNS queries from 'lan' zone to the local resolver, apply to udp and tcp protocol on ports 53, 853 and 5353."))
e3.rmempty = false
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(Value, "adb_backupdir", translate("Backup Directory"),
- translate("Target directory for adblock backups. Please use only non-volatile disks, e.g. an external usb stick."))
+ translate("Target directory for adblock backups. Please use only a non-volatile disk, e.g. an external usb stick."))
e5:depends("adb_backup", 1)
e5.datatype = "directory"
e5.default = "/mnt"
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(Flag, "adb_whitelist_mode", translate("Whitelist Mode"),
- translate("Block access to all domains except those explicitly listed in the whitelist file."))
-e7.default = e7.disabled
-e7.rmempty = true
+e7 = e:option(Value, "adb_maxqueue", translate("Max. Download Queue"),
+ translate("Size of the download queue to handle downloads & list processing in parallel (default '8'). ")
+ ..translate("For further performance improvements you can raise this value, e.g. '8' or '16' should be safe."))
+e7.default = 8
+e7.datatype = "range(1,32)"
+e7.rmempty = false
+
+e8 = e:option(Flag, "adb_report", translate("Enable DNS Query Report"),
+ translate("Gather dns related network traffic via tcpdump to provide a DNS Query Report on demand. ")
+ ..translate("Please note: this needs manual 'tcpdump-mini' package installation."))
+e8.rmempty = false
+
+e9 = e:option(Value, "adb_repdir", translate("Report Directory"),
+ translate("Target directory for dns related report files. Please use preferably a non-volatile disk, e.g. an external usb stick."))
+e9:depends("adb_report", 1)
+e9.datatype = "directory"
+e9.default = "/tmp"
+e9.rmempty = true
-e8 = e:option(Flag, "adb_dnsflush", translate("Flush DNS Cache"),
- translate("Flush DNS Cache after adblock processing."))
-e8.default = e8.disabled
-e8.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 ≤ 0. ")
+ .. translate("Please note: this needs manual 'msmtp' package installation and setup."))
+e10.rmempty = true
-e9 = e:option(Flag, "adb_notify", translate("Email Notification"),
- translate("Send notification emails in case of a processing error or if domain count is ≤ 0.<br />")
- .. translate("Please note: this needs additional 'mstmp' installation and setup (see readme)."))
-e9.default = e9.disabled
-e9.rmempty = true
+-- Optional Extra Options
+
+e20 = 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. ")
+ .. translate("You can use this restrictive blocklist e.g. for guest wifi or kidsafe configurations."))
+e20.optional = true
+e20.default = nil
-e10 = e:option(Value, "adb_notifycnt", translate("Email Notification Count"),
-translate("Raise minimum domain count email notification trigger, to get emails if the overall count is ≤ the given limit (default 0)."))
-e10.default = 0
-e10.datatype = "min(0)"
-e10.optional = true
+e21 = 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), ")
+ .. translate("e.g. to receive an email notification with every adblock update set this value to 150000."))
+e21.default = 0
+e21.datatype = "min(0)"
+e21.optional = true
-e11 = e:option(Value, "adb_dnsdir", translate("DNS Directory"),
+e22 = e:option(Value, "adb_dnsdir", translate("DNS Directory"),
translate("Target directory for the generated blocklist 'adb_list.overall'."))
-e11.datatype = "directory"
-e11.optional = true
+e22.datatype = "directory"
+e22.optional = true
-e12 = e:option(Value, "adb_whitelist", translate("Whitelist File"),
+e23 = e:option(Value, "adb_whitelist", translate("Whitelist File"),
translate("Full path to the whitelist file."))
-e12.datatype = "file"
-e12.default = "/etc/adblock/adblock.whitelist"
-e12.optional = true
+e23.datatype = "file"
+e23.default = "/etc/adblock/adblock.whitelist"
+e23.optional = true
-e13 = e:option(Value, "adb_triggerdelay", translate("Trigger Delay"),
+e24 = e:option(Value, "adb_triggerdelay", translate("Trigger Delay"),
translate("Additional trigger delay in seconds before adblock processing begins."))
-e13.datatype = "range(1,60)"
-e13.optional = true
+e24.datatype = "range(1,60)"
+e24.optional = true
+
+e25 = e:option(Flag, "adb_dnsflush", translate("Flush DNS Cache"),
+ translate("Flush DNS Cache after adblock processing."))
+e25.optional = true
+e25.default = nil
+
+e26 = e:option(ListValue, "adb_repiface", translate("Report Interface"),
+ translate("Reporting interface used by tcpdump, set to 'any' for multiple interfaces (default 'br-lan'). ")
+ ..translate("This change requires a manual service stop/re-start to take effect."))
+if dump then
+ local i, v
+ for i, v in ipairs(dump.interface) do
+ if v.interface ~= "loopback" then
+ local device = v.device
+ if device then
+ e26:value(device)
+ end
+ end
+ end
+end
+e26:value("any")
+e26.optional = true
+
+e27 = e:option(Value, "adb_replisten", translate("Report Listen Port(s)"),
+ translate("Space separated list of reporting port(s) used by tcpdump (default: '53'). ")
+ ..translate("This change requires a manual service stop/re-start to take effect."))
+e27.default = 53
+e27.optional = true
+
+e28 = e:option(Value, "adb_repchunkcnt", translate("Report Chunk Count"),
+ translate("Report chunk count used by tcpdump (default '5'). ")
+ ..translate("This change requires a manual service stop/re-start to take effect."))
+e28.datatype = "range(1,10)"
+e28.default = 5
+e28.optional = true
+
+e29 = e:option(Value, "adb_repchunksize", translate("Report Chunk Size"),
+ translate("Report chunk size used by tcpdump in MB (default '1'). ")
+ ..translate("This change requires a manual service stop/re-start to take effect."))
+e29.datatype = "range(1,10)"
+e29.default = 1
+e29.optional = true
return m
projects / project / luci.git / blobdiff