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