luci-app-adblock: User interface for the 'adblock' package

Simple user interface for the 'adblock' package from packages feed.
Adds 'Adblock' item to the Services menu in LuCI.
Allows enabling/disabling the service and selecting blocklists.

Configuration of the blocklist URLs and selection of Shalla categories
needs to be done manually to the config file, if needed.

Signed-off-by: Hannu Nyman <hannu.nyman@iki.fi>

4 files changed, 97 insertions, 0 deletions

diff --git a/applications/luci-app-adblock/Makefile b/applications/luci-app-adblock/Makefile
new file mode 100644
index 000000000..8efe2d604
--- /dev/null
+++ b/applications/luci-app-adblock/Makefile
@@ -0,0 +1,14 @@
+# Copyright (C) 2016 Openwrt.org
+#
+# This is free software, licensed under the Apache License, Version 2.0 .
+#
+
+include $(TOPDIR)/rules.mk
+
+LUCI_TITLE:=LuCI support for Adblock
+LUCI_DEPENDS:=+adblock
+LUCI_PKGARCH:=all
+
+include ../../luci.mk
+
+# call BuildPackage - OpenWrt buildroot signature
diff --git a/applications/luci-app-adblock/luasrc/controller/adblock.lua b/applications/luci-app-adblock/luasrc/controller/adblock.lua
new file mode 100644
index 000000000..d8b471814
--- /dev/null
+++ b/applications/luci-app-adblock/luasrc/controller/adblock.lua
@@ -0,0 +1,12 @@
+-- Copyright 2016 Openwrt.org
+-- Licensed to the public under the Apache License 2.0.
+
+module("luci.controller.adblock", package.seeall)
+
+function index()
+	if not nixio.fs.access("/etc/config/adblock") then
+		return
+	end
+
+	entry({"admin", "services", "adblock"}, cbi("adblock"), _("Adblock"), 40)
+end
diff --git a/applications/luci-app-adblock/luasrc/model/cbi/adblock.lua b/applications/luci-app-adblock/luasrc/model/cbi/adblock.lua
new file mode 100644
index 000000000..1fd77b4ab
--- /dev/null
+++ b/applications/luci-app-adblock/luasrc/model/cbi/adblock.lua
@@ -0,0 +1,60 @@
+-- Copyright 2016 Openwrt.org
+-- Licensed to the public under the Apache License 2.0.
+
+m = Map("adblock", translate("Adblock"),
+	translate("Configuration of the adblock package to block ad/abuse domains by using DNS."))
+
+-- General options
+
+s = m:section(NamedSection, "global", "adblock", translate("Global options"))
+
+o1 = s:option(Flag, "adb_enabled", translate("Enable"))
+o1.rmempty = false
+o1.default = 0
+
+o2 = s:option(Value, "adb_blacklist", translate("Blacklist file"),
+     translate("File with explicitly blacklisted hosts/domains."))
+o2.rmempty = false
+o2.datatype = "file"
+
+o3 = s:option(Value, "adb_whitelist", translate("Whitelist file"),
+     translate("File with whitelisted hosts/domains that are allowed despite being on a blocklist."))
+o3.rmempty = false
+o3.datatype = "file"
+
+s2 = m:section(NamedSection, "backup", "service", translate("Backup options"))
+
+o4 = s2:option(Flag, "enabled", translate("Enable blocklist backup"))
+o4.rmempty = false
+o4.default = 0
+
+o5 = s2:option(Value, "adb_backupdir", translate("Backup directory"))
+o5.rmempty = false
+o5.datatype = "directory"
+
+s3 = m:section(NamedSection, "debuglog", "service", translate("Debug log options"),
+	translate("Verbose log for debuging purposes."))
+
+o6 = s3:option(Flag, "enabled", translate("Enable debug log"))
+o6.rmempty = false
+o6.default = 0
+
+o7 = s3:option(Value, "adb_logfile", translate("Debug log file"))
+o7.rmempty = false
+o7.datatype = "string"
+
+-- Blocklist options
+
+s3 = m:section(TypedSection, "source", translate("Blocklist sources"),
+	translate("Available blocklist sources (")
+	.. [[<a href="https://github.com/openwrt/packages/blob/master/net/adblock/files/README.md#main-features" target="_blank">]]
+	.. translate("see list details")
+	.. [[</a>]]
+	.. translate("). Note that list URLs and Shallalist category selections are not configurable via Luci."))
+
+name = s3:option(Flag, "enabled", translate("Enabled"))
+name.rmempty  = false
+
+
+return m
+
diff --git a/applications/luci-app-adblock/root/etc/uci-defaults/40_luci-adblock b/applications/luci-app-adblock/root/etc/uci-defaults/40_luci-adblock
new file mode 100755
index 000000000..1f7fb1c0f
--- /dev/null
+++ b/applications/luci-app-adblock/root/etc/uci-defaults/40_luci-adblock
@@ -0,0 +1,11 @@
+#!/bin/sh
+
+uci -q batch <<-EOF >/dev/null
+	delete ucitrack.@adblock[-1]
+	add ucitrack adblock
+	set ucitrack.@adblock[-1].init=adblock
+	commit ucitrack
+EOF
+
+rm -f /tmp/luci-indexcache
+exit 0