From a6278b88305b237b02eabff0d870b57fe851822d Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Tue, 11 Mar 2014 19:03:50 +0100 Subject: bus: replace sd_bus_label_{escape,unescape}() by new sd_bus_path_{encode,decode}() The new calls work similarly, but enforce a that a common, fixed bus path prefix is used. This follows discussions with Simon McVittie on IRC that it should be a good idea to make sure that people don't use the escaping applied here too wildly as anything other than the last label of a bus path. --- man/sd_bus_label_escape.xml | 111 -------------------------------- man/sd_bus_path_encode.xml | 150 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 150 insertions(+), 111 deletions(-) delete mode 100644 man/sd_bus_label_escape.xml create mode 100644 man/sd_bus_path_encode.xml (limited to 'man') diff --git a/man/sd_bus_label_escape.xml b/man/sd_bus_label_escape.xml deleted file mode 100644 index 0b5564f15d..0000000000 --- a/man/sd_bus_label_escape.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - - - sd_bus_label_escape - systemd - - - - A monkey with a typewriter - Zbigniew - Jędrzejewski-Szmek - zbyszek@in.waw.pl - - - - - - sd_bus_label_escape - 3 - - - - sd_bus_label_escape - sd_bus_label_unescape - - Escape D-Bus object path special characters - - - - - #include <systemd/sd-bus.h> - - - char *sd_bus_label_escape - const char *s - - - - char *sd_bus_label_unescape - const char *f - - - - - - Description - - sd_bus_label_escape() takes a - NUL-terminated string as a argument. It will - replace all characters which are invalid in a D-Bus object path by - _ and a hexadecimal number. As a special case, - the empty string will be replaced by a lone _. - sd_bus_label_unescape() can be used to - reverse this process. - - - - Return Value - - On success, a new NUL-terminated string - will be returned. It must be - free3d - by the caller. If a memory allocation failure occurs, - NULL will be returned. - - - - - Notes - - sd_bus_label_escape() and - sd_bus_label_unescape() are available as a - shared library, which can be compiled and linked to with the - libsystemd pkg-config1 - file. - - - - See Also - - - systemd1, - sd-bus3, - free3 - - - - diff --git a/man/sd_bus_path_encode.xml b/man/sd_bus_path_encode.xml new file mode 100644 index 0000000000..5c166d072b --- /dev/null +++ b/man/sd_bus_path_encode.xml @@ -0,0 +1,150 @@ + + + + + + + + + sd_bus_path_encode + systemd + + + + A monkey with a typewriter + Zbigniew + Jędrzejewski-Szmek + zbyszek@in.waw.pl + + + + + + sd_bus_path_encode + 3 + + + + sd_bus_path_encode + sd_bus_path_decode + + Convert an external identifier into an object path and back + + + + + #include <systemd/sd-bus.h> + + + int sd_bus_path_encode + const char *prefix + const char *external_id + char **ret_path + + + + int sd_bus_path_decode + const char *prefix + const char *path + char **ret_external_id + + + + + + Description + + sd_bus_path_encode() and + sd_bus_path_decode() convert external + identifier strings into object paths and back. These functions are + useful to map application-specific string identifiers of any kind + into bus object paths in a simple, reversible and safe way. + + sd_bus_path_encode() takes a bus path + prefix and an external identifier string as arguments, plus a + place to store the returned bus path string. The bus path prefix + must be a valid bus path, starting with a slash + /, but not ending in one. The external + identifier string may be in any format, may be the empty string + and no restrictions on the charset are made - however it must + always be NUL-terminated. The returned string + will be the concatenation of the bus path prefix plus an escaped + version of the external identifier string. This operation may be + reversed with sd_bus_decode(). It is + recommended to only use external identifiers here that generally + require little escaping to be turned into valid bus path + identifiers (for example by sticking to a 7bit ASCII character + set), in order to ensure the resulting bus path is still short and + easily processed. + + sd_bus_path_decode() reverses the + operation of sd_bus_path_encode() and thus + regenerates an external identifier string from a bus path. It + takes a bus path and a prefix string, plus a place to store the + returned external identifier string. If the bus path does not + start with the specified prefix, 0 is returned and the returned + string is set to NULL. Otherwise the the + string following the prefix is unescaped and returned in the + external identifier string. + + The escaping used will will replace all characters which are + invalid in a bus object path by _ followed by a + hexadecimal value. As a special case, the empty string will be + replaced by a lone _. + + + + Return Value + + On success, sd_bus_path_encode() + returns positive or 0, and a valid bus path in the return + argument. On success, sd_bus_path_decode() + returns a positive value if the prefixed matched, or 0 if it + didn't. If the prefix matched the external identifier is returned + in the return parameter. If it did not match NULL is returned in + the return parameter. On failure, a negative errno-style error + number is returned by either function. The returned strings must + be + free3'd + by the caller. + + + + Notes + + sd_bus_path_encode() and + sd_bus_path_decode() are available as a + shared library, which can be compiled and linked to with the + libsystemd pkg-config1 + file. + + + + See Also + + + systemd1, + sd-bus3, + free3 + + + + -- cgit v1.2.3-54-g00ecf