1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3 <title>modules.cpp Source File</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css">
6 <!-- Generated by Doxygen 1.3-rc3 -->
8 <a class="qindex" href="main.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center>
9 <hr><h1>modules.cpp</h1><a href="modules_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*</span>
10 00002 <span class="comment"></span>
11 00003 <span class="comment"></span>
12 00004 <span class="comment">*/</span>
16 00008 <span class="preprocessor">#include <typeinfo></span>
17 00009 <span class="preprocessor">#include <iostream></span>
18 00010 <span class="preprocessor">#include "globals.h"</span>
19 00011 <span class="preprocessor">#include "<a class="code" href="modules_8h.html">modules.h</a>"</span>
20 00012 <span class="preprocessor">#include "<a class="code" href="ctables_8h.html">ctables.h</a>"</span>
21 00013 <span class="preprocessor">#include "inspircd_io.h"</span>
23 00015 <span class="comment">// class type for holding an extended mode character - internal to core</span>
25 <a name="l00017"></a><a class="code" href="classExtMode.html">00017</a> <span class="keyword">class </span><a class="code" href="classExtMode.html">ExtMode</a>
27 00019 <span class="keyword">public</span>:
28 <a name="l00020"></a><a class="code" href="classExtMode.html#m0">00020</a> <span class="keywordtype">char</span> <a class="code" href="classExtMode.html#m0">modechar</a>;
29 <a name="l00021"></a><a class="code" href="classExtMode.html#m1">00021</a> <span class="keywordtype">int</span> <a class="code" href="classExtMode.html#m1">type</a>;
30 <a name="l00022"></a><a class="code" href="classExtMode.html#m2">00022</a> <span class="keywordtype">bool</span> <a class="code" href="classExtMode.html#m2">default_on</a>;
31 <a name="l00023"></a><a class="code" href="classExtMode.html#m3">00023</a> <span class="keywordtype">int</span> <a class="code" href="classExtMode.html#m3">params_when_on</a>;
32 <a name="l00024"></a><a class="code" href="classExtMode.html#m4">00024</a> <span class="keywordtype">int</span> <a class="code" href="classExtMode.html#m4">params_when_off</a>;
33 <a name="l00025"></a><a class="code" href="classExtMode.html#a0">00025</a> <a class="code" href="classExtMode.html#a0">ExtMode</a>(<span class="keywordtype">char</span> mc, <span class="keywordtype">int</span> ty, <span class="keywordtype">bool</span> d_on, <span class="keywordtype">int</span> p_on, <span class="keywordtype">int</span> p_off) : modechar(mc), type(ty), default_on(d_on), params_when_on(p_on), params_when_off(p_off) { };
36 <a name="l00028"></a><a class="code" href="modules_8cpp.html#a0">00028</a> <span class="keyword">typedef</span> std::vector<ExtMode> <a class="code" href="modules_8cpp.html#a0">ExtModeList</a>;
37 <a name="l00029"></a><a class="code" href="modules_8cpp.html#a1">00029</a> <span class="keyword">typedef</span> ExtModeList::iterator <a class="code" href="modules_8cpp.html#a1">ExtModeListIter</a>;
39 <a name="l00031"></a><a class="code" href="modules_8cpp.html#a2">00031</a> <a class="code" href="modules_8cpp.html#a0">ExtModeList</a> <a class="code" href="modules_8cpp.html#a2">EMode</a>;
41 00033 <span class="comment">// returns true if an extended mode character is in use</span>
42 <a name="l00034"></a><a class="code" href="modules_8cpp.html#a4">00034</a> <span class="keywordtype">bool</span> <a class="code" href="modules_8cpp.html#a4">ModeDefined</a>(<span class="keywordtype">char</span> modechar, <span class="keywordtype">int</span> type)
44 00036 <span class="keywordflow">for</span> (<a class="code" href="modules_8cpp.html#a1">ExtModeListIter</a> i = <a class="code" href="modules_8cpp.html#a2">EMode</a>.begin(); i < <a class="code" href="modules_8cpp.html#a2">EMode</a>.end(); i++)
46 00038 <span class="keywordflow">if</span> ((i->modechar == modechar) && (i->type == type))
48 00040 <span class="keywordflow">return</span> <span class="keyword">true</span>;
51 00043 <span class="keywordflow">return</span> <span class="keyword">false</span>;
54 00046 <span class="comment">// returns number of parameters for a custom mode when it is switched on</span>
55 <a name="l00047"></a><a class="code" href="modules_8cpp.html#a5">00047</a> <span class="keywordtype">bool</span> <a class="code" href="modules_8cpp.html#a5">ModeDefinedOn</a>(<span class="keywordtype">char</span> modechar, <span class="keywordtype">int</span> type)
57 00049 <span class="keywordflow">for</span> (<a class="code" href="modules_8cpp.html#a1">ExtModeListIter</a> i = <a class="code" href="modules_8cpp.html#a2">EMode</a>.begin(); i < <a class="code" href="modules_8cpp.html#a2">EMode</a>.end(); i++)
59 00051 <span class="keywordflow">if</span> ((i->modechar == modechar) && (i->type == type))
61 00053 <span class="keywordflow">return</span> i->params_when_on;
64 00056 <span class="keywordflow">return</span> 0;
67 00059 <span class="comment">// returns number of parameters for a custom mode when it is switched on</span>
68 <a name="l00060"></a><a class="code" href="modules_8cpp.html#a6">00060</a> <span class="keywordtype">bool</span> <a class="code" href="modules_8cpp.html#a6">ModeDefinedOff</a>(<span class="keywordtype">char</span> modechar, <span class="keywordtype">int</span> type)
70 00062 <span class="keywordflow">for</span> (<a class="code" href="modules_8cpp.html#a1">ExtModeListIter</a> i = <a class="code" href="modules_8cpp.html#a2">EMode</a>.begin(); i < <a class="code" href="modules_8cpp.html#a2">EMode</a>.end(); i++)
72 00064 <span class="keywordflow">if</span> ((i->modechar == modechar) && (i->type == type))
74 00066 <span class="keywordflow">return</span> i->params_when_off;
77 00069 <span class="keywordflow">return</span> 0;
80 00072 <span class="comment">// returns true if an extended mode character is in use</span>
81 <a name="l00073"></a><a class="code" href="modules_8cpp.html#a7">00073</a> <span class="keywordtype">bool</span> <a class="code" href="modules_8cpp.html#a7">AddExtendedMode</a>(<span class="keywordtype">char</span> modechar, <span class="keywordtype">int</span> type, <span class="keywordtype">bool</span> default_on, <span class="keywordtype">int</span> params_on, <span class="keywordtype">int</span> params_off)
83 00075 <a class="code" href="modules_8cpp.html#a2">EMode</a>.push_back( <a class="code" href="classExtMode.html">ExtMode</a> (modechar,type,default_on,params_on,params_off));
84 00076 <span class="keywordflow">return</span> <span class="keyword">true</span>;
88 00080 <span class="comment">// version is a simple class for holding a modules version number</span>
90 <a name="l00082"></a><a class="code" href="classVersion.html#a0">00082</a> <a class="code" href="classVersion.html#a0">Version::Version</a>(<span class="keywordtype">int</span> major, <span class="keywordtype">int</span> minor, <span class="keywordtype">int</span> revision, <span class="keywordtype">int</span> build) : Major(major), Minor(minor), Revision(revision), Build(build) { };
92 00084 <span class="comment">// admin is a simple class for holding a server's administrative info</span>
94 <a name="l00086"></a><a class="code" href="classAdmin.html#a0">00086</a> <a class="code" href="classAdmin.html#a0">Admin::Admin</a>(std::string name, std::string email, std::string nick) : Name(name), Email(email), Nick(nick) { };
96 <a name="l00088"></a><a class="code" href="classModule.html#a0">00088</a> <a class="code" href="classModule.html#a0">Module::Module</a>() { }
97 <a name="l00089"></a><a class="code" href="classModule.html#a1">00089</a> <a class="code" href="classModule.html#a1">Module::~Module</a>() { }
98 <a name="l00090"></a><a class="code" href="classModule.html#a3">00090</a> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a3">Module::OnUserConnect</a>(<a class="code" href="classuserrec.html">userrec</a>* user) { }
99 <a name="l00091"></a><a class="code" href="classModule.html#a4">00091</a> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a4">Module::OnUserQuit</a>(<a class="code" href="classuserrec.html">userrec</a>* user) { }
100 <a name="l00092"></a><a class="code" href="classModule.html#a5">00092</a> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a5">Module::OnUserJoin</a>(<a class="code" href="classuserrec.html">userrec</a>* user, <a class="code" href="classchanrec.html">chanrec</a>* channel) { }
101 <a name="l00093"></a><a class="code" href="classModule.html#a6">00093</a> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a6">Module::OnUserPart</a>(<a class="code" href="classuserrec.html">userrec</a>* user, <a class="code" href="classchanrec.html">chanrec</a>* channel) { }
102 00094 <span class="keywordtype">void</span> Module::OnPacketTransmit(<span class="keywordtype">char</span> *p) { }
103 00095 <span class="keywordtype">void</span> Module::OnPacketReceive(<span class="keywordtype">char</span> *p) { }
104 <a name="l00096"></a><a class="code" href="classModule.html#a9">00096</a> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a9">Module::OnRehash</a>() { }
105 <a name="l00097"></a><a class="code" href="classModule.html#a10">00097</a> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a10">Module::OnServerRaw</a>(std::string &raw, <span class="keywordtype">bool</span> inbound) { }
106 <a name="l00098"></a><a class="code" href="classModule.html#a11">00098</a> <span class="keywordtype">bool</span> <a class="code" href="classModule.html#a11">Module::OnExtendedMode</a>(<a class="code" href="classuserrec.html">userrec</a>* user, <a class="code" href="classchanrec.html">chanrec</a>* chan, <span class="keywordtype">char</span> modechar, <span class="keywordtype">int</span> type, <span class="keywordtype">bool</span> mode_on, string_list &params) { }
107 <a name="l00099"></a><a class="code" href="classModule.html#a2">00099</a> <a class="code" href="classVersion.html">Version</a> <a class="code" href="classModule.html#a2">Module::GetVersion</a>() { <span class="keywordflow">return</span> <a class="code" href="classVersion.html">Version</a>(1,0,0,0); }
109 00101 <span class="comment">// server is a wrapper class that provides methods to all of the C-style</span>
110 00102 <span class="comment">// exports in the core</span>
111 00103 <span class="comment">//</span>
113 <a name="l00105"></a><a class="code" href="classServer.html#a0">00105</a> <a class="code" href="classServer.html#a0">Server::Server</a>()
117 <a name="l00109"></a><a class="code" href="classServer.html#a1">00109</a> <a class="code" href="classServer.html#a1">Server::~Server</a>()
121 <a name="l00113"></a><a class="code" href="classServer.html#a2">00113</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a2">Server::SendOpers</a>(std::string s)
123 00115 WriteOpers(<span class="stringliteral">"%s"</span>,s.c_str());
126 <a name="l00118"></a><a class="code" href="classServer.html#a3">00118</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a3">Server::Log</a>(<span class="keywordtype">int</span> level, std::string s)
128 00120 log(level,<span class="stringliteral">"%s"</span>,s.c_str());
131 <a name="l00123"></a><a class="code" href="classServer.html#a20">00123</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a20">Server::AddCommand</a>(<span class="keywordtype">char</span>* cmd, handlerfunc f, <span class="keywordtype">char</span> flags, <span class="keywordtype">int</span> minparams)
133 00125 <a class="code" href="modules_8h.html#a12">createcommand</a>(cmd,f,flags,minparams);
137 <a name="l00129"></a><a class="code" href="classServer.html#a4">00129</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a4">Server::Send</a>(<span class="keywordtype">int</span> Socket, std::string s)
139 00131 Write(Socket,<span class="stringliteral">"%s"</span>,s.c_str());
142 <a name="l00134"></a><a class="code" href="classServer.html#a5">00134</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a5">Server::SendServ</a>(<span class="keywordtype">int</span> Socket, std::string s)
144 00136 WriteServ(Socket,<span class="stringliteral">"%s"</span>,s.c_str());
147 <a name="l00139"></a><a class="code" href="classServer.html#a6">00139</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a6">Server::SendFrom</a>(<span class="keywordtype">int</span> Socket, <a class="code" href="classuserrec.html">userrec</a>* User, std::string s)
149 00141 WriteFrom(Socket,User,<span class="stringliteral">"%s"</span>,s.c_str());
152 <a name="l00144"></a><a class="code" href="classServer.html#a7">00144</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a7">Server::SendTo</a>(<a class="code" href="classuserrec.html">userrec</a>* Source, <a class="code" href="classuserrec.html">userrec</a>* Dest, std::string s)
154 00146 WriteTo(Source,Dest,<span class="stringliteral">"%s"</span>,s.c_str());
157 <a name="l00149"></a><a class="code" href="classServer.html#a8">00149</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a8">Server::SendChannel</a>(<a class="code" href="classuserrec.html">userrec</a>* User, <a class="code" href="classchanrec.html">chanrec</a>* Channel, std::string s,<span class="keywordtype">bool</span> IncludeSender)
159 00151 <span class="keywordflow">if</span> (IncludeSender)
161 00153 WriteChannel(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str());
163 00155 <span class="keywordflow">else</span>
165 00157 ChanExceptSender(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str());
169 <a name="l00161"></a><a class="code" href="classServer.html#a9">00161</a> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a9">Server::CommonChannels</a>(<a class="code" href="classuserrec.html">userrec</a>* u1, <a class="code" href="classuserrec.html">userrec</a>* u2)
171 00163 <span class="keywordflow">return</span> (common_channels(u1,u2) != 0);
174 <a name="l00166"></a><a class="code" href="classServer.html#a10">00166</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a10">Server::SendCommon</a>(<a class="code" href="classuserrec.html">userrec</a>* User, std::string text,<span class="keywordtype">bool</span> IncludeSender)
176 00168 <span class="keywordflow">if</span> (IncludeSender)
178 00170 WriteCommon(User,<span class="stringliteral">"%s"</span>,text.c_str());
180 00172 <span class="keywordflow">else</span>
182 00174 WriteCommonExcept(User,<span class="stringliteral">"%s"</span>,text.c_str());
186 <a name="l00178"></a><a class="code" href="classServer.html#a11">00178</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a11">Server::SendWallops</a>(<a class="code" href="classuserrec.html">userrec</a>* User, std::string text)
188 00180 WriteWallOps(User,<span class="stringliteral">"%s"</span>,text.c_str());
191 <a name="l00183"></a><a class="code" href="classServer.html#a12">00183</a> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a12">Server::IsNick</a>(std::string nick)
193 00185 <span class="keywordflow">return</span> (isnick(nick.c_str()) != 0);
196 <a name="l00188"></a><a class="code" href="classServer.html#a13">00188</a> <a class="code" href="classuserrec.html">userrec</a>* <a class="code" href="classServer.html#a13">Server::FindNick</a>(std::string nick)
198 00190 <span class="keywordflow">return</span> Find(nick);
201 <a name="l00193"></a><a class="code" href="classServer.html#a14">00193</a> <a class="code" href="classchanrec.html">chanrec</a>* <a class="code" href="classServer.html#a14">Server::FindChannel</a>(std::string channel)
203 00195 <span class="keywordflow">return</span> FindChan(channel.c_str());
206 <a name="l00198"></a><a class="code" href="classServer.html#a15">00198</a> std::string <a class="code" href="classServer.html#a15">Server::ChanMode</a>(<a class="code" href="classuserrec.html">userrec</a>* User, <a class="code" href="classchanrec.html">chanrec</a>* Chan)
208 00200 <span class="keywordflow">return</span> cmode(User,Chan);
211 <a name="l00203"></a><a class="code" href="classServer.html#a16">00203</a> std::string <a class="code" href="classServer.html#a16">Server::GetServerName</a>()
213 00205 <span class="keywordflow">return</span> getservername();
216 <a name="l00208"></a><a class="code" href="classServer.html#a17">00208</a> std::string <a class="code" href="classServer.html#a17">Server::GetNetworkName</a>()
218 00210 <span class="keywordflow">return</span> getnetworkname();
221 <a name="l00213"></a><a class="code" href="classServer.html#a18">00213</a> <a class="code" href="classAdmin.html">Admin</a> <a class="code" href="classServer.html#a18">Server::GetAdmin</a>()
223 00215 <span class="keywordflow">return</span> <a class="code" href="classAdmin.html">Admin</a>(getadminname(),getadminemail(),getadminnick());
228 <a name="l00220"></a><a class="code" href="classServer.html#a19">00220</a> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a19">Server::AddExtendedMode</a>(<span class="keywordtype">char</span> modechar, <span class="keywordtype">int</span> type, <span class="keywordtype">bool</span> default_on, <span class="keywordtype">int</span> params_when_on, <span class="keywordtype">int</span> params_when_off)
233 <a name="l00225"></a><a class="code" href="classConfigReader.html#a0">00225</a> <a class="code" href="classConfigReader.html#a0">ConfigReader::ConfigReader</a>()
235 00227 <a class="code" href="classConfigReader.html#n0">fname</a> = CONFIG_FILE;
239 <a name="l00231"></a><a class="code" href="classConfigReader.html#a2">00231</a> <a class="code" href="classConfigReader.html#a2">ConfigReader::~ConfigReader</a>()
244 <a name="l00236"></a><a class="code" href="classConfigReader.html#a1">00236</a> <a class="code" href="classConfigReader.html#a0">ConfigReader::ConfigReader</a>(std::string filename) : fname(filename) { };
246 <a name="l00238"></a><a class="code" href="classConfigReader.html#a3">00238</a> std::string <a class="code" href="classConfigReader.html#a3">ConfigReader::ReadValue</a>(std::string tag, std::string name, <span class="keywordtype">int</span> index)
248 00240 <span class="keywordtype">char</span> val[MAXBUF];
249 00241 ReadConf(<a class="code" href="classConfigReader.html#n0">fname</a>.c_str(),tag.c_str(),name.c_str(),index,val);
250 00242 <span class="keywordflow">return</span> val;
254 <a name="l00246"></a><a class="code" href="classConfigReader.html#a4">00246</a> <span class="keywordtype">int</span> <a class="code" href="classConfigReader.html#a4">ConfigReader::Enumerate</a>(std::string tag)
256 00248 <span class="keywordflow">return</span> EnumConf(<a class="code" href="classConfigReader.html#n0">fname</a>.c_str(),tag.c_str());
260 <a name="l00252"></a><a class="code" href="classConfigReader.html#a5">00252</a> <span class="keywordtype">bool</span> <a class="code" href="classConfigReader.html#a5">ConfigReader::Verify</a>()
262 00254 <span class="keywordflow">return</span> <span class="keyword">true</span>;
266 <a name="l00258"></a><a class="code" href="classFileReader.html#a1">00258</a> <a class="code" href="classFileReader.html#a0">FileReader::FileReader</a>(std::string filename)
268 00260 <a class="code" href="modules_8h.html#a9">file_cache</a> c;
269 00261 readfile(c,filename.c_str());
270 00262 this-><a class="code" href="classFileReader.html#o0">fc</a> = c;
273 <a name="l00265"></a><a class="code" href="classFileReader.html#a0">00265</a> <a class="code" href="classFileReader.html#a0">FileReader::FileReader</a>()
277 <a name="l00269"></a><a class="code" href="classFileReader.html#a3">00269</a> <span class="keywordtype">void</span> <a class="code" href="classFileReader.html#a3">FileReader::LoadFile</a>(std::string filename)
279 00271 <a class="code" href="modules_8h.html#a9">file_cache</a> c;
280 00272 readfile(c,filename.c_str());
281 00273 this-><a class="code" href="classFileReader.html#o0">fc</a> = c;
285 <a name="l00277"></a><a class="code" href="classFileReader.html#a2">00277</a> <a class="code" href="classFileReader.html#a2">FileReader::~FileReader</a>()
289 <a name="l00281"></a><a class="code" href="classFileReader.html#a4">00281</a> <span class="keywordtype">bool</span> <a class="code" href="classFileReader.html#a4">FileReader::Exists</a>()
291 00283 <span class="keywordflow">if</span> (<a class="code" href="classFileReader.html#o0">fc</a>.size() == 0)
293 00285 <span class="keywordflow">return</span>(false);
295 00287 <span class="keywordflow">else</span>
297 00289 <span class="keywordflow">return</span>(true);
301 <a name="l00293"></a><a class="code" href="classFileReader.html#a5">00293</a> std::string <a class="code" href="classFileReader.html#a5">FileReader::GetLine</a>(<span class="keywordtype">int</span> x)
303 00295 <span class="keywordflow">if</span> ((x<0) || (x><a class="code" href="classFileReader.html#o0">fc</a>.size()))
304 00296 <span class="keywordflow">return</span> <span class="stringliteral">""</span>;
305 00297 <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#o0">fc</a>[x];
308 <a name="l00300"></a><a class="code" href="classFileReader.html#a6">00300</a> <span class="keywordtype">int</span> <a class="code" href="classFileReader.html#a6">FileReader::FileSize</a>()
310 00302 <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#o0">fc</a>.size();
314 00306 std::vector<Module*> <a class="code" href="modules_8cpp.html#a8">modules</a>(255);
315 00307 std::vector<ircd_module*> <a class="code" href="modules_8cpp.html#a9">factory</a>(255);
317 <a name="l00309"></a><a class="code" href="modules_8cpp.html#a3">00309</a> <span class="keywordtype">int</span> <a class="code" href="modules_8cpp.html#a3">MODCOUNT</a> = -1;
320 </pre></div><hr><address style="align: right;"><small>Generated on Fri Apr 2 13:37:27 2004 for InspIRCd by
321 <a href="http://www.doxygen.org/index.html">
322 <img src="doxygen.png" alt="doxygen" align="middle" border=0
323 width=110 height=53></a>1.3-rc3 </small></address>