2 Bacula® - The Network Backup Solution
4 Copyright (C) 2000-2009 Free Software Foundation Europe e.V.
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 three of the GNU Affero General Public
10 License as published by the Free Software Foundation and included
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.
18 You should have received a copy of the GNU Affero 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
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.
35 * This object can be use to browse the catalog
45 /* Helper for result handler */
47 BVFS_FILE_RECORD = 'F',
48 BVFS_DIR_RECORD = 'D',
49 BVFS_FILE_VERSION = 'V'
53 BVFS_Type = 0, /* Could be D, F, V */
60 BVFS_LStat = 5, /* Can be empty for missing directories */
61 BVFS_FileId = 6, /* Can be empty for missing directories */
63 /* Only if File Version record */
72 Bvfs(JCR *j, B_DB *mdb);
75 void set_jobid(JobId_t id);
76 void set_jobids(char *ids);
78 void set_limit(uint32_t max) {
82 void set_offset(uint32_t nb) {
86 void set_pattern(char *p) {
87 uint32_t len = strlen(p);
88 pattern = check_pool_memory_size(pattern, len*2+1);
89 db_escape_string(jcr, db, pattern, p, len);
92 /* Get the root point */
95 /* It's much better to access Path though their PathId, it
96 * avoids mistakes with string encoding
98 void ch_dir(DBId_t pathid) {
104 * Returns true if the directory exists
106 bool ch_dir(const char *path);
108 bool ls_files(); /* Returns true if we have more files to read */
109 bool ls_dirs(); /* Returns true if we have more dir to read */
110 void ls_special_dirs(); /* get . and .. */
111 void get_all_file_versions(DBId_t pathid, DBId_t fnid, const char *client);
115 void set_see_all_versions(bool val) {
116 see_all_versions = val;
119 void set_see_copies(bool val) {
123 void filter_jobid(); /* Call after set_username */
125 void set_username(char *user) {
127 username = bstrdup(user);
131 void set_handler(DB_RESULT_HANDLER *h, void *ctx) {
148 void reset_offset() {
156 /* Clear all cache */
159 /* Compute restore list */
160 bool compute_restore_list(char *fileid, char *dirid, char *hardlink,
163 /* Drop previous restore list */
164 bool drop_restore_list(char *output_table);
166 /* for internal use */
167 int _handle_path(void *, int, char **);
170 Bvfs(const Bvfs &); /* prohibit pass by value */
171 Bvfs & operator = (const Bvfs &); /* prohibit class assignment */
176 char *username; /* Used with Bweb */
179 uint32_t nb_record; /* number of records of the last query */
181 DBId_t pwd_id; /* Current pathid */
182 DBId_t dir_filenameid; /* special FilenameId where Name='' */
183 POOLMEM *prev_dir; /* ls_dirs query returns all versions, take the 1st one */
184 ATTR *attr; /* Can be use by handler to call decode_stat() */
186 bool see_all_versions;
189 DBId_t get_dir_filenameid();
191 DB_RESULT_HANDLER *list_entries;
195 #define bvfs_is_dir(row) ((row)[BVFS_Type][0] == BVFS_DIR_RECORD)
196 #define bvfs_is_file(row) ((row)[BVFS_Type][0] == BVFS_FILE_RECORD)
197 #define bvfs_is_version(row) ((row)[BVFS_Type][0] == BVFS_FILE_VERSION)
200 void bvfs_update_path_hierarchy_cache(JCR *jcr, B_DB *mdb, char *jobids);
201 void bvfs_update_cache(JCR *jcr, B_DB *mdb);
202 char *bvfs_parent_dir(char *path);
204 /* Return the basename of the with the trailing / (update the given string)
205 * TODO: see in the rest of bacula if we don't have
206 * this function already
208 char *bvfs_basename_dir(char *path);
211 #endif /* __BVFS_H_ */