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 m = Map("adblock", translate("Adblock"),
13 translate("Configuration of the adblock package to block ad/abuse domains by using DNS. ")
14 .. translatef("For further information "
15 .. "<a href=\"%s\" target=\"_blank\">"
16 .. "check the online documentation</a>", "https://github.com/openwrt/packages/blob/master/net/adblock/files/README.md"))
17 m.apply_on_parse = true
19 function m.on_apply(self)
20 luci.sys.call("/etc/init.d/adblock reload >/dev/null 2>&1")
21 luci.http.redirect(luci.dispatcher.build_url("admin", "services", "adblock"))
24 -- Main adblock options
26 s = m:section(NamedSection, "global", "adblock")
28 local parse = json.parse(fs.readfile(adbinput) or "")
30 status = parse.data.adblock_status
31 version = parse.data.adblock_version
32 domains = parse.data.overall_domains
33 fetch = parse.data.fetch_utility
34 backend = parse.data.dns_backend
35 rundate = parse.data.last_rundate
38 o1 = s:option(Flag, "adb_enabled", translate("Enable Adblock"))
39 o1.default = o1.disabled
42 btn = s:option(Button, "", translate("Suspend / Resume Adblock"))
43 if parse and status == "enabled" then
44 btn.inputtitle = translate("Suspend")
45 btn.inputstyle = "reset"
48 luci.sys.call("/etc/init.d/adblock suspend >/dev/null 2>&1")
49 luci.http.redirect(luci.dispatcher.build_url("admin", "services", "adblock"))
51 elseif parse and status == "paused" then
52 btn.inputtitle = translate("Resume")
53 btn.inputstyle = "apply"
56 luci.sys.call("/etc/init.d/adblock resume >/dev/null 2>&1")
57 luci.http.redirect(luci.dispatcher.build_url("admin", "services", "adblock"))
60 btn.inputtitle = translate("-------")
61 btn.inputstyle = "button"
65 o2 = s:option(ListValue, "adb_dns", translate("DNS Backend (DNS Directory)"),
66 translate("List of supported DNS backends with their default list export directory.<br />")
67 .. translate("To overwrite the default path use the 'DNS Directory' option in the extra section below."))
68 o2:value("dnsmasq", "dnsmasq (/tmp)")
69 o2:value("unbound", "unbound (/var/lib/unbound)")
70 o2:value("named", "named (/var/lib/bind)")
71 o2:value("kresd", "kresd (/etc/kresd)")
72 o2:value("dnscrypt-proxy","dnscrypt-proxy (/tmp)")
73 o2.default = "dnsmasq (/tmp)"
76 o3 = s:option(ListValue, "adb_fetchutil", translate("Download Utility"),
77 translate("List of supported and fully pre-configured download utilities."))
78 o3:value("uclient-fetch")
82 o3:value("wget-nossl", "wget-nossl (noSSL)")
83 o3:value("busybox", "wget-busybox (noSSL)")
84 o3.default = "uclient-fetch"
87 o4 = s:option(ListValue, "adb_trigger", translate("Startup Trigger"),
88 translate("List of available network interfaces. Usually the startup will be triggered by the 'wan' interface.<br />")
89 .. translate("Choose 'none' to disable automatic startups, 'timed' to use a classic timeout (default 30 sec.) or select another trigger interface."))
94 for i, v in ipairs(dump.interface) do
95 if v.interface ~= "loopback" then
102 -- Runtime information
104 ds = m:section(NamedSection, "global", "adblock", translate("Runtime Information"))
106 dv1 = ds:option(DummyValue, "", translate("Adblock Status"))
107 dv1.template = "adblock/runtime"
109 dv1.value = translate("n/a")
111 if status == "error" then
112 dv1.value = translate("error")
113 elseif status == "disabled" then
114 dv1.value = translate("disabled")
115 elseif status == "paused" then
116 dv1.value = translate("paused")
117 elseif status == "running" then
118 dv1.value = translate("running")
120 dv1.value = translate("enabled")
124 dv2 = ds:option(DummyValue, "", translate("Adblock Version"))
125 dv2.template = "adblock/runtime"
127 dv2.value = translate("n/a")
132 dv3 = ds:option(DummyValue, "", translate("Download Utility (SSL Library)"),
133 translate("For SSL protected blocklist sources you need a suitable SSL library, e.g. 'libustream-ssl' or 'built-in'."))
134 dv3.template = "adblock/runtime"
136 dv3.value = translate("n/a")
141 dv4 = ds:option(DummyValue, "", translate("DNS Backend (DNS Directory)"))
142 dv4.template = "adblock/runtime"
144 dv4.value = translate("n/a")
149 dv5 = ds:option(DummyValue, "", translate("Overall Domains"))
150 dv5.template = "adblock/runtime"
152 dv5.value = translate("n/a")
157 dv6 = ds:option(DummyValue, "", translate("Last Run"))
158 dv6.template = "adblock/runtime"
160 dv6.value = translate("n/a")
167 bl = m:section(TypedSection, "source", translate("Blocklist Sources"),
168 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!"))
169 bl.template = "adblock/blocklist"
171 name = bl:option(Flag, "enabled", translate("Enabled"))
174 ssl = bl:option(DummyValue, "adb_src", translate("SSL req."))
175 function ssl.cfgvalue(self, section)
176 local source = self.map:get(section, "adb_src")
177 if source and source:match("https://") then
178 return translate("Yes")
180 return translate("No")
184 des = bl:option(DummyValue, "adb_src_desc", translate("Description"))
186 cat = bl:option(DynamicList, "adb_src_cat", translate("Categories"))
187 cat.datatype = "uciname"
192 e = m:section(NamedSection, "extra", "adblock", translate("Extra Options"),
193 translate("Options for further tweaking in case the defaults are not suitable for you."))
195 e1 = e:option(Flag, "adb_debug", translate("Verbose Debug Logging"),
196 translate("Enable verbose debug logging in case of any processing error."))
197 e1.default = e1.disabled
200 e2 = e:option(Flag, "adb_forcedns", translate("Force Local DNS"),
201 translate("Redirect all DNS queries from 'lan' zone to the local resolver."))
202 e2.default = e2.disabled
205 e3 = e:option(Flag, "adb_forcesrt", translate("Force Overall Sort"),
206 translate("Enable memory intense overall sort / duplicate removal on low memory devices (< 64 MB free RAM)"))
207 e3.default = e3.disabled
210 e4 = e:option(Flag, "adb_backup", translate("Enable Blocklist Backup"),
211 translate("Create compressed blocklist backups, they will be used in case of download errors or during startup in backup mode."))
212 e4.default = e4.disabled
215 e5 = e:option(Value, "adb_backupdir", translate("Backup Directory"),
216 translate("Target directory for adblock backups. Please use only non-volatile disks, e.g. an external usb stick."))
217 e5:depends("adb_backup", 1)
218 e5.datatype = "directory"
222 e6 = e:option(Flag, "adb_backup_mode", translate("Backup Mode"),
223 translate("Do not automatically update blocklists during startup, use blocklist backups instead."))
224 e6:depends("adb_backup", 1)
225 e6.default = e6.disabled
228 e7 = e:option(Value, "adb_maxqueue", translate("Max. Download Queue"),
229 translate("Size of the download queue to handle downloads & list processing in parallel (default '4').<br />")
230 .. translate("For further performance improvements you can raise this value, e.g. '8' or '16' should be safe."))
232 e7.datatype = "range(1,32)"
235 e8 = e:option(Flag, "adb_jail", translate("'Jail' Blocklist Creation"),
236 translate("Builds an additional 'Jail' list (/tmp/adb_list.jail) to block access to all domains except those listed in the whitelist file.<br />")
237 .. translate("You can use this restrictive blocklist manually e.g. for guest wifi or kidsafe configurations."))
238 e8.default = e8.disabled
241 e9 = e:option(Flag, "adb_dnsflush", translate("Flush DNS Cache"),
242 translate("Flush DNS Cache after adblock processing."))
243 e9.default = e9.disabled
246 e10 = e:option(Flag, "adb_notify", translate("Email Notification"),
247 translate("Send notification emails in case of a processing error or if domain count is ≤ 0.<br />")
248 .. translate("Please note: this needs additional 'msmtp' package installation and setup."))
249 e10.default = e10.disabled
252 e11 = e:option(Value, "adb_notifycnt", translate("Email Notification Count"),
253 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 />")
254 .. translate("e.g. to receive an email notification with every adblock update set this value to 150000."))
256 e11.datatype = "min(0)"
259 e12 = e:option(Value, "adb_dnsdir", translate("DNS Directory"),
260 translate("Target directory for the generated blocklist 'adb_list.overall'."))
261 e12.datatype = "directory"
264 e13 = e:option(Value, "adb_whitelist", translate("Whitelist File"),
265 translate("Full path to the whitelist file."))
266 e13.datatype = "file"
267 e13.default = "/etc/adblock/adblock.whitelist"
270 e14 = e:option(Value, "adb_triggerdelay", translate("Trigger Delay"),
271 translate("Additional trigger delay in seconds before adblock processing begins."))
272 e14.datatype = "range(1,60)"