Chan.h

Go to the documentation of this file.

/*
 * Copyright (C) 2004-2024 ZNC, see the NOTICE file for details.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef ZNC_CHAN_H
#define ZNC_CHAN_H

#include <znc/zncconfig.h>
#include <znc/Nick.h>
#include <znc/ZNCString.h>
#include <znc/Buffer.h>
#include <znc/Translation.h>
#include <map>

// Forward Declarations
class CUser;
class CIRCNetwork;
class CClient;
class CConfig;
class CFile;
// !Forward Declarations

class CChan : private CCoreTranslationMixin {
  public:
    typedef enum {
        Voice = '+',
        HalfOp = '%',
        Op = '@',
        Admin = '!',
        Owner = '*'
    } EUserPerms;

    typedef enum {
        M_Private = 'p',
        M_Secret = 's',
        M_Moderated = 'm',
        M_InviteOnly = 'i',
        M_NoMessages = 'n',
        M_OpTopic = 't',
        M_Limit = 'l',
        M_Key = 'k',
        M_Op = 'o',
        M_Voice = 'v',
        M_Ban = 'b',
        M_Except = 'e'
    } EModes;

    CChan(const CString& sName, CIRCNetwork* pNetwork, bool bInConfig,
          CConfig* pConfig = nullptr);
    ~CChan();

    CChan(const CChan&) = delete;
    CChan& operator=(const CChan&) = delete;

    void Reset();
    CConfig ToConfig() const;
    void Clone(CChan& chan);
    void Cycle() const;
    void JoinUser(const CString& sKey = "");
    void AttachUser(CClient* pClient = nullptr);
    void DetachUser();

    void OnWho(const CString& sNick, const CString& sIdent,
               const CString& sHost);

    // Modes
    void SetModes(const CString& s);
    void SetModes(const CString& sModes, const VCString& vsModeParams);
    void ModeChange(const CString& sModes, const CNick* OpNick = nullptr);
    void ModeChange(const CString& sModes,const VCString& vsModeParams, const CNick* OpNick = nullptr);
    bool AddMode(char cMode, const CString& sArg);
    bool RemMode(char cMode);
    CString GetModeString() const;
    CString GetModeArg(CString& sArgs) const;
    CString GetModeForNames() const;
    // !Modes

    // Nicks
    void ClearNicks();
    const CNick* FindNick(const CString& sNick) const;
    CNick* FindNick(const CString& sNick);
    int AddNicks(const CString& sNicks);
    bool AddNick(const CString& sNick);
    bool RemNick(const CString& sNick);
    bool ChangeNick(const CString& sOldNick, const CString& sNewNick);
    // !Nicks

    // Buffer
    const CBuffer& GetBuffer() const { return m_Buffer; }
    unsigned int GetBufferCount() const { return m_Buffer.GetLineCount(); }
    bool SetBufferCount(unsigned int u, bool bForce = false) {
        m_bHasBufferCountSet = true;
        return m_Buffer.SetLineCount(u, bForce);
    }
    void InheritBufferCount(unsigned int u, bool bForce = false) {
        if (!m_bHasBufferCountSet) m_Buffer.SetLineCount(u, bForce);
    }
    void ResetBufferCount();
    size_t AddBuffer(const CMessage& Format, const CString& sText = "") {
        return m_Buffer.AddLine(Format, sText);
    }
    size_t AddBuffer(const CString& sFormat, const CString& sText = "",
                     const timeval* ts = nullptr,
                     const MCString& mssTags = MCString::EmptyMap) {
        return m_Buffer.AddLine(sFormat, sText, ts, mssTags);
    }
    void ClearBuffer() { m_Buffer.Clear(); }
    void SendBuffer(CClient* pClient);
    void SendBuffer(CClient* pClient, const CBuffer& Buffer);
    // !Buffer

    // m_Nick wrappers
    CString GetPermStr() const { return m_Nick.GetPermStr(); }
    bool HasPerm(char cPerm) const { return m_Nick.HasPerm(cPerm); }
    bool AddPerm(char cPerm) { return m_Nick.AddPerm(cPerm); }
    bool RemPerm(char cPerm) { return m_Nick.RemPerm(cPerm); }
    // !wrappers

    // Setters
    void SetModeKnown(bool b) { m_bModeKnown = b; }
    void SetIsOn(bool b) {
        m_bIsOn = b;
        if (!b) {
            Reset();
        }
    }
    void SetKey(const CString& s);
    void SetTopic(const CString& s) { m_sTopic = s; }
    void SetTopicOwner(const CString& s) { m_sTopicOwner = s; }
    void SetTopicDate(unsigned long u) { m_ulTopicDate = u; }
    void SetDefaultModes(const CString& s) { m_sDefaultModes = s; }
    void SetAutoClearChanBuffer(bool b);
    void InheritAutoClearChanBuffer(bool b);
    void ResetAutoClearChanBuffer();
    void SetDetached(bool b = true) { m_bDetached = b; }
    void SetInConfig(bool b);
    void SetCreationDate(unsigned long u) { m_ulCreationDate = u; }
    void Disable() { m_bDisabled = true; }
    void Enable();
    void IncJoinTries() { m_uJoinTries++; }
    void ResetJoinTries() { m_uJoinTries = 0; }
    // !Setters

    // Getters
    CIRCNetwork* GetNetwork() const { return m_pNetwork; }
    bool IsModeKnown() const { return m_bModeKnown; }
    bool HasMode(char cMode) const;
    CString GetOptions() const;
    CString GetModeArg(char cMode) const;
    std::map<char, unsigned int> GetPermCounts() const;
    bool IsOn() const { return m_bIsOn; }
    const CString& GetName() const { return m_sName; }
    const std::map<char, CString>& GetModes() const {
        return m_mcsModes;
    }
    const CString& GetKey() const { return m_sKey; }
    const CString& GetTopic() const { return m_sTopic; }
    const CString& GetTopicOwner() const { return m_sTopicOwner; }
    unsigned long GetTopicDate() const { return m_ulTopicDate; }
    const CString& GetDefaultModes() const { return m_sDefaultModes; }
    const std::map<CString, CNick>& GetNicks() const { return m_msNicks; }
    size_t GetNickCount() const { return m_msNicks.size(); }
    bool AutoClearChanBuffer() const { return m_bAutoClearChanBuffer; }
    bool IsDetached() const { return m_bDetached; }
    bool InConfig() const { return m_bInConfig; }
    unsigned long GetCreationDate() const { return m_ulCreationDate; }
    bool IsDisabled() const { return m_bDisabled; }
    unsigned int GetJoinTries() const { return m_uJoinTries; }
    bool HasBufferCountSet() const { return m_bHasBufferCountSet; }
    bool HasAutoClearChanBufferSet() const {
        return m_bHasAutoClearChanBufferSet;
    }
    // !Getters
  private:
  protected:
    bool m_bDetached;
    bool m_bIsOn;
    bool m_bAutoClearChanBuffer;
    bool m_bInConfig;
    bool m_bDisabled;
    bool m_bHasBufferCountSet;
    bool m_bHasAutoClearChanBufferSet;
    CString m_sName;
    CString m_sKey;
    CString m_sTopic;
    CString m_sTopicOwner;
    unsigned long m_ulTopicDate;
    unsigned long m_ulCreationDate;
    CIRCNetwork* m_pNetwork;
    CNick m_Nick;
    unsigned int m_uJoinTries;
    CString m_sDefaultModes;
    std::map<CString, CNick> m_msNicks;  // Todo: make this caseless (irc style)
    CBuffer m_Buffer;

    bool m_bModeKnown;
    std::map<char, CString> m_mcsModes;
};

#endif  // !ZNC_CHAN_H