- New features for the TranscriptWindow and TranscriptWindowInterceptors:

  - Enable TranscriptWindowInterceptors to apply different background/foreground colors - and more generally different styles - to different parts of a message text displayed in the TranscriptWindow, using the syntax of Asciidoc Custom Inline Styles ( https://docs.asciidoctor.org/asciidoc/latest/text/custom-inline-styles/ ), i.e. '[.style-name]#my styled text#' will apply the style 'style-name' to the text between ''#' characters.
  - Enable TranscriptWindowInterceptors to intercept messages that were added to a chat before the user joined the chat.

- Fixed the issue in chatrooms that if the message is coming from the chat server (e.g. the server rejected the message for security reasons) and not a room occupant, an exception is thrown and the message is not displayed in chat window.

Author: cdanger

core/pom.xml

@@ -35,6 +35,8 @@
                         <exclude>**/org/jivesoftware/sparkimpl/preference/media/*</exclude>
                         <exclude>**/org/jivesoftware/sparkimpl/plugin/phone/JMFInit.*</exclude>
                     </excludes>
+                    <source>11</source>
+                    <target>11</target>
                 </configuration>
             </plugin>
             <plugin>

core/src/main/java/org/jivesoftware/spark/ui/MessageEntry.java

@@ -33,9 +33,11 @@
 import java.awt.*;
 import java.awt.image.BufferedImage;
 import java.time.ZonedDateTime;
-import java.util.List;
 import java.util.*;
+import java.util.List;
 import java.util.concurrent.TimeUnit;
+import java.util.function.Predicate;
+import java.util.regex.Pattern;
 
 import static javax.swing.text.StyleConstants.Foreground;
 
@@ -51,12 +53,19 @@
  */
 public class MessageEntry extends TimeStampedEntry
 {
-    public static final List<Character> DIRECTIVE_CHARS = Arrays.asList( '*', '_', '~', '`' );
+    public static final List<Character> DIRECTIVE_CHARS = Arrays.asList( '*', '_', '~', '`', '#', '[' );
+    private static final Predicate<String> CUSTOM_STYLE_NAME_MATCHER = Pattern.compile("_?[a-zA-Z]((-|_)?[a-zA-Z0-9]+)*").asMatchPredicate();
+    private static final SimpleAttributeSet DEFAULT_HIGHLIGHT_STYLE = new SimpleAttributeSet();
+    static {
+        StyleConstants.setBackground(DEFAULT_HIGHLIGHT_STYLE, Color.YELLOW);
+    }
+
     protected final String prefix;
     protected final Color prefixColor;
     protected final String message;
     protected final Color messageColor;
     protected final Color backgroundColor;
+    protected final Map<String, AttributeSet> customStyles;
 
     /**
      * Creates a new entry using the default background color (white/transparent).
@@ -102,9 +111,9 @@ public MessageEntry( ZonedDateTime timestamp, String prefix, Color prefixColor,
         this( timestamp, false, prefix, prefixColor, message, messageColor,backgroundColor );
 
     }
-    
+
     /**
-     * Creates a new entry using the default background color (white/transparent).
+     * Creates a new entry using a given background color.
      *
      * @param timestamp The timestamp of the entry (cannot be null).
      * @param isDelayed Set true if entry contain delayed delivery, historic timestamp.
@@ -115,13 +124,35 @@ public MessageEntry( ZonedDateTime timestamp, String prefix, Color prefixColor,
      * @param backgroundColor The color to be used for the entire entry (prefix as well ass message text).
      */
     public MessageEntry( ZonedDateTime timestamp, boolean isDelayed, String prefix, Color prefixColor, String message, Color messageColor, Color backgroundColor )
+    {
+        this(timestamp, isDelayed, prefix, prefixColor, message, messageColor, backgroundColor, Map.of());
+    }
+    
+    /**
+     * Creates a new entry using a given background color and optional custom styles to be applied like
+     *      * <a href="https://docs.asciidoctor.org/asciidoc/latest/text/custom-inline-styles/">Asciidoc Custom Inline Styles</a>:
+     *      * <p>{@code [.style-name]#my styled text#} will have the effect of applying the style corresponding to {@code style-name} in {@code customStyles} parameter, to the text between {@code #} characters.
+     *
+     * @param timestamp The timestamp of the entry (cannot be null).
+     * @param isDelayed Set true if entry contain delayed delivery, historic timestamp.
+     * @param prefix The prefix of the message (typically, the name of the author of the message.
+     * @param prefixColor The color to be used for the timestamp and prefix text.
+     * @param message The message text itself.
+     * @param messageColor The color to be used for the message text.
+     * @param customStyles custom styles to be applied to specific parts of the message in the same manner as Asciidoc custom inline styles.
+     */
+    public MessageEntry( ZonedDateTime timestamp, boolean isDelayed, String prefix, Color prefixColor, String message, Color messageColor, Color backgroundColor, Map<String, AttributeSet> customStyles )
     {
         super( timestamp, isDelayed );
         this.prefix = prefix == null ? "" : prefix;
         this.prefixColor = prefixColor;
         this.message = message;
         this.messageColor = messageColor;
         this.backgroundColor = backgroundColor != null ? backgroundColor : new Color( 255, 255, 255, 0);
+        if(customStyles.keySet().stream().anyMatch(styleName -> !CUSTOM_STYLE_NAME_MATCHER.test(styleName))) {
+            throw new IllegalArgumentException("One of the input custom style names is invalid: " + customStyles.keySet());
+        }
+        this.customStyles = customStyles;
     }
 
     protected MutableAttributeSet getPrefixStyle()
@@ -192,10 +223,45 @@ protected void addTo( ChatArea chatArea ) throws BadLocationException
                         // Handle directives
                         if (DIRECTIVE_CHARS.contains(line.charAt(from))) {
                             char directive = line.charAt(from);
-                            to = line.indexOf(directive, from + 1);
-                            if (to != -1 && !Character.isWhitespace(line.charAt(to - 1)) && (to - from) > 1) {
-                                insertFragment(chatArea, line.substring(from + 1, to++), applyMessageStyle(directive, messageStyle));
-                                continue;
+                            /*
+                                If the matched directive char is [, check whether this is '[.style-name]#sometext#', where style-name is one of the names in customStyles, in which case apply that custom inline style (Asciidoc-like)
+                                 */
+                            final AttributeSet fragmentSpecificStyle;
+                            if(directive == '[') {
+                                if(line.charAt(from+1) == '.') {
+                                    // style-name is at least one character, therefore look for ] from 'from+3' position
+                                    final int closingSquareBracketIndex = line.indexOf(']', from + 3);
+                                    if (closingSquareBracketIndex != -1 && line.charAt(closingSquareBracketIndex + 1) == '#') {
+                                        final String appliedStyleName = line.substring(from + 2, closingSquareBracketIndex);
+                                        if (!customStyles.containsKey(appliedStyleName)) {
+                                            Log.error("The message text is using a custom inline style named '" + appliedStyleName + "' but no such style has been defined. Ignoring.");
+                                            fragmentSpecificStyle = null;
+                                        } else {
+                                            fragmentSpecificStyle = customStyles.get(appliedStyleName);
+                                            directive = '#';
+                                            from = closingSquareBracketIndex + 1;
+                                            Log.debug("Applying custom inline style '" + appliedStyleName + "' to the text between #");
+                                        }
+                                    } else {
+                                        fragmentSpecificStyle = null;
+                                    }
+                                } else {
+                                    fragmentSpecificStyle = null;
+                                }
+                            } else if(directive == '#') {
+                                /*
+                                    If the matched directive char is #, highlight (in yellow) the text between # (no custom inline style here, as it was already handled in previous case above).
+                                */
+                                fragmentSpecificStyle = DEFAULT_HIGHLIGHT_STYLE;
+                            } else {
+                                fragmentSpecificStyle = applyMessageStyle(directive, messageStyle);
+                            }
+                            if(fragmentSpecificStyle != null) {
+                                to = line.indexOf(directive, from + 1);
+                                if (to != -1 && !Character.isWhitespace(line.charAt(to - 1)) && (to - from) > 1) {
+                                    insertFragment(chatArea, line.substring(from + 1, to++), fragmentSpecificStyle);
+                                    continue;
+                                }
                             }
                         }
 
@@ -226,7 +292,7 @@ protected void addTo( ChatArea chatArea ) throws BadLocationException
         // chatArea.setCaretPosition( doc.getLength() );
     }
 
-    protected void insertFragment(ChatArea chatArea, String fragment, MutableAttributeSet style) throws BadLocationException {
+    protected void insertFragment(ChatArea chatArea, String fragment, AttributeSet style) throws BadLocationException {
         if (insertPicture(chatArea, fragment, style)) return;
         if (insertLink(chatArea.getDocument(), fragment, style)) return;
         if (insertAddress(chatArea.getDocument(), fragment, style)) return;
@@ -367,7 +433,7 @@ public MutableAttributeSet applyMessageStyle( char directive, MutableAttributeSe
      * @param url - the link to the content to insert( ex. http://example.org/hello.gif )
      * @throws BadLocationException if the location is not available for insertion.
      */
-    public boolean insertPicture(ChatArea chatArea, String url, MutableAttributeSet messageStyle) throws BadLocationException
+    public boolean insertPicture(ChatArea chatArea, String url, AttributeSet messageStyle) throws BadLocationException
     {
         // FIXME: this is unsafe. Do not blindly accept anything that looks like an URL (check if it is a valid URL).
         // TODO: instead of operating on message text content, operate on message stanza metadata.
@@ -469,7 +535,7 @@ public static ImageIcon scaleImage(ImageIcon icon, int w, int h)
      * @param link - the link to insert( ex. http://www.javasoft.com )
      * @throws BadLocationException if the location is not available for insertion.
      */
-    public boolean insertLink(Document doc, String link, MutableAttributeSet style) throws BadLocationException
+    public boolean insertLink(Document doc, String link, AttributeSet style) throws BadLocationException
     {
         if ((link.startsWith("http://") ||
             link.startsWith("ftp://") ||
@@ -495,7 +561,7 @@ public boolean insertLink(Document doc, String link, MutableAttributeSet style)
      * @param address - the address to insert( ex. \superpc\etc\file\ OR http://localhost/ )
      * @throws BadLocationException if the location is not available for insertion.
      */
-    public Boolean insertAddress(Document doc, String address, MutableAttributeSet style) throws BadLocationException
+    public Boolean insertAddress(Document doc, String address, AttributeSet style) throws BadLocationException
     {
         if (address.startsWith("\\\\") ||
             (address.indexOf("://") > 0 && address.indexOf(".") < 1)) {

core/src/main/java/org/jivesoftware/spark/ui/TranscriptWindow.java

@@ -29,8 +29,8 @@
 import org.jivesoftware.spark.util.ModelUtil;
 import org.jivesoftware.spark.util.TaskEngine;
 import org.jivesoftware.spark.util.log.Log;
-import org.jivesoftware.sparkimpl.plugin.manager.Enterprise;
 import org.jivesoftware.sparkimpl.plugin.emoticons.EmoticonManager;
+import org.jivesoftware.sparkimpl.plugin.manager.Enterprise;
 import org.jivesoftware.sparkimpl.settings.local.LocalPreferences;
 import org.jivesoftware.sparkimpl.settings.local.SettingsManager;
 import org.jxmpp.util.XmppStringUtils;
@@ -336,12 +336,59 @@ public Date getLastUpdated()
      * @param message the message to insert.
      * @param date    the timestamp of the message.
      */
-    public void insertHistoryMessage( String userid, String message, Date date )
+    public void insertHistoryMessage( String userid, Message message, Date date )
+    {
+        for ( TranscriptWindowInterceptor interceptor : SparkManager.getChatManager().getTranscriptWindowInterceptors() )
+        {
+            try
+            {
+                boolean handled = interceptor.isHistoryMessageIntercepted( this, userid, message, date );
+                if ( handled )
+                {
+                    // Do nothing.
+                    return;
+                }
+            }
+            catch ( Exception e )
+            {
+                Log.error( "A TranscriptWindowInterceptor ('" + interceptor + "') threw an exception while processing a chat history message (current user: '" + userid + "').", e );
+            }
+        }
+
+        final ZonedDateTime sentDate = date.toInstant().atZone( ZoneOffset.UTC );
+        final Color historyColor = (Color) UIManager.get( "History.foreground" );
+
+        add( new MessageEntry( sentDate, true, userid, historyColor, message.getBody(), historyColor ) );
+    }
+
+    /**
+     * Adds a historic text message to this transcript window. These typically are messages that were added to a chat before the local user joined the chat.
+     *
+     * @param userid  the userid of the sender.
+     * @param message the message to insert.
+     * @param date    the timestamp of the message.
+     */
+    public void insertHistoryMessage( String userid, String message, Date date)
+    {
+        insertHistoryMessage(userid, message, date, Map.of());
+    }
+
+    /**
+     * Adds a tagged historic text message to this transcript window. This is the same as {@link #insertHistoryMessage(String, Message, Date)}, except custom style(s) can be applied to specific part(s) of the message using Asciidoc-like
+     * <a href="https://docs.asciidoctor.org/asciidoc/latest/text/custom-inline-styles/">Custom Inline Styles</a>:
+     * <p>{@code [.style-name]#my styled text#} will have the effect of applying the style corresponding to {@code style-name} in {@code customStyles} parameter, to the text between {@code #} characters.
+     *
+     * @param userid  the userid of the sender.
+     * @param message the message to insert.
+     * @param date    the timestamp of the message.
+     * @param customStyles custom styles to be applied to the parts of the message between {@code #} and following {@code [.style-name]} where {@code style-name} is the key identifying the style attributes in this parameter.
+     */
+    public void insertHistoryMessage( String userid, String message, Date date, Map<String, AttributeSet> customStyles)
     {
         final ZonedDateTime sentDate = date.toInstant().atZone( ZoneOffset.UTC );
         final Color historyColor = (Color) UIManager.get( "History.foreground" );
 
-        add( new MessageEntry( sentDate, true, userid, historyColor, message, historyColor ) );
+        add( new MessageEntry( sentDate, true, userid, historyColor, message, historyColor, null, customStyles ) );
     }
 
     public void insertHorizontalLine()

core/src/main/java/org/jivesoftware/spark/ui/TranscriptWindowInterceptor.java

@@ -17,6 +17,8 @@
 
 import org.jivesoftware.smack.packet.Message;
 
+import java.util.Date;
+
 /**
  * Allows users to intercept messages before they are inserted into the TranscriptWindow.
  *
@@ -35,4 +37,18 @@ public interface TranscriptWindowInterceptor {
      */
     boolean isMessageIntercepted(TranscriptWindow window, String userid, Message message);
 
+    /**
+     * Is called before a historic text message by this user is inserted into the TranscriptWindow.
+     * History messages are typically messages that were added to a chat before the local user joined the chat.
+     *
+     * @param window  the TranscriptWindow.
+     * @param userid  the userid.
+     * @param message the message to be inserted.
+     * @param date    the timestamp of the message
+     * @return true if it should be handled by a custom interceptor.
+     */
+    default boolean isHistoryMessageIntercepted(TranscriptWindow window, String userid, Message message, Date date)
+    {
+        return false;
+    }
 }

core/src/main/java/org/jivesoftware/spark/ui/rooms/GroupChatRoom.java

@@ -46,7 +46,6 @@
 import org.jivesoftware.spark.ui.conferences.DataFormDialog;
 import org.jivesoftware.spark.ui.conferences.GroupChatParticipantList;
 import org.jivesoftware.spark.util.ModelUtil;
-import org.jivesoftware.spark.util.SwingWorker;
 import org.jivesoftware.spark.util.UIComponentRegistry;
 import org.jivesoftware.spark.util.log.Log;
 import org.jivesoftware.sparkimpl.settings.local.LocalPreferences;
@@ -626,14 +625,14 @@ private void handleMessagePacket( Stanza stanza )
 
             if ( ModelUtil.hasLength( message.getBody() ) )
             {
-                final Resourcepart from = message.getFrom().getResourceOrThrow();
+                final Resourcepart from = message.getFrom().getResourceOrEmpty();
 
                 if ( inf != null )
                 {
                     // This is part of the MUC history. No need to add it to the transcript again.
 
                     // Add to the UI component that shows the chat.
-                    getTranscriptWindow().insertHistoryMessage( from.toString(), message.getBody(), sentDate );
+                    getTranscriptWindow().insertHistoryMessage( from.toString(), message, sentDate );
                 }
                 else
                 {
@@ -643,9 +642,9 @@ private void handleMessagePacket( Stanza stanza )
                         return;
                     }
 
-                    final boolean isFromRoom = !message.getFrom().hasNoResource();
+                    final boolean isFromRoomOccupant = message.getFrom().hasResource();
 
-                    if ( !isFromRoom && SparkManager.getUserManager().getOccupant( this, from ) == null )
+                    if ( isFromRoomOccupant && SparkManager.getUserManager().getOccupant( this, from ) == null )
                     {
                         return;
                     }