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
35 /** An exception thrown when a bad column or row name or id is requested
37 class SQLbadColName : public SQLexception
43 /** SQLerror holds the error state of any SQLrequest or SQLresult.
44 * The error string varies from database software to database software
45 * and should be used to display informational error messages to users.
47 class SQLerror : public classbase
56 /** Initialize an SQLerror
57 * @param i The error ID to set
58 * @param s The (optional) error string to set
60 SQLerror(SQLerrorNum i = NO_ERROR, const std::string &s = "")
65 /** Return the ID of the error
72 /** Set the ID of an error
73 * @param i The new error ID to set
74 * @return the ID which was set
76 SQLerrorNum Id(SQLerrorNum i)
82 /** Set the error string for an error
83 * @param s The new error string to set
85 void Str(const std::string &s)
90 /** Return the error string for an error
102 return "Invalid database ID";
104 return "Invalid connection";
106 return "Sending query failed";
108 return "Getting query result failed";
110 return "Unknown error";
115 /** SQLquery provides a way to represent a query string, and its parameters in a type-safe way.
116 * C++ has no native type-safe way of having a variable number of arguments to a function,
117 * the workaround for this isn't easy to describe simply, but in a nutshell what's really
118 * happening when - from the above example - you do this:
120 * SQLrequest foo = SQLreq(this, target, "databaseid", "SELECT (foo, bar) FROM rawr WHERE foo = '?' AND bar = ?", "Hello", "42");
122 * what's actually happening is functionally this:
124 * SQLrequest foo = SQLreq(this, target, "databaseid", query("SELECT (foo, bar) FROM rawr WHERE foo = '?' AND bar = ?").addparam("Hello").addparam("42"));
126 * with 'query()' returning a reference to an object with a 'addparam()' member function which
127 * in turn returns a reference to that object. There are actually four ways you can create a
128 * SQLrequest..all have their disadvantages and advantages. In the real implementations the
129 * 'query()' function is replaced by the constructor of another class 'SQLquery' which holds
130 * the query string and a ParamL (std::deque<std::string>) of query parameters.
131 * This is essentially the same as the above example except 'addparam()' is replaced by operator,(). The full syntax for this method is:
133 * SQLrequest foo = SQLrequest(this, target, "databaseid", (SQLquery("SELECT.. ?"), parameter, parameter));
138 /** The query 'format string'
141 /** The query parameter list
142 * There should be one parameter for every ? character
143 * within the format string shown above.
147 /** Initialize an SQLquery with a given format string only
149 SQLquery(const std::string &query)
152 log(DEBUG, "SQLquery constructor: %s", q.c_str());
155 /** Initialize an SQLquery with a format string and parameters.
156 * If you provide parameters, you must initialize the list yourself
157 * if you choose to do it via this method, using std::deque::push_back().
159 SQLquery(const std::string &query, const ParamL ¶ms)
160 : q(query), p(params)
162 log(DEBUG, "SQLquery constructor with %d params: %s", p.size(), q.c_str());
165 /** An overloaded operator for pushing parameters onto the parameter list
167 SQLquery& operator,(const std::string &foo)
173 /** An overloaded operator for pushing parameters onto the parameter list.
174 * This has higher precedence than 'operator,' and can save on parenthesis.
176 SQLquery& operator%(const std::string &foo)
183 /** SQLrequest is sent to the SQL API to command it to run a query and return the result.
184 * You must instantiate this object with a valid SQLquery object and its parameters, then
185 * send it using its Send() method to the module providing the 'SQL' feature. To find this
186 * module, use Server::FindFeature().
188 class SQLrequest : public Request
191 /** The fully parsed and expanded query string
192 * This is initialized from the SQLquery parameter given in the constructor.
195 /** The database ID to apply the request to
198 /** True if this is a priority query.
199 * Priority queries may 'queue jump' in the request queue.
202 /** The query ID, assigned by the SQL api.
203 * After your request is processed, this will
204 * be initialized for you by the API to a valid request ID,
205 * except in the case of an error.
208 /** If an error occured, error.id will be any other value than NO_ERROR.
212 /** Initialize an SQLrequest.
215 * SQLrequest req = SQLreq(MyMod, SQLModule, dbid, "INSERT INTO ircd_log_actors VALUES('','?')", nick);
217 * @param s A pointer to the sending module, where the result should be routed
218 * @param d A pointer to the receiving module, identified as implementing the 'SQL' feature
219 * @param databaseid The database ID to perform the query on. This must match a valid
220 * database ID from the configuration of the SQL module.
221 * @param q A properly initialized SQLquery object.
223 SQLrequest(Module* s, Module* d, const std::string &databaseid, const SQLquery &q)
224 : Request(SQLREQID, s, d), query(q), dbid(databaseid), pri(false), id(0)
228 /** Set the priority of a request.
230 void Priority(bool p = true)
235 /** Set the source of a request. You should not need to use this method.
237 void SetSource(Module* mod)
244 * This class contains a field's data plus a way to determine if the field
245 * is NULL or not without having to mess around with NULL pointers.
256 * If the field was null
260 /** Initialize an SQLfield
262 SQLfield(const std::string &data = "", bool n = false)
269 /** A list of items which make up a row of a result or table (tuple)
270 * This does not include field names.
272 typedef std::vector<SQLfield> SQLfieldList;
273 /** A list of items which make up a row of a result or table (tuple)
274 * This also includes the field names.
276 typedef std::map<std::string, SQLfield> SQLfieldMap;
278 /** SQLresult is a reply to a previous query.
279 * If you send a query to the SQL api, the response will arrive at your
280 * OnRequest method of your module at some later time, depending on the
281 * congestion of the SQL server and complexity of the query. The ID of
282 * this result will match the ID assigned to your original request.
283 * SQLresult contains its own internal cursor (row counter) which is
284 * incremented with each method call which retrieves a single row.
286 class SQLresult : public Request
289 /** The original query string passed initially to the SQL API
292 /** The database ID the query was executed on
296 * The error (if any) which occured.
297 * If an error occured the value of error.id will be any
298 * other value than NO_ERROR.
302 * This will match query ID you were given when sending
303 * the request at an earlier time.
307 /** Used by the SQL API to instantiate an SQLrequest
309 SQLresult(Module* s, Module* d, unsigned long i)
310 : Request(SQLRESID, s, d), id(i)
315 * Return the number of rows in the result
316 * Note that if you have perfomed an INSERT
317 * or UPDATE query or other query which will
318 * not return rows, this will return the
319 * number of affected rows, and SQLresult::Cols()
320 * will contain 0. In this case you SHOULD NEVER
321 * access any of the result set rows, as there arent any!
322 * @returns Number of rows in the result set.
324 virtual int Rows() = 0;
327 * Return the number of columns in the result.
328 * If you performed an UPDATE or INSERT which
329 * does not return a dataset, this value will
331 * @returns Number of columns in the result set.
333 virtual int Cols() = 0;
336 * Get a string name of the column by an index number
337 * @param column The id number of a column
338 * @returns The column name associated with the given ID
340 virtual std::string ColName(int column) = 0;
343 * Get an index number for a column from a string name.
344 * An exception of type SQLbadColName will be thrown if
345 * the name given is invalid.
346 * @param column The column name to get the ID of
347 * @returns The ID number of the column provided
349 virtual int ColNum(const std::string &column) = 0;
352 * Get a string value in a given row and column
353 * This does not effect the internal cursor.
354 * @returns The value stored at [row,column] in the table
356 virtual SQLfield GetValue(int row, int column) = 0;
359 * Return a list of values in a row, this should
360 * increment an internal counter so you can repeatedly
361 * call it until it returns an empty vector.
362 * This returns a reference to an internal object,
363 * the same object is used for all calls to this function
364 * and therefore the return value is only valid until
365 * you call this function again. It is also invalid if
366 * the SQLresult object is destroyed.
367 * The internal cursor (row counter) is incremented by one.
368 * @returns A reference to the current row's SQLfieldList
370 virtual SQLfieldList& GetRow() = 0;
373 * As above, but return a map indexed by key name.
374 * The internal cursor (row counter) is incremented by one.
375 * @returns A reference to the current row's SQLfieldMap
377 virtual SQLfieldMap& GetRowMap() = 0;
380 * Like GetRow(), but returns a pointer to a dynamically
381 * allocated object which must be explicitly freed. For
382 * portability reasons this must be freed with SQLresult::Free()
383 * The internal cursor (row counter) is incremented by one.
384 * @returns A newly-allocated SQLfieldList
386 virtual SQLfieldList* GetRowPtr() = 0;
389 * As above, but return a map indexed by key name
390 * The internal cursor (row counter) is incremented by one.
391 * @returns A newly-allocated SQLfieldMap
393 virtual SQLfieldMap* GetRowMapPtr() = 0;
396 * Overloaded function for freeing the lists and maps
397 * returned by GetRowPtr or GetRowMapPtr.
398 * @param fm The SQLfieldMap to free
400 virtual void Free(SQLfieldMap* fm) = 0;
403 * Overloaded function for freeing the lists and maps
404 * returned by GetRowPtr or GetRowMapPtr.
405 * @param fl The SQLfieldList to free
407 virtual void Free(SQLfieldList* fl) = 0;