summaryrefslogtreecommitdiff
path: root/indra/newview/lllogchat.h
blob: e16cb21e8e0e375d938a01df9497666bf54ca5c5 (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
/**
 * @file lllogchat.h
 * @brief LLFloaterChat class definition
 *
 * $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$
 */

#ifndef LL_LLLOGCHAT_H
#define LL_LLLOGCHAT_H
#include "llthread.h"

class LLChat;

class LLActionThread : public LLThread
{
public:
    LLActionThread(const std::string& name);
    ~LLActionThread();

    void waitFinished();
    bool isFinished() { return mFinished; }
protected:
    void setFinished();
private:
    bool mFinished;
    LLMutex mMutex;
    LLCondition mRunCondition;
};

class LLLoadHistoryThread : public LLActionThread
{
private:
    const std::string& mFileName;
    std::list<LLSD>* mMessages;
    LLSD mLoadParams;
    bool mNewLoad;
public:
    LLLoadHistoryThread(const std::string& file_name, std::list<LLSD>* messages, const LLSD& load_params);
    ~LLLoadHistoryThread();
    //void setHistoryParams(const std::string& file_name, const LLSD& load_params);
    virtual void loadHistory(const std::string& file_name, std::list<LLSD>* messages, const LLSD& load_params);
    virtual void run();

    typedef boost::signals2::signal<void (std::list<LLSD>* messages,const std::string& file_name)> load_end_signal_t;
    load_end_signal_t * mLoadEndSignal;
    boost::signals2::connection setLoadEndSignal(const load_end_signal_t::slot_type& cb);
    void removeLoadEndSignal(const load_end_signal_t::slot_type& cb);
};

class LLDeleteHistoryThread : public LLActionThread
{
private:
    std::list<LLSD>* mMessages;
    LLLoadHistoryThread* mLoadThread;
public:
    LLDeleteHistoryThread(std::list<LLSD>* messages, LLLoadHistoryThread* loadThread);
    ~LLDeleteHistoryThread();

    virtual void run();
    static void deleteHistory();
};

class LLLogChat : public LLSingleton<LLLogChat>
{
    LLSINGLETON(LLLogChat);
    ~LLLogChat();
public:
    // status values for callback function
    enum ELogLineType {
        LOG_EMPTY,
        LOG_LINE,
        LOG_LLSD,
        LOG_END
    };

    static std::string timestamp2LogString(U32 timestamp, bool withdate);
    static std::string makeLogFileName(std::string(filename));
    static void renameLogFile(const std::string& old_filename, const std::string& new_filename);
    /**
    *Add functions to get old and non date stamped file names when needed
    */
    static std::string oldLogFileName(std::string(filename));
    static void saveHistory(const std::string& filename,
                const std::string& from,
                const LLUUID& from_id,
                const std::string& line);
    static void findTranscriptFiles(std::string pattern, std::vector<std::string>& list_of_transcriptions);
    static void getListOfTranscriptFiles(std::vector<std::string>& list);
    static void getListOfTranscriptBackupFiles(std::vector<std::string>& list_of_transcriptions);

    static void loadChatHistory(const std::string& file_name, std::list<LLSD>& messages, const LLSD& load_params = LLSD(), bool is_group = false);

    typedef boost::signals2::signal<void ()> save_history_signal_t;
    boost::signals2::connection setSaveHistorySignal(const save_history_signal_t::slot_type& cb);

    static bool moveTranscripts(const std::string currentDirectory,
                                    const std::string newDirectory,
                                    std::vector<std::string>& listOfFilesToMove,
                                    std::vector<std::string>& listOfFilesMoved);
    static bool moveTranscripts(const std::string currentDirectory,
        const std::string newDirectory,
        std::vector<std::string>& listOfFilesToMove);

    static void deleteTranscripts();
    static bool isTranscriptExist(const LLUUID& avatar_id, bool is_group=false);
    static bool isNearbyTranscriptExist();
    static bool isAdHocTranscriptExist(std::string file_name);
    static bool isTranscriptFileFound(std::string fullname);

    bool historyThreadsFinished(LLUUID session_id);
    LLLoadHistoryThread* getLoadHistoryThread(LLUUID session_id);
    LLDeleteHistoryThread* getDeleteHistoryThread(LLUUID session_id);
    bool addLoadHistoryThread(LLUUID& session_id, LLLoadHistoryThread* lthread);
    bool addDeleteHistoryThread(LLUUID& session_id, LLDeleteHistoryThread* dthread);
    void cleanupHistoryThreads();

private:
    static std::string cleanFileName(std::string filename);

    LLMutex* historyThreadsMutex();
    void triggerHistorySignal();

    save_history_signal_t * mSaveHistorySignal;
    std::map<LLUUID,LLLoadHistoryThread *> mLoadHistoryThreads;
    std::map<LLUUID,LLDeleteHistoryThread *> mDeleteHistoryThreads;
    LLMutex* mHistoryThreadsMutex;
};

/**
 * Formatter for the plain text chat log files
 */
class LLChatLogFormatter
{
public:
    LLChatLogFormatter(const LLSD& im) : mIM(im) {}
    virtual ~LLChatLogFormatter() {};

    friend std::ostream& operator<<(std::ostream& str, const LLChatLogFormatter& formatter)
    {
        formatter.format(formatter.mIM, str);
        return str;
    }

protected:

    /**
     * Format an instant message to a stream
     * Timestamps and sender names are required
     * New lines of multilined messages are prepended with a space
     */
    void format(const LLSD& im, std::ostream& ostr) const;

    LLSD mIM;
};

/**
 * Parser for the plain text chat log files
 */
class LLChatLogParser
{
public:

     /**
     * Parse a line from the plain text chat log file
     * General plain text log format is like: "[timestamp]  [name]: [message]"
     * [timestamp] and [name] are optional
     * Examples of plain text chat log lines:
     * "[2009/11/20 2:53]  Igor ProductEngine: howdy"
     * "Igor ProductEngine: howdy"
     * "Dserduk ProductEngine is Online"
     *
     * @return false if failed to parse mandatory data - message text
     */
    static bool parse(std::string& raw, LLSD& im, const LLSD& parse_params = LLSD());

protected:
    LLChatLogParser();
    virtual ~LLChatLogParser() {};
};

extern const std::string GROUP_CHAT_SUFFIX;

// LLSD map lookup constants
extern const std::string LL_IM_TIME; //("time");
extern const std::string LL_IM_DATE_TIME; //("datetime");
extern const std::string LL_IM_TEXT; //("message");
extern const std::string LL_IM_FROM; //("from");
extern const std::string LL_IM_FROM_ID; //("from_id");
extern const std::string LL_TRANSCRIPT_FILE_EXTENSION; //("txt");

#endif