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 #if defined(HAVE_CYGWIN) || defined(HAVE_WIN32)
  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, struct stat *statp)
 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    p += from_base64(&val, p);
 234    statp->st_mode = val;              /* st_mode */
 235    p++;
 236    skip_nonspaces(&p);                /* st_nlink */
 237    p++;
 238    skip_nonspaces(&p);                /* st_uid */
 239    p++;
 240    skip_nonspaces(&p);                /* st_gid */
 241    p++;
 242    skip_nonspaces(&p);                /* st_rdev */
 243    p++;
 244    skip_nonspaces(&p);                /* st_size */
 245    p++;
 246    skip_nonspaces(&p);                /* st_blksize */
 247    p++;
 248    skip_nonspaces(&p);                /* st_blocks */
 249    p++;
 250    skip_nonspaces(&p);                /* st_atime */
 251    p++;
 252    skip_nonspaces(&p);                /* st_mtime */
 253    p++;
 254    skip_nonspaces(&p);                /* st_ctime */
 255
 256    /* Optional FileIndex of hard linked file data */
 257    if (*p == ' ' || (*p != 0 && *(p+1) == ' ')) {
 258       p++;
 259       p += from_base64(&val, p);
 260       return (int32_t)val;
 261    }
 262    return 0;
 263 }
 264
 265 /*
 266  * Set file modes, permissions and times
 267  *
 268  *  fname is the original filename
 269  *  ofile is the output filename (may be in a different directory)
 270  *
 271  * Returns:  1 on success
 272  *           0 on failure
 273  */
 274 int set_attributes(JCR *jcr, ATTR *attr, BFILE *ofd)
 275 {
 276    struct utimbuf ut;
 277    mode_t old_mask;
 278    int stat = 1;
 279
 280 #if defined(HAVE_CYGWIN) || defined(HAVE_WIN32)
 281    if (attr->data_stream == STREAM_WIN32_DATA ||
 282        attr->data_stream == STREAM_WIN32_GZIP_DATA) {
 283       if (is_bopen(ofd)) {
 284          bclose(ofd);
 285       }
 286       pm_strcpy(&attr->ofname, "*none*");
 287       return 1;
 288    }
 289
 290    if (attr->stream == STREAM_UNIX_ATTRIBUTES_EX &&
 291        set_win32_attributes(jcr, attr, ofd)) {
 292       if (is_bopen(ofd)) {
 293          bclose(ofd);
 294       }
 295       pm_strcpy(&attr->ofname, "*none*");
 296       return 1;
 297    }
 298    /*
 299     * If Windows stuff failed, e.g. attempt to restore Unix file
 300     *  to Windows, simply fall through and we will do it the
 301     *  universal way.
 302     */
 303 #endif
 304
 305    old_mask = umask(0);
 306    if (is_bopen(ofd)) {
 307       bclose(ofd);                    /* first close file */
 308    }
 309
 310    ut.actime = attr->statp.st_atime;
 311    ut.modtime = attr->statp.st_mtime;
 312
 313    /* ***FIXME**** optimize -- don't do if already correct */
 314    /*
 315     * For link, change owner of link using lchown, but don't
 316     *   try to do a chmod as that will update the file behind it.
 317     */
 318    if (attr->type == FT_LNK) {
 319       /* Change owner of link, not of real file */
 320       if (lchown(attr->ofname, attr->statp.st_uid, attr->statp.st_gid) < 0) {
 321          Jmsg2(jcr, M_ERROR, 0, _("Unable to set file owner %s: ERR=%s\n"),
 322             attr->ofname, strerror(errno));
 323          stat = 0;
 324       }
 325    } else {
 326       if (chown(attr->ofname, attr->statp.st_uid, attr->statp.st_gid) < 0) {
 327          Jmsg2(jcr, M_ERROR, 0, _("Unable to set file owner %s: ERR=%s\n"),
 328             attr->ofname, strerror(errno));
 329          stat = 0;
 330       }
 331       if (chmod(attr->ofname, attr->statp.st_mode) < 0) {
 332          Jmsg2(jcr, M_ERROR, 0, _("Unable to set file modes %s: ERR=%s\n"),
 333             attr->ofname, strerror(errno));
 334          stat = 0;
 335       }
 336
 337       /* FreeBSD user flags */
 338 #ifdef HAVE_CHFLAGS
 339       if (chflags(attr->ofname, attr->statp.st_flags) < 0) {
 340          Jmsg2(jcr, M_ERROR, 0, _("Unable to set file flags %s: ERR=%s\n"),
 341             attr->ofname, strerror(errno));
 342          stat = 0;
 343       }
 344 #endif
 345       /*
 346        * Reset file times.
 347        */
 348       if (utime(attr->ofname, &ut) < 0) {
 349          Jmsg2(jcr, M_ERROR, 0, _("Unable to set file times %s: ERR=%s\n"),
 350             attr->ofname, strerror(errno));
 351          stat = 0;
 352       }
 353    }
 354    pm_strcpy(&attr->ofname, "*none*");
 355    umask(old_mask);
 356    return stat;
 357 }
 358
 359
 360 /*=============================================================*/
 361 /*                                                             */
 362 /*                 * * *  U n i x * * * *                      */
 363 /*                                                             */
 364 /*=============================================================*/
 365
 366 #if !defined(HAVE_CYGWIN) && !defined(HAVE_WIN32)
 367
 368 /*
 369  * It is possible to piggyback additional data e.g. ACLs on
 370  *   the encode_stat() data by returning the extended attributes
 371  *   here.  They must be "self-contained" (i.e. you keep track
 372  *   of your own length), and they must be in ASCII string
 373  *   format. Using this feature is not recommended.
 374  * The code below shows how to return nothing.  See the Win32
 375  *   code below for returning something in the attributes.
 376  */
 377 int encode_attribsEx(JCR *jcr, char *attribsEx, FF_PKT *ff_pkt)
 378 {
 379    *attribsEx = 0;                    /* no extended attributes */
 380    return STREAM_UNIX_ATTRIBUTES;
 381 }
 382
 383 #endif
 384
 385
 386
 387 /*=============================================================*/
 388 /*                                                             */
 389 /*                 * * *  W i n 3 2 * * * *                    */
 390 /*                                                             */
 391 /*=============================================================*/
 392
 393 #if defined(HAVE_CYGWIN) || defined(HAVE_WIN32)
 394
 395 int encode_attribsEx(JCR *jcr, char *attribsEx, FF_PKT *ff_pkt)
 396 {
 397    char *p = attribsEx;
 398    WIN32_FILE_ATTRIBUTE_DATA atts;
 399    ULARGE_INTEGER li;
 400
 401    attribsEx[0] = 0;                  /* no extended attributes */
 402
 403    if (!p_GetFileAttributesEx) {
 404       return STREAM_UNIX_ATTRIBUTES;
 405    }
 406
 407    unix_name_to_win32(&ff_pkt->sys_fname, ff_pkt->fname);
 408    if (!p_GetFileAttributesEx(ff_pkt->sys_fname, GetFileExInfoStandard,
 409                             (LPVOID)&atts)) {
 410       win_error(jcr, "GetFileAttributesEx:", ff_pkt->sys_fname);
 411       return STREAM_UNIX_ATTRIBUTES;
 412    }
 413
 414    p += to_base64((uint64_t)atts.dwFileAttributes, p);
 415    *p++ = ' ';                        /* separate fields with a space */
 416    li.LowPart = atts.ftCreationTime.dwLowDateTime;
 417    li.HighPart = atts.ftCreationTime.dwHighDateTime;
 418    p += to_base64((uint64_t)li.QuadPart, p);
 419    *p++ = ' ';
 420    li.LowPart = atts.ftLastAccessTime.dwLowDateTime;
 421    li.HighPart = atts.ftLastAccessTime.dwHighDateTime;
 422    p += to_base64((uint64_t)li.QuadPart, p);
 423    *p++ = ' ';
 424    li.LowPart = atts.ftLastWriteTime.dwLowDateTime;
 425    li.HighPart = atts.ftLastWriteTime.dwHighDateTime;
 426    p += to_base64((uint64_t)li.QuadPart, p);
 427    *p++ = ' ';
 428    p += to_base64((uint64_t)atts.nFileSizeHigh, p);
 429    *p++ = ' ';
 430    p += to_base64((uint64_t)atts.nFileSizeLow, p);
 431    *p = 0;
 432    return STREAM_UNIX_ATTRIBUTES_EX;
 433 }
 434
 435 /* Define attributes that are legal to set with SetFileAttributes() */
 436 #define SET_ATTRS ( \
 437          FILE_ATTRIBUTE_ARCHIVE| \
 438          FILE_ATTRIBUTE_HIDDEN| \
 439          FILE_ATTRIBUTE_NORMAL| \
 440          FILE_ATTRIBUTE_NOT_CONTENT_INDEXED| \
 441          FILE_ATTRIBUTE_OFFLINE| \
 442          FILE_ATTRIBUTE_READONLY| \
 443          FILE_ATTRIBUTE_SYSTEM| \
 444          FILE_ATTRIBUTE_TEMPORARY)
 445
 446
 447 /*
 448  * Set Extended File Attributes for Win32
 449  *
 450  *  fname is the original filename
 451  *  ofile is the output filename (may be in a different directory)
 452  *
 453  * Returns:  1 on success
 454  *           0 on failure
 455  */
 456 static int set_win32_attributes(JCR *jcr, ATTR *attr, BFILE *ofd)
 457 {
 458    char *p = attr->attrEx;
 459    int64_t val;
 460    WIN32_FILE_ATTRIBUTE_DATA atts;
 461    ULARGE_INTEGER li;
 462    POOLMEM *win32_ofile;
 463
 464    if (!p_GetFileAttributesEx) {
 465       return 0;
 466    }
 467
 468    if (!p || !*p) {                   /* we should have attributes */
 469       Dmsg2(100, "Attributes missing. of=%s ofd=%d\n", attr->ofname, ofd->fid);
 470       if (is_bopen(ofd)) {
 471          bclose(ofd);
 472       }
 473       return 0;
 474    } else {
 475       Dmsg2(100, "Attribs %s = %s\n", attr->ofname, attr->attrEx);
 476    }
 477
 478    p += from_base64(&val, p);
 479    atts.dwFileAttributes = val;
 480    p++;                               /* skip space */
 481    p += from_base64(&val, p);
 482    li.QuadPart = val;
 483    atts.ftCreationTime.dwLowDateTime = li.LowPart;
 484    atts.ftCreationTime.dwHighDateTime = li.HighPart;
 485    p++;                               /* skip space */
 486    p += from_base64(&val, p);
 487    li.QuadPart = val;
 488    atts.ftLastAccessTime.dwLowDateTime = li.LowPart;
 489    atts.ftLastAccessTime.dwHighDateTime = li.HighPart;
 490    p++;                               /* skip space */
 491    p += from_base64(&val, p);
 492    li.QuadPart = val;
 493    atts.ftLastWriteTime.dwLowDateTime = li.LowPart;
 494    atts.ftLastWriteTime.dwHighDateTime = li.HighPart;
 495    p++;
 496    p += from_base64(&val, p);
 497    atts.nFileSizeHigh = val;
 498    p++;
 499    p += from_base64(&val, p);
 500    atts.nFileSizeLow = val;
 501
 502    /* Convert to Windows path format */
 503    win32_ofile = get_pool_memory(PM_FNAME);
 504    unix_name_to_win32(&win32_ofile, attr->ofname);
 505
 506
 507
 508    /* At this point, we have reconstructed the WIN32_FILE_ATTRIBUTE_DATA pkt */
 509
 510    if (!is_bopen(ofd)) {
 511       Dmsg1(100, "File not open: %s\n", attr->ofname);
 512       bopen(ofd, attr->ofname, O_WRONLY|O_BINARY, 0);   /* attempt to open the file */
 513    }
 514
 515    if (is_bopen(ofd)) {
 516       Dmsg1(100, "SetFileTime %s\n", attr->ofname);
 517       if (!SetFileTime(bget_handle(ofd),
 518                          &atts.ftCreationTime,
 519                          &atts.ftLastAccessTime,
 520                          &atts.ftLastWriteTime)) {
 521          win_error(jcr, "SetFileTime:", win32_ofile);
 522       }
 523       bclose(ofd);
 524    }
 525
 526    Dmsg1(100, "SetFileAtts %s\n", attr->ofname);
 527    if (!(atts.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)) {
 528       if (!SetFileAttributes(win32_ofile, atts.dwFileAttributes & SET_ATTRS)) {
 529          win_error(jcr, "SetFileAttributes:", win32_ofile);
 530       }
 531    }
 532    free_pool_memory(win32_ofile);
 533    return 1;
 534 }
 535
 536 void win_error(JCR *jcr, char *prefix, POOLMEM *win32_ofile)
 537 {
 538    DWORD lerror = GetLastError();
 539    LPTSTR msg;
 540    FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER|
 541                  FORMAT_MESSAGE_FROM_SYSTEM,
 542                  NULL,
 543                  lerror,
 544                  0,
 545                  (LPTSTR)&msg,
 546                  0,
 547                  NULL);
 548    Dmsg3(100, "Error in %s on file %s: ERR=%s\n", prefix, win32_ofile, msg);
 549    strip_trailing_junk(msg);
 550    Jmsg(jcr, M_ERROR, 0, _("Error in %s file %s: ERR=%s\n"), prefix, win32_ofile, msg);
 551    LocalFree(msg);
 552 }
 553
 554 void win_error(JCR *jcr, char *prefix, DWORD lerror)
 555 {
 556    LPTSTR msg;
 557    FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER|
 558                  FORMAT_MESSAGE_FROM_SYSTEM,
 559                  NULL,
 560                  lerror,
 561                  0,
 562                  (LPTSTR)&msg,
 563                  0,
 564                  NULL);
 565    strip_trailing_junk(msg);
 566    if (jcr) {
 567       Jmsg2(jcr, M_ERROR, 0, _("Error in %s: ERR=%s\n"), prefix, msg);
 568    } else {
 569       MessageBox(NULL, msg, prefix, MB_OK);
 570    }
 571    LocalFree(msg);
 572 }
 573
 574
 575 /* Cygwin API definition */
 576 extern "C" void cygwin_conv_to_win32_path(const char *path, char *win32_path);
 577
 578 void unix_name_to_win32(POOLMEM **win32_name, char *name)
 579 {
 580    /* One extra byte should suffice, but we double it */
 581    *win32_name = check_pool_memory_size(*win32_name, 2*strlen(name)+1);
 582    cygwin_conv_to_win32_path(name, *win32_name);
 583 }
 584
 585 #endif  /* HAVE_CYGWIN */