2 # function library used by adblock-update.sh
3 # written by Dirk Brenken (dev@brenken.org)
5 # f_envload: load adblock environment
9 # source in system function library
11 if [ -r "/lib/functions.sh" ]
16 f_log
"system function library not found" "${rc}"
20 # source in system network library
22 if [ -r "/lib/functions/network.sh" ]
24 .
"/lib/functions/network.sh"
27 f_log
"system network library not found" "${rc}"
31 # set initial defaults,
32 # may be overwritten by setting appropriate adblock config options in global section of /etc/config/adblock
36 adb_nullipv4
="192.0.2.1"
37 adb_nullipv6
="::ffff:c000:0201"
38 adb_whitelist
="/etc/adblock/adblock.whitelist"
39 adb_whitelist_rset
="\$1 ~/^([A-Za-z0-9_-]+\.){1,}[A-Za-z]+/{print tolower(\$1)}"
42 # function to parse global section by callback
47 if [ "${type}" = "adblock" ]
53 eval "${option}=\"${value}\""
60 # function to parse 'service' and 'source' sections
64 local value opt section
="${1}" options
="adb_dir adb_src adb_src_rset adb_src_cat"
65 config_get switch
"${section}" "enabled"
66 if [ "${switch}" = "1" ]
68 if [ "${section}" != "backup" ]
70 eval "adb_sources=\"${adb_sources} ${section}\""
74 config_get value
"${section}" "${opt}"
77 eval "${opt}_${section}=\"${value}\""
83 # check opkg availability
85 if [ -r "/var/lock/opkg.lock" ]
88 f_log
"adblock installation finished successfully, 'opkg' currently locked by package installer"
92 # get list with all installed packages
94 pkg_list
="$(opkg list-installed)"
95 if [ -z "${pkg_list}" ]
98 f_log
"empty package list" "${rc}"
102 # load adblock config and start parsing functions
105 config_foreach parse_config service
106 config_foreach parse_config
source
108 # set more script defaults (can't be overwritten by adblock config options)
111 adb_tmpfile
="$(mktemp -tu)"
112 adb_tmpdir
="$(mktemp -p /tmp -d)"
113 adb_dnsdir
="/tmp/dnsmasq.d"
114 adb_dnsprefix
="adb_list"
115 adb_uci
="$(which uci)"
116 adb_iptv4
="$(which iptables)"
117 adb_iptv6
="$(which ip6tables)"
118 adb_fetch
="$(which wget-ssl)"
119 unset adb_srclist adb_revsrclist adb_errsrclist
121 # check 'enabled' & 'version' config options
123 if [ -z "${adb_enabled}" ] || [ -z "${adb_cfgversion}" ] || [ "${adb_cfgversion}" != "${adb_scriptver%.*}" ]
126 f_log
"outdated adblock configuration found, please copy latest version from '/etc/adblock/adblock.conf.default' to '/etc/config/adblock'"
129 if [ $
((adb_enabled
)) -ne 1 ]
132 f_log
"adblock is currently disabled, please set adblock.global.adb_enabled=1' to use this service"
136 # check running dnsmasq instance
138 rc
="$(ps | grep -q "[d
]nsmasq
"; printf ${?})"
142 f_log
"please enable the local dnsmasq instance to use adblock"
146 # check running firewall
148 check
="$(${adb_iptv4} -vnL | grep -F "DROP
")"
152 f_log
"please enable the local firewall to use adblock"
156 # get lan ip addresses
158 network_get_ipaddr adb_ipv4
"${adb_lanif}"
159 network_get_ipaddr6 adb_ipv6
"${adb_lanif}"
160 if [ -z "${adb_ipv4}" ] && [ -z "${adb_ipv6}" ]
163 f_log
"no valid IPv4/IPv6 configuration found (${adb_lanif}), please set 'adb_lanif' manually"
167 # check logical update interfaces (with default route)
169 network_find_wan adb_wanif4
170 network_find_wan6 adb_wanif6
171 if [ -z "${adb_wanif4}" ] && [ -z "${adb_wanif6}" ]
173 adb_wanif4
="${adb_lanif}"
178 if [ "${adb_wanif4}" = "${adb_lanif}" ] || [ "${adb_wanif6}" = "${adb_lanif}" ]
180 adb_nullipv4
="${adb_ipv4}"
181 adb_nullipv6
="${adb_ipv6}"
182 if [ "$(uci get uhttpd.main.listen_http | grep -Fo "80")" = "80" ] ||
183 [ "$(uci get uhttpd.main.listen_https | grep -Fo "443")" = "443" ]
186 f_log
"AP mode detected, set local LuCI instance to ports <> 80/443"
193 # get system release level
195 adb_sysver
="$(printf "${pkg_list}" | grep "^base-files
-")"
196 adb_sysver
="${adb_sysver##*-}"
199 # f_envcheck: check/set environment prerequisites
205 if [ "${apmode_ok}" = "true" ]
207 f_log
"AP mode enabled"
210 # check general package dependencies
217 f_depend
"kmod-ipt-nat"
219 # check ipv6 related package dependencies
221 if [ -n "${adb_wanif6}" ]
223 check
="$(printf "${pkg_list}" | grep "^ip6tables
-")"
226 f_log
"package 'ip6tables' not found, IPv6 support will be disabled"
229 check
="$(printf "${pkg_list}" | grep "^kmod-ipt-nat6
-")"
232 f_log
"package 'kmod-ipt-nat6' not found, IPv6 support will be disabled"
238 # check ca-certificates package and set fetch parms accordingly
240 fetch_parm
="--no-config --quiet --tries=1 --no-cache --no-cookies --max-redirect=0 --dns-timeout=5 --connect-timeout=5 --read-timeout=5"
241 check
="$(printf "${pkg_list}" | grep "^ca-certificates
-")"
244 fetch_parm
="${fetch_parm} --no-check-certificate"
247 # check adblock temp directory
249 if [ -n "${adb_tmpdir}" ] && [ -d "${adb_tmpdir}" ]
251 f_space
"${adb_tmpdir}"
252 if [ "${space_ok}" = "false" ]
254 if [ $
((av_space
)) -le 2000 ]
257 f_log
"not enough free space in '${adb_tmpdir}' (avail. ${av_space} kb)" "${rc}"
260 f_log
"not enough free space to handle all adblock list sources at once in '${adb_tmpdir}' (avail. ${av_space} kb)"
265 f_log
"temp directory not found" "${rc}"
271 mem_total
="$(awk '$1 ~ /^MemTotal/ {printf $2}' "/proc
/meminfo
")"
272 mem_free
="$(awk '$1 ~ /^MemFree/ {printf $2}' "/proc
/meminfo
")"
273 mem_swap
="$(awk '$1 ~ /^SwapTotal/ {printf $2}' "/proc
/meminfo
")"
274 if [ $
((mem_total
)) -le 64000 ] && [ $
((mem_swap
)) -eq 0 ]
277 f_log
"not enough free memory, overall sort processing will be disabled (total: ${mem_total}, free: ${mem_free}, swap: ${mem_swap})"
282 # check backup configuration
284 if [ -n "${adb_dir_backup}" ] && [ -d "${adb_dir_backup}" ]
286 f_space
"${adb_dir_backup}"
287 if [ "${space_ok}" = "false" ]
289 f_log
"not enough free space in '${adb_dir_backup}'(avail. ${av_space} kb), backup/restore will be disabled"
292 f_log
"backup/restore will be enabled"
297 f_log
"backup/restore will be disabled"
300 # set dnsmasq defaults
302 if [ -n "${adb_wanif4}" ] && [ -n "${adb_wanif6}" ]
304 adb_dnsformat
="awk -v ipv4="${adb_nullipv4}" -v ipv6="${adb_nullipv6}" '{print \"address=/\"\$0\"/\"ipv4\"\n\"\"address=/\"\$0\"/\"ipv6}'"
305 elif [ -n "${adb_wanif4}" ]
307 adb_dnsformat="awk -v ipv4="${adb_nullipv4}" '{print
\"address
=/\"\
$0\"/\"ipv4
}'"
309 adb_dnsformat="awk -v ipv6="${adb_nullipv6}" '{print
\"address
=/\"\
$0\"/\"ipv6
}'"
312 # check ipv4/iptables configuration
314 if [ -n "${adb_wanif4}" ]
316 f_firewall "IPv4" "nat" "A" "prerouting_rule" "adb-nat" "-p tcp -d ${adb_nullipv4} -m multiport --dports 80,443 -j DNAT --to-destination ${adb_ipv4}:${adb_nullport}"
317 f_firewall "IPv4" "filter" "A" "forwarding_rule" "adb-fwd" "-p tcp -d ${adb_nullipv4} -j REJECT --reject-with tcp-reset"
318 f_firewall "IPv4" "filter" "A" "forwarding_rule" "adb-fwd" "-d ${adb_nullipv4} -j REJECT --reject-with icmp-host-unreachable"
319 f_firewall "IPv4" "filter" "A" "output_rule" "adb-out" "-p tcp -d ${adb_nullipv4} -j REJECT --reject-with tcp-reset"
320 f_firewall "IPv4" "filter" "A" "output_rule" "adb-out" "-d ${adb_nullipv4} -j REJECT --reject-with icmp-host-unreachable"
321 if [ $((adb_forcedns)) -eq 1 ]
323 f_firewall "IPv4" "nat" "A" "prerouting_rule" "adb-dns" "-p udp --dport 53 -j DNAT --to-destination ${adb_ipv4}:53"
324 f_firewall "IPv4" "nat" "A" "prerouting_rule" "adb-dns" "-p tcp --dport 53 -j DNAT --to-destination ${adb_ipv4}:53"
326 if [ "${fw_done}" = "true" ]
328 f_log "created volatile IPv4 firewall ruleset"
333 # check ipv6/ip6tables configuration
335 if [ -n "${adb_wanif6}" ]
337 f_firewall "IPv6" "nat" "A" "PREROUTING" "adb-nat" "-p tcp -d ${adb_nullipv6} -m multiport --dports 80,443 -j DNAT --to-destination [${adb_ipv6}]:${adb_nullport}"
338 f_firewall "IPv6" "filter" "A" "forwarding_rule" "adb-fwd" "-p tcp -d ${adb_nullipv6} -j REJECT --reject-with tcp-reset"
339 f_firewall "IPv6" "filter" "A" "forwarding_rule" "adb-fwd" "-d ${adb_nullipv6} -j REJECT --reject-with icmp6-addr-unreachable"
340 f_firewall "IPv6" "filter" "A" "output_rule" "adb-out" "-p tcp -d ${adb_nullipv6} -j REJECT --reject-with tcp-reset"
341 f_firewall "IPv6" "filter" "A" "output_rule" "adb-out" "-d ${adb_nullipv6} -j REJECT --reject-with icmp6-addr-unreachable"
342 if [ $((adb_forcedns)) -eq 1 ]
344 f_firewall "IPv6" "nat" "A" "PREROUTING" "adb-dns" "-p udp --dport 53 -j DNAT --to-destination [${adb_ipv6}]:53"
345 f_firewall "IPv6" "nat" "A" "PREROUTING" "adb-dns" "-p tcp --dport 53 -j DNAT --to-destination [${adb_ipv6}]:53"
347 if [ "${fw_done}" = "true" ]
349 f_log "created volatile IPv6 firewall ruleset"
354 # check volatile adblock uhttpd instance configuration
356 rc="$(ps | grep -q "[u]httpd.*\-h /www/adblock"; printf ${?})"
359 if [ -n "${adb_wanif4}" ] && [ -n "${adb_wanif6}" ]
361 uhttpd -h "/www/adblock" -k 0 -N 100 -t 0 -T 1 -D -S -E "/index.html" -p "${adb_ipv4}:${adb_nullport}" -p "[${adb_ipv6}]:${adb_nullport}"
363 elif [ -n "${adb_wanif4}" ]
365 uhttpd -h "/www/adblock" -k 0 -N 100 -t 0 -T 1 -D -S -E "/index.html" -p "${adb_ipv4}:${adb_nullport}"
368 uhttpd -h "/www/adblock" -k 0 -N 100 -t 0 -T 1 -D -S -E "/index.html" -p "[${adb_ipv6}]:${adb_nullport}"
373 f_log "created volatile uhttpd instance"
375 f_log "failed to initialize volatile uhttpd instance" "${rc}"
380 # check whitelist entries
382 if [ -s "${adb_whitelist}" ]
384 awk "${adb_whitelist_rset}" "${adb_whitelist}" > "${adb_tmpdir}/tmp.whitelist"
387 # remove no longer used opkg package list
392 # f_depend: check package dependencies
399 check="$(printf "${pkg_list}" | grep "^${package} -")"
403 f_log "package '${package}' not found" "${rc}"
408 # f_firewall: set iptables rules for ipv4/ipv6
412 local ipt="${adb_iptv4}"
420 # select appropriate iptables executable for IPv6
422 if [ "${proto}" = "IPv6" ]
427 # check whether iptables rule already applied and proceed accordingly
429 rc="$("${ipt}" -w -t "${table}" -C "${chain}" -m comment --comment "${notes}" ${rules}; printf ${?})"
432 "${ipt}" -w -t "${table}" -"${ctype}" "${chain}" -m comment --comment "${notes}" ${rules}
438 f_log "failed to initialize volatile ${proto} firewall rule '${notes}'" "${rc}"
444 # f_log: log messages to stdout and syslog
453 # check for terminal session
460 # log to different output devices and set log class accordingly
462 if [ -n "${log_msg}" ]
464 if [ $((log_rc)) -gt 0 ]
467 log_rc=", rc: ${log_rc}"
468 log_msg="${log_msg}${log_rc}"
470 "${adb_log}" ${log_parm} -t "adblock[${adb_pid}] ${class}" "${log_msg}" 2>&1
474 ################################################
475 # f_space: check mount points/space requirements
483 av_space="$(df "${mp}" | tail -n1 | awk '{printf $4}')"
484 if [ $((av_space)) -lt $((adb_minspace)) ]
491 # f_cntconfig: calculate counters in config
499 for src_name in $(ls -ASr "${adb_dnsdir}/${adb_dnsprefix}"*)
501 count="$(wc -l < "${src_name}")"
502 src_name="${src_name#*.}"
503 if [ -n "${adb_wanif4}" ] && [ -n "${adb_wanif6}" ]
507 "${adb_uci}" -q set "adblock.${src_name}.adb_src_count=${count}"
508 count_sum=$((count_sum + count))
510 "${adb_uci}" -q set "adblock.global.adb_overall_count=${count_sum}"
513 # f_rmconfig: remove counters & timestamps in given config sections
519 local restore_done="${2:-false}"
521 for src_name in ${rm_done}
523 src_name="${src_name#*.}"
524 if [ "${restore_done}" = "true" ]
526 src_name="${src_name%.*}"
527 "${adb_uci}" -q set "adblock.${src_name}.adb_src_timestamp=list restored"
529 "${adb_uci}" -q delete "adblock.${src_name}.adb_src_count"
530 "${adb_uci}" -q delete "adblock.${src_name}.adb_src_timestamp"
535 # f_restore: restore last adblock list backups and restart dnsmasq
542 # remove bogus adblock lists
544 if [ -n "${adb_revsrclist}" ]
546 rm_done="$(find "${adb_dnsdir}" -maxdepth 1 -type f \( ${adb_revsrclist} \) -print -exec rm -f "{}" \;)"
548 if [ $((rc)) -eq 0 ] && [ -n "${rm_done}" ]
550 f_rmconfig "${rm_done}"
551 f_log "all bogus adblock lists removed"
552 elif [ $((rc)) -ne 0 ]
554 f_log "error during removal of bogus adblock lists" "${rc}"
561 if [ "${backup_ok}" = "true" ]
563 restore_done="$(find "${adb_dir_backup}" -maxdepth 1 -type f -name "${adb_dnsprefix}*.gz" -print -exec cp -pf "{}" "${adb_dnsdir}" \;)"
565 if [ $((rc)) -eq 0 ] && [ -n "${restore_done}" ]
567 find "${adb_dnsdir}" -maxdepth 1 -type f -name "${adb_dnsprefix}*.gz" -exec gunzip -f "{}" \;
568 f_log "all available backups restored"
569 elif [ $((rc)) -ne 0 ] && [ -n "${restore_done}" ]
571 f_log "error during restore of adblock lists" "${rc}"
575 f_log "backup service disabled, nothing to restore"
578 # (re-)try dnsmasq restart without bogus adblock lists / with backups
580 if [ -n "${restore_done}" ] || [ -n "${rm_done}" ]
582 /etc/init.d/dnsmasq restart
584 rc="$(ps | grep -q "[d]nsmasq"; printf ${?})"
589 f_log "adblock lists with overall ${adb_count} domains loaded"
592 f_log "dnsmasq restart failed, please check 'logread
' output" "${rc}"
598 # f_exit: delete (temporary) files, generate statistics and exit
605 # delete temporary files & directories
607 if [ -f "${adb_tmpfile}" ]
609 rm -f "${adb_tmpfile}"
611 if [ -d "${adb_tmpdir}" ]
613 rm -rf "${adb_tmpdir}"
616 # final log message and iptables statistics
620 if [ -n "${adb_wanif4}" ]
622 ipv4_adblock="$(${adb_iptv4} -t nat -vnL | awk '$11 ~
/^adb-nat$
/ {sum += $1} END
{printf sum}')"
623 ipv4_adblock="$((${ipv4_adblock} + $(${adb_iptv4} -vnL | awk '$11 ~ /^adb-(fwd|out)$/ {sum += $1} END {printf sum}')))"
625 if [ -n "${adb_wanif6}" ]
627 ipv6_adblock="$
(${adb_iptv6} -t nat
-vnL |
awk '$10 ~ /^adb-nat$/ {sum += $1} END {printf sum}')"
628 ipv6_adblock="$
((${ipv6_adblock} + $(${adb_iptv6} -vnL | awk '$10 ~ /^adb-(fwd|out)$/ {sum += $1} END
{printf sum}')))"
630 if [ -n "$(${adb_uci} -q changes adblock)" ]
632 "${adb_uci}" -q commit "adblock"
634 f_log "firewall statistics (IPv4/IPv6): ${ipv4_adblock}/${ipv6_adblock} ad related packets blocked"
635 f_log "domain adblock processing finished successfully (${adb_scriptver}, ${adb_sysver}, $(/bin/date "+%d.%m.%Y %H:%M:%S"))"
636 elif [ $((rc)) -gt 0 ]
638 if [ -n "$(${adb_uci} -q changes adblock)" ]
640 "${adb_uci}" -q revert "adblock"
642 f_log "domain adblock processing failed (${adb_scriptver}, ${adb_sysver}, $(/bin/date "+%d.%m.%Y %H:%M:%S"))"
646 rm -f "${adb_pidfile}"