Praxisbeispiel: Plugin "Close Old Threads"

Plugin-Entwicklung



Im folgenden Beispiel wird die Entwicklung des Plugins "Close Old Threads" beschrieben.

0) Anforderungen


Oft passiert es, dass gerade neue Mitglieder ein altes Thema über die Suchfunktion auffinden und dort posten, obwohl bereits eine lange Zeit kein Beitrag mehr in diesem Thema geschrieben wurde. Für den Administrator ist es aber unzumutbar, ständig das Forum zu kontrollieren, um alte Beiträge zu schließen. Das neue Plugin soll dem Admin diese Arbeit abnehmen und beim Aufruf eines Themas automatisch prüfen, ob ein Thema zu alt ist oder nicht.
Für Themen die ein bestimmtes Alter überschritten haben, kann ein Warnhinweis angegeben werden, noch ältere Themen werden komplett geschlossen.

Der Administrator soll festlegen können, nach wie vielen Tagen eine Warnung bzw. eine Schließung erfolgt. Außerdem solle es möglich sein Gruppen zu definieren, die von der Schließung nicht betroffen sind.




1) Neues Plugin erstellen



In der Foren-Administration unter Plugins->Plugin Entwicklung können neue Plugins erstellt werden.

Plugin ID & Plugin Name
Die ersten beiden Werte, die bei der Erstellung eines Plugins angegeben werden müssen sind die Plugin ID und der Plugin Name. Die ID ist der interne Name des Plugins. Er darf keine Sonderzeichen enthalten. Der Pugin Name ist der Name des Plugins, den später der Endbenutzer zu sehen bekommt.


Plugin ID: threadautoclose
Plugin Name: Close Old Threads




2) Elemente des Plugins definieren



Ein Plugin besteht aus folgenden Elementen:

  • Content-Element
    Template-Elemente, Javascript oder HTML-Dateien
  • Config-Variablen
    Einstellungen für das Plugin
  • Daten-Variablen
    In diesen Variablen werden Werte und Daten gespeichert, die das Plugin benötigt. Datenvariablen werden immer einer Quelle (Origin) zugeordnet. Wird eine Variable z.B. dem Benutzerprofil zugeordnet, stehen die gespeicherten Werte später immer zur Verfügung, wenn ein Benutzerprofil geöffnet ist.
  • Globale Variablen
    Funktionieren genau wie Daten-Variablen, allerdings stehen die hier gespeicherten Werte später auf allen Seiten des Forums zur Verfügung. Dies kann die Performanz negativ beeinflusssen und sollte daher vorsichtig eingesetzt werden.



Für das Close Old Threads Plugin benötigen wir keine Variablen, die Daten speichern. Allerdings möchten wir dem Administartor einige Einstellungen ermöglichen, daher legen wir drei Config-Variablen an:

Variablen
1) maxdays_messageage_warning
Nach X Tagen soll eine Warnung angezeigt werden, dass das Thema schon alt ist.
Die Variable ist von Typ int und bekommt den Standardwert 180

2) maxdays_messageage_close
Nach X Tagen soll das Thema ganz geschlossen werden.
Die Variable ist von Typ int und bekommt den Standardwert 360

3) plugin_exceptions
Hier können Gruppen angegeben werden, welche auch nach dem erreichen von maxdays_messageage_close noch antworten können.
Die Variable ist vom Typ grouprights und bekommt den Standardwert administrator

Templates
Das Plugin soll später an zunächst 2 Stellen im Forum aktiv werden: Einmal beim Schreiben eines Beitrags, und einmal in der Themenansicht.

Wir benötigen daher 2 neue Template-Elemente:

Plugin Template Element "New Message"


Wir ordnen unser neues Element dem Foren-Template "Neuen Beitrag Schreiben" zu und erreichen damit, dass der Code des Templates immer ausgeführt wird, wenn das Template "Neuen Beitrag Schreiben" aufgerufen wird.


Desweiteren können wir festlegen, wann genau das Plugin Template ausgeführt werden soll:


Header -> das Plugin-Template wird direkt VOR dem Foren-Template ausgeführt.
Footer -> das Plugin-Template wird direkt NACH dem Foren-Template ausgeführt.
Inline-Element -> Die ermöglich die Ausführung der Plugin-Codes innerhalbt des Foren-Templates. Hierzu gibt es in den Foren-Templates Markierungen. Im "Neuen Beitrag Schreiben"-Template gibt es eine solche Markierung z.B. innerhalb des "Beitrag Schreiben" Formulars. Zu den Markierungen in den Template -Elementen wird es in Kürze noch ein eigenes Tutorial geben.


