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
Gemshorn hat einen neuen Beitrag im Thema Palettentitel bearbeiten geschrieben.
Danke, Ingmar. Sicher eine gute Lösung.Allerdings denke ich, der Gruppenname ist eigentlich GAR nicht notwendig in der Elementansicht. Anders sei es beim Hovern des Icons in der Iconbar. Aber beim aufgepoppten Auswahlmenü reichten im Grunde auch die darin enthaltenen Elemente.
rating rating
Gemshorn hat sich bedankt!
Beitrag: Palettentitel bearbeiten
%usernames% hat sich bedankt!
forum_message forum_message
spotter46 hat einen neuen Beitrag im Thema manchmal wird die alte Admin-Ansicht angezeigt geschrieben.
Es heißt ja immer, bei Bug-Meldungen reagiert der Support schneller, hier scheint's eine Ausnahme zu geben.Gerade wieder passiert.Aus der Mitgliederliste ein Profil aufgerufen, auf "Profil bearbeiten" geklickt.Automatisch werde ich auf das Profil im Adminbereich geleitet.Profil bearbeitet, speichern...
forum_message forum_message
wildflower hat einen neuen Beitrag im Thema Premium Tarif überzahlt | Support gibt keine Antwort geschrieben.
Hallo nochmal,das Problem besteht noch immer und inzwischen ist unsere Administration auch gesperrt, obwohl ich um zügige Bearbeitung gebeten habe. Es wird behauptet, dass keine Zahlung doppelt einging und auf einen Screenshot der das belegt, wird wieder nicht reagiert. Es ist bald 1 Monat her, dass...
forum_message forum_message
Monika Bodeguero hat einen neuen Beitrag im Thema Hat sich seit heute irgendetwas zum Thema Werbeanzeigen verändert? geschrieben.
In den letzten Jahren sind immer mehr Foren-User zu Facebook abgewandert, und die wenigen, die geblieben sind, beklagen sich zunehmend darüber, dass sie die Themen nicht mehr erreichen können, wenn sie ihr iPhone oder Smartphone benutzen. Mir ist das selbst erst aufgefallen, als ich statt mit dem No...
rating rating
Gabriella und 3 weitere haben sich bedankt!
Beitrag: Palettentitel bearbeiten
%usernames% haben sich bedankt!
rating rating
Lady of the light hat sich bedankt!
Beitrag: Hilfe, ich habe alles vergessen
%usernames% hat sich bedankt!
forum_message forum_message
Ingmar hat einen neuen Beitrag im Thema Palettentitel bearbeiten geschrieben.
Zitat von l2otbart_57 im Beitrag #11Doch leider wir bei diesem Text "Icon einfügen" keine Sprache berücksichtigt.Das ist richtig. Da fehlte noch eine Sprachvariable.Zitat von Mike48 im Beitrag #7Die Icons sind in einer Gruppe.Zitat von Gemshorn im Beitrag #8Es sind aber keine Icons, sondern es ist e...
forum_message forum_message
Lonny Fischer hat einen neuen Beitrag im Thema Hilfe, ich habe alles vergessen geschrieben.
Ich habe Hilfe bekommen und bin echt glücklich darüber.Danke !
forum_message forum_message
l2otbart_57 hat einen neuen Beitrag im Thema Palettentitel bearbeiten geschrieben.
hatte auch gedacht, man brauchte nur ein Sprachvariable ändern.Doch leider wir bei diesem Text "Icon einfügen" keine Sprache berücksichtigt.Auch in der Templateentwicklung hat man keinen Zugriff auf die {{iconbar}}, obwohl dort der richtige Ansatzpunkt wäre.nun bleibt nur ein js-Patch in der Iconbar...
forum_message forum_message
Mike48 und 1 weitere haben 6 neue Beiträge im Thema Limit für Freischaltungen geschrieben.
Die Mail Vorlagen gibt es ja schon. Es muss nur im richtigen Moment die passende Mail verschickt werden.
rating rating
Wolfgang hat sich bedankt!
Beitrag: Limit für Freischaltungen
%usernames% hat sich bedankt!
rating rating
Wolfgang hat sich bedankt!
Beitrag: Limit für Freischaltungen
%usernames% hat sich bedankt!
rating rating
Mike48 hat sich bedankt!
Beitrag: Neue Mitglieder - Aktivierung nicht eingestellt.
%usernames% hat sich bedankt!
forum_message forum_message
Ingmar und 1 weitere haben 3 neue Beiträge im Thema Neue Mitglieder - Aktivierung nicht eingestellt. geschrieben.
Zitat von Mike48 im Beitrag #7Ich glaube, es waren Foren, wo ich zum testen das Template/Design schon mal öfter wechseleDu solltest das Design so oft wechseln können wie du möchtest. Dabei dürfen natürlich trotzdem keine Einstellungen verloren gehen Falls du nochmal so einen Fall hast gerne melden.
forum_message forum_message
Ingmar und 1 weitere haben 2 neue Beiträge im Thema Barrierefreiheitsstärkungsgesetz geschrieben.
Ich würde auch sagen euch als Foren-Admins betrifft das erst mal nicht.
forum_message forum_message
Lonny Fischer hat einen neuen Beitrag im Thema Hilfe, ich habe alles vergessen geschrieben.
Danke, da schaue ich mal nach...
forum_message forum_message
Gemshorn und 2 weitere haben 9 neue Beiträge im Thema Palettentitel bearbeiten geschrieben.
Bei Fett, Italic usw. steht ja noch größerer Unsinn im Infotext (das ist aber nicht die gleiche Problematik wie in den aufpoppenden Auswahlfeldern).
rating rating
Gemshorn hat sich bedankt!
Beitrag: Palettentitel bearbeiten
%usernames% hat sich bedankt!
forum_message forum_message
spotter46 hat einen neuen Beitrag im Thema SpendenBox geschrieben.
Bitte die neue Admin-Oberfläche nutzen, bei der alten klappt es nicht.Admin > Premium > Forenkonto Falls aber schon in der neuen Admin-Oberfläche unterwegs, dann die erwähnte eigene Seite deaktivieren.
forum_message forum_message
Gemshorn und 1 weitere haben 2 neue Beiträge im Thema Skript "Header" zweckentfremden geschrieben.
Ja, das ist das Richtige, aber:Lässt sich das auch als Auswahlmenü wie bei den Headers durch einfache Zahleneingabe realisieren?
rating rating
Gemshorn hat sich bedankt!
Beitrag: Skript "Header" zweckentfremden
%usernames% hat sich bedankt!
forum_topic forum_topic
seelenwind hat das Thema SpendenBox erstellt
Irgendwie bekomme ich es nicht hin die Spendenbox einzustellen. Ich lande immer auf meine selbst erstellts Spendenkonto, erstellt auf eigene Seiten. Ich wollte die Spendenbox vom eingestelten System haben um zu wissen was gespendet wurde. Leider landet es immer auf mein Paypalkonto, wo es ja dann ...
forum_topic forum_topic
Gemshorn hat das Thema Skript "Header" zweckentfremden erstellt
Ich hätte gerne eine Möglichkeit - ähnlich dem H-Button - ein Skript für Schriftgröße zu implementieren.Aber eben nicht nur für größere Schrift als die Standardschrift, sondern auch für kleinere.Kann da jemand von euch helfen?
forum_topic forum_topic
Gemshorn hat das Thema Palettentitel bearbeiten erstellt
Beim Verfassen von Beiträgen gibt es unter anderem auch die Auswahl "Farbe einfügen".Klickt man auf das Icon steht dort unpassend "Icon einfügen". Stattdessen sollte z.B. "Farbe wählen" dort stehen.Kann man diesen Text irgendwie bearbeiten - oder ganz elimieren?
forum_message forum_message
Gemshorn hat einen neuen Beitrag im Thema Text zu hell geschrieben.
Ups gefunden, es ist die Schriftfarbe für Texte direkt auf dem Forumshintergrund...Bleibt also nur noch Frage 2.) ...
forum_topic forum_topic
Gemshorn hat das Thema Text zu hell erstellt
Hallo,ich finde nicht, wo ich den Überschriftstext "Icon einfügen" für die Emojipalette dünkler machen könnte:[[File:image.png|none|auto]]Eigentlich könnte er auch ganz weichen.Insofern freue ich mich über eure Tipps, wie ich die Überschrift 1.) dunkler bekomme und 2.) ganz eliminiere.Schon jetzt me...
rating rating
Ingmar hat sich bedankt!
Beitrag: Limit für Freischaltungen
%usernames% hat sich bedankt!
rsummary rsummary
Gabriella und 4 weitere haben 2 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
rsummary rsummary
Wolfgang und 1 weitere haben 3 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
Wer ist Online?
1 Mitglied und 130 Gäste sind Online
Besucher Statistiken
131 Aktive User
1 Mitglied und 130 Gäste sind Online:
Johannes

Heute waren Online
Johannes

Besucherrekord
1274 Benutzer gleichzeitig online (11.10.2019 18:19)

Besucherzähler
Heute waren 130 Gäste und 2 Mitglieder, gestern 6494 Gäste und 27 Mitglieder online.

Statistiken
Themen 42002
Beiträge 307595
Mitglieder 12.582
Forum empfehlen