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
Wolfgang und 3 weitere haben 4 neue Beiträge im Thema Neues Plugin - ToDoX - Die persönliche ToDo-Liste von FoX geschrieben.
Info wird nicht beim Seiten-Reload gespeichert (außer FF)Zitat von Mike48 im Beitrag #86Hallo @Wolfgang Ich kann dir eine Testversion schicken. Im Edge und Chrome wird die Variable auch beim verlassen der Seite (F5) gespeichert.Die Version ist auch für das V6. Im V6 ist aber noch nicht die ToDo im P...
rating rating
Franz-Jupp hat sich bedankt!
Beitrag: Spendenaufruf für das Forum 'Friends of Xobor' aka FOX
%usernames% hat sich bedankt!
rating rating
%usernames% hat sich bedankt!
forum_topic forum_topic
Liebe Gäste und Mitglieder,Um das Wissens- und Testforum 'Friends of Xobor', auch 'FOX' genannt - https://www.friends-of-xobor.de/ weiterhin mit dem benötigten Tarif in Betrieb zu halten, möchte ich hier gerne einen Spendenaufruf posten.Quelle dieses Aufrufs könnt ihr hier nachlesen:Neues Plugin - T...
rating rating
%usernames% hat sich bedankt!
rating rating
%usernames% hat sich bedankt!
rating rating
River und 1 weitere haben sich bedankt!
Beitrag: Neues Plugin - ToDoX - Die persönliche ToDo-Liste von FoX
%usernames% haben sich bedankt!
forum_message forum_message
Ingmar hat einen neuen Beitrag im Thema Fehlerhafte Beitragsnummerierung und Zahl der Antworten geschrieben.
Hm. Also -1 ist mir jetzt auch noch nicht untergekommen.Allgemein kannst du einmal unter Admin→Einstellungen auf "Zähler neu Berechnen" klicken und schauen, ob es das Problem behebt.Falls nicht gerne noch einmal melden. Ihr habt allerdings diverse Template-Änderungen eingebaut - so lange das wirkli...
forum_message forum_message
Mike48 und 2 weitere haben 4 neue Beiträge im Thema Neues Plugin - ToDoX - Die persönliche ToDo-Liste von FoX geschrieben.
Ich hatte den Spendebalken entfernt als wir auf monatliche Zahlung umgestellt hatten. Ich könnte als Spendenziel für den Balken ein halbes Jahr nehmen.
rating rating
%usernames% hat sich bedankt!
rating rating
%usernames% hat sich bedankt!
forum_topic forum_topic
Hallo! Ich habe zwar bereits die Suchfunktion bemüht, wurde jedoch leider nicht fündig. Sollte ich etwas übersehen haben - sorry! Jedenfalls bilde ich mir ein, dass es diesen Fehler bereits einmal gab. Es kann sein, dass er mit dem heutigen Fehler (MySQL) zu tun hat, es ist aber auch möglich, dass e...
forum_message forum_message
Mike48 und 1 weitere haben 3 neue Beiträge im Thema Neues Plugin - ToDoX - Die persönliche ToDo-Liste von FoX geschrieben.
Hallo @Wolfgang Ich kann dir eine Testversion schicken. Im Edge und Chrome wird die Variable auch beim verlassen der Seite (F5) gespeichert.Die Version ist auch für das V6. Im V6 ist aber noch nicht die ToDo im Portal an allen Stellen zu sehen. Bin aber dran.
rating rating
Wolfgang und 1 weitere haben sich bedankt!
Beitrag: Neues Plugin - ToDoX - Die persönliche ToDo-Liste von FoX
%usernames% haben sich bedankt!
rating rating
%usernames% hat sich bedankt!
rating rating
%usernames% hat sich bedankt!
forum_message forum_message
Mike48 und 1 weitere haben 8 neue Beiträge im Thema Neues Plugin - ToDoX - Die persönliche ToDo-Liste von FoX geschrieben.
Bei mir funktioniert das auch für Gäste. In der mobilen Ansicht sieht es etwas verwirrend aus, geht aber auch ohne Anmeldung wenn man sich was anstrengst.
forum_message forum_message
Mike48 hat einen neuen Beitrag im Thema Plugin Einstellungsmenü : Ansicht sehr unübersichtlich geschrieben.
Aber ein paar Tennstriche zwischen den einzelnen Einstell-Optionen einzufügen kann ja nicht die Welt sein und ist dringend erforderlich. Auch das vertikale Zentrieren müsste meines Erachtens schnellstens heraus.Man muss sonst ständig in alte Admin umschalten um eine Kopf an das ganze zu bekommen.
rating rating
old-smokey und 1 weitere haben sich bedankt!
Beitrag: Failed to connect to MySQL
%usernames% haben sich bedankt!
forum_message forum_message
Charles und 7 weitere haben 11 neue Beiträge im Thema Failed to connect to MySQL geschrieben.
Alles gut Johannes.Man sieht es bei uns in den Letzten Beiträgen
rating rating
Wolfgang und 2 weitere haben sich bedankt!
Beitrag: Failed to connect to MySQL
%usernames% haben sich bedankt!
rating rating
Franz-Jupp hat sich bedankt!
Beitrag: Failed to connect to MySQL
%usernames% hat sich bedankt!
rating rating
Franz-Jupp hat sich bedankt!
Beitrag: Failed to connect to MySQL
%usernames% hat sich bedankt!
rating rating
Ingmar hat sich bedankt!
Beitrag: Failed to connect to MySQL
%usernames% hat sich bedankt!
rating rating
Ingmar und 1 weitere haben sich bedankt!
Beitrag: Failed to connect to MySQL
%usernames% haben sich bedankt!
forum_topic forum_topic
wildflower hat das Thema Failed to connect to MySQL erstellt
Hallo zusammen,bei uns kommt seit heute folgender Fehler, wenn man einen Beitrag schreibt oder ins Adminmenü möchte.Failed to connect to MySQL - Too many connectionsfailed connect mailDer Beitrag ist dann dennoch da, jedoch wird auch nichts mehr im Activity Feed angezeigt, lediglich die Bewertungen ...
forum_message forum_message
Wolfgang hat einen neuen Beitrag im Thema Neues Plugin - ToDoX - Die persönliche ToDo-Liste von FoX geschrieben.
Hallo Mike, habe da 2 Fragen oder auch Vorschläge.*************1. Normalerweise wird alles, was man in die ToDo-Liste eingibt, gespeichert, auch wenn man die Seite verlässt und eine andere Kategorie aufruft!Gibt man aber eine Notiz in die ToDo-Liste ein und macht einen Seiten-Reload, ist die Info we...
rating rating
Karima und 1 weitere haben sich bedankt!
Beitrag: Beiträge zählen - Einstellung funktioniert nicht
%usernames% haben sich bedankt!
rating rating
Karima hat sich bedankt!
Beitrag: Einstellung "Beiträge zählen" wird zurückgesetzt
%usernames% hat sich bedankt!
rating rating
Ingmar hat sich bedankt!
Beitrag: Unsichere Verbindung übers Handy
%usernames% hat sich bedankt!
forum_message forum_message
Franz-Jupp und 1 weitere haben 4 neue Beiträge im Thema Unsichere Verbindung übers Handy geschrieben.
Um das vorsichtshalber nochmal klarzustellen, es geht nicht um die Eingabe in der Adresszeile von Google Chrome, sondern um diese in meinen Augen eigentlich nutzlose App GOOGLE https://play.google.com/store/apps/detai...equicksearchbox
rating rating
Ingmar hat sich bedankt!
Beitrag: Beiträge zählen - Einstellung funktioniert nicht
%usernames% hat sich bedankt!
forum_message forum_message
Franz-Jupp hat einen neuen Beitrag im Thema Beiträge zählen - Einstellung funktioniert nicht geschrieben.
Ergänzung Stellt man in der alten Admin auf "nicht zählen", wechselt dann zur neuen Admin und stellt um auf "zählen", dann wird die neue Einstellung seltsamerweise gespeichert.Nur umgedreht funktioniert es nicht.
rating rating
Franz-Jupp hat sich bedankt!
Beitrag: Einstellung "Beiträge zählen" wird zurückgesetzt
%usernames% hat sich bedankt!
forum_message forum_message
Franz-Jupp hat einen neuen Beitrag im Thema Einstellung "Beiträge zählen" wird zurückgesetzt geschrieben.
Zitat von Karima im Beitrag #1Ich klicke auf ein Forum und bin dann in den Foren Einstellungen. Dann stelle ich den Toggle "Beiträge zählen" aus und speichere.Wenn ich dann wieder auf das Forum klicke, ist der der Toggle "Beiträge zählen" wieder an.Stimmt, in der neuen Admin-Oberfläche funktioniert ...
forum_topic forum_topic
Franz-Jupp hat das Thema Beiträge zählen - Einstellung funktioniert nicht erstellt
Zitat von Karima im Beitrag Einstellung "Beiträge zählen" wird zurückgesetztIch klicke auf ein Forum und bin dann in den Foren Einstellungen. Dann stelle ich den Toggle "Beiträge zählen" aus und speichere.Wenn ich dann wieder auf das Forum klicke, ist der der Toggle "Beiträge zählen" wieder an.Ich h...
forum_topic forum_topic
Hallo zusammen,nachdem ich die Suche hier mehrfach genutzt habe und keine Lösung gefunden habe, erstelle ich ein neues Thema. Ich habe aktuell das Problem, dass ich den Beitragszähler nicht ausstellen kann. Ich möchte, dass nur in einer bestimmten Kategorie Beiträge gezählt werden.Wenn ich jetzt in ...
rsummary rsummary
Franz-Jupp und 1 weitere haben 2 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
rsummary rsummary
Wolfgang und 2 weitere haben 3 Beiträge bewertet (Details)
%usernames% haben sich bedankt!
rsummary rsummary
River hat 2 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
rsummary rsummary
Wolfgang und 1 weitere haben 3 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
rsummary rsummary
Wolfgang und 4 weitere haben 5 Beiträge bewertet (Details)
%usernames% haben sich bedankt!
rsummary rsummary
Karima und 1 weitere haben 3 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
Wer ist Online?
6 Mitglieder und 200 Gäste sind Online
Besucher Statistiken
206 Aktive User
6 Mitglieder und 200 Gäste sind Online:
Mike48, old-smokey, Johannes, Wolfgang, Hanshard, Ingmar


Besucherrekord
1274 Benutzer gleichzeitig online (11.10.2019 18:19)

Besucherzähler
Heute waren 1132 Gäste und 21 Mitglieder, gestern 848 Gäste und 30 Mitglieder online.

Statistiken
Themen 41715
Beiträge 305278
Mitglieder 12.463
Forum empfehlen