Merge pull request #1359 from dibdot/adblock

luci-app-adblock: sync with adblock 3.0.0

3 files changed, 115 insertions, 79 deletions

diff --git a/applications/luci-app-adblock/luasrc/controller/adblock.lua b/applications/luci-app-adblock/luasrc/controller/adblock.lua
index efa99b5b89..b74858400b 100644
--- a/applications/luci-app-adblock/luasrc/controller/adblock.lua
+++ b/applications/luci-app-adblock/luasrc/controller/adblock.lua
@@ -3,10 +3,10 @@
 
 module("luci.controller.adblock", package.seeall)
 
-local fs = require("nixio.fs")
-local util = require("luci.util")
+local fs    = require("nixio.fs")
+local util  = require("luci.util")
 local templ = require("luci.template")
-local i18n = require("luci.i18n")
+local i18n  = require("luci.i18n")
 
 function index()
 	if not nixio.fs.access("/etc/config/adblock") then
@@ -24,7 +24,13 @@ function index()
 end
 
 function logread()
-	local logfile = util.trim(util.exec("logread -e 'adblock'"))
+	local logfile
+
+	if nixio.fs.access("/var/log/messages") then
+		logfile = util.trim(util.exec("cat /var/log/messages | grep 'adblock'"))
+	else
+		logfile = util.trim(util.exec("logread -e 'adblock'"))
+	end
 	templ.render("adblock/logread", {title = i18n.translate("Adblock Logfile"), content = logfile})
 end
 
diff --git a/applications/luci-app-adblock/luasrc/model/cbi/adblock/overview_tab.lua b/applications/luci-app-adblock/luasrc/model/cbi/adblock/overview_tab.lua
index aa57014879..c64a5fb30d 100644
--- a/applications/luci-app-adblock/luasrc/model/cbi/adblock/overview_tab.lua
+++ b/applications/luci-app-adblock/luasrc/model/cbi/adblock/overview_tab.lua
@@ -1,32 +1,23 @@
 -- Copyright 2017 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("uci")
-local sys = require("luci.sys")
-local json = require("luci.jsonc")
+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"
-local dnspath = uci.get("adblock", "global", "adb_dnsdir") or ""
-local parse = json.parse(fs.readfile(adbinput) or "")
-if parse ~= nil then
-	version = parse.data.adblock_version
-	domains = parse.data.blocked_domains
-	fetch = parse.data.fetch_info
-	backend = parse.data.dns_backend
-	rundate = parse.data.last_rundate
-	if dnspath == "" then
-		if backend == "dnsmasq" then
-			dnspath = "/tmp/dnsmasq.d"
-		elseif backend == "unbound" then
-			dnspath = "/var/lib/unbound"
-		elseif backend == "named" then
-			dnspath = "/var/lib/bind"
-		elseif backend == "kresd" then
-			dnspath = "/tmp/kresd"
-		end
-	end
+
+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
-local dnsfile = dnspath .. "/.adb_hidden/adb_list.overall"
 
 m = Map("adblock", translate("Adblock"),
 	translate("Configuration of the adblock package to block ad/abuse domains by using DNS. ")
@@ -35,7 +26,7 @@ m = Map("adblock", translate("Adblock"),
 	.. "see online documentation</a>", "https://github.com/openwrt/packages/blob/master/net/adblock/files/README.md"))
 
 function m.on_after_commit(self)
-	function e3.validate(self, value)
+	function e4.validate(self, value)
 		if value == "0" then
 			luci.sys.call("/etc/init.d/adblock reload >/dev/null 2>&1")
 		else
@@ -49,62 +40,83 @@ end
 
 s = m:section(NamedSection, "global", "adblock")
 
-o1 = s:option(Flag, "adb_enabled", translate("Enable adblock"))
-o1.default = o1.enabled
+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
 
