2 * Encode and decode standard Unix attributes and
3 * Extended attributes for Win32 and
4 * other non-Unix systems, or Unix systems with ACLs, ...
6 * Kern Sibbald, October MMII
12 Copyright (C) 2000-2003 Kern Sibbald and John Walker
14 This program is free software; you can redistribute it and/or
15 modify it under the terms of the GNU General Public License as
16 published by the Free Software Foundation; either version 2 of
17 the License, or (at your option) any later version.
19 This program is distributed in the hope that it will be useful,
20 but WITHOUT ANY WARRANTY; without even the implied warranty of
21 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22 General Public License for more details.
24 You should have received a copy of the GNU General Public
25 License along with this program; if not, write to the Free
26 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
38 /* Forward referenced subroutines */
40 int set_win32_attributes(void *jcr, char *fname, char *ofile, char *lname,
41 int type, int stream, struct stat *statp,
42 char *attribsEx, int *ofd);
43 void unix_name_to_win32(POOLMEM **win32_name, char *name);
44 extern "C" HANDLE get_osfhandle(int fd);
45 void win_error(void *jcr, char *prefix, POOLMEM *ofile);
48 /* For old systems that don't have lchown() use chown() */
53 /*=============================================================*/
55 /* *** A l l S y s t e m s *** */
57 /*=============================================================*/
60 /* Encode a stat structure into a base64 character string */
61 void encode_stat(char *buf, struct stat *statp, uint32_t LinkFI)
65 * NOTE: we should use rdev as major and minor device if
66 * it is a block or char device (S_ISCHR(statp->st_mode)
67 * or S_ISBLK(statp->st_mode)). In all other cases,
71 p += to_base64((int64_t)statp->st_dev, p);
72 *p++ = ' '; /* separate fields with a space */
73 p += to_base64((int64_t)statp->st_ino, p);
75 p += to_base64((int64_t)statp->st_mode, p);
77 p += to_base64((int64_t)statp->st_nlink, p);
79 p += to_base64((int64_t)statp->st_uid, p);
81 p += to_base64((int64_t)statp->st_gid, p);
83 p += to_base64((int64_t)statp->st_rdev, p);
85 p += to_base64((int64_t)statp->st_size, p);
87 p += to_base64((int64_t)statp->st_blksize, p);
89 p += to_base64((int64_t)statp->st_blocks, p);
91 p += to_base64((int64_t)statp->st_atime, p);
93 p += to_base64((int64_t)statp->st_mtime, p);
95 p += to_base64((int64_t)statp->st_ctime, p);
97 p += to_base64((int64_t)LinkFI, p);
104 /* Decode a stat packet from base64 characters */
106 decode_stat(char *buf, struct stat *statp, uint32_t *LinkFI)
111 p += from_base64(&val, p);
113 p++; /* skip space */
114 p += from_base64(&val, p);
117 p += from_base64(&val, p);
118 statp->st_mode = val;
120 p += from_base64(&val, p);
121 statp->st_nlink = val;
123 p += from_base64(&val, p);
126 p += from_base64(&val, p);
129 p += from_base64(&val, p);
130 statp->st_rdev = val;
132 p += from_base64(&val, p);
133 statp->st_size = val;
135 p += from_base64(&val, p);
136 statp->st_blksize = val;
138 p += from_base64(&val, p);
139 statp->st_blocks = val;
141 p += from_base64(&val, p);
142 statp->st_atime = val;
144 p += from_base64(&val, p);
145 statp->st_mtime = val;
147 p += from_base64(&val, p);
148 statp->st_ctime = val;
149 /* Optional FileIndex of hard linked file data */
150 if (*p == ' ' || (*p != 0 && *(p+1) == ' ')) {
152 p += from_base64(&val, p);
153 *LinkFI = (uint32_t)val;
160 * Set file modes, permissions and times
162 * fname is the original filename
163 * ofile is the output filename (may be in a different directory)
165 * Returns: 1 on success
168 int set_attributes(void *jcr, char *fname, char *ofile, char *lname,
169 int type, int stream, struct stat *statp,
170 char *attribsEx, int *ofd)
175 if (set_win32_attributes(jcr, fname, ofile, lname, type, stream,
176 statp, attribsEx, ofd)) {
180 * If Windows stuff failed, e.g. attempt to restore Unix file
181 * to Windows, simply fall through and we will do it the
187 close(*ofd); /* first close file */
191 ut.actime = statp->st_atime;
192 ut.modtime = statp->st_mtime;
194 /* ***FIXME**** optimize -- don't do if already correct */
195 if (type == FT_LNK) {
196 if (lchown(ofile, statp->st_uid, statp->st_gid) < 0) {
197 Jmsg2(jcr, M_ERROR, 0, "Unable to set file owner %s: ERR=%s\n",
198 ofile, strerror(errno));
202 if (chown(ofile, statp->st_uid, statp->st_gid) < 0) {
203 Jmsg2(jcr, M_ERROR, 0, "Unable to set file owner %s: ERR=%s\n",
204 ofile, strerror(errno));
208 if (chmod(ofile, statp->st_mode) < 0) {
209 Jmsg2(jcr, M_ERROR, 0, "Unable to set file modes %s: ERR=%s\n",
210 ofile, strerror(errno));
217 if (utime(ofile, &ut) < 0) {
218 Jmsg2(jcr, M_ERROR, 0, "Unable to set file times %s: ERR=%s\n",
219 ofile, strerror(errno));
226 /*=============================================================*/
228 /* * * * U n i x * * * * */
230 /*=============================================================*/
235 * If you have a Unix system with extended attributes (e.g.
236 * ACLs for Solaris, do it here.
238 int encode_attribsEx(void *jcr, char *attribsEx, FF_PKT *ff_pkt)
240 *attribsEx = 0; /* no extended attributes */
241 return STREAM_UNIX_ATTRIBUTES;
248 /*=============================================================*/
250 /* * * * W i n 3 2 * * * * */
252 /*=============================================================*/
256 int NoGetFileAttributesEx = 0;
258 int encode_attribsEx(void *jcr, char *attribsEx, FF_PKT *ff_pkt)
261 WIN32_FILE_ATTRIBUTE_DATA atts;
264 attribsEx[0] = 0; /* no extended attributes */
266 if (NoGetFileAttributesEx) {
267 return STREAM_UNIX_ATTRIBUTES;
270 unix_name_to_win32(&ff_pkt->sys_fname, ff_pkt->fname);
271 if (!GetFileAttributesEx(ff_pkt->sys_fname, GetFileExInfoStandard,
273 win_error(jcr, "GetFileAttributesEx:", ff_pkt->sys_fname);
274 return STREAM_WIN32_ATTRIBUTES;
277 p += to_base64((uint64_t)atts.dwFileAttributes, p);
278 *p++ = ' '; /* separate fields with a space */
279 li.LowPart = atts.ftCreationTime.dwLowDateTime;
280 li.HighPart = atts.ftCreationTime.dwHighDateTime;
281 p += to_base64((uint64_t)li.QuadPart, p);
283 li.LowPart = atts.ftLastAccessTime.dwLowDateTime;
284 li.HighPart = atts.ftLastAccessTime.dwHighDateTime;
285 p += to_base64((uint64_t)li.QuadPart, p);
287 li.LowPart = atts.ftLastWriteTime.dwLowDateTime;
288 li.HighPart = atts.ftLastWriteTime.dwHighDateTime;
289 p += to_base64((uint64_t)li.QuadPart, p);
291 p += to_base64((uint64_t)atts.nFileSizeHigh, p);
293 p += to_base64((uint64_t)atts.nFileSizeLow, p);
295 return STREAM_WIN32_ATTRIBUTES;
298 /* Define attributes that are legal to set with SetFileAttributes() */
299 #define SET_ATTRS ( \
300 FILE_ATTRIBUTE_ARCHIVE| \
301 FILE_ATTRIBUTE_HIDDEN| \
302 FILE_ATTRIBUTE_NORMAL| \
303 FILE_ATTRIBUTE_NOT_CONTENT_INDEXED| \
304 FILE_ATTRIBUTE_OFFLINE| \
305 FILE_ATTRIBUTE_READONLY| \
306 FILE_ATTRIBUTE_SYSTEM| \
307 FILE_ATTRIBUTE_TEMPORARY)
311 * Set Extended File Attributes for Win32
313 * fname is the original filename
314 * ofile is the output filename (may be in a different directory)
316 * Returns: 1 on success
320 int set_win32_attributes(void *jcr, char *fname, char *ofile, char *lname,
321 int type, int stream, struct stat *statp,
322 char *attribsEx, int *ofd)
326 WIN32_FILE_ATTRIBUTE_DATA atts;
329 POOLMEM *win32_ofile;
331 if (!p || !*p) { /* we should have attributes */
332 Dmsg2(100, "Attributes missing. of=%s ofd=%d\n", ofile, *ofd);
339 Dmsg2(100, "Attribs %s = %s\n", ofile, attribsEx);
342 p += from_base64(&val, p);
343 atts.dwFileAttributes = val;
344 p++; /* skip space */
345 p += from_base64(&val, p);
347 atts.ftCreationTime.dwLowDateTime = li.LowPart;
348 atts.ftCreationTime.dwHighDateTime = li.HighPart;
349 p++; /* skip space */
350 p += from_base64(&val, p);
352 atts.ftLastAccessTime.dwLowDateTime = li.LowPart;
353 atts.ftLastAccessTime.dwHighDateTime = li.HighPart;
354 p++; /* skip space */
355 p += from_base64(&val, p);
357 atts.ftLastWriteTime.dwLowDateTime = li.LowPart;
358 atts.ftLastWriteTime.dwHighDateTime = li.HighPart;
360 p += from_base64(&val, p);
361 atts.nFileSizeHigh = val;
363 p += from_base64(&val, p);
364 atts.nFileSizeLow = val;
366 /* At this point, we have reconstructed the WIN32_FILE_ATTRIBUTE_DATA pkt */
368 /* Convert to Windows path format */
369 win32_ofile = get_pool_memory(PM_FNAME);
370 unix_name_to_win32(&win32_ofile, ofile);
373 Dmsg1(100, "File not open: %s\n", ofile);
374 fid = open(ofile, O_RDWR|O_BINARY); /* attempt to open the file */
381 Dmsg1(100, "SetFileTime %s\n", ofile);
382 stat = SetFileTime(get_osfhandle(*ofd),
383 &atts.ftCreationTime,
384 &atts.ftLastAccessTime,
385 &atts.ftLastWriteTime);
387 win_error(jcr, "SetFileTime:", win32_ofile);
393 Dmsg1(100, "SetFileAtts %s\n", ofile);
394 stat = SetFileAttributes(win32_ofile, atts.dwFileAttributes & SET_ATTRS);
396 win_error(jcr, "SetFileAttributes:", win32_ofile);
398 free_pool_memory(win32_ofile);
402 void win_error(void *vjcr, char *prefix, POOLMEM *win32_ofile)
404 JCR *jcr = (JCR *)vjcr;
405 DWORD lerror = GetLastError();
407 FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER|
408 FORMAT_MESSAGE_FROM_SYSTEM,
415 Dmsg3(100, "Error in %s on file %s: ERR=%s\n", prefix, win32_ofile, msg);
416 Jmsg3(jcr, M_INFO, 0, _("Error in %s file %s: ERR=%s\n"), prefix, win32_ofile, msg);
420 /* Cygwin API definition */
421 extern "C" void cygwin_conv_to_win32_path(const char *path, char *win32_path);
423 void unix_name_to_win32(POOLMEM **win32_name, char *name)
425 /* One extra byte should suffice, but we double it */
426 *win32_name = check_pool_memory_size(*win32_name, 2*strlen(name)+1);
427 cygwin_conv_to_win32_path(name, *win32_name);
430 #endif /* HAVE_CYGWIN */