src/common/ircchannel.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 #pragma once
  22
  23 #include "common-export.h"
  24
  25 #include <QHash>
  26 #include <QSet>
  27 #include <QString>
  28 #include <QStringList>
  29 #include <QVariantMap>
  30
  31 #include "syncableobject.h"
  32
  33 class IrcUser;
  34 class Network;
  35
  36 class COMMON_EXPORT IrcChannel : public SyncableObject
  37 {
  38     Q_OBJECT
  39     SYNCABLE_OBJECT
  40
  41     Q_PROPERTY(QString name READ name)
  42     Q_PROPERTY(QString topic READ topic WRITE setTopic)
  43     Q_PROPERTY(QString password READ password WRITE setPassword)
  44     Q_PROPERTY(bool encrypted READ encrypted WRITE setEncrypted)
  45
  46 public :
  47     IrcChannel(const QString &channelname, Network *network);
  48     ~IrcChannel();
  49
  50     bool isKnownUser(IrcUser *ircuser) const;
  51     bool isValidChannelUserMode(const QString &mode) const;
  52
  53     inline QString name() const { return _name; }
  54     inline QString topic() const { return _topic; }
  55     inline QString password() const { return _password; }
  56     inline bool encrypted() const { return _encrypted; }
  57     inline Network *network() const { return _network; }
  58
  59     inline QList<IrcUser *> ircUsers() const { return _userModes.keys(); }
  60
  61     QString userModes(IrcUser *ircuser) const;
  62     QString userModes(const QString &nick) const;
  63
  64     bool hasMode(const QChar &mode) const;
  65     QString modeValue(const QChar &mode) const;
  66     QStringList modeValueList(const QChar &mode) const;
  67     QString channelModeString() const;
  68
  69     inline QTextCodec *codecForEncoding() const { return _codecForEncoding; }
  70     inline QTextCodec *codecForDecoding() const { return _codecForDecoding; }
  71     void setCodecForEncoding(const QString &codecName);
  72     void setCodecForEncoding(QTextCodec *codec);
  73     void setCodecForDecoding(const QString &codecName);
  74     void setCodecForDecoding(QTextCodec *codec);
  75
  76     QString decodeString(const QByteArray &text) const;
  77     QByteArray encodeString(const QString &string) const;
  78
  79 public slots:
  80     void setTopic(const QString &topic);
  81     void setPassword(const QString &password);
  82     void setEncrypted(bool encrypted);
  83
  84     void joinIrcUsers(const QList<IrcUser *> &users, const QStringList &modes);
  85     void joinIrcUsers(const QStringList &nicks, const QStringList &modes);
  86     void joinIrcUser(IrcUser *ircuser);
  87
  88     void part(IrcUser *ircuser);
  89     void part(const QString &nick);
  90
  91     void setUserModes(IrcUser *ircuser, const QString &modes);
  92     void setUserModes(const QString &nick, const QString &modes);
  93
  94     void addUserMode(IrcUser *ircuser, const QString &mode);
  95     void addUserMode(const QString &nick, const QString &mode);
  96
  97     void removeUserMode(IrcUser *ircuser, const QString &mode);
  98     void removeUserMode(const QString &nick, const QString &mode);
  99
 100     void addChannelMode(const QChar &mode, const QString &value);
 101     void removeChannelMode(const QChar &mode, const QString &value);
 102
 103     // init geters
 104     QVariantMap initUserModes() const;
 105     QVariantMap initChanModes() const;
 106
 107     // init seters
 108     void initSetUserModes(const QVariantMap &usermodes);
 109     void initSetChanModes(const QVariantMap &chanModes);
 110
 111 signals:
 112     void topicSet(const QString &topic); // needed by NetworkModel
 113     void encryptedSet(bool encrypted);
 114 //   void passwordSet(const QString &password);
 115 //   void userModesSet(QString nick, QString modes);
 116 //   void userModeAdded(QString nick, QString mode);
 117 //   void userModeRemoved(QString nick, QString mode);
 118 //   void channelModeAdded(const QChar &mode, const QString &value);
 119 //   void channelModeRemoved(const QChar &mode, const QString &value);
 120
 121     void ircUsersJoined(QList<IrcUser *> ircusers);
 122 //   void ircUsersJoined(QStringList nicks, QStringList modes);
 123     void ircUserParted(IrcUser *ircuser);
 124     void ircUserNickSet(IrcUser *ircuser, QString nick);
 125     void ircUserModeAdded(IrcUser *ircuser, QString mode);
 126     void ircUserModeRemoved(IrcUser *ircuser, QString mode);
 127     void ircUserModesSet(IrcUser *ircuser, QString modes);
 128
 129     void parted(); // convenience signal emitted before channels destruction
 130
 131 private slots:
 132     void ircUserDestroyed();
 133     void ircUserNickSet(QString nick);
 134
 135 private:
 136     bool _initialized;
 137     QString _name;
 138     QString _topic;
 139     QString _password;
 140     bool _encrypted;
 141
 142     QHash<IrcUser *, QString> _userModes;
 143
 144     Network *_network;
 145
 146     QTextCodec *_codecForEncoding;
 147     QTextCodec *_codecForDecoding;
 148
 149     QHash<QChar, QStringList> _A_channelModes;
 150     QHash<QChar, QString> _B_channelModes;
 151     QHash<QChar, QString> _C_channelModes;
 152     QSet<QChar> _D_channelModes;
 153 };