123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595 |
- <?php
- /**
- * PHP-CRUD-API v2 License: MIT
- * Maurits van der Schee: maurits@vdschee.nl
- * https://github.com/mevdschee/php-crud-api
- **/
-
- namespace Tqdev\PhpCrudApi;
-
- // file: src/Tqdev/PhpCrudApi/Cache/Cache.php
-
- interface Cache
- {
- public function set(String $key, String $value, int $ttl = 0): bool;
- public function get(String $key): String;
- public function clear(): bool;
- }
-
- // file: src/Tqdev/PhpCrudApi/Cache/CacheFactory.php
-
- class CacheFactory
- {
- const PREFIX = 'phpcrudapi-%s-%s-%s-';
-
- private static function getPrefix(Config $config): String
- {
- $driver = $config->getDriver();
- $database = $config->getDatabase();
- $filehash = substr(md5(__FILE__), 0, 8);
- return sprintf(self::PREFIX, $driver, $database, $filehash);
- }
-
- public static function create(Config $config): Cache
- {
- switch ($config->getCacheType()) {
- case 'TempFile':
- $cache = new TempFileCache(self::getPrefix($config), $config->getCachePath());
- break;
- case 'Redis':
- $cache = new RedisCache(self::getPrefix($config), $config->getCachePath());
- break;
- case 'Memcache':
- $cache = new MemcacheCache(self::getPrefix($config), $config->getCachePath());
- break;
- case 'Memcached':
- $cache = new MemcachedCache(self::getPrefix($config), $config->getCachePath());
- break;
- default:
- $cache = new NoCache();
- }
- return $cache;
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Cache/MemcacheCache.php
-
- class MemcacheCache implements Cache
- {
- protected $prefix;
- protected $memcache;
-
- public function __construct(String $prefix, String $config)
- {
- $this->prefix = $prefix;
- if ($config == '') {
- $address = 'localhost';
- $port = 11211;
- } elseif (strpos($config, ':') === false) {
- $address = $config;
- $port = 11211;
- } else {
- list($address, $port) = explode(':', $config);
- }
- $this->memcache = $this->create();
- $this->memcache->addServer($address, $port);
- }
-
- protected function create(): stdClass
- {
- return new \Memcache();
- }
-
- public function set(String $key, String $value, int $ttl = 0): bool
- {
- return $this->memcache->set($this->prefix . $key, $value, 0, $ttl);
- }
-
- public function get(String $key): String
- {
- return $this->memcache->get($this->prefix . $key) ?: '';
- }
-
- public function clear(): bool
- {
- return $this->memcache->flush();
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Cache/MemcachedCache.php
-
- class MemcachedCache extends MemcacheCache
- {
- protected function create(): stdClass
- {
- return new \Memcached();
- }
-
- public function set(String $key, String $value, int $ttl = 0): bool
- {
- return $this->memcache->set($this->prefix . $key, $value, $ttl);
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Cache/NoCache.php
-
- class NoCache implements Cache
- {
- public function __construct()
- {
- }
-
- public function set(String $key, String $value, int $ttl = 0): bool
- {
- return true;
- }
-
- public function get(String $key): String
- {
- return '';
- }
-
- public function clear(): bool
- {
- return true;
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Cache/RedisCache.php
-
- class RedisCache implements Cache
- {
- protected $prefix;
- protected $redis;
-
- public function __construct(String $prefix, String $config)
- {
- $this->prefix = $prefix;
- if ($config == '') {
- $config = '127.0.0.1';
- }
- $params = explode(':', $config, 6);
- if (isset($params[3])) {
- $params[3] = null;
- }
- $this->redis = new \Redis();
- call_user_func_array(array($this->redis, 'pconnect'), $params);
- }
-
- public function set(String $key, String $value, int $ttl = 0): bool
- {
- return $this->redis->set($this->prefix . $key, $value, $ttl);
- }
-
- public function get(String $key): String
- {
- return $this->redis->get($this->prefix . $key) ?: '';
- }
-
- public function clear(): bool
- {
- return $this->redis->flushDb();
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Cache/TempFileCache.php
-
- class TempFileCache implements Cache
- {
- const SUFFIX = 'cache';
-
- private $path;
- private $segments;
-
- public function __construct(String $prefix, String $config)
- {
- $this->segments = [];
- $s = DIRECTORY_SEPARATOR;
- $ps = PATH_SEPARATOR;
- if ($config == '') {
- $this->path = sys_get_temp_dir() . $s . $prefix . self::SUFFIX;
- } elseif (strpos($config, $ps) === false) {
- $this->path = $config;
- } else {
- list($path, $segments) = explode($ps, $config);
- $this->path = $path;
- $this->segments = explode(',', $segments);
- }
- if (file_exists($this->path) && is_dir($this->path)) {
- $this->clean($this->path, array_filter($this->segments), strlen(md5('')), false);
- }
- }
-
- private function getFileName(String $key): String
- {
- $s = DIRECTORY_SEPARATOR;
- $md5 = md5($key);
- $filename = rtrim($this->path, $s) . $s;
- $i = 0;
- foreach ($this->segments as $segment) {
- $filename .= substr($md5, $i, $segment) . $s;
- $i += $segment;
- }
- $filename .= substr($md5, $i);
- return $filename;
- }
-
- public function set(String $key, String $value, int $ttl = 0): bool
- {
- $filename = $this->getFileName($key);
- $dirname = dirname($filename);
- if (!file_exists($dirname)) {
- if (!mkdir($dirname, 0755, true)) {
- return false;
- }
- }
- $string = $ttl . '|' . $value;
- return $this->filePutContents($filename, $string) !== false;
- }
-
- private function filePutContents($filename, $string)
- {
- return file_put_contents($filename, $string, LOCK_EX);
- }
-
- private function fileGetContents($filename)
- {
- $file = fopen($filename, 'rb');
- if ($file === false) {
- return false;
- }
- $lock = flock($file, LOCK_SH);
- if (!$lock) {
- fclose($file);
- return false;
- }
- $string = '';
- while (!feof($file)) {
- $string .= fread($file, 8192);
- }
- flock($file, LOCK_UN);
- fclose($file);
- return $string;
- }
-
- private function getString($filename): String
- {
- $data = $this->fileGetContents($filename);
- if ($data === false) {
- return '';
- }
- list($ttl, $string) = explode('|', $data, 2);
- if ($ttl > 0 && time() - filemtime($filename) > $ttl) {
- return '';
- }
- return $string;
- }
-
- public function get(String $key): String
- {
- $filename = $this->getFileName($key);
- if (!file_exists($filename)) {
- return '';
- }
- $string = $this->getString($filename);
- if ($string == null) {
- return '';
- }
- return $string;
- }
-
- private function clean(String $path, array $segments, int $len, bool $all) /*: void*/
- {
- $entries = scandir($path);
- foreach ($entries as $entry) {
- if ($entry === '.' || $entry === '..') {
- continue;
- }
- $filename = $path . DIRECTORY_SEPARATOR . $entry;
- if (count($segments) == 0) {
- if (strlen($entry) != $len) {
- continue;
- }
- if (is_file($filename)) {
- if ($all || $this->getString($filename) == null) {
- unlink($filename);
- }
- }
- } else {
- if (strlen($entry) != $segments[0]) {
- continue;
- }
- if (is_dir($filename)) {
- $this->clean($filename, array_slice($segments, 1), $len - $segments[0], $all);
- rmdir($filename);
- }
- }
- }
- }
-
- public function clear(): bool
- {
- if (!file_exists($this->path) || !is_dir($this->path)) {
- return false;
- }
- $this->clean($this->path, array_filter($this->segments), strlen(md5('')), true);
- return true;
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Column/Reflection/ReflectedColumn.php
-
- class ReflectedColumn implements \JsonSerializable
- {
- const DEFAULT_LENGTH = 255;
- const DEFAULT_PRECISION = 19;
- const DEFAULT_SCALE = 4;
-
- private $name;
- private $type;
- private $length;
- private $precision;
- private $scale;
- private $nullable;
- private $pk;
- private $fk;
-
- public function __construct(String $name, String $type, int $length, int $precision, int $scale, bool $nullable, bool $pk, String $fk)
- {
- $this->name = $name;
- $this->type = $type;
- $this->length = $length;
- $this->precision = $precision;
- $this->scale = $scale;
- $this->nullable = $nullable;
- $this->pk = $pk;
- $this->fk = $fk;
- $this->sanitize();
- }
-
- public static function fromReflection(GenericReflection $reflection, array $columnResult): ReflectedColumn
- {
- $name = $columnResult['COLUMN_NAME'];
- $length = (int) $columnResult['CHARACTER_MAXIMUM_LENGTH'];
- $type = $reflection->toJdbcType($columnResult['DATA_TYPE'], $length);
- $precision = (int) $columnResult['NUMERIC_PRECISION'];
- $scale = (int) $columnResult['NUMERIC_SCALE'];
- $nullable = in_array(strtoupper($columnResult['IS_NULLABLE']), ['TRUE', 'YES', 'T', 'Y', '1']);
- $pk = false;
- $fk = '';
- return new ReflectedColumn($name, $type, $length, $precision, $scale, $nullable, $pk, $fk);
- }
-
- public static function fromJson( /* object */$json): ReflectedColumn
- {
- $name = $json->name;
- $type = $json->type;
- $length = isset($json->length) ? $json->length : 0;
- $precision = isset($json->precision) ? $json->precision : 0;
- $scale = isset($json->scale) ? $json->scale : 0;
- $nullable = isset($json->nullable) ? $json->nullable : false;
- $pk = isset($json->pk) ? $json->pk : false;
- $fk = isset($json->fk) ? $json->fk : '';
- return new ReflectedColumn($name, $type, $length, $precision, $scale, $nullable, $pk, $fk);
- }
-
- private function sanitize()
- {
- $this->length = $this->hasLength() ? $this->getLength() : 0;
- $this->precision = $this->hasPrecision() ? $this->getPrecision() : 0;
- $this->scale = $this->hasScale() ? $this->getScale() : 0;
- }
-
- public function getName(): String
- {
- return $this->name;
- }
-
- public function getNullable(): bool
- {
- return $this->nullable;
- }
-
- public function getType(): String
- {
- return $this->type;
- }
-
- public function getLength(): int
- {
- return $this->length ?: self::DEFAULT_LENGTH;
- }
-
- public function getPrecision(): int
- {
- return $this->precision ?: self::DEFAULT_PRECISION;
- }
-
- public function getScale(): int
- {
- return $this->scale ?: self::DEFAULT_SCALE;
- }
-
- public function hasLength(): bool
- {
- return in_array($this->type, ['varchar', 'varbinary']);
- }
-
- public function hasPrecision(): bool
- {
- return $this->type == 'decimal';
- }
-
- public function hasScale(): bool
- {
- return $this->type == 'decimal';
- }
-
- public function isBinary(): bool
- {
- return in_array($this->type, ['blob', 'varbinary']);
- }
-
- public function isBoolean(): bool
- {
- return $this->type == 'boolean';
- }
-
- public function isGeometry(): bool
- {
- return $this->type == 'geometry';
- }
-
- public function setPk($value) /*: void*/
- {
- $this->pk = $value;
- }
-
- public function getPk(): bool
- {
- return $this->pk;
- }
-
- public function setFk($value) /*: void*/
- {
- $this->fk = $value;
- }
-
- public function getFk(): String
- {
- return $this->fk;
- }
-
- public function serialize()
- {
- return [
- 'name' => $this->name,
- 'type' => $this->type,
- 'length' => $this->length,
- 'precision' => $this->precision,
- 'scale' => $this->scale,
- 'nullable' => $this->nullable,
- 'pk' => $this->pk,
- 'fk' => $this->fk,
- ];
- }
-
- public function jsonSerialize()
- {
- return array_filter($this->serialize());
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Column/Reflection/ReflectedDatabase.php
-
- class ReflectedDatabase implements \JsonSerializable
- {
- private $name;
- private $tableTypes;
-
- public function __construct(String $name, array $tableTypes)
- {
- $this->name = $name;
- $this->tableTypes = $tableTypes;
- }
-
- public static function fromReflection(GenericReflection $reflection): ReflectedDatabase
- {
- $name = $reflection->getDatabaseName();
- $tableTypes = [];
- foreach ($reflection->getTables() as $table) {
- $tableName = $table['TABLE_NAME'];
- $tableType = $table['TABLE_TYPE'];
- if (in_array($tableName, $reflection->getIgnoredTables())) {
- continue;
- }
- $tableTypes[$tableName] = $tableType;
- }
- return new ReflectedDatabase($name, $tableTypes);
- }
-
- public static function fromJson( /* object */$json): ReflectedDatabase
- {
- $name = $json->name;
- $tableTypes = (array) $json->tables;
- return new ReflectedDatabase($name, $tableTypes);
- }
-
- public function getName(): String
- {
- return $this->name;
- }
-
- public function hasTable(String $tableName): bool
- {
- return isset($this->tableTypes[$tableName]);
- }
-
- public function getType(String $tableName): String
- {
- return isset($this->tableTypes[$tableName]) ? $this->tableTypes[$tableName] : '';
- }
-
- public function getTableNames(): array
- {
- return array_keys($this->tableTypes);
- }
-
- public function removeTable(String $tableName): bool
- {
- if (!isset($this->tableTypes[$tableName])) {
- return false;
- }
- unset($this->tableTypes[$tableName]);
- return true;
- }
-
- public function serialize()
- {
- return [
- 'name' => $this->name,
- 'tables' => $this->tableTypes,
- ];
- }
-
- public function jsonSerialize()
- {
- return $this->serialize();
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Column/Reflection/ReflectedTable.php
-
- class ReflectedTable implements \JsonSerializable
- {
- private $name;
- private $type;
- private $columns;
- private $pk;
- private $fks;
-
- public function __construct(String $name, String $type, array $columns)
- {
- $this->name = $name;
- $this->type = $type;
- $this->columns = [];
- foreach ($columns as $column) {
- $columnName = $column->getName();
- $this->columns[$columnName] = $column;
- }
- $this->pk = null;
- foreach ($columns as $column) {
- if ($column->getPk() == true) {
- $this->pk = $column;
- }
- }
- $this->fks = [];
- foreach ($columns as $column) {
- $columnName = $column->getName();
- $referencedTableName = $column->getFk();
- if ($referencedTableName != '') {
- $this->fks[$columnName] = $referencedTableName;
- }
- }
- }
-
- public static function fromReflection(GenericReflection $reflection, String $name, String $type): ReflectedTable
- {
- $columns = [];
- foreach ($reflection->getTableColumns($name, $type) as $tableColumn) {
- $column = ReflectedColumn::fromReflection($reflection, $tableColumn);
- $columns[$column->getName()] = $column;
- }
- $columnNames = $reflection->getTablePrimaryKeys($name);
- if (count($columnNames) == 1) {
- $columnName = $columnNames[0];
- if (isset($columns[$columnName])) {
- $pk = $columns[$columnName];
- $pk->setPk(true);
- }
- }
- $fks = $reflection->getTableForeignKeys($name);
- foreach ($fks as $columnName => $table) {
- $columns[$columnName]->setFk($table);
- }
- return new ReflectedTable($name, $type, array_values($columns));
- }
-
- public static function fromJson( /* object */$json): ReflectedTable
- {
- $name = $json->name;
- $type = $json->type;
- $columns = [];
- if (isset($json->columns) && is_array($json->columns)) {
- foreach ($json->columns as $column) {
- $columns[] = ReflectedColumn::fromJson($column);
- }
- }
- return new ReflectedTable($name, $type, $columns);
- }
-
- public function hasColumn(String $columnName): bool
- {
- return isset($this->columns[$columnName]);
- }
-
- public function hasPk(): bool
- {
- return $this->pk != null;
- }
-
- public function getPk() /*: ?ReflectedColumn */
- {
- return $this->pk;
- }
-
- public function getName(): String
- {
- return $this->name;
- }
-
- public function getType(): String
- {
- return $this->type;
- }
-
- public function columnNames(): array
- {
- return array_keys($this->columns);
- }
-
- public function getColumn($columnName): ReflectedColumn
- {
- return $this->columns[$columnName];
- }
-
- public function getFksTo(String $tableName): array
- {
- $columns = array();
- foreach ($this->fks as $columnName => $referencedTableName) {
- if ($tableName == $referencedTableName) {
- $columns[] = $this->columns[$columnName];
- }
- }
- return $columns;
- }
-
- public function removeColumn(String $columnName): bool
- {
- if (!isset($this->columns[$columnName])) {
- return false;
- }
- unset($this->columns[$columnName]);
- return true;
- }
-
- public function serialize()
- {
- return [
- 'name' => $this->name,
- 'type' => $this->type,
- 'columns' => array_values($this->columns),
- ];
- }
-
- public function jsonSerialize()
- {
- return $this->serialize();
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Column/DefinitionService.php
-
- class DefinitionService
- {
- private $db;
- private $reflection;
-
- public function __construct(GenericDB $db, ReflectionService $reflection)
- {
- $this->db = $db;
- $this->reflection = $reflection;
- }
-
- public function updateTable(String $tableName, /* object */ $changes): bool
- {
- $table = $this->reflection->getTable($tableName);
- $newTable = ReflectedTable::fromJson((object) array_merge((array) $table->jsonSerialize(), (array) $changes));
- if ($table->getName() != $newTable->getName()) {
- if (!$this->db->definition()->renameTable($table->getName(), $newTable->getName())) {
- return false;
- }
- }
- return true;
- }
-
- public function updateColumn(String $tableName, String $columnName, /* object */ $changes): bool
- {
- $table = $this->reflection->getTable($tableName);
- $column = $table->getColumn($columnName);
-
- $newColumn = ReflectedColumn::fromJson((object) array_merge((array) $column->jsonSerialize(), (array) $changes));
- if ($newColumn->getPk() != $column->getPk() && $table->hasPk()) {
- $oldColumn = $table->getPk();
- if ($oldColumn->getName() != $columnName) {
- $oldColumn->setPk(false);
- if (!$this->db->definition()->removeColumnPrimaryKey($table->getName(), $oldColumn->getName(), $oldColumn)) {
- return false;
- }
- }
- }
-
- $newColumn = ReflectedColumn::fromJson((object) array_merge((array) $column->jsonSerialize(), ['pk' => false, 'fk' => false]));
- if ($newColumn->getPk() != $column->getPk() && !$newColumn->getPk()) {
- if (!$this->db->definition()->removeColumnPrimaryKey($table->getName(), $column->getName(), $newColumn)) {
- return false;
- }
- }
- if ($newColumn->getFk() != $column->getFk() && !$newColumn->getFk()) {
- if (!$this->db->definition()->removeColumnForeignKey($table->getName(), $column->getName(), $newColumn)) {
- return false;
- }
- }
-
- $newColumn = ReflectedColumn::fromJson((object) array_merge((array) $column->jsonSerialize(), (array) $changes));
- $newColumn->setPk(false);
- $newColumn->setFk('');
- if ($newColumn->getName() != $column->getName()) {
- if (!$this->db->definition()->renameColumn($table->getName(), $column->getName(), $newColumn)) {
- return false;
- }
- }
- if ($newColumn->getType() != $column->getType() ||
- $newColumn->getLength() != $column->getLength() ||
- $newColumn->getPrecision() != $column->getPrecision() ||
- $newColumn->getScale() != $column->getScale()
- ) {
- if (!$this->db->definition()->retypeColumn($table->getName(), $newColumn->getName(), $newColumn)) {
- return false;
- }
- }
- if ($newColumn->getNullable() != $column->getNullable()) {
- if (!$this->db->definition()->setColumnNullable($table->getName(), $newColumn->getName(), $newColumn)) {
- return false;
- }
- }
-
- $newColumn = ReflectedColumn::fromJson((object) array_merge((array) $column->jsonSerialize(), (array) $changes));
- if ($newColumn->getFk()) {
- if (!$this->db->definition()->addColumnForeignKey($table->getName(), $newColumn->getName(), $newColumn)) {
- return false;
- }
- }
- if ($newColumn->getPk()) {
- if (!$this->db->definition()->addColumnPrimaryKey($table->getName(), $newColumn->getName(), $newColumn)) {
- return false;
- }
- }
- return true;
- }
-
- public function addTable( /* object */$definition)
- {
- $newTable = ReflectedTable::fromJson($definition);
- if (!$this->db->definition()->addTable($newTable)) {
- return false;
- }
- return true;
- }
-
- public function addColumn(String $tableName, /* object */ $definition)
- {
- $newColumn = ReflectedColumn::fromJson($definition);
- if (!$this->db->definition()->addColumn($tableName, $newColumn)) {
- return false;
- }
- if ($newColumn->getFk()) {
- if (!$this->db->definition()->addColumnForeignKey($tableName, $newColumn->getName(), $newColumn)) {
- return false;
- }
- }
- if ($newColumn->getPk()) {
- if (!$this->db->definition()->addColumnPrimaryKey($tableName, $newColumn->getName(), $newColumn)) {
- return false;
- }
- }
- return true;
- }
-
- public function removeTable(String $tableName)
- {
- if (!$this->db->definition()->removeTable($tableName)) {
- return false;
- }
- return true;
- }
-
- public function removeColumn(String $tableName, String $columnName)
- {
- $table = $this->reflection->getTable($tableName);
- $newColumn = $table->getColumn($columnName);
- if ($newColumn->getPk()) {
- $newColumn->setPk(false);
- if (!$this->db->definition()->removeColumnPrimaryKey($table->getName(), $newColumn->getName(), $newColumn)) {
- return false;
- }
- }
- if ($newColumn->getFk()) {
- $newColumn->setFk("");
- if (!$this->db->definition()->removeColumnForeignKey($tableName, $columnName, $newColumn)) {
- return false;
- }
- }
- if (!$this->db->definition()->removeColumn($tableName, $columnName)) {
- return false;
- }
- return true;
- }
-
- }
-
- // file: src/Tqdev/PhpCrudApi/Column/ReflectionService.php
-
- class ReflectionService
- {
- private $db;
- private $cache;
- private $ttl;
- private $database;
- private $tables;
-
- public function __construct(GenericDB $db, Cache $cache, int $ttl)
- {
- $this->db = $db;
- $this->cache = $cache;
- $this->ttl = $ttl;
- $this->database = $this->loadDatabase(true);
- $this->tables = [];
- }
-
- private function loadDatabase(bool $useCache): ReflectedDatabase
- {
- $data = $useCache ? $this->cache->get('ReflectedDatabase') : '';
- if ($data != '') {
- $database = ReflectedDatabase::fromJson(json_decode(gzuncompress($data)));
- } else {
- $database = ReflectedDatabase::fromReflection($this->db->reflection());
- $data = gzcompress(json_encode($database, JSON_UNESCAPED_UNICODE));
- $this->cache->set('ReflectedDatabase', $data, $this->ttl);
- }
- return $database;
- }
-
- private function loadTable(String $tableName, bool $useCache): ReflectedTable
- {
- $data = $useCache ? $this->cache->get("ReflectedTable($tableName)") : '';
- if ($data != '') {
- $table = ReflectedTable::fromJson(json_decode(gzuncompress($data)));
- } else {
- $tableType = $this->database->getType($tableName);
- $table = ReflectedTable::fromReflection($this->db->reflection(), $tableName, $tableType);
- $data = gzcompress(json_encode($table, JSON_UNESCAPED_UNICODE));
- $this->cache->set("ReflectedTable($tableName)", $data, $this->ttl);
- }
- return $table;
- }
-
- public function refreshTables()
- {
- $this->database = $this->loadDatabase(false);
- }
-
- public function refreshTable(String $tableName)
- {
- $this->tables[$tableName] = $this->loadTable($tableName, false);
- }
-
- public function hasTable(String $tableName): bool
- {
- return $this->database->hasTable($tableName);
- }
-
- public function getType(String $tableName): String
- {
- return $this->database->getType($tableName);
- }
-
- public function getTable(String $tableName): ReflectedTable
- {
- if (!isset($this->tables[$tableName])) {
- $this->tables[$tableName] = $this->loadTable($tableName, true);
- }
- return $this->tables[$tableName];
- }
-
- public function getTableNames(): array
- {
- return $this->database->getTableNames();
- }
-
- public function getDatabaseName(): String
- {
- return $this->database->getName();
- }
-
- public function removeTable(String $tableName): bool
- {
- unset($this->tables[$tableName]);
- return $this->database->removeTable($tableName);
- }
-
- }
-
- // file: src/Tqdev/PhpCrudApi/Controller/CacheController.php
-
- class CacheController
- {
- private $cache;
- private $responder;
-
- public function __construct(Router $router, Responder $responder, Cache $cache)
- {
- $router->register('GET', '/cache/clear', array($this, 'clear'));
- $this->cache = $cache;
- $this->responder = $responder;
- }
-
- public function clear(Request $request): Response
- {
- return $this->responder->success($this->cache->clear());
- }
-
- }
-
- // file: src/Tqdev/PhpCrudApi/Controller/ColumnController.php
-
- class ColumnController
- {
- private $responder;
- private $reflection;
- private $definition;
-
- public function __construct(Router $router, Responder $responder, ReflectionService $reflection, DefinitionService $definition)
- {
- $router->register('GET', '/columns', array($this, 'getDatabase'));
- $router->register('GET', '/columns/*', array($this, 'getTable'));
- $router->register('GET', '/columns/*/*', array($this, 'getColumn'));
- $router->register('PUT', '/columns/*', array($this, 'updateTable'));
- $router->register('PUT', '/columns/*/*', array($this, 'updateColumn'));
- $router->register('POST', '/columns', array($this, 'addTable'));
- $router->register('POST', '/columns/*', array($this, 'addColumn'));
- $router->register('DELETE', '/columns/*', array($this, 'removeTable'));
- $router->register('DELETE', '/columns/*/*', array($this, 'removeColumn'));
- $this->responder = $responder;
- $this->reflection = $reflection;
- $this->definition = $definition;
- }
-
- public function getDatabase(Request $request): Response
- {
- $name = $this->reflection->getDatabaseName();
- $tables = [];
- foreach ($this->reflection->getTableNames() as $table) {
- $tables[] = $this->reflection->getTable($table);
- }
- $database = ['name' => $name, 'tables' => $tables];
- return $this->responder->success($database);
- }
-
- public function getTable(Request $request): Response
- {
- $tableName = $request->getPathSegment(2);
- if (!$this->reflection->hasTable($tableName)) {
- return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $tableName);
- }
- $table = $this->reflection->getTable($tableName);
- return $this->responder->success($table);
- }
-
- public function getColumn(Request $request): Response
- {
- $tableName = $request->getPathSegment(2);
- $columnName = $request->getPathSegment(3);
- if (!$this->reflection->hasTable($tableName)) {
- return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $tableName);
- }
- $table = $this->reflection->getTable($tableName);
- if (!$table->hasColumn($columnName)) {
- return $this->responder->error(ErrorCode::COLUMN_NOT_FOUND, $columnName);
- }
- $column = $table->getColumn($columnName);
- return $this->responder->success($column);
- }
-
- public function updateTable(Request $request): Response
- {
- $tableName = $request->getPathSegment(2);
- if (!$this->reflection->hasTable($tableName)) {
- return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $tableName);
- }
- $success = $this->definition->updateTable($tableName, $request->getBody());
- if ($success) {
- $this->reflection->refreshTables();
- }
- return $this->responder->success($success);
- }
-
- public function updateColumn(Request $request): Response
- {
- $tableName = $request->getPathSegment(2);
- $columnName = $request->getPathSegment(3);
- if (!$this->reflection->hasTable($tableName)) {
- return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $tableName);
- }
- $table = $this->reflection->getTable($tableName);
- if (!$table->hasColumn($columnName)) {
- return $this->responder->error(ErrorCode::COLUMN_NOT_FOUND, $columnName);
- }
- $success = $this->definition->updateColumn($tableName, $columnName, $request->getBody());
- if ($success) {
- $this->reflection->refreshTable($tableName);
- }
- return $this->responder->success($success);
- }
-
- public function addTable(Request $request): Response
- {
- $tableName = $request->getBody()->name;
- if ($this->reflection->hasTable($tableName)) {
- return $this->responder->error(ErrorCode::TABLE_ALREADY_EXISTS, $tableName);
- }
- $success = $this->definition->addTable($request->getBody());
- if ($success) {
- $this->reflection->refreshTables();
- }
- return $this->responder->success($success);
- }
-
- public function addColumn(Request $request): Response
- {
- $tableName = $request->getPathSegment(2);
- if (!$this->reflection->hasTable($tableName)) {
- return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $tableName);
- }
- $columnName = $request->getBody()->name;
- $table = $this->reflection->getTable($tableName);
- if ($table->hasColumn($columnName)) {
- return $this->responder->error(ErrorCode::COLUMN_ALREADY_EXISTS, $columnName);
- }
- $success = $this->definition->addColumn($tableName, $request->getBody());
- if ($success) {
- $this->reflection->refreshTable($tableName);
- }
- return $this->responder->success($success);
- }
-
- public function removeTable(Request $request): Response
- {
- $tableName = $request->getPathSegment(2);
- if (!$this->reflection->hasTable($tableName)) {
- return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $tableName);
- }
- $success = $this->definition->removeTable($tableName);
- if ($success) {
- $this->reflection->refreshTables();
- }
- return $this->responder->success($success);
- }
-
- public function removeColumn(Request $request): Response
- {
- $tableName = $request->getPathSegment(2);
- $columnName = $request->getPathSegment(3);
- if (!$this->reflection->hasTable($tableName)) {
- return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $tableName);
- }
- $table = $this->reflection->getTable($tableName);
- if (!$table->hasColumn($columnName)) {
- return $this->responder->error(ErrorCode::COLUMN_NOT_FOUND, $columnName);
- }
- $success = $this->definition->removeColumn($tableName, $columnName);
- if ($success) {
- $this->reflection->refreshTable($tableName);
- }
- return $this->responder->success($success);
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Controller/OpenApiController.php
-
- class OpenApiController
- {
- private $openApi;
- private $responder;
-
- public function __construct(Router $router, Responder $responder, OpenApiService $openApi)
- {
- $router->register('GET', '/openapi', array($this, 'openapi'));
- $this->openApi = $openApi;
- $this->responder = $responder;
- }
-
- public function openapi(Request $request): Response
- {
- return $this->responder->success($this->openApi->get());
- }
-
- }
-
- // file: src/Tqdev/PhpCrudApi/Controller/RecordController.php
-
- class RecordController
- {
- private $service;
- private $responder;
-
- public function __construct(Router $router, Responder $responder, RecordService $service)
- {
- $router->register('GET', '/records/*', array($this, '_list'));
- $router->register('POST', '/records/*', array($this, 'create'));
- $router->register('GET', '/records/*/*', array($this, 'read'));
- $router->register('PUT', '/records/*/*', array($this, 'update'));
- $router->register('DELETE', '/records/*/*', array($this, 'delete'));
- $router->register('PATCH', '/records/*/*', array($this, 'increment'));
- $this->service = $service;
- $this->responder = $responder;
- }
-
- public function _list(Request $request): Response
- {
- $table = $request->getPathSegment(2);
- $params = $request->getParams();
- if (!$this->service->hasTable($table)) {
- return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $table);
- }
- return $this->responder->success($this->service->_list($table, $params));
- }
-
- public function read(Request $request): Response
- {
- $table = $request->getPathSegment(2);
- if (!$this->service->hasTable($table)) {
- return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $table);
- }
- if ($this->service->getType($table) != 'table') {
- return $this->responder->error(ErrorCode::OPERATION_NOT_SUPPORTED, __FUNCTION__);
- }
- $id = $request->getPathSegment(3);
- $params = $request->getParams();
- if (strpos($id, ',') !== false) {
- $ids = explode(',', $id);
- $result = [];
- for ($i = 0; $i < count($ids); $i++) {
- array_push($result, $this->service->read($table, $ids[$i], $params));
- }
- return $this->responder->success($result);
- } else {
- $response = $this->service->read($table, $id, $params);
- if ($response === null) {
- return $this->responder->error(ErrorCode::RECORD_NOT_FOUND, $id);
- }
- return $this->responder->success($response);
- }
- }
-
- public function create(Request $request): Response
- {
- $table = $request->getPathSegment(2);
- if (!$this->service->hasTable($table)) {
- return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $table);
- }
- if ($this->service->getType($table) != 'table') {
- return $this->responder->error(ErrorCode::OPERATION_NOT_SUPPORTED, __FUNCTION__);
- }
- $record = $request->getBody();
- if ($record === null) {
- return $this->responder->error(ErrorCode::HTTP_MESSAGE_NOT_READABLE, '');
- }
- $params = $request->getParams();
- if (is_array($record)) {
- $result = array();
- foreach ($record as $r) {
- $result[] = $this->service->create($table, $r, $params);
- }
- return $this->responder->success($result);
- } else {
- return $this->responder->success($this->service->create($table, $record, $params));
- }
- }
-
- public function update(Request $request): Response
- {
- $table = $request->getPathSegment(2);
- if (!$this->service->hasTable($table)) {
- return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $table);
- }
- if ($this->service->getType($table) != 'table') {
- return $this->responder->error(ErrorCode::OPERATION_NOT_SUPPORTED, __FUNCTION__);
- }
- $id = $request->getPathSegment(3);
- $params = $request->getParams();
- $record = $request->getBody();
- if ($record === null) {
- return $this->responder->error(ErrorCode::HTTP_MESSAGE_NOT_READABLE, '');
- }
- $ids = explode(',', $id);
- if (is_array($record)) {
- if (count($ids) != count($record)) {
- return $this->responder->error(ErrorCode::ARGUMENT_COUNT_MISMATCH, $id);
- }
- $result = array();
- for ($i = 0; $i < count($ids); $i++) {
- $result[] = $this->service->update($table, $ids[$i], $record[$i], $params);
- }
- return $this->responder->success($result);
- } else {
- if (count($ids) != 1) {
- return $this->responder->error(ErrorCode::ARGUMENT_COUNT_MISMATCH, $id);
- }
- return $this->responder->success($this->service->update($table, $id, $record, $params));
- }
- }
-
- public function delete(Request $request): Response
- {
- $table = $request->getPathSegment(2);
- if (!$this->service->hasTable($table)) {
- return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $table);
- }
- if ($this->service->getType($table) != 'table') {
- return $this->responder->error(ErrorCode::OPERATION_NOT_SUPPORTED, __FUNCTION__);
- }
- $id = $request->getPathSegment(3);
- $params = $request->getParams();
- $ids = explode(',', $id);
- if (count($ids) > 1) {
- $result = array();
- for ($i = 0; $i < count($ids); $i++) {
- $result[] = $this->service->delete($table, $ids[$i], $params);
- }
- return $this->responder->success($result);
- } else {
- return $this->responder->success($this->service->delete($table, $id, $params));
- }
- }
-
- public function increment(Request $request): Response
- {
- $table = $request->getPathSegment(2);
- if (!$this->service->hasTable($table)) {
- return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $table);
- }
- if ($this->service->getType($table) != 'table') {
- return $this->responder->error(ErrorCode::OPERATION_NOT_SUPPORTED, __FUNCTION__);
- }
- $id = $request->getPathSegment(3);
- $record = $request->getBody();
- if ($record === null) {
- return $this->responder->error(ErrorCode::HTTP_MESSAGE_NOT_READABLE, '');
- }
- $params = $request->getParams();
- $ids = explode(',', $id);
- if (is_array($record)) {
- if (count($ids) != count($record)) {
- return $this->responder->error(ErrorCode::ARGUMENT_COUNT_MISMATCH, $id);
- }
- $result = array();
- for ($i = 0; $i < count($ids); $i++) {
- $result[] = $this->service->increment($table, $ids[$i], $record[$i], $params);
- }
- return $this->responder->success($result);
- } else {
- if (count($ids) != 1) {
- return $this->responder->error(ErrorCode::ARGUMENT_COUNT_MISMATCH, $id);
- }
- return $this->responder->success($this->service->increment($table, $id, $record, $params));
- }
- }
-
- }
-
- // file: src/Tqdev/PhpCrudApi/Controller/Responder.php
-
- class Responder
- {
- public function error(int $error, String $argument, $details = null): Response
- {
- $errorCode = new ErrorCode($error);
- $status = $errorCode->getStatus();
- $document = new ErrorDocument($errorCode, $argument, $details);
- return new Response($status, $document);
- }
-
- public function success($result): Response
- {
- return new Response(Response::OK, $result);
- }
-
- }
-
- // file: src/Tqdev/PhpCrudApi/Database/ColumnConverter.php
-
- class ColumnConverter
- {
- private $driver;
-
- public function __construct(String $driver)
- {
- $this->driver = $driver;
- }
-
- public function convertColumnValue(ReflectedColumn $column): String
- {
- if ($column->isBinary()) {
- switch ($this->driver) {
- case 'mysql':
- return "FROM_BASE64(?)";
- case 'pgsql':
- return "decode(?, 'base64')";
- case 'sqlsrv':
- return "CONVERT(XML, ?).value('.','varbinary(max)')";
- }
- }
- if ($column->isGeometry()) {
- switch ($this->driver) {
- case 'mysql':
- case 'pgsql':
- return "ST_GeomFromText(?)";
- case 'sqlsrv':
- return "geometry::STGeomFromText(?,0)";
- }
- }
- return '?';
- }
-
- public function convertColumnName(ReflectedColumn $column, $value): String
- {
- if ($column->isBinary()) {
- switch ($this->driver) {
- case 'mysql':
- return "TO_BASE64($value) as $value";
- case 'pgsql':
- return "encode($value::bytea, 'base64') as $value";
- case 'sqlsrv':
- return "CASE WHEN $value IS NULL THEN NULL ELSE (SELECT CAST($value as varbinary(max)) FOR XML PATH(''), BINARY BASE64) END as $value";
-
- }
- }
- if ($column->isGeometry()) {
- switch ($this->driver) {
- case 'mysql':
- case 'pgsql':
- return "ST_AsText($value) as $value";
- case 'sqlsrv':
- return "REPLACE($value.STAsText(),' (','(') as $value";
- }
- }
- return $value;
- }
-
- }
-
- // file: src/Tqdev/PhpCrudApi/Database/ColumnsBuilder.php
-
- class ColumnsBuilder
- {
- private $driver;
- private $converter;
-
- public function __construct(String $driver)
- {
- $this->driver = $driver;
- $this->converter = new ColumnConverter($driver);
- }
-
- public function getOffsetLimit(int $offset, int $limit): String
- {
- if ($limit < 0 || $offset < 0) {
- return '';
- }
- switch ($this->driver) {
- case 'mysql':return "LIMIT $offset, $limit";
- case 'pgsql':return "LIMIT $limit OFFSET $offset";
- case 'sqlsrv':return "OFFSET $offset ROWS FETCH NEXT $limit ROWS ONLY";
- }
- }
-
- private function quoteColumnName(ReflectedColumn $column): String
- {
- return '"' . $column->getName() . '"';
- }
-
- public function getOrderBy(ReflectedTable $table, array $columnOrdering): String
- {
- $results = array();
- foreach ($columnOrdering as $i => list($columnName, $ordering)) {
- $column = $table->getColumn($columnName);
- $quotedColumnName = $this->quoteColumnName($column);
- $results[] = $quotedColumnName . ' ' . $ordering;
- }
- return implode(',', $results);
- }
-
- public function getSelect(ReflectedTable $table, array $columnNames): String
- {
- $results = array();
- foreach ($columnNames as $columnName) {
- $column = $table->getColumn($columnName);
- $quotedColumnName = $this->quoteColumnName($column);
- $quotedColumnName = $this->converter->convertColumnName($column, $quotedColumnName);
- $results[] = $quotedColumnName;
- }
- return implode(',', $results);
- }
-
- public function getInsert(ReflectedTable $table, array $columnValues): String
- {
- $columns = array();
- $values = array();
- foreach ($columnValues as $columnName => $columnValue) {
- $column = $table->getColumn($columnName);
- $quotedColumnName = $this->quoteColumnName($column);
- $columns[] = $quotedColumnName;
- $columnValue = $this->converter->convertColumnValue($column);
- $values[] = $columnValue;
- }
- $columnsSql = '(' . implode(',', $columns) . ')';
- $valuesSql = '(' . implode(',', $values) . ')';
- $outputColumn = $this->quoteColumnName($table->getPk());
- switch ($this->driver) {
- case 'mysql':return "$columnsSql VALUES $valuesSql";
- case 'pgsql':return "$columnsSql VALUES $valuesSql RETURNING $outputColumn";
- case 'sqlsrv':return "$columnsSql OUTPUT INSERTED.$outputColumn VALUES $valuesSql";
- }
- }
-
- public function getUpdate(ReflectedTable $table, array $columnValues): String
- {
- $results = array();
- foreach ($columnValues as $columnName => $columnValue) {
- $column = $table->getColumn($columnName);
- $quotedColumnName = $this->quoteColumnName($column);
- $columnValue = $this->converter->convertColumnValue($column);
- $results[] = $quotedColumnName . '=' . $columnValue;
- }
- return implode(',', $results);
- }
-
- public function getIncrement(ReflectedTable $table, array $columnValues): String
- {
- $results = array();
- foreach ($columnValues as $columnName => $columnValue) {
- if (!is_numeric($columnValue)) {
- continue;
- }
- $column = $table->getColumn($columnName);
- $quotedColumnName = $this->quoteColumnName($column);
- $columnValue = $this->converter->convertColumnValue($column);
- $results[] = $quotedColumnName . '=' . $quotedColumnName . '+' . $columnValue;
- }
- return implode(',', $results);
- }
-
- }
-
- // file: src/Tqdev/PhpCrudApi/Database/ConditionsBuilder.php
-
- class ConditionsBuilder
- {
- private $driver;
-
- public function __construct(String $driver)
- {
- $this->driver = $driver;
- }
-
- private function getConditionSql(Condition $condition, array &$arguments): String
- {
- if ($condition instanceof AndCondition) {
- return $this->getAndConditionSql($condition, $arguments);
- }
- if ($condition instanceof OrCondition) {
- return $this->getOrConditionSql($condition, $arguments);
- }
- if ($condition instanceof NotCondition) {
- return $this->getNotConditionSql($condition, $arguments);
- }
- if ($condition instanceof ColumnCondition) {
- return $this->getColumnConditionSql($condition, $arguments);
- }
- if ($condition instanceof SpatialCondition) {
- return $this->getSpatialConditionSql($condition, $arguments);
- }
- throw new \Exception('Unknown Condition: ' . get_class($condition));
- }
-
- private function getAndConditionSql(AndCondition $and, array &$arguments): String
- {
- $parts = [];
- foreach ($and->getConditions() as $condition) {
- $parts[] = $this->getConditionSql($condition, $arguments);
- }
- return '(' . implode(' AND ', $parts) . ')';
- }
-
- private function getOrConditionSql(OrCondition $or, array &$arguments): String
- {
- $parts = [];
- foreach ($or->getConditions() as $condition) {
- $parts[] = $this->getConditionSql($condition, $arguments);
- }
- return '(' . implode(' OR ', $parts) . ')';
- }
-
- private function getNotConditionSql(NotCondition $not, array &$arguments): String
- {
- $condition = $not->getCondition();
- return '(NOT ' . $this->getConditionSql($condition, $arguments) . ')';
- }
-
- private function quoteColumnName(ReflectedColumn $column): String
- {
- return '"' . $column->getName() . '"';
- }
-
- private function escapeLikeValue(String $value): String
- {
- return addcslashes($value, '%_');
- }
-
- private function getColumnConditionSql(ColumnCondition $condition, array &$arguments): String
- {
- $column = $this->quoteColumnName($condition->getColumn());
- $operator = $condition->getOperator();
- $value = $condition->getValue();
- switch ($operator) {
- case 'cs':
- $sql = "$column LIKE ?";
- $arguments[] = '%' . $this->escapeLikeValue($value) . '%';
- break;
- case 'sw':
- $sql = "$column LIKE ?";
- $arguments[] = $this->escapeLikeValue($value) . '%';
- break;
- case 'ew':
- $sql = "$column LIKE ?";
- $arguments[] = '%' . $this->escapeLikeValue($value);
- break;
- case 'eq':
- $sql = "$column = ?";
- $arguments[] = $value;
- break;
- case 'lt':
- $sql = "$column < ?";
- $arguments[] = $value;
- break;
- case 'le':
- $sql = "$column <= ?";
- $arguments[] = $value;
- break;
- case 'ge':
- $sql = "$column >= ?";
- $arguments[] = $value;
- break;
- case 'gt':
- $sql = "$column > ?";
- $arguments[] = $value;
- break;
- case 'bt':
- $parts = explode(',', $value, 2);
- $count = count($parts);
- if ($count == 2) {
- $sql = "($column >= ? AND $column <= ?)";
- $arguments[] = $parts[0];
- $arguments[] = $parts[1];
- } else {
- $sql = "FALSE";
- }
- break;
- case 'in':
- $parts = explode(',', $value);
- $count = count($parts);
- if ($count > 0) {
- $qmarks = implode(',', str_split(str_repeat('?', $count)));
- $sql = "$column IN ($qmarks)";
- for ($i = 0; $i < $count; $i++) {
- $arguments[] = $parts[$i];
- }
- } else {
- $sql = "FALSE";
- }
- break;
- case 'is':
- $sql = "$column IS NULL";
- break;
- }
- return $sql;
- }
-
- private function getSpatialFunctionName(String $operator): String
- {
- switch ($operator) {
- case 'co':return 'ST_Contains';
- case 'cr':return 'ST_Crosses';
- case 'di':return 'ST_Disjoint';
- case 'eq':return 'ST_Equals';
- case 'in':return 'ST_Intersects';
- case 'ov':return 'ST_Overlaps';
- case 'to':return 'ST_Touches';
- case 'wi':return 'ST_Within';
- case 'ic':return 'ST_IsClosed';
- case 'is':return 'ST_IsSimple';
- case 'iv':return 'ST_IsValid';
- }
- }
-
- private function hasSpatialArgument(String $operator): bool
- {
- return in_array($operator, ['ic', 'is', 'iv']) ? false : true;
- }
-
- private function getSpatialFunctionCall(String $functionName, String $column, bool $hasArgument): String
- {
- switch ($this->driver) {
- case 'mysql':
- case 'pgsql':
- $argument = $hasArgument ? 'ST_GeomFromText(?)' : '';
- return "$functionName($column, $argument)=TRUE";
- case 'sql_srv':
- $functionName = str_replace('ST_', 'ST', $functionName);
- $argument = $hasArgument ? 'geometry::STGeomFromText(?,0)' : '';
- return "$column.$functionName($argument)=1";
- }
- }
-
- private function getSpatialConditionSql(ColumnCondition $condition, array &$arguments): String
- {
- $column = $this->quoteColumnName($condition->getColumn());
- $operator = $condition->getOperator();
- $value = $condition->getValue();
- $functionName = $this->getSpatialFunctionName($operator);
- $hasArgument = $this->hasSpatialArgument($operator);
- $sql = $this->getSpatialFunctionCall($functionName, $column, $hasArgument);
- if ($hasArgument) {
- $arguments[] = $value;
- }
- return $sql;
- }
-
- public function getWhereClause(Condition $condition, array &$arguments): String
- {
- if ($condition instanceof NoCondition) {
- return '';
- }
- return ' WHERE ' . $this->getConditionSql($condition, $arguments);
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Database/DataConverter.php
-
- class DataConverter
- {
- private $driver;
-
- public function __construct(String $driver)
- {
- $this->driver = $driver;
- }
-
- private function convertRecordValue($conversion, $value)
- {
- switch ($conversion) {
- case 'boolean':
- return $value ? true : false;
- }
- return $value;
- }
-
- private function getRecordValueConversion(ReflectedColumn $column): String
- {
- if (in_array($this->driver, ['mysql', 'sqlsrv']) && $column->isBoolean()) {
- return 'boolean';
- }
- return 'none';
- }
-
- public function convertRecords(ReflectedTable $table, array $columnNames, array &$records) /*: void*/
- {
- foreach ($columnNames as $columnName) {
- $column = $table->getColumn($columnName);
- $conversion = $this->getRecordValueConversion($column);
- if ($conversion != 'none') {
- foreach ($records as $i => $record) {
- $value = $records[$i][$columnName];
- if ($value === null) {
- continue;
- }
- $records[$i][$columnName] = $this->convertRecordValue($conversion, $value);
- }
- }
- }
- }
-
- private function convertInputValue($conversion, $value)
- {
- switch ($conversion) {
- case 'base64url_to_base64':
- return str_pad(strtr($value, '-_', '+/'), ceil(strlen($value) / 4) * 4, '=', STR_PAD_RIGHT);
- }
- return $value;
- }
-
- private function getInputValueConversion(ReflectedColumn $column): String
- {
- if ($column->isBinary()) {
- return 'base64url_to_base64';
- }
- return 'none';
- }
-
- public function convertColumnValues(ReflectedTable $table, array &$columnValues) /*: void*/
- {
- $columnNames = array_keys($columnValues);
- foreach ($columnNames as $columnName) {
- $column = $table->getColumn($columnName);
- $conversion = $this->getInputValueConversion($column);
- if ($conversion != 'none') {
- $value = $columnValues[$columnName];
- if ($value !== null) {
- $columnValues[$columnName] = $this->convertInputValue($conversion, $value);
- }
- }
- }
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Database/GenericDB.php
-
- class GenericDB
- {
- private $driver;
- private $database;
- private $pdo;
- private $reflection;
- private $definition;
- private $conditions;
- private $columns;
- private $converter;
-
- private function getDsn(String $address, String $port = null, String $database = null): String
- {
- switch ($this->driver) {
- case 'mysql':return "$this->driver:host=$address;port=$port;dbname=$database;charset=utf8mb4";
- case 'pgsql':return "$this->driver:host=$address port=$port dbname=$database options='--client_encoding=UTF8'";
- case 'sqlsrv':return "$this->driver:Server=$address,$port;Database=$database";
- }
- }
-
- private function getCommands(): array
- {
- switch ($this->driver) {
- case 'mysql':return [
- 'SET SESSION sql_warnings=1;',
- 'SET NAMES utf8mb4;',
- 'SET SESSION sql_mode = "ANSI,TRADITIONAL";',
- ];
- case 'pgsql':return [
- "SET NAMES 'UTF8';",
- ];
- case 'sqlsrv':return [
- ];
- }
- }
-
- private function getOptions(): array
- {
- $options = array(
- \PDO::ATTR_ERRMODE => \PDO::ERRMODE_EXCEPTION,
- \PDO::ATTR_DEFAULT_FETCH_MODE => \PDO::FETCH_ASSOC,
- );
- switch ($this->driver) {
- case 'mysql':return $options + [
- \PDO::ATTR_EMULATE_PREPARES => false,
- \PDO::MYSQL_ATTR_FOUND_ROWS => true,
- \PDO::ATTR_PERSISTENT => true,
- ];
- case 'pgsql':return $options + [
- \PDO::ATTR_EMULATE_PREPARES => false,
- \PDO::ATTR_PERSISTENT => true,
- ];
- case 'sqlsrv':return $options + [
- \PDO::SQLSRV_ATTR_FETCHES_NUMERIC_TYPE => true,
- ];
- }
- }
-
- public function __construct(String $driver, String $address, String $port = null, String $database = null, String $username = null, String $password = null)
- {
- $this->driver = $driver;
- $this->database = $database;
- $dsn = $this->getDsn($address, $port, $database);
- $options = $this->getOptions();
- $this->pdo = new \PDO($dsn, $username, $password, $options);
- $commands = $this->getCommands();
- foreach ($commands as $command) {
- $this->pdo->query($command);
- }
- $this->reflection = new GenericReflection($this->pdo, $driver, $database);
- $this->definition = new GenericDefinition($this->pdo, $driver, $database);
- $this->conditions = new ConditionsBuilder($driver);
- $this->columns = new ColumnsBuilder($driver);
- $this->converter = new DataConverter($driver);
- }
-
- public function pdo(): \PDO
- {
- return $this->pdo;
- }
-
- public function reflection(): GenericReflection
- {
- return $this->reflection;
- }
-
- public function definition(): GenericDefinition
- {
- return $this->definition;
- }
-
- private function addMiddlewareConditions(String $tableName, Condition $condition): Condition
- {
- $condition1 = VariableStore::get("authorization.conditions.$tableName");
- if ($condition1) {
- $condition = $condition->_and($condition1);
- }
- $condition2 = VariableStore::get("multiTenancy.conditions.$tableName");
- if ($condition2) {
- $condition = $condition->_and($condition2);
- }
- return $condition;
- }
-
- public function createSingle(ReflectedTable $table, array $columnValues) /*: ?String*/
- {
- $this->converter->convertColumnValues($table, $columnValues);
- $insertColumns = $this->columns->getInsert($table, $columnValues);
- $tableName = $table->getName();
- $pkName = $table->getPk()->getName();
- $parameters = array_values($columnValues);
- $sql = 'INSERT INTO "' . $tableName . '" ' . $insertColumns;
- $stmt = $this->query($sql, $parameters);
- if (isset($columnValues[$pkName])) {
- return $columnValues[$pkName];
- }
- switch ($this->driver) {
- case 'mysql':
- $stmt = $this->query('SELECT LAST_INSERT_ID()', []);
- break;
- }
- return $stmt->fetchColumn(0);
- }
-
- public function selectSingle(ReflectedTable $table, array $columnNames, String $id) /*: ?array*/
- {
- $selectColumns = $this->columns->getSelect($table, $columnNames);
- $tableName = $table->getName();
- $condition = new ColumnCondition($table->getPk(), 'eq', $id);
- $condition = $this->addMiddlewareConditions($tableName, $condition);
- $parameters = array();
- $whereClause = $this->conditions->getWhereClause($condition, $parameters);
- $sql = 'SELECT ' . $selectColumns . ' FROM "' . $tableName . '" ' . $whereClause;
- $stmt = $this->query($sql, $parameters);
- $record = $stmt->fetch() ?: null;
- if ($record === null) {
- return null;
- }
- $records = array($record);
- $this->converter->convertRecords($table, $columnNames, $records);
- return $records[0];
- }
-
- public function selectMultiple(ReflectedTable $table, array $columnNames, array $ids): array
- {
- if (count($ids) == 0) {
- return [];
- }
- $selectColumns = $this->columns->getSelect($table, $columnNames);
- $tableName = $table->getName();
- $condition = new ColumnCondition($table->getPk(), 'in', implode(',', $ids));
- $condition = $this->addMiddlewareConditions($tableName, $condition);
- $parameters = array();
- $whereClause = $this->conditions->getWhereClause($condition, $parameters);
- $sql = 'SELECT ' . $selectColumns . ' FROM "' . $tableName . '" ' . $whereClause;
- $stmt = $this->query($sql, $parameters);
- $records = $stmt->fetchAll();
- $this->converter->convertRecords($table, $columnNames, $records);
- return $records;
- }
-
- public function selectCount(ReflectedTable $table, Condition $condition): int
- {
- $tableName = $table->getName();
- $condition = $this->addMiddlewareConditions($tableName, $condition);
- $parameters = array();
- $whereClause = $this->conditions->getWhereClause($condition, $parameters);
- $sql = 'SELECT COUNT(*) FROM "' . $tableName . '"' . $whereClause;
- $stmt = $this->query($sql, $parameters);
- return $stmt->fetchColumn(0);
- }
-
- public function selectAllUnordered(ReflectedTable $table, array $columnNames, Condition $condition): array
- {
- $selectColumns = $this->columns->getSelect($table, $columnNames);
- $tableName = $table->getName();
- $condition = $this->addMiddlewareConditions($tableName, $condition);
- $parameters = array();
- $whereClause = $this->conditions->getWhereClause($condition, $parameters);
- $sql = 'SELECT ' . $selectColumns . ' FROM "' . $tableName . '"' . $whereClause;
- $stmt = $this->query($sql, $parameters);
- $records = $stmt->fetchAll();
- $this->converter->convertRecords($table, $columnNames, $records);
- return $records;
- }
-
- public function selectAll(ReflectedTable $table, array $columnNames, Condition $condition, array $columnOrdering, int $offset, int $limit): array
- {
- if ($limit == 0) {
- return array();
- }
- $selectColumns = $this->columns->getSelect($table, $columnNames);
- $tableName = $table->getName();
- $condition = $this->addMiddlewareConditions($tableName, $condition);
- $parameters = array();
- $whereClause = $this->conditions->getWhereClause($condition, $parameters);
- $orderBy = $this->columns->getOrderBy($table, $columnOrdering);
- $offsetLimit = $this->columns->getOffsetLimit($offset, $limit);
- $sql = 'SELECT ' . $selectColumns . ' FROM "' . $tableName . '"' . $whereClause . ' ORDER BY ' . $orderBy . ' ' . $offsetLimit;
- $stmt = $this->query($sql, $parameters);
- $records = $stmt->fetchAll();
- $this->converter->convertRecords($table, $columnNames, $records);
- return $records;
- }
-
- public function updateSingle(ReflectedTable $table, array $columnValues, String $id)
- {
- if (count($columnValues) == 0) {
- return 0;
- }
- $this->converter->convertColumnValues($table, $columnValues);
- $updateColumns = $this->columns->getUpdate($table, $columnValues);
- $tableName = $table->getName();
- $condition = new ColumnCondition($table->getPk(), 'eq', $id);
- $condition = $this->addMiddlewareConditions($tableName, $condition);
- $parameters = array_values($columnValues);
- $whereClause = $this->conditions->getWhereClause($condition, $parameters);
- $sql = 'UPDATE "' . $tableName . '" SET ' . $updateColumns . $whereClause;
- $stmt = $this->query($sql, $parameters);
- return $stmt->rowCount();
- }
-
- public function deleteSingle(ReflectedTable $table, String $id)
- {
- $tableName = $table->getName();
- $condition = new ColumnCondition($table->getPk(), 'eq', $id);
- $condition = $this->addMiddlewareConditions($tableName, $condition);
- $parameters = array();
- $whereClause = $this->conditions->getWhereClause($condition, $parameters);
- $sql = 'DELETE FROM "' . $tableName . '" ' . $whereClause;
- $stmt = $this->query($sql, $parameters);
- return $stmt->rowCount();
- }
-
- public function incrementSingle(ReflectedTable $table, array $columnValues, String $id)
- {
- if (count($columnValues) == 0) {
- return 0;
- }
- $this->converter->convertColumnValues($table, $columnValues);
- $updateColumns = $this->columns->getIncrement($table, $columnValues);
- $tableName = $table->getName();
- $condition = new ColumnCondition($table->getPk(), 'eq', $id);
- $condition = $this->addMiddlewareConditions($tableName, $condition);
- $parameters = array_values($columnValues);
- $whereClause = $this->conditions->getWhereClause($condition, $parameters);
- $sql = 'UPDATE "' . $tableName . '" SET ' . $updateColumns . $whereClause;
- $stmt = $this->query($sql, $parameters);
- return $stmt->rowCount();
- }
-
- private function query(String $sql, array $parameters): \PDOStatement
- {
- $stmt = $this->pdo->prepare($sql);
- $stmt->execute($parameters);
- return $stmt;
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Database/GenericDefinition.php
-
- class GenericDefinition
- {
- private $pdo;
- private $driver;
- private $database;
- private $typeConverter;
- private $reflection;
-
- public function __construct(\PDO $pdo, String $driver, String $database)
- {
- $this->pdo = $pdo;
- $this->driver = $driver;
- $this->database = $database;
- $this->typeConverter = new TypeConverter($driver);
- $this->reflection = new GenericReflection($pdo, $driver, $database);
- }
-
- private function quote(String $identifier): String
- {
- return '"' . str_replace('"', '', $identifier) . '"';
- }
-
- public function getColumnType(ReflectedColumn $column, bool $update): String
- {
- if ($this->driver == 'pgsql' && !$update && $column->getPk() && $this->canAutoIncrement($column)) {
- return 'serial';
- }
- $type = $this->typeConverter->fromJdbc($column->getType());
- if ($column->hasPrecision() && $column->hasScale()) {
- $size = '(' . $column->getPrecision() . ',' . $column->getScale() . ')';
- } else if ($column->hasPrecision()) {
- $size = '(' . $column->getPrecision() . ')';
- } else if ($column->hasLength()) {
- $size = '(' . $column->getLength() . ')';
- } else {
- $size = '';
- }
- $null = $this->getColumnNullType($column, $update);
- $auto = $this->getColumnAutoIncrement($column, $update);
- return $type . $size . $null . $auto;
- }
-
- private function getPrimaryKey(String $tableName): String
- {
- $pks = $this->reflection->getTablePrimaryKeys($tableName);
- if (count($pks) == 1) {
- return $pks[0];
- }
- return "";
- }
-
- private function canAutoIncrement(ReflectedColumn $column): bool
- {
- return in_array($column->getType(), ['integer', 'bigint']);
- }
-
- private function getColumnAutoIncrement(ReflectedColumn $column, bool $update): String
- {
- if (!$this->canAutoIncrement($column)) {
- return '';
- }
- switch ($this->driver) {
- case 'mysql':
- return $column->getPk() ? ' AUTO_INCREMENT' : '';
- case 'pgsql':
- return '';
- case 'sqlsrv':
- return ($column->getPk() && !$update) ? ' IDENTITY(1,1)' : '';
- }
- }
-
- private function getColumnNullType(ReflectedColumn $column, bool $update): String
- {
- if ($this->driver == 'pgsql' && $update) {
- return '';
- }
- return $column->getNullable() ? ' NULL' : ' NOT NULL';
- }
-
- private function getTableRenameSQL(String $tableName, String $newTableName): String
- {
- $p1 = $this->quote($tableName);
- $p2 = $this->quote($newTableName);
-
- switch ($this->driver) {
- case 'mysql':
- return "RENAME TABLE $p1 TO $p2";
- case 'pgsql':
- return "ALTER TABLE $p1 RENAME TO $p2";
- case 'sqlsrv':
- return "EXEC sp_rename $p1, $p2";
- }
- }
-
- private function getColumnRenameSQL(String $tableName, String $columnName, ReflectedColumn $newColumn): String
- {
- $p1 = $this->quote($tableName);
- $p2 = $this->quote($columnName);
- $p3 = $this->quote($newColumn->getName());
-
- switch ($this->driver) {
- case 'mysql':
- $p4 = $this->getColumnType($newColumn, true);
- return "ALTER TABLE $p1 CHANGE $p2 $p3 $p4";
- case 'pgsql':
- return "ALTER TABLE $p1 RENAME COLUMN $p2 TO $p3";
- case 'sqlsrv':
- $p4 = $this->quote($tableName . '.' . $columnName);
- return "EXEC sp_rename $p4, $p3, 'COLUMN'";
- }
- }
-
- private function getColumnRetypeSQL(String $tableName, String $columnName, ReflectedColumn $newColumn): String
- {
- $p1 = $this->quote($tableName);
- $p2 = $this->quote($columnName);
- $p3 = $this->quote($newColumn->getName());
- $p4 = $this->getColumnType($newColumn, true);
-
- switch ($this->driver) {
- case 'mysql':
- return "ALTER TABLE $p1 CHANGE $p2 $p3 $p4";
- case 'pgsql':
- return "ALTER TABLE $p1 ALTER COLUMN $p3 TYPE $p4";
- case 'sqlsrv':
- return "ALTER TABLE $p1 ALTER COLUMN $p3 $p4";
- }
- }
-
- private function getSetColumnNullableSQL(String $tableName, String $columnName, ReflectedColumn $newColumn): String
- {
- $p1 = $this->quote($tableName);
- $p2 = $this->quote($columnName);
- $p3 = $this->quote($newColumn->getName());
- $p4 = $this->getColumnType($newColumn, true);
-
- switch ($this->driver) {
- case 'mysql':
- return "ALTER TABLE $p1 CHANGE $p2 $p3 $p4";
- case 'pgsql':
- $p5 = $newColumn->getNullable() ? 'DROP NOT NULL' : 'SET NOT NULL';
- return "ALTER TABLE $p1 ALTER COLUMN $p2 $p5";
- case 'sqlsrv':
- return "ALTER TABLE $p1 ALTER COLUMN $p2 $p4";
- }
- }
-
- private function getSetColumnPkConstraintSQL(String $tableName, String $columnName, ReflectedColumn $newColumn): String
- {
- $p1 = $this->quote($tableName);
- $p2 = $this->quote($columnName);
- $p3 = $this->quote($tableName . '_pkey');
-
- switch ($this->driver) {
- case 'mysql':
- $p4 = $newColumn->getPk() ? "ADD PRIMARY KEY ($p2)" : 'DROP PRIMARY KEY';
- return "ALTER TABLE $p1 $p4";
- case 'pgsql':
- case 'sqlsrv':
- $p4 = $newColumn->getPk() ? "ADD PRIMARY KEY ($p2)" : "DROP CONSTRAINT $p3";
- return "ALTER TABLE $p1 $p4";
- }
- }
-
- private function getSetColumnPkSequenceSQL(String $tableName, String $columnName, ReflectedColumn $newColumn): String
- {
- $p1 = $this->quote($tableName);
- $p2 = $this->quote($columnName);
- $p3 = $this->quote($tableName . '_' . $columnName . '_seq');
-
- switch ($this->driver) {
- case 'mysql':
- return "select 1";
- case 'pgsql':
- return $newColumn->getPk() ? "CREATE SEQUENCE $p3 OWNED BY $p1.$p2" : "DROP SEQUENCE $p3";
- case 'sqlsrv':
- return $newColumn->getPk() ? "CREATE SEQUENCE $p3" : "DROP SEQUENCE $p3";
- }
- }
-
- private function getSetColumnPkSequenceStartSQL(String $tableName, String $columnName, ReflectedColumn $newColumn): String
- {
- $p1 = $this->quote($tableName);
- $p2 = $this->quote($columnName);
- $p3 = $this->pdo->quote($tableName . '_' . $columnName . '_seq');
-
- switch ($this->driver) {
- case 'mysql':
- return "select 1";
- case 'pgsql':
- return "SELECT setval($p3, (SELECT max($p2)+1 FROM $p1));";
- case 'sqlsrv':
- return "ALTER SEQUENCE $p3 RESTART WITH (SELECT max($p2)+1 FROM $p1)";
- }
- }
-
- private function getSetColumnPkDefaultSQL(String $tableName, String $columnName, ReflectedColumn $newColumn): String
- {
- $p1 = $this->quote($tableName);
- $p2 = $this->quote($columnName);
-
- switch ($this->driver) {
- case 'mysql':
- $p3 = $this->quote($newColumn->getName());
- $p4 = $this->getColumnType($newColumn, true);
- return "ALTER TABLE $p1 CHANGE $p2 $p3 $p4";
- case 'pgsql':
- if ($newColumn->getPk()) {
- $p3 = $this->pdo->quote($tableName . '_' . $columnName . '_seq');
- $p4 = "SET DEFAULT nextval($p3)";
- } else {
- $p4 = 'DROP DEFAULT';
- }
- return "ALTER TABLE $p1 ALTER COLUMN $p2 $p4";
- case 'sqlsrv':
- $p3 = $this->pdo->quote($tableName . '_' . $columnName . '_seq');
- $p4 = $this->quote('DF_' . $tableName . '_' . $columnName);
- if ($newColumn->getPk()) {
- return "ALTER TABLE $p1 ADD CONSTRAINT $p4 DEFAULT NEXT VALUE FOR $p3 FOR $p2";
- } else {
- return "ALTER TABLE $p1 DROP CONSTRAINT $p4";
- }
- }
- }
-
- private function getAddColumnFkConstraintSQL(String $tableName, String $columnName, ReflectedColumn $newColumn): String
- {
- $p1 = $this->quote($tableName);
- $p2 = $this->quote($columnName);
- $p3 = $this->quote($tableName . '_' . $columnName . '_fkey');
- $p4 = $this->quote($newColumn->getFk());
- $p5 = $this->quote($this->getPrimaryKey($newColumn->getFk()));
-
- return "ALTER TABLE $p1 ADD CONSTRAINT $p3 FOREIGN KEY ($p2) REFERENCES $p4 ($p5)";
- }
-
- private function getRemoveColumnFkConstraintSQL(String $tableName, String $columnName, ReflectedColumn $newColumn): String
- {
- $p1 = $this->quote($tableName);
- $p2 = $this->quote($tableName . '_' . $columnName . '_fkey');
-
- switch ($this->driver) {
- case 'mysql':
- return "ALTER TABLE $p1 DROP FOREIGN KEY $p2";
- case 'pgsql':
- case 'sqlsrv':
- return "ALTER TABLE $p1 DROP CONSTRAINT $p2";
- }
- }
-
- private function getAddTableSQL(ReflectedTable $newTable): String
- {
- $tableName = $newTable->getName();
- $p1 = $this->quote($tableName);
- $fields = [];
- $constraints = [];
- foreach ($newTable->columnNames() as $columnName) {
- $newColumn = $newTable->getColumn($columnName);
- $f1 = $this->quote($columnName);
- $f2 = $this->getColumnType($newColumn, false);
- $f3 = $this->quote($tableName . '_' . $columnName . '_fkey');
- $f4 = $this->quote($newColumn->getFk());
- $f5 = $this->quote($this->getPrimaryKey($newColumn->getFk()));
- $fields[] = "$f1 $f2";
- if ($newColumn->getPk()) {
- $constraints[] = "PRIMARY KEY ($f1)";
- }
- if ($newColumn->getFk()) {
- $constraints[] = "CONSTRAINT $f3 FOREIGN KEY ($f1) REFERENCES $f4 ($f5)";
- }
- }
- $p2 = implode(',', array_merge($fields, $constraints));
-
- return "CREATE TABLE $p1 ($p2);";
- }
-
- private function getAddColumnSQL(String $tableName, ReflectedColumn $newColumn): String
- {
- $p1 = $this->quote($tableName);
- $p2 = $this->quote($newColumn->getName());
- $p3 = $this->getColumnType($newColumn, false);
-
- return "ALTER TABLE $p1 ADD COLUMN $p2 $p3";
- }
-
- private function getRemoveTableSQL(String $tableName): String
- {
- $p1 = $this->quote($tableName);
-
- return "DROP TABLE $p1 CASCADE;";
- }
-
- private function getRemoveColumnSQL(String $tableName, String $columnName): String
- {
- $p1 = $this->quote($tableName);
- $p2 = $this->quote($columnName);
-
- return "ALTER TABLE $p1 DROP COLUMN $p2 CASCADE;";
- }
-
- public function renameTable(String $tableName, String $newTableName)
- {
- $sql = $this->getTableRenameSQL($tableName, $newTableName);
- return $this->query($sql);
- }
-
- public function renameColumn(String $tableName, String $columnName, ReflectedColumn $newColumn)
- {
- $sql = $this->getColumnRenameSQL($tableName, $columnName, $newColumn);
- return $this->query($sql);
- }
-
- public function retypeColumn(String $tableName, String $columnName, ReflectedColumn $newColumn)
- {
- $sql = $this->getColumnRetypeSQL($tableName, $columnName, $newColumn);
- return $this->query($sql);
- }
-
- public function setColumnNullable(String $tableName, String $columnName, ReflectedColumn $newColumn)
- {
- $sql = $this->getSetColumnNullableSQL($tableName, $columnName, $newColumn);
- return $this->query($sql);
- }
-
- public function addColumnPrimaryKey(String $tableName, String $columnName, ReflectedColumn $newColumn)
- {
- $sql = $this->getSetColumnPkConstraintSQL($tableName, $columnName, $newColumn);
- $this->query($sql);
- if ($this->canAutoIncrement($newColumn)) {
- $sql = $this->getSetColumnPkSequenceSQL($tableName, $columnName, $newColumn);
- $this->query($sql);
- $sql = $this->getSetColumnPkSequenceStartSQL($tableName, $columnName, $newColumn);
- $this->query($sql);
- $sql = $this->getSetColumnPkDefaultSQL($tableName, $columnName, $newColumn);
- $this->query($sql);
- }
- return true;
- }
-
- public function removeColumnPrimaryKey(String $tableName, String $columnName, ReflectedColumn $newColumn)
- {
- if ($this->canAutoIncrement($newColumn)) {
- $sql = $this->getSetColumnPkDefaultSQL($tableName, $columnName, $newColumn);
- $this->query($sql);
- $sql = $this->getSetColumnPkSequenceSQL($tableName, $columnName, $newColumn);
- $this->query($sql);
- }
- $sql = $this->getSetColumnPkConstraintSQL($tableName, $columnName, $newColumn);
- $this->query($sql);
- return true;
- }
-
- public function addColumnForeignKey(String $tableName, String $columnName, ReflectedColumn $newColumn)
- {
- $sql = $this->getAddColumnFkConstraintSQL($tableName, $columnName, $newColumn);
- return $this->query($sql);
- }
-
- public function removeColumnForeignKey(String $tableName, String $columnName, ReflectedColumn $newColumn)
- {
- $sql = $this->getRemoveColumnFkConstraintSQL($tableName, $columnName, $newColumn);
- return $this->query($sql);
- }
-
- public function addTable(ReflectedTable $newTable)
- {
- $sql = $this->getAddTableSQL($newTable);
- return $this->query($sql);
- }
-
- public function addColumn(String $tableName, ReflectedColumn $newColumn)
- {
- $sql = $this->getAddColumnSQL($tableName, $newColumn);
- return $this->query($sql);
- }
-
- public function removeTable(String $tableName)
- {
- $sql = $this->getRemoveTableSQL($tableName);
- return $this->query($sql);
- }
-
- public function removeColumn(String $tableName, String $columnName)
- {
- $sql = $this->getRemoveColumnSQL($tableName, $columnName);
- return $this->query($sql);
- }
-
- private function query(String $sql): bool
- {
- $stmt = $this->pdo->prepare($sql);
- return $stmt->execute();
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Database/GenericReflection.php
-
- class GenericReflection
- {
- private $pdo;
- private $driver;
- private $database;
- private $typeConverter;
-
- public function __construct(\PDO $pdo, String $driver, String $database)
- {
- $this->pdo = $pdo;
- $this->driver = $driver;
- $this->database = $database;
- $this->typeConverter = new TypeConverter($driver);
- }
-
- public function getIgnoredTables(): array
- {
- switch ($this->driver) {
- case 'mysql':return [];
- case 'pgsql':return ['spatial_ref_sys', 'raster_columns', 'raster_overviews', 'geography_columns', 'geometry_columns'];
- case 'sqlsrv':return [];
- }
- }
-
- private function getTablesSQL(): String
- {
- switch ($this->driver) {
- case 'mysql':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"';
- case 'pgsql':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";';
- case 'sqlsrv':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"';
- }
- }
-
- private function getTableColumnsSQL(): String
- {
- switch ($this->driver) {
- case 'mysql':return 'SELECT "COLUMN_NAME", "IS_NULLABLE", "DATA_TYPE", "CHARACTER_MAXIMUM_LENGTH", "NUMERIC_PRECISION", "NUMERIC_SCALE" FROM "INFORMATION_SCHEMA"."COLUMNS" WHERE "TABLE_NAME" = ? AND "TABLE_SCHEMA" = ?';
- case 'pgsql':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" 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;';
- case 'sqlsrv':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" 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 \'\' <> ?';
- }
- }
-
- private function getTablePrimaryKeysSQL(): String
- {
- switch ($this->driver) {
- case 'mysql':return 'SELECT "COLUMN_NAME" FROM "INFORMATION_SCHEMA"."KEY_COLUMN_USAGE" WHERE "CONSTRAINT_NAME" = \'PRIMARY\' AND "TABLE_NAME" = ? AND "TABLE_SCHEMA" = ?';
- case 'pgsql':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\'';
- case 'sqlsrv':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 \'\' <> ?';
- }
- }
-
- private function getTableForeignKeysSQL(): String
- {
- switch ($this->driver) {
- case 'mysql':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" = ?';
- case 'pgsql':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\'';
- case 'sqlsrv':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 \'\' <> ?';
- }
- }
-
- public function getDatabaseName(): String
- {
- return $this->database;
- }
-
- public function getTables(): array
- {
- $sql = $this->getTablesSQL();
- $results = $this->query($sql, [$this->database]);
- foreach ($results as &$result) {
- switch ($this->driver) {
- case 'mysql':
- $map = ['BASE TABLE' => 'table', 'VIEW' => 'view'];
- $result['TABLE_TYPE'] = $map[$result['TABLE_TYPE']];
- break;
- case 'pgsql':
- $map = ['r' => 'table', 'v' => 'view'];
- $result['TABLE_TYPE'] = $map[$result['TABLE_TYPE']];
- break;
- case 'sqlsrv':
- $map = ['U' => 'table', 'V' => 'view'];
- $result['TABLE_TYPE'] = $map[trim($result['TABLE_TYPE'])];
- break;
- }
- }
- return $results;
- }
-
- public function getTableColumns(String $tableName, String $type): array
- {
- $sql = $this->getTableColumnsSQL();
- $results = $this->query($sql, [$tableName, $this->database]);
- if ($type == 'view') {
- foreach ($results as &$result) {
- $result['IS_NULLABLE'] = false;
- }
- }
- return $results;
- }
-
- public function getTablePrimaryKeys(String $tableName): array
- {
- $sql = $this->getTablePrimaryKeysSQL();
- $results = $this->query($sql, [$tableName, $this->database]);
- $primaryKeys = [];
- foreach ($results as $result) {
- $primaryKeys[] = $result['COLUMN_NAME'];
- }
- return $primaryKeys;
- }
-
- public function getTableForeignKeys(String $tableName): array
- {
- $sql = $this->getTableForeignKeysSQL();
- $results = $this->query($sql, [$tableName, $this->database]);
- $foreignKeys = [];
- foreach ($results as $result) {
- $foreignKeys[$result['COLUMN_NAME']] = $result['REFERENCED_TABLE_NAME'];
- }
- return $foreignKeys;
- }
-
- public function toJdbcType(String $type, int $size): String
- {
- return $this->typeConverter->toJdbc($type, $size);
- }
-
- private function query(String $sql, array $parameters): array
- {
- $stmt = $this->pdo->prepare($sql);
- $stmt->execute($parameters);
- return $stmt->fetchAll();
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Database/TypeConverter.php
-
- class TypeConverter
- {
- private $driver;
-
- public function __construct(String $driver)
- {
- $this->driver = $driver;
- }
-
- private $fromJdbc = [
- 'mysql' => [
- 'clob' => 'longtext',
- 'boolean' => 'bit',
- 'blob' => 'longblob',
- 'timestamp' => 'datetime',
- ],
- 'pgsql' => [
- 'clob' => 'text',
- 'blob' => 'bytea',
- ],
- 'sqlsrv' => [
- 'boolean' => 'bit',
- 'varchar' => 'nvarchar',
- 'clob' => 'ntext',
- 'blob' => 'image',
- ],
- ];
-
- private $toJdbc = [
- 'simplified' => [
- 'char' => 'varchar',
- 'longvarchar' => 'clob',
- 'nchar' => 'varchar',
- 'nvarchar' => 'varchar',
- 'longnvarchar' => 'clob',
- 'binary' => 'varbinary',
- 'longvarbinary' => 'blob',
- 'tinyint' => 'integer',
- 'smallint' => 'integer',
- 'real' => 'float',
- 'numeric' => 'decimal',
- 'time_with_timezone' => 'time',
- 'timestamp_with_timezone' => 'timestamp',
- ],
- 'mysql' => [
- 'tinyint(1)' => 'boolean',
- 'bit(0)' => 'boolean',
- 'bit(1)' => 'boolean',
- 'tinyblob' => 'blob',
- 'mediumblob' => 'blob',
- 'longblob' => 'blob',
- 'tinytext' => 'clob',
- 'mediumtext' => 'clob',
- 'longtext' => 'clob',
- 'text' => 'clob',
- 'mediumint' => 'integer',
- 'int' => 'integer',
- 'polygon' => 'geometry',
- 'point' => 'geometry',
- 'datetime' => 'timestamp',
- 'enum' => 'varchar',
- 'json' => 'clob',
- ],
- 'pgsql' => [
- 'bigserial' => 'bigint',
- 'bit varying' => 'bit',
- 'box' => 'geometry',
- 'bytea' => 'blob',
- 'character varying' => 'varchar',
- 'character' => 'char',
- 'cidr' => 'varchar',
- 'circle' => 'geometry',
- 'double precision' => 'double',
- 'inet' => 'integer',
- 'json' => 'clob',
- 'jsonb' => 'clob',
- 'line' => 'geometry',
- 'lseg' => 'geometry',
- 'macaddr' => 'varchar',
- 'money' => 'decimal',
- 'path' => 'geometry',
- 'point' => 'geometry',
- 'polygon' => 'geometry',
- 'real' => 'float',
- 'serial' => 'integer',
- 'text' => 'clob',
- 'time without time zone' => 'time',
- 'time with time zone' => 'time_with_timezone',
- 'timestamp without time zone' => 'timestamp',
- 'timestamp with time zone' => 'timestamp_with_timezone',
- 'uuid' => 'char',
- 'xml' => 'clob',
- ],
- 'sqlsrv' => [
- 'varbinary(0)' => 'blob',
- 'bit' => 'boolean',
- 'datetime' => 'timestamp',
- 'datetime2' => 'timestamp',
- 'float' => 'double',
- 'image' => 'blob',
- 'int' => 'integer',
- 'money' => 'decimal',
- 'ntext' => 'clob',
- 'smalldatetime' => 'timestamp',
- 'smallmoney' => 'decimal',
- 'text' => 'clob',
- 'timestamp' => 'binary',
- 'udt' => 'varbinary',
- 'uniqueidentifier' => 'char',
- 'xml' => 'clob',
- ],
- ];
-
- private $valid = [
- 'bigint' => true,
- 'binary' => true,
- 'bit' => true,
- 'blob' => true,
- 'boolean' => true,
- 'char' => true,
- 'clob' => true,
- 'date' => true,
- 'decimal' => true,
- 'distinct' => true,
- 'double' => true,
- 'float' => true,
- 'integer' => true,
- 'longnvarchar' => true,
- 'longvarbinary' => true,
- 'longvarchar' => true,
- 'nchar' => true,
- 'nclob' => true,
- 'numeric' => true,
- 'nvarchar' => true,
- 'real' => true,
- 'smallint' => true,
- 'time' => true,
- 'time_with_timezone' => true,
- 'timestamp' => true,
- 'timestamp_with_timezone' => true,
- 'tinyint' => true,
- 'varbinary' => true,
- 'varchar' => true,
- 'geometry' => true,
- ];
-
- public function toJdbc(String $type, int $size): String
- {
- $jdbcType = strtolower($type);
- if (isset($this->toJdbc[$this->driver]["$jdbcType($size)"])) {
- $jdbcType = $this->toJdbc[$this->driver]["$jdbcType($size)"];
- }
- if (isset($this->toJdbc[$this->driver][$jdbcType])) {
- $jdbcType = $this->toJdbc[$this->driver][$jdbcType];
- }
- if (isset($this->toJdbc['simplified'][$jdbcType])) {
- $jdbcType = $this->toJdbc['simplified'][$jdbcType];
- }
- if (!isset($this->valid[$jdbcType])) {
- throw new \Exception("Unsupported type '$jdbcType' for driver '$this->driver'");
- }
- return $jdbcType;
- }
-
- public function fromJdbc(String $type): String
- {
- $jdbcType = strtolower($type);
- if (isset($this->fromJdbc[$this->driver][$jdbcType])) {
- $jdbcType = $this->fromJdbc[$this->driver][$jdbcType];
- }
- return $jdbcType;
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Middleware/Base/Handler.php
-
- interface Handler
- {
- public function handle(Request $request): Response;
- }
-
- // file: src/Tqdev/PhpCrudApi/Middleware/Base/Middleware.php
-
- abstract class Middleware implements Handler
- {
- protected $next;
- protected $responder;
- private $properties;
-
- public function __construct(Router $router, Responder $responder, array $properties)
- {
- $router->load($this);
- $this->responder = $responder;
- $this->properties = $properties;
- }
-
- public function setNext(Handler $handler) /*: void*/
- {
- $this->next = $handler;
- }
-
- protected function getArrayProperty(String $key, String $default): array
- {
- return array_filter(array_map('trim', explode(',', $this->getProperty($key, $default))));
- }
-
- protected function getProperty(String $key, $default)
- {
- return isset($this->properties[$key]) ? $this->properties[$key] : $default;
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Middleware/Communication/VariableStore.php
-
- class VariableStore
- {
- static $values = array();
-
- public static function get(String $key)
- {
- if (isset(self::$values[$key])) {
- return self::$values[$key];
- }
- return null;
- }
-
- public static function set(String $key, /* object */ $value)
- {
- self::$values[$key] = $value;
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Middleware/Router/Router.php
-
- interface Router extends Handler
- {
- public function register(String $method, String $path, array $handler);
-
- public function load(Middleware $middleware);
-
- public function route(Request $request): Response;
- }
-
- // file: src/Tqdev/PhpCrudApi/Middleware/Router/SimpleRouter.php
-
- class SimpleRouter implements Router
- {
- private $responder;
- private $cache;
- private $ttl;
- private $registration;
- private $routes;
- private $routeHandlers;
- private $middlewares;
-
- public function __construct(Responder $responder, Cache $cache, int $ttl)
- {
- $this->responder = $responder;
- $this->cache = $cache;
- $this->ttl = $ttl;
- $this->registration = true;
- $this->routes = $this->loadPathTree();
- $this->routeHandlers = [];
- $this->middlewares = array();
- }
-
- private function loadPathTree(): PathTree
- {
- $data = $this->cache->get('PathTree');
- if ($data != '') {
- $tree = PathTree::fromJson(json_decode(gzuncompress($data)));
- $this->registration = false;
- } else {
- $tree = new PathTree();
- }
- return $tree;
- }
-
- public function register(String $method, String $path, array $handler)
- {
- $routeNumber = count($this->routeHandlers);
- $this->routeHandlers[$routeNumber] = $handler;
- if ($this->registration) {
- $parts = explode('/', trim($path, '/'));
- array_unshift($parts, $method);
- $this->routes->put($parts, $routeNumber);
- }
- }
-
- public function load(Middleware $middleware) /*: void*/
- {
- if (count($this->middlewares) > 0) {
- $next = $this->middlewares[0];
- } else {
- $next = $this;
- }
- $middleware->setNext($next);
- array_unshift($this->middlewares, $middleware);
- }
-
- public function route(Request $request): Response
- {
- if ($this->registration) {
- $data = gzcompress(json_encode($this->routes, JSON_UNESCAPED_UNICODE));
- $this->cache->set('PathTree', $data, $this->ttl);
- }
- $obj = $this;
- if (count($this->middlewares) > 0) {
- $obj = $this->middlewares[0];
- }
- return $obj->handle($request);
- }
-
- private function getRouteNumbers(Request $request): array
- {
- $method = strtoupper($request->getMethod());
- $path = explode('/', trim($request->getPath(0), '/'));
- array_unshift($path, $method);
- return $this->routes->match($path);
- }
-
- public function handle(Request $request): Response
- {
- $routeNumbers = $this->getRouteNumbers($request);
- if (count($routeNumbers) == 0) {
- return $this->responder->error(ErrorCode::ROUTE_NOT_FOUND, $request->getPath());
- }
- return call_user_func($this->routeHandlers[$routeNumbers[0]], $request);
- }
-
- }
-
- // file: src/Tqdev/PhpCrudApi/Middleware/AjaxOnlyMiddleware.php
-
- class AjaxOnlyMiddleware extends Middleware
- {
- public function handle(Request $request): Response
- {
- $method = $request->getMethod();
- $excludeMethods = $this->getArrayProperty('excludeMethods', 'OPTIONS,GET');
- if (!in_array($method, $excludeMethods)) {
- $headerName = $this->getProperty('headerName', 'X-Requested-With');
- $headerValue = $this->getProperty('headerValue', 'XMLHttpRequest');
- if ($headerValue != $request->getHeader($headerName)) {
- return $this->responder->error(ErrorCode::ONLY_AJAX_REQUESTS_ALLOWED, $method);
- }
- }
- return $this->next->handle($request);
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Middleware/AuthorizationMiddleware.php
-
- class AuthorizationMiddleware extends Middleware
- {
- private $reflection;
-
- public function __construct(Router $router, Responder $responder, array $properties, ReflectionService $reflection)
- {
- parent::__construct($router, $responder, $properties);
- $this->reflection = $reflection;
- $this->utils = new RequestUtils($reflection);
- }
-
- private function handleColumns(String $operation, String $tableName) /*: void*/
- {
- $columnHandler = $this->getProperty('columnHandler', '');
- if ($columnHandler) {
- $table = $this->reflection->getTable($tableName);
- foreach ($table->columnNames() as $columnName) {
- $allowed = call_user_func($columnHandler, $operation, $tableName, $columnName);
- if (!$allowed) {
- $table->removeColumn($columnName);
- }
- }
- }
- }
-
- private function handleTable(String $operation, String $tableName) /*: void*/
- {
- if (!$this->reflection->hasTable($tableName)) {
- return;
- }
- $tableHandler = $this->getProperty('tableHandler', '');
- if ($tableHandler) {
- $allowed = call_user_func($tableHandler, $operation, $tableName);
- if (!$allowed) {
- $this->reflection->removeTable($tableName);
- } else {
- $this->handleColumns($operation, $tableName);
- }
- }
- }
-
- private function handleRecords(String $operation, String $tableName) /*: void*/
- {
- if (!$this->reflection->hasTable($tableName)) {
- return;
- }
- $recordHandler = $this->getProperty('recordHandler', '');
- if ($recordHandler) {
- $query = call_user_func($recordHandler, $operation, $tableName);
- $filters = new FilterInfo();
- $table = $this->reflection->getTable($tableName);
- $query = str_replace('][]=', ']=', str_replace('=', '[]=', $query));
- parse_str($query, $params);
- $condition = $filters->getCombinedConditions($table, $params);
- VariableStore::set("authorization.conditions.$tableName", $condition);
- }
- }
-
- public function handle(Request $request): Response
- {
- $path = $request->getPathSegment(1);
- $operation = $this->utils->getOperation($request);
- $tableNames = $this->utils->getTableNames($request);
- foreach ($tableNames as $tableName) {
- $this->handleTable($operation, $tableName);
- if ($path == 'records') {
- $this->handleRecords($operation, $tableName);
- }
- }
- if ($path == 'openapi') {
- VariableStore::set('authorization.tableHandler', $this->getProperty('tableHandler', ''));
- VariableStore::set('authorization.columnHandler', $this->getProperty('columnHandler', ''));
- }
- return $this->next->handle($request);
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Middleware/BasicAuthMiddleware.php
-
- class BasicAuthMiddleware extends Middleware
- {
- private function hasCorrectPassword(String $username, String $password, array &$passwords): bool
- {
- $hash = isset($passwords[$username]) ? $passwords[$username] : false;
- if ($hash && password_verify($password, $hash)) {
- if (password_needs_rehash($hash, PASSWORD_DEFAULT)) {
- $passwords[$username] = password_hash($password, PASSWORD_DEFAULT);
- }
- return true;
- }
- return false;
- }
-
- private function getValidUsername(String $username, String $password, String $passwordFile): String
- {
- $passwords = $this->readPasswords($passwordFile);
- $valid = $this->hasCorrectPassword($username, $password, $passwords);
- $this->writePasswords($passwordFile, $passwords);
- return $valid ? $username : '';
- }
-
- private function readPasswords(String $passwordFile): array
- {
- $passwords = [];
- $passwordLines = file($passwordFile);
- foreach ($passwordLines as $passwordLine) {
- if (strpos($passwordLine, ':') !== false) {
- list($username, $hash) = explode(':', trim($passwordLine), 2);
- if (strlen($hash) > 0 && $hash[0] != '$') {
- $hash = password_hash($hash, PASSWORD_DEFAULT);
- }
- $passwords[$username] = $hash;
- }
- }
- return $passwords;
- }
-
- private function writePasswords(String $passwordFile, array $passwords): bool
- {
- $success = false;
- $passwordFileContents = '';
- foreach ($passwords as $username => $hash) {
- $passwordFileContents .= "$username:$hash\n";
- }
- if (file_get_contents($passwordFile) != $passwordFileContents) {
- $success = file_put_contents($passwordFile, $passwordFileContents) !== false;
- }
- return $success;
- }
-
- private function getAuthorizationCredentials(Request $request): String
- {
- if (isset($_SERVER['PHP_AUTH_USER'])) {
- return $_SERVER['PHP_AUTH_USER'] . ':' . $_SERVER['PHP_AUTH_PW'];
- }
- $parts = explode(' ', trim($request->getHeader('Authorization')), 2);
- if (count($parts) != 2) {
- return '';
- }
- if ($parts[0] != 'Basic') {
- return '';
- }
- return base64_decode(strtr($parts[1], '-_', '+/'));
- }
-
- public function handle(Request $request): Response
- {
- if (session_status() == PHP_SESSION_NONE) {
- session_start();
- }
- $credentials = $this->getAuthorizationCredentials($request);
- if ($credentials) {
- list($username, $password) = array('', '');
- if (strpos($credentials, ':') !== false) {
- list($username, $password) = explode(':', $credentials, 2);
- }
- $passwordFile = $this->getProperty('passwordFile', '.htpasswd');
- $validUser = $this->getValidUsername($username, $password, $passwordFile);
- $_SESSION['username'] = $validUser;
- if (!$validUser) {
- return $this->responder->error(ErrorCode::AUTHENTICATION_FAILED, $username);
- }
- if (!headers_sent()) {
- session_regenerate_id();
- }
- }
- if (!isset($_SESSION['username']) || !$_SESSION['username']) {
- $authenticationMode = $this->getProperty('mode', 'required');
- if ($authenticationMode == 'required') {
- $response = $this->responder->error(ErrorCode::AUTHENTICATION_REQUIRED, '');
- $realm = $this->getProperty('realm', 'Username and password required');
- $response->addHeader('WWW-Authenticate', "Basic realm=\"$realm\"");
- return $response;
- }
- }
- return $this->next->handle($request);
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Middleware/CorsMiddleware.php
-
- class CorsMiddleware extends Middleware
- {
- private function isOriginAllowed(String $origin, String $allowedOrigins): bool
- {
- $found = false;
- foreach (explode(',', $allowedOrigins) as $allowedOrigin) {
- $hostname = preg_quote(strtolower(trim($allowedOrigin)));
- $regex = '/^' . str_replace('\*', '.*', $hostname) . '$/';
- if (preg_match($regex, $origin)) {
- $found = true;
- break;
- }
- }
- return $found;
- }
-
- public function handle(Request $request): Response
- {
- $method = $request->getMethod();
- $origin = $request->getHeader('Origin');
- $allowedOrigins = $this->getProperty('allowedOrigins', '*');
- if ($origin && !$this->isOriginAllowed($origin, $allowedOrigins)) {
- $response = $this->responder->error(ErrorCode::ORIGIN_FORBIDDEN, $origin);
- } elseif ($method == 'OPTIONS') {
- $response = new Response(Response::OK, '');
- $allowHeaders = $this->getProperty('allowHeaders', 'Content-Type, X-XSRF-TOKEN, X-Authorization');
- if ($allowHeaders) {
- $response->addHeader('Access-Control-Allow-Headers', $allowHeaders);
- }
- $allowMethods = $this->getProperty('allowMethods', 'OPTIONS, GET, PUT, POST, DELETE, PATCH');
- if ($allowMethods) {
- $response->addHeader('Access-Control-Allow-Methods', $allowMethods);
- }
- $allowCredentials = $this->getProperty('allowCredentials', 'true');
- if ($allowCredentials) {
- $response->addHeader('Access-Control-Allow-Credentials', $allowCredentials);
- }
- $maxAge = $this->getProperty('maxAge', '1728000');
- if ($maxAge) {
- $response->addHeader('Access-Control-Max-Age', $maxAge);
- }
- $exposeHeaders = $this->getProperty('exposeHeaders', '');
- if ($exposeHeaders) {
- $response->addHeader('Access-Control-Expose-Headers', $exposeHeaders);
- }
- } else {
- $response = $this->next->handle($request);
- }
- if ($origin) {
- $allowCredentials = $this->getProperty('allowCredentials', 'true');
- if ($allowCredentials) {
- $response->addHeader('Access-Control-Allow-Credentials', $allowCredentials);
- }
- $response->addHeader('Access-Control-Allow-Origin', $origin);
- }
- return $response;
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Middleware/CustomizationMiddleware.php
-
- class CustomizationMiddleware extends Middleware
- {
- private $reflection;
-
- public function __construct(Router $router, Responder $responder, array $properties, ReflectionService $reflection)
- {
- parent::__construct($router, $responder, $properties);
- $this->reflection = $reflection;
- $this->utils = new RequestUtils($reflection);
- }
-
- public function handle(Request $request): Response
- {
- $operation = $this->utils->getOperation($request);
- $tableName = $request->getPathSegment(2);
- $beforeHandler = $this->getProperty('beforeHandler', '');
- $environment = (object) array();
- if ($beforeHandler !== '') {
- call_user_func($beforeHandler, $operation, $tableName, $request, $environment);
- }
- $response = $this->next->handle($request);
- $afterHandler = $this->getProperty('afterHandler', '');
- if ($afterHandler !== '') {
- call_user_func($afterHandler, $operation, $tableName, $response, $environment);
- }
- return $response;
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Middleware/FileUploadMiddleware.php
-
- class FileUploadMiddleware extends Middleware
- {
- public function handle(Request $request): Response
- {
- $files = $request->getUploadedFiles();
- if (!empty($files)) {
- $body = $request->getBody();
- foreach ($files as $fieldName => $file) {
- if (isset($file['error']) && $file['error']) {
- return $this->responder->error(ErrorCode::FILE_UPLOAD_FAILED, $fieldName);
- }
- foreach ($file as $key => $value) {
- if ($key == 'tmp_name') {
- $value = base64_encode(file_get_contents($value));
- $key = $fieldName;
- } else {
- $key = $fieldName . '_' . $key;
- }
- $body->$key = $value;
- }
- }
- $request->setBody($body);
- }
- return $this->next->handle($request);
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Middleware/FirewallMiddleware.php
-
- class FirewallMiddleware extends Middleware
- {
- private function ipMatch(String $ip, String $cidr): bool
- {
- if (strpos($cidr, '/') !== false) {
- list($subnet, $mask) = explode('/', trim($cidr));
- if ((ip2long($ip) & ~((1 << (32 - $mask)) - 1)) == ip2long($subnet)) {
- return true;
- }
- } else {
- if (ip2long($ip) == ip2long($cidr)) {
- return true;
- }
- }
- return false;
- }
-
- private function isIpAllowed(String $ipAddress, String $allowedIpAddresses): bool
- {
- foreach (explode(',', $allowedIpAddresses) as $allowedIp) {
- if ($this->ipMatch($ipAddress, $allowedIp)) {
- return true;
- }
- }
- return false;
- }
-
- public function handle(Request $request): Response
- {
- $reverseProxy = $this->getProperty('reverseProxy', '');
- if ($reverseProxy) {
- $ipAddress = array_pop(explode(',', $request->getHeader('X-Forwarded-For')));
- } elseif (isset($_SERVER['REMOTE_ADDR'])) {
- $ipAddress = $_SERVER['REMOTE_ADDR'];
- } else {
- $ipAddress = '127.0.0.1';
- }
- $allowedIpAddresses = $this->getProperty('allowedIpAddresses', '');
- if (!$this->isIpAllowed($ipAddress, $allowedIpAddresses)) {
- $response = $this->responder->error(ErrorCode::TEMPORARY_OR_PERMANENTLY_BLOCKED, '');
- } else {
- $response = $this->next->handle($request);
- }
- return $response;
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Middleware/JwtAuthMiddleware.php
-
- class JwtAuthMiddleware extends Middleware
- {
- private function getVerifiedClaims(String $token, int $time, int $leeway, int $ttl, String $secret, array $requirements): array
- {
- $algorithms = array('HS256' => 'sha256', 'HS384' => 'sha384', 'HS512' => 'sha512');
- $token = explode('.', $token);
- if (count($token) < 3) {
- return array();
- }
- $header = json_decode(base64_decode(strtr($token[0], '-_', '+/')), true);
- if (!$secret) {
- return array();
- }
- if ($header['typ'] != 'JWT') {
- return array();
- }
- $algorithm = $header['alg'];
- if (!isset($algorithms[$algorithm])) {
- return array();
- }
- $hmac = $algorithms[$algorithm];
- $signature = bin2hex(base64_decode(strtr($token[2], '-_', '+/')));
- if ($signature != hash_hmac($hmac, "$token[0].$token[1]", $secret)) {
- return array();
- }
- $claims = json_decode(base64_decode(strtr($token[1], '-_', '+/')), true);
- if (!$claims) {
- return array();
- }
- foreach ($requirements as $field => $values) {
- if (!empty($values)) {
- if ($field == 'alg') {
- if (!isset($header[$field]) || !in_array($header[$field], $values)) {
- return array();
- }
- } else {
- if (!isset($claims[$field]) || !in_array($claims[$field], $values)) {
- return array();
- }
- }
- }
- }
- if (isset($claims['nbf']) && $time + $leeway < $claims['nbf']) {
- return array();
- }
- if (isset($claims['iat']) && $time + $leeway < $claims['iat']) {
- return array();
- }
- if (isset($claims['exp']) && $time - $leeway > $claims['exp']) {
- return array();
- }
- if (isset($claims['iat']) && !isset($claims['exp'])) {
- if ($time - $leeway > $claims['iat'] + $ttl) {
- return array();
- }
- }
- return $claims;
- }
-
- private function getClaims(String $token): array
- {
- $time = (int) $this->getProperty('time', time());
- $leeway = (int) $this->getProperty('leeway', '5');
- $ttl = (int) $this->getProperty('ttl', '30');
- $secret = $this->getProperty('secret', '');
- $requirements = array(
- 'alg' => $this->getArrayProperty('algorithms', ''),
- 'aud' => $this->getArrayProperty('audiences', ''),
- 'iss' => $this->getArrayProperty('issuers', ''),
- );
- if (!$secret) {
- return array();
- }
- return $this->getVerifiedClaims($token, $time, $leeway, $ttl, $secret, $requirements);
- }
-
- private function getAuthorizationToken(Request $request): String
- {
- $header = $this->getProperty('header', 'X-Authorization');
- $parts = explode(' ', trim($request->getHeader($header)), 2);
- if (count($parts) != 2) {
- return '';
- }
- if ($parts[0] != 'Bearer') {
- return '';
- }
- return $parts[1];
- }
-
- public function handle(Request $request): Response
- {
- if (session_status() == PHP_SESSION_NONE) {
- session_start();
- }
- $token = $this->getAuthorizationToken($request);
- if ($token) {
- $claims = $this->getClaims($token);
- $_SESSION['claims'] = $claims;
- if (empty($claims)) {
- return $this->responder->error(ErrorCode::AUTHENTICATION_FAILED, 'JWT');
- }
- if (!headers_sent()) {
- session_regenerate_id();
- }
- }
- if (empty($_SESSION['claims'])) {
- $authenticationMode = $this->getProperty('mode', 'required');
- if ($authenticationMode == 'required') {
- return $this->responder->error(ErrorCode::AUTHENTICATION_REQUIRED, '');
- }
- }
- return $this->next->handle($request);
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Middleware/MultiTenancyMiddleware.php
-
- class MultiTenancyMiddleware extends Middleware
- {
- private $reflection;
-
- public function __construct(Router $router, Responder $responder, array $properties, ReflectionService $reflection)
- {
- parent::__construct($router, $responder, $properties);
- $this->reflection = $reflection;
- $this->utils = new RequestUtils($reflection);
- }
-
- private function getCondition(String $tableName, array $pairs): Condition
- {
- $condition = new NoCondition();
- $table = $this->reflection->getTable($tableName);
- foreach ($pairs as $k => $v) {
- $condition = $condition->_and(new ColumnCondition($table->getColumn($k), 'eq', $v));
- }
- return $condition;
- }
-
- private function getPairs($handler, String $operation, String $tableName): array
- {
- $result = array();
- $pairs = call_user_func($handler, $operation, $tableName);
- $table = $this->reflection->getTable($tableName);
- foreach ($pairs as $k => $v) {
- if ($table->hasColumn($k)) {
- $result[$k] = $v;
- }
- }
- return $result;
- }
-
- private function handleRecord(Request $request, String $operation, array $pairs) /*: void*/
- {
- $record = $request->getBody();
- if ($record === null) {
- return;
- }
- $multi = is_array($record);
- $records = $multi ? $record : [$record];
- foreach ($records as &$record) {
- foreach ($pairs as $column => $value) {
- if ($operation == 'create') {
- $record->$column = $value;
- } else {
- if (isset($record->$column)) {
- unset($record->$column);
- }
- }
- }
- }
- $request->setBody($multi ? $records : $records[0]);
- }
-
- public function handle(Request $request): Response
- {
- $handler = $this->getProperty('handler', '');
- if ($handler !== '') {
- $path = $request->getPathSegment(1);
- if ($path == 'records') {
- $operation = $this->utils->getOperation($request);
- $tableNames = $this->utils->getTableNames($request);
- foreach ($tableNames as $i => $tableName) {
- if (!$this->reflection->hasTable($tableName)) {
- continue;
- }
- $pairs = $this->getPairs($handler, $operation, $tableName);
- if ($i == 0) {
- if (in_array($operation, ['create', 'update', 'increment'])) {
- $this->handleRecord($request, $operation, $pairs);
- }
- }
- $condition = $this->getCondition($tableName, $pairs);
- VariableStore::set("multiTenancy.conditions.$tableName", $condition);
- }
- }
- }
- return $this->next->handle($request);
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Middleware/SanitationMiddleware.php
-
- class SanitationMiddleware extends Middleware
- {
- private $reflection;
-
- public function __construct(Router $router, Responder $responder, array $properties, ReflectionService $reflection)
- {
- parent::__construct($router, $responder, $properties);
- $this->reflection = $reflection;
- $this->utils = new RequestUtils($reflection);
- }
-
- private function callHandler($handler, $record, String $operation, ReflectedTable $table) /*: object */
- {
- $context = (array) $record;
- $tableName = $table->getName();
- foreach ($context as $columnName => &$value) {
- if ($table->hasColumn($columnName)) {
- $column = $table->getColumn($columnName);
- $value = call_user_func($handler, $operation, $tableName, $column->serialize(), $value);
- }
- }
- return (object) $context;
- }
-
- public function handle(Request $request): Response
- {
- $operation = $this->utils->getOperation($request);
- if (in_array($operation, ['create', 'update', 'increment'])) {
- $tableName = $request->getPathSegment(2);
- if ($this->reflection->hasTable($tableName)) {
- $record = $request->getBody();
- if ($record !== null) {
- $handler = $this->getProperty('handler', '');
- if ($handler !== '') {
- $table = $this->reflection->getTable($tableName);
- if (is_array($record)) {
- foreach ($record as &$r) {
- $r = $this->callHandler($handler, $r, $operation, $table);
- }
- } else {
- $record = $this->callHandler($handler, $record, $operation, $table);
- }
- $request->setBody($record);
- }
- }
- }
- }
- return $this->next->handle($request);
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Middleware/ValidationMiddleware.php
-
- class ValidationMiddleware extends Middleware
- {
- private $reflection;
-
- public function __construct(Router $router, Responder $responder, array $properties, ReflectionService $reflection)
- {
- parent::__construct($router, $responder, $properties);
- $this->reflection = $reflection;
- $this->utils = new RequestUtils($reflection);
- }
-
- private function callHandler($handler, $record, String $operation, ReflectedTable $table) /*: Response?*/
- {
- $context = (array) $record;
- $details = array();
- $tableName = $table->getName();
- foreach ($context as $columnName => $value) {
- if ($table->hasColumn($columnName)) {
- $column = $table->getColumn($columnName);
- $valid = call_user_func($handler, $operation, $tableName, $column->serialize(), $value, $context);
- if ($valid !== true && $valid !== '') {
- $details[$columnName] = $valid;
- }
- }
- }
- if (count($details) > 0) {
- return $this->responder->error(ErrorCode::INPUT_VALIDATION_FAILED, $tableName, $details);
- }
- return null;
- }
-
- public function handle(Request $request): Response
- {
- $operation = $this->utils->getOperation($request);
- if (in_array($operation, ['create', 'update', 'increment'])) {
- $tableName = $request->getPathSegment(2);
- if ($this->reflection->hasTable($tableName)) {
- $record = $request->getBody();
- if ($record !== null) {
- $handler = $this->getProperty('handler', '');
- if ($handler !== '') {
- $table = $this->reflection->getTable($tableName);
- if (is_array($record)) {
- foreach ($record as $r) {
- $response = $this->callHandler($handler, $r, $operation, $table);
- if ($response !== null) {
- return $response;
- }
- }
- } else {
- $response = $this->callHandler($handler, $record, $operation, $table);
- if ($response !== null) {
- return $response;
- }
- }
- }
- }
- }
- }
- return $this->next->handle($request);
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Middleware/XsrfMiddleware.php
-
- class XsrfMiddleware extends Middleware
- {
- private function getToken(): String
- {
- $cookieName = $this->getProperty('cookieName', 'XSRF-TOKEN');
- if (isset($_COOKIE[$cookieName])) {
- $token = $_COOKIE[$cookieName];
- } else {
- $secure = isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on';
- $token = bin2hex(random_bytes(8));
- if (!headers_sent()) {
- setcookie($cookieName, $token, 0, '', '', $secure);
- }
- }
- return $token;
- }
-
- public function handle(Request $request): Response
- {
- $token = $this->getToken();
- $method = $request->getMethod();
- $excludeMethods = $this->getArrayProperty('excludeMethods', 'OPTIONS,GET');
- if (!in_array($method, $excludeMethods)) {
- $headerName = $this->getProperty('headerName', 'X-XSRF-TOKEN');
- if ($token != $request->getHeader($headerName)) {
- return $this->responder->error(ErrorCode::BAD_OR_MISSING_XSRF_TOKEN, '');
- }
- }
- return $this->next->handle($request);
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/OpenApi/OpenApiBuilder.php
-
- class OpenApiBuilder
- {
- private $openapi;
- private $reflection;
- private $operations = [
- 'list' => 'get',
- 'create' => 'post',
- 'read' => 'get',
- 'update' => 'put',
- 'delete' => 'delete',
- 'increment' => 'patch',
- ];
- private $types = [
- 'integer' => ['type' => 'integer', 'format' => 'int32'],
- 'bigint' => ['type' => 'integer', 'format' => 'int64'],
- 'varchar' => ['type' => 'string'],
- 'clob' => ['type' => 'string'],
- 'varbinary' => ['type' => 'string', 'format' => 'byte'],
- 'blob' => ['type' => 'string', 'format' => 'byte'],
- 'decimal' => ['type' => 'string'],
- 'float' => ['type' => 'number', 'format' => 'float'],
- 'double' => ['type' => 'number', 'format' => 'double'],
- 'time' => ['type' => 'string', 'format' => 'date-time'],
- 'timestamp' => ['type' => 'string', 'format' => 'date-time'],
- 'geometry' => ['type' => 'string'],
- 'boolean' => ['type' => 'boolean'],
- ];
-
- public function __construct(ReflectionService $reflection, $base)
- {
- $this->reflection = $reflection;
- $this->openapi = new OpenApiDefinition($base);
- }
-
- public function build(): OpenApiDefinition
- {
- $this->openapi->set("openapi", "3.0.0");
- $tableNames = $this->reflection->getTableNames();
- foreach ($tableNames as $tableName) {
- $this->setPath($tableName);
- }
- $this->openapi->set("components|responses|pk_integer|description", "inserted primary key value (integer)");
- $this->openapi->set("components|responses|pk_integer|content|application/json|schema|type", "integer");
- $this->openapi->set("components|responses|pk_integer|content|application/json|schema|format", "int64");
- $this->openapi->set("components|responses|pk_string|description", "inserted primary key value (string)");
- $this->openapi->set("components|responses|pk_string|content|application/json|schema|type", "string");
- $this->openapi->set("components|responses|pk_string|content|application/json|schema|format", "uuid");
- $this->openapi->set("components|responses|rows_affected|description", "number of rows affected (integer)");
- $this->openapi->set("components|responses|rows_affected|content|application/json|schema|type", "integer");
- $this->openapi->set("components|responses|rows_affected|content|application/json|schema|format", "int64");
- foreach ($tableNames as $tableName) {
- $this->setComponentSchema($tableName);
- $this->setComponentResponse($tableName);
- $this->setComponentRequestBody($tableName);
- }
- $this->setComponentParameters();
- foreach ($tableNames as $index => $tableName) {
- $this->setTag($index, $tableName);
- }
- return $this->openapi;
- }
-
- private function isOperationOnTableAllowed(String $operation, String $tableName): bool
- {
- $tableHandler = VariableStore::get('authorization.tableHandler');
- if (!$tableHandler) {
- return true;
- }
- return (bool) call_user_func($tableHandler, $operation, $tableName);
- }
-
- private function isOperationOnColumnAllowed(String $operation, String $tableName, String $columnName): bool
- {
- $columnHandler = VariableStore::get('authorization.columnHandler');
- if (!$columnHandler) {
- return true;
- }
- return (bool) call_user_func($columnHandler, $operation, $tableName, $columnName);
- }
-
- private function setPath(String $tableName) /*: void*/
- {
- $table = $this->reflection->getTable($tableName);
- $type = $table->getType($tableName);
- $pk = $table->getPk();
- $pkName = $pk ? $pk->getName() : '';
- foreach ($this->operations as $operation => $method) {
- if (!$pkName && $operation != 'list') {
- continue;
- }
- if ($type != 'table' && $operation != 'list') {
- continue;
- }
- if (!$this->isOperationOnTableAllowed($operation, $tableName)) {
- continue;
- }
- if (in_array($operation, ['list', 'create'])) {
- $path = sprintf('/records/%s', $tableName);
- } else {
- $path = sprintf('/records/%s/{%s}', $tableName, $pkName);
- $this->openapi->set("paths|$path|$method|parameters|0|\$ref", "#/components/parameters/pk");
- }
- if (in_array($operation, ['create', 'update', 'increment'])) {
- $this->openapi->set("paths|$path|$method|requestBody|\$ref", "#/components/requestBodies/$operation-" . urlencode($tableName));
- }
- $this->openapi->set("paths|$path|$method|tags|0", "$tableName");
- $this->openapi->set("paths|$path|$method|description", "$operation $tableName");
- switch ($operation) {
- case 'list':
- $this->openapi->set("paths|$path|$method|responses|200|\$ref", "#/components/responses/$operation-" . urlencode($tableName));
- break;
- case 'create':
- if ($pk->getType() == 'integer') {
- $this->openapi->set("paths|$path|$method|responses|200|\$ref", "#/components/responses/pk_integer");
- } else {
- $this->openapi->set("paths|$path|$method|responses|200|\$ref", "#/components/responses/pk_string");
- }
- break;
- case 'read':
- $this->openapi->set("paths|$path|$method|responses|200|\$ref", "#/components/responses/$operation-" . urlencode($tableName));
- break;
- case 'update':
- case 'delete':
- case 'increment':
- $this->openapi->set("paths|$path|$method|responses|200|\$ref", "#/components/responses/rows_affected");
- break;
- }
- }
- }
-
- private function setComponentSchema(String $tableName) /*: void*/
- {
- $table = $this->reflection->getTable($tableName);
- $type = $table->getType($tableName);
- $pk = $table->getPk();
- $pkName = $pk ? $pk->getName() : '';
- foreach ($this->operations as $operation => $method) {
- if (!$pkName && $operation != 'list') {
- continue;
- }
- if ($type != 'table' && $operation != 'list') {
- continue;
- }
- if ($operation == 'delete') {
- continue;
- }
- if (!$this->isOperationOnTableAllowed($operation, $tableName)) {
- continue;
- }
- if ($operation == 'list') {
- $this->openapi->set("components|schemas|$operation-$tableName|type", "object");
- $this->openapi->set("components|schemas|$operation-$tableName|properties|results|type", "integer");
- $this->openapi->set("components|schemas|$operation-$tableName|properties|results|format", "int64");
- $this->openapi->set("components|schemas|$operation-$tableName|properties|records|type", "array");
- $prefix = "components|schemas|$operation-$tableName|properties|records|items";
- } else {
- $prefix = "components|schemas|$operation-$tableName";
- }
- $this->openapi->set("$prefix|type", "object");
- foreach ($table->columnNames() as $columnName) {
- if (!$this->isOperationOnColumnAllowed($operation, $tableName, $columnName)) {
- continue;
- }
- $column = $table->getColumn($columnName);
- $properties = $this->types[$column->getType()];
- foreach ($properties as $key => $value) {
- $this->openapi->set("$prefix|properties|$columnName|$key", $value);
- }
- }
- }
- }
-
- private function setComponentResponse(String $tableName) /*: void*/
- {
- $table = $this->reflection->getTable($tableName);
- $type = $table->getType($tableName);
- $pk = $table->getPk();
- $pkName = $pk ? $pk->getName() : '';
- foreach (['list', 'read'] as $operation) {
- if (!$pkName && $operation != 'list') {
- continue;
- }
- if ($type != 'table' && $operation != 'list') {
- continue;
- }
- if (!$this->isOperationOnTableAllowed($operation, $tableName)) {
- continue;
- }
- if ($operation == 'list') {
- $this->openapi->set("components|responses|$operation-$tableName|description", "list of $tableName records");
- } else {
- $this->openapi->set("components|responses|$operation-$tableName|description", "single $tableName record");
- }
- $this->openapi->set("components|responses|$operation-$tableName|content|application/json|schema|\$ref", "#/components/schemas/$operation-" . urlencode($tableName));
- }
- }
-
- private function setComponentRequestBody(String $tableName) /*: void*/
- {
- $table = $this->reflection->getTable($tableName);
- $type = $table->getType($tableName);
- $pk = $table->getPk();
- $pkName = $pk ? $pk->getName() : '';
- if ($pkName && $type == 'table') {
- foreach (['create', 'update', 'increment'] as $operation) {
- if (!$this->isOperationOnTableAllowed($operation, $tableName)) {
- continue;
- }
- $this->openapi->set("components|requestBodies|$operation-$tableName|description", "single $tableName record");
- $this->openapi->set("components|requestBodies|$operation-$tableName|content|application/json|schema|\$ref", "#/components/schemas/$operation-" . urlencode($tableName));
- }
- }
- }
-
- private function setComponentParameters() /*: void*/
- {
- $this->openapi->set("components|parameters|pk|name", "id");
- $this->openapi->set("components|parameters|pk|in", "path");
- $this->openapi->set("components|parameters|pk|schema|type", "string");
- $this->openapi->set("components|parameters|pk|description", "primary key value");
- $this->openapi->set("components|parameters|pk|required", true);
- }
-
- private function setTag(int $index, String $tableName) /*: void*/
- {
- $this->openapi->set("tags|$index|name", "$tableName");
- $this->openapi->set("tags|$index|description", "$tableName operations");
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/OpenApi/OpenApiDefinition.php
-
- class OpenApiDefinition implements \JsonSerializable
- {
- private $root;
-
- public function __construct($base)
- {
- $this->root = $base;
- }
-
- public function set(String $path, $value) /*: void*/
- {
- $parts = explode('|', trim($path, '|'));
- $current = &$this->root;
- while (count($parts) > 0) {
- $part = array_shift($parts);
- if (!isset($current[$part])) {
- $current[$part] = [];
- }
- $current = &$current[$part];
- }
- $current = $value;
- }
-
- public function jsonSerialize()
- {
- return $this->root;
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/OpenApi/OpenApiService.php
-
- class OpenApiService
- {
- private $builder;
-
- public function __construct(ReflectionService $reflection, array $base)
- {
- $this->builder = new OpenApiBuilder($reflection, $base);
- }
-
- public function get(): OpenApiDefinition
- {
- return $this->builder->build();
- }
-
- }
-
- // file: src/Tqdev/PhpCrudApi/Record/Condition/AndCondition.php
-
- class AndCondition extends Condition
- {
- private $conditions;
-
- public function __construct(Condition $condition1, Condition $condition2)
- {
- $this->conditions = [$condition1, $condition2];
- }
-
- public function _and(Condition $condition): Condition
- {
- if ($condition instanceof NoCondition) {
- return $this;
- }
- $this->conditions[] = $condition;
- return $this;
- }
-
- public function getConditions(): array
- {
- return $this->conditions;
- }
-
- public static function fromArray(array $conditions): Condition
- {
- $condition = new NoCondition();
- foreach ($conditions as $c) {
- $condition = $condition->_and($c);
- }
- return $condition;
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Record/Condition/ColumnCondition.php
-
- class ColumnCondition extends Condition
- {
- private $column;
- private $operator;
- private $value;
-
- public function __construct(ReflectedColumn $column, String $operator, String $value)
- {
- $this->column = $column;
- $this->operator = $operator;
- $this->value = $value;
- }
-
- public function getColumn(): ReflectedColumn
- {
- return $this->column;
- }
-
- public function getOperator(): String
- {
- return $this->operator;
- }
-
- public function getValue(): String
- {
- return $this->value;
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Record/Condition/Condition.php
-
- abstract class Condition
- {
- public function _and(Condition $condition): Condition
- {
- if ($condition instanceof NoCondition) {
- return $this;
- }
- return new AndCondition($this, $condition);
- }
-
- public function _or(Condition $condition): Condition
- {
- if ($condition instanceof NoCondition) {
- return $this;
- }
- return new OrCondition($this, $condition);
- }
-
- public function _not(): Condition
- {
- return new NotCondition($this);
- }
-
- public static function fromString(ReflectedTable $table, String $value): Condition
- {
- $condition = new NoCondition();
- $parts = explode(',', $value, 3);
- if (count($parts) < 2) {
- return null;
- }
- $field = $table->getColumn($parts[0]);
- $command = $parts[1];
- $negate = false;
- $spatial = false;
- if (strlen($command) > 2) {
- if (substr($command, 0, 1) == 'n') {
- $negate = true;
- $command = substr($command, 1);
- }
- if (substr($command, 0, 1) == 's') {
- $spatial = true;
- $command = substr($command, 1);
- }
- }
- if (count($parts) == 3 || (count($parts) == 2 && in_array($command, ['ic', 'is', 'iv']))) {
- if ($spatial) {
- if (in_array($command, ['co', 'cr', 'di', 'eq', 'in', 'ov', 'to', 'wi', 'ic', 'is', 'iv'])) {
- $condition = new SpatialCondition($field, $command, $parts[2]);
- }
- } else {
- if (in_array($command, ['cs', 'sw', 'ew', 'eq', 'lt', 'le', 'ge', 'gt', 'bt', 'in', 'is'])) {
- $condition = new ColumnCondition($field, $command, $parts[2]);
- }
- }
- }
- if ($negate) {
- $condition = $condition->_not();
- }
- return $condition;
- }
-
- }
-
- // file: src/Tqdev/PhpCrudApi/Record/Condition/NoCondition.php
-
- class NoCondition extends Condition
- {
- public function _and(Condition $condition): Condition
- {
- return $condition;
- }
-
- public function _or(Condition $condition): Condition
- {
- return $condition;
- }
-
- public function _not(): Condition
- {
- return $this;
- }
-
- }
-
- // file: src/Tqdev/PhpCrudApi/Record/Condition/NotCondition.php
-
- class NotCondition extends Condition
- {
- private $condition;
-
- public function __construct(Condition $condition)
- {
- $this->condition = $condition;
- }
-
- public function getCondition(): Condition
- {
- return $this->condition;
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Record/Condition/OrCondition.php
-
- class OrCondition extends Condition
- {
- private $conditions;
-
- public function __construct(Condition $condition1, Condition $condition2)
- {
- $this->conditions = [$condition1, $condition2];
- }
-
- public function _or(Condition $condition): Condition
- {
- if ($condition instanceof NoCondition) {
- return $this;
- }
- $this->conditions[] = $condition;
- return $this;
- }
-
- public function getConditions(): array
- {
- return $this->conditions;
- }
-
- public static function fromArray(array $conditions): Condition
- {
- $condition = new NoCondition();
- foreach ($conditions as $c) {
- $condition = $condition->_or($c);
- }
- return $condition;
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Record/Condition/SpatialCondition.php
-
- class SpatialCondition extends ColumnCondition
- {
- }
-
- // file: src/Tqdev/PhpCrudApi/Record/Document/ErrorDocument.php
-
- class ErrorDocument implements \JsonSerializable
- {
- public $code;
- public $message;
- public $details;
-
- public function __construct(ErrorCode $errorCode, String $argument, $details)
- {
- $this->code = $errorCode->getCode();
- $this->message = $errorCode->getMessage($argument);
- $this->details = $details;
- }
-
- public function getCode(): int
- {
- return $this->code;
- }
-
- public function getMessage(): String
- {
- return $this->message;
- }
-
- public function serialize()
- {
- return [
- 'code' => $this->code,
- 'message' => $this->message,
- 'details' => $this->details,
- ];
- }
-
- public function jsonSerialize()
- {
- return array_filter($this->serialize());
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Record/Document/ListDocument.php
-
- class ListDocument implements \JsonSerializable
- {
-
- private $records;
-
- private $results;
-
- public function __construct(array $records, int $results)
- {
- $this->records = $records;
- $this->results = $results;
- }
-
- public function getRecords(): array
- {
- return $this->records;
- }
-
- public function getResults(): int
- {
- return $this->results;
- }
-
- public function serialize()
- {
- return [
- 'records' => $this->records,
- 'results' => $this->results,
- ];
- }
-
- public function jsonSerialize()
- {
- return array_filter($this->serialize(), function ($v) {
- return $v !== 0;
- });
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Record/ColumnIncluder.php
-
- class ColumnIncluder
- {
-
- private function isMandatory(String $tableName, String $columnName, array $params): bool
- {
- return isset($params['mandatory']) && in_array($tableName . "." . $columnName, $params['mandatory']);
- }
-
- private function select(String $tableName, bool $primaryTable, array $params, String $paramName,
- array $columnNames, bool $include): array{
- if (!isset($params[$paramName])) {
- return $columnNames;
- }
- $columns = array();
- foreach (explode(',', $params[$paramName][0]) as $columnName) {
- $columns[$columnName] = true;
- }
- $result = array();
- foreach ($columnNames as $columnName) {
- $match = isset($columns['*.*']);
- if (!$match) {
- $match = isset($columns[$tableName . '.*']) || isset($columns[$tableName . '.' . $columnName]);
- }
- if ($primaryTable && !$match) {
- $match = isset($columns['*']) || isset($columns[$columnName]);
- }
- if ($match) {
- if ($include || $this->isMandatory($tableName, $columnName, $params)) {
- $result[] = $columnName;
- }
- } else {
- if (!$include || $this->isMandatory($tableName, $columnName, $params)) {
- $result[] = $columnName;
- }
- }
- }
- return $result;
- }
-
- public function getNames(ReflectedTable $table, bool $primaryTable, array $params): array
- {
- $tableName = $table->getName();
- $results = $table->columnNames();
- $results = $this->select($tableName, $primaryTable, $params, 'include', $results, true);
- $results = $this->select($tableName, $primaryTable, $params, 'exclude', $results, false);
- return $results;
- }
-
- public function getValues(ReflectedTable $table, bool $primaryTable, /* object */ $record, array $params): array
- {
- $results = array();
- $columnNames = $this->getNames($table, $primaryTable, $params);
- foreach ($columnNames as $columnName) {
- if (property_exists($record, $columnName)) {
- $results[$columnName] = $record->$columnName;
- }
- }
- return $results;
- }
-
- }
-
- // file: src/Tqdev/PhpCrudApi/Record/ErrorCode.php
-
- class ErrorCode
- {
-
- private $code;
- private $message;
- private $status;
-
- const ERROR_NOT_FOUND = 9999;
- const ROUTE_NOT_FOUND = 1000;
- const TABLE_NOT_FOUND = 1001;
- const ARGUMENT_COUNT_MISMATCH = 1002;
- const RECORD_NOT_FOUND = 1003;
- const ORIGIN_FORBIDDEN = 1004;
- const COLUMN_NOT_FOUND = 1005;
- const TABLE_ALREADY_EXISTS = 1006;
- const COLUMN_ALREADY_EXISTS = 1007;
- const HTTP_MESSAGE_NOT_READABLE = 1008;
- const DUPLICATE_KEY_EXCEPTION = 1009;
- const DATA_INTEGRITY_VIOLATION = 1010;
- const AUTHENTICATION_REQUIRED = 1011;
- const AUTHENTICATION_FAILED = 1012;
- const INPUT_VALIDATION_FAILED = 1013;
- const OPERATION_FORBIDDEN = 1014;
- const OPERATION_NOT_SUPPORTED = 1015;
- const TEMPORARY_OR_PERMANENTLY_BLOCKED = 1016;
- const BAD_OR_MISSING_XSRF_TOKEN = 1017;
- const ONLY_AJAX_REQUESTS_ALLOWED = 1018;
- const FILE_UPLOAD_FAILED = 1019;
-
- private $values = [
- 9999 => ["%s", Response::INTERNAL_SERVER_ERROR],
- 1000 => ["Route '%s' not found", Response::NOT_FOUND],
- 1001 => ["Table '%s' not found", Response::NOT_FOUND],
- 1002 => ["Argument count mismatch in '%s'", Response::UNPROCESSABLE_ENTITY],
- 1003 => ["Record '%s' not found", Response::NOT_FOUND],
- 1004 => ["Origin '%s' is forbidden", Response::FORBIDDEN],
- 1005 => ["Column '%s' not found", Response::NOT_FOUND],
- 1006 => ["Table '%s' already exists", Response::CONFLICT],
- 1007 => ["Column '%s' already exists", Response::CONFLICT],
- 1008 => ["Cannot read HTTP message", Response::UNPROCESSABLE_ENTITY],
- 1009 => ["Duplicate key exception", Response::CONFLICT],
- 1010 => ["Data integrity violation", Response::CONFLICT],
- 1011 => ["Authentication required", Response::UNAUTHORIZED],
- 1012 => ["Authentication failed for '%s'", Response::FORBIDDEN],
- 1013 => ["Input validation failed for '%s'", Response::UNPROCESSABLE_ENTITY],
- 1014 => ["Operation forbidden", Response::FORBIDDEN],
- 1015 => ["Operation '%s' not supported", Response::METHOD_NOT_ALLOWED],
- 1016 => ["Temporary or permanently blocked", Response::FORBIDDEN],
- 1017 => ["Bad or missing XSRF token", Response::FORBIDDEN],
- 1018 => ["Only AJAX requests allowed for '%s'", Response::FORBIDDEN],
- 1019 => ["File upload failed for '%s'", Response::UNPROCESSABLE_ENTITY],
- ];
-
- public function __construct(int $code)
- {
- if (!isset($this->values[$code])) {
- $code = 9999;
- }
- $this->code = $code;
- $this->message = $this->values[$code][0];
- $this->status = $this->values[$code][1];
- }
-
- public function getCode(): int
- {
- return $this->code;
- }
-
- public function getMessage(String $argument): String
- {
- return sprintf($this->message, $argument);
- }
-
- public function getStatus(): int
- {
- return $this->status;
- }
-
- }
-
- // file: src/Tqdev/PhpCrudApi/Record/FilterInfo.php
-
- class FilterInfo
- {
-
- private function addConditionFromFilterPath(PathTree $conditions, array $path, ReflectedTable $table, array $params)
- {
- $key = 'filter' . implode('', $path);
- if (isset($params[$key])) {
- foreach ($params[$key] as $filter) {
- $condition = Condition::fromString($table, $filter);
- if ($condition != null) {
- $conditions->put($path, $condition);
- }
- }
- }
- }
-
- private function getConditionsAsPathTree(ReflectedTable $table, array $params): PathTree
- {
- $conditions = new PathTree();
- $this->addConditionFromFilterPath($conditions, [], $table, $params);
- for ($n = ord('0'); $n <= ord('9'); $n++) {
- $this->addConditionFromFilterPath($conditions, [chr($n)], $table, $params);
- for ($l = ord('a'); $l <= ord('f'); $l++) {
- $this->addConditionFromFilterPath($conditions, [chr($n), chr($l)], $table, $params);
- }
- }
- return $conditions;
- }
-
- private function combinePathTreeOfConditions(PathTree $tree): Condition
- {
- $andConditions = $tree->getValues();
- $and = AndCondition::fromArray($andConditions);
- $orConditions = [];
- foreach ($tree->getKeys() as $p) {
- $orConditions[] = $this->combinePathTreeOfConditions($tree->get($p));
- }
- $or = OrCondition::fromArray($orConditions);
- return $and->_and($or);
- }
-
- public function getCombinedConditions(ReflectedTable $table, array $params): Condition
- {
- return $this->combinePathTreeOfConditions($this->getConditionsAsPathTree($table, $params));
- }
-
- }
-
- // file: src/Tqdev/PhpCrudApi/Record/HabtmValues.php
-
- class HabtmValues
- {
- public $pkValues;
- public $fkValues;
-
- public function __construct(array $pkValues, array $fkValues)
- {
- $this->pkValues = $pkValues;
- $this->fkValues = $fkValues;
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Record/OrderingInfo.php
-
- class OrderingInfo
- {
-
- public function getColumnOrdering(ReflectedTable $table, array $params): array
- {
- $fields = array();
- if (isset($params['order'])) {
- foreach ($params['order'] as $order) {
- $parts = explode(',', $order, 3);
- $columnName = $parts[0];
- if (!$table->hasColumn($columnName)) {
- continue;
- }
- $ascending = 'ASC';
- if (count($parts) > 1) {
- if (substr(strtoupper($parts[1]), 0, 4) == "DESC") {
- $ascending = 'DESC';
- }
- }
- $fields[] = [$columnName, $ascending];
- }
- }
- if (count($fields) == 0) {
- $pk = $table->getPk();
- if ($pk) {
- $fields[] = [$pk->getName(), 'ASC'];
- } else {
- foreach ($table->columnNames() as $columnName) {
- $fields[] = [$columnName, 'ASC'];
- }
-
- }
- }
- return $fields;
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Record/PaginationInfo.php
-
- class PaginationInfo
- {
-
- public $DEFAULT_PAGE_SIZE = 20;
-
- public function hasPage(array $params): bool
- {
- return isset($params['page']);
- }
-
- public function getPageOffset(array $params): int
- {
- $offset = 0;
- $pageSize = $this->getPageSize($params);
- if (isset($params['page'])) {
- foreach ($params['page'] as $page) {
- $parts = explode(',', $page, 2);
- $page = intval($parts[0]) - 1;
- $offset = $page * $pageSize;
- }
- }
- return $offset;
- }
-
- public function getPageSize(array $params): int
- {
- $pageSize = $this->DEFAULT_PAGE_SIZE;
- if (isset($params['page'])) {
- foreach ($params['page'] as $page) {
- $parts = explode(',', $page, 2);
- if (count($parts) > 1) {
- $pageSize = intval($parts[1]);
- }
- }
- }
- return $pageSize;
- }
-
- public function getResultSize(array $params): int
- {
- $numberOfRows = -1;
- if (isset($params['size'])) {
- foreach ($params['size'] as $size) {
- $numberOfRows = intval($size);
- }
- }
- return $numberOfRows;
- }
-
- }
-
- // file: src/Tqdev/PhpCrudApi/Record/PathTree.php
-
- class PathTree implements \JsonSerializable
- {
- const WILDCARD = '*';
-
- private $tree;
-
- public function __construct( /* object */&$tree = null)
- {
- if (!$tree) {
- $tree = $this->newTree();
- }
- $this->tree = &$tree;
- }
-
- public function newTree()
- {
- return (object) ['values' => [], 'branches' => (object) []];
- }
-
- public function getKeys(): array
- {
- $branches = (array) $this->tree->branches;
- return array_keys($branches);
- }
-
- public function getValues(): array
- {
- return $this->tree->values;
- }
-
- public function get(String $key): PathTree
- {
- if (!isset($this->tree->branches->$key)) {
- return null;
- }
- return new PathTree($this->tree->branches->$key);
- }
-
- public function put(array $path, $value)
- {
- $tree = &$this->tree;
- foreach ($path as $key) {
- if (!isset($tree->branches->$key)) {
- $tree->branches->$key = $this->newTree();
- }
- $tree = &$tree->branches->$key;
- }
- $tree->values[] = $value;
- }
-
- public function match(array $path): array
- {
- $star = self::WILDCARD;
- $tree = &$this->tree;
- foreach ($path as $key) {
- if (isset($tree->branches->$key)) {
- $tree = &$tree->branches->$key;
- } else if (isset($tree->branches->$star)) {
- $tree = &$tree->branches->$star;
- } else {
- return [];
- }
- }
- return $tree->values;
- }
-
- public static function fromJson( /* object */$tree): PathTree
- {
- return new PathTree($tree);
- }
-
- public function jsonSerialize()
- {
- return $this->tree;
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Record/RecordService.php
-
- class RecordService
- {
- private $db;
- private $reflection;
- private $columns;
- private $joiner;
- private $filters;
- private $ordering;
- private $pagination;
-
- public function __construct(GenericDB $db, ReflectionService $reflection)
- {
- $this->db = $db;
- $this->reflection = $reflection;
- $this->columns = new ColumnIncluder();
- $this->joiner = new RelationJoiner($reflection, $this->columns);
- $this->filters = new FilterInfo();
- $this->ordering = new OrderingInfo();
- $this->pagination = new PaginationInfo();
- }
-
- private function sanitizeRecord(String $tableName, /* object */ $record, String $id)
- {
- $keyset = array_keys((array) $record);
- foreach ($keyset as $key) {
- if (!$this->reflection->getTable($tableName)->hasColumn($key)) {
- unset($record->$key);
- }
- }
- if ($id != '') {
- $pk = $this->reflection->getTable($tableName)->getPk();
- foreach ($this->reflection->getTable($tableName)->columnNames() as $key) {
- $field = $this->reflection->getTable($tableName)->getColumn($key);
- if ($field->getName() == $pk->getName()) {
- unset($record->$key);
- }
- }
- }
- }
-
- public function hasTable(String $table): bool
- {
- return $this->reflection->hasTable($table);
- }
-
- public function getType(String $table): String
- {
- return $this->reflection->getType($table);
- }
-
- public function create(String $tableName, /* object */ $record, array $params)
- {
- $this->sanitizeRecord($tableName, $record, '');
- $table = $this->reflection->getTable($tableName);
- $columnValues = $this->columns->getValues($table, true, $record, $params);
- return $this->db->createSingle($table, $columnValues);
- }
-
- public function read(String $tableName, String $id, array $params) /*: ?object*/
- {
- $table = $this->reflection->getTable($tableName);
- $this->joiner->addMandatoryColumns($table, $params);
- $columnNames = $this->columns->getNames($table, true, $params);
- $record = $this->db->selectSingle($table, $columnNames, $id);
- if ($record == null) {
- return null;
- }
- $records = array($record);
- $this->joiner->addJoins($table, $records, $params, $this->db);
- return $records[0];
- }
-
- public function update(String $tableName, String $id, /* object */ $record, array $params)
- {
- $this->sanitizeRecord($tableName, $record, $id);
- $table = $this->reflection->getTable($tableName);
- $columnValues = $this->columns->getValues($table, true, $record, $params);
- return $this->db->updateSingle($table, $columnValues, $id);
- }
-
- public function delete(String $tableName, String $id, array $params)
- {
- $table = $this->reflection->getTable($tableName);
- return $this->db->deleteSingle($table, $id);
- }
-
- public function increment(String $tableName, String $id, /* object */ $record, array $params)
- {
- $this->sanitizeRecord($tableName, $record, $id);
- $table = $this->reflection->getTable($tableName);
- $columnValues = $this->columns->getValues($table, true, $record, $params);
- return $this->db->incrementSingle($table, $columnValues, $id);
- }
-
- public function _list(String $tableName, array $params): ListDocument
- {
- $table = $this->reflection->getTable($tableName);
- $this->joiner->addMandatoryColumns($table, $params);
- $columnNames = $this->columns->getNames($table, true, $params);
- $condition = $this->filters->getCombinedConditions($table, $params);
- $columnOrdering = $this->ordering->getColumnOrdering($table, $params);
- if (!$this->pagination->hasPage($params)) {
- $offset = 0;
- $limit = $this->pagination->getResultSize($params);
- $count = 0;
- } else {
- $offset = $this->pagination->getPageOffset($params);
- $limit = $this->pagination->getPageSize($params);
- $count = $this->db->selectCount($table, $condition);
- }
- $records = $this->db->selectAll($table, $columnNames, $condition, $columnOrdering, $offset, $limit);
- $this->joiner->addJoins($table, $records, $params, $this->db);
- return new ListDocument($records, $count);
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Record/RelationJoiner.php
-
- class RelationJoiner
- {
-
- private $reflection;
- private $columns;
-
- public function __construct(ReflectionService $reflection, ColumnIncluder $columns)
- {
- $this->reflection = $reflection;
- $this->columns = $columns;
- }
-
- public function addMandatoryColumns(ReflectedTable $table, array &$params) /*: void*/
- {
- if (!isset($params['join']) || !isset($params['include'])) {
- return;
- }
- $params['mandatory'] = array();
- foreach ($params['join'] as $tableNames) {
- $t1 = $table;
- foreach (explode(',', $tableNames) as $tableName) {
- if (!$this->reflection->hasTable($tableName)) {
- continue;
- }
- $t2 = $this->reflection->getTable($tableName);
- $fks1 = $t1->getFksTo($t2->getName());
- $t3 = $this->hasAndBelongsToMany($t1, $t2);
- if ($t3 != null || count($fks1) > 0) {
- $params['mandatory'][] = $t2->getName() . '.' . $t2->getPk()->getName();
- }
- foreach ($fks1 as $fk) {
- $params['mandatory'][] = $t1->getName() . '.' . $fk->getName();
- }
- $fks2 = $t2->getFksTo($t1->getName());
- if ($t3 != null || count($fks2) > 0) {
- $params['mandatory'][] = $t1->getName() . '.' . $t1->getPk()->getName();
- }
- foreach ($fks2 as $fk) {
- $params['mandatory'][] = $t2->getName() . '.' . $fk->getName();
- }
- $t1 = $t2;
- }
- }
- }
-
- private function getJoinsAsPathTree(array $params): PathTree
- {
- $joins = new PathTree();
- if (isset($params['join'])) {
- foreach ($params['join'] as $tableNames) {
- $path = array();
- foreach (explode(',', $tableNames) as $tableName) {
- $t = $this->reflection->getTable($tableName);
- if ($t != null) {
- $path[] = $t->getName();
- }
- }
- $joins->put($path, true);
- }
- }
- return $joins;
- }
-
- public function addJoins(ReflectedTable $table, array &$records, array $params, GenericDB $db) /*: void*/
- {
- $joins = $this->getJoinsAsPathTree($params);
- $this->addJoinsForTables($table, $joins, $records, $params, $db);
- }
-
- private function hasAndBelongsToMany(ReflectedTable $t1, ReflectedTable $t2) /*: ?ReflectedTable*/
- {
- foreach ($this->reflection->getTableNames() as $tableName) {
- $t3 = $this->reflection->getTable($tableName);
- if (count($t3->getFksTo($t1->getName())) > 0 && count($t3->getFksTo($t2->getName())) > 0) {
- return $t3;
- }
- }
- return null;
- }
-
- private function addJoinsForTables(ReflectedTable $t1, PathTree $joins, array &$records, array $params, GenericDB $db)
- {
-
- foreach ($joins->getKeys() as $t2Name) {
-
- $t2 = $this->reflection->getTable($t2Name);
-
- $belongsTo = count($t1->getFksTo($t2->getName())) > 0;
- $hasMany = count($t2->getFksTo($t1->getName())) > 0;
- $t3 = $this->hasAndBelongsToMany($t1, $t2);
- $hasAndBelongsToMany = ($t3 != null);
-
- $newRecords = array();
- $fkValues = null;
- $pkValues = null;
- $habtmValues = null;
-
- if ($belongsTo) {
- $fkValues = $this->getFkEmptyValues($t1, $t2, $records);
- $this->addFkRecords($t2, $fkValues, $params, $db, $newRecords);
- }
- if ($hasMany) {
- $pkValues = $this->getPkEmptyValues($t1, $records);
- $this->addPkRecords($t1, $t2, $pkValues, $params, $db, $newRecords);
- }
- if ($hasAndBelongsToMany) {
- $habtmValues = $this->getHabtmEmptyValues($t1, $t2, $t3, $db, $records);
- $this->addFkRecords($t2, $habtmValues->fkValues, $params, $db, $newRecords);
- }
-
- $this->addJoinsForTables($t2, $joins->get($t2Name), $newRecords, $params, $db);
-
- if ($fkValues != null) {
- $this->fillFkValues($t2, $newRecords, $fkValues);
- $this->setFkValues($t1, $t2, $records, $fkValues);
- }
- if ($pkValues != null) {
- $this->fillPkValues($t1, $t2, $newRecords, $pkValues);
- $this->setPkValues($t1, $t2, $records, $pkValues);
- }
- if ($habtmValues != null) {
- $this->fillFkValues($t2, $newRecords, $habtmValues->fkValues);
- $this->setHabtmValues($t1, $t3, $records, $habtmValues);
- }
- }
- }
-
- private function getFkEmptyValues(ReflectedTable $t1, ReflectedTable $t2, array $records): array
- {
- $fkValues = array();
- $fks = $t1->getFksTo($t2->getName());
- foreach ($fks as $fk) {
- $fkName = $fk->getName();
- foreach ($records as $record) {
- if (isset($record[$fkName])) {
- $fkValue = $record[$fkName];
- $fkValues[$fkValue] = null;
- }
- }
- }
- return $fkValues;
- }
-
- private function addFkRecords(ReflectedTable $t2, array $fkValues, array $params, GenericDB $db, array &$records) /*: void*/
- {
- $columnNames = $this->columns->getNames($t2, false, $params);
- $fkIds = array_keys($fkValues);
-
- foreach ($db->selectMultiple($t2, $columnNames, $fkIds) as $record) {
- $records[] = $record;
- }
- }
-
- private function fillFkValues(ReflectedTable $t2, array $fkRecords, array &$fkValues) /*: void*/
- {
- $pkName = $t2->getPk()->getName();
- foreach ($fkRecords as $fkRecord) {
- $pkValue = $fkRecord[$pkName];
- $fkValues[$pkValue] = $fkRecord;
- }
- }
-
- private function setFkValues(ReflectedTable $t1, ReflectedTable $t2, array &$records, array $fkValues) /*: void*/
- {
- $fks = $t1->getFksTo($t2->getName());
- foreach ($fks as $fk) {
- $fkName = $fk->getName();
- foreach ($records as $i => $record) {
- if (isset($record[$fkName])) {
- $key = $record[$fkName];
- $records[$i][$fkName] = $fkValues[$key];
- }
- }
- }
- }
-
- private function getPkEmptyValues(ReflectedTable $t1, array $records): array
- {
- $pkValues = array();
- $pkName = $t1->getPk()->getName();
- foreach ($records as $record) {
- $key = $record[$pkName];
- $pkValues[$key] = array();
- }
- return $pkValues;
- }
-
- private function addPkRecords(ReflectedTable $t1, ReflectedTable $t2, array $pkValues, array $params, GenericDB $db, array &$records) /*: void*/
- {
- $fks = $t2->getFksTo($t1->getName());
- $columnNames = $this->columns->getNames($t2, false, $params);
- $pkValueKeys = implode(',', array_keys($pkValues));
- $conditions = array();
- foreach ($fks as $fk) {
- $conditions[] = new ColumnCondition($fk, 'in', $pkValueKeys);
- }
- $condition = OrCondition::fromArray($conditions);
- foreach ($db->selectAllUnordered($t2, $columnNames, $condition) as $record) {
- $records[] = $record;
- }
- }
-
- private function fillPkValues(ReflectedTable $t1, ReflectedTable $t2, array $pkRecords, array &$pkValues) /*: void*/
- {
- $fks = $t2->getFksTo($t1->getName());
- foreach ($fks as $fk) {
- $fkName = $fk->getName();
- foreach ($pkRecords as $pkRecord) {
- $key = $pkRecord[$fkName];
- if (isset($pkValues[$key])) {
- $pkValues[$key][] = $pkRecord;
- }
- }
- }
- }
-
- private function setPkValues(ReflectedTable $t1, ReflectedTable $t2, array &$records, array $pkValues) /*: void*/
- {
- $pkName = $t1->getPk()->getName();
- $t2Name = $t2->getName();
-
- foreach ($records as $i => $record) {
- $key = $record[$pkName];
- $records[$i][$t2Name] = $pkValues[$key];
- }
- }
-
- private function getHabtmEmptyValues(ReflectedTable $t1, ReflectedTable $t2, ReflectedTable $t3, GenericDB $db, array $records): HabtmValues
- {
- $pkValues = $this->getPkEmptyValues($t1, $records);
- $fkValues = array();
-
- $fk1 = $t3->getFksTo($t1->getName())[0];
- $fk2 = $t3->getFksTo($t2->getName())[0];
-
- $fk1Name = $fk1->getName();
- $fk2Name = $fk2->getName();
-
- $columnNames = array($fk1Name, $fk2Name);
-
- $pkIds = implode(',', array_keys($pkValues));
- $condition = new ColumnCondition($t3->getColumn($fk1Name), 'in', $pkIds);
-
- $records = $db->selectAllUnordered($t3, $columnNames, $condition);
- foreach ($records as $record) {
- $val1 = $record[$fk1Name];
- $val2 = $record[$fk2Name];
- $pkValues[$val1][] = $val2;
- $fkValues[$val2] = null;
- }
-
- return new HabtmValues($pkValues, $fkValues);
- }
-
- private function setHabtmValues(ReflectedTable $t1, ReflectedTable $t3, array &$records, HabtmValues $habtmValues) /*: void*/
- {
- $pkName = $t1->getPk()->getName();
- $t3Name = $t3->getName();
- foreach ($records as $i => $record) {
- $key = $record[$pkName];
- $val = array();
- $fks = $habtmValues->pkValues[$key];
- foreach ($fks as $fk) {
- $val[] = $habtmValues->fkValues[$fk];
- }
- $records[$i][$t3Name] = $val;
- }
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Record/RequestUtils.php
-
- class RequestUtils
- {
- private $reflection;
-
- public function __construct(ReflectionService $reflection)
- {
- $this->reflection = $reflection;
- }
-
- public function getOperation(Request $request): String
- {
- $method = $request->getMethod();
- $path = $request->getPathSegment(1);
- $hasPk = $request->getPathSegment(3) != '';
- switch ($path) {
- case 'openapi':
- return 'document';
- case 'columns':
- return $method == 'get' ? 'reflect' : 'remodel';
- case 'records':
- switch ($method) {
- case 'POST':
- return 'create';
- case 'GET':
- return $hasPk ? 'read' : 'list';
- case 'PUT':
- return 'update';
- case 'DELETE':
- return 'delete';
- case 'PATCH':
- return 'increment';
- }
- }
- return 'unknown';
- }
-
- private function getJoinTables(String $tableName, array $parameters): array
- {
- $uniqueTableNames = array();
- $uniqueTableNames[$tableName] = true;
- if (isset($parameters['join'])) {
- foreach ($parameters['join'] as $parameter) {
- $tableNames = explode(',', trim($parameter));
- foreach ($tableNames as $tableName) {
- $uniqueTableNames[$tableName] = true;
- }
- }
- }
- return array_keys($uniqueTableNames);
- }
-
- public function getTableNames(Request $request): array
- {
- $path = $request->getPathSegment(1);
- $tableName = $request->getPathSegment(2);
- $allTableNames = $this->reflection->getTableNames();
- switch ($path) {
- case 'openapi':
- return $allTableNames;
- case 'columns':
- return $tableName ? [$tableName] : $allTableNames;
- case 'records':
- return $this->getJoinTables($tableName, $request->getParams());
- }
- return $allTableNames;
- }
-
- }
-
- // file: src/Tqdev/PhpCrudApi/Api.php
-
- class Api
- {
- private $router;
- private $responder;
- private $debug;
-
- public function __construct(Config $config)
- {
- $db = new GenericDB(
- $config->getDriver(),
- $config->getAddress(),
- $config->getPort(),
- $config->getDatabase(),
- $config->getUsername(),
- $config->getPassword()
- );
- $cache = CacheFactory::create($config);
- $reflection = new ReflectionService($db, $cache, $config->getCacheTime());
- $responder = new Responder();
- $router = new SimpleRouter($responder, $cache, $config->getCacheTime());
- foreach ($config->getMiddlewares() as $middleware => $properties) {
- switch ($middleware) {
- case 'cors':
- new CorsMiddleware($router, $responder, $properties);
- break;
- case 'firewall':
- new FirewallMiddleware($router, $responder, $properties);
- break;
- case 'basicAuth':
- new BasicAuthMiddleware($router, $responder, $properties);
- break;
- case 'jwtAuth':
- new JwtAuthMiddleware($router, $responder, $properties);
- break;
- case 'fileUpload':
- new FileUploadMiddleware($router, $responder, $properties);
- break;
- case 'validation':
- new ValidationMiddleware($router, $responder, $properties, $reflection);
- break;
- case 'sanitation':
- new SanitationMiddleware($router, $responder, $properties, $reflection);
- break;
- case 'multiTenancy':
- new MultiTenancyMiddleware($router, $responder, $properties, $reflection);
- break;
- case 'authorization':
- new AuthorizationMiddleware($router, $responder, $properties, $reflection);
- break;
- case 'xsrf':
- new XsrfMiddleware($router, $responder, $properties);
- break;
- case 'customization':
- new CustomizationMiddleware($router, $responder, $properties, $reflection);
- break;
- }
- }
- foreach ($config->getControllers() as $controller) {
- switch ($controller) {
- case 'records':
- $records = new RecordService($db, $reflection);
- new RecordController($router, $responder, $records);
- break;
- case 'columns':
- $definition = new DefinitionService($db, $reflection);
- new ColumnController($router, $responder, $reflection, $definition);
- break;
- case 'cache':
- new CacheController($router, $responder, $cache);
- break;
- case 'openapi':
- $openApi = new OpenApiService($reflection, $config->getOpenApiBase());
- new OpenApiController($router, $responder, $openApi);
- break;
- }
- }
- $this->router = $router;
- $this->responder = $responder;
- $this->debug = $config->getDebug();
- }
-
- public function handle(Request $request): Response
- {
- $response = null;
- try {
- $response = $this->router->route($request);
- } catch (\Throwable $e) {
- if ($e instanceof \PDOException) {
- if (strpos(strtolower($e->getMessage()), 'duplicate') !== false) {
- return $this->responder->error(ErrorCode::DUPLICATE_KEY_EXCEPTION, '');
- }
- if (strpos(strtolower($e->getMessage()), 'default value') !== false) {
- return $this->responder->error(ErrorCode::DATA_INTEGRITY_VIOLATION, '');
- }
- if (strpos(strtolower($e->getMessage()), 'allow nulls') !== false) {
- return $this->responder->error(ErrorCode::DATA_INTEGRITY_VIOLATION, '');
- }
- if (strpos(strtolower($e->getMessage()), 'constraint') !== false) {
- return $this->responder->error(ErrorCode::DATA_INTEGRITY_VIOLATION, '');
- }
- }
- $response = $this->responder->error(ErrorCode::ERROR_NOT_FOUND, $e->getMessage());
- if ($this->debug) {
- $response->addHeader('X-Debug-Info', 'Exception in ' . $e->getFile() . ' on line ' . $e->getLine());
- }
- }
- return $response;
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Config.php
-
- class Config
- {
- private $values = [
- 'driver' => null,
- 'address' => 'localhost',
- 'port' => null,
- 'username' => null,
- 'password' => null,
- 'database' => null,
- 'middlewares' => 'cors',
- 'controllers' => 'records,openapi',
- 'cacheType' => 'TempFile',
- 'cachePath' => '',
- 'cacheTime' => 10,
- 'debug' => false,
- 'openApiBase' => '{"info":{"title":"PHP-CRUD-API","version":"1.0.0"}}',
- ];
-
- private function getDefaultDriver(array $values): String
- {
- if (isset($values['driver'])) {
- return $values['driver'];
- }
- return 'mysql';
- }
-
- private function getDefaultPort(String $driver): int
- {
- switch ($driver) {
- case 'mysql':return 3306;
- case 'pgsql':return 5432;
- case 'sqlsrv':return 1433;
- }
- }
-
- private function getDefaultAddress(String $driver): String
- {
- switch ($driver) {
- case 'mysql':return 'localhost';
- case 'pgsql':return 'localhost';
- case 'sqlsrv':return 'localhost';
- }
- }
-
- private function getDriverDefaults(String $driver): array
- {
- return [
- 'driver' => $driver,
- 'address' => $this->getDefaultAddress($driver),
- 'port' => $this->getDefaultPort($driver),
- ];
- }
-
- public function __construct(array $values)
- {
- $driver = $this->getDefaultDriver($values);
- $defaults = $this->getDriverDefaults($driver);
- $newValues = array_merge($this->values, $defaults, $values);
- $newValues = $this->parseMiddlewares($newValues);
- $diff = array_diff_key($newValues, $this->values);
- if (!empty($diff)) {
- $key = array_keys($diff)[0];
- throw new \Exception("Config has invalid value '$key'");
- }
- $this->values = $newValues;
- }
-
- private function parseMiddlewares(array $values): array
- {
- $newValues = array();
- $properties = array();
- $middlewares = array_map('trim', explode(',', $values['middlewares']));
- foreach ($middlewares as $middleware) {
- $properties[$middleware] = [];
- }
- foreach ($values as $key => $value) {
- if (strpos($key, '.') === false) {
- $newValues[$key] = $value;
- } else {
- list($middleware, $key2) = explode('.', $key, 2);
- if (isset($properties[$middleware])) {
- $properties[$middleware][$key2] = $value;
- } else {
- throw new \Exception("Config has invalid value '$key'");
- }
- }
- }
- $newValues['middlewares'] = array_reverse($properties, true);
- return $newValues;
- }
-
- public function getDriver(): String
- {
- return $this->values['driver'];
- }
-
- public function getAddress(): String
- {
- return $this->values['address'];
- }
-
- public function getPort(): int
- {
- return $this->values['port'];
- }
-
- public function getUsername(): String
- {
- return $this->values['username'];
- }
-
- public function getPassword(): String
- {
- return $this->values['password'];
- }
-
- public function getDatabase(): String
- {
- return $this->values['database'];
- }
-
- public function getMiddlewares(): array
- {
- return $this->values['middlewares'];
- }
-
- public function getControllers(): array
- {
- return array_map('trim', explode(',', $this->values['controllers']));
- }
-
- public function getCacheType(): String
- {
- return $this->values['cacheType'];
- }
-
- public function getCachePath(): String
- {
- return $this->values['cachePath'];
- }
-
- public function getCacheTime(): int
- {
- return $this->values['cacheTime'];
- }
-
- public function getDebug(): String
- {
- return $this->values['debug'];
- }
-
- public function getOpenApiBase(): array
- {
- return json_decode($this->values['openApiBase'], true);
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Request.php
-
- class Request
- {
- private $method;
- private $path;
- private $pathSegments;
- private $params;
- private $body;
- private $headers;
- private $highPerformance;
-
- public function __construct(String $method = null, String $path = null, String $query = null, array $headers = null, String $body = null, bool $highPerformance = true)
- {
- $this->parseMethod($method);
- $this->parsePath($path);
- $this->parseParams($query);
- $this->parseHeaders($headers);
- $this->parseBody($body);
- $this->highPerformance = $highPerformance;
- }
-
- private function parseMethod(String $method = null)
- {
- if (!$method) {
- if (isset($_SERVER['REQUEST_METHOD'])) {
- $method = $_SERVER['REQUEST_METHOD'];
- } else {
- $method = 'GET';
- }
- }
- $this->method = $method;
- }
-
- private function parsePath(String $path = null)
- {
- if (!$path) {
- if (isset($_SERVER['PATH_INFO'])) {
- $path = $_SERVER['PATH_INFO'];
- } else {
- $path = '/';
- }
- }
- $this->path = $path;
- $this->pathSegments = explode('/', $path);
- }
-
- private function parseParams(String $query = null)
- {
- if (!$query) {
- if (isset($_SERVER['QUERY_STRING'])) {
- $query = $_SERVER['QUERY_STRING'];
- } else {
- $query = '';
- }
- }
- $query = str_replace('][]=', ']=', str_replace('=', '[]=', $query));
- parse_str($query, $this->params);
- }
-
- private function parseHeaders(array $headers = null)
- {
- if (!$headers) {
- $headers = array();
- if (!$this->highPerformance) {
- foreach ($_SERVER as $name => $value) {
- if (substr($name, 0, 5) == 'HTTP_') {
- $key = str_replace(' ', '-', ucwords(strtolower(str_replace('_', ' ', substr($name, 5)))));
- $headers[$key] = $value;
- }
- }
- }
- }
- $this->headers = $headers;
- }
-
- private function decodeBody(String $body) /*: ?object*/
- {
- $first = substr($body, 0, 1);
- if ($first == '[' || $first == '{') {
- $object = json_decode($body);
- $causeCode = json_last_error();
- if ($causeCode !== JSON_ERROR_NONE) {
- $object = null;
- }
- } else {
- parse_str($body, $input);
- foreach ($input as $key => $value) {
- if (substr($key, -9) == '__is_null') {
- $input[substr($key, 0, -9)] = null;
- unset($input[$key]);
- }
- }
- $object = (object) $input;
- }
- return $object;
- }
-
- private function parseBody(String $body = null) /*: void*/
- {
- if ($body) {
- $object = $this->decodeBody($body);
- } else {
- if (!empty($_FILES)) {
- $object = (object) $_POST;
- } else {
- $input = file_get_contents('php://input');
- $object = $this->decodeBody($input);
- }
- }
- $this->body = $object;
- }
-
- public function getMethod(): String
- {
- return $this->method;
- }
-
- public function getPath(): String
- {
- return $this->path;
- }
-
- public function getPathSegment(int $part): String
- {
- if ($part < 0 || $part >= count($this->pathSegments)) {
- return '';
- }
- return $this->pathSegments[$part];
- }
-
- public function getParams(): array
- {
- return $this->params;
- }
-
- public function getBody() /*: ?array*/
- {
- return $this->body;
- }
-
- public function setBody($body) /*: void*/
- {
- $this->body = $body;
- }
-
- public function addHeader(String $key, String $value)
- {
- $this->headers[$key] = $value;
- }
-
- public function getHeader(String $key): String
- {
- if (isset($this->headers[$key])) {
- return $this->headers[$key];
- }
- if ($this->highPerformance) {
- $serverKey = 'HTTP_' . strtoupper(str_replace('-', '_', $key));
- if (isset($_SERVER[$serverKey])) {
- return $_SERVER[$serverKey];
- }
- }
- return '';
- }
-
- public function getHeaders(): array
- {
- return $this->headers;
- }
-
- public static function fromString(String $request): Request
- {
- $parts = explode("\n\n", trim($request), 2);
- $head = $parts[0];
- $body = isset($parts[1]) ? $parts[1] : null;
- $lines = explode("\n", $head);
- $line = explode(' ', trim(array_shift($lines)), 2);
- $method = $line[0];
- $url = isset($line[1]) ? $line[1] : '';
- $path = parse_url($url, PHP_URL_PATH);
- $query = parse_url($url, PHP_URL_QUERY);
- $headers = array();
- foreach ($lines as $line) {
- list($key, $value) = explode(':', $line, 2);
- $headers[$key] = trim($value);
- }
- return new Request($method, $path, $query, $headers, $body);
- }
-
- public function getUploadedFiles(): array
- {
- return $_FILES;
- }
- }
-
- // file: src/Tqdev/PhpCrudApi/Response.php
-
- class Response
- {
- const OK = 200;
- const UNAUTHORIZED = 401;
- const FORBIDDEN = 403;
- const NOT_FOUND = 404;
- const METHOD_NOT_ALLOWED = 405;
- const CONFLICT = 409;
- const UNPROCESSABLE_ENTITY = 422;
- const INTERNAL_SERVER_ERROR = 500;
- private $status;
- private $headers;
- private $body;
-
- public function __construct(int $status, $body)
- {
- $this->status = $status;
- $this->headers = array();
- $this->parseBody($body);
- }
-
- private function parseBody($body)
- {
- if ($body === '') {
- $this->body = '';
- } else {
- $data = json_encode($body, JSON_UNESCAPED_UNICODE);
- $this->addHeader('Content-Type', 'application/json');
- $this->addHeader('Content-Length', strlen($data));
- $this->body = $data;
- }
- }
-
- public function getStatus(): int
- {
- return $this->status;
- }
-
- public function getBody(): String
- {
- return $this->body;
- }
-
- public function addHeader(String $key, String $value)
- {
- $this->headers[$key] = $value;
- }
-
- public function getHeader(String $key): String
- {
- if (isset($this->headers[$key])) {
- return $this->headers[$key];
- }
- return null;
- }
-
- public function getHeaders(): array
- {
- return $this->headers;
- }
-
- public function output()
- {
- http_response_code($this->getStatus());
- foreach ($this->headers as $key => $value) {
- header("$key: $value");
- }
- echo $this->getBody();
- }
-
- public function __toString(): String
- {
- $str = "$this->status\n";
- foreach ($this->headers as $key => $value) {
- $str .= "$key: $value\n";
- }
- if ($this->body !== '') {
- $str .= "\n";
- $str .= "$this->body\n";
- }
- return $str;
- }
- }
-
- // file: src/index.php
-
- $config = new Config([
- 'username' => 'php-crud-api',
- 'password' => 'php-crud-api',
- 'database' => 'php-crud-api',
- ]);
- $request = new Request();
- $api = new Api($config);
- $response = $api->handle($request);
- $response->output();
|