workunit.cpp 439 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569
  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 "jlib.hpp"
  14. #include "workunit.hpp"
  15. #include "jprop.hpp"
  16. #include "jmisc.hpp"
  17. #include "jexcept.hpp"
  18. #include "jiter.ipp"
  19. #include "jptree.hpp"
  20. #include "jtime.ipp"
  21. #include "jencrypt.hpp"
  22. #include "junicode.hpp"
  23. #include "jlzw.hpp"
  24. #include "jregexp.hpp"
  25. #include "eclrtl.hpp"
  26. #include "deftype.hpp"
  27. #include <time.h>
  28. #include "mpbase.hpp"
  29. #include "daclient.hpp"
  30. #include "dadfs.hpp"
  31. #include "dafdesc.hpp"
  32. #include "dasds.hpp"
  33. #include "danqs.hpp"
  34. #include "dautils.hpp"
  35. #include "dllserver.hpp"
  36. #include "thorplugin.hpp"
  37. #include "thorhelper.hpp"
  38. #include "workflow.hpp"
  39. #include "nbcd.hpp"
  40. #include "seclib.hpp"
  41. #include "wuerror.hpp"
  42. #include "wujobq.hpp"
  43. #include "environment.hpp"
  44. #include "workunit.ipp"
  45. #include "digisign.hpp"
  46. using namespace cryptohelper;
  47. static int workUnitTraceLevel = 1;
  48. static StringBuffer &getXPath(StringBuffer &wuRoot, const char *wuid)
  49. {
  50. // MORE - can fold in the date
  51. return wuRoot.append("/WorkUnits/").append(wuid);
  52. }
  53. //To be called by eclserver, but esp etc. won't know, so we need to store it.
  54. static StringBuffer & appendLibrarySuffix(StringBuffer & suffix)
  55. {
  56. #ifdef _WIN32
  57. suffix.append("W");
  58. #else
  59. suffix.append("L");
  60. #endif
  61. #ifdef __64BIT__
  62. suffix.append("64");
  63. #else
  64. suffix.append("32");
  65. #endif
  66. return suffix;
  67. }
  68. typedef MapStringTo<bool> UniqueScopes;
  69. static void wuAccessError(const char *username, const char *action, const char *wuscope, const char *wuid, bool excpt, bool log)
  70. {
  71. StringBuffer err;
  72. err.append("Workunit Access Denied - action: ").append(action).append(" user:").append(username ? username : "<Unknown>");
  73. if (wuid)
  74. err.append(" workunit:").append(wuid);
  75. if (wuscope)
  76. err.append(" scope:").append(wuscope);
  77. //MORE - we would need more information passed in from outside if we want to make the audit message format the same as from higher level ESP calls
  78. SYSLOG(AUDIT_TYPE_ACCESS_FAILURE, err.str());
  79. if (log)
  80. LOG(MCuserError, "%s", err.str());
  81. if (excpt)
  82. throw MakeStringException(WUERR_AccessError, "%s", err.str());
  83. }
  84. static bool checkWuScopeSecAccess(const char *wuscope, ISecManager *secmgr, ISecUser *secuser, int required, const char *action, bool excpt, bool log)
  85. {
  86. if (!secmgr || !secuser)
  87. return true;
  88. bool ret = secmgr->authorizeEx(RT_WORKUNIT_SCOPE, *secuser, wuscope)>=required;
  89. if (!ret && (log || excpt))
  90. wuAccessError(secuser->getName(), action, wuscope, NULL, excpt, log);
  91. return ret;
  92. }
  93. static bool checkWuScopeListSecAccess(const char *wuscope, ISecResourceList *scopes, int required, const char *action, bool excpt, bool log)
  94. {
  95. if (!scopes)
  96. return true;
  97. bool ret=true;
  98. if (wuscope)
  99. {
  100. Owned<ISecResource> res=scopes->getResource(wuscope);
  101. if (!res || res->getAccessFlags()<required)
  102. ret=false;
  103. }
  104. else
  105. {
  106. for (int seq=0; ret && seq<scopes->count(); seq++)
  107. {
  108. ISecResource *res=scopes->queryResource(seq);
  109. if (res && res->getAccessFlags()<required)
  110. return false;
  111. }
  112. }
  113. if (!ret && (log || excpt))
  114. wuAccessError(NULL, action, wuscope, NULL, excpt, log);
  115. return ret;
  116. }
  117. static bool checkWuSecAccess(IConstWorkUnit &cw, ISecManager *secmgr, ISecUser *secuser, int required, const char *action, bool excpt, bool log)
  118. {
  119. if (!secmgr || !secuser)
  120. return true;
  121. bool ret=secmgr->authorizeEx(RT_WORKUNIT_SCOPE, *secuser, cw.queryWuScope())>=required;
  122. if (!ret && (log || excpt))
  123. {
  124. wuAccessError(secuser->getName(), action, cw.queryWuScope(), cw.queryWuid(), excpt, log);
  125. }
  126. return ret;
  127. }
  128. static bool checkWuSecAccess(const char *wuid, ISecManager *secmgr, ISecUser *secuser, int required, const char *action, bool excpt, bool log)
  129. {
  130. if (!secmgr || !secuser)
  131. return true;
  132. Owned<IWorkUnitFactory> factory = getWorkUnitFactory();
  133. Owned<IConstWorkUnit> cw = factory->openWorkUnit(wuid);
  134. bool ret=secmgr->authorizeEx(RT_WORKUNIT_SCOPE, *secuser, cw->queryWuScope())>=required;
  135. if (!ret && (log || excpt))
  136. {
  137. wuAccessError(secuser->getName(), action, cw->queryWuScope(), cw->queryWuid(), excpt, log);
  138. }
  139. return ret;
  140. }
  141. void doDescheduleWorkkunit(char const * wuid)
  142. {
  143. StringBuffer xpath;
  144. xpath.append("*/*/*/");
  145. ncnameEscape(wuid, xpath);
  146. Owned<IRemoteConnection> conn = querySDS().connect("/Schedule", myProcessSession(), RTM_LOCK_WRITE, SDS_LOCK_TIMEOUT);
  147. if(!conn) return;
  148. Owned<IPropertyTree> root = conn->getRoot();
  149. bool more;
  150. do more = root->removeProp(xpath.str()); while(more);
  151. }
  152. //======================================================
  153. /*
  154. * Graph progress support
  155. */
  156. CWuGraphStats::CWuGraphStats(IPropertyTree *_progress, StatisticCreatorType _creatorType, const char * _creator, unsigned wfid, const char * _rootScope, unsigned _id)
  157. : progress(_progress), creatorType(_creatorType), creator(_creator), id(_id)
  158. {
  159. StatsScopeId graphScopeId;
  160. verifyex(graphScopeId.setScopeText(_rootScope));
  161. if (wfid)
  162. {
  163. StatsScopeId rootScopeId(SSTworkflow,wfid);
  164. collector.setown(createStatisticsGatherer(_creatorType, _creator, rootScopeId));
  165. collector->beginScope(graphScopeId);
  166. }
  167. else
  168. {
  169. collector.setown(createStatisticsGatherer(_creatorType, _creator, graphScopeId));
  170. }
  171. }
  172. void CWuGraphStats::beforeDispose()
  173. {
  174. Owned<IStatisticCollection> stats = collector->getResult();
  175. MemoryBuffer compressed;
  176. {
  177. MemoryBuffer serialized;
  178. serializeStatisticCollection(serialized, stats);
  179. compressToBuffer(compressed, serialized.length(), serialized.toByteArray());
  180. }
  181. unsigned minActivity = 0;
  182. unsigned maxActivity = 0;
  183. stats->getMinMaxActivity(minActivity, maxActivity);
  184. StringBuffer tag;
  185. tag.append("sg").append(id);
  186. //Replace the particular subgraph statistics added by this creator
  187. StringBuffer qualified(tag);
  188. qualified.append("[@creator='").append(creator).append("']");
  189. progress->removeProp(qualified);
  190. IPropertyTree * subgraph = progress->addPropTree(tag);
  191. subgraph->setProp("@c", queryCreatorTypeName(creatorType));
  192. subgraph->setProp("@creator", creator);
  193. subgraph->setPropInt("@minActivity", minActivity);
  194. subgraph->setPropInt("@maxActivity", maxActivity);
  195. subgraph->setPropBin("Stats", compressed.length(), compressed.toByteArray());
  196. if (!progress->getPropBool("@stats", false))
  197. progress->setPropBool("@stats", true);
  198. }
  199. IStatisticGatherer & CWuGraphStats::queryStatsBuilder()
  200. {
  201. return *collector;
  202. }
  203. class CConstGraphProgress : public CInterface, implements IConstWUGraphProgress
  204. {
  205. public:
  206. IMPLEMENT_IINTERFACE;
  207. CConstGraphProgress(const char *_wuid, const char *_graphName, IPropertyTree *_progress) : wuid(_wuid), graphName(_graphName), progress(_progress)
  208. {
  209. if (!progress)
  210. progress.setown(createPTree());
  211. formatVersion = progress->getPropInt("@format", PROGRESS_FORMAT_V);
  212. }
  213. virtual IPropertyTree * getProgressTree()
  214. {
  215. if (progress->getPropBool("@stats"))
  216. return createProcessTreeFromStats(); // Should we cache that?
  217. return LINK(progress);
  218. }
  219. virtual unsigned queryFormatVersion()
  220. {
  221. return formatVersion;
  222. }
  223. protected:
  224. CConstGraphProgress(const char *_wuid, const char *_graphName) : wuid(_wuid), graphName(_graphName)
  225. {
  226. formatVersion = PROGRESS_FORMAT_V;
  227. }
  228. static void expandStats(IPropertyTree * target, IStatisticCollection & collection)
  229. {
  230. StringBuffer formattedValue;
  231. unsigned numStats = collection.getNumStatistics();
  232. for (unsigned i=0; i < numStats; i++)
  233. {
  234. StatisticKind kind;
  235. unsigned __int64 value;
  236. collection.getStatistic(kind, value, i);
  237. formatStatistic(formattedValue.clear(), value, kind);
  238. target->setProp(queryTreeTag(kind), formattedValue);
  239. }
  240. }
  241. void expandProcessTreeFromStats(IPropertyTree * rootTarget, IPropertyTree * target, IStatisticCollection * collection)
  242. {
  243. expandStats(target, *collection);
  244. StringBuffer scopeName;
  245. Owned<IStatisticCollectionIterator> activityIter = &collection->getScopes(NULL, false);
  246. ForEach(*activityIter)
  247. {
  248. IStatisticCollection & cur = activityIter->query();
  249. cur.getScope(scopeName.clear());
  250. const char * id = scopeName.str();
  251. const char * tag;
  252. IPropertyTree * curTarget = target;
  253. switch (cur.queryScopeType())
  254. {
  255. case SSTedge:
  256. tag = "edge";
  257. id += strlen(EdgeScopePrefix);
  258. break;
  259. case SSTactivity:
  260. tag = "node";
  261. id += strlen(ActivityScopePrefix);
  262. break;
  263. case SSTsubgraph:
  264. //All subgraphs are added a root elements in the progress tree
  265. curTarget = rootTarget;
  266. tag = "node";
  267. id += strlen(SubGraphScopePrefix);
  268. break;
  269. case SSTchildgraph:
  270. case SSTworkflow:
  271. case SSTgraph:
  272. // SSTworkflow and SSTgraph may be safely ignored. They are not required to produce the statistics.
  273. continue;
  274. case SSTfunction:
  275. //MORE:Should function scopes be included in the graph scope somehow, and if so how?
  276. continue;
  277. default:
  278. throwUnexpected();
  279. }
  280. IPropertyTree * next = curTarget->addPropTree(tag);
  281. next->setProp("@id", id);
  282. expandProcessTreeFromStats(rootTarget, next, &cur);
  283. }
  284. }
  285. IPropertyTree * createProcessTreeFromStats()
  286. {
  287. MemoryBuffer compressed;
  288. MemoryBuffer serialized;
  289. Owned<IPropertyTree> progressTree = createPTree();
  290. Owned<IPropertyTreeIterator> iter = progress->getElements("sg*");
  291. ForEach(*iter)
  292. {
  293. IPropertyTree & curSubGraph = iter->query();
  294. curSubGraph.getPropBin("Stats", compressed.clear());
  295. //Protect against updates that delete the stats while we are iterating
  296. if (compressed.length())
  297. {
  298. decompressToBuffer(serialized.clear(), compressed);
  299. Owned<IStatisticCollection> collection = createStatisticCollection(serialized);
  300. expandProcessTreeFromStats(progressTree, progressTree, collection);
  301. }
  302. }
  303. return progressTree.getClear();
  304. }
  305. protected:
  306. Linked<IPropertyTree> progress;
  307. StringAttr wuid, graphName;
  308. unsigned formatVersion;
  309. };
  310. extern WORKUNIT_API IConstWUGraphProgress *createConstGraphProgress(const char *_wuid, const char *_graphName, IPropertyTree *_progress)
  311. {
  312. return new CConstGraphProgress(_wuid, _graphName, _progress);
  313. }
  314. //--------------------------------------------------------------------------------------------------------------------
  315. /*
  316. * Create a user friendly description a scope/stats combination. Only currently used for elapsed time for root subgraphs
  317. */
  318. static void createDefaultDescription(StringBuffer & description, StatisticKind kind, StatisticScopeType scopeType, const char * scope)
  319. {
  320. switch (kind)
  321. {
  322. case StTimeElapsed:
  323. {
  324. if (scopeType != SSTsubgraph)
  325. break;
  326. //Create a default description for a root subgraph
  327. const char * colon = strchr(scope, ':');
  328. if (!colon)
  329. break;
  330. const char * subgraph = colon+1;
  331. //Check for nested subgraph
  332. if (strchr(subgraph, ':'))
  333. break;
  334. assertex(strncmp(subgraph, SubGraphScopePrefix, strlen(SubGraphScopePrefix)) == 0);
  335. StringAttr graphname;
  336. graphname.set(scope, colon - scope);
  337. unsigned subId = atoi(subgraph + strlen(SubGraphScopePrefix));
  338. formatGraphTimerLabel(description, graphname, 0, subId);
  339. return;
  340. }
  341. }
  342. describeScope(description, scope);
  343. }
  344. /* Represents a single statistic */
  345. class ExtractedStatistic : public CInterfaceOf<IConstWUStatistic>
  346. {
  347. public:
  348. virtual IStringVal & getDescription(IStringVal & str, bool createDefault) const
  349. {
  350. if (!description && createDefault)
  351. {
  352. StringBuffer desc;
  353. createDefaultDescription(desc, kind, scopeType, scope);
  354. str.set(desc);
  355. return str;
  356. }
  357. str.set(description);
  358. return str;
  359. }
  360. virtual IStringVal & getCreator(IStringVal & str) const
  361. {
  362. str.set(creator);
  363. return str;
  364. }
  365. virtual const char * queryScope() const
  366. {
  367. return scope;
  368. }
  369. virtual IStringVal & getFormattedValue(IStringVal & str) const
  370. {
  371. StringBuffer formatted;
  372. formatStatistic(formatted, value, measure);
  373. str.set(formatted);
  374. return str;
  375. }
  376. virtual StatisticMeasure getMeasure() const
  377. {
  378. return measure;
  379. }
  380. virtual StatisticKind getKind() const
  381. {
  382. return kind;
  383. }
  384. virtual StatisticCreatorType getCreatorType() const
  385. {
  386. return creatorType;
  387. }
  388. virtual StatisticScopeType getScopeType() const
  389. {
  390. return scopeType;
  391. }
  392. virtual unsigned __int64 getValue() const
  393. {
  394. return value;
  395. }
  396. virtual unsigned __int64 getCount() const
  397. {
  398. return count;
  399. }
  400. virtual unsigned __int64 getMax() const
  401. {
  402. return max;
  403. }
  404. virtual unsigned __int64 getTimestamp() const
  405. {
  406. return timeStamp;
  407. }
  408. public:
  409. StringBuffer creator;
  410. StringBuffer description;
  411. StringBuffer scope;
  412. StatisticMeasure measure;
  413. StatisticKind kind;
  414. StatisticCreatorType creatorType;
  415. StatisticScopeType scopeType;
  416. unsigned __int64 value;
  417. unsigned __int64 count;
  418. unsigned __int64 max;
  419. unsigned __int64 timeStamp;
  420. };
  421. //---------------------------------------------------------------------------------------------------------------------
  422. /*
  423. * The following compare functions are used to ensure that comparison are consistent with
  424. * compareScopeName() in jstats. This ensures that the scope iterators from different sources
  425. * are processed in a consistent order
  426. */
  427. static int compareGraphNode(IInterface * const *ll, IInterface * const *rr)
  428. {
  429. IPropertyTree *l = (IPropertyTree *) *ll;
  430. IPropertyTree *r = (IPropertyTree *) *rr;
  431. const char * lname = l->queryName();
  432. const char * rname = r->queryName();
  433. return compareScopeName(lname, rname);
  434. }
  435. static int compareSubGraphStatsNode(IInterface * const *ll, IInterface * const *rr)
  436. {
  437. IPropertyTree *l = (IPropertyTree *) *ll;
  438. IPropertyTree *r = (IPropertyTree *) *rr;
  439. return compareScopeName(l->queryName(), r->queryName());
  440. }
  441. static int compareSubGraphNode(IInterface * const *ll, IInterface * const *rr)
  442. {
  443. IPropertyTree *l = (IPropertyTree *) *ll;
  444. IPropertyTree *r = (IPropertyTree *) *rr;
  445. return l->getPropInt("@id") - r->getPropInt("@id");
  446. }
  447. static int compareActivityNode(IInterface * const *ll, IInterface * const *rr)
  448. {
  449. IPropertyTree *l = (IPropertyTree *) *ll;
  450. IPropertyTree *r = (IPropertyTree *) *rr;
  451. return l->getPropInt("@id") - r->getPropInt("@id");
  452. }
  453. static int compareEdgeNode(IInterface * const *ll, IInterface * const *rr)
  454. {
  455. IPropertyTree *l = (IPropertyTree *) *ll;
  456. IPropertyTree *r = (IPropertyTree *) *rr;
  457. //MORE: Edge needs more work
  458. const char * leftId = l->queryProp("@id");
  459. const char * rightId = r->queryProp("@id");
  460. unsigned leftAc = atoi(leftId);
  461. unsigned rightAc = atoi(rightId);
  462. if (leftAc != rightAc)
  463. return (int)(leftAc - rightAc);
  464. const char * leftSep = strchr(leftId, '_');
  465. const char * rightSep = strchr(rightId, '_');
  466. assertex(leftSep && rightSep);
  467. return atoi(leftSep+1) - atoi(rightSep+1);
  468. }
  469. //---------------------------------------------------------------------------------------------------------------------
  470. /*
  471. * A class for implementing a scope iterator that walks through graph progress information
  472. */
  473. class CConstGraphProgressScopeIterator : public CInterfaceOf<IConstWUScopeIterator>
  474. {
  475. public:
  476. CConstGraphProgressScopeIterator(const char * wuid, const ScopeFilter & _filter, __uint64 _minVersion) : filter(_filter), minVersion(_minVersion)
  477. {
  478. //Examine the filter, and determine if we only need to look at a single graph/subgraph
  479. StringAttr singleGraph;
  480. const StringArray & scopesToMatch = filter.queryScopes();
  481. if (scopesToMatch)
  482. {
  483. bool seenGraph = false;
  484. bool seenSubGraph = false;
  485. ForEachItemIn(iScope, scopesToMatch)
  486. {
  487. StringArray ids;
  488. ids.appendList(scopesToMatch.item(iScope), ":");
  489. ForEachItemIn(i, ids)
  490. {
  491. const char * curId = ids.item(i);
  492. StatsScopeId id(curId);
  493. switch (id.queryScopeType())
  494. {
  495. case SSTgraph:
  496. if (seenGraph)
  497. {
  498. if (singleGraph && !streq(singleGraph, curId))
  499. singleGraph.clear();
  500. }
  501. else
  502. {
  503. if (!id.isWildcard())
  504. singleGraph.set(curId);
  505. seenGraph = true;
  506. }
  507. break;
  508. case SSTsubgraph:
  509. if (seenSubGraph)
  510. {
  511. if (singleSubGraph && !streq(singleSubGraph, curId))
  512. singleSubGraph.clear();
  513. }
  514. else
  515. {
  516. if (!id.isWildcard())
  517. singleSubGraph.set(curId);
  518. seenSubGraph = true;
  519. }
  520. break;
  521. }
  522. }
  523. }
  524. }
  525. rootPath.append("/GraphProgress/").append(wuid).append('/');
  526. if (singleGraph)
  527. rootPath.append(singleGraph).append("/");
  528. //Don't lock the statistics while we iterate - any partial updates must not cause problems
  529. if (daliClientActive())
  530. conn.setown(querySDS().connect(rootPath.str(), myProcessSession(), RTM_NONE, SDS_LOCK_TIMEOUT));
  531. if (conn && !singleGraph)
  532. {
  533. graphIter.setown(conn->queryRoot()->getElements("*"));
  534. graphIter.setown(createSortedIterator(*graphIter, compareGraphNode));
  535. }
  536. valid = false;
  537. }
  538. IMPLEMENT_IINTERFACE_USING(CInterfaceOf<IConstWUScopeIterator>)
  539. virtual bool first()
  540. {
  541. valid = false;
  542. if (!conn)
  543. return false;
  544. if (graphIter && !graphIter->first())
  545. return false;
  546. if (!firstSubGraph())
  547. {
  548. if (!nextGraph())
  549. return false;
  550. }
  551. valid = true;
  552. return true;
  553. }
  554. virtual bool next()
  555. {
  556. if (!nextChildScope())
  557. {
  558. if (!nextSubGraph())
  559. {
  560. if (!nextGraph())
  561. {
  562. valid = false;
  563. return false;
  564. }
  565. }
  566. }
  567. return true;
  568. }
  569. virtual bool nextSibling() override
  570. {
  571. if (collections.ordinality() == 0)
  572. return false;
  573. assertex(childIterators.ordinality() < collections.ordinality());
  574. collections.pop();
  575. //next will call childIterator.next() - walking the next sibling
  576. return next();
  577. }
  578. virtual bool nextParent() override
  579. {
  580. if (collections.ordinality() == 0)
  581. return false;
  582. assertex(childIterators.ordinality() < collections.ordinality());
  583. collections.pop();
  584. if (collections.ordinality() == 0)
  585. return false;
  586. //Finish with this node - so next will move onto the sibling of the parent node.
  587. finishCollection();
  588. return next();
  589. }
  590. virtual bool isValid()
  591. {
  592. return valid;
  593. }
  594. protected:
  595. bool firstSubGraph()
  596. {
  597. IPropertyTree & graphNode = graphIter ? graphIter->query() : *conn->queryRoot();
  598. const char * xpath = "sg*";
  599. StringBuffer childXpath;
  600. if (singleSubGraph)
  601. {
  602. childXpath.append(singleSubGraph);
  603. xpath = childXpath.str();
  604. }
  605. subgraphIter.setown(graphNode.getElements(xpath));
  606. if (subgraphIter)
  607. {
  608. if (!singleSubGraph)
  609. subgraphIter.setown(createSortedIterator(*subgraphIter, compareSubGraphStatsNode));
  610. }
  611. else
  612. subgraphIter.setown(graphNode.getElements("sg0"));
  613. if (!subgraphIter->first())
  614. return false;
  615. if (firstStat())
  616. return true;
  617. return nextSubGraph();
  618. }
  619. bool nextSubGraph()
  620. {
  621. for (;;)
  622. {
  623. if (!subgraphIter->next())
  624. return false;
  625. if (firstStat())
  626. return true;
  627. }
  628. }
  629. bool nextGraph()
  630. {
  631. if (!graphIter)
  632. return false;
  633. for (;;)
  634. {
  635. if (!graphIter->next())
  636. return false;
  637. if (firstSubGraph())
  638. return true;
  639. }
  640. }
  641. bool firstStat()
  642. {
  643. IPropertyTree & curSubGraph = subgraphIter->query();
  644. if (!checkSubGraph())
  645. return false;
  646. curSubGraph.getPropBin("Stats", compressed.clear());
  647. //Don't crash on old format progress...
  648. if (compressed.length() == 0)
  649. return false;
  650. decompressToBuffer(serialized.clear(), compressed);
  651. Owned<IStatisticCollection> collection = createStatisticCollection(serialized);
  652. statsIterator.timeStamp = collection->queryWhenCreated();
  653. if (!beginCollection(*collection))
  654. return false;
  655. // When workflow is root element, it is just a container. Ignore the workflow element here
  656. // as WorkUnitStatisticsScopeIterator will produce workflow scope - don't want duplicates.
  657. // (Note: workflow element never contains stats).
  658. if (collections.tos().queryScopeType() == SSTworkflow)
  659. {
  660. if (!next())
  661. return false;
  662. }
  663. //The root element of a collection is a graph - but it is only there to nest the subgraphs in.
  664. //Do not iterate it as a separate element - unless it has some stats.
  665. IStatisticCollection & curCollection = collections.tos();
  666. if ((curCollection.queryScopeType() != SSTgraph) || (curCollection.getNumStatistics() != 0))
  667. return true;
  668. return next();
  669. }
  670. bool beginCollection(IStatisticCollection & collection)
  671. {
  672. collections.append(OLINK(collection));
  673. curScopeType = collection.queryScopeType();
  674. collection.getFullScope(curScopeName.clear());
  675. ScopeCompare result = filter.compare(curScopeName);
  676. if (result & SCequal)
  677. return true;
  678. //If this scope cannot be the parent of a match then discard it.
  679. if (!(result & SCparent))
  680. collections.pop();
  681. //walk the next element
  682. return nextChildScope();
  683. }
  684. bool nextChildScope()
  685. {
  686. for (;;)
  687. {
  688. if (collections.ordinality() == 0)
  689. return false;
  690. IStatisticCollection * curCollection = &collections.tos();
  691. if (childIterators.ordinality() < collections.ordinality())
  692. {
  693. ScopeCompare result = filter.compare(curScopeName);
  694. //Do not walk children scopes if it is unrelated
  695. if (result & SCparent)
  696. {
  697. //Start iterating the children for the current collection
  698. childIterators.append(curCollection->getScopes(NULL, true));
  699. if (!childIterators.tos().first())
  700. {
  701. finishCollection();
  702. continue;
  703. }
  704. }
  705. else
  706. {
  707. //Don't walk the child scopes
  708. collections.pop();
  709. continue;
  710. }
  711. }
  712. else if (!childIterators.tos().next())
  713. {
  714. finishCollection();
  715. continue;
  716. }
  717. if (beginCollection(childIterators.tos().query()))
  718. return true;
  719. }
  720. }
  721. void finishCollection()
  722. {
  723. collections.pop();
  724. childIterators.pop();
  725. }
  726. bool checkSubGraph()
  727. {
  728. IPropertyTree & curSubGraph = subgraphIter->query();
  729. StatisticCreatorType creatorType = queryCreatorType(curSubGraph.queryProp("@c"), SCTnone);
  730. const char * creator = curSubGraph.queryProp("@creator");
  731. //MORE: Check minVersion and allow early filtering
  732. //MORE: Potentially filter by creator type??
  733. // if (!filter->matches(creatorType, creator, SSTall, NULL, SMeasureAll, StKindAll, AnyStatisticValue))
  734. // return false;
  735. statsIterator.creatorType = creatorType;
  736. statsIterator.creator.set(creator);
  737. return true;
  738. }
  739. virtual void playProperties(IWuScopeVisitor & visitor, WuPropertyTypes whichProperties) override
  740. {
  741. if ((whichProperties & PTstatistics))
  742. {
  743. /*
  744. MORE: Code from the statsIterator class should be inlined here - code will be much simpler
  745. but it currently needs an implementation of the IConstWUStatistic 3rd parameter
  746. IStatisticCollection & collection = collections.tos();
  747. ForEachItemIn(i, collection)
  748. {
  749. StatisticKind kind;
  750. unsigned __int64 value;
  751. collection->getStatistic(kind, value, i);
  752. visitor.noteStatistic(kind, value, *this);
  753. }
  754. */
  755. statsIterator.reset(curScopeName, curScopeType, collections.tos());
  756. ForEach(statsIterator)
  757. statsIterator.play(visitor);
  758. }
  759. }
  760. virtual bool getStat(StatisticKind kind, unsigned __int64 & value) const override
  761. {
  762. return collections.tos().getStatistic(kind, value);
  763. }
  764. virtual const char * queryAttribute(WuAttr attr, StringBuffer & scratchpad) const override
  765. {
  766. return nullptr;
  767. }
  768. virtual const char * queryHint(const char * kind) const override
  769. {
  770. return nullptr;
  771. }
  772. virtual const char * queryScope() const override
  773. {
  774. return curScopeName;
  775. }
  776. virtual StatisticScopeType getScopeType() const override
  777. {
  778. return curScopeType;
  779. }
  780. private:
  781. class ScopeStatisticsIterator : public CInterfaceOf<IConstWUStatistic>
  782. {
  783. friend class CConstGraphProgressScopeIterator; // cleaner if this was removed + setScope() functions added.
  784. public:
  785. void reset(const char * _scopeName, StatisticScopeType _scopeType, IStatisticCollection & _collection)
  786. {
  787. scope.set(_scopeName);
  788. scopeType = _scopeType;
  789. collection = &_collection;
  790. numStats = collection->getNumStatistics();
  791. }
  792. // interface IConstWUStatisticIterator
  793. IConstWUStatistic & query()
  794. {
  795. return *this;
  796. }
  797. bool first()
  798. {
  799. curStatIndex = 0;
  800. if (curStatIndex >= numStats)
  801. return false;
  802. collection->getStatistic(kind, value, curStatIndex);
  803. //MORE: Allow filtering:
  804. /*
  805. * if (filter && !filter->matches(SCTall, NULL, SSTall, NULL, queryMeasure(kind), kind, value))
  806. continue;
  807. */
  808. return true;
  809. }
  810. bool next()
  811. {
  812. for (;;)
  813. {
  814. ++curStatIndex;
  815. if (curStatIndex >= numStats)
  816. return false;
  817. collection->getStatistic(kind, value, curStatIndex);
  818. //MORE: Allow stats filtering
  819. return true;
  820. }
  821. }
  822. bool isValid()
  823. {
  824. return curStatIndex < numStats;
  825. }
  826. //interface IConstWUStatistic
  827. virtual IStringVal & getDescription(IStringVal & str, bool createDefault) const override
  828. {
  829. if (createDefault)
  830. {
  831. StringBuffer description;
  832. createDefaultDescription(description, kind, scopeType, scope);
  833. str.set(description);
  834. }
  835. return str;
  836. }
  837. virtual IStringVal & getCreator(IStringVal & str) const override
  838. {
  839. str.set(creator);
  840. return str;
  841. }
  842. virtual const char * queryScope() const override
  843. {
  844. return scope;
  845. }
  846. virtual IStringVal & getFormattedValue(IStringVal & str) const override
  847. {
  848. StringBuffer formatted;
  849. formatStatistic(formatted, value, kind);
  850. str.set(formatted);
  851. return str;
  852. }
  853. virtual StatisticMeasure getMeasure() const override
  854. {
  855. return queryMeasure(kind);
  856. }
  857. virtual StatisticKind getKind() const override
  858. {
  859. return kind;
  860. }
  861. virtual StatisticCreatorType getCreatorType() const override
  862. {
  863. return creatorType;
  864. }
  865. virtual StatisticScopeType getScopeType() const override
  866. {
  867. return scopeType;
  868. }
  869. virtual unsigned __int64 getValue() const override
  870. {
  871. return value;
  872. }
  873. virtual unsigned __int64 getCount() const override
  874. {
  875. return 1;
  876. }
  877. virtual unsigned __int64 getMax() const override
  878. {
  879. return 0;
  880. }
  881. virtual unsigned __int64 getTimestamp() const override
  882. {
  883. return timeStamp;
  884. }
  885. void play(IWuScopeVisitor & visitor)
  886. {
  887. visitor.noteStatistic(kind, value, *this);
  888. }
  889. protected:
  890. IStatisticCollection * collection = nullptr;
  891. StringBuffer creator;
  892. StringBuffer scope;
  893. StatisticKind kind;
  894. StatisticCreatorType creatorType;
  895. StatisticScopeType scopeType;
  896. unsigned __int64 value = 0;
  897. unsigned __int64 timeStamp;
  898. unsigned curStatIndex = 0;
  899. unsigned numStats = 0;
  900. } statsIterator;
  901. Owned<IRemoteConnection> conn;
  902. StringBuffer curScopeName;
  903. StatisticScopeType curScopeType = SSTnone;
  904. __uint64 minVersion;
  905. const ScopeFilter & filter;
  906. StringBuffer rootPath;
  907. StringAttr singleSubGraph;
  908. Owned<IPropertyTreeIterator> graphIter;
  909. Owned<IPropertyTreeIterator> subgraphIter;
  910. IArrayOf<IStatisticCollection> collections;
  911. IArrayOf<IStatisticCollectionIterator> childIterators; // Iterator(n) through collections(n) - created once iterating children
  912. MemoryBuffer compressed;
  913. MemoryBuffer serialized;
  914. bool valid;
  915. };
  916. int compareStatisticScopes(IConstWUStatistic & left, IConstWUStatistic & right)
  917. {
  918. return compareScopeName(left.queryScope(), right.queryScope());
  919. }
  920. int compareStatisticScopes(IInterface * const * left, IInterface * const * right)
  921. {
  922. return compareStatisticScopes(*static_cast<IConstWUStatistic *>(*left), *static_cast<IConstWUStatistic *>(*right));
  923. }
  924. /*
  925. * An implementation of IConstWUScopeIterator for global workunit statistics.
  926. */
  927. class WorkUnitStatisticsScopeIterator : public CInterfaceOf<IConstWUScopeIterator>
  928. {
  929. public:
  930. WorkUnitStatisticsScopeIterator(const IArrayOf<IConstWUStatistic> & _statistics, const ScopeFilter & _filter)
  931. {
  932. ForEachItemIn(i, _statistics)
  933. {
  934. IConstWUStatistic & cur = _statistics.item(i);
  935. if (_filter.compare(cur.queryScope()) & SCequal)
  936. statistics.append(OLINK(cur));
  937. }
  938. statistics.sort(compareStatisticScopes);
  939. }
  940. virtual bool first() override
  941. {
  942. curIndex = 0;
  943. return initScope();
  944. }
  945. virtual bool next() override
  946. {
  947. curIndex += numStatistics;
  948. return initScope();
  949. }
  950. virtual bool nextSibling() override
  951. {
  952. //Search until the current scope is not a child of the previous scope
  953. StringBuffer savedScope(queryScope());
  954. for (;;)
  955. {
  956. if (!next())
  957. return false;
  958. if (compareScopes(queryScope(), savedScope) != SCchild)
  959. return true;
  960. }
  961. }
  962. virtual bool nextParent() override
  963. {
  964. //Search until the current scope is not a child of the previous parent scope
  965. StringBuffer parentScope;
  966. if (getParentScope(parentScope, queryScope()))
  967. {
  968. for (;;)
  969. {
  970. if (!next())
  971. return false;
  972. if (compareScopes(queryScope(), parentScope) != SCchild)
  973. return true;
  974. }
  975. }
  976. else
  977. {
  978. finish();
  979. return false;
  980. }
  981. }
  982. virtual bool isValid() override
  983. {
  984. return statistics.isItem(curIndex);
  985. }
  986. virtual const char * queryScope() const override
  987. {
  988. return statistics.item(curIndex).queryScope();
  989. }
  990. virtual StatisticScopeType getScopeType() const override
  991. {
  992. return statistics.item(curIndex).getScopeType();
  993. }
  994. virtual void playProperties(IWuScopeVisitor & visitor, WuPropertyTypes whichProperties) override
  995. {
  996. if (whichProperties & PTstatistics)
  997. {
  998. for (unsigned i=0; i < numStatistics; i++)
  999. {
  1000. IConstWUStatistic & cur = statistics.item(curIndex + i);
  1001. visitor.noteStatistic(cur.getKind(), cur.getValue(), cur);
  1002. }
  1003. }
  1004. }
  1005. virtual bool getStat(StatisticKind kind, unsigned __int64 & value) const override
  1006. {
  1007. for (unsigned i=0; i < numStatistics; i++)
  1008. {
  1009. IConstWUStatistic & cur = statistics.item(curIndex + i);
  1010. if (cur.getKind() == kind)
  1011. {
  1012. value = cur.getValue();
  1013. return true;
  1014. }
  1015. }
  1016. return false;
  1017. }
  1018. virtual const char * queryAttribute(WuAttr attr, StringBuffer & scratchpad) const override
  1019. {
  1020. return nullptr;
  1021. }
  1022. virtual const char * queryHint(const char * kind) const
  1023. {
  1024. return nullptr;
  1025. }
  1026. protected:
  1027. inline IConstWUStatistic & queryStatistic(unsigned i)
  1028. {
  1029. return statistics.item(curIndex + i);
  1030. }
  1031. bool initScope()
  1032. {
  1033. if (!statistics.isItem(curIndex))
  1034. return false;
  1035. unsigned next = curIndex+1;
  1036. while (next < statistics.ordinality())
  1037. {
  1038. if (compareStatisticScopes(statistics.item(curIndex), statistics.item(next)) != 0)
  1039. break;
  1040. next++;
  1041. }
  1042. numStatistics = (next - curIndex);
  1043. return true;
  1044. }
  1045. void finish()
  1046. {
  1047. curIndex = statistics.ordinality();
  1048. }
  1049. protected:
  1050. IArrayOf<IConstWUStatistic> statistics;
  1051. unsigned curIndex = 0;
  1052. unsigned numStatistics = 1;
  1053. };
  1054. /*
  1055. * An implementation of IConstWUScopeIterator for the query graphs.
  1056. */
  1057. class GraphScopeIterator : public CInterfaceOf<IConstWUScopeIterator>
  1058. {
  1059. private:
  1060. //This uses a state machine - this enumeration contains the different states.
  1061. enum State
  1062. {
  1063. //Following are the states which represent valid scopes
  1064. SGraph,
  1065. SChildGraph,
  1066. SSubGraph,
  1067. SEdge,
  1068. SActivity,
  1069. //The following are internal states.
  1070. SGraphFirstEdge,
  1071. SGraphFirstSubGraph,
  1072. SGraphFirst,
  1073. SGraphEnd,
  1074. SGraphNext,
  1075. SSubGraphFirstEdge,
  1076. SSubGraphFirstActivity,
  1077. SSubGraphEnd,
  1078. SSubGraphNext,
  1079. SEdgeNext,
  1080. SEdgeEnd,
  1081. SActivityNext,
  1082. SActivityEnd,
  1083. SChildGraphFirstEdge,
  1084. SChildGraphFirstSubGraph,
  1085. SChildGraphFirst,
  1086. SChildGraphNext,
  1087. SChildGraphEnd,
  1088. SDone
  1089. };
  1090. State state = SDone;
  1091. State nextState = SDone;
  1092. public:
  1093. GraphScopeIterator(const IConstWorkUnit * wu, const ScopeFilter & _filter) : graphIter(&wu->getGraphs(GraphTypeAny)), filter(_filter)
  1094. {
  1095. }
  1096. virtual bool first() override
  1097. {
  1098. state = SGraphFirst;
  1099. return nextScope();
  1100. }
  1101. virtual bool next() override
  1102. {
  1103. if (!selectNext())
  1104. return false;
  1105. return nextScope();
  1106. }
  1107. virtual bool nextSibling() override
  1108. {
  1109. if (!selectNextSibling())
  1110. return false;
  1111. return nextScope();
  1112. }
  1113. virtual bool nextParent() override
  1114. {
  1115. if (!selectNextParent())
  1116. return false;
  1117. return nextScope();
  1118. }
  1119. virtual bool isValid() override
  1120. {
  1121. return graphIter->isValid();
  1122. }
  1123. virtual const char * queryScope() const override
  1124. {
  1125. return curScopeName.str();
  1126. }
  1127. virtual StatisticScopeType getScopeType() const override
  1128. {
  1129. return scopeType;
  1130. }
  1131. virtual void playProperties(IWuScopeVisitor & visitor, WuPropertyTypes whichProperties) override
  1132. {
  1133. switch (scopeType)
  1134. {
  1135. case SSTgraph:
  1136. return;
  1137. }
  1138. IPropertyTree & cur = treeIters.tos().query();
  1139. switch (scopeType)
  1140. {
  1141. case SSTgraph:
  1142. break;
  1143. case SSTsubgraph:
  1144. break;
  1145. case SSTactivity:
  1146. {
  1147. if (whichProperties & PTattributes)
  1148. {
  1149. playAttribute(visitor, WaLabel);
  1150. Owned<IPropertyTreeIterator> attrs = cur.getElements("att");
  1151. ForEach(*attrs)
  1152. {
  1153. IPropertyTree & cur = attrs->query();
  1154. WuAttr attr = queryGraphChildAttToWuAttr(cur.queryProp("@name"));
  1155. if (attr != WaNone)
  1156. visitor.noteAttribute(attr, cur.queryProp("@value"));
  1157. }
  1158. }
  1159. if (whichProperties & PThints)
  1160. {
  1161. Owned<IPropertyTreeIterator> hints = cur.getElements("hint");
  1162. ForEach(*hints)
  1163. {
  1164. IPropertyTree & cur = hints->query();
  1165. visitor.noteHint(cur.queryProp("@name"), cur.queryProp("@value"));
  1166. }
  1167. }
  1168. break;
  1169. }
  1170. case SSTedge:
  1171. if (whichProperties & PTattributes)
  1172. {
  1173. //MORE This will eventually need to walk the attributes and map the names.
  1174. //Need to be careful if they need to be mapped differently depending on the context.
  1175. playAttribute(visitor, WaLabel);
  1176. playAttribute(visitor, WaIdSource);
  1177. playAttribute(visitor, WaIdTarget);
  1178. playAttribute(visitor, WaSourceIndex);
  1179. playAttribute(visitor, WaTargetIndex);
  1180. playAttribute(visitor, WaIsDependency);
  1181. }
  1182. break;
  1183. }
  1184. }
  1185. virtual bool getStat(StatisticKind kind, unsigned __int64 & value) const override
  1186. {
  1187. return false;
  1188. }
  1189. virtual const char * queryAttribute(WuAttr attr, StringBuffer & scratchpad) const override
  1190. {
  1191. if (!treeIters.ordinality())
  1192. return nullptr;
  1193. //MORE - check that the attribute is value for the current scope type (to prevent defaults being returned)
  1194. return queryAttributeValue(treeIters.tos().query(), attr, scratchpad);
  1195. }
  1196. virtual const char * queryHint(const char * kind) const override
  1197. {
  1198. //MORE: Needs to be implemented!
  1199. return nullptr;
  1200. }
  1201. private:
  1202. void playAttribute(IWuScopeVisitor & visitor, WuAttr kind)
  1203. {
  1204. StringBuffer scratchpad;
  1205. const char * value = queryAttributeValue(treeIters.tos().query(), kind, scratchpad);
  1206. if (value)
  1207. visitor.noteAttribute(kind, value);
  1208. }
  1209. void pushIterator(IPropertyTreeIterator * iter, State state)
  1210. {
  1211. treeIters.append(*LINK(iter));
  1212. stateStack.append(state);
  1213. }
  1214. State popIterator()
  1215. {
  1216. treeIters.pop();
  1217. return (State)stateStack.popGet();
  1218. }
  1219. void pushScope(const char * id)
  1220. {
  1221. scopeLengths.append(curScopeName.length());
  1222. curScopeName.append(":").append(id);
  1223. }
  1224. void popScope()
  1225. {
  1226. curScopeName.setLength(scopeLengths.popGet());
  1227. }
  1228. bool doNextScope()
  1229. {
  1230. for(;;)
  1231. {
  1232. switch (state)
  1233. {
  1234. case SGraph:
  1235. {
  1236. IConstWUGraph & graph = graphIter->query();
  1237. unsigned wfid = graph.getWfid();
  1238. curScopeName.clear();
  1239. if (wfid != 0)
  1240. curScopeName.append(WorkflowScopePrefix).append(wfid).append(':');
  1241. graph.getName(StringBufferAdaptor(curScopeName));
  1242. scopeType = SSTgraph;
  1243. return true;
  1244. }
  1245. case SSubGraph:
  1246. scopeId.set(SubGraphScopePrefix).append(treeIters.tos().query().getPropInt("@id"));
  1247. pushScope(scopeId);
  1248. scopeType = SSTsubgraph;
  1249. return true;
  1250. case SEdge:
  1251. scopeId.set(EdgeScopePrefix).append(treeIters.tos().query().queryProp("@id"));
  1252. pushScope(scopeId);
  1253. scopeType = SSTedge;
  1254. return true;
  1255. case SActivity:
  1256. if (treeIters.tos().query().getPropInt("att[@name='_kind']/@value") == TAKsubgraph)
  1257. {
  1258. state = SActivityNext;
  1259. break;
  1260. }
  1261. scopeId.set(ActivityScopePrefix).append(treeIters.tos().query().getPropInt("@id"));
  1262. pushScope(scopeId);
  1263. scopeType = SSTactivity;
  1264. return true;
  1265. case SChildGraph:
  1266. {
  1267. unsigned numIters = treeIters.ordinality();
  1268. //This should really be implemented by a filter on the node - but it would require _kind/_parentActivity to move to the node tag
  1269. if (treeIters.tos().query().getPropInt("att[@name='_kind']/@value") != TAKsubgraph)
  1270. {
  1271. state = SChildGraphNext;
  1272. break;
  1273. }
  1274. unsigned parentActivityId = treeIters.item(numIters-2).query().getPropInt("@id");
  1275. unsigned parentId = treeIters.tos().query().getPropInt("att[@name='_parentActivity']/@value");
  1276. if (parentId != parentActivityId)
  1277. {
  1278. state = SChildGraphNext;
  1279. break;
  1280. }
  1281. scopeId.set(ChildGraphScopePrefix).append(treeIters.tos().query().getPropInt("@id"));
  1282. pushScope(scopeId);
  1283. scopeType = SSTchildgraph;
  1284. return true;
  1285. }
  1286. //Graph iteration
  1287. case SGraphFirst:
  1288. if (!graphIter->first())
  1289. state = SDone;
  1290. else
  1291. state = SGraph;
  1292. break;
  1293. case SGraphEnd:
  1294. state = SGraphNext;
  1295. break;
  1296. case SGraphNext:
  1297. if (!graphIter->next())
  1298. state = SDone;
  1299. else
  1300. state = SGraph;
  1301. break;
  1302. //Edge iteration
  1303. case SGraphFirstEdge:
  1304. {
  1305. //Walk dependencies - should possibly have a different SST e.g., SSTdependency since they do not
  1306. //share many characteristics with edges - e.g. no flowing records => few/no stats.
  1307. curGraph.setown(graphIter->query().getXGMMLTree(false));
  1308. Owned<IPropertyTreeIterator> treeIter = curGraph->getElements("edge");
  1309. if (treeIter && treeIter->first())
  1310. {
  1311. treeIter.setown(createSortedIterator(*treeIter, compareEdgeNode));
  1312. treeIter->first();
  1313. pushIterator(treeIter, SGraphFirstSubGraph);
  1314. state = SEdge;
  1315. }
  1316. else
  1317. state = SGraphFirstSubGraph;
  1318. break;
  1319. }
  1320. case SChildGraphFirstEdge:
  1321. {
  1322. Owned<IPropertyTreeIterator> treeIter = treeIters.tos().query().getElements("att/graph/edge");
  1323. if (treeIter && treeIter->first())
  1324. {
  1325. treeIter.setown(createSortedIterator(*treeIter, compareEdgeNode));
  1326. pushIterator(treeIter, SChildGraphFirstSubGraph);
  1327. state = SEdge;
  1328. }
  1329. else
  1330. state = SChildGraphFirstSubGraph;
  1331. break;
  1332. }
  1333. case SEdgeEnd:
  1334. popScope();
  1335. state = SEdgeNext;
  1336. break;
  1337. case SEdgeNext:
  1338. if (treeIters.tos().next())
  1339. state = SEdge;
  1340. else
  1341. state = popIterator();
  1342. break;
  1343. //Subgraph iteration
  1344. case SGraphFirstSubGraph:
  1345. {
  1346. Owned<IPropertyTreeIterator> treeIter = curGraph->getElements("node");
  1347. if (treeIter && treeIter->first())
  1348. {
  1349. treeIter.setown(createSortedIterator(*treeIter, compareSubGraphNode));
  1350. treeIter->first();
  1351. pushIterator(treeIter, SGraphNext);
  1352. state = SSubGraph;
  1353. }
  1354. else
  1355. state = SGraphNext;
  1356. break;
  1357. }
  1358. case SChildGraphFirstSubGraph:
  1359. {
  1360. Owned<IPropertyTreeIterator> treeIter = treeIters.tos().query().getElements("att/graph/node");
  1361. if (treeIter && treeIter->first())
  1362. {
  1363. treeIter.setown(createSortedIterator(*treeIter, compareSubGraphNode));
  1364. pushIterator(treeIter, SChildGraphEnd);
  1365. state = SSubGraph;
  1366. }
  1367. else
  1368. state = SChildGraphEnd;
  1369. break;
  1370. }
  1371. case SSubGraphFirstEdge:
  1372. {
  1373. Owned<IPropertyTreeIterator> treeIter = treeIters.tos().query().getElements("att/graph/edge");
  1374. if (treeIter && treeIter->first())
  1375. {
  1376. treeIter.setown(createSortedIterator(*treeIter, compareEdgeNode));
  1377. pushIterator(treeIter, SSubGraphFirstActivity);
  1378. state = SEdge;
  1379. }
  1380. else
  1381. state = SSubGraphFirstActivity;
  1382. break;
  1383. }
  1384. case SSubGraphFirstActivity:
  1385. {
  1386. Owned<IPropertyTreeIterator> treeIter = treeIters.tos().query().getElements("att/graph/node");
  1387. if (treeIter && treeIter->first())
  1388. {
  1389. treeIter.setown(createSortedIterator(*treeIter, compareActivityNode));
  1390. pushIterator(treeIter, SSubGraphEnd);
  1391. state = SActivity;
  1392. }
  1393. else
  1394. state = SSubGraphEnd;
  1395. break;
  1396. }
  1397. case SSubGraphEnd:
  1398. popScope();
  1399. state = SSubGraphNext;
  1400. break;
  1401. case SChildGraphEnd:
  1402. popScope();
  1403. state = SChildGraphNext;
  1404. break;
  1405. case SSubGraphNext:
  1406. if (treeIters.tos().next())
  1407. state = SSubGraph;
  1408. else
  1409. state = popIterator();
  1410. break;
  1411. case SActivityEnd:
  1412. popScope();
  1413. state = SActivityNext;
  1414. break;
  1415. case SActivityNext:
  1416. if (treeIters.tos().next())
  1417. state = SActivity;
  1418. else
  1419. state = popIterator();
  1420. break;
  1421. case SChildGraphNext:
  1422. if (treeIters.tos().next())
  1423. state = SChildGraph;
  1424. else
  1425. state = popIterator();
  1426. break;
  1427. case SChildGraphFirst:
  1428. {
  1429. unsigned numIters = treeIters.ordinality();
  1430. IPropertyTreeIterator & graphIter = treeIters.item(numIters-2);
  1431. Owned<IPropertyTreeIterator> treeIter = graphIter.query().getElements("att/graph/node");
  1432. //Really want to filter by <att name="_parentActivity" value="<parentid>">
  1433. if (treeIter && treeIter->first())
  1434. {
  1435. treeIter.setown(createSortedIterator(*treeIter, compareSubGraphNode));
  1436. pushIterator(treeIter, SActivityEnd);
  1437. state = SChildGraph;
  1438. }
  1439. else
  1440. state = SActivityEnd;
  1441. break;
  1442. }
  1443. case SDone:
  1444. return false;
  1445. default:
  1446. throwUnexpected();
  1447. }
  1448. }
  1449. }
  1450. bool nextScope()
  1451. {
  1452. for(;;)
  1453. {
  1454. if (!doNextScope())
  1455. return false;
  1456. ScopeCompare cmp = filter.compare(curScopeName);
  1457. if (cmp & SCequal)
  1458. return true;
  1459. //MORE: Optimize next based on result of compare
  1460. if (!selectNext())
  1461. return false;
  1462. }
  1463. }
  1464. bool selectNext()
  1465. {
  1466. switch (state)
  1467. {
  1468. case SGraph:
  1469. state = SGraphFirstEdge;
  1470. break;
  1471. case SChildGraph:
  1472. state = SChildGraphFirstEdge;
  1473. break;
  1474. case SSubGraph:
  1475. state = SSubGraphFirstEdge;
  1476. break;
  1477. case SEdge:
  1478. state = SEdgeEnd;
  1479. break;
  1480. case SActivity:
  1481. state = SChildGraphFirst;
  1482. break;
  1483. case SDone:
  1484. return false;
  1485. default:
  1486. throwUnexpected();
  1487. }
  1488. return true;
  1489. }
  1490. bool selectNextSibling()
  1491. {
  1492. switch (state)
  1493. {
  1494. case SGraph:
  1495. state = SGraphEnd;
  1496. break;
  1497. case SChildGraph:
  1498. state = SChildGraphEnd;
  1499. break;
  1500. case SSubGraph:
  1501. state = SSubGraphEnd;
  1502. break;
  1503. case SEdge:
  1504. state = SEdgeEnd;
  1505. break;
  1506. case SActivity:
  1507. state = SActivityEnd;
  1508. break;
  1509. case SDone:
  1510. return false;
  1511. default:
  1512. throwUnexpected();
  1513. }
  1514. return true;
  1515. }
  1516. bool selectNextParent()
  1517. {
  1518. switch (state)
  1519. {
  1520. case SGraph:
  1521. state = SDone;
  1522. break;
  1523. case SChildGraph:
  1524. case SSubGraph:
  1525. case SEdge:
  1526. case SActivity:
  1527. popScope();
  1528. state = popIterator();
  1529. break;
  1530. case SDone:
  1531. return false;
  1532. default:
  1533. throwUnexpected();
  1534. }
  1535. return true;
  1536. }
  1537. protected:
  1538. const ScopeFilter & filter;
  1539. Owned<IConstWUGraphIterator> graphIter;
  1540. Owned<IPropertyTree> curGraph;
  1541. IArrayOf<IPropertyTreeIterator> treeIters;
  1542. UnsignedArray scopeLengths;
  1543. UnsignedArray stateStack;
  1544. StringBuffer curScopeName;
  1545. StringBuffer scopeId;
  1546. StatisticScopeType scopeType = SSTnone;
  1547. };
  1548. static int compareWorkflow(IInterface * const * pLeft, IInterface * const * pRight)
  1549. {
  1550. IConstWorkflowItem * left = static_cast<IConstWorkflowItem *>(*pLeft);
  1551. IConstWorkflowItem * right = static_cast<IConstWorkflowItem *>(*pRight);
  1552. return left->queryWfid() - right->queryWfid();
  1553. }
  1554. static const char * trueToStr(bool value) { return value ? "true" : nullptr; }
  1555. /*
  1556. * An implementation of IConstWUScopeIterator for the workflow information.
  1557. */
  1558. class WorkflowStatisticsScopeIterator : public CInterfaceOf<IConstWUScopeIterator>
  1559. {
  1560. public:
  1561. WorkflowStatisticsScopeIterator(IConstWorkflowItemIterator * wfIter)
  1562. {
  1563. ForEach(*wfIter)
  1564. workflow.append(*LINK(wfIter->query()));
  1565. workflow.sort(compareWorkflow);
  1566. }
  1567. virtual bool first() override
  1568. {
  1569. if (workflow.empty())
  1570. return false;
  1571. curWorkflow = 0;
  1572. return initWorkflowItem();
  1573. }
  1574. virtual bool next() override
  1575. {
  1576. if (!workflow.isItem(++curWorkflow))
  1577. return false;
  1578. return initWorkflowItem();
  1579. }
  1580. virtual bool nextSibling() override
  1581. {
  1582. return next();
  1583. }
  1584. virtual bool nextParent() override
  1585. {
  1586. curWorkflow = NotFound;
  1587. return false;
  1588. }
  1589. virtual bool isValid() override
  1590. {
  1591. return workflow.isItem(curWorkflow);
  1592. }
  1593. virtual const char * queryScope() const override
  1594. {
  1595. return curScope.str();
  1596. }
  1597. virtual StatisticScopeType getScopeType() const override
  1598. {
  1599. return SSTworkflow;
  1600. }
  1601. virtual void playProperties(IWuScopeVisitor & visitor, WuPropertyTypes whichProperties) override
  1602. {
  1603. if (whichProperties & PTattributes)
  1604. {
  1605. {
  1606. StringBuffer scratchpad;
  1607. Owned<IWorkflowDependencyIterator> depends = workflow.item(curWorkflow).getDependencies();
  1608. ForEach(*depends)
  1609. visitor.noteAttribute(WaIdDependency, getValueText(depends->query(), scratchpad, WorkflowScopePrefix));
  1610. }
  1611. play(visitor, { WaIsScheduled, WaIdSuccess, WaIdFailure, WaIdRecovery, WaIdPersist, WaIdScheduled,
  1612. WaPersistName, WaLabel, WaMode, WaType, WaState, WaCluster, WaCriticalSection });
  1613. }
  1614. }
  1615. virtual bool getStat(StatisticKind kind, unsigned __int64 & value) const override
  1616. {
  1617. return false;
  1618. }
  1619. virtual const char * queryAttribute(WuAttr attr, StringBuffer & scratchpad) const override
  1620. {
  1621. auto wf = &workflow.item(curWorkflow);
  1622. StringBufferAdaptor adaptor(scratchpad);
  1623. switch (attr)
  1624. {
  1625. case WaIdDependencyList:
  1626. {
  1627. bool first = true;
  1628. Owned<IWorkflowDependencyIterator> depends = workflow.item(curWorkflow).getDependencies();
  1629. ForEach(*depends)
  1630. {
  1631. if (first)
  1632. scratchpad.append("[");
  1633. else
  1634. scratchpad.append(",");
  1635. scratchpad.append('"').append(WorkflowScopePrefix).append(depends->query()).append('"');
  1636. first = false;
  1637. }
  1638. if (first)
  1639. return nullptr;
  1640. scratchpad.append("]");
  1641. return scratchpad.str();
  1642. }
  1643. case WaIsScheduled: return trueToStr(wf->isScheduled());
  1644. case WaIdSuccess: return getWfidText(wf->querySuccess(), scratchpad);
  1645. case WaIdFailure: return getWfidText(wf->queryFailure(), scratchpad);
  1646. case WaIdRecovery: return getWfidText(wf->queryRecovery(), scratchpad);
  1647. case WaIdPersist: return getWfidText(wf->queryPersistWfid(), scratchpad);
  1648. case WaIdScheduled: return getWfidText(wf->queryScheduledWfid(), scratchpad);
  1649. case WaPersistName: return queryOptString(wf->getPersistName(adaptor));
  1650. case WaLabel: return queryOptString(wf->getLabel(adaptor));
  1651. case WaMode: return wf->queryMode() != WFModeNormal ? queryWorkflowModeText(wf->queryMode()) : nullptr;
  1652. case WaType: return wf->queryType() != WFTypeNormal ? queryWorkflowTypeText(wf->queryType()) : nullptr;
  1653. case WaState: return queryWorkflowStateText(wf->queryState());
  1654. case WaCluster: return queryOptString(wf->queryCluster(adaptor));
  1655. case WaCriticalSection: return queryOptString(wf->getCriticalName(adaptor));
  1656. /*
  1657. The followng attributes are not generated - I'm not convinced they are very useful, but they could be added later.
  1658. virtual bool isScheduledNow() const = 0;
  1659. virtual IWorkflowEvent * getScheduleEvent() const = 0;
  1660. virtual unsigned querySchedulePriority() const = 0;
  1661. virtual bool hasScheduleCount() const = 0;
  1662. virtual unsigned queryScheduleCount() const = 0;
  1663. virtual unsigned queryRetriesAllowed() const = 0;
  1664. virtual int queryPersistCopies() const = 0; // 0 - unmangled name, < 0 - use default, > 0 - max number
  1665. virtual bool queryPersistRefresh() const = 0;
  1666. virtual unsigned queryScheduleCountRemaining() const = 0;
  1667. virtual unsigned queryRetriesRemaining() const = 0;
  1668. virtual int queryFailCode() const = 0;
  1669. virtual const char * queryFailMessage() const = 0;
  1670. virtual const char * queryEventName() const = 0;
  1671. virtual const char * queryEventExtra() const = 0;
  1672. */
  1673. }
  1674. return nullptr;
  1675. }
  1676. virtual const char * queryHint(const char * kind) const
  1677. {
  1678. return nullptr;
  1679. }
  1680. protected:
  1681. bool initWorkflowItem()
  1682. {
  1683. curScope.clear().append(WorkflowScopePrefix).append(workflow.item(curWorkflow).queryWfid());
  1684. return true;
  1685. }
  1686. const char * getValueText(unsigned value, StringBuffer & scratchpad, const char * prefix = nullptr) const
  1687. {
  1688. return scratchpad.clear().append(prefix).append(value).str();
  1689. }
  1690. const char * queryOptString(IStringVal & value) const
  1691. {
  1692. const char * text = value.str();
  1693. if (!text || !*text)
  1694. return nullptr;
  1695. return text;
  1696. }
  1697. const char * getWfidText(unsigned value, StringBuffer & scratchpad) const
  1698. {
  1699. if (!value)
  1700. return nullptr;
  1701. return scratchpad.clear().append(WorkflowScopePrefix).append(value).str();
  1702. }
  1703. void play(IWuScopeVisitor & visitor, const std::initializer_list<WuAttr> & attrs) const
  1704. {
  1705. StringBuffer scratchpad;
  1706. for (auto attr : attrs)
  1707. {
  1708. const char * value = queryAttribute(attr, scratchpad.clear());
  1709. if (value)
  1710. visitor.noteAttribute(attr, value);
  1711. }
  1712. }
  1713. protected:
  1714. IArrayOf<IConstWorkflowItem> workflow;
  1715. unsigned curWorkflow = 0;
  1716. StringBuffer curScope;
  1717. };
  1718. /*
  1719. * An implementation of IConstWUScopeIterator that combines results from multiple sources.
  1720. */
  1721. class CompoundStatisticsScopeIterator : public CInterfaceOf<IConstWUScopeIterator>
  1722. {
  1723. class VisitorMapper : implements IWuScopeVisitor
  1724. {
  1725. public:
  1726. VisitorMapper(const WuScopeFilter & _filter, IWuScopeVisitor & _visitor) :
  1727. filter(_filter), visitor(_visitor)
  1728. {}
  1729. virtual void noteStatistic(StatisticKind kind, unsigned __int64 value, IConstWUStatistic & extra) override
  1730. {
  1731. if (filter.includeStatistic(kind))
  1732. visitor.noteStatistic(kind, value, extra);
  1733. }
  1734. virtual void noteAttribute(WuAttr attr, const char * value) override
  1735. {
  1736. if (filter.includeAttribute(attr))
  1737. visitor.noteAttribute(attr, value);
  1738. }
  1739. virtual void noteHint(const char * kind, const char * value) override
  1740. {
  1741. if (filter.includeHint(kind))
  1742. visitor.noteHint(kind, value);
  1743. }
  1744. protected:
  1745. const WuScopeFilter & filter;
  1746. IWuScopeVisitor & visitor;
  1747. };
  1748. public:
  1749. CompoundStatisticsScopeIterator(const WuScopeFilter & _filter) : filter(_filter)
  1750. {
  1751. }
  1752. void addIter(IConstWUScopeIterator * iter)
  1753. {
  1754. if (iter)
  1755. {
  1756. iters.append(OLINK(*iter));
  1757. assertex(iters.ordinality() <= sizeof(activeIterMask)*8);
  1758. }
  1759. }
  1760. virtual bool first() override
  1761. {
  1762. activeIterMask = 0;
  1763. ForEachItemIn(i, iters)
  1764. {
  1765. if (iters.item(i).first())
  1766. activeIterMask |= (1U << i);
  1767. }
  1768. return findNextScope();
  1769. }
  1770. virtual bool next() override
  1771. {
  1772. selectNext();
  1773. return findNextScope();
  1774. }
  1775. virtual bool nextSibling() override
  1776. {
  1777. selectNextSibling();
  1778. return findNextScope();
  1779. }
  1780. virtual bool nextParent() override
  1781. {
  1782. selectNextParent();
  1783. return findNextScope();
  1784. }
  1785. virtual bool isValid() override
  1786. {
  1787. return (activeIterMask != 0);
  1788. }
  1789. virtual const char * queryScope() const override
  1790. {
  1791. return iters.item(firstMatchIter).queryScope();
  1792. }
  1793. virtual StatisticScopeType getScopeType() const override
  1794. {
  1795. return iters.item(firstMatchIter).getScopeType();
  1796. }
  1797. virtual void playProperties(IWuScopeVisitor & visitor, WuPropertyTypes whichProperties) override
  1798. {
  1799. VisitorMapper mappedVisitor(filter, visitor);
  1800. whichProperties &= filter.properties;
  1801. ForEachItemIn(i, iters)
  1802. {
  1803. if (iterMatchesCurrentScope(i))
  1804. iters.item(i).playProperties(mappedVisitor, whichProperties);
  1805. }
  1806. }
  1807. virtual bool getStat(StatisticKind kind, unsigned __int64 & value) const override
  1808. {
  1809. ForEachItemIn(i, iters)
  1810. {
  1811. if (iterMatchesCurrentScope(i))
  1812. {
  1813. if (iters.item(i).getStat(kind, value))
  1814. return true;
  1815. }
  1816. }
  1817. return false;
  1818. }
  1819. virtual const char * queryAttribute(WuAttr attr, StringBuffer & scratchpad) const override
  1820. {
  1821. ForEachItemIn(i, iters)
  1822. {
  1823. if (iterMatchesCurrentScope(i))
  1824. {
  1825. const char * value = iters.item(i).queryAttribute(attr, scratchpad);
  1826. if (value)
  1827. return value;
  1828. }
  1829. }
  1830. return nullptr;
  1831. }
  1832. virtual const char * queryHint(const char * kind) const override
  1833. {
  1834. ForEachItemIn(i, iters)
  1835. {
  1836. if (iterMatchesCurrentScope(i))
  1837. {
  1838. const char * value = iters.item(i).queryHint(kind);
  1839. if (value)
  1840. return value;
  1841. }
  1842. }
  1843. return nullptr;
  1844. }
  1845. inline bool iterMatchesCurrentScope(unsigned i) const { return ((1U << i) & matchIterMask) != 0; }
  1846. inline bool isAlive(unsigned i) const { return ((1U << i) & activeIterMask) != 0; }
  1847. protected:
  1848. //Calculate which iterators contain the scope that should come next
  1849. bool findNextScope()
  1850. {
  1851. for(;;)
  1852. {
  1853. if (activeIterMask == 0)
  1854. return false;
  1855. unsigned mask = 0;
  1856. const char * scope = nullptr;
  1857. ForEachItemIn(i, iters)
  1858. {
  1859. if (isAlive(i))
  1860. {
  1861. const char * iterScope = iters.item(i).queryScope();
  1862. if (mask)
  1863. {
  1864. int compare = compareScopeName(scope, iterScope);
  1865. if (compare == 0)
  1866. {
  1867. mask |= (1U << i);
  1868. }
  1869. else if (compare > 0)
  1870. {
  1871. scope = iterScope;
  1872. mask = (1U << i);
  1873. firstMatchIter = i;
  1874. }
  1875. }
  1876. else
  1877. {
  1878. scope = iterScope;
  1879. mask = (1U << i);
  1880. firstMatchIter = i;
  1881. }
  1882. }
  1883. }
  1884. matchIterMask = mask;
  1885. while (activeScopes)
  1886. {
  1887. const char * activeScope = activeScopes.tos();
  1888. //If the next scope if not a child of one of the active scopes then that active scope will no longer match.
  1889. if (compareScopes(scope, activeScope) & SCchild)
  1890. break;
  1891. activeScopes.pop();
  1892. }
  1893. //The top most scope will be the deepest. Check if the current scope is close enough to return as a match.
  1894. bool include = false;
  1895. if (activeScopes)
  1896. {
  1897. const char * activeScope = activeScopes.tos();
  1898. //code above has ensured that this scope must be a child of (and therefore deeper) than activeScope
  1899. unsigned nesting = queryScopeDepth(scope) - queryScopeDepth(activeScope);
  1900. if (nesting <= filter.include.nestedDepth)
  1901. include = true;
  1902. }
  1903. //Check to see if this is a new match
  1904. if (filter.compareMatchScopes(scope) & SCequal)
  1905. {
  1906. if (!include)
  1907. include = filter.include.matchedScope;
  1908. //Only add it to the list of active scopes if it can match child elements
  1909. if (filter.include.nestedDepth != 0)
  1910. activeScopes.append(scope);
  1911. }
  1912. if (include)
  1913. {
  1914. if (!filter.includeScope(scope))
  1915. include = false;
  1916. else if (filter.requiredStats.size())
  1917. {
  1918. //MORE: This would be cleaner as a member of filter - but it needs access to the stats.
  1919. for (unsigned iReq=0; iReq < filter.requiredStats.size(); iReq++)
  1920. {
  1921. const StatisticValueFilter & cur = filter.requiredStats[iReq];
  1922. unsigned __int64 value;
  1923. if (getStat(cur.queryKind(), value))
  1924. {
  1925. if (!cur.matches(value))
  1926. include = false;
  1927. }
  1928. else
  1929. include = false;
  1930. }
  1931. }
  1932. }
  1933. if (include)
  1934. return true;
  1935. //MORE: Optimize based on filter.compareScope()
  1936. selectNext();
  1937. }
  1938. }
  1939. void checkScopeOrder(unsigned input, const char * prevScope)
  1940. {
  1941. if (isAlive(input))
  1942. {
  1943. const char * curScope = iters.item(input).queryScope();
  1944. int compare = compareScopeName(prevScope, curScope);
  1945. if (compare >= 0)
  1946. throw MakeStringException(0, "Out of order (%u) scopes %s,%s = %d", input, prevScope, curScope, compare);
  1947. }
  1948. }
  1949. void selectNext()
  1950. {
  1951. ForEachItemIn(i, iters)
  1952. {
  1953. if (iterMatchesCurrentScope(i))
  1954. {
  1955. #ifdef _DEBUG
  1956. StringBuffer prevScope(iters.item(i).queryScope());
  1957. #endif
  1958. if (!iters.item(i).next())
  1959. activeIterMask &= ~(1U << i);
  1960. #ifdef _DEBUG
  1961. checkScopeOrder(i, prevScope);
  1962. #endif
  1963. }
  1964. }
  1965. }
  1966. void selectNextSibling()
  1967. {
  1968. ForEachItemIn(i, iters)
  1969. {
  1970. if (iterMatchesCurrentScope(i))
  1971. {
  1972. #ifdef _DEBUG
  1973. StringBuffer prevScope(iters.item(i).queryScope());
  1974. #endif
  1975. if (!iters.item(i).nextSibling())
  1976. activeIterMask &= ~(1U << i);
  1977. #ifdef _DEBUG
  1978. checkScopeOrder(i, prevScope);
  1979. #endif
  1980. }
  1981. }
  1982. }
  1983. void selectNextParent()
  1984. {
  1985. ForEachItemIn(i, iters)
  1986. {
  1987. if (iterMatchesCurrentScope(i))
  1988. {
  1989. #ifdef _DEBUG
  1990. StringBuffer prevScope(iters.item(i).queryScope());
  1991. #endif
  1992. if (!iters.item(i).nextParent())
  1993. activeIterMask &= ~(1U << i);
  1994. #ifdef _DEBUG
  1995. checkScopeOrder(i, prevScope);
  1996. #endif
  1997. }
  1998. }
  1999. }
  2000. protected:
  2001. const WuScopeFilter & filter;
  2002. IArrayOf<IConstWUScopeIterator> iters;
  2003. unsigned curIter = 0;
  2004. unsigned firstMatchIter = 0;
  2005. unsigned matchIterMask = 0; // bit set of iterators which have a valid entry for the current scope
  2006. unsigned activeIterMask = 0; // bit set of iterators which are still active
  2007. StringArray activeScopes;
  2008. };
  2009. //---------------------------------------------------------------------------------------------------------------------
  2010. class AggregateFilter
  2011. {
  2012. public:
  2013. AggregateFilter(StatisticKind _search) : search(_search) {}
  2014. inline bool matches(StatisticKind kind, unsigned __int64 value, IConstWUStatistic & extra) const
  2015. {
  2016. return (kind == search);
  2017. }
  2018. protected:
  2019. StatisticKind search;
  2020. //MORE: Allow filtering by scope?
  2021. };
  2022. class StatisticAggregator : public CInterfaceOf<IWuScopeVisitor>
  2023. {
  2024. public:
  2025. StatisticAggregator(StatisticKind _search) : filter(_search) {}
  2026. virtual void noteAttribute(WuAttr attr, const char * value) override { throwUnexpected(); }
  2027. virtual void noteHint(const char * kind, const char * value) override { throwUnexpected(); }
  2028. protected:
  2029. AggregateFilter filter;
  2030. };
  2031. class SimpleAggregator : public StatisticAggregator
  2032. {
  2033. public:
  2034. SimpleAggregator(StatisticKind _search) : StatisticAggregator(_search) {}
  2035. virtual void noteStatistic(StatisticKind kind, unsigned __int64 value, IConstWUStatistic & extra) override
  2036. {
  2037. if (filter.matches(kind, value, extra))
  2038. summary.noteValue(value);
  2039. }
  2040. //How should these be reported? Should there be a playAggregates(IWuAggregatedScopeVisitor)
  2041. //with a noteAggregate(value, variant, value, grouping)?
  2042. protected:
  2043. StatsAggregation summary;
  2044. };
  2045. class SimpleReferenceAggregator : public StatisticAggregator
  2046. {
  2047. public:
  2048. SimpleReferenceAggregator(StatisticKind _search, StatsAggregation & _summary) : StatisticAggregator(_search), summary(_summary) {}
  2049. virtual void noteStatistic(StatisticKind kind, unsigned __int64 value, IConstWUStatistic & extra) override
  2050. {
  2051. if (filter.matches(kind, value, extra))
  2052. summary.noteValue(value);
  2053. }
  2054. //How should these be reported? Should there be a playAggregates(IWuAggregatedScopeVisitor)
  2055. //with a noteAggregate(value, variant, value, grouping)?
  2056. protected:
  2057. StatsAggregation & summary;
  2058. };
  2059. class GroupedAggregator : public StatisticAggregator
  2060. {
  2061. public:
  2062. virtual void noteStatistic(StatisticKind kind, unsigned __int64 value, IConstWUStatistic & extra) override
  2063. {
  2064. if (filter.matches(kind, value, extra))
  2065. {
  2066. StatsAggregation & match = summary; // look up in hash table.
  2067. match.noteValue(value);
  2068. }
  2069. }
  2070. protected:
  2071. //HashTable of (possible groupings->summary)
  2072. StatsAggregation summary;
  2073. };
  2074. class CompoundAggregator : implements StatisticAggregator
  2075. {
  2076. public:
  2077. virtual void noteStatistic(StatisticKind kind, unsigned __int64 value, IConstWUStatistic & extra)
  2078. {
  2079. ForEachItemIn(i, aggregators)
  2080. aggregators.item(i).noteStatistic(kind, value, extra);
  2081. }
  2082. protected:
  2083. IArrayOf<StatisticAggregator> aggregators;
  2084. };
  2085. //To calculate aggregates, create a scope iterator, and an instance of a StatisticAggregator, and play the attributes through the interface
  2086. //---------------------------------------------------------------------------------------------------------------------
  2087. //Extract an argument of the format abc[def[ghi...,]],... as (abc,def[...])
  2088. static bool extractOption(const char * & finger, StringBuffer & option, StringBuffer & arg)
  2089. {
  2090. const char * start = finger;
  2091. if (!*start)
  2092. return false;
  2093. const char * cur = start;
  2094. const char * bra = nullptr;
  2095. const char * end = nullptr;
  2096. unsigned braDepth = 0;
  2097. char next;
  2098. arg.clear();
  2099. for (;;)
  2100. {
  2101. next = *cur;
  2102. if (!next || ((next == ',') && (braDepth == 0)))
  2103. break;
  2104. switch (next)
  2105. {
  2106. case '[':
  2107. if (braDepth == 0)
  2108. {
  2109. if (bra)
  2110. throw makeStringExceptionV(0, "Multiple [ in filter : %s", bra);
  2111. bra = cur;
  2112. }
  2113. braDepth++;
  2114. break;
  2115. case ']':
  2116. if (braDepth > 0)
  2117. {
  2118. if (--braDepth == 0)
  2119. {
  2120. end = cur;
  2121. arg.append(cur - (bra+1), bra+1);
  2122. }
  2123. }
  2124. break;
  2125. }
  2126. cur++;
  2127. }
  2128. if (braDepth != 0)
  2129. throw makeStringExceptionV(0, "Mismatched ] in filter : %s", start);
  2130. option.clear();
  2131. if (bra)
  2132. {
  2133. if (cur != end+1)
  2134. throw makeStringExceptionV(0, "Text follows closing bracket: %s", end);
  2135. option.append(bra-start, start);
  2136. }
  2137. else
  2138. option.append(cur-start, start);
  2139. if (next)
  2140. finger = cur+1;
  2141. else
  2142. finger = cur;
  2143. return true;
  2144. }
  2145. static unsigned readOptValue(const char * start, const char * end, unsigned dft, const char * type)
  2146. {
  2147. if (start == end)
  2148. return dft;
  2149. char * next;
  2150. unsigned value = (unsigned)strtoll(start, &next, 10);
  2151. if (next != end)
  2152. throw makeStringExceptionV(0, "Unexpected characters in %s option '%s'", type, next);
  2153. return value;
  2154. }
  2155. static unsigned readValue(const char * start, const char * type)
  2156. {
  2157. if (*start == '\0')
  2158. throw makeStringExceptionV(0, "Expected a value for the %s option", type);
  2159. char * next;
  2160. unsigned value = (unsigned)strtoll(start, &next, 10);
  2161. if (*next != '\0')
  2162. throw makeStringExceptionV(0, "Unexpected characters in %s option '%s'", type, next);
  2163. return value;
  2164. }
  2165. /*
  2166. Scope service matching Syntax: * indicates
  2167. Which items are matched:
  2168. scope[<scope-id>]* | stype[<scope-type>]* | id[<id>]* - which scopes should be matched?
  2169. depth[n | low..high] - range of depths to search for a match
  2170. source[global|stats|graph|all]* - which sources to search within the workunit
  2171. where[<statistickind> | <statistickind> (=|<|<=|>|>=) value | <statistickind>=low..high] - a statistic filter
  2172. Which items are include in the results:
  2173. matched[true|false] - are the matched scopes returned?
  2174. nested[<depth>|all] - how deep within a scope should be matched (default = 0 if matched[true], all if matched[false])
  2175. includetype[<scope-type>] - which scope types should be included?
  2176. Which properties of the items are returned:
  2177. properties[statistics|hints|attributes|scope|all]
  2178. statistic[<statistic-kind>|none|all] - include statistic
  2179. attribute[<attribute-name>|none|all] - include attribute
  2180. hint[<hint-name>] - include hint
  2181. property[<statistic-kind>|<attribute-name>|<hint-name>] - include property
  2182. measure[<measure>] - all statistics with a particular measure
  2183. version[<version>] - minimum version to return
  2184. */
  2185. enum { FOscope, FOstype, FOid, FOdepth, FOsource, FOwhere, FOmatched, FOnested, FOinclude, FOproperties, FOstatistic, FOattribute, FOhint, FOproperty, FOmeasure, FOversion, FOunknown };
  2186. //Some of the following contains aliases for the same option e.g. stat and statistic
  2187. static constexpr EnumMapping filterOptions[] = {
  2188. { FOscope, "scope" }, { FOstype, "stype" }, { FOid, "id" },
  2189. { FOdepth, "depth" }, { FOsource, "source" }, { FOwhere, "where" },
  2190. { FOmatched, "matched" }, { FOnested, "nested" },
  2191. { FOinclude, "include" }, { FOinclude, "includetype" },
  2192. { FOproperties, "props" }, { FOproperties, "properties" }, // some aliases
  2193. { FOstatistic, "stat" }, { FOstatistic, "statistic" }, { FOattribute, "attr" }, { FOattribute, "attribute" }, { FOhint, "hint" },
  2194. { FOproperty, "prop" }, { FOproperty, "property" },
  2195. { FOmeasure, "measure" }, { FOversion, "version" }, { 0, nullptr} };
  2196. static constexpr EnumMapping sourceMappings[] = {
  2197. { SSFsearchGlobalStats, "global" }, { SSFsearchGraphStats, "stats" }, { SSFsearchGraphStats, "statistics" }, { SSFsearchGraph, "graph" }, { SSFsearchExceptions, "exception" }, { SSFsearchWorkflow, "workflow" },
  2198. { (int)SSFsearchAll, "all" }, { 0, nullptr } };
  2199. static constexpr EnumMapping propertyMappings[] = {
  2200. { PTstatistics, "stat" }, { PTstatistics, "statistic" }, { PTattributes, "attr" }, { PTattributes, "attribute" }, { PThints, "hint" },
  2201. { PTstatistics, "stats" }, { PTstatistics, "statistics" }, { PTattributes, "attrs" }, { PTattributes, "attributes" }, { PThints, "hints" },
  2202. { PTnone, "none" }, { PTscope, "scope" }, { PTall, "all" }, { 0, nullptr } };
  2203. WuScopeSourceFlags querySource(const char * source) { return (WuScopeSourceFlags)getEnum(source, sourceMappings, SSFunknown); }
  2204. const char * querySourceText(WuScopeSourceFlags source) { return getEnumText(source, sourceMappings, nullptr); }
  2205. WuScopeFilter::WuScopeFilter(const char * filter)
  2206. {
  2207. addFilter(filter);
  2208. finishedFilter();
  2209. }
  2210. WuScopeFilter & WuScopeFilter::addFilter(const char * filter)
  2211. {
  2212. if (!filter)
  2213. return *this;
  2214. StringBuffer option;
  2215. StringBuffer arg;
  2216. while (extractOption(filter, option, arg))
  2217. {
  2218. switch (getEnum(option, filterOptions, FOunknown))
  2219. {
  2220. case FOscope:
  2221. addScope(arg);
  2222. break;
  2223. case FOstype:
  2224. addScopeType(arg);
  2225. break;
  2226. case FOid:
  2227. addId(arg);
  2228. break;
  2229. case FOdepth:
  2230. {
  2231. //Allow depth[n], depth[a,b] or depth[a..b]
  2232. const char * comma = strchr(arg, ',');
  2233. const char * dotdot = strstr(arg, "..");
  2234. if (comma)
  2235. {
  2236. unsigned low = readOptValue(arg, comma, 0, "depth");
  2237. if (comma[1])
  2238. {
  2239. scopeFilter.setDepth(low, readValue(comma+1, "depth"));
  2240. }
  2241. else
  2242. scopeFilter.setDepth(low, UINT_MAX);
  2243. }
  2244. else if (dotdot)
  2245. {
  2246. unsigned low = readOptValue(arg, dotdot, 0, "depth");
  2247. if (dotdot[2])
  2248. scopeFilter.setDepth(low, readValue(dotdot+2, "depth"));
  2249. else
  2250. scopeFilter.setDepth(low, UINT_MAX);
  2251. }
  2252. else
  2253. {
  2254. scopeFilter.setDepth(readValue(arg, "depth"));
  2255. }
  2256. break;
  2257. }
  2258. case FOsource:
  2259. addSource(arg);
  2260. break;
  2261. case FOwhere: // where[stat<op>value]
  2262. addRequiredStat(arg);
  2263. break;
  2264. case FOmatched:
  2265. setIncludeMatch(strToBool(arg));
  2266. break;
  2267. case FOnested:
  2268. if (strieq(arg, "all"))
  2269. setIncludeNesting(UINT_MAX);
  2270. else if (isdigit(*arg))
  2271. setIncludeNesting(atoi(arg));
  2272. else
  2273. throw makeStringExceptionV(0, "Expected a value for the nesting depth: %s", arg.str());
  2274. break;
  2275. case FOinclude:
  2276. setIncludeScopeType(arg);
  2277. break;
  2278. case FOproperties:
  2279. {
  2280. WuPropertyTypes prop = (WuPropertyTypes)getEnum(arg, propertyMappings, PTunknown);
  2281. if (prop == PTunknown)
  2282. throw makeStringExceptionV(0, "Unexpected properties '%s'", arg.str());
  2283. addOutputProperties(prop);
  2284. break;
  2285. }
  2286. case FOstatistic:
  2287. addOutputStatistic(arg);
  2288. break;
  2289. case FOattribute:
  2290. addOutputAttribute(arg);
  2291. break;
  2292. case FOhint:
  2293. addOutputHint(arg);
  2294. break;
  2295. case FOproperty:
  2296. addOutput(arg);
  2297. break;
  2298. case FOmeasure:
  2299. setMeasure(arg);
  2300. break;
  2301. case FOversion:
  2302. if (isdigit(*arg))
  2303. minVersion = atoi64(arg);
  2304. else
  2305. throw makeStringExceptionV(0, "Expected a value for the version: %s", arg.str());
  2306. break;
  2307. default:
  2308. throw makeStringExceptionV(0, "Unrecognised filter option: %s", option.str());
  2309. }
  2310. }
  2311. return *this;
  2312. }
  2313. WuScopeFilter & WuScopeFilter::addScope(const char * scope)
  2314. {
  2315. if (scope)
  2316. {
  2317. validateScope(scope);
  2318. scopeFilter.addScope(scope);
  2319. }
  2320. return *this;
  2321. }
  2322. WuScopeFilter & WuScopeFilter::addScopeType(const char * scopeType)
  2323. {
  2324. if (scopeType)
  2325. {
  2326. StatisticScopeType sst = queryScopeType(scopeType, SSTmax);
  2327. if (sst == SSTmax)
  2328. throw makeStringExceptionV(0, "Unrecognised scope type '%s'", scopeType);
  2329. scopeFilter.addScopeType(sst);
  2330. }
  2331. return *this;
  2332. }
  2333. WuScopeFilter & WuScopeFilter::addId(const char * id)
  2334. {
  2335. validateScopeId(id);
  2336. scopeFilter.addId(id);
  2337. return *this;
  2338. }
  2339. WuScopeFilter & WuScopeFilter::addOutput(const char * prop)
  2340. {
  2341. WuAttr attr = queryWuAttribute(prop, WaNone);
  2342. if (attr != WaNone)
  2343. {
  2344. WuAttr singleKindAttr = getSingleKindOfListAttribute(attr);
  2345. if (singleKindAttr != WaNone)
  2346. addOutputAttribute(singleKindAttr);
  2347. else
  2348. addOutputAttribute(attr);
  2349. } else if (queryStatisticKind(prop, StMax) != StMax)
  2350. addOutputStatistic(prop);
  2351. else
  2352. addOutputHint(prop);
  2353. return *this;
  2354. }
  2355. WuScopeFilter & WuScopeFilter::addOutputStatistic(const char * prop)
  2356. {
  2357. if (!prop)
  2358. return *this;
  2359. StatisticKind kind = queryStatisticKind(prop, StMax);
  2360. if (kind == StMax)
  2361. throw makeStringExceptionV(0, "Unrecognised statistic '%s'", prop);
  2362. return addOutputStatistic(kind);
  2363. }
  2364. WuScopeFilter & WuScopeFilter::addOutputStatistic(StatisticKind stat)
  2365. {
  2366. if (stat != StKindNone)
  2367. {
  2368. if (stat != StKindAll)
  2369. desiredStats.append(stat);
  2370. else
  2371. desiredStats.kill();
  2372. properties |= PTstatistics;
  2373. }
  2374. else
  2375. properties &= ~PTstatistics;
  2376. return *this;
  2377. }
  2378. WuScopeFilter & WuScopeFilter::addOutputAttribute(const char * prop)
  2379. {
  2380. if (!prop)
  2381. return *this;
  2382. WuAttr attr = queryWuAttribute(prop, WaMax);
  2383. if (attr == WaMax)
  2384. throw makeStringExceptionV(0, "Unrecognised attribute '%s'", prop);
  2385. return addOutputAttribute(attr);
  2386. }
  2387. WuScopeFilter & WuScopeFilter::addOutputAttribute(WuAttr attr)
  2388. {
  2389. if (attr != WaNone)
  2390. {
  2391. if (attr != WaAll)
  2392. desiredAttrs.append(attr);
  2393. else
  2394. desiredAttrs.kill();
  2395. properties |= PTattributes;
  2396. }
  2397. else
  2398. properties &= ~PTattributes;
  2399. return *this;
  2400. }
  2401. WuScopeFilter & WuScopeFilter::addOutputHint(const char * prop)
  2402. {
  2403. if (strieq(prop, "none"))
  2404. {
  2405. desiredHints.kill();
  2406. properties &= ~PThints;
  2407. }
  2408. else
  2409. {
  2410. if (!strieq(prop, "all"))
  2411. desiredHints.append(prop);
  2412. else
  2413. desiredHints.kill();
  2414. properties |= PThints;
  2415. }
  2416. return *this;
  2417. }
  2418. WuScopeFilter & WuScopeFilter::setIncludeMatch(bool value)
  2419. {
  2420. include.matchedScope = value;
  2421. return *this;
  2422. }
  2423. WuScopeFilter & WuScopeFilter::setIncludeNesting(unsigned depth)
  2424. {
  2425. include.nestedDepth = depth;
  2426. return *this;
  2427. }
  2428. WuScopeFilter & WuScopeFilter::setIncludeScopeType(const char * scopeType)
  2429. {
  2430. if (scopeType)
  2431. {
  2432. StatisticScopeType sst = queryScopeType(scopeType, SSTmax);
  2433. if (sst == SSTmax)
  2434. throw makeStringExceptionV(0, "Unrecognised scope type '%s'", scopeType);
  2435. include.scopeTypes.append(sst);
  2436. }
  2437. return *this;
  2438. }
  2439. WuScopeFilter & WuScopeFilter::setMeasure(const char * measure)
  2440. {
  2441. if (measure)
  2442. {
  2443. desiredMeasure = queryMeasure(measure, SMeasureNone);
  2444. if (desiredMeasure == SMeasureNone)
  2445. throw makeStringExceptionV(0, "Unrecognised measure '%s'", measure);
  2446. properties |= PTstatistics;
  2447. }
  2448. return *this;
  2449. }
  2450. WuScopeFilter & WuScopeFilter::addOutputProperties(WuPropertyTypes mask)
  2451. {
  2452. if (properties == PTnone)
  2453. properties = mask;
  2454. else
  2455. properties |= mask;
  2456. return *this;
  2457. }
  2458. WuScopeFilter & WuScopeFilter::addRequiredStat(StatisticKind statKind, stat_type lowValue, stat_type highValue)
  2459. {
  2460. requiredStats.emplace_back(statKind, lowValue, highValue);
  2461. return *this;
  2462. }
  2463. WuScopeFilter & WuScopeFilter::addRequiredStat(StatisticKind statKind)
  2464. {
  2465. requiredStats.emplace_back(statKind, 0, MaxStatisticValue);
  2466. return *this;
  2467. }
  2468. //process a filter in one of the following forms:
  2469. // <statistic-name>
  2470. // <statistic-name> (=|<|<=|>|>=) <value>
  2471. // <statistic-name>=[<low>]..[<high>]
  2472. void WuScopeFilter::addRequiredStat(const char * filter)
  2473. {
  2474. const char * stat = filter;
  2475. const char * cur = stat;
  2476. while (isalpha(*cur))
  2477. cur++;
  2478. StringBuffer statisticName(cur-stat, stat);
  2479. StatisticKind statKind = queryStatisticKind(statisticName, StKindNone);
  2480. if (statKind == StKindNone)
  2481. throw makeStringExceptionV(0, "Unknown statistic name '%s'", statisticName.str());
  2482. //Skip any spaces before a comparison operator.
  2483. while (*cur && isspace(*cur))
  2484. cur++;
  2485. //Save the operator, and skip over any non digits.
  2486. const char * op = cur;
  2487. switch (*op)
  2488. {
  2489. case '=':
  2490. cur++;
  2491. break;
  2492. case '<':
  2493. case '>':
  2494. if (op[1] == '=')
  2495. cur += 2;
  2496. else
  2497. cur++;
  2498. break;
  2499. case '\0':
  2500. break;
  2501. default:
  2502. throw makeStringExceptionV(0, "Unknown comparison '%s'", op);
  2503. }
  2504. const char * next;
  2505. stat_type value = readStatisticValue(cur, &next, queryMeasure(statKind));
  2506. stat_type lowValue = 0;
  2507. stat_type highValue = MaxStatisticValue;
  2508. switch (op[0])
  2509. {
  2510. case '=':
  2511. {
  2512. //Allow a,b or a..b to specify a range - either bound may be omitted.
  2513. if (next[0] == ',')
  2514. {
  2515. lowValue = value;
  2516. next++;
  2517. if (*next != '\0')
  2518. highValue = readStatisticValue(next, &next, queryMeasure(statKind));
  2519. }
  2520. else if (strncmp(next, "..", 2) == 0)
  2521. {
  2522. lowValue = value;
  2523. next += 2;
  2524. if (*next != '\0')
  2525. highValue = readStatisticValue(next, &next, queryMeasure(statKind));
  2526. }
  2527. else
  2528. {
  2529. lowValue = value;
  2530. highValue = value;
  2531. }
  2532. break;
  2533. }
  2534. case '<':
  2535. if (op[1] == '=')
  2536. highValue = value;
  2537. else
  2538. highValue = value-1;
  2539. break;
  2540. case '>':
  2541. if (op[1] == '=')
  2542. lowValue = value;
  2543. else
  2544. lowValue = value+1;
  2545. break;
  2546. }
  2547. if (*next)
  2548. throw makeStringExceptionV(0, "Trailing characters in where '%s'", next);
  2549. requiredStats.emplace_back(statKind, lowValue, highValue);
  2550. }
  2551. WuScopeFilter & WuScopeFilter::addSource(const char * source)
  2552. {
  2553. WuScopeSourceFlags mask = querySource(source);
  2554. if (mask == SSFunknown)
  2555. throw makeStringExceptionV(0, "Unexpected source '%s'", source);
  2556. if (!mask)
  2557. sourceFlags = mask;
  2558. else
  2559. sourceFlags |= mask;
  2560. return *this;
  2561. }
  2562. WuScopeFilter & WuScopeFilter::setDepth(unsigned low, unsigned high)
  2563. {
  2564. scopeFilter.setDepth(low, high);
  2565. return *this;
  2566. }
  2567. bool WuScopeFilter::matchOnly(StatisticScopeType scopeType) const
  2568. {
  2569. //If there is a post filter on the scopeType, then check if it matches
  2570. if (include.scopeTypes.ordinality() == 1)
  2571. return (include.scopeTypes.item(0) == scopeType);
  2572. //If filter doesn't match nested items, then check if the scope filter matches.
  2573. if (include.nestedDepth == 0)
  2574. {
  2575. if (scopeFilter.matchOnly(scopeType))
  2576. return true;
  2577. }
  2578. return false;
  2579. }
  2580. //Called once the filter has been updated to optimize the filter
  2581. void WuScopeFilter::finishedFilter()
  2582. {
  2583. scopeFilter.finishedFilter();
  2584. assertex(!optimized);
  2585. optimized = true;
  2586. if ((include.nestedDepth == 0) && !include.matchedScope)
  2587. include.nestedDepth = UINT_MAX;
  2588. preFilterScope = include.matchedScope && (include.nestedDepth == 0);
  2589. if (scopeFilter.canAlwaysPreFilter())
  2590. preFilterScope = true;
  2591. //If the source flags have not been explicitly set then calculate which sources will provide the results
  2592. if (!sourceFlags)
  2593. {
  2594. sourceFlags = SSFsearchAll;
  2595. //Use the other options to reduce the number of elements that are searched.
  2596. //If not interested in scopes on their own then...
  2597. if (!(properties & PTscope))
  2598. {
  2599. //Global stats and graph stats only contain stats => remove if not interested in them
  2600. if (!(properties & PTstatistics))
  2601. sourceFlags &= ~(SSFsearchGlobalStats|SSFsearchGraphStats);
  2602. //graph, workflow only contains attributes and hints => remove if not interested
  2603. if (!(properties & (PTattributes|PThints)))
  2604. sourceFlags &= ~(SSFsearchGraph|SSFsearchWorkflow);
  2605. }
  2606. }
  2607. //Optimize sources if they haven't been explicitly specified
  2608. //Most of the following are dependent on internal knowledge of the way that information is represented
  2609. if (matchOnly(SSTworkflow))
  2610. {
  2611. //Workflow is not nested within a graph
  2612. sourceFlags &= ~(SSFsearchGraph|SSFsearchGraphStats);
  2613. setDepth(1, 1);
  2614. }
  2615. else if (matchOnly(SSTgraph))
  2616. {
  2617. //Graph starts are stored globally, not in the graph stats.
  2618. sourceFlags &= ~(SSFsearchGraphStats|SSFsearchWorkflow);
  2619. if (!(properties & (PTattributes|PThints)))
  2620. sourceFlags &= ~(SSFsearchGraph);
  2621. setDepth(2, 2);
  2622. }
  2623. else if (matchOnly(SSTsubgraph))
  2624. {
  2625. sourceFlags &= ~(SSFsearchWorkflow);
  2626. }
  2627. else if (matchOnly(SSTcompilestage))
  2628. {
  2629. //compile stages are not stored in the graph
  2630. sourceFlags &= ~(SSFsearchGraphStats|SSFsearchGraph|SSFsearchWorkflow);
  2631. }
  2632. else if (matchOnly(SSTactivity))
  2633. {
  2634. //information about activities is not stored globally
  2635. sourceFlags &= ~(SSFsearchGlobalStats|SSFsearchWorkflow);
  2636. }
  2637. // Everything stored in the graphs stats has a depth of 3 or more - so ignore if there are not matches in that depth
  2638. if (include.nestedDepth == 0)
  2639. {
  2640. if (scopeFilter.compareDepth(3) > 0) // 3 is larger than any scope in the filter
  2641. sourceFlags &= ~(SSFsearchGraphStats);
  2642. else if (scopeFilter.compareDepth(3) == 0) // 3 matches the maximum scope in the filter
  2643. {
  2644. //Subgraph WhenStarted and TimeElapsed are stored globally. If that is all that is required
  2645. //then do not include the subgraph timings
  2646. if (desiredStats.ordinality())
  2647. {
  2648. bool needGraphStats = false;
  2649. ForEachItemIn(i, desiredStats)
  2650. {
  2651. unsigned stat = desiredStats.item(i);
  2652. if ((stat != StWhenStarted) && (stat != StTimeElapsed))
  2653. needGraphStats = true;
  2654. }
  2655. if (!needGraphStats)
  2656. {
  2657. sourceFlags &= ~(SSFsearchGraphStats);
  2658. if (matchOnly(SSTsubgraph))
  2659. sourceFlags &= SSFsearchGlobalStats;
  2660. }
  2661. }
  2662. }
  2663. }
  2664. if (scopeFilter.compareDepth(1) < 0)
  2665. {
  2666. //If minimum match depth is > 1 then it will never match workflow
  2667. sourceFlags &= ~(SSFsearchWorkflow);
  2668. }
  2669. //The xml graph is never updated, so do not check it if minVersion != 0
  2670. if (minVersion != 0)
  2671. {
  2672. sourceFlags &= ~(SSFsearchGraph|SSFsearchWorkflow);
  2673. }
  2674. }
  2675. bool WuScopeFilter::includeStatistic(StatisticKind kind) const
  2676. {
  2677. if (!(properties & PTstatistics))
  2678. return false;
  2679. if ((desiredMeasure != SMeasureAll) && (queryMeasure(kind) != desiredMeasure))
  2680. return false;
  2681. if (desiredStats.empty())
  2682. return true;
  2683. return desiredStats.contains(kind);
  2684. }
  2685. bool WuScopeFilter::includeAttribute(WuAttr attr) const
  2686. {
  2687. if (!(properties & PTattributes))
  2688. return false;
  2689. if (desiredAttrs.empty())
  2690. return true;
  2691. return desiredAttrs.contains(attr);
  2692. }
  2693. bool WuScopeFilter::includeHint(const char * kind) const
  2694. {
  2695. if (!(properties & PThints))
  2696. return false;
  2697. if (desiredHints.empty())
  2698. return true;
  2699. return desiredHints.contains(kind);
  2700. }
  2701. bool WuScopeFilter::includeScope(const char * scope) const
  2702. {
  2703. if (include.scopeTypes)
  2704. {
  2705. const char * tail = queryScopeTail(scope);
  2706. StatsScopeId id(tail);
  2707. if (!include.scopeTypes.contains(id.queryScopeType()))
  2708. return false;
  2709. }
  2710. return true;
  2711. }
  2712. const static ScopeFilter nullScopeFilter {};
  2713. const ScopeFilter & WuScopeFilter::queryIterFilter() const
  2714. {
  2715. if (preFilterScope)
  2716. return scopeFilter;
  2717. else
  2718. return nullScopeFilter;
  2719. }
  2720. ScopeCompare WuScopeFilter::compareMatchScopes(const char * scope) const
  2721. {
  2722. return scopeFilter.compare(scope);
  2723. }
  2724. StringBuffer & WuScopeFilter::describe(StringBuffer & out) const
  2725. {
  2726. scopeFilter.describe(out);
  2727. if (requiredStats.size())
  2728. {
  2729. out.append(",where[");
  2730. bool first = false;
  2731. for (const auto & stat : requiredStats)
  2732. {
  2733. if (!first)
  2734. out.append(",");
  2735. stat.describe(out);
  2736. first = false;
  2737. }
  2738. out.append("]");
  2739. }
  2740. {
  2741. StringBuffer sources;
  2742. for (unsigned mask=1; mask; mask *= 2)
  2743. {
  2744. if (sourceFlags & mask)
  2745. {
  2746. const char * source = querySourceText((WuScopeSourceFlags)mask);
  2747. if (source)
  2748. sources.append(",").append(source);
  2749. }
  2750. }
  2751. if (sources)
  2752. out.append(",source[").append(sources.str()+1).append("]");
  2753. }
  2754. if (include.nestedDepth != UINT_MAX)
  2755. out.appendf(",nested[%u]", include.nestedDepth);
  2756. if (include.scopeTypes)
  2757. {
  2758. out.append(",include[");
  2759. ForEachItemIn(i, include.scopeTypes)
  2760. {
  2761. if (i)
  2762. out.append(",");
  2763. out.append(queryScopeTypeName((StatisticScopeType)include.scopeTypes.item(i)));
  2764. }
  2765. out.append("]");
  2766. }
  2767. {
  2768. StringBuffer props;
  2769. if (properties == PTnone)
  2770. props.append(",none");
  2771. else if (properties == PTall)
  2772. props.append(",all");
  2773. else
  2774. {
  2775. if (properties & PTstatistics)
  2776. props.append(",stat");
  2777. if (properties & PTattributes)
  2778. props.append(",attr");
  2779. if (properties & PThints)
  2780. props.append(",hint");
  2781. if (properties & PTscope)
  2782. props.append(",scope");
  2783. }
  2784. out.append(",properties[").append(props.str()+1).append("]");
  2785. }
  2786. if (desiredStats)
  2787. {
  2788. out.append(",stat[");
  2789. ForEachItemIn(i, desiredStats)
  2790. {
  2791. if (i)
  2792. out.append(",");
  2793. out.append(queryStatisticName((StatisticKind)desiredStats.item(i)));
  2794. }
  2795. out.append("]");
  2796. }
  2797. if (desiredAttrs)
  2798. {
  2799. out.append(",attr[");
  2800. ForEachItemIn(i, desiredAttrs)
  2801. {
  2802. if (i)
  2803. out.append(",");
  2804. out.append(queryWuAttributeName((WuAttr)desiredAttrs.item(i)));
  2805. }
  2806. out.append("]");
  2807. }
  2808. if (desiredHints)
  2809. {
  2810. out.append(",hint[");
  2811. ForEachItemIn(i, desiredHints)
  2812. {
  2813. if (i)
  2814. out.append(",");
  2815. out.append(desiredHints.item(i));
  2816. }
  2817. out.append("]");
  2818. }
  2819. if (desiredMeasure != SMeasureAll)
  2820. out.append(",measure[").append(queryMeasureName(desiredMeasure)).append("]");
  2821. if (minVersion != 0)
  2822. out.appendf(",version(%" I64F "u)", minVersion);
  2823. return out;
  2824. }
  2825. //--------------------------------------------------------------------------------------------------------------------
  2826. EnumMapping states[] = {
  2827. { WUStateUnknown, "unknown" },
  2828. { WUStateCompiled, "compiled" },
  2829. { WUStateRunning, "running" },
  2830. { WUStateCompleted, "completed" },
  2831. { WUStateFailed, "failed" },
  2832. { WUStateArchived, "archived" },
  2833. { WUStateAborting, "aborting" },
  2834. { WUStateAborted, "aborted" },
  2835. { WUStateBlocked, "blocked" },
  2836. { WUStateSubmitted, "submitted" },
  2837. { WUStateScheduled, "scheduled" },
  2838. { WUStateCompiling, "compiling" },
  2839. { WUStateWait, "wait" },
  2840. { WUStateUploadingFiles, "uploading_files" },
  2841. { WUStateDebugPaused, "debugging" },
  2842. { WUStateDebugRunning, "debug_running" },
  2843. { WUStatePaused, "paused" },
  2844. { WUStateSize, NULL }
  2845. };
  2846. EnumMapping actions[] = {
  2847. { WUActionUnknown, "unknown" },
  2848. { WUActionCompile, "compile" },
  2849. { WUActionCheck, "check" },
  2850. { WUActionRun, "run" },
  2851. { WUActionExecuteExisting, "execute" },
  2852. { WUActionPause, "pause" },
  2853. { WUActionPauseNow, "pausenow" },
  2854. { WUActionResume, "resume" },
  2855. { WUActionSize, NULL },
  2856. };
  2857. EnumMapping priorityClasses[] = {
  2858. { PriorityClassUnknown, "unknown" },
  2859. { PriorityClassLow, "low" },
  2860. { PriorityClassNormal, "normal" },
  2861. { PriorityClassHigh, "high" },
  2862. { PriorityClassSize, NULL },
  2863. };
  2864. const char * getWorkunitStateStr(WUState state)
  2865. {
  2866. dbgassertex(state < WUStateSize);
  2867. return states[state].str; // MORE - should be using getEnumText, or need to take steps to ensure values remain contiguous and in order.
  2868. }
  2869. void setEnum(IPropertyTree *p, const char *propname, int value, const EnumMapping *map)
  2870. {
  2871. const char *defval = map->str;
  2872. while (map->str)
  2873. {
  2874. if (value==map->val)
  2875. {
  2876. p->setProp(propname, map->str);
  2877. return;
  2878. }
  2879. map++;
  2880. }
  2881. assertex(!"Unexpected value in setEnum");
  2882. p->setProp(propname, defval);
  2883. }
  2884. static int getEnum(const IPropertyTree *p, const char *propname, const EnumMapping *map)
  2885. {
  2886. return getEnum(p->queryProp(propname),map);
  2887. }
  2888. const char * getWorkunitActionStr(WUAction action)
  2889. {
  2890. return getEnumText(action, actions);
  2891. }
  2892. WUAction getWorkunitAction(const char *actionStr)
  2893. {
  2894. return (WUAction) getEnum(actionStr, actions);
  2895. }
  2896. //==========================================================================================
  2897. class CLightweightWorkunitInfo : public CInterfaceOf<IConstWorkUnitInfo>
  2898. {
  2899. public:
  2900. CLightweightWorkunitInfo(IPropertyTree &p)
  2901. {
  2902. wuid.set(p.queryName());
  2903. user.set(p.queryProp("@submitID"));
  2904. jobName.set(p.queryProp("@jobName"));
  2905. clusterName.set(p.queryProp("@clusterName"));
  2906. timeScheduled.set(p.queryProp("@timeScheduled"));
  2907. state = (WUState) getEnum(&p, "@state", states);
  2908. action = (WUAction) getEnum(&p, "Action", actions);
  2909. priority = (WUPriorityClass) getEnum(&p, "@priorityClass", priorityClasses);
  2910. priorityLevel = calcPriorityValue(&p);
  2911. wuscope.set(p.queryProp("@scope"));
  2912. appvalues.loadBranch(&p,"Application");
  2913. totalThorTime = (unsigned)nanoToMilli(extractTimeCollatable(p.queryProp("@totalThorTime"), false));
  2914. _isProtected = p.getPropBool("@protected", false);
  2915. }
  2916. virtual const char *queryWuid() const { return wuid.str(); }
  2917. virtual const char *queryUser() const { return user.str(); }
  2918. virtual const char *queryJobName() const { return jobName.str(); }
  2919. virtual const char *queryClusterName() const { return clusterName.str(); }
  2920. virtual const char *queryWuScope() const { return wuscope.str(); }
  2921. virtual WUState getState() const { return state; }
  2922. virtual const char *queryStateDesc() const { return getEnumText(state, states); }
  2923. virtual WUAction getAction() const { return action; }
  2924. virtual const char *queryActionDesc() const { return getEnumText(action, actions); }
  2925. virtual WUPriorityClass getPriority() const { return priority; }
  2926. virtual const char *queryPriorityDesc() const { return getEnumText(priority, priorityClasses); }
  2927. virtual int getPriorityLevel() const { return priorityLevel; }
  2928. virtual bool isProtected() const { return _isProtected; }
  2929. virtual IJlibDateTime & getTimeScheduled(IJlibDateTime & val) const
  2930. {
  2931. if (timeScheduled.length())
  2932. val.setGmtString(timeScheduled.str());
  2933. return val;
  2934. }
  2935. virtual unsigned getTotalThorTime() const { return totalThorTime; };
  2936. virtual IConstWUAppValueIterator & getApplicationValues() const { return *new CArrayIteratorOf<IConstWUAppValue,IConstWUAppValueIterator> (appvalues, 0, (IConstWorkUnitInfo *) this); };
  2937. protected:
  2938. StringAttr wuid, user, jobName, clusterName, timeScheduled, wuscope;
  2939. mutable CachedTags<CLocalWUAppValue,IConstWUAppValue> appvalues;
  2940. unsigned totalThorTime;
  2941. WUState state;
  2942. WUAction action;
  2943. WUPriorityClass priority;
  2944. int priorityLevel;
  2945. bool _isProtected;
  2946. };
  2947. extern IConstWorkUnitInfo *createConstWorkUnitInfo(IPropertyTree &p)
  2948. {
  2949. return new CLightweightWorkunitInfo(p);
  2950. }
  2951. class CDaliWuGraphStats : public CWuGraphStats
  2952. {
  2953. public:
  2954. CDaliWuGraphStats(IRemoteConnection *_conn, StatisticCreatorType _creatorType, const char * _creator, unsigned _wfid, const char * _rootScope, unsigned _id)
  2955. : CWuGraphStats(LINK(_conn->queryRoot()), _creatorType, _creator, _wfid, _rootScope, _id), conn(_conn)
  2956. {
  2957. }
  2958. protected:
  2959. Owned<IRemoteConnection> conn;
  2960. };
  2961. CWorkUnitWatcher::CWorkUnitWatcher(IWorkUnitSubscriber *_subscriber, WUSubscribeOptions flags, const char *wuid) : subscriber(_subscriber)
  2962. {
  2963. abortId = 0;
  2964. stateId = 0;
  2965. actionId = 0;
  2966. assertex((flags & ~SubscribeOptionAbort) == 0);
  2967. if (flags & SubscribeOptionAbort)
  2968. {
  2969. VStringBuffer xpath("/WorkUnitAborts/%s", wuid);
  2970. abortId = querySDS().subscribe(xpath.str(), *this, false, true);
  2971. }
  2972. }
  2973. CWorkUnitWatcher::~CWorkUnitWatcher()
  2974. {
  2975. assertex(abortId==0 && stateId==0 && actionId==0);
  2976. }
  2977. void CWorkUnitWatcher::unsubscribe()
  2978. {
  2979. CriticalBlock b(crit);
  2980. if (abortId)
  2981. querySDS().unsubscribe(abortId);
  2982. if (stateId)
  2983. querySDS().unsubscribe(stateId);
  2984. if (actionId)
  2985. querySDS().unsubscribe(actionId);
  2986. abortId = 0;
  2987. stateId = 0;
  2988. actionId = 0;
  2989. }
  2990. void CWorkUnitWatcher::notify(SubscriptionId id, const char *xpath, SDSNotifyFlags flags, unsigned valueLen, const void *valueData)
  2991. {
  2992. CriticalBlock b(crit);
  2993. if (id==stateId)
  2994. subscriber->notify(SubscribeOptionState, valueLen, valueData);
  2995. else if (id==actionId)
  2996. subscriber->notify(SubscribeOptionAction, valueLen, valueData);
  2997. else if (id==abortId)
  2998. subscriber->notify(SubscribeOptionAbort, valueLen, valueData);
  2999. }
  3000. class CDaliWorkUnitWatcher : public CWorkUnitWatcher
  3001. {
  3002. public:
  3003. CDaliWorkUnitWatcher(IWorkUnitSubscriber *_subscriber, WUSubscribeOptions flags, const char *wuid)
  3004. : CWorkUnitWatcher(_subscriber, (WUSubscribeOptions) (flags & SubscribeOptionAbort), wuid)
  3005. {
  3006. if (flags & SubscribeOptionState)
  3007. {
  3008. VStringBuffer xpath("/WorkUnits/%s/State", wuid);
  3009. stateId = querySDS().subscribe(xpath.str(), *this);
  3010. }
  3011. if (flags & SubscribeOptionAction)
  3012. {
  3013. VStringBuffer xpath("/WorkUnits/%s/Action", wuid);
  3014. actionId = querySDS().subscribe(xpath.str(), *this);
  3015. }
  3016. }
  3017. };
  3018. void CPersistedWorkUnit::subscribe(WUSubscribeOptions options)
  3019. {
  3020. CriticalBlock block(crit);
  3021. assertex(options==SubscribeOptionAbort);
  3022. if (!abortWatcher)
  3023. {
  3024. abortWatcher.setown(new CWorkUnitWatcher(this, SubscribeOptionAbort, p->queryName()));
  3025. abortDirty = true;
  3026. }
  3027. }
  3028. void CPersistedWorkUnit::unsubscribe()
  3029. {
  3030. CriticalBlock block(crit);
  3031. if (abortWatcher)
  3032. {
  3033. abortWatcher->unsubscribe();
  3034. abortWatcher.clear();
  3035. }
  3036. }
  3037. bool CPersistedWorkUnit::aborting() const
  3038. {
  3039. CriticalBlock block(crit);
  3040. if (abortDirty)
  3041. {
  3042. StringBuffer apath;
  3043. apath.append("/WorkUnitAborts/").append(p->queryName());
  3044. Owned<IRemoteConnection> acon = querySDS().connect(apath.str(), myProcessSession(), 0, SDS_LOCK_TIMEOUT);
  3045. if (acon)
  3046. abortState = acon->queryRoot()->getPropInt(NULL) != 0;
  3047. else
  3048. abortState = false;
  3049. abortDirty = false;
  3050. }
  3051. return abortState;
  3052. }
  3053. class CDaliWorkUnit : public CPersistedWorkUnit
  3054. {
  3055. public:
  3056. CDaliWorkUnit(IRemoteConnection *_conn, ISecManager *secmgr, ISecUser *secuser)
  3057. : connection(_conn), CPersistedWorkUnit(secmgr, secuser)
  3058. {
  3059. loadPTree(connection->getRoot());
  3060. }
  3061. ~CDaliWorkUnit()
  3062. {
  3063. // NOTE - order is important - we need to construct connection before p and (especially) destroy after p
  3064. // We use the beforeDispose() in base class to help ensure this
  3065. p.clear();
  3066. }
  3067. IConstWUGraphProgress *getGraphProgress(const char *graphName) const
  3068. {
  3069. Owned<IRemoteConnection> conn = getProgressConnection();
  3070. if (conn)
  3071. {
  3072. IPTree *progress = conn->queryRoot()->queryPropTree(graphName);
  3073. if (progress)
  3074. return new CConstGraphProgress(p->queryName(), graphName, progress);
  3075. }
  3076. return NULL;
  3077. }
  3078. virtual WUGraphState queryGraphState(const char *graphName) const
  3079. {
  3080. Owned<IRemoteConnection> conn = getProgressConnection();
  3081. if (conn)
  3082. {
  3083. IPTree *progress = conn->queryRoot()->queryPropTree(graphName);
  3084. if (progress)
  3085. return (WUGraphState) progress->getPropInt("@_state", (unsigned) WUGraphUnknown);
  3086. }
  3087. return WUGraphUnknown;
  3088. }
  3089. virtual WUGraphState queryNodeState(const char *graphName, WUGraphIDType nodeId) const
  3090. {
  3091. Owned<IRemoteConnection> conn = getProgressConnection();
  3092. if (conn)
  3093. {
  3094. IPTree *progress = conn->queryRoot()->queryPropTree(graphName);
  3095. if (progress)
  3096. {
  3097. StringBuffer path;
  3098. // NOTE - the node state info still uses the old graph layout, even when the stats are using the new...
  3099. path.append("node[@id=\"").append(nodeId).append("\"]/@_state");
  3100. return (WUGraphState) progress->getPropInt(path, (unsigned) WUGraphUnknown);
  3101. }
  3102. }
  3103. return WUGraphUnknown;
  3104. }
  3105. virtual void clearGraphProgress() const
  3106. {
  3107. CriticalBlock block(crit);
  3108. progressConnection.clear(); // Make sure nothing is locking for read or we won't be able to lock for write
  3109. StringBuffer path("/GraphProgress/");
  3110. path.append(p->queryName());
  3111. Owned<IRemoteConnection> delconn = querySDS().connect(path.str(), myProcessSession(), RTM_LOCK_WRITE, SDS_LOCK_TIMEOUT);
  3112. if (delconn)
  3113. delconn->close(true);
  3114. }
  3115. virtual bool getRunningGraph(IStringVal &graphName, WUGraphIDType &subId) const
  3116. {
  3117. Owned<IRemoteConnection> conn = getProgressConnection();
  3118. if (!conn)
  3119. return false;
  3120. const char *name = conn->queryRoot()->queryProp("Running/@graph");
  3121. if (name)
  3122. {
  3123. graphName.set(name);
  3124. subId = conn->queryRoot()->getPropInt64("Running/@subId");
  3125. return true;
  3126. }
  3127. else
  3128. return false;
  3129. }
  3130. virtual void forceReload()
  3131. {
  3132. synchronized sync(locked); // protect locked workunits (uncommitted writes) from reload
  3133. CriticalBlock block(crit);
  3134. clearCached(true);
  3135. connection->reload();
  3136. progressConnection.clear();
  3137. abortDirty = true;
  3138. p.setown(connection->getRoot());
  3139. }
  3140. virtual void cleanupAndDelete(bool deldll, bool deleteOwned, const StringArray *deleteExclusions)
  3141. {
  3142. CPersistedWorkUnit::cleanupAndDelete(deldll, deleteOwned, deleteExclusions);
  3143. clearGraphProgress();
  3144. connection->close(true);
  3145. connection.clear();
  3146. }
  3147. virtual void commit()
  3148. {
  3149. CPersistedWorkUnit::commit();
  3150. if (connection)
  3151. connection->commit();
  3152. }
  3153. virtual void _lockRemote()
  3154. {
  3155. StringBuffer wuRoot;
  3156. getXPath(wuRoot, p->queryName());
  3157. if (connection)
  3158. connection->changeMode(RTM_LOCK_WRITE,SDS_LOCK_TIMEOUT);
  3159. else
  3160. connection.setown(querySDS().connect(wuRoot.str(), myProcessSession(), RTM_LOCK_WRITE, SDS_LOCK_TIMEOUT));
  3161. if (!connection)
  3162. throw MakeStringException(WUERR_LockFailed, "Failed to get connection for xpath %s", wuRoot.str());
  3163. clearCached(true);
  3164. p.setown(connection->getRoot());
  3165. }
  3166. virtual void _unlockRemote()
  3167. {
  3168. if (connection)
  3169. {
  3170. try
  3171. {
  3172. try
  3173. {
  3174. connection->commit();
  3175. }
  3176. catch (IException *e)
  3177. {
  3178. EXCLOG(e, "Error during workunit commit");
  3179. connection->rollback();
  3180. connection->changeMode(0, SDS_LOCK_TIMEOUT);
  3181. throw;
  3182. }
  3183. connection->changeMode(0, SDS_LOCK_TIMEOUT);
  3184. }
  3185. catch (IException *E)
  3186. {
  3187. StringBuffer s;
  3188. PrintLog("Failed to release write lock on workunit: %s", E->errorMessage(s).str());
  3189. throw;
  3190. }
  3191. }
  3192. }
  3193. virtual void setGraphState(const char *graphName, WUGraphState state) const
  3194. {
  3195. Owned<IRemoteConnection> conn = getWritableProgressConnection(graphName);
  3196. conn->queryRoot()->setPropInt("@_state", state);
  3197. }
  3198. virtual void setNodeState(const char *graphName, WUGraphIDType nodeId, WUGraphState state) const
  3199. {
  3200. CriticalBlock block(crit);
  3201. progressConnection.clear(); // Make sure nothing is locking for read or we won't be able to lock for write
  3202. VStringBuffer path("/GraphProgress/%s", queryWuid());
  3203. Owned<IRemoteConnection> conn = querySDS().connect(path, myProcessSession(), RTM_LOCK_WRITE|RTM_CREATE_QUERY, SDS_LOCK_TIMEOUT);
  3204. IPTree *progress = ensurePTree(conn->queryRoot(), graphName);
  3205. // NOTE - the node state info still uses the old graph layout, even when the stats are using the new...
  3206. path.clear().append("node[@id=\"").append(nodeId).append("\"]");
  3207. IPropertyTree *node = progress->queryPropTree(path.str());
  3208. if (!node)
  3209. {
  3210. node = progress->addPropTree("node");
  3211. node->setPropInt64("@id", nodeId);
  3212. }
  3213. node->setPropInt("@_state", (unsigned)state);
  3214. switch (state)
  3215. {
  3216. case WUGraphRunning:
  3217. {
  3218. IPropertyTree *running = conn->queryRoot()->setPropTree("Running");
  3219. running->setProp("@graph", graphName);
  3220. running->setPropInt64("@subId", nodeId);
  3221. break;
  3222. }
  3223. case WUGraphComplete:
  3224. {
  3225. conn->queryRoot()->removeProp("Running"); // only one thing running at any given time and one thing with lockWrite access
  3226. break;
  3227. }
  3228. }
  3229. }
  3230. virtual IWUGraphStats *updateStats(const char *graphName, StatisticCreatorType creatorType, const char * creator, unsigned _wfid, unsigned subgraph) const override
  3231. {
  3232. return new CDaliWuGraphStats(getWritableProgressConnection(graphName), creatorType, creator, _wfid, graphName, subgraph);
  3233. }
  3234. protected:
  3235. IRemoteConnection *getProgressConnection() const
  3236. {
  3237. CriticalBlock block(crit);
  3238. if (!progressConnection)
  3239. {
  3240. VStringBuffer path("/GraphProgress/%s", queryWuid());
  3241. progressConnection.setown(querySDS().connect(path, myProcessSession(), 0, SDS_LOCK_TIMEOUT)); // Note - we don't lock. The writes are atomic.
  3242. }
  3243. return progressConnection.getLink();
  3244. }
  3245. IRemoteConnection *getWritableProgressConnection(const char *graphName) const
  3246. {
  3247. CriticalBlock block(crit);
  3248. progressConnection.clear(); // Make sure subsequent reads from this workunit get the changes I am making
  3249. VStringBuffer path("/GraphProgress/%s/%s", queryWuid(), graphName);
  3250. return querySDS().connect(path, myProcessSession(), RTM_LOCK_WRITE|RTM_CREATE_QUERY, SDS_LOCK_TIMEOUT);
  3251. }
  3252. IPropertyTree *getGraphProgressTree() const
  3253. {
  3254. Owned<IRemoteConnection> conn = getProgressConnection();
  3255. if (conn)
  3256. {
  3257. Owned<IPropertyTree> tmp = createPTree("GraphProgress");
  3258. mergePTree(tmp,conn->queryRoot());
  3259. return tmp.getClear();
  3260. }
  3261. return NULL;
  3262. }
  3263. Owned<IRemoteConnection> connection;
  3264. mutable Owned<IRemoteConnection> progressConnection;
  3265. };
  3266. class CLockedWorkUnit : implements ILocalWorkUnit, implements IExtendedWUInterface, public CInterface
  3267. {
  3268. public:
  3269. Owned<CLocalWorkUnit> c;
  3270. IMPLEMENT_IINTERFACE;
  3271. CLockedWorkUnit(CLocalWorkUnit *_c) : c(_c) {}
  3272. ~CLockedWorkUnit()
  3273. {
  3274. if (workUnitTraceLevel > 1)
  3275. PrintLog("Releasing locked workunit %s", queryWuid());
  3276. if (c)
  3277. c->unlockRemote();
  3278. }
  3279. virtual IConstWorkUnit * unlock()
  3280. {
  3281. c->unlockRemote();
  3282. return c.getClear();
  3283. }
  3284. virtual bool aborting() const
  3285. { return c->aborting(); }
  3286. virtual void forceReload()
  3287. { UNIMPLEMENTED; }
  3288. virtual WUAction getAction() const
  3289. { return c->getAction(); }
  3290. virtual const char *queryActionDesc() const
  3291. { return c->queryActionDesc(); }
  3292. virtual IStringVal & getApplicationValue(const char * application, const char * propname, IStringVal & str) const
  3293. { return c->getApplicationValue(application, propname, str); }
  3294. virtual int getApplicationValueInt(const char * application, const char * propname, int defVal) const
  3295. { return c->getApplicationValueInt(application, propname, defVal); }
  3296. virtual IConstWUAppValueIterator & getApplicationValues() const
  3297. { return c->getApplicationValues(); }
  3298. virtual bool hasWorkflow() const
  3299. { return c->hasWorkflow(); }
  3300. virtual unsigned queryEventScheduledCount() const
  3301. { return c->queryEventScheduledCount(); }
  3302. virtual IPropertyTree * queryWorkflowTree() const
  3303. { return c->queryWorkflowTree(); }
  3304. virtual IConstWorkflowItemIterator * getWorkflowItems() const
  3305. { return c->getWorkflowItems(); }
  3306. virtual IWorkflowItemArray * getWorkflowClone() const
  3307. { return c->getWorkflowClone(); }
  3308. virtual bool requiresLocalFileUpload() const
  3309. { return c->requiresLocalFileUpload(); }
  3310. virtual IConstLocalFileUploadIterator * getLocalFileUploads() const
  3311. { return c->getLocalFileUploads(); }
  3312. virtual bool getIsQueryService() const
  3313. { return c->getIsQueryService(); }
  3314. virtual bool getCloneable() const
  3315. { return c->getCloneable(); }
  3316. virtual IUserDescriptor * queryUserDescriptor() const
  3317. { return c->queryUserDescriptor(); }
  3318. virtual const char *queryClusterName() const
  3319. { return c->queryClusterName(); }
  3320. virtual unsigned getCodeVersion() const
  3321. { return c->getCodeVersion(); }
  3322. virtual unsigned getWuidVersion() const
  3323. { return c->getWuidVersion(); }
  3324. virtual void getBuildVersion(IStringVal & buildVersion, IStringVal & eclVersion) const
  3325. { c->getBuildVersion(buildVersion, eclVersion); }
  3326. virtual bool hasDebugValue(const char * propname) const
  3327. { return c->hasDebugValue(propname); }
  3328. virtual IStringVal & getDebugValue(const char * propname, IStringVal & str) const
  3329. { return c->getDebugValue(propname, str); }
  3330. virtual int getDebugValueInt(const char * propname, int defVal) const
  3331. { return c->getDebugValueInt(propname, defVal); }
  3332. virtual __int64 getDebugValueInt64(const char * propname, __int64 defVal) const
  3333. { return c->getDebugValueInt64(propname, defVal); }
  3334. virtual bool getDebugValueBool(const char * propname, bool defVal) const
  3335. { return c->getDebugValueBool(propname, defVal); }
  3336. virtual IStringIterator & getDebugValues() const
  3337. { return c->getDebugValues(NULL); }
  3338. virtual IStringIterator & getDebugValues(const char *prop) const
  3339. { return c->getDebugValues(prop); }
  3340. virtual unsigned getExceptionCount() const
  3341. { return c->getExceptionCount(); }
  3342. virtual IConstWUExceptionIterator & getExceptions() const
  3343. { return c->getExceptions(); }
  3344. virtual unsigned getGraphCount() const
  3345. { return c->getGraphCount(); }
  3346. virtual unsigned getSourceFileCount() const
  3347. { return c->getSourceFileCount(); }
  3348. virtual unsigned getResultCount() const
  3349. { return c->getResultCount(); }
  3350. virtual unsigned getVariableCount() const
  3351. { return c->getVariableCount(); }
  3352. virtual unsigned getApplicationValueCount() const
  3353. { return c->getApplicationValueCount(); }
  3354. virtual IConstWUGraphIterator & getGraphs(WUGraphType type) const
  3355. { return c->getGraphs(type); }
  3356. virtual IConstWUGraphMetaIterator & getGraphsMeta(WUGraphType type) const
  3357. { return c->getGraphsMeta(type); }
  3358. virtual IConstWUGraph * getGraph(const char *name) const
  3359. { return c->getGraph(name); }
  3360. virtual IConstWUGraphProgress * getGraphProgress(const char * name) const
  3361. { return c->getGraphProgress(name); }
  3362. virtual const char *queryJobName() const
  3363. { return c->queryJobName(); }
  3364. virtual IConstWUPlugin * getPluginByName(const char * name) const
  3365. { return c->getPluginByName(name); }
  3366. virtual IConstWUPluginIterator & getPlugins() const
  3367. { return c->getPlugins(); }
  3368. virtual IConstWULibrary* getLibraryByName(const char *name) const
  3369. { return c->getLibraryByName(name); }
  3370. virtual IConstWULibraryIterator & getLibraries() const
  3371. { return c->getLibraries(); }
  3372. virtual WUPriorityClass getPriority() const
  3373. { return c->getPriority(); }
  3374. virtual const char *queryPriorityDesc() const
  3375. { return c->queryPriorityDesc(); }
  3376. virtual int getPriorityLevel() const
  3377. { return c->getPriorityLevel(); }
  3378. virtual int getPriorityValue() const
  3379. { return c->getPriorityValue(); }
  3380. virtual IConstWUQuery * getQuery() const
  3381. { return c->getQuery(); }
  3382. virtual IConstWUWebServicesInfo * getWebServicesInfo() const
  3383. { return c->getWebServicesInfo(); }
  3384. virtual bool getRescheduleFlag() const
  3385. { return c->getRescheduleFlag(); }
  3386. virtual IConstWUResult * getResultByName(const char * name) const
  3387. { return c->getResultByName(name); }
  3388. virtual IConstWUResult * getResultBySequence(unsigned seq) const
  3389. { return c->getResultBySequence(seq); }
  3390. virtual unsigned getResultLimit() const
  3391. { return c->getResultLimit(); }
  3392. virtual IConstWUResultIterator & getResults() const
  3393. { return c->getResults(); }
  3394. virtual IStringVal & getScope(IStringVal & str) const
  3395. { return c->getScope(str); }
  3396. virtual IStringVal & getWorkunitDistributedAccessToken(IStringVal & str) const
  3397. { return c->getWorkunitDistributedAccessToken(str); }
  3398. virtual WUState getState() const
  3399. { return c->getState(); }
  3400. virtual IStringVal & getStateEx(IStringVal & str) const
  3401. { return c->getStateEx(str); }
  3402. virtual __int64 getAgentSession() const
  3403. { return c->getAgentSession(); }
  3404. virtual unsigned getAgentPID() const
  3405. { return c->getAgentPID(); }
  3406. virtual const char *queryStateDesc() const
  3407. { return c->queryStateDesc(); }
  3408. virtual bool getRunningGraph(IStringVal & graphName, WUGraphIDType & subId) const
  3409. { return c->getRunningGraph(graphName, subId); }
  3410. virtual IConstWUScopeIterator & getScopeIterator(const WuScopeFilter & filter) const override
  3411. { return c->getScopeIterator(filter); }
  3412. virtual bool getStatistic(stat_type & value, const char * scope, StatisticKind kind) const override
  3413. { return c->getStatistic(value, scope, kind); }
  3414. virtual IStringVal & getSnapshot(IStringVal & str) const
  3415. { return c->getSnapshot(str); }
  3416. virtual const char *queryUser() const
  3417. { return c->queryUser(); }
  3418. virtual ErrorSeverity getWarningSeverity(unsigned code, ErrorSeverity defaultSeverity) const
  3419. { return c->getWarningSeverity(code, defaultSeverity); }
  3420. virtual const char *queryWuScope() const
  3421. { return c->queryWuScope(); }
  3422. virtual const char *queryWuid() const
  3423. { return c->queryWuid(); }
  3424. virtual IConstWUResult * getGlobalByName(const char * name) const
  3425. { return c->getGlobalByName(name); }
  3426. virtual IConstWUResult * getTemporaryByName(const char * name) const
  3427. { return c->getTemporaryByName(name); }
  3428. virtual IConstWUResultIterator & getTemporaries() const
  3429. { return c->getTemporaries(); }
  3430. virtual IConstWUResult * getVariableByName(const char * name) const
  3431. { return c->getVariableByName(name); }
  3432. virtual IConstWUResultIterator & getVariables() const
  3433. { return c->getVariables(); }
  3434. virtual bool isProtected() const
  3435. { return c->isProtected(); }
  3436. virtual bool isPausing() const
  3437. { return c->isPausing(); }
  3438. virtual IWorkUnit & lock()
  3439. { ((CInterface *)this)->Link(); return (IWorkUnit &) *this; }
  3440. virtual bool reload()
  3441. { UNIMPLEMENTED; }
  3442. virtual void subscribe(WUSubscribeOptions options)
  3443. { c->subscribe(options); }
  3444. virtual void requestAbort()
  3445. { c->requestAbort(); }
  3446. virtual unsigned calculateHash(unsigned prevHash)
  3447. { return queryExtendedWU(c)->calculateHash(prevHash); }
  3448. virtual void copyWorkUnit(IConstWorkUnit *cached, bool copyStats, bool all)
  3449. { queryExtendedWU(c)->copyWorkUnit(cached, copyStats, all); }
  3450. virtual IPropertyTree *queryPTree() const
  3451. { return queryExtendedWU(c)->queryPTree(); }
  3452. virtual IPropertyTree *getUnpackedTree(bool includeProgress) const
  3453. { return queryExtendedWU(c)->getUnpackedTree(includeProgress); }
  3454. virtual bool archiveWorkUnit(const char *base,bool del,bool deldll,bool deleteOwned,bool exportAssociatedFiles)
  3455. { return queryExtendedWU(c)->archiveWorkUnit(base,del,deldll,deleteOwned,exportAssociatedFiles); }
  3456. virtual unsigned queryFileUsage(const char *filename) const
  3457. { return c->queryFileUsage(filename); }
  3458. virtual IConstWUFileUsageIterator * getFieldUsage() const
  3459. { return c->getFieldUsage(); }
  3460. virtual bool getFieldUsageArray(StringArray & filenames, StringArray & columnnames, const char * clusterName) const
  3461. { return c->getFieldUsageArray(filenames, columnnames, clusterName); }
  3462. virtual IJlibDateTime & getTimeScheduled(IJlibDateTime &val) const
  3463. { return c->getTimeScheduled(val); }
  3464. virtual unsigned getDebugAgentListenerPort() const
  3465. { return c->getDebugAgentListenerPort(); }
  3466. virtual IStringVal & getDebugAgentListenerIP(IStringVal &ip) const
  3467. { return c->getDebugAgentListenerIP(ip); }
  3468. virtual IStringVal & getXmlParams(IStringVal & params, bool hidePasswords) const
  3469. { return c->getXmlParams(params, hidePasswords); }
  3470. virtual const IPropertyTree *getXmlParams() const
  3471. { return c->getXmlParams(); }
  3472. virtual unsigned __int64 getHash() const
  3473. { return c->getHash(); }
  3474. virtual IStringIterator *getLogs(const char *type, const char *instance) const
  3475. { return c->getLogs(type, instance); }
  3476. virtual IStringIterator *getProcesses(const char *type) const
  3477. { return c->getProcesses(type); }
  3478. virtual IPropertyTreeIterator* getProcesses(const char *type, const char *instance) const
  3479. { return c->getProcesses(type, instance); }
  3480. virtual unsigned getTotalThorTime() const
  3481. { return c->getTotalThorTime(); }
  3482. virtual WUGraphState queryGraphState(const char *graphName) const
  3483. { return c->queryGraphState(graphName); }
  3484. virtual WUGraphState queryNodeState(const char *graphName, WUGraphIDType nodeId) const
  3485. { return c->queryNodeState(graphName, nodeId); }
  3486. virtual void setGraphState(const char *graphName, WUGraphState state) const
  3487. { c->setGraphState(graphName, state); }
  3488. virtual void setNodeState(const char *graphName, WUGraphIDType nodeId, WUGraphState state) const
  3489. { c->setNodeState(graphName, nodeId, state); }
  3490. virtual IWUGraphStats *updateStats(const char *graphName, StatisticCreatorType creatorType, const char * creator, unsigned _wfid, unsigned subgraph) const override
  3491. { return c->updateStats(graphName, creatorType, creator, _wfid, subgraph); }
  3492. virtual void clearGraphProgress() const
  3493. { c->clearGraphProgress(); }
  3494. virtual IStringVal & getAbortBy(IStringVal & str) const
  3495. { return c->getAbortBy(str); }
  3496. virtual unsigned __int64 getAbortTimeStamp() const
  3497. { return c->getAbortTimeStamp(); }
  3498. virtual void clearExceptions()
  3499. { c->clearExceptions(); }
  3500. virtual void commit()
  3501. { c->commit(); }
  3502. virtual IWUException * createException()
  3503. { return c->createException(); }
  3504. virtual void addProcess(const char *type, const char *instance, unsigned pid, const char *log)
  3505. { c->addProcess(type, instance, pid, log); }
  3506. virtual void protect(bool protectMode)
  3507. { c->protect(protectMode); }
  3508. virtual void setAction(WUAction action)
  3509. { c->setAction(action); }
  3510. virtual void setApplicationValue(const char * application, const char * propname, const char * value, bool overwrite)
  3511. { c->setApplicationValue(application, propname, value, overwrite); }
  3512. virtual void setApplicationValueInt(const char * application, const char * propname, int value, bool overwrite)
  3513. { c->setApplicationValueInt(application, propname, value, overwrite); }
  3514. virtual void incEventScheduledCount()
  3515. { c->incEventScheduledCount(); }
  3516. virtual void setIsQueryService(bool value)
  3517. { c->setIsQueryService(value); }
  3518. virtual void setCloneable(bool value)
  3519. { c->setCloneable(value); }
  3520. virtual void setIsClone(bool value)
  3521. { c->setIsClone(value); }
  3522. virtual void setClusterName(const char * value)
  3523. { c->setClusterName(value); }
  3524. virtual void setCodeVersion(unsigned version, const char * buildVersion, const char * eclVersion)
  3525. { c->setCodeVersion(version, buildVersion, eclVersion); }
  3526. virtual void setDebugValue(const char * propname, const char * value, bool overwrite)
  3527. { c->setDebugValue(propname, value, overwrite); }
  3528. virtual void setDebugValueInt(const char * propname, int value, bool overwrite)
  3529. { c->setDebugValueInt(propname, value, overwrite); }
  3530. virtual void setJobName(const char * value)
  3531. { c->setJobName(value); }
  3532. virtual void setPriority(WUPriorityClass cls)
  3533. { c->setPriority(cls); }
  3534. virtual void setPriorityLevel(int level)
  3535. { c->setPriorityLevel(level); }
  3536. virtual void setRescheduleFlag(bool value)
  3537. { c->setRescheduleFlag(value); }
  3538. virtual void setResultLimit(unsigned value)
  3539. { c->setResultLimit(value); }
  3540. virtual void setState(WUState state)
  3541. { c->setState(state); }
  3542. virtual void setStateEx(const char * text)
  3543. { c->setStateEx(text); }
  3544. virtual void setAgentSession(__int64 sessionId)
  3545. { c->setAgentSession(sessionId); }
  3546. virtual void setStatistic(StatisticCreatorType creatorType, const char * creator, StatisticScopeType scopeType, const char * scope, StatisticKind kind, const char * optDescription, unsigned __int64 value, unsigned __int64 count, unsigned __int64 maxValue, StatsMergeAction mergeAction)
  3547. { c->setStatistic(creatorType, creator, scopeType, scope, kind, optDescription, value, count, maxValue, mergeAction); }
  3548. virtual void setTracingValue(const char * propname, const char * value)
  3549. { c->setTracingValue(propname, value); }
  3550. virtual void setTracingValueInt(const char * propname, int value)
  3551. { c->setTracingValueInt(propname, value); }
  3552. virtual void setTracingValueInt64(const char * propname, __int64 value)
  3553. { c->setTracingValueInt64(propname, value); }
  3554. virtual void setUser(const char * value)
  3555. { c->setUser(value); }
  3556. virtual void setWuScope(const char * value)
  3557. { c->setWuScope(value); }
  3558. virtual IWorkflowItem* addWorkflowItem(unsigned wfid, WFType type, WFMode mode, unsigned success, unsigned failure, unsigned recovery, unsigned retriesAllowed, unsigned contingencyFor)
  3559. { return c->addWorkflowItem(wfid, type, mode, success, failure, recovery, retriesAllowed, contingencyFor); }
  3560. virtual void syncRuntimeWorkflow(IWorkflowItemArray * array)
  3561. { c->syncRuntimeWorkflow(array); }
  3562. virtual IWorkflowItemIterator * updateWorkflowItems()
  3563. { return c->updateWorkflowItems(); }
  3564. virtual void resetWorkflow()
  3565. { c->resetWorkflow(); }
  3566. virtual void schedule()
  3567. { c->schedule(); }
  3568. virtual void deschedule()
  3569. { c->deschedule(); }
  3570. virtual unsigned addLocalFileUpload(LocalFileUploadType type, char const * source, char const * destination, char const * eventTag)
  3571. { return c->addLocalFileUpload(type, source, destination, eventTag); }
  3572. virtual IWUResult * updateGlobalByName(const char * name)
  3573. { return c->updateGlobalByName(name); }
  3574. virtual void createGraph(const char * name, const char *label, WUGraphType type, IPropertyTree *xgmml, unsigned wfid)
  3575. { c->createGraph(name, label, type, xgmml, wfid); }
  3576. virtual IWUQuery * updateQuery()
  3577. { return c->updateQuery(); }
  3578. virtual IWUWebServicesInfo * updateWebServicesInfo(bool create)
  3579. { return c->updateWebServicesInfo(create); }
  3580. virtual IWUPlugin * updatePluginByName(const char * name)
  3581. { return c->updatePluginByName(name); }
  3582. virtual IWULibrary * updateLibraryByName(const char * name)
  3583. { return c->updateLibraryByName(name); }
  3584. virtual IWUResult * updateResultByName(const char * name)
  3585. { return c->updateResultByName(name); }
  3586. virtual IWUResult * updateResultBySequence(unsigned seq)
  3587. { return c->updateResultBySequence(seq); }
  3588. virtual IWUResult * updateTemporaryByName(const char * name)
  3589. { return c->updateTemporaryByName(name); }
  3590. virtual IWUResult * updateVariableByName(const char * name)
  3591. { return c->updateVariableByName(name); }
  3592. virtual void addFile(const char *fileName, StringArray *clusters, unsigned usageCount, WUFileKind fileKind, const char *graphOwner)
  3593. { c->addFile(fileName, clusters, usageCount, fileKind, graphOwner); }
  3594. virtual void noteFileRead(IDistributedFile *file)
  3595. { c->noteFileRead(file); }
  3596. virtual void noteFieldUsage(IPropertyTree * usage)
  3597. { c->noteFieldUsage(usage); }
  3598. virtual void releaseFile(const char *fileName)
  3599. { c->releaseFile(fileName); }
  3600. virtual void resetBeforeGeneration()
  3601. { c->resetBeforeGeneration(); }
  3602. virtual void deleteTempFiles(const char *graph, bool deleteOwned, bool deleteJobOwned)
  3603. { c->deleteTempFiles(graph, deleteOwned, deleteJobOwned); }
  3604. virtual void deleteTemporaries()
  3605. { c->deleteTemporaries(); }
  3606. virtual void addDiskUsageStats(__int64 avgNodeUsage, unsigned minNode, __int64 minNodeUsage, unsigned maxNode, __int64 maxNodeUsage, __int64 graphId)
  3607. { c->addDiskUsageStats(avgNodeUsage, minNode, minNodeUsage, maxNode, maxNodeUsage, graphId); }
  3608. virtual IPropertyTree * getDiskUsageStats()
  3609. { return c->getDiskUsageStats(); }
  3610. virtual IPropertyTreeIterator & getFileIterator() const
  3611. { return c->getFileIterator(); }
  3612. virtual IPropertyTreeIterator & getFilesReadIterator() const
  3613. { return c->getFilesReadIterator(); }
  3614. virtual void setSnapshot(const char * value)
  3615. { c->setSnapshot(value); }
  3616. virtual void setWarningSeverity(unsigned code, ErrorSeverity severity)
  3617. { c->setWarningSeverity(code, severity); }
  3618. virtual void setTimeScheduled(const IJlibDateTime &val)
  3619. { c->setTimeScheduled(val); }
  3620. virtual void setDebugAgentListenerPort(unsigned port)
  3621. { c->setDebugAgentListenerPort(port); }
  3622. virtual void setDebugAgentListenerIP(const char * ip)
  3623. { c->setDebugAgentListenerIP(ip); }
  3624. virtual void setXmlParams(const char *params)
  3625. { c->setXmlParams(params); }
  3626. virtual void setXmlParams(IPropertyTree *tree)
  3627. { c->setXmlParams(tree); }
  3628. virtual void setHash(unsigned __int64 hash)
  3629. { c->setHash(hash); }
  3630. // ILocalWorkUnit - used for debugging etc
  3631. virtual void serialize(MemoryBuffer &tgt)
  3632. { c->serialize(tgt); }
  3633. virtual void deserialize(MemoryBuffer &src)
  3634. { c->deserialize(src); }
  3635. virtual bool switchThorQueue(const char *cluster, IQueueSwitcher *qs)
  3636. { return c->switchThorQueue(cluster,qs); }
  3637. virtual void setAllowedClusters(const char *value)
  3638. { c->setAllowedClusters(value); }
  3639. virtual IStringVal& getAllowedClusters(IStringVal &str) const
  3640. { return c->getAllowedClusters(str); }
  3641. virtual void remoteCheckAccess(IUserDescriptor *user, bool writeaccess) const
  3642. { c->remoteCheckAccess(user,writeaccess); }
  3643. virtual void setAllowAutoQueueSwitch(bool val)
  3644. { c->setAllowAutoQueueSwitch(val); }
  3645. virtual bool getAllowAutoQueueSwitch() const
  3646. { return c->getAllowAutoQueueSwitch(); }
  3647. virtual void setLibraryInformation(const char * name, unsigned interfaceHash, unsigned definitionHash)
  3648. { c->setLibraryInformation(name, interfaceHash, definitionHash); }
  3649. virtual void setResultInt(const char * name, unsigned sequence, __int64 val)
  3650. { c->setResultInt(name, sequence, val); }
  3651. virtual void setResultUInt(const char * name, unsigned sequence, unsigned __int64 val)
  3652. { c->setResultUInt(name, sequence, val); }
  3653. virtual void setResultReal(const char *name, unsigned sequence, double val)
  3654. { c->setResultReal(name, sequence, val); }
  3655. virtual void setResultVarString(const char * stepname, unsigned sequence, const char *val)
  3656. { c->setResultVarString(stepname, sequence, val); }
  3657. virtual void setResultVarUnicode(const char * stepname, unsigned sequence, UChar const *val)
  3658. { c->setResultVarUnicode(stepname, sequence, val); }
  3659. virtual void setResultString(const char * stepname, unsigned sequence, int len, const char *val)
  3660. { c->setResultString(stepname, sequence, len, val); }
  3661. virtual void setResultData(const char * stepname, unsigned sequence, int len, const void *val)
  3662. { c->setResultData(stepname, sequence, len, val); }
  3663. virtual void setResultRaw(const char * name, unsigned sequence, int len, const void *val)
  3664. { c->setResultRaw(name, sequence, len, val); }
  3665. virtual void setResultSet(const char * name, unsigned sequence, bool isAll, size32_t len, const void *val, ISetToXmlTransformer *xform)
  3666. { c->setResultSet(name, sequence, isAll, len, val, xform); }
  3667. virtual void setResultUnicode(const char * name, unsigned sequence, int len, UChar const * val)
  3668. { c->setResultUnicode(name, sequence, len, val); }
  3669. virtual void setResultBool(const char *name, unsigned sequence, bool val)
  3670. { c->setResultBool(name, sequence, val); }
  3671. virtual void setResultDecimal(const char *name, unsigned sequence, int len, int precision, bool isSigned, const void *val)
  3672. { c->setResultDecimal(name, sequence, len, precision, isSigned, val); }
  3673. virtual void setResultDataset(const char * name, unsigned sequence, size32_t len, const void *val, unsigned numRows, bool extend)
  3674. { c->setResultDataset(name, sequence, len, val, numRows, extend); }
  3675. };
  3676. class CLocalWUAssociated : implements IConstWUAssociatedFile, public CInterface
  3677. {
  3678. Owned<IPropertyTree> p;
  3679. public:
  3680. IMPLEMENT_IINTERFACE;
  3681. CLocalWUAssociated(IPropertyTree *p);
  3682. virtual WUFileType getType() const;
  3683. virtual IStringVal & getDescription(IStringVal & ret) const;
  3684. virtual IStringVal & getIp(IStringVal & ret) const;
  3685. virtual IStringVal & getName(IStringVal & ret) const;
  3686. virtual IStringVal & getNameTail(IStringVal & ret) const;
  3687. virtual unsigned getCrc() const;
  3688. virtual unsigned getMinActivityId() const;
  3689. virtual unsigned getMaxActivityId() const;
  3690. };
  3691. class CLocalWUQuery : implements IWUQuery, public CInterface
  3692. {
  3693. Owned<IPropertyTree> p;
  3694. mutable IArrayOf<IConstWUAssociatedFile> associated;
  3695. mutable CriticalSection crit;
  3696. mutable bool associatedCached;
  3697. private:
  3698. void addSpecialCaseAssociated(WUFileType type, const char * propname, unsigned crc) const;
  3699. void loadAssociated() const;
  3700. public:
  3701. IMPLEMENT_IINTERFACE;
  3702. CLocalWUQuery(IPropertyTree *p);
  3703. virtual WUQueryType getQueryType() const;
  3704. virtual IStringVal& getQueryText(IStringVal &str) const;
  3705. virtual IStringVal& getQueryShortText(IStringVal &str) const;
  3706. virtual IStringVal& getQueryName(IStringVal &str) const;
  3707. virtual IStringVal & getQueryMainDefinition(IStringVal & str) const;
  3708. virtual IStringVal& getQueryDllName(IStringVal &str) const;
  3709. virtual unsigned getQueryDllCrc() const;
  3710. virtual IStringVal& getQueryCppName(IStringVal &str) const;
  3711. virtual IStringVal& getQueryResTxtName(IStringVal &str) const;
  3712. virtual IConstWUAssociatedFile * getAssociatedFile(WUFileType type, unsigned index) const;
  3713. virtual IConstWUAssociatedFileIterator& getAssociatedFiles() const;
  3714. virtual bool isArchive() const;
  3715. virtual bool hasArchive() const
  3716. {
  3717. return p->getPropBool("@hasArchive");
  3718. }
  3719. virtual void setQueryType(WUQueryType qt);
  3720. virtual void setQueryText(const char *pstr);
  3721. virtual void setQueryName(const char *);
  3722. virtual void setQueryMainDefinition(const char * str);
  3723. virtual void addAssociatedFile(WUFileType type, const char * name, const char * ip, const char * desc, unsigned crc, unsigned minActivity, unsigned maxActivity);
  3724. virtual void removeAssociatedFiles();
  3725. virtual void removeAssociatedFile(WUFileType type, const char * name, const char * desc);
  3726. };
  3727. class CLocalWUWebServicesInfo : implements IWUWebServicesInfo, public CInterface
  3728. {
  3729. Owned<IPropertyTree> p;
  3730. mutable CriticalSection crit;
  3731. private:
  3732. public:
  3733. IMPLEMENT_IINTERFACE;
  3734. CLocalWUWebServicesInfo(IPropertyTree *p);
  3735. virtual IStringVal& getModuleName(IStringVal &str) const;
  3736. virtual IStringVal& getAttributeName(IStringVal &str) const;
  3737. virtual IStringVal& getDefaultName(IStringVal &str) const;
  3738. virtual IStringVal& getInfo(const char *name, IStringVal &str) const;
  3739. virtual IStringVal& getText(const char *name, IStringVal &str) const;
  3740. virtual unsigned getWebServicesCRC() const;
  3741. virtual void setModuleName(const char *);
  3742. virtual void setAttributeName(const char *);
  3743. virtual void setDefaultName(const char *);
  3744. virtual void setInfo(const char *name, const char *info);
  3745. virtual void setText(const char *name, const char *info);
  3746. virtual void setWebServicesCRC(unsigned);
  3747. };
  3748. class CLocalWUResult : implements IWUResult, public CInterface
  3749. {
  3750. friend class CLocalWorkUnit;
  3751. mutable CriticalSection crit;
  3752. Owned<IPropertyTree> p;
  3753. Owned<IProperties> xmlns;
  3754. public:
  3755. IMPLEMENT_IINTERFACE;
  3756. CLocalWUResult(IPropertyTree *props);
  3757. ~CLocalWUResult() { try { p.clear(); } catch (IException *E) {E->Release();}}
  3758. virtual WUResultStatus getResultStatus() const;
  3759. virtual IStringVal& getResultName(IStringVal &str) const;
  3760. virtual int getResultSequence() const;
  3761. virtual bool isResultScalar() const;
  3762. virtual IStringVal& getResultXml(IStringVal &str, bool hidePasswords) const;
  3763. virtual unsigned getResultFetchSize() const;
  3764. virtual __int64 getResultTotalRowCount() const;
  3765. virtual __int64 getResultRowCount() const;
  3766. virtual void getResultDataset(IStringVal & ecl, IStringVal & defs) const;
  3767. virtual IStringVal& getResultLogicalName(IStringVal &ecl) const;
  3768. virtual IStringVal& getResultKeyField(IStringVal& ecl) const;
  3769. virtual unsigned getResultRequestedRows() const;
  3770. virtual __int64 getResultInt() const;
  3771. virtual bool getResultBool() const;
  3772. virtual double getResultReal() const;
  3773. virtual IStringVal& getResultString(IStringVal & str, bool hidePassword) const;
  3774. virtual IDataVal& getResultRaw(IDataVal & data, IXmlToRawTransformer * xmlTransformer, ICsvToRawTransformer * csvTransformer) const;
  3775. virtual IDataVal& getResultUnicode(IDataVal & data) const;
  3776. virtual void getResultDecimal(void * val, unsigned length, unsigned precision, bool isSigned) const;
  3777. virtual IStringVal& getResultEclSchema(IStringVal & str) const;
  3778. virtual __int64 getResultRawSize(IXmlToRawTransformer * xmlTransformer, ICsvToRawTransformer * csvTransformer) const;
  3779. virtual IDataVal& getResultRaw(IDataVal & data, __int64 from, __int64 length, IXmlToRawTransformer * xmlTransformer, ICsvToRawTransformer * csvTransformer) const;
  3780. virtual IStringVal& getResultRecordSizeEntry(IStringVal & str) const;
  3781. virtual IStringVal& getResultTransformerEntry(IStringVal & str) const;
  3782. virtual __int64 getResultRowLimit() const;
  3783. virtual IStringVal& getResultFilename(IStringVal & str) const;
  3784. virtual WUResultFormat getResultFormat() const;
  3785. virtual unsigned getResultHash() const;
  3786. virtual bool getResultIsAll() const;
  3787. virtual IProperties *queryResultXmlns();
  3788. virtual IStringVal& getResultFieldOpt(const char *name, IStringVal &str) const;
  3789. virtual void getSchema(IArrayOf<ITypeInfo> &types, StringAttrArray &names, IStringVal * ecl=NULL) const;
  3790. virtual void getResultWriteLocation(IStringVal & _graph, unsigned & _activityId) const;
  3791. // interface IWUResult
  3792. virtual void setResultStatus(WUResultStatus status);
  3793. virtual void setResultName(const char *name);
  3794. virtual void setResultSequence(unsigned seq);
  3795. virtual void setResultSchemaRaw(unsigned len, const void *schema);
  3796. virtual void setResultScalar(bool isScalar);
  3797. virtual void setResultRaw(unsigned len, const void *xml, WUResultFormat format);
  3798. virtual void setResultFetchSize(unsigned rows); // 0 means file-loaded
  3799. virtual void setResultTotalRowCount(__int64 rows); // -1 means unknown
  3800. virtual void setResultRowCount(__int64 rows);
  3801. virtual void setResultDataset(const char *ecl, const char *defs);
  3802. virtual void setResultLogicalName(const char *logicalName);
  3803. virtual void setResultKeyField(const char * name);
  3804. virtual void setResultRequestedRows(unsigned req);
  3805. virtual void setResultRecordSizeEntry(const char * val);
  3806. virtual void setResultTransformerEntry(const char * val);
  3807. virtual void setResultInt(__int64 val);
  3808. virtual void setResultReal(double val);
  3809. virtual void setResultBool(bool val);
  3810. virtual void setResultString(const char * val, unsigned length);
  3811. virtual void setResultUnicode(const void * val, unsigned length);
  3812. virtual void setResultData(const void * val, unsigned length);
  3813. virtual void setResultDecimal(const void * val, unsigned length);
  3814. virtual void addResultRaw(unsigned len, const void * data, WUResultFormat format);
  3815. virtual void setResultRowLimit(__int64 value);
  3816. virtual void setResultFilename(const char * name);
  3817. virtual void setResultUInt(unsigned __int64 val);
  3818. virtual void setResultIsAll(bool value);
  3819. virtual void setResultFormat(WUResultFormat format);
  3820. virtual void setResultXML(const char *val);
  3821. virtual void setResultRow(unsigned len, const void * data);
  3822. virtual void setResultXmlns(const char *prefix, const char *uri);
  3823. virtual void setResultFieldOpt(const char *name, const char *value);
  3824. virtual void setResultWriteLocation(const char * _graph, unsigned _activityId);
  3825. virtual IPropertyTree *queryPTree() { return p; }
  3826. };
  3827. class CLocalWUPlugin : implements IWUPlugin, public CInterface
  3828. {
  3829. Owned<IPropertyTree> p;
  3830. public:
  3831. IMPLEMENT_IINTERFACE;
  3832. CLocalWUPlugin(IPropertyTree *p);
  3833. virtual IStringVal& getPluginName(IStringVal &str) const;
  3834. virtual IStringVal& getPluginVersion(IStringVal &str) const;
  3835. virtual void setPluginName(const char *str);
  3836. virtual void setPluginVersion(const char *str);
  3837. };
  3838. class CLocalWULibrary : implements IWULibrary, public CInterface
  3839. {
  3840. Owned<IPropertyTree> p;
  3841. public:
  3842. IMPLEMENT_IINTERFACE;
  3843. CLocalWULibrary(IPropertyTree *p);
  3844. virtual IStringVal & getName(IStringVal & str) const;
  3845. virtual void setName(const char * str);
  3846. };
  3847. class CLocalWUException : implements IWUException, public CInterface
  3848. {
  3849. Owned<IPropertyTree> p;
  3850. public:
  3851. IMPLEMENT_IINTERFACE;
  3852. CLocalWUException(IPropertyTree *p);
  3853. virtual IStringVal& getExceptionSource(IStringVal &str) const override;
  3854. virtual IStringVal& getExceptionMessage(IStringVal &str) const override;
  3855. virtual unsigned getExceptionCode() const override;
  3856. virtual ErrorSeverity getSeverity() const override;
  3857. virtual IStringVal & getTimeStamp(IStringVal & dt) const override;
  3858. virtual IStringVal & getExceptionFileName(IStringVal & str) const override;
  3859. virtual unsigned getExceptionLineNo() const override;
  3860. virtual unsigned getExceptionColumn() const override;
  3861. virtual unsigned getActivityId() const override;
  3862. virtual unsigned getSequence() const override;
  3863. virtual const char * queryScope() const override;
  3864. virtual unsigned getPriority() const override;
  3865. virtual void setExceptionSource(const char *str) override;
  3866. virtual void setExceptionMessage(const char *str) override;
  3867. virtual void setExceptionCode(unsigned code) override;
  3868. virtual void setSeverity(ErrorSeverity level) override;
  3869. virtual void setTimeStamp(const char * dt) override;
  3870. virtual void setExceptionFileName(const char *str) override;
  3871. virtual void setExceptionLineNo(unsigned r) override;
  3872. virtual void setExceptionColumn(unsigned c) override;
  3873. virtual void setActivityId(unsigned _id) override;
  3874. virtual void setScope(const char * _scope) override;
  3875. virtual void setPriority(unsigned _priority) override;
  3876. };
  3877. //==========================================================================================
  3878. extern WORKUNIT_API bool isSpecialResultSequence(unsigned sequence)
  3879. {
  3880. switch ((int) sequence)
  3881. {
  3882. case ResultSequenceInternal:
  3883. case ResultSequenceOnce:
  3884. case ResultSequencePersist:
  3885. case ResultSequenceStored:
  3886. return true;
  3887. default:
  3888. assertex(sequence <= INT_MAX);
  3889. return false;
  3890. }
  3891. }
  3892. class CConstWUArrayIterator : implements IConstWorkUnitIterator, public CInterface
  3893. {
  3894. unsigned curTreeNum;
  3895. IArrayOf<IPropertyTree> trees;
  3896. Owned<IConstWorkUnitInfo> cur;
  3897. void setCurrent()
  3898. {
  3899. cur.setown(new CLightweightWorkunitInfo(trees.item(curTreeNum)));
  3900. }
  3901. public:
  3902. IMPLEMENT_IINTERFACE;
  3903. CConstWUArrayIterator(IArrayOf<IPropertyTree> &_trees)
  3904. {
  3905. ForEachItemIn(t, _trees)
  3906. trees.append(*LINK(&_trees.item(t)));
  3907. curTreeNum = 0;
  3908. }
  3909. bool first()
  3910. {
  3911. curTreeNum = 0;
  3912. return next();
  3913. }
  3914. bool isValid()
  3915. {
  3916. return (NULL != cur.get());
  3917. }
  3918. bool next()
  3919. {
  3920. if (curTreeNum >= trees.ordinality())
  3921. {
  3922. cur.clear();
  3923. return false;
  3924. }
  3925. setCurrent();
  3926. ++curTreeNum;
  3927. return true;
  3928. }
  3929. IConstWorkUnitInfo & query() { return *cur; }
  3930. };
  3931. class CLocalWUFieldUsage : public CInterface, implements IConstWUFieldUsage
  3932. {
  3933. Owned<IPropertyTree> p;
  3934. public:
  3935. IMPLEMENT_IINTERFACE;
  3936. CLocalWUFieldUsage(IPropertyTree& _p) { p.setown(&_p); }
  3937. virtual const char * queryName() const { return p->queryProp("@name"); }
  3938. };
  3939. class CConstWUFieldUsageIterator : public CInterface, implements IConstWUFieldUsageIterator
  3940. {
  3941. public:
  3942. IMPLEMENT_IINTERFACE;
  3943. CConstWUFieldUsageIterator(IPropertyTreeIterator * tree) { iter.setown(tree); }
  3944. bool first() override { return iter->first(); }
  3945. bool isValid() override { return iter->isValid(); }
  3946. bool next() override { return iter->next(); }
  3947. IConstWUFieldUsage * get() const override { return new CLocalWUFieldUsage(iter->get()); }
  3948. private:
  3949. Owned<IPropertyTreeIterator> iter;
  3950. };
  3951. class CLocalWUFileUsage : public CInterface, implements IConstWUFileUsage
  3952. {
  3953. Owned<IPropertyTree> p;
  3954. public:
  3955. IMPLEMENT_IINTERFACE;
  3956. CLocalWUFileUsage(IPropertyTree& _p) { p.setown(&_p); }
  3957. virtual const char * queryName() const { return p->queryProp("@name"); }
  3958. virtual const char * queryType() const { return p->queryProp("@type"); }
  3959. virtual unsigned getNumFields() const { return p->getPropInt("@numFields"); }
  3960. virtual unsigned getNumFieldsUsed() const { return p->getPropInt("@numFieldsUsed"); }
  3961. virtual IConstWUFieldUsageIterator * getFields() const { return new CConstWUFieldUsageIterator(p->getElements("fields/field")); }
  3962. };
  3963. class CConstWUFileUsageIterator : public CInterface, implements IConstWUFileUsageIterator
  3964. {
  3965. public:
  3966. IMPLEMENT_IINTERFACE;
  3967. CConstWUFileUsageIterator(IPropertyTreeIterator * tree) { iter.setown(tree); }
  3968. bool first() override { return iter->first(); }
  3969. bool isValid() override { return iter->isValid(); }
  3970. bool next() override { return iter->next(); }
  3971. IConstWUFileUsage * get() const override { return new CLocalWUFileUsage(iter->get()); }
  3972. private:
  3973. Owned<IPropertyTreeIterator> iter;
  3974. };
  3975. //==========================================================================================
  3976. class CStringArrayIterator : implements IStringIterator, public CInterface
  3977. {
  3978. unsigned idx;
  3979. StringArray strings;
  3980. public:
  3981. IMPLEMENT_IINTERFACE;
  3982. CStringArrayIterator() { idx = 0; };
  3983. void append(const char *str) { strings.append(str); }
  3984. virtual bool first() { idx = 0; return strings.isItem(idx); }
  3985. virtual bool next() { idx ++; return strings.isItem(idx); }
  3986. virtual bool isValid() { return strings.isItem(idx); }
  3987. virtual IStringVal & str(IStringVal &s) { s.set(strings.item(idx)); return s; }
  3988. };
  3989. class CCachedJobNameIterator : implements IStringIterator, public CInterface
  3990. {
  3991. Owned<IPropertyTreeIterator> it;
  3992. public:
  3993. IMPLEMENT_IINTERFACE;
  3994. CCachedJobNameIterator(IPropertyTreeIterator *p) : it(p) {};
  3995. virtual bool first() { return it->first(); }
  3996. virtual bool next() { return it->next(); }
  3997. virtual bool isValid() { return it->isValid(); }
  3998. virtual IStringVal & str(IStringVal &s) { s.set(it->query().queryName()+1); return s; }
  3999. };
  4000. class CEmptyStringIterator : implements IStringIterator, public CInterface
  4001. {
  4002. public:
  4003. IMPLEMENT_IINTERFACE;
  4004. virtual bool first() { return false; }
  4005. virtual bool next() { return false; }
  4006. virtual bool isValid() { return false; }
  4007. virtual IStringVal & str(IStringVal &s) { s.clear(); return s; }
  4008. };
  4009. EnumMapping workunitSortFields[] =
  4010. {
  4011. { WUSFuser, "@submitID" },
  4012. { WUSFcluster, "@clusterName" },
  4013. { WUSFjob, "@jobName" },
  4014. { WUSFstate, "@state" },
  4015. { WUSFpriority, "@priorityClass" },
  4016. { WUSFprotected, "@protected" },
  4017. { WUSFwuid, "@" },
  4018. { WUSFecl, "Query/ShortText" },
  4019. { WUSFfileread, "FilesRead/File/@name" },
  4020. { WUSFtotalthortime, "@totalThorTime|"
  4021. "Statistics/Statistic[@c='summary'][@creator='thor'][@kind='TimeElapsed']/@value|"
  4022. "Statistics/Statistic[@c='summary'][@creator='hthor'][@kind='TimeElapsed']/@value|"
  4023. "Statistics/Statistic[@c='summary'][@creator='roxie'][@kind='TimeElapsed']/@value|"
  4024. "Statistics/Statistic[@desc='Total thor time']/@value|"
  4025. "Timings/Timing[@name='Total thor time']/@duration" //Use Statistics first. If not found, use Timings
  4026. },
  4027. { WUSFwuidhigh, "@" },
  4028. { WUSFwildwuid, "@" },
  4029. { WUSFappvalue, "Application" },
  4030. { WUSFfilewritten, "Files/File/@name" },
  4031. { WUSFterm, NULL }
  4032. };
  4033. extern const char *queryFilterXPath(WUSortField field)
  4034. {
  4035. return getEnumText(field, workunitSortFields);
  4036. }
  4037. EnumMapping querySortFields[] =
  4038. {
  4039. { WUQSFId, "@id" },
  4040. { WUQSFwuid, "@wuid" },
  4041. { WUQSFname, "@name" },
  4042. { WUQSFdll, "@dll" },
  4043. { WUQSFmemoryLimit, "@memoryLimit" },
  4044. { WUQSFmemoryLimitHi, "@memoryLimit" },
  4045. { WUQSFtimeLimit, "@timeLimit" },
  4046. { WUQSFtimeLimitHi, "@timeLimit" },
  4047. { WUQSFwarnTimeLimit, "@warnTimeLimit" },
  4048. { WUQSFwarnTimeLimitHi, "@warnTimeLimit" },
  4049. { WUQSFpriority, "@priority" },
  4050. { WUQSFpriorityHi, "@priority" },
  4051. { WUQSFQuerySet, "@querySetId" },
  4052. { WUQSFActivited, "@activated" },
  4053. { WUQSFSuspendedByUser, "@suspended" },
  4054. { WUQSFLibrary, "Library"},
  4055. { WUQSFPublishedBy, "@publishedBy" },
  4056. { WUQSFterm, NULL }
  4057. };
  4058. class asyncRemoveDllWorkItem: public CInterface, implements IWorkQueueItem // class only used in asyncRemoveDll
  4059. {
  4060. StringAttr name;
  4061. public:
  4062. IMPLEMENT_IINTERFACE;
  4063. asyncRemoveDllWorkItem(const char * _name) : name(_name)
  4064. {
  4065. }
  4066. void execute()
  4067. {
  4068. PROGLOG("WU removeDll %s", name.get());
  4069. queryDllServer().removeDll(name, true, true); // <name>, removeDlls=true, removeDirectory=true
  4070. }
  4071. };
  4072. class asyncRemoveRemoteFileWorkItem: public CInterface, implements IWorkQueueItem // class only used in asyncRemoveFile
  4073. {
  4074. RemoteFilename name;
  4075. public:
  4076. IMPLEMENT_IINTERFACE;
  4077. asyncRemoveRemoteFileWorkItem(const char * _ip, const char * _name)
  4078. {
  4079. SocketEndpoint ep(_ip);
  4080. name.setPath(ep, _name);
  4081. }
  4082. void execute()
  4083. {
  4084. Owned<IFile> file = createIFile(name);
  4085. PROGLOG("WU removeDll %s",file->queryFilename());
  4086. file->remove();
  4087. }
  4088. };
  4089. //==========================================================================================
  4090. class CConstQuerySetQueryIterator : implements IConstQuerySetQueryIterator, public CInterface
  4091. {
  4092. unsigned index;
  4093. IArrayOf<IPropertyTree> trees;
  4094. public:
  4095. IMPLEMENT_IINTERFACE;
  4096. CConstQuerySetQueryIterator(IArrayOf<IPropertyTree> &_trees)
  4097. {
  4098. ForEachItemIn(t, _trees)
  4099. trees.append(*LINK(&_trees.item(t)));
  4100. index = 0;
  4101. }
  4102. ~CConstQuerySetQueryIterator()
  4103. {
  4104. trees.kill();
  4105. }
  4106. bool first()
  4107. {
  4108. index = 0;
  4109. return (trees.ordinality()!=0);
  4110. }
  4111. bool next()
  4112. {
  4113. index++;
  4114. return (index<trees.ordinality());
  4115. }
  4116. bool isValid()
  4117. {
  4118. return (index<trees.ordinality());
  4119. }
  4120. IPropertyTree &query()
  4121. {
  4122. return trees.item(index);
  4123. }
  4124. };
  4125. class CSecurityCache
  4126. {
  4127. };
  4128. class CConstWUIterator : implements IConstWorkUnitIterator, public CInterface
  4129. {
  4130. public:
  4131. IMPLEMENT_IINTERFACE;
  4132. CConstWUIterator(IPropertyTreeIterator *_ptreeIter)
  4133. : ptreeIter(_ptreeIter)
  4134. {
  4135. }
  4136. bool first()
  4137. {
  4138. if (!ptreeIter->first())
  4139. {
  4140. cur.clear();
  4141. return false;
  4142. }
  4143. cur.setown(new CLightweightWorkunitInfo(ptreeIter->query()));
  4144. return true;
  4145. }
  4146. bool isValid()
  4147. {
  4148. return (NULL != cur.get());
  4149. }
  4150. bool next()
  4151. {
  4152. if (!ptreeIter->next())
  4153. {
  4154. cur.clear();
  4155. return false;
  4156. }
  4157. cur.setown(new CLightweightWorkunitInfo(ptreeIter->query()));
  4158. return true;
  4159. }
  4160. IConstWorkUnitInfo & query() { return *cur; }
  4161. private:
  4162. Owned<IConstWorkUnitInfo> cur;
  4163. Owned<IPropertyTreeIterator> ptreeIter;
  4164. };
  4165. class CSecureConstWUIterator : public CInterfaceOf<IConstWorkUnitIterator>
  4166. {
  4167. public:
  4168. CSecureConstWUIterator(IConstWorkUnitIterator *_parent, ISecManager *_secmgr=NULL, ISecUser *_secuser=NULL)
  4169. : parent(_parent), secmgr(_secmgr), secuser(_secuser)
  4170. {
  4171. assertex(_secuser && _secmgr);
  4172. }
  4173. bool first()
  4174. {
  4175. if (!parent->first())
  4176. return false;
  4177. return getNext();
  4178. }
  4179. bool next()
  4180. {
  4181. if (!parent->next())
  4182. return false;
  4183. return getNext();
  4184. }
  4185. virtual bool isValid()
  4186. {
  4187. return parent->isValid();
  4188. }
  4189. virtual IConstWorkUnitInfo &query()
  4190. {
  4191. return parent->query();
  4192. }
  4193. private:
  4194. Owned<IConstWorkUnitIterator> parent;
  4195. MapStringTo<int> scopePermissions;
  4196. Linked<ISecManager> secmgr;
  4197. Linked<ISecUser> secuser;
  4198. bool getNext() // scan for a workunit with permissions
  4199. {
  4200. do
  4201. {
  4202. const char *scopeName = parent->query().queryWuScope();
  4203. if (!scopeName || !*scopeName || checkScope(scopeName))
  4204. return true;
  4205. } while (parent->next());
  4206. return false;
  4207. }
  4208. bool checkScope(const char *scopeName)
  4209. {
  4210. int *perms = scopePermissions.getValue(scopeName);
  4211. SecAccessFlags perm;
  4212. if (!perms)
  4213. {
  4214. perm = secuser.get() ? secmgr->authorizeWorkunitScope(*secuser, scopeName) : SecAccess_Unavailable;
  4215. scopePermissions.setValue(scopeName, perm);
  4216. }
  4217. else
  4218. perm = (SecAccessFlags)*perms;
  4219. return perm >= SecAccess_Read;
  4220. }
  4221. };
  4222. CWorkUnitFactory::CWorkUnitFactory()
  4223. {
  4224. }
  4225. CWorkUnitFactory::~CWorkUnitFactory()
  4226. {
  4227. }
  4228. IWorkUnit* CWorkUnitFactory::createNamedWorkUnit(const char *wuid, const char *app, const char *scope, ISecManager *secmgr, ISecUser *secuser)
  4229. {
  4230. checkWuScopeSecAccess(scope, secmgr, secuser, SecAccess_Write, "Create", true, true);
  4231. Owned<CLocalWorkUnit> cw = _createWorkUnit(wuid, secmgr, secuser);
  4232. if (scope)
  4233. cw->setWuScope(scope); // Note - this may check access rights and throw exception. Is that correct? We might prefer to only check access once, and this will check on the lock too...
  4234. cw->setDistributedAccessToken(secuser ? secuser->getName() : "");//create and sign the workunit distributed access token
  4235. IWorkUnit* ret = &cw->lockRemote(false); // Note - this may throw exception if user does not have rights.
  4236. ret->setDebugValue("CREATED_BY", app, true);
  4237. ret->setDebugValue("CREATED_FOR", scope, true);
  4238. return ret;
  4239. }
  4240. IWorkUnit* CWorkUnitFactory::createWorkUnit(const char *app, const char *scope, ISecManager *secmgr, ISecUser *secuser)
  4241. {
  4242. StringBuffer wuid("W");
  4243. char result[32];
  4244. time_t ltime;
  4245. time( &ltime );
  4246. tm *today = localtime( &ltime ); // MORE - this is not threadsafe. But I probably don't care that much!
  4247. strftime(result, sizeof(result), "%Y%m%d-%H%M%S", today);
  4248. wuid.append(result);
  4249. if (workUnitTraceLevel > 1)
  4250. PrintLog("createWorkUnit created %s", wuid.str());
  4251. IWorkUnit* ret = createNamedWorkUnit(wuid.str(), app, scope, secmgr, secuser);
  4252. if (workUnitTraceLevel > 1)
  4253. PrintLog("createWorkUnit created %s", ret->queryWuid());
  4254. addTimeStamp(ret, SSTglobal, NULL, StWhenCreated);
  4255. return ret;
  4256. }
  4257. bool CWorkUnitFactory::deleteWorkUnitEx(const char * wuid, bool throwException, ISecManager *secmgr, ISecUser *secuser)
  4258. {
  4259. if (workUnitTraceLevel > 1)
  4260. PrintLog("deleteWorkUnit %s", wuid);
  4261. StringBuffer wuRoot;
  4262. getXPath(wuRoot, wuid);
  4263. Owned<CLocalWorkUnit> cw = _updateWorkUnit(wuid, secmgr, secuser);
  4264. if (!checkWuSecAccess(*cw.get(), secmgr, secuser, SecAccess_Full, "delete", true, true))
  4265. return false;
  4266. if (throwException)
  4267. cw->cleanupAndDelete(true, true);
  4268. else
  4269. {
  4270. try
  4271. {
  4272. cw->cleanupAndDelete(true, true);
  4273. }
  4274. catch (IException *E)
  4275. {
  4276. StringBuffer s;
  4277. LOG(MCexception(E, MSGCLS_warning), E, s.append("Exception during deleteWorkUnit: ").append(wuid).str());
  4278. E->Release();
  4279. return false;
  4280. }
  4281. }
  4282. removeWorkUnitFromAllQueues(wuid); //known active workunits wouldn't make it this far
  4283. return true;
  4284. }
  4285. bool CWorkUnitFactory::deleteWorkUnit(const char * wuid, ISecManager *secmgr, ISecUser *secuser)
  4286. {
  4287. return deleteWorkUnitEx(wuid, false, secmgr, secuser);
  4288. }
  4289. IConstWorkUnit* CWorkUnitFactory::openWorkUnit(const char *wuid, ISecManager *secmgr, ISecUser *secuser)
  4290. {
  4291. StringBuffer wuidStr(wuid);
  4292. wuidStr.trim();
  4293. if (wuidStr.length() && ('w' == wuidStr.charAt(0)))
  4294. wuidStr.setCharAt(0, 'W');
  4295. if (!wuidStr.length() || ('W' != wuidStr.charAt(0)))
  4296. {
  4297. if (workUnitTraceLevel > 1)
  4298. PrintLog("openWorkUnit %s invalid WUID", nullText(wuidStr.str()));
  4299. return NULL;
  4300. }
  4301. if (workUnitTraceLevel > 1)
  4302. PrintLog("openWorkUnit %s", wuidStr.str());
  4303. Owned<IConstWorkUnit> wu = _openWorkUnit(wuid, secmgr, secuser);
  4304. if (wu)
  4305. {
  4306. if (!checkWuSecAccess(*wu, secmgr, secuser, SecAccess_Read, "opening", true, true))
  4307. return NULL; // Actually throws exception on failure, so won't reach here
  4308. return wu.getClear();
  4309. }
  4310. else
  4311. {
  4312. if (workUnitTraceLevel > 0)
  4313. PrintLog("openWorkUnit %s not found", wuidStr.str());
  4314. return NULL;
  4315. }
  4316. }
  4317. IWorkUnit* CWorkUnitFactory::updateWorkUnit(const char *wuid, ISecManager *secmgr, ISecUser *secuser)
  4318. {
  4319. if (workUnitTraceLevel > 1)
  4320. PrintLog("updateWorkUnit %s", wuid);
  4321. Owned<CLocalWorkUnit> wu = _updateWorkUnit(wuid, secmgr, secuser);
  4322. if (wu)
  4323. {
  4324. if (!checkWuSecAccess(*wu.get(), secmgr, secuser, SecAccess_Write, "updating", true, true))
  4325. return NULL;
  4326. return &wu->lockRemote(false);
  4327. }
  4328. else
  4329. {
  4330. if (workUnitTraceLevel > 0)
  4331. PrintLog("updateWorkUnit %s not found", wuid);
  4332. return NULL;
  4333. }
  4334. }
  4335. IPropertyTree * pruneBranch(IPropertyTree * from, char const * xpath)
  4336. {
  4337. Owned<IPropertyTree> ret;
  4338. IPropertyTree * branch = from->queryPropTree(xpath);
  4339. if(branch)
  4340. {
  4341. ret.setown(createPTreeFromIPT(branch));
  4342. from->removeTree(branch);
  4343. }
  4344. return ret.getClear();
  4345. }
  4346. bool CWorkUnitFactory::restoreWorkUnit(const char *base, const char *wuid, bool restoreAssociated)
  4347. {
  4348. StringBuffer path(base);
  4349. addPathSepChar(path).append(wuid).append(".xml");
  4350. Owned<IPTree> pt = createPTreeFromXMLFile(path);
  4351. if (!pt)
  4352. return false;
  4353. CDateTime dt;
  4354. dt.setNow();
  4355. StringBuffer dts;
  4356. dt.getString(dts);
  4357. pt->setProp("@restoredDate", dts.str());
  4358. Owned<IPropertyTree> generatedDlls = pruneBranch(pt, "GeneratedDlls[1]");
  4359. Owned<IPropertyTree> associatedFiles;
  4360. IPropertyTree *srcAssociated = pt->queryPropTree("Query/Associated");
  4361. if (srcAssociated)
  4362. associatedFiles.setown(createPTreeFromIPT(srcAssociated));
  4363. // The updating of the repo is implementation specific...
  4364. if (!_restoreWorkUnit(pt.getClear(), wuid))
  4365. return false;
  4366. // now kludge back GeneratedDlls
  4367. if (generatedDlls)
  4368. {
  4369. Owned<IPropertyTreeIterator> dlls = generatedDlls->getElements("GeneratedDll");
  4370. for(dlls->first(); dlls->isValid(); dlls->next())
  4371. {
  4372. IPropertyTree & dll = dlls->query();
  4373. char const * name = dll.queryProp("@name");
  4374. char const * kind = dll.queryProp("@kind");
  4375. char const * location = dll.queryProp("@location");
  4376. Owned<IDllEntry> got = queryDllServer().getEntry(name);
  4377. if (!got)
  4378. {
  4379. RemoteFilename dstRfn;
  4380. dstRfn.setRemotePath(location);
  4381. StringBuffer srcPath(base);
  4382. addPathSepChar(srcPath);
  4383. dstRfn.getTail(srcPath);
  4384. OwnedIFile srcFile = createIFile(srcPath);
  4385. OwnedIFile dstFile = createIFile(dstRfn);
  4386. copyFile(dstFile, srcFile);
  4387. queryDllServer().registerDll(name, kind, location);
  4388. }
  4389. }
  4390. }
  4391. if (associatedFiles)
  4392. {
  4393. Owned<IPropertyTreeIterator> associated = associatedFiles->getElements("*");
  4394. ForEach(*associated)
  4395. {
  4396. IPropertyTree &file = associated->query();
  4397. const char *filename = file.queryProp("@filename");
  4398. SocketEndpoint ep(file.queryProp("@ip"));
  4399. RemoteFilename rfn;
  4400. rfn.setPath(ep, filename);
  4401. OwnedIFile dstFile = createIFile(rfn);
  4402. StringBuffer srcPath(base), name;
  4403. addPathSepChar(srcPath);
  4404. rfn.getTail(name);
  4405. srcPath.append(name);
  4406. if (generatedDlls)
  4407. {
  4408. VStringBuffer gDllPath("GeneratedDll[@name=\"%s\"]", name.str());
  4409. if (generatedDlls->hasProp(gDllPath))
  4410. continue; // generated dlls handled separately - see above
  4411. }
  4412. OwnedIFile srcFile = createIFile(srcPath);
  4413. if (srcFile->exists())
  4414. {
  4415. try
  4416. {
  4417. copyFile(dstFile, srcFile);
  4418. }
  4419. catch (IException *e)
  4420. {
  4421. VStringBuffer msg("Failed to restore associated file '%s' to destination '%s'", srcFile->queryFilename(), dstFile->queryFilename());
  4422. EXCLOG(e, msg.str());
  4423. e->Release();
  4424. }
  4425. }
  4426. }
  4427. }
  4428. return true;
  4429. }
  4430. int CWorkUnitFactory::setTracingLevel(int newLevel)
  4431. {
  4432. if (newLevel)
  4433. PrintLog("Setting workunit trace level to %d", newLevel);
  4434. int level = workUnitTraceLevel;
  4435. workUnitTraceLevel = newLevel;
  4436. return level;
  4437. }
  4438. void CWorkUnitFactory::descheduleAllWorkUnits(ISecManager *secmgr, ISecUser *secuser)
  4439. {
  4440. Owned<IRemoteConnection> conn = querySDS().connect("/Schedule", myProcessSession(), RTM_LOCK_WRITE, SDS_LOCK_TIMEOUT);
  4441. if(!conn) return;
  4442. Owned<IPropertyTree> root(conn->queryRoot()->getBranch("."));
  4443. KeptAtomTable entries;
  4444. Owned<IPropertyTreeIterator> iter(root->getElements("*/*/*/*"));
  4445. StringBuffer wuid;
  4446. for(iter->first(); iter->isValid(); iter->next())
  4447. {
  4448. char const * entry = iter->query().queryName();
  4449. if(!entries.find(entry))
  4450. {
  4451. entries.addAtom(entry);
  4452. ncnameUnescape(entry, wuid.clear());
  4453. Owned<IWorkUnit> wu = updateWorkUnit(wuid, secmgr, secuser);
  4454. if(wu && (wu->getState() == WUStateWait))
  4455. wu->setState(WUStateCompleted);
  4456. }
  4457. }
  4458. bool more;
  4459. do more = root->removeProp("*"); while(more);
  4460. }
  4461. IConstQuerySetQueryIterator* CWorkUnitFactory::getQuerySetQueriesSorted( WUQuerySortField *sortorder, // list of fields to sort by (terminated by WUSFterm)
  4462. WUQuerySortField *filters, // NULL or list of fields to filter on (terminated by WUSFterm)
  4463. const void *filterbuf, // (appended) string values for filters
  4464. unsigned startoffset,
  4465. unsigned maxnum,
  4466. __int64 *cachehint,
  4467. unsigned *total,
  4468. const MapStringTo<bool> *_subset)
  4469. {
  4470. struct PostFilters
  4471. {
  4472. WUQueryFilterBoolean activatedFilter;
  4473. WUQueryFilterBoolean suspendedByUserFilter;
  4474. PostFilters()
  4475. {
  4476. activatedFilter = WUQFSAll;
  4477. suspendedByUserFilter = WUQFSAll;
  4478. };
  4479. } postFilters;
  4480. class CQuerySetQueriesPager : public CSimpleInterface, implements IElementsPager
  4481. {
  4482. StringAttr querySet;
  4483. StringAttr xPath;
  4484. StringAttr sortOrder;
  4485. PostFilters postFilters;
  4486. StringArray unknownAttributes;
  4487. const MapStringTo<bool> *subset;
  4488. void populateQueryTree(const IPropertyTree* querySetTree, IPropertyTree* queryTree)
  4489. {
  4490. const char* querySetId = querySetTree->queryProp("@id");
  4491. VStringBuffer path("Query%s", xPath.get());
  4492. Owned<IPropertyTreeIterator> iter = querySetTree->getElements(path.str());
  4493. ForEach(*iter)
  4494. {
  4495. IPropertyTree &query = iter->query();
  4496. bool activated = false;
  4497. const char* queryId = query.queryProp("@id");
  4498. if (queryId && *queryId)
  4499. {
  4500. if (subset)
  4501. {
  4502. VStringBuffer match("%s/%s", querySetId, queryId);
  4503. if (!subset->getValue(match))
  4504. continue;
  4505. }
  4506. VStringBuffer aliasXPath("Alias[@id='%s']", queryId);
  4507. IPropertyTree *alias = querySetTree->queryPropTree(aliasXPath.str());
  4508. if (alias)
  4509. activated = true;
  4510. }
  4511. if (activated && (postFilters.activatedFilter == WUQFSNo))
  4512. continue;
  4513. if (!activated && (postFilters.activatedFilter == WUQFSYes))
  4514. continue;
  4515. if ((postFilters.suspendedByUserFilter == WUQFSNo) && query.hasProp(getEnumText(WUQSFSuspendedByUser,querySortFields)))
  4516. continue;
  4517. if ((postFilters.suspendedByUserFilter == WUQFSYes) && !query.hasProp(getEnumText(WUQSFSuspendedByUser,querySortFields)))
  4518. continue;
  4519. IPropertyTree *queryWithSetId = queryTree->addPropTree("Query", createPTreeFromIPT(&query));
  4520. queryWithSetId->setProp("@querySetId", querySetId);
  4521. queryWithSetId->setPropBool("@activated", activated);
  4522. }
  4523. }
  4524. IRemoteConnection* populateQueryTree(IPropertyTree* queryTree)
  4525. {
  4526. StringBuffer querySetXPath("QuerySets");
  4527. if (!querySet.isEmpty())
  4528. querySetXPath.appendf("/QuerySet[@id=\"%s\"]", querySet.get());
  4529. Owned<IRemoteConnection> conn = querySDS().connect(querySetXPath.str(), myProcessSession(), 0, SDS_LOCK_TIMEOUT);
  4530. if (!conn)
  4531. return NULL;
  4532. if (querySet.isEmpty())
  4533. {
  4534. Owned<IPropertyTreeIterator> querySetIter = conn->queryRoot()->getElements("*");
  4535. ForEach(*querySetIter)
  4536. populateQueryTree(&querySetIter->query(), queryTree);
  4537. }
  4538. else
  4539. populateQueryTree(conn->queryRoot(), queryTree);
  4540. return conn.getClear();
  4541. }
  4542. public:
  4543. IMPLEMENT_IINTERFACE_USING(CSimpleInterface);
  4544. CQuerySetQueriesPager(const char* _querySet, const char* _xPath, const char *_sortOrder, PostFilters& _postFilters, StringArray& _unknownAttributes, const MapStringTo<bool> *_subset)
  4545. : querySet(_querySet), xPath(_xPath), sortOrder(_sortOrder), subset(_subset)
  4546. {
  4547. postFilters.activatedFilter = _postFilters.activatedFilter;
  4548. postFilters.suspendedByUserFilter = _postFilters.suspendedByUserFilter;
  4549. ForEachItemIn(x, _unknownAttributes)
  4550. unknownAttributes.append(_unknownAttributes.item(x));
  4551. }
  4552. virtual IRemoteConnection* getElements(IArrayOf<IPropertyTree> &elements)
  4553. {
  4554. Owned<IPropertyTree> elementTree = createPTree("Queries");
  4555. Owned<IRemoteConnection> conn = populateQueryTree(elementTree);
  4556. if (!conn)
  4557. return NULL;
  4558. Owned<IPropertyTreeIterator> iter = elementTree->getElements("*");
  4559. if (!iter)
  4560. return NULL;
  4561. sortElements(iter, sortOrder.get(), NULL, NULL, unknownAttributes, elements);
  4562. return conn.getClear();
  4563. }
  4564. virtual bool allMatchingElementsReceived() { return true; } //For now, dali always returns all of matched Queries.
  4565. };
  4566. StringAttr querySet;
  4567. StringBuffer xPath;
  4568. StringBuffer so;
  4569. StringArray unknownAttributes;
  4570. if (filters)
  4571. {
  4572. const char *fv = (const char *)filterbuf;
  4573. for (unsigned i=0;filters[i]!=WUQSFterm;i++) {
  4574. int fmt = filters[i];
  4575. int subfmt = (fmt&0xff);
  4576. if (subfmt==WUQSFQuerySet)
  4577. querySet.set(fv);
  4578. else if ((subfmt==WUQSFmemoryLimit) || (subfmt==WUQSFtimeLimit) || (subfmt==WUQSFwarnTimeLimit) || (subfmt==WUQSFpriority))
  4579. xPath.append('[').append(getEnumText(subfmt,querySortFields)).append(">=").append(fv).append("]");
  4580. else if ((subfmt==WUQSFmemoryLimitHi) || (subfmt==WUQSFtimeLimitHi) || (subfmt==WUQSFwarnTimeLimitHi) || (subfmt==WUQSFpriorityHi))
  4581. xPath.append('[').append(getEnumText(subfmt,querySortFields)).append("<=").append(fv).append("]");
  4582. else if (subfmt==WUQSFActivited)
  4583. postFilters.activatedFilter = (WUQueryFilterBoolean) atoi(fv);
  4584. else if (subfmt==WUQSFSuspendedByUser)
  4585. postFilters.suspendedByUserFilter = (WUQueryFilterBoolean) atoi(fv);
  4586. else if (!fv || !*fv)
  4587. unknownAttributes.append(getEnumText(subfmt,querySortFields));
  4588. else {
  4589. xPath.append('[').append(getEnumText(subfmt,querySortFields)).append('=');
  4590. if (fmt&WUQSFnocase)
  4591. xPath.append('?');
  4592. if (fmt&WUQSFnumeric)
  4593. xPath.append('#');
  4594. if (fmt&WUQSFwild)
  4595. xPath.append('~');
  4596. xPath.append('"').append(fv).append("\"]");
  4597. }
  4598. fv = fv + strlen(fv)+1;
  4599. }
  4600. }
  4601. if (sortorder) {
  4602. for (unsigned i=0;sortorder[i]!=WUQSFterm;i++) {
  4603. if (so.length())
  4604. so.append(',');
  4605. int fmt = sortorder[i];
  4606. if (fmt&WUQSFreverse)
  4607. so.append('-');
  4608. if (fmt&WUQSFnocase)
  4609. so.append('?');
  4610. if (fmt&WUQSFnumeric)
  4611. so.append('#');
  4612. so.append(getEnumText(fmt&0xff,querySortFields));
  4613. }
  4614. }
  4615. IArrayOf<IPropertyTree> results;
  4616. Owned<IElementsPager> elementsPager = new CQuerySetQueriesPager(querySet.get(), xPath.str(), so.length()?so.str():NULL, postFilters, unknownAttributes, _subset);
  4617. Owned<IRemoteConnection> conn=getElementsPaged(elementsPager,startoffset,maxnum,NULL,"",cachehint,results,total,NULL);
  4618. return new CConstQuerySetQueryIterator(results);
  4619. }
  4620. bool CWorkUnitFactory::isAborting(const char *wuid) const
  4621. {
  4622. VStringBuffer apath("/WorkUnitAborts/%s", wuid);
  4623. try
  4624. {
  4625. Owned<IRemoteConnection> acon = querySDS().connect(apath.str(), myProcessSession(), 0, SDS_LOCK_TIMEOUT);
  4626. if (acon)
  4627. return acon->queryRoot()->getPropInt(NULL) != 0;
  4628. }
  4629. catch (IException *E)
  4630. {
  4631. EXCLOG(E);
  4632. E->Release();
  4633. }
  4634. return false;
  4635. }
  4636. void CWorkUnitFactory::clearAborting(const char *wuid)
  4637. {
  4638. VStringBuffer apath("/WorkUnitAborts/%s", wuid);
  4639. try
  4640. {
  4641. Owned<IRemoteConnection> acon = querySDS().connect(apath.str(), myProcessSession(), RTM_LOCK_WRITE|RTM_LOCK_SUB, SDS_LOCK_TIMEOUT);
  4642. if (acon)
  4643. acon->close(true);
  4644. }
  4645. catch (IException *E)
  4646. {
  4647. EXCLOG(E);
  4648. E->Release();
  4649. }
  4650. }
  4651. void CWorkUnitFactory::reportAbnormalTermination(const char *wuid, WUState &state, SessionId agent)
  4652. {
  4653. WARNLOG("reportAbnormalTermination: session stopped unexpectedly: %" I64F "d state: %d", (__int64) agent, (int) state);
  4654. bool isEcl = false;
  4655. switch (state)
  4656. {
  4657. case WUStateAborting:
  4658. state = WUStateAborted;
  4659. break;
  4660. case WUStateCompiling:
  4661. isEcl = true;
  4662. // drop into
  4663. default:
  4664. state = WUStateFailed;
  4665. }
  4666. Owned<IWorkUnit> wu = updateWorkUnit(wuid, NULL, NULL);
  4667. wu->setState(state);
  4668. Owned<IWUException> e = wu->createException();
  4669. e->setExceptionCode(isEcl ? 1001 : 1000);
  4670. e->setExceptionMessage(isEcl ? "EclServer terminated unexpectedly" : "Workunit terminated unexpectedly");
  4671. }
  4672. static CriticalSection deleteDllLock;
  4673. static IWorkQueueThread *deleteDllWorkQ = nullptr;
  4674. MODULE_INIT(INIT_PRIORITY_STANDARD)
  4675. {
  4676. return true;
  4677. }
  4678. MODULE_EXIT()
  4679. {
  4680. CriticalBlock b(deleteDllLock);
  4681. if (deleteDllWorkQ)
  4682. ::Release(deleteDllWorkQ);
  4683. deleteDllWorkQ = nullptr;
  4684. }
  4685. static void asyncRemoveDll(const char * name)
  4686. {
  4687. CriticalBlock b(deleteDllLock);
  4688. if (!deleteDllWorkQ)
  4689. deleteDllWorkQ = createWorkQueueThread();
  4690. deleteDllWorkQ->post(new asyncRemoveDllWorkItem(name));
  4691. }
  4692. static void asyncRemoveFile(const char * ip, const char * name)
  4693. {
  4694. CriticalBlock b(deleteDllLock);
  4695. if (!deleteDllWorkQ)
  4696. deleteDllWorkQ = createWorkQueueThread();
  4697. deleteDllWorkQ->post(new asyncRemoveRemoteFileWorkItem(ip, name));
  4698. }
  4699. class CDaliWorkUnitFactory : public CWorkUnitFactory, implements IDaliClientShutdown
  4700. {
  4701. public:
  4702. IMPLEMENT_IINTERFACE_USING(CWorkUnitFactory);
  4703. CDaliWorkUnitFactory()
  4704. {
  4705. // Assumes dali client configuration has already been done
  4706. sdsManager = &querySDS();
  4707. session = myProcessSession();
  4708. addShutdownHook(*this);
  4709. }
  4710. ~CDaliWorkUnitFactory()
  4711. {
  4712. removeShutdownHook(*this);
  4713. }
  4714. virtual bool initializeStore()
  4715. {
  4716. throwUnexpected(); // Used when loading a plugin factory - not applicable here
  4717. }
  4718. virtual IWorkUnitWatcher *getWatcher(IWorkUnitSubscriber *subscriber, WUSubscribeOptions options, const char *wuid) const
  4719. {
  4720. return new CDaliWorkUnitWatcher(subscriber, options, wuid);
  4721. }
  4722. virtual unsigned validateRepository(bool fixErrors)
  4723. {
  4724. return 0;
  4725. }
  4726. virtual void deleteRepository(bool recreate)
  4727. {
  4728. Owned<IRemoteConnection> conn = sdsManager->connect("/WorkUnits", session, RTM_LOCK_WRITE, SDS_LOCK_TIMEOUT);
  4729. if (conn)
  4730. conn->close(true);
  4731. conn.setown(sdsManager->connect("/GraphProgress", session, RTM_LOCK_WRITE, SDS_LOCK_TIMEOUT));
  4732. if (conn)
  4733. conn->close(true);
  4734. }
  4735. virtual void createRepository()
  4736. {
  4737. // Nothing to do
  4738. }
  4739. virtual const char *queryStoreType() const
  4740. {
  4741. return "Dali";
  4742. }
  4743. virtual CLocalWorkUnit *_createWorkUnit(const char *wuid, ISecManager *secmgr, ISecUser *secuser)
  4744. {
  4745. StringBuffer wuRoot;
  4746. getXPath(wuRoot, wuid);
  4747. IRemoteConnection *conn;
  4748. conn = sdsManager->connect(wuRoot.str(), session, RTM_LOCK_WRITE|RTM_CREATE_UNIQUE, SDS_LOCK_TIMEOUT);
  4749. conn->queryRoot()->setProp("@xmlns:xsi", "http://www.w3.org/1999/XMLSchema-instance");
  4750. conn->queryRoot()->setPropInt("@wuidVersion", WUID_VERSION);
  4751. conn->queryRoot()->setProp("@totalThorTime", "");
  4752. return new CDaliWorkUnit(conn, secmgr, secuser);
  4753. }
  4754. virtual CLocalWorkUnit* _openWorkUnit(const char *wuid, ISecManager *secmgr, ISecUser *secuser)
  4755. {
  4756. StringBuffer wuRoot;
  4757. getXPath(wuRoot, wuid);
  4758. IRemoteConnection* conn = sdsManager->connect(wuRoot.str(), session, 0, SDS_LOCK_TIMEOUT);
  4759. if (conn)
  4760. return new CDaliWorkUnit(conn, secmgr, secuser);
  4761. else
  4762. return NULL;
  4763. }
  4764. virtual bool _restoreWorkUnit(IPTree *_pt, const char *wuid)
  4765. {
  4766. Owned<IPTree> pt(_pt);
  4767. Owned<IPropertyTree> gprogress = pruneBranch(pt, "GraphProgress[1]");
  4768. StringBuffer wuRoot;
  4769. getXPath(wuRoot, wuid);
  4770. Owned<IRemoteConnection> conn = sdsManager->connect(wuRoot.str(), myProcessSession(), RTM_LOCK_WRITE|RTM_CREATE_QUERY, SDS_LOCK_TIMEOUT);
  4771. if (!conn)
  4772. {
  4773. ERRLOG("restoreWorkUnit could not create to %s", wuRoot.str());
  4774. return false;
  4775. }
  4776. IPropertyTree *root = conn->queryRoot();
  4777. if (root->hasChildren())
  4778. {
  4779. ERRLOG("restoreWorkUnit WUID %s already exists", wuid);
  4780. return false;
  4781. }
  4782. root->setPropTree(NULL, pt.getClear());
  4783. conn.clear();
  4784. // now kludge back GraphProgress
  4785. if (gprogress)
  4786. {
  4787. VStringBuffer xpath("/GraphProgress/%s", wuid);
  4788. conn.setown(querySDS().connect(xpath, myProcessSession(), RTM_LOCK_WRITE|RTM_CREATE_QUERY, SDS_LOCK_TIMEOUT));
  4789. if (conn)
  4790. {
  4791. IPropertyTree *groot = conn->queryRoot();
  4792. if (groot->hasChildren())
  4793. WARNLOG("restoreWorkUnit WUID %s graphprogress already exists, replacing",wuid);
  4794. groot->setPropTree(NULL, gprogress.getClear());
  4795. }
  4796. }
  4797. return true;
  4798. }
  4799. virtual CLocalWorkUnit* _updateWorkUnit(const char *wuid, ISecManager *secmgr, ISecUser *secuser)
  4800. {
  4801. StringBuffer wuRoot;
  4802. getXPath(wuRoot, wuid);
  4803. IRemoteConnection* conn = sdsManager->connect(wuRoot.str(), session, RTM_LOCK_WRITE|RTM_LOCK_SUB, SDS_LOCK_TIMEOUT);
  4804. if (conn)
  4805. return new CDaliWorkUnit(conn, secmgr, secuser);
  4806. else
  4807. return NULL;
  4808. }
  4809. virtual IWorkUnit* getGlobalWorkUnit(ISecManager *secmgr, ISecUser *secuser)
  4810. {
  4811. // MORE - should it check security?
  4812. StringBuffer wuRoot;
  4813. getXPath(wuRoot, GLOBAL_WORKUNIT);
  4814. IRemoteConnection* conn = sdsManager->connect(wuRoot.str(), session, RTM_LOCK_WRITE|RTM_CREATE_QUERY, SDS_LOCK_TIMEOUT);
  4815. conn->queryRoot()->setProp("@xmlns:xsi", "http://www.w3.org/1999/XMLSchema-instance");
  4816. Owned<CLocalWorkUnit> cw = new CDaliWorkUnit(conn, (ISecManager *) NULL, NULL);
  4817. return &cw->lockRemote(false);
  4818. }
  4819. virtual IConstWorkUnitIterator* getWorkUnitsByOwner(const char * owner, ISecManager *secmgr, ISecUser *secuser)
  4820. {
  4821. StringBuffer path("*");
  4822. if (owner && *owner)
  4823. path.append("[@submitID=?~\"").append(owner).append("\"]");
  4824. return _getWorkUnitsByXPath(path.str(), secmgr, secuser);
  4825. }
  4826. IConstWorkUnitIterator* getScheduledWorkUnits(ISecManager *secmgr, ISecUser *secuser)
  4827. {
  4828. StringBuffer path("*");
  4829. path.append("[@state=\"").append(getEnumText(WUStateScheduled, states)).append("\"]");
  4830. return _getWorkUnitsByXPath(path.str(), secmgr, secuser);
  4831. }
  4832. virtual void clientShutdown();
  4833. virtual unsigned numWorkUnits()
  4834. {
  4835. Owned<IRemoteConnection> conn = sdsManager->connect("/WorkUnits", session, 0, SDS_LOCK_TIMEOUT);
  4836. if (!conn)
  4837. return 0;
  4838. IPropertyTree *root = conn->queryRoot();
  4839. return root->numChildren();
  4840. }
  4841. /**
  4842. * Add a filter to an xpath query, with the appropriate filter flags
  4843. */
  4844. static void appendFilterToQueryString(StringBuffer& query, int flags, const char* name, const char* value)
  4845. {
  4846. query.append('[').append(name).append('=');
  4847. if (flags & WUSFnocase)
  4848. query.append('?');
  4849. if (flags & WUSFwild)
  4850. query.append('~');
  4851. query.append('"').append(value).append("\"]");
  4852. };
  4853. IConstWorkUnitIterator* getWorkUnitsSorted( WUSortField sortorder, // field to sort by (and flags for desc sort etc)
  4854. WUSortField *filters, // NULL or list of fields to filter on (terminated by WUSFterm)
  4855. const void *filterbuf, // (appended) string values for filters
  4856. unsigned startoffset,
  4857. unsigned maxnum,
  4858. __int64 *cachehint,
  4859. unsigned *total,
  4860. ISecManager *secmgr,
  4861. ISecUser *secuser)
  4862. {
  4863. class CQueryOrFilter : public CInterface
  4864. {
  4865. unsigned flags;
  4866. StringAttr name;
  4867. StringArray values;
  4868. public:
  4869. IMPLEMENT_IINTERFACE;
  4870. CQueryOrFilter(unsigned _flags, const char *_name, const char *_value)
  4871. : flags(_flags), name(_name)
  4872. {
  4873. values.appendListUniq(_value, "|");
  4874. };
  4875. const char* queryName() { return name.get(); };
  4876. unsigned querySearchFlags() { return flags; };
  4877. const StringArray& queryValues() const { return values; };
  4878. };
  4879. class CMultiPTreeIterator : public CInterfaceOf<IPropertyTreeIterator>
  4880. {
  4881. public:
  4882. virtual bool first() override
  4883. {
  4884. curSource = 0;
  4885. while (sources.isItem(curSource))
  4886. {
  4887. if (sources.item(curSource).first())
  4888. return true;
  4889. curSource++;
  4890. }
  4891. return false;
  4892. }
  4893. virtual bool next() override
  4894. {
  4895. if (sources.isItem(curSource))
  4896. {
  4897. if (sources.item(curSource).next())
  4898. return true;
  4899. curSource++;
  4900. while (sources.isItem(curSource))
  4901. {
  4902. if (sources.item(curSource).first())
  4903. return true;
  4904. curSource++;
  4905. }
  4906. }
  4907. return false;
  4908. }
  4909. virtual bool isValid() override
  4910. {
  4911. return sources.isItem(curSource);
  4912. }
  4913. virtual IPropertyTree & query() override
  4914. {
  4915. return sources.item(curSource).query();
  4916. }
  4917. void addSource(IPropertyTreeIterator &source)
  4918. {
  4919. sources.append(source);
  4920. }
  4921. private:
  4922. IArrayOf<IPropertyTreeIterator> sources;
  4923. unsigned curSource = 0;
  4924. };
  4925. class CWorkUnitsPager : public CSimpleInterface, implements IElementsPager
  4926. {
  4927. StringAttr xPath;
  4928. StringAttr sortOrder;
  4929. StringAttr nameFilterLo;
  4930. StringAttr nameFilterHi;
  4931. StringArray unknownAttributes;
  4932. Owned<CQueryOrFilter> orFilter;
  4933. public:
  4934. IMPLEMENT_IINTERFACE_USING(CSimpleInterface);
  4935. CWorkUnitsPager(const char* _xPath, CQueryOrFilter* _orFilter, const char *_sortOrder, const char* _nameFilterLo, const char* _nameFilterHi, StringArray& _unknownAttributes)
  4936. : xPath(_xPath), orFilter(_orFilter), sortOrder(_sortOrder), nameFilterLo(_nameFilterLo), nameFilterHi(_nameFilterHi)
  4937. {
  4938. ForEachItemIn(x, _unknownAttributes)
  4939. unknownAttributes.append(_unknownAttributes.item(x));
  4940. }
  4941. virtual IRemoteConnection* getElements(IArrayOf<IPropertyTree> &elements)
  4942. {
  4943. Owned<IRemoteConnection> conn = querySDS().connect("WorkUnits", myProcessSession(), 0, SDS_LOCK_TIMEOUT);
  4944. if (!conn)
  4945. return NULL;
  4946. Owned<IPropertyTreeIterator> iter;
  4947. if (!orFilter)
  4948. {
  4949. iter.setown(conn->getElements(xPath.get()));
  4950. }
  4951. else
  4952. {
  4953. Owned <CMultiPTreeIterator> multi = new CMultiPTreeIterator;
  4954. bool added = false;
  4955. const char* fieldName = orFilter->queryName();
  4956. unsigned flags = orFilter->querySearchFlags();
  4957. const StringArray& values = orFilter->queryValues();
  4958. ForEachItemIn(i, values)
  4959. {
  4960. StringBuffer path = xPath.get();
  4961. const char* value = values.item(i);
  4962. if (!isEmptyString(value))
  4963. {
  4964. appendFilterToQueryString(path, flags, fieldName, value);
  4965. IPropertyTreeIterator *itr = conn->getElements(path.str());
  4966. if (itr)
  4967. {
  4968. multi->addSource(*itr);
  4969. added = true;
  4970. }
  4971. }
  4972. }
  4973. if (added)
  4974. iter.setown(multi.getClear());
  4975. }
  4976. if (!iter)
  4977. return NULL;
  4978. sortElements(iter, sortOrder.get(), nameFilterLo.get(), nameFilterHi.get(), unknownAttributes, elements);
  4979. return conn.getClear();
  4980. }
  4981. virtual bool allMatchingElementsReceived() { return true; }//For now, dali always returns all of matched WUs.
  4982. };
  4983. class CScopeChecker : public CSimpleInterface, implements ISortedElementsTreeFilter
  4984. {
  4985. UniqueScopes done;
  4986. ISecManager *secmgr;
  4987. ISecUser *secuser;
  4988. CriticalSection crit;
  4989. public:
  4990. IMPLEMENT_IINTERFACE_USING(CSimpleInterface);
  4991. CScopeChecker(ISecManager *_secmgr,ISecUser *_secuser)
  4992. {
  4993. secmgr = _secmgr;
  4994. secuser = _secuser;
  4995. }
  4996. bool isOK(IPropertyTree &tree)
  4997. {
  4998. const char *scopename = tree.queryProp("@scope");
  4999. if (!scopename||!*scopename)
  5000. return true;
  5001. {
  5002. CriticalBlock block(crit);
  5003. const bool *b = done.getValue(scopename);
  5004. if (b)
  5005. return *b;
  5006. }
  5007. bool ret = checkWuScopeSecAccess(scopename,secmgr,secuser,SecAccess_Read,"iterating",false,false);
  5008. {
  5009. // conceivably could have already been checked and added, but ok.
  5010. CriticalBlock block(crit);
  5011. done.setValue(scopename,ret);
  5012. }
  5013. return ret;
  5014. }
  5015. };
  5016. Owned<CQueryOrFilter> orFilter;
  5017. Owned<ISortedElementsTreeFilter> sc = new CScopeChecker(secmgr,secuser);
  5018. StringBuffer query;
  5019. StringBuffer so;
  5020. StringAttr namefilter("*");
  5021. StringAttr namefilterlo;
  5022. StringAttr namefilterhi;
  5023. StringArray unknownAttributes;
  5024. if (filters)
  5025. {
  5026. const char *fv = (const char *) filterbuf;
  5027. for (unsigned i=0;filters[i]!=WUSFterm;i++)
  5028. {
  5029. assertex(fv);
  5030. int fmt = filters[i];
  5031. int subfmt = (fmt&0xff);
  5032. if (subfmt==WUSFwuid)
  5033. namefilterlo.set(fv);
  5034. else if (subfmt==WUSFwuidhigh)
  5035. namefilterhi.set(fv);
  5036. else if (subfmt==WUSFwildwuid)
  5037. namefilter.set(fv);
  5038. else if (subfmt==WUSFappvalue)
  5039. {
  5040. const char *app = fv;
  5041. fv = fv + strlen(fv)+1;
  5042. query.append("[Application/").append(app);
  5043. if (*fv)
  5044. query.append("=?~\"").append(fv).append('\"');
  5045. query.append("]");
  5046. }
  5047. else if (!*fv)
  5048. {
  5049. unknownAttributes.append(getEnumText(subfmt,workunitSortFields));
  5050. if (subfmt==WUSFtotalthortime)
  5051. sortorder = (WUSortField) (sortorder & ~WUSFnumeric);
  5052. }
  5053. else
  5054. {
  5055. const char* fieldName = getEnumText(subfmt,workunitSortFields);
  5056. if (!strchr(fv, '|'))
  5057. appendFilterToQueryString(query, fmt, fieldName, fv);
  5058. else if (orFilter)
  5059. throw MakeStringException(WUERR_InvalidUserInput, "Multiple OR filters not allowed");
  5060. else
  5061. {
  5062. if (!strieq(fieldName, getEnumText(WUSFstate,workunitSortFields)) &&
  5063. !strieq(fieldName, getEnumText(WUSFuser,workunitSortFields)) &&
  5064. !strieq(fieldName, getEnumText(WUSFcluster,workunitSortFields)))
  5065. throw MakeStringException(WUERR_InvalidUserInput, "OR filters not allowed for %s", fieldName);
  5066. orFilter.setown(new CQueryOrFilter(fmt, fieldName, fv));
  5067. }
  5068. }
  5069. fv = fv + strlen(fv)+1;
  5070. }
  5071. }
  5072. if ((sortorder&0xff)==WUSFtotalthortime)
  5073. sortorder = (WUSortField) (sortorder & ~WUSFnumeric);
  5074. query.insert(0, namefilter.get());
  5075. if (sortorder)
  5076. {
  5077. if (so.length())
  5078. so.append(',');
  5079. if (sortorder & WUSFreverse)
  5080. so.append('-');
  5081. if (sortorder & WUSFnocase)
  5082. so.append('?');
  5083. if (sortorder & WUSFnumeric)
  5084. so.append('#');
  5085. so.append(getEnumText(sortorder&0xff,workunitSortFields));
  5086. }
  5087. IArrayOf<IPropertyTree> results;
  5088. Owned<IElementsPager> elementsPager = new CWorkUnitsPager(query.str(), orFilter.getClear(), so.length()?so.str():NULL, namefilterlo.get(), namefilterhi.get(), unknownAttributes);
  5089. Owned<IRemoteConnection> conn=getElementsPaged(elementsPager,startoffset,maxnum,secmgr?sc:NULL,"",cachehint,results,total,NULL);
  5090. return new CConstWUArrayIterator(results);
  5091. }
  5092. virtual WUState waitForWorkUnit(const char * wuid, unsigned timeout, bool compiled, bool returnOnWaitState)
  5093. {
  5094. WUState ret = WUStateUnknown;
  5095. StringBuffer wuRoot;
  5096. getXPath(wuRoot, wuid);
  5097. Owned<IRemoteConnection> conn = sdsManager->connect(wuRoot.str(), session, 0, SDS_LOCK_TIMEOUT);
  5098. if (timeout == 0) //no need to subscribe
  5099. {
  5100. ret = (WUState) getEnum(conn->queryRoot(), "@state", states);
  5101. switch (ret)
  5102. {
  5103. case WUStateCompiled:
  5104. case WUStateUploadingFiles:
  5105. if (!compiled)
  5106. break;
  5107. //fall through
  5108. case WUStateCompleted:
  5109. case WUStateFailed:
  5110. case WUStateAborted:
  5111. return ret;
  5112. case WUStateWait:
  5113. if(returnOnWaitState)
  5114. return ret;
  5115. default:
  5116. break;
  5117. }
  5118. return WUStateUnknown;
  5119. }
  5120. Owned<WorkUnitWaiter> waiter = new WorkUnitWaiter(wuid, SubscribeOptionState);
  5121. LocalIAbortHandler abortHandler(*waiter);
  5122. if (conn)
  5123. {
  5124. SessionId agent = -1;
  5125. bool agentSessionStopped = false;
  5126. unsigned start = msTick();
  5127. for (;;)
  5128. {
  5129. ret = (WUState) getEnum(conn->queryRoot(), "@state", states);
  5130. switch (ret)
  5131. {
  5132. case WUStateCompiled:
  5133. case WUStateUploadingFiles:
  5134. if (!compiled)
  5135. break;
  5136. // fall into
  5137. case WUStateCompleted:
  5138. case WUStateFailed:
  5139. case WUStateAborted:
  5140. return ret;
  5141. case WUStateWait:
  5142. if(returnOnWaitState)
  5143. {
  5144. return ret;
  5145. }
  5146. break;
  5147. case WUStateCompiling:
  5148. case WUStateRunning:
  5149. case WUStateDebugPaused:
  5150. case WUStateDebugRunning:
  5151. case WUStateBlocked:
  5152. case WUStateAborting:
  5153. if (agentSessionStopped)
  5154. {
  5155. reportAbnormalTermination(wuid, ret, agent);
  5156. return ret;
  5157. }
  5158. if (queryDaliServerVersion().compare("2.1")>=0)
  5159. {
  5160. agent = conn->queryRoot()->getPropInt64("@agentSession", -1);
  5161. if((agent>0) && querySessionManager().sessionStopped(agent, 0))
  5162. {
  5163. agentSessionStopped = true;
  5164. conn->reload();
  5165. continue;
  5166. }
  5167. }
  5168. break;
  5169. }
  5170. agentSessionStopped = false; // reset for state changes such as WUStateWait then WUStateRunning again
  5171. unsigned waited = msTick() - start;
  5172. if (timeout==-1 || waited + 20000 < timeout)
  5173. {
  5174. waiter->wait(20000); // recheck state every 20 seconds, in case eclagent has crashed.
  5175. if (waiter->isAborted())
  5176. {
  5177. ret = WUStateUnknown; // MORE - throw an exception?
  5178. break;
  5179. }
  5180. }
  5181. else if (waited > timeout || !waiter->wait(timeout-waited))
  5182. {
  5183. ret = WUStateUnknown; // MORE - throw an exception?
  5184. break;
  5185. }
  5186. conn->reload();
  5187. }
  5188. }
  5189. return ret;
  5190. }
  5191. virtual WUAction waitForWorkUnitAction(const char * wuid, WUAction original)
  5192. {
  5193. Owned<WorkUnitWaiter> waiter = new WorkUnitWaiter(wuid, SubscribeOptionAction);
  5194. LocalIAbortHandler abortHandler(*waiter);
  5195. WUAction ret = WUActionUnknown;
  5196. StringBuffer wuRoot;
  5197. getXPath(wuRoot, wuid);
  5198. Owned<IRemoteConnection> conn = sdsManager->connect(wuRoot.str(), session, 0, SDS_LOCK_TIMEOUT);
  5199. if (conn)
  5200. {
  5201. unsigned start = msTick();
  5202. for (;;)
  5203. {
  5204. ret = (WUAction) getEnum(conn->queryRoot(), "Action", actions);
  5205. if (ret != original)
  5206. break;
  5207. unsigned waited = msTick() - start;
  5208. waiter->wait(20000); // recheck state every 20 seconds even if no timeout, in case eclagent has crashed.
  5209. if (waiter->isAborted())
  5210. {
  5211. ret = WUActionUnknown; // MORE - throw an exception?
  5212. break;
  5213. }
  5214. conn->reload();
  5215. }
  5216. }
  5217. waiter->unsubscribe();
  5218. return ret;
  5219. }
  5220. protected:
  5221. IConstWorkUnitIterator * _getWorkUnitsByXPath(const char *xpath, ISecManager *secmgr, ISecUser *secuser)
  5222. {
  5223. Owned<IRemoteConnection> conn = sdsManager->connect("/WorkUnits", session, 0, SDS_LOCK_TIMEOUT);
  5224. if (conn)
  5225. {
  5226. CDaliVersion serverVersionNeeded("3.2");
  5227. Owned<IPropertyTreeIterator> iter(queryDaliServerVersion().compare(serverVersionNeeded) < 0 ?
  5228. conn->queryRoot()->getElements(xpath) :
  5229. conn->getElements(xpath));
  5230. return createSecureConstWUIterator(iter.getClear(), secmgr, secuser);
  5231. }
  5232. else
  5233. return NULL;
  5234. }
  5235. ISDSManager *sdsManager;
  5236. SessionId session;
  5237. };
  5238. extern WORKUNIT_API IConstWorkUnitIterator *createSecureConstWUIterator(IConstWorkUnitIterator *iter, ISecManager *secmgr, ISecUser *secuser)
  5239. {
  5240. if (secmgr)
  5241. return new CSecureConstWUIterator(iter, secmgr, secuser);
  5242. else
  5243. return iter;
  5244. }
  5245. extern WORKUNIT_API IConstWorkUnitIterator *createSecureConstWUIterator(IPropertyTreeIterator *iter, ISecManager *secmgr, ISecUser *secuser)
  5246. {
  5247. if (secmgr)
  5248. return new CSecureConstWUIterator(new CConstWUIterator(iter), secmgr, secuser);
  5249. else
  5250. return new CConstWUIterator(iter);
  5251. }
  5252. static CriticalSection factoryCrit;
  5253. static Owned<IWorkUnitFactory> factory;
  5254. void CDaliWorkUnitFactory::clientShutdown()
  5255. {
  5256. CriticalBlock b(factoryCrit);
  5257. factory.clear();
  5258. }
  5259. void clientShutdownWorkUnit()
  5260. {
  5261. CriticalBlock b(factoryCrit);
  5262. factory.clear();
  5263. }
  5264. extern WORKUNIT_API void setWorkUnitFactory(IWorkUnitFactory * _factory)
  5265. {
  5266. CriticalBlock b(factoryCrit);
  5267. factory.setown(_factory);
  5268. }
  5269. extern WORKUNIT_API IWorkUnitFactory * getWorkUnitFactory()
  5270. {
  5271. if (!factory)
  5272. {
  5273. CriticalBlock b(factoryCrit);
  5274. if (!factory) // NOTE - this "double test" paradigm is not guaranteed threadsafe on modern systems/compilers - I think in this instance that is harmless even in the (extremely) unlikely event that it resulted in the setown being called twice.
  5275. {
  5276. const char *forceEnv = getenv("FORCE_DALI_WORKUNITS");
  5277. bool forceDali = forceEnv && !strieq(forceEnv, "off") && !strieq(forceEnv, "0");
  5278. Owned<IRemoteConnection> env = querySDS().connect("/Environment", myProcessSession(), 0, SDS_LOCK_TIMEOUT);
  5279. IPropertyTree *pluginInfo = NULL;
  5280. if (env)
  5281. {
  5282. SocketEndpoint targetDali = queryCoven().queryGroup().queryNode(0).endpoint();
  5283. IPropertyTree *daliInfo = findDaliProcess(env->queryRoot(), targetDali);
  5284. if (daliInfo)
  5285. {
  5286. const char *daliName = daliInfo->queryProp("@name");
  5287. if (daliName)
  5288. {
  5289. VStringBuffer xpath("Software/DaliServerPlugin[@type='WorkunitServer'][@daliServers='%s']", daliName);
  5290. pluginInfo = env->queryRoot()->queryPropTree(xpath);
  5291. }
  5292. if (!pluginInfo)
  5293. pluginInfo = daliInfo->queryPropTree("Plugin[@type='WorkunitServer']"); // Compatibility with early betas of 6.0 ...
  5294. }
  5295. }
  5296. if (pluginInfo && !forceDali)
  5297. factory.setown( (IWorkUnitFactory *) loadPlugin(pluginInfo));
  5298. else
  5299. factory.setown(new CDaliWorkUnitFactory());
  5300. }
  5301. }
  5302. return factory.getLink();
  5303. }
  5304. extern WORKUNIT_API IWorkUnitFactory * getDaliWorkUnitFactory()
  5305. {
  5306. if (!factory)
  5307. {
  5308. CriticalBlock b(factoryCrit);
  5309. if (!factory) // NOTE - this "double test" paradigm is not guaranteed threadsafe on modern systems/compilers - I think in this instance that is harmless even in the (extremely) unlikely event that it resulted in the setown being called twice.
  5310. factory.setown(new CDaliWorkUnitFactory());
  5311. }
  5312. return factory.getLink();
  5313. }
  5314. // A SecureWorkUnitFactory allows the security params to be supplied once to the factory rather than being supplied to each call.
  5315. // They can still be supplied if you want...
  5316. class CSecureWorkUnitFactory : implements IWorkUnitFactory, public CInterface
  5317. {
  5318. public:
  5319. IMPLEMENT_IINTERFACE;
  5320. CSecureWorkUnitFactory(IWorkUnitFactory *_baseFactory, ISecManager *_secMgr, ISecUser *_secUser)
  5321. : baseFactory(_baseFactory), defaultSecMgr(_secMgr), defaultSecUser(_secUser)
  5322. {
  5323. }
  5324. virtual bool initializeStore()
  5325. {
  5326. throwUnexpected(); // Used when loading a plugin factory - not applicable here
  5327. }
  5328. virtual IWorkUnitWatcher *getWatcher(IWorkUnitSubscriber *subscriber, WUSubscribeOptions options, const char *wuid) const
  5329. {
  5330. return baseFactory->getWatcher(subscriber, options, wuid);
  5331. }
  5332. virtual unsigned validateRepository(bool fix)
  5333. {
  5334. return baseFactory->validateRepository(fix);
  5335. }
  5336. virtual void deleteRepository(bool recreate)
  5337. {
  5338. return baseFactory->deleteRepository(recreate);
  5339. }
  5340. virtual void createRepository()
  5341. {
  5342. return baseFactory->createRepository();
  5343. }
  5344. virtual const char *queryStoreType() const
  5345. {
  5346. return baseFactory->queryStoreType();
  5347. }
  5348. virtual StringArray &getUniqueValues(WUSortField field, const char *prefix, StringArray &result) const
  5349. {
  5350. return baseFactory->getUniqueValues(field, prefix, result);
  5351. }
  5352. virtual IWorkUnit* createNamedWorkUnit(const char *wuid, const char *app, const char *user, ISecManager *secMgr, ISecUser *secUser)
  5353. {
  5354. if (!secMgr) secMgr = defaultSecMgr.get();
  5355. if (!secUser) secUser = defaultSecUser.get();
  5356. return baseFactory->createNamedWorkUnit(wuid, app, user, secMgr, secUser);
  5357. }
  5358. virtual IWorkUnit* createWorkUnit(const char *app, const char *user, ISecManager *secMgr, ISecUser *secUser)
  5359. {
  5360. if (!secMgr) secMgr = defaultSecMgr.get();
  5361. if (!secUser) secUser = defaultSecUser.get();
  5362. return baseFactory->createWorkUnit(app, user, secMgr, secUser);
  5363. }
  5364. virtual bool deleteWorkUnit(const char * wuid, ISecManager *secMgr, ISecUser *secUser)
  5365. {
  5366. if (!secMgr) secMgr = defaultSecMgr.get();
  5367. if (!secUser) secUser = defaultSecUser.get();
  5368. return baseFactory->deleteWorkUnit(wuid, secMgr, secUser);
  5369. }
  5370. virtual bool deleteWorkUnitEx(const char * wuid, bool throwException, ISecManager *secMgr, ISecUser *secUser)
  5371. {
  5372. if (!secMgr) secMgr = defaultSecMgr.get();
  5373. if (!secUser) secUser = defaultSecUser.get();
  5374. return baseFactory->deleteWorkUnitEx(wuid, throwException, secMgr, secUser);
  5375. }
  5376. virtual IConstWorkUnit* openWorkUnit(const char *wuid, ISecManager *secMgr, ISecUser *secUser)
  5377. {
  5378. if (!secMgr) secMgr = defaultSecMgr.get();
  5379. if (!secUser) secUser = defaultSecUser.get();
  5380. return baseFactory->openWorkUnit(wuid, secMgr, secUser);
  5381. }
  5382. virtual IWorkUnit* updateWorkUnit(const char *wuid, ISecManager *secMgr, ISecUser *secUser)
  5383. {
  5384. if (!secMgr) secMgr = defaultSecMgr.get();
  5385. if (!secUser) secUser = defaultSecUser.get();
  5386. return baseFactory->updateWorkUnit(wuid, secMgr, secUser);
  5387. }
  5388. virtual bool restoreWorkUnit(const char *base, const char *wuid, bool restoreAssociated)
  5389. {
  5390. return baseFactory->restoreWorkUnit(base, wuid, restoreAssociated);
  5391. }
  5392. virtual IWorkUnit * getGlobalWorkUnit(ISecManager *secMgr, ISecUser *secUser)
  5393. {
  5394. if (!secMgr) secMgr = defaultSecMgr.get();
  5395. if (!secUser) secUser = defaultSecUser.get();
  5396. return baseFactory->getGlobalWorkUnit(secMgr, secUser);
  5397. }
  5398. virtual IConstWorkUnitIterator * getWorkUnitsByOwner(const char * owner, ISecManager *secMgr, ISecUser *secUser)
  5399. {
  5400. if (!secMgr) secMgr = defaultSecMgr.get();
  5401. if (!secUser) secUser = defaultSecUser.get();
  5402. return baseFactory->getWorkUnitsByOwner(owner, secMgr, secUser);
  5403. }
  5404. virtual IConstWorkUnitIterator * getScheduledWorkUnits(ISecManager *secMgr, ISecUser *secUser)
  5405. {
  5406. if (!secMgr) secMgr = defaultSecMgr.get();
  5407. if (!secUser) secUser = defaultSecUser.get();
  5408. return baseFactory->getScheduledWorkUnits(secMgr, secUser);
  5409. }
  5410. virtual void descheduleAllWorkUnits(ISecManager *secMgr, ISecUser *secUser)
  5411. {
  5412. if (!secMgr) secMgr = defaultSecMgr.get();
  5413. if (!secUser) secUser = defaultSecUser.get();
  5414. baseFactory->descheduleAllWorkUnits(secMgr, secUser);
  5415. }
  5416. virtual int setTracingLevel(int newLevel)
  5417. {
  5418. return baseFactory->setTracingLevel(newLevel);
  5419. }
  5420. virtual IConstWorkUnitIterator* getWorkUnitsSorted( WUSortField sortorder, // field to sort by
  5421. WUSortField *filters, // NULL or list of fields to filter on (terminated by WUSFterm)
  5422. const void *filterbuf, // (appended) string values for filters
  5423. unsigned startoffset,
  5424. unsigned maxnum,
  5425. __int64 *cachehint,
  5426. unsigned *total,
  5427. ISecManager *secMgr, ISecUser *secUser)
  5428. {
  5429. if (!secMgr) secMgr = defaultSecMgr.get();
  5430. if (!secUser) secUser = defaultSecUser.get();
  5431. return baseFactory->getWorkUnitsSorted(sortorder,filters,filterbuf,startoffset,maxnum,cachehint, total, secMgr, secUser);
  5432. }
  5433. virtual IConstQuerySetQueryIterator* getQuerySetQueriesSorted( WUQuerySortField *sortorder,
  5434. WUQuerySortField *filters,
  5435. const void *filterbuf,
  5436. unsigned startoffset,
  5437. unsigned maxnum,
  5438. __int64 *cachehint,
  5439. unsigned *total,
  5440. const MapStringTo<bool> *subset)
  5441. {
  5442. // MORE - why no security?
  5443. return baseFactory->getQuerySetQueriesSorted(sortorder,filters,filterbuf,startoffset,maxnum,cachehint,total,subset);
  5444. }
  5445. virtual unsigned numWorkUnits()
  5446. {
  5447. return baseFactory->numWorkUnits();
  5448. }
  5449. virtual bool isAborting(const char *wuid) const
  5450. {
  5451. return baseFactory->isAborting(wuid);
  5452. }
  5453. virtual void clearAborting(const char *wuid)
  5454. {
  5455. baseFactory->clearAborting(wuid);
  5456. }
  5457. virtual WUState waitForWorkUnit(const char * wuid, unsigned timeout, bool compiled, bool returnOnWaitState)
  5458. {
  5459. return baseFactory->waitForWorkUnit(wuid, timeout, compiled, returnOnWaitState);
  5460. }
  5461. virtual WUAction waitForWorkUnitAction(const char * wuid, WUAction original)
  5462. {
  5463. return baseFactory->waitForWorkUnitAction(wuid, original);
  5464. }
  5465. private:
  5466. Owned<IWorkUnitFactory> baseFactory;
  5467. Linked<ISecManager> defaultSecMgr;
  5468. Linked<ISecUser> defaultSecUser;
  5469. };
  5470. extern WORKUNIT_API IWorkUnitFactory * getWorkUnitFactory(ISecManager *secmgr, ISecUser *secuser)
  5471. {
  5472. if (secmgr && secuser)
  5473. return new CSecureWorkUnitFactory(getWorkUnitFactory(), secmgr, secuser);
  5474. else
  5475. return getWorkUnitFactory();
  5476. }
  5477. //==========================================================================================
  5478. class CStringPTreeIterator : implements IStringIterator, public CInterface
  5479. {
  5480. Owned<IPropertyTreeIterator> it;
  5481. public:
  5482. IMPLEMENT_IINTERFACE;
  5483. CStringPTreeIterator(IPropertyTreeIterator *p) : it(p) {};
  5484. virtual bool first() { return it->first(); }
  5485. virtual bool next() { return it->next(); }
  5486. virtual bool isValid() { return it->isValid(); }
  5487. virtual IStringVal & str(IStringVal &s) { s.set(it->query().queryProp(NULL)); return s; }
  5488. };
  5489. class CStringPTreeTagIterator : implements IStringIterator, public CInterface
  5490. {
  5491. Owned<IPropertyTreeIterator> it;
  5492. public:
  5493. IMPLEMENT_IINTERFACE;
  5494. CStringPTreeTagIterator(IPropertyTreeIterator *p) : it(p) {};
  5495. virtual bool first() { return it->first(); }
  5496. virtual bool next() { return it->next(); }
  5497. virtual bool isValid() { return it->isValid(); }
  5498. virtual IStringVal & str(IStringVal &s) { s.set(it->query().queryName()); return s; }
  5499. };
  5500. class CStringPTreeAttrIterator : implements IStringIterator, public CInterface
  5501. {
  5502. Owned<IPropertyTreeIterator> it;
  5503. StringAttr name;
  5504. public:
  5505. IMPLEMENT_IINTERFACE;
  5506. CStringPTreeAttrIterator(IPropertyTreeIterator *p, const char *_name) : it(p), name(_name) {};
  5507. virtual bool first() { return it->first(); }
  5508. virtual bool next() { return it->next(); }
  5509. virtual bool isValid() { return it->isValid(); }
  5510. virtual IStringVal & str(IStringVal &s) { s.set(it->query().queryProp(name)); return s; }
  5511. };
  5512. //==========================================================================================
  5513. CLocalWorkUnit::CLocalWorkUnit(ISecManager *secmgr, ISecUser *secuser)
  5514. {
  5515. clearCached(false);
  5516. secMgr.set(secmgr);
  5517. secUser.set(secuser);
  5518. workflowIteratorCached = false;
  5519. resultsCached = false;
  5520. graphsCached = false;
  5521. temporariesCached = false;
  5522. variablesCached = false;
  5523. exceptionsCached = false;
  5524. pluginsCached = false;
  5525. librariesCached = false;
  5526. activitiesCached = false;
  5527. webServicesInfoCached = false;
  5528. roxieQueryInfoCached = false;
  5529. }
  5530. void CLocalWorkUnit::clearCached(bool clearTree)
  5531. {
  5532. query.clear();
  5533. webServicesInfo.clear();
  5534. workflowIterator.clear();
  5535. graphs.kill();
  5536. results.kill();
  5537. variables.kill();
  5538. plugins.kill();
  5539. libraries.kill();
  5540. exceptions.kill();
  5541. temporaries.kill();
  5542. statistics.kill();
  5543. appvalues.kill();
  5544. if (clearTree)
  5545. p.clear();
  5546. workflowIteratorCached = false;
  5547. resultsCached = false;
  5548. graphsCached = false;
  5549. temporariesCached = false;
  5550. variablesCached = false;
  5551. exceptionsCached = false;
  5552. pluginsCached = false;
  5553. librariesCached = false;
  5554. activitiesCached = false;
  5555. webServicesInfoCached = false;
  5556. roxieQueryInfoCached = false;
  5557. }
  5558. void CLocalWorkUnit::loadPTree(IPropertyTree *ptree)
  5559. {
  5560. clearCached(false);
  5561. p.setown(ptree);
  5562. }
  5563. void CLocalWorkUnit::beforeDispose()
  5564. {
  5565. try
  5566. {
  5567. unsubscribe();
  5568. clearCached(true);
  5569. userDesc.clear();
  5570. secMgr.clear();
  5571. secUser.clear();
  5572. }
  5573. catch (IException *E) { LOG(MCexception(E, MSGCLS_warning), E, "Exception during ~CLocalWorkUnit"); E->Release(); }
  5574. }
  5575. void CLocalWorkUnit::cleanupAndDelete(bool deldll, bool deleteOwned, const StringArray *deleteExclusions)
  5576. {
  5577. MTIME_SECTION(queryActiveTimer(), "WUDELETE cleanupAndDelete total");
  5578. // Delete any related things in SDS etc that might otherwise be forgotten
  5579. if (p->getPropBool("@protected", false))
  5580. throw MakeStringException(WUERR_WorkunitProtected, "%s: Workunit is protected",p->queryName());
  5581. switch (getState())
  5582. {
  5583. case WUStateAborted:
  5584. case WUStateCompleted:
  5585. case WUStateFailed:
  5586. case WUStateArchived:
  5587. break;
  5588. case WUStateCompiled:
  5589. if (getAction()==WUActionRun || getAction()==WUActionUnknown)
  5590. throw MakeStringException(WUERR_WorkunitActive, "%s: Workunit is active. Please abort before deleting this workunit.",p->queryName());
  5591. break;
  5592. case WUStateWait:
  5593. throw MakeStringException(WUERR_WorkunitScheduled, "%s: Workunit is scheduled",p->queryName());
  5594. default:
  5595. throw MakeStringException(WUERR_WorkunitActive, "%s: Workunit is active. Please abort before deleting this workunit.",p->queryName());
  5596. break;
  5597. }
  5598. if (getIsQueryService())
  5599. {
  5600. Owned<IPropertyTree> registry = getQueryRegistryRoot();
  5601. if (registry)
  5602. {
  5603. VStringBuffer xpath("QuerySet/Query[@wuid='%s']", p->queryName());
  5604. if (registry->hasProp(xpath.str()))
  5605. throw MakeStringException(WUERR_WorkunitPublished, "%s: Workunit is published",p->queryName());
  5606. }
  5607. }
  5608. try
  5609. {
  5610. if (deldll && !p->getPropBool("@isClone", false))
  5611. {
  5612. Owned<IConstWUQuery> q = getQuery();
  5613. if (q)
  5614. {
  5615. Owned<IConstWUAssociatedFileIterator> iter = &q->getAssociatedFiles();
  5616. SCMStringBuffer name;
  5617. ForEach(*iter)
  5618. {
  5619. IConstWUAssociatedFile & cur = iter->query();
  5620. cur.getNameTail(name);
  5621. if (!deleteExclusions || (NotFound == deleteExclusions->find(name.str())))
  5622. {
  5623. Owned<IDllEntry> entry = queryDllServer().getEntry(name.str());
  5624. if (entry.get())
  5625. asyncRemoveDll(name.str());
  5626. else
  5627. {
  5628. SCMStringBuffer ip, localPath;
  5629. cur.getName(localPath);
  5630. cur.getIp(ip);
  5631. asyncRemoveFile(ip.str(), localPath.str());
  5632. }
  5633. }
  5634. }
  5635. }
  5636. }
  5637. factory->clearAborting(queryWuid());
  5638. deleteTempFiles(NULL, deleteOwned, true); // all, any remaining.
  5639. }
  5640. catch(IException *E)
  5641. {
  5642. StringBuffer s;
  5643. LOG(MCexception(E, MSGCLS_warning), E, s.append("Exception during cleanupAndDelete: ").append(p->queryName()).str());
  5644. E->Release();
  5645. }
  5646. catch (...)
  5647. {
  5648. WARNLOG("Unknown exception during cleanupAndDelete: %s", p->queryName());
  5649. }
  5650. }
  5651. void CLocalWorkUnit::setTimeScheduled(const IJlibDateTime &val)
  5652. {
  5653. SCMStringBuffer strval;
  5654. val.getGmtString(strval);
  5655. p->setProp("@timescheduled",strval.str());
  5656. }
  5657. IJlibDateTime & CLocalWorkUnit::getTimeScheduled(IJlibDateTime &val) const
  5658. {
  5659. StringBuffer str;
  5660. p->getProp("@timescheduled",str);
  5661. if(str.length())
  5662. val.setGmtString(str.str());
  5663. return val;
  5664. }
  5665. bool modifyAndWriteWorkUnitXML(char const * wuid, StringBuffer & buf, StringBuffer & extra, IFileIO * fileio)
  5666. {
  5667. // kludge in extra chunks of XML such as GraphProgress and GeneratedDlls
  5668. if (extra.length())
  5669. {
  5670. const char *bufStart = buf.str();
  5671. const char *bufPtr = bufStart+buf.length();
  5672. while (bufStart != bufPtr)
  5673. {
  5674. --bufPtr;
  5675. if (!isspace(*bufPtr))
  5676. break;
  5677. }
  5678. assertex('>' == *bufPtr);
  5679. size_t l = strlen(wuid);
  5680. assertex((size_t)(bufPtr-bufStart) > l+2); // e.g. at least </W20171111-111111>
  5681. bufPtr -= l+2; // skip back over </wuid
  5682. assertex(0 == memcmp(bufPtr, "</", 2) );
  5683. assertex(0 == memcmp(bufPtr+2, wuid, l));
  5684. buf.insert(bufPtr-bufStart, extra);
  5685. }
  5686. return (fileio->write(0,buf.length(),buf.str()) == buf.length());
  5687. }
  5688. bool CLocalWorkUnit::archiveWorkUnit(const char *base, bool del, bool ignoredllerrors, bool deleteOwned, bool exportAssociatedFiles)
  5689. {
  5690. CriticalBlock block(crit);
  5691. StringBuffer path(base);
  5692. if (!p)
  5693. return false;
  5694. const char *wuid = p->queryName();
  5695. if (!wuid||!*wuid)
  5696. return false;
  5697. addPathSepChar(path).append(wuid).append(".xml");
  5698. Owned<IFile> file = createIFile(path.str());
  5699. if (!file)
  5700. return false;
  5701. Owned<IFileIO> fileio = file->open(IFOcreate);
  5702. if (!fileio)
  5703. return false;
  5704. StringBuffer buf;
  5705. exportWorkUnitToXML(this, buf, false, false, true);
  5706. StringBuffer extraWorkUnitXML;
  5707. Owned<IPTree> graphProgress = getGraphProgressTree();
  5708. if (graphProgress)
  5709. {
  5710. toXML(graphProgress,extraWorkUnitXML,1,XML_Format);
  5711. graphProgress.clear();
  5712. }
  5713. Owned<IConstWUQuery> q = getQuery();
  5714. if (!q)
  5715. {
  5716. if (!modifyAndWriteWorkUnitXML(wuid, buf, extraWorkUnitXML, fileio))
  5717. return false;
  5718. if (del)
  5719. {
  5720. if (getState()==WUStateUnknown)
  5721. setState(WUStateArchived); // to allow delete
  5722. cleanupAndDelete(false,deleteOwned); // no query, may as well delete
  5723. }
  5724. return false;
  5725. }
  5726. StringArray deleteExclusions; // associated files not to delete, added if failure to copy
  5727. Owned<IConstWUAssociatedFileIterator> iter = &q->getAssociatedFiles();
  5728. Owned<IPropertyTree> generatedDlls = createPTree("GeneratedDlls");
  5729. ForEach(*iter)
  5730. {
  5731. IConstWUAssociatedFile & cur = iter->query();
  5732. SCMStringBuffer name;
  5733. cur.getNameTail(name);
  5734. if (name.length())
  5735. {
  5736. Owned<IDllEntry> entry = queryDllServer().getEntry(name.str());
  5737. SCMStringBuffer curPath, curIp;
  5738. cur.getName(curPath);
  5739. cur.getIp(curIp);
  5740. SocketEndpoint curEp(curIp.str());
  5741. RemoteFilename curRfn;
  5742. curRfn.setPath(curEp, curPath.str());
  5743. StringBuffer dst(base);
  5744. addPathSepChar(dst);
  5745. curRfn.getTail(dst);
  5746. Owned<IFile> dstFile = createIFile(dst.str());
  5747. if (entry.get())
  5748. {
  5749. Owned<IException> exception;
  5750. Owned<IDllLocation> loc;
  5751. Owned<IPropertyTree> generatedDllBranch = createPTree();
  5752. generatedDllBranch->setProp("@name", entry->queryName());
  5753. generatedDllBranch->setProp("@kind", entry->queryKind());
  5754. if (exportAssociatedFiles)
  5755. {
  5756. try
  5757. {
  5758. loc.setown(entry->getBestLocation()); //throws exception if no readable locations
  5759. }
  5760. catch(IException * e)
  5761. {
  5762. exception.setown(e);
  5763. loc.setown(entry->getBestLocationCandidate()); //this will be closest of the unreadable locations
  5764. }
  5765. RemoteFilename filename;
  5766. loc->getDllFilename(filename);
  5767. if (!exception)
  5768. {
  5769. Owned<IFile> srcfile = createIFile(filename);
  5770. try
  5771. {
  5772. if (dstFile->exists())
  5773. {
  5774. if (streq(srcfile->queryFilename(), dstFile->queryFilename()))
  5775. deleteExclusions.append(name.str()); // restored workunit, referencing archive location for query dll (no longer true post HPCC-11191 fix)
  5776. // still want to delete if already archived but there are source file copies
  5777. }
  5778. else
  5779. copyFile(dstFile, srcfile);
  5780. }
  5781. catch(IException * e)
  5782. {
  5783. exception.setown(e);
  5784. }
  5785. }
  5786. if (exception)
  5787. {
  5788. if (ignoredllerrors)
  5789. {
  5790. EXCLOG(exception.get(), "archiveWorkUnit (copying associated file)");
  5791. //copy failed, so don't delete the registered dll files
  5792. deleteExclusions.append(name.str());
  5793. }
  5794. else
  5795. throw exception.getClear();
  5796. }
  5797. }
  5798. // Record Associated path to restore back to
  5799. StringBuffer restorePath;
  5800. curRfn.getRemotePath(restorePath);
  5801. generatedDllBranch->setProp("@location", restorePath.str());
  5802. generatedDlls->addPropTree("GeneratedDll", generatedDllBranch.getClear());
  5803. }
  5804. else if (exportAssociatedFiles) // no generated dll entry
  5805. {
  5806. Owned<IFile> srcFile = createIFile(curRfn);
  5807. try
  5808. {
  5809. copyFile(dstFile, srcFile);
  5810. }
  5811. catch (IException *e)
  5812. {
  5813. VStringBuffer msg("Failed to archive associated file '%s' to destination '%s'", srcFile->queryFilename(), dstFile->queryFilename());
  5814. EXCLOG(e, msg.str());
  5815. e->Release();
  5816. deleteExclusions.append(name.str());
  5817. }
  5818. }
  5819. }
  5820. }
  5821. iter.clear();
  5822. if (generatedDlls->numChildren())
  5823. toXML(generatedDlls, extraWorkUnitXML, 1, XML_Format);
  5824. if (!modifyAndWriteWorkUnitXML(wuid, buf, extraWorkUnitXML, fileio))
  5825. return false;
  5826. if (del)
  5827. {
  5828. //setState(WUStateArchived); // this isn't useful as about to delete it!
  5829. q.clear();
  5830. cleanupAndDelete(true, deleteOwned, &deleteExclusions);
  5831. }
  5832. return true;
  5833. }
  5834. void CLocalWorkUnit::loadXML(const char *xml)
  5835. {
  5836. CriticalBlock block(crit);
  5837. clearCached(true);
  5838. assertex(xml);
  5839. p.setown(createPTreeFromXMLString(xml,ipt_lowmem));
  5840. }
  5841. void CLocalWorkUnit::serialize(MemoryBuffer &tgt)
  5842. {
  5843. CriticalBlock block(crit);
  5844. StringBuffer x;
  5845. tgt.append(exportWorkUnitToXML(this, x, false, false, false).str());
  5846. }
  5847. void CLocalWorkUnit::deserialize(MemoryBuffer &src)
  5848. {
  5849. CriticalBlock block(crit);
  5850. StringAttr value;
  5851. src.read(value);
  5852. loadXML(value);
  5853. }
  5854. void CLocalWorkUnit::requestAbort()
  5855. {
  5856. CriticalBlock block(crit);
  5857. abortWorkUnit(p->queryName());
  5858. }
  5859. void CLocalWorkUnit::unlockRemote()
  5860. {
  5861. CriticalBlock block(crit);
  5862. locked.unlock();
  5863. _unlockRemote();
  5864. }
  5865. IWorkUnit &CLocalWorkUnit::lockRemote(bool commit)
  5866. {
  5867. if (secMgr)
  5868. checkWuSecAccess(*this, secMgr.get(), secUser.get(), SecAccess_Write, "write lock", true, true);
  5869. locked.lock();
  5870. CriticalBlock block(crit);
  5871. if (commit)
  5872. {
  5873. try
  5874. {
  5875. _lockRemote();
  5876. }
  5877. catch (IException *E)
  5878. {
  5879. StringBuffer s;
  5880. PrintLog("Failed to get write lock on workunit: %s", E->errorMessage(s).str());
  5881. locked.unlock();
  5882. throw;
  5883. }
  5884. }
  5885. return *new CLockedWorkUnit(LINK(this));
  5886. }
  5887. void CLocalWorkUnit::commit()
  5888. {
  5889. // Nothing to do if not backed by a persistent store
  5890. }
  5891. IWorkUnit& CLocalWorkUnit::lock()
  5892. {
  5893. return lockRemote(true);
  5894. }
  5895. const char *CLocalWorkUnit::queryWuid() const
  5896. {
  5897. CriticalBlock block(crit);
  5898. return p->queryName();
  5899. }
  5900. unsigned CLocalWorkUnit::getDebugAgentListenerPort() const
  5901. {
  5902. CriticalBlock block(crit);
  5903. return p->getPropInt("@DebugListenerPort", 0);
  5904. }
  5905. unsigned CLocalWorkUnit::getTotalThorTime() const
  5906. {
  5907. CriticalBlock block(crit);
  5908. return (unsigned)nanoToMilli(extractTimeCollatable(p->queryProp("@totalThorTime"), false));
  5909. }
  5910. void CLocalWorkUnit::setDebugAgentListenerPort(unsigned port)
  5911. {
  5912. CriticalBlock block(crit);
  5913. p->setPropInt("@DebugListenerPort", port);
  5914. }
  5915. IStringVal& CLocalWorkUnit::getDebugAgentListenerIP(IStringVal &ip) const
  5916. {
  5917. CriticalBlock block(crit);
  5918. ip.set(p->queryProp("@DebugListenerIP"));
  5919. return ip;
  5920. }
  5921. void CLocalWorkUnit::setDebugAgentListenerIP(const char * ip)
  5922. {
  5923. CriticalBlock block(crit);
  5924. p->setProp("@DebugListenerIP", ip);
  5925. }
  5926. IStringVal & CLocalWorkUnit::getWorkunitDistributedAccessToken(IStringVal & datoken) const
  5927. {
  5928. CriticalBlock block(crit);
  5929. datoken.set(p->queryProp("@distributedAccessToken"));
  5930. return datoken;
  5931. }
  5932. bool CLocalWorkUnit::setDistributedAccessToken(const char * user)
  5933. {
  5934. CriticalBlock block(crit);
  5935. //If this format changes, you must update the isWorkunitDAToken() and extractFromWorkunitDAToken() methods
  5936. VStringBuffer datoken("HPCC[u=%s,w=%s]", user, queryWuid());
  5937. IDigitalSignatureManager * pDSM = queryDigitalSignatureManagerInstanceFromEnv();
  5938. if (pDSM && pDSM->isDigiSignerConfigured())
  5939. {
  5940. datoken.append(pDSM->queryKeyName()).append(';');
  5941. StringBuffer b64Signature;
  5942. if (pDSM->digiSign(b64Signature, datoken))
  5943. {
  5944. datoken.append(b64Signature.str());
  5945. }
  5946. else
  5947. {
  5948. ERRLOG("Cannot create workunit Distributed Access Token, digisign failed");
  5949. return false;
  5950. }
  5951. }
  5952. else
  5953. {
  5954. WARNLOG("Cannot sign Distributed Access Token, digisign signing not configured");
  5955. datoken.append(";");
  5956. }
  5957. p->setProp("@distributedAccessToken", datoken);
  5958. return true;
  5959. }
  5960. bool CLocalWorkUnit::getRunningGraph(IStringVal &graphName, WUGraphIDType &subId) const
  5961. {
  5962. // Only implemented in derived classes
  5963. return false;
  5964. }
  5965. void CLocalWorkUnit::setJobName(const char *value)
  5966. {
  5967. CriticalBlock block(crit);
  5968. p->setProp("@jobName", value);
  5969. }
  5970. const char *CLocalWorkUnit::queryJobName() const
  5971. {
  5972. CriticalBlock block(crit);
  5973. const char *ret = p->queryProp("@jobName");
  5974. if (!ret)
  5975. ret = "";
  5976. return ret;
  5977. }
  5978. void CLocalWorkUnit::setClusterName(const char *value)
  5979. {
  5980. CriticalBlock block(crit);
  5981. p->setProp("@clusterName", value);
  5982. }
  5983. const char *CLocalWorkUnit::queryClusterName() const
  5984. {
  5985. CriticalBlock block(crit);
  5986. const char *ret = p->queryProp("@clusterName");
  5987. if (!ret)
  5988. ret = "";
  5989. return ret;
  5990. }
  5991. void CLocalWorkUnit::setAllowedClusters(const char *value)
  5992. {
  5993. setDebugValue("allowedclusters",value, true);
  5994. }
  5995. IStringVal& CLocalWorkUnit::getAllowedClusters(IStringVal &str) const
  5996. {
  5997. CriticalBlock block(crit);
  5998. getDebugValue("allowedclusters",str);
  5999. if (str.length()!=0)
  6000. return str;
  6001. str.set(p->queryProp("@clusterName"));
  6002. return str;
  6003. }
  6004. void CLocalWorkUnit::setAllowAutoQueueSwitch(bool val)
  6005. {
  6006. setDebugValueInt("allowautoqueueswitch",val?1:0,true);
  6007. }
  6008. bool CLocalWorkUnit::getAllowAutoQueueSwitch() const
  6009. {
  6010. CriticalBlock block(crit);
  6011. return getDebugValueBool("allowautoqueueswitch",false);
  6012. }
  6013. void CLocalWorkUnit::setLibraryInformation(const char * name, unsigned interfaceHash, unsigned definitionHash)
  6014. {
  6015. StringBuffer suffix;
  6016. if (name && *name)
  6017. setApplicationValue("LibraryModule", "name", name, true);
  6018. setApplicationValueInt("LibraryModule", "interfaceHash", interfaceHash, true);
  6019. setApplicationValueInt("LibraryModule", "definitionHash", definitionHash, true);
  6020. setApplicationValue("LibraryModule", "platform", appendLibrarySuffix(suffix).str(), true);
  6021. }
  6022. void CLocalWorkUnit::remoteCheckAccess(IUserDescriptor *user, bool writeaccess) const
  6023. {
  6024. unsigned auditflags = DALI_LDAP_AUDIT_REPORT|DALI_LDAP_READ_WANTED;
  6025. if (writeaccess)
  6026. auditflags |= DALI_LDAP_WRITE_WANTED;
  6027. SecAccessFlags perm = SecAccess_Full;
  6028. const char *scopename = p->queryProp("@scope");
  6029. if (scopename&&*scopename) {
  6030. if (!user)
  6031. user = queryUserDescriptor();
  6032. CDateTime now;
  6033. perm = querySessionManager().getPermissionsLDAP("workunit",scopename,user,auditflags,nullptr,now);
  6034. if (perm<0) {
  6035. if (perm == SecAccess_Unavailable)
  6036. perm = SecAccess_Full;
  6037. else
  6038. perm = SecAccess_None;
  6039. }
  6040. }
  6041. if (!HASREADPERMISSION(perm))
  6042. throw MakeStringException(WUERR_WorkunitAccessDenied, "Read access denied for workunit %s", queryWuid());
  6043. if (writeaccess && !HASWRITEPERMISSION(perm))
  6044. throw MakeStringException(WUERR_WorkunitAccessDenied, "Write access denied for workunit %s", queryWuid());
  6045. }
  6046. void CLocalWorkUnit::setUser(const char * value)
  6047. {
  6048. CriticalBlock block(crit);
  6049. p->setProp("@submitID", value);
  6050. }
  6051. const char *CLocalWorkUnit::queryUser() const
  6052. {
  6053. CriticalBlock block(crit);
  6054. const char *ret = p->queryProp("@submitID");
  6055. if (!ret)
  6056. ret = "";
  6057. return ret;
  6058. }
  6059. void CLocalWorkUnit::setWuScope(const char * value)
  6060. {
  6061. if (value && *value)
  6062. {
  6063. if (checkWuScopeSecAccess(value, secMgr.get(), secUser.get(), SecAccess_Write, "Change Scope", true, true))
  6064. {
  6065. CriticalBlock block(crit);
  6066. p->setProp("@scope", value);
  6067. }
  6068. }
  6069. }
  6070. const char *CLocalWorkUnit::queryWuScope() const
  6071. {
  6072. CriticalBlock block(crit);
  6073. const char *ret = p->queryProp("@scope");
  6074. if (!ret)
  6075. ret = "";
  6076. return ret;
  6077. }
  6078. void CLocalWorkUnit::setPriority(WUPriorityClass cls)
  6079. {
  6080. CriticalBlock block(crit);
  6081. setEnum(p, "@priorityClass", cls, priorityClasses);
  6082. }
  6083. WUPriorityClass CLocalWorkUnit::getPriority() const
  6084. {
  6085. CriticalBlock block(crit);
  6086. return (WUPriorityClass) getEnum(p, "@priorityClass", priorityClasses);
  6087. }
  6088. const char *CLocalWorkUnit::queryPriorityDesc() const
  6089. {
  6090. return getEnumText(getPriority(), priorityClasses);
  6091. }
  6092. void CLocalWorkUnit::setState(WUState value)
  6093. {
  6094. if (value==WUStateAborted || value==WUStatePaused || value==WUStateCompleted || value==WUStateFailed || value==WUStateSubmitted || value==WUStateWait)
  6095. {
  6096. if (factory)
  6097. factory->clearAborting(queryWuid());
  6098. }
  6099. CriticalBlock block(crit);
  6100. setEnum(p, "@state", value, states); // For historical reasons, we use state to store the state
  6101. setEnum(p, "State", value, states); // But we can only subscribe to elements, not attributes
  6102. if (getDebugValueBool("monitorWorkunit", false))
  6103. {
  6104. switch(value)
  6105. {
  6106. case WUStateAborted:
  6107. FLLOG(MCoperatorWarning, "Workunit %s aborted", p->queryName());
  6108. break;
  6109. case WUStateCompleted:
  6110. FLLOG(MCoperatorProgress, "Workunit %s completed", p->queryName());
  6111. break;
  6112. case WUStateFailed:
  6113. FLLOG(MCoperatorProgress, "Workunit %s failed", p->queryName());
  6114. break;
  6115. }
  6116. }
  6117. p->removeProp("@stateEx");
  6118. }
  6119. void CLocalWorkUnit::setStateEx(const char * text)
  6120. {
  6121. CriticalBlock block(crit);
  6122. p->setProp("@stateEx", text);
  6123. }
  6124. void CLocalWorkUnit::setAgentSession(__int64 sessionId)
  6125. {
  6126. CriticalBlock block(crit);
  6127. p->setPropInt64("@agentSession", sessionId);
  6128. }
  6129. bool CLocalWorkUnit::getIsQueryService() const
  6130. {
  6131. CriticalBlock block(crit);
  6132. return p->getPropBool("@isQueryService", false);
  6133. }
  6134. void CLocalWorkUnit::setIsQueryService(bool value)
  6135. {
  6136. CriticalBlock block(crit);
  6137. p->setPropBool("@isQueryService", value);
  6138. }
  6139. void CLocalWorkUnit::checkAgentRunning(WUState & state)
  6140. {
  6141. if (queryDaliServerVersion().compare("2.1")<0)
  6142. return;
  6143. switch(state)
  6144. {
  6145. case WUStateRunning:
  6146. case WUStateDebugPaused:
  6147. case WUStateDebugRunning:
  6148. case WUStateBlocked:
  6149. case WUStateAborting:
  6150. case WUStateCompiling:
  6151. case WUStatePaused:
  6152. {
  6153. SessionId agent = getAgentSession();
  6154. if((agent>0) && querySessionManager().sessionStopped(agent, 0))
  6155. {
  6156. forceReload();
  6157. state = (WUState) getEnum(p, "@state", states);
  6158. bool isecl=state==WUStateCompiling;
  6159. if (aborting())
  6160. state = WUStateAborted;
  6161. else if (state==WUStateRunning || state==WUStatePaused || state==WUStateDebugPaused || state==WUStateDebugRunning || state==WUStateBlocked || state==WUStateCompiling)
  6162. state = WUStateFailed;
  6163. else
  6164. return;
  6165. WARNLOG("checkAgentRunning terminated: %" I64F "d state = %d",(__int64)agent,(int)state);
  6166. Owned<IWorkUnit> w = &lock();
  6167. w->setState(state);
  6168. Owned<IWUException> e = w->createException();
  6169. WUAction action = w->getAction();
  6170. switch (action)
  6171. {
  6172. case WUActionPause:
  6173. case WUActionPauseNow:
  6174. case WUActionResume:
  6175. w->setAction(WUActionUnknown);
  6176. }
  6177. if(isecl)
  6178. {
  6179. e->setExceptionCode(1001);
  6180. e->setExceptionMessage("EclServer terminated unexpectedly");
  6181. }
  6182. else
  6183. {
  6184. e->setExceptionCode(1000);
  6185. e->setExceptionMessage("Workunit terminated unexpectedly");
  6186. }
  6187. }
  6188. }
  6189. }
  6190. }
  6191. WUState CLocalWorkUnit::getState() const
  6192. {
  6193. CriticalBlock block(crit);
  6194. WUState state = (WUState) getEnum(p, "@state", states);
  6195. switch (state)
  6196. {
  6197. case WUStateRunning:
  6198. case WUStateDebugPaused:
  6199. case WUStateDebugRunning:
  6200. case WUStateBlocked:
  6201. case WUStateCompiling:
  6202. if (aborting())
  6203. state = WUStateAborting;
  6204. break;
  6205. case WUStateSubmitted:
  6206. if (aborting())
  6207. state = WUStateAborted;
  6208. break;
  6209. }
  6210. const_cast<CLocalWorkUnit *>(this)->checkAgentRunning(state); //need const_cast as will change state if agent has died
  6211. return state;
  6212. }
  6213. IStringVal& CLocalWorkUnit::getStateEx(IStringVal & str) const
  6214. {
  6215. CriticalBlock block(crit);
  6216. str.set(p->queryProp("@stateEx"));
  6217. return str;
  6218. }
  6219. __int64 CLocalWorkUnit::getAgentSession() const
  6220. {
  6221. CriticalBlock block(crit);
  6222. return p->getPropInt64("@agentSession", -1);
  6223. }
  6224. unsigned CLocalWorkUnit::getAgentPID() const
  6225. {
  6226. CriticalBlock block(crit);
  6227. return p->getPropInt("@agentPID", -1);
  6228. }
  6229. const char * CLocalWorkUnit::queryStateDesc() const
  6230. {
  6231. // MORE - not sure about this - may prefer a separate interface
  6232. CriticalBlock block(crit);
  6233. try
  6234. {
  6235. return getEnumText(getState(), states);
  6236. }
  6237. catch (...)
  6238. {
  6239. return "???";
  6240. }
  6241. }
  6242. void CLocalWorkUnit::setAction(WUAction value)
  6243. {
  6244. CriticalBlock block(crit);
  6245. setEnum(p, "Action", value, actions);
  6246. }
  6247. WUAction CLocalWorkUnit::getAction() const
  6248. {
  6249. CriticalBlock block(crit);
  6250. return (WUAction) getEnum(p, "Action", actions);
  6251. }
  6252. const char *CLocalWorkUnit::queryActionDesc() const
  6253. {
  6254. CriticalBlock block(crit);
  6255. return p->queryProp("Action");
  6256. }
  6257. IStringVal& CLocalWorkUnit::getApplicationValue(const char *app, const char *propname, IStringVal &str) const
  6258. {
  6259. CriticalBlock block(crit);
  6260. StringBuffer prop("Application/");
  6261. prop.append(app).append('/').append(propname);
  6262. str.set(p->queryProp(prop.str()));
  6263. return str;
  6264. }
  6265. int CLocalWorkUnit::getApplicationValueInt(const char *app, const char *propname, int defVal) const
  6266. {
  6267. CriticalBlock block(crit);
  6268. StringBuffer prop("Application/");
  6269. prop.append(app).append('/').append(propname);
  6270. return p->getPropInt(prop.str(), defVal);
  6271. }
  6272. IConstWUAppValueIterator& CLocalWorkUnit::getApplicationValues() const
  6273. {
  6274. CriticalBlock block(crit);
  6275. appvalues.load(p,"Application/*");
  6276. return *new CArrayIteratorOf<IConstWUAppValue,IConstWUAppValueIterator> (appvalues, 0, (IConstWorkUnit *) this);
  6277. }
  6278. void CLocalWorkUnit::setApplicationValue(const char *app, const char *propname, const char *value, bool overwrite)
  6279. {
  6280. CriticalBlock block(crit);
  6281. StringBuffer prop("Application/");
  6282. prop.append(app).append('/').append(propname);
  6283. if (overwrite || !p->hasProp(prop.str()))
  6284. {
  6285. StringBuffer sp;
  6286. p->setProp(sp.append("Application").str(), "");
  6287. p->setProp(sp.append('/').append(app).str(), "");
  6288. p->setProp(prop.str(), value);
  6289. }
  6290. }
  6291. void CLocalWorkUnit::setApplicationValueInt(const char *app, const char *propname, int value, bool overwrite)
  6292. {
  6293. VStringBuffer s("%d", value);
  6294. setApplicationValue(app, propname, s, overwrite);
  6295. }
  6296. void CLocalWorkUnit::setPriorityLevel(int level)
  6297. {
  6298. CriticalBlock block(crit);
  6299. p->setPropInt("PriorityFlag", level);
  6300. }
  6301. int CLocalWorkUnit::getPriorityLevel() const
  6302. {
  6303. CriticalBlock block(crit);
  6304. return p->getPropInt("PriorityFlag");
  6305. }
  6306. int calcPriorityValue(const IPropertyTree * p)
  6307. {
  6308. int priority = p->getPropInt("PriorityFlag");
  6309. switch((WUPriorityClass) getEnum(p, "@priorityClass", priorityClasses))
  6310. {
  6311. case PriorityClassLow:
  6312. priority -= 100;
  6313. break;
  6314. case PriorityClassHigh:
  6315. priority += 100;
  6316. break;
  6317. }
  6318. return priority;
  6319. }
  6320. int CLocalWorkUnit::getPriorityValue() const
  6321. {
  6322. CriticalBlock block(crit);
  6323. return calcPriorityValue(p);
  6324. }
  6325. void CLocalWorkUnit::setRescheduleFlag(bool value)
  6326. {
  6327. CriticalBlock block(crit);
  6328. p->setPropInt("RescheduleFlag", (int) value);
  6329. }
  6330. bool CLocalWorkUnit::getRescheduleFlag() const
  6331. {
  6332. CriticalBlock block(crit);
  6333. return p->getPropInt("RescheduleFlag") != 0;
  6334. }
  6335. class NullIStringIterator : implements IStringIterator, public CInterface
  6336. {
  6337. public:
  6338. IMPLEMENT_IINTERFACE;
  6339. bool first() { return false; }
  6340. bool next() { return false; }
  6341. bool isValid() { return false; }
  6342. IStringVal & str(IStringVal & str) { return str; }
  6343. };
  6344. ClusterType getClusterType(const char * platform, ClusterType dft)
  6345. {
  6346. if (stricmp(platform, "thor") == 0)
  6347. return ThorLCRCluster;
  6348. if (stricmp(platform, "thorlcr") == 0)
  6349. return ThorLCRCluster;
  6350. if (stricmp(platform, "hthor") == 0)
  6351. return HThorCluster;
  6352. if (stricmp(platform, "roxie") == 0)
  6353. return RoxieCluster;
  6354. return dft;
  6355. }
  6356. const char *clusterTypeString(ClusterType clusterType, bool lcrSensitive)
  6357. {
  6358. switch (clusterType)
  6359. {
  6360. case ThorLCRCluster:
  6361. if (lcrSensitive)
  6362. return "thorlcr";
  6363. return "thor";
  6364. case RoxieCluster:
  6365. return "roxie";
  6366. case HThorCluster:
  6367. return "hthor";
  6368. }
  6369. throwUnexpected();
  6370. }
  6371. bool extractFromWorkunitDAToken(const char * distributedAccessToken, StringBuffer * wuid, StringBuffer * user, StringBuffer * privKey)
  6372. {
  6373. if (!isWorkunitDAToken(distributedAccessToken))
  6374. {
  6375. DBGLOG("Not a valid workunit distributed access token");
  6376. return false;
  6377. }
  6378. //Extract the string between [ and ]
  6379. const char * pEndBracket = strchr(distributedAccessToken + 5, ']');
  6380. StringBuffer tokenValues;
  6381. tokenValues.append(pEndBracket - distributedAccessToken - 5, distributedAccessToken + 5);
  6382. StringArray nameValues;
  6383. nameValues.appendList(tokenValues.str(), ",",true);
  6384. if (user || wuid)
  6385. {
  6386. for (int x = 0; x < nameValues.ordinality(); x++)
  6387. {
  6388. if (user && 0==strncmp(nameValues[x],"u=",2))//Extract user
  6389. user->append(nameValues[x] + 2);
  6390. if (wuid && 0==strncmp(nameValues[x],"w=",2))//Extract wuid
  6391. wuid->append(nameValues[x] + 2);
  6392. }
  6393. }
  6394. if (privKey)
  6395. {
  6396. const char * finger = pEndBracket;
  6397. ++finger;
  6398. while (*finger && *finger != ';')
  6399. privKey->append(1, finger++);
  6400. }
  6401. return true;
  6402. }
  6403. //Verifies the given signed workunit distributed access token was created
  6404. //and signed by the given wuid and user, and that the workunit is still active
  6405. //Returns:
  6406. // 0 : Success, token is valid and workunit is active
  6407. // 1 : Signature does not verify (wuid/username don't match, or signature does not verify)
  6408. // 2 : Workunit not active
  6409. // Throws if unable to open workunit
  6410. wuTokenStates verifyWorkunitDAToken(const char * ctxUser, const char * daToken)
  6411. {
  6412. if (isEmptyString(daToken))
  6413. {
  6414. ERRLOG("verifyWorkunitDAToken : Token must be provided");
  6415. return wuTokenInvalid;
  6416. }
  6417. StringBuffer tokWuid;
  6418. StringBuffer tokUser;
  6419. if (!extractFromWorkunitDAToken(daToken, &tokWuid, &tokUser, nullptr))//get the wuid and user
  6420. {
  6421. //Not a valid workunit distributed access token
  6422. return wuTokenInvalid;
  6423. }
  6424. //Validate signature
  6425. IDigitalSignatureManager * pDSM = queryDigitalSignatureManagerInstanceFromEnv();
  6426. if (pDSM && pDSM->isDigiVerifierConfigured())
  6427. {
  6428. const char * finger;
  6429. StringBuffer token;//receives copy of everything up until signature
  6430. for (finger = daToken; *finger && *finger != ';'; finger++)
  6431. token.append(1, finger);
  6432. token.append(1, finger);//append ;
  6433. StringBuffer sig(++finger);
  6434. if (!pDSM->digiVerify(sig, token))
  6435. {
  6436. ERRLOG("verifyWorkunitDAToken : workunit distributed access token does not verify");
  6437. return wuTokenInvalid;
  6438. }
  6439. }
  6440. Owned<IWorkUnitFactory> factory = getWorkUnitFactory();
  6441. Owned<IConstWorkUnit> cw = factory->openWorkUnit(tokWuid.str());
  6442. if(!cw)
  6443. {
  6444. throw MakeStringException(WUERR_WorkunitAccessDenied,"verifyWorkunitDAToken : Cannot open workunit %s",tokWuid.str());
  6445. }
  6446. //Verify user matches
  6447. bool wuUserExist = !isEmptyString(cw->queryUser());
  6448. bool tokUserExist = !isEmptyString(tokUser.str());
  6449. bool ctxUserExist = !isEmptyString(ctxUser);
  6450. if (wuUserExist && tokUserExist)
  6451. {
  6452. //if both users are found, they must match
  6453. if (!streq(tokUser.str(), cw->queryUser()))
  6454. {
  6455. ERRLOG("verifyWorkunitDAToken : Token user (%s) does not match WU user (%s)", tokUser.str(), cw->queryUser());
  6456. return wuTokenInvalid;//Possible Internal error
  6457. }
  6458. else if (ctxUserExist && !streq(tokUser.str(), ctxUser))//ctxUser will be empty if security not enabled
  6459. {
  6460. ERRLOG("verifyWorkunitDAToken : Token user (%s) does not match Context user (%s)", cw->queryUser(), ctxUser);
  6461. return wuTokenInvalid;
  6462. }
  6463. }
  6464. else if (!wuUserExist && !tokUserExist)//both users will be empty if no security enabled
  6465. {
  6466. if (ctxUserExist)
  6467. {
  6468. ERRLOG("verifyWorkunitDAToken : Security enabled but WU user and Token user not specified");
  6469. return wuTokenInvalid;
  6470. }
  6471. //both users empty and no context user means if no security enabled
  6472. }
  6473. else
  6474. {
  6475. //one user found, but not the other, treat as an error
  6476. ERRLOG("verifyWorkunitDAToken : WU user %s and Token user %s must be provided", wuUserExist ? cw->queryUser() : "(NULL)", tokUserExist ? tokUser.str() : "(NULL)");
  6477. return wuTokenInvalid;
  6478. }
  6479. // no need to compare tokWuid with workunit wuid, because it will always match
  6480. bool wuActive;
  6481. switch (cw->getState())
  6482. {
  6483. case WUStateRunning:
  6484. case WUStateDebugRunning:
  6485. case WUStateBlocked:
  6486. case WUStateAborting:
  6487. case WUStateUploadingFiles:
  6488. #ifdef _DEBUG
  6489. DBGLOG("verifyWorkunitDAToken : Workunit token validated for %s %s, state is '%s'", cw->queryWuid(), cw->queryUser(), getWorkunitStateStr(cw->getState()));
  6490. #endif
  6491. wuActive = true;
  6492. break;
  6493. default:
  6494. ERRLOG("verifyWorkunitDAToken : Workunit %s not active, state is '%s'", cw->queryWuid(), getWorkunitStateStr(cw->getState()));
  6495. wuActive = false;
  6496. break;
  6497. }
  6498. return wuActive ? wuTokenValid : wuTokenWorkunitInactive;
  6499. }
  6500. IPropertyTree *queryRoxieProcessTree(IPropertyTree *environment, const char *process)
  6501. {
  6502. if (!process || !*process)
  6503. return NULL;
  6504. VStringBuffer xpath("Software/RoxieCluster[@name=\"%s\"]", process);
  6505. return environment->queryPropTree(xpath.str());
  6506. }
  6507. void getRoxieProcessServers(IPropertyTree *roxie, SocketEndpointArray &endpoints)
  6508. {
  6509. if (!roxie)
  6510. return;
  6511. Owned<IPropertyTreeIterator> servers = roxie->getElements("RoxieServerProcess");
  6512. ForEach(*servers)
  6513. {
  6514. IPropertyTree &server = servers->query();
  6515. const char *netAddress = server.queryProp("@netAddress");
  6516. if (netAddress && *netAddress)
  6517. {
  6518. SocketEndpoint ep(netAddress, server.getPropInt("@port", 9876));
  6519. endpoints.append(ep);
  6520. }
  6521. }
  6522. }
  6523. void getRoxieProcessServers(const char *process, SocketEndpointArray &servers)
  6524. {
  6525. Owned<IEnvironmentFactory> factory = getEnvironmentFactory(true);
  6526. Owned<IConstEnvironment> env = factory->openEnvironment();
  6527. Owned<IPropertyTree> root = &env->getPTree();
  6528. getRoxieProcessServers(queryRoxieProcessTree(root, process), servers);
  6529. }
  6530. class CEnvironmentClusterInfo: implements IConstWUClusterInfo, public CInterface
  6531. {
  6532. StringAttr name;
  6533. StringAttr alias;
  6534. StringAttr serverQueue;
  6535. StringAttr agentQueue;
  6536. StringAttr agentName;
  6537. StringAttr roxieProcess;
  6538. SocketEndpointArray roxieServers;
  6539. StringAttr thorQueue;
  6540. StringArray thorProcesses;
  6541. StringArray primaryThorProcesses;
  6542. StringAttr prefix;
  6543. StringAttr ldapUser;
  6544. StringBuffer ldapPassword;
  6545. ClusterType platform;
  6546. unsigned clusterWidth;
  6547. unsigned roxieRedundancy;
  6548. unsigned channelsPerNode;
  6549. unsigned numberOfSlaveLogs;
  6550. int roxieReplicateOffset;
  6551. public:
  6552. IMPLEMENT_IINTERFACE;
  6553. CEnvironmentClusterInfo(const char *_name, const char *_prefix, const char *_alias, IPropertyTree *agent, IArrayOf<IPropertyTree> &thors, IPropertyTree *roxie)
  6554. : name(_name), prefix(_prefix), alias(_alias), roxieRedundancy(0), channelsPerNode(0), numberOfSlaveLogs(0), roxieReplicateOffset(1)
  6555. {
  6556. StringBuffer queue;
  6557. if (thors.ordinality())
  6558. {
  6559. thorQueue.set(getClusterThorQueueName(queue.clear(), name));
  6560. clusterWidth = 0;
  6561. bool isMultiThor = (thors.length() > 1);
  6562. ForEachItemIn(i,thors)
  6563. {
  6564. IPropertyTree &thor = thors.item(i);
  6565. const char* thorName = thor.queryProp("@name");
  6566. thorProcesses.append(thorName);
  6567. if (!isMultiThor)
  6568. primaryThorProcesses.append(thorName);
  6569. else
  6570. {
  6571. const char *nodeGroup = thor.queryProp("@nodeGroup");
  6572. if (!nodeGroup || strieq(nodeGroup, thorName))
  6573. primaryThorProcesses.append(thorName);
  6574. }
  6575. unsigned nodes = thor.getCount("ThorSlaveProcess");
  6576. if (!nodes)
  6577. throw MakeStringException(WUERR_MismatchClusterSize,"CEnvironmentClusterInfo: Thor cluster can not have 0 slave processes");
  6578. unsigned slavesPerNode = thor.getPropInt("@slavesPerNode", 1);
  6579. unsigned channelsPerSlave = thor.getPropInt("@channelsPerSlave", 1);
  6580. unsigned ts = nodes * slavesPerNode * channelsPerSlave;
  6581. numberOfSlaveLogs = nodes * slavesPerNode;
  6582. if (clusterWidth && (ts!=clusterWidth))
  6583. throw MakeStringException(WUERR_MismatchClusterSize,"CEnvironmentClusterInfo: mismatched thor sizes in cluster");
  6584. clusterWidth = ts;
  6585. bool islcr = !thor.getPropBool("@Legacy");
  6586. if (!islcr)
  6587. throw MakeStringException(WUERR_MismatchThorType,"CEnvironmentClusterInfo: Legacy Thor no longer supported");
  6588. }
  6589. platform = ThorLCRCluster;
  6590. }
  6591. else if (roxie)
  6592. {
  6593. roxieProcess.set(roxie->queryProp("@name"));
  6594. platform = RoxieCluster;
  6595. getRoxieProcessServers(roxie, roxieServers);
  6596. clusterWidth = roxieServers.length();
  6597. ldapUser.set(roxie->queryProp("@ldapUser"));
  6598. StringBuffer encPassword = roxie->queryProp("@ldapPassword");
  6599. if (encPassword.length())
  6600. decrypt(ldapPassword, encPassword);
  6601. const char *redundancyMode = roxie->queryProp("@slaveConfig");
  6602. if (redundancyMode && *redundancyMode)
  6603. {
  6604. unsigned dataCopies = roxie->getPropInt("@numDataCopies", 1);
  6605. if (strieq(redundancyMode, "overloaded"))
  6606. channelsPerNode = roxie->getPropInt("@channelsPernode", 1);
  6607. else if (strieq(redundancyMode, "full redundancy"))
  6608. {
  6609. roxieRedundancy = dataCopies-1;
  6610. roxieReplicateOffset = 0;
  6611. }
  6612. else if (strieq(redundancyMode, "cyclic redundancy"))
  6613. {
  6614. roxieRedundancy = dataCopies-1;
  6615. channelsPerNode = dataCopies;
  6616. roxieReplicateOffset = roxie->getPropInt("@cyclicOffset", 1);
  6617. }
  6618. }
  6619. }
  6620. else
  6621. {
  6622. clusterWidth = 1;
  6623. platform = HThorCluster;
  6624. }
  6625. if (agent)
  6626. {
  6627. assertex(!roxie);
  6628. agentQueue.set(getClusterEclAgentQueueName(queue.clear(), name));
  6629. agentName.set(agent->queryProp("@name"));
  6630. }
  6631. else if (roxie)
  6632. agentQueue.set(getClusterRoxieQueueName(queue.clear(), name));
  6633. // MORE - does this need to be conditional?
  6634. serverQueue.set(getClusterEclCCServerQueueName(queue.clear(), name));
  6635. }
  6636. IStringVal & getName(IStringVal & str) const
  6637. {
  6638. str.set(name.get());
  6639. return str;
  6640. }
  6641. const char *getAlias() const
  6642. {
  6643. return alias;
  6644. }
  6645. IStringVal & getScope(IStringVal & str) const
  6646. {
  6647. str.set(prefix.get());
  6648. return str;
  6649. }
  6650. IStringVal & getAgentQueue(IStringVal & str) const
  6651. {
  6652. str.set(agentQueue);
  6653. return str;
  6654. }
  6655. IStringVal & getAgentName(IStringVal & str) const
  6656. {
  6657. str.set(agentName);
  6658. return str;
  6659. }
  6660. virtual IStringVal & getServerQueue(IStringVal & str) const
  6661. {
  6662. str.set(serverQueue);
  6663. return str;
  6664. }
  6665. IStringVal & getThorQueue(IStringVal & str) const
  6666. {
  6667. str.set(thorQueue);
  6668. return str;
  6669. }
  6670. unsigned getSize() const
  6671. {
  6672. return clusterWidth;
  6673. }
  6674. unsigned getNumberOfSlaveLogs() const
  6675. {
  6676. return numberOfSlaveLogs;
  6677. }
  6678. virtual ClusterType getPlatform() const
  6679. {
  6680. return platform;
  6681. }
  6682. IStringVal & getRoxieProcess(IStringVal & str) const
  6683. {
  6684. str.set(roxieProcess.get());
  6685. return str;
  6686. }
  6687. const StringArray & getThorProcesses() const
  6688. {
  6689. return thorProcesses;
  6690. }
  6691. const StringArray & getPrimaryThorProcesses() const
  6692. {
  6693. return primaryThorProcesses;
  6694. }
  6695. const SocketEndpointArray & getRoxieServers() const
  6696. {
  6697. return roxieServers;
  6698. }
  6699. unsigned getRoxieRedundancy() const
  6700. {
  6701. return roxieRedundancy;
  6702. }
  6703. unsigned getChannelsPerNode() const
  6704. {
  6705. return channelsPerNode;
  6706. }
  6707. int getRoxieReplicateOffset() const
  6708. {
  6709. return roxieReplicateOffset;
  6710. }
  6711. const char *getLdapUser() const
  6712. {
  6713. return ldapUser.get();
  6714. }
  6715. virtual const char *getLdapPassword() const
  6716. {
  6717. return ldapPassword.str();
  6718. }
  6719. };
  6720. IStringVal &getProcessQueueNames(IStringVal &ret, const char *process, const char *type, const char *suffix)
  6721. {
  6722. if (process)
  6723. {
  6724. Owned<IEnvironmentFactory> factory = getEnvironmentFactory(true);
  6725. Owned<IConstEnvironment> env = factory->openEnvironment();
  6726. Owned<IPropertyTree> root = &env->getPTree();
  6727. StringBuffer queueNames;
  6728. StringBuffer xpath;
  6729. xpath.appendf("%s[@process=\"%s\"]", type, process);
  6730. Owned<IPropertyTreeIterator> targets = root->getElements("Software/Topology/Cluster");
  6731. ForEach(*targets)
  6732. {
  6733. IPropertyTree &target = targets->query();
  6734. if (target.hasProp(xpath))
  6735. {
  6736. if (queueNames.length())
  6737. queueNames.append(',');
  6738. queueNames.append(target.queryProp("@name")).append(suffix);
  6739. }
  6740. }
  6741. ret.set(queueNames);
  6742. }
  6743. return ret;
  6744. }
  6745. #define ROXIE_QUEUE_EXT ".roxie"
  6746. #define THOR_QUEUE_EXT ".thor"
  6747. #define ECLCCSERVER_QUEUE_EXT ".eclserver"
  6748. #define ECLSERVER_QUEUE_EXT ECLCCSERVER_QUEUE_EXT
  6749. #define ECLSCHEDULER_QUEUE_EXT ".eclscheduler"
  6750. #define ECLAGENT_QUEUE_EXT ".agent"
  6751. extern WORKUNIT_API void getDFUServerQueueNames(StringArray &ret, const char *process)
  6752. {
  6753. Owned<IEnvironmentFactory> factory = getEnvironmentFactory(true);
  6754. Owned<IConstEnvironment> env = factory->openEnvironment();
  6755. StringBuffer xpath = "Software/DfuServerProcess";
  6756. if (!isEmptyString(process))
  6757. xpath.appendf("[@name=\"%s\"]", process);
  6758. Owned<IPropertyTree> root = &env->getPTree();
  6759. Owned<IPropertyTreeIterator> targets = root->getElements(xpath.str());
  6760. ForEach(*targets)
  6761. {
  6762. IPropertyTree &target = targets->query();
  6763. if (target.hasProp("@queue"))
  6764. ret.appendListUniq(target.queryProp("@queue"), ",");
  6765. }
  6766. return;
  6767. }
  6768. extern WORKUNIT_API IStringVal &getEclCCServerQueueNames(IStringVal &ret, const char *process)
  6769. {
  6770. return getProcessQueueNames(ret, process, "EclCCServerProcess", ECLCCSERVER_QUEUE_EXT);
  6771. }
  6772. extern WORKUNIT_API IStringVal &getEclServerQueueNames(IStringVal &ret, const char *process)
  6773. {
  6774. return getProcessQueueNames(ret, process, "EclServerProcess", ECLSERVER_QUEUE_EXT); // shares queue name with EclCCServer
  6775. }
  6776. extern WORKUNIT_API IStringVal &getEclSchedulerQueueNames(IStringVal &ret, const char *process)
  6777. {
  6778. return getProcessQueueNames(ret, process, "EclSchedulerProcess", ECLSCHEDULER_QUEUE_EXT); // Shares deployment/config with EclCCServer
  6779. }
  6780. extern WORKUNIT_API IStringVal &getAgentQueueNames(IStringVal &ret, const char *process)
  6781. {
  6782. return getProcessQueueNames(ret, process, "EclAgentProcess", ECLAGENT_QUEUE_EXT);
  6783. }
  6784. extern WORKUNIT_API IStringVal &getRoxieQueueNames(IStringVal &ret, const char *process)
  6785. {
  6786. return getProcessQueueNames(ret, process, "RoxieCluster", ROXIE_QUEUE_EXT);
  6787. }
  6788. extern WORKUNIT_API IStringVal &getThorQueueNames(IStringVal &ret, const char *process)
  6789. {
  6790. return getProcessQueueNames(ret, process, "ThorCluster", THOR_QUEUE_EXT);
  6791. }
  6792. extern WORKUNIT_API StringBuffer &getClusterThorQueueName(StringBuffer &ret, const char *cluster)
  6793. {
  6794. return ret.append(cluster).append(THOR_QUEUE_EXT);
  6795. }
  6796. extern WORKUNIT_API StringBuffer &getClusterThorGroupName(StringBuffer &ret, const char *cluster)
  6797. {
  6798. Owned<IEnvironmentFactory> factory = getEnvironmentFactory(true);
  6799. Owned<IConstEnvironment> env = factory->openEnvironment();
  6800. Owned<IPropertyTree> root = &env->getPTree();
  6801. StringBuffer path;
  6802. path.append("Software/ThorCluster[@name=\"").append(cluster).append("\"]");
  6803. IPropertyTree * child = root->queryPropTree(path);
  6804. if (child)
  6805. getClusterGroupName(*child, ret);
  6806. return ret;
  6807. }
  6808. extern WORKUNIT_API StringBuffer &getClusterGroupName(StringBuffer &ret, const char *cluster)
  6809. {
  6810. Owned<IEnvironmentFactory> factory = getEnvironmentFactory(true);
  6811. Owned<IConstEnvironment> env = factory->openEnvironment();
  6812. Owned<IPropertyTree> root = &env->getPTree();
  6813. StringBuffer path;
  6814. path.set("Software/ThorCluster[@name=\"").append(cluster).append("\"]");
  6815. IPropertyTree * child = root->queryPropTree(path);
  6816. if (child)
  6817. {
  6818. return getClusterGroupName(*child, ret);
  6819. }
  6820. path.set("Software/RoxieCluster[@name=\"").append(cluster).append("\"]");
  6821. child = root->queryPropTree(path);
  6822. if (child)
  6823. {
  6824. return getClusterGroupName(*child, ret);
  6825. }
  6826. path.set("Software/EclAgentProcess[@name=\"").append(cluster).append("\"]");
  6827. child = root->queryPropTree(path);
  6828. if (child)
  6829. {
  6830. return ret.setf("hthor__%s", cluster);
  6831. }
  6832. return ret;
  6833. }
  6834. extern WORKUNIT_API ClusterType getClusterTypeByClusterName(const char *cluster)
  6835. {
  6836. Owned<IEnvironmentFactory> factory = getEnvironmentFactory(true);
  6837. Owned<IConstEnvironment> env = factory->openEnvironment();
  6838. Owned<IPropertyTree> root = &env->getPTree();
  6839. StringBuffer path;
  6840. path.set("Software/ThorCluster[@name=\"").append(cluster).append("\"]");
  6841. if (root->hasProp(path))
  6842. return ThorLCRCluster;
  6843. path.set("Software/RoxieCluster[@name=\"").append(cluster).append("\"]");
  6844. if (root->hasProp(path))
  6845. return RoxieCluster;
  6846. path.set("Software/EclAgentProcess[@name=\"").append(cluster).append("\"]");
  6847. if (root->hasProp(path))
  6848. return HThorCluster;
  6849. return NoCluster;
  6850. }
  6851. extern WORKUNIT_API StringBuffer &getClusterRoxieQueueName(StringBuffer &ret, const char *cluster)
  6852. {
  6853. return ret.append(cluster).append(ROXIE_QUEUE_EXT);
  6854. }
  6855. extern WORKUNIT_API StringBuffer &getClusterEclCCServerQueueName(StringBuffer &ret, const char *cluster)
  6856. {
  6857. return ret.append(cluster).append(ECLCCSERVER_QUEUE_EXT);
  6858. }
  6859. extern WORKUNIT_API StringBuffer &getClusterEclServerQueueName(StringBuffer &ret, const char *cluster)
  6860. {
  6861. return ret.append(cluster).append(ECLSERVER_QUEUE_EXT);
  6862. }
  6863. extern WORKUNIT_API StringBuffer &getClusterEclAgentQueueName(StringBuffer &ret, const char *cluster)
  6864. {
  6865. return ret.append(cluster).append(ECLAGENT_QUEUE_EXT);
  6866. }
  6867. extern WORKUNIT_API IStringIterator *getTargetClusters(const char *processType, const char *processName)
  6868. {
  6869. Owned<CStringArrayIterator> ret = new CStringArrayIterator;
  6870. Owned<IEnvironmentFactory> factory = getEnvironmentFactory(true);
  6871. Owned<IConstEnvironment> env = factory->openEnvironment();
  6872. Owned<IPropertyTree> root = &env->getPTree();
  6873. StringBuffer xpath;
  6874. xpath.appendf("%s", processType ? processType : "*");
  6875. if (processName && *processName)
  6876. xpath.appendf("[@process=\"%s\"]", processName);
  6877. Owned<IPropertyTreeIterator> targets = root->getElements("Software/Topology/Cluster");
  6878. ForEach(*targets)
  6879. {
  6880. IPropertyTree &target = targets->query();
  6881. if (target.hasProp(xpath))
  6882. {
  6883. ret->append(target.queryProp("@name"));
  6884. }
  6885. }
  6886. return ret.getClear();
  6887. }
  6888. extern WORKUNIT_API bool isProcessCluster(const char *process)
  6889. {
  6890. if (!process || !*process)
  6891. return false;
  6892. Owned<IEnvironmentFactory> factory = getEnvironmentFactory(true);
  6893. Owned<IConstEnvironment> env = factory->openEnvironment();
  6894. Owned<IPropertyTree> root = &env->getPTree();
  6895. VStringBuffer xpath("Software/*Cluster[@name=\"%s\"]", process);
  6896. return root->hasProp(xpath.str());
  6897. }
  6898. extern WORKUNIT_API bool isProcessCluster(const char *remoteDali, const char *process)
  6899. {
  6900. if (!remoteDali || !*remoteDali)
  6901. return isProcessCluster(process);
  6902. if (!process || !*process)
  6903. return false;
  6904. Owned<INode> remote = createINode(remoteDali, 7070);
  6905. if (!remote)
  6906. return false;
  6907. //Cannot use getEnvironmentFactory() since it is using a remotedali
  6908. VStringBuffer xpath("Environment/Software/*Cluster[@name=\"%s\"]/@name", process);
  6909. try
  6910. {
  6911. Owned<IPropertyTreeIterator> clusters = querySDS().getElementsRaw(xpath, remote, 1000*60*1);
  6912. return clusters->first();
  6913. }
  6914. catch (IException *E)
  6915. {
  6916. StringBuffer msg;
  6917. E->errorMessage(msg);
  6918. DBGLOG("Exception validating cluster %s/%s: %s", remoteDali, xpath.str(), msg.str());
  6919. E->Release();
  6920. }
  6921. return true;
  6922. }
  6923. IConstWUClusterInfo* getTargetClusterInfo(IPropertyTree *environment, IPropertyTree *cluster)
  6924. {
  6925. const char *clustname = cluster->queryProp("@name");
  6926. // MORE - at the moment configenf specifies eclagent and thor queues by (in effect) placing an 'example' thor or eclagent in the topology
  6927. // that uses the queue that will be used.
  6928. // We should and I hope will change that, at which point the code below gets simpler
  6929. StringBuffer prefix(cluster->queryProp("@prefix"));
  6930. prefix.toLowerCase();
  6931. StringBuffer xpath;
  6932. StringBuffer querySetName;
  6933. IPropertyTree *agent = NULL;
  6934. const char *agentName = cluster->queryProp("EclAgentProcess/@process");
  6935. if (agentName)
  6936. {
  6937. xpath.clear().appendf("Software/EclAgentProcess[@name=\"%s\"]", agentName);
  6938. agent = environment->queryPropTree(xpath.str());
  6939. }
  6940. Owned<IPropertyTreeIterator> ti = cluster->getElements("ThorCluster");
  6941. IArrayOf<IPropertyTree> thors;
  6942. ForEach(*ti)
  6943. {
  6944. const char *thorName = ti->query().queryProp("@process");
  6945. if (thorName)
  6946. {
  6947. xpath.clear().appendf("Software/ThorCluster[@name=\"%s\"]", thorName);
  6948. thors.append(*environment->getPropTree(xpath.str()));
  6949. }
  6950. }
  6951. const char *roxieName = cluster->queryProp("RoxieCluster/@process");
  6952. return new CEnvironmentClusterInfo(clustname, prefix, cluster->queryProp("@alias"), agent, thors, queryRoxieProcessTree(environment, roxieName));
  6953. }
  6954. IPropertyTree* getTopologyCluster(Owned<IPropertyTree> &envRoot, const char *clustname)
  6955. {
  6956. if (!clustname || !*clustname)
  6957. return NULL;
  6958. Owned<IEnvironmentFactory> factory = getEnvironmentFactory(true);
  6959. Owned<IConstEnvironment> env = factory->openEnvironment();
  6960. envRoot.setown(&env->getPTree());
  6961. StringBuffer xpath;
  6962. xpath.appendf("Software/Topology/Cluster[@name=\"%s\"]", clustname);
  6963. return envRoot->getPropTree(xpath.str());
  6964. }
  6965. bool validateTargetClusterName(const char *clustname)
  6966. {
  6967. Owned<IPropertyTree> envRoot;
  6968. Owned<IPropertyTree> cluster = getTopologyCluster(envRoot, clustname);
  6969. return (cluster.get()!=NULL);
  6970. }
  6971. IConstWUClusterInfo* getTargetClusterInfo(const char *clustname)
  6972. {
  6973. Owned<IPropertyTree> envRoot;
  6974. Owned<IPropertyTree> cluster = getTopologyCluster(envRoot, clustname);
  6975. if (!cluster)
  6976. return NULL;
  6977. return getTargetClusterInfo(envRoot, cluster);
  6978. }
  6979. unsigned getEnvironmentClusterInfo(CConstWUClusterInfoArray &clusters)
  6980. {
  6981. Owned<IEnvironmentFactory> factory = getEnvironmentFactory(true);
  6982. Owned<IConstEnvironment> env = factory->openEnvironment();
  6983. Owned<IPropertyTree> root = &env->getPTree();
  6984. return getEnvironmentClusterInfo(root, clusters);
  6985. }
  6986. unsigned getEnvironmentClusterInfo(IPropertyTree* environmentRoot, CConstWUClusterInfoArray &clusters)
  6987. {
  6988. if (!environmentRoot)
  6989. return 0;
  6990. Owned<IPropertyTreeIterator> clusterIter = environmentRoot->getElements("Software/Topology/Cluster");
  6991. ForEach(*clusterIter)
  6992. {
  6993. IPropertyTree &node = clusterIter->query();
  6994. Owned<IConstWUClusterInfo> cluster = getTargetClusterInfo(environmentRoot, &node);
  6995. clusters.append(*cluster.getClear());
  6996. }
  6997. return clusters.ordinality();
  6998. }
  6999. const char *getTargetClusterComponentName(const char *clustname, const char *processType, StringBuffer &name)
  7000. {
  7001. if (!clustname)
  7002. return NULL;
  7003. Owned<IEnvironmentFactory> factory = getEnvironmentFactory(true);
  7004. Owned<IConstEnvironment> env = factory->openEnvironment();
  7005. Owned<IPropertyTree> root = &env->getPTree();
  7006. StringBuffer xpath;
  7007. xpath.appendf("Software/Topology/Cluster[@name=\"%s\"]", clustname);
  7008. Owned<IPropertyTree> cluster = root->getPropTree(xpath.str());
  7009. if (!cluster)
  7010. return NULL;
  7011. StringBuffer xpath1;
  7012. xpath1.appendf("%s/@process", processType);
  7013. name.append(cluster->queryProp(xpath1.str()));
  7014. return name.str();
  7015. }
  7016. unsigned getEnvironmentThorClusterNames(StringArray &thorNames, StringArray &groupNames, StringArray &targetNames, StringArray &queueNames)
  7017. {
  7018. Owned<IEnvironmentFactory> factory = getEnvironmentFactory(true);
  7019. Owned<IConstEnvironment> env = factory->openEnvironment();
  7020. Owned<IPropertyTree> root = &env->getPTree();
  7021. Owned<IPropertyTreeIterator> allTargets = root->getElements("Software/Topology/Cluster");
  7022. ForEach(*allTargets)
  7023. {
  7024. IPropertyTree &target = allTargets->query();
  7025. const char *targetName = target.queryProp("@name");
  7026. if (targetName && *targetName)
  7027. {
  7028. Owned<IPropertyTreeIterator> thorClusters = target.getElements("ThorCluster");
  7029. ForEach(*thorClusters)
  7030. {
  7031. const char *thorName = thorClusters->query().queryProp("@process");
  7032. VStringBuffer query("Software/ThorCluster[@name=\"%s\"]",thorName);
  7033. IPropertyTree *thorCluster = root->queryPropTree(query.str());
  7034. if (thorCluster)
  7035. {
  7036. const char *groupName = thorCluster->queryProp("@nodeGroup");
  7037. if (!groupName||!*groupName)
  7038. groupName = thorName;
  7039. thorNames.append(thorName);
  7040. groupNames.append(groupName);
  7041. targetNames.append(targetName);
  7042. StringBuffer queueName(targetName);
  7043. queueNames.append(queueName.append(THOR_QUEUE_EXT));
  7044. }
  7045. }
  7046. }
  7047. }
  7048. return thorNames.ordinality();
  7049. }
  7050. unsigned getEnvironmentHThorClusterNames(StringArray &eclAgentNames, StringArray &groupNames, StringArray &targetNames)
  7051. {
  7052. Owned<IEnvironmentFactory> factory = getEnvironmentFactory(true);
  7053. Owned<IConstEnvironment> env = factory->openEnvironment();
  7054. Owned<IPropertyTree> root = &env->getPTree();
  7055. Owned<IPropertyTreeIterator> allEclAgents = root->getElements("Software/EclAgentProcess");
  7056. ForEach(*allEclAgents)
  7057. {
  7058. IPropertyTree &eclAgent = allEclAgents->query();
  7059. const char *eclAgentName = eclAgent.queryProp("@name");
  7060. if (eclAgentName && *eclAgentName)
  7061. {
  7062. Owned<IPropertyTreeIterator> allTargets = root->getElements("Software/Topology/Cluster");
  7063. ForEach(*allTargets)
  7064. {
  7065. IPropertyTree &target = allTargets->query();
  7066. const char *targetName = target.queryProp("@name");
  7067. if (targetName && *targetName)
  7068. {
  7069. StringBuffer xpath;
  7070. xpath.appendf("EclAgentProcess[@process=\"%s\"]", eclAgentName);
  7071. if (target.hasProp(xpath) && !target.hasProp("ThorCluster"))
  7072. {
  7073. StringBuffer groupName("hthor__");
  7074. groupName.append(eclAgentName);
  7075. groupNames.append(groupName);
  7076. eclAgentNames.append(eclAgentName);
  7077. targetNames.append(targetName);
  7078. }
  7079. }
  7080. }
  7081. }
  7082. }
  7083. return eclAgentNames.ordinality();
  7084. }
  7085. IStringVal& CLocalWorkUnit::getScope(IStringVal &str) const
  7086. {
  7087. CriticalBlock block(crit);
  7088. if (p->hasProp("Debug/ForceScope"))
  7089. {
  7090. StringBuffer prefix(p->queryProp("Debug/ForceScope"));
  7091. str.set(prefix.toLowerCase().str());
  7092. }
  7093. else
  7094. {
  7095. Owned <IConstWUClusterInfo> ci = getTargetClusterInfo(p->queryProp("@clusterName"));
  7096. if (ci)
  7097. ci->getScope(str);
  7098. else
  7099. str.clear();
  7100. }
  7101. return str;
  7102. }
  7103. //Queries
  7104. void CLocalWorkUnit::setCodeVersion(unsigned codeVersion, const char * buildVersion, const char * eclVersion)
  7105. {
  7106. CriticalBlock block(crit);
  7107. p->setPropInt("@codeVersion", codeVersion);
  7108. p->setProp("@buildVersion", buildVersion);
  7109. p->setProp("@eclVersion", eclVersion);
  7110. }
  7111. unsigned CLocalWorkUnit::getCodeVersion() const
  7112. {
  7113. CriticalBlock block(crit);
  7114. return p->getPropInt("@codeVersion");
  7115. }
  7116. unsigned CLocalWorkUnit::getWuidVersion() const
  7117. {
  7118. CriticalBlock block(crit);
  7119. return p->getPropInt("@wuidVersion");
  7120. }
  7121. void CLocalWorkUnit::getBuildVersion(IStringVal & buildVersion, IStringVal & eclVersion) const
  7122. {
  7123. CriticalBlock block(crit);
  7124. buildVersion.set(p->queryProp("@buildVersion"));
  7125. eclVersion.set(p->queryProp("@eclVersion"));
  7126. }
  7127. void CLocalWorkUnit::setCloneable(bool value)
  7128. {
  7129. CriticalBlock block(crit);
  7130. p->setPropInt("@cloneable", value);
  7131. }
  7132. void CLocalWorkUnit::setIsClone(bool value)
  7133. {
  7134. CriticalBlock block(crit);
  7135. p->setPropInt("@isClone", value);
  7136. }
  7137. bool CLocalWorkUnit::getCloneable() const
  7138. {
  7139. CriticalBlock block(crit);
  7140. return p->getPropBool("@cloneable", false);
  7141. }
  7142. IUserDescriptor *CLocalWorkUnit::queryUserDescriptor() const
  7143. {
  7144. CriticalBlock block(crit);
  7145. if (!userDesc)
  7146. {
  7147. userDesc.setown(createUserDescriptor());
  7148. SCMStringBuffer token;
  7149. getWorkunitDistributedAccessToken(token);
  7150. userDesc->set(queryUser(), token.str());//use token as password
  7151. }
  7152. return userDesc;
  7153. }
  7154. bool CLocalWorkUnit::isProtected() const
  7155. {
  7156. CriticalBlock block(crit);
  7157. return p->getPropBool("@protected", false);
  7158. }
  7159. bool CLocalWorkUnit::isPausing() const
  7160. {
  7161. CriticalBlock block(crit);
  7162. if (WUActionPause == getAction())
  7163. {
  7164. switch (getState())
  7165. {
  7166. case WUStateRunning:
  7167. case WUStateAborting:
  7168. return true;
  7169. }
  7170. }
  7171. return false;
  7172. }
  7173. void CLocalWorkUnit::protect(bool protectMode)
  7174. {
  7175. CriticalBlock block(crit);
  7176. p->setPropBool("@protected", protectMode);
  7177. }
  7178. void CLocalWorkUnit::setResultLimit(unsigned value)
  7179. {
  7180. CriticalBlock block(crit);
  7181. p->setPropInt("resultLimit", value);
  7182. }
  7183. unsigned CLocalWorkUnit::getResultLimit() const
  7184. {
  7185. CriticalBlock block(crit);
  7186. return p->getPropInt("resultLimit");
  7187. }
  7188. IStringVal & CLocalWorkUnit::getSnapshot(IStringVal & str) const
  7189. {
  7190. CriticalBlock block(crit);
  7191. str.set(p->queryProp("SNAPSHOT"));
  7192. return str;
  7193. }
  7194. void CLocalWorkUnit::setSnapshot(const char * val)
  7195. {
  7196. CriticalBlock block(crit);
  7197. p->setProp("SNAPSHOT", val);
  7198. }
  7199. const static EnumMapping warningSeverityMap[] =
  7200. {
  7201. { SeverityInformation, "info" },
  7202. { SeverityWarning, "warning" },
  7203. { SeverityError, "error" },
  7204. { SeverityAlert, "alert" },
  7205. { SeverityIgnore, "ignore" },
  7206. { SeverityFatal, "fatal" },
  7207. { SeverityUnknown, NULL }
  7208. };
  7209. ErrorSeverity CLocalWorkUnit::getWarningSeverity(unsigned code, ErrorSeverity defaultSeverity) const
  7210. {
  7211. StringBuffer xpath;
  7212. xpath.append("OnWarnings/OnWarning[@code='").append(code).append("']");
  7213. CriticalBlock block(crit);
  7214. IPropertyTree * mapping = p->queryPropTree(xpath);
  7215. if (mapping)
  7216. return (ErrorSeverity) getEnum(mapping, "@severity", warningSeverityMap);
  7217. return defaultSeverity;
  7218. }
  7219. void CLocalWorkUnit::setWarningSeverity(unsigned code, ErrorSeverity severity)
  7220. {
  7221. StringBuffer xpath;
  7222. xpath.append("OnWarnings/OnWarning[@code='").append(code).append("']");
  7223. CriticalBlock block(crit);
  7224. IPropertyTree * mapping = p->queryPropTree(xpath);
  7225. if (!mapping)
  7226. {
  7227. IPropertyTree * onWarnings = ensurePTree(p, "OnWarnings");
  7228. mapping = onWarnings->addPropTree("OnWarning");
  7229. mapping->setPropInt("@code", code);
  7230. }
  7231. setEnum(mapping, "@severity", severity, warningSeverityMap);
  7232. }
  7233. static int comparePropTrees(IInterface * const *ll, IInterface * const *rr)
  7234. {
  7235. IPropertyTree *l = (IPropertyTree *) *ll;
  7236. IPropertyTree *r = (IPropertyTree *) *rr;
  7237. return stricmp(l->queryName(), r->queryName());
  7238. };
  7239. unsigned CLocalWorkUnit::calculateHash(unsigned crc)
  7240. {
  7241. // Any other values in the WU that could affect generated code should be crc'ed here
  7242. IPropertyTree *tree = p->queryBranch("Debug");
  7243. if (tree)
  7244. {
  7245. Owned<IPropertyTreeIterator> sub = tree->getElements("*");
  7246. ICopyArrayOf<IPropertyTree> subs;
  7247. for(sub->first(); sub->isValid(); sub->next())
  7248. subs.append(sub->query());
  7249. subs.sort(comparePropTrees);
  7250. ForEachItemIn(idx, subs)
  7251. {
  7252. const char *name = subs.item(idx).queryName();
  7253. const char *val = subs.item(idx).queryProp(NULL);
  7254. crc = crc32(name, (size32_t)strlen(name), crc);
  7255. if (val)
  7256. crc = crc32(val, (size32_t)strlen(val), crc);
  7257. }
  7258. }
  7259. Owned<IConstWUPluginIterator> plugins = &getPlugins();
  7260. for (plugins->first();plugins->isValid();plugins->next())
  7261. {
  7262. IConstWUPlugin &thisplugin = plugins->query();
  7263. SCMStringBuffer version;
  7264. thisplugin.getPluginVersion(version);
  7265. crc = crc32(version.str(), version.length(), crc);
  7266. }
  7267. return crc;
  7268. }
  7269. static void updateProp(IPropertyTree * to, const IPropertyTree * from, const char * xpath)
  7270. {
  7271. if (!to->hasProp(xpath) && from->hasProp(xpath))
  7272. to->setProp(xpath, from->queryProp(xpath));
  7273. }
  7274. static void setProp(IPropertyTree * to, const IPropertyTree * from, const char * xpath)
  7275. {
  7276. if (from->hasProp(xpath))
  7277. to->setProp(xpath, from->queryProp(xpath));
  7278. }
  7279. static void copyTree(IPropertyTree * to, const IPropertyTree * from, const char * xpath)
  7280. {
  7281. IPropertyTree * match = from->getBranch(xpath);
  7282. if (match)
  7283. to->setPropTree(xpath, match);
  7284. }
  7285. IPropertyTree *CLocalWorkUnit::queryPTree() const
  7286. {
  7287. return p;
  7288. }
  7289. void CLocalWorkUnit::copyWorkUnit(IConstWorkUnit *cached, bool copyStats, bool all)
  7290. {
  7291. CLocalWorkUnit *from = QUERYINTERFACE(cached, CLocalWorkUnit);
  7292. if (!from)
  7293. {
  7294. CLockedWorkUnit *fl = QUERYINTERFACE(cached, CLockedWorkUnit);
  7295. if (!fl)
  7296. throw MakeStringException(WUERR_InternalUnknownImplementation, "Cached workunit not created using workunit dll");
  7297. from = fl->c;
  7298. }
  7299. // Need to copy the query, the results, and the graphs from the cached query.
  7300. // The cache is made before the query is executed so there is no need to clear them.
  7301. if (!cached->getCloneable())
  7302. throw MakeStringException(WUERR_CannotCloneWorkunit, "Source work unit not marked as clonable");
  7303. const IPropertyTree * fromP = from->p;
  7304. IPropertyTree *pt;
  7305. CriticalBlock block(crit);
  7306. clearCached(false);
  7307. query.clear();
  7308. updateProp(p, fromP, "@jobName");
  7309. copyTree(p, fromP, "Query");
  7310. pt = fromP->getBranch("Application/LibraryModule");
  7311. if (pt)
  7312. {
  7313. ensurePTree(p, "Application");
  7314. p->setPropTree("Application/LibraryModule", pt);
  7315. }
  7316. pt = fromP->queryBranch("Debug");
  7317. if (pt)
  7318. {
  7319. IPropertyTree *curDebug = p->queryPropTree("Debug");
  7320. if (curDebug)
  7321. {
  7322. Owned<IPropertyTreeIterator> elems = pt->getElements("*");
  7323. ForEach(*elems)
  7324. {
  7325. IPropertyTree *elem = &elems->query();
  7326. if (!curDebug->hasProp(elem->queryName()))
  7327. curDebug->setPropTree(elem->queryName(),LINK(elem));
  7328. }
  7329. }
  7330. else
  7331. p->setPropTree("Debug", LINK(pt));
  7332. }
  7333. copyTree(p, fromP, "OnWarnings");
  7334. copyTree(p, fromP, "Plugins");
  7335. copyTree(p, fromP, "Libraries");
  7336. copyTree(p, fromP, "Results");
  7337. copyTree(p, fromP, "Graphs");
  7338. copyTree(p, fromP, "Workflow");
  7339. copyTree(p, fromP, "WebServicesInfo");
  7340. if (copyStats)
  7341. {
  7342. // Merge timing info from both branches
  7343. pt = fromP->getBranch("Statistics");
  7344. if (pt)
  7345. {
  7346. IPropertyTree *tgtStatistics = ensurePTree(p, "Statistics");
  7347. mergePTree(tgtStatistics, pt);
  7348. pt->Release();
  7349. }
  7350. }
  7351. updateProp(p, fromP, "@clusterName");
  7352. updateProp(p, fromP, "allowedclusters");
  7353. updateProp(p, fromP, "@submitID");
  7354. updateProp(p, fromP, "SNAPSHOT");
  7355. setProp(p, fromP, "@eventScheduledCount");
  7356. //MORE: This is very adhoc. All options that should be cloned should really be in a common branch
  7357. if (all)
  7358. {
  7359. setProp(p, fromP, "PriorityFlag");
  7360. setProp(p, fromP, "@priorityClass");
  7361. setProp(p, fromP, "@protected");
  7362. setProp(p, fromP, "@clusterName");
  7363. updateProp(p, fromP, "@scope");
  7364. }
  7365. //Variables may have been set up as parameters to the query - so need to preserve any values that were supplied.
  7366. pt = fromP->getBranch("Variables");
  7367. if (pt)
  7368. {
  7369. IPropertyTree *ptTgtVariables = ensurePTree(p, "Variables");
  7370. Owned<IPropertyTreeIterator> ptiVariable = pt->getElements("Variable");
  7371. for (ptiVariable->first(); ptiVariable->isValid(); ptiVariable->next())
  7372. {
  7373. IPropertyTree *ptSrcVariable = &ptiVariable->query();
  7374. const char *name = ptSrcVariable->queryProp("@name");
  7375. assertex(name);
  7376. StringBuffer xpath;
  7377. xpath.append("Variable[@name='").append(name).append("']");
  7378. IPropertyTree *ptTgtVariable = ptTgtVariables->queryPropTree(xpath.str());
  7379. IPropertyTree *merged = createPTreeFromIPT(ptSrcVariable); // clone entire source info...
  7380. merged->removeProp("Value"); // except value and status
  7381. merged->setProp("@status", "undefined");
  7382. if (!merged->getPropBool("@isScalar"))
  7383. merged->removeProp("totalRowCount");
  7384. merged->removeProp("rowCount");
  7385. // If there are any other fields that get set ONLY by eclagent, strip them out here...
  7386. if (ptTgtVariable)
  7387. {
  7388. // copy status and Value from what is already set in target
  7389. merged->setProp("@status", ptTgtVariable->queryProp("@status"));
  7390. MemoryBuffer value;
  7391. if (ptTgtVariable->getPropBin("Value", value))
  7392. merged->setPropBin("Value", value.length(), value.toByteArray());
  7393. ptTgtVariable->removeProp(xpath.str());
  7394. // If there are any other fields in a variable that get set by ws_ecl before submitting, copy them across here...
  7395. }
  7396. ptTgtVariables->addPropTree("Variable", merged);
  7397. }
  7398. pt->Release();
  7399. }
  7400. p->setProp("@codeVersion", fromP->queryProp("@codeVersion"));
  7401. p->setProp("@buildVersion", fromP->queryProp("@buildVersion"));
  7402. p->setProp("@eclVersion", fromP->queryProp("@eclVersion"));
  7403. p->setProp("@totalThorTime", fromP->queryProp("@totalThorTime"));
  7404. p->setProp("@hash", fromP->queryProp("@hash"));
  7405. p->setPropBool("@cloneable", true);
  7406. p->setPropBool("@isClone", true);
  7407. resetWorkflow(); // the source Workflow section may have had some parts already executed...
  7408. Owned<IPropertyTreeIterator> results = p->getElements("Results/Result");
  7409. ForEach(*results)
  7410. {
  7411. CLocalWUResult result(LINK(&results->query()));
  7412. result.setResultStatus(ResultStatusUndefined);
  7413. }
  7414. copyTree(p, fromP, "usedsources"); // field usage
  7415. }
  7416. bool CLocalWorkUnit::hasDebugValue(const char *propname) const
  7417. {
  7418. StringBuffer lower;
  7419. lower.append(propname).toLowerCase();
  7420. CriticalBlock block(crit);
  7421. StringBuffer prop("Debug/");
  7422. return p->hasProp(prop.append(lower));
  7423. }
  7424. IStringVal& CLocalWorkUnit::getDebugValue(const char *propname, IStringVal &str) const
  7425. {
  7426. StringBuffer lower;
  7427. lower.append(propname).toLowerCase();
  7428. CriticalBlock block(crit);
  7429. StringBuffer prop("Debug/");
  7430. str.set(p->queryProp(prop.append(lower).str()));
  7431. return str;
  7432. }
  7433. IStringIterator& CLocalWorkUnit::getDebugValues() const
  7434. {
  7435. return getDebugValues(NULL);
  7436. }
  7437. IStringIterator& CLocalWorkUnit::getDebugValues(const char *prop) const
  7438. {
  7439. CriticalBlock block(crit);
  7440. StringBuffer path("Debug/");
  7441. if (prop)
  7442. {
  7443. StringBuffer lower;
  7444. lower.append(prop).toLowerCase();
  7445. path.append(lower);
  7446. }
  7447. else
  7448. path.append("*");
  7449. return *new CStringPTreeTagIterator(p->getElements(path.str()));
  7450. }
  7451. int CLocalWorkUnit::getDebugValueInt(const char *propname, int defVal) const
  7452. {
  7453. StringBuffer lower;
  7454. lower.append(propname).toLowerCase();
  7455. CriticalBlock block(crit);
  7456. StringBuffer prop("Debug/");
  7457. prop.append(lower);
  7458. return p->getPropInt(prop.str(), defVal);
  7459. }
  7460. __int64 CLocalWorkUnit::getDebugValueInt64(const char *propname, __int64 defVal) const
  7461. {
  7462. StringBuffer lower;
  7463. lower.append(propname).toLowerCase();
  7464. CriticalBlock block(crit);
  7465. StringBuffer prop("Debug/");
  7466. prop.append(lower);
  7467. return p->getPropInt64(prop.str(), defVal);
  7468. }
  7469. bool CLocalWorkUnit::getDebugValueBool(const char * propname, bool defVal) const
  7470. {
  7471. StringBuffer lower;
  7472. lower.append(propname).toLowerCase();
  7473. CriticalBlock block(crit);
  7474. StringBuffer prop("Debug/");
  7475. prop.append(lower);
  7476. return p->getPropBool(prop.str(), defVal);
  7477. }
  7478. IStringIterator *CLocalWorkUnit::getLogs(const char *type, const char *instance) const
  7479. {
  7480. VStringBuffer xpath("Process/%s/", type);
  7481. if (instance)
  7482. xpath.append(instance);
  7483. else
  7484. xpath.append("*");
  7485. CriticalBlock block(crit);
  7486. if (p->getPropInt("@wuidVersion") < 1) // legacy wuid
  7487. {
  7488. // NB: instance unused
  7489. if (streq("EclAgent", type))
  7490. return new CStringPTreeIterator(p->getElements("Debug/eclagentlog"));
  7491. else if (streq("Thor", type))
  7492. return new CStringPTreeIterator(p->getElements("Debug/thorlog*"));
  7493. VStringBuffer xpath("Debug/%s", type);
  7494. return new CStringPTreeIterator(p->getElements(xpath.str()));
  7495. }
  7496. else
  7497. return new CStringPTreeAttrIterator(p->getElements(xpath.str()), "@log");
  7498. }
  7499. IPropertyTreeIterator* CLocalWorkUnit::getProcesses(const char *type, const char *instance) const
  7500. {
  7501. VStringBuffer xpath("Process/%s/", type);
  7502. if (instance)
  7503. xpath.append(instance);
  7504. else
  7505. xpath.append("*");
  7506. CriticalBlock block(crit);
  7507. return p->getElements(xpath.str());
  7508. }
  7509. IStringIterator *CLocalWorkUnit::getProcesses(const char *type) const
  7510. {
  7511. VStringBuffer xpath("Process/%s/*", type);
  7512. CriticalBlock block(crit);
  7513. return new CStringPTreeTagIterator(p->getElements(xpath.str()));
  7514. }
  7515. void CLocalWorkUnit::addProcess(const char *type, const char *instance, unsigned pid, const char *log)
  7516. {
  7517. VStringBuffer processType("Process/%s", type);
  7518. VStringBuffer xpath("%s/%s", processType.str(), instance);
  7519. if (log)
  7520. xpath.appendf("[@log=\"%s\"]", log);
  7521. CriticalBlock block(crit);
  7522. if (!p->hasProp(xpath))
  7523. {
  7524. IPropertyTree *node = ensurePTree(p, processType.str());
  7525. node = node->addPropTree(instance);
  7526. node->setProp("@log", log);
  7527. node->setPropInt("@pid", pid);
  7528. }
  7529. }
  7530. void CLocalWorkUnit::setDebugValue(const char *propname, const char *value, bool overwrite)
  7531. {
  7532. StringBuffer lower;
  7533. lower.append(propname).toLowerCase();
  7534. CriticalBlock block(crit);
  7535. StringBuffer prop("Debug/");
  7536. prop.append(lower);
  7537. if (overwrite || !p->hasProp(prop.str()))
  7538. {
  7539. // MORE - not sure this line should be needed....
  7540. p->setProp("Debug", "");
  7541. p->setProp(prop.str(), value);
  7542. }
  7543. }
  7544. void CLocalWorkUnit::setDebugValueInt(const char *propname, int value, bool overwrite)
  7545. {
  7546. StringBuffer lower;
  7547. lower.append(propname).toLowerCase();
  7548. CriticalBlock block(crit);
  7549. StringBuffer prop("Debug/");
  7550. prop.append(lower);
  7551. if (overwrite || !p->hasProp(prop.str()))
  7552. {
  7553. // MORE - not sure this line should be needed....
  7554. p->setProp("Debug", "");
  7555. p->setPropInt(prop.str(), value);
  7556. }
  7557. }
  7558. void CLocalWorkUnit::setTracingValue(const char *propname, const char *value)
  7559. {
  7560. CriticalBlock block(crit);
  7561. // MORE - not sure this line should be needed....
  7562. p->setProp("Tracing", "");
  7563. StringBuffer prop("Tracing/");
  7564. p->setProp(prop.append(propname).str(), value);
  7565. }
  7566. void CLocalWorkUnit::setTracingValueInt(const char *propname, int value)
  7567. {
  7568. CriticalBlock block(crit);
  7569. StringBuffer prop("Tracing/");
  7570. p->setPropInt(prop.append(propname).str(), value);
  7571. }
  7572. void CLocalWorkUnit::setTracingValueInt64(const char *propname, __int64 value)
  7573. {
  7574. CriticalBlock block(crit);
  7575. VStringBuffer prop("Tracing/%s", propname);
  7576. p->setPropInt64(prop.str(), value);
  7577. }
  7578. IConstWUQuery* CLocalWorkUnit::getQuery() const
  7579. {
  7580. // For this to be legally called, we must have the read-able interface. So we are already locked for (at least) read.
  7581. CriticalBlock block(crit);
  7582. if (!query)
  7583. {
  7584. IPropertyTree *s = p->getPropTree("Query");
  7585. if (s)
  7586. query.setown(new CLocalWUQuery(s)); // NB takes ownership of 's'
  7587. }
  7588. return query.getLink();
  7589. }
  7590. IWUQuery* CLocalWorkUnit::updateQuery()
  7591. {
  7592. // For this to be legally called, we must have the write-able interface. So we are already locked for write.
  7593. CriticalBlock block(crit);
  7594. if (!query)
  7595. {
  7596. IPropertyTree *s = p->queryPropTree("Query");
  7597. if (!s)
  7598. s = p->addPropTree("Query", createPTreeFromXMLString("<Query fetchEntire='1'/>")); // Is this really desirable (the fetchEntire) ?
  7599. s->Link();
  7600. query.setown(new CLocalWUQuery(s));
  7601. }
  7602. return query.getLink();
  7603. }
  7604. void CLocalWorkUnit::loadPlugins() const
  7605. {
  7606. CriticalBlock block(crit);
  7607. if (!pluginsCached)
  7608. {
  7609. assertex(plugins.length() == 0);
  7610. Owned<IPropertyTreeIterator> r = p->getElements("Plugins/Plugin");
  7611. for (r->first(); r->isValid(); r->next())
  7612. {
  7613. IPropertyTree *rp = &r->query();
  7614. rp->Link();
  7615. plugins.append(*new CLocalWUPlugin(rp));
  7616. }
  7617. pluginsCached = true;
  7618. }
  7619. }
  7620. IConstWUPluginIterator& CLocalWorkUnit::getPlugins() const
  7621. {
  7622. CriticalBlock block(crit);
  7623. loadPlugins();
  7624. return *new CArrayIteratorOf<IConstWUPlugin,IConstWUPluginIterator> (plugins, 0, (IConstWorkUnit *) this);
  7625. }
  7626. void CLocalWorkUnit::loadLibraries() const
  7627. {
  7628. CriticalBlock block(crit);
  7629. if (!librariesCached)
  7630. {
  7631. assertex(libraries.length() == 0);
  7632. Owned<IPropertyTreeIterator> r = p->getElements("Libraries/Library");
  7633. ForEach(*r)
  7634. {
  7635. IPropertyTree *rp = &r->query();
  7636. rp->Link();
  7637. libraries.append(*new CLocalWULibrary(rp));
  7638. }
  7639. librariesCached = true;
  7640. }
  7641. }
  7642. IConstWULibraryIterator& CLocalWorkUnit::getLibraries() const
  7643. {
  7644. CriticalBlock block(crit);
  7645. loadLibraries();
  7646. return *new CArrayIteratorOf<IConstWULibrary,IConstWULibraryIterator> (libraries, 0, (IConstWorkUnit *) this);
  7647. }
  7648. IConstWULibrary * CLocalWorkUnit::getLibraryByName(const char * search) const
  7649. {
  7650. CriticalBlock block(crit);
  7651. loadLibraries();
  7652. ForEachItemIn(idx, libraries)
  7653. {
  7654. SCMStringBuffer name;
  7655. IConstWULibrary &cur = libraries.item(idx);
  7656. cur.getName(name);
  7657. if (stricmp(name.str(), search)==0)
  7658. return &OLINK(cur);
  7659. }
  7660. return NULL;
  7661. }
  7662. StringBuffer &formatGraphTimerLabel(StringBuffer &str, const char *graphName, unsigned subGraphNum, unsigned __int64 subId)
  7663. {
  7664. str.append("Graph ").append(graphName);
  7665. if (subGraphNum) str.append(" - ").append(subGraphNum).append(" (").append(subId).append(")");
  7666. else if (subId) str.append(" - id(").append(subId).append(")");
  7667. return str;
  7668. }
  7669. StringBuffer &formatGraphTimerScope(StringBuffer &str, unsigned wfid, const char *graphName, unsigned subGraphNum, unsigned __int64 subId)
  7670. {
  7671. if (wfid)
  7672. str.append(WorkflowScopePrefix).append(wfid).append(":");
  7673. str.append(graphName);
  7674. if (subId) str.append(":sg").append(subId);
  7675. return str;
  7676. }
  7677. bool parseGraphTimerLabel(const char *label, StringAttr &graphName, unsigned & graphNum, unsigned &subGraphNum, unsigned &subId)
  7678. {
  7679. // expects format: "Graph <graphname>[ - <subgraphnum> (<subgraphid>)]"
  7680. unsigned len = (size32_t)strlen(label);
  7681. if (len < 6 || (0 != memcmp(label, "Graph ", 6)))
  7682. return false;
  7683. graphNum = 0;
  7684. subGraphNum = 0;
  7685. subId = 0;
  7686. const char *finger = label+6;
  7687. const char *finger2 = strchr(finger, '-');
  7688. if (NULL == finger2) // just graphName
  7689. graphName.set(finger);
  7690. else
  7691. {
  7692. graphName.set(finger, (size32_t)((finger2-1)-finger));
  7693. finger = finger2+2; // skip '-' and space
  7694. finger2 = strchr(finger, ' ');
  7695. if (finger2)
  7696. {
  7697. subGraphNum = atoi_l(finger, (size32_t)(finger2-finger));
  7698. finger = finger2+2; // skip space and '('
  7699. finger2 = strchr(finger, ')');
  7700. if (finger2)
  7701. subId = atoi_l(finger, (size32_t)(finger2-finger));
  7702. }
  7703. else if (((len-(finger-label))>3) && 0 == memcmp(finger, "id(", 3)) // subgraph id only, new format.
  7704. {
  7705. finger += 3;
  7706. finger2 = strchr(finger, ')');
  7707. if (finger2)
  7708. subId = atoi_l(finger, (size32_t)(finger2-finger));
  7709. }
  7710. }
  7711. if (graphName && !memicmp(graphName, "graph", 5))
  7712. graphNum = atoi(graphName + 5);
  7713. return true;
  7714. }
  7715. bool parseGraphScope(const char *scope, StringAttr &graphName, unsigned & graphNum, unsigned &subGraphId)
  7716. {
  7717. if (!MATCHES_CONST_PREFIX(scope, GraphScopePrefix))
  7718. return false;
  7719. graphNum = atoi(scope + strlen(GraphScopePrefix));
  7720. subGraphId = 0;
  7721. const char * colon = strchr(scope, ':');
  7722. if (!colon)
  7723. {
  7724. graphName.set(scope);
  7725. return true;
  7726. }
  7727. const char * subgraph = colon+1;
  7728. graphName.set(scope, (size32_t)(colon - scope));
  7729. if (MATCHES_CONST_PREFIX(subgraph, SubGraphScopePrefix))
  7730. subGraphId = atoi(subgraph+strlen(SubGraphScopePrefix));
  7731. return true;
  7732. }
  7733. void CLocalWorkUnit::setStatistic(StatisticCreatorType creatorType, const char * creator, StatisticScopeType scopeType, const char * scope, StatisticKind kind, const char * optDescription, unsigned __int64 value, unsigned __int64 count, unsigned __int64 maxValue, StatsMergeAction mergeAction)
  7734. {
  7735. if (!scope) scope = GLOBAL_SCOPE;
  7736. const char * kindName = queryStatisticName(kind);
  7737. StatisticMeasure measure = queryMeasure(kind);
  7738. //creator. scope and name must all be present, and must not contain semi colons.
  7739. assertex(creator && scope);
  7740. CriticalBlock block(crit);
  7741. IPropertyTree * stats = p->queryPropTree("Statistics");
  7742. if (!stats)
  7743. stats = p->addPropTree("Statistics");
  7744. IPropertyTree * statTree = NULL;
  7745. if (mergeAction != StatsMergeAppend)
  7746. {
  7747. StringBuffer xpath;
  7748. xpath.append("Statistic[@creator='").append(creator).append("'][@scope='").append(scope).append("'][@kind='").append(kindName).append("']");
  7749. statTree = stats->queryPropTree(xpath.str());
  7750. }
  7751. if (!statTree)
  7752. {
  7753. statTree = stats->addPropTree("Statistic");
  7754. statTree->setProp("@creator", creator);
  7755. statTree->setProp("@scope", scope);
  7756. statTree->setProp("@kind", kindName);
  7757. //These items are primarily here to facilitate filtering.
  7758. statTree->setProp("@unit", queryMeasureName(measure));
  7759. statTree->setProp("@c", queryCreatorTypeName(creatorType));
  7760. statTree->setProp("@s", queryScopeTypeName(scopeType));
  7761. statTree->setPropInt64("@ts", getTimeStampNowValue());
  7762. if (optDescription)
  7763. statTree->setProp("@desc", optDescription);
  7764. if (statistics.cached)
  7765. statistics.append(LINK(statTree));
  7766. mergeAction = StatsMergeAppend;
  7767. }
  7768. if (mergeAction != StatsMergeAppend) // RKC->GH Is this right??
  7769. {
  7770. unsigned __int64 oldValue = statTree->getPropInt64("@value", 0);
  7771. unsigned __int64 oldCount = statTree->getPropInt64("@count", 0);
  7772. unsigned __int64 oldMax = statTree->getPropInt64("@max", 0);
  7773. if (oldMax < oldValue)
  7774. oldMax = oldValue;
  7775. statTree->setPropInt64("@value", mergeStatisticValue(oldValue, value, mergeAction));
  7776. statTree->setPropInt64("@count", count + oldCount);
  7777. if (maxValue > oldMax)
  7778. statTree->setPropInt64("@max", maxValue);
  7779. }
  7780. else
  7781. {
  7782. statTree->setPropInt64("@value", value);
  7783. statTree->setPropInt64("@count", count);
  7784. if (maxValue)
  7785. statTree->setPropInt64("@max", maxValue);
  7786. else
  7787. statTree->removeProp("@max");
  7788. }
  7789. //Whenever a graph time is updated recalculate the total time spent in thor, and save it
  7790. if ((scopeType == SSTgraph) && (kind == StTimeElapsed))
  7791. {
  7792. _loadStatistics();
  7793. stat_type totalTime = 0;
  7794. ForEachItemIn(i, statistics)
  7795. {
  7796. IConstWUStatistic & cur = statistics.item(i);
  7797. if ((cur.getScopeType() == SSTgraph) && (cur.getKind() == StTimeElapsed))
  7798. totalTime += cur.getValue();
  7799. }
  7800. StringBuffer t;
  7801. formatTimeCollatable(t, totalTime, false);
  7802. p->setProp("@totalThorTime", t);
  7803. }
  7804. }
  7805. void CLocalWorkUnit::_loadStatistics() const
  7806. {
  7807. statistics.load(p,"Statistics/*");
  7808. }
  7809. bool CLocalWorkUnit::getStatistic(stat_type & value, const char * scope, StatisticKind kind) const
  7810. {
  7811. //MORE: Optimize this....
  7812. WuScopeFilter filter;
  7813. filter.addScope(scope).setIncludeNesting(0).addRequiredStat(kind).addOutputStatistic(kind).finishedFilter();
  7814. Owned<IConstWUScopeIterator> stats = &getScopeIterator(filter);
  7815. if (stats->first())
  7816. return stats->getStat(kind, value);
  7817. return false;
  7818. }
  7819. IConstWUScopeIterator & CLocalWorkUnit::getScopeIterator(const WuScopeFilter & filter) const
  7820. {
  7821. assertex(filter.isOptimized());
  7822. WuScopeSourceFlags sources = filter.sourceFlags;
  7823. Owned<CompoundStatisticsScopeIterator> compoundIter = new CompoundStatisticsScopeIterator(filter);
  7824. if (sources & SSFsearchGlobalStats)
  7825. {
  7826. {
  7827. CriticalBlock block(crit);
  7828. statistics.loadBranch(p,"Statistics");
  7829. }
  7830. Owned<IConstWUScopeIterator> localStats(new WorkUnitStatisticsScopeIterator(statistics, filter.queryIterFilter()));
  7831. compoundIter->addIter(localStats);
  7832. }
  7833. if (sources & SSFsearchGraphStats)
  7834. {
  7835. const char * wuid = p->queryName();
  7836. Owned<IConstWUScopeIterator> scopeIter(new CConstGraphProgressScopeIterator(wuid, filter.queryIterFilter(), filter.minVersion));
  7837. compoundIter->addIter(scopeIter);
  7838. }
  7839. if (sources & SSFsearchGraph)
  7840. {
  7841. Owned<IConstWUScopeIterator> graphIter(new GraphScopeIterator(this, filter.queryIterFilter()));
  7842. compoundIter->addIter(graphIter);
  7843. }
  7844. if (sources & SSFsearchWorkflow)
  7845. {
  7846. Owned<IConstWorkflowItemIterator> iter = getWorkflowItems();
  7847. if (iter)
  7848. {
  7849. Owned<IConstWUScopeIterator> workflowIter(new WorkflowStatisticsScopeIterator(iter));
  7850. compoundIter->addIter(workflowIter);
  7851. }
  7852. }
  7853. return *compoundIter.getClear();
  7854. }
  7855. IWUPlugin* CLocalWorkUnit::updatePluginByName(const char *qname)
  7856. {
  7857. CriticalBlock block(crit);
  7858. IConstWUPlugin *existing = getPluginByName(qname);
  7859. if (existing)
  7860. return (IWUPlugin *) existing;
  7861. if (!plugins.length())
  7862. p->addPropTree("Plugins");
  7863. IPropertyTree *pl = p->queryPropTree("Plugins");
  7864. IPropertyTree *s = pl->addPropTree("Plugin");
  7865. s->Link();
  7866. IWUPlugin* q = new CLocalWUPlugin(s);
  7867. q->Link();
  7868. plugins.append(*q);
  7869. q->setPluginName(qname);
  7870. return q;
  7871. }
  7872. IConstWUPlugin* CLocalWorkUnit::getPluginByName(const char *qname) const
  7873. {
  7874. CriticalBlock block(crit);
  7875. loadPlugins();
  7876. ForEachItemIn(idx, plugins)
  7877. {
  7878. SCMStringBuffer name;
  7879. IConstWUPlugin &cur = plugins.item(idx);
  7880. cur.getPluginName(name);
  7881. if (stricmp(name.str(), qname)==0)
  7882. {
  7883. cur.Link();
  7884. return &cur;
  7885. }
  7886. }
  7887. return NULL;
  7888. }
  7889. IWULibrary* CLocalWorkUnit::updateLibraryByName(const char *qname)
  7890. {
  7891. CriticalBlock block(crit);
  7892. IConstWULibrary *existing = getLibraryByName(qname);
  7893. if (existing)
  7894. return (IWULibrary *) existing;
  7895. if (!libraries.length())
  7896. p->addPropTree("Libraries");
  7897. IPropertyTree *pl = p->queryPropTree("Libraries");
  7898. IPropertyTree *s = pl->addPropTree("Library");
  7899. s->Link();
  7900. IWULibrary* q = new CLocalWULibrary(s);
  7901. q->Link();
  7902. libraries.append(*q);
  7903. q->setName(qname);
  7904. return q;
  7905. }
  7906. void CLocalWorkUnit::_loadExceptions() const
  7907. {
  7908. assertex(exceptions.length() == 0);
  7909. Owned<IPropertyTreeIterator> r = p->getElements("Exceptions/Exception");
  7910. for (r->first(); r->isValid(); r->next())
  7911. {
  7912. IPropertyTree *rp = &r->query();
  7913. rp->Link();
  7914. exceptions.append(*new CLocalWUException(rp));
  7915. }
  7916. }
  7917. void CLocalWorkUnit::loadExceptions() const
  7918. {
  7919. CriticalBlock block(crit);
  7920. if (!exceptionsCached)
  7921. {
  7922. _loadExceptions();
  7923. exceptionsCached = true;
  7924. }
  7925. }
  7926. IConstWUExceptionIterator& CLocalWorkUnit::getExceptions() const
  7927. {
  7928. CriticalBlock block(crit);
  7929. loadExceptions();
  7930. return *new CArrayIteratorOf<IConstWUException,IConstWUExceptionIterator> (exceptions, 0, (IConstWorkUnit *) this);
  7931. }
  7932. unsigned CLocalWorkUnit::getExceptionCount() const
  7933. {
  7934. CriticalBlock block(crit);
  7935. loadExceptions();
  7936. return exceptions.length();
  7937. }
  7938. void CLocalWorkUnit::clearExceptions()
  7939. {
  7940. CriticalBlock block(crit);
  7941. // For this to be legally called, we must have the write-able interface. So we are already locked for write.
  7942. loadExceptions();
  7943. ForEachItemInRev(idx, exceptions)
  7944. {
  7945. IWUException &e = exceptions.item(idx);
  7946. SCMStringBuffer s;
  7947. e.getExceptionSource(s);
  7948. if (strieq(s.s, "eclcc") || strieq(s.s, "eclccserver") || strieq(s.s, "eclserver") )
  7949. break;
  7950. VStringBuffer xpath("Exceptions/Exception[@sequence='%d']", e.getSequence());
  7951. p->removeProp(xpath);
  7952. exceptions.remove(idx);
  7953. }
  7954. if (exceptions.length() == 0)
  7955. p->removeProp("Exceptions");
  7956. }
  7957. IWUException* CLocalWorkUnit::createException()
  7958. {
  7959. CriticalBlock block(crit);
  7960. // For this to be legally called, we must have the write-able interface. So we are already locked for write.
  7961. loadExceptions();
  7962. if (!exceptions.length())
  7963. p->addPropTree("Exceptions");
  7964. IPropertyTree *r = p->queryPropTree("Exceptions");
  7965. IPropertyTree *s = r->addPropTree("Exception");
  7966. s->setPropInt("@sequence", exceptions.ordinality());
  7967. IWUException* q = new CLocalWUException(LINK(s));
  7968. exceptions.append(*LINK(q));
  7969. Owned<IJlibDateTime> now = createDateTimeNow();
  7970. SCMStringBuffer temp;
  7971. now->getString(temp);
  7972. q->setTimeStamp(temp.str());
  7973. return q;
  7974. }
  7975. IConstWUWebServicesInfo* CLocalWorkUnit::getWebServicesInfo() const
  7976. {
  7977. // For this to be legally called, we must have the read-able interface. So we are already locked for (at least) read.
  7978. CriticalBlock block(crit);
  7979. if (!webServicesInfoCached)
  7980. {
  7981. assertex(!webServicesInfo);
  7982. IPropertyTree *s = p->getPropTree("WebServicesInfo");
  7983. if (s)
  7984. webServicesInfo.setown(new CLocalWUWebServicesInfo(s)); // NB takes ownership of 's'
  7985. webServicesInfoCached = true;
  7986. }
  7987. return webServicesInfo.getLink();
  7988. }
  7989. IWUWebServicesInfo* CLocalWorkUnit::updateWebServicesInfo(bool create)
  7990. {
  7991. // For this to be legally called, we must have the write-able interface. So we are already locked for write.
  7992. CriticalBlock block(crit);
  7993. if (!webServicesInfoCached)
  7994. {
  7995. IPropertyTree *s = p->queryPropTree("WebServicesInfo");
  7996. if (!s)
  7997. {
  7998. if (create)
  7999. s = p->addPropTree("WebServicesInfo");
  8000. else
  8001. return NULL;
  8002. }
  8003. s->Link();
  8004. webServicesInfo.setown(new CLocalWUWebServicesInfo(s));
  8005. webServicesInfoCached = true;
  8006. }
  8007. return webServicesInfo.getLink();
  8008. }
  8009. static int compareResults(IInterface * const *ll, IInterface * const *rr)
  8010. {
  8011. CLocalWUResult *l = (CLocalWUResult *) *ll;
  8012. CLocalWUResult *r = (CLocalWUResult *) *rr;
  8013. return l->getResultSequence() - r->getResultSequence();
  8014. }
  8015. void CLocalWorkUnit::_loadResults() const
  8016. {
  8017. Owned<IPropertyTreeIterator> r = p->getElements("Results/Result");
  8018. for (r->first(); r->isValid(); r->next())
  8019. {
  8020. IPropertyTree *rp = &r->query();
  8021. rp->Link();
  8022. results.append(*new CLocalWUResult(rp));
  8023. }
  8024. }
  8025. void CLocalWorkUnit::loadResults() const
  8026. {
  8027. if (!resultsCached)
  8028. {
  8029. assertex(results.length() == 0);
  8030. _loadResults();
  8031. results.sort(compareResults);
  8032. resultsCached = true;
  8033. }
  8034. }
  8035. void CLocalWorkUnit::_loadVariables() const
  8036. {
  8037. Owned<IPropertyTreeIterator> r = p->getElements("Variables/Variable");
  8038. for (r->first(); r->isValid(); r->next())
  8039. {
  8040. IPropertyTree *rp = &r->query();
  8041. rp->Link();
  8042. variables.append(*new CLocalWUResult(rp));
  8043. }
  8044. }
  8045. void CLocalWorkUnit::loadVariables() const
  8046. {
  8047. if (!variablesCached)
  8048. {
  8049. assertex(variables.length() == 0);
  8050. _loadVariables();
  8051. variablesCached = true;
  8052. }
  8053. }
  8054. void CLocalWorkUnit::_loadTemporaries() const
  8055. {
  8056. Owned<IPropertyTreeIterator> r = p->getElements("Temporaries/Variable");
  8057. for (r->first(); r->isValid(); r->next())
  8058. {
  8059. IPropertyTree *rp = &r->query();
  8060. rp->Link();
  8061. temporaries.append(*new CLocalWUResult(rp));
  8062. }
  8063. }
  8064. void CLocalWorkUnit::loadTemporaries() const
  8065. {
  8066. if (!temporariesCached)
  8067. {
  8068. assertex(temporaries.length() == 0);
  8069. _loadTemporaries();
  8070. temporariesCached = true;
  8071. }
  8072. }
  8073. void CLocalWorkUnit::deleteTemporaries()
  8074. {
  8075. CriticalBlock block(crit);
  8076. if (temporariesCached)
  8077. {
  8078. temporaries.kill();
  8079. temporariesCached = false;
  8080. }
  8081. p->removeProp("Temporaries");
  8082. }
  8083. IWUResult* CLocalWorkUnit::createResult()
  8084. {
  8085. CriticalBlock block(crit);
  8086. // For this to be legally called, we must have the write-able interface. So we are already locked for write.
  8087. loadResults();
  8088. if (!results.length())
  8089. p->addPropTree("Results");
  8090. IPropertyTree *r = p->queryPropTree("Results");
  8091. IPropertyTree *s = r->addPropTree("Result");
  8092. s->Link();
  8093. IWUResult* q = new CLocalWUResult(s);
  8094. q->Link();
  8095. results.append(*q);
  8096. return q;
  8097. }
  8098. IWUResult* CLocalWorkUnit::updateResultByName(const char *qname)
  8099. {
  8100. CriticalBlock block(crit);
  8101. IConstWUResult *existing = getResultByName(qname);
  8102. if (existing)
  8103. return (IWUResult *) existing;
  8104. IWUResult* q = createResult();
  8105. q->setResultName(qname);
  8106. return q;
  8107. }
  8108. IWUResult* CLocalWorkUnit::updateResultBySequence(unsigned seq)
  8109. {
  8110. CriticalBlock block(crit);
  8111. IConstWUResult *existing = getResultBySequence(seq);
  8112. if (existing)
  8113. return (IWUResult *) existing;
  8114. IWUResult* q = createResult();
  8115. q->setResultSequence(seq);
  8116. return q;
  8117. }
  8118. IConstWUResultIterator& CLocalWorkUnit::getResults() const
  8119. {
  8120. CriticalBlock block(crit);
  8121. loadResults();
  8122. return *new CArrayIteratorOf<IConstWUResult,IConstWUResultIterator> (results, 0, (IConstWorkUnit *) this);
  8123. }
  8124. IConstWUResult* CLocalWorkUnit::getResultByName(const char *qname) const
  8125. {
  8126. CriticalBlock block(crit);
  8127. loadResults();
  8128. ForEachItemIn(idx, results)
  8129. {
  8130. SCMStringBuffer name;
  8131. IConstWUResult &cur = results.item(idx);
  8132. cur.getResultName(name);
  8133. if (stricmp(name.str(), qname)==0)
  8134. {
  8135. cur.Link();
  8136. return &cur;
  8137. }
  8138. }
  8139. return NULL;
  8140. }
  8141. IConstWUResult* CLocalWorkUnit::getResultBySequence(unsigned seq) const
  8142. {
  8143. CriticalBlock block(crit);
  8144. loadResults();
  8145. ForEachItemIn(idx, results)
  8146. {
  8147. IConstWUResult &cur = results.item(idx);
  8148. if (cur.getResultSequence() == seq)
  8149. {
  8150. cur.Link();
  8151. return &cur;
  8152. }
  8153. }
  8154. return NULL;
  8155. }
  8156. IConstWUResultIterator& CLocalWorkUnit::getVariables() const
  8157. {
  8158. CriticalBlock block(crit);
  8159. loadVariables();
  8160. return *new CArrayIteratorOf<IConstWUResult,IConstWUResultIterator> (variables, 0, (IConstWorkUnit *) this);
  8161. }
  8162. IConstWUResult* CLocalWorkUnit::getGlobalByName(const char *qname) const
  8163. {
  8164. CriticalBlock block(crit);
  8165. if (strcmp(p->queryName(), GLOBAL_WORKUNIT)==0)
  8166. return getVariableByName(qname);
  8167. Owned <IWorkUnit> global = factory->getGlobalWorkUnit(secMgr, secUser);
  8168. return global->getVariableByName(qname);
  8169. }
  8170. IWUResult* CLocalWorkUnit::updateGlobalByName(const char *qname)
  8171. {
  8172. CriticalBlock block(crit);
  8173. if (strcmp(p->queryName(), GLOBAL_WORKUNIT)==0)
  8174. return updateVariableByName(qname);
  8175. Owned <IWorkUnit> global = factory->getGlobalWorkUnit(secMgr, secUser);
  8176. return global->updateVariableByName(qname);
  8177. }
  8178. IConstWUResult* CLocalWorkUnit::getVariableByName(const char *qname) const
  8179. {
  8180. CriticalBlock block(crit);
  8181. loadVariables();
  8182. ForEachItemIn(idx, variables)
  8183. {
  8184. SCMStringBuffer name;
  8185. IConstWUResult &cur = variables.item(idx);
  8186. cur.getResultName(name);
  8187. if (stricmp(name.str(), qname)==0)
  8188. {
  8189. cur.Link();
  8190. return &cur;
  8191. }
  8192. }
  8193. return NULL;
  8194. }
  8195. IConstWUResult* CLocalWorkUnit::getTemporaryByName(const char *qname) const
  8196. {
  8197. CriticalBlock block(crit);
  8198. loadTemporaries();
  8199. ForEachItemIn(idx, temporaries)
  8200. {
  8201. SCMStringBuffer name;
  8202. IConstWUResult &cur = temporaries.item(idx);
  8203. cur.getResultName(name);
  8204. if (stricmp(name.str(), qname)==0)
  8205. {
  8206. cur.Link();
  8207. return &cur;
  8208. }
  8209. }
  8210. return NULL;
  8211. }
  8212. IConstWUResultIterator& CLocalWorkUnit::getTemporaries() const
  8213. {
  8214. CriticalBlock block(crit);
  8215. loadTemporaries();
  8216. return *new CArrayIteratorOf<IConstWUResult,IConstWUResultIterator> (temporaries, 0, (IConstWorkUnit *) this);
  8217. }
  8218. IWUResult* CLocalWorkUnit::updateTemporaryByName(const char *qname)
  8219. {
  8220. CriticalBlock block(crit);
  8221. IConstWUResult *existing = getTemporaryByName(qname);
  8222. if (existing)
  8223. return (IWUResult *) existing;
  8224. IPropertyTree *vars = (temporaries.length()) ? p->queryPropTree("Temporaries") : p->addPropTree("Temporaries");
  8225. IPropertyTree *s = vars->addPropTree("Variable");
  8226. s->Link();
  8227. IWUResult* q = new CLocalWUResult(s);
  8228. q->Link();
  8229. temporaries.append(*q);
  8230. q->setResultName(qname);
  8231. q->setResultSequence(ResultSequenceInternal);
  8232. return q;
  8233. }
  8234. IWUResult* CLocalWorkUnit::updateVariableByName(const char *qname)
  8235. {
  8236. CriticalBlock block(crit);
  8237. IConstWUResult *existing = getVariableByName(qname);
  8238. if (existing)
  8239. return (IWUResult *) existing;
  8240. if (!variables.length())
  8241. p->addPropTree("Variables");
  8242. IPropertyTree *vars = p->queryPropTree("Variables");
  8243. IPropertyTree *s = vars->addPropTree("Variable");
  8244. s->Link();
  8245. IWUResult* q = new CLocalWUResult(s);
  8246. q->Link();
  8247. variables.append(*q);
  8248. q->setResultName(qname);
  8249. q->setResultSequence(ResultSequenceStored);
  8250. return q;
  8251. }
  8252. void CLocalWorkUnit::deleteTempFiles(const char *graph, bool deleteOwned, bool deleteJobOwned)
  8253. {
  8254. CriticalBlock block(crit);
  8255. IPropertyTree *files = p->queryPropTree("Files");
  8256. if (!files) return;
  8257. Owned<IPropertyTreeIterator> iter = files->getElements("File");
  8258. ICopyArrayOf<IPropertyTree> toRemove;
  8259. ForEach (*iter)
  8260. {
  8261. IPropertyTree &file = iter->query();
  8262. WUFileKind fileKind = (WUFileKind) file.getPropInt("@kind", WUFileStandard);
  8263. if(file.getPropBool("@temporary")) fileKind = WUFileTemporary; // @temporary, legacy check
  8264. bool needDelete;
  8265. switch(fileKind)
  8266. {
  8267. case WUFileTemporary:
  8268. if(graph==NULL)
  8269. needDelete = true;
  8270. else
  8271. {
  8272. const char *graphOwner = file.queryProp("@graph");
  8273. needDelete = ((graphOwner==NULL) || (strcmp(graph, graphOwner)==0));
  8274. }
  8275. break;
  8276. case WUFileJobOwned:
  8277. needDelete = ((graph==NULL) && deleteJobOwned);
  8278. break;
  8279. case WUFileOwned:
  8280. needDelete = ((graph==NULL) && deleteOwned);
  8281. break;
  8282. default:
  8283. needDelete = false;
  8284. }
  8285. if(needDelete)
  8286. {
  8287. const char *name = file.queryProp("@name");
  8288. LOG(MCdebugProgress, unknownJob, "Removing workunit file %s from DFS", name);
  8289. queryDistributedFileDirectory().removeEntry(name, queryUserDescriptor());
  8290. toRemove.append(file);
  8291. }
  8292. }
  8293. ForEachItemIn(r, toRemove) files->removeTree(&toRemove.item(r));
  8294. }
  8295. static void _noteFileRead(IDistributedFile *file, IPropertyTree *filesRead)
  8296. {
  8297. IDistributedSuperFile *super = file->querySuperFile();
  8298. StringBuffer fname;
  8299. file->getLogicalName(fname);
  8300. if (fname.length())
  8301. {
  8302. StringBuffer path("File[@name=\"");
  8303. path.append(fname).append("\"]");
  8304. IPropertyTree *fileTree = filesRead->queryPropTree(path.str());
  8305. if (fileTree)
  8306. fileTree->setPropInt("@useCount", fileTree->getPropInt("@useCount")+1);
  8307. else
  8308. {
  8309. StringBuffer cluster;
  8310. file->getClusterName(0,cluster);
  8311. fileTree = createPTree();
  8312. fileTree->setProp("@name", fname.str());
  8313. fileTree->setProp("@cluster", cluster.str());
  8314. fileTree->setPropInt("@useCount", 1);
  8315. fileTree = filesRead->addPropTree("File", fileTree);
  8316. }
  8317. if (super)
  8318. {
  8319. fileTree->setPropBool("@super", true);
  8320. Owned<IDistributedFileIterator> iter = super->getSubFileIterator(false);
  8321. ForEach (*iter)
  8322. {
  8323. IDistributedFile &file = iter->query();
  8324. StringBuffer fname;
  8325. file.getLogicalName(fname);
  8326. fileTree->addPropTree("Subfile")->setProp("@name", fname.str());
  8327. _noteFileRead(&file, filesRead);
  8328. }
  8329. }
  8330. }
  8331. }
  8332. void CLocalWorkUnit::_loadFilesRead() const
  8333. {
  8334. // Nothing to do
  8335. }
  8336. void CLocalWorkUnit::noteFileRead(IDistributedFile *file)
  8337. {
  8338. if (file)
  8339. {
  8340. CriticalBlock block(crit);
  8341. IPropertyTree *files = p->queryPropTree("FilesRead");
  8342. if (!files)
  8343. files = p->addPropTree("FilesRead");
  8344. _noteFileRead(file, files);
  8345. }
  8346. }
  8347. void CLocalWorkUnit::noteFieldUsage(IPropertyTree * fieldUsage)
  8348. {
  8349. if (fieldUsage)
  8350. {
  8351. CriticalBlock block(crit);
  8352. p->addPropTree("usedsources", fieldUsage);
  8353. }
  8354. }
  8355. void CLocalWorkUnit::_loadFilesWritten() const
  8356. {
  8357. // Nothing to do
  8358. }
  8359. static void addFile(IPropertyTree *files, const char *fileName, const char *cluster, unsigned usageCount, WUFileKind fileKind, const char *graphOwner)
  8360. {
  8361. StringBuffer path("File[@name=\"");
  8362. path.append(fileName).append("\"]");
  8363. if (cluster)
  8364. path.append("[@cluster=\"").append(cluster).append("\"]");
  8365. IPropertyTree *file = files->queryPropTree(path.str());
  8366. if (file) files->removeTree(file);
  8367. file = createPTree();
  8368. file->setProp("@name", fileName);
  8369. if (cluster)
  8370. file->setProp("@cluster", cluster);
  8371. if (graphOwner)
  8372. file->setProp("@graph", graphOwner);
  8373. file->setPropInt("@kind", (unsigned)fileKind);
  8374. if (WUFileTemporary == fileKind)
  8375. file->setPropInt("@usageCount", usageCount);
  8376. files->addPropTree("File", file);
  8377. }
  8378. void CLocalWorkUnit::addFile(const char *fileName, StringArray *clusters, unsigned usageCount, WUFileKind fileKind, const char *graphOwner)
  8379. {
  8380. CriticalBlock block(crit);
  8381. IPropertyTree *files = p->queryPropTree("Files");
  8382. if (!files)
  8383. files = p->addPropTree("Files");
  8384. if (!clusters)
  8385. ::addFile(files, fileName, NULL, usageCount, fileKind, graphOwner);
  8386. else
  8387. {
  8388. ForEachItemIn(c, *clusters)
  8389. ::addFile(files, fileName, clusters->item(c), usageCount, fileKind, graphOwner);
  8390. }
  8391. }
  8392. void CLocalWorkUnit::releaseFile(const char *fileName)
  8393. {
  8394. StringBuffer path("File[@name=\"");
  8395. path.append(fileName).append("\"]");
  8396. CriticalBlock block(crit);
  8397. IPropertyTree *files = p->queryPropTree("Files");
  8398. if (!files) return;
  8399. Owned<IPropertyTreeIterator> fiter = files->getElements(path.str());
  8400. ForEach (*fiter)
  8401. {
  8402. IPropertyTree *file = &fiter->query();
  8403. unsigned usageCount = file->getPropInt("@usageCount");
  8404. if (usageCount > 1)
  8405. file->setPropInt("@usageCount", usageCount-1);
  8406. else
  8407. {
  8408. StringAttr name(file->queryProp("@name"));
  8409. files->removeTree(file);
  8410. if (!name.isEmpty()&&(1 == usageCount))
  8411. {
  8412. if (queryDistributedFileDirectory().removeEntry(fileName, queryUserDescriptor()))
  8413. LOG(MCdebugProgress, unknownJob, "Removed (released) file %s from DFS", name.get());
  8414. }
  8415. }
  8416. }
  8417. }
  8418. void CLocalWorkUnit::clearGraphProgress() const
  8419. {
  8420. }
  8421. void CLocalWorkUnit::resetBeforeGeneration()
  8422. {
  8423. CriticalBlock block(crit);
  8424. //Remove all associated files
  8425. Owned<IWUQuery> q = updateQuery();
  8426. q->removeAssociatedFiles();
  8427. //Remove any pre-existing workflow information
  8428. workflowIterator.clear();
  8429. p->removeProp("Workflow");
  8430. }
  8431. unsigned CLocalWorkUnit::queryFileUsage(const char *fileName) const
  8432. {
  8433. StringBuffer path("Files/File[@name=\"");
  8434. path.append(fileName).append("\"]/@usageCount");
  8435. CriticalBlock block(crit);
  8436. return p->getPropInt(path.str());
  8437. }
  8438. IConstWUFileUsageIterator * CLocalWorkUnit::getFieldUsage() const
  8439. {
  8440. CriticalBlock block(crit);
  8441. IPropertyTree* fieldUsageTree = p->queryPropTree("usedsources");
  8442. if (!fieldUsageTree)
  8443. return NULL;
  8444. IPropertyTreeIterator* iter = fieldUsageTree->getElements("*");
  8445. return new CConstWUFileUsageIterator(iter);
  8446. }
  8447. bool isFilenameResolved(StringBuffer& filename)
  8448. {
  8449. size32_t length = filename.length();
  8450. // With current implementation, if filename is surrounded by single quotes, it means that the filename was resolved at compile time.
  8451. if (filename.length() >= 2 && filename.charAt(0) == '\'' && filename.charAt(length-1) == '\'')
  8452. return true;
  8453. else
  8454. return false;
  8455. }
  8456. bool CLocalWorkUnit::getFieldUsageArray(StringArray & filenames, StringArray & columnnames, const char * clusterName) const
  8457. {
  8458. bool scopeLoaded = false;
  8459. SCMStringBuffer defaultScope;
  8460. Owned<IConstWUFileUsageIterator> files = getFieldUsage();
  8461. if (!files)
  8462. return false; // this query was not compiled with recordFieldUsage option.
  8463. ForEach(*files)
  8464. {
  8465. Owned<IConstWUFileUsage> file = files->get();
  8466. StringBuffer filename = file->queryName();
  8467. size32_t length = filename.length();
  8468. if (length == 0)
  8469. throw MakeStringException(WUERR_InvalidFieldUsage, "Invalid FieldUsage found in WU. Cannot enforce view security.");
  8470. StringBuffer normalizedFilename;
  8471. // Two cases to handle:
  8472. // 1. Filename was known at compile time, and is surrounded in single quotes (i.e. 'filename').
  8473. // 2. Filename could not be resolved at compile time (i.e. filename is an input to a query),
  8474. // and is a raw expression WITHOUT surrounding single quotes (i.e. STORED('input_filename')).
  8475. if (isFilenameResolved(filename))
  8476. {
  8477. // filename cannot be empty (i.e. empty single quotes '')
  8478. if (length == 2)
  8479. throw MakeStringException(WUERR_InvalidFieldUsage, "Invalid FieldUsage found in WU. Cannot enforce view security.");
  8480. // Remove surrounding single quotes
  8481. StringAttr cleanFilename(filename.str()+1, length-2);
  8482. // When a filename doesn't start with a tilde (~), it means scope is omitted and is relying on a default scope.
  8483. // We need to load a default scope from config and prefix the filename with it.
  8484. if (cleanFilename.str()[0] != '~')
  8485. {
  8486. // loading a default scope from config is expensive, and should be only done once and be reused later.
  8487. if (!scopeLoaded)
  8488. {
  8489. Owned<IConstWUClusterInfo> clusterInfo = getTargetClusterInfo(clusterName);
  8490. if (!clusterInfo)
  8491. throw MakeStringException(WUERR_InvalidCluster, "Unknown cluster %s", clusterName);
  8492. clusterInfo->getScope(defaultScope);
  8493. scopeLoaded = true;
  8494. }
  8495. normalizedFilename.append(defaultScope.str());
  8496. normalizedFilename.append(cleanFilename.str());
  8497. }
  8498. else
  8499. {
  8500. normalizedFilename.append(cleanFilename);
  8501. }
  8502. }
  8503. else
  8504. {
  8505. // When filename is an unresolved expression, simply treat the expression as a "non-existent" filename.
  8506. // It will have an effect of this query accessing a non-existent filename, and will be denied access unconditionally.
  8507. normalizedFilename.append(filename.str());
  8508. }
  8509. Owned<IConstWUFieldUsageIterator> fields = file->getFields();
  8510. ForEach(*fields)
  8511. {
  8512. Owned<IConstWUFieldUsage> field = fields->get();
  8513. filenames.append(normalizedFilename.str());
  8514. columnnames.append(field->queryName());
  8515. }
  8516. }
  8517. return true;
  8518. }
  8519. IPropertyTree *CLocalWorkUnit::getDiskUsageStats()
  8520. {
  8521. return p->getPropTree("DiskUsageStats");
  8522. }
  8523. void CLocalWorkUnit::addDiskUsageStats(__int64 _avgNodeUsage, unsigned _minNode, __int64 _minNodeUsage, unsigned _maxNode, __int64 _maxNodeUsage, __int64 _graphId)
  8524. {
  8525. IPropertyTree *stats = p->queryPropTree("DiskUsageStats");
  8526. offset_t maxNodeUsage;
  8527. if (stats)
  8528. maxNodeUsage = stats->getPropInt64("@maxNodeUsage");
  8529. else
  8530. {
  8531. stats = p->addPropTree("DiskUsageStats");
  8532. maxNodeUsage = 0;
  8533. }
  8534. if ((offset_t)_maxNodeUsage > maxNodeUsage)
  8535. {
  8536. // record all details at time of max node usage.
  8537. stats->setPropInt("@minNode", _minNode);
  8538. stats->setPropInt("@maxNode", _maxNode);
  8539. stats->setPropInt64("@minNodeUsage", _minNodeUsage);
  8540. stats->setPropInt64("@maxNodeUsage", _maxNodeUsage);
  8541. stats->setPropInt64("@graphId", _graphId);
  8542. if (_avgNodeUsage)
  8543. {
  8544. unsigned _skewHi = (unsigned)((100 * (_maxNodeUsage-_avgNodeUsage))/_avgNodeUsage);
  8545. unsigned _skewLo = (unsigned)((100 * (_avgNodeUsage-_minNodeUsage))/_avgNodeUsage);
  8546. stats->setPropInt("@skewHi", _skewHi);
  8547. stats->setPropInt("@skewLo", _skewLo);
  8548. }
  8549. }
  8550. }
  8551. IPropertyTreeIterator & CLocalWorkUnit::getFileIterator() const
  8552. {
  8553. CriticalBlock block(crit);
  8554. _loadFilesWritten();
  8555. return * p->getElements("Files/File");
  8556. }
  8557. IPropertyTreeIterator & CLocalWorkUnit::getFilesReadIterator() const
  8558. {
  8559. CriticalBlock block(crit);
  8560. _loadFilesRead();
  8561. return * p->getElements("FilesRead/File");
  8562. }
  8563. //=================================================================================================
  8564. bool CLocalWorkUnit::switchThorQueue(const char *cluster, IQueueSwitcher *qs)
  8565. {
  8566. CriticalBlock block(crit);
  8567. if (qs->isAuto()&&!getAllowAutoQueueSwitch())
  8568. return false;
  8569. Owned<IConstWUClusterInfo> newci = getTargetClusterInfo(cluster);
  8570. if (!newci)
  8571. return false;
  8572. StringBuffer currentcluster;
  8573. if (!p->getProp("@clusterName",currentcluster))
  8574. return false;
  8575. Owned<IConstWUClusterInfo> curci = getTargetClusterInfo(currentcluster.str());
  8576. if (!curci)
  8577. return false;
  8578. SCMStringBuffer curqname;
  8579. curci->getThorQueue(curqname);
  8580. const char *wuid = p->queryName();
  8581. void *qi = qs->getQ(curqname.str(),wuid);
  8582. if (!qi)
  8583. return false;
  8584. setClusterName(cluster);
  8585. SCMStringBuffer newqname;
  8586. newci->getThorQueue(newqname);
  8587. qs->putQ(newqname.str(),wuid,qi);
  8588. return true;
  8589. }
  8590. //=================================================================================================
  8591. IPropertyTree *CLocalWorkUnit::getUnpackedTree(bool includeProgress) const
  8592. {
  8593. Owned<IPropertyTree> ret = createPTreeFromIPT(p);
  8594. Owned<IConstWUGraphIterator> graphIter = &getGraphs(GraphTypeAny);
  8595. ForEach(*graphIter)
  8596. {
  8597. IConstWUGraph &graph = graphIter->query();
  8598. Owned<IPropertyTree> graphTree = graph.getXGMMLTree(includeProgress);
  8599. SCMStringBuffer gName;
  8600. graph.getName(gName);
  8601. StringBuffer xpath("Graphs/Graph[@name=\"");
  8602. xpath.append(gName.s).append("\"]/xgmml");
  8603. IPropertyTree *xgmml = ret->queryPropTree(xpath.str());
  8604. if (xgmml) // don't know of any reason it shouldn't exist
  8605. {
  8606. xgmml->removeProp("graphBin");
  8607. xgmml->setPropTree("graph", graphTree.getClear());
  8608. }
  8609. }
  8610. return ret.getClear();
  8611. }
  8612. void CLocalWorkUnit::_loadGraphs(bool heavy) const
  8613. {
  8614. Owned<IPropertyTreeIterator> iter = p->getElements("Graphs/Graph");
  8615. ForEach(*iter)
  8616. {
  8617. IPropertyTree &graph = iter->query();
  8618. graphs.append(*new CLocalWUGraph(*this, LINK(&graph)));
  8619. }
  8620. }
  8621. void CLocalWorkUnit::loadGraphs(bool heavy) const
  8622. {
  8623. if (graphsCached < (heavy ? 2 : 1))
  8624. {
  8625. graphs.kill();
  8626. _loadGraphs(heavy);
  8627. graphsCached = (heavy ? 2 : 1);
  8628. }
  8629. }
  8630. EnumMapping graphTypes[] = {
  8631. { GraphTypeAny, "unknown" },
  8632. { GraphTypeProgress, "progress" },
  8633. { GraphTypeEcl, "ECL" },
  8634. { GraphTypeActivities, "activities" },
  8635. { GraphTypeSubProgress, "subgraph" },
  8636. { GraphTypeSize, NULL },
  8637. };
  8638. WUGraphType getGraphTypeFromString(const char* type)
  8639. {
  8640. return (WUGraphType) getEnum(type, graphTypes);
  8641. }
  8642. CLocalWUGraph::CLocalWUGraph(const CLocalWorkUnit &_owner, IPropertyTree *props) : p(props), owner(_owner)
  8643. {
  8644. wuidVersion = owner.getWuidVersion();
  8645. }
  8646. IStringVal& CLocalWUGraph::getName(IStringVal &str) const
  8647. {
  8648. str.set(p->queryProp("@name"));
  8649. return str;
  8650. }
  8651. IStringVal& CLocalWUGraph::getLabel(IStringVal &str) const
  8652. {
  8653. if (wuidVersion >= 2)
  8654. {
  8655. str.set(p->queryProp("@label"));
  8656. return str;
  8657. }
  8658. else
  8659. {
  8660. Owned<IPropertyTree> xgmml = getXGMMLTree(false);
  8661. str.set(xgmml->queryProp("@label"));
  8662. return str;
  8663. }
  8664. }
  8665. WUGraphState CLocalWUGraph::getState() const
  8666. {
  8667. return owner.queryGraphState(p->queryProp("@name"));
  8668. }
  8669. IStringVal& CLocalWUGraph::getXGMML(IStringVal &str, bool mergeProgress) const
  8670. {
  8671. Owned<IPropertyTree> xgmml = getXGMMLTree(mergeProgress);
  8672. if (xgmml)
  8673. {
  8674. StringBuffer x;
  8675. toXML(xgmml, x);
  8676. str.set(x.str());
  8677. }
  8678. return str;
  8679. }
  8680. unsigned CLocalWorkUnit::getGraphCount() const
  8681. {
  8682. CriticalBlock block(crit);
  8683. if (p->hasProp("Graphs"))
  8684. {
  8685. return p->queryPropTree("Graphs")->numChildren();
  8686. }
  8687. return 0;
  8688. }
  8689. unsigned CLocalWorkUnit::getSourceFileCount() const
  8690. {
  8691. CriticalBlock block(crit);
  8692. _loadFilesRead();
  8693. if (p->hasProp("FilesRead"))
  8694. {
  8695. return p->queryPropTree("FilesRead")->numChildren();
  8696. }
  8697. return 0;
  8698. }
  8699. unsigned CLocalWorkUnit::getResultCount() const
  8700. {
  8701. CriticalBlock block(crit);
  8702. if (p->hasProp("Results"))
  8703. {
  8704. return p->queryPropTree("Results")->numChildren();
  8705. }
  8706. return 0;
  8707. }
  8708. unsigned CLocalWorkUnit::getVariableCount() const
  8709. {
  8710. CriticalBlock block(crit);
  8711. if (p->hasProp("Variables"))
  8712. {
  8713. return p->queryPropTree("Variables")->numChildren();
  8714. }
  8715. return 0;
  8716. }
  8717. unsigned CLocalWorkUnit::getApplicationValueCount() const
  8718. {
  8719. CriticalBlock block(crit);
  8720. if (p->hasProp("Application"))
  8721. {
  8722. return p->queryPropTree("Application")->numChildren();
  8723. }
  8724. return 0;
  8725. }
  8726. StringBuffer &appendPTreeOpenTag(StringBuffer &s, IPropertyTree *tree, const char *name, unsigned indent, bool hidePasswords)
  8727. {
  8728. appendXMLOpenTag(s, name, NULL, false);
  8729. Owned<IAttributeIterator> attrs = tree->getAttributes(true);
  8730. if (attrs->first())
  8731. {
  8732. unsigned attributeindent = indent + (size32_t) strlen(name);
  8733. unsigned count = attrs->count();
  8734. bool doindent = false;
  8735. ForEach(*attrs)
  8736. {
  8737. if (hidePasswords && streq(attrs->queryName(), "@token"))
  8738. continue;
  8739. #ifndef _DEBUG
  8740. if (hidePasswords && streq(attrs->queryName(), "@distributedAccessToken"))
  8741. continue;
  8742. #endif
  8743. if (doindent)
  8744. s.append('\n').appendN(attributeindent, ' ');
  8745. else if (count > 3)
  8746. doindent = true;
  8747. appendXMLAttr(s, attrs->queryName()+1, attrs->queryValue());
  8748. }
  8749. }
  8750. s.append('>');
  8751. return s;
  8752. }
  8753. IStringVal &CLocalWorkUnit::getXmlParams(IStringVal &str, bool hidePasswords) const
  8754. {
  8755. CriticalBlock block(crit);
  8756. IPropertyTree *paramTree = p->queryPropTree("Parameters");
  8757. if (!paramTree)
  8758. return str;
  8759. StringBuffer xml;
  8760. if (!hidePasswords)
  8761. toXML(paramTree, xml);
  8762. else
  8763. {
  8764. appendPTreeOpenTag(xml.append(' '), paramTree, "Parameters", 0, false).append('\n');
  8765. Owned<IPropertyTreeIterator> elems = paramTree->getElements("*");
  8766. ForEach(*elems)
  8767. {
  8768. const char *paramname = elems->query().queryName();
  8769. VStringBuffer xpath("Variables/Variable[@name='%s']/Format/@password", paramname);
  8770. if (p->getPropBool(xpath))
  8771. appendXMLTag(xml.append(" "), paramname, "***").append('\n');
  8772. else
  8773. toXML(&elems->query(), xml, 2);
  8774. }
  8775. appendXMLCloseTag(xml.append(' '), "Parameters").append('\n');
  8776. }
  8777. str.set(xml);
  8778. return str;
  8779. }
  8780. const IPropertyTree *CLocalWorkUnit::getXmlParams() const
  8781. {
  8782. CriticalBlock block(crit);
  8783. return p->getPropTree("Parameters");
  8784. }
  8785. void CLocalWorkUnit::setXmlParams(const char *params)
  8786. {
  8787. CriticalBlock block(crit);
  8788. p->setPropTree("Parameters", createPTreeFromXMLString(params));
  8789. }
  8790. void CLocalWorkUnit::setXmlParams(IPropertyTree *tree)
  8791. {
  8792. CriticalBlock block(crit);
  8793. p->setPropTree("Parameters", tree);
  8794. }
  8795. unsigned __int64 CLocalWorkUnit::getHash() const
  8796. {
  8797. CriticalBlock block(crit);
  8798. return p->getPropInt64("@hash");
  8799. }
  8800. void CLocalWorkUnit::setHash(unsigned __int64 hash)
  8801. {
  8802. CriticalBlock block(crit);
  8803. p->setPropInt64("@hash", hash);
  8804. }
  8805. // getGraphs / getGraphsMeta
  8806. // These are basically the same except for the amount of preloading they do, and the type of the iterator they return...
  8807. // If a type other than any is requested, a postfilter is needed.
  8808. template <class T, class U> class CFilteredGraphIteratorOf : public CInterfaceOf<T>
  8809. {
  8810. WUGraphType type;
  8811. Owned<T> base;
  8812. bool match()
  8813. {
  8814. return base->query().getType()==type;
  8815. }
  8816. public:
  8817. CFilteredGraphIteratorOf<T,U>(T *_base, WUGraphType _type)
  8818. : base(_base), type(_type)
  8819. {
  8820. }
  8821. bool first()
  8822. {
  8823. if (!base->first())
  8824. return false;
  8825. if (match())
  8826. return true;
  8827. return next();
  8828. }
  8829. bool next()
  8830. {
  8831. while (base->next())
  8832. if (match())
  8833. return true;
  8834. return false;
  8835. }
  8836. virtual bool isValid()
  8837. {
  8838. return base->isValid();
  8839. }
  8840. U & query()
  8841. {
  8842. return base->query();
  8843. }
  8844. };
  8845. IConstWUGraphMetaIterator& CLocalWorkUnit::getGraphsMeta(WUGraphType type) const
  8846. {
  8847. /* NB: this method should be 'cheap', loadGraphs() creates IConstWUGraph interfaces to the graphs
  8848. * it does not actually pull the graph data. We only use IConstWUGraphMeta here, which never probes the xgmml.
  8849. */
  8850. CriticalBlock block(crit);
  8851. loadGraphs(false);
  8852. IConstWUGraphMetaIterator *giter = new CArrayIteratorOf<IConstWUGraph,IConstWUGraphMetaIterator> (graphs, 0, (IConstWorkUnit *) this);
  8853. if (type!=GraphTypeAny)
  8854. giter = new CFilteredGraphIteratorOf<IConstWUGraphMetaIterator, IConstWUGraphMeta>(giter,type);
  8855. return *giter;
  8856. }
  8857. IConstWUGraphIterator& CLocalWorkUnit::getGraphs(WUGraphType type) const
  8858. {
  8859. CriticalBlock block(crit);
  8860. loadGraphs(true);
  8861. IConstWUGraphIterator *giter = new CArrayIteratorOf<IConstWUGraph,IConstWUGraphIterator> (graphs, 0, (IConstWorkUnit *) this);
  8862. if (type!=GraphTypeAny)
  8863. giter = new CFilteredGraphIteratorOf<IConstWUGraphIterator, IConstWUGraph>(giter, type);
  8864. return *giter;
  8865. }
  8866. IConstWUGraph* CLocalWorkUnit::getGraph(const char *qname) const
  8867. {
  8868. CriticalBlock block(crit);
  8869. VStringBuffer xpath("Graphs/Graph[@name='%s']", qname);
  8870. // NOTE - this would go wrong if we had other graphs of same name but different type. Ignore for now.
  8871. IPTree *graph = p->queryPropTree(xpath);
  8872. if (graph)
  8873. return new CLocalWUGraph(*this, LINK(graph));
  8874. return NULL;
  8875. }
  8876. void CLocalWorkUnit::createGraph(const char * name, const char *label, WUGraphType type, IPropertyTree *xgmml, unsigned wfid)
  8877. {
  8878. CriticalBlock block(crit);
  8879. if (!graphs.length())
  8880. p->addPropTree("Graphs");
  8881. IPropertyTree *r = p->queryPropTree("Graphs");
  8882. IPropertyTree *s = r->addPropTree("Graph");
  8883. CLocalWUGraph *q = new CLocalWUGraph(*this, LINK(s));
  8884. q->setName(name);
  8885. q->setLabel(label);
  8886. q->setType(type);
  8887. q->setWfid(wfid);
  8888. q->setXGMMLTree(xgmml);
  8889. graphs.append(*q);
  8890. }
  8891. IConstWUGraphProgress *CLocalWorkUnit::getGraphProgress(const char *name) const
  8892. {
  8893. /* Owned<IRemoteConnection> conn = getProgressConnection();
  8894. if (conn)
  8895. {
  8896. IPTree *progress = conn->queryRoot()->queryPropTree(graphName);
  8897. if (progress)
  8898. return new CConstGraphProgress(p->queryName(), graphName, progress);
  8899. }
  8900. */
  8901. return NULL;
  8902. }
  8903. WUGraphState CLocalWorkUnit::queryGraphState(const char *graphName) const
  8904. {
  8905. throwUnexpected(); // Should only be used for persisted workunits
  8906. }
  8907. WUGraphState CLocalWorkUnit::queryNodeState(const char *graphName, WUGraphIDType nodeId) const
  8908. {
  8909. throwUnexpected(); // Should only be used for persisted workunits
  8910. }
  8911. void CLocalWorkUnit::setGraphState(const char *graphName, WUGraphState state) const
  8912. {
  8913. throwUnexpected(); // Should only be used for persisted workunits
  8914. }
  8915. void CLocalWorkUnit::setNodeState(const char *graphName, WUGraphIDType nodeId, WUGraphState state) const
  8916. {
  8917. throwUnexpected(); // Should only be used for persisted workunits
  8918. }
  8919. IWUGraphStats *CLocalWorkUnit::updateStats(const char *graphName, StatisticCreatorType creatorType, const char * creator, unsigned _wfid, unsigned subgraph) const
  8920. {
  8921. return new CWuGraphStats(LINK(p), creatorType, creator, _wfid, graphName, subgraph);
  8922. }
  8923. void CLocalWUGraph::setName(const char *str)
  8924. {
  8925. p->setProp("@name", str);
  8926. }
  8927. void CLocalWUGraph::setLabel(const char *str)
  8928. {
  8929. p->setProp("@label", str);
  8930. }
  8931. void CLocalWUGraph::setWfid(unsigned wfid)
  8932. {
  8933. p->setPropInt("@wfid", wfid);
  8934. }
  8935. void CLocalWUGraph::setXGMML(const char *str)
  8936. {
  8937. setXGMMLTree(createPTreeFromXMLString(str,ipt_lowmem));
  8938. }
  8939. void CLocalWUGraph::setXGMMLTree(IPropertyTree *_graph)
  8940. {
  8941. assertex(strcmp(_graph->queryName(), "graph")==0);
  8942. IPropertyTree *xgmml = p->setPropTree("xgmml");
  8943. MemoryBuffer mb;
  8944. _graph->serialize(mb);
  8945. // Note - we could compress further but that would introduce compatibility concerns, so don't bother
  8946. // Cassandra workunit code actually lzw compresses the parent anyway
  8947. xgmml->setPropBin("graphBin", mb.length(), mb.toByteArray());
  8948. graph.setown(_graph);
  8949. }
  8950. static void expandAttributes(IPropertyTree & targetNode, IPropertyTree & progressNode)
  8951. {
  8952. Owned<IAttributeIterator> aIter = progressNode.getAttributes();
  8953. ForEach (*aIter)
  8954. {
  8955. const char *aName = aIter->queryName()+1;
  8956. if (0 != stricmp("id", aName)) // "id" reserved.
  8957. {
  8958. IPropertyTree *att = targetNode.addPropTree("att");
  8959. att->setProp("@name", aName);
  8960. att->setProp("@value", aIter->queryValue());
  8961. }
  8962. }
  8963. }
  8964. void CLocalWUGraph::mergeProgress(IPropertyTree &rootNode, IPropertyTree &progressTree, const unsigned &progressV) const
  8965. {
  8966. IPropertyTree *graphNode = rootNode.queryPropTree("att/graph");
  8967. if (!graphNode) return;
  8968. unsigned nodeId = rootNode.getPropInt("@id");
  8969. StringBuffer progressNodePath("node[@id=\"");
  8970. progressNodePath.append(nodeId).append("\"]");
  8971. IPropertyTree *progressNode = progressTree.queryPropTree(progressNodePath.str());
  8972. if (progressNode)
  8973. {
  8974. expandAttributes(*graphNode, *progressNode);
  8975. Owned<IPropertyTreeIterator> edges = progressNode->getElements("edge");
  8976. ForEach (*edges)
  8977. {
  8978. IPropertyTree &edge = edges->query();
  8979. StringBuffer edgePath("edge[@id=\"");
  8980. edgePath.append(edge.queryProp("@id")).append("\"]");
  8981. IPropertyTree *graphEdge = graphNode->queryPropTree(edgePath.str());
  8982. if (graphEdge)
  8983. {
  8984. if (progressV < 1)
  8985. mergePTree(graphEdge, &edge);
  8986. else
  8987. { // must translate to XGMML format
  8988. expandAttributes(*graphEdge, edge);
  8989. // This is really only here, so that our progress format can use non-attribute values, which have different efficiency qualifies (e.g. can be external by dali)
  8990. Owned<IPropertyTreeIterator> iter = edge.getElements("*");
  8991. ForEach (*iter)
  8992. {
  8993. IPropertyTree &t = iter->query();
  8994. IPropertyTree *att = graphEdge->addPropTree("att");
  8995. att->setProp("@name", t.queryName());
  8996. att->setProp("@value", t.queryProp(NULL));
  8997. }
  8998. }
  8999. }
  9000. }
  9001. Owned<IPropertyTreeIterator> nodes = progressNode->getElements("node");
  9002. ForEach (*nodes)
  9003. {
  9004. IPropertyTree &node = nodes->query();
  9005. StringBuffer nodePath("node[@id=\"");
  9006. nodePath.append(node.queryProp("@id")).append("\"]");
  9007. IPropertyTree *_node = graphNode->queryPropTree(nodePath.str());
  9008. if (_node)
  9009. {
  9010. if (progressV < 1)
  9011. mergePTree(_node, &node);
  9012. else
  9013. { // must translate to XGMML format
  9014. expandAttributes(*_node, node);
  9015. }
  9016. }
  9017. }
  9018. }
  9019. Owned<IPropertyTreeIterator> iter = graphNode->getElements("node");
  9020. ForEach (*iter)
  9021. mergeProgress(iter->query(), progressTree, progressV);
  9022. }
  9023. IPropertyTree * CLocalWUGraph::getXGMMLTreeRaw() const
  9024. {
  9025. return p->getPropTree("xgmml");
  9026. }
  9027. IPropertyTree * CLocalWUGraph::getXGMMLTree(bool doMergeProgress) const
  9028. {
  9029. if (!graph)
  9030. {
  9031. // NB: although graphBin introduced in wuidVersion==2,
  9032. // daliadmin can retrospectively compress existing graphs, so need to check for all versions
  9033. MemoryBuffer mb;
  9034. if (p->getPropBin("xgmml/graphBin", mb))
  9035. graph.setown(createPTree(mb, ipt_lowmem));
  9036. else
  9037. graph.setown(p->getBranch("xgmml/graph"));
  9038. if (!graph)
  9039. return NULL;
  9040. }
  9041. if (!doMergeProgress)
  9042. return graph.getLink();
  9043. else
  9044. {
  9045. Owned<IPropertyTree> copy = createPTreeFromIPT(graph, ipt_lowmem);
  9046. Owned<IConstWUGraphProgress> progress = owner.getGraphProgress(p->queryProp("@name"));
  9047. if (progress)
  9048. {
  9049. //MORE: Eventually this should directly access the new stats structure
  9050. unsigned progressV = progress->queryFormatVersion();
  9051. Owned<IPropertyTree> progressTree = progress->getProgressTree();
  9052. Owned<IPropertyTreeIterator> nodeIterator = copy->getElements("node");
  9053. ForEach (*nodeIterator)
  9054. mergeProgress(nodeIterator->query(), *progressTree, progressV);
  9055. }
  9056. return copy.getClear();
  9057. }
  9058. }
  9059. WUGraphType CLocalWUGraph::getType() const
  9060. {
  9061. return (WUGraphType) getEnum(p, "@type", graphTypes);
  9062. }
  9063. IStringVal & CLocalWUGraph::getTypeName(IStringVal &str) const
  9064. {
  9065. str.set(p->queryProp("@type"));
  9066. if (!str.length())
  9067. str.set("unknown");
  9068. return str;
  9069. }
  9070. unsigned CLocalWUGraph::getWfid() const
  9071. {
  9072. return p->getPropInt("@wfid", 0);
  9073. }
  9074. void CLocalWUGraph::setType(WUGraphType _type)
  9075. {
  9076. setEnum(p, "@type", _type, graphTypes);
  9077. }
  9078. //=================================================================================================
  9079. EnumMapping queryFileTypes[] = {
  9080. { FileTypeCpp, "cpp" },
  9081. { FileTypeDll, "dll" },
  9082. { FileTypeResText, "res" },
  9083. { FileTypeHintXml, "hint" },
  9084. { FileTypeXml, "xml" },
  9085. { FileTypeLog, "log" },
  9086. { FileTypeSize, NULL },
  9087. };
  9088. CLocalWUAssociated::CLocalWUAssociated(IPropertyTree *props) : p(props)
  9089. {
  9090. }
  9091. WUFileType CLocalWUAssociated::getType() const
  9092. {
  9093. return (WUFileType)getEnum(p, "@type", queryFileTypes);
  9094. }
  9095. IStringVal & CLocalWUAssociated::getDescription(IStringVal & str) const
  9096. {
  9097. str.set(p->queryProp("@desc"));
  9098. return str;
  9099. }
  9100. IStringVal & CLocalWUAssociated::getIp(IStringVal & str) const
  9101. {
  9102. str.set(p->queryProp("@ip"));
  9103. return str;
  9104. }
  9105. IStringVal & CLocalWUAssociated::getName(IStringVal & str) const
  9106. {
  9107. str.set(p->queryProp("@filename"));
  9108. return str;
  9109. }
  9110. IStringVal & CLocalWUAssociated::getNameTail(IStringVal & str) const
  9111. {
  9112. str.set(pathTail(p->queryProp("@filename")));
  9113. return str;
  9114. }
  9115. unsigned CLocalWUAssociated::getCrc() const
  9116. {
  9117. return p->getPropInt("@crc", 0);
  9118. }
  9119. unsigned CLocalWUAssociated::getMinActivityId() const
  9120. {
  9121. return p->getPropInt("@minActivity", 0);
  9122. }
  9123. unsigned CLocalWUAssociated::getMaxActivityId() const
  9124. {
  9125. return p->getPropInt("@maxActivity", 0);
  9126. }
  9127. //=================================================================================================
  9128. CLocalWUQuery::CLocalWUQuery(IPropertyTree *props) : p(props)
  9129. {
  9130. associatedCached = false;
  9131. }
  9132. EnumMapping queryTypes[] = {
  9133. { QueryTypeUnknown, "unknown" },
  9134. { QueryTypeEcl, "ECL" },
  9135. { QueryTypeSql, "SQL" },
  9136. { QueryTypeXml, "XML" },
  9137. { QueryTypeAttribute, "Attribute" },
  9138. { QueryTypeSize, NULL },
  9139. };
  9140. WUQueryType CLocalWUQuery::getQueryType() const
  9141. {
  9142. return (WUQueryType) getEnum(p, "@type", queryTypes);
  9143. }
  9144. void CLocalWUQuery::setQueryType(WUQueryType qt)
  9145. {
  9146. setEnum(p, "@type", qt, queryTypes);
  9147. }
  9148. IStringVal& CLocalWUQuery::getQueryText(IStringVal &str) const
  9149. {
  9150. const char *text = p->queryProp("Text");
  9151. if (!text)
  9152. text = p->queryProp("ShortText");
  9153. str.set(text);
  9154. return str;
  9155. }
  9156. IStringVal& CLocalWUQuery::getQueryShortText(IStringVal &str) const
  9157. {
  9158. const char * text = p->queryProp("ShortText");
  9159. if (text)
  9160. str.set(text);
  9161. else
  9162. {
  9163. text = p->queryProp("Text");
  9164. if (isArchiveQuery(text))
  9165. {
  9166. Owned<IPropertyTree> xml = createPTreeFromXMLString(text, ipt_caseInsensitive|ipt_lowmem);
  9167. const char * path = xml->queryProp("Query/@attributePath");
  9168. if (path)
  9169. {
  9170. IPropertyTree * resolved = resolveDefinitionInArchive(xml, path);
  9171. if (resolved)
  9172. str.set(resolved->queryProp(NULL));
  9173. }
  9174. else
  9175. str.set(xml->queryProp("Query"));
  9176. }
  9177. else
  9178. str.set(text);
  9179. }
  9180. return str;
  9181. }
  9182. bool CLocalWUQuery::isArchive() const
  9183. {
  9184. if (p->hasProp("@isArchive"))
  9185. return p->getPropBool("@isArchive");
  9186. const char *text = p->queryProp("Text");
  9187. return isArchiveQuery(text);
  9188. }
  9189. IStringVal& CLocalWUQuery::getQueryName(IStringVal &str) const
  9190. {
  9191. str.set(p->queryProp("@name"));
  9192. return str;
  9193. }
  9194. IStringVal & CLocalWUQuery::getQueryMainDefinition(IStringVal & str) const
  9195. {
  9196. str.set(p->queryProp("@main"));
  9197. return str;
  9198. }
  9199. IStringVal& CLocalWUQuery::getQueryDllName(IStringVal &str) const
  9200. {
  9201. Owned<IConstWUAssociatedFile> entry = getAssociatedFile(FileTypeDll, 0);
  9202. if (entry)
  9203. entry->getNameTail(str);
  9204. return str;
  9205. }
  9206. IStringVal& CLocalWUQuery::getQueryCppName(IStringVal &str) const
  9207. {
  9208. Owned<IConstWUAssociatedFile> entry = getAssociatedFile(FileTypeCpp, 0);
  9209. if (entry)
  9210. entry->getName(str);
  9211. return str;
  9212. }
  9213. IStringVal& CLocalWUQuery::getQueryResTxtName(IStringVal &str) const
  9214. {
  9215. Owned<IConstWUAssociatedFile> entry = getAssociatedFile(FileTypeResText, 0);
  9216. if (entry)
  9217. entry->getName(str);
  9218. return str;
  9219. }
  9220. unsigned CLocalWUQuery::getQueryDllCrc() const
  9221. {
  9222. Owned<IConstWUAssociatedFile> entry = getAssociatedFile(FileTypeDll, 0);
  9223. if (entry)
  9224. return entry->getCrc();
  9225. return 0;
  9226. }
  9227. void CLocalWUQuery::setQueryText(const char *text)
  9228. {
  9229. bool isArchive = isArchiveQuery(text);
  9230. if (isArchive)
  9231. {
  9232. p->setProp("Text", text);
  9233. Owned<IPropertyTree> xml = createPTreeFromXMLString(text, ipt_caseInsensitive|ipt_lowmem);
  9234. const char * path = xml->queryProp("Query/@attributePath");
  9235. if (path)
  9236. {
  9237. IPropertyTree * resolved = resolveDefinitionInArchive(xml, path);
  9238. if (resolved)
  9239. p->setProp("ShortText", resolved->queryProp(NULL));
  9240. }
  9241. else
  9242. p->setProp("ShortText", xml->queryProp("Query"));
  9243. }
  9244. else
  9245. {
  9246. p->setProp("Text", text); // At some point in the future we may be able to remove this,
  9247. // but as long as there may be new workunits compiled by old systems, we can't
  9248. p->setProp("ShortText", text);
  9249. }
  9250. p->setPropBool("@isArchive", isArchive);
  9251. if (isArchive)
  9252. p->setPropBool("@hasArchive", true); //preserved if setQueryText is called multiple times. Should setting this be more explicit?
  9253. }
  9254. void CLocalWUQuery::setQueryName(const char *qname)
  9255. {
  9256. p->setProp("@name", qname);
  9257. }
  9258. void CLocalWUQuery::setQueryMainDefinition(const char * str)
  9259. {
  9260. p->setProp("@main", str);
  9261. }
  9262. void CLocalWUQuery::addAssociatedFile(WUFileType type, const char * name, const char * ip, const char * desc, unsigned crc, unsigned minActivity, unsigned maxActivity)
  9263. {
  9264. CriticalBlock block(crit);
  9265. loadAssociated();
  9266. StringBuffer xpath;
  9267. xpath.append("Associated/File[@filename=\"").append(name).append("\"]");
  9268. if (p->hasProp(xpath))
  9269. return;
  9270. if (!associated.length())
  9271. p->addPropTree("Associated");
  9272. IPropertyTree *pl = p->queryPropTree("Associated");
  9273. IPropertyTree *s = pl->addPropTree("File");
  9274. setEnum(s, "@type", type, queryFileTypes);
  9275. s->setProp("@filename", name);
  9276. s->setProp("@ip", ip);
  9277. s->setProp("@desc", desc);
  9278. if (crc)
  9279. s->setPropInt("@crc", crc);
  9280. if (minActivity)
  9281. s->setPropInt("@minActivity", minActivity);
  9282. if (maxActivity)
  9283. s->setPropInt("@maxActivity", maxActivity);
  9284. IConstWUAssociatedFile * q = new CLocalWUAssociated(LINK(s));
  9285. associated.append(*q);
  9286. }
  9287. void CLocalWUQuery::removeAssociatedFile(WUFileType type, const char * name, const char * desc)
  9288. {
  9289. CriticalBlock block(crit);
  9290. associatedCached = false;
  9291. associated.kill();
  9292. StringBuffer xpath;
  9293. xpath.append("Associated/File");
  9294. if (type)
  9295. xpath.append("[@type=\"").append(getEnumText(type, queryFileTypes)).append("\"]");
  9296. if (name)
  9297. xpath.append("[@filename=\"").append(name).append("\"]");
  9298. if (desc)
  9299. xpath.append("[@desc=\"").append(desc).append("\"]");
  9300. p->removeProp(xpath.str());
  9301. }
  9302. void CLocalWUQuery::removeAssociatedFiles()
  9303. {
  9304. associatedCached = false;
  9305. associated.kill();
  9306. p->removeProp("Associated");
  9307. }
  9308. IConstWUAssociatedFile * CLocalWUQuery::getAssociatedFile(WUFileType type, unsigned index) const
  9309. {
  9310. CriticalBlock block(crit);
  9311. loadAssociated();
  9312. ForEachItemIn(idx, associated)
  9313. {
  9314. CLocalWUAssociated &cur = static_cast<CLocalWUAssociated &>(associated.item(idx));
  9315. if (cur.getType() == type)
  9316. {
  9317. if (index-- == 0)
  9318. return &OLINK(cur);
  9319. }
  9320. }
  9321. return NULL;
  9322. }
  9323. void CLocalWUQuery::addSpecialCaseAssociated(WUFileType type, const char * propname, unsigned crc) const
  9324. {
  9325. const char * name = p->queryProp(propname);
  9326. if (name)
  9327. {
  9328. IPropertyTree *s = createPTree("File");
  9329. setEnum(s, "@type", type, queryFileTypes);
  9330. s->setProp("@filename", name);
  9331. if (crc)
  9332. s->setPropInt("@crc", crc);
  9333. associated.append(*new CLocalWUAssociated(s));
  9334. }
  9335. }
  9336. void CLocalWUQuery::loadAssociated() const
  9337. {
  9338. CriticalBlock block(crit);
  9339. if (!associatedCached)
  9340. {
  9341. assertex(associated.length() == 0);
  9342. addSpecialCaseAssociated(FileTypeDll, "DllName", p->getPropInt("DllCrc", 0));
  9343. addSpecialCaseAssociated(FileTypeCpp, "CppName", 0);
  9344. addSpecialCaseAssociated(FileTypeResText, "ResTxtName", 0);
  9345. Owned<IPropertyTreeIterator> r = p->getElements("Associated/File");
  9346. for (r->first(); r->isValid(); r->next())
  9347. {
  9348. IPropertyTree *rp = &r->query();
  9349. rp->Link();
  9350. associated.append(*new CLocalWUAssociated(rp));
  9351. }
  9352. associatedCached = true;
  9353. }
  9354. }
  9355. IConstWUAssociatedFileIterator& CLocalWUQuery::getAssociatedFiles() const
  9356. {
  9357. CriticalBlock block(crit);
  9358. loadAssociated();
  9359. return *new CArrayIteratorOf<IConstWUAssociatedFile,IConstWUAssociatedFileIterator> (associated, 0, (IConstWUQuery *) this);
  9360. }
  9361. //========================================================================================
  9362. CLocalWUWebServicesInfo::CLocalWUWebServicesInfo(IPropertyTree *props) : p(props)
  9363. {
  9364. }
  9365. IStringVal& CLocalWUWebServicesInfo::getModuleName(IStringVal &str) const
  9366. {
  9367. str.set(p->queryProp("@module"));
  9368. return str;
  9369. }
  9370. IStringVal& CLocalWUWebServicesInfo::getAttributeName(IStringVal &str) const
  9371. {
  9372. str.set(p->queryProp("@attribute"));
  9373. return str;
  9374. }
  9375. IStringVal& CLocalWUWebServicesInfo::getDefaultName(IStringVal &str) const
  9376. {
  9377. str.set(p->queryProp("@defaultName"));
  9378. return str;
  9379. }
  9380. unsigned CLocalWUWebServicesInfo::getWebServicesCRC() const
  9381. {
  9382. return (unsigned) p->getPropInt("@crc");
  9383. }
  9384. IStringVal& CLocalWUWebServicesInfo::getInfo(const char *name, IStringVal &str) const
  9385. {
  9386. if (!name)
  9387. {
  9388. StringBuffer ws_info;
  9389. ws_info.appendf("<%s ", p->queryName());
  9390. Owned<IAttributeIterator> attrs = p->getAttributes();
  9391. for(attrs->first(); attrs->isValid(); attrs->next())
  9392. {
  9393. const char *name = attrs->queryName()+1;
  9394. const char *value = attrs->queryValue();
  9395. ws_info.appendf("%s='%s' ", name, value);
  9396. }
  9397. ws_info.append("> \n");
  9398. Owned<IPropertyTreeIterator> info = p->getElements("*");
  9399. ForEach(*info)
  9400. {
  9401. IPropertyTree &item = info->query();
  9402. const char *name = item.queryName();
  9403. if (name)
  9404. {
  9405. MemoryBuffer mb;
  9406. bool isbin = p->isBinary(name);
  9407. if (isbin)
  9408. {
  9409. p->getPropBin(name,mb);
  9410. if (mb.length())
  9411. {
  9412. unsigned len = 0;
  9413. mb.read(len);
  9414. StringBuffer encodedString;
  9415. StringBuffer val(len, (const char *) mb.readDirect(len));
  9416. encodeXML(val, encodedString);
  9417. ws_info.appendf("<%s>%s</%s>", name, encodedString.str(), name);
  9418. }
  9419. }
  9420. else
  9421. {
  9422. StringBuffer tmp;
  9423. toXML(&item, tmp);
  9424. ws_info.append(tmp.str());
  9425. }
  9426. }
  9427. }
  9428. ws_info.appendf("</%s>", p->queryName());
  9429. str.setLen(ws_info.str(), ws_info.length());
  9430. }
  9431. else
  9432. {
  9433. MemoryBuffer mb;
  9434. p->getPropBin(name,mb);
  9435. if (mb.length())
  9436. {
  9437. unsigned len;
  9438. mb.read(len);
  9439. str.setLen((const char *) mb.readDirect(len), len);
  9440. }
  9441. }
  9442. return str;
  9443. }
  9444. IStringVal& CLocalWUWebServicesInfo::getText(const char *name, IStringVal &str) const
  9445. {
  9446. str.set(p->queryProp(name));
  9447. return str;
  9448. }
  9449. void CLocalWUWebServicesInfo::setModuleName(const char *mname)
  9450. {
  9451. p->setProp("@module", mname);
  9452. }
  9453. void CLocalWUWebServicesInfo::setAttributeName(const char *aname)
  9454. {
  9455. p->setProp("@attribute", aname);
  9456. }
  9457. void CLocalWUWebServicesInfo::setDefaultName(const char *dname)
  9458. {
  9459. p->setProp("@defaultName", dname);
  9460. }
  9461. void CLocalWUWebServicesInfo::setWebServicesCRC(unsigned crc)
  9462. {
  9463. p->setPropInt("@crc", crc);
  9464. }
  9465. void CLocalWUWebServicesInfo::setInfo(const char *name, const char *info)
  9466. {
  9467. MemoryBuffer m;
  9468. unsigned len = (size32_t)strlen(info);
  9469. serializeLPString(len, info, m);
  9470. p->setPropBin(name, m.length(), m.toByteArray());
  9471. }
  9472. void CLocalWUWebServicesInfo::setText(const char *name, const char *info)
  9473. {
  9474. p->setProp(name, info);
  9475. }
  9476. //========================================================================================
  9477. CLocalWUResult::CLocalWUResult(IPropertyTree *props) : p(props)
  9478. {
  9479. }
  9480. EnumMapping resultStatuses[] = {
  9481. { ResultStatusUndefined, "undefined" },
  9482. { ResultStatusCalculated, "calculated" },
  9483. { ResultStatusSupplied, "supplied" },
  9484. { ResultStatusFailed, "failed" },
  9485. { ResultStatusPartial, "partial" },
  9486. { ResultStatusSize, NULL }
  9487. };
  9488. WUResultStatus CLocalWUResult::getResultStatus() const
  9489. {
  9490. return (WUResultStatus ) getEnum(p, "@status", resultStatuses);
  9491. }
  9492. IStringVal& CLocalWUResult::getResultName(IStringVal &str) const
  9493. {
  9494. str.set(p->queryProp("@name"));
  9495. return str;
  9496. }
  9497. int CLocalWUResult::getResultSequence() const
  9498. {
  9499. return p->getPropInt("@sequence", -1);
  9500. }
  9501. bool CLocalWUResult::isResultScalar() const
  9502. {
  9503. return p->getPropInt("@isScalar", 1) != 0;
  9504. }
  9505. bool findSize(int size, IntArray &sizes)
  9506. {
  9507. ForEachItemIn(idx, sizes)
  9508. {
  9509. if (sizes.item(idx)==size)
  9510. return true;
  9511. }
  9512. return false;
  9513. }
  9514. void CLocalWUResult::getSchema(IArrayOf<ITypeInfo> &types, StringAttrArray &names, IStringVal * eclText) const
  9515. {
  9516. MemoryBuffer schema;
  9517. p->getPropBin("SchemaRaw", schema);
  9518. if (schema.length())
  9519. {
  9520. for (;;)
  9521. {
  9522. StringAttr name;
  9523. schema.read(name);
  9524. if (*schema.readDirect(0)==type_void)
  9525. break;
  9526. names.append(*new StringAttrItem(name));
  9527. types.append(*deserializeType(schema)); // MORE - nested records!
  9528. }
  9529. schema.skip(1);
  9530. if (schema.length() != schema.getPos())
  9531. {
  9532. unsigned eclLen;
  9533. schema.read(eclLen);
  9534. const char * schemaData = (const char *)schema.readDirect(eclLen);
  9535. if (eclText)
  9536. {
  9537. eclText->setLen(schemaData, eclLen);
  9538. if ((eclLen == 0) && names.ordinality())
  9539. {
  9540. const char * firstName = names.item(0).text;
  9541. StringBuffer temp;
  9542. temp.append("RECORD ");
  9543. types.item(0).getECLType(temp);
  9544. temp.append(" value{NAMED('").append(firstName).append("')}").append("; END;");
  9545. eclText->set(temp.str());
  9546. }
  9547. }
  9548. }
  9549. }
  9550. }
  9551. void readRow(StringBuffer &out, MemoryBuffer &in, TypeInfoArray &types, StringAttrArray &names)
  9552. {
  9553. ForEachItemIn(idx, types)
  9554. {
  9555. StringAttrItem &name = names.item(idx);
  9556. ITypeInfo &type = types.item(idx);
  9557. unsigned size = type.getSize();
  9558. switch(type.getTypeCode())
  9559. {
  9560. case type_data:
  9561. if (size==UNKNOWN_LENGTH)
  9562. {
  9563. if (in.remaining() < sizeof(int))
  9564. throw MakeStringException(WUERR_CorruptResult, "corrupt workunit information");
  9565. in.read(size);
  9566. }
  9567. outputXmlData(size, in.readDirect(size), name.text, out);
  9568. break;
  9569. case type_string:
  9570. if (size==UNKNOWN_LENGTH)
  9571. {
  9572. if (in.remaining() < sizeof(int))
  9573. throw MakeStringException(WUERR_CorruptResult, "corrupt workunit information");
  9574. in.read(size);
  9575. }
  9576. outputXmlString(size, (const char *) in.readDirect(size), name.text, out);
  9577. break;
  9578. case type_varstring:
  9579. {
  9580. if (size == UNKNOWN_LENGTH)
  9581. size = (size32_t)strlen((const char *) in.readDirect(0))+1;
  9582. const char * text = (const char *) in.readDirect(size);
  9583. outputXmlString((size32_t)strlen(text), text, name.text, out);
  9584. break;
  9585. }
  9586. case type_unicode:
  9587. {
  9588. unsigned len = type.getStringLen();
  9589. if (size==UNKNOWN_LENGTH)
  9590. in.read(len);
  9591. outputXmlUnicode(len, (UChar const *) in.readDirect(len*2), name.text, out);
  9592. }
  9593. break;
  9594. case type_utf8:
  9595. {
  9596. unsigned len = type.getStringLen();
  9597. if (size==UNKNOWN_LENGTH)
  9598. {
  9599. in.read(len);
  9600. size = rtlUtf8Size(len, in.readDirect(0));
  9601. }
  9602. outputXmlUtf8(len, (const char *) in.readDirect(size), name.text, out);
  9603. }
  9604. break;
  9605. case type_qstring:
  9606. {
  9607. unsigned len = type.getStringLen();
  9608. if (size==UNKNOWN_LENGTH)
  9609. in.read(len);
  9610. unsigned outlen;
  9611. char *outstr;
  9612. rtlQStrToStrX(outlen, outstr, len, (const char *) in.readDirect(rtlQStrSize(len)));
  9613. outputXmlString(outlen, outstr, name.text, out);
  9614. free(outstr);
  9615. break;
  9616. }
  9617. case type_int:
  9618. case type_swapint:
  9619. if (type.isSigned())
  9620. {
  9621. const unsigned char *raw = (const unsigned char *) in.readDirect(size);
  9622. unsigned __int64 cval8 = 0;
  9623. //MORE: I think this is wrong - swapped doesn't mean little/big/
  9624. if (type.isSwappedEndian())
  9625. {
  9626. unsigned idx = 0;
  9627. if (raw[idx] & 0x80)
  9628. cval8 = (__int64)-1;
  9629. while (size--)
  9630. cval8 = (cval8 << 8) | raw[idx++];
  9631. }
  9632. else
  9633. {
  9634. if (raw[size-1] & 0x80)
  9635. cval8 = (__int64)-1;
  9636. while (size--)
  9637. cval8 = (cval8 << 8) | raw[size];
  9638. }
  9639. outputXmlInt((__int64) cval8, name.text, out);
  9640. }
  9641. else
  9642. {
  9643. const unsigned char *raw = (const unsigned char *) in.readDirect(size);
  9644. unsigned __int64 cval8 = 0;
  9645. if (type.isSwappedEndian())
  9646. {
  9647. unsigned idx = 0;
  9648. while (size--)
  9649. cval8 = (cval8 << 8) | raw[idx++];
  9650. }
  9651. else
  9652. {
  9653. while (size--)
  9654. cval8 = (cval8 << 8) | raw[size];
  9655. }
  9656. outputXmlUInt(cval8, name.text, out);
  9657. }
  9658. break;
  9659. case type_boolean:
  9660. bool cvalb;
  9661. in.read(cvalb);
  9662. outputXmlBool(cvalb, name.text, out);
  9663. break;
  9664. case type_decimal:
  9665. if (type.isSigned())
  9666. outputXmlDecimal(in.readDirect(size), size, type.getPrecision(), name.text, out);
  9667. else
  9668. outputXmlUDecimal(in.readDirect(size), size, type.getPrecision(), name.text, out);
  9669. break;
  9670. case type_real:
  9671. double cvald;
  9672. switch(size)
  9673. {
  9674. case 4:
  9675. float cvalf;
  9676. in.read(cvalf);
  9677. cvald = cvalf;
  9678. break;
  9679. case 8:
  9680. in.read(cvald);
  9681. break;
  9682. }
  9683. outputXmlReal(cvald, name.text, out);
  9684. break;
  9685. default:
  9686. assertex(!"unexpected type in raw record");
  9687. break;
  9688. }
  9689. }
  9690. }
  9691. IStringVal& CLocalWUResult::getResultXml(IStringVal &str, bool hidePassword) const
  9692. {
  9693. TypeInfoArray types;
  9694. StringAttrArray names;
  9695. getSchema(types, names);
  9696. StringBuffer xml;
  9697. const char * name = p->queryProp("@name");
  9698. if (name)
  9699. xml.appendf("<Dataset name=\'%s\'>\n", name);
  9700. else
  9701. xml.append("<Dataset>\n");
  9702. if (hidePassword && p->getPropBool("Format/@password"))
  9703. {
  9704. xml.append(" <Row>");
  9705. appendXMLTag(xml, name, "****");
  9706. xml.append("</Row>\n");
  9707. }
  9708. else if (p->hasProp("Value"))
  9709. {
  9710. MemoryBuffer raw;
  9711. p->getPropBin("Value", raw);
  9712. unsigned __int64 numrows = getResultRowCount();
  9713. while (numrows--)
  9714. {
  9715. xml.append(" <Row>");
  9716. readRow(xml, raw, types, names);
  9717. xml.append("</Row>\n");
  9718. }
  9719. }
  9720. else if (p->hasProp("xmlValue"))
  9721. {
  9722. xml.append(" <Row>");
  9723. appendXMLTag(xml, name, p->queryProp("xmlValue"));
  9724. xml.append("</Row>\n");
  9725. }
  9726. xml.append("</Dataset>\n");
  9727. str.set(xml.str());
  9728. return str;
  9729. }
  9730. IProperties *CLocalWUResult::queryResultXmlns()
  9731. {
  9732. CriticalBlock block(crit);
  9733. if (xmlns)
  9734. return xmlns;
  9735. xmlns.setown(createProperties());
  9736. Owned<IAttributeIterator> it = p->getAttributes();
  9737. unsigned prefixLen = strlen("@xmlns");
  9738. ForEach(*it)
  9739. {
  9740. const char *name = it->queryName();
  9741. if (!strncmp("@xmlns", name, prefixLen))
  9742. {
  9743. if (name[prefixLen]==':') //normal case
  9744. xmlns->setProp(name+prefixLen+1, it->queryValue());
  9745. else if (!name[prefixLen]) //special case, unprefixed namespace
  9746. xmlns->setProp("xmlns", it->queryValue());
  9747. }
  9748. }
  9749. return xmlns;
  9750. }
  9751. unsigned CLocalWUResult::getResultFetchSize() const
  9752. {
  9753. return p->getPropInt("fetchSize", 100);
  9754. }
  9755. __int64 CLocalWUResult::getResultTotalRowCount() const
  9756. {
  9757. return p->getPropInt64("totalRowCount", -1);
  9758. }
  9759. __int64 CLocalWUResult::getResultRowCount() const
  9760. {
  9761. return p->getPropInt64("rowCount", 0);
  9762. }
  9763. void CLocalWUResult::getResultDataset(IStringVal & ecl, IStringVal & defs) const
  9764. {
  9765. ecl.set(p->queryProp("datasetEcl"));
  9766. defs.set(p->queryProp("datasetEclDefs"));
  9767. }
  9768. IStringVal& CLocalWUResult::getResultLogicalName(IStringVal & val) const
  9769. {
  9770. val.set(p->queryProp("logicalName"));
  9771. return val;
  9772. }
  9773. IStringVal& CLocalWUResult::getResultKeyField(IStringVal & ecl) const
  9774. {
  9775. ecl.set(p->queryProp("keyField"));
  9776. return ecl;
  9777. }
  9778. unsigned CLocalWUResult::getResultRequestedRows() const
  9779. {
  9780. return p->getPropInt("requestedRows", 1);
  9781. }
  9782. IStringVal& CLocalWUResult::getResultEclSchema(IStringVal & str) const
  9783. {
  9784. TypeInfoArray types;
  9785. StringAttrArray names;
  9786. getSchema(types, names, &str);
  9787. return str;
  9788. }
  9789. IStringVal& CLocalWUResult::getResultRecordSizeEntry(IStringVal & str) const
  9790. {
  9791. str.set(p->queryProp("@recordSizeEntry"));
  9792. return str;
  9793. }
  9794. IStringVal& CLocalWUResult::getResultTransformerEntry(IStringVal & str) const
  9795. {
  9796. str.set(p->queryProp("@transformerEntry"));
  9797. return str;
  9798. }
  9799. __int64 CLocalWUResult::getResultRowLimit() const
  9800. {
  9801. return p->getPropInt64("@rowLimit");
  9802. }
  9803. IStringVal& CLocalWUResult::getResultFilename(IStringVal & str) const
  9804. {
  9805. str.set(p->queryProp("@tempFilename"));
  9806. return str;
  9807. }
  9808. IStringVal& CLocalWUResult::getResultFieldOpt(const char *name, IStringVal &str) const
  9809. {
  9810. str.clear();
  9811. if (!name || !*name)
  9812. return str;
  9813. IPropertyTree *format = p->queryPropTree("Format");
  9814. if (!format)
  9815. return str;
  9816. VStringBuffer xpath("@%s", name);
  9817. str.set(format->queryProp(xpath));
  9818. return str;
  9819. }
  9820. void CLocalWUResult::getResultWriteLocation(IStringVal & _graph, unsigned & _activityId) const
  9821. {
  9822. _graph.set(p->queryProp("@graph"));
  9823. _activityId = p->getPropInt("@activity", 0);
  9824. }
  9825. void CLocalWUResult::setResultStatus(WUResultStatus status)
  9826. {
  9827. setEnum(p, "@status", status, resultStatuses);
  9828. if (status==ResultStatusUndefined)
  9829. {
  9830. p->removeProp("Value");
  9831. p->removeProp("totalRowCount");
  9832. p->removeProp("rowCount");
  9833. p->removeProp("@format");
  9834. p->removeProp("@tempFileNmae");
  9835. p->removeProp("logicalName");
  9836. }
  9837. }
  9838. void CLocalWUResult::setResultName(const char *s)
  9839. {
  9840. p->setProp("@name", s);
  9841. }
  9842. void CLocalWUResult::setResultSequence(unsigned seq)
  9843. {
  9844. p->setPropInt("@sequence", seq);
  9845. }
  9846. void CLocalWUResult::setResultSchemaRaw(unsigned size, const void *schema)
  9847. {
  9848. p->setPropBin("SchemaRaw", size, schema);
  9849. }
  9850. void CLocalWUResult::setResultXmlns(const char *prefix, const char *uri)
  9851. {
  9852. StringBuffer xpath("@xmlns");
  9853. if (prefix && *prefix)
  9854. xpath.append(':').append(prefix);
  9855. p->setProp(xpath, uri);
  9856. }
  9857. void CLocalWUResult::setResultFieldOpt(const char *name, const char *value)
  9858. {
  9859. if (!name || !*name)
  9860. return;
  9861. IPropertyTree *format = ensurePTree(p, "Format");
  9862. VStringBuffer xpath("@%s", name);
  9863. format->setProp(xpath, value);
  9864. }
  9865. void CLocalWUResult::setResultWriteLocation(const char * _graph, unsigned _activityId)
  9866. {
  9867. p->setProp("@graph", _graph);
  9868. p->setPropInt("@activity", _activityId);
  9869. }
  9870. void CLocalWUResult::setResultScalar(bool isScalar)
  9871. {
  9872. p->setPropInt("@isScalar", (int) isScalar);
  9873. if (isScalar)
  9874. setResultTotalRowCount(1);
  9875. }
  9876. void CLocalWUResult::setResultRaw(unsigned len, const void *data, WUResultFormat format)
  9877. {
  9878. p->setPropBin("Value", len, data);
  9879. setResultStatus(ResultStatusSupplied);
  9880. setResultFormat(format);
  9881. }
  9882. void CLocalWUResult::setResultFormat(WUResultFormat format)
  9883. {
  9884. switch (format)
  9885. {
  9886. case ResultFormatXml:
  9887. p->setProp("@format","xml");
  9888. break;
  9889. case ResultFormatXmlSet:
  9890. p->setProp("@format","xmlSet");
  9891. break;
  9892. case ResultFormatCsv:
  9893. p->setProp("@format","csv");
  9894. break;
  9895. default:
  9896. p->removeProp("@format");
  9897. break;
  9898. }
  9899. }
  9900. void CLocalWUResult::setResultXML(const char *val)
  9901. {
  9902. p->setProp("xmlValue", val);
  9903. }
  9904. void CLocalWUResult::addResultRaw(unsigned len, const void *data, WUResultFormat format)
  9905. {
  9906. p->appendPropBin("Value", len, data);
  9907. setResultStatus(ResultStatusPartial);
  9908. const char *existingFormat = p->queryProp("@format");
  9909. const char *formatStr = NULL;
  9910. switch (format)
  9911. {
  9912. case ResultFormatXml:
  9913. formatStr = "xml";
  9914. break;
  9915. case ResultFormatXmlSet:
  9916. formatStr = "xmlSet";
  9917. break;
  9918. case ResultFormatCsv:
  9919. formatStr = "csv";
  9920. break;
  9921. default:
  9922. p->removeProp("@format");
  9923. break;
  9924. }
  9925. if (format)
  9926. {
  9927. if (existingFormat)
  9928. {
  9929. if (0 != stricmp(formatStr, existingFormat))
  9930. throw MakeStringException(WUERR_ResultFormatMismatch, "addResult format %s, does not match existing format %s", formatStr, existingFormat);
  9931. }
  9932. else
  9933. p->setProp("@format", formatStr);
  9934. }
  9935. }
  9936. void CLocalWUResult::setResultFetchSize(unsigned rows)
  9937. {
  9938. p->setPropInt("fetchSize", rows);
  9939. }
  9940. void CLocalWUResult::setResultTotalRowCount(__int64 rows)
  9941. {
  9942. p->setPropInt64("totalRowCount", rows);
  9943. }
  9944. void CLocalWUResult::setResultRowCount(__int64 rows)
  9945. {
  9946. p->setPropInt64("rowCount", rows);
  9947. }
  9948. void CLocalWUResult::setResultDataset(const char *ecl, const char *defs)
  9949. {
  9950. p->setProp("datasetEcl", ecl);
  9951. p->setProp("datasetEclDefs", defs);
  9952. }
  9953. void CLocalWUResult::setResultLogicalName(const char *logicalName)
  9954. {
  9955. p->setProp("logicalName", logicalName);
  9956. }
  9957. void CLocalWUResult::setResultKeyField(const char *ecl)
  9958. {
  9959. p->setProp("keyField", ecl);
  9960. }
  9961. void CLocalWUResult::setResultRequestedRows(unsigned rows)
  9962. {
  9963. p->setPropInt("requestedRows", rows);
  9964. }
  9965. void CLocalWUResult::setResultRecordSizeEntry(const char * entry)
  9966. {
  9967. p->setProp("@recordSizeEntry", entry);
  9968. }
  9969. void CLocalWUResult::setResultTransformerEntry(const char * entry)
  9970. {
  9971. p->setProp("@transformerEntry", entry);
  9972. }
  9973. void CLocalWUResult::setResultRowLimit(__int64 value)
  9974. {
  9975. p->setPropInt64("@rowLimit", value);
  9976. }
  9977. void CLocalWUResult::setResultFilename(const char * name)
  9978. {
  9979. p->setProp("@tempFilename", name);
  9980. }
  9981. // MORE - it's an undetected error if we call getResult... of a type that does not match schema
  9982. __int64 CLocalWUResult::getResultInt() const
  9983. {
  9984. __int64 result = 0;
  9985. MemoryBuffer s;
  9986. p->getPropBin("Value", s);
  9987. if (s.length())
  9988. s.read(result);
  9989. else
  9990. result = p->getPropInt64("xmlValue");
  9991. return result;
  9992. }
  9993. bool CLocalWUResult::getResultBool() const
  9994. {
  9995. bool result = false;
  9996. MemoryBuffer s;
  9997. p->getPropBin("Value", s);
  9998. if (s.length())
  9999. s.read(result);
  10000. else
  10001. result = p->getPropBool("xmlValue");
  10002. return result;
  10003. }
  10004. double CLocalWUResult::getResultReal() const
  10005. {
  10006. double result = 0;
  10007. MemoryBuffer s;
  10008. p->getPropBin("Value", s);
  10009. if (s.length())
  10010. s.read(result);
  10011. else
  10012. {
  10013. const char *xmlVal = p->queryProp("xmlValue");
  10014. if (xmlVal)
  10015. result = atof(xmlVal);
  10016. }
  10017. return result;
  10018. }
  10019. void CLocalWUResult::getResultDecimal(void * val, unsigned len, unsigned precision, bool isSigned) const
  10020. {
  10021. MemoryBuffer s;
  10022. p->getPropBin("Value", s);
  10023. if (s.length())
  10024. {
  10025. assertex(s.length() == len);
  10026. s.read(len, val);
  10027. }
  10028. else
  10029. {
  10030. const char *xmlVal = p->queryProp("xmlValue");
  10031. if (xmlVal)
  10032. {
  10033. Decimal d;
  10034. d.setString(strlen(xmlVal), xmlVal);
  10035. if (isSigned)
  10036. d.getDecimal(len, precision, val);
  10037. else
  10038. d.getUDecimal(len, precision, val);
  10039. }
  10040. else
  10041. memset(val, 0, len);
  10042. }
  10043. }
  10044. IStringVal& CLocalWUResult::getResultString(IStringVal & str, bool hidePassword) const
  10045. {
  10046. if (hidePassword && p->getPropBool("@password"))
  10047. {
  10048. str.set("****");
  10049. return str;
  10050. }
  10051. MemoryBuffer s;
  10052. p->getPropBin("Value", s);
  10053. if (s.length())
  10054. {
  10055. unsigned len;
  10056. s.read(len);
  10057. str.setLen((const char *) s.readDirect(len), len);
  10058. }
  10059. else
  10060. {
  10061. p->getPropBin("xmlValue", s);
  10062. if (p->isBinary("xmlValue"))
  10063. str.setLen(s.toByteArray(), s.length());
  10064. else
  10065. {
  10066. char *ascii = rtlUtf8ToVStr(rtlUtf8Length(s.length(), s.toByteArray()), s.toByteArray());
  10067. str.set(ascii);
  10068. rtlFree(ascii);
  10069. }
  10070. }
  10071. return str;
  10072. }
  10073. WUResultFormat CLocalWUResult::getResultFormat() const
  10074. {
  10075. const char * format = p->queryProp("@format");
  10076. if (!format)
  10077. return ResultFormatRaw;
  10078. else if (strcmp(format, "xml") == 0)
  10079. return ResultFormatXml;
  10080. else if (strcmp(format, "xmlSet") == 0)
  10081. return ResultFormatXmlSet;
  10082. else if (strcmp(format, "csv") == 0)
  10083. return ResultFormatCsv;
  10084. else
  10085. throw MakeStringException(WUERR_InvalidResultFormat, "Unrecognised result format %s", format);
  10086. }
  10087. IDataVal& CLocalWUResult::getResultRaw(IDataVal & data, IXmlToRawTransformer * xmlTransformer, ICsvToRawTransformer * csvTransformer) const
  10088. {
  10089. MemoryBuffer s;
  10090. p->getPropBin("Value", s);
  10091. unsigned len = s.length();
  10092. if (len)
  10093. {
  10094. WUResultFormat format = getResultFormat();
  10095. if (format == ResultFormatXml || format == ResultFormatXmlSet)
  10096. {
  10097. if (!xmlTransformer)
  10098. throw MakeStringException(WUERR_MissingFormatTranslator, "No transformer supplied to translate XML format result");
  10099. xmlTransformer->transform(data, len, s.readDirect(len), format == ResultFormatXml);
  10100. }
  10101. else if (format == ResultFormatCsv)
  10102. {
  10103. if (!csvTransformer)
  10104. throw MakeStringException(WUERR_MissingFormatTranslator, "No transformer supplied to translate Csv format result");
  10105. csvTransformer->transform(data, len, s.readDirect(len), true);
  10106. }
  10107. else
  10108. data.setLen(s.readDirect(len), len);
  10109. }
  10110. else
  10111. data.clear();
  10112. return data;
  10113. }
  10114. unsigned CLocalWUResult::getResultHash() const
  10115. {
  10116. MemoryBuffer s;
  10117. p->getPropBin("Value", s);
  10118. unsigned len = s.length();
  10119. const byte * data = (const byte *)s.toByteArray();
  10120. return ~hashc(data, len, ~0);
  10121. }
  10122. IDataVal& CLocalWUResult::getResultUnicode(IDataVal & data) const
  10123. {
  10124. MemoryBuffer s;
  10125. p->getPropBin("Value", s);
  10126. if (s.length())
  10127. {
  10128. unsigned len;
  10129. s.read(len);
  10130. data.setLen(s.readDirect(len*2), len*2);
  10131. }
  10132. else
  10133. {
  10134. StringBuffer utf8;
  10135. if (p->getProp("xmlValue", utf8))
  10136. {
  10137. unsigned outlen;
  10138. UChar *out;
  10139. rtlUtf8ToUnicodeX(outlen, out, utf8.length(), utf8.str());
  10140. data.setLen(out, outlen*2);
  10141. rtlFree(out);
  10142. }
  10143. else
  10144. data.clear();
  10145. }
  10146. return data;
  10147. }
  10148. __int64 CLocalWUResult::getResultRawSize(IXmlToRawTransformer * xmlTransformer, ICsvToRawTransformer * csvTransformer) const
  10149. {
  10150. WUResultFormat format = getResultFormat();
  10151. if (format == ResultFormatRaw)
  10152. {
  10153. //MORE: This should not load the whole property...
  10154. MemoryBuffer s;
  10155. p->getPropBin("Value", s);
  10156. return s.length();
  10157. }
  10158. else
  10159. {
  10160. MemoryBuffer temp;
  10161. MemoryBuffer2IDataVal adaptor(temp);
  10162. getResultRaw(adaptor, xmlTransformer, csvTransformer);
  10163. return temp.length();
  10164. }
  10165. }
  10166. IDataVal& CLocalWUResult::getResultRaw(IDataVal & data, __int64 from, __int64 length, IXmlToRawTransformer * xmlTransformer, ICsvToRawTransformer * csvTransformer) const
  10167. {
  10168. WUResultFormat format = getResultFormat();
  10169. if (format != ResultFormatRaw)
  10170. {
  10171. MemoryBuffer temp;
  10172. MemoryBuffer2IDataVal adaptor(temp);
  10173. getResultRaw(adaptor, xmlTransformer, csvTransformer);
  10174. unsigned len = temp.length();
  10175. if (from > len) from = len;
  10176. if (from + length > len) length = len - from;
  10177. data.setLen(temp.readDirect(len) + from, (size32_t)length);
  10178. return data;
  10179. }
  10180. else
  10181. {
  10182. //MORE: This should not load the whole property, and should be different from the code above...
  10183. MemoryBuffer s;
  10184. p->getPropBin("Value", s);
  10185. unsigned len = s.length();
  10186. if (from > len) from = len;
  10187. if (from + length > len) length = len - from;
  10188. data.setLen(s.readDirect(len) + from, (size32_t)length);
  10189. return data;
  10190. }
  10191. }
  10192. bool CLocalWUResult::getResultIsAll() const
  10193. {
  10194. return p->getPropBool("@isAll", false);
  10195. }
  10196. // MORE - it's an undetected error if we call setResult... of a type that does not match schema
  10197. void CLocalWUResult::setResultInt(__int64 val)
  10198. {
  10199. // Note: we always serialize scalar integer results as int8, and schema must reflect this
  10200. MemoryBuffer m;
  10201. serializeInt8(val, m);
  10202. p->setPropBin("Value", m.length(), m.toByteArray());
  10203. setResultRowCount(1);
  10204. setResultTotalRowCount(1);
  10205. }
  10206. void CLocalWUResult::setResultUInt(unsigned __int64 val)
  10207. {
  10208. setResultInt((__int64) val);
  10209. }
  10210. void CLocalWUResult::setResultReal(double val)
  10211. {
  10212. // Note: we always serialize scalar real results as real8, and schema must reflect this
  10213. MemoryBuffer m;
  10214. serializeReal8(val, m);
  10215. p->setPropBin("Value", m.length(), m.toByteArray());
  10216. setResultRowCount(1);
  10217. setResultTotalRowCount(1);
  10218. }
  10219. void CLocalWUResult::setResultBool(bool val)
  10220. {
  10221. MemoryBuffer m;
  10222. serializeBool(val, m);
  10223. p->setPropBin("Value", m.length(), m.toByteArray());
  10224. setResultRowCount(1);
  10225. setResultTotalRowCount(1);
  10226. }
  10227. void CLocalWUResult::setResultString(const char *val, unsigned len)
  10228. {
  10229. // Note: we always serialize scalar strings with length prefix, and schema must reflect this
  10230. MemoryBuffer m;
  10231. serializeLPString(len, val, m);
  10232. p->setPropBin("Value", m.length(), m.toByteArray());
  10233. setResultRowCount(1);
  10234. setResultTotalRowCount(1);
  10235. }
  10236. void CLocalWUResult::setResultUnicode(const void *val, unsigned len)
  10237. {
  10238. // Note: we always serialize scalar strings with length prefix, and schema must reflect this
  10239. MemoryBuffer m;
  10240. m.append(len).append(len*2, val);
  10241. p->setPropBin("Value", m.length(), m.toByteArray());
  10242. setResultRowCount(1);
  10243. setResultTotalRowCount(1);
  10244. }
  10245. void CLocalWUResult::setResultData(const void *val, unsigned len)
  10246. {
  10247. // Note: we always serialize scalar data with length prefix, and schema must reflect this
  10248. MemoryBuffer m;
  10249. serializeLPString(len, (const char *)val, m);
  10250. p->setPropBin("Value", m.length(), m.toByteArray());
  10251. setResultRowCount(1);
  10252. setResultTotalRowCount(1);
  10253. }
  10254. void CLocalWUResult::setResultDecimal(const void *val, unsigned len)
  10255. {
  10256. // Note: serialized as data but with length known from schema
  10257. MemoryBuffer m;
  10258. serializeFixedData(len, val, m);
  10259. p->setPropBin("Value", m.length(), m.toByteArray());
  10260. setResultRowCount(1);
  10261. setResultTotalRowCount(1);
  10262. }
  10263. void CLocalWUResult::setResultRow(unsigned len, const void * data)
  10264. {
  10265. p->setPropBin("Value", len, data);
  10266. setResultRowCount(1);
  10267. setResultTotalRowCount(1);
  10268. setResultFormat(ResultFormatRaw);
  10269. }
  10270. void CLocalWUResult::setResultIsAll(bool value)
  10271. {
  10272. p->setPropBool("@isAll", value);
  10273. }
  10274. //==========================================================================================
  10275. CLocalWUPlugin::CLocalWUPlugin(IPropertyTree *props) : p(props)
  10276. {
  10277. }
  10278. IStringVal& CLocalWUPlugin::getPluginName(IStringVal &str) const
  10279. {
  10280. str.set(p->queryProp("@dllname"));
  10281. return str;
  10282. }
  10283. IStringVal& CLocalWUPlugin::getPluginVersion(IStringVal &str) const
  10284. {
  10285. str.set(p->queryProp("@version"));
  10286. return str;
  10287. }
  10288. void CLocalWUPlugin::setPluginName(const char *str)
  10289. {
  10290. p->setProp("@dllname", str);
  10291. }
  10292. void CLocalWUPlugin::setPluginVersion(const char *str)
  10293. {
  10294. p->setProp("@version", str);
  10295. }
  10296. //==========================================================================================
  10297. CLocalWULibrary::CLocalWULibrary(IPropertyTree *props) : p(props)
  10298. {
  10299. }
  10300. IStringVal& CLocalWULibrary::getName(IStringVal &str) const
  10301. {
  10302. str.set(p->queryProp("@name"));
  10303. return str;
  10304. }
  10305. void CLocalWULibrary::setName(const char *str)
  10306. {
  10307. p->setProp("@name", str);
  10308. }
  10309. //==========================================================================================
  10310. CLocalWUException::CLocalWUException(IPropertyTree *props) : p(props)
  10311. {
  10312. }
  10313. IStringVal& CLocalWUException::getExceptionSource(IStringVal &str) const
  10314. {
  10315. str.set(p->queryProp("@source"));
  10316. return str;
  10317. }
  10318. IStringVal& CLocalWUException::getExceptionMessage(IStringVal &str) const
  10319. {
  10320. str.set(p->queryProp(NULL));
  10321. return str;
  10322. }
  10323. unsigned CLocalWUException::getExceptionCode() const
  10324. {
  10325. return p->getPropInt("@code", 0);
  10326. }
  10327. ErrorSeverity CLocalWUException::getSeverity() const
  10328. {
  10329. return (ErrorSeverity)p->getPropInt("@severity", SeverityError);
  10330. }
  10331. IStringVal & CLocalWUException::getTimeStamp(IStringVal & dt) const
  10332. {
  10333. dt.set(p->queryProp("@time"));
  10334. return dt;
  10335. }
  10336. IStringVal & CLocalWUException::getExceptionFileName(IStringVal & str) const
  10337. {
  10338. str.set(p->queryProp("@filename"));
  10339. return str;
  10340. }
  10341. unsigned CLocalWUException::getExceptionLineNo() const
  10342. {
  10343. return p->getPropInt("@row", 0);
  10344. }
  10345. unsigned CLocalWUException::getExceptionColumn() const
  10346. {
  10347. return p->getPropInt("@col", 0);
  10348. }
  10349. unsigned CLocalWUException::getActivityId() const
  10350. {
  10351. const char * scope = queryScope();
  10352. if (scope)
  10353. {
  10354. const char * colon = strrchr(scope, ':');
  10355. if (colon && hasPrefix(colon+1, ActivityScopePrefix, true))
  10356. return atoi(colon+1+strlen(ActivityScopePrefix));
  10357. }
  10358. return p->getPropInt("@activity", 0);
  10359. }
  10360. unsigned CLocalWUException::getSequence() const
  10361. {
  10362. return p->getPropInt("@sequence", 0);
  10363. }
  10364. const char * CLocalWUException::queryScope() const
  10365. {
  10366. return p->queryProp("@scope");
  10367. }
  10368. unsigned CLocalWUException::getPriority() const
  10369. {
  10370. return p->getPropInt("@prio", 0);
  10371. }
  10372. void CLocalWUException::setExceptionSource(const char *str)
  10373. {
  10374. p->setProp("@source", str);
  10375. }
  10376. void CLocalWUException::setExceptionMessage(const char *str)
  10377. {
  10378. p->setProp(NULL, str);
  10379. }
  10380. void CLocalWUException::setExceptionCode(unsigned code)
  10381. {
  10382. p->setPropInt("@code", code);
  10383. }
  10384. void CLocalWUException::setSeverity(ErrorSeverity level)
  10385. {
  10386. p->setPropInt("@severity", level);
  10387. }
  10388. void CLocalWUException::setTimeStamp(const char *str)
  10389. {
  10390. p->setProp("@time", str);
  10391. }
  10392. void CLocalWUException::setExceptionFileName(const char *str)
  10393. {
  10394. p->setProp("@filename", str);
  10395. }
  10396. void CLocalWUException::setExceptionLineNo(unsigned r)
  10397. {
  10398. p->setPropInt("@row", r);
  10399. }
  10400. void CLocalWUException::setExceptionColumn(unsigned c)
  10401. {
  10402. p->setPropInt("@col", c);
  10403. }
  10404. void CLocalWUException::setActivityId(unsigned _id)
  10405. {
  10406. p->setPropInt("@activity", _id);
  10407. }
  10408. void CLocalWUException::setScope(const char * _scope)
  10409. {
  10410. p->setProp("@scope", _scope);
  10411. }
  10412. void CLocalWUException::setPriority(unsigned _priority)
  10413. {
  10414. p->setPropInt("@prio", _priority);
  10415. }
  10416. //==========================================================================================
  10417. CLocalWUAppValue::CLocalWUAppValue(IPropertyTree *props, unsigned child) : p(props)
  10418. {
  10419. StringAttrBuilder propPath(prop);
  10420. propPath.append("*[").append(child).append("]");
  10421. }
  10422. const char * CLocalWUAppValue::queryApplication() const
  10423. {
  10424. return p->queryName();
  10425. }
  10426. const char * CLocalWUAppValue::queryName() const
  10427. {
  10428. IPropertyTree* val=p->queryPropTree(prop.str());
  10429. if(val)
  10430. return val->queryName();
  10431. return ""; // Should not happen in normal usage
  10432. }
  10433. const char * CLocalWUAppValue::queryValue() const
  10434. {
  10435. return p->queryProp(prop.str());
  10436. }
  10437. //==========================================================================================
  10438. CLocalWUStatistic::CLocalWUStatistic(IPropertyTree *props) : p(props)
  10439. {
  10440. }
  10441. IStringVal & CLocalWUStatistic::getCreator(IStringVal & str) const
  10442. {
  10443. const char * creator = p->queryProp("@creator");
  10444. str.set(creator);
  10445. return str;
  10446. }
  10447. IStringVal & CLocalWUStatistic::getDescription(IStringVal & str, bool createDefault) const
  10448. {
  10449. const char * desc = p->queryProp("@desc");
  10450. if (desc)
  10451. {
  10452. str.set(desc); // legacy and in case it is overridden
  10453. }
  10454. else if (createDefault)
  10455. {
  10456. StatisticKind kind = getKind();
  10457. assertex(kind != StKindNone);
  10458. const char * scope = p->queryProp("@scope");
  10459. assertex(scope);
  10460. //Clean up the format of the scope when converting it to a description
  10461. StringBuffer descriptionText;
  10462. if (isGlobalScope(scope))
  10463. {
  10464. const char * creator = p->queryProp("@creator");
  10465. descriptionText.append(creator).append(":");
  10466. queryLongStatisticName(descriptionText, kind);
  10467. }
  10468. else
  10469. {
  10470. for (;;)
  10471. {
  10472. char c = *scope++;
  10473. if (!c)
  10474. break;
  10475. if (c == ':')
  10476. descriptionText.append(": ");
  10477. else
  10478. descriptionText.append(c);
  10479. }
  10480. if (kind != StTimeElapsed)
  10481. queryLongStatisticName(descriptionText.append(": "), kind);
  10482. }
  10483. str.set(descriptionText);
  10484. }
  10485. else
  10486. str.clear();
  10487. return str;
  10488. }
  10489. IStringVal & CLocalWUStatistic::getFormattedValue(IStringVal & str) const
  10490. {
  10491. StringBuffer formatted;
  10492. formatStatistic(formatted, getValue(), getMeasure());
  10493. str.set(formatted);
  10494. return str;
  10495. }
  10496. StatisticCreatorType CLocalWUStatistic::getCreatorType() const
  10497. {
  10498. return queryCreatorType(p->queryProp("@c"), SCTnone);
  10499. }
  10500. StatisticScopeType CLocalWUStatistic::getScopeType() const
  10501. {
  10502. return queryScopeType(p->queryProp("@s"), SSTnone);
  10503. }
  10504. StatisticKind CLocalWUStatistic::getKind() const
  10505. {
  10506. return queryStatisticKind(p->queryProp("@kind"), StKindNone);
  10507. }
  10508. const char * CLocalWUStatistic::queryScope() const
  10509. {
  10510. const char * scope = p->queryProp("@scope");
  10511. if (scope && streq(scope, LEGACY_GLOBAL_SCOPE))
  10512. scope = GLOBAL_SCOPE;
  10513. return scope;
  10514. }
  10515. StatisticMeasure CLocalWUStatistic::getMeasure() const
  10516. {
  10517. return queryMeasure(p->queryProp("@unit"), SMeasureNone);
  10518. }
  10519. unsigned __int64 CLocalWUStatistic::getValue() const
  10520. {
  10521. return p->getPropInt64("@value", 0);
  10522. }
  10523. unsigned __int64 CLocalWUStatistic::getCount() const
  10524. {
  10525. return p->getPropInt64("@count", 0);
  10526. }
  10527. unsigned __int64 CLocalWUStatistic::getMax() const
  10528. {
  10529. return p->getPropInt64("@max", 0);
  10530. }
  10531. unsigned __int64 CLocalWUStatistic::getTimestamp() const
  10532. {
  10533. return p->getPropInt64("@ts", 0);
  10534. }
  10535. //==========================================================================================
  10536. extern WORKUNIT_API ILocalWorkUnit * createLocalWorkUnit(const char *xml)
  10537. {
  10538. Owned<CLocalWorkUnit> cw = new CLocalWorkUnit((ISecManager *) NULL, NULL);
  10539. if (xml)
  10540. cw->loadPTree(createPTreeFromXMLString(xml, ipt_lowmem));
  10541. else
  10542. {
  10543. Owned<IPropertyTree> p = createPTree("W_LOCAL", ipt_lowmem);
  10544. p->setProp("@xmlns:xsi", "http://www.w3.org/1999/XMLSchema-instance");
  10545. cw->loadPTree(p.getClear());
  10546. }
  10547. ILocalWorkUnit* ret = QUERYINTERFACE(&cw->lockRemote(false), ILocalWorkUnit);
  10548. return ret;
  10549. }
  10550. void exportWorkUnitToXMLWithHiddenPasswords(IPropertyTree *p, IIOStream &out, unsigned extraXmlFlags)
  10551. {
  10552. const char *name = p->queryName();
  10553. if (!name)
  10554. name = "__unnamed__";
  10555. StringBuffer temp;
  10556. writeStringToStream(out, appendPTreeOpenTag(temp, p, name, 1, true));
  10557. Owned<IPropertyTreeIterator> elems = p->getElements("*", iptiter_sort);
  10558. ForEach(*elems)
  10559. {
  10560. IPropertyTree &elem = elems->query();
  10561. if (streq(elem.queryName(), "Parameters"))
  10562. {
  10563. writeStringToStream(out, appendPTreeOpenTag(temp.clear().append(' '), &elem, "Parameters", 2, false).append('\n'));
  10564. Owned<IPropertyTreeIterator> params = elem.getElements("*", iptiter_sort);
  10565. ForEach(*params)
  10566. {
  10567. IPropertyTree &param = params->query();
  10568. const char *paramname = param.queryName();
  10569. VStringBuffer xpath("Variables/Variable[@name='%s']/Format/@password", paramname);
  10570. if (p->getPropBool(xpath))
  10571. writeStringToStream(out, appendXMLTag(temp.clear().append(" "), paramname, "****").append('\n'));
  10572. else
  10573. {
  10574. toXML(&param, out, 2, XML_Format|XML_SortTags|extraXmlFlags);
  10575. }
  10576. }
  10577. writeStringToStream(out, appendXMLCloseTag(temp.clear().append(' '), "Parameters").append('\n'));
  10578. }
  10579. else if (streq(elem.queryName(), "Variables"))
  10580. {
  10581. writeStringToStream(out, appendPTreeOpenTag(temp.clear().append(' '), &elem, "Variables", 2, false).append('\n'));
  10582. Owned<IPropertyTreeIterator> vars = elem.getElements("*", iptiter_sort);
  10583. ForEach(*vars)
  10584. {
  10585. Owned<IPropertyTree> var = LINK(&vars->query());
  10586. if (var->getPropBool("Format/@password"))
  10587. {
  10588. var.setown(createPTreeFromIPT(var)); //copy and remove password values
  10589. var->removeProp("Value");
  10590. var->removeProp("xmlValue");
  10591. }
  10592. toXML(var, out, 2, XML_Format|XML_SortTags|extraXmlFlags);
  10593. }
  10594. writeStringToStream(out, appendXMLCloseTag(temp.clear().append(' '), "Variables").append('\n'));
  10595. }
  10596. else
  10597. toXML(&elem, out, 1, XML_Format|XML_SortTags|extraXmlFlags);
  10598. }
  10599. writeStringToStream(out, appendXMLCloseTag(temp.clear(), name));
  10600. }
  10601. StringBuffer &exportWorkUnitToXMLWithHiddenPasswords(IPropertyTree *p, StringBuffer &str)
  10602. {
  10603. class CAdapter : public CInterface, implements IIOStream
  10604. {
  10605. StringBuffer &out;
  10606. public:
  10607. IMPLEMENT_IINTERFACE;
  10608. CAdapter(StringBuffer &_out) : out(_out) { }
  10609. virtual void flush() { }
  10610. virtual size32_t read(size32_t len, void * data) { UNIMPLEMENTED; return 0; }
  10611. virtual size32_t write(size32_t len, const void * data) { out.append(len, (const char *)data); return len; }
  10612. } adapter(str);
  10613. exportWorkUnitToXMLWithHiddenPasswords(p->queryBranch(NULL), adapter, 0);
  10614. return str;
  10615. }
  10616. void exportWorkUnitToXMLFileWithHiddenPasswords(IPropertyTree *p, const char *filename, unsigned extraXmlFlags)
  10617. {
  10618. OwnedIFile ifile = createIFile(filename);
  10619. OwnedIFileIO ifileio = ifile->open(IFOcreate);
  10620. Owned<IIOStream> stream = createIOStream(ifileio);
  10621. exportWorkUnitToXMLWithHiddenPasswords(p->queryBranch(NULL), *stream, extraXmlFlags);
  10622. }
  10623. extern WORKUNIT_API StringBuffer &exportWorkUnitToXML(const IConstWorkUnit *wu, StringBuffer &str, bool unpack, bool includeProgress, bool hidePasswords)
  10624. {
  10625. // MORE - queryPTree isn't really safe without holding CLocalWorkUnit::crit - really need to move these functions into CLocalWorkunit
  10626. const IExtendedWUInterface *ewu = queryExtendedWU(wu);
  10627. if (ewu)
  10628. {
  10629. Linked<IPropertyTree> p;
  10630. if (unpack||includeProgress)
  10631. p.setown(ewu->getUnpackedTree(includeProgress));
  10632. else
  10633. p.set(ewu->queryPTree());
  10634. if (hidePasswords)
  10635. return exportWorkUnitToXMLWithHiddenPasswords(p, str);
  10636. else
  10637. return toXML(p, str, 0, XML_Format|XML_SortTags);
  10638. }
  10639. else
  10640. return str.append("Unrecognized workunit format");
  10641. }
  10642. extern WORKUNIT_API void exportWorkUnitToXMLFile(const IConstWorkUnit *wu, const char * filename, unsigned extraXmlFlags, bool unpack, bool includeProgress, bool hidePasswords, bool regressionTest)
  10643. {
  10644. const IExtendedWUInterface *ewu = queryExtendedWU(wu);
  10645. if (ewu)
  10646. {
  10647. Linked<IPropertyTree> p;
  10648. if (unpack||includeProgress)
  10649. p.setown(ewu->getUnpackedTree(includeProgress));
  10650. else if (regressionTest)
  10651. p.setown(createPTreeFromIPT(ewu->queryPTree()));
  10652. else
  10653. p.set(ewu->queryPTree());
  10654. if (hidePasswords)
  10655. return exportWorkUnitToXMLFileWithHiddenPasswords(p, filename, extraXmlFlags);
  10656. if (regressionTest)
  10657. {
  10658. //This removes any items from the xml that will vary from run to run, so they can be binary compared from run to run
  10659. //The following attributes change with the build. Simpler to remove rather than needing to updated each build
  10660. p->removeProp("@buildVersion");
  10661. p->removeProp("@eclVersion");
  10662. p->removeProp("@hash");
  10663. //Remove statistics, and extract them to a separate file
  10664. IPropertyTree * stats = p->queryPropTree("Statistics");
  10665. if (stats)
  10666. {
  10667. StringBuffer statsFilename;
  10668. statsFilename.append(filename).append(".stats");
  10669. saveXML(statsFilename, stats, 0, (XML_Format|XML_SortTags|extraXmlFlags) & ~XML_LineBreakAttributes);
  10670. p->removeProp("Statistics");
  10671. }
  10672. //Now remove timestamps from exceptions
  10673. Owned<IPropertyTreeIterator> elems = p->getElements("Exceptions/Exception", iptiter_sort);
  10674. ForEach(*elems)
  10675. {
  10676. IPropertyTree &elem = elems->query();
  10677. elem.removeProp("@time");
  10678. }
  10679. }
  10680. saveXML(filename, p, 0, XML_Format|XML_SortTags|extraXmlFlags);
  10681. }
  10682. else
  10683. throw makeStringException(0, "Unrecognized workunit format");
  10684. }
  10685. extern WORKUNIT_API void submitWorkUnit(const char *wuid, const char *username, const char *password)
  10686. {
  10687. MemoryBuffer buffer;
  10688. Owned<INamedQueueConnection> conn = createNamedQueueConnection(0); // MORE - security token?
  10689. Owned<IWorkUnitFactory> factory = getWorkUnitFactory();
  10690. Owned<IWorkUnit> workunit = factory->updateWorkUnit(wuid);
  10691. assertex(workunit);
  10692. StringAttr clusterName(workunit->queryClusterName());
  10693. if (!clusterName.length())
  10694. throw MakeStringException(WUERR_InvalidCluster, "No target cluster specified");
  10695. workunit->commit();
  10696. workunit.clear();
  10697. Owned<IConstWUClusterInfo> clusterInfo = getTargetClusterInfo(clusterName.str());
  10698. if (!clusterInfo)
  10699. throw MakeStringException(WUERR_InvalidCluster, "Unknown cluster %s", clusterName.str());
  10700. SCMStringBuffer serverQueue;
  10701. clusterInfo->getServerQueue(serverQueue);
  10702. assertex(serverQueue.length());
  10703. Owned<IJobQueue> queue = createJobQueue(serverQueue.str());
  10704. if (!queue.get())
  10705. throw MakeStringException(WUERR_InvalidQueue, "Could not create workunit queue");
  10706. IJobQueueItem *item = createJobQueueItem(wuid);
  10707. queue->enqueue(item);
  10708. }
  10709. extern WORKUNIT_API void abortWorkUnit(const char *wuid)
  10710. {
  10711. StringBuffer xpath("/WorkUnitAborts/");
  10712. xpath.append(wuid);
  10713. Owned<IRemoteConnection> acon = querySDS().connect(xpath.str(), myProcessSession(), RTM_LOCK_WRITE|RTM_CREATE, SDS_LOCK_TIMEOUT);
  10714. acon->queryRoot()->setPropInt(NULL, 1);
  10715. }
  10716. extern WORKUNIT_API void secSubmitWorkUnit(const char *wuid, ISecManager &secmgr, ISecUser &secuser)
  10717. {
  10718. if (checkWuSecAccess(wuid, &secmgr, &secuser, SecAccess_Write, "Submit", true, true))
  10719. submitWorkUnit(wuid, secuser.getName(), secuser.credentials().getPassword());
  10720. }
  10721. extern WORKUNIT_API void secAbortWorkUnit(const char *wuid, ISecManager &secmgr, ISecUser &secuser)
  10722. {
  10723. if (!checkWuSecAccess(wuid, &secmgr, &secuser, SecAccess_Write, "Submit", true, true))
  10724. return;
  10725. abortWorkUnit(wuid);
  10726. Owned<IConstWorkUnit> cw = factory->openWorkUnit(wuid);
  10727. if(!cw)
  10728. return;
  10729. WorkunitUpdate wu(&cw->lock());
  10730. const char *abortBy = secuser.getName();
  10731. if (abortBy && *abortBy)
  10732. wu->setTracingValue("AbortBy", abortBy);
  10733. wu->setTracingValueInt64("AbortTimeStamp", getTimeStampNowValue());
  10734. }
  10735. extern WORKUNIT_API void submitWorkUnit(const char *wuid, ISecManager *secmgr, ISecUser *secuser)
  10736. {
  10737. if (secmgr && secuser)
  10738. return secSubmitWorkUnit(wuid, *secmgr, *secuser);
  10739. if (secuser)
  10740. return submitWorkUnit(wuid, secuser->getName(), secuser->credentials().getPassword());
  10741. submitWorkUnit(wuid, "", "");
  10742. }
  10743. extern WORKUNIT_API void abortWorkUnit(const char *wuid, ISecManager *secmgr, ISecUser *secuser)
  10744. {
  10745. if (secmgr && secuser)
  10746. return secAbortWorkUnit(wuid, *secmgr, *secuser);
  10747. abortWorkUnit(wuid);
  10748. }
  10749. bool CLocalWorkUnit::hasWorkflow() const
  10750. {
  10751. return p->hasProp("Workflow");
  10752. }
  10753. unsigned CLocalWorkUnit::queryEventScheduledCount() const
  10754. {
  10755. CriticalBlock block(crit);
  10756. if (p->hasProp("@eventScheduledCount"))
  10757. return p->getPropInt("@eventScheduledCount", 0);
  10758. else
  10759. return p->getPropInt("Workflow/@eventScheduledCount", 0); // Legacy location for this setting
  10760. }
  10761. void CLocalWorkUnit::incEventScheduledCount()
  10762. {
  10763. CriticalBlock block(crit);
  10764. p->setPropInt("@eventScheduledCount", queryEventScheduledCount()+1);
  10765. }
  10766. IPropertyTree * CLocalWorkUnit::queryWorkflowTree() const
  10767. {
  10768. CriticalBlock block(crit);
  10769. return p->queryPropTree("Workflow");
  10770. }
  10771. IConstWorkflowItemIterator* CLocalWorkUnit::getWorkflowItems() const
  10772. {
  10773. // For this to be legally called, we must have the read-able interface. So we are already locked for (at least) read.
  10774. CriticalBlock block(crit);
  10775. if(!workflowIteratorCached)
  10776. {
  10777. assertex(!workflowIterator);
  10778. Owned<IPropertyTree> s = p->getPropTree("Workflow");
  10779. if(s)
  10780. workflowIterator.setown(createWorkflowItemIterator(s));
  10781. workflowIteratorCached = true;
  10782. }
  10783. return workflowIterator.getLink();
  10784. }
  10785. IWorkflowItemArray * CLocalWorkUnit::getWorkflowClone() const
  10786. {
  10787. unsigned count = 0;
  10788. Owned<IConstWorkflowItemIterator> iter = getWorkflowItems();
  10789. for(iter->first(); iter->isValid(); iter->next())
  10790. count++;
  10791. Owned<IWorkflowItemArray> array = createWorkflowItemArray(count);
  10792. for(iter->first(); iter->isValid(); iter->next())
  10793. array->addClone(iter->query());
  10794. return array.getLink();
  10795. }
  10796. IWorkflowItem * CLocalWorkUnit::addWorkflowItem(unsigned wfid, WFType type, WFMode mode, unsigned success, unsigned failure, unsigned recovery, unsigned retriesAllowed, unsigned contingencyFor)
  10797. {
  10798. // For this to be legally called, we must have the write-able interface. So we are already locked for write.
  10799. CriticalBlock block(crit);
  10800. workflowIterator.clear();
  10801. workflowIteratorCached = false;
  10802. IPropertyTree * s = p->queryPropTree("Workflow");
  10803. if(!s)
  10804. s = p->addPropTree("Workflow");
  10805. return createWorkflowItem(s, wfid, type, mode, success, failure, recovery, retriesAllowed, contingencyFor);
  10806. }
  10807. IWorkflowItemIterator * CLocalWorkUnit::updateWorkflowItems()
  10808. {
  10809. // For this to be legally called, we must have the write-able interface. So we are already locked for write.
  10810. CriticalBlock block(crit);
  10811. if(!workflowIterator)
  10812. {
  10813. IPropertyTree * s = p->queryPropTree("Workflow");
  10814. if(!s)
  10815. s = p->addPropTree("Workflow");
  10816. workflowIterator.setown(createWorkflowItemIterator(s));
  10817. workflowIteratorCached = true;
  10818. }
  10819. return workflowIterator.getLink();
  10820. }
  10821. void CLocalWorkUnit::syncRuntimeWorkflow(IWorkflowItemArray * array)
  10822. {
  10823. Owned<IWorkflowItemIterator> iter = updateWorkflowItems();
  10824. Owned<IWorkflowItem> item;
  10825. for(iter->first(); iter->isValid(); iter->next())
  10826. {
  10827. item.setown(iter->get());
  10828. item->syncRuntimeData(array->queryWfid(item->queryWfid()));
  10829. }
  10830. workflowIterator.clear();
  10831. workflowIteratorCached = false;
  10832. }
  10833. void CLocalWorkUnit::resetWorkflow()
  10834. {
  10835. if (hasWorkflow())
  10836. {
  10837. Owned<IWorkflowItemIterator> iter = updateWorkflowItems();
  10838. Owned<IWorkflowItem> wf;
  10839. for(iter->first(); iter->isValid(); iter->next())
  10840. {
  10841. wf.setown(iter->get());
  10842. wf->reset();
  10843. }
  10844. workflowIterator.clear();
  10845. workflowIteratorCached = false;
  10846. }
  10847. }
  10848. void CLocalWorkUnit::schedule()
  10849. {
  10850. CriticalBlock block(crit);
  10851. if(queryEventScheduledCount() == 0) return;
  10852. switch(getState())
  10853. {
  10854. case WUStateCompleted:
  10855. setState(WUStateWait);
  10856. break;
  10857. case WUStateFailed:
  10858. case WUStateArchived:
  10859. case WUStateAborting:
  10860. case WUStateAborted:
  10861. case WUStateScheduled:
  10862. throw MakeStringException(WUERR_CannotSchedule, "Cannot schedule workunit in this state");
  10863. }
  10864. StringBuffer rootPath;
  10865. rootPath.append("/Schedule/").append(queryClusterName());
  10866. Owned<IRemoteConnection> conn = querySDS().connect(rootPath.str(), myProcessSession(), RTM_LOCK_WRITE | RTM_CREATE_QUERY, SDS_LOCK_TIMEOUT);
  10867. Owned<IPropertyTree> root = conn->getRoot();
  10868. if(!root->hasChildren())
  10869. {
  10870. StringBuffer addPath;
  10871. addPath.append("/Schedulers/").append(queryClusterName());
  10872. Owned<IRemoteConnection> addConn = querySDS().connect(addPath.str(), myProcessSession(), RTM_LOCK_WRITE | RTM_CREATE_QUERY, SDS_LOCK_TIMEOUT);
  10873. }
  10874. char const * wuid = p->queryName();
  10875. StringBuffer xpath("*/*/");
  10876. ncnameEscape(wuid, xpath);
  10877. bool more;
  10878. do more = root->removeProp(xpath.str()); while(more);
  10879. Owned<IConstWorkflowItemIterator> iter = getWorkflowItems();
  10880. Owned<IWorkflowEvent> event;
  10881. Owned<IPropertyTree> branch1, branch2;
  10882. for(iter->first(); iter->isValid(); iter->next())
  10883. {
  10884. event.setown(iter->query()->getScheduleEvent());
  10885. if(!event) continue;
  10886. ncnameEscape(event->queryName(), xpath.clear());
  10887. ensurePTree(root, xpath.str());
  10888. branch1.setown(root->getPropTree(xpath.str()));
  10889. ncnameEscape(event->queryText(), xpath.clear());
  10890. ensurePTree(branch1, xpath.str());
  10891. branch2.setown(branch1->getPropTree(xpath.str()));
  10892. ncnameEscape(wuid, xpath.clear());
  10893. ensurePTree(branch2, xpath.str());
  10894. }
  10895. }
  10896. void CLocalWorkUnit::deschedule()
  10897. {
  10898. if(queryEventScheduledCount() == 0) return;
  10899. if(getState() == WUStateWait)
  10900. setState(WUStateCompleted);
  10901. doDescheduleWorkkunit(p->queryName());
  10902. }
  10903. EnumMapping localFileUploadTypes[] = {
  10904. { UploadTypeFileSpray, "FileSpray" },
  10905. { UploadTypeWUResult, "WUResult" },
  10906. { UploadTypeWUResultCsv, "WUResultCsv" },
  10907. { UploadTypeWUResultXml, "WUResultXml" },
  10908. { UploadTypeSize, NULL }
  10909. };
  10910. class CLocalFileUpload : public CInterface, implements IConstLocalFileUpload
  10911. {
  10912. public:
  10913. CLocalFileUpload(IPropertyTree * _tree) : tree(_tree) {}
  10914. CLocalFileUpload(unsigned id, LocalFileUploadType type, char const * source, char const * destination, char const * eventTag)
  10915. {
  10916. tree.setown(createPTree());
  10917. tree->setPropInt("@id", id);
  10918. setEnum(tree, "@type", type, localFileUploadTypes);
  10919. tree->setProp("@source", source);
  10920. tree->setProp("@destination", destination);
  10921. if (eventTag)
  10922. tree->setProp("@eventTag", eventTag);
  10923. }
  10924. IMPLEMENT_IINTERFACE;
  10925. IPropertyTree * getTree() { return tree.getLink(); }
  10926. virtual unsigned queryID() const { return tree->getPropInt("@id"); }
  10927. virtual LocalFileUploadType queryType() const { return (LocalFileUploadType)getEnum(tree, "@type", localFileUploadTypes); }
  10928. virtual IStringVal & getSource(IStringVal & ret) const { ret.set(tree->queryProp("@source")); return ret; }
  10929. virtual IStringVal & getDestination(IStringVal & ret) const { ret.set(tree->queryProp("@destination")); return ret; }
  10930. virtual IStringVal & getEventTag(IStringVal & ret) const { if(tree->hasProp("@eventTag")) ret.set(tree->queryProp("@eventTag")); else ret.clear(); return ret; }
  10931. private:
  10932. Owned<IPropertyTree> tree;
  10933. };
  10934. class CLocalFileUploadIterator : public CInterface, implements IConstLocalFileUploadIterator
  10935. {
  10936. public:
  10937. CLocalFileUploadIterator(IPropertyTree * _tree) : tree(_tree), iter(tree->getElements("LocalFileUpload")) {}
  10938. IMPLEMENT_IINTERFACE;
  10939. bool first() { return iter->first(); }
  10940. bool isValid() { return iter->isValid(); }
  10941. bool next() { return iter->next(); }
  10942. IConstLocalFileUpload * get() { return new CLocalFileUpload(&iter->get()); }
  10943. private:
  10944. Owned<IPropertyTree> tree;
  10945. Owned<IPropertyTreeIterator> iter;
  10946. };
  10947. IConstLocalFileUploadIterator * CLocalWorkUnit::getLocalFileUploads() const
  10948. {
  10949. // For this to be legally called, we must have the read-able interface. So we are already locked for (at least) read.
  10950. CriticalBlock block(crit);
  10951. Owned<IPropertyTree> s = p->getPropTree("LocalFileUploads");
  10952. if(s)
  10953. return new CLocalFileUploadIterator(s.getClear());
  10954. else
  10955. return NULL;
  10956. }
  10957. bool CLocalWorkUnit::requiresLocalFileUpload() const
  10958. {
  10959. SCMStringBuffer dest;
  10960. Owned<IConstWUResult> result;
  10961. Owned<IConstLocalFileUploadIterator> iter(getLocalFileUploads());
  10962. if(!iter)
  10963. return false;
  10964. for(iter->first(); iter->isValid(); iter->next())
  10965. {
  10966. Owned<IConstLocalFileUpload> upload(iter->get());
  10967. switch(upload->queryType())
  10968. {
  10969. case UploadTypeWUResult:
  10970. case UploadTypeWUResultCsv:
  10971. case UploadTypeWUResultXml:
  10972. upload->getDestination(dest);
  10973. result.setown(getResultByName(dest.str()));
  10974. if(!result)
  10975. return true;
  10976. break;
  10977. default:
  10978. throw MakeStringException(WUERR_InvalidUploadFormat, "Unsupported local file upload type %s", getEnumText(upload->queryType(), localFileUploadTypes));
  10979. }
  10980. }
  10981. return false;
  10982. }
  10983. unsigned CLocalWorkUnit::addLocalFileUpload(LocalFileUploadType type, char const * source, char const * destination, char const * eventTag)
  10984. {
  10985. // For this to be legally called, we must have the write-able interface. So we are already locked for write.
  10986. CriticalBlock block(crit);
  10987. IPropertyTree * s = p->queryPropTree("LocalFileUploads");
  10988. if(!s)
  10989. s = p->addPropTree("LocalFileUploads");
  10990. unsigned id = s->numChildren();
  10991. Owned<CLocalFileUpload> upload = new CLocalFileUpload(id, type, source, destination, eventTag);
  10992. s->addPropTree("LocalFileUpload", upload->getTree());
  10993. return id;
  10994. }
  10995. IStringVal & CLocalWorkUnit::getAbortBy(IStringVal & str) const
  10996. {
  10997. CriticalBlock block(crit);
  10998. str.set(p->queryProp("Tracing/AbortBy"));
  10999. return str;
  11000. }
  11001. unsigned __int64 CLocalWorkUnit::getAbortTimeStamp() const
  11002. {
  11003. CriticalBlock block(crit);
  11004. return p->getPropInt64("Tracing/AbortTimeStamp", 0);
  11005. }
  11006. #if 0
  11007. void testConstWorkflow(IConstWorkflowItem * cwf, bool * okay, bool * dep)
  11008. {
  11009. DBGLOG("Test workflow const iface %u", cwf->queryWfid());
  11010. unsigned deps = 0;
  11011. Owned<IWorkflowDependencyIterator> diter;
  11012. switch(cwf->queryWfid())
  11013. {
  11014. case 1:
  11015. assertex(!cwf->isScheduled());
  11016. assertex(cwf->queryType() == WFTypeNormal);
  11017. assertex(cwf->queryState() == WFStateNull);
  11018. diter.setown(cwf->getDependencies());
  11019. for(diter->first(); diter->isValid(); diter->next())
  11020. deps++;
  11021. assertex(deps==0);
  11022. okay[0] = true;
  11023. break;
  11024. case 2:
  11025. assertex(!cwf->isScheduled());
  11026. assertex(cwf->queryType() == WFTypeRecovery);
  11027. assertex(cwf->queryState() == WFStateSkip);
  11028. okay[1] = true;
  11029. break;
  11030. case 3:
  11031. assertex(cwf->queryContingencyFor() == 4);
  11032. okay[2] = true;
  11033. break;
  11034. case 4:
  11035. assertex(cwf->isScheduled());
  11036. assertex(cwf->queryType() == WFTypeNormal);
  11037. assertex(cwf->queryState() == WFStateReqd);
  11038. assertex(cwf->querySuccess() == 0);
  11039. assertex(cwf->queryFailure() == 3);
  11040. assertex(cwf->queryRecovery() == 2);
  11041. assertex(cwf->queryRetriesAllowed() == 10);
  11042. assertex(cwf->queryRetriesRemaining() == 10);
  11043. diter.setown(cwf->getDependencies());
  11044. for(diter->first(); diter->isValid(); diter->next())
  11045. {
  11046. dep[diter->query()-1] = true;
  11047. deps++;
  11048. }
  11049. assertex(deps==2);
  11050. assertex(dep[0]);
  11051. assertex(dep[1]);
  11052. okay[3] = true;
  11053. break;
  11054. case 5:
  11055. assertex(cwf->isScheduled());
  11056. assertex(!cwf->isScheduledNow());
  11057. assertex(cwf->querySchedulePriority() == 75);
  11058. assertex(cwf->queryScheduleCount() == 5);
  11059. assertex(cwf->queryScheduleCountRemaining() == 5);
  11060. okay[4] = true;
  11061. break;
  11062. case 6:
  11063. assertex(cwf->isScheduled());
  11064. assertex(!cwf->isScheduledNow());
  11065. assertex(cwf->querySchedulePriority() == 25);
  11066. assertex(!cwf->hasScheduleCount());
  11067. okay[5] = true;
  11068. break;
  11069. default:
  11070. assertex(!"unknown wfid in test");
  11071. }
  11072. }
  11073. void testRuntimeWorkflow(IRuntimeWorkflowItem * rwf, bool * okay)
  11074. {
  11075. DBGLOG("Test workflow runtime iface %u", rwf->queryWfid());
  11076. switch(rwf->queryWfid())
  11077. {
  11078. case 1:
  11079. case 2:
  11080. case 3:
  11081. okay[rwf->queryWfid()-1] = true;
  11082. break;
  11083. case 4:
  11084. {
  11085. unsigned tries = 0;
  11086. while(rwf->testAndDecRetries())
  11087. tries++;
  11088. assertex(tries == 10);
  11089. assertex(rwf->queryRetriesRemaining() == 0);
  11090. rwf->setState(WFStateFail);
  11091. assertex(rwf->queryState() == WFStateFail);
  11092. rwf->reset();
  11093. assertex(rwf->queryRetriesRemaining() == 10);
  11094. assertex(rwf->queryState() == WFStateReqd);
  11095. }
  11096. okay[3] = true;
  11097. break;
  11098. case 5:
  11099. {
  11100. assertex(rwf->queryScheduleCountRemaining() == 5);
  11101. unsigned count = 0;
  11102. do count++; while(rwf->decAndTestScheduleCountRemaining());
  11103. assertex(count == 5);
  11104. assertex(rwf->queryScheduleCountRemaining() == 0);
  11105. rwf->reset();
  11106. assertex(rwf->queryScheduleCountRemaining() == 5);
  11107. }
  11108. okay[4] = true;
  11109. break;
  11110. case 6:
  11111. {
  11112. assertex(!rwf->hasScheduleCount());
  11113. unsigned count;
  11114. for(count=0; count<20; count++)
  11115. assertex(rwf->decAndTestScheduleCountRemaining());
  11116. }
  11117. okay[5] = true;
  11118. break;
  11119. default:
  11120. assertex(!"unknown wfid in test");
  11121. }
  11122. }
  11123. void testWorkflow()
  11124. {
  11125. DBGLOG("workunit.cpp : testWorkflow");
  11126. CLocalWorkUnit wu("W-WF-TEST", 0, 0, 0);
  11127. Owned<IWorkflowItem> wf;
  11128. wf.setown(wu.addWorkflowItem(1, WFTypeNormal, 0, 0, 0, 0, 0));
  11129. wf.setown(wu.addWorkflowItem(2, WFTypeRecovery, 0, 0, 0, 0, 0));
  11130. wf.setown(wu.addWorkflowItem(3, WFTypeFailure, 0, 0, 0, 0, 4));
  11131. wf.setown(wu.addWorkflowItem(4, WFTypeNormal, 0, 3, 2, 10, 0));
  11132. wf->setScheduledNow();
  11133. wf->addDependency(1);
  11134. wf.setown(wu.addWorkflowItem(5, WFTypeNormal, 0, 0, 0, 0, 0));
  11135. wf->setScheduledOn("test", "foo*");
  11136. wf->setSchedulePriority(75);
  11137. wf->setScheduleCount(5);
  11138. wf.setown(wu.addWorkflowItem(6, WFTypeNormal, 0, 0, 0, 0, 0));
  11139. wf->setScheduledOn("test", "bar*");
  11140. wf->setSchedulePriority(25);
  11141. unsigned const n = 6;
  11142. bool okay[n];
  11143. bool dep[n];
  11144. unsigned i;
  11145. for(i=0; i<n; i++)
  11146. okay[i] = dep[i] = 0;
  11147. Owned<IConstWorkflowItemIterator> citer(wu.getWorkflowItems());
  11148. for(citer->first(); citer->isValid(); citer->next())
  11149. testConstWorkflow(citer->query(), okay, dep);
  11150. for(i=0; i<n; i++)
  11151. {
  11152. assertex(okay[i]);
  11153. okay[i] = false;
  11154. }
  11155. Owned<IWorkflowItemIterator> miter(wu.updateWorkflowItems());
  11156. for(miter->first(); miter->isValid(); miter->next())
  11157. {
  11158. Owned<IRuntimeWorkflowItem> rwf(miter->get());
  11159. testRuntimeWorkflow(rwf, okay);
  11160. }
  11161. for(i=0; i<n; i++)
  11162. {
  11163. assertex(okay[i]);
  11164. okay[i] = dep[i] = false;
  11165. }
  11166. Owned<IWorkflowItemArray> array(wu.getWorkflowClone());
  11167. unsigned wfid;
  11168. for(wfid = 1; array->isValid(wfid); wfid++)
  11169. testConstWorkflow(&array->queryWfid(wfid), okay, dep);
  11170. for(i=0; i<n; i++)
  11171. {
  11172. assertex(okay[i]);
  11173. okay[i] = false;
  11174. }
  11175. for(wfid = 1; array->isValid(wfid); wfid++)
  11176. testRuntimeWorkflow(&array->queryWfid(wfid), okay);
  11177. for(i=0; i<n; i++)
  11178. {
  11179. assertex(okay[i]);
  11180. okay[i] = false;
  11181. }
  11182. }
  11183. #endif
  11184. //------------------------------------------------------------------------------------------
  11185. extern WUState waitForWorkUnitToComplete(const char * wuid, int timeout, bool returnOnWaitState)
  11186. {
  11187. return factory->waitForWorkUnit(wuid, (unsigned) timeout, false, returnOnWaitState);
  11188. }
  11189. extern WORKUNIT_API WUState secWaitForWorkUnitToComplete(const char * wuid, ISecManager &secmgr, ISecUser &secuser, int timeout, bool returnOnWaitState)
  11190. {
  11191. if (checkWuSecAccess(wuid, &secmgr, &secuser, SecAccess_Read, "Wait for Complete", false, true))
  11192. return waitForWorkUnitToComplete(wuid, timeout, returnOnWaitState);
  11193. return WUStateUnknown;
  11194. }
  11195. extern bool waitForWorkUnitToCompile(const char * wuid, int timeout)
  11196. {
  11197. switch(factory->waitForWorkUnit(wuid, (unsigned) timeout, true, true))
  11198. {
  11199. case WUStateCompiled:
  11200. case WUStateCompleted:
  11201. case WUStateWait:
  11202. case WUStateUploadingFiles:
  11203. return true;
  11204. default:
  11205. return false;
  11206. }
  11207. }
  11208. extern WORKUNIT_API bool secWaitForWorkUnitToCompile(const char * wuid, ISecManager &secmgr, ISecUser &secuser, int timeout)
  11209. {
  11210. if (checkWuSecAccess(wuid, &secmgr, &secuser, SecAccess_Read, "Wait for Compile", false, true))
  11211. return waitForWorkUnitToCompile(wuid, timeout);
  11212. return false;
  11213. }
  11214. extern WORKUNIT_API bool secDebugWorkunit(const char * wuid, ISecManager &secmgr, ISecUser &secuser, const char *command, StringBuffer &response)
  11215. {
  11216. if (strnicmp(command, "<debug:", 7) == 0 && checkWuSecAccess(wuid, &secmgr, &secuser, SecAccess_Read, "Debug", false, true))
  11217. {
  11218. Owned<IConstWorkUnit> wu = factory->openWorkUnit(wuid, &secmgr, &secuser);
  11219. SCMStringBuffer ip;
  11220. unsigned port;
  11221. port = wu->getDebugAgentListenerPort();
  11222. wu->getDebugAgentListenerIP(ip);
  11223. SocketEndpoint debugEP(ip.str(), port);
  11224. Owned<ISocket> socket = ISocket::connect_timeout(debugEP, 1000);
  11225. unsigned len = (size32_t)strlen(command);
  11226. unsigned revlen = len;
  11227. _WINREV(revlen);
  11228. socket->write(&revlen, sizeof(revlen));
  11229. socket->write(command, len);
  11230. for (;;)
  11231. {
  11232. socket->read(&len, sizeof(len));
  11233. _WINREV(len);
  11234. if (len == 0)
  11235. break;
  11236. if (len & 0x80000000)
  11237. {
  11238. throwUnexpected();
  11239. }
  11240. char * mem = (char*) response.reserve(len);
  11241. socket->read(mem, len);
  11242. }
  11243. return true;
  11244. }
  11245. return false;
  11246. }
  11247. void getSimpleResultType(IWUResult *r, Owned<ITypeInfo> &type)
  11248. {
  11249. TypeInfoArray types;
  11250. StringAttrArray names;
  11251. r->getSchema(types, names, NULL);
  11252. if (types.ordinality()==1)
  11253. type.set(&types.item(0));
  11254. }
  11255. bool isSuppliedParamScalar(IWUResult *r, IPropertyTree &curVal, Owned<ITypeInfo> &type)
  11256. {
  11257. if (!r->isResultScalar())
  11258. return false;
  11259. if (!curVal.hasChildren())
  11260. return true;
  11261. getSimpleResultType(r, type);
  11262. return type && type->isScalar();
  11263. }
  11264. void updateSuppliedXmlParams(IWorkUnit * w)
  11265. {
  11266. Owned<const IPropertyTree> params = w->getXmlParams();
  11267. if (!params)
  11268. return;
  11269. Owned<IPropertyTreeIterator> elems = params->getElements("*");
  11270. ForEach(*elems)
  11271. {
  11272. IPropertyTree & curVal = elems->query();
  11273. const char *name = curVal.queryName();
  11274. Owned<IWUResult> r = updateWorkUnitResult(w, name, -1);
  11275. if (r)
  11276. {
  11277. Owned<ITypeInfo> type;
  11278. StringBuffer s;
  11279. if (isSuppliedParamScalar(r, curVal, type))
  11280. {
  11281. curVal.getProp(".", s);
  11282. r->setResultXML(s);
  11283. r->setResultStatus(ResultStatusSupplied);
  11284. }
  11285. else
  11286. {
  11287. toXML(&curVal, s);
  11288. if (!type)
  11289. getSimpleResultType(r, type);
  11290. bool isSet = (type && type->getTypeCode()==type_set);
  11291. r->setResultRaw(s.length(), s.str(), isSet ? ResultFormatXmlSet : ResultFormatXml);
  11292. }
  11293. }
  11294. else
  11295. DBGLOG("WARNING: no matching variable in workunit for input parameter %s", name);
  11296. }
  11297. }
  11298. IWUResult * updateWorkUnitResult(IWorkUnit * w, const char *name, unsigned sequence)
  11299. {
  11300. switch ((int)sequence)
  11301. {
  11302. case ResultSequenceStored:
  11303. return w->updateVariableByName(name);
  11304. case ResultSequencePersist:
  11305. return w->updateGlobalByName(name);
  11306. case ResultSequenceInternal:
  11307. case ResultSequenceOnce:
  11308. return w->updateTemporaryByName(name);
  11309. default:
  11310. return w->updateResultBySequence(sequence);
  11311. }
  11312. }
  11313. IConstWUResult * getWorkUnitResult(IConstWorkUnit * w, const char *name, unsigned sequence)
  11314. {
  11315. switch ((int)sequence)
  11316. {
  11317. case ResultSequenceStored:
  11318. return w->getVariableByName(name);
  11319. case ResultSequencePersist:
  11320. return w->getGlobalByName(name);
  11321. case ResultSequenceInternal:
  11322. case ResultSequenceOnce:
  11323. return w->getTemporaryByName(name);
  11324. default:
  11325. if (name && name[0])
  11326. return w->getResultByName(name);//name takes precedence over sequence
  11327. else
  11328. return w->getResultBySequence(sequence);
  11329. }
  11330. }
  11331. extern WORKUNIT_API bool getWorkUnitCreateTime(const char *wuid,CDateTime &time)
  11332. {
  11333. if (wuid) {
  11334. char prefchar;
  11335. unsigned year,month,day,hour,min,sec;
  11336. if (sscanf(wuid, "%c%4u%2u%2u-%2u%2u%2u", &prefchar, &year, &month, &day, &hour, &min, &sec)==7) {
  11337. time.set(year, month, day, hour, min, sec, 0, true);
  11338. // time.setDate(year, month, day);
  11339. // time.setTime(hour, min, sec, 0, true); // for some reason time is local
  11340. return true;
  11341. }
  11342. }
  11343. return false;
  11344. }
  11345. extern WORKUNIT_API WUState getWorkUnitState(const char* state)
  11346. {
  11347. return (WUState) getEnum(state, states);
  11348. }
  11349. constexpr LogMsgCategory MCschedconn = MCprogress(1000); // Category used to inform about schedule synchronization
  11350. class CWorkflowScheduleConnection : implements IWorkflowScheduleConnection, public CInterface
  11351. {
  11352. public:
  11353. CWorkflowScheduleConnection(char const * wuid)
  11354. {
  11355. basexpath.append("/WorkflowSchedule/").append(wuid);
  11356. flagxpath.append(basexpath.str()).append("/Active");
  11357. }
  11358. IMPLEMENT_IINTERFACE;
  11359. virtual void lock()
  11360. {
  11361. LOG(MCschedconn, "Locking base schedule connection");
  11362. baseconn.setown(querySDS().connect(basexpath.str(), myProcessSession(), RTM_CREATE_QUERY | RTM_LOCK_WRITE, INFINITE));
  11363. if(!baseconn)
  11364. throw MakeStringException(WUERR_ScheduleLockFailed, "Could not get base workflow schedule lock");
  11365. }
  11366. virtual void unlock()
  11367. {
  11368. LOG(MCschedconn, "Unlocking base schedule connection");
  11369. baseconn.clear();
  11370. }
  11371. virtual void setActive()
  11372. {
  11373. LOG(MCschedconn, "Setting active flag in schedule connection");
  11374. flagconn.setown(querySDS().connect(flagxpath.str(), myProcessSession(), RTM_CREATE | RTM_LOCK_WRITE | RTM_DELETE_ON_DISCONNECT, INFINITE));
  11375. if(!flagconn)
  11376. throw MakeStringException(WUERR_ScheduleLockFailed, "Could not get active workflow schedule lock");
  11377. }
  11378. virtual void resetActive()
  11379. {
  11380. LOG(MCschedconn, "Resetting active flag in schedule connection");
  11381. flagconn.clear();
  11382. }
  11383. virtual bool queryActive()
  11384. {
  11385. return baseconn->queryRoot()->hasProp("Active");
  11386. }
  11387. virtual bool pull(IWorkflowItemArray * workflow)
  11388. {
  11389. assertex(baseconn);
  11390. Owned<IPropertyTree> root = baseconn->getRoot();
  11391. Owned<IPropertyTree> eventQueue = root->getPropTree("EventQueue");
  11392. if(!eventQueue) return false;
  11393. if(!eventQueue->hasProp("Item")) return false;
  11394. {
  11395. Owned<IPropertyTreeIterator> eventItems = eventQueue->getElements("Item");
  11396. Owned<IPropertyTree> eventItem;
  11397. Owned<IRuntimeWorkflowItemIterator> wfItems = workflow->getSequenceIterator();
  11398. Owned<IRuntimeWorkflowItem> wfItem;
  11399. for(eventItems->first(); eventItems->isValid(); eventItems->next())
  11400. {
  11401. eventItem.setown(&eventItems->get());
  11402. const char * eventName = eventItem->queryProp("@name");
  11403. const char * eventText = eventItem->queryProp("@text");
  11404. for(wfItems->first(); wfItems->isValid(); wfItems->next())
  11405. {
  11406. wfItem.setown(wfItems->get());
  11407. if(wfItem->queryState() != WFStateWait)
  11408. continue;
  11409. Owned<IWorkflowEvent> targetEvent = wfItem->getScheduleEvent();
  11410. if(!targetEvent || !targetEvent->matches(eventName, eventText))
  11411. continue;
  11412. wfItem->setEvent(eventName, eventText);
  11413. wfItem->setState(WFStateReqd);
  11414. resetDependentsState(workflow, *wfItem);
  11415. }
  11416. }
  11417. }
  11418. bool more;
  11419. do
  11420. more = eventQueue->removeProp("Item");
  11421. while(more);
  11422. return true;
  11423. }
  11424. virtual void push(char const * name, char const * text)
  11425. {
  11426. assertex(baseconn);
  11427. Owned<IPropertyTree> root = baseconn->getRoot();
  11428. IPropertyTree *eventQueue = ensurePTree(root, "EventQueue");
  11429. IPropertyTree *eventItem = eventQueue->addPropTree("Item");
  11430. eventItem->setProp("@name", name);
  11431. eventItem->setProp("@text", text);
  11432. }
  11433. virtual void remove()
  11434. {
  11435. if (baseconn)
  11436. {
  11437. baseconn->close(true);
  11438. baseconn.clear();
  11439. }
  11440. }
  11441. private:
  11442. void resetItemStateAndDependents(IWorkflowItemArray * workflow, unsigned wfid) const
  11443. {
  11444. if (wfid)
  11445. resetItemStateAndDependents(workflow, workflow->queryWfid(wfid));
  11446. }
  11447. void resetItemStateAndDependents(IWorkflowItemArray * workflow, IRuntimeWorkflowItem & item) const
  11448. {
  11449. switch(item.queryState())
  11450. {
  11451. case WFStateDone:
  11452. case WFStateFail:
  11453. {
  11454. item.setState(WFStateNull);
  11455. resetItemStateAndDependents(workflow, item.queryPersistWfid());
  11456. resetDependentsState(workflow, item);
  11457. break;
  11458. }
  11459. }
  11460. }
  11461. void resetDependentsState(IWorkflowItemArray * workflow, IRuntimeWorkflowItem & item) const
  11462. {
  11463. Owned<IWorkflowDependencyIterator> iter(item.getDependencies());
  11464. for(iter->first(); iter->isValid(); iter->next())
  11465. {
  11466. IRuntimeWorkflowItem & dep = workflow->queryWfid(iter->query());
  11467. resetItemStateAndDependents(workflow, dep);
  11468. }
  11469. }
  11470. private:
  11471. StringBuffer basexpath;
  11472. StringBuffer flagxpath;
  11473. Owned<IRemoteConnection> baseconn;
  11474. Owned<IRemoteConnection> flagconn;
  11475. };
  11476. extern WORKUNIT_API IWorkflowScheduleConnection * getWorkflowScheduleConnection(char const * wuid)
  11477. {
  11478. return new CWorkflowScheduleConnection(wuid);
  11479. }
  11480. extern WORKUNIT_API IExtendedWUInterface * queryExtendedWU(IConstWorkUnit * wu)
  11481. {
  11482. return QUERYINTERFACE(wu, IExtendedWUInterface);
  11483. }
  11484. extern WORKUNIT_API const IExtendedWUInterface * queryExtendedWU(const IConstWorkUnit * wu)
  11485. {
  11486. return QUERYINTERFACE(wu, const IExtendedWUInterface);
  11487. }
  11488. extern WORKUNIT_API void addExceptionToWorkunit(IWorkUnit * wu, ErrorSeverity severity, const char * source, unsigned code, const char * text, const char * filename, unsigned lineno, unsigned column, unsigned activity)
  11489. {
  11490. Owned<IWUException> we = wu->createException();
  11491. we->setSeverity(severity);
  11492. we->setExceptionMessage(text);
  11493. if (source)
  11494. we->setExceptionSource(source);
  11495. if (code)
  11496. we->setExceptionCode(code);
  11497. if (filename)
  11498. we->setExceptionFileName(filename);
  11499. if (lineno)
  11500. {
  11501. we->setExceptionLineNo(lineno);
  11502. if (column)
  11503. we->setExceptionColumn(lineno);
  11504. }
  11505. if (activity)
  11506. we->setActivityId(activity);
  11507. }
  11508. const char * skipLeadingXml(const char * text)
  11509. {
  11510. if (!text)
  11511. return NULL;
  11512. //skip utf8 BOM, probably excessive
  11513. if (memcmp(text, UTF8_BOM, 3) == 0)
  11514. text += 3;
  11515. for (;;)
  11516. {
  11517. if (isspace(*text))
  11518. text++;
  11519. else if (text[0] == '<' && text[1] == '?')
  11520. {
  11521. text += 2;
  11522. for (;;)
  11523. {
  11524. if (!*text) break;
  11525. if (text[0] == '?' && text[1] == '>')
  11526. {
  11527. text += 2;
  11528. break;
  11529. }
  11530. text++;
  11531. }
  11532. }
  11533. else if (text[0] == '<' && text[1] == '!' && text[2] == '-' && text[3] == '-')
  11534. {
  11535. text += 4;
  11536. for (;;)
  11537. {
  11538. if (!*text) break;
  11539. if (text[0] == '-' && text[1] == '-' && text[2] == '>')
  11540. {
  11541. text += 3;
  11542. break;
  11543. }
  11544. text++;
  11545. }
  11546. }
  11547. else
  11548. break;
  11549. }
  11550. return text;
  11551. }
  11552. extern WORKUNIT_API bool isArchiveQuery(const char * text)
  11553. {
  11554. text = skipLeadingXml(text);
  11555. if (!text)
  11556. return false;
  11557. const char * archivePrefix = "<Archive";
  11558. return memicmp(text, archivePrefix, strlen(archivePrefix)) == 0;
  11559. }
  11560. extern WORKUNIT_API bool isQueryManifest(const char * text)
  11561. {
  11562. text = skipLeadingXml(text);
  11563. if (!text)
  11564. return false;
  11565. const char * manifestPrefix = "<Manifest";
  11566. return memicmp(text, manifestPrefix, strlen(manifestPrefix)) == 0;
  11567. }
  11568. //------------------------------------------------------------------------------
  11569. // Named Alias helper function
  11570. static IPropertyTree * resolveQueryByDll(IPropertyTree * queryRegistry, const char * dll)
  11571. {
  11572. StringBuffer xpath;
  11573. xpath.append("Query[@dll=\"").append(dll).append("\"]");
  11574. return queryRegistry->getPropTree(xpath);
  11575. }
  11576. static IPropertyTree * resolveQueryByWuid(IPropertyTree * queryRegistry, const char * wuid)
  11577. {
  11578. StringBuffer xpath;
  11579. xpath.append("Query[@wuid=\"").append(wuid).append("\"]");
  11580. return queryRegistry->getPropTree(xpath);
  11581. }
  11582. static void clearAliases(IPropertyTree * queryRegistry, const char * id)
  11583. {
  11584. StringBuffer lcId(id);
  11585. lcId.toLowerCase();
  11586. StringBuffer xpath;
  11587. xpath.append("Alias[@id=\"").append(lcId).append("\"]");
  11588. Owned<IPropertyTreeIterator> iter = queryRegistry->getElements(xpath);
  11589. ForEach(*iter)
  11590. {
  11591. queryRegistry->removeProp(xpath.str());
  11592. }
  11593. }
  11594. IPropertyTree * addNamedQuery(IPropertyTree * queryRegistry, const char * name, const char * wuid, const char * dll, bool library, const char *userid, const char *snapshot)
  11595. {
  11596. StringBuffer lcName(name);
  11597. lcName.toLowerCase();
  11598. StringBuffer xpath;
  11599. xpath.append("Query[@name=\"").append(lcName.str()).append("\"]");
  11600. Owned<IPropertyTreeIterator> iter = queryRegistry->getElements(xpath);
  11601. unsigned seq = 1;
  11602. ForEach(*iter)
  11603. {
  11604. IPropertyTree &item = iter->query();
  11605. const char *thisWuid = item.queryProp("@wuid");
  11606. if (strieq(wuid, thisWuid))
  11607. return &item;
  11608. unsigned thisSeq = item.getPropInt("@seq");
  11609. if (thisSeq >= seq)
  11610. seq = thisSeq + 1;
  11611. }
  11612. StringBuffer id;
  11613. id.append(lcName).append(".").append(seq);
  11614. IPropertyTree * newEntry = createPTree("Query", ipt_caseInsensitive|ipt_lowmem);
  11615. newEntry->setProp("@name", lcName);
  11616. newEntry->setProp("@wuid", wuid);
  11617. newEntry->setProp("@dll", dll);
  11618. newEntry->setProp("@id", id);
  11619. newEntry->setPropInt("@seq", seq);
  11620. if (library)
  11621. newEntry->setPropBool("@isLibrary", true);
  11622. if (userid && *userid)
  11623. newEntry->setProp("@publishedBy", userid);
  11624. if (snapshot && *snapshot)
  11625. newEntry->setProp("@snapshot", snapshot);
  11626. return queryRegistry->addPropTree("Query", newEntry);
  11627. }
  11628. void removeNamedQuery(IPropertyTree * queryRegistry, const char * id)
  11629. {
  11630. StringBuffer lcId(id);
  11631. lcId.toLowerCase();
  11632. clearAliases(queryRegistry, lcId);
  11633. StringBuffer xpath;
  11634. xpath.append("Query[@id=\"").append(lcId).append("\"]");
  11635. queryRegistry->removeProp(xpath);
  11636. }
  11637. void removeDllFromNamedQueries(IPropertyTree * queryRegistry, const char * dll)
  11638. {
  11639. Owned<IPropertyTree> match = resolveQueryByDll(queryRegistry, dll);
  11640. if (!match)
  11641. return;
  11642. clearAliases(queryRegistry, match->queryProp("@id"));
  11643. queryRegistry->removeTree(match);
  11644. }
  11645. void removeWuidFromNamedQueries(IPropertyTree * queryRegistry, const char * wuid)
  11646. {
  11647. Owned<IPropertyTree> match = resolveQueryByWuid(queryRegistry, wuid);
  11648. if (!match)
  11649. return;
  11650. clearAliases(queryRegistry, match->queryProp("@id"));
  11651. queryRegistry->removeTree(match);
  11652. }
  11653. void removeAliasesFromNamedQuery(IPropertyTree * queryRegistry, const char * id)
  11654. {
  11655. clearAliases(queryRegistry, id);
  11656. }
  11657. void setQueryAlias(IPropertyTree * queryRegistry, const char * name, const char * value)
  11658. {
  11659. StringBuffer lcName(name);
  11660. lcName.toLowerCase();
  11661. StringBuffer xpath;
  11662. xpath.append("Alias[@name=\"").append(lcName).append("\"]");
  11663. IPropertyTree * match = queryRegistry->queryPropTree(xpath);
  11664. if (!match)
  11665. {
  11666. match = queryRegistry->addPropTree("Alias");
  11667. match->setProp("@name", lcName);
  11668. }
  11669. match->setProp("@id", value);
  11670. }
  11671. extern WORKUNIT_API IPropertyTree * getQueryById(IPropertyTree * queryRegistry, const char *queryid)
  11672. {
  11673. if (!queryRegistry || !queryid)
  11674. return NULL;
  11675. StringBuffer xpath;
  11676. xpath.append("Query[@id=\"").append(queryid).append("\"]");
  11677. return queryRegistry->getPropTree(xpath);
  11678. }
  11679. extern WORKUNIT_API IPropertyTree * getQueryById(const char *queryset, const char *queryid, bool readonly)
  11680. {
  11681. Owned<IPropertyTree> queryRegistry = getQueryRegistry(queryset, readonly);
  11682. return getQueryById(queryRegistry, queryid);
  11683. }
  11684. extern WORKUNIT_API IPropertyTree * resolveQueryAlias(IPropertyTree * queryRegistry, const char * alias)
  11685. {
  11686. if (!queryRegistry || !alias)
  11687. return NULL;
  11688. StringBuffer xpath;
  11689. unsigned cnt = 0;
  11690. StringBuffer lc(alias);
  11691. const char * search = lc.toLowerCase().str();
  11692. for (;;)
  11693. {
  11694. xpath.set("Alias[@name='").append(search).append("']/@id");
  11695. const char * queryId = queryRegistry->queryProp(xpath);
  11696. if (!queryId)
  11697. break;
  11698. //Check for too many alias indirections.
  11699. if (cnt++ > 10)
  11700. return NULL;
  11701. search = lc.set(queryId).toLowerCase().str();
  11702. }
  11703. return getQueryById(queryRegistry, search);
  11704. }
  11705. extern WORKUNIT_API IPropertyTree * resolveQueryAlias(const char *queryset, const char *alias, bool readonly)
  11706. {
  11707. Owned<IPropertyTree> queryRegistry = getQueryRegistry(queryset, readonly);
  11708. return resolveQueryAlias(queryRegistry, alias);
  11709. }
  11710. void setQuerySuspendedState(IPropertyTree * queryRegistry, const char *id, bool suspend, const char *userid)
  11711. {
  11712. StringBuffer lcId(id);
  11713. lcId.toLowerCase();
  11714. StringBuffer xpath;
  11715. xpath.append("Query[@id=\"").append(lcId).append("\"]");
  11716. IPropertyTree *tree = queryRegistry->queryPropTree(xpath);
  11717. if (tree)
  11718. {
  11719. if (tree->getPropBool("@suspended", false) == suspend)
  11720. return;
  11721. if (suspend)
  11722. {
  11723. tree->addPropBool("@suspended", true);
  11724. if (userid && *userid)
  11725. tree->addProp("@suspendedBy", userid);
  11726. }
  11727. else
  11728. {
  11729. tree->removeProp("@suspended");
  11730. tree->removeProp("@suspendedBy");
  11731. }
  11732. }
  11733. else
  11734. throw MakeStringException((suspend)? QUERRREG_SUSPEND : QUERRREG_UNSUSPEND, "Modifying query suspended state failed. Could not find query %s", id);
  11735. }
  11736. void setQueryCommentForNamedQuery(IPropertyTree * queryRegistry, const char *id, const char *queryComment)
  11737. {
  11738. if (queryComment)
  11739. {
  11740. StringBuffer lcId(id);
  11741. lcId.toLowerCase();
  11742. StringBuffer xpath;
  11743. xpath.append("Query[@id=\"").append(lcId).append("\"]");
  11744. IPropertyTree *tree = queryRegistry->queryPropTree(xpath);
  11745. if (tree)
  11746. tree->setProp("@queryComment", queryComment);
  11747. else
  11748. throw MakeStringException(QUERRREG_COMMENT, "Could not find query %s", id);
  11749. }
  11750. }
  11751. extern WORKUNIT_API IPropertyTree * getQueryRegistryRoot()
  11752. {
  11753. Owned<IRemoteConnection> conn = querySDS().connect("/QuerySets", myProcessSession(), RTM_LOCK_READ, SDS_LOCK_TIMEOUT);
  11754. if (conn)
  11755. return conn->getRoot();
  11756. else
  11757. return NULL;
  11758. }
  11759. extern WORKUNIT_API void checkAddLibrariesToQueryEntry(IPropertyTree *queryTree, IConstWULibraryIterator *libraries)
  11760. {
  11761. if (!queryTree || !libraries)
  11762. return;
  11763. if (queryTree->hasProp("@libCount")) //already added
  11764. return;
  11765. unsigned libCount=0;
  11766. ForEach(*libraries)
  11767. {
  11768. IConstWULibrary &library = libraries->query();
  11769. SCMStringBuffer libname;
  11770. if (!library.getName(libname).length())
  11771. continue;
  11772. queryTree->addProp("Library", libname.str());
  11773. libCount++;
  11774. }
  11775. queryTree->setPropInt("@libCount", libCount);
  11776. }
  11777. extern WORKUNIT_API void checkAddLibrariesToQueryEntry(IPropertyTree *queryTree, IConstWorkUnit *cw)
  11778. {
  11779. Owned<IConstWULibraryIterator> libraries = &cw->getLibraries();
  11780. checkAddLibrariesToQueryEntry(queryTree, libraries);
  11781. }
  11782. extern WORKUNIT_API IPropertyTree * getQueryRegistry(const char * wsEclId, bool readonly)
  11783. {
  11784. //Only lock the branch for the target we're interested in.
  11785. StringBuffer xpath;
  11786. xpath.append("/QuerySets/QuerySet[@id=\"").append(wsEclId).append("\"]");
  11787. Owned<IRemoteConnection> conn = querySDS().connect(xpath.str(), myProcessSession(), readonly ? RTM_LOCK_READ : RTM_LOCK_WRITE, SDS_LOCK_TIMEOUT);
  11788. if (conn)
  11789. return conn->getRoot();
  11790. if (readonly)
  11791. return NULL;
  11792. //Lock the QuerySets in case another thread/client wants to check/add the same QuerySet.
  11793. Owned<IRemoteConnection> globalLock = querySDS().connect("/QuerySets/", myProcessSession(), RTM_LOCK_WRITE|RTM_CREATE_QUERY, SDS_LOCK_TIMEOUT);
  11794. //Re-check if the QuerySet has been added between checking the 1st time and gaining the globalLock.
  11795. conn.setown(querySDS().connect(xpath.str(), myProcessSession(), RTM_LOCK_WRITE, SDS_LOCK_TIMEOUT));
  11796. if (conn)
  11797. return conn->getRoot();
  11798. conn.setown(querySDS().connect("/QuerySets/QuerySet", myProcessSession(), RTM_LOCK_WRITE|RTM_CREATE_ADD, SDS_LOCK_TIMEOUT));
  11799. if (!conn)
  11800. throwUnexpected();
  11801. IPropertyTree * root = conn->queryRoot();
  11802. root->setProp("@id",wsEclId);
  11803. conn->commit();
  11804. return LINK(root);
  11805. }
  11806. IPropertyTree * addNamedPackageSet(IPropertyTree * packageRegistry, const char * name, IPropertyTree *packageInfo, bool overWrite)
  11807. {
  11808. StringBuffer xpath;
  11809. StringBuffer lcName(name);
  11810. lcName.toLowerCase();
  11811. // see if "name" already exists
  11812. xpath.append("Package[@id='").append(name).append("']");
  11813. IPropertyTree *pkgTree = packageRegistry->queryPropTree(xpath.str());
  11814. if (pkgTree)
  11815. {
  11816. if (overWrite)
  11817. packageRegistry->removeTree(pkgTree);
  11818. else
  11819. throw MakeStringException(WUERR_PackageAlreadyExists, "Package name %s already exists, either delete it or specify overwrite",name);
  11820. }
  11821. IPropertyTree *tree = packageRegistry->addPropTree("Package", packageInfo);
  11822. tree->setProp("@id", lcName);
  11823. return tree;
  11824. }
  11825. void removeNamedPackage(IPropertyTree * packageRegistry, const char * id)
  11826. {
  11827. StringBuffer lcId(id);
  11828. lcId.toLowerCase();
  11829. StringBuffer xpath;
  11830. xpath.append("Package[@id=\"").append(lcId).append("\"]");
  11831. packageRegistry->removeProp(xpath);
  11832. }
  11833. extern WORKUNIT_API IPropertyTree * getPackageSetRegistry(const char * wsEclId, bool readonly)
  11834. {
  11835. //Only lock the branch for the target we're interested in.
  11836. StringBuffer xpath;
  11837. xpath.append("/PackageSets/PackageSet[@id=\"").append(wsEclId).append("\"]");
  11838. Owned<IRemoteConnection> conn = querySDS().connect(xpath.str(), myProcessSession(), readonly ? RTM_LOCK_READ : RTM_LOCK_WRITE, SDS_LOCK_TIMEOUT);
  11839. if (conn)
  11840. return conn->getRoot();
  11841. if (readonly)
  11842. return NULL;
  11843. //Lock the PackageSets in case another thread/client wants to check/add the same PackageSet.
  11844. Owned<IRemoteConnection> globalLock = querySDS().connect("/PackageSets/", myProcessSession(), RTM_LOCK_WRITE|RTM_CREATE_QUERY, SDS_LOCK_TIMEOUT);
  11845. //Re-check if the PackageSet has been added between checking the 1st time and gaining the globalLock.
  11846. conn.setown(querySDS().connect(xpath.str(), myProcessSession(), RTM_LOCK_WRITE, SDS_LOCK_TIMEOUT));
  11847. if (conn)
  11848. return conn->getRoot();
  11849. conn.setown(querySDS().connect("/PackageSets/PackageSet", myProcessSession(), RTM_LOCK_WRITE|RTM_CREATE_ADD, SDS_LOCK_TIMEOUT));
  11850. if (!conn)
  11851. throwUnexpected();
  11852. IPropertyTree* root = conn->queryRoot();
  11853. root->setProp("@id",wsEclId);
  11854. conn->commit();
  11855. return LINK(root);
  11856. }
  11857. void addQueryToQuerySet(IWorkUnit *workunit, IPropertyTree *queryRegistry, const char *queryName, WUQueryActivationOptions activateOption, StringBuffer &newQueryId, const char *userid)
  11858. {
  11859. StringBuffer cleanQueryName;
  11860. appendUtf8XmlName(cleanQueryName, strlen(queryName), queryName);
  11861. SCMStringBuffer dllName;
  11862. Owned<IConstWUQuery> q = workunit->getQuery();
  11863. q->getQueryDllName(dllName);
  11864. if (!dllName.length())
  11865. throw MakeStringException(WUERR_InvalidDll, "Cannot deploy query - no associated dll.");
  11866. StringBuffer currentTargetClusterType;
  11867. queryRegistry->getProp("@targetclustertype", currentTargetClusterType);
  11868. SCMStringBuffer targetClusterType;
  11869. workunit->getDebugValue("targetclustertype", targetClusterType);
  11870. SCMStringBuffer snapshot;
  11871. workunit->getSnapshot(snapshot);
  11872. if (currentTargetClusterType.length() < 1)
  11873. {
  11874. queryRegistry->setProp("@targetclustertype", targetClusterType.str());
  11875. }
  11876. else
  11877. {
  11878. if (strcmp(currentTargetClusterType.str(), "roxie") == 0 && strcmp(currentTargetClusterType.str(), targetClusterType.str())!=0)
  11879. {
  11880. throw MakeStringException(WUERR_MismatchClusterType, "TargetClusterTypes of workunit and queryset do not match.");
  11881. }
  11882. }
  11883. IPropertyTree *newEntry = addNamedQuery(queryRegistry, cleanQueryName, workunit->queryWuid(), dllName.str(), isLibrary(workunit), userid, snapshot.str());
  11884. Owned<IConstWULibraryIterator> libraries = &workunit->getLibraries();
  11885. checkAddLibrariesToQueryEntry(newEntry, libraries);
  11886. newQueryId.append(newEntry->queryProp("@id"));
  11887. workunit->setIsQueryService(true); //will check querysets before delete
  11888. workunit->commit();
  11889. activateQuery(queryRegistry, activateOption, queryName, newQueryId, userid);
  11890. }
  11891. void activateQuery(IPropertyTree *queryRegistry, WUQueryActivationOptions activateOption, const char *queryName, const char *queryId, const char *userid)
  11892. {
  11893. StringBuffer cleanQueryName;
  11894. appendUtf8XmlName(cleanQueryName, strlen(queryName), queryName);
  11895. if (activateOption == ACTIVATE_SUSPEND_PREVIOUS|| activateOption == ACTIVATE_DELETE_PREVIOUS)
  11896. {
  11897. Owned<IPropertyTree> prevQuery = resolveQueryAlias(queryRegistry, cleanQueryName);
  11898. setQueryAlias(queryRegistry, cleanQueryName, queryId);
  11899. if (prevQuery && !streq(queryId, prevQuery->queryProp("@id")))
  11900. {
  11901. if (activateOption == ACTIVATE_SUSPEND_PREVIOUS)
  11902. setQuerySuspendedState(queryRegistry, prevQuery->queryProp("@id"), true, userid);
  11903. else
  11904. removeNamedQuery(queryRegistry, prevQuery->queryProp("@id"));
  11905. }
  11906. }
  11907. else if (activateOption == MAKE_ACTIVATE || activateOption == MAKE_ACTIVATE_LOAD_DATA_ONLY)
  11908. setQueryAlias(queryRegistry, cleanQueryName, queryId);
  11909. }
  11910. void addQueryToQuerySet(IWorkUnit *workunit, const char *querySetName, const char *queryName, WUQueryActivationOptions activateOption, StringBuffer &newQueryId, const char *userid)
  11911. {
  11912. Owned<IPropertyTree> queryRegistry = getQueryRegistry(querySetName, false);
  11913. addQueryToQuerySet(workunit, queryRegistry, queryName, activateOption, newQueryId, userid);
  11914. }
  11915. bool removeQuerySetAlias(const char *querySetName, const char *alias)
  11916. {
  11917. Owned<IPropertyTree> queryRegistry = getQueryRegistry(querySetName, true);
  11918. StringBuffer xpath;
  11919. xpath.appendf("Alias[@name='%s']", alias);
  11920. IPropertyTree *t = queryRegistry->queryPropTree(xpath);
  11921. return queryRegistry->removeTree(t);
  11922. }
  11923. void addQuerySetAlias(const char *querySetName, const char *alias, const char *id)
  11924. {
  11925. Owned<IPropertyTree> queryRegistry = getQueryRegistry(querySetName, false);
  11926. setQueryAlias(queryRegistry, alias, id);
  11927. }
  11928. void setSuspendQuerySetQuery(const char *querySetName, const char *id, bool suspend, const char *userid)
  11929. {
  11930. Owned<IPropertyTree> queryRegistry = getQueryRegistry(querySetName, true);
  11931. setQuerySuspendedState(queryRegistry, id, suspend, userid);
  11932. }
  11933. void deleteQuerySetQuery(const char *querySetName, const char *id)
  11934. {
  11935. Owned<IPropertyTree> queryRegistry = getQueryRegistry(querySetName, true);
  11936. removeNamedQuery(queryRegistry, id);
  11937. }
  11938. void removeQuerySetAliasesFromNamedQuery(const char *querySetName, const char * id)
  11939. {
  11940. Owned<IPropertyTree> queryRegistry = getQueryRegistry(querySetName, true);
  11941. clearAliases(queryRegistry, id);
  11942. }
  11943. void setQueryCommentForNamedQuery(const char *querySetName, const char *id, const char *queryComment)
  11944. {
  11945. Owned<IPropertyTree> queryRegistry = getQueryRegistry(querySetName, true);
  11946. setQueryCommentForNamedQuery(queryRegistry, id, queryComment);
  11947. }
  11948. const char *queryIdFromQuerySetWuid(IPropertyTree *queryRegistry, const char *wuid, const char *queryName, IStringVal &id)
  11949. {
  11950. if (!queryRegistry)
  11951. return NULL;
  11952. StringBuffer xpath;
  11953. xpath.appendf("Query[@wuid='%s']", wuid);
  11954. if (queryName && *queryName)
  11955. xpath.appendf("[@name='%s']", queryName);
  11956. IPropertyTree *q = queryRegistry->queryPropTree(xpath.str());
  11957. if (q)
  11958. {
  11959. id.set(q->queryProp("@id"));
  11960. }
  11961. return id.str();
  11962. }
  11963. const char *queryIdFromQuerySetWuid(const char *querySetName, const char *wuid, const char *queryName, IStringVal &id)
  11964. {
  11965. Owned<IPropertyTree> queryRegistry = getQueryRegistry(querySetName, true);
  11966. return queryIdFromQuerySetWuid(queryRegistry, wuid, queryName, id);
  11967. }
  11968. extern WORKUNIT_API void gatherLibraryNames(StringArray &names, StringArray &unresolved, IWorkUnitFactory &workunitFactory, IConstWorkUnit &cw, IPropertyTree *queryset)
  11969. {
  11970. Owned<IConstWULibraryIterator> wulibraries = &cw.getLibraries();
  11971. ForEach(*wulibraries)
  11972. {
  11973. SCMStringBuffer libname;
  11974. IConstWULibrary &wulibrary = wulibraries->query();
  11975. wulibrary.getName(libname);
  11976. if (names.contains(libname.str()) || unresolved.contains(libname.str()))
  11977. continue;
  11978. Owned<IPropertyTree> query = resolveQueryAlias(queryset, libname.str());
  11979. if (query && query->getPropBool("@isLibrary"))
  11980. {
  11981. const char *wuid = query->queryProp("@wuid");
  11982. Owned<IConstWorkUnit> libcw = workunitFactory.openWorkUnit(wuid);
  11983. if (libcw)
  11984. {
  11985. names.appendUniq(libname.str());
  11986. gatherLibraryNames(names, unresolved, workunitFactory, *libcw, queryset);
  11987. continue;
  11988. }
  11989. }
  11990. unresolved.appendUniq(libname.str());
  11991. }
  11992. }
  11993. bool looksLikeAWuid(const char * wuid, const char firstChar)
  11994. {
  11995. if (!wuid)
  11996. return false;
  11997. if (wuid[0] != firstChar)
  11998. return false;
  11999. if (!isdigit(wuid[1]) || !isdigit(wuid[2]) || !isdigit(wuid[3]) || !isdigit(wuid[4]))
  12000. return false;
  12001. if (!isdigit(wuid[5]) || !isdigit(wuid[6]) || !isdigit(wuid[7]) || !isdigit(wuid[8]))
  12002. return false;
  12003. return (wuid[9]=='-');
  12004. }
  12005. IPropertyTree * resolveDefinitionInArchive(IPropertyTree * archive, const char * path)
  12006. {
  12007. IPropertyTree * module = archive;
  12008. const char * dot = strrchr(path, '.');
  12009. StringBuffer xpath;
  12010. if (dot)
  12011. {
  12012. xpath.clear().append("Module[@key='").appendLower(dot-path, path).append("']");
  12013. module = archive->queryPropTree(xpath);
  12014. path = dot+1;
  12015. }
  12016. else
  12017. module = archive->queryPropTree("Module[@key='']");
  12018. if (!module)
  12019. return NULL;
  12020. xpath.clear().append("Attribute[@key='").appendLower(strlen(path), path).append("']");
  12021. return module->queryPropTree(xpath);
  12022. }
  12023. extern WORKUNIT_API void associateLocalFile(IWUQuery * query, WUFileType type, const char * name, const char * description, unsigned crc, unsigned minActivity, unsigned maxActivity)
  12024. {
  12025. StringBuffer hostname;
  12026. queryHostIP().getIpText(hostname);
  12027. StringBuffer fullPathname;
  12028. makeAbsolutePath(name, fullPathname);
  12029. query->addAssociatedFile(type, fullPathname, hostname, description, crc, minActivity, maxActivity);
  12030. }
  12031. extern WORKUNIT_API void descheduleWorkunit(char const * wuid)
  12032. {
  12033. Owned<IWorkUnitFactory> factory = getWorkUnitFactory();
  12034. Owned<IWorkUnit> workunit = factory->updateWorkUnit(wuid);
  12035. if(workunit)
  12036. workunit->deschedule();
  12037. else
  12038. doDescheduleWorkkunit(wuid);
  12039. }
  12040. extern WORKUNIT_API void updateWorkunitStat(IWorkUnit * wu, StatisticScopeType scopeType, const char * scope, StatisticKind kind, const char * description, unsigned __int64 value, unsigned wfid)
  12041. {
  12042. StringBuffer scopestr;
  12043. if (wfid && scope && *scope)
  12044. scopestr.append(WorkflowScopePrefix).append(wfid).append(":").append(scope);
  12045. else
  12046. scopestr.set(scope);
  12047. wu->setStatistic(queryStatisticsComponentType(), queryStatisticsComponentName(), scopeType, scopestr, kind, description, value, 1, 0, StatsMergeReplace);
  12048. }
  12049. class WuTimingUpdater : implements ITimeReportInfo
  12050. {
  12051. public:
  12052. WuTimingUpdater(IWorkUnit * _wu, StatisticScopeType _scopeType, StatisticKind _kind)
  12053. : wu(_wu), scopeType(_scopeType), kind(_kind)
  12054. { }
  12055. virtual void report(const char * scope, const __int64 totaltime, const __int64 maxtime, const unsigned count)
  12056. {
  12057. wu->setStatistic(queryStatisticsComponentType(), queryStatisticsComponentName(), scopeType, scope, kind, nullptr, totaltime, count, maxtime, StatsMergeReplace);
  12058. }
  12059. protected:
  12060. IWorkUnit * wu;
  12061. StatisticScopeType scopeType;
  12062. StatisticKind kind;
  12063. };
  12064. extern WORKUNIT_API void updateWorkunitTimings(IWorkUnit * wu, ITimeReporter *timer)
  12065. {
  12066. WuTimingUpdater target(wu, SSTsection, StTimeTotalExecute);
  12067. timer->report(target);
  12068. }
  12069. extern WORKUNIT_API void updateWorkunitTimings(IWorkUnit * wu, StatisticScopeType scopeType, StatisticKind kind, ITimeReporter *timer)
  12070. {
  12071. WuTimingUpdater target(wu, scopeType, kind);
  12072. timer->report(target);
  12073. }
  12074. extern WORKUNIT_API void addTimeStamp(IWorkUnit * wu, StatisticScopeType scopeType, const char * scope, StatisticKind kind, unsigned wfid)
  12075. {
  12076. StringBuffer scopestr;
  12077. if (wfid && scope && *scope)
  12078. scopestr.append(WorkflowScopePrefix).append(wfid).append(":").append(scope);
  12079. else
  12080. scopestr.set(scope);
  12081. wu->setStatistic(queryStatisticsComponentType(), queryStatisticsComponentName(), scopeType, scopestr, kind, NULL, getTimeStampNowValue(), 1, 0, StatsMergeAppend);
  12082. }
  12083. void aggregateStatistic(StatsAggregation & result, IConstWorkUnit * wu, const WuScopeFilter & filter, StatisticKind search)
  12084. {
  12085. SimpleReferenceAggregator aggregator(search, result);
  12086. Owned<IConstWUScopeIterator> it = &wu->getScopeIterator(filter);
  12087. ForEach(*it)
  12088. it->playProperties(aggregator);
  12089. }
  12090. class GlobalStatisticGatherer : public CInterfaceOf<IStatisticGatherer>
  12091. {
  12092. public:
  12093. GlobalStatisticGatherer(IWorkUnit * _wu) : wu(_wu) {}
  12094. virtual void beginScope(const StatsScopeId & id)
  12095. {
  12096. prevLenStack.append(scope.length());
  12097. if (scope.length())
  12098. scope.append(":");
  12099. id.getScopeText(scope);
  12100. scopeTypeStack.append(id.queryScopeType());
  12101. }
  12102. virtual void beginSubGraphScope(unsigned id)
  12103. {
  12104. StatsScopeId scopeId(SSTsubgraph, id);
  12105. beginScope(scopeId);
  12106. }
  12107. virtual void beginActivityScope(unsigned id)
  12108. {
  12109. StatsScopeId scopeId(SSTactivity, id);
  12110. beginScope(scopeId);
  12111. }
  12112. virtual void beginEdgeScope(unsigned id, unsigned oid)
  12113. {
  12114. StatsScopeId scopeId(SSTedge, id, oid);
  12115. beginScope(scopeId);
  12116. }
  12117. virtual void beginChildGraphScope(unsigned id)
  12118. {
  12119. StatsScopeId scopeId(SSTchildgraph, id);
  12120. beginScope(scopeId);
  12121. }
  12122. virtual void endScope()
  12123. {
  12124. scope.setLength(prevLenStack.popGet());
  12125. scopeTypeStack.pop();
  12126. }
  12127. virtual void addStatistic(StatisticKind kind, unsigned __int64 value)
  12128. {
  12129. StatisticScopeType scopeType = scopeTypeStack.ordinality() ? (StatisticScopeType)scopeTypeStack.tos() : SSTglobal;
  12130. wu->setStatistic(queryStatisticsComponentType(), queryStatisticsComponentName(), scopeType, scope, kind, NULL, value, 1, 0, StatsMergeAppend);
  12131. }
  12132. virtual void updateStatistic(StatisticKind kind, unsigned __int64 value, StatsMergeAction mergeAction)
  12133. {
  12134. StatisticScopeType scopeType = scopeTypeStack.ordinality() ? (StatisticScopeType)scopeTypeStack.tos() : SSTglobal;
  12135. wu->setStatistic(queryStatisticsComponentType(), queryStatisticsComponentName(), scopeType, scope, kind, NULL, value, 1, 0, mergeAction);
  12136. }
  12137. virtual IStatisticCollection * getResult()
  12138. {
  12139. return NULL;
  12140. }
  12141. protected:
  12142. Linked<IWorkUnit> wu;
  12143. StringBuffer scope;
  12144. UnsignedArray prevLenStack;
  12145. UnsignedArray scopeTypeStack;
  12146. };
  12147. IStatisticGatherer * createGlobalStatisticGatherer(IWorkUnit * wu)
  12148. {
  12149. return new GlobalStatisticGatherer(wu);
  12150. }
  12151. extern WORKUNIT_API IPropertyTree * getWUGraphProgress(const char * wuid, bool readonly)
  12152. {
  12153. if (!wuid || !*wuid)
  12154. return NULL;
  12155. VStringBuffer path("/GraphProgress/%s", wuid);
  12156. Owned<IRemoteConnection> conn = querySDS().connect(path.str(),myProcessSession(),readonly ? RTM_LOCK_READ : RTM_LOCK_WRITE, SDS_LOCK_TIMEOUT);
  12157. if (conn)
  12158. return conn->getRoot();
  12159. else
  12160. return NULL;
  12161. }
  12162. void addWorkunitException(IWorkUnit * wu, IError * error, bool removeTimeStamp)
  12163. {
  12164. ErrorSeverity wuSeverity = SeverityInformation;
  12165. ErrorSeverity severity = error->getSeverity();
  12166. switch (severity)
  12167. {
  12168. case SeverityIgnore:
  12169. return;
  12170. case SeverityInformation:
  12171. break;
  12172. case SeverityWarning:
  12173. wuSeverity = SeverityWarning;
  12174. break;
  12175. case SeverityError:
  12176. case SeverityFatal:
  12177. wuSeverity = SeverityError;
  12178. break;
  12179. }
  12180. Owned<IWUException> exception = wu->createException();
  12181. exception->setSeverity(wuSeverity);
  12182. StringBuffer msg;
  12183. exception->setExceptionCode(error->errorCode());
  12184. exception->setExceptionMessage(error->errorMessage(msg).str());
  12185. const char * source = queryCreatorTypeName(queryStatisticsComponentType());
  12186. exception->setExceptionSource(source);
  12187. exception->setExceptionFileName(error->getFilename());
  12188. exception->setExceptionLineNo(error->getLine());
  12189. exception->setExceptionColumn(error->getColumn());
  12190. if (removeTimeStamp)
  12191. exception->setTimeStamp(nullptr);
  12192. if (error->getActivity())
  12193. exception->setActivityId(error->getActivity());
  12194. if (error->queryScope())
  12195. exception->setScope(error->queryScope());
  12196. }
  12197. IError * WorkUnitErrorReceiver::mapError(IError * error)
  12198. {
  12199. return LINK(error);
  12200. }
  12201. void WorkUnitErrorReceiver::report(IError* eclError)
  12202. {
  12203. addWorkunitException(wu, eclError, removeTimeStamp);
  12204. }
  12205. size32_t WorkUnitErrorReceiver::errCount()
  12206. {
  12207. unsigned count = 0;
  12208. Owned<IConstWUExceptionIterator> exceptions = &wu->getExceptions();
  12209. ForEach(*exceptions)
  12210. if (exceptions->query().getSeverity() == SeverityError)
  12211. count++;
  12212. return count;
  12213. }
  12214. size32_t WorkUnitErrorReceiver::warnCount()
  12215. {
  12216. unsigned count = 0;
  12217. Owned<IConstWUExceptionIterator> exceptions = &wu->getExceptions();
  12218. ForEach(*exceptions)
  12219. if (exceptions->query().getSeverity() == SeverityWarning)
  12220. count++;
  12221. return count;
  12222. }
  12223. bool isValidPriorityValue(const char *priority)
  12224. {
  12225. if (isEmptyString(priority))
  12226. return false;
  12227. if (strieq("SLA", priority) || strieq("LOW", priority) || strieq("HIGH", priority) || strieq("NONE", priority))
  12228. return true;
  12229. return false;
  12230. }
  12231. bool isValidMemoryValue(const char *memoryUnit)
  12232. {
  12233. if (isEmptyString(memoryUnit) || !isdigit(*memoryUnit))
  12234. return false;
  12235. while (isdigit(*++memoryUnit));
  12236. if (!*memoryUnit)
  12237. return true;
  12238. switch (toupper(*memoryUnit++))
  12239. {
  12240. case 'E':
  12241. case 'P':
  12242. case 'T':
  12243. case 'G':
  12244. case 'M':
  12245. case 'K':
  12246. if (!*memoryUnit || strieq("B", memoryUnit))
  12247. return true;
  12248. break;
  12249. case 'B':
  12250. if (!*memoryUnit)
  12251. return true;
  12252. break;
  12253. }
  12254. return false;
  12255. }