libatalk/vfs/ea_sys.c

   1 /*
   2   Copyright (c) 2009 Frank Lahm <franklahm@gmail.com>
   3
   4   This program is free software; you can redistribute it and/or modify
   5   it under the terms of the GNU General Public License as published by
   6   the Free Software Foundation; either version 2 of the License, or
   7   (at your option) any later version.
   8
   9   This program is distributed in the hope that it will be useful,
  10   but WITHOUT ANY WARRANTY; without even the implied warranty of
  11   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12   GNU General Public License for more details.
  13 */
  14
  15 #ifdef HAVE_CONFIG_H
  16 #include "config.h"
  17 #endif /* HAVE_CONFIG_H */
  18
  19 #include <unistd.h>
  20 #include <stdint.h>
  21 #include <errno.h>
  22 #include <stdlib.h>
  23 #include <string.h>
  24 #include <sys/types.h>
  25 #include <sys/stat.h>
  26 #include <fcntl.h>
  27 #include <dirent.h>
  28
  29 #include <atalk/adouble.h>
  30 #include <atalk/ea.h>
  31 #include <atalk/afp.h>
  32 #include <atalk/logger.h>
  33 #include <atalk/volume.h>
  34 #include <atalk/vfs.h>
  35 #include <atalk/util.h>
  36 #include <atalk/unix.h>
  37 #include <atalk/compat.h>
  38
  39 /**********************************************************************************
  40  * EA VFS funcs for storing EAs in nativa filesystem EAs
  41  **********************************************************************************/
  42
  43 /*
  44  * Function: sys_get_easize
  45  *
  46  * Purpose: get size of a native EA
  47  *
  48  * Arguments:
  49  *
  50  *    vol          (r) current volume
  51  *    rbuf         (w) DSI reply buffer
  52  *    rbuflen      (rw) current length of data in reply buffer
  53  *    uname        (r) filename
  54  *    oflag        (r) link and create flag
  55  *    attruname    (r) name of attribute
  56  *
  57  * Returns: AFP code: AFP_OK on success or appropiate AFP error code
  58  *
  59  * Effects:
  60  *
  61  * Copies EA size into rbuf in network order. Increments *rbuflen +4.
  62  */
  63 int sys_get_easize(VFS_FUNC_ARGS_EA_GETSIZE)
  64 {
  65     ssize_t   ret;
  66     uint32_t  attrsize;
  67
  68     LOG(log_debug7, logtype_afpd, "sys_getextattr_size(%s): attribute: \"%s\"", uname, attruname);
  69
  70     if ((oflag & O_NOFOLLOW) ) {
  71         ret = sys_lgetxattr(uname, attruname, rbuf +4, 0);
  72     }
  73     else {
  74         ret = sys_getxattr(uname, attruname,  rbuf +4, 0);
  75     }
  76
  77     if (ret == -1) {
  78         memset(rbuf, 0, 4);
  79         *rbuflen += 4;
  80         switch(errno) {
  81         case OPEN_NOFOLLOW_ERRNO:
  82             /* its a symlink and client requested O_NOFOLLOW  */
  83             LOG(log_debug, logtype_afpd, "sys_getextattr_size(%s): encountered symlink with kXAttrNoFollow", uname);
  84             return AFP_OK;
  85
  86         case ENOATTR:
  87             return AFPERR_MISC;
  88
  89         default:
  90             LOG(log_error, logtype_afpd, "sys_getextattr_size: error: %s", strerror(errno));
  91             return AFPERR_MISC;
  92         }
  93     }
  94
  95     if (ret > MAX_EA_SIZE)
  96       ret = MAX_EA_SIZE;
  97
  98     /* Start building reply packet */
  99     LOG(log_debug7, logtype_afpd, "sys_getextattr_size(%s): attribute: \"%s\", size: %u", uname, attruname, ret);
 100
 101     /* length of attribute data */
 102     attrsize = htonl((uint32_t)ret);
 103     memcpy(rbuf, &attrsize, 4);
 104     *rbuflen += 4;
 105
 106     ret = AFP_OK;
 107     return ret;
 108 }
 109
 110 /*
 111  * Function: sys_get_eacontent
 112  *
 113  * Purpose: copy native EA into rbuf
 114  *
 115  * Arguments:
 116  *
 117  *    vol          (r) current volume
 118  *    rbuf         (w) DSI reply buffer
 119  *    rbuflen      (rw) current length of data in reply buffer
 120  *    uname        (r) filename
 121  *    oflag        (r) link and create flag
 122  *    attruname    (r) name of attribute
 123  *    maxreply     (r) maximum EA size as of current specs/real-life
 124  *
 125  * Returns: AFP code: AFP_OK on success or appropiate AFP error code
 126  *
 127  * Effects:
 128  *
 129  * Copies EA into rbuf. Increments *rbuflen accordingly.
 130  */
 131 int sys_get_eacontent(VFS_FUNC_ARGS_EA_GETCONTENT)
 132 {
 133     ssize_t   ret;
 134     uint32_t  attrsize;
 135
 136     /* Start building reply packet */
 137
 138     maxreply -= MAX_REPLY_EXTRA_BYTES;
 139
 140     if (maxreply > MAX_EA_SIZE)
 141         maxreply = MAX_EA_SIZE;
 142
 143     LOG(log_debug7, logtype_afpd, "sys_getextattr_content(%s): attribute: \"%s\", size: %u", uname, attruname, maxreply);
 144
 145     if ((oflag & O_NOFOLLOW) ) {
 146         ret = sys_lgetxattr(uname, attruname, rbuf +4, maxreply);
 147     }
 148     else {
 149         ret = sys_getxattr(uname, attruname,  rbuf +4, maxreply);
 150     }
 151
 152     if (ret == -1) {
 153         memset(rbuf, 0, 4);
 154         *rbuflen += 4;
 155         switch(errno) {
 156         case OPEN_NOFOLLOW_ERRNO:
 157             /* its a symlink and client requested O_NOFOLLOW  */
 158             LOG(log_debug, logtype_afpd, "sys_getextattr_content(%s): encountered symlink with kXAttrNoFollow", uname);
 159             return AFP_OK;
 160
 161         case ENOATTR:
 162             return AFPERR_MISC;
 163
 164         default:
 165             LOG(log_error, logtype_afpd, "sys_getextattr_content(%s): error: %s", attruname, strerror(errno));
 166             return AFPERR_MISC;
 167         }
 168     }
 169
 170     /* remember where we must store length of attribute data in rbuf */
 171     *rbuflen += 4 +ret;
 172
 173     attrsize = htonl((uint32_t)ret);
 174     memcpy(rbuf, &attrsize, 4);
 175
 176     return AFP_OK;
 177 }
 178
 179 /*
 180  * Function: sys_list_eas
 181  *
 182  * Purpose: copy names of native EAs into attrnamebuf
 183  *
 184  * Arguments:
 185  *
 186  *    vol          (r) current volume
 187  *    attrnamebuf  (w) store names a consecutive C strings here
 188  *    buflen       (rw) length of names in attrnamebuf
 189  *    uname        (r) filename
 190  *    oflag        (r) link and create flag
 191  *
 192  * Returns: AFP code: AFP_OK on success or appropiate AFP error code
 193  *
 194  * Effects:
 195  *
 196  * Copies names of all EAs of uname as consecutive C strings into rbuf.
 197  * Increments *rbuflen accordingly.
 198  */
 199 int sys_list_eas(VFS_FUNC_ARGS_EA_LIST)
 200 {
 201     ssize_t attrbuflen = *buflen;
 202     int     ret, len, nlen;
 203     char    *buf;
 204     char    *ptr;
 205
 206     buf = malloc(ATTRNAMEBUFSIZ);
 207     if (!buf)
 208         return AFPERR_MISC;
 209
 210     if ((oflag & O_NOFOLLOW)) {
 211         ret = sys_llistxattr(uname, buf, ATTRNAMEBUFSIZ);
 212     }
 213     else {
 214         ret = sys_listxattr(uname, buf, ATTRNAMEBUFSIZ);
 215     }
 216
 217     if (ret == -1) switch(errno) {
 218         case OPEN_NOFOLLOW_ERRNO:
 219             /* its a symlink and client requested O_NOFOLLOW */
 220             ret = AFPERR_BADTYPE;
 221             goto exit;
 222 #ifdef HAVE_ATTROPEN            /* Solaris */
 223         case ENOATTR:
 224             ret = AFP_OK;
 225             goto exit;
 226 #endif
 227         default:
 228             LOG(log_error, logtype_afpd, "sys_list_extattr(%s): error opening atttribute dir: %s", uname, strerror(errno));
 229             ret= AFPERR_MISC;
 230             goto exit;
 231     }
 232
 233     ptr = buf;
 234     while (ret > 0)  {
 235         len = strlen(ptr);
 236
 237         /* Convert name to CH_UTF8_MAC and directly store in in the reply buffer */
 238         if ( 0 >= ( nlen = convert_string(vol->v_volcharset, CH_UTF8_MAC, ptr, len, attrnamebuf + attrbuflen, 256)) ) {
 239             ret = AFPERR_MISC;
 240             goto exit;
 241         }
 242
 243         LOG(log_debug7, logtype_afpd, "sys_list_extattr(%s): attribute: %s", uname, ptr);
 244
 245         attrbuflen += nlen + 1;
 246         if (attrbuflen > (ATTRNAMEBUFSIZ - 256)) {
 247             /* Next EA name could overflow, so bail out with error.
 248                FIXME: evantually malloc/memcpy/realloc whatever.
 249                Is it worth it ? */
 250             LOG(log_warning, logtype_afpd, "sys_list_extattr(%s): running out of buffer for EA names", uname);
 251             ret = AFPERR_MISC;
 252             goto exit;
 253         }
 254         ret -= len +1;
 255         ptr += len +1;
 256     }
 257
 258     ret = AFP_OK;
 259
 260 exit:
 261     free(buf);
 262     *buflen = attrbuflen;
 263     return ret;
 264 }
 265
 266 /*
 267  * Function: sys_set_ea
 268  *
 269  * Purpose: set a native EA
 270  *
 271  * Arguments:
 272  *
 273  *    vol          (r) current volume
 274  *    uname        (r) filename
 275  *    attruname    (r) EA name
 276  *    ibuf         (r) buffer with EA content
 277  *    attrsize     (r) length EA in ibuf
 278  *    oflag        (r) link and create flag
 279  *
 280  * Returns: AFP code: AFP_OK on success or appropiate AFP error code
 281  *
 282  * Effects:
 283  *
 284  */
 285 int sys_set_ea(VFS_FUNC_ARGS_EA_SET)
 286 {
 287     int attr_flag;
 288     int ret;
 289
 290     attr_flag = 0;
 291     if ((oflag & O_CREAT) )
 292         attr_flag |= XATTR_CREATE;
 293
 294     else if ((oflag & O_TRUNC) )
 295         attr_flag |= XATTR_REPLACE;
 296
 297     if ((oflag & O_NOFOLLOW) ) {
 298         ret = sys_lsetxattr(uname, attruname,  ibuf, attrsize,attr_flag);
 299     }
 300     else {
 301         ret = sys_setxattr(uname, attruname,  ibuf, attrsize, attr_flag);
 302     }
 303
 304     if (ret == -1) {
 305         switch(errno) {
 306         case OPEN_NOFOLLOW_ERRNO:
 307             /* its a symlink and client requested O_NOFOLLOW  */
 308             LOG(log_debug, logtype_afpd, "sys_set_ea(%s/%s): encountered symlink with kXAttrNoFollow",
 309                 uname, attruname);
 310             return AFP_OK;
 311         case EEXIST:
 312             LOG(log_debug, logtype_afpd, "sys_set_ea(%s/%s): EA already exists",
 313                 uname, attruname);
 314             return AFPERR_EXIST;
 315         default:
 316             LOG(log_error, logtype_afpd, "sys_set_ea(%s/%s): error: %s", uname, attruname, strerror(errno));
 317             return AFPERR_MISC;
 318         }
 319     }
 320
 321     return AFP_OK;
 322 }
 323
 324 /*
 325  * Function: sys_remove_ea
 326  *
 327  * Purpose: remove a native EA
 328  *
 329  * Arguments:
 330  *
 331  *    vol          (r) current volume
 332  *    uname        (r) filename
 333  *    attruname    (r) EA name
 334  *    oflag        (r) link and create flag
 335  *
 336  * Returns: AFP code: AFP_OK on success or appropiate AFP error code
 337  *
 338  * Effects:
 339  *
 340  * Removes EA attruname from file uname.
 341  */
 342 int sys_remove_ea(VFS_FUNC_ARGS_EA_REMOVE)
 343 {
 344     int ret;
 345
 346     if ((oflag & O_NOFOLLOW) ) {
 347         ret = sys_lremovexattr(uname, attruname);
 348     }
 349     else {
 350         ret = sys_removexattr(uname, attruname);
 351     }
 352
 353     if (ret == -1) {
 354         switch(errno) {
 355         case OPEN_NOFOLLOW_ERRNO:
 356             /* its a symlink and client requested O_NOFOLLOW  */
 357             LOG(log_debug, logtype_afpd, "sys_remove_ea(%s/%s): encountered symlink with kXAttrNoFollow", uname);
 358             return AFP_OK;
 359         case EACCES:
 360             LOG(log_debug, logtype_afpd, "sys_remove_ea(%s/%s): error: %s", uname, attruname, strerror(errno));
 361             return AFPERR_ACCESS;
 362         default:
 363             LOG(log_error, logtype_afpd, "sys_remove_ea(%s/%s): error: %s", uname, attruname, strerror(errno));
 364             return AFPERR_MISC;
 365         }
 366     }
 367
 368     return AFP_OK;
 369 }
 370
 371 /*
 372  * @brief Copy EAs
 373  *
 374  * @note Supports *at semantics, therfor switches back and forth between sfd and cwd
 375  */
 376 int sys_ea_copyfile(VFS_FUNC_ARGS_COPYFILE)
 377 {
 378         int ret = 0;
 379     int cwd = -1;
 380         ssize_t size;
 381         char *names = NULL, *end_names, *name, *value = NULL;
 382         unsigned int setxattr_ENOTSUP = 0;
 383
 384     if (sfd != -1) {
 385         if ((cwd = open(".", O_RDONLY)) == -1) {
 386             LOG(log_error, logtype_afpd, "sys_ea_copyfile: cant open cwd: %s",
 387                 strerror(errno));
 388             ret = -1;
 389             goto getout;
 390         }
 391     }
 392
 393     if (sfd != -1) {
 394         if (fchdir(sfd) == -1) {
 395             LOG(log_error, logtype_afpd, "sys_ea_copyfile: cant chdir to sfd: %s",
 396                 strerror(errno));
 397             ret = -1;
 398             goto getout;
 399         }
 400     }
 401
 402         size = sys_listxattr(src, NULL, 0);
 403         if (size < 0) {
 404                 if (errno != ENOSYS && errno != ENOTSUP) {
 405                         ret = -1;
 406                 }
 407                 goto getout;
 408         }
 409         names = malloc(size+1);
 410         if (names == NULL) {
 411                 ret = -1;
 412                 goto getout;
 413         }
 414         size = sys_listxattr(src, names, size);
 415         if (size < 0) {
 416                 ret = -1;
 417                 goto getout;
 418         } else {
 419                 names[size] = '\0';
 420                 end_names = names + size;
 421         }
 422
 423     if (sfd != -1) {
 424         if (fchdir(cwd) == -1) {
 425             LOG(log_error, logtype_afpd, "sys_ea_copyfile: cant chdir to cwd: %s",
 426                 strerror(errno));
 427             ret = -1;
 428             goto getout;
 429         }
 430     }
 431
 432         for (name = names; name != end_names; name = strchr(name, '\0') + 1) {
 433                 void *old_value;
 434
 435                 /* check if this attribute shall be preserved */
 436                 if (!*name)
 437                         continue;
 438
 439         if (sfd != -1) {
 440             if (fchdir(sfd) == -1) {
 441                 LOG(log_error, logtype_afpd, "sys_ea_copyfile: cant chdir to sfd: %s",
 442                     strerror(errno));
 443                 ret = -1;
 444                 goto getout;
 445             }
 446         }
 447
 448                 size = sys_getxattr (src, name, NULL, 0);
 449                 if (size < 0) {
 450                         ret = -1;
 451                         continue;
 452                 }
 453                 value = realloc(old_value = value, size);
 454                 if (size != 0 && value == NULL) {
 455                         free(old_value);
 456                         ret = -1;
 457                 }
 458                 size = sys_getxattr(src, name, value, size);
 459                 if (size < 0) {
 460                         ret = -1;
 461                         continue;
 462                 }
 463
 464         if (sfd != -1) {
 465             if (fchdir(cwd) == -1) {
 466                 LOG(log_error, logtype_afpd, "sys_ea_copyfile: cant chdir to cwd: %s",
 467                     strerror(errno));
 468                 ret = -1;
 469                 goto getout;
 470             }
 471         }
 472
 473                 if (sys_setxattr(dst, name, value, size, 0) != 0) {
 474                         if (errno == ENOTSUP)
 475                                 setxattr_ENOTSUP++;
 476                         else {
 477                                 if (errno == ENOSYS) {
 478                                         ret = -1;
 479                                         /* no hope of getting any further */
 480                                         break;
 481                                 } else {
 482                                         ret = -1;
 483                                 }
 484                         }
 485                 }
 486         }
 487         if (setxattr_ENOTSUP) {
 488                 errno = ENOTSUP;
 489                 ret = -1;
 490         }
 491
 492 getout:
 493     if (cwd != -1)
 494         close(cwd);
 495
 496         free(value);
 497         free(names);
 498
 499     if (ret == -1) {
 500         switch(errno) {
 501         case ENOENT:
 502             /* no attribute */
 503             break;
 504         case EACCES:
 505             LOG(log_debug, logtype_afpd, "sys_ea_copyfile(%s, %s): error: %s", src, dst, strerror(errno));
 506             return AFPERR_ACCESS;
 507         default:
 508             LOG(log_error, logtype_afpd, "sys_ea_copyfile(%s, %s): error: %s", src, dst, strerror(errno));
 509             return AFPERR_MISC;
 510         }
 511     }
 512
 513     return AFP_OK;
 514 }