/** * @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 "llagent.h" #include "llagentui.h" #include "llavatarnamecache.h" #include "lllogchat.h" #include "lltrans.h" #include "llviewercontrol.h" #include "lldiriterator.h" #include "llfloaterimsessiontab.h" #include "llinstantmessage.h" #include "llsingleton.h" // for LLSingleton #include #include #include #include #include #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 #if LL_MSVC #pragma warning(pop) // Restore all warnings to the previous state #endif #include #include const S32 LOG_RECALL_SIZE = 2048; const std::string LL_IM_TIME("time"); 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 static std::string IM_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 " Conference 2010/11/19 03:43 f0f4" * On initiating side, an ad-hoc is named like Ad-hoc Conference 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& 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; } class LLLogChatTimeScanner: public LLSingleton { public: 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))); } date getTodayPacificDate() { typedef boost::date_time::local_adjustor pst; typedef boost::date_time::local_adjustor 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; }; LLLogChat::save_history_signal_t * LLLogChat::sSaveHistorySignal = 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 matches; bool inboundConf = boost::regex_match(filename, matches, INBOUND_CONFERENCE); bool outboundConf = boost::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); filename += '.' + LL_TRANSCRIPT_FILE_EXTENSION; return filename; } 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::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; substitution["datetime"] = (S32)time_corrected(); 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!"; llwarning(warn, 666); llassert(tmp_filename.size()); return; } llofstream file (LLLogChat::makeLogFileName(filename), std::ios_base::app); if (!file.is_open()) { llwarns << "Couldn't open chat history log! - " + filename << llendl; return; } LLSD item; if (gSavedPerAccountSettings.getBOOL("LogTimestamp")) item["time"] = LLLogChat::timestamp(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(); if (NULL != sSaveHistorySignal) { (*sSaveHistorySignal)(); } } // static void LLLogChat::loadChatHistory(const std::string& file_name, std::list& messages, const LLSD& load_params) { if (file_name.empty()) { llwarns << "Session name is Empty!" << llendl; return ; } bool load_all_history = load_params.has("load_all_history") ? load_params["load_all_history"].asBoolean() : false; LLFILE* fptr = LLFile::fopen(makeLogFileName(file_name), "r");/*Flawfinder: ignore*/ if (!fptr) { fptr = LLFile::fopen(oldLogFileName(file_name), "r");/*Flawfinder: ignore*/ if (!fptr) { 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); 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(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); } // 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 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; } // static void LLLogChat::findTranscriptFiles(std::string pattern, std::vector& 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); LLFILE * filep = LLFile::fopen(fullname, "rb"); if (NULL != filep) { 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 matches; if (boost::regex_match(std::string(buffer), matches, TIMESTAMP)) { list_of_transcriptions.push_back(gDirUtilp->add(dirname, filename)); } } LLFile::close(filep); } } } // static void LLLogChat::getListOfTranscriptFiles(std::vector& list_of_transcriptions) { // create search pattern std::string pattern = "*." + LL_TRANSCRIPT_FILE_EXTENSION; findTranscriptFiles(pattern, list_of_transcriptions); } // static void LLLogChat::getListOfTranscriptBackupFiles(std::vector& list_of_transcriptions) { // create search pattern std::string pattern = "*." + LL_TRANSCRIPT_FILE_EXTENSION + ".backup*"; findTranscriptFiles(pattern, list_of_transcriptions); } //static boost::signals2::connection LLLogChat::setSaveHistorySignal(const save_history_signal_t::slot_type& cb) { if (NULL == sSaveHistorySignal) { sSaveHistorySignal = new save_history_signal_t(); } return sSaveHistorySignal->connect(cb); } //static bool LLLogChat::moveTranscripts(const std::string originDirectory, const std::string targetDirectory, std::vector& listOfFilesToMove, std::vector& listOfFilesMoved) { std::string newFullPath; bool movedAllTranscripts = true; std::string backupFileName; unsigned backupFileCount; BOOST_FOREACH(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" + boost::lexical_cast(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& listOfFilesToMove) { std::vector listOfFilesMoved; return moveTranscripts(currentDirectory, newDirectory, listOfFilesToMove, listOfFilesMoved); } //static void LLLogChat::deleteTranscripts() { std::vector list_of_transcriptions; getListOfTranscriptFiles(list_of_transcriptions); getListOfTranscriptBackupFiles(list_of_transcriptions); BOOST_FOREACH(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) { std::vector list_of_transcriptions; LLLogChat::getListOfTranscriptFiles(list_of_transcriptions); if (list_of_transcriptions.size() > 0) { 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(), '.', '_'); BOOST_FOREACH(std::string& transcript_file_name, list_of_transcriptions) { if (std::string::npos != transcript_file_name.find(avatar_user_name)) { return true; } } } else { std::string file_name; gCacheName->getGroupName(avatar_id, file_name); file_name = makeLogFileName(file_name); BOOST_FOREACH(std::string& transcript_file_name, list_of_transcriptions) { if (transcript_file_name == file_name) { return true; } } } } return false; } bool LLLogChat::isNearbyTranscriptExist() { std::vector list_of_transcriptions; LLLogChat::getListOfTranscriptFiles(list_of_transcriptions); std::string file_name; file_name = makeLogFileName("chat"); BOOST_FOREACH(std::string& transcript_file_name, list_of_transcriptions) { if (transcript_file_name == file_name) { return true; } } return false; } //*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 " void LLChatLogFormatter::format(const LLSD& im, std::ostream& ostr) const { if (!im.isMap()) { llwarning("invalid LLSD type of an instant message", 0); 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 form avatar name //which are more strict by its nature (only firstname and secondname) //Example, an object's name can be written like "Object " if (im[LL_IM_FROM].isDefined()) { std::string from = im[LL_IM_FROM].asString(); boost::trim(from); if (from.size()) { ostr << from << 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 matches; if (!boost::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); if (cut_off_todays_date) { LLLogChatTimeScanner::instance().checkAndCutOffDate(timestamp); } im[LL_IM_TIME] = timestamp; } else { //timestamp is optional 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 name_and_text; if (!boost::regex_match(stuff, name_and_text, NAME_AND_TEXT)) return false; bool has_name = name_and_text[IDX_NAME].matched; std::string name = 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) { U32 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] = 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 }