/*
* Jitsi, the OpenSource Java VoIP and Instant Messaging client.
*
* Copyright @ 2015 Atlassian Pty Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.java.sip.communicator.impl.gui.main.chat;
import java.io.*;
import java.text.*;
import java.util.*;
import javax.swing.text.html.HTML.Tag;
import net.java.sip.communicator.impl.gui.*;
import net.java.sip.communicator.service.history.*;
import net.java.sip.communicator.util.*;
import org.apache.commons.lang3.*;
/**
*
* @author Yana Stamcheva
*/
public class ChatHtmlUtils
{
/**
* The name attribute.
*/
public final static String NAME_ATTRIBUTE = "name";
/**
* The date attribute.
*/
public final static String DATE_ATTRIBUTE = "date";
/**
* The name of the attribute containing the original chat message before
* processing replacements.
*/
public final static String ORIGINAL_MESSAGE_ATTRIBUTE = "original_message";
/**
* The message header identifier attribute.
*/
public final static String MESSAGE_HEADER_ID = "dateHeader";
/**
* The message identifier attribute.
*/
public final static String MESSAGE_TEXT_ID = "message";
/**
* The html text content type.
*/
public static final String HTML_CONTENT_TYPE = "text/html";
/**
* The plain text content type.
*/
public static final String TEXT_CONTENT_TYPE = "text/plain";
/**
* The color used in html for name background.
*/
public static final String MSG_NAME_BACKGROUND = "#efefef";
/**
* The color used in html for incoming message contact name foreground.
*/
public static final String MSG_IN_NAME_FOREGROUND = "#488fe7";
/**
* Creates an incoming message tag.
*
* @param messageID the identifier
* @param contactName the name of the contact sending the message
* @param contactDisplayName the display name of the contact sending the
* message
* @param avatarPath the path to the avatar file
* @param date the date, when the message was sent
* @param message the message content
* @param contentType the content type HTML or PLAIN_TEXT
* @param isHistory indicates if this is a message coming from history
* @param isSimpleTheme indicates if the simple or the advance theme should
* be used
* @return the created incoming message tag
*/
public static String createIncomingMessageTag(
String messageID,
String contactName,
String contactDisplayName,
String avatarPath,
Date date,
String message,
String contentType,
boolean isHistory,
boolean isSimpleTheme)
{
if (isSimpleTheme)
return createSimpleIncomingMessageTag( messageID,
contactName,
contactDisplayName,
avatarPath,
date,
message,
contentType,
isHistory);
else
return createAdvancedIncomingMessageTag(messageID,
contactName,
contactDisplayName,
avatarPath,
date,
message,
contentType,
isHistory);
}
/**
* Create an outgoing message tag.
*
* @param messageID the identifier of the message
* @param contactName the name of the account sending the message
* @param contactDisplayName the display name of the account sending the
* message
* @param avatarPath the path to the avatar image
* @param date the date, when the message was sent
* @param message the content of the message
* @param contentType the content type HTML or PLAIN_TEXT
* @param isHistory indicates if this is a message coming from history
* @param isSimpleTheme indicates if the simple or the advance theme should
* be used
* @return the created outgoing message tag
*/
public static String createOutgoingMessageTag( String messageID,
String contactName,
String contactDisplayName,
String avatarPath,
Date date,
String message,
String contentType,
boolean isHistory,
boolean isSimpleTheme)
{
if (isSimpleTheme)
return createSimpleOutgoingMessageTag( messageID,
contactName,
contactDisplayName,
avatarPath,
date,
message,
contentType,
isHistory);
else
return createAdvancedOutgoingMessageTag(messageID,
contactName,
contactDisplayName,
avatarPath,
date,
message,
contentType,
isHistory);
}
/**
* Creates the message tag.
*
* @param messageID the identifier of the message
* @param contactName the name of the sender
* @param message the message content
* @param contentType the content type (html or plain text)
* @param date the date on which the message was sent
* @param isEdited indicates if the given message has been edited
* @param isHistory indicates if this is a message coming from history
* @param isSimpleTheme indicates if the simple or the advance theme should
* be used
* @return the newly constructed message tag
*/
public static String createMessageTag( String messageID,
String contactName,
String message,
String contentType,
Date date,
boolean isEdited,
boolean isHistory,
boolean isSimpleTheme)
{
if (isSimpleTheme)
return createSimpleMessageTag( messageID,
contactName,
message,
contentType,
date,
isEdited,
isHistory);
else
return createAdvancedMessageTag(messageID,
contactName,
message,
contentType,
date,
isEdited,
isHistory);
}
/**
* Creates an incoming message tag.
*
* @param messageID the identifier
* @param contactName the name of the contact sending the message
* @param contactDisplayName the display name of the contact sending the
* message
* @param avatarPath the path to the avatar file
* @param date the date, when the message was sent
* @param message the message content
* @param contentType the content type HTML or PLAIN_TEXT
* @param isHistory indicates if this is a message coming from history
* @return the created incoming message tag
*/
private static String createSimpleIncomingMessageTag(
String messageID,
String contactName,
String contactDisplayName,
String avatarPath,
Date date,
String message,
String contentType,
boolean isHistory)
{
StringBuilder headerBuffer = new StringBuilder();
SimpleDateFormat sdf = new SimpleDateFormat(HistoryService.DATE_FORMAT);
headerBuffer.append("");
final StringBuilder messageBuff = new StringBuilder();
messageBuff.append("");
messageBuff.append(
createSimpleMessageTag( messageID,
contactName,
message,
contentType,
date,
false,
isHistory));
return messageBuff.toString();
}
/**
* Create an outgoing message tag.
*
* @param messageID the identifier of the message
* @param contactName the name of the account sending the message
* @param contactDisplayName the display name of the account sending the
* message
* @param avatarPath the path to the avatar image
* @param date the date, when the message was sent
* @param message the content of the message
* @param contentType the content type HTML or PLAIN_TEXT
* @param isHistory indicates if this is a message coming from history
* @return the created outgoing message tag
*/
private static String createSimpleOutgoingMessageTag( String messageID,
String contactName,
String contactDisplayName,
String avatarPath,
Date date,
String message,
String contentType,
boolean isHistory)
{
StringBuilder headerBuffer = new StringBuilder();
SimpleDateFormat sdf = new SimpleDateFormat(HistoryService.DATE_FORMAT);
headerBuffer.append("");
StringBuffer messageBuff = new StringBuffer();
messageBuff.append("");
messageBuff.append(
createSimpleMessageTag( messageID,
contactName,
message,
contentType,
date,
false,
isHistory));
return messageBuff.toString();
}
/**
* Creates an incoming message tag.
*
* @param messageID the identifier
* @param contactName the name of the contact sending the message
* @param contactDisplayName the display name of the contact sending the
* message
* @param avatarPath the path to the avatar file
* @param date the date, when the message was sent
* @param message the message content
* @param contentType the content type HTML or PLAIN_TEXT
* @param isHistory indicates if this is a message coming from history
* @return the created incoming message tag
*/
private static String createAdvancedIncomingMessageTag(
String messageID,
String contactName,
String contactDisplayName,
String avatarPath,
Date date,
String message,
String contentType,
boolean isHistory)
{
StringBuilder headerBuffer = new StringBuilder();
SimpleDateFormat sdf = new SimpleDateFormat(HistoryService.DATE_FORMAT);
headerBuffer.append("");
StringBuffer messageBuff = new StringBuffer();
messageBuff.append("");
return messageBuff.toString();
}
/**
* Create an outgoing message tag.
*
* @param messageID the identifier of the message
* @param contactName the name of the account sending the message
* @param contactDisplayName the display name of the account sending the
* message
* @param avatarPath the path to the avatar image
* @param date the date, when the message was sent
* @param message the content of the message
* @param contentType the content type HTML or PLAIN_TEXT
* @param isHistory indicates if this is a message coming from history
* @return the created outgoing message tag
*/
private static String createAdvancedOutgoingMessageTag( String messageID,
String contactName,
String contactDisplayName,
String avatarPath,
Date date,
String message,
String contentType,
boolean isHistory)
{
StringBuilder headerBuffer = new StringBuilder();
SimpleDateFormat sdf = new SimpleDateFormat(HistoryService.DATE_FORMAT);
headerBuffer.append("");
StringBuffer messageBuff = new StringBuffer();
// Construct the message.
messageBuff.append("");
return messageBuff.toString();
}
/**
* Creates a message table tag, representing the message header.
*
* @param nameHeader the name of the header.
* @param date the date, when the message was sent or received
* @return the message header tag
*/
private static String createAdvancedMessageHeaderTag(String nameHeader,
Date date)
{
StringBuilder messageHeader = new StringBuilder();
messageHeader.append("");
messageHeader.append("");
messageHeader.append("| ");
messageHeader.append(nameHeader);
messageHeader.append(" | ");
messageHeader.append("");
messageHeader.append(getDateString(date));
messageHeader.append(GuiUtils.formatTime(date));
messageHeader.append(" | ");
messageHeader.append("
");
messageHeader.append("
");
return messageHeader.toString();
}
/**
* Creates a tag that shows the last edit time of a message, in the format
* (Edited at ...).
* If date < 0, returns an empty tag that serves as a placeholder
* for future corrections of this message.
*
* @param messageUID The ID of the edited message.
* @param date The date when the message was last edited, or -1 to generate
* an empty tag.
* @return The string representation of the tag.
*/
public static String createEditedAtTag(String messageUID, long date)
{
StringBuilder res = new StringBuilder();
// Use a tag here as most of the other inline tags (e.g. h1-7,
// b, i) cause different problems when used in setOuterHTML.
res.append(" ");
if (date > 0)
{
res.append(" ");
String contents = GuiActivator.getResources().getI18NString(
"service.gui.EDITED_AT",
new String[] { GuiUtils.formatTime(date) }
);
res.append(contents);
}
res.append("");
return res.toString();
}
/**
* Creates the message tag.
*
* @param messageID the identifier of the message
* @param contactName the name of the sender
* @param message the message content
* @param contentType the content type (html or plain text)
* @param date the date on which the message was sent
* @param isEdited indicates if the given message has been edited
* @param isHistory indicates if this is a message coming from history
* @return the newly constructed message tag
*/
private static String createSimpleMessageTag(String messageID,
String contactName,
String message,
String contentType,
Date date,
boolean isEdited,
boolean isHistory)
{
StringBuilder messageTag = new StringBuilder();
SimpleDateFormat sdf = new SimpleDateFormat(HistoryService.DATE_FORMAT);
messageTag.append(String.format("");
if (HTML_CONTENT_TYPE.equalsIgnoreCase(contentType))
{
messageTag.append(message);
}
else
{
messageTag.append(StringEscapeUtils.escapeHtml4(message));
}
if (isEdited)
messageTag.append(" ");
if (isEdited)
messageTag.append(createEditedAt(date));
messageTag.append("
");
return messageTag.toString();
}
/**
* Creates the message tag.
*
* @param messageID the identifier of the message
* @param contactName the name of the sender
* @param message the message content
* @param contentType the content type (html or plain text)
* @param date the date on which the message was sent
* @param isEdited indicates if the given message has been edited
* @param isHistory indicates if this is a message coming from history
* @return the newly constructed message tag
*/
private static String createAdvancedMessageTag( String messageID,
String contactName,
String message,
String contentType,
Date date,
boolean isEdited,
boolean isHistory)
{
StringBuilder messageTag = new StringBuilder();
SimpleDateFormat sdf = new SimpleDateFormat(HistoryService.DATE_FORMAT);
messageTag.append(String.format("");
if (HTML_CONTENT_TYPE.equalsIgnoreCase(contentType))
{
messageTag.append(message);
}
else
{
messageTag.append(StringEscapeUtils.escapeHtml4(message));
}
if (isEdited)
{
messageTag.append(" ");
messageTag.append(createEditedAt(date));
}
messageTag.append("
");
return messageTag.toString();
}
private static byte[] getMessageBytes(final String message) {
try
{
return message.getBytes("UTF-8");
}
catch (UnsupportedEncodingException e)
{
// this should not happen since we hard-code the character encoding
throw new IllegalStateException("This should not happen since we "
+ "hard-code the required character encoding.");
}
}
/**
* Returns the date string to show for the given date.
*
* @param date the date to format
* @return the date string to show for the given date
*/
public static String getDateString(Date date)
{
if (GuiUtils.compareDatesOnly(date, new Date()) <= 0)
{
StringBuffer dateStrBuf = new StringBuffer();
GuiUtils.formatDate(date, dateStrBuf);
dateStrBuf.append(" ");
return dateStrBuf.toString();
}
return "";
}
/**
* Creates the edited at string.
*
* @param date the date of the re-edition
* @return the newly constructed string
*/
private static String createEditedAt(Date date)
{
return "(" + GuiActivator.getResources()
.getI18NString( "service.gui.EDITED_AT",
new String[]{GuiUtils.formatTime(date)})
+ ")";
}
}