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

   1 /*
   2    Bacula® - The Network Backup Solution
   3
   4    Copyright (C) 2000-2009 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
  30 #ifndef __BVFS_H_
  31 #define __BVFS_H_ 1
  32
  33
  34 /*
  35  * This object can be use to browse the catalog
  36  *
  37  * Bvfs fs;
  38  * fs.set_jobid(10);
  39  * fs.update_cache();
  40  * fs.ch_dir("/");
  41  * fs.ls_dirs();
  42  * fs.ls_files();
  43  */
  44
  45 /* Helper for result handler */
  46 typedef enum {
  47    BVFS_FILE_RECORD  = 'F',
  48    BVFS_DIR_RECORD   = 'D',
  49    BVFS_FILE_VERSION = 'V'
  50 } bvfs_handler_type;
  51
  52 typedef enum {
  53    BVFS_Type    = 0,            /* Could be D, F, V */
  54    BVFS_PathId  = 1,
  55    BVFS_FilenameId = 2,
  56
  57    BVFS_Name    = 3,
  58    BVFS_JobId   = 4,
  59
  60    BVFS_LStat   = 5,            /* Can be empty for missing directories */
  61    BVFS_FileId  = 6,            /* Can be empty for missing directories */
  62
  63    /* Only if File Version record */
  64    BVFS_Md5     = 3,
  65    BVFS_VolName = 4,
  66    BVFS_VolInchanger = 5
  67 } bvfs_row_index;
  68
  69 class Bvfs {
  70
  71 public:
  72    Bvfs(JCR *j, B_DB *mdb);
  73    virtual ~Bvfs();
  74
  75    void set_jobid(JobId_t id) {
  76       Mmsg(jobids, "%lld", (uint64_t)id);
  77    }
  78
  79    void set_jobids(char *ids) {
  80       pm_strcpy(jobids, ids);
  81    }
  82
  83    void set_limit(uint32_t max) {
  84       limit = max;
  85    }
  86
  87    void set_offset(uint32_t nb) {
  88       offset = nb;
  89    }
  90
  91    void set_pattern(char *p) {
  92       uint32_t len = strlen(p)*2+1;
  93       pattern = check_pool_memory_size(pattern, len);
  94       db_escape_string(jcr, db, pattern, p, len);
  95    }
  96
  97    /* Get the root point */
  98    DBId_t get_root();
  99
 100    /* It's much better to access Path though their PathId, it
 101     * avoids mistakes with string encoding
 102     */
 103    void ch_dir(DBId_t pathid) {
 104       reset_offset();
 105       pwd_id = pathid;
 106    }
 107
 108    /*
 109     * Returns true if the directory exists
 110     */
 111    bool ch_dir(const char *path);
 112
 113    bool ls_files();             /* Returns true if we have more files to read */
 114    bool ls_dirs();              /* Returns true if we have more dir to read */
 115    void ls_special_dirs();      /* get . and .. */
 116    void get_all_file_versions(DBId_t pathid, DBId_t fnid, const char *client);
 117
 118    void update_cache();
 119
 120    void set_see_all_version(bool val) {
 121       see_all_version = val;
 122    }
 123
 124    void set_see_copies(bool val) {
 125       see_copies = val;
 126    }
 127
 128    void set_handler(DB_RESULT_HANDLER *h, void *ctx) {
 129       list_entries = h;
 130       user_data = ctx;
 131    }
 132
 133    DBId_t get_pwd() {
 134       return pwd_id;
 135    }
 136
 137    ATTR *get_attr() {
 138       return attr;
 139    }
 140
 141    JCR *get_jcr() {
 142       return jcr;
 143    }
 144
 145    void reset_offset() {
 146       offset=0;
 147    }
 148
 149    void next_offset() {
 150       offset+=limit;
 151    }
 152
 153    /* for internal use */
 154    int _handle_path(void *, int, char **);
 155
 156 private:
 157    Bvfs(const Bvfs &);               /* prohibit pass by value */
 158    Bvfs & operator = (const Bvfs &); /* prohibit class assignment */
 159
 160    JCR *jcr;
 161    B_DB *db;
 162    POOLMEM *jobids;
 163    uint32_t limit;
 164    uint32_t offset;
 165    uint32_t nb_record;          /* number of records of the last query */
 166    POOLMEM *pattern;
 167    DBId_t pwd_id;               /* Current pathid */
 168    DBId_t dir_filenameid;       /* special FilenameId where Name='' */
 169    POOLMEM *prev_dir; /* ls_dirs query returns all versions, take the 1st one */
 170    ATTR *attr;        /* Can be use by handler to call decode_stat() */
 171
 172    bool see_all_version;
 173    bool see_copies;
 174
 175    DBId_t get_dir_filenameid();
 176
 177    DB_RESULT_HANDLER *list_entries;
 178    void *user_data;
 179 };
 180
 181 #define bvfs_is_dir(row) ((row)[BVFS_Type][0] == BVFS_DIR_RECORD)
 182 #define bvfs_is_file(row) ((row)[BVFS_Type][0] == BVFS_FILE_RECORD)
 183
 184 void bvfs_update_path_hierarchy_cache(JCR *jcr, B_DB *mdb, char *jobids);
 185 void bvfs_update_cache(JCR *jcr, B_DB *mdb);
 186 char *bvfs_parent_dir(char *path);
 187
 188 /* Return the basename of the with the trailing /  (update the given string)
 189  * TODO: see in the rest of bacula if we don't have
 190  * this function already
 191  */
 192 char *bvfs_basename_dir(char *path);
 193
 194
 195 #endif /* __BVFS_H_ */