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