]> git.sur5r.net Git - bacula/bacula/blobdiff - bacula/src/cats/cats.h
ebl Modify disk-changer to check if slot contains something before
[bacula/bacula] / bacula / src / cats / cats.h
index 139607ffc0e7c8a9acff4171766a8286baf98dd7..38f8180cc35bbcb9e914553e71a80027ef948093 100644 (file)
@@ -1,29 +1,14 @@
-/*
- * SQL header file
- *
- *   by Kern E. Sibbald
- *
- *   Anyone who accesses the database will need to include
- *   this file.
- *
- * This file contains definitions common to sql.c and
- * the external world, and definitions destined only
- * for the external world. This is control with
- * the define __SQL_C, which is defined only in sql.c
- *
- *    Version $Id$
- */
 /*
    Bacula® - The Network Backup Solution
 
-   Copyright (C) 2000-2006 Free Software Foundation Europe e.V.
+   Copyright (C) 2000-2008 Free Software Foundation Europe e.V.
 
    The main author of Bacula is Kern Sibbald, with contributions from
    many others, a complete list can be found in the file AUTHORS.
    This program is Free Software; you can redistribute it and/or
    modify it under the terms of version two of the GNU General Public
-   License as published by the Free Software Foundation plus additions
-   that are listed in the file LICENSE.
+   License as published by the Free Software Foundation and included
+   in the file LICENSE.
 
    This program is distributed in the hope that it will be useful, but
    WITHOUT ANY WARRANTY; without even the implied warranty of
    (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
    Switzerland, email:ftf@fsfeurope.org.
 */
+/*
+ * SQL header file
+ *
+ *   by Kern E. Sibbald
+ *
+ *   Anyone who accesses the database will need to include
+ *   this file.
+ *
+ * This file contains definitions common to sql.c and
+ * the external world, and definitions destined only
+ * for the external world. This is control with
+ * the define __SQL_C, which is defined only in sql.c
+ *
+ *    Version $Id$
+ */
 
 /*
    Here is how database versions work. 
 #ifndef __SQL_H_
 #define __SQL_H_ 1
 
+enum {
+   SQL_TYPE_MYSQL      = 0,
+   SQL_TYPE_POSTGRESQL = 1,
+   SQL_TYPE_SQLITE     = 2
+};
+
 
 typedef void (DB_LIST_HANDLER)(void *, const char *);
 typedef int (DB_RESULT_HANDLER)(void *, int, char **);
@@ -141,7 +147,7 @@ struct B_DB {
    POOLMEM *fname;                    /* Filename only */
    POOLMEM *path;                     /* Path only */
    POOLMEM *esc_name;                 /* Escaped file name */
-   POOLMEM *esc_name2;                /* Escaped path name */
+   POOLMEM *esc_path;                 /* Escaped path name */
    int fnl;                           /* file name length */
    int pnl;                           /* path name length */
 };
