kopete/protocols/irc/ircaccount.h

   1 /*
   2     ircaccount.h - IRC Account
   3
   4     Copyright (c) 2002      by Nick Betcher <nbetcher@kde.org>
   5     Copyright (c) 2003      by Jason Keirstead <jason@keirstead.org>
   6     Copyright (c) 2003-2007 by Michel Hermier <michel.hermier@gmail.com>
   7
   8     Kopete    (c) 2002-2007 by the Kopete developers <kopete-devel@kde.org>
   9
  10     *************************************************************************
  11     *                                                                       *
  12     * This program is free software; you can redistribute it and/or modify  *
  13     * it under the terms of the GNU General Public License as published by  *
  14     * the Free Software Foundation; either version 2 of the License, or     *
  15     * (at your option) any later version.                                   *
  16     *                                                                       *
  17     *************************************************************************
  18 */
  19
  20 #ifndef IRCACCOUNT_H
  21 #define IRCACCOUNT_H
  22
  23 #include "ircnetwork.h"
  24
  25 #include "kircsocket.h"
  26
  27 #include "kopetepasswordedaccount.h"
  28 #include "kopetemessage.h"
  29
  30 class IRCContact;
  31
  32 namespace KIrc
  33 {
  34 class ClientSocket;
  35 class Event;
  36 }
  37
  38 namespace Kopete
  39 {
  40 class Contact;
  41 class Message;
  42 class ChatSession;
  43 class MetaContact;
  44 }
  45
  46 class KAction;
  47 class KActionMenu;
  48
  49 class IRCAccount
  50         : public Kopete::PasswordedAccount
  51 {
  52         Q_OBJECT
  53
  54         Q_PROPERTY(int codecMib READ codecMib WRITE setCodecFromMib)
  55         Q_PROPERTY(QString networkName READ networkName WRITE setNetworkByName)
  56
  57         Q_PROPERTY(QString userName READ userName WRITE setUserName)
  58         Q_PROPERTY(QString realName READ realName WRITE setRealName)
  59 //      Q_PROPERTY(QString password READ password WRITE setPassword)
  60
  61         Q_PROPERTY(QString nickName READ nickName WRITE setNickName)
  62 //      Q_PROPERTY(QStringList nickNames READ nickNames WRITE setNickNames)
  63
  64         Q_PROPERTY(QString partMessage READ partMessage WRITE setPartMessage)
  65         Q_PROPERTY(QString quitMessage READ quitMessage WRITE setQuitMessage)
  66
  67         Q_PROPERTY(bool autoShowServerWindow READ autoShowServerWindow WRITE setAutoShowServerWindow)
  68
  69 public:
  70         explicit IRCAccount(const QString &accountid, const QString &autoConnect = QString(),
  71                         const QString& networkName = QString(), const QString &nickName = QString());
  72         virtual ~IRCAccount();
  73
  74 public: // READ properties accessors.
  75
  76         int codecMib() const;
  77
  78         const QString networkName() const;
  79
  80         const QString userName() const;
  81
  82         const QString realName() const;
  83
  84         const QString nickName() const;
  85
  86 //      const QString altNick() const;
  87
  88         const QString partMessage() const;
  89
  90         const QString quitMessage() const;
  91
  92         bool autoShowServerWindow() const;
  93
  94 public slots: // WRITE properties accessors.
  95
  96         void setCodecFromMib(int mib);
  97
  98         void setNetworkByName( const QString & );
  99
 100         void setUserName( const QString & );
 101
 102         void setRealName( const QString & );
 103
 104         void setNickName( const QString & );
 105
 106         void setPartMessage( const QString & );
 107
 108         void setQuitMessage( const QString & );
 109
 110         void setAutoShowServerWindow( bool autoShow );
 111
 112 public:
 113         // Returns the KIRC engine instance
 114         KIrc::ClientSocket *client() const;
 115
 116         QTextCodec *codec() const;
 117         void setCodec( QTextCodec *codec );
 118
 119 //      IRCNetwork network();
 120
 121         const QStringList connectCommands() const;
 122
 123         void setConnectCommands( const QStringList & ) const;
 124
 125 public:
 126
 127         QMap< QString, QString > customCtcp() const;
 128
 129         void setCustomCtcpReplies( const QMap< QString, QString > &replies );
 130
 131         const QMap<QString, QString> customCtcpReplies() const;
 132
 133         void setCurrentCommandSource( Kopete::ChatSession *session );
 134
 135         Kopete::ChatSession *currentCommandSource();
 136
 137         IRCContact *getContact(const QByteArray &name, Kopete::MetaContact *metac=0);
 138         IRCContact *getContact(const KIrc::EntityPtr &entity, Kopete::MetaContact *metac=0);
 139         QList<Kopete::Contact*> getContacts( const KIrc::EntityList &entities);
 140
 141         virtual void fillActionMenu( KActionMenu *actionMenu );
 142
 143         /** Reimplemented from Kopete::Account */
 144         virtual void setOnlineStatus(const Kopete::OnlineStatus &status, const Kopete::StatusMessage &statusMessage,
 145                                      const OnlineStatusOptions& options = None);
 146
 147         virtual void setStatusMessage(const Kopete::StatusMessage &statusMessage);
 148
 149         // Returns the Kopete::Contact of the user
 150         IRCContact *mySelf() const;
 151
 152         // Returns the Kopete::Contact of the server of the user
 153         IRCContact *myServer() const;
 154
 155 public slots:
 156
 157         virtual void setAway( bool isAway, const QString &awayMessage = QString() );
 158
 159         virtual void connectWithPassword( const QString & );
 160
 161         virtual void disconnect() { quit(); } // REMOVE ME ASAP
 162
 163 public slots:
 164         void quit( const QString &quitMessage = QString() );
 165
 166 protected:
 167         virtual bool createContact( const QString &contactId, Kopete::MetaContact *parentContact ) ;
 168
 169 private slots:
 170         void clientConnectionStateChanged(KIrc::Socket::ConnectionState newstate);
 171
 172         void destroyed(IRCContact *contact);
 173
 174         void receivedEvent(QEvent *event);
 175
 176         void slotPerformOnConnectCommands();
 177
 178         void slotShowServerWindow();
 179
 180         void slotJoinChannel();
 181
 182 private:
 183         void clientSetup();
 184         void clientConnect();
 185         void appendMessage(IRCContact* from, QList<Kopete::Contact*> to,const QString& text, Kopete::Message::MessageType type);
 186 private:
 187         Q_DISABLE_COPY(IRCAccount)
 188
 189         class Private;
 190         Private * const d;
 191 };
 192
 193 #endif