2 * Bacula Catalog Database Get record interface routines
3 * Note, these routines generally get a record by id or
4 * by name. If more logic is involved, the routine
7 * Bacula Catalog Database routines written specifically
8 * for Bacula. Note, these routines are VERY dumb and
9 * do not provide all the functionality of an SQL database.
10 * The purpose of these routines is to ensure that Bacula
11 * can limp along if no real database is loaded on the
14 * Kern Sibbald, January MMI
20 Copyright (C) 2001-2003 Kern Sibbald and John Walker
22 This program is free software; you can redistribute it and/or
23 modify it under the terms of the GNU General Public License as
24 published by the Free Software Foundation; either version 2 of
25 the License, or (at your option) any later version.
27 This program is distributed in the hope that it will be useful,
28 but WITHOUT ANY WARRANTY; without even the implied warranty of
29 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
30 General Public License for more details.
32 You should have received a copy of the GNU General Public
33 License along with this program; if not, write to the Free
34 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
40 /* The following is necessary so that we do not include
41 * the dummy external definition of DB.
43 #define __SQL_C /* indicate that this is sql.c */
51 /* Forward referenced functions */
54 /* -----------------------------------------------------------------------
56 * Bacula specific defines and subroutines
58 * -----------------------------------------------------------------------
63 * Get Job record for given JobId
64 * Returns: 0 on failure
68 int db_get_job_record(JCR *jcr, B_DB *mdb, JOB_DBR *jr)
77 if (jr->JobId == 0 && jr->Name[0] == 0) { /* he wants # of Job records */
78 jr->JobId = mdb->control.JobId;
82 Dmsg0(200, "Open Jobs\n");
83 if (!bdb_open_jobs_file(mdb)) {
87 fseek(mdb->jobfd, 0L, SEEK_SET); /* rewind file */
89 /* Linear search through Job records
92 while (fread(&ojr, len, 1, mdb->jobfd) > 0) {
93 /* If id not zero, search by Id */
95 if (jr->JobId == ojr.JobId) {
99 } else if (strcmp(jr->Job, ojr.Job) == 0) {
101 Dmsg1(200, "Found Job: %s\n", ojr.Job);
104 rec_addr = ftell(mdb->jobfd); /* save start next record */
107 /* Found desired record, now return it */
108 memcpy(jr, &ojr, len);
109 jr->rec_addr = rec_addr;
111 Dmsg2(200, "Found job record: JobId=%d Job=%s",
116 strcpy(mdb->errmsg, "Job record not found.\n");
119 Dmsg1(200, "Return job stat=%d\n", stat);
125 * Get the number of pool records
127 * Returns: -1 on failure
130 int db_get_num_pool_records(JCR *jcr, B_DB *mdb)
135 stat = mdb->control.PoolId;
141 * This function returns a list of all the Pool record ids.
142 * The caller must free ids if non-NULL.
144 * Returns 0: on failure
147 int db_get_pool_ids(JCR *jcr, B_DB *mdb, int *num_ids, uint32_t *ids[])
156 if (!bdb_open_pools_file(mdb)) {
160 fseek(mdb->poolfd, 0L, SEEK_SET); /* rewind file */
161 /* Linear search through Pool records
164 *num_ids = mdb->control.PoolId;
165 id = (uint32_t *)malloc(*num_ids * sizeof(uint32_t));
166 while (fread(&opr, len, 1, mdb->poolfd) > 0) {
167 id[i++] = opr.PoolId;
177 * If the PoolId is non-zero, we get its record,
178 * otherwise, we search on the PoolName
180 * Returns: false on failure
183 bool db_get_pool_record(JCR *jcr, B_DB *mdb, POOL_DBR *pr)
191 Dmsg0(200, "Open pools\n");
192 if (!bdb_open_pools_file(mdb)) {
196 fseek(mdb->poolfd, 0L, SEEK_SET); /* rewind file */
198 /* Linear search through Pool records
201 while (fread(&opr, len, 1, mdb->poolfd) > 0) {
202 /* If id not zero, search by Id */
203 if (pr->PoolId != 0) {
204 if (pr->PoolId == opr.PoolId) {
208 } else if (strcmp(pr->Name, opr.Name) == 0) {
210 Dmsg1(200, "Found pool: %s\n", opr.Name);
213 rec_addr = ftell(mdb->poolfd); /* save start next record */
216 /* Found desired record, now return it */
217 memcpy(pr, &opr, len);
218 pr->rec_addr = rec_addr;
219 Dmsg3(200, "Found pool record: PoolId=%d Name=%s PoolType=%s\n",
220 opr.PoolId, opr.Name, opr.PoolType);
224 strcpy(mdb->errmsg, "Pool record not found.\n");
231 * Get the number of Media records
233 * Returns: -1 on failure
236 int db_get_num_media_records(JCR *jcr, B_DB *mdb)
241 stat = mdb->control.MediaId;
247 * This function returns a list of all the Media record ids
248 * for a specified PoolId
249 * The caller must free ids if non-NULL.
251 * Returns false: on failure
254 bool db_get_media_ids(JCR *jcr, B_DB *mdb, uint32_t PoolId, int *num_ids, uint32_t *ids[])
263 if (!bdb_open_media_file(mdb)) {
267 fseek(mdb->mediafd, 0L, SEEK_SET); /* rewind file */
268 /* Linear search through Pool records
271 if (mdb->control.MediaId == 0) {
275 *num_ids = mdb->control.MediaId;
276 id = (uint32_t *)malloc(*num_ids * sizeof(uint32_t));
277 while (fread(&omr, len, 1, mdb->mediafd) > 0) {
278 if (PoolId == omr.MediaId) {
279 id[i++] = omr.MediaId;
289 * If the MediaId is non-zero, we get its record,
290 * otherwise, we search on the MediaName
292 * Returns: false on failure
295 bool db_get_media_record(JCR *jcr, B_DB *mdb, MEDIA_DBR *mr)
303 if (!bdb_open_media_file(mdb)) {
306 fseek(mdb->mediafd, 0L, SEEK_SET); /* rewind file */
308 /* Linear search through Media records
311 while (fread(&omr, len, 1, mdb->mediafd) > 0) {
312 if (omr.MediaId == 0) {
313 continue; /* deleted record */
315 Dmsg1(200, "VolName=%s\n", omr.VolumeName);
316 /* If id not zero, search by Id */
317 if (mr->MediaId != 0) {
318 Dmsg1(200, "MediaId=%d\n", mr->MediaId);
319 if (mr->MediaId == omr.MediaId) {
323 } else if (strcmp(mr->VolumeName, omr.VolumeName) == 0) {
327 rec_addr = ftell(mdb->mediafd); /* save start next record */
330 /* Found desired record, now return it */
331 memcpy(mr, &omr, len);
332 mr->rec_addr = rec_addr;
333 Dmsg3(200, "Found media record: MediaId=%d Name=%s MediaType=%s\n",
334 omr.MediaId, omr.VolumeName, mr->MediaType);
338 strcpy(mdb->errmsg, "Could not find requested Media record.\n");
346 * Find VolumeNames for a give JobId
347 * Returns: 0 on error or no Volumes found
348 * number of volumes on success
349 * Volumes are concatenated in VolumeNames
350 * separated by a vertical bar (|).
352 int db_get_job_volume_names(JCR *jcr, B_DB *mdb, uint32_t JobId, POOLMEM **VolumeNames)
360 if (!bdb_open_jobmedia_file(mdb)) {
364 if (!bdb_open_media_file(mdb)) {
371 fseek(mdb->jobmediafd, 0L, SEEK_SET); /* rewind the file */
372 while (fread(&jm, jmlen, 1, mdb->jobmediafd) > 0) {
373 if (jm.JobId == JobId) {
374 /* Now look up VolumeName in Media file given MediaId */
375 fseek(mdb->mediafd, 0L, SEEK_SET);
376 while (fread(&mr, mrlen, 1, mdb->mediafd) > 0) {
377 if (jm.MediaId == mr.MediaId) {
378 if (*VolumeNames[0] != 0) { /* if not first name, */
379 pm_strcat(VolumeNames, "|"); /* add separator */
381 pm_strcat(VolumeNames, mr.VolumeName); /* add Volume Name */
388 strcpy(mdb->errmsg, "No Volumes found.\n");
396 * If the ClientId is non-zero, we get its record,
397 * otherwise, we search on the Name
399 * Returns: 0 on failure
402 int db_get_client_record(JCR *jcr, B_DB *mdb, CLIENT_DBR *cr)
409 if (!bdb_open_client_file(mdb)) {
413 fseek(mdb->clientfd, 0L, SEEK_SET); /* rewind file */
415 * Linear search through Client records
418 while (fread(&lcr, len, 1, mdb->clientfd)) {
419 /* If id not zero, search by Id */
420 if (cr->ClientId != 0) {
421 if (cr->ClientId != lcr.ClientId) {
425 } else if (strcmp(cr->Name, lcr.Name) != 0) {
426 continue; /* not found */
428 memcpy(cr, &lcr, len);
430 Dmsg2(200, "Found Client record: ClientId=%d Name=%s\n",
431 lcr.ClientId, lcr.Name);
435 strcpy(mdb->errmsg, "Client record not found.\n");
442 * Get FileSet Record (We read the FILESET_DBR structure)
443 * If the FileSetId is non-zero, we get its record,
444 * otherwise, we search on the FileSet (its name).
446 * Returns: 0 on failure
449 int db_get_fileset_record(JCR *jcr, B_DB *mdb, FILESET_DBR *fsr)
455 if (!bdb_open_fileset_file(mdb)) {
459 fseek(mdb->filesetfd, 0L, SEEK_SET); /* rewind file */
461 * Linear search through FileSet records
463 while (fread(&lfsr, sizeof(lfsr), 1, mdb->filesetfd) > 0) {
464 /* If id not zero, search by Id */
465 if (fsr->FileSetId != 0) {
466 if (fsr->FileSetId != lfsr.FileSetId) {
469 /* Search by Name & MD5 */
470 } else if (strcmp(fsr->FileSet, lfsr.FileSet) != 0 ||
471 strcmp(fsr->MD5, lfsr.MD5) != 0) {
472 continue; /* not found */
474 /* Found desired record, now return it */
475 memcpy(fsr, &lfsr, sizeof(lfsr));
476 stat = fsr->FileSetId;
477 Dmsg2(200, "Found FileSet record: FileSetId=%d FileSet=%s\n",
478 lfsr.FileSetId, lfsr.FileSet);
482 strcpy(mdb->errmsg, "FileSet record not found.\n");
490 int db_get_file_attributes_record(JCR *jcr, B_DB *mdb, char *fname, JOB_DBR *jr, FILE_DBR *fdbr)
493 int db_get_job_volume_parameters(JCR *jcr, B_DB *mdb, uint32_t JobId, VOL_PARAMS **VolParams)
496 int db_get_client_ids(JCR *jcr, B_DB *mdb, int *num_ids, uint32_t *ids[])
499 int db_get_counter_record(JCR *jcr, B_DB *mdb, COUNTER_DBR *cr)
503 #endif /* HAVE_BACULA_DB */