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