From 270283eb61716fa51c0c9b96ef3e00d23eb94dc9 Mon Sep 17 00:00:00 2001
From: metamuffin <metamuffin@disroot.org>
Date: Thu, 20 Jun 2024 16:08:57 +0200
Subject: add more info

---
 readme.md          | 16 ++++++++++++++--
 sample_config.yaml | 16 ++++++++++++++++
 src/info.rs        | 16 ++++++++++------
 src/main.rs        |  1 -
 src/state.rs       |  8 +++++++-
 5 files changed, 47 insertions(+), 10 deletions(-)
 create mode 100644 sample_config.yaml

diff --git a/readme.md b/readme.md
index 05b61cc..ef98b75 100644
--- a/readme.md
+++ b/readme.md
@@ -1,4 +1,16 @@
 # meta adservices
 
-A funny adservice. To promote each others free software projects or websites like one would in
-a webring.
+A funny adservice. To promote each others free software projects or websites
+like one would in a webring.
+
+## Usage
+
+1. Build with cargo: `cargo build --release`
+2. Write a configuration file. See [sample_config.yaml](./sample_config.yaml)
+3. Run it: `meta-adservices your_config.yaml`
+
+Ask questions in issues or [contact me](https://metamuffin.org/contact).
+
+## License
+
+AGPL-3.0-only; See [COPYING](./COPYING)
diff --git a/sample_config.yaml b/sample_config.yaml
new file mode 100644
index 0000000..4c5b0bb
--- /dev/null
+++ b/sample_config.yaml
@@ -0,0 +1,16 @@
+bloom_filter_size: 10000
+impression_weight_falloff: 0.95
+leaderboard_weight_threshold: 16
+database_path: /path/to/data
+port: 8080
+image_base: /path/to/ads_dir
+ads:
+    one:
+        image: image-one.avif
+        target: "https://example.org/"
+    two:
+        image: image-two.avif
+        target: "https://example.org/"
+    three:
+        image: image-three.avif
+        target: "https://example.org/"
diff --git a/src/info.rs b/src/info.rs
index f0cda28..d082d4d 100644
--- a/src/info.rs
+++ b/src/info.rs
@@ -20,7 +20,9 @@ pub async fn r_index<'a>(state: &State<Arc<Logic>>) -> MyResult<Template<DynRend
                 h1 { "meta adservices" }
                 p {
                     "meta adservices is the leading provider of useless images within iframes. "
-                    "meta adservices is inspired by " a[href="https://john.citrons.xyz/"]{"johnvertisement"}
+                    "meta adservices is inspired by " a[href="https://john.citrons.xyz/"]{"johnvertisement"} ". "
+                    "the primary differences to john are that meta adservices serves properly compressed images, is free software and is bit more responsive in general. "
+                    "check the source code on " a[href="https://codeberg.org/metamuffin/meta-adservices"]{"codeberg"} ". "
                 }
                 h2 { "sample ad" }
                 iframe[src="/v1/embed?s=adservices.metamuffin.org", style="border:none;width:728px;height:90px;"] {}
@@ -33,10 +35,11 @@ pub async fn r_index<'a>(state: &State<Arc<Logic>>) -> MyResult<Template<DynRend
                     "Send mail to " a[href="mailto:metamuffin@disroot.org"]{"metamuffin@disroot.org"} "." br;
                     "The mail MUST contain a ad name, ad image, URL to direct those who click it and optionally ad author name. " br;
                     "Some ads will be rejected for any or no reason at all. "
-                    "To create good ads, consider the following statements in the context of your ad: "
+                    "To create good ads, consider the following statements in the context of your ad (you must not satisfy all): "
                     ol {
                         li { "It is funny, amusing or enigmatic in some way." }
-                        li { "It doesn't break any laws." }
+                        li { "It doesn't break any laws in germany." }
+                        li { "The link promotes a personal page or free software project page." }
                         li { "The image is compressed losslessly." }
                         li { "The image has a resolution of exactly 728x90." }
                         li { "The image uses the sRGB color space." }
@@ -46,12 +49,12 @@ pub async fn r_index<'a>(state: &State<Arc<Logic>>) -> MyResult<Template<DynRend
                 }
                 h2 { "leaderboard" }
                 table {
-                    tr { th { "Domain" } th { "Impressions" } th { "Impression weight" } }
+                    tr { th { "Domain" } th { "Impression weight" } th { "Impressions" } }
                     @for (domain, raw, weighted) in &leaderboard {
                         tr {
                             td { @domain }
-                            td { @raw }
-                            td { @weighted.round() }
+                            td { b { @weighted.round() } }
+                            td { small { @raw } }
                         }
                     }
                 }
@@ -66,6 +69,7 @@ pub async fn r_index<'a>(state: &State<Arc<Logic>>) -> MyResult<Template<DynRend
                     li { "Your IP address is used within a bloom filter in volatile memory." }
                     li { "Your requests increments a persistent public counter per ad site (according to a weighting function)." }
                 }
+                p { "in case of questions or request mail " a[href="mailto:metamuffin@disroot.org"]{"metamuffin@disroot.org"} }
             }
         }
     }))
diff --git a/src/main.rs b/src/main.rs
index f846715..79c3842 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -1,5 +1,4 @@
 #![feature(duration_constructors)]
-#![feature(ip_bits)]
 pub mod embed;
 pub mod error;
 pub mod info;
diff --git a/src/state.rs b/src/state.rs
index a1d86c9..266199b 100644
--- a/src/state.rs
+++ b/src/state.rs
@@ -21,6 +21,7 @@ pub struct AdInfo {
 pub struct Config {
     bloom_filter_size: usize,
     impression_weight_falloff: f64,
+    leaderboard_weight_threshold: f64,
     pub image_base: PathBuf,
     database_path: PathBuf,
     pub port: u16,
@@ -103,7 +104,12 @@ impl Logic {
         }
 
         d.sort_by_key(|(_, _, w)| OrdAnyway(-*w));
-        while d.len() > 16 {
+        while d
+            .last()
+            .map(|l| l.2 < self.config.leaderboard_weight_threshold)
+            .unwrap_or_default()
+            || d.len() > 64
+        {
             d.pop();
         }
 
-- 
cgit v1.2.3-70-g09d2