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
Mike48, Ludger und Olaf haben 3 neue Beiträge im Thema Sonderzeichen im Forum aufgetaucht geschrieben.
Hier im Support ist es jetzt. Auf dem PC finde ich nur neben der Pagination und aud dem Smartphon noch zusätzlich ganz oben.[[File:Sonderzeichen-mobil-1.PNG|none|600px|600px]]
forum_message forum_message
Mike48, focus und spotter46 haben 3 neue Beiträge im Thema Bilder einstellen geschrieben.
Dann schau mal in seiner Benutzergruppe nach ob Forencodes aktiv ist.
forum_topic forum_topic
focus hat das Thema Bilder einstellen erstellt
Hallo,ein Mitglied bei mir im Forum möchte gerne Bilder einstellen. Den Beitrag hat ergeschrieben und anstelle der Bilder sind jetzt diese Einträge zu sehen.[[File:B 08.jpg|none|auto]][[File:B 08A.jpg|none|auto]]Ich bin jetrzt ein wenig Ratlos, was hat er falsch gemacht bzw. wie kann ich Ihm helfen....
forum_message forum_message
Johannes hat einen neuen Beitrag im Thema Premium Tarif überzahlt | Support gibt keine Antwort geschrieben.
Ihre Anfrage liegt vor und wird in kürze beantwortet. Natürlich erhalten sie zuviel/doppelt gezahltes zurück oder es wird mit der näcjsten Rechnung verrechnet.
forum_topic forum_topic
wildflower hat das Thema Premium Tarif überzahlt | Support gibt keine Antwort erstellt
Hallo, wir zahlen in unserem Board 925358 den Profi Tarif. Im Mai haben wir ausversehen 2x bezahlt und gedacht es wird verrechnet. Wurde es leider nicht und deswegen haben wir über das Kontaktformular angefragt, weil ich nicht nochmal den vollen Preis zahlen wollte, da ich es im Vormonat doppelt sch...
forum_message forum_message
focus und Ingmar haben 2 neue Beiträge im Thema Daumen nach oben geschrieben.
Hallo Ingmar,vielen Dank für die schnelle Antwort.Ich habe jetzt die Cookies gelöscht. Aber der Eintrag bleibt. Mus ich die Einträge dannhändisch löschen ?
rating rating
Ludger hat sich bedankt!
Beitrag: Sonderzeichen im Forum aufgetaucht
%usernames% hat sich bedankt!
forum_message forum_message
Ingmar, Ludger und l2otbart_57 haben 7 neue Beiträge im Thema Sonderzeichen im Forum aufgetaucht geschrieben.
Zitat von Ludger im Beitrag #16muss ich mir dann Sorgen machen dass mein Forum gehackt wurde??Nein.
forum_topic forum_topic
focus hat das Thema Daumen nach oben erstellt
Hallo,ich habe einige "Probe Acounts" (Mitglieder) erstellt. Um bei Überprüfungen und VersuchenErgebnisse sehen zu können.Jetzt habe ich festgestellt, das wenn ich mit einem "Probe Mitglied" unterwegs bin und einen"Daumen hoch" als Wertung abgebe, mein Admin als "Bewerter" erscheint. Sollte dann ni...
forum_message forum_message
nobody und 5 weitere haben 8 neue Beiträge im Thema Sonderzeichen im Forum aufgetaucht geschrieben.
Im Quelltext findet man diese Zeichen.<td class="main "><div class="content page_index"><div class="spacer20">';?><script> var tuserID = 0; var xoborPluginData = {}; var xoborDynamic = []; ///////////////////////////////////////////////////...
rating rating
Ludger hat sich bedankt!
Beitrag: Sonderzeichen im Forum aufgetaucht
%usernames% hat sich bedankt!
rating rating
Ludger hat sich bedankt!
Beitrag: Sonderzeichen im Forum aufgetaucht
%usernames% hat sich bedankt!
rating rating
Ludger hat sich bedankt!
Beitrag: Sonderzeichen im Forum aufgetaucht
%usernames% hat sich bedankt!
forum_message forum_message
Ingmar hat einen neuen Beitrag im Thema Sonderzeichen im Forum aufgetaucht geschrieben.
Hm. Grundsätzlich sieht das schon nach etwas aus, das von uns verursacht wird. Leider kann ich das in keinem meiner Foren reproduzieren gerade. Hast du mir mal einen konkreten Link zu einer Seite auf der der Fehler zu sehen ist?
forum_topic forum_topic
Ludger hat das Thema Sonderzeichen im Forum aufgetaucht erstellt
[[File:Ashampoo_Snap_Mittwoch, 11. Juni 2025_09h31m39s_001_.jpg|none|fullsize]]diese Zeichen begleiten einem durch das Forum ... immer oben linksBusiness Template V4ist in mehreren Foren zu sehen
forum_message forum_message
Ingmar hat einen neuen Beitrag im Thema Neuanmeldung Begrüßungs E-Mail Text ändern geschrieben.
Admin→Einstellungen→Mailvorlagen
forum_topic forum_topic
susanne2019 hat das Thema Neuanmeldung Begrüßungs E-Mail Text ändern erstellt
Hallo, wo ändere ich den Text der E-Mail, die neumitglieder automatisch erhalten? viele Grüße und Danke!
forum_message forum_message
spotter46 hat 2 neue Beiträge im Thema Neue Gruppe, Rechte-Übernahme kompliziert geschrieben.
Sorry, habe mich wohl geirrt, warum auch immer, denn die Abläufe sind immer noch ziemlich identisch mit meiner Schilderung in Beitrag #2.
rating rating
Havaneserherzen Admin hat sich bedankt!
Beitrag: Danke Ingmar von Herzen Meine Idee und Umsetzung
%usernames% hat sich bedankt!
rating rating
Sporty hat sich bedankt!
Beitrag: Tägliches Limit für neue Beiträge
%usernames% hat sich bedankt!
rating rating
Gabriella hat sich bedankt!
Beitrag: Danke Ingmar von Herzen Meine Idee und Umsetzung
%usernames% hat sich bedankt!
rating rating
Kipper-Spedition hat sich bedankt!
Beitrag: Danke Ingmar von Herzen Meine Idee und Umsetzung
%usernames% hat sich bedankt!
forum_message forum_message
Ingmar und 1 weitere haben 2 neue Beiträge im Thema Danke Ingmar von Herzen Meine Idee und Umsetzung geschrieben.
Das Kleinanzeigen-Plugin ist so weit fertig und wird irgendwann auch seinen Einzug in den Plugin-Store finden.Aktuell arbeiten wir am Video-Upload.Alles weitere könnt ihr bei Bedarf gerne per pn klären
rating rating
%usernames% hat sich bedankt!
forum_message forum_message
Karl und 1 weitere haben 2 neue Beiträge im Thema Sicherheit in Foren - Forum Update für besseren Schutz vor Spam geschrieben.
IP Adressen sperren bringt nichts. Die verwenden dauernd leicht abgeänderte Adressen. Aber der Einbau einer Sicherheitsabfrage hat geholfen. Seither ist Ruhe. Trotzdem Danke.
forum_message forum_message
spotter46 und 1 weitere haben 2 neue Beiträge im Thema Plugin "Drei Infoboxen" geschrieben.
So, das Update auf 0.082 ist installiert.Bernd's ( @l2otbart_57 ) CSS-Script habe ich entfernt./*zum Plugin Drei Infoboxen = Anzeige nicht doppelt */#threeBoxes tr.textBox:nth-child(4),#threeBoxes tr.textBox:nth-child(5),#threeBoxes tr.textBox:nth-child(6) { display: none; } Wenn ich im Fore...
rating rating
spotter46 hat sich bedankt!
Beitrag: Plugin "Drei Infoboxen"
%usernames% hat sich bedankt!
forum_message forum_message
Ich habe einmal eine Frage: seit heute versuchen Dutzende mit äußerst fragwürdigen IP Adressen sich in meinem Forum anzumelden. Ich lösche diese Anmeldungsversuche zwar sofort, aber dann melden sich gleich wieder neu an (oder versuchen es jedenfalls). Eine Suche mit whois zeigt, dass diese IPs auf e...
forum_message forum_message
@Mike48 Oh, vielen Dank für die Info. Dann bau ich es mal um ^^
forum_message forum_message
spotter46 hat einen neuen Beitrag im Thema Plugin "Drei Infoboxen" geschrieben.
Zitat von spotter46 im Beitrag #191denn ich hoffe, der Support @Ingmar etc. schaltet das Update schnell freiLieb gemeinter Anstupser @Ingmar
rsummary rsummary
Ludger hat 3 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
rsummary rsummary
Havaneserherzen Admin und 3 weitere haben 4 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
Wer ist Online?
3 Mitglieder und 14 Gäste sind Online
Besucher Statistiken
17 Aktive User
3 Mitglieder und 14 Gäste sind Online:
Ingmar, Tom-Tiger, nobody


Besucherrekord
1274 Benutzer gleichzeitig online (11.10.2019 18:19)

Besucherzähler
Heute waren 2756 Gäste und 22 Mitglieder, gestern 3060 Gäste und 15 Mitglieder online.

Statistiken
Themen 41977
Beiträge 307411
Mitglieder 12.576
Forum empfehlen