Yaaic/application/src/org/yaaic/model/Message.java

/*
Yaaic - Yet Another Android IRC Client

Copyright 2009-2010 Sebastian Kaspari

This file is part of Yaaic.

Yaaic is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

Yaaic is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with Yaaic.  If not, see <http://www.gnu.org/licenses/>.
*/
package org.yaaic.model;

import java.util.Date;

import android.content.Context;
import android.graphics.Typeface;
import android.graphics.drawable.Drawable;
import android.text.Spannable;
import android.text.SpannableString;
import android.text.style.ForegroundColorSpan;
import android.text.style.ImageSpan;
import android.widget.TextView;

/**
 * A channel or server message
 * 
 * @author Sebastian Kaspari <sebastian@yaaic.org>
 */
public class Message {
	public static final int COLOR_GREEN  = 0xFF458509;
	public static final int COLOR_RED    = 0xFFcc0000;
	public static final int COLOR_BLUE   = 0xFF729fcf;
	public static final int COLOR_YELLOW = 0xFFbe9b01;
	public static final int COLOR_GREY   = 0xFFaaaaaa;
	public static final int COLOR_DEFAULT   = 0xFFeeeeee;
	
	public static final int[] colors = {
		0xFFffffff, //White
		0xFFffff00, //Yellow
		0xFFff00ff, //Fuchsia
		0xFFff0000, //Red
		0xFFc0c0c0, //Silver
		0xFF808080, //Gray
		0xFF808000, //Olive
		0xFF800080, //Purple
		0xFF800000, //Maroon
		0xFF00ffff, //Agua
		0xFF00ff00, //Lime
		0xFF008080, //Teal
		0xFF008000, //Green
		0xFF0000FF, //Blue
		0xFF000080, //Navy
		0xFF000000, //Black
	};

	private int icon = -1;
	private String text;
	private String sender;
	private SpannableString canvas;
	private int color = -1;
	private long timestamp;
	
	/**
	 * Create a new message without an icon
	 * 
	 * @param text
	 */
	public Message(String text)
	{
		this(text, null);
	}
	/**
	 * Create a new message sent by a user without an icon
	 *
	 * @param text
	 * @param sender
	 */
	public Message(String text, String sender)
	{
		this.text = text;
		this.sender = sender;
		this.timestamp = new Date().getTime();
	}
	
	/**
	 * Set the message's icon
	 */
	public void setIcon(int icon)
	{
		this.icon = icon;
	}
	
	/**
	 * Get the message's icon
	 * 
	 * @return
	 */
	public int getIcon()
	{
		return icon;
	}
	
	/**
	 * Get the text of this message
	 * 
	 * @return
	 */
	public String getText()
	{
		return text;
	}
	
	/**
	 * Set the color of this message
	 */
	public void setColor(int color)
	{
		this.color = color;
	}
	/**
	 * Associate a color with a sender name
	 *
	 * @return a color hexa
	 */
	private int getSenderColor()
	{
		/* It might be worth to use some hash table here */
		if (sender == null) return COLOR_DEFAULT;
		int color = 0;
		for(int i = 0; i < sender.length(); i++){
			color += sender.charAt(i);
		}
		/* we dont want color[colors.length-1] which is black */
		color = color % (colors.length - 1);
		return colors[color];
	}
	/**
	 * Render message as spannable string
	 * 
	 * @return
	 */
	public SpannableString render(Context context)
	{
		Settings settings = new Settings(context);
		
		if (canvas == null) {
			String prefix = icon != -1 && settings.showIcons() ? "  " : "";
			String nick = sender != null ? "<" + sender + "> " : "";
			String timestamp = settings.showTimestamp() ? Message.generateTimestamp(this.timestamp, settings.use24hFormat()) : "";
			
			canvas = new SpannableString(prefix + timestamp + nick + text);
			
			if (sender != null) {
				int start = (prefix + timestamp).length() + 1;
				int end = start + sender.length();
				if (settings.showColorsNick()) {
					canvas.setSpan(new ForegroundColorSpan(getSenderColor()), start, end , Spannable.SPAN_EXCLUSIVE_EXCLUSIVE);
				}
			}

			if (icon != -1 && settings.showIcons()) {
				Drawable drawable = context.getResources().getDrawable(icon);
				drawable.setBounds(0, 0, drawable.getIntrinsicWidth(), drawable.getIntrinsicHeight());
				canvas.setSpan(new ImageSpan(drawable, ImageSpan.ALIGN_BOTTOM), 0, 1, Spannable.SPAN_EXCLUSIVE_EXCLUSIVE);
			}
			if (color != -1 && settings.showColors()) {
				canvas.setSpan(new ForegroundColorSpan(color), 0, canvas.length(), Spannable.SPAN_EXCLUSIVE_EXCLUSIVE);
			}
		}
		
		return canvas;
	}
	
	/**
	 * Render message as text view
	 * 
	 * @param context
	 * @return
	 */
	public TextView renderTextView(Context context)
	{
		// XXX: We should not read settings here ALWAYS for EVERY textview
		Settings settings = new Settings(context);
		
		TextView canvas = new TextView(context);
		
		canvas.setText(this.render(context));
		canvas.setTextSize(settings.getFontSize());
		canvas.setTypeface(Typeface.MONOSPACE);
		canvas.setTextColor(COLOR_DEFAULT);
		
		return canvas;
	}
	
	/**
	 * Generate a timestamp
	 * 
	 * @param use24hFormat
	 * @return
	 */
	public static String generateTimestamp(long timestamp, boolean use24hFormat)
	{
		Date date = new Date(timestamp);
		
		int hours = date.getHours();
		int minutes = date.getMinutes();

		if (!use24hFormat) {
			hours = Math.abs(12 - hours);
			if (hours == 12) {
				hours = 0;
			}
		}
		
		return "[" + (hours < 10 ? "0" + hours : hours) + ":" + (minutes < 10 ? "0" + minutes : minutes) + "] ";
	}
}