1 -- Copyright 2017-2018 Dirk Brenken (dev@brenken.org)
2 -- This is free software, licensed under the Apache License, Version 2.0
4 local fs = require("nixio.fs")
5 local uci = require("luci.model.uci").cursor()
6 local sys = require("luci.sys")
7 local util = require("luci.util")
8 local dump = util.ubus("network.interface", "dump", {})
9 local json = require("luci.jsonc")
10 local adbinput = uci.get("adblock", "global", "adb_rtfile") or "/tmp/adb_runtime.json"
12 if not uci:get("adblock", "extra") then
13 m = SimpleForm("", nil, translate("Please update your adblock config file to use this package.<br />")
14 .. translatef("During opkg package installation use the '--force-maintainer' option to overwrite the pre-existing config file or download a fresh default config from "
15 .. "<a href=\"%s\" target=\"_blank\">"
16 .. "here</a>", "https://raw.githubusercontent.com/openwrt/packages/master/net/adblock/files/adblock.conf"))
22 m = Map("adblock", translate("Adblock"),
23 translate("Configuration of the adblock package to block ad/abuse domains by using DNS. ")
24 .. translatef("For further information "
25 .. "<a href=\"%s\" target=\"_blank\">"
26 .. "check the online documentation</a>", "https://github.com/openwrt/packages/blob/master/net/adblock/files/README.md"))
28 function m.on_after_commit(self)
29 luci.sys.call("/etc/init.d/adblock reload >/dev/null 2>&1")
30 luci.http.redirect(luci.dispatcher.build_url("admin", "services", "adblock"))
33 -- Main adblock options
35 s = m:section(NamedSection, "global", "adblock")
37 local parse = json.parse(fs.readfile(adbinput) or "")
39 status = parse.data.adblock_status
40 version = parse.data.adblock_version
41 domains = parse.data.overall_domains
42 fetch = parse.data.fetch_utility
43 backend = parse.data.dns_backend
44 rundate = parse.data.last_rundate
47 o1 = s:option(Flag, "adb_enabled", translate("Enable Adblock"))
48 o1.default = o1.disabled
51 btn = s:option(Button, "", translate("Suspend / Resume Adblock"))
52 if parse and status == "enabled" then
53 btn.inputtitle = translate("Suspend")
54 btn.inputstyle = "reset"
57 luci.sys.call("/etc/init.d/adblock suspend >/dev/null 2>&1")
58 luci.http.redirect(luci.dispatcher.build_url("admin", "services", "adblock"))
60 elseif parse and status == "paused" then
61 btn.inputtitle = translate("Resume")
62 btn.inputstyle = "apply"
65 luci.sys.call("/etc/init.d/adblock resume >/dev/null 2>&1")
66 luci.http.redirect(luci.dispatcher.build_url("admin", "services", "adblock"))
69 btn.inputtitle = translate("-------")
70 btn.inputstyle = "button"
74 o2 = s:option(ListValue, "adb_dns", translate("DNS Backend (DNS Directory)"),
75 translate("List of supported DNS backends with their default list export directory.<br />")
76 .. translate("To overwrite the default path use the 'DNS Directory' option in the extra section below."))
77 o2:value("dnsmasq", "dnsmasq (/tmp)")
78 o2:value("unbound", "unbound (/var/lib/unbound)")
79 o2:value("named", "named (/var/lib/bind)")
80 o2:value("kresd", "kresd (/etc/kresd)")
81 o2:value("dnscrypt-proxy","dnscrypt-proxy (/tmp)")
84 o3 = s:option(ListValue, "adb_trigger", translate("Startup Trigger"),
85 translate("List of available network interfaces. Usually the startup will be triggered by the 'wan' interface.<br />")
86 .. translate("Choose 'none' to disable automatic startups, 'timed' to use a classic timeout (default 30 sec.) or select another trigger interface."))
91 for i, v in ipairs(dump.interface) do
92 if v.interface ~= "loopback" then
99 -- Runtime information
101 ds = m:section(NamedSection, "global", "adblock", translate("Runtime Information"))
103 dv1 = ds:option(DummyValue, "", translate("Adblock Status"))
104 dv1.template = "adblock/runtime"
106 dv1.value = translate("n/a")
108 if status == "error" then
109 dv1.value = translate("error")
110 elseif status == "disabled" then
111 dv1.value = translate("disabled")
112 elseif status == "paused" then
113 dv1.value = translate("paused")
115 dv1.value = translate("enabled")
119 dv2 = ds:option(DummyValue, "", translate("Adblock Version"))
120 dv2.template = "adblock/runtime"
122 dv2.value = translate("n/a")
127 dv3 = ds:option(DummyValue, "", translate("Download Utility (SSL Library)"),
128 translate("For SSL protected blocklist sources you need a suitable SSL library, e.g. 'libustream-ssl' or the wget 'built-in'."))
129 dv3.template = "adblock/runtime"
131 dv3.value = translate("n/a")
136 dv4 = ds:option(DummyValue, "", translate("DNS Backend (DNS Directory)"))
137 dv4.template = "adblock/runtime"
139 dv4.value = translate("n/a")
144 dv5 = ds:option(DummyValue, "", translate("Overall Domains"))
145 dv5.template = "adblock/runtime"
147 dv5.value = translate("n/a")
152 dv6 = ds:option(DummyValue, "", translate("Last Run"))
153 dv6.template = "adblock/runtime"
155 dv6.value = translate("n/a")
162 bl = m:section(TypedSection, "source", translate("Blocklist Sources"),
163 translate("Available blocklist sources. ")
164 .. translate("List URLs and Shallalist category selections are configurable in the 'Advanced' section.<br />")
165 .. 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!"))
166 bl.template = "adblock/blocklist"
168 name = bl:option(Flag, "enabled", translate("Enabled"))
171 ssl = bl:option(DummyValue, "adb_src", translate("SSL req."))
172 function ssl.cfgvalue(self, section)
173 local source = self.map:get(section, "adb_src")
174 if source and source:match("https://") then
175 return translate("Yes")
177 return translate("No")
180 des = bl:option(DummyValue, "adb_src_desc", translate("Description"))
184 e = m:section(NamedSection, "extra", "adblock", translate("Extra Options"),
185 translate("Options for further tweaking in case the defaults are not suitable for you."))
187 e1 = e:option(Flag, "adb_debug", translate("Verbose Debug Logging"),
188 translate("Enable verbose debug logging in case of any processing error."))
189 e1.default = e1.disabled
192 e2 = e:option(Flag, "adb_forcedns", translate("Force Local DNS"),
193 translate("Redirect all DNS queries from 'lan' zone to the local resolver."))
194 e2.default = e2.disabled
197 e3 = e:option(Flag, "adb_forcesrt", translate("Force Overall Sort"),
198 translate("Enable memory intense overall sort / duplicate removal on low memory devices (< 64 MB free RAM)"))
199 e3.default = e3.disabled
202 e4 = e:option(Flag, "adb_backup", translate("Enable Blocklist Backup"),
203 translate("Create compressed blocklist backups, they will be used in case of download errors or during startup in backup mode."))
204 e4.default = e4.disabled
207 e5 = e:option(Value, "adb_backupdir", translate("Backup Directory"),
208 translate("Target directory for adblock backups. Please use only non-volatile disks, e.g. an external usb stick."))
209 e5:depends("adb_backup", 1)
210 e5.datatype = "directory"
214 e6 = e:option(Flag, "adb_backup_mode", translate("Backup Mode"),
215 translate("Do not automatically update blocklists during startup, use blocklist backups instead."))
216 e6:depends("adb_backup", 1)
217 e6.default = e6.disabled
220 e7 = e:option(Flag, "adb_whitelist_mode", translate("Whitelist Mode"),
221 translate("Block access to all domains except those explicitly listed in the whitelist file."))
222 e7.default = e7.disabled
225 e8 = e:option(Flag, "adb_dnsflush", translate("Flush DNS Cache"),
226 translate("Flush DNS Cache after adblock processing."))
227 e8.default = e8.disabled
230 e9 = e:option(Flag, "adb_notify", translate("Email Notification"),
231 translate("Send notification emails in case of a processing error or if domain count is ≤ 0.<br />")
232 .. translate("Please note: this needs additional 'mstmp' installation and setup (see readme)."))
233 e9.default = e9.disabled
236 e10 = e:option(Value, "adb_notifycnt", translate("Email Notification Count"),
237 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 />")
238 .. translate("e.g. to receive an email notification with every adblock update set this value to 150000."))
240 e10.datatype = "min(0)"
243 e11 = e:option(Value, "adb_dnsdir", translate("DNS Directory"),
244 translate("Target directory for the generated blocklist 'adb_list.overall'."))
245 e11.datatype = "directory"
248 e12 = e:option(Value, "adb_whitelist", translate("Whitelist File"),
249 translate("Full path to the whitelist file."))
250 e12.datatype = "file"
251 e12.default = "/etc/adblock/adblock.whitelist"
254 e13 = e:option(Value, "adb_triggerdelay", translate("Trigger Delay"),
255 translate("Additional trigger delay in seconds before adblock processing begins."))
256 e13.datatype = "range(1,60)"