modernization

.pre-commit-config.yaml

@@ -0,0 +1,36 @@
+---
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.1.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+        args:
+          - '--allow-multiple-documents'
+      - id: check-json
+      - id: check-added-large-files
+      - id: check-symlinks
+      - id: destroyed-symlinks
+      - id: check-executables-have-shebangs
+      - id: requirements-txt-fixer
+  - repo: https://github.com/shellcheck-py/shellcheck-py
+    rev: v0.8.0.3
+    hooks:
+      - id: shellcheck
+  - repo: https://github.com/AleksaC/hadolint-py
+    rev: v2.8.0
+    hooks:
+      - id: hadolint
+        args:
+          - '--ignore'
+          - 'DL3007'
+          - '--ignore'
+          - 'DL3008'
+          - '--ignore'
+          - 'DL3013'
+  - repo: https://github.com/sirosen/check-jsonschema
+    rev: 0.9.1
+    hooks:
+      - id: check-github-workflows
+      - id: check-github-actions

LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org>

README.md

@@ -1,4 +1,23 @@
 privoxy-blocklist
 =================
 
-Script converting AdBlock Plus rules into privoxy format.
+[![GitHub release](https://img.shields.io/github/release/Andrwe/privoxy-blocklist?include_prereleases=&sort=semver&color=blue)](https://github.com/Andrwe/privoxy-blocklist/releases/)
+[![License](https://img.shields.io/badge/License-UNLICENSE-blue)](#license)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Andrwe/privoxy-blocklist/master.svg)](https://results.pre-commit.ci/latest/github/Andrwe/privoxy-blocklist/master)
+
+Script converting AdBlock Plus rules into privoxy format.
+
+## How does it work
+
+The script `privoxy-blocklist.sh` downloads AdBlock Plus filter files and generates privoxy compatible filter and action files based on these.
+After the generation is done it modifies the privoxy configuration files `/etc/privoxy/config` to import the generated files.
+
+Due to this behaviour the script must run as root user to be able to modify the privoxy configuration file.
+
+## Usage
+
+Either run `privoxy-blocklist.sh` manually with root privileges (e.g., `sudo privoxy-blocklist.sh`) or via root cronjob.
+
+## Kudos
+
+* [Badge Generator](https://michaelcurrin.github.io/badge-generator/#/) for providing easy method to generate badges/shields

helper/install_deps.sh

@@ -0,0 +1,27 @@
+#!/bin/sh
+
+set -e
+
+exists() {
+    if command -v "$1" >/dev/null 2>&1; then
+        return 0
+    fi
+    return 1
+}
+
+if exists apk;then
+    apk add --no-cache privoxy sed grep bash wget
+    exit 0
+fi
+if exists apt-get; then
+    export DEBIAN_FRONTEND=noninteractive
+    apt-get update -qq -y
+    apt-get install -y privoxy sed grep bash wget
+    exit 0
+fi
+if exists pacman; then
+    pacman -Sy privoxy sed grep bash wget
+    exit 0
+fi
+echo "no install command found"
+exit 1