Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove Leading Bullet Points for Compatibility with pihole-updatelists #1324

Closed
wants to merge 5 commits into from
Closed

Conversation

mschabhuettl
Copy link
Contributor

@mschabhuettl mschabhuettl commented Oct 31, 2023

Remove Leading Bullet Points for Compatibility with pihole-updatelists

I've removed the leading bullet points from the Blocklisten.md file to ensure compatibility with the pihole-updatelists script.

While using the pihole-updatelists script to fetch all URLs from Blocklisten.md, I observed a significant decrease in the number of blocklists, from 85 million to just 2 million. Upon further investigation, I discovered that the script was unable to fetch URLs that were prefixed with bullet points, specifically in the format "- ". This issue caused a disruption in my Pi-hole setup.

Thank you for considering this change.

Best regards,
Matthias

Removed leading "bullet points" as pihole-updatelists script is unable to fetch url

Signed-off-by: Matthias Schabhüttl <[email protected]>
Signed-off-by: Matthias Schabhüttl <[email protected]>
@mschabhuettl
Copy link
Contributor Author

In order to ensure formatting on GitHub, I've used double CRLF, in order to have every URL in one line.

@LizenzFass78851
Copy link
Contributor

LizenzFass78851 commented Oct 31, 2023

This results in the content of the readme being displayed longer again.
809700e
Screenshot (99)


The advantage of the "-" sign is that the readme is presented more compactly and copying and pasting the lists into pihole still works.
Mind you, copying and pasting the lists still works if there is a "-" in front of it and if you don't display the RAW view of the readme
4f4458d
Screenshot (100)


If you remove the empty lines and do without the "-", the links would be displayed in one line in the readme.
3d3f16a
Screenshot (101)


I think that @RPiList should decide which representation of the readme is best and what should be continued accordingly.

  • The variant with double blank lines, which means the readme file is displayed a little longer.
  • or The variant with "-" which makes the readme more compact in its presentation.

@mschabhuettl
Copy link
Contributor Author

@LizenzFass78851 @RPiList
Ich möchte hier mal primär in Deutsch antworten:
Es scheint mir, dass es in diesem Kontext weniger um Lesbarkeit als vielmehr um Funktionalität geht. Seit Jahren nutze ich jacklul/pihole-updatelists, um die Listen automatisch zu importieren. Dank dieses Skripts muss ich in der pihole-updatelists.conf nur die Blocklisten.md-Datei angeben, und alle Listen werden automatisch heruntergeladen. Das Kopieren und Einfügen funktioniert auch einwandfrei mit doppeltem CRLF.

English Version:
In this context, I believe the focus is less on readability and more on functionality. I've been using jacklul/pihole-updatelists for years to automatically import the lists. Thanks to this script, all I need to do in the pihole-updatelists.conf is specify the Blocklisten.md file, and all the lists are automatically fetched. Copying and pasting also work seamlessly with double CRLF.

@LizenzFass78851
Copy link
Contributor

Ok. Konnte ich nicht wissen.

Dann ist die alte Formatierung mit den doppelten Leerzeichen wohl die weitestgehend funktionale Lösung, da der Input der Readme auch mithilfe von externen Scripten verwendet werden können.

@mschabhuettl
Copy link
Contributor Author

@LizenzFass78851 Ja, das ist mir bis gestern gar nicht aufgefallen. Mein Pihole aktualisiert sich täglich/monatlich. Plötzlich hat sich die Anzahl der Block-Einträge drastisch verringert. Mir ist das jedoch erst aufgefallen, als ich aktiv ins Pihole-Interface geschaut habe.

LizenzFass78851 and others added 2 commits October 31, 2023 10:14
Signed-off-by: LizenzFass78851 <[email protected]>
@RPiList
Copy link
Owner

RPiList commented Oct 31, 2023

Das Ziel dieser Liste war ursprünglich das ermöglichen von Copy & Paste in das Pihole-UI. Deswegen steht das in der Liste über den Listen als Hinweis für Nutzer. Die Variante, die das ermöglicht, ist die richtige Variante. Ob das mit den sog. Bullet-Points geht weiß ich nicht. Noch nicht getestet.

Irgendwann hatten wir mal die Formatierung mit 2x CRLF. Damit hat das C&P mit Pihole v5 funktioniert, mit Pihole v6 aber nicht. Deswegen hatte ich das auf 1x CRLF geändert. Dann sieht die Liste für den Menschen aber richtig unübersichtlich aus. Jetzt ist Pihole v6 aber noch in der Beta, hat jede Menge Bugs im UI, so dass gar nicht klar ist, welche Formatierung am Ende funktionieren wird. Also sich jetzt schon nach v6 ausrichten ist ein Fehler von mir gewesen.

Gibt auch noch andere Möglichkeiten: Z.B. das Anbieten der Listen in einem "Code"-Fenster, dann bleibt die Formatierung auch mit einem CRLF lesbar. Codefenster bieten auch oft die Möglichkeit dass der Nutzer den Code mit einem Button-Click kopieren kann (Copy & Paste).

