Initial version

This commit contains a functional plugin. It has been tested by the crawler on https://xmppnetwork.goodbytes.im/
igniterealtime · Dec 19, 2023 · 36a3962 · 36a3962
commit 36a3962
Show file tree

Hide file tree

Showing 13 changed files with 404 additions and 0 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,16 @@
+# EditorConfig helps developers define and maintain consistent coding styles between different editors and IDEs.
+#
+# EditorConfig is awesome: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+indent_style = space
+indent_size = 4
+
+[*.bat]
+end_of_line = crlf
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -0,0 +1,10 @@
+# Version 2023-03-05
+name: Java CI
+on: [push, pull_request]
+
+jobs:
+  build:
+    uses: igniterealtime/openfire-plugin-builder-action/.github/workflows/openfire-plugin-build.yml@main
+    secrets:
+      IGNITE_REALTIME_MAVEN_USERNAME: ${{ secrets.IGNITE_REALTIME_MAVEN_USERNAME }}
+      IGNITE_REALTIME_MAVEN_PASSWORD: ${{ secrets.IGNITE_REALTIME_MAVEN_PASSWORD }}
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,30 @@
+target/
+work/
+*.class
+
+# Ignore Intellij Idea project files
+*.iml
+*.ipr
+.idea
+atlassian-ide-plugin.xml
+out/
+
+# Ignore Eclipse project files
+.settings
+.project
+.classpath
+
+# Ignore MacOSX files
+.DS_Store
+
+# Ignore Netbeans project files
+nbproject/
+nbbuild/
+/bin/
+
+# Microsoft Visual Studio Code
+.vscode/
+
+# build temp folders
+rpmbuild/
+debian/
diff --git a/changelog.html b/changelog.html
@@ -0,0 +1,53 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+
+<html>
+<head>
+    <title>PubSub Server Info Plugin Changelog</title>
+    <style type="text/css">
+        BODY {
+            font-size : 100%;
+        }
+        BODY, TD, TH {
+            font-family : tahoma, verdana, arial, helvetica, sans-serif;
+            font-size : 0.8em;
+        }
+        H2 {
+             font-size : 10pt;
+             font-weight : bold;
+             padding-left : 1em;
+        }
+        A:hover {
+            text-decoration : none;
+        }
+        H1 {
+            font-family : tahoma, arial, helvetica, sans-serif;
+            font-size : 1.4em;
+            font-weight: bold;
+            border-bottom : 1px #ccc solid;
+            padding-bottom : 2px;
+        }
+
+        TT {
+            font-family : courier new;
+            font-weight : bold;
+            color : #060;
+        }
+        PRE {
+            font-family : courier new;
+            font-size : 100%;
+        }
+    </style>
+</head>
+<body>
+
+<h1>
+    PubSub Server Info Plugin Changelog
+</h1>
+
+<p><b>1.0.0</b> -- (tbd)</p>
+<ul>
+    <li>Initial release.</li>
+</ul>
+
+</body>
+</html>
diff --git a/logo_large.png b/logo_large.png
diff --git a/logo_small.png b/logo_small.png
diff --git a/plugin.xml b/plugin.xml
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<plugin>
+    <class>org.igniterealtime.openfire.plugin.pubsubserverinfo.PubSubServerInfoPlugin</class>
+    <name>${project.name}</name>
+    <description>${project.description}</description>
+    <author>Guus der Kinderen</author>
+    <version>${project.version}</version>
+    <date>2023-12-19</date>
+    <minServerVersion>4.8.0</minServerVersion>
+</plugin>
diff --git a/pom.xml b/pom.xml
@@ -0,0 +1,49 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <artifactId>plugins</artifactId>
+        <groupId>org.igniterealtime.openfire</groupId>
+        <version>4.8.0-beta</version>
+    </parent>
+
+    <groupId>org.igniterealtime.openfire.plugins</groupId>
+    <artifactId>pubsubserverinfo</artifactId>
+    <version>1.0.0-SNAPSHOT</version>
+
+    <name>PubSub Server Info</name>
+    <description>Exposes basic server information through a public Pub/Sub node.</description>
+
+    <build>
+        <sourceDirectory>src/java</sourceDirectory>
+        <plugins>
+            <plugin>
+                <artifactId>maven-assembly-plugin</artifactId>
+            </plugin>
+        </plugins>
+    </build>
+
+    <repositories>
+        <!-- Where we obtain dependencies (such as the parent project). -->
+        <repository>
+            <id>igniterealtime</id>
+            <name>Ignite Realtime Repository</name>
+            <url>https://igniterealtime.org/archiva/repository/maven/</url>
+        </repository>
+    </repositories>
+
+    <pluginRepositories>
+        <!-- Typically used to retrieve Maven plugins used by this project from. This
+             apparently is also used to obtain the dependencies _used by_ plugins
+             (eg: openfire-plugin-assembly-descriptor) -->
+        <pluginRepository>
+            <id>igniterealtime</id>
+            <name>Ignite Realtime Repository</name>
+            <url>https://igniterealtime.org/archiva/repository/maven/</url>
+        </pluginRepository>
+    </pluginRepositories>
+
+</project>
diff --git a/readme.html b/readme.html
@@ -0,0 +1,62 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+
+<html>
+<head>
+    <title>PubSub Server Info Plugin Readme</title>
+    <style type="text/css">
+        BODY {
+            font-size : 100%;
+        }
+        BODY {
+            font-family : tahoma, verdana, arial, helvetica, sans-serif;
+            font-size : 0.8em;
+        }
+        H2 {
+             font-size : 10pt;
+             font-weight : bold;
+        }
+        A:hover {
+            text-decoration : none;
+        }
+        H1 {
+            font-family : tahoma, arial, helvetica, sans-serif;
+            font-size : 1.4em;
+            font-weight: bold;
+            border-bottom : 1px #ccc solid;
+            padding-bottom : 2px;
+        }
+    </style>
+</head>
+<body>
+
+<h1>
+    PubSub Server Info Plugin Readme
+</h1>
+
+<h2>Overview</h2>
+
+<p>
+    The Pubsub Server Info plugin provides a way for Openfire to report statistics about itself in a well-known pub-sub
+    node: 'serverinfo'. The data format is defined in <a href="https://xmpp.org/extensions/inbox/xep-pubsub-server-info.html">XEP-xxxx: PubSub Server Info</a>.
+</p>
+<p>
+    Note: at the time of writing, the protocol as implemented by this plugin has not yet been accepted for consideration or approved
+    in any official manner by the XMPP Standards Foundation, and this document is not yet an XMPP Extension Protocol (XEP). This plugin should
+    be considered experimental.
+</p>
+
+<h2>Installation</h2>
+
+<p>
+    Copy pubsubserverinfo.jar into the plugins directory of your Openfire installation. The plugin will then be
+    automatically deployed. To upgrade to a new version, copy the new pubsubserverinfo.jar file over the existing
+    file.
+</p>
+
+<h2>Attribution</h2>
+<p>
+    <a href="https://www.flaticon.com/free-icons/info" title="info icons">Info icons created by Freepik - Flaticon</a>
+</p>
+
+</body>
+</html>
diff --git a/readme.md b/readme.md
@@ -0,0 +1,17 @@
+# Openfire PubSub Server Info Plugin
+
+The PubSub Server Info plugin provides a way for Openfire to report statistics about itself in a well-known pub-sub
+node: 'serverinfo'. The data format is defined in [XEP-xxxx: PubSub Server Info](https://xmpp.org/extensions/inbox/xep-pubsub-server-info.html).
+
+Note: at the time of writing, the protocol as implemented by this plugin has not yet been accepted for consideration or approved 
+in any official manner by the XMPP Standards Foundation, and this document is not yet an XMPP Extension Protocol (XEP). This plugin should
+be considered experimental.
+
+## Installation
+Copy pubsubserverinfo.jar into the plugins directory of your Openfire installation. The plugin will then be
+automatically deployed. To upgrade to a new version, copy the new pubsubserverinfo.jar file over the existing
+file.
+
+## Reporting Issues
+
+Issues may be reported to the [forums](https://discourse.igniterealtime.org) or via this repo's [Github Issues](https://github.com/igniterealtime/openfire-pubsubserverinfo-plugin).
diff --git a/src/i18n/pubsubserverinfo_i18n.properties b/src/i18n/pubsubserverinfo_i18n.properties
@@ -0,0 +1,2 @@
+system_property.plugin.pubsubserverinfo.nodeid=The ID of the pub-sub node on which server info data will be published.
+system_property.plugin.pubsubserverinfo.refresh.interval=The frequency with which published server info data will be refreshed.
diff --git a/src/i18n/pubsubserverinfo_i18n_nl.properties b/src/i18n/pubsubserverinfo_i18n_nl.properties
@@ -0,0 +1,2 @@
+system_property.plugin.pubsubserverinfo.nodeid=De pub-sub node-ID van de node waarop server info data wordt gepubliceerd.
+system_property.plugin.pubsubserverinfo.refresh.interval=De frequentie waarin de gepubliceerde server info data wordt ververst.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		system_property.plugin.pubsubserverinfo.nodeid=The ID of the pub-sub node on which server info data will be published.
		system_property.plugin.pubsubserverinfo.refresh.interval=The frequency with which published server info data will be refreshed.