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
Marlies Stockmann und Kipper-Spedition haben 4 neue Beiträge im Thema Posten neue Mitglieder geschrieben.
AlkevDanke hab es gefunden aber finde ganz schwer das Supportforum
rating rating
spotter46 und Mike48 haben sich bedankt!
Beitrag: Posten neue Mitglieder
%usernames% haben sich bedankt!
forum_message forum_message
River und spotter46 haben 2 neue Beiträge im Thema Posten neue Mitglieder geschrieben.
Zitat von spotter46 im Beitrag #23Ansonsten hat River zum eigentlichen Thema dieses Threads nichts beigetragen.Das ist so nicht ganz richtig - man muss manchmal auch darauf hinweisen, was für Gepflogenheiten in diesem freundlichen Forum gewünscht oder nicht gewünscht sind, sonst vergisst man ganz, d...
forum_message forum_message
River hat einen neuen Beitrag im Thema Mitgliederliste für bestimmte Usergruppe sichtbar einstellen geschrieben.
Hallo Andreas,Das sollte zu finden sein unter: Admin > Gruppen - dort die jeweilige Benutzergruppe anklicken > nach unten scrollen zu Sektion 'Zugriffsrechte'.Dort gibt es die Option: Einblick der Mitgliederliste & Profile - wo man den Toggle-Button aktivieren muss.Viele GrüßeRiver
rating rating
River und Rika1 haben sich bedankt!
Beitrag: Dennis
%usernames% haben sich bedankt!
forum_message forum_message
River und 3 weitere haben 4 neue Beiträge im Thema Dennis geschrieben.
Zitat von l2otbart_57 im Beitrag #4Das Aufgabenfeld von Denis scheint ein anderes zu sein.Ja, ich glaube auch, dass Denis eher bei der Technik im Background unterwegs ist und hier im Forum so ein Test-Unterforum hat, wo er immer mal was testet.Jedenfalls ist es bestimmt toll bei der Technik im Backg...
rating rating
River hat sich bedankt!
Beitrag: Dennis
%usernames% hat sich bedankt!
rating rating
River und 1 weitere haben sich bedankt!
Beitrag: Dennis
%usernames% haben sich bedankt!
forum_topic forum_topic
Guten Morgen,manchmal sieht man ja "den Wald vor lauter Bäumen nicht":Für Mitglieder einer bestimmten Benutzergruppe soll die Mitgliederliste sichtbar sein,leider wird folgendes angezeigt:Wo kann man das in der Administration einstellen ?VGAndreas
rating rating
Katzenpfote hat sich bedankt!
Beitrag: Dennis
%usernames% hat sich bedankt!
forum_message forum_message
Gabriella und 3 weitere haben 7 neue Beiträge im Thema Posten neue Mitglieder geschrieben.
Ja das ist bei den Einstellungen der alten Admin dasselbe, steht halt nicht so da wie in der neuen, wenn das so eingestellt ist, wie bei mir auf dem Screen gezeigt, können die Mitglieder auch immer Beiträge posten. Sie muss die Zahl von 7 Tagen auf 0 stellen.Das was ich markiert habe ist das, wo man...
forum_message forum_message
River hat einen neuen Beitrag im Thema Dennis geschrieben.
Na ja - ich bin halt jünger und nicht konservativ - ich mach das auch andersrum :)Viele GrüßeRiver
forum_topic forum_topic
Mike48 hat das Thema Dennis erstellt
Zitat von River im Beitrag Posten neue MitgliederA propos, wir haben Denis noch gar nicht richtig begrüßt, obwohl er hier schon seit einer Weile immer wieder anwesend ist.Anwesend reicht ja nicht aus. Es gibt noch keinen Beitrag von ihm. Sollte da irgendwann mal was kommen kann das immer noch tun. B...
rating rating
spotter46 hat sich bedankt!
Beitrag: Posten neue Mitglieder
%usernames% hat sich bedankt!
forum_message forum_message
Gabriella und 2 weitere haben 5 neue Beiträge im Thema Posten neue Mitglieder geschrieben.
Zitat von Mike48 im Beitrag #18Da muss ich dir energisch widersprechen. Das was hier in dem Thema gefragt ist kannst du in der alten Admin überhaupt nicht finden.Doch den Beweis siehst Du auf dem Screenshot, ich arbeite schon wesentlich länger als Du und Jupp mit der Xobor Software!Ich habe jede aus...
rating rating
Wolfgang hat sich bedankt!
Beitrag: Video Upload funktioniert wie genau?
%usernames% hat sich bedankt!
rating rating
Wolfgang hat sich bedankt!
Beitrag: Video Upload funktioniert wie genau?
%usernames% hat sich bedankt!
rating rating
spotter46 hat sich bedankt!
Beitrag: Registrieren nicht möglich
%usernames% hat sich bedankt!
forum_message forum_message
Thofroe und 1 weitere haben 2 neue Beiträge im Thema Registrieren nicht möglich geschrieben.
Habe noch einmal probiert und es ging sofort ohne Probleme.Allerdings habe ich bei der ersten Abfrage „Möchten Sie von Google reCAPTCHA bereitgestellte externe Inhalte laden?“Bei meinem Fehlversuch hatte ich „JA“ angeklickt und nun „Immer“. Bei einem weiteren Test habe ich festgestellt, dass es egal...
rating rating
spotter46 hat sich bedankt!
Beitrag: Posten neue Mitglieder
%usernames% hat sich bedankt!
forum_message forum_message
Mike48 hat einen neuen Beitrag im Thema Keine Hauptadmin ernennen möglich geschrieben.
Manches in der Admin ist vom Template abhängig. Das betrifft aber hauptsächlich die Rubrik Layout. Ich habe jetzt auch noch mal geteste und festgestellt, dass es wieder funktioniert. Entweder war es eine temporerer Störung oder vom Support wurde was gemacht. Es funktioniert auch auf dem Smartphone. ...
rating rating
Mike48 hat sich bedankt!
Beitrag: Posten neue Mitglieder
%usernames% hat sich bedankt!
rating rating
spotter46 hat sich bedankt!
Beitrag: Posten neue Mitglieder
%usernames% hat sich bedankt!
rating rating
Mike48 hat sich bedankt!
Beitrag: Posten neue Mitglieder
%usernames% hat sich bedankt!
forum_topic forum_topic
Thofroe hat das Thema Registrieren nicht möglich erstellt
Es hat mich gerade jemand angeschrieben, der meinte, er könne sich nicht registrieren.Ich habe daraufhin getestet und es ging bei mir auch nicht.Ich habe alle Cookies gelöscht und versuchte mich dann zu registrieren, aber es kam immer nur die Fehlermeldung:Es ist ein Fehler aufgetreten!Bitte lösen S...
forum_message forum_message
spotter46 und 3 weitere haben 4 neue Beiträge im Thema Posten neue Mitglieder geschrieben.
Leider hat Gabriella nicht Recht, siehe Mike48' Post Zitat von Mike48 im Beitrag #8Arbeitest du mit der alten Admin?Da kannst das nicht finden, das gibt es nur in der neuen Admin in den Benutzer Gruppen.In der alten Admin-Oberfläche lassen sich nur Einstellungen zu den Links vornehmen, nicht die Zah...
rating rating
spotter46 hat sich bedankt!
Beitrag: Posten neue Mitglieder
%usernames% hat sich bedankt!
forum_message forum_message
Marlies Stockmann und 2 weitere haben 4 neue Beiträge im Thema Posten neue Mitglieder geschrieben.
Komm damit nur schwer klar trotzdem danke
forum_message forum_message
spotter46 hat einen neuen Beitrag im Thema Nur Admins können noch spenden geschrieben.
Ich konnte das im Template V3 nicht reproduzieren.TESTUSER ist ein ganz normales Mitglied.Das Spendenziel hatte ich testweise auf 15€ runtergesetzt, Ziel demnach erreicht, Spendenbox wird nicht angezeigt.In der Navigation befindet sich aber ein Button, der zum Forenkonto führt, /donations.htmlTESTUS...
forum_message forum_message
spotter46 und 1 weitere haben 5 neue Beiträge im Thema Posten neue Mitglieder geschrieben.
Zitat von spotter46 im Beitrag Beiträge schreibenZitat von spotter46 im Beitrag Beiträge schreibenBitte sorgfältig lesen und die Einstellungen nach Wunsch verändern - neue Administration verwendenSicherheit in Foren - Forum Update für besseren Schutz vor SpamIm Adminbereich auf Benutzer > Gruppen da...
rsummary rsummary
River und 1 weitere haben 2 Beiträge bewertet (Details)
%usernames% haben sich bedankt!
rsummary rsummary
Wolfgang und 1 weitere haben 3 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
rsummary rsummary
Mike48 und 1 weitere haben 3 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
Wer ist Online?
1 Mitglied und 34 Gäste sind Online
Besucher Statistiken
35 Aktive User
1 Mitglied und 34 Gäste sind Online:
Kipper-Spedition

Heute waren Online
Gabriella, nobody

Besucherrekord
1274 Benutzer gleichzeitig online (11.10.2019 18:19)

Besucherzähler
Heute waren 65 Gäste und 2 Mitglieder, gestern 3539 Gäste und 20 Mitglieder online.

Statistiken
Themen 42084
Beiträge 308317
Mitglieder 12.593
Forum empfehlen