git.sur5r.net Git - bacula/bacula/blob - bacula/src/findlib/attribs.c

   1 /*
   2  *  Encode and decode standard Unix attributes and
   3  *   Extended attributes for Win32 and
   4  *   other non-Unix systems, or Unix systems with ACLs, ...
   5  *
   6  *    Kern Sibbald, October MMII
   7  *
   8  *   Version $Id$
   9  *
  10  */
  11 /*
  12    Copyright (C) 2000-2004 Kern Sibbald and John Walker
  13
  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.
  18
  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.
  23
  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,
  27    MA 02111-1307, USA.
  28
  29  */
  30
  31 #include "bacula.h"
  32 #include "find.h"
  33
  34 #ifdef HAVE_CYGWIN
  35
  36 /* Forward referenced subroutines */
  37 static int set_win32_attributes(JCR *jcr, ATTR *attr, BFILE *ofd);
  38 void unix_name_to_win32(POOLMEM **win32_name, char *name);
  39 void win_error(JCR *jcr, char *prefix, POOLMEM *ofile);
  40 HANDLE bget_handle(BFILE *bfd);
  41 #endif
  42
  43 /* For old systems that don't have lchown() use chown() */
  44 #ifndef HAVE_LCHOWN
  45 #define lchown chown
  46 #endif
  47
  48 /*=============================================================*/
  49 /*                                                             */
  50 /*             ***  A l l  S y s t e m s ***                   */
  51 /*                                                             */
  52 /*=============================================================*/
  53
  54 /*
  55  * Return the data stream that will be used
  56  */
  57 int select_data_stream(FF_PKT *ff_pkt)
  58 {
  59    int stream;
  60
  61    /* Note, no sparse option for win32_data */
  62    if (!is_portable_backup(&ff_pkt->bfd)) {
  63       stream = STREAM_WIN32_DATA;
  64       ff_pkt->flags &= ~FO_SPARSE;
  65    } else if (ff_pkt->flags & FO_SPARSE) {
  66       stream = STREAM_SPARSE_DATA;
  67    } else {
  68       stream = STREAM_FILE_DATA;
  69    }
  70 #ifdef HAVE_LIBZ
  71    if (ff_pkt->flags & FO_GZIP) {
  72       if (stream == STREAM_WIN32_DATA) {
  73          stream = STREAM_WIN32_GZIP_DATA;
  74       } else if (stream == STREAM_FILE_DATA) {
  75          stream = STREAM_GZIP_DATA;
  76       } else {
  77          stream = STREAM_SPARSE_GZIP_DATA;
  78       }
  79    }
  80 #endif
  81    return stream;
  82 }
  83
  84
  85 /*
  86  * Encode a stat structure into a base64 character string
  87  *   All systems must create such a structure.
  88  *   In addition, we tack on the LinkFI, which is non-zero in
  89  *   the case of a hard linked file that has no data.  This
  90  *   is a File Index pointing to the link that does have the
  91  *   data (always the first one encountered in a save).
  92  * You may piggyback attributes on this packet by encoding
  93  *   them in the encode_attribsEx() subroutine, but this is
  94  *   not recommended.
  95  */
  96 void encode_stat(char *buf, FF_PKT *ff_pkt, int data_stream)
  97 {
  98    char *p = buf;
  99    struct stat *statp = &ff_pkt->statp;
 100    /*
 101     *  Encode a stat packet.  I should have done this more intelligently
 102     *   with a length so that it could be easily expanded.
 103     */
 104    p += to_base64((int64_t)statp->st_dev, p);
 105    *p++ = ' ';                        /* separate fields with a space */
 106    p += to_base64((int64_t)statp->st_ino, p);
 107    *p++ = ' ';
 108    p += to_base64((int64_t)statp->st_mode, p);
 109    *p++ = ' ';
 110    p += to_base64((int64_t)statp->st_nlink, p);
 111    *p++ = ' ';
 112    p += to_base64((int64_t)statp->st_uid, p);
 113    *p++ = ' ';
 114    p += to_base64((int64_t)statp->st_gid, p);
 115    *p++ = ' ';
 116    p += to_base64((int64_t)statp->st_rdev, p);
 117    *p++ = ' ';
 118    p += to_base64((int64_t)statp->st_size, p);
 119    *p++ = ' ';
 120    p += to_base64((int64_t)statp->st_blksize, p);
 121    *p++ = ' ';
 122    p += to_base64((int64_t)statp->st_blocks, p);
 123    *p++ = ' ';
 124    p += to_base64((int64_t)statp->st_atime, p);
 125    *p++ = ' ';
 126    p += to_base64((int64_t)statp->st_mtime, p);
 127    *p++ = ' ';
 128    p += to_base64((int64_t)statp->st_ctime, p);
 129    *p++ = ' ';
 130    p += to_base64((int64_t)ff_pkt->LinkFI, p);
 131    *p++ = ' ';
 132
 133 #ifdef HAVE_CHFLAGS
 134    /* FreeBSD function */
 135    p += to_base64((int64_t)statp->st_flags, p);  /* output st_flags */
 136 #else
 137    p += to_base64((int64_t)0, p);     /* output place holder */
 138 #endif
 139    *p++ = ' ';
 140    p += to_base64((int64_t)data_stream, p);
 141    *p = 0;
 142    return;
 143 }
 144
 145
 146
 147 /* Decode a stat packet from base64 characters */
 148 int decode_stat(char *buf, struct stat *statp, int32_t *LinkFI)
 149 {
 150    char *p = buf;
 151    int64_t val;
 152
 153    p += from_base64(&val, p);
 154    statp->st_dev = val;
 155    p++;                               /* skip space */
 156    p += from_base64(&val, p);
 157    statp->st_ino = val;
 158    p++;
 159    p += from_base64(&val, p);
 160    statp->st_mode = val;
 161    p++;
 162    p += from_base64(&val, p);
 163    statp->st_nlink = val;
 164    p++;
 165    p += from_base64(&val, p);
 166    statp->st_uid = val;
 167    p++;
 168    p += from_base64(&val, p);
 169    statp->st_gid = val;
 170    p++;
 171    p += from_base64(&val, p);
 172    statp->st_rdev = val;
 173    p++;
 174    p += from_base64(&val, p);
 175    statp->st_size = val;
 176    p++;
 177    p += from_base64(&val, p);
 178    statp->st_blksize = val;
 179    p++;
 180    p += from_base64(&val, p);
 181    statp->st_blocks = val;
 182    p++;
 183    p += from_base64(&val, p);
 184    statp->st_atime = val;
 185    p++;
 186    p += from_base64(&val, p);
 187    statp->st_mtime = val;
 188    p++;
 189    p += from_base64(&val, p);
 190    statp->st_ctime = val;
 191
 192    /* Optional FileIndex of hard linked file data */
 193    if (*p == ' ' || (*p != 0 && *(p+1) == ' ')) {
 194       p++;
 195       p += from_base64(&val, p);
 196       *LinkFI = (uint32_t)val;
 197    } else {
 198       *LinkFI = 0;
 199       return 0;
 200    }
 201
 202    /* FreeBSD user flags */
 203    if (*p == ' ' || (*p != 0 && *(p+1) == ' ')) {
 204       p++;
 205       p += from_base64(&val, p);
 206 #ifdef HAVE_CHFLAGS
 207       statp->st_flags = (uint32_t)val;
 208    } else {
 209       statp->st_flags  = 0;
 210 #endif
 211    }
 212
 213    /* Look for data stream id */
 214    if (*p == ' ' || (*p != 0 && *(p+1) == ' ')) {
 215       p++;
 216       p += from_base64(&val, p);
 217    } else {
 218       val = 0;
 219    }
 220    return (int)val;
 221 }
 222
 223 /* Decode a LinkFI field of encoded stat packet */
 224 int32_t decode_LinkFI(char *buf)
 225 {
 226    char *p = buf;
 227    int64_t val;
 228
 229    skip_nonspaces(&p);                /* st_dev */
 230    p++;                               /* skip space */
 231    skip_nonspaces(&p);                /* st_ino */
 232    p++;
 233    skip_nonspaces(&p);                /* st_mode */
 234    p++;
 235    skip_nonspaces(&p);                /* st_nlink */
 236    p++;
 237    skip_nonspaces(&p);                /* st_uid */
 238    p++;
 239    skip_nonspaces(&p);                /* st_gid */
 240    p++;
 241    skip_nonspaces(&p);                /* st_rdev */
 242    p++;
 243    skip_nonspaces(&p);                /* st_size */
 244    p++;
 245    skip_nonspaces(&p);                /* st_blksize */
 246    p++;
 247    skip_nonspaces(&p);                /* st_blocks */
 248    p++;
 249    skip_nonspaces(&p);                /* st_atime */
 250    p++;
 251    skip_nonspaces(&p);                /* st_mtime */
 252    p++;
 253    skip_nonspaces(&p);                /* st_ctime */
 254
 255    /* Optional FileIndex of hard linked file data */
 256    if (*p == ' ' || (*p != 0 && *(p+1) == ' ')) {
 257       p++;
 258       p += from_base64(&val, p);
 259       return (int32_t)val;
 260    }
 261    return 0;
 262 }
 263
 264 /*
 265  * Set file modes, permissions and times
 266  *
 267  *  fname is the original filename
 268  *  ofile is the output filename (may be in a different directory)
 269  *
 270  * Returns:  1 on success
 271  *           0 on failure
 272  */
 273 int set_attributes(JCR *jcr, ATTR *attr, BFILE *ofd)
 274 {
 275    struct utimbuf ut;
 276    mode_t old_mask;
 277    int stat = 1;
 278
 279 #ifdef HAVE_CYGWIN
 280    if (attr->data_stream == STREAM_WIN32_DATA ||
 281        attr->data_stream == STREAM_WIN32_GZIP_DATA) {
 282       if (is_bopen(ofd)) {
 283          bclose(ofd);
 284       }
 285       pm_strcpy(&attr->ofname, "*none*");
 286       return 1;
 287    }
 288
 289    if (attr->stream == STREAM_UNIX_ATTRIBUTES_EX &&
 290        set_win32_attributes(jcr, attr, ofd)) {
 291       if (is_bopen(ofd)) {
 292          bclose(ofd);
 293       }
 294       pm_strcpy(&attr->ofname, "*none*");
 295       return 1;
 296    }
 297    /*
 298     * If Windows stuff failed, e.g. attempt to restore Unix file
 299     *  to Windows, simply fall through and we will do it the
 300     *  universal way.
 301     */
 302 #endif
 303
 304    old_mask = umask(0);
 305    if (is_bopen(ofd)) {
 306       bclose(ofd);                    /* first close file */
 307    }
 308
 309    ut.actime = attr->statp.st_atime;
 310    ut.modtime = attr->statp.st_mtime;
 311
 312    /* ***FIXME**** optimize -- don't do if already correct */
 313    /*
 314     * For link, change owner of link using lchown, but don't
 315     *   try to do a chmod as that will update the file behind it.
 316     */
 317    if (attr->type == FT_LNK) {
 318       /* Change owner of link, not of real file */
 319       if (lchown(attr->ofname, attr->statp.st_uid, attr->statp.st_gid) < 0) {
 320          Jmsg2(jcr, M_ERROR, 0, _("Unable to set file owner %s: ERR=%s\n"),
 321             attr->ofname, strerror(errno));
 322          stat = 0;
 323       }
 324    } else {
 325       if (chown(attr->ofname, attr->statp.st_uid, attr->statp.st_gid) < 0) {
 326          Jmsg2(jcr, M_ERROR, 0, _("Unable to set file owner %s: ERR=%s\n"),
 327             attr->ofname, strerror(errno));
 328          stat = 0;
 329       }
 330       if (chmod(attr->ofname, attr->statp.st_mode) < 0) {
 331          Jmsg2(jcr, M_ERROR, 0, _("Unable to set file modes %s: ERR=%s\n"),
 332             attr->ofname, strerror(errno));
 333          stat = 0;
 334       }
 335
 336       /* FreeBSD user flags */
 337 #ifdef HAVE_CHFLAGS
 338       if (chflags(attr->ofname, attr->statp.st_flags) < 0) {
 339          Jmsg2(jcr, M_ERROR, 0, _("Unable to set file flags %s: ERR=%s\n"),
 340             attr->ofname, strerror(errno));
 341          stat = 0;
 342       }
 343 #endif
 344       /*
 345        * Reset file times.
 346        */
 347       if (utime(attr->ofname, &ut) < 0) {
 348          Jmsg2(jcr, M_ERROR, 0, _("Unable to set file times %s: ERR=%s\n"),
 349             attr->ofname, strerror(errno));
 350          stat = 0;
 351       }
 352    }
 353    pm_strcpy(&attr->ofname, "*none*");
 354    umask(old_mask);
 355    return stat;
 356 }
 357
 358
 359 /*=============================================================*/
 360 /*                                                             */
 361 /*                 * * *  U n i x * * * *                      */
 362 /*                                                             */
 363 /*=============================================================*/
 364
 365 #ifndef HAVE_CYGWIN
 366
 367 /*
 368  * It is possible to piggyback additional data e.g. ACLs on
 369  *   the encode_stat() data by returning the extended attributes
 370  *   here.  They must be "self-contained" (i.e. you keep track
 371  *   of your own length), and they must be in ASCII string
 372  *   format. Using this feature is not recommended.
 373  * The code below shows how to return nothing.  See the Win32
 374  *   code below for returning something in the attributes.
 375  */
 376 int encode_attribsEx(JCR *jcr, char *attribsEx, FF_PKT *ff_pkt)
 377 {
 378    *attribsEx = 0;                    /* no extended attributes */
 379    return STREAM_UNIX_ATTRIBUTES;
 380 }
 381
 382 #endif
 383
 384
 385
 386 /*=============================================================*/
 387 /*                                                             */
 388 /*                 * * *  W i n 3 2 * * * *                    */
 389 /*                                                             */
 390 /*=============================================================*/
 391
 392 #ifdef HAVE_CYGWIN
 393
 394 int encode_attribsEx(JCR *jcr, char *attribsEx, FF_PKT *ff_pkt)
 395 {
 396    char *p = attribsEx;
 397    WIN32_FILE_ATTRIBUTE_DATA atts;
 398    ULARGE_INTEGER li;
 399
 400    attribsEx[0] = 0;                  /* no extended attributes */
 401
 402    if (!p_GetFileAttributesEx) {
 403       return STREAM_UNIX_ATTRIBUTES;
 404    }
 405
 406    unix_name_to_win32(&ff_pkt->sys_fname, ff_pkt->fname);
 407    if (!p_GetFileAttributesEx(ff_pkt->sys_fname, GetFileExInfoStandard,
 408                             (LPVOID)&atts)) {
 409       win_error(jcr, "GetFileAttributesEx:", ff_pkt->sys_fname);
 410       return STREAM_UNIX_ATTRIBUTES;
 411    }
 412
 413    p += to_base64((uint64_t)atts.dwFileAttributes, p);
 414    *p++ = ' ';                        /* separate fields with a space */
 415    li.LowPart = atts.ftCreationTime.dwLowDateTime;
 416    li.HighPart = atts.ftCreationTime.dwHighDateTime;
 417    p += to_base64((uint64_t)li.QuadPart, p);
 418    *p++ = ' ';
 419    li.LowPart = atts.ftLastAccessTime.dwLowDateTime;
 420    li.HighPart = atts.ftLastAccessTime.dwHighDateTime;
 421    p += to_base64((uint64_t)li.QuadPart, p);
 422    *p++ = ' ';
 423    li.LowPart = atts.ftLastWriteTime.dwLowDateTime;
 424    li.HighPart = atts.ftLastWriteTime.dwHighDateTime;
 425    p += to_base64((uint64_t)li.QuadPart, p);
 426    *p++ = ' ';
 427    p += to_base64((uint64_t)atts.nFileSizeHigh, p);
 428    *p++ = ' ';
 429    p += to_base64((uint64_t)atts.nFileSizeLow, p);
 430    *p = 0;
 431    return STREAM_UNIX_ATTRIBUTES_EX;
 432 }
 433
 434 /* Define attributes that are legal to set with SetFileAttributes() */
 435 #define SET_ATTRS ( \
 436          FILE_ATTRIBUTE_ARCHIVE| \
 437          FILE_ATTRIBUTE_HIDDEN| \
 438          FILE_ATTRIBUTE_NORMAL| \
 439          FILE_ATTRIBUTE_NOT_CONTENT_INDEXED| \
 440          FILE_ATTRIBUTE_OFFLINE| \
 441          FILE_ATTRIBUTE_READONLY| \
 442          FILE_ATTRIBUTE_SYSTEM| \
 443          FILE_ATTRIBUTE_TEMPORARY)
 444
 445
 446 /*
 447  * Set Extended File Attributes for Win32
 448  *
 449  *  fname is the original filename
 450  *  ofile is the output filename (may be in a different directory)
 451  *
 452  * Returns:  1 on success
 453  *           0 on failure
 454  */
 455 static int set_win32_attributes(JCR *jcr, ATTR *attr, BFILE *ofd)
 456 {
 457    char *p = attr->attrEx;
 458    int64_t val;
 459    WIN32_FILE_ATTRIBUTE_DATA atts;
 460    ULARGE_INTEGER li;
 461    POOLMEM *win32_ofile;
 462
 463    if (!p_GetFileAttributesEx) {
 464       return 0;
 465    }
 466
 467    if (!p || !*p) {                   /* we should have attributes */
 468       Dmsg2(100, "Attributes missing. of=%s ofd=%d\n", attr->ofname, ofd->fid);
 469       if (is_bopen(ofd)) {
 470          bclose(ofd);
 471       }
 472       return 0;
 473    } else {
 474       Dmsg2(100, "Attribs %s = %s\n", attr->ofname, attr->attrEx);
 475    }
 476
 477    p += from_base64(&val, p);
 478    atts.dwFileAttributes = val;
 479    p++;                               /* skip space */
 480    p += from_base64(&val, p);
 481    li.QuadPart = val;
 482    atts.ftCreationTime.dwLowDateTime = li.LowPart;
 483    atts.ftCreationTime.dwHighDateTime = li.HighPart;
 484    p++;                               /* skip space */
 485    p += from_base64(&val, p);
 486    li.QuadPart = val;
 487    atts.ftLastAccessTime.dwLowDateTime = li.LowPart;
 488    atts.ftLastAccessTime.dwHighDateTime = li.HighPart;
 489    p++;                               /* skip space */
 490    p += from_base64(&val, p);
 491    li.QuadPart = val;
 492    atts.ftLastWriteTime.dwLowDateTime = li.LowPart;
 493    atts.ftLastWriteTime.dwHighDateTime = li.HighPart;
 494    p++;
 495    p += from_base64(&val, p);
 496    atts.nFileSizeHigh = val;
 497    p++;
 498    p += from_base64(&val, p);
 499    atts.nFileSizeLow = val;
 500
 501    /* Convert to Windows path format */
 502    win32_ofile = get_pool_memory(PM_FNAME);
 503    unix_name_to_win32(&win32_ofile, attr->ofname);
 504
 505
 506
 507    /* At this point, we have reconstructed the WIN32_FILE_ATTRIBUTE_DATA pkt */
 508
 509    if (!is_bopen(ofd)) {
 510       Dmsg1(100, "File not open: %s\n", attr->ofname);
 511       bopen(ofd, attr->ofname, O_WRONLY|O_BINARY, 0);   /* attempt to open the file */
 512    }
 513
 514    if (is_bopen(ofd)) {
 515       Dmsg1(100, "SetFileTime %s\n", attr->ofname);
 516       if (!SetFileTime(bget_handle(ofd),
 517                          &atts.ftCreationTime,
 518                          &atts.ftLastAccessTime,
 519                          &atts.ftLastWriteTime)) {
 520          win_error(jcr, "SetFileTime:", win32_ofile);
 521       }
 522       bclose(ofd);
 523    }
 524
 525    Dmsg1(100, "SetFileAtts %s\n", attr->ofname);
 526    if (!(atts.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)) {
 527       if (!SetFileAttributes(win32_ofile, atts.dwFileAttributes & SET_ATTRS)) {
 528          win_error(jcr, "SetFileAttributes:", win32_ofile);
 529       }
 530    }
 531    free_pool_memory(win32_ofile);
 532    return 1;
 533 }
 534
 535 void win_error(JCR *jcr, char *prefix, POOLMEM *win32_ofile)
 536 {
 537    DWORD lerror = GetLastError();
 538    LPTSTR msg;
 539    FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER|
 540                  FORMAT_MESSAGE_FROM_SYSTEM,
 541                  NULL,
 542                  lerror,
 543                  0,
 544                  (LPTSTR)&msg,
 545                  0,
 546                  NULL);
 547    Dmsg3(100, "Error in %s on file %s: ERR=%s\n", prefix, win32_ofile, msg);
 548    strip_trailing_junk(msg);
 549    Jmsg(jcr, M_ERROR, 0, _("Error in %s file %s: ERR=%s\n"), prefix, win32_ofile, msg);
 550    LocalFree(msg);
 551 }
 552
 553 void win_error(JCR *jcr, char *prefix, DWORD lerror)
 554 {
 555    LPTSTR msg;
 556    FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER|
 557                  FORMAT_MESSAGE_FROM_SYSTEM,
 558                  NULL,
 559                  lerror,
 560                  0,
 561                  (LPTSTR)&msg,
 562                  0,
 563                  NULL);
 564    strip_trailing_junk(msg);
 565    if (jcr) {
 566       Jmsg2(jcr, M_ERROR, 0, _("Error in %s: ERR=%s\n"), prefix, msg);
 567    } else {
 568       MessageBox(NULL, msg, prefix, MB_OK);
 569    }
 570    LocalFree(msg);
 571 }
 572
 573
 574 /* Cygwin API definition */
 575 extern "C" void cygwin_conv_to_win32_path(const char *path, char *win32_path);
 576
 577 void unix_name_to_win32(POOLMEM **win32_name, char *name)
 578 {
 579    /* One extra byte should suffice, but we double it */
 580    *win32_name = check_pool_memory_size(*win32_name, 2*strlen(name)+1);
 581    cygwin_conv_to_win32_path(name, *win32_name);
 582 }
 583
 584 #endif  /* HAVE_CYGWIN */