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

   1 /*
   2    Bacula® - The Network Backup Solution
   3
   4    Copyright (C) 2000-2010 Free Software Foundation Europe e.V.
   5
   6    The main author of Bacula is Kern Sibbald, with contributions from
   7    many others, a complete list can be found in the file AUTHORS.
   8    This program is Free Software; you can redistribute it and/or
   9    modify it under the terms of version two of the GNU General Public
  10    License as published by the Free Software Foundation and included
  11    in the file LICENSE.
  12
  13    This program is distributed in the hope that it will be useful, but
  14    WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16    General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program; if not, write to the Free Software
  20    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21    02110-1301, USA.
  22
  23    Bacula® is a registered trademark of Kern Sibbald.
  24    The licensor of Bacula is the Free Software Foundation Europe
  25    (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
  26    Switzerland, email:ftf@fsfeurope.org.
  27 */
  28 /*
  29  * SQL header file
  30  *
  31  *   by Kern E. Sibbald
  32  *
  33  *   Anyone who accesses the database will need to include
  34  *   this file.
  35  *
  36  * This file contains definitions common to sql.c and
  37  * the external world, and definitions destined only
  38  * for the external world. This is control with
  39  * the define __SQL_C, which is defined only in sql.c
  40  *
  41  */
  42
  43 /*
  44    Here is how database versions work.
  45
  46    While I am working on a new release with database changes, the
  47    update scripts are in the src/cats directory under the names
  48    update_xxx_tables.in.  Most of the time, I make database updates
  49    in one go and immediately update the version, but not always.  If
  50    there are going to be several updates as is the case with version
  51    1.37, then I will often forgo changing the version until the last
  52    update otherwise I will end up with too many versions and a lot
  53    of confusion.
  54
  55    When I am pretty sure there will be no more updates, I will
  56    change the version from 8 to 9 (in the present case), and when I
  57    am 100% sure there will be no more changes, the update script
  58    will be copied to the updatedb directory with the correct name
  59    (in the present case 8 to 9).
  60
  61    Now, in principle, each of the different DB implementations
  62    can have a different version, but in practice they are all
  63    the same (simplifies things). The exception is the internal
  64    database, which is no longer used, and hence, no longer changes.
  65  */
  66
  67
  68 #ifndef __SQL_H_
  69 #define __SQL_H_ 1
  70
  71 enum {
  72    SQL_TYPE_MYSQL      = 0,
  73    SQL_TYPE_POSTGRESQL = 1,
  74    SQL_TYPE_SQLITE     = 2,
  75    SQL_TYPE_SQLITE3    = 3,
  76    SQL_TYPE_INGRES     = 4
  77 };
  78
  79
  80 typedef void (DB_LIST_HANDLER)(void *, const char *);
  81 typedef int (DB_RESULT_HANDLER)(void *, int, char **);
  82
  83 #define db_lock(mdb)   _db_lock(__FILE__, __LINE__, mdb)
  84 #define db_unlock(mdb) _db_unlock(__FILE__, __LINE__, mdb)
  85
  86 #ifdef __SQL_C
  87
  88 #if defined(BUILDING_CATS)
  89 #ifdef HAVE_SQLITE
  90 #error "SQLite2 is now deprecated, use SQLite3 instead."
  91
  92 #define BDB_VERSION 12
  93
  94 #include <sqlite.h>
  95
  96 /* Define opaque structure for sqlite */
  97 struct sqlite {
  98    char dummy;
  99 };
 100
 101 #define IS_NUM(x)             ((x) == 1)
 102 #define IS_NOT_NULL(x)        ((x) == 1)
 103
 104 typedef struct s_sql_field {
 105    char *name;                        /* name of column */
 106    int length;                        /* length */
 107    int max_length;                    /* max length */
 108    uint32_t type;                     /* type */
 109    uint32_t flags;                    /* flags */
 110 } SQL_FIELD;
 111
 112 /*
 113  * This is the "real" definition that should only be
 114  * used inside sql.c and associated database interface
 115  * subroutines.
 116  *                    S Q L I T E
 117  */
 118 struct B_DB {
 119    dlink link;                        /* queue control */
 120    brwlock_t lock;                    /* transaction lock */
 121    struct sqlite *db;
 122    char **result;
 123    int status;
 124    int nrow;                          /* nrow returned from sqlite */
 125    int ncolumn;                       /* ncolum returned from sqlite */
 126    int num_rows;                      /* used by code */
 127    int row;                           /* seek row */
 128    int field;                         /* seek field */
 129    SQL_FIELD **fields;                /* defined fields */
 130    int ref_count;
 131    char *db_name;
 132    char *db_user;
 133    char *db_address;                  /* host name address */
 134    char *db_socket;                   /* socket for local access */
 135    char *db_password;
 136    int  db_port;                      /* port for host name address */
 137    bool connected;                    /* connection made to db */
 138    bool have_insert_id;               /* do not have insert id */
 139    bool fields_defined;               /* set when fields defined */
 140    char *sqlite_errmsg;               /* error message returned by sqlite */
 141    POOLMEM *errmsg;                   /* nicely edited error message */
 142    POOLMEM *cmd;                      /* SQL command string */
 143    POOLMEM *cached_path;              /* cached path name */
 144    int cached_path_len;               /* length of cached path */
 145    uint32_t cached_path_id;           /* cached path id */
 146    bool allow_transactions;           /* transactions allowed */
 147    bool transaction;                  /* transaction started */
 148    int changes;                       /* changes during transaction */
 149    POOLMEM *fname;                    /* Filename only */
 150    POOLMEM *path;                     /* Path only */
 151    POOLMEM *esc_name;                 /* Escaped file name */
 152    POOLMEM *esc_path;                 /* Escaped path name */
 153    int fnl;                           /* file name length */
 154    int pnl;                           /* path name length */
 155 };
 156
 157
 158 /*
 159  * "Generic" names for easier conversion
 160  *
 161  *                    S Q L I T E
 162  */
 163 #define sql_store_result(x)   (x)->result
 164 #define sql_free_result(x)    my_sqlite_free_table(x)
 165 #define sql_fetch_row(x)      my_sqlite_fetch_row(x)
 166 #define sql_query(x, y)       my_sqlite_query((x), (y))
 167 #ifdef HAVE_SQLITE3
 168 #define sql_insert_id(x,y)    sqlite3_last_insert_rowid((x)->db)
 169 #define sql_close(x)          sqlite3_close((x)->db)
 170 #define sql_affected_rows(x)  sqlite3_changes((x)->db)
 171 #else
 172 #define sql_insert_id(x,y)    sqlite_last_insert_rowid((x)->db)
 173 #define sql_close(x)          sqlite_close((x)->db)
 174 #define sql_affected_rows(x)  1
 175 #endif
 176 #define sql_strerror(x)       (x)->sqlite_errmsg?(x)->sqlite_errmsg:"unknown"
 177 #define sql_num_rows(x)       (x)->nrow
 178 #define sql_data_seek(x, i)   (x)->row = (i)
 179 #define sql_field_seek(x, y)  my_sqlite_field_seek((x), (y))
 180 #define sql_fetch_field(x)    my_sqlite_fetch_field(x)
 181 #define sql_num_fields(x)     ((x)->ncolumn)
 182 #define SQL_ROW               char**
 183 #define SQL_MATCH             "MATCH"
 184
 185 #define sql_batch_start(x,y)    my_batch_start(x,y)
 186 #define sql_batch_end(x,y,z)    my_batch_end(x,y,z)
 187 #define sql_batch_insert(x,y,z) my_batch_insert(x,y,z)
 188 #define sql_batch_lock_path_query       my_sqlite_batch_lock_query
 189 #define sql_batch_lock_filename_query   my_sqlite_batch_lock_query
 190 #define sql_batch_unlock_tables_query   my_sqlite_batch_unlock_query
 191 #define sql_batch_fill_filename_query   my_sqlite_batch_fill_filename_query
 192 #define sql_batch_fill_path_query       my_sqlite_batch_fill_path_query
 193
 194 /* In cats/sqlite.c */
 195 void       my_sqlite_free_table(B_DB *mdb);
 196 SQL_ROW    my_sqlite_fetch_row(B_DB *mdb);
 197 int        my_sqlite_query(B_DB *mdb, const char *cmd);
 198 void       my_sqlite_field_seek(B_DB *mdb, int field);
 199 SQL_FIELD *my_sqlite_fetch_field(B_DB *mdb);
 200 extern const char* my_sqlite_batch_lock_query;
 201 extern const char* my_sqlite_batch_unlock_query;
 202 extern const char* my_sqlite_batch_fill_filename_query;
 203 extern const char* my_sqlite_batch_fill_path_query;
 204
 205
 206 #else
 207
 208 /*                    S Q L I T E 3            */
 209
 210
 211 #ifdef HAVE_SQLITE3
 212
 213
 214 #define BDB_VERSION 12
 215
 216 #include <sqlite3.h>
 217
 218 /* Define opaque structure for sqlite */
 219 struct sqlite3 {
 220    char dummy;
 221 };
 222
 223 #define IS_NUM(x)             ((x) == 1)
 224 #define IS_NOT_NULL(x)        ((x) == 1)
 225
 226 typedef struct s_sql_field {
 227    char *name;                        /* name of column */
 228    int length;                        /* length */
 229    int max_length;                    /* max length */
 230    uint32_t type;                     /* type */
 231    uint32_t flags;                    /* flags */
 232 } SQL_FIELD;
 233
 234 /*
 235  * This is the "real" definition that should only be
 236  * used inside sql.c and associated database interface
 237  * subroutines.
 238  *                    S Q L I T E
 239  */
 240 struct B_DB {
 241    dlink link;                        /* queue control */
 242    brwlock_t lock;                    /* transaction lock */
 243    struct sqlite3 *db;
 244    char **result;
 245    int status;
 246    int nrow;                          /* nrow returned from sqlite */
 247    int ncolumn;                       /* ncolum returned from sqlite */
 248    int num_rows;                      /* used by code */
 249    int row;                           /* seek row */
 250    int field;                         /* seek field */
 251    SQL_FIELD **fields;                /* defined fields */
 252    int ref_count;
 253    char *db_name;
 254    char *db_user;
 255    char *db_address;                  /* host name address */
 256    char *db_socket;                   /* socket for local access */
 257    char *db_password;
 258    int  db_port;                      /* port for host name address */
 259    bool connected;                    /* connection made to db */
 260    bool have_insert_id;               /* do not have insert id */
 261    bool fields_defined;               /* set when fields defined */
 262    char *sqlite_errmsg;               /* error message returned by sqlite */
 263    POOLMEM *errmsg;                   /* nicely edited error message */
 264    POOLMEM *cmd;                      /* SQL command string */
 265    POOLMEM *cached_path;              /* cached path name */
 266    int cached_path_len;               /* length of cached path */
 267    uint32_t cached_path_id;           /* cached path id */
 268    bool allow_transactions;           /* transactions allowed */
 269    bool transaction;                  /* transaction started */
 270    int changes;                       /* changes during transaction */
 271    POOLMEM *fname;                    /* Filename only */
 272    POOLMEM *path;                     /* Path only */
 273    POOLMEM *esc_name;                 /* Escaped file name */
 274    POOLMEM *esc_path;                 /* Escaped path name */
 275    int fnl;                           /* file name length */
 276    int pnl;                           /* path name length */
 277 };
 278
 279 /*
 280  * Conversion of sqlite 2 names to sqlite3
 281  */
 282 #define sqlite_last_insert_rowid sqlite3_last_insert_rowid
 283 #define sqlite_open sqlite3_open
 284 #define sqlite_close sqlite3_close
 285 #define sqlite_result sqlite3_result
 286 #define sqlite_exec sqlite3_exec
 287 #define sqlite_get_table sqlite3_get_table
 288 #define sqlite_free_table sqlite3_free_table
 289
 290
 291 /*
 292  * "Generic" names for easier conversion
 293  *
 294  *                    S Q L I T E 3
 295  */
 296 #define sql_store_result(x)   (x)->result
 297 #define sql_free_result(x)    my_sqlite_free_table(x)
 298 #define sql_fetch_row(x)      my_sqlite_fetch_row(x)
 299 #define sql_query(x, y)       my_sqlite_query((x), (y))
 300 #ifdef HAVE_SQLITE3
 301 #define sql_insert_id(x,y)    sqlite3_last_insert_rowid((x)->db)
 302 #define sql_close(x)          sqlite3_close((x)->db)
 303 #else
 304 #define sql_insert_id(x,y)    sqlite_last_insert_rowid((x)->db)
 305 #define sql_close(x)          sqlite_close((x)->db)
 306 #endif
 307 #define sql_strerror(x)       (x)->sqlite_errmsg?(x)->sqlite_errmsg:"unknown"
 308 #define sql_num_rows(x)       (x)->nrow
 309 #define sql_data_seek(x, i)   (x)->row = (i)
 310 #define sql_affected_rows(x)  sqlite3_changes((x)->db)
 311 #define sql_field_seek(x, y)  my_sqlite_field_seek((x), (y))
 312 #define sql_fetch_field(x)    my_sqlite_fetch_field(x)
 313 #define sql_num_fields(x)     ((x)->ncolumn)
 314 #define sql_batch_start(x,y)    my_batch_start(x,y)
 315 #define sql_batch_end(x,y,z)    my_batch_end(x,y,z)
 316 #define sql_batch_insert(x,y,z) my_batch_insert(x,y,z)
 317 #define SQL_ROW               char**
 318 #define SQL_MATCH             "MATCH"
 319 #define sql_batch_lock_path_query       my_sqlite_batch_lock_query
 320 #define sql_batch_lock_filename_query   my_sqlite_batch_lock_query
 321 #define sql_batch_unlock_tables_query   my_sqlite_batch_unlock_query
 322 #define sql_batch_fill_filename_query   my_sqlite_batch_fill_filename_query
 323 #define sql_batch_fill_path_query       my_sqlite_batch_fill_path_query
 324
 325 /* In cats/sqlite.c */
 326 void       my_sqlite_free_table(B_DB *mdb);
 327 SQL_ROW    my_sqlite_fetch_row(B_DB *mdb);
 328 int        my_sqlite_query(B_DB *mdb, const char *cmd);
 329 void       my_sqlite_field_seek(B_DB *mdb, int field);
 330 SQL_FIELD *my_sqlite_fetch_field(B_DB *mdb);
 331 extern const char* my_sqlite_batch_lock_query;
 332 extern const char* my_sqlite_batch_unlock_query;
 333 extern const char* my_sqlite_batch_fill_filename_query;
 334 extern const char* my_sqlite_batch_fill_path_query;
 335
 336
 337 #else
 338
 339 #ifdef HAVE_MYSQL
 340
 341 #define BDB_VERSION 12
 342
 343 #include <mysql.h>
 344
 345 /*
 346  * This is the "real" definition that should only be
 347  * used inside sql.c and associated database interface
 348  * subroutines.
 349  *
 350  *                     M Y S Q L
 351  */
 352 struct B_DB {
 353    dlink link;                        /* queue control */
 354    brwlock_t lock;                    /* transaction lock */
 355    MYSQL mysql;
 356    MYSQL *db;
 357    MYSQL_RES *result;
 358    int status;
 359    my_ulonglong num_rows;
 360    int ref_count;
 361    char *db_name;
 362    char *db_user;
 363    char *db_password;
 364    char *db_address;                  /* host address */
 365    char *db_socket;                   /* socket for local access */
 366    int db_port;                       /* port of host address */
 367    int have_insert_id;                /* do have insert_id() */
 368    bool connected;
 369    POOLMEM *errmsg;                   /* nicely edited error message */
 370    POOLMEM *cmd;                      /* SQL command string */
 371    POOLMEM *cached_path;
 372    int cached_path_len;               /* length of cached path */
 373    uint32_t cached_path_id;
 374    bool allow_transactions;           /* transactions allowed */
 375    int changes;                       /* changes made to db */
 376    POOLMEM *fname;                    /* Filename only */
 377    POOLMEM *path;                     /* Path only */
 378    POOLMEM *esc_name;                 /* Escaped file name */
 379    POOLMEM *esc_path;                 /* Escaped path name */
 380    int fnl;                           /* file name length */
 381    int pnl;                           /* path name length */
 382 };
 383
 384 #define DB_STATUS int
 385
 386 /* "Generic" names for easier conversion */
 387 #define sql_store_result(x)   mysql_store_result((x)->db)
 388 #define sql_use_result(x)     mysql_use_result((x)->db)
 389 #define sql_free_result(x)    my_mysql_free_result(x)
 390 #define sql_fetch_row(x)      mysql_fetch_row((x)->result)
 391 #define sql_query(x, y)       mysql_query((x)->db, (y))
 392 #define sql_strerror(x)       mysql_error((x)->db)
 393 #define sql_num_rows(x)       mysql_num_rows((x)->result)
 394 #define sql_data_seek(x, i)   mysql_data_seek((x)->result, (i))
 395 #define sql_affected_rows(x)  mysql_affected_rows((x)->db)
 396 #define sql_insert_id(x,y)    mysql_insert_id((x)->db)
 397 #define sql_field_seek(x, y)  mysql_field_seek((x)->result, (y))
 398 #define sql_fetch_field(x)    mysql_fetch_field((x)->result)
 399 #define sql_num_fields(x)     (int)mysql_num_fields((x)->result)
 400 #define SQL_ROW               MYSQL_ROW
 401 #define SQL_FIELD             MYSQL_FIELD
 402 #define SQL_MATCH             "MATCH"
 403
 404 #define sql_batch_start(x,y)    my_batch_start(x,y)
 405 #define sql_batch_end(x,y,z)    my_batch_end(x,y,z)
 406 #define sql_batch_insert(x,y,z) my_batch_insert(x,y,z)
 407 #define sql_batch_lock_path_query       my_mysql_batch_lock_path_query
 408 #define sql_batch_lock_filename_query   my_mysql_batch_lock_filename_query
 409 #define sql_batch_unlock_tables_query   my_mysql_batch_unlock_tables_query
 410 #define sql_batch_fill_filename_query   my_mysql_batch_fill_filename_query
 411 #define sql_batch_fill_path_query       my_mysql_batch_fill_path_query
 412
 413
 414 extern const char* my_mysql_batch_lock_path_query;
 415 extern const char* my_mysql_batch_lock_filename_query;
 416 extern const char* my_mysql_batch_unlock_tables_query;
 417 extern const char* my_mysql_batch_fill_filename_query;
 418 extern const char* my_mysql_batch_fill_path_query;
 419 extern void  my_mysql_free_result(B_DB *mdb);
 420
 421 #else
 422
 423 #ifdef HAVE_POSTGRESQL
 424
 425 #define BDB_VERSION 12
 426
 427 #include <libpq-fe.h>
 428
 429 /* TEMP: the following is taken from select OID, typname from pg_type; */
 430 #define IS_NUM(x)        ((x) == 20 || (x) == 21 || (x) == 23 || (x) == 700 || (x) == 701)
 431 #define IS_NOT_NULL(x)   ((x) == 1)
 432
 433 typedef char **POSTGRESQL_ROW;
 434 typedef struct pg_field {
 435    char         *name;
 436    int           max_length;
 437    unsigned int  type;
 438    unsigned int  flags;       // 1 == not null
 439 } POSTGRESQL_FIELD;
 440
 441
 442 /*
 443  * This is the "real" definition that should only be
 444  * used inside sql.c and associated database interface
 445  * subroutines.
 446  *
 447  *                     P O S T G R E S Q L
 448  */
 449 struct B_DB {
 450    dlink link;                        /* queue control */
 451    brwlock_t lock;                    /* transaction lock */
 452    PGconn *db;
 453    PGresult *result;
 454    int status;
 455    POSTGRESQL_ROW row;
 456    POSTGRESQL_FIELD *fields;
 457    int num_rows;
 458    int row_size;                  /* size of malloced rows */
 459    int num_fields;
 460    int fields_size;               /* size of malloced fields */
 461    int row_number;                /* row number from my_postgresql_data_seek */
 462    int field_number;              /* field number from my_postgresql_field_seek */
 463    int ref_count;
 464    char *db_name;
 465    char *db_user;
 466    char *db_password;
 467    char *db_address;              /* host address */
 468    char *db_socket;               /* socket for local access */
 469    int db_port;                   /* port of host address */
 470    int have_insert_id;            /* do have insert_id() */
 471    bool connected;
 472    POOLMEM *errmsg;               /* nicely edited error message */
 473    POOLMEM *cmd;                  /* SQL command string */
 474    POOLMEM *cached_path;
 475    int cached_path_len;           /* length of cached path */
 476    uint32_t cached_path_id;
 477    bool allow_transactions;       /* transactions allowed */
 478    bool transaction;              /* transaction started */
 479    int changes;                   /* changes made to db */
 480    POOLMEM *fname;                /* Filename only */
 481    POOLMEM *path;                 /* Path only */
 482    POOLMEM *esc_name;             /* Escaped file name */
 483    POOLMEM *esc_path;             /* Escaped path name */
 484    int fnl;                       /* file name length */
 485    int pnl;                       /* path name length */
 486 };
 487
 488 void               my_postgresql_free_result(B_DB *mdb);
 489 POSTGRESQL_ROW     my_postgresql_fetch_row  (B_DB *mdb);
 490 int                my_postgresql_query      (B_DB *mdb, const char *query);
 491 void               my_postgresql_data_seek  (B_DB *mdb, int row);
 492 int                my_postgresql_currval    (B_DB *mdb, const char *table_name);
 493 void               my_postgresql_field_seek (B_DB *mdb, int row);
 494 POSTGRESQL_FIELD * my_postgresql_fetch_field(B_DB *mdb);
 495
 496 int my_postgresql_batch_start(JCR *jcr, B_DB *mdb);
 497 int my_postgresql_batch_end(JCR *jcr, B_DB *mdb, const char *error);
 498 typedef struct ATTR_DBR ATTR_DBR;
 499 int my_postgresql_batch_insert(JCR *jcr, B_DB *mdb, ATTR_DBR *ar);
 500 char *my_postgresql_copy_escape(char *dest, char *src, size_t len);
 501
 502 extern const char* my_pg_batch_lock_path_query;
 503 extern const char* my_pg_batch_lock_filename_query;
 504 extern const char* my_pg_batch_unlock_tables_query;
 505 extern const char* my_pg_batch_fill_filename_query;
 506 extern const char* my_pg_batch_fill_path_query;
 507
 508 /* "Generic" names for easier conversion */
 509 #define sql_store_result(x)   ((x)->result)
 510 #define sql_free_result(x)    my_postgresql_free_result(x)
 511 #define sql_fetch_row(x)      my_postgresql_fetch_row(x)
 512 #define sql_query(x, y)       my_postgresql_query((x), (y))
 513 #define sql_close(x)          PQfinish((x)->db)
 514 #define sql_strerror(x)       PQerrorMessage((x)->db)
 515 #define sql_num_rows(x)       ((unsigned) PQntuples((x)->result))
 516 #define sql_data_seek(x, i)   my_postgresql_data_seek((x), (i))
 517 #define sql_affected_rows(x)  ((unsigned) atoi(PQcmdTuples((x)->result)))
 518 #define sql_insert_id(x,y)    my_postgresql_currval((x), (y))
 519 #define sql_field_seek(x, y)  my_postgresql_field_seek((x), (y))
 520 #define sql_fetch_field(x)    my_postgresql_fetch_field(x)
 521 #define sql_num_fields(x)     ((x)->num_fields)
 522
 523 #define sql_batch_start(x,y)    my_postgresql_batch_start(x,y)
 524 #define sql_batch_end(x,y,z)    my_postgresql_batch_end(x,y,z)
 525 #define sql_batch_insert(x,y,z) my_postgresql_batch_insert(x,y,z)
 526 #define sql_batch_lock_path_query       my_pg_batch_lock_path_query
 527 #define sql_batch_lock_filename_query   my_pg_batch_lock_filename_query
 528 #define sql_batch_unlock_tables_query   my_pg_batch_unlock_tables_query
 529 #define sql_batch_fill_filename_query   my_pg_batch_fill_filename_query
 530 #define sql_batch_fill_path_query       my_pg_batch_fill_path_query
 531
 532 #define SQL_ROW               POSTGRESQL_ROW
 533 #define SQL_FIELD             POSTGRESQL_FIELD
 534 #define SQL_MATCH             "~"
 535
 536 #else
 537
 538 #ifdef HAVE_INGRES
 539
 540 #include "myingres.h"
 541
 542 #define BDB_VERSION 11
 543
 544 /* TEMP: the following is taken from select OID, typname from pg_type; */ /*SRE: huh? */
 545 #define IS_NUM(x)        ((x) == 20 || (x) == 21 || (x) == 23 || (x) == 700 || (x) == 701)
 546 #define IS_NOT_NULL(x)   ((x) == 1)
 547
 548 typedef char **INGRES_ROW;
 549
 550 /*
 551  * This is the "real" definition that should only be
 552  * used inside sql.c and associated database interface
 553  * subroutines.
 554  *
 555  *                     I N G R E S
 556  */
 557 struct B_DB {
 558    dlink link;                        /* queue control */
 559    brwlock_t lock;                    /* transaction lock */
 560    INGconn *db;
 561    INGresult *result;
 562    int status;
 563    INGRES_ROW row;
 564    INGRES_FIELD *fields;
 565    int num_rows;
 566    int row_size;                  /* size of malloced rows */
 567    int num_fields;
 568    int fields_size;               /* size of malloced fields */
 569    int row_number;                /* row number from my_ingres_data_seek */
 570    int field_number;              /* field number from my_ingres_field_seek */
 571    int ref_count;
 572    char *db_name;
 573    char *db_user;
 574    char *db_password;
 575    char *db_address;              /* host address */
 576    char *db_socket;               /* socket for local access */
 577    int db_port;                   /* port of host address */
 578    int have_insert_id;            /* do have insert_id() */
 579    bool connected;
 580    POOLMEM *errmsg;               /* nicely edited error message */
 581    POOLMEM *cmd;                  /* SQL command string */
 582    POOLMEM *cached_path;
 583    int cached_path_len;           /* length of cached path */
 584    uint32_t cached_path_id;
 585    bool allow_transactions;       /* transactions allowed */
 586    bool transaction;              /* transaction started */
 587    int changes;                   /* changes made to db */
 588    POOLMEM *fname;                /* Filename only */
 589    POOLMEM *path;                 /* Path only */
 590    POOLMEM *esc_name;             /* Escaped file name */
 591    POOLMEM *esc_path;             /* Escaped path name */
 592    int fnl;                       /* file name length */
 593    int pnl;                       /* path name length */
 594 };
 595
 596 void               my_ingres_free_result(B_DB *mdb);
 597 INGRES_ROW         my_ingres_fetch_row  (B_DB *mdb);
 598 int                my_ingres_query      (B_DB *mdb, const char *query);
 599 void               my_ingres_data_seek  (B_DB *mdb, int row);
 600 int                my_ingres_currval    (B_DB *mdb, const char *table_name);
 601 void               my_ingres_field_seek (B_DB *mdb, int row);
 602 INGRES_FIELD *     my_ingres_fetch_field(B_DB *mdb);
 603 void               my_ingres_close      (B_DB *mdb);
 604
 605 int my_ingres_batch_start(JCR *jcr, B_DB *mdb);
 606 int my_ingres_batch_end(JCR *jcr, B_DB *mdb, const char *error);
 607 typedef struct ATTR_DBR ATTR_DBR;
 608 int my_ingres_batch_insert(JCR *jcr, B_DB *mdb, ATTR_DBR *ar);
 609 char *my_ingres_copy_escape(char *dest, char *src, size_t len);
 610
 611 extern const char* my_ingres_batch_lock_path_query;
 612 extern const char* my_ingres_batch_lock_filename_query;
 613 extern const char* my_ingres_batch_unlock_tables_query;
 614 extern const char* my_ingres_batch_fill_filename_query;
 615 extern const char* my_ingres_batch_fill_path_query;
 616
 617 /* "Generic" names for easier conversion */
 618 #define sql_store_result(x)   ((x)->result)
 619 #define sql_free_result(x)    my_ingres_free_result(x)
 620 #define sql_fetch_row(x)      my_ingres_fetch_row(x)
 621 #define sql_query(x, y)       my_ingres_query((x), (y))
 622 #define sql_close(x)          my_ingres_close(x)
 623 #define sql_strerror(x)       INGerrorMessage((x)->db)
 624 #define sql_num_rows(x)       ((unsigned) INGntuples((x)->result))
 625 #define sql_data_seek(x, i)   my_ingres_data_seek((x), (i))
 626 #define sql_affected_rows(x)  ((x)->num_rows)
 627 #define sql_insert_id(x,y)    my_ingres_currval((x), (y))
 628 #define sql_field_seek(x, y)  my_ingres_field_seek((x), (y))
 629 #define sql_fetch_field(x)    my_ingres_fetch_field(x)
 630 #define sql_num_fields(x)     ((x)->num_fields)
 631
 632 #define sql_batch_start(x,y)    my_ingres_batch_start(x,y)
 633 #define sql_batch_end(x,y,z)    my_ingres_batch_end(x,y,z)
 634 #define sql_batch_insert(x,y,z) my_ingres_batch_insert(x,y,z)
 635 #define sql_batch_lock_path_query       my_ingres_batch_lock_path_query
 636 #define sql_batch_lock_filename_query   my_ingres_batch_lock_filename_query
 637 #define sql_batch_unlock_tables_query   my_ingres_batch_unlock_tables_query
 638 #define sql_batch_fill_filename_query   my_ingres_batch_fill_filename_query
 639 #define sql_batch_fill_path_query       my_ingres_batch_fill_path_query
 640
 641 #define SQL_ROW               INGRES_ROW
 642 #define SQL_FIELD             INGRES_FIELD
 643 #define SQL_MATCH             "~"
 644
 645 #else
 646
 647 #ifdef HAVE_DBI
 648
 649 #define BDB_VERSION 12
 650
 651 #include <dbi/dbi.h>
 652
 653 #ifdef HAVE_BATCH_FILE_INSERT
 654 #include <dbi/dbi-dev.h>
 655 #endif //HAVE_BATCH_FILE_INSERT
 656
 657 #define IS_NUM(x)        ((x) == 1 || (x) == 2 )
 658 #define IS_NOT_NULL(x)   ((x) == (1 << 0))
 659
 660 typedef char **DBI_ROW;
 661 typedef struct dbi_field {
 662    char         *name;
 663    int           max_length;
 664    unsigned int  type;
 665    unsigned int  flags;       // 1 == not null
 666 } DBI_FIELD;
 667
 668 typedef struct dbi_field_get {
 669    dlink link;
 670    char *value;
 671 } DBI_FIELD_GET;
 672
 673 /*
 674  * This is the "real" definition that should only be
 675  * used inside sql.c and associated database interface
 676  * subroutines.
 677  *
 678  *                     D B I
 679  */
 680 struct B_DB {
 681    dlink link;                        /* queue control */
 682    brwlock_t lock;                    /* transaction lock */
 683    dbi_conn *db;
 684    dbi_result *result;
 685    dbi_inst instance;
 686    dbi_error_flag status;
 687    DBI_ROW row;
 688    DBI_FIELD *fields;
 689    DBI_FIELD_GET *field_get;
 690    int num_rows;
 691    int row_size;                  /* size of malloced rows */
 692    int num_fields;
 693    int fields_size;               /* size of malloced fields */
 694    int row_number;                /* row number from my_postgresql_data_seek */
 695    int field_number;              /* field number from my_postgresql_field_seek */
 696    int ref_count;
 697    int db_type;                   /* DBI driver defined */
 698    char *db_driverdir ;           /* DBI driver dir */
 699    char *db_driver;               /* DBI type database */
 700    char *db_name;
 701    char *db_user;
 702    char *db_password;
 703    char *db_address;              /* host address */
 704    char *db_socket;               /* socket for local access */
 705    int db_port;                   /* port of host address */
 706    int have_insert_id;            /* do have insert_id() */
 707    bool connected;
 708    POOLMEM *errmsg;               /* nicely edited error message */
 709    POOLMEM *cmd;                  /* SQL command string */
 710    POOLMEM *cached_path;
 711    int cached_path_len;           /* length of cached path */
 712    uint32_t cached_path_id;
 713    bool allow_transactions;       /* transactions allowed */
 714    bool transaction;              /* transaction started */
 715    int changes;                   /* changes made to db */
 716    POOLMEM *fname;                /* Filename only */
 717    POOLMEM *path;                 /* Path only */
 718    POOLMEM *esc_name;             /* Escaped file name */
 719    POOLMEM *esc_path;             /* Escaped path name */
 720    int fnl;                       /* file name length */
 721    int pnl;                       /* path name length */
 722 };
 723
 724 void               my_dbi_free_result(B_DB *mdb);
 725 DBI_ROW            my_dbi_fetch_row  (B_DB *mdb);
 726 int                my_dbi_query      (B_DB *mdb, const char *query);
 727 void               my_dbi_data_seek  (B_DB *mdb, int row);
 728 void               my_dbi_field_seek (B_DB *mdb, int row);
 729 DBI_FIELD *        my_dbi_fetch_field(B_DB *mdb);
 730 const char *       my_dbi_strerror   (B_DB *mdb);
 731 int                my_dbi_getisnull  (dbi_result *result, int row_number, int column_number);
 732 char *             my_dbi_getvalue   (dbi_result *result, int row_number, unsigned int column_number);
 733 //int                my_dbi_getvalue   (dbi_result *result, int row_number, unsigned int column_number, char *value);
 734 int                my_dbi_sql_insert_id(B_DB *mdb, char *table_name);
 735
 736 int my_dbi_batch_start(JCR *jcr, B_DB *mdb);
 737 int my_dbi_batch_end(JCR *jcr, B_DB *mdb, const char *error);
 738 typedef struct ATTR_DBR ATTR_DBR;
 739 int my_dbi_batch_insert(JCR *jcr, B_DB *mdb, ATTR_DBR *ar);
 740 char *my_postgresql_copy_escape(char *dest, char *src, size_t len);
 741 // typedefs for libdbi work with postgresql copy insert
 742 typedef int (*custom_function_insert_t)(void*, const char*, int);
 743 typedef char* (*custom_function_error_t)(void*);
 744 typedef int (*custom_function_end_t)(void*, const char*);
 745
 746 extern const char* my_dbi_batch_lock_path_query[5];
 747 extern const char* my_dbi_batch_lock_filename_query[5];
 748 extern const char* my_dbi_batch_unlock_tables_query[5];
 749 extern const char* my_dbi_batch_fill_filename_query[5];
 750 extern const char* my_dbi_batch_fill_path_query[5];
 751 extern const char* my_dbi_match[5];
 752
 753 /* "Generic" names for easier conversion */
 754 #define sql_store_result(x)   (x)->result
 755 #define sql_free_result(x)    my_dbi_free_result(x)
 756 #define sql_fetch_row(x)      my_dbi_fetch_row(x)
 757 #define sql_query(x, y)       my_dbi_query((x), (y))
 758 #define sql_close(x)          dbi_conn_close((x)->db)
 759 #define sql_strerror(x)       my_dbi_strerror(x)
 760 #define sql_num_rows(x)       dbi_result_get_numrows((x)->result)
 761 #define sql_data_seek(x, i)   my_dbi_data_seek((x), (i))
 762 #define SQL_MATCH             my_dbi_match[db_type]
 763 /* #define sql_affected_rows(x)  dbi_result_get_numrows_affected((x)->result) */
 764 #define sql_affected_rows(x)  1
 765 #define sql_insert_id(x,y)    my_dbi_sql_insert_id((x), (y))
 766 #define sql_field_seek(x, y)  my_dbi_field_seek((x), (y))
 767 #define sql_fetch_field(x)    my_dbi_fetch_field(x)
 768 #define sql_num_fields(x)     ((x)->num_fields)
 769 #define sql_batch_start(x,y)    my_dbi_batch_start(x,y)
 770 #define sql_batch_end(x,y,z)    my_dbi_batch_end(x,y,z)
 771 #define sql_batch_insert(x,y,z) my_dbi_batch_insert(x,y,z)
 772 #define sql_batch_lock_path_query       my_dbi_batch_lock_path_query[db_type]
 773 #define sql_batch_lock_filename_query   my_dbi_batch_lock_filename_query[db_type]
 774 #define sql_batch_unlock_tables_query   my_dbi_batch_unlock_tables_query[db_type]
 775 #define sql_batch_fill_filename_query   my_dbi_batch_fill_filename_query[db_type]
 776 #define sql_batch_fill_path_query       my_dbi_batch_fill_path_query[db_type]
 777
 778 #define SQL_ROW               DBI_ROW
 779 #define SQL_FIELD             DBI_FIELD
 780
 781 #endif /* HAVE_SQLITE3 */
 782 #endif /* HAVE_MYSQL */
 783 #endif /* HAVE_SQLITE */
 784 #endif /* HAVE_POSTGRESQL */
 785 #endif /* HAVE_INGRES */
 786 #endif /* HAVE_DBI */
 787 #endif
 788
 789 /* Use for better error location printing */
 790 #define UPDATE_DB(jcr, db, cmd) UpdateDB(__FILE__, __LINE__, jcr, db, cmd)
 791 #define INSERT_DB(jcr, db, cmd) InsertDB(__FILE__, __LINE__, jcr, db, cmd)
 792 #define QUERY_DB(jcr, db, cmd) QueryDB(__FILE__, __LINE__, jcr, db, cmd)
 793 #define DELETE_DB(jcr, db, cmd) DeleteDB(__FILE__, __LINE__, jcr, db, cmd)
 794
 795
 796 #else    /* not __SQL_C */
 797
 798 /* This is a "dummy" definition for use outside of sql.c
 799  */
 800 struct B_DB {
 801    int dummy;                         /* for SunOS compiler */
 802 };
 803
 804 #endif /*  __SQL_C */
 805
 806 /* ==============================================================
 807  *
 808  *  What follows are definitions that are used "globally" for all
 809  *   the different SQL engines and both inside and external to the
 810  *   cats directory.
 811  */
 812
 813 extern uint32_t bacula_db_version;
 814
 815 #define faddr_t long
 816
 817 /*
 818  * Structure used when calling db_get_query_ids()
 819  *  allows the subroutine to return a list of ids.
 820  */
 821 class dbid_list : public SMARTALLOC {
 822 public:
 823    DBId_t *DBId;                      /* array of DBIds */
 824    char *PurgedFiles;                 /* Array of PurgedFile flags */
 825    int num_ids;                       /* num of ids actually stored */
 826    int max_ids;                       /* size of id array */
 827    int num_seen;                      /* number of ids processed */
 828    int tot_ids;                       /* total to process */
 829
 830    dbid_list();                       /* in sql.c */
 831    ~dbid_list();                      /* in sql.c */
 832 };
 833
 834
 835
 836
 837 /* Job information passed to create job record and update
 838  * job record at end of job. Note, although this record
 839  * contains all the fields found in the Job database record,
 840  * it also contains fields found in the JobMedia record.
 841  */
 842 /* Job record */
 843 struct JOB_DBR {
 844    JobId_t JobId;
 845    char Job[MAX_NAME_LENGTH];         /* Job unique name */
 846    char Name[MAX_NAME_LENGTH];        /* Job base name */
 847    int JobType;                       /* actually char(1) */
 848    int JobLevel;                      /* actually char(1) */
 849    int JobStatus;                     /* actually char(1) */
 850    DBId_t ClientId;                   /* Id of client */
 851    DBId_t PoolId;                     /* Id of pool */
 852    DBId_t FileSetId;                  /* Id of FileSet */
 853    DBId_t PriorJobId;                 /* Id of migrated (prior) job */
 854    time_t SchedTime;                  /* Time job scheduled */
 855    time_t StartTime;                  /* Job start time */
 856    time_t EndTime;                    /* Job termination time of orig job */
 857    time_t RealEndTime;                /* Job termination time of this job */
 858    utime_t JobTDate;                  /* Backup time/date in seconds */
 859    uint32_t VolSessionId;
 860    uint32_t VolSessionTime;
 861    uint32_t JobFiles;
 862    uint32_t JobErrors;
 863    uint32_t JobMissingFiles;
 864    uint64_t JobBytes;
 865    uint64_t ReadBytes;
 866    int PurgedFiles;
 867    int HasBase;
 868
 869    /* Note, FirstIndex, LastIndex, Start/End File and Block
 870     * are only used in the JobMedia record.
 871     */
 872    uint32_t FirstIndex;               /* First index this Volume */
 873    uint32_t LastIndex;                /* Last index this Volume */
 874    uint32_t StartFile;
 875    uint32_t EndFile;
 876    uint32_t StartBlock;
 877    uint32_t EndBlock;
 878
 879    char cSchedTime[MAX_TIME_LENGTH];
 880    char cStartTime[MAX_TIME_LENGTH];
 881    char cEndTime[MAX_TIME_LENGTH];
 882    char cRealEndTime[MAX_TIME_LENGTH];
 883    /* Extra stuff not in DB */
 884    int limit;                         /* limit records to display */
 885    faddr_t rec_addr;
 886    uint32_t FileIndex;                /* added during Verify */
 887 };
 888
 889 /* Job Media information used to create the media records
 890  * for each Volume used for the job.
 891  */
 892 /* JobMedia record */
 893 struct JOBMEDIA_DBR {
 894    DBId_t JobMediaId;                 /* record id */
 895    JobId_t  JobId;                    /* JobId */
 896    DBId_t MediaId;                    /* MediaId */
 897    uint32_t FirstIndex;               /* First index this Volume */
 898    uint32_t LastIndex;                /* Last index this Volume */
 899    uint32_t StartFile;                /* File for start of data */
 900    uint32_t EndFile;                  /* End file on Volume */
 901    uint32_t StartBlock;               /* start block on tape */
 902    uint32_t EndBlock;                 /* last block */
 903 // uint32_t Copy;                     /* identical copy */
 904 };
 905
 906
 907 /* Volume Parameter structure */
 908 struct VOL_PARAMS {
 909    char VolumeName[MAX_NAME_LENGTH];  /* Volume name */
 910    char MediaType[MAX_NAME_LENGTH];   /* Media Type */
 911    char Storage[MAX_NAME_LENGTH];     /* Storage name */
 912    uint32_t VolIndex;                 /* Volume seqence no. */
 913    uint32_t FirstIndex;               /* First index this Volume */
 914    uint32_t LastIndex;                /* Last index this Volume */
 915    int32_t Slot;                      /* Slot */
 916    uint64_t StartAddr;                /* Start address */
 917    uint64_t EndAddr;                  /* End address */
 918    int32_t InChanger;                 /* InChanger flag */
 919 // uint32_t Copy;                     /* identical copy */
 920 // uint32_t Stripe;                   /* RAIT strip number */
 921 };
 922
 923
 924 /* Attributes record -- NOT same as in database because
 925  *  in general, this "record" creates multiple database
 926  *  records (e.g. pathname, filename, fileattributes).
 927  */
 928 struct ATTR_DBR {
 929    char *fname;                       /* full path & filename */
 930    char *link;                        /* link if any */
 931    char *attr;                        /* attributes statp */
 932    uint32_t FileIndex;
 933    uint32_t Stream;
 934    uint32_t FileType;
 935    JobId_t  JobId;
 936    DBId_t ClientId;
 937    DBId_t PathId;
 938    DBId_t FilenameId;
 939    FileId_t FileId;
 940    char *Digest;
 941    int DigestType;
 942 };
 943
 944
 945 /* File record -- same format as database */
 946 struct FILE_DBR {
 947    FileId_t FileId;
 948    uint32_t FileIndex;
 949    JobId_t  JobId;
 950    DBId_t FilenameId;
 951    DBId_t PathId;
 952    JobId_t  MarkId;
 953    char LStat[256];
 954    char Digest[BASE64_SIZE(CRYPTO_DIGEST_MAX_SIZE)];
 955    int DigestType;                    /* NO_SIG/MD5_SIG/SHA1_SIG */
 956 };
 957
 958 /* Pool record -- same format as database */
 959 struct POOL_DBR {
 960    DBId_t PoolId;
 961    char Name[MAX_NAME_LENGTH];        /* Pool name */
 962    uint32_t NumVols;                  /* total number of volumes */
 963    uint32_t MaxVols;                  /* max allowed volumes */
 964    int32_t LabelType;                 /* Bacula/ANSI/IBM */
 965    int32_t UseOnce;                   /* set to use once only */
 966    int32_t UseCatalog;                /* set to use catalog */
 967    int32_t AcceptAnyVolume;           /* set to accept any volume sequence */
 968    int32_t AutoPrune;                 /* set to prune automatically */
 969    int32_t Recycle;                   /* default Vol recycle flag */
 970    uint32_t ActionOnPurge;            /* action on purge, e.g. truncate the disk volume */
 971    utime_t  VolRetention;             /* retention period in seconds */
 972    utime_t  VolUseDuration;           /* time in secs volume can be used */
 973    uint32_t MaxVolJobs;               /* Max Jobs on Volume */
 974    uint32_t MaxVolFiles;              /* Max files on Volume */
 975    uint64_t MaxVolBytes;              /* Max bytes on Volume */
 976    DBId_t RecyclePoolId;              /* RecyclePool destination when media is purged */
 977    DBId_t ScratchPoolId;              /* ScratchPool source when media is needed */
 978    char PoolType[MAX_NAME_LENGTH];
 979    char LabelFormat[MAX_NAME_LENGTH];
 980    /* Extra stuff not in DB */
 981    faddr_t rec_addr;
 982 };
 983
 984 class DEVICE_DBR {
 985 public:
 986    DBId_t DeviceId;
 987    char Name[MAX_NAME_LENGTH];        /* Device name */
 988    DBId_t MediaTypeId;                /* MediaType */
 989    DBId_t StorageId;                  /* Storage id if autochanger */
 990    uint32_t DevMounts;                /* Number of times mounted */
 991    uint32_t DevErrors;                /* Number of read/write errors */
 992    uint64_t DevReadBytes;             /* Number of bytes read */
 993    uint64_t DevWriteBytes;            /* Number of bytew written */
 994    uint64_t DevReadTime;              /* time spent reading volume */
 995    uint64_t DevWriteTime;             /* time spent writing volume */
 996    uint64_t DevReadTimeSincCleaning;  /* read time since cleaning */
 997    uint64_t DevWriteTimeSincCleaning; /* write time since cleaning */
 998    time_t   CleaningDate;             /* time last cleaned */
 999    utime_t  CleaningPeriod;           /* time between cleanings */
1000 };
1001
1002 class STORAGE_DBR {
1003 public:
1004    DBId_t StorageId;
1005    char Name[MAX_NAME_LENGTH];        /* Device name */
1006    int AutoChanger;                   /* Set if autochanger */
1007
1008    /* Not in database */
1009    bool created;                      /* set if created by db_create ... */
1010 };
1011
1012 class MEDIATYPE_DBR {
1013 public:
1014    DBId_t MediaTypeId;
1015    char MediaType[MAX_NAME_LENGTH];   /* MediaType string */
1016    int ReadOnly;                      /* Set if read-only */
1017 };
1018
1019
1020 /* Media record -- same as the database */
1021 struct MEDIA_DBR {
1022    DBId_t MediaId;                    /* Unique volume id */
1023    char VolumeName[MAX_NAME_LENGTH];  /* Volume name */
1024    char MediaType[MAX_NAME_LENGTH];   /* Media type */
1025    DBId_t PoolId;                     /* Pool id */
1026    time_t   FirstWritten;             /* Time Volume first written this usage */
1027    time_t   LastWritten;              /* Time Volume last written */
1028    time_t   LabelDate;                /* Date/Time Volume labeled */
1029    time_t   InitialWrite;             /* Date/Time Volume first written */
1030    int32_t  LabelType;                /* Label (Bacula/ANSI/IBM) */
1031    uint32_t VolJobs;                  /* number of jobs on this medium */
1032    uint32_t VolFiles;                 /* Number of files */
1033    uint32_t VolBlocks;                /* Number of blocks */
1034    uint32_t VolMounts;                /* Number of times mounted */
1035    uint32_t VolErrors;                /* Number of read/write errors */
1036    uint32_t VolWrites;                /* Number of writes */
1037    uint32_t VolReads;                 /* Number of reads */
1038    uint64_t VolBytes;                 /* Number of bytes written */
1039    uint32_t VolParts;                 /* Number of parts written */
1040    uint64_t MaxVolBytes;              /* Max bytes to write to Volume */
1041    uint64_t VolCapacityBytes;         /* capacity estimate */
1042    uint64_t VolReadTime;              /* time spent reading volume */
1043    uint64_t VolWriteTime;             /* time spent writing volume */
1044    utime_t  VolRetention;             /* Volume retention in seconds */
1045    utime_t  VolUseDuration;           /* time in secs volume can be used */
1046    uint32_t ActionOnPurge;            /* action on purge, e.g. truncate the disk volume */
1047    uint32_t MaxVolJobs;               /* Max Jobs on Volume */
1048    uint32_t MaxVolFiles;              /* Max files on Volume */
1049    int32_t  Recycle;                  /* recycle yes/no */
1050    int32_t  Slot;                     /* slot in changer */
1051    int32_t  Enabled;                  /* 0=disabled, 1=enabled, 2=archived */
1052    int32_t  InChanger;                /* Volume currently in changer */
1053    DBId_t   StorageId;                /* Storage record Id */
1054    uint32_t EndFile;                  /* Last file on volume */
1055    uint32_t EndBlock;                 /* Last block on volume */
1056    uint32_t RecycleCount;             /* Number of times recycled */
1057    char     VolStatus[20];            /* Volume status */
1058    DBId_t   DeviceId;                 /* Device where Vol last written */
1059    DBId_t   LocationId;               /* Where Volume is -- user defined */
1060    DBId_t   ScratchPoolId;            /* Where to move if scratch */
1061    DBId_t   RecyclePoolId;            /* Where to move when recycled */
1062    /* Extra stuff not in DB */
1063    faddr_t rec_addr;                  /* found record address */
1064    /* Since the database returns times as strings, this is how we pass
1065     *   them back.
1066     */
1067    char    cFirstWritten[MAX_TIME_LENGTH]; /* FirstWritten returned from DB */
1068    char    cLastWritten[MAX_TIME_LENGTH];  /* LastWritten returned from DB */
1069    char    cLabelDate[MAX_TIME_LENGTH];    /* LabelData returned from DB */
1070    char    cInitialWrite[MAX_TIME_LENGTH]; /* InitialWrite returned from DB */
1071    bool    set_first_written;
1072    bool    set_label_date;
1073 };
1074
1075 /* Client record -- same as the database */
1076 struct CLIENT_DBR {
1077    DBId_t ClientId;                   /* Unique Client id */
1078    int AutoPrune;
1079    utime_t FileRetention;
1080    utime_t JobRetention;
1081    char Name[MAX_NAME_LENGTH];        /* Client name */
1082    char Uname[256];                   /* Uname for client */
1083 };
1084
1085 /* Counter record as in database */
1086 struct COUNTER_DBR {
1087    char Counter[MAX_NAME_LENGTH];
1088    int32_t MinValue;
1089    int32_t MaxValue;
1090    int32_t CurrentValue;
1091    char WrapCounter[MAX_NAME_LENGTH];
1092 };
1093
1094
1095 /* FileSet record -- same as the database */
1096 struct FILESET_DBR {
1097    DBId_t FileSetId;                  /* Unique FileSet id */
1098    char FileSet[MAX_NAME_LENGTH];     /* FileSet name */
1099    char MD5[50];                      /* MD5 signature of include/exclude */
1100    time_t CreateTime;                 /* date created */
1101    /*
1102     * This is where we return CreateTime
1103     */
1104    char cCreateTime[MAX_TIME_LENGTH]; /* CreateTime as returned from DB */
1105    /* Not in DB but returned by db_create_fileset() */
1106    bool created;                      /* set when record newly created */
1107 };
1108
1109 /* Call back context for getting a 32/64 bit value from the database */
1110 struct db_int64_ctx {
1111    int64_t value;                     /* value returned */
1112    int count;                         /* number of values seen */
1113 };
1114
1115 /* Call back context for getting a list of comma separated strings from the
1116  * database
1117  */
1118 class db_list_ctx {
1119 public:
1120    POOLMEM *list;                     /* list */
1121    int count;                         /* number of values seen */
1122
1123    db_list_ctx() { list = get_pool_memory(PM_FNAME); *list = 0; count = 0; }
1124    ~db_list_ctx() { free_pool_memory(list); list = NULL; }
1125
1126 private:
1127    db_list_ctx(const db_list_ctx&);            /* prohibit pass by value */
1128    db_list_ctx &operator=(const db_list_ctx&); /* prohibit class assignment */
1129 };
1130
1131
1132 #include "protos.h"
1133 #include "jcr.h"
1134 #include "sql_cmds.h"
1135
1136 /*
1137  * Exported globals from sql.c
1138  */
1139 extern int CATS_IMP_EXP db_type;        /* SQL engine type index */
1140
1141 /*
1142  * Some functions exported by sql.c for use within the
1143  *   cats directory.
1144  */
1145 void list_result(JCR *jcr, B_DB *mdb, DB_LIST_HANDLER *send, void *ctx, e_list_type type);
1146 void list_dashes(B_DB *mdb, DB_LIST_HANDLER *send, void *ctx);
1147 int get_sql_record_max(JCR *jcr, B_DB *mdb);
1148 bool check_tables_version(JCR *jcr, B_DB *mdb);
1149 bool db_check_max_connections(JCR *jcr, B_DB *mdb, uint32_t nb);
1150 void _db_unlock(const char *file, int line, B_DB *mdb);
1151 void _db_lock(const char *file, int line, B_DB *mdb);
1152 const char *db_get_type(void);
1153
1154 void print_dashes(B_DB *mdb);
1155 void print_result(B_DB *mdb);
1156 int QueryDB(const char *file, int line, JCR *jcr, B_DB *db, char *select_cmd);
1157 int InsertDB(const char *file, int line, JCR *jcr, B_DB *db, char *select_cmd);
1158 int DeleteDB(const char *file, int line, JCR *jcr, B_DB *db, char *delete_cmd);
1159 int UpdateDB(const char *file, int line, JCR *jcr, B_DB *db, char *update_cmd);
1160 void split_path_and_file(JCR *jcr, B_DB *mdb, const char *fname);
1161 #endif /* __SQL_H_ */