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

   1 /*
   2    Bacula® - The Network Backup Solution
   3
   4    Copyright (C) 2000-2007 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 plus additions
  11    that are listed 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 John Walker.
  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  *    Version $Id$
  42  */
  43
  44 /*
  45    Here is how database versions work.
  46
  47    While I am working on a new release with database changes, the
  48    update scripts are in the src/cats directory under the names
  49    update_xxx_tables.in.  Most of the time, I make database updates
  50    in one go and immediately update the version, but not always.  If
  51    there are going to be several updates as is the case with version
  52    1.37, then I will often forgo changing the version until the last
  53    update otherwise I will end up with too many versions and a lot
  54    of confusion.
  55
  56    When I am pretty sure there will be no more updates, I will
  57    change the version from 8 to 9 (in the present case), and when I
  58    am 100% sure there will be no more changes, the update script
  59    will be copied to the updatedb directory with the correct name
  60    (in the present case 8 to 9).
  61
  62    Now, in principle, each of the different DB implementations
  63    can have a different version, but in practice they are all
  64    the same (simplifies things). The exception is the internal
  65    database, which is no longer used, and hence, no longer changes.
  66  */
  67
  68
  69 #ifndef __SQL_H_
  70 #define __SQL_H_ 1
  71
  72
  73 typedef void (DB_LIST_HANDLER)(void *, const char *);
  74 typedef int (DB_RESULT_HANDLER)(void *, int, char **);
  75
  76 #define db_lock(mdb)   _db_lock(__FILE__, __LINE__, mdb)
  77 #define db_unlock(mdb) _db_unlock(__FILE__, __LINE__, mdb)
  78
  79 #ifdef __SQL_C
  80
  81 #if defined(BUILDING_CATS)
  82 #ifdef HAVE_SQLITE
  83
  84 #define BDB_VERSION 10
  85
  86 #include <sqlite.h>
  87
  88 /* Define opaque structure for sqlite */
  89 struct sqlite {
  90    char dummy;
  91 };
  92
  93 #define IS_NUM(x)             ((x) == 1)
  94 #define IS_NOT_NULL(x)        ((x) == 1)
  95
  96 typedef struct s_sql_field {
  97    char *name;                        /* name of column */
  98    int length;                        /* length */
  99    int max_length;                    /* max length */
 100    uint32_t type;                     /* type */
 101    uint32_t flags;                    /* flags */
 102 } SQL_FIELD;
 103
 104 /*
 105  * This is the "real" definition that should only be
 106  * used inside sql.c and associated database interface
 107  * subroutines.
 108  *                    S Q L I T E
 109  */
 110 struct B_DB {
 111    BQUEUE bq;                         /* queue control */
 112    brwlock_t lock;                    /* transaction lock */
 113    struct sqlite *db;
 114    char **result;
 115    int status;
 116    int nrow;                          /* nrow returned from sqlite */
 117    int ncolumn;                       /* ncolum returned from sqlite */
 118    int num_rows;                      /* used by code */
 119    int row;                           /* seek row */
 120    int field;                         /* seek field */
 121    SQL_FIELD **fields;                /* defined fields */
 122    int ref_count;
 123    char *db_name;
 124    char *db_user;
 125    char *db_address;                  /* host name address */
 126    char *db_socket;                   /* socket for local access */
 127    char *db_password;
 128    int  db_port;                      /* port for host name address */
 129    bool connected;                    /* connection made to db */
 130    bool have_insert_id;               /* do not have insert id */
 131    bool fields_defined;               /* set when fields defined */
 132    char *sqlite_errmsg;               /* error message returned by sqlite */
 133    POOLMEM *errmsg;                   /* nicely edited error message */
 134    POOLMEM *cmd;                      /* SQL command string */
 135    POOLMEM *cached_path;              /* cached path name */
 136    int cached_path_len;               /* length of cached path */
 137    uint32_t cached_path_id;           /* cached path id */
 138    bool allow_transactions;           /* transactions allowed */
 139    bool transaction;                  /* transaction started */
 140    int changes;                       /* changes during transaction */
 141    POOLMEM *fname;                    /* Filename only */
 142    POOLMEM *path;                     /* Path only */
 143    POOLMEM *esc_name;                 /* Escaped file name */
 144    POOLMEM *esc_name2;                /* Escaped path name */
 145    int fnl;                           /* file name length */
 146    int pnl;                           /* path name length */
 147 };
 148
 149
 150 /*
 151  * "Generic" names for easier conversion
 152  *
 153  *                    S Q L I T E
 154  */
 155 #define sql_store_result(x)   (x)->result
 156 #define sql_free_result(x)    my_sqlite_free_table(x)
 157 #define sql_fetch_row(x)      my_sqlite_fetch_row(x)
 158 #define sql_query(x, y)       my_sqlite_query((x), (y))
 159 #ifdef HAVE_SQLITE3
 160 #define sql_insert_id(x,y)    sqlite3_last_insert_rowid((x)->db)
 161 #define sql_close(x)          sqlite3_close((x)->db)
 162 #else
 163 #define sql_insert_id(x,y)    sqlite_last_insert_rowid((x)->db)
 164 #define sql_close(x)          sqlite_close((x)->db)
 165 #endif
 166 #define sql_strerror(x)       (x)->sqlite_errmsg?(x)->sqlite_errmsg:"unknown"
 167 #define sql_num_rows(x)       (x)->nrow
 168 #define sql_data_seek(x, i)   (x)->row = (i)
 169 #define sql_affected_rows(x)  1
 170 #define sql_field_seek(x, y)  my_sqlite_field_seek((x), (y))
 171 #define sql_fetch_field(x)    my_sqlite_fetch_field(x)
 172 #define sql_num_fields(x)     ((x)->ncolumn)
 173 #define SQL_ROW               char**
 174
 175 #define sql_batch_start(x,y)    my_batch_start(x,y)
 176 #define sql_batch_end(x,y,z)    my_batch_end(x,y,z)
 177 #define sql_batch_insert(x,y,z) my_batch_insert(x,y,z)
 178 #define sql_batch_lock_path_query       my_sqlite_batch_lock_query
 179 #define sql_batch_lock_filename_query   my_sqlite_batch_lock_query
 180 #define sql_batch_unlock_tables_query   my_sqlite_batch_unlock_query
 181 #define sql_batch_fill_filename_query   my_sqlite_batch_fill_filename_query
 182 #define sql_batch_fill_path_query       my_sqlite_batch_fill_path_query
 183
 184 /* In cats/sqlite.c */
 185 void       my_sqlite_free_table(B_DB *mdb);
 186 SQL_ROW    my_sqlite_fetch_row(B_DB *mdb);
 187 int        my_sqlite_query(B_DB *mdb, const char *cmd);
 188 void       my_sqlite_field_seek(B_DB *mdb, int field);
 189 SQL_FIELD *my_sqlite_fetch_field(B_DB *mdb);
 190 extern char* my_sqlite_batch_lock_query;
 191 extern char* my_sqlite_batch_unlock_query;
 192 extern char* my_sqlite_batch_fill_filename_query;
 193 extern char* my_sqlite_batch_fill_path_query;
 194
 195
 196 #else
 197
 198 /*                    S Q L I T E 3            */
 199
 200
 201 #ifdef HAVE_SQLITE3
 202
 203
 204 #define BDB_VERSION 10
 205
 206 #include <sqlite3.h>
 207
 208 /* Define opaque structure for sqlite */
 209 struct sqlite3 {
 210    char dummy;
 211 };
 212
 213 #define IS_NUM(x)             ((x) == 1)
 214 #define IS_NOT_NULL(x)        ((x) == 1)
 215
 216 typedef struct s_sql_field {
 217    char *name;                        /* name of column */
 218    int length;                        /* length */
 219    int max_length;                    /* max length */
 220    uint32_t type;                     /* type */
 221    uint32_t flags;                    /* flags */
 222 } SQL_FIELD;
 223
 224 /*
 225  * This is the "real" definition that should only be
 226  * used inside sql.c and associated database interface
 227  * subroutines.
 228  *                    S Q L I T E
 229  */
 230 struct B_DB {
 231    BQUEUE bq;                         /* queue control */
 232    brwlock_t lock;                    /* transaction lock */
 233    struct sqlite3 *db;
 234    char **result;
 235    int status;
 236    int nrow;                          /* nrow returned from sqlite */
 237    int ncolumn;                       /* ncolum returned from sqlite */
 238    int num_rows;                      /* used by code */
 239    int row;                           /* seek row */
 240    int field;                         /* seek field */
 241    SQL_FIELD **fields;                /* defined fields */
 242    int ref_count;
 243    char *db_name;
 244    char *db_user;
 245    char *db_address;                  /* host name address */
 246    char *db_socket;                   /* socket for local access */
 247    char *db_password;
 248    int  db_port;                      /* port for host name address */
 249    bool connected;                    /* connection made to db */
 250    bool have_insert_id;               /* do not have insert id */
 251    bool fields_defined;               /* set when fields defined */
 252    char *sqlite_errmsg;               /* error message returned by sqlite */
 253    POOLMEM *errmsg;                   /* nicely edited error message */
 254    POOLMEM *cmd;                      /* SQL command string */
 255    POOLMEM *cached_path;              /* cached path name */
 256    int cached_path_len;               /* length of cached path */
 257    uint32_t cached_path_id;           /* cached path id */
 258    bool allow_transactions;           /* transactions allowed */
 259    bool transaction;                  /* transaction started */
 260    int changes;                       /* changes during transaction */
 261    POOLMEM *fname;                    /* Filename only */
 262    POOLMEM *path;                     /* Path only */
 263    POOLMEM *esc_name;                 /* Escaped file name */
 264    POOLMEM *esc_name2;                /* Escaped path name */
 265    int fnl;                           /* file name length */
 266    int pnl;                           /* path name length */
 267 };
 268
 269 /*
 270  * Conversion of sqlite 2 names to sqlite3
 271  */
 272 #define sqlite_last_insert_rowid sqlite3_last_insert_rowid
 273 #define sqlite_open sqlite3_open
 274 #define sqlite_close sqlite3_close
 275 #define sqlite_result sqlite3_result
 276 #define sqlite_exec sqlite3_exec
 277 #define sqlite_get_table sqlite3_get_table
 278 #define sqlite_free_table sqlite3_free_table
 279
 280
 281 /*
 282  * "Generic" names for easier conversion
 283  *
 284  *                    S Q L I T E 3
 285  */
 286 #define sql_store_result(x)   (x)->result
 287 #define sql_free_result(x)    my_sqlite_free_table(x)
 288 #define sql_fetch_row(x)      my_sqlite_fetch_row(x)
 289 #define sql_query(x, y)       my_sqlite_query((x), (y))
 290 #ifdef HAVE_SQLITE3
 291 #define sql_insert_id(x,y)    sqlite3_last_insert_rowid((x)->db)
 292 #define sql_close(x)          sqlite3_close((x)->db)
 293 #else
 294 #define sql_insert_id(x,y)    sqlite_last_insert_rowid((x)->db)
 295 #define sql_close(x)          sqlite_close((x)->db)
 296 #endif
 297 #define sql_strerror(x)       (x)->sqlite_errmsg?(x)->sqlite_errmsg:"unknown"
 298 #define sql_num_rows(x)       (x)->nrow
 299 #define sql_data_seek(x, i)   (x)->row = (i)
 300 #define sql_affected_rows(x)  1
 301 #define sql_field_seek(x, y)  my_sqlite_field_seek((x), (y))
 302 #define sql_fetch_field(x)    my_sqlite_fetch_field(x)
 303 #define sql_num_fields(x)     ((x)->ncolumn)
 304 #define sql_batch_start(x,y)    my_batch_start(x,y)
 305 #define sql_batch_end(x,y,z)    my_batch_end(x,y,z)
 306 #define sql_batch_insert(x,y,z) my_batch_insert(x,y,z)
 307 #define SQL_ROW               char**
 308 #define sql_batch_lock_path_query       my_sqlite_batch_lock_query
 309 #define sql_batch_lock_filename_query   my_sqlite_batch_lock_query
 310 #define sql_batch_unlock_tables_query   my_sqlite_batch_unlock_query
 311 #define sql_batch_fill_filename_query   my_sqlite_batch_fill_filename_query
 312 #define sql_batch_fill_path_query       my_sqlite_batch_fill_path_query
 313
 314 /* In cats/sqlite.c */
 315 void       my_sqlite_free_table(B_DB *mdb);
 316 SQL_ROW    my_sqlite_fetch_row(B_DB *mdb);
 317 int        my_sqlite_query(B_DB *mdb, const char *cmd);
 318 void       my_sqlite_field_seek(B_DB *mdb, int field);
 319 SQL_FIELD *my_sqlite_fetch_field(B_DB *mdb);
 320 extern char* my_sqlite_batch_lock_query;
 321 extern char* my_sqlite_batch_unlock_query;
 322 extern char* my_sqlite_batch_fill_filename_query;
 323 extern char* my_sqlite_batch_fill_path_query;
 324
 325
 326 #else
 327
 328 #ifdef HAVE_MYSQL
 329
 330 #define BDB_VERSION 10
 331
 332 #include <mysql.h>
 333
 334 /*
 335  * This is the "real" definition that should only be
 336  * used inside sql.c and associated database interface
 337  * subroutines.
 338  *
 339  *                     M Y S Q L
 340  */
 341 struct B_DB {
 342    BQUEUE bq;                         /* queue control */
 343    brwlock_t lock;                    /* transaction lock */
 344    MYSQL mysql;
 345    MYSQL *db;
 346    MYSQL_RES *result;
 347    int status;
 348    my_ulonglong num_rows;
 349    int ref_count;
 350    char *db_name;
 351    char *db_user;
 352    char *db_password;
 353    char *db_address;                  /* host address */
 354    char *db_socket;                   /* socket for local access */
 355    int db_port;                       /* port of host address */
 356    int have_insert_id;                /* do have insert_id() */
 357    bool connected;
 358    POOLMEM *errmsg;                   /* nicely edited error message */
 359    POOLMEM *cmd;                      /* SQL command string */
 360    POOLMEM *cached_path;
 361    int cached_path_len;               /* length of cached path */
 362    uint32_t cached_path_id;
 363    int changes;                       /* changes made to db */
 364    POOLMEM *fname;                    /* Filename only */
 365    POOLMEM *path;                     /* Path only */
 366    POOLMEM *esc_name;                 /* Escaped file name */
 367    POOLMEM *esc_name2;                /* Escaped path name */
 368    int fnl;                           /* file name length */
 369    int pnl;                           /* path name length */
 370 };
 371
 372 #define DB_STATUS int
 373
 374 /* "Generic" names for easier conversion */
 375 #define sql_store_result(x)   mysql_store_result((x)->db)
 376 #define sql_use_result(x)     mysql_use_result((x)->db)
 377 #define sql_free_result(x)    mysql_free_result((x)->result)
 378 #define sql_fetch_row(x)      mysql_fetch_row((x)->result)
 379 #define sql_query(x, y)       mysql_query((x)->db, (y))
 380 #define sql_close(x)          mysql_close((x)->db)
 381 #define sql_strerror(x)       mysql_error((x)->db)
 382 #define sql_num_rows(x)       mysql_num_rows((x)->result)
 383 #define sql_data_seek(x, i)   mysql_data_seek((x)->result, (i))
 384 #define sql_affected_rows(x)  mysql_affected_rows((x)->db)
 385 #define sql_insert_id(x,y)    mysql_insert_id((x)->db)
 386 #define sql_field_seek(x, y)  mysql_field_seek((x)->result, (y))
 387 #define sql_fetch_field(x)    mysql_fetch_field((x)->result)
 388 #define sql_num_fields(x)     (int)mysql_num_fields((x)->result)
 389 #define SQL_ROW               MYSQL_ROW
 390 #define SQL_FIELD             MYSQL_FIELD
 391
 392 #define sql_batch_start(x,y)    my_batch_start(x,y)
 393 #define sql_batch_end(x,y,z)    my_batch_end(x,y,z)
 394 #define sql_batch_insert(x,y,z) my_batch_insert(x,y,z)
 395 #define sql_batch_lock_path_query       my_mysql_batch_lock_path_query
 396 #define sql_batch_lock_filename_query   my_mysql_batch_lock_filename_query
 397 #define sql_batch_unlock_tables_query   my_mysql_batch_unlock_tables_query
 398 #define sql_batch_fill_filename_query   my_mysql_batch_fill_filename_query
 399 #define sql_batch_fill_path_query       my_mysql_batch_fill_path_query
 400
 401
 402 extern char* my_mysql_batch_lock_path_query;
 403 extern char* my_mysql_batch_lock_filename_query;
 404 extern char* my_mysql_batch_unlock_tables_query;
 405 extern char* my_mysql_batch_fill_filename_query;
 406 extern char* my_mysql_batch_fill_path_query;
 407
 408 #else
 409
 410 #ifdef HAVE_POSTGRESQL
 411
 412 #define BDB_VERSION 10
 413
 414 #include <libpq-fe.h>
 415
 416 /* TEMP: the following is taken from select OID, typname from pg_type; */
 417 #define IS_NUM(x)        ((x) == 20 || (x) == 21 || (x) == 23 || (x) == 700 || (x) == 701)
 418 #define IS_NOT_NULL(x)   ((x) == 1)
 419
 420 typedef char **POSTGRESQL_ROW;
 421 typedef struct pg_field {
 422    char         *name;
 423    int           max_length;
 424    unsigned int  type;
 425    unsigned int  flags;       // 1 == not null
 426 } POSTGRESQL_FIELD;
 427
 428
 429 /*
 430  * This is the "real" definition that should only be
 431  * used inside sql.c and associated database interface
 432  * subroutines.
 433  *
 434  *                     P O S T G R E S Q L
 435  */
 436 struct B_DB {
 437    BQUEUE bq;                         /* queue control */
 438    brwlock_t lock;                    /* transaction lock */
 439    PGconn *db;
 440    PGresult *result;
 441    int status;
 442    POSTGRESQL_ROW row;
 443    POSTGRESQL_FIELD *fields;
 444    int num_rows;
 445    int num_fields;
 446    int row_number;            /* what row number did we get via my_postgresql_data_seek? */
 447    int field_number;          /* what field number did we get via my_postgresql_field_seek? */
 448    int ref_count;
 449    char *db_name;
 450    char *db_user;
 451    char *db_password;
 452    char *db_address;              /* host address */
 453    char *db_socket;               /* socket for local access */
 454    int db_port;                   /* port of host address */
 455    int have_insert_id;            /* do have insert_id() */
 456    bool connected;
 457    POOLMEM *errmsg;               /* nicely edited error message */
 458    POOLMEM *cmd;                  /* SQL command string */
 459    POOLMEM *cached_path;
 460    int cached_path_len;           /* length of cached path */
 461    uint32_t cached_path_id;
 462    bool allow_transactions;       /* transactions allowed */
 463    bool transaction;              /* transaction started */
 464    int changes;                   /* changes made to db */
 465    POOLMEM *fname;                /* Filename only */
 466    POOLMEM *path;                 /* Path only */
 467    POOLMEM *esc_name;             /* Escaped file name */
 468    POOLMEM *esc_name2;            /* Escaped path name */
 469    int fnl;                       /* file name length */
 470    int pnl;                       /* path name length */
 471 };
 472
 473 void               my_postgresql_free_result(B_DB *mdb);
 474 POSTGRESQL_ROW     my_postgresql_fetch_row  (B_DB *mdb);
 475 int                my_postgresql_query      (B_DB *mdb, const char *query);
 476 void               my_postgresql_data_seek  (B_DB *mdb, int row);
 477 int                my_postgresql_currval    (B_DB *mdb, char *table_name);
 478 void               my_postgresql_field_seek (B_DB *mdb, int row);
 479 POSTGRESQL_FIELD * my_postgresql_fetch_field(B_DB *mdb);
 480
 481 int my_postgresql_batch_start(JCR *jcr, B_DB *mdb);
 482 int my_postgresql_batch_end(JCR *jcr, B_DB *mdb, const char *error);
 483 typedef struct ATTR_DBR ATTR_DBR;
 484 int my_postgresql_batch_insert(JCR *jcr, B_DB *mdb, ATTR_DBR *ar);
 485 char *my_postgresql_copy_escape(char *dest, char *src, size_t len);
 486
 487 extern char* my_pg_batch_lock_path_query;
 488 extern char* my_pg_batch_lock_filename_query;
 489 extern char* my_pg_batch_unlock_tables_query;
 490 extern char* my_pg_batch_fill_filename_query;
 491 extern char* my_pg_batch_fill_path_query;
 492
 493 /* "Generic" names for easier conversion */
 494 #define sql_store_result(x)   ((x)->result)
 495 #define sql_free_result(x)    my_postgresql_free_result(x)
 496 #define sql_fetch_row(x)      my_postgresql_fetch_row(x)
 497 #define sql_query(x, y)       my_postgresql_query((x), (y))
 498 #define sql_close(x)          PQfinish((x)->db)
 499 #define sql_strerror(x)       PQresultErrorMessage((x)->result)
 500 #define sql_num_rows(x)       ((unsigned) PQntuples((x)->result))
 501 #define sql_data_seek(x, i)   my_postgresql_data_seek((x), (i))
 502 #define sql_affected_rows(x)  ((unsigned) atoi(PQcmdTuples((x)->result)))
 503 #define sql_insert_id(x,y)    my_postgresql_currval((x), (y))
 504 #define sql_field_seek(x, y)  my_postgresql_field_seek((x), (y))
 505 #define sql_fetch_field(x)    my_postgresql_fetch_field(x)
 506 #define sql_num_fields(x)     ((x)->num_fields)
 507
 508 #define sql_batch_start(x,y)    my_postgresql_batch_start(x,y)
 509 #define sql_batch_end(x,y,z)    my_postgresql_batch_end(x,y,z)
 510 #define sql_batch_insert(x,y,z) my_postgresql_batch_insert(x,y,z)
 511 #define sql_batch_lock_path_query       my_pg_batch_lock_path_query
 512 #define sql_batch_lock_filename_query   my_pg_batch_lock_filename_query
 513 #define sql_batch_unlock_tables_query   my_pg_batch_unlock_tables_query
 514 #define sql_batch_fill_filename_query   my_pg_batch_fill_filename_query
 515 #define sql_batch_fill_path_query       my_pg_batch_fill_path_query
 516
 517 #define SQL_ROW               POSTGRESQL_ROW
 518 #define SQL_FIELD             POSTGRESQL_FIELD
 519
 520 #else  /* USE BACULA DB routines */
 521
 522 #define HAVE_BACULA_DB 1
 523
 524 /* Change this each time there is some incompatible
 525  * file format change!!!!
 526  */
 527 #define BDB_VERSION 13                /* file version number */
 528
 529 struct s_control {
 530    int bdb_version;                   /* Version number */
 531    uint32_t JobId;                    /* next Job Id */
 532    uint32_t PoolId;                   /* next Pool Id */
 533    uint32_t MediaId;                  /* next Media Id */
 534    uint32_t JobMediaId;               /* next JobMedia Id */
 535    uint32_t ClientId;                 /* next Client Id */
 536    uint32_t FileSetId;                /* nest FileSet Id */
 537    time_t time;                       /* time file written */
 538 };
 539
 540
 541 /* This is the REAL definition for using the
 542  *  Bacula internal DB
 543  */
 544 struct B_DB {
 545    BQUEUE bq;                         /* queue control */
 546 /* pthread_mutex_t mutex;  */         /* single thread lock */
 547    brwlock_t lock;                    /* transaction lock */
 548    int ref_count;                     /* number of times opened */
 549    struct s_control control;          /* control file structure */
 550    int cfd;                           /* control file device */
 551    FILE *jobfd;                       /* Jobs records file descriptor */
 552    FILE *poolfd;                      /* Pool records fd */
 553    FILE *mediafd;                     /* Media records fd */
 554    FILE *jobmediafd;                  /* JobMedia records fd */
 555    FILE *clientfd;                    /* Client records fd */
 556    FILE *filesetfd;                   /* FileSet records fd */
 557    char *db_name;                     /* name of database */
 558    POOLMEM *errmsg;                   /* nicely edited error message */
 559    POOLMEM *cmd;                      /* Command string */
 560    POOLMEM *cached_path;
 561    int cached_path_len;               /* length of cached path */
 562    uint32_t cached_path_id;
 563 };
 564
 565 #endif /* HAVE_SQLITE3 */
 566 #endif /* HAVE_MYSQL */
 567 #endif /* HAVE_SQLITE */
 568 #endif /* HAVE_POSTGRESQL */
 569 #endif
 570
 571 /* Use for better error location printing */
 572 #define UPDATE_DB(jcr, db, cmd) UpdateDB(__FILE__, __LINE__, jcr, db, cmd)
 573 #define INSERT_DB(jcr, db, cmd) InsertDB(__FILE__, __LINE__, jcr, db, cmd)
 574 #define QUERY_DB(jcr, db, cmd) QueryDB(__FILE__, __LINE__, jcr, db, cmd)
 575 #define DELETE_DB(jcr, db, cmd) DeleteDB(__FILE__, __LINE__, jcr, db, cmd)
 576
 577
 578 #else    /* not __SQL_C */
 579
 580 /* This is a "dummy" definition for use outside of sql.c
 581  */
 582 struct B_DB {
 583    int dummy;                         /* for SunOS compiler */
 584 };
 585
 586 #endif /*  __SQL_C */
 587
 588 extern uint32_t bacula_db_version;
 589
 590 /* ***FIXME*** FileId_t should *really* be uint64_t
 591  *  but at the current time, this breaks MySQL.
 592  */
 593 typedef uint32_t FileId_t;
 594 typedef uint32_t DBId_t;              /* general DB id type */
 595 typedef uint32_t JobId_t;
 596
 597 #define faddr_t long
 598
 599
 600 /* Job information passed to create job record and update
 601  * job record at end of job. Note, although this record
 602  * contains all the fields found in the Job database record,
 603  * it also contains fields found in the JobMedia record.
 604  */
 605 /* Job record */
 606 struct JOB_DBR {
 607    JobId_t JobId;
 608    char Job[MAX_NAME_LENGTH];         /* Job unique name */
 609    char Name[MAX_NAME_LENGTH];        /* Job base name */
 610    int JobType;                       /* actually char(1) */
 611    int JobLevel;                      /* actually char(1) */
 612    int JobStatus;                     /* actually char(1) */
 613    DBId_t ClientId;                   /* Id of client */
 614    DBId_t PoolId;                     /* Id of pool */
 615    DBId_t FileSetId;                  /* Id of FileSet */
 616    DBId_t PriorJobId;                 /* Id of migrated (prior) job */
 617    time_t SchedTime;                  /* Time job scheduled */
 618    time_t StartTime;                  /* Job start time */
 619    time_t EndTime;                    /* Job termination time of orig job */
 620    time_t RealEndTime;                /* Job termination time of this job */
 621    utime_t JobTDate;                  /* Backup time/date in seconds */
 622    uint32_t VolSessionId;
 623    uint32_t VolSessionTime;
 624    uint32_t JobFiles;
 625    uint32_t JobErrors;
 626    uint32_t JobMissingFiles;
 627    uint64_t JobBytes;
 628    int PurgedFiles;
 629    int HasBase;
 630
 631    /* Note, FirstIndex, LastIndex, Start/End File and Block
 632     * are only used in the JobMedia record.
 633     */
 634    uint32_t FirstIndex;               /* First index this Volume */
 635    uint32_t LastIndex;                /* Last index this Volume */
 636    uint32_t StartFile;
 637    uint32_t EndFile;
 638    uint32_t StartBlock;
 639    uint32_t EndBlock;
 640
 641    char cSchedTime[MAX_TIME_LENGTH];
 642    char cStartTime[MAX_TIME_LENGTH];
 643    char cEndTime[MAX_TIME_LENGTH];
 644    char cRealEndTime[MAX_TIME_LENGTH];
 645    /* Extra stuff not in DB */
 646    int limit;                         /* limit records to display */
 647    faddr_t rec_addr;
 648 };
 649
 650 /* Job Media information used to create the media records
 651  * for each Volume used for the job.
 652  */
 653 /* JobMedia record */
 654 struct JOBMEDIA_DBR {
 655    DBId_t JobMediaId;                 /* record id */
 656    JobId_t  JobId;                    /* JobId */
 657    DBId_t MediaId;                    /* MediaId */
 658    uint32_t FirstIndex;               /* First index this Volume */
 659    uint32_t LastIndex;                /* Last index this Volume */
 660    uint32_t StartFile;                /* File for start of data */
 661    uint32_t EndFile;                  /* End file on Volume */
 662    uint32_t StartBlock;               /* start block on tape */
 663    uint32_t EndBlock;                 /* last block */
 664    uint32_t Copy;                     /* identical copy */
 665 };
 666
 667
 668 /* Volume Parameter structure */
 669 struct VOL_PARAMS {
 670    char VolumeName[MAX_NAME_LENGTH];  /* Volume name */
 671    char MediaType[MAX_NAME_LENGTH];   /* Media Type */
 672    char Storage[MAX_NAME_LENGTH];     /* Storage name */
 673    uint32_t VolIndex;                 /* Volume seqence no. */
 674    uint32_t FirstIndex;               /* First index this Volume */
 675    uint32_t LastIndex;                /* Last index this Volume */
 676    uint32_t StartFile;                /* File for start of data */
 677    uint32_t EndFile;                  /* End file on Volume */
 678    uint32_t StartBlock;               /* start block on tape */
 679    uint32_t EndBlock;                 /* last block */
 680    int32_t Slot;                      /* Slot */
 681 // uint32_t Copy;                     /* identical copy */
 682 // uint32_t Stripe;                   /* RAIT strip number */
 683 };
 684
 685
 686 /* Attributes record -- NOT same as in database because
 687  *  in general, this "record" creates multiple database
 688  *  records (e.g. pathname, filename, fileattributes).
 689  */
 690 struct ATTR_DBR {
 691    char *fname;                       /* full path & filename */
 692    char *link;                        /* link if any */
 693    char *attr;                        /* attributes statp */
 694    uint32_t FileIndex;
 695    uint32_t Stream;
 696    JobId_t  JobId;
 697    DBId_t ClientId;
 698    DBId_t PathId;
 699    DBId_t FilenameId;
 700    FileId_t FileId;
 701    char *Digest;
 702    int DigestType;
 703 };
 704
 705
 706 /* File record -- same format as database */
 707 struct FILE_DBR {
 708    FileId_t FileId;
 709    uint32_t FileIndex;
 710    JobId_t  JobId;
 711    DBId_t FilenameId;
 712    DBId_t PathId;
 713    JobId_t  MarkId;
 714    char LStat[256];
 715    char Digest[BASE64_SIZE(CRYPTO_DIGEST_MAX_SIZE)];
 716    int DigestType;                    /* NO_SIG/MD5_SIG/SHA1_SIG */
 717 };
 718
 719 /* Pool record -- same format as database */
 720 struct POOL_DBR {
 721    DBId_t PoolId;
 722    char Name[MAX_NAME_LENGTH];        /* Pool name */
 723    uint32_t NumVols;                  /* total number of volumes */
 724    uint32_t MaxVols;                  /* max allowed volumes */
 725    int32_t LabelType;                 /* Bacula/ANSI/IBM */
 726    int32_t UseOnce;                   /* set to use once only */
 727    int32_t UseCatalog;                /* set to use catalog */
 728    int32_t AcceptAnyVolume;           /* set to accept any volume sequence */
 729    int32_t AutoPrune;                 /* set to prune automatically */
 730    int32_t Recycle;                   /* default Vol recycle flag */
 731    utime_t  VolRetention;             /* retention period in seconds */
 732    utime_t  VolUseDuration;           /* time in secs volume can be used */
 733    uint32_t MaxVolJobs;               /* Max Jobs on Volume */
 734    uint32_t MaxVolFiles;              /* Max files on Volume */
 735    uint64_t MaxVolBytes;              /* Max bytes on Volume */
 736    DBId_t RecyclePoolId;              /* RecyclePool destination when media is purged */
 737    char PoolType[MAX_NAME_LENGTH];
 738    char LabelFormat[MAX_NAME_LENGTH];
 739    /* Extra stuff not in DB */
 740    faddr_t rec_addr;
 741 };
 742
 743 class DEVICE_DBR {
 744 public:
 745    DBId_t DeviceId;
 746    char Name[MAX_NAME_LENGTH];        /* Device name */
 747    DBId_t MediaTypeId;                /* MediaType */
 748    DBId_t StorageId;                  /* Storage id if autochanger */
 749    uint32_t DevMounts;                /* Number of times mounted */
 750    uint32_t DevErrors;                /* Number of read/write errors */
 751    uint64_t DevReadBytes;             /* Number of bytes read */
 752    uint64_t DevWriteBytes;            /* Number of bytew written */
 753    uint64_t DevReadTime;              /* time spent reading volume */
 754    uint64_t DevWriteTime;             /* time spent writing volume */
 755    uint64_t DevReadTimeSincCleaning;  /* read time since cleaning */
 756    uint64_t DevWriteTimeSincCleaning; /* write time since cleaning */
 757    time_t   CleaningDate;             /* time last cleaned */
 758    utime_t  CleaningPeriod;           /* time between cleanings */
 759 };
 760
 761 class STORAGE_DBR {
 762 public:
 763    DBId_t StorageId;
 764    char Name[MAX_NAME_LENGTH];        /* Device name */
 765    int AutoChanger;                   /* Set if autochanger */
 766
 767    /* Not in database */
 768    bool created;                      /* set if created by db_create ... */
 769 };
 770
 771 class MEDIATYPE_DBR {
 772 public:
 773    DBId_t MediaTypeId;
 774    char MediaType[MAX_NAME_LENGTH];   /* MediaType string */
 775    int ReadOnly;                      /* Set if read-only */
 776 };
 777
 778
 779 /* Media record -- same as the database */
 780 struct MEDIA_DBR {
 781    DBId_t MediaId;                    /* Unique volume id */
 782    char VolumeName[MAX_NAME_LENGTH];  /* Volume name */
 783    char MediaType[MAX_NAME_LENGTH];   /* Media type */
 784    DBId_t PoolId;                     /* Pool id */
 785    time_t   FirstWritten;             /* Time Volume first written this usage */
 786    time_t   LastWritten;              /* Time Volume last written */
 787    time_t   LabelDate;                /* Date/Time Volume labeled */
 788    time_t   InitialWrite;             /* Date/Time Volume first written */
 789    int32_t  LabelType;                /* Label (Bacula/ANSI/IBM) */
 790    uint32_t VolJobs;                  /* number of jobs on this medium */
 791    uint32_t VolFiles;                 /* Number of files */
 792    uint32_t VolBlocks;                /* Number of blocks */
 793    uint32_t VolMounts;                /* Number of times mounted */
 794    uint32_t VolErrors;                /* Number of read/write errors */
 795    uint32_t VolWrites;                /* Number of writes */
 796    uint32_t VolReads;                 /* Number of reads */
 797    uint64_t VolBytes;                 /* Number of bytes written */
 798    uint32_t VolParts;                 /* Number of parts written */
 799    uint64_t MaxVolBytes;              /* Max bytes to write to Volume */
 800    uint64_t VolCapacityBytes;         /* capacity estimate */
 801    uint64_t VolReadTime;              /* time spent reading volume */
 802    uint64_t VolWriteTime;             /* time spent writing volume */
 803    utime_t  VolRetention;             /* Volume retention in seconds */
 804    utime_t  VolUseDuration;           /* time in secs volume can be used */
 805    uint32_t MaxVolJobs;               /* Max Jobs on Volume */
 806    uint32_t MaxVolFiles;              /* Max files on Volume */
 807    int32_t  Recycle;                  /* recycle yes/no */
 808    int32_t  Slot;                     /* slot in changer */
 809    int32_t  Enabled;                  /* 0=disabled, 1=enabled, 2=archived */
 810    int32_t  InChanger;                /* Volume currently in changer */
 811    DBId_t   StorageId;                /* Storage record Id */
 812    uint32_t EndFile;                  /* Last file on volume */
 813    uint32_t EndBlock;                 /* Last block on volume */
 814    uint32_t RecycleCount;             /* Number of times recycled */
 815    char     VolStatus[20];            /* Volume status */
 816    DBId_t   DeviceId;                 /* Device where Vol last written */
 817    DBId_t   LocationId;               /* Where Volume is -- user defined */
 818    DBId_t   ScratchPoolId;            /* Where to move if scratch */
 819    DBId_t   RecyclePoolId;            /* Where to move when recycled */
 820    /* Extra stuff not in DB */
 821    faddr_t rec_addr;                  /* found record address */
 822    /* Since the database returns times as strings, this is how we pass
 823     *   them back.
 824     */
 825    char    cFirstWritten[MAX_TIME_LENGTH]; /* FirstWritten returned from DB */
 826    char    cLastWritten[MAX_TIME_LENGTH];  /* LastWritten returned from DB */
 827    char    cLabelDate[MAX_TIME_LENGTH];    /* LabelData returned from DB */
 828    char    cInitialWrite[MAX_TIME_LENGTH]; /* InitialWrite returned from DB */
 829    bool    set_first_written;
 830    bool    set_label_date;
 831 };
 832
 833 /* Client record -- same as the database */
 834 struct CLIENT_DBR {
 835    DBId_t ClientId;                   /* Unique Client id */
 836    int AutoPrune;
 837    utime_t FileRetention;
 838    utime_t JobRetention;
 839    char Name[MAX_NAME_LENGTH];        /* Client name */
 840    char Uname[256];                   /* Uname for client */
 841 };
 842
 843 /* Counter record as in database */
 844 struct COUNTER_DBR {
 845    char Counter[MAX_NAME_LENGTH];
 846    int32_t MinValue;
 847    int32_t MaxValue;
 848    int32_t CurrentValue;
 849    char WrapCounter[MAX_NAME_LENGTH];
 850 };
 851
 852
 853 /* FileSet record -- same as the database */
 854 struct FILESET_DBR {
 855    DBId_t FileSetId;                  /* Unique FileSet id */
 856    char FileSet[MAX_NAME_LENGTH];     /* FileSet name */
 857    char MD5[50];                      /* MD5 signature of include/exclude */
 858    time_t CreateTime;                 /* date created */
 859    /*
 860     * This is where we return CreateTime
 861     */
 862    char cCreateTime[MAX_TIME_LENGTH]; /* CreateTime as returned from DB */
 863    /* Not in DB but returned by db_create_fileset() */
 864    bool created;                      /* set when record newly created */
 865 };
 866
 867 /* Call back context for getting a 32/64 bit value from the database */
 868 struct db_int64_ctx {
 869    int64_t value;                     /* value returned */
 870    int count;                         /* number of values seen */
 871 };
 872
 873
 874 #include "protos.h"
 875 #include "jcr.h"
 876 #include "sql_cmds.h"
 877
 878 /*
 879  * Some functions exported by sql.c for use within the
 880  *   cats directory.
 881  */
 882 void list_result(JCR *jcr, B_DB *mdb, DB_LIST_HANDLER *send, void *ctx, e_list_type type);
 883 void list_dashes(B_DB *mdb, DB_LIST_HANDLER *send, void *ctx);
 884 int get_sql_record_max(JCR *jcr, B_DB *mdb);
 885 bool check_tables_version(JCR *jcr, B_DB *mdb);
 886 void _db_unlock(const char *file, int line, B_DB *mdb);
 887 void _db_lock(const char *file, int line, B_DB *mdb);
 888 const char *db_get_type(void);
 889
 890 void print_dashes(B_DB *mdb);
 891 void print_result(B_DB *mdb);
 892 int QueryDB(const char *file, int line, JCR *jcr, B_DB *db, char *select_cmd);
 893 int InsertDB(const char *file, int line, JCR *jcr, B_DB *db, char *select_cmd);
 894 int DeleteDB(const char *file, int line, JCR *jcr, B_DB *db, char *delete_cmd);
 895 int UpdateDB(const char *file, int line, JCR *jcr, B_DB *db, char *update_cmd);
 896 void split_path_and_file(JCR *jcr, B_DB *mdb, const char *fname);
 897 #endif /* __SQL_H_ */