1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://www.inspircd.org/wiki/index.php/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
17 /* $ModDesc: Povides support for ircu-style services accounts, including chmode +R, etc. */
19 /** Channel mode +r - mark a channel as identified
21 class Channel_r : public ModeHandler
25 Channel_r(InspIRCd* Instance) : ModeHandler(Instance, 'r', 0, 0, false, MODETYPE_CHANNEL, false) { }
27 ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding, bool)
29 // only a u-lined server may add or remove the +r mode.
30 if (IS_REMOTE(source) || ServerInstance->ULine(source->nick.c_str()) || ServerInstance->ULine(source->server))
32 // Only change the mode if it's not redundant
33 if ((adding && !channel->IsModeSet('r')) || (!adding && channel->IsModeSet('r')))
35 channel->SetMode('r',adding);
36 return MODEACTION_ALLOW;
39 return MODEACTION_DENY;
43 source->WriteNumeric(500, "%s :Only a server may modify the +r channel mode", source->nick.c_str());
44 return MODEACTION_DENY;
49 /** User mode +r - mark a user as identified
51 class User_r : public ModeHandler
55 User_r(InspIRCd* Instance) : ModeHandler(Instance, 'r', 0, 0, false, MODETYPE_USER, false) { }
57 ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding, bool servermode)
59 if (servermode || IS_REMOTE(source) || ServerInstance->ULine(source->nick.c_str()) || ServerInstance->ULine(source->server))
61 if ((adding && !dest->IsModeSet('r')) || (!adding && dest->IsModeSet('r')))
63 dest->SetMode('r',adding);
64 return MODEACTION_ALLOW;
66 return MODEACTION_DENY;
70 source->WriteNumeric(500, "%s :Only a server may modify the +r user mode", source->nick.c_str());
71 return MODEACTION_DENY;
76 /** Channel mode +R - unidentified users cannot join
78 class AChannel_R : public SimpleChannelModeHandler
81 AChannel_R(InspIRCd* Instance) : SimpleChannelModeHandler(Instance, 'R') { }
84 /** User mode +R - unidentified users cannot message
86 class AUser_R : public SimpleUserModeHandler
89 AUser_R(InspIRCd* Instance) : SimpleUserModeHandler(Instance, 'R') { }
92 /** Channel mode +M - unidentified users cannot message channel
94 class AChannel_M : public SimpleChannelModeHandler
97 AChannel_M(InspIRCd* Instance) : SimpleChannelModeHandler(Instance, 'M') { }
100 class ModuleServicesAccount : public Module
108 ModuleServicesAccount(InspIRCd* Me) : Module(Me)
110 m1 = new AChannel_R(ServerInstance);
111 m2 = new AChannel_M(ServerInstance);
112 m3 = new AUser_R(ServerInstance);
113 m4 = new Channel_r(ServerInstance);
114 m5 = new User_r(ServerInstance);
116 if (!ServerInstance->Modes->AddMode(m1) || !ServerInstance->Modes->AddMode(m2) || !ServerInstance->Modes->AddMode(m3) || !ServerInstance->Modes->AddMode(m4) || !ServerInstance->Modes->AddMode(m5))
117 throw ModuleException("Some other module has claimed our modes!");
119 Implementation eventlist[] = { I_OnWhois, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreJoin,
120 I_OnSyncUserMetaData, I_OnUserQuit, I_OnCleanup, I_OnDecodeMetaData, I_On005Numeric, I_OnUserPostNick };
122 ServerInstance->Modules->Attach(eventlist, this, 10);
125 virtual void On005Numeric(std::string &t)
127 ServerInstance->AddExtBanChar('R');
128 ServerInstance->AddExtBanChar('M');
131 /* <- :twisted.oscnet.org 330 w00t2 w00t2 w00t :is logged in as */
132 virtual void OnWhois(User* source, User* dest)
134 std::string *account;
135 dest->GetExt("accountname", account);
139 ServerInstance->SendWhoisLine(source, dest, 330, "%s %s %s :is logged in as", source->nick.c_str(), dest->nick.c_str(), account->c_str());
142 if (dest->IsModeSet('r'))
144 /* user is registered */
145 ServerInstance->SendWhoisLine(source, dest, 307, "%s %s :is a registered nick", source->nick.c_str(), dest->nick.c_str());
149 virtual void OnUserPostNick(User* user, const std::string &oldnick)
151 /* On nickchange, if they have +r, remove it */
152 if (user->IsModeSet('r') && assign(user->nick) != oldnick)
154 std::vector<std::string> modechange;
155 modechange.push_back(user->nick);
156 modechange.push_back("-r");
157 ServerInstance->SendMode(modechange, user);
161 virtual int OnUserPreMessage(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
166 std::string *account;
167 bool is_registered = user->GetExt("accountname", account);
168 is_registered = is_registered && !account->empty();
170 if ((ServerInstance->ULine(user->nick.c_str())) || (ServerInstance->ULine(user->server)))
172 // user is ulined, can speak regardless
176 if (target_type == TYPE_CHANNEL)
178 Channel* c = (Channel*)dest;
180 if (c->IsModeSet('M') && !is_registered)
182 // user messaging a +M channel and is not registered
183 user->WriteNumeric(477, ""+std::string(user->nick)+" "+std::string(c->name)+" :You need to be identified to a registered account to message this channel");
189 if (c->IsExtBanned(*account, 'M'))
191 // may not speak (text is deliberately vague, so they don't know which restriction to evade)
192 user->WriteNumeric(477, ""+std::string(user->nick)+" "+std::string(c->name)+" :You may not speak in this channel");
197 else if (target_type == TYPE_USER)
199 User* u = (User*)dest;
201 if (u->IsModeSet('R') && !is_registered)
203 // user messaging a +R user and is not registered
204 user->WriteNumeric(477, ""+ user->nick +" "+ u->nick +" :You need to be identified to a registered account to message this user");
211 virtual int OnUserPreNotice(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
213 return OnUserPreMessage(user, dest, target_type, text, status, exempt_list);
216 virtual int OnUserPreJoin(User* user, Channel* chan, const char* cname, std::string &privs, const std::string &keygiven)
221 std::string *account;
222 bool is_registered = user->GetExt("accountname", account);
223 is_registered = is_registered && !account->empty();
227 if ((ServerInstance->ULine(user->nick.c_str())) || (ServerInstance->ULine(user->server)))
229 // user is ulined, won't be stopped from joining
233 if (chan->IsModeSet('R'))
237 // joining a +R channel and not identified
238 user->WriteNumeric(477, user->nick + " " + chan->name + " :You need to be identified to a registered account to join this channel");
245 if (chan->IsExtBanned(*account, 'R'))
248 user->WriteNumeric(ERR_BANNEDFROMCHAN, "%s %s :Cannot join channel (You're banned)", user->nick.c_str(), chan->name.c_str());
256 // Whenever the linking module wants to send out data, but doesnt know what the data
257 // represents (e.g. it is metadata, added to a User or Channel by a module) then
258 // this method is called. We should use the ProtoSendMetaData function after we've
259 // corrected decided how the data should look, to send the metadata on its way if
261 virtual void OnSyncUserMetaData(User* user, Module* proto, void* opaque, const std::string &extname, bool displayable)
263 // check if the linking module wants to know about OUR metadata
264 if (extname == "accountname")
266 // check if this user has an swhois field to send
267 std::string* account;
268 user->GetExt("accountname", account);
271 // remove any accidental leading/trailing spaces
274 // call this function in the linking module, let it format the data how it
275 // sees fit, and send it on its way. We dont need or want to know how.
276 proto->ProtoSendMetaData(opaque,TYPE_USER,user,extname,*account);
281 // when a user quits, tidy up their metadata
282 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message)
284 std::string* account;
285 user->GetExt("accountname", account);
288 user->Shrink("accountname");
293 // if the module is unloaded, tidy up all our dangling metadata
294 virtual void OnCleanup(int target_type, void* item)
296 if (target_type == TYPE_USER)
298 User* user = (User*)item;
299 std::string* account;
300 user->GetExt("accountname", account);
303 user->Shrink("accountname");
309 // Whenever the linking module receives metadata from another server and doesnt know what
310 // to do with it (of course, hence the 'meta') it calls this method, and it is up to each
311 // module in turn to figure out if this metadata key belongs to them, and what they want
313 // In our case we're only sending a single string around, so we just construct a std::string.
314 // Some modules will probably get much more complex and format more detailed structs and classes
315 // in a textual way for sending over the link.
316 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
318 // check if its our metadata key, and its associated with a user
319 if ((target_type == TYPE_USER) && (extname == "accountname"))
321 User* dest = (User*)target;
323 /* logging them out? */
326 std::string* account;
327 dest->GetExt("accountname", account);
330 dest->Shrink("accountname");
336 // if they dont already have an accountname field, accept the remote server's
338 if (!dest->GetExt("accountname", text))
340 text = new std::string(extdata);
341 // remove any accidental leading/trailing spaces
343 dest->Extend("accountname", text);
346 dest->WriteNumeric(900, "%s %s %s :You are now logged in as %s", dest->nick.c_str(), dest->GetFullHost().c_str(), text->c_str(), text->c_str());
351 Event n((char*)&ac, this, "account_login");
352 n.Send(ServerInstance);
358 virtual ~ModuleServicesAccount()
360 ServerInstance->Modes->DelMode(m1);
361 ServerInstance->Modes->DelMode(m2);
362 ServerInstance->Modes->DelMode(m3);
363 ServerInstance->Modes->DelMode(m4);
364 ServerInstance->Modes->DelMode(m5);
372 virtual Version GetVersion()
374 return Version("$Id$",VF_COMMON|VF_VENDOR,API_VERSION);
378 MODULE_INIT(ModuleServicesAccount)