summaryrefslogtreecommitdiff
path: root/indra/newview/lllogchat.cpp
blob: 4b650aeebe7ab920a708c2ec76bf0f9fa5223366 (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
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
/**
 * @file lllogchat.cpp
 * @brief LLLogChat class implementation
 *
 * $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 "llviewerprecompiledheaders.h"
#include "llfloaterconversationpreview.h"
#include "llagent.h"
#include "llagentui.h"
#include "llavatarnamecache.h"
#include "lllogchat.h"
#include "llregex.h"
#include "lltrans.h"
#include "llviewercontrol.h"

#include "lldiriterator.h"
#include "llfloaterimsessiontab.h"
#include "llinstantmessage.h"
#include "llsingleton.h" // for LLSingleton

#include <boost/algorithm/string/trim.hpp>
#include <boost/algorithm/string/replace.hpp>
#include <boost/regex.hpp>

#if LL_MSVC
#pragma warning(push)
// disable warning about boost::lexical_cast unreachable code
// when it fails to parse the string
#pragma warning (disable:4702)
#endif

#include <boost/date_time/gregorian/gregorian.hpp>
#if LL_MSVC
#pragma warning(pop)   // Restore all warnings to the previous state
#endif

#include <boost/date_time/posix_time/posix_time.hpp>
#include <boost/date_time/local_time_adjustor.hpp>

const S32 LOG_RECALL_SIZE = 20480;

const std::string LL_IM_TIME("time");
const std::string LL_IM_DATE_TIME("datetime");
const std::string LL_IM_TEXT("message");
const std::string LL_IM_FROM("from");
const std::string LL_IM_FROM_ID("from_id");
const std::string LL_TRANSCRIPT_FILE_EXTENSION("txt");

const std::string GROUP_CHAT_SUFFIX(" (group)");

const static char IM_SYMBOL_SEPARATOR(':');
const static std::string IM_SEPARATOR(std::string() + IM_SYMBOL_SEPARATOR + " ");
const static std::string NEW_LINE("\n");
const static std::string NEW_LINE_SPACE_PREFIX("\n ");
const static std::string TWO_SPACES("  ");
const static std::string MULTI_LINE_PREFIX(" ");

/**
 *  Chat log lines - timestamp and name are optional but message text is mandatory.
 *
 *  Typical plain text chat log lines:
 *
 *  SuperCar: You aren't the owner
 *  [2:59]  SuperCar: You aren't the owner
 *  [2009/11/20 3:00]  SuperCar: You aren't the owner
 *  Katar Ivercourt is Offline
 *  [3:00]  Katar Ivercourt is Offline
 *  [2009/11/20 3:01]  Corba ProductEngine is Offline
 *
 * Note: "You" was used as an avatar names in viewers of previous versions
 */
const static boost::regex TIMESTAMP_AND_STUFF("^(\\[\\d{4}/\\d{1,2}/\\d{1,2}\\s+\\d{1,2}:\\d{2}\\]\\s+|\\[\\d{1,2}:\\d{2}\\]\\s+)?(.*)$");
const static boost::regex TIMESTAMP("^(\\[\\d{4}/\\d{1,2}/\\d{1,2}\\s+\\d{1,2}:\\d{2}\\]|\\[\\d{1,2}:\\d{2}\\]).*");

/**
 *  Regular expression suitable to match names like
 *  "You", "Second Life", "Igor ProductEngine", "Object", "Mega House"
 */
const static boost::regex NAME_AND_TEXT("([^:]+[:]{1})?(\\s*)(.*)");

/**
 * These are recognizers for matching the names of ad-hoc conferences when generating the log file name
 * On invited side, an ad-hoc is named like "<first name> <last name> Conference 2010/11/19 03:43 f0f4"
 * On initiating side, an ad-hoc is named like Ad-hoc Conference hash<hash>"
 * If the naming system for ad-hoc conferences are change in LLIMModel::LLIMSession::buildHistoryFileName()
 * then these definition need to be adjusted as well.
 */
const static boost::regex INBOUND_CONFERENCE("^[a-zA-Z]{1,31} [a-zA-Z]{1,31} Conference [0-9]{4}/[0-9]{2}/[0-9]{2} [0-9]{2}:[0-9]{2} [0-9a-f]{4}");
const static boost::regex OUTBOUND_CONFERENCE("^Ad-hoc Conference hash[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}");

//is used to parse complex object names like "Xstreet SL Terminal v2.2.5 st"
const static std::string NAME_TEXT_DIVIDER(": ");

// is used for timestamps adjusting
const static char* DATE_FORMAT("%Y/%m/%d %H:%M");
const static char* TIME_FORMAT("%H:%M");

const static int IDX_TIMESTAMP = 1;
const static int IDX_STUFF = 2;
const static int IDX_NAME = 1;
const static int IDX_TEXT = 3;

using namespace boost::posix_time;
using namespace boost::gregorian;

void append_to_last_message(std::list<LLSD>& messages, const std::string& line)
{
    if (!messages.size()) return;

    std::string im_text = messages.back()[LL_IM_TEXT].asString();
    im_text.append(line);
    messages.back()[LL_IM_TEXT] = im_text;
}

const char* remove_utf8_bom(const char* buf)
{
    const char* start = buf;
    if (start[0] == (char)0xEF && start[1] == (char)0xBB && start[2] == (char)0xBF)
    {   // If string starts with the magic bytes, return pointer after it.
        start += 3;
    }
    return start;
}

class LLLogChatTimeScanner: public LLSingleton<LLLogChatTimeScanner>
{
    LLSINGLETON(LLLogChatTimeScanner);

public:
    date getTodayPacificDate()
    {
        typedef boost::date_time::local_adjustor<ptime, -8, no_dst> pst;
        typedef boost::date_time::local_adjustor<ptime, -7, no_dst> pdt;
        time_t t_time = time(NULL);
        ptime p_time = LLStringOps::getPacificDaylightTime()
            ? pdt::utc_to_local(from_time_t(t_time))
            : pst::utc_to_local(from_time_t(t_time));
        struct tm s_tm = to_tm(p_time);
        return date_from_tm(s_tm);
    }

    void checkAndCutOffDate(std::string& time_str)
    {
        // Cuts off the "%Y/%m/%d" from string for todays timestamps.
        // Assume that passed string has at least "%H:%M" time format.
        date log_date(not_a_date_time);
        date today(getTodayPacificDate());

        // Parse the passed date
        mDateStream.str(LLStringUtil::null);
        mDateStream << time_str;
        mDateStream >> log_date;
        mDateStream.clear();

        days zero_days(0);
        days days_alive = today - log_date;

        if ( days_alive == zero_days )
        {
            // Yep, today's so strip "%Y/%m/%d" info
            ptime stripped_time(not_a_date_time);

            mTimeStream.str(LLStringUtil::null);
            mTimeStream << time_str;
            mTimeStream >> stripped_time;
            mTimeStream.clear();

            time_str.clear();

            mTimeStream.str(LLStringUtil::null);
            mTimeStream << stripped_time;
            mTimeStream >> time_str;
            mTimeStream.clear();
        }

        LL_DEBUGS("LLChatLogParser")
            << " log_date: "
            << log_date
            << " today: "
            << today
            << " days alive: "
            << days_alive
            << " new time: "
            << time_str
            << LL_ENDL;
    }


private:
    std::stringstream mDateStream;
    std::stringstream mTimeStream;
};

inline
LLLogChatTimeScanner::LLLogChatTimeScanner()
{
    // Note, date/time facets will be destroyed by string streams
    mDateStream.imbue(std::locale(mDateStream.getloc(), new date_input_facet(DATE_FORMAT)));
    mTimeStream.imbue(std::locale(mTimeStream.getloc(), new time_facet(TIME_FORMAT)));
    mTimeStream.imbue(std::locale(mTimeStream.getloc(), new time_input_facet(DATE_FORMAT)));
}

LLLogChat::LLLogChat()
: mSaveHistorySignal(NULL) // only needed in preferences
{
    mHistoryThreadsMutex = new LLMutex();
}

LLLogChat::~LLLogChat()
{
    delete mHistoryThreadsMutex;
    mHistoryThreadsMutex = NULL;

    if (mSaveHistorySignal)
    {
        mSaveHistorySignal->disconnect_all_slots();
        delete mSaveHistorySignal;
        mSaveHistorySignal = NULL;
    }
}


//static
std::string LLLogChat::makeLogFileName(std::string filename)
{
    /**
     * Testing for in bound and out bound ad-hoc file names
     * if it is then skip date stamping.
     **/

    boost::match_results<std::string::const_iterator> matches;
    bool inboundConf = ll_regex_match(filename, matches, INBOUND_CONFERENCE);
    bool outboundConf = ll_regex_match(filename, matches, OUTBOUND_CONFERENCE);
    if (!(inboundConf || outboundConf))
    {
        if( gSavedPerAccountSettings.getBOOL("LogFileNamewithDate") )
        {
            time_t now;
            time(&now);
            char dbuffer[20];       /* Flawfinder: ignore */
            if (filename == "chat")
            {
                strftime(dbuffer, 20, "-%Y-%m-%d", localtime(&now));
            }
            else
            {
                strftime(dbuffer, 20, "-%Y-%m", localtime(&now));
            }
            filename += dbuffer;
        }
    }

    filename = cleanFileName(filename);
    filename = gDirUtilp->getExpandedFilename(LL_PATH_PER_ACCOUNT_CHAT_LOGS, filename);
    if (!filename.empty())
    {
        filename += '.' + LL_TRANSCRIPT_FILE_EXTENSION;
    }

    return filename;
}

//static
void LLLogChat::renameLogFile(const std::string& old_filename, const std::string& new_filename)
{
    std::string new_name = cleanFileName(new_filename);
    std::string old_name = cleanFileName(old_filename);
    new_name = gDirUtilp->getExpandedFilename(LL_PATH_PER_ACCOUNT_CHAT_LOGS, new_name);
    old_name = gDirUtilp->getExpandedFilename(LL_PATH_PER_ACCOUNT_CHAT_LOGS, old_name);

    if (new_name.empty() || old_name.empty())
    {
        return;
    }

    new_name += '.' + LL_TRANSCRIPT_FILE_EXTENSION;
    old_name += '.' + LL_TRANSCRIPT_FILE_EXTENSION;

    if (!LLFile::isfile(new_name) && LLFile::isfile(old_name))
    {
        LLFile::rename(old_name, new_name);
    }
}

std::string LLLogChat::cleanFileName(std::string filename)
{
    std::string invalidChars = "\"\'\\/?*:.<>|[]{}~"; // Cannot match glob or illegal filename chars
    std::string::size_type position = filename.find_first_of(invalidChars);
    while (position != filename.npos)
    {
        filename[position] = '_';
        position = filename.find_first_of(invalidChars, position);
    }
    return filename;
}

std::string LLLogChat::timestamp2LogString(U32 timestamp, bool withdate)
{
    std::string timeStr;
    if (withdate)
    {
        timeStr = "[" + LLTrans::getString ("TimeYear") + "]/["
                  + LLTrans::getString ("TimeMonth") + "]/["
                  + LLTrans::getString ("TimeDay") + "] ["
                  + LLTrans::getString ("TimeHour") + "]:["
                  + LLTrans::getString ("TimeMin") + "]";
    }
    else
    {
        timeStr = "[" + LLTrans::getString("TimeHour") + "]:["
                  + LLTrans::getString ("TimeMin")+"]";
    }

    LLSD substitution;
    if (timestamp == 0)
    {
        substitution["datetime"] = (S32)time_corrected();
    }
    else
    {   // timestamp is correct utc already
        substitution["datetime"] = (S32)timestamp;
    }

    LLStringUtil::format (timeStr, substitution);
    return timeStr;
}


//static
void LLLogChat::saveHistory(const std::string& filename,
                            const std::string& from,
                            const LLUUID& from_id,
                            const std::string& line)
{
    std::string tmp_filename = filename;
    LLStringUtil::trim(tmp_filename);
    if (tmp_filename.empty())
    {
        std::string warn = "Chat history filename [" + filename + "] is empty!";
        LL_WARNS() << warn << LL_ENDL;
        llassert(tmp_filename.size());
        return;
    }

    llofstream file(LLLogChat::makeLogFileName(filename).c_str(), std::ios_base::app);
    if (!file.is_open())
    {
        LL_WARNS() << "Couldn't open chat history log! - " + filename << LL_ENDL;
        return;
    }

    LLSD item;

    if (gSavedPerAccountSettings.getBOOL("LogTimestamp"))
         item["time"] = LLLogChat::timestamp2LogString(0, gSavedPerAccountSettings.getBOOL("LogTimestampDate"));

    item["from_id"] = from_id;
    item["message"] = line;

    //adding "Second Life:" for all system messages to make chat log history parsing more reliable
    if (from.empty() && from_id.isNull())
    {
        item["from"] = SYSTEM_FROM;
    }
    else
    {
        item["from"] = from;
    }

    file << LLChatLogFormatter(item) << std::endl;

    file.close();

    LLLogChat::getInstance()->triggerHistorySignal();
}

// static
void LLLogChat::loadChatHistory(const std::string& file_name, std::list<LLSD>& messages, const LLSD& load_params, bool is_group)
{
    if (file_name.empty())
    {
        LL_WARNS("LLLogChat::loadChatHistory") << "Local history file name is empty!" << LL_ENDL;
        return ;
    }

    bool load_all_history = load_params.has("load_all_history") ? load_params["load_all_history"].asBoolean() : false;

    // Stat the file to find it and get the last history entry time
    llstat stat_data;

    std::string log_file_name = LLLogChat::makeLogFileName(file_name);
    LL_DEBUGS("ChatHistory") << "First attempt to stat chat history file " << log_file_name << LL_ENDL;

    S32 no_stat = LLFile::stat(log_file_name, &stat_data);

    if (no_stat)
    {
        if (is_group)
        {
            std::string old_name(file_name);
            old_name.erase(old_name.size() - GROUP_CHAT_SUFFIX.size());     // trim off " (group)"
            log_file_name = LLLogChat::makeLogFileName(old_name);
            LL_DEBUGS("ChatHistory") << "Attempting to stat adjusted chat history file " << log_file_name << LL_ENDL;
            no_stat = LLFile::stat(log_file_name, &stat_data);
            if (!no_stat)
            {   // Found it without "(group)", copy to new naming style.  We already have the mod time in stat_data
                log_file_name = LLLogChat::makeLogFileName(file_name);
                LL_DEBUGS("ChatHistory") << "Attempt to stat copied history file " << log_file_name << LL_ENDL;
                LLFile::copy(LLLogChat::makeLogFileName(old_name), log_file_name);
            }
        }
        if (no_stat)
        {
            log_file_name = LLLogChat::oldLogFileName(file_name);
            LL_DEBUGS("ChatHistory") << "Attempt to stat old history file name " << log_file_name << LL_ENDL;
            no_stat = LLFile::stat(log_file_name, &stat_data);
            if (no_stat)
            {
                LL_DEBUGS("ChatHistory") << "No previous conversation log file found for " << file_name << LL_ENDL;
                return;                     //No previous conversation with this name.
            }
        }
    }

    // If we got here, we managed to stat the file.
    // Open the file to read
    LLFILE* fptr = LLFile::fopen(log_file_name, "r");       /*Flawfinder: ignore*/
    if (!fptr)
    {   // Ok, this is strange but not really tragic in the big picture of things
        LL_WARNS("ChatHistory") << "Unable to read file " << log_file_name << " after stat was successful" << LL_ENDL;
        return;
    }

    S32 save_num_messages = messages.size();

    char buffer[LOG_RECALL_SIZE];       /*Flawfinder: ignore*/
    char *bptr;
    S32 len;
    bool firstline = TRUE;

    if (load_all_history || fseek(fptr, (LOG_RECALL_SIZE - 1) * -1  , SEEK_END))
    {   //We need to load the whole historyFile or it's smaller than recall size, so get it all.
        firstline = FALSE;
        if (fseek(fptr, 0, SEEK_SET))
        {
            fclose(fptr);
            return;
        }
    }
    while (fgets(buffer, LOG_RECALL_SIZE, fptr)  && !feof(fptr))
    {
        len = strlen(buffer) - 1;       /*Flawfinder: ignore*/
        // backfill any end of line characters with nulls
        for (bptr = (buffer + len); (*bptr == '\n' || *bptr == '\r') && bptr>buffer; bptr--)    *bptr='\0';

        if (firstline)
        {
            firstline = FALSE;
            continue;
        }

        std::string line(remove_utf8_bom(buffer));

        //updated 1.23 plain text log format requires a space added before subsequent lines in a multilined message
        if (' ' == line[0])
        {
            line.erase(0, MULTI_LINE_PREFIX.length());
            append_to_last_message(messages, '\n' + line);
        }
        else if (0 == len && ('\n' == line[0] || '\r' == line[0]))
        {
            //to support old format's multilined messages with new lines used to divide paragraphs
            append_to_last_message(messages, line);
        }
        else
        {
            LLSD item;
            if (!LLChatLogParser::parse(line, item, load_params))
            {
                item[LL_IM_TEXT] = line;
            }
            messages.push_back(item);
        }
    }
    fclose(fptr);

    LL_DEBUGS("ChatHistory") << "Read " << (messages.size() - save_num_messages)
        << " messages of chat history from " << log_file_name
        << " file mod time " << (F64)stat_data.st_mtime << LL_ENDL;
}

bool LLLogChat::historyThreadsFinished(LLUUID session_id)
{
    LLMutexLock lock(historyThreadsMutex());
    bool finished = true;
    std::map<LLUUID,LLLoadHistoryThread *>::iterator it = mLoadHistoryThreads.find(session_id);
    if (it != mLoadHistoryThreads.end())
    {
        finished = it->second->isFinished();
    }
    if (!finished)
    {
        return false;
    }
    std::map<LLUUID,LLDeleteHistoryThread *>::iterator dit = mDeleteHistoryThreads.find(session_id);
    if (dit != mDeleteHistoryThreads.end())
    {
        finished = finished && dit->second->isFinished();
    }
    return finished;
}

LLLoadHistoryThread* LLLogChat::getLoadHistoryThread(LLUUID session_id)
{
    LLMutexLock lock(historyThreadsMutex());
    std::map<LLUUID,LLLoadHistoryThread *>::iterator it = mLoadHistoryThreads.find(session_id);
    if (it != mLoadHistoryThreads.end())
    {
        return it->second;
    }
    return NULL;
}

LLDeleteHistoryThread* LLLogChat::getDeleteHistoryThread(LLUUID session_id)
{
    LLMutexLock lock(historyThreadsMutex());
    std::map<LLUUID,LLDeleteHistoryThread *>::iterator it = mDeleteHistoryThreads.find(session_id);
    if (it != mDeleteHistoryThreads.end())
    {
        return it->second;
    }
    return NULL;
}

bool LLLogChat::addLoadHistoryThread(LLUUID& session_id, LLLoadHistoryThread* lthread)
{
    LLMutexLock lock(historyThreadsMutex());
    std::map<LLUUID,LLLoadHistoryThread *>::const_iterator it = mLoadHistoryThreads.find(session_id);
    if (it != mLoadHistoryThreads.end())
    {
        return false;
    }
    mLoadHistoryThreads[session_id] = lthread;
    return true;
}

bool LLLogChat::addDeleteHistoryThread(LLUUID& session_id, LLDeleteHistoryThread* dthread)
{
    LLMutexLock lock(historyThreadsMutex());
    std::map<LLUUID,LLDeleteHistoryThread *>::const_iterator it = mDeleteHistoryThreads.find(session_id);
    if (it != mDeleteHistoryThreads.end())
    {
        return false;
    }
    mDeleteHistoryThreads[session_id] = dthread;
    return true;
}

void LLLogChat::cleanupHistoryThreads()
{
    LLMutexLock lock(historyThreadsMutex());
    std::vector<LLUUID> uuids;
    std::map<LLUUID,LLLoadHistoryThread *>::iterator lit = mLoadHistoryThreads.begin();
    for (; lit != mLoadHistoryThreads.end(); lit++)
    {
        if (lit->second->isFinished() && mDeleteHistoryThreads[lit->first]->isFinished())
        {
            delete lit->second;
            delete mDeleteHistoryThreads[lit->first];
            uuids.push_back(lit->first);
        }
    }
    std::vector<LLUUID>::iterator uuid_it = uuids.begin();
    for ( ;uuid_it != uuids.end(); uuid_it++)
    {
        mLoadHistoryThreads.erase(*uuid_it);
        mDeleteHistoryThreads.erase(*uuid_it);
    }
}

LLMutex* LLLogChat::historyThreadsMutex()
{
    return mHistoryThreadsMutex;
}

void LLLogChat::triggerHistorySignal()
{
    if (NULL != mSaveHistorySignal)
    {
        (*mSaveHistorySignal)();
    }
}

// static
std::string LLLogChat::oldLogFileName(std::string filename)
{
    // get Users log directory
    std::string directory = gDirUtilp->getPerAccountChatLogsDir();

    // add final OS dependent delimiter
    directory += gDirUtilp->getDirDelimiter();

    // lest make sure the file name has no invalid characters before making the pattern
    filename = cleanFileName(filename);

    // create search pattern
    std::string pattern = filename + ( filename == "chat" ? "-???\?-?\?-??.txt" : "-???\?-??.txt");

    std::vector<std::string> allfiles;
    LLDirIterator iter(directory, pattern);
    std::string scanResult;

    while (iter.next(scanResult))
    {
        allfiles.push_back(scanResult);
    }

    if (allfiles.size() == 0)  // if no result from date search, return generic filename
    {
        scanResult = directory + filename + '.' + LL_TRANSCRIPT_FILE_EXTENSION;
    }
    else
    {
        sort(allfiles.begin(), allfiles.end());
        scanResult = directory + allfiles.back();
        // this file is now the most recent version of the file.
    }

    return scanResult;
}

bool LLLogChat::transcriptFilesExist()
{
    std::string pattern = "*." + LL_TRANSCRIPT_FILE_EXTENSION;
    // get Users log directory
    std::string dirname = gDirUtilp->getPerAccountChatLogsDir();

    // add final OS dependent delimiter
    dirname += gDirUtilp->getDirDelimiter();

    LLDirIterator iter(dirname, pattern);
    std::string filename;
    while (iter.next(filename))
    {
        std::string fullname = gDirUtilp->add(dirname, filename);
        if (isTranscriptFileFound(fullname))
        {
            return true;
        }
    }
    return false;
}
// static
void LLLogChat::findTranscriptFiles(std::string pattern, std::vector<std::string>& list_of_transcriptions)
{
    // get Users log directory
    std::string dirname = gDirUtilp->getPerAccountChatLogsDir();

    // add final OS dependent delimiter
    dirname += gDirUtilp->getDirDelimiter();

    LLDirIterator iter(dirname, pattern);
    std::string filename;
    while (iter.next(filename))
    {
        std::string fullname = gDirUtilp->add(dirname, filename);
        if (isTranscriptFileFound(fullname))
        {
            list_of_transcriptions.push_back(fullname);
        }
    }
}

// static
void LLLogChat::getListOfTranscriptFiles(std::vector<std::string>& list_of_transcriptions)
{
    // create search pattern
    std::string pattern = "*." + LL_TRANSCRIPT_FILE_EXTENSION;
    findTranscriptFiles(pattern, list_of_transcriptions);
}

// static
void LLLogChat::getListOfTranscriptBackupFiles(std::vector<std::string>& list_of_transcriptions)
{
    // create search pattern
    std::string pattern = "*." + LL_TRANSCRIPT_FILE_EXTENSION + ".backup*";
    findTranscriptFiles(pattern, list_of_transcriptions);
}

boost::signals2::connection LLLogChat::setSaveHistorySignal(const save_history_signal_t::slot_type& cb)
{
    if (NULL == mSaveHistorySignal)
    {
        mSaveHistorySignal = new save_history_signal_t();
    }

    return mSaveHistorySignal->connect(cb);
}

//static
bool LLLogChat::moveTranscripts(const std::string originDirectory,
                                const std::string targetDirectory,
                                std::vector<std::string>& listOfFilesToMove,
                                std::vector<std::string>& listOfFilesMoved)
{
    std::string newFullPath;
    bool movedAllTranscripts = true;
    std::string backupFileName;
    unsigned backupFileCount;

    for (const std::string& fullpath : listOfFilesToMove)
    {
        backupFileCount = 0;
        newFullPath = targetDirectory + fullpath.substr(originDirectory.length(), std::string::npos);

        //The target directory contains that file already, so lets store it
        if(LLFile::isfile(newFullPath))
        {
            backupFileName = newFullPath + ".backup";

            //If needed store backup file as .backup1 etc.
            while(LLFile::isfile(backupFileName))
            {
                ++backupFileCount;
                backupFileName = newFullPath + ".backup" + std::to_string(backupFileCount);
            }

            //Rename the file to its backup name so it is not overwritten
            LLFile::rename(newFullPath, backupFileName);
        }

        S32 retry_count = 0;
        while (retry_count < 5)
        {
            //success is zero
            if (LLFile::rename(fullpath, newFullPath) != 0)
            {
                retry_count++;
                S32 result = errno;
                LL_WARNS("LLLogChat::moveTranscripts") << "Problem renaming " << fullpath << " - errorcode: "
                    << result << " attempt " << retry_count << LL_ENDL;

                ms_sleep(100);
            }
            else
            {
                listOfFilesMoved.push_back(newFullPath);

                if (retry_count)
                {
                    LL_WARNS("LLLogChat::moveTranscripts") << "Successfully renamed " << fullpath << LL_ENDL;
                }
                break;
            }
        }
    }

    if(listOfFilesMoved.size() != listOfFilesToMove.size())
    {
        movedAllTranscripts = false;
    }

    return movedAllTranscripts;
}

//static
bool LLLogChat::moveTranscripts(const std::string currentDirectory,
    const std::string newDirectory,
    std::vector<std::string>& listOfFilesToMove)
{
    std::vector<std::string> listOfFilesMoved;
    return moveTranscripts(currentDirectory, newDirectory, listOfFilesToMove, listOfFilesMoved);
}

//static
void LLLogChat::deleteTranscripts()
{
    std::vector<std::string> list_of_transcriptions;
    getListOfTranscriptFiles(list_of_transcriptions);
    getListOfTranscriptBackupFiles(list_of_transcriptions);

    for (const std::string& fullpath : list_of_transcriptions)
    {
        S32 retry_count = 0;
        while (retry_count < 5)
        {
            if (0 != LLFile::remove(fullpath))
            {
                retry_count++;
                S32 result = errno;
                LL_WARNS("LLLogChat::deleteTranscripts") << "Problem removing " << fullpath << " - errorcode: "
                    << result << " attempt " << retry_count << LL_ENDL;

                if(retry_count >= 5)
                {
                    LL_WARNS("LLLogChat::deleteTranscripts") << "Failed to remove " << fullpath << LL_ENDL;
                    return;
                }

                ms_sleep(100);
            }
            else
            {
                if (retry_count)
                {
                    LL_WARNS("LLLogChat::deleteTranscripts") << "Successfully removed " << fullpath << LL_ENDL;
                }
                break;
            }
        }
    }

    LLFloaterIMSessionTab::processChatHistoryStyleUpdate(true);
}

// static
bool LLLogChat::isTranscriptExist(const LLUUID& avatar_id, bool is_group)
{
    LLAvatarName avatar_name;
    LLAvatarNameCache::get(avatar_id, &avatar_name);
    std::string avatar_user_name = avatar_name.getAccountName();
    if(!is_group)
    {
        std::replace(avatar_user_name.begin(), avatar_user_name.end(), '.', '_');
        return isTranscriptFileFound(makeLogFileName(avatar_user_name));
    }
    else
    {
        std::string file_name;
        gCacheName->getGroupName(avatar_id, file_name);
        file_name = makeLogFileName(file_name + GROUP_CHAT_SUFFIX);
        return isTranscriptFileFound(file_name);
    }
    return false;
}

bool LLLogChat::isNearbyTranscriptExist()
{
    return isTranscriptFileFound(makeLogFileName("chat"));;
}

bool LLLogChat::isAdHocTranscriptExist(std::string file_name)
{
    return isTranscriptFileFound(makeLogFileName(file_name));;
}

// static
bool LLLogChat::isTranscriptFileFound(std::string fullname)
{
    bool result = false;
    LLFILE * filep = LLFile::fopen(fullname, "rb");
    if (NULL != filep)
    {
        if (makeLogFileName("chat") == fullname)
        {
            LLFile::close(filep);
            return true;
        }
        char buffer[LOG_RECALL_SIZE];

        fseek(filep, 0, SEEK_END);          // seek to end of file
        S32 bytes_to_read = ftell(filep);   // get current file pointer
        fseek(filep, 0, SEEK_SET);          // seek back to beginning of file

        // limit the number characters to read from file
        if (bytes_to_read >= LOG_RECALL_SIZE)
        {
            bytes_to_read = LOG_RECALL_SIZE - 1;
        }

        if (bytes_to_read > 0 && NULL != fgets(buffer, bytes_to_read, filep))
        {
            //matching a timestamp
            boost::match_results<std::string::const_iterator> matches;
            std::string line(remove_utf8_bom(buffer));
            if (ll_regex_match(line, matches, TIMESTAMP))
            {
                result = true;
            }
        }
        LLFile::close(filep);
    }
    return result;
}

//*TODO mark object's names in a special way so that they will be distinguishable form avatar name
//which are more strict by its nature (only firstname and secondname)
//Example, an object's name can be written like "Object <actual_object's_name>"
void LLChatLogFormatter::format(const LLSD& im, std::ostream& ostr) const
{
    if (!im.isMap())
    {
        LL_WARNS() << "invalid LLSD type of an instant message" << LL_ENDL;
        return;
    }

    if (im[LL_IM_TIME].isDefined())
    {
        std::string timestamp = im[LL_IM_TIME].asString();
        boost::trim(timestamp);
        ostr << '[' << timestamp << ']' << TWO_SPACES;
    }

    //*TODO mark object's names in a special way so that they will be distinguishable from avatar name
    //which are more strict by its nature (only firstname and secondname)
    //Example, an object's name can be written like "Object <actual_object's_name>"
    if (im[LL_IM_FROM].isDefined())
    {
        std::string from = im[LL_IM_FROM].asString();
        boost::trim(from);

        std::size_t found = from.find(IM_SYMBOL_SEPARATOR);
        std::size_t len = from.size();
        std::size_t start = 0;
        while (found != std::string::npos)
        {
            std::size_t sub_len = found - start;
            if (sub_len > 0)
            {
                ostr << from.substr(start, sub_len);
            }
            LLURI::encodeCharacter(ostr, IM_SYMBOL_SEPARATOR);
            start = found + 1;
            found = from.find(IM_SYMBOL_SEPARATOR, start);
        }
        if (start < len)
        {
            std::string str_end = from.substr(start, len - start);
            ostr << str_end;
        }
        if (len > 0)
        {
            ostr << IM_SEPARATOR;
        }
    }

    if (im[LL_IM_TEXT].isDefined())
    {
        std::string im_text = im[LL_IM_TEXT].asString();

        //multilined text will be saved with prepended spaces
        boost::replace_all(im_text, NEW_LINE, NEW_LINE_SPACE_PREFIX);
        ostr << im_text;
    }
}

bool LLChatLogParser::parse(std::string& raw, LLSD& im, const LLSD& parse_params)
{
    if (!raw.length()) return false;

    bool cut_off_todays_date = parse_params.has("cut_off_todays_date")  ? parse_params["cut_off_todays_date"].asBoolean()  : true;
    im = LLSD::emptyMap();

    //matching a timestamp
    boost::match_results<std::string::const_iterator> matches;
    if (!ll_regex_match(raw, matches, TIMESTAMP_AND_STUFF)) return false;

    bool has_timestamp = matches[IDX_TIMESTAMP].matched;
    if (has_timestamp)
    {
        //timestamp was successfully parsed
        std::string timestamp = matches[IDX_TIMESTAMP];
        boost::trim(timestamp);
        timestamp.erase(0, 1);
        timestamp.erase(timestamp.length()-1, 1);

        im[LL_IM_DATE_TIME] = timestamp;    // Retain full date-time for merging chat histories

        if (cut_off_todays_date)
        {
            LLLogChatTimeScanner::instance().checkAndCutOffDate(timestamp);
        }

        im[LL_IM_TIME] = timestamp;
    }
    else
    {   //timestamp is optional
        im[LL_IM_DATE_TIME] = "";
        im[LL_IM_TIME] = "";
    }

    bool has_stuff = matches[IDX_STUFF].matched;
    if (!has_stuff)
    {
        return false;  //*TODO should return false or not?
    }

    //matching a name and a text
    std::string stuff = matches[IDX_STUFF];
    boost::match_results<std::string::const_iterator> name_and_text;
    if (!ll_regex_match(stuff, name_and_text, NAME_AND_TEXT)) return false;

    bool has_name = name_and_text[IDX_NAME].matched;
    std::string name = LLURI::unescape(name_and_text[IDX_NAME]);

    //we don't need a name/text separator
    if (has_name && name.length() && name[name.length()-1] == ':')
    {
        name.erase(name.length()-1, 1);
    }

    if (!has_name || name == SYSTEM_FROM)
    {
        //name is optional too
        im[LL_IM_FROM] = SYSTEM_FROM;
        im[LL_IM_FROM_ID] = LLUUID::null;
    }

    //possibly a case of complex object names consisting of 3+ words
    if (!has_name)
    {
        std::string::size_type divider_pos = stuff.find(NAME_TEXT_DIVIDER);
        if (divider_pos != std::string::npos && divider_pos < (stuff.length() - NAME_TEXT_DIVIDER.length()))
        {
            im[LL_IM_FROM] = LLURI::unescape(stuff.substr(0, divider_pos));
            im[LL_IM_TEXT] = stuff.substr(divider_pos + NAME_TEXT_DIVIDER.length());
            return true;
        }
    }

    if (!has_name)
    {
        //text is mandatory
        im[LL_IM_TEXT] = stuff;
        return true; //parse as a message from Second Life
    }

    bool has_text = name_and_text[IDX_TEXT].matched;
    if (!has_text) return false;

    //for parsing logs created in very old versions of a viewer
    if (name == "You")
    {
        std::string agent_name;
        LLAgentUI::buildFullname(agent_name);
        im[LL_IM_FROM] = agent_name;
        im[LL_IM_FROM_ID] = gAgentID;
    }
    else
    {
        im[LL_IM_FROM] = name;
    }

    im[LL_IM_TEXT] = name_and_text[IDX_TEXT];
    return true;  //parsed name and message text, maybe have a timestamp too
}

LLDeleteHistoryThread::LLDeleteHistoryThread(std::list<LLSD>* messages, LLLoadHistoryThread* loadThread)
    : LLActionThread("delete chat history"),
    mMessages(messages),
    mLoadThread(loadThread)
{
}
LLDeleteHistoryThread::~LLDeleteHistoryThread()
{
}
void LLDeleteHistoryThread::run()
{
    if (mLoadThread != NULL)
    {
        mLoadThread->waitFinished();
    }
    if (NULL != mMessages)
    {
        delete mMessages;
    }
    mMessages = NULL;
    setFinished();
}

LLActionThread::LLActionThread(const std::string& name)
    : LLThread(name),
    mMutex(),
    mRunCondition(),
    mFinished(false)
{
}

LLActionThread::~LLActionThread()
{
}

void LLActionThread::waitFinished()
{
    mMutex.lock();
    if (!mFinished)
    {
        mMutex.unlock();
        mRunCondition.wait();
    }
    else
    {
        mMutex.unlock();
    }
}

void LLActionThread::setFinished()
{
    mMutex.lock();
    mFinished = true;
    mMutex.unlock();
    mRunCondition.signal();
}

LLLoadHistoryThread::LLLoadHistoryThread(const std::string& file_name, std::list<LLSD>* messages, const LLSD& load_params)
    : LLActionThread("load chat history"),
    mMessages(messages),
    mFileName(file_name),
    mLoadParams(load_params),
    mNewLoad(true),
    mLoadEndSignal(NULL)
{
}

LLLoadHistoryThread::~LLLoadHistoryThread()
{
}

void LLLoadHistoryThread::run()
{
    if(mNewLoad)
    {
        loadHistory(mFileName, mMessages, mLoadParams);
        int count = mMessages->size();
        LL_INFOS() << "mMessages->size(): " << count << LL_ENDL;
        setFinished();
    }
}

void LLLoadHistoryThread::loadHistory(const std::string& file_name, std::list<LLSD>* messages, const LLSD& load_params)
{
    if (file_name.empty())
    {
        LL_WARNS("LLLogChat::loadHistory") << "Session name is Empty!" << LL_ENDL;
        return ;
    }

    bool load_all_history = load_params.has("load_all_history") ? load_params["load_all_history"].asBoolean() : false;
    LLFILE* fptr = LLFile::fopen(LLLogChat::makeLogFileName(file_name), "r");/*Flawfinder: ignore*/

    if (!fptr)
    {
        bool is_group = load_params.has("is_group") ? load_params["is_group"].asBoolean() : false;
        if (is_group)
        {
            std::string old_name(file_name);
            old_name.erase(old_name.size() - GROUP_CHAT_SUFFIX.size());
            fptr = LLFile::fopen(LLLogChat::makeLogFileName(old_name), "r");
            if (fptr)
            {
                fclose(fptr);
                LLFile::copy(LLLogChat::makeLogFileName(old_name), LLLogChat::makeLogFileName(file_name));
            }
            fptr = LLFile::fopen(LLLogChat::makeLogFileName(file_name), "r");
        }
        if (!fptr)
        {
            fptr = LLFile::fopen(LLLogChat::oldLogFileName(file_name), "r");/*Flawfinder: ignore*/
            if (!fptr)
            {
                mNewLoad = false;
                (*mLoadEndSignal)(messages, file_name);
                return;                     //No previous conversation with this name.
            }
        }
    }

    char buffer[LOG_RECALL_SIZE];       /*Flawfinder: ignore*/

    char *bptr;
    S32 len;
    bool firstline = TRUE;

    if (load_all_history || fseek(fptr, (LOG_RECALL_SIZE - 1) * -1  , SEEK_END))
    {   //We need to load the whole historyFile or it's smaller than recall size, so get it all.
        firstline = FALSE;
        if (fseek(fptr, 0, SEEK_SET))
        {
            fclose(fptr);
            mNewLoad = false;
            (*mLoadEndSignal)(messages, file_name);
            return;
        }
    }


    while (fgets(buffer, LOG_RECALL_SIZE, fptr)  && !feof(fptr))
    {
        len = strlen(buffer) - 1;       /*Flawfinder: ignore*/

        for (bptr = (buffer + len); (*bptr == '\n' || *bptr == '\r') && bptr>buffer; bptr--)    *bptr='\0';


        if (firstline)
        {
            firstline = FALSE;
            continue;
        }
        std::string line(remove_utf8_bom(buffer));

        //updated 1.23 plaint text log format requires a space added before subsequent lines in a multilined message
        if (' ' == line[0])
        {
            line.erase(0, MULTI_LINE_PREFIX.length());
            append_to_last_message(*messages, '\n' + line);
        }
        else if (0 == len && ('\n' == line[0] || '\r' == line[0]))
        {
            //to support old format's multilined messages with new lines used to divide paragraphs
            append_to_last_message(*messages, line);
        }
        else
        {
            LLSD item;
            if (!LLChatLogParser::parse(line, item, load_params))
            {
                item[LL_IM_TEXT] = line;
            }
            messages->push_back(item);
        }
    }

    fclose(fptr);
    mNewLoad = false;
    (*mLoadEndSignal)(messages, file_name);
}

boost::signals2::connection LLLoadHistoryThread::setLoadEndSignal(const load_end_signal_t::slot_type& cb)
{
    if (NULL == mLoadEndSignal)
    {
        mLoadEndSignal = new load_end_signal_t();
    }

    return mLoadEndSignal->connect(cb);
}

void LLLoadHistoryThread::removeLoadEndSignal(const load_end_signal_t::slot_type& cb)
{
    if (NULL != mLoadEndSignal)
    {
        mLoadEndSignal->disconnect_all_slots();
        delete mLoadEndSignal;
    }
    mLoadEndSignal = NULL;
}