@@ -171,9 +177,10 @@ struct B_DB {
 #define sql_fetch_field(x)    my_sqlite_fetch_field(x)
 #define sql_num_fields(x)     ((x)->ncolumn)
 #define SQL_ROW               char**
-#define sql_batch_start(x)    db_batch_start(x)
-#define sql_batch_end(x,y)    db_batch_end(x,y)
-#define sql_batch_insert(x,y) db_batch_insert(x,y)
+
+#define sql_batch_start(x,y)    my_batch_start(x,y) 
+#define sql_batch_end(x,y,z)    my_batch_end(x,y,z)   
+#define sql_batch_insert(x,y,z) my_batch_insert(x,y,z)
 #define sql_batch_lock_path_query       my_sqlite_batch_lock_query
 #define sql_batch_lock_filename_query   my_sqlite_batch_lock_query
 #define sql_batch_unlock_tables_query   my_sqlite_batch_unlock_query
@@ -186,10 +193,10 @@ SQL_ROW    my_sqlite_fetch_row(B_DB *mdb);
 int        my_sqlite_query(B_DB *mdb, const char *cmd);
 void       my_sqlite_field_seek(B_DB *mdb, int field);
 SQL_FIELD *my_sqlite_fetch_field(B_DB *mdb);
-extern char* my_sqlite_batch_lock_query;
-extern char* my_sqlite_batch_unlock_query;
-extern char* my_sqlite_batch_fill_filename_query;
-extern char* my_sqlite_batch_fill_path_query;
+extern const char* my_sqlite_batch_lock_query;
+extern const char* my_sqlite_batch_unlock_query;
+extern const char* my_sqlite_batch_fill_filename_query;
+extern const char* my_sqlite_batch_fill_path_query;
 
 
 #else
@@ -260,7 +267,7 @@ struct B_DB {
    POOLMEM *fname;                    /* Filename only */
    POOLMEM *path;                     /* Path only */
    POOLMEM *esc_name;                 /* Escaped file name */
-   POOLMEM *esc_name2;                /* Escaped path name */
+   POOLMEM *esc_path;                 /* Escaped path name */
    int fnl;                           /* file name length */
    int pnl;                           /* path name length */
 };
@@ -300,10 +307,10 @@ struct B_DB {
 #define sql_field_seek(x, y)  my_sqlite_field_seek((x), (y))
 #define sql_fetch_field(x)    my_sqlite_fetch_field(x)
 #define sql_num_fields(x)     ((x)->ncolumn)
+#define sql_batch_start(x,y)    my_batch_start(x,y)   
+#define sql_batch_end(x,y,z)    my_batch_end(x,y,z)   
+#define sql_batch_insert(x,y,z) my_batch_insert(x,y,z)
 #define SQL_ROW               char**
-#define sql_batch_start(x)    db_batch_start(x)
-#define sql_batch_end(x,y)    db_batch_end(x,y)
-#define sql_batch_insert(x,y) db_batch_insert(x,y)
 #define sql_batch_lock_path_query       my_sqlite_batch_lock_query
 #define sql_batch_lock_filename_query   my_sqlite_batch_lock_query
 #define sql_batch_unlock_tables_query   my_sqlite_batch_unlock_query
@@ -316,10 +323,10 @@ SQL_ROW    my_sqlite_fetch_row(B_DB *mdb);
 int        my_sqlite_query(B_DB *mdb, const char *cmd);
 void       my_sqlite_field_seek(B_DB *mdb, int field);
 SQL_FIELD *my_sqlite_fetch_field(B_DB *mdb);
-extern char* my_sqlite_batch_lock_query;
-extern char* my_sqlite_batch_unlock_query;
-extern char* my_sqlite_batch_fill_filename_query;
-extern char* my_sqlite_batch_fill_path_query;
+extern const char* my_sqlite_batch_lock_query;
+extern const char* my_sqlite_batch_unlock_query;
+extern const char* my_sqlite_batch_fill_filename_query;
+extern const char* my_sqlite_batch_fill_path_query;
 
 
 #else
@@ -363,7 +370,7 @@ struct B_DB {
    POOLMEM *fname;                    /* Filename only */
    POOLMEM *path;                     /* Path only */
    POOLMEM *esc_name;                 /* Escaped file name */
-   POOLMEM *esc_name2;                /* Escaped path name */
+   POOLMEM *esc_path;                 /* Escaped path name */
    int fnl;                           /* file name length */
    int pnl;                           /* path name length */
 };
@@ -373,10 +380,9 @@ struct B_DB {
 /* "Generic" names for easier conversion */
 #define sql_store_result(x)   mysql_store_result((x)->db)
 #define sql_use_result(x)     mysql_use_result((x)->db)
-#define sql_free_result(x)    mysql_free_result((x)->result)
+#define sql_free_result(x)    my_mysql_free_result(x)
 #define sql_fetch_row(x)      mysql_fetch_row((x)->result)
 #define sql_query(x, y)       mysql_query((x)->db, (y))
-#define sql_close(x)          mysql_close((x)->db)
 #define sql_strerror(x)       mysql_error((x)->db)
 #define sql_num_rows(x)       mysql_num_rows((x)->result)
 #define sql_data_seek(x, i)   mysql_data_seek((x)->result, (i))
@@ -385,24 +391,25 @@ struct B_DB {
 #define sql_field_seek(x, y)  mysql_field_seek((x)->result, (y))
 #define sql_fetch_field(x)    mysql_fetch_field((x)->result)
 #define sql_num_fields(x)     (int)mysql_num_fields((x)->result)
-#define sql_batch_start(x)    db_batch_start(x)
-#define sql_batch_end(x,y)    db_batch_end(x,y)
-#define sql_batch_insert(x,y) db_batch_insert(x,y)
+#define SQL_ROW               MYSQL_ROW
+#define SQL_FIELD             MYSQL_FIELD
+
+#define sql_batch_start(x,y)    my_batch_start(x,y)
+#define sql_batch_end(x,y,z)    my_batch_end(x,y,z)   
+#define sql_batch_insert(x,y,z) my_batch_insert(x,y,z)   
 #define sql_batch_lock_path_query       my_mysql_batch_lock_path_query
 #define sql_batch_lock_filename_query   my_mysql_batch_lock_filename_query
 #define sql_batch_unlock_tables_query   my_mysql_batch_unlock_tables_query
 #define sql_batch_fill_filename_query   my_mysql_batch_fill_filename_query
 #define sql_batch_fill_path_query       my_mysql_batch_fill_path_query
-#define SQL_ROW               MYSQL_ROW
-#define SQL_FIELD             MYSQL_FIELD
 
 
-int my_mysql_batch_start(B_DB *mdb);
-extern char* my_mysql_batch_lock_path_query;
-extern char* my_mysql_batch_lock_filename_query;
-extern char* my_mysql_batch_unlock_tables_query;
-extern char* my_mysql_batch_fill_filename_query;
-extern char* my_mysql_batch_fill_path_query;
+extern const char* my_mysql_batch_lock_path_query;
+extern const char* my_mysql_batch_lock_filename_query;
+extern const char* my_mysql_batch_unlock_tables_query;
+extern const char* my_mysql_batch_fill_filename_query;
+extern const char* my_mysql_batch_fill_path_query;
+extern void  my_mysql_free_result(B_DB *mdb);
 
 #else
 
@@ -441,9 +448,11 @@ struct B_DB {
    POSTGRESQL_ROW row;
    POSTGRESQL_FIELD *fields;
    int num_rows;
+   int row_size;                  /* size of malloced rows */
    int num_fields;
-   int row_number;            /* what row number did we get via my_postgresql_data_seek? */
-   int field_number;          /* what field number did we get via my_postgresql_field_seek? */
+   int fields_size;               /* size of malloced fields */
+   int row_number;                /* row number from my_postgresql_data_seek */
+   int field_number;              /* field number from my_postgresql_field_seek */
    int ref_count;
    char *db_name;
    char *db_user;
@@ -464,7 +473,7 @@ struct B_DB {
    POOLMEM *fname;                /* Filename only */
    POOLMEM *path;                 /* Path only */
    POOLMEM *esc_name;             /* Escaped file name */
-   POOLMEM *esc_name2;            /* Escaped path name */
+   POOLMEM *esc_path;             /* Escaped path name */
    int fnl;                       /* file name length */
    int pnl;                       /* path name length */
 };     
@@ -476,19 +485,18 @@ void               my_postgresql_data_seek  (B_DB *mdb, int row);
 int                my_postgresql_currval    (B_DB *mdb, char *table_name);
 void               my_postgresql_field_seek (B_DB *mdb, int row);
 POSTGRESQL_FIELD * my_postgresql_fetch_field(B_DB *mdb);
-int my_postgresql_lock_table(B_DB *mdb, const char *table);
-int my_postgresql_unlock_table(B_DB *mdb);
-int my_postgresql_batch_start(B_DB *mdb);
-int my_postgresql_batch_end(B_DB *mdb, const char *error);
+
+int my_postgresql_batch_start(JCR *jcr, B_DB *mdb);
+int my_postgresql_batch_end(JCR *jcr, B_DB *mdb, const char *error);
 typedef struct ATTR_DBR ATTR_DBR;
-int my_postgresql_batch_insert(B_DB *mdb, ATTR_DBR *ar);
+int my_postgresql_batch_insert(JCR *jcr, B_DB *mdb, ATTR_DBR *ar);
 char *my_postgresql_copy_escape(char *dest, char *src, size_t len);
 
-extern char* my_pg_batch_lock_path_query;
-extern char* my_pg_batch_lock_filename_query;
-extern char* my_pg_batch_unlock_tables_query;
-extern char* my_pg_batch_fill_filename_query;
-extern char* my_pg_batch_fill_path_query;
+extern const char* my_pg_batch_lock_path_query;
+extern const char* my_pg_batch_lock_filename_query;
+extern const char* my_pg_batch_unlock_tables_query;
+extern const char* my_pg_batch_fill_filename_query;
+extern const char* my_pg_batch_fill_path_query;
 
 /* "Generic" names for easier conversion */
 #define sql_store_result(x)   ((x)->result)
@@ -496,7 +504,7 @@ extern char* my_pg_batch_fill_path_query;
 #define sql_fetch_row(x)      my_postgresql_fetch_row(x)
 #define sql_query(x, y)       my_postgresql_query((x), (y))
 #define sql_close(x)          PQfinish((x)->db)
-#define sql_strerror(x)       PQresultErrorMessage((x)->result)
+#define sql_strerror(x)       PQerrorMessage((x)->db)
 #define sql_num_rows(x)       ((unsigned) PQntuples((x)->result))
 #define sql_data_seek(x, i)   my_postgresql_data_seek((x), (i))
 #define sql_affected_rows(x)  ((unsigned) atoi(PQcmdTuples((x)->result)))
@@ -504,11 +512,10 @@ extern char* my_pg_batch_fill_path_query;
 #define sql_field_seek(x, y)  my_postgresql_field_seek((x), (y))
 #define sql_fetch_field(x)    my_postgresql_fetch_field(x)
 #define sql_num_fields(x)     ((x)->num_fields)
-#define sql_batch_start(x)    my_postgresql_batch_start(x)
-#define sql_batch_end(x,y)    my_postgresql_batch_end(x,y)
-#define sql_batch_insert(x,y) my_postgresql_batch_insert(x,y)
-#define sql_lock_table(x,y)   my_postgresql_lock_table(x, y)
-#define sql_unlock_table(x,y) my_postgresql_unlock_table(x)
+
+#define sql_batch_start(x,y)    my_postgresql_batch_start(x,y)   
+#define sql_batch_end(x,y,z)    my_postgresql_batch_end(x,y,z)   
+#define sql_batch_insert(x,y,z) my_postgresql_batch_insert(x,y,z)
 #define sql_batch_lock_path_query       my_pg_batch_lock_path_query
 #define sql_batch_lock_filename_query   my_pg_batch_lock_filename_query
 #define sql_batch_unlock_tables_query   my_pg_batch_unlock_tables_query
@@ -518,6 +525,141 @@ extern char* my_pg_batch_fill_path_query;
 #define SQL_ROW               POSTGRESQL_ROW
 #define SQL_FIELD             POSTGRESQL_FIELD
 
+#else
+
+#ifdef HAVE_DBI
+
+#define BDB_VERSION 10
+
+#include <dbi/dbi.h>
+
+#ifdef HAVE_BATCH_FILE_INSERT
+#include <dbi/dbi-dev.h>
+#endif //HAVE_BATCH_FILE_INSERT
+
+#define IS_NUM(x)        ((x) == 1 || (x) == 2 )
+#define IS_NOT_NULL(x)   ((x) == (1 << 0))
+
+typedef char **DBI_ROW;
+typedef struct dbi_field {
+   char         *name;
+   int           max_length;
+   unsigned int  type;
+   unsigned int  flags;       // 1 == not null
+} DBI_FIELD;
+
+typedef struct dbi_field_get {
+   BQUEUE bq;
+   char *value;
+} DBI_FIELD_GET;
+
+/*
+ * This is the "real" definition that should only be
+ * used inside sql.c and associated database interface
+ * subroutines.
+ *
+ *                     D B I
+ */
+struct B_DB {
+   BQUEUE bq;                         /* queue control */
+   brwlock_t lock;                    /* transaction lock */
+   dbi_conn *db;
+   dbi_result *result;
+   dbi_inst instance;
+   dbi_error_flag status;
+   DBI_ROW row;
+   DBI_FIELD *fields;
+   DBI_FIELD_GET *field_get;
+   int num_rows;
+   int row_size;                  /* size of malloced rows */
+   int num_fields;
+   int fields_size;               /* size of malloced fields */
+   int row_number;                /* row number from my_postgresql_data_seek */
+   int field_number;              /* field number from my_postgresql_field_seek */
+   int ref_count;
+   int db_type;                   /* DBI driver defined */
+   char *db_driverdir ;           /* DBI driver dir */
+   char *db_driver;               /* DBI type database */
+   char *db_name;
+   char *db_user;
+   char *db_password;
+   char *db_address;              /* host address */
+   char *db_socket;               /* socket for local access */
+   int db_port;                   /* port of host address */
+   int have_insert_id;            /* do have insert_id() */
+   bool connected;
+   POOLMEM *errmsg;               /* nicely edited error message */
+   POOLMEM *cmd;                  /* SQL command string */
+   POOLMEM *cached_path;
+   int cached_path_len;           /* length of cached path */
+   uint32_t cached_path_id;
+   bool allow_transactions;       /* transactions allowed */
+   bool transaction;              /* transaction started */
+   int changes;                   /* changes made to db */
+   POOLMEM *fname;                /* Filename only */
+   POOLMEM *path;                 /* Path only */
+   POOLMEM *esc_name;             /* Escaped file name */
+   POOLMEM *esc_path;             /* Escaped path name */
+   int fnl;                       /* file name length */
+   int pnl;                       /* path name length */
+};     
+
+void               my_dbi_free_result(B_DB *mdb);
+DBI_ROW            my_dbi_fetch_row  (B_DB *mdb);
+int                my_dbi_query      (B_DB *mdb, const char *query);
+void               my_dbi_data_seek  (B_DB *mdb, int row);
+void               my_dbi_field_seek (B_DB *mdb, int row);
+DBI_FIELD *        my_dbi_fetch_field(B_DB *mdb);
+const char *       my_dbi_strerror   (B_DB *mdb);
+int                my_dbi_getisnull  (dbi_result *result, int row_number, int column_number);
+char *             my_dbi_getvalue   (dbi_result *result, int row_number, unsigned int column_number);
+//int                my_dbi_getvalue   (dbi_result *result, int row_number, unsigned int column_number, char *value);
+int                my_dbi_sql_insert_id(B_DB *mdb, char *table_name);
+
+int my_dbi_batch_start(JCR *jcr, B_DB *mdb);
+int my_dbi_batch_end(JCR *jcr, B_DB *mdb, const char *error);
+typedef struct ATTR_DBR ATTR_DBR;
+int my_dbi_batch_insert(JCR *jcr, B_DB *mdb, ATTR_DBR *ar);
+char *my_postgresql_copy_escape(char *dest, char *src, size_t len);
+// typedefs for libdbi work with postgresql copy insert
+typedef int (*custom_function_insert_t)(void*, const char*, int);   
+typedef char* (*custom_function_error_t)(void*);
+typedef int (*custom_function_end_t)(void*, const char*);
+
+extern const char* my_dbi_batch_lock_path_query[3];
+extern const char* my_dbi_batch_lock_filename_query[3];
+extern const char* my_dbi_batch_unlock_tables_query[3];
+extern const char* my_dbi_batch_fill_filename_query[3];
+extern const char* my_dbi_batch_fill_path_query[3];
+
+/* "Generic" names for easier conversion */
+#define sql_store_result(x)   (x)->result
+#define sql_free_result(x)    my_dbi_free_result(x)
+#define sql_fetch_row(x)      my_dbi_fetch_row(x)
+#define sql_query(x, y)       my_dbi_query((x), (y))
+#define sql_close(x)          dbi_conn_close((x)->db)
+#define sql_strerror(x)       my_dbi_strerror(x)
+#define sql_num_rows(x)       dbi_result_get_numrows((x)->result)
+#define sql_data_seek(x, i)   my_dbi_data_seek((x), (i))
+/* #define sql_affected_rows(x)  dbi_result_get_numrows_affected((x)->result) */
+#define sql_affected_rows(x)  1
+#define sql_insert_id(x,y)    my_dbi_sql_insert_id((x), (y))
+#define sql_field_seek(x, y)  my_dbi_field_seek((x), (y))
+#define sql_fetch_field(x)    my_dbi_fetch_field(x)
+#define sql_num_fields(x)     ((x)->num_fields)
+#define sql_batch_start(x,y)    my_dbi_batch_start(x,y)   
+#define sql_batch_end(x,y,z)    my_dbi_batch_end(x,y,z)   
+#define sql_batch_insert(x,y,z) my_dbi_batch_insert(x,y,z)
+#define sql_batch_lock_path_query       my_dbi_batch_lock_path_query[db_type]
+#define sql_batch_lock_filename_query   my_dbi_batch_lock_filename_query[db_type]
+#define sql_batch_unlock_tables_query   my_dbi_batch_unlock_tables_query[db_type]
+#define sql_batch_fill_filename_query   my_dbi_batch_fill_filename_query[db_type]
+#define sql_batch_fill_path_query       my_dbi_batch_fill_path_query[db_type]
+
+#define SQL_ROW               DBI_ROW
+#define SQL_FIELD             DBI_FIELD
+
+
 #else  /* USE BACULA DB routines */
 
 #define HAVE_BACULA_DB 1
@@ -567,6 +709,7 @@ struct B_DB {
 #endif /* HAVE_MYSQL */
 #endif /* HAVE_SQLITE */
 #endif /* HAVE_POSTGRESQL */
+#endif /* HAVE_DBI */
 #endif
 
 /* Use for better error location printing */
@@ -586,10 +729,23 @@ struct B_DB {
 
 #endif /*  __SQL_C */
 
+/* ==============================================================   
+ *
+ *  What follows are definitions that are used "globally" for all 
+ *   the different SQL engines and both inside and external to the
+ *   cats directory.
+ */
+
 extern uint32_t bacula_db_version;
 
-/* ***FIXME*** FileId_t should *really* be uint64_t
- *  but at the current time, this breaks MySQL.
+/*
+ * These are the sizes of the current definitions of database
+ *  Ids.  In general, FileId_t can be set to uint64_t and it
+ *  *should* work.  Users have reported back that it does work
+ *  for PostgreSQL.  For the other types, all places in Bacula
+ *  have been converted, but no one has actually tested it.
+ * In principle, the only field that really should need to be
+ *  64 bits is the FileId_t
  */
 typedef uint32_t FileId_t;
 typedef uint32_t DBId_t;              /* general DB id type */
@@ -597,6 +753,25 @@ typedef uint32_t JobId_t;
 
 #define faddr_t long
 
+/*
+ * Structure used when calling db_get_query_ids()
+ *  allows the subroutine to return a list of ids.
+ */
+class dbid_list : public SMARTALLOC {
+public:
+   DBId_t *DBId;                      /* array of DBIds */
+   char *PurgedFiles;                 /* Array of PurgedFile flags */
+   int num_ids;                       /* num of ids actually stored */
+   int max_ids;                       /* size of id array */
+   int num_seen;                      /* number of ids processed */
+   int tot_ids;                       /* total to process */
+
+   dbid_list();                       /* in sql.c */
+   ~dbid_list();                      /* in sql.c */
+};
+
+
+
 
 /* Job information passed to create job record and update
  * job record at end of job. Note, although this record
@@ -876,6 +1051,11 @@ struct db_int64_ctx {
 #include "jcr.h"
 #include "sql_cmds.h"
 
+/*
+ * Exported globals from sql.c  
+ */
+extern int DLL_IMP_EXP db_type;        /* SQL engine type index */
+
 /*
  * Some functions exported by sql.c for use within the
  *   cats directory.