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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 #include "config-parser-common.h"
26 #include "config-parser-trivial.h"
28 #include <dbus/dbus-list.h>
29 #include <dbus/dbus-internals.h>
33 * TRIVIAL parser for bus configuration file.
35 struct BusConfigParser
38 DBusString user; /**< User the dbus-daemon runs as */
39 DBusString bus_type; /**< Message bus type */
40 DBusString service_helper; /**< Location of the setuid helper */
41 DBusList *service_dirs; /**< Directories to look for services in */
45 service_dirs_find_dir (DBusList **service_dirs,
50 _dbus_assert (dir != NULL);
52 for (link = *service_dirs; link; link = _dbus_list_get_next_link(service_dirs, link))
56 link_dir = (const char *)link->data;
57 if (strcmp (dir, link_dir) == 0)
65 service_dirs_append_link_unique_or_free (DBusList **service_dirs,
68 if (!service_dirs_find_dir (service_dirs, dir_link->data))
70 _dbus_list_append_link (service_dirs, dir_link);
74 dbus_free (dir_link->data);
75 _dbus_list_free_link (dir_link);
80 bus_config_parser_new (const DBusString *basedir,
81 dbus_bool_t is_toplevel,
82 const BusConfigParser *parent)
84 BusConfigParser *parser;
86 parser = dbus_new0 (BusConfigParser, 1);
90 parser->type = ELEMENT_NONE;
93 parser->service_dirs = NULL;
95 /* init the strings */
96 if (!_dbus_string_init (&parser->user))
98 if (!_dbus_string_init (&parser->bus_type))
100 if (!_dbus_string_init (&parser->service_helper))
106 /* argh. we have do do this carefully because of OOM */
108 _dbus_string_free (&parser->bus_type);
110 _dbus_string_free (&parser->user);
118 bus_config_parser_unref (BusConfigParser *parser)
120 _dbus_string_free (&parser->user);
121 _dbus_string_free (&parser->service_helper);
122 _dbus_string_free (&parser->bus_type);
124 _dbus_list_foreach (&parser->service_dirs,
125 (DBusForeachFunction) dbus_free,
128 _dbus_list_clear (&parser->service_dirs);
134 bus_config_parser_start_element (BusConfigParser *parser,
135 const char *element_name,
136 const char **attribute_names,
137 const char **attribute_values,
140 /* we don't do processing of attribute names, we don't need to */
141 parser->type = bus_config_parser_element_name_to_type (element_name);
143 switch (parser->type)
145 case ELEMENT_SERVICEHELPER:
148 /* content about to be handled */
151 case ELEMENT_STANDARD_SYSTEM_SERVICEDIRS:
157 if (!_dbus_get_standard_system_servicedirs (&dirs))
163 while ((link = _dbus_list_pop_first_link (&dirs)))
164 service_dirs_append_link_unique_or_free (&parser->service_dirs, link);
170 /* we really don't care about the others... */
171 _dbus_verbose (" START We dont care about '%s' type '%i'\n", element_name, parser->type);
179 bus_config_parser_end_element (BusConfigParser *parser,
180 const char *element_name,
188 bus_config_parser_content (BusConfigParser *parser,
189 const DBusString *content,
192 DBusString content_sane;
197 if (!_dbus_string_init (&content_sane))
202 if (!_dbus_string_copy (content, 0, &content_sane, 0))
208 /* rip out white space */
209 _dbus_string_chop_white (&content_sane);
210 if (_dbus_string_get_length (&content_sane) == 0)
212 /* optimise, there is no content */
217 switch (parser->type)
219 case ELEMENT_SERVICEDIR:
223 /* copy the sane data into a char array */
224 if (!_dbus_string_copy_data(&content_sane, &cpath))
230 /* append the dynamic char string to service dirs */
231 if (!_dbus_list_append (&parser->service_dirs, cpath))
240 case ELEMENT_SERVICEHELPER:
242 if (!_dbus_string_copy (&content_sane, 0, &parser->service_helper, 0))
252 if (!_dbus_string_copy (&content_sane, 0, &parser->user, 0))
262 if (!_dbus_string_copy (&content_sane, 0, &parser->bus_type, 0))
271 /* we don't care about the others... really */
272 _dbus_verbose (" CONTENTS We dont care '%s' type '%i'\n", _dbus_string_get_const_data (&content_sane), parser->type);
281 _dbus_string_free (&content_sane);
287 bus_config_parser_finished (BusConfigParser *parser,
290 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
291 _dbus_verbose ("finished scanning!\n");
296 bus_config_parser_get_user (BusConfigParser *parser)
298 return _dbus_string_get_const_data (&parser->user);
302 bus_config_parser_get_type (BusConfigParser *parser)
304 return _dbus_string_get_const_data (&parser->bus_type);
308 bus_config_parser_get_service_dirs (BusConfigParser *parser)
310 return &parser->service_dirs;
313 #ifdef DBUS_BUILD_TESTS
325 check_return_values (const DBusString *full_path)
327 BusConfigParser *parser;
334 dbus_error_init (&error);
337 printf ("Testing values from: %s\n", _dbus_string_get_const_data (full_path));
339 parser = bus_config_load (full_path, TRUE, NULL, &error);
342 _DBUS_ASSERT_ERROR_IS_SET (&error);
343 if (dbus_error_has_name (&error, DBUS_ERROR_NO_MEMORY))
344 _dbus_verbose ("Failed to load valid file due to OOM\n");
347 _DBUS_ASSERT_ERROR_IS_CLEAR (&error);
349 /* check user return value is okay */
350 user = bus_config_parser_get_user (parser);
353 _dbus_warn ("User was NULL!\n");
356 if (strcmp (user, "dbus") != 0)
358 _dbus_warn ("User was invalid; '%s'!\n", user);
361 printf (" <user>dbus</user> OKAY!\n");
363 /* check type return value is okay */
364 type = bus_config_parser_get_type (parser);
367 _dbus_warn ("Type was NULL!\n");
370 if (strcmp (type, "system") != 0)
372 _dbus_warn ("Type was invalid; '%s'!\n", user);
375 printf (" <type>system</type> OKAY!\n");
377 /* check dirs return value is okay */
378 dirs = bus_config_parser_get_service_dirs (parser);
381 _dbus_warn ("Service dirs are NULL!\n");
384 printf (" <standard_system_service_dirs/> OKAY!\n");
385 /* NOTE: We tested the specific return values in the config-parser tests */
391 bus_config_parser_unref (parser);
392 dbus_error_free (&error);
397 do_load (const DBusString *full_path,
399 dbus_bool_t oom_possible)
401 BusConfigParser *parser;
404 dbus_error_init (&error);
406 parser = bus_config_load (full_path, TRUE, NULL, &error);
409 _DBUS_ASSERT_ERROR_IS_SET (&error);
412 dbus_error_has_name (&error, DBUS_ERROR_NO_MEMORY))
414 _dbus_verbose ("Failed to load valid file due to OOM\n");
415 dbus_error_free (&error);
418 else if (validity == VALID)
420 _dbus_warn ("Failed to load valid file but still had memory: %s\n",
423 dbus_error_free (&error);
428 dbus_error_free (&error);
434 _DBUS_ASSERT_ERROR_IS_CLEAR (&error);
436 bus_config_parser_unref (parser);
438 if (validity == INVALID)
440 _dbus_warn ("Accepted invalid file\n");
450 const DBusString *full_path;
455 check_loader_oom_func (void *data)
457 LoaderOomData *d = data;
459 return do_load (d->full_path, d->validity, TRUE);
463 process_test_valid_subdir (const DBusString *test_base_dir,
467 DBusString test_directory;
476 if (!_dbus_string_init (&test_directory))
477 _dbus_assert_not_reached ("didn't allocate test_directory\n");
479 _dbus_string_init_const (&filename, subdir);
481 if (!_dbus_string_copy (test_base_dir, 0,
483 _dbus_assert_not_reached ("couldn't copy test_base_dir to test_directory");
485 if (!_dbus_concat_dir_and_file (&test_directory, &filename))
486 _dbus_assert_not_reached ("couldn't allocate full path");
488 _dbus_string_free (&filename);
489 if (!_dbus_string_init (&filename))
490 _dbus_assert_not_reached ("didn't allocate filename string\n");
492 dbus_error_init (&error);
493 dir = _dbus_directory_open (&test_directory, &error);
496 _dbus_warn ("Could not open %s: %s\n",
497 _dbus_string_get_const_data (&test_directory),
499 dbus_error_free (&error);
503 if (validity == VALID)
504 printf ("Testing valid files:\n");
505 else if (validity == INVALID)
506 printf ("Testing invalid files:\n");
508 printf ("Testing unknown files:\n");
511 while (_dbus_directory_get_next_file (dir, &filename, &error))
513 DBusString full_path;
516 if (!_dbus_string_init (&full_path))
517 _dbus_assert_not_reached ("couldn't init string");
519 if (!_dbus_string_copy (&test_directory, 0, &full_path, 0))
520 _dbus_assert_not_reached ("couldn't copy dir to full_path");
522 if (!_dbus_concat_dir_and_file (&full_path, &filename))
523 _dbus_assert_not_reached ("couldn't concat file to dir");
525 if (!_dbus_string_ends_with_c_str (&full_path, ".conf"))
527 _dbus_verbose ("Skipping non-.conf file %s\n",
528 _dbus_string_get_const_data (&filename));
529 _dbus_string_free (&full_path);
533 printf (" %s\n", _dbus_string_get_const_data (&filename));
535 _dbus_verbose (" expecting %s\n",
536 validity == VALID ? "valid" :
537 (validity == INVALID ? "invalid" :
538 (validity == UNKNOWN ? "unknown" : "???")));
540 d.full_path = &full_path;
541 d.validity = validity;
543 /* FIXME hackaround for an expat problem, see
544 * https://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=124747
545 * http://freedesktop.org/pipermail/dbus/2004-May/001153.html
547 /* if (!_dbus_test_oom_handling ("config-loader", check_loader_oom_func, &d)) */
548 if (!check_loader_oom_func (&d))
549 _dbus_assert_not_reached ("test failed");
551 _dbus_string_free (&full_path);
554 if (dbus_error_is_set (&error))
556 _dbus_warn ("Could not get next file in %s: %s\n",
557 _dbus_string_get_const_data (&test_directory),
559 dbus_error_free (&error);
568 _dbus_directory_close (dir);
569 _dbus_string_free (&test_directory);
570 _dbus_string_free (&filename);
575 /* convenience function, do not reuse outside of TEST */
577 make_full_path (const DBusString *test_data_dir,
580 DBusString *full_path)
587 if (!_dbus_string_init (full_path))
589 _dbus_warn ("couldn't allocate full path");
593 if (!_dbus_string_copy (test_data_dir, 0, full_path, 0))
595 _dbus_warn ("couldn't allocate full path");
599 _dbus_string_init_const (&filename, subdir);
600 if (!_dbus_concat_dir_and_file (full_path, &filename))
602 _dbus_warn ("couldn't allocate full path");
605 _dbus_string_free (&filename);
607 _dbus_string_init_const (&filename, file);
608 if (!_dbus_concat_dir_and_file (full_path, &filename))
610 _dbus_warn ("couldn't allocate full path");
618 _dbus_string_free (&filename);
623 check_file_valid (DBusString *full_path,
628 if (validity == VALID)
629 printf ("Testing valid file:\n");
630 else if (validity == INVALID)
631 printf ("Testing invalid file:\n");
633 printf ("Testing unknown file:\n");
635 /* print the filename, just so we match the other output */
636 printf (" %s\n", _dbus_string_get_const_data (full_path));
638 /* only test one file */
639 retval = do_load (full_path, validity, TRUE);
645 bus_config_parser_trivial_test (const DBusString *test_data_dir)
647 DBusString full_path;
652 if (test_data_dir == NULL ||
653 _dbus_string_get_length (test_data_dir) == 0)
655 printf ("No test data\n");
659 /* We already test default_session_servicedirs and default_system_servicedirs
660 * in bus_config_parser_test() */
661 if (!process_test_valid_subdir (test_data_dir, "valid-config-files", VALID))
664 /* we don't process all the invalid files, as the trivial parser can't hope
665 * to validate them all for all different syntaxes. We just check one broken
666 * file to see if junk is received */
667 if (!make_full_path (test_data_dir, "invalid-config-files", "not-well-formed.conf", &full_path))
669 if (!check_file_valid (&full_path, INVALID))
671 _dbus_string_free (&full_path);
673 /* just test if the check_file_valid works okay and we got sane values */
674 if (!make_full_path (test_data_dir, "valid-config-files", "system.conf", &full_path))
676 if (!check_file_valid (&full_path, VALID))
678 /* check to see if we got the correct values from the parser */
679 if (!check_return_values (&full_path))
686 _dbus_string_free (&full_path);
688 /* we don't process equiv-config-files as we don't handle <include> */
692 #endif /* DBUS_BUILD_TESTS */