1 #ifndef INSPIRCD_SQLAPI_2
2 #define INSPIRCD_SQLAPI_2
10 * This is the voodoo magic which lets us pass multiple
11 * parameters to the SQLrequest constructor... voodoo...
13 #define SQLreq(a, b, c, d, e...) SQLrequest(a, b, c, (SQLquery(d), ##e))
15 /** Identifiers used to identify Request types
17 #define SQLREQID "SQLv2 Request"
18 #define SQLRESID "SQLv2 Result"
19 #define SQLSUCCESS "You shouldn't be reading this (success)"
21 /** Defines the error types which SQLerror may be set to
23 enum SQLerrorNum { NO_ERROR, BAD_DBID, BAD_CONN, QSEND_FAIL, QREPLY_FAIL };
25 /** A list of format parameters for an SQLquery object.
27 typedef std::deque<std::string> ParamL;
29 /** The base class of SQL exceptions
31 class SQLexception : public ModuleException
34 SQLexception(const std::string &reason) : ModuleException(reason)
38 SQLexception() : ModuleException("SQLv2: Undefined exception")
43 /** An exception thrown when a bad column or row name or id is requested
45 class SQLbadColName : public SQLexception
48 SQLbadColName() : SQLexception("SQLv2: Bad column name")
53 /** SQLerror holds the error state of any SQLrequest or SQLresult.
54 * The error string varies from database software to database software
55 * and should be used to display informational error messages to users.
57 class SQLerror : public classbase
66 /** Initialize an SQLerror
67 * @param i The error ID to set
68 * @param s The (optional) error string to set
70 SQLerror(SQLerrorNum i = NO_ERROR, const std::string &s = "")
75 /** Return the ID of the error
82 /** Set the ID of an error
83 * @param i The new error ID to set
84 * @return the ID which was set
86 SQLerrorNum Id(SQLerrorNum i)
92 /** Set the error string for an error
93 * @param s The new error string to set
95 void Str(const std::string &s)
100 /** Return the error string for an error
112 return "Invalid database ID";
114 return "Invalid connection";
116 return "Sending query failed";
118 return "Getting query result failed";
120 return "Unknown error";
125 /** SQLquery provides a way to represent a query string, and its parameters in a type-safe way.
126 * C++ has no native type-safe way of having a variable number of arguments to a function,
127 * the workaround for this isn't easy to describe simply, but in a nutshell what's really
128 * happening when - from the above example - you do this:
130 * SQLrequest foo = SQLreq(this, target, "databaseid", "SELECT (foo, bar) FROM rawr WHERE foo = '?' AND bar = ?", "Hello", "42");
132 * what's actually happening is functionally this:
134 * SQLrequest foo = SQLreq(this, target, "databaseid", query("SELECT (foo, bar) FROM rawr WHERE foo = '?' AND bar = ?").addparam("Hello").addparam("42"));
136 * with 'query()' returning a reference to an object with a 'addparam()' member function which
137 * in turn returns a reference to that object. There are actually four ways you can create a
138 * SQLrequest..all have their disadvantages and advantages. In the real implementations the
139 * 'query()' function is replaced by the constructor of another class 'SQLquery' which holds
140 * the query string and a ParamL (std::deque<std::string>) of query parameters.
141 * This is essentially the same as the above example except 'addparam()' is replaced by operator,(). The full syntax for this method is:
143 * SQLrequest foo = SQLrequest(this, target, "databaseid", (SQLquery("SELECT.. ?"), parameter, parameter));
148 /** The query 'format string'
151 /** The query parameter list
152 * There should be one parameter for every ? character
153 * within the format string shown above.
157 /** Initialize an SQLquery with a given format string only
159 SQLquery(const std::string &query)
164 /** Initialize an SQLquery with a format string and parameters.
165 * If you provide parameters, you must initialize the list yourself
166 * if you choose to do it via this method, using std::deque::push_back().
168 SQLquery(const std::string &query, const ParamL ¶ms)
169 : q(query), p(params)
173 /** An overloaded operator for pushing parameters onto the parameter list
175 SQLquery& operator,(const std::string &foo)
181 /** An overloaded operator for pushing parameters onto the parameter list.
182 * This has higher precedence than 'operator,' and can save on parenthesis.
184 SQLquery& operator%(const std::string &foo)
191 /** SQLrequest is sent to the SQL API to command it to run a query and return the result.
192 * You must instantiate this object with a valid SQLquery object and its parameters, then
193 * send it using its Send() method to the module providing the 'SQL' feature. To find this
194 * module, use Server::FindFeature().
196 class SQLrequest : public Request
199 /** The fully parsed and expanded query string
200 * This is initialized from the SQLquery parameter given in the constructor.
203 /** The database ID to apply the request to
206 /** True if this is a priority query.
207 * Priority queries may 'queue jump' in the request queue.
210 /** The query ID, assigned by the SQL api.
211 * After your request is processed, this will
212 * be initialized for you by the API to a valid request ID,
213 * except in the case of an error.
216 /** If an error occured, error.id will be any other value than NO_ERROR.
220 /** Initialize an SQLrequest.
223 * SQLrequest req = SQLreq(MyMod, SQLModule, dbid, "INSERT INTO ircd_log_actors VALUES('','?')", nick);
225 * @param s A pointer to the sending module, where the result should be routed
226 * @param d A pointer to the receiving module, identified as implementing the 'SQL' feature
227 * @param databaseid The database ID to perform the query on. This must match a valid
228 * database ID from the configuration of the SQL module.
229 * @param q A properly initialized SQLquery object.
231 SQLrequest(Module* s, Module* d, const std::string &databaseid, const SQLquery &q)
232 : Request(s, d, SQLREQID), query(q), dbid(databaseid), pri(false), id(0)
236 /** Set the priority of a request.
238 void Priority(bool p = true)
243 /** Set the source of a request. You should not need to use this method.
245 void SetSource(Module* mod)
252 * This class contains a field's data plus a way to determine if the field
253 * is NULL or not without having to mess around with NULL pointers.
264 * If the field was null
268 /** Initialize an SQLfield
270 SQLfield(const std::string &data = "", bool n = false)
277 /** A list of items which make up a row of a result or table (tuple)
278 * This does not include field names.
280 typedef std::vector<SQLfield> SQLfieldList;
281 /** A list of items which make up a row of a result or table (tuple)
282 * This also includes the field names.
284 typedef std::map<std::string, SQLfield> SQLfieldMap;
286 /** SQLresult is a reply to a previous query.
287 * If you send a query to the SQL api, the response will arrive at your
288 * OnRequest method of your module at some later time, depending on the
289 * congestion of the SQL server and complexity of the query. The ID of
290 * this result will match the ID assigned to your original request.
291 * SQLresult contains its own internal cursor (row counter) which is
292 * incremented with each method call which retrieves a single row.
294 class SQLresult : public Request
297 /** The original query string passed initially to the SQL API
300 /** The database ID the query was executed on
304 * The error (if any) which occured.
305 * If an error occured the value of error.id will be any
306 * other value than NO_ERROR.
310 * This will match query ID you were given when sending
311 * the request at an earlier time.
315 /** Used by the SQL API to instantiate an SQLrequest
317 SQLresult(Module* s, Module* d, unsigned long i)
318 : Request(s, d, SQLRESID), id(i)
323 * Return the number of rows in the result
324 * Note that if you have perfomed an INSERT
325 * or UPDATE query or other query which will
326 * not return rows, this will return the
327 * number of affected rows, and SQLresult::Cols()
328 * will contain 0. In this case you SHOULD NEVER
329 * access any of the result set rows, as there arent any!
330 * @returns Number of rows in the result set.
332 virtual int Rows() = 0;
335 * Return the number of columns in the result.
336 * If you performed an UPDATE or INSERT which
337 * does not return a dataset, this value will
339 * @returns Number of columns in the result set.
341 virtual int Cols() = 0;
344 * Get a string name of the column by an index number
345 * @param column The id number of a column
346 * @returns The column name associated with the given ID
348 virtual std::string ColName(int column) = 0;
351 * Get an index number for a column from a string name.
352 * An exception of type SQLbadColName will be thrown if
353 * the name given is invalid.
354 * @param column The column name to get the ID of
355 * @returns The ID number of the column provided
357 virtual int ColNum(const std::string &column) = 0;
360 * Get a string value in a given row and column
361 * This does not effect the internal cursor.
362 * @returns The value stored at [row,column] in the table
364 virtual SQLfield GetValue(int row, int column) = 0;
367 * Return a list of values in a row, this should
368 * increment an internal counter so you can repeatedly
369 * call it until it returns an empty vector.
370 * This returns a reference to an internal object,
371 * the same object is used for all calls to this function
372 * and therefore the return value is only valid until
373 * you call this function again. It is also invalid if
374 * the SQLresult object is destroyed.
375 * The internal cursor (row counter) is incremented by one.
376 * @returns A reference to the current row's SQLfieldList
378 virtual SQLfieldList& GetRow() = 0;
381 * As above, but return a map indexed by key name.
382 * The internal cursor (row counter) is incremented by one.
383 * @returns A reference to the current row's SQLfieldMap
385 virtual SQLfieldMap& GetRowMap() = 0;
388 * Like GetRow(), but returns a pointer to a dynamically
389 * allocated object which must be explicitly freed. For
390 * portability reasons this must be freed with SQLresult::Free()
391 * The internal cursor (row counter) is incremented by one.
392 * @returns A newly-allocated SQLfieldList
394 virtual SQLfieldList* GetRowPtr() = 0;
397 * As above, but return a map indexed by key name
398 * The internal cursor (row counter) is incremented by one.
399 * @returns A newly-allocated SQLfieldMap
401 virtual SQLfieldMap* GetRowMapPtr() = 0;
404 * Overloaded function for freeing the lists and maps
405 * returned by GetRowPtr or GetRowMapPtr.
406 * @param fm The SQLfieldMap to free
408 virtual void Free(SQLfieldMap* fm) = 0;
411 * Overloaded function for freeing the lists and maps
412 * returned by GetRowPtr or GetRowMapPtr.
413 * @param fl The SQLfieldList to free
415 virtual void Free(SQLfieldList* fl) = 0;