v1.1

Issues #4, 6, 7, 9

Author: mcprostar205

BuddyNotify-source/README.md

@@ -1,8 +1,9 @@
-#BuddyNotify v1.0
+#BuddyNotify v1.1
 
 Plugin for PocketMine-MP that sends email notifications to players when server starts/stops and/or when their buddy's join/leave. 
 
    Copyright (C) 2015 Scott Handley
+   https://github.com/mcprostar205/pocketmine-plugins/tree/master/BuddyNotify-source
 
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
@@ -60,14 +61,25 @@ For more information on setting up and configuring BuddyNotify, please see the D
 * `/email ur|unreg : Unregister your email from receiving alerts`
 * `/email us|unsub <buddy>  : Unsubscribe from a buddy's alerts`
 * `/email ?|help : Show sub-command help`
-* From Console: `/email <player> a|add <buddy> : Add buddy to player's alerts`
-* From Console: `/email <player> d|del <buddy> : Remove buddy from player's alerts`
-* From Console: `/email <player> ls|list  : Show player's alerts email and assigned buddies`
-* From Console: `/email s|send <player>|all <message> : Send a player or everyone an email`
-* From Console: `/email <player> r|reg <email> : Register player's email to receive alerts`
-* From Console: `/email <player> ur|unreg  : Unregister player's email from receiving alerts`
-* From Console: `/email <buddy> us|unsub <player> : Unsubscribe player another player's alerts`
-* From Console: `/email ?|help : Show sub-command help`
+* From Console: `email <player> a|add <buddy> : Add buddy to player's alerts`
+* From Console: `email <player> d|del <buddy> : Remove buddy from player's alerts`
+* From Console: `email <player> ls|list  : Show player's alerts email and assigned buddies`
+* From Console: `email s|send <player>|all <message> : Send a player or everyone an email`
+* From Console: `email <player> r|reg <email> : Register player's email to receive alerts`
+* From Console: `email <player> ur|unreg  : Unregister player's email from receiving alerts`
+* From Console: `email <buddy> us|unsub <player> : Unsubscribe player another player's alerts`
+* From Console: `email ?|help : Show sub-command help`
+* From Console: `stop noemail : Shutdown the server without sending an email notification. After the next start/stop, notification will resume.`
+
+## Installation Instructions
+
+* Install and enable an appropriate mail server for your operating system. Verify it is operating correctly on its own by sending a sample email.
+* Open the PocketMine PHP configuration (bin/php5/bin/php.ini) and edit (or add) the "sendmail_path" with the path to your email server software.
+* Download The BuddyNotify plugin and install it in the PocketMine plugins folder.
+* Restart your PocketMine Server to active the plugin for the first time.
+* Open _BuddyNotify/config.yml_, edit the "server-address" property with a valid system operator's email address, and save.
+* Restart your PocketMine Server to activate the new configuration with valid server-address.
+* Register players and send a sample notification.
 
 ## Configuration
 
@@ -76,23 +88,60 @@ You can modify the _BuddyNotify/config.yml_ file on the _plugins_ directory once
 | Configuration | Type | Default | Description |
 | :---: | :---: | :---: | :--- |
 | buddynotifier | boolean | true | Master switch turning the notification system on or off. Good for maintenance activities to prevent spamming.
-| system-address | string | true | Server administration email address from which server notifications are sent.
+| system-address | string | <empty> | Server administration email address from which server notifications are sent.
+| l10n-file | string | l10n.html | Localized string file for in-game and email notifications.
 | notify-start | boolean | true | Enable server started notifications for registered players.
 | notify-stop | boolean | true | Enable server shutdown notifications for registered players.
 | notify-auth | boolean | true | Enable player joined notifications for subscribed players.
 | notify-quit | boolean | true | Enable player quit notifications for subscribed players.
+| notify-delay | integer | 5000 | Delay in milliseconds before sending a notification.
 | date-format | string | "D M j, Y, g:i a" | Configures date/time in localized format.
 
 ### Localization
 
-Commands and email messages can be localized by translating the text in the l10n.yml configuration file.
+Commands and email messages can be localized by translating the text in the l10n.yml and 
+l10n_html.yml configuration files.
 
 ### Email
 
 Your server must have a mail server configured and operational for this plug-in to 
 function. You need to update your 'php.ini' file with the correct command. You may 
 need to update the line break specific to your operating system. This configuration 
