jlog.cpp 98 KB

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