workunit.cpp 427 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204
  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. static int workUnitTraceLevel = 1;
  46. static StringBuffer &getXPath(StringBuffer &wuRoot, const char *wuid)
  47. {
  48. // MORE - can fold in the date
  49. return wuRoot.append("/WorkUnits/").append(wuid);
  50. }
  51. //To be called by eclserver, but esp etc. won't know, so we need to store it.
  52. static StringBuffer & appendLibrarySuffix(StringBuffer & suffix)
  53. {
  54. #ifdef _WIN32
  55. suffix.append("W");
  56. #else
  57. suffix.append("L");
  58. #endif
  59. #ifdef __64BIT__
  60. suffix.append("64");
  61. #else
  62. suffix.append("32");
  63. #endif
  64. return suffix;
  65. }
  66. typedef MapStringTo<bool> UniqueScopes;
  67. static void wuAccessError(const char *username, const char *action, const char *wuscope, const char *wuid, bool excpt, bool log)
  68. {
  69. StringBuffer err;
  70. err.append("Workunit Access Denied - action: ").append(action).append(" user:").append(username ? username : "<Unknown>");
  71. if (wuid)
  72. err.append(" workunit:").append(wuid);
  73. if (wuscope)
  74. err.append(" scope:").append(wuscope);
  75. //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
  76. SYSLOG(AUDIT_TYPE_ACCESS_FAILURE, err.str());
  77. if (log)
  78. LOG(MCuserError, "%s", err.str());
  79. if (excpt)
  80. throw MakeStringException(WUERR_AccessError, "%s", err.str());
  81. }
  82. static bool checkWuScopeSecAccess(const char *wuscope, ISecManager *secmgr, ISecUser *secuser, int required, const char *action, bool excpt, bool log)
  83. {
  84. if (!secmgr || !secuser)
  85. return true;
  86. bool ret = secmgr->authorizeEx(RT_WORKUNIT_SCOPE, *secuser, wuscope)>=required;
  87. if (!ret && (log || excpt))
  88. wuAccessError(secuser->getName(), action, wuscope, NULL, excpt, log);
  89. return ret;
  90. }
  91. static bool checkWuScopeListSecAccess(const char *wuscope, ISecResourceList *scopes, int required, const char *action, bool excpt, bool log)
  92. {
  93. if (!scopes)
  94. return true;
  95. bool ret=true;
  96. if (wuscope)
  97. {
  98. Owned<ISecResource> res=scopes->getResource(wuscope);
  99. if (!res || res->getAccessFlags()<required)
  100. ret=false;
  101. }
  102. else
  103. {
  104. for (int seq=0; ret && seq<scopes->count(); seq++)
  105. {
  106. ISecResource *res=scopes->queryResource(seq);
  107. if (res && res->getAccessFlags()<required)
  108. return false;
  109. }
  110. }
  111. if (!ret && (log || excpt))
  112. wuAccessError(NULL, action, wuscope, NULL, excpt, log);
  113. return ret;
  114. }
  115. static bool checkWuSecAccess(IConstWorkUnit &cw, ISecManager *secmgr, ISecUser *secuser, int required, const char *action, bool excpt, bool log)
  116. {
  117. if (!secmgr || !secuser)
  118. return true;
  119. bool ret=secmgr->authorizeEx(RT_WORKUNIT_SCOPE, *secuser, cw.queryWuScope())>=required;
  120. if (!ret && (log || excpt))
  121. {
  122. wuAccessError(secuser->getName(), action, cw.queryWuScope(), cw.queryWuid(), excpt, log);
  123. }
  124. return ret;
  125. }
  126. static bool checkWuSecAccess(const char *wuid, ISecManager *secmgr, ISecUser *secuser, int required, const char *action, bool excpt, bool log)
  127. {
  128. if (!secmgr || !secuser)
  129. return true;
  130. Owned<IWorkUnitFactory> factory = getWorkUnitFactory();
  131. Owned<IConstWorkUnit> cw = factory->openWorkUnit(wuid);
  132. bool ret=secmgr->authorizeEx(RT_WORKUNIT_SCOPE, *secuser, cw->queryWuScope())>=required;
  133. if (!ret && (log || excpt))
  134. {
  135. wuAccessError(secuser->getName(), action, cw->queryWuScope(), cw->queryWuid(), excpt, log);
  136. }
  137. return ret;
  138. }
  139. void doDescheduleWorkkunit(char const * wuid)
  140. {
  141. StringBuffer xpath;
  142. xpath.append("*/*/*/");
  143. ncnameEscape(wuid, xpath);
  144. Owned<IRemoteConnection> conn = querySDS().connect("/Schedule", myProcessSession(), RTM_LOCK_WRITE, SDS_LOCK_TIMEOUT);
  145. if(!conn) return;
  146. Owned<IPropertyTree> root = conn->getRoot();
  147. bool more;
  148. do more = root->removeProp(xpath.str()); while(more);
  149. }
  150. //======================================================
  151. /*
  152. * Graph progress support
  153. */
  154. CWuGraphStats::CWuGraphStats(IPropertyTree *_progress, StatisticCreatorType _creatorType, const char * _creator, unsigned wfid, const char * _rootScope, unsigned _id)
  155. : progress(_progress), creatorType(_creatorType), creator(_creator), id(_id)
  156. {
  157. StatsScopeId graphScopeId;
  158. verifyex(graphScopeId.setScopeText(_rootScope));
  159. if (wfid)
  160. {
  161. StatsScopeId rootScopeId(SSTworkflow,wfid);
  162. collector.setown(createStatisticsGatherer(_creatorType, _creator, rootScopeId));
  163. collector->beginScope(graphScopeId);
  164. }
  165. else
  166. {
  167. collector.setown(createStatisticsGatherer(_creatorType, _creator, graphScopeId));
  168. }
  169. }
  170. void CWuGraphStats::beforeDispose()
  171. {
  172. Owned<IStatisticCollection> stats = collector->getResult();
  173. MemoryBuffer compressed;
  174. {
  175. MemoryBuffer serialized;
  176. serializeStatisticCollection(serialized, stats);
  177. compressToBuffer(compressed, serialized.length(), serialized.toByteArray());
  178. }
  179. unsigned minActivity = 0;
  180. unsigned maxActivity = 0;
  181. stats->getMinMaxActivity(minActivity, maxActivity);
  182. StringBuffer tag;
  183. tag.append("sg").append(id);
  184. //Replace the particular subgraph statistics added by this creator
  185. StringBuffer qualified(tag);
  186. qualified.append("[@creator='").append(creator).append("']");
  187. progress->removeProp(qualified);
  188. IPropertyTree * subgraph = progress->addPropTree(tag);
  189. subgraph->setProp("@c", queryCreatorTypeName(creatorType));
  190. subgraph->setProp("@creator", creator);
  191. subgraph->setPropInt("@minActivity", minActivity);
  192. subgraph->setPropInt("@maxActivity", maxActivity);
  193. subgraph->setPropBin("Stats", compressed.length(), compressed.toByteArray());
  194. if (!progress->getPropBool("@stats", false))
  195. progress->setPropBool("@stats", true);
  196. }
  197. IStatisticGatherer & CWuGraphStats::queryStatsBuilder()
  198. {
  199. return *collector;
  200. }
  201. class CConstGraphProgress : public CInterface, implements IConstWUGraphProgress
  202. {
  203. public:
  204. IMPLEMENT_IINTERFACE;
  205. CConstGraphProgress(const char *_wuid, const char *_graphName, IPropertyTree *_progress) : wuid(_wuid), graphName(_graphName), progress(_progress)
  206. {
  207. if (!progress)
  208. progress.setown(createPTree());
  209. formatVersion = progress->getPropInt("@format", PROGRESS_FORMAT_V);
  210. }
  211. virtual IPropertyTree * getProgressTree()
  212. {
  213. if (progress->getPropBool("@stats"))
  214. return createProcessTreeFromStats(); // Should we cache that?
  215. return LINK(progress);
  216. }
  217. virtual unsigned queryFormatVersion()
  218. {
  219. return formatVersion;
  220. }
  221. protected:
  222. CConstGraphProgress(const char *_wuid, const char *_graphName) : wuid(_wuid), graphName(_graphName)
  223. {
  224. formatVersion = PROGRESS_FORMAT_V;
  225. }
  226. static void expandStats(IPropertyTree * target, IStatisticCollection & collection)
  227. {
  228. StringBuffer formattedValue;
  229. unsigned numStats = collection.getNumStatistics();
  230. for (unsigned i=0; i < numStats; i++)
  231. {
  232. StatisticKind kind;
  233. unsigned __int64 value;
  234. collection.getStatistic(kind, value, i);
  235. formatStatistic(formattedValue.clear(), value, kind);
  236. target->setProp(queryTreeTag(kind), formattedValue);
  237. }
  238. }
  239. void expandProcessTreeFromStats(IPropertyTree * rootTarget, IPropertyTree * target, IStatisticCollection * collection)
  240. {
  241. expandStats(target, *collection);
  242. StringBuffer scopeName;
  243. Owned<IStatisticCollectionIterator> activityIter = &collection->getScopes(NULL, false);
  244. ForEach(*activityIter)
  245. {
  246. IStatisticCollection & cur = activityIter->query();
  247. cur.getScope(scopeName.clear());
  248. const char * id = scopeName.str();
  249. const char * tag;
  250. IPropertyTree * curTarget = target;
  251. switch (cur.queryScopeType())
  252. {
  253. case SSTedge:
  254. tag = "edge";
  255. id += strlen(EdgeScopePrefix);
  256. break;
  257. case SSTactivity:
  258. tag = "node";
  259. id += strlen(ActivityScopePrefix);
  260. break;
  261. case SSTsubgraph:
  262. //All subgraphs are added a root elements in the progress tree
  263. curTarget = rootTarget;
  264. tag = "node";
  265. id += strlen(SubGraphScopePrefix);
  266. break;
  267. case SSTchildgraph:
  268. case SSTworkflow:
  269. case SSTgraph:
  270. // SSTworkflow and SSTgraph may be safely ignored. They are not required to produce the statistics.
  271. continue;
  272. case SSTfunction:
  273. //MORE:Should function scopes be included in the graph scope somehow, and if so how?
  274. continue;
  275. default:
  276. throwUnexpected();
  277. }
  278. IPropertyTree * next = curTarget->addPropTree(tag);
  279. next->setProp("@id", id);
  280. expandProcessTreeFromStats(rootTarget, next, &cur);
  281. }
  282. }
  283. IPropertyTree * createProcessTreeFromStats()
  284. {
  285. MemoryBuffer compressed;
  286. MemoryBuffer serialized;
  287. Owned<IPropertyTree> progressTree = createPTree();
  288. Owned<IPropertyTreeIterator> iter = progress->getElements("sg*");
  289. ForEach(*iter)
  290. {
  291. IPropertyTree & curSubGraph = iter->query();
  292. curSubGraph.getPropBin("Stats", compressed.clear());
  293. //Protect against updates that delete the stats while we are iterating
  294. if (compressed.length())
  295. {
  296. decompressToBuffer(serialized.clear(), compressed);
  297. Owned<IStatisticCollection> collection = createStatisticCollection(serialized);
  298. expandProcessTreeFromStats(progressTree, progressTree, collection);
  299. }
  300. }
  301. return progressTree.getClear();
  302. }
  303. protected:
  304. Linked<IPropertyTree> progress;
  305. StringAttr wuid, graphName;
  306. unsigned formatVersion;
  307. };
  308. extern WORKUNIT_API IConstWUGraphProgress *createConstGraphProgress(const char *_wuid, const char *_graphName, IPropertyTree *_progress)
  309. {
  310. return new CConstGraphProgress(_wuid, _graphName, _progress);
  311. }
  312. //--------------------------------------------------------------------------------------------------------------------
  313. /*
  314. * Create a user friendly description a scope/stats combination. Only currently used for elapsed time for root subgraphs
  315. */
  316. static void createDefaultDescription(StringBuffer & description, StatisticKind kind, StatisticScopeType scopeType, const char * scope)
  317. {
  318. switch (kind)
  319. {
  320. case StTimeElapsed:
  321. {
  322. if (scopeType != SSTsubgraph)
  323. break;
  324. //Create a default description for a root subgraph
  325. const char * colon = strchr(scope, ':');
  326. if (!colon)
  327. break;
  328. const char * subgraph = colon+1;
  329. //Check for nested subgraph
  330. if (strchr(subgraph, ':'))
  331. break;
  332. assertex(strncmp(subgraph, SubGraphScopePrefix, strlen(SubGraphScopePrefix)) == 0);
  333. StringAttr graphname;
  334. graphname.set(scope, colon - scope);
  335. unsigned subId = atoi(subgraph + strlen(SubGraphScopePrefix));
  336. formatGraphTimerLabel(description, graphname, 0, subId);
  337. return;
  338. }
  339. }
  340. describeScope(description, scope);
  341. }
  342. /* Represents a single statistic */
  343. class ExtractedStatistic : public CInterfaceOf<IConstWUStatistic>
  344. {
  345. public:
  346. virtual IStringVal & getDescription(IStringVal & str, bool createDefault) const
  347. {
  348. if (!description && createDefault)
  349. {
  350. StringBuffer desc;
  351. createDefaultDescription(desc, kind, scopeType, scope);
  352. str.set(desc);
  353. return str;
  354. }
  355. str.set(description);
  356. return str;
  357. }
  358. virtual IStringVal & getCreator(IStringVal & str) const
  359. {
  360. str.set(creator);
  361. return str;
  362. }
  363. virtual const char * queryScope() const
  364. {
  365. return scope;
  366. }
  367. virtual IStringVal & getFormattedValue(IStringVal & str) const
  368. {
  369. StringBuffer formatted;
  370. formatStatistic(formatted, value, measure);
  371. str.set(formatted);
  372. return str;
  373. }
  374. virtual StatisticMeasure getMeasure() const
  375. {
  376. return measure;
  377. }
  378. virtual StatisticKind getKind() const
  379. {
  380. return kind;
  381. }
  382. virtual StatisticCreatorType getCreatorType() const
  383. {
  384. return creatorType;
  385. }
  386. virtual StatisticScopeType getScopeType() const
  387. {
  388. return scopeType;
  389. }
  390. virtual unsigned __int64 getValue() const
  391. {
  392. return value;
  393. }
  394. virtual unsigned __int64 getCount() const
  395. {
  396. return count;
  397. }
  398. virtual unsigned __int64 getMax() const
  399. {
  400. return max;
  401. }
  402. virtual unsigned __int64 getTimestamp() const
  403. {
  404. return timeStamp;
  405. }
  406. public:
  407. StringBuffer creator;
  408. StringBuffer description;
  409. StringBuffer scope;
  410. StatisticMeasure measure;
  411. StatisticKind kind;
  412. StatisticCreatorType creatorType;
  413. StatisticScopeType scopeType;
  414. unsigned __int64 value;
  415. unsigned __int64 count;
  416. unsigned __int64 max;
  417. unsigned __int64 timeStamp;
  418. };
  419. //---------------------------------------------------------------------------------------------------------------------
  420. /*
  421. * The following compare functions are used to ensure that comparison are consistent with
  422. * compareScopeName() in jstats. This ensures that the scope iterators from different sources
  423. * are processed in a consistent order
  424. */
  425. static int compareGraphNode(IInterface * const *ll, IInterface * const *rr)
  426. {
  427. IPropertyTree *l = (IPropertyTree *) *ll;
  428. IPropertyTree *r = (IPropertyTree *) *rr;
  429. const char * lname = l->queryName();
  430. const char * rname = r->queryName();
  431. return compareScopeName(lname, rname);
  432. }
  433. static int compareSubGraphStatsNode(IInterface * const *ll, IInterface * const *rr)
  434. {
  435. IPropertyTree *l = (IPropertyTree *) *ll;
  436. IPropertyTree *r = (IPropertyTree *) *rr;
  437. return compareScopeName(l->queryName(), r->queryName());
  438. }
  439. static int compareSubGraphNode(IInterface * const *ll, IInterface * const *rr)
  440. {
  441. IPropertyTree *l = (IPropertyTree *) *ll;
  442. IPropertyTree *r = (IPropertyTree *) *rr;
  443. return l->getPropInt("@id") - r->getPropInt("@id");
  444. }
  445. static int compareActivityNode(IInterface * const *ll, IInterface * const *rr)
  446. {
  447. IPropertyTree *l = (IPropertyTree *) *ll;
  448. IPropertyTree *r = (IPropertyTree *) *rr;
  449. return l->getPropInt("@id") - r->getPropInt("@id");
  450. }
  451. static int compareEdgeNode(IInterface * const *ll, IInterface * const *rr)
  452. {
  453. IPropertyTree *l = (IPropertyTree *) *ll;
  454. IPropertyTree *r = (IPropertyTree *) *rr;
  455. //MORE: Edge needs more work
  456. const char * leftId = l->queryProp("@id");
  457. const char * rightId = r->queryProp("@id");
  458. unsigned leftAc = atoi(leftId);
  459. unsigned rightAc = atoi(rightId);
  460. if (leftAc != rightAc)
  461. return (int)(leftAc - rightAc);
  462. const char * leftSep = strchr(leftId, '_');
  463. const char * rightSep = strchr(rightId, '_');
  464. assertex(leftSep && rightSep);
  465. return atoi(leftSep+1) - atoi(rightSep+1);
  466. }
  467. //---------------------------------------------------------------------------------------------------------------------
  468. /*
  469. * A class for implementing a scope iterator that walks through graph progress information
  470. */
  471. class CConstGraphProgressScopeIterator : public CInterfaceOf<IConstWUScopeIterator>
  472. {
  473. public:
  474. CConstGraphProgressScopeIterator(const char * wuid, const ScopeFilter & _filter, __uint64 _minVersion) : filter(_filter), minVersion(_minVersion)
  475. {
  476. //Examine the filter, and determine if we only need to look at a single graph/subgraph
  477. StringAttr singleGraph;
  478. const StringArray & scopesToMatch = filter.queryScopes();
  479. if (scopesToMatch)
  480. {
  481. bool seenGraph = false;
  482. bool seenSubGraph = false;
  483. ForEachItemIn(iScope, scopesToMatch)
  484. {
  485. StringArray ids;
  486. ids.appendList(scopesToMatch.item(iScope), ":");
  487. ForEachItemIn(i, ids)
  488. {
  489. const char * curId = ids.item(i);
  490. StatsScopeId id(curId);
  491. switch (id.queryScopeType())
  492. {
  493. case SSTgraph:
  494. if (seenGraph)
  495. {
  496. if (singleGraph && !streq(singleGraph, curId))
  497. singleGraph.clear();
  498. }
  499. else
  500. {
  501. if (!id.isWildcard())
  502. singleGraph.set(curId);
  503. seenGraph = true;
  504. }
  505. break;
  506. case SSTsubgraph:
  507. if (seenSubGraph)
  508. {
  509. if (singleSubGraph && !streq(singleSubGraph, curId))
  510. singleSubGraph.clear();
  511. }
  512. else
  513. {
  514. if (!id.isWildcard())
  515. singleSubGraph.set(curId);
  516. seenSubGraph = true;
  517. }
  518. break;
  519. }
  520. }
  521. }
  522. }
  523. rootPath.append("/GraphProgress/").append(wuid).append('/');
  524. if (singleGraph)
  525. rootPath.append(singleGraph).append("/");
  526. //Don't lock the statistics while we iterate - any partial updates must not cause problems
  527. if (daliClientActive())
  528. conn.setown(querySDS().connect(rootPath.str(), myProcessSession(), RTM_NONE, SDS_LOCK_TIMEOUT));
  529. if (conn && !singleGraph)
  530. {
  531. graphIter.setown(conn->queryRoot()->getElements("*"));
  532. graphIter.setown(createSortedIterator(*graphIter, compareGraphNode));
  533. }
  534. valid = false;
  535. }
  536. IMPLEMENT_IINTERFACE_USING(CInterfaceOf<IConstWUScopeIterator>)
  537. virtual bool first()
  538. {
  539. valid = false;
  540. if (!conn)
  541. return false;
  542. if (graphIter && !graphIter->first())
  543. return false;
  544. if (!firstSubGraph())
  545. {
  546. if (!nextGraph())
  547. return false;
  548. }
  549. valid = true;
  550. return true;
  551. }
  552. virtual bool next()
  553. {
  554. if (!nextChildScope())
  555. {
  556. if (!nextSubGraph())
  557. {
  558. if (!nextGraph())
  559. {
  560. valid = false;
  561. return false;
  562. }
  563. }
  564. }
  565. return true;
  566. }
  567. virtual bool nextSibling() override
  568. {
  569. if (collections.ordinality() == 0)
  570. return false;
  571. assertex(childIterators.ordinality() < collections.ordinality());
  572. collections.pop();
  573. //next will call childIterator.next() - walking the next sibling
  574. return next();
  575. }
  576. virtual bool nextParent() override
  577. {
  578. if (collections.ordinality() == 0)
  579. return false;
  580. assertex(childIterators.ordinality() < collections.ordinality());
  581. collections.pop();
  582. if (collections.ordinality() == 0)
  583. return false;
  584. //Finish with this node - so next will move onto the sibling of the parent node.
  585. finishCollection();
  586. return next();
  587. }
  588. virtual bool isValid()
  589. {
  590. return valid;
  591. }
  592. protected:
  593. bool firstSubGraph()
  594. {
  595. IPropertyTree & graphNode = graphIter ? graphIter->query() : *conn->queryRoot();
  596. const char * xpath = "sg*";
  597. StringBuffer childXpath;
  598. if (singleSubGraph)
  599. {
  600. childXpath.append(singleSubGraph);
  601. xpath = childXpath.str();
  602. }
  603. subgraphIter.setown(graphNode.getElements(xpath));
  604. if (subgraphIter)
  605. {
  606. if (!singleSubGraph)
  607. subgraphIter.setown(createSortedIterator(*subgraphIter, compareSubGraphStatsNode));
  608. }
  609. else
  610. subgraphIter.setown(graphNode.getElements("sg0"));
  611. if (!subgraphIter->first())
  612. return false;
  613. if (firstStat())
  614. return true;
  615. return nextSubGraph();
  616. }
  617. bool nextSubGraph()
  618. {
  619. for (;;)
  620. {
  621. if (!subgraphIter->next())
  622. return false;
  623. if (firstStat())
  624. return true;
  625. }
  626. }
  627. bool nextGraph()
  628. {
  629. if (!graphIter)
  630. return false;
  631. for (;;)
  632. {
  633. if (!graphIter->next())
  634. return false;
  635. if (firstSubGraph())
  636. return true;
  637. }
  638. }
  639. bool firstStat()
  640. {
  641. IPropertyTree & curSubGraph = subgraphIter->query();
  642. if (!checkSubGraph())
  643. return false;
  644. curSubGraph.getPropBin("Stats", compressed.clear());
  645. //Don't crash on old format progress...
  646. if (compressed.length() == 0)
  647. return false;
  648. decompressToBuffer(serialized.clear(), compressed);
  649. Owned<IStatisticCollection> collection = createStatisticCollection(serialized);
  650. statsIterator.timeStamp = collection->queryWhenCreated();
  651. if (!beginCollection(*collection))
  652. return false;
  653. // When workflow is root element, it is just a container. Ignore the workflow element here
  654. // as WorkUnitStatisticsScopeIterator will produce workflow scope - don't want duplicates.
  655. // (Note: workflow element never contains stats).
  656. if (collection->queryScopeType() == SSTworkflow)
  657. {
  658. if (!next())
  659. return false;
  660. }
  661. //The root element of a collection is a graph - but it is only there to nest the subgraphs in.
  662. //Do not iterate it as a separate element - unless it has some stats.
  663. IStatisticCollection & curCollection = collections.tos();
  664. if ((curCollection.queryScopeType() != SSTgraph) || (curCollection.getNumStatistics() != 0))
  665. return true;
  666. return next();
  667. }
  668. bool beginCollection(IStatisticCollection & collection)
  669. {
  670. collections.append(OLINK(collection));
  671. curScopeType = collection.queryScopeType();
  672. collection.getFullScope(curScopeName.clear());
  673. ScopeCompare result = filter.compare(curScopeName);
  674. if (result & SCequal)
  675. return true;
  676. //If this scope cannot be the parent of a match then discard it.
  677. if (!(result & SCparent))
  678. collections.pop();
  679. //walk the next element
  680. return nextChildScope();
  681. }
  682. bool nextChildScope()
  683. {
  684. for (;;)
  685. {
  686. if (collections.ordinality() == 0)
  687. return false;
  688. IStatisticCollection * curCollection = &collections.tos();
  689. if (childIterators.ordinality() < collections.ordinality())
  690. {
  691. ScopeCompare result = filter.compare(curScopeName);
  692. //Do not walk children scopes if it is unrelated
  693. if (result & SCparent)
  694. {
  695. //Start iterating the children for the current collection
  696. childIterators.append(curCollection->getScopes(NULL, true));
  697. if (!childIterators.tos().first())
  698. {
  699. finishCollection();
  700. continue;
  701. }
  702. }
  703. else
  704. {
  705. //Don't walk the child scopes
  706. collections.pop();
  707. continue;
  708. }
  709. }
  710. else if (!childIterators.tos().next())
  711. {
  712. finishCollection();
  713. continue;
  714. }
  715. if (beginCollection(childIterators.tos().query()))
  716. return true;
  717. }
  718. }
  719. void finishCollection()
  720. {
  721. collections.pop();
  722. childIterators.pop();
  723. }
  724. bool checkSubGraph()
  725. {
  726. IPropertyTree & curSubGraph = subgraphIter->query();
  727. StatisticCreatorType creatorType = queryCreatorType(curSubGraph.queryProp("@c"), SCTnone);
  728. const char * creator = curSubGraph.queryProp("@creator");
  729. //MORE: Check minVersion and allow early filtering
  730. //MORE: Potentially filter by creator type??
  731. // if (!filter->matches(creatorType, creator, SSTall, NULL, SMeasureAll, StKindAll, AnyStatisticValue))
  732. // return false;
  733. statsIterator.creatorType = creatorType;
  734. statsIterator.creator.set(creator);
  735. return true;
  736. }
  737. virtual void playProperties(IWuScopeVisitor & visitor, WuPropertyTypes whichProperties) override
  738. {
  739. if ((whichProperties & PTstatistics))
  740. {
  741. /*
  742. MORE: Code from the statsIterator class should be inlined here - code will be much simpler
  743. but it currently needs an implementation of the IConstWUStatistic 3rd parameter
  744. IStatisticCollection & collection = collections.tos();
  745. ForEachItemIn(i, collection)
  746. {
  747. StatisticKind kind;
  748. unsigned __int64 value;
  749. collection->getStatistic(kind, value, i);
  750. visitor.noteStatistic(kind, value, *this);
  751. }
  752. */
  753. statsIterator.reset(curScopeName, curScopeType, collections.tos());
  754. ForEach(statsIterator)
  755. statsIterator.play(visitor);
  756. }
  757. }
  758. virtual bool getStat(StatisticKind kind, unsigned __int64 & value) const override
  759. {
  760. return collections.tos().getStatistic(kind, value);
  761. }
  762. virtual const char * queryAttribute(WuAttr attr, StringBuffer & scratchpad) const override
  763. {
  764. return nullptr;
  765. }
  766. virtual const char * queryHint(const char * kind) const override
  767. {
  768. return nullptr;
  769. }
  770. virtual const char * queryScope() const override
  771. {
  772. return curScopeName;
  773. }
  774. virtual StatisticScopeType getScopeType() const override
  775. {
  776. return curScopeType;
  777. }
  778. private:
  779. class ScopeStatisticsIterator : public CInterfaceOf<IConstWUStatistic>
  780. {
  781. friend class CConstGraphProgressScopeIterator; // cleaner if this was removed + setScope() functions added.
  782. public:
  783. void reset(const char * _scopeName, StatisticScopeType _scopeType, IStatisticCollection & _collection)
  784. {
  785. scope.set(_scopeName);
  786. scopeType = _scopeType;
  787. collection = &_collection;
  788. numStats = collection->getNumStatistics();
  789. }
  790. // interface IConstWUStatisticIterator
  791. IConstWUStatistic & query()
  792. {
  793. return *this;
  794. }
  795. bool first()
  796. {
  797. curStatIndex = 0;
  798. if (curStatIndex >= numStats)
  799. return false;
  800. collection->getStatistic(kind, value, curStatIndex);
  801. //MORE: Allow filtering:
  802. /*
  803. * if (filter && !filter->matches(SCTall, NULL, SSTall, NULL, queryMeasure(kind), kind, value))
  804. continue;
  805. */
  806. return true;
  807. }
  808. bool next()
  809. {
  810. for (;;)
  811. {
  812. ++curStatIndex;
  813. if (curStatIndex >= numStats)
  814. return false;
  815. collection->getStatistic(kind, value, curStatIndex);
  816. //MORE: Allow stats filtering
  817. return true;
  818. }
  819. }
  820. bool isValid()
  821. {
  822. return curStatIndex < numStats;
  823. }
  824. //interface IConstWUStatistic
  825. virtual IStringVal & getDescription(IStringVal & str, bool createDefault) const override
  826. {
  827. if (createDefault)
  828. {
  829. StringBuffer description;
  830. createDefaultDescription(description, kind, scopeType, scope);
  831. str.set(description);
  832. }
  833. return str;
  834. }
  835. virtual IStringVal & getCreator(IStringVal & str) const override
  836. {
  837. str.set(creator);
  838. return str;
  839. }
  840. virtual const char * queryScope() const override
  841. {
  842. return scope;
  843. }
  844. virtual IStringVal & getFormattedValue(IStringVal & str) const override
  845. {
  846. StringBuffer formatted;
  847. formatStatistic(formatted, value, kind);
  848. str.set(formatted);
  849. return str;
  850. }
  851. virtual StatisticMeasure getMeasure() const override
  852. {
  853. return queryMeasure(kind);
  854. }
  855. virtual StatisticKind getKind() const override
  856. {
  857. return kind;
  858. }
  859. virtual StatisticCreatorType getCreatorType() const override
  860. {
  861. return creatorType;
  862. }
  863. virtual StatisticScopeType getScopeType() const override
  864. {
  865. return scopeType;
  866. }
  867. virtual unsigned __int64 getValue() const override
  868. {
  869. return value;
  870. }
  871. virtual unsigned __int64 getCount() const override
  872. {
  873. return 1;
  874. }
  875. virtual unsigned __int64 getMax() const override
  876. {
  877. return 0;
  878. }
  879. virtual unsigned __int64 getTimestamp() const override
  880. {
  881. return timeStamp;
  882. }
  883. void play(IWuScopeVisitor & visitor)
  884. {
  885. visitor.noteStatistic(kind, value, *this);
  886. }
  887. protected:
  888. IStatisticCollection * collection = nullptr;
  889. StringBuffer creator;
  890. StringBuffer scope;
  891. StatisticKind kind;
  892. StatisticCreatorType creatorType;
  893. StatisticScopeType scopeType;
  894. unsigned __int64 value = 0;
  895. unsigned __int64 timeStamp;
  896. unsigned curStatIndex = 0;
  897. unsigned numStats = 0;
  898. } statsIterator;
  899. Owned<IRemoteConnection> conn;
  900. StringBuffer curScopeName;
  901. StatisticScopeType curScopeType = SSTnone;
  902. __uint64 minVersion;
  903. const ScopeFilter & filter;
  904. StringBuffer rootPath;
  905. StringAttr singleSubGraph;
  906. Owned<IPropertyTreeIterator> graphIter;
  907. Owned<IPropertyTreeIterator> subgraphIter;
  908. IArrayOf<IStatisticCollection> collections;
  909. IArrayOf<IStatisticCollectionIterator> childIterators; // Iterator(n) through collections(n) - created once iterating children
  910. MemoryBuffer compressed;
  911. MemoryBuffer serialized;
  912. bool valid;
  913. };
  914. int compareStatisticScopes(IConstWUStatistic & left, IConstWUStatistic & right)
  915. {
  916. return compareScopeName(left.queryScope(), right.queryScope());
  917. }
  918. int compareStatisticScopes(IInterface * const * left, IInterface * const * right)
  919. {
  920. return compareStatisticScopes(*static_cast<IConstWUStatistic *>(*left), *static_cast<IConstWUStatistic *>(*right));
  921. }
  922. /*
  923. * An implementation of IConstWUScopeIterator for global workunit statistics.
  924. */
  925. class WorkUnitStatisticsScopeIterator : public CInterfaceOf<IConstWUScopeIterator>
  926. {
  927. public:
  928. WorkUnitStatisticsScopeIterator(const IArrayOf<IConstWUStatistic> & _statistics, const ScopeFilter & _filter)
  929. {
  930. ForEachItemIn(i, _statistics)
  931. {
  932. IConstWUStatistic & cur = _statistics.item(i);
  933. if (_filter.compare(cur.queryScope()) & SCequal)
  934. statistics.append(OLINK(cur));
  935. }
  936. statistics.sort(compareStatisticScopes);
  937. }
  938. virtual bool first() override
  939. {
  940. curIndex = 0;
  941. return initScope();
  942. }
  943. virtual bool next() override
  944. {
  945. curIndex += numStatistics;
  946. return initScope();
  947. }
  948. virtual bool nextSibling() override
  949. {
  950. //Search until the current scope is not a child of the previous scope
  951. StringBuffer savedScope(queryScope());
  952. for (;;)
  953. {
  954. if (!next())
  955. return false;
  956. if (compareScopes(queryScope(), savedScope) != SCchild)
  957. return true;
  958. }
  959. }
  960. virtual bool nextParent() override
  961. {
  962. //Search until the current scope is not a child of the previous parent scope
  963. StringBuffer parentScope;
  964. if (getParentScope(parentScope, queryScope()))
  965. {
  966. for (;;)
  967. {
  968. if (!next())
  969. return false;
  970. if (compareScopes(queryScope(), parentScope) != SCchild)
  971. return true;
  972. }
  973. }
  974. else
  975. {
  976. finish();
  977. return false;
  978. }
  979. }
  980. virtual bool isValid() override
  981. {
  982. return statistics.isItem(curIndex);
  983. }
  984. virtual const char * queryScope() const override
  985. {
  986. return statistics.item(curIndex).queryScope();
  987. }
  988. virtual StatisticScopeType getScopeType() const override
  989. {
  990. return statistics.item(curIndex).getScopeType();
  991. }
  992. virtual void playProperties(IWuScopeVisitor & visitor, WuPropertyTypes whichProperties) override
  993. {
  994. if (whichProperties & PTstatistics)
  995. {
  996. for (unsigned i=0; i < numStatistics; i++)
  997. {
  998. IConstWUStatistic & cur = statistics.item(curIndex + i);
  999. visitor.noteStatistic(cur.getKind(), cur.getValue(), cur);
  1000. }
  1001. }
  1002. }
  1003. virtual bool getStat(StatisticKind kind, unsigned __int64 & value) const override
  1004. {
  1005. for (unsigned i=0; i < numStatistics; i++)
  1006. {
  1007. IConstWUStatistic & cur = statistics.item(curIndex + i);
  1008. if (cur.getKind() == kind)
  1009. {
  1010. value = cur.getValue();
  1011. return true;
  1012. }
  1013. }
  1014. return false;
  1015. }
  1016. virtual const char * queryAttribute(WuAttr attr, StringBuffer & scratchpad) const override
  1017. {
  1018. return nullptr;
  1019. }
  1020. virtual const char * queryHint(const char * kind) const
  1021. {
  1022. return nullptr;
  1023. }
  1024. protected:
  1025. inline IConstWUStatistic & queryStatistic(unsigned i)
  1026. {
  1027. return statistics.item(curIndex + i);
  1028. }
  1029. bool initScope()
  1030. {
  1031. if (!statistics.isItem(curIndex))
  1032. return false;
  1033. unsigned next = curIndex+1;
  1034. while (next < statistics.ordinality())
  1035. {
  1036. if (compareStatisticScopes(statistics.item(curIndex), statistics.item(next)) != 0)
  1037. break;
  1038. next++;
  1039. }
  1040. numStatistics = (next - curIndex);
  1041. return true;
  1042. }
  1043. void finish()
  1044. {
  1045. curIndex = statistics.ordinality();
  1046. }
  1047. protected:
  1048. IArrayOf<IConstWUStatistic> statistics;
  1049. unsigned curIndex = 0;
  1050. unsigned numStatistics = 1;
  1051. };
  1052. /*
  1053. * An implementation of IConstWUScopeIterator for the query graphs.
  1054. */
  1055. class GraphScopeIterator : public CInterfaceOf<IConstWUScopeIterator>
  1056. {
  1057. private:
  1058. //This uses a state machine - this enumeration contains the different states.
  1059. enum State
  1060. {
  1061. //Following are the states which represent valid scopes
  1062. SGraph,
  1063. SChildGraph,
  1064. SSubGraph,
  1065. SEdge,
  1066. SActivity,
  1067. //The following are internal states.
  1068. SGraphFirstEdge,
  1069. SGraphFirstSubGraph,
  1070. SGraphFirst,
  1071. SGraphEnd,
  1072. SGraphNext,
  1073. SSubGraphFirstEdge,
  1074. SSubGraphFirstActivity,
  1075. SSubGraphEnd,
  1076. SSubGraphNext,
  1077. SEdgeNext,
  1078. SEdgeEnd,
  1079. SActivityNext,
  1080. SActivityEnd,
  1081. SChildGraphFirstEdge,
  1082. SChildGraphFirstSubGraph,
  1083. SChildGraphFirst,
  1084. SChildGraphNext,
  1085. SChildGraphEnd,
  1086. SDone
  1087. };
  1088. State state = SDone;
  1089. State nextState = SDone;
  1090. public:
  1091. GraphScopeIterator(const IConstWorkUnit * wu, const ScopeFilter & _filter) : graphIter(&wu->getGraphs(GraphTypeAny)), filter(_filter)
  1092. {
  1093. }
  1094. virtual bool first() override
  1095. {
  1096. state = SGraphFirst;
  1097. return nextScope();
  1098. }
  1099. virtual bool next() override
  1100. {
  1101. if (!selectNext())
  1102. return false;
  1103. return nextScope();
  1104. }
  1105. virtual bool nextSibling() override
  1106. {
  1107. if (!selectNextSibling())
  1108. return false;
  1109. return nextScope();
  1110. }
  1111. virtual bool nextParent() override
  1112. {
  1113. if (!selectNextParent())
  1114. return false;
  1115. return nextScope();
  1116. }
  1117. virtual bool isValid() override
  1118. {
  1119. return graphIter->isValid();
  1120. }
  1121. virtual const char * queryScope() const override
  1122. {
  1123. return curScopeName.str();
  1124. }
  1125. virtual StatisticScopeType getScopeType() const override
  1126. {
  1127. return scopeType;
  1128. }
  1129. virtual void playProperties(IWuScopeVisitor & visitor, WuPropertyTypes whichProperties) override
  1130. {
  1131. switch (scopeType)
  1132. {
  1133. case SSTgraph:
  1134. return;
  1135. }
  1136. IPropertyTree & cur = treeIters.tos().query();
  1137. switch (scopeType)
  1138. {
  1139. case SSTgraph:
  1140. break;
  1141. case SSTsubgraph:
  1142. break;
  1143. case SSTactivity:
  1144. {
  1145. if (whichProperties & PTattributes)
  1146. {
  1147. playAttribute(visitor, WaLabel);
  1148. Owned<IPropertyTreeIterator> attrs = cur.getElements("att");
  1149. ForEach(*attrs)
  1150. {
  1151. IPropertyTree & cur = attrs->query();
  1152. WuAttr attr = queryGraphChildAttToWuAttr(cur.queryProp("@name"));
  1153. if (attr != WaNone)
  1154. visitor.noteAttribute(attr, cur.queryProp("@value"));
  1155. }
  1156. }
  1157. if (whichProperties & PThints)
  1158. {
  1159. Owned<IPropertyTreeIterator> hints = cur.getElements("hint");
  1160. ForEach(*hints)
  1161. {
  1162. IPropertyTree & cur = hints->query();
  1163. visitor.noteHint(cur.queryProp("@name"), cur.queryProp("@value"));
  1164. }
  1165. }
  1166. break;
  1167. }
  1168. case SSTedge:
  1169. if (whichProperties & PTattributes)
  1170. {
  1171. //MORE This will eventually need to walk the attributes and map the names.
  1172. //Need to be careful if they need to be mapped differently depending on the context.
  1173. playAttribute(visitor, WaLabel);
  1174. playAttribute(visitor, WaIdSource);
  1175. playAttribute(visitor, WaIdTarget);
  1176. playAttribute(visitor, WaSourceIndex);
  1177. playAttribute(visitor, WaTargetIndex);
  1178. playAttribute(visitor, WaIsDependency);
  1179. }
  1180. break;
  1181. }
  1182. }
  1183. virtual bool getStat(StatisticKind kind, unsigned __int64 & value) const override
  1184. {
  1185. return false;
  1186. }
  1187. virtual const char * queryAttribute(WuAttr attr, StringBuffer & scratchpad) const override
  1188. {
  1189. if (!treeIters.ordinality())
  1190. return nullptr;
  1191. //MORE - check that the attribute is value for the current scope type (to prevent defaults being returned)
  1192. return queryAttributeValue(treeIters.tos().query(), attr, scratchpad);
  1193. }
  1194. virtual const char * queryHint(const char * kind) const override
  1195. {
  1196. //MORE: Needs to be implemented!
  1197. return nullptr;
  1198. }
  1199. private:
  1200. void playAttribute(IWuScopeVisitor & visitor, WuAttr kind)
  1201. {
  1202. StringBuffer scratchpad;
  1203. const char * value = queryAttributeValue(treeIters.tos().query(), kind, scratchpad);
  1204. if (value)
  1205. visitor.noteAttribute(kind, value);
  1206. }
  1207. void pushIterator(IPropertyTreeIterator * iter, State state)
  1208. {
  1209. treeIters.append(*LINK(iter));
  1210. stateStack.append(state);
  1211. }
  1212. State popIterator()
  1213. {
  1214. treeIters.pop();
  1215. return (State)stateStack.popGet();
  1216. }
  1217. void pushScope(const char * id)
  1218. {
  1219. scopeLengths.append(curScopeName.length());
  1220. curScopeName.append(":").append(id);
  1221. }
  1222. void popScope()
  1223. {
  1224. curScopeName.setLength(scopeLengths.popGet());
  1225. }
  1226. bool doNextScope()
  1227. {
  1228. for(;;)
  1229. {
  1230. switch (state)
  1231. {
  1232. case SGraph:
  1233. {
  1234. IConstWUGraph & graph = graphIter->query();
  1235. unsigned wfid = graph.getWfid();
  1236. curScopeName.clear();
  1237. if (wfid != 0)
  1238. curScopeName.append(WorkflowScopePrefix).append(wfid).append(':');
  1239. graph.getName(StringBufferAdaptor(curScopeName));
  1240. scopeType = SSTgraph;
  1241. return true;
  1242. }
  1243. case SSubGraph:
  1244. scopeId.set(SubGraphScopePrefix).append(treeIters.tos().query().getPropInt("@id"));
  1245. pushScope(scopeId);
  1246. scopeType = SSTsubgraph;
  1247. return true;
  1248. case SEdge:
  1249. scopeId.set(EdgeScopePrefix).append(treeIters.tos().query().queryProp("@id"));
  1250. pushScope(scopeId);
  1251. scopeType = SSTedge;
  1252. return true;
  1253. case SActivity:
  1254. if (treeIters.tos().query().getPropInt("att[@name='_kind']/@value") == TAKsubgraph)
  1255. {
  1256. state = SActivityNext;
  1257. break;
  1258. }
  1259. scopeId.set(ActivityScopePrefix).append(treeIters.tos().query().getPropInt("@id"));
  1260. pushScope(scopeId);
  1261. scopeType = SSTactivity;
  1262. return true;
  1263. case SChildGraph:
  1264. {
  1265. unsigned numIters = treeIters.ordinality();
  1266. //This should really be implemented by a filter on the node - but it would require _kind/_parentActivity to move to the node tag
  1267. if (treeIters.tos().query().getPropInt("att[@name='_kind']/@value") != TAKsubgraph)
  1268. {
  1269. state = SChildGraphNext;
  1270. break;
  1271. }
  1272. unsigned parentActivityId = treeIters.item(numIters-2).query().getPropInt("@id");
  1273. unsigned parentId = treeIters.tos().query().getPropInt("att[@name='_parentActivity']/@value");
  1274. if (parentId != parentActivityId)
  1275. {
  1276. state = SChildGraphNext;
  1277. break;
  1278. }
  1279. scopeId.set(ChildGraphScopePrefix).append(treeIters.tos().query().getPropInt("@id"));
  1280. pushScope(scopeId);
  1281. scopeType = SSTchildgraph;
  1282. return true;
  1283. }
  1284. //Graph iteration
  1285. case SGraphFirst:
  1286. if (!graphIter->first())
  1287. state = SDone;
  1288. else
  1289. state = SGraph;
  1290. break;
  1291. case SGraphEnd:
  1292. state = SGraphNext;
  1293. break;
  1294. case SGraphNext:
  1295. if (!graphIter->next())
  1296. state = SDone;
  1297. else
  1298. state = SGraph;
  1299. break;
  1300. //Edge iteration
  1301. case SGraphFirstEdge:
  1302. {
  1303. //Walk dependencies - should possibly have a different SST e.g., SSTdependency since they do not
  1304. //share many characteristics with edges - e.g. no flowing records => few/no stats.
  1305. curGraph.setown(graphIter->query().getXGMMLTree(false));
  1306. Owned<IPropertyTreeIterator> treeIter = curGraph->getElements("edge");
  1307. if (treeIter && treeIter->first())
  1308. {
  1309. treeIter.setown(createSortedIterator(*treeIter, compareEdgeNode));
  1310. treeIter->first();
  1311. pushIterator(treeIter, SGraphFirstSubGraph);
  1312. state = SEdge;
  1313. }
  1314. else
  1315. state = SGraphFirstSubGraph;
  1316. break;
  1317. }
  1318. case SChildGraphFirstEdge:
  1319. {
  1320. Owned<IPropertyTreeIterator> treeIter = treeIters.tos().query().getElements("att/graph/edge");
  1321. if (treeIter && treeIter->first())
  1322. {
  1323. treeIter.setown(createSortedIterator(*treeIter, compareEdgeNode));
  1324. pushIterator(treeIter, SChildGraphFirstSubGraph);
  1325. state = SEdge;
  1326. }
  1327. else
  1328. state = SChildGraphFirstSubGraph;
  1329. break;
  1330. }
  1331. case SEdgeEnd:
  1332. popScope();
  1333. state = SEdgeNext;
  1334. break;
  1335. case SEdgeNext:
  1336. if (treeIters.tos().next())
  1337. state = SEdge;
  1338. else
  1339. state = popIterator();
  1340. break;
  1341. //Subgraph iteration
  1342. case SGraphFirstSubGraph:
  1343. {
  1344. Owned<IPropertyTreeIterator> treeIter = curGraph->getElements("node");
  1345. if (treeIter && treeIter->first())
  1346. {
  1347. treeIter.setown(createSortedIterator(*treeIter, compareSubGraphNode));
  1348. treeIter->first();
  1349. pushIterator(treeIter, SGraphNext);
  1350. state = SSubGraph;
  1351. }
  1352. else
  1353. state = SGraphNext;
  1354. break;
  1355. }
  1356. case SChildGraphFirstSubGraph:
  1357. {
  1358. Owned<IPropertyTreeIterator> treeIter = treeIters.tos().query().getElements("att/graph/node");
  1359. if (treeIter && treeIter->first())
  1360. {
  1361. treeIter.setown(createSortedIterator(*treeIter, compareSubGraphNode));
  1362. pushIterator(treeIter, SChildGraphEnd);
  1363. state = SSubGraph;
  1364. }
  1365. else
  1366. state = SChildGraphEnd;
  1367. break;
  1368. }
  1369. case SSubGraphFirstEdge:
  1370. {
  1371. Owned<IPropertyTreeIterator> treeIter = treeIters.tos().query().getElements("att/graph/edge");
  1372. if (treeIter && treeIter->first())
  1373. {
  1374. treeIter.setown(createSortedIterator(*treeIter, compareEdgeNode));
  1375. pushIterator(treeIter, SSubGraphFirstActivity);
  1376. state = SEdge;
  1377. }
  1378. else
  1379. state = SSubGraphFirstActivity;
  1380. break;
  1381. }
  1382. case SSubGraphFirstActivity:
  1383. {
  1384. Owned<IPropertyTreeIterator> treeIter = treeIters.tos().query().getElements("att/graph/node");
  1385. if (treeIter && treeIter->first())
  1386. {
  1387. treeIter.setown(createSortedIterator(*treeIter, compareActivityNode));
  1388. pushIterator(treeIter, SSubGraphEnd);
  1389. state = SActivity;
  1390. }
  1391. else
  1392. state = SSubGraphEnd;
  1393. break;
  1394. }
  1395. case SSubGraphEnd:
  1396. popScope();
  1397. state = SSubGraphNext;
  1398. break;
  1399. case SChildGraphEnd:
  1400. popScope();
  1401. state = SChildGraphNext;
  1402. break;
  1403. case SSubGraphNext:
  1404. if (treeIters.tos().next())
  1405. state = SSubGraph;
  1406. else
  1407. state = popIterator();
  1408. break;
  1409. case SActivityEnd:
  1410. popScope();
  1411. state = SActivityNext;
  1412. break;
  1413. case SActivityNext:
  1414. if (treeIters.tos().next())
  1415. state = SActivity;
  1416. else
  1417. state = popIterator();
  1418. break;
  1419. case SChildGraphNext:
  1420. if (treeIters.tos().next())
  1421. state = SChildGraph;
  1422. else
  1423. state = popIterator();
  1424. break;
  1425. case SChildGraphFirst:
  1426. {
  1427. unsigned numIters = treeIters.ordinality();
  1428. IPropertyTreeIterator & graphIter = treeIters.item(numIters-2);
  1429. Owned<IPropertyTreeIterator> treeIter = graphIter.query().getElements("att/graph/node");
  1430. //Really want to filter by <att name="_parentActivity" value="<parentid>">
  1431. if (treeIter && treeIter->first())
  1432. {
  1433. treeIter.setown(createSortedIterator(*treeIter, compareSubGraphNode));
  1434. pushIterator(treeIter, SActivityEnd);
  1435. state = SChildGraph;
  1436. }
  1437. else
  1438. state = SActivityEnd;
  1439. break;
  1440. }
  1441. case SDone:
  1442. return false;
  1443. default:
  1444. throwUnexpected();
  1445. }
  1446. }
  1447. }
  1448. bool nextScope()
  1449. {
  1450. for(;;)
  1451. {
  1452. if (!doNextScope())
  1453. return false;
  1454. ScopeCompare cmp = filter.compare(curScopeName);
  1455. if (cmp & SCequal)
  1456. return true;
  1457. //MORE: Optimize next based on result of compare
  1458. if (!selectNext())
  1459. return false;
  1460. }
  1461. }
  1462. bool selectNext()
  1463. {
  1464. switch (state)
  1465. {
  1466. case SGraph:
  1467. state = SGraphFirstEdge;
  1468. break;
  1469. case SChildGraph:
  1470. state = SChildGraphFirstEdge;
  1471. break;
  1472. case SSubGraph:
  1473. state = SSubGraphFirstEdge;
  1474. break;
  1475. case SEdge:
  1476. state = SEdgeEnd;
  1477. break;
  1478. case SActivity:
  1479. state = SChildGraphFirst;
  1480. break;
  1481. case SDone:
  1482. return false;
  1483. default:
  1484. throwUnexpected();
  1485. }
  1486. return true;
  1487. }
  1488. bool selectNextSibling()
  1489. {
  1490. switch (state)
  1491. {
  1492. case SGraph:
  1493. state = SGraphEnd;
  1494. break;
  1495. case SChildGraph:
  1496. state = SChildGraphEnd;
  1497. break;
  1498. case SSubGraph:
  1499. state = SSubGraphEnd;
  1500. break;
  1501. case SEdge:
  1502. state = SEdgeEnd;
  1503. break;
  1504. case SActivity:
  1505. state = SActivityEnd;
  1506. break;
  1507. case SDone:
  1508. return false;
  1509. default:
  1510. throwUnexpected();
  1511. }
  1512. return true;
  1513. }
  1514. bool selectNextParent()
  1515. {
  1516. switch (state)
  1517. {
  1518. case SGraph:
  1519. state = SDone;
  1520. break;
  1521. case SChildGraph:
  1522. case SSubGraph:
  1523. case SEdge:
  1524. case SActivity:
  1525. popScope();
  1526. state = popIterator();
  1527. break;
  1528. case SDone:
  1529. return false;
  1530. default:
  1531. throwUnexpected();
  1532. }
  1533. return true;
  1534. }
  1535. protected:
  1536. const ScopeFilter & filter;
  1537. Owned<IConstWUGraphIterator> graphIter;
  1538. Owned<IPropertyTree> curGraph;
  1539. IArrayOf<IPropertyTreeIterator> treeIters;
  1540. UnsignedArray scopeLengths;
  1541. UnsignedArray stateStack;
  1542. StringBuffer curScopeName;
  1543. StringBuffer scopeId;
  1544. StatisticScopeType scopeType = SSTnone;
  1545. };
  1546. static int compareWorkflow(IInterface * const * pLeft, IInterface * const * pRight)
  1547. {
  1548. IConstWorkflowItem * left = static_cast<IConstWorkflowItem *>(*pLeft);
  1549. IConstWorkflowItem * right = static_cast<IConstWorkflowItem *>(*pRight);
  1550. return left->queryWfid() - right->queryWfid();
  1551. }
  1552. static const char * trueToStr(bool value) { return value ? "true" : nullptr; }
  1553. /*
  1554. * An implementation of IConstWUScopeIterator for the workflow information.
  1555. */
  1556. class WorkflowStatisticsScopeIterator : public CInterfaceOf<IConstWUScopeIterator>
  1557. {
  1558. public:
  1559. WorkflowStatisticsScopeIterator(IConstWorkflowItemIterator * wfIter)
  1560. {
  1561. ForEach(*wfIter)
  1562. workflow.append(*LINK(wfIter->query()));
  1563. workflow.sort(compareWorkflow);
  1564. }
  1565. virtual bool first() override
  1566. {
  1567. if (workflow.empty())
  1568. return false;
  1569. curWorkflow = 0;
  1570. return initWorkflowItem();
  1571. }
  1572. virtual bool next() override
  1573. {
  1574. if (!workflow.isItem(++curWorkflow))
  1575. return false;
  1576. return initWorkflowItem();
  1577. }
  1578. virtual bool nextSibling() override
  1579. {
  1580. return next();
  1581. }
  1582. virtual bool nextParent() override
  1583. {
  1584. curWorkflow = NotFound;
  1585. return false;
  1586. }
  1587. virtual bool isValid() override
  1588. {
  1589. return workflow.isItem(curWorkflow);
  1590. }
  1591. virtual const char * queryScope() const override
  1592. {
  1593. return curScope.str();
  1594. }
  1595. virtual StatisticScopeType getScopeType() const override
  1596. {
  1597. return SSTworkflow;
  1598. }
  1599. virtual void playProperties(IWuScopeVisitor & visitor, WuPropertyTypes whichProperties) override
  1600. {
  1601. if (whichProperties & PTattributes)
  1602. {
  1603. #if 0
  1604. //Enable this code when the mapping from multiple instance attributes to lists is implemented in the service layer above
  1605. //At that point remove WaDependencyList from the list below.
  1606. {
  1607. StringBuffer scratchpad;
  1608. Owned<IWorkflowDependencyIterator> depends = workflow.item(curWorkflow).getDependencies();
  1609. ForEach(*depends)
  1610. visitor.noteAttribute(WaIdDependency, getValueText(depends->query(), scratchpad, WorkflowScopePrefix));
  1611. }
  1612. #endif
  1613. play(visitor, { WaIdDependencyList, WaIsScheduled, WaIdSuccess, WaIdFailure, WaIdRecovery, WaIdPersist, WaIdScheduled,
  1614. WaPersistName, WaLabel, WaMode, WaType, WaState, WaCluster, WaCriticalSection });
  1615. }
  1616. }
  1617. virtual bool getStat(StatisticKind kind, unsigned __int64 & value) const override
  1618. {
  1619. return false;
  1620. }
  1621. virtual const char * queryAttribute(WuAttr attr, StringBuffer & scratchpad) const override
  1622. {
  1623. auto wf = &workflow.item(curWorkflow);
  1624. StringBufferAdaptor adaptor(scratchpad);
  1625. switch (attr)
  1626. {
  1627. case WaIdDependencyList:
  1628. {
  1629. bool first = true;
  1630. Owned<IWorkflowDependencyIterator> depends = workflow.item(curWorkflow).getDependencies();
  1631. ForEach(*depends)
  1632. {
  1633. if (first)
  1634. scratchpad.append("[");
  1635. else
  1636. scratchpad.append(",");
  1637. scratchpad.append('"').append(WorkflowScopePrefix).append(depends->query()).append('"');
  1638. first = false;
  1639. }
  1640. if (first)
  1641. return nullptr;
  1642. scratchpad.append("]");
  1643. return scratchpad.str();
  1644. }
  1645. case WaIsScheduled: return trueToStr(wf->isScheduled());
  1646. case WaIdSuccess: return getWfidText(wf->querySuccess(), scratchpad);
  1647. case WaIdFailure: return getWfidText(wf->queryFailure(), scratchpad);
  1648. case WaIdRecovery: return getWfidText(wf->queryRecovery(), scratchpad);
  1649. case WaIdPersist: return getWfidText(wf->queryPersistWfid(), scratchpad);
  1650. case WaIdScheduled: return getWfidText(wf->queryScheduledWfid(), scratchpad);
  1651. case WaPersistName: return queryOptString(wf->getPersistName(adaptor));
  1652. case WaLabel: return queryOptString(wf->getLabel(adaptor));
  1653. case WaMode: return wf->queryMode() != WFModeNormal ? queryWorkflowModeText(wf->queryMode()) : nullptr;
  1654. case WaType: return wf->queryType() != WFTypeNormal ? queryWorkflowTypeText(wf->queryType()) : nullptr;
  1655. case WaState: return queryWorkflowStateText(wf->queryState());
  1656. case WaCluster: return queryOptString(wf->queryCluster(adaptor));
  1657. case WaCriticalSection: return queryOptString(wf->getCriticalName(adaptor));
  1658. /*
  1659. The followng attributes are not generated - I'm not convinced they are very useful, but they could be added later.
  1660. virtual bool isScheduledNow() const = 0;
  1661. virtual IWorkflowEvent * getScheduleEvent() const = 0;
  1662. virtual unsigned querySchedulePriority() const = 0;
  1663. virtual bool hasScheduleCount() const = 0;
  1664. virtual unsigned queryScheduleCount() const = 0;
  1665. virtual unsigned queryRetriesAllowed() const = 0;
  1666. virtual int queryPersistCopies() const = 0; // 0 - unmangled name, < 0 - use default, > 0 - max number
  1667. virtual bool queryPersistRefresh() const = 0;
  1668. virtual unsigned queryScheduleCountRemaining() const = 0;
  1669. virtual unsigned queryRetriesRemaining() const = 0;
  1670. virtual int queryFailCode() const = 0;
  1671. virtual const char * queryFailMessage() const = 0;
  1672. virtual const char * queryEventName() const = 0;
  1673. virtual const char * queryEventExtra() const = 0;
  1674. */
  1675. }
  1676. return nullptr;
  1677. }
  1678. virtual const char * queryHint(const char * kind) const
  1679. {
  1680. return nullptr;
  1681. }
  1682. protected:
  1683. bool initWorkflowItem()
  1684. {
  1685. curScope.clear().append(WorkflowScopePrefix).append(workflow.item(curWorkflow).queryWfid());
  1686. return true;
  1687. }
  1688. const char * getValueText(unsigned value, StringBuffer & scratchpad, const char * prefix = nullptr) const
  1689. {
  1690. return scratchpad.clear().append(prefix).append(value).str();
  1691. }
  1692. const char * queryOptString(IStringVal & value) const
  1693. {
  1694. const char * text = value.str();
  1695. if (!text || !*text)
  1696. return nullptr;
  1697. return text;
  1698. }
  1699. const char * getWfidText(unsigned value, StringBuffer & scratchpad) const
  1700. {
  1701. if (!value)
  1702. return nullptr;
  1703. return scratchpad.clear().append(WorkflowScopePrefix).append(value).str();
  1704. }
  1705. void play(IWuScopeVisitor & visitor, const std::initializer_list<WuAttr> & attrs) const
  1706. {
  1707. StringBuffer scratchpad;
  1708. for (auto attr : attrs)
  1709. {
  1710. const char * value = queryAttribute(attr, scratchpad.clear());
  1711. if (value)
  1712. visitor.noteAttribute(attr, value);
  1713. }
  1714. }
  1715. protected:
  1716. IArrayOf<IConstWorkflowItem> workflow;
  1717. unsigned curWorkflow = 0;
  1718. StringBuffer curScope;
  1719. };
  1720. /*
  1721. * An implementation of IConstWUScopeIterator that combines results from multiple sources.
  1722. */
  1723. class CompoundStatisticsScopeIterator : public CInterfaceOf<IConstWUScopeIterator>
  1724. {
  1725. class VisitorMapper : implements IWuScopeVisitor
  1726. {
  1727. public:
  1728. VisitorMapper(const WuScopeFilter & _filter, IWuScopeVisitor & _visitor) :
  1729. filter(_filter), visitor(_visitor)
  1730. {}
  1731. virtual void noteStatistic(StatisticKind kind, unsigned __int64 value, IConstWUStatistic & extra) override
  1732. {
  1733. if (filter.includeStatistic(kind))
  1734. visitor.noteStatistic(kind, value, extra);
  1735. }
  1736. virtual void noteAttribute(WuAttr attr, const char * value) override
  1737. {
  1738. if (filter.includeAttribute(attr))
  1739. visitor.noteAttribute(attr, value);
  1740. }
  1741. virtual void noteHint(const char * kind, const char * value) override
  1742. {
  1743. if (filter.includeHint(kind))
  1744. visitor.noteHint(kind, value);
  1745. }
  1746. protected:
  1747. const WuScopeFilter & filter;
  1748. IWuScopeVisitor & visitor;
  1749. };
  1750. public:
  1751. CompoundStatisticsScopeIterator(const WuScopeFilter & _filter) : filter(_filter)
  1752. {
  1753. }
  1754. void addIter(IConstWUScopeIterator * iter)
  1755. {
  1756. if (iter)
  1757. {
  1758. iters.append(OLINK(*iter));
  1759. assertex(iters.ordinality() <= sizeof(activeIterMask)*8);
  1760. }
  1761. }
  1762. virtual bool first() override
  1763. {
  1764. activeIterMask = 0;
  1765. ForEachItemIn(i, iters)
  1766. {
  1767. if (iters.item(i).first())
  1768. activeIterMask |= (1U << i);
  1769. }
  1770. return findNextScope();
  1771. }
  1772. virtual bool next() override
  1773. {
  1774. selectNext();
  1775. return findNextScope();
  1776. }
  1777. virtual bool nextSibling() override
  1778. {
  1779. selectNextSibling();
  1780. return findNextScope();
  1781. }
  1782. virtual bool nextParent() override
  1783. {
  1784. selectNextParent();
  1785. return findNextScope();
  1786. }
  1787. virtual bool isValid() override
  1788. {
  1789. return (activeIterMask != 0);
  1790. }
  1791. virtual const char * queryScope() const override
  1792. {
  1793. return iters.item(firstMatchIter).queryScope();
  1794. }
  1795. virtual StatisticScopeType getScopeType() const override
  1796. {
  1797. return iters.item(firstMatchIter).getScopeType();
  1798. }
  1799. virtual void playProperties(IWuScopeVisitor & visitor, WuPropertyTypes whichProperties) override
  1800. {
  1801. VisitorMapper mappedVisitor(filter, visitor);
  1802. whichProperties &= filter.properties;
  1803. ForEachItemIn(i, iters)
  1804. {
  1805. if (iterMatchesCurrentScope(i))
  1806. iters.item(i).playProperties(mappedVisitor, whichProperties);
  1807. }
  1808. }
  1809. virtual bool getStat(StatisticKind kind, unsigned __int64 & value) const override
  1810. {
  1811. ForEachItemIn(i, iters)
  1812. {
  1813. if (iterMatchesCurrentScope(i))
  1814. {
  1815. if (iters.item(i).getStat(kind, value))
  1816. return true;
  1817. }
  1818. }
  1819. return false;
  1820. }
  1821. virtual const char * queryAttribute(WuAttr attr, StringBuffer & scratchpad) const override
  1822. {
  1823. ForEachItemIn(i, iters)
  1824. {
  1825. if (iterMatchesCurrentScope(i))
  1826. {
  1827. const char * value = iters.item(i).queryAttribute(attr, scratchpad);
  1828. if (value)
  1829. return value;
  1830. }
  1831. }
  1832. return nullptr;
  1833. }
  1834. virtual const char * queryHint(const char * kind) const override
  1835. {
  1836. ForEachItemIn(i, iters)
  1837. {
  1838. if (iterMatchesCurrentScope(i))
  1839. {
  1840. const char * value = iters.item(i).queryHint(kind);
  1841. if (value)
  1842. return value;
  1843. }
  1844. }
  1845. return nullptr;
  1846. }
  1847. inline bool iterMatchesCurrentScope(unsigned i) const { return ((1U << i) & matchIterMask) != 0; }
  1848. inline bool isAlive(unsigned i) const { return ((1U << i) & activeIterMask) != 0; }
  1849. protected:
  1850. //Calculate which iterators contain the scope that should come next
  1851. bool findNextScope()
  1852. {
  1853. for(;;)
  1854. {
  1855. if (activeIterMask == 0)
  1856. return false;
  1857. unsigned mask = 0;
  1858. const char * scope = nullptr;
  1859. ForEachItemIn(i, iters)
  1860. {
  1861. if (isAlive(i))
  1862. {
  1863. const char * iterScope = iters.item(i).queryScope();
  1864. if (mask)
  1865. {
  1866. int compare = compareScopeName(scope, iterScope);
  1867. if (compare == 0)
  1868. {
  1869. mask |= (1U << i);
  1870. }
  1871. else if (compare > 0)
  1872. {
  1873. scope = iterScope;
  1874. mask = (1U << i);
  1875. firstMatchIter = i;
  1876. }
  1877. }
  1878. else
  1879. {
  1880. scope = iterScope;
  1881. mask = (1U << i);
  1882. firstMatchIter = i;
  1883. }
  1884. }
  1885. }
  1886. matchIterMask = mask;
  1887. while (activeScopes)
  1888. {
  1889. const char * activeScope = activeScopes.tos();
  1890. //If the next scope if not a child of one of the active scopes then that active scope will no longer match.
  1891. if (compareScopes(scope, activeScope) & SCchild)
  1892. break;
  1893. activeScopes.pop();
  1894. }
  1895. //The top most scope will be the deepest. Check if the current scope is close enough to return as a match.
  1896. bool include = false;
  1897. if (activeScopes)
  1898. {
  1899. const char * activeScope = activeScopes.tos();
  1900. //code above has ensured that this scope must be a child of (and therefore deeper) than activeScope
  1901. unsigned nesting = queryScopeDepth(scope) - queryScopeDepth(activeScope);
  1902. if (nesting <= filter.include.nestedDepth)
  1903. include = true;
  1904. }
  1905. //Check to see if this is a new match
  1906. if (filter.compareMatchScopes(scope) & SCequal)
  1907. {
  1908. if (!include)
  1909. include = filter.include.matchedScope;
  1910. //Only add it to the list of active scopes if it can match child elements
  1911. if (filter.include.nestedDepth != 0)
  1912. activeScopes.append(scope);
  1913. }
  1914. if (include)
  1915. {
  1916. if (!filter.includeScope(scope))
  1917. include = false;
  1918. else if (filter.requiredStats.size())
  1919. {
  1920. //MORE: This would be cleaner as a member of filter - but it needs access to the stats.
  1921. for (unsigned iReq=0; iReq < filter.requiredStats.size(); iReq++)
  1922. {
  1923. const StatisticValueFilter & cur = filter.requiredStats[iReq];
  1924. unsigned __int64 value;
  1925. if (getStat(cur.queryKind(), value))
  1926. {
  1927. if (!cur.matches(value))
  1928. include = false;
  1929. }
  1930. else
  1931. include = false;
  1932. }
  1933. }
  1934. }
  1935. if (include)
  1936. return true;
  1937. //MORE: Optimize based on filter.compareScope()
  1938. selectNext();
  1939. }
  1940. }
  1941. void checkScopeOrder(unsigned input, const char * prevScope)
  1942. {
  1943. if (isAlive(input))
  1944. {
  1945. const char * curScope = iters.item(input).queryScope();
  1946. int compare = compareScopeName(prevScope, curScope);
  1947. if (compare >= 0)
  1948. throw MakeStringException(0, "Out of order (%u) scopes %s,%s = %d", input, prevScope, curScope, compare);
  1949. }
  1950. }
  1951. void selectNext()
  1952. {
  1953. ForEachItemIn(i, iters)
  1954. {
  1955. if (iterMatchesCurrentScope(i))
  1956. {
  1957. #ifdef _DEBUG
  1958. StringBuffer prevScope(iters.item(i).queryScope());
  1959. #endif
  1960. if (!iters.item(i).next())
  1961. activeIterMask &= ~(1U << i);
  1962. #ifdef _DEBUG
  1963. checkScopeOrder(i, prevScope);
  1964. #endif
  1965. }
  1966. }
  1967. }
  1968. void selectNextSibling()
  1969. {
  1970. ForEachItemIn(i, iters)
  1971. {
  1972. if (iterMatchesCurrentScope(i))
  1973. {
  1974. #ifdef _DEBUG
  1975. StringBuffer prevScope(iters.item(i).queryScope());
  1976. #endif
  1977. if (!iters.item(i).nextSibling())
  1978. activeIterMask &= ~(1U << i);
  1979. #ifdef _DEBUG
  1980. checkScopeOrder(i, prevScope);
  1981. #endif
  1982. }
  1983. }
  1984. }
  1985. void selectNextParent()
  1986. {
  1987. ForEachItemIn(i, iters)
  1988. {
  1989. if (iterMatchesCurrentScope(i))
  1990. {
  1991. #ifdef _DEBUG
  1992. StringBuffer prevScope(iters.item(i).queryScope());
  1993. #endif
  1994. if (!iters.item(i).nextParent())
  1995. activeIterMask &= ~(1U << i);
  1996. #ifdef _DEBUG
  1997. checkScopeOrder(i, prevScope);
  1998. #endif
  1999. }
  2000. }
  2001. }
  2002. protected:
  2003. const WuScopeFilter & filter;
  2004. IArrayOf<IConstWUScopeIterator> iters;
  2005. unsigned curIter = 0;
  2006. unsigned firstMatchIter = 0;
  2007. unsigned matchIterMask = 0; // bit set of iterators which have a valid entry for the current scope
  2008. unsigned activeIterMask = 0; // bit set of iterators which are still active
  2009. StringArray activeScopes;
  2010. };
  2011. //---------------------------------------------------------------------------------------------------------------------
  2012. class AggregateFilter
  2013. {
  2014. public:
  2015. AggregateFilter(StatisticKind _search) : search(_search) {}
  2016. inline bool matches(StatisticKind kind, unsigned __int64 value, IConstWUStatistic & extra) const
  2017. {
  2018. return (kind == search);
  2019. }
  2020. protected:
  2021. StatisticKind search;
  2022. //MORE: Allow filtering by scope?
  2023. };
  2024. class StatisticAggregator : public CInterfaceOf<IWuScopeVisitor>
  2025. {
  2026. public:
  2027. StatisticAggregator(StatisticKind _search) : filter(_search) {}
  2028. virtual void noteAttribute(WuAttr attr, const char * value) override { throwUnexpected(); }
  2029. virtual void noteHint(const char * kind, const char * value) override { throwUnexpected(); }
  2030. protected:
  2031. AggregateFilter filter;
  2032. };
  2033. class SimpleAggregator : public StatisticAggregator
  2034. {
  2035. public:
  2036. SimpleAggregator(StatisticKind _search) : StatisticAggregator(_search) {}
  2037. virtual void noteStatistic(StatisticKind kind, unsigned __int64 value, IConstWUStatistic & extra) override
  2038. {
  2039. if (filter.matches(kind, value, extra))
  2040. summary.noteValue(value);
  2041. }
  2042. //How should these be reported? Should there be a playAggregates(IWuAggregatedScopeVisitor)
  2043. //with a noteAggregate(value, variant, value, grouping)?
  2044. protected:
  2045. StatsAggregation summary;
  2046. };
  2047. class SimpleReferenceAggregator : public StatisticAggregator
  2048. {
  2049. public:
  2050. SimpleReferenceAggregator(StatisticKind _search, StatsAggregation & _summary) : StatisticAggregator(_search), summary(_summary) {}
  2051. virtual void noteStatistic(StatisticKind kind, unsigned __int64 value, IConstWUStatistic & extra) override
  2052. {
  2053. if (filter.matches(kind, value, extra))
  2054. summary.noteValue(value);
  2055. }
  2056. //How should these be reported? Should there be a playAggregates(IWuAggregatedScopeVisitor)
  2057. //with a noteAggregate(value, variant, value, grouping)?
  2058. protected:
  2059. StatsAggregation & summary;
  2060. };
  2061. class GroupedAggregator : public StatisticAggregator
  2062. {
  2063. public:
  2064. virtual void noteStatistic(StatisticKind kind, unsigned __int64 value, IConstWUStatistic & extra) override
  2065. {
  2066. if (filter.matches(kind, value, extra))
  2067. {
  2068. StatsAggregation & match = summary; // look up in hash table.
  2069. match.noteValue(value);
  2070. }
  2071. }
  2072. protected:
  2073. //HashTable of (possible groupings->summary)
  2074. StatsAggregation summary;
  2075. };
  2076. class CompoundAggregator : implements StatisticAggregator
  2077. {
  2078. public:
  2079. virtual void noteStatistic(StatisticKind kind, unsigned __int64 value, IConstWUStatistic & extra)
  2080. {
  2081. ForEachItemIn(i, aggregators)
  2082. aggregators.item(i).noteStatistic(kind, value, extra);
  2083. }
  2084. protected:
  2085. IArrayOf<StatisticAggregator> aggregators;
  2086. };
  2087. //To calculate aggregates, create a scope iterator, and an instance of a StatisticAggregator, and play the attributes through the interface
  2088. //---------------------------------------------------------------------------------------------------------------------
  2089. //Extract an argument of the format abc[def[ghi...,]],... as (abc,def[...])
  2090. static bool extractOption(const char * & finger, StringBuffer & option, StringBuffer & arg)
  2091. {
  2092. const char * start = finger;
  2093. if (!*start)
  2094. return false;
  2095. const char * cur = start;
  2096. const char * bra = nullptr;
  2097. const char * end = nullptr;
  2098. unsigned braDepth = 0;
  2099. char next;
  2100. arg.clear();
  2101. for (;;)
  2102. {
  2103. next = *cur;
  2104. if (!next || ((next == ',') && (braDepth == 0)))
  2105. break;
  2106. switch (next)
  2107. {
  2108. case '[':
  2109. if (braDepth == 0)
  2110. {
  2111. if (bra)
  2112. throw makeStringExceptionV(0, "Multiple [ in filter : %s", bra);
  2113. bra = cur;
  2114. }
  2115. braDepth++;
  2116. break;
  2117. case ']':
  2118. if (braDepth > 0)
  2119. {
  2120. if (--braDepth == 0)
  2121. {
  2122. end = cur;
  2123. arg.append(cur - (bra+1), bra+1);
  2124. }
  2125. }
  2126. break;
  2127. }
  2128. cur++;
  2129. }
  2130. if (braDepth != 0)
  2131. throw makeStringExceptionV(0, "Mismatched ] in filter : %s", start);
  2132. option.clear();
  2133. if (bra)
  2134. {
  2135. if (cur != end+1)
  2136. throw makeStringExceptionV(0, "Text follows closing bracket: %s", end);
  2137. option.append(bra-start, start);
  2138. }
  2139. else
  2140. option.append(cur-start, start);
  2141. if (next)
  2142. finger = cur+1;
  2143. else
  2144. finger = cur;
  2145. return true;
  2146. }
  2147. static unsigned readOptValue(const char * start, const char * end, unsigned dft, const char * type)
  2148. {
  2149. if (start == end)
  2150. return dft;
  2151. char * next;
  2152. unsigned value = (unsigned)strtoll(start, &next, 10);
  2153. if (next != end)
  2154. throw makeStringExceptionV(0, "Unexpected characters in %s option '%s'", type, next);
  2155. return value;
  2156. }
  2157. static unsigned readValue(const char * start, const char * type)
  2158. {
  2159. if (*start == '\0')
  2160. throw makeStringExceptionV(0, "Expected a value for the %s option", type);
  2161. char * next;
  2162. unsigned value = (unsigned)strtoll(start, &next, 10);
  2163. if (*next != '\0')
  2164. throw makeStringExceptionV(0, "Unexpected characters in %s option '%s'", type, next);
  2165. return value;
  2166. }
  2167. /*
  2168. Scope service matching Syntax: * indicates
  2169. Which items are matched:
  2170. scope[<scope-id>]* | stype[<scope-type>]* | id[<id>]* - which scopes should be matched?
  2171. depth[n | low..high] - range of depths to search for a match
  2172. source[global|stats|graph|all]* - which sources to search within the workunit
  2173. where[<statistickind> | <statistickind> (=|<|<=|>|>=) value | <statistickind>=low..high] - a statistic filter
  2174. Which items are include in the results:
  2175. matched[true|false] - are the matched scopes returned?
  2176. nested[<depth>|all] - how deep within a scope should be matched (default = 0 if matched[true], all if matched[false])
  2177. includetype[<scope-type>] - which scope types should be included?
  2178. Which properties of the items are returned:
  2179. properties[statistics|hints|attributes|scope|all]
  2180. statistic[<statistic-kind>|none|all] - include statistic
  2181. attribute[<attribute-name>|none|all] - include attribute
  2182. hint[<hint-name>] - include hint
  2183. property[<statistic-kind>|<attribute-name>|<hint-name>] - include property
  2184. measure[<measure>] - all statistics with a particular measure
  2185. version[<version>] - minimum version to return
  2186. */
  2187. enum { FOscope, FOstype, FOid, FOdepth, FOsource, FOwhere, FOmatched, FOnested, FOinclude, FOproperties, FOstatistic, FOattribute, FOhint, FOproperty, FOmeasure, FOversion, FOunknown };
  2188. //Some of the following contains aliases for the same option e.g. stat and statistic
  2189. static constexpr EnumMapping filterOptions[] = {
  2190. { FOscope, "scope" }, { FOstype, "stype" }, { FOid, "id" },
  2191. { FOdepth, "depth" }, { FOsource, "source" }, { FOwhere, "where" },
  2192. { FOmatched, "matched" }, { FOnested, "nested" },
  2193. { FOinclude, "include" }, { FOinclude, "includetype" },
  2194. { FOproperties, "props" }, { FOproperties, "properties" }, // some aliases
  2195. { FOstatistic, "stat" }, { FOstatistic, "statistic" }, { FOattribute, "attr" }, { FOattribute, "attribute" }, { FOhint, "hint" },
  2196. { FOproperty, "prop" }, { FOproperty, "property" },
  2197. { FOmeasure, "measure" }, { FOversion, "version" }, { 0, nullptr} };
  2198. static constexpr EnumMapping sourceMappings[] = {
  2199. { SSFsearchGlobalStats, "global" }, { SSFsearchGraphStats, "stats" }, { SSFsearchGraphStats, "statistics" }, { SSFsearchGraph, "graph" }, { SSFsearchExceptions, "exception" }, { SSFsearchWorkflow, "workflow" },
  2200. { (int)SSFsearchAll, "all" }, { 0, nullptr } };
  2201. static constexpr EnumMapping propertyMappings[] = {
  2202. { PTstatistics, "stat" }, { PTstatistics, "statistic" }, { PTattributes, "attr" }, { PTattributes, "attribute" }, { PThints, "hint" },
  2203. { PTstatistics, "stats" }, { PTstatistics, "statistics" }, { PTattributes, "attrs" }, { PTattributes, "attributes" }, { PThints, "hints" },
  2204. { PTnone, "none" }, { PTscope, "scope" }, { PTall, "all" }, { 0, 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. if (queryStatisticKind(prop, StMax) != StMax)
  2342. addOutputStatistic(prop);
  2343. else if (queryWuAttribute(prop, WaMax) != WaMax)
  2344. addOutputAttribute(prop);
  2345. else
  2346. addOutputHint(prop);
  2347. return *this;
  2348. }
  2349. WuScopeFilter & WuScopeFilter::addOutputStatistic(const char * prop)
  2350. {
  2351. if (!prop)
  2352. return *this;
  2353. StatisticKind kind = queryStatisticKind(prop, StMax);
  2354. if (kind == StMax)
  2355. throw makeStringExceptionV(0, "Unrecognised statistic '%s'", prop);
  2356. return addOutputStatistic(kind);
  2357. }
  2358. WuScopeFilter & WuScopeFilter::addOutputStatistic(StatisticKind stat)
  2359. {
  2360. if (stat != StKindNone)
  2361. {
  2362. if (stat != StKindAll)
  2363. desiredStats.append(stat);
  2364. else
  2365. desiredStats.kill();
  2366. properties |= PTstatistics;
  2367. }
  2368. else
  2369. properties &= ~PTstatistics;
  2370. return *this;
  2371. }
  2372. WuScopeFilter & WuScopeFilter::addOutputAttribute(const char * prop)
  2373. {
  2374. if (!prop)
  2375. return *this;
  2376. WuAttr attr = queryWuAttribute(prop, WaMax);
  2377. if (attr == WaMax)
  2378. throw makeStringExceptionV(0, "Unrecognised attribute '%s'", prop);
  2379. return addOutputAttribute(attr);
  2380. }
  2381. WuScopeFilter & WuScopeFilter::addOutputAttribute(WuAttr attr)
  2382. {
  2383. if (attr != WaNone)
  2384. {
  2385. if (attr != WaAll)
  2386. desiredAttrs.append(attr);
  2387. else
  2388. desiredAttrs.kill();
  2389. properties |= PTattributes;
  2390. }
  2391. else
  2392. properties &= ~PTattributes;
  2393. return *this;
  2394. }
  2395. WuScopeFilter & WuScopeFilter::addOutputHint(const char * prop)
  2396. {
  2397. if (strieq(prop, "none"))
  2398. {
  2399. desiredHints.kill();
  2400. properties &= ~PThints;
  2401. }
  2402. else
  2403. {
  2404. if (!strieq(prop, "all"))
  2405. desiredHints.append(prop);
  2406. else
  2407. desiredHints.kill();
  2408. properties |= PThints;
  2409. }
  2410. return *this;
  2411. }
  2412. WuScopeFilter & WuScopeFilter::setIncludeMatch(bool value)
  2413. {
  2414. include.matchedScope = value;
  2415. return *this;
  2416. }
  2417. WuScopeFilter & WuScopeFilter::setIncludeNesting(unsigned depth)
  2418. {
  2419. include.nestedDepth = depth;
  2420. return *this;
  2421. }
  2422. WuScopeFilter & WuScopeFilter::setIncludeScopeType(const char * scopeType)
  2423. {
  2424. if (scopeType)
  2425. {
  2426. StatisticScopeType sst = queryScopeType(scopeType, SSTmax);
  2427. if (sst == SSTmax)
  2428. throw makeStringExceptionV(0, "Unrecognised scope type '%s'", scopeType);
  2429. include.scopeTypes.append(sst);
  2430. }
  2431. return *this;
  2432. }
  2433. WuScopeFilter & WuScopeFilter::setMeasure(const char * measure)
  2434. {
  2435. if (measure)
  2436. {
  2437. desiredMeasure = queryMeasure(measure, SMeasureNone);
  2438. if (desiredMeasure == SMeasureNone)
  2439. throw makeStringExceptionV(0, "Unrecognised measure '%s'", measure);
  2440. properties |= PTstatistics;
  2441. }
  2442. return *this;
  2443. }
  2444. WuScopeFilter & WuScopeFilter::addOutputProperties(WuPropertyTypes mask)
  2445. {
  2446. if (properties == PTnone)
  2447. properties = mask;
  2448. else
  2449. properties |= mask;
  2450. return *this;
  2451. }
  2452. WuScopeFilter & WuScopeFilter::addRequiredStat(StatisticKind statKind, stat_type lowValue, stat_type highValue)
  2453. {
  2454. requiredStats.emplace_back(statKind, lowValue, highValue);
  2455. return *this;
  2456. }
  2457. WuScopeFilter & WuScopeFilter::addRequiredStat(StatisticKind statKind)
  2458. {
  2459. requiredStats.emplace_back(statKind, 0, MaxStatisticValue);
  2460. return *this;
  2461. }
  2462. //process a filter in one of the following forms:
  2463. // <statistic-name>
  2464. // <statistic-name> (=|<|<=|>|>=) <value>
  2465. // <statistic-name>=[<low>]..[<high>]
  2466. void WuScopeFilter::addRequiredStat(const char * filter)
  2467. {
  2468. const char * stat = filter;
  2469. const char * cur = stat;
  2470. while (isalpha(*cur))
  2471. cur++;
  2472. StringBuffer statisticName(cur-stat, stat);
  2473. StatisticKind statKind = queryStatisticKind(statisticName, StKindNone);
  2474. if (statKind == StKindNone)
  2475. throw makeStringExceptionV(0, "Unknown statistic name '%s'", statisticName.str());
  2476. //Skip any spaces before a comparison operator.
  2477. while (*cur && isspace(*cur))
  2478. cur++;
  2479. //Save the operator, and skip over any non digits.
  2480. const char * op = cur;
  2481. switch (*op)
  2482. {
  2483. case '=':
  2484. cur++;
  2485. break;
  2486. case '<':
  2487. case '>':
  2488. if (op[1] == '=')
  2489. cur += 2;
  2490. else
  2491. cur++;
  2492. break;
  2493. case '\0':
  2494. break;
  2495. default:
  2496. throw makeStringExceptionV(0, "Unknown comparison '%s'", op);
  2497. }
  2498. const char * next;
  2499. stat_type value = readStatisticValue(cur, &next, queryMeasure(statKind));
  2500. stat_type lowValue = 0;
  2501. stat_type highValue = MaxStatisticValue;
  2502. switch (op[0])
  2503. {
  2504. case '=':
  2505. {
  2506. //Allow a,b or a..b to specify a range - either bound may be omitted.
  2507. if (next[0] == ',')
  2508. {
  2509. lowValue = value;
  2510. next++;
  2511. if (*next != '\0')
  2512. highValue = readStatisticValue(next, &next, queryMeasure(statKind));
  2513. }
  2514. else if (strncmp(next, "..", 2) == 0)
  2515. {
  2516. lowValue = value;
  2517. next += 2;
  2518. if (*next != '\0')
  2519. highValue = readStatisticValue(next, &next, queryMeasure(statKind));
  2520. }
  2521. else
  2522. {
  2523. lowValue = value;
  2524. highValue = value;
  2525. }
  2526. break;
  2527. }
  2528. case '<':
  2529. if (op[1] == '=')
  2530. highValue = value;
  2531. else
  2532. highValue = value-1;
  2533. break;
  2534. case '>':
  2535. if (op[1] == '=')
  2536. lowValue = value;
  2537. else
  2538. lowValue = value+1;
  2539. break;
  2540. }
  2541. if (*next)
  2542. throw makeStringExceptionV(0, "Trailing characters in where '%s'", next);
  2543. requiredStats.emplace_back(statKind, lowValue, highValue);
  2544. }
  2545. WuScopeFilter & WuScopeFilter::addSource(const char * source)
  2546. {
  2547. WuScopeSourceFlags mask = (WuScopeSourceFlags)getEnum(source, sourceMappings, SSFunknown);
  2548. if (mask == SSFunknown)
  2549. throw makeStringExceptionV(0, "Unexpected source '%s'", source);
  2550. if (!mask)
  2551. sourceFlags = mask;
  2552. else
  2553. sourceFlags |= mask;
  2554. return *this;
  2555. }
  2556. WuScopeFilter & WuScopeFilter::setDepth(unsigned low, unsigned high)
  2557. {
  2558. scopeFilter.setDepth(low, high);
  2559. return *this;
  2560. }
  2561. bool WuScopeFilter::matchOnly(StatisticScopeType scopeType) const
  2562. {
  2563. //If there is a post filter on the scopeType, then check if it matches
  2564. if (include.scopeTypes.ordinality() == 1)
  2565. return (include.scopeTypes.item(0) == scopeType);
  2566. //If filter doesn't match nested items, then check if the scope filter matches.
  2567. if (include.nestedDepth == 0)
  2568. {
  2569. if (scopeFilter.matchOnly(scopeType))
  2570. return true;
  2571. }
  2572. return false;
  2573. }
  2574. //Called once the filter has been updated to optimize the filter
  2575. void WuScopeFilter::finishedFilter()
  2576. {
  2577. assertex(!optimized);
  2578. optimized = true;
  2579. if ((include.nestedDepth == 0) && !include.matchedScope)
  2580. include.nestedDepth = UINT_MAX;
  2581. preFilterScope = include.matchedScope && (include.nestedDepth == 0);
  2582. if (scopeFilter.canAlwaysPreFilter())
  2583. preFilterScope = true;
  2584. //If the source flags have not been explicitly set then calculate which sources will provide the results
  2585. if (!sourceFlags)
  2586. {
  2587. sourceFlags = SSFsearchAll;
  2588. //Use the other options to reduce the number of elements that are searched.
  2589. //If not interested in scopes on their own then...
  2590. if (!(properties & PTscope))
  2591. {
  2592. //Global stats and graph stats only contain stats => remove if not interested in them
  2593. if (!(properties & PTstatistics))
  2594. sourceFlags &= ~(SSFsearchGlobalStats|SSFsearchGraphStats);
  2595. //graph, workflow only contains attributes and hints => remove if not interested
  2596. if (!(properties & (PTattributes|PThints)))
  2597. sourceFlags &= ~(SSFsearchGraph|SSFsearchWorkflow);
  2598. }
  2599. }
  2600. //Optimize sources if they haven't been explicitly specified
  2601. //Most of the following are dependent on internal knowledge of the way that information is represented
  2602. if (matchOnly(SSTworkflow))
  2603. {
  2604. //Workflow is not nested within a graph
  2605. sourceFlags &= ~(SSFsearchGraph|SSFsearchGraphStats);
  2606. setDepth(1, 1);
  2607. }
  2608. else if (matchOnly(SSTgraph))
  2609. {
  2610. //Graph starts are stored globally, not in the graph stats.
  2611. sourceFlags &= ~(SSFsearchGraphStats|SSFsearchWorkflow);
  2612. if (!(properties & (PTattributes|PThints)))
  2613. sourceFlags &= ~(SSFsearchGraph);
  2614. setDepth(1, 1); // MORE - will become 2 once scopes are modified to include the workflow id.
  2615. }
  2616. else if (matchOnly(SSTsubgraph))
  2617. {
  2618. sourceFlags &= ~(SSFsearchWorkflow);
  2619. //subgraph timings are stored globally - otherwise need to look in the graph stats.
  2620. if (!(properties & (PTattributes|PThints)))
  2621. {
  2622. if (desiredStats.ordinality() == 1)
  2623. {
  2624. StatisticKind stat = (StatisticKind)desiredStats.item(0);
  2625. if (stat == StTimeElapsed || stat == StWhenStarted)
  2626. sourceFlags &= ~(SSFsearchGraphStats|SSFsearchGraph);
  2627. }
  2628. }
  2629. }
  2630. else if (matchOnly(SSTcompilestage))
  2631. {
  2632. //compile stages are not stored in the graph
  2633. sourceFlags &= ~(SSFsearchGraphStats|SSFsearchGraph|SSFsearchWorkflow);
  2634. }
  2635. else if (matchOnly(SSTactivity))
  2636. {
  2637. //information about activities is not stored globally
  2638. sourceFlags &= ~(SSFsearchGlobalStats|SSFsearchWorkflow);
  2639. }
  2640. // Everything stored in the graphs stats has a depth of 2 or more - so ignore if there are not matches in that depth
  2641. if ((include.nestedDepth == 0) && (scopeFilter.compareDepth(2) > 0))
  2642. {
  2643. sourceFlags &= ~(SSFsearchGraphStats);
  2644. }
  2645. if (scopeFilter.compareDepth(1) < 0)
  2646. {
  2647. //If minimum match depth is > 1 then it will never match workflow
  2648. sourceFlags &= ~(SSFsearchWorkflow);
  2649. }
  2650. //The xml graph is never updated, so do not check it if minVersion != 0
  2651. if (minVersion != 0)
  2652. {
  2653. sourceFlags &= ~(SSFsearchGraph|SSFsearchWorkflow);
  2654. }
  2655. }
  2656. bool WuScopeFilter::includeStatistic(StatisticKind kind) const
  2657. {
  2658. if (!(properties & PTstatistics))
  2659. return false;
  2660. if ((desiredMeasure != SMeasureAll) && (queryMeasure(kind) != desiredMeasure))
  2661. return false;
  2662. if (desiredStats.empty())
  2663. return true;
  2664. return desiredStats.contains(kind);
  2665. }
  2666. bool WuScopeFilter::includeAttribute(WuAttr attr) const
  2667. {
  2668. if (!(properties & PTattributes))
  2669. return false;
  2670. if (desiredAttrs.empty())
  2671. return true;
  2672. return desiredAttrs.contains(attr);
  2673. }
  2674. bool WuScopeFilter::includeHint(const char * kind) const
  2675. {
  2676. if (!(properties & PThints))
  2677. return false;
  2678. if (desiredHints.empty())
  2679. return true;
  2680. return desiredHints.contains(kind);
  2681. }
  2682. bool WuScopeFilter::includeScope(const char * scope) const
  2683. {
  2684. if (include.scopeTypes)
  2685. {
  2686. const char * tail = queryScopeTail(scope);
  2687. StatsScopeId id(tail);
  2688. if (!include.scopeTypes.contains(id.queryScopeType()))
  2689. return false;
  2690. }
  2691. return true;
  2692. }
  2693. const static ScopeFilter nullScopeFilter {};
  2694. const ScopeFilter & WuScopeFilter::queryIterFilter() const
  2695. {
  2696. if (preFilterScope)
  2697. return scopeFilter;
  2698. else
  2699. return nullScopeFilter;
  2700. }
  2701. ScopeCompare WuScopeFilter::compareMatchScopes(const char * scope) const
  2702. {
  2703. return scopeFilter.compare(scope);
  2704. }
  2705. //--------------------------------------------------------------------------------------------------------------------
  2706. EnumMapping states[] = {
  2707. { WUStateUnknown, "unknown" },
  2708. { WUStateCompiled, "compiled" },
  2709. { WUStateRunning, "running" },
  2710. { WUStateCompleted, "completed" },
  2711. { WUStateFailed, "failed" },
  2712. { WUStateArchived, "archived" },
  2713. { WUStateAborting, "aborting" },
  2714. { WUStateAborted, "aborted" },
  2715. { WUStateBlocked, "blocked" },
  2716. { WUStateSubmitted, "submitted" },
  2717. { WUStateScheduled, "scheduled" },
  2718. { WUStateCompiling, "compiling" },
  2719. { WUStateWait, "wait" },
  2720. { WUStateUploadingFiles, "uploading_files" },
  2721. { WUStateDebugPaused, "debugging" },
  2722. { WUStateDebugRunning, "debug_running" },
  2723. { WUStatePaused, "paused" },
  2724. { WUStateSize, NULL }
  2725. };
  2726. EnumMapping actions[] = {
  2727. { WUActionUnknown, "unknown" },
  2728. { WUActionCompile, "compile" },
  2729. { WUActionCheck, "check" },
  2730. { WUActionRun, "run" },
  2731. { WUActionExecuteExisting, "execute" },
  2732. { WUActionPause, "pause" },
  2733. { WUActionPauseNow, "pausenow" },
  2734. { WUActionResume, "resume" },
  2735. { WUActionSize, NULL },
  2736. };
  2737. EnumMapping priorityClasses[] = {
  2738. { PriorityClassUnknown, "unknown" },
  2739. { PriorityClassLow, "low" },
  2740. { PriorityClassNormal, "normal" },
  2741. { PriorityClassHigh, "high" },
  2742. { PriorityClassSize, NULL },
  2743. };
  2744. const char * getWorkunitStateStr(WUState state)
  2745. {
  2746. dbgassertex(state < WUStateSize);
  2747. return states[state].str; // MORE - should be using getEnumText, or need to take steps to ensure values remain contiguous and in order.
  2748. }
  2749. void setEnum(IPropertyTree *p, const char *propname, int value, const EnumMapping *map)
  2750. {
  2751. const char *defval = map->str;
  2752. while (map->str)
  2753. {
  2754. if (value==map->val)
  2755. {
  2756. p->setProp(propname, map->str);
  2757. return;
  2758. }
  2759. map++;
  2760. }
  2761. assertex(!"Unexpected value in setEnum");
  2762. p->setProp(propname, defval);
  2763. }
  2764. static int getEnum(const IPropertyTree *p, const char *propname, const EnumMapping *map)
  2765. {
  2766. return getEnum(p->queryProp(propname),map);
  2767. }
  2768. const char * getWorkunitActionStr(WUAction action)
  2769. {
  2770. return getEnumText(action, actions);
  2771. }
  2772. WUAction getWorkunitAction(const char *actionStr)
  2773. {
  2774. return (WUAction) getEnum(actionStr, actions);
  2775. }
  2776. //==========================================================================================
  2777. class CLightweightWorkunitInfo : public CInterfaceOf<IConstWorkUnitInfo>
  2778. {
  2779. public:
  2780. CLightweightWorkunitInfo(IPropertyTree &p)
  2781. {
  2782. wuid.set(p.queryName());
  2783. user.set(p.queryProp("@submitID"));
  2784. jobName.set(p.queryProp("@jobName"));
  2785. clusterName.set(p.queryProp("@clusterName"));
  2786. timeScheduled.set(p.queryProp("@timeScheduled"));
  2787. state = (WUState) getEnum(&p, "@state", states);
  2788. action = (WUAction) getEnum(&p, "Action", actions);
  2789. priority = (WUPriorityClass) getEnum(&p, "@priorityClass", priorityClasses);
  2790. priorityLevel = calcPriorityValue(&p);
  2791. wuscope.set(p.queryProp("@scope"));
  2792. appvalues.loadBranch(&p,"Application");
  2793. totalThorTime = (unsigned)nanoToMilli(extractTimeCollatable(p.queryProp("@totalThorTime"), false));
  2794. _isProtected = p.getPropBool("@protected", false);
  2795. }
  2796. virtual const char *queryWuid() const { return wuid.str(); }
  2797. virtual const char *queryUser() const { return user.str(); }
  2798. virtual const char *queryJobName() const { return jobName.str(); }
  2799. virtual const char *queryClusterName() const { return clusterName.str(); }
  2800. virtual const char *queryWuScope() const { return wuscope.str(); }
  2801. virtual WUState getState() const { return state; }
  2802. virtual const char *queryStateDesc() const { return getEnumText(state, states); }
  2803. virtual WUAction getAction() const { return action; }
  2804. virtual const char *queryActionDesc() const { return getEnumText(action, actions); }
  2805. virtual WUPriorityClass getPriority() const { return priority; }
  2806. virtual const char *queryPriorityDesc() const { return getEnumText(priority, priorityClasses); }
  2807. virtual int getPriorityLevel() const { return priorityLevel; }
  2808. virtual bool isProtected() const { return _isProtected; }
  2809. virtual IJlibDateTime & getTimeScheduled(IJlibDateTime & val) const
  2810. {
  2811. if (timeScheduled.length())
  2812. val.setGmtString(timeScheduled.str());
  2813. return val;
  2814. }
  2815. virtual unsigned getTotalThorTime() const { return totalThorTime; };
  2816. virtual IConstWUAppValueIterator & getApplicationValues() const { return *new CArrayIteratorOf<IConstWUAppValue,IConstWUAppValueIterator> (appvalues, 0, (IConstWorkUnitInfo *) this); };
  2817. protected:
  2818. StringAttr wuid, user, jobName, clusterName, timeScheduled, wuscope;
  2819. mutable CachedTags<CLocalWUAppValue,IConstWUAppValue> appvalues;
  2820. unsigned totalThorTime;
  2821. WUState state;
  2822. WUAction action;
  2823. WUPriorityClass priority;
  2824. int priorityLevel;
  2825. bool _isProtected;
  2826. };
  2827. extern IConstWorkUnitInfo *createConstWorkUnitInfo(IPropertyTree &p)
  2828. {
  2829. return new CLightweightWorkunitInfo(p);
  2830. }
  2831. class CDaliWuGraphStats : public CWuGraphStats
  2832. {
  2833. public:
  2834. CDaliWuGraphStats(IRemoteConnection *_conn, StatisticCreatorType _creatorType, const char * _creator, unsigned _wfid, const char * _rootScope, unsigned _id)
  2835. : CWuGraphStats(LINK(_conn->queryRoot()), _creatorType, _creator, _wfid, _rootScope, _id), conn(_conn)
  2836. {
  2837. }
  2838. protected:
  2839. Owned<IRemoteConnection> conn;
  2840. };
  2841. CWorkUnitWatcher::CWorkUnitWatcher(IWorkUnitSubscriber *_subscriber, WUSubscribeOptions flags, const char *wuid) : subscriber(_subscriber)
  2842. {
  2843. abortId = 0;
  2844. stateId = 0;
  2845. actionId = 0;
  2846. assertex((flags & ~SubscribeOptionAbort) == 0);
  2847. if (flags & SubscribeOptionAbort)
  2848. {
  2849. VStringBuffer xpath("/WorkUnitAborts/%s", wuid);
  2850. abortId = querySDS().subscribe(xpath.str(), *this);
  2851. }
  2852. }
  2853. CWorkUnitWatcher::~CWorkUnitWatcher()
  2854. {
  2855. assertex(abortId==0 && stateId==0 && actionId==0);
  2856. }
  2857. void CWorkUnitWatcher::unsubscribe()
  2858. {
  2859. CriticalBlock b(crit);
  2860. if (abortId)
  2861. querySDS().unsubscribe(abortId);
  2862. if (stateId)
  2863. querySDS().unsubscribe(stateId);
  2864. if (actionId)
  2865. querySDS().unsubscribe(actionId);
  2866. abortId = 0;
  2867. stateId = 0;
  2868. actionId = 0;
  2869. }
  2870. void CWorkUnitWatcher::notify(SubscriptionId id, const char *xpath, SDSNotifyFlags flags, unsigned valueLen, const void *valueData)
  2871. {
  2872. CriticalBlock b(crit);
  2873. if (id==stateId)
  2874. subscriber->notify(SubscribeOptionState);
  2875. else if (id==actionId)
  2876. subscriber->notify(SubscribeOptionAction);
  2877. else if (id==abortId)
  2878. subscriber->notify(SubscribeOptionAbort);
  2879. }
  2880. class CDaliWorkUnitWatcher : public CWorkUnitWatcher
  2881. {
  2882. public:
  2883. CDaliWorkUnitWatcher(IWorkUnitSubscriber *_subscriber, WUSubscribeOptions flags, const char *wuid)
  2884. : CWorkUnitWatcher(_subscriber, (WUSubscribeOptions) (flags & SubscribeOptionAbort), wuid)
  2885. {
  2886. if (flags & SubscribeOptionState)
  2887. {
  2888. VStringBuffer xpath("/WorkUnits/%s/State", wuid);
  2889. stateId = querySDS().subscribe(xpath.str(), *this);
  2890. }
  2891. if (flags & SubscribeOptionAction)
  2892. {
  2893. VStringBuffer xpath("/WorkUnits/%s/Action", wuid);
  2894. actionId = querySDS().subscribe(xpath.str(), *this);
  2895. }
  2896. }
  2897. };
  2898. void CPersistedWorkUnit::subscribe(WUSubscribeOptions options)
  2899. {
  2900. CriticalBlock block(crit);
  2901. assertex(options==SubscribeOptionAbort);
  2902. if (!abortWatcher)
  2903. {
  2904. abortWatcher.setown(new CWorkUnitWatcher(this, SubscribeOptionAbort, p->queryName()));
  2905. abortDirty = true;
  2906. }
  2907. }
  2908. void CPersistedWorkUnit::unsubscribe()
  2909. {
  2910. CriticalBlock block(crit);
  2911. if (abortWatcher)
  2912. {
  2913. abortWatcher->unsubscribe();
  2914. abortWatcher.clear();
  2915. }
  2916. }
  2917. bool CPersistedWorkUnit::aborting() const
  2918. {
  2919. CriticalBlock block(crit);
  2920. if (abortDirty)
  2921. {
  2922. StringBuffer apath;
  2923. apath.append("/WorkUnitAborts/").append(p->queryName());
  2924. Owned<IRemoteConnection> acon = querySDS().connect(apath.str(), myProcessSession(), 0, SDS_LOCK_TIMEOUT);
  2925. if (acon)
  2926. abortState = acon->queryRoot()->getPropInt(NULL) != 0;
  2927. else
  2928. abortState = false;
  2929. abortDirty = false;
  2930. }
  2931. return abortState;
  2932. }
  2933. class CDaliWorkUnit : public CPersistedWorkUnit
  2934. {
  2935. public:
  2936. CDaliWorkUnit(IRemoteConnection *_conn, ISecManager *secmgr, ISecUser *secuser)
  2937. : connection(_conn), CPersistedWorkUnit(secmgr, secuser)
  2938. {
  2939. loadPTree(connection->getRoot());
  2940. }
  2941. ~CDaliWorkUnit()
  2942. {
  2943. // NOTE - order is important - we need to construct connection before p and (especially) destroy after p
  2944. // We use the beforeDispose() in base class to help ensure this
  2945. p.clear();
  2946. }
  2947. IConstWUGraphProgress *getGraphProgress(const char *graphName) const
  2948. {
  2949. Owned<IRemoteConnection> conn = getProgressConnection();
  2950. if (conn)
  2951. {
  2952. IPTree *progress = conn->queryRoot()->queryPropTree(graphName);
  2953. if (progress)
  2954. return new CConstGraphProgress(p->queryName(), graphName, progress);
  2955. }
  2956. return NULL;
  2957. }
  2958. virtual WUGraphState queryGraphState(const char *graphName) const
  2959. {
  2960. Owned<IRemoteConnection> conn = getProgressConnection();
  2961. if (conn)
  2962. {
  2963. IPTree *progress = conn->queryRoot()->queryPropTree(graphName);
  2964. if (progress)
  2965. return (WUGraphState) progress->getPropInt("@_state", (unsigned) WUGraphUnknown);
  2966. }
  2967. return WUGraphUnknown;
  2968. }
  2969. virtual WUGraphState queryNodeState(const char *graphName, WUGraphIDType nodeId) const
  2970. {
  2971. Owned<IRemoteConnection> conn = getProgressConnection();
  2972. if (conn)
  2973. {
  2974. IPTree *progress = conn->queryRoot()->queryPropTree(graphName);
  2975. if (progress)
  2976. {
  2977. StringBuffer path;
  2978. // NOTE - the node state info still uses the old graph layout, even when the stats are using the new...
  2979. path.append("node[@id=\"").append(nodeId).append("\"]/@_state");
  2980. return (WUGraphState) progress->getPropInt(path, (unsigned) WUGraphUnknown);
  2981. }
  2982. }
  2983. return WUGraphUnknown;
  2984. }
  2985. virtual void clearGraphProgress() const
  2986. {
  2987. CriticalBlock block(crit);
  2988. progressConnection.clear(); // Make sure nothing is locking for read or we won't be able to lock for write
  2989. StringBuffer path("/GraphProgress/");
  2990. path.append(p->queryName());
  2991. Owned<IRemoteConnection> delconn = querySDS().connect(path.str(), myProcessSession(), RTM_LOCK_WRITE, SDS_LOCK_TIMEOUT);
  2992. if (delconn)
  2993. delconn->close(true);
  2994. }
  2995. virtual bool getRunningGraph(IStringVal &graphName, WUGraphIDType &subId) const
  2996. {
  2997. Owned<IRemoteConnection> conn = getProgressConnection();
  2998. if (!conn)
  2999. return false;
  3000. const char *name = conn->queryRoot()->queryProp("Running/@graph");
  3001. if (name)
  3002. {
  3003. graphName.set(name);
  3004. subId = conn->queryRoot()->getPropInt64("Running/@subId");
  3005. return true;
  3006. }
  3007. else
  3008. return false;
  3009. }
  3010. virtual void forceReload()
  3011. {
  3012. synchronized sync(locked); // protect locked workunits (uncommitted writes) from reload
  3013. CriticalBlock block(crit);
  3014. clearCached(true);
  3015. connection->reload();
  3016. progressConnection.clear();
  3017. abortDirty = true;
  3018. p.setown(connection->getRoot());
  3019. }
  3020. virtual void cleanupAndDelete(bool deldll, bool deleteOwned, const StringArray *deleteExclusions)
  3021. {
  3022. CPersistedWorkUnit::cleanupAndDelete(deldll, deleteOwned, deleteExclusions);
  3023. clearGraphProgress();
  3024. connection->close(true);
  3025. connection.clear();
  3026. }
  3027. virtual void commit()
  3028. {
  3029. CPersistedWorkUnit::commit();
  3030. if (connection)
  3031. connection->commit();
  3032. }
  3033. virtual void _lockRemote()
  3034. {
  3035. StringBuffer wuRoot;
  3036. getXPath(wuRoot, p->queryName());
  3037. if (connection)
  3038. connection->changeMode(RTM_LOCK_WRITE,SDS_LOCK_TIMEOUT);
  3039. else
  3040. connection.setown(querySDS().connect(wuRoot.str(), myProcessSession(), RTM_LOCK_WRITE, SDS_LOCK_TIMEOUT));
  3041. if (!connection)
  3042. throw MakeStringException(WUERR_LockFailed, "Failed to get connection for xpath %s", wuRoot.str());
  3043. clearCached(true);
  3044. p.setown(connection->getRoot());
  3045. }
  3046. virtual void _unlockRemote()
  3047. {
  3048. if (connection)
  3049. {
  3050. try
  3051. {
  3052. try
  3053. {
  3054. connection->commit();
  3055. }
  3056. catch (IException *e)
  3057. {
  3058. EXCLOG(e, "Error during workunit commit");
  3059. connection->rollback();
  3060. connection->changeMode(0, SDS_LOCK_TIMEOUT);
  3061. throw;
  3062. }
  3063. connection->changeMode(0, SDS_LOCK_TIMEOUT);
  3064. }
  3065. catch (IException *E)
  3066. {
  3067. StringBuffer s;
  3068. PrintLog("Failed to release write lock on workunit: %s", E->errorMessage(s).str());
  3069. throw;
  3070. }
  3071. }
  3072. }
  3073. virtual void setGraphState(const char *graphName, WUGraphState state) const
  3074. {
  3075. Owned<IRemoteConnection> conn = getWritableProgressConnection(graphName);
  3076. conn->queryRoot()->setPropInt("@_state", state);
  3077. }
  3078. virtual void setNodeState(const char *graphName, WUGraphIDType nodeId, WUGraphState state) const
  3079. {
  3080. CriticalBlock block(crit);
  3081. progressConnection.clear(); // Make sure nothing is locking for read or we won't be able to lock for write
  3082. VStringBuffer path("/GraphProgress/%s", queryWuid());
  3083. Owned<IRemoteConnection> conn = querySDS().connect(path, myProcessSession(), RTM_LOCK_WRITE|RTM_CREATE_QUERY, SDS_LOCK_TIMEOUT);
  3084. IPTree *progress = ensurePTree(conn->queryRoot(), graphName);
  3085. // NOTE - the node state info still uses the old graph layout, even when the stats are using the new...
  3086. path.clear().append("node[@id=\"").append(nodeId).append("\"]");
  3087. IPropertyTree *node = progress->queryPropTree(path.str());
  3088. if (!node)
  3089. {
  3090. node = progress->addPropTree("node");
  3091. node->setPropInt64("@id", nodeId);
  3092. }
  3093. node->setPropInt("@_state", (unsigned)state);
  3094. switch (state)
  3095. {
  3096. case WUGraphRunning:
  3097. {
  3098. IPropertyTree *running = conn->queryRoot()->setPropTree("Running");
  3099. running->setProp("@graph", graphName);
  3100. running->setPropInt64("@subId", nodeId);
  3101. break;
  3102. }
  3103. case WUGraphComplete:
  3104. {
  3105. conn->queryRoot()->removeProp("Running"); // only one thing running at any given time and one thing with lockWrite access
  3106. break;
  3107. }
  3108. }
  3109. }
  3110. virtual IWUGraphStats *updateStats(const char *graphName, StatisticCreatorType creatorType, const char * creator, unsigned _wfid, unsigned subgraph) const override
  3111. {
  3112. return new CDaliWuGraphStats(getWritableProgressConnection(graphName), creatorType, creator, _wfid, graphName, subgraph);
  3113. }
  3114. protected:
  3115. IRemoteConnection *getProgressConnection() const
  3116. {
  3117. CriticalBlock block(crit);
  3118. if (!progressConnection)
  3119. {
  3120. VStringBuffer path("/GraphProgress/%s", queryWuid());
  3121. progressConnection.setown(querySDS().connect(path, myProcessSession(), 0, SDS_LOCK_TIMEOUT)); // Note - we don't lock. The writes are atomic.
  3122. }
  3123. return progressConnection.getLink();
  3124. }
  3125. IRemoteConnection *getWritableProgressConnection(const char *graphName) const
  3126. {
  3127. CriticalBlock block(crit);
  3128. progressConnection.clear(); // Make sure subsequent reads from this workunit get the changes I am making
  3129. VStringBuffer path("/GraphProgress/%s/%s", queryWuid(), graphName);
  3130. return querySDS().connect(path, myProcessSession(), RTM_LOCK_WRITE|RTM_CREATE_QUERY, SDS_LOCK_TIMEOUT);
  3131. }
  3132. IPropertyTree *getGraphProgressTree() const
  3133. {
  3134. Owned<IRemoteConnection> conn = getProgressConnection();
  3135. if (conn)
  3136. {
  3137. Owned<IPropertyTree> tmp = createPTree("GraphProgress");
  3138. mergePTree(tmp,conn->queryRoot());
  3139. return tmp.getClear();
  3140. }
  3141. return NULL;
  3142. }
  3143. Owned<IRemoteConnection> connection;
  3144. mutable Owned<IRemoteConnection> progressConnection;
  3145. };
  3146. class CLockedWorkUnit : implements ILocalWorkUnit, implements IExtendedWUInterface, public CInterface
  3147. {
  3148. public:
  3149. Owned<CLocalWorkUnit> c;
  3150. IMPLEMENT_IINTERFACE;
  3151. CLockedWorkUnit(CLocalWorkUnit *_c) : c(_c) {}
  3152. ~CLockedWorkUnit()
  3153. {
  3154. if (workUnitTraceLevel > 1)
  3155. PrintLog("Releasing locked workunit %s", queryWuid());
  3156. if (c)
  3157. c->unlockRemote();
  3158. }
  3159. virtual IConstWorkUnit * unlock()
  3160. {
  3161. c->unlockRemote();
  3162. return c.getClear();
  3163. }
  3164. virtual bool aborting() const
  3165. { return c->aborting(); }
  3166. virtual void forceReload()
  3167. { UNIMPLEMENTED; }
  3168. virtual WUAction getAction() const
  3169. { return c->getAction(); }
  3170. virtual const char *queryActionDesc() const
  3171. { return c->queryActionDesc(); }
  3172. virtual IStringVal & getApplicationValue(const char * application, const char * propname, IStringVal & str) const
  3173. { return c->getApplicationValue(application, propname, str); }
  3174. virtual int getApplicationValueInt(const char * application, const char * propname, int defVal) const
  3175. { return c->getApplicationValueInt(application, propname, defVal); }
  3176. virtual IConstWUAppValueIterator & getApplicationValues() const
  3177. { return c->getApplicationValues(); }
  3178. virtual bool hasWorkflow() const
  3179. { return c->hasWorkflow(); }
  3180. virtual unsigned queryEventScheduledCount() const
  3181. { return c->queryEventScheduledCount(); }
  3182. virtual IPropertyTree * queryWorkflowTree() const
  3183. { return c->queryWorkflowTree(); }
  3184. virtual IConstWorkflowItemIterator * getWorkflowItems() const
  3185. { return c->getWorkflowItems(); }
  3186. virtual IWorkflowItemArray * getWorkflowClone() const
  3187. { return c->getWorkflowClone(); }
  3188. virtual bool requiresLocalFileUpload() const
  3189. { return c->requiresLocalFileUpload(); }
  3190. virtual IConstLocalFileUploadIterator * getLocalFileUploads() const
  3191. { return c->getLocalFileUploads(); }
  3192. virtual bool getIsQueryService() const
  3193. { return c->getIsQueryService(); }
  3194. virtual bool getCloneable() const
  3195. { return c->getCloneable(); }
  3196. virtual IUserDescriptor * queryUserDescriptor() const
  3197. { return c->queryUserDescriptor(); }
  3198. virtual const char *queryClusterName() const
  3199. { return c->queryClusterName(); }
  3200. virtual unsigned getCodeVersion() const
  3201. { return c->getCodeVersion(); }
  3202. virtual unsigned getWuidVersion() const
  3203. { return c->getWuidVersion(); }
  3204. virtual void getBuildVersion(IStringVal & buildVersion, IStringVal & eclVersion) const
  3205. { c->getBuildVersion(buildVersion, eclVersion); }
  3206. virtual bool hasDebugValue(const char * propname) const
  3207. { return c->hasDebugValue(propname); }
  3208. virtual IStringVal & getDebugValue(const char * propname, IStringVal & str) const
  3209. { return c->getDebugValue(propname, str); }
  3210. virtual int getDebugValueInt(const char * propname, int defVal) const
  3211. { return c->getDebugValueInt(propname, defVal); }
  3212. virtual __int64 getDebugValueInt64(const char * propname, __int64 defVal) const
  3213. { return c->getDebugValueInt64(propname, defVal); }
  3214. virtual bool getDebugValueBool(const char * propname, bool defVal) const
  3215. { return c->getDebugValueBool(propname, defVal); }
  3216. virtual IStringIterator & getDebugValues() const
  3217. { return c->getDebugValues(NULL); }
  3218. virtual IStringIterator & getDebugValues(const char *prop) const
  3219. { return c->getDebugValues(prop); }
  3220. virtual unsigned getExceptionCount() const
  3221. { return c->getExceptionCount(); }
  3222. virtual IConstWUExceptionIterator & getExceptions() const
  3223. { return c->getExceptions(); }
  3224. virtual unsigned getGraphCount() const
  3225. { return c->getGraphCount(); }
  3226. virtual unsigned getSourceFileCount() const
  3227. { return c->getSourceFileCount(); }
  3228. virtual unsigned getResultCount() const
  3229. { return c->getResultCount(); }
  3230. virtual unsigned getVariableCount() const
  3231. { return c->getVariableCount(); }
  3232. virtual unsigned getApplicationValueCount() const
  3233. { return c->getApplicationValueCount(); }
  3234. virtual IConstWUGraphIterator & getGraphs(WUGraphType type) const
  3235. { return c->getGraphs(type); }
  3236. virtual IConstWUGraphMetaIterator & getGraphsMeta(WUGraphType type) const
  3237. { return c->getGraphsMeta(type); }
  3238. virtual IConstWUGraph * getGraph(const char *name) const
  3239. { return c->getGraph(name); }
  3240. virtual IConstWUGraphProgress * getGraphProgress(const char * name) const
  3241. { return c->getGraphProgress(name); }
  3242. virtual const char *queryJobName() const
  3243. { return c->queryJobName(); }
  3244. virtual IConstWUPlugin * getPluginByName(const char * name) const
  3245. { return c->getPluginByName(name); }
  3246. virtual IConstWUPluginIterator & getPlugins() const
  3247. { return c->getPlugins(); }
  3248. virtual IConstWULibrary* getLibraryByName(const char *name) const
  3249. { return c->getLibraryByName(name); }
  3250. virtual IConstWULibraryIterator & getLibraries() const
  3251. { return c->getLibraries(); }
  3252. virtual WUPriorityClass getPriority() const
  3253. { return c->getPriority(); }
  3254. virtual const char *queryPriorityDesc() const
  3255. { return c->queryPriorityDesc(); }
  3256. virtual int getPriorityLevel() const
  3257. { return c->getPriorityLevel(); }
  3258. virtual int getPriorityValue() const
  3259. { return c->getPriorityValue(); }
  3260. virtual IConstWUQuery * getQuery() const
  3261. { return c->getQuery(); }
  3262. virtual IConstWUWebServicesInfo * getWebServicesInfo() const
  3263. { return c->getWebServicesInfo(); }
  3264. virtual bool getRescheduleFlag() const
  3265. { return c->getRescheduleFlag(); }
  3266. virtual IConstWUResult * getResultByName(const char * name) const
  3267. { return c->getResultByName(name); }
  3268. virtual IConstWUResult * getResultBySequence(unsigned seq) const
  3269. { return c->getResultBySequence(seq); }
  3270. virtual unsigned getResultLimit() const
  3271. { return c->getResultLimit(); }
  3272. virtual IConstWUResultIterator & getResults() const
  3273. { return c->getResults(); }
  3274. virtual IStringVal & getScope(IStringVal & str) const
  3275. { return c->getScope(str); }
  3276. virtual IStringVal & getSecurityToken(IStringVal & str) const
  3277. { return c->getSecurityToken(str); }
  3278. virtual WUState getState() const
  3279. { return c->getState(); }
  3280. virtual IStringVal & getStateEx(IStringVal & str) const
  3281. { return c->getStateEx(str); }
  3282. virtual __int64 getAgentSession() const
  3283. { return c->getAgentSession(); }
  3284. virtual unsigned getAgentPID() const
  3285. { return c->getAgentPID(); }
  3286. virtual const char *queryStateDesc() const
  3287. { return c->queryStateDesc(); }
  3288. virtual bool getRunningGraph(IStringVal & graphName, WUGraphIDType & subId) const
  3289. { return c->getRunningGraph(graphName, subId); }
  3290. virtual IConstWUScopeIterator & getScopeIterator(const WuScopeFilter & filter) const override
  3291. { return c->getScopeIterator(filter); }
  3292. virtual bool getStatistic(stat_type & value, const char * scope, StatisticKind kind) const override
  3293. { return c->getStatistic(value, scope, kind); }
  3294. virtual IStringVal & getSnapshot(IStringVal & str) const
  3295. { return c->getSnapshot(str); }
  3296. virtual const char *queryUser() const
  3297. { return c->queryUser(); }
  3298. virtual ErrorSeverity getWarningSeverity(unsigned code, ErrorSeverity defaultSeverity) const
  3299. { return c->getWarningSeverity(code, defaultSeverity); }
  3300. virtual const char *queryWuScope() const
  3301. { return c->queryWuScope(); }
  3302. virtual const char *queryWuid() const
  3303. { return c->queryWuid(); }
  3304. virtual IConstWUResult * getGlobalByName(const char * name) const
  3305. { return c->getGlobalByName(name); }
  3306. virtual IConstWUResult * getTemporaryByName(const char * name) const
  3307. { return c->getTemporaryByName(name); }
  3308. virtual IConstWUResultIterator & getTemporaries() const
  3309. { return c->getTemporaries(); }
  3310. virtual IConstWUResult * getVariableByName(const char * name) const
  3311. { return c->getVariableByName(name); }
  3312. virtual IConstWUResultIterator & getVariables() const
  3313. { return c->getVariables(); }
  3314. virtual bool isProtected() const
  3315. { return c->isProtected(); }
  3316. virtual bool isPausing() const
  3317. { return c->isPausing(); }
  3318. virtual IWorkUnit & lock()
  3319. { ((CInterface *)this)->Link(); return (IWorkUnit &) *this; }
  3320. virtual bool reload()
  3321. { UNIMPLEMENTED; }
  3322. virtual void subscribe(WUSubscribeOptions options)
  3323. { c->subscribe(options); }
  3324. virtual void requestAbort()
  3325. { c->requestAbort(); }
  3326. virtual unsigned calculateHash(unsigned prevHash)
  3327. { return queryExtendedWU(c)->calculateHash(prevHash); }
  3328. virtual void copyWorkUnit(IConstWorkUnit *cached, bool copyStats, bool all)
  3329. { queryExtendedWU(c)->copyWorkUnit(cached, copyStats, all); }
  3330. virtual IPropertyTree *queryPTree() const
  3331. { return queryExtendedWU(c)->queryPTree(); }
  3332. virtual IPropertyTree *getUnpackedTree(bool includeProgress) const
  3333. { return queryExtendedWU(c)->getUnpackedTree(includeProgress); }
  3334. virtual bool archiveWorkUnit(const char *base,bool del,bool deldll,bool deleteOwned,bool exportAssociatedFiles)
  3335. { return queryExtendedWU(c)->archiveWorkUnit(base,del,deldll,deleteOwned,exportAssociatedFiles); }
  3336. virtual unsigned queryFileUsage(const char *filename) const
  3337. { return c->queryFileUsage(filename); }
  3338. virtual IConstWUFileUsageIterator * getFieldUsage() const
  3339. { return c->getFieldUsage(); }
  3340. virtual bool getFieldUsageArray(StringArray & filenames, StringArray & columnnames, const char * clusterName) const
  3341. { return c->getFieldUsageArray(filenames, columnnames, clusterName); }
  3342. virtual IJlibDateTime & getTimeScheduled(IJlibDateTime &val) const
  3343. { return c->getTimeScheduled(val); }
  3344. virtual unsigned getDebugAgentListenerPort() const
  3345. { return c->getDebugAgentListenerPort(); }
  3346. virtual IStringVal & getDebugAgentListenerIP(IStringVal &ip) const
  3347. { return c->getDebugAgentListenerIP(ip); }
  3348. virtual IStringVal & getXmlParams(IStringVal & params, bool hidePasswords) const
  3349. { return c->getXmlParams(params, hidePasswords); }
  3350. virtual const IPropertyTree *getXmlParams() const
  3351. { return c->getXmlParams(); }
  3352. virtual unsigned __int64 getHash() const
  3353. { return c->getHash(); }
  3354. virtual IStringIterator *getLogs(const char *type, const char *instance) const
  3355. { return c->getLogs(type, instance); }
  3356. virtual IStringIterator *getProcesses(const char *type) const
  3357. { return c->getProcesses(type); }
  3358. virtual IPropertyTreeIterator* getProcesses(const char *type, const char *instance) const
  3359. { return c->getProcesses(type, instance); }
  3360. virtual unsigned getTotalThorTime() const
  3361. { return c->getTotalThorTime(); }
  3362. virtual WUGraphState queryGraphState(const char *graphName) const
  3363. { return c->queryGraphState(graphName); }
  3364. virtual WUGraphState queryNodeState(const char *graphName, WUGraphIDType nodeId) const
  3365. { return c->queryNodeState(graphName, nodeId); }
  3366. virtual void setGraphState(const char *graphName, WUGraphState state) const
  3367. { c->setGraphState(graphName, state); }
  3368. virtual void setNodeState(const char *graphName, WUGraphIDType nodeId, WUGraphState state) const
  3369. { c->setNodeState(graphName, nodeId, state); }
  3370. virtual IWUGraphStats *updateStats(const char *graphName, StatisticCreatorType creatorType, const char * creator, unsigned _wfid, unsigned subgraph) const override
  3371. { return c->updateStats(graphName, creatorType, creator, _wfid, subgraph); }
  3372. virtual void clearGraphProgress() const
  3373. { c->clearGraphProgress(); }
  3374. virtual IStringVal & getAbortBy(IStringVal & str) const
  3375. { return c->getAbortBy(str); }
  3376. virtual unsigned __int64 getAbortTimeStamp() const
  3377. { return c->getAbortTimeStamp(); }
  3378. virtual void clearExceptions()
  3379. { c->clearExceptions(); }
  3380. virtual void commit()
  3381. { c->commit(); }
  3382. virtual IWUException * createException()
  3383. { return c->createException(); }
  3384. virtual void addProcess(const char *type, const char *instance, unsigned pid, const char *log)
  3385. { c->addProcess(type, instance, pid, log); }
  3386. virtual void protect(bool protectMode)
  3387. { c->protect(protectMode); }
  3388. virtual void setAction(WUAction action)
  3389. { c->setAction(action); }
  3390. virtual void setApplicationValue(const char * application, const char * propname, const char * value, bool overwrite)
  3391. { c->setApplicationValue(application, propname, value, overwrite); }
  3392. virtual void setApplicationValueInt(const char * application, const char * propname, int value, bool overwrite)
  3393. { c->setApplicationValueInt(application, propname, value, overwrite); }
  3394. virtual void incEventScheduledCount()
  3395. { c->incEventScheduledCount(); }
  3396. virtual void setIsQueryService(bool value)
  3397. { c->setIsQueryService(value); }
  3398. virtual void setCloneable(bool value)
  3399. { c->setCloneable(value); }
  3400. virtual void setIsClone(bool value)
  3401. { c->setIsClone(value); }
  3402. virtual void setClusterName(const char * value)
  3403. { c->setClusterName(value); }
  3404. virtual void setCodeVersion(unsigned version, const char * buildVersion, const char * eclVersion)
  3405. { c->setCodeVersion(version, buildVersion, eclVersion); }
  3406. virtual void setDebugValue(const char * propname, const char * value, bool overwrite)
  3407. { c->setDebugValue(propname, value, overwrite); }
  3408. virtual void setDebugValueInt(const char * propname, int value, bool overwrite)
  3409. { c->setDebugValueInt(propname, value, overwrite); }
  3410. virtual void setJobName(const char * value)
  3411. { c->setJobName(value); }
  3412. virtual void setPriority(WUPriorityClass cls)
  3413. { c->setPriority(cls); }
  3414. virtual void setPriorityLevel(int level)
  3415. { c->setPriorityLevel(level); }
  3416. virtual void setRescheduleFlag(bool value)
  3417. { c->setRescheduleFlag(value); }
  3418. virtual void setResultLimit(unsigned value)
  3419. { c->setResultLimit(value); }
  3420. virtual void setSecurityToken(const char *value)
  3421. { c->setSecurityToken(value); }
  3422. virtual void setState(WUState state)
  3423. { c->setState(state); }
  3424. virtual void setStateEx(const char * text)
  3425. { c->setStateEx(text); }
  3426. virtual void setAgentSession(__int64 sessionId)
  3427. { c->setAgentSession(sessionId); }
  3428. 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)
  3429. { c->setStatistic(creatorType, creator, scopeType, scope, kind, optDescription, value, count, maxValue, mergeAction); }
  3430. virtual void setTracingValue(const char * propname, const char * value)
  3431. { c->setTracingValue(propname, value); }
  3432. virtual void setTracingValueInt(const char * propname, int value)
  3433. { c->setTracingValueInt(propname, value); }
  3434. virtual void setTracingValueInt64(const char * propname, __int64 value)
  3435. { c->setTracingValueInt64(propname, value); }
  3436. virtual void setUser(const char * value)
  3437. { c->setUser(value); }
  3438. virtual void setWuScope(const char * value)
  3439. { c->setWuScope(value); }
  3440. virtual IWorkflowItem* addWorkflowItem(unsigned wfid, WFType type, WFMode mode, unsigned success, unsigned failure, unsigned recovery, unsigned retriesAllowed, unsigned contingencyFor)
  3441. { return c->addWorkflowItem(wfid, type, mode, success, failure, recovery, retriesAllowed, contingencyFor); }
  3442. virtual void syncRuntimeWorkflow(IWorkflowItemArray * array)
  3443. { c->syncRuntimeWorkflow(array); }
  3444. virtual IWorkflowItemIterator * updateWorkflowItems()
  3445. { return c->updateWorkflowItems(); }
  3446. virtual void resetWorkflow()
  3447. { c->resetWorkflow(); }
  3448. virtual void schedule()
  3449. { c->schedule(); }
  3450. virtual void deschedule()
  3451. { c->deschedule(); }
  3452. virtual unsigned addLocalFileUpload(LocalFileUploadType type, char const * source, char const * destination, char const * eventTag)
  3453. { return c->addLocalFileUpload(type, source, destination, eventTag); }
  3454. virtual IWUResult * updateGlobalByName(const char * name)
  3455. { return c->updateGlobalByName(name); }
  3456. virtual void createGraph(const char * name, const char *label, WUGraphType type, IPropertyTree *xgmml, unsigned wfid)
  3457. { c->createGraph(name, label, type, xgmml, wfid); }
  3458. virtual IWUQuery * updateQuery()
  3459. { return c->updateQuery(); }
  3460. virtual IWUWebServicesInfo * updateWebServicesInfo(bool create)
  3461. { return c->updateWebServicesInfo(create); }
  3462. virtual IWUPlugin * updatePluginByName(const char * name)
  3463. { return c->updatePluginByName(name); }
  3464. virtual IWULibrary * updateLibraryByName(const char * name)
  3465. { return c->updateLibraryByName(name); }
  3466. virtual IWUResult * updateResultByName(const char * name)
  3467. { return c->updateResultByName(name); }
  3468. virtual IWUResult * updateResultBySequence(unsigned seq)
  3469. { return c->updateResultBySequence(seq); }
  3470. virtual IWUResult * updateTemporaryByName(const char * name)
  3471. { return c->updateTemporaryByName(name); }
  3472. virtual IWUResult * updateVariableByName(const char * name)
  3473. { return c->updateVariableByName(name); }
  3474. virtual void addFile(const char *fileName, StringArray *clusters, unsigned usageCount, WUFileKind fileKind, const char *graphOwner)
  3475. { c->addFile(fileName, clusters, usageCount, fileKind, graphOwner); }
  3476. virtual void noteFileRead(IDistributedFile *file)
  3477. { c->noteFileRead(file); }
  3478. virtual void noteFieldUsage(IPropertyTree * usage)
  3479. { c->noteFieldUsage(usage); }
  3480. virtual void releaseFile(const char *fileName)
  3481. { c->releaseFile(fileName); }
  3482. virtual void resetBeforeGeneration()
  3483. { c->resetBeforeGeneration(); }
  3484. virtual void deleteTempFiles(const char *graph, bool deleteOwned, bool deleteJobOwned)
  3485. { c->deleteTempFiles(graph, deleteOwned, deleteJobOwned); }
  3486. virtual void deleteTemporaries()
  3487. { c->deleteTemporaries(); }
  3488. virtual void addDiskUsageStats(__int64 avgNodeUsage, unsigned minNode, __int64 minNodeUsage, unsigned maxNode, __int64 maxNodeUsage, __int64 graphId)
  3489. { c->addDiskUsageStats(avgNodeUsage, minNode, minNodeUsage, maxNode, maxNodeUsage, graphId); }
  3490. virtual IPropertyTree * getDiskUsageStats()
  3491. { return c->getDiskUsageStats(); }
  3492. virtual IPropertyTreeIterator & getFileIterator() const
  3493. { return c->getFileIterator(); }
  3494. virtual IPropertyTreeIterator & getFilesReadIterator() const
  3495. { return c->getFilesReadIterator(); }
  3496. virtual void setSnapshot(const char * value)
  3497. { c->setSnapshot(value); }
  3498. virtual void setWarningSeverity(unsigned code, ErrorSeverity severity)
  3499. { c->setWarningSeverity(code, severity); }
  3500. virtual void setTimeScheduled(const IJlibDateTime &val)
  3501. { c->setTimeScheduled(val); }
  3502. virtual void setDebugAgentListenerPort(unsigned port)
  3503. { c->setDebugAgentListenerPort(port); }
  3504. virtual void setDebugAgentListenerIP(const char * ip)
  3505. { c->setDebugAgentListenerIP(ip); }
  3506. virtual void setXmlParams(const char *params)
  3507. { c->setXmlParams(params); }
  3508. virtual void setXmlParams(IPropertyTree *tree)
  3509. { c->setXmlParams(tree); }
  3510. virtual void setHash(unsigned __int64 hash)
  3511. { c->setHash(hash); }
  3512. // ILocalWorkUnit - used for debugging etc
  3513. virtual void serialize(MemoryBuffer &tgt)
  3514. { c->serialize(tgt); }
  3515. virtual void deserialize(MemoryBuffer &src)
  3516. { c->deserialize(src); }
  3517. virtual bool switchThorQueue(const char *cluster, IQueueSwitcher *qs)
  3518. { return c->switchThorQueue(cluster,qs); }
  3519. virtual void setAllowedClusters(const char *value)
  3520. { c->setAllowedClusters(value); }
  3521. virtual IStringVal& getAllowedClusters(IStringVal &str) const
  3522. { return c->getAllowedClusters(str); }
  3523. virtual void remoteCheckAccess(IUserDescriptor *user, bool writeaccess) const
  3524. { c->remoteCheckAccess(user,writeaccess); }
  3525. virtual void setAllowAutoQueueSwitch(bool val)
  3526. { c->setAllowAutoQueueSwitch(val); }
  3527. virtual bool getAllowAutoQueueSwitch() const
  3528. { return c->getAllowAutoQueueSwitch(); }
  3529. virtual void setLibraryInformation(const char * name, unsigned interfaceHash, unsigned definitionHash)
  3530. { c->setLibraryInformation(name, interfaceHash, definitionHash); }
  3531. virtual void setResultInt(const char * name, unsigned sequence, __int64 val)
  3532. { c->setResultInt(name, sequence, val); }
  3533. virtual void setResultUInt(const char * name, unsigned sequence, unsigned __int64 val)
  3534. { c->setResultUInt(name, sequence, val); }
  3535. virtual void setResultReal(const char *name, unsigned sequence, double val)
  3536. { c->setResultReal(name, sequence, val); }
  3537. virtual void setResultVarString(const char * stepname, unsigned sequence, const char *val)
  3538. { c->setResultVarString(stepname, sequence, val); }
  3539. virtual void setResultVarUnicode(const char * stepname, unsigned sequence, UChar const *val)
  3540. { c->setResultVarUnicode(stepname, sequence, val); }
  3541. virtual void setResultString(const char * stepname, unsigned sequence, int len, const char *val)
  3542. { c->setResultString(stepname, sequence, len, val); }
  3543. virtual void setResultData(const char * stepname, unsigned sequence, int len, const void *val)
  3544. { c->setResultData(stepname, sequence, len, val); }
  3545. virtual void setResultRaw(const char * name, unsigned sequence, int len, const void *val)
  3546. { c->setResultRaw(name, sequence, len, val); }
  3547. virtual void setResultSet(const char * name, unsigned sequence, bool isAll, size32_t len, const void *val, ISetToXmlTransformer *xform)
  3548. { c->setResultSet(name, sequence, isAll, len, val, xform); }
  3549. virtual void setResultUnicode(const char * name, unsigned sequence, int len, UChar const * val)
  3550. { c->setResultUnicode(name, sequence, len, val); }
  3551. virtual void setResultBool(const char *name, unsigned sequence, bool val)
  3552. { c->setResultBool(name, sequence, val); }
  3553. virtual void setResultDecimal(const char *name, unsigned sequence, int len, int precision, bool isSigned, const void *val)
  3554. { c->setResultDecimal(name, sequence, len, precision, isSigned, val); }
  3555. virtual void setResultDataset(const char * name, unsigned sequence, size32_t len, const void *val, unsigned numRows, bool extend)
  3556. { c->setResultDataset(name, sequence, len, val, numRows, extend); }
  3557. };
  3558. class CLocalWUAssociated : implements IConstWUAssociatedFile, public CInterface
  3559. {
  3560. Owned<IPropertyTree> p;
  3561. public:
  3562. IMPLEMENT_IINTERFACE;
  3563. CLocalWUAssociated(IPropertyTree *p);
  3564. virtual WUFileType getType() const;
  3565. virtual IStringVal & getDescription(IStringVal & ret) const;
  3566. virtual IStringVal & getIp(IStringVal & ret) const;
  3567. virtual IStringVal & getName(IStringVal & ret) const;
  3568. virtual IStringVal & getNameTail(IStringVal & ret) const;
  3569. virtual unsigned getCrc() const;
  3570. virtual unsigned getMinActivityId() const;
  3571. virtual unsigned getMaxActivityId() const;
  3572. };
  3573. class CLocalWUQuery : implements IWUQuery, public CInterface
  3574. {
  3575. Owned<IPropertyTree> p;
  3576. mutable IArrayOf<IConstWUAssociatedFile> associated;
  3577. mutable CriticalSection crit;
  3578. mutable bool associatedCached;
  3579. private:
  3580. void addSpecialCaseAssociated(WUFileType type, const char * propname, unsigned crc) const;
  3581. void loadAssociated() const;
  3582. public:
  3583. IMPLEMENT_IINTERFACE;
  3584. CLocalWUQuery(IPropertyTree *p);
  3585. virtual WUQueryType getQueryType() const;
  3586. virtual IStringVal& getQueryText(IStringVal &str) const;
  3587. virtual IStringVal& getQueryShortText(IStringVal &str) const;
  3588. virtual IStringVal& getQueryName(IStringVal &str) const;
  3589. virtual IStringVal & getQueryMainDefinition(IStringVal & str) const;
  3590. virtual IStringVal& getQueryDllName(IStringVal &str) const;
  3591. virtual unsigned getQueryDllCrc() const;
  3592. virtual IStringVal& getQueryCppName(IStringVal &str) const;
  3593. virtual IStringVal& getQueryResTxtName(IStringVal &str) const;
  3594. virtual IConstWUAssociatedFile * getAssociatedFile(WUFileType type, unsigned index) const;
  3595. virtual IConstWUAssociatedFileIterator& getAssociatedFiles() const;
  3596. virtual bool isArchive() const;
  3597. virtual bool hasArchive() const
  3598. {
  3599. return p->getPropBool("@hasArchive");
  3600. }
  3601. virtual void setQueryType(WUQueryType qt);
  3602. virtual void setQueryText(const char *pstr);
  3603. virtual void setQueryName(const char *);
  3604. virtual void setQueryMainDefinition(const char * str);
  3605. virtual void addAssociatedFile(WUFileType type, const char * name, const char * ip, const char * desc, unsigned crc, unsigned minActivity, unsigned maxActivity);
  3606. virtual void removeAssociatedFiles();
  3607. virtual void removeAssociatedFile(WUFileType type, const char * name, const char * desc);
  3608. };
  3609. class CLocalWUWebServicesInfo : implements IWUWebServicesInfo, public CInterface
  3610. {
  3611. Owned<IPropertyTree> p;
  3612. mutable CriticalSection crit;
  3613. private:
  3614. public:
  3615. IMPLEMENT_IINTERFACE;
  3616. CLocalWUWebServicesInfo(IPropertyTree *p);
  3617. virtual IStringVal& getModuleName(IStringVal &str) const;
  3618. virtual IStringVal& getAttributeName(IStringVal &str) const;
  3619. virtual IStringVal& getDefaultName(IStringVal &str) const;
  3620. virtual IStringVal& getInfo(const char *name, IStringVal &str) const;
  3621. virtual IStringVal& getText(const char *name, IStringVal &str) const;
  3622. virtual unsigned getWebServicesCRC() const;
  3623. virtual void setModuleName(const char *);
  3624. virtual void setAttributeName(const char *);
  3625. virtual void setDefaultName(const char *);
  3626. virtual void setInfo(const char *name, const char *info);
  3627. virtual void setText(const char *name, const char *info);
  3628. virtual void setWebServicesCRC(unsigned);
  3629. };
  3630. class CLocalWUResult : implements IWUResult, public CInterface
  3631. {
  3632. friend class CLocalWorkUnit;
  3633. mutable CriticalSection crit;
  3634. Owned<IPropertyTree> p;
  3635. Owned<IProperties> xmlns;
  3636. public:
  3637. IMPLEMENT_IINTERFACE;
  3638. CLocalWUResult(IPropertyTree *props);
  3639. ~CLocalWUResult() { try { p.clear(); } catch (IException *E) {E->Release();}}
  3640. virtual WUResultStatus getResultStatus() const;
  3641. virtual IStringVal& getResultName(IStringVal &str) const;
  3642. virtual int getResultSequence() const;
  3643. virtual bool isResultScalar() const;
  3644. virtual IStringVal& getResultXml(IStringVal &str, bool hidePasswords) const;
  3645. virtual unsigned getResultFetchSize() const;
  3646. virtual __int64 getResultTotalRowCount() const;
  3647. virtual __int64 getResultRowCount() const;
  3648. virtual void getResultDataset(IStringVal & ecl, IStringVal & defs) const;
  3649. virtual IStringVal& getResultLogicalName(IStringVal &ecl) const;
  3650. virtual IStringVal& getResultKeyField(IStringVal& ecl) const;
  3651. virtual unsigned getResultRequestedRows() const;
  3652. virtual __int64 getResultInt() const;
  3653. virtual bool getResultBool() const;
  3654. virtual double getResultReal() const;
  3655. virtual IStringVal& getResultString(IStringVal & str, bool hidePassword) const;
  3656. virtual IDataVal& getResultRaw(IDataVal & data, IXmlToRawTransformer * xmlTransformer, ICsvToRawTransformer * csvTransformer) const;
  3657. virtual IDataVal& getResultUnicode(IDataVal & data) const;
  3658. virtual void getResultDecimal(void * val, unsigned length, unsigned precision, bool isSigned) const;
  3659. virtual IStringVal& getResultEclSchema(IStringVal & str) const;
  3660. virtual __int64 getResultRawSize(IXmlToRawTransformer * xmlTransformer, ICsvToRawTransformer * csvTransformer) const;
  3661. virtual IDataVal& getResultRaw(IDataVal & data, __int64 from, __int64 length, IXmlToRawTransformer * xmlTransformer, ICsvToRawTransformer * csvTransformer) const;
  3662. virtual IStringVal& getResultRecordSizeEntry(IStringVal & str) const;
  3663. virtual IStringVal& getResultTransformerEntry(IStringVal & str) const;
  3664. virtual __int64 getResultRowLimit() const;
  3665. virtual IStringVal& getResultFilename(IStringVal & str) const;
  3666. virtual WUResultFormat getResultFormat() const;
  3667. virtual unsigned getResultHash() const;
  3668. virtual bool getResultIsAll() const;
  3669. virtual IProperties *queryResultXmlns();
  3670. virtual IStringVal& getResultFieldOpt(const char *name, IStringVal &str) const;
  3671. virtual void getSchema(IArrayOf<ITypeInfo> &types, StringAttrArray &names, IStringVal * ecl=NULL) const;
  3672. virtual void getResultWriteLocation(IStringVal & _graph, unsigned & _activityId) const;
  3673. // interface IWUResult
  3674. virtual void setResultStatus(WUResultStatus status);
  3675. virtual void setResultName(const char *name);
  3676. virtual void setResultSequence(unsigned seq);
  3677. virtual void setResultSchemaRaw(unsigned len, const void *schema);
  3678. virtual void setResultScalar(bool isScalar);
  3679. virtual void setResultRaw(unsigned len, const void *xml, WUResultFormat format);
  3680. virtual void setResultFetchSize(unsigned rows); // 0 means file-loaded
  3681. virtual void setResultTotalRowCount(__int64 rows); // -1 means unknown
  3682. virtual void setResultRowCount(__int64 rows);
  3683. virtual void setResultDataset(const char *ecl, const char *defs);
  3684. virtual void setResultLogicalName(const char *logicalName);
  3685. virtual void setResultKeyField(const char * name);
  3686. virtual void setResultRequestedRows(unsigned req);
  3687. virtual void setResultRecordSizeEntry(const char * val);
  3688. virtual void setResultTransformerEntry(const char * val);
  3689. virtual void setResultInt(__int64 val);
  3690. virtual void setResultReal(double val);
  3691. virtual void setResultBool(bool val);
  3692. virtual void setResultString(const char * val, unsigned length);
  3693. virtual void setResultUnicode(const void * val, unsigned length);
  3694. virtual void setResultData(const void * val, unsigned length);
  3695. virtual void setResultDecimal(const void * val, unsigned length);
  3696. virtual void addResultRaw(unsigned len, const void * data, WUResultFormat format);
  3697. virtual void setResultRowLimit(__int64 value);
  3698. virtual void setResultFilename(const char * name);
  3699. virtual void setResultUInt(unsigned __int64 val);
  3700. virtual void setResultIsAll(bool value);
  3701. virtual void setResultFormat(WUResultFormat format);
  3702. virtual void setResultXML(const char *val);
  3703. virtual void setResultRow(unsigned len, const void * data);
  3704. virtual void setResultXmlns(const char *prefix, const char *uri);
  3705. virtual void setResultFieldOpt(const char *name, const char *value);
  3706. virtual void setResultWriteLocation(const char * _graph, unsigned _activityId);
  3707. virtual IPropertyTree *queryPTree() { return p; }
  3708. };
  3709. class CLocalWUPlugin : implements IWUPlugin, public CInterface
  3710. {
  3711. Owned<IPropertyTree> p;
  3712. public:
  3713. IMPLEMENT_IINTERFACE;
  3714. CLocalWUPlugin(IPropertyTree *p);
  3715. virtual IStringVal& getPluginName(IStringVal &str) const;
  3716. virtual IStringVal& getPluginVersion(IStringVal &str) const;
  3717. virtual void setPluginName(const char *str);
  3718. virtual void setPluginVersion(const char *str);
  3719. };
  3720. class CLocalWULibrary : implements IWULibrary, public CInterface
  3721. {
  3722. Owned<IPropertyTree> p;
  3723. public:
  3724. IMPLEMENT_IINTERFACE;
  3725. CLocalWULibrary(IPropertyTree *p);
  3726. virtual IStringVal & getName(IStringVal & str) const;
  3727. virtual void setName(const char * str);
  3728. };
  3729. class CLocalWUException : implements IWUException, public CInterface
  3730. {
  3731. Owned<IPropertyTree> p;
  3732. public:
  3733. IMPLEMENT_IINTERFACE;
  3734. CLocalWUException(IPropertyTree *p);
  3735. virtual IStringVal& getExceptionSource(IStringVal &str) const override;
  3736. virtual IStringVal& getExceptionMessage(IStringVal &str) const override;
  3737. virtual unsigned getExceptionCode() const override;
  3738. virtual ErrorSeverity getSeverity() const override;
  3739. virtual IStringVal & getTimeStamp(IStringVal & dt) const override;
  3740. virtual IStringVal & getExceptionFileName(IStringVal & str) const override;
  3741. virtual unsigned getExceptionLineNo() const override;
  3742. virtual unsigned getExceptionColumn() const override;
  3743. virtual unsigned getActivityId() const override;
  3744. virtual unsigned getSequence() const override;
  3745. virtual const char * queryScope() const override;
  3746. virtual unsigned getPriority() const override;
  3747. virtual void setExceptionSource(const char *str) override;
  3748. virtual void setExceptionMessage(const char *str) override;
  3749. virtual void setExceptionCode(unsigned code) override;
  3750. virtual void setSeverity(ErrorSeverity level) override;
  3751. virtual void setTimeStamp(const char * dt) override;
  3752. virtual void setExceptionFileName(const char *str) override;
  3753. virtual void setExceptionLineNo(unsigned r) override;
  3754. virtual void setExceptionColumn(unsigned c) override;
  3755. virtual void setActivityId(unsigned _id) override;
  3756. virtual void setScope(const char * _scope) override;
  3757. virtual void setPriority(unsigned _priority) override;
  3758. };
  3759. //==========================================================================================
  3760. extern WORKUNIT_API bool isSpecialResultSequence(unsigned sequence)
  3761. {
  3762. switch ((int) sequence)
  3763. {
  3764. case ResultSequenceInternal:
  3765. case ResultSequenceOnce:
  3766. case ResultSequencePersist:
  3767. case ResultSequenceStored:
  3768. return true;
  3769. default:
  3770. assertex(sequence <= INT_MAX);
  3771. return false;
  3772. }
  3773. }
  3774. class CConstWUArrayIterator : implements IConstWorkUnitIterator, public CInterface
  3775. {
  3776. unsigned curTreeNum;
  3777. IArrayOf<IPropertyTree> trees;
  3778. Owned<IConstWorkUnitInfo> cur;
  3779. void setCurrent()
  3780. {
  3781. cur.setown(new CLightweightWorkunitInfo(trees.item(curTreeNum)));
  3782. }
  3783. public:
  3784. IMPLEMENT_IINTERFACE;
  3785. CConstWUArrayIterator(IArrayOf<IPropertyTree> &_trees)
  3786. {
  3787. ForEachItemIn(t, _trees)
  3788. trees.append(*LINK(&_trees.item(t)));
  3789. curTreeNum = 0;
  3790. }
  3791. bool first()
  3792. {
  3793. curTreeNum = 0;
  3794. return next();
  3795. }
  3796. bool isValid()
  3797. {
  3798. return (NULL != cur.get());
  3799. }
  3800. bool next()
  3801. {
  3802. if (curTreeNum >= trees.ordinality())
  3803. {
  3804. cur.clear();
  3805. return false;
  3806. }
  3807. setCurrent();
  3808. ++curTreeNum;
  3809. return true;
  3810. }
  3811. IConstWorkUnitInfo & query() { return *cur; }
  3812. };
  3813. class CLocalWUFieldUsage : public CInterface, implements IConstWUFieldUsage
  3814. {
  3815. Owned<IPropertyTree> p;
  3816. public:
  3817. IMPLEMENT_IINTERFACE;
  3818. CLocalWUFieldUsage(IPropertyTree& _p) { p.setown(&_p); }
  3819. virtual const char * queryName() const { return p->queryProp("@name"); }
  3820. };
  3821. class CConstWUFieldUsageIterator : public CInterface, implements IConstWUFieldUsageIterator
  3822. {
  3823. public:
  3824. IMPLEMENT_IINTERFACE;
  3825. CConstWUFieldUsageIterator(IPropertyTreeIterator * tree) { iter.setown(tree); }
  3826. bool first() override { return iter->first(); }
  3827. bool isValid() override { return iter->isValid(); }
  3828. bool next() override { return iter->next(); }
  3829. IConstWUFieldUsage * get() const override { return new CLocalWUFieldUsage(iter->get()); }
  3830. private:
  3831. Owned<IPropertyTreeIterator> iter;
  3832. };
  3833. class CLocalWUFileUsage : public CInterface, implements IConstWUFileUsage
  3834. {
  3835. Owned<IPropertyTree> p;
  3836. public:
  3837. IMPLEMENT_IINTERFACE;
  3838. CLocalWUFileUsage(IPropertyTree& _p) { p.setown(&_p); }
  3839. virtual const char * queryName() const { return p->queryProp("@name"); }
  3840. virtual const char * queryType() const { return p->queryProp("@type"); }
  3841. virtual unsigned getNumFields() const { return p->getPropInt("@numFields"); }
  3842. virtual unsigned getNumFieldsUsed() const { return p->getPropInt("@numFieldsUsed"); }
  3843. virtual IConstWUFieldUsageIterator * getFields() const { return new CConstWUFieldUsageIterator(p->getElements("fields/field")); }
  3844. };
  3845. class CConstWUFileUsageIterator : public CInterface, implements IConstWUFileUsageIterator
  3846. {
  3847. public:
  3848. IMPLEMENT_IINTERFACE;
  3849. CConstWUFileUsageIterator(IPropertyTreeIterator * tree) { iter.setown(tree); }
  3850. bool first() override { return iter->first(); }
  3851. bool isValid() override { return iter->isValid(); }
  3852. bool next() override { return iter->next(); }
  3853. IConstWUFileUsage * get() const override { return new CLocalWUFileUsage(iter->get()); }
  3854. private:
  3855. Owned<IPropertyTreeIterator> iter;
  3856. };
  3857. //==========================================================================================
  3858. class CStringArrayIterator : implements IStringIterator, public CInterface
  3859. {
  3860. unsigned idx;
  3861. StringArray strings;
  3862. public:
  3863. IMPLEMENT_IINTERFACE;
  3864. CStringArrayIterator() { idx = 0; };
  3865. void append(const char *str) { strings.append(str); }
  3866. virtual bool first() { idx = 0; return strings.isItem(idx); }
  3867. virtual bool next() { idx ++; return strings.isItem(idx); }
  3868. virtual bool isValid() { return strings.isItem(idx); }
  3869. virtual IStringVal & str(IStringVal &s) { s.set(strings.item(idx)); return s; }
  3870. };
  3871. class CCachedJobNameIterator : implements IStringIterator, public CInterface
  3872. {
  3873. Owned<IPropertyTreeIterator> it;
  3874. public:
  3875. IMPLEMENT_IINTERFACE;
  3876. CCachedJobNameIterator(IPropertyTreeIterator *p) : it(p) {};
  3877. virtual bool first() { return it->first(); }
  3878. virtual bool next() { return it->next(); }
  3879. virtual bool isValid() { return it->isValid(); }
  3880. virtual IStringVal & str(IStringVal &s) { s.set(it->query().queryName()+1); return s; }
  3881. };
  3882. class CEmptyStringIterator : implements IStringIterator, public CInterface
  3883. {
  3884. public:
  3885. IMPLEMENT_IINTERFACE;
  3886. virtual bool first() { return false; }
  3887. virtual bool next() { return false; }
  3888. virtual bool isValid() { return false; }
  3889. virtual IStringVal & str(IStringVal &s) { s.clear(); return s; }
  3890. };
  3891. EnumMapping workunitSortFields[] =
  3892. {
  3893. { WUSFuser, "@submitID" },
  3894. { WUSFcluster, "@clusterName" },
  3895. { WUSFjob, "@jobName" },
  3896. { WUSFstate, "@state" },
  3897. { WUSFpriority, "@priorityClass" },
  3898. { WUSFprotected, "@protected" },
  3899. { WUSFwuid, "@" },
  3900. { WUSFecl, "Query/ShortText" },
  3901. { WUSFfileread, "FilesRead/File/@name" },
  3902. { WUSFtotalthortime, "@totalThorTime|"
  3903. "Statistics/Statistic[@c='summary'][@creator='thor'][@kind='TimeElapsed']/@value|"
  3904. "Statistics/Statistic[@c='summary'][@creator='hthor'][@kind='TimeElapsed']/@value|"
  3905. "Statistics/Statistic[@c='summary'][@creator='roxie'][@kind='TimeElapsed']/@value|"
  3906. "Statistics/Statistic[@desc='Total thor time']/@value|"
  3907. "Timings/Timing[@name='Total thor time']/@duration" //Use Statistics first. If not found, use Timings
  3908. },
  3909. { WUSFwuidhigh, "@" },
  3910. { WUSFwildwuid, "@" },
  3911. { WUSFappvalue, "Application" },
  3912. { WUSFfilewritten, "Files/File/@name" },
  3913. { WUSFterm, NULL }
  3914. };
  3915. extern const char *queryFilterXPath(WUSortField field)
  3916. {
  3917. return getEnumText(field, workunitSortFields);
  3918. }
  3919. EnumMapping querySortFields[] =
  3920. {
  3921. { WUQSFId, "@id" },
  3922. { WUQSFwuid, "@wuid" },
  3923. { WUQSFname, "@name" },
  3924. { WUQSFdll, "@dll" },
  3925. { WUQSFmemoryLimit, "@memoryLimit" },
  3926. { WUQSFmemoryLimitHi, "@memoryLimit" },
  3927. { WUQSFtimeLimit, "@timeLimit" },
  3928. { WUQSFtimeLimitHi, "@timeLimit" },
  3929. { WUQSFwarnTimeLimit, "@warnTimeLimit" },
  3930. { WUQSFwarnTimeLimitHi, "@warnTimeLimit" },
  3931. { WUQSFpriority, "@priority" },
  3932. { WUQSFpriorityHi, "@priority" },
  3933. { WUQSFQuerySet, "@querySetId" },
  3934. { WUQSFActivited, "@activated" },
  3935. { WUQSFSuspendedByUser, "@suspended" },
  3936. { WUQSFLibrary, "Library"},
  3937. { WUQSFPublishedBy, "@publishedBy" },
  3938. { WUQSFterm, NULL }
  3939. };
  3940. class asyncRemoveDllWorkItem: public CInterface, implements IWorkQueueItem // class only used in asyncRemoveDll
  3941. {
  3942. StringAttr name;
  3943. public:
  3944. IMPLEMENT_IINTERFACE;
  3945. asyncRemoveDllWorkItem(const char * _name) : name(_name)
  3946. {
  3947. }
  3948. void execute()
  3949. {
  3950. PROGLOG("WU removeDll %s", name.get());
  3951. queryDllServer().removeDll(name, true, true); // <name>, removeDlls=true, removeDirectory=true
  3952. }
  3953. };
  3954. class asyncRemoveRemoteFileWorkItem: public CInterface, implements IWorkQueueItem // class only used in asyncRemoveFile
  3955. {
  3956. RemoteFilename name;
  3957. public:
  3958. IMPLEMENT_IINTERFACE;
  3959. asyncRemoveRemoteFileWorkItem(const char * _ip, const char * _name)
  3960. {
  3961. SocketEndpoint ep(_ip);
  3962. name.setPath(ep, _name);
  3963. }
  3964. void execute()
  3965. {
  3966. Owned<IFile> file = createIFile(name);
  3967. PROGLOG("WU removeDll %s",file->queryFilename());
  3968. file->remove();
  3969. }
  3970. };
  3971. //==========================================================================================
  3972. class CConstQuerySetQueryIterator : implements IConstQuerySetQueryIterator, public CInterface
  3973. {
  3974. unsigned index;
  3975. IArrayOf<IPropertyTree> trees;
  3976. public:
  3977. IMPLEMENT_IINTERFACE;
  3978. CConstQuerySetQueryIterator(IArrayOf<IPropertyTree> &_trees)
  3979. {
  3980. ForEachItemIn(t, _trees)
  3981. trees.append(*LINK(&_trees.item(t)));
  3982. index = 0;
  3983. }
  3984. ~CConstQuerySetQueryIterator()
  3985. {
  3986. trees.kill();
  3987. }
  3988. bool first()
  3989. {
  3990. index = 0;
  3991. return (trees.ordinality()!=0);
  3992. }
  3993. bool next()
  3994. {
  3995. index++;
  3996. return (index<trees.ordinality());
  3997. }
  3998. bool isValid()
  3999. {
  4000. return (index<trees.ordinality());
  4001. }
  4002. IPropertyTree &query()
  4003. {
  4004. return trees.item(index);
  4005. }
  4006. };
  4007. class CSecurityCache
  4008. {
  4009. };
  4010. class CConstWUIterator : implements IConstWorkUnitIterator, public CInterface
  4011. {
  4012. public:
  4013. IMPLEMENT_IINTERFACE;
  4014. CConstWUIterator(IPropertyTreeIterator *_ptreeIter)
  4015. : ptreeIter(_ptreeIter)
  4016. {
  4017. }
  4018. bool first()
  4019. {
  4020. if (!ptreeIter->first())
  4021. {
  4022. cur.clear();
  4023. return false;
  4024. }
  4025. cur.setown(new CLightweightWorkunitInfo(ptreeIter->query()));
  4026. return true;
  4027. }
  4028. bool isValid()
  4029. {
  4030. return (NULL != cur.get());
  4031. }
  4032. bool next()
  4033. {
  4034. if (!ptreeIter->next())
  4035. {
  4036. cur.clear();
  4037. return false;
  4038. }
  4039. cur.setown(new CLightweightWorkunitInfo(ptreeIter->query()));
  4040. return true;
  4041. }
  4042. IConstWorkUnitInfo & query() { return *cur; }
  4043. private:
  4044. Owned<IConstWorkUnitInfo> cur;
  4045. Owned<IPropertyTreeIterator> ptreeIter;
  4046. };
  4047. class CSecureConstWUIterator : public CInterfaceOf<IConstWorkUnitIterator>
  4048. {
  4049. public:
  4050. CSecureConstWUIterator(IConstWorkUnitIterator *_parent, ISecManager *_secmgr=NULL, ISecUser *_secuser=NULL)
  4051. : parent(_parent), secmgr(_secmgr), secuser(_secuser)
  4052. {
  4053. assertex(_secuser && _secmgr);
  4054. }
  4055. bool first()
  4056. {
  4057. if (!parent->first())
  4058. return false;
  4059. return getNext();
  4060. }
  4061. bool next()
  4062. {
  4063. if (!parent->next())
  4064. return false;
  4065. return getNext();
  4066. }
  4067. virtual bool isValid()
  4068. {
  4069. return parent->isValid();
  4070. }
  4071. virtual IConstWorkUnitInfo &query()
  4072. {
  4073. return parent->query();
  4074. }
  4075. private:
  4076. Owned<IConstWorkUnitIterator> parent;
  4077. MapStringTo<int> scopePermissions;
  4078. Linked<ISecManager> secmgr;
  4079. Linked<ISecUser> secuser;
  4080. bool getNext() // scan for a workunit with permissions
  4081. {
  4082. do
  4083. {
  4084. const char *scopeName = parent->query().queryWuScope();
  4085. if (!scopeName || !*scopeName || checkScope(scopeName))
  4086. return true;
  4087. } while (parent->next());
  4088. return false;
  4089. }
  4090. bool checkScope(const char *scopeName)
  4091. {
  4092. int *perms = scopePermissions.getValue(scopeName);
  4093. SecAccessFlags perm;
  4094. if (!perms)
  4095. {
  4096. perm = secuser.get() ? secmgr->authorizeWorkunitScope(*secuser, scopeName) : SecAccess_Unavailable;
  4097. scopePermissions.setValue(scopeName, perm);
  4098. }
  4099. else
  4100. perm = (SecAccessFlags)*perms;
  4101. return perm >= SecAccess_Read;
  4102. }
  4103. };
  4104. CWorkUnitFactory::CWorkUnitFactory()
  4105. {
  4106. }
  4107. CWorkUnitFactory::~CWorkUnitFactory()
  4108. {
  4109. }
  4110. IWorkUnit* CWorkUnitFactory::createNamedWorkUnit(const char *wuid, const char *app, const char *scope, ISecManager *secmgr, ISecUser *secuser)
  4111. {
  4112. checkWuScopeSecAccess(scope, secmgr, secuser, SecAccess_Write, "Create", true, true);
  4113. Owned<CLocalWorkUnit> cw = _createWorkUnit(wuid, secmgr, secuser);
  4114. if (scope)
  4115. 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...
  4116. IWorkUnit* ret = &cw->lockRemote(false); // Note - this may throw exception if user does not have rights.
  4117. ret->setDebugValue("CREATED_BY", app, true);
  4118. ret->setDebugValue("CREATED_FOR", scope, true);
  4119. return ret;
  4120. }
  4121. IWorkUnit* CWorkUnitFactory::createWorkUnit(const char *app, const char *scope, ISecManager *secmgr, ISecUser *secuser)
  4122. {
  4123. StringBuffer wuid("W");
  4124. char result[32];
  4125. time_t ltime;
  4126. time( &ltime );
  4127. tm *today = localtime( &ltime ); // MORE - this is not threadsafe. But I probably don't care that much!
  4128. strftime(result, sizeof(result), "%Y%m%d-%H%M%S", today);
  4129. wuid.append(result);
  4130. if (workUnitTraceLevel > 1)
  4131. PrintLog("createWorkUnit created %s", wuid.str());
  4132. IWorkUnit* ret = createNamedWorkUnit(wuid.str(), app, scope, secmgr, secuser);
  4133. if (workUnitTraceLevel > 1)
  4134. PrintLog("createWorkUnit created %s", ret->queryWuid());
  4135. addTimeStamp(ret, SSTglobal, NULL, StWhenCreated);
  4136. return ret;
  4137. }
  4138. bool CWorkUnitFactory::deleteWorkUnit(const char * wuid, ISecManager *secmgr, ISecUser *secuser)
  4139. {
  4140. if (workUnitTraceLevel > 1)
  4141. PrintLog("deleteWorkUnit %s", wuid);
  4142. StringBuffer wuRoot;
  4143. getXPath(wuRoot, wuid);
  4144. Owned<CLocalWorkUnit> cw = _updateWorkUnit(wuid, secmgr, secuser);
  4145. if (!checkWuSecAccess(*cw.get(), secmgr, secuser, SecAccess_Full, "delete", true, true))
  4146. return false;
  4147. try
  4148. {
  4149. cw->cleanupAndDelete(true, true);
  4150. }
  4151. catch (IException *E)
  4152. {
  4153. StringBuffer s;
  4154. LOG(MCexception(E, MSGCLS_warning), E, s.append("Exception during deleteWorkUnit: ").append(wuid).str());
  4155. E->Release();
  4156. return false;
  4157. }
  4158. removeWorkUnitFromAllQueues(wuid); //known active workunits wouldn't make it this far
  4159. return true;
  4160. }
  4161. IConstWorkUnit* CWorkUnitFactory::openWorkUnit(const char *wuid, ISecManager *secmgr, ISecUser *secuser)
  4162. {
  4163. StringBuffer wuidStr(wuid);
  4164. wuidStr.trim();
  4165. if (wuidStr.length() && ('w' == wuidStr.charAt(0)))
  4166. wuidStr.setCharAt(0, 'W');
  4167. if (!wuidStr.length() || ('W' != wuidStr.charAt(0)))
  4168. {
  4169. if (workUnitTraceLevel > 1)
  4170. PrintLog("openWorkUnit %s invalid WUID", nullText(wuidStr.str()));
  4171. return NULL;
  4172. }
  4173. if (workUnitTraceLevel > 1)
  4174. PrintLog("openWorkUnit %s", wuidStr.str());
  4175. Owned<IConstWorkUnit> wu = _openWorkUnit(wuid, secmgr, secuser);
  4176. if (wu)
  4177. {
  4178. if (!checkWuSecAccess(*wu, secmgr, secuser, SecAccess_Read, "opening", true, true))
  4179. return NULL; // Actually throws exception on failure, so won't reach here
  4180. return wu.getClear();
  4181. }
  4182. else
  4183. {
  4184. if (workUnitTraceLevel > 0)
  4185. PrintLog("openWorkUnit %s not found", wuidStr.str());
  4186. return NULL;
  4187. }
  4188. }
  4189. IWorkUnit* CWorkUnitFactory::updateWorkUnit(const char *wuid, ISecManager *secmgr, ISecUser *secuser)
  4190. {
  4191. if (workUnitTraceLevel > 1)
  4192. PrintLog("updateWorkUnit %s", wuid);
  4193. Owned<CLocalWorkUnit> wu = _updateWorkUnit(wuid, secmgr, secuser);
  4194. if (wu)
  4195. {
  4196. if (!checkWuSecAccess(*wu.get(), secmgr, secuser, SecAccess_Write, "updating", true, true))
  4197. return NULL;
  4198. return &wu->lockRemote(false);
  4199. }
  4200. else
  4201. {
  4202. if (workUnitTraceLevel > 0)
  4203. PrintLog("updateWorkUnit %s not found", wuid);
  4204. return NULL;
  4205. }
  4206. }
  4207. IPropertyTree * pruneBranch(IPropertyTree * from, char const * xpath)
  4208. {
  4209. Owned<IPropertyTree> ret;
  4210. IPropertyTree * branch = from->queryPropTree(xpath);
  4211. if(branch)
  4212. {
  4213. ret.setown(createPTreeFromIPT(branch));
  4214. from->removeTree(branch);
  4215. }
  4216. return ret.getClear();
  4217. }
  4218. bool CWorkUnitFactory::restoreWorkUnit(const char *base, const char *wuid, bool restoreAssociated)
  4219. {
  4220. StringBuffer path(base);
  4221. addPathSepChar(path).append(wuid).append(".xml");
  4222. Owned<IPTree> pt = createPTreeFromXMLFile(path);
  4223. if (!pt)
  4224. return false;
  4225. CDateTime dt;
  4226. dt.setNow();
  4227. StringBuffer dts;
  4228. dt.getString(dts);
  4229. pt->setProp("@restoredDate", dts.str());
  4230. Owned<IPropertyTree> generatedDlls = pruneBranch(pt, "GeneratedDlls[1]");
  4231. Owned<IPropertyTree> associatedFiles;
  4232. IPropertyTree *srcAssociated = pt->queryPropTree("Query/Associated");
  4233. if (srcAssociated)
  4234. associatedFiles.setown(createPTreeFromIPT(srcAssociated));
  4235. // The updating of the repo is implementation specific...
  4236. if (!_restoreWorkUnit(pt.getClear(), wuid))
  4237. return false;
  4238. // now kludge back GeneratedDlls
  4239. if (generatedDlls)
  4240. {
  4241. Owned<IPropertyTreeIterator> dlls = generatedDlls->getElements("GeneratedDll");
  4242. for(dlls->first(); dlls->isValid(); dlls->next())
  4243. {
  4244. IPropertyTree & dll = dlls->query();
  4245. char const * name = dll.queryProp("@name");
  4246. char const * kind = dll.queryProp("@kind");
  4247. char const * location = dll.queryProp("@location");
  4248. Owned<IDllEntry> got = queryDllServer().getEntry(name);
  4249. if (!got)
  4250. {
  4251. RemoteFilename dstRfn;
  4252. dstRfn.setRemotePath(location);
  4253. StringBuffer srcPath(base);
  4254. addPathSepChar(srcPath);
  4255. dstRfn.getTail(srcPath);
  4256. OwnedIFile srcFile = createIFile(srcPath);
  4257. OwnedIFile dstFile = createIFile(dstRfn);
  4258. copyFile(dstFile, srcFile);
  4259. queryDllServer().registerDll(name, kind, location);
  4260. }
  4261. }
  4262. }
  4263. if (associatedFiles)
  4264. {
  4265. Owned<IPropertyTreeIterator> associated = associatedFiles->getElements("*");
  4266. ForEach(*associated)
  4267. {
  4268. IPropertyTree &file = associated->query();
  4269. const char *filename = file.queryProp("@filename");
  4270. SocketEndpoint ep(file.queryProp("@ip"));
  4271. RemoteFilename rfn;
  4272. rfn.setPath(ep, filename);
  4273. OwnedIFile dstFile = createIFile(rfn);
  4274. StringBuffer srcPath(base), name;
  4275. addPathSepChar(srcPath);
  4276. rfn.getTail(name);
  4277. srcPath.append(name);
  4278. if (generatedDlls)
  4279. {
  4280. VStringBuffer gDllPath("GeneratedDll[@name=\"%s\"]", name.str());
  4281. if (generatedDlls->hasProp(gDllPath))
  4282. continue; // generated dlls handled separately - see above
  4283. }
  4284. OwnedIFile srcFile = createIFile(srcPath);
  4285. if (srcFile->exists())
  4286. {
  4287. try
  4288. {
  4289. copyFile(dstFile, srcFile);
  4290. }
  4291. catch (IException *e)
  4292. {
  4293. VStringBuffer msg("Failed to restore associated file '%s' to destination '%s'", srcFile->queryFilename(), dstFile->queryFilename());
  4294. EXCLOG(e, msg.str());
  4295. e->Release();
  4296. }
  4297. }
  4298. }
  4299. }
  4300. return true;
  4301. }
  4302. int CWorkUnitFactory::setTracingLevel(int newLevel)
  4303. {
  4304. if (newLevel)
  4305. PrintLog("Setting workunit trace level to %d", newLevel);
  4306. int level = workUnitTraceLevel;
  4307. workUnitTraceLevel = newLevel;
  4308. return level;
  4309. }
  4310. void CWorkUnitFactory::descheduleAllWorkUnits(ISecManager *secmgr, ISecUser *secuser)
  4311. {
  4312. Owned<IRemoteConnection> conn = querySDS().connect("/Schedule", myProcessSession(), RTM_LOCK_WRITE, SDS_LOCK_TIMEOUT);
  4313. if(!conn) return;
  4314. Owned<IPropertyTree> root(conn->queryRoot()->getBranch("."));
  4315. KeptAtomTable entries;
  4316. Owned<IPropertyTreeIterator> iter(root->getElements("*/*/*/*"));
  4317. StringBuffer wuid;
  4318. for(iter->first(); iter->isValid(); iter->next())
  4319. {
  4320. char const * entry = iter->query().queryName();
  4321. if(!entries.find(entry))
  4322. {
  4323. entries.addAtom(entry);
  4324. ncnameUnescape(entry, wuid.clear());
  4325. Owned<IWorkUnit> wu = updateWorkUnit(wuid, secmgr, secuser);
  4326. if(wu && (wu->getState() == WUStateWait))
  4327. wu->setState(WUStateCompleted);
  4328. }
  4329. }
  4330. bool more;
  4331. do more = root->removeProp("*"); while(more);
  4332. }
  4333. IConstQuerySetQueryIterator* CWorkUnitFactory::getQuerySetQueriesSorted( WUQuerySortField *sortorder, // list of fields to sort by (terminated by WUSFterm)
  4334. WUQuerySortField *filters, // NULL or list of fields to filter on (terminated by WUSFterm)
  4335. const void *filterbuf, // (appended) string values for filters
  4336. unsigned startoffset,
  4337. unsigned maxnum,
  4338. __int64 *cachehint,
  4339. unsigned *total,
  4340. const MapStringTo<bool> *_subset)
  4341. {
  4342. struct PostFilters
  4343. {
  4344. WUQueryFilterBoolean activatedFilter;
  4345. WUQueryFilterBoolean suspendedByUserFilter;
  4346. PostFilters()
  4347. {
  4348. activatedFilter = WUQFSAll;
  4349. suspendedByUserFilter = WUQFSAll;
  4350. };
  4351. } postFilters;
  4352. class CQuerySetQueriesPager : public CSimpleInterface, implements IElementsPager
  4353. {
  4354. StringAttr querySet;
  4355. StringAttr xPath;
  4356. StringAttr sortOrder;
  4357. PostFilters postFilters;
  4358. StringArray unknownAttributes;
  4359. const MapStringTo<bool> *subset;
  4360. void populateQueryTree(const IPropertyTree* querySetTree, IPropertyTree* queryTree)
  4361. {
  4362. const char* querySetId = querySetTree->queryProp("@id");
  4363. VStringBuffer path("Query%s", xPath.get());
  4364. Owned<IPropertyTreeIterator> iter = querySetTree->getElements(path.str());
  4365. ForEach(*iter)
  4366. {
  4367. IPropertyTree &query = iter->query();
  4368. bool activated = false;
  4369. const char* queryId = query.queryProp("@id");
  4370. if (queryId && *queryId)
  4371. {
  4372. if (subset)
  4373. {
  4374. VStringBuffer match("%s/%s", querySetId, queryId);
  4375. if (!subset->getValue(match))
  4376. continue;
  4377. }
  4378. VStringBuffer aliasXPath("Alias[@id='%s']", queryId);
  4379. IPropertyTree *alias = querySetTree->queryPropTree(aliasXPath.str());
  4380. if (alias)
  4381. activated = true;
  4382. }
  4383. if (activated && (postFilters.activatedFilter == WUQFSNo))
  4384. continue;
  4385. if (!activated && (postFilters.activatedFilter == WUQFSYes))
  4386. continue;
  4387. if ((postFilters.suspendedByUserFilter == WUQFSNo) && query.hasProp(getEnumText(WUQSFSuspendedByUser,querySortFields)))
  4388. continue;
  4389. if ((postFilters.suspendedByUserFilter == WUQFSYes) && !query.hasProp(getEnumText(WUQSFSuspendedByUser,querySortFields)))
  4390. continue;
  4391. IPropertyTree *queryWithSetId = queryTree->addPropTree("Query", createPTreeFromIPT(&query));
  4392. queryWithSetId->setProp("@querySetId", querySetId);
  4393. queryWithSetId->setPropBool("@activated", activated);
  4394. }
  4395. }
  4396. IRemoteConnection* populateQueryTree(IPropertyTree* queryTree)
  4397. {
  4398. StringBuffer querySetXPath("QuerySets");
  4399. if (!querySet.isEmpty())
  4400. querySetXPath.appendf("/QuerySet[@id=\"%s\"]", querySet.get());
  4401. Owned<IRemoteConnection> conn = querySDS().connect(querySetXPath.str(), myProcessSession(), 0, SDS_LOCK_TIMEOUT);
  4402. if (!conn)
  4403. return NULL;
  4404. if (querySet.isEmpty())
  4405. {
  4406. Owned<IPropertyTreeIterator> querySetIter = conn->queryRoot()->getElements("*");
  4407. ForEach(*querySetIter)
  4408. populateQueryTree(&querySetIter->query(), queryTree);
  4409. }
  4410. else
  4411. populateQueryTree(conn->queryRoot(), queryTree);
  4412. return conn.getClear();
  4413. }
  4414. public:
  4415. IMPLEMENT_IINTERFACE_USING(CSimpleInterface);
  4416. CQuerySetQueriesPager(const char* _querySet, const char* _xPath, const char *_sortOrder, PostFilters& _postFilters, StringArray& _unknownAttributes, const MapStringTo<bool> *_subset)
  4417. : querySet(_querySet), xPath(_xPath), sortOrder(_sortOrder), subset(_subset)
  4418. {
  4419. postFilters.activatedFilter = _postFilters.activatedFilter;
  4420. postFilters.suspendedByUserFilter = _postFilters.suspendedByUserFilter;
  4421. ForEachItemIn(x, _unknownAttributes)
  4422. unknownAttributes.append(_unknownAttributes.item(x));
  4423. }
  4424. virtual IRemoteConnection* getElements(IArrayOf<IPropertyTree> &elements)
  4425. {
  4426. Owned<IPropertyTree> elementTree = createPTree("Queries");
  4427. Owned<IRemoteConnection> conn = populateQueryTree(elementTree);
  4428. if (!conn)
  4429. return NULL;
  4430. Owned<IPropertyTreeIterator> iter = elementTree->getElements("*");
  4431. if (!iter)
  4432. return NULL;
  4433. sortElements(iter, sortOrder.get(), NULL, NULL, unknownAttributes, elements);
  4434. return conn.getClear();
  4435. }
  4436. virtual bool allMatchingElementsReceived() { return true; } //For now, dali always returns all of matched Queries.
  4437. };
  4438. StringAttr querySet;
  4439. StringBuffer xPath;
  4440. StringBuffer so;
  4441. StringArray unknownAttributes;
  4442. if (filters)
  4443. {
  4444. const char *fv = (const char *)filterbuf;
  4445. for (unsigned i=0;filters[i]!=WUQSFterm;i++) {
  4446. int fmt = filters[i];
  4447. int subfmt = (fmt&0xff);
  4448. if (subfmt==WUQSFQuerySet)
  4449. querySet.set(fv);
  4450. else if ((subfmt==WUQSFmemoryLimit) || (subfmt==WUQSFtimeLimit) || (subfmt==WUQSFwarnTimeLimit) || (subfmt==WUQSFpriority))
  4451. xPath.append('[').append(getEnumText(subfmt,querySortFields)).append(">=").append(fv).append("]");
  4452. else if ((subfmt==WUQSFmemoryLimitHi) || (subfmt==WUQSFtimeLimitHi) || (subfmt==WUQSFwarnTimeLimitHi) || (subfmt==WUQSFpriorityHi))
  4453. xPath.append('[').append(getEnumText(subfmt,querySortFields)).append("<=").append(fv).append("]");
  4454. else if (subfmt==WUQSFActivited)
  4455. postFilters.activatedFilter = (WUQueryFilterBoolean) atoi(fv);
  4456. else if (subfmt==WUQSFSuspendedByUser)
  4457. postFilters.suspendedByUserFilter = (WUQueryFilterBoolean) atoi(fv);
  4458. else if (!fv || !*fv)
  4459. unknownAttributes.append(getEnumText(subfmt,querySortFields));
  4460. else {
  4461. xPath.append('[').append(getEnumText(subfmt,querySortFields)).append('=');
  4462. if (fmt&WUQSFnocase)
  4463. xPath.append('?');
  4464. if (fmt&WUQSFnumeric)
  4465. xPath.append('#');
  4466. if (fmt&WUQSFwild)
  4467. xPath.append('~');
  4468. xPath.append('"').append(fv).append("\"]");
  4469. }
  4470. fv = fv + strlen(fv)+1;
  4471. }
  4472. }
  4473. if (sortorder) {
  4474. for (unsigned i=0;sortorder[i]!=WUQSFterm;i++) {
  4475. if (so.length())
  4476. so.append(',');
  4477. int fmt = sortorder[i];
  4478. if (fmt&WUQSFreverse)
  4479. so.append('-');
  4480. if (fmt&WUQSFnocase)
  4481. so.append('?');
  4482. if (fmt&WUQSFnumeric)
  4483. so.append('#');
  4484. so.append(getEnumText(fmt&0xff,querySortFields));
  4485. }
  4486. }
  4487. IArrayOf<IPropertyTree> results;
  4488. Owned<IElementsPager> elementsPager = new CQuerySetQueriesPager(querySet.get(), xPath.str(), so.length()?so.str():NULL, postFilters, unknownAttributes, _subset);
  4489. Owned<IRemoteConnection> conn=getElementsPaged(elementsPager,startoffset,maxnum,NULL,"",cachehint,results,total,NULL);
  4490. return new CConstQuerySetQueryIterator(results);
  4491. }
  4492. bool CWorkUnitFactory::isAborting(const char *wuid) const
  4493. {
  4494. VStringBuffer apath("/WorkUnitAborts/%s", wuid);
  4495. try
  4496. {
  4497. Owned<IRemoteConnection> acon = querySDS().connect(apath.str(), myProcessSession(), 0, SDS_LOCK_TIMEOUT);
  4498. if (acon)
  4499. return acon->queryRoot()->getPropInt(NULL) != 0;
  4500. }
  4501. catch (IException *E)
  4502. {
  4503. EXCLOG(E);
  4504. E->Release();
  4505. }
  4506. return false;
  4507. }
  4508. void CWorkUnitFactory::clearAborting(const char *wuid)
  4509. {
  4510. VStringBuffer apath("/WorkUnitAborts/%s", wuid);
  4511. try
  4512. {
  4513. Owned<IRemoteConnection> acon = querySDS().connect(apath.str(), myProcessSession(), RTM_LOCK_WRITE|RTM_LOCK_SUB, SDS_LOCK_TIMEOUT);
  4514. if (acon)
  4515. acon->close(true);
  4516. }
  4517. catch (IException *E)
  4518. {
  4519. EXCLOG(E);
  4520. E->Release();
  4521. }
  4522. }
  4523. void CWorkUnitFactory::reportAbnormalTermination(const char *wuid, WUState &state, SessionId agent)
  4524. {
  4525. WARNLOG("reportAbnormalTermination: session stopped unexpectedly: %" I64F "d state: %d", (__int64) agent, (int) state);
  4526. bool isEcl = false;
  4527. switch (state)
  4528. {
  4529. case WUStateAborting:
  4530. state = WUStateAborted;
  4531. break;
  4532. case WUStateCompiling:
  4533. isEcl = true;
  4534. // drop into
  4535. default:
  4536. state = WUStateFailed;
  4537. }
  4538. Owned<IWorkUnit> wu = updateWorkUnit(wuid, NULL, NULL);
  4539. wu->setState(state);
  4540. Owned<IWUException> e = wu->createException();
  4541. e->setExceptionCode(isEcl ? 1001 : 1000);
  4542. e->setExceptionMessage(isEcl ? "EclServer terminated unexpectedly" : "Workunit terminated unexpectedly");
  4543. }
  4544. static CriticalSection deleteDllLock;
  4545. static IWorkQueueThread *deleteDllWorkQ = nullptr;
  4546. MODULE_INIT(INIT_PRIORITY_STANDARD)
  4547. {
  4548. return true;
  4549. }
  4550. MODULE_EXIT()
  4551. {
  4552. CriticalBlock b(deleteDllLock);
  4553. if (deleteDllWorkQ)
  4554. ::Release(deleteDllWorkQ);
  4555. deleteDllWorkQ = nullptr;
  4556. }
  4557. static void asyncRemoveDll(const char * name)
  4558. {
  4559. CriticalBlock b(deleteDllLock);
  4560. if (!deleteDllWorkQ)
  4561. deleteDllWorkQ = createWorkQueueThread();
  4562. deleteDllWorkQ->post(new asyncRemoveDllWorkItem(name));
  4563. }
  4564. static void asyncRemoveFile(const char * ip, const char * name)
  4565. {
  4566. CriticalBlock b(deleteDllLock);
  4567. if (!deleteDllWorkQ)
  4568. deleteDllWorkQ = createWorkQueueThread();
  4569. deleteDllWorkQ->post(new asyncRemoveRemoteFileWorkItem(ip, name));
  4570. }
  4571. class CDaliWorkUnitFactory : public CWorkUnitFactory, implements IDaliClientShutdown
  4572. {
  4573. public:
  4574. IMPLEMENT_IINTERFACE_USING(CWorkUnitFactory);
  4575. CDaliWorkUnitFactory()
  4576. {
  4577. // Assumes dali client configuration has already been done
  4578. sdsManager = &querySDS();
  4579. session = myProcessSession();
  4580. addShutdownHook(*this);
  4581. }
  4582. ~CDaliWorkUnitFactory()
  4583. {
  4584. removeShutdownHook(*this);
  4585. }
  4586. virtual bool initializeStore()
  4587. {
  4588. throwUnexpected(); // Used when loading a plugin factory - not applicable here
  4589. }
  4590. virtual IWorkUnitWatcher *getWatcher(IWorkUnitSubscriber *subscriber, WUSubscribeOptions options, const char *wuid) const
  4591. {
  4592. return new CDaliWorkUnitWatcher(subscriber, options, wuid);
  4593. }
  4594. virtual unsigned validateRepository(bool fixErrors)
  4595. {
  4596. return 0;
  4597. }
  4598. virtual void deleteRepository(bool recreate)
  4599. {
  4600. Owned<IRemoteConnection> conn = sdsManager->connect("/WorkUnits", session, RTM_LOCK_WRITE, SDS_LOCK_TIMEOUT);
  4601. if (conn)
  4602. conn->close(true);
  4603. conn.setown(sdsManager->connect("/GraphProgress", session, RTM_LOCK_WRITE, SDS_LOCK_TIMEOUT));
  4604. if (conn)
  4605. conn->close(true);
  4606. }
  4607. virtual void createRepository()
  4608. {
  4609. // Nothing to do
  4610. }
  4611. virtual const char *queryStoreType() const
  4612. {
  4613. return "Dali";
  4614. }
  4615. virtual CLocalWorkUnit *_createWorkUnit(const char *wuid, ISecManager *secmgr, ISecUser *secuser)
  4616. {
  4617. StringBuffer wuRoot;
  4618. getXPath(wuRoot, wuid);
  4619. IRemoteConnection *conn;
  4620. conn = sdsManager->connect(wuRoot.str(), session, RTM_LOCK_WRITE|RTM_CREATE_UNIQUE, SDS_LOCK_TIMEOUT);
  4621. conn->queryRoot()->setProp("@xmlns:xsi", "http://www.w3.org/1999/XMLSchema-instance");
  4622. conn->queryRoot()->setPropInt("@wuidVersion", WUID_VERSION);
  4623. conn->queryRoot()->setProp("@totalThorTime", "");
  4624. return new CDaliWorkUnit(conn, secmgr, secuser);
  4625. }
  4626. virtual CLocalWorkUnit* _openWorkUnit(const char *wuid, ISecManager *secmgr, ISecUser *secuser)
  4627. {
  4628. StringBuffer wuRoot;
  4629. getXPath(wuRoot, wuid);
  4630. IRemoteConnection* conn = sdsManager->connect(wuRoot.str(), session, 0, SDS_LOCK_TIMEOUT);
  4631. if (conn)
  4632. return new CDaliWorkUnit(conn, secmgr, secuser);
  4633. else
  4634. return NULL;
  4635. }
  4636. virtual bool _restoreWorkUnit(IPTree *_pt, const char *wuid)
  4637. {
  4638. Owned<IPTree> pt(_pt);
  4639. Owned<IPropertyTree> gprogress = pruneBranch(pt, "GraphProgress[1]");
  4640. StringBuffer wuRoot;
  4641. getXPath(wuRoot, wuid);
  4642. Owned<IRemoteConnection> conn = sdsManager->connect(wuRoot.str(), myProcessSession(), RTM_LOCK_WRITE|RTM_CREATE_QUERY, SDS_LOCK_TIMEOUT);
  4643. if (!conn)
  4644. {
  4645. ERRLOG("restoreWorkUnit could not create to %s", wuRoot.str());
  4646. return false;
  4647. }
  4648. IPropertyTree *root = conn->queryRoot();
  4649. if (root->hasChildren())
  4650. {
  4651. ERRLOG("restoreWorkUnit WUID %s already exists", wuid);
  4652. return false;
  4653. }
  4654. root->setPropTree(NULL, pt.getClear());
  4655. conn.clear();
  4656. // now kludge back GraphProgress
  4657. if (gprogress)
  4658. {
  4659. VStringBuffer xpath("/GraphProgress/%s", wuid);
  4660. conn.setown(querySDS().connect(xpath, myProcessSession(), RTM_LOCK_WRITE|RTM_CREATE_QUERY, SDS_LOCK_TIMEOUT));
  4661. if (conn)
  4662. {
  4663. IPropertyTree *groot = conn->queryRoot();
  4664. if (groot->hasChildren())
  4665. WARNLOG("restoreWorkUnit WUID %s graphprogress already exists, replacing",wuid);
  4666. groot->setPropTree(NULL, gprogress.getClear());
  4667. }
  4668. }
  4669. return true;
  4670. }
  4671. virtual CLocalWorkUnit* _updateWorkUnit(const char *wuid, ISecManager *secmgr, ISecUser *secuser)
  4672. {
  4673. StringBuffer wuRoot;
  4674. getXPath(wuRoot, wuid);
  4675. IRemoteConnection* conn = sdsManager->connect(wuRoot.str(), session, RTM_LOCK_WRITE|RTM_LOCK_SUB, SDS_LOCK_TIMEOUT);
  4676. if (conn)
  4677. return new CDaliWorkUnit(conn, secmgr, secuser);
  4678. else
  4679. return NULL;
  4680. }
  4681. virtual IWorkUnit* getGlobalWorkUnit(ISecManager *secmgr, ISecUser *secuser)
  4682. {
  4683. // MORE - should it check security?
  4684. StringBuffer wuRoot;
  4685. getXPath(wuRoot, GLOBAL_WORKUNIT);
  4686. IRemoteConnection* conn = sdsManager->connect(wuRoot.str(), session, RTM_LOCK_WRITE|RTM_CREATE_QUERY, SDS_LOCK_TIMEOUT);
  4687. conn->queryRoot()->setProp("@xmlns:xsi", "http://www.w3.org/1999/XMLSchema-instance");
  4688. Owned<CLocalWorkUnit> cw = new CDaliWorkUnit(conn, (ISecManager *) NULL, NULL);
  4689. return &cw->lockRemote(false);
  4690. }
  4691. virtual IConstWorkUnitIterator* getWorkUnitsByOwner(const char * owner, ISecManager *secmgr, ISecUser *secuser)
  4692. {
  4693. StringBuffer path("*");
  4694. if (owner && *owner)
  4695. path.append("[@submitID=?~\"").append(owner).append("\"]");
  4696. return _getWorkUnitsByXPath(path.str(), secmgr, secuser);
  4697. }
  4698. IConstWorkUnitIterator* getScheduledWorkUnits(ISecManager *secmgr, ISecUser *secuser)
  4699. {
  4700. StringBuffer path("*");
  4701. path.append("[@state=\"").append(getEnumText(WUStateScheduled, states)).append("\"]");
  4702. return _getWorkUnitsByXPath(path.str(), secmgr, secuser);
  4703. }
  4704. virtual void clientShutdown();
  4705. virtual unsigned numWorkUnits()
  4706. {
  4707. Owned<IRemoteConnection> conn = sdsManager->connect("/WorkUnits", session, 0, SDS_LOCK_TIMEOUT);
  4708. if (!conn)
  4709. return 0;
  4710. IPropertyTree *root = conn->queryRoot();
  4711. return root->numChildren();
  4712. }
  4713. /**
  4714. * Add a filter to an xpath query, with the appropriate filter flags
  4715. */
  4716. static void appendFilterToQueryString(StringBuffer& query, int flags, const char* name, const char* value)
  4717. {
  4718. query.append('[').append(name).append('=');
  4719. if (flags & WUSFnocase)
  4720. query.append('?');
  4721. if (flags & WUSFwild)
  4722. query.append('~');
  4723. query.append('"').append(value).append("\"]");
  4724. };
  4725. IConstWorkUnitIterator* getWorkUnitsSorted( WUSortField sortorder, // field to sort by (and flags for desc sort etc)
  4726. WUSortField *filters, // NULL or list of fields to filter on (terminated by WUSFterm)
  4727. const void *filterbuf, // (appended) string values for filters
  4728. unsigned startoffset,
  4729. unsigned maxnum,
  4730. __int64 *cachehint,
  4731. unsigned *total,
  4732. ISecManager *secmgr,
  4733. ISecUser *secuser)
  4734. {
  4735. class CQueryOrFilter : public CInterface
  4736. {
  4737. unsigned flags;
  4738. StringAttr name;
  4739. StringArray values;
  4740. public:
  4741. IMPLEMENT_IINTERFACE;
  4742. CQueryOrFilter(unsigned _flags, const char *_name, const char *_value)
  4743. : flags(_flags), name(_name)
  4744. {
  4745. values.appendListUniq(_value, "|");
  4746. };
  4747. const char* queryName() { return name.get(); };
  4748. unsigned querySearchFlags() { return flags; };
  4749. const StringArray& queryValues() const { return values; };
  4750. };
  4751. class CMultiPTreeIterator : public CInterfaceOf<IPropertyTreeIterator>
  4752. {
  4753. public:
  4754. virtual bool first() override
  4755. {
  4756. curSource = 0;
  4757. while (sources.isItem(curSource))
  4758. {
  4759. if (sources.item(curSource).first())
  4760. return true;
  4761. curSource++;
  4762. }
  4763. return false;
  4764. }
  4765. virtual bool next() override
  4766. {
  4767. if (sources.isItem(curSource))
  4768. {
  4769. if (sources.item(curSource).next())
  4770. return true;
  4771. curSource++;
  4772. while (sources.isItem(curSource))
  4773. {
  4774. if (sources.item(curSource).first())
  4775. return true;
  4776. curSource++;
  4777. }
  4778. }
  4779. return false;
  4780. }
  4781. virtual bool isValid() override
  4782. {
  4783. return sources.isItem(curSource);
  4784. }
  4785. virtual IPropertyTree & query() override
  4786. {
  4787. return sources.item(curSource).query();
  4788. }
  4789. void addSource(IPropertyTreeIterator &source)
  4790. {
  4791. sources.append(source);
  4792. }
  4793. private:
  4794. IArrayOf<IPropertyTreeIterator> sources;
  4795. unsigned curSource = 0;
  4796. };
  4797. class CWorkUnitsPager : public CSimpleInterface, implements IElementsPager
  4798. {
  4799. StringAttr xPath;
  4800. StringAttr sortOrder;
  4801. StringAttr nameFilterLo;
  4802. StringAttr nameFilterHi;
  4803. StringArray unknownAttributes;
  4804. Owned<CQueryOrFilter> orFilter;
  4805. public:
  4806. IMPLEMENT_IINTERFACE_USING(CSimpleInterface);
  4807. CWorkUnitsPager(const char* _xPath, CQueryOrFilter* _orFilter, const char *_sortOrder, const char* _nameFilterLo, const char* _nameFilterHi, StringArray& _unknownAttributes)
  4808. : xPath(_xPath), orFilter(_orFilter), sortOrder(_sortOrder), nameFilterLo(_nameFilterLo), nameFilterHi(_nameFilterHi)
  4809. {
  4810. ForEachItemIn(x, _unknownAttributes)
  4811. unknownAttributes.append(_unknownAttributes.item(x));
  4812. }
  4813. virtual IRemoteConnection* getElements(IArrayOf<IPropertyTree> &elements)
  4814. {
  4815. Owned<IRemoteConnection> conn = querySDS().connect("WorkUnits", myProcessSession(), 0, SDS_LOCK_TIMEOUT);
  4816. if (!conn)
  4817. return NULL;
  4818. Owned<IPropertyTreeIterator> iter;
  4819. if (!orFilter)
  4820. {
  4821. iter.setown(conn->getElements(xPath.get()));
  4822. }
  4823. else
  4824. {
  4825. Owned <CMultiPTreeIterator> multi = new CMultiPTreeIterator;
  4826. bool added = false;
  4827. const char* fieldName = orFilter->queryName();
  4828. unsigned flags = orFilter->querySearchFlags();
  4829. const StringArray& values = orFilter->queryValues();
  4830. ForEachItemIn(i, values)
  4831. {
  4832. StringBuffer path = xPath.get();
  4833. const char* value = values.item(i);
  4834. if (!isEmptyString(value))
  4835. {
  4836. appendFilterToQueryString(path, flags, fieldName, value);
  4837. IPropertyTreeIterator *itr = conn->getElements(path.str());
  4838. if (itr)
  4839. {
  4840. multi->addSource(*itr);
  4841. added = true;
  4842. }
  4843. }
  4844. }
  4845. if (added)
  4846. iter.setown(multi.getClear());
  4847. }
  4848. if (!iter)
  4849. return NULL;
  4850. sortElements(iter, sortOrder.get(), nameFilterLo.get(), nameFilterHi.get(), unknownAttributes, elements);
  4851. return conn.getClear();
  4852. }
  4853. virtual bool allMatchingElementsReceived() { return true; }//For now, dali always returns all of matched WUs.
  4854. };
  4855. class CScopeChecker : public CSimpleInterface, implements ISortedElementsTreeFilter
  4856. {
  4857. UniqueScopes done;
  4858. ISecManager *secmgr;
  4859. ISecUser *secuser;
  4860. CriticalSection crit;
  4861. public:
  4862. IMPLEMENT_IINTERFACE_USING(CSimpleInterface);
  4863. CScopeChecker(ISecManager *_secmgr,ISecUser *_secuser)
  4864. {
  4865. secmgr = _secmgr;
  4866. secuser = _secuser;
  4867. }
  4868. bool isOK(IPropertyTree &tree)
  4869. {
  4870. const char *scopename = tree.queryProp("@scope");
  4871. if (!scopename||!*scopename)
  4872. return true;
  4873. {
  4874. CriticalBlock block(crit);
  4875. const bool *b = done.getValue(scopename);
  4876. if (b)
  4877. return *b;
  4878. }
  4879. bool ret = checkWuScopeSecAccess(scopename,secmgr,secuser,SecAccess_Read,"iterating",false,false);
  4880. {
  4881. // conceivably could have already been checked and added, but ok.
  4882. CriticalBlock block(crit);
  4883. done.setValue(scopename,ret);
  4884. }
  4885. return ret;
  4886. }
  4887. };
  4888. Owned<CQueryOrFilter> orFilter;
  4889. Owned<ISortedElementsTreeFilter> sc = new CScopeChecker(secmgr,secuser);
  4890. StringBuffer query;
  4891. StringBuffer so;
  4892. StringAttr namefilter("*");
  4893. StringAttr namefilterlo;
  4894. StringAttr namefilterhi;
  4895. StringArray unknownAttributes;
  4896. if (filters)
  4897. {
  4898. const char *fv = (const char *) filterbuf;
  4899. for (unsigned i=0;filters[i]!=WUSFterm;i++)
  4900. {
  4901. assertex(fv);
  4902. int fmt = filters[i];
  4903. int subfmt = (fmt&0xff);
  4904. if (subfmt==WUSFwuid)
  4905. namefilterlo.set(fv);
  4906. else if (subfmt==WUSFwuidhigh)
  4907. namefilterhi.set(fv);
  4908. else if (subfmt==WUSFwildwuid)
  4909. namefilter.set(fv);
  4910. else if (subfmt==WUSFappvalue)
  4911. {
  4912. const char *app = fv;
  4913. fv = fv + strlen(fv)+1;
  4914. query.append("[Application/").append(app);
  4915. if (*fv)
  4916. query.append("=?~\"").append(fv).append('\"');
  4917. query.append("]");
  4918. }
  4919. else if (!*fv)
  4920. {
  4921. unknownAttributes.append(getEnumText(subfmt,workunitSortFields));
  4922. if (subfmt==WUSFtotalthortime)
  4923. sortorder = (WUSortField) (sortorder & ~WUSFnumeric);
  4924. }
  4925. else
  4926. {
  4927. const char* fieldName = getEnumText(subfmt,workunitSortFields);
  4928. if (!strchr(fv, '|'))
  4929. appendFilterToQueryString(query, fmt, fieldName, fv);
  4930. else if (orFilter)
  4931. throw MakeStringException(WUERR_InvalidUserInput, "Multiple OR filters not allowed");
  4932. else
  4933. {
  4934. if (!strieq(fieldName, getEnumText(WUSFstate,workunitSortFields)) &&
  4935. !strieq(fieldName, getEnumText(WUSFuser,workunitSortFields)) &&
  4936. !strieq(fieldName, getEnumText(WUSFcluster,workunitSortFields)))
  4937. throw MakeStringException(WUERR_InvalidUserInput, "OR filters not allowed for %s", fieldName);
  4938. orFilter.setown(new CQueryOrFilter(fmt, fieldName, fv));
  4939. }
  4940. }
  4941. fv = fv + strlen(fv)+1;
  4942. }
  4943. }
  4944. if ((sortorder&0xff)==WUSFtotalthortime)
  4945. sortorder = (WUSortField) (sortorder & ~WUSFnumeric);
  4946. query.insert(0, namefilter.get());
  4947. if (sortorder)
  4948. {
  4949. if (so.length())
  4950. so.append(',');
  4951. if (sortorder & WUSFreverse)
  4952. so.append('-');
  4953. if (sortorder & WUSFnocase)
  4954. so.append('?');
  4955. if (sortorder & WUSFnumeric)
  4956. so.append('#');
  4957. so.append(getEnumText(sortorder&0xff,workunitSortFields));
  4958. }
  4959. IArrayOf<IPropertyTree> results;
  4960. Owned<IElementsPager> elementsPager = new CWorkUnitsPager(query.str(), orFilter.getClear(), so.length()?so.str():NULL, namefilterlo.get(), namefilterhi.get(), unknownAttributes);
  4961. Owned<IRemoteConnection> conn=getElementsPaged(elementsPager,startoffset,maxnum,secmgr?sc:NULL,"",cachehint,results,total,NULL);
  4962. return new CConstWUArrayIterator(results);
  4963. }
  4964. virtual WUState waitForWorkUnit(const char * wuid, unsigned timeout, bool compiled, bool returnOnWaitState)
  4965. {
  4966. WUState ret = WUStateUnknown;
  4967. StringBuffer wuRoot;
  4968. getXPath(wuRoot, wuid);
  4969. Owned<IRemoteConnection> conn = sdsManager->connect(wuRoot.str(), session, 0, SDS_LOCK_TIMEOUT);
  4970. if (timeout == 0) //no need to subscribe
  4971. {
  4972. ret = (WUState) getEnum(conn->queryRoot(), "@state", states);
  4973. switch (ret)
  4974. {
  4975. case WUStateCompiled:
  4976. case WUStateUploadingFiles:
  4977. if (!compiled)
  4978. break;
  4979. //fall through
  4980. case WUStateCompleted:
  4981. case WUStateFailed:
  4982. case WUStateAborted:
  4983. return ret;
  4984. case WUStateWait:
  4985. if(returnOnWaitState)
  4986. return ret;
  4987. default:
  4988. break;
  4989. }
  4990. return WUStateUnknown;
  4991. }
  4992. Owned<WorkUnitWaiter> waiter = new WorkUnitWaiter(wuid, SubscribeOptionState);
  4993. LocalIAbortHandler abortHandler(*waiter);
  4994. if (conn)
  4995. {
  4996. SessionId agent = -1;
  4997. bool agentSessionStopped = false;
  4998. unsigned start = msTick();
  4999. for (;;)
  5000. {
  5001. ret = (WUState) getEnum(conn->queryRoot(), "@state", states);
  5002. switch (ret)
  5003. {
  5004. case WUStateCompiled:
  5005. case WUStateUploadingFiles:
  5006. if (!compiled)
  5007. break;
  5008. // fall into
  5009. case WUStateCompleted:
  5010. case WUStateFailed:
  5011. case WUStateAborted:
  5012. return ret;
  5013. case WUStateWait:
  5014. if(returnOnWaitState)
  5015. {
  5016. return ret;
  5017. }
  5018. break;
  5019. case WUStateCompiling:
  5020. case WUStateRunning:
  5021. case WUStateDebugPaused:
  5022. case WUStateDebugRunning:
  5023. case WUStateBlocked:
  5024. case WUStateAborting:
  5025. if (agentSessionStopped)
  5026. {
  5027. reportAbnormalTermination(wuid, ret, agent);
  5028. return ret;
  5029. }
  5030. if (queryDaliServerVersion().compare("2.1")>=0)
  5031. {
  5032. agent = conn->queryRoot()->getPropInt64("@agentSession", -1);
  5033. if((agent>0) && querySessionManager().sessionStopped(agent, 0))
  5034. {
  5035. agentSessionStopped = true;
  5036. conn->reload();
  5037. continue;
  5038. }
  5039. }
  5040. break;
  5041. }
  5042. agentSessionStopped = false; // reset for state changes such as WUStateWait then WUStateRunning again
  5043. unsigned waited = msTick() - start;
  5044. if (timeout==-1 || waited + 20000 < timeout)
  5045. {
  5046. waiter->wait(20000); // recheck state every 20 seconds, in case eclagent has crashed.
  5047. if (waiter->aborted)
  5048. {
  5049. ret = WUStateUnknown; // MORE - throw an exception?
  5050. break;
  5051. }
  5052. }
  5053. else if (waited > timeout || !waiter->wait(timeout-waited))
  5054. {
  5055. ret = WUStateUnknown; // MORE - throw an exception?
  5056. break;
  5057. }
  5058. conn->reload();
  5059. }
  5060. }
  5061. return ret;
  5062. }
  5063. virtual WUAction waitForWorkUnitAction(const char * wuid, WUAction original)
  5064. {
  5065. Owned<WorkUnitWaiter> waiter = new WorkUnitWaiter(wuid, SubscribeOptionAction);
  5066. LocalIAbortHandler abortHandler(*waiter);
  5067. WUAction ret = WUActionUnknown;
  5068. StringBuffer wuRoot;
  5069. getXPath(wuRoot, wuid);
  5070. Owned<IRemoteConnection> conn = sdsManager->connect(wuRoot.str(), session, 0, SDS_LOCK_TIMEOUT);
  5071. if (conn)
  5072. {
  5073. unsigned start = msTick();
  5074. for (;;)
  5075. {
  5076. ret = (WUAction) getEnum(conn->queryRoot(), "Action", actions);
  5077. if (ret != original)
  5078. break;
  5079. unsigned waited = msTick() - start;
  5080. waiter->wait(20000); // recheck state every 20 seconds even if no timeout, in case eclagent has crashed.
  5081. if (waiter->aborted)
  5082. {
  5083. ret = WUActionUnknown; // MORE - throw an exception?
  5084. break;
  5085. }
  5086. conn->reload();
  5087. }
  5088. }
  5089. waiter->unsubscribe();
  5090. return ret;
  5091. }
  5092. protected:
  5093. IConstWorkUnitIterator * _getWorkUnitsByXPath(const char *xpath, ISecManager *secmgr, ISecUser *secuser)
  5094. {
  5095. Owned<IRemoteConnection> conn = sdsManager->connect("/WorkUnits", session, 0, SDS_LOCK_TIMEOUT);
  5096. if (conn)
  5097. {
  5098. CDaliVersion serverVersionNeeded("3.2");
  5099. Owned<IPropertyTreeIterator> iter(queryDaliServerVersion().compare(serverVersionNeeded) < 0 ?
  5100. conn->queryRoot()->getElements(xpath) :
  5101. conn->getElements(xpath));
  5102. return createSecureConstWUIterator(iter.getClear(), secmgr, secuser);
  5103. }
  5104. else
  5105. return NULL;
  5106. }
  5107. ISDSManager *sdsManager;
  5108. SessionId session;
  5109. };
  5110. extern WORKUNIT_API IConstWorkUnitIterator *createSecureConstWUIterator(IConstWorkUnitIterator *iter, ISecManager *secmgr, ISecUser *secuser)
  5111. {
  5112. if (secmgr)
  5113. return new CSecureConstWUIterator(iter, secmgr, secuser);
  5114. else
  5115. return iter;
  5116. }
  5117. extern WORKUNIT_API IConstWorkUnitIterator *createSecureConstWUIterator(IPropertyTreeIterator *iter, ISecManager *secmgr, ISecUser *secuser)
  5118. {
  5119. if (secmgr)
  5120. return new CSecureConstWUIterator(new CConstWUIterator(iter), secmgr, secuser);
  5121. else
  5122. return new CConstWUIterator(iter);
  5123. }
  5124. static CriticalSection factoryCrit;
  5125. static Owned<IWorkUnitFactory> factory;
  5126. void CDaliWorkUnitFactory::clientShutdown()
  5127. {
  5128. CriticalBlock b(factoryCrit);
  5129. factory.clear();
  5130. }
  5131. void clientShutdownWorkUnit()
  5132. {
  5133. CriticalBlock b(factoryCrit);
  5134. factory.clear();
  5135. }
  5136. extern WORKUNIT_API void setWorkUnitFactory(IWorkUnitFactory * _factory)
  5137. {
  5138. CriticalBlock b(factoryCrit);
  5139. factory.setown(_factory);
  5140. }
  5141. extern WORKUNIT_API IWorkUnitFactory * getWorkUnitFactory()
  5142. {
  5143. if (!factory)
  5144. {
  5145. CriticalBlock b(factoryCrit);
  5146. 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.
  5147. {
  5148. const char *forceEnv = getenv("FORCE_DALI_WORKUNITS");
  5149. bool forceDali = forceEnv && !strieq(forceEnv, "off") && !strieq(forceEnv, "0");
  5150. Owned<IRemoteConnection> env = querySDS().connect("/Environment", myProcessSession(), 0, SDS_LOCK_TIMEOUT);
  5151. IPropertyTree *pluginInfo = NULL;
  5152. if (env)
  5153. {
  5154. SocketEndpoint targetDali = queryCoven().queryGroup().queryNode(0).endpoint();
  5155. IPropertyTree *daliInfo = findDaliProcess(env->queryRoot(), targetDali);
  5156. if (daliInfo)
  5157. {
  5158. const char *daliName = daliInfo->queryProp("@name");
  5159. if (daliName)
  5160. {
  5161. VStringBuffer xpath("Software/DaliServerPlugin[@type='WorkunitServer'][@daliServers='%s']", daliName);
  5162. pluginInfo = env->queryRoot()->queryPropTree(xpath);
  5163. }
  5164. if (!pluginInfo)
  5165. pluginInfo = daliInfo->queryPropTree("Plugin[@type='WorkunitServer']"); // Compatibility with early betas of 6.0 ...
  5166. }
  5167. }
  5168. if (pluginInfo && !forceDali)
  5169. factory.setown( (IWorkUnitFactory *) loadPlugin(pluginInfo));
  5170. else
  5171. factory.setown(new CDaliWorkUnitFactory());
  5172. }
  5173. }
  5174. return factory.getLink();
  5175. }
  5176. extern WORKUNIT_API IWorkUnitFactory * getDaliWorkUnitFactory()
  5177. {
  5178. if (!factory)
  5179. {
  5180. CriticalBlock b(factoryCrit);
  5181. 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.
  5182. factory.setown(new CDaliWorkUnitFactory());
  5183. }
  5184. return factory.getLink();
  5185. }
  5186. // A SecureWorkUnitFactory allows the security params to be supplied once to the factory rather than being supplied to each call.
  5187. // They can still be supplied if you want...
  5188. class CSecureWorkUnitFactory : implements IWorkUnitFactory, public CInterface
  5189. {
  5190. public:
  5191. IMPLEMENT_IINTERFACE;
  5192. CSecureWorkUnitFactory(IWorkUnitFactory *_baseFactory, ISecManager *_secMgr, ISecUser *_secUser)
  5193. : baseFactory(_baseFactory), defaultSecMgr(_secMgr), defaultSecUser(_secUser)
  5194. {
  5195. }
  5196. virtual bool initializeStore()
  5197. {
  5198. throwUnexpected(); // Used when loading a plugin factory - not applicable here
  5199. }
  5200. virtual IWorkUnitWatcher *getWatcher(IWorkUnitSubscriber *subscriber, WUSubscribeOptions options, const char *wuid) const
  5201. {
  5202. return baseFactory->getWatcher(subscriber, options, wuid);
  5203. }
  5204. virtual unsigned validateRepository(bool fix)
  5205. {
  5206. return baseFactory->validateRepository(fix);
  5207. }
  5208. virtual void deleteRepository(bool recreate)
  5209. {
  5210. return baseFactory->deleteRepository(recreate);
  5211. }
  5212. virtual void createRepository()
  5213. {
  5214. return baseFactory->createRepository();
  5215. }
  5216. virtual const char *queryStoreType() const
  5217. {
  5218. return baseFactory->queryStoreType();
  5219. }
  5220. virtual StringArray &getUniqueValues(WUSortField field, const char *prefix, StringArray &result) const
  5221. {
  5222. return baseFactory->getUniqueValues(field, prefix, result);
  5223. }
  5224. virtual IWorkUnit* createNamedWorkUnit(const char *wuid, const char *app, const char *user, ISecManager *secMgr, ISecUser *secUser)
  5225. {
  5226. if (!secMgr) secMgr = defaultSecMgr.get();
  5227. if (!secUser) secUser = defaultSecUser.get();
  5228. return baseFactory->createNamedWorkUnit(wuid, app, user, secMgr, secUser);
  5229. }
  5230. virtual IWorkUnit* createWorkUnit(const char *app, const char *user, ISecManager *secMgr, ISecUser *secUser)
  5231. {
  5232. if (!secMgr) secMgr = defaultSecMgr.get();
  5233. if (!secUser) secUser = defaultSecUser.get();
  5234. return baseFactory->createWorkUnit(app, user, secMgr, secUser);
  5235. }
  5236. virtual bool deleteWorkUnit(const char * wuid, ISecManager *secMgr, ISecUser *secUser)
  5237. {
  5238. if (!secMgr) secMgr = defaultSecMgr.get();
  5239. if (!secUser) secUser = defaultSecUser.get();
  5240. return baseFactory->deleteWorkUnit(wuid, secMgr, secUser);
  5241. }
  5242. virtual IConstWorkUnit* openWorkUnit(const char *wuid, ISecManager *secMgr, ISecUser *secUser)
  5243. {
  5244. if (!secMgr) secMgr = defaultSecMgr.get();
  5245. if (!secUser) secUser = defaultSecUser.get();
  5246. return baseFactory->openWorkUnit(wuid, secMgr, secUser);
  5247. }
  5248. virtual IWorkUnit* updateWorkUnit(const char *wuid, ISecManager *secMgr, ISecUser *secUser)
  5249. {
  5250. if (!secMgr) secMgr = defaultSecMgr.get();
  5251. if (!secUser) secUser = defaultSecUser.get();
  5252. return baseFactory->updateWorkUnit(wuid, secMgr, secUser);
  5253. }
  5254. virtual bool restoreWorkUnit(const char *base, const char *wuid, bool restoreAssociated)
  5255. {
  5256. return baseFactory->restoreWorkUnit(base, wuid, restoreAssociated);
  5257. }
  5258. virtual IWorkUnit * getGlobalWorkUnit(ISecManager *secMgr, ISecUser *secUser)
  5259. {
  5260. if (!secMgr) secMgr = defaultSecMgr.get();
  5261. if (!secUser) secUser = defaultSecUser.get();
  5262. return baseFactory->getGlobalWorkUnit(secMgr, secUser);
  5263. }
  5264. virtual IConstWorkUnitIterator * getWorkUnitsByOwner(const char * owner, ISecManager *secMgr, ISecUser *secUser)
  5265. {
  5266. if (!secMgr) secMgr = defaultSecMgr.get();
  5267. if (!secUser) secUser = defaultSecUser.get();
  5268. return baseFactory->getWorkUnitsByOwner(owner, secMgr, secUser);
  5269. }
  5270. virtual IConstWorkUnitIterator * getScheduledWorkUnits(ISecManager *secMgr, ISecUser *secUser)
  5271. {
  5272. if (!secMgr) secMgr = defaultSecMgr.get();
  5273. if (!secUser) secUser = defaultSecUser.get();
  5274. return baseFactory->getScheduledWorkUnits(secMgr, secUser);
  5275. }
  5276. virtual void descheduleAllWorkUnits(ISecManager *secMgr, ISecUser *secUser)
  5277. {
  5278. if (!secMgr) secMgr = defaultSecMgr.get();
  5279. if (!secUser) secUser = defaultSecUser.get();
  5280. baseFactory->descheduleAllWorkUnits(secMgr, secUser);
  5281. }
  5282. virtual int setTracingLevel(int newLevel)
  5283. {
  5284. return baseFactory->setTracingLevel(newLevel);
  5285. }
  5286. virtual IConstWorkUnitIterator* getWorkUnitsSorted( WUSortField sortorder, // field to sort by
  5287. WUSortField *filters, // NULL or list of fields to filter on (terminated by WUSFterm)
  5288. const void *filterbuf, // (appended) string values for filters
  5289. unsigned startoffset,
  5290. unsigned maxnum,
  5291. __int64 *cachehint,
  5292. unsigned *total,
  5293. ISecManager *secMgr, ISecUser *secUser)
  5294. {
  5295. if (!secMgr) secMgr = defaultSecMgr.get();
  5296. if (!secUser) secUser = defaultSecUser.get();
  5297. return baseFactory->getWorkUnitsSorted(sortorder,filters,filterbuf,startoffset,maxnum,cachehint, total, secMgr, secUser);
  5298. }
  5299. virtual IConstQuerySetQueryIterator* getQuerySetQueriesSorted( WUQuerySortField *sortorder,
  5300. WUQuerySortField *filters,
  5301. const void *filterbuf,
  5302. unsigned startoffset,
  5303. unsigned maxnum,
  5304. __int64 *cachehint,
  5305. unsigned *total,
  5306. const MapStringTo<bool> *subset)
  5307. {
  5308. // MORE - why no security?
  5309. return baseFactory->getQuerySetQueriesSorted(sortorder,filters,filterbuf,startoffset,maxnum,cachehint,total,subset);
  5310. }
  5311. virtual unsigned numWorkUnits()
  5312. {
  5313. return baseFactory->numWorkUnits();
  5314. }
  5315. virtual bool isAborting(const char *wuid) const
  5316. {
  5317. return baseFactory->isAborting(wuid);
  5318. }
  5319. virtual void clearAborting(const char *wuid)
  5320. {
  5321. baseFactory->clearAborting(wuid);
  5322. }
  5323. virtual WUState waitForWorkUnit(const char * wuid, unsigned timeout, bool compiled, bool returnOnWaitState)
  5324. {
  5325. return baseFactory->waitForWorkUnit(wuid, timeout, compiled, returnOnWaitState);
  5326. }
  5327. virtual WUAction waitForWorkUnitAction(const char * wuid, WUAction original)
  5328. {
  5329. return baseFactory->waitForWorkUnitAction(wuid, original);
  5330. }
  5331. private:
  5332. Owned<IWorkUnitFactory> baseFactory;
  5333. Linked<ISecManager> defaultSecMgr;
  5334. Linked<ISecUser> defaultSecUser;
  5335. };
  5336. extern WORKUNIT_API IWorkUnitFactory * getWorkUnitFactory(ISecManager *secmgr, ISecUser *secuser)
  5337. {
  5338. if (secmgr && secuser)
  5339. return new CSecureWorkUnitFactory(getWorkUnitFactory(), secmgr, secuser);
  5340. else
  5341. return getWorkUnitFactory();
  5342. }
  5343. //==========================================================================================
  5344. class CStringPTreeIterator : implements IStringIterator, public CInterface
  5345. {
  5346. Owned<IPropertyTreeIterator> it;
  5347. public:
  5348. IMPLEMENT_IINTERFACE;
  5349. CStringPTreeIterator(IPropertyTreeIterator *p) : it(p) {};
  5350. virtual bool first() { return it->first(); }
  5351. virtual bool next() { return it->next(); }
  5352. virtual bool isValid() { return it->isValid(); }
  5353. virtual IStringVal & str(IStringVal &s) { s.set(it->query().queryProp(NULL)); return s; }
  5354. };
  5355. class CStringPTreeTagIterator : implements IStringIterator, public CInterface
  5356. {
  5357. Owned<IPropertyTreeIterator> it;
  5358. public:
  5359. IMPLEMENT_IINTERFACE;
  5360. CStringPTreeTagIterator(IPropertyTreeIterator *p) : it(p) {};
  5361. virtual bool first() { return it->first(); }
  5362. virtual bool next() { return it->next(); }
  5363. virtual bool isValid() { return it->isValid(); }
  5364. virtual IStringVal & str(IStringVal &s) { s.set(it->query().queryName()); return s; }
  5365. };
  5366. class CStringPTreeAttrIterator : implements IStringIterator, public CInterface
  5367. {
  5368. Owned<IPropertyTreeIterator> it;
  5369. StringAttr name;
  5370. public:
  5371. IMPLEMENT_IINTERFACE;
  5372. CStringPTreeAttrIterator(IPropertyTreeIterator *p, const char *_name) : it(p), name(_name) {};
  5373. virtual bool first() { return it->first(); }
  5374. virtual bool next() { return it->next(); }
  5375. virtual bool isValid() { return it->isValid(); }
  5376. virtual IStringVal & str(IStringVal &s) { s.set(it->query().queryProp(name)); return s; }
  5377. };
  5378. //==========================================================================================
  5379. CLocalWorkUnit::CLocalWorkUnit(ISecManager *secmgr, ISecUser *secuser)
  5380. {
  5381. clearCached(false);
  5382. secMgr.set(secmgr);
  5383. secUser.set(secuser);
  5384. workflowIteratorCached = false;
  5385. resultsCached = false;
  5386. graphsCached = false;
  5387. temporariesCached = false;
  5388. variablesCached = false;
  5389. exceptionsCached = false;
  5390. pluginsCached = false;
  5391. librariesCached = false;
  5392. activitiesCached = false;
  5393. webServicesInfoCached = false;
  5394. roxieQueryInfoCached = false;
  5395. }
  5396. void CLocalWorkUnit::clearCached(bool clearTree)
  5397. {
  5398. query.clear();
  5399. webServicesInfo.clear();
  5400. workflowIterator.clear();
  5401. graphs.kill();
  5402. results.kill();
  5403. variables.kill();
  5404. plugins.kill();
  5405. libraries.kill();
  5406. exceptions.kill();
  5407. temporaries.kill();
  5408. statistics.kill();
  5409. appvalues.kill();
  5410. if (clearTree)
  5411. p.clear();
  5412. workflowIteratorCached = false;
  5413. resultsCached = false;
  5414. graphsCached = false;
  5415. temporariesCached = false;
  5416. variablesCached = false;
  5417. exceptionsCached = false;
  5418. pluginsCached = false;
  5419. librariesCached = false;
  5420. activitiesCached = false;
  5421. webServicesInfoCached = false;
  5422. roxieQueryInfoCached = false;
  5423. }
  5424. void CLocalWorkUnit::loadPTree(IPropertyTree *ptree)
  5425. {
  5426. clearCached(false);
  5427. p.setown(ptree);
  5428. }
  5429. void CLocalWorkUnit::beforeDispose()
  5430. {
  5431. try
  5432. {
  5433. unsubscribe();
  5434. clearCached(true);
  5435. userDesc.clear();
  5436. secMgr.clear();
  5437. secUser.clear();
  5438. }
  5439. catch (IException *E) { LOG(MCexception(E, MSGCLS_warning), E, "Exception during ~CLocalWorkUnit"); E->Release(); }
  5440. }
  5441. void CLocalWorkUnit::cleanupAndDelete(bool deldll, bool deleteOwned, const StringArray *deleteExclusions)
  5442. {
  5443. MTIME_SECTION(queryActiveTimer(), "WUDELETE cleanupAndDelete total");
  5444. // Delete any related things in SDS etc that might otherwise be forgotten
  5445. if (p->getPropBool("@protected", false))
  5446. throw MakeStringException(WUERR_WorkunitProtected, "%s: Workunit is protected",p->queryName());
  5447. switch (getState())
  5448. {
  5449. case WUStateAborted:
  5450. case WUStateCompleted:
  5451. case WUStateFailed:
  5452. case WUStateArchived:
  5453. break;
  5454. case WUStateCompiled:
  5455. if (getAction()==WUActionRun || getAction()==WUActionUnknown)
  5456. throw MakeStringException(WUERR_WorkunitActive, "%s: Workunit is active. Please abort before deleting this workunit.",p->queryName());
  5457. break;
  5458. case WUStateWait:
  5459. throw MakeStringException(WUERR_WorkunitScheduled, "%s: Workunit is scheduled",p->queryName());
  5460. default:
  5461. throw MakeStringException(WUERR_WorkunitActive, "%s: Workunit is active. Please abort before deleting this workunit.",p->queryName());
  5462. break;
  5463. }
  5464. if (getIsQueryService())
  5465. {
  5466. Owned<IPropertyTree> registry = getQueryRegistryRoot();
  5467. if (registry)
  5468. {
  5469. VStringBuffer xpath("QuerySet/Query[@wuid='%s']", p->queryName());
  5470. if (registry->hasProp(xpath.str()))
  5471. throw MakeStringException(WUERR_WorkunitPublished, "%s: Workunit is published",p->queryName());
  5472. }
  5473. }
  5474. try
  5475. {
  5476. if (deldll && !p->getPropBool("@isClone", false))
  5477. {
  5478. Owned<IConstWUQuery> q = getQuery();
  5479. if (q)
  5480. {
  5481. Owned<IConstWUAssociatedFileIterator> iter = &q->getAssociatedFiles();
  5482. SCMStringBuffer name;
  5483. ForEach(*iter)
  5484. {
  5485. IConstWUAssociatedFile & cur = iter->query();
  5486. cur.getNameTail(name);
  5487. if (!deleteExclusions || (NotFound == deleteExclusions->find(name.str())))
  5488. {
  5489. Owned<IDllEntry> entry = queryDllServer().getEntry(name.str());
  5490. if (entry.get())
  5491. asyncRemoveDll(name.str());
  5492. else
  5493. {
  5494. SCMStringBuffer ip, localPath;
  5495. cur.getName(localPath);
  5496. cur.getIp(ip);
  5497. asyncRemoveFile(ip.str(), localPath.str());
  5498. }
  5499. }
  5500. }
  5501. }
  5502. }
  5503. factory->clearAborting(queryWuid());
  5504. deleteTempFiles(NULL, deleteOwned, true); // all, any remaining.
  5505. }
  5506. catch(IException *E)
  5507. {
  5508. StringBuffer s;
  5509. LOG(MCexception(E, MSGCLS_warning), E, s.append("Exception during cleanupAndDelete: ").append(p->queryName()).str());
  5510. E->Release();
  5511. }
  5512. catch (...)
  5513. {
  5514. WARNLOG("Unknown exception during cleanupAndDelete: %s", p->queryName());
  5515. }
  5516. }
  5517. void CLocalWorkUnit::setTimeScheduled(const IJlibDateTime &val)
  5518. {
  5519. SCMStringBuffer strval;
  5520. val.getGmtString(strval);
  5521. p->setProp("@timescheduled",strval.str());
  5522. }
  5523. IJlibDateTime & CLocalWorkUnit::getTimeScheduled(IJlibDateTime &val) const
  5524. {
  5525. StringBuffer str;
  5526. p->getProp("@timescheduled",str);
  5527. if(str.length())
  5528. val.setGmtString(str.str());
  5529. return val;
  5530. }
  5531. bool modifyAndWriteWorkUnitXML(char const * wuid, StringBuffer & buf, StringBuffer & extra, IFileIO * fileio)
  5532. {
  5533. // kludge in extra chunks of XML such as GraphProgress and GeneratedDlls
  5534. if (extra.length())
  5535. {
  5536. const char *bufStart = buf.str();
  5537. const char *bufPtr = bufStart+buf.length();
  5538. while (bufStart != bufPtr)
  5539. {
  5540. --bufPtr;
  5541. if (!isspace(*bufPtr))
  5542. break;
  5543. }
  5544. assertex('>' == *bufPtr);
  5545. size_t l = strlen(wuid);
  5546. assertex((size_t)(bufPtr-bufStart) > l+2); // e.g. at least </W20171111-111111>
  5547. bufPtr -= l+2; // skip back over </wuid
  5548. assertex(0 == memcmp(bufPtr, "</", 2) );
  5549. assertex(0 == memcmp(bufPtr+2, wuid, l));
  5550. buf.insert(bufPtr-bufStart, extra);
  5551. }
  5552. return (fileio->write(0,buf.length(),buf.str()) == buf.length());
  5553. }
  5554. bool CLocalWorkUnit::archiveWorkUnit(const char *base, bool del, bool ignoredllerrors, bool deleteOwned, bool exportAssociatedFiles)
  5555. {
  5556. CriticalBlock block(crit);
  5557. StringBuffer path(base);
  5558. if (!p)
  5559. return false;
  5560. const char *wuid = p->queryName();
  5561. if (!wuid||!*wuid)
  5562. return false;
  5563. addPathSepChar(path).append(wuid).append(".xml");
  5564. Owned<IFile> file = createIFile(path.str());
  5565. if (!file)
  5566. return false;
  5567. Owned<IFileIO> fileio = file->open(IFOcreate);
  5568. if (!fileio)
  5569. return false;
  5570. StringBuffer buf;
  5571. exportWorkUnitToXML(this, buf, false, false, true);
  5572. StringBuffer extraWorkUnitXML;
  5573. Owned<IPTree> graphProgress = getGraphProgressTree();
  5574. if (graphProgress)
  5575. {
  5576. toXML(graphProgress,extraWorkUnitXML,1,XML_Format);
  5577. graphProgress.clear();
  5578. }
  5579. Owned<IConstWUQuery> q = getQuery();
  5580. if (!q)
  5581. {
  5582. if (!modifyAndWriteWorkUnitXML(wuid, buf, extraWorkUnitXML, fileio))
  5583. return false;
  5584. if (del)
  5585. {
  5586. if (getState()==WUStateUnknown)
  5587. setState(WUStateArchived); // to allow delete
  5588. cleanupAndDelete(false,deleteOwned); // no query, may as well delete
  5589. }
  5590. return false;
  5591. }
  5592. StringArray deleteExclusions; // associated files not to delete, added if failure to copy
  5593. Owned<IConstWUAssociatedFileIterator> iter = &q->getAssociatedFiles();
  5594. Owned<IPropertyTree> generatedDlls = createPTree("GeneratedDlls");
  5595. ForEach(*iter)
  5596. {
  5597. IConstWUAssociatedFile & cur = iter->query();
  5598. SCMStringBuffer name;
  5599. cur.getNameTail(name);
  5600. if (name.length())
  5601. {
  5602. Owned<IDllEntry> entry = queryDllServer().getEntry(name.str());
  5603. SCMStringBuffer curPath, curIp;
  5604. cur.getName(curPath);
  5605. cur.getIp(curIp);
  5606. SocketEndpoint curEp(curIp.str());
  5607. RemoteFilename curRfn;
  5608. curRfn.setPath(curEp, curPath.str());
  5609. StringBuffer dst(base);
  5610. addPathSepChar(dst);
  5611. curRfn.getTail(dst);
  5612. Owned<IFile> dstFile = createIFile(dst.str());
  5613. if (entry.get())
  5614. {
  5615. Owned<IException> exception;
  5616. Owned<IDllLocation> loc;
  5617. Owned<IPropertyTree> generatedDllBranch = createPTree();
  5618. generatedDllBranch->setProp("@name", entry->queryName());
  5619. generatedDllBranch->setProp("@kind", entry->queryKind());
  5620. if (exportAssociatedFiles)
  5621. {
  5622. try
  5623. {
  5624. loc.setown(entry->getBestLocation()); //throws exception if no readable locations
  5625. }
  5626. catch(IException * e)
  5627. {
  5628. exception.setown(e);
  5629. loc.setown(entry->getBestLocationCandidate()); //this will be closest of the unreadable locations
  5630. }
  5631. RemoteFilename filename;
  5632. loc->getDllFilename(filename);
  5633. if (!exception)
  5634. {
  5635. Owned<IFile> srcfile = createIFile(filename);
  5636. try
  5637. {
  5638. if (dstFile->exists())
  5639. {
  5640. if (streq(srcfile->queryFilename(), dstFile->queryFilename()))
  5641. deleteExclusions.append(name.str()); // restored workunit, referencing archive location for query dll (no longer true post HPCC-11191 fix)
  5642. // still want to delete if already archived but there are source file copies
  5643. }
  5644. else
  5645. copyFile(dstFile, srcfile);
  5646. }
  5647. catch(IException * e)
  5648. {
  5649. exception.setown(e);
  5650. }
  5651. }
  5652. if (exception)
  5653. {
  5654. if (ignoredllerrors)
  5655. {
  5656. EXCLOG(exception.get(), "archiveWorkUnit (copying associated file)");
  5657. //copy failed, so don't delete the registered dll files
  5658. deleteExclusions.append(name.str());
  5659. }
  5660. else
  5661. throw exception.getClear();
  5662. }
  5663. }
  5664. // Record Associated path to restore back to
  5665. StringBuffer restorePath;
  5666. curRfn.getRemotePath(restorePath);
  5667. generatedDllBranch->setProp("@location", restorePath.str());
  5668. generatedDlls->addPropTree("GeneratedDll", generatedDllBranch.getClear());
  5669. }
  5670. else if (exportAssociatedFiles) // no generated dll entry
  5671. {
  5672. Owned<IFile> srcFile = createIFile(curRfn);
  5673. try
  5674. {
  5675. copyFile(dstFile, srcFile);
  5676. }
  5677. catch (IException *e)
  5678. {
  5679. VStringBuffer msg("Failed to archive associated file '%s' to destination '%s'", srcFile->queryFilename(), dstFile->queryFilename());
  5680. EXCLOG(e, msg.str());
  5681. e->Release();
  5682. deleteExclusions.append(name.str());
  5683. }
  5684. }
  5685. }
  5686. }
  5687. iter.clear();
  5688. if (generatedDlls->numChildren())
  5689. toXML(generatedDlls, extraWorkUnitXML, 1, XML_Format);
  5690. if (!modifyAndWriteWorkUnitXML(wuid, buf, extraWorkUnitXML, fileio))
  5691. return false;
  5692. if (del)
  5693. {
  5694. //setState(WUStateArchived); // this isn't useful as about to delete it!
  5695. q.clear();
  5696. cleanupAndDelete(true, deleteOwned, &deleteExclusions);
  5697. }
  5698. return true;
  5699. }
  5700. void CLocalWorkUnit::loadXML(const char *xml)
  5701. {
  5702. CriticalBlock block(crit);
  5703. clearCached(true);
  5704. assertex(xml);
  5705. p.setown(createPTreeFromXMLString(xml,ipt_lowmem));
  5706. }
  5707. void CLocalWorkUnit::serialize(MemoryBuffer &tgt)
  5708. {
  5709. CriticalBlock block(crit);
  5710. StringBuffer x;
  5711. tgt.append(exportWorkUnitToXML(this, x, false, false, false).str());
  5712. }
  5713. void CLocalWorkUnit::deserialize(MemoryBuffer &src)
  5714. {
  5715. CriticalBlock block(crit);
  5716. StringAttr value;
  5717. src.read(value);
  5718. loadXML(value);
  5719. }
  5720. void CLocalWorkUnit::requestAbort()
  5721. {
  5722. CriticalBlock block(crit);
  5723. abortWorkUnit(p->queryName());
  5724. }
  5725. void CLocalWorkUnit::unlockRemote()
  5726. {
  5727. CriticalBlock block(crit);
  5728. locked.unlock();
  5729. _unlockRemote();
  5730. }
  5731. IWorkUnit &CLocalWorkUnit::lockRemote(bool commit)
  5732. {
  5733. if (secMgr)
  5734. checkWuSecAccess(*this, secMgr.get(), secUser.get(), SecAccess_Write, "write lock", true, true);
  5735. locked.lock();
  5736. CriticalBlock block(crit);
  5737. if (commit)
  5738. {
  5739. try
  5740. {
  5741. _lockRemote();
  5742. }
  5743. catch (IException *E)
  5744. {
  5745. StringBuffer s;
  5746. PrintLog("Failed to get write lock on workunit: %s", E->errorMessage(s).str());
  5747. locked.unlock();
  5748. throw;
  5749. }
  5750. }
  5751. return *new CLockedWorkUnit(LINK(this));
  5752. }
  5753. void CLocalWorkUnit::commit()
  5754. {
  5755. // Nothing to do if not backed by a persistent store
  5756. }
  5757. IWorkUnit& CLocalWorkUnit::lock()
  5758. {
  5759. return lockRemote(true);
  5760. }
  5761. const char *CLocalWorkUnit::queryWuid() const
  5762. {
  5763. CriticalBlock block(crit);
  5764. return p->queryName();
  5765. }
  5766. unsigned CLocalWorkUnit::getDebugAgentListenerPort() const
  5767. {
  5768. CriticalBlock block(crit);
  5769. return p->getPropInt("@DebugListenerPort", 0);
  5770. }
  5771. unsigned CLocalWorkUnit::getTotalThorTime() const
  5772. {
  5773. CriticalBlock block(crit);
  5774. return (unsigned)nanoToMilli(extractTimeCollatable(p->queryProp("@totalThorTime"), false));
  5775. }
  5776. void CLocalWorkUnit::setDebugAgentListenerPort(unsigned port)
  5777. {
  5778. CriticalBlock block(crit);
  5779. p->setPropInt("@DebugListenerPort", port);
  5780. }
  5781. IStringVal& CLocalWorkUnit::getDebugAgentListenerIP(IStringVal &ip) const
  5782. {
  5783. CriticalBlock block(crit);
  5784. ip.set(p->queryProp("@DebugListenerIP"));
  5785. return ip;
  5786. }
  5787. void CLocalWorkUnit::setDebugAgentListenerIP(const char * ip)
  5788. {
  5789. CriticalBlock block(crit);
  5790. p->setProp("@DebugListenerIP", ip);
  5791. }
  5792. IStringVal& CLocalWorkUnit::getSecurityToken(IStringVal &str) const
  5793. {
  5794. CriticalBlock block(crit);
  5795. str.set(p->queryProp("@token"));
  5796. return str;
  5797. }
  5798. void CLocalWorkUnit::setSecurityToken(const char *value)
  5799. {
  5800. CriticalBlock block(crit);
  5801. p->setProp("@token", value);
  5802. }
  5803. bool CLocalWorkUnit::getRunningGraph(IStringVal &graphName, WUGraphIDType &subId) const
  5804. {
  5805. // Only implemented in derived classes
  5806. return false;
  5807. }
  5808. void CLocalWorkUnit::setJobName(const char *value)
  5809. {
  5810. CriticalBlock block(crit);
  5811. p->setProp("@jobName", value);
  5812. }
  5813. const char *CLocalWorkUnit::queryJobName() const
  5814. {
  5815. CriticalBlock block(crit);
  5816. const char *ret = p->queryProp("@jobName");
  5817. if (!ret)
  5818. ret = "";
  5819. return ret;
  5820. }
  5821. void CLocalWorkUnit::setClusterName(const char *value)
  5822. {
  5823. CriticalBlock block(crit);
  5824. p->setProp("@clusterName", value);
  5825. }
  5826. const char *CLocalWorkUnit::queryClusterName() const
  5827. {
  5828. CriticalBlock block(crit);
  5829. const char *ret = p->queryProp("@clusterName");
  5830. if (!ret)
  5831. ret = "";
  5832. return ret;
  5833. }
  5834. void CLocalWorkUnit::setAllowedClusters(const char *value)
  5835. {
  5836. setDebugValue("allowedclusters",value, true);
  5837. }
  5838. IStringVal& CLocalWorkUnit::getAllowedClusters(IStringVal &str) const
  5839. {
  5840. CriticalBlock block(crit);
  5841. getDebugValue("allowedclusters",str);
  5842. if (str.length()!=0)
  5843. return str;
  5844. str.set(p->queryProp("@clusterName"));
  5845. return str;
  5846. }
  5847. void CLocalWorkUnit::setAllowAutoQueueSwitch(bool val)
  5848. {
  5849. setDebugValueInt("allowautoqueueswitch",val?1:0,true);
  5850. }
  5851. bool CLocalWorkUnit::getAllowAutoQueueSwitch() const
  5852. {
  5853. CriticalBlock block(crit);
  5854. return getDebugValueBool("allowautoqueueswitch",false);
  5855. }
  5856. void CLocalWorkUnit::setLibraryInformation(const char * name, unsigned interfaceHash, unsigned definitionHash)
  5857. {
  5858. StringBuffer suffix;
  5859. if (name && *name)
  5860. setApplicationValue("LibraryModule", "name", name, true);
  5861. setApplicationValueInt("LibraryModule", "interfaceHash", interfaceHash, true);
  5862. setApplicationValueInt("LibraryModule", "definitionHash", definitionHash, true);
  5863. setApplicationValue("LibraryModule", "platform", appendLibrarySuffix(suffix).str(), true);
  5864. }
  5865. void CLocalWorkUnit::remoteCheckAccess(IUserDescriptor *user, bool writeaccess) const
  5866. {
  5867. unsigned auditflags = DALI_LDAP_AUDIT_REPORT|DALI_LDAP_READ_WANTED;
  5868. if (writeaccess)
  5869. auditflags |= DALI_LDAP_WRITE_WANTED;
  5870. SecAccessFlags perm = SecAccess_Full;
  5871. const char *scopename = p->queryProp("@scope");
  5872. if (scopename&&*scopename) {
  5873. if (!user)
  5874. user = queryUserDescriptor();
  5875. perm = querySessionManager().getPermissionsLDAP("workunit",scopename,user,auditflags);
  5876. if (perm<0) {
  5877. if (perm == SecAccess_Unavailable)
  5878. perm = SecAccess_Full;
  5879. else
  5880. perm = SecAccess_None;
  5881. }
  5882. }
  5883. if (!HASREADPERMISSION(perm))
  5884. throw MakeStringException(WUERR_WorkunitAccessDenied, "Read access denied for workunit %s", queryWuid());
  5885. if (writeaccess && !HASWRITEPERMISSION(perm))
  5886. throw MakeStringException(WUERR_WorkunitAccessDenied, "Write access denied for workunit %s", queryWuid());
  5887. }
  5888. void CLocalWorkUnit::setUser(const char * value)
  5889. {
  5890. CriticalBlock block(crit);
  5891. p->setProp("@submitID", value);
  5892. }
  5893. const char *CLocalWorkUnit::queryUser() const
  5894. {
  5895. CriticalBlock block(crit);
  5896. const char *ret = p->queryProp("@submitID");
  5897. if (!ret)
  5898. ret = "";
  5899. return ret;
  5900. }
  5901. void CLocalWorkUnit::setWuScope(const char * value)
  5902. {
  5903. if (value && *value)
  5904. {
  5905. if (checkWuScopeSecAccess(value, secMgr.get(), secUser.get(), SecAccess_Write, "Change Scope", true, true))
  5906. {
  5907. CriticalBlock block(crit);
  5908. p->setProp("@scope", value);
  5909. }
  5910. }
  5911. }
  5912. const char *CLocalWorkUnit::queryWuScope() const
  5913. {
  5914. CriticalBlock block(crit);
  5915. const char *ret = p->queryProp("@scope");
  5916. if (!ret)
  5917. ret = "";
  5918. return ret;
  5919. }
  5920. void CLocalWorkUnit::setPriority(WUPriorityClass cls)
  5921. {
  5922. CriticalBlock block(crit);
  5923. setEnum(p, "@priorityClass", cls, priorityClasses);
  5924. }
  5925. WUPriorityClass CLocalWorkUnit::getPriority() const
  5926. {
  5927. CriticalBlock block(crit);
  5928. return (WUPriorityClass) getEnum(p, "@priorityClass", priorityClasses);
  5929. }
  5930. const char *CLocalWorkUnit::queryPriorityDesc() const
  5931. {
  5932. return getEnumText(getPriority(), priorityClasses);
  5933. }
  5934. void CLocalWorkUnit::setState(WUState value)
  5935. {
  5936. if (value==WUStateAborted || value==WUStatePaused || value==WUStateCompleted || value==WUStateFailed || value==WUStateSubmitted || value==WUStateWait)
  5937. {
  5938. if (factory)
  5939. factory->clearAborting(queryWuid());
  5940. }
  5941. CriticalBlock block(crit);
  5942. setEnum(p, "@state", value, states); // For historical reasons, we use state to store the state
  5943. setEnum(p, "State", value, states); // But we can only subscribe to elements, not attributes
  5944. if (getDebugValueBool("monitorWorkunit", false))
  5945. {
  5946. switch(value)
  5947. {
  5948. case WUStateAborted:
  5949. FLLOG(MCoperatorWarning, "Workunit %s aborted", p->queryName());
  5950. break;
  5951. case WUStateCompleted:
  5952. FLLOG(MCoperatorProgress, "Workunit %s completed", p->queryName());
  5953. break;
  5954. case WUStateFailed:
  5955. FLLOG(MCoperatorProgress, "Workunit %s failed", p->queryName());
  5956. break;
  5957. }
  5958. }
  5959. p->removeProp("@stateEx");
  5960. }
  5961. void CLocalWorkUnit::setStateEx(const char * text)
  5962. {
  5963. CriticalBlock block(crit);
  5964. p->setProp("@stateEx", text);
  5965. }
  5966. void CLocalWorkUnit::setAgentSession(__int64 sessionId)
  5967. {
  5968. CriticalBlock block(crit);
  5969. p->setPropInt64("@agentSession", sessionId);
  5970. }
  5971. bool CLocalWorkUnit::getIsQueryService() const
  5972. {
  5973. CriticalBlock block(crit);
  5974. return p->getPropBool("@isQueryService", false);
  5975. }
  5976. void CLocalWorkUnit::setIsQueryService(bool value)
  5977. {
  5978. CriticalBlock block(crit);
  5979. p->setPropBool("@isQueryService", value);
  5980. }
  5981. void CLocalWorkUnit::checkAgentRunning(WUState & state)
  5982. {
  5983. if (queryDaliServerVersion().compare("2.1")<0)
  5984. return;
  5985. switch(state)
  5986. {
  5987. case WUStateRunning:
  5988. case WUStateDebugPaused:
  5989. case WUStateDebugRunning:
  5990. case WUStateBlocked:
  5991. case WUStateAborting:
  5992. case WUStateCompiling:
  5993. case WUStatePaused:
  5994. {
  5995. SessionId agent = getAgentSession();
  5996. if((agent>0) && querySessionManager().sessionStopped(agent, 0))
  5997. {
  5998. forceReload();
  5999. state = (WUState) getEnum(p, "@state", states);
  6000. bool isecl=state==WUStateCompiling;
  6001. if (aborting())
  6002. state = WUStateAborted;
  6003. else if (state==WUStateRunning || state==WUStatePaused || state==WUStateDebugPaused || state==WUStateDebugRunning || state==WUStateBlocked || state==WUStateCompiling)
  6004. state = WUStateFailed;
  6005. else
  6006. return;
  6007. WARNLOG("checkAgentRunning terminated: %" I64F "d state = %d",(__int64)agent,(int)state);
  6008. Owned<IWorkUnit> w = &lock();
  6009. w->setState(state);
  6010. Owned<IWUException> e = w->createException();
  6011. WUAction action = w->getAction();
  6012. switch (action)
  6013. {
  6014. case WUActionPause:
  6015. case WUActionPauseNow:
  6016. case WUActionResume:
  6017. w->setAction(WUActionUnknown);
  6018. }
  6019. if(isecl)
  6020. {
  6021. e->setExceptionCode(1001);
  6022. e->setExceptionMessage("EclServer terminated unexpectedly");
  6023. }
  6024. else
  6025. {
  6026. e->setExceptionCode(1000);
  6027. e->setExceptionMessage("Workunit terminated unexpectedly");
  6028. }
  6029. }
  6030. }
  6031. }
  6032. }
  6033. WUState CLocalWorkUnit::getState() const
  6034. {
  6035. CriticalBlock block(crit);
  6036. WUState state = (WUState) getEnum(p, "@state", states);
  6037. switch (state)
  6038. {
  6039. case WUStateRunning:
  6040. case WUStateDebugPaused:
  6041. case WUStateDebugRunning:
  6042. case WUStateBlocked:
  6043. case WUStateCompiling:
  6044. if (aborting())
  6045. state = WUStateAborting;
  6046. break;
  6047. case WUStateSubmitted:
  6048. if (aborting())
  6049. state = WUStateAborted;
  6050. break;
  6051. }
  6052. const_cast<CLocalWorkUnit *>(this)->checkAgentRunning(state); //need const_cast as will change state if agent has died
  6053. return state;
  6054. }
  6055. IStringVal& CLocalWorkUnit::getStateEx(IStringVal & str) const
  6056. {
  6057. CriticalBlock block(crit);
  6058. str.set(p->queryProp("@stateEx"));
  6059. return str;
  6060. }
  6061. __int64 CLocalWorkUnit::getAgentSession() const
  6062. {
  6063. CriticalBlock block(crit);
  6064. return p->getPropInt64("@agentSession", -1);
  6065. }
  6066. unsigned CLocalWorkUnit::getAgentPID() const
  6067. {
  6068. CriticalBlock block(crit);
  6069. return p->getPropInt("@agentPID", -1);
  6070. }
  6071. const char * CLocalWorkUnit::queryStateDesc() const
  6072. {
  6073. // MORE - not sure about this - may prefer a separate interface
  6074. CriticalBlock block(crit);
  6075. try
  6076. {
  6077. return getEnumText(getState(), states);
  6078. }
  6079. catch (...)
  6080. {
  6081. return "???";
  6082. }
  6083. }
  6084. void CLocalWorkUnit::setAction(WUAction value)
  6085. {
  6086. CriticalBlock block(crit);
  6087. setEnum(p, "Action", value, actions);
  6088. }
  6089. WUAction CLocalWorkUnit::getAction() const
  6090. {
  6091. CriticalBlock block(crit);
  6092. return (WUAction) getEnum(p, "Action", actions);
  6093. }
  6094. const char *CLocalWorkUnit::queryActionDesc() const
  6095. {
  6096. CriticalBlock block(crit);
  6097. return p->queryProp("Action");
  6098. }
  6099. IStringVal& CLocalWorkUnit::getApplicationValue(const char *app, const char *propname, IStringVal &str) const
  6100. {
  6101. CriticalBlock block(crit);
  6102. StringBuffer prop("Application/");
  6103. prop.append(app).append('/').append(propname);
  6104. str.set(p->queryProp(prop.str()));
  6105. return str;
  6106. }
  6107. int CLocalWorkUnit::getApplicationValueInt(const char *app, const char *propname, int defVal) const
  6108. {
  6109. CriticalBlock block(crit);
  6110. StringBuffer prop("Application/");
  6111. prop.append(app).append('/').append(propname);
  6112. return p->getPropInt(prop.str(), defVal);
  6113. }
  6114. IConstWUAppValueIterator& CLocalWorkUnit::getApplicationValues() const
  6115. {
  6116. CriticalBlock block(crit);
  6117. appvalues.load(p,"Application/*");
  6118. return *new CArrayIteratorOf<IConstWUAppValue,IConstWUAppValueIterator> (appvalues, 0, (IConstWorkUnit *) this);
  6119. }
  6120. void CLocalWorkUnit::setApplicationValue(const char *app, const char *propname, const char *value, bool overwrite)
  6121. {
  6122. CriticalBlock block(crit);
  6123. StringBuffer prop("Application/");
  6124. prop.append(app).append('/').append(propname);
  6125. if (overwrite || !p->hasProp(prop.str()))
  6126. {
  6127. StringBuffer sp;
  6128. p->setProp(sp.append("Application").str(), "");
  6129. p->setProp(sp.append('/').append(app).str(), "");
  6130. p->setProp(prop.str(), value);
  6131. }
  6132. }
  6133. void CLocalWorkUnit::setApplicationValueInt(const char *app, const char *propname, int value, bool overwrite)
  6134. {
  6135. VStringBuffer s("%d", value);
  6136. setApplicationValue(app, propname, s, overwrite);
  6137. }
  6138. void CLocalWorkUnit::setPriorityLevel(int level)
  6139. {
  6140. CriticalBlock block(crit);
  6141. p->setPropInt("PriorityFlag", level);
  6142. }
  6143. int CLocalWorkUnit::getPriorityLevel() const
  6144. {
  6145. CriticalBlock block(crit);
  6146. return p->getPropInt("PriorityFlag");
  6147. }
  6148. int calcPriorityValue(const IPropertyTree * p)
  6149. {
  6150. int priority = p->getPropInt("PriorityFlag");
  6151. switch((WUPriorityClass) getEnum(p, "@priorityClass", priorityClasses))
  6152. {
  6153. case PriorityClassLow:
  6154. priority -= 100;
  6155. break;
  6156. case PriorityClassHigh:
  6157. priority += 100;
  6158. break;
  6159. }
  6160. return priority;
  6161. }
  6162. int CLocalWorkUnit::getPriorityValue() const
  6163. {
  6164. CriticalBlock block(crit);
  6165. return calcPriorityValue(p);
  6166. }
  6167. void CLocalWorkUnit::setRescheduleFlag(bool value)
  6168. {
  6169. CriticalBlock block(crit);
  6170. p->setPropInt("RescheduleFlag", (int) value);
  6171. }
  6172. bool CLocalWorkUnit::getRescheduleFlag() const
  6173. {
  6174. CriticalBlock block(crit);
  6175. return p->getPropInt("RescheduleFlag") != 0;
  6176. }
  6177. class NullIStringIterator : implements IStringIterator, public CInterface
  6178. {
  6179. public:
  6180. IMPLEMENT_IINTERFACE;
  6181. bool first() { return false; }
  6182. bool next() { return false; }
  6183. bool isValid() { return false; }
  6184. IStringVal & str(IStringVal & str) { return str; }
  6185. };
  6186. ClusterType getClusterType(const char * platform, ClusterType dft)
  6187. {
  6188. if (stricmp(platform, "thor") == 0)
  6189. return ThorLCRCluster;
  6190. if (stricmp(platform, "thorlcr") == 0)
  6191. return ThorLCRCluster;
  6192. if (stricmp(platform, "hthor") == 0)
  6193. return HThorCluster;
  6194. if (stricmp(platform, "roxie") == 0)
  6195. return RoxieCluster;
  6196. return dft;
  6197. }
  6198. const char *clusterTypeString(ClusterType clusterType, bool lcrSensitive)
  6199. {
  6200. switch (clusterType)
  6201. {
  6202. case ThorLCRCluster:
  6203. if (lcrSensitive)
  6204. return "thorlcr";
  6205. return "thor";
  6206. case RoxieCluster:
  6207. return "roxie";
  6208. case HThorCluster:
  6209. return "hthor";
  6210. }
  6211. throwUnexpected();
  6212. }
  6213. IPropertyTree *queryRoxieProcessTree(IPropertyTree *environment, const char *process)
  6214. {
  6215. if (!process || !*process)
  6216. return NULL;
  6217. VStringBuffer xpath("Software/RoxieCluster[@name=\"%s\"]", process);
  6218. return environment->queryPropTree(xpath.str());
  6219. }
  6220. void getRoxieProcessServers(IPropertyTree *roxie, SocketEndpointArray &endpoints)
  6221. {
  6222. if (!roxie)
  6223. return;
  6224. Owned<IPropertyTreeIterator> servers = roxie->getElements("RoxieServerProcess");
  6225. ForEach(*servers)
  6226. {
  6227. IPropertyTree &server = servers->query();
  6228. const char *netAddress = server.queryProp("@netAddress");
  6229. if (netAddress && *netAddress)
  6230. {
  6231. SocketEndpoint ep(netAddress, server.getPropInt("@port", 9876));
  6232. endpoints.append(ep);
  6233. }
  6234. }
  6235. }
  6236. void getRoxieProcessServers(const char *process, SocketEndpointArray &servers)
  6237. {
  6238. Owned<IEnvironmentFactory> factory = getEnvironmentFactory(true);
  6239. Owned<IConstEnvironment> env = factory->openEnvironment();
  6240. Owned<IPropertyTree> root = &env->getPTree();
  6241. getRoxieProcessServers(queryRoxieProcessTree(root, process), servers);
  6242. }
  6243. class CEnvironmentClusterInfo: implements IConstWUClusterInfo, public CInterface
  6244. {
  6245. StringAttr name;
  6246. StringAttr alias;
  6247. StringAttr serverQueue;
  6248. StringAttr agentQueue;
  6249. StringAttr roxieProcess;
  6250. SocketEndpointArray roxieServers;
  6251. StringAttr thorQueue;
  6252. StringArray thorProcesses;
  6253. StringArray primaryThorProcesses;
  6254. StringAttr prefix;
  6255. StringAttr ldapUser;
  6256. StringBuffer ldapPassword;
  6257. ClusterType platform;
  6258. unsigned clusterWidth;
  6259. unsigned roxieRedundancy;
  6260. unsigned channelsPerNode;
  6261. unsigned numberOfSlaveLogs;
  6262. int roxieReplicateOffset;
  6263. public:
  6264. IMPLEMENT_IINTERFACE;
  6265. CEnvironmentClusterInfo(const char *_name, const char *_prefix, const char *_alias, IPropertyTree *agent, IArrayOf<IPropertyTree> &thors, IPropertyTree *roxie)
  6266. : name(_name), prefix(_prefix), alias(_alias), roxieRedundancy(0), channelsPerNode(0), numberOfSlaveLogs(0), roxieReplicateOffset(1)
  6267. {
  6268. StringBuffer queue;
  6269. if (thors.ordinality())
  6270. {
  6271. thorQueue.set(getClusterThorQueueName(queue.clear(), name));
  6272. clusterWidth = 0;
  6273. bool isMultiThor = (thors.length() > 1);
  6274. ForEachItemIn(i,thors)
  6275. {
  6276. IPropertyTree &thor = thors.item(i);
  6277. const char* thorName = thor.queryProp("@name");
  6278. thorProcesses.append(thorName);
  6279. if (!isMultiThor)
  6280. primaryThorProcesses.append(thorName);
  6281. else
  6282. {
  6283. const char *nodeGroup = thor.queryProp("@nodeGroup");
  6284. if (!nodeGroup || strieq(nodeGroup, thorName))
  6285. primaryThorProcesses.append(thorName);
  6286. }
  6287. unsigned nodes = thor.getCount("ThorSlaveProcess");
  6288. if (!nodes)
  6289. throw MakeStringException(WUERR_MismatchClusterSize,"CEnvironmentClusterInfo: Thor cluster can not have 0 slave processes");
  6290. unsigned slavesPerNode = thor.getPropInt("@slavesPerNode", 1);
  6291. unsigned channelsPerSlave = thor.getPropInt("@channelsPerSlave", 1);
  6292. unsigned ts = nodes * slavesPerNode * channelsPerSlave;
  6293. numberOfSlaveLogs = nodes * slavesPerNode;
  6294. if (clusterWidth && (ts!=clusterWidth))
  6295. throw MakeStringException(WUERR_MismatchClusterSize,"CEnvironmentClusterInfo: mismatched thor sizes in cluster");
  6296. clusterWidth = ts;
  6297. bool islcr = !thor.getPropBool("@Legacy");
  6298. if (!islcr)
  6299. throw MakeStringException(WUERR_MismatchThorType,"CEnvironmentClusterInfo: Legacy Thor no longer supported");
  6300. }
  6301. platform = ThorLCRCluster;
  6302. }
  6303. else if (roxie)
  6304. {
  6305. roxieProcess.set(roxie->queryProp("@name"));
  6306. platform = RoxieCluster;
  6307. getRoxieProcessServers(roxie, roxieServers);
  6308. clusterWidth = roxieServers.length();
  6309. ldapUser.set(roxie->queryProp("@ldapUser"));
  6310. StringBuffer encPassword = roxie->queryProp("@ldapPassword");
  6311. if (encPassword.length())
  6312. decrypt(ldapPassword, encPassword);
  6313. const char *redundancyMode = roxie->queryProp("@slaveConfig");
  6314. if (redundancyMode && *redundancyMode)
  6315. {
  6316. unsigned dataCopies = roxie->getPropInt("@numDataCopies", 1);
  6317. if (strieq(redundancyMode, "overloaded"))
  6318. channelsPerNode = roxie->getPropInt("@channelsPernode", 1);
  6319. else if (strieq(redundancyMode, "full redundancy"))
  6320. {
  6321. roxieRedundancy = dataCopies-1;
  6322. roxieReplicateOffset = 0;
  6323. }
  6324. else if (strieq(redundancyMode, "cyclic redundancy"))
  6325. {
  6326. roxieRedundancy = dataCopies-1;
  6327. channelsPerNode = dataCopies;
  6328. roxieReplicateOffset = roxie->getPropInt("@cyclicOffset", 1);
  6329. }
  6330. }
  6331. }
  6332. else
  6333. {
  6334. clusterWidth = 1;
  6335. platform = HThorCluster;
  6336. }
  6337. if (agent)
  6338. {
  6339. assertex(!roxie);
  6340. agentQueue.set(getClusterEclAgentQueueName(queue.clear(), name));
  6341. }
  6342. else if (roxie)
  6343. agentQueue.set(getClusterRoxieQueueName(queue.clear(), name));
  6344. // MORE - does this need to be conditional?
  6345. serverQueue.set(getClusterEclCCServerQueueName(queue.clear(), name));
  6346. }
  6347. IStringVal & getName(IStringVal & str) const
  6348. {
  6349. str.set(name.get());
  6350. return str;
  6351. }
  6352. const char *getAlias() const
  6353. {
  6354. return alias;
  6355. }
  6356. IStringVal & getScope(IStringVal & str) const
  6357. {
  6358. str.set(prefix.get());
  6359. return str;
  6360. }
  6361. IStringVal & getAgentQueue(IStringVal & str) const
  6362. {
  6363. str.set(agentQueue);
  6364. return str;
  6365. }
  6366. virtual IStringVal & getServerQueue(IStringVal & str) const
  6367. {
  6368. str.set(serverQueue);
  6369. return str;
  6370. }
  6371. IStringVal & getThorQueue(IStringVal & str) const
  6372. {
  6373. str.set(thorQueue);
  6374. return str;
  6375. }
  6376. unsigned getSize() const
  6377. {
  6378. return clusterWidth;
  6379. }
  6380. unsigned getNumberOfSlaveLogs() const
  6381. {
  6382. return numberOfSlaveLogs;
  6383. }
  6384. virtual ClusterType getPlatform() const
  6385. {
  6386. return platform;
  6387. }
  6388. IStringVal & getRoxieProcess(IStringVal & str) const
  6389. {
  6390. str.set(roxieProcess.get());
  6391. return str;
  6392. }
  6393. const StringArray & getThorProcesses() const
  6394. {
  6395. return thorProcesses;
  6396. }
  6397. const StringArray & getPrimaryThorProcesses() const
  6398. {
  6399. return primaryThorProcesses;
  6400. }
  6401. const SocketEndpointArray & getRoxieServers() const
  6402. {
  6403. return roxieServers;
  6404. }
  6405. unsigned getRoxieRedundancy() const
  6406. {
  6407. return roxieRedundancy;
  6408. }
  6409. unsigned getChannelsPerNode() const
  6410. {
  6411. return channelsPerNode;
  6412. }
  6413. int getRoxieReplicateOffset() const
  6414. {
  6415. return roxieReplicateOffset;
  6416. }
  6417. const char *getLdapUser() const
  6418. {
  6419. return ldapUser.get();
  6420. }
  6421. virtual const char *getLdapPassword() const
  6422. {
  6423. return ldapPassword.str();
  6424. }
  6425. };
  6426. IStringVal &getProcessQueueNames(IStringVal &ret, const char *process, const char *type, const char *suffix)
  6427. {
  6428. if (process)
  6429. {
  6430. Owned<IEnvironmentFactory> factory = getEnvironmentFactory(true);
  6431. Owned<IConstEnvironment> env = factory->openEnvironment();
  6432. Owned<IPropertyTree> root = &env->getPTree();
  6433. StringBuffer queueNames;
  6434. StringBuffer xpath;
  6435. xpath.appendf("%s[@process=\"%s\"]", type, process);
  6436. Owned<IPropertyTreeIterator> targets = root->getElements("Software/Topology/Cluster");
  6437. ForEach(*targets)
  6438. {
  6439. IPropertyTree &target = targets->query();
  6440. if (target.hasProp(xpath))
  6441. {
  6442. if (queueNames.length())
  6443. queueNames.append(',');
  6444. queueNames.append(target.queryProp("@name")).append(suffix);
  6445. }
  6446. }
  6447. ret.set(queueNames);
  6448. }
  6449. return ret;
  6450. }
  6451. #define ROXIE_QUEUE_EXT ".roxie"
  6452. #define THOR_QUEUE_EXT ".thor"
  6453. #define ECLCCSERVER_QUEUE_EXT ".eclserver"
  6454. #define ECLSERVER_QUEUE_EXT ECLCCSERVER_QUEUE_EXT
  6455. #define ECLSCHEDULER_QUEUE_EXT ".eclscheduler"
  6456. #define ECLAGENT_QUEUE_EXT ".agent"
  6457. extern WORKUNIT_API void getDFUServerQueueNames(StringArray &ret, const char *process)
  6458. {
  6459. Owned<IEnvironmentFactory> factory = getEnvironmentFactory(true);
  6460. Owned<IConstEnvironment> env = factory->openEnvironment();
  6461. StringBuffer xpath = "Software/DfuServerProcess";
  6462. if (!isEmptyString(process))
  6463. xpath.appendf("[@name=\"%s\"]", process);
  6464. Owned<IPropertyTree> root = &env->getPTree();
  6465. Owned<IPropertyTreeIterator> targets = root->getElements(xpath.str());
  6466. ForEach(*targets)
  6467. {
  6468. IPropertyTree &target = targets->query();
  6469. if (target.hasProp("@queue"))
  6470. ret.appendListUniq(target.queryProp("@queue"), ",");
  6471. }
  6472. return;
  6473. }
  6474. extern WORKUNIT_API IStringVal &getEclCCServerQueueNames(IStringVal &ret, const char *process)
  6475. {
  6476. return getProcessQueueNames(ret, process, "EclCCServerProcess", ECLCCSERVER_QUEUE_EXT);
  6477. }
  6478. extern WORKUNIT_API IStringVal &getEclServerQueueNames(IStringVal &ret, const char *process)
  6479. {
  6480. return getProcessQueueNames(ret, process, "EclServerProcess", ECLSERVER_QUEUE_EXT); // shares queue name with EclCCServer
  6481. }
  6482. extern WORKUNIT_API IStringVal &getEclSchedulerQueueNames(IStringVal &ret, const char *process)
  6483. {
  6484. return getProcessQueueNames(ret, process, "EclSchedulerProcess", ECLSCHEDULER_QUEUE_EXT); // Shares deployment/config with EclCCServer
  6485. }
  6486. extern WORKUNIT_API IStringVal &getAgentQueueNames(IStringVal &ret, const char *process)
  6487. {
  6488. return getProcessQueueNames(ret, process, "EclAgentProcess", ECLAGENT_QUEUE_EXT);
  6489. }
  6490. extern WORKUNIT_API IStringVal &getRoxieQueueNames(IStringVal &ret, const char *process)
  6491. {
  6492. return getProcessQueueNames(ret, process, "RoxieCluster", ROXIE_QUEUE_EXT);
  6493. }
  6494. extern WORKUNIT_API IStringVal &getThorQueueNames(IStringVal &ret, const char *process)
  6495. {
  6496. return getProcessQueueNames(ret, process, "ThorCluster", THOR_QUEUE_EXT);
  6497. }
  6498. extern WORKUNIT_API StringBuffer &getClusterThorQueueName(StringBuffer &ret, const char *cluster)
  6499. {
  6500. return ret.append(cluster).append(THOR_QUEUE_EXT);
  6501. }
  6502. extern WORKUNIT_API StringBuffer &getClusterThorGroupName(StringBuffer &ret, const char *cluster)
  6503. {
  6504. Owned<IEnvironmentFactory> factory = getEnvironmentFactory(true);
  6505. Owned<IConstEnvironment> env = factory->openEnvironment();
  6506. Owned<IPropertyTree> root = &env->getPTree();
  6507. StringBuffer path;
  6508. path.append("Software/ThorCluster[@name=\"").append(cluster).append("\"]");
  6509. IPropertyTree * child = root->queryPropTree(path);
  6510. if (child)
  6511. getClusterGroupName(*child, ret);
  6512. return ret;
  6513. }
  6514. extern WORKUNIT_API StringBuffer &getClusterRoxieQueueName(StringBuffer &ret, const char *cluster)
  6515. {
  6516. return ret.append(cluster).append(ROXIE_QUEUE_EXT);
  6517. }
  6518. extern WORKUNIT_API StringBuffer &getClusterEclCCServerQueueName(StringBuffer &ret, const char *cluster)
  6519. {
  6520. return ret.append(cluster).append(ECLCCSERVER_QUEUE_EXT);
  6521. }
  6522. extern WORKUNIT_API StringBuffer &getClusterEclServerQueueName(StringBuffer &ret, const char *cluster)
  6523. {
  6524. return ret.append(cluster).append(ECLSERVER_QUEUE_EXT);
  6525. }
  6526. extern WORKUNIT_API StringBuffer &getClusterEclAgentQueueName(StringBuffer &ret, const char *cluster)
  6527. {
  6528. return ret.append(cluster).append(ECLAGENT_QUEUE_EXT);
  6529. }
  6530. extern WORKUNIT_API IStringIterator *getTargetClusters(const char *processType, const char *processName)
  6531. {
  6532. Owned<CStringArrayIterator> ret = new CStringArrayIterator;
  6533. Owned<IEnvironmentFactory> factory = getEnvironmentFactory(true);
  6534. Owned<IConstEnvironment> env = factory->openEnvironment();
  6535. Owned<IPropertyTree> root = &env->getPTree();
  6536. StringBuffer xpath;
  6537. xpath.appendf("%s", processType ? processType : "*");
  6538. if (processName && *processName)
  6539. xpath.appendf("[@process=\"%s\"]", processName);
  6540. Owned<IPropertyTreeIterator> targets = root->getElements("Software/Topology/Cluster");
  6541. ForEach(*targets)
  6542. {
  6543. IPropertyTree &target = targets->query();
  6544. if (target.hasProp(xpath))
  6545. {
  6546. ret->append(target.queryProp("@name"));
  6547. }
  6548. }
  6549. return ret.getClear();
  6550. }
  6551. extern WORKUNIT_API bool isProcessCluster(const char *process)
  6552. {
  6553. if (!process || !*process)
  6554. return false;
  6555. Owned<IEnvironmentFactory> factory = getEnvironmentFactory(true);
  6556. Owned<IConstEnvironment> env = factory->openEnvironment();
  6557. Owned<IPropertyTree> root = &env->getPTree();
  6558. VStringBuffer xpath("Software/*Cluster[@name=\"%s\"]", process);
  6559. return root->hasProp(xpath.str());
  6560. }
  6561. extern WORKUNIT_API bool isProcessCluster(const char *remoteDali, const char *process)
  6562. {
  6563. if (!remoteDali || !*remoteDali)
  6564. return isProcessCluster(process);
  6565. if (!process || !*process)
  6566. return false;
  6567. Owned<INode> remote = createINode(remoteDali, 7070);
  6568. if (!remote)
  6569. return false;
  6570. //Cannot use getEnvironmentFactory() since it is using a remotedali
  6571. VStringBuffer xpath("Environment/Software/*Cluster[@name=\"%s\"]/@name", process);
  6572. try
  6573. {
  6574. Owned<IPropertyTreeIterator> clusters = querySDS().getElementsRaw(xpath, remote, 1000*60*1);
  6575. return clusters->first();
  6576. }
  6577. catch (IException *E)
  6578. {
  6579. StringBuffer msg;
  6580. E->errorMessage(msg);
  6581. DBGLOG("Exception validating cluster %s/%s: %s", remoteDali, xpath.str(), msg.str());
  6582. E->Release();
  6583. }
  6584. return true;
  6585. }
  6586. IConstWUClusterInfo* getTargetClusterInfo(IPropertyTree *environment, IPropertyTree *cluster)
  6587. {
  6588. const char *clustname = cluster->queryProp("@name");
  6589. // MORE - at the moment configenf specifies eclagent and thor queues by (in effect) placing an 'example' thor or eclagent in the topology
  6590. // that uses the queue that will be used.
  6591. // We should and I hope will change that, at which point the code below gets simpler
  6592. StringBuffer prefix(cluster->queryProp("@prefix"));
  6593. prefix.toLowerCase();
  6594. StringBuffer xpath;
  6595. StringBuffer querySetName;
  6596. IPropertyTree *agent = NULL;
  6597. const char *agentName = cluster->queryProp("EclAgentProcess/@process");
  6598. if (agentName)
  6599. {
  6600. xpath.clear().appendf("Software/EclAgentProcess[@name=\"%s\"]", agentName);
  6601. agent = environment->queryPropTree(xpath.str());
  6602. }
  6603. Owned<IPropertyTreeIterator> ti = cluster->getElements("ThorCluster");
  6604. IArrayOf<IPropertyTree> thors;
  6605. ForEach(*ti)
  6606. {
  6607. const char *thorName = ti->query().queryProp("@process");
  6608. if (thorName)
  6609. {
  6610. xpath.clear().appendf("Software/ThorCluster[@name=\"%s\"]", thorName);
  6611. thors.append(*environment->getPropTree(xpath.str()));
  6612. }
  6613. }
  6614. const char *roxieName = cluster->queryProp("RoxieCluster/@process");
  6615. return new CEnvironmentClusterInfo(clustname, prefix, cluster->queryProp("@alias"), agent, thors, queryRoxieProcessTree(environment, roxieName));
  6616. }
  6617. IPropertyTree* getTopologyCluster(Owned<IPropertyTree> &envRoot, const char *clustname)
  6618. {
  6619. if (!clustname || !*clustname)
  6620. return NULL;
  6621. Owned<IEnvironmentFactory> factory = getEnvironmentFactory(true);
  6622. Owned<IConstEnvironment> env = factory->openEnvironment();
  6623. envRoot.setown(&env->getPTree());
  6624. StringBuffer xpath;
  6625. xpath.appendf("Software/Topology/Cluster[@name=\"%s\"]", clustname);
  6626. return envRoot->getPropTree(xpath.str());
  6627. }
  6628. bool validateTargetClusterName(const char *clustname)
  6629. {
  6630. Owned<IPropertyTree> envRoot;
  6631. Owned<IPropertyTree> cluster = getTopologyCluster(envRoot, clustname);
  6632. return (cluster.get()!=NULL);
  6633. }
  6634. IConstWUClusterInfo* getTargetClusterInfo(const char *clustname)
  6635. {
  6636. Owned<IPropertyTree> envRoot;
  6637. Owned<IPropertyTree> cluster = getTopologyCluster(envRoot, clustname);
  6638. if (!cluster)
  6639. return NULL;
  6640. return getTargetClusterInfo(envRoot, cluster);
  6641. }
  6642. unsigned getEnvironmentClusterInfo(CConstWUClusterInfoArray &clusters)
  6643. {
  6644. Owned<IEnvironmentFactory> factory = getEnvironmentFactory(true);
  6645. Owned<IConstEnvironment> env = factory->openEnvironment();
  6646. Owned<IPropertyTree> root = &env->getPTree();
  6647. return getEnvironmentClusterInfo(root, clusters);
  6648. }
  6649. unsigned getEnvironmentClusterInfo(IPropertyTree* environmentRoot, CConstWUClusterInfoArray &clusters)
  6650. {
  6651. if (!environmentRoot)
  6652. return 0;
  6653. Owned<IPropertyTreeIterator> clusterIter = environmentRoot->getElements("Software/Topology/Cluster");
  6654. ForEach(*clusterIter)
  6655. {
  6656. IPropertyTree &node = clusterIter->query();
  6657. Owned<IConstWUClusterInfo> cluster = getTargetClusterInfo(environmentRoot, &node);
  6658. clusters.append(*cluster.getClear());
  6659. }
  6660. return clusters.ordinality();
  6661. }
  6662. const char *getTargetClusterComponentName(const char *clustname, const char *processType, StringBuffer &name)
  6663. {
  6664. if (!clustname)
  6665. return NULL;
  6666. Owned<IEnvironmentFactory> factory = getEnvironmentFactory(true);
  6667. Owned<IConstEnvironment> env = factory->openEnvironment();
  6668. Owned<IPropertyTree> root = &env->getPTree();
  6669. StringBuffer xpath;
  6670. xpath.appendf("Software/Topology/Cluster[@name=\"%s\"]", clustname);
  6671. Owned<IPropertyTree> cluster = root->getPropTree(xpath.str());
  6672. if (!cluster)
  6673. return NULL;
  6674. StringBuffer xpath1;
  6675. xpath1.appendf("%s/@process", processType);
  6676. name.append(cluster->queryProp(xpath1.str()));
  6677. return name.str();
  6678. }
  6679. unsigned getEnvironmentThorClusterNames(StringArray &thorNames, StringArray &groupNames, StringArray &targetNames, StringArray &queueNames)
  6680. {
  6681. Owned<IEnvironmentFactory> factory = getEnvironmentFactory(true);
  6682. Owned<IConstEnvironment> env = factory->openEnvironment();
  6683. Owned<IPropertyTree> root = &env->getPTree();
  6684. Owned<IPropertyTreeIterator> allTargets = root->getElements("Software/Topology/Cluster");
  6685. ForEach(*allTargets)
  6686. {
  6687. IPropertyTree &target = allTargets->query();
  6688. const char *targetName = target.queryProp("@name");
  6689. if (targetName && *targetName)
  6690. {
  6691. Owned<IPropertyTreeIterator> thorClusters = target.getElements("ThorCluster");
  6692. ForEach(*thorClusters)
  6693. {
  6694. const char *thorName = thorClusters->query().queryProp("@process");
  6695. VStringBuffer query("Software/ThorCluster[@name=\"%s\"]",thorName);
  6696. IPropertyTree *thorCluster = root->queryPropTree(query.str());
  6697. if (thorCluster)
  6698. {
  6699. const char *groupName = thorCluster->queryProp("@nodeGroup");
  6700. if (!groupName||!*groupName)
  6701. groupName = thorName;
  6702. thorNames.append(thorName);
  6703. groupNames.append(groupName);
  6704. targetNames.append(targetName);
  6705. StringBuffer queueName(targetName);
  6706. queueNames.append(queueName.append(THOR_QUEUE_EXT));
  6707. }
  6708. }
  6709. }
  6710. }
  6711. return thorNames.ordinality();
  6712. }
  6713. unsigned getEnvironmentHThorClusterNames(StringArray &eclAgentNames, StringArray &groupNames, StringArray &targetNames)
  6714. {
  6715. Owned<IEnvironmentFactory> factory = getEnvironmentFactory(true);
  6716. Owned<IConstEnvironment> env = factory->openEnvironment();
  6717. Owned<IPropertyTree> root = &env->getPTree();
  6718. Owned<IPropertyTreeIterator> allEclAgents = root->getElements("Software/EclAgentProcess");
  6719. ForEach(*allEclAgents)
  6720. {
  6721. IPropertyTree &eclAgent = allEclAgents->query();
  6722. const char *eclAgentName = eclAgent.queryProp("@name");
  6723. if (eclAgentName && *eclAgentName)
  6724. {
  6725. Owned<IPropertyTreeIterator> allTargets = root->getElements("Software/Topology/Cluster");
  6726. ForEach(*allTargets)
  6727. {
  6728. IPropertyTree &target = allTargets->query();
  6729. const char *targetName = target.queryProp("@name");
  6730. if (targetName && *targetName)
  6731. {
  6732. StringBuffer xpath;
  6733. xpath.appendf("EclAgentProcess[@process=\"%s\"]", eclAgentName);
  6734. if (target.hasProp(xpath) && !target.hasProp("ThorCluster"))
  6735. {
  6736. StringBuffer groupName("hthor__");
  6737. groupName.append(eclAgentName);
  6738. groupNames.append(groupName);
  6739. eclAgentNames.append(eclAgentName);
  6740. targetNames.append(targetName);
  6741. }
  6742. }
  6743. }
  6744. }
  6745. }
  6746. return eclAgentNames.ordinality();
  6747. }
  6748. IStringVal& CLocalWorkUnit::getScope(IStringVal &str) const
  6749. {
  6750. CriticalBlock block(crit);
  6751. if (p->hasProp("Debug/ForceScope"))
  6752. {
  6753. StringBuffer prefix(p->queryProp("Debug/ForceScope"));
  6754. str.set(prefix.toLowerCase().str());
  6755. }
  6756. else
  6757. {
  6758. Owned <IConstWUClusterInfo> ci = getTargetClusterInfo(p->queryProp("@clusterName"));
  6759. if (ci)
  6760. ci->getScope(str);
  6761. else
  6762. str.clear();
  6763. }
  6764. return str;
  6765. }
  6766. //Queries
  6767. void CLocalWorkUnit::setCodeVersion(unsigned codeVersion, const char * buildVersion, const char * eclVersion)
  6768. {
  6769. CriticalBlock block(crit);
  6770. p->setPropInt("@codeVersion", codeVersion);
  6771. p->setProp("@buildVersion", buildVersion);
  6772. p->setProp("@eclVersion", eclVersion);
  6773. }
  6774. unsigned CLocalWorkUnit::getCodeVersion() const
  6775. {
  6776. CriticalBlock block(crit);
  6777. return p->getPropInt("@codeVersion");
  6778. }
  6779. unsigned CLocalWorkUnit::getWuidVersion() const
  6780. {
  6781. CriticalBlock block(crit);
  6782. return p->getPropInt("@wuidVersion");
  6783. }
  6784. void CLocalWorkUnit::getBuildVersion(IStringVal & buildVersion, IStringVal & eclVersion) const
  6785. {
  6786. CriticalBlock block(crit);
  6787. buildVersion.set(p->queryProp("@buildVersion"));
  6788. eclVersion.set(p->queryProp("@eclVersion"));
  6789. }
  6790. void CLocalWorkUnit::setCloneable(bool value)
  6791. {
  6792. CriticalBlock block(crit);
  6793. p->setPropInt("@cloneable", value);
  6794. }
  6795. void CLocalWorkUnit::setIsClone(bool value)
  6796. {
  6797. CriticalBlock block(crit);
  6798. p->setPropInt("@isClone", value);
  6799. }
  6800. bool CLocalWorkUnit::getCloneable() const
  6801. {
  6802. CriticalBlock block(crit);
  6803. return p->getPropBool("@cloneable", false);
  6804. }
  6805. IUserDescriptor *CLocalWorkUnit::queryUserDescriptor() const
  6806. {
  6807. CriticalBlock block(crit);
  6808. if (!userDesc)
  6809. {
  6810. SCMStringBuffer token, user, password;
  6811. getSecurityToken(token);
  6812. extractToken(token.str(), queryWuid(), user, password);
  6813. userDesc.setown(createUserDescriptor());
  6814. userDesc->set(user.str(), password.str());
  6815. }
  6816. return userDesc;
  6817. }
  6818. bool CLocalWorkUnit::isProtected() const
  6819. {
  6820. CriticalBlock block(crit);
  6821. return p->getPropBool("@protected", false);
  6822. }
  6823. bool CLocalWorkUnit::isPausing() const
  6824. {
  6825. CriticalBlock block(crit);
  6826. if (WUActionPause == getAction())
  6827. {
  6828. switch (getState())
  6829. {
  6830. case WUStateRunning:
  6831. case WUStateAborting:
  6832. return true;
  6833. }
  6834. }
  6835. return false;
  6836. }
  6837. void CLocalWorkUnit::protect(bool protectMode)
  6838. {
  6839. CriticalBlock block(crit);
  6840. p->setPropBool("@protected", protectMode);
  6841. }
  6842. void CLocalWorkUnit::setResultLimit(unsigned value)
  6843. {
  6844. CriticalBlock block(crit);
  6845. p->setPropInt("resultLimit", value);
  6846. }
  6847. unsigned CLocalWorkUnit::getResultLimit() const
  6848. {
  6849. CriticalBlock block(crit);
  6850. return p->getPropInt("resultLimit");
  6851. }
  6852. IStringVal & CLocalWorkUnit::getSnapshot(IStringVal & str) const
  6853. {
  6854. CriticalBlock block(crit);
  6855. str.set(p->queryProp("SNAPSHOT"));
  6856. return str;
  6857. }
  6858. void CLocalWorkUnit::setSnapshot(const char * val)
  6859. {
  6860. CriticalBlock block(crit);
  6861. p->setProp("SNAPSHOT", val);
  6862. }
  6863. const static EnumMapping warningSeverityMap[] =
  6864. {
  6865. { SeverityInformation, "info" },
  6866. { SeverityWarning, "warning" },
  6867. { SeverityError, "error" },
  6868. { SeverityAlert, "alert" },
  6869. { SeverityIgnore, "ignore" },
  6870. { SeverityFatal, "fatal" },
  6871. { SeverityUnknown, NULL }
  6872. };
  6873. ErrorSeverity CLocalWorkUnit::getWarningSeverity(unsigned code, ErrorSeverity defaultSeverity) const
  6874. {
  6875. StringBuffer xpath;
  6876. xpath.append("OnWarnings/OnWarning[@code='").append(code).append("']");
  6877. CriticalBlock block(crit);
  6878. IPropertyTree * mapping = p->queryPropTree(xpath);
  6879. if (mapping)
  6880. return (ErrorSeverity) getEnum(mapping, "@severity", warningSeverityMap);
  6881. return defaultSeverity;
  6882. }
  6883. void CLocalWorkUnit::setWarningSeverity(unsigned code, ErrorSeverity severity)
  6884. {
  6885. StringBuffer xpath;
  6886. xpath.append("OnWarnings/OnWarning[@code='").append(code).append("']");
  6887. CriticalBlock block(crit);
  6888. IPropertyTree * mapping = p->queryPropTree(xpath);
  6889. if (!mapping)
  6890. {
  6891. IPropertyTree * onWarnings = ensurePTree(p, "OnWarnings");
  6892. mapping = onWarnings->addPropTree("OnWarning");
  6893. mapping->setPropInt("@code", code);
  6894. }
  6895. setEnum(mapping, "@severity", severity, warningSeverityMap);
  6896. }
  6897. static int comparePropTrees(IInterface * const *ll, IInterface * const *rr)
  6898. {
  6899. IPropertyTree *l = (IPropertyTree *) *ll;
  6900. IPropertyTree *r = (IPropertyTree *) *rr;
  6901. return stricmp(l->queryName(), r->queryName());
  6902. };
  6903. unsigned CLocalWorkUnit::calculateHash(unsigned crc)
  6904. {
  6905. // Any other values in the WU that could affect generated code should be crc'ed here
  6906. IPropertyTree *tree = p->queryBranch("Debug");
  6907. if (tree)
  6908. {
  6909. Owned<IPropertyTreeIterator> sub = tree->getElements("*");
  6910. ICopyArrayOf<IPropertyTree> subs;
  6911. for(sub->first(); sub->isValid(); sub->next())
  6912. subs.append(sub->query());
  6913. subs.sort(comparePropTrees);
  6914. ForEachItemIn(idx, subs)
  6915. {
  6916. const char *name = subs.item(idx).queryName();
  6917. const char *val = subs.item(idx).queryProp(NULL);
  6918. crc = crc32(name, (size32_t)strlen(name), crc);
  6919. if (val)
  6920. crc = crc32(val, (size32_t)strlen(val), crc);
  6921. }
  6922. }
  6923. Owned<IConstWUPluginIterator> plugins = &getPlugins();
  6924. for (plugins->first();plugins->isValid();plugins->next())
  6925. {
  6926. IConstWUPlugin &thisplugin = plugins->query();
  6927. SCMStringBuffer version;
  6928. thisplugin.getPluginVersion(version);
  6929. crc = crc32(version.str(), version.length(), crc);
  6930. }
  6931. return crc;
  6932. }
  6933. static void updateProp(IPropertyTree * to, const IPropertyTree * from, const char * xpath)
  6934. {
  6935. if (!to->hasProp(xpath) && from->hasProp(xpath))
  6936. to->setProp(xpath, from->queryProp(xpath));
  6937. }
  6938. static void setProp(IPropertyTree * to, const IPropertyTree * from, const char * xpath)
  6939. {
  6940. if (from->hasProp(xpath))
  6941. to->setProp(xpath, from->queryProp(xpath));
  6942. }
  6943. static void copyTree(IPropertyTree * to, const IPropertyTree * from, const char * xpath)
  6944. {
  6945. IPropertyTree * match = from->getBranch(xpath);
  6946. if (match)
  6947. to->setPropTree(xpath, match);
  6948. }
  6949. IPropertyTree *CLocalWorkUnit::queryPTree() const
  6950. {
  6951. return p;
  6952. }
  6953. void CLocalWorkUnit::copyWorkUnit(IConstWorkUnit *cached, bool copyStats, bool all)
  6954. {
  6955. CLocalWorkUnit *from = QUERYINTERFACE(cached, CLocalWorkUnit);
  6956. if (!from)
  6957. {
  6958. CLockedWorkUnit *fl = QUERYINTERFACE(cached, CLockedWorkUnit);
  6959. if (!fl)
  6960. throw MakeStringException(WUERR_InternalUnknownImplementation, "Cached workunit not created using workunit dll");
  6961. from = fl->c;
  6962. }
  6963. // Need to copy the query, the results, and the graphs from the cached query.
  6964. // The cache is made before the query is executed so there is no need to clear them.
  6965. if (!cached->getCloneable())
  6966. throw MakeStringException(WUERR_CannotCloneWorkunit, "Source work unit not marked as clonable");
  6967. const IPropertyTree * fromP = from->p;
  6968. IPropertyTree *pt;
  6969. CriticalBlock block(crit);
  6970. clearCached(false);
  6971. query.clear();
  6972. updateProp(p, fromP, "@jobName");
  6973. copyTree(p, fromP, "Query");
  6974. pt = fromP->getBranch("Application/LibraryModule");
  6975. if (pt)
  6976. {
  6977. ensurePTree(p, "Application");
  6978. p->setPropTree("Application/LibraryModule", pt);
  6979. }
  6980. pt = fromP->queryBranch("Debug");
  6981. if (pt)
  6982. {
  6983. IPropertyTree *curDebug = p->queryPropTree("Debug");
  6984. if (curDebug)
  6985. {
  6986. Owned<IPropertyTreeIterator> elems = pt->getElements("*");
  6987. ForEach(*elems)
  6988. {
  6989. IPropertyTree *elem = &elems->query();
  6990. if (!curDebug->hasProp(elem->queryName()))
  6991. curDebug->setPropTree(elem->queryName(),LINK(elem));
  6992. }
  6993. }
  6994. else
  6995. p->setPropTree("Debug", LINK(pt));
  6996. }
  6997. copyTree(p, fromP, "OnWarnings");
  6998. copyTree(p, fromP, "Plugins");
  6999. copyTree(p, fromP, "Libraries");
  7000. copyTree(p, fromP, "Results");
  7001. copyTree(p, fromP, "Graphs");
  7002. copyTree(p, fromP, "Workflow");
  7003. copyTree(p, fromP, "WebServicesInfo");
  7004. if (copyStats)
  7005. {
  7006. // Merge timing info from both branches
  7007. pt = fromP->getBranch("Statistics");
  7008. if (pt)
  7009. {
  7010. IPropertyTree *tgtStatistics = ensurePTree(p, "Statistics");
  7011. mergePTree(tgtStatistics, pt);
  7012. pt->Release();
  7013. }
  7014. }
  7015. updateProp(p, fromP, "@clusterName");
  7016. updateProp(p, fromP, "allowedclusters");
  7017. updateProp(p, fromP, "@submitID");
  7018. updateProp(p, fromP, "SNAPSHOT");
  7019. setProp(p, fromP, "@eventScheduledCount");
  7020. //MORE: This is very adhoc. All options that should be cloned should really be in a common branch
  7021. if (all)
  7022. {
  7023. setProp(p, fromP, "PriorityFlag");
  7024. setProp(p, fromP, "@priorityClass");
  7025. setProp(p, fromP, "@protected");
  7026. setProp(p, fromP, "@clusterName");
  7027. updateProp(p, fromP, "@scope");
  7028. }
  7029. //Variables may have been set up as parameters to the query - so need to preserve any values that were supplied.
  7030. pt = fromP->getBranch("Variables");
  7031. if (pt)
  7032. {
  7033. IPropertyTree *ptTgtVariables = ensurePTree(p, "Variables");
  7034. Owned<IPropertyTreeIterator> ptiVariable = pt->getElements("Variable");
  7035. for (ptiVariable->first(); ptiVariable->isValid(); ptiVariable->next())
  7036. {
  7037. IPropertyTree *ptSrcVariable = &ptiVariable->query();
  7038. const char *name = ptSrcVariable->queryProp("@name");
  7039. assertex(name);
  7040. StringBuffer xpath;
  7041. xpath.append("Variable[@name='").append(name).append("']");
  7042. IPropertyTree *ptTgtVariable = ptTgtVariables->queryPropTree(xpath.str());
  7043. IPropertyTree *merged = createPTreeFromIPT(ptSrcVariable); // clone entire source info...
  7044. merged->removeProp("Value"); // except value and status
  7045. merged->setProp("@status", "undefined");
  7046. if (!merged->getPropBool("@isScalar"))
  7047. merged->removeProp("totalRowCount");
  7048. merged->removeProp("rowCount");
  7049. // If there are any other fields that get set ONLY by eclagent, strip them out here...
  7050. if (ptTgtVariable)
  7051. {
  7052. // copy status and Value from what is already set in target
  7053. merged->setProp("@status", ptTgtVariable->queryProp("@status"));
  7054. MemoryBuffer value;
  7055. if (ptTgtVariable->getPropBin("Value", value))
  7056. merged->setPropBin("Value", value.length(), value.toByteArray());
  7057. ptTgtVariable->removeProp(xpath.str());
  7058. // If there are any other fields in a variable that get set by ws_ecl before submitting, copy them across here...
  7059. }
  7060. ptTgtVariables->addPropTree("Variable", merged);
  7061. }
  7062. pt->Release();
  7063. }
  7064. p->setProp("@codeVersion", fromP->queryProp("@codeVersion"));
  7065. p->setProp("@buildVersion", fromP->queryProp("@buildVersion"));
  7066. p->setProp("@eclVersion", fromP->queryProp("@eclVersion"));
  7067. p->setProp("@totalThorTime", fromP->queryProp("@totalThorTime"));
  7068. p->setProp("@hash", fromP->queryProp("@hash"));
  7069. p->setPropBool("@cloneable", true);
  7070. p->setPropBool("@isClone", true);
  7071. resetWorkflow(); // the source Workflow section may have had some parts already executed...
  7072. Owned<IPropertyTreeIterator> results = p->getElements("Results/Result");
  7073. ForEach(*results)
  7074. {
  7075. CLocalWUResult result(LINK(&results->query()));
  7076. result.setResultStatus(ResultStatusUndefined);
  7077. }
  7078. copyTree(p, fromP, "usedsources"); // field usage
  7079. }
  7080. bool CLocalWorkUnit::hasDebugValue(const char *propname) const
  7081. {
  7082. StringBuffer lower;
  7083. lower.append(propname).toLowerCase();
  7084. CriticalBlock block(crit);
  7085. StringBuffer prop("Debug/");
  7086. return p->hasProp(prop.append(lower));
  7087. }
  7088. IStringVal& CLocalWorkUnit::getDebugValue(const char *propname, IStringVal &str) const
  7089. {
  7090. StringBuffer lower;
  7091. lower.append(propname).toLowerCase();
  7092. CriticalBlock block(crit);
  7093. StringBuffer prop("Debug/");
  7094. str.set(p->queryProp(prop.append(lower).str()));
  7095. return str;
  7096. }
  7097. IStringIterator& CLocalWorkUnit::getDebugValues() const
  7098. {
  7099. return getDebugValues(NULL);
  7100. }
  7101. IStringIterator& CLocalWorkUnit::getDebugValues(const char *prop) const
  7102. {
  7103. CriticalBlock block(crit);
  7104. StringBuffer path("Debug/");
  7105. if (prop)
  7106. {
  7107. StringBuffer lower;
  7108. lower.append(prop).toLowerCase();
  7109. path.append(lower);
  7110. }
  7111. else
  7112. path.append("*");
  7113. return *new CStringPTreeTagIterator(p->getElements(path.str()));
  7114. }
  7115. int CLocalWorkUnit::getDebugValueInt(const char *propname, int defVal) const
  7116. {
  7117. StringBuffer lower;
  7118. lower.append(propname).toLowerCase();
  7119. CriticalBlock block(crit);
  7120. StringBuffer prop("Debug/");
  7121. prop.append(lower);
  7122. return p->getPropInt(prop.str(), defVal);
  7123. }
  7124. __int64 CLocalWorkUnit::getDebugValueInt64(const char *propname, __int64 defVal) const
  7125. {
  7126. StringBuffer lower;
  7127. lower.append(propname).toLowerCase();
  7128. CriticalBlock block(crit);
  7129. StringBuffer prop("Debug/");
  7130. prop.append(lower);
  7131. return p->getPropInt64(prop.str(), defVal);
  7132. }
  7133. bool CLocalWorkUnit::getDebugValueBool(const char * propname, bool defVal) const
  7134. {
  7135. StringBuffer lower;
  7136. lower.append(propname).toLowerCase();
  7137. CriticalBlock block(crit);
  7138. StringBuffer prop("Debug/");
  7139. prop.append(lower);
  7140. return p->getPropBool(prop.str(), defVal);
  7141. }
  7142. IStringIterator *CLocalWorkUnit::getLogs(const char *type, const char *instance) const
  7143. {
  7144. VStringBuffer xpath("Process/%s/", type);
  7145. if (instance)
  7146. xpath.append(instance);
  7147. else
  7148. xpath.append("*");
  7149. CriticalBlock block(crit);
  7150. if (p->getPropInt("@wuidVersion") < 1) // legacy wuid
  7151. {
  7152. // NB: instance unused
  7153. if (streq("EclAgent", type))
  7154. return new CStringPTreeIterator(p->getElements("Debug/eclagentlog"));
  7155. else if (streq("Thor", type))
  7156. return new CStringPTreeIterator(p->getElements("Debug/thorlog*"));
  7157. VStringBuffer xpath("Debug/%s", type);
  7158. return new CStringPTreeIterator(p->getElements(xpath.str()));
  7159. }
  7160. else
  7161. return new CStringPTreeAttrIterator(p->getElements(xpath.str()), "@log");
  7162. }
  7163. IPropertyTreeIterator* CLocalWorkUnit::getProcesses(const char *type, const char *instance) const
  7164. {
  7165. VStringBuffer xpath("Process/%s/", type);
  7166. if (instance)
  7167. xpath.append(instance);
  7168. else
  7169. xpath.append("*");
  7170. CriticalBlock block(crit);
  7171. return p->getElements(xpath.str());
  7172. }
  7173. IStringIterator *CLocalWorkUnit::getProcesses(const char *type) const
  7174. {
  7175. VStringBuffer xpath("Process/%s/*", type);
  7176. CriticalBlock block(crit);
  7177. return new CStringPTreeTagIterator(p->getElements(xpath.str()));
  7178. }
  7179. void CLocalWorkUnit::addProcess(const char *type, const char *instance, unsigned pid, const char *log)
  7180. {
  7181. VStringBuffer processType("Process/%s", type);
  7182. VStringBuffer xpath("%s/%s", processType.str(), instance);
  7183. if (log)
  7184. xpath.appendf("[@log=\"%s\"]", log);
  7185. CriticalBlock block(crit);
  7186. if (!p->hasProp(xpath))
  7187. {
  7188. IPropertyTree *node = ensurePTree(p, processType.str());
  7189. node = node->addPropTree(instance);
  7190. node->setProp("@log", log);
  7191. node->setPropInt("@pid", pid);
  7192. }
  7193. }
  7194. void CLocalWorkUnit::setDebugValue(const char *propname, const char *value, bool overwrite)
  7195. {
  7196. StringBuffer lower;
  7197. lower.append(propname).toLowerCase();
  7198. CriticalBlock block(crit);
  7199. StringBuffer prop("Debug/");
  7200. prop.append(lower);
  7201. if (overwrite || !p->hasProp(prop.str()))
  7202. {
  7203. // MORE - not sure this line should be needed....
  7204. p->setProp("Debug", "");
  7205. p->setProp(prop.str(), value);
  7206. }
  7207. }
  7208. void CLocalWorkUnit::setDebugValueInt(const char *propname, int value, bool overwrite)
  7209. {
  7210. StringBuffer lower;
  7211. lower.append(propname).toLowerCase();
  7212. CriticalBlock block(crit);
  7213. StringBuffer prop("Debug/");
  7214. prop.append(lower);
  7215. if (overwrite || !p->hasProp(prop.str()))
  7216. {
  7217. // MORE - not sure this line should be needed....
  7218. p->setProp("Debug", "");
  7219. p->setPropInt(prop.str(), value);
  7220. }
  7221. }
  7222. void CLocalWorkUnit::setTracingValue(const char *propname, const char *value)
  7223. {
  7224. CriticalBlock block(crit);
  7225. // MORE - not sure this line should be needed....
  7226. p->setProp("Tracing", "");
  7227. StringBuffer prop("Tracing/");
  7228. p->setProp(prop.append(propname).str(), value);
  7229. }
  7230. void CLocalWorkUnit::setTracingValueInt(const char *propname, int value)
  7231. {
  7232. CriticalBlock block(crit);
  7233. StringBuffer prop("Tracing/");
  7234. p->setPropInt(prop.append(propname).str(), value);
  7235. }
  7236. void CLocalWorkUnit::setTracingValueInt64(const char *propname, __int64 value)
  7237. {
  7238. CriticalBlock block(crit);
  7239. VStringBuffer prop("Tracing/%s", propname);
  7240. p->setPropInt64(prop.str(), value);
  7241. }
  7242. IConstWUQuery* CLocalWorkUnit::getQuery() const
  7243. {
  7244. // For this to be legally called, we must have the read-able interface. So we are already locked for (at least) read.
  7245. CriticalBlock block(crit);
  7246. if (!query)
  7247. {
  7248. IPropertyTree *s = p->getPropTree("Query");
  7249. if (s)
  7250. query.setown(new CLocalWUQuery(s)); // NB takes ownership of 's'
  7251. }
  7252. return query.getLink();
  7253. }
  7254. IWUQuery* CLocalWorkUnit::updateQuery()
  7255. {
  7256. // For this to be legally called, we must have the write-able interface. So we are already locked for write.
  7257. CriticalBlock block(crit);
  7258. if (!query)
  7259. {
  7260. IPropertyTree *s = p->queryPropTree("Query");
  7261. if (!s)
  7262. s = p->addPropTree("Query", createPTreeFromXMLString("<Query fetchEntire='1'/>")); // Is this really desirable (the fetchEntire) ?
  7263. s->Link();
  7264. query.setown(new CLocalWUQuery(s));
  7265. }
  7266. return query.getLink();
  7267. }
  7268. void CLocalWorkUnit::loadPlugins() const
  7269. {
  7270. CriticalBlock block(crit);
  7271. if (!pluginsCached)
  7272. {
  7273. assertex(plugins.length() == 0);
  7274. Owned<IPropertyTreeIterator> r = p->getElements("Plugins/Plugin");
  7275. for (r->first(); r->isValid(); r->next())
  7276. {
  7277. IPropertyTree *rp = &r->query();
  7278. rp->Link();
  7279. plugins.append(*new CLocalWUPlugin(rp));
  7280. }
  7281. pluginsCached = true;
  7282. }
  7283. }
  7284. IConstWUPluginIterator& CLocalWorkUnit::getPlugins() const
  7285. {
  7286. CriticalBlock block(crit);
  7287. loadPlugins();
  7288. return *new CArrayIteratorOf<IConstWUPlugin,IConstWUPluginIterator> (plugins, 0, (IConstWorkUnit *) this);
  7289. }
  7290. void CLocalWorkUnit::loadLibraries() const
  7291. {
  7292. CriticalBlock block(crit);
  7293. if (!librariesCached)
  7294. {
  7295. assertex(libraries.length() == 0);
  7296. Owned<IPropertyTreeIterator> r = p->getElements("Libraries/Library");
  7297. ForEach(*r)
  7298. {
  7299. IPropertyTree *rp = &r->query();
  7300. rp->Link();
  7301. libraries.append(*new CLocalWULibrary(rp));
  7302. }
  7303. librariesCached = true;
  7304. }
  7305. }
  7306. IConstWULibraryIterator& CLocalWorkUnit::getLibraries() const
  7307. {
  7308. CriticalBlock block(crit);
  7309. loadLibraries();
  7310. return *new CArrayIteratorOf<IConstWULibrary,IConstWULibraryIterator> (libraries, 0, (IConstWorkUnit *) this);
  7311. }
  7312. IConstWULibrary * CLocalWorkUnit::getLibraryByName(const char * search) const
  7313. {
  7314. CriticalBlock block(crit);
  7315. loadLibraries();
  7316. ForEachItemIn(idx, libraries)
  7317. {
  7318. SCMStringBuffer name;
  7319. IConstWULibrary &cur = libraries.item(idx);
  7320. cur.getName(name);
  7321. if (stricmp(name.str(), search)==0)
  7322. return &OLINK(cur);
  7323. }
  7324. return NULL;
  7325. }
  7326. StringBuffer &formatGraphTimerLabel(StringBuffer &str, const char *graphName, unsigned subGraphNum, unsigned __int64 subId)
  7327. {
  7328. str.append("Graph ").append(graphName);
  7329. if (subGraphNum) str.append(" - ").append(subGraphNum).append(" (").append(subId).append(")");
  7330. else if (subId) str.append(" - id(").append(subId).append(")");
  7331. return str;
  7332. }
  7333. StringBuffer &formatGraphTimerScope(StringBuffer &str, unsigned wfid, const char *graphName, unsigned subGraphNum, unsigned __int64 subId)
  7334. {
  7335. if (wfid)
  7336. str.append(WorkflowScopePrefix).append(wfid).append(":");
  7337. str.append(graphName);
  7338. if (subId) str.append(":sg").append(subId);
  7339. return str;
  7340. }
  7341. bool parseGraphTimerLabel(const char *label, StringAttr &graphName, unsigned & graphNum, unsigned &subGraphNum, unsigned &subId)
  7342. {
  7343. // expects format: "Graph <graphname>[ - <subgraphnum> (<subgraphid>)]"
  7344. unsigned len = (size32_t)strlen(label);
  7345. if (len < 6 || (0 != memcmp(label, "Graph ", 6)))
  7346. return false;
  7347. graphNum = 0;
  7348. subGraphNum = 0;
  7349. subId = 0;
  7350. const char *finger = label+6;
  7351. const char *finger2 = strchr(finger, '-');
  7352. if (NULL == finger2) // just graphName
  7353. graphName.set(finger);
  7354. else
  7355. {
  7356. graphName.set(finger, (size32_t)((finger2-1)-finger));
  7357. finger = finger2+2; // skip '-' and space
  7358. finger2 = strchr(finger, ' ');
  7359. if (finger2)
  7360. {
  7361. subGraphNum = atoi_l(finger, (size32_t)(finger2-finger));
  7362. finger = finger2+2; // skip space and '('
  7363. finger2 = strchr(finger, ')');
  7364. if (finger2)
  7365. subId = atoi_l(finger, (size32_t)(finger2-finger));
  7366. }
  7367. else if (((len-(finger-label))>3) && 0 == memcmp(finger, "id(", 3)) // subgraph id only, new format.
  7368. {
  7369. finger += 3;
  7370. finger2 = strchr(finger, ')');
  7371. if (finger2)
  7372. subId = atoi_l(finger, (size32_t)(finger2-finger));
  7373. }
  7374. }
  7375. if (graphName && !memicmp(graphName, "graph", 5))
  7376. graphNum = atoi(graphName + 5);
  7377. return true;
  7378. }
  7379. bool parseGraphScope(const char *scope, StringAttr &graphName, unsigned & graphNum, unsigned &subGraphId)
  7380. {
  7381. if (!MATCHES_CONST_PREFIX(scope, GraphScopePrefix))
  7382. return false;
  7383. graphNum = atoi(scope + strlen(GraphScopePrefix));
  7384. subGraphId = 0;
  7385. const char * colon = strchr(scope, ':');
  7386. if (!colon)
  7387. {
  7388. graphName.set(scope);
  7389. return true;
  7390. }
  7391. const char * subgraph = colon+1;
  7392. graphName.set(scope, (size32_t)(colon - scope));
  7393. if (MATCHES_CONST_PREFIX(subgraph, SubGraphScopePrefix))
  7394. subGraphId = atoi(subgraph+strlen(SubGraphScopePrefix));
  7395. return true;
  7396. }
  7397. 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)
  7398. {
  7399. if (!scope) scope = GLOBAL_SCOPE;
  7400. const char * kindName = queryStatisticName(kind);
  7401. StatisticMeasure measure = queryMeasure(kind);
  7402. //creator. scope and name must all be present, and must not contain semi colons.
  7403. assertex(creator && scope);
  7404. CriticalBlock block(crit);
  7405. IPropertyTree * stats = p->queryPropTree("Statistics");
  7406. if (!stats)
  7407. stats = p->addPropTree("Statistics");
  7408. IPropertyTree * statTree = NULL;
  7409. if (mergeAction != StatsMergeAppend)
  7410. {
  7411. StringBuffer xpath;
  7412. xpath.append("Statistic[@creator='").append(creator).append("'][@scope='").append(scope).append("'][@kind='").append(kindName).append("']");
  7413. statTree = stats->queryPropTree(xpath.str());
  7414. }
  7415. if (!statTree)
  7416. {
  7417. statTree = stats->addPropTree("Statistic");
  7418. statTree->setProp("@creator", creator);
  7419. statTree->setProp("@scope", scope);
  7420. statTree->setProp("@kind", kindName);
  7421. //These items are primarily here to facilitate filtering.
  7422. statTree->setProp("@unit", queryMeasureName(measure));
  7423. statTree->setProp("@c", queryCreatorTypeName(creatorType));
  7424. statTree->setProp("@s", queryScopeTypeName(scopeType));
  7425. statTree->setPropInt64("@ts", getTimeStampNowValue());
  7426. if (optDescription)
  7427. statTree->setProp("@desc", optDescription);
  7428. if (statistics.cached)
  7429. statistics.append(LINK(statTree));
  7430. mergeAction = StatsMergeAppend;
  7431. }
  7432. if (mergeAction != StatsMergeAppend) // RKC->GH Is this right??
  7433. {
  7434. unsigned __int64 oldValue = statTree->getPropInt64("@value", 0);
  7435. unsigned __int64 oldCount = statTree->getPropInt64("@count", 0);
  7436. unsigned __int64 oldMax = statTree->getPropInt64("@max", 0);
  7437. if (oldMax < oldValue)
  7438. oldMax = oldValue;
  7439. statTree->setPropInt64("@value", mergeStatisticValue(oldValue, value, mergeAction));
  7440. statTree->setPropInt64("@count", count + oldCount);
  7441. if (maxValue > oldMax)
  7442. statTree->setPropInt64("@max", maxValue);
  7443. }
  7444. else
  7445. {
  7446. statTree->setPropInt64("@value", value);
  7447. statTree->setPropInt64("@count", count);
  7448. if (maxValue)
  7449. statTree->setPropInt64("@max", maxValue);
  7450. else
  7451. statTree->removeProp("@max");
  7452. }
  7453. //Whenever a graph time is updated recalculate the total time spent in thor, and save it
  7454. if ((scopeType == SSTgraph) && (kind == StTimeElapsed))
  7455. {
  7456. _loadStatistics();
  7457. stat_type totalTime = 0;
  7458. ForEachItemIn(i, statistics)
  7459. {
  7460. IConstWUStatistic & cur = statistics.item(i);
  7461. if ((cur.getScopeType() == SSTgraph) && (cur.getKind() == StTimeElapsed))
  7462. totalTime += cur.getValue();
  7463. }
  7464. StringBuffer t;
  7465. formatTimeCollatable(t, totalTime, false);
  7466. p->setProp("@totalThorTime", t);
  7467. }
  7468. }
  7469. void CLocalWorkUnit::_loadStatistics() const
  7470. {
  7471. statistics.load(p,"Statistics/*");
  7472. }
  7473. bool CLocalWorkUnit::getStatistic(stat_type & value, const char * scope, StatisticKind kind) const
  7474. {
  7475. //MORE: Optimize this....
  7476. WuScopeFilter filter;
  7477. filter.addScope(scope).setIncludeNesting(0).addRequiredStat(kind).addOutputStatistic(kind).finishedFilter();
  7478. Owned<IConstWUScopeIterator> stats = &getScopeIterator(filter);
  7479. if (stats->first())
  7480. return stats->getStat(kind, value);
  7481. return false;
  7482. }
  7483. IConstWUScopeIterator & CLocalWorkUnit::getScopeIterator(const WuScopeFilter & filter) const
  7484. {
  7485. assertex(filter.isOptimized());
  7486. WuScopeSourceFlags sources = filter.sourceFlags;
  7487. Owned<CompoundStatisticsScopeIterator> compoundIter = new CompoundStatisticsScopeIterator(filter);
  7488. if (sources & SSFsearchGlobalStats)
  7489. {
  7490. {
  7491. CriticalBlock block(crit);
  7492. statistics.loadBranch(p,"Statistics");
  7493. }
  7494. Owned<IConstWUScopeIterator> localStats(new WorkUnitStatisticsScopeIterator(statistics, filter.queryIterFilter()));
  7495. compoundIter->addIter(localStats);
  7496. }
  7497. if (sources & SSFsearchGraphStats)
  7498. {
  7499. const char * wuid = p->queryName();
  7500. Owned<IConstWUScopeIterator> scopeIter(new CConstGraphProgressScopeIterator(wuid, filter.queryIterFilter(), filter.minVersion));
  7501. compoundIter->addIter(scopeIter);
  7502. }
  7503. if (sources & SSFsearchGraph)
  7504. {
  7505. Owned<IConstWUScopeIterator> graphIter(new GraphScopeIterator(this, filter.queryIterFilter()));
  7506. compoundIter->addIter(graphIter);
  7507. }
  7508. if (sources & SSFsearchWorkflow)
  7509. {
  7510. Owned<IConstWUScopeIterator> workflowIter(new WorkflowStatisticsScopeIterator(getWorkflowItems()));
  7511. compoundIter->addIter(workflowIter);
  7512. }
  7513. return *compoundIter.getClear();
  7514. }
  7515. IWUPlugin* CLocalWorkUnit::updatePluginByName(const char *qname)
  7516. {
  7517. CriticalBlock block(crit);
  7518. IConstWUPlugin *existing = getPluginByName(qname);
  7519. if (existing)
  7520. return (IWUPlugin *) existing;
  7521. if (!plugins.length())
  7522. p->addPropTree("Plugins");
  7523. IPropertyTree *pl = p->queryPropTree("Plugins");
  7524. IPropertyTree *s = pl->addPropTree("Plugin");
  7525. s->Link();
  7526. IWUPlugin* q = new CLocalWUPlugin(s);
  7527. q->Link();
  7528. plugins.append(*q);
  7529. q->setPluginName(qname);
  7530. return q;
  7531. }
  7532. IConstWUPlugin* CLocalWorkUnit::getPluginByName(const char *qname) const
  7533. {
  7534. CriticalBlock block(crit);
  7535. loadPlugins();
  7536. ForEachItemIn(idx, plugins)
  7537. {
  7538. SCMStringBuffer name;
  7539. IConstWUPlugin &cur = plugins.item(idx);
  7540. cur.getPluginName(name);
  7541. if (stricmp(name.str(), qname)==0)
  7542. {
  7543. cur.Link();
  7544. return &cur;
  7545. }
  7546. }
  7547. return NULL;
  7548. }
  7549. IWULibrary* CLocalWorkUnit::updateLibraryByName(const char *qname)
  7550. {
  7551. CriticalBlock block(crit);
  7552. IConstWULibrary *existing = getLibraryByName(qname);
  7553. if (existing)
  7554. return (IWULibrary *) existing;
  7555. if (!libraries.length())
  7556. p->addPropTree("Libraries");
  7557. IPropertyTree *pl = p->queryPropTree("Libraries");
  7558. IPropertyTree *s = pl->addPropTree("Library");
  7559. s->Link();
  7560. IWULibrary* q = new CLocalWULibrary(s);
  7561. q->Link();
  7562. libraries.append(*q);
  7563. q->setName(qname);
  7564. return q;
  7565. }
  7566. void CLocalWorkUnit::_loadExceptions() const
  7567. {
  7568. assertex(exceptions.length() == 0);
  7569. Owned<IPropertyTreeIterator> r = p->getElements("Exceptions/Exception");
  7570. for (r->first(); r->isValid(); r->next())
  7571. {
  7572. IPropertyTree *rp = &r->query();
  7573. rp->Link();
  7574. exceptions.append(*new CLocalWUException(rp));
  7575. }
  7576. }
  7577. void CLocalWorkUnit::loadExceptions() const
  7578. {
  7579. CriticalBlock block(crit);
  7580. if (!exceptionsCached)
  7581. {
  7582. _loadExceptions();
  7583. exceptionsCached = true;
  7584. }
  7585. }
  7586. IConstWUExceptionIterator& CLocalWorkUnit::getExceptions() const
  7587. {
  7588. CriticalBlock block(crit);
  7589. loadExceptions();
  7590. return *new CArrayIteratorOf<IConstWUException,IConstWUExceptionIterator> (exceptions, 0, (IConstWorkUnit *) this);
  7591. }
  7592. unsigned CLocalWorkUnit::getExceptionCount() const
  7593. {
  7594. CriticalBlock block(crit);
  7595. loadExceptions();
  7596. return exceptions.length();
  7597. }
  7598. void CLocalWorkUnit::clearExceptions()
  7599. {
  7600. CriticalBlock block(crit);
  7601. // For this to be legally called, we must have the write-able interface. So we are already locked for write.
  7602. loadExceptions();
  7603. ForEachItemInRev(idx, exceptions)
  7604. {
  7605. IWUException &e = exceptions.item(idx);
  7606. SCMStringBuffer s;
  7607. e.getExceptionSource(s);
  7608. if (strieq(s.s, "eclcc") || strieq(s.s, "eclccserver") || strieq(s.s, "eclserver") )
  7609. break;
  7610. VStringBuffer xpath("Exceptions/Exception[@sequence='%d']", e.getSequence());
  7611. p->removeProp(xpath);
  7612. exceptions.remove(idx);
  7613. }
  7614. if (exceptions.length() == 0)
  7615. p->removeProp("Exceptions");
  7616. }
  7617. IWUException* CLocalWorkUnit::createException()
  7618. {
  7619. CriticalBlock block(crit);
  7620. // For this to be legally called, we must have the write-able interface. So we are already locked for write.
  7621. loadExceptions();
  7622. if (!exceptions.length())
  7623. p->addPropTree("Exceptions");
  7624. IPropertyTree *r = p->queryPropTree("Exceptions");
  7625. IPropertyTree *s = r->addPropTree("Exception");
  7626. s->setPropInt("@sequence", exceptions.ordinality());
  7627. IWUException* q = new CLocalWUException(LINK(s));
  7628. exceptions.append(*LINK(q));
  7629. Owned<IJlibDateTime> now = createDateTimeNow();
  7630. SCMStringBuffer temp;
  7631. now->getString(temp);
  7632. q->setTimeStamp(temp.str());
  7633. return q;
  7634. }
  7635. IConstWUWebServicesInfo* CLocalWorkUnit::getWebServicesInfo() const
  7636. {
  7637. // For this to be legally called, we must have the read-able interface. So we are already locked for (at least) read.
  7638. CriticalBlock block(crit);
  7639. if (!webServicesInfoCached)
  7640. {
  7641. assertex(!webServicesInfo);
  7642. IPropertyTree *s = p->getPropTree("WebServicesInfo");
  7643. if (s)
  7644. webServicesInfo.setown(new CLocalWUWebServicesInfo(s)); // NB takes ownership of 's'
  7645. webServicesInfoCached = true;
  7646. }
  7647. return webServicesInfo.getLink();
  7648. }
  7649. IWUWebServicesInfo* CLocalWorkUnit::updateWebServicesInfo(bool create)
  7650. {
  7651. // For this to be legally called, we must have the write-able interface. So we are already locked for write.
  7652. CriticalBlock block(crit);
  7653. if (!webServicesInfoCached)
  7654. {
  7655. IPropertyTree *s = p->queryPropTree("WebServicesInfo");
  7656. if (!s)
  7657. {
  7658. if (create)
  7659. s = p->addPropTree("WebServicesInfo");
  7660. else
  7661. return NULL;
  7662. }
  7663. s->Link();
  7664. webServicesInfo.setown(new CLocalWUWebServicesInfo(s));
  7665. webServicesInfoCached = true;
  7666. }
  7667. return webServicesInfo.getLink();
  7668. }
  7669. static int compareResults(IInterface * const *ll, IInterface * const *rr)
  7670. {
  7671. CLocalWUResult *l = (CLocalWUResult *) *ll;
  7672. CLocalWUResult *r = (CLocalWUResult *) *rr;
  7673. return l->getResultSequence() - r->getResultSequence();
  7674. }
  7675. void CLocalWorkUnit::_loadResults() const
  7676. {
  7677. Owned<IPropertyTreeIterator> r = p->getElements("Results/Result");
  7678. for (r->first(); r->isValid(); r->next())
  7679. {
  7680. IPropertyTree *rp = &r->query();
  7681. rp->Link();
  7682. results.append(*new CLocalWUResult(rp));
  7683. }
  7684. }
  7685. void CLocalWorkUnit::loadResults() const
  7686. {
  7687. if (!resultsCached)
  7688. {
  7689. assertex(results.length() == 0);
  7690. _loadResults();
  7691. results.sort(compareResults);
  7692. resultsCached = true;
  7693. }
  7694. }
  7695. void CLocalWorkUnit::_loadVariables() const
  7696. {
  7697. Owned<IPropertyTreeIterator> r = p->getElements("Variables/Variable");
  7698. for (r->first(); r->isValid(); r->next())
  7699. {
  7700. IPropertyTree *rp = &r->query();
  7701. rp->Link();
  7702. variables.append(*new CLocalWUResult(rp));
  7703. }
  7704. }
  7705. void CLocalWorkUnit::loadVariables() const
  7706. {
  7707. if (!variablesCached)
  7708. {
  7709. assertex(variables.length() == 0);
  7710. _loadVariables();
  7711. variablesCached = true;
  7712. }
  7713. }
  7714. void CLocalWorkUnit::_loadTemporaries() const
  7715. {
  7716. Owned<IPropertyTreeIterator> r = p->getElements("Temporaries/Variable");
  7717. for (r->first(); r->isValid(); r->next())
  7718. {
  7719. IPropertyTree *rp = &r->query();
  7720. rp->Link();
  7721. temporaries.append(*new CLocalWUResult(rp));
  7722. }
  7723. }
  7724. void CLocalWorkUnit::loadTemporaries() const
  7725. {
  7726. if (!temporariesCached)
  7727. {
  7728. assertex(temporaries.length() == 0);
  7729. _loadTemporaries();
  7730. temporariesCached = true;
  7731. }
  7732. }
  7733. void CLocalWorkUnit::deleteTemporaries()
  7734. {
  7735. CriticalBlock block(crit);
  7736. if (temporariesCached)
  7737. {
  7738. temporaries.kill();
  7739. temporariesCached = false;
  7740. }
  7741. p->removeProp("Temporaries");
  7742. }
  7743. IWUResult* CLocalWorkUnit::createResult()
  7744. {
  7745. CriticalBlock block(crit);
  7746. // For this to be legally called, we must have the write-able interface. So we are already locked for write.
  7747. loadResults();
  7748. if (!results.length())
  7749. p->addPropTree("Results");
  7750. IPropertyTree *r = p->queryPropTree("Results");
  7751. IPropertyTree *s = r->addPropTree("Result");
  7752. s->Link();
  7753. IWUResult* q = new CLocalWUResult(s);
  7754. q->Link();
  7755. results.append(*q);
  7756. return q;
  7757. }
  7758. IWUResult* CLocalWorkUnit::updateResultByName(const char *qname)
  7759. {
  7760. CriticalBlock block(crit);
  7761. IConstWUResult *existing = getResultByName(qname);
  7762. if (existing)
  7763. return (IWUResult *) existing;
  7764. IWUResult* q = createResult();
  7765. q->setResultName(qname);
  7766. return q;
  7767. }
  7768. IWUResult* CLocalWorkUnit::updateResultBySequence(unsigned seq)
  7769. {
  7770. CriticalBlock block(crit);
  7771. IConstWUResult *existing = getResultBySequence(seq);
  7772. if (existing)
  7773. return (IWUResult *) existing;
  7774. IWUResult* q = createResult();
  7775. q->setResultSequence(seq);
  7776. return q;
  7777. }
  7778. IConstWUResultIterator& CLocalWorkUnit::getResults() const
  7779. {
  7780. CriticalBlock block(crit);
  7781. loadResults();
  7782. return *new CArrayIteratorOf<IConstWUResult,IConstWUResultIterator> (results, 0, (IConstWorkUnit *) this);
  7783. }
  7784. IConstWUResult* CLocalWorkUnit::getResultByName(const char *qname) const
  7785. {
  7786. CriticalBlock block(crit);
  7787. loadResults();
  7788. ForEachItemIn(idx, results)
  7789. {
  7790. SCMStringBuffer name;
  7791. IConstWUResult &cur = results.item(idx);
  7792. cur.getResultName(name);
  7793. if (stricmp(name.str(), qname)==0)
  7794. {
  7795. cur.Link();
  7796. return &cur;
  7797. }
  7798. }
  7799. return NULL;
  7800. }
  7801. IConstWUResult* CLocalWorkUnit::getResultBySequence(unsigned seq) const
  7802. {
  7803. CriticalBlock block(crit);
  7804. loadResults();
  7805. ForEachItemIn(idx, results)
  7806. {
  7807. IConstWUResult &cur = results.item(idx);
  7808. if (cur.getResultSequence() == seq)
  7809. {
  7810. cur.Link();
  7811. return &cur;
  7812. }
  7813. }
  7814. return NULL;
  7815. }
  7816. IConstWUResultIterator& CLocalWorkUnit::getVariables() const
  7817. {
  7818. CriticalBlock block(crit);
  7819. loadVariables();
  7820. return *new CArrayIteratorOf<IConstWUResult,IConstWUResultIterator> (variables, 0, (IConstWorkUnit *) this);
  7821. }
  7822. IConstWUResult* CLocalWorkUnit::getGlobalByName(const char *qname) const
  7823. {
  7824. CriticalBlock block(crit);
  7825. if (strcmp(p->queryName(), GLOBAL_WORKUNIT)==0)
  7826. return getVariableByName(qname);
  7827. Owned <IWorkUnit> global = factory->getGlobalWorkUnit(secMgr, secUser);
  7828. return global->getVariableByName(qname);
  7829. }
  7830. IWUResult* CLocalWorkUnit::updateGlobalByName(const char *qname)
  7831. {
  7832. CriticalBlock block(crit);
  7833. if (strcmp(p->queryName(), GLOBAL_WORKUNIT)==0)
  7834. return updateVariableByName(qname);
  7835. Owned <IWorkUnit> global = factory->getGlobalWorkUnit(secMgr, secUser);
  7836. return global->updateVariableByName(qname);
  7837. }
  7838. IConstWUResult* CLocalWorkUnit::getVariableByName(const char *qname) const
  7839. {
  7840. CriticalBlock block(crit);
  7841. loadVariables();
  7842. ForEachItemIn(idx, variables)
  7843. {
  7844. SCMStringBuffer name;
  7845. IConstWUResult &cur = variables.item(idx);
  7846. cur.getResultName(name);
  7847. if (stricmp(name.str(), qname)==0)
  7848. {
  7849. cur.Link();
  7850. return &cur;
  7851. }
  7852. }
  7853. return NULL;
  7854. }
  7855. IConstWUResult* CLocalWorkUnit::getTemporaryByName(const char *qname) const
  7856. {
  7857. CriticalBlock block(crit);
  7858. loadTemporaries();
  7859. ForEachItemIn(idx, temporaries)
  7860. {
  7861. SCMStringBuffer name;
  7862. IConstWUResult &cur = temporaries.item(idx);
  7863. cur.getResultName(name);
  7864. if (stricmp(name.str(), qname)==0)
  7865. {
  7866. cur.Link();
  7867. return &cur;
  7868. }
  7869. }
  7870. return NULL;
  7871. }
  7872. IConstWUResultIterator& CLocalWorkUnit::getTemporaries() const
  7873. {
  7874. CriticalBlock block(crit);
  7875. loadTemporaries();
  7876. return *new CArrayIteratorOf<IConstWUResult,IConstWUResultIterator> (temporaries, 0, (IConstWorkUnit *) this);
  7877. }
  7878. IWUResult* CLocalWorkUnit::updateTemporaryByName(const char *qname)
  7879. {
  7880. CriticalBlock block(crit);
  7881. IConstWUResult *existing = getTemporaryByName(qname);
  7882. if (existing)
  7883. return (IWUResult *) existing;
  7884. IPropertyTree *vars = (temporaries.length()) ? p->queryPropTree("Temporaries") : p->addPropTree("Temporaries");
  7885. IPropertyTree *s = vars->addPropTree("Variable");
  7886. s->Link();
  7887. IWUResult* q = new CLocalWUResult(s);
  7888. q->Link();
  7889. temporaries.append(*q);
  7890. q->setResultName(qname);
  7891. q->setResultSequence(ResultSequenceInternal);
  7892. return q;
  7893. }
  7894. IWUResult* CLocalWorkUnit::updateVariableByName(const char *qname)
  7895. {
  7896. CriticalBlock block(crit);
  7897. IConstWUResult *existing = getVariableByName(qname);
  7898. if (existing)
  7899. return (IWUResult *) existing;
  7900. if (!variables.length())
  7901. p->addPropTree("Variables");
  7902. IPropertyTree *vars = p->queryPropTree("Variables");
  7903. IPropertyTree *s = vars->addPropTree("Variable");
  7904. s->Link();
  7905. IWUResult* q = new CLocalWUResult(s);
  7906. q->Link();
  7907. variables.append(*q);
  7908. q->setResultName(qname);
  7909. q->setResultSequence(ResultSequenceStored);
  7910. return q;
  7911. }
  7912. void CLocalWorkUnit::deleteTempFiles(const char *graph, bool deleteOwned, bool deleteJobOwned)
  7913. {
  7914. CriticalBlock block(crit);
  7915. IPropertyTree *files = p->queryPropTree("Files");
  7916. if (!files) return;
  7917. Owned<IPropertyTreeIterator> iter = files->getElements("File");
  7918. ICopyArrayOf<IPropertyTree> toRemove;
  7919. ForEach (*iter)
  7920. {
  7921. IPropertyTree &file = iter->query();
  7922. WUFileKind fileKind = (WUFileKind) file.getPropInt("@kind", WUFileStandard);
  7923. if(file.getPropBool("@temporary")) fileKind = WUFileTemporary; // @temporary, legacy check
  7924. bool needDelete;
  7925. switch(fileKind)
  7926. {
  7927. case WUFileTemporary:
  7928. if(graph==NULL)
  7929. needDelete = true;
  7930. else
  7931. {
  7932. const char *graphOwner = file.queryProp("@graph");
  7933. needDelete = ((graphOwner==NULL) || (strcmp(graph, graphOwner)==0));
  7934. }
  7935. break;
  7936. case WUFileJobOwned:
  7937. needDelete = ((graph==NULL) && deleteJobOwned);
  7938. break;
  7939. case WUFileOwned:
  7940. needDelete = ((graph==NULL) && deleteOwned);
  7941. break;
  7942. default:
  7943. needDelete = false;
  7944. }
  7945. if(needDelete)
  7946. {
  7947. const char *name = file.queryProp("@name");
  7948. LOG(MCdebugProgress, unknownJob, "Removing workunit file %s from DFS", name);
  7949. queryDistributedFileDirectory().removeEntry(name, queryUserDescriptor());
  7950. toRemove.append(file);
  7951. }
  7952. }
  7953. ForEachItemIn(r, toRemove) files->removeTree(&toRemove.item(r));
  7954. }
  7955. static void _noteFileRead(IDistributedFile *file, IPropertyTree *filesRead)
  7956. {
  7957. IDistributedSuperFile *super = file->querySuperFile();
  7958. StringBuffer fname;
  7959. file->getLogicalName(fname);
  7960. if (fname.length())
  7961. {
  7962. StringBuffer path("File[@name=\"");
  7963. path.append(fname).append("\"]");
  7964. IPropertyTree *fileTree = filesRead->queryPropTree(path.str());
  7965. if (fileTree)
  7966. fileTree->setPropInt("@useCount", fileTree->getPropInt("@useCount")+1);
  7967. else
  7968. {
  7969. StringBuffer cluster;
  7970. file->getClusterName(0,cluster);
  7971. fileTree = createPTree();
  7972. fileTree->setProp("@name", fname.str());
  7973. fileTree->setProp("@cluster", cluster.str());
  7974. fileTree->setPropInt("@useCount", 1);
  7975. fileTree = filesRead->addPropTree("File", fileTree);
  7976. }
  7977. if (super)
  7978. {
  7979. fileTree->setPropBool("@super", true);
  7980. Owned<IDistributedFileIterator> iter = super->getSubFileIterator(false);
  7981. ForEach (*iter)
  7982. {
  7983. IDistributedFile &file = iter->query();
  7984. StringBuffer fname;
  7985. file.getLogicalName(fname);
  7986. fileTree->addPropTree("Subfile")->setProp("@name", fname.str());
  7987. _noteFileRead(&file, filesRead);
  7988. }
  7989. }
  7990. }
  7991. }
  7992. void CLocalWorkUnit::_loadFilesRead() const
  7993. {
  7994. // Nothing to do
  7995. }
  7996. void CLocalWorkUnit::noteFileRead(IDistributedFile *file)
  7997. {
  7998. if (file)
  7999. {
  8000. CriticalBlock block(crit);
  8001. IPropertyTree *files = p->queryPropTree("FilesRead");
  8002. if (!files)
  8003. files = p->addPropTree("FilesRead");
  8004. _noteFileRead(file, files);
  8005. }
  8006. }
  8007. void CLocalWorkUnit::noteFieldUsage(IPropertyTree * fieldUsage)
  8008. {
  8009. if (fieldUsage)
  8010. {
  8011. CriticalBlock block(crit);
  8012. p->addPropTree("usedsources", fieldUsage);
  8013. }
  8014. }
  8015. void CLocalWorkUnit::_loadFilesWritten() const
  8016. {
  8017. // Nothing to do
  8018. }
  8019. static void addFile(IPropertyTree *files, const char *fileName, const char *cluster, unsigned usageCount, WUFileKind fileKind, const char *graphOwner)
  8020. {
  8021. StringBuffer path("File[@name=\"");
  8022. path.append(fileName).append("\"]");
  8023. if (cluster)
  8024. path.append("[@cluster=\"").append(cluster).append("\"]");
  8025. IPropertyTree *file = files->queryPropTree(path.str());
  8026. if (file) files->removeTree(file);
  8027. file = createPTree();
  8028. file->setProp("@name", fileName);
  8029. if (cluster)
  8030. file->setProp("@cluster", cluster);
  8031. if (graphOwner)
  8032. file->setProp("@graph", graphOwner);
  8033. file->setPropInt("@kind", (unsigned)fileKind);
  8034. if (WUFileTemporary == fileKind)
  8035. file->setPropInt("@usageCount", usageCount);
  8036. files->addPropTree("File", file);
  8037. }
  8038. void CLocalWorkUnit::addFile(const char *fileName, StringArray *clusters, unsigned usageCount, WUFileKind fileKind, const char *graphOwner)
  8039. {
  8040. CriticalBlock block(crit);
  8041. IPropertyTree *files = p->queryPropTree("Files");
  8042. if (!files)
  8043. files = p->addPropTree("Files");
  8044. if (!clusters)
  8045. ::addFile(files, fileName, NULL, usageCount, fileKind, graphOwner);
  8046. else
  8047. {
  8048. ForEachItemIn(c, *clusters)
  8049. ::addFile(files, fileName, clusters->item(c), usageCount, fileKind, graphOwner);
  8050. }
  8051. }
  8052. void CLocalWorkUnit::releaseFile(const char *fileName)
  8053. {
  8054. StringBuffer path("File[@name=\"");
  8055. path.append(fileName).append("\"]");
  8056. CriticalBlock block(crit);
  8057. IPropertyTree *files = p->queryPropTree("Files");
  8058. if (!files) return;
  8059. Owned<IPropertyTreeIterator> fiter = files->getElements(path.str());
  8060. ForEach (*fiter)
  8061. {
  8062. IPropertyTree *file = &fiter->query();
  8063. unsigned usageCount = file->getPropInt("@usageCount");
  8064. if (usageCount > 1)
  8065. file->setPropInt("@usageCount", usageCount-1);
  8066. else
  8067. {
  8068. StringAttr name(file->queryProp("@name"));
  8069. files->removeTree(file);
  8070. if (!name.isEmpty()&&(1 == usageCount))
  8071. {
  8072. if (queryDistributedFileDirectory().removeEntry(fileName, queryUserDescriptor()))
  8073. LOG(MCdebugProgress, unknownJob, "Removed (released) file %s from DFS", name.get());
  8074. }
  8075. }
  8076. }
  8077. }
  8078. void CLocalWorkUnit::clearGraphProgress() const
  8079. {
  8080. }
  8081. void CLocalWorkUnit::resetBeforeGeneration()
  8082. {
  8083. CriticalBlock block(crit);
  8084. //Remove all associated files
  8085. Owned<IWUQuery> q = updateQuery();
  8086. q->removeAssociatedFiles();
  8087. //Remove any pre-existing workflow information
  8088. workflowIterator.clear();
  8089. p->removeProp("Workflow");
  8090. }
  8091. unsigned CLocalWorkUnit::queryFileUsage(const char *fileName) const
  8092. {
  8093. StringBuffer path("Files/File[@name=\"");
  8094. path.append(fileName).append("\"]/@usageCount");
  8095. CriticalBlock block(crit);
  8096. return p->getPropInt(path.str());
  8097. }
  8098. IConstWUFileUsageIterator * CLocalWorkUnit::getFieldUsage() const
  8099. {
  8100. CriticalBlock block(crit);
  8101. IPropertyTree* fieldUsageTree = p->queryPropTree("usedsources");
  8102. if (!fieldUsageTree)
  8103. return NULL;
  8104. IPropertyTreeIterator* iter = fieldUsageTree->getElements("*");
  8105. return new CConstWUFileUsageIterator(iter);
  8106. }
  8107. bool isFilenameResolved(StringBuffer& filename)
  8108. {
  8109. size32_t length = filename.length();
  8110. // With current implementation, if filename is surrounded by single quotes, it means that the filename was resolved at compile time.
  8111. if (filename.length() >= 2 && filename.charAt(0) == '\'' && filename.charAt(length-1) == '\'')
  8112. return true;
  8113. else
  8114. return false;
  8115. }
  8116. bool CLocalWorkUnit::getFieldUsageArray(StringArray & filenames, StringArray & columnnames, const char * clusterName) const
  8117. {
  8118. bool scopeLoaded = false;
  8119. SCMStringBuffer defaultScope;
  8120. Owned<IConstWUFileUsageIterator> files = getFieldUsage();
  8121. if (!files)
  8122. return false; // this query was not compiled with recordFieldUsage option.
  8123. ForEach(*files)
  8124. {
  8125. Owned<IConstWUFileUsage> file = files->get();
  8126. StringBuffer filename = file->queryName();
  8127. size32_t length = filename.length();
  8128. if (length == 0)
  8129. throw MakeStringException(WUERR_InvalidFieldUsage, "Invalid FieldUsage found in WU. Cannot enforce view security.");
  8130. StringBuffer normalizedFilename;
  8131. // Two cases to handle:
  8132. // 1. Filename was known at compile time, and is surrounded in single quotes (i.e. 'filename').
  8133. // 2. Filename could not be resolved at compile time (i.e. filename is an input to a query),
  8134. // and is a raw expression WITHOUT surrounding single quotes (i.e. STORED('input_filename')).
  8135. if (isFilenameResolved(filename))
  8136. {
  8137. // filename cannot be empty (i.e. empty single quotes '')
  8138. if (length == 2)
  8139. throw MakeStringException(WUERR_InvalidFieldUsage, "Invalid FieldUsage found in WU. Cannot enforce view security.");
  8140. // Remove surrounding single quotes
  8141. StringAttr cleanFilename(filename.str()+1, length-2);
  8142. // When a filename doesn't start with a tilde (~), it means scope is omitted and is relying on a default scope.
  8143. // We need to load a default scope from config and prefix the filename with it.
  8144. if (cleanFilename.str()[0] != '~')
  8145. {
  8146. // loading a default scope from config is expensive, and should be only done once and be reused later.
  8147. if (!scopeLoaded)
  8148. {
  8149. Owned<IConstWUClusterInfo> clusterInfo = getTargetClusterInfo(clusterName);
  8150. if (!clusterInfo)
  8151. throw MakeStringException(WUERR_InvalidCluster, "Unknown cluster %s", clusterName);
  8152. clusterInfo->getScope(defaultScope);
  8153. scopeLoaded = true;
  8154. }
  8155. normalizedFilename.append(defaultScope.str());
  8156. normalizedFilename.append(cleanFilename.str());
  8157. }
  8158. else
  8159. {
  8160. normalizedFilename.append(cleanFilename);
  8161. }
  8162. }
  8163. else
  8164. {
  8165. // When filename is an unresolved expression, simply treat the expression as a "non-existent" filename.
  8166. // It will have an effect of this query accessing a non-existent filename, and will be denied access unconditionally.
  8167. normalizedFilename.append(filename.str());
  8168. }
  8169. Owned<IConstWUFieldUsageIterator> fields = file->getFields();
  8170. ForEach(*fields)
  8171. {
  8172. Owned<IConstWUFieldUsage> field = fields->get();
  8173. filenames.append(normalizedFilename.str());
  8174. columnnames.append(field->queryName());
  8175. }
  8176. }
  8177. return true;
  8178. }
  8179. IPropertyTree *CLocalWorkUnit::getDiskUsageStats()
  8180. {
  8181. return p->getPropTree("DiskUsageStats");
  8182. }
  8183. void CLocalWorkUnit::addDiskUsageStats(__int64 _avgNodeUsage, unsigned _minNode, __int64 _minNodeUsage, unsigned _maxNode, __int64 _maxNodeUsage, __int64 _graphId)
  8184. {
  8185. IPropertyTree *stats = p->queryPropTree("DiskUsageStats");
  8186. offset_t maxNodeUsage;
  8187. if (stats)
  8188. maxNodeUsage = stats->getPropInt64("@maxNodeUsage");
  8189. else
  8190. {
  8191. stats = p->addPropTree("DiskUsageStats");
  8192. maxNodeUsage = 0;
  8193. }
  8194. if ((offset_t)_maxNodeUsage > maxNodeUsage)
  8195. {
  8196. // record all details at time of max node usage.
  8197. stats->setPropInt("@minNode", _minNode);
  8198. stats->setPropInt("@maxNode", _maxNode);
  8199. stats->setPropInt64("@minNodeUsage", _minNodeUsage);
  8200. stats->setPropInt64("@maxNodeUsage", _maxNodeUsage);
  8201. stats->setPropInt64("@graphId", _graphId);
  8202. if (_avgNodeUsage)
  8203. {
  8204. unsigned _skewHi = (unsigned)((100 * (_maxNodeUsage-_avgNodeUsage))/_avgNodeUsage);
  8205. unsigned _skewLo = (unsigned)((100 * (_avgNodeUsage-_minNodeUsage))/_avgNodeUsage);
  8206. stats->setPropInt("@skewHi", _skewHi);
  8207. stats->setPropInt("@skewLo", _skewLo);
  8208. }
  8209. }
  8210. }
  8211. IPropertyTreeIterator & CLocalWorkUnit::getFileIterator() const
  8212. {
  8213. CriticalBlock block(crit);
  8214. _loadFilesWritten();
  8215. return * p->getElements("Files/File");
  8216. }
  8217. IPropertyTreeIterator & CLocalWorkUnit::getFilesReadIterator() const
  8218. {
  8219. CriticalBlock block(crit);
  8220. _loadFilesRead();
  8221. return * p->getElements("FilesRead/File");
  8222. }
  8223. //=================================================================================================
  8224. bool CLocalWorkUnit::switchThorQueue(const char *cluster, IQueueSwitcher *qs)
  8225. {
  8226. CriticalBlock block(crit);
  8227. if (qs->isAuto()&&!getAllowAutoQueueSwitch())
  8228. return false;
  8229. Owned<IConstWUClusterInfo> newci = getTargetClusterInfo(cluster);
  8230. if (!newci)
  8231. return false;
  8232. StringBuffer currentcluster;
  8233. if (!p->getProp("@clusterName",currentcluster))
  8234. return false;
  8235. Owned<IConstWUClusterInfo> curci = getTargetClusterInfo(currentcluster.str());
  8236. if (!curci)
  8237. return false;
  8238. SCMStringBuffer curqname;
  8239. curci->getThorQueue(curqname);
  8240. const char *wuid = p->queryName();
  8241. void *qi = qs->getQ(curqname.str(),wuid);
  8242. if (!qi)
  8243. return false;
  8244. setClusterName(cluster);
  8245. SCMStringBuffer newqname;
  8246. newci->getThorQueue(newqname);
  8247. qs->putQ(newqname.str(),wuid,qi);
  8248. return true;
  8249. }
  8250. //=================================================================================================
  8251. IPropertyTree *CLocalWorkUnit::getUnpackedTree(bool includeProgress) const
  8252. {
  8253. Owned<IPropertyTree> ret = createPTreeFromIPT(p);
  8254. Owned<IConstWUGraphIterator> graphIter = &getGraphs(GraphTypeAny);
  8255. ForEach(*graphIter)
  8256. {
  8257. IConstWUGraph &graph = graphIter->query();
  8258. Owned<IPropertyTree> graphTree = graph.getXGMMLTree(includeProgress);
  8259. SCMStringBuffer gName;
  8260. graph.getName(gName);
  8261. StringBuffer xpath("Graphs/Graph[@name=\"");
  8262. xpath.append(gName.s).append("\"]/xgmml");
  8263. IPropertyTree *xgmml = ret->queryPropTree(xpath.str());
  8264. if (xgmml) // don't know of any reason it shouldn't exist
  8265. {
  8266. xgmml->removeProp("graphBin");
  8267. xgmml->setPropTree("graph", graphTree.getClear());
  8268. }
  8269. }
  8270. return ret.getClear();
  8271. }
  8272. void CLocalWorkUnit::_loadGraphs(bool heavy) const
  8273. {
  8274. Owned<IPropertyTreeIterator> iter = p->getElements("Graphs/Graph");
  8275. ForEach(*iter)
  8276. {
  8277. IPropertyTree &graph = iter->query();
  8278. graphs.append(*new CLocalWUGraph(*this, LINK(&graph)));
  8279. }
  8280. }
  8281. void CLocalWorkUnit::loadGraphs(bool heavy) const
  8282. {
  8283. if (graphsCached < (heavy ? 2 : 1))
  8284. {
  8285. graphs.kill();
  8286. _loadGraphs(heavy);
  8287. graphsCached = (heavy ? 2 : 1);
  8288. }
  8289. }
  8290. EnumMapping graphTypes[] = {
  8291. { GraphTypeAny, "unknown" },
  8292. { GraphTypeProgress, "progress" },
  8293. { GraphTypeEcl, "ECL" },
  8294. { GraphTypeActivities, "activities" },
  8295. { GraphTypeSubProgress, "subgraph" },
  8296. { GraphTypeSize, NULL },
  8297. };
  8298. WUGraphType getGraphTypeFromString(const char* type)
  8299. {
  8300. return (WUGraphType) getEnum(type, graphTypes);
  8301. }
  8302. CLocalWUGraph::CLocalWUGraph(const CLocalWorkUnit &_owner, IPropertyTree *props) : p(props), owner(_owner)
  8303. {
  8304. wuidVersion = owner.getWuidVersion();
  8305. }
  8306. IStringVal& CLocalWUGraph::getName(IStringVal &str) const
  8307. {
  8308. str.set(p->queryProp("@name"));
  8309. return str;
  8310. }
  8311. IStringVal& CLocalWUGraph::getLabel(IStringVal &str) const
  8312. {
  8313. if (wuidVersion >= 2)
  8314. {
  8315. str.set(p->queryProp("@label"));
  8316. return str;
  8317. }
  8318. else
  8319. {
  8320. Owned<IPropertyTree> xgmml = getXGMMLTree(false);
  8321. str.set(xgmml->queryProp("@label"));
  8322. return str;
  8323. }
  8324. }
  8325. WUGraphState CLocalWUGraph::getState() const
  8326. {
  8327. return owner.queryGraphState(p->queryProp("@name"));
  8328. }
  8329. IStringVal& CLocalWUGraph::getXGMML(IStringVal &str, bool mergeProgress) const
  8330. {
  8331. Owned<IPropertyTree> xgmml = getXGMMLTree(mergeProgress);
  8332. if (xgmml)
  8333. {
  8334. StringBuffer x;
  8335. toXML(xgmml, x);
  8336. str.set(x.str());
  8337. }
  8338. return str;
  8339. }
  8340. unsigned CLocalWorkUnit::getGraphCount() const
  8341. {
  8342. CriticalBlock block(crit);
  8343. if (p->hasProp("Graphs"))
  8344. {
  8345. return p->queryPropTree("Graphs")->numChildren();
  8346. }
  8347. return 0;
  8348. }
  8349. unsigned CLocalWorkUnit::getSourceFileCount() const
  8350. {
  8351. CriticalBlock block(crit);
  8352. _loadFilesRead();
  8353. if (p->hasProp("FilesRead"))
  8354. {
  8355. return p->queryPropTree("FilesRead")->numChildren();
  8356. }
  8357. return 0;
  8358. }
  8359. unsigned CLocalWorkUnit::getResultCount() const
  8360. {
  8361. CriticalBlock block(crit);
  8362. if (p->hasProp("Results"))
  8363. {
  8364. return p->queryPropTree("Results")->numChildren();
  8365. }
  8366. return 0;
  8367. }
  8368. unsigned CLocalWorkUnit::getVariableCount() const
  8369. {
  8370. CriticalBlock block(crit);
  8371. if (p->hasProp("Variables"))
  8372. {
  8373. return p->queryPropTree("Variables")->numChildren();
  8374. }
  8375. return 0;
  8376. }
  8377. unsigned CLocalWorkUnit::getApplicationValueCount() const
  8378. {
  8379. CriticalBlock block(crit);
  8380. if (p->hasProp("Application"))
  8381. {
  8382. return p->queryPropTree("Application")->numChildren();
  8383. }
  8384. return 0;
  8385. }
  8386. StringBuffer &appendPTreeOpenTag(StringBuffer &s, IPropertyTree *tree, const char *name, unsigned indent, bool hidePasswords)
  8387. {
  8388. appendXMLOpenTag(s, name, NULL, false);
  8389. Owned<IAttributeIterator> attrs = tree->getAttributes(true);
  8390. if (attrs->first())
  8391. {
  8392. unsigned attributeindent = indent + (size32_t) strlen(name);
  8393. unsigned count = attrs->count();
  8394. bool doindent = false;
  8395. ForEach(*attrs)
  8396. {
  8397. if (hidePasswords && streq(attrs->queryName(), "@token"))
  8398. continue;
  8399. if (doindent)
  8400. s.append('\n').appendN(attributeindent, ' ');
  8401. else if (count > 3)
  8402. doindent = true;
  8403. appendXMLAttr(s, attrs->queryName()+1, attrs->queryValue());
  8404. }
  8405. }
  8406. s.append('>');
  8407. return s;
  8408. }
  8409. IStringVal &CLocalWorkUnit::getXmlParams(IStringVal &str, bool hidePasswords) const
  8410. {
  8411. CriticalBlock block(crit);
  8412. IPropertyTree *paramTree = p->queryPropTree("Parameters");
  8413. if (!paramTree)
  8414. return str;
  8415. StringBuffer xml;
  8416. if (!hidePasswords)
  8417. toXML(paramTree, xml);
  8418. else
  8419. {
  8420. appendPTreeOpenTag(xml.append(' '), paramTree, "Parameters", 0, false).append('\n');
  8421. Owned<IPropertyTreeIterator> elems = paramTree->getElements("*");
  8422. ForEach(*elems)
  8423. {
  8424. const char *paramname = elems->query().queryName();
  8425. VStringBuffer xpath("Variables/Variable[@name='%s']/Format/@password", paramname);
  8426. if (p->getPropBool(xpath))
  8427. appendXMLTag(xml.append(" "), paramname, "***").append('\n');
  8428. else
  8429. toXML(&elems->query(), xml, 2);
  8430. }
  8431. appendXMLCloseTag(xml.append(' '), "Parameters").append('\n');
  8432. }
  8433. str.set(xml);
  8434. return str;
  8435. }
  8436. const IPropertyTree *CLocalWorkUnit::getXmlParams() const
  8437. {
  8438. CriticalBlock block(crit);
  8439. return p->getPropTree("Parameters");
  8440. }
  8441. void CLocalWorkUnit::setXmlParams(const char *params)
  8442. {
  8443. CriticalBlock block(crit);
  8444. p->setPropTree("Parameters", createPTreeFromXMLString(params));
  8445. }
  8446. void CLocalWorkUnit::setXmlParams(IPropertyTree *tree)
  8447. {
  8448. CriticalBlock block(crit);
  8449. p->setPropTree("Parameters", tree);
  8450. }
  8451. unsigned __int64 CLocalWorkUnit::getHash() const
  8452. {
  8453. CriticalBlock block(crit);
  8454. return p->getPropInt64("@hash");
  8455. }
  8456. void CLocalWorkUnit::setHash(unsigned __int64 hash)
  8457. {
  8458. CriticalBlock block(crit);
  8459. p->setPropInt64("@hash", hash);
  8460. }
  8461. // getGraphs / getGraphsMeta
  8462. // These are basically the same except for the amount of preloading they do, and the type of the iterator they return...
  8463. // If a type other than any is requested, a postfilter is needed.
  8464. template <class T, class U> class CFilteredGraphIteratorOf : public CInterfaceOf<T>
  8465. {
  8466. WUGraphType type;
  8467. Owned<T> base;
  8468. bool match()
  8469. {
  8470. return base->query().getType()==type;
  8471. }
  8472. public:
  8473. CFilteredGraphIteratorOf<T,U>(T *_base, WUGraphType _type)
  8474. : base(_base), type(_type)
  8475. {
  8476. }
  8477. bool first()
  8478. {
  8479. if (!base->first())
  8480. return false;
  8481. if (match())
  8482. return true;
  8483. return next();
  8484. }
  8485. bool next()
  8486. {
  8487. while (base->next())
  8488. if (match())
  8489. return true;
  8490. return false;
  8491. }
  8492. virtual bool isValid()
  8493. {
  8494. return base->isValid();
  8495. }
  8496. U & query()
  8497. {
  8498. return base->query();
  8499. }
  8500. };
  8501. IConstWUGraphMetaIterator& CLocalWorkUnit::getGraphsMeta(WUGraphType type) const
  8502. {
  8503. /* NB: this method should be 'cheap', loadGraphs() creates IConstWUGraph interfaces to the graphs
  8504. * it does not actually pull the graph data. We only use IConstWUGraphMeta here, which never probes the xgmml.
  8505. */
  8506. CriticalBlock block(crit);
  8507. loadGraphs(false);
  8508. IConstWUGraphMetaIterator *giter = new CArrayIteratorOf<IConstWUGraph,IConstWUGraphMetaIterator> (graphs, 0, (IConstWorkUnit *) this);
  8509. if (type!=GraphTypeAny)
  8510. giter = new CFilteredGraphIteratorOf<IConstWUGraphMetaIterator, IConstWUGraphMeta>(giter,type);
  8511. return *giter;
  8512. }
  8513. IConstWUGraphIterator& CLocalWorkUnit::getGraphs(WUGraphType type) const
  8514. {
  8515. CriticalBlock block(crit);
  8516. loadGraphs(true);
  8517. IConstWUGraphIterator *giter = new CArrayIteratorOf<IConstWUGraph,IConstWUGraphIterator> (graphs, 0, (IConstWorkUnit *) this);
  8518. if (type!=GraphTypeAny)
  8519. giter = new CFilteredGraphIteratorOf<IConstWUGraphIterator, IConstWUGraph>(giter, type);
  8520. return *giter;
  8521. }
  8522. IConstWUGraph* CLocalWorkUnit::getGraph(const char *qname) const
  8523. {
  8524. CriticalBlock block(crit);
  8525. VStringBuffer xpath("Graphs/Graph[@name='%s']", qname);
  8526. // NOTE - this would go wrong if we had other graphs of same name but different type. Ignore for now.
  8527. IPTree *graph = p->queryPropTree(xpath);
  8528. if (graph)
  8529. return new CLocalWUGraph(*this, LINK(graph));
  8530. return NULL;
  8531. }
  8532. void CLocalWorkUnit::createGraph(const char * name, const char *label, WUGraphType type, IPropertyTree *xgmml, unsigned wfid)
  8533. {
  8534. CriticalBlock block(crit);
  8535. if (!graphs.length())
  8536. p->addPropTree("Graphs");
  8537. IPropertyTree *r = p->queryPropTree("Graphs");
  8538. IPropertyTree *s = r->addPropTree("Graph");
  8539. CLocalWUGraph *q = new CLocalWUGraph(*this, LINK(s));
  8540. q->setName(name);
  8541. q->setLabel(label);
  8542. q->setType(type);
  8543. q->setWfid(wfid);
  8544. q->setXGMMLTree(xgmml);
  8545. graphs.append(*q);
  8546. }
  8547. IConstWUGraphProgress *CLocalWorkUnit::getGraphProgress(const char *name) const
  8548. {
  8549. /* Owned<IRemoteConnection> conn = getProgressConnection();
  8550. if (conn)
  8551. {
  8552. IPTree *progress = conn->queryRoot()->queryPropTree(graphName);
  8553. if (progress)
  8554. return new CConstGraphProgress(p->queryName(), graphName, progress);
  8555. }
  8556. */
  8557. return NULL;
  8558. }
  8559. WUGraphState CLocalWorkUnit::queryGraphState(const char *graphName) const
  8560. {
  8561. throwUnexpected(); // Should only be used for persisted workunits
  8562. }
  8563. WUGraphState CLocalWorkUnit::queryNodeState(const char *graphName, WUGraphIDType nodeId) const
  8564. {
  8565. throwUnexpected(); // Should only be used for persisted workunits
  8566. }
  8567. void CLocalWorkUnit::setGraphState(const char *graphName, WUGraphState state) const
  8568. {
  8569. throwUnexpected(); // Should only be used for persisted workunits
  8570. }
  8571. void CLocalWorkUnit::setNodeState(const char *graphName, WUGraphIDType nodeId, WUGraphState state) const
  8572. {
  8573. throwUnexpected(); // Should only be used for persisted workunits
  8574. }
  8575. IWUGraphStats *CLocalWorkUnit::updateStats(const char *graphName, StatisticCreatorType creatorType, const char * creator, unsigned _wfid, unsigned subgraph) const
  8576. {
  8577. return new CWuGraphStats(LINK(p), creatorType, creator, _wfid, graphName, subgraph);
  8578. }
  8579. void CLocalWUGraph::setName(const char *str)
  8580. {
  8581. p->setProp("@name", str);
  8582. }
  8583. void CLocalWUGraph::setLabel(const char *str)
  8584. {
  8585. p->setProp("@label", str);
  8586. }
  8587. void CLocalWUGraph::setWfid(unsigned wfid)
  8588. {
  8589. p->setPropInt("@wfid", wfid);
  8590. }
  8591. void CLocalWUGraph::setXGMML(const char *str)
  8592. {
  8593. setXGMMLTree(createPTreeFromXMLString(str,ipt_lowmem));
  8594. }
  8595. void CLocalWUGraph::setXGMMLTree(IPropertyTree *_graph)
  8596. {
  8597. assertex(strcmp(_graph->queryName(), "graph")==0);
  8598. IPropertyTree *xgmml = p->setPropTree("xgmml");
  8599. MemoryBuffer mb;
  8600. _graph->serialize(mb);
  8601. // Note - we could compress further but that would introduce compatibility concerns, so don't bother
  8602. // Cassandra workunit code actually lzw compresses the parent anyway
  8603. xgmml->setPropBin("graphBin", mb.length(), mb.toByteArray());
  8604. graph.setown(_graph);
  8605. }
  8606. static void expandAttributes(IPropertyTree & targetNode, IPropertyTree & progressNode)
  8607. {
  8608. Owned<IAttributeIterator> aIter = progressNode.getAttributes();
  8609. ForEach (*aIter)
  8610. {
  8611. const char *aName = aIter->queryName()+1;
  8612. if (0 != stricmp("id", aName)) // "id" reserved.
  8613. {
  8614. IPropertyTree *att = targetNode.addPropTree("att");
  8615. att->setProp("@name", aName);
  8616. att->setProp("@value", aIter->queryValue());
  8617. }
  8618. }
  8619. }
  8620. void CLocalWUGraph::mergeProgress(IPropertyTree &rootNode, IPropertyTree &progressTree, const unsigned &progressV) const
  8621. {
  8622. IPropertyTree *graphNode = rootNode.queryPropTree("att/graph");
  8623. if (!graphNode) return;
  8624. unsigned nodeId = rootNode.getPropInt("@id");
  8625. StringBuffer progressNodePath("node[@id=\"");
  8626. progressNodePath.append(nodeId).append("\"]");
  8627. IPropertyTree *progressNode = progressTree.queryPropTree(progressNodePath.str());
  8628. if (progressNode)
  8629. {
  8630. expandAttributes(*graphNode, *progressNode);
  8631. Owned<IPropertyTreeIterator> edges = progressNode->getElements("edge");
  8632. ForEach (*edges)
  8633. {
  8634. IPropertyTree &edge = edges->query();
  8635. StringBuffer edgePath("edge[@id=\"");
  8636. edgePath.append(edge.queryProp("@id")).append("\"]");
  8637. IPropertyTree *graphEdge = graphNode->queryPropTree(edgePath.str());
  8638. if (graphEdge)
  8639. {
  8640. if (progressV < 1)
  8641. mergePTree(graphEdge, &edge);
  8642. else
  8643. { // must translate to XGMML format
  8644. expandAttributes(*graphEdge, edge);
  8645. // 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)
  8646. Owned<IPropertyTreeIterator> iter = edge.getElements("*");
  8647. ForEach (*iter)
  8648. {
  8649. IPropertyTree &t = iter->query();
  8650. IPropertyTree *att = graphEdge->addPropTree("att");
  8651. att->setProp("@name", t.queryName());
  8652. att->setProp("@value", t.queryProp(NULL));
  8653. }
  8654. }
  8655. }
  8656. }
  8657. Owned<IPropertyTreeIterator> nodes = progressNode->getElements("node");
  8658. ForEach (*nodes)
  8659. {
  8660. IPropertyTree &node = nodes->query();
  8661. StringBuffer nodePath("node[@id=\"");
  8662. nodePath.append(node.queryProp("@id")).append("\"]");
  8663. IPropertyTree *_node = graphNode->queryPropTree(nodePath.str());
  8664. if (_node)
  8665. {
  8666. if (progressV < 1)
  8667. mergePTree(_node, &node);
  8668. else
  8669. { // must translate to XGMML format
  8670. expandAttributes(*_node, node);
  8671. }
  8672. }
  8673. }
  8674. }
  8675. Owned<IPropertyTreeIterator> iter = graphNode->getElements("node");
  8676. ForEach (*iter)
  8677. mergeProgress(iter->query(), progressTree, progressV);
  8678. }
  8679. IPropertyTree * CLocalWUGraph::getXGMMLTreeRaw() const
  8680. {
  8681. return p->getPropTree("xgmml");
  8682. }
  8683. IPropertyTree * CLocalWUGraph::getXGMMLTree(bool doMergeProgress) const
  8684. {
  8685. if (!graph)
  8686. {
  8687. // NB: although graphBin introduced in wuidVersion==2,
  8688. // daliadmin can retrospectively compress existing graphs, so need to check for all versions
  8689. MemoryBuffer mb;
  8690. if (p->getPropBin("xgmml/graphBin", mb))
  8691. graph.setown(createPTree(mb, ipt_lowmem));
  8692. else
  8693. graph.setown(p->getBranch("xgmml/graph"));
  8694. if (!graph)
  8695. return NULL;
  8696. }
  8697. if (!doMergeProgress)
  8698. return graph.getLink();
  8699. else
  8700. {
  8701. Owned<IPropertyTree> copy = createPTreeFromIPT(graph, ipt_lowmem);
  8702. Owned<IConstWUGraphProgress> progress = owner.getGraphProgress(p->queryProp("@name"));
  8703. if (progress)
  8704. {
  8705. //MORE: Eventually this should directly access the new stats structure
  8706. unsigned progressV = progress->queryFormatVersion();
  8707. Owned<IPropertyTree> progressTree = progress->getProgressTree();
  8708. Owned<IPropertyTreeIterator> nodeIterator = copy->getElements("node");
  8709. ForEach (*nodeIterator)
  8710. mergeProgress(nodeIterator->query(), *progressTree, progressV);
  8711. }
  8712. return copy.getClear();
  8713. }
  8714. }
  8715. WUGraphType CLocalWUGraph::getType() const
  8716. {
  8717. return (WUGraphType) getEnum(p, "@type", graphTypes);
  8718. }
  8719. IStringVal & CLocalWUGraph::getTypeName(IStringVal &str) const
  8720. {
  8721. str.set(p->queryProp("@type"));
  8722. if (!str.length())
  8723. str.set("unknown");
  8724. return str;
  8725. }
  8726. unsigned CLocalWUGraph::getWfid() const
  8727. {
  8728. return p->getPropInt("@wfid", 0);
  8729. }
  8730. void CLocalWUGraph::setType(WUGraphType _type)
  8731. {
  8732. setEnum(p, "@type", _type, graphTypes);
  8733. }
  8734. //=================================================================================================
  8735. EnumMapping queryFileTypes[] = {
  8736. { FileTypeCpp, "cpp" },
  8737. { FileTypeDll, "dll" },
  8738. { FileTypeResText, "res" },
  8739. { FileTypeHintXml, "hint" },
  8740. { FileTypeXml, "xml" },
  8741. { FileTypeSize, NULL },
  8742. };
  8743. CLocalWUAssociated::CLocalWUAssociated(IPropertyTree *props) : p(props)
  8744. {
  8745. }
  8746. WUFileType CLocalWUAssociated::getType() const
  8747. {
  8748. return (WUFileType)getEnum(p, "@type", queryFileTypes);
  8749. }
  8750. IStringVal & CLocalWUAssociated::getDescription(IStringVal & str) const
  8751. {
  8752. str.set(p->queryProp("@desc"));
  8753. return str;
  8754. }
  8755. IStringVal & CLocalWUAssociated::getIp(IStringVal & str) const
  8756. {
  8757. str.set(p->queryProp("@ip"));
  8758. return str;
  8759. }
  8760. IStringVal & CLocalWUAssociated::getName(IStringVal & str) const
  8761. {
  8762. str.set(p->queryProp("@filename"));
  8763. return str;
  8764. }
  8765. IStringVal & CLocalWUAssociated::getNameTail(IStringVal & str) const
  8766. {
  8767. str.set(pathTail(p->queryProp("@filename")));
  8768. return str;
  8769. }
  8770. unsigned CLocalWUAssociated::getCrc() const
  8771. {
  8772. return p->getPropInt("@crc", 0);
  8773. }
  8774. unsigned CLocalWUAssociated::getMinActivityId() const
  8775. {
  8776. return p->getPropInt("@minActivity", 0);
  8777. }
  8778. unsigned CLocalWUAssociated::getMaxActivityId() const
  8779. {
  8780. return p->getPropInt("@maxActivity", 0);
  8781. }
  8782. //=================================================================================================
  8783. CLocalWUQuery::CLocalWUQuery(IPropertyTree *props) : p(props)
  8784. {
  8785. associatedCached = false;
  8786. }
  8787. EnumMapping queryTypes[] = {
  8788. { QueryTypeUnknown, "unknown" },
  8789. { QueryTypeEcl, "ECL" },
  8790. { QueryTypeSql, "SQL" },
  8791. { QueryTypeXml, "XML" },
  8792. { QueryTypeAttribute, "Attribute" },
  8793. { QueryTypeSize, NULL },
  8794. };
  8795. WUQueryType CLocalWUQuery::getQueryType() const
  8796. {
  8797. return (WUQueryType) getEnum(p, "@type", queryTypes);
  8798. }
  8799. void CLocalWUQuery::setQueryType(WUQueryType qt)
  8800. {
  8801. setEnum(p, "@type", qt, queryTypes);
  8802. }
  8803. IStringVal& CLocalWUQuery::getQueryText(IStringVal &str) const
  8804. {
  8805. const char *text = p->queryProp("Text");
  8806. if (!text)
  8807. text = p->queryProp("ShortText");
  8808. str.set(text);
  8809. return str;
  8810. }
  8811. IStringVal& CLocalWUQuery::getQueryShortText(IStringVal &str) const
  8812. {
  8813. const char * text = p->queryProp("ShortText");
  8814. if (text)
  8815. str.set(text);
  8816. else
  8817. {
  8818. text = p->queryProp("Text");
  8819. if (isArchiveQuery(text))
  8820. {
  8821. Owned<IPropertyTree> xml = createPTreeFromXMLString(text, ipt_caseInsensitive|ipt_lowmem);
  8822. const char * path = xml->queryProp("Query/@attributePath");
  8823. if (path)
  8824. {
  8825. IPropertyTree * resolved = resolveDefinitionInArchive(xml, path);
  8826. if (resolved)
  8827. str.set(resolved->queryProp(NULL));
  8828. }
  8829. else
  8830. str.set(xml->queryProp("Query"));
  8831. }
  8832. else
  8833. str.set(text);
  8834. }
  8835. return str;
  8836. }
  8837. bool CLocalWUQuery::isArchive() const
  8838. {
  8839. if (p->hasProp("@isArchive"))
  8840. return p->getPropBool("@isArchive");
  8841. const char *text = p->queryProp("Text");
  8842. return isArchiveQuery(text);
  8843. }
  8844. IStringVal& CLocalWUQuery::getQueryName(IStringVal &str) const
  8845. {
  8846. str.set(p->queryProp("@name"));
  8847. return str;
  8848. }
  8849. IStringVal & CLocalWUQuery::getQueryMainDefinition(IStringVal & str) const
  8850. {
  8851. str.set(p->queryProp("@main"));
  8852. return str;
  8853. }
  8854. IStringVal& CLocalWUQuery::getQueryDllName(IStringVal &str) const
  8855. {
  8856. Owned<IConstWUAssociatedFile> entry = getAssociatedFile(FileTypeDll, 0);
  8857. if (entry)
  8858. entry->getNameTail(str);
  8859. return str;
  8860. }
  8861. IStringVal& CLocalWUQuery::getQueryCppName(IStringVal &str) const
  8862. {
  8863. Owned<IConstWUAssociatedFile> entry = getAssociatedFile(FileTypeCpp, 0);
  8864. if (entry)
  8865. entry->getName(str);
  8866. return str;
  8867. }
  8868. IStringVal& CLocalWUQuery::getQueryResTxtName(IStringVal &str) const
  8869. {
  8870. Owned<IConstWUAssociatedFile> entry = getAssociatedFile(FileTypeResText, 0);
  8871. if (entry)
  8872. entry->getName(str);
  8873. return str;
  8874. }
  8875. unsigned CLocalWUQuery::getQueryDllCrc() const
  8876. {
  8877. Owned<IConstWUAssociatedFile> entry = getAssociatedFile(FileTypeDll, 0);
  8878. if (entry)
  8879. return entry->getCrc();
  8880. return 0;
  8881. }
  8882. void CLocalWUQuery::setQueryText(const char *text)
  8883. {
  8884. bool isArchive = isArchiveQuery(text);
  8885. if (isArchive)
  8886. {
  8887. p->setProp("Text", text);
  8888. Owned<IPropertyTree> xml = createPTreeFromXMLString(text, ipt_caseInsensitive|ipt_lowmem);
  8889. const char * path = xml->queryProp("Query/@attributePath");
  8890. if (path)
  8891. {
  8892. IPropertyTree * resolved = resolveDefinitionInArchive(xml, path);
  8893. if (resolved)
  8894. p->setProp("ShortText", resolved->queryProp(NULL));
  8895. }
  8896. else
  8897. p->setProp("ShortText", xml->queryProp("Query"));
  8898. }
  8899. else
  8900. {
  8901. p->setProp("Text", text); // At some point in the future we may be able to remove this,
  8902. // but as long as there may be new workunits compiled by old systems, we can't
  8903. p->setProp("ShortText", text);
  8904. }
  8905. p->setPropBool("@isArchive", isArchive);
  8906. if (isArchive)
  8907. p->setPropBool("@hasArchive", true); //preserved if setQueryText is called multiple times. Should setting this be more explicit?
  8908. }
  8909. void CLocalWUQuery::setQueryName(const char *qname)
  8910. {
  8911. p->setProp("@name", qname);
  8912. }
  8913. void CLocalWUQuery::setQueryMainDefinition(const char * str)
  8914. {
  8915. p->setProp("@main", str);
  8916. }
  8917. void CLocalWUQuery::addAssociatedFile(WUFileType type, const char * name, const char * ip, const char * desc, unsigned crc, unsigned minActivity, unsigned maxActivity)
  8918. {
  8919. CriticalBlock block(crit);
  8920. loadAssociated();
  8921. StringBuffer xpath;
  8922. xpath.append("Associated/File[@filename=\"").append(name).append("\"]");
  8923. if (p->hasProp(xpath))
  8924. return;
  8925. if (!associated.length())
  8926. p->addPropTree("Associated");
  8927. IPropertyTree *pl = p->queryPropTree("Associated");
  8928. IPropertyTree *s = pl->addPropTree("File");
  8929. setEnum(s, "@type", type, queryFileTypes);
  8930. s->setProp("@filename", name);
  8931. s->setProp("@ip", ip);
  8932. s->setProp("@desc", desc);
  8933. if (crc)
  8934. s->setPropInt("@crc", crc);
  8935. if (minActivity)
  8936. s->setPropInt("@minActivity", minActivity);
  8937. if (maxActivity)
  8938. s->setPropInt("@maxActivity", maxActivity);
  8939. IConstWUAssociatedFile * q = new CLocalWUAssociated(LINK(s));
  8940. associated.append(*q);
  8941. }
  8942. void CLocalWUQuery::removeAssociatedFile(WUFileType type, const char * name, const char * desc)
  8943. {
  8944. CriticalBlock block(crit);
  8945. associatedCached = false;
  8946. associated.kill();
  8947. StringBuffer xpath;
  8948. xpath.append("Associated/File");
  8949. if (type)
  8950. xpath.append("[@type=\"").append(getEnumText(type, queryFileTypes)).append("\"]");
  8951. if (name)
  8952. xpath.append("[@filename=\"").append(name).append("\"]");
  8953. if (desc)
  8954. xpath.append("[@desc=\"").append(desc).append("\"]");
  8955. p->removeProp(xpath.str());
  8956. }
  8957. void CLocalWUQuery::removeAssociatedFiles()
  8958. {
  8959. associatedCached = false;
  8960. associated.kill();
  8961. p->removeProp("Associated");
  8962. }
  8963. IConstWUAssociatedFile * CLocalWUQuery::getAssociatedFile(WUFileType type, unsigned index) const
  8964. {
  8965. CriticalBlock block(crit);
  8966. loadAssociated();
  8967. ForEachItemIn(idx, associated)
  8968. {
  8969. CLocalWUAssociated &cur = static_cast<CLocalWUAssociated &>(associated.item(idx));
  8970. if (cur.getType() == type)
  8971. {
  8972. if (index-- == 0)
  8973. return &OLINK(cur);
  8974. }
  8975. }
  8976. return NULL;
  8977. }
  8978. void CLocalWUQuery::addSpecialCaseAssociated(WUFileType type, const char * propname, unsigned crc) const
  8979. {
  8980. const char * name = p->queryProp(propname);
  8981. if (name)
  8982. {
  8983. IPropertyTree *s = createPTree("File");
  8984. setEnum(s, "@type", type, queryFileTypes);
  8985. s->setProp("@filename", name);
  8986. if (crc)
  8987. s->setPropInt("@crc", crc);
  8988. associated.append(*new CLocalWUAssociated(s));
  8989. }
  8990. }
  8991. void CLocalWUQuery::loadAssociated() const
  8992. {
  8993. CriticalBlock block(crit);
  8994. if (!associatedCached)
  8995. {
  8996. assertex(associated.length() == 0);
  8997. addSpecialCaseAssociated(FileTypeDll, "DllName", p->getPropInt("DllCrc", 0));
  8998. addSpecialCaseAssociated(FileTypeCpp, "CppName", 0);
  8999. addSpecialCaseAssociated(FileTypeResText, "ResTxtName", 0);
  9000. Owned<IPropertyTreeIterator> r = p->getElements("Associated/File");
  9001. for (r->first(); r->isValid(); r->next())
  9002. {
  9003. IPropertyTree *rp = &r->query();
  9004. rp->Link();
  9005. associated.append(*new CLocalWUAssociated(rp));
  9006. }
  9007. associatedCached = true;
  9008. }
  9009. }
  9010. IConstWUAssociatedFileIterator& CLocalWUQuery::getAssociatedFiles() const
  9011. {
  9012. CriticalBlock block(crit);
  9013. loadAssociated();
  9014. return *new CArrayIteratorOf<IConstWUAssociatedFile,IConstWUAssociatedFileIterator> (associated, 0, (IConstWUQuery *) this);
  9015. }
  9016. //========================================================================================
  9017. CLocalWUWebServicesInfo::CLocalWUWebServicesInfo(IPropertyTree *props) : p(props)
  9018. {
  9019. }
  9020. IStringVal& CLocalWUWebServicesInfo::getModuleName(IStringVal &str) const
  9021. {
  9022. str.set(p->queryProp("@module"));
  9023. return str;
  9024. }
  9025. IStringVal& CLocalWUWebServicesInfo::getAttributeName(IStringVal &str) const
  9026. {
  9027. str.set(p->queryProp("@attribute"));
  9028. return str;
  9029. }
  9030. IStringVal& CLocalWUWebServicesInfo::getDefaultName(IStringVal &str) const
  9031. {
  9032. str.set(p->queryProp("@defaultName"));
  9033. return str;
  9034. }
  9035. unsigned CLocalWUWebServicesInfo::getWebServicesCRC() const
  9036. {
  9037. return (unsigned) p->getPropInt("@crc");
  9038. }
  9039. IStringVal& CLocalWUWebServicesInfo::getInfo(const char *name, IStringVal &str) const
  9040. {
  9041. if (!name)
  9042. {
  9043. StringBuffer ws_info;
  9044. ws_info.appendf("<%s ", p->queryName());
  9045. Owned<IAttributeIterator> attrs = p->getAttributes();
  9046. for(attrs->first(); attrs->isValid(); attrs->next())
  9047. {
  9048. const char *name = attrs->queryName()+1;
  9049. const char *value = attrs->queryValue();
  9050. ws_info.appendf("%s='%s' ", name, value);
  9051. }
  9052. ws_info.append("> \n");
  9053. Owned<IPropertyTreeIterator> info = p->getElements("*");
  9054. ForEach(*info)
  9055. {
  9056. IPropertyTree &item = info->query();
  9057. const char *name = item.queryName();
  9058. if (name)
  9059. {
  9060. MemoryBuffer mb;
  9061. bool isbin = p->isBinary(name);
  9062. if (isbin)
  9063. {
  9064. p->getPropBin(name,mb);
  9065. if (mb.length())
  9066. {
  9067. unsigned len = 0;
  9068. mb.read(len);
  9069. StringBuffer encodedString;
  9070. StringBuffer val(len, (const char *) mb.readDirect(len));
  9071. encodeXML(val, encodedString);
  9072. ws_info.appendf("<%s>%s</%s>", name, encodedString.str(), name);
  9073. }
  9074. }
  9075. else
  9076. {
  9077. StringBuffer tmp;
  9078. toXML(&item, tmp);
  9079. ws_info.append(tmp.str());
  9080. }
  9081. }
  9082. }
  9083. ws_info.appendf("</%s>", p->queryName());
  9084. str.setLen(ws_info.str(), ws_info.length());
  9085. }
  9086. else
  9087. {
  9088. MemoryBuffer mb;
  9089. p->getPropBin(name,mb);
  9090. if (mb.length())
  9091. {
  9092. unsigned len;
  9093. mb.read(len);
  9094. str.setLen((const char *) mb.readDirect(len), len);
  9095. }
  9096. }
  9097. return str;
  9098. }
  9099. IStringVal& CLocalWUWebServicesInfo::getText(const char *name, IStringVal &str) const
  9100. {
  9101. str.set(p->queryProp(name));
  9102. return str;
  9103. }
  9104. void CLocalWUWebServicesInfo::setModuleName(const char *mname)
  9105. {
  9106. p->setProp("@module", mname);
  9107. }
  9108. void CLocalWUWebServicesInfo::setAttributeName(const char *aname)
  9109. {
  9110. p->setProp("@attribute", aname);
  9111. }
  9112. void CLocalWUWebServicesInfo::setDefaultName(const char *dname)
  9113. {
  9114. p->setProp("@defaultName", dname);
  9115. }
  9116. void CLocalWUWebServicesInfo::setWebServicesCRC(unsigned crc)
  9117. {
  9118. p->setPropInt("@crc", crc);
  9119. }
  9120. void CLocalWUWebServicesInfo::setInfo(const char *name, const char *info)
  9121. {
  9122. MemoryBuffer m;
  9123. unsigned len = (size32_t)strlen(info);
  9124. serializeLPString(len, info, m);
  9125. p->setPropBin(name, m.length(), m.toByteArray());
  9126. }
  9127. void CLocalWUWebServicesInfo::setText(const char *name, const char *info)
  9128. {
  9129. p->setProp(name, info);
  9130. }
  9131. //========================================================================================
  9132. CLocalWUResult::CLocalWUResult(IPropertyTree *props) : p(props)
  9133. {
  9134. }
  9135. EnumMapping resultStatuses[] = {
  9136. { ResultStatusUndefined, "undefined" },
  9137. { ResultStatusCalculated, "calculated" },
  9138. { ResultStatusSupplied, "supplied" },
  9139. { ResultStatusFailed, "failed" },
  9140. { ResultStatusPartial, "partial" },
  9141. { ResultStatusSize, NULL }
  9142. };
  9143. WUResultStatus CLocalWUResult::getResultStatus() const
  9144. {
  9145. return (WUResultStatus ) getEnum(p, "@status", resultStatuses);
  9146. }
  9147. IStringVal& CLocalWUResult::getResultName(IStringVal &str) const
  9148. {
  9149. str.set(p->queryProp("@name"));
  9150. return str;
  9151. }
  9152. int CLocalWUResult::getResultSequence() const
  9153. {
  9154. return p->getPropInt("@sequence", -1);
  9155. }
  9156. bool CLocalWUResult::isResultScalar() const
  9157. {
  9158. return p->getPropInt("@isScalar", 1) != 0;
  9159. }
  9160. bool findSize(int size, IntArray &sizes)
  9161. {
  9162. ForEachItemIn(idx, sizes)
  9163. {
  9164. if (sizes.item(idx)==size)
  9165. return true;
  9166. }
  9167. return false;
  9168. }
  9169. void CLocalWUResult::getSchema(IArrayOf<ITypeInfo> &types, StringAttrArray &names, IStringVal * eclText) const
  9170. {
  9171. MemoryBuffer schema;
  9172. p->getPropBin("SchemaRaw", schema);
  9173. if (schema.length())
  9174. {
  9175. for (;;)
  9176. {
  9177. StringAttr name;
  9178. schema.read(name);
  9179. if (*schema.readDirect(0)==type_void)
  9180. break;
  9181. names.append(*new StringAttrItem(name));
  9182. types.append(*deserializeType(schema)); // MORE - nested records!
  9183. }
  9184. schema.skip(1);
  9185. if (schema.length() != schema.getPos())
  9186. {
  9187. unsigned eclLen;
  9188. schema.read(eclLen);
  9189. const char * schemaData = (const char *)schema.readDirect(eclLen);
  9190. if (eclText)
  9191. {
  9192. eclText->setLen(schemaData, eclLen);
  9193. if ((eclLen == 0) && names.ordinality())
  9194. {
  9195. const char * firstName = names.item(0).text;
  9196. StringBuffer temp;
  9197. temp.append("RECORD ");
  9198. types.item(0).getECLType(temp);
  9199. temp.append(" value{NAMED('").append(firstName).append("')}").append("; END;");
  9200. eclText->set(temp.str());
  9201. }
  9202. }
  9203. }
  9204. }
  9205. }
  9206. void readRow(StringBuffer &out, MemoryBuffer &in, TypeInfoArray &types, StringAttrArray &names)
  9207. {
  9208. ForEachItemIn(idx, types)
  9209. {
  9210. StringAttrItem &name = names.item(idx);
  9211. ITypeInfo &type = types.item(idx);
  9212. unsigned size = type.getSize();
  9213. switch(type.getTypeCode())
  9214. {
  9215. case type_data:
  9216. if (size==UNKNOWN_LENGTH)
  9217. {
  9218. if (in.remaining() < sizeof(int))
  9219. throw MakeStringException(WUERR_CorruptResult, "corrupt workunit information");
  9220. in.read(size);
  9221. }
  9222. outputXmlData(size, in.readDirect(size), name.text, out);
  9223. break;
  9224. case type_string:
  9225. if (size==UNKNOWN_LENGTH)
  9226. {
  9227. if (in.remaining() < sizeof(int))
  9228. throw MakeStringException(WUERR_CorruptResult, "corrupt workunit information");
  9229. in.read(size);
  9230. }
  9231. outputXmlString(size, (const char *) in.readDirect(size), name.text, out);
  9232. break;
  9233. case type_varstring:
  9234. {
  9235. if (size == UNKNOWN_LENGTH)
  9236. size = (size32_t)strlen((const char *) in.readDirect(0))+1;
  9237. const char * text = (const char *) in.readDirect(size);
  9238. outputXmlString((size32_t)strlen(text), text, name.text, out);
  9239. break;
  9240. }
  9241. case type_unicode:
  9242. {
  9243. unsigned len = type.getStringLen();
  9244. if (size==UNKNOWN_LENGTH)
  9245. in.read(len);
  9246. outputXmlUnicode(len, (UChar const *) in.readDirect(len*2), name.text, out);
  9247. }
  9248. break;
  9249. case type_utf8:
  9250. {
  9251. unsigned len = type.getStringLen();
  9252. if (size==UNKNOWN_LENGTH)
  9253. {
  9254. in.read(len);
  9255. size = rtlUtf8Size(len, in.readDirect(0));
  9256. }
  9257. outputXmlUtf8(len, (const char *) in.readDirect(size), name.text, out);
  9258. }
  9259. break;
  9260. case type_qstring:
  9261. {
  9262. unsigned len = type.getStringLen();
  9263. if (size==UNKNOWN_LENGTH)
  9264. in.read(len);
  9265. unsigned outlen;
  9266. char *outstr;
  9267. rtlQStrToStrX(outlen, outstr, len, (const char *) in.readDirect(rtlQStrSize(len)));
  9268. outputXmlString(outlen, outstr, name.text, out);
  9269. free(outstr);
  9270. break;
  9271. }
  9272. case type_int:
  9273. case type_swapint:
  9274. if (type.isSigned())
  9275. {
  9276. const unsigned char *raw = (const unsigned char *) in.readDirect(size);
  9277. unsigned __int64 cval8 = 0;
  9278. //MORE: I think this is wrong - swapped doesn't mean little/big/
  9279. if (type.isSwappedEndian())
  9280. {
  9281. unsigned idx = 0;
  9282. if (raw[idx] & 0x80)
  9283. cval8 = (__int64)-1;
  9284. while (size--)
  9285. cval8 = (cval8 << 8) | raw[idx++];
  9286. }
  9287. else
  9288. {
  9289. if (raw[size-1] & 0x80)
  9290. cval8 = (__int64)-1;
  9291. while (size--)
  9292. cval8 = (cval8 << 8) | raw[size];
  9293. }
  9294. outputXmlInt((__int64) cval8, name.text, out);
  9295. }
  9296. else
  9297. {
  9298. const unsigned char *raw = (const unsigned char *) in.readDirect(size);
  9299. unsigned __int64 cval8 = 0;
  9300. if (type.isSwappedEndian())
  9301. {
  9302. unsigned idx = 0;
  9303. while (size--)
  9304. cval8 = (cval8 << 8) | raw[idx++];
  9305. }
  9306. else
  9307. {
  9308. while (size--)
  9309. cval8 = (cval8 << 8) | raw[size];
  9310. }
  9311. outputXmlUInt(cval8, name.text, out);
  9312. }
  9313. break;
  9314. case type_boolean:
  9315. bool cvalb;
  9316. in.read(cvalb);
  9317. outputXmlBool(cvalb, name.text, out);
  9318. break;
  9319. case type_decimal:
  9320. if (type.isSigned())
  9321. outputXmlDecimal(in.readDirect(size), size, type.getPrecision(), name.text, out);
  9322. else
  9323. outputXmlUDecimal(in.readDirect(size), size, type.getPrecision(), name.text, out);
  9324. break;
  9325. case type_real:
  9326. double cvald;
  9327. switch(size)
  9328. {
  9329. case 4:
  9330. float cvalf;
  9331. in.read(cvalf);
  9332. cvald = cvalf;
  9333. break;
  9334. case 8:
  9335. in.read(cvald);
  9336. break;
  9337. }
  9338. outputXmlReal(cvald, name.text, out);
  9339. break;
  9340. default:
  9341. assertex(!"unexpected type in raw record");
  9342. break;
  9343. }
  9344. }
  9345. }
  9346. IStringVal& CLocalWUResult::getResultXml(IStringVal &str, bool hidePassword) const
  9347. {
  9348. TypeInfoArray types;
  9349. StringAttrArray names;
  9350. getSchema(types, names);
  9351. StringBuffer xml;
  9352. const char * name = p->queryProp("@name");
  9353. if (name)
  9354. xml.appendf("<Dataset name=\'%s\'>\n", name);
  9355. else
  9356. xml.append("<Dataset>\n");
  9357. if (hidePassword && p->getPropBool("Format/@password"))
  9358. {
  9359. xml.append(" <Row>");
  9360. appendXMLTag(xml, name, "****");
  9361. xml.append("</Row>\n");
  9362. }
  9363. else if (p->hasProp("Value"))
  9364. {
  9365. MemoryBuffer raw;
  9366. p->getPropBin("Value", raw);
  9367. unsigned __int64 numrows = getResultRowCount();
  9368. while (numrows--)
  9369. {
  9370. xml.append(" <Row>");
  9371. readRow(xml, raw, types, names);
  9372. xml.append("</Row>\n");
  9373. }
  9374. }
  9375. else if (p->hasProp("xmlValue"))
  9376. {
  9377. xml.append(" <Row>");
  9378. appendXMLTag(xml, name, p->queryProp("xmlValue"));
  9379. xml.append("</Row>\n");
  9380. }
  9381. xml.append("</Dataset>\n");
  9382. str.set(xml.str());
  9383. return str;
  9384. }
  9385. IProperties *CLocalWUResult::queryResultXmlns()
  9386. {
  9387. CriticalBlock block(crit);
  9388. if (xmlns)
  9389. return xmlns;
  9390. xmlns.setown(createProperties());
  9391. Owned<IAttributeIterator> it = p->getAttributes();
  9392. unsigned prefixLen = strlen("@xmlns");
  9393. ForEach(*it)
  9394. {
  9395. const char *name = it->queryName();
  9396. if (!strncmp("@xmlns", name, prefixLen))
  9397. {
  9398. if (name[prefixLen]==':') //normal case
  9399. xmlns->setProp(name+prefixLen+1, it->queryValue());
  9400. else if (!name[prefixLen]) //special case, unprefixed namespace
  9401. xmlns->setProp("xmlns", it->queryValue());
  9402. }
  9403. }
  9404. return xmlns;
  9405. }
  9406. unsigned CLocalWUResult::getResultFetchSize() const
  9407. {
  9408. return p->getPropInt("fetchSize", 100);
  9409. }
  9410. __int64 CLocalWUResult::getResultTotalRowCount() const
  9411. {
  9412. return p->getPropInt64("totalRowCount", -1);
  9413. }
  9414. __int64 CLocalWUResult::getResultRowCount() const
  9415. {
  9416. return p->getPropInt64("rowCount", 0);
  9417. }
  9418. void CLocalWUResult::getResultDataset(IStringVal & ecl, IStringVal & defs) const
  9419. {
  9420. ecl.set(p->queryProp("datasetEcl"));
  9421. defs.set(p->queryProp("datasetEclDefs"));
  9422. }
  9423. IStringVal& CLocalWUResult::getResultLogicalName(IStringVal & val) const
  9424. {
  9425. val.set(p->queryProp("logicalName"));
  9426. return val;
  9427. }
  9428. IStringVal& CLocalWUResult::getResultKeyField(IStringVal & ecl) const
  9429. {
  9430. ecl.set(p->queryProp("keyField"));
  9431. return ecl;
  9432. }
  9433. unsigned CLocalWUResult::getResultRequestedRows() const
  9434. {
  9435. return p->getPropInt("requestedRows", 1);
  9436. }
  9437. IStringVal& CLocalWUResult::getResultEclSchema(IStringVal & str) const
  9438. {
  9439. TypeInfoArray types;
  9440. StringAttrArray names;
  9441. getSchema(types, names, &str);
  9442. return str;
  9443. }
  9444. IStringVal& CLocalWUResult::getResultRecordSizeEntry(IStringVal & str) const
  9445. {
  9446. str.set(p->queryProp("@recordSizeEntry"));
  9447. return str;
  9448. }
  9449. IStringVal& CLocalWUResult::getResultTransformerEntry(IStringVal & str) const
  9450. {
  9451. str.set(p->queryProp("@transformerEntry"));
  9452. return str;
  9453. }
  9454. __int64 CLocalWUResult::getResultRowLimit() const
  9455. {
  9456. return p->getPropInt64("@rowLimit");
  9457. }
  9458. IStringVal& CLocalWUResult::getResultFilename(IStringVal & str) const
  9459. {
  9460. str.set(p->queryProp("@tempFilename"));
  9461. return str;
  9462. }
  9463. IStringVal& CLocalWUResult::getResultFieldOpt(const char *name, IStringVal &str) const
  9464. {
  9465. str.clear();
  9466. if (!name || !*name)
  9467. return str;
  9468. IPropertyTree *format = p->queryPropTree("Format");
  9469. if (!format)
  9470. return str;
  9471. VStringBuffer xpath("@%s", name);
  9472. str.set(format->queryProp(xpath));
  9473. return str;
  9474. }
  9475. void CLocalWUResult::getResultWriteLocation(IStringVal & _graph, unsigned & _activityId) const
  9476. {
  9477. _graph.set(p->queryProp("@graph"));
  9478. _activityId = p->getPropInt("@activity", 0);
  9479. }
  9480. void CLocalWUResult::setResultStatus(WUResultStatus status)
  9481. {
  9482. setEnum(p, "@status", status, resultStatuses);
  9483. if (status==ResultStatusUndefined)
  9484. {
  9485. p->removeProp("Value");
  9486. p->removeProp("totalRowCount");
  9487. p->removeProp("rowCount");
  9488. p->removeProp("@format");
  9489. p->removeProp("@tempFileNmae");
  9490. p->removeProp("logicalName");
  9491. }
  9492. }
  9493. void CLocalWUResult::setResultName(const char *s)
  9494. {
  9495. p->setProp("@name", s);
  9496. }
  9497. void CLocalWUResult::setResultSequence(unsigned seq)
  9498. {
  9499. p->setPropInt("@sequence", seq);
  9500. }
  9501. void CLocalWUResult::setResultSchemaRaw(unsigned size, const void *schema)
  9502. {
  9503. p->setPropBin("SchemaRaw", size, schema);
  9504. }
  9505. void CLocalWUResult::setResultXmlns(const char *prefix, const char *uri)
  9506. {
  9507. StringBuffer xpath("@xmlns");
  9508. if (prefix && *prefix)
  9509. xpath.append(':').append(prefix);
  9510. p->setProp(xpath, uri);
  9511. }
  9512. void CLocalWUResult::setResultFieldOpt(const char *name, const char *value)
  9513. {
  9514. if (!name || !*name)
  9515. return;
  9516. IPropertyTree *format = ensurePTree(p, "Format");
  9517. VStringBuffer xpath("@%s", name);
  9518. format->setProp(xpath, value);
  9519. }
  9520. void CLocalWUResult::setResultWriteLocation(const char * _graph, unsigned _activityId)
  9521. {
  9522. p->setProp("@graph", _graph);
  9523. p->setPropInt("@activity", _activityId);
  9524. }
  9525. void CLocalWUResult::setResultScalar(bool isScalar)
  9526. {
  9527. p->setPropInt("@isScalar", (int) isScalar);
  9528. if (isScalar)
  9529. setResultTotalRowCount(1);
  9530. }
  9531. void CLocalWUResult::setResultRaw(unsigned len, const void *data, WUResultFormat format)
  9532. {
  9533. p->setPropBin("Value", len, data);
  9534. setResultStatus(ResultStatusSupplied);
  9535. setResultFormat(format);
  9536. }
  9537. void CLocalWUResult::setResultFormat(WUResultFormat format)
  9538. {
  9539. switch (format)
  9540. {
  9541. case ResultFormatXml:
  9542. p->setProp("@format","xml");
  9543. break;
  9544. case ResultFormatXmlSet:
  9545. p->setProp("@format","xmlSet");
  9546. break;
  9547. case ResultFormatCsv:
  9548. p->setProp("@format","csv");
  9549. break;
  9550. default:
  9551. p->removeProp("@format");
  9552. break;
  9553. }
  9554. }
  9555. void CLocalWUResult::setResultXML(const char *val)
  9556. {
  9557. p->setProp("xmlValue", val);
  9558. }
  9559. void CLocalWUResult::addResultRaw(unsigned len, const void *data, WUResultFormat format)
  9560. {
  9561. p->appendPropBin("Value", len, data);
  9562. setResultStatus(ResultStatusPartial);
  9563. const char *existingFormat = p->queryProp("@format");
  9564. const char *formatStr = NULL;
  9565. switch (format)
  9566. {
  9567. case ResultFormatXml:
  9568. formatStr = "xml";
  9569. break;
  9570. case ResultFormatXmlSet:
  9571. formatStr = "xmlSet";
  9572. break;
  9573. case ResultFormatCsv:
  9574. formatStr = "csv";
  9575. break;
  9576. default:
  9577. p->removeProp("@format");
  9578. break;
  9579. }
  9580. if (format)
  9581. {
  9582. if (existingFormat)
  9583. {
  9584. if (0 != stricmp(formatStr, existingFormat))
  9585. throw MakeStringException(WUERR_ResultFormatMismatch, "addResult format %s, does not match existing format %s", formatStr, existingFormat);
  9586. }
  9587. else
  9588. p->setProp("@format", formatStr);
  9589. }
  9590. }
  9591. void CLocalWUResult::setResultFetchSize(unsigned rows)
  9592. {
  9593. p->setPropInt("fetchSize", rows);
  9594. }
  9595. void CLocalWUResult::setResultTotalRowCount(__int64 rows)
  9596. {
  9597. p->setPropInt64("totalRowCount", rows);
  9598. }
  9599. void CLocalWUResult::setResultRowCount(__int64 rows)
  9600. {
  9601. p->setPropInt64("rowCount", rows);
  9602. }
  9603. void CLocalWUResult::setResultDataset(const char *ecl, const char *defs)
  9604. {
  9605. p->setProp("datasetEcl", ecl);
  9606. p->setProp("datasetEclDefs", defs);
  9607. }
  9608. void CLocalWUResult::setResultLogicalName(const char *logicalName)
  9609. {
  9610. p->setProp("logicalName", logicalName);
  9611. }
  9612. void CLocalWUResult::setResultKeyField(const char *ecl)
  9613. {
  9614. p->setProp("keyField", ecl);
  9615. }
  9616. void CLocalWUResult::setResultRequestedRows(unsigned rows)
  9617. {
  9618. p->setPropInt("requestedRows", rows);
  9619. }
  9620. void CLocalWUResult::setResultRecordSizeEntry(const char * entry)
  9621. {
  9622. p->setProp("@recordSizeEntry", entry);
  9623. }
  9624. void CLocalWUResult::setResultTransformerEntry(const char * entry)
  9625. {
  9626. p->setProp("@transformerEntry", entry);
  9627. }
  9628. void CLocalWUResult::setResultRowLimit(__int64 value)
  9629. {
  9630. p->setPropInt64("@rowLimit", value);
  9631. }
  9632. void CLocalWUResult::setResultFilename(const char * name)
  9633. {
  9634. p->setProp("@tempFilename", name);
  9635. }
  9636. // MORE - it's an undetected error if we call getResult... of a type that does not match schema
  9637. __int64 CLocalWUResult::getResultInt() const
  9638. {
  9639. __int64 result = 0;
  9640. MemoryBuffer s;
  9641. p->getPropBin("Value", s);
  9642. if (s.length())
  9643. s.read(result);
  9644. else
  9645. result = p->getPropInt64("xmlValue");
  9646. return result;
  9647. }
  9648. bool CLocalWUResult::getResultBool() const
  9649. {
  9650. bool result = false;
  9651. MemoryBuffer s;
  9652. p->getPropBin("Value", s);
  9653. if (s.length())
  9654. s.read(result);
  9655. else
  9656. result = p->getPropBool("xmlValue");
  9657. return result;
  9658. }
  9659. double CLocalWUResult::getResultReal() const
  9660. {
  9661. double result = 0;
  9662. MemoryBuffer s;
  9663. p->getPropBin("Value", s);
  9664. if (s.length())
  9665. s.read(result);
  9666. else
  9667. {
  9668. const char *xmlVal = p->queryProp("xmlValue");
  9669. if (xmlVal)
  9670. result = atof(xmlVal);
  9671. }
  9672. return result;
  9673. }
  9674. void CLocalWUResult::getResultDecimal(void * val, unsigned len, unsigned precision, bool isSigned) const
  9675. {
  9676. MemoryBuffer s;
  9677. p->getPropBin("Value", s);
  9678. if (s.length())
  9679. {
  9680. assertex(s.length() == len);
  9681. s.read(len, val);
  9682. }
  9683. else
  9684. {
  9685. const char *xmlVal = p->queryProp("xmlValue");
  9686. if (xmlVal)
  9687. {
  9688. Decimal d;
  9689. d.setString(strlen(xmlVal), xmlVal);
  9690. if (isSigned)
  9691. d.getDecimal(len, precision, val);
  9692. else
  9693. d.getUDecimal(len, precision, val);
  9694. }
  9695. else
  9696. memset(val, 0, len);
  9697. }
  9698. }
  9699. IStringVal& CLocalWUResult::getResultString(IStringVal & str, bool hidePassword) const
  9700. {
  9701. if (hidePassword && p->getPropBool("@password"))
  9702. {
  9703. str.set("****");
  9704. return str;
  9705. }
  9706. MemoryBuffer s;
  9707. p->getPropBin("Value", s);
  9708. if (s.length())
  9709. {
  9710. unsigned len;
  9711. s.read(len);
  9712. str.setLen((const char *) s.readDirect(len), len);
  9713. }
  9714. else
  9715. {
  9716. p->getPropBin("xmlValue", s);
  9717. if (p->isBinary("xmlValue"))
  9718. str.setLen(s.toByteArray(), s.length());
  9719. else
  9720. {
  9721. char *ascii = rtlUtf8ToVStr(rtlUtf8Length(s.length(), s.toByteArray()), s.toByteArray());
  9722. str.set(ascii);
  9723. rtlFree(ascii);
  9724. }
  9725. }
  9726. return str;
  9727. }
  9728. WUResultFormat CLocalWUResult::getResultFormat() const
  9729. {
  9730. const char * format = p->queryProp("@format");
  9731. if (!format)
  9732. return ResultFormatRaw;
  9733. else if (strcmp(format, "xml") == 0)
  9734. return ResultFormatXml;
  9735. else if (strcmp(format, "xmlSet") == 0)
  9736. return ResultFormatXmlSet;
  9737. else if (strcmp(format, "csv") == 0)
  9738. return ResultFormatCsv;
  9739. else
  9740. throw MakeStringException(WUERR_InvalidResultFormat, "Unrecognised result format %s", format);
  9741. }
  9742. IDataVal& CLocalWUResult::getResultRaw(IDataVal & data, IXmlToRawTransformer * xmlTransformer, ICsvToRawTransformer * csvTransformer) const
  9743. {
  9744. MemoryBuffer s;
  9745. p->getPropBin("Value", s);
  9746. unsigned len = s.length();
  9747. if (len)
  9748. {
  9749. WUResultFormat format = getResultFormat();
  9750. if (format == ResultFormatXml || format == ResultFormatXmlSet)
  9751. {
  9752. if (!xmlTransformer)
  9753. throw MakeStringException(WUERR_MissingFormatTranslator, "No transformer supplied to translate XML format result");
  9754. xmlTransformer->transform(data, len, s.readDirect(len), format == ResultFormatXml);
  9755. }
  9756. else if (format == ResultFormatCsv)
  9757. {
  9758. if (!csvTransformer)
  9759. throw MakeStringException(WUERR_MissingFormatTranslator, "No transformer supplied to translate Csv format result");
  9760. csvTransformer->transform(data, len, s.readDirect(len), true);
  9761. }
  9762. else
  9763. data.setLen(s.readDirect(len), len);
  9764. }
  9765. else
  9766. data.clear();
  9767. return data;
  9768. }
  9769. unsigned CLocalWUResult::getResultHash() const
  9770. {
  9771. MemoryBuffer s;
  9772. p->getPropBin("Value", s);
  9773. unsigned len = s.length();
  9774. const byte * data = (const byte *)s.toByteArray();
  9775. return ~hashc(data, len, ~0);
  9776. }
  9777. IDataVal& CLocalWUResult::getResultUnicode(IDataVal & data) const
  9778. {
  9779. MemoryBuffer s;
  9780. p->getPropBin("Value", s);
  9781. if (s.length())
  9782. {
  9783. unsigned len;
  9784. s.read(len);
  9785. data.setLen(s.readDirect(len*2), len*2);
  9786. }
  9787. else
  9788. {
  9789. StringBuffer utf8;
  9790. if (p->getProp("xmlValue", utf8))
  9791. {
  9792. unsigned outlen;
  9793. UChar *out;
  9794. rtlUtf8ToUnicodeX(outlen, out, utf8.length(), utf8.str());
  9795. data.setLen(out, outlen*2);
  9796. rtlFree(out);
  9797. }
  9798. else
  9799. data.clear();
  9800. }
  9801. return data;
  9802. }
  9803. __int64 CLocalWUResult::getResultRawSize(IXmlToRawTransformer * xmlTransformer, ICsvToRawTransformer * csvTransformer) const
  9804. {
  9805. WUResultFormat format = getResultFormat();
  9806. if (format == ResultFormatRaw)
  9807. {
  9808. //MORE: This should not load the whole property...
  9809. MemoryBuffer s;
  9810. p->getPropBin("Value", s);
  9811. return s.length();
  9812. }
  9813. else
  9814. {
  9815. MemoryBuffer temp;
  9816. MemoryBuffer2IDataVal adaptor(temp);
  9817. getResultRaw(adaptor, xmlTransformer, csvTransformer);
  9818. return temp.length();
  9819. }
  9820. }
  9821. IDataVal& CLocalWUResult::getResultRaw(IDataVal & data, __int64 from, __int64 length, IXmlToRawTransformer * xmlTransformer, ICsvToRawTransformer * csvTransformer) const
  9822. {
  9823. WUResultFormat format = getResultFormat();
  9824. if (format != ResultFormatRaw)
  9825. {
  9826. MemoryBuffer temp;
  9827. MemoryBuffer2IDataVal adaptor(temp);
  9828. getResultRaw(adaptor, xmlTransformer, csvTransformer);
  9829. unsigned len = temp.length();
  9830. if (from > len) from = len;
  9831. if (from + length > len) length = len - from;
  9832. data.setLen(temp.readDirect(len) + from, (size32_t)length);
  9833. return data;
  9834. }
  9835. else
  9836. {
  9837. //MORE: This should not load the whole property, and should be different from the code above...
  9838. MemoryBuffer s;
  9839. p->getPropBin("Value", s);
  9840. unsigned len = s.length();
  9841. if (from > len) from = len;
  9842. if (from + length > len) length = len - from;
  9843. data.setLen(s.readDirect(len) + from, (size32_t)length);
  9844. return data;
  9845. }
  9846. }
  9847. bool CLocalWUResult::getResultIsAll() const
  9848. {
  9849. return p->getPropBool("@isAll", false);
  9850. }
  9851. // MORE - it's an undetected error if we call setResult... of a type that does not match schema
  9852. void CLocalWUResult::setResultInt(__int64 val)
  9853. {
  9854. // Note: we always serialize scalar integer results as int8, and schema must reflect this
  9855. MemoryBuffer m;
  9856. serializeInt8(val, m);
  9857. p->setPropBin("Value", m.length(), m.toByteArray());
  9858. setResultRowCount(1);
  9859. setResultTotalRowCount(1);
  9860. }
  9861. void CLocalWUResult::setResultUInt(unsigned __int64 val)
  9862. {
  9863. setResultInt((__int64) val);
  9864. }
  9865. void CLocalWUResult::setResultReal(double val)
  9866. {
  9867. // Note: we always serialize scalar real results as real8, and schema must reflect this
  9868. MemoryBuffer m;
  9869. serializeReal8(val, m);
  9870. p->setPropBin("Value", m.length(), m.toByteArray());
  9871. setResultRowCount(1);
  9872. setResultTotalRowCount(1);
  9873. }
  9874. void CLocalWUResult::setResultBool(bool val)
  9875. {
  9876. MemoryBuffer m;
  9877. serializeBool(val, m);
  9878. p->setPropBin("Value", m.length(), m.toByteArray());
  9879. setResultRowCount(1);
  9880. setResultTotalRowCount(1);
  9881. }
  9882. void CLocalWUResult::setResultString(const char *val, unsigned len)
  9883. {
  9884. // Note: we always serialize scalar strings with length prefix, and schema must reflect this
  9885. MemoryBuffer m;
  9886. serializeLPString(len, val, m);
  9887. p->setPropBin("Value", m.length(), m.toByteArray());
  9888. setResultRowCount(1);
  9889. setResultTotalRowCount(1);
  9890. }
  9891. void CLocalWUResult::setResultUnicode(const void *val, unsigned len)
  9892. {
  9893. // Note: we always serialize scalar strings with length prefix, and schema must reflect this
  9894. MemoryBuffer m;
  9895. m.append(len).append(len*2, val);
  9896. p->setPropBin("Value", m.length(), m.toByteArray());
  9897. setResultRowCount(1);
  9898. setResultTotalRowCount(1);
  9899. }
  9900. void CLocalWUResult::setResultData(const void *val, unsigned len)
  9901. {
  9902. // Note: we always serialize scalar data with length prefix, and schema must reflect this
  9903. MemoryBuffer m;
  9904. serializeLPString(len, (const char *)val, m);
  9905. p->setPropBin("Value", m.length(), m.toByteArray());
  9906. setResultRowCount(1);
  9907. setResultTotalRowCount(1);
  9908. }
  9909. void CLocalWUResult::setResultDecimal(const void *val, unsigned len)
  9910. {
  9911. // Note: serialized as data but with length known from schema
  9912. MemoryBuffer m;
  9913. serializeFixedData(len, val, m);
  9914. p->setPropBin("Value", m.length(), m.toByteArray());
  9915. setResultRowCount(1);
  9916. setResultTotalRowCount(1);
  9917. }
  9918. void CLocalWUResult::setResultRow(unsigned len, const void * data)
  9919. {
  9920. p->setPropBin("Value", len, data);
  9921. setResultRowCount(1);
  9922. setResultTotalRowCount(1);
  9923. setResultFormat(ResultFormatRaw);
  9924. }
  9925. void CLocalWUResult::setResultIsAll(bool value)
  9926. {
  9927. p->setPropBool("@isAll", value);
  9928. }
  9929. //==========================================================================================
  9930. CLocalWUPlugin::CLocalWUPlugin(IPropertyTree *props) : p(props)
  9931. {
  9932. }
  9933. IStringVal& CLocalWUPlugin::getPluginName(IStringVal &str) const
  9934. {
  9935. str.set(p->queryProp("@dllname"));
  9936. return str;
  9937. }
  9938. IStringVal& CLocalWUPlugin::getPluginVersion(IStringVal &str) const
  9939. {
  9940. str.set(p->queryProp("@version"));
  9941. return str;
  9942. }
  9943. void CLocalWUPlugin::setPluginName(const char *str)
  9944. {
  9945. p->setProp("@dllname", str);
  9946. }
  9947. void CLocalWUPlugin::setPluginVersion(const char *str)
  9948. {
  9949. p->setProp("@version", str);
  9950. }
  9951. //==========================================================================================
  9952. CLocalWULibrary::CLocalWULibrary(IPropertyTree *props) : p(props)
  9953. {
  9954. }
  9955. IStringVal& CLocalWULibrary::getName(IStringVal &str) const
  9956. {
  9957. str.set(p->queryProp("@name"));
  9958. return str;
  9959. }
  9960. void CLocalWULibrary::setName(const char *str)
  9961. {
  9962. p->setProp("@name", str);
  9963. }
  9964. //==========================================================================================
  9965. CLocalWUException::CLocalWUException(IPropertyTree *props) : p(props)
  9966. {
  9967. }
  9968. IStringVal& CLocalWUException::getExceptionSource(IStringVal &str) const
  9969. {
  9970. str.set(p->queryProp("@source"));
  9971. return str;
  9972. }
  9973. IStringVal& CLocalWUException::getExceptionMessage(IStringVal &str) const
  9974. {
  9975. str.set(p->queryProp(NULL));
  9976. return str;
  9977. }
  9978. unsigned CLocalWUException::getExceptionCode() const
  9979. {
  9980. return p->getPropInt("@code", 0);
  9981. }
  9982. ErrorSeverity CLocalWUException::getSeverity() const
  9983. {
  9984. return (ErrorSeverity)p->getPropInt("@severity", SeverityError);
  9985. }
  9986. IStringVal & CLocalWUException::getTimeStamp(IStringVal & dt) const
  9987. {
  9988. dt.set(p->queryProp("@time"));
  9989. return dt;
  9990. }
  9991. IStringVal & CLocalWUException::getExceptionFileName(IStringVal & str) const
  9992. {
  9993. str.set(p->queryProp("@filename"));
  9994. return str;
  9995. }
  9996. unsigned CLocalWUException::getExceptionLineNo() const
  9997. {
  9998. return p->getPropInt("@row", 0);
  9999. }
  10000. unsigned CLocalWUException::getExceptionColumn() const
  10001. {
  10002. return p->getPropInt("@col", 0);
  10003. }
  10004. unsigned CLocalWUException::getActivityId() const
  10005. {
  10006. const char * scope = queryScope();
  10007. if (scope)
  10008. {
  10009. const char * colon = strrchr(scope, ':');
  10010. if (colon && hasPrefix(colon+1, ActivityScopePrefix, true))
  10011. return atoi(colon+1+strlen(ActivityScopePrefix));
  10012. }
  10013. return p->getPropInt("@activity", 0);
  10014. }
  10015. unsigned CLocalWUException::getSequence() const
  10016. {
  10017. return p->getPropInt("@sequence", 0);
  10018. }
  10019. const char * CLocalWUException::queryScope() const
  10020. {
  10021. return p->queryProp("@scope");
  10022. }
  10023. unsigned CLocalWUException::getPriority() const
  10024. {
  10025. return p->getPropInt("@prio", 0);
  10026. }
  10027. void CLocalWUException::setExceptionSource(const char *str)
  10028. {
  10029. p->setProp("@source", str);
  10030. }
  10031. void CLocalWUException::setExceptionMessage(const char *str)
  10032. {
  10033. p->setProp(NULL, str);
  10034. }
  10035. void CLocalWUException::setExceptionCode(unsigned code)
  10036. {
  10037. p->setPropInt("@code", code);
  10038. }
  10039. void CLocalWUException::setSeverity(ErrorSeverity level)
  10040. {
  10041. p->setPropInt("@severity", level);
  10042. }
  10043. void CLocalWUException::setTimeStamp(const char *str)
  10044. {
  10045. p->setProp("@time", str);
  10046. }
  10047. void CLocalWUException::setExceptionFileName(const char *str)
  10048. {
  10049. p->setProp("@filename", str);
  10050. }
  10051. void CLocalWUException::setExceptionLineNo(unsigned r)
  10052. {
  10053. p->setPropInt("@row", r);
  10054. }
  10055. void CLocalWUException::setExceptionColumn(unsigned c)
  10056. {
  10057. p->setPropInt("@col", c);
  10058. }
  10059. void CLocalWUException::setActivityId(unsigned _id)
  10060. {
  10061. p->setPropInt("@activity", _id);
  10062. }
  10063. void CLocalWUException::setScope(const char * _scope)
  10064. {
  10065. p->setProp("@scope", _scope);
  10066. }
  10067. void CLocalWUException::setPriority(unsigned _priority)
  10068. {
  10069. p->setPropInt("@prio", _priority);
  10070. }
  10071. //==========================================================================================
  10072. CLocalWUAppValue::CLocalWUAppValue(IPropertyTree *props, unsigned child) : p(props)
  10073. {
  10074. StringAttrBuilder propPath(prop);
  10075. propPath.append("*[").append(child).append("]");
  10076. }
  10077. const char * CLocalWUAppValue::queryApplication() const
  10078. {
  10079. return p->queryName();
  10080. }
  10081. const char * CLocalWUAppValue::queryName() const
  10082. {
  10083. IPropertyTree* val=p->queryPropTree(prop.str());
  10084. if(val)
  10085. return val->queryName();
  10086. return ""; // Should not happen in normal usage
  10087. }
  10088. const char * CLocalWUAppValue::queryValue() const
  10089. {
  10090. return p->queryProp(prop.str());
  10091. }
  10092. //==========================================================================================
  10093. CLocalWUStatistic::CLocalWUStatistic(IPropertyTree *props) : p(props)
  10094. {
  10095. }
  10096. IStringVal & CLocalWUStatistic::getCreator(IStringVal & str) const
  10097. {
  10098. const char * creator = p->queryProp("@creator");
  10099. str.set(creator);
  10100. return str;
  10101. }
  10102. IStringVal & CLocalWUStatistic::getDescription(IStringVal & str, bool createDefault) const
  10103. {
  10104. const char * desc = p->queryProp("@desc");
  10105. if (desc)
  10106. {
  10107. str.set(desc); // legacy and in case it is overridden
  10108. }
  10109. else if (createDefault)
  10110. {
  10111. StatisticKind kind = getKind();
  10112. assertex(kind != StKindNone);
  10113. const char * scope = p->queryProp("@scope");
  10114. assertex(scope);
  10115. //Clean up the format of the scope when converting it to a description
  10116. StringBuffer descriptionText;
  10117. if (isGlobalScope(scope))
  10118. {
  10119. const char * creator = p->queryProp("@creator");
  10120. descriptionText.append(creator).append(":");
  10121. queryLongStatisticName(descriptionText, kind);
  10122. }
  10123. else
  10124. {
  10125. for (;;)
  10126. {
  10127. char c = *scope++;
  10128. if (!c)
  10129. break;
  10130. if (c == ':')
  10131. descriptionText.append(": ");
  10132. else
  10133. descriptionText.append(c);
  10134. }
  10135. if (kind != StTimeElapsed)
  10136. queryLongStatisticName(descriptionText.append(": "), kind);
  10137. }
  10138. str.set(descriptionText);
  10139. }
  10140. else
  10141. str.clear();
  10142. return str;
  10143. }
  10144. IStringVal & CLocalWUStatistic::getFormattedValue(IStringVal & str) const
  10145. {
  10146. StringBuffer formatted;
  10147. formatStatistic(formatted, getValue(), getMeasure());
  10148. str.set(formatted);
  10149. return str;
  10150. }
  10151. StatisticCreatorType CLocalWUStatistic::getCreatorType() const
  10152. {
  10153. return queryCreatorType(p->queryProp("@c"), SCTnone);
  10154. }
  10155. StatisticScopeType CLocalWUStatistic::getScopeType() const
  10156. {
  10157. return queryScopeType(p->queryProp("@s"), SSTnone);
  10158. }
  10159. StatisticKind CLocalWUStatistic::getKind() const
  10160. {
  10161. return queryStatisticKind(p->queryProp("@kind"), StKindNone);
  10162. }
  10163. const char * CLocalWUStatistic::queryScope() const
  10164. {
  10165. const char * scope = p->queryProp("@scope");
  10166. if (scope && streq(scope, LEGACY_GLOBAL_SCOPE))
  10167. scope = GLOBAL_SCOPE;
  10168. return scope;
  10169. }
  10170. StatisticMeasure CLocalWUStatistic::getMeasure() const
  10171. {
  10172. return queryMeasure(p->queryProp("@unit"), SMeasureNone);
  10173. }
  10174. unsigned __int64 CLocalWUStatistic::getValue() const
  10175. {
  10176. return p->getPropInt64("@value", 0);
  10177. }
  10178. unsigned __int64 CLocalWUStatistic::getCount() const
  10179. {
  10180. return p->getPropInt64("@count", 0);
  10181. }
  10182. unsigned __int64 CLocalWUStatistic::getMax() const
  10183. {
  10184. return p->getPropInt64("@max", 0);
  10185. }
  10186. unsigned __int64 CLocalWUStatistic::getTimestamp() const
  10187. {
  10188. return p->getPropInt64("@ts", 0);
  10189. }
  10190. //==========================================================================================
  10191. extern WORKUNIT_API ILocalWorkUnit * createLocalWorkUnit(const char *xml)
  10192. {
  10193. Owned<CLocalWorkUnit> cw = new CLocalWorkUnit((ISecManager *) NULL, NULL);
  10194. if (xml)
  10195. cw->loadPTree(createPTreeFromXMLString(xml, ipt_lowmem));
  10196. else
  10197. {
  10198. Owned<IPropertyTree> p = createPTree("W_LOCAL", ipt_lowmem);
  10199. p->setProp("@xmlns:xsi", "http://www.w3.org/1999/XMLSchema-instance");
  10200. cw->loadPTree(p.getClear());
  10201. }
  10202. ILocalWorkUnit* ret = QUERYINTERFACE(&cw->lockRemote(false), ILocalWorkUnit);
  10203. return ret;
  10204. }
  10205. void exportWorkUnitToXMLWithHiddenPasswords(IPropertyTree *p, IIOStream &out, unsigned extraXmlFlags)
  10206. {
  10207. const char *name = p->queryName();
  10208. if (!name)
  10209. name = "__unnamed__";
  10210. StringBuffer temp;
  10211. writeStringToStream(out, appendPTreeOpenTag(temp, p, name, 1, true));
  10212. Owned<IPropertyTreeIterator> elems = p->getElements("*", iptiter_sort);
  10213. ForEach(*elems)
  10214. {
  10215. IPropertyTree &elem = elems->query();
  10216. if (streq(elem.queryName(), "Parameters"))
  10217. {
  10218. writeStringToStream(out, appendPTreeOpenTag(temp.clear().append(' '), &elem, "Parameters", 2, false).append('\n'));
  10219. Owned<IPropertyTreeIterator> params = elem.getElements("*", iptiter_sort);
  10220. ForEach(*params)
  10221. {
  10222. IPropertyTree &param = params->query();
  10223. const char *paramname = param.queryName();
  10224. VStringBuffer xpath("Variables/Variable[@name='%s']/Format/@password", paramname);
  10225. if (p->getPropBool(xpath))
  10226. writeStringToStream(out, appendXMLTag(temp.clear().append(" "), paramname, "****").append('\n'));
  10227. else
  10228. {
  10229. toXML(&param, out, 2, XML_Format|XML_SortTags|extraXmlFlags);
  10230. }
  10231. }
  10232. writeStringToStream(out, appendXMLCloseTag(temp.clear().append(' '), "Parameters").append('\n'));
  10233. }
  10234. else if (streq(elem.queryName(), "Variables"))
  10235. {
  10236. writeStringToStream(out, appendPTreeOpenTag(temp.clear().append(' '), &elem, "Variables", 2, false).append('\n'));
  10237. Owned<IPropertyTreeIterator> vars = elem.getElements("*", iptiter_sort);
  10238. ForEach(*vars)
  10239. {
  10240. Owned<IPropertyTree> var = LINK(&vars->query());
  10241. if (var->getPropBool("Format/@password"))
  10242. {
  10243. var.setown(createPTreeFromIPT(var)); //copy and remove password values
  10244. var->removeProp("Value");
  10245. var->removeProp("xmlValue");
  10246. }
  10247. toXML(var, out, 2, XML_Format|XML_SortTags|extraXmlFlags);
  10248. }
  10249. writeStringToStream(out, appendXMLCloseTag(temp.clear().append(' '), "Variables").append('\n'));
  10250. }
  10251. else
  10252. toXML(&elem, out, 1, XML_Format|XML_SortTags|extraXmlFlags);
  10253. }
  10254. writeStringToStream(out, appendXMLCloseTag(temp.clear(), name));
  10255. }
  10256. StringBuffer &exportWorkUnitToXMLWithHiddenPasswords(IPropertyTree *p, StringBuffer &str)
  10257. {
  10258. class CAdapter : public CInterface, implements IIOStream
  10259. {
  10260. StringBuffer &out;
  10261. public:
  10262. IMPLEMENT_IINTERFACE;
  10263. CAdapter(StringBuffer &_out) : out(_out) { }
  10264. virtual void flush() { }
  10265. virtual size32_t read(size32_t len, void * data) { UNIMPLEMENTED; return 0; }
  10266. virtual size32_t write(size32_t len, const void * data) { out.append(len, (const char *)data); return len; }
  10267. } adapter(str);
  10268. exportWorkUnitToXMLWithHiddenPasswords(p->queryBranch(NULL), adapter, 0);
  10269. return str;
  10270. }
  10271. void exportWorkUnitToXMLFileWithHiddenPasswords(IPropertyTree *p, const char *filename, unsigned extraXmlFlags)
  10272. {
  10273. OwnedIFile ifile = createIFile(filename);
  10274. OwnedIFileIO ifileio = ifile->open(IFOcreate);
  10275. Owned<IIOStream> stream = createIOStream(ifileio);
  10276. exportWorkUnitToXMLWithHiddenPasswords(p->queryBranch(NULL), *stream, extraXmlFlags);
  10277. }
  10278. extern WORKUNIT_API StringBuffer &exportWorkUnitToXML(const IConstWorkUnit *wu, StringBuffer &str, bool unpack, bool includeProgress, bool hidePasswords)
  10279. {
  10280. // MORE - queryPTree isn't really safe without holding CLocalWorkUnit::crit - really need to move these functions into CLocalWorkunit
  10281. const IExtendedWUInterface *ewu = queryExtendedWU(wu);
  10282. if (ewu)
  10283. {
  10284. Linked<IPropertyTree> p;
  10285. if (unpack||includeProgress)
  10286. p.setown(ewu->getUnpackedTree(includeProgress));
  10287. else
  10288. p.set(ewu->queryPTree());
  10289. if (hidePasswords)
  10290. return exportWorkUnitToXMLWithHiddenPasswords(p, str);
  10291. else
  10292. return toXML(p, str, 0, XML_Format|XML_SortTags);
  10293. }
  10294. else
  10295. return str.append("Unrecognized workunit format");
  10296. }
  10297. extern WORKUNIT_API void exportWorkUnitToXMLFile(const IConstWorkUnit *wu, const char * filename, unsigned extraXmlFlags, bool unpack, bool includeProgress, bool hidePasswords, bool splitStats)
  10298. {
  10299. const IExtendedWUInterface *ewu = queryExtendedWU(wu);
  10300. if (ewu)
  10301. {
  10302. Linked<IPropertyTree> p;
  10303. if (unpack||includeProgress)
  10304. p.setown(ewu->getUnpackedTree(includeProgress));
  10305. else
  10306. p.set(ewu->queryPTree());
  10307. if (hidePasswords)
  10308. return exportWorkUnitToXMLFileWithHiddenPasswords(p, filename, extraXmlFlags);
  10309. if (splitStats)
  10310. {
  10311. StringBuffer statsFilename;
  10312. statsFilename.append(filename).append(".stats");
  10313. IPropertyTree * stats = p->queryPropTree("Statistics");
  10314. if (stats)
  10315. {
  10316. saveXML(statsFilename, stats, 0, (XML_Format|XML_SortTags|extraXmlFlags) & ~XML_LineBreakAttributes);
  10317. p->removeProp("Statistics");
  10318. }
  10319. }
  10320. saveXML(filename, p, 0, XML_Format|XML_SortTags|extraXmlFlags);
  10321. }
  10322. else
  10323. throw makeStringException(0, "Unrecognized workunit format");
  10324. }
  10325. extern WORKUNIT_API void submitWorkUnit(const char *wuid, const char *username, const char *password)
  10326. {
  10327. MemoryBuffer buffer;
  10328. Owned<INamedQueueConnection> conn = createNamedQueueConnection(0); // MORE - security token?
  10329. Owned<IWorkUnitFactory> factory = getWorkUnitFactory();
  10330. Owned<IWorkUnit> workunit = factory->updateWorkUnit(wuid);
  10331. assertex(workunit);
  10332. SCMStringBuffer token;
  10333. createToken(wuid, username, password, token);
  10334. workunit->setSecurityToken(token.str());
  10335. StringAttr clusterName(workunit->queryClusterName());
  10336. if (!clusterName.length())
  10337. throw MakeStringException(WUERR_InvalidCluster, "No target cluster specified");
  10338. workunit->commit();
  10339. workunit.clear();
  10340. Owned<IConstWUClusterInfo> clusterInfo = getTargetClusterInfo(clusterName.str());
  10341. if (!clusterInfo)
  10342. throw MakeStringException(WUERR_InvalidCluster, "Unknown cluster %s", clusterName.str());
  10343. SCMStringBuffer serverQueue;
  10344. clusterInfo->getServerQueue(serverQueue);
  10345. assertex(serverQueue.length());
  10346. Owned<IJobQueue> queue = createJobQueue(serverQueue.str());
  10347. if (!queue.get())
  10348. throw MakeStringException(WUERR_InvalidQueue, "Could not create workunit queue");
  10349. IJobQueueItem *item = createJobQueueItem(wuid);
  10350. queue->enqueue(item);
  10351. }
  10352. extern WORKUNIT_API void abortWorkUnit(const char *wuid)
  10353. {
  10354. StringBuffer xpath("/WorkUnitAborts/");
  10355. xpath.append(wuid);
  10356. Owned<IRemoteConnection> acon = querySDS().connect(xpath.str(), myProcessSession(), RTM_LOCK_WRITE|RTM_CREATE, SDS_LOCK_TIMEOUT);
  10357. acon->queryRoot()->setPropInt(NULL, 1);
  10358. }
  10359. extern WORKUNIT_API void secSubmitWorkUnit(const char *wuid, ISecManager &secmgr, ISecUser &secuser)
  10360. {
  10361. if (checkWuSecAccess(wuid, &secmgr, &secuser, SecAccess_Write, "Submit", true, true))
  10362. submitWorkUnit(wuid, secuser.getName(), secuser.credentials().getPassword());
  10363. }
  10364. extern WORKUNIT_API void secAbortWorkUnit(const char *wuid, ISecManager &secmgr, ISecUser &secuser)
  10365. {
  10366. if (!checkWuSecAccess(wuid, &secmgr, &secuser, SecAccess_Write, "Submit", true, true))
  10367. return;
  10368. abortWorkUnit(wuid);
  10369. Owned<IConstWorkUnit> cw = factory->openWorkUnit(wuid);
  10370. if(!cw)
  10371. return;
  10372. WorkunitUpdate wu(&cw->lock());
  10373. const char *abortBy = secuser.getName();
  10374. if (abortBy && *abortBy)
  10375. wu->setTracingValue("AbortBy", abortBy);
  10376. wu->setTracingValueInt64("AbortTimeStamp", getTimeStampNowValue());
  10377. }
  10378. extern WORKUNIT_API void submitWorkUnit(const char *wuid, ISecManager *secmgr, ISecUser *secuser)
  10379. {
  10380. if (secmgr && secuser)
  10381. return secSubmitWorkUnit(wuid, *secmgr, *secuser);
  10382. if (secuser)
  10383. return submitWorkUnit(wuid, secuser->getName(), secuser->credentials().getPassword());
  10384. submitWorkUnit(wuid, "", "");
  10385. }
  10386. extern WORKUNIT_API void abortWorkUnit(const char *wuid, ISecManager *secmgr, ISecUser *secuser)
  10387. {
  10388. if (secmgr && secuser)
  10389. return secAbortWorkUnit(wuid, *secmgr, *secuser);
  10390. abortWorkUnit(wuid);
  10391. }
  10392. bool CLocalWorkUnit::hasWorkflow() const
  10393. {
  10394. return p->hasProp("Workflow");
  10395. }
  10396. unsigned CLocalWorkUnit::queryEventScheduledCount() const
  10397. {
  10398. CriticalBlock block(crit);
  10399. if (p->hasProp("@eventScheduledCount"))
  10400. return p->getPropInt("@eventScheduledCount", 0);
  10401. else
  10402. return p->getPropInt("Workflow/@eventScheduledCount", 0); // Legacy location for this setting
  10403. }
  10404. void CLocalWorkUnit::incEventScheduledCount()
  10405. {
  10406. CriticalBlock block(crit);
  10407. p->setPropInt("@eventScheduledCount", queryEventScheduledCount()+1);
  10408. }
  10409. IPropertyTree * CLocalWorkUnit::queryWorkflowTree() const
  10410. {
  10411. CriticalBlock block(crit);
  10412. return p->queryPropTree("Workflow");
  10413. }
  10414. IConstWorkflowItemIterator* CLocalWorkUnit::getWorkflowItems() const
  10415. {
  10416. // For this to be legally called, we must have the read-able interface. So we are already locked for (at least) read.
  10417. CriticalBlock block(crit);
  10418. if(!workflowIteratorCached)
  10419. {
  10420. assertex(!workflowIterator);
  10421. Owned<IPropertyTree> s = p->getPropTree("Workflow");
  10422. if(s)
  10423. workflowIterator.setown(createWorkflowItemIterator(s));
  10424. workflowIteratorCached = true;
  10425. }
  10426. return workflowIterator.getLink();
  10427. }
  10428. IWorkflowItemArray * CLocalWorkUnit::getWorkflowClone() const
  10429. {
  10430. unsigned count = 0;
  10431. Owned<IConstWorkflowItemIterator> iter = getWorkflowItems();
  10432. for(iter->first(); iter->isValid(); iter->next())
  10433. count++;
  10434. Owned<IWorkflowItemArray> array = createWorkflowItemArray(count);
  10435. for(iter->first(); iter->isValid(); iter->next())
  10436. array->addClone(iter->query());
  10437. return array.getLink();
  10438. }
  10439. IWorkflowItem * CLocalWorkUnit::addWorkflowItem(unsigned wfid, WFType type, WFMode mode, unsigned success, unsigned failure, unsigned recovery, unsigned retriesAllowed, unsigned contingencyFor)
  10440. {
  10441. // For this to be legally called, we must have the write-able interface. So we are already locked for write.
  10442. CriticalBlock block(crit);
  10443. workflowIterator.clear();
  10444. workflowIteratorCached = false;
  10445. IPropertyTree * s = p->queryPropTree("Workflow");
  10446. if(!s)
  10447. s = p->addPropTree("Workflow");
  10448. return createWorkflowItem(s, wfid, type, mode, success, failure, recovery, retriesAllowed, contingencyFor);
  10449. }
  10450. IWorkflowItemIterator * CLocalWorkUnit::updateWorkflowItems()
  10451. {
  10452. // For this to be legally called, we must have the write-able interface. So we are already locked for write.
  10453. CriticalBlock block(crit);
  10454. if(!workflowIterator)
  10455. {
  10456. IPropertyTree * s = p->queryPropTree("Workflow");
  10457. if(!s)
  10458. s = p->addPropTree("Workflow");
  10459. workflowIterator.setown(createWorkflowItemIterator(s));
  10460. workflowIteratorCached = true;
  10461. }
  10462. return workflowIterator.getLink();
  10463. }
  10464. void CLocalWorkUnit::syncRuntimeWorkflow(IWorkflowItemArray * array)
  10465. {
  10466. Owned<IWorkflowItemIterator> iter = updateWorkflowItems();
  10467. Owned<IWorkflowItem> item;
  10468. for(iter->first(); iter->isValid(); iter->next())
  10469. {
  10470. item.setown(iter->get());
  10471. item->syncRuntimeData(array->queryWfid(item->queryWfid()));
  10472. }
  10473. workflowIterator.clear();
  10474. workflowIteratorCached = false;
  10475. }
  10476. void CLocalWorkUnit::resetWorkflow()
  10477. {
  10478. if (hasWorkflow())
  10479. {
  10480. Owned<IWorkflowItemIterator> iter = updateWorkflowItems();
  10481. Owned<IWorkflowItem> wf;
  10482. for(iter->first(); iter->isValid(); iter->next())
  10483. {
  10484. wf.setown(iter->get());
  10485. wf->reset();
  10486. }
  10487. workflowIterator.clear();
  10488. workflowIteratorCached = false;
  10489. }
  10490. }
  10491. void CLocalWorkUnit::schedule()
  10492. {
  10493. CriticalBlock block(crit);
  10494. if(queryEventScheduledCount() == 0) return;
  10495. switch(getState())
  10496. {
  10497. case WUStateCompleted:
  10498. setState(WUStateWait);
  10499. break;
  10500. case WUStateFailed:
  10501. case WUStateArchived:
  10502. case WUStateAborting:
  10503. case WUStateAborted:
  10504. case WUStateScheduled:
  10505. throw MakeStringException(WUERR_CannotSchedule, "Cannot schedule workunit in this state");
  10506. }
  10507. StringBuffer rootPath;
  10508. rootPath.append("/Schedule/").append(queryClusterName());
  10509. Owned<IRemoteConnection> conn = querySDS().connect(rootPath.str(), myProcessSession(), RTM_LOCK_WRITE | RTM_CREATE_QUERY, SDS_LOCK_TIMEOUT);
  10510. Owned<IPropertyTree> root = conn->getRoot();
  10511. if(!root->hasChildren())
  10512. {
  10513. StringBuffer addPath;
  10514. addPath.append("/Schedulers/").append(queryClusterName());
  10515. Owned<IRemoteConnection> addConn = querySDS().connect(addPath.str(), myProcessSession(), RTM_LOCK_WRITE | RTM_CREATE_QUERY, SDS_LOCK_TIMEOUT);
  10516. }
  10517. char const * wuid = p->queryName();
  10518. StringBuffer xpath("*/*/");
  10519. ncnameEscape(wuid, xpath);
  10520. bool more;
  10521. do more = root->removeProp(xpath.str()); while(more);
  10522. Owned<IConstWorkflowItemIterator> iter = getWorkflowItems();
  10523. Owned<IWorkflowEvent> event;
  10524. Owned<IPropertyTree> branch1, branch2;
  10525. for(iter->first(); iter->isValid(); iter->next())
  10526. {
  10527. event.setown(iter->query()->getScheduleEvent());
  10528. if(!event) continue;
  10529. ncnameEscape(event->queryName(), xpath.clear());
  10530. ensurePTree(root, xpath.str());
  10531. branch1.setown(root->getPropTree(xpath.str()));
  10532. ncnameEscape(event->queryText(), xpath.clear());
  10533. ensurePTree(branch1, xpath.str());
  10534. branch2.setown(branch1->getPropTree(xpath.str()));
  10535. ncnameEscape(wuid, xpath.clear());
  10536. ensurePTree(branch2, xpath.str());
  10537. }
  10538. }
  10539. void CLocalWorkUnit::deschedule()
  10540. {
  10541. if(queryEventScheduledCount() == 0) return;
  10542. if(getState() == WUStateWait)
  10543. setState(WUStateCompleted);
  10544. doDescheduleWorkkunit(p->queryName());
  10545. }
  10546. EnumMapping localFileUploadTypes[] = {
  10547. { UploadTypeFileSpray, "FileSpray" },
  10548. { UploadTypeWUResult, "WUResult" },
  10549. { UploadTypeWUResultCsv, "WUResultCsv" },
  10550. { UploadTypeWUResultXml, "WUResultXml" },
  10551. { UploadTypeSize, NULL }
  10552. };
  10553. class CLocalFileUpload : public CInterface, implements IConstLocalFileUpload
  10554. {
  10555. public:
  10556. CLocalFileUpload(IPropertyTree * _tree) : tree(_tree) {}
  10557. CLocalFileUpload(unsigned id, LocalFileUploadType type, char const * source, char const * destination, char const * eventTag)
  10558. {
  10559. tree.setown(createPTree());
  10560. tree->setPropInt("@id", id);
  10561. setEnum(tree, "@type", type, localFileUploadTypes);
  10562. tree->setProp("@source", source);
  10563. tree->setProp("@destination", destination);
  10564. if (eventTag)
  10565. tree->setProp("@eventTag", eventTag);
  10566. }
  10567. IMPLEMENT_IINTERFACE;
  10568. IPropertyTree * getTree() { return tree.getLink(); }
  10569. virtual unsigned queryID() const { return tree->getPropInt("@id"); }
  10570. virtual LocalFileUploadType queryType() const { return (LocalFileUploadType)getEnum(tree, "@type", localFileUploadTypes); }
  10571. virtual IStringVal & getSource(IStringVal & ret) const { ret.set(tree->queryProp("@source")); return ret; }
  10572. virtual IStringVal & getDestination(IStringVal & ret) const { ret.set(tree->queryProp("@destination")); return ret; }
  10573. virtual IStringVal & getEventTag(IStringVal & ret) const { if(tree->hasProp("@eventTag")) ret.set(tree->queryProp("@eventTag")); else ret.clear(); return ret; }
  10574. private:
  10575. Owned<IPropertyTree> tree;
  10576. };
  10577. class CLocalFileUploadIterator : public CInterface, implements IConstLocalFileUploadIterator
  10578. {
  10579. public:
  10580. CLocalFileUploadIterator(IPropertyTree * _tree) : tree(_tree), iter(tree->getElements("LocalFileUpload")) {}
  10581. IMPLEMENT_IINTERFACE;
  10582. bool first() { return iter->first(); }
  10583. bool isValid() { return iter->isValid(); }
  10584. bool next() { return iter->next(); }
  10585. IConstLocalFileUpload * get() { return new CLocalFileUpload(&iter->get()); }
  10586. private:
  10587. Owned<IPropertyTree> tree;
  10588. Owned<IPropertyTreeIterator> iter;
  10589. };
  10590. IConstLocalFileUploadIterator * CLocalWorkUnit::getLocalFileUploads() const
  10591. {
  10592. // For this to be legally called, we must have the read-able interface. So we are already locked for (at least) read.
  10593. CriticalBlock block(crit);
  10594. Owned<IPropertyTree> s = p->getPropTree("LocalFileUploads");
  10595. if(s)
  10596. return new CLocalFileUploadIterator(s.getClear());
  10597. else
  10598. return NULL;
  10599. }
  10600. bool CLocalWorkUnit::requiresLocalFileUpload() const
  10601. {
  10602. SCMStringBuffer dest;
  10603. Owned<IConstWUResult> result;
  10604. Owned<IConstLocalFileUploadIterator> iter(getLocalFileUploads());
  10605. if(!iter)
  10606. return false;
  10607. for(iter->first(); iter->isValid(); iter->next())
  10608. {
  10609. Owned<IConstLocalFileUpload> upload(iter->get());
  10610. switch(upload->queryType())
  10611. {
  10612. case UploadTypeWUResult:
  10613. case UploadTypeWUResultCsv:
  10614. case UploadTypeWUResultXml:
  10615. upload->getDestination(dest);
  10616. result.setown(getResultByName(dest.str()));
  10617. if(!result)
  10618. return true;
  10619. break;
  10620. default:
  10621. throw MakeStringException(WUERR_InvalidUploadFormat, "Unsupported local file upload type %s", getEnumText(upload->queryType(), localFileUploadTypes));
  10622. }
  10623. }
  10624. return false;
  10625. }
  10626. unsigned CLocalWorkUnit::addLocalFileUpload(LocalFileUploadType type, char const * source, char const * destination, char const * eventTag)
  10627. {
  10628. // For this to be legally called, we must have the write-able interface. So we are already locked for write.
  10629. CriticalBlock block(crit);
  10630. IPropertyTree * s = p->queryPropTree("LocalFileUploads");
  10631. if(!s)
  10632. s = p->addPropTree("LocalFileUploads");
  10633. unsigned id = s->numChildren();
  10634. Owned<CLocalFileUpload> upload = new CLocalFileUpload(id, type, source, destination, eventTag);
  10635. s->addPropTree("LocalFileUpload", upload->getTree());
  10636. return id;
  10637. }
  10638. IStringVal & CLocalWorkUnit::getAbortBy(IStringVal & str) const
  10639. {
  10640. CriticalBlock block(crit);
  10641. str.set(p->queryProp("Tracing/AbortBy"));
  10642. return str;
  10643. }
  10644. unsigned __int64 CLocalWorkUnit::getAbortTimeStamp() const
  10645. {
  10646. CriticalBlock block(crit);
  10647. return p->getPropInt64("Tracing/AbortTimeStamp", 0);
  10648. }
  10649. #if 0
  10650. void testConstWorkflow(IConstWorkflowItem * cwf, bool * okay, bool * dep)
  10651. {
  10652. DBGLOG("Test workflow const iface %u", cwf->queryWfid());
  10653. unsigned deps = 0;
  10654. Owned<IWorkflowDependencyIterator> diter;
  10655. switch(cwf->queryWfid())
  10656. {
  10657. case 1:
  10658. assertex(!cwf->isScheduled());
  10659. assertex(cwf->queryType() == WFTypeNormal);
  10660. assertex(cwf->queryState() == WFStateNull);
  10661. diter.setown(cwf->getDependencies());
  10662. for(diter->first(); diter->isValid(); diter->next())
  10663. deps++;
  10664. assertex(deps==0);
  10665. okay[0] = true;
  10666. break;
  10667. case 2:
  10668. assertex(!cwf->isScheduled());
  10669. assertex(cwf->queryType() == WFTypeRecovery);
  10670. assertex(cwf->queryState() == WFStateSkip);
  10671. okay[1] = true;
  10672. break;
  10673. case 3:
  10674. assertex(cwf->queryContingencyFor() == 4);
  10675. okay[2] = true;
  10676. break;
  10677. case 4:
  10678. assertex(cwf->isScheduled());
  10679. assertex(cwf->queryType() == WFTypeNormal);
  10680. assertex(cwf->queryState() == WFStateReqd);
  10681. assertex(cwf->querySuccess() == 0);
  10682. assertex(cwf->queryFailure() == 3);
  10683. assertex(cwf->queryRecovery() == 2);
  10684. assertex(cwf->queryRetriesAllowed() == 10);
  10685. assertex(cwf->queryRetriesRemaining() == 10);
  10686. diter.setown(cwf->getDependencies());
  10687. for(diter->first(); diter->isValid(); diter->next())
  10688. {
  10689. dep[diter->query()-1] = true;
  10690. deps++;
  10691. }
  10692. assertex(deps==2);
  10693. assertex(dep[0]);
  10694. assertex(dep[1]);
  10695. okay[3] = true;
  10696. break;
  10697. case 5:
  10698. assertex(cwf->isScheduled());
  10699. assertex(!cwf->isScheduledNow());
  10700. assertex(cwf->querySchedulePriority() == 75);
  10701. assertex(cwf->queryScheduleCount() == 5);
  10702. assertex(cwf->queryScheduleCountRemaining() == 5);
  10703. okay[4] = true;
  10704. break;
  10705. case 6:
  10706. assertex(cwf->isScheduled());
  10707. assertex(!cwf->isScheduledNow());
  10708. assertex(cwf->querySchedulePriority() == 25);
  10709. assertex(!cwf->hasScheduleCount());
  10710. okay[5] = true;
  10711. break;
  10712. default:
  10713. assertex(!"unknown wfid in test");
  10714. }
  10715. }
  10716. void testRuntimeWorkflow(IRuntimeWorkflowItem * rwf, bool * okay)
  10717. {
  10718. DBGLOG("Test workflow runtime iface %u", rwf->queryWfid());
  10719. switch(rwf->queryWfid())
  10720. {
  10721. case 1:
  10722. case 2:
  10723. case 3:
  10724. okay[rwf->queryWfid()-1] = true;
  10725. break;
  10726. case 4:
  10727. {
  10728. unsigned tries = 0;
  10729. while(rwf->testAndDecRetries())
  10730. tries++;
  10731. assertex(tries == 10);
  10732. assertex(rwf->queryRetriesRemaining() == 0);
  10733. rwf->setState(WFStateFail);
  10734. assertex(rwf->queryState() == WFStateFail);
  10735. rwf->reset();
  10736. assertex(rwf->queryRetriesRemaining() == 10);
  10737. assertex(rwf->queryState() == WFStateReqd);
  10738. }
  10739. okay[3] = true;
  10740. break;
  10741. case 5:
  10742. {
  10743. assertex(rwf->queryScheduleCountRemaining() == 5);
  10744. unsigned count = 0;
  10745. do count++; while(rwf->decAndTestScheduleCountRemaining());
  10746. assertex(count == 5);
  10747. assertex(rwf->queryScheduleCountRemaining() == 0);
  10748. rwf->reset();
  10749. assertex(rwf->queryScheduleCountRemaining() == 5);
  10750. }
  10751. okay[4] = true;
  10752. break;
  10753. case 6:
  10754. {
  10755. assertex(!rwf->hasScheduleCount());
  10756. unsigned count;
  10757. for(count=0; count<20; count++)
  10758. assertex(rwf->decAndTestScheduleCountRemaining());
  10759. }
  10760. okay[5] = true;
  10761. break;
  10762. default:
  10763. assertex(!"unknown wfid in test");
  10764. }
  10765. }
  10766. void testWorkflow()
  10767. {
  10768. DBGLOG("workunit.cpp : testWorkflow");
  10769. CLocalWorkUnit wu("W-WF-TEST", 0, 0, 0);
  10770. Owned<IWorkflowItem> wf;
  10771. wf.setown(wu.addWorkflowItem(1, WFTypeNormal, 0, 0, 0, 0, 0));
  10772. wf.setown(wu.addWorkflowItem(2, WFTypeRecovery, 0, 0, 0, 0, 0));
  10773. wf.setown(wu.addWorkflowItem(3, WFTypeFailure, 0, 0, 0, 0, 4));
  10774. wf.setown(wu.addWorkflowItem(4, WFTypeNormal, 0, 3, 2, 10, 0));
  10775. wf->setScheduledNow();
  10776. wf->addDependency(1);
  10777. wf.setown(wu.addWorkflowItem(5, WFTypeNormal, 0, 0, 0, 0, 0));
  10778. wf->setScheduledOn("test", "foo*");
  10779. wf->setSchedulePriority(75);
  10780. wf->setScheduleCount(5);
  10781. wf.setown(wu.addWorkflowItem(6, WFTypeNormal, 0, 0, 0, 0, 0));
  10782. wf->setScheduledOn("test", "bar*");
  10783. wf->setSchedulePriority(25);
  10784. unsigned const n = 6;
  10785. bool okay[n];
  10786. bool dep[n];
  10787. unsigned i;
  10788. for(i=0; i<n; i++)
  10789. okay[i] = dep[i] = 0;
  10790. Owned<IConstWorkflowItemIterator> citer(wu.getWorkflowItems());
  10791. for(citer->first(); citer->isValid(); citer->next())
  10792. testConstWorkflow(citer->query(), okay, dep);
  10793. for(i=0; i<n; i++)
  10794. {
  10795. assertex(okay[i]);
  10796. okay[i] = false;
  10797. }
  10798. Owned<IWorkflowItemIterator> miter(wu.updateWorkflowItems());
  10799. for(miter->first(); miter->isValid(); miter->next())
  10800. {
  10801. Owned<IRuntimeWorkflowItem> rwf(miter->get());
  10802. testRuntimeWorkflow(rwf, okay);
  10803. }
  10804. for(i=0; i<n; i++)
  10805. {
  10806. assertex(okay[i]);
  10807. okay[i] = dep[i] = false;
  10808. }
  10809. Owned<IWorkflowItemArray> array(wu.getWorkflowClone());
  10810. unsigned wfid;
  10811. for(wfid = 1; array->isValid(wfid); wfid++)
  10812. testConstWorkflow(&array->queryWfid(wfid), okay, dep);
  10813. for(i=0; i<n; i++)
  10814. {
  10815. assertex(okay[i]);
  10816. okay[i] = false;
  10817. }
  10818. for(wfid = 1; array->isValid(wfid); wfid++)
  10819. testRuntimeWorkflow(&array->queryWfid(wfid), okay);
  10820. for(i=0; i<n; i++)
  10821. {
  10822. assertex(okay[i]);
  10823. okay[i] = false;
  10824. }
  10825. }
  10826. #endif
  10827. //------------------------------------------------------------------------------------------
  10828. extern WUState waitForWorkUnitToComplete(const char * wuid, int timeout, bool returnOnWaitState)
  10829. {
  10830. return factory->waitForWorkUnit(wuid, (unsigned) timeout, false, returnOnWaitState);
  10831. }
  10832. extern WORKUNIT_API WUState secWaitForWorkUnitToComplete(const char * wuid, ISecManager &secmgr, ISecUser &secuser, int timeout, bool returnOnWaitState)
  10833. {
  10834. if (checkWuSecAccess(wuid, &secmgr, &secuser, SecAccess_Read, "Wait for Complete", false, true))
  10835. return waitForWorkUnitToComplete(wuid, timeout, returnOnWaitState);
  10836. return WUStateUnknown;
  10837. }
  10838. extern bool waitForWorkUnitToCompile(const char * wuid, int timeout)
  10839. {
  10840. switch(factory->waitForWorkUnit(wuid, (unsigned) timeout, true, true))
  10841. {
  10842. case WUStateCompiled:
  10843. case WUStateCompleted:
  10844. case WUStateWait:
  10845. case WUStateUploadingFiles:
  10846. return true;
  10847. default:
  10848. return false;
  10849. }
  10850. }
  10851. extern WORKUNIT_API bool secWaitForWorkUnitToCompile(const char * wuid, ISecManager &secmgr, ISecUser &secuser, int timeout)
  10852. {
  10853. if (checkWuSecAccess(wuid, &secmgr, &secuser, SecAccess_Read, "Wait for Compile", false, true))
  10854. return waitForWorkUnitToCompile(wuid, timeout);
  10855. return false;
  10856. }
  10857. extern WORKUNIT_API bool secDebugWorkunit(const char * wuid, ISecManager &secmgr, ISecUser &secuser, const char *command, StringBuffer &response)
  10858. {
  10859. if (strnicmp(command, "<debug:", 7) == 0 && checkWuSecAccess(wuid, &secmgr, &secuser, SecAccess_Read, "Debug", false, true))
  10860. {
  10861. Owned<IConstWorkUnit> wu = factory->openWorkUnit(wuid, &secmgr, &secuser);
  10862. SCMStringBuffer ip;
  10863. unsigned port;
  10864. port = wu->getDebugAgentListenerPort();
  10865. wu->getDebugAgentListenerIP(ip);
  10866. SocketEndpoint debugEP(ip.str(), port);
  10867. Owned<ISocket> socket = ISocket::connect_timeout(debugEP, 1000);
  10868. unsigned len = (size32_t)strlen(command);
  10869. unsigned revlen = len;
  10870. _WINREV(revlen);
  10871. socket->write(&revlen, sizeof(revlen));
  10872. socket->write(command, len);
  10873. for (;;)
  10874. {
  10875. socket->read(&len, sizeof(len));
  10876. _WINREV(len);
  10877. if (len == 0)
  10878. break;
  10879. if (len & 0x80000000)
  10880. {
  10881. throwUnexpected();
  10882. }
  10883. char * mem = (char*) response.reserve(len);
  10884. socket->read(mem, len);
  10885. }
  10886. return true;
  10887. }
  10888. return false;
  10889. }
  10890. void getSimpleResultType(IWUResult *r, Owned<ITypeInfo> &type)
  10891. {
  10892. TypeInfoArray types;
  10893. StringAttrArray names;
  10894. r->getSchema(types, names, NULL);
  10895. if (types.ordinality()==1)
  10896. type.set(&types.item(0));
  10897. }
  10898. bool isSuppliedParamScalar(IWUResult *r, IPropertyTree &curVal, Owned<ITypeInfo> &type)
  10899. {
  10900. if (!r->isResultScalar())
  10901. return false;
  10902. if (!curVal.hasChildren())
  10903. return true;
  10904. getSimpleResultType(r, type);
  10905. return type && type->isScalar();
  10906. }
  10907. void updateSuppliedXmlParams(IWorkUnit * w)
  10908. {
  10909. Owned<const IPropertyTree> params = w->getXmlParams();
  10910. if (!params)
  10911. return;
  10912. Owned<IPropertyTreeIterator> elems = params->getElements("*");
  10913. ForEach(*elems)
  10914. {
  10915. IPropertyTree & curVal = elems->query();
  10916. const char *name = curVal.queryName();
  10917. Owned<IWUResult> r = updateWorkUnitResult(w, name, -1);
  10918. if (r)
  10919. {
  10920. Owned<ITypeInfo> type;
  10921. StringBuffer s;
  10922. if (isSuppliedParamScalar(r, curVal, type))
  10923. {
  10924. curVal.getProp(".", s);
  10925. r->setResultXML(s);
  10926. r->setResultStatus(ResultStatusSupplied);
  10927. }
  10928. else
  10929. {
  10930. toXML(&curVal, s);
  10931. if (!type)
  10932. getSimpleResultType(r, type);
  10933. bool isSet = (type && type->getTypeCode()==type_set);
  10934. r->setResultRaw(s.length(), s.str(), isSet ? ResultFormatXmlSet : ResultFormatXml);
  10935. }
  10936. }
  10937. else
  10938. DBGLOG("WARNING: no matching variable in workunit for input parameter %s", name);
  10939. }
  10940. }
  10941. IWUResult * updateWorkUnitResult(IWorkUnit * w, const char *name, unsigned sequence)
  10942. {
  10943. switch ((int)sequence)
  10944. {
  10945. case ResultSequenceStored:
  10946. return w->updateVariableByName(name);
  10947. case ResultSequencePersist:
  10948. return w->updateGlobalByName(name);
  10949. case ResultSequenceInternal:
  10950. case ResultSequenceOnce:
  10951. return w->updateTemporaryByName(name);
  10952. default:
  10953. return w->updateResultBySequence(sequence);
  10954. }
  10955. }
  10956. IConstWUResult * getWorkUnitResult(IConstWorkUnit * w, const char *name, unsigned sequence)
  10957. {
  10958. switch ((int)sequence)
  10959. {
  10960. case ResultSequenceStored:
  10961. return w->getVariableByName(name);
  10962. case ResultSequencePersist:
  10963. return w->getGlobalByName(name);
  10964. case ResultSequenceInternal:
  10965. case ResultSequenceOnce:
  10966. return w->getTemporaryByName(name);
  10967. default:
  10968. if (name && name[0])
  10969. return w->getResultByName(name);//name takes precedence over sequence
  10970. else
  10971. return w->getResultBySequence(sequence);
  10972. }
  10973. }
  10974. extern WORKUNIT_API bool getWorkUnitCreateTime(const char *wuid,CDateTime &time)
  10975. {
  10976. if (wuid) {
  10977. char prefchar;
  10978. unsigned year,month,day,hour,min,sec;
  10979. if (sscanf(wuid, "%c%4u%2u%2u-%2u%2u%2u", &prefchar, &year, &month, &day, &hour, &min, &sec)==7) {
  10980. time.set(year, month, day, hour, min, sec, 0, true);
  10981. // time.setDate(year, month, day);
  10982. // time.setTime(hour, min, sec, 0, true); // for some reason time is local
  10983. return true;
  10984. }
  10985. }
  10986. return false;
  10987. }
  10988. extern WORKUNIT_API IStringVal& createToken(const char *wuid, const char *user, const char *password, IStringVal &str)
  10989. {
  10990. StringBuffer wu, token("X");
  10991. wu.append(wuid).append(';').append(user).append(';').append(password);
  10992. encrypt(token,wu.str());
  10993. str.set(token.str());
  10994. return str;
  10995. }
  10996. // This will be replaced by something more secure!
  10997. extern WORKUNIT_API void extractToken(const char *token, const char *wuid, IStringVal &user, IStringVal &password)
  10998. {
  10999. if (token && *token)
  11000. {
  11001. StringBuffer wu;
  11002. decrypt(wu, token+1);
  11003. const char *finger = strchr(wu.str(),';');
  11004. if (finger && strnicmp(wuid, wu.str(), finger-wu.str())==0)
  11005. {
  11006. const char *finger1 = strchr(++finger,';');
  11007. if(finger1)
  11008. {
  11009. user.setLen(finger, (size32_t)(finger1-finger));
  11010. finger1++;
  11011. password.setLen(finger1, (size32_t)(wu.str() + wu.length() - finger1));
  11012. return;
  11013. }
  11014. }
  11015. throw MakeStringException(WUERR_InvalidSecurityToken, "Invalid call to extractToken");
  11016. }
  11017. }
  11018. extern WORKUNIT_API WUState getWorkUnitState(const char* state)
  11019. {
  11020. return (WUState) getEnum(state, states);
  11021. }
  11022. const LogMsgCategory MCschedconn = MCprogress(1000); // Category used to inform about schedule synchronization
  11023. class CWorkflowScheduleConnection : implements IWorkflowScheduleConnection, public CInterface
  11024. {
  11025. public:
  11026. CWorkflowScheduleConnection(char const * wuid)
  11027. {
  11028. basexpath.append("/WorkflowSchedule/").append(wuid);
  11029. flagxpath.append(basexpath.str()).append("/Active");
  11030. }
  11031. IMPLEMENT_IINTERFACE;
  11032. virtual void lock()
  11033. {
  11034. LOG(MCschedconn, "Locking base schedule connection");
  11035. baseconn.setown(querySDS().connect(basexpath.str(), myProcessSession(), RTM_CREATE_QUERY | RTM_LOCK_WRITE, INFINITE));
  11036. if(!baseconn)
  11037. throw MakeStringException(WUERR_ScheduleLockFailed, "Could not get base workflow schedule lock");
  11038. }
  11039. virtual void unlock()
  11040. {
  11041. LOG(MCschedconn, "Unlocking base schedule connection");
  11042. baseconn.clear();
  11043. }
  11044. virtual void setActive()
  11045. {
  11046. LOG(MCschedconn, "Setting active flag in schedule connection");
  11047. flagconn.setown(querySDS().connect(flagxpath.str(), myProcessSession(), RTM_CREATE | RTM_LOCK_WRITE | RTM_DELETE_ON_DISCONNECT, INFINITE));
  11048. if(!flagconn)
  11049. throw MakeStringException(WUERR_ScheduleLockFailed, "Could not get active workflow schedule lock");
  11050. }
  11051. virtual void resetActive()
  11052. {
  11053. LOG(MCschedconn, "Resetting active flag in schedule connection");
  11054. flagconn.clear();
  11055. }
  11056. virtual bool queryActive()
  11057. {
  11058. return baseconn->queryRoot()->hasProp("Active");
  11059. }
  11060. virtual bool pull(IWorkflowItemArray * workflow)
  11061. {
  11062. assertex(baseconn);
  11063. Owned<IPropertyTree> root = baseconn->getRoot();
  11064. Owned<IPropertyTree> eventQueue = root->getPropTree("EventQueue");
  11065. if(!eventQueue) return false;
  11066. if(!eventQueue->hasProp("Item")) return false;
  11067. {
  11068. Owned<IPropertyTreeIterator> eventItems = eventQueue->getElements("Item");
  11069. Owned<IPropertyTree> eventItem;
  11070. Owned<IRuntimeWorkflowItemIterator> wfItems = workflow->getSequenceIterator();
  11071. Owned<IRuntimeWorkflowItem> wfItem;
  11072. for(eventItems->first(); eventItems->isValid(); eventItems->next())
  11073. {
  11074. eventItem.setown(&eventItems->get());
  11075. const char * eventName = eventItem->queryProp("@name");
  11076. const char * eventText = eventItem->queryProp("@text");
  11077. for(wfItems->first(); wfItems->isValid(); wfItems->next())
  11078. {
  11079. wfItem.setown(wfItems->get());
  11080. if(wfItem->queryState() != WFStateWait)
  11081. continue;
  11082. Owned<IWorkflowEvent> targetEvent = wfItem->getScheduleEvent();
  11083. if(!targetEvent || !targetEvent->matches(eventName, eventText))
  11084. continue;
  11085. wfItem->setEvent(eventName, eventText);
  11086. wfItem->setState(WFStateReqd);
  11087. resetDependentsState(workflow, *wfItem);
  11088. }
  11089. }
  11090. }
  11091. bool more;
  11092. do
  11093. more = eventQueue->removeProp("Item");
  11094. while(more);
  11095. return true;
  11096. }
  11097. virtual void push(char const * name, char const * text)
  11098. {
  11099. assertex(baseconn);
  11100. Owned<IPropertyTree> root = baseconn->getRoot();
  11101. IPropertyTree *eventQueue = ensurePTree(root, "EventQueue");
  11102. IPropertyTree *eventItem = eventQueue->addPropTree("Item");
  11103. eventItem->setProp("@name", name);
  11104. eventItem->setProp("@text", text);
  11105. }
  11106. virtual void remove()
  11107. {
  11108. if (baseconn)
  11109. {
  11110. baseconn->close(true);
  11111. baseconn.clear();
  11112. }
  11113. }
  11114. private:
  11115. void resetItemStateAndDependents(IWorkflowItemArray * workflow, unsigned wfid) const
  11116. {
  11117. if (wfid)
  11118. resetItemStateAndDependents(workflow, workflow->queryWfid(wfid));
  11119. }
  11120. void resetItemStateAndDependents(IWorkflowItemArray * workflow, IRuntimeWorkflowItem & item) const
  11121. {
  11122. switch(item.queryState())
  11123. {
  11124. case WFStateDone:
  11125. case WFStateFail:
  11126. {
  11127. item.setState(WFStateNull);
  11128. resetItemStateAndDependents(workflow, item.queryPersistWfid());
  11129. resetDependentsState(workflow, item);
  11130. break;
  11131. }
  11132. }
  11133. }
  11134. void resetDependentsState(IWorkflowItemArray * workflow, IRuntimeWorkflowItem & item) const
  11135. {
  11136. Owned<IWorkflowDependencyIterator> iter(item.getDependencies());
  11137. for(iter->first(); iter->isValid(); iter->next())
  11138. {
  11139. IRuntimeWorkflowItem & dep = workflow->queryWfid(iter->query());
  11140. resetItemStateAndDependents(workflow, dep);
  11141. }
  11142. }
  11143. private:
  11144. StringBuffer basexpath;
  11145. StringBuffer flagxpath;
  11146. Owned<IRemoteConnection> baseconn;
  11147. Owned<IRemoteConnection> flagconn;
  11148. };
  11149. extern WORKUNIT_API IWorkflowScheduleConnection * getWorkflowScheduleConnection(char const * wuid)
  11150. {
  11151. return new CWorkflowScheduleConnection(wuid);
  11152. }
  11153. extern WORKUNIT_API IExtendedWUInterface * queryExtendedWU(IConstWorkUnit * wu)
  11154. {
  11155. return QUERYINTERFACE(wu, IExtendedWUInterface);
  11156. }
  11157. extern WORKUNIT_API const IExtendedWUInterface * queryExtendedWU(const IConstWorkUnit * wu)
  11158. {
  11159. return QUERYINTERFACE(wu, const IExtendedWUInterface);
  11160. }
  11161. 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)
  11162. {
  11163. Owned<IWUException> we = wu->createException();
  11164. we->setSeverity(severity);
  11165. we->setExceptionMessage(text);
  11166. if (source)
  11167. we->setExceptionSource(source);
  11168. if (code)
  11169. we->setExceptionCode(code);
  11170. if (filename)
  11171. we->setExceptionFileName(filename);
  11172. if (lineno)
  11173. {
  11174. we->setExceptionLineNo(lineno);
  11175. if (column)
  11176. we->setExceptionColumn(lineno);
  11177. }
  11178. if (activity)
  11179. we->setActivityId(activity);
  11180. }
  11181. const char * skipLeadingXml(const char * text)
  11182. {
  11183. if (!text)
  11184. return NULL;
  11185. //skip utf8 BOM, probably excessive
  11186. if (memcmp(text, UTF8_BOM, 3) == 0)
  11187. text += 3;
  11188. for (;;)
  11189. {
  11190. if (isspace(*text))
  11191. text++;
  11192. else if (text[0] == '<' && text[1] == '?')
  11193. {
  11194. text += 2;
  11195. for (;;)
  11196. {
  11197. if (!*text) break;
  11198. if (text[0] == '?' && text[1] == '>')
  11199. {
  11200. text += 2;
  11201. break;
  11202. }
  11203. text++;
  11204. }
  11205. }
  11206. else if (text[0] == '<' && text[1] == '!' && text[2] == '-' && text[3] == '-')
  11207. {
  11208. text += 4;
  11209. for (;;)
  11210. {
  11211. if (!*text) break;
  11212. if (text[0] == '-' && text[1] == '-' && text[2] == '>')
  11213. {
  11214. text += 3;
  11215. break;
  11216. }
  11217. text++;
  11218. }
  11219. }
  11220. else
  11221. break;
  11222. }
  11223. return text;
  11224. }
  11225. extern WORKUNIT_API bool isArchiveQuery(const char * text)
  11226. {
  11227. text = skipLeadingXml(text);
  11228. if (!text)
  11229. return false;
  11230. const char * archivePrefix = "<Archive";
  11231. return memicmp(text, archivePrefix, strlen(archivePrefix)) == 0;
  11232. }
  11233. extern WORKUNIT_API bool isQueryManifest(const char * text)
  11234. {
  11235. text = skipLeadingXml(text);
  11236. if (!text)
  11237. return false;
  11238. const char * manifestPrefix = "<Manifest";
  11239. return memicmp(text, manifestPrefix, strlen(manifestPrefix)) == 0;
  11240. }
  11241. //------------------------------------------------------------------------------
  11242. // Named Alias helper function
  11243. static IPropertyTree * resolveQueryByDll(IPropertyTree * queryRegistry, const char * dll)
  11244. {
  11245. StringBuffer xpath;
  11246. xpath.append("Query[@dll=\"").append(dll).append("\"]");
  11247. return queryRegistry->getPropTree(xpath);
  11248. }
  11249. static IPropertyTree * resolveQueryByWuid(IPropertyTree * queryRegistry, const char * wuid)
  11250. {
  11251. StringBuffer xpath;
  11252. xpath.append("Query[@wuid=\"").append(wuid).append("\"]");
  11253. return queryRegistry->getPropTree(xpath);
  11254. }
  11255. static void clearAliases(IPropertyTree * queryRegistry, const char * id)
  11256. {
  11257. StringBuffer lcId(id);
  11258. lcId.toLowerCase();
  11259. StringBuffer xpath;
  11260. xpath.append("Alias[@id=\"").append(lcId).append("\"]");
  11261. Owned<IPropertyTreeIterator> iter = queryRegistry->getElements(xpath);
  11262. ForEach(*iter)
  11263. {
  11264. queryRegistry->removeProp(xpath.str());
  11265. }
  11266. }
  11267. IPropertyTree * addNamedQuery(IPropertyTree * queryRegistry, const char * name, const char * wuid, const char * dll, bool library, const char *userid, const char *snapshot)
  11268. {
  11269. StringBuffer lcName(name);
  11270. lcName.toLowerCase();
  11271. StringBuffer xpath;
  11272. xpath.append("Query[@name=\"").append(lcName.str()).append("\"]");
  11273. Owned<IPropertyTreeIterator> iter = queryRegistry->getElements(xpath);
  11274. unsigned seq = 1;
  11275. ForEach(*iter)
  11276. {
  11277. IPropertyTree &item = iter->query();
  11278. const char *thisWuid = item.queryProp("@wuid");
  11279. if (strieq(wuid, thisWuid))
  11280. return &item;
  11281. unsigned thisSeq = item.getPropInt("@seq");
  11282. if (thisSeq >= seq)
  11283. seq = thisSeq + 1;
  11284. }
  11285. StringBuffer id;
  11286. id.append(lcName).append(".").append(seq);
  11287. IPropertyTree * newEntry = createPTree("Query", ipt_caseInsensitive|ipt_lowmem);
  11288. newEntry->setProp("@name", lcName);
  11289. newEntry->setProp("@wuid", wuid);
  11290. newEntry->setProp("@dll", dll);
  11291. newEntry->setProp("@id", id);
  11292. newEntry->setPropInt("@seq", seq);
  11293. if (library)
  11294. newEntry->setPropBool("@isLibrary", true);
  11295. if (userid && *userid)
  11296. newEntry->setProp("@publishedBy", userid);
  11297. if (snapshot && *snapshot)
  11298. newEntry->setProp("@snapshot", snapshot);
  11299. return queryRegistry->addPropTree("Query", newEntry);
  11300. }
  11301. void removeNamedQuery(IPropertyTree * queryRegistry, const char * id)
  11302. {
  11303. StringBuffer lcId(id);
  11304. lcId.toLowerCase();
  11305. clearAliases(queryRegistry, lcId);
  11306. StringBuffer xpath;
  11307. xpath.append("Query[@id=\"").append(lcId).append("\"]");
  11308. queryRegistry->removeProp(xpath);
  11309. }
  11310. void removeDllFromNamedQueries(IPropertyTree * queryRegistry, const char * dll)
  11311. {
  11312. Owned<IPropertyTree> match = resolveQueryByDll(queryRegistry, dll);
  11313. if (!match)
  11314. return;
  11315. clearAliases(queryRegistry, match->queryProp("@id"));
  11316. queryRegistry->removeTree(match);
  11317. }
  11318. void removeWuidFromNamedQueries(IPropertyTree * queryRegistry, const char * wuid)
  11319. {
  11320. Owned<IPropertyTree> match = resolveQueryByWuid(queryRegistry, wuid);
  11321. if (!match)
  11322. return;
  11323. clearAliases(queryRegistry, match->queryProp("@id"));
  11324. queryRegistry->removeTree(match);
  11325. }
  11326. void removeAliasesFromNamedQuery(IPropertyTree * queryRegistry, const char * id)
  11327. {
  11328. clearAliases(queryRegistry, id);
  11329. }
  11330. void setQueryAlias(IPropertyTree * queryRegistry, const char * name, const char * value)
  11331. {
  11332. StringBuffer lcName(name);
  11333. lcName.toLowerCase();
  11334. StringBuffer xpath;
  11335. xpath.append("Alias[@name=\"").append(lcName).append("\"]");
  11336. IPropertyTree * match = queryRegistry->queryPropTree(xpath);
  11337. if (!match)
  11338. {
  11339. match = queryRegistry->addPropTree("Alias");
  11340. match->setProp("@name", lcName);
  11341. }
  11342. match->setProp("@id", value);
  11343. }
  11344. extern WORKUNIT_API IPropertyTree * getQueryById(IPropertyTree * queryRegistry, const char *queryid)
  11345. {
  11346. if (!queryRegistry || !queryid)
  11347. return NULL;
  11348. StringBuffer xpath;
  11349. xpath.append("Query[@id=\"").append(queryid).append("\"]");
  11350. return queryRegistry->getPropTree(xpath);
  11351. }
  11352. extern WORKUNIT_API IPropertyTree * getQueryById(const char *queryset, const char *queryid, bool readonly)
  11353. {
  11354. Owned<IPropertyTree> queryRegistry = getQueryRegistry(queryset, readonly);
  11355. return getQueryById(queryRegistry, queryid);
  11356. }
  11357. extern WORKUNIT_API IPropertyTree * resolveQueryAlias(IPropertyTree * queryRegistry, const char * alias)
  11358. {
  11359. if (!queryRegistry || !alias)
  11360. return NULL;
  11361. StringBuffer xpath;
  11362. unsigned cnt = 0;
  11363. StringBuffer lc(alias);
  11364. const char * search = lc.toLowerCase().str();
  11365. for (;;)
  11366. {
  11367. xpath.set("Alias[@name='").append(search).append("']/@id");
  11368. const char * queryId = queryRegistry->queryProp(xpath);
  11369. if (!queryId)
  11370. break;
  11371. //Check for too many alias indirections.
  11372. if (cnt++ > 10)
  11373. return NULL;
  11374. search = lc.set(queryId).toLowerCase().str();
  11375. }
  11376. return getQueryById(queryRegistry, search);
  11377. }
  11378. extern WORKUNIT_API IPropertyTree * resolveQueryAlias(const char *queryset, const char *alias, bool readonly)
  11379. {
  11380. Owned<IPropertyTree> queryRegistry = getQueryRegistry(queryset, readonly);
  11381. return resolveQueryAlias(queryRegistry, alias);
  11382. }
  11383. void setQuerySuspendedState(IPropertyTree * queryRegistry, const char *id, bool suspend, const char *userid)
  11384. {
  11385. StringBuffer lcId(id);
  11386. lcId.toLowerCase();
  11387. StringBuffer xpath;
  11388. xpath.append("Query[@id=\"").append(lcId).append("\"]");
  11389. IPropertyTree *tree = queryRegistry->queryPropTree(xpath);
  11390. if (tree)
  11391. {
  11392. if (tree->getPropBool("@suspended", false) == suspend)
  11393. return;
  11394. if (suspend)
  11395. {
  11396. tree->addPropBool("@suspended", true);
  11397. if (userid && *userid)
  11398. tree->addProp("@suspendedBy", userid);
  11399. }
  11400. else
  11401. {
  11402. tree->removeProp("@suspended");
  11403. tree->removeProp("@suspendedBy");
  11404. }
  11405. }
  11406. else
  11407. throw MakeStringException((suspend)? QUERRREG_SUSPEND : QUERRREG_UNSUSPEND, "Modifying query suspended state failed. Could not find query %s", id);
  11408. }
  11409. void setQueryCommentForNamedQuery(IPropertyTree * queryRegistry, const char *id, const char *queryComment)
  11410. {
  11411. if (queryComment)
  11412. {
  11413. StringBuffer lcId(id);
  11414. lcId.toLowerCase();
  11415. StringBuffer xpath;
  11416. xpath.append("Query[@id=\"").append(lcId).append("\"]");
  11417. IPropertyTree *tree = queryRegistry->queryPropTree(xpath);
  11418. if (tree)
  11419. tree->setProp("@queryComment", queryComment);
  11420. else
  11421. throw MakeStringException(QUERRREG_COMMENT, "Could not find query %s", id);
  11422. }
  11423. }
  11424. extern WORKUNIT_API IPropertyTree * getQueryRegistryRoot()
  11425. {
  11426. Owned<IRemoteConnection> conn = querySDS().connect("/QuerySets", myProcessSession(), RTM_LOCK_READ, SDS_LOCK_TIMEOUT);
  11427. if (conn)
  11428. return conn->getRoot();
  11429. else
  11430. return NULL;
  11431. }
  11432. extern WORKUNIT_API void checkAddLibrariesToQueryEntry(IPropertyTree *queryTree, IConstWULibraryIterator *libraries)
  11433. {
  11434. if (!queryTree || !libraries)
  11435. return;
  11436. if (queryTree->hasProp("@libCount")) //already added
  11437. return;
  11438. unsigned libCount=0;
  11439. ForEach(*libraries)
  11440. {
  11441. IConstWULibrary &library = libraries->query();
  11442. SCMStringBuffer libname;
  11443. if (!library.getName(libname).length())
  11444. continue;
  11445. queryTree->addProp("Library", libname.str());
  11446. libCount++;
  11447. }
  11448. queryTree->setPropInt("@libCount", libCount);
  11449. }
  11450. extern WORKUNIT_API void checkAddLibrariesToQueryEntry(IPropertyTree *queryTree, IConstWorkUnit *cw)
  11451. {
  11452. Owned<IConstWULibraryIterator> libraries = &cw->getLibraries();
  11453. checkAddLibrariesToQueryEntry(queryTree, libraries);
  11454. }
  11455. extern WORKUNIT_API IPropertyTree * getQueryRegistry(const char * wsEclId, bool readonly)
  11456. {
  11457. //Only lock the branch for the target we're interested in.
  11458. StringBuffer xpath;
  11459. xpath.append("/QuerySets/QuerySet[@id=\"").append(wsEclId).append("\"]");
  11460. Owned<IRemoteConnection> conn = querySDS().connect(xpath.str(), myProcessSession(), readonly ? RTM_LOCK_READ : RTM_LOCK_WRITE, SDS_LOCK_TIMEOUT);
  11461. if (conn)
  11462. return conn->getRoot();
  11463. if (readonly)
  11464. return NULL;
  11465. //Lock the QuerySets in case another thread/client wants to check/add the same QuerySet.
  11466. Owned<IRemoteConnection> globalLock = querySDS().connect("/QuerySets/", myProcessSession(), RTM_LOCK_WRITE|RTM_CREATE_QUERY, SDS_LOCK_TIMEOUT);
  11467. //Re-check if the QuerySet has been added between checking the 1st time and gaining the globalLock.
  11468. conn.setown(querySDS().connect(xpath.str(), myProcessSession(), RTM_LOCK_WRITE, SDS_LOCK_TIMEOUT));
  11469. if (conn)
  11470. return conn->getRoot();
  11471. conn.setown(querySDS().connect("/QuerySets/QuerySet", myProcessSession(), RTM_LOCK_WRITE|RTM_CREATE_ADD, SDS_LOCK_TIMEOUT));
  11472. if (!conn)
  11473. throwUnexpected();
  11474. IPropertyTree * root = conn->queryRoot();
  11475. root->setProp("@id",wsEclId);
  11476. conn->commit();
  11477. return LINK(root);
  11478. }
  11479. IPropertyTree * addNamedPackageSet(IPropertyTree * packageRegistry, const char * name, IPropertyTree *packageInfo, bool overWrite)
  11480. {
  11481. StringBuffer xpath;
  11482. StringBuffer lcName(name);
  11483. lcName.toLowerCase();
  11484. // see if "name" already exists
  11485. xpath.append("Package[@id='").append(name).append("']");
  11486. IPropertyTree *pkgTree = packageRegistry->queryPropTree(xpath.str());
  11487. if (pkgTree)
  11488. {
  11489. if (overWrite)
  11490. packageRegistry->removeTree(pkgTree);
  11491. else
  11492. throw MakeStringException(WUERR_PackageAlreadyExists, "Package name %s already exists, either delete it or specify overwrite",name);
  11493. }
  11494. IPropertyTree *tree = packageRegistry->addPropTree("Package", packageInfo);
  11495. tree->setProp("@id", lcName);
  11496. return tree;
  11497. }
  11498. void removeNamedPackage(IPropertyTree * packageRegistry, const char * id)
  11499. {
  11500. StringBuffer lcId(id);
  11501. lcId.toLowerCase();
  11502. StringBuffer xpath;
  11503. xpath.append("Package[@id=\"").append(lcId).append("\"]");
  11504. packageRegistry->removeProp(xpath);
  11505. }
  11506. extern WORKUNIT_API IPropertyTree * getPackageSetRegistry(const char * wsEclId, bool readonly)
  11507. {
  11508. //Only lock the branch for the target we're interested in.
  11509. StringBuffer xpath;
  11510. xpath.append("/PackageSets/PackageSet[@id=\"").append(wsEclId).append("\"]");
  11511. Owned<IRemoteConnection> conn = querySDS().connect(xpath.str(), myProcessSession(), readonly ? RTM_LOCK_READ : RTM_LOCK_WRITE, SDS_LOCK_TIMEOUT);
  11512. if (conn)
  11513. return conn->getRoot();
  11514. if (readonly)
  11515. return NULL;
  11516. //Lock the PackageSets in case another thread/client wants to check/add the same PackageSet.
  11517. Owned<IRemoteConnection> globalLock = querySDS().connect("/PackageSets/", myProcessSession(), RTM_LOCK_WRITE|RTM_CREATE_QUERY, SDS_LOCK_TIMEOUT);
  11518. //Re-check if the PackageSet has been added between checking the 1st time and gaining the globalLock.
  11519. conn.setown(querySDS().connect(xpath.str(), myProcessSession(), RTM_LOCK_WRITE, SDS_LOCK_TIMEOUT));
  11520. if (conn)
  11521. return conn->getRoot();
  11522. conn.setown(querySDS().connect("/PackageSets/PackageSet", myProcessSession(), RTM_LOCK_WRITE|RTM_CREATE_ADD, SDS_LOCK_TIMEOUT));
  11523. if (!conn)
  11524. throwUnexpected();
  11525. IPropertyTree* root = conn->queryRoot();
  11526. root->setProp("@id",wsEclId);
  11527. conn->commit();
  11528. return LINK(root);
  11529. }
  11530. void addQueryToQuerySet(IWorkUnit *workunit, IPropertyTree *queryRegistry, const char *queryName, WUQueryActivationOptions activateOption, StringBuffer &newQueryId, const char *userid)
  11531. {
  11532. StringBuffer cleanQueryName;
  11533. appendUtf8XmlName(cleanQueryName, strlen(queryName), queryName);
  11534. SCMStringBuffer dllName;
  11535. Owned<IConstWUQuery> q = workunit->getQuery();
  11536. q->getQueryDllName(dllName);
  11537. if (!dllName.length())
  11538. throw MakeStringException(WUERR_InvalidDll, "Cannot deploy query - no associated dll.");
  11539. StringBuffer currentTargetClusterType;
  11540. queryRegistry->getProp("@targetclustertype", currentTargetClusterType);
  11541. SCMStringBuffer targetClusterType;
  11542. workunit->getDebugValue("targetclustertype", targetClusterType);
  11543. SCMStringBuffer snapshot;
  11544. workunit->getSnapshot(snapshot);
  11545. if (currentTargetClusterType.length() < 1)
  11546. {
  11547. queryRegistry->setProp("@targetclustertype", targetClusterType.str());
  11548. }
  11549. else
  11550. {
  11551. if (strcmp(currentTargetClusterType.str(), "roxie") == 0 && strcmp(currentTargetClusterType.str(), targetClusterType.str())!=0)
  11552. {
  11553. throw MakeStringException(WUERR_MismatchClusterType, "TargetClusterTypes of workunit and queryset do not match.");
  11554. }
  11555. }
  11556. IPropertyTree *newEntry = addNamedQuery(queryRegistry, cleanQueryName, workunit->queryWuid(), dllName.str(), isLibrary(workunit), userid, snapshot.str());
  11557. Owned<IConstWULibraryIterator> libraries = &workunit->getLibraries();
  11558. checkAddLibrariesToQueryEntry(newEntry, libraries);
  11559. newQueryId.append(newEntry->queryProp("@id"));
  11560. workunit->setIsQueryService(true); //will check querysets before delete
  11561. workunit->commit();
  11562. activateQuery(queryRegistry, activateOption, queryName, newQueryId, userid);
  11563. }
  11564. void activateQuery(IPropertyTree *queryRegistry, WUQueryActivationOptions activateOption, const char *queryName, const char *queryId, const char *userid)
  11565. {
  11566. StringBuffer cleanQueryName;
  11567. appendUtf8XmlName(cleanQueryName, strlen(queryName), queryName);
  11568. if (activateOption == ACTIVATE_SUSPEND_PREVIOUS|| activateOption == ACTIVATE_DELETE_PREVIOUS)
  11569. {
  11570. Owned<IPropertyTree> prevQuery = resolveQueryAlias(queryRegistry, cleanQueryName);
  11571. setQueryAlias(queryRegistry, cleanQueryName, queryId);
  11572. if (prevQuery && !streq(queryId, prevQuery->queryProp("@id")))
  11573. {
  11574. if (activateOption == ACTIVATE_SUSPEND_PREVIOUS)
  11575. setQuerySuspendedState(queryRegistry, prevQuery->queryProp("@id"), true, userid);
  11576. else
  11577. removeNamedQuery(queryRegistry, prevQuery->queryProp("@id"));
  11578. }
  11579. }
  11580. else if (activateOption == MAKE_ACTIVATE || activateOption == MAKE_ACTIVATE_LOAD_DATA_ONLY)
  11581. setQueryAlias(queryRegistry, cleanQueryName, queryId);
  11582. }
  11583. void addQueryToQuerySet(IWorkUnit *workunit, const char *querySetName, const char *queryName, WUQueryActivationOptions activateOption, StringBuffer &newQueryId, const char *userid)
  11584. {
  11585. Owned<IPropertyTree> queryRegistry = getQueryRegistry(querySetName, false);
  11586. addQueryToQuerySet(workunit, queryRegistry, queryName, activateOption, newQueryId, userid);
  11587. }
  11588. bool removeQuerySetAlias(const char *querySetName, const char *alias)
  11589. {
  11590. Owned<IPropertyTree> queryRegistry = getQueryRegistry(querySetName, true);
  11591. StringBuffer xpath;
  11592. xpath.appendf("Alias[@name='%s']", alias);
  11593. IPropertyTree *t = queryRegistry->queryPropTree(xpath);
  11594. return queryRegistry->removeTree(t);
  11595. }
  11596. void addQuerySetAlias(const char *querySetName, const char *alias, const char *id)
  11597. {
  11598. Owned<IPropertyTree> queryRegistry = getQueryRegistry(querySetName, false);
  11599. setQueryAlias(queryRegistry, alias, id);
  11600. }
  11601. void setSuspendQuerySetQuery(const char *querySetName, const char *id, bool suspend, const char *userid)
  11602. {
  11603. Owned<IPropertyTree> queryRegistry = getQueryRegistry(querySetName, true);
  11604. setQuerySuspendedState(queryRegistry, id, suspend, userid);
  11605. }
  11606. void deleteQuerySetQuery(const char *querySetName, const char *id)
  11607. {
  11608. Owned<IPropertyTree> queryRegistry = getQueryRegistry(querySetName, true);
  11609. removeNamedQuery(queryRegistry, id);
  11610. }
  11611. void removeQuerySetAliasesFromNamedQuery(const char *querySetName, const char * id)
  11612. {
  11613. Owned<IPropertyTree> queryRegistry = getQueryRegistry(querySetName, true);
  11614. clearAliases(queryRegistry, id);
  11615. }
  11616. void setQueryCommentForNamedQuery(const char *querySetName, const char *id, const char *queryComment)
  11617. {
  11618. Owned<IPropertyTree> queryRegistry = getQueryRegistry(querySetName, true);
  11619. setQueryCommentForNamedQuery(queryRegistry, id, queryComment);
  11620. }
  11621. const char *queryIdFromQuerySetWuid(IPropertyTree *queryRegistry, const char *wuid, const char *queryName, IStringVal &id)
  11622. {
  11623. if (!queryRegistry)
  11624. return NULL;
  11625. StringBuffer xpath;
  11626. xpath.appendf("Query[@wuid='%s']", wuid);
  11627. if (queryName && *queryName)
  11628. xpath.appendf("[@name='%s']", queryName);
  11629. IPropertyTree *q = queryRegistry->queryPropTree(xpath.str());
  11630. if (q)
  11631. {
  11632. id.set(q->queryProp("@id"));
  11633. }
  11634. return id.str();
  11635. }
  11636. const char *queryIdFromQuerySetWuid(const char *querySetName, const char *wuid, const char *queryName, IStringVal &id)
  11637. {
  11638. Owned<IPropertyTree> queryRegistry = getQueryRegistry(querySetName, true);
  11639. return queryIdFromQuerySetWuid(queryRegistry, wuid, queryName, id);
  11640. }
  11641. extern WORKUNIT_API void gatherLibraryNames(StringArray &names, StringArray &unresolved, IWorkUnitFactory &workunitFactory, IConstWorkUnit &cw, IPropertyTree *queryset)
  11642. {
  11643. Owned<IConstWULibraryIterator> wulibraries = &cw.getLibraries();
  11644. ForEach(*wulibraries)
  11645. {
  11646. SCMStringBuffer libname;
  11647. IConstWULibrary &wulibrary = wulibraries->query();
  11648. wulibrary.getName(libname);
  11649. if (names.contains(libname.str()) || unresolved.contains(libname.str()))
  11650. continue;
  11651. Owned<IPropertyTree> query = resolveQueryAlias(queryset, libname.str());
  11652. if (query && query->getPropBool("@isLibrary"))
  11653. {
  11654. const char *wuid = query->queryProp("@wuid");
  11655. Owned<IConstWorkUnit> libcw = workunitFactory.openWorkUnit(wuid);
  11656. if (libcw)
  11657. {
  11658. names.appendUniq(libname.str());
  11659. gatherLibraryNames(names, unresolved, workunitFactory, *libcw, queryset);
  11660. continue;
  11661. }
  11662. }
  11663. unresolved.appendUniq(libname.str());
  11664. }
  11665. }
  11666. bool looksLikeAWuid(const char * wuid, const char firstChar)
  11667. {
  11668. if (!wuid)
  11669. return false;
  11670. if (wuid[0] != firstChar)
  11671. return false;
  11672. if (!isdigit(wuid[1]) || !isdigit(wuid[2]) || !isdigit(wuid[3]) || !isdigit(wuid[4]))
  11673. return false;
  11674. if (!isdigit(wuid[5]) || !isdigit(wuid[6]) || !isdigit(wuid[7]) || !isdigit(wuid[8]))
  11675. return false;
  11676. return (wuid[9]=='-');
  11677. }
  11678. IPropertyTree * resolveDefinitionInArchive(IPropertyTree * archive, const char * path)
  11679. {
  11680. IPropertyTree * module = archive;
  11681. const char * dot = strrchr(path, '.');
  11682. StringBuffer xpath;
  11683. if (dot)
  11684. {
  11685. xpath.clear().append("Module[@key='").appendLower(dot-path, path).append("']");
  11686. module = archive->queryPropTree(xpath);
  11687. path = dot+1;
  11688. }
  11689. else
  11690. module = archive->queryPropTree("Module[@key='']");
  11691. if (!module)
  11692. return NULL;
  11693. xpath.clear().append("Attribute[@key='").appendLower(strlen(path), path).append("']");
  11694. return module->queryPropTree(xpath);
  11695. }
  11696. extern WORKUNIT_API void associateLocalFile(IWUQuery * query, WUFileType type, const char * name, const char * description, unsigned crc, unsigned minActivity, unsigned maxActivity)
  11697. {
  11698. StringBuffer hostname;
  11699. queryHostIP().getIpText(hostname);
  11700. StringBuffer fullPathname;
  11701. makeAbsolutePath(name, fullPathname);
  11702. query->addAssociatedFile(type, fullPathname, hostname, description, crc, minActivity, maxActivity);
  11703. }
  11704. extern WORKUNIT_API void descheduleWorkunit(char const * wuid)
  11705. {
  11706. Owned<IWorkUnitFactory> factory = getWorkUnitFactory();
  11707. Owned<IWorkUnit> workunit = factory->updateWorkUnit(wuid);
  11708. if(workunit)
  11709. workunit->deschedule();
  11710. else
  11711. doDescheduleWorkkunit(wuid);
  11712. }
  11713. extern WORKUNIT_API void updateWorkunitStat(IWorkUnit * wu, StatisticScopeType scopeType, const char * scope, StatisticKind kind, const char * description, unsigned __int64 value, unsigned wfid)
  11714. {
  11715. StringBuffer scopestr;
  11716. if (wfid && scope && *scope)
  11717. scopestr.append(WorkflowScopePrefix).append(wfid).append(":").append(scope);
  11718. else
  11719. scopestr.set(scope);
  11720. wu->setStatistic(queryStatisticsComponentType(), queryStatisticsComponentName(), scopeType, scopestr, kind, description, value, 1, 0, StatsMergeReplace);
  11721. }
  11722. class WuTimingUpdater : implements ITimeReportInfo
  11723. {
  11724. public:
  11725. WuTimingUpdater(IWorkUnit * _wu, StatisticScopeType _scopeType, StatisticKind _kind)
  11726. : wu(_wu), scopeType(_scopeType), kind(_kind)
  11727. { }
  11728. virtual void report(const char * scope, const __int64 totaltime, const __int64 maxtime, const unsigned count)
  11729. {
  11730. wu->setStatistic(queryStatisticsComponentType(), queryStatisticsComponentName(), scopeType, scope, kind, nullptr, totaltime, count, maxtime, StatsMergeReplace);
  11731. }
  11732. protected:
  11733. IWorkUnit * wu;
  11734. StatisticScopeType scopeType;
  11735. StatisticKind kind;
  11736. };
  11737. extern WORKUNIT_API void updateWorkunitTimings(IWorkUnit * wu, ITimeReporter *timer)
  11738. {
  11739. WuTimingUpdater target(wu, SSTsection, StTimeTotalExecute);
  11740. timer->report(target);
  11741. }
  11742. extern WORKUNIT_API void updateWorkunitTimings(IWorkUnit * wu, StatisticScopeType scopeType, StatisticKind kind, ITimeReporter *timer)
  11743. {
  11744. WuTimingUpdater target(wu, scopeType, kind);
  11745. timer->report(target);
  11746. }
  11747. extern WORKUNIT_API void addTimeStamp(IWorkUnit * wu, StatisticScopeType scopeType, const char * scope, StatisticKind kind, unsigned wfid)
  11748. {
  11749. StringBuffer scopestr;
  11750. if (wfid && scope && *scope)
  11751. scopestr.append(WorkflowScopePrefix).append(wfid).append(":").append(scope);
  11752. else
  11753. scopestr.set(scope);
  11754. wu->setStatistic(queryStatisticsComponentType(), queryStatisticsComponentName(), scopeType, scopestr, kind, NULL, getTimeStampNowValue(), 1, 0, StatsMergeAppend);
  11755. }
  11756. void aggregateStatistic(StatsAggregation & result, IConstWorkUnit * wu, const WuScopeFilter & filter, StatisticKind search)
  11757. {
  11758. SimpleReferenceAggregator aggregator(search, result);
  11759. Owned<IConstWUScopeIterator> it = &wu->getScopeIterator(filter);
  11760. ForEach(*it)
  11761. it->playProperties(aggregator);
  11762. }
  11763. class GlobalStatisticGatherer : public CInterfaceOf<IStatisticGatherer>
  11764. {
  11765. public:
  11766. GlobalStatisticGatherer(IWorkUnit * _wu) : wu(_wu) {}
  11767. virtual void beginScope(const StatsScopeId & id)
  11768. {
  11769. prevLenStack.append(scope.length());
  11770. if (scope.length())
  11771. scope.append(":");
  11772. id.getScopeText(scope);
  11773. scopeTypeStack.append(id.queryScopeType());
  11774. }
  11775. virtual void beginSubGraphScope(unsigned id)
  11776. {
  11777. StatsScopeId scopeId(SSTsubgraph, id);
  11778. beginScope(scopeId);
  11779. }
  11780. virtual void beginActivityScope(unsigned id)
  11781. {
  11782. StatsScopeId scopeId(SSTactivity, id);
  11783. beginScope(scopeId);
  11784. }
  11785. virtual void beginEdgeScope(unsigned id, unsigned oid)
  11786. {
  11787. StatsScopeId scopeId(SSTedge, id, oid);
  11788. beginScope(scopeId);
  11789. }
  11790. virtual void beginChildGraphScope(unsigned id)
  11791. {
  11792. StatsScopeId scopeId(SSTchildgraph, id);
  11793. beginScope(scopeId);
  11794. }
  11795. virtual void endScope()
  11796. {
  11797. scope.setLength(prevLenStack.popGet());
  11798. scopeTypeStack.pop();
  11799. }
  11800. virtual void addStatistic(StatisticKind kind, unsigned __int64 value)
  11801. {
  11802. StatisticScopeType scopeType = scopeTypeStack.ordinality() ? (StatisticScopeType)scopeTypeStack.tos() : SSTglobal;
  11803. wu->setStatistic(queryStatisticsComponentType(), queryStatisticsComponentName(), scopeType, scope, kind, NULL, value, 1, 0, StatsMergeAppend);
  11804. }
  11805. virtual void updateStatistic(StatisticKind kind, unsigned __int64 value, StatsMergeAction mergeAction)
  11806. {
  11807. StatisticScopeType scopeType = scopeTypeStack.ordinality() ? (StatisticScopeType)scopeTypeStack.tos() : SSTglobal;
  11808. wu->setStatistic(queryStatisticsComponentType(), queryStatisticsComponentName(), scopeType, scope, kind, NULL, value, 1, 0, mergeAction);
  11809. }
  11810. virtual IStatisticCollection * getResult()
  11811. {
  11812. return NULL;
  11813. }
  11814. protected:
  11815. Linked<IWorkUnit> wu;
  11816. StringBuffer scope;
  11817. UnsignedArray prevLenStack;
  11818. UnsignedArray scopeTypeStack;
  11819. };
  11820. IStatisticGatherer * createGlobalStatisticGatherer(IWorkUnit * wu)
  11821. {
  11822. return new GlobalStatisticGatherer(wu);
  11823. }
  11824. extern WORKUNIT_API IPropertyTree * getWUGraphProgress(const char * wuid, bool readonly)
  11825. {
  11826. if (!wuid || !*wuid)
  11827. return NULL;
  11828. VStringBuffer path("/GraphProgress/%s", wuid);
  11829. Owned<IRemoteConnection> conn = querySDS().connect(path.str(),myProcessSession(),readonly ? RTM_LOCK_READ : RTM_LOCK_WRITE, SDS_LOCK_TIMEOUT);
  11830. if (conn)
  11831. return conn->getRoot();
  11832. else
  11833. return NULL;
  11834. }
  11835. void addWorkunitException(IWorkUnit * wu, IError * error, bool removeTimeStamp)
  11836. {
  11837. ErrorSeverity wuSeverity = SeverityInformation;
  11838. ErrorSeverity severity = error->getSeverity();
  11839. switch (severity)
  11840. {
  11841. case SeverityIgnore:
  11842. return;
  11843. case SeverityInformation:
  11844. break;
  11845. case SeverityWarning:
  11846. wuSeverity = SeverityWarning;
  11847. break;
  11848. case SeverityError:
  11849. case SeverityFatal:
  11850. wuSeverity = SeverityError;
  11851. break;
  11852. }
  11853. Owned<IWUException> exception = wu->createException();
  11854. exception->setSeverity(wuSeverity);
  11855. StringBuffer msg;
  11856. exception->setExceptionCode(error->errorCode());
  11857. exception->setExceptionMessage(error->errorMessage(msg).str());
  11858. const char * source = queryCreatorTypeName(queryStatisticsComponentType());
  11859. exception->setExceptionSource(source);
  11860. exception->setExceptionFileName(error->getFilename());
  11861. exception->setExceptionLineNo(error->getLine());
  11862. exception->setExceptionColumn(error->getColumn());
  11863. if (removeTimeStamp)
  11864. exception->setTimeStamp(nullptr);
  11865. if (error->getActivity())
  11866. exception->setActivityId(error->getActivity());
  11867. if (error->queryScope())
  11868. exception->setScope(error->queryScope());
  11869. }
  11870. IError * WorkUnitErrorReceiver::mapError(IError * error)
  11871. {
  11872. return LINK(error);
  11873. }
  11874. void WorkUnitErrorReceiver::report(IError* eclError)
  11875. {
  11876. addWorkunitException(wu, eclError, removeTimeStamp);
  11877. }
  11878. size32_t WorkUnitErrorReceiver::errCount()
  11879. {
  11880. unsigned count = 0;
  11881. Owned<IConstWUExceptionIterator> exceptions = &wu->getExceptions();
  11882. ForEach(*exceptions)
  11883. if (exceptions->query().getSeverity() == SeverityError)
  11884. count++;
  11885. return count;
  11886. }
  11887. size32_t WorkUnitErrorReceiver::warnCount()
  11888. {
  11889. unsigned count = 0;
  11890. Owned<IConstWUExceptionIterator> exceptions = &wu->getExceptions();
  11891. ForEach(*exceptions)
  11892. if (exceptions->query().getSeverity() == SeverityWarning)
  11893. count++;
  11894. return count;
  11895. }
  11896. bool isValidPriorityValue(const char *priority)
  11897. {
  11898. if (isEmptyString(priority))
  11899. return false;
  11900. if (strieq("SLA", priority) || strieq("LOW", priority) || strieq("HIGH", priority) || strieq("NONE", priority))
  11901. return true;
  11902. return false;
  11903. }
  11904. bool isValidMemoryValue(const char *memoryUnit)
  11905. {
  11906. if (isEmptyString(memoryUnit) || !isdigit(*memoryUnit))
  11907. return false;
  11908. while (isdigit(*++memoryUnit));
  11909. if (!*memoryUnit)
  11910. return true;
  11911. switch (toupper(*memoryUnit++))
  11912. {
  11913. case 'E':
  11914. case 'P':
  11915. case 'T':
  11916. case 'G':
  11917. case 'M':
  11918. case 'K':
  11919. if (!*memoryUnit || strieq("B", memoryUnit))
  11920. return true;
  11921. break;
  11922. case 'B':
  11923. if (!*memoryUnit)
  11924. return true;
  11925. break;
  11926. }
  11927. return false;
  11928. }