-'header-crlf' can be found in the 'l10n.yml' file
+'header-crlf' can be found in the 'l10n.yml' or 'l10n_html.yml' file.
+
+By default, BuddyNotify delivers email notifications in plain text. However, BuddyNotify
+can send HTML formatted notifications providing a more interactive experience. To enable 
+HTML notifications, change the 'l10n-file' to 'l10n_html.yml' in the 'config.yml'.
+
+## Frequently Asked Questions
+
+BuddyNotify requires the server hosting PocketMine-MP have an email server running to 
+relay messages to recipients (such as sendmail on unix). Once you have verified your 
+mail relay is working on its own, be sure to update the PocketMine-MP's php.ini for 
+the mail command.
+
+On Unix, _php.ini_ can be found in the PocketMine-MP location under _bin/php5/bin_. 
+A common mail configuration would be:
+
+`[mail function]`
+`sendmail_path="/usr/sbin/sendmail -t"​`
+
+Below are some common questions and answers:
+`[BuddyNotify] System alerts disabled. System operator email address not set in 'config.xml'.`
+You have not updated the "system-address" property in _plugins/BuddyNotify/config.xml_ 
+with a valid system administrators email address.​
+
+`[BuddyNotify] Unable to send. Check the master switch in the 'config.cfg'`
+You have set the "buddynotifier" property to "false" in _plugins/BuddyNotify/config.xml"_
+
+`[BuddyNotify] Unable to send. There are no registered email addresses.`
+No player has registered their email address. Either inform players to register their email 
+addresses or register player email addresses from the console.
+​
+`[BuddyNotify] Unable to send. Check the 'sendmail_path' property in 'php.ini' is correct.`
+There is a problem sending mail. Possible causes:
+- You haven't installed, configured, or activated your email server relay
+- You haven't configured the PocketMine PHP.ini with the path to your email server executable​
 
 ## Permissions
 
@@ -109,4 +158,24 @@ All methods are available through the main plugin object
 * boolean isFeatureEnabled(String $feature)
 * boolean isPlayerRegistered(String $playername)
 * String [] getBuddyList(String $playername)
-* String sendEmail(String $from, String $to, $subject, $body, $bcc=null)
+* String sendEmail(String $from, String $to, $subject, $body, $bcc=null)
+
+## Release Notes
+
+### 1.1
+
+* Improved player join/quit email notifications to reduce notification sent when a player drops from the game briefly and re-joins within a specified time interval.
+
+A configuration entry `notify-delay` can be added to increase or decrease the time interval before issuing a quit notification. Default time is 5 minutes.
+
+* Added configuration entry `l10n-file` to specify which localization file to use (e.g l10n_fr-fr.yml)
+
+* Added capability to send email notification in HTML format for richer formatting and interactive experience using hypertext.
+
+A default `l10n_html.yml` file has been included to demonstrate. It can be assigned to `l10n-file` config entry.
+
+* Added capability to suppress email notifications temporarily on a server "restart" (stop followed by start).
+
+Console command to suppress notification => `stop noemail`
+
+* No longer sends email notifications when the "reload" command is issued.

BuddyNotify-source/plugin.yml

@@ -1,6 +1,6 @@
 name: BuddyNotify
 main: BuddyNotify\BuddyNotify
-version: "1.0"
+version: "1.1"
 api: [1.10.0]
 load: STARTUP
 author: Scott Handley

BuddyNotify-source/resources/config.yml

@@ -1,9 +1,11 @@
 ---
 buddynotifier: true
 system-address: 
+l10n-file: l10n.yml
 notify-start: true
 notify-stop: true
 notify-auth: true
 notify-quit: true
+notify-delay: 5000
 date-format: "D M j, Y, g:i a"
 ...

BuddyNotify-source/resources/l10n.yml

@@ -14,9 +14,10 @@ email:
     event-quit: "%s left '%s'" 
   body:
     greeting: "Hello %s,\n\n"
-    signature: "\n\nFrom,\n%s\n\n--Sent from '%s'"
+    signature: "\n\nFrom,\n%s\n\n----\nSent by BuddyNotify\nhttps://forums.pocketmine.net/plugins/buddynotify.1344/"
     players-hdr: "\n\nOnline Players:\n\n"
-    players-row: " * %s -> %s\n"
+    players-row: " * %s -> %s - %s\n"
+    players-ftr: ""
     event-start: "Server started. Enjoy the game!\n\nDate: %s\n\nServer: %s\n\nVersion: %s"
     event-stop: "Server stopped. Game play will resume shortly.\nYou will receive a message when the server is available.\n\nDate: %s\n\nServer: %s\n\nVersion: %s" 
     event-auth: "%s joined the game.\n\nDate: %s\n\nServer: %s\n\nWorld: %s"

BuddyNotify-source/resources/l10n_html.yml