Die Funktionalität mit dem angesprochenen Addon sollte auch gewährleistet werden. Vor allem, wenn das ein oft genutztes Addon ist. Natürlich könnte man auch eine eigene Liste für das Addon erstellen, aber dann haben wir doppelte Arbeit die Addon-Liste immer synchron zu halten.

Bevor wir hier die abschließende Entscheidung fällen, ist es sicher das Beste, umgehend die Kompatiblität mit dem Addon herzustellen. Das wäre dann die Variante mit dem 2x CRLF, richtig? Weil wenn das von vielen Nutzern genutzt wird, funktioniert deren Pihole nicht mehr richtig.

Das sieht dann zwar nicht so schön aus wie die Bullet-Points, aber funktioniert mit dem Addon und CopyPaste mit Pihole v5 funktioniert auch.

Danach schauen wir was wir für alternative Darstellungsmöglichkeiten haben.

@LizenzFass78851
Copy link
Contributor

LizenzFass78851 commented Oct 31, 2023

Irgendwann hatten wir mal die Formatierung mit 2x CRLF. Damit hat das C&P mit Pihole v5 funktioniert, mit Pihole v6 aber nicht.

Dies wurde bei Pihole durch pi-hole/web#2707 bereits behoben.
Das einfügen per Copy and Paste sollte eigentlich in Pihole Version 6 wieder genauso funktionieren wie bei Pihole in der Version 5

@LizenzFass78851
Copy link
Contributor

Bevor wir hier die abschließende Entscheidung fällen, ist es sicher das Beste, umgehend die Kompatiblität mit dem Addon herzustellen. Das wäre dann die Variante mit dem 2x CRLF, richtig?

Richtig.

@RPiList
Copy link
Owner

RPiList commented Oct 31, 2023

Also die Bullet Points sind Copy&Paste kompatible mit Pihole v5 und Pihole v6.

@LizenzFass78851
Copy link
Contributor

LizenzFass78851 commented Oct 31, 2023

Also die Bullet Points sind Copy&Paste kompatible mit Pihole v5 und Pihole v6

Diese sind kompatible
Dies sieht beim einfügen folgendermaßen aus:

https://raw.githubusercontent.com/RPiList/specials/master/Blocklisten/notserious
https://raw.githubusercontent.com/RPiList/specials/master/Blocklisten/Streaming
https://raw.githubusercontent.com/RPiList/specials/master/Blocklisten/Phishing-Angriffe
https://raw.githubusercontent.com/RPiList/specials/master/Blocklisten/spam.mails
https://raw.githubusercontent.com/RPiList/specials/master/Blocklisten/Win10Telemetry
https://raw.githubusercontent.com/RPiList/specials/master/Blocklisten/easylist
https://raw.githubusercontent.com/RPiList/specials/master/Blocklisten/samsung

Diese Bullet Points werden beim markieren nicht mit markiert außer man ist in der RAW Ansicht der Datei.
Deswegen die Anmerkung von @mschabhuettl zwecks pihole-updatelists

@LizenzFass78851
Copy link
Contributor

LizenzFass78851 commented Oct 31, 2023

Also die Bullet Points sind Copy&Paste kompatible mit Pihole v5 und Pihole v6

Diese sind kompatible

Der Versuch zeigt: Es hat funkioniert.
2023-10-31-18-35-34

@mschabhuettl
Copy link
Contributor Author

mschabhuettl commented Oct 31, 2023

@RPiList @LizenzFass78851 Codeblöcke sind eigentlich eine sehr gute Idee. Zumindest wenn sie als Bulk-Code-Comment angegeben werden. Dann sind vor den URLs keine Zeichen und das C&P wäre einfacher und auch "lesbarer" im Sinne, dass der Zeilenabstand geringer wäre.

Das hier mein ich.
Der Parser von pihole-updatelists sollte die ``` Zeichen ignorieren.
Der Nachteil hier drunter ist dass nur dass die Links in einem Codeblock glaub ich nicht geklickt werden können.
http://sempervideo.de
Das ist meiner Meinung nach aber auch nicht notwendig, da die Links eh oben stehen.

Gibt es sonst noch weitere Möglichkeiten Codeblöcke darzustellen?

Wenn ich morgen Zeit habe, und niemand von euch schneller ist würde ich die Idee in den Pull Request committen.

Liebe Grüße,
Matthias

Signed-off-by: Matthias Schabhüttl <[email protected]>
@mschabhuettl
Copy link
Contributor Author

mschabhuettl commented Oct 31, 2023

@RPiList @LizenzFass78851 hab das doppelte CRLF jetzt gegen ```-Blöcke getauscht.

Wird jetzt so dargestellt:

image

@RPiList
Copy link
Owner

RPiList commented Oct 31, 2023

Wird jetzt so dargestellt:

ja, lass uns das so entsprechend umbauen. Kommt Dein Addon/Plugin damit klar?

@RPiList
Copy link
Owner

RPiList commented Nov 1, 2023

Liste wurde umgestellt. Bitte prüfen ob das Addon noch funktioniert. Danach kann das hier dann geschlossen werden.

@mschabhuettl
Copy link
Contributor Author

mschabhuettl commented Nov 1, 2023

@RPiList

Funktioniert! Danke!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants