00365 {
-00366 }
+00367 {
+00368 }
@@ -278,10 +278,10 @@ Default destructor.
Destroys a Server object.
-Definition at line 368 of file modules.cpp.
+Definition at line 370 of file modules.cpp.
-
00369 {
-00370 }
+00371 {
+00372 }
@@ -345,13 +345,13 @@ This allows modules to add extra commands into the command table. You must place
typedef void (handlerfunc) (char**, int, userrec*); ... void handle_kill(char **parameters, int pcnt, userrec *user)
When the command is typed, the parameters will be placed into the parameters array (similar to argv) and the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters than the 'minparams' value you specified when creating the command. The *user parameter is the class of the user which caused the command to trigger, who will always have the flag you specified in 'flags' when creating the initial command. For example to create an oper only command create the commands with flags='o'. The source parameter is used for resource tracking, and should contain the name of your module (with file extension) e.g. "m_blarp.so". If you place the wrong identifier here, you can cause crashes if your module is unloaded.
-Definition at line 437 of file modules.cpp.
+Definition at line 439 of file modules.cpp.
References createcommand().
-
00438 {
-00439 createcommand(cmd,f,flags,minparams,source);
-00440 }
+00440 {
+00441 createcommand(cmd,f,flags,minparams,source);
+00442 }
@@ -406,13 +406,13 @@ Adds a E-line The E-line is enforced as soon as it is added.
The duration must be in seconds, however you can use the Server::CalcDuration method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name.
-Definition at line 699 of file modules.cpp.
+Definition at line 701 of file modules.cpp.
References add_eline(), and duration().
-
00700 {
-00701 add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
-00702 }
+00702 {
+00703 add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
+00704 }
@@ -451,16 +451,16 @@ This call is used to implement modes like +q and +a. The characteristics of thes
(4) The mode and its parameter are NOT stored in the channels modes structure
It is down to the module handling the mode to maintain state and determine what 'items' (e.g. users, or a banlist) have the mode set on them, and process the modes at the correct times, e.g. during access checks on channels, etc. When the extended mode is triggered the OnExtendedMode method will be triggered as above. Note that the target you are given will be a channel, if for example your mode is set 'on a user' (in for example +a) you must use Server::Find to locate the user the mode is operating on. Your mode handler may return 1 to handle the mode AND tell the core to display the mode change, e.g. '+aaa one two three' in the case of the mode for 'two', or it may return -1 to 'eat' the mode change, so the above example would become '+aa one three' after processing.
-Definition at line 605 of file modules.cpp.
+Definition at line 607 of file modules.cpp.
-References DoAddExtendedMode(), ModeMakeList(), and MT_CHANNEL.
+References DoAddExtendedMode(), ModeMakeList(), and MT_CHANNEL.
-
00606 {
-00607 bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1);
-00608 if (res)
-00609 ModeMakeList(modechar);
-00610 return res;
-00611 }
+00608 {
+00609 bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1);
+00610 if (res)
+00611 ModeMakeList(modechar);
+00612 return res;
+00613 }
@@ -521,36 +521,36 @@ Adds an extended mode letter which is parsed by a module.
This allows modules to add extra mode letters, e.g. +x for hostcloak. the "type" parameter is either MT_CHANNEL, MT_CLIENT, or MT_SERVER, to indicate wether the mode is a channel mode, a client mode, or a server mode. requires_oper is used with MT_CLIENT type modes only to indicate the mode can only be set or unset by an oper. If this is used for MT_CHANNEL type modes it is ignored. params_when_on is the number of modes to expect when the mode is turned on (for type MT_CHANNEL only), e.g. with mode +k, this would have a value of 1. the params_when_off value has a similar value to params_when_on, except it indicates the number of parameters to expect when the mode is disabled. Modes which act in a similar way to channel mode +l (e.g. require a parameter to enable, but not to disable) should use this parameter. The function returns false if the mode is unavailable, and will not attempt to allocate another character, as this will confuse users. This also means that as only one module can claim a specific mode character, the core does not need to keep track of which modules own which modes, which speeds up operation of the server. In this version, a mode can have at most one parameter, attempting to use more parameters will have undefined effects.
-Definition at line 577 of file modules.cpp.
-
-References DEBUG, DoAddExtendedMode(), MT_CLIENT, and MT_SERVER.
-
-
00578 {
-00579 if (((modechar >= 'A') && (modechar <= 'Z')) || ((modechar >= 'a') && (modechar <= 'z')))
-00580 {
-00581 if (type == MT_SERVER)
-00582 {
-00583 log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion");
-00584 return false;
-00585 }
-00586 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
-00587 {
-00588 log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
-00589 return false;
-00590 }
-00591 if ((params_when_on>1) || (params_when_off>1))
-00592 {
-00593 log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported");
-00594 return false;
-00595 }
-00596 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
-00597 }
-00598 else
-00599 {
-00600 log(DEBUG,"*** API ERROR *** Muppet modechar detected.");
-00601 }
-00602 return false;
-00603 }
+Definition at line 579 of file modules.cpp.
+
+References DEBUG, DoAddExtendedMode(), MT_CLIENT, and MT_SERVER.
+
+
00580 {
+00581 if (((modechar >= 'A') && (modechar <= 'Z')) || ((modechar >= 'a') && (modechar <= 'z')))
+00582 {
+00583 if (type == MT_SERVER)
+00584 {
+00585 log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion");
+00586 return false;
+00587 }
+00588 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
+00589 {
+00590 log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
+00591 return false;
+00592 }
+00593 if ((params_when_on>1) || (params_when_off>1))
+00594 {
+00595 log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported");
+00596 return false;
+00597 }
+00598 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
+00599 }
+00600 else
+00601 {
+00602 log(DEBUG,"*** API ERROR *** Muppet modechar detected.");
+00603 }
+00604 return false;
+00605 }
@@ -605,13 +605,13 @@ Adds a G-line The G-line is propogated to all of the servers in the mesh and enf
The duration must be in seconds, however you can use the Server::CalcDuration method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name.
-Definition at line 679 of file modules.cpp.
+Definition at line 681 of file modules.cpp.
References add_gline(), and duration().
-
00680 {
-00681 add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
-00682 }
+00682 {
+00683 add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
+00684 }
@@ -666,13 +666,13 @@ Adds a K-line The K-line is enforced as soon as it is added.
The duration must be in seconds, however you can use the Server::CalcDuration method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name.
-Definition at line 694 of file modules.cpp.
+Definition at line 696 of file modules.cpp.
References add_kline(), and duration().
-
00695 {
-00696 add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
-00697 }
+00697 {
+00698 add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
+00699 }
@@ -727,13 +727,13 @@ Adds a Q-line The Q-line is propogated to all of the servers in the mesh and enf
The duration must be in seconds, however you can use the Server::CalcDuration method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name.
-Definition at line 684 of file modules.cpp.
+Definition at line 686 of file modules.cpp.
References add_qline(), and duration().
-
00685 {
-00686 add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str());
-00687 }
+00687 {
+00688 add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str());
+00689 }
@@ -788,13 +788,13 @@ Adds a Z-line The Z-line is propogated to all of the servers in the mesh and enf
The duration must be in seconds, however you can use the Server::CalcDuration method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name.
-Definition at line 689 of file modules.cpp.
+Definition at line 691 of file modules.cpp.
References add_zline(), and duration().
-
00690 {
-00691 add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str());
-00692 }
+00692 {
+00693 add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str());
+00694 }
@@ -828,13 +828,13 @@ Calculates a duration This method will take a string containing a formatted dura
"1w2d") and return its value as a total number of seconds. This is the same function used internally by /GLINE etc to set the ban times.
-Definition at line 729 of file modules.cpp.
+Definition at line 731 of file modules.cpp.
References duration().
-
00730 {
-00731 return duration(delta.c_str());
-00732 }
+00732 {
+00733 return duration(delta.c_str());
+00734 }
@@ -890,11 +890,11 @@ Calls the handler for a command, either implemented by the core or by another mo
You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN, KICK etc, or even as a method of callback. By defining command names that are untypeable for users on irc (e.g. those which contain a or
) you may use them as callback identifiers. The first parameter to this method is the name of the command handler you wish to call, e.g. PRIVMSG. This will be a command handler previously registered by the core or wih AddCommand(). The second parameter is an array of parameters, and the third parameter is a count of parameters in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the functiom will silently ignore it. The final parameter is the user executing the command handler, used for privilage checks, etc.
-Definition at line 427 of file modules.cpp.
+Definition at line 429 of file modules.cpp.
-
00428 {
-00429 call_handler(commandname.c_str(),parameters,pcnt,user);
-00430 }
+00430 {
+00431 call_handler(commandname.c_str(),parameters,pcnt,user);
+00432 }
@@ -937,13 +937,13 @@ Change GECOS (fullname) of a user.
You should always call this method to change a user's GECOS rather than writing directly to the fullname member of userrec, as any change applied via this method will be propogated to any linked servers.
-Definition at line 520 of file modules.cpp.
+Definition at line 522 of file modules.cpp.
References ChangeName().
-
00521 {
-00522 ChangeName(user,gecos.c_str());
-00523 }
+00523 {
+00524 ChangeName(user,gecos.c_str());
+00525 }
@@ -986,13 +986,13 @@ Change displayed hostname of a user.
You should always call this method to change a user's host rather than writing directly to the dhost member of userrec, as any change applied via this method will be propogated to any linked servers.
-Definition at line 515 of file modules.cpp.
+Definition at line 517 of file modules.cpp.
References ChangeDisplayedHost().
-
00516 {
-00517 ChangeDisplayedHost(user,host.c_str());
-00518 }
+00518 {
+00519 ChangeDisplayedHost(user,host.c_str());
+00520 }
@@ -1035,11 +1035,11 @@ Forces a user nickchange.
This command works similarly to SVSNICK, and can be used to implement Q-lines etc. If you specify an invalid nickname, the nick change will be dropped and the target user will receive the error numeric for it.
-Definition at line 412 of file modules.cpp.
+Definition at line 414 of file modules.cpp.
-
00413 {
-00414 force_nickchange(user,nickname.c_str());
-00415 }
+00415 {
+00416 force_nickchange(user,nickname.c_str());
+00417 }
@@ -1082,13 +1082,13 @@ Attempts to look up a user's privilages on a channel.
This function will return a string containing either @, , +, or an empty string, representing the user's privilages upon the channel you specify.
-Definition at line 545 of file modules.cpp.
+Definition at line 547 of file modules.cpp.
References cmode().
-
00546 {
-00547 return cmode(User,Chan);
-00548 }
+00548 {
+00549 return cmode(User,Chan);
+00550 }
@@ -1131,13 +1131,13 @@ Returns true if two users share a common channel.
This method is used internally by the NICK and QUIT commands, and the Server::SendCommon method.
-Definition at line 493 of file modules.cpp.
+Definition at line 495 of file modules.cpp.
References common_channels().
-
00494 {
-00495 return (common_channels(u1,u2) != 0);
-00496 }
+00496 {
+00497 return (common_channels(u1,u2) != 0);
+00498 }
@@ -1171,11 +1171,11 @@ Returns a count of the number of users on a channel.
This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.
-Definition at line 613 of file modules.cpp.
+Definition at line 615 of file modules.cpp.
-
00614 {
-00615 return usercount(c);
-00616 }
+00616 {
+00617 return usercount(c);
+00618 }
@@ -1209,13 +1209,13 @@ Deletes a local E-Line.
-Definition at line 724 of file modules.cpp.
+Definition at line 726 of file modules.cpp.
References del_eline().
-
00725 {
-00726 del_eline(hostmask.c_str());
-00727 }
+00727 {
+00728 del_eline(hostmask.c_str());
+00729 }
@@ -1249,13 +1249,13 @@ Deletes a G-Line from all servers on the mesh.
-Definition at line 704 of file modules.cpp.
+Definition at line 706 of file modules.cpp.
References del_gline().
-
00705 {
-00706 del_gline(hostmask.c_str());
-00707 }
+00707 {
+00708 del_gline(hostmask.c_str());
+00709 }
@@ -1289,13 +1289,13 @@ Deletes a local K-Line.
-Definition at line 719 of file modules.cpp.
+Definition at line 721 of file modules.cpp.
References del_kline().
-
00720 {
-00721 del_kline(hostmask.c_str());
-00722 }
+00722 {
+00723 del_kline(hostmask.c_str());
+00724 }
@@ -1329,13 +1329,13 @@ Deletes a Q-Line from all servers on the mesh.
-Definition at line 709 of file modules.cpp.
+Definition at line 711 of file modules.cpp.
References del_qline().
-
00710 {
-00711 del_qline(nickname.c_str());
-00712 }
+00712 {
+00713 del_qline(nickname.c_str());
+00714 }
@@ -1369,13 +1369,13 @@ Deletes a Z-Line from all servers on the mesh.
-Definition at line 714 of file modules.cpp.
+Definition at line 716 of file modules.cpp.
References del_zline().
-
00715 {
-00716 del_zline(ipaddr.c_str());
-00717 }
+00717 {
+00718 del_zline(ipaddr.c_str());
+00719 }
@@ -1409,11 +1409,11 @@ Attempts to look up a channel and return a pointer to it.
This function will return NULL if the channel does not exist.
-Definition at line 540 of file modules.cpp.
+Definition at line 542 of file modules.cpp.
-
00541 {
-00542 return FindChan(channel.c_str());
-00543 }
+00543 {
+00544 return FindChan(channel.c_str());
+00545 }
@@ -1447,13 +1447,13 @@ Attempts to look up a nick using the file descriptor associated with that nick.
This function will return NULL if the file descriptor is not associated with a valid user.
-Definition at line 535 of file modules.cpp.
+Definition at line 537 of file modules.cpp.
-References fd_ref_table.
+References fd_ref_table.
-
00536 {
-00537 return (socket < 65536 ? fd_ref_table[socket] : NULL);
-00538 }
+00538 {
+00539 return (socket < 65536 ? fd_ref_table[socket] : NULL);
+00540 }
@@ -1487,20 +1487,20 @@ This function finds a module by name.
You must provide the filename of the module. If the module cannot be found (is not loaded) the function will return NULL.
-Definition at line 807 of file modules.cpp.
+Definition at line 809 of file modules.cpp.
-References MODCOUNT, module_names, and modules.
+References MODCOUNT, module_names, and modules.
-
00808 {
-00809 for (int i = 0; i <= MODCOUNT; i++)
-00810 {
-00811 if (module_names[i] == name)
-00812 {
-00813 return modules[i];
-00814 }
-00815 }
-00816 return NULL;
-00817 }
+00810 {
+00811 for (int i = 0; i <= MODCOUNT; i++)
+00812 {
+00813 if (module_names[i] == name)
+00814 {
+00815 return modules[i];
+00816 }
+00817 }
+00818 return NULL;
+00819 }
@@ -1534,11 +1534,11 @@ Attempts to look up a nick and return a pointer to it.
This function will return NULL if the nick does not exist.
-Definition at line 530 of file modules.cpp.
+Definition at line 532 of file modules.cpp.
-
00531 {
-00532 return Find(nick);
-00533 }
+00533 {
+00534 return Find(nick);
+00535 }
@@ -1571,11 +1571,11 @@ Returns the information of the server as returned by the /ADMIN command.
See the Admin class for further information of the return value. The members Admin::Nick, Admin::Email and Admin::Name contain the information for the server where the module is loaded.
-Definition at line 570 of file modules.cpp.
+Definition at line 572 of file modules.cpp.
-
00571 {
-00572 return Admin(getadminname(),getadminemail(),getadminnick());
-00573 }
+00573 {
+00574 return Admin(getadminname(),getadminemail(),getadminnick());
+00575 }
@@ -1608,11 +1608,11 @@ Returns the network name, global to all linked servers.
-Definition at line 560 of file modules.cpp.
+Definition at line 562 of file modules.cpp.
-
00561 {
-00562 return getnetworkname();
-00563 }
+00563 {
+00564 return getnetworkname();
+00565 }
@@ -1645,11 +1645,11 @@ Returns the server description string of the local server.
-Definition at line 565 of file modules.cpp.
+Definition at line 567 of file modules.cpp.
-
00566 {
-00567 return getserverdesc();
-00568 }
+00568 {
+00569 return getserverdesc();
+00570 }
@@ -1682,11 +1682,11 @@ Returns the server name of the server where the module is loaded.
-Definition at line 555 of file modules.cpp.
+Definition at line 557 of file modules.cpp.
-
00556 {
-00557 return getservername();
-00558 }
+00558 {
+00559 return getservername();
+00560 }
@@ -1720,21 +1720,21 @@ Fetches the userlist of a channel.
This function must be here and not a member of userrec or chanrec due to include constraints.
-Definition at line 400 of file modules.cpp.
+Definition at line 402 of file modules.cpp.
References chanuserlist, chanrec::GetUsers(), and list.
-
00401 {
-00402 chanuserlist userl;
-00403 userl.clear();
-00404 std::vector<char*> *list = chan->GetUsers();
-00405 for (std::vector<char*>::iterator i = list->begin(); i != list->end(); i++)
-00406 {
-00407 char* o = *i;
-00408 userl.push_back((userrec*)o);
-00409 }
-00410 return userl;
-00411 }
+00403 {
+00404 chanuserlist userl;
+00405 userl.clear();
+00406 std::vector<char*> *list = chan->GetUsers();
+00407 for (std::vector<char*>::iterator i = list->begin(); i != list->end(); i++)
+00408 {
+00409 char* o = *i;
+00410 userl.push_back((userrec*)o);
+00411 }
+00412 return userl;
+00413 }
@@ -1768,13 +1768,13 @@ Returns true if a nick is valid.
Nicks for unregistered connections will return false.
-Definition at line 525 of file modules.cpp.
+Definition at line 527 of file modules.cpp.
References isnick().
-
00526 {
-00527 return (isnick(nick.c_str()) != 0);
-00528 }
+00528 {
+00529 return (isnick(nick.c_str()) != 0);
+00530 }
@@ -1817,13 +1817,13 @@ Checks if a user is on a channel.
This function will return true or false to indicate if user 'User' is on channel 'Chan'.
-Definition at line 550 of file modules.cpp.
+Definition at line 552 of file modules.cpp.
References has_channel().
-
00551 {
-00552 return has_channel(User,Chan);
-00553 }
+00553 {
+00554 return has_channel(User,Chan);
+00555 }
@@ -1857,13 +1857,13 @@ Returns true if the servername you give is ulined.
ULined servers have extra privilages. They are allowed to change nicknames on remote servers, change modes of clients which are on remote servers and set modes of channels where there are no channel operators for that channel on the ulined server, amongst other things. Ulined server data is also broadcast across the mesh at all times as opposed to selectively messaged in the case of normal servers, as many ulined server types (such as services) do not support meshed links and must operate in this manner.
-Definition at line 422 of file modules.cpp.
+Definition at line 424 of file modules.cpp.
References is_uline().
-
00423 {
-00424 return is_uline(server.c_str());
-00425 }
+00425 {
+00426 return is_uline(server.c_str());
+00427 }
@@ -1897,35 +1897,35 @@ Returns true if a nick!ident string is correctly formatted, false if otherwise.
-Definition at line 734 of file modules.cpp.
+Definition at line 736 of file modules.cpp.
-
00735 {
-00736 const char* dest = mask.c_str();
-00737 if (strchr(dest,'!')==0)
-00738 return false;
-00739 if (strchr(dest,'@')==0)
+00737 {
+00738 const char* dest = mask.c_str();
+00739 if (strchr(dest,'!')==0)
00740 return false;
-00741 for (int i = 0; i < strlen(dest); i++)
-00742 if (dest[i] < 32)
-00743 return false;
-00744 for (int i = 0; i < strlen(dest); i++)
-00745 if (dest[i] > 126)
-00746 return false;
-00747 int c = 0;
-00748 for (int i = 0; i < strlen(dest); i++)
-00749 if (dest[i] == '!')
-00750 c++;
-00751 if (c>1)
-00752 return false;
-00753 c = 0;
-00754 for (int i = 0; i < strlen(dest); i++)
-00755 if (dest[i] == '@')
-00756 c++;
-00757 if (c>1)
-00758 return false;
-00759
-00760 return true;
-00761 }
+00741 if (strchr(dest,'@')==0)
+00742 return false;
+00743 for (int i = 0; i < strlen(dest); i++)
+00744 if (dest[i] < 32)
+00745 return false;
+00746 for (int i = 0; i < strlen(dest); i++)
+00747 if (dest[i] > 126)
+00748 return false;
+00749 int c = 0;
+00750 for (int i = 0; i < strlen(dest); i++)
+00751 if (dest[i] == '!')
+00752 c++;
+00753 if (c>1)
+00754 return false;
+00755 c = 0;
+00756 for (int i = 0; i < strlen(dest); i++)
+00757 if (dest[i] == '@')
+00758 c++;
+00759 if (c>1)
+00760 return false;
+00761
+00762 return true;
+00763 }
@@ -1974,11 +1974,11 @@ Forces a user to join a channel.
This is similar to svsjoin and can be used to implement redirection, etc. On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to. On failure, the result is NULL.
-Definition at line 390 of file modules.cpp.
+Definition at line 392 of file modules.cpp.
-
00391 {
-00392 return add_channel(user,cname.c_str(),key.c_str(),false);
-00393 }
+00393 {
+00394 return add_channel(user,cname.c_str(),key.c_str(),false);
+00395 }
@@ -2021,11 +2021,11 @@ Writes a log string.
This method writes a line of text to the log. If the level given is lower than the level given in the configuration, this command has no effect.
-Definition at line 432 of file modules.cpp.
+Definition at line 434 of file modules.cpp.
-
00433 {
-00434 log(level,"%s",s.c_str());
-00435 }
+00435 {
+00436 log(level,"%s",s.c_str());
+00437 }
@@ -2068,14 +2068,14 @@ Matches text against a glob pattern.
Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com Returns true if the literal successfully matches the pattern, false if otherwise.
-Definition at line 377 of file modules.cpp.
+Definition at line 379 of file modules.cpp.
-
00378 {
-00379 char literal[MAXBUF],pattern[MAXBUF];
-00380 strlcpy(literal,sliteral.c_str(),MAXBUF);
-00381 strlcpy(pattern,spattern.c_str(),MAXBUF);
-00382 return match(literal,pattern);
-00383 }
+00380 {
+00381 char literal[MAXBUF],pattern[MAXBUF];
+00382 strlcpy(literal,sliteral.c_str(),MAXBUF);
+00383 strlcpy(pattern,spattern.c_str(),MAXBUF);
+00384 return match(literal,pattern);
+00385 }
@@ -2118,15 +2118,15 @@ This function is used to check if any users on channel c are on server servernam
This is used internally by PRIVMSG etc. You should not need to use it.
-Definition at line 789 of file modules.cpp.
+Definition at line 791 of file modules.cpp.
-
00790 {
-00791 if (c)
-00792 {
-00793 return ChanAnyOnThisServer(c,(char*)servername.c_str());
-00794 }
-00795 else return false;
-00796 }
+00792 {
+00793 if (c)
+00794 {
+00795 return ChanAnyOnThisServer(c,(char*)servername.c_str());
+00796 }
+00797 else return false;
+00798 }
@@ -2169,15 +2169,15 @@ This function is used to check if user u has any channels in common with users o
This is used internally by Server::MeshSendCommon. You should very rarely need to use it.
-Definition at line 798 of file modules.cpp.
+Definition at line 800 of file modules.cpp.
-
00799 {
-00800 if (u)
-00801 {
-00802 return CommonOnThisServer(u,(char*)servername.c_str());
-00803 }
-00804 else return false;
-00805 }
+00801 {
+00802 if (u)
+00803 {
+00804 return CommonOnThisServer(u,(char*)servername.c_str());
+00805 }
+00806 else return false;
+00807 }
@@ -2211,11 +2211,11 @@ Sends a line of text to all connected servers.
If a server is not directly reachable, the core deals with routing the message, and will also deal with failures transparently.
-Definition at line 763 of file modules.cpp.
+Definition at line 765 of file modules.cpp.
-
00764 {
-00765 NetSendToAll((char*)text.c_str());
-00766 }
+00766 {
+00767 NetSendToAll((char*)text.c_str());
+00768 }
@@ -2249,11 +2249,11 @@ This function is equivalent to Server::MeshSendToAll except it will only route t
-Definition at line 774 of file modules.cpp.
+Definition at line 776 of file modules.cpp.
-
00775 {
-00776 NetSendToAllAlive((char*)text.c_str());
-00777 }
+00777 {
+00778 NetSendToAllAlive((char*)text.c_str());
+00779 }
@@ -2296,11 +2296,11 @@ This function sends to all servers EXCEPT the one you specify.
You should usually use this function to send messages, specifying the SENDER of your message as 'target'. This will prevent message loops.
-Definition at line 784 of file modules.cpp.
+Definition at line 786 of file modules.cpp.
-
00785 {
-00786 NetSendToAllExcept(target.c_str(),(char*)text.c_str());
-00787 }
+00787 {
+00788 NetSendToAllExcept(target.c_str(),(char*)text.c_str());
+00789 }
@@ -2343,12 +2343,12 @@ This method sends a line of text to all servers who have users which share commo
For example, if user A is on server A, and they are on channels #one and #two, and user B is on server B, and also on channel #one, but user C is on server C and on neither #one or #two, this function will cause the text to only be sent to server B. However, if server B is only reachable via C, it will route it to C (you do not have to worry about this routing, it is done transparently, but its good to know how things work!)
-Definition at line 768 of file modules.cpp.
+Definition at line 770 of file modules.cpp.
-
00769 {
-00770 if (user)
-00771 NetSendToCommon(user,(char*)text.c_str());
-00772 }
+00771 {
+00772 if (user)
+00773 NetSendToCommon(user,(char*)text.c_str());
+00774 }
@@ -2391,11 +2391,11 @@ This function sends a line of text directly to a server.
If the server is not directly routable at this time, the server attempts to route text through the mesh.
-Definition at line 779 of file modules.cpp.
+Definition at line 781 of file modules.cpp.
-
00780 {
-00781 NetSendToOne((char*)destination.c_str(),(char*)text.c_str());
-00782 }
+00782 {
+00783 NetSendToOne((char*)destination.c_str(),(char*)text.c_str());
+00784 }
@@ -2444,11 +2444,11 @@ Forces a user to part a channel.
This is similar to svspart and can be used to implement redirection, etc. Although the return value of this function is a pointer to a channel record, the returned data is undefined and should not be read or written to. This behaviour may be changed in a future version.
-Definition at line 395 of file modules.cpp.
+Definition at line 397 of file modules.cpp.
-
00396 {
-00397 return del_channel(user,cname.c_str(),reason.c_str(),false);
-00398 }
+00398 {
+00399 return del_channel(user,cname.c_str(),reason.c_str(),false);
+00400 }
@@ -2497,38 +2497,38 @@ This user takes one user, and switches their file descriptor with another user,
The user in 'alive' is booted off the server with the given message. The user referred to by 'zombie' should have previously been locked with Server::ZombifyUser, otherwise stale sockets and file descriptor leaks can occur. After this call, the pointer to alive will be invalid, and the pointer to zombie will be equivalent in effect to the old pointer to alive.
-Definition at line 649 of file modules.cpp.
-
-References ucrec::channel, userrec::chans, userrec::ClearBuffer(), connection::fd, FD_MAGIC_NUMBER, fd_ref_table, connection::host, userrec::ident, chanrec::name, userrec::nick, chanrec::setby, chanrec::topic, and chanrec::topicset.
-
-
00650 {
-00651 zombie->fd = alive->fd;
-00652 alive->fd = FD_MAGIC_NUMBER;
-00653 alive->ClearBuffer();
-00654 Write(zombie->fd,":%s!%s@%s NICK %s",alive->nick,alive->ident,alive->host,zombie->nick);
-00655 kill_link(alive,message.c_str());
-00656 fd_ref_table[zombie->fd] = zombie;
-00657 for (int i = 0; i != MAXCHANS; i++)
-00658 {
-00659 if (zombie->chans[i].channel != NULL)
-00660 {
-00661 if (zombie->chans[i].channel->name)
-00662 {
-00663 chanrec* Ptr = zombie->chans[i].channel;
-00664 WriteFrom(zombie->fd,zombie,"JOIN %s",Ptr->name);
-00665 if (Ptr->topicset)
-00666 {
-00667 WriteServ(zombie->fd,"332 %s %s :%s", zombie->nick, Ptr->name, Ptr->topic);
-00668 WriteServ(zombie->fd,"333 %s %s %s %d", zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset);
-00669 }
-00670 userlist(zombie,Ptr);
-00671 WriteServ(zombie->fd,"366 %s %s :End of /NAMES list.", zombie->nick, Ptr->name);
-00672
-00673 }
-00674 }
-00675 }
-00676
-00677 }
+Definition at line 651 of file modules.cpp.
+
+References ucrec::channel, userrec::chans, userrec::ClearBuffer(), connection::fd, FD_MAGIC_NUMBER, fd_ref_table, connection::host, userrec::ident, chanrec::name, userrec::nick, chanrec::setby, chanrec::topic, and chanrec::topicset.
+
+
00652 {
+00653 zombie->fd = alive->fd;
+00654 alive->fd = FD_MAGIC_NUMBER;
+00655 alive->ClearBuffer();
+00656 Write(zombie->fd,":%s!%s@%s NICK %s",alive->nick,alive->ident,alive->host,zombie->nick);
+00657 kill_link(alive,message.c_str());
+00658 fd_ref_table[zombie->fd] = zombie;
+00659 for (int i = 0; i != MAXCHANS; i++)
+00660 {
+00661 if (zombie->chans[i].channel != NULL)
+00662 {
+00663 if (zombie->chans[i].channel->name)
+00664 {
+00665 chanrec* Ptr = zombie->chans[i].channel;
+00666 WriteFrom(zombie->fd,zombie,"JOIN %s",Ptr->name);
+00667 if (Ptr->topicset)
+00668 {
+00669 WriteServ(zombie->fd,"332 %s %s :%s", zombie->nick, Ptr->name, Ptr->topic);
+00670 WriteServ(zombie->fd,"333 %s %s %s %d", zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset);
+00671 }
+00672 userlist(zombie,Ptr);
+00673 WriteServ(zombie->fd,"366 %s %s :End of /NAMES list.", zombie->nick, Ptr->name);
+00674
+00675 }
+00676 }
+00677 }
+00678
+00679 }
@@ -2573,11 +2573,11 @@ To the user, it will appear as if they typed /QUIT themselves, except for the fa
WARNING!
Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of action after calling this method is to immediately bail from your handler.
-Definition at line 417 of file modules.cpp.
+Definition at line 419 of file modules.cpp.
-
00418 {
-00419 kill_link(user,reason.c_str());
-00420 }
+00420 {
+00421 kill_link(user,reason.c_str());
+00422 }
@@ -2620,11 +2620,11 @@ Sends a line of text down a TCP/IP socket.
This method writes a line of text to an established socket, cutting it to 510 characters plus a carriage return and linefeed if required.
-Definition at line 447 of file modules.cpp.
+Definition at line 449 of file modules.cpp.
-
00448 {
-00449 Write(Socket,"%s",s.c_str());
-00450 }
+00450 {
+00451 Write(Socket,"%s",s.c_str());
+00452 }
@@ -2679,18 +2679,18 @@ Sends text from a user to a channel (mulicast).
This method writes a line of text to a channel, with the given user's nick/ident /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent back to the user from which it originated, as seen in MODE (see RFC 1459).
-Definition at line 481 of file modules.cpp.
-
-
00482 {
-00483 if (IncludeSender)
-00484 {
-00485 WriteChannel(Channel,User,"%s",s.c_str());
-00486 }
-00487 else
-00488 {
-00489 ChanExceptSender(Channel,User,"%s",s.c_str());
-00490 }
-00491 }
+Definition at line 483 of file modules.cpp.
+
+
00484 {
+00485 if (IncludeSender)
+00486 {
+00487 WriteChannel(Channel,User,"%s",s.c_str());
+00488 }
+00489 else
+00490 {
+00491 ChanExceptSender(Channel,User,"%s",s.c_str());
+00492 }
+00493 }
@@ -2739,11 +2739,11 @@ Writes text to a channel, but from a server, including all.
This can be used to send server notices to a group of users.
-Definition at line 476 of file modules.cpp.
+Definition at line 478 of file modules.cpp.
-
00477 {
-00478 WriteChannelWithServ((char*)ServName.c_str(), Channel, "%s", text.c_str());
-00479 }
+00479 {
+00480 WriteChannelWithServ((char*)ServName.c_str(), Channel, "%s", text.c_str());
+00481 }
@@ -2792,18 +2792,18 @@ Sends text from a user to one or more channels (mulicast).
This method writes a line of text to all users which share a common channel with a given user, with the user's nick/ident/host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent back to the user from which it originated, as seen in NICK (see RFC 1459). Otherwise, it is only sent to the other recipients, as seen in QUIT.
-Definition at line 498 of file modules.cpp.
-
-
00499 {
-00500 if (IncludeSender)
-00501 {
-00502 WriteCommon(User,"%s",text.c_str());
-00503 }
-00504 else
-00505 {
-00506 WriteCommonExcept(User,"%s",text.c_str());
-00507 }
-00508 }
+Definition at line 500 of file modules.cpp.
+
+
00501 {
+00502 if (IncludeSender)
+00503 {
+00504 WriteCommon(User,"%s",text.c_str());
+00505 }
+00506 else
+00507 {
+00508 WriteCommonExcept(User,"%s",text.c_str());
+00509 }
+00510 }
@@ -2852,11 +2852,11 @@ Sends text from a user to a socket.
This method writes a line of text to an established socket, with the given user's nick/ident /host combination prepended, as used in PRIVSG etc commands (see RFC 1459)
-Definition at line 457 of file modules.cpp.
+Definition at line 459 of file modules.cpp.
-
00458 {
-00459 WriteFrom(Socket,User,"%s",s.c_str());
-00460 }
+00460 {
+00461 WriteFrom(Socket,User,"%s",s.c_str());
+00462 }
@@ -2912,13 +2912,13 @@ modes[2] = user->nick;
Srv->SendMode(modes,3,user);
The modes will originate from the server where the command was issued, however responses (e.g. numerics) will be sent to the user you provide as the third parameter. You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave your server in an unstable state!
-Definition at line 442 of file modules.cpp.
+Definition at line 444 of file modules.cpp.
References server_mode().
-
00443 {
-00444 server_mode(parameters,pcnt,user);
-00445 }
+00445 {
+00446 server_mode(parameters,pcnt,user);
+00447 }
@@ -2952,11 +2952,11 @@ Sends text to all opers.
This method sends a server notice to all opers with the usermode +s.
-Definition at line 372 of file modules.cpp.
+Definition at line 374 of file modules.cpp.
-
00373 {
-00374 WriteOpers("%s",s.c_str());
-00375 }
+00375 {
+00376 WriteOpers("%s",s.c_str());
+00377 }
@@ -2999,11 +2999,11 @@ Sends text from the server to a socket.
This method writes a line of text to an established socket, with the servername prepended as used by numerics (see RFC 1459)
-Definition at line 452 of file modules.cpp.
+Definition at line 454 of file modules.cpp.
-
00453 {
-00454 WriteServ(Socket,"%s",s.c_str());
-00455 }
+00455 {
+00456 WriteServ(Socket,"%s",s.c_str());
+00457 }
@@ -3056,22 +3056,22 @@ The format will become:
:localserver TEXT
Which is useful for numerics and server notices to single users, etc.
-Definition at line 462 of file modules.cpp.
+Definition at line 464 of file modules.cpp.
References connection::fd.
-
00463 {
-00464 if (!Source)
-00465 {
-00466 // if source is NULL, then the message originates from the local server
-00467 Write(Dest->fd,":%s %s",this->GetServerName().c_str(),s.c_str());
-00468 }
-00469 else
-00470 {
-00471 // otherwise it comes from the user specified
-00472 WriteTo(Source,Dest,"%s",s.c_str());
-00473 }
-00474 }
+00465 {
+00466 if (!Source)
+00467 {
+00468 // if source is NULL, then the message originates from the local server
+00469 Write(Dest->fd,":%s %s",this->GetServerName().c_str(),s.c_str());
+00470 }
+00471 else
+00472 {
+00473 // otherwise it comes from the user specified
+00474 WriteTo(Source,Dest,"%s",s.c_str());
+00475 }
+00476 }
@@ -3122,11 +3122,11 @@ These can be RFC specified modes such as +i, or module provided modes, including
Serv->SendToModeMask("xi", WM_OR, "m00");
Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the user must have both modes set to receive the message.
-Definition at line 385 of file modules.cpp.
+Definition at line 387 of file modules.cpp.
-
00386 {
-00387 WriteMode(modes.c_str(),flags,"%s",text.c_str());
-00388 }
+00388 {
+00389 WriteMode(modes.c_str(),flags,"%s",text.c_str());
+00390 }
@@ -3169,11 +3169,11 @@ Sends a WALLOPS message.
This method writes a WALLOPS message to all users with the +w flag, originating from the specified user.
-Definition at line 510 of file modules.cpp.
+Definition at line 512 of file modules.cpp.
-
00511 {
-00512 WriteWallOps(User,false,"%s",text.c_str());
-00513 }
+00513 {
+00514 WriteWallOps(User,false,"%s",text.c_str());
+00515 }
@@ -3216,44 +3216,44 @@ Remove a user's connection to the irc server, but leave their client in existenc
When you call this function, the user's file descriptor will be replaced with the value of FD_MAGIC_NUMBER and their old file descriptor will be closed. This idle client will remain until it is restored with a valid file descriptor, or is removed from IRC by an operator After this call, the pointer to user will be invalid.
-Definition at line 619 of file modules.cpp.
-
-References userrec::ClearBuffer(), DEBUG, connection::fd, FD_MAGIC_NUMBER, connection::host, and userrec::ident.
-
-
00620 {
-00621 unsigned int old_fd = user->fd;
-00622 user->fd = FD_MAGIC_NUMBER;
-00623 user->ClearBuffer();
-00624 Write(old_fd,"ERROR :Closing link (%s@%s) [%s]",user->ident,user->host,message.c_str());
-00625 #ifdef USE_KQUEUE
-00626 struct kevent ke;
-00627 EV_SET(&ke, old_fd, EVFILT_READ, EV_DELETE, 0, 0, NULL);
-00628 int i = kevent(kq, &ke, 1, 0, 0, NULL);
-00629 if (i == -1)
-00630 {
-00631 log(DEBUG,"kqueue: Failed to remove user from queue!");
-00632 }
-00633 #endif
-00634 #ifdef USE_EPOLL
-00635 struct epoll_event ev;
-00636 ev.events = EPOLLIN | EPOLLET;
-00637 ev.data.fd = old_fd;
-00638 int i = epoll_ctl(ep, EPOLL_CTL_DEL, old_fd, &ev);
-00639 if (i < 0)
-00640 {
-00641 log(DEBUG,"epoll: List deletion failure!");
-00642 }
-00643 #endif
-00644
-00645 shutdown(old_fd,2);
-00646 close(old_fd);
-00647 }
+Definition at line 621 of file modules.cpp.
+
+References userrec::ClearBuffer(), DEBUG, connection::fd, FD_MAGIC_NUMBER, connection::host, and userrec::ident.
+
+
00622 {
+00623 unsigned int old_fd = user->fd;
+00624 user->fd = FD_MAGIC_NUMBER;
+00625 user->ClearBuffer();
+00626 Write(old_fd,"ERROR :Closing link (%s@%s) [%s]",user->ident,user->host,message.c_str());
+00627 #ifdef USE_KQUEUE
+00628 struct kevent ke;
+00629 EV_SET(&ke, old_fd, EVFILT_READ, EV_DELETE, 0, 0, NULL);
+00630 int i = kevent(kq, &ke, 1, 0, 0, NULL);
+00631 if (i == -1)
+00632 {
+00633 log(DEBUG,"kqueue: Failed to remove user from queue!");
+00634 }
+00635 #endif
+00636 #ifdef USE_EPOLL
+00637 struct epoll_event ev;
+00638 ev.events = EPOLLIN | EPOLLET;
+00639 ev.data.fd = old_fd;
+00640 int i = epoll_ctl(ep, EPOLL_CTL_DEL, old_fd, &ev);
+00641 if (i < 0)
+00642 {
+00643 log(DEBUG,"epoll: List deletion failure!");
+00644 }
+00645 #endif
+00646
+00647 shutdown(old_fd,2);
+00648 close(old_fd);
+00649 }
The documentation for this class was generated from the following files:
-
Generated on Wed May 25 22:03:22 2005 for InspIRCd by
+
Generated on Mon May 30 05:17:32 2005 for InspIRCd by
1.3.3
--
cgit v1.3.1-10-gc9f91