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_topic forum_topic
l2otbart_57 hat das Thema no_permission_userprofile erstellt
#no_permission_userprofilewenn man hier im Support als Gast über die Userlinks fährt, erhält man Links mit #no_permission_userprofilefast überall, hier z.b. nicht[[File:support_userlink.png|none|400px|400px]]kein Drama, aber woran liegt's?
rating rating
Elvenar-Fan-Forum hat sich bedankt!
Beitrag: Übertriebene Verbindunssperren
%usernames% hat sich bedankt!
forum_message forum_message
l2otbart_57 und 3 weitere haben 13 neue Beiträge im Thema Xobor APP bald für jedes Forum - Jetzt die APP hier Beta testen geschrieben.
Zitat von Ingmar im Beitrag #14Zitat von l2otbart_57 im Beitrag #13unter Opera sehen die Menues anders aus, bisher habe ich die richtigen Knöpfe noch nicht gefunden ....Ja, für den Fall dass Push-Nachrichten vom Nutzer betreits abgelehnt bzw deaktiviert worden sind ist es leider immer recht kompliz...
rating rating
%usernames% hat sich bedankt!
forum_message forum_message
Mike48 und 1 weitere haben 3 neue Beiträge im Thema Entwickler-Talk geschrieben.
Sorry.Habe nicht bis ans Ende geschaut. Waren doch nicht alle Daten in einer Variablen.
rating rating
%usernames% hat sich bedankt!
rating rating
zickzack und 2 weitere haben sich bedankt!
Beitrag: Mit der Vorschau von Beiträgen wird Zitat angehangen
%usernames% haben sich bedankt!
rating rating
Franz-Jupp und 1 weitere haben sich bedankt!
Beitrag: Kategorie deaktivieren und aktivieren
%usernames% haben sich bedankt!
forum_message forum_message
Ingmar hat einen neuen Beitrag im Thema Mit der Vorschau von Beiträgen wird Zitat angehangen geschrieben.
Ich sehe gerade mit dem Update gestern ist dieser bereits behobene Fehler wieder online. Sorry dafür, wird schnellstmöglich noch einmal behoben
forum_message forum_message
Ingmar und 3 weitere haben 9 neue Beiträge im Thema Kategorie deaktivieren und aktivieren geschrieben.
Zitat von Mike48 im Beitrag #9Der Banner den Creator zeigt kommt nur bei deaktivierten Foren aber nicht bei deaktivierten Kategorien. Außerdem wird bei Kategorien beim aktivieren und deaktivieren immer Forum statt Kategorie gesagt.Ist BugDanke für's genau hinschauen.Ist ~intern behoben~ Änderungen ...
rating rating
%usernames% hat sich bedankt!
rating rating
Franz-Jupp hat sich bedankt!
Beitrag: Problem: Datei anhängen ragt in die Seite rein
%usernames% hat sich bedankt!
forum_message forum_message
Ingmar und 2 weitere haben 3 neue Beiträge im Thema Problem: Datei anhängen ragt in die Seite rein geschrieben.
Seltsam. Das wird absichtlich per Javascript 100 Pixel "nach oben" geschoben, wenn es bereits hochgeladene Dateien gibt {{files==true}}Ich tippe mal das hatte irgendwann mal einen Sinn - aktuell scheint es aber in allen Browsern den gezeigten Fehler zu verursachen.Ich habe die entsprechende Zeile en...
rating rating
Ingmar hat sich bedankt!
Beitrag: Problem: Datei anhängen ragt in die Seite rein
%usernames% hat sich bedankt!
rating rating
Naturfreund hat sich bedankt!
Beitrag: Problem: Datei anhängen ragt in die Seite rein
%usernames% hat sich bedankt!
rating rating
Franz-Jupp und 1 weitere haben sich bedankt!
Beitrag: Kategorie deaktivieren und aktivieren
%usernames% haben sich bedankt!
forum_message forum_message
Ingmar und 2 weitere haben 3 neue Beiträge im Thema Xobor APP bald für jedes Forum - Jetzt die APP hier Beta testen geschrieben.
Zitat von Mike48 im Beitrag #6Ich kann auf meinem iPhone 11 im Safari den Button Push Nachrichten aktivieren nicht betätigen. Ist ausgegraut.Apple unterstützt Push Nachrichten nur, wenn die Webseite auf dem Gerät installiert wurde.Da scheint es noch einen Fehler zu geben, weshalb dieser Hinweistext ...
forum_topic forum_topic
Hajo22 hat das Thema Kategorie deaktivieren und aktivieren erstellt
Ich habe eine Kategorie deaktiviert und bekomme sie nicht aktiviert. Wie funktioniert das und welche Idee steht dahinter?
forum_message forum_message
Franz-Jupp und 1 weitere haben 2 neue Beiträge im Thema Xobor APP bald für jedes Forum - Jetzt die APP hier Beta testen geschrieben.
Zitat von Silvi im Beitrag #3Ich würde gern testen aber ich kann mich auf dem Handy nicht im Forum anmelden. Es kommt immer der Hinweis Benutzername falsch bzw. Passwort.Hab' ich auch schon gehabt, damals hat die automatische Rechtschreibekorrektur dazwischen gefunkt - die hab' ich inzwischen deakti...
forum_message forum_message
Ingmar hat einen neuen Beitrag im Thema Webmail Fehler geschrieben.
Siehe Webmailer
forum_topic forum_topic
Roger34385 hat das Thema Webmail Fehler erstellt
... beim Löschen von Mails; danke für Überprüfung.[[File:Bildschirmfoto 2024-04-18 um 20.06.47.png|none|fullsize]]
forum_message forum_message
markusp und 1 weitere haben 2 neue Beiträge im Thema https - Verschluesselung weg geschrieben.
Danke !wie auch immer wir das ausgeschaltet haben - danke für die wirklich prompte Reaktion.
rating rating
markusp hat sich bedankt!
Beitrag: https - Verschluesselung weg
%usernames% hat sich bedankt!
forum_topic forum_topic
markusp hat das Thema https - Verschluesselung weg erstellt
Hallo,kann mal jemand schauen? - DankeForum 184918 loewenfrankfurt-playground.dedie URL ist - wohl seit gestern ca. 16:00 Uhr - nicht mehr per https erreichbar - was auch einige seltsame Seiteneffekte bzgl.gelesener Beiträge hat.MAn landet auf einer unverschlüsselten Version der seite.
rating rating
Knox und 1 weitere haben sich bedankt!
Beitrag: Top & Flop - Generation 2.0
%usernames% haben sich bedankt!
rating rating
%usernames% hat sich bedankt!
forum_message forum_message
Ludger hat einen neuen Beitrag im Thema Xobor APP bald für jedes Forum - Jetzt die APP hier Beta testen geschrieben.
[[File:Ashampoo_Snap_Mittwoch, 17. April 2024_18h34m10s_002_.jpg|none|301px|301px]]am PC getestet .... klasse !
forum_message forum_message
Mike48 hat einen neuen Beitrag im Thema Top & Flop - Generation 2.0 geschrieben.
Da im Plugin nur die ID's der Foren, Themen, Alben und Rating-Buttons gespeichert werden ist bei vielen ID's schwirig, den Überblick zu behalten. Ich habe das Plugin um einige Tabelen erweitert. Es gibt folgende Tabellen:- Tabelle mit allen aktiven Kategorien und Foren mit ID, Ebene (Kat, Forum, Unt...
rating rating
Ludger und 4 weitere haben sich bedankt!
Beitrag: Xobor APP bald für jedes Forum - Jetzt die APP hier Beta testen
%usernames% haben sich bedankt!
forum_message forum_message
SusanneG und 1 weitere haben 4 neue Beiträge im Thema Hilfe, ReCaptcha weg geschrieben.
Zitat von Ingmar im Beitrag #33Fehler gefunden und ~intern behoben~Danke!
rating rating
SusanneG hat sich bedankt!
Beitrag: Hilfe, ReCaptcha weg
%usernames% hat sich bedankt!
rsummary rsummary
Kräuterhexe und 4 weitere haben 3 Beiträge bewertet (Details)
%usernames% haben sich bedankt!
rsummary rsummary
Franz-Jupp hat 2 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
rsummary rsummary
Ingmar und 2 weitere haben 3 Beiträge bewertet (Details)
%usernames% haben sich bedankt!
rsummary rsummary
Knox und 2 weitere haben 2 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
Wer ist Online?
2 Mitglieder und 79 Gäste sind Online
Besucher Statistiken
81 Aktive User
2 Mitglieder und 79 Gäste sind Online:
Franz-Jupp, Ingmar


Besucherrekord
1274 Benutzer gleichzeitig online (11.10.2019 18:19)

Besucherzähler
Heute waren 2244 Gäste und 18 Mitglieder, gestern 4024 Gäste und 33 Mitglieder online.

Statistiken
Themen 41361
Beiträge 301873
Mitglieder 12.381
Forum empfehlen