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