Let afs_event() return int.
[paraslash.git] / attribute.c
1 /*
2 * Copyright (C) 1997 Andre Noll <maan@tuebingen.mpg.de>
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 para_printf(&laad->pb, "%s\n", name);
140 return 1;
141 }
142 ret = osl(osl_get_object(table, row, ATTCOL_BITNUM, &bitnum_obj));
143 if (ret < 0) {
144 para_printf(&laad->pb, "%s: %s\n", name, para_strerror(-ret));
145 return ret;
146 }
147 para_printf(&laad->pb, "%u\t%s\n", *(unsigned char*)bitnum_obj.data,
148 name);
149 return 1;
150 }
151
152 static int com_lsatt_callback(int fd, const struct osl_object *query)
153 {
154 int ret;
155 struct lsatt_action_data laad = {
156 .flags = *(unsigned *) query->data,
157 .pb = {
158 .max_size = shm_get_shmmax(),
159 .private_data = &(struct afs_max_size_handler_data) {
160 .fd = fd,
161 .band = SBD_OUTPUT
162 },
163 .max_size_handler = afs_max_size_handler
164 }
165
166 };
167 struct pattern_match_data pmd = {
168 .table = attribute_table,
169 .loop_col_num = ATTCOL_BITNUM,
170 .match_col_num = ATTCOL_NAME,
171 .patterns = {.data = (char *)query->data + sizeof(laad.flags),
172 .size = query->size - sizeof(laad.flags)},
173 .pm_flags = PM_NO_PATTERN_MATCHES_EVERYTHING,
174 .data = &laad,
175 .action = print_attribute
176 };
177 if (laad.flags & LSATT_FLAG_SORT_BY_ID)
178 pmd.loop_col_num = ATTCOL_NAME;
179 if (laad.flags & LSATT_FLAG_REVERSE)
180 pmd.pm_flags |= PM_REVERSE_LOOP;
181 ret = for_each_matching_row(&pmd);
182 if (ret < 0)
183 goto out;
184 if (pmd.num_matches == 0)
185 ret = -E_NO_MATCH;
186 out:
187 flush_and_free_pb(&laad.pb);
188 return ret;
189 }
190
191 int com_lsatt(struct command_context *cc)
192 {
193 unsigned flags = 0;
194 struct osl_object options = {.data = &flags, .size = sizeof(flags)};
195 int i;
196
197 for (i = 1; i < cc->argc; i++) {
198 const char *arg = cc->argv[i];
199 if (arg[0] != '-')
200 break;
201 if (!strcmp(arg, "--")) {
202 i++;
203 break;
204 }
205 if (!strcmp(arg, "-i")) {
206 flags |= LSATT_FLAG_SORT_BY_ID;
207 continue;
208 }
209 if (!strcmp(arg, "-l")) {
210 flags |= LSATT_FLAG_LONG;
211 continue;
212 }
213 if (!strcmp(arg, "-r")) {
214 flags |= LSATT_FLAG_REVERSE;
215 continue;
216 }
217 }
218 return send_option_arg_callback_request(&options, cc->argc - i, cc->argv + i,
219 com_lsatt_callback, afs_cb_result_handler, cc);
220 }
221
222 struct addatt_event_data {
223 const char *name;
224 unsigned char bitnum;
225 };
226
227
228 static int com_addatt_callback(int fd, const struct osl_object *query)
229 {
230 char *p;
231 int ret = 1;
232 struct para_buffer pb = {
233 .max_size = shm_get_shmmax(),
234 .private_data = &(struct afs_max_size_handler_data) {
235 .fd = fd,
236 .band = SBD_OUTPUT
237 },
238 .max_size_handler = afs_max_size_handler
239 };
240 size_t len;
241
242 for (p = query->data; p < (char *)query->data + query->size; p += len + 1) {
243 struct osl_object objs[NUM_ATT_COLUMNS];
244 struct osl_row *row;
245 unsigned char bitnum;
246 struct addatt_event_data aed;
247
248 len = strlen(p);
249 if (!len || p[len - 1] == '-' || p[len - 1] == '+') {
250 para_printf(&pb, "invalid attribute name: %s\n", p);
251 continue;
252 }
253 ret = get_attribute_bitnum_by_name(p, &bitnum);
254 if (ret >= 0) {
255 para_printf(&pb, "attribute \"%s\" already exists\n", p);
256 continue;
257 }
258 if (ret != -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND)) /* error */
259 goto out;
260 objs[ATTCOL_BITNUM].size = 1;
261 /* find smallest unused attribute */
262 for (bitnum = 0; bitnum < 64; bitnum++) {
263 objs[ATTCOL_BITNUM].data = &bitnum;
264 ret = osl(osl_get_row(attribute_table, ATTCOL_BITNUM,
265 &objs[ATTCOL_BITNUM], &row));
266 if (ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
267 break; /* this bitnum is unused, use it */
268 if (ret < 0) /* error */
269 goto out;
270 /* this bit is already in use, try next bit */
271 }
272 if (bitnum == 64) {
273 ret = -E_ATT_TABLE_FULL;
274 goto out;
275 }
276 objs[ATTCOL_NAME].data = p;
277 objs[ATTCOL_NAME].size = len + 1;
278 ret = osl(osl_add_row(attribute_table, objs));
279 if (ret < 0)
280 goto out;
281 aed.name = p;
282 aed.bitnum = bitnum;
283 ret = afs_event(ATTRIBUTE_ADD, &pb, &aed);
284 if (ret < 0)
285 goto out;
286 greatest_att_bitnum = PARA_MAX(greatest_att_bitnum, (int)bitnum);
287 }
288 out:
289 if (ret < 0)
290 para_printf(&pb, "%s: %s\n", p, para_strerror(-ret));
291 flush_and_free_pb(&pb);
292 return 0;
293 }
294
295 int com_addatt(struct command_context *cc)
296 {
297 int ret;
298
299 if (cc->argc < 2)
300 return -E_ATTR_SYNTAX;
301 ret = send_standard_callback_request(cc->argc - 1, cc->argv + 1,
302 com_addatt_callback, afs_cb_result_handler, cc);
303 if (ret < 0)
304 send_strerror(cc, -ret);
305 return ret;
306 }
307
308 static int com_mvatt_callback(int fd, const struct osl_object *query)
309 {
310 char *old = query->data;
311 size_t size = strlen(old) + 1;
312 char *new = old + size;
313 struct osl_object obj = {.data = old, .size = size};
314 struct osl_row *row;
315 struct para_buffer pb = {
316 .max_size = shm_get_shmmax(),
317 .private_data = &(struct afs_max_size_handler_data) {
318 .fd = fd,
319 .band = SBD_OUTPUT
320 },
321 .max_size_handler = afs_max_size_handler,
322 };
323 int ret;
324
325 ret = osl(osl_get_row(attribute_table, ATTCOL_NAME, &obj, &row));
326 if (ret < 0)
327 goto out;
328 obj.data = new;
329 obj.size = strlen(new) + 1;
330 ret = osl(osl_update_object(attribute_table, row, ATTCOL_NAME, &obj));
331 out:
332 if (ret < 0)
333 para_printf(&pb, "cannot rename %s to %s\n", old, new);
334 else
335 ret = afs_event(ATTRIBUTE_RENAME, &pb, NULL);
336 flush_and_free_pb(&pb);
337 return ret;
338 }
339
340 int com_mvatt(struct command_context *cc)
341 {
342 if (cc->argc != 3)
343 return -E_ATTR_SYNTAX;
344 return send_standard_callback_request(cc->argc - 1, cc->argv + 1,
345 com_mvatt_callback, afs_cb_result_handler, cc);
346 }
347
348 static int remove_attribute(struct osl_table *table, struct osl_row *row,
349 const char *name, void *data)
350 {
351 struct para_buffer *pb = data;
352 int ret;
353 struct rmatt_event_data red = {.name = name};
354
355 ret = get_attribute_bitnum_by_name(name, &red.bitnum);
356 if (ret < 0) {
357 para_printf(pb, "cannot remove %s\n", name);
358 return ret;
359 }
360 para_printf(pb, "removing attribute %s\n", name);
361 ret = osl(osl_del_row(table, row));
362 if (ret < 0) {
363 para_printf(pb, "cannot remove %s\n", name);
364 return ret;
365 }
366 return afs_event(ATTRIBUTE_REMOVE, pb, &red);
367 }
368
369 static int com_rmatt_callback(int fd, const struct osl_object *query)
370 {
371 struct para_buffer pb = {
372 .max_size = shm_get_shmmax(),
373 .private_data = &(struct afs_max_size_handler_data) {
374 .fd = fd,
375 .band = SBD_OUTPUT
376 },
377 .max_size_handler = afs_max_size_handler,
378 };
379 int ret;
380 struct pattern_match_data pmd = {
381 .table = attribute_table,
382 .patterns = *query,
383 .loop_col_num = ATTCOL_BITNUM,
384 .match_col_num = ATTCOL_NAME,
385 .data = &pb,
386 .action = remove_attribute
387 };
388 ret = for_each_matching_row(&pmd);
389 if (ret < 0)
390 goto out;
391 if (pmd.num_matches == 0)
392 ret = -E_NO_MATCH;
393 out:
394 flush_and_free_pb(&pb);
395 return ret;
396 }
397
398 int com_rmatt(struct command_context *cc)
399 {
400 if (cc->argc < 2)
401 return -E_ATTR_SYNTAX;
402 return send_standard_callback_request(cc->argc - 1, cc->argv + 1,
403 com_rmatt_callback, afs_cb_result_handler, cc);
404 }
405
406 /**
407 * Return a binary representation of the given attribute value.
408 *
409 * \param atts Pointer to the attribute value.
410 * \param buf Result.
411 *
412 * This function prints a string of at most 64 characters plus the terminating
413 * \p NULL character into \a buf which must be provided by the caller and at
414 * least 65 bytes long. The "x" character is used for set attributes and "-" is
415 * used for unset attributes.
416 *
417 * In practice, not all 64 attributes are defined. In this case, the function
418 * only prints \a N + 1 characters where \a N is the greatest id of a defined
419 * attribute.
420 */
421 void get_attribute_bitmap(const uint64_t *atts, char *buf)
422 {
423 int i;
424 const uint64_t one = 1;
425
426 for (i = 0; i <= greatest_att_bitnum; i++)
427 buf[greatest_att_bitnum - i] = (*atts & (one << i))? 'x' : '-';
428 buf[i] = '\0';
429 }
430
431 /**
432 * Get a string containing the set attributes in text form.
433 *
434 * \param atts The attribute bitmap.
435 * \param delim The delimiter to separate matching attribute names.
436 * \param text Result pointer.
437 *
438 * \return Positive on success, negative on errors. If no attributes have
439 * been defined, \a *text is NULL.
440 */
441 int get_attribute_text(uint64_t *atts, const char *delim, char **text)
442 {
443 int i, ret;
444 const uint64_t one = 1;
445
446 *text = NULL;
447 if (greatest_att_bitnum < 0) { /* no attributes available */
448 *text = para_strdup("(no attributes available)");
449 return 1;
450 }
451 for (i = 0; i <= greatest_att_bitnum; i++) {
452 unsigned char bn = i;
453 struct osl_object obj = {.data = &bn, .size = 1};
454 struct osl_row *row;
455
456 if (!(*atts & (one << i)))
457 continue;
458 ret = osl(osl_get_row(attribute_table, ATTCOL_BITNUM, &obj, &row));
459 if (ret < 0)
460 goto err;
461 ret = osl(osl_get_object(attribute_table, row, ATTCOL_NAME, &obj));
462 if (ret < 0)
463 goto err;
464 if (*text) {
465 char *tmp = make_message("%s%s%s", *text, delim, (char *)obj.data);
466 free(*text);
467 *text = tmp;
468 } else
469 *text = para_strdup(obj.data);
470 }
471 if (!*text) /* no attributes set */
472 *text = para_strdup("");
473 return 1;
474 err:
475 free(*text);
476 return ret;
477 }
478
479 /**
480 * Close the attribute table.
481 *
482 * \sa osl_close_table().
483 */
484 static void attribute_close(void)
485 {
486 osl_close_table(attribute_table, OSL_MARK_CLEAN);
487 attribute_table = NULL;
488 }
489
490 /**
491 * Open the attribute table.
492 *
493 * \param dir The database directory.
494 *
495 * \return Positive on success, negative on errors.
496 *
497 * \sa osl_open_table().
498 */
499 static int attribute_open(const char *dir)
500 {
501 int ret;
502
503 attribute_table_desc.dir = dir;
504 ret = osl(osl_open_table(&attribute_table_desc, &attribute_table));
505 greatest_att_bitnum = -1; /* no atts available */
506 if (ret >= 0) {
507 find_greatest_att_bitnum();
508 return ret;
509 }
510 attribute_table = NULL;
511 if (ret >= 0 || ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_NOENT))
512 return 1;
513 return ret;
514 }
515
516 static int attribute_create(const char *dir)
517 {
518 attribute_table_desc.dir = dir;
519 return osl(osl_create_table(&attribute_table_desc));
520 }
521
522 /**
523 * Initialize the attribute table structure.
524 *
525 * \param t The table structure to initialize.
526 */
527 void attribute_init(struct afs_table *t)
528 {
529 t->open = attribute_open;
530 t->close = attribute_close;
531 t->create = attribute_create;
532 }