attribute.c

   1 /*
   2  * Copyright (C) 1997-2013 Andre Noll <maan@systemlinux.org>
   3  *
   4  * Licensed under the GPL v2. For licencing details see COPYING.
   5  */
   6
   7 /** \file attribute.c Attribute handling functions. */
   8
   9 #include <regex.h>
  10 #include <osl.h>
  11
  12 #include "para.h"
  13 #include "error.h"
  14 #include "crypt.h"
  15 #include "string.h"
  16 #include "afh.h"
  17 #include "afs.h"
  18 #include "ipc.h"
  19 #include "sideband.h"
  20 #include "command.h"
  21
  22 static struct osl_table *attribute_table;
  23 static int greatest_att_bitnum;
  24
  25 /** The columns of the attribute table. */
  26 enum attribute_table_columns {
  27         /** The bit number (0-63). */
  28         ATTCOL_BITNUM,
  29         /** The name of the attribute. */
  30         ATTCOL_NAME,
  31         /** Number of columns in this table. */
  32         NUM_ATT_COLUMNS
  33 };
  34
  35 static int char_compare(const struct osl_object *obj1, const struct osl_object *obj2)
  36 {
  37         const unsigned char *c1 = (const unsigned char*)obj1->data;
  38         const unsigned char *c2 = (const unsigned char*)obj2->data;
  39         if (*c1 > *c2)
  40                 return 1;
  41         if (*c1 < *c2)
  42                 return -1;
  43         return 0;
  44 }
  45
  46 static struct osl_column_description att_cols[] = {
  47         [ATTCOL_BITNUM] = {
  48                 .storage_type = OSL_MAPPED_STORAGE,
  49                 .storage_flags = OSL_RBTREE | OSL_FIXED_SIZE | OSL_UNIQUE,
  50                 .name = "bitnum",
  51                 .compare_function = char_compare,
  52                 .data_size = 1
  53         },
  54         [ATTCOL_NAME] = {
  55                 .storage_type = OSL_MAPPED_STORAGE,
  56                 .storage_flags = OSL_RBTREE | OSL_UNIQUE,
  57                 .name = "name",
  58                 .compare_function = string_compare,
  59         }
  60 };
  61
  62 static struct osl_table_description attribute_table_desc = {
  63         .name = "attributes",
  64         .num_columns = NUM_ATT_COLUMNS,
  65         .flags = 0,
  66         .column_descriptions = att_cols
  67 };
  68
  69 static void find_greatest_att_bitnum(void)
  70 {
  71         unsigned char c = 63;
  72         do {
  73                 struct osl_row *row;
  74                 struct osl_object obj = {.data = &c, .size = 1};
  75                 if (osl_get_row(attribute_table, ATTCOL_BITNUM, &obj,
  76                                 &row) >= 0) {
  77                         greatest_att_bitnum = c;
  78                         return;
  79                 }
  80         } while (c--);
  81         PARA_INFO_LOG("no attributes\n");
  82         greatest_att_bitnum = -E_NO_ATTRIBUTES;
  83 }
  84
  85 /**
  86  * Retrieve the identifier (number) of an attribute.
  87  *
  88  * \param att_name The name of the attribute.
  89  * \param bitnum Result pointer.
  90  *
  91  * \return Positive on success, negative on errors.
  92  */
  93 int get_attribute_bitnum_by_name(const char *att_name, unsigned char *bitnum)
  94 {
  95         struct osl_object obj = {.data = (char *)att_name,
  96                 .size = strlen(att_name) + 1};
  97         struct osl_row *row;
  98         int ret = osl(osl_get_row(attribute_table, ATTCOL_NAME, &obj, &row));
  99
 100         if (ret < 0)
 101                 return ret;
 102         ret = osl(osl_get_object(attribute_table, row, ATTCOL_BITNUM, &obj));
 103         if (ret < 0)
 104                 return ret;
 105         *bitnum = *(unsigned char *)obj.data;
 106         return 1;
 107 }
 108
 109 /**
 110  * Flags used by the lsatt command.
 111  *
 112  * \param \sa com_lsatt().
 113  */
 114 enum lsatt_flags {
 115         /** Whether "-a" was given for the lsatt command. */
 116         LSATT_FLAG_SORT_BY_ID = 1,
 117         /** Whether "-l" was given for the lsatt command. */
 118         LSATT_FLAG_LONG = 2,
 119         /** Reverse sort order. */
 120         LSATT_FLAG_REVERSE = 4
 121 };
 122
 123 /** Data passed to the action function of lsatt */
 124 struct lsatt_action_data {
 125         /** The result buffer. */
 126         struct para_buffer pb;
 127         /** The given flags for the lsatt command. */
 128         unsigned flags;
 129 };
 130
 131 static int print_attribute(struct osl_table *table, struct osl_row *row,
 132                 const char *name, void *data)
 133 {
 134         struct lsatt_action_data *laad = data;
 135         struct osl_object bitnum_obj;
 136         int ret;
 137
 138         if (!(laad->flags & LSATT_FLAG_LONG))
 139                 return para_printf(&laad->pb, "%s\n", name);
 140         ret = osl(osl_get_object(table, row, ATTCOL_BITNUM, &bitnum_obj));
 141         if (ret < 0) {
 142                 para_printf(&laad->pb, "%s: %s\n", name, para_strerror(-ret));
 143                 return ret;
 144         }
 145         return para_printf(&laad->pb, "%u\t%s\n", *(unsigned char*)bitnum_obj.data,
 146                 name);
 147 }
 148
 149 static void com_lsatt_callback(int fd, const struct osl_object *query)
 150 {
 151         struct lsatt_action_data laad = {
 152                 .flags = *(unsigned *) query->data,
 153                 .pb = {
 154                         .max_size = shm_get_shmmax(),
 155                         .private_data = &(struct afs_max_size_handler_data) {
 156                                 .fd = fd,
 157                                 .band = SBD_OUTPUT
 158                         },
 159                         .max_size_handler = afs_max_size_handler
 160                 }
 161
 162         };
 163         struct pattern_match_data pmd = {
 164                 .table = attribute_table,
 165                 .loop_col_num = ATTCOL_BITNUM,
 166                 .match_col_num = ATTCOL_NAME,
 167                 .patterns = {.data = (char *)query->data + sizeof(laad.flags),
 168                         .size = query->size - sizeof(laad.flags)},
 169                 .pm_flags = PM_NO_PATTERN_MATCHES_EVERYTHING,
 170                 .data = &laad,
 171                 .action = print_attribute
 172         };
 173         if (laad.flags & LSATT_FLAG_SORT_BY_ID)
 174                 pmd.loop_col_num = ATTCOL_NAME;
 175         if (laad.flags & LSATT_FLAG_REVERSE)
 176                 pmd.pm_flags |= PM_REVERSE_LOOP;
 177         for_each_matching_row(&pmd);
 178         if (laad.pb.offset)
 179                 pass_buffer_as_shm(fd, SBD_OUTPUT, laad.pb.buf, laad.pb.offset);
 180         free(laad.pb.buf);
 181 }
 182
 183 int com_lsatt(struct command_context *cc)
 184 {
 185         unsigned flags = 0;
 186         struct osl_object options = {.data = &flags, .size = sizeof(flags)};
 187         int ret, i;
 188
 189         for (i = 1; i < cc->argc; i++) {
 190                 const char *arg = cc->argv[i];
 191                 if (arg[0] != '-')
 192                         break;
 193                 if (!strcmp(arg, "--")) {
 194                         i++;
 195                         break;
 196                 }
 197                 if (!strcmp(arg, "-i")) {
 198                         flags |= LSATT_FLAG_SORT_BY_ID;
 199                         continue;
 200                 }
 201                 if (!strcmp(arg, "-l")) {
 202                         flags |= LSATT_FLAG_LONG;
 203                         continue;
 204                 }
 205                 if (!strcmp(arg, "-r")) {
 206                         flags |= LSATT_FLAG_REVERSE;
 207                         continue;
 208                 }
 209         }
 210         ret = send_option_arg_callback_request(&options, cc->argc - i, cc->argv + i,
 211                 com_lsatt_callback, afs_cb_result_handler, cc);
 212         if (ret < 0)
 213                 send_strerror(cc, -ret);
 214         else if (ret == 0 && cc->argc > 1)
 215                 ret = cc->use_sideband?
 216                         send_sb_va(&cc->scc, SBD_ERROR_LOG, "no matches\n")
 217                 :
 218                         sc_send_va_buffer(&cc->scc, "no matches\n");
 219         return ret;
 220 }
 221
 222 static void com_setatt_callback(__a_unused int fd, const struct osl_object *query)
 223 {
 224         char *p;
 225         uint64_t add_mask = 0, del_mask = 0;
 226         int ret;
 227         size_t len;
 228         struct osl_object obj;
 229
 230         for (p = query->data; p < (char *)query->data + query->size; p += len + 1) {
 231                 char c;
 232                 unsigned char bitnum;
 233
 234                 len = strlen(p);
 235                 ret = -E_ATTR_SYNTAX;
 236                 if (!*p)
 237                         goto out;
 238                 c = p[len - 1];
 239                 if (c != '+' && c != '-')
 240                         break;
 241                 p[len - 1] = '\0';
 242                 ret = get_attribute_bitnum_by_name(p, &bitnum);
 243                 if (ret < 0)
 244                         goto out;
 245                 if (c == '+')
 246                         add_mask |= (1UL << bitnum);
 247                 else
 248                         del_mask |= (1UL << bitnum);
 249         }
 250         ret = -E_ATTR_SYNTAX;
 251         if (!add_mask && !del_mask)
 252                 goto out;
 253         PARA_DEBUG_LOG("masks: %llx:%llx\n",(long long unsigned)add_mask,
 254                 (long long unsigned)del_mask);
 255         for (; p < (char *)query->data + query->size; p += len + 1) { /* TODO: fnmatch */
 256                 struct afs_info old_afsi, new_afsi;
 257                 struct afsi_change_event_data aced = {.old_afsi = &old_afsi};
 258
 259                 len = strlen(p);
 260                 ret = aft_get_row_of_path(p, &aced.aft_row);
 261                 if (ret < 0)
 262                         goto out;
 263                 ret = get_afsi_object_of_row(aced.aft_row, &obj);
 264                 if (ret < 0)
 265                         goto out;
 266                 ret = load_afsi(&old_afsi, &obj);
 267                 if (ret < 0)
 268                         goto out;
 269                 new_afsi = old_afsi;
 270                 new_afsi.attributes |= add_mask;
 271                 new_afsi.attributes &= ~del_mask;
 272                 save_afsi(&new_afsi, &obj); /* in-place update */
 273                 afs_event(AFSI_CHANGE, NULL, &aced);
 274         }
 275 out:
 276         if (ret < 0)
 277                 PARA_NOTICE_LOG("%s\n", para_strerror(-ret));
 278 }
 279
 280 int com_setatt(struct command_context *cc)
 281 {
 282         if (cc->argc < 3)
 283                 return -E_ATTR_SYNTAX;
 284         return send_standard_callback_request(cc->argc - 1, cc->argv + 1,
 285                 com_setatt_callback, NULL, NULL);
 286 }
 287
 288 struct addatt_event_data {
 289         const char *name;
 290         unsigned char bitnum;
 291 };
 292
 293
 294 static void com_addatt_callback(int fd, const struct osl_object *query)
 295 {
 296         char *p;
 297         int ret = 1, ret2 = 0;
 298         struct para_buffer pb = {
 299                 .max_size = shm_get_shmmax(),
 300                 .private_data = &(struct afs_max_size_handler_data) {
 301                         .fd = fd,
 302                         .band = SBD_OUTPUT
 303                 },
 304                 .max_size_handler = afs_max_size_handler
 305         };
 306         size_t len;
 307
 308         for (p = query->data; p < (char *)query->data + query->size; p += len + 1) {
 309                 struct osl_object objs[NUM_ATT_COLUMNS];
 310                 struct osl_row *row;
 311                 unsigned char bitnum;
 312                 struct addatt_event_data aed;
 313
 314                 len = strlen(p);
 315                 if (!len || p[len - 1] == '-' || p[len - 1] == '+') {
 316                         ret2 = para_printf(&pb, "invalid attribute name: %s\n", p);
 317                         if (ret2 < 0)
 318                                 goto out;
 319                         continue;
 320                 }
 321                 ret = get_attribute_bitnum_by_name(p, &bitnum);
 322                 if (ret >= 0) {
 323                         ret2 = para_printf(&pb, "attribute \"%s\" already exists\n", p);
 324                         if (ret2 < 0)
 325                                 goto out;
 326                         continue;
 327                 }
 328                 if (ret != -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND)) /* error */
 329                         goto out;
 330                 objs[ATTCOL_BITNUM].size = 1;
 331                 /* find smallest unused attribute */
 332                 for (bitnum = 0; bitnum < 64; bitnum++) {
 333                         objs[ATTCOL_BITNUM].data = &bitnum;
 334                         ret = osl(osl_get_row(attribute_table, ATTCOL_BITNUM,
 335                                 &objs[ATTCOL_BITNUM], &row));
 336                         if (ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
 337                                 break; /* this bitnum is unused, use it */
 338                         if (ret < 0) /* error */
 339                                 goto out;
 340                         /* this bit is already in use, try next bit */
 341                 }
 342                 if (bitnum == 64) {
 343                         ret = -E_ATT_TABLE_FULL;
 344                         goto out;
 345                 }
 346                 objs[ATTCOL_NAME].data = p;
 347                 objs[ATTCOL_NAME].size = len + 1;
 348                 ret = osl(osl_add_row(attribute_table, objs));
 349                 if (ret < 0)
 350                         goto out;
 351                 aed.name = p;
 352                 aed.bitnum = bitnum;
 353                 afs_event(ATTRIBUTE_ADD, &pb, &aed);
 354                 greatest_att_bitnum = PARA_MAX(greatest_att_bitnum, (int)bitnum);
 355         }
 356 out:
 357         if (ret < 0 && ret2 >= 0)
 358                 para_printf(&pb, "%s: %s\n", p, para_strerror(-ret));
 359         if (pb.offset)
 360                 pass_buffer_as_shm(fd, SBD_OUTPUT, pb.buf, pb.offset);
 361         free(pb.buf);
 362 }
 363
 364 int com_addatt(struct command_context *cc)
 365 {
 366         int ret;
 367
 368         if (cc->argc < 2)
 369                 return -E_ATTR_SYNTAX;
 370         ret = send_standard_callback_request(cc->argc - 1, cc->argv + 1,
 371                 com_addatt_callback, afs_cb_result_handler, cc);
 372         if (ret < 0)
 373                 send_strerror(cc, -ret);
 374         return ret;
 375 }
 376
 377 static void com_mvatt_callback(int fd, const struct osl_object *query)
 378 {
 379         char *old = query->data;
 380         size_t size = strlen(old) + 1;
 381         char *new = old + size;
 382         struct osl_object obj = {.data = old, .size = size};
 383         struct osl_row *row;
 384         struct para_buffer pb = {
 385                 .max_size = shm_get_shmmax(),
 386                 .private_data = &(struct afs_max_size_handler_data) {
 387                         .fd = fd,
 388                         .band = SBD_OUTPUT
 389                 },
 390                 .max_size_handler = afs_max_size_handler,
 391         };
 392         int ret;
 393
 394         ret = osl(osl_get_row(attribute_table, ATTCOL_NAME, &obj, &row));
 395         if (ret < 0)
 396                 goto out;
 397         obj.data = new;
 398         obj.size = strlen(new) + 1;
 399         ret = osl(osl_update_object(attribute_table, row, ATTCOL_NAME, &obj));
 400 out:
 401         if (ret < 0)
 402                 para_printf(&pb, "%s\n", para_strerror(-ret));
 403         else
 404                 afs_event(ATTRIBUTE_RENAME, &pb, NULL);
 405         if (pb.offset)
 406                 pass_buffer_as_shm(fd, SBD_OUTPUT, pb.buf, pb.offset);
 407         free(pb.buf);
 408 }
 409
 410 int com_mvatt(struct command_context *cc)
 411 {
 412         int ret;
 413
 414         if (cc->argc != 3)
 415                 return -E_ATTR_SYNTAX;
 416         ret = send_standard_callback_request(cc->argc - 1, cc->argv + 1,
 417                 com_mvatt_callback, afs_cb_result_handler, cc);
 418         if (ret < 0)
 419                 send_strerror(cc, -ret);
 420         return ret;
 421 }
 422
 423 /** Data passed to the action handler of com_rmatt(). */
 424 struct remove_attribute_action_data {
 425         /** Message buffer. */
 426         struct para_buffer pb;
 427         /** Numver of attributes removed. */
 428         int num_removed;
 429         /** Bitwise "or" of the removed attributes. */
 430         uint64_t mask_of_removed_atts;
 431 };
 432
 433 static int remove_attribute(struct osl_table *table, struct osl_row *row,
 434                 const char *name, void *data)
 435 {
 436         struct remove_attribute_action_data *raad = data;
 437         int ret;
 438         struct rmatt_event_data red = {.name = name};
 439
 440         ret = get_attribute_bitnum_by_name(name, &red.bitnum);
 441         if (ret < 0)
 442                 return para_printf(&raad->pb, "%s: %s\n", name, para_strerror(-ret));
 443         ret = osl(osl_del_row(table, row));
 444         if (ret < 0)
 445                 return para_printf(&raad->pb, "%s: %s\n", name, para_strerror(-ret));
 446         ret = para_printf(&raad->pb, "removed attribute %s\n", name);
 447         raad->num_removed++;
 448         raad->mask_of_removed_atts |= (1 << red.bitnum);
 449         afs_event(ATTRIBUTE_REMOVE, &raad->pb, &red);
 450         return ret;
 451 }
 452
 453 static void com_rmatt_callback(int fd, const struct osl_object *query)
 454 {
 455         struct remove_attribute_action_data raad = {
 456                 .num_removed = 0,
 457                 .pb = {
 458                         .max_size = shm_get_shmmax(),
 459                         .private_data = &(struct afs_max_size_handler_data) {
 460                                 .fd = fd,
 461                                 .band = SBD_OUTPUT
 462                         },
 463                         .max_size_handler = afs_max_size_handler,
 464                 }
 465         };
 466         int ret, ret2 = 0;
 467         struct pattern_match_data pmd = {
 468                 .table = attribute_table,
 469                 .patterns = *query,
 470                 .loop_col_num = ATTCOL_BITNUM,
 471                 .match_col_num = ATTCOL_NAME,
 472                 .data = &raad,
 473                 .action = remove_attribute
 474         };
 475         ret = for_each_matching_row(&pmd);
 476         if (ret < 0)
 477                 ret2 = para_printf(&raad.pb, "%s\n", para_strerror(-ret));
 478         else if (!raad.num_removed)
 479                 ret2 = para_printf(&raad.pb, "no match -- nothing removed\n");
 480         if (ret2 >= 0 && raad.pb.offset)
 481                 pass_buffer_as_shm(fd, SBD_OUTPUT, raad.pb.buf, raad.pb.offset);
 482         free(raad.pb.buf);
 483 }
 484
 485 int com_rmatt(struct command_context *cc)
 486 {
 487         int ret;
 488
 489         if (cc->argc < 2)
 490                 return -E_ATTR_SYNTAX;
 491         ret = send_standard_callback_request(cc->argc - 1, cc->argv + 1,
 492                 com_rmatt_callback, afs_cb_result_handler, cc);
 493         if (ret < 0)
 494                 send_strerror(cc, -ret);
 495         return ret;
 496 }
 497
 498 /**
 499  * Return a binary representation of the given attribute value.
 500  *
 501  * \param atts Pointer to the attribute value.
 502  * \param buf Result.
 503  *
 504  * This function prints a string of at most 64 characters plus the terminating
 505  * \p NULL character into \a buf which must be provided by the caller and at
 506  * least 65 bytes long. The "x" character is used for set attributes and "-" is
 507  * used for unset attributes.
 508  *
 509  * In practice, not all 64 attributes are defined. In this case, the function
 510  * only prints \a N + 1 charaters where \a N is the greatest id of a defined
 511  * attribute.
 512  */
 513 void get_attribute_bitmap(const uint64_t *atts, char *buf)
 514 {
 515         int i;
 516         const uint64_t one = 1;
 517
 518         for (i = 0; i <= greatest_att_bitnum; i++)
 519                 buf[greatest_att_bitnum - i] = (*atts & (one << i))? 'x' : '-';
 520         buf[i] = '\0';
 521 }
 522
 523 /**
 524  * Get a string containing the set attributes in text form.
 525  *
 526  * \param atts The attribute bitmap.
 527  * \param delim The delimiter to separate matching attribute names.
 528  * \param text Result pointer.
 529  *
 530  * \return Positive on success, negative on errors. If no attributes have
 531  * been defined, \a *text is NULL.
 532  */
 533 int get_attribute_text(uint64_t *atts, const char *delim, char **text)
 534 {
 535         int i, ret;
 536         const uint64_t one = 1;
 537
 538         *text = NULL;
 539         if (greatest_att_bitnum < 0) { /* no attributes available */
 540                 *text = para_strdup("(no attributes available)");
 541                 return 1;
 542         }
 543         for (i = 0; i <= greatest_att_bitnum; i++) {
 544                 unsigned char bn = i;
 545                 struct osl_object obj = {.data = &bn, .size = 1};
 546                 struct osl_row *row;
 547
 548                 if (!(*atts & (one << i)))
 549                         continue;
 550                 ret = osl(osl_get_row(attribute_table, ATTCOL_BITNUM, &obj, &row));
 551                 if (ret < 0)
 552                         goto err;
 553                 ret = osl(osl_get_object(attribute_table, row, ATTCOL_NAME, &obj));
 554                 if (ret < 0)
 555                         goto err;
 556                 if (*text) {
 557                         char *tmp = make_message("%s%s%s", *text, delim, (char *)obj.data);
 558                         free(*text);
 559                         *text = tmp;
 560                 } else
 561                         *text = para_strdup(obj.data);
 562         }
 563         if (!*text) /* no attributes set */
 564                 *text = para_strdup("");
 565         return 1;
 566 err:
 567         free(*text);
 568         return ret;
 569 }
 570
 571 /**
 572  * Close the attribute table.
 573  *
 574  * \sa osl_close_table().
 575  */
 576 static void attribute_close(void)
 577 {
 578         osl_close_table(attribute_table, OSL_MARK_CLEAN);
 579         attribute_table = NULL;
 580 }
 581
 582 /**
 583  * Open the attribute table.
 584  *
 585  * \param dir The database directory.
 586  *
 587  * \return Positive on success, negative on errors.
 588  *
 589  * \sa osl_open_table().
 590  */
 591 static int attribute_open(const char *dir)
 592 {
 593         int ret;
 594
 595         attribute_table_desc.dir = dir;
 596         ret = osl(osl_open_table(&attribute_table_desc, &attribute_table));
 597         greatest_att_bitnum = -1; /* no atts available */
 598         if (ret >= 0) {
 599                 find_greatest_att_bitnum();
 600                 return ret;
 601         }
 602         attribute_table = NULL;
 603         if (ret >= 0 || ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_NOENT))
 604                 return 1;
 605         return ret;
 606 }
 607
 608 static int attribute_create(const char *dir)
 609 {
 610         attribute_table_desc.dir = dir;
 611         return osl(osl_create_table(&attribute_table_desc));
 612 }
 613
 614 /**
 615  * Initialize the attribute table structure.
 616  *
 617  * \param t The table structure to initialize.
 618  */
 619 void attribute_init(struct afs_table *t)
 620 {
 621         t->open = attribute_open;
 622         t->close = attribute_close;
 623         t->create = attribute_create;
 624 }