boinc/db/db_base.h

144 lines
3.9 KiB
C++

// This file is part of BOINC.
// http://boinc.berkeley.edu
// Copyright (C) 2008 University of California
//
// BOINC is free software; you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License
// as published by the Free Software Foundation,
// either version 3 of the License, or (at your option) any later version.
//
// BOINC is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
// See the GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with BOINC. If not, see <http://www.gnu.org/licenses/>.
#ifndef _DB_BASE_
#define _DB_BASE_
#include <cstdlib>
#include <string>
#include <mysql.h>
extern bool g_print_queries;
// if SQL columns are not 'not null', you must use these safe_atoi, safe_atof
// instead of atoi, atof, since the strings returned by MySQL may be NULL.
//
inline int safe_atoi(const char* s) {
if (!s) return 0;
return atoi(s);
}
inline double safe_atof(const char* s) {
if (!s) return 0;
return atof(s);
}
#define strcpy2(x, y) \
{ \
const char* z = y; \
if (!z) { \
x[0]=0; \
} else { \
strlcpy(x, z, sizeof(x)); \
} \
}
#define MAX_QUERY_LEN 262144
// TODO: use string for queries, get rid of this
struct CURSOR {
bool active;
MYSQL_RES *rp;
CURSOR() { active = false; rp = NULL; }
};
enum ISOLATION_LEVEL {
READ_UNCOMMITTED,
READ_COMMITTED,
REPEATABLE_READ,
SERIALIZABLE
};
// represents a connection to a database
//
class DB_CONN {
public:
DB_CONN();
int open(char* name, char* host, char* user, char* passwd);
int set_isolation_level(ISOLATION_LEVEL);
int do_query(const char*);
int affected_rows();
void close();
int insert_id();
void print_error(const char*);
const char* error_string();
int ping();
int start_transaction();
int rollback_transaction();
int commit_transaction();
MYSQL* mysql;
};
// Base for derived classes that can access the DB
// Defines various generic operations on DB tables
//
class DB_BASE {
public:
DB_BASE(const char *table_name, DB_CONN*);
virtual ~DB_BASE(){}
int insert();
int insert_batch(std::string&);
int update();
int update_field(const char*, const char* where_clause=NULL);
int update_fields_noid(const char* set_clause, const char* where_clause);
int delete_from_db();
int delete_from_db_multi(const char* where_clause);
int get_field_ints(const char*, int, int*);
int get_field_str(const char*, char*, int);
int lookup_id(int id);
int lookup(const char*);
int enumerate(const char* clause="", bool use_use_result=false);
int end_enumerate();
int count(int&, const char* clause="");
int max_id(int&, const char* clause="");
int sum(double&, const char* field, const char* clause="");
int get_double(const char* query, double&);
int get_integer(const char* query, int&);
int affected_rows();
DB_CONN* db;
const char *table_name;
CURSOR cursor;
virtual int get_id();
virtual void db_print(char*);
virtual void db_parse(MYSQL_ROW&);
};
// Base for derived classes that can get special-purpose data,
// perhaps spanning multiple tables
//
class DB_BASE_SPECIAL {
public:
DB_BASE_SPECIAL(DB_CONN*);
DB_CONN* db;
CURSOR cursor;
};
void escape_string(char* field, int len);
void unescape_string(char* p, int len);
void escape_mysql_like_pattern(const char* in, char* out);
// if you're going to use a "like X" clause,
// call this function to escape the non-wildcard part of X.
// If it contains wildcard chars (%, _) this will put
// two (2) backslashes before each one,
// so that they don't get treated as wildcards
#endif