1 /***************************************************************************
2 * Copyright (C) 2005-2013 by the Quassel Project *
3 * devel@quassel-irc.org *
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. *
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. *
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 ***************************************************************************/
21 #include "ircchannel.h"
27 #include <QMapIterator>
28 #include <QHashIterator>
33 INIT_SYNCABLE_OBJECT(IrcChannel)
34 IrcChannel::IrcChannel(const QString &channelname, Network *network)
35 : SyncableObject(network),
44 setObjectName(QString::number(network->networkId().toInt()) + "/" + channelname);
48 IrcChannel::~IrcChannel()
53 // ====================
55 // ====================
56 bool IrcChannel::isKnownUser(IrcUser *ircuser) const
59 qWarning() << "Channel" << name() << "received IrcUser Nullpointer!";
63 if (!_userModes.contains(ircuser)) {
64 qWarning() << "Channel" << name() << "received data for unknown User" << ircuser->nick();
72 bool IrcChannel::isValidChannelUserMode(const QString &mode) const
75 if (mode.size() > 1) {
76 qWarning() << "Channel" << name() << "received Channel User Mode which is longer then 1 Char:" << mode;
83 QString IrcChannel::userModes(IrcUser *ircuser) const
85 if (_userModes.contains(ircuser))
86 return _userModes[ircuser];
92 QString IrcChannel::userModes(const QString &nick) const
94 return userModes(network()->ircUser(nick));
98 void IrcChannel::setCodecForEncoding(const QString &name)
100 setCodecForEncoding(QTextCodec::codecForName(name.toAscii()));
104 void IrcChannel::setCodecForEncoding(QTextCodec *codec)
106 _codecForEncoding = codec;
110 void IrcChannel::setCodecForDecoding(const QString &name)
112 setCodecForDecoding(QTextCodec::codecForName(name.toAscii()));
116 void IrcChannel::setCodecForDecoding(QTextCodec *codec)
118 _codecForDecoding = codec;
122 QString IrcChannel::decodeString(const QByteArray &text) const
124 if (!codecForDecoding()) return network()->decodeString(text);
125 return ::decodeString(text, _codecForDecoding);
129 QByteArray IrcChannel::encodeString(const QString &string) const
131 if (codecForEncoding()) {
132 return _codecForEncoding->fromUnicode(string);
134 return network()->encodeString(string);
138 // ====================
140 // ====================
141 void IrcChannel::setTopic(const QString &topic)
145 emit topicSet(topic);
149 void IrcChannel::setPassword(const QString &password)
151 _password = password;
155 void IrcChannel::setEncrypted(bool encrypted)
157 _encrypted = encrypted;
159 emit encryptedSet(encrypted);
163 void IrcChannel::joinIrcUsers(const QList<IrcUser *> &users, const QStringList &modes)
168 if (users.count() != modes.count()) {
169 qWarning() << "IrcChannel::addUsers(): number of nicks does not match number of modes!";
173 QStringList newNicks;
174 QStringList newModes;
175 QList<IrcUser *> newUsers;
178 for (int i = 0; i < users.count(); i++) {
180 if (!ircuser || _userModes.contains(ircuser)) {
181 addUserMode(ircuser, modes[i]);
185 _userModes[ircuser] = modes[i];
186 ircuser->joinChannel(this);
187 connect(ircuser, SIGNAL(nickSet(QString)), this, SLOT(ircUserNickSet(QString)));
189 // connect(ircuser, SIGNAL(destroyed()), this, SLOT(ircUserDestroyed()));
190 // if you wonder why there is no counterpart to ircUserJoined:
191 // the joines are propagted by the ircuser. the signal ircUserJoined is only for convenience
193 newNicks << ircuser->nick();
194 newModes << modes[i];
198 if (newNicks.isEmpty())
201 SYNC_OTHER(joinIrcUsers, ARG(newNicks), ARG(newModes));
202 emit ircUsersJoined(newUsers);
206 void IrcChannel::joinIrcUsers(const QStringList &nicks, const QStringList &modes)
208 QList<IrcUser *> users;
209 foreach(QString nick, nicks)
210 users << network()->newIrcUser(nick);
211 joinIrcUsers(users, modes);
215 void IrcChannel::joinIrcUser(IrcUser *ircuser)
217 QList<IrcUser *> users;
221 joinIrcUsers(users, modes);
225 void IrcChannel::part(IrcUser *ircuser)
227 if (isKnownUser(ircuser)) {
228 _userModes.remove(ircuser);
229 ircuser->partChannel(this);
230 // if you wonder why there is no counterpart to ircUserParted:
231 // the joines are propagted by the ircuser. the signal ircUserParted is only for convenience
232 disconnect(ircuser, 0, this, 0);
233 emit ircUserParted(ircuser);
235 if (network()->isMe(ircuser) || _userModes.isEmpty()) {
236 // in either case we're no longer in the channel
237 // -> clean up the channel and destroy it
238 QList<IrcUser *> users = _userModes.keys();
240 foreach(IrcUser *user, users) {
241 disconnect(user, 0, this, 0);
242 user->partChannel(this);
245 network()->removeIrcChannel(this);
251 void IrcChannel::part(const QString &nick)
253 part(network()->ircUser(nick));
258 void IrcChannel::setUserModes(IrcUser *ircuser, const QString &modes)
260 if (isKnownUser(ircuser)) {
261 _userModes[ircuser] = modes;
262 QString nick = ircuser->nick();
263 SYNC_OTHER(setUserModes, ARG(nick), ARG(modes))
264 emit ircUserModesSet(ircuser, modes);
269 void IrcChannel::setUserModes(const QString &nick, const QString &modes)
271 setUserModes(network()->ircUser(nick), modes);
276 void IrcChannel::addUserMode(IrcUser *ircuser, const QString &mode)
278 if (!isKnownUser(ircuser) || !isValidChannelUserMode(mode))
281 if (!_userModes[ircuser].contains(mode)) {
282 _userModes[ircuser] += mode;
283 QString nick = ircuser->nick();
284 SYNC_OTHER(addUserMode, ARG(nick), ARG(mode))
285 emit ircUserModeAdded(ircuser, mode);
290 void IrcChannel::addUserMode(const QString &nick, const QString &mode)
292 addUserMode(network()->ircUser(nick), mode);
297 void IrcChannel::removeUserMode(IrcUser *ircuser, const QString &mode)
299 if (!isKnownUser(ircuser) || !isValidChannelUserMode(mode))
302 if (_userModes[ircuser].contains(mode)) {
303 _userModes[ircuser].remove(mode);
304 QString nick = ircuser->nick();
305 SYNC_OTHER(removeUserMode, ARG(nick), ARG(mode));
306 emit ircUserModeRemoved(ircuser, mode);
311 void IrcChannel::removeUserMode(const QString &nick, const QString &mode)
313 removeUserMode(network()->ircUser(nick), mode);
317 // INIT SET USER MODES
318 QVariantMap IrcChannel::initUserModes() const
320 QVariantMap usermodes;
321 QHash<IrcUser *, QString>::const_iterator iter = _userModes.constBegin();
322 while (iter != _userModes.constEnd()) {
323 usermodes[iter.key()->nick()] = iter.value();
330 void IrcChannel::initSetUserModes(const QVariantMap &usermodes)
332 QList<IrcUser *> users;
334 QVariantMap::const_iterator iter = usermodes.constBegin();
335 while (iter != usermodes.constEnd()) {
336 users << network()->newIrcUser(iter.key());
337 modes << iter.value().toString();
340 joinIrcUsers(users, modes);
344 QVariantMap IrcChannel::initChanModes() const
346 QVariantMap channelModes;
349 QHash<QChar, QStringList>::const_iterator A_iter = _A_channelModes.constBegin();
350 while (A_iter != _A_channelModes.constEnd()) {
351 A_modes[A_iter.key()] = A_iter.value();
354 channelModes["A"] = A_modes;
357 QHash<QChar, QString>::const_iterator B_iter = _B_channelModes.constBegin();
358 while (B_iter != _B_channelModes.constEnd()) {
359 B_modes[B_iter.key()] = B_iter.value();
362 channelModes["B"] = B_modes;
365 QHash<QChar, QString>::const_iterator C_iter = _C_channelModes.constBegin();
366 while (C_iter != _C_channelModes.constEnd()) {
367 C_modes[C_iter.key()] = C_iter.value();
370 channelModes["C"] = C_modes;
373 QSet<QChar>::const_iterator D_iter = _D_channelModes.constBegin();
374 while (D_iter != _D_channelModes.constEnd()) {
378 channelModes["D"] = D_modes;
384 void IrcChannel::initSetChanModes(const QVariantMap &channelModes)
386 QVariantMap::const_iterator iter = channelModes["A"].toMap().constBegin();
387 QVariantMap::const_iterator iterEnd = channelModes["A"].toMap().constEnd();
388 while (iter != iterEnd) {
389 _A_channelModes[iter.key()[0]] = iter.value().toStringList();
393 iter = channelModes["B"].toMap().constBegin();
394 iterEnd = channelModes["B"].toMap().constEnd();
395 while (iter != iterEnd) {
396 _B_channelModes[iter.key()[0]] = iter.value().toString();
400 iter = channelModes["C"].toMap().constBegin();
401 iterEnd = channelModes["C"].toMap().constEnd();
402 while (iter != iterEnd) {
403 _C_channelModes[iter.key()[0]] = iter.value().toString();
407 QString D_modes = channelModes["D"].toString();
408 for (int i = 0; i < D_modes.count(); i++) {
409 _D_channelModes << D_modes[i];
414 void IrcChannel::ircUserDestroyed()
416 IrcUser *ircUser = static_cast<IrcUser *>(sender());
418 _userModes.remove(ircUser);
419 // no further propagation.
420 // this leads only to fuck ups.
424 void IrcChannel::ircUserNickSet(QString nick)
426 IrcUser *ircUser = qobject_cast<IrcUser *>(sender());
428 emit ircUserNickSet(ircUser, nick);
432 /*******************************************************************************
436 * o CHANMODES=A,B,C,D
438 * The CHANMODES token specifies the modes that may be set on a channel.
439 * These modes are split into four categories, as follows:
441 * o Type A: Modes that add or remove an address to or from a list.
442 * These modes always take a parameter when sent by the server to a
443 * client; when sent by a client, they may be specified without a
444 * parameter, which requests the server to display the current
445 * contents of the corresponding list on the channel to the client.
446 * o Type B: Modes that change a setting on the channel. These modes
447 * always take a parameter.
448 * o Type C: Modes that change a setting on the channel. These modes
449 * take a parameter only when set; the parameter is absent when the
450 * mode is removed both in the client's and server's MODE command.
451 * o Type D: Modes that change a setting on the channel. These modes
452 * never take a parameter.
454 * If the server sends any additional types after these 4, the client
455 * MUST ignore them; this is intended to allow future extension of this
458 * The IRC server MUST NOT list modes in CHANMODES which are also
459 * present in the PREFIX parameter; however, for completeness, modes
460 * described in PREFIX may be treated as type B modes.
462 ******************************************************************************/
464 /*******************************************************************************
466 * A --> add/remove from List
467 * B --> set value or remove
468 * C --> set value or remove
471 * B and C behave very similar... we store the data in different datastructes
472 * for future compatibility
473 ******************************************************************************/
475 // NOTE: the behavior of addChannelMode and removeChannelMode depends on the type of mode
476 // see list above for chanmode types
477 void IrcChannel::addChannelMode(const QChar &mode, const QString &value)
479 Network::ChannelModeType modeType = network()->channelModeType(mode);
482 case Network::NOT_A_CHANMODE:
484 case Network::A_CHANMODE:
485 if (!_A_channelModes.contains(mode))
486 _A_channelModes[mode] = QStringList(value);
487 else if (!_A_channelModes[mode].contains(value))
488 _A_channelModes[mode] << value;
491 case Network::B_CHANMODE:
492 _B_channelModes[mode] = value;
495 case Network::C_CHANMODE:
496 _C_channelModes[mode] = value;
499 case Network::D_CHANMODE:
500 _D_channelModes << mode;
503 SYNC(ARG(mode), ARG(value))
507 void IrcChannel::removeChannelMode(const QChar &mode, const QString &value)
509 Network::ChannelModeType modeType = network()->channelModeType(mode);
512 case Network::NOT_A_CHANMODE:
514 case Network::A_CHANMODE:
515 if (_A_channelModes.contains(mode))
516 _A_channelModes[mode].removeAll(value);
519 case Network::B_CHANMODE:
520 _B_channelModes.remove(mode);
523 case Network::C_CHANMODE:
524 _C_channelModes.remove(mode);
527 case Network::D_CHANMODE:
528 _D_channelModes.remove(mode);
531 SYNC(ARG(mode), ARG(value))
535 bool IrcChannel::hasMode(const QChar &mode) const
537 Network::ChannelModeType modeType = network()->channelModeType(mode);
540 case Network::NOT_A_CHANMODE:
542 case Network::A_CHANMODE:
543 return _A_channelModes.contains(mode);
544 case Network::B_CHANMODE:
545 return _B_channelModes.contains(mode);
546 case Network::C_CHANMODE:
547 return _C_channelModes.contains(mode);
548 case Network::D_CHANMODE:
549 return _D_channelModes.contains(mode);
556 QString IrcChannel::modeValue(const QChar &mode) const
558 Network::ChannelModeType modeType = network()->channelModeType(mode);
561 case Network::B_CHANMODE:
562 if (_B_channelModes.contains(mode))
563 return _B_channelModes[mode];
566 case Network::C_CHANMODE:
567 if (_C_channelModes.contains(mode))
568 return _C_channelModes[mode];
577 QStringList IrcChannel::modeValueList(const QChar &mode) const
579 Network::ChannelModeType modeType = network()->channelModeType(mode);
582 case Network::A_CHANMODE:
583 if (_A_channelModes.contains(mode))
584 return _A_channelModes[mode];
586 return QStringList();
591 QString IrcChannel::channelModeString() const
596 QSet<QChar>::const_iterator D_iter = _D_channelModes.constBegin();
597 while (D_iter != _D_channelModes.constEnd()) {
598 modeString += *D_iter;
602 QHash<QChar, QString>::const_iterator BC_iter = _C_channelModes.constBegin();
603 while (BC_iter != _C_channelModes.constEnd()) {
604 modeString += BC_iter.key();
605 params << BC_iter.value();
609 BC_iter = _B_channelModes.constBegin();
610 while (BC_iter != _B_channelModes.constEnd()) {
611 modeString += BC_iter.key();
612 params << BC_iter.value();
615 if (modeString.isEmpty())
618 return QString("+%1 %2").arg(modeString).arg(params.join(" "));