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