File: clearbufferonmsg.cpp

package info (click to toggle)
znc 1.10.1-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 12,164 kB
  • sloc: cpp: 58,072; javascript: 11,859; python: 1,635; perl: 1,229; tcl: 219; sh: 200; ansic: 187; makefile: 82
file content (161 lines) | stat: -rw-r--r-- 4,684 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
/*
 * Copyright (C) 2004-2025 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.
 */

#include <znc/IRCNetwork.h>
#include <znc/User.h>
#include <znc/Chan.h>
#include <znc/Query.h>

using std::vector;

enum {
    RULE_MSG,
    RULE_CTCP,
    RULE_ACTION,
    RULE_NOTICE,
    RULE_PART,
    RULE_TOPIC,
    RULE_QUIT,
    RULE_MAX,
};

class CClearBufferOnMsgMod : public CModule {
  public:
    MODCONSTRUCTOR(CClearBufferOnMsgMod) {
        SetAllRules(true);
        // false for backward compatibility
        m_bRules[RULE_QUIT] = false;
    }

    void ClearAllBuffers() {
        CIRCNetwork* pNetwork = GetNetwork();

        if (pNetwork) {
            const vector<CChan*>& vChans = pNetwork->GetChans();

            for (CChan* pChan : vChans) {
                // Skip detached channels, they weren't read yet
                if (pChan->IsDetached()) continue;

                pChan->ClearBuffer();
                // We deny AutoClearChanBuffer on all channels since this module
                // doesn't make any sense with it
                pChan->SetAutoClearChanBuffer(false);
            }

            vector<CQuery*> VQueries = pNetwork->GetQueries();

            for (CQuery* pQuery : VQueries) {
                pNetwork->DelQuery(pQuery->GetName());
            }

            // We deny AutoClearQueryBuffer since this module
            // doesn't make any sense with it
            GetUser()->SetAutoClearQueryBuffer(false);
        }
    }

    EModRet OnUserMsg(CString& sTarget, CString& sMessage) override {
        if (m_bRules[RULE_MSG]) ClearAllBuffers();
        return CONTINUE;
    }

    EModRet OnUserCTCP(CString& sTarget, CString& sMessage) override {
        if (m_bRules[RULE_CTCP]) ClearAllBuffers();
        return CONTINUE;
    }

    EModRet OnUserAction(CString& sTarget, CString& sMessage) override {
        if (m_bRules[RULE_ACTION]) ClearAllBuffers();
        return CONTINUE;
    }

    EModRet OnUserNotice(CString& sTarget, CString& sMessage) override {
        if (m_bRules[RULE_NOTICE]) ClearAllBuffers();
        return CONTINUE;
    }

    EModRet OnUserPart(CString& sChannel, CString& sMessage) override {
        if (m_bRules[RULE_PART]) ClearAllBuffers();
        return CONTINUE;
    }

    EModRet OnUserTopic(CString& sChannel, CString& sTopic) override {
        if (m_bRules[RULE_TOPIC]) ClearAllBuffers();
        return CONTINUE;
    }

    EModRet OnUserQuit(CString& sMessage) override {
        if (m_bRules[RULE_QUIT]) ClearAllBuffers();
        return CONTINUE;
    }

    void SetAllRules(bool bVal) {
        for (int i = 0; i < RULE_MAX; i++) m_bRules[i] = bVal;
    }

    void SetRule(const CString& sOpt, bool bVal) {
        static const struct {
            CString sName;
            int Index;
        } Names[RULE_MAX] = {
              {"msg", RULE_MSG},
              {"ctcp", RULE_CTCP},
              {"action", RULE_ACTION},
              {"notice", RULE_NOTICE},
              {"part", RULE_PART},
              {"topic", RULE_TOPIC},
              {"quit", RULE_QUIT},
          };

        if (sOpt.Equals("all")) {
            SetAllRules(bVal);
        } else {
            for (int i = 0; i < RULE_MAX; i++) {
                if (sOpt.Equals(Names[i].sName))
                    m_bRules[Names[i].Index] = bVal;
            }
        }
    }

    bool OnLoad(const CString& sArgs, CString& sMessage) override {
        VCString vsOpts;

        sArgs.Split(" ", vsOpts, false);

        for (CString& sOpt : vsOpts) {
            if (sOpt.StartsWith("!"))
                SetRule(sOpt.substr(1), false);
            else if (!sOpt.empty())
                SetRule(sOpt, true);
        }

        return true;
    }

  private:
    bool m_bRules[RULE_MAX];
};

template <>
void TModInfo<CClearBufferOnMsgMod>(CModInfo& Info) {
    Info.SetWikiPage("clearbufferonmsg");
    Info.SetHasArgs(true);
    Info.SetArgsHelpText("[ [!]<msg|ctcp|action|notice|part|topic|quit|all> ]");
}

USERMODULEDEFS(CClearBufferOnMsgMod, t_s("Clears all channel and query buffers "
                                         "whenever the user does something"))