--- Copyright 2016 Hannu Nyman
-- Copyright 2017 Dirk Brenken (dev@brenken.org)
-- This is free software, licensed under the Apache License, Version 2.0
-local sys = require("luci.sys")
-local util = require("luci.util")
-local data = util.ubus("service", "get_data", "name", "adblock") or { }
-local dnsFile1 = sys.exec("find '/tmp/dnsmasq.d' -maxdepth 1 -type f -name 'adb_list*' -print 2>/dev/null")
-local dnsFile2 = sys.exec("find '/var/lib/unbound' -maxdepth 1 -type f -name 'adb_list*' -print 2>/dev/null")
+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_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 "
+ .. "<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
m = Map("adblock", translate("Adblock"),
translate("Configuration of the adblock package to block ad/abuse domains by using DNS. ")
- .. translate("For further information ")
- .. [[<a href="https://github.com/openwrt/packages/blob/master/net/adblock/files/README.md" target="_blank">]]
- .. translate("see online documentation")
- .. [[</a>]]
- .. translate("."))
+ .. 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"))
+
+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.http.redirect(luci.dispatcher.build_url("admin", "services", "adblock"))
+end
-- Main adblock options
s = m:section(NamedSection, "global", "adblock")
-o1 = s:option(Flag, "adb_enabled", translate("Enable 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.blocked_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
-o1.default = 0
-btn = s:option(Button, "", translate("Suspend / Resume adblock"))
-if data.adblock == nil then
- btn.inputtitle = "n/a"
- btn.inputstyle = nil
- btn.disabled = true
-elseif dnsFile1 ~= "" or dnsFile2 ~= "" then
- btn.inputtitle = translate("Suspend adblock")
+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
-else
- btn.inputtitle = translate("Resume adblock")
+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(Flag, "adb_debug", translate("Enable verbose debug logging"))
-o2.default = o2.disabled
+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("unbound", "unbound (/var/lib/unbound)")
+o2:value("named", "bind (/var/lib/bind)")
+o2:value("kresd", "kresd (/etc/kresd)")
+o2:value("dnscrypt-proxy","dnscrypt-proxy (/tmp)")
+o2.default = "dnsmasq"
o2.rmempty = false
-o3 = s:option(Value, "adb_iface", translate("Restrict interface reload trigger to certain interface(s)"),
- translate("Space separated list of interfaces that trigger a reload action. "..
- "To disable reload trigger at all remove all entries."))
-o3.rmempty =true
+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 />")
+ .. 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")
+if dump then
+ local i, v
+ for i, v in ipairs(dump.interface) do
+ if v.interface ~= "loopback" then
+ o3:value(v.interface)
+ end
+ end
+end
+o3.rmempty = false
-- Runtime information
- ds = s:option(DummyValue, "_dummy", translate("Runtime information"))
- ds.template = "cbi/nullsection"
+ds = s:option(DummyValue, "", translate("Runtime Information"))
+ds.template = "cbi/nullsection"
- dv1 = s:option(DummyValue, "adblock_version", translate("Adblock version"))
- dv1.template = "adblock/runtime"
- if data.adblock ~= nil then
- dv1.value = data.adblock.adblock.adblock_version or "n/a"
+dv1 = s: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 = "n/a"
+ dv1.value = translate("enabled")
end
+end
- dv2 = s:option(DummyValue, "status", translate("Status"))
- dv2.template = "adblock/runtime"
- if data.adblock == nil then
- dv2.value = "n/a"
- elseif dnsFile1 ~= "" or dnsFile2 ~= "" then
- dv2.value = "active"
- else
- dv2.value = "suspended"
- end
+dv2 = s:option(DummyValue, "", translate("Adblock Version"))
+dv2.template = "adblock/runtime"
+if parse == nil then
+ dv2.value = translate("n/a")
+else
+ dv2.value = version
+end
- dv3 = s:option(DummyValue, "dns_backend", translate("DNS backend"))
- dv3.template = "adblock/runtime"
- if data.adblock ~= nil then
- dv3.value = data.adblock.adblock.dns_backend or "n/a"
- else
- dv3.value = "n/a"
- 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.template = "adblock/runtime"
+if parse == nil then
+ dv3.value = translate("n/a")
+else
+ dv3.value = fetch
+end
- dv4 = s:option(DummyValue, "blocked_domains", translate("Blocked domains (overall)"))
- dv4.template = "adblock/runtime"
- if data.adblock ~= nil then
- dv4.value = data.adblock.adblock.blocked_domains or "n/a"
- else
- dv4.value = "n/a"
- end
+dv4 = s: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 = s:option(DummyValue, "last_rundate", translate("Last rundate"))
- dv5.template = "adblock/runtime"
- if data.adblock ~= nil then
- dv5.value = data.adblock.adblock.last_rundate or "n/a"
- else
- dv5.value = "n/a"
- end
+dv5 = s:option(DummyValue, "", translate("Overall Blocked Domains"))
+dv5.template = "adblock/runtime"
+if parse == nil then
+ dv5.value = translate("n/a")
+else
+ dv5.value = domains
+end
--- Blocklist options
+dv6 = s:option(DummyValue, "", translate("Last Run"))
+dv6.template = "adblock/runtime"
+if parse == nil then
+ dv6.value = translate("n/a")
+else
+ dv6.value = rundate
+end
+
+-- Blocklist table
-bl = m:section(TypedSection, "source", translate("Blocklist sources"),
+bl = m:section(TypedSection, "source", translate("Blocklist Sources"),
translate("Available blocklist sources. ")
- .. translate("Note that list URLs and Shallalist category selections are configurable in the 'Advanced' section."))
+ .. 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"
name = bl:option(Flag, "enabled", translate("Enabled"))
-name.rmempty = false
-
-des = bl:option(DummyValue, "adb_src_desc", translate("Description"))
-
--- Backup options
+name.rmempty = false
-s = m:section(NamedSection, "global", "adblock", translate("Backup options"))
+ssl = bl:option(DummyValue, "adb_src", translate("SSL req."))
+function ssl.cfgvalue(self, section)
+ local source = self.map:get(section, "adb_src")
+ if source and source:match("https://") then
+ return translate("Yes")
+ else
+ return translate("No")
+ end
+end
-o4 = s:option(Flag, "adb_backup", translate("Enable blocklist backup"))
-o4.rmempty = false
-o4.default = 0
+des = bl:option(DummyValue, "adb_src_desc", translate("Description"))
-o5 = s:option(Value, "adb_backupdir", translate("Backup directory"))
-o5.rmempty = false
-o5.datatype = "directory"
+-- Extra options
+
+e = m:section(NamedSection, "global", "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"),
+ 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.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 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.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
+
+e7 = e:option(Value, "adb_dnsdir", translate("DNS Directory"),
+ translate("Target directory for the generated blocklist 'adb_list.overall'."))
+e7.datatype = "directory"
+e7.optional = true
+
+e8 = 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
return m