1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
|
/***
This file is part of PulseAudio.
PulseAudio is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation; either version 2.1 of the License,
or (at your option) any later version.
PulseAudio is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
***/
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <stdlib.h>
#include <stdio.h>
#include <pulse/xmalloc.h>
#include <pulsecore/core.h>
#include <pulsecore/core-util.h>
#include <pulsecore/log.h>
#include <pulsecore/macro.h>
#include "message-handler.h"
/* Check if a path string starts with a / and only contains valid characters.
* Also reject double slashes. */
static bool object_path_is_valid(const char *test_string) {
uint32_t i;
if (!test_string)
return false;
/* Make sure the string starts with a / */
if (test_string[0] != '/')
return false;
for (i = 0; test_string[i]; i++) {
if ((test_string[i] >= 'a' && test_string[i] <= 'z') ||
(test_string[i] >= 'A' && test_string[i] <= 'Z') ||
(test_string[i] >= '0' && test_string[i] <= '9') ||
test_string[i] == '.' ||
test_string[i] == '_' ||
test_string[i] == '-' ||
(test_string[i] == '/' && test_string[i + 1] != '/'))
continue;
return false;
}
/* Make sure the string does not end with a / */
if (test_string[i - 1] == '/')
return false;
return true;
}
/* Message handler functions */
/* Register message handler for the specified object. object_path must be a unique name starting with "/". */
void pa_message_handler_register(pa_core *c, const char *object_path, const char *description, pa_message_handler_cb_t cb, void *userdata) {
struct pa_message_handler *handler;
pa_assert(c);
pa_assert(object_path);
pa_assert(cb);
pa_assert(userdata);
/* Ensure that object path is valid */
pa_assert(object_path_is_valid(object_path));
handler = pa_xnew0(struct pa_message_handler, 1);
handler->userdata = userdata;
handler->callback = cb;
handler->object_path = pa_xstrdup(object_path);
handler->description = pa_xstrdup(description);
pa_assert_se(pa_hashmap_put(c->message_handlers, handler->object_path, handler) == 0);
}
/* Unregister a message handler */
void pa_message_handler_unregister(pa_core *c, const char *object_path) {
struct pa_message_handler *handler;
pa_assert(c);
pa_assert(object_path);
pa_assert_se(handler = pa_hashmap_remove(c->message_handlers, object_path));
pa_xfree(handler->object_path);
pa_xfree(handler->description);
pa_xfree(handler);
}
/* Send a message to an object identified by object_path */
int pa_message_handler_send_message(pa_core *c, const char *object_path, const char *message, const char *message_parameters, char **response) {
struct pa_message_handler *handler;
int ret;
char *parameter_copy, *path_copy;
pa_assert(c);
pa_assert(object_path);
pa_assert(message);
pa_assert(response);
*response = NULL;
path_copy = pa_xstrdup(object_path);
/* Remove trailing / from path name if present */
if (path_copy[strlen(path_copy) - 1] == '/')
path_copy[strlen(path_copy) - 1] = 0;
if (!(handler = pa_hashmap_get(c->message_handlers, path_copy))) {
pa_xfree(path_copy);
return -PA_ERR_NOENTITY;
}
parameter_copy = pa_xstrdup(message_parameters);
/* The handler is expected to return an error code and may also
return an error string in response */
ret = handler->callback(handler->object_path, message, parameter_copy, response, handler->userdata);
pa_xfree(parameter_copy);
pa_xfree(path_copy);
return ret;
}
/* Set handler description */
int pa_message_handler_set_description(pa_core *c, const char *object_path, const char *description) {
struct pa_message_handler *handler;
pa_assert(c);
pa_assert(object_path);
if (!(handler = pa_hashmap_get(c->message_handlers, object_path)))
return -PA_ERR_NOENTITY;
pa_xfree(handler->description);
handler->description = pa_xstrdup(description);
return PA_OK;
}
|
