Refactor for improved use by third parties

.github/workflows/builds.yml

@@ -0,0 +1,57 @@
+name: Binary builds
+
+on:
+  push: [main]
+
+jobs:
+  check:
+    name: Check files
+    outputs:
+      run_job: ${{ steps.check_files.outputs.run_job }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 2
+
+      - name: check modified files
+        id: check_files
+        run: |
+          echo "=============== list modified files ==============="
+          git diff --name-only HEAD^ HEAD
+
+          echo "========== check paths of modified files =========="
+          git diff --name-only HEAD^ HEAD > files.txt
+          while IFS= read -r file
+          do
+            echo $file
+            if [[ $file != src/* ]]; then
+              echo "This modified file is not under the 'src' folder."
+              echo "::set-output name=run_job::false"
+              break
+            else
+              echo "::set-output name=run_job::true"
+            fi
+          done < files.txt
+
+  job_for_db:
+    name: Compile to binary
+    needs: check
+    if: needs.check.outputs.run_job == 'true'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout...
+        uses: actions/checkout@v2
+
+      - name: Compile...
+        run: cargo build --release
+
+      - name: Rename...
+        run: mv ./target/release/shield-db ./linux
+
+      - name: Update release
+        uses: johnwbyrd/update-release@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          asset: ./linux

Cargo.toml

@@ -12,3 +12,5 @@ tokio = { version = "1", features = ["full"] }
 # Serde
 serde = { version = "1.0", features = ["derive"] }
 serde_yaml = "0.8"
+# Progress bar for ui
+linya = "0.1"

config.yml

@@ -1,33 +1,41 @@
-trackers:
-  abp:
-    - 'https://easylist.to/easylist/easylist.txt'
-    - 'https://easylist.to/easylist/easyprivacy.txt'
-    - 'https://hosts.netlify.app/Pro/adblock.txt'
-    - 'https://raw.githubusercontent.com/trickypr/energized-mirror/main/ultimate.txt'
-    - 'https://raw.githubusercontent.com/dothq-extensions/shield-db/main/lists/ads.txt'
+name: ShieldDB
+out: out
 
-  hosts: []
+header:
+  creator: Dot HQ
+  product: Dot Shield (adblocker)
 
-social:
-  abp:
-    - 'https://raw.githubusercontent.com/trickypr/energized-mirror/main/social.txt'
+lists:
+  - name: trackers
+    abp:
+      - 'https://easylist.to/easylist/easylist.txt'
+      - 'https://easylist.to/easylist/easyprivacy.txt'
+      - 'https://hosts.netlify.app/Pro/adblock.txt'
+      - 'https://raw.githubusercontent.com/trickypr/energized-mirror/main/ultimate.txt'
+      - 'https://raw.githubusercontent.com/dothq-extensions/shield-db/main/lists/ads.txt'
 
-  hosts: []
+    hosts: []
 
-fake_news:
-  abp: []
+  - name: social
+    abp:
+      - 'https://raw.githubusercontent.com/trickypr/energized-mirror/main/social.txt'
 
-  hosts:
-    - 'https://raw.githubusercontent.com/StevenBlack/hosts/master/extensions/fakenews/hosts'
+    hosts: []
 
-gambling:
-  abp: []
+  - name: fake_news
+    abp: []
 
-  hosts:
-    - 'https://raw.githubusercontent.com/StevenBlack/hosts/master/extensions/gambling/hosts'
+    hosts:
+      - 'https://raw.githubusercontent.com/StevenBlack/hosts/master/extensions/fakenews/hosts'
 
-ip_grabbers:
-  abp: []
-
-  hosts:
-    - 'https://raw.githubusercontent.com/ejaz4/hosts/main/IP%20loggers.txt'
+  - name: gambling
+    abp: []
+
+    hosts:
+      - 'https://raw.githubusercontent.com/StevenBlack/hosts/master/extensions/gambling/hosts'
+
+  - name: ip_grabbers
+    abp: []
+
+    hosts:
+      - 'https://raw.githubusercontent.com/ejaz4/hosts/main/IP%20loggers.txt'

out/fake_news.txt

@@ -1,3 +1,9 @@
+! This is an automatically generated blocklist based on a number of third-party sources.
+! These sources have their own copyright and license. This list was generated for Dot Shield (adblocker) by Dot HQ
+! 
+! The list fake_news includes:
+! - https://raw.githubusercontent.com/StevenBlack/hosts/master/extensions/fakenews/hosts
+
 ||100percentfedup.com^
 ||20minutenews.com^
 ||21stcenturywire.com^

out/gambling.txt

@@ -1,3 +1,9 @@
+! This is an automatically generated blocklist based on a number of third-party sources.
+! These sources have their own copyright and license. This list was generated for Dot Shield (adblocker) by Dot HQ
+! 
+! The list gambling includes:
+! - https://raw.githubusercontent.com/StevenBlack/hosts/master/extensions/gambling/hosts
+
 ||10bet.com^
 ||10luxury39.com^
 ||12bet.com^

out/ip_grabbers.txt

@@ -1,3 +1,9 @@
+! This is an automatically generated blocklist based on a number of third-party sources.
+! These sources have their own copyright and license. This list was generated for Dot Shield (adblocker) by Dot HQ
+! 
+! The list ip_grabbers includes:
+! - https://raw.githubusercontent.com/ejaz4/hosts/main/IP%20loggers.txt
+
 ||^
 ||2no.co^
 ||blasze.com^

out/social.txt

@@ -1,3 +1,9 @@
+! This is an automatically generated blocklist based on a number of third-party sources.
+! These sources have their own copyright and license. This list was generated for Dot Shield (adblocker) by Dot HQ
+! 
+! The list social includes:
+! - https://raw.githubusercontent.com/trickypr/energized-mirror/main/social.txt
+
 ||0-act.channel.facebook.com^
 ||0-edge-chat.facebook.com^
 ||0.0.freebasics.com^