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, Kaninchenraum und creator haben 11 neue Beiträge im Thema Header nicht sichtbar mobile Ansicht geschrieben.
Beim V1 bis V4 kommt man wie folgt in die mobilen EinstellungenAdministration → Layout → Mobil Da kannst du alle Einstellungen für die mobile Ansicht machen. Auch deine Farben in Mobil so wie im Desktop anpassen. Für den Header:Administration → Layout → Mobil →Desktop-Header Zum Beispiel so:[[File:D...
rating rating
Katzenpfote hat sich bedankt!
Beitrag: Foren-Logo
%usernames% hat sich bedankt!
forum_message forum_message
Mike48 und Katzenpfote haben 6 neue Beiträge im Thema Foren-Logo geschrieben.
Ich habe es mal probiert.Administration → Kopf- & FußzeileIm Logo Wizard nur das Logo eingetragen. Ich habe das Logo geändert und den Hintergrund transparent gemacht. Kannst du dir hier runterladen.[[File:Katzen-Logo-3.png|none|600px|600px]]Administration → Layout → Farben & Einstellungen → Desktop-...
rating rating
Katzenpfote hat sich bedankt!
Beitrag: Foren-Logo
%usernames% hat sich bedankt!
forum_message forum_message
spotter46 und Katzenpfote haben 2 neue Beiträge im Thema Foren-Logo geschrieben.
Zitat von Katzenpfote im Beitrag #11Hallo Zusammenwie kann ich das Forenlogo vergrößern?In dem Du das Bild vergrößerst und das alte Logo damit ersetzt
forum_message forum_message
Katzenpfote und creator haben 4 neue Beiträge im Thema Meine Forenadresse wird unter den Beiträgen falsch angezeigt? geschrieben.
Zitat von creator im Beitrag #4Wenn du bei der Signatur etwas nach unten scrollst, wirst du den Link sicher sehen können.Dankeschön für den Hinweis 👏 genauso ist es.
forum_topic forum_topic
Hallo Zusammen,kann mir Jemand sagen warum die Forenadresse falsch angezeigt wird obwohl der Eintrag im Profil richtig ist?Unter den Beiträgen hier wird angezeigt www.katzenforum.dein meinem Profil steht www.katzenforum-nr1.de [[File:IMG_4343.jpeg|none|fullsize]]
forum_message forum_message
Katzenpfote hat einen neuen Beitrag im Thema Zugriff auf eigenen Domain geschrieben.
Danke @Ingmar für den Hinweis, das hatte ich glatt überlesen. Es hat sich gerade Jemand bei mir gemeldet. Vielen Dank
rating rating
Olaf hat sich bedankt!
Beitrag: Laufschrift über Header
%usernames% hat sich bedankt!
forum_message forum_message
creator hat einen neuen Beitrag im Thema Eigene Seite auf dem Smartphone geschrieben.
Zitat von Andreas Lipske im Beitrag #4Wenn man "responsiv" einsetzt, dann haben u.a."div" u. "center" in dem Seitencode nichts mehr verloren...Wo genau hast du das gehört? Das eine hat mit dem anderen nichts zu tun.Center ist "deprecated" (zur Entfernung vormarkiert), funktioniert aber weiterhin. St...
forum_message forum_message
Rika1 hat einen neuen Beitrag im Thema Laufschrift über Header geschrieben.
Lieber Olaf herzlichen Dank! Das ist jetzt genau was ich wollte und funktioniert einwandfrei!
rating rating
Rika1 hat sich bedankt!
Beitrag: Laufschrift über Header
%usernames% hat sich bedankt!
forum_message forum_message
Olaf und 3 weitere haben 6 neue Beiträge im Thema Laufschrift über Header geschrieben.
@Rika1 Ich habe Dir mein Plugin nochmal zugesendet (Version 0.020).Da kannst Du jetzt einstellen,ob die Laufschrift unter der Navi angezeigt werden soll oder über den Header.Sehr wichtig ist,das bei der Einstellung im Plugin "Anzeigen über den Header" beim V6 das Menü von Xobor nicht fixiert sein da...
forum_message forum_message
Andreas Lipske und 1 weitere haben 3 neue Beiträge im Thema Eigene Seite auf dem Smartphone geschrieben.
Hallo Mike,nun habe ich mich etwas schlau gemacht und beschlossen, nichts zu tun:Wenn man "responsiv" einsetzt, dann haben u.a."div" u. "center" in dem Seitencode nichts mehr verloren...Werde daher sicher nicht an > 100 Seiten rumbasteln Meine Lösung: Ich habe Geduld und warte einfach auf die nächst...
rating rating
Olaf hat sich bedankt!
Beitrag: Laufschrift über Header
%usernames% hat sich bedankt!
rating rating
Olaf und 1 weitere haben sich bedankt!
Beitrag: Laufschrift über Header
%usernames% haben sich bedankt!
rating rating
Andreas Lipske hat sich bedankt!
Beitrag: Eigene Seite auf dem Smartphone
%usernames% hat sich bedankt!
rating rating
Rika1 und 1 weitere haben sich bedankt!
Beitrag: Laufschrift über Header
%usernames% haben sich bedankt!
forum_topic forum_topic
Andreas Lipske hat das Thema Eigene Seite auf dem Smartphone erstellt
Hallo allerseits,wie ihr sicher sehr schnell sehen werdet, besteht mein Forum Andili aus dem Portal ( Startseite) und weit über 100 eigenen Seiten. Alle Seiten habe ich so gebastelt, dass der Inhalt maximal 1100px breit ist und zentriert dargestellt wird. D.h. egal wie breit der Monitor bzw. das Bro...
forum_message forum_message
Mike48 und 3 weitere haben 6 neue Beiträge im Thema Laufschrift über Header geschrieben.
Zitat von Rika1 im Beitrag #1Dieses Plugin vermisse ich sehr! Geht mit v6 leider nicht. Wieder mal ein bereuen auf v6 umgestiegen zu sein. Könnte einer von Euch Bastlern da was machen?Das kannst du ganz einfach selber machen. Jürgen hat die meisten seiner Plugins freigegeben. Du kannst dir selber ei...
rating rating
Rika1 hat sich bedankt!
Beitrag: Laufschrift über Header
%usernames% hat sich bedankt!
rating rating
Rika1 hat sich bedankt!
Beitrag: Laufschrift über Header
%usernames% hat sich bedankt!
forum_message forum_message
Ingmar und 1 weitere haben 2 neue Beiträge im Thema Zugriff auf eigenen Domain geschrieben.
So weit ich mich erinnere habe ich damals geantwortet, dass wir für Auftragsarbeiten frühestens nach den Osterferien wieder Kapazitäten haben.Das wäre dann nächste Woche. Der Kollege wird aber sicherlich am Montag auch noch ein paar andere Dinge auf dem Tisch liegen haben - ich kann daher nicht gara...
rating rating
spotter46 hat sich bedankt!
Beitrag: Laufschrift über Header
%usernames% hat sich bedankt!
forum_topic forum_topic
Rika1 hat das Thema Laufschrift über Header erstellt
Dieses Plugin vermisse ich sehr! Geht mit v6 leider nicht. Wieder mal ein bereuen auf v6 umgestiegen zu sein. Könnte einer von Euch Bastlern da was machen? Ich wäre sehr dankbar!
rating rating
%usernames% hat sich bedankt!
forum_message forum_message
Rika1 und 1 weitere haben 3 neue Beiträge im Thema In neu erstellten Unterforum wird Smilie nicht angezeigt geschrieben.
Danke creator, das war es! Hab es jetzt aktiviert, musste aber erst mit "bearbeiten" den Smilie-Codes einen Ruck geben, danach sind sie erschienen.
forum_topic forum_topic
Hallo,gestern erstellte ich ein neues Unterforum erstellt. Nur in diesem Forum wird ein bestimmtes Smilie nicht angezeigt. In anderen Foren wird es angezeigt wie schon immer. Das Smilie gibt es schon immer. Es ist wie alle Smilies bei mir ein Link zu der homepage-bilder-übersicht.Es funktioniert ja ...
%usernames% hat sich bedankt!
rsummary rsummary
Olaf und 3 weitere haben 4 Beiträge bewertet (Details)
%usernames% haben sich bedankt!
rsummary rsummary
Rika1 hat 2 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
Wer ist Online?
0 Mitglieder und 34 Gäste sind Online
Besucher Statistiken
34 Aktive User
0 Mitglieder und 34 Gäste sind Online


Besucherrekord
1274 Benutzer gleichzeitig online (11.10.2019 18:19)

Besucherzähler
Heute waren 848 Gäste und 6 Mitglieder, gestern 3609 Gäste und 22 Mitglieder online.

Statistiken
Themen 41895
Beiträge 306878
Mitglieder 12.579
Forum empfehlen