]> git.sur5r.net Git - bacula/bacula/blob - bacula/src/stored/butil.c
First cut 1.27 see kes23Oct02
[bacula/bacula] / bacula / src / stored / butil.c
1 /*
2  *
3  *  Utility routines for "tool" programs such as bscan, bls,
4  *    bextract, ...  
5  * 
6  *  Normally nothing in this file is called by the Storage   
7  *    daemon because we interact more directly with the user
8  *    i.e. printf, ...
9  *
10  *   Version $Id$
11  */
12 /*
13    Copyright (C) 2000, 2001, 2002 Kern Sibbald and John Walker
14
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.
19
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.
24
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,
28    MA 02111-1307, USA.
29
30  */
31
32 #include "bacula.h"
33 #include "stored.h"
34
35 /* Imported variables -- eliminate some day */
36 extern char *configfile;
37
38 #ifdef DEBUG
39 char *rec_state_to_str(DEV_RECORD *rec)
40 {
41    static char buf[200]; 
42    buf[0] = 0;
43    if (rec->state & REC_NO_HEADER) {
44       strcat(buf, "Nohdr,");
45    }
46    if (is_partial_record(rec)) {
47       strcat(buf, "partial,");
48    }
49    if (rec->state & REC_BLOCK_EMPTY) {
50       strcat(buf, "empty,");
51    }
52    if (rec->state & REC_NO_MATCH) {
53       strcat(buf, "Nomatch,");
54    }
55    if (rec->state & REC_CONTINUATION) {
56       strcat(buf, "cont,");
57    }
58    if (buf[0]) {
59       buf[strlen(buf)-1] = 0;
60    }
61    return buf;
62 }
63 #endif
64
65
66 /*
67  * Setup device, jcr, and prepare to access device.
68  *   If the caller wants read access, acquire the device, otherwise,
69  *     the caller will do it.
70  */
71 DEVICE *setup_to_access_device(JCR *jcr, int read_access)
72 {
73    DEVICE *dev;
74    DEV_BLOCK *block;
75    char *p;
76    DEVRES *device;
77
78    jcr->VolumeName[0] = 0;
79    if (strncmp(jcr->dev_name, "/dev/", 5) != 0) {
80       /* Try stripping file part */
81       p = jcr->dev_name + strlen(jcr->dev_name);
82       while (p >= jcr->dev_name && *p != '/')
83          p--;
84       if (*p == '/') {
85          strcpy(jcr->VolumeName, p+1);
86          *p = 0;
87       }
88    }
89
90    if ((device=find_device_res(jcr->dev_name)) == NULL) {
91       Emsg2(M_FATAL, 0, "Cannot find device %s in config file %s.\n", 
92            jcr->dev_name, configfile);
93       return NULL;
94    }
95    
96    dev = init_dev(NULL, device);
97    if (!dev) {
98       Emsg1(M_FATAL, 0, "Cannot open %s\n", jcr->dev_name);
99       return NULL;
100    }
101    if (!open_device(dev)) {
102       Emsg1(M_FATAL, 0, "Cannot open %s\n", jcr->dev_name);
103       return NULL;
104    }
105    Dmsg0(90, "Device opened for read.\n");
106
107    block = new_block(dev);
108
109    create_vol_list(jcr);
110
111    Dmsg1(100, "Volume=%s\n", jcr->VolumeName);
112    if (read_access) {
113       if (!acquire_device_for_read(jcr, dev, block)) {
114          Emsg0(M_ERROR, 0, dev->errmsg);
115          return NULL;
116       }
117    }
118    free_block(block);
119    return dev;
120 }
121
122
123 /*
124  * Search for device resource that corresponds to 
125  * device name on command line (or default).
126  *       
127  * Returns: NULL on failure
128  *          Device resource pointer on success
129  */
130 DEVRES *find_device_res(char *device_name)
131 {
132    int found = 0;
133    DEVRES *device;
134
135    LockRes();
136    for (device=NULL; (device=(DEVRES *)GetNextRes(R_DEVICE, (RES *)device)); ) {
137       if (strcmp(device->device_name, device_name) == 0) {
138          found = 1;
139          break;
140       }
141    } 
142    UnlockRes();
143    if (!found) {
144       Pmsg2(0, "Could not find device %s in config file %s.\n", device_name,
145             configfile);
146       return NULL;
147    }
148    Pmsg1(0, "Using device: %s\n", device_name);
149    return device;
150 }
151
152
153
154 /*
155  * Called here when freeing JCR so that we can get rid 
156  *  of "daemon" specific memory allocated.
157  */
158 static void my_free_jcr(JCR *jcr)
159 {
160    if (jcr->pool_name) {
161       free_pool_memory(jcr->pool_name);
162       jcr->pool_name = NULL;
163    }
164    if (jcr->pool_type) {
165       free_pool_memory(jcr->pool_type);
166       jcr->pool_type = NULL;
167    }
168    if (jcr->job_name) {
169       free_pool_memory(jcr->job_name);
170       jcr->job_name = NULL;
171    }
172    if (jcr->client_name) {
173       free_pool_memory(jcr->client_name);
174       jcr->client_name = NULL;
175    }
176    if (jcr->fileset_name) {
177       free_pool_memory(jcr->fileset_name);
178       jcr->fileset_name = NULL;
179    }
180    if (jcr->dev_name) {
181       free_pool_memory(jcr->dev_name);
182       jcr->dev_name = NULL;
183    }
184      
185    return;
186 }
187
188 /*
189  * Setup a "daemon" JCR for the various standalone
190  *  tools (e.g. bls, bextract, bscan, ...)
191  */
192 JCR *setup_jcr(char *name, char *device, BSR *bsr) 
193 {
194    JCR *jcr = new_jcr(sizeof(JCR), my_free_jcr);
195    jcr->VolSessionId = 1;
196    jcr->VolSessionTime = (uint32_t)time(NULL);
197    jcr->bsr = bsr;
198    jcr->NumVolumes = 1;
199    jcr->pool_name = get_pool_memory(PM_FNAME);
200    strcpy(jcr->pool_name, "Default");
201    jcr->pool_type = get_pool_memory(PM_FNAME);
202    strcpy(jcr->pool_type, "Backup");
203    jcr->job_name = get_pool_memory(PM_FNAME);
204    strcpy(jcr->job_name, "Dummy.Job.Name");
205    jcr->client_name = get_pool_memory(PM_FNAME);
206    strcpy(jcr->client_name, "Dummy.Client.Name");
207    strcpy(jcr->Job, name);
208    jcr->fileset_name = get_pool_memory(PM_FNAME);
209    strcpy(jcr->fileset_name, "Dummy.fileset.name");
210    jcr->JobId = 1;
211    jcr->JobType = JT_BACKUP;
212    jcr->JobLevel = L_FULL;
213    jcr->JobStatus = JS_Terminated;
214    jcr->dev_name = get_pool_memory(PM_FNAME);
215    pm_strcpy(&jcr->dev_name, device);
216    return jcr;
217 }
218
219
220 /*
221  * Device got an error, attempt to analyse it
222  */
223 void display_error_status(DEVICE *dev)
224 {
225    uint32_t status;
226
227    Emsg0(M_ERROR, 0, dev->errmsg);
228    status_dev(dev, &status);
229    Dmsg1(20, "Device status: %x\n", status);
230    if (status & MT_EOD)
231       Emsg0(M_ERROR_TERM, 0, "Unexpected End of Data\n");
232    else if (status & MT_EOT)
233       Emsg0(M_ERROR_TERM, 0, "Unexpected End of Tape\n");
234    else if (status & MT_EOF)
235       Emsg0(M_ERROR_TERM, 0, "Unexpected End of File\n");
236    else if (status & MT_DR_OPEN)
237       Emsg0(M_ERROR_TERM, 0, "Tape Door is Open\n");
238    else if (!(status & MT_ONLINE))
239       Emsg0(M_ERROR_TERM, 0, "Unexpected Tape is Off-line\n");
240    else
241       Emsg2(M_ERROR_TERM, 0, "Read error on Record Header %s: %s\n", dev_name(dev), strerror(errno));
242 }
243
244
245 extern char *getuser(uid_t uid);
246 extern char *getgroup(gid_t gid);
247
248 void print_ls_output(char *fname, char *link, int type, struct stat *statp)
249 {
250    char buf[1000]; 
251    char ec1[30];
252    char *p, *f;
253    int n;
254
255    p = encode_mode(statp->st_mode, buf);
256    n = sprintf(p, "  %2d ", (uint32_t)statp->st_nlink);
257    p += n;
258    n = sprintf(p, "%-8.8s %-8.8s", getuser(statp->st_uid), getgroup(statp->st_gid));
259    p += n;
260    n = sprintf(p, "%8.8s ", edit_uint64(statp->st_size, ec1));
261    p += n;
262    p = encode_time(statp->st_ctime, p);
263    *p++ = ' ';
264    *p++ = ' ';
265    /* Copy file name */
266    for (f=fname; *f && (p-buf) < (int)sizeof(buf); )
267       *p++ = *f++;
268    if (type == FT_LNK) {
269       *p++ = ' ';
270       *p++ = '-';
271       *p++ = '>';
272       *p++ = ' ';
273       /* Copy link name */
274       for (f=link; *f && (p-buf) < (int)sizeof(buf); )
275          *p++ = *f++;
276    }
277    *p++ = '\n';
278    *p = 0;
279    fputs(buf, stdout);
280 }