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
Gabriella hat einen neuen Beitrag im Thema Schriftgrösse im Talk geschrieben.
Hi Muenggi,nun der Betreff ist nicht falsch, im V4 gibt es den Talk, anstelle der Shoutbox und eben den Chat der ist eigenständig und derselbe wie in allen Templates.@Olaf wird auch für den Chat einen Code haben, dieser ist allerdings umfangreicher, wie die Zeile für die Schriftgrösse dafür lautet, ...
rating rating
Ludger hat sich bedankt!
Beitrag: Plugin audio_msg - mp3 im Beitrag abspielen
%usernames% hat sich bedankt!
forum_message forum_message
Muenggi, Olaf und spotter46 haben 3 neue Beiträge im Thema Schriftgrösse im Talk geschrieben.
Besten Dank für die Hilfe.Nur ich hab den falschen Betreff eingestellt.Die Frage sollte heissen:Schriftgrösse im Chat. SorryGibt es dafür auch ein Code?
rating rating
spotter46 und Gabriella haben sich bedankt!
Beitrag: Schriftgrösse im Talk
%usernames% haben sich bedankt!
forum_topic forum_topic
Muenggi hat das Thema Schriftgrösse im Talk erstellt
Guten AbendIch möchte gerne die Schriftgrösse im Talk verändern - sprich vergrössern.Ist viel zu klein für unsere Augen.Habe aber leider die Möglichkeit dafür noch nicht gefunden.Kann mir jemand helfen?
rating rating
spotter46 hat sich bedankt!
Beitrag: Plugin audio_msg - mp3 im Beitrag abspielen
%usernames% hat sich bedankt!
forum_topic forum_topic
l2otbart_57 hat das Thema Plugin audio_msg - mp3 im Beitrag abspielen erstellt
Audio-Daten sind bisher kümmerlich in die Beiträge integriert.Nur als mp3 lassen sie sich hochladen und können dann nur als Link in der Anhangliste aufgerufen werden.Dabei können sie einen Beitrag oder ein Bild wirkungsvoll hervorheben.Dieses Plugin fügt ein Audio-Bedienfeld in den Anhang einAuswir...
forum_message forum_message
Muenggi und Mike48 haben 2 neue Beiträge im Thema Shoutbox geschrieben.
Danke für deine Antwort Mike48Hm - schade aber wohl nicht zu ändern.
forum_message forum_message
Mike48 hat einen neuen Beitrag im Thema Admin Design-Vorlagen geschrieben.
Habe ich auch
forum_topic forum_topic
l2otbart_57 hat das Thema Admin Design-Vorlagen erstellt
Augenblicklich fehlen die Design-VorlagenAdmin → Layout → Design-Vorlagen [[File:design_vorlagen.png|none|auto]][[File:design_vorlagen2.png|none|auto]] Screenshots wieder ab 18.06. 12 Uhr verfügbar
forum_message forum_message
spotter46 hat einen neuen Beitrag im Thema Zugang Wiki begrenzen geschrieben.
Zitat von Mike48 im Beitrag #6Das Plugin funktioniert leider schon lange nicht mehr. Es arbeitet mit Action Elemente und die sind von Miranus abgeschaltet.Sollte man dann solche Plugins seitehs Xobor-Miranus nicht aus der Liste streichen ?
rating rating
Ingmar hat sich bedankt!
Beitrag: Shoutbox
%usernames% hat sich bedankt!
forum_topic forum_topic
Muenggi hat das Thema Shoutbox erstellt
Guten TagIch glaube ich habe Pflaumen auf den Augen. Bin absolut sicher, dass ich den Plugin Shoutbox im Adminbereich schon gesehen habe.Doch leider kann ich ihn nicht mehr finden.Kann es sein, dass man diesen Plugin aus versehen selber löschen kann?Wünsche allen einen schönen Tag und danke für eine...
forum_message forum_message
Mike48 und spotter46 haben 2 neue Beiträge im Thema Zugang Wiki begrenzen geschrieben.
Das Plugin funktioniert leider schon lange nicht mehr. Es arbeitet mit Action Elemente und die sind von Miranus abgeschaltet.
rating rating
m3ontour und spotter46 haben sich bedankt!
Beitrag: Zugang Wiki begrenzen
%usernames% haben sich bedankt!
forum_message forum_message
Ingmar und m3ontour haben 2 neue Beiträge im Thema Zugang Wiki begrenzen geschrieben.
Zitat von m3ontour im Beitrag #3Das ist ja aber nicht Sinn der Sache. Dieser Zustand soll ja Beitrags- und Beteiligungsabhängig sein!Naja dann musst du eben eine Beitrags- und Beteiligungsabhängige Gruppe erstellen.Automatisiert geht das zwar nicht. Aber du kannst natürlich alle Mitglieder, die eine...
forum_message forum_message
spotter46 hat einen neuen Beitrag im Thema Zugang Wiki begrenzen geschrieben.
Wo liegt das Problem ?Du kannst doch, wie in fast allen Bereichen, entsprechende Rechte vergeben. Die "Absauger" einfach in eine besondere Gruppe packen und dieser Gruppe nur eingeschränkte Rechte zuteilen.Geht auch im WIKI[[File:Wiki-Rechte.jpg|none|auto]]
forum_topic forum_topic
m3ontour hat das Thema Zugang Wiki begrenzen erstellt
Hallo,ich habe mal wieder ein Problemchen.Wir haben im Wiki einen Datenpool angelegt.Gibt es die Möglichkeit den Zugang zu diesem Datenpool erst zu erlauben wenn sich das Mitglied aktiv am Forum beteiligt?Also z.B. wenn er 20 Beiträge geschrieben hat, oder so etwas in der Art.In diesem Datenpool sin...
rating rating
spotter46 hat sich bedankt!
Beitrag: Beiträge schreiben
%usernames% hat sich bedankt!
rating rating
Ingmar hat sich bedankt!
Beitrag: E-Mail abgelehnt wegen fehlender DKIM Signatur
%usernames% hat sich bedankt!
forum_message forum_message
m3ontour hat einen neuen Beitrag im Thema Beiträge schreiben geschrieben.
Hallo,vielen Dank. Mit Ruhe hab ich es jetzt gefunden,Zwischen Tür und Angel sollte man auch nicht wegen so etwas agieren.Danke
rating rating
m3ontour hat sich bedankt!
Beitrag: Beiträge schreiben
%usernames% hat sich bedankt!
forum_message forum_message
Mike48 und Ingmar haben 3 neue Beiträge im Thema E-Mail abgelehnt wegen fehlender DKIM Signatur geschrieben.
Feed Mails. Neuigkeiten aus dem Forum sind wahrscheinlich die Mails, die die User in ihrem Profi einstellen können.
forum_message forum_message
spotter46 und m3ontour haben 2 neue Beiträge im Thema Beiträge schreiben geschrieben.
Zitat von spotter46 im Beitrag #3Bitte 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 dann nach und nach jede Gruppe anklicken, etwas runterscrollen und ...
rating rating
catwiesel und Wolfgang haben sich bedankt!
Beitrag: Favicon nur bei Xobor-Homepage?
%usernames% haben sich bedankt!
rating rating
Kipper-Spedition hat sich bedankt!
Beitrag: YouTube "Shorts" einbetten
%usernames% hat sich bedankt!
rating rating
Kipper-Spedition und Wolfgang haben sich bedankt!
Beitrag: YouTube "Shorts" einbetten
%usernames% haben sich bedankt!
rating rating
Wolfgang hat sich bedankt!
Beitrag: Grafischer Fehler unterhalb einer Infobox.
%usernames% hat sich bedankt!
forum_message forum_message
Ingmar und pasdoe haben 9 neue Beiträge im Thema Favicon nur bei Xobor-Homepage? geschrieben.
Ich habe gerade gemerkt, dass in der mobilen Version die Standard-Icons verwendet werden, wenn kein V6 Template aktiv ist. Eventuell ist das ein Problem für die Anzeige bei Google. Ich versuche das morgen zu beheben.
rsummary rsummary
spotter46 und Ingmar haben 2 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
rsummary rsummary
catwiesel, Wolfgang und Kipper-Spedition haben 4 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
Wer ist Online?
2 Mitglieder und 45 Gäste sind Online
Besucher Statistiken
47 Aktive User
2 Mitglieder und 45 Gäste sind Online:
WarriorCats-VierneueClans, Muenggi


Besucherrekord
1274 Benutzer gleichzeitig online (11.10.2019 18:19)

Besucherzähler
Heute waren 818 Gäste und 14 Mitglieder, gestern 2564 Gäste und 25 Mitglieder online.

Statistiken
Themen 42015
Beiträge 307711
Mitglieder 12.584
Forum empfehlen