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
Ingmar hat sich bedankt!
Beitrag: Header nicht sichtbar mobile Ansicht
%usernames% hat sich bedankt!
rating rating
Plaudereckchen hat sich bedankt!
Beitrag: Ich mag kein Ideenklau respektive Urheberrecht !
%usernames% hat sich bedankt!
forum_message forum_message
creator, l2otbart_57 und Kaninchenraum haben 3 neue Beiträge im Thema Header nicht sichtbar mobile Ansicht geschrieben.
Zitat von Kaninchenraum im Beitrag #1wie kann ich den Header in der mobilen Ansicht sichtbar machen?Indem du den HTML-Fehler im Logo-Wizard behebst.
forum_message forum_message
Katzenpfote hat 2 neue Beiträge im Thema Zugriff auf eigenen Domain geschrieben.
Zitat von Ingmar im Beitrag #6Ich habe dir vorhin geantwortet...Perfekt Danke
rating rating
Katzenpfote hat sich bedankt!
Beitrag: Zugriff auf eigenen Domain
%usernames% hat sich bedankt!
forum_message forum_message
Ingmar hat einen neuen Beitrag im Thema Besucherzähler geschrieben.
Und die Frage ist, wie der Unterschied zustande kommt?Die einfachen Statistiken sind nichts als ein "Hit-Counter". Auch bots z.B. von Suchmaschienen können dort ggf. auftauchen,Die Premium-Statistiken sind die einzig verlässliche Quelle für die tatsächlichen Zugriffe.
forum_message forum_message
Ingmar hat einen neuen Beitrag im Thema Zugriff auf eigenen Domain geschrieben.
Zitat von Katzenpfote im Beitrag #5Ich habe doch einen eigen Domain angemeldet, auf den ich doch Zugriff haben sollte? Der läuft doch auf meinen Namen.Wie Johannes schon schrieb:ZitatEine Verwaltung der DNS Einstellungen bieten wir nicht an.Die Domain bei uns ist für den Zugriff aufs Forum konfiguri...
forum_message forum_message
Ingmar hat einen neuen Beitrag im Thema Header nicht sichtbar mobile Ansicht geschrieben.
Zitat von Kaninchenraum im Beitrag #1wie kann ich den Header in der mobilen Ansicht sichtbar machen?Dein Header aus den anderen Templates wird in der mobilen Ansicht nicht verwendet, da das in den wenigsten Fällen ins Layout passen würde (ein mobiltelefon hat eben sehr viel weniger PLatz zur Verfügu...
rating rating
Ingmar hat sich bedankt!
Beitrag: Abo Kündigung und Sicherheit
%usernames% hat sich bedankt!
rating rating
Ingmar hat sich bedankt!
Beitrag: Abo Kündigung und Sicherheit
%usernames% hat sich bedankt!
forum_topic forum_topic
Kaninchenraum hat das Thema Header nicht sichtbar mobile Ansicht erstellt
Hallo zusammen ,wie kann ich den Header in der mobilen Ansicht sichtbar machen?Support konnte bisher nicht helfen und hat mich hierher verwiesen.Weiter kann ich im Forum in der mobilen Ansicht nicht auf meinen Adminbereich zugreifen, sondern muss zuerst die mobile Ansicht aktivieren.[[File:Screensho...
forum_message forum_message
Katzenpfote und Johannes haben 4 neue Beiträge im Thema Zugriff auf eigenen Domain geschrieben.
Zitat von Johannes im Beitrag #4Zitat von Katzenpfote im Beitrag #3Gewünschte Einstellungen kann ich doch erst festlegen wenn ich die jetzigen Einstellungen des DNS kenne, oder nicht?Wozu wollen Sie die DNS Einstelungen ändern?Ich habe doch einen eigen Domain angemeldet, auf den ich doch Zugriff hab...
forum_message forum_message
spotter46 und 3 weitere haben 7 neue Beiträge im Thema Foren-Logo geschrieben.
@allBysterstorfer kann neue animierte GIF selbst erstellen.Zwei Bilder gleichzeitig in das Feld für's Logo funktioniert nicht.Man kann höchstens Zusatzbild und Text unter dem Logo anzeigen lassen, so wie bei uns >> www.zur-blende.deDa steht dann der Blumenstrauß und darunter das mit dem Geburtstag.K...
forum_topic forum_topic
Katzenpfote hat das Thema Zugriff auf eigenen Domain erstellt
Hallo liebe Forengemeinde,Wie komme ich zu meiner eigenen Domain Verwaltung um DNS Einträge zu prüfen ggf. anzupassen?
rating rating
Rika1 und 1 weitere haben sich bedankt!
Beitrag: Foren-Logo
%usernames% haben sich bedankt!
forum_message forum_message
spotter46 und 1 weitere haben 2 neue Beiträge im Thema Iconbar wechselt Position bei PN geschrieben.
Ich habe mal bei unserem Technik-Admin "geklingelt", denn ich finde keine Fehler.Melde mich dann.
forum_topic forum_topic
spotter46 hat das Thema Iconbar wechselt Position bei PN erstellt
Wahrscheinlich ist das schon etwas länger so, aufgefallen aber erst heute.Sobald ich ein PN (Persönliche Nachricht) schreiben will, sieht das noch "jungfräulich" so aus, die Iconbar wie erwartet oberhalb des Textfeldes.[[File:PN_Iconbar1.jpg|none|auto]]Sobald jedoch in's Textfeld geklickt wird um zu...
forum_message forum_message
cleo und 1 weitere haben 2 neue Beiträge im Thema Abo Kündigung und Sicherheit geschrieben.
Hallo Dreimal Ja. LG
rating rating
cleo hat sich bedankt!
Beitrag: Abo Kündigung und Sicherheit
%usernames% hat sich bedankt!
forum_topic forum_topic
Stefan5547 hat das Thema Abo Kündigung und Sicherheit erstellt
Hallo an Alle,Bevor ich ein Abo abschließe, hätte ich ein paar Fragen bitte.1.Sind die Abos monatlich kündbar? 2.Kann man erst die kostenlose Vision testen und später noch upgraden?3.Werden alle Sicherheitsupdates, Server etc. automatisch gemacht?Vielen Dank im Voraus!Grüße
forum_topic forum_topic
Bysterstorfer hat das Thema Foren-Logo erstellt
Moin in die Runde.Ich möchte in unserem Forum neben dem Foren-Logo noch ein animiertes GIF unterbringen.Geht das überhaupt und wenn ja wie?Wir nutzen den Profi Tarif und Templatv4.
rating rating
Katzenpfote hat sich bedankt!
Beitrag: Kann die Statistik für Gäste ausgeblendet werden?
%usernames% hat sich bedankt!
forum_message forum_message
Katzenpfote und 2 weitere haben 3 neue Beiträge im Thema Kann die Statistik für Gäste ausgeblendet werden? geschrieben.
Zitat von Mike48 im Beitrag #3Du verwendest das V6 Template?Da kannst du die Anzeige der Boxen einstellenVielen Dank, hat funktioniert 👍
forum_topic forum_topic
Katzenpfote hat das Thema Kann die Statistik für Gäste ausgeblendet werden? erstellt
Damit meine ich diese Anzeige [[File:IMG_4212.jpeg|none|fullsize]]
forum_message forum_message
Gyoergy hat einen neuen Beitrag im Thema geschlossenes Forum geschrieben.
Hallo Ihr Lieben,bitte nicht falsch verstehen, meine Worte waren auch nicht böse oder abwertend gemeint.Meine Frage war ja nur, wie es überhaupt möglich ist, dass sich jemand registrieren kann, obwohl die Registrierungkomplett abgeschaltet ist. Wenn der Plugin jedoch umgehen werden kann, ist das Lös...
rating rating
spotter46 hat sich bedankt!
Beitrag: Mitgliedernamen in grün
%usernames% hat sich bedankt!
forum_message forum_message
old-smokey hat einen neuen Beitrag im Thema Besucherzähler geschrieben.
@Ingmar Eine Frage zum Besucherzähler- aktuell wird bei uns eine sehr hohe tägliche Anzahl an Gästen angezeigt, lt. den Premium Statistiken liegen für heute aber nur 871 Besuche insgesamt vor.BesucherzählerHeute waren 3113 Gäste und 396 Mitglieder online. Foren-Nummer 778993
rsummary rsummary
Ingmar und 1 weitere haben 2 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
rsummary rsummary
Ingmar hat 2 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
Wer ist Online?
5 Mitglieder und 148 Gäste sind Online
Besucher Statistiken
153 Aktive User
5 Mitglieder und 148 Gäste sind Online:
Ingmar, Mike48, Lady of the light, Stefan5547, Katzenpfote


Besucherrekord
1274 Benutzer gleichzeitig online (11.10.2019 18:19)

Besucherzähler
Heute waren 2767 Gäste und 25 Mitglieder, gestern 4413 Gäste und 26 Mitglieder online.

Statistiken
Themen 41886
Beiträge 306797
Mitglieder 12.569
Forum empfehlen