-btn = s:option(Button, "", translate("Suspend / Resume adblock"))
-if parse ~= nil and nixio.fs.access(dnsfile) then
-	btn.inputtitle = translate("Resume adblock")
-	btn.inputstyle = "apply"
+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 resume >/dev/null 2>&1")
+		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("Suspend adblock")
-	btn.inputstyle = "reset"
+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 suspend >/dev/null 2>&1")
+		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(Value, "adb_iface", translate("Restrict interface trigger to certain interface(s)"),
-	translate("Space separated list of interfaces that trigger adblock processing. "..
-	"To disable event driven (re-)starts remove all entries."))
-o2.rmempty = true
-
-o3 = s:option(Value, "adb_triggerdelay", translate("Trigger delay"),
-	translate("Additional trigger delay in seconds before adblock processing begins."))
-o3.default = 2
-o3.datatype = "range(1,90)"
+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(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
 
-o4 = s:option(Flag, "adb_debug", translate("Enable verbose debug logging"))
-o4.default = o4.disabled
-o4.rmempty = false
-
 -- Runtime information
 
-ds = s:option(DummyValue, "_dummy", translate("Runtime information"))
+ds = s:option(DummyValue, "", translate("Runtime Information"))
 ds.template = "cbi/nullsection"
 
-dv1 = s:option(DummyValue, "status", translate("Status"))
+dv1 = s:option(DummyValue, "", translate("Adblock Status"))
 dv1.template = "adblock/runtime"
 if parse == nil then
 	dv1.value = translate("n/a")
-elseif domains == "0" then
-	dv1.value = translate("no domains blocked")
-elseif nixio.fs.access(dnsfile) then
-	dv1.value = translate("suspended")
 else
-	dv1.value = translate("active")
+	dv1.value = translate(status)
 end
 
-dv2 = s:option(DummyValue, "adblock_version", translate("Adblock version"))
+dv2 = s:option(DummyValue, "", translate("Adblock Version"))
 dv2.template = "adblock/runtime"
 if parse == nil then
 	dv2.value = translate("n/a")
@@ -112,7 +124,7 @@ else
 	dv2.value = version
 end
 
-dv3 = s:option(DummyValue, "fetch_info", translate("Download Utility (SSL Library)"),
+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
@@ -121,7 +133,7 @@ else
 	dv3.value = fetch
 end
 
-dv4 = s:option(DummyValue, "dns_backend", translate("DNS backend"))
+dv4 = s:option(DummyValue, "", translate("DNS Backend (DNS Directory)"))
 dv4.template = "adblock/runtime"
 if parse == nil then
 	dv4.value = translate("n/a")
@@ -129,7 +141,7 @@ else
 	dv4.value = backend
 end
 
-dv5 = s:option(DummyValue, "blocked_domains", translate("Blocked domains (overall)"))
+dv5 = s:option(DummyValue, "", translate("Overall Blocked Domains"))
 dv5.template = "adblock/runtime"
 if parse == nil then
 	dv5.value = translate("n/a")
@@ -137,7 +149,7 @@ else
 	dv5.value = domains
 end
 
-dv6 = s:option(DummyValue, "last_rundate", translate("Last rundate"))
+dv6 = s:option(DummyValue, "", translate("Last Run"))
 dv6.template = "adblock/runtime"
 if parse == nil then
 	dv6.value = translate("n/a")
@@ -147,9 +159,10 @@ 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"))
@@ -169,31 +182,48 @@ des = bl:option(DummyValue, "adb_src_desc", translate("Description"))
 
 -- Extra options
 
-e = m:section(NamedSection, "global", "adblock", translate("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_forcedns", translate("Force local DNS"),
-	translate("Redirect all DNS queries to the local resolver."))
+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_forcesrt", translate("Force Overall Sort"),
-	translate("Enable memory intense overall sort / duplicate removal on low memory devices (&lt; 64 MB RAM)"))
+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_manmode", translate("Manual / Backup mode"),
-	translate("Do not automatically update blocklists during startup, use blocklist backups instead."))
+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)"))
 e3.default = e3.disabled
 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 manual mode."))
+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(Value, "adb_backupdir", translate("Backup directory"))
-e5.datatype = "directory"
+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
diff --git a/applications/luci-app-adblock/luasrc/view/adblock/runtime.htm b/applications/luci-app-adblock/luasrc/view/adblock/runtime.htm
index ee3a4553a8..0221a75ed1 100644
--- a/applications/luci-app-adblock/luasrc/view/adblock/runtime.htm
+++ b/applications/luci-app-adblock/luasrc/view/adblock/runtime.htm
@@ -5,6 +5,6 @@ This is free software, licensed under the Apache License, Version 2.0
 
 <%+cbi/valueheader%>
 
-<input name="runtime" id="runtime" type="text" class="cbi-input-text" style="border: none; box-shadow: none; background-color: #ffffff; color: #0069d6;" value="<%=self:cfgvalue(section)%>" disabled="disabled" />
+<input name="runtime" id="runtime" type="text" class="cbi-input-text" style="border:none;box-shadow:none;background:transparent;color:#0069d6;" value="<%=self:cfgvalue(section)%>" disabled="disabled" />
 
 <%+cbi/valuefooter%>