1 UseVoteGer 4.12 (c) 2001-2014 Marc Langer
3 UseVoteGer is a voting software for usenet votes.
5 This script package is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Public License as published by the
7 Free Software Foundation.
10 - Ron Dippold (Usevote 3.0, 1993/94)
11 - Frederik Ramm (German translation, 1994)
12 - Wolfgang Behrens (UseVoteGer 3.1, based on Frederik's translation, 1998/99)
13 - Cornell Binder for some good advice and code fragments
14 (e.g. UVtemplate.pm, UVformats.pm)
16 This is a complete rewrite of UseVoteGer 3.1 in Perl (former versions were
17 written in C). Not all functions of Usevote/UseVoteGer 3.x are implemented!
19 -------------------------------------------------------------------------------
21 UseVoteGer 4.12 - Usenet-Abstimmungssoftware
22 ===========================================
24 von Marc Langer <uv@marclanger.de>
26 aktuelle Versionen: http://www.usevote.de
33 2. Usevote fuer Ungeduldige
34 3. Kompatibilitaet zu frueheren Versionen
36 5. Anfangs-Konfiguration
37 6. Konfiguration fuer einzelne Abstimmungen
38 7. Wahlschein generieren
39 8. Stimmen verarbeiten
40 9. Unzustellbare Bestaetigungen
43 12. Personalisierte Wahlscheine
44 13. Die einzelnen Programme
45 14. Die Konfigurationsdateien
52 Diese Software vereinfacht die Durchfuehrung von Usenet-Abstimmungen.
53 Usevote in der Urversion wurde von Ron Dippold fuer die Reorganisation
54 der Gruppe comp.sys.ibm.pc.games geschrieben und spaeter fuer die
55 allgemeine Verwendung verbessert.
57 Die deutsche Uebersetzung von Frederik Ramm diente jahrelang als
58 Grundlage fuer CfV-Auswertungen im deutschsprachigen Raum.
59 Wolfgang Behrens von den German Volunteer Votetakers (GVV) passte
60 es spaeter an neue Begebenheiten (z.B. personalisierte Wahlscheine)
61 an. Jedoch liefen die UseVoteGer 3.1beta-Versionen aufgrund eines
62 unbekannten Fehlers nicht auf jedem System (Segmentation Fault).
64 Um groessere Flexibilitaet und Plattformunabhaengigkeit zu bieten,
65 habe ich mich entschlossen, UseVoteGer in Perl neu zu implementieren.
66 Getestet wurde diese Version mit Perl 5.x unter Linux sowie
67 ActiveState Perl unter Windows 98.
70 2. Usevote fuer Ungeduldige
71 ===========================
73 I. Einmalig bei der Usevote-Erstinstallation
74 (1) usevote.cfg nach Bedarf anpassen (selbsterklaerend)
75 ACHTUNG: Unter Windows gibt es das Programm "less" nicht, da "more"
76 aber einigermassen broken ist, sollte man sich less fuer Windows
77 herunterladen: http://www.greenwoodsoftware.com/less/less381d.zip
78 Notfalls laesst sich auch in usevote.cfg die Einstellung "pager"
79 auf "more" setzen, aber viel Freude hat man damit nicht...
80 (2) Evtl. die Templates im gleichnamigen Unterverzeichnis fuer
81 eigenen Geschmack anpassen. Die Templates enthalten saemtliche
82 Texte fuer Bestaetigungs-/Fehlermails sowie die Ausgabeformate
83 und Texte fuer die CfVs und das Result.
84 (3) Perlmodule MIME::Parser, MIME::QuotedPrint, Digest::MD5,
85 Date::Parse und Email::Date installieren, falls noch nicht vorhanden.
86 Bei Benutzung von POP3 oder SMTP (siehe usevote.cfg) muss
87 Libnet installiert sein (Net::POP3 und Net::SMTP).
88 (Fuer Perl-Einsteiger: Unter Unix geht die Modul-Installation
89 sehr einfach mit "perl -MCPAN -e shell", ActivePerl fuer
90 Windows hat einen eigenen Paketmanager)
94 (1) usevote.cfg auf das durchzufuehrende Voting anpassen
96 (2) bei Sonderregeln (Abhaengigkeiten der einzelnen Abstimmungspunkte)
97 in usevote.rul Regeln definieren (selbsterklaerend)
98 (3) CfV erstellen und Wahlschein mit uvballot.pl generieren
99 (4) Fertigen CfV einreichen und auf Veroeffentlichung warten ;-)
100 (5) Bis zum 2. CfV regelmaessig (an den ersten Tagen mehrmals taeglich,
101 spaeter einmal taeglich) dies tun:
102 - uvvote.pl durchlaufen lassen
103 - im Verzeichnis tmp/ die Datei ergebnis.* (Ergebnis der Auswertung)
104 und evtl. ack.* (Bestaetigungsmails an die Waehler) kontrollieren
105 - Falls es Probleme gab: Bitte den Abschnit "Stimmen verarbeiten"
106 weiter unten in dieser Datei genau durchlesen. Dort steht
107 beschrieben, wie Fehler korrigiert werden koennen
108 - "uvvote.pl clean" aufrufen, um die Bestaetigungen zu verschicken
109 und das Ergebnis zu speichern/archivieren
110 - Falls Wahlbestaetigungen als unzustellbar zurueckkommen, solltest
111 Du diese zusammen in einer Datei speichern oder in ein spezielles
113 (6) Zwischenbestaetigung fuer den 2. CfV mit "uvcount.pl -l" erzeugen und
114 veroeffentlichen. Falls Wahlbestaetigungen als unzustellbar
115 zurueckkamen, kannst Du mit "uvbounce.pl dateiname" automatisch eine
116 Liste der ungueltigen Adressen erzeugen ("dateiname" ist die Datei,
117 in die Du zuvor die Bounces gespeichert hattest). Siehe auch Abschnitt
118 "Unzustellbare Bestaetigungen" weiter unten in dieser Datei, dort
119 ist auch erklaert, wie die Bounces aus einem POP3-Postfach gelesen
121 (7) Bis zum Result wieder wie (5)
122 (8) Zum vorgegebenen Zeitpunkt die Wahl abschliessen,
123 mit "uvcount.pl -r -v" Endergebnis erzeugen und veroeffentlichen
124 (zuvor wiederum Liste der ungueltigen Mailadressen erzeugen, siehe
127 Weitere Details finden sich im Folgenden.
128 Jeder Nutzer dieser Software sollte sich diesen Text wenigstens einmal
131 Abschnitt 6 beschreibt, wie mehrere Abstimmungen gleichzeitig durchgefuehrt
132 werden koennen, ohne saemtliche Programmdateien zu kopieren.
135 3. Kompatibilitaet zu frueheren Versionen
136 =========================================
138 - englische Usevote-Versionen: keine Kompatibilitaet
140 - deutsche Usevote-Versionen (Usevote 3.0a, UseVoteGer 3.1):
141 * Wahlscheine haben neue Markierungen zum sicheren Erkennen
142 der Stimmen. Bisherige Wahlscheine sind mit dieser Version
143 nicht mehr einsetzbar!
145 * acktext.txt gibt es nicht mehr, statt dessen sind im Unterverzeichnis
146 "templates" Vorlagen zu finden, die diese Texte enthalten.
148 * usevote.cfg ist komplett inkompatibel
150 * usevote.rul: voll kompatibel, ohne Einschraenkungen
152 * Ergebnisdateien: Inhalt kompatibel, aber Namensgebung geaendert
153 (obwohl irrelevant, da Umstieg auf diese Version waehrend
154 einer laufenden Wahl nicht moeglich)
156 * scheinkennungen: Dateiformat gaendert (aus selbigen Gruenden
157 nicht weiter wichtig)
159 * uvshell: integriert in uvvote.pl, ueber usevote.cfg steuerbar
161 * uvvote.pl: Aufrufparameter geaendert / Zusammenfuehrung mit uvshell
163 * uvcfv.pl: Alte Funktionalitaet ist nicht mehr implementiert,
164 statt dessen dient das Tool jetzt zum Generieren der persoenlichen
165 Wahlscheine und Verschicken des CfV an die Waehler
167 * uvcount.pl: Beinhaltet auch uvack und uvdup. Drei Einzelprogramme
168 schienen mir ineffizient.
170 * uvbounce.pl: Ausgabeformat etwas anders
176 * Ausgelieferte Dateien:
178 CHANGES Versionsaenderungen
179 COPYING GNU General Public License
181 UVconfig.pm Routinen zum Einlesen und Pruefen der Konfiguration
182 UVformats.pm Routinen zum Formatieren von Texten in Templates
183 UVmenu.pm Routinen zur Interaktion mit dem Wahlleiter
184 UVmessage.pm Routinen zum Parsen von Texten und Ersetzen von Platzhaltern
185 UVreadmail.pm Routinen zum Einlesen und MIME-Decodieren der Mails
186 UVrules.pm Routinen zur Regelverarbeitung (usevote.rul)
187 UVsendmail.pm Routinen zum Erzeugen von Mails
188 UVtemplate.pm Routinen zur Verarbeitung von Vorlagen (Templates)
189 bdsgtext.cfg Spezieller Text fuer den Wahlschein (Hinweis auf
190 Datenschutzgesetz), muss ausserhalb Deutschlands ggfls.
191 angepasst oder kann ignoriert werden (bdsg=0 in usevote.cfg)
192 mailpatterns.cfg Wildcards fuer verdaechtige Mailadressen
193 messages.cfg Programm-Meldungen (Ressourcen-Datei)
194 scheinkennungen Speicherung der Scheinkennungen bei personalisierten
195 Wahlscheinen. Muss zu Beginn der Abstimmung leer sein.
196 usevote.cfg Konfigurationsdatei
197 usevote.rul Abstimmungsregeln
198 uvballot.pl Wahlschein aus Abstimmungsdaten erstellen
199 uvbounce.pl Listen von unzustellbaren Bestaetigungen erzeugen
200 uvcfv.pl Erstellen und Verschicken von personalisierten Wahlscheinen
201 uvcount.pl Stimmenzaehlung, Erstellen von Waehlerlisten und
202 Aussortieren von doppelten Stimmabgaben
203 uvvote.pl Stimmen verarbeiten (fuer die taegliche Arbeit)
205 templates/ Verzeichnis mit Templates (Vorlagen)
206 ack-mail Template fuer Bestaetigungsmails
207 address-not-registered Fehlermail: Noch keine Scheinkennung fuer Adresse
209 ballot Template fuer einen Wahlschein
210 ballot-personal Template fuer personalisierten Wahlschein
211 ballot-request Template fuer eine Wahlscheinanforderung
212 bdsg-error Fehlermail: Datenschutzklausel nicht akzeptiert
213 bouncelist Template fuer Liste der ungueltigen Mailadressen
214 cancelled Template fuer Bestaetigung der Stimmannullierung
215 invalid-account Fehlermail: Fragwuerdige Mailadresse (Role Account)
216 invalid-name Fehlermail: Kein gueltiger Name in Mail/Wahlschein
218 mailheader Template fuer den Header von Mails an die Waehler
219 multiple-votes Fehlermail: Widerspruechliche Stimmen im Wahlschein
220 no-ballot Fehlermail: Kein Wahlschein in Mail gefunden
221 no-ballotid Fehlermail: Keine Wahlscheinkennung gefunden
222 no-votes Fehlermail: Keine Stimmen abgegeben
223 result-multi Template fuer ein Wahlergebnis mit mehreren Gruppen
224 result-single Template fuer ein Wahlergebnis mit einer Gruppe
225 result-proportional Template fuer ein Wahlergebnis, bei dem das Verhaeltnis
226 oder die Differenz von Ja- und Nein-Stimmen entscheidet
227 (z.B. Moderationsnachwahlen, "proportional=1" gesetzt)
228 rule-violated Fehlermail: Wahlregeln aus usevote.rul verletzt
229 voterlist Template fuer eine Waehlerliste (2. CfV)
230 votes-multi Template fuer eine Stimmenliste mit mehreren Gruppen
231 votes-single Template fuer eine Stimmenliste bei einer Gruppe
232 wrong-ballotid Fehlermail: Falsche Wahlscheinkennung angegeben
234 * Beim Programmlauf erstellte Dateien (Name ist konfigurierbar):
236 ergebnis.alle Saemtliche Einzelergebnisse zusammengefasst (wird
237 bei jedem Lauf von uvvote.pl neu erstellt)
238 errors.log Fehlermeldungen, die beim Programmlauf auftauchen,
239 werden hier abgelegt. Normalerweise bleibt die Datei
240 leer, ansonsten wird beim Programmende eine Warnung
241 mit Verweis auf die Datei ausgegeben.
242 uidlcache Eindeutige IDs der abgerufenen Mails (bei Benutzung
243 von POP3). Darf waehrend einer laufenden Abstimmung
244 keinesfalls geloescht werden, um Mehrfachzaehlung von
245 Stimmen zu verhindern.
246 uidlcache_req dto, fuer die Mailbox mit den Wahlscheinanforderungen
247 (bei Verwendung von personalisierten Wahlscheinen)
248 uidlcache_bounce dto, fuer die Mailbox mit den Bounces (wird von
249 uvbounce.pl ausgewertet)
250 usevote.lock Temporaere Lockdatei, um gleichzeitiges Ausfuehren
251 mehrerer Instanzen zu verhindern. Kann (falls vorhanden)
252 gefahrlos geloescht werden, wenn gerade keines der
253 Usevote-Scripts laeuft.
255 * Folgende Unterverzeichnisse werden von Usevote im aktuellen
256 Verzeichnis (CWD) angelegt:
258 fertig/ Verzeichnis fuer Archivierung verarbeiteter Dateien
259 tmp/ Verzeichnis fuer temporaere Dateien
261 * Von Usevote dort erstellte Dateien:
263 ack.* Bestaetigungsmails (in tmp/)
264 ack.control Steuerungsdatei fuer Bestaetigungsmails (in tmp/)
265 domail Shellscript zum Verschicken der Mails (in tmp/)
266 ergebnis.* Ergebnisdateien einzelner Durchlaeufe (zunaecht in tmp/,
267 spaeter nach fertig/ verschoben und archiviert)
268 stimmen.* Archivierte Stimmendateien (dto.)
271 5. Anfangs-Konfiguration
272 ========================
274 Zuerst solltest Du "usevote.cfg" fuer Dein System anpassen (Details
275 dort in den Kommentarzeilen und weiter hinten in dieser Dokumentation).
276 Unter Windows werden die Regular Expressions fuer die Stimmenerkennung
277 moeglicherweise lauter unlesbare Zeichen enthalten (anderer Zeichensatz),
278 dort sollten saemtliche in Namen vorkommende Umlaute und Buchstaben mit
279 Accents etc. aufgefuehrt werden. Weiter ist bei Nutzung von Windows zu
280 beachten, dass das Kommando zum Loeschen des Bildschirms "cls" und nicht
281 "clear" heisst. Dazu gibt es auch eine Einstellung in usevote.cfg. Den
282 standardmaessig eingestellten Pager "less" gibt es unter Windows zunaechst
283 nicht, more ist aber so buggy, dass man sich am besten "less" fuer
284 Windows herunterladen sollte:
285 http://www.greenwoodsoftware.com/less/less381d.zip
287 Im Unterverzeichnis "templates" findest Du Vorlagen, die fuer die
288 einzelnen Bestaetigungstexte, Mails, Wahlscheine und Waehlerlisten
289 verwendet werden. Hier kannst Du unter Beachtung der Syntax (siehe
290 gesonderte Dokumentation) alle Texte an Deinen Geschmack und Deine
291 Beduerfnisse anpassen.
294 6. Konfiguration fuer einzelne Abstimmungen
295 ===========================================
297 Fuer jede Abstimmung muss eine eigene Konfigurationsdatei geschrieben
298 werden. Aendere einfach usevote.cfg entsprechend der Regeln fuer die
299 betreffende Abstimmung. Falls Du haeufiger Wahlleiter spielst, solltest
300 Du Dir eine globale Konfigurationsdatei mit Standardeinstellungen
301 (z.B. als ~/.usevote-defaults.cfg) anlegen und in der usevote.cfg nur
302 noch die Einstellungen setzen, die sich fuer jede Abstimmunge aendern.
303 Die globale Datei kann am Anfang der usevote.cfg mit folgender Zeile
306 include ~/.usevote-defaults.cfg
308 Zu beachten ist aber, dass jeweils die letzte Definition einer Option
309 benutzt wird. Die usevote.cfg sollte daher wirklich nur noch
310 abstimmungsspezifische Einstellungen enthalten, um nicht versehentlich
311 die globalen Optionen zu überschreiben.
313 Ausserdem muss die Datei "usevote.rul" geprueft werden. Wenn Deine
314 Abstimmung irgendwelche speziellen Regeln enthaelt (z.B. man kann
315 nur fuer Gruppe x stimmen, wenn man auch fuer y gestimmt hat, oder man
316 muss fuer den .misc-Abschnitt stimmen, wenn man fuer irgendeinen
317 anderen Abschnitt gestimmt hat), dann solltest Du diese Datei lesen
318 und entsprechend aendern. Allerdings empfiehlt es sich, bereits im
319 RfD deutlich auf die Regeln hinzuweisen, die zur Anwendung kommen sollen.
320 Die eingegebenen Regeln koennen dann mit "uvvote -t" getestet werden.
322 Es ist auch moeglich, mehrere Abstimmungen gleichzeitig durchzufuehren,
323 ohne die .pl und .pm Dateien jedesmal mitzukopieren. Folgende Dateien
324 sollten im Abstimmungsverzeichnis vorhanden sein (notwendig ist nur
325 usevote.cfg, darin können alle anderen Pfade angepasst werden):
335 Ggf. sollte das "templates"-Verzeichnis kopiert werden, falls
336 individuelle Templates fuer einzelne Abstimmungen verwendet werden.
338 Außerdem muessen i.d.R. einige Pfade in der usevote.cfg angepasst
339 werden. Dadurch ist auch die Angabe eines anderen Verzeichnisses
340 fuer einige der oben genannten Konfigurationsdateien moeglich,
341 falls diese zentral gepflegt werden sollen (z.B. messages.cfg und
344 Damit die Usevote-Perlmodule gefunden werden, sollten sie im
345 selben Verzeichnis wie die Programmdateien liegen bleiben. Ansonsten
346 muss eine Umgebungsvariable gesetzt werden:
350 .. steht für das übergeordnete Verzeichnis. Ggf. muss hier ein
351 absoluter Pfad eingetragen werden, wenn das Abstimmungsverzeichnis
352 kein Unterverzeichnis des Usevote-Verzeichnisses ist.
354 Je nach Betriebssystem kann die obige Zeile etwas anders aussehen,
355 unter Windows sollte z.B. "SET PERL5LIB=C:\PERL\USEVOTE" in die
356 autoexec.bat aufgenommen oder sonstwie ausgeführt werden (Pfad
357 natürlich entsprechend anpassen).
360 7. Wahlschein generieren
361 ========================
363 Der Wahlschein ist ein Abschnitt des CfV, den die Leute zur Stimmabgabe
364 ausfuellen und zurueckschicken sollen. Am einfachsten erzeugst Du
365 diesen nach Anpassung der Konfiguration und ggfls. des Templates
366 mit "uvballot.pl". Folgendes Format ist erforderlich:
372 Eine zusaetzliche Beschreibung rechts daneben macht es dem Waehler
373 einfacher, ist aber fuer Usevote nicht zwingend erforderlich. Wichtig
374 sind nur die fortlaufenden Nummern, die entsprechend der Eintraege
375 in usevote.cfg zugeordnet werden.
377 Je nach Konfiguration koennen weitere Zeilen noetig sein, dazu spaeter.
379 Als Stimme in den eckigen Klammern werden diverse Strings erkannt,
380 die in usevote.cfg definiert werden koennen. JA, NEIN und ENTHALTUNG
381 sind Standard, einige Abwandlungen sind ebenfalls moeglich.
382 Zusaetzlich kann ANNULLIERUNG verwendet werden, um eine schon abgegebene
383 Stimme zu loeschen und somit nicht im Result aufzutauchen.
385 Bei der Verwendung von persoenlichen Wahlscheinen (Abschnitt 6a der
386 Wahlregeln fuer de.*) ist das Vorgehen etwas anders, siehe hierzu
387 den gesonderten Abschnitt weiter hinten.
390 8. Stimmen verarbeiten
391 ======================
393 Falls POP3 nicht benutzt werden soll (siehe usevote.cfg), werden alle
394 Wahlmails zu einer Abstimmung aus einer Mailboxdatei gelesen
395 (Name/Pfad der Datei in usevote.cfg einstellbar). Standardmaessig
396 wird das Unix-Mailboxformat erkannt, dieses ist aber ueber "mailstart"
397 in usevote.cfg konfigurierbar (bei komplett anderen Formaten muesste
398 der Quellcode geaendert werden).
400 Wechsele nun in das Verzeichnis, in dem die passenden
401 Konfigurationsdateien liegen (normalerweise werden diese aus
402 dem aktuellen Verzeichnis gelesen, was mehrere gleichzeitige
403 Verfahren moeglich macht) und starte uvvote.pl. Bei Problemen
404 mit einzelnen Stimmen wirst Du interaktiv durch Menues gefuehrt.
405 Meistens gibt es folgende Moeglichkeiten, die durch die
406 eingeklammerten Buchstaben und Zahlen aufgerufen werden koennen:
408 (0) Wahlschein mit Original vergleichen (diff)
409 (1) Anzeigen der Wahlmail
411 Bestaetigen oder Aendern von Wahlschein-Eigenschaften:
416 (6) Datenschutzklausel
419 (i) Diese Stimme ignorieren (ohne Benachrichtigung verwerfen)
422 Teilweise gibt es Unteroptionen:
423 (a) OK (Zweifel sind unbegründet, ist alles in Ordnung)
424 (b) Aendern (z.B. wenn der Realname von Usevote nicht vollstaendig
426 (c) Ungueltig (es handelt sich nach Deinem Ermessen nicht um
427 eine gueltige Stimmabgabe)
429 Nun solltest Du zunaechst mit (1) die Mail ansehen und anhand
430 der bemaengelten Punkte entscheiden, ob der Wahlschein gueltig
431 oder ungueltig ist bzw. welche Maengel tatsaechlich zutreffen.
432 Mit (0) kannst Du einen Dateivergleich zu einem vorher hinterlegten
433 Musterwahlschein ausfuehren ("diff"), um Aenderungen/Fehler schneller
436 Mit den Optionen (2) bis (7) kannst Du einzelne Eigenschaften
437 des Wahlscheins nachbessern (wenn Usevote z.B. einen Namen oder
438 eine Stimme nicht korrekt erkannt hat) oder auch einfach die
439 Korrektheit bestaetigen.
441 Wenn Du alle oben auf der Seite aufgelisteten Maengel beseitigst,
442 indem Du die entsprechenden Optionen waehlst, wird die Stimme
443 akzeptiert. Bleiben Zweifel unausgeraeumt, wird eine entsprechende
444 Fehlermail verschickt (Du erhaeltst dann noch eine gesonderte
447 Zum Schluss kannst Du (w) wählen, um fortzufahren. Möchtest Du,
448 dass eine Stimme komplett ignoriert wird (weil es sich z.B.
449 um Spam handelt), kannst Du (i) waehlen und die folgende
450 Sicherheitsfrage mit "JA" beantworten.
452 Ist uvvote.pl durchgelaufen, koennen im Unterverzeichnis tmp/
453 (wird ebenfalls aktuellen Verzeichnis angelegt!) die ermittelten
454 Ergebnisse und erzeugten Mails an die Waehler noch einmal geprueft
455 werden. Ist alles in Ordnung, werden mittels "uvvote.pl clean"
456 die Mails verschickt und die Ergebnisse gespeichert sowie die
457 Originalmails archiviert. Hierzu wird das Verzeichnis fertig/
460 Falls der komplette uvvote-Lauf verworfen werden soll, kann
461 die Datei mit den Waehlermails (stimmen-xyz im tmp-Verzeichnis,
462 xyz entspricht der aktuellen Unixtime waehrend des Durchlaufs)
463 wieder an den urspruenglichen Platz zurueckkopiert werden
464 (bei POP3: fuer den Neuversuch POP3 abschalten und die
465 Maildatei einlesen lassen, da auf dem Server die Mails
466 moeglicherweise geloescht wurden) und das komplette tmp-Verzeichnis
467 geloescht werden. Anschliessend den uvvote-Lauf erneut durchfuehren.
468 Wichtig ist nur, dass das Verzeichnis fertig/ waehrend der ganzen
469 Abstimmung mitsamt seines Inhaltes erhalten bleibt.
471 Noch ein kurzes Wort zum Verschicken der Mails: Jede Mail wird
472 in einer gesonderten durchnummerierten Datei (ack.1, ack.2, ...)
473 gespeichert, zusaetzlich wird eine Steuerungsdatei ("ack.control")
474 erzeugt, welche zu jeder Mail Dateinamen und Empfaenger auflistet.
475 Je nach Einstellung werden die Mails dann per SMTP verschickt oder
476 es wird ein Shellscript ("domail") erzeugt, welches nach und
477 nach die Mails in Sendmail einspeist. Zwecks Serialisierung ist
478 in usevote.cfg die Einstellung "sleepcmd" konfigurierbar,
479 normalerweise wird ein "sleep 1" nach jeder Mail ausgefuehrt.
480 Das Verschicken der Mails (und damit ggfls. der Aufruf von "domail")
481 erfolgt automatisch mit "uvvote.pl clean".
483 Unter Windows ist nur SMTP moeglich, es sei denn, es gibt
484 die Befehle sendmail, sleep und rm ;-)
487 9. Unzustellbare Bestaetigungen
488 ===============================
490 Leider kommt es immer mal wieder vor, dass jemand bei der Abstimmung
491 eine ungueltige Mailadresse angegeben hat. In diesem Fall erhaeltst Du
492 einen Bounce an die Absenderadresse zurueck (diese laesst sich in
493 usevote.cfg mit der Option "envelopefrom" einstellen bzw. bei
494 direkten Aufruf eines Mailers über die entsprechende Kommandozeilenoption
495 in der mailcmd-Einstellung, z.B. bei Sendmail -f). Du solltest
496 solche Fehlermails in einer gesonderten Datei speichern oder in
497 einem gesonderten POP3-Postfach halten und beim Erstellen
498 des 2. CfVs und des Results uvbounce.pl aufrufen.
500 Ausgegeben wird von uvbounce.pl eine Liste mit ungueltigen Adressen,
501 die einfach an den Abschnitt "ungueltige Stimmen" des 2. CfVs bzw.
502 Results angehaengt werden kann. Nicht vergessen, die Stimmen manuell
503 aus der Liste der gueltigen Stimmen zu loeschen (falls Du die
504 Policy verfolgst, nur Stimmen mit gueltiger Absenderadresse zu werten,
505 was empfehlenswert ist) und bei Bedarf das Ergebnis zu korrigieren!
511 Zum Erstellen des 2. CfVs kannst Du erst einmal den 1. CfV als Vorlage
512 benutzen. Am Ende sollte allerdings eine Liste der Personen folgen,
513 die bereits abgestimmt haben. Diese laesst sich mit "uvcount.pl -l"
514 erzeugen. Moeglicherweise fragt uvcount.pl wegen scheinbar doppelter
515 Stimmabgaben nach und bietet an, eine oder beide Stimmen zu ignorieren.
516 Du solltest das dann genauer untersuchen und die passende Wahl treffen.
518 Vorsicht bei doppelten Namen: Es gibt einige doppelt vorkommende
519 Namen, hinter denen sich voellig unterschiedliche Personen
520 verbergen! Die Mailadresse sollte in solchen Faellen Auskunft
521 geben koennen, notfalls einmal nachfragen.
523 Das Endergebnis kannst Du mit "uvcount.pl -r" ausgeben lassen.
524 Bei Verfahren mit mehreren Abstimmungspunkten wird automatusch
525 das folgende tabellarische Format verwendet:
527 Ja Nein : 2/3? >=60? : ang.? : Gruppe
528 ==== ==== : ==== ===== : ===== : =======================================
529 100 70 : Nein Ja : Nein : Einrichtung von xyz
531 Bei Abstimmungen ueber nur einen Punkt gibt es auch die Moeglichkeit,
532 einen einfachen beschreibenden Text zu verwenden:
533 "Es gab 100 JA und 70 NEIN-Stimmen ...".
535 Falls in usevote.cfg die Einstellung "multigroup = 1" gesetzt ist,
536 wird immer die tabellarische Form gewaehlt, bei "multigroup = 0"
537 benutzt uvcount.pl bei nur einem Abstimmungspunkt den beschreibenden
538 Text. Überschreiben laesst sich dieses mit Aufrufparametern:
540 uvcount.pl -r -m = Tabellarisch (m = multigroup)
541 uvcount.pl -r -o = Text (o = onegroup)
543 Falls in usevote.cfg die Option "proportional = 1" aktiviert ist,
544 wird standardmaessig folgendes Ausgabeformat angewandt:
546 Ja Nein : J>=N? Ja/Nein : ang.? : Gruppe
547 ==== ==== : ===== ======= : ===== : ====================================
548 100 70 : Ja 1.429 : : Einrichtung von abc
549 80 90 : Nein 0.888 : : Einrichtung von xyz
551 Das genaue Aussehen ist im Template "result-proportional" aenderbar,
552 die Bedingungen und Auswertungsformeln sind ueber usevote.cfg
553 einzustellen (prop_formula und condition1). Die Spalte "ang.?" muss
554 in diesem Fall manuell ausgefüllt werden, da manchmal auch mehrere
555 Abstimmungsgegenstände angenommen werden, z.B. bei Moderationsnachwahlen
556 für verschiedene Posten.
558 Die Waehlerliste mit abgegebenen Stimmen erzeugst Du mit
559 "uvcount -v". Diese Option laesst sich auch mit -r kombinieren,
560 so dass Du Dir das doppelte Aussortieren von Duplikaten sparst.
561 Wichtig: Diese Liste darf erst im Result veroeffentlicht werden,
564 Falls ein trivialer Schutz vor Spammern gewuenscht ist, koennen durch
565 eine Aenderung in den Template "voterlist", "votes-single", "votes-multi"
566 und "bouncelist" alle Mailadressen verfremdet werden. Entweder Du fuegst
567 folgende Definition ein:
569 mail := value mail | replace '@' ' -at - '
571 Oder Du veraenderst direkt die vorgegebenen Formate, indem Du
572 die Mailadresse mit Hilfe des Pipe-Symbols durch die replace-Funktion
575 multi-line := value mail | replace '@' ' -at- ' | justify-behind name 72
577 Die Replace-Funktion erwartet wie im Beispiel gezeigt zwei Werte,
578 die zu ersetztende Zeichenfolge (hier das '@') und eine neue Zeichenfolge,
579 die statt dessen eingesetzt werden soll und frei gewaehlt werden kann.
581 Wie bereits beschrieben, sollte am Ende des 2. CfVs bzw. Results noch die
582 Liste der gebouncten Mailadressen angehaengt werden (z.B. mit dem Programm
583 uvbounce.pl) und bei Bedarf die urspruenglichen Stimmen geloescht und das
584 Ergebnis korrigiert werden.
590 Zum Schutz der deutschen Wahlleiter wurden spezielle Klauseln
591 aufgenommen, die vom Waehler die Erlaubnis zur Verarbeitung
592 der Stimme verlangen. Die Option "bdsg" in usevote.cfg schaltet
593 diese Sonderbehandlung ein oder aus. Folgende Besonderheiten
594 gelten bei Aktivierung:
596 - Im Wahlschein ist ein spezieller Hinweistext enthalten, der
597 aus der Datei bdsgtext.cfg genommen wird. Beim Verarbeiten
598 abgegebener Stimmen wird der Abschnitt wieder mit der Datei
599 verglichen. Fehlt er oder wurde er veraendert, wird der
600 Wahlschein dem Wahlleiter zur Kontrolle vorgelegt.
601 Die Fehlerpruefung ignoriert Quote- und Leerzeichen sowie
602 Zeilenumbrueche, kann aber versagen, wenn dem Quotezeichen
603 Initialen vorangestellt sind (wie in manchen Mailboxnetzen
604 ueblich) oder eine Silbentrennung ueber den Text gelaufen ist.
606 - Ausserdem enthaelt der Wahlschein eine spezielle Frage,
607 die mit JA zu beantworten ist. Anderenfalls muss ebenfalls
608 Kontrolle durch den Wahlleiter erfolgen. Der Text dieser
609 Frage ist ueber usevote.cfg einzustellen.
611 Erfolgt eine derartige Kontroll-Vorlage beim uvvote.pl-Lauf,
612 sollte der Wahlleiter sich den Wahlschein genau anschauen
613 und dann entweder im Menue die Option (6)(a) waehlen oder
614 mit (w) fortfahren. Im letzteren Fall wird die Stimme
615 verworfen und eine Hinweismail zurueckgeschickt.
617 Wenn eine Wahlbestaetigung veraendert und zurueckgeschickt
618 wird, fehlt der entsprechende Datenschutzhinweis. Da in
619 diesem Fall die Zustimmung aber bereits bei der ersten
620 Stimmabgabe gegeben wurde, kann der Wahlleiter beruhigt
621 die Korrektheit wie oben beschrieben bestaetigen.
624 12. Personalisierte Wahlscheine
625 ===============================
627 Die Wahlregeln fuer de.* sehen im Abschnitt 6a ein Verfahren
628 mit persoenlichen Wahlscheinen vor, die mit einer speziellen
629 Kennung versehen mehr Sicherheit vor Manipulation bieten.
631 Um dieses Verfahren einzuschalten, muss zunaechst die Option
632 "personal = 1" in usevote.cfg gesetzt werden und das Template
633 "ballot-personal" im Unterverzeichnis "templates" um den Text
634 des CfVs erweitert werden (einfach statt des von Sternchen
635 umrandeten Kommentars in der Datei einfuegen). Bitte eventuell
636 im Text vorkommende eckige Klammern wie folgt unschaedlich
637 machen: \[Text\] (Backslash voranstellen), da in den Templates
638 diese Klammern spezielle Bedeutungen haben (siehe gesonderten
639 Abschnitt zu dem Thema in dieser Datei).
641 Der gepostete CfV enthaelt i.d.R. nur einen Dummy-Abschnitt
642 mit Hinweis auf die gesonderte Wahlscheinanforderung. So ein
643 Abschnitt kann mit uvballot.pl generiert werden.
645 Der dana-Moderation sollte beim Einreichen des CfVs auch
646 ein Dummy-Wahlschein mitgesendet werden, wie er bei der
647 Wahlscheinanforderung verschickt wird. Dieser laesst sich mit
648 "uvcfv.pl -t" erzeugen.
650 Die eingehenden Wahlscheinanforderungen sollten an eine
651 spezielle Mailadresse gehen und dann mit uvcfv.pl verarbeitet
652 werden. Je nach Konfiguration in usevote.cfg werden die
653 Mails aus einer Mailboxdatei oder per POP3 eingelesen und jeweils
654 mit einem personalisierten Wahlschein beantwortet. Bitte vor
655 dem Posten des CfVs einen Test durchfuehren, um sicherzustellen,
656 dass die generierten Wahlscheine korrekt sind und auch bei
657 der Auswertung akzeptiert werden (hierbei wird die speziell
658 eingefuegte Wahlscheinkennung in Verbindung mit der Absenderadresse
662 13. Die einzelnen Programme
663 ===========================
666 Generiert den Wahlschein fuer den CfV. Bei personalisierten
667 Wahlscheinen (personal = 1 in usevote.cfg) wird nur ein Dummy-
668 Abschnitt mit Hinweisen zur Wahlscheinanforderung ausgegeben.
670 Die Vorlage fuer den Wahlschein ist im templates-Unterverzeichnis
672 - ballot Standard-Wahlschein (personal=0)
673 - ballot-request Dummy-Abschnitt mit Hinweisen zur
674 Wahlscheinanforderung (personal=1)
675 - ballot-personal Wahlschein mit Scheinkennung, wird von
680 -c config_file liest die Konfiguration aus config_file
681 (usevote.cfg falls nicht angegeben)
683 --help zeigen einen Hilfetext an
687 Liest Bounces aus den uebergebenen Dateien oder aus einer POP3-
688 Mailbox ein (Verhalten haengt von usevote.cfg ab) und generiert
689 eine Liste von unzustellbaren Adressen, die an den 2. CfV oder das
690 Result angehaengt werden kann. Falls POP3 in usevote.cfg
691 eingeschaltet und die Option -f (siehe unten) nicht benutzt wurde,
692 werden die uebergebenen Dateinamen ignoriert.
694 Die Mails werden aus den uebergebenen Mailboxdateien geloescht
695 und statt dessen in einer neuen Datei mit der Erweiterung ".processed"
698 Die Vorlage fuer die ausgegebene Liste ist im templates-
699 Unterverzeichnis konfigurierbar (Datei "bouncelist").
703 -c config_file liest die Konfiguration aus config_file
705 --file dateiname(n) lesen die Bounces aus den uebergebenen Dateien,
706 auch wenn in der Konfigurationsdatei POP3
707 eingeschaltet ist. Diese Option wird benoetigt,
708 falls zwar die Stimmzettel per POP3 eingelesen
709 werden sollen, nicht aber die Bounces.
710 Die Dateinamen werden durch Leerzeichen getrennt.
712 --help zeigen einen Hilfetext an
717 Liest Mailboxen ein und beantwortet alle Mails mit personalisierten
718 CfVs (falls personal=1 in usevote.cfg).
720 Die Vorlage fuer die ausgegebene Liste ist im templates-
721 Unterverzeichnis konfigurierbar (Datei "ballot-personal").
725 -c config_file liest die Konfiguration aus config_file
726 (usevote.cfg falls nicht angegeben)
728 --test gibt einen Dummy-Wahlschein mit Scheinkennung
729 an der Standardausgabe aus, zur Pruefungszwecken
731 --help zeigen einen Hilfetext an
736 Zaehlt Stimmen und gibt Waehlerlisten aus. Dient zur Erstellung
737 von 2.CfV und Result.
739 Es werden die folgenden Vorlagen aus dem templates-Unterverzeichnis
742 - result-multi Ergebnisauszaehlung bei mehreren Gruppen
743 - result-single Ergebnisauszaehlung bei nur einem Abstimmungs-
744 gegenstand (nicht tabellarisch, sondern im
745 Fliesstext), falls in usevote.cfg multigroup=0
746 gesetzt ist oder die Option -o verwendet wird
748 - voterlist Reine Auflistung der bisherigen Waehler ohne
749 Stimmen (fuer 2. CfV)
750 - votes-multi Stimmenliste im Mehrgruppenformat (eine Liste
751 mit allen Waehlern, rechts daneben die jeweils
753 - votes-single Stimmenliste im Eingruppenformat (getrennte
754 Listen mit Ja-, Nein- und Enthaltungsstimmen)
758 -c config_file liest die Konfiguration aus config_file
759 (usevote.cfg falls nicht angegeben)
760 -f result_file liest die Stimmen aus result_file (ueberschreibt
761 die "resultfile"-Angabe aus der Konfigurationsdatei)
763 --list Geben eine Liste aller Waehler aus (ohne Stimmen).
765 --voters Wie --list, aber mit Angabe der abgegebenen Stimmen.
767 --result Ausgabe des Endergebnisses (kann mit --list oder
768 --voters kombiniert werden).
770 --multigroup Benutzt auch bei Eingruppenabstimmungen das
771 Mehrgruppenformat beim Endergebnis (ueberschreibt
772 die Einstellung aus usevote.cfg).
773 Nur in Kombination mit --result verwendbar,
774 schliesst --onegroup aus.
776 --onegroup Benutzt bei Eingruppenabstimmungen immer das
777 Eingruppenformat beim Endergebnis (ueberschreibt
778 die Einstellung aus usevote.cfg).
779 Nur in Kombination mit --result verwendbar,
780 schliesst --multigroup aus.
782 --nodup Verzichtet auf das Aussortieren von doppelten
783 Stimmabgaben. Nicht empfohlen!
785 --help zeigen einen Hilfetext an
791 Liest Mailboxen aus einer Datei oder per POP3 ein wertet die Mails
792 als Stimmzettel aus. Erst beim Aufruf mit der Option "clean" werden
793 die Ergebnisse endgueltig gespeichert und die Bestaetigungsmails
796 Es werden diverse Vorlagen aus dem templates-Unterverzeichnis
797 benutzt, um Bestaetigungs- und Fehlermails zu generieren.
801 -c config_file liest die Konfiguration aus config_file
802 (usevote.cfg falls nicht angegeben)
804 --test fuehrt einen Test der Konfiguration durch und
805 gibt das ermittelte Ergebnis aus.
807 --help zeigen einen Hilfetext an
811 14. Die Konfigurationsdateien
812 =============================
817 Diese Datei enthaelt einen regulaeren Ausdruck (Perl-Syntax) pro
818 Zeile. Passt die Mailadresse eines Abstimmenden auf eines der Muster,
819 wird dem Wahlleiter bei der Auswertung eine Warnung angezeigt.
820 In der Regel kann man diese ignorieren, weil heutzutage viele
821 Privatleute ihre eigene Domain haben und Role-Accounts wie news@
822 benutzen. Sieht man aber so etwas wie news@t-online.de ist
823 Vorsicht angebracht und man sollte durch Auswahl von "(W)eiter"
824 die Stimme ungueltig werten und eine entsprechende Fehlermail
825 zurueckschicken lassen.
831 Hier sind alle kuerzeren Texte enthalten, die Usevote ausgibt,
832 unabhaengig davon, ob sie nur dem Wahlleiter bei der Programmausfuehrung
833 ausgegeben werden oder in persoenlichen Mails bzw. dem Result
834 auftauchen. Laengere Textpassagen sind als eigene Dateien im
835 "templates"-Verzeichnis zu finden und bieten weitergehende
836 Formatierungsmoeglichkeiten.
838 Jede Zeile in der messages.cfg besteht aus einem Identifier, einem
839 Gleichheitszeichen und dem eigentlichen Text. Der Identifier ist
840 grundsaetzlich in Grossbuchstaben gehalten und vom Programmcode fest
841 vorgegeben. Aenderungen duerfen nur rechts vom Gleichzeichen vorgenommen
842 werden, wenn Dir z.B. Formulierungen nicht gefallen oder Du anders-
843 sprachige Ausgaben haben moechtest.
845 Variablen sind ueber ${VARIABLE} einzubauen, allerdings sind die
846 Variablennamen und deren Inhalte vom Programmcode vorgegeben und
847 sollten beibehalten werden. Es gibt keine vordefinierten Variablen,
848 die Du selbst einbauen kannst, es sei denn, Du erweiterst den
849 Programmcode an der entsprechenden Stelle.
851 Die einzigen Texte, die fest im Programmcode stehen, sind die
852 Hilfetexte der einzelnen Programme (ueber die Option -h oder --help
853 aufrufbar) sowie die Startmeldungen (Copyright etc.) und initiale
854 Fehlermeldungen (usevote.cfg oder messages.cfg nicht gefunden,
855 ungueltige oder falsch kombinierte Aufrufparameter).
861 Mit dieser Datei koennen spezielle Regeln fuer eine gueltige Stimmabgabe
862 bei Mehrgruppenabstimmungen erstellt werden, z.B. dass man Punkt 3 oder 4
863 waehlen muss, wenn man fuer Punkt 2 gestimmt hat (quasi als weitergehende
864 Auswahlmoeglichkeit). Solche Regeln verkomplizieren aber die Abstimmung
865 und sollten nur in Ausnahmefaellen benutzt werden. Urspruenglich gedacht
866 war diese Moeglichkeit z.B. fuer .misc Gruppen, die zwangsweise bei einer
867 Aufteilung mit angelegt werden mussten. Dadurch, dass das in den
868 Wahlregeln fuer de.* als Automatismus eingebaut ist, kann man sich
869 so etwas meistens sparen. Fuer den Fall, dass bei einer vorgeschlagenen
870 neuen Gruppe der Name noch unklar ist, gibt ebenfalls das Benutzen
871 von speziellen Wahlregeln wenig Sinn, da man auch eine Meinung ueber
872 den Gruppennamen haben kann, wenn man eigentlich gegen die Gruppe ist.
874 Wenn Du aber ein Verfahren betreust, in dem Du solche Sonderregeln
875 benoetigst, kannst Du eine Regel pro Zeile in der folgenden Syntax schreiben:
879 Eine Regel beginnt immer mit "if", und danach folgen eine Anzahl Symbole;
880 diese Anzahl muss gleich der Anzahl der Gruppen sein, ueber die abgestimmt
881 wird. Oben geht es also um eine Abstimmung ueber sechs Gruppen.
882 Die Symbole hinter "if" geben an, in welchem Fall diese Regel Anwendung
883 finden soll. Falls sie zutrifft, wird die Bedingung hinter "then"
884 geprueft (dort muessen nochmal so viele Symbole folgen, wie Gruppen
885 im Wahlschein vorkommen). Ist diese Bedingung nicht erfuellt, wird
886 der Wahlschein dem Wahlleiter als regelverletzend vorgelegt, und
887 wenn diese mit "(w)eiter" den Fehler bestaetigt, wird eine entsprechende
888 Fehlermeldung zurueckgeschickt und die Stimme als ungueltig gewertet.
890 Folgende Symbole sind erlaubt:
895 S eine JA- oder NEIN-Stimme
896 H eine Enthaltung oder JA-Stimme
897 I eine Enthaltung oder NEIN-Stimme
898 . egal (Ja, nein oder Enthaltung)
899 j eine oder mehrere der markierten Gruppen hat JA-Stimme
900 n "" "" "" "" "" "" "" NEIN-Stimme
901 e "" "" "" "" "" "" "" Enthaltung
902 s "" "" "" "" "" "" "" Ja- oder Nein-Stimme
903 h "" "" "" "" "" "" "" Enthaltung oder Ja-Stimme
904 i "" "" "" "" "" "" "" Enthaltung oder Nein-Stimme
906 Hier noch ein Beispiel:
911 Diese Regeln sagen: Wer fuer die erste Gruppe abstimmt, der muss auch
912 fuer die zweite und dritte Gruppe abstimmen - egal wie. Ausserdem muss er
913 (Regeln 2 und 3) sich bei 3 enthalten, wenn er bei 2 eine Stimme abgibt
914 und umgekehrt. Die vierte Gruppe wird hier gar nicht betroffen.
920 Dieses ist die zentrale Konfigurationsdatei fuer Usevote. Einige
921 Einstellungen sind nur einmal auf das System und Deine Gewohnheiten
922 anzupassen, andere muessen fuer jede Abstimmung geaendert werden.
923 Alle Einstellungen sind mit mehr oder weniger sinnvollen
924 Standardwerten vorgegeben, die sich bei leerer usevote.cfg mittels
925 "uvvote.pl -t" ermitteln lassen.
927 Es lassen sich durch eine Zeile "include dateiname" weitere
928 Konfigurationsdateien einbinden. Die Stelle, an der dieses geschieht,
929 ist dabei wichtig, da die usevote.cfg von oben nach unten gelesen
930 wird (zusätzlich eingebundene Konfigurationsdateien werden an der
931 Stelle der "include"-Zeile eingefügt) und bei mehrmals vorkommenen
932 Optionen der jeweils letzte gesetzte Wert benutzt wird.
933 Daher sollte eine Datei mit systemweiten Defaults am besten am
934 Anfang der usevote.cfg eingebunden werden, die dort gesetzten
935 Optionen sollten aber unbedingt aus der usevote.cfg geloescht werden,
936 damit die systemweiten Einstellungen nicht gleich wieder ueberschrieben
939 Das Format ist allgemein:
943 Der Wert muss in manchen Faellen 0 (=aus) oder ungleich 0 (=an) sein,
944 in anderen Faellen muss eine exakte Zahl oder Zeichenkette eingegeben
947 Alles, was hinter einem # Zeichen steht, wird als Kommentar gewertet
948 und ignoriert. Steht hinter einem Wert so ein Kommentar, wird
949 normalerweise alles bis zum Kommentarzeichen noch in den String
950 einbezogen. In so einem Fall sollte der Wert von Anfuehrungszeichen
951 umschlossen werden. Im folgenden Beispiel wird ein Dateiname
954 # Der Dateiname endet mit 10 Leerzeichen (bis zum Kommentarzeichen):
955 tpl_mailheader = mailheader # Kommentar
957 # Der Dateiname enthaelt keine Leerzeichen, da mit Anfuehrungsstrichen
959 tpl_mailheader = "mailheader" # Kommentar
961 Folgt kein Kommentar in der selben Zeile, koennen die Anfuehrungsstriche
964 Hier eine Auflistung der immer anzupassenden Optionen
965 (BOOL bedeutet, dass 0 (aus) oder 1 (an) eingetragen werden muss):
967 votename Name der Abstimmung
968 group1 Erster Abstimmungsgegenstand
969 group2 Zweiter (und so weiter durchnummerieren)
970 sampleballotfile Datei mit Musterwahlschein aus dem CfV fuer Dateivergleich (diff)
971 votefile Mailbox mit eingehenden Stimmen (falls POP3 ausgeschaltet)
972 mailboxtype Typ der Mailbox (mbox, maildir)
973 personal Personalisierte Wahlscheine verwenden? [BOOL]
974 (siehe gesonderten Abschnitt weiter oben)
975 voteaccount Mailadresse, unter der abgestimmt werden kann
976 (Reply-To im CfV auf diese Adresse setzen)
977 requestfile Datei mit Anforderungsmails bei "personal=1", falls
978 POP3 ausgeschaltet ist
979 bdsg Datenschutzklausel generieren und auf deren Existenz
980 pruefen? [BOOL] (siehe gesonderten Abschnitt weiter oben)
981 replyto Reply-To Header auswerten? [BOOL] (nicht empfohlen und in
982 de.* von den GVV nicht praktiziert)
983 voteack Jede Stimme mit einer Bestaetigungsmail beantworten? [BOOL]
985 mailcc weitere Mailadresse, an die eine Kopie jeder Bestaetigungs-
986 oder Fehlermail geschickt wird (fuer Archivzwecke)
987 onestep Mails direkt verschicken und Ergebnisse speichern? [BOOL]
988 ("uvvote clean" Aufruf entfaellt)
989 multigroup Fuer das Ergebnis auch bei Eingruppenabstimmung des
990 Mehrgruppenformat waehlen? [BOOL]
991 condition1 Bedingungen fuer einen Erfolg der Abstimmung in Perl-Syntax
992 condition2 (normalerweise "$yes>=2*$no" und "$yes>=60"
993 resultfile Datei fuer Gesamtergebnis (normalerweise ergebnis.alle)
994 idfile Datei mit Scheinkennungen (bei "personal=1")
995 pop3 POP3 benutzen? [BOOL] (andernfalls Stimmen aus Datei lesen)
996 pop3server POP3-Server fuer eingehende Wahlscheine
997 pop3port POP3-Serverport (normalerweise 110)
998 pop3user Benutzername
1000 pop3delete Mails nach Abruf vom Server loeschen? [BOOL]
1001 pop3uidlcache Dateiname zum Speichern bereits abgerufener Mail-IDs (UIDL)
1002 pop3*_req entsprechende Optionen fuer Mailbox mit eingehenden
1003 Wahlscheinanforderungen (bei "personal=1")
1004 pop3*_bounce entsprechende Optionen fuer Mailbox mit Bounces (Fehlermails)
1005 fuer die Verarbeitung durch uvbounce.pl
1006 smtp SMTP zum Verschicken von Mails benutzen? [BOOL]
1007 Andernfalls wird direkt an den MTA uebergeben (nur Unix)
1008 smtpserver SMTP-Server
1009 smtpport SMTP-Serverport (normalerweise 25)
1010 smtpauth SMTP-Authentication nach RFC 2554 benutzen? [BOOL]
1011 smtpuser SMTP-Benutzername
1012 smtppass SMTP-Passwort
1013 smtphelo String fuer die HELO-Greeting bei SMTP (Default: Hostname)
1014 fqdn String fuer den Host-Teil der Message-ID
1015 (Fully Qualified Domain Name) (Default: Hostname)
1016 archivedir Verzeichnis fuer Archivierung von verarbeiteten Stimmen
1017 tmpdir temporaeres Verzeichnis
1018 templatedir Verzeichnis mit Templates (Vorlagen) fuer diverse Zwecke
1019 (normalerweise "templates", dort liegen bereits vordefinierte
1020 Templates, die i.d.R. nicht angepasst zu werden brauchen)
1021 formats Konvertierungsfunktionen fuer die Templates, mit Komma getrennt
1022 (mitgelieferte UVformats.pm muss hier aufgefuehrt werden,
1023 desweiteren koennen eigene Module mit weiteren Funktionen
1024 hier eingebunden werden)
1025 controlfile Name der Steuerungsdatei fuer den Mailversand (tmp/ack.control)
1026 domailfile Name des Shellscripts zum Versenden der Bestaetigungsmails
1027 (falls smtp=0, normalerweise tmp/domail)
1028 mailcmd Aufruf des Mail Transfer Agents (MTA) zum Verschicken der
1029 Bestaetigungsmails (falls smtp=0), z.B.
1030 "sendmail -oi -oem -femail@adresse"
1031 sleepcmd Weiteres Kommando, welches nach jeder Mail aufgerufen werden
1032 soll (falls smtp=0). Sinnvoll ist ein "sleep x", wobei x bei
1033 langsamen Systemen hoeher gewaehlt werden sollte.
1034 clearcmd Shellbefehl zum Loeschen des Bildschirms (Standard: clear),
1035 muss unter Windows auf "cls" geaendert werden. Falls Shell
1036 oder Betriebssystem keinen solchen Befehl bereitstellen,
1037 sollte ein Kommando verwendet werden, welches eine Trennlinie
1038 oder aehnliches auf dem Bildschirm ausgibt, z.B. mit "echo"
1039 diff Shellbefehl zum Dateivergleich (diff); es koennen auch
1040 Parameter angegeben werden, z.B. "diff -u". Das verwendete
1041 Programm muss das Lesen einer Datei von STDIN erlauben
1042 ("-" statt Dateinamen fuer Einlesen von Standardeingabekanal)
1043 pager Shellbefehl zum seitenweisen Darstellen von Mails auf dem
1044 Bildschirm (normalerweise "less"). Unter Windows muss "more"
1045 benutzt werden, unter Unix hingegen gibt es moeglicherweise
1046 bei "more" Probleme mit der Umleitung von STDERR in eine Datei
1047 (wie es z.B. von uvvote.pl benoetigt wird), daher ist "less"
1049 mailfrom Absender fuer den From-Header der Bestaetigungsmails. Wird
1050 auch in Bestaetigungsmails als Unterschrift eingefuegt und
1051 sollte daher am besten in folgendem Format sein:
1052 Vorname Nachname <gvv@foo.bar>
1053 (ohne Anfuehrungsstriche, falls rfc-konform moeglich)
1054 envelopefrom Absender fuer den Envelope (Return-Path) der Bestaetigungsmails
1055 bei Verwendung von SMTP (bitte nur die Adresse eintragen, ohne
1056 Klammern und Zusaetze). Wenn SMTP ausgeschaltet ist, muss
1057 diese Einstellung entsprechend der Mailer-Doku in "mailcmd"
1058 gesetzt werden (z.B. bei Sendmail und kompatiblen mit -f)
1059 messagefile Datei mit diversen Meldungen und Textfragmenten (messages.cfg)
1060 rulefile Datei mit Wahlregeln (usevote.rul)
1061 badaddrfile Datei mit verdaechtigen Mailadressen (mailpatterns.cfg)
1062 errorfile Datei fuer Fehlermeldungen beim Programmlauf (errors.log)
1063 mailstart Einleitungszeile fuer naechste Mail (RegExp), falls Mails
1064 aus einer Datei eingelesen werden (smtp=0), normalerweise
1066 begin_divider Trennlinien vor und nach dem Wahlschein
1067 end_divider ("Alles vor/nach dieser Zeile bitte loeschen")
1068 nametext Text fuer die Namens-Angabe im Wahlschein. Muss im
1069 Wahlschein genauso stehen und wird beim Standardtemplate
1070 auch aus dieser Einstellung uebernommen. Beispieltext:
1071 "Dein Realname, falls nicht im FROM-Header:"
1072 nametext2 Text fuer Namens-Angabe in Bestaetigungsmails
1073 (dito, Standardwert "Waehlername:")
1074 addresstext Text fuer die Adress-Angabe im Wahlschein
1075 (dito, Standardwert "Waehleradresse:")
1076 ballotidtext Text für die Angabe der Wahlscheinkennung (falls personal=1)
1077 (dito, Standardwert "Wahlscheinkennung:")
1078 bdsgtext Text fuer Datenschutzklausel (falls bdsg=1), erscheint als
1079 Abstimmungspunkt (z.B. "Datenschutzklausel - Zustimmung: Ich
1080 bin mit der Verarbeitung meiner Daten wie oben beschrieben
1082 bdsgfile Datei mit Erklaerungstext fuer BDSG-Klausel (bdsgtext.cfg)
1083 rightmargin Zeilenbreite bei Ausgaben, die nicht durch Templates
1084 gesteuert werden. Hat vor allem auf Bildschirmausgaben
1086 name_re Regulaerer Ausdruck fuer Erkennung eines gueltigen Realnamens.
1087 Beispiel: "[a-zA-ZäöüáàâéèêíìîóòôúùûÄÖÜÁÁÂÉÈÊÍÌÎÓÒÔÚÙÛß-]{2,} +
1088 .*[a-zA-ZäöüáàâéèêíìîóòôúùûÄÖÜÁÁÂÉÈÊÍÌÎÓÒÔÚÙÛß]{2,}"
1089 (muss ohne Umbruch in eine Zeile)
1091 Regulaere Ausdruecke fuer Erkennung der Stimmen
1092 (Gross-/Kleinschreibung spielt keine Rolle):
1094 ja_stimme Standardwert: (J\s*A|J|(D\s*A\s*)?F\s*U\s*E\s*R)
1095 nein_stimme Standardwert: (N\s*E\s*I\s*N|N|(D\s*A\s*)?G\s*E\s*G\s*E\s*N)
1096 enth_stimme Standardwert: (E|E\s*N\s*T\s*H\s*A\s*L\s*T\s*U\s*N\s*G)
1097 ann_stimme Standardwert: A\s*N\s*N\s*U\s*L\s*L\s*I\s*E\s*R\s*U\s*N\s*G
1099 Definition der verwendeten Templatedateien
1100 (werden im Unterverzeichnis "templates" mitgeliefert):
1102 tpl_mailheader "mailheader" # generally used mail header
1103 tpl_bouncelist "bouncelist" # used by uvbounce.pl
1104 tpl_result_multi "result-multi" # used by uvcount.pl -r -m
1105 tpl_result_single "result-single" # used by uvcount.pl -r -o
1106 tpl_votes_multi "votes-multi" # used by uvcount.pl -v (multiple groups)
1107 tpl_votes_single "votes-single" # used by uvcount.pl -v (single group only)
1108 tpl_voterlist "voterlist" # used by uvcount.pl -l (2nd CfV)
1109 tpl_ballot "ballot" # used by uvballot.pl (personal = 0)
1110 tpl_ballot_request "ballot-request" # used by uvballot.pl (personal = 1)
1111 tpl_ballot_personal "ballot-personal" # used by uvcfv.pl (personal = 1)
1112 tpl_addr_reg "address-not-registered" # used by uvvote.pl (personal = 1)
1113 tpl_no_ballotid "no-ballotid" # used by uvvote.pl (personal = 1)
1114 tpl_wrong_ballotid "wrong-ballotid" # used by uvvote.pl (personal = 1)
1115 tpl_bdsg_error "bdsg-error" # used by uvvote.pl (bdsg = 1)
1116 tpl_ack_mail "ack-mail" # used by uvvote.pl (voteack = 1)
1117 tpl_cancelled "cancelled" # used by uvvote.pl
1118 tpl_invalid_account "invalid-account" # used by uvvote.pl
1119 tpl_invalid_name "invalid-name" # used by uvvote.pl
1120 tpl_multiple_votes "multiple-votes" # used by uvvote.pl
1121 tpl_no_ballot "no-ballot" # used by uvvote.pl
1122 tpl_no_votes "no-votes" # used by uvvote.pl
1123 tpl_rule_violated "rule-violated" # used by uvvote.pl (siehe usevote.rul)
1129 Die mitgelieferten Templates befinden sich im Verzeichnis "templates".
1130 In usevote.cfg koennen weitere Verzeichnisse definiert werden, in
1131 denen auch nach Templates gesucht wird ("templatedir", kommaseparierte
1132 Liste mit Verzeichnissen). Außerdem koennen dort die Dateinamen der einzelnen
1133 Templates eingestellt werden, wodurch es moeglich ist, in einzelnen
1134 Abstimmungen andere, selbst definierte Templates zu verwenden, die in
1135 einem gesonderten Verzeichnis abgelegt sind.
1137 Eine Templatedatei besteht aus zwei Teilen. Am Anfang werden die
1138 Formatierungen bestimmter Schluessel definiert und nach einem Trenner
1139 folgt der eigentlich Template-Koerper, der dann von Programm bearbeitet
1140 und ausgegeben wird.
1142 format-key := function1 param | function2 param
1144 == TEMPLATE ====================================
1146 Ich bin nun das eigentliche Template:
1148 format-key: [$format-key]
1150 Der Trenner beginnt mit den Zeichen '== TEMPLATE' danach koennen beliebige
1151 Zeichen folgen um die beiden Sektionen optisch voneinander abzugrenzen.
1153 Wenn es keine Formatierungsanweisungen gibt, kann der Trenner auch
1154 weggelassen werden. D.h. wenn kein Trenner gefunden wird, wird der
1155 komplette Text als Template-Koerper betrachtet.
1161 Im Template-Koerper werden die zu ersetzenden Token durch eckige
1162 Klammern abgegrenzt. Sollen eckige Klammern im Text ausgegeben werden,
1163 muessen diese durch einen Backslash freigestellt werden.
1165 [$termersetzung] [@schleife] nur eine \[ Klammer
1170 Ersetzt den Token durch den Wert des angegeben Schluessels:
1172 [$formatierung] [$schluessel]
1174 Es wird zuerst nach einer Formatierung mit den entsprechenden
1175 Bezeichner gesucht. Ist diese vorhanden, werden die entsprechenden
1176 Funktionen ausgefuehrt (siehe folgender Abschnitt).
1178 Kann kein Format gefunden werden, wird direkt in der im Programmcode
1179 gefuellten Datenstruktur nach einem Schluessel mit dem angegeben
1180 Bezeichner gesucht und sein Wert eingesetzt. Alle Einstellungen
1181 aus der usevote.cfg sind automatisch als Schluessel definiert, es
1182 kann also z.B. [$nametext] jederzeit verwendet werden. Eingesetzt
1183 wird an der Stelle der mit "nametext = " definierte Text aus
1186 Schlussendlich ist es noch moeglich einen default-Wert zu
1187 definieren, der eingesetzt wird, wenn keiner der obigen Wege
1190 Hallo [$name|Unbekannter]!
1192 Diese Zeile gibt, wenn kein Name definiert wurde, das Wort
1196 Bedingte Verzeigung:
1198 Ueberprueft ob der Wert des angegebenen Formats/Schluessel boolsch
1199 WAHR ist. Dementsprechend wird der then oder else Block eingefuegt:
1201 [?if|then|else] oder auch nur [?if|then]
1203 Die then/else Bloecke werden natuerlich auch auf Tokens geparst und
1204 diese dementsprechend ersetzt.
1209 Der nachfolgende Textblock wird fuer alle Elemente des durch den
1210 Schluessel bezeichneten Arrays ausgefuehrt und eingefuegt.
1212 [@schluessel|block] oder [@schluessel|block|sep]
1214 Als zweiter Parameter kann ein Separtor definiert werden, mit dem
1215 sich z.B. kommaseparierte Listen erzeugen lassen, da der Separator
1216 eben nur zwischen den Elementen eingefuegt wird.
1218 Auch fuer Schleifen koennen Formatierungen genutzt werden.Allerdings
1219 darf kein String zurueckgegeben werden, sondern ein Array mit einer
1220 Menge von UVtemplate-Objekten.
1225 Token die nach der Bearbeitungen entfernt werden:
1227 [# mich sieht man nicht]
1232 Um in Listen einen Zeilenumbruch zu erzwingen, muss lediglich ein
1233 '\n' eingefuegt werden, falls eine kompakte Definition der Liste
1236 [@names|[name] [email]\n]
1242 Eine Formatierung besteht eigentlich nur aus dem entsprechenden
1243 Namen und einer beliebigen Anzahl von Funktionsaufrufen:
1245 format := funktion param1 "param 2" | funktion param
1247 Aehnlich der Unix-Shell-Funktionalitaet, wird dabei die Ausgabe
1248 einer Funktion an die folgende weitergeleitet. So ist es moeglich,
1249 verschiedenste simple Formatierungen zu kombinieren um nicht fuer
1250 jeden Spezialfall eine neue Funktion schreiben zu muessen.
1252 Die jeweilige Formatierungsfunktion erhaelt als Input die
1253 Datenstruktur, den Output der vorherigen Funktion und die definierten
1254 Parameter in der entsprechenden Reihenfolge.
1256 Zahlen und einfache Bezeichner koennen direkt definiert werden.
1257 Sollen Sonderzeichen oder Leerzeichen uebergeben werden, muessen
1258 diese gequotet werden. Dazu kann ' oder " verwendet werden.
1260 Die Funktionen geben im Allgemeinen einen String zurueck. Im Rahmen
1261 von Listen können auch Arrays uebergeben werden.
1263 Die erste Funktion duerfte ueblicherweise 'value' sein. Sie gibt
1264 den Wert des angegeben Schluessel zurueck, der dann von den
1265 folgenden Funktionen definiert wird:
1267 name-60 := value name | fill-right 60
1269 Das Format "name-60" definiert also den Wert des Schluessel "name",
1270 der um Leerzeichen aufgefuellt wird, bis eine Laenge von 60 Zeichen
1273 name-email := value name | justify-behind mail 72
1275 "name-email" resultiert in einem String, der zwischen den Werten von
1276 "name" und "email" genau so viele Leerzeichen enthaelt, damit der
1277 gesamte String 72 Zeichen lang ist.
1279 Wird dieses Format in einer Liste angewandt, erhaelt man eine Tabelle
1280 in der die linke Spalte linksbuendig und die rechte Spalte
1281 entsprechend rechtsbuendig ist.
1283 Soweit ein kleiner Ueberblick ueber die Formatierungen. Ausfuehrliche
1284 Funktionsbeschreibungen und weitere Beispiele finden sich in der
1285 POD-Dokumentation des Moduls UVformat ("perldoc UVformat.pm").
1287 Es ist moeglich, selbst eigene Module mit Formatierungsfunktionen
1288 zu schreiben und ueber die Option "formats" in usevote.cfg einzubinden.
1289 Am besten kann dazu UVformats.pm als Vorlage genommen werden.
1290 Wichtig: der Name einer Formatierungsfunktionen darf nur aus
1291 Gross- und Kleinbuchstaben, Zahlen und Minuszeichen bestehen.
1292 Unterstriche, Punkte etc. sind nicht erlaubt!
1294 Falls eine elementare Funktion fehlt, kannst Du Dich auch gerne
1295 bei mir melden und ich pruefe, wie sie sich einbauen laesst.
1297 Marc Langer, im Oktober 2005