3 * Bacula Director -- Tape labeling commands
5 * Kern Sibbald, April MMIII
11 Copyright (C) 2000-2004 Kern Sibbald and John Walker
13 This program is free software; you can redistribute it and/or
14 modify it under the terms of the GNU General Public License as
15 published by the Free Software Foundation; either version 2 of
16 the License, or (at your option) any later version.
18 This program is distributed in the hope that it will be useful,
19 but WITHOUT ANY WARRANTY; without even the implied warranty of
20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 General Public License for more details.
23 You should have received a copy of the GNU General Public
24 License along with this program; if not, write to the Free
25 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
33 /* Slot list definition */
34 typedef struct s_vol_list {
35 struct s_vol_list *next;
41 /* Forward referenced functions */
42 static int do_label(UAContext *ua, char *cmd, int relabel);
43 static void label_from_barcodes(UAContext *ua);
44 static int send_label_request(UAContext *ua, MEDIA_DBR *mr, MEDIA_DBR *omr,
45 POOL_DBR *pr, int relabel, bool media_record_exits);
46 static vol_list_t *get_vol_list_from_SD(UAContext *ua, bool scan);
47 static void free_vol_list(vol_list_t *vol_list);
48 static bool is_cleaning_tape(UAContext *ua, MEDIA_DBR *mr, POOL_DBR *pr);
49 static BSOCK *open_sd_bsock(UAContext *ua);
50 static void close_sd_bsock(UAContext *ua);
51 static char *get_volume_name_from_SD(UAContext *ua, int Slot);
57 * label storage=xxx volume=vvv
59 int label_cmd(UAContext *ua, char *cmd)
61 return do_label(ua, cmd, 0); /* standard label */
64 int relabel_cmd(UAContext *ua, char *cmd)
66 return do_label(ua, cmd, 1); /* relabel tape */
69 static int const max_slots = 5000;
71 static bool get_user_slot_list(UAContext *ua, char *slot_list, int num_slots)
76 for (int i=0; i<num_slots; i++) {
79 i = find_arg_with_value(ua, "slots");
81 /* scan slot list in ua->argv[i] */
85 strip_trailing_junk(ua->argv[i]);
86 for (p=ua->argv[i]; p && *p; p=e) {
93 h = strchr(p, '-'); /* range? */
95 msg = _("Negative numbers not permitted\n");
100 if (!is_an_integer(h)) {
101 msg = _("Range end is not integer.\n");
105 if (!is_an_integer(p)) {
106 msg = _("Range start is not an integer.\n");
112 msg = _("Range end not bigger than start.\n");
117 if (!is_an_integer(p)) {
118 msg = _("Input value is not an integer.\n");
123 if (beg <= 0 || end <= 0) {
124 msg = _("Values must be be greater than zero.\n");
127 if (end >= num_slots) {
128 msg = _("Slot too large.\n");
131 for (i=beg; i<=end; i++) {
132 slot_list[i] = 1; /* Turn on specified range */
136 /* Turn everything on */
137 for (i=0; i<num_slots; i++) {
142 printf("Slots turned on:\n");
143 for (i=1; i<num_slots; i++) {
156 * Update Slots corresponding to Volumes in autochanger
158 int update_slots(UAContext *ua)
161 vol_list_t *vl, *vol_list = NULL;
169 store = get_storage_resource(ua, 1);
173 ua->jcr->store = store;
175 scan = find_arg(ua, _("scan")) >= 0;
177 slot_list = (char *)malloc(max_slots);
178 if (!get_user_slot_list(ua, slot_list, max_slots)) {
183 vol_list = get_vol_list_from_SD(ua, scan);
186 bsendmsg(ua, _("No Volumes found to label, or no barcodes.\n"));
190 /* Walk through the list updating the media records */
191 for (vl=vol_list; vl; vl=vl->next) {
192 /* Check if user wants us to look at this slot */
193 if (!slot_list[vl->Slot]) {
194 Dmsg1(100, "Skipping slot=%d\n", vl->Slot);
197 /* If scanning, we read the label rather than the barcode */
203 vl->VolName = get_volume_name_from_SD(ua, vl->Slot);
204 Dmsg2(100, "Got Vol=%s from SD for Slot=%d\n", vl->VolName, vl->Slot);
207 Dmsg1(100, "No VolName for Slot=%d skipping.\n", vl->Slot);
210 memset(&mr, 0, sizeof(mr));
211 bstrncpy(mr.VolumeName, vl->VolName, sizeof(mr.VolumeName));
213 if (db_get_media_record(ua->jcr, ua->db, &mr)) {
214 if (mr.Slot != vl->Slot || !mr.InChanger) {
217 if (!db_update_media_record(ua->jcr, ua->db, &mr)) {
218 bsendmsg(ua, _("%s\n"), db_strerror(ua->db));
221 "Catalog record for Volume \"%s\" updated to reference slot %d.\n"),
222 mr.VolumeName, mr.Slot);
225 bsendmsg(ua, _("Catalog record for Volume \"%s\" is up to date.\n"),
231 bsendmsg(ua, _("Record for Volume \"%s\" not found in catalog.\n"),
240 free_vol_list(vol_list);
249 * Common routine for both label and relabel
251 static int do_label(UAContext *ua, char *cmd, int relabel)
255 char dev_name[MAX_NAME_LENGTH];
258 bool print_reminder = true;
261 bool media_record_exists = false;
262 static char *barcode_keyword[] = {
268 memset(&pr, 0, sizeof(pr));
272 store = get_storage_resource(ua, 1);
276 ua->jcr->store = store;
278 if (!relabel && find_arg_keyword(ua, barcode_keyword) >= 0) {
279 label_from_barcodes(ua);
283 /* If relabel get name of Volume to relabel */
285 /* Check for oldvolume=name */
286 i = find_arg_with_value(ua, "oldvolume");
288 memset(&omr, 0, sizeof(omr));
289 bstrncpy(omr.VolumeName, ua->argv[i], sizeof(omr.VolumeName));
290 if (db_get_media_record(ua->jcr, ua->db, &omr)) {
293 bsendmsg(ua, "%s", db_strerror(ua->db));
295 /* No keyword or Vol not found, ask user to select */
296 if (!select_media_dbr(ua, &omr)) {
300 /* Require Volume to be Purged or Recycled */
302 if (strcmp(omr.VolStatus, "Purged") != 0 && strcmp(omr.VolStatus, "Recycle") != 0) {
303 bsendmsg(ua, _("Volume \"%s\" has VolStatus %s. It must be Purged or Recycled before relabeling.\n"),
304 omr.VolumeName, omr.VolStatus);
309 /* Check for volume=NewVolume */
310 i = find_arg_with_value(ua, "volume");
312 pm_strcpy(&ua->cmd, ua->argv[i]);
316 /* Get a new Volume name */
318 media_record_exists = false;
319 if (!get_cmd(ua, _("Enter new Volume name: "))) {
323 if (!is_volume_name_legal(ua, ua->cmd)) {
327 memset(&mr, 0, sizeof(mr));
328 bstrncpy(mr.VolumeName, ua->cmd, sizeof(mr.VolumeName));
329 /* If VolBytes are zero the Volume is not labeled */
330 if (db_get_media_record(ua->jcr, ua->db, &mr)) {
331 if (mr.VolBytes != 0) {
332 bsendmsg(ua, _("Media record for new Volume \"%s\" already exists.\n"),
336 media_record_exists = true;
341 /* If autochanger, request slot */
342 if (store->autochanger) {
343 i = find_arg_with_value(ua, "slot");
345 mr.Slot = atoi(ua->argv[i]);
346 } else if (!get_pint(ua, _("Enter slot (0 for none): "))) {
349 mr.Slot = ua->pint32_val;
351 mr.InChanger = 1; /* assumed if we are labeling it */
354 bstrncpy(mr.MediaType, store->media_type, sizeof(mr.MediaType));
356 /* Must select Pool if not already done */
357 if (pr.PoolId == 0) {
358 memset(&pr, 0, sizeof(pr));
359 if (!select_pool_dbr(ua, &pr)) {
365 ok = send_label_request(ua, &mr, &omr, &pr, relabel, media_record_exists);
368 sd = ua->jcr->store_bsock;
370 if (!db_delete_media_record(ua->jcr, ua->db, &omr)) {
371 bsendmsg(ua, _("Delete of Volume \"%s\" failed. ERR=%s"),
372 omr.VolumeName, db_strerror(ua->db));
374 bsendmsg(ua, _("Old volume \"%s\" deleted from catalog.\n"),
379 bstrncpy(dev_name, store->dev_name, sizeof(dev_name));
380 bsendmsg(ua, _("Requesting to mount %s ...\n"), dev_name);
381 bash_spaces(dev_name);
382 bnet_fsend(sd, "mount %s", dev_name);
383 unbash_spaces(dev_name);
384 while (bnet_recv(sd) >= 0) {
385 bsendmsg(ua, "%s", sd->msg);
387 * 3001 OK mount. Device=xxx or
388 * 3001 Mounted Volume vvvv
389 * 3906 is cannot mount non-tape
390 * So for those, no need to print a reminder
392 if (strncmp(sd->msg, "3001 ", 5) == 0 ||
393 strncmp(sd->msg, "3906 ", 5) == 0) {
394 print_reminder = false;
399 if (print_reminder) {
400 bsendmsg(ua, _("Do not forget to mount the drive!!!\n"));
408 * Request SD to send us the slot:barcodes, then wiffle
409 * through them all labeling them.
411 static void label_from_barcodes(UAContext *ua)
413 STORE *store = ua->jcr->store;
416 vol_list_t *vl, *vol_list = NULL;
417 bool media_record_exists;
420 slot_list = (char *)malloc(max_slots);
421 if (!get_user_slot_list(ua, slot_list, max_slots)) {
426 vol_list = get_vol_list_from_SD(ua, false /*no scan*/);
429 bsendmsg(ua, _("No Volumes found to label, or no barcodes.\n"));
433 /* Display list of Volumes and ask if he really wants to proceed */
434 bsendmsg(ua, _("The following Volumes will be labeled:\n"
436 "==============\n"));
437 for (vl=vol_list; vl; vl=vl->next) {
438 if (!vl->VolName || !slot_list[vl->Slot]) {
441 bsendmsg(ua, "%4d %s\n", vl->Slot, vl->VolName);
443 if (!get_cmd(ua, _("Do you want to continue? (y/n): ")) ||
444 (ua->cmd[0] != 'y' && ua->cmd[0] != 'Y')) {
448 memset(&pr, 0, sizeof(pr));
449 if (!select_pool_dbr(ua, &pr)) {
452 memset(&omr, 0, sizeof(omr));
454 /* Fire off the label requests */
455 for (vl=vol_list; vl; vl=vl->next) {
456 if (!vl->VolName || !slot_list[vl->Slot]) {
459 memset(&mr, 0, sizeof(mr));
460 bstrncpy(mr.VolumeName, vl->VolName, sizeof(mr.VolumeName));
461 media_record_exists = false;
462 if (db_get_media_record(ua->jcr, ua->db, &mr)) {
463 if (mr.VolBytes != 0) {
464 bsendmsg(ua, _("Media record for Slot %d Volume \"%s\" already exists.\n"),
465 vl->Slot, mr.VolumeName);
468 if (!db_update_media_record(ua->jcr, ua->db, &mr)) {
469 bsendmsg(ua, "Error setting InChanger: ERR=%s", db_strerror(ua->db));
474 media_record_exists = true;
478 * Deal with creating cleaning tape here. Normal tapes created in
479 * send_label_request() below
481 if (is_cleaning_tape(ua, &mr, &pr)) {
482 if (media_record_exists) { /* we update it */
484 if (!db_update_media_record(ua->jcr, ua->db, &mr)) {
485 bsendmsg(ua, "%s", db_strerror(ua->db));
487 } else { /* create the media record */
488 set_pool_dbr_defaults_in_media_dbr(&mr, &pr);
489 if (db_create_media_record(ua->jcr, ua->db, &mr)) {
490 bsendmsg(ua, _("Catalog record for cleaning tape \"%s\" successfully created.\n"),
493 bsendmsg(ua, "Catalog error on cleaning tape: %s", db_strerror(ua->db));
496 continue; /* done, go handle next volume */
498 bstrncpy(mr.MediaType, store->media_type, sizeof(mr.MediaType));
501 if (!send_label_request(ua, &mr, &omr, &pr, 0, media_record_exists)) {
508 free_vol_list(vol_list);
515 * Check if the Volume name has legal characters
516 * If ua is non-NULL send the message
518 bool is_volume_name_legal(UAContext *ua, char *name)
522 char *accept = ":.-_";
524 /* Restrict the characters permitted in the Volume name */
525 for (p=name; *p; p++) {
526 if (B_ISALPHA(*p) || B_ISDIGIT(*p) || strchr(accept, (int)(*p))) {
530 bsendmsg(ua, _("Illegal character \"%c\" in a volume name.\n"), *p);
535 if (len >= MAX_NAME_LENGTH) {
537 bsendmsg(ua, _("Volume name too long.\n"));
543 bsendmsg(ua, _("Volume name must be at least one character long.\n"));
550 static int send_label_request(UAContext *ua, MEDIA_DBR *mr, MEDIA_DBR *omr,
551 POOL_DBR *pr, int relabel, bool media_record_exists)
554 char dev_name[MAX_NAME_LENGTH];
557 if (!(sd=open_sd_bsock(ua))) {
560 bstrncpy(dev_name, ua->jcr->store->dev_name, sizeof(dev_name));
561 bash_spaces(dev_name);
562 bash_spaces(mr->VolumeName);
563 bash_spaces(mr->MediaType);
564 bash_spaces(pr->Name);
566 bash_spaces(omr->VolumeName);
567 bnet_fsend(sd, "relabel %s OldName=%s NewName=%s PoolName=%s MediaType=%s Slot=%d",
568 dev_name, omr->VolumeName, mr->VolumeName, pr->Name, mr->MediaType, mr->Slot);
569 bsendmsg(ua, _("Sending relabel command from \"%s\" to \"%s\" ...\n"),
570 omr->VolumeName, mr->VolumeName);
572 bnet_fsend(sd, "label %s VolumeName=%s PoolName=%s MediaType=%s Slot=%d",
573 dev_name, mr->VolumeName, pr->Name, mr->MediaType, mr->Slot);
574 bsendmsg(ua, _("Sending label command for Volume \"%s\" Slot %d ...\n"),
575 mr->VolumeName, mr->Slot);
576 Dmsg5(200, "label %s VolumeName=%s PoolName=%s MediaType=%s Slot=%d\n",
577 dev_name, mr->VolumeName, pr->Name, mr->MediaType, mr->Slot);
580 while (bnet_recv(sd) >= 0) {
581 bsendmsg(ua, "%s", sd->msg);
582 if (strncmp(sd->msg, "3000 OK label.", 14) == 0) {
587 unbash_spaces(mr->VolumeName);
588 unbash_spaces(mr->MediaType);
589 unbash_spaces(pr->Name);
590 mr->LabelDate = time(NULL);
592 if (media_record_exists) { /* we update it */
595 if (!db_update_media_record(ua->jcr, ua->db, mr)) {
596 bsendmsg(ua, "%s", db_strerror(ua->db));
599 } else { /* create the media record */
600 set_pool_dbr_defaults_in_media_dbr(mr, pr);
601 mr->VolBytes = 1; /* flag indicating Volume labeled */
603 if (db_create_media_record(ua->jcr, ua->db, mr)) {
604 bsendmsg(ua, _("Catalog record for Volume \"%s\", Slot %d successfully created.\n"),
605 mr->VolumeName, mr->Slot);
607 bsendmsg(ua, "%s", db_strerror(ua->db));
612 bsendmsg(ua, _("Label command failed.\n"));
617 static BSOCK *open_sd_bsock(UAContext *ua)
619 STORE *store = ua->jcr->store;
621 if (!ua->jcr->store_bsock) {
622 bsendmsg(ua, _("Connecting to Storage daemon %s at %s:%d ...\n"),
623 store->hdr.name, store->address, store->SDport);
624 if (!connect_to_storage_daemon(ua->jcr, 10, SDConnectTimeout, 1)) {
625 bsendmsg(ua, _("Failed to connect to Storage daemon.\n"));
629 return ua->jcr->store_bsock;
632 static void close_sd_bsock(UAContext *ua)
634 if (ua->jcr->store_bsock) {
635 bnet_sig(ua->jcr->store_bsock, BNET_TERMINATE);
636 bnet_close(ua->jcr->store_bsock);
637 ua->jcr->store_bsock = NULL;
641 static char *get_volume_name_from_SD(UAContext *ua, int Slot)
643 STORE *store = ua->jcr->store;
645 char dev_name[MAX_NAME_LENGTH];
646 char *VolName = NULL;
649 if (!(sd=open_sd_bsock(ua))) {
650 bsendmsg(ua, _("Could not open SD socket.\n"));
653 bstrncpy(dev_name, store->dev_name, sizeof(dev_name));
654 bash_spaces(dev_name);
655 /* Ask for autochanger list of volumes */
656 bnet_fsend(sd, _("readlabel %s Slot=%d\n"), dev_name, Slot);
657 Dmsg1(100, "Sent: %s", sd->msg);
659 /* Get Volume name in this Slot */
660 while (bnet_recv(sd) >= 0) {
661 bsendmsg(ua, "%s", sd->msg);
662 Dmsg1(100, "Got: %s", sd->msg);
663 if (strncmp(sd->msg, "3001 Volume=", 12) == 0) {
664 VolName = (char *)malloc(sd->msglen);
665 if (sscanf(sd->msg, "3001 Volume=%s Slot=%d", VolName, &rtn_slot) == 2) {
673 Dmsg1(200, "get_vol_name=%s\n", NPRT(VolName));
678 * We get the slot list from the Storage daemon.
679 * If scan is set, we return all slots found,
680 * otherwise, we return only slots with valid barcodes (Volume names)
682 static vol_list_t *get_vol_list_from_SD(UAContext *ua, bool scan)
684 STORE *store = ua->jcr->store;
685 char dev_name[MAX_NAME_LENGTH];
688 vol_list_t *vol_list = NULL;
691 if (!(sd=open_sd_bsock(ua))) {
695 bstrncpy(dev_name, store->dev_name, sizeof(dev_name));
696 bash_spaces(dev_name);
697 /* Ask for autochanger list of volumes */
698 bnet_fsend(sd, _("autochanger list %s \n"), dev_name);
700 /* Read and organize list of Volumes */
701 while (bnet_recv(sd) >= 0) {
704 strip_trailing_junk(sd->msg);
706 /* Check for returned SD messages */
707 if (sd->msg[0] == '3' && B_ISDIGIT(sd->msg[1]) &&
708 B_ISDIGIT(sd->msg[2]) && B_ISDIGIT(sd->msg[3]) &&
710 bsendmsg(ua, "%s\n", sd->msg); /* pass them on to user */
714 /* Validate Slot: if scanning, otherwise Slot:Barcode */
715 p = strchr(sd->msg, ':');
717 /* Scanning -- require only valid slot */
718 Slot = atoi(sd->msg);
722 bsendmsg(ua, _("Invalid Slot number: %s\n"), sd->msg);
727 if (p && strlen(p) > 1) {
729 if (!is_an_integer(sd->msg) || (Slot=atoi(sd->msg)) <= 0) {
732 bsendmsg(ua, _("Invalid Slot number: %s\n"), sd->msg);
738 if (!is_volume_name_legal(ua, p)) {
741 bsendmsg(ua, _("Invalid Volume name: %s\n"), sd->msg);
746 /* Add Slot and VolumeName to list */
747 vl = (vol_list_t *)malloc(sizeof(vol_list_t));
751 p++; /* skip separator */
753 vl->VolName = bstrdup(p);
757 Dmsg2(100, "Add slot=%d Vol=%s to list.\n", vl->Slot, NPRT(vl->VolName));
762 /* Add new entry to end of list */
763 for (vol_list_t *tvl=vol_list; tvl; tvl=tvl->next) {
776 static void free_vol_list(vol_list_t *vol_list)
780 for (vl=vol_list; vl; ) {
793 * Check if this is a cleaning tape by comparing the Volume name
794 * with the Cleaning Prefix. If they match, this is a cleaning
797 static bool is_cleaning_tape(UAContext *ua, MEDIA_DBR *mr, POOL_DBR *pr)
799 /* Find Pool resource */
800 ua->jcr->pool = (POOL *)GetResWithName(R_POOL, pr->Name);
801 if (!ua->jcr->pool) {
802 bsendmsg(ua, _("Pool \"%s\" resource not found!\n"), pr->Name);
805 if (ua->jcr->pool->cleaning_prefix == NULL) {
808 Dmsg4(100, "CLNprefix=%s: Vol=%s: len=%d strncmp=%d\n",
809 ua->jcr->pool->cleaning_prefix, mr->VolumeName,
810 strlen(ua->jcr->pool->cleaning_prefix),
811 strncmp(mr->VolumeName, ua->jcr->pool->cleaning_prefix,
812 strlen(ua->jcr->pool->cleaning_prefix)));
813 return strncmp(mr->VolumeName, ua->jcr->pool->cleaning_prefix,
814 strlen(ua->jcr->pool->cleaning_prefix)) == 0;