Unsere Einstellungen für das Element "New Message" lauten also:
Template: Neuen Beitrag Schreiben
Inline-Element: "new_message_in_form" (Name der Markierung im Foren Template)
Template Name: new_message

Analog dazu wird auch das Template "topic" angelegt:
Template: Themen Ansicht
Header: JA - das Plugin-Template soll vor dem Laden der Beiträge angezeigt werden.
Template Name: topic





3) Plugin Elemente schreiben


Wir haben nun alle Elemente des Plugins definiert und den jeweiligen Foren-Templates zugeordnet. Im nächsten Schritt schreiben wir nun den Code des Plugins

Plugin-Templates funktionieren fast genau wie normale Foren-Templates. Es stehen alle Foren-Variablen zur Verfügung, die auch im verknüpften Template-Element verwencet werden. Außerdem stehen die Variablen des Plugins zur Verfügung.

Auf den Wert der Variablen maxdays_messageage_warningzum Beispiel kann im Plugin Template mit {{plugin_threadautoclose_config_maxdays_messageage_warning}} zugegriffen werden.
Für Rechtevariablen erzeugt das System automatisch eine zusätzliche boolean-Variable. D.h während die Variable {{plugin_threadautoclose_config_plugin_exceptions}} die Gruppen-Ids der Gruppen enthält, die von der Themenschließung nicht betroffen sind, enthält {{plugin_threadautoclose_config_plugin_exceptions_boolean}} einen true/false Wert, der für den aktuellen Benutzer angepasst wird.


Das Element new_message setzt folgendes um:

Beim laden von "Neuen Beitrag Schreiben" prüfen wir ob

1) Das maximale Themenalter erreicht wurde
1a) Falls ja: Prüfen Ob das Mitglied in der "Ausnahmen"-Gruppe ist.
1aa) Falls ja: Warnhinweis anzeigen, dass das Thema eigentlich geschlossen wäre
1ab) Falls nein: Thema als geschlossen anzeigen, Laden des "Beitrag schreiben" Templates unterbinden

2) Das Themenalter für eine Warnung reicht:
2a) Falls ja: Warnung anzeigen

Das könnte dann z.B. so aussehen:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
<!--{{reply==true.start}} = Nur laden, wenn geantwortet wird:-->
{{reply==true.start}}
 
<!--Berechnung der Tage seit der letzten Antwort-->
{{secs_since_message.startint}}{{server_time}}-{{thread_lastmessage_ts}}{{secs_since_message.end}}
{{days_inactive.startint}}{{secs_since_message}}/60/60/24{{days_inactive.end}}
 
{{limitreached.start}}0{{limitreached.end}}
 
<!--Thread ist älter als in maxdays_messageage_close definiert-->
{{days_inactive>plugin_threadautoclose_config_maxdays_messageage_close.start}}

 
{{plugin_threadautoclose_config_plugin_exceptions_boolean==true.start}}
<!--Thread ist älter als in maxdays_messageage_close definiert - aber der USer ist in einer ausgenommenen Gruppe-->
{{limitreached.start}}1{{limitreached.end}}
<div class="threadinactive">In diesem Thema wurden seit mehr als {{plugin_threadautoclose_config_maxdays_messageage_close}} Tagen kein Beitrag verfasst. <br/>Bitte überlegen Sie vor dem posten ob es nicht sinnvoller ist, ein neues Thema zu eröffnen</div>
 
{{plugin_threadautoclose_config_plugin_exceptions_boolean==true.else}}
<!--Thread ist älter als in maxdays_messageage_close definiert - Thema wird als geschlossen angezeigt-->
<div class="threadinactive_hardlimit" style="text-align:center;">
Dieses Thema wurde aufgrund von Inaktivität geschlossen. <br/>Bitte eröffnen Sie bei Bedarf ein neues Thema.<br/>
<a href="{{reply_message_link}}" class="button button1">zurück zum Beitrag</a>
</div>

<!--Diese Funktionen veerhindern, dass weitere Templates geladen werden-->
{{template_stoploading(new_message)}}
{{template_stoploading(quote_html)}}
 
{{plugin_threadautoclose_config_plugin_exceptions_boolean==true.end}}
 
{{days_inactive>plugin_threadautoclose_config_maxdays_messageage_close.end}}
 
