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) 2002-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 bool 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 #ifndef HAVE_MINGW
 121    p += to_base64((int64_t)statp->st_blksize, p);
 122    *p++ = ' ';
 123    p += to_base64((int64_t)statp->st_blocks, p);
 124    *p++ = ' ';
 125 #else
 126    p += to_base64((int64_t)0, p); /* output place holder */
 127    *p++ = ' ';
 128    p += to_base64((int64_t)0, p); /* output place holder */
 129    *p++ = ' ';
 130 #endif
 131    p += to_base64((int64_t)statp->st_atime, p);
 132    *p++ = ' ';
 133    p += to_base64((int64_t)statp->st_mtime, p);
 134    *p++ = ' ';
 135    p += to_base64((int64_t)statp->st_ctime, p);
 136    *p++ = ' ';
 137    p += to_base64((int64_t)ff_pkt->LinkFI, p);
 138    *p++ = ' ';
 139
 140 #ifdef HAVE_CHFLAGS
 141    /* FreeBSD function */
 142    p += to_base64((int64_t)statp->st_flags, p);  /* output st_flags */
 143 #else
 144    p += to_base64((int64_t)0, p);     /* output place holder */
 145 #endif
 146    *p++ = ' ';
 147    p += to_base64((int64_t)data_stream, p);
 148    *p = 0;
 149    return;
 150 }
 151
 152
 153 /* Do casting according to unknown type to keep compiler happy */
 154 #if !HAVE_GCC & HAVE_SUN_OS
 155 #define plug(st, val) st = val        /* brain damaged compiler */
 156 #else
 157 template <class T> void plug(T &st, uint64_t val)
 158     { st = static_cast<T>(val); }
 159 #endif
 160
 161
 162 /* Decode a stat packet from base64 characters */
 163 int decode_stat(char *buf, struct stat *statp, int32_t *LinkFI)
 164 {
 165    char *p = buf;
 166    int64_t val;
 167
 168    p += from_base64(&val, p);
 169    plug(statp->st_dev, val);
 170    p++;
 171    p += from_base64(&val, p);
 172    plug(statp->st_ino, val);
 173    p++;
 174    p += from_base64(&val, p);
 175    plug(statp->st_mode, val);
 176    p++;
 177    p += from_base64(&val, p);
 178    plug(statp->st_nlink, val);
 179    p++;
 180    p += from_base64(&val, p);
 181    plug(statp->st_uid, val);
 182    p++;
 183    p += from_base64(&val, p);
 184    plug(statp->st_gid, val);
 185    p++;
 186    p += from_base64(&val, p);
 187    plug(statp->st_rdev, val);
 188    p++;
 189    p += from_base64(&val, p);
 190    plug(statp->st_size, val);
 191    p++;
 192 #ifndef HAVE_MINGW
 193    p += from_base64(&val, p);
 194    plug(statp->st_blksize, val);
 195    p++;
 196    p += from_base64(&val, p);
 197    plug(statp->st_blocks, val);
 198    p++;
 199 #else
 200    p += from_base64(&val, p);
 201 //   plug(statp->st_blksize, val);
 202    p++;
 203    p += from_base64(&val, p);
 204 //   plug(statp->st_blocks, val);
 205    p++;
 206 #endif
 207    p += from_base64(&val, p);
 208    plug(statp->st_atime, val);
 209    p++;
 210    p += from_base64(&val, p);
 211    plug(statp->st_mtime, val);
 212    p++;
 213    p += from_base64(&val, p);
 214    plug(statp->st_ctime, val);
 215
 216    /* Optional FileIndex of hard linked file data */
 217    if (*p == ' ' || (*p != 0 && *(p+1) == ' ')) {
 218       p++;
 219       p += from_base64(&val, p);
 220       *LinkFI = (uint32_t)val;
 221    } else {
 222       *LinkFI = 0;
 223       return 0;
 224    }
 225
 226    /* FreeBSD user flags */
 227    if (*p == ' ' || (*p != 0 && *(p+1) == ' ')) {
 228       p++;
 229       p += from_base64(&val, p);
 230 #ifdef HAVE_CHFLAGS
 231       plug(statp->st_flags, val);
 232    } else {
 233       statp->st_flags  = 0;
 234 #endif
 235    }
 236
 237    /* Look for data stream id */
 238    if (*p == ' ' || (*p != 0 && *(p+1) == ' ')) {
 239       p++;
 240       p += from_base64(&val, p);
 241    } else {
 242       val = 0;
 243    }
 244    return (int)val;
 245 }
 246
 247 /* Decode a LinkFI field of encoded stat packet */
 248 int32_t decode_LinkFI(char *buf, struct stat *statp)
 249 {
 250    char *p = buf;
 251    int64_t val;
 252
 253    skip_nonspaces(&p);                /* st_dev */
 254    p++;                               /* skip space */
 255    skip_nonspaces(&p);                /* st_ino */
 256    p++;
 257    p += from_base64(&val, p);
 258    plug(statp->st_mode, val);         /* st_mode */
 259    p++;
 260    skip_nonspaces(&p);                /* st_nlink */
 261    p++;
 262    skip_nonspaces(&p);                /* st_uid */
 263    p++;
 264    skip_nonspaces(&p);                /* st_gid */
 265    p++;
 266    skip_nonspaces(&p);                /* st_rdev */
 267    p++;
 268    skip_nonspaces(&p);                /* st_size */
 269    p++;
 270    skip_nonspaces(&p);                /* st_blksize */
 271    p++;
 272    skip_nonspaces(&p);                /* st_blocks */
 273    p++;
 274    skip_nonspaces(&p);                /* st_atime */
 275    p++;
 276    skip_nonspaces(&p);                /* st_mtime */
 277    p++;
 278    skip_nonspaces(&p);                /* st_ctime */
 279
 280    /* Optional FileIndex of hard linked file data */
 281    if (*p == ' ' || (*p != 0 && *(p+1) == ' ')) {
 282       p++;
 283       p += from_base64(&val, p);
 284       return (int32_t)val;
 285    }
 286    return 0;
 287 }
 288
 289 /*
 290  * Set file modes, permissions and times
 291  *
 292  *  fname is the original filename
 293  *  ofile is the output filename (may be in a different directory)
 294  *
 295  * Returns:  true  on success
 296  *           false on failure
 297  */
 298 bool set_attributes(JCR *jcr, ATTR *attr, BFILE *ofd)
 299 {
 300    struct utimbuf ut;
 301    mode_t old_mask;
 302    bool ok = true;
 303
 304 #if defined(HAVE_CYGWIN) || defined(HAVE_WIN32)
 305    if (attr->stream == STREAM_UNIX_ATTRIBUTES_EX &&
 306        set_win32_attributes(jcr, attr, ofd)) {
 307        if (is_bopen(ofd)) {
 308            bclose(ofd);
 309        }
 310        pm_strcpy(&attr->ofname, "*none*");
 311        return true;
 312    }
 313    if (attr->data_stream == STREAM_WIN32_DATA ||
 314        attr->data_stream == STREAM_WIN32_GZIP_DATA) {
 315       if (is_bopen(ofd)) {
 316          bclose(ofd);
 317       }
 318       pm_strcpy(&attr->ofname, "*none*");
 319       return true;
 320    }
 321
 322
 323    /*
 324     * If Windows stuff failed, e.g. attempt to restore Unix file
 325     *  to Windows, simply fall through and we will do it the
 326     *  universal way.
 327     */
 328 #endif
 329
 330    old_mask = umask(0);
 331    if (is_bopen(ofd)) {
 332       bclose(ofd);                    /* first close file */
 333    }
 334
 335    ut.actime = attr->statp.st_atime;
 336    ut.modtime = attr->statp.st_mtime;
 337
 338    /* ***FIXME**** optimize -- don't do if already correct */
 339    /*
 340     * For link, change owner of link using lchown, but don't
 341     *   try to do a chmod as that will update the file behind it.
 342     */
 343    if (attr->type == FT_LNK) {
 344       /* Change owner of link, not of real file */
 345       if (lchown(attr->ofname, attr->statp.st_uid, attr->statp.st_gid) < 0) {
 346          berrno be;
 347          Jmsg2(jcr, M_ERROR, 0, _("Unable to set file owner %s: ERR=%s\n"),
 348             attr->ofname, be.strerror());
 349          ok = false;
 350       }
 351    } else {
 352       if (chown(attr->ofname, attr->statp.st_uid, attr->statp.st_gid) < 0) {
 353          berrno be;
 354          Jmsg2(jcr, M_ERROR, 0, _("Unable to set file owner %s: ERR=%s\n"),
 355             attr->ofname, be.strerror());
 356          ok = false;
 357       }
 358       if (chmod(attr->ofname, attr->statp.st_mode) < 0) {
 359          berrno be;
 360          Jmsg2(jcr, M_ERROR, 0, _("Unable to set file modes %s: ERR=%s\n"),
 361             attr->ofname, be.strerror());
 362          ok = false;
 363       }
 364
 365       /*
 366        * Reset file times.
 367        */
 368       if (utime(attr->ofname, &ut) < 0) {
 369          berrno be;
 370          Jmsg2(jcr, M_ERROR, 0, _("Unable to set file times %s: ERR=%s\n"),
 371             attr->ofname, be.strerror());
 372          ok = false;
 373       }
 374 #ifdef HAVE_CHFLAGS
 375       /*
 376        * FreeBSD user flags
 377        *
 378        * Note, this should really be done before the utime() above,
 379        *  but if the immutable bit is set, it will make the utimes()
 380        *  fail.
 381        */
 382       if (chflags(attr->ofname, attr->statp.st_flags) < 0) {
 383          berrno be;
 384          Jmsg2(jcr, M_ERROR, 0, _("Unable to set file flags %s: ERR=%s\n"),
 385             attr->ofname, be.strerror());
 386          ok = false;
 387       }
 388 #endif
 389    }
 390    pm_strcpy(&attr->ofname, "*none*");
 391    umask(old_mask);
 392    return ok;
 393 }
 394
 395
 396 /*=============================================================*/
 397 /*                                                             */
 398 /*                 * * *  U n i x * * * *                      */
 399 /*                                                             */
 400 /*=============================================================*/
 401
 402 #if !defined(HAVE_CYGWIN) && !defined(HAVE_WIN32)
 403
 404 /*
 405  * It is possible to piggyback additional data e.g. ACLs on
 406  *   the encode_stat() data by returning the extended attributes
 407  *   here.  They must be "self-contained" (i.e. you keep track
 408  *   of your own length), and they must be in ASCII string
 409  *   format. Using this feature is not recommended.
 410  * The code below shows how to return nothing.  See the Win32
 411  *   code below for returning something in the attributes.
 412  */
 413 int encode_attribsEx(JCR *jcr, char *attribsEx, FF_PKT *ff_pkt)
 414 {
 415    *attribsEx = 0;                    /* no extended attributes */
 416    return STREAM_UNIX_ATTRIBUTES;
 417 }
 418
 419 #endif
 420
 421
 422
 423 /*=============================================================*/
 424 /*                                                             */
 425 /*                 * * *  W i n 3 2 * * * *                    */
 426 /*                                                             */
 427 /*=============================================================*/
 428
 429 #if defined(HAVE_CYGWIN) || defined(HAVE_WIN32)
 430
 431 int encode_attribsEx(JCR *jcr, char *attribsEx, FF_PKT *ff_pkt)
 432 {
 433    char *p = attribsEx;
 434    WIN32_FILE_ATTRIBUTE_DATA atts;
 435    ULARGE_INTEGER li;
 436
 437    attribsEx[0] = 0;                  /* no extended attributes */
 438
 439    if (!p_GetFileAttributesEx) {
 440       return STREAM_UNIX_ATTRIBUTES;
 441    }
 442
 443    unix_name_to_win32(&ff_pkt->sys_fname, ff_pkt->fname);
 444    if (!p_GetFileAttributesEx(ff_pkt->sys_fname, GetFileExInfoStandard,
 445                             (LPVOID)&atts)) {
 446       win_error(jcr, "GetFileAttributesEx:", ff_pkt->sys_fname);
 447       return STREAM_UNIX_ATTRIBUTES;
 448    }
 449
 450    p += to_base64((uint64_t)atts.dwFileAttributes, p);
 451    *p++ = ' ';                        /* separate fields with a space */
 452    li.LowPart = atts.ftCreationTime.dwLowDateTime;
 453    li.HighPart = atts.ftCreationTime.dwHighDateTime;
 454    p += to_base64((uint64_t)li.QuadPart, p);
 455    *p++ = ' ';
 456    li.LowPart = atts.ftLastAccessTime.dwLowDateTime;
 457    li.HighPart = atts.ftLastAccessTime.dwHighDateTime;
 458    p += to_base64((uint64_t)li.QuadPart, p);
 459    *p++ = ' ';
 460    li.LowPart = atts.ftLastWriteTime.dwLowDateTime;
 461    li.HighPart = atts.ftLastWriteTime.dwHighDateTime;
 462    p += to_base64((uint64_t)li.QuadPart, p);
 463    *p++ = ' ';
 464    p += to_base64((uint64_t)atts.nFileSizeHigh, p);
 465    *p++ = ' ';
 466    p += to_base64((uint64_t)atts.nFileSizeLow, p);
 467    *p = 0;
 468    return STREAM_UNIX_ATTRIBUTES_EX;
 469 }
 470
 471 /* Define attributes that are legal to set with SetFileAttributes() */
 472 #define SET_ATTRS ( \
 473          FILE_ATTRIBUTE_ARCHIVE| \
 474          FILE_ATTRIBUTE_HIDDEN| \
 475          FILE_ATTRIBUTE_NORMAL| \
 476          FILE_ATTRIBUTE_NOT_CONTENT_INDEXED| \
 477          FILE_ATTRIBUTE_OFFLINE| \
 478          FILE_ATTRIBUTE_READONLY| \
 479          FILE_ATTRIBUTE_SYSTEM| \
 480          FILE_ATTRIBUTE_TEMPORARY)
 481
 482
 483 /*
 484  * Set Extended File Attributes for Win32
 485  *
 486  *  fname is the original filename
 487  *  ofile is the output filename (may be in a different directory)
 488  *
 489  * Returns:  true  on success
 490  *           false on failure
 491  */
 492 static bool set_win32_attributes(JCR *jcr, ATTR *attr, BFILE *ofd)
 493 {
 494    char *p = attr->attrEx;
 495    int64_t val;
 496    WIN32_FILE_ATTRIBUTE_DATA atts;
 497    ULARGE_INTEGER li;
 498    POOLMEM *win32_ofile;
 499
 500    if (!p_GetFileAttributesEx) {
 501       return false;
 502    }
 503
 504    if (!p || !*p) {                   /* we should have attributes */
 505       Dmsg2(100, "Attributes missing. of=%s ofd=%d\n", attr->ofname, ofd->fid);
 506       if (is_bopen(ofd)) {
 507          bclose(ofd);
 508       }
 509       return false;
 510    } else {
 511       Dmsg2(100, "Attribs %s = %s\n", attr->ofname, attr->attrEx);
 512    }
 513
 514    p += from_base64(&val, p);
 515    plug(atts.dwFileAttributes, val);
 516    p++;                               /* skip space */
 517    p += from_base64(&val, p);
 518    li.QuadPart = val;
 519    atts.ftCreationTime.dwLowDateTime = li.LowPart;
 520    atts.ftCreationTime.dwHighDateTime = li.HighPart;
 521    p++;                               /* skip space */
 522    p += from_base64(&val, p);
 523    li.QuadPart = val;
 524    atts.ftLastAccessTime.dwLowDateTime = li.LowPart;
 525    atts.ftLastAccessTime.dwHighDateTime = li.HighPart;
 526    p++;                               /* skip space */
 527    p += from_base64(&val, p);
 528    li.QuadPart = val;
 529    atts.ftLastWriteTime.dwLowDateTime = li.LowPart;
 530    atts.ftLastWriteTime.dwHighDateTime = li.HighPart;
 531    p++;
 532    p += from_base64(&val, p);
 533    plug(atts.nFileSizeHigh, val);
 534    p++;
 535    p += from_base64(&val, p);
 536    plug(atts.nFileSizeLow, val);
 537
 538    /* Convert to Windows path format */
 539    win32_ofile = get_pool_memory(PM_FNAME);
 540    unix_name_to_win32(&win32_ofile, attr->ofname);
 541
 542
 543
 544    /* At this point, we have reconstructed the WIN32_FILE_ATTRIBUTE_DATA pkt */
 545
 546    if (!is_bopen(ofd)) {
 547       Dmsg1(100, "File not open: %s\n", attr->ofname);
 548       bopen(ofd, attr->ofname, O_WRONLY|O_BINARY, 0);   /* attempt to open the file */
 549    }
 550
 551    if (is_bopen(ofd)) {
 552       Dmsg1(100, "SetFileTime %s\n", attr->ofname);
 553       if (!SetFileTime(bget_handle(ofd),
 554                          &atts.ftCreationTime,
 555                          &atts.ftLastAccessTime,
 556                          &atts.ftLastWriteTime)) {
 557          win_error(jcr, "SetFileTime:", win32_ofile);
 558       }
 559       bclose(ofd);
 560    }
 561
 562    Dmsg1(100, "SetFileAtts %s\n", attr->ofname);
 563    if (!(atts.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)) {
 564       if (!SetFileAttributes(win32_ofile, atts.dwFileAttributes & SET_ATTRS)) {
 565          win_error(jcr, "SetFileAttributes:", win32_ofile);
 566       }
 567    }
 568    free_pool_memory(win32_ofile);
 569    return true;
 570 }
 571
 572 void win_error(JCR *jcr, char *prefix, POOLMEM *win32_ofile)
 573 {
 574    DWORD lerror = GetLastError();
 575    LPTSTR msg;
 576    FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER|
 577                  FORMAT_MESSAGE_FROM_SYSTEM,
 578                  NULL,
 579                  lerror,
 580                  0,
 581                  (LPTSTR)&msg,
 582                  0,
 583                  NULL);
 584    Dmsg3(100, "Error in %s on file %s: ERR=%s\n", prefix, win32_ofile, msg);
 585    strip_trailing_junk(msg);
 586    Jmsg(jcr, M_ERROR, 0, _("Error in %s file %s: ERR=%s\n"), prefix, win32_ofile, msg);
 587    LocalFree(msg);
 588 }
 589
 590 void win_error(JCR *jcr, char *prefix, DWORD lerror)
 591 {
 592    LPTSTR msg;
 593    FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER|
 594                  FORMAT_MESSAGE_FROM_SYSTEM,
 595                  NULL,
 596                  lerror,
 597                  0,
 598                  (LPTSTR)&msg,
 599                  0,
 600                  NULL);
 601    strip_trailing_junk(msg);
 602    if (jcr) {
 603       Jmsg2(jcr, M_ERROR, 0, _("Error in %s: ERR=%s\n"), prefix, msg);
 604    } else {
 605       MessageBox(NULL, msg, prefix, MB_OK);
 606    }
 607    LocalFree(msg);
 608 }
 609
 610
 611 /* Cygwin API definition */
 612 extern "C" void cygwin_conv_to_win32_path(const char *path, char *win32_path);
 613
 614 void unix_name_to_win32(POOLMEM **win32_name, char *name)
 615 {
 616    /* One extra byte should suffice, but we double it */
 617    *win32_name = check_pool_memory_size(*win32_name, 2*strlen(name)+1);
 618    cygwin_conv_to_win32_path(name, *win32_name);
 619 }
 620
 621 #endif  /* HAVE_CYGWIN */