api de gestion de ticket, basé sur php-crud-api. Le but est de décorrélé les outils de gestion des données, afin
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

api.php 418KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245
  1. <?php
  2. /**
  3. * PHP-CRUD-API v2 License: MIT
  4. * Maurits van der Schee: maurits@vdschee.nl
  5. * https://github.com/mevdschee/php-crud-api
  6. *
  7. * Dependencies:
  8. * - vendor/psr/*: PHP-FIG
  9. * https://github.com/php-fig
  10. * - vendor/nyholm/*: Tobias Nyholm
  11. * https://github.com/Nyholm
  12. **/
  13. // file: vendor/psr/http-factory/src/RequestFactoryInterface.php
  14. namespace Psr\Http\Message {
  15. interface RequestFactoryInterface
  16. {
  17. /**
  18. * Create a new request.
  19. *
  20. * @param string $method The HTTP method associated with the request.
  21. * @param UriInterface|string $uri The URI associated with the request. If
  22. * the value is a string, the factory MUST create a UriInterface
  23. * instance based on it.
  24. *
  25. * @return RequestInterface
  26. */
  27. public function createRequest(string $method, $uri): RequestInterface;
  28. }
  29. }
  30. // file: vendor/psr/http-factory/src/ResponseFactoryInterface.php
  31. namespace Psr\Http\Message {
  32. interface ResponseFactoryInterface
  33. {
  34. /**
  35. * Create a new response.
  36. *
  37. * @param int $code HTTP status code; defaults to 200
  38. * @param string $reasonPhrase Reason phrase to associate with status code
  39. * in generated response; if none is provided implementations MAY use
  40. * the defaults as suggested in the HTTP specification.
  41. *
  42. * @return ResponseInterface
  43. */
  44. public function createResponse(int $code = 200, string $reasonPhrase = ''): ResponseInterface;
  45. }
  46. }
  47. // file: vendor/psr/http-factory/src/ServerRequestFactoryInterface.php
  48. namespace Psr\Http\Message {
  49. interface ServerRequestFactoryInterface
  50. {
  51. /**
  52. * Create a new server request.
  53. *
  54. * Note that server-params are taken precisely as given - no parsing/processing
  55. * of the given values is performed, and, in particular, no attempt is made to
  56. * determine the HTTP method or URI, which must be provided explicitly.
  57. *
  58. * @param string $method The HTTP method associated with the request.
  59. * @param UriInterface|string $uri The URI associated with the request. If
  60. * the value is a string, the factory MUST create a UriInterface
  61. * instance based on it.
  62. * @param array $serverParams Array of SAPI parameters with which to seed
  63. * the generated request instance.
  64. *
  65. * @return ServerRequestInterface
  66. */
  67. public function createServerRequest(string $method, $uri, array $serverParams = []): ServerRequestInterface;
  68. }
  69. }
  70. // file: vendor/psr/http-factory/src/StreamFactoryInterface.php
  71. namespace Psr\Http\Message {
  72. interface StreamFactoryInterface
  73. {
  74. /**
  75. * Create a new stream from a string.
  76. *
  77. * The stream SHOULD be created with a temporary resource.
  78. *
  79. * @param string $content String content with which to populate the stream.
  80. *
  81. * @return StreamInterface
  82. */
  83. public function createStream(string $content = ''): StreamInterface;
  84. /**
  85. * Create a stream from an existing file.
  86. *
  87. * The file MUST be opened using the given mode, which may be any mode
  88. * supported by the `fopen` function.
  89. *
  90. * The `$filename` MAY be any string supported by `fopen()`.
  91. *
  92. * @param string $filename Filename or stream URI to use as basis of stream.
  93. * @param string $mode Mode with which to open the underlying filename/stream.
  94. *
  95. * @return StreamInterface
  96. * @throws \RuntimeException If the file cannot be opened.
  97. * @throws \InvalidArgumentException If the mode is invalid.
  98. */
  99. public function createStreamFromFile(string $filename, string $mode = 'r'): StreamInterface;
  100. /**
  101. * Create a new stream from an existing resource.
  102. *
  103. * The stream MUST be readable and may be writable.
  104. *
  105. * @param resource $resource PHP resource to use as basis of stream.
  106. *
  107. * @return StreamInterface
  108. */
  109. public function createStreamFromResource($resource): StreamInterface;
  110. }
  111. }
  112. // file: vendor/psr/http-factory/src/UploadedFileFactoryInterface.php
  113. namespace Psr\Http\Message {
  114. interface UploadedFileFactoryInterface
  115. {
  116. /**
  117. * Create a new uploaded file.
  118. *
  119. * If a size is not provided it will be determined by checking the size of
  120. * the file.
  121. *
  122. * @see http://php.net/manual/features.file-upload.post-method.php
  123. * @see http://php.net/manual/features.file-upload.errors.php
  124. *
  125. * @param StreamInterface $stream Underlying stream representing the
  126. * uploaded file content.
  127. * @param int $size in bytes
  128. * @param int $error PHP file upload error
  129. * @param string $clientFilename Filename as provided by the client, if any.
  130. * @param string $clientMediaType Media type as provided by the client, if any.
  131. *
  132. * @return UploadedFileInterface
  133. *
  134. * @throws \InvalidArgumentException If the file resource is not readable.
  135. */
  136. public function createUploadedFile(
  137. StreamInterface $stream,
  138. int $size = null,
  139. int $error = \UPLOAD_ERR_OK,
  140. string $clientFilename = null,
  141. string $clientMediaType = null
  142. ): UploadedFileInterface;
  143. }
  144. }
  145. // file: vendor/psr/http-factory/src/UriFactoryInterface.php
  146. namespace Psr\Http\Message {
  147. interface UriFactoryInterface
  148. {
  149. /**
  150. * Create a new URI.
  151. *
  152. * @param string $uri
  153. *
  154. * @return UriInterface
  155. *
  156. * @throws \InvalidArgumentException If the given URI cannot be parsed.
  157. */
  158. public function createUri(string $uri = ''): UriInterface;
  159. }
  160. }
  161. // file: vendor/psr/http-message/src/MessageInterface.php
  162. namespace Psr\Http\Message {
  163. /**
  164. * HTTP messages consist of requests from a client to a server and responses
  165. * from a server to a client. This interface defines the methods common to
  166. * each.
  167. *
  168. * Messages are considered immutable; all methods that might change state MUST
  169. * be implemented such that they retain the internal state of the current
  170. * message and return an instance that contains the changed state.
  171. *
  172. * @link http://www.ietf.org/rfc/rfc7230.txt
  173. * @link http://www.ietf.org/rfc/rfc7231.txt
  174. */
  175. interface MessageInterface
  176. {
  177. /**
  178. * Retrieves the HTTP protocol version as a string.
  179. *
  180. * The string MUST contain only the HTTP version number (e.g., "1.1", "1.0").
  181. *
  182. * @return string HTTP protocol version.
  183. */
  184. public function getProtocolVersion();
  185. /**
  186. * Return an instance with the specified HTTP protocol version.
  187. *
  188. * The version string MUST contain only the HTTP version number (e.g.,
  189. * "1.1", "1.0").
  190. *
  191. * This method MUST be implemented in such a way as to retain the
  192. * immutability of the message, and MUST return an instance that has the
  193. * new protocol version.
  194. *
  195. * @param string $version HTTP protocol version
  196. * @return static
  197. */
  198. public function withProtocolVersion($version);
  199. /**
  200. * Retrieves all message header values.
  201. *
  202. * The keys represent the header name as it will be sent over the wire, and
  203. * each value is an array of strings associated with the header.
  204. *
  205. * // Represent the headers as a string
  206. * foreach ($message->getHeaders() as $name => $values) {
  207. * echo $name . ": " . implode(", ", $values);
  208. * }
  209. *
  210. * // Emit headers iteratively:
  211. * foreach ($message->getHeaders() as $name => $values) {
  212. * foreach ($values as $value) {
  213. * header(sprintf('%s: %s', $name, $value), false);
  214. * }
  215. * }
  216. *
  217. * While header names are not case-sensitive, getHeaders() will preserve the
  218. * exact case in which headers were originally specified.
  219. *
  220. * @return string[][] Returns an associative array of the message's headers. Each
  221. * key MUST be a header name, and each value MUST be an array of strings
  222. * for that header.
  223. */
  224. public function getHeaders();
  225. /**
  226. * Checks if a header exists by the given case-insensitive name.
  227. *
  228. * @param string $name Case-insensitive header field name.
  229. * @return bool Returns true if any header names match the given header
  230. * name using a case-insensitive string comparison. Returns false if
  231. * no matching header name is found in the message.
  232. */
  233. public function hasHeader($name);
  234. /**
  235. * Retrieves a message header value by the given case-insensitive name.
  236. *
  237. * This method returns an array of all the header values of the given
  238. * case-insensitive header name.
  239. *
  240. * If the header does not appear in the message, this method MUST return an
  241. * empty array.
  242. *
  243. * @param string $name Case-insensitive header field name.
  244. * @return string[] An array of string values as provided for the given
  245. * header. If the header does not appear in the message, this method MUST
  246. * return an empty array.
  247. */
  248. public function getHeader($name);
  249. /**
  250. * Retrieves a comma-separated string of the values for a single header.
  251. *
  252. * This method returns all of the header values of the given
  253. * case-insensitive header name as a string concatenated together using
  254. * a comma.
  255. *
  256. * NOTE: Not all header values may be appropriately represented using
  257. * comma concatenation. For such headers, use getHeader() instead
  258. * and supply your own delimiter when concatenating.
  259. *
  260. * If the header does not appear in the message, this method MUST return
  261. * an empty string.
  262. *
  263. * @param string $name Case-insensitive header field name.
  264. * @return string A string of values as provided for the given header
  265. * concatenated together using a comma. If the header does not appear in
  266. * the message, this method MUST return an empty string.
  267. */
  268. public function getHeaderLine($name);
  269. /**
  270. * Return an instance with the provided value replacing the specified header.
  271. *
  272. * While header names are case-insensitive, the casing of the header will
  273. * be preserved by this function, and returned from getHeaders().
  274. *
  275. * This method MUST be implemented in such a way as to retain the
  276. * immutability of the message, and MUST return an instance that has the
  277. * new and/or updated header and value.
  278. *
  279. * @param string $name Case-insensitive header field name.
  280. * @param string|string[] $value Header value(s).
  281. * @return static
  282. * @throws \InvalidArgumentException for invalid header names or values.
  283. */
  284. public function withHeader($name, $value);
  285. /**
  286. * Return an instance with the specified header appended with the given value.
  287. *
  288. * Existing values for the specified header will be maintained. The new
  289. * value(s) will be appended to the existing list. If the header did not
  290. * exist previously, it will be added.
  291. *
  292. * This method MUST be implemented in such a way as to retain the
  293. * immutability of the message, and MUST return an instance that has the
  294. * new header and/or value.
  295. *
  296. * @param string $name Case-insensitive header field name to add.
  297. * @param string|string[] $value Header value(s).
  298. * @return static
  299. * @throws \InvalidArgumentException for invalid header names or values.
  300. */
  301. public function withAddedHeader($name, $value);
  302. /**
  303. * Return an instance without the specified header.
  304. *
  305. * Header resolution MUST be done without case-sensitivity.
  306. *
  307. * This method MUST be implemented in such a way as to retain the
  308. * immutability of the message, and MUST return an instance that removes
  309. * the named header.
  310. *
  311. * @param string $name Case-insensitive header field name to remove.
  312. * @return static
  313. */
  314. public function withoutHeader($name);
  315. /**
  316. * Gets the body of the message.
  317. *
  318. * @return StreamInterface Returns the body as a stream.
  319. */
  320. public function getBody();
  321. /**
  322. * Return an instance with the specified message body.
  323. *
  324. * The body MUST be a StreamInterface object.
  325. *
  326. * This method MUST be implemented in such a way as to retain the
  327. * immutability of the message, and MUST return a new instance that has the
  328. * new body stream.
  329. *
  330. * @param StreamInterface $body Body.
  331. * @return static
  332. * @throws \InvalidArgumentException When the body is not valid.
  333. */
  334. public function withBody(StreamInterface $body);
  335. }
  336. }
  337. // file: vendor/psr/http-message/src/RequestInterface.php
  338. namespace Psr\Http\Message {
  339. /**
  340. * Representation of an outgoing, client-side request.
  341. *
  342. * Per the HTTP specification, this interface includes properties for
  343. * each of the following:
  344. *
  345. * - Protocol version
  346. * - HTTP method
  347. * - URI
  348. * - Headers
  349. * - Message body
  350. *
  351. * During construction, implementations MUST attempt to set the Host header from
  352. * a provided URI if no Host header is provided.
  353. *
  354. * Requests are considered immutable; all methods that might change state MUST
  355. * be implemented such that they retain the internal state of the current
  356. * message and return an instance that contains the changed state.
  357. */
  358. interface RequestInterface extends MessageInterface
  359. {
  360. /**
  361. * Retrieves the message's request target.
  362. *
  363. * Retrieves the message's request-target either as it will appear (for
  364. * clients), as it appeared at request (for servers), or as it was
  365. * specified for the instance (see withRequestTarget()).
  366. *
  367. * In most cases, this will be the origin-form of the composed URI,
  368. * unless a value was provided to the concrete implementation (see
  369. * withRequestTarget() below).
  370. *
  371. * If no URI is available, and no request-target has been specifically
  372. * provided, this method MUST return the string "/".
  373. *
  374. * @return string
  375. */
  376. public function getRequestTarget();
  377. /**
  378. * Return an instance with the specific request-target.
  379. *
  380. * If the request needs a non-origin-form request-target — e.g., for
  381. * specifying an absolute-form, authority-form, or asterisk-form —
  382. * this method may be used to create an instance with the specified
  383. * request-target, verbatim.
  384. *
  385. * This method MUST be implemented in such a way as to retain the
  386. * immutability of the message, and MUST return an instance that has the
  387. * changed request target.
  388. *
  389. * @link http://tools.ietf.org/html/rfc7230#section-5.3 (for the various
  390. * request-target forms allowed in request messages)
  391. * @param mixed $requestTarget
  392. * @return static
  393. */
  394. public function withRequestTarget($requestTarget);
  395. /**
  396. * Retrieves the HTTP method of the request.
  397. *
  398. * @return string Returns the request method.
  399. */
  400. public function getMethod();
  401. /**
  402. * Return an instance with the provided HTTP method.
  403. *
  404. * While HTTP method names are typically all uppercase characters, HTTP
  405. * method names are case-sensitive and thus implementations SHOULD NOT
  406. * modify the given string.
  407. *
  408. * This method MUST be implemented in such a way as to retain the
  409. * immutability of the message, and MUST return an instance that has the
  410. * changed request method.
  411. *
  412. * @param string $method Case-sensitive method.
  413. * @return static
  414. * @throws \InvalidArgumentException for invalid HTTP methods.
  415. */
  416. public function withMethod($method);
  417. /**
  418. * Retrieves the URI instance.
  419. *
  420. * This method MUST return a UriInterface instance.
  421. *
  422. * @link http://tools.ietf.org/html/rfc3986#section-4.3
  423. * @return UriInterface Returns a UriInterface instance
  424. * representing the URI of the request.
  425. */
  426. public function getUri();
  427. /**
  428. * Returns an instance with the provided URI.
  429. *
  430. * This method MUST update the Host header of the returned request by
  431. * default if the URI contains a host component. If the URI does not
  432. * contain a host component, any pre-existing Host header MUST be carried
  433. * over to the returned request.
  434. *
  435. * You can opt-in to preserving the original state of the Host header by
  436. * setting `$preserveHost` to `true`. When `$preserveHost` is set to
  437. * `true`, this method interacts with the Host header in the following ways:
  438. *
  439. * - If the Host header is missing or empty, and the new URI contains
  440. * a host component, this method MUST update the Host header in the returned
  441. * request.
  442. * - If the Host header is missing or empty, and the new URI does not contain a
  443. * host component, this method MUST NOT update the Host header in the returned
  444. * request.
  445. * - If a Host header is present and non-empty, this method MUST NOT update
  446. * the Host header in the returned request.
  447. *
  448. * This method MUST be implemented in such a way as to retain the
  449. * immutability of the message, and MUST return an instance that has the
  450. * new UriInterface instance.
  451. *
  452. * @link http://tools.ietf.org/html/rfc3986#section-4.3
  453. * @param UriInterface $uri New request URI to use.
  454. * @param bool $preserveHost Preserve the original state of the Host header.
  455. * @return static
  456. */
  457. public function withUri(UriInterface $uri, $preserveHost = false);
  458. }
  459. }
  460. // file: vendor/psr/http-message/src/ResponseInterface.php
  461. namespace Psr\Http\Message {
  462. /**
  463. * Representation of an outgoing, server-side response.
  464. *
  465. * Per the HTTP specification, this interface includes properties for
  466. * each of the following:
  467. *
  468. * - Protocol version
  469. * - Status code and reason phrase
  470. * - Headers
  471. * - Message body
  472. *
  473. * Responses are considered immutable; all methods that might change state MUST
  474. * be implemented such that they retain the internal state of the current
  475. * message and return an instance that contains the changed state.
  476. */
  477. interface ResponseInterface extends MessageInterface
  478. {
  479. /**
  480. * Gets the response status code.
  481. *
  482. * The status code is a 3-digit integer result code of the server's attempt
  483. * to understand and satisfy the request.
  484. *
  485. * @return int Status code.
  486. */
  487. public function getStatusCode();
  488. /**
  489. * Return an instance with the specified status code and, optionally, reason phrase.
  490. *
  491. * If no reason phrase is specified, implementations MAY choose to default
  492. * to the RFC 7231 or IANA recommended reason phrase for the response's
  493. * status code.
  494. *
  495. * This method MUST be implemented in such a way as to retain the
  496. * immutability of the message, and MUST return an instance that has the
  497. * updated status and reason phrase.
  498. *
  499. * @link http://tools.ietf.org/html/rfc7231#section-6
  500. * @link http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
  501. * @param int $code The 3-digit integer result code to set.
  502. * @param string $reasonPhrase The reason phrase to use with the
  503. * provided status code; if none is provided, implementations MAY
  504. * use the defaults as suggested in the HTTP specification.
  505. * @return static
  506. * @throws \InvalidArgumentException For invalid status code arguments.
  507. */
  508. public function withStatus($code, $reasonPhrase = '');
  509. /**
  510. * Gets the response reason phrase associated with the status code.
  511. *
  512. * Because a reason phrase is not a required element in a response
  513. * status line, the reason phrase value MAY be null. Implementations MAY
  514. * choose to return the default RFC 7231 recommended reason phrase (or those
  515. * listed in the IANA HTTP Status Code Registry) for the response's
  516. * status code.
  517. *
  518. * @link http://tools.ietf.org/html/rfc7231#section-6
  519. * @link http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
  520. * @return string Reason phrase; must return an empty string if none present.
  521. */
  522. public function getReasonPhrase();
  523. }
  524. }
  525. // file: vendor/psr/http-message/src/ServerRequestInterface.php
  526. namespace Psr\Http\Message {
  527. /**
  528. * Representation of an incoming, server-side HTTP request.
  529. *
  530. * Per the HTTP specification, this interface includes properties for
  531. * each of the following:
  532. *
  533. * - Protocol version
  534. * - HTTP method
  535. * - URI
  536. * - Headers
  537. * - Message body
  538. *
  539. * Additionally, it encapsulates all data as it has arrived to the
  540. * application from the CGI and/or PHP environment, including:
  541. *
  542. * - The values represented in $_SERVER.
  543. * - Any cookies provided (generally via $_COOKIE)
  544. * - Query string arguments (generally via $_GET, or as parsed via parse_str())
  545. * - Upload files, if any (as represented by $_FILES)
  546. * - Deserialized body parameters (generally from $_POST)
  547. *
  548. * $_SERVER values MUST be treated as immutable, as they represent application
  549. * state at the time of request; as such, no methods are provided to allow
  550. * modification of those values. The other values provide such methods, as they
  551. * can be restored from $_SERVER or the request body, and may need treatment
  552. * during the application (e.g., body parameters may be deserialized based on
  553. * content type).
  554. *
  555. * Additionally, this interface recognizes the utility of introspecting a
  556. * request to derive and match additional parameters (e.g., via URI path
  557. * matching, decrypting cookie values, deserializing non-form-encoded body
  558. * content, matching authorization headers to users, etc). These parameters
  559. * are stored in an "attributes" property.
  560. *
  561. * Requests are considered immutable; all methods that might change state MUST
  562. * be implemented such that they retain the internal state of the current
  563. * message and return an instance that contains the changed state.
  564. */
  565. interface ServerRequestInterface extends RequestInterface
  566. {
  567. /**
  568. * Retrieve server parameters.
  569. *
  570. * Retrieves data related to the incoming request environment,
  571. * typically derived from PHP's $_SERVER superglobal. The data IS NOT
  572. * REQUIRED to originate from $_SERVER.
  573. *
  574. * @return array
  575. */
  576. public function getServerParams();
  577. /**
  578. * Retrieve cookies.
  579. *
  580. * Retrieves cookies sent by the client to the server.
  581. *
  582. * The data MUST be compatible with the structure of the $_COOKIE
  583. * superglobal.
  584. *
  585. * @return array
  586. */
  587. public function getCookieParams();
  588. /**
  589. * Return an instance with the specified cookies.
  590. *
  591. * The data IS NOT REQUIRED to come from the $_COOKIE superglobal, but MUST
  592. * be compatible with the structure of $_COOKIE. Typically, this data will
  593. * be injected at instantiation.
  594. *
  595. * This method MUST NOT update the related Cookie header of the request
  596. * instance, nor related values in the server params.
  597. *
  598. * This method MUST be implemented in such a way as to retain the
  599. * immutability of the message, and MUST return an instance that has the
  600. * updated cookie values.
  601. *
  602. * @param array $cookies Array of key/value pairs representing cookies.
  603. * @return static
  604. */
  605. public function withCookieParams(array $cookies);
  606. /**
  607. * Retrieve query string arguments.
  608. *
  609. * Retrieves the deserialized query string arguments, if any.
  610. *
  611. * Note: the query params might not be in sync with the URI or server
  612. * params. If you need to ensure you are only getting the original
  613. * values, you may need to parse the query string from `getUri()->getQuery()`
  614. * or from the `QUERY_STRING` server param.
  615. *
  616. * @return array
  617. */
  618. public function getQueryParams();
  619. /**
  620. * Return an instance with the specified query string arguments.
  621. *
  622. * These values SHOULD remain immutable over the course of the incoming
  623. * request. They MAY be injected during instantiation, such as from PHP's
  624. * $_GET superglobal, or MAY be derived from some other value such as the
  625. * URI. In cases where the arguments are parsed from the URI, the data
  626. * MUST be compatible with what PHP's parse_str() would return for
  627. * purposes of how duplicate query parameters are handled, and how nested
  628. * sets are handled.
  629. *
  630. * Setting query string arguments MUST NOT change the URI stored by the
  631. * request, nor the values in the server params.
  632. *
  633. * This method MUST be implemented in such a way as to retain the
  634. * immutability of the message, and MUST return an instance that has the
  635. * updated query string arguments.
  636. *
  637. * @param array $query Array of query string arguments, typically from
  638. * $_GET.
  639. * @return static
  640. */
  641. public function withQueryParams(array $query);
  642. /**
  643. * Retrieve normalized file upload data.
  644. *
  645. * This method returns upload metadata in a normalized tree, with each leaf
  646. * an instance of Psr\Http\Message\UploadedFileInterface.
  647. *
  648. * These values MAY be prepared from $_FILES or the message body during
  649. * instantiation, or MAY be injected via withUploadedFiles().
  650. *
  651. * @return array An array tree of UploadedFileInterface instances; an empty
  652. * array MUST be returned if no data is present.
  653. */
  654. public function getUploadedFiles();
  655. /**
  656. * Create a new instance with the specified uploaded files.
  657. *
  658. * This method MUST be implemented in such a way as to retain the
  659. * immutability of the message, and MUST return an instance that has the
  660. * updated body parameters.
  661. *
  662. * @param array $uploadedFiles An array tree of UploadedFileInterface instances.
  663. * @return static
  664. * @throws \InvalidArgumentException if an invalid structure is provided.
  665. */
  666. public function withUploadedFiles(array $uploadedFiles);
  667. /**
  668. * Retrieve any parameters provided in the request body.
  669. *
  670. * If the request Content-Type is either application/x-www-form-urlencoded
  671. * or multipart/form-data, and the request method is POST, this method MUST
  672. * return the contents of $_POST.
  673. *
  674. * Otherwise, this method may return any results of deserializing
  675. * the request body content; as parsing returns structured content, the
  676. * potential types MUST be arrays or objects only. A null value indicates
  677. * the absence of body content.
  678. *
  679. * @return null|array|object The deserialized body parameters, if any.
  680. * These will typically be an array or object.
  681. */
  682. public function getParsedBody();
  683. /**
  684. * Return an instance with the specified body parameters.
  685. *
  686. * These MAY be injected during instantiation.
  687. *
  688. * If the request Content-Type is either application/x-www-form-urlencoded
  689. * or multipart/form-data, and the request method is POST, use this method
  690. * ONLY to inject the contents of $_POST.
  691. *
  692. * The data IS NOT REQUIRED to come from $_POST, but MUST be the results of
  693. * deserializing the request body content. Deserialization/parsing returns
  694. * structured data, and, as such, this method ONLY accepts arrays or objects,
  695. * or a null value if nothing was available to parse.
  696. *
  697. * As an example, if content negotiation determines that the request data
  698. * is a JSON payload, this method could be used to create a request
  699. * instance with the deserialized parameters.
  700. *
  701. * This method MUST be implemented in such a way as to retain the
  702. * immutability of the message, and MUST return an instance that has the
  703. * updated body parameters.
  704. *
  705. * @param null|array|object $data The deserialized body data. This will
  706. * typically be in an array or object.
  707. * @return static
  708. * @throws \InvalidArgumentException if an unsupported argument type is
  709. * provided.
  710. */
  711. public function withParsedBody($data);
  712. /**
  713. * Retrieve attributes derived from the request.
  714. *
  715. * The request "attributes" may be used to allow injection of any
  716. * parameters derived from the request: e.g., the results of path
  717. * match operations; the results of decrypting cookies; the results of
  718. * deserializing non-form-encoded message bodies; etc. Attributes
  719. * will be application and request specific, and CAN be mutable.
  720. *
  721. * @return array Attributes derived from the request.
  722. */
  723. public function getAttributes();
  724. /**
  725. * Retrieve a single derived request attribute.
  726. *
  727. * Retrieves a single derived request attribute as described in
  728. * getAttributes(). If the attribute has not been previously set, returns
  729. * the default value as provided.
  730. *
  731. * This method obviates the need for a hasAttribute() method, as it allows
  732. * specifying a default value to return if the attribute is not found.
  733. *
  734. * @see getAttributes()
  735. * @param string $name The attribute name.
  736. * @param mixed $default Default value to return if the attribute does not exist.
  737. * @return mixed
  738. */
  739. public function getAttribute($name, $default = null);
  740. /**
  741. * Return an instance with the specified derived request attribute.
  742. *
  743. * This method allows setting a single derived request attribute as
  744. * described in getAttributes().
  745. *
  746. * This method MUST be implemented in such a way as to retain the
  747. * immutability of the message, and MUST return an instance that has the
  748. * updated attribute.
  749. *
  750. * @see getAttributes()
  751. * @param string $name The attribute name.
  752. * @param mixed $value The value of the attribute.
  753. * @return static
  754. */
  755. public function withAttribute($name, $value);
  756. /**
  757. * Return an instance that removes the specified derived request attribute.
  758. *
  759. * This method allows removing a single derived request attribute as
  760. * described in getAttributes().
  761. *
  762. * This method MUST be implemented in such a way as to retain the
  763. * immutability of the message, and MUST return an instance that removes
  764. * the attribute.
  765. *
  766. * @see getAttributes()
  767. * @param string $name The attribute name.
  768. * @return static
  769. */
  770. public function withoutAttribute($name);
  771. }
  772. }
  773. // file: vendor/psr/http-message/src/StreamInterface.php
  774. namespace Psr\Http\Message {
  775. /**
  776. * Describes a data stream.
  777. *
  778. * Typically, an instance will wrap a PHP stream; this interface provides
  779. * a wrapper around the most common operations, including serialization of
  780. * the entire stream to a string.
  781. */
  782. interface StreamInterface
  783. {
  784. /**
  785. * Reads all data from the stream into a string, from the beginning to end.
  786. *
  787. * This method MUST attempt to seek to the beginning of the stream before
  788. * reading data and read the stream until the end is reached.
  789. *
  790. * Warning: This could attempt to load a large amount of data into memory.
  791. *
  792. * This method MUST NOT raise an exception in order to conform with PHP's
  793. * string casting operations.
  794. *
  795. * @see http://php.net/manual/en/language.oop5.magic.php#object.tostring
  796. * @return string
  797. */
  798. public function __toString();
  799. /**
  800. * Closes the stream and any underlying resources.
  801. *
  802. * @return void
  803. */
  804. public function close();
  805. /**
  806. * Separates any underlying resources from the stream.
  807. *
  808. * After the stream has been detached, the stream is in an unusable state.
  809. *
  810. * @return resource|null Underlying PHP stream, if any
  811. */
  812. public function detach();
  813. /**
  814. * Get the size of the stream if known.
  815. *
  816. * @return int|null Returns the size in bytes if known, or null if unknown.
  817. */
  818. public function getSize();
  819. /**
  820. * Returns the current position of the file read/write pointer
  821. *
  822. * @return int Position of the file pointer
  823. * @throws \RuntimeException on error.
  824. */
  825. public function tell();
  826. /**
  827. * Returns true if the stream is at the end of the stream.
  828. *
  829. * @return bool
  830. */
  831. public function eof();
  832. /**
  833. * Returns whether or not the stream is seekable.
  834. *
  835. * @return bool
  836. */
  837. public function isSeekable();
  838. /**
  839. * Seek to a position in the stream.
  840. *
  841. * @link http://www.php.net/manual/en/function.fseek.php
  842. * @param int $offset Stream offset
  843. * @param int $whence Specifies how the cursor position will be calculated
  844. * based on the seek offset. Valid values are identical to the built-in
  845. * PHP $whence values for `fseek()`. SEEK_SET: Set position equal to
  846. * offset bytes SEEK_CUR: Set position to current location plus offset
  847. * SEEK_END: Set position to end-of-stream plus offset.
  848. * @throws \RuntimeException on failure.
  849. */
  850. public function seek($offset, $whence = SEEK_SET);
  851. /**
  852. * Seek to the beginning of the stream.
  853. *
  854. * If the stream is not seekable, this method will raise an exception;
  855. * otherwise, it will perform a seek(0).
  856. *
  857. * @see seek()
  858. * @link http://www.php.net/manual/en/function.fseek.php
  859. * @throws \RuntimeException on failure.
  860. */
  861. public function rewind();
  862. /**
  863. * Returns whether or not the stream is writable.
  864. *
  865. * @return bool
  866. */
  867. public function isWritable();
  868. /**
  869. * Write data to the stream.
  870. *
  871. * @param string $string The string that is to be written.
  872. * @return int Returns the number of bytes written to the stream.
  873. * @throws \RuntimeException on failure.
  874. */
  875. public function write($string);
  876. /**
  877. * Returns whether or not the stream is readable.
  878. *
  879. * @return bool
  880. */
  881. public function isReadable();
  882. /**
  883. * Read data from the stream.
  884. *
  885. * @param int $length Read up to $length bytes from the object and return
  886. * them. Fewer than $length bytes may be returned if underlying stream
  887. * call returns fewer bytes.
  888. * @return string Returns the data read from the stream, or an empty string
  889. * if no bytes are available.
  890. * @throws \RuntimeException if an error occurs.
  891. */
  892. public function read($length);
  893. /**
  894. * Returns the remaining contents in a string
  895. *
  896. * @return string
  897. * @throws \RuntimeException if unable to read or an error occurs while
  898. * reading.
  899. */
  900. public function getContents();
  901. /**
  902. * Get stream metadata as an associative array or retrieve a specific key.
  903. *
  904. * The keys returned are identical to the keys returned from PHP's
  905. * stream_get_meta_data() function.
  906. *
  907. * @link http://php.net/manual/en/function.stream-get-meta-data.php
  908. * @param string $key Specific metadata to retrieve.
  909. * @return array|mixed|null Returns an associative array if no key is
  910. * provided. Returns a specific key value if a key is provided and the
  911. * value is found, or null if the key is not found.
  912. */
  913. public function getMetadata($key = null);
  914. }
  915. }
  916. // file: vendor/psr/http-message/src/UploadedFileInterface.php
  917. namespace Psr\Http\Message {
  918. /**
  919. * Value object representing a file uploaded through an HTTP request.
  920. *
  921. * Instances of this interface are considered immutable; all methods that
  922. * might change state MUST be implemented such that they retain the internal
  923. * state of the current instance and return an instance that contains the
  924. * changed state.
  925. */
  926. interface UploadedFileInterface
  927. {
  928. /**
  929. * Retrieve a stream representing the uploaded file.
  930. *
  931. * This method MUST return a StreamInterface instance, representing the
  932. * uploaded file. The purpose of this method is to allow utilizing native PHP
  933. * stream functionality to manipulate the file upload, such as
  934. * stream_copy_to_stream() (though the result will need to be decorated in a
  935. * native PHP stream wrapper to work with such functions).
  936. *
  937. * If the moveTo() method has been called previously, this method MUST raise
  938. * an exception.
  939. *
  940. * @return StreamInterface Stream representation of the uploaded file.
  941. * @throws \RuntimeException in cases when no stream is available or can be
  942. * created.
  943. */
  944. public function getStream();
  945. /**
  946. * Move the uploaded file to a new location.
  947. *
  948. * Use this method as an alternative to move_uploaded_file(). This method is
  949. * guaranteed to work in both SAPI and non-SAPI environments.
  950. * Implementations must determine which environment they are in, and use the
  951. * appropriate method (move_uploaded_file(), rename(), or a stream
  952. * operation) to perform the operation.
  953. *
  954. * $targetPath may be an absolute path, or a relative path. If it is a
  955. * relative path, resolution should be the same as used by PHP's rename()
  956. * function.
  957. *
  958. * The original file or stream MUST be removed on completion.
  959. *
  960. * If this method is called more than once, any subsequent calls MUST raise
  961. * an exception.
  962. *
  963. * When used in an SAPI environment where $_FILES is populated, when writing
  964. * files via moveTo(), is_uploaded_file() and move_uploaded_file() SHOULD be
  965. * used to ensure permissions and upload status are verified correctly.
  966. *
  967. * If you wish to move to a stream, use getStream(), as SAPI operations
  968. * cannot guarantee writing to stream destinations.
  969. *
  970. * @see http://php.net/is_uploaded_file
  971. * @see http://php.net/move_uploaded_file
  972. * @param string $targetPath Path to which to move the uploaded file.
  973. * @throws \InvalidArgumentException if the $targetPath specified is invalid.
  974. * @throws \RuntimeException on any error during the move operation, or on
  975. * the second or subsequent call to the method.
  976. */
  977. public function moveTo($targetPath);
  978. /**
  979. * Retrieve the file size.
  980. *
  981. * Implementations SHOULD return the value stored in the "size" key of
  982. * the file in the $_FILES array if available, as PHP calculates this based
  983. * on the actual size transmitted.
  984. *
  985. * @return int|null The file size in bytes or null if unknown.
  986. */
  987. public function getSize();
  988. /**
  989. * Retrieve the error associated with the uploaded file.
  990. *
  991. * The return value MUST be one of PHP's UPLOAD_ERR_XXX constants.
  992. *
  993. * If the file was uploaded successfully, this method MUST return
  994. * UPLOAD_ERR_OK.
  995. *
  996. * Implementations SHOULD return the value stored in the "error" key of
  997. * the file in the $_FILES array.
  998. *
  999. * @see http://php.net/manual/en/features.file-upload.errors.php
  1000. * @return int One of PHP's UPLOAD_ERR_XXX constants.
  1001. */
  1002. public function getError();
  1003. /**
  1004. * Retrieve the filename sent by the client.
  1005. *
  1006. * Do not trust the value returned by this method. A client could send
  1007. * a malicious filename with the intention to corrupt or hack your
  1008. * application.
  1009. *
  1010. * Implementations SHOULD return the value stored in the "name" key of
  1011. * the file in the $_FILES array.
  1012. *
  1013. * @return string|null The filename sent by the client or null if none
  1014. * was provided.
  1015. */
  1016. public function getClientFilename();
  1017. /**
  1018. * Retrieve the media type sent by the client.
  1019. *
  1020. * Do not trust the value returned by this method. A client could send
  1021. * a malicious media type with the intention to corrupt or hack your
  1022. * application.
  1023. *
  1024. * Implementations SHOULD return the value stored in the "type" key of
  1025. * the file in the $_FILES array.
  1026. *
  1027. * @return string|null The media type sent by the client or null if none
  1028. * was provided.
  1029. */
  1030. public function getClientMediaType();
  1031. }
  1032. }
  1033. // file: vendor/psr/http-message/src/UriInterface.php
  1034. namespace Psr\Http\Message {
  1035. /**
  1036. * Value object representing a URI.
  1037. *
  1038. * This interface is meant to represent URIs according to RFC 3986 and to
  1039. * provide methods for most common operations. Additional functionality for
  1040. * working with URIs can be provided on top of the interface or externally.
  1041. * Its primary use is for HTTP requests, but may also be used in other
  1042. * contexts.
  1043. *
  1044. * Instances of this interface are considered immutable; all methods that
  1045. * might change state MUST be implemented such that they retain the internal
  1046. * state of the current instance and return an instance that contains the
  1047. * changed state.
  1048. *
  1049. * Typically the Host header will be also be present in the request message.
  1050. * For server-side requests, the scheme will typically be discoverable in the
  1051. * server parameters.
  1052. *
  1053. * @link http://tools.ietf.org/html/rfc3986 (the URI specification)
  1054. */
  1055. interface UriInterface
  1056. {
  1057. /**
  1058. * Retrieve the scheme component of the URI.
  1059. *
  1060. * If no scheme is present, this method MUST return an empty string.
  1061. *
  1062. * The value returned MUST be normalized to lowercase, per RFC 3986
  1063. * Section 3.1.
  1064. *
  1065. * The trailing ":" character is not part of the scheme and MUST NOT be
  1066. * added.
  1067. *
  1068. * @see https://tools.ietf.org/html/rfc3986#section-3.1
  1069. * @return string The URI scheme.
  1070. */
  1071. public function getScheme();
  1072. /**
  1073. * Retrieve the authority component of the URI.
  1074. *
  1075. * If no authority information is present, this method MUST return an empty
  1076. * string.
  1077. *
  1078. * The authority syntax of the URI is:
  1079. *
  1080. * <pre>
  1081. * [user-info@]host[:port]
  1082. * </pre>
  1083. *
  1084. * If the port component is not set or is the standard port for the current
  1085. * scheme, it SHOULD NOT be included.
  1086. *
  1087. * @see https://tools.ietf.org/html/rfc3986#section-3.2
  1088. * @return string The URI authority, in "[user-info@]host[:port]" format.
  1089. */
  1090. public function getAuthority();
  1091. /**
  1092. * Retrieve the user information component of the URI.
  1093. *
  1094. * If no user information is present, this method MUST return an empty
  1095. * string.
  1096. *
  1097. * If a user is present in the URI, this will return that value;
  1098. * additionally, if the password is also present, it will be appended to the
  1099. * user value, with a colon (":") separating the values.
  1100. *
  1101. * The trailing "@" character is not part of the user information and MUST
  1102. * NOT be added.
  1103. *
  1104. * @return string The URI user information, in "username[:password]" format.
  1105. */
  1106. public function getUserInfo();
  1107. /**
  1108. * Retrieve the host component of the URI.
  1109. *
  1110. * If no host is present, this method MUST return an empty string.
  1111. *
  1112. * The value returned MUST be normalized to lowercase, per RFC 3986
  1113. * Section 3.2.2.
  1114. *
  1115. * @see http://tools.ietf.org/html/rfc3986#section-3.2.2
  1116. * @return string The URI host.
  1117. */
  1118. public function getHost();
  1119. /**
  1120. * Retrieve the port component of the URI.
  1121. *
  1122. * If a port is present, and it is non-standard for the current scheme,
  1123. * this method MUST return it as an integer. If the port is the standard port
  1124. * used with the current scheme, this method SHOULD return null.
  1125. *
  1126. * If no port is present, and no scheme is present, this method MUST return
  1127. * a null value.
  1128. *
  1129. * If no port is present, but a scheme is present, this method MAY return
  1130. * the standard port for that scheme, but SHOULD return null.
  1131. *
  1132. * @return null|int The URI port.
  1133. */
  1134. public function getPort();
  1135. /**
  1136. * Retrieve the path component of the URI.
  1137. *
  1138. * The path can either be empty or absolute (starting with a slash) or
  1139. * rootless (not starting with a slash). Implementations MUST support all
  1140. * three syntaxes.
  1141. *
  1142. * Normally, the empty path "" and absolute path "/" are considered equal as
  1143. * defined in RFC 7230 Section 2.7.3. But this method MUST NOT automatically
  1144. * do this normalization because in contexts with a trimmed base path, e.g.
  1145. * the front controller, this difference becomes significant. It's the task
  1146. * of the user to handle both "" and "/".
  1147. *
  1148. * The value returned MUST be percent-encoded, but MUST NOT double-encode
  1149. * any characters. To determine what characters to encode, please refer to
  1150. * RFC 3986, Sections 2 and 3.3.
  1151. *
  1152. * As an example, if the value should include a slash ("/") not intended as
  1153. * delimiter between path segments, that value MUST be passed in encoded
  1154. * form (e.g., "%2F") to the instance.
  1155. *
  1156. * @see https://tools.ietf.org/html/rfc3986#section-2
  1157. * @see https://tools.ietf.org/html/rfc3986#section-3.3
  1158. * @return string The URI path.
  1159. */
  1160. public function getPath();
  1161. /**
  1162. * Retrieve the query string of the URI.
  1163. *
  1164. * If no query string is present, this method MUST return an empty string.
  1165. *
  1166. * The leading "?" character is not part of the query and MUST NOT be
  1167. * added.
  1168. *
  1169. * The value returned MUST be percent-encoded, but MUST NOT double-encode
  1170. * any characters. To determine what characters to encode, please refer to
  1171. * RFC 3986, Sections 2 and 3.4.
  1172. *
  1173. * As an example, if a value in a key/value pair of the query string should
  1174. * include an ampersand ("&") not intended as a delimiter between values,
  1175. * that value MUST be passed in encoded form (e.g., "%26") to the instance.
  1176. *
  1177. * @see https://tools.ietf.org/html/rfc3986#section-2
  1178. * @see https://tools.ietf.org/html/rfc3986#section-3.4
  1179. * @return string The URI query string.
  1180. */
  1181. public function getQuery();
  1182. /**
  1183. * Retrieve the fragment component of the URI.
  1184. *
  1185. * If no fragment is present, this method MUST return an empty string.
  1186. *
  1187. * The leading "#" character is not part of the fragment and MUST NOT be
  1188. * added.
  1189. *
  1190. * The value returned MUST be percent-encoded, but MUST NOT double-encode
  1191. * any characters. To determine what characters to encode, please refer to
  1192. * RFC 3986, Sections 2 and 3.5.
  1193. *
  1194. * @see https://tools.ietf.org/html/rfc3986#section-2
  1195. * @see https://tools.ietf.org/html/rfc3986#section-3.5
  1196. * @return string The URI fragment.
  1197. */
  1198. public function getFragment();
  1199. /**
  1200. * Return an instance with the specified scheme.
  1201. *
  1202. * This method MUST retain the state of the current instance, and return
  1203. * an instance that contains the specified scheme.
  1204. *
  1205. * Implementations MUST support the schemes "http" and "https" case
  1206. * insensitively, and MAY accommodate other schemes if required.
  1207. *
  1208. * An empty scheme is equivalent to removing the scheme.
  1209. *
  1210. * @param string $scheme The scheme to use with the new instance.
  1211. * @return static A new instance with the specified scheme.
  1212. * @throws \InvalidArgumentException for invalid or unsupported schemes.
  1213. */
  1214. public function withScheme($scheme);
  1215. /**
  1216. * Return an instance with the specified user information.
  1217. *
  1218. * This method MUST retain the state of the current instance, and return
  1219. * an instance that contains the specified user information.
  1220. *
  1221. * Password is optional, but the user information MUST include the
  1222. * user; an empty string for the user is equivalent to removing user
  1223. * information.
  1224. *
  1225. * @param string $user The user name to use for authority.
  1226. * @param null|string $password The password associated with $user.
  1227. * @return static A new instance with the specified user information.
  1228. */
  1229. public function withUserInfo($user, $password = null);
  1230. /**
  1231. * Return an instance with the specified host.
  1232. *
  1233. * This method MUST retain the state of the current instance, and return
  1234. * an instance that contains the specified host.
  1235. *
  1236. * An empty host value is equivalent to removing the host.
  1237. *
  1238. * @param string $host The hostname to use with the new instance.
  1239. * @return static A new instance with the specified host.
  1240. * @throws \InvalidArgumentException for invalid hostnames.
  1241. */
  1242. public function withHost($host);
  1243. /**
  1244. * Return an instance with the specified port.
  1245. *
  1246. * This method MUST retain the state of the current instance, and return
  1247. * an instance that contains the specified port.
  1248. *
  1249. * Implementations MUST raise an exception for ports outside the
  1250. * established TCP and UDP port ranges.
  1251. *
  1252. * A null value provided for the port is equivalent to removing the port
  1253. * information.
  1254. *
  1255. * @param null|int $port The port to use with the new instance; a null value
  1256. * removes the port information.
  1257. * @return static A new instance with the specified port.
  1258. * @throws \InvalidArgumentException for invalid ports.
  1259. */
  1260. public function withPort($port);
  1261. /**
  1262. * Return an instance with the specified path.
  1263. *
  1264. * This method MUST retain the state of the current instance, and return
  1265. * an instance that contains the specified path.
  1266. *
  1267. * The path can either be empty or absolute (starting with a slash) or
  1268. * rootless (not starting with a slash). Implementations MUST support all
  1269. * three syntaxes.
  1270. *
  1271. * If the path is intended to be domain-relative rather than path relative then
  1272. * it must begin with a slash ("/"). Paths not starting with a slash ("/")
  1273. * are assumed to be relative to some base path known to the application or
  1274. * consumer.
  1275. *
  1276. * Users can provide both encoded and decoded path characters.
  1277. * Implementations ensure the correct encoding as outlined in getPath().
  1278. *
  1279. * @param string $path The path to use with the new instance.
  1280. * @return static A new instance with the specified path.
  1281. * @throws \InvalidArgumentException for invalid paths.
  1282. */
  1283. public function withPath($path);
  1284. /**
  1285. * Return an instance with the specified query string.
  1286. *
  1287. * This method MUST retain the state of the current instance, and return
  1288. * an instance that contains the specified query string.
  1289. *
  1290. * Users can provide both encoded and decoded query characters.
  1291. * Implementations ensure the correct encoding as outlined in getQuery().
  1292. *
  1293. * An empty query string value is equivalent to removing the query string.
  1294. *
  1295. * @param string $query The query string to use with the new instance.
  1296. * @return static A new instance with the specified query string.
  1297. * @throws \InvalidArgumentException for invalid query strings.
  1298. */
  1299. public function withQuery($query);
  1300. /**
  1301. * Return an instance with the specified URI fragment.
  1302. *
  1303. * This method MUST retain the state of the current instance, and return
  1304. * an instance that contains the specified URI fragment.
  1305. *
  1306. * Users can provide both encoded and decoded fragment characters.
  1307. * Implementations ensure the correct encoding as outlined in getFragment().
  1308. *
  1309. * An empty fragment value is equivalent to removing the fragment.
  1310. *
  1311. * @param string $fragment The fragment to use with the new instance.
  1312. * @return static A new instance with the specified fragment.
  1313. */
  1314. public function withFragment($fragment);
  1315. /**
  1316. * Return the string representation as a URI reference.
  1317. *
  1318. * Depending on which components of the URI are present, the resulting
  1319. * string is either a full URI or relative reference according to RFC 3986,
  1320. * Section 4.1. The method concatenates the various components of the URI,
  1321. * using the appropriate delimiters:
  1322. *
  1323. * - If a scheme is present, it MUST be suffixed by ":".
  1324. * - If an authority is present, it MUST be prefixed by "//".
  1325. * - The path can be concatenated without delimiters. But there are two
  1326. * cases where the path has to be adjusted to make the URI reference
  1327. * valid as PHP does not allow to throw an exception in __toString():
  1328. * - If the path is rootless and an authority is present, the path MUST
  1329. * be prefixed by "/".
  1330. * - If the path is starting with more than one "/" and no authority is
  1331. * present, the starting slashes MUST be reduced to one.
  1332. * - If a query is present, it MUST be prefixed by "?".
  1333. * - If a fragment is present, it MUST be prefixed by "#".
  1334. *
  1335. * @see http://tools.ietf.org/html/rfc3986#section-4.1
  1336. * @return string
  1337. */
  1338. public function __toString();
  1339. }
  1340. }
  1341. // file: vendor/psr/http-server-handler/src/RequestHandlerInterface.php
  1342. namespace Psr\Http\Server {
  1343. use Psr\Http\Message\ResponseInterface;
  1344. use Psr\Http\Message\ServerRequestInterface;
  1345. /**
  1346. * Handles a server request and produces a response.
  1347. *
  1348. * An HTTP request handler process an HTTP request in order to produce an
  1349. * HTTP response.
  1350. */
  1351. interface RequestHandlerInterface
  1352. {
  1353. /**
  1354. * Handles a request and produces a response.
  1355. *
  1356. * May call other collaborating code to generate the response.
  1357. */
  1358. public function handle(ServerRequestInterface $request): ResponseInterface;
  1359. }
  1360. }
  1361. // file: vendor/psr/http-server-middleware/src/MiddlewareInterface.php
  1362. namespace Psr\Http\Server {
  1363. use Psr\Http\Message\ResponseInterface;
  1364. use Psr\Http\Message\ServerRequestInterface;
  1365. /**
  1366. * Participant in processing a server request and response.
  1367. *
  1368. * An HTTP middleware component participates in processing an HTTP message:
  1369. * by acting on the request, generating the response, or forwarding the
  1370. * request to a subsequent middleware and possibly acting on its response.
  1371. */
  1372. interface MiddlewareInterface
  1373. {
  1374. /**
  1375. * Process an incoming server request.
  1376. *
  1377. * Processes an incoming server request in order to produce a response.
  1378. * If unable to produce the response itself, it may delegate to the provided
  1379. * request handler to do so.
  1380. */
  1381. public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface;
  1382. }
  1383. }
  1384. // file: vendor/nyholm/psr7/src/Factory/Psr17Factory.php
  1385. namespace Nyholm\Psr7\Factory {
  1386. use Nyholm\Psr7\{Request, Response, ServerRequest, Stream, UploadedFile, Uri};
  1387. use Psr\Http\Message\{RequestFactoryInterface, RequestInterface, ResponseFactoryInterface, ResponseInterface, ServerRequestFactoryInterface, ServerRequestInterface, StreamFactoryInterface, StreamInterface, UploadedFileFactoryInterface, UploadedFileInterface, UriFactoryInterface, UriInterface};
  1388. /**
  1389. * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  1390. * @author Martijn van der Ven <martijn@vanderven.se>
  1391. */
  1392. final class Psr17Factory implements RequestFactoryInterface, ResponseFactoryInterface, ServerRequestFactoryInterface, StreamFactoryInterface, UploadedFileFactoryInterface, UriFactoryInterface
  1393. {
  1394. public function createRequest(string $method, $uri): RequestInterface
  1395. {
  1396. return new Request($method, $uri);
  1397. }
  1398. public function createResponse(int $code = 200, string $reasonPhrase = ''): ResponseInterface
  1399. {
  1400. if (2 > \func_num_args()) {
  1401. // This will make the Response class to use a custom reasonPhrase
  1402. $reasonPhrase = null;
  1403. }
  1404. return new Response($code, [], null, '1.1', $reasonPhrase);
  1405. }
  1406. public function createStream(string $content = ''): StreamInterface
  1407. {
  1408. return Stream::create($content);
  1409. }
  1410. public function createStreamFromFile(string $filename, string $mode = 'r'): StreamInterface
  1411. {
  1412. $resource = @\fopen($filename, $mode);
  1413. if (false === $resource) {
  1414. if ('' === $mode || false === \in_array($mode[0], ['r', 'w', 'a', 'x', 'c'])) {
  1415. throw new \InvalidArgumentException('The mode ' . $mode . ' is invalid.');
  1416. }
  1417. throw new \RuntimeException('The file ' . $filename . ' cannot be opened.');
  1418. }
  1419. return Stream::create($resource);
  1420. }
  1421. public function createStreamFromResource($resource): StreamInterface
  1422. {
  1423. return Stream::create($resource);
  1424. }
  1425. public function createUploadedFile(StreamInterface $stream, int $size = null, int $error = \UPLOAD_ERR_OK, string $clientFilename = null, string $clientMediaType = null): UploadedFileInterface
  1426. {
  1427. if (null === $size) {
  1428. $size = $stream->getSize();
  1429. }
  1430. return new UploadedFile($stream, $size, $error, $clientFilename, $clientMediaType);
  1431. }
  1432. public function createUri(string $uri = ''): UriInterface
  1433. {
  1434. return new Uri($uri);
  1435. }
  1436. public function createServerRequest(string $method, $uri, array $serverParams = []): ServerRequestInterface
  1437. {
  1438. return new ServerRequest($method, $uri, [], null, '1.1', $serverParams);
  1439. }
  1440. }
  1441. }
  1442. // file: vendor/nyholm/psr7/src/MessageTrait.php
  1443. namespace Nyholm\Psr7 {
  1444. use Psr\Http\Message\StreamInterface;
  1445. /**
  1446. * Trait implementing functionality common to requests and responses.
  1447. *
  1448. * @author Michael Dowling and contributors to guzzlehttp/psr7
  1449. * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  1450. * @author Martijn van der Ven <martijn@vanderven.se>
  1451. *
  1452. * @internal should not be used outside of Nyholm/Psr7 as it does not fall under our BC promise
  1453. */
  1454. trait MessageTrait
  1455. {
  1456. /** @var array Map of all registered headers, as original name => array of values */
  1457. private $headers = [];
  1458. /** @var array Map of lowercase header name => original name at registration */
  1459. private $headerNames = [];
  1460. /** @var string */
  1461. private $protocol = '1.1';
  1462. /** @var StreamInterface|null */
  1463. private $stream;
  1464. public function getProtocolVersion(): string
  1465. {
  1466. return $this->protocol;
  1467. }
  1468. public function withProtocolVersion($version): self
  1469. {
  1470. if ($this->protocol === $version) {
  1471. return $this;
  1472. }
  1473. $new = clone $this;
  1474. $new->protocol = $version;
  1475. return $new;
  1476. }
  1477. public function getHeaders(): array
  1478. {
  1479. return $this->headers;
  1480. }
  1481. public function hasHeader($header): bool
  1482. {
  1483. return isset($this->headerNames[\strtolower($header)]);
  1484. }
  1485. public function getHeader($header): array
  1486. {
  1487. $header = \strtolower($header);
  1488. if (!isset($this->headerNames[$header])) {
  1489. return [];
  1490. }
  1491. $header = $this->headerNames[$header];
  1492. return $this->headers[$header];
  1493. }
  1494. public function getHeaderLine($header): string
  1495. {
  1496. return \implode(', ', $this->getHeader($header));
  1497. }
  1498. public function withHeader($header, $value): self
  1499. {
  1500. $value = $this->validateAndTrimHeader($header, $value);
  1501. $normalized = \strtolower($header);
  1502. $new = clone $this;
  1503. if (isset($new->headerNames[$normalized])) {
  1504. unset($new->headers[$new->headerNames[$normalized]]);
  1505. }
  1506. $new->headerNames[$normalized] = $header;
  1507. $new->headers[$header] = $value;
  1508. return $new;
  1509. }
  1510. public function withAddedHeader($header, $value): self
  1511. {
  1512. if (!\is_string($header) || '' === $header) {
  1513. throw new \InvalidArgumentException('Header name must be an RFC 7230 compatible string.');
  1514. }
  1515. $new = clone $this;
  1516. $new->setHeaders([$header => $value]);
  1517. return $new;
  1518. }
  1519. public function withoutHeader($header): self
  1520. {
  1521. $normalized = \strtolower($header);
  1522. if (!isset($this->headerNames[$normalized])) {
  1523. return $this;
  1524. }
  1525. $header = $this->headerNames[$normalized];
  1526. $new = clone $this;
  1527. unset($new->headers[$header], $new->headerNames[$normalized]);
  1528. return $new;
  1529. }
  1530. public function getBody(): StreamInterface
  1531. {
  1532. if (null === $this->stream) {
  1533. $this->stream = Stream::create('');
  1534. }
  1535. return $this->stream;
  1536. }
  1537. public function withBody(StreamInterface $body): self
  1538. {
  1539. if ($body === $this->stream) {
  1540. return $this;
  1541. }
  1542. $new = clone $this;
  1543. $new->stream = $body;
  1544. return $new;
  1545. }
  1546. private function setHeaders(array $headers) /*:void*/
  1547. {
  1548. foreach ($headers as $header => $value) {
  1549. $value = $this->validateAndTrimHeader($header, $value);
  1550. $normalized = \strtolower($header);
  1551. if (isset($this->headerNames[$normalized])) {
  1552. $header = $this->headerNames[$normalized];
  1553. $this->headers[$header] = \array_merge($this->headers[$header], $value);
  1554. } else {
  1555. $this->headerNames[$normalized] = $header;
  1556. $this->headers[$header] = $value;
  1557. }
  1558. }
  1559. }
  1560. /**
  1561. * Make sure the header complies with RFC 7230.
  1562. *
  1563. * Header names must be a non-empty string consisting of token characters.
  1564. *
  1565. * Header values must be strings consisting of visible characters with all optional
  1566. * leading and trailing whitespace stripped. This method will always strip such
  1567. * optional whitespace. Note that the method does not allow folding whitespace within
  1568. * the values as this was deprecated for almost all instances by the RFC.
  1569. *
  1570. * header-field = field-name ":" OWS field-value OWS
  1571. * field-name = 1*( "!" / "#" / "$" / "%" / "&" / "'" / "*" / "+" / "-" / "." / "^"
  1572. * / "_" / "`" / "|" / "~" / %x30-39 / ( %x41-5A / %x61-7A ) )
  1573. * OWS = *( SP / HTAB )
  1574. * field-value = *( ( %x21-7E / %x80-FF ) [ 1*( SP / HTAB ) ( %x21-7E / %x80-FF ) ] )
  1575. *
  1576. * @see https://tools.ietf.org/html/rfc7230#section-3.2.4
  1577. */
  1578. private function validateAndTrimHeader($header, $values): array
  1579. {
  1580. if (!\is_string($header) || 1 !== \preg_match("@^[!#$%&'*+.^_`|~0-9A-Za-z-]+$@", $header)) {
  1581. throw new \InvalidArgumentException('Header name must be an RFC 7230 compatible string.');
  1582. }
  1583. if (!\is_array($values)) {
  1584. // This is simple, just one value.
  1585. if ((!\is_numeric($values) && !\is_string($values)) || 1 !== \preg_match("@^[ \t\x21-\x7E\x80-\xFF]*$@", (string) $values)) {
  1586. throw new \InvalidArgumentException('Header values must be RFC 7230 compatible strings.');
  1587. }
  1588. return [\trim((string) $values, " \t")];
  1589. }
  1590. if (empty($values)) {
  1591. throw new \InvalidArgumentException('Header values must be a string or an array of strings, empty array given.');
  1592. }
  1593. // Assert Non empty array
  1594. $returnValues = [];
  1595. foreach ($values as $v) {
  1596. if ((!\is_numeric($v) && !\is_string($v)) || 1 !== \preg_match("@^[ \t\x21-\x7E\x80-\xFF]*$@", (string) $v)) {
  1597. throw new \InvalidArgumentException('Header values must be RFC 7230 compatible strings.');
  1598. }
  1599. $returnValues[] = \trim((string) $v, " \t");
  1600. }
  1601. return $returnValues;
  1602. }
  1603. }
  1604. }
  1605. // file: vendor/nyholm/psr7/src/Request.php
  1606. namespace Nyholm\Psr7 {
  1607. use Psr\Http\Message\{RequestInterface, StreamInterface, UriInterface};
  1608. /**
  1609. * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  1610. * @author Martijn van der Ven <martijn@vanderven.se>
  1611. */
  1612. final class Request implements RequestInterface
  1613. {
  1614. use MessageTrait;
  1615. use RequestTrait;
  1616. /**
  1617. * @param string $method HTTP method
  1618. * @param string|UriInterface $uri URI
  1619. * @param array $headers Request headers
  1620. * @param string|resource|StreamInterface|null $body Request body
  1621. * @param string $version Protocol version
  1622. */
  1623. public function __construct(string $method, $uri, array $headers = [], $body = null, string $version = '1.1')
  1624. {
  1625. if (!($uri instanceof UriInterface)) {
  1626. $uri = new Uri($uri);
  1627. }
  1628. $this->method = $method;
  1629. $this->uri = $uri;
  1630. $this->setHeaders($headers);
  1631. $this->protocol = $version;
  1632. if (!$this->hasHeader('Host')) {
  1633. $this->updateHostFromUri();
  1634. }
  1635. // If we got no body, defer initialization of the stream until Request::getBody()
  1636. if ('' !== $body && null !== $body) {
  1637. $this->stream = Stream::create($body);
  1638. }
  1639. }
  1640. }
  1641. }
  1642. // file: vendor/nyholm/psr7/src/RequestTrait.php
  1643. namespace Nyholm\Psr7 {
  1644. use Psr\Http\Message\UriInterface;
  1645. /**
  1646. * @author Michael Dowling and contributors to guzzlehttp/psr7
  1647. * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  1648. * @author Martijn van der Ven <martijn@vanderven.se>
  1649. *
  1650. * @internal should not be used outside of Nyholm/Psr7 as it does not fall under our BC promise
  1651. */
  1652. trait RequestTrait
  1653. {
  1654. /** @var string */
  1655. private $method;
  1656. /** @var string|null */
  1657. private $requestTarget;
  1658. /** @var UriInterface|null */
  1659. private $uri;
  1660. public function getRequestTarget(): string
  1661. {
  1662. if (null !== $this->requestTarget) {
  1663. return $this->requestTarget;
  1664. }
  1665. if ('' === $target = $this->uri->getPath()) {
  1666. $target = '/';
  1667. }
  1668. if ('' !== $this->uri->getQuery()) {
  1669. $target .= '?' . $this->uri->getQuery();
  1670. }
  1671. return $target;
  1672. }
  1673. public function withRequestTarget($requestTarget): self
  1674. {
  1675. if (\preg_match('#\s#', $requestTarget)) {
  1676. throw new \InvalidArgumentException('Invalid request target provided; cannot contain whitespace');
  1677. }
  1678. $new = clone $this;
  1679. $new->requestTarget = $requestTarget;
  1680. return $new;
  1681. }
  1682. public function getMethod(): string
  1683. {
  1684. return $this->method;
  1685. }
  1686. public function withMethod($method): self
  1687. {
  1688. if (!\is_string($method)) {
  1689. throw new \InvalidArgumentException('Method must be a string');
  1690. }
  1691. $new = clone $this;
  1692. $new->method = $method;
  1693. return $new;
  1694. }
  1695. public function getUri(): UriInterface
  1696. {
  1697. return $this->uri;
  1698. }
  1699. public function withUri(UriInterface $uri, $preserveHost = false): self
  1700. {
  1701. if ($uri === $this->uri) {
  1702. return $this;
  1703. }
  1704. $new = clone $this;
  1705. $new->uri = $uri;
  1706. if (!$preserveHost || !$this->hasHeader('Host')) {
  1707. $new->updateHostFromUri();
  1708. }
  1709. return $new;
  1710. }
  1711. private function updateHostFromUri() /*:void*/
  1712. {
  1713. if ('' === $host = $this->uri->getHost()) {
  1714. return;
  1715. }
  1716. if (null !== ($port = $this->uri->getPort())) {
  1717. $host .= ':' . $port;
  1718. }
  1719. if (isset($this->headerNames['host'])) {
  1720. $header = $this->headerNames['host'];
  1721. } else {
  1722. $this->headerNames['host'] = $header = 'Host';
  1723. }
  1724. // Ensure Host is the first header.
  1725. // See: http://tools.ietf.org/html/rfc7230#section-5.4
  1726. $this->headers = [$header => [$host]] + $this->headers;
  1727. }
  1728. }
  1729. }
  1730. // file: vendor/nyholm/psr7/src/Response.php
  1731. namespace Nyholm\Psr7 {
  1732. use Psr\Http\Message\{ResponseInterface, StreamInterface};
  1733. /**
  1734. * @author Michael Dowling and contributors to guzzlehttp/psr7
  1735. * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  1736. * @author Martijn van der Ven <martijn@vanderven.se>
  1737. */
  1738. final class Response implements ResponseInterface
  1739. {
  1740. use MessageTrait;
  1741. /** @var array Map of standard HTTP status code/reason phrases */
  1742. /*private*/ const PHRASES = [
  1743. 100 => 'Continue', 101 => 'Switching Protocols', 102 => 'Processing',
  1744. 200 => 'OK', 201 => 'Created', 202 => 'Accepted', 203 => 'Non-Authoritative Information', 204 => 'No Content', 205 => 'Reset Content', 206 => 'Partial Content', 207 => 'Multi-status', 208 => 'Already Reported',
  1745. 300 => 'Multiple Choices', 301 => 'Moved Permanently', 302 => 'Found', 303 => 'See Other', 304 => 'Not Modified', 305 => 'Use Proxy', 306 => 'Switch Proxy', 307 => 'Temporary Redirect',
  1746. 400 => 'Bad Request', 401 => 'Unauthorized', 402 => 'Payment Required', 403 => 'Forbidden', 404 => 'Not Found', 405 => 'Method Not Allowed', 406 => 'Not Acceptable', 407 => 'Proxy Authentication Required', 408 => 'Request Time-out', 409 => 'Conflict', 410 => 'Gone', 411 => 'Length Required', 412 => 'Precondition Failed', 413 => 'Request Entity Too Large', 414 => 'Request-URI Too Large', 415 => 'Unsupported Media Type', 416 => 'Requested range not satisfiable', 417 => 'Expectation Failed', 418 => 'I\'m a teapot', 422 => 'Unprocessable Entity', 423 => 'Locked', 424 => 'Failed Dependency', 425 => 'Unordered Collection', 426 => 'Upgrade Required', 428 => 'Precondition Required', 429 => 'Too Many Requests', 431 => 'Request Header Fields Too Large', 451 => 'Unavailable For Legal Reasons',
  1747. 500 => 'Internal Server Error', 501 => 'Not Implemented', 502 => 'Bad Gateway', 503 => 'Service Unavailable', 504 => 'Gateway Time-out', 505 => 'HTTP Version not supported', 506 => 'Variant Also Negotiates', 507 => 'Insufficient Storage', 508 => 'Loop Detected', 511 => 'Network Authentication Required',
  1748. ];
  1749. /** @var string */
  1750. private $reasonPhrase = '';
  1751. /** @var int */
  1752. private $statusCode;
  1753. /**
  1754. * @param int $status Status code
  1755. * @param array $headers Response headers
  1756. * @param string|resource|StreamInterface|null $body Response body
  1757. * @param string $version Protocol version
  1758. * @param string|null $reason Reason phrase (when empty a default will be used based on the status code)
  1759. */
  1760. public function __construct(int $status = 200, array $headers = [], $body = null, string $version = '1.1', string $reason = null)
  1761. {
  1762. // If we got no body, defer initialization of the stream until Response::getBody()
  1763. if ('' !== $body && null !== $body) {
  1764. $this->stream = Stream::create($body);
  1765. }
  1766. $this->statusCode = $status;
  1767. $this->setHeaders($headers);
  1768. if (null === $reason && isset(self::PHRASES[$this->statusCode])) {
  1769. $this->reasonPhrase = self::PHRASES[$status];
  1770. } else {
  1771. $this->reasonPhrase = $reason ?? '';
  1772. }
  1773. $this->protocol = $version;
  1774. }
  1775. public function getStatusCode(): int
  1776. {
  1777. return $this->statusCode;
  1778. }
  1779. public function getReasonPhrase(): string
  1780. {
  1781. return $this->reasonPhrase;
  1782. }
  1783. public function withStatus($code, $reasonPhrase = ''): self
  1784. {
  1785. if (!\is_int($code) && !\is_string($code)) {
  1786. throw new \InvalidArgumentException('Status code has to be an integer');
  1787. }
  1788. $code = (int) $code;
  1789. if ($code < 100 || $code > 599) {
  1790. throw new \InvalidArgumentException('Status code has to be an integer between 100 and 599');
  1791. }
  1792. $new = clone $this;
  1793. $new->statusCode = $code;
  1794. if ((null === $reasonPhrase || '' === $reasonPhrase) && isset(self::PHRASES[$new->statusCode])) {
  1795. $reasonPhrase = self::PHRASES[$new->statusCode];
  1796. }
  1797. $new->reasonPhrase = $reasonPhrase;
  1798. return $new;
  1799. }
  1800. }
  1801. }
  1802. // file: vendor/nyholm/psr7/src/ServerRequest.php
  1803. namespace Nyholm\Psr7 {
  1804. use Psr\Http\Message\{ServerRequestInterface, StreamInterface, UploadedFileInterface, UriInterface};
  1805. /**
  1806. * @author Michael Dowling and contributors to guzzlehttp/psr7
  1807. * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  1808. * @author Martijn van der Ven <martijn@vanderven.se>
  1809. */
  1810. final class ServerRequest implements ServerRequestInterface
  1811. {
  1812. use MessageTrait;
  1813. use RequestTrait;
  1814. /** @var array */
  1815. private $attributes = [];
  1816. /** @var array */
  1817. private $cookieParams = [];
  1818. /** @var array|object|null */
  1819. private $parsedBody;
  1820. /** @var array */
  1821. private $queryParams = [];
  1822. /** @var array */
  1823. private $serverParams;
  1824. /** @var UploadedFileInterface[] */
  1825. private $uploadedFiles = [];
  1826. /**
  1827. * @param string $method HTTP method
  1828. * @param string|UriInterface $uri URI
  1829. * @param array $headers Request headers
  1830. * @param string|resource|StreamInterface|null $body Request body
  1831. * @param string $version Protocol version
  1832. * @param array $serverParams Typically the $_SERVER superglobal
  1833. */
  1834. public function __construct(string $method, $uri, array $headers = [], $body = null, string $version = '1.1', array $serverParams = [])
  1835. {
  1836. $this->serverParams = $serverParams;
  1837. if (!($uri instanceof UriInterface)) {
  1838. $uri = new Uri($uri);
  1839. }
  1840. $this->method = $method;
  1841. $this->uri = $uri;
  1842. $this->setHeaders($headers);
  1843. $this->protocol = $version;
  1844. if (!$this->hasHeader('Host')) {
  1845. $this->updateHostFromUri();
  1846. }
  1847. // If we got no body, defer initialization of the stream until ServerRequest::getBody()
  1848. if ('' !== $body && null !== $body) {
  1849. $this->stream = Stream::create($body);
  1850. }
  1851. }
  1852. public function getServerParams(): array
  1853. {
  1854. return $this->serverParams;
  1855. }
  1856. public function getUploadedFiles(): array
  1857. {
  1858. return $this->uploadedFiles;
  1859. }
  1860. public function withUploadedFiles(array $uploadedFiles)
  1861. {
  1862. $new = clone $this;
  1863. $new->uploadedFiles = $uploadedFiles;
  1864. return $new;
  1865. }
  1866. public function getCookieParams(): array
  1867. {
  1868. return $this->cookieParams;
  1869. }
  1870. public function withCookieParams(array $cookies)
  1871. {
  1872. $new = clone $this;
  1873. $new->cookieParams = $cookies;
  1874. return $new;
  1875. }
  1876. public function getQueryParams(): array
  1877. {
  1878. return $this->queryParams;
  1879. }
  1880. public function withQueryParams(array $query)
  1881. {
  1882. $new = clone $this;
  1883. $new->queryParams = $query;
  1884. return $new;
  1885. }
  1886. public function getParsedBody()
  1887. {
  1888. return $this->parsedBody;
  1889. }
  1890. public function withParsedBody($data)
  1891. {
  1892. if (!\is_array($data) && !\is_object($data) && null !== $data) {
  1893. throw new \InvalidArgumentException('First parameter to withParsedBody MUST be object, array or null');
  1894. }
  1895. $new = clone $this;
  1896. $new->parsedBody = $data;
  1897. return $new;
  1898. }
  1899. public function getAttributes(): array
  1900. {
  1901. return $this->attributes;
  1902. }
  1903. public function getAttribute($attribute, $default = null)
  1904. {
  1905. if (false === \array_key_exists($attribute, $this->attributes)) {
  1906. return $default;
  1907. }
  1908. return $this->attributes[$attribute];
  1909. }
  1910. public function withAttribute($attribute, $value): self
  1911. {
  1912. $new = clone $this;
  1913. $new->attributes[$attribute] = $value;
  1914. return $new;
  1915. }
  1916. public function withoutAttribute($attribute): self
  1917. {
  1918. if (false === \array_key_exists($attribute, $this->attributes)) {
  1919. return $this;
  1920. }
  1921. $new = clone $this;
  1922. unset($new->attributes[$attribute]);
  1923. return $new;
  1924. }
  1925. }
  1926. }
  1927. // file: vendor/nyholm/psr7/src/Stream.php
  1928. namespace Nyholm\Psr7 {
  1929. use Psr\Http\Message\StreamInterface;
  1930. /**
  1931. * @author Michael Dowling and contributors to guzzlehttp/psr7
  1932. * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  1933. * @author Martijn van der Ven <martijn@vanderven.se>
  1934. */
  1935. final class Stream implements StreamInterface
  1936. {
  1937. /** @var resource|null A resource reference */
  1938. private $stream;
  1939. /** @var bool */
  1940. private $seekable;
  1941. /** @var bool */
  1942. private $readable;
  1943. /** @var bool */
  1944. private $writable;
  1945. /** @var array|mixed|void|null */
  1946. private $uri;
  1947. /** @var int|null */
  1948. private $size;
  1949. /** @var array Hash of readable and writable stream types */
  1950. /*private*/ const READ_WRITE_HASH = [
  1951. 'read' => [
  1952. 'r' => true, 'w+' => true, 'r+' => true, 'x+' => true, 'c+' => true,
  1953. 'rb' => true, 'w+b' => true, 'r+b' => true, 'x+b' => true,
  1954. 'c+b' => true, 'rt' => true, 'w+t' => true, 'r+t' => true,
  1955. 'x+t' => true, 'c+t' => true, 'a+' => true,
  1956. ],
  1957. 'write' => [
  1958. 'w' => true, 'w+' => true, 'rw' => true, 'r+' => true, 'x+' => true,
  1959. 'c+' => true, 'wb' => true, 'w+b' => true, 'r+b' => true,
  1960. 'x+b' => true, 'c+b' => true, 'w+t' => true, 'r+t' => true,
  1961. 'x+t' => true, 'c+t' => true, 'a' => true, 'a+' => true,
  1962. ],
  1963. ];
  1964. private function __construct()
  1965. {
  1966. }
  1967. /**
  1968. * Creates a new PSR-7 stream.
  1969. *
  1970. * @param string|resource|StreamInterface $body
  1971. *
  1972. * @return StreamInterface
  1973. *
  1974. * @throws \InvalidArgumentException
  1975. */
  1976. public static function create($body = ''): StreamInterface
  1977. {
  1978. if ($body instanceof StreamInterface) {
  1979. return $body;
  1980. }
  1981. if (\is_string($body)) {
  1982. $resource = \fopen('php://temp', 'rw+');
  1983. \fwrite($resource, $body);
  1984. $body = $resource;
  1985. }
  1986. if (\is_resource($body)) {
  1987. $new = new self();
  1988. $new->stream = $body;
  1989. $meta = \stream_get_meta_data($new->stream);
  1990. $new->seekable = $meta['seekable'] && 0 === \fseek($new->stream, 0, \SEEK_CUR);
  1991. $new->readable = isset(self::READ_WRITE_HASH['read'][$meta['mode']]);
  1992. $new->writable = isset(self::READ_WRITE_HASH['write'][$meta['mode']]);
  1993. $new->uri = $new->getMetadata('uri');
  1994. return $new;
  1995. }
  1996. throw new \InvalidArgumentException('First argument to Stream::create() must be a string, resource or StreamInterface.');
  1997. }
  1998. /**
  1999. * Closes the stream when the destructed.
  2000. */
  2001. public function __destruct()
  2002. {
  2003. $this->close();
  2004. }
  2005. public function __toString(): string
  2006. {
  2007. try {
  2008. if ($this->isSeekable()) {
  2009. $this->seek(0);
  2010. }
  2011. return $this->getContents();
  2012. } catch (\Exception $e) {
  2013. return '';
  2014. }
  2015. }
  2016. public function close() /*:void*/
  2017. {
  2018. if (isset($this->stream)) {
  2019. if (\is_resource($this->stream)) {
  2020. \fclose($this->stream);
  2021. }
  2022. $this->detach();
  2023. }
  2024. }
  2025. public function detach()
  2026. {
  2027. if (!isset($this->stream)) {
  2028. return null;
  2029. }
  2030. $result = $this->stream;
  2031. unset($this->stream);
  2032. $this->size = $this->uri = null;
  2033. $this->readable = $this->writable = $this->seekable = false;
  2034. return $result;
  2035. }
  2036. public function getSize() /*:?int*/
  2037. {
  2038. if (null !== $this->size) {
  2039. return $this->size;
  2040. }
  2041. if (!isset($this->stream)) {
  2042. return null;
  2043. }
  2044. // Clear the stat cache if the stream has a URI
  2045. if ($this->uri) {
  2046. \clearstatcache(true, $this->uri);
  2047. }
  2048. $stats = \fstat($this->stream);
  2049. if (isset($stats['size'])) {
  2050. $this->size = $stats['size'];
  2051. return $this->size;
  2052. }
  2053. return null;
  2054. }
  2055. public function tell(): int
  2056. {
  2057. if (false === $result = \ftell($this->stream)) {
  2058. throw new \RuntimeException('Unable to determine stream position');
  2059. }
  2060. return $result;
  2061. }
  2062. public function eof(): bool
  2063. {
  2064. return !$this->stream || \feof($this->stream);
  2065. }
  2066. public function isSeekable(): bool
  2067. {
  2068. return $this->seekable;
  2069. }
  2070. public function seek($offset, $whence = \SEEK_SET) /*:void*/
  2071. {
  2072. if (!$this->seekable) {
  2073. throw new \RuntimeException('Stream is not seekable');
  2074. }
  2075. if (-1 === \fseek($this->stream, $offset, $whence)) {
  2076. throw new \RuntimeException('Unable to seek to stream position ' . $offset . ' with whence ' . \var_export($whence, true));
  2077. }
  2078. }
  2079. public function rewind() /*:void*/
  2080. {
  2081. $this->seek(0);
  2082. }
  2083. public function isWritable(): bool
  2084. {
  2085. return $this->writable;
  2086. }
  2087. public function write($string): int
  2088. {
  2089. if (!$this->writable) {
  2090. throw new \RuntimeException('Cannot write to a non-writable stream');
  2091. }
  2092. // We can't know the size after writing anything
  2093. $this->size = null;
  2094. if (false === $result = \fwrite($this->stream, $string)) {
  2095. throw new \RuntimeException('Unable to write to stream');
  2096. }
  2097. return $result;
  2098. }
  2099. public function isReadable(): bool
  2100. {
  2101. return $this->readable;
  2102. }
  2103. public function read($length): string
  2104. {
  2105. if (!$this->readable) {
  2106. throw new \RuntimeException('Cannot read from non-readable stream');
  2107. }
  2108. return \fread($this->stream, $length);
  2109. }
  2110. public function getContents(): string
  2111. {
  2112. if (!isset($this->stream)) {
  2113. throw new \RuntimeException('Unable to read stream contents');
  2114. }
  2115. if (false === $contents = \stream_get_contents($this->stream)) {
  2116. throw new \RuntimeException('Unable to read stream contents');
  2117. }
  2118. return $contents;
  2119. }
  2120. public function getMetadata($key = null)
  2121. {
  2122. if (!isset($this->stream)) {
  2123. return $key ? null : [];
  2124. }
  2125. $meta = \stream_get_meta_data($this->stream);
  2126. if (null === $key) {
  2127. return $meta;
  2128. }
  2129. return $meta[$key] ?? null;
  2130. }
  2131. }
  2132. }
  2133. // file: vendor/nyholm/psr7/src/UploadedFile.php
  2134. namespace Nyholm\Psr7 {
  2135. use Psr\Http\Message\{StreamInterface, UploadedFileInterface};
  2136. /**
  2137. * @author Michael Dowling and contributors to guzzlehttp/psr7
  2138. * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  2139. * @author Martijn van der Ven <martijn@vanderven.se>
  2140. */
  2141. final class UploadedFile implements UploadedFileInterface
  2142. {
  2143. /** @var array */
  2144. /*private*/ const ERRORS = [
  2145. \UPLOAD_ERR_OK => 1,
  2146. \UPLOAD_ERR_INI_SIZE => 1,
  2147. \UPLOAD_ERR_FORM_SIZE => 1,
  2148. \UPLOAD_ERR_PARTIAL => 1,
  2149. \UPLOAD_ERR_NO_FILE => 1,
  2150. \UPLOAD_ERR_NO_TMP_DIR => 1,
  2151. \UPLOAD_ERR_CANT_WRITE => 1,
  2152. \UPLOAD_ERR_EXTENSION => 1,
  2153. ];
  2154. /** @var string */
  2155. private $clientFilename;
  2156. /** @var string */
  2157. private $clientMediaType;
  2158. /** @var int */
  2159. private $error;
  2160. /** @var string|null */
  2161. private $file;
  2162. /** @var bool */
  2163. private $moved = false;
  2164. /** @var int */
  2165. private $size;
  2166. /** @var StreamInterface|null */
  2167. private $stream;
  2168. /**
  2169. * @param StreamInterface|string|resource $streamOrFile
  2170. * @param int $size
  2171. * @param int $errorStatus
  2172. * @param string|null $clientFilename
  2173. * @param string|null $clientMediaType
  2174. */
  2175. public function __construct($streamOrFile, $size, $errorStatus, $clientFilename = null, $clientMediaType = null)
  2176. {
  2177. if (false === \is_int($errorStatus) || !isset(self::ERRORS[$errorStatus])) {
  2178. throw new \InvalidArgumentException('Upload file error status must be an integer value and one of the "UPLOAD_ERR_*" constants.');
  2179. }
  2180. if (false === \is_int($size)) {
  2181. throw new \InvalidArgumentException('Upload file size must be an integer');
  2182. }
  2183. if (null !== $clientFilename && !\is_string($clientFilename)) {
  2184. throw new \InvalidArgumentException('Upload file client filename must be a string or null');
  2185. }
  2186. if (null !== $clientMediaType && !\is_string($clientMediaType)) {
  2187. throw new \InvalidArgumentException('Upload file client media type must be a string or null');
  2188. }
  2189. $this->error = $errorStatus;
  2190. $this->size = $size;
  2191. $this->clientFilename = $clientFilename;
  2192. $this->clientMediaType = $clientMediaType;
  2193. if (\UPLOAD_ERR_OK === $this->error) {
  2194. // Depending on the value set file or stream variable.
  2195. if (\is_string($streamOrFile)) {
  2196. $this->file = $streamOrFile;
  2197. } elseif (\is_resource($streamOrFile)) {
  2198. $this->stream = Stream::create($streamOrFile);
  2199. } elseif ($streamOrFile instanceof StreamInterface) {
  2200. $this->stream = $streamOrFile;
  2201. } else {
  2202. throw new \InvalidArgumentException('Invalid stream or file provided for UploadedFile');
  2203. }
  2204. }
  2205. }
  2206. /**
  2207. * @throws \RuntimeException if is moved or not ok
  2208. */
  2209. private function validateActive() /*:void*/
  2210. {
  2211. if (\UPLOAD_ERR_OK !== $this->error) {
  2212. throw new \RuntimeException('Cannot retrieve stream due to upload error');
  2213. }
  2214. if ($this->moved) {
  2215. throw new \RuntimeException('Cannot retrieve stream after it has already been moved');
  2216. }
  2217. }
  2218. public function getStream(): StreamInterface
  2219. {
  2220. $this->validateActive();
  2221. if ($this->stream instanceof StreamInterface) {
  2222. return $this->stream;
  2223. }
  2224. $resource = \fopen($this->file, 'r');
  2225. return Stream::create($resource);
  2226. }
  2227. public function moveTo($targetPath) /*:void*/
  2228. {
  2229. $this->validateActive();
  2230. if (!\is_string($targetPath) || '' === $targetPath) {
  2231. throw new \InvalidArgumentException('Invalid path provided for move operation; must be a non-empty string');
  2232. }
  2233. if (null !== $this->file) {
  2234. $this->moved = 'cli' === \PHP_SAPI ? \rename($this->file, $targetPath) : \move_uploaded_file($this->file, $targetPath);
  2235. } else {
  2236. $stream = $this->getStream();
  2237. if ($stream->isSeekable()) {
  2238. $stream->rewind();
  2239. }
  2240. // Copy the contents of a stream into another stream until end-of-file.
  2241. $dest = Stream::create(\fopen($targetPath, 'w'));
  2242. while (!$stream->eof()) {
  2243. if (!$dest->write($stream->read(1048576))) {
  2244. break;
  2245. }
  2246. }
  2247. $this->moved = true;
  2248. }
  2249. if (false === $this->moved) {
  2250. throw new \RuntimeException(\sprintf('Uploaded file could not be moved to %s', $targetPath));
  2251. }
  2252. }
  2253. public function getSize(): int
  2254. {
  2255. return $this->size;
  2256. }
  2257. public function getError(): int
  2258. {
  2259. return $this->error;
  2260. }
  2261. public function getClientFilename() /*:?string*/
  2262. {
  2263. return $this->clientFilename;
  2264. }
  2265. public function getClientMediaType() /*:?string*/
  2266. {
  2267. return $this->clientMediaType;
  2268. }
  2269. }
  2270. }
  2271. // file: vendor/nyholm/psr7/src/Uri.php
  2272. namespace Nyholm\Psr7 {
  2273. use Psr\Http\Message\UriInterface;
  2274. /**
  2275. * PSR-7 URI implementation.
  2276. *
  2277. * @author Michael Dowling
  2278. * @author Tobias Schultze
  2279. * @author Matthew Weier O'Phinney
  2280. * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  2281. * @author Martijn van der Ven <martijn@vanderven.se>
  2282. */
  2283. final class Uri implements UriInterface
  2284. {
  2285. /*private*/ const SCHEMES = ['http' => 80, 'https' => 443];
  2286. /*private*/ const CHAR_UNRESERVED = 'a-zA-Z0-9_\-\.~';
  2287. /*private*/ const CHAR_SUB_DELIMS = '!\$&\'\(\)\*\+,;=';
  2288. /** @var string Uri scheme. */
  2289. private $scheme = '';
  2290. /** @var string Uri user info. */
  2291. private $userInfo = '';
  2292. /** @var string Uri host. */
  2293. private $host = '';
  2294. /** @var int|null Uri port. */
  2295. private $port;
  2296. /** @var string Uri path. */
  2297. private $path = '';
  2298. /** @var string Uri query string. */
  2299. private $query = '';
  2300. /** @var string Uri fragment. */
  2301. private $fragment = '';
  2302. public function __construct(string $uri = '')
  2303. {
  2304. if ('' !== $uri) {
  2305. if (false === $parts = \parse_url($uri)) {
  2306. throw new \InvalidArgumentException("Unable to parse URI: $uri");
  2307. }
  2308. // Apply parse_url parts to a URI.
  2309. $this->scheme = isset($parts['scheme']) ? \strtolower($parts['scheme']) : '';
  2310. $this->userInfo = $parts['user'] ?? '';
  2311. $this->host = isset($parts['host']) ? \strtolower($parts['host']) : '';
  2312. $this->port = isset($parts['port']) ? $this->filterPort($parts['port']) : null;
  2313. $this->path = isset($parts['path']) ? $this->filterPath($parts['path']) : '';
  2314. $this->query = isset($parts['query']) ? $this->filterQueryAndFragment($parts['query']) : '';
  2315. $this->fragment = isset($parts['fragment']) ? $this->filterQueryAndFragment($parts['fragment']) : '';
  2316. if (isset($parts['pass'])) {
  2317. $this->userInfo .= ':' . $parts['pass'];
  2318. }
  2319. }
  2320. }
  2321. public function __toString(): string
  2322. {
  2323. return self::createUriString($this->scheme, $this->getAuthority(), $this->path, $this->query, $this->fragment);
  2324. }
  2325. public function getScheme(): string
  2326. {
  2327. return $this->scheme;
  2328. }
  2329. public function getAuthority(): string
  2330. {
  2331. if ('' === $this->host) {
  2332. return '';
  2333. }
  2334. $authority = $this->host;
  2335. if ('' !== $this->userInfo) {
  2336. $authority = $this->userInfo . '@' . $authority;
  2337. }
  2338. if (null !== $this->port) {
  2339. $authority .= ':' . $this->port;
  2340. }
  2341. return $authority;
  2342. }
  2343. public function getUserInfo(): string
  2344. {
  2345. return $this->userInfo;
  2346. }
  2347. public function getHost(): string
  2348. {
  2349. return $this->host;
  2350. }
  2351. public function getPort() /*:?int*/
  2352. {
  2353. return $this->port;
  2354. }
  2355. public function getPath(): string
  2356. {
  2357. return $this->path;
  2358. }
  2359. public function getQuery(): string
  2360. {
  2361. return $this->query;
  2362. }
  2363. public function getFragment(): string
  2364. {
  2365. return $this->fragment;
  2366. }
  2367. public function withScheme($scheme): self
  2368. {
  2369. if (!\is_string($scheme)) {
  2370. throw new \InvalidArgumentException('Scheme must be a string');
  2371. }
  2372. if ($this->scheme === $scheme = \strtolower($scheme)) {
  2373. return $this;
  2374. }
  2375. $new = clone $this;
  2376. $new->scheme = $scheme;
  2377. $new->port = $new->filterPort($new->port);
  2378. return $new;
  2379. }
  2380. public function withUserInfo($user, $password = null): self
  2381. {
  2382. $info = $user;
  2383. if (null !== $password && '' !== $password) {
  2384. $info .= ':' . $password;
  2385. }
  2386. if ($this->userInfo === $info) {
  2387. return $this;
  2388. }
  2389. $new = clone $this;
  2390. $new->userInfo = $info;
  2391. return $new;
  2392. }
  2393. public function withHost($host): self
  2394. {
  2395. if (!\is_string($host)) {
  2396. throw new \InvalidArgumentException('Host must be a string');
  2397. }
  2398. if ($this->host === $host = \strtolower($host)) {
  2399. return $this;
  2400. }
  2401. $new = clone $this;
  2402. $new->host = $host;
  2403. return $new;
  2404. }
  2405. public function withPort($port): self
  2406. {
  2407. if ($this->port === $port = $this->filterPort($port)) {
  2408. return $this;
  2409. }
  2410. $new = clone $this;
  2411. $new->port = $port;
  2412. return $new;
  2413. }
  2414. public function withPath($path): self
  2415. {
  2416. if ($this->path === $path = $this->filterPath($path)) {
  2417. return $this;
  2418. }
  2419. $new = clone $this;
  2420. $new->path = $path;
  2421. return $new;
  2422. }
  2423. public function withQuery($query): self
  2424. {
  2425. if ($this->query === $query = $this->filterQueryAndFragment($query)) {
  2426. return $this;
  2427. }
  2428. $new = clone $this;
  2429. $new->query = $query;
  2430. return $new;
  2431. }
  2432. public function withFragment($fragment): self
  2433. {
  2434. if ($this->fragment === $fragment = $this->filterQueryAndFragment($fragment)) {
  2435. return $this;
  2436. }
  2437. $new = clone $this;
  2438. $new->fragment = $fragment;
  2439. return $new;
  2440. }
  2441. /**
  2442. * Create a URI string from its various parts.
  2443. */
  2444. private static function createUriString(string $scheme, string $authority, string $path, string $query, string $fragment): string
  2445. {
  2446. $uri = '';
  2447. if ('' !== $scheme) {
  2448. $uri .= $scheme . ':';
  2449. }
  2450. if ('' !== $authority) {
  2451. $uri .= '//' . $authority;
  2452. }
  2453. if ('' !== $path) {
  2454. if ('/' !== $path[0]) {
  2455. if ('' !== $authority) {
  2456. // If the path is rootless and an authority is present, the path MUST be prefixed by "/"
  2457. $path = '/' . $path;
  2458. }
  2459. } elseif (isset($path[1]) && '/' === $path[1]) {
  2460. if ('' === $authority) {
  2461. // If the path is starting with more than one "/" and no authority is present, the
  2462. // starting slashes MUST be reduced to one.
  2463. $path = '/' . \ltrim($path, '/');
  2464. }
  2465. }
  2466. $uri .= $path;
  2467. }
  2468. if ('' !== $query) {
  2469. $uri .= '?' . $query;
  2470. }
  2471. if ('' !== $fragment) {
  2472. $uri .= '#' . $fragment;
  2473. }
  2474. return $uri;
  2475. }
  2476. /**
  2477. * Is a given port non-standard for the current scheme?
  2478. */
  2479. private static function isNonStandardPort(string $scheme, int $port): bool
  2480. {
  2481. return !isset(self::SCHEMES[$scheme]) || $port !== self::SCHEMES[$scheme];
  2482. }
  2483. private function filterPort($port) /*:?int*/
  2484. {
  2485. if (null === $port) {
  2486. return null;
  2487. }
  2488. $port = (int) $port;
  2489. if (0 > $port || 0xffff < $port) {
  2490. throw new \InvalidArgumentException(\sprintf('Invalid port: %d. Must be between 0 and 65535', $port));
  2491. }
  2492. return self::isNonStandardPort($this->scheme, $port) ? $port : null;
  2493. }
  2494. private function filterPath($path): string
  2495. {
  2496. if (!\is_string($path)) {
  2497. throw new \InvalidArgumentException('Path must be a string');
  2498. }
  2499. return \preg_replace_callback('/(?:[^' . self::CHAR_UNRESERVED . self::CHAR_SUB_DELIMS . '%:@\/]++|%(?![A-Fa-f0-9]{2}))/', [__CLASS__, 'rawurlencodeMatchZero'], $path);
  2500. }
  2501. private function filterQueryAndFragment($str): string
  2502. {
  2503. if (!\is_string($str)) {
  2504. throw new \InvalidArgumentException('Query and fragment must be a string');
  2505. }
  2506. return \preg_replace_callback('/(?:[^' . self::CHAR_UNRESERVED . self::CHAR_SUB_DELIMS . '%:@\/\?]++|%(?![A-Fa-f0-9]{2}))/', [__CLASS__, 'rawurlencodeMatchZero'], $str);
  2507. }
  2508. private static function rawurlencodeMatchZero(array $match): string
  2509. {
  2510. return \rawurlencode($match[0]);
  2511. }
  2512. }
  2513. }
  2514. // file: vendor/nyholm/psr7-server/src/ServerRequestCreator.php
  2515. namespace Nyholm\Psr7Server {
  2516. use Psr\Http\Message\ServerRequestFactoryInterface;
  2517. use Psr\Http\Message\ServerRequestInterface;
  2518. use Psr\Http\Message\StreamFactoryInterface;
  2519. use Psr\Http\Message\StreamInterface;
  2520. use Psr\Http\Message\UploadedFileFactoryInterface;
  2521. use Psr\Http\Message\UploadedFileInterface;
  2522. use Psr\Http\Message\UriFactoryInterface;
  2523. use Psr\Http\Message\UriInterface;
  2524. /**
  2525. * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  2526. * @author Martijn van der Ven <martijn@vanderven.se>
  2527. */
  2528. final class ServerRequestCreator implements ServerRequestCreatorInterface
  2529. {
  2530. private $serverRequestFactory;
  2531. private $uriFactory;
  2532. private $uploadedFileFactory;
  2533. private $streamFactory;
  2534. public function __construct(
  2535. ServerRequestFactoryInterface $serverRequestFactory,
  2536. UriFactoryInterface $uriFactory,
  2537. UploadedFileFactoryInterface $uploadedFileFactory,
  2538. StreamFactoryInterface $streamFactory
  2539. ) {
  2540. $this->serverRequestFactory = $serverRequestFactory;
  2541. $this->uriFactory = $uriFactory;
  2542. $this->uploadedFileFactory = $uploadedFileFactory;
  2543. $this->streamFactory = $streamFactory;
  2544. }
  2545. /**
  2546. * {@inheritdoc}
  2547. */
  2548. public function fromGlobals(): ServerRequestInterface
  2549. {
  2550. $server = $_SERVER;
  2551. if (false === isset($server['REQUEST_METHOD'])) {
  2552. $server['REQUEST_METHOD'] = 'GET';
  2553. }
  2554. $headers = \function_exists('getallheaders') ? getallheaders() : static::getHeadersFromServer($_SERVER);
  2555. return $this->fromArrays($server, $headers, $_COOKIE, $_GET, $_POST, $_FILES, \fopen('php://input', 'r') ?: null);
  2556. }
  2557. /**
  2558. * {@inheritdoc}
  2559. */
  2560. public function fromArrays(array $server, array $headers = [], array $cookie = [], array $get = [], array $post = [], array $files = [], $body = null): ServerRequestInterface
  2561. {
  2562. $method = $this->getMethodFromEnv($server);
  2563. $uri = $this->getUriFromEnvWithHTTP($server);
  2564. $protocol = isset($server['SERVER_PROTOCOL']) ? \str_replace('HTTP/', '', $server['SERVER_PROTOCOL']) : '1.1';
  2565. $serverRequest = $this->serverRequestFactory->createServerRequest($method, $uri, $server);
  2566. foreach ($headers as $name => $value) {
  2567. $serverRequest = $serverRequest->withAddedHeader($name, $value);
  2568. }
  2569. $serverRequest = $serverRequest
  2570. ->withProtocolVersion($protocol)
  2571. ->withCookieParams($cookie)
  2572. ->withQueryParams($get)
  2573. ->withParsedBody($post)
  2574. ->withUploadedFiles($this->normalizeFiles($files));
  2575. if (null === $body) {
  2576. return $serverRequest;
  2577. }
  2578. if (\is_resource($body)) {
  2579. $body = $this->streamFactory->createStreamFromResource($body);
  2580. } elseif (\is_string($body)) {
  2581. $body = $this->streamFactory->createStream($body);
  2582. } elseif (!$body instanceof StreamInterface) {
  2583. throw new \InvalidArgumentException('The $body parameter to ServerRequestCreator::fromArrays must be string, resource or StreamInterface');
  2584. }
  2585. return $serverRequest->withBody($body);
  2586. }
  2587. /**
  2588. * Implementation from Zend\Diactoros\marshalHeadersFromSapi().
  2589. */
  2590. public static function getHeadersFromServer(array $server): array
  2591. {
  2592. $headers = [];
  2593. foreach ($server as $key => $value) {
  2594. // Apache prefixes environment variables with REDIRECT_
  2595. // if they are added by rewrite rules
  2596. if (0 === \strpos($key, 'REDIRECT_')) {
  2597. $key = \substr($key, 9);
  2598. // We will not overwrite existing variables with the
  2599. // prefixed versions, though
  2600. if (\array_key_exists($key, $server)) {
  2601. continue;
  2602. }
  2603. }
  2604. if ($value && 0 === \strpos($key, 'HTTP_')) {
  2605. $name = \strtr(\strtolower(\substr($key, 5)), '_', '-');
  2606. $headers[$name] = $value;
  2607. continue;
  2608. }
  2609. if ($value && 0 === \strpos($key, 'CONTENT_')) {
  2610. $name = 'content-'.\strtolower(\substr($key, 8));
  2611. $headers[$name] = $value;
  2612. continue;
  2613. }
  2614. }
  2615. return $headers;
  2616. }
  2617. private function getMethodFromEnv(array $environment): string
  2618. {
  2619. if (false === isset($environment['REQUEST_METHOD'])) {
  2620. throw new \InvalidArgumentException('Cannot determine HTTP method');
  2621. }
  2622. return $environment['REQUEST_METHOD'];
  2623. }
  2624. private function getUriFromEnvWithHTTP(array $environment): UriInterface
  2625. {
  2626. $uri = $this->createUriFromArray($environment);
  2627. if (empty($uri->getScheme())) {
  2628. $uri = $uri->withScheme('http');
  2629. }
  2630. return $uri;
  2631. }
  2632. /**
  2633. * Return an UploadedFile instance array.
  2634. *
  2635. * @param array $files A array which respect $_FILES structure
  2636. *
  2637. * @return UploadedFileInterface[]
  2638. *
  2639. * @throws \InvalidArgumentException for unrecognized values
  2640. */
  2641. private function normalizeFiles(array $files): array
  2642. {
  2643. $normalized = [];
  2644. foreach ($files as $key => $value) {
  2645. if ($value instanceof UploadedFileInterface) {
  2646. $normalized[$key] = $value;
  2647. } elseif (\is_array($value) && isset($value['tmp_name'])) {
  2648. $normalized[$key] = $this->createUploadedFileFromSpec($value);
  2649. } elseif (\is_array($value)) {
  2650. $normalized[$key] = $this->normalizeFiles($value);
  2651. } else {
  2652. throw new \InvalidArgumentException('Invalid value in files specification');
  2653. }
  2654. }
  2655. return $normalized;
  2656. }
  2657. /**
  2658. * Create and return an UploadedFile instance from a $_FILES specification.
  2659. *
  2660. * If the specification represents an array of values, this method will
  2661. * delegate to normalizeNestedFileSpec() and return that return value.
  2662. *
  2663. * @param array $value $_FILES struct
  2664. *
  2665. * @return array|UploadedFileInterface
  2666. */
  2667. private function createUploadedFileFromSpec(array $value)
  2668. {
  2669. if (\is_array($value['tmp_name'])) {
  2670. return $this->normalizeNestedFileSpec($value);
  2671. }
  2672. try {
  2673. $stream = $this->streamFactory->createStreamFromFile($value['tmp_name']);
  2674. } catch (\RuntimeException $e) {
  2675. $stream = $this->streamFactory->createStream();
  2676. }
  2677. return $this->uploadedFileFactory->createUploadedFile(
  2678. $stream,
  2679. (int) $value['size'],
  2680. (int) $value['error'],
  2681. $value['name'],
  2682. $value['type']
  2683. );
  2684. }
  2685. /**
  2686. * Normalize an array of file specifications.
  2687. *
  2688. * Loops through all nested files and returns a normalized array of
  2689. * UploadedFileInterface instances.
  2690. *
  2691. * @param array $files
  2692. *
  2693. * @return UploadedFileInterface[]
  2694. */
  2695. private function normalizeNestedFileSpec(array $files = []): array
  2696. {
  2697. $normalizedFiles = [];
  2698. foreach (\array_keys($files['tmp_name']) as $key) {
  2699. $spec = [
  2700. 'tmp_name' => $files['tmp_name'][$key],
  2701. 'size' => $files['size'][$key],
  2702. 'error' => $files['error'][$key],
  2703. 'name' => $files['name'][$key],
  2704. 'type' => $files['type'][$key],
  2705. ];
  2706. $normalizedFiles[$key] = $this->createUploadedFileFromSpec($spec);
  2707. }
  2708. return $normalizedFiles;
  2709. }
  2710. /**
  2711. * Create a new uri from server variable.
  2712. *
  2713. * @param array $server typically $_SERVER or similar structure
  2714. */
  2715. private function createUriFromArray(array $server): UriInterface
  2716. {
  2717. $uri = $this->uriFactory->createUri('');
  2718. if (isset($server['HTTP_X_FORWARDED_PROTO'])) {
  2719. $uri = $uri->withScheme($server['HTTP_X_FORWARDED_PROTO']);
  2720. } else {
  2721. if (isset($server['REQUEST_SCHEME'])) {
  2722. $uri = $uri->withScheme($server['REQUEST_SCHEME']);
  2723. } elseif (isset($server['HTTPS'])) {
  2724. $uri = $uri->withScheme('on' === $server['HTTPS'] ? 'https' : 'http');
  2725. }
  2726. if (isset($server['SERVER_PORT'])) {
  2727. $uri = $uri->withPort($server['SERVER_PORT']);
  2728. }
  2729. }
  2730. if (isset($server['HTTP_HOST'])) {
  2731. if (1 === \preg_match('/^(.+)\:(\d+)$/', $server['HTTP_HOST'], $matches)) {
  2732. $uri = $uri->withHost($matches[1])->withPort($matches[2]);
  2733. } else {
  2734. $uri = $uri->withHost($server['HTTP_HOST']);
  2735. }
  2736. } elseif (isset($server['SERVER_NAME'])) {
  2737. $uri = $uri->withHost($server['SERVER_NAME']);
  2738. }
  2739. if (isset($server['REQUEST_URI'])) {
  2740. $uri = $uri->withPath(\current(\explode('?', $server['REQUEST_URI'])));
  2741. }
  2742. if (isset($server['QUERY_STRING'])) {
  2743. $uri = $uri->withQuery($server['QUERY_STRING']);
  2744. }
  2745. return $uri;
  2746. }
  2747. }
  2748. }
  2749. // file: vendor/nyholm/psr7-server/src/ServerRequestCreatorInterface.php
  2750. namespace Nyholm\Psr7Server {
  2751. use Psr\Http\Message\ServerRequestInterface;
  2752. use Psr\Http\Message\StreamInterface;
  2753. /**
  2754. * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  2755. * @author Martijn van der Ven <martijn@vanderven.se>
  2756. */
  2757. interface ServerRequestCreatorInterface
  2758. {
  2759. /**
  2760. * Create a new server request from the current environment variables.
  2761. * Defaults to a GET request to minimise the risk of an \InvalidArgumentException.
  2762. * Includes the current request headers as supplied by the server through `getallheaders()`.
  2763. * If `getallheaders()` is unavailable on the current server it will fallback to its own `getHeadersFromServer()` method.
  2764. * Defaults to php://input for the request body.
  2765. *
  2766. * @throws \InvalidArgumentException if no valid method or URI can be determined
  2767. */
  2768. public function fromGlobals(): ServerRequestInterface;
  2769. /**
  2770. * Create a new server request from a set of arrays.
  2771. *
  2772. * @param array $server typically $_SERVER or similar structure
  2773. * @param array $headers typically the output of getallheaders() or similar structure
  2774. * @param array $cookie typically $_COOKIE or similar structure
  2775. * @param array $get typically $_GET or similar structure
  2776. * @param array $post typically $_POST or similar structure
  2777. * @param array $files typically $_FILES or similar structure
  2778. * @param StreamInterface|resource|string|null $body Typically stdIn
  2779. *
  2780. * @throws \InvalidArgumentException if no valid method or URI can be determined
  2781. */
  2782. public function fromArrays(
  2783. array $server,
  2784. array $headers = [],
  2785. array $cookie = [],
  2786. array $get = [],
  2787. array $post = [],
  2788. array $files = [],
  2789. $body = null
  2790. ): ServerRequestInterface;
  2791. /**
  2792. * Get parsed headers from ($_SERVER) array.
  2793. *
  2794. * @param array $server typically $_SERVER or similar structure
  2795. *
  2796. * @return array
  2797. */
  2798. public static function getHeadersFromServer(array $server): array;
  2799. }
  2800. }
  2801. // file: src/Tqdev/PhpCrudApi/Cache/Cache.php
  2802. namespace Tqdev\PhpCrudApi\Cache {
  2803. interface Cache
  2804. {
  2805. public function set(string $key, string $value, int $ttl = 0): bool;
  2806. public function get(string $key): string;
  2807. public function clear(): bool;
  2808. }
  2809. }
  2810. // file: src/Tqdev/PhpCrudApi/Cache/CacheFactory.php
  2811. namespace Tqdev\PhpCrudApi\Cache {
  2812. class CacheFactory
  2813. {
  2814. public static function create(string $type, string $prefix, string $config): Cache
  2815. {
  2816. switch ($type) {
  2817. case 'TempFile':
  2818. $cache = new TempFileCache($prefix, $config);
  2819. break;
  2820. case 'Redis':
  2821. $cache = new RedisCache($prefix, $config);
  2822. break;
  2823. case 'Memcache':
  2824. $cache = new MemcacheCache($prefix, $config);
  2825. break;
  2826. case 'Memcached':
  2827. $cache = new MemcachedCache($prefix, $config);
  2828. break;
  2829. default:
  2830. $cache = new NoCache();
  2831. }
  2832. return $cache;
  2833. }
  2834. }
  2835. }
  2836. // file: src/Tqdev/PhpCrudApi/Cache/MemcacheCache.php
  2837. namespace Tqdev\PhpCrudApi\Cache {
  2838. class MemcacheCache implements Cache
  2839. {
  2840. protected $prefix;
  2841. protected $memcache;
  2842. public function __construct(string $prefix, string $config)
  2843. {
  2844. $this->prefix = $prefix;
  2845. if ($config == '') {
  2846. $address = 'localhost';
  2847. $port = 11211;
  2848. } elseif (strpos($config, ':') === false) {
  2849. $address = $config;
  2850. $port = 11211;
  2851. } else {
  2852. list($address, $port) = explode(':', $config);
  2853. }
  2854. $this->memcache = $this->create();
  2855. $this->memcache->addServer($address, $port);
  2856. }
  2857. protected function create() /*: \Memcache*/
  2858. {
  2859. return new \Memcache();
  2860. }
  2861. public function set(string $key, string $value, int $ttl = 0): bool
  2862. {
  2863. return $this->memcache->set($this->prefix . $key, $value, 0, $ttl);
  2864. }
  2865. public function get(string $key): string
  2866. {
  2867. return $this->memcache->get($this->prefix . $key) ?: '';
  2868. }
  2869. public function clear(): bool
  2870. {
  2871. return $this->memcache->flush();
  2872. }
  2873. }
  2874. }
  2875. // file: src/Tqdev/PhpCrudApi/Cache/MemcachedCache.php
  2876. namespace Tqdev\PhpCrudApi\Cache {
  2877. class MemcachedCache extends MemcacheCache
  2878. {
  2879. protected function create() /*: \Memcached*/
  2880. {
  2881. return new \Memcached();
  2882. }
  2883. public function set(string $key, string $value, int $ttl = 0): bool
  2884. {
  2885. return $this->memcache->set($this->prefix . $key, $value, $ttl);
  2886. }
  2887. }
  2888. }
  2889. // file: src/Tqdev/PhpCrudApi/Cache/NoCache.php
  2890. namespace Tqdev\PhpCrudApi\Cache {
  2891. class NoCache implements Cache
  2892. {
  2893. public function __construct()
  2894. {
  2895. }
  2896. public function set(string $key, string $value, int $ttl = 0): bool
  2897. {
  2898. return true;
  2899. }
  2900. public function get(string $key): string
  2901. {
  2902. return '';
  2903. }
  2904. public function clear(): bool
  2905. {
  2906. return true;
  2907. }
  2908. }
  2909. }
  2910. // file: src/Tqdev/PhpCrudApi/Cache/RedisCache.php
  2911. namespace Tqdev\PhpCrudApi\Cache {
  2912. class RedisCache implements Cache
  2913. {
  2914. protected $prefix;
  2915. protected $redis;
  2916. public function __construct(string $prefix, string $config)
  2917. {
  2918. $this->prefix = $prefix;
  2919. if ($config == '') {
  2920. $config = '127.0.0.1';
  2921. }
  2922. $params = explode(':', $config, 6);
  2923. if (isset($params[3])) {
  2924. $params[3] = null;
  2925. }
  2926. $this->redis = new \Redis();
  2927. call_user_func_array(array($this->redis, 'pconnect'), $params);
  2928. }
  2929. public function set(string $key, string $value, int $ttl = 0): bool
  2930. {
  2931. return $this->redis->set($this->prefix . $key, $value, $ttl);
  2932. }
  2933. public function get(string $key): string
  2934. {
  2935. return $this->redis->get($this->prefix . $key) ?: '';
  2936. }
  2937. public function clear(): bool
  2938. {
  2939. return $this->redis->flushDb();
  2940. }
  2941. }
  2942. }
  2943. // file: src/Tqdev/PhpCrudApi/Cache/TempFileCache.php
  2944. namespace Tqdev\PhpCrudApi\Cache {
  2945. class TempFileCache implements Cache
  2946. {
  2947. const SUFFIX = 'cache';
  2948. private $path;
  2949. private $segments;
  2950. public function __construct(string $prefix, string $config)
  2951. {
  2952. $this->segments = [];
  2953. $s = DIRECTORY_SEPARATOR;
  2954. $ps = PATH_SEPARATOR;
  2955. if ($config == '') {
  2956. $this->path = sys_get_temp_dir() . $s . $prefix . self::SUFFIX;
  2957. } elseif (strpos($config, $ps) === false) {
  2958. $this->path = $config;
  2959. } else {
  2960. list($path, $segments) = explode($ps, $config);
  2961. $this->path = $path;
  2962. $this->segments = explode(',', $segments);
  2963. }
  2964. if (file_exists($this->path) && is_dir($this->path)) {
  2965. $this->clean($this->path, array_filter($this->segments), strlen(md5('')), false);
  2966. }
  2967. }
  2968. private function getFileName(string $key): string
  2969. {
  2970. $s = DIRECTORY_SEPARATOR;
  2971. $md5 = md5($key);
  2972. $filename = rtrim($this->path, $s) . $s;
  2973. $i = 0;
  2974. foreach ($this->segments as $segment) {
  2975. $filename .= substr($md5, $i, $segment) . $s;
  2976. $i += $segment;
  2977. }
  2978. $filename .= substr($md5, $i);
  2979. return $filename;
  2980. }
  2981. public function set(string $key, string $value, int $ttl = 0): bool
  2982. {
  2983. $filename = $this->getFileName($key);
  2984. $dirname = dirname($filename);
  2985. if (!file_exists($dirname)) {
  2986. if (!mkdir($dirname, 0755, true)) {
  2987. return false;
  2988. }
  2989. }
  2990. $string = $ttl . '|' . $value;
  2991. return $this->filePutContents($filename, $string) !== false;
  2992. }
  2993. private function filePutContents($filename, $string)
  2994. {
  2995. return file_put_contents($filename, $string, LOCK_EX);
  2996. }
  2997. private function fileGetContents($filename)
  2998. {
  2999. $file = fopen($filename, 'rb');
  3000. if ($file === false) {
  3001. return false;
  3002. }
  3003. $lock = flock($file, LOCK_SH);
  3004. if (!$lock) {
  3005. fclose($file);
  3006. return false;
  3007. }
  3008. $string = '';
  3009. while (!feof($file)) {
  3010. $string .= fread($file, 8192);
  3011. }
  3012. flock($file, LOCK_UN);
  3013. fclose($file);
  3014. return $string;
  3015. }
  3016. private function getString($filename): string
  3017. {
  3018. $data = $this->fileGetContents($filename);
  3019. if ($data === false) {
  3020. return '';
  3021. }
  3022. if (strpos($data, '|') === false) {
  3023. return '';
  3024. }
  3025. list($ttl, $string) = explode('|', $data, 2);
  3026. if ($ttl > 0 && time() - filemtime($filename) > $ttl) {
  3027. return '';
  3028. }
  3029. return $string;
  3030. }
  3031. public function get(string $key): string
  3032. {
  3033. $filename = $this->getFileName($key);
  3034. if (!file_exists($filename)) {
  3035. return '';
  3036. }
  3037. $string = $this->getString($filename);
  3038. if ($string == null) {
  3039. return '';
  3040. }
  3041. return $string;
  3042. }
  3043. private function clean(string $path, array $segments, int $len, bool $all) /*: void*/
  3044. {
  3045. $entries = scandir($path);
  3046. foreach ($entries as $entry) {
  3047. if ($entry === '.' || $entry === '..') {
  3048. continue;
  3049. }
  3050. $filename = $path . DIRECTORY_SEPARATOR . $entry;
  3051. if (count($segments) == 0) {
  3052. if (strlen($entry) != $len) {
  3053. continue;
  3054. }
  3055. if (file_exists($filename) && is_file($filename)) {
  3056. if ($all || $this->getString($filename) == null) {
  3057. @unlink($filename);
  3058. }
  3059. }
  3060. } else {
  3061. if (strlen($entry) != $segments[0]) {
  3062. continue;
  3063. }
  3064. if (file_exists($filename) && is_dir($filename)) {
  3065. $this->clean($filename, array_slice($segments, 1), $len - $segments[0], $all);
  3066. @rmdir($filename);
  3067. }
  3068. }
  3069. }
  3070. }
  3071. public function clear(): bool
  3072. {
  3073. if (!file_exists($this->path) || !is_dir($this->path)) {
  3074. return false;
  3075. }
  3076. $this->clean($this->path, array_filter($this->segments), strlen(md5('')), true);
  3077. return true;
  3078. }
  3079. }
  3080. }
  3081. // file: src/Tqdev/PhpCrudApi/Column/Reflection/ReflectedColumn.php
  3082. namespace Tqdev\PhpCrudApi\Column\Reflection {
  3083. use Tqdev\PhpCrudApi\Database\GenericReflection;
  3084. class ReflectedColumn implements \JsonSerializable
  3085. {
  3086. const DEFAULT_LENGTH = 255;
  3087. const DEFAULT_PRECISION = 19;
  3088. const DEFAULT_SCALE = 4;
  3089. private $name;
  3090. private $type;
  3091. private $length;
  3092. private $precision;
  3093. private $scale;
  3094. private $nullable;
  3095. private $pk;
  3096. private $fk;
  3097. public function __construct(string $name, string $type, int $length, int $precision, int $scale, bool $nullable, bool $pk, string $fk)
  3098. {
  3099. $this->name = $name;
  3100. $this->type = $type;
  3101. $this->length = $length;
  3102. $this->precision = $precision;
  3103. $this->scale = $scale;
  3104. $this->nullable = $nullable;
  3105. $this->pk = $pk;
  3106. $this->fk = $fk;
  3107. $this->sanitize();
  3108. }
  3109. private static function parseColumnType(string $columnType, int &$length, int &$precision, int &$scale) /*: void*/
  3110. {
  3111. if (!$columnType) {
  3112. return;
  3113. }
  3114. $pos = strpos($columnType, '(');
  3115. if ($pos) {
  3116. $dataSize = rtrim(substr($columnType, $pos + 1), ')');
  3117. if ($length) {
  3118. $length = (int) $dataSize;
  3119. } else {
  3120. $pos = strpos($dataSize, ',');
  3121. if ($pos) {
  3122. $precision = (int) substr($dataSize, 0, $pos);
  3123. $scale = (int) substr($dataSize, $pos + 1);
  3124. } else {
  3125. $precision = (int) $dataSize;
  3126. $scale = 0;
  3127. }
  3128. }
  3129. }
  3130. }
  3131. private static function getDataSize(int $length, int $precision, int $scale): string
  3132. {
  3133. $dataSize = '';
  3134. if ($length) {
  3135. $dataSize = $length;
  3136. } elseif ($precision) {
  3137. if ($scale) {
  3138. $dataSize = $precision . ',' . $scale;
  3139. } else {
  3140. $dataSize = $precision;
  3141. }
  3142. }
  3143. return $dataSize;
  3144. }
  3145. public static function fromReflection(GenericReflection $reflection, array $columnResult): ReflectedColumn
  3146. {
  3147. $name = $columnResult['COLUMN_NAME'];
  3148. $dataType = $columnResult['DATA_TYPE'];
  3149. $length = (int) $columnResult['CHARACTER_MAXIMUM_LENGTH'];
  3150. $precision = (int) $columnResult['NUMERIC_PRECISION'];
  3151. $scale = (int) $columnResult['NUMERIC_SCALE'];
  3152. $columnType = $columnResult['COLUMN_TYPE'];
  3153. self::parseColumnType($columnType, $length, $precision, $scale);
  3154. $dataSize = self::getDataSize($length, $precision, $scale);
  3155. $type = $reflection->toJdbcType($dataType, $dataSize);
  3156. $nullable = in_array(strtoupper($columnResult['IS_NULLABLE']), ['TRUE', 'YES', 'T', 'Y', '1']);
  3157. $pk = false;
  3158. $fk = '';
  3159. return new ReflectedColumn($name, $type, $length, $precision, $scale, $nullable, $pk, $fk);
  3160. }
  3161. public static function fromJson(/* object */$json): ReflectedColumn
  3162. {
  3163. $name = $json->name;
  3164. $type = $json->type;
  3165. $length = isset($json->length) ? (int) $json->length : 0;
  3166. $precision = isset($json->precision) ? (int) $json->precision : 0;
  3167. $scale = isset($json->scale) ? (int) $json->scale : 0;
  3168. $nullable = isset($json->nullable) ? (bool) $json->nullable : false;
  3169. $pk = isset($json->pk) ? (bool) $json->pk : false;
  3170. $fk = isset($json->fk) ? $json->fk : '';
  3171. return new ReflectedColumn($name, $type, $length, $precision, $scale, $nullable, $pk, $fk);
  3172. }
  3173. private function sanitize()
  3174. {
  3175. $this->length = $this->hasLength() ? $this->getLength() : 0;
  3176. $this->precision = $this->hasPrecision() ? $this->getPrecision() : 0;
  3177. $this->scale = $this->hasScale() ? $this->getScale() : 0;
  3178. }
  3179. public function getName(): string
  3180. {
  3181. return $this->name;
  3182. }
  3183. public function getNullable(): bool
  3184. {
  3185. return $this->nullable;
  3186. }
  3187. public function getType(): string
  3188. {
  3189. return $this->type;
  3190. }
  3191. public function getLength(): int
  3192. {
  3193. return $this->length ?: self::DEFAULT_LENGTH;
  3194. }
  3195. public function getPrecision(): int
  3196. {
  3197. return $this->precision ?: self::DEFAULT_PRECISION;
  3198. }
  3199. public function getScale(): int
  3200. {
  3201. return $this->scale ?: self::DEFAULT_SCALE;
  3202. }
  3203. public function hasLength(): bool
  3204. {
  3205. return in_array($this->type, ['varchar', 'varbinary']);
  3206. }
  3207. public function hasPrecision(): bool
  3208. {
  3209. return $this->type == 'decimal';
  3210. }
  3211. public function hasScale(): bool
  3212. {
  3213. return $this->type == 'decimal';
  3214. }
  3215. public function isBinary(): bool
  3216. {
  3217. return in_array($this->type, ['blob', 'varbinary']);
  3218. }
  3219. public function isBoolean(): bool
  3220. {
  3221. return $this->type == 'boolean';
  3222. }
  3223. public function isGeometry(): bool
  3224. {
  3225. return $this->type == 'geometry';
  3226. }
  3227. public function isInteger(): bool
  3228. {
  3229. return in_array($this->type, ['integer', 'bigint', 'smallint', 'tinyint']);
  3230. }
  3231. public function setPk($value) /*: void*/
  3232. {
  3233. $this->pk = $value;
  3234. }
  3235. public function getPk(): bool
  3236. {
  3237. return $this->pk;
  3238. }
  3239. public function setFk($value) /*: void*/
  3240. {
  3241. $this->fk = $value;
  3242. }
  3243. public function getFk(): string
  3244. {
  3245. return $this->fk;
  3246. }
  3247. public function serialize()
  3248. {
  3249. return [
  3250. 'name' => $this->name,
  3251. 'type' => $this->type,
  3252. 'length' => $this->length,
  3253. 'precision' => $this->precision,
  3254. 'scale' => $this->scale,
  3255. 'nullable' => $this->nullable,
  3256. 'pk' => $this->pk,
  3257. 'fk' => $this->fk,
  3258. ];
  3259. }
  3260. public function jsonSerialize()
  3261. {
  3262. return array_filter($this->serialize());
  3263. }
  3264. }
  3265. }
  3266. // file: src/Tqdev/PhpCrudApi/Column/Reflection/ReflectedDatabase.php
  3267. namespace Tqdev\PhpCrudApi\Column\Reflection {
  3268. use Tqdev\PhpCrudApi\Database\GenericReflection;
  3269. class ReflectedDatabase implements \JsonSerializable
  3270. {
  3271. private $tableTypes;
  3272. public function __construct(array $tableTypes)
  3273. {
  3274. $this->tableTypes = $tableTypes;
  3275. }
  3276. public static function fromReflection(GenericReflection $reflection): ReflectedDatabase
  3277. {
  3278. $tableTypes = [];
  3279. foreach ($reflection->getTables() as $table) {
  3280. $tableName = $table['TABLE_NAME'];
  3281. $tableType = $table['TABLE_TYPE'];
  3282. if (in_array($tableName, $reflection->getIgnoredTables())) {
  3283. continue;
  3284. }
  3285. $tableTypes[$tableName] = $tableType;
  3286. }
  3287. return new ReflectedDatabase($tableTypes);
  3288. }
  3289. public static function fromJson(/* object */$json): ReflectedDatabase
  3290. {
  3291. $tableTypes = (array) $json->tables;
  3292. return new ReflectedDatabase($tableTypes);
  3293. }
  3294. public function hasTable(string $tableName): bool
  3295. {
  3296. return isset($this->tableTypes[$tableName]);
  3297. }
  3298. public function getType(string $tableName): string
  3299. {
  3300. return isset($this->tableTypes[$tableName]) ? $this->tableTypes[$tableName] : '';
  3301. }
  3302. public function getTableNames(): array
  3303. {
  3304. return array_keys($this->tableTypes);
  3305. }
  3306. public function removeTable(string $tableName): bool
  3307. {
  3308. if (!isset($this->tableTypes[$tableName])) {
  3309. return false;
  3310. }
  3311. unset($this->tableTypes[$tableName]);
  3312. return true;
  3313. }
  3314. public function serialize()
  3315. {
  3316. return [
  3317. 'tables' => $this->tableTypes,
  3318. ];
  3319. }
  3320. public function jsonSerialize()
  3321. {
  3322. return $this->serialize();
  3323. }
  3324. }
  3325. }
  3326. // file: src/Tqdev/PhpCrudApi/Column/Reflection/ReflectedTable.php
  3327. namespace Tqdev\PhpCrudApi\Column\Reflection {
  3328. use Tqdev\PhpCrudApi\Database\GenericReflection;
  3329. class ReflectedTable implements \JsonSerializable
  3330. {
  3331. private $name;
  3332. private $type;
  3333. private $columns;
  3334. private $pk;
  3335. private $fks;
  3336. public function __construct(string $name, string $type, array $columns)
  3337. {
  3338. $this->name = $name;
  3339. $this->type = $type;
  3340. // set columns
  3341. $this->columns = [];
  3342. foreach ($columns as $column) {
  3343. $columnName = $column->getName();
  3344. $this->columns[$columnName] = $column;
  3345. }
  3346. // set primary key
  3347. $this->pk = null;
  3348. foreach ($columns as $column) {
  3349. if ($column->getPk() == true) {
  3350. $this->pk = $column;
  3351. }
  3352. }
  3353. // set foreign keys
  3354. $this->fks = [];
  3355. foreach ($columns as $column) {
  3356. $columnName = $column->getName();
  3357. $referencedTableName = $column->getFk();
  3358. if ($referencedTableName != '') {
  3359. $this->fks[$columnName] = $referencedTableName;
  3360. }
  3361. }
  3362. }
  3363. public static function fromReflection(GenericReflection $reflection, string $name, string $type): ReflectedTable
  3364. {
  3365. // set columns
  3366. $columns = [];
  3367. foreach ($reflection->getTableColumns($name, $type) as $tableColumn) {
  3368. $column = ReflectedColumn::fromReflection($reflection, $tableColumn);
  3369. $columns[$column->getName()] = $column;
  3370. }
  3371. // set primary key
  3372. $columnNames = $reflection->getTablePrimaryKeys($name);
  3373. if (count($columnNames) == 1) {
  3374. $columnName = $columnNames[0];
  3375. if (isset($columns[$columnName])) {
  3376. $pk = $columns[$columnName];
  3377. $pk->setPk(true);
  3378. }
  3379. }
  3380. // set foreign keys
  3381. $fks = $reflection->getTableForeignKeys($name);
  3382. foreach ($fks as $columnName => $table) {
  3383. $columns[$columnName]->setFk($table);
  3384. }
  3385. return new ReflectedTable($name, $type, array_values($columns));
  3386. }
  3387. public static function fromJson(/* object */$json): ReflectedTable
  3388. {
  3389. $name = $json->name;
  3390. $type = isset($json->type) ? $json->type : 'table';
  3391. $columns = [];
  3392. if (isset($json->columns) && is_array($json->columns)) {
  3393. foreach ($json->columns as $column) {
  3394. $columns[] = ReflectedColumn::fromJson($column);
  3395. }
  3396. }
  3397. return new ReflectedTable($name, $type, $columns);
  3398. }
  3399. public function hasColumn(string $columnName): bool
  3400. {
  3401. return isset($this->columns[$columnName]);
  3402. }
  3403. public function hasPk(): bool
  3404. {
  3405. return $this->pk != null;
  3406. }
  3407. public function getPk() /*: ?ReflectedColumn */
  3408. {
  3409. return $this->pk;
  3410. }
  3411. public function getName(): string
  3412. {
  3413. return $this->name;
  3414. }
  3415. public function getType(): string
  3416. {
  3417. return $this->type;
  3418. }
  3419. public function getColumnNames(): array
  3420. {
  3421. return array_keys($this->columns);
  3422. }
  3423. public function getColumn($columnName): ReflectedColumn
  3424. {
  3425. return $this->columns[$columnName];
  3426. }
  3427. public function getFksTo(string $tableName): array
  3428. {
  3429. $columns = array();
  3430. foreach ($this->fks as $columnName => $referencedTableName) {
  3431. if ($tableName == $referencedTableName) {
  3432. $columns[] = $this->columns[$columnName];
  3433. }
  3434. }
  3435. return $columns;
  3436. }
  3437. public function removeColumn(string $columnName): bool
  3438. {
  3439. if (!isset($this->columns[$columnName])) {
  3440. return false;
  3441. }
  3442. unset($this->columns[$columnName]);
  3443. return true;
  3444. }
  3445. public function serialize()
  3446. {
  3447. return [
  3448. 'name' => $this->name,
  3449. 'type' => $this->type,
  3450. 'columns' => array_values($this->columns),
  3451. ];
  3452. }
  3453. public function jsonSerialize()
  3454. {
  3455. return $this->serialize();
  3456. }
  3457. }
  3458. }
  3459. // file: src/Tqdev/PhpCrudApi/Column/DefinitionService.php
  3460. namespace Tqdev\PhpCrudApi\Column {
  3461. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedColumn;
  3462. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedTable;
  3463. use Tqdev\PhpCrudApi\Database\GenericDB;
  3464. class DefinitionService
  3465. {
  3466. private $db;
  3467. private $reflection;
  3468. public function __construct(GenericDB $db, ReflectionService $reflection)
  3469. {
  3470. $this->db = $db;
  3471. $this->reflection = $reflection;
  3472. }
  3473. public function updateTable(string $tableName, /* object */ $changes): bool
  3474. {
  3475. $table = $this->reflection->getTable($tableName);
  3476. $newTable = ReflectedTable::fromJson((object) array_merge((array) $table->jsonSerialize(), (array) $changes));
  3477. if ($table->getName() != $newTable->getName()) {
  3478. if (!$this->db->definition()->renameTable($table->getName(), $newTable->getName())) {
  3479. return false;
  3480. }
  3481. }
  3482. return true;
  3483. }
  3484. public function updateColumn(string $tableName, string $columnName, /* object */ $changes): bool
  3485. {
  3486. $table = $this->reflection->getTable($tableName);
  3487. $column = $table->getColumn($columnName);
  3488. // remove constraints on other column
  3489. $newColumn = ReflectedColumn::fromJson((object) array_merge((array) $column->jsonSerialize(), (array) $changes));
  3490. if ($newColumn->getPk() != $column->getPk() && $table->hasPk()) {
  3491. $oldColumn = $table->getPk();
  3492. if ($oldColumn->getName() != $columnName) {
  3493. $oldColumn->setPk(false);
  3494. if (!$this->db->definition()->removeColumnPrimaryKey($table->getName(), $oldColumn->getName(), $oldColumn)) {
  3495. return false;
  3496. }
  3497. }
  3498. }
  3499. // remove constraints
  3500. $newColumn = ReflectedColumn::fromJson((object) array_merge((array) $column->jsonSerialize(), ['pk' => false, 'fk' => false]));
  3501. if ($newColumn->getPk() != $column->getPk() && !$newColumn->getPk()) {
  3502. if (!$this->db->definition()->removeColumnPrimaryKey($table->getName(), $column->getName(), $newColumn)) {
  3503. return false;
  3504. }
  3505. }
  3506. if ($newColumn->getFk() != $column->getFk() && !$newColumn->getFk()) {
  3507. if (!$this->db->definition()->removeColumnForeignKey($table->getName(), $column->getName(), $newColumn)) {
  3508. return false;
  3509. }
  3510. }
  3511. // name and type
  3512. $newColumn = ReflectedColumn::fromJson((object) array_merge((array) $column->jsonSerialize(), (array) $changes));
  3513. $newColumn->setPk(false);
  3514. $newColumn->setFk('');
  3515. if ($newColumn->getName() != $column->getName()) {
  3516. if (!$this->db->definition()->renameColumn($table->getName(), $column->getName(), $newColumn)) {
  3517. return false;
  3518. }
  3519. }
  3520. if (
  3521. $newColumn->getType() != $column->getType() ||
  3522. $newColumn->getLength() != $column->getLength() ||
  3523. $newColumn->getPrecision() != $column->getPrecision() ||
  3524. $newColumn->getScale() != $column->getScale()
  3525. ) {
  3526. if (!$this->db->definition()->retypeColumn($table->getName(), $newColumn->getName(), $newColumn)) {
  3527. return false;
  3528. }
  3529. }
  3530. if ($newColumn->getNullable() != $column->getNullable()) {
  3531. if (!$this->db->definition()->setColumnNullable($table->getName(), $newColumn->getName(), $newColumn)) {
  3532. return false;
  3533. }
  3534. }
  3535. // add constraints
  3536. $newColumn = ReflectedColumn::fromJson((object) array_merge((array) $column->jsonSerialize(), (array) $changes));
  3537. if ($newColumn->getFk()) {
  3538. if (!$this->db->definition()->addColumnForeignKey($table->getName(), $newColumn->getName(), $newColumn)) {
  3539. return false;
  3540. }
  3541. }
  3542. if ($newColumn->getPk()) {
  3543. if (!$this->db->definition()->addColumnPrimaryKey($table->getName(), $newColumn->getName(), $newColumn)) {
  3544. return false;
  3545. }
  3546. }
  3547. return true;
  3548. }
  3549. public function addTable(/* object */$definition)
  3550. {
  3551. $newTable = ReflectedTable::fromJson($definition);
  3552. if (!$this->db->definition()->addTable($newTable)) {
  3553. return false;
  3554. }
  3555. return true;
  3556. }
  3557. public function addColumn(string $tableName, /* object */ $definition)
  3558. {
  3559. $newColumn = ReflectedColumn::fromJson($definition);
  3560. if (!$this->db->definition()->addColumn($tableName, $newColumn)) {
  3561. return false;
  3562. }
  3563. if ($newColumn->getFk()) {
  3564. if (!$this->db->definition()->addColumnForeignKey($tableName, $newColumn->getName(), $newColumn)) {
  3565. return false;
  3566. }
  3567. }
  3568. if ($newColumn->getPk()) {
  3569. if (!$this->db->definition()->addColumnPrimaryKey($tableName, $newColumn->getName(), $newColumn)) {
  3570. return false;
  3571. }
  3572. }
  3573. return true;
  3574. }
  3575. public function removeTable(string $tableName)
  3576. {
  3577. if (!$this->db->definition()->removeTable($tableName)) {
  3578. return false;
  3579. }
  3580. return true;
  3581. }
  3582. public function removeColumn(string $tableName, string $columnName)
  3583. {
  3584. $table = $this->reflection->getTable($tableName);
  3585. $newColumn = $table->getColumn($columnName);
  3586. if ($newColumn->getPk()) {
  3587. $newColumn->setPk(false);
  3588. if (!$this->db->definition()->removeColumnPrimaryKey($table->getName(), $newColumn->getName(), $newColumn)) {
  3589. return false;
  3590. }
  3591. }
  3592. if ($newColumn->getFk()) {
  3593. $newColumn->setFk("");
  3594. if (!$this->db->definition()->removeColumnForeignKey($tableName, $columnName, $newColumn)) {
  3595. return false;
  3596. }
  3597. }
  3598. if (!$this->db->definition()->removeColumn($tableName, $columnName)) {
  3599. return false;
  3600. }
  3601. return true;
  3602. }
  3603. }
  3604. }
  3605. // file: src/Tqdev/PhpCrudApi/Column/ReflectionService.php
  3606. namespace Tqdev\PhpCrudApi\Column {
  3607. use Tqdev\PhpCrudApi\Cache\Cache;
  3608. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedDatabase;
  3609. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedTable;
  3610. use Tqdev\PhpCrudApi\Database\GenericDB;
  3611. class ReflectionService
  3612. {
  3613. private $db;
  3614. private $cache;
  3615. private $ttl;
  3616. private $database;
  3617. private $tables;
  3618. public function __construct(GenericDB $db, Cache $cache, int $ttl)
  3619. {
  3620. $this->db = $db;
  3621. $this->cache = $cache;
  3622. $this->ttl = $ttl;
  3623. $this->database = null;
  3624. $this->tables = [];
  3625. }
  3626. private function database(): ReflectedDatabase
  3627. {
  3628. if ($this->database) {
  3629. return $this->database;
  3630. }
  3631. $this->database = $this->loadDatabase(true);
  3632. return $this->database;
  3633. }
  3634. private function loadDatabase(bool $useCache): ReflectedDatabase
  3635. {
  3636. $key = sprintf('%s-ReflectedDatabase', $this->db->getCacheKey());
  3637. $data = $useCache ? $this->cache->get($key) : '';
  3638. if ($data != '') {
  3639. $database = ReflectedDatabase::fromJson(json_decode(gzuncompress($data)));
  3640. } else {
  3641. $database = ReflectedDatabase::fromReflection($this->db->reflection());
  3642. $data = gzcompress(json_encode($database, JSON_UNESCAPED_UNICODE));
  3643. $this->cache->set($key, $data, $this->ttl);
  3644. }
  3645. return $database;
  3646. }
  3647. private function loadTable(string $tableName, bool $useCache): ReflectedTable
  3648. {
  3649. $key = sprintf('%s-ReflectedTable(%s)', $this->db->getCacheKey(), $tableName);
  3650. $data = $useCache ? $this->cache->get($key) : '';
  3651. if ($data != '') {
  3652. $table = ReflectedTable::fromJson(json_decode(gzuncompress($data)));
  3653. } else {
  3654. $tableType = $this->database()->getType($tableName);
  3655. $table = ReflectedTable::fromReflection($this->db->reflection(), $tableName, $tableType);
  3656. $data = gzcompress(json_encode($table, JSON_UNESCAPED_UNICODE));
  3657. $this->cache->set($key, $data, $this->ttl);
  3658. }
  3659. return $table;
  3660. }
  3661. public function refreshTables()
  3662. {
  3663. $this->database = $this->loadDatabase(false);
  3664. }
  3665. public function refreshTable(string $tableName)
  3666. {
  3667. $this->tables[$tableName] = $this->loadTable($tableName, false);
  3668. }
  3669. public function hasTable(string $tableName): bool
  3670. {
  3671. return $this->database()->hasTable($tableName);
  3672. }
  3673. public function getType(string $tableName): string
  3674. {
  3675. return $this->database()->getType($tableName);
  3676. }
  3677. public function getTable(string $tableName): ReflectedTable
  3678. {
  3679. if (!isset($this->tables[$tableName])) {
  3680. $this->tables[$tableName] = $this->loadTable($tableName, true);
  3681. }
  3682. return $this->tables[$tableName];
  3683. }
  3684. public function getTableNames(): array
  3685. {
  3686. return $this->database()->getTableNames();
  3687. }
  3688. public function removeTable(string $tableName): bool
  3689. {
  3690. unset($this->tables[$tableName]);
  3691. return $this->database()->removeTable($tableName);
  3692. }
  3693. }
  3694. }
  3695. // file: src/Tqdev/PhpCrudApi/Controller/CacheController.php
  3696. namespace Tqdev\PhpCrudApi\Controller {
  3697. use Psr\Http\Message\ResponseInterface;
  3698. use Psr\Http\Message\ServerRequestInterface;
  3699. use Tqdev\PhpCrudApi\Cache\Cache;
  3700. use Tqdev\PhpCrudApi\Middleware\Router\Router;
  3701. class CacheController
  3702. {
  3703. private $cache;
  3704. private $responder;
  3705. public function __construct(Router $router, Responder $responder, Cache $cache)
  3706. {
  3707. $router->register('GET', '/cache/clear', array($this, 'clear'));
  3708. $this->cache = $cache;
  3709. $this->responder = $responder;
  3710. }
  3711. public function clear(ServerRequestInterface $request): ResponseInterface
  3712. {
  3713. return $this->responder->success($this->cache->clear());
  3714. }
  3715. }
  3716. }
  3717. // file: src/Tqdev/PhpCrudApi/Controller/ColumnController.php
  3718. namespace Tqdev\PhpCrudApi\Controller {
  3719. use Psr\Http\Message\ResponseInterface;
  3720. use Psr\Http\Message\ServerRequestInterface;
  3721. use Tqdev\PhpCrudApi\Column\DefinitionService;
  3722. use Tqdev\PhpCrudApi\Column\ReflectionService;
  3723. use Tqdev\PhpCrudApi\Middleware\Router\Router;
  3724. use Tqdev\PhpCrudApi\Record\ErrorCode;
  3725. use Tqdev\PhpCrudApi\RequestUtils;
  3726. class ColumnController
  3727. {
  3728. private $responder;
  3729. private $reflection;
  3730. private $definition;
  3731. public function __construct(Router $router, Responder $responder, ReflectionService $reflection, DefinitionService $definition)
  3732. {
  3733. $router->register('GET', '/columns', array($this, 'getDatabase'));
  3734. $router->register('GET', '/columns/*', array($this, 'getTable'));
  3735. $router->register('GET', '/columns/*/*', array($this, 'getColumn'));
  3736. $router->register('PUT', '/columns/*', array($this, 'updateTable'));
  3737. $router->register('PUT', '/columns/*/*', array($this, 'updateColumn'));
  3738. $router->register('POST', '/columns', array($this, 'addTable'));
  3739. $router->register('POST', '/columns/*', array($this, 'addColumn'));
  3740. $router->register('DELETE', '/columns/*', array($this, 'removeTable'));
  3741. $router->register('DELETE', '/columns/*/*', array($this, 'removeColumn'));
  3742. $this->responder = $responder;
  3743. $this->reflection = $reflection;
  3744. $this->definition = $definition;
  3745. }
  3746. public function getDatabase(ServerRequestInterface $request): ResponseInterface
  3747. {
  3748. $tables = [];
  3749. foreach ($this->reflection->getTableNames() as $table) {
  3750. $tables[] = $this->reflection->getTable($table);
  3751. }
  3752. $database = ['tables' => $tables];
  3753. return $this->responder->success($database);
  3754. }
  3755. public function getTable(ServerRequestInterface $request): ResponseInterface
  3756. {
  3757. $tableName = RequestUtils::getPathSegment($request, 2);
  3758. if (!$this->reflection->hasTable($tableName)) {
  3759. return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $tableName);
  3760. }
  3761. $table = $this->reflection->getTable($tableName);
  3762. return $this->responder->success($table);
  3763. }
  3764. public function getColumn(ServerRequestInterface $request): ResponseInterface
  3765. {
  3766. $tableName = RequestUtils::getPathSegment($request, 2);
  3767. $columnName = RequestUtils::getPathSegment($request, 3);
  3768. if (!$this->reflection->hasTable($tableName)) {
  3769. return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $tableName);
  3770. }
  3771. $table = $this->reflection->getTable($tableName);
  3772. if (!$table->hasColumn($columnName)) {
  3773. return $this->responder->error(ErrorCode::COLUMN_NOT_FOUND, $columnName);
  3774. }
  3775. $column = $table->getColumn($columnName);
  3776. return $this->responder->success($column);
  3777. }
  3778. public function updateTable(ServerRequestInterface $request): ResponseInterface
  3779. {
  3780. $tableName = RequestUtils::getPathSegment($request, 2);
  3781. if (!$this->reflection->hasTable($tableName)) {
  3782. return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $tableName);
  3783. }
  3784. $success = $this->definition->updateTable($tableName, $request->getParsedBody());
  3785. if ($success) {
  3786. $this->reflection->refreshTables();
  3787. }
  3788. return $this->responder->success($success);
  3789. }
  3790. public function updateColumn(ServerRequestInterface $request): ResponseInterface
  3791. {
  3792. $tableName = RequestUtils::getPathSegment($request, 2);
  3793. $columnName = RequestUtils::getPathSegment($request, 3);
  3794. if (!$this->reflection->hasTable($tableName)) {
  3795. return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $tableName);
  3796. }
  3797. $table = $this->reflection->getTable($tableName);
  3798. if (!$table->hasColumn($columnName)) {
  3799. return $this->responder->error(ErrorCode::COLUMN_NOT_FOUND, $columnName);
  3800. }
  3801. $success = $this->definition->updateColumn($tableName, $columnName, $request->getParsedBody());
  3802. if ($success) {
  3803. $this->reflection->refreshTable($tableName);
  3804. }
  3805. return $this->responder->success($success);
  3806. }
  3807. public function addTable(ServerRequestInterface $request): ResponseInterface
  3808. {
  3809. $tableName = $request->getParsedBody()->name;
  3810. if ($this->reflection->hasTable($tableName)) {
  3811. return $this->responder->error(ErrorCode::TABLE_ALREADY_EXISTS, $tableName);
  3812. }
  3813. $success = $this->definition->addTable($request->getParsedBody());
  3814. if ($success) {
  3815. $this->reflection->refreshTables();
  3816. }
  3817. return $this->responder->success($success);
  3818. }
  3819. public function addColumn(ServerRequestInterface $request): ResponseInterface
  3820. {
  3821. $tableName = RequestUtils::getPathSegment($request, 2);
  3822. if (!$this->reflection->hasTable($tableName)) {
  3823. return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $tableName);
  3824. }
  3825. $columnName = $request->getParsedBody()->name;
  3826. $table = $this->reflection->getTable($tableName);
  3827. if ($table->hasColumn($columnName)) {
  3828. return $this->responder->error(ErrorCode::COLUMN_ALREADY_EXISTS, $columnName);
  3829. }
  3830. $success = $this->definition->addColumn($tableName, $request->getParsedBody());
  3831. if ($success) {
  3832. $this->reflection->refreshTable($tableName);
  3833. }
  3834. return $this->responder->success($success);
  3835. }
  3836. public function removeTable(ServerRequestInterface $request): ResponseInterface
  3837. {
  3838. $tableName = RequestUtils::getPathSegment($request, 2);
  3839. if (!$this->reflection->hasTable($tableName)) {
  3840. return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $tableName);
  3841. }
  3842. $success = $this->definition->removeTable($tableName);
  3843. if ($success) {
  3844. $this->reflection->refreshTables();
  3845. }
  3846. return $this->responder->success($success);
  3847. }
  3848. public function removeColumn(ServerRequestInterface $request): ResponseInterface
  3849. {
  3850. $tableName = RequestUtils::getPathSegment($request, 2);
  3851. $columnName = RequestUtils::getPathSegment($request, 3);
  3852. if (!$this->reflection->hasTable($tableName)) {
  3853. return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $tableName);
  3854. }
  3855. $table = $this->reflection->getTable($tableName);
  3856. if (!$table->hasColumn($columnName)) {
  3857. return $this->responder->error(ErrorCode::COLUMN_NOT_FOUND, $columnName);
  3858. }
  3859. $success = $this->definition->removeColumn($tableName, $columnName);
  3860. if ($success) {
  3861. $this->reflection->refreshTable($tableName);
  3862. }
  3863. return $this->responder->success($success);
  3864. }
  3865. }
  3866. }
  3867. // file: src/Tqdev/PhpCrudApi/Controller/GeoJsonController.php
  3868. namespace Tqdev\PhpCrudApi\Controller {
  3869. use Psr\Http\Message\ResponseInterface;
  3870. use Psr\Http\Message\ServerRequestInterface;
  3871. use Tqdev\PhpCrudApi\GeoJson\GeoJsonService;
  3872. use Tqdev\PhpCrudApi\Middleware\Router\Router;
  3873. use Tqdev\PhpCrudApi\Record\ErrorCode;
  3874. use Tqdev\PhpCrudApi\RequestUtils;
  3875. class GeoJsonController
  3876. {
  3877. private $service;
  3878. private $responder;
  3879. public function __construct(Router $router, Responder $responder, GeoJsonService $service)
  3880. {
  3881. $router->register('GET', '/geojson/*', array($this, '_list'));
  3882. $router->register('GET', '/geojson/*/*', array($this, 'read'));
  3883. $this->service = $service;
  3884. $this->responder = $responder;
  3885. }
  3886. public function _list(ServerRequestInterface $request): ResponseInterface
  3887. {
  3888. $table = RequestUtils::getPathSegment($request, 2);
  3889. $params = RequestUtils::getParams($request);
  3890. if (!$this->service->hasTable($table)) {
  3891. return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $table);
  3892. }
  3893. return $this->responder->success($this->service->_list($table, $params));
  3894. }
  3895. public function read(ServerRequestInterface $request): ResponseInterface
  3896. {
  3897. $table = RequestUtils::getPathSegment($request, 2);
  3898. if (!$this->service->hasTable($table)) {
  3899. return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $table);
  3900. }
  3901. if ($this->service->getType($table) != 'table') {
  3902. return $this->responder->error(ErrorCode::OPERATION_NOT_SUPPORTED, __FUNCTION__);
  3903. }
  3904. $id = RequestUtils::getPathSegment($request, 3);
  3905. $params = RequestUtils::getParams($request);
  3906. if (strpos($id, ',') !== false) {
  3907. $ids = explode(',', $id);
  3908. $result = (object) array('type' => 'FeatureCollection', 'features' => array());
  3909. for ($i = 0; $i < count($ids); $i++) {
  3910. array_push($result->features, $this->service->read($table, $ids[$i], $params));
  3911. }
  3912. return $this->responder->success($result);
  3913. } else {
  3914. $response = $this->service->read($table, $id, $params);
  3915. if ($response === null) {
  3916. return $this->responder->error(ErrorCode::RECORD_NOT_FOUND, $id);
  3917. }
  3918. return $this->responder->success($response);
  3919. }
  3920. }
  3921. }
  3922. }
  3923. // file: src/Tqdev/PhpCrudApi/Controller/JsonResponder.php
  3924. namespace Tqdev\PhpCrudApi\Controller {
  3925. use Psr\Http\Message\ResponseInterface;
  3926. use Tqdev\PhpCrudApi\Record\Document\ErrorDocument;
  3927. use Tqdev\PhpCrudApi\Record\ErrorCode;
  3928. use Tqdev\PhpCrudApi\ResponseFactory;
  3929. class JsonResponder implements Responder
  3930. {
  3931. public function error(int $error, string $argument, $details = null): ResponseInterface
  3932. {
  3933. $errorCode = new ErrorCode($error);
  3934. $status = $errorCode->getStatus();
  3935. $document = new ErrorDocument($errorCode, $argument, $details);
  3936. return ResponseFactory::fromObject($status, $document);
  3937. }
  3938. public function success($result): ResponseInterface
  3939. {
  3940. return ResponseFactory::fromObject(ResponseFactory::OK, $result);
  3941. }
  3942. }
  3943. }
  3944. // file: src/Tqdev/PhpCrudApi/Controller/OpenApiController.php
  3945. namespace Tqdev\PhpCrudApi\Controller {
  3946. use Psr\Http\Message\ResponseInterface;
  3947. use Psr\Http\Message\ServerRequestInterface;
  3948. use Tqdev\PhpCrudApi\Middleware\Router\Router;
  3949. use Tqdev\PhpCrudApi\OpenApi\OpenApiService;
  3950. class OpenApiController
  3951. {
  3952. private $openApi;
  3953. private $responder;
  3954. public function __construct(Router $router, Responder $responder, OpenApiService $openApi)
  3955. {
  3956. $router->register('GET', '/openapi', array($this, 'openapi'));
  3957. $this->openApi = $openApi;
  3958. $this->responder = $responder;
  3959. }
  3960. public function openapi(ServerRequestInterface $request): ResponseInterface
  3961. {
  3962. return $this->responder->success($this->openApi->get());
  3963. }
  3964. }
  3965. }
  3966. // file: src/Tqdev/PhpCrudApi/Controller/RecordController.php
  3967. namespace Tqdev\PhpCrudApi\Controller {
  3968. use Psr\Http\Message\ResponseInterface;
  3969. use Psr\Http\Message\ServerRequestInterface;
  3970. use Tqdev\PhpCrudApi\Middleware\Router\Router;
  3971. use Tqdev\PhpCrudApi\Record\ErrorCode;
  3972. use Tqdev\PhpCrudApi\Record\RecordService;
  3973. use Tqdev\PhpCrudApi\RequestUtils;
  3974. class RecordController
  3975. {
  3976. private $service;
  3977. private $responder;
  3978. public function __construct(Router $router, Responder $responder, RecordService $service)
  3979. {
  3980. $router->register('GET', '/records/*', array($this, '_list'));
  3981. $router->register('POST', '/records/*', array($this, 'create'));
  3982. $router->register('GET', '/records/*/*', array($this, 'read'));
  3983. $router->register('PUT', '/records/*/*', array($this, 'update'));
  3984. $router->register('DELETE', '/records/*/*', array($this, 'delete'));
  3985. $router->register('PATCH', '/records/*/*', array($this, 'increment'));
  3986. $this->service = $service;
  3987. $this->responder = $responder;
  3988. }
  3989. public function _list(ServerRequestInterface $request): ResponseInterface
  3990. {
  3991. $table = RequestUtils::getPathSegment($request, 2);
  3992. $params = RequestUtils::getParams($request);
  3993. if (!$this->service->hasTable($table)) {
  3994. return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $table);
  3995. }
  3996. return $this->responder->success($this->service->_list($table, $params));
  3997. }
  3998. public function read(ServerRequestInterface $request): ResponseInterface
  3999. {
  4000. $table = RequestUtils::getPathSegment($request, 2);
  4001. if (!$this->service->hasTable($table)) {
  4002. return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $table);
  4003. }
  4004. if ($this->service->getType($table) != 'table') {
  4005. return $this->responder->error(ErrorCode::OPERATION_NOT_SUPPORTED, __FUNCTION__);
  4006. }
  4007. $id = RequestUtils::getPathSegment($request, 3);
  4008. $params = RequestUtils::getParams($request);
  4009. if (strpos($id, ',') !== false) {
  4010. $ids = explode(',', $id);
  4011. $result = [];
  4012. for ($i = 0; $i < count($ids); $i++) {
  4013. array_push($result, $this->service->read($table, $ids[$i], $params));
  4014. }
  4015. return $this->responder->success($result);
  4016. } else {
  4017. $response = $this->service->read($table, $id, $params);
  4018. if ($response === null) {
  4019. return $this->responder->error(ErrorCode::RECORD_NOT_FOUND, $id);
  4020. }
  4021. return $this->responder->success($response);
  4022. }
  4023. }
  4024. public function create(ServerRequestInterface $request): ResponseInterface
  4025. {
  4026. $table = RequestUtils::getPathSegment($request, 2);
  4027. if (!$this->service->hasTable($table)) {
  4028. return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $table);
  4029. }
  4030. if ($this->service->getType($table) != 'table') {
  4031. return $this->responder->error(ErrorCode::OPERATION_NOT_SUPPORTED, __FUNCTION__);
  4032. }
  4033. $record = $request->getParsedBody();
  4034. if ($record === null) {
  4035. return $this->responder->error(ErrorCode::HTTP_MESSAGE_NOT_READABLE, '');
  4036. }
  4037. $params = RequestUtils::getParams($request);
  4038. if (is_array($record)) {
  4039. $result = array();
  4040. foreach ($record as $r) {
  4041. $result[] = $this->service->create($table, $r, $params);
  4042. }
  4043. return $this->responder->success($result);
  4044. } else {
  4045. return $this->responder->success($this->service->create($table, $record, $params));
  4046. }
  4047. }
  4048. public function update(ServerRequestInterface $request): ResponseInterface
  4049. {
  4050. $table = RequestUtils::getPathSegment($request, 2);
  4051. if (!$this->service->hasTable($table)) {
  4052. return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $table);
  4053. }
  4054. if ($this->service->getType($table) != 'table') {
  4055. return $this->responder->error(ErrorCode::OPERATION_NOT_SUPPORTED, __FUNCTION__);
  4056. }
  4057. $id = RequestUtils::getPathSegment($request, 3);
  4058. $params = RequestUtils::getParams($request);
  4059. $record = $request->getParsedBody();
  4060. if ($record === null) {
  4061. return $this->responder->error(ErrorCode::HTTP_MESSAGE_NOT_READABLE, '');
  4062. }
  4063. $ids = explode(',', $id);
  4064. if (is_array($record)) {
  4065. if (count($ids) != count($record)) {
  4066. return $this->responder->error(ErrorCode::ARGUMENT_COUNT_MISMATCH, $id);
  4067. }
  4068. $result = array();
  4069. for ($i = 0; $i < count($ids); $i++) {
  4070. $result[] = $this->service->update($table, $ids[$i], $record[$i], $params);
  4071. }
  4072. return $this->responder->success($result);
  4073. } else {
  4074. if (count($ids) != 1) {
  4075. return $this->responder->error(ErrorCode::ARGUMENT_COUNT_MISMATCH, $id);
  4076. }
  4077. return $this->responder->success($this->service->update($table, $id, $record, $params));
  4078. }
  4079. }
  4080. public function delete(ServerRequestInterface $request): ResponseInterface
  4081. {
  4082. $table = RequestUtils::getPathSegment($request, 2);
  4083. if (!$this->service->hasTable($table)) {
  4084. return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $table);
  4085. }
  4086. if ($this->service->getType($table) != 'table') {
  4087. return $this->responder->error(ErrorCode::OPERATION_NOT_SUPPORTED, __FUNCTION__);
  4088. }
  4089. $id = RequestUtils::getPathSegment($request, 3);
  4090. $params = RequestUtils::getParams($request);
  4091. $ids = explode(',', $id);
  4092. if (count($ids) > 1) {
  4093. $result = array();
  4094. for ($i = 0; $i < count($ids); $i++) {
  4095. $result[] = $this->service->delete($table, $ids[$i], $params);
  4096. }
  4097. return $this->responder->success($result);
  4098. } else {
  4099. return $this->responder->success($this->service->delete($table, $id, $params));
  4100. }
  4101. }
  4102. public function increment(ServerRequestInterface $request): ResponseInterface
  4103. {
  4104. $table = RequestUtils::getPathSegment($request, 2);
  4105. if (!$this->service->hasTable($table)) {
  4106. return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $table);
  4107. }
  4108. if ($this->service->getType($table) != 'table') {
  4109. return $this->responder->error(ErrorCode::OPERATION_NOT_SUPPORTED, __FUNCTION__);
  4110. }
  4111. $id = RequestUtils::getPathSegment($request, 3);
  4112. $record = $request->getParsedBody();
  4113. if ($record === null) {
  4114. return $this->responder->error(ErrorCode::HTTP_MESSAGE_NOT_READABLE, '');
  4115. }
  4116. $params = RequestUtils::getParams($request);
  4117. $ids = explode(',', $id);
  4118. if (is_array($record)) {
  4119. if (count($ids) != count($record)) {
  4120. return $this->responder->error(ErrorCode::ARGUMENT_COUNT_MISMATCH, $id);
  4121. }
  4122. $result = array();
  4123. for ($i = 0; $i < count($ids); $i++) {
  4124. $result[] = $this->service->increment($table, $ids[$i], $record[$i], $params);
  4125. }
  4126. return $this->responder->success($result);
  4127. } else {
  4128. if (count($ids) != 1) {
  4129. return $this->responder->error(ErrorCode::ARGUMENT_COUNT_MISMATCH, $id);
  4130. }
  4131. return $this->responder->success($this->service->increment($table, $id, $record, $params));
  4132. }
  4133. }
  4134. }
  4135. }
  4136. // file: src/Tqdev/PhpCrudApi/Controller/Responder.php
  4137. namespace Tqdev\PhpCrudApi\Controller {
  4138. use Psr\Http\Message\ResponseInterface;
  4139. interface Responder
  4140. {
  4141. public function error(int $error, string $argument, $details = null): ResponseInterface;
  4142. public function success($result): ResponseInterface;
  4143. }
  4144. }
  4145. // file: src/Tqdev/PhpCrudApi/Database/ColumnConverter.php
  4146. namespace Tqdev\PhpCrudApi\Database {
  4147. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedColumn;
  4148. class ColumnConverter
  4149. {
  4150. private $driver;
  4151. public function __construct(string $driver)
  4152. {
  4153. $this->driver = $driver;
  4154. }
  4155. public function convertColumnValue(ReflectedColumn $column): string
  4156. {
  4157. if ($column->isBoolean()) {
  4158. switch ($this->driver) {
  4159. case 'mysql':
  4160. return "IFNULL(IF(?,TRUE,FALSE),NULL)";
  4161. case 'pgsql':
  4162. return "?";
  4163. case 'sqlsrv':
  4164. return "?";
  4165. }
  4166. }
  4167. if ($column->isBinary()) {
  4168. switch ($this->driver) {
  4169. case 'mysql':
  4170. return "FROM_BASE64(?)";
  4171. case 'pgsql':
  4172. return "decode(?, 'base64')";
  4173. case 'sqlsrv':
  4174. return "CONVERT(XML, ?).value('.','varbinary(max)')";
  4175. }
  4176. }
  4177. if ($column->isGeometry()) {
  4178. switch ($this->driver) {
  4179. case 'mysql':
  4180. case 'pgsql':
  4181. return "ST_GeomFromText(?)";
  4182. case 'sqlsrv':
  4183. return "geometry::STGeomFromText(?,0)";
  4184. }
  4185. }
  4186. return '?';
  4187. }
  4188. public function convertColumnName(ReflectedColumn $column, $value): string
  4189. {
  4190. if ($column->isBinary()) {
  4191. switch ($this->driver) {
  4192. case 'mysql':
  4193. return "TO_BASE64($value) as $value";
  4194. case 'pgsql':
  4195. return "encode($value::bytea, 'base64') as $value";
  4196. case 'sqlsrv':
  4197. return "CASE WHEN $value IS NULL THEN NULL ELSE (SELECT CAST($value as varbinary(max)) FOR XML PATH(''), BINARY BASE64) END as $value";
  4198. }
  4199. }
  4200. if ($column->isGeometry()) {
  4201. switch ($this->driver) {
  4202. case 'mysql':
  4203. case 'pgsql':
  4204. return "ST_AsText($value) as $value";
  4205. case 'sqlsrv':
  4206. return "REPLACE($value.STAsText(),' (','(') as $value";
  4207. }
  4208. }
  4209. return $value;
  4210. }
  4211. }
  4212. }
  4213. // file: src/Tqdev/PhpCrudApi/Database/ColumnsBuilder.php
  4214. namespace Tqdev\PhpCrudApi\Database {
  4215. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedColumn;
  4216. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedTable;
  4217. class ColumnsBuilder
  4218. {
  4219. private $driver;
  4220. private $converter;
  4221. public function __construct(string $driver)
  4222. {
  4223. $this->driver = $driver;
  4224. $this->converter = new ColumnConverter($driver);
  4225. }
  4226. public function getOffsetLimit(int $offset, int $limit): string
  4227. {
  4228. if ($limit < 0 || $offset < 0) {
  4229. return '';
  4230. }
  4231. switch ($this->driver) {
  4232. case 'mysql':
  4233. return " LIMIT $offset, $limit";
  4234. case 'pgsql':
  4235. return " LIMIT $limit OFFSET $offset";
  4236. case 'sqlsrv':
  4237. return " OFFSET $offset ROWS FETCH NEXT $limit ROWS ONLY";
  4238. case 'sqlite':
  4239. return " LIMIT $limit OFFSET $offset";
  4240. }
  4241. }
  4242. private function quoteColumnName(ReflectedColumn $column): string
  4243. {
  4244. return '"' . $column->getName() . '"';
  4245. }
  4246. public function getOrderBy(ReflectedTable $table, array $columnOrdering): string
  4247. {
  4248. if (count($columnOrdering) == 0) {
  4249. return '';
  4250. }
  4251. $results = array();
  4252. foreach ($columnOrdering as $i => list($columnName, $ordering)) {
  4253. $column = $table->getColumn($columnName);
  4254. $quotedColumnName = $this->quoteColumnName($column);
  4255. $results[] = $quotedColumnName . ' ' . $ordering;
  4256. }
  4257. return ' ORDER BY ' . implode(',', $results);
  4258. }
  4259. public function getSelect(ReflectedTable $table, array $columnNames): string
  4260. {
  4261. $results = array();
  4262. foreach ($columnNames as $columnName) {
  4263. $column = $table->getColumn($columnName);
  4264. $quotedColumnName = $this->quoteColumnName($column);
  4265. $quotedColumnName = $this->converter->convertColumnName($column, $quotedColumnName);
  4266. $results[] = $quotedColumnName;
  4267. }
  4268. return implode(',', $results);
  4269. }
  4270. public function getInsert(ReflectedTable $table, array $columnValues): string
  4271. {
  4272. $columns = array();
  4273. $values = array();
  4274. foreach ($columnValues as $columnName => $columnValue) {
  4275. $column = $table->getColumn($columnName);
  4276. $quotedColumnName = $this->quoteColumnName($column);
  4277. $columns[] = $quotedColumnName;
  4278. $columnValue = $this->converter->convertColumnValue($column);
  4279. $values[] = $columnValue;
  4280. }
  4281. $columnsSql = '(' . implode(',', $columns) . ')';
  4282. $valuesSql = '(' . implode(',', $values) . ')';
  4283. $outputColumn = $this->quoteColumnName($table->getPk());
  4284. switch ($this->driver) {
  4285. case 'mysql':
  4286. return "$columnsSql VALUES $valuesSql";
  4287. case 'pgsql':
  4288. return "$columnsSql VALUES $valuesSql RETURNING $outputColumn";
  4289. case 'sqlsrv':
  4290. return "$columnsSql OUTPUT INSERTED.$outputColumn VALUES $valuesSql";
  4291. case 'sqlite':
  4292. return "$columnsSql VALUES $valuesSql";
  4293. }
  4294. }
  4295. public function getUpdate(ReflectedTable $table, array $columnValues): string
  4296. {
  4297. $results = array();
  4298. foreach ($columnValues as $columnName => $columnValue) {
  4299. $column = $table->getColumn($columnName);
  4300. $quotedColumnName = $this->quoteColumnName($column);
  4301. $columnValue = $this->converter->convertColumnValue($column);
  4302. $results[] = $quotedColumnName . '=' . $columnValue;
  4303. }
  4304. return implode(',', $results);
  4305. }
  4306. public function getIncrement(ReflectedTable $table, array $columnValues): string
  4307. {
  4308. $results = array();
  4309. foreach ($columnValues as $columnName => $columnValue) {
  4310. if (!is_numeric($columnValue)) {
  4311. continue;
  4312. }
  4313. $column = $table->getColumn($columnName);
  4314. $quotedColumnName = $this->quoteColumnName($column);
  4315. $columnValue = $this->converter->convertColumnValue($column);
  4316. $results[] = $quotedColumnName . '=' . $quotedColumnName . '+' . $columnValue;
  4317. }
  4318. return implode(',', $results);
  4319. }
  4320. }
  4321. }
  4322. // file: src/Tqdev/PhpCrudApi/Database/ConditionsBuilder.php
  4323. namespace Tqdev\PhpCrudApi\Database {
  4324. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedColumn;
  4325. use Tqdev\PhpCrudApi\Record\Condition\AndCondition;
  4326. use Tqdev\PhpCrudApi\Record\Condition\ColumnCondition;
  4327. use Tqdev\PhpCrudApi\Record\Condition\Condition;
  4328. use Tqdev\PhpCrudApi\Record\Condition\NoCondition;
  4329. use Tqdev\PhpCrudApi\Record\Condition\NotCondition;
  4330. use Tqdev\PhpCrudApi\Record\Condition\OrCondition;
  4331. use Tqdev\PhpCrudApi\Record\Condition\SpatialCondition;
  4332. class ConditionsBuilder
  4333. {
  4334. private $driver;
  4335. public function __construct(string $driver)
  4336. {
  4337. $this->driver = $driver;
  4338. }
  4339. private function getConditionSql(Condition $condition, array &$arguments): string
  4340. {
  4341. if ($condition instanceof AndCondition) {
  4342. return $this->getAndConditionSql($condition, $arguments);
  4343. }
  4344. if ($condition instanceof OrCondition) {
  4345. return $this->getOrConditionSql($condition, $arguments);
  4346. }
  4347. if ($condition instanceof NotCondition) {
  4348. return $this->getNotConditionSql($condition, $arguments);
  4349. }
  4350. if ($condition instanceof SpatialCondition) {
  4351. return $this->getSpatialConditionSql($condition, $arguments);
  4352. }
  4353. if ($condition instanceof ColumnCondition) {
  4354. return $this->getColumnConditionSql($condition, $arguments);
  4355. }
  4356. throw new \Exception('Unknown Condition: ' . get_class($condition));
  4357. }
  4358. private function getAndConditionSql(AndCondition $and, array &$arguments): string
  4359. {
  4360. $parts = [];
  4361. foreach ($and->getConditions() as $condition) {
  4362. $parts[] = $this->getConditionSql($condition, $arguments);
  4363. }
  4364. return '(' . implode(' AND ', $parts) . ')';
  4365. }
  4366. private function getOrConditionSql(OrCondition $or, array &$arguments): string
  4367. {
  4368. $parts = [];
  4369. foreach ($or->getConditions() as $condition) {
  4370. $parts[] = $this->getConditionSql($condition, $arguments);
  4371. }
  4372. return '(' . implode(' OR ', $parts) . ')';
  4373. }
  4374. private function getNotConditionSql(NotCondition $not, array &$arguments): string
  4375. {
  4376. $condition = $not->getCondition();
  4377. return '(NOT ' . $this->getConditionSql($condition, $arguments) . ')';
  4378. }
  4379. private function quoteColumnName(ReflectedColumn $column): string
  4380. {
  4381. return '"' . $column->getName() . '"';
  4382. }
  4383. private function escapeLikeValue(string $value): string
  4384. {
  4385. return addcslashes($value, '%_');
  4386. }
  4387. private function getColumnConditionSql(ColumnCondition $condition, array &$arguments): string
  4388. {
  4389. $column = $this->quoteColumnName($condition->getColumn());
  4390. $operator = $condition->getOperator();
  4391. $value = $condition->getValue();
  4392. switch ($operator) {
  4393. case 'cs':
  4394. $sql = "$column LIKE ?";
  4395. $arguments[] = '%' . $this->escapeLikeValue($value) . '%';
  4396. break;
  4397. case 'sw':
  4398. $sql = "$column LIKE ?";
  4399. $arguments[] = $this->escapeLikeValue($value) . '%';
  4400. break;
  4401. case 'ew':
  4402. $sql = "$column LIKE ?";
  4403. $arguments[] = '%' . $this->escapeLikeValue($value);
  4404. break;
  4405. case 'eq':
  4406. $sql = "$column = ?";
  4407. $arguments[] = $value;
  4408. break;
  4409. case 'lt':
  4410. $sql = "$column < ?";
  4411. $arguments[] = $value;
  4412. break;
  4413. case 'le':
  4414. $sql = "$column <= ?";
  4415. $arguments[] = $value;
  4416. break;
  4417. case 'ge':
  4418. $sql = "$column >= ?";
  4419. $arguments[] = $value;
  4420. break;
  4421. case 'gt':
  4422. $sql = "$column > ?";
  4423. $arguments[] = $value;
  4424. break;
  4425. case 'bt':
  4426. $parts = explode(',', $value, 2);
  4427. $count = count($parts);
  4428. if ($count == 2) {
  4429. $sql = "($column >= ? AND $column <= ?)";
  4430. $arguments[] = $parts[0];
  4431. $arguments[] = $parts[1];
  4432. } else {
  4433. $sql = "FALSE";
  4434. }
  4435. break;
  4436. case 'in':
  4437. $parts = explode(',', $value);
  4438. $count = count($parts);
  4439. if ($count > 0) {
  4440. $qmarks = implode(',', str_split(str_repeat('?', $count)));
  4441. $sql = "$column IN ($qmarks)";
  4442. for ($i = 0; $i < $count; $i++) {
  4443. $arguments[] = $parts[$i];
  4444. }
  4445. } else {
  4446. $sql = "FALSE";
  4447. }
  4448. break;
  4449. case 'is':
  4450. $sql = "$column IS NULL";
  4451. break;
  4452. }
  4453. return $sql;
  4454. }
  4455. private function getSpatialFunctionName(string $operator): string
  4456. {
  4457. switch ($operator) {
  4458. case 'co':
  4459. return 'ST_Contains';
  4460. case 'cr':
  4461. return 'ST_Crosses';
  4462. case 'di':
  4463. return 'ST_Disjoint';
  4464. case 'eq':
  4465. return 'ST_Equals';
  4466. case 'in':
  4467. return 'ST_Intersects';
  4468. case 'ov':
  4469. return 'ST_Overlaps';
  4470. case 'to':
  4471. return 'ST_Touches';
  4472. case 'wi':
  4473. return 'ST_Within';
  4474. case 'ic':
  4475. return 'ST_IsClosed';
  4476. case 'is':
  4477. return 'ST_IsSimple';
  4478. case 'iv':
  4479. return 'ST_IsValid';
  4480. }
  4481. }
  4482. private function hasSpatialArgument(string $operator): bool
  4483. {
  4484. return in_array($operator, ['ic', 'is', 'iv']) ? false : true;
  4485. }
  4486. private function getSpatialFunctionCall(string $functionName, string $column, bool $hasArgument): string
  4487. {
  4488. switch ($this->driver) {
  4489. case 'mysql':
  4490. case 'pgsql':
  4491. $argument = $hasArgument ? 'ST_GeomFromText(?)' : '';
  4492. return "$functionName($column, $argument)=TRUE";
  4493. case 'sqlsrv':
  4494. $functionName = str_replace('ST_', 'ST', $functionName);
  4495. $argument = $hasArgument ? 'geometry::STGeomFromText(?,0)' : '';
  4496. return "$column.$functionName($argument)=1";
  4497. case 'sqlite':
  4498. $argument = $hasArgument ? '?' : '0';
  4499. return "$functionName($column, $argument)=1";
  4500. }
  4501. }
  4502. private function getSpatialConditionSql(ColumnCondition $condition, array &$arguments): string
  4503. {
  4504. $column = $this->quoteColumnName($condition->getColumn());
  4505. $operator = $condition->getOperator();
  4506. $value = $condition->getValue();
  4507. $functionName = $this->getSpatialFunctionName($operator);
  4508. $hasArgument = $this->hasSpatialArgument($operator);
  4509. $sql = $this->getSpatialFunctionCall($functionName, $column, $hasArgument);
  4510. if ($hasArgument) {
  4511. $arguments[] = $value;
  4512. }
  4513. return $sql;
  4514. }
  4515. public function getWhereClause(Condition $condition, array &$arguments): string
  4516. {
  4517. if ($condition instanceof NoCondition) {
  4518. return '';
  4519. }
  4520. return ' WHERE ' . $this->getConditionSql($condition, $arguments);
  4521. }
  4522. }
  4523. }
  4524. // file: src/Tqdev/PhpCrudApi/Database/DataConverter.php
  4525. namespace Tqdev\PhpCrudApi\Database {
  4526. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedColumn;
  4527. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedTable;
  4528. class DataConverter
  4529. {
  4530. private $driver;
  4531. public function __construct(string $driver)
  4532. {
  4533. $this->driver = $driver;
  4534. }
  4535. private function convertRecordValue($conversion, $value)
  4536. {
  4537. $args = explode('|', $conversion);
  4538. $type = array_shift($args);
  4539. switch ($type) {
  4540. case 'boolean':
  4541. return $value ? true : false;
  4542. case 'integer':
  4543. return (int) $value;
  4544. case 'float':
  4545. return (float) $value;
  4546. case 'decimal':
  4547. return number_format($value, $args[0], '.', '');
  4548. }
  4549. return $value;
  4550. }
  4551. private function getRecordValueConversion(ReflectedColumn $column): string
  4552. {
  4553. if (in_array($this->driver, ['mysql', 'sqlsrv', 'sqlite']) && $column->isBoolean()) {
  4554. return 'boolean';
  4555. }
  4556. if (in_array($this->driver, ['sqlsrv', 'sqlite']) && in_array($column->getType(), ['integer', 'bigint'])) {
  4557. return 'integer';
  4558. }
  4559. if (in_array($this->driver, ['sqlite', 'pgsql']) && in_array($column->getType(), ['float', 'double'])) {
  4560. return 'float';
  4561. }
  4562. if (in_array($this->driver, ['sqlite']) && in_array($column->getType(), ['decimal'])) {
  4563. return 'decimal|' . $column->getScale();
  4564. }
  4565. return 'none';
  4566. }
  4567. public function convertRecords(ReflectedTable $table, array $columnNames, array &$records) /*: void*/
  4568. {
  4569. foreach ($columnNames as $columnName) {
  4570. $column = $table->getColumn($columnName);
  4571. $conversion = $this->getRecordValueConversion($column);
  4572. if ($conversion != 'none') {
  4573. foreach ($records as $i => $record) {
  4574. $value = $records[$i][$columnName];
  4575. if ($value === null) {
  4576. continue;
  4577. }
  4578. $records[$i][$columnName] = $this->convertRecordValue($conversion, $value);
  4579. }
  4580. }
  4581. }
  4582. }
  4583. private function convertInputValue($conversion, $value)
  4584. {
  4585. switch ($conversion) {
  4586. case 'boolean':
  4587. return $value ? 1 : 0;
  4588. case 'base64url_to_base64':
  4589. return str_pad(strtr($value, '-_', '+/'), ceil(strlen($value) / 4) * 4, '=', STR_PAD_RIGHT);
  4590. }
  4591. return $value;
  4592. }
  4593. private function getInputValueConversion(ReflectedColumn $column): string
  4594. {
  4595. if ($column->isBoolean()) {
  4596. return 'boolean';
  4597. }
  4598. if ($column->isBinary()) {
  4599. return 'base64url_to_base64';
  4600. }
  4601. return 'none';
  4602. }
  4603. public function convertColumnValues(ReflectedTable $table, array &$columnValues) /*: void*/
  4604. {
  4605. $columnNames = array_keys($columnValues);
  4606. foreach ($columnNames as $columnName) {
  4607. $column = $table->getColumn($columnName);
  4608. $conversion = $this->getInputValueConversion($column);
  4609. if ($conversion != 'none') {
  4610. $value = $columnValues[$columnName];
  4611. if ($value !== null) {
  4612. $columnValues[$columnName] = $this->convertInputValue($conversion, $value);
  4613. }
  4614. }
  4615. }
  4616. }
  4617. }
  4618. }
  4619. // file: src/Tqdev/PhpCrudApi/Database/GenericDB.php
  4620. namespace Tqdev\PhpCrudApi\Database {
  4621. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedTable;
  4622. use Tqdev\PhpCrudApi\Middleware\Communication\VariableStore;
  4623. use Tqdev\PhpCrudApi\Record\Condition\ColumnCondition;
  4624. use Tqdev\PhpCrudApi\Record\Condition\Condition;
  4625. class GenericDB
  4626. {
  4627. private $driver;
  4628. private $address;
  4629. private $port;
  4630. private $database;
  4631. private $tables;
  4632. private $username;
  4633. private $password;
  4634. private $pdo;
  4635. private $reflection;
  4636. private $definition;
  4637. private $conditions;
  4638. private $columns;
  4639. private $converter;
  4640. private function getDsn(): string
  4641. {
  4642. switch ($this->driver) {
  4643. case 'mysql':
  4644. return "$this->driver:host=$this->address;port=$this->port;dbname=$this->database;charset=utf8mb4";
  4645. case 'pgsql':
  4646. return "$this->driver:host=$this->address port=$this->port dbname=$this->database options='--client_encoding=UTF8'";
  4647. case 'sqlsrv':
  4648. return "$this->driver:Server=$this->address,$this->port;Database=$this->database";
  4649. case 'sqlite':
  4650. return "$this->driver:$this->address";
  4651. }
  4652. }
  4653. private function getCommands(): array
  4654. {
  4655. switch ($this->driver) {
  4656. case 'mysql':
  4657. return [
  4658. 'SET SESSION sql_warnings=1;',
  4659. 'SET NAMES utf8mb4;',
  4660. 'SET SESSION sql_mode = "ANSI,TRADITIONAL";',
  4661. ];
  4662. case 'pgsql':
  4663. return [
  4664. "SET NAMES 'UTF8';",
  4665. ];
  4666. case 'sqlsrv':
  4667. return [];
  4668. case 'sqlite':
  4669. return [
  4670. 'PRAGMA foreign_keys = on;',
  4671. ];
  4672. }
  4673. }
  4674. private function getOptions(): array
  4675. {
  4676. $options = array(
  4677. \PDO::ATTR_ERRMODE => \PDO::ERRMODE_EXCEPTION,
  4678. \PDO::ATTR_DEFAULT_FETCH_MODE => \PDO::FETCH_ASSOC,
  4679. );
  4680. switch ($this->driver) {
  4681. case 'mysql':
  4682. return $options + [
  4683. \PDO::ATTR_EMULATE_PREPARES => false,
  4684. \PDO::MYSQL_ATTR_FOUND_ROWS => true,
  4685. \PDO::ATTR_PERSISTENT => true,
  4686. ];
  4687. case 'pgsql':
  4688. return $options + [
  4689. \PDO::ATTR_EMULATE_PREPARES => false,
  4690. \PDO::ATTR_PERSISTENT => true,
  4691. ];
  4692. case 'sqlsrv':
  4693. return $options + [
  4694. \PDO::SQLSRV_ATTR_DIRECT_QUERY => false,
  4695. \PDO::SQLSRV_ATTR_FETCHES_NUMERIC_TYPE => true,
  4696. ];
  4697. case 'sqlite':
  4698. return $options + [];
  4699. }
  4700. }
  4701. private function initPdo(): bool
  4702. {
  4703. if ($this->pdo) {
  4704. $result = $this->pdo->reconstruct($this->getDsn(), $this->username, $this->password, $this->getOptions());
  4705. } else {
  4706. $this->pdo = new LazyPdo($this->getDsn(), $this->username, $this->password, $this->getOptions());
  4707. $result = true;
  4708. }
  4709. $commands = $this->getCommands();
  4710. foreach ($commands as $command) {
  4711. $this->pdo->addInitCommand($command);
  4712. }
  4713. $this->reflection = new GenericReflection($this->pdo, $this->driver, $this->database, $this->tables);
  4714. $this->definition = new GenericDefinition($this->pdo, $this->driver, $this->database, $this->tables);
  4715. $this->conditions = new ConditionsBuilder($this->driver);
  4716. $this->columns = new ColumnsBuilder($this->driver);
  4717. $this->converter = new DataConverter($this->driver);
  4718. return $result;
  4719. }
  4720. public function __construct(string $driver, string $address, int $port, string $database, array $tables, string $username, string $password)
  4721. {
  4722. $this->driver = $driver;
  4723. $this->address = $address;
  4724. $this->port = $port;
  4725. $this->database = $database;
  4726. $this->tables = $tables;
  4727. $this->username = $username;
  4728. $this->password = $password;
  4729. $this->initPdo();
  4730. }
  4731. public function reconstruct(string $driver, string $address, int $port, string $database, array $tables, string $username, string $password): bool
  4732. {
  4733. if ($driver) {
  4734. $this->driver = $driver;
  4735. }
  4736. if ($address) {
  4737. $this->address = $address;
  4738. }
  4739. if ($port) {
  4740. $this->port = $port;
  4741. }
  4742. if ($database) {
  4743. $this->database = $database;
  4744. }
  4745. if ($tables) {
  4746. $this->tables = $tables;
  4747. }
  4748. if ($username) {
  4749. $this->username = $username;
  4750. }
  4751. if ($password) {
  4752. $this->password = $password;
  4753. }
  4754. return $this->initPdo();
  4755. }
  4756. public function pdo(): LazyPdo
  4757. {
  4758. return $this->pdo;
  4759. }
  4760. public function reflection(): GenericReflection
  4761. {
  4762. return $this->reflection;
  4763. }
  4764. public function definition(): GenericDefinition
  4765. {
  4766. return $this->definition;
  4767. }
  4768. private function addMiddlewareConditions(string $tableName, Condition $condition): Condition
  4769. {
  4770. $condition1 = VariableStore::get("authorization.conditions.$tableName");
  4771. if ($condition1) {
  4772. $condition = $condition->_and($condition1);
  4773. }
  4774. $condition2 = VariableStore::get("multiTenancy.conditions.$tableName");
  4775. if ($condition2) {
  4776. $condition = $condition->_and($condition2);
  4777. }
  4778. return $condition;
  4779. }
  4780. public function createSingle(ReflectedTable $table, array $columnValues) /*: ?String*/
  4781. {
  4782. $this->converter->convertColumnValues($table, $columnValues);
  4783. $insertColumns = $this->columns->getInsert($table, $columnValues);
  4784. $tableName = $table->getName();
  4785. $pkName = $table->getPk()->getName();
  4786. $parameters = array_values($columnValues);
  4787. $sql = 'INSERT INTO "' . $tableName . '" ' . $insertColumns;
  4788. $stmt = $this->query($sql, $parameters);
  4789. // return primary key value if specified in the input
  4790. if (isset($columnValues[$pkName])) {
  4791. return $columnValues[$pkName];
  4792. }
  4793. // work around missing "returning" or "output" in mysql
  4794. switch ($this->driver) {
  4795. case 'mysql':
  4796. $stmt = $this->query('SELECT LAST_INSERT_ID()', []);
  4797. break;
  4798. case 'sqlite':
  4799. $stmt = $this->query('SELECT LAST_INSERT_ROWID()', []);
  4800. break;
  4801. }
  4802. $pkValue = $stmt->fetchColumn(0);
  4803. if ($this->driver == 'sqlsrv' && $table->getPk()->getType() == 'bigint') {
  4804. return (int) $pkValue;
  4805. }
  4806. if ($this->driver == 'sqlite' && in_array($table->getPk()->getType(), ['integer', 'bigint'])) {
  4807. return (int) $pkValue;
  4808. }
  4809. return $pkValue;
  4810. }
  4811. public function selectSingle(ReflectedTable $table, array $columnNames, string $id) /*: ?array*/
  4812. {
  4813. $selectColumns = $this->columns->getSelect($table, $columnNames);
  4814. $tableName = $table->getName();
  4815. $condition = new ColumnCondition($table->getPk(), 'eq', $id);
  4816. $condition = $this->addMiddlewareConditions($tableName, $condition);
  4817. $parameters = array();
  4818. $whereClause = $this->conditions->getWhereClause($condition, $parameters);
  4819. $sql = 'SELECT ' . $selectColumns . ' FROM "' . $tableName . '" ' . $whereClause;
  4820. $stmt = $this->query($sql, $parameters);
  4821. $record = $stmt->fetch() ?: null;
  4822. if ($record === null) {
  4823. return null;
  4824. }
  4825. $records = array($record);
  4826. $this->converter->convertRecords($table, $columnNames, $records);
  4827. return $records[0];
  4828. }
  4829. public function selectMultiple(ReflectedTable $table, array $columnNames, array $ids): array
  4830. {
  4831. if (count($ids) == 0) {
  4832. return [];
  4833. }
  4834. $selectColumns = $this->columns->getSelect($table, $columnNames);
  4835. $tableName = $table->getName();
  4836. $condition = new ColumnCondition($table->getPk(), 'in', implode(',', $ids));
  4837. $condition = $this->addMiddlewareConditions($tableName, $condition);
  4838. $parameters = array();
  4839. $whereClause = $this->conditions->getWhereClause($condition, $parameters);
  4840. $sql = 'SELECT ' . $selectColumns . ' FROM "' . $tableName . '" ' . $whereClause;
  4841. $stmt = $this->query($sql, $parameters);
  4842. $records = $stmt->fetchAll();
  4843. $this->converter->convertRecords($table, $columnNames, $records);
  4844. return $records;
  4845. }
  4846. public function selectCount(ReflectedTable $table, Condition $condition): int
  4847. {
  4848. $tableName = $table->getName();
  4849. $condition = $this->addMiddlewareConditions($tableName, $condition);
  4850. $parameters = array();
  4851. $whereClause = $this->conditions->getWhereClause($condition, $parameters);
  4852. $sql = 'SELECT COUNT(*) FROM "' . $tableName . '"' . $whereClause;
  4853. $stmt = $this->query($sql, $parameters);
  4854. return $stmt->fetchColumn(0);
  4855. }
  4856. public function selectAll(ReflectedTable $table, array $columnNames, Condition $condition, array $columnOrdering, int $offset, int $limit): array
  4857. {
  4858. if ($limit == 0) {
  4859. return array();
  4860. }
  4861. $selectColumns = $this->columns->getSelect($table, $columnNames);
  4862. $tableName = $table->getName();
  4863. $condition = $this->addMiddlewareConditions($tableName, $condition);
  4864. $parameters = array();
  4865. $whereClause = $this->conditions->getWhereClause($condition, $parameters);
  4866. $orderBy = $this->columns->getOrderBy($table, $columnOrdering);
  4867. $offsetLimit = $this->columns->getOffsetLimit($offset, $limit);
  4868. $sql = 'SELECT ' . $selectColumns . ' FROM "' . $tableName . '"' . $whereClause . $orderBy . $offsetLimit;
  4869. $stmt = $this->query($sql, $parameters);
  4870. $records = $stmt->fetchAll();
  4871. $this->converter->convertRecords($table, $columnNames, $records);
  4872. return $records;
  4873. }
  4874. public function updateSingle(ReflectedTable $table, array $columnValues, string $id)
  4875. {
  4876. if (count($columnValues) == 0) {
  4877. return 0;
  4878. }
  4879. $this->converter->convertColumnValues($table, $columnValues);
  4880. $updateColumns = $this->columns->getUpdate($table, $columnValues);
  4881. $tableName = $table->getName();
  4882. $condition = new ColumnCondition($table->getPk(), 'eq', $id);
  4883. $condition = $this->addMiddlewareConditions($tableName, $condition);
  4884. $parameters = array_values($columnValues);
  4885. $whereClause = $this->conditions->getWhereClause($condition, $parameters);
  4886. $sql = 'UPDATE "' . $tableName . '" SET ' . $updateColumns . $whereClause;
  4887. $stmt = $this->query($sql, $parameters);
  4888. return $stmt->rowCount();
  4889. }
  4890. public function deleteSingle(ReflectedTable $table, string $id)
  4891. {
  4892. $tableName = $table->getName();
  4893. $condition = new ColumnCondition($table->getPk(), 'eq', $id);
  4894. $condition = $this->addMiddlewareConditions($tableName, $condition);
  4895. $parameters = array();
  4896. $whereClause = $this->conditions->getWhereClause($condition, $parameters);
  4897. $sql = 'DELETE FROM "' . $tableName . '" ' . $whereClause;
  4898. $stmt = $this->query($sql, $parameters);
  4899. return $stmt->rowCount();
  4900. }
  4901. public function incrementSingle(ReflectedTable $table, array $columnValues, string $id)
  4902. {
  4903. if (count($columnValues) == 0) {
  4904. return 0;
  4905. }
  4906. $this->converter->convertColumnValues($table, $columnValues);
  4907. $updateColumns = $this->columns->getIncrement($table, $columnValues);
  4908. $tableName = $table->getName();
  4909. $condition = new ColumnCondition($table->getPk(), 'eq', $id);
  4910. $condition = $this->addMiddlewareConditions($tableName, $condition);
  4911. $parameters = array_values($columnValues);
  4912. $whereClause = $this->conditions->getWhereClause($condition, $parameters);
  4913. $sql = 'UPDATE "' . $tableName . '" SET ' . $updateColumns . $whereClause;
  4914. $stmt = $this->query($sql, $parameters);
  4915. return $stmt->rowCount();
  4916. }
  4917. private function query(string $sql, array $parameters): \PDOStatement
  4918. {
  4919. $stmt = $this->pdo->prepare($sql);
  4920. //echo "- $sql -- " . json_encode($parameters, JSON_UNESCAPED_UNICODE) . "\n";
  4921. $stmt->execute($parameters);
  4922. return $stmt;
  4923. }
  4924. public function getCacheKey(): string
  4925. {
  4926. return md5(json_encode([
  4927. $this->driver,
  4928. $this->address,
  4929. $this->port,
  4930. $this->database,
  4931. $this->tables,
  4932. $this->username
  4933. ]));
  4934. }
  4935. }
  4936. }
  4937. // file: src/Tqdev/PhpCrudApi/Database/GenericDefinition.php
  4938. namespace Tqdev\PhpCrudApi\Database {
  4939. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedColumn;
  4940. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedTable;
  4941. use Tqdev\PhpCrudApi\Database\LazyPdo;
  4942. class GenericDefinition
  4943. {
  4944. private $pdo;
  4945. private $driver;
  4946. private $database;
  4947. private $typeConverter;
  4948. private $reflection;
  4949. public function __construct(LazyPdo $pdo, string $driver, string $database, array $tables)
  4950. {
  4951. $this->pdo = $pdo;
  4952. $this->driver = $driver;
  4953. $this->database = $database;
  4954. $this->typeConverter = new TypeConverter($driver);
  4955. $this->reflection = new GenericReflection($pdo, $driver, $database, $tables);
  4956. }
  4957. private function quote(string $identifier): string
  4958. {
  4959. return '"' . str_replace('"', '', $identifier) . '"';
  4960. }
  4961. public function getColumnType(ReflectedColumn $column, bool $update): string
  4962. {
  4963. if ($this->driver == 'pgsql' && !$update && $column->getPk() && $this->canAutoIncrement($column)) {
  4964. return 'serial';
  4965. }
  4966. $type = $this->typeConverter->fromJdbc($column->getType());
  4967. if ($column->hasPrecision() && $column->hasScale()) {
  4968. $size = '(' . $column->getPrecision() . ',' . $column->getScale() . ')';
  4969. } elseif ($column->hasPrecision()) {
  4970. $size = '(' . $column->getPrecision() . ')';
  4971. } elseif ($column->hasLength()) {
  4972. $size = '(' . $column->getLength() . ')';
  4973. } else {
  4974. $size = '';
  4975. }
  4976. $null = $this->getColumnNullType($column, $update);
  4977. $auto = $this->getColumnAutoIncrement($column, $update);
  4978. return $type . $size . $null . $auto;
  4979. }
  4980. private function getPrimaryKey(string $tableName): string
  4981. {
  4982. $pks = $this->reflection->getTablePrimaryKeys($tableName);
  4983. if (count($pks) == 1) {
  4984. return $pks[0];
  4985. }
  4986. return "";
  4987. }
  4988. private function canAutoIncrement(ReflectedColumn $column): bool
  4989. {
  4990. return in_array($column->getType(), ['integer', 'bigint']);
  4991. }
  4992. private function getColumnAutoIncrement(ReflectedColumn $column, bool $update): string
  4993. {
  4994. if (!$this->canAutoIncrement($column)) {
  4995. return '';
  4996. }
  4997. switch ($this->driver) {
  4998. case 'mysql':
  4999. return $column->getPk() ? ' AUTO_INCREMENT' : '';
  5000. case 'pgsql':
  5001. case 'sqlsrv':
  5002. return $column->getPk() ? ' IDENTITY(1,1)' : '';
  5003. case 'sqlite':
  5004. return $column->getPk() ? ' AUTOINCREMENT' : '';
  5005. }
  5006. }
  5007. private function getColumnNullType(ReflectedColumn $column, bool $update): string
  5008. {
  5009. if ($this->driver == 'pgsql' && $update) {
  5010. return '';
  5011. }
  5012. return $column->getNullable() ? ' NULL' : ' NOT NULL';
  5013. }
  5014. private function getTableRenameSQL(string $tableName, string $newTableName): string
  5015. {
  5016. $p1 = $this->quote($tableName);
  5017. $p2 = $this->quote($newTableName);
  5018. switch ($this->driver) {
  5019. case 'mysql':
  5020. return "RENAME TABLE $p1 TO $p2";
  5021. case 'pgsql':
  5022. return "ALTER TABLE $p1 RENAME TO $p2";
  5023. case 'sqlsrv':
  5024. return "EXEC sp_rename $p1, $p2";
  5025. case 'sqlite':
  5026. return "ALTER TABLE $p1 RENAME TO $p2";
  5027. }
  5028. }
  5029. private function getColumnRenameSQL(string $tableName, string $columnName, ReflectedColumn $newColumn): string
  5030. {
  5031. $p1 = $this->quote($tableName);
  5032. $p2 = $this->quote($columnName);
  5033. $p3 = $this->quote($newColumn->getName());
  5034. switch ($this->driver) {
  5035. case 'mysql':
  5036. $p4 = $this->getColumnType($newColumn, true);
  5037. return "ALTER TABLE $p1 CHANGE $p2 $p3 $p4";
  5038. case 'pgsql':
  5039. return "ALTER TABLE $p1 RENAME COLUMN $p2 TO $p3";
  5040. case 'sqlsrv':
  5041. $p4 = $this->quote($tableName . '.' . $columnName);
  5042. return "EXEC sp_rename $p4, $p3, 'COLUMN'";
  5043. case 'sqlite':
  5044. return "ALTER TABLE $p1 RENAME COLUMN $p2 TO $p3";
  5045. }
  5046. }
  5047. private function getColumnRetypeSQL(string $tableName, string $columnName, ReflectedColumn $newColumn): string
  5048. {
  5049. $p1 = $this->quote($tableName);
  5050. $p2 = $this->quote($columnName);
  5051. $p3 = $this->quote($newColumn->getName());
  5052. $p4 = $this->getColumnType($newColumn, true);
  5053. switch ($this->driver) {
  5054. case 'mysql':
  5055. return "ALTER TABLE $p1 CHANGE $p2 $p3 $p4";
  5056. case 'pgsql':
  5057. return "ALTER TABLE $p1 ALTER COLUMN $p3 TYPE $p4";
  5058. case 'sqlsrv':
  5059. return "ALTER TABLE $p1 ALTER COLUMN $p3 $p4";
  5060. }
  5061. }
  5062. private function getSetColumnNullableSQL(string $tableName, string $columnName, ReflectedColumn $newColumn): string
  5063. {
  5064. $p1 = $this->quote($tableName);
  5065. $p2 = $this->quote($columnName);
  5066. $p3 = $this->quote($newColumn->getName());
  5067. $p4 = $this->getColumnType($newColumn, true);
  5068. switch ($this->driver) {
  5069. case 'mysql':
  5070. return "ALTER TABLE $p1 CHANGE $p2 $p3 $p4";
  5071. case 'pgsql':
  5072. $p5 = $newColumn->getNullable() ? 'DROP NOT NULL' : 'SET NOT NULL';
  5073. return "ALTER TABLE $p1 ALTER COLUMN $p2 $p5";
  5074. case 'sqlsrv':
  5075. return "ALTER TABLE $p1 ALTER COLUMN $p2 $p4";
  5076. }
  5077. }
  5078. private function getSetColumnPkConstraintSQL(string $tableName, string $columnName, ReflectedColumn $newColumn): string
  5079. {
  5080. $p1 = $this->quote($tableName);
  5081. $p2 = $this->quote($columnName);
  5082. $p3 = $this->quote($tableName . '_pkey');
  5083. switch ($this->driver) {
  5084. case 'mysql':
  5085. $p4 = $newColumn->getPk() ? "ADD PRIMARY KEY ($p2)" : 'DROP PRIMARY KEY';
  5086. return "ALTER TABLE $p1 $p4";
  5087. case 'pgsql':
  5088. case 'sqlsrv':
  5089. $p4 = $newColumn->getPk() ? "ADD CONSTRAINT $p3 PRIMARY KEY ($p2)" : "DROP CONSTRAINT $p3";
  5090. return "ALTER TABLE $p1 $p4";
  5091. }
  5092. }
  5093. private function getSetColumnPkSequenceSQL(string $tableName, string $columnName, ReflectedColumn $newColumn): string
  5094. {
  5095. $p1 = $this->quote($tableName);
  5096. $p2 = $this->quote($columnName);
  5097. $p3 = $this->quote($tableName . '_' . $columnName . '_seq');
  5098. switch ($this->driver) {
  5099. case 'mysql':
  5100. return "select 1";
  5101. case 'pgsql':
  5102. return $newColumn->getPk() ? "CREATE SEQUENCE $p3 OWNED BY $p1.$p2" : "DROP SEQUENCE $p3";
  5103. case 'sqlsrv':
  5104. return $newColumn->getPk() ? "CREATE SEQUENCE $p3" : "DROP SEQUENCE $p3";
  5105. }
  5106. }
  5107. private function getSetColumnPkSequenceStartSQL(string $tableName, string $columnName, ReflectedColumn $newColumn): string
  5108. {
  5109. $p1 = $this->quote($tableName);
  5110. $p2 = $this->quote($columnName);
  5111. switch ($this->driver) {
  5112. case 'mysql':
  5113. return "select 1";
  5114. case 'pgsql':
  5115. $p3 = $this->pdo->quote($tableName . '_' . $columnName . '_seq');
  5116. return "SELECT setval($p3, (SELECT max($p2)+1 FROM $p1));";
  5117. case 'sqlsrv':
  5118. $p3 = $this->quote($tableName . '_' . $columnName . '_seq');
  5119. $p4 = $this->pdo->query("SELECT max($p2)+1 FROM $p1")->fetchColumn();
  5120. return "ALTER SEQUENCE $p3 RESTART WITH $p4";
  5121. }
  5122. }
  5123. private function getSetColumnPkDefaultSQL(string $tableName, string $columnName, ReflectedColumn $newColumn): string
  5124. {
  5125. $p1 = $this->quote($tableName);
  5126. $p2 = $this->quote($columnName);
  5127. switch ($this->driver) {
  5128. case 'mysql':
  5129. $p3 = $this->quote($newColumn->getName());
  5130. $p4 = $this->getColumnType($newColumn, true);
  5131. return "ALTER TABLE $p1 CHANGE $p2 $p3 $p4";
  5132. case 'pgsql':
  5133. if ($newColumn->getPk()) {
  5134. $p3 = $this->pdo->quote($tableName . '_' . $columnName . '_seq');
  5135. $p4 = "SET DEFAULT nextval($p3)";
  5136. } else {
  5137. $p4 = 'DROP DEFAULT';
  5138. }
  5139. return "ALTER TABLE $p1 ALTER COLUMN $p2 $p4";
  5140. case 'sqlsrv':
  5141. $p3 = $this->quote($tableName . '_' . $columnName . '_seq');
  5142. $p4 = $this->quote($tableName . '_' . $columnName . '_def');
  5143. if ($newColumn->getPk()) {
  5144. return "ALTER TABLE $p1 ADD CONSTRAINT $p4 DEFAULT NEXT VALUE FOR $p3 FOR $p2";
  5145. } else {
  5146. return "ALTER TABLE $p1 DROP CONSTRAINT $p4";
  5147. }
  5148. }
  5149. }
  5150. private function getAddColumnFkConstraintSQL(string $tableName, string $columnName, ReflectedColumn $newColumn): string
  5151. {
  5152. $p1 = $this->quote($tableName);
  5153. $p2 = $this->quote($columnName);
  5154. $p3 = $this->quote($tableName . '_' . $columnName . '_fkey');
  5155. $p4 = $this->quote($newColumn->getFk());
  5156. $p5 = $this->quote($this->getPrimaryKey($newColumn->getFk()));
  5157. return "ALTER TABLE $p1 ADD CONSTRAINT $p3 FOREIGN KEY ($p2) REFERENCES $p4 ($p5)";
  5158. }
  5159. private function getRemoveColumnFkConstraintSQL(string $tableName, string $columnName, ReflectedColumn $newColumn): string
  5160. {
  5161. $p1 = $this->quote($tableName);
  5162. $p2 = $this->quote($tableName . '_' . $columnName . '_fkey');
  5163. switch ($this->driver) {
  5164. case 'mysql':
  5165. return "ALTER TABLE $p1 DROP FOREIGN KEY $p2";
  5166. case 'pgsql':
  5167. case 'sqlsrv':
  5168. return "ALTER TABLE $p1 DROP CONSTRAINT $p2";
  5169. }
  5170. }
  5171. private function getAddTableSQL(ReflectedTable $newTable): string
  5172. {
  5173. $tableName = $newTable->getName();
  5174. $p1 = $this->quote($tableName);
  5175. $fields = [];
  5176. $constraints = [];
  5177. foreach ($newTable->getColumnNames() as $columnName) {
  5178. $pkColumn = $this->getPrimaryKey($tableName);
  5179. $newColumn = $newTable->getColumn($columnName);
  5180. $f1 = $this->quote($columnName);
  5181. $f2 = $this->getColumnType($newColumn, false);
  5182. $f3 = $this->quote($tableName . '_' . $columnName . '_fkey');
  5183. $f4 = $this->quote($newColumn->getFk());
  5184. $f5 = $this->quote($this->getPrimaryKey($newColumn->getFk()));
  5185. $f6 = $this->quote($tableName . '_' . $pkColumn . '_pkey');
  5186. if ($this->driver == 'sqlite') {
  5187. if ($newColumn->getPk()) {
  5188. $f2 = str_replace('NULL', 'NULL PRIMARY KEY', $f2);
  5189. }
  5190. $fields[] = "$f1 $f2";
  5191. if ($newColumn->getFk()) {
  5192. $constraints[] = "FOREIGN KEY ($f1) REFERENCES $f4 ($f5)";
  5193. }
  5194. } else {
  5195. $fields[] = "$f1 $f2";
  5196. if ($newColumn->getPk()) {
  5197. $constraints[] = "CONSTRAINT $f6 PRIMARY KEY ($f1)";
  5198. }
  5199. if ($newColumn->getFk()) {
  5200. $constraints[] = "CONSTRAINT $f3 FOREIGN KEY ($f1) REFERENCES $f4 ($f5)";
  5201. }
  5202. }
  5203. }
  5204. $p2 = implode(',', array_merge($fields, $constraints));
  5205. return "CREATE TABLE $p1 ($p2);";
  5206. }
  5207. private function getAddColumnSQL(string $tableName, ReflectedColumn $newColumn): string
  5208. {
  5209. $p1 = $this->quote($tableName);
  5210. $p2 = $this->quote($newColumn->getName());
  5211. $p3 = $this->getColumnType($newColumn, false);
  5212. switch ($this->driver) {
  5213. case 'mysql':
  5214. case 'pgsql':
  5215. return "ALTER TABLE $p1 ADD COLUMN $p2 $p3";
  5216. case 'sqlsrv':
  5217. return "ALTER TABLE $p1 ADD $p2 $p3";
  5218. case 'sqlite':
  5219. return "ALTER TABLE $p1 ADD COLUMN $p2 $p3";
  5220. }
  5221. }
  5222. private function getRemoveTableSQL(string $tableName): string
  5223. {
  5224. $p1 = $this->quote($tableName);
  5225. switch ($this->driver) {
  5226. case 'mysql':
  5227. case 'pgsql':
  5228. return "DROP TABLE $p1 CASCADE;";
  5229. case 'sqlsrv':
  5230. return "DROP TABLE $p1;";
  5231. case 'sqlite':
  5232. return "DROP TABLE $p1;";
  5233. }
  5234. }
  5235. private function getRemoveColumnSQL(string $tableName, string $columnName): string
  5236. {
  5237. $p1 = $this->quote($tableName);
  5238. $p2 = $this->quote($columnName);
  5239. switch ($this->driver) {
  5240. case 'mysql':
  5241. case 'pgsql':
  5242. return "ALTER TABLE $p1 DROP COLUMN $p2 CASCADE;";
  5243. case 'sqlsrv':
  5244. return "ALTER TABLE $p1 DROP COLUMN $p2;";
  5245. case 'sqlite':
  5246. return "ALTER TABLE $p1 DROP COLUMN $p2;";
  5247. }
  5248. }
  5249. public function renameTable(string $tableName, string $newTableName)
  5250. {
  5251. $sql = $this->getTableRenameSQL($tableName, $newTableName);
  5252. return $this->query($sql, []);
  5253. }
  5254. public function renameColumn(string $tableName, string $columnName, ReflectedColumn $newColumn)
  5255. {
  5256. $sql = $this->getColumnRenameSQL($tableName, $columnName, $newColumn);
  5257. return $this->query($sql, []);
  5258. }
  5259. public function retypeColumn(string $tableName, string $columnName, ReflectedColumn $newColumn)
  5260. {
  5261. $sql = $this->getColumnRetypeSQL($tableName, $columnName, $newColumn);
  5262. return $this->query($sql, []);
  5263. }
  5264. public function setColumnNullable(string $tableName, string $columnName, ReflectedColumn $newColumn)
  5265. {
  5266. $sql = $this->getSetColumnNullableSQL($tableName, $columnName, $newColumn);
  5267. return $this->query($sql, []);
  5268. }
  5269. public function addColumnPrimaryKey(string $tableName, string $columnName, ReflectedColumn $newColumn)
  5270. {
  5271. $sql = $this->getSetColumnPkConstraintSQL($tableName, $columnName, $newColumn);
  5272. $this->query($sql, []);
  5273. if ($this->canAutoIncrement($newColumn)) {
  5274. $sql = $this->getSetColumnPkSequenceSQL($tableName, $columnName, $newColumn);
  5275. $this->query($sql, []);
  5276. $sql = $this->getSetColumnPkSequenceStartSQL($tableName, $columnName, $newColumn);
  5277. $this->query($sql, []);
  5278. $sql = $this->getSetColumnPkDefaultSQL($tableName, $columnName, $newColumn);
  5279. $this->query($sql, []);
  5280. }
  5281. return true;
  5282. }
  5283. public function removeColumnPrimaryKey(string $tableName, string $columnName, ReflectedColumn $newColumn)
  5284. {
  5285. if ($this->canAutoIncrement($newColumn)) {
  5286. $sql = $this->getSetColumnPkDefaultSQL($tableName, $columnName, $newColumn);
  5287. $this->query($sql, []);
  5288. $sql = $this->getSetColumnPkSequenceSQL($tableName, $columnName, $newColumn);
  5289. $this->query($sql, []);
  5290. }
  5291. $sql = $this->getSetColumnPkConstraintSQL($tableName, $columnName, $newColumn);
  5292. $this->query($sql, []);
  5293. return true;
  5294. }
  5295. public function addColumnForeignKey(string $tableName, string $columnName, ReflectedColumn $newColumn)
  5296. {
  5297. $sql = $this->getAddColumnFkConstraintSQL($tableName, $columnName, $newColumn);
  5298. return $this->query($sql, []);
  5299. }
  5300. public function removeColumnForeignKey(string $tableName, string $columnName, ReflectedColumn $newColumn)
  5301. {
  5302. $sql = $this->getRemoveColumnFkConstraintSQL($tableName, $columnName, $newColumn);
  5303. return $this->query($sql, []);
  5304. }
  5305. public function addTable(ReflectedTable $newTable)
  5306. {
  5307. $sql = $this->getAddTableSQL($newTable);
  5308. return $this->query($sql, []);
  5309. }
  5310. public function addColumn(string $tableName, ReflectedColumn $newColumn)
  5311. {
  5312. $sql = $this->getAddColumnSQL($tableName, $newColumn);
  5313. return $this->query($sql, []);
  5314. }
  5315. public function removeTable(string $tableName)
  5316. {
  5317. $sql = $this->getRemoveTableSQL($tableName);
  5318. return $this->query($sql, []);
  5319. }
  5320. public function removeColumn(string $tableName, string $columnName)
  5321. {
  5322. $sql = $this->getRemoveColumnSQL($tableName, $columnName);
  5323. return $this->query($sql, []);
  5324. }
  5325. private function query(string $sql, array $arguments): bool
  5326. {
  5327. $stmt = $this->pdo->prepare($sql);
  5328. // echo "- $sql -- " . json_encode($arguments) . "\n";
  5329. return $stmt->execute($arguments);
  5330. }
  5331. }
  5332. }
  5333. // file: src/Tqdev/PhpCrudApi/Database/GenericReflection.php
  5334. namespace Tqdev\PhpCrudApi\Database {
  5335. use Tqdev\PhpCrudApi\Database\LazyPdo;
  5336. class GenericReflection
  5337. {
  5338. private $pdo;
  5339. private $driver;
  5340. private $database;
  5341. private $tables;
  5342. private $typeConverter;
  5343. public function __construct(LazyPdo $pdo, string $driver, string $database, array $tables)
  5344. {
  5345. $this->pdo = $pdo;
  5346. $this->driver = $driver;
  5347. $this->database = $database;
  5348. $this->tables = $tables;
  5349. $this->typeConverter = new TypeConverter($driver);
  5350. }
  5351. public function getIgnoredTables(): array
  5352. {
  5353. switch ($this->driver) {
  5354. case 'mysql':
  5355. return [];
  5356. case 'pgsql':
  5357. return ['spatial_ref_sys', 'raster_columns', 'raster_overviews', 'geography_columns', 'geometry_columns'];
  5358. case 'sqlsrv':
  5359. return [];
  5360. case 'sqlite':
  5361. return [];
  5362. }
  5363. }
  5364. private function getTablesSQL(): string
  5365. {
  5366. switch ($this->driver) {
  5367. case 'mysql':
  5368. return 'SELECT "TABLE_NAME", "TABLE_TYPE" FROM "INFORMATION_SCHEMA"."TABLES" WHERE "TABLE_TYPE" IN (\'BASE TABLE\' , \'VIEW\') AND "TABLE_SCHEMA" = ? ORDER BY BINARY "TABLE_NAME"';
  5369. case 'pgsql':
  5370. return 'SELECT c.relname as "TABLE_NAME", c.relkind as "TABLE_TYPE" FROM pg_catalog.pg_class c LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace WHERE c.relkind IN (\'r\', \'v\') AND n.nspname <> \'pg_catalog\' AND n.nspname <> \'information_schema\' AND n.nspname !~ \'^pg_toast\' AND pg_catalog.pg_table_is_visible(c.oid) AND \'\' <> ? ORDER BY "TABLE_NAME";';
  5371. case 'sqlsrv':
  5372. return 'SELECT o.name as "TABLE_NAME", o.xtype as "TABLE_TYPE" FROM sysobjects o WHERE o.xtype IN (\'U\', \'V\') ORDER BY "TABLE_NAME"';
  5373. case 'sqlite':
  5374. return 'SELECT t.name as "TABLE_NAME", t.type as "TABLE_TYPE" FROM sqlite_master t WHERE t.type IN (\'table\', \'view\') AND \'\' <> ? ORDER BY "TABLE_NAME"';
  5375. }
  5376. }
  5377. private function getTableColumnsSQL(): string
  5378. {
  5379. switch ($this->driver) {
  5380. case 'mysql':
  5381. return 'SELECT "COLUMN_NAME", "IS_NULLABLE", "DATA_TYPE", "CHARACTER_MAXIMUM_LENGTH" as "CHARACTER_MAXIMUM_LENGTH", "NUMERIC_PRECISION", "NUMERIC_SCALE", "COLUMN_TYPE" FROM "INFORMATION_SCHEMA"."COLUMNS" WHERE "TABLE_NAME" = ? AND "TABLE_SCHEMA" = ? ORDER BY "ORDINAL_POSITION"';
  5382. case 'pgsql':
  5383. return 'SELECT a.attname AS "COLUMN_NAME", case when a.attnotnull then \'NO\' else \'YES\' end as "IS_NULLABLE", pg_catalog.format_type(a.atttypid, -1) as "DATA_TYPE", case when a.atttypmod < 0 then NULL else a.atttypmod-4 end as "CHARACTER_MAXIMUM_LENGTH", case when a.atttypid != 1700 then NULL else ((a.atttypmod - 4) >> 16) & 65535 end as "NUMERIC_PRECISION", case when a.atttypid != 1700 then NULL else (a.atttypmod - 4) & 65535 end as "NUMERIC_SCALE", \'\' AS "COLUMN_TYPE" FROM pg_attribute a JOIN pg_class pgc ON pgc.oid = a.attrelid WHERE pgc.relname = ? AND \'\' <> ? AND a.attnum > 0 AND NOT a.attisdropped ORDER BY a.attnum;';
  5384. case 'sqlsrv':
  5385. return 'SELECT c.name AS "COLUMN_NAME", c.is_nullable AS "IS_NULLABLE", t.Name AS "DATA_TYPE", (c.max_length/2) AS "CHARACTER_MAXIMUM_LENGTH", c.precision AS "NUMERIC_PRECISION", c.scale AS "NUMERIC_SCALE", \'\' AS "COLUMN_TYPE" FROM sys.columns c INNER JOIN sys.types t ON c.user_type_id = t.user_type_id WHERE c.object_id = OBJECT_ID(?) AND \'\' <> ? ORDER BY c.column_id';
  5386. case 'sqlite':
  5387. return 'SELECT "name" AS "COLUMN_NAME", case when "notnull"==1 then \'no\' else \'yes\' end as "IS_NULLABLE", lower("type") AS "DATA_TYPE", 2147483647 AS "CHARACTER_MAXIMUM_LENGTH", 0 AS "NUMERIC_PRECISION", 0 AS "NUMERIC_SCALE", \'\' AS "COLUMN_TYPE" FROM pragma_table_info(?) WHERE \'\' <> ? ORDER BY "cid"';
  5388. }
  5389. }
  5390. private function getTablePrimaryKeysSQL(): string
  5391. {
  5392. switch ($this->driver) {
  5393. case 'mysql':
  5394. return 'SELECT "COLUMN_NAME" FROM "INFORMATION_SCHEMA"."KEY_COLUMN_USAGE" WHERE "CONSTRAINT_NAME" = \'PRIMARY\' AND "TABLE_NAME" = ? AND "TABLE_SCHEMA" = ?';
  5395. case 'pgsql':
  5396. return 'SELECT a.attname AS "COLUMN_NAME" FROM pg_attribute a JOIN pg_constraint c ON (c.conrelid, c.conkey[1]) = (a.attrelid, a.attnum) JOIN pg_class pgc ON pgc.oid = a.attrelid WHERE pgc.relname = ? AND \'\' <> ? AND c.contype = \'p\'';
  5397. case 'sqlsrv':
  5398. return 'SELECT c.NAME as "COLUMN_NAME" FROM sys.key_constraints kc inner join sys.objects t on t.object_id = kc.parent_object_id INNER JOIN sys.index_columns ic ON kc.parent_object_id = ic.object_id and kc.unique_index_id = ic.index_id INNER JOIN sys.columns c ON ic.object_id = c.object_id AND ic.column_id = c.column_id WHERE kc.type = \'PK\' and t.object_id = OBJECT_ID(?) and \'\' <> ?';
  5399. case 'sqlite':
  5400. return 'SELECT "name" as "COLUMN_NAME" FROM pragma_table_info(?) WHERE "pk"=1 AND \'\' <> ?';
  5401. }
  5402. }
  5403. private function getTableForeignKeysSQL(): string
  5404. {
  5405. switch ($this->driver) {
  5406. case 'mysql':
  5407. return 'SELECT "COLUMN_NAME", "REFERENCED_TABLE_NAME" FROM "INFORMATION_SCHEMA"."KEY_COLUMN_USAGE" WHERE "REFERENCED_TABLE_NAME" IS NOT NULL AND "TABLE_NAME" = ? AND "TABLE_SCHEMA" = ?';
  5408. case 'pgsql':
  5409. return 'SELECT a.attname AS "COLUMN_NAME", c.confrelid::regclass::text AS "REFERENCED_TABLE_NAME" FROM pg_attribute a JOIN pg_constraint c ON (c.conrelid, c.conkey[1]) = (a.attrelid, a.attnum) JOIN pg_class pgc ON pgc.oid = a.attrelid WHERE pgc.relname = ? AND \'\' <> ? AND c.contype = \'f\'';
  5410. case 'sqlsrv':
  5411. return 'SELECT COL_NAME(fc.parent_object_id, fc.parent_column_id) AS "COLUMN_NAME", OBJECT_NAME (f.referenced_object_id) AS "REFERENCED_TABLE_NAME" FROM sys.foreign_keys AS f INNER JOIN sys.foreign_key_columns AS fc ON f.OBJECT_ID = fc.constraint_object_id WHERE f.parent_object_id = OBJECT_ID(?) and \'\' <> ?';
  5412. case 'sqlite':
  5413. return 'SELECT "from" AS "COLUMN_NAME", "table" AS "REFERENCED_TABLE_NAME" FROM pragma_foreign_key_list(?) WHERE \'\' <> ?';
  5414. }
  5415. }
  5416. public function getDatabaseName(): string
  5417. {
  5418. return $this->database;
  5419. }
  5420. public function getTables(): array
  5421. {
  5422. $sql = $this->getTablesSQL();
  5423. $results = $this->query($sql, [$this->database]);
  5424. $tables = $this->tables;
  5425. $results = array_filter($results, function ($v) use ($tables) {
  5426. return !$tables || in_array($v['TABLE_NAME'], $tables);
  5427. });
  5428. foreach ($results as &$result) {
  5429. $map = [];
  5430. switch ($this->driver) {
  5431. case 'mysql':
  5432. $map = ['BASE TABLE' => 'table', 'VIEW' => 'view'];
  5433. break;
  5434. case 'pgsql':
  5435. $map = ['r' => 'table', 'v' => 'view'];
  5436. break;
  5437. case 'sqlsrv':
  5438. $map = ['U' => 'table', 'V' => 'view'];
  5439. break;
  5440. case 'sqlite':
  5441. $map = ['table' => 'table', 'view' => 'view'];
  5442. break;
  5443. }
  5444. $result['TABLE_TYPE'] = $map[trim($result['TABLE_TYPE'])];
  5445. }
  5446. return $results;
  5447. }
  5448. public function getTableColumns(string $tableName, string $type): array
  5449. {
  5450. $sql = $this->getTableColumnsSQL();
  5451. $results = $this->query($sql, [$tableName, $this->database]);
  5452. if ($type == 'view') {
  5453. foreach ($results as &$result) {
  5454. $result['IS_NULLABLE'] = false;
  5455. }
  5456. }
  5457. if ($this->driver == 'mysql') {
  5458. foreach ($results as &$result) {
  5459. // mysql does not properly reflect display width of types
  5460. preg_match('|([a-z]+)(\(([0-9]+)(,([0-9]+))?\))?|', $result['DATA_TYPE'], $matches);
  5461. $result['DATA_TYPE'] = $matches[1];
  5462. if (!$result['CHARACTER_MAXIMUM_LENGTH']) {
  5463. if (isset($matches[3])) {
  5464. $result['NUMERIC_PRECISION'] = $matches[3];
  5465. }
  5466. if (isset($matches[5])) {
  5467. $result['NUMERIC_SCALE'] = $matches[5];
  5468. }
  5469. }
  5470. }
  5471. }
  5472. if ($this->driver == 'sqlite') {
  5473. foreach ($results as &$result) {
  5474. // sqlite does not properly reflect display width of types
  5475. preg_match('|([a-z]+)(\(([0-9]+)(,([0-9]+))?\))?|', $result['DATA_TYPE'], $matches);
  5476. if (isset($matches[1])) {
  5477. $result['DATA_TYPE'] = $matches[1];
  5478. } else {
  5479. $result['DATA_TYPE'] = 'integer';
  5480. }
  5481. if (isset($matches[5])) {
  5482. $result['NUMERIC_PRECISION'] = $matches[3];
  5483. $result['NUMERIC_SCALE'] = $matches[5];
  5484. } else if (isset($matches[3])) {
  5485. $result['CHARACTER_MAXIMUM_LENGTH'] = $matches[3];
  5486. }
  5487. }
  5488. }
  5489. return $results;
  5490. }
  5491. public function getTablePrimaryKeys(string $tableName): array
  5492. {
  5493. $sql = $this->getTablePrimaryKeysSQL();
  5494. $results = $this->query($sql, [$tableName, $this->database]);
  5495. $primaryKeys = [];
  5496. foreach ($results as $result) {
  5497. $primaryKeys[] = $result['COLUMN_NAME'];
  5498. }
  5499. return $primaryKeys;
  5500. }
  5501. public function getTableForeignKeys(string $tableName): array
  5502. {
  5503. $sql = $this->getTableForeignKeysSQL();
  5504. $results = $this->query($sql, [$tableName, $this->database]);
  5505. $foreignKeys = [];
  5506. foreach ($results as $result) {
  5507. $foreignKeys[$result['COLUMN_NAME']] = $result['REFERENCED_TABLE_NAME'];
  5508. }
  5509. return $foreignKeys;
  5510. }
  5511. public function toJdbcType(string $type, string $size): string
  5512. {
  5513. return $this->typeConverter->toJdbc($type, $size);
  5514. }
  5515. private function query(string $sql, array $parameters): array
  5516. {
  5517. $stmt = $this->pdo->prepare($sql);
  5518. //echo "- $sql -- " . json_encode($parameters, JSON_UNESCAPED_UNICODE) . "\n";
  5519. $stmt->execute($parameters);
  5520. return $stmt->fetchAll();
  5521. }
  5522. }
  5523. }
  5524. // file: src/Tqdev/PhpCrudApi/Database/LazyPdo.php
  5525. namespace Tqdev\PhpCrudApi\Database {
  5526. class LazyPdo extends \PDO
  5527. {
  5528. private $dsn;
  5529. private $user;
  5530. private $password;
  5531. private $options;
  5532. private $commands;
  5533. private $pdo = null;
  5534. public function __construct(string $dsn, /*?string*/ $user = null, /*?string*/ $password = null, array $options = array())
  5535. {
  5536. $this->dsn = $dsn;
  5537. $this->user = $user;
  5538. $this->password = $password;
  5539. $this->options = $options;
  5540. $this->commands = array();
  5541. // explicitly NOT calling super::__construct
  5542. }
  5543. public function addInitCommand(string $command)/*: void*/
  5544. {
  5545. $this->commands[] = $command;
  5546. }
  5547. private function pdo()
  5548. {
  5549. if (!$this->pdo) {
  5550. $this->pdo = new \PDO($this->dsn, $this->user, $this->password, $this->options);
  5551. foreach ($this->commands as $command) {
  5552. $this->pdo->query($command);
  5553. }
  5554. }
  5555. return $this->pdo;
  5556. }
  5557. public function reconstruct(string $dsn, /*?string*/ $user = null, /*?string*/ $password = null, array $options = array()): bool
  5558. {
  5559. $this->dsn = $dsn;
  5560. $this->user = $user;
  5561. $this->password = $password;
  5562. $this->options = $options;
  5563. $this->commands = array();
  5564. if ($this->pdo) {
  5565. $this->pdo = null;
  5566. return true;
  5567. }
  5568. return false;
  5569. }
  5570. public function inTransaction(): bool
  5571. {
  5572. // Do not call parent method if there is no pdo object
  5573. return $this->pdo && parent::inTransaction();
  5574. }
  5575. public function setAttribute($attribute, $value): bool
  5576. {
  5577. if ($this->pdo) {
  5578. return $this->pdo()->setAttribute($attribute, $value);
  5579. }
  5580. $this->options[$attribute] = $value;
  5581. return true;
  5582. }
  5583. public function getAttribute($attribute): mixed
  5584. {
  5585. return $this->pdo()->getAttribute($attribute);
  5586. }
  5587. public function beginTransaction(): bool
  5588. {
  5589. return $this->pdo()->beginTransaction();
  5590. }
  5591. public function commit(): bool
  5592. {
  5593. return $this->pdo()->commit();
  5594. }
  5595. public function rollBack(): bool
  5596. {
  5597. return $this->pdo()->rollBack();
  5598. }
  5599. public function errorCode(): mixed
  5600. {
  5601. return $this->pdo()->errorCode();
  5602. }
  5603. public function errorInfo(): array
  5604. {
  5605. return $this->pdo()->errorInfo();
  5606. }
  5607. public function exec($query): int
  5608. {
  5609. return $this->pdo()->exec($query);
  5610. }
  5611. public function prepare($statement, $options = array())
  5612. {
  5613. return $this->pdo()->prepare($statement, $options);
  5614. }
  5615. public function quote($string, $parameter_type = null): string
  5616. {
  5617. return $this->pdo()->quote($string, $parameter_type);
  5618. }
  5619. public function lastInsertId(/* ?string */$name = null): string
  5620. {
  5621. return $this->pdo()->lastInsertId($name);
  5622. }
  5623. public function query(string $statement): \PDOStatement
  5624. {
  5625. return call_user_func_array(array($this->pdo(), 'query'), func_get_args());
  5626. }
  5627. }
  5628. }
  5629. // file: src/Tqdev/PhpCrudApi/Database/TypeConverter.php
  5630. namespace Tqdev\PhpCrudApi\Database {
  5631. class TypeConverter
  5632. {
  5633. private $driver;
  5634. public function __construct(string $driver)
  5635. {
  5636. $this->driver = $driver;
  5637. }
  5638. private $fromJdbc = [
  5639. 'mysql' => [
  5640. 'clob' => 'longtext',
  5641. 'boolean' => 'tinyint(1)',
  5642. 'blob' => 'longblob',
  5643. 'timestamp' => 'datetime',
  5644. ],
  5645. 'pgsql' => [
  5646. 'clob' => 'text',
  5647. 'blob' => 'bytea',
  5648. 'float' => 'real',
  5649. 'double' => 'double precision',
  5650. 'varbinary' => 'bytea',
  5651. ],
  5652. 'sqlsrv' => [
  5653. 'boolean' => 'bit',
  5654. 'varchar' => 'nvarchar',
  5655. 'clob' => 'ntext',
  5656. 'blob' => 'image',
  5657. 'time' => 'time(0)',
  5658. 'timestamp' => 'datetime2(0)',
  5659. 'double' => 'float',
  5660. 'float' => 'real',
  5661. ],
  5662. ];
  5663. private $toJdbc = [
  5664. 'simplified' => [
  5665. 'char' => 'varchar',
  5666. 'longvarchar' => 'clob',
  5667. 'nchar' => 'varchar',
  5668. 'nvarchar' => 'varchar',
  5669. 'longnvarchar' => 'clob',
  5670. 'binary' => 'varbinary',
  5671. 'longvarbinary' => 'blob',
  5672. 'tinyint' => 'integer',
  5673. 'smallint' => 'integer',
  5674. 'real' => 'float',
  5675. 'numeric' => 'decimal',
  5676. 'nclob' => 'clob',
  5677. 'time_with_timezone' => 'time',
  5678. 'timestamp_with_timezone' => 'timestamp',
  5679. ],
  5680. 'mysql' => [
  5681. 'tinyint(1)' => 'boolean',
  5682. 'bit(1)' => 'boolean',
  5683. 'tinyblob' => 'blob',
  5684. 'mediumblob' => 'blob',
  5685. 'longblob' => 'blob',
  5686. 'tinytext' => 'clob',
  5687. 'mediumtext' => 'clob',
  5688. 'longtext' => 'clob',
  5689. 'text' => 'clob',
  5690. 'mediumint' => 'integer',
  5691. 'int' => 'integer',
  5692. 'polygon' => 'geometry',
  5693. 'point' => 'geometry',
  5694. 'datetime' => 'timestamp',
  5695. 'year' => 'integer',
  5696. 'enum' => 'varchar',
  5697. 'set' => 'varchar',
  5698. 'json' => 'clob',
  5699. ],
  5700. 'pgsql' => [
  5701. 'bigserial' => 'bigint',
  5702. 'bit varying' => 'bit',
  5703. 'box' => 'geometry',
  5704. 'bytea' => 'blob',
  5705. 'bpchar' => 'char',
  5706. 'character varying' => 'varchar',
  5707. 'character' => 'char',
  5708. 'cidr' => 'varchar',
  5709. 'circle' => 'geometry',
  5710. 'double precision' => 'double',
  5711. 'inet' => 'integer',
  5712. //'interval [ fields ]'
  5713. 'json' => 'clob',
  5714. 'jsonb' => 'clob',
  5715. 'line' => 'geometry',
  5716. 'lseg' => 'geometry',
  5717. 'macaddr' => 'varchar',
  5718. 'money' => 'decimal',
  5719. 'path' => 'geometry',
  5720. 'point' => 'geometry',
  5721. 'polygon' => 'geometry',
  5722. 'real' => 'float',
  5723. 'serial' => 'integer',
  5724. 'text' => 'clob',
  5725. 'time without time zone' => 'time',
  5726. 'time with time zone' => 'time_with_timezone',
  5727. 'timestamp without time zone' => 'timestamp',
  5728. 'timestamp with time zone' => 'timestamp_with_timezone',
  5729. //'tsquery'=
  5730. //'tsvector'
  5731. //'txid_snapshot'
  5732. 'uuid' => 'char',
  5733. 'xml' => 'clob',
  5734. ],
  5735. // source: https://docs.microsoft.com/en-us/sql/connect/jdbc/using-basic-data-types?view=sql-server-2017
  5736. 'sqlsrv' => [
  5737. 'varbinary()' => 'blob',
  5738. 'bit' => 'boolean',
  5739. 'datetime' => 'timestamp',
  5740. 'datetime2' => 'timestamp',
  5741. 'float' => 'double',
  5742. 'image' => 'blob',
  5743. 'int' => 'integer',
  5744. 'money' => 'decimal',
  5745. 'ntext' => 'clob',
  5746. 'smalldatetime' => 'timestamp',
  5747. 'smallmoney' => 'decimal',
  5748. 'text' => 'clob',
  5749. 'timestamp' => 'binary',
  5750. 'udt' => 'varbinary',
  5751. 'uniqueidentifier' => 'char',
  5752. 'xml' => 'clob',
  5753. ],
  5754. 'sqlite' => [
  5755. 'tinytext' => 'clob',
  5756. 'text' => 'clob',
  5757. 'mediumtext' => 'clob',
  5758. 'longtext' => 'clob',
  5759. 'mediumint' => 'integer',
  5760. 'int' => 'integer',
  5761. 'bigint' => 'bigint',
  5762. 'int2' => 'smallint',
  5763. 'int4' => 'integer',
  5764. 'int8' => 'bigint',
  5765. 'double precision' => 'double',
  5766. 'datetime' => 'timestamp'
  5767. ],
  5768. ];
  5769. // source: https://docs.oracle.com/javase/9/docs/api/java/sql/Types.html
  5770. private $valid = [
  5771. //'array' => true,
  5772. 'bigint' => true,
  5773. 'binary' => true,
  5774. 'bit' => true,
  5775. 'blob' => true,
  5776. 'boolean' => true,
  5777. 'char' => true,
  5778. 'clob' => true,
  5779. //'datalink' => true,
  5780. 'date' => true,
  5781. 'decimal' => true,
  5782. //'distinct' => true,
  5783. 'double' => true,
  5784. 'float' => true,
  5785. 'integer' => true,
  5786. //'java_object' => true,
  5787. 'longnvarchar' => true,
  5788. 'longvarbinary' => true,
  5789. 'longvarchar' => true,
  5790. 'nchar' => true,
  5791. 'nclob' => true,
  5792. //'null' => true,
  5793. 'numeric' => true,
  5794. 'nvarchar' => true,
  5795. //'other' => true,
  5796. 'real' => true,
  5797. //'ref' => true,
  5798. //'ref_cursor' => true,
  5799. //'rowid' => true,
  5800. 'smallint' => true,
  5801. //'sqlxml' => true,
  5802. //'struct' => true,
  5803. 'time' => true,
  5804. 'time_with_timezone' => true,
  5805. 'timestamp' => true,
  5806. 'timestamp_with_timezone' => true,
  5807. 'tinyint' => true,
  5808. 'varbinary' => true,
  5809. 'varchar' => true,
  5810. // extra:
  5811. 'geometry' => true,
  5812. ];
  5813. public function toJdbc(string $type, string $size): string
  5814. {
  5815. $jdbcType = strtolower($type);
  5816. if (isset($this->toJdbc[$this->driver]["$jdbcType($size)"])) {
  5817. $jdbcType = $this->toJdbc[$this->driver]["$jdbcType($size)"];
  5818. }
  5819. if (isset($this->toJdbc[$this->driver][$jdbcType])) {
  5820. $jdbcType = $this->toJdbc[$this->driver][$jdbcType];
  5821. }
  5822. if (isset($this->toJdbc['simplified'][$jdbcType])) {
  5823. $jdbcType = $this->toJdbc['simplified'][$jdbcType];
  5824. }
  5825. if (!isset($this->valid[$jdbcType])) {
  5826. //throw new \Exception("Unsupported type '$jdbcType' for driver '$this->driver'");
  5827. $jdbcType = 'clob';
  5828. }
  5829. return $jdbcType;
  5830. }
  5831. public function fromJdbc(string $type): string
  5832. {
  5833. $jdbcType = strtolower($type);
  5834. if (isset($this->fromJdbc[$this->driver][$jdbcType])) {
  5835. $jdbcType = $this->fromJdbc[$this->driver][$jdbcType];
  5836. }
  5837. return $jdbcType;
  5838. }
  5839. }
  5840. }
  5841. // file: src/Tqdev/PhpCrudApi/GeoJson/Feature.php
  5842. namespace Tqdev\PhpCrudApi\GeoJson {
  5843. class Feature implements \JsonSerializable
  5844. {
  5845. private $id;
  5846. private $properties;
  5847. private $geometry;
  5848. public function __construct($id, array $properties, /*?Geometry*/ $geometry)
  5849. {
  5850. $this->id = $id;
  5851. $this->properties = $properties;
  5852. $this->geometry = $geometry;
  5853. }
  5854. public function serialize()
  5855. {
  5856. return [
  5857. 'type' => 'Feature',
  5858. 'id' => $this->id,
  5859. 'properties' => $this->properties,
  5860. 'geometry' => $this->geometry,
  5861. ];
  5862. }
  5863. public function jsonSerialize()
  5864. {
  5865. return $this->serialize();
  5866. }
  5867. }
  5868. }
  5869. // file: src/Tqdev/PhpCrudApi/GeoJson/FeatureCollection.php
  5870. namespace Tqdev\PhpCrudApi\GeoJson {
  5871. class FeatureCollection implements \JsonSerializable
  5872. {
  5873. private $features;
  5874. private $results;
  5875. public function __construct(array $features, int $results)
  5876. {
  5877. $this->features = $features;
  5878. $this->results = $results;
  5879. }
  5880. public function serialize()
  5881. {
  5882. return [
  5883. 'type' => 'FeatureCollection',
  5884. 'features' => $this->features,
  5885. 'results' => $this->results,
  5886. ];
  5887. }
  5888. public function jsonSerialize()
  5889. {
  5890. return array_filter($this->serialize(), function ($v) {
  5891. return $v !== 0;
  5892. });
  5893. }
  5894. }
  5895. }
  5896. // file: src/Tqdev/PhpCrudApi/GeoJson/GeoJsonService.php
  5897. namespace Tqdev\PhpCrudApi\GeoJson {
  5898. use Tqdev\PhpCrudApi\Column\ReflectionService;
  5899. use Tqdev\PhpCrudApi\GeoJson\FeatureCollection;
  5900. use Tqdev\PhpCrudApi\Record\RecordService;
  5901. class GeoJsonService
  5902. {
  5903. private $reflection;
  5904. private $records;
  5905. public function __construct(ReflectionService $reflection, RecordService $records)
  5906. {
  5907. $this->reflection = $reflection;
  5908. $this->records = $records;
  5909. }
  5910. public function hasTable(string $table): bool
  5911. {
  5912. return $this->reflection->hasTable($table);
  5913. }
  5914. public function getType(string $table): string
  5915. {
  5916. return $this->reflection->getType($table);
  5917. }
  5918. private function getGeometryColumnName(string $tableName, array &$params): string
  5919. {
  5920. $geometryParam = isset($params['geometry']) ? $params['geometry'][0] : '';
  5921. $table = $this->reflection->getTable($tableName);
  5922. $geometryColumnName = '';
  5923. foreach ($table->getColumnNames() as $columnName) {
  5924. if ($geometryParam && $geometryParam != $columnName) {
  5925. continue;
  5926. }
  5927. $column = $table->getColumn($columnName);
  5928. if ($column->isGeometry()) {
  5929. $geometryColumnName = $columnName;
  5930. break;
  5931. }
  5932. }
  5933. if ($geometryColumnName) {
  5934. $params['mandatory'][] = $tableName . "." . $geometryColumnName;
  5935. }
  5936. return $geometryColumnName;
  5937. }
  5938. private function setBoudingBoxFilter(string $geometryColumnName, array &$params)
  5939. {
  5940. $boundingBox = isset($params['bbox']) ? $params['bbox'][0] : '';
  5941. if ($boundingBox) {
  5942. $c = explode(',', $boundingBox);
  5943. if (!isset($params['filter'])) {
  5944. $params['filter'] = array();
  5945. }
  5946. $params['filter'][] = "$geometryColumnName,sin,POLYGON(($c[0] $c[1],$c[2] $c[1],$c[2] $c[3],$c[0] $c[3],$c[0] $c[1]))";
  5947. }
  5948. $tile = isset($params['tile']) ? $params['tile'][0] : '';
  5949. if ($tile) {
  5950. $zxy = explode(',', $tile);
  5951. if (count($zxy) == 3) {
  5952. list($z, $x, $y) = $zxy;
  5953. $c = array();
  5954. $c = array_merge($c, $this->convertTileToLatLonOfUpperLeftCorner($z, $x, $y));
  5955. $c = array_merge($c, $this->convertTileToLatLonOfUpperLeftCorner($z, $x + 1, $y + 1));
  5956. $params['filter'][] = "$geometryColumnName,sin,POLYGON(($c[0] $c[1],$c[2] $c[1],$c[2] $c[3],$c[0] $c[3],$c[0] $c[1]))";
  5957. }
  5958. }
  5959. }
  5960. private function convertTileToLatLonOfUpperLeftCorner($z, $x, $y): array
  5961. {
  5962. $n = pow(2, $z);
  5963. $lon = $x / $n * 360.0 - 180.0;
  5964. $lat = rad2deg(atan(sinh(pi() * (1 - 2 * $y / $n))));
  5965. return [$lon, $lat];
  5966. }
  5967. private function convertRecordToFeature(/*object*/$record, string $primaryKeyColumnName, string $geometryColumnName)
  5968. {
  5969. $id = null;
  5970. if ($primaryKeyColumnName) {
  5971. $id = $record[$primaryKeyColumnName];
  5972. }
  5973. $geometry = null;
  5974. if (isset($record[$geometryColumnName])) {
  5975. $geometry = Geometry::fromWkt($record[$geometryColumnName]);
  5976. }
  5977. $properties = array_diff_key($record, [$primaryKeyColumnName => true, $geometryColumnName => true]);
  5978. return new Feature($id, $properties, $geometry);
  5979. }
  5980. private function getPrimaryKeyColumnName(string $tableName, array &$params): string
  5981. {
  5982. $primaryKeyColumn = $this->reflection->getTable($tableName)->getPk();
  5983. if (!$primaryKeyColumn) {
  5984. return '';
  5985. }
  5986. $primaryKeyColumnName = $primaryKeyColumn->getName();
  5987. $params['mandatory'][] = $tableName . "." . $primaryKeyColumnName;
  5988. return $primaryKeyColumnName;
  5989. }
  5990. public function _list(string $tableName, array $params): FeatureCollection
  5991. {
  5992. $geometryColumnName = $this->getGeometryColumnName($tableName, $params);
  5993. $this->setBoudingBoxFilter($geometryColumnName, $params);
  5994. $primaryKeyColumnName = $this->getPrimaryKeyColumnName($tableName, $params);
  5995. $records = $this->records->_list($tableName, $params);
  5996. $features = array();
  5997. foreach ($records->getRecords() as $record) {
  5998. $features[] = $this->convertRecordToFeature($record, $primaryKeyColumnName, $geometryColumnName);
  5999. }
  6000. return new FeatureCollection($features, $records->getResults());
  6001. }
  6002. public function read(string $tableName, string $id, array $params): Feature
  6003. {
  6004. $geometryColumnName = $this->getGeometryColumnName($tableName, $params);
  6005. $primaryKeyColumnName = $this->getPrimaryKeyColumnName($tableName, $params);
  6006. $record = $this->records->read($tableName, $id, $params);
  6007. return $this->convertRecordToFeature($record, $primaryKeyColumnName, $geometryColumnName);
  6008. }
  6009. }
  6010. }
  6011. // file: src/Tqdev/PhpCrudApi/GeoJson/Geometry.php
  6012. namespace Tqdev\PhpCrudApi\GeoJson {
  6013. class Geometry implements \JsonSerializable
  6014. {
  6015. private $type;
  6016. private $geometry;
  6017. public static $types = [
  6018. "Point",
  6019. "MultiPoint",
  6020. "LineString",
  6021. "MultiLineString",
  6022. "Polygon",
  6023. "MultiPolygon",
  6024. //"GeometryCollection",
  6025. ];
  6026. public function __construct(string $type, array $coordinates)
  6027. {
  6028. $this->type = $type;
  6029. $this->coordinates = $coordinates;
  6030. }
  6031. public static function fromWkt(string $wkt): Geometry
  6032. {
  6033. $bracket = strpos($wkt, '(');
  6034. $type = strtoupper(trim(substr($wkt, 0, $bracket)));
  6035. $supported = false;
  6036. foreach (Geometry::$types as $typeName) {
  6037. if (strtoupper($typeName) == $type) {
  6038. $type = $typeName;
  6039. $supported = true;
  6040. }
  6041. }
  6042. if (!$supported) {
  6043. throw new \Exception('Geometry type not supported: ' . $type);
  6044. }
  6045. $coordinates = substr($wkt, $bracket);
  6046. if (substr($type, -5) != 'Point' || ($type == 'MultiPoint' && $coordinates[1] != '(')) {
  6047. $coordinates = preg_replace('|([0-9\-\.]+ )+([0-9\-\.]+)|', '[\1\2]', $coordinates);
  6048. }
  6049. $coordinates = str_replace(['(', ')', ', ', ' '], ['[', ']', ',', ','], $coordinates);
  6050. $coordinates = json_decode($coordinates);
  6051. if (!$coordinates) {
  6052. throw new \Exception('Could not decode WKT: ' . $wkt);
  6053. }
  6054. return new Geometry($type, $coordinates);
  6055. }
  6056. public function serialize()
  6057. {
  6058. return [
  6059. 'type' => $this->type,
  6060. 'coordinates' => $this->coordinates,
  6061. ];
  6062. }
  6063. public function jsonSerialize()
  6064. {
  6065. return $this->serialize();
  6066. }
  6067. }
  6068. }
  6069. // file: src/Tqdev/PhpCrudApi/Middleware/Base/Middleware.php
  6070. namespace Tqdev\PhpCrudApi\Middleware\Base {
  6071. use Psr\Http\Server\MiddlewareInterface;
  6072. use Tqdev\PhpCrudApi\Controller\Responder;
  6073. use Tqdev\PhpCrudApi\Middleware\Router\Router;
  6074. abstract class Middleware implements MiddlewareInterface
  6075. {
  6076. protected $next;
  6077. protected $responder;
  6078. private $properties;
  6079. public function __construct(Router $router, Responder $responder, array $properties)
  6080. {
  6081. $router->load($this);
  6082. $this->responder = $responder;
  6083. $this->properties = $properties;
  6084. }
  6085. protected function getArrayProperty(string $key, string $default): array
  6086. {
  6087. return array_filter(array_map('trim', explode(',', $this->getProperty($key, $default))));
  6088. }
  6089. protected function getMapProperty(string $key, string $default): array
  6090. {
  6091. $pairs = $this->getArrayProperty($key, $default);
  6092. $result = array();
  6093. foreach ($pairs as $pair) {
  6094. if (strpos($pair, ':')) {
  6095. list($k, $v) = explode(':', $pair, 2);
  6096. $result[trim($k)] = trim($v);
  6097. } else {
  6098. $result[] = trim($pair);
  6099. }
  6100. }
  6101. return $result;
  6102. }
  6103. protected function getProperty(string $key, $default)
  6104. {
  6105. return isset($this->properties[$key]) ? $this->properties[$key] : $default;
  6106. }
  6107. }
  6108. }
  6109. // file: src/Tqdev/PhpCrudApi/Middleware/Communication/VariableStore.php
  6110. namespace Tqdev\PhpCrudApi\Middleware\Communication {
  6111. class VariableStore
  6112. {
  6113. public static $values = array();
  6114. public static function get(string $key)
  6115. {
  6116. if (isset(self::$values[$key])) {
  6117. return self::$values[$key];
  6118. }
  6119. return null;
  6120. }
  6121. public static function set(string $key, /* object */ $value)
  6122. {
  6123. self::$values[$key] = $value;
  6124. }
  6125. }
  6126. }
  6127. // file: src/Tqdev/PhpCrudApi/Middleware/Router/Router.php
  6128. namespace Tqdev\PhpCrudApi\Middleware\Router {
  6129. use Psr\Http\Message\ResponseInterface;
  6130. use Psr\Http\Message\ServerRequestInterface;
  6131. use Psr\Http\Server\RequestHandlerInterface;
  6132. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  6133. interface Router extends RequestHandlerInterface
  6134. {
  6135. public function register(string $method, string $path, array $handler);
  6136. public function load(Middleware $middleware);
  6137. public function route(ServerRequestInterface $request): ResponseInterface;
  6138. }
  6139. }
  6140. // file: src/Tqdev/PhpCrudApi/Middleware/Router/SimpleRouter.php
  6141. namespace Tqdev\PhpCrudApi\Middleware\Router {
  6142. use Psr\Http\Message\ResponseInterface;
  6143. use Psr\Http\Message\ServerRequestInterface;
  6144. use Tqdev\PhpCrudApi\Cache\Cache;
  6145. use Tqdev\PhpCrudApi\Controller\Responder;
  6146. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  6147. use Tqdev\PhpCrudApi\Record\ErrorCode;
  6148. use Tqdev\PhpCrudApi\Record\PathTree;
  6149. use Tqdev\PhpCrudApi\RequestUtils;
  6150. use Tqdev\PhpCrudApi\ResponseUtils;
  6151. class SimpleRouter implements Router
  6152. {
  6153. private $basePath;
  6154. private $responder;
  6155. private $cache;
  6156. private $ttl;
  6157. private $debug;
  6158. private $registration;
  6159. private $routes;
  6160. private $routeHandlers;
  6161. private $middlewares;
  6162. public function __construct(string $basePath, Responder $responder, Cache $cache, int $ttl, bool $debug)
  6163. {
  6164. $this->basePath = rtrim($this->detectBasePath($basePath), '/');
  6165. $this->responder = $responder;
  6166. $this->cache = $cache;
  6167. $this->ttl = $ttl;
  6168. $this->debug = $debug;
  6169. $this->registration = true;
  6170. $this->routes = $this->loadPathTree();
  6171. $this->routeHandlers = [];
  6172. $this->middlewares = array();
  6173. }
  6174. private function detectBasePath(string $basePath): string
  6175. {
  6176. if ($basePath) {
  6177. return $basePath;
  6178. }
  6179. if (isset($_SERVER['REQUEST_URI'])) {
  6180. $fullPath = urldecode(explode('?', $_SERVER['REQUEST_URI'])[0]);
  6181. if (isset($_SERVER['PATH_INFO'])) {
  6182. $path = $_SERVER['PATH_INFO'];
  6183. if (substr($fullPath, -1 * strlen($path)) == $path) {
  6184. return substr($fullPath, 0, -1 * strlen($path));
  6185. }
  6186. }
  6187. return $fullPath;
  6188. }
  6189. return '/';
  6190. }
  6191. private function loadPathTree(): PathTree
  6192. {
  6193. $data = $this->cache->get('PathTree');
  6194. if ($data != '') {
  6195. $tree = PathTree::fromJson(json_decode(gzuncompress($data)));
  6196. $this->registration = false;
  6197. } else {
  6198. $tree = new PathTree();
  6199. }
  6200. return $tree;
  6201. }
  6202. public function register(string $method, string $path, array $handler)
  6203. {
  6204. $routeNumber = count($this->routeHandlers);
  6205. $this->routeHandlers[$routeNumber] = $handler;
  6206. if ($this->registration) {
  6207. $path = trim($path, '/');
  6208. $parts = array();
  6209. if ($path) {
  6210. $parts = explode('/', $path);
  6211. }
  6212. array_unshift($parts, $method);
  6213. $this->routes->put($parts, $routeNumber);
  6214. }
  6215. }
  6216. public function load(Middleware $middleware) /*: void*/
  6217. {
  6218. array_push($this->middlewares, $middleware);
  6219. }
  6220. public function route(ServerRequestInterface $request): ResponseInterface
  6221. {
  6222. if ($this->registration) {
  6223. $data = gzcompress(json_encode($this->routes, JSON_UNESCAPED_UNICODE));
  6224. $this->cache->set('PathTree', $data, $this->ttl);
  6225. }
  6226. return $this->handle($request);
  6227. }
  6228. private function getRouteNumbers(ServerRequestInterface $request): array
  6229. {
  6230. $method = strtoupper($request->getMethod());
  6231. $path = array();
  6232. $segment = $method;
  6233. for ($i = 1; $segment; $i++) {
  6234. array_push($path, $segment);
  6235. $segment = RequestUtils::getPathSegment($request, $i);
  6236. }
  6237. return $this->routes->match($path);
  6238. }
  6239. private function removeBasePath(ServerRequestInterface $request): ServerRequestInterface
  6240. {
  6241. $path = $request->getUri()->getPath();
  6242. if (substr($path, 0, strlen($this->basePath)) == $this->basePath) {
  6243. $path = substr($path, strlen($this->basePath));
  6244. $request = $request->withUri($request->getUri()->withPath($path));
  6245. }
  6246. return $request;
  6247. }
  6248. public function getBasePath(): string
  6249. {
  6250. return $this->basePath;
  6251. }
  6252. public function handle(ServerRequestInterface $request): ResponseInterface
  6253. {
  6254. $request = $this->removeBasePath($request);
  6255. if (count($this->middlewares)) {
  6256. $handler = array_pop($this->middlewares);
  6257. return $handler->process($request, $this);
  6258. }
  6259. $routeNumbers = $this->getRouteNumbers($request);
  6260. if (count($routeNumbers) == 0) {
  6261. return $this->responder->error(ErrorCode::ROUTE_NOT_FOUND, $request->getUri()->getPath());
  6262. }
  6263. try {
  6264. $response = call_user_func($this->routeHandlers[$routeNumbers[0]], $request);
  6265. } catch (\PDOException $e) {
  6266. if (strpos(strtolower($e->getMessage()), 'duplicate') !== false) {
  6267. $response = $this->responder->error(ErrorCode::DUPLICATE_KEY_EXCEPTION, '');
  6268. } elseif (strpos(strtolower($e->getMessage()), 'unique constraint') !== false) {
  6269. $response = $this->responder->error(ErrorCode::DUPLICATE_KEY_EXCEPTION, '');
  6270. } elseif (strpos(strtolower($e->getMessage()), 'default value') !== false) {
  6271. $response = $this->responder->error(ErrorCode::DATA_INTEGRITY_VIOLATION, '');
  6272. } elseif (strpos(strtolower($e->getMessage()), 'allow nulls') !== false) {
  6273. $response = $this->responder->error(ErrorCode::DATA_INTEGRITY_VIOLATION, '');
  6274. } elseif (strpos(strtolower($e->getMessage()), 'constraint') !== false) {
  6275. $response = $this->responder->error(ErrorCode::DATA_INTEGRITY_VIOLATION, '');
  6276. } else {
  6277. $response = $this->responder->error(ErrorCode::ERROR_NOT_FOUND, '');
  6278. }
  6279. if ($this->debug) {
  6280. $response = ResponseUtils::addExceptionHeaders($response, $e);
  6281. }
  6282. }
  6283. return $response;
  6284. }
  6285. }
  6286. }
  6287. // file: src/Tqdev/PhpCrudApi/Middleware/AjaxOnlyMiddleware.php
  6288. namespace Tqdev\PhpCrudApi\Middleware {
  6289. use Psr\Http\Message\ResponseInterface;
  6290. use Psr\Http\Message\ServerRequestInterface;
  6291. use Psr\Http\Server\RequestHandlerInterface;
  6292. use Tqdev\PhpCrudApi\Controller\Responder;
  6293. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  6294. use Tqdev\PhpCrudApi\Record\ErrorCode;
  6295. use Tqdev\PhpCrudApi\RequestUtils;
  6296. class AjaxOnlyMiddleware extends Middleware
  6297. {
  6298. public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
  6299. {
  6300. $method = $request->getMethod();
  6301. $excludeMethods = $this->getArrayProperty('excludeMethods', 'OPTIONS,GET');
  6302. if (!in_array($method, $excludeMethods)) {
  6303. $headerName = $this->getProperty('headerName', 'X-Requested-With');
  6304. $headerValue = $this->getProperty('headerValue', 'XMLHttpRequest');
  6305. if ($headerValue != RequestUtils::getHeader($request, $headerName)) {
  6306. return $this->responder->error(ErrorCode::ONLY_AJAX_REQUESTS_ALLOWED, $method);
  6307. }
  6308. }
  6309. return $next->handle($request);
  6310. }
  6311. }
  6312. }
  6313. // file: src/Tqdev/PhpCrudApi/Middleware/AuthorizationMiddleware.php
  6314. namespace Tqdev\PhpCrudApi\Middleware {
  6315. use Psr\Http\Message\ResponseInterface;
  6316. use Psr\Http\Message\ServerRequestInterface;
  6317. use Psr\Http\Server\RequestHandlerInterface;
  6318. use Tqdev\PhpCrudApi\Column\ReflectionService;
  6319. use Tqdev\PhpCrudApi\Controller\Responder;
  6320. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  6321. use Tqdev\PhpCrudApi\Middleware\Communication\VariableStore;
  6322. use Tqdev\PhpCrudApi\Middleware\Router\Router;
  6323. use Tqdev\PhpCrudApi\Record\FilterInfo;
  6324. use Tqdev\PhpCrudApi\RequestUtils;
  6325. class AuthorizationMiddleware extends Middleware
  6326. {
  6327. private $reflection;
  6328. public function __construct(Router $router, Responder $responder, array $properties, ReflectionService $reflection)
  6329. {
  6330. parent::__construct($router, $responder, $properties);
  6331. $this->reflection = $reflection;
  6332. }
  6333. private function handleColumns(string $operation, string $tableName) /*: void*/
  6334. {
  6335. $columnHandler = $this->getProperty('columnHandler', '');
  6336. if ($columnHandler) {
  6337. $table = $this->reflection->getTable($tableName);
  6338. foreach ($table->getColumnNames() as $columnName) {
  6339. $allowed = call_user_func($columnHandler, $operation, $tableName, $columnName);
  6340. if (!$allowed) {
  6341. $table->removeColumn($columnName);
  6342. }
  6343. }
  6344. }
  6345. }
  6346. private function handleTable(string $operation, string $tableName) /*: void*/
  6347. {
  6348. if (!$this->reflection->hasTable($tableName)) {
  6349. return;
  6350. }
  6351. $allowed = true;
  6352. $tableHandler = $this->getProperty('tableHandler', '');
  6353. if ($tableHandler) {
  6354. $allowed = call_user_func($tableHandler, $operation, $tableName);
  6355. }
  6356. if (!$allowed) {
  6357. $this->reflection->removeTable($tableName);
  6358. } else {
  6359. $this->handleColumns($operation, $tableName);
  6360. }
  6361. }
  6362. private function handleRecords(string $operation, string $tableName) /*: void*/
  6363. {
  6364. if (!$this->reflection->hasTable($tableName)) {
  6365. return;
  6366. }
  6367. $recordHandler = $this->getProperty('recordHandler', '');
  6368. if ($recordHandler) {
  6369. $query = call_user_func($recordHandler, $operation, $tableName);
  6370. $filters = new FilterInfo();
  6371. $table = $this->reflection->getTable($tableName);
  6372. $query = str_replace('][]=', ']=', str_replace('=', '[]=', $query));
  6373. parse_str($query, $params);
  6374. $condition = $filters->getCombinedConditions($table, $params);
  6375. VariableStore::set("authorization.conditions.$tableName", $condition);
  6376. }
  6377. }
  6378. public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
  6379. {
  6380. $path = RequestUtils::getPathSegment($request, 1);
  6381. $operation = RequestUtils::getOperation($request);
  6382. $tableNames = RequestUtils::getTableNames($request, $this->reflection);
  6383. foreach ($tableNames as $tableName) {
  6384. $this->handleTable($operation, $tableName);
  6385. if ($path == 'records') {
  6386. $this->handleRecords($operation, $tableName);
  6387. }
  6388. }
  6389. if ($path == 'openapi') {
  6390. VariableStore::set('authorization.tableHandler', $this->getProperty('tableHandler', ''));
  6391. VariableStore::set('authorization.columnHandler', $this->getProperty('columnHandler', ''));
  6392. }
  6393. return $next->handle($request);
  6394. }
  6395. }
  6396. }
  6397. // file: src/Tqdev/PhpCrudApi/Middleware/BasicAuthMiddleware.php
  6398. namespace Tqdev\PhpCrudApi\Middleware {
  6399. use Psr\Http\Message\ResponseInterface;
  6400. use Psr\Http\Message\ServerRequestInterface;
  6401. use Psr\Http\Server\RequestHandlerInterface;
  6402. use Tqdev\PhpCrudApi\Controller\Responder;
  6403. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  6404. use Tqdev\PhpCrudApi\Record\ErrorCode;
  6405. use Tqdev\PhpCrudApi\RequestUtils;
  6406. class BasicAuthMiddleware extends Middleware
  6407. {
  6408. private function hasCorrectPassword(string $username, string $password, array &$passwords): bool
  6409. {
  6410. $hash = isset($passwords[$username]) ? $passwords[$username] : false;
  6411. if ($hash && password_verify($password, $hash)) {
  6412. if (password_needs_rehash($hash, PASSWORD_DEFAULT)) {
  6413. $passwords[$username] = password_hash($password, PASSWORD_DEFAULT);
  6414. }
  6415. return true;
  6416. }
  6417. return false;
  6418. }
  6419. private function getValidUsername(string $username, string $password, string $passwordFile): string
  6420. {
  6421. $passwords = $this->readPasswords($passwordFile);
  6422. $valid = $this->hasCorrectPassword($username, $password, $passwords);
  6423. $this->writePasswords($passwordFile, $passwords);
  6424. return $valid ? $username : '';
  6425. }
  6426. private function readPasswords(string $passwordFile): array
  6427. {
  6428. $passwords = [];
  6429. $passwordLines = file($passwordFile);
  6430. foreach ($passwordLines as $passwordLine) {
  6431. if (strpos($passwordLine, ':') !== false) {
  6432. list($username, $hash) = explode(':', trim($passwordLine), 2);
  6433. if (strlen($hash) > 0 && $hash[0] != '$') {
  6434. $hash = password_hash($hash, PASSWORD_DEFAULT);
  6435. }
  6436. $passwords[$username] = $hash;
  6437. }
  6438. }
  6439. return $passwords;
  6440. }
  6441. private function writePasswords(string $passwordFile, array $passwords): bool
  6442. {
  6443. $success = false;
  6444. $passwordFileContents = '';
  6445. foreach ($passwords as $username => $hash) {
  6446. $passwordFileContents .= "$username:$hash\n";
  6447. }
  6448. if (file_get_contents($passwordFile) != $passwordFileContents) {
  6449. $success = file_put_contents($passwordFile, $passwordFileContents) !== false;
  6450. }
  6451. return $success;
  6452. }
  6453. private function getAuthorizationCredentials(ServerRequestInterface $request): string
  6454. {
  6455. if (isset($_SERVER['PHP_AUTH_USER'])) {
  6456. return $_SERVER['PHP_AUTH_USER'] . ':' . $_SERVER['PHP_AUTH_PW'];
  6457. }
  6458. $header = RequestUtils::getHeader($request, 'Authorization');
  6459. $parts = explode(' ', trim($header), 2);
  6460. if (count($parts) != 2) {
  6461. return '';
  6462. }
  6463. if ($parts[0] != 'Basic') {
  6464. return '';
  6465. }
  6466. return base64_decode(strtr($parts[1], '-_', '+/'));
  6467. }
  6468. public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
  6469. {
  6470. if (session_status() == PHP_SESSION_NONE) {
  6471. if (!headers_sent()) {
  6472. $sessionName = $this->getProperty('sessionName', '');
  6473. if ($sessionName) {
  6474. session_name($sessionName);
  6475. }
  6476. session_start();
  6477. }
  6478. }
  6479. $credentials = $this->getAuthorizationCredentials($request);
  6480. if ($credentials) {
  6481. list($username, $password) = array('', '');
  6482. if (strpos($credentials, ':') !== false) {
  6483. list($username, $password) = explode(':', $credentials, 2);
  6484. }
  6485. $passwordFile = $this->getProperty('passwordFile', '.htpasswd');
  6486. $validUser = $this->getValidUsername($username, $password, $passwordFile);
  6487. $_SESSION['username'] = $validUser;
  6488. if (!$validUser) {
  6489. return $this->responder->error(ErrorCode::AUTHENTICATION_FAILED, $username);
  6490. }
  6491. if (!headers_sent()) {
  6492. session_regenerate_id();
  6493. }
  6494. }
  6495. if (!isset($_SESSION['username']) || !$_SESSION['username']) {
  6496. $authenticationMode = $this->getProperty('mode', 'required');
  6497. if ($authenticationMode == 'required') {
  6498. $response = $this->responder->error(ErrorCode::AUTHENTICATION_REQUIRED, '');
  6499. $realm = $this->getProperty('realm', 'Username and password required');
  6500. $response = $response->withHeader('WWW-Authenticate', "Basic realm=\"$realm\"");
  6501. return $response;
  6502. }
  6503. }
  6504. return $next->handle($request);
  6505. }
  6506. }
  6507. }
  6508. // file: src/Tqdev/PhpCrudApi/Middleware/CorsMiddleware.php
  6509. namespace Tqdev\PhpCrudApi\Middleware {
  6510. use Psr\Http\Message\ResponseInterface;
  6511. use Psr\Http\Message\ServerRequestInterface;
  6512. use Psr\Http\Server\RequestHandlerInterface;
  6513. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  6514. use Tqdev\PhpCrudApi\Record\ErrorCode;
  6515. use Tqdev\PhpCrudApi\ResponseFactory;
  6516. class CorsMiddleware extends Middleware
  6517. {
  6518. private function isOriginAllowed(string $origin, string $allowedOrigins): bool
  6519. {
  6520. $found = false;
  6521. foreach (explode(',', $allowedOrigins) as $allowedOrigin) {
  6522. $hostname = preg_quote(strtolower(trim($allowedOrigin)));
  6523. $regex = '/^' . str_replace('\*', '.*', $hostname) . '$/';
  6524. if (preg_match($regex, $origin)) {
  6525. $found = true;
  6526. break;
  6527. }
  6528. }
  6529. return $found;
  6530. }
  6531. public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
  6532. {
  6533. $method = $request->getMethod();
  6534. $origin = count($request->getHeader('Origin')) ? $request->getHeader('Origin')[0] : '';
  6535. $allowedOrigins = $this->getProperty('allowedOrigins', '*');
  6536. if ($origin && !$this->isOriginAllowed($origin, $allowedOrigins)) {
  6537. $response = $this->responder->error(ErrorCode::ORIGIN_FORBIDDEN, $origin);
  6538. } elseif ($method == 'OPTIONS') {
  6539. $response = ResponseFactory::fromStatus(ResponseFactory::OK);
  6540. $allowHeaders = $this->getProperty('allowHeaders', 'Content-Type, X-XSRF-TOKEN, X-Authorization');
  6541. if ($allowHeaders) {
  6542. $response = $response->withHeader('Access-Control-Allow-Headers', $allowHeaders);
  6543. }
  6544. $allowMethods = $this->getProperty('allowMethods', 'OPTIONS, GET, PUT, POST, DELETE, PATCH');
  6545. if ($allowMethods) {
  6546. $response = $response->withHeader('Access-Control-Allow-Methods', $allowMethods);
  6547. }
  6548. $allowCredentials = $this->getProperty('allowCredentials', 'true');
  6549. if ($allowCredentials) {
  6550. $response = $response->withHeader('Access-Control-Allow-Credentials', $allowCredentials);
  6551. }
  6552. $maxAge = $this->getProperty('maxAge', '1728000');
  6553. if ($maxAge) {
  6554. $response = $response->withHeader('Access-Control-Max-Age', $maxAge);
  6555. }
  6556. $exposeHeaders = $this->getProperty('exposeHeaders', '');
  6557. if ($exposeHeaders) {
  6558. $response = $response->withHeader('Access-Control-Expose-Headers', $exposeHeaders);
  6559. }
  6560. } else {
  6561. $response = $next->handle($request);
  6562. }
  6563. if ($origin) {
  6564. $allowCredentials = $this->getProperty('allowCredentials', 'true');
  6565. if ($allowCredentials) {
  6566. $response = $response->withHeader('Access-Control-Allow-Credentials', $allowCredentials);
  6567. }
  6568. $response = $response->withHeader('Access-Control-Allow-Origin', $origin);
  6569. }
  6570. return $response;
  6571. }
  6572. }
  6573. }
  6574. // file: src/Tqdev/PhpCrudApi/Middleware/CustomizationMiddleware.php
  6575. namespace Tqdev\PhpCrudApi\Middleware {
  6576. use Psr\Http\Message\ResponseInterface;
  6577. use Psr\Http\Message\ServerRequestInterface;
  6578. use Psr\Http\Server\RequestHandlerInterface;
  6579. use Tqdev\PhpCrudApi\Column\ReflectionService;
  6580. use Tqdev\PhpCrudApi\Controller\Responder;
  6581. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  6582. use Tqdev\PhpCrudApi\Middleware\Router\Router;
  6583. use Tqdev\PhpCrudApi\RequestUtils;
  6584. class CustomizationMiddleware extends Middleware
  6585. {
  6586. private $reflection;
  6587. public function __construct(Router $router, Responder $responder, array $properties, ReflectionService $reflection)
  6588. {
  6589. parent::__construct($router, $responder, $properties);
  6590. $this->reflection = $reflection;
  6591. }
  6592. public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
  6593. {
  6594. $operation = RequestUtils::getOperation($request);
  6595. $tableName = RequestUtils::getPathSegment($request, 2);
  6596. $beforeHandler = $this->getProperty('beforeHandler', '');
  6597. $environment = (object) array();
  6598. if ($beforeHandler !== '') {
  6599. $result = call_user_func($beforeHandler, $operation, $tableName, $request, $environment);
  6600. $request = $result ?: $request;
  6601. }
  6602. $response = $next->handle($request);
  6603. $afterHandler = $this->getProperty('afterHandler', '');
  6604. if ($afterHandler !== '') {
  6605. $result = call_user_func($afterHandler, $operation, $tableName, $response, $environment);
  6606. $response = $result ?: $response;
  6607. }
  6608. return $response;
  6609. }
  6610. }
  6611. }
  6612. // file: src/Tqdev/PhpCrudApi/Middleware/DbAuthMiddleware.php
  6613. namespace Tqdev\PhpCrudApi\Middleware {
  6614. use Psr\Http\Message\ResponseInterface;
  6615. use Psr\Http\Message\ServerRequestInterface;
  6616. use Psr\Http\Server\RequestHandlerInterface;
  6617. use Tqdev\PhpCrudApi\Column\ReflectionService;
  6618. use Tqdev\PhpCrudApi\Controller\Responder;
  6619. use Tqdev\PhpCrudApi\Database\GenericDB;
  6620. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  6621. use Tqdev\PhpCrudApi\Middleware\Router\Router;
  6622. use Tqdev\PhpCrudApi\Record\Condition\ColumnCondition;
  6623. use Tqdev\PhpCrudApi\Record\ErrorCode;
  6624. use Tqdev\PhpCrudApi\Record\OrderingInfo;
  6625. use Tqdev\PhpCrudApi\RequestUtils;
  6626. class DbAuthMiddleware extends Middleware
  6627. {
  6628. private $reflection;
  6629. private $db;
  6630. private $ordering;
  6631. public function __construct(Router $router, Responder $responder, array $properties, ReflectionService $reflection, GenericDB $db)
  6632. {
  6633. parent::__construct($router, $responder, $properties);
  6634. $this->reflection = $reflection;
  6635. $this->db = $db;
  6636. $this->ordering = new OrderingInfo();
  6637. }
  6638. public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
  6639. {
  6640. if (session_status() == PHP_SESSION_NONE) {
  6641. if (!headers_sent()) {
  6642. $sessionName = $this->getProperty('sessionName', '');
  6643. if ($sessionName) {
  6644. session_name($sessionName);
  6645. }
  6646. session_start();
  6647. }
  6648. }
  6649. $path = RequestUtils::getPathSegment($request, 1);
  6650. $method = $request->getMethod();
  6651. if ($method == 'POST' && $path == 'login') {
  6652. $body = $request->getParsedBody();
  6653. $username = isset($body->username) ? $body->username : '';
  6654. $password = isset($body->password) ? $body->password : '';
  6655. $tableName = $this->getProperty('usersTable', 'users');
  6656. $table = $this->reflection->getTable($tableName);
  6657. $usernameColumnName = $this->getProperty('usernameColumn', 'username');
  6658. $usernameColumn = $table->getColumn($usernameColumnName);
  6659. $passwordColumnName = $this->getProperty('passwordColumn', 'password');
  6660. $passwordColumn = $table->getColumn($passwordColumnName);
  6661. $condition = new ColumnCondition($usernameColumn, 'eq', $username);
  6662. $returnedColumns = $this->getProperty('returnedColumns', '');
  6663. if (!$returnedColumns) {
  6664. $columnNames = $table->getColumnNames();
  6665. } else {
  6666. $columnNames = array_map('trim', explode(',', $returnedColumns));
  6667. $columnNames[] = $passwordColumnName;
  6668. }
  6669. $columnOrdering = $this->ordering->getDefaultColumnOrdering($table);
  6670. $users = $this->db->selectAll($table, $columnNames, $condition, $columnOrdering, 0, 1);
  6671. foreach ($users as $user) {
  6672. if (password_verify($password, $user[$passwordColumnName]) == 1) {
  6673. if (!headers_sent()) {
  6674. session_regenerate_id(true);
  6675. }
  6676. unset($user[$passwordColumnName]);
  6677. $_SESSION['user'] = $user;
  6678. return $this->responder->success($user);
  6679. }
  6680. }
  6681. return $this->responder->error(ErrorCode::AUTHENTICATION_FAILED, $username);
  6682. }
  6683. if ($method == 'POST' && $path == 'logout') {
  6684. if (isset($_SESSION['user'])) {
  6685. $user = $_SESSION['user'];
  6686. unset($_SESSION['user']);
  6687. if (session_status() != PHP_SESSION_NONE) {
  6688. session_destroy();
  6689. }
  6690. return $this->responder->success($user);
  6691. }
  6692. return $this->responder->error(ErrorCode::AUTHENTICATION_REQUIRED, '');
  6693. }
  6694. if (!isset($_SESSION['user']) || !$_SESSION['user']) {
  6695. $authenticationMode = $this->getProperty('mode', 'required');
  6696. if ($authenticationMode == 'required') {
  6697. return $this->responder->error(ErrorCode::AUTHENTICATION_REQUIRED, '');
  6698. }
  6699. }
  6700. return $next->handle($request);
  6701. }
  6702. }
  6703. }
  6704. // file: src/Tqdev/PhpCrudApi/Middleware/FirewallMiddleware.php
  6705. namespace Tqdev\PhpCrudApi\Middleware {
  6706. use Psr\Http\Message\ResponseInterface;
  6707. use Psr\Http\Message\ServerRequestInterface;
  6708. use Psr\Http\Server\RequestHandlerInterface;
  6709. use Tqdev\PhpCrudApi\Controller\Responder;
  6710. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  6711. use Tqdev\PhpCrudApi\Record\ErrorCode;
  6712. class FirewallMiddleware extends Middleware
  6713. {
  6714. private function ipMatch(string $ip, string $cidr): bool
  6715. {
  6716. if (strpos($cidr, '/') !== false) {
  6717. list($subnet, $mask) = explode('/', trim($cidr));
  6718. if ((ip2long($ip) & ~((1 << (32 - $mask)) - 1)) == ip2long($subnet)) {
  6719. return true;
  6720. }
  6721. } else {
  6722. if (ip2long($ip) == ip2long($cidr)) {
  6723. return true;
  6724. }
  6725. }
  6726. return false;
  6727. }
  6728. private function isIpAllowed(string $ipAddress, string $allowedIpAddresses): bool
  6729. {
  6730. foreach (explode(',', $allowedIpAddresses) as $allowedIp) {
  6731. if ($this->ipMatch($ipAddress, $allowedIp)) {
  6732. return true;
  6733. }
  6734. }
  6735. return false;
  6736. }
  6737. public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
  6738. {
  6739. $reverseProxy = $this->getProperty('reverseProxy', '');
  6740. if ($reverseProxy) {
  6741. $ipAddress = array_pop(explode(',', $request->getHeader('X-Forwarded-For')));
  6742. } elseif (isset($_SERVER['REMOTE_ADDR'])) {
  6743. $ipAddress = $_SERVER['REMOTE_ADDR'];
  6744. } else {
  6745. $ipAddress = '127.0.0.1';
  6746. }
  6747. $allowedIpAddresses = $this->getProperty('allowedIpAddresses', '');
  6748. if (!$this->isIpAllowed($ipAddress, $allowedIpAddresses)) {
  6749. $response = $this->responder->error(ErrorCode::TEMPORARY_OR_PERMANENTLY_BLOCKED, '');
  6750. } else {
  6751. $response = $next->handle($request);
  6752. }
  6753. return $response;
  6754. }
  6755. }
  6756. }
  6757. // file: src/Tqdev/PhpCrudApi/Middleware/IpAddressMiddleware.php
  6758. namespace Tqdev\PhpCrudApi\Middleware {
  6759. use Psr\Http\Message\ResponseInterface;
  6760. use Psr\Http\Message\ServerRequestInterface;
  6761. use Psr\Http\Server\RequestHandlerInterface;
  6762. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedTable;
  6763. use Tqdev\PhpCrudApi\Column\ReflectionService;
  6764. use Tqdev\PhpCrudApi\Controller\Responder;
  6765. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  6766. use Tqdev\PhpCrudApi\Middleware\Router\Router;
  6767. use Tqdev\PhpCrudApi\RequestUtils;
  6768. class IpAddressMiddleware extends Middleware
  6769. {
  6770. private $reflection;
  6771. public function __construct(Router $router, Responder $responder, array $properties, ReflectionService $reflection)
  6772. {
  6773. parent::__construct($router, $responder, $properties);
  6774. $this->reflection = $reflection;
  6775. }
  6776. private function callHandler($record, string $operation, ReflectedTable $table) /*: object */
  6777. {
  6778. $context = (array) $record;
  6779. $columnNames = $this->getProperty('columns', '');
  6780. if ($columnNames) {
  6781. foreach (explode(',', $columnNames) as $columnName) {
  6782. if ($table->hasColumn($columnName)) {
  6783. if ($operation == 'create') {
  6784. $context[$columnName] = $_SERVER['REMOTE_ADDR'];
  6785. } else {
  6786. unset($context[$columnName]);
  6787. }
  6788. }
  6789. }
  6790. }
  6791. return (object) $context;
  6792. }
  6793. public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
  6794. {
  6795. $operation = RequestUtils::getOperation($request);
  6796. if (in_array($operation, ['create', 'update', 'increment'])) {
  6797. $tableNames = $this->getProperty('tables', '');
  6798. $tableName = RequestUtils::getPathSegment($request, 2);
  6799. if (!$tableNames || in_array($tableName, explode(',', $tableNames))) {
  6800. if ($this->reflection->hasTable($tableName)) {
  6801. $record = $request->getParsedBody();
  6802. if ($record !== null) {
  6803. $table = $this->reflection->getTable($tableName);
  6804. if (is_array($record)) {
  6805. foreach ($record as &$r) {
  6806. $r = $this->callHandler($r, $operation, $table);
  6807. }
  6808. } else {
  6809. $record = $this->callHandler($record, $operation, $table);
  6810. }
  6811. $request = $request->withParsedBody($record);
  6812. }
  6813. }
  6814. }
  6815. }
  6816. return $next->handle($request);
  6817. }
  6818. }
  6819. }
  6820. // file: src/Tqdev/PhpCrudApi/Middleware/JoinLimitsMiddleware.php
  6821. namespace Tqdev\PhpCrudApi\Middleware {
  6822. use Psr\Http\Message\ResponseInterface;
  6823. use Psr\Http\Message\ServerRequestInterface;
  6824. use Psr\Http\Server\RequestHandlerInterface;
  6825. use Tqdev\PhpCrudApi\Column\ReflectionService;
  6826. use Tqdev\PhpCrudApi\Controller\Responder;
  6827. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  6828. use Tqdev\PhpCrudApi\Middleware\Communication\VariableStore;
  6829. use Tqdev\PhpCrudApi\Middleware\Router\Router;
  6830. use Tqdev\PhpCrudApi\RequestUtils;
  6831. class JoinLimitsMiddleware extends Middleware
  6832. {
  6833. private $reflection;
  6834. public function __construct(Router $router, Responder $responder, array $properties, ReflectionService $reflection)
  6835. {
  6836. parent::__construct($router, $responder, $properties);
  6837. $this->reflection = $reflection;
  6838. }
  6839. public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
  6840. {
  6841. $operation = RequestUtils::getOperation($request);
  6842. $params = RequestUtils::getParams($request);
  6843. if (in_array($operation, ['read', 'list']) && isset($params['join'])) {
  6844. $maxDepth = (int) $this->getProperty('depth', '3');
  6845. $maxTables = (int) $this->getProperty('tables', '10');
  6846. $maxRecords = (int) $this->getProperty('records', '1000');
  6847. $tableCount = 0;
  6848. $joinPaths = array();
  6849. for ($i = 0; $i < count($params['join']); $i++) {
  6850. $joinPath = array();
  6851. $tables = explode(',', $params['join'][$i]);
  6852. for ($depth = 0; $depth < min($maxDepth, count($tables)); $depth++) {
  6853. array_push($joinPath, $tables[$depth]);
  6854. $tableCount += 1;
  6855. if ($tableCount == $maxTables) {
  6856. break;
  6857. }
  6858. }
  6859. array_push($joinPaths, implode(',', $joinPath));
  6860. if ($tableCount == $maxTables) {
  6861. break;
  6862. }
  6863. }
  6864. $params['join'] = $joinPaths;
  6865. $request = RequestUtils::setParams($request, $params);
  6866. VariableStore::set("joinLimits.maxRecords", $maxRecords);
  6867. }
  6868. return $next->handle($request);
  6869. }
  6870. }
  6871. }
  6872. // file: src/Tqdev/PhpCrudApi/Middleware/JwtAuthMiddleware.php
  6873. namespace Tqdev\PhpCrudApi\Middleware {
  6874. use Psr\Http\Message\ResponseInterface;
  6875. use Psr\Http\Message\ServerRequestInterface;
  6876. use Psr\Http\Server\RequestHandlerInterface;
  6877. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  6878. use Tqdev\PhpCrudApi\Record\ErrorCode;
  6879. use Tqdev\PhpCrudApi\RequestUtils;
  6880. class JwtAuthMiddleware extends Middleware
  6881. {
  6882. private function getVerifiedClaims(string $token, int $time, int $leeway, int $ttl, array $secrets, array $requirements): array
  6883. {
  6884. $algorithms = array(
  6885. 'HS256' => 'sha256',
  6886. 'HS384' => 'sha384',
  6887. 'HS512' => 'sha512',
  6888. 'RS256' => 'sha256',
  6889. 'RS384' => 'sha384',
  6890. 'RS512' => 'sha512',
  6891. );
  6892. $token = explode('.', $token);
  6893. if (count($token) < 3) {
  6894. return array();
  6895. }
  6896. $header = json_decode(base64_decode(strtr($token[0], '-_', '+/')), true);
  6897. $kid = 0;
  6898. if (isset($header['kid'])) {
  6899. $kid = $header['kid'];
  6900. }
  6901. if (!isset($secrets[$kid])) {
  6902. return array();
  6903. }
  6904. $secret = $secrets[$kid];
  6905. if ($header['typ'] != 'JWT') {
  6906. return array();
  6907. }
  6908. $algorithm = $header['alg'];
  6909. if (!isset($algorithms[$algorithm])) {
  6910. return array();
  6911. }
  6912. if (!empty($requirements['alg']) && !in_array($algorithm, $requirements['alg'])) {
  6913. return array();
  6914. }
  6915. $hmac = $algorithms[$algorithm];
  6916. $signature = base64_decode(strtr($token[2], '-_', '+/'));
  6917. $data = "$token[0].$token[1]";
  6918. switch ($algorithm[0]) {
  6919. case 'H':
  6920. $hash = hash_hmac($hmac, $data, $secret, true);
  6921. $equals = hash_equals($hash, $signature);
  6922. if (!$equals) {
  6923. return array();
  6924. }
  6925. break;
  6926. case 'R':
  6927. $equals = openssl_verify($data, $signature, $secret, $hmac) == 1;
  6928. if (!$equals) {
  6929. return array();
  6930. }
  6931. break;
  6932. }
  6933. $claims = json_decode(base64_decode(strtr($token[1], '-_', '+/')), true);
  6934. if (!$claims) {
  6935. return array();
  6936. }
  6937. foreach ($requirements as $field => $values) {
  6938. if (!empty($values)) {
  6939. if ($field != 'alg') {
  6940. if (!isset($claims[$field]) || !in_array($claims[$field], $values)) {
  6941. return array();
  6942. }
  6943. }
  6944. }
  6945. }
  6946. if (isset($claims['nbf']) && $time + $leeway < $claims['nbf']) {
  6947. return array();
  6948. }
  6949. if (isset($claims['iat']) && $time + $leeway < $claims['iat']) {
  6950. return array();
  6951. }
  6952. if (isset($claims['exp']) && $time - $leeway > $claims['exp']) {
  6953. return array();
  6954. }
  6955. if (isset($claims['iat']) && !isset($claims['exp'])) {
  6956. if ($time - $leeway > $claims['iat'] + $ttl) {
  6957. return array();
  6958. }
  6959. }
  6960. return $claims;
  6961. }
  6962. private function getClaims(string $token): array
  6963. {
  6964. $time = (int) $this->getProperty('time', time());
  6965. $leeway = (int) $this->getProperty('leeway', '5');
  6966. $ttl = (int) $this->getProperty('ttl', '30');
  6967. $secrets = $this->getMapProperty('secrets', '');
  6968. if (!$secrets) {
  6969. $secrets = [$this->getProperty('secret', '')];
  6970. }
  6971. $requirements = array(
  6972. 'alg' => $this->getArrayProperty('algorithms', ''),
  6973. 'aud' => $this->getArrayProperty('audiences', ''),
  6974. 'iss' => $this->getArrayProperty('issuers', ''),
  6975. );
  6976. return $this->getVerifiedClaims($token, $time, $leeway, $ttl, $secrets, $requirements);
  6977. }
  6978. private function getAuthorizationToken(ServerRequestInterface $request): string
  6979. {
  6980. $headerName = $this->getProperty('header', 'X-Authorization');
  6981. $headerValue = RequestUtils::getHeader($request, $headerName);
  6982. $parts = explode(' ', trim($headerValue), 2);
  6983. if (count($parts) != 2) {
  6984. return '';
  6985. }
  6986. if ($parts[0] != 'Bearer') {
  6987. return '';
  6988. }
  6989. return $parts[1];
  6990. }
  6991. public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
  6992. {
  6993. if (session_status() == PHP_SESSION_NONE) {
  6994. if (!headers_sent()) {
  6995. $sessionName = $this->getProperty('sessionName', '');
  6996. if ($sessionName) {
  6997. session_name($sessionName);
  6998. }
  6999. session_start();
  7000. }
  7001. }
  7002. $token = $this->getAuthorizationToken($request);
  7003. if ($token) {
  7004. $claims = $this->getClaims($token);
  7005. $_SESSION['claims'] = $claims;
  7006. if (empty($claims)) {
  7007. return $this->responder->error(ErrorCode::AUTHENTICATION_FAILED, 'JWT');
  7008. }
  7009. if (!headers_sent()) {
  7010. session_regenerate_id();
  7011. }
  7012. }
  7013. if (empty($_SESSION['claims'])) {
  7014. $authenticationMode = $this->getProperty('mode', 'required');
  7015. if ($authenticationMode == 'required') {
  7016. return $this->responder->error(ErrorCode::AUTHENTICATION_REQUIRED, '');
  7017. }
  7018. }
  7019. return $next->handle($request);
  7020. }
  7021. }
  7022. }
  7023. // file: src/Tqdev/PhpCrudApi/Middleware/MultiTenancyMiddleware.php
  7024. namespace Tqdev\PhpCrudApi\Middleware {
  7025. use Psr\Http\Message\ResponseInterface;
  7026. use Psr\Http\Message\ServerRequestInterface;
  7027. use Psr\Http\Server\RequestHandlerInterface;
  7028. use Tqdev\PhpCrudApi\Column\ReflectionService;
  7029. use Tqdev\PhpCrudApi\Controller\Responder;
  7030. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  7031. use Tqdev\PhpCrudApi\Middleware\Communication\VariableStore;
  7032. use Tqdev\PhpCrudApi\Middleware\Router\Router;
  7033. use Tqdev\PhpCrudApi\Record\Condition\ColumnCondition;
  7034. use Tqdev\PhpCrudApi\Record\Condition\Condition;
  7035. use Tqdev\PhpCrudApi\Record\Condition\NoCondition;
  7036. use Tqdev\PhpCrudApi\RequestUtils;
  7037. class MultiTenancyMiddleware extends Middleware
  7038. {
  7039. private $reflection;
  7040. public function __construct(Router $router, Responder $responder, array $properties, ReflectionService $reflection)
  7041. {
  7042. parent::__construct($router, $responder, $properties);
  7043. $this->reflection = $reflection;
  7044. }
  7045. private function getCondition(string $tableName, array $pairs): Condition
  7046. {
  7047. $condition = new NoCondition();
  7048. $table = $this->reflection->getTable($tableName);
  7049. foreach ($pairs as $k => $v) {
  7050. $condition = $condition->_and(new ColumnCondition($table->getColumn($k), 'eq', $v));
  7051. }
  7052. return $condition;
  7053. }
  7054. private function getPairs($handler, string $operation, string $tableName): array
  7055. {
  7056. $result = array();
  7057. $pairs = call_user_func($handler, $operation, $tableName);
  7058. $table = $this->reflection->getTable($tableName);
  7059. foreach ($pairs as $k => $v) {
  7060. if ($table->hasColumn($k)) {
  7061. $result[$k] = $v;
  7062. }
  7063. }
  7064. return $result;
  7065. }
  7066. private function handleRecord(ServerRequestInterface $request, string $operation, array $pairs): ServerRequestInterface
  7067. {
  7068. $record = $request->getParsedBody();
  7069. if ($record === null) {
  7070. return $request;
  7071. }
  7072. $multi = is_array($record);
  7073. $records = $multi ? $record : [$record];
  7074. foreach ($records as &$record) {
  7075. foreach ($pairs as $column => $value) {
  7076. if ($operation == 'create') {
  7077. $record->$column = $value;
  7078. } else {
  7079. if (isset($record->$column)) {
  7080. unset($record->$column);
  7081. }
  7082. }
  7083. }
  7084. }
  7085. return $request->withParsedBody($multi ? $records : $records[0]);
  7086. }
  7087. public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
  7088. {
  7089. $handler = $this->getProperty('handler', '');
  7090. if ($handler !== '') {
  7091. $path = RequestUtils::getPathSegment($request, 1);
  7092. if ($path == 'records') {
  7093. $operation = RequestUtils::getOperation($request);
  7094. $tableNames = RequestUtils::getTableNames($request, $this->reflection);
  7095. foreach ($tableNames as $i => $tableName) {
  7096. if (!$this->reflection->hasTable($tableName)) {
  7097. continue;
  7098. }
  7099. $pairs = $this->getPairs($handler, $operation, $tableName);
  7100. if ($i == 0) {
  7101. if (in_array($operation, ['create', 'update', 'increment'])) {
  7102. $request = $this->handleRecord($request, $operation, $pairs);
  7103. }
  7104. }
  7105. $condition = $this->getCondition($tableName, $pairs);
  7106. VariableStore::set("multiTenancy.conditions.$tableName", $condition);
  7107. }
  7108. }
  7109. }
  7110. return $next->handle($request);
  7111. }
  7112. }
  7113. }
  7114. // file: src/Tqdev/PhpCrudApi/Middleware/PageLimitsMiddleware.php
  7115. namespace Tqdev\PhpCrudApi\Middleware {
  7116. use Psr\Http\Message\ResponseInterface;
  7117. use Psr\Http\Message\ServerRequestInterface;
  7118. use Psr\Http\Server\RequestHandlerInterface;
  7119. use Tqdev\PhpCrudApi\Column\ReflectionService;
  7120. use Tqdev\PhpCrudApi\Controller\Responder;
  7121. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  7122. use Tqdev\PhpCrudApi\Middleware\Router\Router;
  7123. use Tqdev\PhpCrudApi\Record\ErrorCode;
  7124. use Tqdev\PhpCrudApi\RequestUtils;
  7125. class PageLimitsMiddleware extends Middleware
  7126. {
  7127. private $reflection;
  7128. public function __construct(Router $router, Responder $responder, array $properties, ReflectionService $reflection)
  7129. {
  7130. parent::__construct($router, $responder, $properties);
  7131. $this->reflection = $reflection;
  7132. }
  7133. public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
  7134. {
  7135. $operation = RequestUtils::getOperation($request);
  7136. if ($operation == 'list') {
  7137. $params = RequestUtils::getParams($request);
  7138. $maxPage = (int) $this->getProperty('pages', '100');
  7139. if (isset($params['page']) && $params['page'] && $maxPage > 0) {
  7140. if (strpos($params['page'][0], ',') === false) {
  7141. $page = $params['page'][0];
  7142. } else {
  7143. list($page, $size) = explode(',', $params['page'][0], 2);
  7144. }
  7145. if ($page > $maxPage) {
  7146. return $this->responder->error(ErrorCode::PAGINATION_FORBIDDEN, '');
  7147. }
  7148. }
  7149. $maxSize = (int) $this->getProperty('records', '1000');
  7150. if (!isset($params['size']) || !$params['size'] && $maxSize > 0) {
  7151. $params['size'] = array($maxSize);
  7152. } else {
  7153. $params['size'] = array(min($params['size'][0], $maxSize));
  7154. }
  7155. $request = RequestUtils::setParams($request, $params);
  7156. }
  7157. return $next->handle($request);
  7158. }
  7159. }
  7160. }
  7161. // file: src/Tqdev/PhpCrudApi/Middleware/ReconnectMiddleware.php
  7162. namespace Tqdev\PhpCrudApi\Middleware {
  7163. use Psr\Http\Message\ResponseInterface;
  7164. use Psr\Http\Message\ServerRequestInterface;
  7165. use Psr\Http\Server\RequestHandlerInterface;
  7166. use Tqdev\PhpCrudApi\Column\ReflectionService;
  7167. use Tqdev\PhpCrudApi\Controller\Responder;
  7168. use Tqdev\PhpCrudApi\Database\GenericDB;
  7169. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  7170. use Tqdev\PhpCrudApi\Middleware\Router\Router;
  7171. class ReconnectMiddleware extends Middleware
  7172. {
  7173. private $reflection;
  7174. private $db;
  7175. public function __construct(Router $router, Responder $responder, array $properties, ReflectionService $reflection, GenericDB $db)
  7176. {
  7177. parent::__construct($router, $responder, $properties);
  7178. $this->reflection = $reflection;
  7179. $this->db = $db;
  7180. }
  7181. private function getDriver(): string
  7182. {
  7183. $driverHandler = $this->getProperty('driverHandler', '');
  7184. if ($driverHandler) {
  7185. return call_user_func($driverHandler);
  7186. }
  7187. return '';
  7188. }
  7189. private function getAddress(): string
  7190. {
  7191. $addressHandler = $this->getProperty('addressHandler', '');
  7192. if ($addressHandler) {
  7193. return call_user_func($addressHandler);
  7194. }
  7195. return '';
  7196. }
  7197. private function getPort(): int
  7198. {
  7199. $portHandler = $this->getProperty('portHandler', '');
  7200. if ($portHandler) {
  7201. return call_user_func($portHandler);
  7202. }
  7203. return 0;
  7204. }
  7205. private function getDatabase(): string
  7206. {
  7207. $databaseHandler = $this->getProperty('databaseHandler', '');
  7208. if ($databaseHandler) {
  7209. return call_user_func($databaseHandler);
  7210. }
  7211. return '';
  7212. }
  7213. private function getTables(): array
  7214. {
  7215. $tablesHandler = $this->getProperty('tablesHandler', '');
  7216. if ($tablesHandler) {
  7217. return call_user_func($tablesHandler);
  7218. }
  7219. return [];
  7220. }
  7221. private function getUsername(): string
  7222. {
  7223. $usernameHandler = $this->getProperty('usernameHandler', '');
  7224. if ($usernameHandler) {
  7225. return call_user_func($usernameHandler);
  7226. }
  7227. return '';
  7228. }
  7229. private function getPassword(): string
  7230. {
  7231. $passwordHandler = $this->getProperty('passwordHandler', '');
  7232. if ($passwordHandler) {
  7233. return call_user_func($passwordHandler);
  7234. }
  7235. return '';
  7236. }
  7237. public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
  7238. {
  7239. $driver = $this->getDriver();
  7240. $address = $this->getAddress();
  7241. $port = $this->getPort();
  7242. $database = $this->getDatabase();
  7243. $tables = $this->getTables();
  7244. $username = $this->getUsername();
  7245. $password = $this->getPassword();
  7246. if ($driver || $address || $port || $database || $tables || $username || $password) {
  7247. $this->db->reconstruct($driver, $address, $port, $database, $tables, $username, $password);
  7248. }
  7249. return $next->handle($request);
  7250. }
  7251. }
  7252. }
  7253. // file: src/Tqdev/PhpCrudApi/Middleware/SanitationMiddleware.php
  7254. namespace Tqdev\PhpCrudApi\Middleware {
  7255. use Psr\Http\Message\ResponseInterface;
  7256. use Psr\Http\Message\ServerRequestInterface;
  7257. use Psr\Http\Server\RequestHandlerInterface;
  7258. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedTable;
  7259. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedColumn;
  7260. use Tqdev\PhpCrudApi\Column\ReflectionService;
  7261. use Tqdev\PhpCrudApi\Controller\Responder;
  7262. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  7263. use Tqdev\PhpCrudApi\Middleware\Router\Router;
  7264. use Tqdev\PhpCrudApi\RequestUtils;
  7265. class SanitationMiddleware extends Middleware
  7266. {
  7267. private $reflection;
  7268. public function __construct(Router $router, Responder $responder, array $properties, ReflectionService $reflection)
  7269. {
  7270. parent::__construct($router, $responder, $properties);
  7271. $this->reflection = $reflection;
  7272. }
  7273. private function callHandler($handler, $record, string $operation, ReflectedTable $table) /*: object */
  7274. {
  7275. $context = (array) $record;
  7276. $tableName = $table->getName();
  7277. foreach ($context as $columnName => &$value) {
  7278. if ($table->hasColumn($columnName)) {
  7279. $column = $table->getColumn($columnName);
  7280. $value = call_user_func($handler, $operation, $tableName, $column->serialize(), $value);
  7281. $value = $this->sanitizeType($table, $column, $value);
  7282. }
  7283. }
  7284. return (object) $context;
  7285. }
  7286. private function sanitizeType(ReflectedTable $table, ReflectedColumn $column, $value)
  7287. {
  7288. $tables = $this->getArrayProperty('tables', 'all');
  7289. $types = $this->getArrayProperty('types', 'all');
  7290. if (
  7291. (in_array('all', $tables) || in_array($table->getName(), $tables)) &&
  7292. (in_array('all', $types) || in_array($column->getType(), $types))
  7293. ) {
  7294. if (is_null($value)) {
  7295. return $value;
  7296. }
  7297. if (is_string($value)) {
  7298. $newValue = null;
  7299. switch ($column->getType()) {
  7300. case 'integer':
  7301. case 'bigint':
  7302. $newValue = filter_var(trim($value), FILTER_VALIDATE_INT, FILTER_NULL_ON_FAILURE);
  7303. break;
  7304. case 'decimal':
  7305. $newValue = filter_var(trim($value), FILTER_VALIDATE_FLOAT, FILTER_NULL_ON_FAILURE);
  7306. if (is_float($newValue)) {
  7307. $newValue = number_format($newValue, $column->getScale(), '.', '');
  7308. }
  7309. break;
  7310. case 'float':
  7311. case 'double':
  7312. $newValue = filter_var(trim($value), FILTER_VALIDATE_FLOAT, FILTER_NULL_ON_FAILURE);
  7313. break;
  7314. case 'boolean':
  7315. $newValue = filter_var(trim($value), FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE);
  7316. break;
  7317. case 'date':
  7318. $time = strtotime(trim($value));
  7319. if ($time !== false) {
  7320. $newValue = date('Y-m-d', $time);
  7321. }
  7322. break;
  7323. case 'time':
  7324. $time = strtotime(trim($value));
  7325. if ($time !== false) {
  7326. $newValue = date('H:i:s', $time);
  7327. }
  7328. break;
  7329. case 'timestamp':
  7330. $time = strtotime(trim($value));
  7331. if ($time !== false) {
  7332. $newValue = date('Y-m-d H:i:s', $time);
  7333. }
  7334. break;
  7335. case 'blob':
  7336. case 'varbinary':
  7337. // allow base64url format
  7338. $newValue = strtr(trim($value), '-_', '+/');
  7339. break;
  7340. case 'clob':
  7341. case 'varchar':
  7342. $newValue = $value;
  7343. break;
  7344. case 'geometry':
  7345. $newValue = trim($value);
  7346. break;
  7347. }
  7348. if (!is_null($newValue)) {
  7349. $value = $newValue;
  7350. }
  7351. } else {
  7352. switch ($column->getType()) {
  7353. case 'integer':
  7354. case 'bigint':
  7355. if (is_float($value)) {
  7356. $value = (int) round($value);
  7357. }
  7358. break;
  7359. case 'decimal':
  7360. if (is_float($value) || is_int($value)) {
  7361. $value = number_format((float) $value, $column->getScale(), '.', '');
  7362. }
  7363. break;
  7364. }
  7365. }
  7366. // post process
  7367. }
  7368. return $value;
  7369. }
  7370. public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
  7371. {
  7372. $operation = RequestUtils::getOperation($request);
  7373. if (in_array($operation, ['create', 'update', 'increment'])) {
  7374. $tableName = RequestUtils::getPathSegment($request, 2);
  7375. if ($this->reflection->hasTable($tableName)) {
  7376. $record = $request->getParsedBody();
  7377. if ($record !== null) {
  7378. $handler = $this->getProperty('handler', '');
  7379. if ($handler !== '') {
  7380. $table = $this->reflection->getTable($tableName);
  7381. if (is_array($record)) {
  7382. foreach ($record as &$r) {
  7383. $r = $this->callHandler($handler, $r, $operation, $table);
  7384. }
  7385. } else {
  7386. $record = $this->callHandler($handler, $record, $operation, $table);
  7387. }
  7388. $request = $request->withParsedBody($record);
  7389. }
  7390. }
  7391. }
  7392. }
  7393. return $next->handle($request);
  7394. }
  7395. }
  7396. }
  7397. // file: src/Tqdev/PhpCrudApi/Middleware/SslRedirectMiddleware.php
  7398. namespace Tqdev\PhpCrudApi\Middleware {
  7399. use Psr\Http\Message\ResponseInterface;
  7400. use Psr\Http\Message\ServerRequestInterface;
  7401. use Psr\Http\Server\RequestHandlerInterface;
  7402. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  7403. use Tqdev\PhpCrudApi\ResponseFactory;
  7404. class SslRedirectMiddleware extends Middleware
  7405. {
  7406. public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
  7407. {
  7408. $uri = $request->getUri();
  7409. $scheme = $uri->getScheme();
  7410. if ($scheme == 'http') {
  7411. $uri = $request->getUri();
  7412. $uri = $uri->withScheme('https');
  7413. $response = ResponseFactory::fromStatus(301);
  7414. $response = $response->withHeader('Location', $uri->__toString());
  7415. } else {
  7416. $response = $next->handle($request);
  7417. }
  7418. return $response;
  7419. }
  7420. }
  7421. }
  7422. // file: src/Tqdev/PhpCrudApi/Middleware/ValidationMiddleware.php
  7423. namespace Tqdev\PhpCrudApi\Middleware {
  7424. use Psr\Http\Message\ResponseInterface;
  7425. use Psr\Http\Message\ServerRequestInterface;
  7426. use Psr\Http\Server\RequestHandlerInterface;
  7427. use Tqdev\PhpCrudApi\Column\ReflectionService;
  7428. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedTable;
  7429. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedColumn;
  7430. use Tqdev\PhpCrudApi\Controller\Responder;
  7431. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  7432. use Tqdev\PhpCrudApi\Middleware\Router\Router;
  7433. use Tqdev\PhpCrudApi\Record\ErrorCode;
  7434. use Tqdev\PhpCrudApi\RequestUtils;
  7435. class ValidationMiddleware extends Middleware
  7436. {
  7437. private $reflection;
  7438. public function __construct(Router $router, Responder $responder, array $properties, ReflectionService $reflection)
  7439. {
  7440. parent::__construct($router, $responder, $properties);
  7441. $this->reflection = $reflection;
  7442. }
  7443. private function callHandler($handler, $record, string $operation, ReflectedTable $table) /*: ResponseInterface?*/
  7444. {
  7445. $context = (array) $record;
  7446. $details = array();
  7447. $tableName = $table->getName();
  7448. foreach ($context as $columnName => $value) {
  7449. if ($table->hasColumn($columnName)) {
  7450. $column = $table->getColumn($columnName);
  7451. $valid = call_user_func($handler, $operation, $tableName, $column->serialize(), $value, $context);
  7452. if ($valid === true || $valid === '') {
  7453. $valid = $this->validateType($table, $column, $value);
  7454. }
  7455. if ($valid !== true && $valid !== '') {
  7456. $details[$columnName] = $valid;
  7457. }
  7458. }
  7459. }
  7460. if (count($details) > 0) {
  7461. return $this->responder->error(ErrorCode::INPUT_VALIDATION_FAILED, $tableName, $details);
  7462. }
  7463. return null;
  7464. }
  7465. private function validateType(ReflectedTable $table, ReflectedColumn $column, $value)
  7466. {
  7467. $tables = $this->getArrayProperty('tables', 'all');
  7468. $types = $this->getArrayProperty('types', 'all');
  7469. if (
  7470. (in_array('all', $tables) || in_array($table->getName(), $tables)) &&
  7471. (in_array('all', $types) || in_array($column->getType(), $types))
  7472. ) {
  7473. if (is_null($value)) {
  7474. return ($column->getNullable() ? true : "cannot be null");
  7475. }
  7476. if (is_string($value)) {
  7477. // check for whitespace
  7478. switch ($column->getType()) {
  7479. case 'varchar':
  7480. case 'clob':
  7481. break;
  7482. default:
  7483. if (strlen(trim($value)) != strlen($value)) {
  7484. return 'illegal whitespace';
  7485. }
  7486. break;
  7487. }
  7488. // try to parse
  7489. switch ($column->getType()) {
  7490. case 'integer':
  7491. case 'bigint':
  7492. if (
  7493. filter_var($value, FILTER_SANITIZE_NUMBER_INT) !== $value ||
  7494. filter_var($value, FILTER_VALIDATE_INT) === false
  7495. ) {
  7496. return 'invalid integer';
  7497. }
  7498. break;
  7499. case 'decimal':
  7500. if (strpos($value, '.') !== false) {
  7501. list($whole, $decimals) = explode('.', $value, 2);
  7502. } else {
  7503. list($whole, $decimals) = array($value, '');
  7504. }
  7505. if (strlen($whole) > 0 && !ctype_digit($whole)) {
  7506. return 'invalid decimal';
  7507. }
  7508. if (strlen($decimals) > 0 && !ctype_digit($decimals)) {
  7509. return 'invalid decimal';
  7510. }
  7511. if (strlen($whole) > $column->getPrecision() - $column->getScale()) {
  7512. return 'decimal too large';
  7513. }
  7514. if (strlen($decimals) > $column->getScale()) {
  7515. return 'decimal too precise';
  7516. }
  7517. break;
  7518. case 'float':
  7519. case 'double':
  7520. if (
  7521. filter_var($value, FILTER_SANITIZE_NUMBER_FLOAT) !== $value ||
  7522. filter_var($value, FILTER_VALIDATE_FLOAT) === false
  7523. ) {
  7524. return 'invalid float';
  7525. }
  7526. break;
  7527. case 'boolean':
  7528. if (!in_array(strtolower($value), array('true', 'false'))) {
  7529. return 'invalid boolean';
  7530. }
  7531. break;
  7532. case 'date':
  7533. if (date_create_from_format('Y-m-d', $value) === false) {
  7534. return 'invalid date';
  7535. }
  7536. break;
  7537. case 'time':
  7538. if (date_create_from_format('H:i:s', $value) === false) {
  7539. return 'invalid time';
  7540. }
  7541. break;
  7542. case 'timestamp':
  7543. if (date_create_from_format('Y-m-d H:i:s', $value) === false) {
  7544. return 'invalid timestamp';
  7545. }
  7546. break;
  7547. case 'clob':
  7548. case 'varchar':
  7549. if ($column->hasLength() && mb_strlen($value, 'UTF-8') > $column->getLength()) {
  7550. return 'string too long';
  7551. }
  7552. break;
  7553. case 'blob':
  7554. case 'varbinary':
  7555. if (base64_decode($value, true) === false) {
  7556. return 'invalid base64';
  7557. }
  7558. if ($column->hasLength() && strlen(base64_decode($value)) > $column->getLength()) {
  7559. return 'string too long';
  7560. }
  7561. break;
  7562. case 'geometry':
  7563. // no checks yet
  7564. break;
  7565. }
  7566. } else { // check non-string types
  7567. switch ($column->getType()) {
  7568. case 'integer':
  7569. case 'bigint':
  7570. if (!is_int($value)) {
  7571. return 'invalid integer';
  7572. }
  7573. break;
  7574. case 'float':
  7575. case 'double':
  7576. if (!is_float($value) && !is_int($value)) {
  7577. return 'invalid float';
  7578. }
  7579. break;
  7580. case 'boolean':
  7581. if (!is_bool($value) && ($value !== 0) && ($value !== 1)) {
  7582. return 'invalid boolean';
  7583. }
  7584. break;
  7585. default:
  7586. return 'invalid ' . $column->getType();
  7587. }
  7588. }
  7589. // extra checks
  7590. switch ($column->getType()) {
  7591. case 'integer': // 4 byte signed
  7592. $value = filter_var($value, FILTER_VALIDATE_INT);
  7593. if ($value > 2147483647 || $value < -2147483648) {
  7594. return 'invalid integer';
  7595. }
  7596. break;
  7597. }
  7598. }
  7599. return (true);
  7600. }
  7601. public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
  7602. {
  7603. $operation = RequestUtils::getOperation($request);
  7604. if (in_array($operation, ['create', 'update', 'increment'])) {
  7605. $tableName = RequestUtils::getPathSegment($request, 2);
  7606. if ($this->reflection->hasTable($tableName)) {
  7607. $record = $request->getParsedBody();
  7608. if ($record !== null) {
  7609. $handler = $this->getProperty('handler', '');
  7610. if ($handler !== '') {
  7611. $table = $this->reflection->getTable($tableName);
  7612. if (is_array($record)) {
  7613. foreach ($record as $r) {
  7614. $response = $this->callHandler($handler, $r, $operation, $table);
  7615. if ($response !== null) {
  7616. return $response;
  7617. }
  7618. }
  7619. } else {
  7620. $response = $this->callHandler($handler, $record, $operation, $table);
  7621. if ($response !== null) {
  7622. return $response;
  7623. }
  7624. }
  7625. }
  7626. }
  7627. }
  7628. }
  7629. return $next->handle($request);
  7630. }
  7631. }
  7632. }
  7633. // file: src/Tqdev/PhpCrudApi/Middleware/XmlMiddleware.php
  7634. namespace Tqdev\PhpCrudApi\Middleware {
  7635. use Psr\Http\Message\ResponseInterface;
  7636. use Psr\Http\Message\ServerRequestInterface;
  7637. use Psr\Http\Server\RequestHandlerInterface;
  7638. use Tqdev\PhpCrudApi\Column\ReflectionService;
  7639. use Tqdev\PhpCrudApi\Controller\Responder;
  7640. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  7641. use Tqdev\PhpCrudApi\Middleware\Router\Router;
  7642. use Tqdev\PhpCrudApi\RequestUtils;
  7643. use Tqdev\PhpCrudApi\ResponseFactory;
  7644. class XmlMiddleware extends Middleware
  7645. {
  7646. private $reflection;
  7647. public function __construct(Router $router, Responder $responder, array $properties, ReflectionService $reflection)
  7648. {
  7649. parent::__construct($router, $responder, $properties);
  7650. $this->reflection = $reflection;
  7651. }
  7652. private function json2xml($json, $types = 'null,boolean,number,string,object,array')
  7653. {
  7654. $a = json_decode($json);
  7655. $d = new \DOMDocument();
  7656. $c = $d->createElement("root");
  7657. $d->appendChild($c);
  7658. $t = function ($v) {
  7659. $type = gettype($v);
  7660. switch ($type) {
  7661. case 'integer':
  7662. return 'number';
  7663. case 'double':
  7664. return 'number';
  7665. default:
  7666. return strtolower($type);
  7667. }
  7668. };
  7669. $ts = explode(',', $types);
  7670. $f = function ($f, $c, $a, $s = false) use ($t, $d, $ts) {
  7671. if (in_array($t($a), $ts)) {
  7672. $c->setAttribute('type', $t($a));
  7673. }
  7674. if ($t($a) != 'array' && $t($a) != 'object') {
  7675. if ($t($a) == 'boolean') {
  7676. $c->appendChild($d->createTextNode($a ? 'true' : 'false'));
  7677. } else {
  7678. $c->appendChild($d->createTextNode($a));
  7679. }
  7680. } else {
  7681. foreach ($a as $k => $v) {
  7682. if ($k == '__type' && $t($a) == 'object') {
  7683. $c->setAttribute('__type', $v);
  7684. } else {
  7685. if ($t($v) == 'object') {
  7686. $ch = $c->appendChild($d->createElementNS(null, $s ? 'item' : $k));
  7687. $f($f, $ch, $v);
  7688. } else if ($t($v) == 'array') {
  7689. $ch = $c->appendChild($d->createElementNS(null, $s ? 'item' : $k));
  7690. $f($f, $ch, $v, true);
  7691. } else {
  7692. $va = $d->createElementNS(null, $s ? 'item' : $k);
  7693. if ($t($v) == 'boolean') {
  7694. $va->appendChild($d->createTextNode($v ? 'true' : 'false'));
  7695. } else {
  7696. $va->appendChild($d->createTextNode($v));
  7697. }
  7698. $ch = $c->appendChild($va);
  7699. if (in_array($t($v), $ts)) {
  7700. $ch->setAttribute('type', $t($v));
  7701. }
  7702. }
  7703. }
  7704. }
  7705. }
  7706. };
  7707. $f($f, $c, $a, $t($a) == 'array');
  7708. return $d->saveXML($d->documentElement);
  7709. }
  7710. private function xml2json($xml)
  7711. {
  7712. $a = @dom_import_simplexml(simplexml_load_string($xml));
  7713. if (!$a) {
  7714. return null;
  7715. }
  7716. $t = function ($v) {
  7717. $t = $v->getAttribute('type');
  7718. $txt = $v->firstChild->nodeType == XML_TEXT_NODE;
  7719. return $t ?: ($txt ? 'string' : 'object');
  7720. };
  7721. $f = function ($f, $a) use ($t) {
  7722. $c = null;
  7723. if ($t($a) == 'null') {
  7724. $c = null;
  7725. } else if ($t($a) == 'boolean') {
  7726. $b = substr(strtolower($a->textContent), 0, 1);
  7727. $c = in_array($b, array('1', 't'));
  7728. } else if ($t($a) == 'number') {
  7729. $c = $a->textContent + 0;
  7730. } else if ($t($a) == 'string') {
  7731. $c = $a->textContent;
  7732. } else if ($t($a) == 'object') {
  7733. $c = array();
  7734. if ($a->getAttribute('__type')) {
  7735. $c['__type'] = $a->getAttribute('__type');
  7736. }
  7737. for ($i = 0; $i < $a->childNodes->length; $i++) {
  7738. $v = $a->childNodes[$i];
  7739. $c[$v->nodeName] = $f($f, $v);
  7740. }
  7741. $c = (object) $c;
  7742. } else if ($t($a) == 'array') {
  7743. $c = array();
  7744. for ($i = 0; $i < $a->childNodes->length; $i++) {
  7745. $v = $a->childNodes[$i];
  7746. $c[$i] = $f($f, $v);
  7747. }
  7748. }
  7749. return $c;
  7750. };
  7751. $c = $f($f, $a);
  7752. return json_encode($c);
  7753. }
  7754. public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
  7755. {
  7756. parse_str($request->getUri()->getQuery(), $params);
  7757. $isXml = isset($params['format']) && $params['format'] == 'xml';
  7758. if ($isXml) {
  7759. $body = $request->getBody()->getContents();
  7760. if ($body) {
  7761. $json = $this->xml2json($body);
  7762. $request = $request->withParsedBody(json_decode($json));
  7763. }
  7764. }
  7765. $response = $next->handle($request);
  7766. if ($isXml) {
  7767. $body = $response->getBody()->getContents();
  7768. if ($body) {
  7769. $types = implode(',', $this->getArrayProperty('types', 'null,array'));
  7770. if ($types == '' || $types == 'all') {
  7771. $xml = $this->json2xml($body);
  7772. } else {
  7773. $xml = $this->json2xml($body, $types);
  7774. }
  7775. $response = ResponseFactory::fromXml(ResponseFactory::OK, $xml);
  7776. }
  7777. }
  7778. return $response;
  7779. }
  7780. }
  7781. }
  7782. // file: src/Tqdev/PhpCrudApi/Middleware/XsrfMiddleware.php
  7783. namespace Tqdev\PhpCrudApi\Middleware {
  7784. use Psr\Http\Message\ResponseInterface;
  7785. use Psr\Http\Message\ServerRequestInterface;
  7786. use Psr\Http\Server\RequestHandlerInterface;
  7787. use Tqdev\PhpCrudApi\Controller\Responder;
  7788. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  7789. use Tqdev\PhpCrudApi\Record\ErrorCode;
  7790. class XsrfMiddleware extends Middleware
  7791. {
  7792. private function getToken(): string
  7793. {
  7794. $cookieName = $this->getProperty('cookieName', 'XSRF-TOKEN');
  7795. if (isset($_COOKIE[$cookieName])) {
  7796. $token = $_COOKIE[$cookieName];
  7797. } else {
  7798. $secure = isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on';
  7799. $token = bin2hex(random_bytes(8));
  7800. if (!headers_sent()) {
  7801. setcookie($cookieName, $token, 0, '', '', $secure);
  7802. }
  7803. }
  7804. return $token;
  7805. }
  7806. public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
  7807. {
  7808. $token = $this->getToken();
  7809. $method = $request->getMethod();
  7810. $excludeMethods = $this->getArrayProperty('excludeMethods', 'OPTIONS,GET');
  7811. if (!in_array($method, $excludeMethods)) {
  7812. $headerName = $this->getProperty('headerName', 'X-XSRF-TOKEN');
  7813. if ($token != $request->getHeader($headerName)) {
  7814. return $this->responder->error(ErrorCode::BAD_OR_MISSING_XSRF_TOKEN, '');
  7815. }
  7816. }
  7817. return $next->handle($request);
  7818. }
  7819. }
  7820. }
  7821. // file: src/Tqdev/PhpCrudApi/OpenApi/OpenApiBuilder.php
  7822. namespace Tqdev\PhpCrudApi\OpenApi {
  7823. use Tqdev\PhpCrudApi\Column\ReflectionService;
  7824. use Tqdev\PhpCrudApi\OpenApi\OpenApiDefinition;
  7825. class OpenApiBuilder
  7826. {
  7827. private $openapi;
  7828. private $records;
  7829. private $columns;
  7830. private $builders;
  7831. public function __construct(ReflectionService $reflection, array $base, array $controllers, array $builders)
  7832. {
  7833. $this->openapi = new OpenApiDefinition($base);
  7834. $this->records = in_array('records', $controllers) ? new OpenApiRecordsBuilder($this->openapi, $reflection) : null;
  7835. $this->columns = in_array('columns', $controllers) ? new OpenApiColumnsBuilder($this->openapi) : null;
  7836. $this->builders = array();
  7837. foreach ($builders as $className) {
  7838. $this->builders[] = new $className($this->openapi, $reflection);
  7839. }
  7840. }
  7841. private function getServerUrl(): string
  7842. {
  7843. $protocol = @$_SERVER['HTTP_X_FORWARDED_PROTO'] ?: @$_SERVER['REQUEST_SCHEME'] ?: ((isset($_SERVER["HTTPS"]) && $_SERVER["HTTPS"] == "on") ? "https" : "http");
  7844. $port = @intval($_SERVER['HTTP_X_FORWARDED_PORT']) ?: @intval($_SERVER["SERVER_PORT"]) ?: (($protocol === 'https') ? 443 : 80);
  7845. $host = @explode(":", $_SERVER['HTTP_HOST'])[0] ?: @$_SERVER['SERVER_NAME'] ?: @$_SERVER['SERVER_ADDR'];
  7846. $port = ($protocol === 'https' && $port === 443) || ($protocol === 'http' && $port === 80) ? '' : ':' . $port;
  7847. $path = @trim(substr($_SERVER['REQUEST_URI'], 0, strpos($_SERVER['REQUEST_URI'], '/openapi')), '/');
  7848. return sprintf('%s://%s%s/%s', $protocol, $host, $port, $path);
  7849. }
  7850. public function build(): OpenApiDefinition
  7851. {
  7852. $this->openapi->set("openapi", "3.0.0");
  7853. if (!$this->openapi->has("servers") && isset($_SERVER['REQUEST_URI'])) {
  7854. $this->openapi->set("servers|0|url", $this->getServerUrl());
  7855. }
  7856. if ($this->records) {
  7857. $this->records->build();
  7858. }
  7859. if ($this->columns) {
  7860. $this->columns->build();
  7861. }
  7862. foreach ($this->builders as $builder) {
  7863. $builder->build();
  7864. }
  7865. return $this->openapi;
  7866. }
  7867. }
  7868. }
  7869. // file: src/Tqdev/PhpCrudApi/OpenApi/OpenApiColumnsBuilder.php
  7870. namespace Tqdev\PhpCrudApi\OpenApi {
  7871. use Tqdev\PhpCrudApi\OpenApi\OpenApiDefinition;
  7872. class OpenApiColumnsBuilder
  7873. {
  7874. private $openapi;
  7875. private $operations = [
  7876. 'database' => [
  7877. 'read' => 'get',
  7878. ],
  7879. 'table' => [
  7880. 'create' => 'post',
  7881. 'read' => 'get',
  7882. 'update' => 'put', //rename
  7883. 'delete' => 'delete',
  7884. ],
  7885. 'column' => [
  7886. 'create' => 'post',
  7887. 'read' => 'get',
  7888. 'update' => 'put',
  7889. 'delete' => 'delete',
  7890. ]
  7891. ];
  7892. public function __construct(OpenApiDefinition $openapi)
  7893. {
  7894. $this->openapi = $openapi;
  7895. }
  7896. public function build() /*: void*/
  7897. {
  7898. $this->setPaths();
  7899. $this->openapi->set("components|responses|boolSuccess|description", "boolean indicating success or failure");
  7900. $this->openapi->set("components|responses|boolSuccess|content|application/json|schema|type", "boolean");
  7901. $this->setComponentSchema();
  7902. $this->setComponentResponse();
  7903. $this->setComponentRequestBody();
  7904. $this->setComponentParameters();
  7905. foreach (array_keys($this->operations) as $index => $type) {
  7906. $this->setTag($index, $type);
  7907. }
  7908. }
  7909. private function setPaths() /*: void*/
  7910. {
  7911. foreach (array_keys($this->operations) as $type) {
  7912. foreach ($this->operations[$type] as $operation => $method) {
  7913. $parameters = [];
  7914. switch ($type) {
  7915. case 'database':
  7916. $path = '/columns';
  7917. break;
  7918. case 'table':
  7919. $path = $operation == 'create' ? '/columns' : '/columns/{table}';
  7920. break;
  7921. case 'column':
  7922. $path = $operation == 'create' ? '/columns/{table}' : '/columns/{table}/{column}';
  7923. break;
  7924. }
  7925. if (strpos($path, '{table}')) {
  7926. $parameters[] = 'table';
  7927. }
  7928. if (strpos($path, '{column}')) {
  7929. $parameters[] = 'column';
  7930. }
  7931. foreach ($parameters as $p => $parameter) {
  7932. $this->openapi->set("paths|$path|$method|parameters|$p|\$ref", "#/components/parameters/$parameter");
  7933. }
  7934. $operationType = $operation . ucfirst($type);
  7935. if (in_array($operation, ['create', 'update'])) {
  7936. $this->openapi->set("paths|$path|$method|requestBody|\$ref", "#/components/requestBodies/$operationType");
  7937. }
  7938. $this->openapi->set("paths|$path|$method|tags|0", "$type");
  7939. $this->openapi->set("paths|$path|$method|operationId", "$operation" . "_" . "$type");
  7940. if ($operationType == 'updateTable') {
  7941. $this->openapi->set("paths|$path|$method|description", "rename table");
  7942. } else {
  7943. $this->openapi->set("paths|$path|$method|description", "$operation $type");
  7944. }
  7945. switch ($operation) {
  7946. case 'read':
  7947. $this->openapi->set("paths|$path|$method|responses|200|\$ref", "#/components/responses/$operationType");
  7948. break;
  7949. case 'create':
  7950. case 'update':
  7951. case 'delete':
  7952. $this->openapi->set("paths|$path|$method|responses|200|\$ref", "#/components/responses/boolSuccess");
  7953. break;
  7954. }
  7955. }
  7956. }
  7957. }
  7958. private function setComponentSchema() /*: void*/
  7959. {
  7960. foreach (array_keys($this->operations) as $type) {
  7961. foreach (array_keys($this->operations[$type]) as $operation) {
  7962. if ($operation == 'delete') {
  7963. continue;
  7964. }
  7965. $operationType = $operation . ucfirst($type);
  7966. $prefix = "components|schemas|$operationType";
  7967. $this->openapi->set("$prefix|type", "object");
  7968. switch ($type) {
  7969. case 'database':
  7970. $this->openapi->set("$prefix|properties|tables|type", 'array');
  7971. $this->openapi->set("$prefix|properties|tables|items|\$ref", "#/components/schemas/readTable");
  7972. break;
  7973. case 'table':
  7974. if ($operation == 'update') {
  7975. $this->openapi->set("$prefix|required", ['name']);
  7976. $this->openapi->set("$prefix|properties|name|type", 'string');
  7977. } else {
  7978. $this->openapi->set("$prefix|properties|name|type", 'string');
  7979. if ($operation == 'read') {
  7980. $this->openapi->set("$prefix|properties|type|type", 'string');
  7981. }
  7982. $this->openapi->set("$prefix|properties|columns|type", 'array');
  7983. $this->openapi->set("$prefix|properties|columns|items|\$ref", "#/components/schemas/readColumn");
  7984. }
  7985. break;
  7986. case 'column':
  7987. $this->openapi->set("$prefix|required", ['name', 'type']);
  7988. $this->openapi->set("$prefix|properties|name|type", 'string');
  7989. $this->openapi->set("$prefix|properties|type|type", 'string');
  7990. $this->openapi->set("$prefix|properties|length|type", 'integer');
  7991. $this->openapi->set("$prefix|properties|length|format", "int64");
  7992. $this->openapi->set("$prefix|properties|precision|type", 'integer');
  7993. $this->openapi->set("$prefix|properties|precision|format", "int64");
  7994. $this->openapi->set("$prefix|properties|scale|type", 'integer');
  7995. $this->openapi->set("$prefix|properties|scale|format", "int64");
  7996. $this->openapi->set("$prefix|properties|nullable|type", 'boolean');
  7997. $this->openapi->set("$prefix|properties|pk|type", 'boolean');
  7998. $this->openapi->set("$prefix|properties|fk|type", 'string');
  7999. break;
  8000. }
  8001. }
  8002. }
  8003. }
  8004. private function setComponentResponse() /*: void*/
  8005. {
  8006. foreach (array_keys($this->operations) as $type) {
  8007. foreach (array_keys($this->operations[$type]) as $operation) {
  8008. if ($operation != 'read') {
  8009. continue;
  8010. }
  8011. $operationType = $operation . ucfirst($type);
  8012. $this->openapi->set("components|responses|$operationType|description", "single $type record");
  8013. $this->openapi->set("components|responses|$operationType|content|application/json|schema|\$ref", "#/components/schemas/$operationType");
  8014. }
  8015. }
  8016. }
  8017. private function setComponentRequestBody() /*: void*/
  8018. {
  8019. foreach (array_keys($this->operations) as $type) {
  8020. foreach (array_keys($this->operations[$type]) as $operation) {
  8021. if (!in_array($operation, ['create', 'update'])) {
  8022. continue;
  8023. }
  8024. $operationType = $operation . ucfirst($type);
  8025. $this->openapi->set("components|requestBodies|$operationType|description", "single $type record");
  8026. $this->openapi->set("components|requestBodies|$operationType|content|application/json|schema|\$ref", "#/components/schemas/$operationType");
  8027. }
  8028. }
  8029. }
  8030. private function setComponentParameters() /*: void*/
  8031. {
  8032. $this->openapi->set("components|parameters|table|name", "table");
  8033. $this->openapi->set("components|parameters|table|in", "path");
  8034. $this->openapi->set("components|parameters|table|schema|type", "string");
  8035. $this->openapi->set("components|parameters|table|description", "table name");
  8036. $this->openapi->set("components|parameters|table|required", true);
  8037. $this->openapi->set("components|parameters|column|name", "column");
  8038. $this->openapi->set("components|parameters|column|in", "path");
  8039. $this->openapi->set("components|parameters|column|schema|type", "string");
  8040. $this->openapi->set("components|parameters|column|description", "column name");
  8041. $this->openapi->set("components|parameters|column|required", true);
  8042. }
  8043. private function setTag(int $index, string $type) /*: void*/
  8044. {
  8045. $this->openapi->set("tags|$index|name", "$type");
  8046. $this->openapi->set("tags|$index|description", "$type operations");
  8047. }
  8048. }
  8049. }
  8050. // file: src/Tqdev/PhpCrudApi/OpenApi/OpenApiDefinition.php
  8051. namespace Tqdev\PhpCrudApi\OpenApi {
  8052. class OpenApiDefinition implements \JsonSerializable
  8053. {
  8054. private $root;
  8055. public function __construct(array $base)
  8056. {
  8057. $this->root = $base;
  8058. }
  8059. public function set(string $path, $value) /*: void*/
  8060. {
  8061. $parts = explode('|', trim($path, '|'));
  8062. $current = &$this->root;
  8063. while (count($parts) > 0) {
  8064. $part = array_shift($parts);
  8065. if (!isset($current[$part])) {
  8066. $current[$part] = [];
  8067. }
  8068. $current = &$current[$part];
  8069. }
  8070. $current = $value;
  8071. }
  8072. public function has(string $path): bool
  8073. {
  8074. $parts = explode('|', trim($path, '|'));
  8075. $current = &$this->root;
  8076. while (count($parts) > 0) {
  8077. $part = array_shift($parts);
  8078. if (!isset($current[$part])) {
  8079. return false;
  8080. }
  8081. $current = &$current[$part];
  8082. }
  8083. return true;
  8084. }
  8085. public function jsonSerialize()
  8086. {
  8087. return $this->root;
  8088. }
  8089. }
  8090. }
  8091. // file: src/Tqdev/PhpCrudApi/OpenApi/OpenApiRecordsBuilder.php
  8092. namespace Tqdev\PhpCrudApi\OpenApi {
  8093. use Tqdev\PhpCrudApi\Column\ReflectionService;
  8094. use Tqdev\PhpCrudApi\Middleware\Communication\VariableStore;
  8095. use Tqdev\PhpCrudApi\OpenApi\OpenApiDefinition;
  8096. class OpenApiRecordsBuilder
  8097. {
  8098. private $openapi;
  8099. private $reflection;
  8100. private $operations = [
  8101. 'list' => 'get',
  8102. 'create' => 'post',
  8103. 'read' => 'get',
  8104. 'update' => 'put',
  8105. 'delete' => 'delete',
  8106. 'increment' => 'patch',
  8107. ];
  8108. private $types = [
  8109. 'integer' => ['type' => 'integer', 'format' => 'int32'],
  8110. 'bigint' => ['type' => 'integer', 'format' => 'int64'],
  8111. 'varchar' => ['type' => 'string'],
  8112. 'clob' => ['type' => 'string'],
  8113. 'varbinary' => ['type' => 'string', 'format' => 'byte'],
  8114. 'blob' => ['type' => 'string', 'format' => 'byte'],
  8115. 'decimal' => ['type' => 'string'],
  8116. 'float' => ['type' => 'number', 'format' => 'float'],
  8117. 'double' => ['type' => 'number', 'format' => 'double'],
  8118. 'date' => ['type' => 'string', 'format' => 'date'],
  8119. 'time' => ['type' => 'string', 'format' => 'date-time'],
  8120. 'timestamp' => ['type' => 'string', 'format' => 'date-time'],
  8121. 'geometry' => ['type' => 'string'],
  8122. 'boolean' => ['type' => 'boolean'],
  8123. ];
  8124. public function __construct(OpenApiDefinition $openapi, ReflectionService $reflection)
  8125. {
  8126. $this->openapi = $openapi;
  8127. $this->reflection = $reflection;
  8128. }
  8129. private function getAllTableReferences(): array
  8130. {
  8131. $tableReferences = array();
  8132. foreach ($this->reflection->getTableNames() as $tableName) {
  8133. $table = $this->reflection->getTable($tableName);
  8134. foreach ($table->getColumnNames() as $columnName) {
  8135. $column = $table->getColumn($columnName);
  8136. $referencedTableName = $column->getFk();
  8137. if ($referencedTableName) {
  8138. if (!isset($tableReferences[$referencedTableName])) {
  8139. $tableReferences[$referencedTableName] = array();
  8140. }
  8141. $tableReferences[$referencedTableName][] = "$tableName.$columnName";
  8142. }
  8143. }
  8144. }
  8145. return $tableReferences;
  8146. }
  8147. public function build() /*: void*/
  8148. {
  8149. $tableNames = $this->reflection->getTableNames();
  8150. foreach ($tableNames as $tableName) {
  8151. $this->setPath($tableName);
  8152. }
  8153. $this->openapi->set("components|responses|pk_integer|description", "inserted primary key value (integer)");
  8154. $this->openapi->set("components|responses|pk_integer|content|application/json|schema|type", "integer");
  8155. $this->openapi->set("components|responses|pk_integer|content|application/json|schema|format", "int64");
  8156. $this->openapi->set("components|responses|pk_string|description", "inserted primary key value (string)");
  8157. $this->openapi->set("components|responses|pk_string|content|application/json|schema|type", "string");
  8158. $this->openapi->set("components|responses|pk_string|content|application/json|schema|format", "uuid");
  8159. $this->openapi->set("components|responses|rows_affected|description", "number of rows affected (integer)");
  8160. $this->openapi->set("components|responses|rows_affected|content|application/json|schema|type", "integer");
  8161. $this->openapi->set("components|responses|rows_affected|content|application/json|schema|format", "int64");
  8162. $tableReferences = $this->getAllTableReferences();
  8163. foreach ($tableNames as $tableName) {
  8164. $references = isset($tableReferences[$tableName]) ? $tableReferences[$tableName] : array();
  8165. $this->setComponentSchema($tableName, $references);
  8166. $this->setComponentResponse($tableName);
  8167. $this->setComponentRequestBody($tableName);
  8168. }
  8169. $this->setComponentParameters();
  8170. foreach ($tableNames as $index => $tableName) {
  8171. $this->setTag($index, $tableName);
  8172. }
  8173. }
  8174. private function isOperationOnTableAllowed(string $operation, string $tableName): bool
  8175. {
  8176. $tableHandler = VariableStore::get('authorization.tableHandler');
  8177. if (!$tableHandler) {
  8178. return true;
  8179. }
  8180. return (bool) call_user_func($tableHandler, $operation, $tableName);
  8181. }
  8182. private function isOperationOnColumnAllowed(string $operation, string $tableName, string $columnName): bool
  8183. {
  8184. $columnHandler = VariableStore::get('authorization.columnHandler');
  8185. if (!$columnHandler) {
  8186. return true;
  8187. }
  8188. return (bool) call_user_func($columnHandler, $operation, $tableName, $columnName);
  8189. }
  8190. private function setPath(string $tableName) /*: void*/
  8191. {
  8192. $table = $this->reflection->getTable($tableName);
  8193. $type = $table->getType();
  8194. $pk = $table->getPk();
  8195. $pkName = $pk ? $pk->getName() : '';
  8196. foreach ($this->operations as $operation => $method) {
  8197. if (!$pkName && $operation != 'list') {
  8198. continue;
  8199. }
  8200. if ($type != 'table' && $operation != 'list') {
  8201. continue;
  8202. }
  8203. if (!$this->isOperationOnTableAllowed($operation, $tableName)) {
  8204. continue;
  8205. }
  8206. $parameters = [];
  8207. if (in_array($operation, ['list', 'create'])) {
  8208. $path = sprintf('/records/%s', $tableName);
  8209. if ($operation == 'list') {
  8210. $parameters = ['filter', 'include', 'exclude', 'order', 'size', 'page', 'join'];
  8211. }
  8212. } else {
  8213. $path = sprintf('/records/%s/{id}', $tableName);
  8214. if ($operation == 'read') {
  8215. $parameters = ['pk', 'include', 'exclude', 'join'];
  8216. } else {
  8217. $parameters = ['pk'];
  8218. }
  8219. }
  8220. foreach ($parameters as $p => $parameter) {
  8221. $this->openapi->set("paths|$path|$method|parameters|$p|\$ref", "#/components/parameters/$parameter");
  8222. }
  8223. if (in_array($operation, ['create', 'update', 'increment'])) {
  8224. $this->openapi->set("paths|$path|$method|requestBody|\$ref", "#/components/requestBodies/$operation-" . rawurlencode($tableName));
  8225. }
  8226. $this->openapi->set("paths|$path|$method|tags|0", "$tableName");
  8227. $this->openapi->set("paths|$path|$method|operationId", "$operation" . "_" . "$tableName");
  8228. $this->openapi->set("paths|$path|$method|description", "$operation $tableName");
  8229. switch ($operation) {
  8230. case 'list':
  8231. $this->openapi->set("paths|$path|$method|responses|200|\$ref", "#/components/responses/$operation-" . rawurlencode($tableName));
  8232. break;
  8233. case 'create':
  8234. if ($pk->getType() == 'integer') {
  8235. $this->openapi->set("paths|$path|$method|responses|200|\$ref", "#/components/responses/pk_integer");
  8236. } else {
  8237. $this->openapi->set("paths|$path|$method|responses|200|\$ref", "#/components/responses/pk_string");
  8238. }
  8239. break;
  8240. case 'read':
  8241. $this->openapi->set("paths|$path|$method|responses|200|\$ref", "#/components/responses/$operation-" . rawurlencode($tableName));
  8242. break;
  8243. case 'update':
  8244. case 'delete':
  8245. case 'increment':
  8246. $this->openapi->set("paths|$path|$method|responses|200|\$ref", "#/components/responses/rows_affected");
  8247. break;
  8248. }
  8249. }
  8250. }
  8251. private function setComponentSchema(string $tableName, array $references) /*: void*/
  8252. {
  8253. $table = $this->reflection->getTable($tableName);
  8254. $type = $table->getType();
  8255. $pk = $table->getPk();
  8256. $pkName = $pk ? $pk->getName() : '';
  8257. foreach ($this->operations as $operation => $method) {
  8258. if (!$pkName && $operation != 'list') {
  8259. continue;
  8260. }
  8261. if ($type != 'table' && $operation != 'list') {
  8262. continue;
  8263. }
  8264. if ($operation == 'delete') {
  8265. continue;
  8266. }
  8267. if (!$this->isOperationOnTableAllowed($operation, $tableName)) {
  8268. continue;
  8269. }
  8270. if ($operation == 'list') {
  8271. $this->openapi->set("components|schemas|$operation-$tableName|type", "object");
  8272. $this->openapi->set("components|schemas|$operation-$tableName|properties|results|type", "integer");
  8273. $this->openapi->set("components|schemas|$operation-$tableName|properties|results|format", "int64");
  8274. $this->openapi->set("components|schemas|$operation-$tableName|properties|records|type", "array");
  8275. $prefix = "components|schemas|$operation-$tableName|properties|records|items";
  8276. } else {
  8277. $prefix = "components|schemas|$operation-$tableName";
  8278. }
  8279. $this->openapi->set("$prefix|type", "object");
  8280. foreach ($table->getColumnNames() as $columnName) {
  8281. if (!$this->isOperationOnColumnAllowed($operation, $tableName, $columnName)) {
  8282. continue;
  8283. }
  8284. $column = $table->getColumn($columnName);
  8285. $properties = $this->types[$column->getType()];
  8286. foreach ($properties as $key => $value) {
  8287. $this->openapi->set("$prefix|properties|$columnName|$key", $value);
  8288. }
  8289. if ($column->getPk()) {
  8290. $this->openapi->set("$prefix|properties|$columnName|x-primary-key", true);
  8291. $this->openapi->set("$prefix|properties|$columnName|x-referenced", $references);
  8292. }
  8293. $fk = $column->getFk();
  8294. if ($fk) {
  8295. $this->openapi->set("$prefix|properties|$columnName|x-references", $fk);
  8296. }
  8297. }
  8298. }
  8299. }
  8300. private function setComponentResponse(string $tableName) /*: void*/
  8301. {
  8302. $table = $this->reflection->getTable($tableName);
  8303. $type = $table->getType();
  8304. $pk = $table->getPk();
  8305. $pkName = $pk ? $pk->getName() : '';
  8306. foreach (['list', 'read'] as $operation) {
  8307. if (!$pkName && $operation != 'list') {
  8308. continue;
  8309. }
  8310. if ($type != 'table' && $operation != 'list') {
  8311. continue;
  8312. }
  8313. if (!$this->isOperationOnTableAllowed($operation, $tableName)) {
  8314. continue;
  8315. }
  8316. if ($operation == 'list') {
  8317. $this->openapi->set("components|responses|$operation-$tableName|description", "list of $tableName records");
  8318. } else {
  8319. $this->openapi->set("components|responses|$operation-$tableName|description", "single $tableName record");
  8320. }
  8321. $this->openapi->set("components|responses|$operation-$tableName|content|application/json|schema|\$ref", "#/components/schemas/$operation-" . rawurlencode($tableName));
  8322. }
  8323. }
  8324. private function setComponentRequestBody(string $tableName) /*: void*/
  8325. {
  8326. $table = $this->reflection->getTable($tableName);
  8327. $type = $table->getType();
  8328. $pk = $table->getPk();
  8329. $pkName = $pk ? $pk->getName() : '';
  8330. if ($pkName && $type == 'table') {
  8331. foreach (['create', 'update', 'increment'] as $operation) {
  8332. if (!$this->isOperationOnTableAllowed($operation, $tableName)) {
  8333. continue;
  8334. }
  8335. $this->openapi->set("components|requestBodies|$operation-$tableName|description", "single $tableName record");
  8336. $this->openapi->set("components|requestBodies|$operation-$tableName|content|application/json|schema|\$ref", "#/components/schemas/$operation-" . rawurlencode($tableName));
  8337. }
  8338. }
  8339. }
  8340. private function setComponentParameters() /*: void*/
  8341. {
  8342. $this->openapi->set("components|parameters|pk|name", "id");
  8343. $this->openapi->set("components|parameters|pk|in", "path");
  8344. $this->openapi->set("components|parameters|pk|schema|type", "string");
  8345. $this->openapi->set("components|parameters|pk|description", "primary key value");
  8346. $this->openapi->set("components|parameters|pk|required", true);
  8347. $this->openapi->set("components|parameters|filter|name", "filter");
  8348. $this->openapi->set("components|parameters|filter|in", "query");
  8349. $this->openapi->set("components|parameters|filter|schema|type", "array");
  8350. $this->openapi->set("components|parameters|filter|schema|items|type", "string");
  8351. $this->openapi->set("components|parameters|filter|description", "Filters to be applied. Each filter consists of a column, an operator and a value (comma separated). Example: id,eq,1");
  8352. $this->openapi->set("components|parameters|filter|required", false);
  8353. $this->openapi->set("components|parameters|include|name", "include");
  8354. $this->openapi->set("components|parameters|include|in", "query");
  8355. $this->openapi->set("components|parameters|include|schema|type", "string");
  8356. $this->openapi->set("components|parameters|include|description", "Columns you want to include in the output (comma separated). Example: posts.*,categories.name");
  8357. $this->openapi->set("components|parameters|include|required", false);
  8358. $this->openapi->set("components|parameters|exclude|name", "exclude");
  8359. $this->openapi->set("components|parameters|exclude|in", "query");
  8360. $this->openapi->set("components|parameters|exclude|schema|type", "string");
  8361. $this->openapi->set("components|parameters|exclude|description", "Columns you want to exclude from the output (comma separated). Example: posts.content");
  8362. $this->openapi->set("components|parameters|exclude|required", false);
  8363. $this->openapi->set("components|parameters|order|name", "order");
  8364. $this->openapi->set("components|parameters|order|in", "query");
  8365. $this->openapi->set("components|parameters|order|schema|type", "array");
  8366. $this->openapi->set("components|parameters|order|schema|items|type", "string");
  8367. $this->openapi->set("components|parameters|order|description", "Column you want to sort on and the sort direction (comma separated). Example: id,desc");
  8368. $this->openapi->set("components|parameters|order|required", false);
  8369. $this->openapi->set("components|parameters|size|name", "size");
  8370. $this->openapi->set("components|parameters|size|in", "query");
  8371. $this->openapi->set("components|parameters|size|schema|type", "string");
  8372. $this->openapi->set("components|parameters|size|description", "Maximum number of results (for top lists). Example: 10");
  8373. $this->openapi->set("components|parameters|size|required", false);
  8374. $this->openapi->set("components|parameters|page|name", "page");
  8375. $this->openapi->set("components|parameters|page|in", "query");
  8376. $this->openapi->set("components|parameters|page|schema|type", "string");
  8377. $this->openapi->set("components|parameters|page|description", "Page number and page size (comma separated). Example: 1,10");
  8378. $this->openapi->set("components|parameters|page|required", false);
  8379. $this->openapi->set("components|parameters|join|name", "join");
  8380. $this->openapi->set("components|parameters|join|in", "query");
  8381. $this->openapi->set("components|parameters|join|schema|type", "array");
  8382. $this->openapi->set("components|parameters|join|schema|items|type", "string");
  8383. $this->openapi->set("components|parameters|join|description", "Paths (comma separated) to related entities that you want to include. Example: comments,users");
  8384. $this->openapi->set("components|parameters|join|required", false);
  8385. }
  8386. private function setTag(int $index, string $tableName) /*: void*/
  8387. {
  8388. $this->openapi->set("tags|$index|name", "$tableName");
  8389. $this->openapi->set("tags|$index|description", "$tableName operations");
  8390. }
  8391. }
  8392. }
  8393. // file: src/Tqdev/PhpCrudApi/OpenApi/OpenApiService.php
  8394. namespace Tqdev\PhpCrudApi\OpenApi {
  8395. use Tqdev\PhpCrudApi\Column\ReflectionService;
  8396. use Tqdev\PhpCrudApi\OpenApi\OpenApiBuilder;
  8397. class OpenApiService
  8398. {
  8399. private $builder;
  8400. public function __construct(ReflectionService $reflection, array $base, array $controllers, array $customBuilders)
  8401. {
  8402. $this->builder = new OpenApiBuilder($reflection, $base, $controllers, $customBuilders);
  8403. }
  8404. public function get(): OpenApiDefinition
  8405. {
  8406. return $this->builder->build();
  8407. }
  8408. }
  8409. }
  8410. // file: src/Tqdev/PhpCrudApi/Record/Condition/AndCondition.php
  8411. namespace Tqdev\PhpCrudApi\Record\Condition {
  8412. class AndCondition extends Condition
  8413. {
  8414. private $conditions;
  8415. public function __construct(Condition $condition1, Condition $condition2)
  8416. {
  8417. $this->conditions = [$condition1, $condition2];
  8418. }
  8419. public function _and(Condition $condition): Condition
  8420. {
  8421. if ($condition instanceof NoCondition) {
  8422. return $this;
  8423. }
  8424. $this->conditions[] = $condition;
  8425. return $this;
  8426. }
  8427. public function getConditions(): array
  8428. {
  8429. return $this->conditions;
  8430. }
  8431. public static function fromArray(array $conditions): Condition
  8432. {
  8433. $condition = new NoCondition();
  8434. foreach ($conditions as $c) {
  8435. $condition = $condition->_and($c);
  8436. }
  8437. return $condition;
  8438. }
  8439. }
  8440. }
  8441. // file: src/Tqdev/PhpCrudApi/Record/Condition/ColumnCondition.php
  8442. namespace Tqdev\PhpCrudApi\Record\Condition {
  8443. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedColumn;
  8444. class ColumnCondition extends Condition
  8445. {
  8446. private $column;
  8447. private $operator;
  8448. private $value;
  8449. public function __construct(ReflectedColumn $column, string $operator, string $value)
  8450. {
  8451. $this->column = $column;
  8452. $this->operator = $operator;
  8453. $this->value = $value;
  8454. }
  8455. public function getColumn(): ReflectedColumn
  8456. {
  8457. return $this->column;
  8458. }
  8459. public function getOperator(): string
  8460. {
  8461. return $this->operator;
  8462. }
  8463. public function getValue(): string
  8464. {
  8465. return $this->value;
  8466. }
  8467. }
  8468. }
  8469. // file: src/Tqdev/PhpCrudApi/Record/Condition/Condition.php
  8470. namespace Tqdev\PhpCrudApi\Record\Condition {
  8471. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedTable;
  8472. abstract class Condition
  8473. {
  8474. public function _and(Condition $condition): Condition
  8475. {
  8476. if ($condition instanceof NoCondition) {
  8477. return $this;
  8478. }
  8479. return new AndCondition($this, $condition);
  8480. }
  8481. public function _or(Condition $condition): Condition
  8482. {
  8483. if ($condition instanceof NoCondition) {
  8484. return $this;
  8485. }
  8486. return new OrCondition($this, $condition);
  8487. }
  8488. public function _not(): Condition
  8489. {
  8490. return new NotCondition($this);
  8491. }
  8492. public static function fromString(ReflectedTable $table, string $value): Condition
  8493. {
  8494. $condition = new NoCondition();
  8495. $parts = explode(',', $value, 3);
  8496. if (count($parts) < 2) {
  8497. return $condition;
  8498. }
  8499. if (count($parts) < 3) {
  8500. $parts[2] = '';
  8501. }
  8502. $field = $table->getColumn($parts[0]);
  8503. $command = $parts[1];
  8504. $negate = false;
  8505. $spatial = false;
  8506. if (strlen($command) > 2) {
  8507. if (substr($command, 0, 1) == 'n') {
  8508. $negate = true;
  8509. $command = substr($command, 1);
  8510. }
  8511. if (substr($command, 0, 1) == 's') {
  8512. $spatial = true;
  8513. $command = substr($command, 1);
  8514. }
  8515. }
  8516. if ($spatial) {
  8517. if (in_array($command, ['co', 'cr', 'di', 'eq', 'in', 'ov', 'to', 'wi', 'ic', 'is', 'iv'])) {
  8518. $condition = new SpatialCondition($field, $command, $parts[2]);
  8519. }
  8520. } else {
  8521. if (in_array($command, ['cs', 'sw', 'ew', 'eq', 'lt', 'le', 'ge', 'gt', 'bt', 'in', 'is'])) {
  8522. $condition = new ColumnCondition($field, $command, $parts[2]);
  8523. }
  8524. }
  8525. if ($negate) {
  8526. $condition = $condition->_not();
  8527. }
  8528. return $condition;
  8529. }
  8530. }
  8531. }
  8532. // file: src/Tqdev/PhpCrudApi/Record/Condition/NoCondition.php
  8533. namespace Tqdev\PhpCrudApi\Record\Condition {
  8534. class NoCondition extends Condition
  8535. {
  8536. public function _and(Condition $condition): Condition
  8537. {
  8538. return $condition;
  8539. }
  8540. public function _or(Condition $condition): Condition
  8541. {
  8542. return $condition;
  8543. }
  8544. public function _not(): Condition
  8545. {
  8546. return $this;
  8547. }
  8548. }
  8549. }
  8550. // file: src/Tqdev/PhpCrudApi/Record/Condition/NotCondition.php
  8551. namespace Tqdev\PhpCrudApi\Record\Condition {
  8552. class NotCondition extends Condition
  8553. {
  8554. private $condition;
  8555. public function __construct(Condition $condition)
  8556. {
  8557. $this->condition = $condition;
  8558. }
  8559. public function getCondition(): Condition
  8560. {
  8561. return $this->condition;
  8562. }
  8563. }
  8564. }
  8565. // file: src/Tqdev/PhpCrudApi/Record/Condition/OrCondition.php
  8566. namespace Tqdev\PhpCrudApi\Record\Condition {
  8567. class OrCondition extends Condition
  8568. {
  8569. private $conditions;
  8570. public function __construct(Condition $condition1, Condition $condition2)
  8571. {
  8572. $this->conditions = [$condition1, $condition2];
  8573. }
  8574. public function _or(Condition $condition): Condition
  8575. {
  8576. if ($condition instanceof NoCondition) {
  8577. return $this;
  8578. }
  8579. $this->conditions[] = $condition;
  8580. return $this;
  8581. }
  8582. public function getConditions(): array
  8583. {
  8584. return $this->conditions;
  8585. }
  8586. public static function fromArray(array $conditions): Condition
  8587. {
  8588. $condition = new NoCondition();
  8589. foreach ($conditions as $c) {
  8590. $condition = $condition->_or($c);
  8591. }
  8592. return $condition;
  8593. }
  8594. }
  8595. }
  8596. // file: src/Tqdev/PhpCrudApi/Record/Condition/SpatialCondition.php
  8597. namespace Tqdev\PhpCrudApi\Record\Condition {
  8598. class SpatialCondition extends ColumnCondition
  8599. {
  8600. }
  8601. }
  8602. // file: src/Tqdev/PhpCrudApi/Record/Document/ErrorDocument.php
  8603. namespace Tqdev\PhpCrudApi\Record\Document {
  8604. use Tqdev\PhpCrudApi\Record\ErrorCode;
  8605. class ErrorDocument implements \JsonSerializable
  8606. {
  8607. public $code;
  8608. public $message;
  8609. public $details;
  8610. public function __construct(ErrorCode $errorCode, string $argument, $details)
  8611. {
  8612. $this->code = $errorCode->getCode();
  8613. $this->message = $errorCode->getMessage($argument);
  8614. $this->details = $details;
  8615. }
  8616. public function getCode(): int
  8617. {
  8618. return $this->code;
  8619. }
  8620. public function getMessage(): string
  8621. {
  8622. return $this->message;
  8623. }
  8624. public function serialize()
  8625. {
  8626. return [
  8627. 'code' => $this->code,
  8628. 'message' => $this->message,
  8629. 'details' => $this->details,
  8630. ];
  8631. }
  8632. public function jsonSerialize()
  8633. {
  8634. return array_filter($this->serialize());
  8635. }
  8636. }
  8637. }
  8638. // file: src/Tqdev/PhpCrudApi/Record/Document/ListDocument.php
  8639. namespace Tqdev\PhpCrudApi\Record\Document {
  8640. class ListDocument implements \JsonSerializable
  8641. {
  8642. private $records;
  8643. private $results;
  8644. public function __construct(array $records, int $results)
  8645. {
  8646. $this->records = $records;
  8647. $this->results = $results;
  8648. }
  8649. public function getRecords(): array
  8650. {
  8651. return $this->records;
  8652. }
  8653. public function getResults(): int
  8654. {
  8655. return $this->results;
  8656. }
  8657. public function serialize()
  8658. {
  8659. return [
  8660. 'records' => $this->records,
  8661. 'results' => $this->results,
  8662. ];
  8663. }
  8664. public function jsonSerialize()
  8665. {
  8666. return array_filter($this->serialize(), function ($v) {
  8667. return $v !== 0;
  8668. });
  8669. }
  8670. }
  8671. }
  8672. // file: src/Tqdev/PhpCrudApi/Record/ColumnIncluder.php
  8673. namespace Tqdev\PhpCrudApi\Record {
  8674. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedTable;
  8675. class ColumnIncluder
  8676. {
  8677. private function isMandatory(string $tableName, string $columnName, array $params): bool
  8678. {
  8679. return isset($params['mandatory']) && in_array($tableName . "." . $columnName, $params['mandatory']);
  8680. }
  8681. private function select(
  8682. string $tableName,
  8683. bool $primaryTable,
  8684. array $params,
  8685. string $paramName,
  8686. array $columnNames,
  8687. bool $include
  8688. ): array {
  8689. if (!isset($params[$paramName])) {
  8690. return $columnNames;
  8691. }
  8692. $columns = array();
  8693. foreach (explode(',', $params[$paramName][0]) as $columnName) {
  8694. $columns[$columnName] = true;
  8695. }
  8696. $result = array();
  8697. foreach ($columnNames as $columnName) {
  8698. $match = isset($columns['*.*']);
  8699. if (!$match) {
  8700. $match = isset($columns[$tableName . '.*']) || isset($columns[$tableName . '.' . $columnName]);
  8701. }
  8702. if ($primaryTable && !$match) {
  8703. $match = isset($columns['*']) || isset($columns[$columnName]);
  8704. }
  8705. if ($match) {
  8706. if ($include || $this->isMandatory($tableName, $columnName, $params)) {
  8707. $result[] = $columnName;
  8708. }
  8709. } else {
  8710. if (!$include || $this->isMandatory($tableName, $columnName, $params)) {
  8711. $result[] = $columnName;
  8712. }
  8713. }
  8714. }
  8715. return $result;
  8716. }
  8717. public function getNames(ReflectedTable $table, bool $primaryTable, array $params): array
  8718. {
  8719. $tableName = $table->getName();
  8720. $results = $table->getColumnNames();
  8721. $results = $this->select($tableName, $primaryTable, $params, 'include', $results, true);
  8722. $results = $this->select($tableName, $primaryTable, $params, 'exclude', $results, false);
  8723. return $results;
  8724. }
  8725. public function getValues(ReflectedTable $table, bool $primaryTable, /* object */ $record, array $params): array
  8726. {
  8727. $results = array();
  8728. $columnNames = $this->getNames($table, $primaryTable, $params);
  8729. foreach ($columnNames as $columnName) {
  8730. if (property_exists($record, $columnName)) {
  8731. $results[$columnName] = $record->$columnName;
  8732. }
  8733. }
  8734. return $results;
  8735. }
  8736. }
  8737. }
  8738. // file: src/Tqdev/PhpCrudApi/Record/ErrorCode.php
  8739. namespace Tqdev\PhpCrudApi\Record {
  8740. use Tqdev\PhpCrudApi\ResponseFactory;
  8741. class ErrorCode
  8742. {
  8743. private $code;
  8744. private $message;
  8745. private $status;
  8746. const ERROR_NOT_FOUND = 9999;
  8747. const ROUTE_NOT_FOUND = 1000;
  8748. const TABLE_NOT_FOUND = 1001;
  8749. const ARGUMENT_COUNT_MISMATCH = 1002;
  8750. const RECORD_NOT_FOUND = 1003;
  8751. const ORIGIN_FORBIDDEN = 1004;
  8752. const COLUMN_NOT_FOUND = 1005;
  8753. const TABLE_ALREADY_EXISTS = 1006;
  8754. const COLUMN_ALREADY_EXISTS = 1007;
  8755. const HTTP_MESSAGE_NOT_READABLE = 1008;
  8756. const DUPLICATE_KEY_EXCEPTION = 1009;
  8757. const DATA_INTEGRITY_VIOLATION = 1010;
  8758. const AUTHENTICATION_REQUIRED = 1011;
  8759. const AUTHENTICATION_FAILED = 1012;
  8760. const INPUT_VALIDATION_FAILED = 1013;
  8761. const OPERATION_FORBIDDEN = 1014;
  8762. const OPERATION_NOT_SUPPORTED = 1015;
  8763. const TEMPORARY_OR_PERMANENTLY_BLOCKED = 1016;
  8764. const BAD_OR_MISSING_XSRF_TOKEN = 1017;
  8765. const ONLY_AJAX_REQUESTS_ALLOWED = 1018;
  8766. const PAGINATION_FORBIDDEN = 1019;
  8767. private $values = [
  8768. 9999 => ["%s", ResponseFactory::INTERNAL_SERVER_ERROR],
  8769. 1000 => ["Route '%s' not found", ResponseFactory::NOT_FOUND],
  8770. 1001 => ["Table '%s' not found", ResponseFactory::NOT_FOUND],
  8771. 1002 => ["Argument count mismatch in '%s'", ResponseFactory::UNPROCESSABLE_ENTITY],
  8772. 1003 => ["Record '%s' not found", ResponseFactory::NOT_FOUND],
  8773. 1004 => ["Origin '%s' is forbidden", ResponseFactory::FORBIDDEN],
  8774. 1005 => ["Column '%s' not found", ResponseFactory::NOT_FOUND],
  8775. 1006 => ["Table '%s' already exists", ResponseFactory::CONFLICT],
  8776. 1007 => ["Column '%s' already exists", ResponseFactory::CONFLICT],
  8777. 1008 => ["Cannot read HTTP message", ResponseFactory::UNPROCESSABLE_ENTITY],
  8778. 1009 => ["Duplicate key exception", ResponseFactory::CONFLICT],
  8779. 1010 => ["Data integrity violation", ResponseFactory::CONFLICT],
  8780. 1011 => ["Authentication required", ResponseFactory::UNAUTHORIZED],
  8781. 1012 => ["Authentication failed for '%s'", ResponseFactory::FORBIDDEN],
  8782. 1013 => ["Input validation failed for '%s'", ResponseFactory::UNPROCESSABLE_ENTITY],
  8783. 1014 => ["Operation forbidden", ResponseFactory::FORBIDDEN],
  8784. 1015 => ["Operation '%s' not supported", ResponseFactory::METHOD_NOT_ALLOWED],
  8785. 1016 => ["Temporary or permanently blocked", ResponseFactory::FORBIDDEN],
  8786. 1017 => ["Bad or missing XSRF token", ResponseFactory::FORBIDDEN],
  8787. 1018 => ["Only AJAX requests allowed for '%s'", ResponseFactory::FORBIDDEN],
  8788. 1019 => ["Pagination forbidden", ResponseFactory::FORBIDDEN],
  8789. ];
  8790. public function __construct(int $code)
  8791. {
  8792. if (!isset($this->values[$code])) {
  8793. $code = 9999;
  8794. }
  8795. $this->code = $code;
  8796. $this->message = $this->values[$code][0];
  8797. $this->status = $this->values[$code][1];
  8798. }
  8799. public function getCode(): int
  8800. {
  8801. return $this->code;
  8802. }
  8803. public function getMessage(string $argument): string
  8804. {
  8805. return sprintf($this->message, $argument);
  8806. }
  8807. public function getStatus(): int
  8808. {
  8809. return $this->status;
  8810. }
  8811. }
  8812. }
  8813. // file: src/Tqdev/PhpCrudApi/Record/FilterInfo.php
  8814. namespace Tqdev\PhpCrudApi\Record {
  8815. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedTable;
  8816. use Tqdev\PhpCrudApi\Record\Condition\AndCondition;
  8817. use Tqdev\PhpCrudApi\Record\Condition\Condition;
  8818. use Tqdev\PhpCrudApi\Record\Condition\NoCondition;
  8819. use Tqdev\PhpCrudApi\Record\Condition\OrCondition;
  8820. class FilterInfo
  8821. {
  8822. private function addConditionFromFilterPath(PathTree $conditions, array $path, ReflectedTable $table, array $params)
  8823. {
  8824. $key = 'filter' . implode('', $path);
  8825. if (isset($params[$key])) {
  8826. foreach ($params[$key] as $filter) {
  8827. $condition = Condition::fromString($table, $filter);
  8828. if (($condition instanceof NoCondition) == false) {
  8829. $conditions->put($path, $condition);
  8830. }
  8831. }
  8832. }
  8833. }
  8834. private function getConditionsAsPathTree(ReflectedTable $table, array $params): PathTree
  8835. {
  8836. $conditions = new PathTree();
  8837. $this->addConditionFromFilterPath($conditions, [], $table, $params);
  8838. for ($n = ord('0'); $n <= ord('9'); $n++) {
  8839. $this->addConditionFromFilterPath($conditions, [chr($n)], $table, $params);
  8840. for ($l = ord('a'); $l <= ord('f'); $l++) {
  8841. $this->addConditionFromFilterPath($conditions, [chr($n), chr($l)], $table, $params);
  8842. }
  8843. }
  8844. return $conditions;
  8845. }
  8846. private function combinePathTreeOfConditions(PathTree $tree): Condition
  8847. {
  8848. $andConditions = $tree->getValues();
  8849. $and = AndCondition::fromArray($andConditions);
  8850. $orConditions = [];
  8851. foreach ($tree->getKeys() as $p) {
  8852. $orConditions[] = $this->combinePathTreeOfConditions($tree->get($p));
  8853. }
  8854. $or = OrCondition::fromArray($orConditions);
  8855. return $and->_and($or);
  8856. }
  8857. public function getCombinedConditions(ReflectedTable $table, array $params): Condition
  8858. {
  8859. return $this->combinePathTreeOfConditions($this->getConditionsAsPathTree($table, $params));
  8860. }
  8861. }
  8862. }
  8863. // file: src/Tqdev/PhpCrudApi/Record/HabtmValues.php
  8864. namespace Tqdev\PhpCrudApi\Record {
  8865. class HabtmValues
  8866. {
  8867. public $pkValues;
  8868. public $fkValues;
  8869. public function __construct(array $pkValues, array $fkValues)
  8870. {
  8871. $this->pkValues = $pkValues;
  8872. $this->fkValues = $fkValues;
  8873. }
  8874. }
  8875. }
  8876. // file: src/Tqdev/PhpCrudApi/Record/OrderingInfo.php
  8877. namespace Tqdev\PhpCrudApi\Record {
  8878. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedTable;
  8879. class OrderingInfo
  8880. {
  8881. public function getColumnOrdering(ReflectedTable $table, array $params): array
  8882. {
  8883. $fields = array();
  8884. if (isset($params['order'])) {
  8885. foreach ($params['order'] as $order) {
  8886. $parts = explode(',', $order, 3);
  8887. $columnName = $parts[0];
  8888. if (!$table->hasColumn($columnName)) {
  8889. continue;
  8890. }
  8891. $ascending = 'ASC';
  8892. if (count($parts) > 1) {
  8893. if (substr(strtoupper($parts[1]), 0, 4) == "DESC") {
  8894. $ascending = 'DESC';
  8895. }
  8896. }
  8897. $fields[] = [$columnName, $ascending];
  8898. }
  8899. }
  8900. if (count($fields) == 0) {
  8901. return $this->getDefaultColumnOrdering($table);
  8902. }
  8903. return $fields;
  8904. }
  8905. public function getDefaultColumnOrdering(ReflectedTable $table): array
  8906. {
  8907. $fields = array();
  8908. $pk = $table->getPk();
  8909. if ($pk) {
  8910. $fields[] = [$pk->getName(), 'ASC'];
  8911. } else {
  8912. foreach ($table->getColumnNames() as $columnName) {
  8913. $fields[] = [$columnName, 'ASC'];
  8914. }
  8915. }
  8916. return $fields;
  8917. }
  8918. }
  8919. }
  8920. // file: src/Tqdev/PhpCrudApi/Record/PaginationInfo.php
  8921. namespace Tqdev\PhpCrudApi\Record {
  8922. class PaginationInfo
  8923. {
  8924. public $DEFAULT_PAGE_SIZE = 20;
  8925. public function hasPage(array $params): bool
  8926. {
  8927. return isset($params['page']);
  8928. }
  8929. public function getPageOffset(array $params): int
  8930. {
  8931. $offset = 0;
  8932. $pageSize = $this->getPageSize($params);
  8933. if (isset($params['page'])) {
  8934. foreach ($params['page'] as $page) {
  8935. $parts = explode(',', $page, 2);
  8936. $page = intval($parts[0]) - 1;
  8937. $offset = $page * $pageSize;
  8938. }
  8939. }
  8940. return $offset;
  8941. }
  8942. private function getPageSize(array $params): int
  8943. {
  8944. $pageSize = $this->DEFAULT_PAGE_SIZE;
  8945. if (isset($params['page'])) {
  8946. foreach ($params['page'] as $page) {
  8947. $parts = explode(',', $page, 2);
  8948. if (count($parts) > 1) {
  8949. $pageSize = intval($parts[1]);
  8950. }
  8951. }
  8952. }
  8953. return $pageSize;
  8954. }
  8955. public function getResultSize(array $params): int
  8956. {
  8957. $numberOfRows = -1;
  8958. if (isset($params['size'])) {
  8959. foreach ($params['size'] as $size) {
  8960. $numberOfRows = intval($size);
  8961. }
  8962. }
  8963. return $numberOfRows;
  8964. }
  8965. public function getPageLimit(array $params): int
  8966. {
  8967. $pageLimit = -1;
  8968. if ($this->hasPage($params)) {
  8969. $pageLimit = $this->getPageSize($params);
  8970. }
  8971. $resultSize = $this->getResultSize($params);
  8972. if ($resultSize >= 0) {
  8973. if ($pageLimit >= 0) {
  8974. $pageLimit = min($pageLimit, $resultSize);
  8975. } else {
  8976. $pageLimit = $resultSize;
  8977. }
  8978. }
  8979. return $pageLimit;
  8980. }
  8981. }
  8982. }
  8983. // file: src/Tqdev/PhpCrudApi/Record/PathTree.php
  8984. namespace Tqdev\PhpCrudApi\Record {
  8985. class PathTree implements \JsonSerializable
  8986. {
  8987. const WILDCARD = '*';
  8988. private $tree;
  8989. public function __construct(/* object */&$tree = null)
  8990. {
  8991. if (!$tree) {
  8992. $tree = $this->newTree();
  8993. }
  8994. $this->tree = &$tree;
  8995. }
  8996. public function newTree()
  8997. {
  8998. return (object) ['values' => [], 'branches' => (object) []];
  8999. }
  9000. public function getKeys(): array
  9001. {
  9002. $branches = (array) $this->tree->branches;
  9003. return array_keys($branches);
  9004. }
  9005. public function getValues(): array
  9006. {
  9007. return $this->tree->values;
  9008. }
  9009. public function get(string $key): PathTree
  9010. {
  9011. if (!isset($this->tree->branches->$key)) {
  9012. return null;
  9013. }
  9014. return new PathTree($this->tree->branches->$key);
  9015. }
  9016. public function put(array $path, $value)
  9017. {
  9018. $tree = &$this->tree;
  9019. foreach ($path as $key) {
  9020. if (!isset($tree->branches->$key)) {
  9021. $tree->branches->$key = $this->newTree();
  9022. }
  9023. $tree = &$tree->branches->$key;
  9024. }
  9025. $tree->values[] = $value;
  9026. }
  9027. public function match(array $path): array
  9028. {
  9029. $star = self::WILDCARD;
  9030. $tree = &$this->tree;
  9031. foreach ($path as $key) {
  9032. if (isset($tree->branches->$key)) {
  9033. $tree = &$tree->branches->$key;
  9034. } elseif (isset($tree->branches->$star)) {
  9035. $tree = &$tree->branches->$star;
  9036. } else {
  9037. return [];
  9038. }
  9039. }
  9040. return $tree->values;
  9041. }
  9042. public static function fromJson(/* object */$tree): PathTree
  9043. {
  9044. return new PathTree($tree);
  9045. }
  9046. public function jsonSerialize()
  9047. {
  9048. return $this->tree;
  9049. }
  9050. }
  9051. }
  9052. // file: src/Tqdev/PhpCrudApi/Record/RecordService.php
  9053. namespace Tqdev\PhpCrudApi\Record {
  9054. use Tqdev\PhpCrudApi\Column\ReflectionService;
  9055. use Tqdev\PhpCrudApi\Database\GenericDB;
  9056. use Tqdev\PhpCrudApi\Record\Document\ListDocument;
  9057. class RecordService
  9058. {
  9059. private $db;
  9060. private $reflection;
  9061. private $columns;
  9062. private $joiner;
  9063. private $filters;
  9064. private $ordering;
  9065. private $pagination;
  9066. public function __construct(GenericDB $db, ReflectionService $reflection)
  9067. {
  9068. $this->db = $db;
  9069. $this->reflection = $reflection;
  9070. $this->columns = new ColumnIncluder();
  9071. $this->joiner = new RelationJoiner($reflection, $this->columns);
  9072. $this->filters = new FilterInfo();
  9073. $this->ordering = new OrderingInfo();
  9074. $this->pagination = new PaginationInfo();
  9075. }
  9076. private function sanitizeRecord(string $tableName, /* object */ $record, string $id)
  9077. {
  9078. $keyset = array_keys((array) $record);
  9079. foreach ($keyset as $key) {
  9080. if (!$this->reflection->getTable($tableName)->hasColumn($key)) {
  9081. unset($record->$key);
  9082. }
  9083. }
  9084. if ($id != '') {
  9085. $pk = $this->reflection->getTable($tableName)->getPk();
  9086. foreach ($this->reflection->getTable($tableName)->getColumnNames() as $key) {
  9087. $field = $this->reflection->getTable($tableName)->getColumn($key);
  9088. if ($field->getName() == $pk->getName()) {
  9089. unset($record->$key);
  9090. }
  9091. }
  9092. }
  9093. }
  9094. public function hasTable(string $table): bool
  9095. {
  9096. return $this->reflection->hasTable($table);
  9097. }
  9098. public function getType(string $table): string
  9099. {
  9100. return $this->reflection->getType($table);
  9101. }
  9102. public function create(string $tableName, /* object */ $record, array $params) /*: ?int*/
  9103. {
  9104. $this->sanitizeRecord($tableName, $record, '');
  9105. $table = $this->reflection->getTable($tableName);
  9106. $columnValues = $this->columns->getValues($table, true, $record, $params);
  9107. return $this->db->createSingle($table, $columnValues);
  9108. }
  9109. public function read(string $tableName, string $id, array $params) /*: ?object*/
  9110. {
  9111. $table = $this->reflection->getTable($tableName);
  9112. $this->joiner->addMandatoryColumns($table, $params);
  9113. $columnNames = $this->columns->getNames($table, true, $params);
  9114. $record = $this->db->selectSingle($table, $columnNames, $id);
  9115. if ($record == null) {
  9116. return null;
  9117. }
  9118. $records = array($record);
  9119. $this->joiner->addJoins($table, $records, $params, $this->db);
  9120. return $records[0];
  9121. }
  9122. public function update(string $tableName, string $id, /* object */ $record, array $params) /*: ?int*/
  9123. {
  9124. $this->sanitizeRecord($tableName, $record, $id);
  9125. $table = $this->reflection->getTable($tableName);
  9126. $columnValues = $this->columns->getValues($table, true, $record, $params);
  9127. return $this->db->updateSingle($table, $columnValues, $id);
  9128. }
  9129. public function delete(string $tableName, string $id, array $params) /*: ?int*/
  9130. {
  9131. $table = $this->reflection->getTable($tableName);
  9132. return $this->db->deleteSingle($table, $id);
  9133. }
  9134. public function increment(string $tableName, string $id, /* object */ $record, array $params) /*: ?int*/
  9135. {
  9136. $this->sanitizeRecord($tableName, $record, $id);
  9137. $table = $this->reflection->getTable($tableName);
  9138. $columnValues = $this->columns->getValues($table, true, $record, $params);
  9139. return $this->db->incrementSingle($table, $columnValues, $id);
  9140. }
  9141. public function _list(string $tableName, array $params): ListDocument
  9142. {
  9143. $table = $this->reflection->getTable($tableName);
  9144. $this->joiner->addMandatoryColumns($table, $params);
  9145. $columnNames = $this->columns->getNames($table, true, $params);
  9146. $condition = $this->filters->getCombinedConditions($table, $params);
  9147. $columnOrdering = $this->ordering->getColumnOrdering($table, $params);
  9148. if (!$this->pagination->hasPage($params)) {
  9149. $offset = 0;
  9150. $limit = $this->pagination->getPageLimit($params);
  9151. $count = 0;
  9152. } else {
  9153. $offset = $this->pagination->getPageOffset($params);
  9154. $limit = $this->pagination->getPageLimit($params);
  9155. $count = $this->db->selectCount($table, $condition);
  9156. }
  9157. $records = $this->db->selectAll($table, $columnNames, $condition, $columnOrdering, $offset, $limit);
  9158. $this->joiner->addJoins($table, $records, $params, $this->db);
  9159. return new ListDocument($records, $count);
  9160. }
  9161. }
  9162. }
  9163. // file: src/Tqdev/PhpCrudApi/Record/RelationJoiner.php
  9164. namespace Tqdev\PhpCrudApi\Record {
  9165. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedTable;
  9166. use Tqdev\PhpCrudApi\Column\ReflectionService;
  9167. use Tqdev\PhpCrudApi\Database\GenericDB;
  9168. use Tqdev\PhpCrudApi\Middleware\Communication\VariableStore;
  9169. use Tqdev\PhpCrudApi\Record\Condition\ColumnCondition;
  9170. use Tqdev\PhpCrudApi\Record\Condition\OrCondition;
  9171. class RelationJoiner
  9172. {
  9173. private $reflection;
  9174. private $ordering;
  9175. private $columns;
  9176. public function __construct(ReflectionService $reflection, ColumnIncluder $columns)
  9177. {
  9178. $this->reflection = $reflection;
  9179. $this->ordering = new OrderingInfo();
  9180. $this->columns = $columns;
  9181. }
  9182. public function addMandatoryColumns(ReflectedTable $table, array &$params) /*: void*/
  9183. {
  9184. if (!isset($params['join']) || !isset($params['include'])) {
  9185. return;
  9186. }
  9187. $params['mandatory'] = array();
  9188. foreach ($params['join'] as $tableNames) {
  9189. $t1 = $table;
  9190. foreach (explode(',', $tableNames) as $tableName) {
  9191. if (!$this->reflection->hasTable($tableName)) {
  9192. continue;
  9193. }
  9194. $t2 = $this->reflection->getTable($tableName);
  9195. $fks1 = $t1->getFksTo($t2->getName());
  9196. $t3 = $this->hasAndBelongsToMany($t1, $t2);
  9197. if ($t3 != null || count($fks1) > 0) {
  9198. $params['mandatory'][] = $t2->getName() . '.' . $t2->getPk()->getName();
  9199. }
  9200. foreach ($fks1 as $fk) {
  9201. $params['mandatory'][] = $t1->getName() . '.' . $fk->getName();
  9202. }
  9203. $fks2 = $t2->getFksTo($t1->getName());
  9204. if ($t3 != null || count($fks2) > 0) {
  9205. $params['mandatory'][] = $t1->getName() . '.' . $t1->getPk()->getName();
  9206. }
  9207. foreach ($fks2 as $fk) {
  9208. $params['mandatory'][] = $t2->getName() . '.' . $fk->getName();
  9209. }
  9210. $t1 = $t2;
  9211. }
  9212. }
  9213. }
  9214. private function getJoinsAsPathTree(array $params): PathTree
  9215. {
  9216. $joins = new PathTree();
  9217. if (isset($params['join'])) {
  9218. foreach ($params['join'] as $tableNames) {
  9219. $path = array();
  9220. foreach (explode(',', $tableNames) as $tableName) {
  9221. if (!$this->reflection->hasTable($tableName)) {
  9222. continue;
  9223. }
  9224. $t = $this->reflection->getTable($tableName);
  9225. if ($t != null) {
  9226. $path[] = $t->getName();
  9227. }
  9228. }
  9229. $joins->put($path, true);
  9230. }
  9231. }
  9232. return $joins;
  9233. }
  9234. public function addJoins(ReflectedTable $table, array &$records, array $params, GenericDB $db) /*: void*/
  9235. {
  9236. $joins = $this->getJoinsAsPathTree($params);
  9237. $this->addJoinsForTables($table, $joins, $records, $params, $db);
  9238. }
  9239. private function hasAndBelongsToMany(ReflectedTable $t1, ReflectedTable $t2) /*: ?ReflectedTable*/
  9240. {
  9241. foreach ($this->reflection->getTableNames() as $tableName) {
  9242. $t3 = $this->reflection->getTable($tableName);
  9243. if (count($t3->getFksTo($t1->getName())) > 0 && count($t3->getFksTo($t2->getName())) > 0) {
  9244. return $t3;
  9245. }
  9246. }
  9247. return null;
  9248. }
  9249. private function addJoinsForTables(ReflectedTable $t1, PathTree $joins, array &$records, array $params, GenericDB $db)
  9250. {
  9251. foreach ($joins->getKeys() as $t2Name) {
  9252. $t2 = $this->reflection->getTable($t2Name);
  9253. $belongsTo = count($t1->getFksTo($t2->getName())) > 0;
  9254. $hasMany = count($t2->getFksTo($t1->getName())) > 0;
  9255. if (!$belongsTo && !$hasMany) {
  9256. $t3 = $this->hasAndBelongsToMany($t1, $t2);
  9257. } else {
  9258. $t3 = null;
  9259. }
  9260. $hasAndBelongsToMany = ($t3 != null);
  9261. $newRecords = array();
  9262. $fkValues = null;
  9263. $pkValues = null;
  9264. $habtmValues = null;
  9265. if ($belongsTo) {
  9266. $fkValues = $this->getFkEmptyValues($t1, $t2, $records);
  9267. $this->addFkRecords($t2, $fkValues, $params, $db, $newRecords);
  9268. }
  9269. if ($hasMany) {
  9270. $pkValues = $this->getPkEmptyValues($t1, $records);
  9271. $this->addPkRecords($t1, $t2, $pkValues, $params, $db, $newRecords);
  9272. }
  9273. if ($hasAndBelongsToMany) {
  9274. $habtmValues = $this->getHabtmEmptyValues($t1, $t2, $t3, $db, $records);
  9275. $this->addFkRecords($t2, $habtmValues->fkValues, $params, $db, $newRecords);
  9276. }
  9277. $this->addJoinsForTables($t2, $joins->get($t2Name), $newRecords, $params, $db);
  9278. if ($fkValues != null) {
  9279. $this->fillFkValues($t2, $newRecords, $fkValues);
  9280. $this->setFkValues($t1, $t2, $records, $fkValues);
  9281. }
  9282. if ($pkValues != null) {
  9283. $this->fillPkValues($t1, $t2, $newRecords, $pkValues);
  9284. $this->setPkValues($t1, $t2, $records, $pkValues);
  9285. }
  9286. if ($habtmValues != null) {
  9287. $this->fillFkValues($t2, $newRecords, $habtmValues->fkValues);
  9288. $this->setHabtmValues($t1, $t2, $records, $habtmValues);
  9289. }
  9290. }
  9291. }
  9292. private function getFkEmptyValues(ReflectedTable $t1, ReflectedTable $t2, array $records): array
  9293. {
  9294. $fkValues = array();
  9295. $fks = $t1->getFksTo($t2->getName());
  9296. foreach ($fks as $fk) {
  9297. $fkName = $fk->getName();
  9298. foreach ($records as $record) {
  9299. if (isset($record[$fkName])) {
  9300. $fkValue = $record[$fkName];
  9301. $fkValues[$fkValue] = null;
  9302. }
  9303. }
  9304. }
  9305. return $fkValues;
  9306. }
  9307. private function addFkRecords(ReflectedTable $t2, array $fkValues, array $params, GenericDB $db, array &$records) /*: void*/
  9308. {
  9309. $columnNames = $this->columns->getNames($t2, false, $params);
  9310. $fkIds = array_keys($fkValues);
  9311. foreach ($db->selectMultiple($t2, $columnNames, $fkIds) as $record) {
  9312. $records[] = $record;
  9313. }
  9314. }
  9315. private function fillFkValues(ReflectedTable $t2, array $fkRecords, array &$fkValues) /*: void*/
  9316. {
  9317. $pkName = $t2->getPk()->getName();
  9318. foreach ($fkRecords as $fkRecord) {
  9319. $pkValue = $fkRecord[$pkName];
  9320. $fkValues[$pkValue] = $fkRecord;
  9321. }
  9322. }
  9323. private function setFkValues(ReflectedTable $t1, ReflectedTable $t2, array &$records, array $fkValues) /*: void*/
  9324. {
  9325. $fks = $t1->getFksTo($t2->getName());
  9326. foreach ($fks as $fk) {
  9327. $fkName = $fk->getName();
  9328. foreach ($records as $i => $record) {
  9329. if (isset($record[$fkName])) {
  9330. $key = $record[$fkName];
  9331. $records[$i][$fkName] = $fkValues[$key];
  9332. }
  9333. }
  9334. }
  9335. }
  9336. private function getPkEmptyValues(ReflectedTable $t1, array $records): array
  9337. {
  9338. $pkValues = array();
  9339. $pkName = $t1->getPk()->getName();
  9340. foreach ($records as $record) {
  9341. $key = $record[$pkName];
  9342. $pkValues[$key] = array();
  9343. }
  9344. return $pkValues;
  9345. }
  9346. private function addPkRecords(ReflectedTable $t1, ReflectedTable $t2, array $pkValues, array $params, GenericDB $db, array &$records) /*: void*/
  9347. {
  9348. $fks = $t2->getFksTo($t1->getName());
  9349. $columnNames = $this->columns->getNames($t2, false, $params);
  9350. $pkValueKeys = implode(',', array_keys($pkValues));
  9351. $conditions = array();
  9352. foreach ($fks as $fk) {
  9353. $conditions[] = new ColumnCondition($fk, 'in', $pkValueKeys);
  9354. }
  9355. $condition = OrCondition::fromArray($conditions);
  9356. $columnOrdering = array();
  9357. $limit = VariableStore::get("joinLimits.maxRecords") ?: -1;
  9358. if ($limit != -1) {
  9359. $columnOrdering = $this->ordering->getDefaultColumnOrdering($t2);
  9360. }
  9361. foreach ($db->selectAll($t2, $columnNames, $condition, $columnOrdering, 0, $limit) as $record) {
  9362. $records[] = $record;
  9363. }
  9364. }
  9365. private function fillPkValues(ReflectedTable $t1, ReflectedTable $t2, array $pkRecords, array &$pkValues) /*: void*/
  9366. {
  9367. $fks = $t2->getFksTo($t1->getName());
  9368. foreach ($fks as $fk) {
  9369. $fkName = $fk->getName();
  9370. foreach ($pkRecords as $pkRecord) {
  9371. $key = $pkRecord[$fkName];
  9372. if (isset($pkValues[$key])) {
  9373. $pkValues[$key][] = $pkRecord;
  9374. }
  9375. }
  9376. }
  9377. }
  9378. private function setPkValues(ReflectedTable $t1, ReflectedTable $t2, array &$records, array $pkValues) /*: void*/
  9379. {
  9380. $pkName = $t1->getPk()->getName();
  9381. $t2Name = $t2->getName();
  9382. foreach ($records as $i => $record) {
  9383. $key = $record[$pkName];
  9384. $records[$i][$t2Name] = $pkValues[$key];
  9385. }
  9386. }
  9387. private function getHabtmEmptyValues(ReflectedTable $t1, ReflectedTable $t2, ReflectedTable $t3, GenericDB $db, array $records): HabtmValues
  9388. {
  9389. $pkValues = $this->getPkEmptyValues($t1, $records);
  9390. $fkValues = array();
  9391. $fk1 = $t3->getFksTo($t1->getName())[0];
  9392. $fk2 = $t3->getFksTo($t2->getName())[0];
  9393. $fk1Name = $fk1->getName();
  9394. $fk2Name = $fk2->getName();
  9395. $columnNames = array($fk1Name, $fk2Name);
  9396. $pkIds = implode(',', array_keys($pkValues));
  9397. $condition = new ColumnCondition($t3->getColumn($fk1Name), 'in', $pkIds);
  9398. $columnOrdering = array();
  9399. $limit = VariableStore::get("joinLimits.maxRecords") ?: -1;
  9400. if ($limit != -1) {
  9401. $columnOrdering = $this->ordering->getDefaultColumnOrdering($t3);
  9402. }
  9403. $records = $db->selectAll($t3, $columnNames, $condition, $columnOrdering, 0, $limit);
  9404. foreach ($records as $record) {
  9405. $val1 = $record[$fk1Name];
  9406. $val2 = $record[$fk2Name];
  9407. $pkValues[$val1][] = $val2;
  9408. $fkValues[$val2] = null;
  9409. }
  9410. return new HabtmValues($pkValues, $fkValues);
  9411. }
  9412. private function setHabtmValues(ReflectedTable $t1, ReflectedTable $t2, array &$records, HabtmValues $habtmValues) /*: void*/
  9413. {
  9414. $pkName = $t1->getPk()->getName();
  9415. $t2Name = $t2->getName();
  9416. foreach ($records as $i => $record) {
  9417. $key = $record[$pkName];
  9418. $val = array();
  9419. $fks = $habtmValues->pkValues[$key];
  9420. foreach ($fks as $fk) {
  9421. $val[] = $habtmValues->fkValues[$fk];
  9422. }
  9423. $records[$i][$t2Name] = $val;
  9424. }
  9425. }
  9426. }
  9427. }
  9428. // file: src/Tqdev/PhpCrudApi/Api.php
  9429. namespace Tqdev\PhpCrudApi {
  9430. use Psr\Http\Message\ResponseInterface;
  9431. use Psr\Http\Message\ServerRequestInterface;
  9432. use Psr\Http\Server\RequestHandlerInterface;
  9433. use Tqdev\PhpCrudApi\Cache\CacheFactory;
  9434. use Tqdev\PhpCrudApi\Column\DefinitionService;
  9435. use Tqdev\PhpCrudApi\Column\ReflectionService;
  9436. use Tqdev\PhpCrudApi\Controller\CacheController;
  9437. use Tqdev\PhpCrudApi\Controller\ColumnController;
  9438. use Tqdev\PhpCrudApi\Controller\GeoJsonController;
  9439. use Tqdev\PhpCrudApi\Controller\JsonResponder;
  9440. use Tqdev\PhpCrudApi\Controller\OpenApiController;
  9441. use Tqdev\PhpCrudApi\Controller\RecordController;
  9442. use Tqdev\PhpCrudApi\Database\GenericDB;
  9443. use Tqdev\PhpCrudApi\GeoJson\GeoJsonService;
  9444. use Tqdev\PhpCrudApi\Middleware\AuthorizationMiddleware;
  9445. use Tqdev\PhpCrudApi\Middleware\BasicAuthMiddleware;
  9446. use Tqdev\PhpCrudApi\Middleware\CorsMiddleware;
  9447. use Tqdev\PhpCrudApi\Middleware\CustomizationMiddleware;
  9448. use Tqdev\PhpCrudApi\Middleware\DbAuthMiddleware;
  9449. use Tqdev\PhpCrudApi\Middleware\FirewallMiddleware;
  9450. use Tqdev\PhpCrudApi\Middleware\IpAddressMiddleware;
  9451. use Tqdev\PhpCrudApi\Middleware\JoinLimitsMiddleware;
  9452. use Tqdev\PhpCrudApi\Middleware\JwtAuthMiddleware;
  9453. use Tqdev\PhpCrudApi\Middleware\MultiTenancyMiddleware;
  9454. use Tqdev\PhpCrudApi\Middleware\PageLimitsMiddleware;
  9455. use Tqdev\PhpCrudApi\Middleware\ReconnectMiddleware;
  9456. use Tqdev\PhpCrudApi\Middleware\Router\SimpleRouter;
  9457. use Tqdev\PhpCrudApi\Middleware\SanitationMiddleware;
  9458. use Tqdev\PhpCrudApi\Middleware\SslRedirectMiddleware;
  9459. use Tqdev\PhpCrudApi\Middleware\ValidationMiddleware;
  9460. use Tqdev\PhpCrudApi\Middleware\XmlMiddleware;
  9461. use Tqdev\PhpCrudApi\Middleware\XsrfMiddleware;
  9462. use Tqdev\PhpCrudApi\OpenApi\OpenApiService;
  9463. use Tqdev\PhpCrudApi\Record\ErrorCode;
  9464. use Tqdev\PhpCrudApi\Record\RecordService;
  9465. use Tqdev\PhpCrudApi\ResponseUtils;
  9466. class Api implements RequestHandlerInterface
  9467. {
  9468. private $router;
  9469. private $responder;
  9470. private $debug;
  9471. public function __construct(Config $config)
  9472. {
  9473. $db = new GenericDB(
  9474. $config->getDriver(),
  9475. $config->getAddress(),
  9476. $config->getPort(),
  9477. $config->getDatabase(),
  9478. $config->getTables(),
  9479. $config->getUsername(),
  9480. $config->getPassword()
  9481. );
  9482. $prefix = sprintf('phpcrudapi-%s-', substr(md5(__FILE__), 0, 8));
  9483. $cache = CacheFactory::create($config->getCacheType(), $prefix, $config->getCachePath());
  9484. $reflection = new ReflectionService($db, $cache, $config->getCacheTime());
  9485. $responder = new JsonResponder();
  9486. $router = new SimpleRouter($config->getBasePath(), $responder, $cache, $config->getCacheTime(), $config->getDebug());
  9487. foreach ($config->getMiddlewares() as $middleware => $properties) {
  9488. switch ($middleware) {
  9489. case 'sslRedirect':
  9490. new SslRedirectMiddleware($router, $responder, $properties);
  9491. break;
  9492. case 'cors':
  9493. new CorsMiddleware($router, $responder, $properties);
  9494. break;
  9495. case 'firewall':
  9496. new FirewallMiddleware($router, $responder, $properties);
  9497. break;
  9498. case 'basicAuth':
  9499. new BasicAuthMiddleware($router, $responder, $properties);
  9500. break;
  9501. case 'jwtAuth':
  9502. new JwtAuthMiddleware($router, $responder, $properties);
  9503. break;
  9504. case 'dbAuth':
  9505. new DbAuthMiddleware($router, $responder, $properties, $reflection, $db);
  9506. break;
  9507. case 'reconnect':
  9508. new ReconnectMiddleware($router, $responder, $properties, $reflection, $db);
  9509. break;
  9510. case 'validation':
  9511. new ValidationMiddleware($router, $responder, $properties, $reflection);
  9512. break;
  9513. case 'ipAddress':
  9514. new IpAddressMiddleware($router, $responder, $properties, $reflection);
  9515. break;
  9516. case 'sanitation':
  9517. new SanitationMiddleware($router, $responder, $properties, $reflection);
  9518. break;
  9519. case 'multiTenancy':
  9520. new MultiTenancyMiddleware($router, $responder, $properties, $reflection);
  9521. break;
  9522. case 'authorization':
  9523. new AuthorizationMiddleware($router, $responder, $properties, $reflection);
  9524. break;
  9525. case 'xsrf':
  9526. new XsrfMiddleware($router, $responder, $properties);
  9527. break;
  9528. case 'pageLimits':
  9529. new PageLimitsMiddleware($router, $responder, $properties, $reflection);
  9530. break;
  9531. case 'joinLimits':
  9532. new JoinLimitsMiddleware($router, $responder, $properties, $reflection);
  9533. break;
  9534. case 'customization':
  9535. new CustomizationMiddleware($router, $responder, $properties, $reflection);
  9536. break;
  9537. case 'xml':
  9538. new XmlMiddleware($router, $responder, $properties, $reflection);
  9539. break;
  9540. }
  9541. }
  9542. foreach ($config->getControllers() as $controller) {
  9543. switch ($controller) {
  9544. case 'records':
  9545. $records = new RecordService($db, $reflection);
  9546. new RecordController($router, $responder, $records);
  9547. break;
  9548. case 'columns':
  9549. $definition = new DefinitionService($db, $reflection);
  9550. new ColumnController($router, $responder, $reflection, $definition);
  9551. break;
  9552. case 'cache':
  9553. new CacheController($router, $responder, $cache);
  9554. break;
  9555. case 'openapi':
  9556. $openApi = new OpenApiService($reflection, $config->getOpenApiBase(), $config->getControllers(), $config->getCustomOpenApiBuilders());
  9557. new OpenApiController($router, $responder, $openApi);
  9558. break;
  9559. case 'geojson':
  9560. $records = new RecordService($db, $reflection);
  9561. $geoJson = new GeoJsonService($reflection, $records);
  9562. new GeoJsonController($router, $responder, $geoJson);
  9563. break;
  9564. }
  9565. }
  9566. foreach ($config->getCustomControllers() as $className) {
  9567. if (class_exists($className)) {
  9568. $records = new RecordService($db, $reflection);
  9569. new $className($router, $responder, $records);
  9570. }
  9571. }
  9572. $this->router = $router;
  9573. $this->responder = $responder;
  9574. $this->debug = $config->getDebug();
  9575. }
  9576. private function parseBody(string $body) /*: ?object*/
  9577. {
  9578. $first = substr($body, 0, 1);
  9579. if ($first == '[' || $first == '{') {
  9580. $object = json_decode($body);
  9581. $causeCode = json_last_error();
  9582. if ($causeCode !== JSON_ERROR_NONE) {
  9583. $object = null;
  9584. }
  9585. } else {
  9586. parse_str($body, $input);
  9587. foreach ($input as $key => $value) {
  9588. if (substr($key, -9) == '__is_null') {
  9589. $input[substr($key, 0, -9)] = null;
  9590. unset($input[$key]);
  9591. }
  9592. }
  9593. $object = (object) $input;
  9594. }
  9595. return $object;
  9596. }
  9597. private function addParsedBody(ServerRequestInterface $request): ServerRequestInterface
  9598. {
  9599. $parsedBody = $request->getParsedBody();
  9600. if ($parsedBody) {
  9601. $request = $this->applyParsedBodyHack($request);
  9602. } else {
  9603. $body = $request->getBody();
  9604. if ($body->isReadable()) {
  9605. if ($body->isSeekable()) {
  9606. $body->rewind();
  9607. }
  9608. $contents = $body->getContents();
  9609. if ($body->isSeekable()) {
  9610. $body->rewind();
  9611. }
  9612. if ($contents) {
  9613. $parsedBody = $this->parseBody($contents);
  9614. $request = $request->withParsedBody($parsedBody);
  9615. }
  9616. }
  9617. }
  9618. return $request;
  9619. }
  9620. private function applyParsedBodyHack(ServerRequestInterface $request): ServerRequestInterface
  9621. {
  9622. $parsedBody = $request->getParsedBody();
  9623. if (is_array($parsedBody)) { // is it really?
  9624. $contents = json_encode($parsedBody);
  9625. $parsedBody = $this->parseBody($contents);
  9626. $request = $request->withParsedBody($parsedBody);
  9627. }
  9628. return $request;
  9629. }
  9630. public function handle(ServerRequestInterface $request): ResponseInterface
  9631. {
  9632. $response = null;
  9633. try {
  9634. $response = $this->router->route($this->addParsedBody($request));
  9635. } catch (\Throwable $e) {
  9636. $response = $this->responder->error(ErrorCode::ERROR_NOT_FOUND, $e->getMessage());
  9637. if ($this->debug) {
  9638. $response = ResponseUtils::addExceptionHeaders($response, $e);
  9639. }
  9640. }
  9641. return $response;
  9642. }
  9643. }
  9644. }
  9645. // file: src/Tqdev/PhpCrudApi/Config.php
  9646. namespace Tqdev\PhpCrudApi {
  9647. class Config
  9648. {
  9649. private $values = [
  9650. 'driver' => null,
  9651. 'address' => 'localhost',
  9652. 'port' => null,
  9653. 'username' => null,
  9654. 'password' => null,
  9655. 'database' => null,
  9656. 'tables' => '',
  9657. 'middlewares' => 'cors',
  9658. 'controllers' => 'records,geojson,openapi',
  9659. 'customControllers' => '',
  9660. 'customOpenApiBuilders' => '',
  9661. 'cacheType' => 'TempFile',
  9662. 'cachePath' => '',
  9663. 'cacheTime' => 10,
  9664. 'debug' => false,
  9665. 'basePath' => '',
  9666. 'openApiBase' => '{"info":{"title":"PHP-CRUD-API","version":"1.0.0"}}',
  9667. ];
  9668. private function getDefaultDriver(array $values): string
  9669. {
  9670. if (isset($values['driver'])) {
  9671. return $values['driver'];
  9672. }
  9673. return 'mysql';
  9674. }
  9675. private function getDefaultPort(string $driver): int
  9676. {
  9677. switch ($driver) {
  9678. case 'mysql':
  9679. return 3306;
  9680. case 'pgsql':
  9681. return 5432;
  9682. case 'sqlsrv':
  9683. return 1433;
  9684. case 'sqlite':
  9685. return 0;
  9686. }
  9687. }
  9688. private function getDefaultAddress(string $driver): string
  9689. {
  9690. switch ($driver) {
  9691. case 'mysql':
  9692. return 'localhost';
  9693. case 'pgsql':
  9694. return 'localhost';
  9695. case 'sqlsrv':
  9696. return 'localhost';
  9697. case 'sqlite':
  9698. return 'data.db';
  9699. }
  9700. }
  9701. private function getDriverDefaults(string $driver): array
  9702. {
  9703. return [
  9704. 'driver' => $driver,
  9705. 'address' => $this->getDefaultAddress($driver),
  9706. 'port' => $this->getDefaultPort($driver),
  9707. ];
  9708. }
  9709. public function __construct(array $values)
  9710. {
  9711. $driver = $this->getDefaultDriver($values);
  9712. $defaults = $this->getDriverDefaults($driver);
  9713. $newValues = array_merge($this->values, $defaults, $values);
  9714. $newValues = $this->parseMiddlewares($newValues);
  9715. $diff = array_diff_key($newValues, $this->values);
  9716. if (!empty($diff)) {
  9717. $key = array_keys($diff)[0];
  9718. throw new \Exception("Config has invalid value '$key'");
  9719. }
  9720. $this->values = $newValues;
  9721. }
  9722. private function parseMiddlewares(array $values): array
  9723. {
  9724. $newValues = array();
  9725. $properties = array();
  9726. $middlewares = array_map('trim', explode(',', $values['middlewares']));
  9727. foreach ($middlewares as $middleware) {
  9728. $properties[$middleware] = [];
  9729. }
  9730. foreach ($values as $key => $value) {
  9731. if (strpos($key, '.') === false) {
  9732. $newValues[$key] = $value;
  9733. } else {
  9734. list($middleware, $key2) = explode('.', $key, 2);
  9735. if (isset($properties[$middleware])) {
  9736. $properties[$middleware][$key2] = $value;
  9737. } else {
  9738. throw new \Exception("Config has invalid value '$key'");
  9739. }
  9740. }
  9741. }
  9742. $newValues['middlewares'] = array_reverse($properties, true);
  9743. return $newValues;
  9744. }
  9745. public function getDriver(): string
  9746. {
  9747. return $this->values['driver'];
  9748. }
  9749. public function getAddress(): string
  9750. {
  9751. return $this->values['address'];
  9752. }
  9753. public function getPort(): int
  9754. {
  9755. return $this->values['port'];
  9756. }
  9757. public function getUsername(): string
  9758. {
  9759. return $this->values['username'];
  9760. }
  9761. public function getPassword(): string
  9762. {
  9763. return $this->values['password'];
  9764. }
  9765. public function getDatabase(): string
  9766. {
  9767. return $this->values['database'];
  9768. }
  9769. public function getTables(): array
  9770. {
  9771. return array_filter(array_map('trim', explode(',', $this->values['tables'])));
  9772. }
  9773. public function getMiddlewares(): array
  9774. {
  9775. return $this->values['middlewares'];
  9776. }
  9777. public function getControllers(): array
  9778. {
  9779. return array_filter(array_map('trim', explode(',', $this->values['controllers'])));
  9780. }
  9781. public function getCustomControllers(): array
  9782. {
  9783. return array_filter(array_map('trim', explode(',', $this->values['customControllers'])));
  9784. }
  9785. public function getCustomOpenApiBuilders(): array
  9786. {
  9787. return array_filter(array_map('trim', explode(',', $this->values['customOpenApiBuilders'])));
  9788. }
  9789. public function getCacheType(): string
  9790. {
  9791. return $this->values['cacheType'];
  9792. }
  9793. public function getCachePath(): string
  9794. {
  9795. return $this->values['cachePath'];
  9796. }
  9797. public function getCacheTime(): int
  9798. {
  9799. return $this->values['cacheTime'];
  9800. }
  9801. public function getDebug(): bool
  9802. {
  9803. return $this->values['debug'];
  9804. }
  9805. public function getBasePath(): string
  9806. {
  9807. return $this->values['basePath'];
  9808. }
  9809. public function getOpenApiBase(): array
  9810. {
  9811. return json_decode($this->values['openApiBase'], true);
  9812. }
  9813. }
  9814. }
  9815. // file: src/Tqdev/PhpCrudApi/RequestFactory.php
  9816. namespace Tqdev\PhpCrudApi {
  9817. use Nyholm\Psr7\Factory\Psr17Factory;
  9818. use Nyholm\Psr7Server\ServerRequestCreator;
  9819. use Psr\Http\Message\ServerRequestInterface;
  9820. class RequestFactory
  9821. {
  9822. public static function fromGlobals(): ServerRequestInterface
  9823. {
  9824. $psr17Factory = new Psr17Factory();
  9825. $creator = new ServerRequestCreator($psr17Factory, $psr17Factory, $psr17Factory, $psr17Factory);
  9826. $serverRequest = $creator->fromGlobals();
  9827. $stream = $psr17Factory->createStreamFromFile('php://input');
  9828. $serverRequest = $serverRequest->withBody($stream);
  9829. return $serverRequest;
  9830. }
  9831. public static function fromString(string $request): ServerRequestInterface
  9832. {
  9833. $parts = explode("\n\n", trim($request), 2);
  9834. $lines = explode("\n", $parts[0]);
  9835. $first = explode(' ', trim(array_shift($lines)), 2);
  9836. $method = $first[0];
  9837. $body = isset($parts[1]) ? $parts[1] : '';
  9838. $url = isset($first[1]) ? $first[1] : '';
  9839. $psr17Factory = new Psr17Factory();
  9840. $serverRequest = $psr17Factory->createServerRequest($method, $url);
  9841. foreach ($lines as $line) {
  9842. list($key, $value) = explode(':', $line, 2);
  9843. $serverRequest = $serverRequest->withAddedHeader($key, $value);
  9844. }
  9845. if ($body) {
  9846. $stream = $psr17Factory->createStream($body);
  9847. $stream->rewind();
  9848. $serverRequest = $serverRequest->withBody($stream);
  9849. }
  9850. return $serverRequest;
  9851. }
  9852. }
  9853. }
  9854. // file: src/Tqdev/PhpCrudApi/RequestUtils.php
  9855. namespace Tqdev\PhpCrudApi {
  9856. use Psr\Http\Message\ServerRequestInterface;
  9857. use Tqdev\PhpCrudApi\Column\ReflectionService;
  9858. class RequestUtils
  9859. {
  9860. public static function setParams(ServerRequestInterface $request, array $params): ServerRequestInterface
  9861. {
  9862. $query = preg_replace('|%5B[0-9]+%5D=|', '=', http_build_query($params));
  9863. return $request->withUri($request->getUri()->withQuery($query));
  9864. }
  9865. public static function getHeader(ServerRequestInterface $request, string $header): string
  9866. {
  9867. $headers = $request->getHeader($header);
  9868. return isset($headers[0]) ? $headers[0] : '';
  9869. }
  9870. public static function getParams(ServerRequestInterface $request): array
  9871. {
  9872. $params = array();
  9873. $query = $request->getUri()->getQuery();
  9874. //$query = str_replace('][]=', ']=', str_replace('=', '[]=', $query));
  9875. $query = str_replace('%5D%5B%5D=', '%5D=', str_replace('=', '%5B%5D=', $query));
  9876. parse_str($query, $params);
  9877. return $params;
  9878. }
  9879. public static function getPathSegment(ServerRequestInterface $request, int $part): string
  9880. {
  9881. $path = $request->getUri()->getPath();
  9882. $pathSegments = explode('/', rtrim($path, '/'));
  9883. if ($part < 0 || $part >= count($pathSegments)) {
  9884. return '';
  9885. }
  9886. return urldecode($pathSegments[$part]);
  9887. }
  9888. public static function getOperation(ServerRequestInterface $request): string
  9889. {
  9890. $method = $request->getMethod();
  9891. $path = RequestUtils::getPathSegment($request, 1);
  9892. $hasPk = RequestUtils::getPathSegment($request, 3) != '';
  9893. switch ($path) {
  9894. case 'openapi':
  9895. return 'document';
  9896. case 'columns':
  9897. return $method == 'get' ? 'reflect' : 'remodel';
  9898. case 'geojson':
  9899. case 'records':
  9900. switch ($method) {
  9901. case 'POST':
  9902. return 'create';
  9903. case 'GET':
  9904. return $hasPk ? 'read' : 'list';
  9905. case 'PUT':
  9906. return 'update';
  9907. case 'DELETE':
  9908. return 'delete';
  9909. case 'PATCH':
  9910. return 'increment';
  9911. }
  9912. }
  9913. return 'unknown';
  9914. }
  9915. private static function getJoinTables(string $tableName, array $parameters): array
  9916. {
  9917. $uniqueTableNames = array();
  9918. $uniqueTableNames[$tableName] = true;
  9919. if (isset($parameters['join'])) {
  9920. foreach ($parameters['join'] as $parameter) {
  9921. $tableNames = explode(',', trim($parameter));
  9922. foreach ($tableNames as $tableName) {
  9923. $uniqueTableNames[$tableName] = true;
  9924. }
  9925. }
  9926. }
  9927. return array_keys($uniqueTableNames);
  9928. }
  9929. public static function getTableNames(ServerRequestInterface $request, ReflectionService $reflection): array
  9930. {
  9931. $path = RequestUtils::getPathSegment($request, 1);
  9932. $tableName = RequestUtils::getPathSegment($request, 2);
  9933. $allTableNames = $reflection->getTableNames();
  9934. switch ($path) {
  9935. case 'openapi':
  9936. return $allTableNames;
  9937. case 'columns':
  9938. return $tableName ? [$tableName] : $allTableNames;
  9939. case 'records':
  9940. return self::getJoinTables($tableName, RequestUtils::getParams($request));
  9941. }
  9942. return $allTableNames;
  9943. }
  9944. }
  9945. }
  9946. // file: src/Tqdev/PhpCrudApi/ResponseFactory.php
  9947. namespace Tqdev\PhpCrudApi {
  9948. use Nyholm\Psr7\Factory\Psr17Factory;
  9949. use Psr\Http\Message\ResponseInterface;
  9950. class ResponseFactory
  9951. {
  9952. const OK = 200;
  9953. const UNAUTHORIZED = 401;
  9954. const FORBIDDEN = 403;
  9955. const NOT_FOUND = 404;
  9956. const METHOD_NOT_ALLOWED = 405;
  9957. const CONFLICT = 409;
  9958. const UNPROCESSABLE_ENTITY = 422;
  9959. const INTERNAL_SERVER_ERROR = 500;
  9960. public static function fromXml(int $status, string $xml): ResponseInterface
  9961. {
  9962. return self::from($status, 'text/xml', $xml);
  9963. }
  9964. public static function fromCsv(int $status, string $csv): ResponseInterface
  9965. {
  9966. $response = self::from($status, 'text/csv', $csv);
  9967. return $response->withHeader('Content-Type', 'text/csv');
  9968. }
  9969. public static function fromHtml(int $status, string $html): ResponseInterface
  9970. {
  9971. return self::from($status, 'text/html', $html);
  9972. }
  9973. public static function fromObject(int $status, $body): ResponseInterface
  9974. {
  9975. $content = json_encode($body, JSON_UNESCAPED_UNICODE);
  9976. return self::from($status, 'application/json', $content);
  9977. }
  9978. private static function from(int $status, string $contentType, string $content): ResponseInterface
  9979. {
  9980. $psr17Factory = new Psr17Factory();
  9981. $response = $psr17Factory->createResponse($status);
  9982. $stream = $psr17Factory->createStream($content);
  9983. $stream->rewind();
  9984. $response = $response->withBody($stream);
  9985. $response = $response->withHeader('Content-Type', $contentType . '; charset=utf-8');
  9986. $response = $response->withHeader('Content-Length', strlen($content));
  9987. return $response;
  9988. }
  9989. public static function fromStatus(int $status): ResponseInterface
  9990. {
  9991. $psr17Factory = new Psr17Factory();
  9992. return $psr17Factory->createResponse($status);
  9993. }
  9994. }
  9995. }
  9996. // file: src/Tqdev/PhpCrudApi/ResponseUtils.php
  9997. namespace Tqdev\PhpCrudApi {
  9998. use Psr\Http\Message\ResponseInterface;
  9999. class ResponseUtils
  10000. {
  10001. public static function output(ResponseInterface $response)
  10002. {
  10003. $status = $response->getStatusCode();
  10004. $headers = $response->getHeaders();
  10005. $body = $response->getBody()->getContents();
  10006. http_response_code($status);
  10007. foreach ($headers as $key => $values) {
  10008. foreach ($values as $value) {
  10009. header("$key: $value");
  10010. }
  10011. }
  10012. echo $body;
  10013. }
  10014. public static function addExceptionHeaders(ResponseInterface $response, \Throwable $e): ResponseInterface
  10015. {
  10016. $response = $response->withHeader('X-Exception-Name', get_class($e));
  10017. $response = $response->withHeader('X-Exception-Message', preg_replace('|\n|', ' ', trim($e->getMessage())));
  10018. $response = $response->withHeader('X-Exception-File', $e->getFile() . ':' . $e->getLine());
  10019. return $response;
  10020. }
  10021. public static function toString(ResponseInterface $response): string
  10022. {
  10023. $status = $response->getStatusCode();
  10024. $headers = $response->getHeaders();
  10025. $body = $response->getBody()->getContents();
  10026. $str = "$status\n";
  10027. foreach ($headers as $key => $values) {
  10028. foreach ($values as $value) {
  10029. $str .= "$key: $value\n";
  10030. }
  10031. }
  10032. if ($body !== '') {
  10033. $str .= "\n";
  10034. $str .= "$body\n";
  10035. }
  10036. return $str;
  10037. }
  10038. }
  10039. }
  10040. // file: src/index.php
  10041. namespace Tqdev\PhpCrudApi {
  10042. use Tqdev\PhpCrudApi\Api;
  10043. use Tqdev\PhpCrudApi\Config;
  10044. use Tqdev\PhpCrudApi\RequestFactory;
  10045. use Tqdev\PhpCrudApi\ResponseUtils;
  10046. $config = new Config([
  10047. // 'driver' => 'mysql',
  10048. // 'address' => 'localhost',
  10049. 'username' => 'php-crud-api',
  10050. 'password' => 'php-crud-api',
  10051. 'database' => 'php-crud-api',
  10052. // 'debug' => false
  10053. ]);
  10054. $request = RequestFactory::fromGlobals();
  10055. $api = new Api($config);
  10056. $response = $api->handle($request);
  10057. ResponseUtils::output($response);
  10058. }