@@ -0,0 +1,69 @@
+---
+labels:
+  players: "Players"
+  sysadmin: "System Administrator"
+email:
+  header-crlf: "\r\n"
+  header-mime: "text/html; charset=iso-8859-1"
+  subject:
+    prefix: "PocketMine - "
+    cmd-send: "'%s' has sent you a message"
+    event-start: "Start - %s"
+    event-stop: "Stop - %s" 
+    event-auth: "%s joined '%s'"
+    event-quit: "%s left '%s'" 
+  body:
+    html-head: ""
+    greeting: "<p>Hello %s,</p>"
+    signature: "<p>From,<br>%s</p><p>--Sent by <a href='https://forums.pocketmine.net/plugins/buddynotify.1344/'>BuddyNotify</a></p>"
+    players-hdr: "<h3>Online Players</h3><table><tr bgcolor='e8e8e8'><td><strong>Player</strong></td><td><strong>World</strong></td><td><strong>Mode</strong></td></tr>"
+    players-row: "<tr bgcolor='f8f8f8'><td>%s</td><td>%s</td><td>%s</td></tr>"
+    players-ftr: "</table>"
+    event-start: "<p>Server started. Enjoy the game!</p><table cellpadding='1'><tr><td bgcolor='e8e8e8'><strong>Date</strong></td><td bgcolor='f8f8f8'>%s</td></tr><tr><td bgcolor='e8e8e8'><strong>Server</strong></td><td bgcolor='f8f8f8'>%s</td></tr><tr><td bgcolor='e8e8e8'><strong>Version</strong></td><td bgcolor='f8f8f8'>%s</td></tr></table>"
+    event-stop: "<p>Server stopped. Game play will resume shortly. You will receive a message when the server is available.</p><table cellpadding='1'><tr><td bgcolor='e8e8e8'><strong>Date</strong></td><td bgcolor='f8f8f8'>%s</td></tr><tr><td bgcolor='e8e8e8'><strong>Server</strong></td><td bgcolor='f8f8f8'>%s</td></tr><tr><td bgcolor='e8e8e8'><strong>Version</strong></td><td bgcolor='f8f8f8'>%s</td></tr></table>" 
+    event-auth: "<p><strong>%s</strong> joined the game.</p><table cellpadding='1'><tr><td bgcolor='e8e8e8'><strong>Date</strong></td><td bgcolor='f8f8f8'>%s</td></tr><tr><td bgcolor='e8e8e8'><strong>Server</strong></td><td bgcolor='f8f8f8'>%s</td></tr><tr><td bgcolor='e8e8e8'><strong>World</strong></td><td bgcolor='f8f8f8'>%s</td></tr></table>"
+    event-quit: "<p><strong>%s</strong> left the game.</p><table cellpadding='1'><tr><td bgcolor='e8e8e8'><strong>Date</strong></td><td bgcolor='f8f8f8'>%s</td></tr><tr><td bgcolor='e8e8e8'><strong>Server</strong></td><td bgcolor='f8f8f8'>%s</td></tr><tr><td bgcolor='e8e8e8'><strong>World</strong></td><td bgcolor='f8f8f8'>%s</td></tr></table>"
+    cmd-send: "<p>%s</p>"
+commands:
+  msg-add-success: "%s added to buddy list"
+  msg-add-error: "%s is already a buddy"
+  msg-del-success: "%s removed from buddy list"
+  msg-del-error: "%s is not a buddy"
+  msg-list-email-label: "Address: "
+  msg-list-email-unset: "Empty - use '/email reg <email>' command"
+  msg-list-buddy-label: "Buddies: "
+  msg-list-buddy-unset: "Empty - use '/email add <player>' command"
+  msg-reg-success: "Email address added"
+  msg-reg-error: "Invalid email address"
+  msg-unreg-success: "Email address removed"
+  msg-send-success: "Your email was sent"
+  msg-send-general-error: "Unable to send. Contact the Admin."
+  msg-player-not-registered: "No email address for '%s'"
+console:
+  msg-all-notifications-off: "Unable to send. Check the master switch in the 'config.cfg'"
+  msg_player_no_buddies: "%s has no buddies"
+  msg-player-not-registered: "Unable to send. The player, %s, has not registered an email address."
+  msg-send-error: "Unable to send. Check the 'sendmail_path' property in 'php.ini' is correct."
+  msg-send-success: "Your email was sent"    
+  msg-sysadmin-email-notset1: "System alerts disabled. System operator email address not set in 'config.xml'."
+  msg-sysadmin-email-notset2: "Unable to send. System operator email address not set in 'config.xml'."
+  msg-no-registered-emails: "Unable to send. There are no registered email addresses."
+usage:
+  header: "---Showing email sub-command help page"
+  player:
+    cmd-add: "Add buddy to your alerts"
+    cmd-del: "Remove buddy from your alerts"
+    cmd-list: "Show your email and buddy configuration"
+    cmd-send: "Send a player an email"
+    cmd-reg: "Register your email to receive alerts"
+    cmd-unreg: "Unregister your email from receiving alerts"
+    cmd-unsub: "Unsubscribe from a buddy's alerts"
+  console:
+    cmd-add: "Add buddy to player's alerts"
+    cmd-del: "Remove buddy from player's alerts"
+    cmd-list: "Show player's email and buddy configuration"
+    cmd-send: "Send a player or everyone an email"
+    cmd-reg: "Register player's email to receive alerts"
+    cmd-unreg: "Unregister player's email from receiving alerts"
+    cmd-unsub: "Unsubscribe player from another player's alerts"
+...