summaryrefslogtreecommitdiff
path: root/indra/llplugin/llpluginmessage.cpp
blob: 188d71227b0b905841a2603f740da5c152c0540a (plain)
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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
/**
 * @file llpluginmessage.cpp
 * @brief LLPluginMessage encapsulates the serialization/deserialization of messages passed to and from plugins.
 *
 * @cond
 * $LicenseInfo:firstyear=2008&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2010, Linden Research, Inc.
 *
 * This library 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;
 * version 2.1 of the License only.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
 * $/LicenseInfo$
 * @endcond
 */

#include "linden_common.h"

#include "llpluginmessage.h"
#include "llsdserialize.h"
#include "u64.h"

/**
 * Constructor.
 */
LLPluginMessage::LLPluginMessage()
{
}

/**
 * Constructor.
 *
 * @param[in] p Existing message
 */
LLPluginMessage::LLPluginMessage(const LLPluginMessage &p)
{
    mMessage = p.mMessage;
}

/**
 * Constructor.
 *
 * @param[in] message_class Message class
 * @param[in] message_name Message name
 */
LLPluginMessage::LLPluginMessage(const std::string &message_class, const std::string &message_name)
{
    setMessage(message_class, message_name);
}


/**
 * Destructor.
 */
LLPluginMessage::~LLPluginMessage()
{
}

/**
 * Reset all internal state.
 */
void LLPluginMessage::clear()
{
    mMessage = LLSD::emptyMap();
    mMessage["params"] = LLSD::emptyMap();
}

/**
 * Sets the message class and name. Also has the side-effect of clearing any key-value pairs in the message.
 *
 * @param[in] message_class Message class
 * @param[in] message_name Message name
 */
void LLPluginMessage::setMessage(const std::string &message_class, const std::string &message_name)
{
    clear();
    mMessage["class"] = message_class;
    mMessage["name"] = message_name;
}

/**
 * Sets a key/value pair in the message, where the value is a string.
 *
 * @param[in] key Key
 * @param[in] value String value
 */
void LLPluginMessage::setValue(const std::string &key, const std::string &value)
{
    mMessage["params"][key] = value;
}

/**
 * Sets a key/value pair in the message, where the value is LLSD.
 *
 * @param[in] key Key
 * @param[in] value LLSD value
 */
void LLPluginMessage::setValueLLSD(const std::string &key, const LLSD &value)
{
    mMessage["params"][key] = value;
}

/**
 * Sets a key/value pair in the message, where the value is signed 32-bit.
 *
 * @param[in] key Key
 * @param[in] value 32-bit signed value
 */
void LLPluginMessage::setValueS32(const std::string &key, S32 value)
{
    mMessage["params"][key] = value;
}

/**
 * Sets a key/value pair in the message, where the value is unsigned 32-bit. The value is stored as a string beginning with "0x".
 *
 * @param[in] key Key
 * @param[in] value 32-bit unsigned value
 */
void LLPluginMessage::setValueU32(const std::string &key, U32 value)
{
    std::stringstream temp;
    temp << "0x" << std::hex << value;
    setValue(key, temp.str());
}

/**
 * Sets a key/value pair in the message, where the value is a bool.
 *
 * @param[in] key Key
 * @param[in] value Boolean value
 */
void LLPluginMessage::setValueBoolean(const std::string &key, bool value)
{
    mMessage["params"][key] = value;
}

/**
 * Sets a key/value pair in the message, where the value is a double.
 *
 * @param[in] key Key
 * @param[in] value Boolean value
 */
void LLPluginMessage::setValueReal(const std::string &key, F64 value)
{
    mMessage["params"][key] = value;
}

/**
 * Sets a key/value pair in the message, where the value is a pointer. The pointer is stored as a string.
 *
 * @param[in] key Key
 * @param[in] value Pointer value
 */
void LLPluginMessage::setValuePointer(const std::string &key, void* value)
{
    std::stringstream temp;
    // iostreams should output pointer values in hex with an initial 0x by default.
    temp << value;
    setValue(key, temp.str());
}

/**
 * Gets the message class.
 *
 * @return Message class
 */
std::string LLPluginMessage::getClass(void) const
{
    return mMessage["class"];
}

/**
 * Gets the message name.
 *
 * @return Message name
 */
std::string LLPluginMessage::getName(void) const
{
    return mMessage["name"];
}

/**
 *  Returns true if the specified key exists in this message (useful for optional parameters).
 *
 * @param[in] key Key
 *
 * @return True if key exists, false otherwise.
 */
bool LLPluginMessage::hasValue(const std::string &key) const
{
    bool result = false;

    if(mMessage["params"].has(key))
    {
        result = true;
    }

    return result;
}

/**
 *  Gets the value of a key as a string. If the key does not exist, an empty string will be returned.
 *
 * @param[in] key Key
 *
 * @return String value of key if key exists, empty string if key does not exist.
 */
