/*-------------------------------------------------------------------------
svninfo: $Id$
Maarten's Mud, WWW-based MUD using MYSQL
Copyright (C) 1998  Maarten van Leunen

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 the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program 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 this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

Maarten van Leunen
Appelhof 27
5345 KA Oss
Nederland
Europe
maarten_l@yahoo.com
-------------------------------------------------------------------------*/
package mmud.commands;

import java.util.logging.Logger;

import mmud.MudException;
import mmud.boards.Board;
import mmud.characters.Persons;
import mmud.characters.User;
import mmud.database.BoardsDb;
import mmud.database.MudDatabaseException;

/**
 * Reads a general board.
 */
public abstract class ReadBoardCommand extends NormalCommand
{
	private String theResult = null;

	public ReadBoardCommand(String aRegExpr)
	{
		super(aRegExpr);
	}

	/**
	 * Reads a board for a user.
	 * 
	 * @param aUser
	 *            the user reading the board. Used to convey messages.
	 * @param aBoardName
	 *            the name of the board.
	 * @param aRoomId
	 *            the identification number of the room where this board is
	 *            active.
	 * @throws MudException
	 */
	protected boolean readMessage(User aUser, String aBoardName, int aRoomId)
			throws MudException
	{
		if (aUser.getRoom().getId() != aRoomId)
		{
			return false;
		}
		theResult = null;
		Board myBoard = null;
		try
		{
			myBoard = BoardsDb.getBoard(aBoardName);
		} catch (MudDatabaseException e)
		{
			e.printStackTrace();
			return false;
		}
		try
		{
			theResult = myBoard.getDescription() + myBoard.read()
					+ aUser.printForm();
		} catch (MudDatabaseException e)
		{
			e.printStackTrace();
			return false;
		}
		Persons.sendMessage(aUser, "%SNAME read%VERB2 the " + myBoard.getName()
				+ " board.<BR>\r\n");
		return true;
	}

	@Override
	public String getResult()
	{
		Logger.getLogger("mmud").finer("");
		return theResult;
	}

}