chattab.cpp

Go to the documentation of this file.

/*
 *  The Mana Client
 *  Copyright (C) 2008-2009  The Mana World Development Team
 *  Copyright (C) 2009-2012  The Mana Developers
 *
 *  This file is part of The Mana Client.
 *
 *  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
 *  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, see <http://www.gnu.org/licenses/>.
 */
 
#include "gui/widgets/chattab.h"
 
#include "actorspritemanager.h"
#include "chatlogger.h"
#include "client.h"
#include "commandhandler.h"
#include "configuration.h"
#include "localplayer.h"
#include "sound.h"
 
#include "gui/recorder.h"
 
#include "gui/widgets/browserbox.h"
#include "gui/widgets/scrollarea.h"
#include "gui/widgets/itemlinkhandler.h"
 
#include "net/chathandler.h"
#include "net/net.h"
 
#include "resources/iteminfo.h"
#include "resources/itemdb.h"
 
#include "utils/gettext.h"
#include "utils/stringutils.h"
 
#include <guichan/widgets/tabbedarea.hpp>
 
ChatTab::ChatTab(const std::string &name)
{
    setCaption(name);
 
    mTextOutput = new BrowserBox(BrowserBox::AUTO_WRAP);
    mTextOutput->setWrapIndent(15);
    mTextOutput->setMaxRows(config.chatLogLength);
    mTextOutput->setLinkHandler(chatWindow->mItemLinkHandler);
 
    mScrollArea = new ScrollArea(mTextOutput);
    mScrollArea->setScrollPolicy(gcn::ScrollArea::SHOW_NEVER,
                                 gcn::ScrollArea::SHOW_ALWAYS);
    mScrollArea->setScrollAmount(0, 1);
    mScrollArea->setOpaque(false);
 
    chatWindow->addTab(this);
 
    listen(Event::ConfigChannel);
 
    // Initiate the text format
    updateTextFormat(Window::getGuiAlpha());
}
 
ChatTab::~ChatTab()
{
    if (chatWindow)
        chatWindow->removeTab(this);
 
    delete mTextOutput;
    delete mScrollArea;
}
 
void ChatTab::updateTextFormat(int alpha)
{
    if (alpha > 200)
    {
        mTextOutput->setOutlinedText(false);
        mTextOutput->setShadowedText(false);
    }
    else if (alpha <= 200 && alpha > 100)
    {
        mTextOutput->setOutlinedText(false);
        mTextOutput->setShadowedText(true);
    }
    else
    {
        mTextOutput->setOutlinedText(true);
        mTextOutput->setShadowedText(false);
    }
}
 
void ChatTab::event(Event::Channel channel, const Event &event)
{
    // Update the text outline and shadow according to the gui opacity.
    if (channel == Event::ConfigChannel &&
        event.getType() == Event::ConfigOptionChanged &&
        event.hasValue(&Config::guiAlpha))
    {
        updateTextFormat(Window::getGuiAlpha());
    }
}
 
