Changeset 13777

Timestamp:

01/22/12 15:23:10 (4 weeks ago)

Author:

GeorgeClark

Message:

Item9551: More updates to ImmediateNotify

Pulled the Twitter and IRC code from TweetOnSavePlugin and IrcPlugin.
Not functional here yet, need converting. Changed the templates to real
templates, so they can be more easily overridden using Topic templates.

Added a beforeSaveHandler and a NewTopic context - so the messages can
more easily show created vs updated topics.

Eliminated the MIME multipart headers from the email template, since a
single part message using multipart headers causes issues in Outlook.

Location:

trunk/ImmediateNotifyPlugin

Files:

• lib/Foswiki/Plugins/ImmediateNotifyPlugin.pm (modified) (3 diffs)
• lib/Foswiki/Plugins/ImmediateNotifyPlugin/Config.spec (modified) (3 diffs)
• lib/Foswiki/Plugins/ImmediateNotifyPlugin/IRC.pm (added)
• lib/Foswiki/Plugins/ImmediateNotifyPlugin/SMTP.pm (modified) (1 diff)
• lib/Foswiki/Plugins/ImmediateNotifyPlugin/Twitter.pm (added)
• lib/Foswiki/Plugins/ImmediateNotifyPlugin/XMPP.pm (modified) (2 diffs)
• templates/smtp.immediatenotify.tmpl (modified) (2 diffs)
• templates/xmpp.immediatenotify.tmpl (modified) (1 diff)

trunk/ImmediateNotifyPlugin/lib/Foswiki/Plugins/ImmediateNotifyPlugin.pm

@@ -81 +81 @@
         next if ( $method eq "Module" );
         next if ( $method eq "Enabled" );
