src/common/ircuser.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2015 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 IRCUSER_H
  22 #define IRCUSER_H
  23
  24 #include <QSet>
  25 #include <QString>
  26 #include <QStringList>
  27 #include <QVariantMap>
  28 #include <QDateTime>
  29
  30 #include "syncableobject.h"
  31 #include "types.h"
  32
  33 class SignalProxy;
  34 class Network;
  35 class IrcChannel;
  36
  37 class IrcUser : public SyncableObject
  38 {
  39     SYNCABLE_OBJECT
  40     Q_OBJECT
  41
  42     Q_PROPERTY(QString user READ user WRITE setUser)
  43     Q_PROPERTY(QString host READ host WRITE setHost)
  44     Q_PROPERTY(QString nick READ nick WRITE setNick)
  45     Q_PROPERTY(QString realName READ realName WRITE setRealName)
  46     Q_PROPERTY(bool away READ isAway WRITE setAway)
  47     Q_PROPERTY(QString awayMessage READ awayMessage WRITE setAwayMessage)
  48     Q_PROPERTY(QDateTime idleTime READ idleTime WRITE setIdleTime)
  49     Q_PROPERTY(QDateTime loginTime READ loginTime WRITE setLoginTime)
  50     Q_PROPERTY(QString server READ server WRITE setServer)
  51     Q_PROPERTY(QString ircOperator READ ircOperator WRITE setIrcOperator)
  52     Q_PROPERTY(int lastAwayMessage READ lastAwayMessage WRITE setLastAwayMessage)
  53     Q_PROPERTY(QString whoisServiceReply READ whoisServiceReply WRITE setWhoisServiceReply)
  54     Q_PROPERTY(QString suserHost READ suserHost WRITE setSuserHost)
  55     Q_PROPERTY(bool encrypted READ encrypted WRITE setEncrypted)
  56
  57     Q_PROPERTY(QStringList channels READ channels)
  58     Q_PROPERTY(QString userModes READ userModes WRITE setUserModes)
  59
  60 public :
  61         IrcUser(const QString &hostmask, Network *network);
  62     virtual ~IrcUser();
  63
  64     inline QString user() const { return _user; }
  65     inline QString host() const { return _host; }
  66     inline QString nick() const { return _nick; }
  67     inline QString realName() const { return _realName; }
  68     QString hostmask() const;
  69     inline bool isAway() const { return _away; }
  70     inline QString awayMessage() const { return _awayMessage; }
  71     QDateTime idleTime();
  72     inline QDateTime loginTime() const { return _loginTime; }
  73     inline QString server() const { return _server; }
  74     inline QString ircOperator() const { return _ircOperator; }
  75     inline int lastAwayMessage() const { return _lastAwayMessage; }
  76     inline QString whoisServiceReply() const { return _whoisServiceReply; }
  77     inline QString suserHost() const { return _suserHost; }
  78     inline bool encrypted() const { return _encrypted; }
  79     inline Network *network() const { return _network; }
  80
  81     inline QString userModes() const { return _userModes; }
  82
  83     QStringList channels() const;
  84
  85     // user-specific encodings
  86     inline QTextCodec *codecForEncoding() const { return _codecForEncoding; }
  87     inline QTextCodec *codecForDecoding() const { return _codecForDecoding; }
  88     void setCodecForEncoding(const QString &codecName);
  89     void setCodecForEncoding(QTextCodec *codec);
  90     void setCodecForDecoding(const QString &codecName);
  91     void setCodecForDecoding(QTextCodec *codec);
  92
  93     QString decodeString(const QByteArray &text) const;
  94     QByteArray encodeString(const QString &string) const;
  95
  96     // only valid on client side, these are not synced!
  97     inline QDateTime lastChannelActivity(BufferId id) const { return _lastActivity.value(id); }
  98     void setLastChannelActivity(BufferId id, const QDateTime &time);
  99     inline QDateTime lastSpokenTo(BufferId id) const { return _lastSpokenTo.value(id); }
 100     void setLastSpokenTo(BufferId id, const QDateTime &time);
 101
 102 public slots:
 103     void setUser(const QString &user);
 104     void setHost(const QString &host);
 105     void setNick(const QString &nick);
 106     void setRealName(const QString &realName);
 107     void setAway(const bool &away);
 108     void setAwayMessage(const QString &awayMessage);
 109     void setIdleTime(const QDateTime &idleTime);
 110     void setLoginTime(const QDateTime &loginTime);
 111     void setServer(const QString &server);
 112     void setIrcOperator(const QString &ircOperator);
 113     void setLastAwayMessage(const int &lastAwayMessage);
 114     void setWhoisServiceReply(const QString &whoisServiceReply);
 115     void setSuserHost(const QString &suserHost);
 116     void setEncrypted(bool encrypted);
 117     void updateHostmask(const QString &mask);
 118
 119     void setUserModes(const QString &modes);
 120
 121     /*!
 122      * \brief joinChannel Called when user joins some channel, this function inserts the channel to internal list of channels this user is in.
 123      * \param channel Pointer to a channel this user just joined
 124      * \param skip_channel_join If this is false, this function will also call IrcChannel::joinIrcUser, can be set to true as a performance tweak.
 125      */
 126     void joinChannel(IrcChannel *channel, bool skip_channel_join = false);
 127     void joinChannel(const QString &channelname);
 128     void partChannel(IrcChannel *channel);
 129     void partChannel(const QString &channelname);
 130     void quit();
 131
 132     void addUserModes(const QString &modes);
 133     void removeUserModes(const QString &modes);
 134
 135 signals:
 136 //   void userSet(QString user);
 137 //   void hostSet(QString host);
 138     void nickSet(QString newnick); // needed in NetworkModel
 139 //   void realNameSet(QString realName);
 140     void awaySet(bool away); // needed in NetworkModel
 141 //   void awayMessageSet(QString awayMessage);
 142 //   void idleTimeSet(QDateTime idleTime);
 143 //   void loginTimeSet(QDateTime loginTime);
 144 //   void serverSet(QString server);
 145 //   void ircOperatorSet(QString ircOperator);
 146 //   void lastAwayMessageSet(int lastAwayMessage);
 147 //   void whoisServiceReplySet(QString whoisServiceReply);
 148 //   void suserHostSet(QString suserHost);
 149     void encryptedSet(bool encrypted);
 150
 151     void userModesSet(QString modes);
 152     void userModesAdded(QString modes);
 153     void userModesRemoved(QString modes);
 154
 155     // void channelJoined(QString channel);
 156     void channelParted(QString channel);
 157     void quited();
 158
 159     void lastChannelActivityUpdated(BufferId id, const QDateTime &newTime);
 160     void lastSpokenToUpdated(BufferId id, const QDateTime &newTime);
 161
 162 private slots:
 163     void updateObjectName();
 164     void channelDestroyed();
 165
 166 private:
 167     inline bool operator==(const IrcUser &ircuser2)
 168     {
 169         return (_nick.toLower() == ircuser2.nick().toLower());
 170     }
 171
 172
 173     inline bool operator==(const QString &nickname)
 174     {
 175         return (_nick.toLower() == nickname.toLower());
 176     }
 177
 178
 179     bool _initialized;
 180
 181     QString _nick;
 182     QString _user;
 183     QString _host;
 184     QString _realName;
 185     QString _awayMessage;
 186     bool _away;
 187     QString _server;
 188     QDateTime _idleTime;
 189     QDateTime _idleTimeSet;
 190     QDateTime _loginTime;
 191     QString _ircOperator;
 192     int _lastAwayMessage;
 193     QString _whoisServiceReply;
 194     QString _suserHost;
 195     bool _encrypted;
 196
 197     // QSet<QString> _channels;
 198     QSet<IrcChannel *> _channels;
 199     QString _userModes;
 200
 201     Network *_network;
 202
 203     QTextCodec *_codecForEncoding;
 204     QTextCodec *_codecForDecoding;
 205
 206     QHash<BufferId, QDateTime> _lastActivity;
 207     QHash<BufferId, QDateTime> _lastSpokenTo;
 208 };
 209
 210
 211 #endif