src/common/ircchannel.cpp

   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 #include "ircchannel.h"
  22
  23 #include "network.h"
  24 #include "ircuser.h"
  25 #include "util.h"
  26
  27 #include <QMapIterator>
  28 #include <QHashIterator>
  29 #include <QTextCodec>
  30
  31 #include <QDebug>
  32
  33 INIT_SYNCABLE_OBJECT(IrcChannel)
  34 IrcChannel::IrcChannel(const QString &channelname, Network *network)
  35     : SyncableObject(network),
  36     _initialized(false),
  37     _name(channelname),
  38     _topic(QString()),
  39     _encrypted(false),
  40     _network(network),
  41     _codecForEncoding(0),
  42     _codecForDecoding(0)
  43 {
  44     setObjectName(QString::number(network->networkId().toInt()) + "/" +  channelname);
  45 }
  46
  47
  48 IrcChannel::~IrcChannel()
  49 {
  50 }
  51
  52
  53 // ====================
  54 //  PUBLIC:
  55 // ====================
  56 bool IrcChannel::isKnownUser(IrcUser *ircuser) const
  57 {
  58     if (ircuser == 0) {
  59         qWarning() << "Channel" << name() << "received IrcUser Nullpointer!";
  60         return false;
  61     }
  62
  63     if (!_userModes.contains(ircuser)) {
  64         qWarning() << "Channel" << name() << "received data for unknown User" << ircuser->nick();
  65         return false;
  66     }
  67
  68     return true;
  69 }
  70
  71
  72 bool IrcChannel::isValidChannelUserMode(const QString &mode) const
  73 {
  74     bool isvalid = true;
  75     if (mode.size() > 1) {
  76         qWarning() << "Channel" << name() << "received Channel User Mode which is longer than 1 Char:" << mode;
  77         isvalid = false;
  78     }
  79     return isvalid;
  80 }
  81
  82
  83 QString IrcChannel::userModes(IrcUser *ircuser) const
  84 {
  85     if (_userModes.contains(ircuser))
  86         return _userModes[ircuser];
  87     else
  88         return QString();
  89 }
  90
  91
  92 QString IrcChannel::userModes(const QString &nick) const
  93 {
  94     return userModes(network()->ircUser(nick));
  95 }
  96
  97
  98 void IrcChannel::setCodecForEncoding(const QString &name)
  99 {
 100     setCodecForEncoding(QTextCodec::codecForName(name.toLatin1()));
 101 }
 102
 103
 104 void IrcChannel::setCodecForEncoding(QTextCodec *codec)
 105 {
 106     _codecForEncoding = codec;
 107 }
 108
 109
 110 void IrcChannel::setCodecForDecoding(const QString &name)
 111 {
 112     setCodecForDecoding(QTextCodec::codecForName(name.toLatin1()));
 113 }
 114
 115
 116 void IrcChannel::setCodecForDecoding(QTextCodec *codec)
 117 {
 118     _codecForDecoding = codec;
 119 }
 120
 121
 122 QString IrcChannel::decodeString(const QByteArray &text) const
 123 {
 124     if (!codecForDecoding()) return network()->decodeString(text);
 125     return ::decodeString(text, _codecForDecoding);
 126 }
 127
 128
 129 QByteArray IrcChannel::encodeString(const QString &string) const
 130 {
 131     if (codecForEncoding()) {
 132         return _codecForEncoding->fromUnicode(string);
 133     }
 134     return network()->encodeString(string);
 135 }
 136
 137
 138 // ====================
 139 //  PUBLIC SLOTS:
 140 // ====================
 141 void IrcChannel::setTopic(const QString &topic)
 142 {
 143     _topic = topic;
 144     SYNC(ARG(topic))
 145     emit topicSet(topic);
 146 }
 147
 148
 149 void IrcChannel::setPassword(const QString &password)
 150 {
 151     _password = password;
 152     SYNC(ARG(password))
 153 }
 154
 155 void IrcChannel::setEncrypted(bool encrypted)
 156 {
 157     _encrypted = encrypted;
 158     SYNC(ARG(encrypted))
 159     emit encryptedSet(encrypted);
 160 }
 161
 162
 163 void IrcChannel::joinIrcUsers(const QList<IrcUser *> &users, const QStringList &modes)
 164 {
 165     if (users.isEmpty())
 166         return;
 167
 168     if (users.count() != modes.count()) {
 169         qWarning() << "IrcChannel::addUsers(): number of nicks does not match number of modes!";
 170         return;
 171     }
 172
 173     // Sort user modes first
 174     const QStringList sortedModes = network()->sortPrefixModes(modes);
 175
 176     QStringList newNicks;
 177     QStringList newModes;
 178     QList<IrcUser *> newUsers;
 179
 180     IrcUser *ircuser;
 181     for (int i = 0; i < users.count(); i++) {
 182         ircuser = users[i];
 183         if (!ircuser || _userModes.contains(ircuser)) {
 184             if (sortedModes[i].count() > 1) {
 185                 // Multiple modes received, do it one at a time
 186                 // TODO Better way of syncing this without breaking protocol?
 187                 for (int i_m = 0; i_m < sortedModes[i].count(); ++i_m) {
 188                     addUserMode(ircuser, sortedModes[i][i_m]);
 189                 }
 190             } else {
 191                 addUserMode(ircuser, sortedModes[i]);
 192             }
 193             continue;
 194         }
 195
 196         _userModes[ircuser] = sortedModes[i];
 197         ircuser->joinChannel(this, true);
 198         connect(ircuser, SIGNAL(nickSet(QString)), this, SLOT(ircUserNickSet(QString)));
 199
 200         // connect(ircuser, SIGNAL(destroyed()), this, SLOT(ircUserDestroyed()));
 201         // If you wonder why there is no counterpart to ircUserJoined:
 202         // the joins are propagated by the ircuser. The signal ircUserJoined is only for convenience
 203
 204         newNicks << ircuser->nick();
 205         newModes << sortedModes[i];
 206         newUsers << ircuser;
 207     }
 208
 209     if (newNicks.isEmpty())
 210         return;
 211
 212     SYNC_OTHER(joinIrcUsers, ARG(newNicks), ARG(newModes));
 213     emit ircUsersJoined(newUsers);
 214 }
 215
 216
 217 void IrcChannel::joinIrcUsers(const QStringList &nicks, const QStringList &modes)
 218 {
 219     QList<IrcUser *> users;
 220     foreach(QString nick, nicks)
 221     users << network()->newIrcUser(nick);
 222     joinIrcUsers(users, modes);
 223 }
 224
 225
 226 void IrcChannel::joinIrcUser(IrcUser *ircuser)
 227 {
 228     QList<IrcUser *> users;
 229     users << ircuser;
 230     QStringList modes;
 231     modes << QString();
 232     joinIrcUsers(users, modes);
 233 }
 234
 235
 236 void IrcChannel::part(IrcUser *ircuser)
 237 {
 238     if (isKnownUser(ircuser)) {
 239         _userModes.remove(ircuser);
 240         ircuser->partChannel(this);
 241         // If you wonder why there is no counterpart to ircUserParted:
 242         // the joins are propagted by the ircuser. The signal ircUserParted is only for convenience
 243         disconnect(ircuser, 0, this, 0);
 244         emit ircUserParted(ircuser);
 245
 246         if (network()->isMe(ircuser) || _userModes.isEmpty()) {
 247             // in either case we're no longer in the channel
 248             //  -> clean up the channel and destroy it
 249             QList<IrcUser *> users = _userModes.keys();
 250             _userModes.clear();
 251             foreach(IrcUser *user, users) {
 252                 disconnect(user, 0, this, 0);
 253                 user->partChannel(this);
 254             }
 255             emit parted();
 256             network()->removeIrcChannel(this);
 257         }
 258     }
 259 }
 260
 261
 262 void IrcChannel::part(const QString &nick)
 263 {
 264     part(network()->ircUser(nick));
 265 }
 266
 267
 268 // SET USER MODE
 269 void IrcChannel::setUserModes(IrcUser *ircuser, const QString &modes)
 270 {
 271     if (isKnownUser(ircuser)) {
 272         // Keep user modes sorted
 273         _userModes[ircuser] = network()->sortPrefixModes(modes);
 274         QString nick = ircuser->nick();
 275         SYNC_OTHER(setUserModes, ARG(nick), ARG(modes))
 276         emit ircUserModesSet(ircuser, modes);
 277     }
 278 }
 279
 280
 281 void IrcChannel::setUserModes(const QString &nick, const QString &modes)
 282 {
 283     setUserModes(network()->ircUser(nick), modes);
 284 }
 285
 286
 287 // ADD USER MODE
 288 void IrcChannel::addUserMode(IrcUser *ircuser, const QString &mode)
 289 {
 290     if (!isKnownUser(ircuser) || !isValidChannelUserMode(mode))
 291         return;
 292
 293     if (!_userModes[ircuser].contains(mode)) {
 294         // Keep user modes sorted
 295         _userModes[ircuser] = network()->sortPrefixModes(_userModes[ircuser] + mode);
 296         QString nick = ircuser->nick();
 297         SYNC_OTHER(addUserMode, ARG(nick), ARG(mode))
 298         emit ircUserModeAdded(ircuser, mode);
 299     }
 300 }
 301
 302
 303 void IrcChannel::addUserMode(const QString &nick, const QString &mode)
 304 {
 305     addUserMode(network()->ircUser(nick), mode);
 306 }
 307
 308
 309 // REMOVE USER MODE
 310 void IrcChannel::removeUserMode(IrcUser *ircuser, const QString &mode)
 311 {
 312     if (!isKnownUser(ircuser) || !isValidChannelUserMode(mode))
 313         return;
 314
 315     if (_userModes[ircuser].contains(mode)) {
 316         // Removing modes shouldn't mess up ordering
 317         _userModes[ircuser].remove(mode);
 318         QString nick = ircuser->nick();
 319         SYNC_OTHER(removeUserMode, ARG(nick), ARG(mode));
 320         emit ircUserModeRemoved(ircuser, mode);
 321     }
 322 }
 323
 324
 325 void IrcChannel::removeUserMode(const QString &nick, const QString &mode)
 326 {
 327     removeUserMode(network()->ircUser(nick), mode);
 328 }
 329
 330
 331 // INIT SET USER MODES
 332 QVariantMap IrcChannel::initUserModes() const
 333 {
 334     QVariantMap usermodes;
 335     QHash<IrcUser *, QString>::const_iterator iter = _userModes.constBegin();
 336     while (iter != _userModes.constEnd()) {
 337         usermodes[iter.key()->nick()] = iter.value();
 338         ++iter;
 339     }
 340     return usermodes;
 341 }
 342
 343
 344 void IrcChannel::initSetUserModes(const QVariantMap &usermodes)
 345 {
 346     QList<IrcUser *> users;
 347     QStringList modes;
 348     QVariantMap::const_iterator iter = usermodes.constBegin();
 349     while (iter != usermodes.constEnd()) {
 350         users << network()->newIrcUser(iter.key());
 351         modes << iter.value().toString();
 352         ++iter;
 353     }
 354     // joinIrcUsers handles sorting modes
 355     joinIrcUsers(users, modes);
 356 }
 357
 358
 359 QVariantMap IrcChannel::initChanModes() const
 360 {
 361     QVariantMap channelModes;
 362
 363     QVariantMap A_modes;
 364     QHash<QChar, QStringList>::const_iterator A_iter = _A_channelModes.constBegin();
 365     while (A_iter != _A_channelModes.constEnd()) {
 366         A_modes[A_iter.key()] = A_iter.value();
 367         ++A_iter;
 368     }
 369     channelModes["A"] = A_modes;
 370
 371     QVariantMap B_modes;
 372     QHash<QChar, QString>::const_iterator B_iter = _B_channelModes.constBegin();
 373     while (B_iter != _B_channelModes.constEnd()) {
 374         B_modes[B_iter.key()] = B_iter.value();
 375         ++B_iter;
 376     }
 377     channelModes["B"] = B_modes;
 378
 379     QVariantMap C_modes;
 380     QHash<QChar, QString>::const_iterator C_iter = _C_channelModes.constBegin();
 381     while (C_iter != _C_channelModes.constEnd()) {
 382         C_modes[C_iter.key()] = C_iter.value();
 383         ++C_iter;
 384     }
 385     channelModes["C"] = C_modes;
 386
 387     QString D_modes;
 388     QSet<QChar>::const_iterator D_iter = _D_channelModes.constBegin();
 389     while (D_iter != _D_channelModes.constEnd()) {
 390         D_modes += *D_iter;
 391         ++D_iter;
 392     }
 393     channelModes["D"] = D_modes;
 394
 395     return channelModes;
 396 }
 397
 398
 399 void IrcChannel::initSetChanModes(const QVariantMap &channelModes)
 400 {
 401     QVariantMap::const_iterator iter = channelModes["A"].toMap().constBegin();
 402     QVariantMap::const_iterator iterEnd = channelModes["A"].toMap().constEnd();
 403     while (iter != iterEnd) {
 404         _A_channelModes[iter.key()[0]] = iter.value().toStringList();
 405         ++iter;
 406     }
 407
 408     iter = channelModes["B"].toMap().constBegin();
 409     iterEnd = channelModes["B"].toMap().constEnd();
 410     while (iter != iterEnd) {
 411         _B_channelModes[iter.key()[0]] = iter.value().toString();
 412         ++iter;
 413     }
 414
 415     iter = channelModes["C"].toMap().constBegin();
 416     iterEnd = channelModes["C"].toMap().constEnd();
 417     while (iter != iterEnd) {
 418         _C_channelModes[iter.key()[0]] = iter.value().toString();
 419         ++iter;
 420     }
 421
 422     QString D_modes = channelModes["D"].toString();
 423     for (int i = 0; i < D_modes.count(); i++) {
 424         _D_channelModes << D_modes[i];
 425     }
 426 }
 427
 428
 429 void IrcChannel::ircUserDestroyed()
 430 {
 431     IrcUser *ircUser = static_cast<IrcUser *>(sender());
 432     Q_ASSERT(ircUser);
 433     _userModes.remove(ircUser);
 434     // no further propagation.
 435     // this leads only to fuck ups.
 436 }
 437
 438
 439 void IrcChannel::ircUserNickSet(QString nick)
 440 {
 441     IrcUser *ircUser = qobject_cast<IrcUser *>(sender());
 442     Q_ASSERT(ircUser);
 443     emit ircUserNickSet(ircUser, nick);
 444 }
 445
 446
 447 /*******************************************************************************
 448  *
 449  * 3.3 CHANMODES
 450  *
 451  *    o  CHANMODES=A,B,C,D
 452  *
 453  *    The CHANMODES token specifies the modes that may be set on a channel.
 454  *    These modes are split into four categories, as follows:
 455  *
 456  *    o  Type A: Modes that add or remove an address to or from a list.
 457  *       These modes always take a parameter when sent by the server to a
 458  *       client; when sent by a client, they may be specified without a
 459  *       parameter, which requests the server to display the current
 460  *       contents of the corresponding list on the channel to the client.
 461  *    o  Type B: Modes that change a setting on the channel.  These modes
 462  *       always take a parameter.
 463  *    o  Type C: Modes that change a setting on the channel. These modes
 464  *       take a parameter only when set; the parameter is absent when the
 465  *       mode is removed both in the client's and server's MODE command.
 466  *    o  Type D: Modes that change a setting on the channel. These modes
 467  *       never take a parameter.
 468  *
 469  *    If the server sends any additional types after these 4, the client
 470  *    MUST ignore them; this is intended to allow future extension of this
 471  *    token.
 472  *
 473  *    The IRC server MUST NOT list modes in CHANMODES which are also
 474  *    present in the PREFIX parameter; however, for completeness, modes
 475  *    described in PREFIX may be treated as type B modes.
 476  *
 477  ******************************************************************************/
 478
 479 /*******************************************************************************
 480  * Short Version:
 481  * A --> add/remove from List
 482  * B --> set value or remove
 483  * C --> set value or remove
 484  * D --> on/off
 485  *
 486  * B and C behave very similar... we store the data in different datastructures
 487  * for future compatibility
 488  ******************************************************************************/
 489
 490 // NOTE: the behavior of addChannelMode and removeChannelMode depends on the type of mode
 491 // see list above for chanmode types
 492 void IrcChannel::addChannelMode(const QChar &mode, const QString &value)
 493 {
 494     Network::ChannelModeType modeType = network()->channelModeType(mode);
 495
 496     switch (modeType) {
 497     case Network::NOT_A_CHANMODE:
 498         return;
 499     case Network::A_CHANMODE:
 500         if (!_A_channelModes.contains(mode))
 501             _A_channelModes[mode] = QStringList(value);
 502         else if (!_A_channelModes[mode].contains(value))
 503             _A_channelModes[mode] << value;
 504         break;
 505
 506     case Network::B_CHANMODE:
 507         _B_channelModes[mode] = value;
 508         break;
 509
 510     case Network::C_CHANMODE:
 511         _C_channelModes[mode] = value;
 512         break;
 513
 514     case Network::D_CHANMODE:
 515         _D_channelModes << mode;
 516         break;
 517     }
 518     SYNC(ARG(mode), ARG(value))
 519 }
 520
 521
 522 void IrcChannel::removeChannelMode(const QChar &mode, const QString &value)
 523 {
 524     Network::ChannelModeType modeType = network()->channelModeType(mode);
 525
 526     switch (modeType) {
 527     case Network::NOT_A_CHANMODE:
 528         return;
 529     case Network::A_CHANMODE:
 530         if (_A_channelModes.contains(mode))
 531             _A_channelModes[mode].removeAll(value);
 532         break;
 533
 534     case Network::B_CHANMODE:
 535         _B_channelModes.remove(mode);
 536         break;
 537
 538     case Network::C_CHANMODE:
 539         _C_channelModes.remove(mode);
 540         break;
 541
 542     case Network::D_CHANMODE:
 543         _D_channelModes.remove(mode);
 544         break;
 545     }
 546     SYNC(ARG(mode), ARG(value))
 547 }
 548
 549
 550 bool IrcChannel::hasMode(const QChar &mode) const
 551 {
 552     Network::ChannelModeType modeType = network()->channelModeType(mode);
 553
 554     switch (modeType) {
 555     case Network::NOT_A_CHANMODE:
 556         return false;
 557     case Network::A_CHANMODE:
 558         return _A_channelModes.contains(mode);
 559     case Network::B_CHANMODE:
 560         return _B_channelModes.contains(mode);
 561     case Network::C_CHANMODE:
 562         return _C_channelModes.contains(mode);
 563     case Network::D_CHANMODE:
 564         return _D_channelModes.contains(mode);
 565     }
 566     return false;
 567 }
 568
 569
 570 QString IrcChannel::modeValue(const QChar &mode) const
 571 {
 572     Network::ChannelModeType modeType = network()->channelModeType(mode);
 573
 574     switch (modeType) {
 575     case Network::B_CHANMODE:
 576         if (_B_channelModes.contains(mode))
 577             return _B_channelModes[mode];
 578         else
 579             return QString();
 580     case Network::C_CHANMODE:
 581         if (_C_channelModes.contains(mode))
 582             return _C_channelModes[mode];
 583         else
 584             return QString();
 585     default:
 586         return QString();
 587     }
 588 }
 589
 590
 591 QStringList IrcChannel::modeValueList(const QChar &mode) const
 592 {
 593     Network::ChannelModeType modeType = network()->channelModeType(mode);
 594
 595     switch (modeType) {
 596     case Network::A_CHANMODE:
 597         if (_A_channelModes.contains(mode))
 598             return _A_channelModes[mode];
 599         break;
 600     default:
 601         ;
 602     }
 603     return {};
 604 }
 605
 606
 607 QString IrcChannel::channelModeString() const
 608 {
 609     QStringList params;
 610     QString modeString;
 611
 612     QSet<QChar>::const_iterator D_iter = _D_channelModes.constBegin();
 613     while (D_iter != _D_channelModes.constEnd()) {
 614         modeString += *D_iter;
 615         ++D_iter;
 616     }
 617
 618     QHash<QChar, QString>::const_iterator BC_iter = _C_channelModes.constBegin();
 619     while (BC_iter != _C_channelModes.constEnd()) {
 620         modeString += BC_iter.key();
 621         params << BC_iter.value();
 622         ++BC_iter;
 623     }
 624
 625     BC_iter = _B_channelModes.constBegin();
 626     while (BC_iter != _B_channelModes.constEnd()) {
 627         modeString += BC_iter.key();
 628         params << BC_iter.value();
 629         ++BC_iter;
 630     }
 631     if (modeString.isEmpty())
 632         return modeString;
 633     else
 634         return QString("+%1 %2").arg(modeString).arg(params.join(" "));
 635 }