2 Bacula® - The Network Backup Solution
4 Copyright (C) 2002-2010 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 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 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.
30 * Bacula Director -- User Agent Database Purge Command
32 * Purges Files from specific JobIds
34 * Purges Jobs from Volumes
36 * Kern Sibbald, February MMII
43 /* Forward referenced functions */
44 static int purge_files_from_client(UAContext *ua, CLIENT *client);
45 static int purge_jobs_from_client(UAContext *ua, CLIENT *client);
46 static int action_on_purge_cmd(UAContext *ua, const char *cmd);
48 static const char *select_jobsfiles_from_client =
49 "SELECT JobId FROM Job "
53 static const char *select_jobs_from_client =
54 "SELECT JobId, PurgedFiles FROM Job "
58 * Purge records from database
60 * Purge Files (from) [Job|JobId|Client|Volume]
61 * Purge Jobs (from) [Client|Volume]
63 * N.B. Not all above is implemented yet.
65 int purgecmd(UAContext *ua, const char *cmd)
71 static const char *keywords[] = {
77 static const char *files_keywords[] = {
84 static const char *jobs_keywords[] = {
90 "\nThis command can be DANGEROUS!!!\n\n"
91 "It purges (deletes) all Files from a Job,\n"
92 "JobId, Client or Volume; or it purges (deletes)\n"
93 "all Jobs from a Client or Volume without regard\n"
94 "to retention periods. Normally you should use the\n"
95 "PRUNE command, which respects retention periods.\n"));
100 switch (find_arg_keyword(ua, keywords)) {
103 switch(find_arg_keyword(ua, files_keywords)) {
106 if (get_job_dbr(ua, &jr)) {
108 edit_int64(jr.JobId, jobid);
109 purge_files_from_jobs(ua, jobid);
113 client = get_client_resource(ua);
115 purge_files_from_client(ua, client);
119 if (select_media_dbr(ua, &mr)) {
120 purge_files_from_volume(ua, &mr);
126 switch(find_arg_keyword(ua, jobs_keywords)) {
128 client = get_client_resource(ua);
130 purge_jobs_from_client(ua, client);
134 if (select_media_dbr(ua, &mr)) {
135 purge_jobs_from_volume(ua, &mr, /*force*/true);
141 /* Perform ActionOnPurge (action=truncate) */
142 if (find_arg(ua, "action") >= 0) {
143 return action_on_purge_cmd(ua, ua->cmd);
146 while ((i=find_arg(ua, NT_("volume"))) >= 0) {
147 if (select_media_dbr(ua, &mr)) {
148 purge_jobs_from_volume(ua, &mr, /*force*/true);
150 *ua->argk[i] = 0; /* zap keyword already seen */
157 switch (do_keyword_prompt(ua, _("Choose item to purge"), keywords)) {
159 client = get_client_resource(ua);
161 purge_files_from_client(ua, client);
165 client = get_client_resource(ua);
167 purge_jobs_from_client(ua, client);
171 if (select_media_dbr(ua, &mr)) {
172 purge_jobs_from_volume(ua, &mr, /*force*/true);
180 * Purge File records from the database. For any Job which
181 * is older than the retention period, we unconditionally delete
182 * all File records for that Job. This is simple enough that no
183 * temporary tables are needed. We simply make an in memory list of
184 * the JobIds meeting the prune conditions, then delete all File records
185 * pointing to each of those JobIds.
187 static int purge_files_from_client(UAContext *ua, CLIENT *client)
190 POOL_MEM query(PM_MESSAGE);
194 memset(&cr, 0, sizeof(cr));
195 bstrncpy(cr.Name, client->name(), sizeof(cr.Name));
196 if (!db_create_client_record(ua->jcr, ua->db, &cr)) {
200 memset(&del, 0, sizeof(del));
202 del.JobId = (JobId_t *)malloc(sizeof(JobId_t) * del.max_ids);
204 ua->info_msg(_("Begin purging files for Client \"%s\"\n"), cr.Name);
206 Mmsg(query, select_jobsfiles_from_client, edit_int64(cr.ClientId, ed1));
207 Dmsg1(050, "select sql=%s\n", query.c_str());
208 db_sql_query(ua->db, query.c_str(), file_delete_handler, (void *)&del);
210 purge_files_from_job_list(ua, del);
212 if (del.num_ids == 0) {
213 ua->warning_msg(_("No Files found for client %s to purge from %s catalog.\n"),
214 client->name(), client->catalog->name());
216 ua->info_msg(_("Files for %d Jobs for client \"%s\" purged from %s catalog.\n"), del.num_ids,
217 client->name(), client->catalog->name());
229 * Purge Job records from the database. For any Job which
230 * is older than the retention period, we unconditionally delete
231 * it and all File records for that Job. This is simple enough that no
232 * temporary tables are needed. We simply make an in memory list of
233 * the JobIds then delete the Job, Files, and JobMedia records in that list.
235 static int purge_jobs_from_client(UAContext *ua, CLIENT *client)
238 POOL_MEM query(PM_MESSAGE);
242 memset(&cr, 0, sizeof(cr));
244 bstrncpy(cr.Name, client->name(), sizeof(cr.Name));
245 if (!db_create_client_record(ua->jcr, ua->db, &cr)) {
249 memset(&del, 0, sizeof(del));
251 del.JobId = (JobId_t *)malloc(sizeof(JobId_t) * del.max_ids);
252 del.PurgedFiles = (char *)malloc(del.max_ids);
254 ua->info_msg(_("Begin purging jobs from Client \"%s\"\n"), cr.Name);
256 Mmsg(query, select_jobs_from_client, edit_int64(cr.ClientId, ed1));
257 Dmsg1(150, "select sql=%s\n", query.c_str());
258 db_sql_query(ua->db, query.c_str(), job_delete_handler, (void *)&del);
260 purge_job_list_from_catalog(ua, del);
262 if (del.num_ids == 0) {
263 ua->warning_msg(_("No Files found for client %s to purge from %s catalog.\n"),
264 client->name(), client->catalog->name());
266 ua->info_msg(_("%d Jobs for client %s purged from %s catalog.\n"), del.num_ids,
267 client->name(), client->catalog->name());
273 if (del.PurgedFiles) {
274 free(del.PurgedFiles);
281 * Remove File records from a list of JobIds
283 void purge_files_from_jobs(UAContext *ua, char *jobs)
285 POOL_MEM query(PM_MESSAGE);
287 Mmsg(query, "DELETE FROM File WHERE JobId IN (%s)", jobs);
288 db_sql_query(ua->db, query.c_str(), NULL, (void *)NULL);
289 Dmsg1(050, "Delete File sql=%s\n", query.c_str());
291 Mmsg(query, "DELETE FROM BaseFiles WHERE JobId IN (%s)", jobs);
292 db_sql_query(ua->db, query.c_str(), NULL, (void *)NULL);
293 Dmsg1(050, "Delete BaseFiles sql=%s\n", query.c_str());
296 * Now mark Job as having files purged. This is necessary to
297 * avoid having too many Jobs to process in future prunings. If
298 * we don't do this, the number of JobId's in our in memory list
299 * could grow very large.
301 Mmsg(query, "UPDATE Job SET PurgedFiles=1 WHERE JobId IN (%s)", jobs);
302 db_sql_query(ua->db, query.c_str(), NULL, (void *)NULL);
303 Dmsg1(050, "Mark purged sql=%s\n", query.c_str());
307 * Delete jobs (all records) from the catalog in groups of 1000
310 void purge_job_list_from_catalog(UAContext *ua, del_ctx &del)
312 POOL_MEM jobids(PM_MESSAGE);
315 for (int i=0; del.num_ids; ) {
316 Dmsg1(150, "num_ids=%d\n", del.num_ids);
317 pm_strcat(jobids, "");
318 for (int j=0; j<1000 && del.num_ids>0; j++) {
320 if (del.JobId[i] == 0 || ua->jcr->JobId == del.JobId[i]) {
321 Dmsg2(150, "skip JobId[%d]=%d\n", i, (int)del.JobId[i]);
325 if (*jobids.c_str() != 0) {
326 pm_strcat(jobids, ",");
328 pm_strcat(jobids, edit_int64(del.JobId[i++], ed1));
329 Dmsg1(150, "Add id=%s\n", ed1);
332 Dmsg1(150, "num_ids=%d\n", del.num_ids);
333 purge_jobs_from_catalog(ua, jobids.c_str());
338 * Delete files from a list of jobs in groups of 1000
341 void purge_files_from_job_list(UAContext *ua, del_ctx &del)
343 POOL_MEM jobids(PM_MESSAGE);
346 * OK, now we have the list of JobId's to be pruned, send them
347 * off to be deleted batched 1000 at a time.
349 for (int i=0; del.num_ids; ) {
350 pm_strcat(jobids, "");
351 for (int j=0; j<1000 && del.num_ids>0; j++) {
353 if (del.JobId[i] == 0 || ua->jcr->JobId == del.JobId[i]) {
354 Dmsg2(150, "skip JobId[%d]=%d\n", i, (int)del.JobId[i]);
358 if (*jobids.c_str() != 0) {
359 pm_strcat(jobids, ",");
361 pm_strcat(jobids, edit_int64(del.JobId[i++], ed1));
362 Dmsg1(150, "Add id=%s\n", ed1);
365 purge_files_from_jobs(ua, jobids.c_str());
370 * Change the type of the next copy job to backup.
371 * We need to upgrade the next copy of a normal job,
372 * and also upgrade the next copy when the normal job
373 * already have been purged.
375 * JobId: 1 PriorJobId: 0 (original)
376 * JobId: 2 PriorJobId: 1 (first copy)
377 * JobId: 3 PriorJobId: 1 (second copy)
379 * JobId: 2 PriorJobId: 1 (first copy, now regular backup)
380 * JobId: 3 PriorJobId: 1 (second copy)
382 * => Search through PriorJobId in jobid and
383 * PriorJobId in PriorJobId (jobid)
385 void upgrade_copies(UAContext *ua, char *jobs)
387 POOL_MEM query(PM_MESSAGE);
390 /* Do it in two times for mysql */
391 Mmsg(query, "CREATE TEMPORARY TABLE cpy_tmp AS "
392 "SELECT MIN(JobId) AS JobId FROM Job " /* Choose the oldest job */
394 "AND ( PriorJobId IN (%s) "
399 "WHERE JobId IN (%s) "
403 "GROUP BY PriorJobId ", /* one result per copy */
404 JT_JOB_COPY, jobs, jobs);
405 db_sql_query(ua->db, query.c_str(), NULL, (void *)NULL);
406 Dmsg1(050, "Upgrade copies Log sql=%s\n", query.c_str());
408 /* Now upgrade first copy to Backup */
409 Mmsg(query, "UPDATE Job SET Type='B' " /* JT_JOB_COPY => JT_BACKUP */
410 "WHERE JobId IN ( SELECT JobId FROM cpy_tmp )");
412 db_sql_query(ua->db, query.c_str(), NULL, (void *)NULL);
414 Mmsg(query, "DROP TABLE cpy_tmp");
415 db_sql_query(ua->db, query.c_str(), NULL, (void *)NULL);
421 * Remove all records from catalog for a list of JobIds
423 void purge_jobs_from_catalog(UAContext *ua, char *jobs)
425 POOL_MEM query(PM_MESSAGE);
427 /* Delete (or purge) records associated with the job */
428 purge_files_from_jobs(ua, jobs);
430 Mmsg(query, "DELETE FROM JobMedia WHERE JobId IN (%s)", jobs);
431 db_sql_query(ua->db, query.c_str(), NULL, (void *)NULL);
432 Dmsg1(050, "Delete JobMedia sql=%s\n", query.c_str());
434 Mmsg(query, "DELETE FROM Log WHERE JobId IN (%s)", jobs);
435 db_sql_query(ua->db, query.c_str(), NULL, (void *)NULL);
436 Dmsg1(050, "Delete Log sql=%s\n", query.c_str());
438 upgrade_copies(ua, jobs);
440 /* Now remove the Job record itself */
441 Mmsg(query, "DELETE FROM Job WHERE JobId IN (%s)", jobs);
442 db_sql_query(ua->db, query.c_str(), NULL, (void *)NULL);
444 Dmsg1(050, "Delete Job sql=%s\n", query.c_str());
447 void purge_files_from_volume(UAContext *ua, MEDIA_DBR *mr )
448 {} /* ***FIXME*** implement */
451 * Returns: 1 if Volume purged
452 * 0 if Volume not purged
454 bool purge_jobs_from_volume(UAContext *ua, MEDIA_DBR *mr, bool force)
456 POOL_MEM query(PM_MESSAGE);
464 stat = strcmp(mr->VolStatus, "Append") == 0 ||
465 strcmp(mr->VolStatus, "Full") == 0 ||
466 strcmp(mr->VolStatus, "Used") == 0 ||
467 strcmp(mr->VolStatus, "Error") == 0;
469 ua->error_msg(_("\nVolume \"%s\" has VolStatus \"%s\" and cannot be purged.\n"
470 "The VolStatus must be: Append, Full, Used, or Error to be purged.\n"),
471 mr->VolumeName, mr->VolStatus);
475 memset(&jr, 0, sizeof(jr));
476 memset(&del, 0, sizeof(del));
478 del.JobId = (JobId_t *)malloc(sizeof(JobId_t) * del.max_ids);
481 * Check if he wants to purge a single jobid
483 i = find_arg_with_value(ua, "jobid");
486 del.JobId[0] = str_to_int64(ua->argv[i]);
491 Mmsg(query, "SELECT DISTINCT JobId FROM JobMedia WHERE MediaId=%s",
492 edit_int64(mr->MediaId, ed1));
493 if (!db_sql_query(ua->db, query.c_str(), file_delete_handler, (void *)&del)) {
494 ua->error_msg("%s", db_strerror(ua->db));
495 Dmsg0(050, "Count failed\n");
500 purge_job_list_from_catalog(ua, del);
502 ua->info_msg(_("%d File%s on Volume \"%s\" purged from catalog.\n"), del.num_del,
503 del.num_del==1?"":"s", mr->VolumeName);
505 purged = is_volume_purged(ua, mr, force);
515 * This routine will check the JobMedia records to see if the
516 * Volume has been purged. If so, it marks it as such and
518 * Returns: true if volume purged
521 * Note, we normally will not purge a volume that has Firstor LastWritten
522 * zero, because it means the volume is most likely being written
523 * however, if the user manually purges using the purge command in
524 * the console, he has been warned, and we go ahead and purge
525 * the volume anyway, if possible).
527 bool is_volume_purged(UAContext *ua, MEDIA_DBR *mr, bool force)
529 POOL_MEM query(PM_MESSAGE);
530 struct s_count_ctx cnt;
534 if (!force && (mr->FirstWritten == 0 || mr->LastWritten == 0)) {
535 goto bail_out; /* not written cannot purge */
538 if (strcmp(mr->VolStatus, "Purged") == 0) {
543 /* If purged, mark it so */
545 Mmsg(query, "SELECT count(*) FROM JobMedia WHERE MediaId=%s",
546 edit_int64(mr->MediaId, ed1));
547 if (!db_sql_query(ua->db, query.c_str(), del_count_handler, (void *)&cnt)) {
548 ua->error_msg("%s", db_strerror(ua->db));
549 Dmsg0(050, "Count failed\n");
553 if (cnt.count == 0) {
554 ua->warning_msg(_("There are no more Jobs associated with Volume \"%s\". Marking it purged.\n"),
556 if (!(purged = mark_media_purged(ua, mr))) {
557 ua->error_msg("%s", db_strerror(ua->db));
564 static BSOCK *open_sd_bsock(UAContext *ua)
566 STORE *store = ua->jcr->wstore;
568 if (!ua->jcr->store_bsock) {
569 ua->send_msg(_("Connecting to Storage daemon %s at %s:%d ...\n"),
570 store->name(), store->address, store->SDport);
571 if (!connect_to_storage_daemon(ua->jcr, 10, SDConnectTimeout, 1)) {
572 ua->error_msg(_("Failed to connect to Storage daemon.\n"));
576 return ua->jcr->store_bsock;
579 static void do_truncate_on_purge(UAContext *ua, MEDIA_DBR *mr,
580 char *pool, char *storage,
581 int drive, BSOCK *sd)
585 uint64_t VolBytes = 0;
587 /* TODO: Return if not mr->Recyle ? */
592 if (mr->ActionOnPurge & AOP_TRUNCATE) {
593 /* Send the command to truncate the volume after purge. If this feature
594 * is disabled for the specific device, this will be a no-op.
597 /* Protect us from spaces */
598 bash_spaces(mr->VolumeName);
599 bash_spaces(mr->MediaType);
601 bash_spaces(storage);
603 sd->fsend("relabel %s OldName=%s NewName=%s PoolName=%s "
604 "MediaType=%s Slot=%d drive=%d\n",
606 mr->VolumeName, mr->VolumeName,
607 pool, mr->MediaType, mr->Slot, drive);
609 unbash_spaces(mr->VolumeName);
610 unbash_spaces(mr->MediaType);
612 unbash_spaces(storage);
614 while (sd->recv() >= 0) {
615 ua->send_msg("%s", sd->msg);
616 if (sscanf(sd->msg, "3000 OK label. VolBytes=%llu DVD=%d ",
617 &VolBytes, &dvd) == 2)
624 mr->VolBytes = VolBytes;
626 if (!db_update_media_record(ua->jcr, ua->db, mr)) {
627 ua->error_msg(_("Can't update volume size in the catalog\n"));
629 ua->send_msg(_("The volume \"%s\" has been truncated\n"), mr->VolumeName);
631 ua->warning_msg(_("Unable to truncate volume \"%s\"\n"), mr->VolumeName);
636 /* purge action= pool= volume= storage= devicetype= */
637 static int action_on_purge_cmd(UAContext *ua, const char *cmd)
643 uint32_t *results=NULL;
644 const char *action="all";
652 memset(&pr, 0, sizeof(pr));
653 memset(&mr, 0, sizeof(mr));
656 for (int i=1; i<ua->argc; i++) {
657 if (strcasecmp(ua->argk[i], NT_("allpools")) == 0) {
660 } else if (strcasecmp(ua->argk[i], NT_("volume")) == 0 && ua->argv[i]) {
661 bstrncpy(mr.VolumeName, ua->argv[i], sizeof(mr.VolumeName));
663 } else if (strcasecmp(ua->argk[i], NT_("devicetype")) == 0 && ua->argv[i]) {
664 bstrncpy(mr.MediaType, ua->argv[i], sizeof(mr.MediaType));
666 } else if (strcasecmp(ua->argk[i], NT_("drive")) == 0 && ua->argv[i]) {
667 drive = atoi(ua->argv[i]);
669 } else if (strcasecmp(ua->argk[i], NT_("action")) == 0 && ua->argv[i]) {
675 ua->jcr->wstore = store = get_storage_resource(ua, false);
679 mr.StorageId = store->StorageId;
682 Dmsg0(100, "Can't open db\n");
687 /* force pool selection */
688 pool = get_pool_resource(ua);
690 Dmsg0(100, "Can't get pool resource\n");
693 bstrncpy(pr.Name, pool->name(), sizeof(pr.Name));
694 if (!db_get_pool_record(ua->jcr, ua->db, &pr)) {
695 Dmsg0(100, "Can't get pool record\n");
698 mr.PoolId = pr.PoolId;
704 bstrncpy(mr.VolStatus, "Purged", sizeof(mr.VolStatus));
706 if (!db_get_media_ids(ua->jcr, ua->db, &mr, &nb, &results)) {
707 Dmsg0(100, "No results from db_get_media_ids\n");
712 ua->send_msg(_("No volume founds to perform %s action(s)\n"), action);
716 if ((sd=open_sd_bsock(ua)) == NULL) {
717 Dmsg0(100, "Can't open connection to sd\n");
721 for (int i=0; i < nb; i++) {
722 memset(&mr, 0, sizeof(mr));
723 mr.MediaId = results[i];
724 if (db_get_media_record(ua->jcr, ua->db, &mr)) {
725 /* TODO: ask for drive and change Pool */
726 if (!strcasecmp("truncate", action) || !strcasecmp("all", action)) {
727 do_truncate_on_purge(ua, &mr, pr.Name, store->dev_name(), drive, sd);
730 Dmsg1(0, "Can't find MediaId=%lld\n", (uint64_t) mr.MediaId);
737 sd->signal(BNET_TERMINATE);
739 ua->jcr->store_bsock = NULL;
741 ua->jcr->wstore = NULL;
750 * IF volume status is Append, Full, Used, or Error, mark it Purged
751 * Purged volumes can then be recycled (if enabled).
753 bool mark_media_purged(UAContext *ua, MEDIA_DBR *mr)
756 if (strcmp(mr->VolStatus, "Append") == 0 ||
757 strcmp(mr->VolStatus, "Full") == 0 ||
758 strcmp(mr->VolStatus, "Used") == 0 ||
759 strcmp(mr->VolStatus, "Error") == 0) {
760 bstrncpy(mr->VolStatus, "Purged", sizeof(mr->VolStatus));
761 if (!db_update_media_record(jcr, ua->db, mr)) {
764 pm_strcpy(jcr->VolumeName, mr->VolumeName);
765 generate_job_event(jcr, "VolumePurged");
766 generate_plugin_event(jcr, bEventVolumePurged);
768 * If the RecyclePool is defined, move the volume there
770 if (mr->RecyclePoolId && mr->RecyclePoolId != mr->PoolId) {
771 POOL_DBR oldpr, newpr;
772 memset(&oldpr, 0, sizeof(POOL_DBR));
773 memset(&newpr, 0, sizeof(POOL_DBR));
774 newpr.PoolId = mr->RecyclePoolId;
775 oldpr.PoolId = mr->PoolId;
776 if ( db_get_pool_record(jcr, ua->db, &oldpr)
777 && db_get_pool_record(jcr, ua->db, &newpr))
779 /* check if destination pool size is ok */
780 if (newpr.MaxVols > 0 && newpr.NumVols >= newpr.MaxVols) {
781 ua->error_msg(_("Unable move recycled Volume in full "
782 "Pool \"%s\" MaxVols=%d\n"),
783 newpr.Name, newpr.MaxVols);
785 } else { /* move media */
786 update_vol_pool(ua, newpr.Name, mr, &oldpr);
789 ua->error_msg("%s", db_strerror(ua->db));
793 /* Send message to Job report, if it is a *real* job */
794 if (jcr && jcr->JobId > 0) {
795 Jmsg(jcr, M_INFO, 0, _("All records pruned from Volume \"%s\"; marking it \"Purged\"\n"),
800 ua->error_msg(_("Cannot purge Volume with VolStatus=%s\n"), mr->VolStatus);
802 return strcmp(mr->VolStatus, "Purged") == 0;