3 * Bacula Director -- Tape labeling commands
5 * Kern Sibbald, April MMIII
11 Copyright (C) 2000-2003 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);
46 static vol_list_t *get_slot_list_from_SD(UAContext *ua);
47 static int is_cleaning_tape(UAContext *ua, MEDIA_DBR *mr, POOL_DBR *pr);
53 * label storage=xxx volume=vvv
55 int label_cmd(UAContext *ua, char *cmd)
57 return do_label(ua, cmd, 0); /* standard label */
60 int relabel_cmd(UAContext *ua, char *cmd)
62 return do_label(ua, cmd, 1); /* relabel tape */
67 * Update Slots corresponding to Volumes in autochanger
69 int update_slots(UAContext *ua)
72 vol_list_t *vl, *vol_list = NULL;
78 store = get_storage_resource(ua, 1);
82 ua->jcr->store = store;
84 vol_list = get_slot_list_from_SD(ua);
88 bsendmsg(ua, _("No Volumes found to label, or no barcodes.\n"));
92 /* Walk through the list updating the media records */
93 for (vl=vol_list; vl; vl=vl->next) {
95 memset(&mr, 0, sizeof(mr));
96 bstrncpy(mr.VolumeName, vl->VolName, sizeof(mr.VolumeName));
98 if (db_get_media_record(ua->jcr, ua->db, &mr)) {
99 if (mr.Slot != vl->Slot) {
101 if (!db_update_media_record(ua->jcr, ua->db, &mr)) {
102 bsendmsg(ua, _("%s\n"), db_strerror(ua->db));
105 "Catalog record for Volume \"%s\" updated to reference slot %d.\n"),
106 mr.VolumeName, mr.Slot);
109 bsendmsg(ua, _("Catalog record for Volume \"%s\" is up to date.\n"),
115 bsendmsg(ua, _("Record for Volume \"%s\" not found in catalog.\n"),
124 for (vl=vol_list; vl; ) {
132 if (ua->jcr->store_bsock) {
133 bnet_sig(ua->jcr->store_bsock, BNET_TERMINATE);
134 bnet_close(ua->jcr->store_bsock);
135 ua->jcr->store_bsock = NULL;
141 * Common routine for both label and relabel
143 static int do_label(UAContext *ua, char *cmd, int relabel)
147 sd = ua->jcr->store_bsock;
148 char dev_name[MAX_NAME_LENGTH];
154 static char *barcode_keyword[] = {
160 memset(&pr, 0, sizeof(pr));
164 store = get_storage_resource(ua, 1);
168 ua->jcr->store = store;
170 if (!relabel && find_arg_keyword(ua, barcode_keyword) >= 0) {
171 label_from_barcodes(ua);
175 /* If relabel get name of Volume to relabel */
177 /* Check for oldvolume=name */
178 i = find_arg_with_value(ua, "oldvolume");
180 memset(&omr, 0, sizeof(omr));
181 bstrncpy(omr.VolumeName, ua->argv[i], sizeof(omr.VolumeName));
182 if (db_get_media_record(ua->jcr, ua->db, &omr)) {
185 bsendmsg(ua, "%s", db_strerror(ua->db));
187 /* No keyword or Vol not found, ask user to select */
188 if (!select_media_dbr(ua, &omr)) {
192 /* Require Volume to be Purged */
194 if (strcmp(omr.VolStatus, "Purged") != 0) {
195 bsendmsg(ua, _("Volume \"%s\" has VolStatus %s. It must be purged before relabeling.\n"),
196 omr.VolumeName, omr.VolStatus);
201 /* Check for volume=NewVolume */
202 i = find_arg_with_value(ua, "volume");
204 pm_strcpy(&ua->cmd, ua->argv[i]);
208 /* Get a new Volume name */
210 if (!get_cmd(ua, _("Enter new Volume name: "))) {
214 if (!is_volume_name_legal(ua, ua->cmd)) {
218 memset(&mr, 0, sizeof(mr));
219 bstrncpy(mr.VolumeName, ua->cmd, sizeof(mr.VolumeName));
220 if (db_get_media_record(ua->jcr, ua->db, &mr)) {
221 bsendmsg(ua, _("Media record for new Volume \"%s\" already exists.\n"),
228 /* If autochanger, request slot */
229 if (store->autochanger) {
230 i = find_arg_with_value(ua, "slot");
232 mr.Slot = atoi(ua->argv[i]);
233 } else if (!get_pint(ua, _("Enter slot (0 for none): "))) {
236 mr.Slot = ua->pint32_val;
240 bstrncpy(mr.MediaType, store->media_type, sizeof(mr.MediaType));
242 /* Must select Pool if not already done */
243 if (pr.PoolId == 0) {
244 memset(&pr, 0, sizeof(pr));
245 if (!select_pool_dbr(ua, &pr)) {
250 bsendmsg(ua, _("Connecting to Storage daemon %s at %s:%d ...\n"),
251 store->hdr.name, store->address, store->SDport);
252 if (!connect_to_storage_daemon(ua->jcr, 10, SDConnectTimeout, 1)) {
253 bsendmsg(ua, _("Failed to connect to Storage daemon.\n"));
256 sd = ua->jcr->store_bsock;
258 ok = send_label_request(ua, &mr, &omr, &pr, relabel);
262 if (!db_delete_media_record(ua->jcr, ua->db, &omr)) {
263 bsendmsg(ua, _("Delete of Volume \"%s\" failed. ERR=%s"),
264 omr.VolumeName, db_strerror(ua->db));
266 bsendmsg(ua, _("Old volume \"%s\" deleted from catalog.\n"),
271 strcpy(dev_name, store->dev_name);
272 bsendmsg(ua, _("Requesting mount %s ...\n"), dev_name);
273 bash_spaces(dev_name);
274 bnet_fsend(sd, "mount %s", dev_name);
275 unbash_spaces(dev_name);
276 while (bnet_recv(sd) >= 0) {
277 bsendmsg(ua, "%s", sd->msg);
279 * 3001 OK mount. Device=xxx or
280 * 3001 Mounted Volume vvvv
282 mounted = strncmp(sd->msg, "3001 ", 5) == 0;
287 bsendmsg(ua, _("Do not forget to mount the drive!!!\n"));
289 bnet_sig(sd, BNET_TERMINATE);
291 ua->jcr->store_bsock = NULL;
297 * Request SD to send us the slot:barcodes, then wiffle
298 * through them all labeling them.
300 static void label_from_barcodes(UAContext *ua)
302 STORE *store = ua->jcr->store;
305 vol_list_t *vl, *vol_list = NULL;
307 vol_list = get_slot_list_from_SD(ua);
310 bsendmsg(ua, _("No Volumes found to label, or no barcodes.\n"));
314 /* Display list of Volumes and ask if he really wants to proceed */
315 bsendmsg(ua, _("The following Volumes will be labeled:\n"
317 "==============\n"));
318 for (vl=vol_list; vl; vl=vl->next) {
319 bsendmsg(ua, "%4d %s\n", vl->Slot, vl->VolName);
321 if (!get_cmd(ua, _("Do you want to continue? (y/n): ")) ||
322 (ua->cmd[0] != 'y' && ua->cmd[0] != 'Y')) {
326 memset(&pr, 0, sizeof(pr));
327 if (!select_pool_dbr(ua, &pr)) {
330 memset(&omr, 0, sizeof(omr));
332 /* Fire off the label requests */
333 for (vl=vol_list; vl; vl=vl->next) {
335 memset(&mr, 0, sizeof(mr));
336 bstrncpy(mr.VolumeName, vl->VolName, sizeof(mr.VolumeName));
337 if (db_get_media_record(ua->jcr, ua->db, &mr)) {
338 bsendmsg(ua, _("Media record for Slot %d Volume \"%s\" already exists.\n"),
339 vl->Slot, mr.VolumeName);
343 * Deal with creating cleaning tape here. Normal tapes created in
344 * send_label_request() below
346 if (is_cleaning_tape(ua, &mr, &pr)) {
347 set_pool_dbr_defaults_in_media_dbr(&mr, &pr);
348 if (db_create_media_record(ua->jcr, ua->db, &mr)) {
349 bsendmsg(ua, _("Catalog record for cleaning tape \"%s\" successfully created.\n"),
352 bsendmsg(ua, "Catalog error on cleaning tape: %s", db_strerror(ua->db));
356 bstrncpy(mr.MediaType, store->media_type, sizeof(mr.MediaType));
357 if (ua->jcr->store_bsock) {
358 bnet_sig(ua->jcr->store_bsock, BNET_TERMINATE);
359 bnet_close(ua->jcr->store_bsock);
360 ua->jcr->store_bsock = NULL;
362 bsendmsg(ua, _("Connecting to Storage daemon %s at %s:%d ...\n"),
363 store->hdr.name, store->address, store->SDport);
364 if (!connect_to_storage_daemon(ua->jcr, 10, SDConnectTimeout, 1)) {
365 bsendmsg(ua, _("Failed to connect to Storage daemon.\n"));
370 send_label_request(ua, &mr, &omr, &pr, 0);
376 for (vl=vol_list; vl; ) {
384 if (ua->jcr->store_bsock) {
385 bnet_sig(ua->jcr->store_bsock, BNET_TERMINATE);
386 bnet_close(ua->jcr->store_bsock);
387 ua->jcr->store_bsock = NULL;
394 * Check if the Volume name has legal characters
395 * If ua is non-NULL send the message
397 int is_volume_name_legal(UAContext *ua, char *name)
401 char *accept = ":.-_";
403 /* Restrict the characters permitted in the Volume name */
404 for (p=name; *p; p++) {
405 if (B_ISALPHA(*p) || B_ISDIGIT(*p) || strchr(accept, (int)(*p))) {
409 bsendmsg(ua, _("Illegal character \"%c\" in a volume name.\n"), *p);
414 if (len >= MAX_NAME_LENGTH) {
416 bsendmsg(ua, _("Volume name too long.\n"));
422 bsendmsg(ua, _("Volume name must be at least one character long.\n"));
429 static int send_label_request(UAContext *ua, MEDIA_DBR *mr, MEDIA_DBR *omr,
430 POOL_DBR *pr, int relabel)
433 char dev_name[MAX_NAME_LENGTH];
436 sd = ua->jcr->store_bsock;
437 bstrncpy(dev_name, ua->jcr->store->dev_name, sizeof(dev_name));
438 bash_spaces(dev_name);
439 bash_spaces(mr->VolumeName);
440 bash_spaces(mr->MediaType);
441 bash_spaces(pr->Name);
443 bash_spaces(omr->VolumeName);
444 bnet_fsend(sd, _("relabel %s OldName=%s NewName=%s PoolName=%s MediaType=%s Slot=%d"),
445 dev_name, omr->VolumeName, mr->VolumeName, pr->Name, mr->MediaType, mr->Slot);
446 bsendmsg(ua, _("Sending relabel command from \"%s\" to \"%s\" ...\n"),
447 omr->VolumeName, mr->VolumeName);
449 bnet_fsend(sd, _("label %s VolumeName=%s PoolName=%s MediaType=%s Slot=%d"),
450 dev_name, mr->VolumeName, pr->Name, mr->MediaType, mr->Slot);
451 bsendmsg(ua, _("Sending label command for Volume \"%s\" Slot %d ...\n"),
452 mr->VolumeName, mr->Slot);
453 Dmsg5(200, "label %s VolumeName=%s PoolName=%s MediaType=%s Slot=%d\n",
454 dev_name, mr->VolumeName, pr->Name, mr->MediaType, mr->Slot);
457 while (bnet_recv(sd) >= 0) {
458 bsendmsg(ua, "%s", sd->msg);
459 if (strncmp(sd->msg, "3000 OK label.", 14) == 0) {
463 unbash_spaces(mr->VolumeName);
464 unbash_spaces(mr->MediaType);
465 unbash_spaces(pr->Name);
466 mr->LabelDate = time(NULL);
468 set_pool_dbr_defaults_in_media_dbr(mr, pr);
469 if (db_create_media_record(ua->jcr, ua->db, mr)) {
470 bsendmsg(ua, _("Catalog record for Volume \"%s\", Slot %d successfully created.\n"),
471 mr->VolumeName, mr->Slot);
473 bsendmsg(ua, "%s", db_strerror(ua->db));
477 bsendmsg(ua, _("Label command failed.\n"));
482 static vol_list_t *get_slot_list_from_SD(UAContext *ua)
484 STORE *store = ua->jcr->store;
485 char dev_name[MAX_NAME_LENGTH];
488 vol_list_t *vol_list = NULL;
491 bsendmsg(ua, _("Connecting to Storage daemon %s at %s:%d ...\n"),
492 store->hdr.name, store->address, store->SDport);
493 if (!connect_to_storage_daemon(ua->jcr, 10, SDConnectTimeout, 1)) {
494 bsendmsg(ua, _("Failed to connect to Storage daemon.\n"));
497 sd = ua->jcr->store_bsock;
499 bstrncpy(dev_name, store->dev_name, sizeof(dev_name));
500 bash_spaces(dev_name);
501 /* Ask for autochanger list of volumes */
502 bnet_fsend(sd, _("autochanger list %s \n"), dev_name);
504 /* Read and organize list of Volumes */
505 while (bnet_recv(sd) >= 0) {
508 strip_trailing_junk(sd->msg);
510 /* Check for returned SD messages */
511 if (sd->msg[0] == '3' && B_ISDIGIT(sd->msg[1]) &&
512 B_ISDIGIT(sd->msg[2]) && B_ISDIGIT(sd->msg[3]) &&
514 bsendmsg(ua, "%s\n", sd->msg); /* pass them on to user */
518 /* Validate Slot:Barcode */
519 p = strchr(sd->msg, ':');
520 if (p && strlen(p) > 1) {
522 if (!is_an_integer(sd->msg)) {
528 Slot = atoi(sd->msg);
529 if (Slot <= 0 || !is_volume_name_legal(ua, p)) {
533 /* Add Slot and VolumeName to list */
534 vl = (vol_list_t *)malloc(sizeof(vol_list_t));
536 vl->VolName = bstrdup(p);
541 /* Add new entry to end of list */
542 for (vol_list_t *tvl=vol_list; tvl; tvl=tvl->next) {
555 * Check if this is a cleaning tape by comparing the Volume name
556 * with the Cleaning Prefix. If they match, this is a cleaning
559 static int is_cleaning_tape(UAContext *ua, MEDIA_DBR *mr, POOL_DBR *pr)
561 if (!ua->jcr->pool) {
562 /* Find Pool resource */
563 ua->jcr->pool = (POOL *)GetResWithName(R_POOL, pr->Name);
564 if (!ua->jcr->pool) {
565 bsendmsg(ua, _("Pool %s resource not found!\n"), pr->Name);
569 if (ua->jcr->pool->cleaning_prefix == NULL) {
572 return strncmp(mr->VolumeName, ua->jcr->pool->cleaning_prefix,
573 strlen(ua->jcr->pool->cleaning_prefix)) == 0;