+        next if ( $method eq "Bitly" );
         if ( $Foswiki::cfg{Plugins}{ImmediateNotifyPlugin}{$method}{Enabled} ) {
             debug("Allowing method $method");
@@ -215 +216 @@
                 my ( $method, $parms ) =
                   $methodString =~ m/^(.*?)(?:\((.*?)\))?$/;
+                  $parms |= '';
                 debug(
 "- ImmediateNotifyPlugin: processName: User $name found method ($method) parms ($parms) "
@@ -236 +238 @@
 }
 
+
+=begin TML
+
+---+ beforeSaveHandler
+
+Set a flag if this is a new topic.
+
+=cut
+
+sub beforeSaveHandler {
+    my ( $text, $topic, $web, $meta ) = @_;
+
+    unless ( Foswiki::Func::topicExists($web, $topic) ) {
+      Foswiki::Func::getContext()->{'NewTopic'} = 1;
+    }
+}
+
 =begin TML
 

trunk/ImmediateNotifyPlugin/lib/Foswiki/Plugins/ImmediateNotifyPlugin/Config.spec

@@ -1 +1 @@
 # ---+ Extensions
 # ---++ ImmediateNotifyPlugin
+# ---+++ EMail Notifications
 # **BOOLEAN**
 # Enable SMTP for mailing messages. Note:  This plugin uses Foswiki core email support for sending
@@ -15 +16 @@
 $Foswiki::cfg{Plugins}{ImmediateNotifyPlugin}{SMTP}{EmailFilterIn} = '';
 
+# ---+++ Jabber / XMPP
 # **BOOLEAN**
 # Enable XMPP (XMPP) for notifications.
@@ -33 +35 @@
 $Foswiki::cfg{Plugins}{ImmediateNotifyPlugin}{XMPP}{Password} = '';
 
+# ---+++ Twitter
+# **BOOLEAN**
+# Enable Twitter for notifications.
+$Foswiki::cfg{Plugins}{ImmediateNotifyPlugin}{Twitter}{Enabled} = $FALSE;
+
+# **STRING 30**
+# Specify the username for the twitter account
+$Foswiki::cfg{Plugins}{ImmediateNotifyPlugin}{Twitter}{Username} = '';
+
+# **PASSWORD 30**
+# Specify the password for the twitter account
+$Foswiki::cfg{Plugins}{ImmediateNotifyPlugin}{Twitter}{Password} = '';
+
+# ---+++ Bit.ly URL Shortening
+# **BOOLEAN**
+# Enable URL Shortening with Bit.ly.
+$Foswiki::cfg{Plugins}{ImmediateNotifyPlugin}{Bitly}{Enabled} = $FALSE;
+
+# **STRING**
+# Optionally, specify a bit.ly username
+$Foswiki::cfg{Plugins}{ImmediateNotifyPlugin}{Bitly}{Username} = '';
+
+# **STRING**
+# Optionally, specify a bit.ly API key
+$Foswiki::cfg{Plugins}{ImmediateNotifyPlugin}{Bitlly}{APIKey} = '';

trunk/ImmediateNotifyPlugin/lib/Foswiki/Plugins/ImmediateNotifyPlugin/SMTP.pm

@@ -43 +43 @@
     my ($template) = Foswiki::Func::readTemplate( 'smtp', 'immediatenotify' );
 
-    # &$debug("- SMTP:  template read $template");
+    # Expand legacy macros
     my ($from) = Foswiki::Func::getPreferencesValue("WIKIWEBMASTER");
-
     $template =~ s/%EMAILFROM%/$from/go;
-    $template =~ s/%WEB%/$info->{web}/go;
     $template =~ s/%TOPICNAME%/$info->{topic}/go;
     $template =~ s/%USER%/$info->{user}/go;

trunk/ImmediateNotifyPlugin/lib/Foswiki/Plugins/ImmediateNotifyPlugin/XMPP.pm

@@ -105 +105 @@
     my ($template) = Foswiki::Func::readTemplate( 'xmpp', 'immediatenotify' );
 
-    # &$debug("- SMTP:  template read $template");
+    &$debug("- XMPP:  template read $template");
+
+    # Expand Legacy variables - not used in latest templates
     my ($from) = Foswiki::Func::getPreferencesValue("WIKIWEBMASTER");
-
     $template =~ s/%EMAILFROM%/$from/go;
-    $template =~ s/%WEB%/$info->{web}/go;
+    $template =~ s/%USER%/$info->{user}/go;
     $template =~ s/%TOPICNAME%/$info->{topic}/go;
-    $template =~ s/%USER%/$info->{user}/go;
     $template =~ s/%REV%/$info->{version}/go;
 
@@ -125 +125 @@
         &$debug(" processing $user");
 
-        #&$debug(" userref = ".ref($userHash->{$user}));
         my %uHash = %{ $userHash->{$user} };
 

trunk/ImmediateNotifyPlugin/templates/smtp.immediatenotify.tmpl

@@ -1 @@
-From: %WIKIWEBMASTER%
+%TMPL:DEF{smtpHeaders}%From: %WIKIWEBMASTER%
 To: %EMAILTO%
 Subject: %WIKITOOLNAME%.%WEB%.%TOPICNAME% - Immediate notification of topic change
 MIME-Version: 1.0
-Content-Type: multipart/mixed; boundary="------------2D594AE113AD25493C2C7246"
-
-This is a multi-part message in MIME format.
---------------2D594AE113AD25493C2C7246
 Content-Type: text/plain; charset=%CHARSET%
 Content-Transfer-Encoding: 8bit
 
+%TMPL:END%
+%TMPL:DEF{smtpMessage}%
 This is an automatically generated email.
 
-%USER% has created or changed the topic
-%SCRIPTURL{"view"}%/%WEB%/%TOPICNAME% - Revision %REV%
+%WIKINAME% has %IF{"context NewTopic" then="created" else="changed"}% the topic
+%SCRIPTURL{"view"}%/%WEB%/%TOPIC% - Revision %REVINFO{format="r1.$rev"}%
 
 --
@@ -20 +18 @@
    * The IMMEDIATENOTIFY list in the modified topic
    * The %SCRIPTURL{"view"}%/%WEB%/WebImmediateNotify topic
+%TMPL:END%
+%TMPL:P{smtpHeaders}%%TMPL:P{smtpMessage}%

trunk/ImmediateNotifyPlugin/templates/xmpp.immediatenotify.tmpl

@@ -1 @@
-%USER% has created or changed the topic %SCRIPTURL{"view"}%/%WEB%/%TOPICNAME% - Revision %REV%
+%TMPL:DEF{xmppBody}%%WIKINAME% has %IF{"context NewTopic" then="created" else="changed"}% the topic %SCRIPTURL{"view"}%/%WEB%/%TOPIC% Rev:%REVINFO{format="r1.$rev"}% %INCLUDE{"%WEB%.%TOPIC%" section="NOTIFYTEXT" warn="off"}%%TMPL:END%
+%TMPL:P{xmppBody}%