src/core/coresessioneventprocessor.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2018 by the Quassel Project                        *
   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) version 3.                                           *
   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  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  19  ***************************************************************************/
  20
  21 #ifndef CORESESSIONEVENTPROCESSOR_H
  22 #define CORESESSIONEVENTPROCESSOR_H
  23
  24 #include "basichandler.h"
  25 #include "corenetwork.h"
  26 #include "networkevent.h"
  27
  28 class CoreSession;
  29 class CtcpEvent;
  30 class IrcEvent;
  31 class IrcEventNumeric;
  32 class Netsplit;
  33
  34 #ifdef HAVE_QCA2
  35 class KeyEvent;
  36 #endif
  37
  38 class CoreSessionEventProcessor : public BasicHandler
  39 {
  40     Q_OBJECT
  41
  42 public:
  43     CoreSessionEventProcessor(CoreSession *session);
  44
  45     inline CoreSession *coreSession() const { return _coreSession; }
  46
  47     Q_INVOKABLE void processIrcEventNumeric(IrcEventNumeric *event);
  48
  49     Q_INVOKABLE void processIrcEventAuthenticate(IrcEvent *event); /// SASL authentication
  50     Q_INVOKABLE void processIrcEventCap(IrcEvent *event);          /// CAP framework negotiation
  51     Q_INVOKABLE void processIrcEventAccount(IrcEvent *event);      /// account-notify received
  52     Q_INVOKABLE void processIrcEventAway(IrcEvent *event);         /// away-notify received
  53     Q_INVOKABLE void processIrcEventChghost(IrcEvent *event);      /// chghost received
  54     Q_INVOKABLE void processIrcEventInvite(IrcEvent *event);
  55     Q_INVOKABLE void processIrcEventJoin(IrcEvent *event);
  56     Q_INVOKABLE void lateProcessIrcEventKick(IrcEvent *event);
  57     Q_INVOKABLE void processIrcEventMode(IrcEvent *event);
  58     Q_INVOKABLE void processIrcEventNick(IrcEvent *event);         /// Nickname changes
  59     Q_INVOKABLE void lateProcessIrcEventNick(IrcEvent *event);
  60     Q_INVOKABLE void processIrcEventPart(IrcEvent *event);         /// Leaving a channel
  61     Q_INVOKABLE void lateProcessIrcEventPart(IrcEvent *event);
  62     Q_INVOKABLE void processIrcEventPing(IrcEvent *event);
  63     Q_INVOKABLE void processIrcEventPong(IrcEvent *event);
  64     Q_INVOKABLE void processIrcEventQuit(IrcEvent *event);
  65     Q_INVOKABLE void lateProcessIrcEventQuit(IrcEvent *event);
  66     Q_INVOKABLE void processIrcEventTopic(IrcEvent *event);
  67     Q_INVOKABLE void processIrcEventError(IrcEvent *event);       /// ERROR message from server
  68 #ifdef HAVE_QCA2
  69     Q_INVOKABLE void processKeyEvent(KeyEvent *event);
  70 #endif
  71
  72     Q_INVOKABLE void processIrcEvent001(IrcEventNumeric *event);   // RPL_WELCOME
  73     Q_INVOKABLE void processIrcEvent005(IrcEvent *event);          // RPL_ISUPPORT
  74     Q_INVOKABLE void processIrcEvent221(IrcEvent *event);          // RPL_UMODEIS
  75     Q_INVOKABLE void processIrcEvent250(IrcEvent *event);          // RPL_STATSCONN
  76     Q_INVOKABLE void processIrcEvent265(IrcEvent *event);          // RPL_LOCALUSERS
  77     Q_INVOKABLE void processIrcEvent266(IrcEvent *event);          // RPL_GLOBALUSERS
  78     Q_INVOKABLE void processIrcEvent301(IrcEvent *event);          // RPL_AWAY
  79     Q_INVOKABLE void processIrcEvent305(IrcEvent *event);          // RPL_UNAWAY
  80     Q_INVOKABLE void processIrcEvent306(IrcEvent *event);          // RPL_NOWAWAY
  81     Q_INVOKABLE void processIrcEvent307(IrcEvent *event);          // RPL_WHOISSERVICE
  82     Q_INVOKABLE void processIrcEvent310(IrcEvent *event);          // RPL_SUSERHOST
  83     Q_INVOKABLE void processIrcEvent311(IrcEvent *event);          // RPL_WHOISUSER
  84     Q_INVOKABLE void processIrcEvent312(IrcEvent *event);          // RPL_WHOISSERVER
  85     Q_INVOKABLE void processIrcEvent313(IrcEvent *event);          // RPL_WHOISOPERATOR
  86     Q_INVOKABLE void processIrcEvent315(IrcEvent *event);          // RPL_ENDOFWHO
  87     Q_INVOKABLE void processIrcEvent317(IrcEvent *event);          // RPL_WHOISIDLE
  88     Q_INVOKABLE void processIrcEvent322(IrcEvent *event);          // RPL_LIST
  89     Q_INVOKABLE void processIrcEvent323(IrcEvent *event);          // RPL_LISTEND
  90     Q_INVOKABLE void processIrcEvent324(IrcEvent *event);          // RPL_CHANNELMODEIS
  91     Q_INVOKABLE void processIrcEvent330(IrcEvent *event);          // RPL_WHOISACCOUNT (quakenet/snircd/undernet)
  92     Q_INVOKABLE void processIrcEvent331(IrcEvent *event);          // RPL_NOTOPIC
  93     Q_INVOKABLE void processIrcEvent332(IrcEvent *event);          // RPL_TOPIC
  94     Q_INVOKABLE void processIrcEvent352(IrcEvent *event);          // RPL_WHOREPLY
  95     Q_INVOKABLE void processIrcEvent353(IrcEvent *event);          // RPL_NAMREPLY
  96     Q_INVOKABLE void processIrcEvent354(IrcEvent *event);          // RPL_WHOSPCRPL
  97     Q_INVOKABLE void processIrcEvent403(IrcEventNumeric *event);   // ERR_NOSUCHCHANNEL
  98     Q_INVOKABLE void processIrcEvent432(IrcEventNumeric *event);   // ERR_ERRONEUSNICKNAME
  99     Q_INVOKABLE void processIrcEvent433(IrcEventNumeric *event);   // ERR_NICKNAMEINUSE
 100     Q_INVOKABLE void processIrcEvent437(IrcEventNumeric *event);   // ERR_UNAVAILRESOURCE
 101
 102     // Q_INVOKABLE void processIrcEvent(IrcEvent *event);
 103
 104     /* CTCP handlers */
 105     Q_INVOKABLE void processCtcpEvent(CtcpEvent *event);
 106
 107     Q_INVOKABLE void handleCtcpAction(CtcpEvent *event);
 108     Q_INVOKABLE void handleCtcpClientinfo(CtcpEvent *event);
 109     Q_INVOKABLE void handleCtcpDcc(CtcpEvent *event);
 110     Q_INVOKABLE void handleCtcpPing(CtcpEvent *event);
 111     Q_INVOKABLE void handleCtcpTime(CtcpEvent *event);
 112     Q_INVOKABLE void handleCtcpVersion(CtcpEvent *event);
 113     Q_INVOKABLE void defaultHandler(const QString &ctcpCmd, CtcpEvent *event);
 114
 115 signals:
 116     void newEvent(Event *event);
 117
 118 protected:
 119     bool checkParamCount(IrcEvent *event, int minParams);
 120     inline CoreNetwork *coreNetwork(NetworkEvent *e) const { return qobject_cast<CoreNetwork *>(e->network()); }
 121     void tryNextNick(NetworkEvent *e, const QString &errnick, bool erroneous = false);
 122
 123 private slots:
 124     //! Joins after a netsplit
 125     /** This slot handles a bulk-join after a netsplit is over
 126       * \param net     The network
 127       * \param channel The channel the users joined
 128       * \param users   The list of users that joind the channel
 129       * \param modes   The list of modes the users get set
 130       * \param quitMessage The message we received when the netsplit occured
 131       */
 132     void handleNetsplitJoin(Network *net, const QString &channel, const QStringList &users, const QStringList &modes, const QString &quitMessage);
 133
 134     //! Quits after a netsplit
 135     /** This slot handles a bulk-quit after a netsplit occured
 136       * \param net     The network
 137       * \param channel The channel the users quitted
 138       * \param users   The list of users that got split
 139       * \param quitMessage The message we received when the netsplit occured
 140       */
 141     void handleNetsplitQuit(Network *net, const QString &channel, const QStringList &users, const QString &quitMessage);
 142
 143     //! Netsplit finished
 144     /** This slot deletes the netsplit object that sent the finished() signal
 145       */
 146     void handleNetsplitFinished();
 147
 148     void handleEarlyNetsplitJoin(Network *net, const QString &channel, const QStringList &users, const QStringList &modes);
 149
 150     //! Destroy any existing netsplits
 151     /** This slot deletes all netsplit objects
 152       * Used to get rid of existing netsplits on network reconnect
 153       * \param network The network we want to clear
 154       */
 155     void destroyNetsplits(NetworkId network);
 156
 157 private:
 158     CoreSession *_coreSession;
 159
 160     // structure to organize netsplits
 161     // key: quit message
 162     // value: the corresponding netsplit object
 163     QHash<Network *, QHash<QString, Netsplit *> > _netsplits;
 164
 165     /**
 166      * Process given WHO reply information, updating user data, channel modes, etc as needed
 167      *
 168      * This takes information from WHO and WHOX replies, processing information that's common
 169      * between them.
 170      *
 171      * @param[in] net                 Network object for the IRC server
 172      * @param[in] targetChannel       Target channel, or * if unspecified
 173      * @param[in] ircUser             IrcUser representing the desired nick
 174      * @param[in] server              Nick server name
 175      * @param[in] user                Nick username
 176      * @param[in] host                Nick hostname
 177      * @param[in] awayStateAndModes   Nick away-state and modes (e.g. G@)
 178      * @param[in] realname            Nick realname
 179      */
 180     void processWhoInformation (Network *net, const QString &targetChannel, IrcUser *ircUser,
 181                                 const QString &server, const QString &user, const QString &host,
 182                                 const QString &awayStateAndModes, const QString &realname);
 183 };
 184
 185
 186 #endif