1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-address.c Server address parser.
4 * Copyright (C) 2003 CodeFactory AB
5 * Copyright (C) 2004,2005 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
26 #include "dbus-address.h"
27 #include "dbus-internals.h"
28 #include "dbus-list.h"
29 #include "dbus-string.h"
30 #include "dbus-protocol.h"
33 * @defgroup DBusAddressInternals Address parsing
34 * @ingroup DBusInternals
35 * @brief Implementation of parsing addresses of D-Bus servers.
41 * Internals of DBusAddressEntry
43 struct DBusAddressEntry
45 DBusString method; /**< The address type (unix, tcp, etc.) */
47 DBusList *keys; /**< List of keys */
48 DBusList *values; /**< List of values */
54 * Sets #DBUS_ERROR_BAD_ADDRESS.
55 * If address_problem_type and address_problem_field are not #NULL,
56 * sets an error message about how the field is no good. Otherwise, sets
57 * address_problem_other as the error message.
59 * @param error the error to set
60 * @param address_problem_type the address type of the bad address or #NULL
61 * @param address_problem_field the missing field of the bad address or #NULL
62 * @param address_problem_other any other error message or #NULL
65 _dbus_set_bad_address (DBusError *error,
66 const char *address_problem_type,
67 const char *address_problem_field,
68 const char *address_problem_other)
70 if (address_problem_type != NULL)
71 dbus_set_error (error, DBUS_ERROR_BAD_ADDRESS,
72 "Server address of type %s was missing argument %s",
73 address_problem_type, address_problem_field);
75 dbus_set_error (error, DBUS_ERROR_BAD_ADDRESS,
76 "Could not parse server address: %s",
77 address_problem_other);
81 * #TRUE if the byte need not be escaped when found in a dbus address.
82 * All other bytes are required to be escaped in a valid address.
84 #define _DBUS_ADDRESS_OPTIONALLY_ESCAPED_BYTE(b) \
85 (((b) >= 'a' && (b) <= 'z') || \
86 ((b) >= 'A' && (b) <= 'Z') || \
87 ((b) >= '0' && (b) <= '9') || \
95 * Appends an escaped version of one string to another string,
96 * using the D-Bus address escaping mechanism
98 * @param escaped the string to append to
99 * @param unescaped the string to escape
100 * @returns #FALSE if no memory
103 _dbus_address_append_escaped (DBusString *escaped,
104 const DBusString *unescaped)
113 orig_len = _dbus_string_get_length (escaped);
114 p = _dbus_string_get_const_data (unescaped);
115 end = p + _dbus_string_get_length (unescaped);
118 if (_DBUS_ADDRESS_OPTIONALLY_ESCAPED_BYTE (*p))
120 if (!_dbus_string_append_byte (escaped, *p))
125 if (!_dbus_string_append_byte (escaped, '%'))
127 if (!_dbus_string_append_byte_as_hex (escaped, *p))
138 _dbus_string_set_length (escaped, orig_len);
142 /** @} */ /* End of internals */
145 dbus_address_entry_free (DBusAddressEntry *entry)
149 _dbus_string_free (&entry->method);
151 link = _dbus_list_get_first_link (&entry->keys);
154 _dbus_string_free (link->data);
155 dbus_free (link->data);
157 link = _dbus_list_get_next_link (&entry->keys, link);
159 _dbus_list_clear (&entry->keys);
161 link = _dbus_list_get_first_link (&entry->values);
164 _dbus_string_free (link->data);
165 dbus_free (link->data);
167 link = _dbus_list_get_next_link (&entry->values, link);
169 _dbus_list_clear (&entry->values);
175 * @defgroup DBusAddress Address parsing
177 * @brief Parsing addresses of D-Bus servers.
183 * Frees a #NULL-terminated array of address entries.
185 * @param entries the array.
188 dbus_address_entries_free (DBusAddressEntry **entries)
192 for (i = 0; entries[i] != NULL; i++)
193 dbus_address_entry_free (entries[i]);
197 static DBusAddressEntry *
200 DBusAddressEntry *entry;
202 entry = dbus_new0 (DBusAddressEntry, 1);
207 if (!_dbus_string_init (&entry->method))
217 * Returns the method string of an address entry.
219 * @param entry the entry.
220 * @returns a string describing the method. This string
224 dbus_address_entry_get_method (DBusAddressEntry *entry)
226 return _dbus_string_get_const_data (&entry->method);
230 * Returns a value from a key of an entry.
232 * @param entry the entry.
233 * @param key the key.
234 * @returns the key value. This string must not be freed.
237 dbus_address_entry_get_value (DBusAddressEntry *entry,
240 DBusList *values, *keys;
242 keys = _dbus_list_get_first_link (&entry->keys);
243 values = _dbus_list_get_first_link (&entry->values);
247 _dbus_assert (values != NULL);
249 if (_dbus_string_equal_c_str (keys->data, key))
250 return _dbus_string_get_const_data (values->data);
252 keys = _dbus_list_get_next_link (&entry->keys, keys);
253 values = _dbus_list_get_next_link (&entry->values, values);
260 append_unescaped_value (DBusString *unescaped,
261 const DBusString *escaped,
272 p = _dbus_string_get_const_data (escaped) + escaped_start;
273 end = p + escaped_len;
276 if (_DBUS_ADDRESS_OPTIONALLY_ESCAPED_BYTE (*p))
278 if (!_dbus_string_append_byte (unescaped, *p))
283 /* Efficiency is king */
292 dbus_set_error (error, DBUS_ERROR_BAD_ADDRESS,
293 "In D-Bus address, percent character was not followed by two hex digits");
302 _dbus_string_init_const (&hex, buf);
304 if (!_dbus_string_hex_decode (&hex, 0, &hex_end,
306 _dbus_string_get_length (unescaped)))
311 dbus_set_error (error, DBUS_ERROR_BAD_ADDRESS,
312 "In D-Bus address, percent character was followed by characters other than hex digits");
318 /* Error, should have been escaped */
319 dbus_set_error (error, DBUS_ERROR_BAD_ADDRESS,
320 "In D-Bus address, character '%c' should have been escaped\n",
331 if (!ret && error && !dbus_error_is_set (error))
332 _DBUS_SET_OOM (error);
334 _dbus_assert (ret || error == NULL || dbus_error_is_set (error));
340 * Parses an address string of the form:
342 * method:key=value,key=value;method:key=value
344 * See the D-Bus specification for complete docs on the format.
346 * @param address the address.
347 * @param entry return location to an array of entries.
348 * @param array_len return location for array length.
349 * @param error address where an error can be returned.
350 * @returns #TRUE on success, #FALSE otherwise.
353 dbus_parse_address (const char *address,
354 DBusAddressEntry ***entry,
359 int pos, end_pos, len, i;
360 DBusList *entries, *link;
361 DBusAddressEntry **entry_array;
363 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
365 _dbus_string_init_const (&str, address);
369 len = _dbus_string_get_length (&str);
373 DBusAddressEntry *entry;
377 entry = create_entry ();
380 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
385 /* Append the entry */
386 if (!_dbus_list_append (&entries, entry))
388 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
389 dbus_address_entry_free (entry);
393 /* Look for a semi-colon */
394 if (!_dbus_string_find (&str, pos, ";", &end_pos))
397 /* Look for the colon : */
398 if (!_dbus_string_find_to (&str, pos, end_pos, ":", &found_pos))
400 dbus_set_error (error, DBUS_ERROR_BAD_ADDRESS, "Address does not contain a colon");
404 if (!_dbus_string_copy_len (&str, pos, found_pos - pos, &entry->method, 0))
406 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
412 while (pos < end_pos)
414 int comma_pos, equals_pos;
416 if (!_dbus_string_find_to (&str, pos, end_pos, ",", &comma_pos))
419 if (!_dbus_string_find_to (&str, pos, comma_pos, "=", &equals_pos) ||
420 equals_pos == pos || equals_pos + 1 == comma_pos)
422 dbus_set_error (error, DBUS_ERROR_BAD_ADDRESS,
423 "'=' character not found or has no value following it");
431 key = dbus_new0 (DBusString, 1);
435 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
439 value = dbus_new0 (DBusString, 1);
442 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
447 if (!_dbus_string_init (key))
449 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
456 if (!_dbus_string_init (value))
458 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
459 _dbus_string_free (key);
466 if (!_dbus_string_copy_len (&str, pos, equals_pos - pos, key, 0))
468 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
469 _dbus_string_free (key);
470 _dbus_string_free (value);
477 if (!append_unescaped_value (value, &str, equals_pos + 1,
478 comma_pos - equals_pos - 1, error))
480 _dbus_assert (error == NULL || dbus_error_is_set (error));
481 _dbus_string_free (key);
482 _dbus_string_free (value);
489 if (!_dbus_list_append (&entry->keys, key))
491 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
492 _dbus_string_free (key);
493 _dbus_string_free (value);
500 if (!_dbus_list_append (&entry->values, value))
502 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
503 _dbus_string_free (value);
516 *array_len = _dbus_list_get_length (&entries);
518 entry_array = dbus_new (DBusAddressEntry *, *array_len + 1);
522 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
527 entry_array [*array_len] = NULL;
529 link = _dbus_list_get_first_link (&entries);
533 entry_array[i] = link->data;
535 link = _dbus_list_get_next_link (&entries, link);
538 _dbus_list_clear (&entries);
539 *entry = entry_array;
545 link = _dbus_list_get_first_link (&entries);
548 dbus_address_entry_free (link->data);
549 link = _dbus_list_get_next_link (&entries, link);
552 _dbus_list_clear (&entries);
559 * Escapes the given string as a value in a key=value pair
560 * for a D-Bus address.
562 * @param value the unescaped value
563 * @returns newly-allocated escaped value or #NULL if no memory
566 dbus_address_escape_value (const char *value)
569 DBusString unescaped;
574 _dbus_string_init_const (&unescaped, value);
576 if (!_dbus_string_init (&escaped))
579 if (!_dbus_address_append_escaped (&escaped, &unescaped))
582 if (!_dbus_string_steal_data (&escaped, &ret))
586 _dbus_string_free (&escaped);
591 * Unescapes the given string as a value in a key=value pair
592 * for a D-Bus address.
594 * @param value the escaped value
595 * @param error error to set if the unescaping fails
596 * @returns newly-allocated unescaped value or #NULL if no memory
599 dbus_address_unescape_value (const char *value,
602 DBusString unescaped;
608 _dbus_string_init_const (&escaped, value);
610 if (!_dbus_string_init (&unescaped))
613 if (!append_unescaped_value (&unescaped, &escaped,
614 0, _dbus_string_get_length (&escaped),
618 if (!_dbus_string_steal_data (&unescaped, &ret))
622 if (ret == NULL && error && !dbus_error_is_set (error))
623 _DBUS_SET_OOM (error);
625 _dbus_assert (ret != NULL || error == NULL || dbus_error_is_set (error));
627 _dbus_string_free (&unescaped);
631 /** @} */ /* End of public API */
633 #ifdef DBUS_BUILD_TESTS
635 #ifndef DOXYGEN_SHOULD_SKIP_THIS
637 #include "dbus-test.h"
643 const char *unescaped;
646 static const EscapeTest escape_tests[] = {
647 { "abcde", "abcde" },
652 { "abc%24", "abc$" },
653 { "%24abc", "$abc" },
654 { "abc%24abc", "abc$abc" },
666 static const char* invalid_escaped_values[] = {
681 _dbus_address_test (void)
683 DBusAddressEntry **entries;
688 dbus_error_init (&error);
691 while (i < _DBUS_N_ELEMENTS (escape_tests))
693 const EscapeTest *test = &escape_tests[i];
697 escaped = dbus_address_escape_value (test->unescaped);
699 _dbus_assert_not_reached ("oom");
701 if (strcmp (escaped, test->escaped) != 0)
703 _dbus_warn ("Escaped '%s' as '%s' should have been '%s'\n",
704 test->unescaped, escaped, test->escaped);
709 unescaped = dbus_address_unescape_value (test->escaped, &error);
710 if (unescaped == NULL)
712 _dbus_warn ("Failed to unescape '%s': %s\n",
713 test->escaped, error.message);
714 dbus_error_free (&error);
718 if (strcmp (unescaped, test->unescaped) != 0)
720 _dbus_warn ("Unescaped '%s' as '%s' should have been '%s'\n",
721 test->escaped, unescaped, test->unescaped);
724 dbus_free (unescaped);
730 while (i < _DBUS_N_ELEMENTS (invalid_escaped_values))
734 unescaped = dbus_address_unescape_value (invalid_escaped_values[i],
736 if (unescaped != NULL)
738 _dbus_warn ("Should not have successfully unescaped '%s' to '%s'\n",
739 invalid_escaped_values[i], unescaped);
740 dbus_free (unescaped);
744 _dbus_assert (dbus_error_is_set (&error));
745 dbus_error_free (&error);
750 if (!dbus_parse_address ("unix:path=/tmp/foo;debug:name=test,sliff=sloff;",
751 &entries, &len, &error))
752 _dbus_assert_not_reached ("could not parse address");
753 _dbus_assert (len == 2);
754 _dbus_assert (strcmp (dbus_address_entry_get_value (entries[0], "path"), "/tmp/foo") == 0);
755 _dbus_assert (strcmp (dbus_address_entry_get_value (entries[1], "name"), "test") == 0);
756 _dbus_assert (strcmp (dbus_address_entry_get_value (entries[1], "sliff"), "sloff") == 0);
758 dbus_address_entries_free (entries);
760 /* Different possible errors */
761 if (dbus_parse_address ("foo", &entries, &len, &error))
762 _dbus_assert_not_reached ("Parsed incorrect address.");
764 dbus_error_free (&error);
766 if (dbus_parse_address ("foo:bar", &entries, &len, &error))
767 _dbus_assert_not_reached ("Parsed incorrect address.");
769 dbus_error_free (&error);
771 if (dbus_parse_address ("foo:bar,baz", &entries, &len, &error))
772 _dbus_assert_not_reached ("Parsed incorrect address.");
774 dbus_error_free (&error);
776 if (dbus_parse_address ("foo:bar=foo,baz", &entries, &len, &error))
777 _dbus_assert_not_reached ("Parsed incorrect address.");
779 dbus_error_free (&error);
781 if (dbus_parse_address ("foo:bar=foo;baz", &entries, &len, &error))
782 _dbus_assert_not_reached ("Parsed incorrect address.");
784 dbus_error_free (&error);
786 if (dbus_parse_address ("foo:=foo", &entries, &len, &error))
787 _dbus_assert_not_reached ("Parsed incorrect address.");
789 dbus_error_free (&error);
791 if (dbus_parse_address ("foo:foo=", &entries, &len, &error))
792 _dbus_assert_not_reached ("Parsed incorrect address.");
794 dbus_error_free (&error);
796 if (dbus_parse_address ("foo:foo,bar=baz", &entries, &len, &error))
797 _dbus_assert_not_reached ("Parsed incorrect address.");
799 dbus_error_free (&error);
804 #endif /* !DOXYGEN_SHOULD_SKIP_THIS */