kgamechat.cpp

Go to the documentation of this file.

/*
    This file is part of the KDE games library
    Copyright (C) 2001-2002 Andreas Beckermann (b_mann@gmx.de)
    Copyright (C) 2001 Martin Heni (kde at heni-online.de)

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License version 2 as published by the Free Software Foundation.

    This library 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
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

#include "kgamechat.h"
#include "kgamechat.moc"

#include "kgame.h"
#include "kplayer.h"
#include "kgameproperty.h"
#include "kgamemessage.h"

#include <klocale.h>
#include <kdebug.h>

#include <QMap>

//FIXME:
#define FIRST_ID 2 // first id, that is free of use, aka not defined above

class KGameChatPrivate
{
public:
    KGameChatPrivate()
    {
        mFromPlayer = 0;
        mGame = 0;

        mToMyGroup = -1;
    }
    
    KGame* mGame;
    KPlayer* mFromPlayer;
    int mMessageId;


    QMap<int, int> mSendId2PlayerId;
    int mToMyGroup; // just as the above - but for the group, not for players
};

KGameChat::KGameChat(KGame* g, int msgid, QWidget* parent, KChatBaseModel* model, KChatBaseItemDelegate* delegate)
    : KChatBase(parent, model, delegate),
      d( new KGameChatPrivate )
{
 init(g, msgid); 
}

KGameChat::KGameChat(KGame* g, int msgid, KPlayer* fromPlayer, QWidget* parent, KChatBaseModel* model, KChatBaseItemDelegate* delegate)
    : KChatBase(parent,model,delegate),
      d( new KGameChatPrivate )
{
 init(g, msgid);
 setFromPlayer(fromPlayer);
}

KGameChat::KGameChat(QWidget* parent)
    : KChatBase(parent),
      d( new KGameChatPrivate )
{
 init(0, -1);
}

KGameChat::~KGameChat()
{
 kDebug(11001) ;
 delete d;
}

void KGameChat::init(KGame* g, int msgId)
{
 kDebug(11001) ;
 setMessageId(msgId);

 setKGame(g);
}

void KGameChat::addMessage(int fromId, const QString& text)
{
 if (!d->mGame) {
    kWarning(11001) << "no KGame object has been set";
    addMessage(i18n("Player %1", fromId), text);
 } else {
    KPlayer* p = d->mGame->findPlayer(fromId);
    if (p) {
        kDebug(11001) << "adding message of player" << p->name() << "id=" << fromId;
        addMessage(p->name(), text);
    } else {
        kWarning(11001) << "Could not find player id" << fromId;
        addMessage(i18nc("Unknown player", "Unknown"), text);
    }
 }
}

void KGameChat::returnPressed(const QString& text)
{
 if (!d->mFromPlayer) {
    kWarning(11001) << ": You must set a player first!";
    return;
 }
 if (!d->mGame) {
    kWarning(11001) << ": You must set a game first!";
    return;
 }

 kDebug(11001) << "from:" << d->mFromPlayer->id() << "==" << d->mFromPlayer->name();

 int id = sendingEntry();

 if (isToGroupMessage(id)) {
    // note: there is currently no support for other groups than the players
    // group! It might be useful to send to other groups, too
    QString group = d->mFromPlayer->group();
    kDebug(11001) << "send to group" << group;
    int sender = d->mFromPlayer->id();
    d->mGame->sendGroupMessage(text, messageId(), sender, group);

    //TODO
    //AB: this message is never received!! we need to connect to
    //KPlayer::networkData!!!
    //TODO
    
 } else {
    int toPlayer = 0;
    if (!isSendToAllMessage(id) && isToPlayerMessage(id)) {
        toPlayer = playerId(id);
        if (toPlayer == -1) {
            kError(11001) << ": don't know that player "
                    << "- internal ERROR";
        }
    } 
    int receiver = toPlayer;
    int sender = d->mFromPlayer->id();
    d->mGame->sendMessage(text, messageId(), receiver, sender);
 }
}

void KGameChat::setMessageId(int msgid)
{ d->mMessageId = msgid; }

int KGameChat::messageId() const
{ return d->mMessageId; }

bool KGameChat::isSendToAllMessage(int id) const
{ return (id == KChatBase::SendToAll); }

bool KGameChat::isToGroupMessage(int id) const
{ return (id == d->mToMyGroup); }

bool KGameChat::isToPlayerMessage(int id) const
{
return d->mSendId2PlayerId.contains(id); }

QString KGameChat::sendToPlayerEntry(const QString& name) const
{ return i18n("Send to %1", name); }

int KGameChat::playerId(int id) const
{
 if (!isToPlayerMessage(id)) {
    return -1;
 }

 return d->mSendId2PlayerId[id];
}

int KGameChat::sendingId(int playerId) const
{
 QMap<int, int>::Iterator it;
 for (it = d->mSendId2PlayerId.begin(); it != d->mSendId2PlayerId.end(); ++it) {
    if (it.value() == playerId) {
        return it.key();
    }
 }
 return -1;
}

QString KGameChat::fromName() const
{ return d->mFromPlayer ? d->mFromPlayer->name() : QString(); }

bool KGameChat::hasPlayer(int id) const
{
 return (sendingId(id) != -1);
}

void KGameChat::setFromPlayer(KPlayer* p)
{
 if (!p) {
    kError(11001) << ": NULL player";
    removeSendingEntry(d->mToMyGroup);
    d->mFromPlayer = 0;
    return;
 }
 if (d->mFromPlayer) {
    changeSendingEntry(p->group(), d->mToMyGroup);
 } else {
    if (d->mToMyGroup != -1) {
        kWarning(11001) << "send to my group exists already - removing";
        removeSendingEntry(d->mToMyGroup);
    }
    d->mToMyGroup = nextId();
    addSendingEntry(i18n("Send to My Group (\"%1\")", p->group()), d->mToMyGroup);
 }
 d->mFromPlayer = p;
 kDebug(11001) << "player=" << p;
}


void KGameChat::setKGame(KGame* g)
{
 if (d->mGame) {
    slotUnsetKGame();
 }
 kDebug(11001) << "game=" << g;
 d->mGame = g;

 if (d->mGame) {
    connect(d->mGame, SIGNAL(signalPlayerJoinedGame(KPlayer*)), 
            this, SLOT(slotAddPlayer(KPlayer*)));
    connect(d->mGame, SIGNAL(signalPlayerLeftGame(KPlayer*)), 
            this, SLOT(slotRemovePlayer(KPlayer*)));
    connect(d->mGame, SIGNAL(signalNetworkData(int,QByteArray,quint32,quint32)),
            this, SLOT(slotReceiveMessage(int,QByteArray,quint32,quint32)));
    connect(d->mGame, SIGNAL(destroyed()), this, SLOT(slotUnsetKGame()));

    QList<KPlayer*> playerList = *d->mGame->playerList();
    for (int i = 0; i < playerList.count(); i++) {
        slotAddPlayer(playerList.at(i));
    }
 }
}

KGame* KGameChat::game() const
{
 return d->mGame;
}

KPlayer* KGameChat::fromPlayer() const
{
 return d->mFromPlayer;
}

void KGameChat::slotUnsetKGame()
{
//TODO: test this method!

 if (!d->mGame) {
    return;
 }
 disconnect(d->mGame, 0, this, 0);
 removeSendingEntry(d->mToMyGroup);
 QMap<int, int>::Iterator it;
 for (it = d->mSendId2PlayerId.begin(); it != d->mSendId2PlayerId.end(); ++it) {
    removeSendingEntry(it.value());
 }
}

void KGameChat::slotAddPlayer(KPlayer* p)
{
 if (!p) {
    kError(11001) << ": cannot add NULL player";
    return;
 }
 if (hasPlayer(p->id())) {
    kError(11001) << ": player was added before";
    return;
 }

 int sendingId = nextId();
 addSendingEntry(comboBoxItem(p->name()), sendingId);
 d->mSendId2PlayerId.insert(sendingId, p->id());
 connect(p, SIGNAL(signalPropertyChanged(KGamePropertyBase*,KPlayer*)),
        this, SLOT(slotPropertyChanged(KGamePropertyBase*,KPlayer*)));
 connect(p, SIGNAL(signalNetworkData(int,QByteArray,quint32,KPlayer*)),
        this, SLOT(slotReceivePrivateMessage(int,QByteArray,quint32,KPlayer*)));
}

void KGameChat::slotRemovePlayer(KPlayer* p)
{
 if (!p) {
    kError(11001) << ": NULL player";
    return;
 }
 if (!hasPlayer(p->id())) {
    kError(11001) << ": cannot remove non-existent player";
    return;
 }

 int id = sendingId(p->id());
 removeSendingEntry(id);
 p->disconnect(this);
 d->mSendId2PlayerId.remove(id);
}

void KGameChat::slotPropertyChanged(KGamePropertyBase* prop, KPlayer* player)
{
 if (prop->id() == KGamePropertyBase::IdName) {
//  kDebug(11001) << "new Name";
    changeSendingEntry(player->name(), sendingId(player->id()));
/*
    mCombo->changeItem(comboBoxItem(player->name()), index);
 */
 } else if (prop->id() == KGamePropertyBase::IdGroup) {
 //TODO
 }
}

void KGameChat::slotReceivePrivateMessage(int msgid, const QByteArray& buffer, quint32 sender, KPlayer* me)
{
 if (!me || me != fromPlayer()) {
    kDebug() << "nope - not for us!";
    return;
 }
 slotReceiveMessage(msgid, buffer, me->id(), sender);
}

void KGameChat::slotReceiveMessage(int msgid, const QByteArray& buffer, quint32 , quint32 sender)
{
 QDataStream msg(buffer);
 if (msgid != messageId()) {
    return;
 }

 QString text;
 msg >> text;

 addMessage(sender, text);
}