src/common/ircchannel.h

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