std::string LLPluginMessage::getValue(const std::string &key) const
{
    std::string result;

    if(mMessage["params"].has(key))
    {
        result = mMessage["params"][key].asString();
    }

    return result;
}

/**
 *  Gets the value of a key as LLSD. If the key does not exist, a null LLSD will be returned.
 *
 * @param[in] key Key
 *
 * @return LLSD value of key if key exists, null LLSD if key does not exist.
 */
LLSD LLPluginMessage::getValueLLSD(const std::string &key) const
{
    LLSD result;

    if(mMessage["params"].has(key))
    {
        result = mMessage["params"][key];
    }

    return result;
}

/**
 *  Gets the value of a key as signed 32-bit int. If the key does not exist, 0 will be returned.
 *
 * @param[in] key Key
 *
 * @return Signed 32-bit int value of key if key exists, 0 if key does not exist.
 */
S32 LLPluginMessage::getValueS32(const std::string &key) const
{
    S32 result = 0;

    if(mMessage["params"].has(key))
    {
        result = mMessage["params"][key].asInteger();
    }

    return result;
}

/**
 *  Gets the value of a key as unsigned 32-bit int. If the key does not exist, 0 will be returned.
 *
 * @param[in] key Key
 *
 * @return Unsigned 32-bit int value of key if key exists, 0 if key does not exist.
 */
U32 LLPluginMessage::getValueU32(const std::string &key) const
{
    U32 result = 0;

    if(mMessage["params"].has(key))
    {
        std::string value = mMessage["params"][key].asString();

        result = (U32)strtoul(value.c_str(), NULL, 16);
    }

    return result;
}

/**
 *  Gets the value of a key as a bool. If the key does not exist, false will be returned.
 *
 * @param[in] key Key
 *
 * @return Boolean value of key if it exists, false otherwise.
 */
bool LLPluginMessage::getValueBoolean(const std::string &key) const
{
    bool result = false;

    if(mMessage["params"].has(key))
    {
        result = mMessage["params"][key].asBoolean();
    }

    return result;
}

/**
 *  Gets the value of a key as a double. If the key does not exist, 0 will be returned.
 *
 * @param[in] key Key
 *
 * @return Value as a double if key exists, 0 otherwise.
 */
F64 LLPluginMessage::getValueReal(const std::string &key) const
{
    F64 result = 0.0f;

    if(mMessage["params"].has(key))
    {
        result = mMessage["params"][key].asReal();
    }

    return result;
}

/**
 *  Gets the value of a key as a pointer. If the key does not exist, NULL will be returned.
 *
 * @param[in] key Key
 *
 * @return Pointer value if key exists, NULL otherwise.
 */
void* LLPluginMessage::getValuePointer(const std::string &key) const
{
    void* result = NULL;

    if(mMessage["params"].has(key))
    {
        std::string value = mMessage["params"][key].asString();

        result = (void*)llstrtou64(value.c_str(), NULL, 16);
    }

    return result;
}

/**
 *  Flatten the message into a string.
 *
 * @return Message as a string.
 */
std::string LLPluginMessage::generate(void) const
{
    std::ostringstream result;

    // Pretty XML may be slightly easier to deal with while debugging...
//  LLSDSerialize::toXML(mMessage, result);
    LLSDSerialize::toPrettyXML(mMessage, result);

    return result.str();
}

/**
 *  Parse an incoming message into component parts. Clears all existing state before starting the parse.
 *
 * @return Returns -1 on failure, otherwise returns the number of key/value pairs in the incoming message.
 */
int LLPluginMessage::parse(const std::string &message)
{
    // clear any previous state
    clear();

    std::istringstream input(message);

    S32 parse_result = LLSDSerialize::fromXML(mMessage, input);

    return (int)parse_result;
}


/**
 * Destructor
 */
LLPluginMessageListener::~LLPluginMessageListener()
{
    // TODO: should listeners have a way to ensure they're removed from dispatcher lists when deleted?
}


/**
 * Destructor
 */
LLPluginMessageDispatcher::~LLPluginMessageDispatcher()
{

}

/**
 * Add a message listener. TODO:DOC need more info on what uses this. when are multiple listeners needed?
 *
 * @param[in] listener Message listener
 */
void LLPluginMessageDispatcher::addPluginMessageListener(LLPluginMessageListener *listener)
{
    mListeners.insert(listener);
}

/**
 * Remove a message listener.
 *
 * @param[in] listener Message listener
 */
void LLPluginMessageDispatcher::removePluginMessageListener(LLPluginMessageListener *listener)
{
    mListeners.erase(listener);
}

/**
 * Distribute a message to all message listeners.
 *
 * @param[in] message Message
 */
void LLPluginMessageDispatcher::dispatchPluginMessage(const LLPluginMessage &message)
{
    for (listener_set_t::iterator it = mListeners.begin();
        it != mListeners.end();
        )
    {
        LLPluginMessageListener* listener = *it;
        listener->receivePluginMessage(message);
        // In case something deleted an entry.
        it = mListeners.upper_bound(listener);
    }
}