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    off_t fsize;
 304
 305 #if defined(HAVE_CYGWIN) || defined(HAVE_WIN32)
 306    if (attr->stream == STREAM_UNIX_ATTRIBUTES_EX &&
 307        set_win32_attributes(jcr, attr, ofd)) {
 308        if (is_bopen(ofd)) {
 309            bclose(ofd);
 310        }
 311        pm_strcpy(attr->ofname, "*none*");
 312        return true;
 313    }
 314    if (attr->data_stream == STREAM_WIN32_DATA ||
 315        attr->data_stream == STREAM_WIN32_GZIP_DATA) {
 316       if (is_bopen(ofd)) {
 317          bclose(ofd);
 318       }
 319       pm_strcpy(attr->ofname, "*none*");
 320       return true;
 321    }
 322
 323
 324    /*
 325     * If Windows stuff failed, e.g. attempt to restore Unix file
 326     *  to Windows, simply fall through and we will do it the
 327     *  universal way.
 328     */
 329 #endif
 330
 331    old_mask = umask(0);
 332    if (is_bopen(ofd)) {
 333       char ec1[50], ec2[50];
 334       fsize = blseek(ofd, 0, SEEK_CUR);
 335       bclose(ofd);                    /* first close file */
 336       if (fsize > 0 && fsize != attr->statp.st_size) {
 337          Jmsg3(jcr, M_ERROR, 0, _("File size of restored file %s not correct. Original %s, restored %s.\n"),
 338             attr->ofname, edit_uint64(attr->statp.st_size, ec1),
 339             edit_uint64(fsize, ec2));
 340       }
 341    }
 342
 343    ut.actime = attr->statp.st_atime;
 344    ut.modtime = attr->statp.st_mtime;
 345
 346    /* ***FIXME**** optimize -- don't do if already correct */
 347    /*
 348     * For link, change owner of link using lchown, but don't
 349     *   try to do a chmod as that will update the file behind it.
 350     */
 351    if (attr->type == FT_LNK) {
 352       /* Change owner of link, not of real file */
 353       if (lchown(attr->ofname, attr->statp.st_uid, attr->statp.st_gid) < 0) {
 354          berrno be;
 355          Jmsg2(jcr, M_ERROR, 0, _("Unable to set file owner %s: ERR=%s\n"),
 356             attr->ofname, be.strerror());
 357          ok = false;
 358       }
 359    } else {
 360       if (chown(attr->ofname, attr->statp.st_uid, attr->statp.st_gid) < 0) {
 361          berrno be;
 362          Jmsg2(jcr, M_ERROR, 0, _("Unable to set file owner %s: ERR=%s\n"),
 363             attr->ofname, be.strerror());
 364          ok = false;
 365       }
 366       if (chmod(attr->ofname, attr->statp.st_mode) < 0) {
 367          berrno be;
 368          Jmsg2(jcr, M_ERROR, 0, _("Unable to set file modes %s: ERR=%s\n"),
 369             attr->ofname, be.strerror());
 370          ok = false;
 371       }
 372
 373       /*
 374        * Reset file times.
 375        */
 376       if (utime(attr->ofname, &ut) < 0) {
 377          berrno be;
 378          Jmsg2(jcr, M_ERROR, 0, _("Unable to set file times %s: ERR=%s\n"),
 379             attr->ofname, be.strerror());
 380          ok = false;
 381       }
 382 #ifdef HAVE_CHFLAGS
 383       /*
 384        * FreeBSD user flags
 385        *
 386        * Note, this should really be done before the utime() above,
 387        *  but if the immutable bit is set, it will make the utimes()
 388        *  fail.
 389        */
 390       if (chflags(attr->ofname, attr->statp.st_flags) < 0) {
 391          berrno be;
 392          Jmsg2(jcr, M_ERROR, 0, _("Unable to set file flags %s: ERR=%s\n"),
 393             attr->ofname, be.strerror());
 394          ok = false;
 395       }
 396 #endif
 397    }
 398    pm_strcpy(attr->ofname, "*none*");
 399    umask(old_mask);
 400    return ok;
 401 }
 402
 403
 404 /*=============================================================*/
 405 /*                                                             */
 406 /*                 * * *  U n i x * * * *                      */
 407 /*                                                             */
 408 /*=============================================================*/
 409
 410 #if !defined(HAVE_CYGWIN) && !defined(HAVE_WIN32)
 411
 412 /*
 413  * It is possible to piggyback additional data e.g. ACLs on
 414  *   the encode_stat() data by returning the extended attributes
 415  *   here.  They must be "self-contained" (i.e. you keep track
 416  *   of your own length), and they must be in ASCII string
 417  *   format. Using this feature is not recommended.
 418  * The code below shows how to return nothing.  See the Win32
 419  *   code below for returning something in the attributes.
 420  */
 421 int encode_attribsEx(JCR *jcr, char *attribsEx, FF_PKT *ff_pkt)
 422 {
 423    *attribsEx = 0;                    /* no extended attributes */
 424    return STREAM_UNIX_ATTRIBUTES;
 425 }
 426
 427 #endif
 428
 429
 430
 431 /*=============================================================*/
 432 /*                                                             */
 433 /*                 * * *  W i n 3 2 * * * *                    */
 434 /*                                                             */
 435 /*=============================================================*/
 436
 437 #if defined(HAVE_CYGWIN) || defined(HAVE_WIN32)
 438
 439 int encode_attribsEx(JCR *jcr, char *attribsEx, FF_PKT *ff_pkt)
 440 {
 441    char *p = attribsEx;
 442    WIN32_FILE_ATTRIBUTE_DATA atts;
 443    ULARGE_INTEGER li;
 444
 445    attribsEx[0] = 0;                  /* no extended attributes */
 446
 447    if (!p_GetFileAttributesEx) {
 448       return STREAM_UNIX_ATTRIBUTES;
 449    }
 450
 451    unix_name_to_win32(&ff_pkt->sys_fname, ff_pkt->fname);
 452    if (!p_GetFileAttributesEx(ff_pkt->sys_fname, GetFileExInfoStandard,
 453                             (LPVOID)&atts)) {
 454       win_error(jcr, "GetFileAttributesEx:", ff_pkt->sys_fname);
 455       return STREAM_UNIX_ATTRIBUTES;
 456    }
 457
 458    p += to_base64((uint64_t)atts.dwFileAttributes, p);
 459    *p++ = ' ';                        /* separate fields with a space */
 460    li.LowPart = atts.ftCreationTime.dwLowDateTime;
 461    li.HighPart = atts.ftCreationTime.dwHighDateTime;
 462    p += to_base64((uint64_t)li.QuadPart, p);
 463    *p++ = ' ';
 464    li.LowPart = atts.ftLastAccessTime.dwLowDateTime;
 465    li.HighPart = atts.ftLastAccessTime.dwHighDateTime;
 466    p += to_base64((uint64_t)li.QuadPart, p);
 467    *p++ = ' ';
 468    li.LowPart = atts.ftLastWriteTime.dwLowDateTime;
 469    li.HighPart = atts.ftLastWriteTime.dwHighDateTime;
 470    p += to_base64((uint64_t)li.QuadPart, p);
 471    *p++ = ' ';
 472    p += to_base64((uint64_t)atts.nFileSizeHigh, p);
 473    *p++ = ' ';
 474    p += to_base64((uint64_t)atts.nFileSizeLow, p);
 475    *p = 0;
 476    return STREAM_UNIX_ATTRIBUTES_EX;
 477 }
 478
 479 /* Define attributes that are legal to set with SetFileAttributes() */
 480 #define SET_ATTRS ( \
 481          FILE_ATTRIBUTE_ARCHIVE| \
 482          FILE_ATTRIBUTE_HIDDEN| \
 483          FILE_ATTRIBUTE_NORMAL| \
 484          FILE_ATTRIBUTE_NOT_CONTENT_INDEXED| \
 485          FILE_ATTRIBUTE_OFFLINE| \
 486          FILE_ATTRIBUTE_READONLY| \
 487          FILE_ATTRIBUTE_SYSTEM| \
 488          FILE_ATTRIBUTE_TEMPORARY)
 489
 490
 491 /*
 492  * Set Extended File Attributes for Win32
 493  *
 494  *  fname is the original filename
 495  *  ofile is the output filename (may be in a different directory)
 496  *
 497  * Returns:  true  on success
 498  *           false on failure
 499  */
 500 static bool set_win32_attributes(JCR *jcr, ATTR *attr, BFILE *ofd)
 501 {
 502    char *p = attr->attrEx;
 503    int64_t val;
 504    WIN32_FILE_ATTRIBUTE_DATA atts;
 505    ULARGE_INTEGER li;
 506    POOLMEM *win32_ofile;
 507
 508    if (!p_GetFileAttributesEx) {
 509       return false;
 510    }
 511
 512    if (!p || !*p) {                   /* we should have attributes */
 513       Dmsg2(100, "Attributes missing. of=%s ofd=%d\n", attr->ofname, ofd->fid);
 514       if (is_bopen(ofd)) {
 515          bclose(ofd);
 516       }
 517       return false;
 518    } else {
 519       Dmsg2(100, "Attribs %s = %s\n", attr->ofname, attr->attrEx);
 520    }
 521
 522    p += from_base64(&val, p);
 523    plug(atts.dwFileAttributes, val);
 524    p++;                               /* skip space */
 525    p += from_base64(&val, p);
 526    li.QuadPart = val;
 527    atts.ftCreationTime.dwLowDateTime = li.LowPart;
 528    atts.ftCreationTime.dwHighDateTime = li.HighPart;
 529    p++;                               /* skip space */
 530    p += from_base64(&val, p);
 531    li.QuadPart = val;
 532    atts.ftLastAccessTime.dwLowDateTime = li.LowPart;
 533    atts.ftLastAccessTime.dwHighDateTime = li.HighPart;
 534    p++;                               /* skip space */
 535    p += from_base64(&val, p);
 536    li.QuadPart = val;
 537    atts.ftLastWriteTime.dwLowDateTime = li.LowPart;
 538    atts.ftLastWriteTime.dwHighDateTime = li.HighPart;
 539    p++;
 540    p += from_base64(&val, p);
 541    plug(atts.nFileSizeHigh, val);
 542    p++;
 543    p += from_base64(&val, p);
 544    plug(atts.nFileSizeLow, val);
 545
 546    /* Convert to Windows path format */
 547    win32_ofile = get_pool_memory(PM_FNAME);
 548    unix_name_to_win32(&win32_ofile, attr->ofname);
 549
 550
 551
 552    /* At this point, we have reconstructed the WIN32_FILE_ATTRIBUTE_DATA pkt */
 553
 554    if (!is_bopen(ofd)) {
 555       Dmsg1(100, "File not open: %s\n", attr->ofname);
 556       bopen(ofd, attr->ofname, O_WRONLY|O_BINARY, 0);   /* attempt to open the file */
 557    }
 558
 559    if (is_bopen(ofd)) {
 560       Dmsg1(100, "SetFileTime %s\n", attr->ofname);
 561       if (!SetFileTime(bget_handle(ofd),
 562                          &atts.ftCreationTime,
 563                          &atts.ftLastAccessTime,
 564                          &atts.ftLastWriteTime)) {
 565          win_error(jcr, "SetFileTime:", win32_ofile);
 566       }
 567       bclose(ofd);
 568    }
 569
 570    Dmsg1(100, "SetFileAtts %s\n", attr->ofname);
 571    if (!(atts.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)) {
 572       if (!SetFileAttributes(win32_ofile, atts.dwFileAttributes & SET_ATTRS)) {
 573          win_error(jcr, "SetFileAttributes:", win32_ofile);
 574       }
 575    }
 576    free_pool_memory(win32_ofile);
 577    return true;
 578 }
 579
 580 void win_error(JCR *jcr, char *prefix, POOLMEM *win32_ofile)
 581 {
 582    DWORD lerror = GetLastError();
 583    LPTSTR msg;
 584    FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER|
 585                  FORMAT_MESSAGE_FROM_SYSTEM,
 586                  NULL,
 587                  lerror,
 588                  0,
 589                  (LPTSTR)&msg,
 590                  0,
 591                  NULL);
 592    Dmsg3(100, "Error in %s on file %s: ERR=%s\n", prefix, win32_ofile, msg);
 593    strip_trailing_junk(msg);
 594    Jmsg(jcr, M_ERROR, 0, _("Error in %s file %s: ERR=%s\n"), prefix, win32_ofile, msg);
 595    LocalFree(msg);
 596 }
 597
 598 void win_error(JCR *jcr, char *prefix, DWORD lerror)
 599 {
 600    LPTSTR msg;
 601    FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER|
 602                  FORMAT_MESSAGE_FROM_SYSTEM,
 603                  NULL,
 604                  lerror,
 605                  0,
 606                  (LPTSTR)&msg,
 607                  0,
 608                  NULL);
 609    strip_trailing_junk(msg);
 610    if (jcr) {
 611       Jmsg2(jcr, M_ERROR, 0, _("Error in %s: ERR=%s\n"), prefix, msg);
 612    } else {
 613       MessageBox(NULL, msg, prefix, MB_OK);
 614    }
 615    LocalFree(msg);
 616 }
 617
 618
 619 /* Cygwin API definition */
 620 extern "C" void cygwin_conv_to_win32_path(const char *path, char *win32_path);
 621
 622 void unix_name_to_win32(POOLMEM **win32_name, char *name)
 623 {
 624    /* One extra byte should suffice, but we double it */
 625    *win32_name = check_pool_memory_size(*win32_name, 2*strlen(name)+1);
 626    cygwin_conv_to_win32_path(name, *win32_name);
 627 }
 628
 629 #endif  /* HAVE_CYGWIN */