git.sur5r.net Git - bacula/bacula/blob - bacula/src/cats/bdb.h

   1 /*
   2    Bacula(R) - The Network Backup Solution
   3
   4    Copyright (C) 2000-2016 Kern Sibbald
   5
   6    The original author of Bacula is Kern Sibbald, with contributions
   7    from many others, a complete list can be found in the file AUTHORS.
   8
   9    You may use this file and others of this release according to the
  10    license defined in the LICENSE file, which includes the Affero General
  11    Public License, v3.0 ("AGPLv3") and some additional permissions and
  12    terms pursuant to its AGPLv3 Section 7.
  13
  14    This notice must be preserved when any source code is
  15    conveyed and/or propagated.
  16
  17    Bacula(R) is a registered trademark of Kern Sibbald.
  18 */
  19 /*
  20  *  Catalog DB Interface class
  21  *
  22  *  Written by Kern E. Sibbald
  23  *
  24  */
  25
  26 #ifndef __BDB_H_
  27 #define __BDB_H_ 1
  28
  29 class BDB: public SMARTALLOC {
  30 public:
  31    dlink m_link;                      /* queue control */
  32    brwlock_t m_lock;                  /* transaction lock */
  33    SQL_DRIVER m_db_driver_type;       /* driver type */
  34    SQL_DBTYPE m_db_type;              /* database type */
  35    char *m_db_name;                   /* database name */
  36    char *m_db_user;                   /* database user */
  37    char *m_db_address;                /* host name address */
  38    char *m_db_socket;                 /* socket for local access */
  39    char *m_db_password;               /* database password */
  40    char *m_db_driver;                 /* database driver */
  41    char *m_db_driverdir;              /* database driver dir */
  42    int m_ref_count;                   /* reference count */
  43    int m_db_port;                     /* port for host name address */
  44    char *m_db_ssl_key;                /* path name to the key file */
  45    char *m_db_ssl_cert;               /* path name to the certificate file */
  46    char *m_db_ssl_ca;                 /* path name to the certificate authority file */
  47    char *m_db_ssl_capath;             /* path name to a directory that contains trusted SSL CA certificates in PEM format */
  48    char *m_db_ssl_cipher;             /* a list of permissible ciphers to use for SSL encryption */
  49    bool m_disabled_batch_insert;      /* explicitly disabled batch insert mode ? */
  50    bool m_dedicated;                  /* is this connection dedicated? */
  51    bool m_use_fatal_jmsg;             /* use Jmsg(M_FATAL) after bad queries? */
  52    bool m_connected;                  /* connection made to db */
  53    bool m_have_batch_insert;          /* have batch insert support ? */
  54
  55    /* Cats Internal */
  56    int m_status;                      /* status */
  57    int m_num_rows;                    /* number of rows returned by last query */
  58    int m_num_fields;                  /* number of fields returned by last query */
  59    int m_rows_size;                   /* size of malloced rows */
  60    int m_fields_size;                 /* size of malloced fields */
  61    int m_row_number;                  /* row number from xx_data_seek */
  62    int m_field_number;                /* field number from sql_field_seek */
  63    SQL_ROW m_rows;                    /* defined rows */
  64    SQL_FIELD *m_fields;               /* defined fields */
  65    bool m_allow_transactions;         /* transactions allowed */
  66    bool m_transaction;                /* transaction started */
  67
  68    POOLMEM *cached_path;              /* cached path name */
  69    POOLMEM *cmd;                      /* SQL command string */
  70    POOLMEM *errmsg;                   /* nicely edited error message */
  71    POOLMEM *esc_name;                 /* Escaped file name */
  72    POOLMEM *esc_obj;                  /* Escaped restore object */
  73    POOLMEM *esc_path;                 /* Escaped path name */
  74    POOLMEM *fname;                    /* Filename only */
  75    POOLMEM *path;                     /* Path only */
  76    uint32_t cached_path_id;           /* cached path id */
  77    int cached_path_len;               /* length of cached path */
  78    int changes;                       /* changes during transaction */
  79    int fnl;                           /* file name length */
  80    int pnl;                           /* path name length */
  81
  82    /* methods */
  83    BDB() {};
  84    virtual ~BDB() {};
  85    const char *get_db_name(void) { return m_db_name; };
  86    const char *get_db_user(void) { return m_db_user; };
  87    const bool is_connected(void) { return m_connected; };
  88    const bool is_dedicated(void) { return m_dedicated; };
  89    bool use_fatal_jmsg(void) { return m_use_fatal_jmsg; };
  90    const bool batch_insert_available(void) { return m_have_batch_insert; };
  91    void set_use_fatal_jmsg(bool val) { m_use_fatal_jmsg = val; };
  92    void increment_refcount(void) { m_ref_count++; };
  93    const int bdb_get_type_index(void) { return m_db_type; };
  94    const char *bdb_get_engine_name(void);
  95
  96    BDB *bdb_clone_database_connection(JCR *jcr, bool mult_db_connections);
  97    bool bdb_match_database(const char *db_driver, const char *db_name,
  98             const char *bdb_address, int db_port);
  99    bool bdb_sql_query(const char *query, int flags=0);
 100    void bdb_lock(const char *file=__FILE__, int line=__LINE__);
 101    void bdb_unlock(const char *file=__FILE__, int line=__LINE__);
 102    void print_lock_info(FILE *fp);
 103
 104    /* sql.c */
 105    bool UpdateDB(JCR *jcr, char *cmd, const char *file=__FILE__, int line=__LINE__);
 106    bool InsertDB(JCR *jcr, char *cmd, const char *file=__FILE__, int line=__LINE__);
 107    bool QueryDB(JCR *jcr, char *cmd, const char *file=__FILE__, int line=__LINE__);
 108    int  DeleteDB(JCR *jcr, char *cmd, const char *file=__FILE__, int line=__LINE__);
 109    char *bdb_strerror() { return errmsg; };
 110    bool bdb_check_version(JCR *jcr);
 111    bool bdb_open_batch_connexion(JCR *jcr);
 112    bool bdb_check_max_connections(JCR *jcr, uint32_t max_concurrent_jobs);
 113
 114    /* sql_delete.c */
 115    int bdb_delete_pool_record(JCR *jcr, POOL_DBR *pool_dbr);
 116    int bdb_delete_media_record(JCR *jcr, MEDIA_DBR *mr);
 117    int bdb_purge_media_record(JCR *jcr, MEDIA_DBR *mr);
 118    int bdb_delete_snapshot_record(JCR *jcr, SNAPSHOT_DBR *sr);
 119
 120    /* sql_find.c */
 121    bool bdb_find_last_job_end_time(JCR *jcr, JOB_DBR *jr, POOLMEM **etime, char *job);
 122    bool bdb_find_last_job_start_time(JCR *jcr, JOB_DBR *jr, POOLMEM **stime, char *job, int JobLevel);
 123    bool bdb_find_job_start_time(JCR *jcr, JOB_DBR *jr, POOLMEM **stime, char *job);
 124    bool bdb_find_last_jobid(JCR *jcr, const char *Name, JOB_DBR *jr);
 125    int bdb_find_next_volume(JCR *jcr, int index, bool InChanger, MEDIA_DBR *mr);
 126    bool bdb_find_failed_job_since(JCR *jcr, JOB_DBR *jr, POOLMEM *stime, int &JobLevel);
 127
 128    /* sql_create.c */
 129    int bdb_create_path_record(JCR *jcr, ATTR_DBR *ar);
 130    bool bdb_create_file_attributes_record(JCR *jcr, ATTR_DBR *ar);
 131    bool bdb_create_job_record(JCR *jcr, JOB_DBR *jr);
 132    int bdb_create_media_record(JCR *jcr, MEDIA_DBR *media_dbr);
 133    int bdb_create_client_record(JCR *jcr, CLIENT_DBR *cr);
 134    bool bdb_create_fileset_record(JCR *jcr, FILESET_DBR *fsr);
 135    bool bdb_create_pool_record(JCR *jcr, POOL_DBR *pool_dbr);
 136    bool bdb_create_jobmedia_record(JCR *jcr, JOBMEDIA_DBR *jr);
 137    int bdb_create_counter_record(JCR *jcr, COUNTER_DBR *cr);
 138    bool bdb_create_device_record(JCR *jcr, DEVICE_DBR *dr);
 139    bool bdb_create_storage_record(JCR *jcr, STORAGE_DBR *sr);
 140    bool bdb_create_mediatype_record(JCR *jcr, MEDIATYPE_DBR *mr);
 141    bool bdb_create_attributes_record(JCR *jcr, ATTR_DBR *ar);
 142    bool bdb_create_restore_object_record(JCR *jcr, ROBJECT_DBR *ar);
 143    bool bdb_create_base_file_attributes_record(JCR *jcr, ATTR_DBR *ar);
 144    bool bdb_commit_base_file_attributes_record(JCR *jcr);
 145    bool bdb_create_base_file_list(JCR *jcr, char *jobids);
 146    bool bdb_create_snapshot_record(JCR *jcr, SNAPSHOT_DBR *snap);
 147    int bdb_create_file_record(JCR *jcr, ATTR_DBR *ar);
 148    int bdb_create_filename_record(JCR *jcr, ATTR_DBR *ar);
 149    bool bdb_create_batch_file_attributes_record(JCR *jcr, ATTR_DBR *ar);
 150
 151    /* sql_get.c */
 152    bool bdb_get_file_record(JCR *jcr, JOB_DBR *jr, FILE_DBR *fdbr);
 153    bool bdb_get_snapshot_record(JCR *jcr, SNAPSHOT_DBR *snap);
 154    bool bdb_get_volume_jobids(JCR *jcr,
 155             MEDIA_DBR *mr, db_list_ctx *lst);
 156    bool bdb_get_base_file_list(JCR *jcr, bool use_md5,
 157             DB_RESULT_HANDLER *result_handler,void *ctx);
 158    int bdb_get_filename_record(JCR *jcr);
 159    int bdb_get_path_record(JCR *jcr);
 160    bool bdb_get_pool_record(JCR *jcr, POOL_DBR *pdbr);
 161    bool bdb_get_pool_numvols(JCR *jcr, POOL_DBR *pdbr);
 162    int bdb_get_client_record(JCR *jcr, CLIENT_DBR *cr);
 163    bool bdb_get_job_record(JCR *jcr, JOB_DBR *jr);
 164    int bdb_get_job_volume_names(JCR *jcr, JobId_t JobId, POOLMEM **VolumeNames);
 165    bool bdb_get_file_attributes_record(JCR *jcr, char *fname, JOB_DBR *jr, FILE_DBR *fdbr);
 166    int bdb_get_fileset_record(JCR *jcr, FILESET_DBR *fsr);
 167    bool bdb_get_media_record(JCR *jcr, MEDIA_DBR *mr);
 168    int bdb_get_num_media_records(JCR *jcr);
 169    int bdb_get_num_pool_records(JCR *jcr);
 170    int bdb_get_pool_ids(JCR *jcr, int *num_ids, DBId_t **ids);
 171    int bdb_get_client_ids(JCR *jcr, int *num_ids, DBId_t **ids);
 172    bool bdb_get_media_ids(JCR *jcr, MEDIA_DBR *mr, int *num_ids, uint32_t **ids);
 173    int  bdb_get_job_volume_parameters(JCR *jcr, JobId_t JobId, VOL_PARAMS **VolParams);
 174    bool bdb_get_counter_record(JCR *jcr, COUNTER_DBR *cr);
 175    bool bdb_get_query_dbids(JCR *jcr, POOL_MEM &query, dbid_list &ids);
 176    bool bdb_get_file_list(JCR *jcr, char *jobids,
 177             bool use_md5, bool use_delta,
 178             DB_RESULT_HANDLER *result_handler, void *ctx);
 179    bool bdb_get_base_jobid(JCR *jcr, JOB_DBR *jr, JobId_t *jobid);
 180    bool bdb_get_accurate_jobids(JCR *jcr, JOB_DBR *jr, db_list_ctx *jobids);
 181    bool bdb_get_used_base_jobids(JCR *jcr, POOLMEM *jobids, db_list_ctx *result);
 182    bool bdb_get_restoreobject_record(JCR *jcr, ROBJECT_DBR *rr);
 183
 184 /* sql_list.c */
 185    void bdb_list_pool_records(JCR *jcr, POOL_DBR *pr, DB_LIST_HANDLER sendit, void *ctx, e_list_type type);
 186    alist *bdb_list_job_records(JCR *jcr, JOB_DBR *jr, DB_LIST_HANDLER sendit, void *ctx, e_list_type type);
 187    void bdb_list_job_totals(JCR *jcr, JOB_DBR *jr, DB_LIST_HANDLER sendit, void *ctx);
 188    void bdb_list_files_for_job(JCR *jcr, uint32_t jobid, DB_LIST_HANDLER sendit, void *ctx);
 189    void bdb_list_media_records(JCR *jcr, MEDIA_DBR *mdbr, DB_LIST_HANDLER *sendit, void *ctx, e_list_type type);
 190    void bdb_list_jobmedia_records(JCR *jcr, JobId_t JobId, DB_LIST_HANDLER *sendit, void *ctx, e_list_type type);
 191    void bdb_list_joblog_records(JCR *jcr, JobId_t JobId, DB_LIST_HANDLER *sendit, void *ctx, e_list_type type);
 192    int  bdb_list_sql_query(JCR *jcr, const char *query, DB_LIST_HANDLER *sendit, void *ctx, int verbose, e_list_type type);
 193    void bdb_list_client_records(JCR *jcr, DB_LIST_HANDLER *sendit, void *ctx, e_list_type type);
 194    void bdb_list_copies_records(JCR *jcr, uint32_t limit, char *jobids, DB_LIST_HANDLER *sendit, void *ctx, e_list_type type);
 195    void bdb_list_base_files_for_job(JCR *jcr, JobId_t jobid, DB_LIST_HANDLER *sendit, void *ctx);
 196    void bdb_list_restore_objects(JCR *jcr, ROBJECT_DBR *rr, DB_LIST_HANDLER *sendit, void *ctx, e_list_type type);
 197    void bdb_list_snapshot_records(JCR *jcr, SNAPSHOT_DBR *sdbr,
 198               DB_LIST_HANDLER *sendit, void *ctx, e_list_type type);
 199
 200
 201    /* sql_update.c */
 202    bool bdb_update_job_start_record(JCR *jcr, JOB_DBR *jr);
 203    int  bdb_update_job_end_record(JCR *jcr, JOB_DBR *jr);
 204    int  bdb_update_client_record(JCR *jcr, CLIENT_DBR *cr);
 205    int  bdb_update_pool_record(JCR *jcr, POOL_DBR *pr);
 206    bool bdb_update_storage_record(JCR *jcr, STORAGE_DBR *sr);
 207    int  bdb_update_media_record(JCR *jcr, MEDIA_DBR *mr);
 208    int  bdb_update_media_defaults(JCR *jcr, MEDIA_DBR *mr);
 209    int  bdb_update_counter_record(JCR *jcr, COUNTER_DBR *cr);
 210    int  bdb_add_digest_to_file_record(JCR *jcr, FileId_t FileId, char *digest, int type);
 211    int  bdb_mark_file_record(JCR *jcr, FileId_t FileId, JobId_t JobId);
 212    void bdb_make_inchanger_unique(JCR *jcr, MEDIA_DBR *mr);
 213    int  bdb_update_stats(JCR *jcr, utime_t age);
 214    bool bdb_update_snapshot_record(JCR *jcr, SNAPSHOT_DBR *sr);
 215
 216    /* Pure virtual low level methods */
 217    virtual void bdb_escape_string(JCR *jcr, char *snew, char *old, int len) = 0;
 218    virtual char *bdb_escape_object(JCR *jcr, char *old, int len) = 0;
 219    virtual void bdb_unescape_object(JCR *jcr, char *from, int32_t expected_len,
 220                    POOLMEM **dest, int32_t *len) = 0;
 221    virtual bool bdb_open_database(JCR *jcr) = 0;
 222    virtual void bdb_close_database(JCR *jcr) = 0;
 223    virtual void bdb_start_transaction(JCR *jcr) = 0;
 224    virtual void bdb_end_transaction(JCR *jcr) = 0;
 225    virtual bool bdb_sql_query(const char *query, DB_RESULT_HANDLER *result_handler, void *ctx) = 0;
 226    virtual void bdb_thread_cleanup(void) = 0;
 227
 228    /* By default, we use bdb_sql_query */
 229    virtual bool bdb_big_sql_query(const char *query,
 230                    DB_RESULT_HANDLER *result_handler, void *ctx) {
 231       return bdb_sql_query(query, result_handler, ctx);
 232    };
 233
 234    /* Cats Internal */
 235 #ifdef CATS_PRIVATE_DBI
 236    int sql_num_rows(void) { return m_num_rows; };
 237    void sql_field_seek(int field) { m_field_number = field; };
 238    int sql_num_fields(void) { return m_num_fields; };
 239    virtual void sql_free_result(void) = 0;
 240    virtual SQL_ROW sql_fetch_row(void) = 0;
 241    virtual bool sql_query(const char *query, int flags=0) = 0;
 242    virtual const char *sql_strerror(void) = 0;
 243    virtual void sql_data_seek(int row) = 0;
 244    virtual int sql_affected_rows(void) = 0;
 245    virtual uint64_t sql_insert_autokey_record(const char *query, const char *table_name) = 0;
 246    virtual SQL_FIELD *sql_fetch_field(void) = 0;
 247    virtual bool sql_field_is_not_null(int field_type) = 0;
 248    virtual bool sql_field_is_numeric(int field_type) = 0;
 249    virtual bool sql_batch_start(JCR *jcr) = 0;
 250    virtual bool sql_batch_end(JCR *jcr, const char *error) = 0;
 251    virtual bool sql_batch_insert(JCR *jcr, ATTR_DBR *ar) = 0;
 252 #endif
 253 };
 254
 255 #endif /* __Bbdb_H_ */