1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* config-parser-trivial.c XML-library-agnostic configuration file parser
3 * Does not do includes or anything remotely complicated.
5 * Copyright (C) 2003, 2004, 2007 Red Hat, Inc.
7 * Licensed under the Academic Free License version 2.1
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
26 #include "config-parser-common.h"
27 #include "config-parser-trivial.h"
29 #include <dbus/dbus-list.h>
30 #include <dbus/dbus-internals.h>
34 * TRIVIAL parser for bus configuration file.
36 struct BusConfigParser
39 DBusString user; /**< User the dbus-daemon runs as */
40 DBusString bus_type; /**< Message bus type */
41 DBusString service_helper; /**< Location of the setuid helper */
42 DBusList *service_dirs; /**< Directories to look for services in */
46 service_dirs_find_dir (DBusList **service_dirs,
51 _dbus_assert (dir != NULL);
53 for (link = *service_dirs; link; link = _dbus_list_get_next_link(service_dirs, link))
57 link_dir = (const char *)link->data;
58 if (strcmp (dir, link_dir) == 0)
66 service_dirs_append_link_unique_or_free (DBusList **service_dirs,
69 if (!service_dirs_find_dir (service_dirs, dir_link->data))
71 _dbus_list_append_link (service_dirs, dir_link);
75 dbus_free (dir_link->data);
76 _dbus_list_free_link (dir_link);
81 bus_config_parser_new (const DBusString *basedir,
82 dbus_bool_t is_toplevel,
83 const BusConfigParser *parent)
85 BusConfigParser *parser;
87 parser = dbus_new0 (BusConfigParser, 1);
91 parser->type = ELEMENT_NONE;
94 parser->service_dirs = NULL;
96 /* init the strings */
97 if (!_dbus_string_init (&parser->user))
99 if (!_dbus_string_init (&parser->bus_type))
101 if (!_dbus_string_init (&parser->service_helper))
107 /* argh. we have do do this carefully because of OOM */
109 _dbus_string_free (&parser->bus_type);
111 _dbus_string_free (&parser->user);
119 bus_config_parser_unref (BusConfigParser *parser)
121 _dbus_string_free (&parser->user);
122 _dbus_string_free (&parser->service_helper);
123 _dbus_string_free (&parser->bus_type);
125 _dbus_list_foreach (&parser->service_dirs,
126 (DBusForeachFunction) dbus_free,
129 _dbus_list_clear (&parser->service_dirs);
135 bus_config_parser_check_doctype (BusConfigParser *parser,
139 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
141 if (strcmp (doctype, "busconfig") != 0)
143 dbus_set_error (error,
145 "Configuration file has the wrong document type %s",
154 bus_config_parser_start_element (BusConfigParser *parser,
155 const char *element_name,
156 const char **attribute_names,
157 const char **attribute_values,
160 /* we don't do processing of attribute names, we don't need to */
161 parser->type = bus_config_parser_element_name_to_type (element_name);
163 switch (parser->type)
165 case ELEMENT_SERVICEDIR:
166 case ELEMENT_SERVICEHELPER:
168 case ELEMENT_CONFIGTYPE:
169 /* content about to be handled */
172 case ELEMENT_STANDARD_SYSTEM_SERVICEDIRS:
178 if (!_dbus_get_standard_system_servicedirs (&dirs))
184 while ((link = _dbus_list_pop_first_link (&dirs)))
185 service_dirs_append_link_unique_or_free (&parser->service_dirs, link);
190 case ELEMENT_BUSCONFIG:
191 case ELEMENT_INCLUDE:
199 case ELEMENT_PIDFILE:
200 case ELEMENT_INCLUDEDIR:
201 case ELEMENT_SELINUX:
202 case ELEMENT_ASSOCIATE:
203 case ELEMENT_STANDARD_SESSION_SERVICEDIRS:
204 case ELEMENT_KEEP_UMASK:
206 case ELEMENT_ALLOW_ANONYMOUS:
207 case ELEMENT_APPARMOR:
211 /* we really don't care about the others... */
212 _dbus_verbose (" START We don't care about '%s' type '%i'\n", element_name, parser->type);
220 bus_config_parser_end_element (BusConfigParser *parser,
221 const char *element_name,
229 bus_config_parser_content (BusConfigParser *parser,
230 const DBusString *content,
233 DBusString content_sane;
238 if (!_dbus_string_init (&content_sane))
243 if (!_dbus_string_copy (content, 0, &content_sane, 0))
249 /* rip out white space */
250 _dbus_string_chop_white (&content_sane);
251 if (_dbus_string_get_length (&content_sane) == 0)
253 /* optimise, there is no content */
258 switch (parser->type)
260 case ELEMENT_SERVICEDIR:
264 /* copy the sane data into a char array */
265 if (!_dbus_string_copy_data(&content_sane, &cpath))
271 /* append the dynamic char string to service dirs */
272 if (!_dbus_list_append (&parser->service_dirs, cpath))
281 case ELEMENT_SERVICEHELPER:
283 if (!_dbus_string_copy (&content_sane, 0, &parser->service_helper, 0))
293 if (!_dbus_string_copy (&content_sane, 0, &parser->user, 0))
301 case ELEMENT_CONFIGTYPE:
303 if (!_dbus_string_copy (&content_sane, 0, &parser->bus_type, 0))
312 case ELEMENT_BUSCONFIG:
313 case ELEMENT_INCLUDE:
321 case ELEMENT_PIDFILE:
322 case ELEMENT_INCLUDEDIR:
323 case ELEMENT_SELINUX:
324 case ELEMENT_ASSOCIATE:
325 case ELEMENT_STANDARD_SESSION_SERVICEDIRS:
326 case ELEMENT_STANDARD_SYSTEM_SERVICEDIRS:
327 case ELEMENT_KEEP_UMASK:
329 case ELEMENT_ALLOW_ANONYMOUS:
330 case ELEMENT_APPARMOR:
334 /* we don't care about the others... really */
335 _dbus_verbose (" CONTENTS We don't care about '%s' type '%i'\n", _dbus_string_get_const_data (&content_sane), parser->type);
344 _dbus_string_free (&content_sane);
350 bus_config_parser_finished (BusConfigParser *parser,
353 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
354 _dbus_verbose ("finished scanning!\n");
359 bus_config_parser_get_user (BusConfigParser *parser)
361 return _dbus_string_get_const_data (&parser->user);
365 bus_config_parser_get_type (BusConfigParser *parser)
367 return _dbus_string_get_const_data (&parser->bus_type);
371 * @returns A list of strings, owned by the BusConfigParser
374 bus_config_parser_get_service_paths (BusConfigParser *parser)
376 return &parser->service_dirs;
379 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
391 check_return_values (const DBusString *full_path)
393 BusConfigParser *parser;
400 dbus_error_init (&error);
403 printf ("Testing values from: %s\n", _dbus_string_get_const_data (full_path));
405 parser = bus_config_load (full_path, TRUE, NULL, &error);
408 _DBUS_ASSERT_ERROR_IS_SET (&error);
409 if (dbus_error_has_name (&error, DBUS_ERROR_NO_MEMORY))
410 _dbus_verbose ("Failed to load valid file due to OOM\n");
413 _DBUS_ASSERT_ERROR_IS_CLEAR (&error);
415 /* check user return value is okay */
416 user = bus_config_parser_get_user (parser);
419 _dbus_warn ("User was NULL!");
423 /* the username can be configured in configure.in so this test doesn't work */
424 if (strcmp (user, "dbus") != 0)
426 _dbus_warn ("User was invalid; '%s'!", user);
429 printf (" <user>dbus</user> OKAY!\n");
432 /* check type return value is okay */
433 type = bus_config_parser_get_type (parser);
436 _dbus_warn ("Type was NULL!");
439 if (strcmp (type, "system") != 0)
441 _dbus_warn ("Type was invalid; '%s'!", user);
444 printf (" <type>system</type> OKAY!\n");
446 /* check dirs return value is okay */
447 dirs = bus_config_parser_get_service_paths (parser);
450 _dbus_warn ("Service dirs are NULL!");
453 printf (" <standard_system_service_dirs/> OKAY!\n");
454 /* NOTE: We tested the specific return values in the config-parser tests */
460 bus_config_parser_unref (parser);
461 dbus_error_free (&error);
466 do_load (const DBusString *full_path,
468 dbus_bool_t oom_possible)
470 BusConfigParser *parser;
473 dbus_error_init (&error);
475 parser = bus_config_load (full_path, TRUE, NULL, &error);
478 _DBUS_ASSERT_ERROR_IS_SET (&error);
481 dbus_error_has_name (&error, DBUS_ERROR_NO_MEMORY))
483 _dbus_verbose ("Failed to load valid file due to OOM\n");
484 dbus_error_free (&error);
487 else if (validity == VALID)
489 _dbus_warn ("Failed to load valid file but still had memory: %s",
492 dbus_error_free (&error);
497 dbus_error_free (&error);
503 _DBUS_ASSERT_ERROR_IS_CLEAR (&error);
505 bus_config_parser_unref (parser);
507 if (validity == INVALID)
509 _dbus_warn ("Accepted invalid file");
519 const DBusString *full_path;
524 check_loader_oom_func (void *data)
526 LoaderOomData *d = data;
528 return do_load (d->full_path, d->validity, TRUE);
532 process_test_valid_subdir (const DBusString *test_base_dir,
536 DBusString test_directory;
545 if (!_dbus_string_init (&test_directory))
546 _dbus_assert_not_reached ("didn't allocate test_directory");
548 _dbus_string_init_const (&filename, subdir);
550 if (!_dbus_string_copy (test_base_dir, 0,
552 _dbus_assert_not_reached ("couldn't copy test_base_dir to test_directory");
554 if (!_dbus_concat_dir_and_file (&test_directory, &filename))
555 _dbus_assert_not_reached ("couldn't allocate full path");
557 _dbus_string_free (&filename);
558 if (!_dbus_string_init (&filename))
559 _dbus_assert_not_reached ("didn't allocate filename string");
561 dbus_error_init (&error);
562 dir = _dbus_directory_open (&test_directory, &error);
565 _dbus_warn ("Could not open %s: %s",
566 _dbus_string_get_const_data (&test_directory),
568 dbus_error_free (&error);
572 if (validity == VALID)
573 printf ("Testing valid files:\n");
574 else if (validity == INVALID)
575 printf ("Testing invalid files:\n");
577 printf ("Testing unknown files:\n");
580 while (_dbus_directory_get_next_file (dir, &filename, &error))
582 DBusString full_path;
585 if (!_dbus_string_init (&full_path))
586 _dbus_assert_not_reached ("couldn't init string");
588 if (!_dbus_string_copy (&test_directory, 0, &full_path, 0))
589 _dbus_assert_not_reached ("couldn't copy dir to full_path");
591 if (!_dbus_concat_dir_and_file (&full_path, &filename))
592 _dbus_assert_not_reached ("couldn't concat file to dir");
594 if (!_dbus_string_ends_with_c_str (&full_path, ".conf"))
596 _dbus_verbose ("Skipping non-.conf file %s\n",
597 _dbus_string_get_const_data (&filename));
598 _dbus_string_free (&full_path);
602 printf (" %s\n", _dbus_string_get_const_data (&filename));
604 _dbus_verbose (" expecting %s\n",
605 validity == VALID ? "valid" :
606 (validity == INVALID ? "invalid" :
607 (validity == UNKNOWN ? "unknown" : "???")));
609 d.full_path = &full_path;
610 d.validity = validity;
612 /* FIXME hackaround for an expat problem, see
613 * https://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=124747
614 * http://freedesktop.org/pipermail/dbus/2004-May/001153.html
616 /* if (!_dbus_test_oom_handling ("config-loader", check_loader_oom_func, &d)) */
617 if (!check_loader_oom_func (&d))
618 _dbus_assert_not_reached ("test failed");
620 _dbus_string_free (&full_path);
623 if (dbus_error_is_set (&error))
625 _dbus_warn ("Could not get next file in %s: %s",
626 _dbus_string_get_const_data (&test_directory),
628 dbus_error_free (&error);
637 _dbus_directory_close (dir);
638 _dbus_string_free (&test_directory);
639 _dbus_string_free (&filename);
644 /* convenience function, do not reuse outside of TEST */
646 make_full_path (const DBusString *test_data_dir,
649 DBusString *full_path)
656 if (!_dbus_string_init (full_path))
658 _dbus_warn ("couldn't allocate full path");
662 if (!_dbus_string_copy (test_data_dir, 0, full_path, 0))
664 _dbus_warn ("couldn't allocate full path");
668 _dbus_string_init_const (&filename, subdir);
669 if (!_dbus_concat_dir_and_file (full_path, &filename))
671 _dbus_warn ("couldn't allocate full path");
674 _dbus_string_free (&filename);
676 _dbus_string_init_const (&filename, file);
677 if (!_dbus_concat_dir_and_file (full_path, &filename))
679 _dbus_warn ("couldn't allocate full path");
687 _dbus_string_free (&filename);
692 check_file_valid (DBusString *full_path,
697 if (validity == VALID)
698 printf ("Testing valid file:\n");
699 else if (validity == INVALID)
700 printf ("Testing invalid file:\n");
702 printf ("Testing unknown file:\n");
704 /* print the filename, just so we match the other output */
705 printf (" %s\n", _dbus_string_get_const_data (full_path));
707 /* only test one file */
708 retval = do_load (full_path, validity, TRUE);
714 bus_config_parser_trivial_test (const DBusString *test_data_dir)
716 DBusString full_path;
721 if (test_data_dir == NULL ||
722 _dbus_string_get_length (test_data_dir) == 0)
724 printf ("No test data\n");
728 /* We already test default_session_servicedirs and default_system_servicedirs
729 * in bus_config_parser_test() */
730 if (!process_test_valid_subdir (test_data_dir, "valid-config-files", VALID))
734 /* We already test default_session_servicedirs and default_system_servicedirs
735 * in bus_config_parser_test() */
736 if (!process_test_valid_subdir (test_data_dir, "valid-config-files-system", VALID))
740 /* we don't process all the invalid files, as the trivial parser can't hope
741 * to validate them all for all different syntaxes. We just check one broken
742 * file to see if junk is received */
743 if (!make_full_path (test_data_dir, "invalid-config-files", "not-well-formed.conf", &full_path))
745 if (!check_file_valid (&full_path, INVALID))
747 _dbus_string_free (&full_path);
750 /* just test if the check_file_valid works okay and we got sane values */
751 if (!make_full_path (test_data_dir, "valid-config-files-system", "system.conf", &full_path))
753 if (!check_file_valid (&full_path, VALID))
755 /* check to see if we got the correct values from the parser */
756 if (!check_return_values (&full_path))
764 _dbus_string_free (&full_path);
766 /* we don't process equiv-config-files as we don't handle <include> */
770 #endif /* DBUS_ENABLE_EMBEDDED_TESTS */