From bf97f35db51efef6bd63c8dbfc3b4e90ede0122b Mon Sep 17 00:00:00 2001 From: Dirk Brenken Date: Fri, 19 Jan 2018 10:30:42 +0100 Subject: [17.01] luci-app-adblock: release 3.4.3 * bump adblock version in stable tree Signed-off-by: Dirk Brenken --- .../luasrc/model/cbi/adblock/blacklist_tab.lua | 15 +- .../luasrc/model/cbi/adblock/configuration_tab.lua | 3 + .../luasrc/model/cbi/adblock/overview_tab.lua | 261 +++++++++++++++------ .../luasrc/model/cbi/adblock/whitelist_tab.lua | 12 + 4 files changed, 214 insertions(+), 77 deletions(-) (limited to 'applications/luci-app-adblock/luasrc/model') diff --git a/applications/luci-app-adblock/luasrc/model/cbi/adblock/blacklist_tab.lua b/applications/luci-app-adblock/luasrc/model/cbi/adblock/blacklist_tab.lua index d540c77d10..ef70100e4f 100644 --- a/applications/luci-app-adblock/luasrc/model/cbi/adblock/blacklist_tab.lua +++ b/applications/luci-app-adblock/luasrc/model/cbi/adblock/blacklist_tab.lua @@ -7,12 +7,25 @@ local uci = require("uci") local adbinput = uci.get("adblock", "blacklist", "adb_src" or "/etc/adblock/adblock.blacklist") if not nixio.fs.access(adbinput) then - m = SimpleForm("error", nil, translate("Input file not found, please check your configuration.")) + m = SimpleForm("error", nil, + translate("Input file not found, please check your configuration.")) + m.reset = false + m.submit = false + return m +end + +if nixio.fs.stat(adbinput).size > 524288 then + m = SimpleForm("error", nil, + translate("The file size is too large for online editing in LuCI (> 512 KB). ") + .. translate("Please edit this file directly in a terminal session.")) + m.reset = false + m.submit = false return m end m = SimpleForm("input", nil) m:append(Template("adblock/config_css")) +m.submit = translate("Save") m.reset = false s = m:section(SimpleSection, nil, diff --git a/applications/luci-app-adblock/luasrc/model/cbi/adblock/configuration_tab.lua b/applications/luci-app-adblock/luasrc/model/cbi/adblock/configuration_tab.lua index 1b83c949e1..1d89485e79 100644 --- a/applications/luci-app-adblock/luasrc/model/cbi/adblock/configuration_tab.lua +++ b/applications/luci-app-adblock/luasrc/model/cbi/adblock/configuration_tab.lua @@ -7,11 +7,14 @@ local adbinput = "/etc/config/adblock" if not nixio.fs.access(adbinput) then m = SimpleForm("error", nil, translate("Input file not found, please check your configuration.")) + m.reset = false + m.submit = false return m end m = SimpleForm("input", nil) m:append(Template("adblock/config_css")) +m.submit = translate("Save") m.reset = false s = m:section(SimpleSection, nil, 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 d2740f4daf..476d8ece6c 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,127 +1,183 @@ --- 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") -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 parse = json.parse(fs.readfile(adbinput) or "") -local dnsFile1 = sys.exec("find '/tmp/dnsmasq.d/.adb_hidden' -maxdepth 1 -type f -name 'adb_list*' -print 2>/dev/null") -local dnsFile2 = sys.exec("find '/var/lib/unbound/.adb_hidden' -maxdepth 1 -type f -name 'adb_list*' -print 2>/dev/null") + +if not uci:get("adblock", "extra") then + m = SimpleForm("", nil, translate("Please update your adblock config file to use this package.
") + .. translatef("During opkg package installation use the '--force-maintainer' option to overwrite the pre-existing config file or download a fresh default config from " + .. "" + .. "here", "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 ") - .. [[]] - .. translate("see online documentation") - .. [[]] - .. translate(".")) -m.reset = false + .. translatef("For further information " + .. "" + .. "check the online documentation", "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") -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.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 dnsFile1 ~= "" or dnsFile2 ~= "" 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 +o2 = s:option(ListValue, "adb_dns", translate("DNS Backend (DNS Directory)"), + 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(Value, "adb_triggerdelay", translate("Trigger delay"), - translate("Additional trigger delay in seconds before adblock processing begins.")) -o3.default = 2 -o3.datatype = "range(1,90)" +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(Flag, "adb_debug", translate("Enable verbose debug logging")) -o4.default = o4.disabled +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 + o4:value(v.interface) + end + end +end o4.rmempty = false -- Runtime information -ds = s:option(DummyValue, "_dummy", translate("Runtime information")) -ds.template = "cbi/nullsection" +ds = m:section(NamedSection, "global", "adblock", translate("Runtime Information")) -dv1 = s:option(DummyValue, "status", translate("Status")) +dv1 = ds:option(DummyValue, "", translate("Adblock Status")) dv1.template = "adblock/runtime" if parse == nil then dv1.value = translate("n/a") -elseif parse.data.blocked_domains == "0" then - dv1.value = translate("no domains blocked") -elseif dnsFile1 ~= "" or dnsFile2 ~= "" then - dv1.value = translate("suspended") else - dv1.value = translate("active") + if status == "error" then + dv1.value = translate("error") + elseif status == "disabled" then + 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, "adblock_version", translate("Adblock version")) + +dv2 = ds:option(DummyValue, "", translate("Adblock Version")) dv2.template = "adblock/runtime" -if parse ~= nil then - dv2.value = parse.data.adblock_version or translate("n/a") -else +if parse == nil then dv2.value = translate("n/a") +else + dv2.value = version end -dv3 = s:option(DummyValue, "fetch_info", 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 = parse.data.fetch_info or translate("n/a") -else +if parse == nil then dv3.value = translate("n/a") +else + dv3.value = fetch end -dv4 = s:option(DummyValue, "dns_backend", translate("DNS backend")) +dv4 = ds:option(DummyValue, "", translate("DNS Backend (DNS Directory)")) dv4.template = "adblock/runtime" -if parse ~= nil then - dv4.value = parse.data.dns_backend or translate("n/a") -else +if parse == nil then dv4.value = translate("n/a") +else + dv4.value = backend end -dv5 = s:option(DummyValue, "blocked_domains", translate("Blocked domains (overall)")) +dv5 = ds:option(DummyValue, "", translate("Overall Domains")) dv5.template = "adblock/runtime" -if parse ~= nil then - dv5.value = parse.data.blocked_domains or translate("n/a") -else +if parse == nil then dv5.value = translate("n/a") +else + dv5.value = domains end -dv6 = s:option(DummyValue, "last_rundate", translate("Last rundate")) +dv6 = ds:option(DummyValue, "", translate("Last Run")) dv6.template = "adblock/runtime" -if parse ~= nil then - dv6.value = parse.data.last_rundate or translate("n/a") -else +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.")) -bl.template = "cbi/tblsection" + .. translate("List URLs and Shallalist category selections are configurable in the 'Advanced' section.
") + .. 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 @@ -135,30 +191,83 @@ 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_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 (< 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_backup", translate("Enable blocklist backup")) +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.rmempty = false -e4 = e:option(Value, "adb_backupdir", translate("Backup directory")) -e4.datatype = "directory" +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.")) +e5:depends("adb_backup", 1) +e5.datatype = "directory" +e5.default = "/mnt" +e5.rmempty = true + +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 + +e8 = e:option(Flag, "adb_dnsflush", translate("Flush DNS Cache"), + translate("Flush DNS Cache after adblock processing.")) +e8.default = e8.disabled +e8.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.
") + .. translate("Please note: this needs additional 'mstmp' installation and setup (see readme).")) +e9.default = e9.disabled +e9.rmempty = true + +e10 = 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.")) +e10.default = 0 +e10.datatype = "min(0)" +e10.optional = true + +e11 = e:option(Value, "adb_dnsdir", translate("DNS Directory"), + translate("Target directory for the generated blocklist 'adb_list.overall'.")) +e11.datatype = "directory" +e11.optional = true + +e12 = 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 + +e13 = 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 + return m diff --git a/applications/luci-app-adblock/luasrc/model/cbi/adblock/whitelist_tab.lua b/applications/luci-app-adblock/luasrc/model/cbi/adblock/whitelist_tab.lua index 23c99a9778..a3659eb469 100644 --- a/applications/luci-app-adblock/luasrc/model/cbi/adblock/whitelist_tab.lua +++ b/applications/luci-app-adblock/luasrc/model/cbi/adblock/whitelist_tab.lua @@ -8,11 +8,23 @@ local adbinput = uci.get("adblock", "global", "adb_whitelist") or "/etc/adblock/ if not nixio.fs.access(adbinput) then m = SimpleForm("error", nil, translate("Input file not found, please check your configuration.")) + m.reset = false + m.submit = false + return m +end + +if nixio.fs.stat(adbinput).size > 524288 then + m = SimpleForm("error", nil, + translate("The file size is too large for online editing in LuCI (> 512 KB). ") + .. translate("Please edit this file directly in a terminal session.")) + m.reset = false + m.submit = false return m end m = SimpleForm("input", nil) m:append(Template("adblock/config_css")) +m.submit = translate("Save") m.reset = false s = m:section(SimpleSection, nil, -- cgit v1.2.3