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 #define DEFAULT_PORT 6667
  35
  36
  37 /*!
  38  * This is a server object, managing a single connection to an IRC server, handling the associated channels and so on.
  39  * We have this running in its own thread mainly to not block other server objects or the core if something goes wrong,
  40  * e.g. if some scripts starts running wild...
  41  */
  42
  43 class Server : public QThread {
  44   Q_OBJECT
  45
  46   public:
  47     Server(UserId uid, QString network);
  48     ~Server();
  49
  50     UserId userId() const { return user; }
  51     // serverState state();
  52     bool isConnected() const { return socket.state() == QAbstractSocket::ConnectedState; }
  53     QString getNetwork() { return network; }
  54     QStringList providesUserHandlers();
  55
  56     enum CtcpType {CtcpQuery, CtcpReply};
  57
  58   public slots:
  59     // void setServerOptions();
  60     void sendState();
  61     void connectToIrc(QString net);
  62     void disconnectFromIrc(QString net);
  63     void userInput(QString net, QString buffer, QString msg);
  64
  65     void putRawLine(QString input);
  66     void putCmd(QString cmd, QStringList params, QString prefix = 0);
  67
  68     //void exitThread();
  69
  70   signals:
  71     void serverState(QString net, VarMap data);
  72     void recvRawServerMsg(QString);
  73     void displayStatusMsg(QString);
  74     //void displayMsg(Message msg);
  75     void displayMsg(Message::Type, QString target, QString text, QString sender = "", quint8 flags = Message::None);
  76     void connected(QString network);
  77     void disconnected(QString network);
  78
  79     void nickAdded(QString network, QString nick, VarMap props);
  80     void nickRenamed(QString network, QString oldnick, QString newnick);
  81     void nickRemoved(QString network, QString nick);
  82     void nickUpdated(QString network, QString nick, VarMap props);
  83     void modeSet(QString network, QString target, QString mode);
  84     void topicSet(QString network, QString buffer, QString topic);
  85     void ownNickSet(QString network, QString newNick);
  86     void queryRequested(QString network, QString nick);
  87
  88
  89   private slots:
  90     void run();
  91     void socketHasData();
  92     void socketError(QAbstractSocket::SocketError);
  93     void socketConnected();
  94     void socketDisconnected();
  95     void socketStateChanged(QAbstractSocket::SocketState);
  96
  97     /* Message Handlers */
  98
  99     /* void handleUser(QString, QString); */
 100     void handleUserAway(QString, QString);
 101     void handleUserDeop(QString, QString);
 102     void handleUserDevoice(QString, QString);
 103     void handleUserInvite(QString, QString);
 104     void handleUserJoin(QString, QString);
 105     void handleUserKick(QString, QString);
 106     void handleUserList(QString, QString);
 107     void handleUserMode(QString, QString);
 108     void handleUserMsg(QString, QString);
 109     void handleUserNick(QString, QString);
 110     void handleUserOp(QString, QString);
 111     void handleUserPart(QString, QString);
 112     void handleUserQuery(QString, QString);
 113     void handleUserQuit(QString, QString);
 114     void handleUserQuote(QString, QString);
 115     void handleUserSay(QString, QString);
 116     void handleUserTopic(QString, QString);
 117     void handleUserVoice(QString, QString);
 118     void handleUserMe(QString, QString);
 119
 120     /* void handleServer(QString, QStringList); */
 121     void handleServerJoin(QString, QStringList);
 122     void handleServerKick(QString, QStringList);
 123     void handleServerMode(QString, QStringList);
 124     void handleServerNick(QString, QStringList);
 125     void handleServerNotice(QString, QStringList);
 126     void handleServerPart(QString, QStringList);
 127     void handleServerPing(QString, QStringList);
 128     void handleServerPrivmsg(QString, QStringList);
 129     void handleServerQuit(QString, QStringList);
 130     void handleServerTopic(QString, QStringList);
 131
 132     void handleServer001(QString, QStringList);   // RPL_WELCOME
 133     void handleServer005(QString, QStringList);   // RPL_ISUPPORT
 134     void handleServer331(QString, QStringList);   // RPL_NOTOPIC
 135     void handleServer332(QString, QStringList);   // RPL_TOPIC
 136     void handleServer333(QString, QStringList);   // Topic set by...
 137     void handleServer353(QString, QStringList);   // RPL_NAMREPLY
 138     void handleServer432(QString, QStringList);   // ERR_ERRONEUSNICKNAME
 139     void handleServer433(QString, QStringList);   // ERR_NICKNAMEINUSE
 140
 141     void handleCtcpAction(CtcpType, QString, QString, QString);
 142     void handleCtcpPing(CtcpType, QString, QString, QString);
 143     void handleCtcpVersion(CtcpType, QString, QString, QString);
 144
 145     void defaultServerHandler(QString cmd, QString prefix, QStringList params);
 146     void defaultUserHandler(QString buf, QString cmd, QString msg);
 147     void defaultCtcpHandler(CtcpType ctcptype, QString prefix, QString cmd, QString target, QString param);
 148
 149   private:
 150     UserId user;
 151     QString network;
 152     QTcpSocket socket;
 153     //QHash<QString, Buffer*> buffers;
 154
 155     QString ownNick;
 156     QString currentServer;
 157     VarMap networkSettings;
 158     VarMap identity;
 159     QHash<QString, VarMap> nicks;  // stores all known nicks for the server
 160     QHash<QString, QString> topics; // stores topics for each buffer
 161     VarMap serverSupports;  // stores results from RPL_ISUPPORT
 162
 163     void handleServerMsg(QByteArray rawMsg);
 164     void handleUserInput(QString buffer, QString usrMsg);
 165
 166     // CTCP Stuff
 167     QString XDELIM;
 168     QHash<QString, QString> ctcpMDequoteHash;
 169     QHash<QString, QString> ctcpXDelimDequoteHash;
 170     QString ctcpDequote(QString);
 171     QString ctcpXdelimDequote(QString);
 172     QStringList parseCtcp(CtcpType, QString, QString, QString);
 173
 174     QString ctcpPack(QString ctcpTag, QString message);
 175     void ctcpQuery(QString bufname, QString ctcpTag, QString message);
 176     void ctcpReply(QString bufname, QString ctcpTag, QString message);
 177
 178     QString updateNickFromMask(QString mask);
 179
 180     class ParseError : public Exception {
 181       public:
 182         ParseError(QString cmd, QString prefix, QStringList params);
 183     };
 184
 185     class UnknownCmdError : public Exception {
 186       public:
 187         UnknownCmdError(QString cmd, QString prefix, QStringList params);
 188     };
 189
 190     // stuff needed for new separation of server information
 191     ServerInfo *serverinfo;
 192 };
 193
 194 #endif