summaryrefslogtreecommitdiff
path: root/indra/newview/llautoreplace.cpp
blob: e1d494f7c70d2b3471b109633b31015bb56279b3 (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
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
/**
 * @file llautoreplace.cpp
 * @brief Auto Replace Manager
 *
 * $LicenseInfo:firstyear=2012&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2012, 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; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * 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
 * $/LicenseInfo$
 */

#include "llviewerprecompiledheaders.h"
#include "llautoreplace.h"
#include "llsdserialize.h"
#include "llboost.h"
#include "llcontrol.h"
#include "llviewercontrol.h"
#include "llnotificationsutil.h"

const char* LLAutoReplace::SETTINGS_FILE_NAME = "autoreplace.xml";

void LLAutoReplace::autoreplaceCallback(S32& replacement_start, S32& replacement_length, LLWString& replacement_string, S32& cursor_pos, const LLWString& input_text)
{
    // make sure these returned values are cleared in case there is no replacement
    replacement_start = 0;
    replacement_length = 0;
    replacement_string.clear();

    static LLCachedControl<bool> perform_autoreplace(gSavedSettings, "AutoReplace", 0);
    if (perform_autoreplace)
    {
        S32 word_end = cursor_pos - 1;

        bool at_space  = (input_text[word_end] == ' ');
        bool have_word = (LLWStringUtil::isPartOfWord(input_text[word_end]));

        if (at_space || have_word)
        {
            if (at_space && word_end > 0)
            {
                // find out if this space immediately follows a word
                word_end--;
                have_word  = (LLWStringUtil::isPartOfWord(input_text[word_end]));
            }
            if (have_word)
            {
                // word_end points to the end of a word, now find the start of the word
                std::string word;
                S32 word_start = word_end;
                for (S32 back_one = word_start - 1;
                     back_one >= 0 && LLWStringUtil::isPartOfWord(input_text[back_one]);
                     back_one--
                    )
                {
                    word_start--; // walk word_start back to the beginning of the word
                }
                LL_DEBUGS("AutoReplace") << "word_start: " << word_start << " word_end: " << word_end << LL_ENDL;
                LLWString old_string = input_text.substr(word_start, word_end - word_start + 1);
                std::string last_word = wstring_to_utf8str(old_string);
                std::string replacement_word(mSettings.replaceWord(last_word));

                if (replacement_word != last_word)
                {
                    // The last word is one for which we have a replacement
                    if (at_space)
                    {
                        // return the replacement string
                        replacement_start = word_start;
                        replacement_length = word_end - word_start + 1;
                        replacement_string = utf8str_to_wstring(replacement_word);
                        S32 size_change = replacement_string.size() - old_string.size();
                        cursor_pos += size_change;
                    }
                }
            }
        }
    }
}

std::string LLAutoReplace::getUserSettingsFileName()
{
    std::string path=gDirUtilp->getExpandedFilename(LL_PATH_USER_SETTINGS, "");

    if (!path.empty())
    {
        path = gDirUtilp->getExpandedFilename(LL_PATH_USER_SETTINGS, SETTINGS_FILE_NAME);
    }
    return path;
}

std::string LLAutoReplace::getAppSettingsFileName()
{
    std::string path=gDirUtilp->getExpandedFilename(LL_PATH_APP_SETTINGS, "");

    if (!path.empty())
    {
        path = gDirUtilp->getExpandedFilename(LL_PATH_APP_SETTINGS, SETTINGS_FILE_NAME);
    }
    else
    {
        LL_ERRS("AutoReplace") << "Failed to get app settings directory name" << LL_ENDL;
    }
    return path;
}

LLAutoReplaceSettings LLAutoReplace::getSettings()
{
    return mSettings;
}

void LLAutoReplace::setSettings(const LLAutoReplaceSettings& newSettings)
{
    mSettings.set(newSettings);
    /// Make the newSettings active and write them to user storage
    saveToUserSettings();
}

LLAutoReplace::LLAutoReplace()
{
}

void LLAutoReplace::initSingleton()
{
    loadFromSettings();
}

void LLAutoReplace::loadFromSettings()
{
    std::string filename=getUserSettingsFileName();
    if (filename.empty())
    {
        LL_INFOS("AutoReplace") << "no valid user settings directory." << LL_ENDL;
    }
    if(gDirUtilp->fileExists(filename))
    {
        LLSD userSettings;
        llifstream file;
        file.open(filename.c_str());
        if (file.is_open())
        {
            LLSDSerialize::fromXML(userSettings, file);
        }
        file.close();
        if ( mSettings.setFromLLSD(userSettings) )
        {
            LL_INFOS("AutoReplace") << "settings loaded from '" << filename << "'" << LL_ENDL;
        }
        else
        {
            LL_WARNS("AutoReplace") << "invalid settings found in '" << filename << "'" << LL_ENDL;
        }
    }
    else // no user settings found, try application settings
    {
        std::string defaultName = getAppSettingsFileName();
        LL_INFOS("AutoReplace") << " user settings file '" << filename << "' not found"<< LL_ENDL;

        bool gotSettings = false;
        if(gDirUtilp->fileExists(defaultName))
        {
            LLSD appDefault;
            llifstream file;
            file.open(defaultName.c_str());
            if (file.is_open())
            {
                LLSDSerialize::fromXMLDocument(appDefault, file);
            }
            file.close();

            if ( mSettings.setFromLLSD(appDefault) )
            {
                LL_INFOS("AutoReplace") << "settings loaded from '" << defaultName.c_str() << "'" << LL_ENDL;
                gotSettings = true;
            }
            else
            {
                LL_WARNS("AutoReplace") << "invalid settings found in '" << defaultName.c_str() << "'" << LL_ENDL;
            }
        }

        if ( ! gotSettings )
        {
            if (mSettings.setFromLLSD(mSettings.getExampleLLSD()))
            {
                LL_WARNS("AutoReplace") << "no settings found; loaded example." << LL_ENDL;
            }
            else
            {
                LL_WARNS("AutoReplace") << "no settings found and example invalid!" << LL_ENDL;
            }
        }
    }
}

void LLAutoReplace::saveToUserSettings()
{
    std::string filename=getUserSettingsFileName();
    llofstream file;
    file.open(filename.c_str());
    LLSDSerialize::toPrettyXML(mSettings.asLLSD(), file);
    file.close();
    LL_INFOS("AutoReplace") << "settings saved to '" << filename << "'" << LL_ENDL;
}

// ================================================================
// LLAutoReplaceSettings
// ================================================================

const std::string LLAutoReplaceSettings::AUTOREPLACE_LIST_NAME         = "name";         ///< key for looking up list names
const std::string LLAutoReplaceSettings::AUTOREPLACE_LIST_REPLACEMENTS = "replacements"; ///< key for looking up replacement map

LLAutoReplaceSettings::LLAutoReplaceSettings()
{
}

LLAutoReplaceSettings::LLAutoReplaceSettings(const LLAutoReplaceSettings& settings)
{
    // copy all values through fundamental type intermediates for thread safety
    mLists = LLSD::emptyArray();

    for ( LLSD::array_const_iterator list = settings.mLists.beginArray(), listEnd = settings.mLists.endArray();
          list != listEnd;
          list++
         )
    {
        if ( (*list).isMap() ) // can fail due to LLSD-30: ignore it
        {
            LLSD listMap = LLSD::emptyMap();
            std::string listName = (*list)[AUTOREPLACE_LIST_NAME];
            listMap[AUTOREPLACE_LIST_NAME] = listName;
            listMap[AUTOREPLACE_LIST_REPLACEMENTS] = LLSD::emptyMap();

            for ( LLSD::map_const_iterator
                      entry = (*list)[AUTOREPLACE_LIST_REPLACEMENTS].beginMap(),
                      entriesEnd = (*list)[AUTOREPLACE_LIST_REPLACEMENTS].endMap();
                  entry != entriesEnd;
                  entry++
                 )
            {
                std::string keyword = entry->first;
                std::string replacement = entry->second.asString();
                listMap[AUTOREPLACE_LIST_REPLACEMENTS].insert(keyword, LLSD(replacement));
            }

            mLists.append(listMap);
        }
    }
}

void LLAutoReplaceSettings::set(const LLAutoReplaceSettings& newSettings)
{
    mLists = newSettings.mLists;
}

bool LLAutoReplaceSettings::setFromLLSD(const LLSD& settingsFromLLSD)
{
    bool settingsValid = true;

    if ( settingsFromLLSD.isArray() )
    {
        for ( LLSD::array_const_iterator
                  list = settingsFromLLSD.beginArray(),
                  listEnd = settingsFromLLSD.endArray();
              settingsValid && list != listEnd;
              list++
             )
        {
            if ( (*list).isDefined() ) // can be undef due to LLSD-30: ignore it
            {
                settingsValid = listIsValid(*list);
            }
        }
    }
    else
    {
        settingsValid = false;
        LL_WARNS("AutoReplace") << "settings are not an array" << LL_ENDL;
    }

    if ( settingsValid )
    {
        mLists = settingsFromLLSD;
    }
    else
    {
        LL_WARNS("AutoReplace") << "invalid settings discarded; using hard coded example" << LL_ENDL;
    }

    return settingsValid;
}

bool LLAutoReplaceSettings::listNameMatches( const LLSD& list, const std::string name )
{
    return list.isMap()
        && list.has(AUTOREPLACE_LIST_NAME)
        && list[AUTOREPLACE_LIST_NAME].asString() == name;
}

const LLSD* LLAutoReplaceSettings::getListEntries(std::string listName)
{
    const LLSD* returnedEntries = NULL;
    for( LLSD::array_const_iterator list = mLists.beginArray(), endList = mLists.endArray();
         returnedEntries == NULL && list != endList;
         list++
        )
    {
        const LLSD& thisList = *list;
        if ( listNameMatches(thisList, listName) )
        {
            returnedEntries = &thisList[AUTOREPLACE_LIST_REPLACEMENTS];
        }
    }
    return returnedEntries;
}

std::string LLAutoReplaceSettings::replacementFor(std::string keyword, std::string listName)
{
    std::string replacement;
    bool foundList = false;
    for( LLSD::array_const_iterator list = mLists.beginArray(), endList = mLists.endArray();
         ! foundList && list != endList;
         list++
        )
    {
        const LLSD& thisList = *list;
        if ( listNameMatches(thisList, listName) )
        {
            foundList = true; // whether there is a replacement or not, we're done
            if (   thisList.isMap()
                && thisList.has(AUTOREPLACE_LIST_REPLACEMENTS)
                && thisList[AUTOREPLACE_LIST_REPLACEMENTS].has(keyword)
                )
            {
                replacement = thisList[AUTOREPLACE_LIST_REPLACEMENTS][keyword].asString();
                LL_DEBUGS("AutoReplace")<<"'"<<keyword<<"' -> '"<<replacement<<"'"<<LL_ENDL;
            }
        }
        if (!foundList)
        {
            LL_WARNS("AutoReplace")<<"failed to find list '"<<listName<<"'"<<LL_ENDL;
        }
    }
    if (replacement.empty())
    {
        LL_WARNS("AutoReplace")<<"failed to find '"<<keyword<<"'"<<LL_ENDL;
    }
    return replacement;
}

LLSD LLAutoReplaceSettings::getListNames()
{
    LL_DEBUGS("AutoReplace")<<"====="<<LL_ENDL;
    LLSD toReturn = LLSD::emptyArray();
    S32 counter=0;
    for( LLSD::array_const_iterator list = mLists.beginArray(), endList = mLists.endArray();
         list != endList;
         list++
        )
    {
        const LLSD& thisList = *list;
        if ( thisList.isMap() )
        {
            if ( thisList.has(AUTOREPLACE_LIST_NAME) )
            {
                std::string name = thisList[AUTOREPLACE_LIST_NAME].asString();
                LL_DEBUGS("AutoReplace")<<counter<<" '"<<name<<"'"<<LL_ENDL;
                toReturn.append(LLSD(name));
            }
            else
            {
                LL_ERRS("AutoReplace") <<counter<<" ! MISSING "<<AUTOREPLACE_LIST_NAME<< LL_ENDL;
            }
        }
        else
        {
            LL_WARNS("AutoReplace")<<counter<<" ! not a map: "<<LLSD::typeString(thisList.type())<< LL_ENDL;
        }
        counter++;
    }
    LL_DEBUGS("AutoReplace")<<"^^^^^^"<<LL_ENDL;
    return toReturn;
}

bool LLAutoReplaceSettings::listIsValid(const LLSD& list)
{
    bool listValid = true;
    if ( ! list.isMap() )
    {
        listValid = false;
        LL_WARNS("AutoReplace") << "list is not a map" << LL_ENDL;
    }
    else if (   ! list.has(AUTOREPLACE_LIST_NAME)
             || ! list[AUTOREPLACE_LIST_NAME].isString()
             || list[AUTOREPLACE_LIST_NAME].asString().empty()
             )
    {
        listValid = false;
        LL_WARNS("AutoReplace")
            << "list found without " << AUTOREPLACE_LIST_NAME
            << " (or it is empty)"
            << LL_ENDL;
    }
    else if ( ! list.has(AUTOREPLACE_LIST_REPLACEMENTS) || ! list[AUTOREPLACE_LIST_REPLACEMENTS].isMap() )
    {
        listValid = false;
        LL_WARNS("AutoReplace") << "list '" << list[AUTOREPLACE_LIST_NAME].asString() << "' without " << AUTOREPLACE_LIST_REPLACEMENTS << LL_ENDL;
    }
    else
    {
        for ( LLSD::map_const_iterator
                  entry = list[AUTOREPLACE_LIST_REPLACEMENTS].beginMap(),
                  entriesEnd = list[AUTOREPLACE_LIST_REPLACEMENTS].endMap();
              listValid && entry != entriesEnd;
              entry++
             )
        {
            if ( ! entry->second.isString() )
            {
                listValid = false;
                LL_WARNS("AutoReplace")
                    << "non-string replacement value found in list '"
                    << list[AUTOREPLACE_LIST_NAME].asString() << "'"
                    << LL_ENDL;
            }
        }
    }

    return listValid;
}

const LLSD* LLAutoReplaceSettings::exportList(std::string listName)
{
    const LLSD* exportedList = NULL;
    for ( LLSD::array_const_iterator list = mLists.beginArray(), listEnd = mLists.endArray();
          exportedList == NULL && list != listEnd;
          list++
         )
    {
        if ( listNameMatches(*list, listName) )
        {
            const LLSD& namedList = (*list);
            exportedList = &namedList;
        }
    }
    return exportedList;
}

bool LLAutoReplaceSettings::listNameIsUnique(const LLSD& newList)
{
    bool nameIsUnique = true;
    // this must always be called with a valid list, so it is safe to assume it has a name
    std::string newListName = newList[AUTOREPLACE_LIST_NAME].asString();
    for ( LLSD::array_const_iterator list = mLists.beginArray(), listEnd = mLists.endArray();
          nameIsUnique && list != listEnd;
          list++
         )
    {
        if ( listNameMatches(*list, newListName) )
        {
            LL_WARNS("AutoReplace")<<"duplicate list name '"<<newListName<<"'"<<LL_ENDL;
            nameIsUnique = false;
        }
    }
    return nameIsUnique;
}

/* static */
void LLAutoReplaceSettings::createEmptyList(LLSD& emptyList)
{
    emptyList = LLSD::emptyMap();
    emptyList[AUTOREPLACE_LIST_NAME] = "Empty";
    emptyList[AUTOREPLACE_LIST_REPLACEMENTS] = LLSD::emptyMap();
}

/* static */
void LLAutoReplaceSettings::setListName(LLSD& list, const std::string& newName)
{
    list[AUTOREPLACE_LIST_NAME] = newName;
}

/* static */
std::string LLAutoReplaceSettings::getListName(LLSD& list)
{
    std::string name;
    if ( list.isMap() && list.has(AUTOREPLACE_LIST_NAME) && list[AUTOREPLACE_LIST_NAME].isString() )
    {
        name = list[AUTOREPLACE_LIST_NAME].asString();
    }
    return name;
}

LLAutoReplaceSettings::AddListResult LLAutoReplaceSettings::addList(const LLSD& newList)
{
    AddListResult result;
    if ( listIsValid( newList ) )
    {
        if ( listNameIsUnique( newList ) )
        {
            mLists.append(newList);
            result = AddListOk;
        }
        else
        {
            LL_WARNS("AutoReplace") << "attempt to add duplicate name" << LL_ENDL;
            result = AddListDuplicateName;
        }
    }
    else
    {
        LL_WARNS("AutoReplace") << "attempt to add invalid list" << LL_ENDL;
        result = AddListInvalidList;
    }
    return result;
}

LLAutoReplaceSettings::AddListResult LLAutoReplaceSettings::replaceList(const LLSD& newList)
{
    AddListResult result = AddListInvalidList;
    if ( listIsValid( newList ) )
    {
        std::string listName = newList[AUTOREPLACE_LIST_NAME].asString();
        bool listFound = false;
        S32 search_index;
        LLSD targetList;
        // The following is working around the fact that LLSD arrays containing maps also seem to have undefined entries... see LLSD-30
        for ( search_index = 0, targetList = mLists[0];
              !listFound && search_index < mLists.size();
              search_index += 1, targetList = mLists[search_index]
             )
        {
            if ( targetList.isMap() )
            {
                if ( listNameMatches( targetList, listName) )
                {
                    LL_DEBUGS("AutoReplace")<<"list to replace found at "<<search_index<<LL_ENDL;
                    mLists.erase(search_index);
                    mLists.insert(search_index, newList);
                    listFound = true;
                    result = AddListOk;
                }
            }
        }

        if ( ! listFound )
        {
            LL_WARNS("AutoReplace") << "attempt to replace unconfigured list" << LL_ENDL;
        }
    }
    else
    {
        LL_WARNS("AutoReplace") << "attempt to add invalid list" << LL_ENDL;
    }
    return result;
}

bool LLAutoReplaceSettings::removeReplacementList(std::string listName)
{
    bool found = false;
    for( S32 index = 0; !found && mLists[index].isDefined(); index++ )
    {
        if( listNameMatches(mLists.get(index), listName) )
        {
            LL_DEBUGS("AutoReplace")<<"list '"<<listName<<"'"<<LL_ENDL;
            mLists.erase(index);
            found = true;
        }
    }
    return found;
}

/// Move the named list up in the priority order
bool LLAutoReplaceSettings::increaseListPriority(std::string listName)
{
    LL_DEBUGS("AutoReplace")<<listName<<LL_ENDL;
    bool found = false;
    S32 search_index, previous_index;
    LLSD targetList;
    // The following is working around the fact that LLSD arrays containing maps also seem to have undefined entries... see LLSD-30
    previous_index = -1;
    for ( search_index = 0, targetList = mLists[0];
          !found && search_index < mLists.size();
          search_index += 1, targetList = mLists[search_index]
         )
    {
        if ( targetList.isMap() )
        {
            if ( listNameMatches( targetList, listName) )
            {
                LL_DEBUGS("AutoReplace")<<"found at "<<search_index<<", previous is "<<previous_index<<LL_ENDL;
                found = true;
                if (previous_index >= 0)
                {
                    LL_DEBUGS("AutoReplace") << "erase "<<search_index<<LL_ENDL;
                    mLists.erase(search_index);
                    LL_DEBUGS("AutoReplace") << "insert at "<<previous_index<<LL_ENDL;
                    mLists.insert(previous_index, targetList);
                }
                else
                {
                    LL_WARNS("AutoReplace") << "attempted to move top list up" << LL_ENDL;
                }
            }
            else
            {
                previous_index = search_index;
            }
        }
        else
        {
            LL_DEBUGS("AutoReplace") << search_index<<" is "<<LLSD::typeString(targetList.type())<<LL_ENDL;
        }
    }
    return found;
}

/// Move the named list down in the priority order
bool LLAutoReplaceSettings::decreaseListPriority(std::string listName)
{
    LL_DEBUGS("AutoReplace")<<listName<<LL_ENDL;
    S32 found_index = -1;
    S32 search_index;
    for ( search_index = 0;
          found_index == -1 && search_index < mLists.size();
          search_index++
         )
    {
        if ( listNameMatches( mLists[search_index], listName) )
        {
            LL_DEBUGS("AutoReplace")<<"found at index "<<search_index<<LL_ENDL;
            found_index = search_index;
        }
    }
    if (found_index != -1)
    {
        S32 next_index;
        for ( next_index = found_index+1;
              next_index < mLists.size() && ! mLists[next_index].isMap();
              next_index++
             )
        {
            // skipping over any undefined slots (see LLSD-30)
            LL_WARNS("AutoReplace")<<next_index<<" ! not a map: "<<LLSD::typeString(mLists[next_index].type())<< LL_ENDL;
        }
        if ( next_index < mLists.size() )
        {
            LLSD next_list = mLists[next_index];
            LL_DEBUGS("AutoReplace") << "erase "<<next_index<<LL_ENDL;
            mLists.erase(next_index);
            LL_DEBUGS("AutoReplace") << "insert at "<<found_index<<LL_ENDL;
            mLists.insert(found_index, next_list);
        }
        else
        {
            LL_WARNS("AutoReplace") << "attempted to move bottom list down" << LL_ENDL;
        }
    }
    else
    {
        LL_WARNS("AutoReplace") << "not found" << LL_ENDL;
    }
    return (found_index != -1);
}


std::string LLAutoReplaceSettings::replaceWord(const std::string currentWord)
{
    std::string returnedWord = currentWord; // in case no replacement is found
    static LLCachedControl<bool> autoreplace_enabled(gSavedSettings, "AutoReplace", false);
    if ( autoreplace_enabled )
    {
        LL_DEBUGS("AutoReplace")<<"checking '"<<currentWord<<"'"<< LL_ENDL;
        //loop through lists in order
        bool found = false;
        for( LLSD::array_const_iterator list = mLists.beginArray(), endLists = mLists.endArray();
             ! found && list != endLists;
             list++
            )
        {
            const LLSD& checkList = *list;
            const LLSD& replacements = checkList[AUTOREPLACE_LIST_REPLACEMENTS];

            if ( replacements.has(currentWord) )
            {
                found = true;
                LL_DEBUGS("AutoReplace")
                    << "  found in list '" << checkList[AUTOREPLACE_LIST_NAME].asString()
                    << " => '" << replacements[currentWord].asString() << "'"
                    << LL_ENDL;
                returnedWord = replacements[currentWord].asString();
            }
        }
    }
    return returnedWord;
}

bool LLAutoReplaceSettings::addEntryToList(LLWString keyword, LLWString replacement, std::string listName)
{
    bool added = false;

    if ( ! keyword.empty() && ! replacement.empty() )
    {
        bool isOneWord = true;
        for (S32 character = 0; isOneWord && character < keyword.size(); character++ )
        {
            if ( ! LLWStringUtil::isPartOfWord(keyword[character]) )
            {
                LL_WARNS("AutoReplace") << "keyword '" << wstring_to_utf8str(keyword) << "' not a single word (len "<<keyword.size()<<" '"<<character<<"')" << LL_ENDL;
                isOneWord = false;
            }
        }

        if ( isOneWord )
        {
            bool listFound = false;
            for( LLSD::array_iterator list = mLists.beginArray(), endLists = mLists.endArray();
                 ! listFound && list != endLists;
                 list++
                )
            {
                if ( listNameMatches(*list, listName) )
                {
                    listFound = true;
                    (*list)[AUTOREPLACE_LIST_REPLACEMENTS][wstring_to_utf8str(keyword)]=wstring_to_utf8str(replacement);
                }
            }
            if (listFound)
            {
                added = true;
            }
            else
            {
                LL_WARNS("AutoReplace") << "list '" << listName << "' not found" << LL_ENDL;
            }
        }
    }

    return added;
}

bool LLAutoReplaceSettings::removeEntryFromList(std::string keyword, std::string listName)
{
    bool found = false;
    for( LLSD::array_iterator list = mLists.beginArray(), endLists = mLists.endArray();
         ! found && list != endLists;
         list++
        )
    {
        if ( listNameMatches(*list, listName) )
        {
            found = true;
            (*list)[AUTOREPLACE_LIST_REPLACEMENTS].erase(keyword);
        }
    }
    if (!found)
    {
        LL_WARNS("AutoReplace") << "list '" << listName << "' not found" << LL_ENDL;
    }
    return found;
}

LLSD LLAutoReplaceSettings::getExampleLLSD()
{
    LL_DEBUGS("AutoReplace")<<LL_ENDL;
    LLSD example = LLSD::emptyArray();

    example[0] = LLSD::emptyMap();
    example[0][AUTOREPLACE_LIST_NAME]    = "Example List 1";
    example[0][AUTOREPLACE_LIST_REPLACEMENTS]    = LLSD::emptyMap();
    example[0][AUTOREPLACE_LIST_REPLACEMENTS]["keyword1"] = "replacement string 1";
    example[0][AUTOREPLACE_LIST_REPLACEMENTS]["keyword2"] = "replacement string 2";

    example[1] = LLSD::emptyMap();
    example[1][AUTOREPLACE_LIST_NAME]    = "Example List 2";
    example[1][AUTOREPLACE_LIST_REPLACEMENTS]    = LLSD::emptyMap();
    example[1][AUTOREPLACE_LIST_REPLACEMENTS]["mistake1"] = "correction 1";
    example[1][AUTOREPLACE_LIST_REPLACEMENTS]["mistake2"] = "correction 2";

    return example;
}

const LLSD& LLAutoReplaceSettings::asLLSD()
{
    return mLists;
}

LLAutoReplaceSettings::~LLAutoReplaceSettings()
{
}