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