lllogchat.cpp
上传用户:king477883
上传日期:2021-03-01
资源大小:9553k
文件大小:12k
源码类别:

游戏引擎

开发平台:

C++ Builder

  1. /** 
  2.  * @file lllogchat.cpp
  3.  * @brief LLLogChat class implementation
  4.  *
  5.  * $LicenseInfo:firstyear=2002&license=viewergpl$
  6.  * 
  7.  * Copyright (c) 2002-2010, Linden Research, Inc.
  8.  * 
  9.  * Second Life Viewer Source Code
  10.  * The source code in this file ("Source Code") is provided by Linden Lab
  11.  * to you under the terms of the GNU General Public License, version 2.0
  12.  * ("GPL"), unless you have obtained a separate licensing agreement
  13.  * ("Other License"), formally executed by you and Linden Lab.  Terms of
  14.  * the GPL can be found in doc/GPL-license.txt in this distribution, or
  15.  * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
  16.  * 
  17.  * There are special exceptions to the terms and conditions of the GPL as
  18.  * it is applied to this Source Code. View the full text of the exception
  19.  * in the file doc/FLOSS-exception.txt in this software distribution, or
  20.  * online at
  21.  * http://secondlifegrid.net/programs/open_source/licensing/flossexception
  22.  * 
  23.  * By copying, modifying or distributing this software, you acknowledge
  24.  * that you have read and understood your obligations described above,
  25.  * and agree to abide by those obligations.
  26.  * 
  27.  * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
  28.  * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
  29.  * COMPLETENESS OR PERFORMANCE.
  30.  * $/LicenseInfo$
  31.  */
  32. #include "llviewerprecompiledheaders.h"
  33. #include "llagent.h"
  34. #include "llagentui.h"
  35. #include "lllogchat.h"
  36. #include "lltrans.h"
  37. #include "llviewercontrol.h"
  38. #include "llinstantmessage.h"
  39. #include <boost/algorithm/string/trim.hpp>
  40. #include <boost/algorithm/string/replace.hpp>
  41. #include <boost/regex.hpp>
  42. #include <boost/regex/v4/match_results.hpp>
  43. const S32 LOG_RECALL_SIZE = 2048;
  44. const static std::string IM_TIME("time");
  45. const static std::string IM_TEXT("message");
  46. const static std::string IM_FROM("from");
  47. const static std::string IM_FROM_ID("from_id");
  48. const static std::string IM_SEPARATOR(": ");
  49. const static std::string NEW_LINE("n");
  50. const static std::string NEW_LINE_SPACE_PREFIX("n ");
  51. const static std::string TWO_SPACES("  ");
  52. const static std::string MULTI_LINE_PREFIX(" ");
  53. /**
  54.  *  Chat log lines - timestamp and name are optional but message text is mandatory.
  55.  *
  56.  *  Typical plain text chat log lines:
  57.  *
  58.  *  SuperCar: You aren't the owner
  59.  *  [2:59]  SuperCar: You aren't the owner
  60.  *  [2009/11/20 3:00]  SuperCar: You aren't the owner
  61.  *  Katar Ivercourt is Offline
  62.  *  [3:00]  Katar Ivercourt is Offline
  63.  *  [2009/11/20 3:01]  Corba ProductEngine is Offline
  64.  *
  65.  * Note: "You" was used as an avatar names in viewers of previous versions
  66.  */
  67. 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+)?(.*)$");
  68. /**
  69.  *  Regular expression suitable to match names like
  70.  *  "You", "Second Life", "Igor ProductEngine", "Object", "Mega House"
  71.  */
  72. const static boost::regex NAME_AND_TEXT("(You:|Second Life:|[^\s:]+\s*[:]{1}|\S+\s+[^\s:]+[:]{1})?(\s*)(.*)");
  73. //is used to parse complex object names like "Xstreet SL Terminal v2.2.5 st"
  74. const static std::string NAME_TEXT_DIVIDER(": ");
  75. const static int IDX_TIMESTAMP = 1;
  76. const static int IDX_STUFF = 2;
  77. const static int IDX_NAME = 1;
  78. const static int IDX_TEXT = 3;
  79. //static
  80. std::string LLLogChat::makeLogFileName(std::string filename)
  81. {
  82. filename = cleanFileName(filename);
  83. filename = gDirUtilp->getExpandedFilename(LL_PATH_PER_ACCOUNT_CHAT_LOGS,filename);
  84. filename += ".txt";
  85. return filename;
  86. }
  87. std::string LLLogChat::cleanFileName(std::string filename)
  88. {
  89. std::string invalidChars = ""'\/?*:<>|";
  90. std::string::size_type position = filename.find_first_of(invalidChars);
  91. while (position != filename.npos)
  92. {
  93. filename[position] = '_';
  94. position = filename.find_first_of(invalidChars, position);
  95. }
  96. return filename;
  97. }
  98. std::string LLLogChat::timestamp(bool withdate)
  99. {
  100. time_t utc_time;
  101. utc_time = time_corrected();
  102. std::string timeStr;
  103. LLSD substitution;
  104. substitution["datetime"] = (S32) utc_time;
  105. if (withdate)
  106. {
  107. timeStr = "["+LLTrans::getString ("TimeYear")+"]/["
  108.           +LLTrans::getString ("TimeMonth")+"]/["
  109.   +LLTrans::getString ("TimeDay")+"] ["
  110.   +LLTrans::getString ("TimeHour")+"]:["
  111.   +LLTrans::getString ("TimeMin")+"]";
  112. }
  113. else
  114. {
  115. timeStr = "[" + LLTrans::getString("TimeHour") + "]:["
  116.       + LLTrans::getString ("TimeMin")+"]";
  117. }
  118. LLStringUtil::format (timeStr, substitution);
  119. return timeStr;
  120. }
  121. //static
  122. void LLLogChat::saveHistory(const std::string& filename,
  123.     const std::string& from,
  124.     const LLUUID& from_id,
  125.     const std::string& line)
  126. {
  127. std::string tmp_filename = filename;
  128. LLStringUtil::trim(tmp_filename);
  129. if (tmp_filename.empty())
  130. {
  131. std::string warn = "Chat history filename [" + filename + "] is empty!";
  132. llwarning(warn, 666);
  133. llassert(tmp_filename.size());
  134. return;
  135. }
  136. llofstream file (LLLogChat::makeLogFileName(filename), std::ios_base::app);
  137. if (!file.is_open())
  138. {
  139. llwarns << "Couldn't open chat history log! - " + filename << llendl;
  140. return;
  141. }
  142. LLSD item;
  143. if (gSavedPerAccountSettings.getBOOL("LogTimestamp"))
  144.  item["time"] = LLLogChat::timestamp(gSavedPerAccountSettings.getBOOL("LogTimestampDate"));
  145. item["from_id"] = from_id;
  146. item["message"] = line;
  147. //adding "Second Life:" for all system messages to make chat log history parsing more reliable
  148. if (from.empty() && from_id.isNull())
  149. {
  150. item["from"] = SYSTEM_FROM; 
  151. }
  152. else
  153. {
  154. item["from"] = from;
  155. }
  156. file << LLChatLogFormatter(item) << std::endl;
  157. file.close();
  158. }
  159. void LLLogChat::loadHistory(const std::string& filename, void (*callback)(ELogLineType, const LLSD&, void*), void* userdata)
  160. {
  161. if(!filename.size())
  162. {
  163. llwarns << "Filename is Empty!" << llendl;
  164. return ;
  165. }
  166.         
  167. LLFILE* fptr = LLFile::fopen(makeLogFileName(filename), "r"); /*Flawfinder: ignore*/
  168. if (!fptr)
  169. {
  170. callback(LOG_EMPTY, LLSD(), userdata);
  171. return; //No previous conversation with this name.
  172. }
  173. else
  174. {
  175. char buffer[LOG_RECALL_SIZE]; /*Flawfinder: ignore*/
  176. char *bptr;
  177. S32 len;
  178. bool firstline=TRUE;
  179. if ( fseek(fptr, (LOG_RECALL_SIZE - 1) * -1  , SEEK_END) )
  180. { //File is smaller than recall size.  Get it all.
  181. firstline = FALSE;
  182. if ( fseek(fptr, 0, SEEK_SET) )
  183. {
  184. fclose(fptr);
  185. return;
  186. }
  187. }
  188. while ( fgets(buffer, LOG_RECALL_SIZE, fptr)  && !feof(fptr) ) 
  189. {
  190. len = strlen(buffer) - 1; /*Flawfinder: ignore*/
  191. for ( bptr = (buffer + len); (*bptr == 'n' || *bptr == 'r') && bptr>buffer; bptr--) *bptr='';
  192. if (!firstline)
  193. {
  194. LLSD item;
  195. std::string line(buffer);
  196. std::istringstream iss(line);
  197. if (!LLChatLogParser::parse(line, item))
  198. {
  199. item["message"] = line;
  200. callback(LOG_LINE, item, userdata);
  201. }
  202. else
  203. {
  204. callback(LOG_LLSD, item, userdata);
  205. }
  206. }
  207. else
  208. {
  209. firstline = FALSE;
  210. }
  211. }
  212. callback(LOG_END, LLSD(), userdata);
  213. fclose(fptr);
  214. }
  215. }
  216. void append_to_last_message(std::list<LLSD>& messages, const std::string& line)
  217. {
  218. if (!messages.size()) return;
  219. std::string im_text = messages.back()[IM_TEXT].asString();
  220. im_text.append(line);
  221. messages.back()[IM_TEXT] = im_text;
  222. }
  223. void LLLogChat::loadAllHistory(const std::string& file_name, std::list<LLSD>& messages)
  224. {
  225. if (file_name.empty())
  226. {
  227. llwarns << "Session name is Empty!" << llendl;
  228. return ;
  229. }
  230. LLFILE* fptr = LLFile::fopen(makeLogFileName(file_name), "r"); /*Flawfinder: ignore*/
  231. if (!fptr) return; //No previous conversation with this name.
  232. char buffer[LOG_RECALL_SIZE]; /*Flawfinder: ignore*/
  233. char *bptr;
  234. S32 len;
  235. bool firstline = TRUE;
  236. if (fseek(fptr, (LOG_RECALL_SIZE - 1) * -1  , SEEK_END))
  237. { //File is smaller than recall size.  Get it all.
  238. firstline = FALSE;
  239. if (fseek(fptr, 0, SEEK_SET))
  240. {
  241. fclose(fptr);
  242. return;
  243. }
  244. }
  245. while (fgets(buffer, LOG_RECALL_SIZE, fptr)  && !feof(fptr)) 
  246. {
  247. len = strlen(buffer) - 1; /*Flawfinder: ignore*/
  248. for (bptr = (buffer + len); (*bptr == 'n' || *bptr == 'r') && bptr>buffer; bptr--) *bptr='';
  249. if (firstline)
  250. {
  251. firstline = FALSE;
  252. continue;
  253. }
  254. std::string line(buffer);
  255. //updated 1.23 plaint text log format requires a space added before subsequent lines in a multilined message
  256. if (' ' == line[0])
  257. {
  258. line.erase(0, MULTI_LINE_PREFIX.length());
  259. append_to_last_message(messages, 'n' + line);
  260. }
  261. else if (0 == len && ('n' == line[0] || 'r' == line[0]))
  262. {
  263. //to support old format's multilined messages with new lines used to divide paragraphs
  264. append_to_last_message(messages, line);
  265. }
  266. else
  267. {
  268. LLSD item;
  269. if (!LLChatLogParser::parse(line, item))
  270. {
  271. item[IM_TEXT] = line;
  272. }
  273. messages.push_back(item);
  274. }
  275. }
  276. fclose(fptr);
  277. }
  278. //*TODO mark object's names in a special way so that they will be distinguishable form avatar name 
  279. //which are more strict by its nature (only firstname and secondname)
  280. //Example, an object's name can be writen like "Object <actual_object's_name>"
  281. void LLChatLogFormatter::format(const LLSD& im, std::ostream& ostr) const
  282. {
  283. if (!im.isMap())
  284. {
  285. llwarning("invalid LLSD type of an instant message", 0);
  286. return;
  287. }
  288. if (im[IM_TIME].isDefined())
  289. {
  290. std::string timestamp = im[IM_TIME].asString();
  291. boost::trim(timestamp);
  292. ostr << '[' << timestamp << ']' << TWO_SPACES;
  293. }
  294. //*TODO mark object's names in a special way so that they will be distinguishable form avatar name 
  295. //which are more strict by its nature (only firstname and secondname)
  296. //Example, an object's name can be writen like "Object <actual_object's_name>"
  297. if (im[IM_FROM].isDefined())
  298. {
  299. std::string from = im[IM_FROM].asString();
  300. boost::trim(from);
  301. if (from.size())
  302. {
  303. ostr << from << IM_SEPARATOR;
  304. }
  305. }
  306. if (im[IM_TEXT].isDefined())
  307. {
  308. std::string im_text = im[IM_TEXT].asString();
  309. //multilined text will be saved with prepended spaces
  310. boost::replace_all(im_text, NEW_LINE, NEW_LINE_SPACE_PREFIX);
  311. ostr << im_text;
  312. }
  313. }
  314. bool LLChatLogParser::parse(std::string& raw, LLSD& im)
  315. {
  316. if (!raw.length()) return false;
  317. im = LLSD::emptyMap();
  318. //matching a timestamp
  319. boost::match_results<std::string::const_iterator> matches;
  320. if (!boost::regex_match(raw, matches, TIMESTAMP_AND_STUFF)) return false;
  321. bool has_timestamp = matches[IDX_TIMESTAMP].matched;
  322. if (has_timestamp)
  323. {
  324. //timestamp was successfully parsed
  325. std::string timestamp = matches[IDX_TIMESTAMP];
  326. boost::trim(timestamp);
  327. timestamp.erase(0, 1);
  328. timestamp.erase(timestamp.length()-1, 1);
  329. im[IM_TIME] = timestamp;
  330. }
  331. else
  332. {
  333. //timestamp is optional
  334. im[IM_TIME] = "";
  335. }
  336. bool has_stuff = matches[IDX_STUFF].matched;
  337. if (!has_stuff)
  338. {
  339. return false;  //*TODO should return false or not?
  340. }
  341. //matching a name and a text
  342. std::string stuff = matches[IDX_STUFF];
  343. boost::match_results<std::string::const_iterator> name_and_text;
  344. if (!boost::regex_match(stuff, name_and_text, NAME_AND_TEXT)) return false;
  345. bool has_name = name_and_text[IDX_NAME].matched;
  346. std::string name = name_and_text[IDX_NAME];
  347. //we don't need a name/text separator
  348. if (has_name && name.length() && name[name.length()-1] == ':')
  349. {
  350. name.erase(name.length()-1, 1);
  351. }
  352. if (!has_name || name == SYSTEM_FROM)
  353. {
  354. //name is optional too
  355. im[IM_FROM] = SYSTEM_FROM;
  356. im[IM_FROM_ID] = LLUUID::null;
  357. }
  358. //possibly a case of complex object names consisting of 3+ words
  359. if (!has_name)
  360. {
  361. U32 divider_pos = stuff.find(NAME_TEXT_DIVIDER);
  362. if (divider_pos != std::string::npos && divider_pos < (stuff.length() - NAME_TEXT_DIVIDER.length()))
  363. {
  364. im[IM_FROM] = stuff.substr(0, divider_pos);
  365. im[IM_TEXT] = stuff.substr(divider_pos + NAME_TEXT_DIVIDER.length());
  366. return true;
  367. }
  368. }
  369. if (!has_name)
  370. {
  371. //text is mandatory
  372. im[IM_TEXT] = stuff;
  373. return true; //parse as a message from Second Life
  374. }
  375. bool has_text = name_and_text[IDX_TEXT].matched;
  376. if (!has_text) return false;
  377. //for parsing logs created in very old versions of a viewer
  378. if (name == "You")
  379. {
  380. std::string agent_name;
  381. LLAgentUI::buildFullname(agent_name);
  382. im[IM_FROM] = agent_name;
  383. im[IM_FROM_ID] = gAgentID;
  384. }
  385. else
  386. {
  387. im[IM_FROM] = name;
  388. }
  389. im[IM_TEXT] = name_and_text[IDX_TEXT];
  390. return true;  //parsed name and message text, maybe have a timestamp too
  391. }