src/core/server.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005/06 by The Quassel Team                             *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20
  21 #ifndef _SERVER_H_
  22 #define _SERVER_H_
  23
  24 #include <QAbstractSocket>
  25 #include <QString>
  26 #include <QStringList>
  27 #include <QTcpSocket>
  28 #include <QThread>
  29 #include <QTimer>
  30
  31 #include "message.h"
  32 #include "serverinfo.h"
  33
  34
  35 /*!
  36  * This is a server object, managing a single connection to an IRC server, handling the associated channels and so on.
  37  * We have this running in its own thread mainly to not block other server objects or the core if something goes wrong,
  38  * e.g. if some scripts starts running wild...
  39  */
  40
  41 class Server : public QThread {
  42   Q_OBJECT
  43
  44   public:
  45     Server(UserId uid, QString network);
  46     ~Server();
  47
  48     UserId userId() const { return user; }
  49     // serverState state();
  50     bool isConnected() const { return socket.state() == QAbstractSocket::ConnectedState; }
  51     QString getNetwork() { return network; }
  52     QStringList providesUserHandlers();
  53
  54     enum CtcpType {CtcpQuery, CtcpReply};
  55
  56   public slots:
  57     // void setServerOptions();
  58     void sendState();
  59     void connectToIrc(QString net);
  60     void disconnectFromIrc(QString net);
  61     void userInput(QString net, QString buffer, QString msg);
  62
  63     void putRawLine(QString input);
  64     void putCmd(QString cmd, QStringList params, QString prefix = 0);
  65
  66     //void exitThread();
  67
  68   signals:
  69     void serverState(QString net, QVariantMap data);
  70     void recvRawServerMsg(QString);
  71     void displayStatusMsg(QString);
  72     //void displayMsg(Message msg);
  73     void displayMsg(Message::Type, QString target, QString text, QString sender = "", quint8 flags = Message::None);
  74     void connected(QString network);
  75     void disconnected(QString network);
  76
  77     void nickAdded(QString network, QString nick, QVariantMap props);
  78     void nickRenamed(QString network, QString oldnick, QString newnick);
  79     void nickRemoved(QString network, QString nick);
  80     void nickUpdated(QString network, QString nick, QVariantMap props);
  81     void modeSet(QString network, QString target, QString mode);
  82     void topicSet(QString network, QString buffer, QString topic);
  83     void ownNickSet(QString network, QString newNick);
  84     void queryRequested(QString network, QString nick);
  85
  86
  87   private slots:
  88     void run();
  89     void socketHasData();
  90     void socketError(QAbstractSocket::SocketError);
  91     void socketConnected();
  92     void socketDisconnected();
  93     void socketStateChanged(QAbstractSocket::SocketState);
  94
  95     /* Message Handlers */
  96
  97     /* void handleUser(QString, QString); */
  98     void handleUserAway(QString, QString);
  99     void handleUserDeop(QString, QString);
 100     void handleUserDevoice(QString, QString);
 101     void handleUserInvite(QString, QString);
 102     void handleUserJoin(QString, QString);
 103     void handleUserKick(QString, QString);
 104     void handleUserList(QString, QString);
 105     void handleUserMode(QString, QString);
 106     void handleUserMsg(QString, QString);
 107     void handleUserNick(QString, QString);
 108     void handleUserOp(QString, QString);
 109     void handleUserPart(QString, QString);
 110     void handleUserQuery(QString, QString);
 111     void handleUserQuit(QString, QString);
 112     void handleUserQuote(QString, QString);
 113     void handleUserSay(QString, QString);
 114     void handleUserTopic(QString, QString);
 115     void handleUserVoice(QString, QString);
 116     void handleUserMe(QString, QString);
 117
 118     /* void handleServer(QString, QStringList); */
 119     void handleServerJoin(QString, QStringList);
 120     void handleServerKick(QString, QStringList);
 121     void handleServerMode(QString, QStringList);
 122     void handleServerNick(QString, QStringList);
 123     void handleServerNotice(QString, QStringList);
 124     void handleServerPart(QString, QStringList);
 125     void handleServerPing(QString, QStringList);
 126     void handleServerPrivmsg(QString, QStringList);
 127     void handleServerQuit(QString, QStringList);
 128     void handleServerTopic(QString, QStringList);
 129
 130     void handleServer001(QString, QStringList);   // RPL_WELCOME
 131     void handleServer005(QString, QStringList);   // RPL_ISUPPORT
 132     void handleServer331(QString, QStringList);   // RPL_NOTOPIC
 133     void handleServer332(QString, QStringList);   // RPL_TOPIC
 134     void handleServer333(QString, QStringList);   // Topic set by...
 135     void handleServer353(QString, QStringList);   // RPL_NAMREPLY
 136     void handleServer432(QString, QStringList);   // ERR_ERRONEUSNICKNAME
 137     void handleServer433(QString, QStringList);   // ERR_NICKNAMEINUSE
 138
 139     void handleCtcpAction(CtcpType, QString, QString, QString);
 140     void handleCtcpPing(CtcpType, QString, QString, QString);
 141     void handleCtcpVersion(CtcpType, QString, QString, QString);
 142
 143     void defaultServerHandler(QString cmd, QString prefix, QStringList params);
 144     void defaultUserHandler(QString buf, QString cmd, QString msg);
 145     void defaultCtcpHandler(CtcpType ctcptype, QString prefix, QString cmd, QString target, QString param);
 146
 147   private:
 148     UserId user;
 149     QString network;
 150     QTcpSocket socket;
 151     //QHash<QString, Buffer*> buffers;
 152
 153     QString ownNick;
 154     QString currentServer;
 155     QVariantMap networkSettings;
 156     QVariantMap identity;
 157     QHash<QString, QVariantMap> nicks;  // stores all known nicks for the server
 158     QHash<QString, QString> topics; // stores topics for each buffer
 159     QVariantMap serverSupports;  // stores results from RPL_ISUPPORT
 160
 161     void handleServerMsg(QByteArray rawMsg);
 162     void handleUserInput(QString buffer, QString usrMsg);
 163
 164     // CTCP Stuff
 165     QString XDELIM;
 166     QHash<QString, QString> ctcpMDequoteHash;
 167     QHash<QString, QString> ctcpXDelimDequoteHash;
 168     QString ctcpDequote(QString);
 169     QString ctcpXdelimDequote(QString);
 170     QStringList parseCtcp(CtcpType, QString, QString, QString);
 171
 172     QString ctcpPack(QString ctcpTag, QString message);
 173     void ctcpQuery(QString bufname, QString ctcpTag, QString message);
 174     void ctcpReply(QString bufname, QString ctcpTag, QString message);
 175
 176     QString updateNickFromMask(QString mask);
 177
 178     class ParseError : public Exception {
 179       public:
 180         ParseError(QString cmd, QString prefix, QStringList params);
 181     };
 182
 183     class UnknownCmdError : public Exception {
 184       public:
 185         UnknownCmdError(QString cmd, QString prefix, QStringList params);
 186     };
 187
 188     // stuff needed for new separation of server information
 189     ServerInfo *serverinfo;
 190 };
 191
 192 #endif