<!--Thread ist älter als in maxdays_messageage_warning definiert - Warnhinweis anzeigen-->
{{days_inactive>plugin_threadautoclose_config_maxdays_messageage_warning.start}}{{days_inactive<plugin_threadautoclose_config_maxdays_messageage_close.start}}
{{limitreached.start}}1{{limitreached.end}}
<div class="threadinactive">Bitte beachten Sie, dass in diesem Thema schon länger kein Beitrag mehr verfasst wurde.<br/>Überlegen Sie vor dem posten ob es nicht sinnvoller ist, ein neues Thema zu eröffnen.</div>
{{days_inactive<plugin_threadautoclose_config_maxdays_messageage_close.end}}{{days_inactive>plugin_threadautoclose_config_maxdays_messageage_warning.end}}
 

<!--Hier wird der eingefügte Code per Javascript auf der Seite positioniert. Je nach Template wird er an eine unterschiedliche Position geschoben-->
{{limitreached==true.start}}
 
<script>
$(document).ready(function(){
{{template==1.start}}var $infotexttarget = $('#previewbutton').closest('table');{{template==1.end}}
{{template==111.start}}var $infotexttarget = $('#previewbutton').closest('table');{{template==111.end}}
{{template==110.start}}var $infotexttarget = $(".submit-buttons");{{template==110.end}}
{{template==144.start}}var $infotexttarget = $("#newmsg");{{template==144.end}}
$('.threadinactive').insertBefore($infotexttarget);
});</script>
{{limitreached==true.end}}
{{reply==true.end}}
 



Das Element "topic" wird auf der Themen Ansicht geladen. Für die erste Version des Plugins beschränken wir uns darauf, die Schnellantwort auszublenden, wenn das Limit überschritten wurde (da Mitglieder ja sonst auf diesem Wege dennoch Beiträge schreiben könnten).


{{secs_since_message.startint}}{{server_time}}-{{thread_lastmessage_ts}}{{secs_since_message.end}}
{{days_inactive.startint}}{{secs_since_message}}/60/60/24{{days_inactive.end}}

{{limitreached.start}}0{{limitreached.end}}

{{days_inactive>plugin_threadautoclose_config_maxdays_messageage_close.start}}
{{plugin_threadautoclose_config_plugin_exceptions_boolean==true.start}}
{{limitreached.start}}1{{limitreached.end}}
{{plugin_threadautoclose_config_plugin_exceptions_boolean==true.else}}
{{reply_quick.start}}0{{reply_quick.end}}
{{plugin_threadautoclose_config_plugin_exceptions_boolean==true.end}}

{{days_inactive>plugin_threadautoclose_config_maxdays_messageage_close.end}}




4) Testen



Wenn alles klappt, sollten nun beim beantworten alter Themen keine Antwort mehr möglich sein.




5) Veröffentlichen



An dieser Stelle ist die erste Version des Plugins fertig für die Veröffentlichung im Plugin-Store. Dazu geben wir in den Plugin-Einstellungen die gewünschte Versionsnummer an (Falls bereits eine Version des Plugins veröffentlicht wurde muss die versionsnummer höher sein als zuvor!) und klicken auf "In Plugin Store veröffentlichen. Da wir bei den Plugin-Einstellungen festgelegt haben, dass das Plugin sichtbar für alle ist (Public Store) erscheint das Plugin nun im öffentlichen Plugin Store, sobald ein Xobor Mitarbeiter den Code überprüft und für gut befunden hat.

Ist das Plugin erst einmal im Plugin Store, kann es von allen Xobor Foren mit einem Klick installiert und verwendet werden.

6) Erweitern



Die Arbeit hört hier natürlich nicht auf. Man könnte noch Variablen hinzufügen, die dem Admin erlauben, selbst die angezeigten Texte festzulegen. Oder man fügt bei der Themen-Ansicht gleich das "Thema geschlossen"-Icon ein wenn das Antworten nicht gestattet ist.

Nachdem ein Plugin verändert wurde, muss eine neue Versionsnummer angegeben werden, bevor es im Plugin Store veröffentlicht werden kann. Ist eine neue Version verfügbar, können alle Foren das Update mit einem Klick installieren.


