summaryrefslogtreecommitdiff
path: root/indra/llcharacter/llgesture.cpp
blob: 151bac792023beb72262633c1662a1ce7ff920fd (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
/**
 * @file llgesture.cpp
 *
 * $LicenseInfo:firstyear=2002&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$
 */

#include "linden_common.h"

#include "indra_constants.h"

#include "llgesture.h"
#include "llendianswizzle.h"
#include "message.h"
#include <boost/tokenizer.hpp>

// for allocating serialization buffers - these need to be updated when members change
const S32 LLGestureList::SERIAL_HEADER_SIZE = sizeof(S32);
const S32 LLGesture::MAX_SERIAL_SIZE = sizeof(KEY) + sizeof(MASK) + 16 + 26 + 41 + 41;

LLGesture::LLGesture()
:   mKey(KEY_NONE),
    mMask(MASK_NONE),
    mTrigger(),
    mTriggerLower(),
    mSoundItemID(),
    mAnimation(),
    mOutputString()
{ }

LLGesture::LLGesture(KEY key, MASK mask, const std::string &trigger,
                     const LLUUID &sound_item_id,
                     const std::string &animation,
                     const std::string &output_string)
:
    mKey(key),
    mMask(mask),
    mTrigger(trigger),
    mTriggerLower(trigger),
    mSoundItemID(sound_item_id),
    mAnimation(animation),
    mOutputString(output_string)
{
    mTriggerLower = utf8str_tolower(mTriggerLower);
}

LLGesture::LLGesture(U8 **buffer, S32 max_size)
{
    *buffer = deserialize(*buffer, max_size);
}

LLGesture::LLGesture(const LLGesture &rhs)
{
    mKey            = rhs.mKey;
    mMask           = rhs.mMask;
    mTrigger        = rhs.mTrigger;
    mTriggerLower   = rhs.mTriggerLower;
    mSoundItemID    = rhs.mSoundItemID;
    mAnimation      = rhs.mAnimation;
    mOutputString   = rhs.mOutputString;
}

const LLGesture &LLGesture::operator =(const LLGesture &rhs)
{
    mKey            = rhs.mKey;
    mMask           = rhs.mMask;
    mTrigger        = rhs.mTrigger;
    mTriggerLower   = rhs.mTriggerLower;
    mSoundItemID    = rhs.mSoundItemID;
    mAnimation      = rhs.mAnimation;
    mOutputString   = rhs.mOutputString;
    return (*this);
}


bool LLGesture::trigger(KEY key, MASK mask)
{
    LL_WARNS() << "Parent class trigger called: you probably didn't mean this." << LL_ENDL;
    return false;
}


bool LLGesture::trigger(const std::string& trigger_string)
{
    LL_WARNS() << "Parent class trigger called: you probably didn't mean this." << LL_ENDL;
    return false;
}

// NOT endian-neutral
U8 *LLGesture::serialize(U8 *buffer) const
{
    htolememcpy(buffer, &mKey, MVT_S8, 1);
    buffer += sizeof(mKey);
    htolememcpy(buffer, &mMask, MVT_U32, 4);
    buffer += sizeof(mMask);
    htolememcpy(buffer, mSoundItemID.mData, MVT_LLUUID, 16);
    buffer += 16;

    memcpy(buffer, mTrigger.c_str(), mTrigger.length() + 1);        /* Flawfinder: ignore */
    buffer += mTrigger.length() + 1;
    memcpy(buffer, mAnimation.c_str(), mAnimation.length() + 1);        /* Flawfinder: ignore */
    buffer += mAnimation.length() + 1;
    memcpy(buffer, mOutputString.c_str(), mOutputString.length() + 1);      /* Flawfinder: ignore */
    buffer += mOutputString.length() + 1;

    return buffer;
}

U8 *LLGesture::deserialize(U8 *buffer, S32 max_size)
{
    U8 *tmp = buffer;

    if (tmp + sizeof(mKey) + sizeof(mMask) + 16 > buffer + max_size)
    {
        LL_WARNS() << "Attempt to read past end of buffer, bad data!!!!" << LL_ENDL;
        return buffer;
    }

    htolememcpy(&mKey, tmp, MVT_S8, 1);
    tmp += sizeof(mKey);
    htolememcpy(&mMask, tmp, MVT_U32, 4);
    tmp += sizeof(mMask);
    htolememcpy(mSoundItemID.mData, tmp, MVT_LLUUID, 16);
    tmp += 16;

    mTrigger.assign((char *)tmp);
    mTriggerLower = mTrigger;
    mTriggerLower = utf8str_tolower(mTriggerLower);
    tmp += mTrigger.length() + 1;
    mAnimation.assign((char *)tmp);
    //RN: force animation names to lower case
    // must do this for backwards compatibility
    mAnimation = utf8str_tolower(mAnimation);
    tmp += mAnimation.length() + 1;
    mOutputString.assign((char *)tmp);
    tmp += mOutputString.length() + 1;

    if (tmp > buffer + max_size)
    {
        LL_WARNS() << "Read past end of buffer, bad data!!!!" << LL_ENDL;
        return tmp;
    }

    return tmp;
}

S32 LLGesture::getMaxSerialSize()
{
    return MAX_SERIAL_SIZE;
}

//---------------------------------------------------------------------
// LLGestureList
//---------------------------------------------------------------------

LLGestureList::LLGestureList()
:   mList(0)
{}

LLGestureList::~LLGestureList()
{
    deleteAll();
}


void LLGestureList::deleteAll()
{
    delete_and_clear(mList);
}

// Iterates through space delimited tokens in string, triggering any gestures found.
// Generates a revised string that has the found tokens replaced by their replacement strings
// and (as a minor side effect) has multiple spaces in a row replaced by single spaces.
bool LLGestureList::triggerAndReviseString(const std::string &string, std::string* revised_string)
{
    std::string tokenized = string;

    bool found_gestures = false;
    bool first_token = true;

    typedef boost::tokenizer<boost::char_separator<char> > tokenizer;
    boost::char_separator<char> sep(" ");
    tokenizer tokens(string, sep);

    for(const std::string& cur_token : tokens)
    {
        LLGesture* gesture = NULL;

        if( !found_gestures ) // Only pay attention to the first gesture in the string.
        {
            std::string cur_token_lower = cur_token;
            LLStringUtil::toLower(cur_token_lower);

            for (U32 i = 0; i < mList.size(); i++)
            {
                gesture = mList.at(i);
                if (gesture->trigger(cur_token_lower))
                {
                    if( !gesture->getOutputString().empty() )
                    {
                        if( !first_token )
                        {
                            revised_string->append( " " );
                        }

                        // Don't muck with the user's capitalization if we don't have to.
                        const std::string& output = gesture->getOutputString();
                        std::string output_lower = std::string(output.c_str());
                        LLStringUtil::toLower(output_lower);
                        if( cur_token_lower == output_lower )
                        {
                            revised_string->append(cur_token);
                        }
                        else
                        {
                            revised_string->append(output);
                        }

                    }
                    found_gestures = true;
                    break;
                }
                gesture = NULL;
            }
        }

        if( !gesture )
        {
            if( !first_token )
            {
                revised_string->append( " " );
            }
            revised_string->append( cur_token );
        }

        first_token = false;
    }
    return found_gestures;
}



bool LLGestureList::trigger(KEY key, MASK mask)
{
    for (U32 i = 0; i < mList.size(); i++)
    {
        LLGesture* gesture = mList.at(i);
        if( gesture )
        {
            if (gesture->trigger(key, mask))
            {
                return true;
            }
        }
        else
        {
            LL_WARNS() << "NULL gesture in gesture list (" << i << ")" << LL_ENDL;
        }
    }
    return false;
}

// NOT endian-neutral
U8 *LLGestureList::serialize(U8 *buffer) const
{
    // a single S32 serves as the header that tells us how many to read
    U32 count = mList.size();
    htolememcpy(buffer, &count, MVT_S32, 4);
    buffer += sizeof(count);

    for (S32 i = 0; i < count; i++)
    {
        buffer = mList[i]->serialize(buffer);
    }

    return buffer;
}

const S32 MAX_GESTURES = 4096;

U8 *LLGestureList::deserialize(U8 *buffer, S32 max_size)
{
    deleteAll();

    S32 count;
    U8 *tmp = buffer;

    if (tmp + sizeof(count) > buffer + max_size)
    {
        LL_WARNS() << "Invalid max_size" << LL_ENDL;
        return buffer;
    }

    htolememcpy(&count, tmp, MVT_S32, 4);

    if (count > MAX_GESTURES)
    {
        LL_WARNS() << "Unreasonably large gesture list count in deserialize: " << count << LL_ENDL;
        return tmp;
    }

    tmp += sizeof(count);

    mList.resize(count);

    for (S32 i = 0; i < count; i++)
    {
        mList[i] = create_gesture(&tmp, max_size - (S32)(tmp - buffer));
        if (tmp - buffer > max_size)
        {
            LL_WARNS() << "Deserialization read past end of buffer, bad data!!!!" << LL_ENDL;
            return tmp;
        }
    }

    return tmp;
}

// this is a helper for deserialize
// it gets overridden by LLViewerGestureList to create LLViewerGestures
// overridden by child class to use local LLGesture implementation
LLGesture *LLGestureList::create_gesture(U8 **buffer, S32 max_size)
{
    return new LLGesture(buffer, max_size);
}

S32 LLGestureList::getMaxSerialSize()
{
    return SERIAL_HEADER_SIZE + (count() * LLGesture::getMaxSerialSize());
}