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(100, "spath=%s\n", spath);
132 Dmsg1(100, "file=%s\n", file);
134 db_escape_string(buf, file, fnl);
135 fdbr->FilenameId = db_get_filename_record(mdb, buf);
136 Dmsg2(100, "db_get_filename_record FilenameId=%d file=%s\n", fdbr->FilenameId, buf);
138 db_escape_string(buf, spath, pnl);
139 fdbr->PathId = db_get_path_record(mdb, buf);
140 Dmsg2(100, "db_get_path_record PathId=%d path=%s\n", fdbr->PathId, buf);
142 id = db_get_file_record(mdb, fdbr);
150 * Returns: 0 on failure
154 int db_get_file_record(B_DB *mdb, FILE_DBR *fdbr)
161 "SELECT FileId, LStat, MD5 from File where File.JobId=%d and File.PathId=%d and \
162 File.FilenameId=%d", fdbr->JobId, fdbr->PathId, fdbr->FilenameId);
164 Dmsg3(050, "Get_file_record JobId=%d FilenameId=%d PathId=%d\n",
165 fdbr->JobId, fdbr->FilenameId, fdbr->PathId);
167 Dmsg1(100, "Query=%s\n", mdb->cmd);
169 if (QUERY_DB(mdb, mdb->cmd)) {
171 mdb->num_rows = sql_num_rows(mdb);
172 Dmsg1(050, "get_file_record num_rows=%d\n", (int)mdb->num_rows);
175 * Note, we can find more than one File record with the same
176 * filename if the file is linked. ????????
178 if (mdb->num_rows > 1) {
179 Jmsg1(mdb->jcr, M_WARNING, 0, _("get_file_record want 1 got rows=%d\n"), mdb->num_rows);
180 Jmsg1(mdb->jcr, M_ERROR, 0, "%s", mdb->cmd);
182 if (mdb->num_rows >= 1) {
183 if ((row = sql_fetch_row(mdb)) == NULL) {
184 Mmsg1(&mdb->errmsg, "Error fetching row: %s\n", sql_strerror(mdb));
185 Jmsg(mdb->jcr, M_ERROR, 0, "%s", mdb->errmsg);
187 fdbr->FileId = (FileId_t)strtod(row[0], NULL);
188 strncpy(fdbr->LStat, row[1], sizeof(fdbr->LStat));
189 fdbr->LStat[sizeof(fdbr->LStat)] = 0;
190 strncpy(fdbr->MD5, row[2], sizeof(fdbr->MD5));
191 fdbr->MD5[sizeof(fdbr->MD5)] = 0;
195 sql_free_result(mdb);
202 /* Get Filename record
203 * Returns: 0 on failure
204 * FilenameId on success
206 static int db_get_filename_record(B_DB *mdb, char *fname)
212 Mmsg0(&mdb->errmsg, _("Null name given to db_get_filename_record\n"));
213 Emsg0(M_ABORT, 0, mdb->errmsg);
217 Mmsg(&mdb->cmd, "SELECT FilenameId FROM Filename WHERE Name='%s'", fname);
218 if (QUERY_DB(mdb, mdb->cmd)) {
220 mdb->num_rows = sql_num_rows(mdb);
222 if (mdb->num_rows > 1) {
223 Mmsg1(&mdb->errmsg, _("More than one Filename!: %d\n"), (int)(mdb->num_rows));
224 Jmsg(mdb->jcr, M_WARNING, 0, "%s", mdb->errmsg);
226 if (mdb->num_rows >= 1) {
227 if ((row = sql_fetch_row(mdb)) == NULL) {
228 Mmsg1(&mdb->errmsg, _("error fetching row: %s\n"), sql_strerror(mdb));
229 Jmsg(mdb->jcr, M_ERROR, 0, "%s", mdb->errmsg);
231 FilenameId = atoi(row[0]);
232 if (FilenameId <= 0) {
233 Mmsg2(&mdb->errmsg, _("Get DB Filename record %s found bad record: %d\n"),
234 mdb->cmd, FilenameId);
235 Jmsg(mdb->jcr, M_ERROR, 0, "%s", mdb->errmsg);
240 sql_free_result(mdb);
247 * Returns: 0 on failure
250 static int db_get_path_record(B_DB *mdb, char *path)
256 Emsg0(M_ABORT, 0, _("Null path given to db_get_path_record\n"));
261 if (mdb->cached_path_id != 0 && strcmp(mdb->cached_path, path) == 0) {
263 return mdb->cached_path_id;
266 Mmsg(&mdb->cmd, "SELECT PathId FROM Path WHERE Path='%s'", path);
268 if (QUERY_DB(mdb, mdb->cmd)) {
270 mdb->num_rows = sql_num_rows(mdb);
272 if (mdb->num_rows > 1) {
273 Mmsg1(&mdb->errmsg, _("More than one Path!: %s\n"),
274 edit_uint64(mdb->num_rows, ed1));
275 Jmsg(mdb->jcr, M_ERROR, 0, "%s", mdb->errmsg);
276 } else if (mdb->num_rows == 1) {
277 if ((row = sql_fetch_row(mdb)) == NULL) {
278 Mmsg1(&mdb->errmsg, _("error fetching row: %s\n"), sql_strerror(mdb));
279 Jmsg(mdb->jcr, M_ERROR, 0, "%s", mdb->errmsg);
281 PathId = atoi(row[0]);
283 Mmsg2(&mdb->errmsg, _("Get DB path record %s found bad record: %d\n"),
285 Jmsg(mdb->jcr, M_ERROR, 0, "%s", mdb->errmsg);
289 if (PathId != mdb->cached_path_id) {
290 mdb->cached_path_id = PathId;
291 mdb->cached_path = check_pool_memory_size(mdb->cached_path,
293 strcpy(mdb->cached_path, path);
298 sql_free_result(mdb);
306 * Get Job record for given JobId or Job name
307 * Returns: 0 on failure
310 int db_get_job_record(B_DB *mdb, JOB_DBR *jr)
315 if (jr->JobId == 0) {
316 Mmsg(&mdb->cmd, "SELECT VolSessionId, VolSessionTime, \
317 PoolId, StartTime, EndTime, JobFiles, JobBytes, JobTDate, Job, JobStatus \
318 FROM Job WHERE Job='%s'", jr->Job);
320 Mmsg(&mdb->cmd, "SELECT VolSessionId, VolSessionTime, \
321 PoolId, StartTime, EndTime, JobFiles, JobBytes, JobTDate, Job, JobStatus \
322 FROM Job WHERE JobId=%d", jr->JobId);
325 if (!QUERY_DB(mdb, mdb->cmd)) {
327 return 0; /* failed */
329 if ((row = sql_fetch_row(mdb)) == NULL) {
330 Mmsg1(&mdb->errmsg, _("No Job found for JobId %d\n"), jr->JobId);
331 Jmsg(mdb->jcr, M_ERROR, 0, "%s", mdb->errmsg);
332 sql_free_result(mdb);
334 return 0; /* failed */
337 jr->VolSessionId = atol(row[0]);
338 jr->VolSessionTime = atol(row[1]);
339 jr->PoolId = atoi(row[2]);
340 strcpy(jr->cStartTime, row[3]);
341 strcpy(jr->cEndTime, row[4]);
342 jr->JobFiles = atol(row[5]);
343 jr->JobBytes = (uint64_t)strtod(row[6], NULL);
344 jr->JobTDate = (btime_t)strtod(row[7], NULL);
345 strcpy(jr->Job, row[8]);
346 jr->JobStatus = (int)*row[9];
347 sql_free_result(mdb);
354 * Find VolumeNames for a give JobId
355 * Returns: 0 on error or no Volumes found
356 * number of volumes on success
357 * Volumes are concatenated in VolumeNames
358 * separated by a vertical bar (|).
360 int db_get_job_volume_names(B_DB *mdb, uint32_t JobId, POOLMEM **VolumeNames)
368 "SELECT VolumeName FROM JobMedia,Media WHERE JobMedia.JobId=%d \
369 AND JobMedia.MediaId=Media.MediaId", JobId);
371 Dmsg1(130, "VolNam=%s\n", mdb->cmd);
373 if (QUERY_DB(mdb, mdb->cmd)) {
374 mdb->num_rows = sql_num_rows(mdb);
375 Dmsg1(130, "Num rows=%d\n", mdb->num_rows);
376 if (mdb->num_rows <= 0) {
377 Mmsg1(&mdb->errmsg, _("No volumes found for JobId=%d"), JobId);
378 Jmsg(mdb->jcr, M_ERROR, 0, "%s", mdb->errmsg);
381 stat = mdb->num_rows;
382 for (i=0; i < stat; i++) {
383 if ((row = sql_fetch_row(mdb)) == NULL) {
384 Mmsg2(&mdb->errmsg, _("Error fetching row %d: ERR=%s\n"), i, sql_strerror(mdb));
385 Jmsg(mdb->jcr, M_ERROR, 0, "%s", mdb->errmsg);
389 if (*VolumeNames[0] != 0) {
390 pm_strcat(VolumeNames, "|");
392 pm_strcat(VolumeNames, row[0]);
396 sql_free_result(mdb);
404 * Get the number of pool records
406 * Returns: -1 on failure
409 int db_get_num_pool_records(B_DB *mdb)
414 Mmsg(&mdb->cmd, "SELECT count(*) from Pool");
415 stat = get_sql_record_max(mdb);
421 * This function returns a list of all the Pool record ids.
422 * The caller must free ids if non-NULL.
424 * Returns 0: on failure
427 int db_get_pool_ids(B_DB *mdb, int *num_ids, uint32_t *ids[])
436 Mmsg(&mdb->cmd, "SELECT PoolId FROM Pool");
437 if (QUERY_DB(mdb, mdb->cmd)) {
438 *num_ids = sql_num_rows(mdb);
440 id = (uint32_t *)malloc(*num_ids * sizeof(uint32_t));
441 while ((row = sql_fetch_row(mdb)) != NULL) {
442 id[i++] = (uint32_t)atoi(row[0]);
446 sql_free_result(mdb);
449 Mmsg(&mdb->errmsg, _("Pool id select failed: ERR=%s\n"), sql_strerror(mdb));
450 Jmsg(mdb->jcr, M_ERROR, 0, "%s", mdb->errmsg);
459 * If the PoolId is non-zero, we get its record,
460 * otherwise, we search on the PoolName
462 * Returns: 0 on failure
465 int db_get_pool_record(B_DB *mdb, POOL_DBR *pdbr)
471 if (pdbr->PoolId != 0) { /* find by id */
473 "SELECT PoolId, Name, NumVols, MaxVols, UseOnce, UseCatalog, AcceptAnyVolume, \
474 AutoPrune, Recycle, VolRetention, \
475 PoolType, LabelFormat FROM Pool WHERE Pool.PoolId=%d", pdbr->PoolId);
476 } else { /* find by name */
478 "SELECT PoolId, Name, NumVols, MaxVols, UseOnce, UseCatalog, AcceptAnyVolume, \
479 AutoPrune, Recycle, VolRetention, \
480 PoolType, LabelFormat FROM Pool WHERE Pool.Name='%s'", pdbr->Name);
483 if (QUERY_DB(mdb, mdb->cmd)) {
484 mdb->num_rows = sql_num_rows(mdb);
485 if (mdb->num_rows > 1) {
487 Mmsg1(&mdb->errmsg, _("More than one Pool!: %s\n"),
488 edit_uint64(mdb->num_rows, ed1));
489 Jmsg(mdb->jcr, M_ERROR, 0, "%s", mdb->errmsg);
490 } else if (mdb->num_rows == 1) {
491 if ((row = sql_fetch_row(mdb)) == NULL) {
492 Mmsg1(&mdb->errmsg, _("error fetching row: %s\n"), sql_strerror(mdb));
493 Jmsg(mdb->jcr, M_ERROR, 0, "%s", mdb->errmsg);
495 pdbr->PoolId = atoi(row[0]);
496 strcpy(pdbr->Name, row[1]);
497 pdbr->NumVols = atoi(row[2]);
498 pdbr->MaxVols = atoi(row[3]);
499 pdbr->UseOnce = atoi(row[4]);
500 pdbr->UseCatalog = atoi(row[5]);
501 pdbr->AcceptAnyVolume = atoi(row[6]);
502 pdbr->AutoPrune = atoi(row[7]);
503 pdbr->Recycle = atoi(row[8]);
504 pdbr->VolRetention = (btime_t)strtod(row[9], NULL);
505 strcpy(pdbr->PoolType, row[10]);
507 strcpy(pdbr->LabelFormat, row[11]);
509 pdbr->LabelFormat[0] = 0;
514 sql_free_result(mdb);
520 /* Get FileSet Record
521 * If the FileSetId is non-zero, we get its record,
522 * otherwise, we search on the name
524 * Returns: 0 on failure
527 int db_get_fileset_record(B_DB *mdb, FILESET_DBR *fsr)
533 if (fsr->FileSetId != 0) { /* find by id */
535 "SELECT FileSetId, FileSet, MD5 FROM FileSet "
536 "WHERE FileSetId=%u", fsr->FileSetId);
537 } else { /* find by name */
539 "SELECT FileSetId, FileSet, MD5 FROM FileSet "
540 "WHERE FileSet='%s'", fsr->FileSet);
543 if (QUERY_DB(mdb, mdb->cmd)) {
544 mdb->num_rows = sql_num_rows(mdb);
545 if (mdb->num_rows > 1) {
547 Mmsg1(&mdb->errmsg, _("Got %s FileSets expected only one!\n"),
548 edit_uint64(mdb->num_rows, ed1));
549 Jmsg(mdb->jcr, M_ERROR, 0, "%s", mdb->errmsg);
550 sql_data_seek(mdb, mdb->num_rows-1);
552 if ((row = sql_fetch_row(mdb)) == NULL) {
553 Mmsg1(&mdb->errmsg, _("Error fetching row get_fileset: %s\n"), sql_strerror(mdb));
554 Jmsg(mdb->jcr, M_ERROR, 0, "%s", mdb->errmsg);
556 fsr->FileSetId = atoi(row[0]);
557 strcpy(fsr->FileSet, row[1]);
558 strcpy(fsr->MD5, row[2]);
559 stat = fsr->FileSetId;
561 sql_free_result(mdb);
569 * Get the number of Media records
571 * Returns: -1 on failure
574 int db_get_num_media_records(B_DB *mdb)
579 Mmsg(&mdb->cmd, "SELECT count(*) from Media");
580 stat = get_sql_record_max(mdb);
587 * This function returns a list of all the Media record ids.
588 * The caller must free ids if non-NULL.
590 * Returns 0: on failure
593 int db_get_media_ids(B_DB *mdb, int *num_ids, uint32_t *ids[])
602 Mmsg(&mdb->cmd, "SELECT MediaId FROM Media");
603 if (QUERY_DB(mdb, mdb->cmd)) {
604 *num_ids = sql_num_rows(mdb);
606 id = (uint32_t *)malloc(*num_ids * sizeof(uint32_t));
607 while ((row = sql_fetch_row(mdb)) != NULL) {
608 id[i++] = (uint32_t)atoi(row[0]);
612 sql_free_result(mdb);
615 Mmsg(&mdb->errmsg, _("Media id select failed: ERR=%s\n"), sql_strerror(mdb));
616 Jmsg(mdb->jcr, M_ERROR, 0, "%s", mdb->errmsg);
626 * Returns: 0 on failure
629 int db_get_media_record(B_DB *mdb, MEDIA_DBR *mr)
635 if (mr->MediaId == 0 && mr->VolumeName[0] == 0) {
636 Mmsg(&mdb->cmd, "SELECT count(*) from Media");
637 mr->MediaId = get_sql_record_max(mdb);
641 if (mr->MediaId != 0) { /* find by id */
642 Mmsg(&mdb->cmd, "SELECT MediaId,VolumeName,VolJobs,VolFiles,VolBlocks,\
643 VolBytes,VolMounts,VolErrors,VolWrites,VolMaxBytes,VolCapacityBytes,\
644 MediaType,VolStatus,PoolId,VolRetention,Recycle,Slot \
645 FROM Media WHERE MediaId=%d", mr->MediaId);
646 } else { /* find by name */
647 Mmsg(&mdb->cmd, "SELECT MediaId,VolumeName,VolJobs,VolFiles,VolBlocks,\
648 VolBytes,VolMounts,VolErrors,VolWrites,VolMaxBytes,VolCapacityBytes,\
649 MediaType,VolStatus,PoolId,VolRetention,Recycle,Slot \
650 FROM Media WHERE VolumeName='%s'", mr->VolumeName);
653 if (QUERY_DB(mdb, mdb->cmd)) {
654 mdb->num_rows = sql_num_rows(mdb);
655 if (mdb->num_rows > 1) {
657 Mmsg1(&mdb->errmsg, _("More than one Volume!: %s\n"),
658 edit_uint64(mdb->num_rows, ed1));
659 Jmsg(mdb->jcr, M_ERROR, 0, "%s", mdb->errmsg);
660 } else if (mdb->num_rows == 1) {
661 if ((row = sql_fetch_row(mdb)) == NULL) {
662 Mmsg1(&mdb->errmsg, _("error fetching row: %s\n"), sql_strerror(mdb));
663 Jmsg(mdb->jcr, M_ERROR, 0, "%s", mdb->errmsg);
666 mr->MediaId = atoi(row[0]);
667 strcpy(mr->VolumeName, row[1]);
668 mr->VolJobs = atoi(row[2]);
669 mr->VolFiles = atoi(row[3]);
670 mr->VolBlocks = atoi(row[4]);
671 mr->VolBytes = (uint64_t)strtod(row[5], NULL);
672 mr->VolMounts = atoi(row[6]);
673 mr->VolErrors = atoi(row[7]);
674 mr->VolWrites = atoi(row[8]);
675 mr->VolMaxBytes = (uint64_t)strtod(row[9], NULL);
676 mr->VolCapacityBytes = (uint64_t)strtod(row[10], NULL);
677 strcpy(mr->MediaType, row[11]);
678 strcpy(mr->VolStatus, row[12]);
679 mr->PoolId = atoi(row[13]);
680 mr->VolRetention = (btime_t)strtod(row[14], NULL);
681 mr->Recycle = atoi(row[15]);
682 mr->Slot = atoi(row[16]);
686 Mmsg0(&mdb->errmsg, _("Media record not found.\n"));
688 sql_free_result(mdb);
695 #endif /* HAVE_MYSQL || HAVE_SQLITE */