summaryrefslogtreecommitdiff
path: root/src/modules/extra/m_filter_pcre.cpp
blob: ff87d7e8add1fd3b15f9902d8b9787eb2ecd5e72 (plain)
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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
/*       +------------------------------------+
 *       | Inspire Internet Relay Chat Daemon |
 *       +------------------------------------+
 *
 *  InspIRCd is copyright (C) 2002-2004 ChatSpike-Dev.
 *                       E-mail:
 *                <brain@chatspike.net>
 *           	  <Craig@chatspike.net>
 *     
 * Written by Craig Edwards, Craig McLure, and others.
 * This program is free but copyrighted software; see
 *            the file COPYING for details.
 *
 * ---------------------------------------------------
 */

using namespace std;

// Message and notice filtering using regex patterns
// a module based on the original work done by Craig Edwards in 2003
// for the chatspike network.

#include <stdio.h>
#include <string>
#include <pcre.h>
#include "users.h"
#include "channels.h"
#include "modules.h"
#include "helperfuncs.h"

class FilterPCREException : public ModuleException
{
 public:
	virtual char* GetReason()
	{
		return "Could not find <filter file=\"\"> definition in your config file!";
	}
};

/* $ModDesc: m_filter with regexps */
/* $CompileFlags: -I/usr/local/include */
/* $LinkerFlags: -L/usr/local/lib -lpcre */

class ModuleFilterPCRE : public Module
{
	Server *Srv;
	ConfigReader *Conf, *MyConf;
	std::vector<pcre*> filters;
	pcre *re;
	const char *error;
	int erroffset;
 
 public:
	ModuleFilterPCRE(Server* Me)
		: Module::Module(Me)
	{
		// read the configuration file on startup.
		// it is perfectly valid to set <filter file> to the value of the
		// main config file, then append your <keyword> tags to the bottom
		// of the main config... but rather messy. That's why the capability
		// of using a seperate config file is provided.
		Srv = Me;
		Conf = new ConfigReader;
		std::string filterfile = Conf->ReadValue("filter","file",0);
		MyConf = new ConfigReader(filterfile);
		if ((filterfile == "") || (!MyConf->Verify()))
		{
			FilterPCREException e;
			throw(e);
		}
		Srv->Log(DEFAULT,std::string("m_filter_pcre: read configuration from ")+filterfile);

		filters.clear();
		for (int index = 0; index < MyConf->Enumerate("keyword"); index++)
		{
			std::string pattern = MyConf->ReadValue("keyword","pattern",index);
			re = pcre_compile(pattern.c_str(),0,&error,&erroffset,NULL);
			if (!re)
			{
				log(DEFAULT,"Error in regular expression: %s at offset %d: %s\n", pattern.c_str(), erroffset, error);
				log(DEFAULT,"Regular expression %s not loaded.", pattern.c_str());
			}
			else
			{
				filters.push_back(re);
				log(DEFAULT,"Regular expression %s loaded.", pattern.c_str());
			}
		}

	}
	
	virtual ~ModuleFilterPCRE()
	{
		delete MyConf;
		delete Conf;
	}

        void Implements(char* List)
        {
                List[I_OnUserPreMessage] = List[I_OnUserPreNotice] = List[I_OnRehash] = 1;
        }

	// format of a config entry is <keyword pattern="^regexp$" reason="Some reason here" action="kill/block">
	
	virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text, char status)
	{
		return OnUserPreNotice(user,dest,target_type,text,status);
	}
	
	virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text, char status)
	{
		for (unsigned int index = 0; index < filters.size(); index++)
		{
			if (pcre_exec(filters[index],NULL,text.c_str(),text.length(),0,0,NULL,0) > -1)
			{
				std::string target = "";
				std::string reason = MyConf->ReadValue("keyword","reason",index);
				std::string do_action = MyConf->ReadValue("keyword","action",index);

				if (do_action == "")
					do_action = "none";
					
				if (target_type == TYPE_USER)
				{
					userrec* t = (userrec*)dest;
					target = std::string(t->nick);
				}
				else if (target_type == TYPE_CHANNEL)
				{
					chanrec* t = (chanrec*)dest;
					target = std::string(t->name);
				}
				if (do_action == "block")
	      			{	
					Srv->SendOpers(std::string("Filter: ")+std::string(user->nick)+
    							std::string(" had their notice filtered, target was ")+
    							target+": "+reason);
					Srv->SendTo(NULL,user,"NOTICE "+std::string(user->nick)+
    							" :Your notice has been filtered and opers notified: "+reason);
    				}
				Srv->Log(DEFAULT,std::string("Filter: ")+std::string(user->nick)+
    						std::string(" had their notice filtered, target was ")+
    						target+": "+reason+" Action: "+do_action);

				if (do_action == "kill")
				{
					Srv->QuitUser(user,reason);
				}
				return 1;
			}
		}
		return 0;
	}
	
	virtual void OnRehash(const std::string &parameter)
	{
		// reload our config file on rehash - we must destroy and re-allocate the classes
		// to call the constructor again and re-read our data.
		delete Conf;
		delete MyConf;
		Conf = new ConfigReader;
		std::string filterfile = Conf->ReadValue("filter","file",0);
		// this automatically re-reads the configuration file into the class
		MyConf = new ConfigReader(filterfile);
		if ((filterfile == "") || (!MyConf->Verify()))
		{
			FilterPCREException e;
			// bail if the user forgot to create a config file
			throw(e);
		}
		Srv->Log(DEFAULT,std::string("m_filter_pcre: read configuration from ")+filterfile);

                filters.clear();
                for (int index = 0; index < MyConf->Enumerate("keyword"); index++)
                {
                        std::string pattern = MyConf->ReadValue("keyword","pattern",index);
                        re = pcre_compile(pattern.c_str(),0,&error,&erroffset,NULL);
                        if (!re)
                        {
                                log(DEFAULT,"Error in regular expression: %s at offset %d: %s\n", pattern.c_str(), erroffset, error);
                                log(DEFAULT,"Regular expression %s not loaded.", pattern.c_str());
                        }
                        else
                        {
                                filters.push_back(re);
                                log(DEFAULT,"Regular expression %s loaded.", pattern.c_str());
                        }
                }

	}
	
	virtual Version GetVersion()
	{
		// This is version 2 because version 1.x is the unreleased unrealircd module
		return Version(3,0,0,0,VF_VENDOR);
	}
	
};

// stuff down here is the module-factory stuff. For basic modules you can ignore this.

class ModuleFilterPCREFactory : public ModuleFactory
{
 public:
	ModuleFilterPCREFactory()
	{
	}
	
	~ModuleFilterPCREFactory()
	{
	}
	
	virtual Module * CreateModule(Server* Me)
	{
		return new ModuleFilterPCRE(Me);
	}
	
};


extern "C" void * init_module( void )
{
	return new ModuleFilterPCREFactory;
}