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 * Kern Sibbald, March 2000
13 Copyright (C) 2000, 2001, 2002 Kern Sibbald and John Walker
15 This program is free software; you can redistribute it and/or
16 modify it under the terms of the GNU General Public License as
17 published by the Free Software Foundation; either version 2 of
18 the License, or (at your option) any later version.
20 This program is distributed in the hope that it will be useful,
21 but WITHOUT ANY WARRANTY; without even the implied warranty of
22 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
23 General Public License for more details.
25 You should have received a copy of the GNU General Public
26 License along with this program; if not, write to the Free
27 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
32 /* *****FIXME**** fix fixed length of select_cmd[] and insert_cmd[] */
34 /* The following is necessary so that we do not include
35 * the dummy external definition of DB.
37 #define __SQL_C /* indicate that this is sql.c */
42 #if HAVE_MYSQL || HAVE_SQLITE
44 /* -----------------------------------------------------------------------
46 * Generic Routines (or almost generic)
48 * -----------------------------------------------------------------------
51 /* Forward referenced functions */
52 static int db_get_file_record(B_DB *mdb, FILE_DBR *fdbr);
53 static int db_get_filename_record(B_DB *mdb, char *fname);
54 static int db_get_path_record(B_DB *mdb, char *path);
57 /* Imported subroutines */
58 extern void print_result(B_DB *mdb);
59 extern int QueryDB(char *file, int line, B_DB *db, char *select_cmd);
63 * Given a full filename (with path), look up the File record
64 * (with attributes) in the database.
66 * Returns: 0 on failure
67 * 1 on success with the File record in FILE_DBR
69 int db_get_file_attributes_record(B_DB *mdb, char *fname, FILE_DBR *fdbr)
75 char spath[MAXSTRING];
77 Dmsg1(20, "Enter get_file_from_catalog fname=%s \n", fname);
79 /* Find path without the filename.
80 * I.e. everything after the last / is a "filename".
81 * OK, maybe it is a directory name, but we treat it like
82 * a filename. If we don't find a / then the whole name
83 * must be a path name (e.g. c:).
85 for (p=l=fname; *p; p++) {
90 if (*l == '/') { /* did we find a slash? */
91 l++; /* yes, point to filename */
92 } else { /* no, whole thing must be path name */
96 /* If filename doesn't exist (i.e. root directory), we
97 * simply create a blank name consisting of a single
98 * space. This makes handling zero length filenames
103 Jmsg1(mdb->jcr, M_WARNING, 0, _("Filename truncated to 255 chars: %s\n"), l);
107 strncpy(file, l, fnl); /* copy filename */
110 file[0] = ' '; /* blank filename */
117 Jmsg1(mdb->jcr, M_WARNING, 0, _("Path name truncated to 255 chars: %s\n"), fname);
120 strncpy(spath, fname, pnl);
124 Mmsg1(&mdb->errmsg, _("Path length is zero. File=%s\n"), fname);
125 Jmsg(mdb->jcr, M_ERROR, 0, "%s", mdb->errmsg);
131 Dmsg1(400, "spath=%s\n", spath);
132 Dmsg1(400, "file=%s\n", file);
134 db_escape_string(buf, file, fnl);
135 fdbr->FilenameId = db_get_filename_record(mdb, buf);
136 Dmsg2(400, "db_get_filename_record FilenameId=%u file=%s\n", fdbr->FilenameId, buf);
138 db_escape_string(buf, spath, pnl);
139 fdbr->PathId = db_get_path_record(mdb, buf);
140 Dmsg2(400, "db_get_path_record PathId=%u path=%s\n", fdbr->PathId, buf);
142 stat = db_get_file_record(mdb, fdbr);
150 * Returns: 0 on failure
153 * DO NOT use Jmsg in this routine.
155 * Note in this routine, we do not use Jmsg because it may be
156 * called to get attributes of a non-existent file, which is
157 * "normal" if a new file is found during Verify.
160 int db_get_file_record(B_DB *mdb, FILE_DBR *fdbr)
167 "SELECT FileId, LStat, MD5 from File where File.JobId=%u and File.PathId=%u and \
168 File.FilenameId=%u", fdbr->JobId, fdbr->PathId, fdbr->FilenameId);
170 Dmsg3(050, "Get_file_record JobId=%u FilenameId=%u PathId=%u\n",
171 fdbr->JobId, fdbr->FilenameId, fdbr->PathId);
173 Dmsg1(100, "Query=%s\n", mdb->cmd);
175 if (QUERY_DB(mdb, mdb->cmd)) {
177 mdb->num_rows = sql_num_rows(mdb);
178 Dmsg1(050, "get_file_record num_rows=%d\n", (int)mdb->num_rows);
180 if (mdb->num_rows > 1) {
181 Mmsg1(&mdb->errmsg, _("get_file_record want 1 got rows=%d\n"),
184 if (mdb->num_rows >= 1) {
185 if ((row = sql_fetch_row(mdb)) == NULL) {
186 Mmsg1(&mdb->errmsg, _("Error fetching row: %s\n"), sql_strerror(mdb));
188 fdbr->FileId = (FileId_t)strtod(row[0], NULL);
189 strncpy(fdbr->LStat, row[1], sizeof(fdbr->LStat));
190 fdbr->LStat[sizeof(fdbr->LStat)] = 0;
191 strncpy(fdbr->MD5, row[2], sizeof(fdbr->MD5));
192 fdbr->MD5[sizeof(fdbr->MD5)] = 0;
196 Mmsg2(&mdb->errmsg, _("File record not found for PathId=%u FilenameId=%u\n"),
197 fdbr->PathId, fdbr->FilenameId);
199 sql_free_result(mdb);
206 /* Get Filename record
207 * Returns: 0 on failure
208 * FilenameId on success
210 * DO NOT use Jmsg in this routine (see notes for get_file_record)
212 static int db_get_filename_record(B_DB *mdb, char *fname)
218 Mmsg0(&mdb->errmsg, _("Null name given to db_get_filename_record\n"));
219 Emsg0(M_ABORT, 0, mdb->errmsg);
223 Mmsg(&mdb->cmd, "SELECT FilenameId FROM Filename WHERE Name='%s'", fname);
224 if (QUERY_DB(mdb, mdb->cmd)) {
226 mdb->num_rows = sql_num_rows(mdb);
228 if (mdb->num_rows > 1) {
229 Mmsg1(&mdb->errmsg, _("More than one Filename!: %d\n"), (int)(mdb->num_rows));
231 if (mdb->num_rows >= 1) {
232 if ((row = sql_fetch_row(mdb)) == NULL) {
233 Mmsg1(&mdb->errmsg, _("error fetching row: %s\n"), sql_strerror(mdb));
235 FilenameId = atoi(row[0]);
236 if (FilenameId <= 0) {
237 Mmsg2(&mdb->errmsg, _("Get DB Filename record %s found bad record: %d\n"),
238 mdb->cmd, FilenameId);
243 Mmsg1(&mdb->errmsg, _("Filename record: %s not found.\n"), fname);
245 sql_free_result(mdb);
252 * Returns: 0 on failure
255 * DO NOT use Jmsg in this routine (see notes for get_file_record)
257 static int db_get_path_record(B_DB *mdb, char *path)
263 Emsg0(M_ABORT, 0, _("Null path given to db_get_path_record\n"));
268 if (mdb->cached_path_id != 0 && strcmp(mdb->cached_path, path) == 0) {
270 return mdb->cached_path_id;
273 Mmsg(&mdb->cmd, "SELECT PathId FROM Path WHERE Path='%s'", path);
275 if (QUERY_DB(mdb, mdb->cmd)) {
277 mdb->num_rows = sql_num_rows(mdb);
279 if (mdb->num_rows > 1) {
280 Mmsg1(&mdb->errmsg, _("More than one Path!: %s\n"),
281 edit_uint64(mdb->num_rows, ed1));
282 Jmsg(mdb->jcr, M_ERROR, 0, "%s", mdb->errmsg);
283 } else if (mdb->num_rows == 1) {
284 if ((row = sql_fetch_row(mdb)) == NULL) {
285 Mmsg1(&mdb->errmsg, _("error fetching row: %s\n"), sql_strerror(mdb));
287 PathId = atoi(row[0]);
289 Mmsg2(&mdb->errmsg, _("Get DB path record %s found bad record: %u\n"),
294 if (PathId != mdb->cached_path_id) {
295 mdb->cached_path_id = PathId;
296 mdb->cached_path = check_pool_memory_size(mdb->cached_path,
298 strcpy(mdb->cached_path, path);
303 Mmsg1(&mdb->errmsg, _("Path record: %s not found.\n"), path);
305 sql_free_result(mdb);
313 * Get Job record for given JobId or Job name
314 * Returns: 0 on failure
317 int db_get_job_record(B_DB *mdb, JOB_DBR *jr)
322 if (jr->JobId == 0) {
323 Mmsg(&mdb->cmd, "SELECT VolSessionId,VolSessionTime,\
324 PoolId,StartTime,EndTime,JobFiles,JobBytes,JobTDate,Job,JobStatus,\
326 FROM Job WHERE Job='%s'", jr->Job);
328 Mmsg(&mdb->cmd, "SELECT VolSessionId,VolSessionTime,\
329 PoolId,StartTime,EndTime,JobFiles,JobBytes,JobTDate,Job,JobStatus,\
331 FROM Job WHERE JobId=%u", jr->JobId);
334 if (!QUERY_DB(mdb, mdb->cmd)) {
336 return 0; /* failed */
338 if ((row = sql_fetch_row(mdb)) == NULL) {
339 Mmsg1(&mdb->errmsg, _("No Job found for JobId %u\n"), jr->JobId);
340 sql_free_result(mdb);
342 return 0; /* failed */
345 jr->VolSessionId = atol(row[0]);
346 jr->VolSessionTime = atol(row[1]);
347 jr->PoolId = atoi(row[2]);
348 bstrncpy(jr->cStartTime, row[3]!=NULL?row[3]:"", sizeof(jr->cStartTime));
349 bstrncpy(jr->cEndTime, row[4]!=NULL?row[4]:"", sizeof(jr->cEndTime));
350 jr->JobFiles = atol(row[5]);
351 jr->JobBytes = (uint64_t)strtod(row[6], NULL);
352 jr->JobTDate = (utime_t)strtod(row[7], NULL);
353 bstrncpy(jr->Job, row[8]!=NULL?row[8]:"", sizeof(jr->Job));
354 jr->JobStatus = (int)*row[9];
355 jr->Type = (int)*row[10];
356 jr->Level = (int)*row[11];
357 sql_free_result(mdb);
364 * Find VolumeNames for a give JobId
365 * Returns: 0 on error or no Volumes found
366 * number of volumes on success
367 * Volumes are concatenated in VolumeNames
368 * separated by a vertical bar (|).
370 * Returns: number of volumes on success
372 int db_get_job_volume_names(B_DB *mdb, uint32_t JobId, POOLMEM **VolumeNames)
380 "SELECT VolumeName FROM JobMedia,Media WHERE JobMedia.JobId=%u \
381 AND JobMedia.MediaId=Media.MediaId", JobId);
383 Dmsg1(130, "VolNam=%s\n", mdb->cmd);
385 if (QUERY_DB(mdb, mdb->cmd)) {
386 mdb->num_rows = sql_num_rows(mdb);
387 Dmsg1(130, "Num rows=%d\n", mdb->num_rows);
388 if (mdb->num_rows <= 0) {
389 Mmsg1(&mdb->errmsg, _("No volumes found for JobId=%d\n"), JobId);
392 stat = mdb->num_rows;
393 for (i=0; i < stat; i++) {
394 if ((row = sql_fetch_row(mdb)) == NULL) {
395 Mmsg2(&mdb->errmsg, _("Error fetching row %d: ERR=%s\n"), i, sql_strerror(mdb));
396 Jmsg(mdb->jcr, M_ERROR, 0, "%s", mdb->errmsg);
400 if (*VolumeNames[0] != 0) {
401 pm_strcat(VolumeNames, "|");
403 pm_strcat(VolumeNames, row[0]);
407 sql_free_result(mdb);
414 * Find Volume parameters for a give JobId
415 * Returns: 0 on error or no Volumes found
416 * number of volumes on success
417 * List of Volumes and start/end file/blocks (malloced structure!)
419 * Returns: number of volumes on success
421 int db_get_job_volume_parameters(B_DB *mdb, uint32_t JobId, VOL_PARAMS **VolParams)
426 VOL_PARAMS *Vols = NULL;
430 "SELECT VolumeName,StartFile,EndFile,StartBlock,EndBlock"
431 " FROM JobMedia,Media WHERE JobMedia.JobId=%u"
432 " AND JobMedia.MediaId=Media.MediaId", JobId);
434 Dmsg1(130, "VolNam=%s\n", mdb->cmd);
435 if (QUERY_DB(mdb, mdb->cmd)) {
436 mdb->num_rows = sql_num_rows(mdb);
437 Dmsg1(130, "Num rows=%d\n", mdb->num_rows);
438 if (mdb->num_rows <= 0) {
439 Mmsg1(&mdb->errmsg, _("No volumes found for JobId=%d\n"), JobId);
442 stat = mdb->num_rows;
444 *VolParams = Vols = (VOL_PARAMS *)malloc(stat * sizeof(VOL_PARAMS));
446 for (i=0; i < stat; i++) {
447 if ((row = sql_fetch_row(mdb)) == NULL) {
448 Mmsg2(&mdb->errmsg, _("Error fetching row %d: ERR=%s\n"), i, sql_strerror(mdb));
449 Jmsg(mdb->jcr, M_ERROR, 0, "%s", mdb->errmsg);
453 bstrncpy(Vols[i].VolumeName, row[0], MAX_NAME_LENGTH);
454 Vols[i].StartFile = atoi(row[1]);
455 Vols[i].EndFile = atoi(row[2]);
456 Vols[i].StartBlock = atoi(row[3]);
457 Vols[i].EndBlock = atoi(row[4]);
461 sql_free_result(mdb);
470 * Get the number of pool records
472 * Returns: -1 on failure
475 int db_get_num_pool_records(B_DB *mdb)
480 Mmsg(&mdb->cmd, "SELECT count(*) from Pool");
481 stat = get_sql_record_max(mdb);
487 * This function returns a list of all the Pool record ids.
488 * The caller must free ids if non-NULL.
490 * Returns 0: on failure
493 int db_get_pool_ids(B_DB *mdb, int *num_ids, uint32_t *ids[])
502 Mmsg(&mdb->cmd, "SELECT PoolId FROM Pool");
503 if (QUERY_DB(mdb, mdb->cmd)) {
504 *num_ids = sql_num_rows(mdb);
506 id = (uint32_t *)malloc(*num_ids * sizeof(uint32_t));
507 while ((row = sql_fetch_row(mdb)) != NULL) {
508 id[i++] = (uint32_t)atoi(row[0]);
512 sql_free_result(mdb);
515 Mmsg(&mdb->errmsg, _("Pool id select failed: ERR=%s\n"), sql_strerror(mdb));
516 Jmsg(mdb->jcr, M_ERROR, 0, "%s", mdb->errmsg);
525 * If the PoolId is non-zero, we get its record,
526 * otherwise, we search on the PoolName
528 * Returns: 0 on failure
531 int db_get_pool_record(B_DB *mdb, POOL_DBR *pdbr)
537 if (pdbr->PoolId != 0) { /* find by id */
539 "SELECT PoolId,Name,NumVols,MaxVols,UseOnce,UseCatalog,AcceptAnyVolume,\
540 AutoPrune,Recycle,VolRetention,VolUseDuration,MaxVolJobs,MaxVolFiles,\
541 MaxVolBytes,PoolType,LabelFormat FROM Pool WHERE Pool.PoolId=%d", pdbr->PoolId);
542 } else { /* find by name */
544 "SELECT PoolId,Name,NumVols,MaxVols,UseOnce,UseCatalog,AcceptAnyVolume,\
545 AutoPrune,Recycle,VolRetention,VolUseDuration,MaxVolJobs,MaxVolFiles,\
546 MaxVolBytes,PoolType,LabelFormat FROM Pool WHERE Pool.Name='%s'", pdbr->Name);
549 if (QUERY_DB(mdb, mdb->cmd)) {
550 mdb->num_rows = sql_num_rows(mdb);
551 if (mdb->num_rows > 1) {
553 Mmsg1(&mdb->errmsg, _("More than one Pool!: %s\n"),
554 edit_uint64(mdb->num_rows, ed1));
555 Jmsg(mdb->jcr, M_ERROR, 0, "%s", mdb->errmsg);
556 } else if (mdb->num_rows == 1) {
557 if ((row = sql_fetch_row(mdb)) == NULL) {
558 Mmsg1(&mdb->errmsg, _("error fetching row: %s\n"), sql_strerror(mdb));
559 Jmsg(mdb->jcr, M_ERROR, 0, "%s", mdb->errmsg);
561 pdbr->PoolId = atoi(row[0]);
562 bstrncpy(pdbr->Name, row[1]!=NULL?row[1]:"", sizeof(pdbr->Name));
563 pdbr->NumVols = atoi(row[2]);
564 pdbr->MaxVols = atoi(row[3]);
565 pdbr->UseOnce = atoi(row[4]);
566 pdbr->UseCatalog = atoi(row[5]);
567 pdbr->AcceptAnyVolume = atoi(row[6]);
568 pdbr->AutoPrune = atoi(row[7]);
569 pdbr->Recycle = atoi(row[8]);
570 pdbr->VolRetention = (utime_t)strtod(row[9], NULL);
571 pdbr->VolUseDuration = (utime_t)strtod(row[10], NULL);
572 pdbr->MaxVolJobs = atoi(row[11]);
573 pdbr->MaxVolFiles = atoi(row[12]);
574 pdbr->MaxVolBytes = (uint64_t)strtod(row[13], NULL);
575 bstrncpy(pdbr->PoolType, row[13]!=NULL?row[14]:"", sizeof(pdbr->PoolType));
576 bstrncpy(pdbr->LabelFormat, row[14]!=NULL?row[15]:"", sizeof(pdbr->LabelFormat));
580 sql_free_result(mdb);
586 /* Get FileSet Record
587 * If the FileSetId is non-zero, we get its record,
588 * otherwise, we search on the name
590 * Returns: 0 on failure
593 int db_get_fileset_record(B_DB *mdb, FILESET_DBR *fsr)
599 if (fsr->FileSetId != 0) { /* find by id */
601 "SELECT FileSetId, FileSet, MD5 FROM FileSet "
602 "WHERE FileSetId=%u", fsr->FileSetId);
603 } else { /* find by name */
605 "SELECT FileSetId, FileSet, MD5 FROM FileSet "
606 "WHERE FileSet='%s'", fsr->FileSet);
609 if (QUERY_DB(mdb, mdb->cmd)) {
610 mdb->num_rows = sql_num_rows(mdb);
611 if (mdb->num_rows > 1) {
613 Mmsg1(&mdb->errmsg, _("Error got %s FileSets but expected only one!\n"),
614 edit_uint64(mdb->num_rows, ed1));
615 sql_data_seek(mdb, mdb->num_rows-1);
617 if ((row = sql_fetch_row(mdb)) == NULL) {
618 Mmsg1(&mdb->errmsg, _("Error: FileSet record \"%s\" not found\n"), fsr->FileSet);
620 fsr->FileSetId = atoi(row[0]);
621 bstrncpy(fsr->FileSet, row[1]!=NULL?row[1]:"", sizeof(fsr->FileSet));
622 bstrncpy(fsr->MD5, row[2]!=NULL?row[2]:"", sizeof(fsr->MD5));
623 stat = fsr->FileSetId;
625 sql_free_result(mdb);
633 * Get the number of Media records
635 * Returns: -1 on failure
638 int db_get_num_media_records(B_DB *mdb)
643 Mmsg(&mdb->cmd, "SELECT count(*) from Media");
644 stat = get_sql_record_max(mdb);
651 * This function returns a list of all the Media record ids.
652 * The caller must free ids if non-NULL.
654 * Returns 0: on failure
657 int db_get_media_ids(B_DB *mdb, int *num_ids, uint32_t *ids[])
666 Mmsg(&mdb->cmd, "SELECT MediaId FROM Media");
667 if (QUERY_DB(mdb, mdb->cmd)) {
668 *num_ids = sql_num_rows(mdb);
670 id = (uint32_t *)malloc(*num_ids * sizeof(uint32_t));
671 while ((row = sql_fetch_row(mdb)) != NULL) {
672 id[i++] = (uint32_t)atoi(row[0]);
676 sql_free_result(mdb);
679 Mmsg(&mdb->errmsg, _("Media id select failed: ERR=%s\n"), sql_strerror(mdb));
680 Jmsg(mdb->jcr, M_ERROR, 0, "%s", mdb->errmsg);
690 * Returns: 0 on failure
693 int db_get_media_record(B_DB *mdb, MEDIA_DBR *mr)
699 if (mr->MediaId == 0 && mr->VolumeName[0] == 0) {
700 Mmsg(&mdb->cmd, "SELECT count(*) from Media");
701 mr->MediaId = get_sql_record_max(mdb);
705 if (mr->MediaId != 0) { /* find by id */
706 Mmsg(&mdb->cmd, "SELECT MediaId,VolumeName,VolJobs,VolFiles,VolBlocks,\
707 VolBytes,VolMounts,VolErrors,VolWrites,MaxVolBytes,VolCapacityBytes,\
708 MediaType,VolStatus,PoolId,VolRetention,VolUseDuration,MaxVolJobs,MaxVolFiles,\
709 Recycle,Slot, FirstWritten \
710 FROM Media WHERE MediaId=%d", mr->MediaId);
711 } else { /* find by name */
712 Mmsg(&mdb->cmd, "SELECT MediaId,VolumeName,VolJobs,VolFiles,VolBlocks,\
713 VolBytes,VolMounts,VolErrors,VolWrites,MaxVolBytes,VolCapacityBytes,\
714 MediaType,VolStatus,PoolId,VolRetention,VolUseDuration,MaxVolJobs,MaxVolFiles,\
715 Recycle,Slot,FirstWritten \
716 FROM Media WHERE VolumeName='%s'", mr->VolumeName);
719 if (QUERY_DB(mdb, mdb->cmd)) {
720 mdb->num_rows = sql_num_rows(mdb);
721 if (mdb->num_rows > 1) {
723 Mmsg1(&mdb->errmsg, _("More than one Volume!: %s\n"),
724 edit_uint64(mdb->num_rows, ed1));
725 Jmsg(mdb->jcr, M_ERROR, 0, "%s", mdb->errmsg);
726 } else if (mdb->num_rows == 1) {
727 if ((row = sql_fetch_row(mdb)) == NULL) {
728 Mmsg1(&mdb->errmsg, _("error fetching row: %s\n"), sql_strerror(mdb));
729 Jmsg(mdb->jcr, M_ERROR, 0, "%s", mdb->errmsg);
732 mr->MediaId = atoi(row[0]);
733 bstrncpy(mr->VolumeName, row[1]!=NULL?row[1]:"", sizeof(mr->VolumeName));
734 mr->VolJobs = atoi(row[2]);
735 mr->VolFiles = atoi(row[3]);
736 mr->VolBlocks = atoi(row[4]);
737 mr->VolBytes = (uint64_t)strtod(row[5], NULL);
738 mr->VolMounts = atoi(row[6]);
739 mr->VolErrors = atoi(row[7]);
740 mr->VolWrites = atoi(row[8]);
741 mr->MaxVolBytes = (uint64_t)strtod(row[9], NULL);
742 mr->VolCapacityBytes = (uint64_t)strtod(row[10], NULL);
743 bstrncpy(mr->MediaType, row[11]!=NULL?row[11]:"", sizeof(mr->MediaType));
744 bstrncpy(mr->VolStatus, row[12]!=NULL?row[12]:"", sizeof(mr->VolStatus));
745 mr->PoolId = atoi(row[13]);
746 mr->VolRetention = (utime_t)strtod(row[14], NULL);
747 mr->VolUseDuration = (utime_t)strtod(row[15], NULL);
748 mr->MaxVolJobs = atoi(row[16]);
749 mr->MaxVolFiles = atoi(row[17]);
750 mr->Recycle = atoi(row[18]);
751 mr->Slot = atoi(row[19]);
752 bstrncpy(mr->cFirstWritten, row[20]!=NULL?row[20]:"", sizeof(mr->cFirstWritten));
756 Mmsg0(&mdb->errmsg, _("Media record not found.\n"));
758 sql_free_result(mdb);
765 #endif /* HAVE_MYSQL || HAVE_SQLITE */