2 Bacula® - The Network Backup Solution
4 Copyright (C) 2009-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 two of the GNU General Public
10 License as published by the Free Software Foundation, which is
11 listed in the file LICENSE.
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 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.
29 #define __SQL_C /* indicate that this is sql.c */
32 #include "cats/cats.h"
33 #include "lib/htable.h"
37 #define dbglevel_sql 15
39 static int result_handler(void *ctx, int fields, char **row)
42 Pmsg4(0, "%s\t%s\t%s\t%s\n",
43 row[0], row[1], row[2], row[3]);
44 } else if (fields == 5) {
45 Pmsg5(0, "%s\t%s\t%s\t%s\t%s\n",
46 row[0], row[1], row[2], row[3], row[4]);
47 } else if (fields == 6) {
48 Pmsg6(0, "%s\t%s\t%s\t%s\t%s\t%s\n",
49 row[0], row[1], row[2], row[3], row[4], row[5]);
50 } else if (fields == 7) {
51 Pmsg7(0, "%s\t%s\t%s\t%s\t%s\t%s\t%s\n",
52 row[0], row[1], row[2], row[3], row[4], row[5], row[6]);
57 Bvfs::Bvfs(JCR *j, B_DB *mdb) {
60 db = mdb; /* need to inc ref count */
61 prev_dir = get_pool_memory(PM_NAME);
62 jobids = get_pool_memory(PM_NAME);
63 pattern = get_pool_memory(PM_NAME);
64 *prev_dir = *pattern = *jobids = 0;
65 dir_filenameid = pwd_id = offset = 0;
66 see_copies = see_all_version = false;
69 list_entries = result_handler;
74 free_pool_memory(jobids);
75 free_pool_memory(pattern);
76 free_pool_memory(prev_dir);
82 * TODO: Find a way to let the user choose how he wants to display
83 * files and directories
88 * Working Object to store PathId already seen (avoid
89 * database queries), equivalent to %cache_ppathid in perl
98 htable *cache_ppathid;
103 cache_ppathid = (htable *)malloc(sizeof(htable));
104 cache_ppathid->init(&link, &link, NITEMS);
106 nodes = (hlink *) malloc(max_node * sizeof (hlink));
111 if (nb_node >= max_node) {
113 nodes = (hlink *)brealloc(nodes, sizeof(hlink) * max_node);
115 return nodes + nb_node++;
118 bool lookup(char *pathid) {
119 bool ret = cache_ppathid->lookup(pathid) != NULL;
123 void insert(char *pathid) {
124 hlink *h = get_hlink();
125 cache_ppathid->insert(pathid, h);
129 cache_ppathid->destroy();
134 pathid_cache(const pathid_cache &); /* prohibit pass by value */
135 pathid_cache &operator= (const pathid_cache &);/* prohibit class assignment*/
138 /* Return the parent_dir with the trailing / (update the given string)
139 * TODO: see in the rest of bacula if we don't have already this function
145 char *bvfs_parent_dir(char *path)
148 int len = strlen(path) - 1;
150 if (len >= 0 && path[len] == '/') { /* if directory, skip last / */
156 while (p > path && !IsPathSeparator(*p)) {
164 /* Return the basename of the with the trailing /
165 * TODO: see in the rest of bacula if we don't have
166 * this function already
168 char *bvfs_basename_dir(char *path)
171 int len = strlen(path) - 1;
173 if (path[len] == '/') { /* if directory, skip last / */
179 while (p > path && !IsPathSeparator(*p)) {
183 p++; /* skip first / */
189 static void build_path_hierarchy(JCR *jcr, B_DB *mdb,
190 pathid_cache &ppathid_cache,
191 char *org_pathid, char *path)
193 Dmsg1(dbglevel, "build_path_hierarchy(%s)\n", path);
196 char *bkp = mdb->path;
197 strncpy(pathid, org_pathid, sizeof(pathid));
199 /* Does the ppathid exist for this ? we use a memory cache... In order to
200 * avoid the full loop, we consider that if a dir is allready in the
201 * brestore_pathhierarchy table, then there is no need to calculate all the
204 while (path && *path)
206 if (!ppathid_cache.lookup(pathid))
209 "SELECT PPathId FROM brestore_pathhierarchy WHERE PathId = %s",
212 QUERY_DB(jcr, mdb, mdb->cmd);
213 /* Do we have a result ? */
214 if (sql_num_rows(mdb) > 0) {
215 ppathid_cache.insert(pathid);
216 /* This dir was in the db ...
217 * It means we can leave, the tree has allready been built for
222 /* search or create parent PathId in Path table */
223 mdb->path = bvfs_parent_dir(path);
224 mdb->pnl = strlen(mdb->path);
225 if (!db_create_path_record(jcr, mdb, &parent)) {
228 ppathid_cache.insert(pathid);
231 "INSERT INTO brestore_pathhierarchy (PathId, PPathId) "
233 pathid, (uint64_t) parent.PathId);
235 INSERT_DB(jcr, mdb, mdb->cmd);
237 edit_uint64(parent.PathId, pathid);
238 path = mdb->path; /* already done */
241 /* It's allready in the cache. We can leave, no time to waste here,
242 * all the parent dirs have allready been done
254 * Internal function to update path_hierarchy cache with a shared pathid cache
256 static void update_path_hierarchy_cache(JCR *jcr,
258 pathid_cache &ppathid_cache,
261 Dmsg0(dbglevel, "update_path_hierarchy_cache()\n");
265 edit_uint64(JobId, jobid);
268 db_start_transaction(jcr, mdb);
270 Mmsg(mdb->cmd, "SELECT 1 FROM brestore_knownjobid WHERE JobId = %s", jobid);
272 if (!QUERY_DB(jcr, mdb, mdb->cmd) || sql_num_rows(mdb) > 0) {
273 Dmsg1(dbglevel, "already computed %d\n", (uint32_t)JobId );
277 /* Inserting path records for JobId */
278 Mmsg(mdb->cmd, "INSERT INTO brestore_pathvisibility (PathId, JobId) "
279 "SELECT DISTINCT PathId, JobId FROM File WHERE JobId = %s",
281 QUERY_DB(jcr, mdb, mdb->cmd);
284 /* Now we have to do the directory recursion stuff to determine missing
285 * visibility We try to avoid recursion, to be as fast as possible We also
286 * only work on not allready hierarchised directories...
289 "SELECT brestore_pathvisibility.PathId, Path "
290 "FROM brestore_pathvisibility "
291 "JOIN Path ON( brestore_pathvisibility.PathId = Path.PathId) "
292 "LEFT JOIN brestore_pathhierarchy "
293 "ON (brestore_pathvisibility.PathId = brestore_pathhierarchy.PathId) "
294 "WHERE brestore_pathvisibility.JobId = %s "
295 "AND brestore_pathhierarchy.PathId IS NULL "
296 "ORDER BY Path", jobid);
297 Dmsg1(dbglevel_sql, "q=%s\n", mdb->cmd);
298 QUERY_DB(jcr, mdb, mdb->cmd);
300 /* TODO: I need to reuse the DB connection without emptying the result
301 * So, now i'm copying the result in memory to be able to query the
302 * catalog descriptor again.
304 num = sql_num_rows(mdb);
306 char **result = (char **)malloc (num * 2 * sizeof(char *));
310 while((row = sql_fetch_row(mdb))) {
311 result[i++] = bstrdup(row[0]);
312 result[i++] = bstrdup(row[1]);
317 build_path_hierarchy(jcr, mdb, ppathid_cache, result[i], result[i+1]);
326 "INSERT INTO brestore_pathvisibility (PathId, JobId) "
327 "SELECT a.PathId,%s "
329 "SELECT DISTINCT h.PPathId AS PathId "
330 "FROM brestore_pathhierarchy AS h "
331 "JOIN brestore_pathvisibility AS p ON (h.PathId=p.PathId) "
332 "WHERE p.JobId=%s) AS a LEFT JOIN "
334 "FROM brestore_pathvisibility "
335 "WHERE JobId=%s) AS b ON (a.PathId = b.PathId) "
336 "WHERE b.PathId IS NULL", jobid, jobid, jobid);
339 QUERY_DB(jcr, mdb, mdb->cmd);
340 } while (sql_affected_rows(mdb) > 0);
342 Mmsg(mdb->cmd, "INSERT INTO brestore_knownjobid (JobId) VALUES (%s)", jobid);
343 INSERT_DB(jcr, mdb, mdb->cmd);
346 db_end_transaction(jcr, mdb);
351 * Find an store the filename descriptor for empty directories Filename.Name=''
353 DBId_t Bvfs::get_dir_filenameid()
356 if (dir_filenameid) {
357 return dir_filenameid;
360 Mmsg(q, "SELECT FilenameId FROM Filename WHERE Name = ''");
361 db_sql_query(db, q.c_str(), db_int_handler, &id);
363 return dir_filenameid;
366 void bvfs_update_cache(JCR *jcr, B_DB *mdb)
370 db_start_transaction(jcr, mdb);
372 Mmsg(mdb->cmd, "SELECT 1 from brestore_knownjobid LIMIT 1");
373 /* TODO: Add this code in the make_bacula_table script */
374 if (!QUERY_DB(jcr, mdb, mdb->cmd)) {
375 Dmsg0(dbglevel, "Creating cache table\n");
377 "CREATE TABLE brestore_knownjobid ("
378 "JobId integer NOT NULL, "
379 "CONSTRAINT brestore_knownjobid_pkey PRIMARY KEY (JobId))");
380 QUERY_DB(jcr, mdb, mdb->cmd);
383 "CREATE TABLE brestore_pathhierarchy ( "
384 "PathId integer NOT NULL, "
385 "PPathId integer NOT NULL, "
386 "CONSTRAINT brestore_pathhierarchy_pkey "
387 "PRIMARY KEY (PathId))");
388 QUERY_DB(jcr, mdb, mdb->cmd);
391 "CREATE INDEX brestore_pathhierarchy_ppathid "
392 "ON brestore_pathhierarchy (PPathId)");
393 QUERY_DB(jcr, mdb, mdb->cmd);
396 "CREATE TABLE brestore_pathvisibility ("
397 "PathId integer NOT NULL, "
398 "JobId integer NOT NULL, "
399 "Size int8 DEFAULT 0, "
400 "Files int4 DEFAULT 0, "
401 "CONSTRAINT brestore_pathvisibility_pkey "
402 "PRIMARY KEY (JobId, PathId))");
403 QUERY_DB(jcr, mdb, mdb->cmd);
406 "CREATE INDEX brestore_pathvisibility_jobid "
407 "ON brestore_pathvisibility (JobId)");
408 QUERY_DB(jcr, mdb, mdb->cmd);
412 POOLMEM *jobids = get_pool_memory(PM_NAME);
416 "SELECT JobId from Job "
417 "WHERE JobId NOT IN (SELECT JobId FROM brestore_knownjobid) "
418 "AND Type IN ('B') AND JobStatus IN ('T', 'f', 'A') "
421 db_sql_query(mdb, mdb->cmd, db_get_int_handler, jobids);
423 bvfs_update_path_hierarchy_cache(jcr, mdb, jobids);
425 db_end_transaction(jcr, mdb);
426 db_start_transaction(jcr, mdb);
427 Dmsg0(dbglevel, "Cleaning pathvisibility\n");
429 "DELETE FROM brestore_pathvisibility "
431 "(SELECT 1 FROM Job WHERE JobId=brestore_pathvisibility.JobId)");
432 nb = DELETE_DB(jcr, mdb, mdb->cmd);
433 Dmsg1(dbglevel, "Affected row(s) = %d\n", nb);
435 Dmsg0(dbglevel, "Cleaning knownjobid\n");
437 "DELETE FROM brestore_knownjobid "
439 "(SELECT 1 FROM Job WHERE JobId=brestore_knownjobid.JobId)");
440 nb = DELETE_DB(jcr, mdb, mdb->cmd);
441 Dmsg1(dbglevel, "Affected row(s) = %d\n", nb);
443 db_end_transaction(jcr, mdb);
444 free_pool_memory(jobids);
448 * Update the bvfs cache for given jobids (1,2,3,4)
451 bvfs_update_path_hierarchy_cache(JCR *jcr, B_DB *mdb, char *jobids)
453 pathid_cache ppathid_cache;
458 int stat = get_next_jobid_from_list(&p, &JobId);
465 Dmsg1(dbglevel, "Updating cache for %lld\n", (uint64_t) JobId);
466 update_path_hierarchy_cache(jcr, mdb, ppathid_cache, JobId);
471 * Update the bvfs cache for current jobids
473 void Bvfs::update_cache()
475 bvfs_update_path_hierarchy_cache(jcr, db, jobids);
478 /* Change the current directory, returns true if the path exists */
479 bool Bvfs::ch_dir(const char *path)
481 pm_strcpy(db->path, path);
482 db->pnl = strlen(db->path);
483 ch_dir(db_get_path_record(jcr, db));
488 * Get all file versions for a specified client
490 void Bvfs::get_all_file_versions(DBId_t pathid, DBId_t fnid, const char *client)
492 Dmsg3(dbglevel, "get_all_file_versions(%lld, %lld, %s)\n", (uint64_t)pathid,
493 (uint64_t)fnid, client);
494 char ed1[50], ed2[50];
497 Mmsg(q, " AND Job.Type IN ('C', 'B') ");
499 Mmsg(q, " AND Job.Type = 'B' ");
505 "SELECT File.FileId, File.Md5, File.JobId, File.LStat, "
507 "Media.VolumeName, Media.InChanger "
508 "FROM File, Job, Client, JobMedia, Media "
509 "WHERE File.FilenameId = %s "
510 "AND File.PathId=%s "
511 "AND File.JobId = Job.JobId "
512 "AND Job.ClientId = Client.ClientId "
513 "AND Job.JobId = JobMedia.JobId "
514 "AND File.FileIndex >= JobMedia.FirstIndex "
515 "AND File.FileIndex <= JobMedia.LastIndex "
516 "AND JobMedia.MediaId = Media.MediaId "
517 "AND Client.Name = '%s' "
518 "%s ORDER BY FileId LIMIT %d OFFSET %d"
519 ,edit_uint64(fnid, ed1), edit_uint64(pathid, ed2), client, q.c_str(),
521 Dmsg1(dbglevel_sql, "q=%s\n", query.c_str());
522 db_sql_query(db, query.c_str(), list_entries, user_data);
525 DBId_t Bvfs::get_root()
528 return db_get_path_record(jcr, db);
531 static int path_handler(void *ctx, int fields, char **row)
533 Bvfs *fs = (Bvfs *) ctx;
534 return fs->_handle_path(ctx, fields, row);
537 int Bvfs::_handle_path(void *ctx, int fields, char **row)
539 if (fields == BVFS_DIR_RECORD) {
540 /* can have the same path 2 times */
541 if (strcmp(row[BVFS_Name], prev_dir)) {
542 pm_strcpy(prev_dir, row[BVFS_Name]);
543 return list_entries(user_data, fields, row);
550 * Retrieve . and .. information
552 void Bvfs::ls_special_dirs()
554 Dmsg1(dbglevel, "ls_special_dirs(%lld)\n", (uint64_t)pwd_id);
555 char ed1[50], ed2[50];
559 if (!dir_filenameid) {
560 get_dir_filenameid();
563 /* Will fetch directories */
568 "((SELECT PPathId AS PathId, '..' AS Path "
569 "FROM brestore_pathhierarchy "
570 "WHERE PathId = %s) "
572 "(SELECT %s AS PathId, '.' AS Path))",
573 edit_uint64(pwd_id, ed1), ed1);
577 "SELECT tmp.PathId, tmp.Path, JobId, LStat "
578 "FROM %s AS tmp LEFT JOIN ( " // get attributes if any
579 "SELECT File1.PathId AS PathId, File1.JobId AS JobId, "
580 "File1.LStat AS LStat FROM File AS File1 "
581 "WHERE File1.FilenameId = %s "
582 "AND File1.JobId IN (%s)) AS listfile1 "
583 "ON (tmp.PathId = listfile1.PathId) "
584 "ORDER BY tmp.Path, JobId DESC ",
585 query.c_str(), edit_uint64(dir_filenameid, ed2), jobids);
587 Dmsg1(dbglevel_sql, "q=%s\n", query2.c_str());
588 db_sql_query(db, query2.c_str(), path_handler, this);
591 /* Returns true if we have dirs to read */
594 Dmsg1(dbglevel, "ls_dirs(%lld)\n", (uint64_t)pwd_id);
595 char ed1[50], ed2[50];
602 Mmsg(filter, " AND Path2.Path %s '%s' ", SQL_MATCH, pattern);
605 if (!dir_filenameid) {
606 get_dir_filenameid();
609 /* the sql query displays same directory multiple time, take the first one */
612 /* Let's retrieve the list of the visible dirs in this dir ...
613 * First, I need the empty filenameid to locate efficiently
614 * the dirs in the file table
615 * my $dir_filenameid = $self->get_dir_filenameid();
617 /* Then we get all the dir entries from File ... */
621 "SELECT PathId, Path, JobId, LStat FROM ( "
622 "SELECT Path1.PathId AS PathId, Path1.Path AS Path, "
623 "lower(Path1.Path) AS lpath, "
624 "listfile1.JobId AS JobId, listfile1.LStat AS LStat "
626 "SELECT DISTINCT brestore_pathhierarchy1.PathId AS PathId "
627 "FROM brestore_pathhierarchy AS brestore_pathhierarchy1 "
628 "JOIN Path AS Path2 "
629 "ON (brestore_pathhierarchy1.PathId = Path2.PathId) "
630 "JOIN brestore_pathvisibility AS brestore_pathvisibility1 "
631 "ON (brestore_pathhierarchy1.PathId = brestore_pathvisibility1.PathId) "
632 "WHERE brestore_pathhierarchy1.PPathId = %s "
633 "AND brestore_pathvisibility1.jobid IN (%s) "
636 "JOIN Path AS Path1 ON (listpath1.PathId = Path1.PathId) "
638 "LEFT JOIN ( " /* get attributes if any */
639 "SELECT File1.PathId AS PathId, File1.JobId AS JobId, "
640 "File1.LStat AS LStat FROM File AS File1 "
641 "WHERE File1.FilenameId = %s "
642 "AND File1.JobId IN (%s)) AS listfile1 "
643 "ON (listpath1.PathId = listfile1.PathId) "
644 ") AS A ORDER BY 2,3 DESC LIMIT %d OFFSET %d",
645 edit_uint64(pwd_id, ed1),
648 edit_uint64(dir_filenameid, ed2),
652 Dmsg1(dbglevel_sql, "q=%s\n", query.c_str());
655 db_sql_query(db, query.c_str(), path_handler, this);
656 nb_record = db->num_rows;
659 return nb_record == limit;
662 /* Returns true if we have files to read */
663 bool Bvfs::ls_files()
665 Dmsg1(dbglevel, "ls_files(%lld)\n", (uint64_t)pwd_id);
677 Mmsg(filter, " AND Filename.Name %s '%s' ", SQL_MATCH, pattern);
681 Mmsg(query, // 0 1 2 3 4
682 "SELECT File.FilenameId, listfiles.Name, File.JobId, File.LStat, listfiles.id "
684 "SELECT Filename.Name as Name, max(File.FileId) as id "
685 "FROM File, Filename "
686 "WHERE File.FilenameId = Filename.FilenameId "
687 "AND Filename.Name != '' "
688 "AND File.PathId = %s "
689 "AND File.JobId IN (%s) "
691 "GROUP BY Filename.Name "
692 "ORDER BY Filename.Name LIMIT %d OFFSET %d "
694 "WHERE File.FileId = listfiles.id",
695 edit_uint64(pwd_id, ed1),
700 Dmsg1(dbglevel_sql, "q=%s\n", query.c_str());
703 db_sql_query(db, query.c_str(), list_entries, user_data);
704 nb_record = db->num_rows;
707 return nb_record == limit;