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