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
rating rating
Rika1 hat sich bedankt!
Beitrag: Besucher Rekord: Falsches Datum angezeigt
%usernames% hat sich bedankt!
rating rating
Mike48 hat sich bedankt!
Beitrag: Besucher Rekord: Falsches Datum angezeigt
%usernames% hat sich bedankt!
forum_message forum_message
Rika1 und Mike48 haben 2 neue Beiträge im Thema Besucher Rekord: Falsches Datum angezeigt geschrieben.
Mike stimmt, fiel mir garnicht auf. Arbeite heute schon 10 Stunden am PC, da lässt das Hirn nach. Die Uhrzeit stimmt und die Besucherzahl.
forum_topic forum_topic
Rika1 hat das Thema Besucher Rekord: Falsches Datum angezeigt erstellt
Im Besucher Rekord wird heute (22. November) als Datum der 24. November angezeigt.Hab heute genau diese Anzahl Besucher online gesehen und darum den Besucher Rekord frei geschaltet, der wurde bisher nicht angezeigt.Also Besucherzahl stimmt, das Datum nicht.Das wurde soeben angezeigt:
forum_message forum_message
eisernerbiker und Ingmar haben 5 neue Beiträge im Thema Hintergrund des Forum verschwunden geschrieben.
Die Breite des Forums stimmt ja nun auch nicht mehr
rating rating
Gabriella hat sich bedankt!
Beitrag: Neues Plugin "Kalenderfarben ändern"
%usernames% hat sich bedankt!
forum_message forum_message
Olaf hat einen neuen Beitrag im Thema Neues Plugin "Kalenderfarben ändern" geschrieben.
Ein neues Update,jetzt auch in V6 verfügbar:Version 0.030-Headerfarbe über alle Kalenderseiten-Schriftfarbe im Header über alle Kalenderseiten-Hoverfarbe im Header über Monats-,Tages- und Jahreskalenderseite-Ereignisse im Monatskalender in fetter Schrift,ja/nein-Ereignisse im Monatskalender Schriftg...
forum_message forum_message
XiNáru und Johannes haben 2 neue Beiträge im Thema Aktuelle Probleme? geschrieben.
vielen dank ja es scheint wieder zu laufen. danke für die antwort
forum_topic forum_topic
XiNáru hat das Thema Aktuelle Probleme? erstellt
Hey, Kann es sein dass Xobor teilweise gerade probleme hat?in meinem forum habe ich gerade das problem dass teilweise posts nur seeeeehr langsam abgeschickt werden, und auch in der übersicht der letzte post nicht aktualisiert wird gerade. das ist jetzt sein ein paar minuten.
forum_topic forum_topic
eisernerbiker hat das Thema Hintergrund des Forum verschwunden erstellt
Hallo, ich habe seit 3 Tagen die App und habe versehentlich dummerweise was am Breakpiont für die Navigation verstellt. Nun ist der Designhintergrund verschwunden und alles weiß auf der Webseite. Auch das Grössenverhaltnis der Grafiken ist verändert.Bei gespeicherten Designs ist auch nichts mehr zu ...
rating rating
Mike48 hat sich bedankt!
Beitrag: Kategorie einblenden
%usernames% hat sich bedankt!
forum_message forum_message
Mats hat einen neuen Beitrag im Thema Kategorie einblenden geschrieben.
Danke, das wars warum auch immer das passiert ist ...
forum_message forum_message
Franz-Jupp und 3 weitere haben 6 neue Beiträge im Thema versteckter Gast geschrieben.
Ich verstehe nicht, wie es zum Icon "Gast" im Screenshot des Eröffnungsbeitrags kommt.Oder gibt's in diesem Forum irgendwelche speziellen Einstellungen, ggf. CSS oder so ?
rating rating
Franz-Jupp hat sich bedankt!
Beitrag: versteckter Gast
%usernames% hat sich bedankt!
forum_topic forum_topic
jube hat das Thema versteckter Gast erstellt
Hallo,eine Frage in die runde, ich sehe in meinem forum immer wieder einen versteckten Gast wie kann das sein?[[File:gast.jpg|none|auto]]vielleicht kennt jemand die antwort?www.capronfahrer.deGrüßejürgen
rating rating
%usernames% hat sich bedankt!
rating rating
Franz-Jupp hat sich bedankt!
Beitrag: Kategorie einblenden
%usernames% hat sich bedankt!
forum_message forum_message
Mike48 hat einen neuen Beitrag im Thema Kategorie einblenden geschrieben.
Die Schrift in den Kategorien haben die gleiche Farbe wie der Hintergrund.. . . Ostfriesische Flagge:Weiße Möve auf weißem Grund
forum_topic forum_topic
Mats hat das Thema Kategorie einblenden erstellt
Ich hoffe das ist einfach, aber ich finde einfach keine Eistellung dafür. Warum werden die Kategorien bei mir nicht gezeigt ?[[File:Screenshot 2024-11-20 194920.jpg|none|auto]][[File:Screenshot 2024-11-20 194847.jpg|none|auto]]
rating rating
Franz-Jupp hat sich bedankt!
Beitrag: Klickzahlen im Keller
%usernames% hat sich bedankt!
rating rating
m.schenker hat sich bedankt!
Beitrag: Kalender-Export möglich?
%usernames% hat sich bedankt!
rating rating
%usernames% hat sich bedankt!
forum_message forum_message
Ingmar hat einen neuen Beitrag im Thema Kalender-Export möglich? geschrieben.
Ist angekommen, ich warte noch auf Rückmeldung und melde mich bei dir, sobald ich die habe
forum_message forum_message
Ingmar hat einen neuen Beitrag im Thema Klickzahlen im Keller geschrieben.
Die "clicks" sagen leider recht wenig über die tatsächliche Nutzung aus.Wir empfehlen daher die "Xobor Premium Statistiken" zu aktivieren - dort lässt sich genau nachempfinden, welche Bereiche des Forums tatsächlich besucht werden und wie oft.ZitatUnd wie ist es bei Euren Zugriffszahlen? Gehen die a...
forum_topic forum_topic
Benjaminbe hat das Thema Klickzahlen im Keller erstellt
Hallo,mein Forum hatte über Monate 500 bis 1000 Clicks am Tag.Jetzt dümpeln die Zugriffszahlen schon seit 14 Tagen bei rund 50 Clicks am Tag. Und mir ist nicht klar, woran das liegen kann.Die Nachrichten im Forum schreibe noch überwiegend ich. Und in den letzten Monaten schreibe ich durchgängig alle...
forum_message forum_message
m.schenker hat einen neuen Beitrag im Thema Kalender-Export möglich? geschrieben.
Ist die Anfrage über das Formular der Webseite bei euch angekommen?Danke, Martin
rating rating
%usernames% hat sich bedankt!
forum_message forum_message
Franz-Jupp hat einen neuen Beitrag im Thema Neue Mitglieder erscheinen nicht in der Mitgliederliste geschrieben.
1) Admin > Benutzer > Gruppen etwas runterscrollen, dort bei Freischaltung neu angemeldeter Mitglieder kontrollieren, welche Art der Registrierung eingestellt ist.Ich empfehle, "Neue Mitglieder manuell in der Administration freischalten und ...."[[File:Screenshot_20241119-172929_Chrome.jpg|none|auto...
forum_topic forum_topic
Hallo,es hat sich ein Mitglied neu angermeldet. Ich habe ein e Mail erhalten das sich ein Mitglied neu angemeldet hat. Dieser erscheint allerdings nicht in der Mitgliederliste. Wie lange dauert die Freischaltung ?Was mache ich bzw. das neue Mitglied falsch ?GrußMarcus
rsummary rsummary
Rika1 und 1 weitere haben 2 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
rsummary rsummary
Ingmar und 1 weitere haben 2 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
rsummary rsummary
Franz-Jupp und 2 weitere haben 3 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
Wer ist Online?
1 Mitglied und 72 Gäste sind Online
Besucher Statistiken
73 Aktive User
1 Mitglied und 72 Gäste sind Online:
Franz-Jupp


Besucherrekord
1274 Benutzer gleichzeitig online (11.10.2019 18:19)

Besucherzähler
Heute waren 3385 Gäste und 14 Mitglieder, gestern 13139 Gäste und 22 Mitglieder online.

Statistiken
Themen 41682
Beiträge 304933
Mitglieder 12.455
Forum empfehlen