jlog.cpp 106 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251
  1. /*##############################################################################
  2. HPCC SYSTEMS software Copyright (C) 2012 HPCC Systems®.
  3. Licensed under the Apache License, Version 2.0 (the "License");
  4. you may not use this file except in compliance with the License.
  5. You may obtain a copy of the License at
  6. http://www.apache.org/licenses/LICENSE-2.0
  7. Unless required by applicable law or agreed to in writing, software
  8. distributed under the License is distributed on an "AS IS" BASIS,
  9. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  10. See the License for the specific language governing permissions and
  11. limitations under the License.
  12. ############################################################################## */
  13. #include "platform.h"
  14. #include <algorithm>
  15. #include "stdio.h"
  16. #include "jlog.hpp"
  17. #include "jlog.ipp"
  18. #include "jmutex.hpp"
  19. #include "jarray.hpp"
  20. #include "jsocket.hpp"
  21. #include "jmisc.hpp"
  22. #include "jprop.hpp"
  23. #include "lnuid.h"
  24. using namespace ln_uid;
  25. #define MSGCOMP_NUMBER 1000
  26. #define FILE_LOG_ENABLES_QUEUEUING
  27. #ifndef _WIN32
  28. #define AUDIT_DATA_LOG_TEMPLATE "/var/log/seisint/log_data_XXXXXX"
  29. #endif
  30. // Time, in nanoseconds, after which the clock field loops --- 3600000000000ns = 1hr
  31. #define CLOCK_LOOP_NANOSECONDS I64C(3600000000000)
  32. // LogMsgSysInfo
  33. static FILE *getNullHandle()
  34. {
  35. #ifdef _WIN32
  36. return fopen("nul","w");
  37. #else
  38. return fopen("/dev/null","w");
  39. #endif
  40. }
  41. LogMsgSysInfo::LogMsgSysInfo(LogMsgId _id, unsigned port, LogMsgSessionId session)
  42. {
  43. id = _id;
  44. #ifdef _WIN32
  45. // Hack for the fact that Windows doesn't handle gettimeofday
  46. // Subsecond timing granularities in log files will not be available
  47. time(&timeStarted);
  48. #else
  49. gettimeofday(&timeStarted, NULL);
  50. #endif
  51. processID = GetCurrentProcessId();
  52. threadID = threadLogID();
  53. sessionID = session;
  54. #ifdef INCLUDE_LOGMSGSYSINFO_NODE
  55. node.setLocalHost(port);
  56. #endif
  57. }
  58. void LogMsgSysInfo::serialize(MemoryBuffer & out) const
  59. {
  60. out.append(id).append((unsigned) queryTime()).append(processID).append(threadID).append(sessionID); node.serialize(out);
  61. }
  62. void LogMsgSysInfo::deserialize(MemoryBuffer & in)
  63. {
  64. unsigned t;
  65. in.read(id).read(t).read(processID).read(threadID).read(sessionID); node.deserialize(in);
  66. #ifdef _WIN32
  67. timeStarted = t;
  68. #else
  69. timeStarted.tv_sec = t;
  70. timeStarted.tv_usec = 0; // For back-compatibility reasons, the subsecond timings are not serialized
  71. #endif
  72. }
  73. class LoggingFieldColumns
  74. {
  75. const EnumMapping MsgFieldMap[16] =
  76. {
  77. { MSGFIELD_msgID, "MsgID " },
  78. { MSGFIELD_audience, "Audience " },
  79. { MSGFIELD_class, "Class " },
  80. { MSGFIELD_detail, "Detail " },
  81. { MSGFIELD_date, "Date " },
  82. { MSGFIELD_microTime, "Time(micro) " },
  83. { MSGFIELD_milliTime, "Time(milli) " },
  84. { MSGFIELD_time, "Time " },
  85. { MSGFIELD_process, "PID " },
  86. { MSGFIELD_thread, "TID " },
  87. { MSGFIELD_session, "SessionID " },
  88. { MSGFIELD_node, "Node " },
  89. { MSGFIELD_job, "JobID " },
  90. { MSGFIELD_user, "UserID " },
  91. { MSGFIELD_component, "Compo " },
  92. { MSGFIELD_quote, "Quoted "}
  93. };
  94. const unsigned sizeMsgFieldMap = arraysize(MsgFieldMap);
  95. public:
  96. unsigned getMaxHeaderSize()
  97. {
  98. // Note: return length is slightly longer than necessary as only one time field is valid
  99. // but the length of all time fields are added
  100. unsigned size = 0;
  101. for (unsigned i=0; i<sizeMsgFieldMap; ++i)
  102. size += strlen(MsgFieldMap[i].str);
  103. return size+2; // 2 extra characters for \r\n
  104. }
  105. unsigned getPositionOfField(unsigned logfields, unsigned positionoffield)
  106. {
  107. unsigned pos = 0;
  108. for (unsigned i=0; i<sizeMsgFieldMap; ++i)
  109. {
  110. if (MsgFieldMap[i].val==MSGFIELD_time && (logfields & (MSGFIELD_microTime|MSGFIELD_milliTime)) )
  111. continue;
  112. if (MsgFieldMap[i].val & positionoffield)
  113. break;
  114. if (MsgFieldMap[i].val & logfields)
  115. ++pos;
  116. }
  117. return pos;
  118. }
  119. unsigned extractMessageFieldsFromHeader(const char *line, bool hashPrefixed)
  120. {
  121. unsigned fieldHeader = 0;
  122. if (line && *line=='#')
  123. {
  124. ++line;
  125. const unsigned sizeFieldMap = arraysize(MsgFieldMap);
  126. for (unsigned i=0; i<sizeFieldMap; ++i)
  127. {
  128. const char * linep = line;
  129. const char * fieldp = MsgFieldMap[i].str;
  130. while( *fieldp && *linep==*fieldp)
  131. {
  132. ++linep;
  133. ++fieldp;
  134. }
  135. if (*fieldp==0) // At the end of the field, so whole field matched
  136. {
  137. fieldHeader |= MsgFieldMap[i].val;
  138. if (*linep==0 || *linep=='\n')
  139. break;
  140. line = linep;
  141. }
  142. }
  143. }
  144. if (fieldHeader & (MSGFIELD_microTime | MSGFIELD_milliTime))
  145. fieldHeader |= MSGFIELD_time;
  146. return fieldHeader;
  147. }
  148. StringBuffer & generateHeaderRow(StringBuffer & out, unsigned fields, bool prefixHash)
  149. {
  150. if (prefixHash)
  151. out.append('#');
  152. for (unsigned i=0; i<sizeMsgFieldMap; ++i)
  153. if (fields & MsgFieldMap[i].val)
  154. {
  155. if (MsgFieldMap[i].val==MSGFIELD_time && (fields & (MSGFIELD_microTime|MSGFIELD_milliTime)) )
  156. continue;
  157. out.append(MsgFieldMap[i].str);
  158. }
  159. return out;
  160. }
  161. } loggingFieldColumns;
  162. unsigned getPositionOfField(unsigned logfields, unsigned positionoffield)
  163. {
  164. return loggingFieldColumns.getPositionOfField(logfields, positionoffield);
  165. }
  166. // LogMsg
  167. LogMsgJobInfo::~LogMsgJobInfo()
  168. {
  169. if (isDeserialized)
  170. free((void *) jobIDStr);
  171. }
  172. const char * LogMsgJobInfo::queryJobIDStr() const
  173. {
  174. if (isDeserialized)
  175. return jobIDStr;
  176. else if (jobID == UnknownJob)
  177. return "UNK";
  178. else
  179. return theManager->queryJobId(jobID);
  180. }
  181. LogMsgJobId LogMsgJobInfo::queryJobID() const
  182. {
  183. if (isDeserialized)
  184. return UnknownJob; // Or assert?
  185. else
  186. return jobID;
  187. }
  188. void LogMsgJobInfo::setJobID(LogMsgUserId id)
  189. {
  190. if (isDeserialized)
  191. free((void *) jobIDStr);
  192. jobID = id;
  193. isDeserialized = false;
  194. }
  195. void LogMsgJobInfo::serialize(MemoryBuffer & out) const
  196. {
  197. if (isDeserialized)
  198. out.append(jobIDStr);
  199. else
  200. out.append(theManager->queryJobId(jobID));
  201. out.append(userID);
  202. }
  203. void LogMsgJobInfo::deserialize(MemoryBuffer & in)
  204. {
  205. StringBuffer idStr;
  206. in.read(idStr);
  207. jobIDStr = idStr.detach();
  208. in.read(userID);
  209. isDeserialized = true;
  210. }
  211. static LogMsgJobInfo globalDefaultJobInfo(UnknownJob, UnknownUser);
  212. static thread_local LogMsgJobInfo defaultJobInfo = globalDefaultJobInfo;
  213. const LogMsgJobInfo unknownJob(UnknownJob, UnknownUser);
  214. void resetThreadLogging()
  215. {
  216. // Note - as implemented the thread default job info is determined by what the global one was when the thread was created.
  217. // There is an alternative interpretation, that an unset thread-local one should default to whatever the global one is at the time the thread one is used.
  218. // In practice I doubt there's a lot of difference as global one is likely to be set once at program startup
  219. defaultJobInfo = globalDefaultJobInfo;
  220. }
  221. const LogMsgJobInfo & checkDefaultJobInfo(const LogMsgJobInfo & _jobInfo)
  222. {
  223. if (&_jobInfo == &unknownJob)
  224. {
  225. return defaultJobInfo;
  226. }
  227. return _jobInfo;
  228. }
  229. void setDefaultJobId(const char *id, bool threaded)
  230. {
  231. setDefaultJobId(theManager->addJobId(id), threaded);
  232. }
  233. void setDefaultJobId(LogMsgJobId id, bool threaded)
  234. {
  235. if (!threaded)
  236. globalDefaultJobInfo.setJobID(id);
  237. defaultJobInfo.setJobID(id);
  238. }
  239. LogMsg::LogMsg(LogMsgJobId id, const char *job) : category(MSGAUD_programmer, job ? MSGCLS_addid : MSGCLS_removeid), sysInfo(), jobInfo(id), remoteFlag(false)
  240. {
  241. if (job)
  242. text.append(job);
  243. }
  244. LogMsg::LogMsg(const LogMsgCategory & _cat, LogMsgId _id, const LogMsgJobInfo & _jobInfo, LogMsgCode _code, const char * _text, unsigned _compo, unsigned port, LogMsgSessionId session)
  245. : category(_cat), sysInfo(_id, port, session), jobInfo(checkDefaultJobInfo(_jobInfo)), msgCode(_code), component(_compo), remoteFlag(false)
  246. {
  247. text.append(_text);
  248. }
  249. LogMsg::LogMsg(const LogMsgCategory & _cat, LogMsgId _id, const LogMsgJobInfo & _jobInfo, LogMsgCode _code, size32_t sz, const char * _text, unsigned _compo, unsigned port, LogMsgSessionId session)
  250. : category(_cat), sysInfo(_id, port, session), jobInfo(checkDefaultJobInfo(_jobInfo)), msgCode(_code), component(_compo), remoteFlag(false)
  251. {
  252. text.append(sz, _text);
  253. }
  254. LogMsg::LogMsg(const LogMsgCategory & _cat, LogMsgId _id, const LogMsgJobInfo & _jobInfo, LogMsgCode _code, const char * format, va_list args,
  255. unsigned _compo, unsigned port, LogMsgSessionId session)
  256. : category(_cat), sysInfo(_id, port, session), jobInfo(checkDefaultJobInfo(_jobInfo)), msgCode(_code), component(_compo), remoteFlag(false)
  257. {
  258. text.valist_appendf(format, args);
  259. }
  260. StringBuffer & LogMsg::toStringPlain(StringBuffer & out, unsigned fields) const
  261. {
  262. out.ensureCapacity(LOG_MSG_FORMAT_BUFFER_LENGTH);
  263. if(fields & MSGFIELD_msgID)
  264. out.appendf("id=%X ", sysInfo.queryMsgID());
  265. if(fields & MSGFIELD_audience)
  266. out.append("aud=").append(LogMsgAudienceToVarString(category.queryAudience())).append(' ');
  267. if(fields & MSGFIELD_class)
  268. out.append("cls=").append(LogMsgClassToFixString(category.queryClass())).append(' ');
  269. if(fields & MSGFIELD_detail)
  270. out.appendf("det=%d ", category.queryDetail());
  271. if(fields & MSGFIELD_timeDate)
  272. {
  273. time_t timeNum = sysInfo.queryTime();
  274. char timeString[12];
  275. struct tm timeStruct;
  276. localtime_r(&timeNum, &timeStruct);
  277. if(fields & MSGFIELD_date)
  278. {
  279. strftime(timeString, 12, "%Y-%m-%d ", &timeStruct);
  280. out.append(timeString);
  281. }
  282. if(fields & MSGFIELD_microTime)
  283. {
  284. out.appendf("%02d:%02d:%02d.%06d ", timeStruct.tm_hour, timeStruct.tm_min, timeStruct.tm_sec, sysInfo.queryUSecs());
  285. }
  286. else if(fields & MSGFIELD_milliTime)
  287. {
  288. out.appendf("%02d:%02d:%02d.%03d ", timeStruct.tm_hour, timeStruct.tm_min, timeStruct.tm_sec, sysInfo.queryUSecs()/1000);
  289. }
  290. else if(fields & MSGFIELD_time)
  291. {
  292. strftime(timeString, 12, "%H:%M:%S ", &timeStruct);
  293. out.append(timeString);
  294. }
  295. }
  296. if(fields & MSGFIELD_process)
  297. out.appendf("pid=%d ",sysInfo.queryProcessID());
  298. if(fields & MSGFIELD_thread)
  299. out.appendf("tid=%d ",sysInfo.queryThreadID());
  300. if(fields & MSGFIELD_session)
  301. {
  302. if(sysInfo.querySessionID() == UnknownSession)
  303. out.append("sid=unknown ");
  304. else
  305. out.appendf("sid=%" I64F "u ", sysInfo.querySessionID());
  306. }
  307. if(fields & MSGFIELD_node)
  308. {
  309. sysInfo.queryNode()->getUrlStr(out);
  310. out.append(" ");
  311. }
  312. if(fields & MSGFIELD_job)
  313. {
  314. out.appendf("job=%s ", jobInfo.queryJobIDStr());
  315. }
  316. if(fields & MSGFIELD_user)
  317. {
  318. if(jobInfo.queryUserID() == UnknownUser)
  319. out.append("usr=unknown ");
  320. else
  321. out.appendf("usr=%" I64F "u ", jobInfo.queryUserID());
  322. }
  323. if(fields & MSGFIELD_component)
  324. out.appendf("cmp=%u ", component);
  325. if (fields & MSGFIELD_quote)
  326. out.append('"');
  327. if (fields & MSGFIELD_prefix)
  328. out.append(msgPrefix(category.queryClass()));
  329. if((fields & MSGFIELD_code) && (msgCode != NoLogMsgCode))
  330. out.append(msgCode).append(": ").append(text.str());
  331. else
  332. out.append(text.str());
  333. if (fields & MSGFIELD_quote)
  334. out.append('"');
  335. return out;
  336. }
  337. StringBuffer & LogMsg::toStringXML(StringBuffer & out, unsigned fields) const
  338. {
  339. out.ensureCapacity(LOG_MSG_FORMAT_BUFFER_LENGTH);
  340. out.append("<msg ");
  341. if(fields & MSGFIELD_msgID)
  342. out.append("MessageID=\"").append(sysInfo.queryMsgID()).append("\" ");
  343. if(fields & MSGFIELD_audience)
  344. out.append("Audience=\"").append(LogMsgAudienceToVarString(category.queryAudience())).append("\" ");
  345. if(fields & MSGFIELD_class)
  346. out.append("Class=\"").append(LogMsgClassToVarString(category.queryClass())).append("\" ");
  347. if(fields & MSGFIELD_detail)
  348. out.append("Detail=\"").append(category.queryDetail()).append("\" ");
  349. #ifdef LOG_MSG_NEWLINE
  350. if(fields & MSGFIELD_allCategory) out.append("\n ");
  351. #endif
  352. if(fields & MSGFIELD_timeDate)
  353. {
  354. time_t timeNum = sysInfo.queryTime();
  355. char timeString[20];
  356. struct tm timeStruct;
  357. localtime_r(&timeNum, &timeStruct);
  358. if(fields & MSGFIELD_date)
  359. {
  360. strftime(timeString, 20, "date=\"%Y-%m-%d\" ", &timeStruct);
  361. out.append(timeString);
  362. }
  363. if(fields & MSGFIELD_microTime)
  364. {
  365. out.appendf("time=\"%02d:%02d:%02d.%06d\" ", timeStruct.tm_hour, timeStruct.tm_min, timeStruct.tm_sec, sysInfo.queryUSecs());
  366. }
  367. else if(fields & MSGFIELD_milliTime)
  368. {
  369. out.appendf("time=\"%02d:%02d:%02d.%03d\" ", timeStruct.tm_hour, timeStruct.tm_min, timeStruct.tm_sec, sysInfo.queryUSecs()/1000);
  370. }
  371. else if(fields & MSGFIELD_time)
  372. {
  373. strftime(timeString, 20, "time=\"%H:%M:%S\" ", &timeStruct);
  374. out.append(timeString);
  375. }
  376. }
  377. if(fields & MSGFIELD_process)
  378. out.append("PID=\"").append(sysInfo.queryProcessID()).append("\" ");
  379. if(fields & MSGFIELD_thread)
  380. out.append("TID=\"").append(sysInfo.queryThreadID()).append("\" ");
  381. if(fields & MSGFIELD_session)
  382. {
  383. if(sysInfo.querySessionID() == UnknownSession)
  384. out.append("SessionID=\"unknown\" ");
  385. else
  386. out.append("SessionID=\"").append(sysInfo.querySessionID()).append("\" ");
  387. }
  388. if(fields & MSGFIELD_node)
  389. {
  390. out.append("Node=\"");
  391. sysInfo.queryNode()->getUrlStr(out);
  392. out.append("\" ");
  393. }
  394. #ifdef LOG_MSG_NEWLINE
  395. if(fields & MSGFIELD_allSysInfo) out.append("\n ");
  396. #endif
  397. if(fields & MSGFIELD_job)
  398. {
  399. out.appendf("JobID=\"%s\" ", jobInfo.queryJobIDStr());
  400. }
  401. if(fields & MSGFIELD_user)
  402. {
  403. if(jobInfo.queryUserID() == UnknownUser)
  404. out.append("UserID=\"unknown\" ");
  405. else
  406. out.append("UserID=\"").append(jobInfo.queryUserID()).append("\" ");
  407. }
  408. #ifdef LOG_MSG_NEWLINE
  409. if(fields & MSGFIELD_allJobInfo) out.append("\n ");
  410. #endif
  411. if(fields & MSGFIELD_component) out.append("Component=\"").append(component).append("\" ");
  412. if((fields & MSGFIELD_code) && (msgCode != NoLogMsgCode))
  413. out.append("code=\"").append(msgCode).append("\" ");
  414. out.append("text=\"").append(text.str()).append("\" />\n");
  415. return out;
  416. }
  417. StringBuffer & LogMsg::toStringTable(StringBuffer & out, unsigned fields) const
  418. {
  419. if(fields & MSGFIELD_msgID)
  420. out.appendf("%8X ", sysInfo.queryMsgID());
  421. out.ensureCapacity(LOG_MSG_FORMAT_BUFFER_LENGTH);
  422. if(fields & MSGFIELD_audience)
  423. out.append(LogMsgAudienceToFixString(category.queryAudience()));
  424. if(fields & MSGFIELD_class)
  425. out.append(LogMsgClassToFixString(category.queryClass()));
  426. if(fields & MSGFIELD_detail)
  427. out.appendf("%10d ", category.queryDetail());
  428. if(fields & MSGFIELD_timeDate)
  429. {
  430. time_t timeNum = sysInfo.queryTime();
  431. char timeString[12];
  432. struct tm timeStruct;
  433. localtime_r(&timeNum, &timeStruct);
  434. if(fields & MSGFIELD_date)
  435. {
  436. strftime(timeString, 12, "%Y-%m-%d ", &timeStruct);
  437. out.append(timeString);
  438. }
  439. if(fields & MSGFIELD_microTime)
  440. {
  441. out.appendf("%02d:%02d:%02d.%06d ", timeStruct.tm_hour, timeStruct.tm_min, timeStruct.tm_sec, sysInfo.queryUSecs());
  442. }
  443. else if(fields & MSGFIELD_milliTime)
  444. {
  445. out.appendf("%02d:%02d:%02d.%03d ", timeStruct.tm_hour, timeStruct.tm_min, timeStruct.tm_sec, sysInfo.queryUSecs()/1000);
  446. }
  447. else if(fields & MSGFIELD_time)
  448. {
  449. strftime(timeString, 12, "%H:%M:%S ", &timeStruct);
  450. out.append(timeString);
  451. }
  452. }
  453. if(fields & MSGFIELD_process)
  454. out.appendf("%5d ",sysInfo.queryProcessID());
  455. if(fields & MSGFIELD_thread)
  456. out.appendf("%5d ",sysInfo.queryThreadID());
  457. if(fields & MSGFIELD_session)
  458. {
  459. if(sysInfo.querySessionID() == UnknownSession)
  460. out.append(" unknown ");
  461. else
  462. out.appendf("%20" I64F "u ", sysInfo.querySessionID());
  463. }
  464. if(fields & MSGFIELD_node)
  465. {
  466. size32_t len = out.length();
  467. sysInfo.queryNode()->getUrlStr(out);
  468. out.appendN(20 + len - out.length(), ' ');
  469. }
  470. if(fields & MSGFIELD_job)
  471. {
  472. out.appendf("%-7s ", jobInfo.queryJobIDStr());
  473. }
  474. if(fields & MSGFIELD_user)
  475. {
  476. if(jobInfo.queryUserID() == UnknownUser)
  477. out.append("unknown ");
  478. else
  479. out.appendf("%7" I64F "u ", jobInfo.queryUserID());
  480. }
  481. if(fields & MSGFIELD_component)
  482. out.appendf("%6u ", component);
  483. if (fields & MSGFIELD_quote)
  484. out.append('"');
  485. if (fields & MSGFIELD_prefix)
  486. out.append(msgPrefix(category.queryClass()));
  487. if((fields & MSGFIELD_code) && (msgCode != NoLogMsgCode))
  488. out.append(msgCode).append(": ").append(text.str());
  489. else
  490. out.append(text.str());
  491. if (fields & MSGFIELD_quote)
  492. out.append('"');
  493. out.append('\n');
  494. return out;
  495. }
  496. StringBuffer & LogMsg::toStringTableHead(StringBuffer & out, unsigned fields)
  497. {
  498. loggingFieldColumns.generateHeaderRow(out, fields, false).append("\n\n");
  499. return out;
  500. }
  501. void LogMsg::fprintPlain(FILE * handle, unsigned fields) const
  502. {
  503. if(fields & MSGFIELD_msgID)
  504. fprintf(handle, "id=%X ", sysInfo.queryMsgID());
  505. if(fields & MSGFIELD_audience)
  506. fprintf(handle, "aud=%s", LogMsgAudienceToVarString(category.queryAudience()));
  507. if(fields & MSGFIELD_class)
  508. fprintf(handle, "cls=%s", LogMsgClassToFixString(category.queryClass()));
  509. if(fields & MSGFIELD_detail)
  510. fprintf(handle, "det=%d ", category.queryDetail());
  511. if(fields & MSGFIELD_timeDate)
  512. {
  513. time_t timeNum = sysInfo.queryTime();
  514. char timeString[12];
  515. struct tm timeStruct;
  516. localtime_r(&timeNum, &timeStruct);
  517. if(fields & MSGFIELD_date)
  518. {
  519. strftime(timeString, 12, "%Y-%m-%d ", &timeStruct);
  520. fputs(timeString, handle);
  521. }
  522. if(fields & MSGFIELD_microTime)
  523. {
  524. fprintf(handle, "%02d:%02d:%02d.%06d ", timeStruct.tm_hour, timeStruct.tm_min, timeStruct.tm_sec, sysInfo.queryUSecs());
  525. }
  526. else if(fields & MSGFIELD_milliTime)
  527. {
  528. fprintf(handle, "%02d:%02d:%02d.%03d ", timeStruct.tm_hour, timeStruct.tm_min, timeStruct.tm_sec, sysInfo.queryUSecs()/1000);
  529. }
  530. else if(fields & MSGFIELD_time)
  531. {
  532. strftime(timeString, 12, "%H:%M:%S ", &timeStruct);
  533. fputs(timeString, handle);
  534. }
  535. }
  536. if(fields & MSGFIELD_process)
  537. fprintf(handle, "pid=%d ",sysInfo.queryProcessID());
  538. if(fields & MSGFIELD_thread)
  539. fprintf(handle, "tid=%d ",sysInfo.queryThreadID());
  540. if(fields & MSGFIELD_session)
  541. {
  542. if(sysInfo.querySessionID() == UnknownSession)
  543. fprintf(handle, "sid=unknown ");
  544. else
  545. fprintf(handle, "sid=%" I64F "u ", sysInfo.querySessionID());
  546. }
  547. if(fields & MSGFIELD_node)
  548. {
  549. StringBuffer buff;
  550. sysInfo.queryNode()->getUrlStr(buff);
  551. fprintf(handle, "%s ", buff.str());
  552. }
  553. if(fields & MSGFIELD_job)
  554. {
  555. fprintf(handle, "job=%s ", jobInfo.queryJobIDStr());
  556. }
  557. if(fields & MSGFIELD_user)
  558. {
  559. if(jobInfo.queryUserID() == UnknownUser)
  560. fprintf(handle, "usr=unknown ");
  561. else
  562. fprintf(handle, "usr=%" I64F "u ", jobInfo.queryUserID());
  563. }
  564. if(fields & MSGFIELD_component)
  565. fprintf(handle, "cmp=%u ", component);
  566. const char * quote = (fields & MSGFIELD_quote) ? "\"" : "";
  567. const char * prefix = (fields & MSGFIELD_prefix) ? msgPrefix(category.queryClass()) : "";
  568. if((fields & MSGFIELD_code) && (msgCode != NoLogMsgCode))
  569. fprintf(handle, "%s%s%d: %s%s", quote, prefix, msgCode, text.str(), quote);
  570. else
  571. fprintf(handle, "%s%s%s%s", quote, prefix, text.str(), quote);
  572. }
  573. void LogMsg::fprintXML(FILE * handle, unsigned fields) const
  574. {
  575. fprintf(handle, "<msg ");
  576. if(fields & MSGFIELD_msgID)
  577. fprintf(handle, "MessageID=\"%d\" ",sysInfo.queryMsgID());
  578. if(fields & MSGFIELD_audience)
  579. fprintf(handle, "Audience=\"%s\" ", LogMsgAudienceToVarString(category.queryAudience()));
  580. if(fields & MSGFIELD_class)
  581. fprintf(handle, "Class=\"%s\" ", LogMsgClassToVarString(category.queryClass()));
  582. if(fields & MSGFIELD_detail)
  583. fprintf(handle, "Detail=\"%d\" ", category.queryDetail());
  584. #ifdef LOG_MSG_NEWLINE
  585. if(fields & MSGFIELD_allCategory) fprintf(handle, "\n ");
  586. #endif
  587. if(fields & MSGFIELD_timeDate)
  588. {
  589. time_t timeNum = sysInfo.queryTime();
  590. char timeString[20];
  591. struct tm timeStruct;
  592. localtime_r(&timeNum, &timeStruct);
  593. if(fields & MSGFIELD_date)
  594. {
  595. strftime(timeString, 20, "date=\"%Y-%m-%d\" ", &timeStruct);
  596. fputs(timeString, handle);
  597. }
  598. if(fields & MSGFIELD_microTime)
  599. {
  600. fprintf(handle, "time=\"%02d:%02d:%02d.%06d\" ", timeStruct.tm_hour, timeStruct.tm_min, timeStruct.tm_sec, sysInfo.queryUSecs());
  601. }
  602. else if(fields & MSGFIELD_milliTime)
  603. {
  604. fprintf(handle, "time=\"%02d:%02d:%02d.%03d\" ", timeStruct.tm_hour, timeStruct.tm_min, timeStruct.tm_sec, sysInfo.queryUSecs()/1000);
  605. }
  606. else if(fields & MSGFIELD_time)
  607. {
  608. strftime(timeString, 20, "time=\"%H:%M:%S\" ", &timeStruct);
  609. fputs(timeString, handle);
  610. }
  611. }
  612. if(fields & MSGFIELD_process)
  613. fprintf(handle, "PID=\"%d\" ", sysInfo.queryProcessID());
  614. if(fields & MSGFIELD_thread)
  615. fprintf(handle, "TID=\"%d\" ", sysInfo.queryThreadID());
  616. if(fields & MSGFIELD_session)
  617. {
  618. if(sysInfo.querySessionID() == UnknownSession)
  619. fprintf(handle, "SessionID=\"unknown\" ");
  620. else
  621. fprintf(handle, "SessionID=\"%" I64F "u\" ", sysInfo.querySessionID());
  622. }
  623. if(fields & MSGFIELD_node)
  624. {
  625. StringBuffer buff;
  626. sysInfo.queryNode()->getUrlStr(buff);
  627. fprintf(handle, "Node=\"%s\" ", buff.str());
  628. }
  629. #ifdef LOG_MSG_NEWLINE
  630. if(fields & MSGFIELD_allSysInfo) fprintf(handle, "\n ");
  631. #endif
  632. if(fields & MSGFIELD_job)
  633. {
  634. fprintf(handle, "JobID=\"%s\" ", jobInfo.queryJobIDStr());
  635. }
  636. if(fields & MSGFIELD_user)
  637. {
  638. if(jobInfo.queryUserID() == UnknownUser)
  639. fprintf(handle, "UserID=\"unknown\" ");
  640. else
  641. fprintf(handle, "UserID=\"%" I64F "u\" ", jobInfo.queryUserID());
  642. }
  643. if(fields & MSGFIELD_component)
  644. fprintf(handle, "Component=\"%6u\" ", component);
  645. #ifdef LOG_MSG_NEWLINE
  646. if(fields & MSGFIELD_allJobInfo) fprintf(handle, "\n ");
  647. #endif
  648. if((fields & MSGFIELD_code) && (msgCode != NoLogMsgCode))
  649. fprintf(handle, "code=\"%d\" ", msgCode);
  650. fprintf(handle, "text=\"%s\" />\n", text.str());
  651. }
  652. void LogMsg::fprintTable(FILE * handle, unsigned fields) const
  653. {
  654. if(fields & MSGFIELD_msgID)
  655. fprintf(handle, "%08X ", sysInfo.queryMsgID());
  656. if(fields & MSGFIELD_audience)
  657. fputs(LogMsgAudienceToFixString(category.queryAudience()), handle);
  658. if(fields & MSGFIELD_class)
  659. fputs(LogMsgClassToFixString(category.queryClass()), handle);
  660. if(fields & MSGFIELD_detail)
  661. fprintf(handle, "%10d ", category.queryDetail());
  662. if(fields & MSGFIELD_timeDate)
  663. {
  664. time_t timeNum = sysInfo.queryTime();
  665. char timeString[12];
  666. struct tm timeStruct;
  667. localtime_r(&timeNum, &timeStruct);
  668. if(fields & MSGFIELD_date)
  669. {
  670. strftime(timeString, 12, "%Y-%m-%d ", &timeStruct);
  671. fputs(timeString, handle);
  672. }
  673. if(fields & MSGFIELD_microTime)
  674. {
  675. fprintf(handle, "%02d:%02d:%02d.%06d ", timeStruct.tm_hour, timeStruct.tm_min, timeStruct.tm_sec, sysInfo.queryUSecs());
  676. }
  677. else if(fields & MSGFIELD_milliTime)
  678. {
  679. fprintf(handle, "%02d:%02d:%02d.%03d ", timeStruct.tm_hour, timeStruct.tm_min, timeStruct.tm_sec, sysInfo.queryUSecs()/1000);
  680. }
  681. else if(fields & MSGFIELD_time)
  682. {
  683. strftime(timeString, 12, "%H:%M:%S ", &timeStruct);
  684. fputs(timeString, handle);
  685. }
  686. }
  687. if(fields & MSGFIELD_process)
  688. fprintf(handle, "%5d ",sysInfo.queryProcessID());
  689. if(fields & MSGFIELD_thread)
  690. fprintf(handle, "%5d ",sysInfo.queryThreadID());
  691. if(fields & MSGFIELD_session)
  692. {
  693. if(sysInfo.querySessionID() == UnknownSession)
  694. fprintf(handle, " unknown ");
  695. else
  696. fprintf(handle, "%20" I64F "u ", sysInfo.querySessionID());
  697. }
  698. if(fields & MSGFIELD_node)
  699. {
  700. StringBuffer buff;
  701. static const char * twenty_spaces = " ";
  702. sysInfo.queryNode()->getUrlStr(buff);
  703. fprintf(handle, "%s%s", buff.str(), (buff.length()<=20) ? twenty_spaces+buff.length() : "");
  704. }
  705. if(fields & MSGFIELD_job)
  706. {
  707. fprintf(handle, "%-7s ", jobInfo.queryJobIDStr());
  708. }
  709. if(fields & MSGFIELD_user)
  710. {
  711. if(jobInfo.queryUserID() == UnknownUser)
  712. fprintf(handle, "unknown ");
  713. else
  714. fprintf(handle, "%7" I64F "u ", jobInfo.queryUserID());
  715. }
  716. if(fields & MSGFIELD_component)
  717. fprintf(handle, "%6u ", component);
  718. const char * quote = (fields & MSGFIELD_quote) ? "\"" : "";
  719. const char * prefix = (fields & MSGFIELD_prefix) ? msgPrefix(category.queryClass()) : "";
  720. if((fields & MSGFIELD_code) && (msgCode != NoLogMsgCode))
  721. fprintf(handle, "%s%s%d: %s%s\n", quote, prefix, msgCode, text.str(), quote);
  722. else
  723. fprintf(handle, "%s%s%s%s\n", quote, prefix, text.str(), quote);
  724. }
  725. void LogMsg::fprintTableHead(FILE * handle, unsigned fields)
  726. {
  727. StringBuffer header;
  728. loggingFieldColumns.generateHeaderRow(header, fields, true).append("\n");
  729. fputs(header.str(), handle);
  730. }
  731. void LogMsg::deserialize(MemoryBuffer & in)
  732. {
  733. remoteFlag = true;
  734. category.deserialize(in);
  735. sysInfo.deserialize(in);
  736. jobInfo.deserialize(in);
  737. in.read(msgCode);
  738. text.clear();
  739. text.deserialize(in);
  740. }
  741. unsigned getMessageFieldsFromHeader(FILE *handle)
  742. {
  743. unsigned currentFieldHeader = 0;
  744. try
  745. {
  746. MemoryBuffer mb(loggingFieldColumns.getMaxHeaderSize());
  747. fpos_t pos;
  748. fgetpos (handle,&pos);
  749. rewind (handle);
  750. mb.reserve(loggingFieldColumns.getMaxHeaderSize());
  751. const char * line = fgets (static_cast<char *>(mb.bufferBase()), loggingFieldColumns.getMaxHeaderSize(), handle );
  752. if (line && *line)
  753. currentFieldHeader = loggingFieldColumns.extractMessageFieldsFromHeader(line, true);
  754. fsetpos (handle, &pos);
  755. }
  756. catch (...)
  757. {
  758. currentFieldHeader = 0;
  759. }
  760. return currentFieldHeader;
  761. }
  762. unsigned getMessageFieldsFromHeader(const char * line)
  763. {
  764. return loggingFieldColumns.extractMessageFieldsFromHeader(line, true);
  765. }
  766. // Implementations of ILogMsgFilter
  767. void PassAllLogMsgFilter::addToPTree(IPropertyTree * tree) const
  768. {
  769. IPropertyTree * filterTree = createPTree(ipt_caseInsensitive);
  770. filterTree->setProp("@type", "all");
  771. tree->addPropTree("filter", filterTree);
  772. }
  773. void PassLocalLogMsgFilter::addToPTree(IPropertyTree * tree) const
  774. {
  775. IPropertyTree * filterTree = createPTree(ipt_caseInsensitive);
  776. filterTree->setProp("@type", "local");
  777. tree->addPropTree("filter", filterTree);
  778. }
  779. void PassNoneLogMsgFilter::addToPTree(IPropertyTree * tree) const
  780. {
  781. IPropertyTree * filterTree = createPTree(ipt_caseInsensitive);
  782. filterTree->setProp("@type", "none");
  783. tree->addPropTree("filter", filterTree);
  784. }
  785. void CategoryLogMsgFilter::addToPTree(IPropertyTree * tree) const
  786. {
  787. IPropertyTree * filterTree = createPTree(ipt_caseInsensitive);
  788. filterTree->setProp("@type", "category");
  789. filterTree->setPropInt("@audience", audienceMask);
  790. filterTree->setPropInt("@class", classMask);
  791. filterTree->setPropInt("@detail", maxDetail);
  792. if(localFlag) filterTree->setPropInt("@local", 1);
  793. tree->addPropTree("filter", filterTree);
  794. }
  795. void PIDLogMsgFilter::addToPTree(IPropertyTree * tree) const
  796. {
  797. IPropertyTree * filterTree = createPTree(ipt_caseInsensitive);
  798. filterTree->setProp("@type", "pid");
  799. filterTree->setPropInt("@pid", pid);
  800. if(localFlag) filterTree->setPropInt("@local", 1);
  801. tree->addPropTree("filter", filterTree);
  802. }
  803. void TIDLogMsgFilter::addToPTree(IPropertyTree * tree) const
  804. {
  805. IPropertyTree * filterTree = createPTree(ipt_caseInsensitive);
  806. filterTree->setProp("@type", "tid");
  807. filterTree->setPropInt("@tid", tid);
  808. if(localFlag) filterTree->setPropInt("@local", 1);
  809. tree->addPropTree("filter", filterTree);
  810. }
  811. void NodeLogMsgFilter::addToPTree(IPropertyTree * tree) const
  812. {
  813. IPropertyTree * filterTree = createPTree(ipt_caseInsensitive);
  814. filterTree->setProp("@type", "node");
  815. StringBuffer buff;
  816. node.getIpText(buff);
  817. filterTree->setProp("@ip", buff.str());
  818. filterTree->setPropInt("@port", node.port);
  819. if(localFlag) filterTree->setPropInt("@local", 1);
  820. tree->addPropTree("filter", filterTree);
  821. }
  822. void IpLogMsgFilter::addToPTree(IPropertyTree * tree) const
  823. {
  824. IPropertyTree * filterTree = createPTree(ipt_caseInsensitive);
  825. filterTree->setProp("@type", "ip");
  826. StringBuffer buff;
  827. ip.getIpText(buff);
  828. filterTree->setProp("@ip", buff.str());
  829. if(localFlag) filterTree->setPropInt("@local", 1);
  830. tree->addPropTree("filter", filterTree);
  831. }
  832. void SessionLogMsgFilter::addToPTree(IPropertyTree * tree) const
  833. {
  834. IPropertyTree * filterTree = createPTree(ipt_caseInsensitive);
  835. filterTree->setProp("@type", "session");
  836. filterTree->setPropInt("@session", (int)session);
  837. if(localFlag) filterTree->setPropInt("@local", 1);
  838. tree->addPropTree("filter", filterTree);
  839. }
  840. void ComponentLogMsgFilter::addToPTree(IPropertyTree * tree) const
  841. {
  842. IPropertyTree * filterTree = createPTree(ipt_caseInsensitive);
  843. filterTree->setProp("@type", "component");
  844. filterTree->setPropInt("@component", component);
  845. if(localFlag) filterTree->setPropInt("@local", 1);
  846. tree->addPropTree("filter", filterTree);
  847. }
  848. bool RegexLogMsgFilter::includeMessage(const LogMsg & msg) const
  849. {
  850. if(localFlag && msg.queryRemoteFlag()) return false;
  851. SpinBlock b(lock);
  852. return const_cast<RegExpr &>(regex).find(msg.queryText()) != NULL;
  853. }
  854. void RegexLogMsgFilter::addToPTree(IPropertyTree * tree) const
  855. {
  856. IPropertyTree * filterTree = createPTree(ipt_caseInsensitive);
  857. filterTree->setProp("@type", "regex");
  858. filterTree->setProp("@regex", regexText);
  859. if(localFlag) filterTree->setPropInt("@local", 1);
  860. tree->addPropTree("filter", filterTree);
  861. }
  862. void NotLogMsgFilter::addToPTree(IPropertyTree * tree) const
  863. {
  864. IPropertyTree * filterTree = createPTree(ipt_caseInsensitive);
  865. filterTree->setProp("@type", "not");
  866. arg->addToPTree(filterTree);
  867. tree->addPropTree("filter", filterTree);
  868. }
  869. void AndLogMsgFilter::addToPTree(IPropertyTree * tree) const
  870. {
  871. IPropertyTree * filterTree = createPTree(ipt_caseInsensitive);
  872. filterTree->setProp("@type", "and");
  873. arg1->addToPTree(filterTree);
  874. arg2->addToPTree(filterTree);
  875. tree->addPropTree("filter", filterTree);
  876. }
  877. void OrLogMsgFilter::addToPTree(IPropertyTree * tree) const
  878. {
  879. IPropertyTree * filterTree = createPTree(ipt_caseInsensitive);
  880. filterTree->setProp("@type", "or");
  881. arg1->addToPTree(filterTree);
  882. arg2->addToPTree(filterTree);
  883. tree->addPropTree("filter", filterTree);
  884. }
  885. void SwitchLogMsgFilter::addToPTree(IPropertyTree * tree) const
  886. {
  887. IPropertyTree * filterTree = createPTree(ipt_caseInsensitive);
  888. filterTree->setProp("@type", "switch");
  889. cond->addToPTree(filterTree);
  890. yes->addToPTree(filterTree);
  891. no->addToPTree(filterTree);
  892. tree->addPropTree("filter", filterTree);
  893. }
  894. void CategoryLogMsgFilter::orWithFilter(const ILogMsgFilter * filter)
  895. {
  896. audienceMask |= filter->queryAudienceMask();
  897. classMask |= filter->queryClassMask();
  898. maxDetail = std::max(maxDetail, filter->queryMaxDetail());
  899. }
  900. void CategoryLogMsgFilter::reset()
  901. {
  902. audienceMask = 0;
  903. classMask = 0;
  904. maxDetail = 0;
  905. }
  906. // HandleLogMsgHandler
  907. void HandleLogMsgHandlerTable::addToPTree(IPropertyTree * tree) const
  908. {
  909. IPropertyTree * handlerTree = createPTree(ipt_caseInsensitive);
  910. if(handle==stderr)
  911. handlerTree->setProp("@type", "stderr");
  912. else
  913. handlerTree->setProp("@type", "mischandle");
  914. handlerTree->setPropInt("@fields", messageFields);
  915. tree->addPropTree("handler", handlerTree);
  916. }
  917. void HandleLogMsgHandlerXML::addToPTree(IPropertyTree * tree) const
  918. {
  919. IPropertyTree * handlerTree = createPTree(ipt_caseInsensitive);
  920. if(handle==stderr)
  921. handlerTree->setProp("@type", "stderr");
  922. else
  923. handlerTree->setProp("@type", "mischandle");
  924. handlerTree->setPropInt("@fields", messageFields);
  925. handlerTree->setProp("@writeXML", "true");
  926. tree->addPropTree("handler", handlerTree);
  927. }
  928. // FileLogMsgHandler
  929. FileLogMsgHandler::FileLogMsgHandler(const char * _filename, const char * _headerText, unsigned _fields, bool _append, bool _flushes)
  930. : messageFields(_fields), filename(_filename), headerText(_headerText), append(_append), flushes(_flushes)
  931. {
  932. recursiveCreateDirectoryForFile(filename);
  933. if(append)
  934. handle = fopen(filename, "a");
  935. else
  936. handle = fopen(filename, "w");
  937. if(!handle) {
  938. handle = getNullHandle();
  939. StringBuffer err;
  940. err.appendf("LOGGING: could not open file '%s' for output",filename.get());
  941. OERRLOG("%s",err.str()); // make sure doesn't get lost!
  942. throw MakeStringException(3000,"%s",err.str()); // 3000: internal error
  943. }
  944. if(headerText) fprintf(handle, "--- %s ---\n", (const char *)headerText);
  945. }
  946. static void closeAndDeleteEmpty(const char * filename, FILE *handle)
  947. {
  948. if (handle) {
  949. fpos_t pos;
  950. bool del = (fgetpos(handle, &pos)==0)&&
  951. #if defined( _WIN32) || defined(__FreeBSD__) || defined(__APPLE__)
  952. (pos==0);
  953. #else
  954. (pos.__pos==0);
  955. #endif
  956. fclose(handle);
  957. if (del)
  958. remove(filename);
  959. }
  960. }
  961. FileLogMsgHandler::~FileLogMsgHandler()
  962. {
  963. closeAndDeleteEmpty(filename,handle);
  964. }
  965. char const * FileLogMsgHandler::disable()
  966. {
  967. crit.enter();
  968. fclose(handle);
  969. handle = NULL;
  970. return filename;
  971. }
  972. void FileLogMsgHandler::enable()
  973. {
  974. recursiveCreateDirectoryForFile(filename);
  975. handle = fopen(filename, "a");
  976. if(!handle) {
  977. handle = getNullHandle();
  978. assertex(!"FileLogMsgHandler::enable : could not open file for output");
  979. }
  980. crit.leave();
  981. }
  982. void FileLogMsgHandlerTable::addToPTree(IPropertyTree * tree) const
  983. {
  984. IPropertyTree * handlerTree = createPTree(ipt_caseInsensitive);
  985. handlerTree->setProp("@type", "file");
  986. handlerTree->setProp("@filename", filename.get());
  987. if(headerText) handlerTree->setProp("@headertext", headerText.get());
  988. handlerTree->setPropInt("@fields", messageFields);
  989. handlerTree->setProp("@writeTable", "true");
  990. if(append) handlerTree->setProp("@append", "true");
  991. if(flushes) handlerTree->setProp("@flushes", "true");
  992. tree->addPropTree("handler", handlerTree);
  993. }
  994. void FileLogMsgHandlerXML::addToPTree(IPropertyTree * tree) const
  995. {
  996. IPropertyTree * handlerTree = createPTree(ipt_caseInsensitive);
  997. handlerTree->setProp("@type", "file");
  998. handlerTree->setProp("@filename", filename.get());
  999. if(headerText) handlerTree->setProp("@headertext", headerText.get());
  1000. handlerTree->setPropInt("@fields", messageFields);
  1001. if(append) handlerTree->setProp("@append", "true");
  1002. if(flushes) handlerTree->setProp("@flushes", "true");
  1003. tree->addPropTree("handler", handlerTree);
  1004. }
  1005. // RollingFileLogMsgHandler
  1006. #define MIN_LOGFILE_SIZE_LIMIT 10000
  1007. #define LOG_LINE_SIZE_ESTIMATE 80
  1008. RollingFileLogMsgHandler::RollingFileLogMsgHandler(const char * _filebase, const char * _fileextn, unsigned _fields, bool _append, bool _flushes, const char *initialName, const char *_alias, bool daily, long _maxLogFileSize)
  1009. : handle(0), messageFields(_fields), alias(_alias), filebase(_filebase), fileextn(_fileextn), append(_append), flushes(_flushes), maxLogFileSize(_maxLogFileSize)
  1010. {
  1011. if (_maxLogFileSize)
  1012. {
  1013. if (_maxLogFileSize < MIN_LOGFILE_SIZE_LIMIT) // Setting the cap too low, doesn't work well
  1014. maxLogFileSize = MIN_LOGFILE_SIZE_LIMIT;
  1015. maxLogFileSize = _maxLogFileSize - (LOG_LINE_SIZE_ESTIMATE*2); // Trying to keep log file size below capped
  1016. };
  1017. time_t tNow;
  1018. time(&tNow);
  1019. localtime_r(&tNow, &startTime);
  1020. doRollover(daily, initialName);
  1021. checkRollover();
  1022. }
  1023. RollingFileLogMsgHandler::~RollingFileLogMsgHandler()
  1024. {
  1025. closeAndDeleteEmpty(filename,handle);
  1026. }
  1027. char const * RollingFileLogMsgHandler::disable()
  1028. {
  1029. crit.enter();
  1030. fclose(handle);
  1031. return filename;
  1032. }
  1033. void RollingFileLogMsgHandler::enable()
  1034. {
  1035. recursiveCreateDirectoryForFile(filename);
  1036. handle = fopen(filename, "a");
  1037. if(!handle) {
  1038. handle = getNullHandle();
  1039. assertex(!"RollingFileLogMsgHandler::enable : could not open file for output");
  1040. }
  1041. crit.leave();
  1042. }
  1043. void RollingFileLogMsgHandler::addToPTree(IPropertyTree * tree) const
  1044. {
  1045. IPropertyTree * handlerTree = createPTree(ipt_caseInsensitive);
  1046. handlerTree->setProp("@type", "rollingfile");
  1047. handlerTree->setProp("@filebase", filebase.get());
  1048. handlerTree->setProp("@fileextn", fileextn.get());
  1049. handlerTree->setPropInt("@fields", messageFields);
  1050. if(append) handlerTree->setProp("@append", "true");
  1051. if(flushes) handlerTree->setProp("@flushes", "true");
  1052. tree->addPropTree("handler", handlerTree);
  1053. }
  1054. void RollingFileLogMsgHandler::checkRollover()
  1055. {
  1056. time_t tNow;
  1057. time(&tNow);
  1058. struct tm ltNow;
  1059. localtime_r(&tNow, &ltNow);
  1060. if(ltNow.tm_year != startTime.tm_year || ltNow.tm_yday != startTime.tm_yday)
  1061. {
  1062. localtime_r(&tNow, &startTime); // reset the start time for next rollover check
  1063. doRollover(true);
  1064. }
  1065. else if (maxLogFileSize)
  1066. {
  1067. linesSinceSizeChecked++;
  1068. if (linesSinceSizeChecked > sizeCheckNext)
  1069. {
  1070. long fsize = ftell(handle);
  1071. if ((fsize==-1 && errno==EOVERFLOW) || (fsize >= maxLogFileSize))
  1072. {
  1073. localtime_r(&tNow, &startTime);
  1074. doRollover(false);
  1075. }
  1076. else
  1077. // Calc how many lines to skip before next log file size check
  1078. // - using (LOG_LINE_SIZE_ESTIMATE*2) to ensure the size check is done well before limit
  1079. sizeCheckNext = (maxLogFileSize - fsize) / (LOG_LINE_SIZE_ESTIMATE*2);
  1080. linesSinceSizeChecked = 0;
  1081. }
  1082. }
  1083. }
  1084. void RollingFileLogMsgHandler::doRollover(bool daily, const char *forceName)
  1085. {
  1086. CriticalBlock block(crit);
  1087. closeAndDeleteEmpty(filename,handle);
  1088. handle = 0;
  1089. filename.clear();
  1090. if (forceName)
  1091. filename.append(forceName);
  1092. else
  1093. {
  1094. filename.clear().append(filebase.get());
  1095. addFileTimestamp(filename, daily);
  1096. filename.append(fileextn.get());
  1097. }
  1098. recursiveCreateDirectoryForFile(filename.str());
  1099. handle = fopen(filename.str(), append ? "a+" : "w");
  1100. printHeader = true;
  1101. currentLogFields = 0;
  1102. if (handle)
  1103. {
  1104. if (append)
  1105. {
  1106. fseek(handle, 0, SEEK_END);
  1107. long pos = ftell(handle);
  1108. if (pos > 0 || (pos==-1 && errno==EOVERFLOW)) // If current file is not empty
  1109. {
  1110. printHeader = false;
  1111. unsigned logfields = getMessageFieldsFromHeader(handle);
  1112. if (logfields == 0) // No header file so write log lines legacy field format
  1113. currentLogFields = MSGFIELD_LEGACY;
  1114. else if (logfields != messageFields) // Different log format from format in current log file
  1115. currentLogFields = logfields;
  1116. }
  1117. }
  1118. if (alias && alias.length())
  1119. {
  1120. fclose(handle);
  1121. handle = 0;
  1122. remove(alias);
  1123. try
  1124. {
  1125. createHardLink(alias, filename.str());
  1126. }
  1127. catch (IException *E)
  1128. {
  1129. recursiveCreateDirectoryForFile(filename.str());
  1130. handle = fopen(filename.str(), append ? "a" : "w");
  1131. EXCLOG(E); // Log the fact that we could not create the alias - probably it is locked (tail a bit unfortunate on windows).
  1132. E->Release();
  1133. }
  1134. if (!handle)
  1135. {
  1136. recursiveCreateDirectoryForFile(filename.str());
  1137. handle = fopen(filename.str(), append ? "a" : "w");
  1138. }
  1139. }
  1140. }
  1141. if(!handle)
  1142. {
  1143. handle = getNullHandle();
  1144. OWARNLOG("RollingFileLogMsgHandler::doRollover : could not open log file %s for output", filename.str());
  1145. // actually this is pretty fatal
  1146. }
  1147. }
  1148. // BinLogMsgHandler
  1149. BinLogMsgHandler::BinLogMsgHandler(const char * _filename, bool _append) : filename(_filename), append(_append)
  1150. {
  1151. file.setown(createIFile(filename.get()));
  1152. if(!file) assertex(!"BinLogMsgHandler::BinLogMsgHandler : Could not create IFile");
  1153. if(append)
  1154. fio.setown(file->open(IFOwrite));
  1155. else
  1156. fio.setown(file->open(IFOcreate));
  1157. if(!fio) assertex(!"BinLogMsgHandler::BinLogMsgHandler : Could not create IFileIO");
  1158. fstr.setown(createIOStream(fio));
  1159. if(!fstr) assertex(!"BinLogMsgHandler::BinLogMsgHandler : Could not create IFileIOStream");
  1160. if(append)
  1161. fstr->seek(0, IFSend);
  1162. }
  1163. BinLogMsgHandler::~BinLogMsgHandler()
  1164. {
  1165. fstr.clear();
  1166. fio.clear();
  1167. file.clear();
  1168. }
  1169. void BinLogMsgHandler::handleMessage(const LogMsg & msg)
  1170. {
  1171. CriticalBlock block(crit);
  1172. mbuff.clear();
  1173. msg.serialize(mbuff);
  1174. size32_t msglen = mbuff.length();
  1175. fstr->write(sizeof(msglen), &msglen);
  1176. fstr->write(msglen, mbuff.toByteArray());
  1177. }
  1178. void BinLogMsgHandler::addToPTree(IPropertyTree * tree) const
  1179. {
  1180. IPropertyTree * handlerTree = createPTree(ipt_caseInsensitive);
  1181. handlerTree->setProp("@type", "binary");
  1182. handlerTree->setProp("@filename", filename.get());
  1183. if(append) handlerTree->setProp("@append", "true");
  1184. tree->addPropTree("handler", handlerTree);
  1185. }
  1186. char const * BinLogMsgHandler::disable()
  1187. {
  1188. crit.enter();
  1189. fstr.clear();
  1190. fio.clear();
  1191. return filename.get();
  1192. }
  1193. void BinLogMsgHandler::enable()
  1194. {
  1195. fio.setown(file->open(IFOwrite));
  1196. if(!fio) assertex(!"BinLogMsgHandler::enable : Could not create IFileIO");
  1197. fstr.setown(createIOStream(fio));
  1198. if(!fstr) assertex(!"BinLogMsgHandler::enable : Could not create IFileIOStream");
  1199. fstr->seek(0, IFSend);
  1200. crit.leave();
  1201. }
  1202. // LogMsgComponentReporter
  1203. void LogMsgComponentReporter::report(const LogMsgCategory & cat, const char * format, ...)
  1204. {
  1205. va_list args;
  1206. va_start(args, format);
  1207. queryLogMsgManager()->report_va(component, cat, unknownJob, format, args);
  1208. va_end(args);
  1209. }
  1210. void LogMsgComponentReporter::report_va(const LogMsgCategory & cat, const char * format, va_list args)
  1211. {
  1212. queryLogMsgManager()->report_va(component, cat, unknownJob, format, args);
  1213. }
  1214. void LogMsgComponentReporter::report(const LogMsgCategory & cat, LogMsgCode code, const char * format, ...)
  1215. {
  1216. va_list args;
  1217. va_start(args, format);
  1218. queryLogMsgManager()->report_va(component, cat, unknownJob, code, format, args);
  1219. va_end(args);
  1220. }
  1221. void LogMsgComponentReporter::report_va(const LogMsgCategory & cat, LogMsgCode code, const char * format, va_list args)
  1222. {
  1223. queryLogMsgManager()->report_va(component, cat, unknownJob, code, format, args);
  1224. }
  1225. void LogMsgComponentReporter::report(const LogMsgCategory & cat, const IException * exception, const char * prefix)
  1226. {
  1227. StringBuffer buff;
  1228. if(prefix) buff.append(prefix).append(" : ");
  1229. exception->errorMessage(buff);
  1230. queryLogMsgManager()->report(component, cat, unknownJob, exception->errorCode(), "%s", buff.str());
  1231. }
  1232. void LogMsgComponentReporter::report(const LogMsgCategory & cat, const LogMsgJobInfo & job, const char * format, ...)
  1233. {
  1234. va_list args;
  1235. va_start(args, format);
  1236. queryLogMsgManager()->report_va(component, cat, job, format, args);
  1237. va_end(args);
  1238. }
  1239. void LogMsgComponentReporter::report_va(const LogMsgCategory & cat, const LogMsgJobInfo & job, const char * format, va_list args)
  1240. {
  1241. queryLogMsgManager()->report_va(component, cat, job, format, args);
  1242. }
  1243. void LogMsgComponentReporter::report(const LogMsgCategory & cat, const LogMsgJobInfo & job, LogMsgCode code, const char * format, ...)
  1244. {
  1245. va_list args;
  1246. va_start(args, format);
  1247. queryLogMsgManager()->report_va(component, cat, job, code, format, args);
  1248. va_end(args);
  1249. }
  1250. void LogMsgComponentReporter::report_va(const LogMsgCategory & cat, const LogMsgJobInfo & job, LogMsgCode code, const char * format, va_list args)
  1251. {
  1252. queryLogMsgManager()->report_va(component, cat, job, code, format, args);
  1253. }
  1254. void LogMsgComponentReporter::report(const LogMsgCategory & cat, const LogMsgJobInfo & job, const IException * exception, const char * prefix)
  1255. {
  1256. StringBuffer buff;
  1257. if(prefix) buff.append(prefix).append(" : ");
  1258. exception->errorMessage(buff);
  1259. queryLogMsgManager()->report(component, cat, job, exception->errorCode(), "%s", buff.str());
  1260. }
  1261. void LogMsgComponentReporter::report(const LogMsg & msg)
  1262. {
  1263. queryLogMsgManager()->report(msg);
  1264. }
  1265. void LogMsgComponentReporter::mreport_direct(const LogMsgCategory & cat, const LogMsgJobInfo & job, const char * msg)
  1266. {
  1267. queryLogMsgManager()->mreport_direct(component, cat, job, msg);
  1268. }
  1269. void LogMsgComponentReporter::mreport_va(const LogMsgCategory & cat, const LogMsgJobInfo & job, const char * format, va_list args)
  1270. {
  1271. queryLogMsgManager()->mreport_va(component, cat, job, format, args);
  1272. }
  1273. // LogMsgPrepender
  1274. void LogMsgPrepender::report(const LogMsgCategory & cat, const char * format, ...)
  1275. {
  1276. StringBuffer buff;
  1277. buff.append(file).append("(").append(line).append(") : ").append(format);
  1278. va_list args;
  1279. va_start(args, format);
  1280. if(reporter)
  1281. reporter->report_va(cat, unknownJob, buff.str(), args);
  1282. else
  1283. queryLogMsgManager()->report_va(cat, unknownJob, buff.str(), args);
  1284. va_end(args);
  1285. }
  1286. void LogMsgPrepender::report_va(const LogMsgCategory & cat, const char * format, va_list args)
  1287. {
  1288. StringBuffer buff;
  1289. buff.append(file).append("(").append(line).append(") : ").append(format);
  1290. if(reporter)
  1291. reporter->report_va(cat, unknownJob, buff.str(), args);
  1292. else
  1293. queryLogMsgManager()->report_va(cat, unknownJob, buff.str(), args);
  1294. }
  1295. void LogMsgPrepender::report(const LogMsgCategory & cat, LogMsgCode code, const char * format, ...)
  1296. {
  1297. StringBuffer buff;
  1298. buff.append(file).append("(").append(line).append(") : ").append(format);
  1299. va_list args;
  1300. va_start(args, format);
  1301. if(reporter)
  1302. reporter->report_va(cat, unknownJob, buff.str(), args);
  1303. else
  1304. queryLogMsgManager()->report_va(cat, unknownJob, buff.str(), args);
  1305. va_end(args);
  1306. }
  1307. void LogMsgPrepender::report_va(const LogMsgCategory & cat, LogMsgCode code, const char * format, va_list args)
  1308. {
  1309. StringBuffer buff;
  1310. buff.append(file).append("(").append(line).append(") : ").append(format);
  1311. if(reporter)
  1312. reporter->report_va(cat, unknownJob, buff.str(), args);
  1313. else
  1314. queryLogMsgManager()->report_va(cat, unknownJob, buff.str(), args);
  1315. }
  1316. void LogMsgPrepender::report(const LogMsgCategory & cat, const IException * exception, const char * prefix)
  1317. {
  1318. StringBuffer buff;
  1319. buff.append(file).append("(").append(line).append(") : ");
  1320. if(prefix) buff.append(prefix).append(" : ");
  1321. exception->errorMessage(buff);
  1322. if(reporter)
  1323. reporter->report(cat, unknownJob, exception->errorCode(), "%s", buff.str());
  1324. else
  1325. queryLogMsgManager()->report(cat, unknownJob, exception->errorCode(), "%s", buff.str());
  1326. }
  1327. void LogMsgPrepender::report(const LogMsgCategory & cat, const LogMsgJobInfo & job, const char * format, ...)
  1328. {
  1329. StringBuffer buff;
  1330. buff.append(file).append("(").append(line).append(") : ").append(format);
  1331. va_list args;
  1332. va_start(args, format);
  1333. if(reporter)
  1334. reporter->report_va(cat, job, buff.str(), args);
  1335. else
  1336. queryLogMsgManager()->report_va(cat, job, buff.str(), args);
  1337. va_end(args);
  1338. }
  1339. void LogMsgPrepender::report_va(const LogMsgCategory & cat, const LogMsgJobInfo & job, const char * format, va_list args)
  1340. {
  1341. StringBuffer buff;
  1342. buff.append(file).append("(").append(line).append(") : ").append(format);
  1343. if(reporter)
  1344. reporter->report_va(cat, job, buff.str(), args);
  1345. else
  1346. queryLogMsgManager()->report_va(cat, job, buff.str(), args);
  1347. }
  1348. void LogMsgPrepender::report(const LogMsgCategory & cat, const LogMsgJobInfo & job, LogMsgCode code, const char * format, ...)
  1349. {
  1350. StringBuffer buff;
  1351. buff.append(file).append("(").append(line).append(") : ").append(format);
  1352. va_list args;
  1353. va_start(args, format);
  1354. if(reporter)
  1355. reporter->report_va(cat, job, buff.str(), args);
  1356. else
  1357. queryLogMsgManager()->report_va(cat, job, buff.str(), args);
  1358. va_end(args);
  1359. }
  1360. void LogMsgPrepender::report_va(const LogMsgCategory & cat, const LogMsgJobInfo & job, LogMsgCode code, const char * format, va_list args)
  1361. {
  1362. StringBuffer buff;
  1363. buff.append(file).append("(").append(line).append(") : ").append(format);
  1364. if(reporter)
  1365. reporter->report_va(cat, job, buff.str(), args);
  1366. else
  1367. queryLogMsgManager()->report_va(cat, job, buff.str(), args);
  1368. }
  1369. void LogMsgPrepender::report(const LogMsgCategory & cat, const LogMsgJobInfo & job, const IException * exception, const char * prefix)
  1370. {
  1371. StringBuffer txt;
  1372. if (prefix)
  1373. txt.append(prefix).append(" : ");
  1374. exception->errorMessage(txt);
  1375. if (reporter)
  1376. reporter->report(cat, job, exception->errorCode(), "%s(%d) : %s", file, line, txt.str());
  1377. else
  1378. queryLogMsgManager()->report(cat, job, exception->errorCode(), "%s(%d) : %s", file, line, txt.str());
  1379. }
  1380. IException * LogMsgPrepender::report(IException * e, const char * prefix, LogMsgClass cls)
  1381. {
  1382. report(MCexception(e, cls), unknownJob, e, prefix);
  1383. return e;
  1384. }
  1385. // LogMsgMonitor
  1386. void LogMsgMonitor::addToPTree(IPropertyTree * tree) const
  1387. {
  1388. IPropertyTree * monitorTree = createPTree(ipt_caseInsensitive);
  1389. handler->addToPTree(monitorTree);
  1390. filter->addToPTree(monitorTree);
  1391. tree->addPropTree("monitor", monitorTree);
  1392. }
  1393. // CLogMsgManager
  1394. void CLogMsgManager::MsgProcessor::push(LogMsg * msg)
  1395. {
  1396. //assertex(more); an assertex will just recurse here
  1397. if (!more) // we are effective stopped so don't bother even dropping (and leak parameter) as drop will involve
  1398. // interaction with the base class which is stopped and could easily crash (as this condition
  1399. // is expected not to occur - typically occurs if the user has incorrectly called exit on one thread
  1400. // while still in the process of logging on another)
  1401. // cf Bug #53695 for more discussion of the issue
  1402. return;
  1403. else if(droppingLimit && (q.ordinality() >= droppingLimit))
  1404. drop();
  1405. q.enqueue(msg);
  1406. }
  1407. int CLogMsgManager::MsgProcessor::run()
  1408. {
  1409. Owned<LogMsg> msg;
  1410. while(more)
  1411. {
  1412. msg.setown(q.dequeueAndNotify(this)); // notify locks mutex on non-null return
  1413. if(!msg)
  1414. break;
  1415. owner->doReport(*msg);
  1416. pullCycleMutex.unlock();
  1417. }
  1418. while(true)
  1419. {
  1420. msg.setown(q.dequeueNowAndNotify(this)); // notify locks mutex on non-null return
  1421. if(!msg)
  1422. break;
  1423. owner->doReport(*msg);
  1424. pullCycleMutex.unlock();
  1425. }
  1426. return 0;
  1427. }
  1428. void CLogMsgManager::MsgProcessor::notify(LogMsg *)
  1429. {
  1430. pullCycleMutex.lock();
  1431. }
  1432. void CLogMsgManager::MsgProcessor::setBlockingLimit(unsigned lim)
  1433. {
  1434. q.setLimit(lim);
  1435. droppingLimit = 0;
  1436. }
  1437. void CLogMsgManager::MsgProcessor::setDroppingLimit(unsigned lim, unsigned num)
  1438. {
  1439. numToDrop = num;
  1440. droppingLimit = lim;
  1441. q.setLimit(0);
  1442. }
  1443. void CLogMsgManager::MsgProcessor::resetLimit()
  1444. {
  1445. droppingLimit = 0;
  1446. q.setLimit(0);
  1447. }
  1448. void CLogMsgManager::MsgProcessor::stop()
  1449. {
  1450. more = false;
  1451. q.stop();
  1452. }
  1453. void CLogMsgManager::MsgProcessor::drop()
  1454. {
  1455. Owned<LogMsg> msg, lastMsg;
  1456. unsigned count;
  1457. unsigned prev = 0;
  1458. for(count = 0; count < numToDrop; count++)
  1459. {
  1460. msg.setown(q.dequeueTail(0));
  1461. if(!msg) break;
  1462. DropLogMsg * dmsg = dynamic_cast<DropLogMsg *>(msg.get());
  1463. if(dmsg) prev += dmsg->queryCount()-1;
  1464. lastMsg.setown(msg.getClear());
  1465. }
  1466. if(lastMsg)
  1467. q.enqueue(new DropLogMsg(owner, lastMsg->querySysInfo().queryMsgID(), count+prev));
  1468. }
  1469. bool CLogMsgManager::MsgProcessor::flush(unsigned timeout)
  1470. {
  1471. unsigned start = msTick();
  1472. if(!q.waitMaxOrdinality(0, timeout))
  1473. return false;
  1474. unsigned now = msTick();
  1475. if(now >= (start+timeout))
  1476. return false;
  1477. try
  1478. {
  1479. synchronized block(pullCycleMutex, timeout+start-now);
  1480. }
  1481. catch(IException * e)
  1482. {
  1483. e->Release();
  1484. return false;
  1485. }
  1486. return true;
  1487. }
  1488. CLogMsgManager::~CLogMsgManager()
  1489. {
  1490. CriticalBlock crit(modeLock);
  1491. if(processor)
  1492. {
  1493. processor->stop();
  1494. processor->join();
  1495. }
  1496. }
  1497. LogMsgJobId CLogMsgManager::addJobId(const char *job)
  1498. {
  1499. LogMsgJobId ret = ++nextJobId;
  1500. pushMsg(new LogMsg(ret, job));
  1501. return ret;
  1502. }
  1503. void CLogMsgManager::removeJobId(LogMsgJobId id)
  1504. {
  1505. pushMsg(new LogMsg(id, nullptr));
  1506. }
  1507. const char * CLogMsgManager::queryJobId(LogMsgJobId id) const
  1508. {
  1509. // NOTE - thread safety is important here. We have to consider two things:
  1510. // 1. Whether an id (and therefore an entry in this table) can be invalidated between the return statement and someone using the result
  1511. // It is up to the calling application to ensure that it does not call removeJobId() on an ID that may still be being used for logging by another thread.
  1512. // 2. Whether the table lookup may coincide with a table add, and crash in getValue/setValue
  1513. // This is a non-issue in queueing mode as all gets/sets happen on a single thread, but we lock to be on the safe side
  1514. CriticalBlock b(jobIdLock);
  1515. StringAttr *found = jobIds.getValue(id);
  1516. return found ? found->get() : "invalid";
  1517. }
  1518. void CLogMsgManager::doAddJobId(LogMsgJobId id, const char *text) const
  1519. {
  1520. CriticalBlock b(jobIdLock);
  1521. jobIds.setValue(id, text);
  1522. }
  1523. void CLogMsgManager::doRemoveJobId(LogMsgJobId id) const
  1524. {
  1525. CriticalBlock b(jobIdLock);
  1526. jobIds.remove(id);
  1527. }
  1528. void CLogMsgManager::enterQueueingMode()
  1529. {
  1530. CriticalBlock crit(modeLock);
  1531. if(processor) return;
  1532. processor.setown(new MsgProcessor(this));
  1533. processor->setBlockingLimit(defaultMsgQueueLimit);
  1534. processor->start();
  1535. }
  1536. void CLogMsgManager::setQueueBlockingLimit(unsigned lim)
  1537. {
  1538. CriticalBlock crit(modeLock);
  1539. if(processor)
  1540. processor->setBlockingLimit(lim);
  1541. }
  1542. void CLogMsgManager::setQueueDroppingLimit(unsigned lim, unsigned numToDrop)
  1543. {
  1544. CriticalBlock crit(modeLock);
  1545. if(processor)
  1546. processor->setDroppingLimit(lim, numToDrop);
  1547. }
  1548. void CLogMsgManager::resetQueueLimit()
  1549. {
  1550. CriticalBlock crit(modeLock);
  1551. if(processor)
  1552. processor->resetLimit();
  1553. }
  1554. void CLogMsgManager::report(const LogMsgCategory & cat, const char * format, ...)
  1555. {
  1556. if(rejectsCategory(cat)) return;
  1557. va_list args;
  1558. va_start(args, format);
  1559. pushMsg(new LogMsg(cat, getNextID(), unknownJob, NoLogMsgCode, format, args, 0, port, session));
  1560. va_end(args);
  1561. }
  1562. void CLogMsgManager::report_va(const LogMsgCategory & cat, const char * format, va_list args)
  1563. {
  1564. if(rejectsCategory(cat)) return;
  1565. pushMsg(new LogMsg(cat, getNextID(), unknownJob, NoLogMsgCode, format, args, 0, port, session));
  1566. }
  1567. void CLogMsgManager::report(const LogMsgCategory & cat, LogMsgCode code, const char * format, ...)
  1568. {
  1569. if(rejectsCategory(cat)) return;
  1570. va_list args;
  1571. va_start(args, format);
  1572. pushMsg(new LogMsg(cat, getNextID(), unknownJob, code, format, args, 0, port, session));
  1573. va_end(args);
  1574. }
  1575. void CLogMsgManager::report_va(const LogMsgCategory & cat, LogMsgCode code, const char * format, va_list args)
  1576. {
  1577. if(rejectsCategory(cat)) return;
  1578. pushMsg(new LogMsg(cat, getNextID(), unknownJob, code, format, args, 0, port, session));
  1579. }
  1580. void CLogMsgManager::mreport_direct(unsigned compo, const LogMsgCategory & cat, const LogMsgJobInfo & job, const char * msg)
  1581. {
  1582. if(rejectsCategory(cat)) return;
  1583. const char *cursor = msg;
  1584. const char *lineStart = cursor;
  1585. while (true)
  1586. {
  1587. switch (*cursor)
  1588. {
  1589. case '\0':
  1590. pushMsg(new LogMsg(cat, getNextID(), job, NoLogMsgCode, (int)(cursor-lineStart), lineStart, compo, port, session));
  1591. return;
  1592. case '\r':
  1593. // NB: \r or \r\n translated into newline
  1594. pushMsg(new LogMsg(cat, getNextID(), job, NoLogMsgCode, (int)(cursor-lineStart), lineStart, compo, port, session));
  1595. if ('\n' == *(cursor+1))
  1596. cursor++;
  1597. lineStart = cursor+1;
  1598. break;
  1599. case '\n':
  1600. pushMsg(new LogMsg(cat, getNextID(), job, NoLogMsgCode, (int)(cursor-lineStart), lineStart, compo, port, session));
  1601. lineStart = cursor+1;
  1602. break;
  1603. }
  1604. ++cursor;
  1605. }
  1606. }
  1607. void CLogMsgManager::mreport_direct(const LogMsgCategory & cat, const LogMsgJobInfo & job, const char * msg)
  1608. {
  1609. mreport_direct(0, cat, job, msg);
  1610. }
  1611. void CLogMsgManager::mreport_va(unsigned compo, const LogMsgCategory & cat, const LogMsgJobInfo & job, const char * format, va_list args)
  1612. {
  1613. if(rejectsCategory(cat)) return;
  1614. StringBuffer log;
  1615. log.limited_valist_appendf(1024*1024, format, args);
  1616. mreport_direct(compo, cat, job, log);
  1617. }
  1618. void CLogMsgManager::mreport_va(const LogMsgCategory & cat, const LogMsgJobInfo & job, const char * format, va_list args)
  1619. {
  1620. if(rejectsCategory(cat)) return;
  1621. StringBuffer log;
  1622. log.limited_valist_appendf(1024*1024, format, args);
  1623. mreport_direct(cat, job, log);
  1624. }
  1625. void CLogMsgManager::report(const LogMsgCategory & cat, const IException * exception, const char * prefix)
  1626. {
  1627. if(rejectsCategory(cat)) return;
  1628. StringBuffer buff;
  1629. if(prefix) buff.append(prefix).append(" : ");
  1630. exception->errorMessage(buff);
  1631. pushMsg(new LogMsg(cat, getNextID(), unknownJob, exception->errorCode(), buff.str(), 0, port, session));
  1632. }
  1633. void CLogMsgManager::report(unsigned compo, const LogMsgCategory & cat, const char * format, ...)
  1634. {
  1635. if(rejectsCategory(cat)) return;
  1636. va_list args;
  1637. va_start(args, format);
  1638. pushMsg(new LogMsg(cat, getNextID(), unknownJob, NoLogMsgCode, format, args, compo, port, session));
  1639. va_end(args);
  1640. }
  1641. void CLogMsgManager::report_va(unsigned compo, const LogMsgCategory & cat, const char * format, va_list args)
  1642. {
  1643. if(rejectsCategory(cat)) return;
  1644. pushMsg(new LogMsg(cat, getNextID(), unknownJob, NoLogMsgCode, format, args, compo, port, session));
  1645. }
  1646. void CLogMsgManager::report(unsigned compo, const LogMsgCategory & cat, LogMsgCode code, const char * format, ...)
  1647. {
  1648. if(rejectsCategory(cat)) return;
  1649. va_list args;
  1650. va_start(args, format);
  1651. pushMsg(new LogMsg(cat, getNextID(), unknownJob, code, format, args, compo, port, session));
  1652. va_end(args);
  1653. }
  1654. void CLogMsgManager::report_va(unsigned compo, const LogMsgCategory & cat, LogMsgCode code, const char * format, va_list args)
  1655. {
  1656. if(rejectsCategory(cat)) return;
  1657. pushMsg(new LogMsg(cat, getNextID(), unknownJob, code, format, args, compo, port, session));
  1658. }
  1659. void CLogMsgManager::report(unsigned compo, const LogMsgCategory & cat, const IException * exception, const char * prefix)
  1660. {
  1661. if(rejectsCategory(cat)) return;
  1662. StringBuffer buff;
  1663. if(prefix) buff.append(prefix).append(" : ");
  1664. exception->errorMessage(buff);
  1665. pushMsg(new LogMsg(cat, getNextID(), unknownJob, exception->errorCode(), buff.str(), compo, port, session));
  1666. }
  1667. void CLogMsgManager::report(const LogMsgCategory & cat, const LogMsgJobInfo & job, const char * format, ...)
  1668. {
  1669. if(rejectsCategory(cat)) return;
  1670. va_list args;
  1671. va_start(args, format);
  1672. pushMsg(new LogMsg(cat, getNextID(), job, NoLogMsgCode, format, args, 0, port, session));
  1673. va_end(args);
  1674. }
  1675. void CLogMsgManager::report_va(const LogMsgCategory & cat, const LogMsgJobInfo & job, const char * format, va_list args)
  1676. {
  1677. if(rejectsCategory(cat)) return;
  1678. pushMsg(new LogMsg(cat, getNextID(), job, NoLogMsgCode, format, args, 0, port, session));
  1679. }
  1680. void CLogMsgManager::report(const LogMsgCategory & cat, const LogMsgJobInfo & job, LogMsgCode code, const char * format, ...)
  1681. {
  1682. if(rejectsCategory(cat)) return;
  1683. va_list args;
  1684. va_start(args, format);
  1685. pushMsg(new LogMsg(cat, getNextID(), job, code, format, args, 0, port, session));
  1686. va_end(args);
  1687. }
  1688. void CLogMsgManager::report_va(const LogMsgCategory & cat, const LogMsgJobInfo & job, LogMsgCode code, const char * format, va_list args)
  1689. {
  1690. if(rejectsCategory(cat)) return;
  1691. pushMsg(new LogMsg(cat, getNextID(), job, code, format, args, 0, port, session));
  1692. }
  1693. void CLogMsgManager::report(const LogMsgCategory & cat, const LogMsgJobInfo & job, const IException * exception, const char * prefix)
  1694. {
  1695. if(rejectsCategory(cat)) return;
  1696. StringBuffer buff;
  1697. if(prefix) buff.append(prefix).append(" : ");
  1698. exception->errorMessage(buff);
  1699. pushMsg(new LogMsg(cat, getNextID(), job, exception->errorCode(), buff.str(), 0, port, session));
  1700. }
  1701. void CLogMsgManager::report(unsigned compo, const LogMsgCategory & cat, const LogMsgJobInfo & job, const char * format, ...)
  1702. {
  1703. if(rejectsCategory(cat)) return;
  1704. va_list args;
  1705. va_start(args, format);
  1706. pushMsg(new LogMsg(cat, getNextID(), job, NoLogMsgCode, format, args, compo, port, session));
  1707. va_end(args);
  1708. }
  1709. void CLogMsgManager::report_va(unsigned compo, const LogMsgCategory & cat, const LogMsgJobInfo & job, const char * format, va_list args)
  1710. {
  1711. if(rejectsCategory(cat)) return;
  1712. pushMsg(new LogMsg(cat, getNextID(), job, NoLogMsgCode, format, args, compo, port, session));
  1713. }
  1714. void CLogMsgManager::report(unsigned compo, const LogMsgCategory & cat, const LogMsgJobInfo & job, LogMsgCode code, const char * format, ...)
  1715. {
  1716. if(rejectsCategory(cat)) return;
  1717. va_list args;
  1718. va_start(args, format);
  1719. pushMsg(new LogMsg(cat, getNextID(), job, code, format, args, compo, port, session));
  1720. va_end(args);
  1721. }
  1722. void CLogMsgManager::report_va(unsigned compo, const LogMsgCategory & cat, const LogMsgJobInfo & job, LogMsgCode code, const char * format, va_list args)
  1723. {
  1724. if(rejectsCategory(cat)) return;
  1725. pushMsg(new LogMsg(cat, getNextID(), job, code, format, args, compo, port, session));
  1726. }
  1727. void CLogMsgManager::report(unsigned compo, const LogMsgCategory & cat, const LogMsgJobInfo & job, const IException * exception, const char * prefix)
  1728. {
  1729. if(rejectsCategory(cat)) return;
  1730. StringBuffer buff;
  1731. if(prefix) buff.append(prefix).append(" : ");
  1732. exception->errorMessage(buff);
  1733. pushMsg(new LogMsg(cat, getNextID(), job, exception->errorCode(), buff.str(), compo, port, session));
  1734. }
  1735. void CLogMsgManager::pushMsg(LogMsg * _msg)
  1736. {
  1737. Owned<LogMsg> msg(_msg);
  1738. if(processor)
  1739. processor->push(msg.getLink());
  1740. else
  1741. doReport(*msg);
  1742. }
  1743. void CLogMsgManager::doReport(const LogMsg & msg) const
  1744. {
  1745. try
  1746. {
  1747. switch (msg.queryCategory().queryClass())
  1748. {
  1749. case MSGCLS_addid:
  1750. doAddJobId(msg.queryJobInfo().queryJobID(), msg.queryText());
  1751. break;
  1752. case MSGCLS_removeid:
  1753. doRemoveJobId(msg.queryJobInfo().queryJobID());
  1754. break;
  1755. default:
  1756. ReadLockBlock block(monitorLock);
  1757. ForEachItemIn(i, monitors)
  1758. monitors.item(i).processMessage(msg);
  1759. break;
  1760. }
  1761. }
  1762. catch(IException * e)
  1763. {
  1764. StringBuffer err("exception reporting log message: ");
  1765. err.append(e->errorCode());
  1766. e->errorMessage(err);
  1767. panic(err.str());
  1768. e->Release();
  1769. }
  1770. catch(...)
  1771. {
  1772. panic("unknown exception reporting log message");
  1773. }
  1774. }
  1775. void CLogMsgManager::panic(char const * reason) const
  1776. {
  1777. fprintf(stderr, "%s", reason); // not sure there's anything more useful we can do here
  1778. }
  1779. offset_t CLogMsgManager::getLogPosition(StringBuffer &logFileName, const ILogMsgHandler * handler) const
  1780. {
  1781. if (processor)
  1782. processor->flush(10*1000);
  1783. WriteLockBlock block(monitorLock); // Prevents any incoming messages as we are doing this
  1784. return handler->getLogPosition(logFileName);
  1785. }
  1786. aindex_t CLogMsgManager::find(const ILogMsgHandler * handler) const
  1787. {
  1788. // N.B. Should be used inside critical block
  1789. ForEachItemIn(i, monitors)
  1790. if(monitors.item(i).queryHandler()==handler) return i;
  1791. return NotFound;
  1792. }
  1793. bool CLogMsgManager::addMonitor(ILogMsgHandler * handler, ILogMsgFilter * filter)
  1794. {
  1795. flushQueue(10*1000);
  1796. WriteLockBlock block(monitorLock);
  1797. if(find(handler) != NotFound) return false;
  1798. monitors.append(*(new LogMsgMonitor(filter, handler)));
  1799. prefilter.orWithFilter(filter);
  1800. sendFilterToChildren(true);
  1801. return true;
  1802. }
  1803. bool CLogMsgManager::addMonitorOwn(ILogMsgHandler * handler, ILogMsgFilter * filter)
  1804. {
  1805. bool ret = addMonitor(handler, filter);
  1806. filter->Release();
  1807. handler->Release();
  1808. return ret;
  1809. }
  1810. void CLogMsgManager::buildPrefilter()
  1811. {
  1812. // N.B. Should be used inside critical block
  1813. prefilter.reset();
  1814. ForEachItemIn(i, monitors)
  1815. prefilter.orWithFilter(monitors.item(i).queryFilter());
  1816. }
  1817. bool CLogMsgManager::removeMonitor(ILogMsgHandler * handler)
  1818. {
  1819. Linked<LogMsgMonitor> todelete;
  1820. {
  1821. WriteLockBlock block(monitorLock);
  1822. aindex_t pos = find(handler);
  1823. if(pos == NotFound) return false;
  1824. todelete.set(&monitors.item(pos));
  1825. monitors.remove(pos);
  1826. buildPrefilter();
  1827. sendFilterToChildren(true);
  1828. return true;
  1829. }
  1830. }
  1831. unsigned CLogMsgManager::removeMonitorsMatching(HandlerTest & test)
  1832. {
  1833. CIArrayOf<LogMsgMonitor> todelete; // delete outside monitorLock
  1834. unsigned count = 0;
  1835. {
  1836. WriteLockBlock block(monitorLock);
  1837. ForEachItemInRev(i, monitors)
  1838. if(test(monitors.item(i).queryHandler()))
  1839. {
  1840. LogMsgMonitor &it = monitors.item(i);
  1841. it.Link();
  1842. todelete.append(it);
  1843. monitors.remove(i);
  1844. ++count;
  1845. }
  1846. buildPrefilter();
  1847. sendFilterToChildren(true);
  1848. }
  1849. return count;
  1850. }
  1851. void CLogMsgManager::removeAllMonitors()
  1852. {
  1853. CIArrayOf<LogMsgMonitor> todelete; // delete outside monitorLock
  1854. {
  1855. WriteLockBlock block(monitorLock);
  1856. ForEachItemInRev(i, monitors) {
  1857. LogMsgMonitor &it = monitors.item(i);
  1858. it.Link();
  1859. todelete.append(it);
  1860. monitors.remove(i);
  1861. }
  1862. prefilter.reset();
  1863. sendFilterToChildren(true);
  1864. }
  1865. }
  1866. void CLogMsgManager::resetMonitors()
  1867. {
  1868. suspendChildren();
  1869. removeAllMonitors();
  1870. Owned<ILogMsgFilter> defaultFilter = getDefaultLogMsgFilter();
  1871. addMonitor(theStderrHandler, defaultFilter);
  1872. unsuspendChildren();
  1873. }
  1874. ILogMsgFilter * CLogMsgManager::queryMonitorFilter(const ILogMsgHandler * handler) const
  1875. {
  1876. ReadLockBlock block(monitorLock);
  1877. aindex_t pos = find(handler);
  1878. if(pos == NotFound) return 0;
  1879. return monitors.item(pos).queryFilter();
  1880. }
  1881. bool CLogMsgManager::changeMonitorFilter(const ILogMsgHandler * handler, ILogMsgFilter * newFilter)
  1882. {
  1883. WriteLockBlock block(monitorLock);
  1884. aindex_t pos = find(handler);
  1885. if(pos == NotFound) return 0;
  1886. monitors.item(pos).setFilter(newFilter);
  1887. buildPrefilter();
  1888. sendFilterToChildren(true);
  1889. return true;
  1890. }
  1891. void CLogMsgManager::prepAllHandlers() const
  1892. {
  1893. ReadLockBlock block(monitorLock);
  1894. ForEachItemIn(i, monitors)
  1895. if(monitors.item(i).queryHandler()->needsPrep()) monitors.item(i).queryHandler()->prep();
  1896. }
  1897. aindex_t CLogMsgManager::findChild(ILogMsgLinkToChild * child) const
  1898. {
  1899. ForEachItemIn(i, children)
  1900. if(&(children.item(i)) == child ) return i;
  1901. return NotFound;
  1902. }
  1903. ILogMsgFilter * CLogMsgManager::getCompoundFilter(bool locked) const
  1904. {
  1905. if(!locked) monitorLock.lockRead();
  1906. Owned<CategoryLogMsgFilter> categoryFilter = new CategoryLogMsgFilter(0, 0, 0, false);
  1907. Owned<ILogMsgFilter> otherFilters;
  1908. ILogMsgFilter * ifilter;
  1909. bool hadCat = false;
  1910. ForEachItemIn(i, monitors)
  1911. {
  1912. ifilter = monitors.item(i).queryFilter();
  1913. if(ifilter->queryLocalFlag()) continue;
  1914. if(ifilter->isCategoryFilter())
  1915. {
  1916. categoryFilter->orWithFilter(ifilter);
  1917. hadCat = true;
  1918. }
  1919. else
  1920. {
  1921. if(otherFilters)
  1922. otherFilters.setown(getOrLogMsgFilter(otherFilters, ifilter));
  1923. else
  1924. otherFilters.set(ifilter);
  1925. }
  1926. }
  1927. if(hadCat)
  1928. {
  1929. if(otherFilters)
  1930. otherFilters.setown(getOrLogMsgFilter(otherFilters, categoryFilter));
  1931. else
  1932. otherFilters.set(categoryFilter);
  1933. }
  1934. if(!locked) monitorLock.unlock();
  1935. if(!otherFilters)
  1936. return getPassNoneLogMsgFilter();
  1937. return otherFilters.getLink();
  1938. }
  1939. void CLogMsgManager::sendFilterToChildren(bool locked) const
  1940. {
  1941. if(suspendedChildren) return;
  1942. ReadLockBlock block(childLock);
  1943. if(children.length()==0) return;
  1944. ILogMsgFilter * filter = getCompoundFilter(locked);
  1945. ForEachItemIn(i, children)
  1946. children.item(i).sendFilter(filter);
  1947. filter->Release();
  1948. }
  1949. bool CLogMsgManager::addMonitorToPTree(const ILogMsgHandler * handler, IPropertyTree * tree) const
  1950. {
  1951. ReadLockBlock block(monitorLock);
  1952. aindex_t pos = find(handler);
  1953. if(pos == NotFound) return false;
  1954. monitors.item(pos).addToPTree(tree);
  1955. return true;
  1956. }
  1957. void CLogMsgManager::addAllMonitorsToPTree(IPropertyTree * tree) const
  1958. {
  1959. ReadLockBlock block(monitorLock);
  1960. ForEachItemIn(i, monitors)
  1961. monitors.item(i).addToPTree(tree);
  1962. }
  1963. bool CLogMsgManager::rejectsCategory(const LogMsgCategory & cat) const
  1964. {
  1965. if (!prefilter.includeCategory(cat))
  1966. return true;
  1967. ReadLockBlock block(monitorLock);
  1968. ForEachItemIn(i, monitors)
  1969. {
  1970. if (monitors.item(i).queryFilter()->mayIncludeCategory(cat))
  1971. return false;
  1972. }
  1973. return true;
  1974. }
  1975. // Helper functions
  1976. ILogMsgFilter * getDeserializedLogMsgFilter(MemoryBuffer & in)
  1977. {
  1978. unsigned type;
  1979. in.read(type);
  1980. switch(type)
  1981. {
  1982. case MSGFILTER_passall : return LINK(thePassAllFilter);
  1983. case MSGFILTER_passlocal : return LINK(thePassLocalFilter);
  1984. case MSGFILTER_passnone : return LINK(thePassNoneFilter);
  1985. case MSGFILTER_category : return new CategoryLogMsgFilter(in);
  1986. case MSGFILTER_pid : return new PIDLogMsgFilter(in);
  1987. case MSGFILTER_tid : return new TIDLogMsgFilter(in);
  1988. case MSGFILTER_node : return new NodeLogMsgFilter(in);
  1989. case MSGFILTER_ip : return new IpLogMsgFilter(in);
  1990. case MSGFILTER_session : return new SessionLogMsgFilter(in);
  1991. case MSGFILTER_component : return new ComponentLogMsgFilter(in);
  1992. case MSGFILTER_regex : return new RegexLogMsgFilter(in);
  1993. case MSGFILTER_not : return new NotLogMsgFilter(in);
  1994. case MSGFILTER_and : return new AndLogMsgFilter(in);
  1995. case MSGFILTER_or : return new OrLogMsgFilter(in);
  1996. case MSGFILTER_switch : return new SwitchLogMsgFilter(in);
  1997. default: assertex(!"getDeserializedLogMsgFilter: unrecognized LogMsgFilterType");
  1998. }
  1999. return 0;
  2000. }
  2001. ILogMsgFilter * getLogMsgFilterFromPTree(IPropertyTree * xml)
  2002. {
  2003. /* Note that several of these constructors use GetPropInt and GetPropInt64 to get unsigneds. I think this is OK? (all int64 internally)*/
  2004. StringBuffer type;
  2005. xml->getProp("@type", type);
  2006. if(strcmp(type.str(), "all")==0) return LINK(thePassAllFilter);
  2007. else if(strcmp(type.str(), "local")==0) return LINK(thePassLocalFilter);
  2008. else if(strcmp(type.str(), "none")==0) return LINK(thePassNoneFilter);
  2009. else if(strcmp(type.str(), "category")==0) return new CategoryLogMsgFilter(xml);
  2010. else if(strcmp(type.str(), "pid")==0) return new PIDLogMsgFilter(xml);
  2011. else if(strcmp(type.str(), "tid")==0) return new TIDLogMsgFilter(xml);
  2012. else if(strcmp(type.str(), "node")==0) return new NodeLogMsgFilter(xml);
  2013. else if(strcmp(type.str(), "ip")==0) return new IpLogMsgFilter(xml);
  2014. else if(strcmp(type.str(), "session")==0) return new SessionLogMsgFilter(xml);
  2015. else if(strcmp(type.str(), "component")==0) return new ComponentLogMsgFilter(xml);
  2016. else if(strcmp(type.str(), "regex")==0) return new RegexLogMsgFilter(xml);
  2017. else if(strcmp(type.str(), "not")==0) return new NotLogMsgFilter(xml);
  2018. else if(strcmp(type.str(), "and")==0) return new AndLogMsgFilter(xml);
  2019. else if(strcmp(type.str(), "or")==0) return new OrLogMsgFilter(xml);
  2020. else if(strcmp(type.str(), "filter")==0) return new SwitchLogMsgFilter(xml);
  2021. else assertex(!"getLogMsgFilterFromPTree : unrecognized LogMsgFilter type");
  2022. return getPassAllLogMsgFilter();
  2023. }
  2024. ILogMsgFilter * getDefaultLogMsgFilter()
  2025. {
  2026. return new CategoryLogMsgFilter(MSGAUD_all, MSGCLS_all, DefaultDetail, true);
  2027. }
  2028. ILogMsgFilter * getPassAllLogMsgFilter()
  2029. {
  2030. return LINK(thePassAllFilter);
  2031. }
  2032. ILogMsgFilter * getLocalLogMsgFilter()
  2033. {
  2034. return LINK(thePassLocalFilter);
  2035. }
  2036. ILogMsgFilter * getPassNoneLogMsgFilter()
  2037. {
  2038. return LINK(thePassNoneFilter);
  2039. }
  2040. ILogMsgFilter * queryPassAllLogMsgFilter()
  2041. {
  2042. return thePassAllFilter;
  2043. }
  2044. ILogMsgFilter * queryLocalLogMsgFilter()
  2045. {
  2046. return thePassLocalFilter;
  2047. }
  2048. ILogMsgFilter * queryPassNoneLogMsgFilter()
  2049. {
  2050. return thePassNoneFilter;
  2051. }
  2052. ILogMsgFilter * getCategoryLogMsgFilter(unsigned audiences, unsigned classes, LogMsgDetail maxDetail, bool local)
  2053. {
  2054. if((audiences==MSGAUD_all) && (classes==MSGCLS_all) && (maxDetail==TopDetail))
  2055. {
  2056. if(local)
  2057. return LINK(thePassLocalFilter);
  2058. else
  2059. return LINK(thePassAllFilter);
  2060. }
  2061. return new CategoryLogMsgFilter(audiences, classes, maxDetail, local);
  2062. }
  2063. ILogMsgFilter * getPIDLogMsgFilter(unsigned pid, bool local)
  2064. {
  2065. return new PIDLogMsgFilter(pid, local);
  2066. }
  2067. ILogMsgFilter * getTIDLogMsgFilter(unsigned tid, bool local)
  2068. {
  2069. return new TIDLogMsgFilter(tid, local);
  2070. }
  2071. ILogMsgFilter * getNodeLogMsgFilter(const char * name, unsigned port, bool local)
  2072. {
  2073. return new NodeLogMsgFilter(name, port, local);
  2074. }
  2075. ILogMsgFilter * getNodeLogMsgFilter(const IpAddress & ip, unsigned port, bool local)
  2076. {
  2077. return new NodeLogMsgFilter(ip, port, local);
  2078. }
  2079. ILogMsgFilter * getNodeLogMsgFilter(unsigned port, bool local)
  2080. {
  2081. return new NodeLogMsgFilter(port, local);
  2082. }
  2083. ILogMsgFilter * getIpLogMsgFilter(const char * name, bool local)
  2084. {
  2085. return new IpLogMsgFilter(name, local);
  2086. }
  2087. ILogMsgFilter * getIpLogMsgFilter(const IpAddress & ip, bool local)
  2088. {
  2089. return new IpLogMsgFilter(ip, local);
  2090. }
  2091. ILogMsgFilter * getIpLogMsgFilter(bool local)
  2092. {
  2093. return new IpLogMsgFilter(local);
  2094. }
  2095. ILogMsgFilter * getSessionLogMsgFilter(LogMsgSessionId session, bool local)
  2096. {
  2097. return new SessionLogMsgFilter(session, local);
  2098. }
  2099. ILogMsgFilter * getComponentLogMsgFilter(unsigned component, bool local)
  2100. {
  2101. return new ComponentLogMsgFilter(component, local);
  2102. }
  2103. ILogMsgFilter * getRegexLogMsgFilter(const char *regex, bool local)
  2104. {
  2105. return new RegexLogMsgFilter(regex, local);
  2106. }
  2107. ILogMsgFilter * getNotLogMsgFilter(ILogMsgFilter * arg)
  2108. {
  2109. return new NotLogMsgFilter(arg);
  2110. }
  2111. ILogMsgFilter * getNotLogMsgFilterOwn(ILogMsgFilter * arg)
  2112. {
  2113. ILogMsgFilter * ret = new NotLogMsgFilter(arg);
  2114. arg->Release();
  2115. return ret;
  2116. }
  2117. ILogMsgFilter * getAndLogMsgFilter(ILogMsgFilter * arg1, ILogMsgFilter * arg2)
  2118. {
  2119. return new AndLogMsgFilter(arg1, arg2);
  2120. }
  2121. ILogMsgFilter * getAndLogMsgFilterOwn(ILogMsgFilter * arg1, ILogMsgFilter * arg2)
  2122. {
  2123. ILogMsgFilter * ret = new AndLogMsgFilter(arg1, arg2);
  2124. arg1->Release();
  2125. arg2->Release();
  2126. return ret;
  2127. }
  2128. ILogMsgFilter * getOrLogMsgFilter(ILogMsgFilter * arg1, ILogMsgFilter * arg2)
  2129. {
  2130. return new OrLogMsgFilter(arg1, arg2);
  2131. }
  2132. ILogMsgFilter * getOrLogMsgFilterOwn(ILogMsgFilter * arg1, ILogMsgFilter * arg2)
  2133. {
  2134. ILogMsgFilter * ret = new OrLogMsgFilter(arg1, arg2);
  2135. arg1->Release();
  2136. arg2->Release();
  2137. return ret;
  2138. }
  2139. ILogMsgFilter * getSwitchLogMsgFilterOwn(ILogMsgFilter * switchFilter, ILogMsgFilter * yesFilter, ILogMsgFilter * noFilter)
  2140. {
  2141. ILogMsgFilter * ret = new SwitchLogMsgFilter(switchFilter, yesFilter, noFilter);
  2142. switchFilter->Release();
  2143. yesFilter->Release();
  2144. noFilter->Release();
  2145. return ret;
  2146. }
  2147. ILogMsgHandler * getHandleLogMsgHandler(FILE * handle, unsigned fields, bool writeXML)
  2148. {
  2149. if(writeXML)
  2150. return new HandleLogMsgHandlerXML(handle, fields);
  2151. return new HandleLogMsgHandlerTable(handle, fields);
  2152. }
  2153. ILogMsgHandler * getFileLogMsgHandler(const char * filename, const char * headertext, unsigned fields, bool writeXML, bool append, bool flushes)
  2154. {
  2155. if(writeXML)
  2156. return new FileLogMsgHandlerXML(filename, headertext, fields, append, flushes);
  2157. return new FileLogMsgHandlerTable(filename, headertext, fields, append, flushes);
  2158. }
  2159. ILogMsgHandler * getRollingFileLogMsgHandler(const char * filebase, const char * fileextn, unsigned fields, bool append, bool flushes, const char *initialName, const char *alias, bool daily, long maxLogSize)
  2160. {
  2161. return new RollingFileLogMsgHandler(filebase, fileextn, fields, append, flushes, initialName, alias, daily, maxLogSize);
  2162. }
  2163. ILogMsgHandler * getBinLogMsgHandler(const char * filename, bool append)
  2164. {
  2165. return new BinLogMsgHandler(filename, append);
  2166. }
  2167. void installLogMsgFilterSwitch(ILogMsgHandler * handler, ILogMsgFilter * switchFilter, ILogMsgFilter * newFilter)
  2168. {
  2169. queryLogMsgManager()->changeMonitorFilterOwn(handler, getSwitchLogMsgFilterOwn(switchFilter, newFilter, queryLogMsgManager()->getMonitorFilter(handler)));
  2170. }
  2171. ILogMsgHandler * getLogMsgHandlerFromPTree(IPropertyTree * tree)
  2172. {
  2173. StringBuffer type;
  2174. tree->getProp("@type", type);
  2175. unsigned fields = MSGFIELD_all;
  2176. char const * fstr = tree->queryProp("@fields");
  2177. if(fstr)
  2178. {
  2179. if(isdigit(fstr[0]))
  2180. fields = atoi(fstr);
  2181. else
  2182. fields = logMsgFieldsFromAbbrevs(fstr);
  2183. }
  2184. if(strcmp(type.str(), "stderr")==0)
  2185. return getHandleLogMsgHandler(stderr, fields, tree->hasProp("@writeXML"));
  2186. else if(strcmp(type.str(), "file")==0)
  2187. {
  2188. StringBuffer filename;
  2189. tree->getProp("@filename", filename);
  2190. if(tree->hasProp("@headertext"))
  2191. {
  2192. StringBuffer headertext;
  2193. tree->getProp("@headertext", headertext);
  2194. return getFileLogMsgHandler(filename.str(), headertext.str(), fields, !(tree->hasProp("@writeTable")), tree->hasProp("@append"), tree->hasProp("@flushes"));
  2195. }
  2196. else
  2197. return getFileLogMsgHandler(filename.str(), 0, fields, !(tree->hasProp("@writeTable")), tree->hasProp("@append"), tree->hasProp("@flushes"));
  2198. }
  2199. else if(strcmp(type.str(), "binary")==0)
  2200. {
  2201. StringBuffer filename;
  2202. tree->getProp("@filename", filename);
  2203. return getBinLogMsgHandler(filename.str(), tree->hasProp("@append"));
  2204. }
  2205. else assertex(!"getLogMsgFilterFromPTree : unrecognized LogMsgHandler type");
  2206. return LINK(theStderrHandler);
  2207. }
  2208. ILogMsgHandler * attachStandardFileLogMsgMonitor(const char * filename, const char * headertext, unsigned fields, unsigned audiences, unsigned classes, LogMsgDetail detail, bool writeXML, bool append, bool flushes, bool local)
  2209. {
  2210. #ifdef FILE_LOG_ENABLES_QUEUEUING
  2211. queryLogMsgManager()->enterQueueingMode();
  2212. #endif
  2213. ILogMsgFilter * filter = getCategoryLogMsgFilter(audiences, classes, detail, local);
  2214. ILogMsgHandler * handler = getFileLogMsgHandler(filename, headertext, fields, writeXML, append, flushes);
  2215. queryLogMsgManager()->addMonitorOwn(handler, filter);
  2216. return handler;
  2217. }
  2218. ILogMsgHandler * attachStandardBinLogMsgMonitor(const char * filename, unsigned audiences, unsigned classes, LogMsgDetail detail, bool append, bool local)
  2219. {
  2220. #ifdef FILE_LOG_ENABLES_QUEUEUING
  2221. queryLogMsgManager()->enterQueueingMode();
  2222. #endif
  2223. ILogMsgFilter * filter = getCategoryLogMsgFilter(audiences, classes, detail, local);
  2224. ILogMsgHandler * handler = getBinLogMsgHandler(filename, append);
  2225. queryLogMsgManager()->addMonitorOwn(handler, filter);
  2226. return handler;
  2227. }
  2228. ILogMsgHandler * attachStandardHandleLogMsgMonitor(FILE * handle, unsigned fields, unsigned audiences, unsigned classes, LogMsgDetail detail, bool writeXML, bool local)
  2229. {
  2230. ILogMsgFilter * filter = getCategoryLogMsgFilter(audiences, classes, detail, local);
  2231. ILogMsgHandler * handler = getHandleLogMsgHandler(handle, fields, writeXML);
  2232. queryLogMsgManager()->addMonitorOwn(handler, filter);
  2233. return handler;
  2234. }
  2235. ILogMsgHandler * attachLogMsgMonitorFromPTree(IPropertyTree * tree)
  2236. {
  2237. Owned<IPropertyTree> handlertree = tree->getPropTree("handler");
  2238. Owned<IPropertyTree> filtertree = tree->getPropTree("filter");
  2239. ILogMsgHandler * handler = getLogMsgHandlerFromPTree(handlertree);
  2240. ILogMsgFilter * filter = getLogMsgFilterFromPTree(filtertree);
  2241. queryLogMsgManager()->addMonitorOwn(handler, filter);
  2242. return handler;
  2243. }
  2244. void attachManyLogMsgMonitorsFromPTree(IPropertyTree * tree)
  2245. {
  2246. Owned<IPropertyTreeIterator> iter = tree->getElements("monitor");
  2247. ForEach(*iter)
  2248. attachLogMsgMonitorFromPTree(&(iter->query()));
  2249. }
  2250. // Calls to make, remove, and return the manager, standard handler, pass all/none filters, reporter array
  2251. PassAllLogMsgFilter * thePassAllFilter;
  2252. PassLocalLogMsgFilter * thePassLocalFilter;
  2253. PassNoneLogMsgFilter * thePassNoneFilter;
  2254. HandleLogMsgHandlerTable * theStderrHandler;
  2255. CLogMsgManager * theManager;
  2256. CSysLogEventLogger * theSysLogEventLogger;
  2257. LogMsgComponentReporter * theReporters[MSGCOMP_NUMBER];
  2258. MODULE_INIT(INIT_PRIORITY_JLOG)
  2259. {
  2260. thePassAllFilter = new PassAllLogMsgFilter();
  2261. thePassLocalFilter = new PassLocalLogMsgFilter();
  2262. thePassNoneFilter = new PassNoneLogMsgFilter();
  2263. theStderrHandler = new HandleLogMsgHandlerTable(stderr, MSGFIELD_STANDARD);
  2264. theSysLogEventLogger = new CSysLogEventLogger;
  2265. theManager = new CLogMsgManager();
  2266. theManager->resetMonitors();
  2267. for(unsigned compo = 0; compo<MSGCOMP_NUMBER; compo++)
  2268. theReporters[compo] = new LogMsgComponentReporter(compo);
  2269. return true;
  2270. }
  2271. MODULE_EXIT()
  2272. {
  2273. for(unsigned compo = 0; compo<MSGCOMP_NUMBER; compo++)
  2274. {
  2275. delete theReporters[compo];
  2276. theReporters[compo] = NULL;
  2277. }
  2278. delete theManager;
  2279. delete theSysLogEventLogger;
  2280. delete theStderrHandler;
  2281. delete thePassNoneFilter;
  2282. delete thePassLocalFilter;
  2283. delete thePassAllFilter;
  2284. theManager = NULL;
  2285. theSysLogEventLogger = NULL;
  2286. theStderrHandler = NULL;
  2287. thePassNoneFilter = NULL;
  2288. thePassLocalFilter = NULL;
  2289. thePassAllFilter = NULL;
  2290. }
  2291. #ifdef _CONTAINERIZED
  2292. static constexpr const char * logFieldsAtt = "@fields";
  2293. static constexpr const char * logMsgDetailAtt = "@detail";
  2294. static constexpr const char * logMsgAudiencesAtt = "@audiences";
  2295. static constexpr const char * logMsgClassesAtt = "@classes";
  2296. static constexpr const char * useLogQueueAtt = "@useLogQueue";
  2297. static constexpr const char * logQueueLenAtt = "@queueLen";
  2298. static constexpr const char * logQueueDropAtt = "@queueDrop";
  2299. static constexpr const char * logQueueDisabledAtt = "@disabled";
  2300. static constexpr const char * useSysLogpAtt ="@enableSysLog";
  2301. #ifdef _DEBUG
  2302. static constexpr bool useQueueDefault = false;
  2303. #else
  2304. static constexpr bool useQueueDefault = true;
  2305. #endif
  2306. static constexpr unsigned queueLenDefault = 512;
  2307. static constexpr unsigned queueDropDefault = 32;
  2308. static constexpr bool useSysLogDefault = false;
  2309. void setupContainerizedLogMsgHandler()
  2310. {
  2311. Owned<IPropertyTree> logConfig = getComponentConfigSP()->getPropTree("logging");
  2312. if (logConfig)
  2313. {
  2314. if (logConfig->getPropBool(logQueueDisabledAtt, false))
  2315. {
  2316. removeLog();
  2317. return;
  2318. }
  2319. if (logConfig->hasProp(logFieldsAtt))
  2320. {
  2321. //Supported logging fields: AUD,CLS,DET,MID,TIM,DAT,PID,TID,NOD,JOB,USE,SES,COD,MLT,MCT,NNT,COM,QUO,PFX,ALL,STD
  2322. const char *logFields = logConfig->queryProp(logFieldsAtt);
  2323. if (!isEmptyString(logFields))
  2324. theStderrHandler->setMessageFields(logMsgFieldsFromAbbrevs(logFields));
  2325. }
  2326. //Only recreate filter if at least one filter attribute configured
  2327. if (logConfig->hasProp(logMsgDetailAtt) || logConfig->hasProp(logMsgAudiencesAtt) || logConfig->hasProp(logMsgClassesAtt))
  2328. {
  2329. LogMsgDetail logDetail = logConfig->getPropInt(logMsgDetailAtt, DefaultDetail);
  2330. unsigned msgClasses = MSGCLS_all;
  2331. const char *logClasses = logConfig->queryProp(logMsgClassesAtt);
  2332. if (!isEmptyString(logClasses))
  2333. msgClasses = logMsgClassesFromAbbrevs(logClasses);
  2334. unsigned msgAudiences = MSGAUD_all;
  2335. const char *logAudiences = logConfig->queryProp(logMsgAudiencesAtt);
  2336. if (!isEmptyString(logAudiences))
  2337. msgAudiences = logMsgAudsFromAbbrevs(logAudiences);
  2338. const bool local = true; // Do not include remote messages from other components
  2339. Owned<ILogMsgFilter> filter = getCategoryLogMsgFilter(msgAudiences, msgClasses, logDetail, local);
  2340. theManager->changeMonitorFilter(theStderrHandler, filter);
  2341. }
  2342. bool useLogQueue = logConfig->getPropBool(useLogQueueAtt, useQueueDefault);
  2343. if (useLogQueue)
  2344. {
  2345. unsigned queueLen = logConfig->getPropInt(logQueueLenAtt, queueLenDefault);
  2346. unsigned queueDrop = logConfig->getPropInt(logQueueDropAtt, queueDropDefault);
  2347. queryLogMsgManager()->enterQueueingMode();
  2348. queryLogMsgManager()->setQueueDroppingLimit(queueLen, queueDrop);
  2349. }
  2350. if (logConfig->getPropBool(useSysLogpAtt, useSysLogDefault))
  2351. UseSysLogForOperatorMessages();
  2352. }
  2353. }
  2354. #endif
  2355. ILogMsgManager * queryLogMsgManager()
  2356. {
  2357. return theManager;
  2358. }
  2359. ILogMsgHandler * queryStderrLogMsgHandler()
  2360. {
  2361. return theStderrHandler;
  2362. }
  2363. LogMsgComponentReporter * queryLogMsgComponentReporter(unsigned compo)
  2364. {
  2365. return theReporters[compo];
  2366. }
  2367. ILogMsgManager * createLogMsgManager() // use with care! (needed by mplog listener facility)
  2368. {
  2369. return new CLogMsgManager();
  2370. }
  2371. // Event Logging
  2372. ISysLogEventLogger * querySysLogEventLogger()
  2373. {
  2374. return theSysLogEventLogger;
  2375. }
  2376. ILogMsgHandler * getSysLogMsgHandler(unsigned fields)
  2377. {
  2378. return new SysLogMsgHandler(theSysLogEventLogger, fields);
  2379. }
  2380. #ifdef _WIN32
  2381. #include <WINNT.H>
  2382. #include "jelog.h"
  2383. struct AuditTypeWin32Data
  2384. {
  2385. public:
  2386. unsigned eventtype;
  2387. unsigned categoryid;
  2388. unsigned eventid;
  2389. };
  2390. #define CATEGORY_AUDIT_FUNCTION_REQUIRED
  2391. #define AUDIT_TYPES_BEGIN AuditTypeWin32Data auditTypeDataMap[NUM_AUDIT_TYPES+1] = {
  2392. #define MAKE_AUDIT_TYPE(name, type, categoryid, eventid, level) {type, categoryid, eventid},
  2393. #define AUDIT_TYPES_END {0, 0, 0} };
  2394. #include "jelogtype.hpp"
  2395. #undef CATEGORY_AUDIT_FUNCTION_REQUIRED
  2396. #undef AUDIT_TYPES_BEGIN
  2397. #undef MAKE_AUDIT_TYPE
  2398. #undef AUDIT_TYPES_END
  2399. CSysLogEventLogger::CSysLogEventLogger() : hEventLog(0)
  2400. {
  2401. }
  2402. bool CSysLogEventLogger::log(AuditType auditType, char const * msg, size32_t datasize, void const * data)
  2403. {
  2404. assertex(auditType < NUM_AUDIT_TYPES);
  2405. AuditTypeWin32Data const & typeData = auditTypeDataMap[auditType];
  2406. return win32Report(typeData.eventtype, typeData.categoryid, typeData.eventid, msg, datasize, data);
  2407. }
  2408. bool CSysLogEventLogger::win32Report(unsigned eventtype, unsigned category, unsigned eventid, const char * msg, size32_t datasize, const void * data)
  2409. {
  2410. if (hEventLog==0) {
  2411. // MORE - this doesn't work on Vista/Win7 as can't copy to system32...
  2412. // Perhaps we should just kill this code
  2413. char path[_MAX_PATH+1];
  2414. GetEnvironmentVariable("SystemRoot",path,sizeof(path));
  2415. strcat(path,"\\System32\\JELOG.dll");
  2416. Owned<IFile> file = createIFile(path);
  2417. try {
  2418. if (!file->exists()) {
  2419. char src[_MAX_PATH+1];
  2420. LPTSTR tail;
  2421. DWORD res = SearchPath(NULL,"JELOG.DLL",NULL,sizeof(src),src,&tail);
  2422. if (res>0)
  2423. copyFile(path,src);
  2424. else
  2425. throw makeOsException(GetLastError());
  2426. }
  2427. }
  2428. catch (IException *e)
  2429. {
  2430. EXCLOG(e, "reportEventLog: Could not install JELOG.DLL");
  2431. hEventLog=(HANDLE)-1;
  2432. e->Release();
  2433. return false;
  2434. }
  2435. HKEY hk;
  2436. if (RegCreateKeyEx(HKEY_LOCAL_MACHINE,"SYSTEM\\CurrentControlSet\\Services\\EventLog\\Application\\Seisint",
  2437. NULL, NULL, 0, KEY_ALL_ACCESS, NULL, &hk, NULL)==0) {
  2438. DWORD sizedata = 0;
  2439. DWORD type = REG_EXPAND_SZ;
  2440. if ((RegQueryValueEx(hk,"EventMessageFile",NULL, &type, NULL, &sizedata)!=0)||!sizedata) {
  2441. StringAttr str("%SystemRoot%\\System32\\JELOG.dll");
  2442. RegSetValueEx(hk,"EventMessageFile", 0, REG_EXPAND_SZ, (LPBYTE) str.get(), (DWORD)str.length() + 1);
  2443. RegSetValueEx(hk,"CategoryMessageFile", 0, REG_EXPAND_SZ, (LPBYTE) str.get(), (DWORD)str.length() + 1);
  2444. DWORD dwData = EVENTLOG_ERROR_TYPE | EVENTLOG_WARNING_TYPE | EVENTLOG_INFORMATION_TYPE | EVENTLOG_AUDIT_SUCCESS | EVENTLOG_AUDIT_FAILURE;
  2445. RegSetValueEx(hk, "TypesSupported", 0, REG_DWORD, (LPBYTE) &dwData, sizeof(DWORD));
  2446. dwData = 16;
  2447. RegSetValueEx(hk, "CategoryCount", 0, REG_DWORD, (LPBYTE) &dwData, sizeof(DWORD));
  2448. }
  2449. RegCloseKey(hk);
  2450. }
  2451. hEventLog = RegisterEventSource(NULL,"Seisint");
  2452. if (!hEventLog) {
  2453. OERRLOG("reportEventLog: Could not register Seisint event source");
  2454. hEventLog=(HANDLE)-1;
  2455. return false;
  2456. }
  2457. }
  2458. if (hEventLog==(HANDLE)-1)
  2459. return false;
  2460. assertex((unsigned)eventtype<=16);
  2461. if (!data)
  2462. datasize = 0;
  2463. else if (!datasize)
  2464. data = NULL;
  2465. #if 1 //useful for debugging...
  2466. ReportEvent(hEventLog, eventtype, category, eventid, NULL, 1, datasize, &msg, (LPVOID)data);
  2467. #else
  2468. if(datasize)
  2469. {
  2470. char * buff = (char *)malloc(datasize*3+1);
  2471. unsigned char const * cdata = (unsigned char *)data;
  2472. unsigned i;
  2473. for(i=0; i<datasize; i++)
  2474. sprintf(buff+i*3, "%02X ", cdata[i]);
  2475. buff[datasize*3-1] = 0;
  2476. DBGLOG("ReportEvent: type=%X categoryid=%X eventid=%X msg='%s' data=[%s]", eventtype, category, eventid, msg, buff);
  2477. free(buff);
  2478. }
  2479. else
  2480. DBGLOG("ReportEvent: type=%X categoryid=%X eventid=%X msg='%s'", eventtype, category, eventid, msg);
  2481. #endif
  2482. return true;
  2483. }
  2484. CSysLogEventLogger::~CSysLogEventLogger()
  2485. {
  2486. if (hEventLog!=0)
  2487. DeregisterEventSource(hEventLog);
  2488. }
  2489. #else
  2490. #include <syslog.h>
  2491. #define CATEGORY_AUDIT_FUNCTION_REQUIRED
  2492. #define AUDIT_TYPES_BEGIN int auditTypeDataMap[NUM_AUDIT_TYPES+1] = {
  2493. #define MAKE_AUDIT_TYPE(name, type, categoryid, eventid, level) level,
  2494. #define AUDIT_TYPES_END 0 };
  2495. #include "jelogtype.hpp"
  2496. #undef CATEGORY_AUDIT_FUNCTION_REQUIRED
  2497. #undef AUDIT_TYPES_BEGIN
  2498. #undef MAKE_AUDIT_TYPE
  2499. #undef AUDIT_TYPES_END
  2500. CSysLogEventLogger::CSysLogEventLogger() : dataLogUsed(false), dataLogName(0), dataLogFile(-1)
  2501. {
  2502. StringBuffer folder;
  2503. const char * processName = splitDirTail(queryCurrentProcessPath(), folder);
  2504. if (!processName||!*processName)
  2505. processName = "hpcc";
  2506. openlog(processName, LOG_PID, LOG_USER);
  2507. }
  2508. CSysLogEventLogger::~CSysLogEventLogger()
  2509. {
  2510. if(dataLogFile != -1)
  2511. close(dataLogFile);
  2512. if(dataLogName)
  2513. delete [] dataLogName;
  2514. closelog();
  2515. }
  2516. bool CSysLogEventLogger::log(AuditType auditType, const char *msg, size32_t datasize, const void * data)
  2517. {
  2518. assertex(auditType < NUM_AUDIT_TYPES);
  2519. int level = auditTypeDataMap[auditType];
  2520. return linuxReport(level, msg, datasize, data);
  2521. }
  2522. bool CSysLogEventLogger::linuxReport(int level, const char * msg, size32_t datasize, const void * data)
  2523. {
  2524. if (!data)
  2525. datasize = 0;
  2526. else if (!datasize)
  2527. data = NULL;
  2528. bool ret = true;
  2529. #if 1 //useful for debugging...
  2530. if(data)
  2531. {
  2532. if(!dataLogUsed)
  2533. openDataLog();
  2534. if(dataLogFile != -1)
  2535. {
  2536. int fpos = writeDataLog(datasize, (byte const *)data);
  2537. if(fpos != -1)
  2538. syslog(level, "%s [0x%X bytes of data at %s byte 0x%X]", msg, datasize, dataLogName, fpos);
  2539. else
  2540. syslog(level, "%s [could not write 0x%X bytes of data to %s]", msg, datasize, dataLogName);
  2541. }
  2542. else
  2543. {
  2544. ret = false;
  2545. syslog(level, "%s [could not open file of form %s to write data]", msg, AUDIT_DATA_LOG_TEMPLATE);
  2546. }
  2547. }
  2548. else
  2549. {
  2550. syslog(level, "%s", msg);
  2551. }
  2552. #else
  2553. if(datasize)
  2554. {
  2555. char * buff = (char *)malloc(datasize*3+1);
  2556. unsigned char const * cdata = (unsigned char *)data;
  2557. unsigned i;
  2558. for(i=0; i<datasize; i++)
  2559. sprintf(buff+i*3, "%02X ", cdata[i]);
  2560. buff[datasize*3-1] = 0;
  2561. DBGLOG("syslog: priority=%X msg='%s' data=[%s]", level, msg, buff);
  2562. free(buff);
  2563. }
  2564. else
  2565. DBGLOG("syslog: priority=%X msg='%s'", level, msg);
  2566. #endif
  2567. return ret;
  2568. }
  2569. void CSysLogEventLogger::openDataLog()
  2570. {
  2571. CriticalBlock block(dataLogLock);
  2572. dataLogUsed = true;
  2573. unsigned len = strlen(AUDIT_DATA_LOG_TEMPLATE);
  2574. dataLogName = new char[len+1];
  2575. strcpy(dataLogName, AUDIT_DATA_LOG_TEMPLATE);
  2576. dataLogFile = mkstemp(dataLogName);
  2577. }
  2578. int CSysLogEventLogger::writeDataLog(size32_t datasize, byte const * data)
  2579. {
  2580. CriticalBlock block(dataLogLock);
  2581. off_t fpos = lseek(dataLogFile, 0, SEEK_CUR);
  2582. while(datasize > 0)
  2583. {
  2584. ssize_t written = write(dataLogFile, data, datasize);
  2585. if (written == -1)
  2586. return -1;
  2587. data += written;
  2588. datasize -= written;
  2589. }
  2590. #ifndef _WIN32
  2591. #ifdef F_FULLFSYNC
  2592. fcntl(dataLogFile, F_FULLFSYNC);
  2593. #else
  2594. fdatasync(dataLogFile);
  2595. #endif
  2596. #ifdef POSIX_FADV_DONTNEED
  2597. posix_fadvise(dataLogFile, 0, 0, POSIX_FADV_DONTNEED);
  2598. #endif
  2599. #endif
  2600. return fpos;
  2601. }
  2602. #endif
  2603. void SysLogMsgHandler::handleMessage(const LogMsg & msg)
  2604. {
  2605. AuditType type = categoryToAuditType(msg.queryCategory());
  2606. StringBuffer text;
  2607. msg.toStringPlain(text, fields);
  2608. logger->log(type, text.str());
  2609. }
  2610. void SysLogMsgHandler::addToPTree(IPropertyTree * tree) const
  2611. {
  2612. IPropertyTree * handlerTree = createPTree(ipt_caseInsensitive);
  2613. handlerTree->setProp("@type", "audit");
  2614. tree->addPropTree("handler", handlerTree);
  2615. }
  2616. // Default implementations of the functions in IContextLogger interface
  2617. void IContextLogger::CTXLOG(const char *format, ...) const
  2618. {
  2619. va_list args;
  2620. va_start(args, format);
  2621. CTXLOGva(format, args);
  2622. va_end(args);
  2623. }
  2624. void IContextLogger::mCTXLOG(const char *format, ...) const
  2625. {
  2626. va_list args;
  2627. va_start(args, format);
  2628. StringBuffer log;
  2629. log.limited_valist_appendf(1024*1024, format, args);
  2630. va_end(args);
  2631. const char *cursor = log;
  2632. const char *lineStart = cursor;
  2633. while (true)
  2634. {
  2635. switch (*cursor)
  2636. {
  2637. case '\0':
  2638. CTXLOG("%.*s", (int)(cursor-lineStart), lineStart);
  2639. return;
  2640. case '\r':
  2641. // NB: \r or \r\n translated into newline
  2642. CTXLOG("%.*s", (int)(cursor-lineStart), lineStart);
  2643. if ('\n' == *(cursor+1))
  2644. cursor++;
  2645. lineStart = cursor+1;
  2646. break;
  2647. case '\n':
  2648. CTXLOG("%.*s", (int)(cursor-lineStart), lineStart);
  2649. lineStart = cursor+1;
  2650. break;
  2651. }
  2652. ++cursor;
  2653. }
  2654. }
  2655. void IContextLogger::logOperatorException(IException *E, const char *file, unsigned line, const char *format, ...) const
  2656. {
  2657. va_list args;
  2658. va_start(args, format);
  2659. logOperatorExceptionVA(E, file, line, format, args);
  2660. va_end(args);
  2661. }
  2662. class DummyLogCtx : implements IContextLogger
  2663. {
  2664. private:
  2665. StringAttr globalId;
  2666. StringAttr callerId;
  2667. StringBuffer localId;
  2668. StringAttr globalIdHeader;
  2669. StringAttr callerIdHeader;
  2670. public:
  2671. // It's a static object - we don't want to actually link-count it...
  2672. virtual void Link() const {}
  2673. virtual bool Release() const { return false; }
  2674. virtual void CTXLOGva(const char *format, va_list args) const __attribute__((format(printf,2,0)))
  2675. {
  2676. StringBuffer ss;
  2677. ss.valist_appendf(format, args);
  2678. DBGLOG("%s", ss.str());
  2679. }
  2680. virtual void logOperatorExceptionVA(IException *E, const char *file, unsigned line, const char *format, va_list args) const __attribute__((format(printf,5,0)))
  2681. {
  2682. StringBuffer ss;
  2683. ss.append("ERROR");
  2684. if (E)
  2685. ss.append(": ").append(E->errorCode());
  2686. if (file)
  2687. ss.appendf(": %s(%d) ", sanitizeSourceFile(file), line);
  2688. if (E)
  2689. E->errorMessage(ss.append(": "));
  2690. if (format)
  2691. ss.append(": ").valist_appendf(format, args);
  2692. LOG(MCoperatorProgress, unknownJob, "%s", ss.str());
  2693. }
  2694. virtual void noteStatistic(StatisticKind kind, unsigned __int64 value) const
  2695. {
  2696. }
  2697. virtual void mergeStats(const CRuntimeStatisticCollection &from) const
  2698. {
  2699. }
  2700. virtual unsigned queryTraceLevel() const
  2701. {
  2702. return 0;
  2703. }
  2704. virtual void setGlobalId(const char *id, SocketEndpoint &ep, unsigned pid) override
  2705. {
  2706. globalId.set(id);
  2707. appendGloballyUniqueId(localId.clear());
  2708. }
  2709. virtual void setCallerId(const char *id) override
  2710. {
  2711. callerId.set(id);
  2712. }
  2713. virtual const char *queryGlobalId() const
  2714. {
  2715. return globalId.get();
  2716. }
  2717. virtual const char *queryCallerId() const override
  2718. {
  2719. return callerId.str();
  2720. }
  2721. virtual const char *queryLocalId() const
  2722. {
  2723. return localId.str();
  2724. }
  2725. virtual void setHttpIdHeaders(const char *global, const char *caller)
  2726. {
  2727. if (global && *global)
  2728. globalIdHeader.set(global);
  2729. if (caller && *caller)
  2730. callerIdHeader.set(caller);
  2731. }
  2732. virtual const char *queryGlobalIdHttpHeader() const
  2733. {
  2734. return globalIdHeader.str();
  2735. }
  2736. virtual const char *queryCallerIdHttpHeader() const
  2737. {
  2738. return callerIdHeader.str();
  2739. }
  2740. } dummyContextLogger;
  2741. extern jlib_decl const IContextLogger &queryDummyContextLogger()
  2742. {
  2743. return dummyContextLogger;
  2744. }
  2745. extern jlib_decl IContextLogger &updateDummyContextLogger()
  2746. {
  2747. return dummyContextLogger;
  2748. }
  2749. extern jlib_decl StringBuffer &appendGloballyUniqueId(StringBuffer &s)
  2750. {
  2751. string uid = createUniqueIdString();
  2752. return s.append(uid.c_str());
  2753. }
  2754. extern jlib_decl void UseSysLogForOperatorMessages(bool use)
  2755. {
  2756. static ILogMsgHandler *msgHandler=NULL;
  2757. if (use==(msgHandler!=NULL))
  2758. return;
  2759. if (use) {
  2760. msgHandler = getSysLogMsgHandler();
  2761. ILogMsgFilter * operatorFilter = getCategoryLogMsgFilter(MSGAUD_operator, MSGCLS_all, DefaultDetail, true);
  2762. queryLogMsgManager()->addMonitorOwn(msgHandler, operatorFilter);
  2763. }
  2764. else {
  2765. queryLogMsgManager()->removeMonitor(msgHandler);
  2766. msgHandler = NULL;
  2767. }
  2768. }
  2769. extern jlib_decl void AuditSystemAccess(const char *userid, bool success, char const * msg,...)
  2770. {
  2771. va_list args;
  2772. va_start(args, msg);
  2773. VStringBuffer s("User %s: ", userid);
  2774. SYSLOG((success) ? AUDIT_TYPE_ACCESS_SUCCESS : AUDIT_TYPE_ACCESS_FAILURE, s.valist_appendf(msg, args).str());
  2775. va_end(args);
  2776. }
  2777. //--------------------------------------------------------------
  2778. class jlib_decl CComponentLogFileCreator : implements IComponentLogFileCreator, public CInterface
  2779. {
  2780. private:
  2781. StringBuffer component;
  2782. //filename parts
  2783. StringBuffer prefix;
  2784. StringBuffer name;
  2785. StringBuffer postfix;
  2786. StringBuffer extension;
  2787. StringBuffer fullFileSpec;
  2788. bool createAlias;
  2789. StringBuffer aliasName;
  2790. StringBuffer logDirSubdir;
  2791. bool rolling;
  2792. //ILogMsgHandler fields
  2793. bool append;
  2794. bool flushes;
  2795. unsigned msgFields;
  2796. //ILogMsgFilter fields
  2797. unsigned msgAudiences;
  2798. unsigned msgClasses;
  2799. LogMsgDetail maxDetail;
  2800. bool local;
  2801. //available after logging started
  2802. StringBuffer logDir; //access via queryLogDir()
  2803. StringBuffer aliasFileSpec; //access via queryAliasFileSpec()
  2804. StringBuffer expandedLogSpec;//access via queryLogFileSpec()
  2805. long maxLogFileSize = 0;
  2806. private:
  2807. void setDefaults()
  2808. {
  2809. rolling = true;
  2810. append = true;
  2811. flushes = true;
  2812. #ifdef _CONTAINERIZED
  2813. const char *logFields = nullptr;
  2814. #else
  2815. const char *logFields = queryEnvironmentConf().queryProp("logfields");
  2816. #endif
  2817. if (!isEmptyString(logFields))
  2818. msgFields = logMsgFieldsFromAbbrevs(logFields);
  2819. else
  2820. msgFields = MSGFIELD_STANDARD;
  2821. msgAudiences = MSGAUD_all;
  2822. msgClasses = MSGCLS_all;
  2823. maxDetail = DefaultDetail;
  2824. name.set(component); //logfile defaults to component name. Change via setName(), setPrefix() and setPostfix()
  2825. extension.set(".log");
  2826. local = false;
  2827. createAlias = true;
  2828. }
  2829. public:
  2830. IMPLEMENT_IINTERFACE;
  2831. CComponentLogFileCreator(IPropertyTree * _properties, const char *_component) : component(_component)
  2832. {
  2833. setDefaults();
  2834. if (_properties && !getConfigurationDirectory(_properties->queryPropTree("Directories"), "log", _component, _properties->queryProp("@name"), logDir))
  2835. _properties->getProp("@logDir", logDir);
  2836. }
  2837. CComponentLogFileCreator(const char *_logDir, const char *_component) : component(_component), logDir(_logDir)
  2838. {
  2839. setDefaults();
  2840. }
  2841. CComponentLogFileCreator(const char *_component) : component(_component)
  2842. {
  2843. setDefaults();
  2844. if (!getConfigurationDirectory(NULL, "log", _component, _component, logDir))
  2845. {
  2846. appendCurrentDirectory(logDir,false);
  2847. }
  2848. }
  2849. //set methods
  2850. void setExtension(const char * _ext) { extension.set(_ext); }
  2851. void setPrefix(const char * _prefix) { prefix.set(_prefix); }
  2852. void setName(const char * _name) { name.set(_name); }
  2853. void setCompleteFilespec(const char * _fs){fullFileSpec.set(_fs); setExtension(NULL); setRolling(false);}
  2854. void setPostfix(const char * _postfix) { postfix.set(_postfix); }
  2855. void setCreateAliasFile(bool _create) { createAlias = _create; }
  2856. void setAliasName(const char * _aliasName) { aliasName.set(_aliasName); }
  2857. void setLogDirSubdir(const char * _subdir) { logDirSubdir.set(_subdir); }
  2858. void setRolling(const bool _rolls) { rolling = _rolls; }
  2859. void setMaxLogFileSize( const long _size) { maxLogFileSize = _size; }
  2860. //ILogMsgHandler fields
  2861. void setAppend(const bool _append) { append = _append; }
  2862. void setFlushes(const bool _flushes) { flushes = _flushes; }
  2863. void setMsgFields(const unsigned _fields){ msgFields = _fields; }
  2864. //ILogMsgFilter fields
  2865. void setMsgAudiences(const unsigned _audiences){ msgAudiences = _audiences; }
  2866. void setMsgClasses(const unsigned _classes) { msgClasses = _classes; }
  2867. void setMaxDetail(const LogMsgDetail _maxDetail) { maxDetail = _maxDetail; }
  2868. void setLocal(const bool _local) { local = _local; }
  2869. //query methods (not valid until logging started)
  2870. const char * queryLogDir() const { return logDir.str(); }
  2871. const char * queryLogFileSpec() const { return expandedLogSpec.str(); }
  2872. const char * queryAliasFileSpec() const { return aliasFileSpec.str(); }
  2873. ILogMsgHandler * beginLogging()
  2874. {
  2875. //build directory path
  2876. StringBuffer logFileSpec;
  2877. if (!fullFileSpec.length())//user specify complete logfile specification?
  2878. {
  2879. if (!logDir.length())
  2880. {
  2881. appendCurrentDirectory(logDir,false).append(PATHSEPSTR).append("logs");
  2882. OWARNLOG("No logfile directory specified - logs will be written locally to %s", logDir.str());
  2883. }
  2884. makeAbsolutePath(logDir);
  2885. //build log file name (without date string or extension)
  2886. StringBuffer logFileName;
  2887. if (prefix.length())
  2888. logFileName.append(prefix).append(".");
  2889. logFileName.append(name);
  2890. if (postfix.length())
  2891. logFileName.append(".").append(postfix);
  2892. //build log file spec
  2893. if (logDirSubdir.length())
  2894. logDir.append(PATHSEPCHAR).append(logDirSubdir);//user specified subfolder
  2895. logFileSpec.append(logDir).append(PATHSEPCHAR).append(logFileName);
  2896. //build alias file spec
  2897. if (createAlias)
  2898. {
  2899. if (aliasName.length()==0)
  2900. aliasName.set(logFileName);
  2901. aliasFileSpec.append(logDir).append(PATHSEPCHAR).append(aliasName).append(extension);
  2902. }
  2903. }
  2904. else
  2905. makeAbsolutePath(fullFileSpec);
  2906. ILogMsgHandler * lmh;
  2907. if (rolling)
  2908. {
  2909. lmh = getRollingFileLogMsgHandler(logFileSpec.str(), extension, msgFields, append, flushes, NULL, aliasFileSpec.str(), true, maxLogFileSize);
  2910. }
  2911. else
  2912. {
  2913. StringBuffer lfs;
  2914. if (fullFileSpec.length())
  2915. lfs.set(fullFileSpec);
  2916. else
  2917. lfs.set(logFileSpec.append(extension).str());
  2918. lmh = getFileLogMsgHandler(lfs.str(), NULL, msgFields, false);
  2919. }
  2920. lmh->getLogName(expandedLogSpec);
  2921. queryLogMsgManager()->addMonitorOwn( lmh, getCategoryLogMsgFilter(msgAudiences, msgClasses, maxDetail, local));
  2922. return lmh;
  2923. }
  2924. };
  2925. IComponentLogFileCreator * createComponentLogFileCreator(IPropertyTree * _properties, const char *_component)
  2926. {
  2927. return new CComponentLogFileCreator(_properties, _component);
  2928. }
  2929. IComponentLogFileCreator * createComponentLogFileCreator(const char *_logDir, const char *_component)
  2930. {
  2931. return new CComponentLogFileCreator(_logDir, _component);
  2932. }
  2933. IComponentLogFileCreator * createComponentLogFileCreator(const char *_component)
  2934. {
  2935. return new CComponentLogFileCreator(_component);
  2936. }