summaryrefslogtreecommitdiff
path: root/src/modules/m_park.cpp
blob: 716c91579f5e94268f328a8c92048030389e2ce6 (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
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
/*       +------------------------------------+
 *       | Inspire Internet Relay Chat Daemon |
 *       +------------------------------------+
 *
 *  Inspire 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;

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

/* $ModDesc: Provides support for user parking/unparking */

class awaymsg
{
 public:
	std::string from;
	std::string text;
	time_t tm;
};

class parkedinfo
{
 public:
	std::string nick;
	std::string host;
	time_t parktime;
};

Server *Srv;
typedef std::vector<awaymsg> awaylog;
typedef std::vector<parkedinfo> parkinfo;
parkinfo pinfo;
long ParkMaxTime;
long ConcurrentParks;
long ParkMaxMsgs;
parkedinfo pi;

void handle_park(char **parameters, int pcnt, userrec *user)
{
	/** Parking. easy stuff.
	 *
	 * We duplicate and switch the users file descriptor, so that they can remain forever as a 'ghost'
	 * We then disconnect the real user leaving a controlled ghost in their place :)
	 */
	int othersessions = 0;
	if (pinfo.size())
	        for (parkinfo::iterator j = pinfo.begin(); j != pinfo.end(); j++)
			if (j->host == std::string(user->host))
				othersessions++;
	if (othersessions >= ConcurrentParks)
	{
		Srv->SendServ(user->fd,"927 "+std::string(user->nick)+" :You are already parked up to the maximum number of allowed times.");
	}
	else
	{
		awaylog* aw;
		char msg[MAXBUF];
		unsigned long key = abs(random() * 12345);
		snprintf(msg,MAXBUF,"You are now parked. To unpark use /UNPARK %s %lu",user->nick,key);
		Srv->UserToPseudo(user,std::string(msg));
		aw = new awaylog;
		user->Extend("park_awaylog",(char*)aw);
		user->Extend("park_key",(char*)key);
		pi.nick = user->nick;
		pi.host = user->host;
		pi.parktime = time(NULL);
		pinfo.push_back(pi);
	}
}

void handle_parkstats(char **parameters, int pcnt, userrec *user)
{
	char status[MAXBUF];
	snprintf(status,MAXBUF,"NOTICE %s :There are a total of %lu parked clients on this server, with a maximum of %lu parked sessions allowed per user.",user->nick,(unsigned long)pinfo.size(),(unsigned long)ConcurrentParks);
	Srv->SendServ(user->fd,status);
}

void handle_unpark(char **parameters, int pcnt, userrec *user)
{
	/** Unparking. complicated stuff.
	 *
	 * Unparking is done in several steps:
	 *
	 * (1) Check if the user is parked
	 * (2) Check the key of the user against the one provided
	 * (3) Part the user who issued the command from all of their channels so as not to confuse clients
	 * (4) Remove all the users UMODEs
	 * (5) Duplicate and switch file descriptors on the two users, and disconnect the dead one
	 * (6) Force a nickchange onto the user who issued the command forcing them to change to the parked nick
	 * (7) Force join the user into all the channels the parked nick is currently in (send them localized join and namelist)
	 * (8) Send the user the umodes of their new 'persona'
	 * (9) Spool any awaylog messages to the user
	 *
	 * And there you have it, easy huh (NOT)...
	 */
	userrec* unpark = Srv->FindNick(std::string(parameters[0]));
	if (!unpark)
	{
		WriteServ(user->fd,"942 %s %s :Invalid user specified.",user->nick, parameters[0]);
		return;
	}
	awaylog* awy = (awaylog*)unpark->GetExt("park_awaylog");
	long key = (long)unpark->GetExt("park_key");
	if (!awy)
	{
		WriteServ(user->fd,"943 %s %s :This user is not parked.",user->nick, unpark->nick);
		return;
	}
	if (key == atoi(parameters[1]))
	{
		// first part the user from all chans theyre on, so things dont get messy
	        for (int i = 0; i != MAXCHANS; i++)
	        {
	                if (user->chans[i].channel != NULL)
	                {
	                        if (user->chans[i].channel->name)
	                        {
					Srv->PartUserFromChannel(user,user->chans[i].channel->name,"Unparking");
				}
			}
		}
		// remove all their old modes
		WriteServ(user->fd,"MODE %s -%s",user->nick,user->modes);
		// now, map them to the parked user, while nobody can see :p
		Srv->PseudoToUser(user,unpark,"Unparked to "+std::string(parameters[0]));
		// set all their new modes
		WriteServ(unpark->fd,"MODE %s +%s",unpark->nick,unpark->modes);
		// spool their away log to them
		WriteServ(unpark->fd,"NOTICE %s :*** You are now unparked. You have successfully taken back the nickname and privilages of %s.",unpark->nick,unpark->nick);
		for (awaylog::iterator i = awy->begin(); i != awy->end(); i++)
		{
			char timebuf[MAXBUF];
			tm *timeinfo = localtime(&i->tm);
			strlcpy(timebuf,asctime(timeinfo),MAXBUF);
			timebuf[strlen(timebuf)-1] = '\0';
			WriteServ(unpark->fd,"NOTICE %s :From %s at %s: \2%s\2",unpark->nick,i->from.c_str(),timebuf,i->text.c_str());
		}
		delete awy;
		unpark->Shrink("park_awaylog");
		unpark->Shrink("park_key");
		for (parkinfo::iterator j = pinfo.begin(); j != pinfo.end(); j++)
		{
			if (j->nick == std::string(unpark->nick))
			{
				pinfo.erase(j);
				break;
			}
		}
	}
	else
	{
		Srv->SendServ(user->fd,"928 "+std::string(user->nick)+" :Incorrect park key.");
	}
}


class ModulePark : public Module
{
 protected:
	ConfigReader* Conf;
 public:
	virtual void ReadSettings()
	{
		Conf = new ConfigReader;
		ParkMaxTime = Conf->ReadInteger("park","maxtime",0,true);
		ConcurrentParks = Conf->ReadInteger("park","maxperip",0,true);
		ParkMaxMsgs = Conf->ReadInteger("park","maxmessages",0,true);
		delete Conf;
	}

	ModulePark(Server* Me)
		: Module::Module(Me)
	{
		Srv = Me;
		pinfo.clear();
		this->ReadSettings();
		Srv->AddCommand("PARK",handle_park,0,0,"m_park.so");
		Srv->AddCommand("UNPARK",handle_unpark,0,2,"m_park.so");
		Srv->AddCommand("PARKSTATS",handle_parkstats,'o',0,"m_park.so");
	}
	
	virtual ~ModulePark()
	{
	}

	virtual void OnRehash(std::string parameter)
	{
		this->ReadSettings();
	}

        virtual void On005Numeric(std::string &output)
        {
                output = output + std::string(" PARK");
        }

        virtual void OnUserQuit(userrec* user, std::string reason)
        {
                std::string nick = user->nick;
                // track quits in our parked user list
                for (parkinfo::iterator j = pinfo.begin(); j != pinfo.end(); j++)
                {
                        if (j->nick == nick)
                        {
                                pinfo.erase(j);
                                break;
                        }
                }
        }


	virtual void OnPrePrivmsg(userrec* user, userrec* dest, std::string text)
	{
		awaylog* awy = (awaylog*)dest->GetExt("park_awaylog");
		if (awy)
		{
			if (awy->size() <= (unsigned)ParkMaxMsgs)
			{
				awaymsg am;
				am.text = text;
				am.from = user->GetFullHost();
				am.tm = time(NULL);
				awy->push_back(am);
				Srv->SendServ(user->fd,"930 "+std::string(user->nick)+" :User "+std::string(dest->nick)+" is parked. Your message has been stored.");
			}
			else Srv->SendServ(user->fd,"929 "+std::string(user->nick)+" :User "+std::string(dest->nick)+" is parked, but their message queue is full. Message not saved.");
		}
	}

	virtual int OnUserPreNick(userrec* user, std::string newnick)
	{
		// track nickchanges in our parked user list
		// (this isnt too efficient, i'll tidy it up some time)
                for (parkinfo::iterator j = pinfo.begin(); j != pinfo.end(); j++)
                {
                        if (j->nick == std::string(user->nick))
                        {
                                j->nick = newnick;
                                break;
                        }
                }
		return 0;
	}

	virtual void OnBackgroundTimer(time_t curtime)
	{
	        // look for parked clients which have timed out (this needs tidying)
	        if (pinfo.empty())
	                return;
        	bool go_again = true;
	        while (go_again)
	        {
	                go_again = false;
	                for (parkinfo::iterator j = pinfo.begin(); j != pinfo.end(); j++)
	                {
	                        if (time(NULL) >= (j->parktime+ParkMaxTime))
	                        {
	                                userrec* thisnick = Srv->FindNick(j->nick);
					// THIS MUST COME BEFORE THE QuitUser - QuitUser can
					// create a recursive call to OnUserQuit in this module
					// and then corrupt the pointer!
					pinfo.erase(j);
	                                if (thisnick)
	                                        Srv->QuitUser(thisnick,"PARK timeout");
	                                go_again = true;
	                                break;
	                        }
	                }
	        }
	}

	virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text)
	{
		if (target_type == TYPE_USER)
		{
			userrec* u = (userrec*)dest;
			OnPrePrivmsg(user,u,text);
		}
		return 0;
	}

        virtual void OnWhois(userrec* src, userrec* dst)
        {
		if (dst->GetExt("park_awaylog"))
	                Srv->SendTo(NULL,src,"335 "+std::string(src->nick)+" "+std::string(dst->nick)+" :is a parked client");
        }
	
	virtual Version GetVersion()
	{
		return Version(1,0,0,1,VF_VENDOR);
	}
	
};

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

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


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