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