Login
Activity Feed
forum_message forum_message
m3ontour hat einen neuen Beitrag im Thema Gibt es ein Backup für das Xobor Wiki geschrieben.
Hallo Ingmar,hast du die Daten bekommen?
forum_message forum_message
Mike48 und Gemshorn haben 2 neue Beiträge im Thema Artefakte in hochgeladenen Bildern geschrieben.
Ich kann da keinen Unterschied feststellen. Edit:Ich habe doch einen Unteschied gefunden. Es sind unterschiedliche Formate. Eins ist PNG das ander JPG, Beide sind 163x96 und sehen gleich aus.
forum_topic forum_topic
Gemshorn hat das Thema Artefakte in hochgeladenen Bildern erstellt
Hallo,ich habe heute festgestellt, dass Bilder, die per STRG + V in einen Beitrag hochgeladen wurden, sauber dort ankommen. Qualität astrein!Lade ich dasselbe Bild als Datei von meinem PC aus hoch, ist das Ergebnis nach dem Upload minderwertig.Warum?
forum_message forum_message
ConniFaehre und Mike48 haben 4 neue Beiträge im Thema Fehler bei PN? geschrieben.
Keine Zahl in den Einstellungen ist negativ. Nach Neuinstallation berichten User weiterhin von dem Problem. Schade, wär ne einfache Lösung gewesen.
rating rating
Wolfgang hat sich bedankt!
Beitrag: webp Grafik wird fehlerhaft hochgeladen
%usernames% hat sich bedankt!
forum_topic forum_topic
ConniFaehre hat das Thema Fehler bei PN? erstellt
Hallo, wir haben das „Briefumschlagplugin“ installiert. Ich habe kürzlich das Update durchgeführt. Nun melden User folgendes: https://ere.xobor.de/t18127f24752-PN-ist...html#msg1035036Viele Grüße
forum_message forum_message
River hat einen neuen Beitrag im Thema Captcha - Akustische Lösung geschrieben.
Zitat von spotter46 im Beitrag #3Mal z.B. wurde ein einzelnes Motorrad abgebildet und es mussten alle Felder mit Motorrad abgehakt werden. Das kann bekanntlich eher mal zu Fehlern führen, aber wenn in einem anderen Fall in Collagenform mehrere Einzelbildchen gezeigt werden, dann kann man mir schon z...
rating rating
River hat sich bedankt!
Beitrag: Captcha - Akustische Lösung
%usernames% hat sich bedankt!
rating rating
Mike48 hat sich bedankt!
Beitrag: Keine Email bei "Passwort vergessen" über Freenet?!
%usernames% hat sich bedankt!
forum_message forum_message
ThomasB., Mike48 und m.schenker haben 3 neue Beiträge im Thema Keine Email bei "Passwort vergessen" über Freenet?! geschrieben.
Ja, hat sie. Auch dort nichts angekommen.
forum_message forum_message
Ingmar hat einen neuen Beitrag im Thema webp Grafik wird fehlerhaft hochgeladen geschrieben.
Kann ich reproduzieren. Seltsam, letzte Woche habe ich noch webp Grafiken hochgeladen.Danke fürs melden.
forum_topic forum_topic
Ludger hat das Thema webp Grafik wird fehlerhaft hochgeladen erstellt
webk Grafiken werden fehlerhaft bzw. gar nicht hochgeladenfolgendes erscheint:[[File:Ashampoo_Snap_2025.01.18_12h26m05s_005_.jpg|none|auto]]und--------------------------------------------[[File:Ashampoo_Snap_2025.01.18_12h09m11s_003_.jpg|none|auto]]
forum_message forum_message
spotter46 und focus haben 2 neue Beiträge im Thema Frage zur Statistik und Auswertung geschrieben.
Zitat von focus im Beitrag #8Ich habe den Basis Tarif, allerdings kann ich die Mitgliederliste nicht als CSV Datei expotieren !!??Ja, Du hast Recht, wie ich nach einem Test in einem Forum mit Basistarif leider mit Verspätung festgestellt habe.Man mag es bedauern, aber es ist halt so, dass Miranus-X...
rating rating
Gemshorn hat sich bedankt!
Beitrag: Fixiertes Menü
%usernames% hat sich bedankt!
forum_message forum_message
Ingmar, spotter46 und Mike48 haben 7 neue Beiträge im Thema Captcha - Akustische Lösung geschrieben.
Zitat von spotter46 im Beitrag #5Warum nutzt ihr nicht euer eigenes Xobor-Captcha ? Ist das so sehr unsicherer ?Es hat durchaus ein paar Nachteile. Z.b ist es eben nicht barrierefrei. Außerdem kann es zu Problemen kommen, wenn viele Mitglieder über die gleiche IP online gehen.Wir haben hier beim Log...
rating rating
Mike48 hat sich bedankt!
Beitrag: Captcha - Akustische Lösung
%usernames% hat sich bedankt!
forum_message forum_message
Remember MJ hat einen neuen Beitrag im Thema Spam Mails geschrieben.
Hallo Markus,habe auch immer wieder Spam Mails in meinem Ordner.Denke, daß hat etwas mit dem Impressum des Forums zu tun.Da muß ja leider die Mailaddy angegeben werden.Manche schauen dort halt einfach nach und senden dir dann ihren Müll.Da kann man wohl leider nichts dran ändern.
rating rating
Lady of the light hat sich bedankt!
Beitrag: Captcha - Akustische Lösung
%usernames% hat sich bedankt!
forum_topic forum_topic
spotter46 hat das Thema Captcha - Akustische Lösung erstellt
Nachdem ich gestern etwa 3/4-Stunde vergeblich versucht habe, mich hier einzuloggen und zunächst die Fehlermeldung kam, Benutzername und/oder Passwort wären nicht korrekt, musste ich beim erneuten Versuch das Captcha lösen.Ich bin kein Anfänger und Captchas gibt's ja nicht nur hier im Supportforum, ...
rating rating
Ingmar hat sich bedankt!
Beitrag: Link in den Beiträgen
%usernames% hat sich bedankt!
rating rating
Wolfgang und Gabriella haben sich bedankt!
Beitrag: Fixiertes Menü
%usernames% haben sich bedankt!
forum_message forum_message
l2otbart_57 und Ingmar haben 2 neue Beiträge im Thema Fixiertes Menü geschrieben.
Habe auch gerade die fixierten breadcrumbs ausprobiert und muss feststellen, dass die Einstellung nur in der Threadansicht wirkt. Das ist ganz praktisch, um so den Threadtitel immer im Blick zu haben. Ich könnte mir gut vorstellen, dass eine Fixierung auch in der Forumansicht hilfreich wäre, um das ...
forum_message forum_message
spotter46 und Peltzer haben 4 neue Beiträge im Thema Link in den Beiträgen geschrieben.
Zitat von Peltzer im Beitrag #8Booohhhhh, ich ziehe alles zurück, sorry.Ist da. Ich konnte mit dem Symbol überhaupt nichts anfangen. GrußAxelKein Problem.Daher ist der intensive "Genuss" vom Xobor-Wiki und zum ebenso intensiven und gefahrlosen testen die Anlage eines eigenen Testforums angeraten.
forum_message forum_message
Gemshorn hat einen neuen Beitrag im Thema Fixiertes Menü geschrieben.
Update: Die fixierten Breadcrumbs scheinen das wichtigere Feature zu sein - und das lässt sich ja im Adminbereich per Schalter aktivieren. Das fixierte Menü habe ich nun wieder deaktiviert. Vielleicht die einfachste Lösung.Danke fürs Mitlesen.
forum_topic forum_topic
Gemshorn hat das Thema Fixiertes Menü erstellt
V6.Meine User wünschen sich einerseits ein fixiertes Menü und andererseits auch fixierte Breadcrumbs.Aktiviere ich beides, überlagern sich Menü und Breadcrumbs aber dergestalt, dass die Navigationsbuttons ÜBER den Breadcrumbs zu liegen kommen, sodass man letztere nicht mehr anklicken kann. Könnt ihr...
forum_message forum_message
m3ontour und 3 weitere haben 4 neue Beiträge im Thema Gibt es ein Backup für das Xobor Wiki geschrieben.
Hallo Ingmar,ich habe dir die Daten als Mail auf Xobor Supportforum <news@hpm-support.de> gesendet.Vielen Dank vorab
rating rating
Ingmar hat sich bedankt!
Beitrag: Kann in Navigation keine Einträge hinzu fügen
%usernames% hat sich bedankt!
rsummary rsummary
River und 1 weitere haben 2 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
rsummary rsummary
Ingmar und 2 weitere haben 2 Beiträge bewertet (Details)
%usernames% haben sich bedankt!
Wer ist Online?
0 Mitglieder und 58 Gäste sind Online
Besucher Statistiken
58 Aktive User
0 Mitglieder und 58 Gäste sind Online

Heute waren Online
Gabriella, nobody

Besucherrekord
1274 Benutzer gleichzeitig online (11.10.2019 18:19)

Besucherzähler
Heute waren 303 Gäste und 2 Mitglieder, gestern 1527 Gäste und 17 Mitglieder online.

Statistiken
Themen 41767
Beiträge 305690
Mitglieder 12.466
Forum empfehlen