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, const 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, const char *cmd)
61 return do_label(ua, cmd, 0); /* standard label */
64 int relabel_cmd(UAContext *ua, const 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 if (vl->Slot >= max_slots) {
193 bsendmsg(ua, _("Slot %d larger than max %d ignored.\n"));
196 /* Check if user wants us to look at this slot */
197 if (!slot_list[vl->Slot]) {
198 Dmsg1(100, "Skipping slot=%d\n", vl->Slot);
201 /* If scanning, we read the label rather than the barcode */
207 vl->VolName = get_volume_name_from_SD(ua, vl->Slot);
208 Dmsg2(100, "Got Vol=%s from SD for Slot=%d\n", vl->VolName, vl->Slot);
210 slot_list[vl->Slot] = 0; /* clear Slot */
212 Dmsg1(100, "No VolName for Slot=%d setting InChanger to zero.\n", vl->Slot);
213 memset(&mr, 0, sizeof(mr));
216 /* Set InChanger to zero for this Slot */
218 db_make_inchanger_unique(ua->jcr, ua->db, &mr);
220 bsendmsg(ua, _("No VolName for Slot=%d set InChanger to zero.\n"), vl->Slot);
223 memset(&mr, 0, sizeof(mr));
224 bstrncpy(mr.VolumeName, vl->VolName, sizeof(mr.VolumeName));
226 if (db_get_media_record(ua->jcr, ua->db, &mr)) {
227 if (mr.Slot != vl->Slot || !mr.InChanger) {
230 if (!db_update_media_record(ua->jcr, ua->db, &mr)) {
231 bsendmsg(ua, _("%s\n"), db_strerror(ua->db));
234 "Catalog record for Volume \"%s\" updated to reference slot %d.\n"),
235 mr.VolumeName, mr.Slot);
238 bsendmsg(ua, _("Catalog record for Volume \"%s\" is up to date.\n"),
244 bsendmsg(ua, _("Record for Volume \"%s\" not found in catalog.\n"),
249 memset(&mr, 0, sizeof(mr));
251 for (int i=1; i<max_slots; i++) {
254 /* Set InChanger to zero for this Slot */
256 db_make_inchanger_unique(ua->jcr, ua->db, &mr);
258 bsendmsg(ua, _("No VolName for Slot=%d set InChanger to zero.\n"), i);
264 free_vol_list(vol_list);
273 * Common routine for both label and relabel
275 static int do_label(UAContext *ua, const char *cmd, int relabel)
279 char dev_name[MAX_NAME_LENGTH];
282 bool print_reminder = true;
285 bool media_record_exists = false;
286 static const char *barcode_keyword[] = {
292 memset(&pr, 0, sizeof(pr));
296 store = get_storage_resource(ua, 1);
300 ua->jcr->store = store;
302 if (!relabel && find_arg_keyword(ua, barcode_keyword) >= 0) {
303 label_from_barcodes(ua);
307 /* If relabel get name of Volume to relabel */
309 /* Check for oldvolume=name */
310 i = find_arg_with_value(ua, "oldvolume");
312 memset(&omr, 0, sizeof(omr));
313 bstrncpy(omr.VolumeName, ua->argv[i], sizeof(omr.VolumeName));
314 if (db_get_media_record(ua->jcr, ua->db, &omr)) {
317 bsendmsg(ua, "%s", db_strerror(ua->db));
319 /* No keyword or Vol not found, ask user to select */
320 if (!select_media_dbr(ua, &omr)) {
324 /* Require Volume to be Purged or Recycled */
326 if (strcmp(omr.VolStatus, "Purged") != 0 && strcmp(omr.VolStatus, "Recycle") != 0) {
327 bsendmsg(ua, _("Volume \"%s\" has VolStatus %s. It must be Purged or Recycled before relabeling.\n"),
328 omr.VolumeName, omr.VolStatus);
333 /* Check for volume=NewVolume */
334 i = find_arg_with_value(ua, "volume");
336 pm_strcpy(&ua->cmd, ua->argv[i]);
340 /* Get a new Volume name */
342 media_record_exists = false;
343 if (!get_cmd(ua, _("Enter new Volume name: "))) {
347 if (!is_volume_name_legal(ua, ua->cmd)) {
351 memset(&mr, 0, sizeof(mr));
352 bstrncpy(mr.VolumeName, ua->cmd, sizeof(mr.VolumeName));
353 /* If VolBytes are zero the Volume is not labeled */
354 if (db_get_media_record(ua->jcr, ua->db, &mr)) {
355 if (mr.VolBytes != 0) {
356 bsendmsg(ua, _("Media record for new Volume \"%s\" already exists.\n"),
360 media_record_exists = true;
365 /* If autochanger, request slot */
366 if (store->autochanger) {
367 i = find_arg_with_value(ua, "slot");
369 mr.Slot = atoi(ua->argv[i]);
370 } else if (!get_pint(ua, _("Enter slot (0 for none): "))) {
373 mr.Slot = ua->pint32_val;
375 mr.InChanger = 1; /* assumed if we are labeling it */
378 bstrncpy(mr.MediaType, store->media_type, sizeof(mr.MediaType));
380 /* Must select Pool if not already done */
381 if (pr.PoolId == 0) {
382 memset(&pr, 0, sizeof(pr));
383 if (!select_pool_dbr(ua, &pr)) {
389 ok = send_label_request(ua, &mr, &omr, &pr, relabel, media_record_exists);
392 sd = ua->jcr->store_bsock;
394 if (!db_delete_media_record(ua->jcr, ua->db, &omr)) {
395 bsendmsg(ua, _("Delete of Volume \"%s\" failed. ERR=%s"),
396 omr.VolumeName, db_strerror(ua->db));
398 bsendmsg(ua, _("Old volume \"%s\" deleted from catalog.\n"),
403 bstrncpy(dev_name, store->dev_name, sizeof(dev_name));
404 bsendmsg(ua, _("Requesting to mount %s ...\n"), dev_name);
405 bash_spaces(dev_name);
406 bnet_fsend(sd, "mount %s", dev_name);
407 unbash_spaces(dev_name);
408 while (bnet_recv(sd) >= 0) {
409 bsendmsg(ua, "%s", sd->msg);
411 * 3001 OK mount. Device=xxx or
412 * 3001 Mounted Volume vvvv
413 * 3906 is cannot mount non-tape
414 * So for those, no need to print a reminder
416 if (strncmp(sd->msg, "3001 ", 5) == 0 ||
417 strncmp(sd->msg, "3906 ", 5) == 0) {
418 print_reminder = false;
423 if (print_reminder) {
424 bsendmsg(ua, _("Do not forget to mount the drive!!!\n"));
432 * Request SD to send us the slot:barcodes, then wiffle
433 * through them all labeling them.
435 static void label_from_barcodes(UAContext *ua)
437 STORE *store = ua->jcr->store;
440 vol_list_t *vl, *vol_list = NULL;
441 bool media_record_exists;
444 slot_list = (char *)malloc(max_slots);
445 if (!get_user_slot_list(ua, slot_list, max_slots)) {
449 vol_list = get_vol_list_from_SD(ua, false /*no scan*/);
452 bsendmsg(ua, _("No Volumes found to label, or no barcodes.\n"));
456 /* Display list of Volumes and ask if he really wants to proceed */
457 bsendmsg(ua, _("The following Volumes will be labeled:\n"
459 "==============\n"));
460 for (vl=vol_list; vl; vl=vl->next) {
461 if (!vl->VolName || !slot_list[vl->Slot]) {
464 bsendmsg(ua, "%4d %s\n", vl->Slot, vl->VolName);
466 if (!get_cmd(ua, _("Do you want to continue? (y/n): ")) ||
467 (ua->cmd[0] != 'y' && ua->cmd[0] != 'Y')) {
471 memset(&pr, 0, sizeof(pr));
472 if (!select_pool_dbr(ua, &pr)) {
475 memset(&omr, 0, sizeof(omr));
477 /* Fire off the label requests */
478 for (vl=vol_list; vl; vl=vl->next) {
479 if (!vl->VolName || !slot_list[vl->Slot]) {
482 memset(&mr, 0, sizeof(mr));
483 bstrncpy(mr.VolumeName, vl->VolName, sizeof(mr.VolumeName));
484 media_record_exists = false;
485 if (db_get_media_record(ua->jcr, ua->db, &mr)) {
486 if (mr.VolBytes != 0) {
487 bsendmsg(ua, _("Media record for Slot %d Volume \"%s\" already exists.\n"),
488 vl->Slot, mr.VolumeName);
491 if (!db_update_media_record(ua->jcr, ua->db, &mr)) {
492 bsendmsg(ua, "Error setting InChanger: ERR=%s", db_strerror(ua->db));
497 media_record_exists = true;
501 * Deal with creating cleaning tape here. Normal tapes created in
502 * send_label_request() below
504 if (is_cleaning_tape(ua, &mr, &pr)) {
505 if (media_record_exists) { /* we update it */
507 if (!db_update_media_record(ua->jcr, ua->db, &mr)) {
508 bsendmsg(ua, "%s", db_strerror(ua->db));
510 } else { /* create the media record */
511 set_pool_dbr_defaults_in_media_dbr(&mr, &pr);
512 if (db_create_media_record(ua->jcr, ua->db, &mr)) {
513 bsendmsg(ua, _("Catalog record for cleaning tape \"%s\" successfully created.\n"),
516 bsendmsg(ua, "Catalog error on cleaning tape: %s", db_strerror(ua->db));
519 continue; /* done, go handle next volume */
521 bstrncpy(mr.MediaType, store->media_type, sizeof(mr.MediaType));
524 send_label_request(ua, &mr, &omr, &pr, 0, media_record_exists);
530 free_vol_list(vol_list);
537 * Check if the Volume name has legal characters
538 * If ua is non-NULL send the message
540 bool is_volume_name_legal(UAContext *ua, const char *name)
544 const char *accept = ":.-_";
546 /* Restrict the characters permitted in the Volume name */
547 for (p=name; *p; p++) {
548 if (B_ISALPHA(*p) || B_ISDIGIT(*p) || strchr(accept, (int)(*p))) {
552 bsendmsg(ua, _("Illegal character \"%c\" in a volume name.\n"), *p);
557 if (len >= MAX_NAME_LENGTH) {
559 bsendmsg(ua, _("Volume name too long.\n"));
565 bsendmsg(ua, _("Volume name must be at least one character long.\n"));
573 * NOTE! This routine opens the SD socket but leaves it open
575 static int send_label_request(UAContext *ua, MEDIA_DBR *mr, MEDIA_DBR *omr,
576 POOL_DBR *pr, int relabel, bool media_record_exists)
579 char dev_name[MAX_NAME_LENGTH];
582 if (!(sd=open_sd_bsock(ua))) {
585 bstrncpy(dev_name, ua->jcr->store->dev_name, sizeof(dev_name));
586 bash_spaces(dev_name);
587 bash_spaces(mr->VolumeName);
588 bash_spaces(mr->MediaType);
589 bash_spaces(pr->Name);
591 bash_spaces(omr->VolumeName);
592 bnet_fsend(sd, "relabel %s OldName=%s NewName=%s PoolName=%s MediaType=%s Slot=%d",
593 dev_name, omr->VolumeName, mr->VolumeName, pr->Name, mr->MediaType, mr->Slot);
594 bsendmsg(ua, _("Sending relabel command from \"%s\" to \"%s\" ...\n"),
595 omr->VolumeName, mr->VolumeName);
597 bnet_fsend(sd, "label %s VolumeName=%s PoolName=%s MediaType=%s Slot=%d",
598 dev_name, mr->VolumeName, pr->Name, mr->MediaType, mr->Slot);
599 bsendmsg(ua, _("Sending label command for Volume \"%s\" Slot %d ...\n"),
600 mr->VolumeName, mr->Slot);
601 Dmsg5(200, "label %s VolumeName=%s PoolName=%s MediaType=%s Slot=%d\n",
602 dev_name, mr->VolumeName, pr->Name, mr->MediaType, mr->Slot);
605 while (bnet_recv(sd) >= 0) {
606 bsendmsg(ua, "%s", sd->msg);
607 if (strncmp(sd->msg, "3000 OK label.", 14) == 0) {
611 unbash_spaces(mr->VolumeName);
612 unbash_spaces(mr->MediaType);
613 unbash_spaces(pr->Name);
614 mr->LabelDate = time(NULL);
616 if (media_record_exists) { /* we update it */
619 if (!db_update_media_record(ua->jcr, ua->db, mr)) {
620 bsendmsg(ua, "%s", db_strerror(ua->db));
623 } else { /* create the media record */
624 set_pool_dbr_defaults_in_media_dbr(mr, pr);
625 mr->VolBytes = 1; /* flag indicating Volume labeled */
627 if (db_create_media_record(ua->jcr, ua->db, mr)) {
628 bsendmsg(ua, _("Catalog record for Volume \"%s\", Slot %d successfully created.\n"),
629 mr->VolumeName, mr->Slot);
631 bsendmsg(ua, "%s", db_strerror(ua->db));
636 bsendmsg(ua, _("Label command failed for Volume %s.\n"), mr->VolumeName);
641 static BSOCK *open_sd_bsock(UAContext *ua)
643 STORE *store = ua->jcr->store;
645 if (!ua->jcr->store_bsock) {
646 bsendmsg(ua, _("Connecting to Storage daemon %s at %s:%d ...\n"),
647 store->hdr.name, store->address, store->SDport);
648 if (!connect_to_storage_daemon(ua->jcr, 10, SDConnectTimeout, 1)) {
649 bsendmsg(ua, _("Failed to connect to Storage daemon.\n"));
653 return ua->jcr->store_bsock;
656 static void close_sd_bsock(UAContext *ua)
658 if (ua->jcr->store_bsock) {
659 bnet_sig(ua->jcr->store_bsock, BNET_TERMINATE);
660 bnet_close(ua->jcr->store_bsock);
661 ua->jcr->store_bsock = NULL;
665 static char *get_volume_name_from_SD(UAContext *ua, int Slot)
667 STORE *store = ua->jcr->store;
669 char dev_name[MAX_NAME_LENGTH];
670 char *VolName = NULL;
673 if (!(sd=open_sd_bsock(ua))) {
674 bsendmsg(ua, _("Could not open SD socket.\n"));
677 bstrncpy(dev_name, store->dev_name, sizeof(dev_name));
678 bash_spaces(dev_name);
679 /* Ask for autochanger list of volumes */
680 bnet_fsend(sd, _("readlabel %s Slot=%d\n"), dev_name, Slot);
681 Dmsg1(100, "Sent: %s", sd->msg);
683 /* Get Volume name in this Slot */
684 while (bnet_recv(sd) >= 0) {
685 bsendmsg(ua, "%s", sd->msg);
686 Dmsg1(100, "Got: %s", sd->msg);
687 if (strncmp(sd->msg, "3001 Volume=", 12) == 0) {
688 VolName = (char *)malloc(sd->msglen);
689 if (sscanf(sd->msg, "3001 Volume=%s Slot=%d", VolName, &rtn_slot) == 2) {
697 Dmsg1(200, "get_vol_name=%s\n", NPRT(VolName));
702 * We get the slot list from the Storage daemon.
703 * If scan is set, we return all slots found,
704 * otherwise, we return only slots with valid barcodes (Volume names)
706 static vol_list_t *get_vol_list_from_SD(UAContext *ua, bool scan)
708 STORE *store = ua->jcr->store;
709 char dev_name[MAX_NAME_LENGTH];
712 vol_list_t *vol_list = NULL;
715 if (!(sd=open_sd_bsock(ua))) {
719 bstrncpy(dev_name, store->dev_name, sizeof(dev_name));
720 bash_spaces(dev_name);
721 /* Ask for autochanger list of volumes */
722 bnet_fsend(sd, _("autochanger list %s \n"), dev_name);
724 /* Read and organize list of Volumes */
725 while (bnet_recv(sd) >= 0) {
728 strip_trailing_junk(sd->msg);
730 /* Check for returned SD messages */
731 if (sd->msg[0] == '3' && B_ISDIGIT(sd->msg[1]) &&
732 B_ISDIGIT(sd->msg[2]) && B_ISDIGIT(sd->msg[3]) &&
734 bsendmsg(ua, "%s\n", sd->msg); /* pass them on to user */
738 /* Validate Slot: if scanning, otherwise Slot:Barcode */
739 p = strchr(sd->msg, ':');
741 /* Scanning -- require only valid slot */
742 Slot = atoi(sd->msg);
746 bsendmsg(ua, _("Invalid Slot number: %s\n"), sd->msg);
751 if (p && strlen(p) > 1) {
753 if (!is_an_integer(sd->msg) || (Slot=atoi(sd->msg)) <= 0) {
756 bsendmsg(ua, _("Invalid Slot number: %s\n"), sd->msg);
762 if (!is_volume_name_legal(ua, p)) {
765 bsendmsg(ua, _("Invalid Volume name: %s\n"), sd->msg);
770 /* Add Slot and VolumeName to list */
771 vl = (vol_list_t *)malloc(sizeof(vol_list_t));
775 p++; /* skip separator */
777 vl->VolName = bstrdup(p);
781 Dmsg2(100, "Add slot=%d Vol=%s to SD list.\n", vl->Slot, NPRT(vl->VolName));
786 /* Add new entry to end of list */
787 for (vol_list_t *tvl=vol_list; tvl; tvl=tvl->next) {
800 static void free_vol_list(vol_list_t *vol_list)
805 for (vl=vol_list; vl; ) {
818 * Check if this is a cleaning tape by comparing the Volume name
819 * with the Cleaning Prefix. If they match, this is a cleaning
822 static bool is_cleaning_tape(UAContext *ua, MEDIA_DBR *mr, POOL_DBR *pr)
824 /* Find Pool resource */
825 ua->jcr->pool = (POOL *)GetResWithName(R_POOL, pr->Name);
826 if (!ua->jcr->pool) {
827 bsendmsg(ua, _("Pool \"%s\" resource not found!\n"), pr->Name);
830 if (ua->jcr->pool->cleaning_prefix == NULL) {
833 Dmsg4(100, "CLNprefix=%s: Vol=%s: len=%d strncmp=%d\n",
834 ua->jcr->pool->cleaning_prefix, mr->VolumeName,
835 strlen(ua->jcr->pool->cleaning_prefix),
836 strncmp(mr->VolumeName, ua->jcr->pool->cleaning_prefix,
837 strlen(ua->jcr->pool->cleaning_prefix)));
838 return strncmp(mr->VolumeName, ua->jcr->pool->cleaning_prefix,
839 strlen(ua->jcr->pool->cleaning_prefix)) == 0;