2 * Copyright (C) 1997-2009 Andre Noll <maan@systemlinux.org>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file attribute.c Attribute handling functions. */
10 #include <openssl/rc4.h>
22 static struct osl_table *attribute_table;
23 static int greatest_att_bitnum;
25 /** The columns of the attribute table. */
26 enum attribute_table_columns {
27 /** The bit number (0-63). */
29 /** The name of the attribute. */
31 /** Number of columns in this table. */
35 static int char_compare(const struct osl_object *obj1, const struct osl_object *obj2)
37 const unsigned char *c1 = (const unsigned char*)obj1->data;
38 const unsigned char *c2 = (const unsigned char*)obj2->data;
46 static struct osl_column_description att_cols[] = {
48 .storage_type = OSL_MAPPED_STORAGE,
49 .storage_flags = OSL_RBTREE | OSL_FIXED_SIZE | OSL_UNIQUE,
51 .compare_function = char_compare,
55 .storage_type = OSL_MAPPED_STORAGE,
56 .storage_flags = OSL_RBTREE | OSL_UNIQUE,
58 .compare_function = string_compare,
62 static struct osl_table_description attribute_table_desc = {
64 .num_columns = NUM_ATT_COLUMNS,
66 .column_descriptions = att_cols
69 static void find_greatest_att_bitnum(void)
74 struct osl_object obj = {.data = &c, .size = 1};
75 if (osl_get_row(attribute_table, ATTCOL_BITNUM, &obj,
77 greatest_att_bitnum = c;
81 PARA_INFO_LOG("no attributes\n");
82 greatest_att_bitnum = -E_NO_ATTRIBUTES;
86 * Retrieve the identifier (number) of an attribute.
88 * \param att_name The name of the attribute.
89 * \param bitnum Result pointer.
91 * \return Positive on success, negative on errors.
93 int get_attribute_bitnum_by_name(const char *att_name, unsigned char *bitnum)
95 struct osl_object obj = {.data = (char *)att_name,
96 .size = strlen(att_name) + 1};
98 int ret = osl(osl_get_row(attribute_table, ATTCOL_NAME, &obj, &row));
102 ret = osl(osl_get_object(attribute_table, row, ATTCOL_BITNUM, &obj));
105 *bitnum = *(unsigned char *)obj.data;
110 * Flags used by the lsatt command.
112 * \param \sa com_lsatt().
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. */
119 /** Reverse sort order. */
120 LSATT_FLAG_REVERSE = 4
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. */
131 static int print_attribute(struct osl_table *table, struct osl_row *row,
132 const char *name, void *data)
134 struct lsatt_action_data *laad = data;
135 struct osl_object bitnum_obj;
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));
142 para_printf(&laad->pb, "%s: %s\n", name, para_strerror(-ret));
145 return para_printf(&laad->pb, "%u\t%s\n", *(unsigned char*)bitnum_obj.data,
149 static void com_lsatt_callback(int fd, const struct osl_object *query)
151 struct lsatt_action_data laad = {
152 .flags = *(unsigned *) query->data,
156 .max_size_handler = pass_buffer_as_shm
160 struct pattern_match_data pmd = {
161 .table = attribute_table,
162 .loop_col_num = ATTCOL_BITNUM,
163 .match_col_num = ATTCOL_NAME,
164 .patterns = {.data = (char *)query->data + sizeof(laad.flags),
165 .size = query->size - sizeof(laad.flags)},
166 .pm_flags = PM_NO_PATTERN_MATCHES_EVERYTHING,
168 .action = print_attribute
170 if (laad.flags & LSATT_FLAG_SORT_BY_ID)
171 pmd.loop_col_num = ATTCOL_NAME;
172 if (laad.flags & LSATT_FLAG_REVERSE)
173 pmd.pm_flags |= PM_REVERSE_LOOP;
174 for_each_matching_row(&pmd);
176 pass_buffer_as_shm(laad.pb.buf, laad.pb.offset, &fd);
180 int com_lsatt(struct rc4_context *rc4c, int argc, char * const * const argv)
183 struct osl_object options = {.data = &flags, .size = sizeof(flags)};
186 for (i = 1; i < argc; i++) {
187 const char *arg = argv[i];
190 if (!strcmp(arg, "--")) {
194 if (!strcmp(arg, "-i")) {
195 flags |= LSATT_FLAG_SORT_BY_ID;
198 if (!strcmp(arg, "-l")) {
199 flags |= LSATT_FLAG_LONG;
202 if (!strcmp(arg, "-r")) {
203 flags |= LSATT_FLAG_REVERSE;
207 ret = send_option_arg_callback_request(&options, argc - i, argv + i,
208 com_lsatt_callback, rc4_send_result, rc4c);
211 ret = rc4_send_va_buffer(rc4c, "no matches\n");
213 rc4_send_va_buffer(rc4c, "%s\n", para_strerror(-ret));
217 static void com_setatt_callback(__a_unused int fd, const struct osl_object *query)
220 uint64_t add_mask = 0, del_mask = 0;
223 struct osl_object obj;
226 for (p = query->data; p < (char *)query->data + query->size; p += len + 1) {
230 ret = -E_ATTR_SYNTAX;
234 if (c != '+' && c != '-')
239 ret = osl(osl_get_row(attribute_table, ATTCOL_NAME, &obj, &row));
242 ret = osl(osl_get_object(attribute_table, row, ATTCOL_BITNUM,
247 add_mask |= (1UL << *(unsigned char *)obj.data);
249 del_mask |= (1UL << *(unsigned char *)obj.data);
251 ret = -E_ATTR_SYNTAX;
252 if (!add_mask && !del_mask)
254 PARA_DEBUG_LOG("masks: %llx:%llx\n",(long long unsigned)add_mask,
255 (long long unsigned)del_mask);
256 for (; p < (char *)query->data + query->size; p += len + 1) { /* TODO: fnmatch */
257 struct afs_info old_afsi, new_afsi;
258 struct afsi_change_event_data aced = {.old_afsi = &old_afsi};
261 ret = aft_get_row_of_path(p, &aced.aft_row);
264 ret = get_afsi_object_of_row(aced.aft_row, &obj);
267 ret = load_afsi(&old_afsi, &obj);
271 new_afsi.attributes |= add_mask;
272 new_afsi.attributes &= ~del_mask;
273 save_afsi(&new_afsi, &obj); /* in-place update */
274 afs_event(AFSI_CHANGE, NULL, &aced);
278 PARA_NOTICE_LOG("%s\n", para_strerror(-ret));
281 int com_setatt(__a_unused struct rc4_context *rc4c, int argc, char * const * const argv)
284 return -E_ATTR_SYNTAX;
285 return send_standard_callback_request(argc - 1, argv + 1, com_setatt_callback,
289 struct addatt_event_data {
291 unsigned char bitnum;
295 static void com_addatt_callback(int fd, const struct osl_object *query)
298 int ret = 1, ret2 = 0;
299 struct para_buffer pb = {
302 .max_size_handler = pass_buffer_as_shm
306 for (p = query->data; p < (char *)query->data + query->size; p += len + 1) {
307 struct osl_object objs[NUM_ATT_COLUMNS];
309 unsigned char bitnum;
310 struct addatt_event_data aed;
313 if (!len || p[len - 1] == '-' || p[len - 1] == '+') {
314 ret2 = para_printf(&pb, "invalid attribute name: %s\n", p);
319 ret = get_attribute_bitnum_by_name(p, &bitnum);
321 ret2 = para_printf(&pb, "attribute \"%s\" already exists\n", p);
326 if (ret != -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND)) /* error */
328 objs[ATTCOL_BITNUM].size = 1;
329 /* find smallest unused attribute */
330 for (bitnum = 0; bitnum < 64; bitnum++) {
331 objs[ATTCOL_BITNUM].data = &bitnum;
332 ret = osl(osl_get_row(attribute_table, ATTCOL_BITNUM,
333 &objs[ATTCOL_BITNUM], &row));
334 if (ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
335 break; /* this bitnum is unused, use it */
336 if (ret < 0) /* error */
338 /* this bit is already in use, try next bit */
341 ret = -E_ATT_TABLE_FULL;
344 objs[ATTCOL_NAME].data = p;
345 objs[ATTCOL_NAME].size = len + 1;
346 ret = osl(osl_add_row(attribute_table, objs));
351 afs_event(ATTRIBUTE_ADD, &pb, &aed);
352 greatest_att_bitnum = PARA_MAX(greatest_att_bitnum, (int)bitnum);
355 if (ret < 0 && ret2 >= 0)
356 para_printf(&pb, "%s: %s\n", p, para_strerror(-ret));
358 pass_buffer_as_shm(pb.buf, pb.offset, &fd);
362 int com_addatt(struct rc4_context *rc4c, int argc, char * const * const argv)
367 return -E_ATTR_SYNTAX;
368 ret = send_standard_callback_request(argc - 1, argv + 1, com_addatt_callback,
369 rc4_send_result, rc4c);
371 rc4_send_va_buffer(rc4c, "%s\n", para_strerror(-ret));
375 static void com_mvatt_callback(int fd, const struct osl_object *query)
377 char *old = query->data;
378 size_t size = strlen(old) + 1;
379 char *new = old + size;
380 struct osl_object obj = {.data = old, .size = size};
382 struct para_buffer pb = {
385 .max_size_handler = pass_buffer_as_shm
389 ret = osl(osl_get_row(attribute_table, ATTCOL_NAME, &obj, &row));
393 obj.size = strlen(new) + 1;
394 ret = osl(osl_update_object(attribute_table, row, ATTCOL_NAME, &obj));
397 para_printf(&pb, "%s\n", para_strerror(-ret));
399 afs_event(ATTRIBUTE_RENAME, &pb, NULL);
401 pass_buffer_as_shm(pb.buf, pb.offset, &fd);
405 int com_mvatt(struct rc4_context *rc4c, int argc, char * const * const argv)
410 return -E_ATTR_SYNTAX;
411 ret = send_standard_callback_request(argc - 1, argv + 1, com_mvatt_callback,
412 rc4_send_result, rc4c);
414 rc4_send_va_buffer(rc4c, "%s\n", para_strerror(-ret));
418 /** Data passed to the action handler of com_rmatt(). */
419 struct remove_attribute_action_data {
420 /** Message buffer. */
421 struct para_buffer pb;
422 /** Numver of attributes removed. */
424 /** Bitwise "or" of the removed attributes. */
425 uint64_t mask_of_removed_atts;
428 static int remove_attribute(struct osl_table *table, struct osl_row *row,
429 const char *name, void *data)
431 struct remove_attribute_action_data *raad = data;
433 struct rmatt_event_data red = {.name = name};
435 ret = get_attribute_bitnum_by_name(name, &red.bitnum);
437 return para_printf(&raad->pb, "%s: %s\n", name, para_strerror(-ret));
438 ret = osl(osl_del_row(table, row));
440 return para_printf(&raad->pb, "%s: %s\n", name, para_strerror(-ret));
441 ret = para_printf(&raad->pb, "removed attribute %s\n", name);
443 raad->mask_of_removed_atts |= (1 << red.bitnum);
444 afs_event(ATTRIBUTE_REMOVE, &raad->pb, &red);
448 static void com_rmatt_callback(int fd, const struct osl_object *query)
450 struct remove_attribute_action_data raad = {
455 .max_size_handler = pass_buffer_as_shm
459 struct pattern_match_data pmd = {
460 .table = attribute_table,
462 .loop_col_num = ATTCOL_BITNUM,
463 .match_col_num = ATTCOL_NAME,
465 .action = remove_attribute
467 ret = for_each_matching_row(&pmd);
469 ret2 = para_printf(&raad.pb, "%s\n", para_strerror(-ret));
470 else if (!raad.num_removed)
471 ret2 = para_printf(&raad.pb, "no match -- nothing removed\n");
472 if (ret2 >= 0 && raad.pb.offset)
473 pass_buffer_as_shm(raad.pb.buf, raad.pb.offset, &fd);
477 int com_rmatt(struct rc4_context *rc4c, int argc, char * const * const argv)
482 return -E_ATTR_SYNTAX;
483 ret = send_standard_callback_request(argc - 1, argv + 1, com_rmatt_callback,
484 rc4_send_result, rc4c);
486 rc4_send_va_buffer(rc4c, "%s\n", para_strerror(-ret));
491 * Return a binary representation of the given attribute value.
493 * \param atts Pointer to the attribute value.
496 * This function prints a string of at most 64 characters plus the terminating
497 * \p NULL character into \a buf which must be provided by the caller and at
498 * least 65 bytes long. The "x" character is used for set attributes and "-" is
499 * used for unset attributes.
501 * In practice, not all 64 attributes are defined. In this case, the function
502 * only prints \a N + 1 charaters where \a N is the greatest id of a defined
505 void get_attribute_bitmap(const uint64_t *atts, char *buf)
508 const uint64_t one = 1;
510 for (i = 0; i <= greatest_att_bitnum; i++)
511 buf[greatest_att_bitnum - i] = (*atts & (one << i))? 'x' : '-';
516 * Get a string containing the set attributes in text form.
518 * \param atts The attribute bitmap.
519 * \param delim The delimiter to separate matching attribute names.
520 * \param text Result pointer.
522 * \return Positive on success, negative on errors. If no attributes have
523 * been defined, \a *text is NULL.
525 int get_attribute_text(uint64_t *atts, const char *delim, char **text)
528 const uint64_t one = 1;
531 if (greatest_att_bitnum < 0) { /* no attributes available */
532 *text = para_strdup("(no attributes available)");
535 for (i = 0; i <= greatest_att_bitnum; i++) {
536 unsigned char bn = i;
537 struct osl_object obj = {.data = &bn, .size = 1};
540 if (!(*atts & (one << i)))
542 ret = osl(osl_get_row(attribute_table, ATTCOL_BITNUM, &obj, &row));
545 ret = osl(osl_get_object(attribute_table, row, ATTCOL_NAME, &obj));
549 char *tmp = make_message("%s%s%s", *text, delim, (char *)obj.data);
553 *text = para_strdup(obj.data);
555 if (!*text) /* no attributes set */
556 *text = para_strdup("");
564 * Close the attribute table.
566 * \sa osl_close_table().
568 static void attribute_close(void)
570 osl_close_table(attribute_table, OSL_MARK_CLEAN);
571 attribute_table = NULL;
575 * Open the attribute table.
577 * \param dir The database directory.
579 * \return Positive on success, negative on errors.
581 * \sa osl_open_table().
583 static int attribute_open(const char *dir)
587 attribute_table_desc.dir = dir;
588 ret = osl(osl_open_table(&attribute_table_desc, &attribute_table));
589 greatest_att_bitnum = -1; /* no atts available */
591 find_greatest_att_bitnum();
594 attribute_table = NULL;
595 if (ret >= 0 || ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_NOENT))
600 static int attribute_create(const char *dir)
602 attribute_table_desc.dir = dir;
603 return osl(osl_create_table(&attribute_table_desc));
607 * Initialize the attribute table structure.
609 * \param t The table structure to initialize.
611 void attribute_init(struct afs_table *t)
613 t->open = attribute_open;
614 t->close = attribute_close;
615 t->create = attribute_create;