void ChatTab::chatLog(std::string line, Own own, bool ignoreRecord)
{
    // Trim whitespace
    trim(line);
 
    if (line.empty())
        return;
 
    CHATLOG tmp;
    tmp.own = own;
    tmp.text = line;
 
    std::string::size_type pos = line.find(" : ");
    if (pos != std::string::npos)
    {
        tmp.nick = line.substr(0, pos);
        tmp.text = line.substr(pos + 3);
    }
    else
    {
        // Fix the owner of welcome message.
        if (line.substr(0, 7) == "Welcome")
        {
            own = BY_SERVER;
        }
    }
 
    // *implements actions in a backwards compatible way*
    if ((own == BY_PLAYER || own == BY_OTHER) &&
        tmp.text.at(0) == '*' &&
        tmp.text.at(tmp.text.length()-1) == '*')
    {
        tmp.text[0] = ' ';
        tmp.text.erase(tmp.text.length() - 1);
        own = ACT_IS;
    }
 
    std::string lineColor = "##C";
    switch (own)
    {
        case BY_GM:
            if (tmp.nick.empty())
            {
                tmp.nick = std::string(_("Global announcement:"));
                tmp.nick += " ";
                lineColor = "##G";
            }
            else
            {
                tmp.nick = strprintf(_("Global announcement from %s:"),
                                     tmp.nick.c_str());
                tmp.nick += " ";
                lineColor = "##g";
            }
            break;
        case BY_PLAYER:
            tmp.nick += ": ";
            lineColor = "##Y";
            break;
        case BY_OTHER:
            tmp.nick += ": ";
            lineColor = "##C";
            break;
        case BY_SERVER:
            tmp.nick = _("Server:");
            tmp.nick += " ";
            tmp.text = line;
            lineColor = "##S";
            break;
        case BY_CHANNEL:
            tmp.nick.clear();
            // TODO: Use a predefined color
            lineColor = "##2"; // Equiv. to BrowserBox::GREEN
            break;
        case ACT_WHISPER:
            tmp.nick = strprintf(_("%s whispers: %s"), tmp.nick.c_str(), "");
            lineColor = "##W";
            break;
        case ACT_IS:
            lineColor = "##I";
            break;
        case BY_LOGGER:
            tmp.nick.clear();
            tmp.text = line;
            lineColor = "##L";
            break;
    }
 
    if (tmp.nick == ": ")
    {
        tmp.nick.clear();
        lineColor = "##S";
    }
 
    // Get the current system time
    time_t t;
    time(&t);
 
    // Format the time string properly
    std::stringstream timeStr;
    timeStr << "[" << ((((t / 60) / 60) % 24 < 10) ? "0" : "")
        << (int) (((t / 60) / 60) % 24)
        << ":" << (((t / 60) % 60 < 10) ? "0" : "")
        << (int) ((t / 60) % 60)
        << "] ";
 
    line = lineColor + timeStr.str() + tmp.nick + tmp.text;
 
    if (config.enableChatLog && !ignoreRecord)
        saveToLogFile(line);
 
    // We look if the Vertical Scroll Bar is set at the max before
    // adding a row, otherwise the max will always be a row higher
    // at comparison.
    if (mScrollArea->getVerticalScrollAmount() >= mScrollArea->getVerticalMaxScroll())
    {
        mTextOutput->addRow(line);
        mScrollArea->setVerticalScrollAmount(mScrollArea->getVerticalMaxScroll());
    }
    else
    {
        mTextOutput->addRow(line);
    }
 
    mScrollArea->logic();
 
    chatWindow->mRecorder->record(line.substr(3));
 
    if (own != BY_PLAYER)
    {
        bool currentTab = getTabbedArea()->getSelectedTab() == this;
 
        if (!currentTab)
            setFlash(true);
 
        if (!(currentTab && Client::hasInputFocus()) && own != BY_SERVER)
            if (checkNotify(own))
                sound.playNotification("system/newmessage.ogg");
    }
}
 
void ChatTab::chatLog(const std::string &nick, const std::string &msg)
{
    chatLog(nick + " : " + msg,
            nick == local_player->getName() ? BY_PLAYER : BY_OTHER,
            false);
}
 
void ChatTab::chatInput(const std::string &message)
{
    std::string msg = message;
    trim(msg);
 
    if (msg.empty())
        return;
 
    // Check for item link
    std::string::size_type start = msg.find('[');
    while (start != std::string::npos && msg[start+1] != '@')
    {
        std::string::size_type end = msg.find(']', start);
        if (start + 1 != end && end != std::string::npos)
        {
            // Catch multiple embeds and ignore them
            // so it doesn't crash the client.
            while ((msg.find('[', start + 1) != std::string::npos) &&
                   (msg.find('[', start + 1) < end))
            {
                start = msg.find('[', start + 1);
            }
 
            std::string temp = msg.substr(start + 1, end - start - 1);
 
            const ItemInfo &itemInfo = itemDb->get(temp);
            if (itemInfo.id != 0)
            {
                msg.insert(end, "@@");
                msg.insert(start + 1, "|");
                msg.insert(start + 1, toString(itemInfo.id));
                msg.insert(start + 1, "@@");
            }
        }
        start = msg.find('[', start + 1);
    }
 
    // Prepare ordinary message
    if (msg[0] != '/')
        handleInput(msg);
    else
        handleCommand(std::string(msg, 1));
}
 
void ChatTab::scroll(int amount)
{
    int range = mScrollArea->getHeight() / 8 * amount;
    gcn::Rectangle scr;
    scr.y = mScrollArea->getVerticalScrollAmount() + range;
    scr.height = abs(range);
    mTextOutput->showPart(scr);
}
 
void ChatTab::clearText()
{
    mTextOutput->clearRows();
}
 
void ChatTab::handleInput(const std::string &msg)
{
    Net::getChatHandler()->talk(msg);
}
 
void ChatTab::handleCommand(const std::string &msg)
{
    commandHandler->handleCommand(msg, this);
}
 
bool ChatTab::checkNotify(Own own) const
{
    return own == ACT_WHISPER;
}
 
void ChatTab::getAutoCompleteList(std::vector<std::string> &names) const
{
    actorSpriteManager->getPlayerNPCNameLister()->getAutoCompleteList(names);
}
 
void ChatTab::saveToLogFile(std::string &msg)
{
    if (chatLogger)
        chatLogger->log(msg);
}