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

api.include.php 425KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387
  1. <?php
  2. /**
  3. * PHP-CRUD-API v2 License: MIT
  4. * Maurits van der Schee: maurits@vdschee.nl
  5. * https://github.com/mevdschee/php-crud-api
  6. *
  7. * Dependencies:
  8. * - vendor/psr/*: PHP-FIG
  9. * https://github.com/php-fig
  10. * - vendor/nyholm/*: Tobias Nyholm
  11. * https://github.com/Nyholm
  12. **/
  13. // file: vendor/psr/http-factory/src/RequestFactoryInterface.php
  14. namespace Psr\Http\Message {
  15. interface RequestFactoryInterface
  16. {
  17. /**
  18. * Create a new request.
  19. *
  20. * @param string $method The HTTP method associated with the request.
  21. * @param UriInterface|string $uri The URI associated with the request. If
  22. * the value is a string, the factory MUST create a UriInterface
  23. * instance based on it.
  24. *
  25. * @return RequestInterface
  26. */
  27. public function createRequest(string $method, $uri): RequestInterface;
  28. }
  29. }
  30. // file: vendor/psr/http-factory/src/ResponseFactoryInterface.php
  31. namespace Psr\Http\Message {
  32. interface ResponseFactoryInterface
  33. {
  34. /**
  35. * Create a new response.
  36. *
  37. * @param int $code HTTP status code; defaults to 200
  38. * @param string $reasonPhrase Reason phrase to associate with status code
  39. * in generated response; if none is provided implementations MAY use
  40. * the defaults as suggested in the HTTP specification.
  41. *
  42. * @return ResponseInterface
  43. */
  44. public function createResponse(int $code = 200, string $reasonPhrase = ''): ResponseInterface;
  45. }
  46. }
  47. // file: vendor/psr/http-factory/src/ServerRequestFactoryInterface.php
  48. namespace Psr\Http\Message {
  49. interface ServerRequestFactoryInterface
  50. {
  51. /**
  52. * Create a new server request.
  53. *
  54. * Note that server-params are taken precisely as given - no parsing/processing
  55. * of the given values is performed, and, in particular, no attempt is made to
  56. * determine the HTTP method or URI, which must be provided explicitly.
  57. *
  58. * @param string $method The HTTP method associated with the request.
  59. * @param UriInterface|string $uri The URI associated with the request. If
  60. * the value is a string, the factory MUST create a UriInterface
  61. * instance based on it.
  62. * @param array $serverParams Array of SAPI parameters with which to seed
  63. * the generated request instance.
  64. *
  65. * @return ServerRequestInterface
  66. */
  67. public function createServerRequest(string $method, $uri, array $serverParams = []): ServerRequestInterface;
  68. }
  69. }
  70. // file: vendor/psr/http-factory/src/StreamFactoryInterface.php
  71. namespace Psr\Http\Message {
  72. interface StreamFactoryInterface
  73. {
  74. /**
  75. * Create a new stream from a string.
  76. *
  77. * The stream SHOULD be created with a temporary resource.
  78. *
  79. * @param string $content String content with which to populate the stream.
  80. *
  81. * @return StreamInterface
  82. */
  83. public function createStream(string $content = ''): StreamInterface;
  84. /**
  85. * Create a stream from an existing file.
  86. *
  87. * The file MUST be opened using the given mode, which may be any mode
  88. * supported by the `fopen` function.
  89. *
  90. * The `$filename` MAY be any string supported by `fopen()`.
  91. *
  92. * @param string $filename Filename or stream URI to use as basis of stream.
  93. * @param string $mode Mode with which to open the underlying filename/stream.
  94. *
  95. * @return StreamInterface
  96. * @throws \RuntimeException If the file cannot be opened.
  97. * @throws \InvalidArgumentException If the mode is invalid.
  98. */
  99. public function createStreamFromFile(string $filename, string $mode = 'r'): StreamInterface;
  100. /**
  101. * Create a new stream from an existing resource.
  102. *
  103. * The stream MUST be readable and may be writable.
  104. *
  105. * @param resource $resource PHP resource to use as basis of stream.
  106. *
  107. * @return StreamInterface
  108. */
  109. public function createStreamFromResource($resource): StreamInterface;
  110. }
  111. }
  112. // file: vendor/psr/http-factory/src/UploadedFileFactoryInterface.php
  113. namespace Psr\Http\Message {
  114. interface UploadedFileFactoryInterface
  115. {
  116. /**
  117. * Create a new uploaded file.
  118. *
  119. * If a size is not provided it will be determined by checking the size of
  120. * the file.
  121. *
  122. * @see http://php.net/manual/features.file-upload.post-method.php
  123. * @see http://php.net/manual/features.file-upload.errors.php
  124. *
  125. * @param StreamInterface $stream Underlying stream representing the
  126. * uploaded file content.
  127. * @param int $size in bytes
  128. * @param int $error PHP file upload error
  129. * @param string $clientFilename Filename as provided by the client, if any.
  130. * @param string $clientMediaType Media type as provided by the client, if any.
  131. *
  132. * @return UploadedFileInterface
  133. *
  134. * @throws \InvalidArgumentException If the file resource is not readable.
  135. */
  136. public function createUploadedFile(
  137. StreamInterface $stream,
  138. int $size = null,
  139. int $error = \UPLOAD_ERR_OK,
  140. string $clientFilename = null,
  141. string $clientMediaType = null
  142. ): UploadedFileInterface;
  143. }
  144. }
  145. // file: vendor/psr/http-factory/src/UriFactoryInterface.php
  146. namespace Psr\Http\Message {
  147. interface UriFactoryInterface
  148. {
  149. /**
  150. * Create a new URI.
  151. *
  152. * @param string $uri
  153. *
  154. * @return UriInterface
  155. *
  156. * @throws \InvalidArgumentException If the given URI cannot be parsed.
  157. */
  158. public function createUri(string $uri = ''): UriInterface;
  159. }
  160. }
  161. // file: vendor/psr/http-message/src/MessageInterface.php
  162. namespace Psr\Http\Message {
  163. /**
  164. * HTTP messages consist of requests from a client to a server and responses
  165. * from a server to a client. This interface defines the methods common to
  166. * each.
  167. *
  168. * Messages are considered immutable; all methods that might change state MUST
  169. * be implemented such that they retain the internal state of the current
  170. * message and return an instance that contains the changed state.
  171. *
  172. * @link http://www.ietf.org/rfc/rfc7230.txt
  173. * @link http://www.ietf.org/rfc/rfc7231.txt
  174. */
  175. interface MessageInterface
  176. {
  177. /**
  178. * Retrieves the HTTP protocol version as a string.
  179. *
  180. * The string MUST contain only the HTTP version number (e.g., "1.1", "1.0").
  181. *
  182. * @return string HTTP protocol version.
  183. */
  184. public function getProtocolVersion();
  185. /**
  186. * Return an instance with the specified HTTP protocol version.
  187. *
  188. * The version string MUST contain only the HTTP version number (e.g.,
  189. * "1.1", "1.0").
  190. *
  191. * This method MUST be implemented in such a way as to retain the
  192. * immutability of the message, and MUST return an instance that has the
  193. * new protocol version.
  194. *
  195. * @param string $version HTTP protocol version
  196. * @return static
  197. */
  198. public function withProtocolVersion($version);
  199. /**
  200. * Retrieves all message header values.
  201. *
  202. * The keys represent the header name as it will be sent over the wire, and
  203. * each value is an array of strings associated with the header.
  204. *
  205. * // Represent the headers as a string
  206. * foreach ($message->getHeaders() as $name => $values) {
  207. * echo $name . ": " . implode(", ", $values);
  208. * }
  209. *
  210. * // Emit headers iteratively:
  211. * foreach ($message->getHeaders() as $name => $values) {
  212. * foreach ($values as $value) {
  213. * header(sprintf('%s: %s', $name, $value), false);
  214. * }
  215. * }
  216. *
  217. * While header names are not case-sensitive, getHeaders() will preserve the
  218. * exact case in which headers were originally specified.
  219. *
  220. * @return string[][] Returns an associative array of the message's headers. Each
  221. * key MUST be a header name, and each value MUST be an array of strings
  222. * for that header.
  223. */
  224. public function getHeaders();
  225. /**
  226. * Checks if a header exists by the given case-insensitive name.
  227. *
  228. * @param string $name Case-insensitive header field name.
  229. * @return bool Returns true if any header names match the given header
  230. * name using a case-insensitive string comparison. Returns false if
  231. * no matching header name is found in the message.
  232. */
  233. public function hasHeader($name);
  234. /**
  235. * Retrieves a message header value by the given case-insensitive name.
  236. *
  237. * This method returns an array of all the header values of the given
  238. * case-insensitive header name.
  239. *
  240. * If the header does not appear in the message, this method MUST return an
  241. * empty array.
  242. *
  243. * @param string $name Case-insensitive header field name.
  244. * @return string[] An array of string values as provided for the given
  245. * header. If the header does not appear in the message, this method MUST
  246. * return an empty array.
  247. */
  248. public function getHeader($name);
  249. /**
  250. * Retrieves a comma-separated string of the values for a single header.
  251. *
  252. * This method returns all of the header values of the given
  253. * case-insensitive header name as a string concatenated together using
  254. * a comma.
  255. *
  256. * NOTE: Not all header values may be appropriately represented using
  257. * comma concatenation. For such headers, use getHeader() instead
  258. * and supply your own delimiter when concatenating.
  259. *
  260. * If the header does not appear in the message, this method MUST return
  261. * an empty string.
  262. *
  263. * @param string $name Case-insensitive header field name.
  264. * @return string A string of values as provided for the given header
  265. * concatenated together using a comma. If the header does not appear in
  266. * the message, this method MUST return an empty string.
  267. */
  268. public function getHeaderLine($name);
  269. /**
  270. * Return an instance with the provided value replacing the specified header.
  271. *
  272. * While header names are case-insensitive, the casing of the header will
  273. * be preserved by this function, and returned from getHeaders().
  274. *
  275. * This method MUST be implemented in such a way as to retain the
  276. * immutability of the message, and MUST return an instance that has the
  277. * new and/or updated header and value.
  278. *
  279. * @param string $name Case-insensitive header field name.
  280. * @param string|string[] $value Header value(s).
  281. * @return static
  282. * @throws \InvalidArgumentException for invalid header names or values.
  283. */
  284. public function withHeader($name, $value);
  285. /**
  286. * Return an instance with the specified header appended with the given value.
  287. *
  288. * Existing values for the specified header will be maintained. The new
  289. * value(s) will be appended to the existing list. If the header did not
  290. * exist previously, it will be added.
  291. *
  292. * This method MUST be implemented in such a way as to retain the
  293. * immutability of the message, and MUST return an instance that has the
  294. * new header and/or value.
  295. *
  296. * @param string $name Case-insensitive header field name to add.
  297. * @param string|string[] $value Header value(s).
  298. * @return static
  299. * @throws \InvalidArgumentException for invalid header names or values.
  300. */
  301. public function withAddedHeader($name, $value);
  302. /**
  303. * Return an instance without the specified header.
  304. *
  305. * Header resolution MUST be done without case-sensitivity.
  306. *
  307. * This method MUST be implemented in such a way as to retain the
  308. * immutability of the message, and MUST return an instance that removes
  309. * the named header.
  310. *
  311. * @param string $name Case-insensitive header field name to remove.
  312. * @return static
  313. */
  314. public function withoutHeader($name);
  315. /**
  316. * Gets the body of the message.
  317. *
  318. * @return StreamInterface Returns the body as a stream.
  319. */
  320. public function getBody();
  321. /**
  322. * Return an instance with the specified message body.
  323. *
  324. * The body MUST be a StreamInterface object.
  325. *
  326. * This method MUST be implemented in such a way as to retain the
  327. * immutability of the message, and MUST return a new instance that has the
  328. * new body stream.
  329. *
  330. * @param StreamInterface $body Body.
  331. * @return static
  332. * @throws \InvalidArgumentException When the body is not valid.
  333. */
  334. public function withBody(StreamInterface $body);
  335. }
  336. }
  337. // file: vendor/psr/http-message/src/RequestInterface.php
  338. namespace Psr\Http\Message {
  339. /**
  340. * Representation of an outgoing, client-side request.
  341. *
  342. * Per the HTTP specification, this interface includes properties for
  343. * each of the following:
  344. *
  345. * - Protocol version
  346. * - HTTP method
  347. * - URI
  348. * - Headers
  349. * - Message body
  350. *
  351. * During construction, implementations MUST attempt to set the Host header from
  352. * a provided URI if no Host header is provided.
  353. *
  354. * Requests are considered immutable; all methods that might change state MUST
  355. * be implemented such that they retain the internal state of the current
  356. * message and return an instance that contains the changed state.
  357. */
  358. interface RequestInterface extends MessageInterface
  359. {
  360. /**
  361. * Retrieves the message's request target.
  362. *
  363. * Retrieves the message's request-target either as it will appear (for
  364. * clients), as it appeared at request (for servers), or as it was
  365. * specified for the instance (see withRequestTarget()).
  366. *
  367. * In most cases, this will be the origin-form of the composed URI,
  368. * unless a value was provided to the concrete implementation (see
  369. * withRequestTarget() below).
  370. *
  371. * If no URI is available, and no request-target has been specifically
  372. * provided, this method MUST return the string "/".
  373. *
  374. * @return string
  375. */
  376. public function getRequestTarget();
  377. /**
  378. * Return an instance with the specific request-target.
  379. *
  380. * If the request needs a non-origin-form request-target — e.g., for
  381. * specifying an absolute-form, authority-form, or asterisk-form —
  382. * this method may be used to create an instance with the specified
  383. * request-target, verbatim.
  384. *
  385. * This method MUST be implemented in such a way as to retain the
  386. * immutability of the message, and MUST return an instance that has the
  387. * changed request target.
  388. *
  389. * @link http://tools.ietf.org/html/rfc7230#section-5.3 (for the various
  390. * request-target forms allowed in request messages)
  391. * @param mixed $requestTarget
  392. * @return static
  393. */
  394. public function withRequestTarget($requestTarget);
  395. /**
  396. * Retrieves the HTTP method of the request.
  397. *
  398. * @return string Returns the request method.
  399. */
  400. public function getMethod();
  401. /**
  402. * Return an instance with the provided HTTP method.
  403. *
  404. * While HTTP method names are typically all uppercase characters, HTTP
  405. * method names are case-sensitive and thus implementations SHOULD NOT
  406. * modify the given string.
  407. *
  408. * This method MUST be implemented in such a way as to retain the
  409. * immutability of the message, and MUST return an instance that has the
  410. * changed request method.
  411. *
  412. * @param string $method Case-sensitive method.
  413. * @return static
  414. * @throws \InvalidArgumentException for invalid HTTP methods.
  415. */
  416. public function withMethod($method);
  417. /**
  418. * Retrieves the URI instance.
  419. *
  420. * This method MUST return a UriInterface instance.
  421. *
  422. * @link http://tools.ietf.org/html/rfc3986#section-4.3
  423. * @return UriInterface Returns a UriInterface instance
  424. * representing the URI of the request.
  425. */
  426. public function getUri();
  427. /**
  428. * Returns an instance with the provided URI.
  429. *
  430. * This method MUST update the Host header of the returned request by
  431. * default if the URI contains a host component. If the URI does not
  432. * contain a host component, any pre-existing Host header MUST be carried
  433. * over to the returned request.
  434. *
  435. * You can opt-in to preserving the original state of the Host header by
  436. * setting `$preserveHost` to `true`. When `$preserveHost` is set to
  437. * `true`, this method interacts with the Host header in the following ways:
  438. *
  439. * - If the Host header is missing or empty, and the new URI contains
  440. * a host component, this method MUST update the Host header in the returned
  441. * request.
  442. * - If the Host header is missing or empty, and the new URI does not contain a
  443. * host component, this method MUST NOT update the Host header in the returned
  444. * request.
  445. * - If a Host header is present and non-empty, this method MUST NOT update
  446. * the Host header in the returned request.
  447. *
  448. * This method MUST be implemented in such a way as to retain the
  449. * immutability of the message, and MUST return an instance that has the
  450. * new UriInterface instance.
  451. *
  452. * @link http://tools.ietf.org/html/rfc3986#section-4.3
  453. * @param UriInterface $uri New request URI to use.
  454. * @param bool $preserveHost Preserve the original state of the Host header.
  455. * @return static
  456. */
  457. public function withUri(UriInterface $uri, $preserveHost = false);
  458. }
  459. }
  460. // file: vendor/psr/http-message/src/ResponseInterface.php
  461. namespace Psr\Http\Message {
  462. /**
  463. * Representation of an outgoing, server-side response.
  464. *
  465. * Per the HTTP specification, this interface includes properties for
  466. * each of the following:
  467. *
  468. * - Protocol version
  469. * - Status code and reason phrase
  470. * - Headers
  471. * - Message body
  472. *
  473. * Responses are considered immutable; all methods that might change state MUST
  474. * be implemented such that they retain the internal state of the current
  475. * message and return an instance that contains the changed state.
  476. */
  477. interface ResponseInterface extends MessageInterface
  478. {
  479. /**
  480. * Gets the response status code.
  481. *
  482. * The status code is a 3-digit integer result code of the server's attempt
  483. * to understand and satisfy the request.
  484. *
  485. * @return int Status code.
  486. */
  487. public function getStatusCode();
  488. /**
  489. * Return an instance with the specified status code and, optionally, reason phrase.
  490. *
  491. * If no reason phrase is specified, implementations MAY choose to default
  492. * to the RFC 7231 or IANA recommended reason phrase for the response's
  493. * status code.
  494. *
  495. * This method MUST be implemented in such a way as to retain the
  496. * immutability of the message, and MUST return an instance that has the
  497. * updated status and reason phrase.
  498. *
  499. * @link http://tools.ietf.org/html/rfc7231#section-6
  500. * @link http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
  501. * @param int $code The 3-digit integer result code to set.
  502. * @param string $reasonPhrase The reason phrase to use with the
  503. * provided status code; if none is provided, implementations MAY
  504. * use the defaults as suggested in the HTTP specification.
  505. * @return static
  506. * @throws \InvalidArgumentException For invalid status code arguments.
  507. */
  508. public function withStatus($code, $reasonPhrase = '');
  509. /**
  510. * Gets the response reason phrase associated with the status code.
  511. *
  512. * Because a reason phrase is not a required element in a response
  513. * status line, the reason phrase value MAY be null. Implementations MAY
  514. * choose to return the default RFC 7231 recommended reason phrase (or those
  515. * listed in the IANA HTTP Status Code Registry) for the response's
  516. * status code.
  517. *
  518. * @link http://tools.ietf.org/html/rfc7231#section-6
  519. * @link http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
  520. * @return string Reason phrase; must return an empty string if none present.
  521. */
  522. public function getReasonPhrase();
  523. }
  524. }
  525. // file: vendor/psr/http-message/src/ServerRequestInterface.php
  526. namespace Psr\Http\Message {
  527. /**
  528. * Representation of an incoming, server-side HTTP request.
  529. *
  530. * Per the HTTP specification, this interface includes properties for
  531. * each of the following:
  532. *
  533. * - Protocol version
  534. * - HTTP method
  535. * - URI
  536. * - Headers
  537. * - Message body
  538. *
  539. * Additionally, it encapsulates all data as it has arrived to the
  540. * application from the CGI and/or PHP environment, including:
  541. *
  542. * - The values represented in $_SERVER.
  543. * - Any cookies provided (generally via $_COOKIE)
  544. * - Query string arguments (generally via $_GET, or as parsed via parse_str())
  545. * - Upload files, if any (as represented by $_FILES)
  546. * - Deserialized body parameters (generally from $_POST)
  547. *
  548. * $_SERVER values MUST be treated as immutable, as they represent application
  549. * state at the time of request; as such, no methods are provided to allow
  550. * modification of those values. The other values provide such methods, as they
  551. * can be restored from $_SERVER or the request body, and may need treatment
  552. * during the application (e.g., body parameters may be deserialized based on
  553. * content type).
  554. *
  555. * Additionally, this interface recognizes the utility of introspecting a
  556. * request to derive and match additional parameters (e.g., via URI path
  557. * matching, decrypting cookie values, deserializing non-form-encoded body
  558. * content, matching authorization headers to users, etc). These parameters
  559. * are stored in an "attributes" property.
  560. *
  561. * Requests are considered immutable; all methods that might change state MUST
  562. * be implemented such that they retain the internal state of the current
  563. * message and return an instance that contains the changed state.
  564. */
  565. interface ServerRequestInterface extends RequestInterface
  566. {
  567. /**
  568. * Retrieve server parameters.
  569. *
  570. * Retrieves data related to the incoming request environment,
  571. * typically derived from PHP's $_SERVER superglobal. The data IS NOT
  572. * REQUIRED to originate from $_SERVER.
  573. *
  574. * @return array
  575. */
  576. public function getServerParams();
  577. /**
  578. * Retrieve cookies.
  579. *
  580. * Retrieves cookies sent by the client to the server.
  581. *
  582. * The data MUST be compatible with the structure of the $_COOKIE
  583. * superglobal.
  584. *
  585. * @return array
  586. */
  587. public function getCookieParams();
  588. /**
  589. * Return an instance with the specified cookies.
  590. *
  591. * The data IS NOT REQUIRED to come from the $_COOKIE superglobal, but MUST
  592. * be compatible with the structure of $_COOKIE. Typically, this data will
  593. * be injected at instantiation.
  594. *
  595. * This method MUST NOT update the related Cookie header of the request
  596. * instance, nor related values in the server params.
  597. *
  598. * This method MUST be implemented in such a way as to retain the
  599. * immutability of the message, and MUST return an instance that has the
  600. * updated cookie values.
  601. *
  602. * @param array $cookies Array of key/value pairs representing cookies.
  603. * @return static
  604. */
  605. public function withCookieParams(array $cookies);
  606. /**
  607. * Retrieve query string arguments.
  608. *
  609. * Retrieves the deserialized query string arguments, if any.
  610. *
  611. * Note: the query params might not be in sync with the URI or server
  612. * params. If you need to ensure you are only getting the original
  613. * values, you may need to parse the query string from `getUri()->getQuery()`
  614. * or from the `QUERY_STRING` server param.
  615. *
  616. * @return array
  617. */
  618. public function getQueryParams();
  619. /**
  620. * Return an instance with the specified query string arguments.
  621. *
  622. * These values SHOULD remain immutable over the course of the incoming
  623. * request. They MAY be injected during instantiation, such as from PHP's
  624. * $_GET superglobal, or MAY be derived from some other value such as the
  625. * URI. In cases where the arguments are parsed from the URI, the data
  626. * MUST be compatible with what PHP's parse_str() would return for
  627. * purposes of how duplicate query parameters are handled, and how nested
  628. * sets are handled.
  629. *
  630. * Setting query string arguments MUST NOT change the URI stored by the
  631. * request, nor the values in the server params.
  632. *
  633. * This method MUST be implemented in such a way as to retain the
  634. * immutability of the message, and MUST return an instance that has the
  635. * updated query string arguments.
  636. *
  637. * @param array $query Array of query string arguments, typically from
  638. * $_GET.
  639. * @return static
  640. */
  641. public function withQueryParams(array $query);
  642. /**
  643. * Retrieve normalized file upload data.
  644. *
  645. * This method returns upload metadata in a normalized tree, with each leaf
  646. * an instance of Psr\Http\Message\UploadedFileInterface.
  647. *
  648. * These values MAY be prepared from $_FILES or the message body during
  649. * instantiation, or MAY be injected via withUploadedFiles().
  650. *
  651. * @return array An array tree of UploadedFileInterface instances; an empty
  652. * array MUST be returned if no data is present.
  653. */
  654. public function getUploadedFiles();
  655. /**
  656. * Create a new instance with the specified uploaded files.
  657. *
  658. * This method MUST be implemented in such a way as to retain the
  659. * immutability of the message, and MUST return an instance that has the
  660. * updated body parameters.
  661. *
  662. * @param array $uploadedFiles An array tree of UploadedFileInterface instances.
  663. * @return static
  664. * @throws \InvalidArgumentException if an invalid structure is provided.
  665. */
  666. public function withUploadedFiles(array $uploadedFiles);
  667. /**
  668. * Retrieve any parameters provided in the request body.
  669. *
  670. * If the request Content-Type is either application/x-www-form-urlencoded
  671. * or multipart/form-data, and the request method is POST, this method MUST
  672. * return the contents of $_POST.
  673. *
  674. * Otherwise, this method may return any results of deserializing
  675. * the request body content; as parsing returns structured content, the
  676. * potential types MUST be arrays or objects only. A null value indicates
  677. * the absence of body content.
  678. *
  679. * @return null|array|object The deserialized body parameters, if any.
  680. * These will typically be an array or object.
  681. */
  682. public function getParsedBody();
  683. /**
  684. * Return an instance with the specified body parameters.
  685. *
  686. * These MAY be injected during instantiation.
  687. *
  688. * If the request Content-Type is either application/x-www-form-urlencoded
  689. * or multipart/form-data, and the request method is POST, use this method
  690. * ONLY to inject the contents of $_POST.
  691. *
  692. * The data IS NOT REQUIRED to come from $_POST, but MUST be the results of
  693. * deserializing the request body content. Deserialization/parsing returns
  694. * structured data, and, as such, this method ONLY accepts arrays or objects,
  695. * or a null value if nothing was available to parse.
  696. *
  697. * As an example, if content negotiation determines that the request data
  698. * is a JSON payload, this method could be used to create a request
  699. * instance with the deserialized parameters.
  700. *
  701. * This method MUST be implemented in such a way as to retain the
  702. * immutability of the message, and MUST return an instance that has the
  703. * updated body parameters.
  704. *
  705. * @param null|array|object $data The deserialized body data. This will
  706. * typically be in an array or object.
  707. * @return static
  708. * @throws \InvalidArgumentException if an unsupported argument type is
  709. * provided.
  710. */
  711. public function withParsedBody($data);
  712. /**
  713. * Retrieve attributes derived from the request.
  714. *
  715. * The request "attributes" may be used to allow injection of any
  716. * parameters derived from the request: e.g., the results of path
  717. * match operations; the results of decrypting cookies; the results of
  718. * deserializing non-form-encoded message bodies; etc. Attributes
  719. * will be application and request specific, and CAN be mutable.
  720. *
  721. * @return array Attributes derived from the request.
  722. */
  723. public function getAttributes();
  724. /**
  725. * Retrieve a single derived request attribute.
  726. *
  727. * Retrieves a single derived request attribute as described in
  728. * getAttributes(). If the attribute has not been previously set, returns
  729. * the default value as provided.
  730. *
  731. * This method obviates the need for a hasAttribute() method, as it allows
  732. * specifying a default value to return if the attribute is not found.
  733. *
  734. * @see getAttributes()
  735. * @param string $name The attribute name.
  736. * @param mixed $default Default value to return if the attribute does not exist.
  737. * @return mixed
  738. */
  739. public function getAttribute($name, $default = null);
  740. /**
  741. * Return an instance with the specified derived request attribute.
  742. *
  743. * This method allows setting a single derived request attribute as
  744. * described in getAttributes().
  745. *
  746. * This method MUST be implemented in such a way as to retain the
  747. * immutability of the message, and MUST return an instance that has the
  748. * updated attribute.
  749. *
  750. * @see getAttributes()
  751. * @param string $name The attribute name.
  752. * @param mixed $value The value of the attribute.
  753. * @return static
  754. */
  755. public function withAttribute($name, $value);
  756. /**
  757. * Return an instance that removes the specified derived request attribute.
  758. *
  759. * This method allows removing a single derived request attribute as
  760. * described in getAttributes().
  761. *
  762. * This method MUST be implemented in such a way as to retain the
  763. * immutability of the message, and MUST return an instance that removes
  764. * the attribute.
  765. *
  766. * @see getAttributes()
  767. * @param string $name The attribute name.
  768. * @return static
  769. */
  770. public function withoutAttribute($name);
  771. }
  772. }
  773. // file: vendor/psr/http-message/src/StreamInterface.php
  774. namespace Psr\Http\Message {
  775. /**
  776. * Describes a data stream.
  777. *
  778. * Typically, an instance will wrap a PHP stream; this interface provides
  779. * a wrapper around the most common operations, including serialization of
  780. * the entire stream to a string.
  781. */
  782. interface StreamInterface
  783. {
  784. /**
  785. * Reads all data from the stream into a string, from the beginning to end.
  786. *
  787. * This method MUST attempt to seek to the beginning of the stream before
  788. * reading data and read the stream until the end is reached.
  789. *
  790. * Warning: This could attempt to load a large amount of data into memory.
  791. *
  792. * This method MUST NOT raise an exception in order to conform with PHP's
  793. * string casting operations.
  794. *
  795. * @see http://php.net/manual/en/language.oop5.magic.php#object.tostring
  796. * @return string
  797. */
  798. public function __toString();
  799. /**
  800. * Closes the stream and any underlying resources.
  801. *
  802. * @return void
  803. */
  804. public function close();
  805. /**
  806. * Separates any underlying resources from the stream.
  807. *
  808. * After the stream has been detached, the stream is in an unusable state.
  809. *
  810. * @return resource|null Underlying PHP stream, if any
  811. */
  812. public function detach();
  813. /**
  814. * Get the size of the stream if known.
  815. *
  816. * @return int|null Returns the size in bytes if known, or null if unknown.
  817. */
  818. public function getSize();
  819. /**
  820. * Returns the current position of the file read/write pointer
  821. *
  822. * @return int Position of the file pointer
  823. * @throws \RuntimeException on error.
  824. */
  825. public function tell();
  826. /**
  827. * Returns true if the stream is at the end of the stream.
  828. *
  829. * @return bool
  830. */
  831. public function eof();
  832. /**
  833. * Returns whether or not the stream is seekable.
  834. *
  835. * @return bool
  836. */
  837. public function isSeekable();
  838. /**
  839. * Seek to a position in the stream.
  840. *
  841. * @link http://www.php.net/manual/en/function.fseek.php
  842. * @param int $offset Stream offset
  843. * @param int $whence Specifies how the cursor position will be calculated
  844. * based on the seek offset. Valid values are identical to the built-in
  845. * PHP $whence values for `fseek()`. SEEK_SET: Set position equal to
  846. * offset bytes SEEK_CUR: Set position to current location plus offset
  847. * SEEK_END: Set position to end-of-stream plus offset.
  848. * @throws \RuntimeException on failure.
  849. */
  850. public function seek($offset, $whence = SEEK_SET);
  851. /**
  852. * Seek to the beginning of the stream.
  853. *
  854. * If the stream is not seekable, this method will raise an exception;
  855. * otherwise, it will perform a seek(0).
  856. *
  857. * @see seek()
  858. * @link http://www.php.net/manual/en/function.fseek.php
  859. * @throws \RuntimeException on failure.
  860. */
  861. public function rewind();
  862. /**
  863. * Returns whether or not the stream is writable.
  864. *
  865. * @return bool
  866. */
  867. public function isWritable();
  868. /**
  869. * Write data to the stream.
  870. *
  871. * @param string $string The string that is to be written.
  872. * @return int Returns the number of bytes written to the stream.
  873. * @throws \RuntimeException on failure.
  874. */
  875. public function write($string);
  876. /**
  877. * Returns whether or not the stream is readable.
  878. *
  879. * @return bool
  880. */
  881. public function isReadable();
  882. /**
  883. * Read data from the stream.
  884. *
  885. * @param int $length Read up to $length bytes from the object and return
  886. * them. Fewer than $length bytes may be returned if underlying stream
  887. * call returns fewer bytes.
  888. * @return string Returns the data read from the stream, or an empty string
  889. * if no bytes are available.
  890. * @throws \RuntimeException if an error occurs.
  891. */
  892. public function read($length);
  893. /**
  894. * Returns the remaining contents in a string
  895. *
  896. * @return string
  897. * @throws \RuntimeException if unable to read or an error occurs while
  898. * reading.
  899. */
  900. public function getContents();
  901. /**
  902. * Get stream metadata as an associative array or retrieve a specific key.
  903. *
  904. * The keys returned are identical to the keys returned from PHP's
  905. * stream_get_meta_data() function.
  906. *
  907. * @link http://php.net/manual/en/function.stream-get-meta-data.php
  908. * @param string $key Specific metadata to retrieve.
  909. * @return array|mixed|null Returns an associative array if no key is
  910. * provided. Returns a specific key value if a key is provided and the
  911. * value is found, or null if the key is not found.
  912. */
  913. public function getMetadata($key = null);
  914. }
  915. }
  916. // file: vendor/psr/http-message/src/UploadedFileInterface.php
  917. namespace Psr\Http\Message {
  918. /**
  919. * Value object representing a file uploaded through an HTTP request.
  920. *
  921. * Instances of this interface are considered immutable; all methods that
  922. * might change state MUST be implemented such that they retain the internal
  923. * state of the current instance and return an instance that contains the
  924. * changed state.
  925. */
  926. interface UploadedFileInterface
  927. {
  928. /**
  929. * Retrieve a stream representing the uploaded file.
  930. *
  931. * This method MUST return a StreamInterface instance, representing the
  932. * uploaded file. The purpose of this method is to allow utilizing native PHP
  933. * stream functionality to manipulate the file upload, such as
  934. * stream_copy_to_stream() (though the result will need to be decorated in a
  935. * native PHP stream wrapper to work with such functions).
  936. *
  937. * If the moveTo() method has been called previously, this method MUST raise
  938. * an exception.
  939. *
  940. * @return StreamInterface Stream representation of the uploaded file.
  941. * @throws \RuntimeException in cases when no stream is available or can be
  942. * created.
  943. */
  944. public function getStream();
  945. /**
  946. * Move the uploaded file to a new location.
  947. *
  948. * Use this method as an alternative to move_uploaded_file(). This method is
  949. * guaranteed to work in both SAPI and non-SAPI environments.
  950. * Implementations must determine which environment they are in, and use the
  951. * appropriate method (move_uploaded_file(), rename(), or a stream
  952. * operation) to perform the operation.
  953. *
  954. * $targetPath may be an absolute path, or a relative path. If it is a
  955. * relative path, resolution should be the same as used by PHP's rename()
  956. * function.
  957. *
  958. * The original file or stream MUST be removed on completion.
  959. *
  960. * If this method is called more than once, any subsequent calls MUST raise
  961. * an exception.
  962. *
  963. * When used in an SAPI environment where $_FILES is populated, when writing
  964. * files via moveTo(), is_uploaded_file() and move_uploaded_file() SHOULD be
  965. * used to ensure permissions and upload status are verified correctly.
  966. *
  967. * If you wish to move to a stream, use getStream(), as SAPI operations
  968. * cannot guarantee writing to stream destinations.
  969. *
  970. * @see http://php.net/is_uploaded_file
  971. * @see http://php.net/move_uploaded_file
  972. * @param string $targetPath Path to which to move the uploaded file.
  973. * @throws \InvalidArgumentException if the $targetPath specified is invalid.
  974. * @throws \RuntimeException on any error during the move operation, or on
  975. * the second or subsequent call to the method.
  976. */
  977. public function moveTo($targetPath);
  978. /**
  979. * Retrieve the file size.
  980. *
  981. * Implementations SHOULD return the value stored in the "size" key of
  982. * the file in the $_FILES array if available, as PHP calculates this based
  983. * on the actual size transmitted.
  984. *
  985. * @return int|null The file size in bytes or null if unknown.
  986. */
  987. public function getSize();
  988. /**
  989. * Retrieve the error associated with the uploaded file.
  990. *
  991. * The return value MUST be one of PHP's UPLOAD_ERR_XXX constants.
  992. *
  993. * If the file was uploaded successfully, this method MUST return
  994. * UPLOAD_ERR_OK.
  995. *
  996. * Implementations SHOULD return the value stored in the "error" key of
  997. * the file in the $_FILES array.
  998. *
  999. * @see http://php.net/manual/en/features.file-upload.errors.php
  1000. * @return int One of PHP's UPLOAD_ERR_XXX constants.
  1001. */
  1002. public function getError();
  1003. /**
  1004. * Retrieve the filename sent by the client.
  1005. *
  1006. * Do not trust the value returned by this method. A client could send
  1007. * a malicious filename with the intention to corrupt or hack your
  1008. * application.
  1009. *
  1010. * Implementations SHOULD return the value stored in the "name" key of
  1011. * the file in the $_FILES array.
  1012. *
  1013. * @return string|null The filename sent by the client or null if none
  1014. * was provided.
  1015. */
  1016. public function getClientFilename();
  1017. /**
  1018. * Retrieve the media type sent by the client.
  1019. *
  1020. * Do not trust the value returned by this method. A client could send
  1021. * a malicious media type with the intention to corrupt or hack your
  1022. * application.
  1023. *
  1024. * Implementations SHOULD return the value stored in the "type" key of
  1025. * the file in the $_FILES array.
  1026. *
  1027. * @return string|null The media type sent by the client or null if none
  1028. * was provided.
  1029. */
  1030. public function getClientMediaType();
  1031. }
  1032. }
  1033. // file: vendor/psr/http-message/src/UriInterface.php
  1034. namespace Psr\Http\Message {
  1035. /**
  1036. * Value object representing a URI.
  1037. *
  1038. * This interface is meant to represent URIs according to RFC 3986 and to
  1039. * provide methods for most common operations. Additional functionality for
  1040. * working with URIs can be provided on top of the interface or externally.
  1041. * Its primary use is for HTTP requests, but may also be used in other
  1042. * contexts.
  1043. *
  1044. * Instances of this interface are considered immutable; all methods that
  1045. * might change state MUST be implemented such that they retain the internal
  1046. * state of the current instance and return an instance that contains the
  1047. * changed state.
  1048. *
  1049. * Typically the Host header will be also be present in the request message.
  1050. * For server-side requests, the scheme will typically be discoverable in the
  1051. * server parameters.
  1052. *
  1053. * @link http://tools.ietf.org/html/rfc3986 (the URI specification)
  1054. */
  1055. interface UriInterface
  1056. {
  1057. /**
  1058. * Retrieve the scheme component of the URI.
  1059. *
  1060. * If no scheme is present, this method MUST return an empty string.
  1061. *
  1062. * The value returned MUST be normalized to lowercase, per RFC 3986
  1063. * Section 3.1.
  1064. *
  1065. * The trailing ":" character is not part of the scheme and MUST NOT be
  1066. * added.
  1067. *
  1068. * @see https://tools.ietf.org/html/rfc3986#section-3.1
  1069. * @return string The URI scheme.
  1070. */
  1071. public function getScheme();
  1072. /**
  1073. * Retrieve the authority component of the URI.
  1074. *
  1075. * If no authority information is present, this method MUST return an empty
  1076. * string.
  1077. *
  1078. * The authority syntax of the URI is:
  1079. *
  1080. * <pre>
  1081. * [user-info@]host[:port]
  1082. * </pre>
  1083. *
  1084. * If the port component is not set or is the standard port for the current
  1085. * scheme, it SHOULD NOT be included.
  1086. *
  1087. * @see https://tools.ietf.org/html/rfc3986#section-3.2
  1088. * @return string The URI authority, in "[user-info@]host[:port]" format.
  1089. */
  1090. public function getAuthority();
  1091. /**
  1092. * Retrieve the user information component of the URI.
  1093. *
  1094. * If no user information is present, this method MUST return an empty
  1095. * string.
  1096. *
  1097. * If a user is present in the URI, this will return that value;
  1098. * additionally, if the password is also present, it will be appended to the
  1099. * user value, with a colon (":") separating the values.
  1100. *
  1101. * The trailing "@" character is not part of the user information and MUST
  1102. * NOT be added.
  1103. *
  1104. * @return string The URI user information, in "username[:password]" format.
  1105. */
  1106. public function getUserInfo();
  1107. /**
  1108. * Retrieve the host component of the URI.
  1109. *
  1110. * If no host is present, this method MUST return an empty string.
  1111. *
  1112. * The value returned MUST be normalized to lowercase, per RFC 3986
  1113. * Section 3.2.2.
  1114. *
  1115. * @see http://tools.ietf.org/html/rfc3986#section-3.2.2
  1116. * @return string The URI host.
  1117. */
  1118. public function getHost();
  1119. /**
  1120. * Retrieve the port component of the URI.
  1121. *
  1122. * If a port is present, and it is non-standard for the current scheme,
  1123. * this method MUST return it as an integer. If the port is the standard port
  1124. * used with the current scheme, this method SHOULD return null.
  1125. *
  1126. * If no port is present, and no scheme is present, this method MUST return
  1127. * a null value.
  1128. *
  1129. * If no port is present, but a scheme is present, this method MAY return
  1130. * the standard port for that scheme, but SHOULD return null.
  1131. *
  1132. * @return null|int The URI port.
  1133. */
  1134. public function getPort();
  1135. /**
  1136. * Retrieve the path component of the URI.
  1137. *
  1138. * The path can either be empty or absolute (starting with a slash) or
  1139. * rootless (not starting with a slash). Implementations MUST support all
  1140. * three syntaxes.
  1141. *
  1142. * Normally, the empty path "" and absolute path "/" are considered equal as
  1143. * defined in RFC 7230 Section 2.7.3. But this method MUST NOT automatically
  1144. * do this normalization because in contexts with a trimmed base path, e.g.
  1145. * the front controller, this difference becomes significant. It's the task
  1146. * of the user to handle both "" and "/".
  1147. *
  1148. * The value returned MUST be percent-encoded, but MUST NOT double-encode
  1149. * any characters. To determine what characters to encode, please refer to
  1150. * RFC 3986, Sections 2 and 3.3.
  1151. *
  1152. * As an example, if the value should include a slash ("/") not intended as
  1153. * delimiter between path segments, that value MUST be passed in encoded
  1154. * form (e.g., "%2F") to the instance.
  1155. *
  1156. * @see https://tools.ietf.org/html/rfc3986#section-2
  1157. * @see https://tools.ietf.org/html/rfc3986#section-3.3
  1158. * @return string The URI path.
  1159. */
  1160. public function getPath();
  1161. /**
  1162. * Retrieve the query string of the URI.
  1163. *
  1164. * If no query string is present, this method MUST return an empty string.
  1165. *
  1166. * The leading "?" character is not part of the query and MUST NOT be
  1167. * added.
  1168. *
  1169. * The value returned MUST be percent-encoded, but MUST NOT double-encode
  1170. * any characters. To determine what characters to encode, please refer to
  1171. * RFC 3986, Sections 2 and 3.4.
  1172. *
  1173. * As an example, if a value in a key/value pair of the query string should
  1174. * include an ampersand ("&") not intended as a delimiter between values,
  1175. * that value MUST be passed in encoded form (e.g., "%26") to the instance.
  1176. *
  1177. * @see https://tools.ietf.org/html/rfc3986#section-2
  1178. * @see https://tools.ietf.org/html/rfc3986#section-3.4
  1179. * @return string The URI query string.
  1180. */
  1181. public function getQuery();
  1182. /**
  1183. * Retrieve the fragment component of the URI.
  1184. *
  1185. * If no fragment is present, this method MUST return an empty string.
  1186. *
  1187. * The leading "#" character is not part of the fragment and MUST NOT be
  1188. * added.
  1189. *
  1190. * The value returned MUST be percent-encoded, but MUST NOT double-encode
  1191. * any characters. To determine what characters to encode, please refer to
  1192. * RFC 3986, Sections 2 and 3.5.
  1193. *
  1194. * @see https://tools.ietf.org/html/rfc3986#section-2
  1195. * @see https://tools.ietf.org/html/rfc3986#section-3.5
  1196. * @return string The URI fragment.
  1197. */
  1198. public function getFragment();
  1199. /**
  1200. * Return an instance with the specified scheme.
  1201. *
  1202. * This method MUST retain the state of the current instance, and return
  1203. * an instance that contains the specified scheme.
  1204. *
  1205. * Implementations MUST support the schemes "http" and "https" case
  1206. * insensitively, and MAY accommodate other schemes if required.
  1207. *
  1208. * An empty scheme is equivalent to removing the scheme.
  1209. *
  1210. * @param string $scheme The scheme to use with the new instance.
  1211. * @return static A new instance with the specified scheme.
  1212. * @throws \InvalidArgumentException for invalid or unsupported schemes.
  1213. */
  1214. public function withScheme($scheme);
  1215. /**
  1216. * Return an instance with the specified user information.
  1217. *
  1218. * This method MUST retain the state of the current instance, and return
  1219. * an instance that contains the specified user information.
  1220. *
  1221. * Password is optional, but the user information MUST include the
  1222. * user; an empty string for the user is equivalent to removing user
  1223. * information.
  1224. *
  1225. * @param string $user The user name to use for authority.
  1226. * @param null|string $password The password associated with $user.
  1227. * @return static A new instance with the specified user information.
  1228. */
  1229. public function withUserInfo($user, $password = null);
  1230. /**
  1231. * Return an instance with the specified host.
  1232. *
  1233. * This method MUST retain the state of the current instance, and return
  1234. * an instance that contains the specified host.
  1235. *
  1236. * An empty host value is equivalent to removing the host.
  1237. *
  1238. * @param string $host The hostname to use with the new instance.
  1239. * @return static A new instance with the specified host.
  1240. * @throws \InvalidArgumentException for invalid hostnames.
  1241. */
  1242. public function withHost($host);
  1243. /**
  1244. * Return an instance with the specified port.
  1245. *
  1246. * This method MUST retain the state of the current instance, and return
  1247. * an instance that contains the specified port.
  1248. *
  1249. * Implementations MUST raise an exception for ports outside the
  1250. * established TCP and UDP port ranges.
  1251. *
  1252. * A null value provided for the port is equivalent to removing the port
  1253. * information.
  1254. *
  1255. * @param null|int $port The port to use with the new instance; a null value
  1256. * removes the port information.
  1257. * @return static A new instance with the specified port.
  1258. * @throws \InvalidArgumentException for invalid ports.
  1259. */
  1260. public function withPort($port);
  1261. /**
  1262. * Return an instance with the specified path.
  1263. *
  1264. * This method MUST retain the state of the current instance, and return
  1265. * an instance that contains the specified path.
  1266. *
  1267. * The path can either be empty or absolute (starting with a slash) or
  1268. * rootless (not starting with a slash). Implementations MUST support all
  1269. * three syntaxes.
  1270. *
  1271. * If the path is intended to be domain-relative rather than path relative then
  1272. * it must begin with a slash ("/"). Paths not starting with a slash ("/")
  1273. * are assumed to be relative to some base path known to the application or
  1274. * consumer.
  1275. *
  1276. * Users can provide both encoded and decoded path characters.
  1277. * Implementations ensure the correct encoding as outlined in getPath().
  1278. *
  1279. * @param string $path The path to use with the new instance.
  1280. * @return static A new instance with the specified path.
  1281. * @throws \InvalidArgumentException for invalid paths.
  1282. */
  1283. public function withPath($path);
  1284. /**
  1285. * Return an instance with the specified query string.
  1286. *
  1287. * This method MUST retain the state of the current instance, and return
  1288. * an instance that contains the specified query string.
  1289. *
  1290. * Users can provide both encoded and decoded query characters.
  1291. * Implementations ensure the correct encoding as outlined in getQuery().
  1292. *
  1293. * An empty query string value is equivalent to removing the query string.
  1294. *
  1295. * @param string $query The query string to use with the new instance.
  1296. * @return static A new instance with the specified query string.
  1297. * @throws \InvalidArgumentException for invalid query strings.
  1298. */
  1299. public function withQuery($query);
  1300. /**
  1301. * Return an instance with the specified URI fragment.
  1302. *
  1303. * This method MUST retain the state of the current instance, and return
  1304. * an instance that contains the specified URI fragment.
  1305. *
  1306. * Users can provide both encoded and decoded fragment characters.
  1307. * Implementations ensure the correct encoding as outlined in getFragment().
  1308. *
  1309. * An empty fragment value is equivalent to removing the fragment.
  1310. *
  1311. * @param string $fragment The fragment to use with the new instance.
  1312. * @return static A new instance with the specified fragment.
  1313. */
  1314. public function withFragment($fragment);
  1315. /**
  1316. * Return the string representation as a URI reference.
  1317. *
  1318. * Depending on which components of the URI are present, the resulting
  1319. * string is either a full URI or relative reference according to RFC 3986,
  1320. * Section 4.1. The method concatenates the various components of the URI,
  1321. * using the appropriate delimiters:
  1322. *
  1323. * - If a scheme is present, it MUST be suffixed by ":".
  1324. * - If an authority is present, it MUST be prefixed by "//".
  1325. * - The path can be concatenated without delimiters. But there are two
  1326. * cases where the path has to be adjusted to make the URI reference
  1327. * valid as PHP does not allow to throw an exception in __toString():
  1328. * - If the path is rootless and an authority is present, the path MUST
  1329. * be prefixed by "/".
  1330. * - If the path is starting with more than one "/" and no authority is
  1331. * present, the starting slashes MUST be reduced to one.
  1332. * - If a query is present, it MUST be prefixed by "?".
  1333. * - If a fragment is present, it MUST be prefixed by "#".
  1334. *
  1335. * @see http://tools.ietf.org/html/rfc3986#section-4.1
  1336. * @return string
  1337. */
  1338. public function __toString();
  1339. }
  1340. }
  1341. // file: vendor/psr/http-server-handler/src/RequestHandlerInterface.php
  1342. namespace Psr\Http\Server {
  1343. use Psr\Http\Message\ResponseInterface;
  1344. use Psr\Http\Message\ServerRequestInterface;
  1345. /**
  1346. * Handles a server request and produces a response.
  1347. *
  1348. * An HTTP request handler process an HTTP request in order to produce an
  1349. * HTTP response.
  1350. */
  1351. interface RequestHandlerInterface
  1352. {
  1353. /**
  1354. * Handles a request and produces a response.
  1355. *
  1356. * May call other collaborating code to generate the response.
  1357. */
  1358. public function handle(ServerRequestInterface $request): ResponseInterface;
  1359. }
  1360. }
  1361. // file: vendor/psr/http-server-middleware/src/MiddlewareInterface.php
  1362. namespace Psr\Http\Server {
  1363. use Psr\Http\Message\ResponseInterface;
  1364. use Psr\Http\Message\ServerRequestInterface;
  1365. /**
  1366. * Participant in processing a server request and response.
  1367. *
  1368. * An HTTP middleware component participates in processing an HTTP message:
  1369. * by acting on the request, generating the response, or forwarding the
  1370. * request to a subsequent middleware and possibly acting on its response.
  1371. */
  1372. interface MiddlewareInterface
  1373. {
  1374. /**
  1375. * Process an incoming server request.
  1376. *
  1377. * Processes an incoming server request in order to produce a response.
  1378. * If unable to produce the response itself, it may delegate to the provided
  1379. * request handler to do so.
  1380. */
  1381. public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface;
  1382. }
  1383. }
  1384. // file: vendor/nyholm/psr7/src/Factory/Psr17Factory.php
  1385. namespace Nyholm\Psr7\Factory {
  1386. use Nyholm\Psr7\{Request, Response, ServerRequest, Stream, UploadedFile, Uri};
  1387. use Psr\Http\Message\{RequestFactoryInterface, RequestInterface, ResponseFactoryInterface, ResponseInterface, ServerRequestFactoryInterface, ServerRequestInterface, StreamFactoryInterface, StreamInterface, UploadedFileFactoryInterface, UploadedFileInterface, UriFactoryInterface, UriInterface};
  1388. /**
  1389. * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  1390. * @author Martijn van der Ven <martijn@vanderven.se>
  1391. */
  1392. final class Psr17Factory implements RequestFactoryInterface, ResponseFactoryInterface, ServerRequestFactoryInterface, StreamFactoryInterface, UploadedFileFactoryInterface, UriFactoryInterface
  1393. {
  1394. public function createRequest(string $method, $uri): RequestInterface
  1395. {
  1396. return new Request($method, $uri);
  1397. }
  1398. public function createResponse(int $code = 200, string $reasonPhrase = ''): ResponseInterface
  1399. {
  1400. if (2 > \func_num_args()) {
  1401. // This will make the Response class to use a custom reasonPhrase
  1402. $reasonPhrase = null;
  1403. }
  1404. return new Response($code, [], null, '1.1', $reasonPhrase);
  1405. }
  1406. public function createStream(string $content = ''): StreamInterface
  1407. {
  1408. return Stream::create($content);
  1409. }
  1410. public function createStreamFromFile(string $filename, string $mode = 'r'): StreamInterface
  1411. {
  1412. $resource = @\fopen($filename, $mode);
  1413. if (false === $resource) {
  1414. if ('' === $mode || false === \in_array($mode[0], ['r', 'w', 'a', 'x', 'c'])) {
  1415. throw new \InvalidArgumentException('The mode ' . $mode . ' is invalid.');
  1416. }
  1417. throw new \RuntimeException('The file ' . $filename . ' cannot be opened.');
  1418. }
  1419. return Stream::create($resource);
  1420. }
  1421. public function createStreamFromResource($resource): StreamInterface
  1422. {
  1423. return Stream::create($resource);
  1424. }
  1425. public function createUploadedFile(StreamInterface $stream, int $size = null, int $error = \UPLOAD_ERR_OK, string $clientFilename = null, string $clientMediaType = null): UploadedFileInterface
  1426. {
  1427. if (null === $size) {
  1428. $size = $stream->getSize();
  1429. }
  1430. return new UploadedFile($stream, $size, $error, $clientFilename, $clientMediaType);
  1431. }
  1432. public function createUri(string $uri = ''): UriInterface
  1433. {
  1434. return new Uri($uri);
  1435. }
  1436. public function createServerRequest(string $method, $uri, array $serverParams = []): ServerRequestInterface
  1437. {
  1438. return new ServerRequest($method, $uri, [], null, '1.1', $serverParams);
  1439. }
  1440. }
  1441. }
  1442. // file: vendor/nyholm/psr7/src/MessageTrait.php
  1443. namespace Nyholm\Psr7 {
  1444. use Psr\Http\Message\StreamInterface;
  1445. /**
  1446. * Trait implementing functionality common to requests and responses.
  1447. *
  1448. * @author Michael Dowling and contributors to guzzlehttp/psr7
  1449. * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  1450. * @author Martijn van der Ven <martijn@vanderven.se>
  1451. *
  1452. * @internal should not be used outside of Nyholm/Psr7 as it does not fall under our BC promise
  1453. */
  1454. trait MessageTrait
  1455. {
  1456. /** @var array Map of all registered headers, as original name => array of values */
  1457. private $headers = [];
  1458. /** @var array Map of lowercase header name => original name at registration */
  1459. private $headerNames = [];
  1460. /** @var string */
  1461. private $protocol = '1.1';
  1462. /** @var StreamInterface|null */
  1463. private $stream;
  1464. public function getProtocolVersion(): string
  1465. {
  1466. return $this->protocol;
  1467. }
  1468. public function withProtocolVersion($version): self
  1469. {
  1470. if ($this->protocol === $version) {
  1471. return $this;
  1472. }
  1473. $new = clone $this;
  1474. $new->protocol = $version;
  1475. return $new;
  1476. }
  1477. public function getHeaders(): array
  1478. {
  1479. return $this->headers;
  1480. }
  1481. public function hasHeader($header): bool
  1482. {
  1483. return isset($this->headerNames[\strtolower($header)]);
  1484. }
  1485. public function getHeader($header): array
  1486. {
  1487. $header = \strtolower($header);
  1488. if (!isset($this->headerNames[$header])) {
  1489. return [];
  1490. }
  1491. $header = $this->headerNames[$header];
  1492. return $this->headers[$header];
  1493. }
  1494. public function getHeaderLine($header): string
  1495. {
  1496. return \implode(', ', $this->getHeader($header));
  1497. }
  1498. public function withHeader($header, $value): self
  1499. {
  1500. $value = $this->validateAndTrimHeader($header, $value);
  1501. $normalized = \strtolower($header);
  1502. $new = clone $this;
  1503. if (isset($new->headerNames[$normalized])) {
  1504. unset($new->headers[$new->headerNames[$normalized]]);
  1505. }
  1506. $new->headerNames[$normalized] = $header;
  1507. $new->headers[$header] = $value;
  1508. return $new;
  1509. }
  1510. public function withAddedHeader($header, $value): self
  1511. {
  1512. if (!\is_string($header) || '' === $header) {
  1513. throw new \InvalidArgumentException('Header name must be an RFC 7230 compatible string.');
  1514. }
  1515. $new = clone $this;
  1516. $new->setHeaders([$header => $value]);
  1517. return $new;
  1518. }
  1519. public function withoutHeader($header): self
  1520. {
  1521. $normalized = \strtolower($header);
  1522. if (!isset($this->headerNames[$normalized])) {
  1523. return $this;
  1524. }
  1525. $header = $this->headerNames[$normalized];
  1526. $new = clone $this;
  1527. unset($new->headers[$header], $new->headerNames[$normalized]);
  1528. return $new;
  1529. }
  1530. public function getBody(): StreamInterface
  1531. {
  1532. if (null === $this->stream) {
  1533. $this->stream = Stream::create('');
  1534. }
  1535. return $this->stream;
  1536. }
  1537. public function withBody(StreamInterface $body): self
  1538. {
  1539. if ($body === $this->stream) {
  1540. return $this;
  1541. }
  1542. $new = clone $this;
  1543. $new->stream = $body;
  1544. return $new;
  1545. }
  1546. private function setHeaders(array $headers) /*:void*/
  1547. {
  1548. foreach ($headers as $header => $value) {
  1549. $value = $this->validateAndTrimHeader($header, $value);
  1550. $normalized = \strtolower($header);
  1551. if (isset($this->headerNames[$normalized])) {
  1552. $header = $this->headerNames[$normalized];
  1553. $this->headers[$header] = \array_merge($this->headers[$header], $value);
  1554. } else {
  1555. $this->headerNames[$normalized] = $header;
  1556. $this->headers[$header] = $value;
  1557. }
  1558. }
  1559. }
  1560. /**
  1561. * Make sure the header complies with RFC 7230.
  1562. *
  1563. * Header names must be a non-empty string consisting of token characters.
  1564. *
  1565. * Header values must be strings consisting of visible characters with all optional
  1566. * leading and trailing whitespace stripped. This method will always strip such
  1567. * optional whitespace. Note that the method does not allow folding whitespace within
  1568. * the values as this was deprecated for almost all instances by the RFC.
  1569. *
  1570. * header-field = field-name ":" OWS field-value OWS
  1571. * field-name = 1*( "!" / "#" / "$" / "%" / "&" / "'" / "*" / "+" / "-" / "." / "^"
  1572. * / "_" / "`" / "|" / "~" / %x30-39 / ( %x41-5A / %x61-7A ) )
  1573. * OWS = *( SP / HTAB )
  1574. * field-value = *( ( %x21-7E / %x80-FF ) [ 1*( SP / HTAB ) ( %x21-7E / %x80-FF ) ] )
  1575. *
  1576. * @see https://tools.ietf.org/html/rfc7230#section-3.2.4
  1577. */
  1578. private function validateAndTrimHeader($header, $values): array
  1579. {
  1580. if (!\is_string($header) || 1 !== \preg_match("@^[!#$%&'*+.^_`|~0-9A-Za-z-]+$@", $header)) {
  1581. throw new \InvalidArgumentException('Header name must be an RFC 7230 compatible string.');
  1582. }
  1583. if (!\is_array($values)) {
  1584. // This is simple, just one value.
  1585. if ((!\is_numeric($values) && !\is_string($values)) || 1 !== \preg_match("@^[ \t\x21-\x7E\x80-\xFF]*$@", (string) $values)) {
  1586. throw new \InvalidArgumentException('Header values must be RFC 7230 compatible strings.');
  1587. }
  1588. return [\trim((string) $values, " \t")];
  1589. }
  1590. if (empty($values)) {
  1591. throw new \InvalidArgumentException('Header values must be a string or an array of strings, empty array given.');
  1592. }
  1593. // Assert Non empty array
  1594. $returnValues = [];
  1595. foreach ($values as $v) {
  1596. if ((!\is_numeric($v) && !\is_string($v)) || 1 !== \preg_match("@^[ \t\x21-\x7E\x80-\xFF]*$@", (string) $v)) {
  1597. throw new \InvalidArgumentException('Header values must be RFC 7230 compatible strings.');
  1598. }
  1599. $returnValues[] = \trim((string) $v, " \t");
  1600. }
  1601. return $returnValues;
  1602. }
  1603. }
  1604. }
  1605. // file: vendor/nyholm/psr7/src/Request.php
  1606. namespace Nyholm\Psr7 {
  1607. use Psr\Http\Message\{RequestInterface, StreamInterface, UriInterface};
  1608. /**
  1609. * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  1610. * @author Martijn van der Ven <martijn@vanderven.se>
  1611. */
  1612. final class Request implements RequestInterface
  1613. {
  1614. use MessageTrait;
  1615. use RequestTrait;
  1616. /**
  1617. * @param string $method HTTP method
  1618. * @param string|UriInterface $uri URI
  1619. * @param array $headers Request headers
  1620. * @param string|resource|StreamInterface|null $body Request body
  1621. * @param string $version Protocol version
  1622. */
  1623. public function __construct(string $method, $uri, array $headers = [], $body = null, string $version = '1.1')
  1624. {
  1625. if (!($uri instanceof UriInterface)) {
  1626. $uri = new Uri($uri);
  1627. }
  1628. $this->method = $method;
  1629. $this->uri = $uri;
  1630. $this->setHeaders($headers);
  1631. $this->protocol = $version;
  1632. if (!$this->hasHeader('Host')) {
  1633. $this->updateHostFromUri();
  1634. }
  1635. // If we got no body, defer initialization of the stream until Request::getBody()
  1636. if ('' !== $body && null !== $body) {
  1637. $this->stream = Stream::create($body);
  1638. }
  1639. }
  1640. }
  1641. }
  1642. // file: vendor/nyholm/psr7/src/RequestTrait.php
  1643. namespace Nyholm\Psr7 {
  1644. use Psr\Http\Message\UriInterface;
  1645. /**
  1646. * @author Michael Dowling and contributors to guzzlehttp/psr7
  1647. * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  1648. * @author Martijn van der Ven <martijn@vanderven.se>
  1649. *
  1650. * @internal should not be used outside of Nyholm/Psr7 as it does not fall under our BC promise
  1651. */
  1652. trait RequestTrait
  1653. {
  1654. /** @var string */
  1655. private $method;
  1656. /** @var string|null */
  1657. private $requestTarget;
  1658. /** @var UriInterface|null */
  1659. private $uri;
  1660. public function getRequestTarget(): string
  1661. {
  1662. if (null !== $this->requestTarget) {
  1663. return $this->requestTarget;
  1664. }
  1665. if ('' === $target = $this->uri->getPath()) {
  1666. $target = '/';
  1667. }
  1668. if ('' !== $this->uri->getQuery()) {
  1669. $target .= '?' . $this->uri->getQuery();
  1670. }
  1671. return $target;
  1672. }
  1673. public function withRequestTarget($requestTarget): self
  1674. {
  1675. if (\preg_match('#\s#', $requestTarget)) {
  1676. throw new \InvalidArgumentException('Invalid request target provided; cannot contain whitespace');
  1677. }
  1678. $new = clone $this;
  1679. $new->requestTarget = $requestTarget;
  1680. return $new;
  1681. }
  1682. public function getMethod(): string
  1683. {
  1684. return $this->method;
  1685. }
  1686. public function withMethod($method): self
  1687. {
  1688. if (!\is_string($method)) {
  1689. throw new \InvalidArgumentException('Method must be a string');
  1690. }
  1691. $new = clone $this;
  1692. $new->method = $method;
  1693. return $new;
  1694. }
  1695. public function getUri(): UriInterface
  1696. {
  1697. return $this->uri;
  1698. }
  1699. public function withUri(UriInterface $uri, $preserveHost = false): self
  1700. {
  1701. if ($uri === $this->uri) {
  1702. return $this;
  1703. }
  1704. $new = clone $this;
  1705. $new->uri = $uri;
  1706. if (!$preserveHost || !$this->hasHeader('Host')) {
  1707. $new->updateHostFromUri();
  1708. }
  1709. return $new;
  1710. }
  1711. private function updateHostFromUri() /*:void*/
  1712. {
  1713. if ('' === $host = $this->uri->getHost()) {
  1714. return;
  1715. }
  1716. if (null !== ($port = $this->uri->getPort())) {
  1717. $host .= ':' . $port;
  1718. }
  1719. if (isset($this->headerNames['host'])) {
  1720. $header = $this->headerNames['host'];
  1721. } else {
  1722. $this->headerNames['host'] = $header = 'Host';
  1723. }
  1724. // Ensure Host is the first header.
  1725. // See: http://tools.ietf.org/html/rfc7230#section-5.4
  1726. $this->headers = [$header => [$host]] + $this->headers;
  1727. }
  1728. }
  1729. }
  1730. // file: vendor/nyholm/psr7/src/Response.php
  1731. namespace Nyholm\Psr7 {
  1732. use Psr\Http\Message\{ResponseInterface, StreamInterface};
  1733. /**
  1734. * @author Michael Dowling and contributors to guzzlehttp/psr7
  1735. * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  1736. * @author Martijn van der Ven <martijn@vanderven.se>
  1737. */
  1738. final class Response implements ResponseInterface
  1739. {
  1740. use MessageTrait;
  1741. /** @var array Map of standard HTTP status code/reason phrases */
  1742. /*private*/ const PHRASES = [
  1743. 100 => 'Continue', 101 => 'Switching Protocols', 102 => 'Processing',
  1744. 200 => 'OK', 201 => 'Created', 202 => 'Accepted', 203 => 'Non-Authoritative Information', 204 => 'No Content', 205 => 'Reset Content', 206 => 'Partial Content', 207 => 'Multi-status', 208 => 'Already Reported',
  1745. 300 => 'Multiple Choices', 301 => 'Moved Permanently', 302 => 'Found', 303 => 'See Other', 304 => 'Not Modified', 305 => 'Use Proxy', 306 => 'Switch Proxy', 307 => 'Temporary Redirect',
  1746. 400 => 'Bad Request', 401 => 'Unauthorized', 402 => 'Payment Required', 403 => 'Forbidden', 404 => 'Not Found', 405 => 'Method Not Allowed', 406 => 'Not Acceptable', 407 => 'Proxy Authentication Required', 408 => 'Request Time-out', 409 => 'Conflict', 410 => 'Gone', 411 => 'Length Required', 412 => 'Precondition Failed', 413 => 'Request Entity Too Large', 414 => 'Request-URI Too Large', 415 => 'Unsupported Media Type', 416 => 'Requested range not satisfiable', 417 => 'Expectation Failed', 418 => 'I\'m a teapot', 422 => 'Unprocessable Entity', 423 => 'Locked', 424 => 'Failed Dependency', 425 => 'Unordered Collection', 426 => 'Upgrade Required', 428 => 'Precondition Required', 429 => 'Too Many Requests', 431 => 'Request Header Fields Too Large', 451 => 'Unavailable For Legal Reasons',
  1747. 500 => 'Internal Server Error', 501 => 'Not Implemented', 502 => 'Bad Gateway', 503 => 'Service Unavailable', 504 => 'Gateway Time-out', 505 => 'HTTP Version not supported', 506 => 'Variant Also Negotiates', 507 => 'Insufficient Storage', 508 => 'Loop Detected', 511 => 'Network Authentication Required',
  1748. ];
  1749. /** @var string */
  1750. private $reasonPhrase = '';
  1751. /** @var int */
  1752. private $statusCode;
  1753. /**
  1754. * @param int $status Status code
  1755. * @param array $headers Response headers
  1756. * @param string|resource|StreamInterface|null $body Response body
  1757. * @param string $version Protocol version
  1758. * @param string|null $reason Reason phrase (when empty a default will be used based on the status code)
  1759. */
  1760. public function __construct(int $status = 200, array $headers = [], $body = null, string $version = '1.1', string $reason = null)
  1761. {
  1762. // If we got no body, defer initialization of the stream until Response::getBody()
  1763. if ('' !== $body && null !== $body) {
  1764. $this->stream = Stream::create($body);
  1765. }
  1766. $this->statusCode = $status;
  1767. $this->setHeaders($headers);
  1768. if (null === $reason && isset(self::PHRASES[$this->statusCode])) {
  1769. $this->reasonPhrase = self::PHRASES[$status];
  1770. } else {
  1771. $this->reasonPhrase = $reason ?? '';
  1772. }
  1773. $this->protocol = $version;
  1774. }
  1775. public function getStatusCode(): int
  1776. {
  1777. return $this->statusCode;
  1778. }
  1779. public function getReasonPhrase(): string
  1780. {
  1781. return $this->reasonPhrase;
  1782. }
  1783. public function withStatus($code, $reasonPhrase = ''): self
  1784. {
  1785. if (!\is_int($code) && !\is_string($code)) {
  1786. throw new \InvalidArgumentException('Status code has to be an integer');
  1787. }
  1788. $code = (int) $code;
  1789. if ($code < 100 || $code > 599) {
  1790. throw new \InvalidArgumentException('Status code has to be an integer between 100 and 599');
  1791. }
  1792. $new = clone $this;
  1793. $new->statusCode = $code;
  1794. if ((null === $reasonPhrase || '' === $reasonPhrase) && isset(self::PHRASES[$new->statusCode])) {
  1795. $reasonPhrase = self::PHRASES[$new->statusCode];
  1796. }
  1797. $new->reasonPhrase = $reasonPhrase;
  1798. return $new;
  1799. }
  1800. }
  1801. }
  1802. // file: vendor/nyholm/psr7/src/ServerRequest.php
  1803. namespace Nyholm\Psr7 {
  1804. use Psr\Http\Message\{ServerRequestInterface, StreamInterface, UploadedFileInterface, UriInterface};
  1805. /**
  1806. * @author Michael Dowling and contributors to guzzlehttp/psr7
  1807. * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  1808. * @author Martijn van der Ven <martijn@vanderven.se>
  1809. */
  1810. final class ServerRequest implements ServerRequestInterface
  1811. {
  1812. use MessageTrait;
  1813. use RequestTrait;
  1814. /** @var array */
  1815. private $attributes = [];
  1816. /** @var array */
  1817. private $cookieParams = [];
  1818. /** @var array|object|null */
  1819. private $parsedBody;
  1820. /** @var array */
  1821. private $queryParams = [];
  1822. /** @var array */
  1823. private $serverParams;
  1824. /** @var UploadedFileInterface[] */
  1825. private $uploadedFiles = [];
  1826. /**
  1827. * @param string $method HTTP method
  1828. * @param string|UriInterface $uri URI
  1829. * @param array $headers Request headers
  1830. * @param string|resource|StreamInterface|null $body Request body
  1831. * @param string $version Protocol version
  1832. * @param array $serverParams Typically the $_SERVER superglobal
  1833. */
  1834. public function __construct(string $method, $uri, array $headers = [], $body = null, string $version = '1.1', array $serverParams = [])
  1835. {
  1836. $this->serverParams = $serverParams;
  1837. if (!($uri instanceof UriInterface)) {
  1838. $uri = new Uri($uri);
  1839. }
  1840. $this->method = $method;
  1841. $this->uri = $uri;
  1842. $this->setHeaders($headers);
  1843. $this->protocol = $version;
  1844. if (!$this->hasHeader('Host')) {
  1845. $this->updateHostFromUri();
  1846. }
  1847. // If we got no body, defer initialization of the stream until ServerRequest::getBody()
  1848. if ('' !== $body && null !== $body) {
  1849. $this->stream = Stream::create($body);
  1850. }
  1851. }
  1852. public function getServerParams(): array
  1853. {
  1854. return $this->serverParams;
  1855. }
  1856. public function getUploadedFiles(): array
  1857. {
  1858. return $this->uploadedFiles;
  1859. }
  1860. public function withUploadedFiles(array $uploadedFiles)
  1861. {
  1862. $new = clone $this;
  1863. $new->uploadedFiles = $uploadedFiles;
  1864. return $new;
  1865. }
  1866. public function getCookieParams(): array
  1867. {
  1868. return $this->cookieParams;
  1869. }
  1870. public function withCookieParams(array $cookies)
  1871. {
  1872. $new = clone $this;
  1873. $new->cookieParams = $cookies;
  1874. return $new;
  1875. }
  1876. public function getQueryParams(): array
  1877. {
  1878. return $this->queryParams;
  1879. }
  1880. public function withQueryParams(array $query)
  1881. {
  1882. $new = clone $this;
  1883. $new->queryParams = $query;
  1884. return $new;
  1885. }
  1886. public function getParsedBody()
  1887. {
  1888. return $this->parsedBody;
  1889. }
  1890. public function withParsedBody($data)
  1891. {
  1892. if (!\is_array($data) && !\is_object($data) && null !== $data) {
  1893. throw new \InvalidArgumentException('First parameter to withParsedBody MUST be object, array or null');
  1894. }
  1895. $new = clone $this;
  1896. $new->parsedBody = $data;
  1897. return $new;
  1898. }
  1899. public function getAttributes(): array
  1900. {
  1901. return $this->attributes;
  1902. }
  1903. public function getAttribute($attribute, $default = null)
  1904. {
  1905. if (false === \array_key_exists($attribute, $this->attributes)) {
  1906. return $default;
  1907. }
  1908. return $this->attributes[$attribute];
  1909. }
  1910. public function withAttribute($attribute, $value): self
  1911. {
  1912. $new = clone $this;
  1913. $new->attributes[$attribute] = $value;
  1914. return $new;
  1915. }
  1916. public function withoutAttribute($attribute): self
  1917. {
  1918. if (false === \array_key_exists($attribute, $this->attributes)) {
  1919. return $this;
  1920. }
  1921. $new = clone $this;
  1922. unset($new->attributes[$attribute]);
  1923. return $new;
  1924. }
  1925. }
  1926. }
  1927. // file: vendor/nyholm/psr7/src/Stream.php
  1928. namespace Nyholm\Psr7 {
  1929. use Psr\Http\Message\StreamInterface;
  1930. /**
  1931. * @author Michael Dowling and contributors to guzzlehttp/psr7
  1932. * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  1933. * @author Martijn van der Ven <martijn@vanderven.se>
  1934. */
  1935. final class Stream implements StreamInterface
  1936. {
  1937. /** @var resource|null A resource reference */
  1938. private $stream;
  1939. /** @var bool */
  1940. private $seekable;
  1941. /** @var bool */
  1942. private $readable;
  1943. /** @var bool */
  1944. private $writable;
  1945. /** @var array|mixed|void|null */
  1946. private $uri;
  1947. /** @var int|null */
  1948. private $size;
  1949. /** @var array Hash of readable and writable stream types */
  1950. /*private*/ const READ_WRITE_HASH = [
  1951. 'read' => [
  1952. 'r' => true, 'w+' => true, 'r+' => true, 'x+' => true, 'c+' => true,
  1953. 'rb' => true, 'w+b' => true, 'r+b' => true, 'x+b' => true,
  1954. 'c+b' => true, 'rt' => true, 'w+t' => true, 'r+t' => true,
  1955. 'x+t' => true, 'c+t' => true, 'a+' => true,
  1956. ],
  1957. 'write' => [
  1958. 'w' => true, 'w+' => true, 'rw' => true, 'r+' => true, 'x+' => true,
  1959. 'c+' => true, 'wb' => true, 'w+b' => true, 'r+b' => true,
  1960. 'x+b' => true, 'c+b' => true, 'w+t' => true, 'r+t' => true,
  1961. 'x+t' => true, 'c+t' => true, 'a' => true, 'a+' => true,
  1962. ],
  1963. ];
  1964. private function __construct()
  1965. {
  1966. }
  1967. /**
  1968. * Creates a new PSR-7 stream.
  1969. *
  1970. * @param string|resource|StreamInterface $body
  1971. *
  1972. * @return StreamInterface
  1973. *
  1974. * @throws \InvalidArgumentException
  1975. */
  1976. public static function create($body = ''): StreamInterface
  1977. {
  1978. if ($body instanceof StreamInterface) {
  1979. return $body;
  1980. }
  1981. if (\is_string($body)) {
  1982. $resource = \fopen('php://temp', 'rw+');
  1983. \fwrite($resource, $body);
  1984. $body = $resource;
  1985. }
  1986. if (\is_resource($body)) {
  1987. $new = new self();
  1988. $new->stream = $body;
  1989. $meta = \stream_get_meta_data($new->stream);
  1990. $new->seekable = $meta['seekable'] && 0 === \fseek($new->stream, 0, \SEEK_CUR);
  1991. $new->readable = isset(self::READ_WRITE_HASH['read'][$meta['mode']]);
  1992. $new->writable = isset(self::READ_WRITE_HASH['write'][$meta['mode']]);
  1993. $new->uri = $new->getMetadata('uri');
  1994. return $new;
  1995. }
  1996. throw new \InvalidArgumentException('First argument to Stream::create() must be a string, resource or StreamInterface.');
  1997. }
  1998. /**
  1999. * Closes the stream when the destructed.
  2000. */
  2001. public function __destruct()
  2002. {
  2003. $this->close();
  2004. }
  2005. public function __toString(): string
  2006. {
  2007. try {
  2008. if ($this->isSeekable()) {
  2009. $this->seek(0);
  2010. }
  2011. return $this->getContents();
  2012. } catch (\Exception $e) {
  2013. return '';
  2014. }
  2015. }
  2016. public function close() /*:void*/
  2017. {
  2018. if (isset($this->stream)) {
  2019. if (\is_resource($this->stream)) {
  2020. \fclose($this->stream);
  2021. }
  2022. $this->detach();
  2023. }
  2024. }
  2025. public function detach()
  2026. {
  2027. if (!isset($this->stream)) {
  2028. return null;
  2029. }
  2030. $result = $this->stream;
  2031. unset($this->stream);
  2032. $this->size = $this->uri = null;
  2033. $this->readable = $this->writable = $this->seekable = false;
  2034. return $result;
  2035. }
  2036. public function getSize() /*:?int*/
  2037. {
  2038. if (null !== $this->size) {
  2039. return $this->size;
  2040. }
  2041. if (!isset($this->stream)) {
  2042. return null;
  2043. }
  2044. // Clear the stat cache if the stream has a URI
  2045. if ($this->uri) {
  2046. \clearstatcache(true, $this->uri);
  2047. }
  2048. $stats = \fstat($this->stream);
  2049. if (isset($stats['size'])) {
  2050. $this->size = $stats['size'];
  2051. return $this->size;
  2052. }
  2053. return null;
  2054. }
  2055. public function tell(): int
  2056. {
  2057. if (false === $result = \ftell($this->stream)) {
  2058. throw new \RuntimeException('Unable to determine stream position');
  2059. }
  2060. return $result;
  2061. }
  2062. public function eof(): bool
  2063. {
  2064. return !$this->stream || \feof($this->stream);
  2065. }
  2066. public function isSeekable(): bool
  2067. {
  2068. return $this->seekable;
  2069. }
  2070. public function seek($offset, $whence = \SEEK_SET) /*:void*/
  2071. {
  2072. if (!$this->seekable) {
  2073. throw new \RuntimeException('Stream is not seekable');
  2074. }
  2075. if (-1 === \fseek($this->stream, $offset, $whence)) {
  2076. throw new \RuntimeException('Unable to seek to stream position ' . $offset . ' with whence ' . \var_export($whence, true));
  2077. }
  2078. }
  2079. public function rewind() /*:void*/
  2080. {
  2081. $this->seek(0);
  2082. }
  2083. public function isWritable(): bool
  2084. {
  2085. return $this->writable;
  2086. }
  2087. public function write($string): int
  2088. {
  2089. if (!$this->writable) {
  2090. throw new \RuntimeException('Cannot write to a non-writable stream');
  2091. }
  2092. // We can't know the size after writing anything
  2093. $this->size = null;
  2094. if (false === $result = \fwrite($this->stream, $string)) {
  2095. throw new \RuntimeException('Unable to write to stream');
  2096. }
  2097. return $result;
  2098. }
  2099. public function isReadable(): bool
  2100. {
  2101. return $this->readable;
  2102. }
  2103. public function read($length): string
  2104. {
  2105. if (!$this->readable) {
  2106. throw new \RuntimeException('Cannot read from non-readable stream');
  2107. }
  2108. return \fread($this->stream, $length);
  2109. }
  2110. public function getContents(): string
  2111. {
  2112. if (!isset($this->stream)) {
  2113. throw new \RuntimeException('Unable to read stream contents');
  2114. }
  2115. if (false === $contents = \stream_get_contents($this->stream)) {
  2116. throw new \RuntimeException('Unable to read stream contents');
  2117. }
  2118. return $contents;
  2119. }
  2120. public function getMetadata($key = null)
  2121. {
  2122. if (!isset($this->stream)) {
  2123. return $key ? null : [];
  2124. }
  2125. $meta = \stream_get_meta_data($this->stream);
  2126. if (null === $key) {
  2127. return $meta;
  2128. }
  2129. return $meta[$key] ?? null;
  2130. }
  2131. }
  2132. }
  2133. // file: vendor/nyholm/psr7/src/UploadedFile.php
  2134. namespace Nyholm\Psr7 {
  2135. use Psr\Http\Message\{StreamInterface, UploadedFileInterface};
  2136. /**
  2137. * @author Michael Dowling and contributors to guzzlehttp/psr7
  2138. * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  2139. * @author Martijn van der Ven <martijn@vanderven.se>
  2140. */
  2141. final class UploadedFile implements UploadedFileInterface
  2142. {
  2143. /** @var array */
  2144. /*private*/ const ERRORS = [
  2145. \UPLOAD_ERR_OK => 1,
  2146. \UPLOAD_ERR_INI_SIZE => 1,
  2147. \UPLOAD_ERR_FORM_SIZE => 1,
  2148. \UPLOAD_ERR_PARTIAL => 1,
  2149. \UPLOAD_ERR_NO_FILE => 1,
  2150. \UPLOAD_ERR_NO_TMP_DIR => 1,
  2151. \UPLOAD_ERR_CANT_WRITE => 1,
  2152. \UPLOAD_ERR_EXTENSION => 1,
  2153. ];
  2154. /** @var string */
  2155. private $clientFilename;
  2156. /** @var string */
  2157. private $clientMediaType;
  2158. /** @var int */
  2159. private $error;
  2160. /** @var string|null */
  2161. private $file;
  2162. /** @var bool */
  2163. private $moved = false;
  2164. /** @var int */
  2165. private $size;
  2166. /** @var StreamInterface|null */
  2167. private $stream;
  2168. /**
  2169. * @param StreamInterface|string|resource $streamOrFile
  2170. * @param int $size
  2171. * @param int $errorStatus
  2172. * @param string|null $clientFilename
  2173. * @param string|null $clientMediaType
  2174. */
  2175. public function __construct($streamOrFile, $size, $errorStatus, $clientFilename = null, $clientMediaType = null)
  2176. {
  2177. if (false === \is_int($errorStatus) || !isset(self::ERRORS[$errorStatus])) {
  2178. throw new \InvalidArgumentException('Upload file error status must be an integer value and one of the "UPLOAD_ERR_*" constants.');
  2179. }
  2180. if (false === \is_int($size)) {
  2181. throw new \InvalidArgumentException('Upload file size must be an integer');
  2182. }
  2183. if (null !== $clientFilename && !\is_string($clientFilename)) {
  2184. throw new \InvalidArgumentException('Upload file client filename must be a string or null');
  2185. }
  2186. if (null !== $clientMediaType && !\is_string($clientMediaType)) {
  2187. throw new \InvalidArgumentException('Upload file client media type must be a string or null');
  2188. }
  2189. $this->error = $errorStatus;
  2190. $this->size = $size;
  2191. $this->clientFilename = $clientFilename;
  2192. $this->clientMediaType = $clientMediaType;
  2193. if (\UPLOAD_ERR_OK === $this->error) {
  2194. // Depending on the value set file or stream variable.
  2195. if (\is_string($streamOrFile)) {
  2196. $this->file = $streamOrFile;
  2197. } elseif (\is_resource($streamOrFile)) {
  2198. $this->stream = Stream::create($streamOrFile);
  2199. } elseif ($streamOrFile instanceof StreamInterface) {
  2200. $this->stream = $streamOrFile;
  2201. } else {
  2202. throw new \InvalidArgumentException('Invalid stream or file provided for UploadedFile');
  2203. }
  2204. }
  2205. }
  2206. /**
  2207. * @throws \RuntimeException if is moved or not ok
  2208. */
  2209. private function validateActive() /*:void*/
  2210. {
  2211. if (\UPLOAD_ERR_OK !== $this->error) {
  2212. throw new \RuntimeException('Cannot retrieve stream due to upload error');
  2213. }
  2214. if ($this->moved) {
  2215. throw new \RuntimeException('Cannot retrieve stream after it has already been moved');
  2216. }
  2217. }
  2218. public function getStream(): StreamInterface
  2219. {
  2220. $this->validateActive();
  2221. if ($this->stream instanceof StreamInterface) {
  2222. return $this->stream;
  2223. }
  2224. $resource = \fopen($this->file, 'r');
  2225. return Stream::create($resource);
  2226. }
  2227. public function moveTo($targetPath) /*:void*/
  2228. {
  2229. $this->validateActive();
  2230. if (!\is_string($targetPath) || '' === $targetPath) {
  2231. throw new \InvalidArgumentException('Invalid path provided for move operation; must be a non-empty string');
  2232. }
  2233. if (null !== $this->file) {
  2234. $this->moved = 'cli' === \PHP_SAPI ? \rename($this->file, $targetPath) : \move_uploaded_file($this->file, $targetPath);
  2235. } else {
  2236. $stream = $this->getStream();
  2237. if ($stream->isSeekable()) {
  2238. $stream->rewind();
  2239. }
  2240. // Copy the contents of a stream into another stream until end-of-file.
  2241. $dest = Stream::create(\fopen($targetPath, 'w'));
  2242. while (!$stream->eof()) {
  2243. if (!$dest->write($stream->read(1048576))) {
  2244. break;
  2245. }
  2246. }
  2247. $this->moved = true;
  2248. }
  2249. if (false === $this->moved) {
  2250. throw new \RuntimeException(\sprintf('Uploaded file could not be moved to %s', $targetPath));
  2251. }
  2252. }
  2253. public function getSize(): int
  2254. {
  2255. return $this->size;
  2256. }
  2257. public function getError(): int
  2258. {
  2259. return $this->error;
  2260. }
  2261. public function getClientFilename() /*:?string*/
  2262. {
  2263. return $this->clientFilename;
  2264. }
  2265. public function getClientMediaType() /*:?string*/
  2266. {
  2267. return $this->clientMediaType;
  2268. }
  2269. }
  2270. }
  2271. // file: vendor/nyholm/psr7/src/Uri.php
  2272. namespace Nyholm\Psr7 {
  2273. use Psr\Http\Message\UriInterface;
  2274. /**
  2275. * PSR-7 URI implementation.
  2276. *
  2277. * @author Michael Dowling
  2278. * @author Tobias Schultze
  2279. * @author Matthew Weier O'Phinney
  2280. * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  2281. * @author Martijn van der Ven <martijn@vanderven.se>
  2282. */
  2283. final class Uri implements UriInterface
  2284. {
  2285. /*private*/ const SCHEMES = ['http' => 80, 'https' => 443];
  2286. /*private*/ const CHAR_UNRESERVED = 'a-zA-Z0-9_\-\.~';
  2287. /*private*/ const CHAR_SUB_DELIMS = '!\$&\'\(\)\*\+,;=';
  2288. /** @var string Uri scheme. */
  2289. private $scheme = '';
  2290. /** @var string Uri user info. */
  2291. private $userInfo = '';
  2292. /** @var string Uri host. */
  2293. private $host = '';
  2294. /** @var int|null Uri port. */
  2295. private $port;
  2296. /** @var string Uri path. */
  2297. private $path = '';
  2298. /** @var string Uri query string. */
  2299. private $query = '';
  2300. /** @var string Uri fragment. */
  2301. private $fragment = '';
  2302. public function __construct(string $uri = '')
  2303. {
  2304. if ('' !== $uri) {
  2305. if (false === $parts = \parse_url($uri)) {
  2306. throw new \InvalidArgumentException("Unable to parse URI: $uri");
  2307. }
  2308. // Apply parse_url parts to a URI.
  2309. $this->scheme = isset($parts['scheme']) ? \strtolower($parts['scheme']) : '';
  2310. $this->userInfo = $parts['user'] ?? '';
  2311. $this->host = isset($parts['host']) ? \strtolower($parts['host']) : '';
  2312. $this->port = isset($parts['port']) ? $this->filterPort($parts['port']) : null;
  2313. $this->path = isset($parts['path']) ? $this->filterPath($parts['path']) : '';
  2314. $this->query = isset($parts['query']) ? $this->filterQueryAndFragment($parts['query']) : '';
  2315. $this->fragment = isset($parts['fragment']) ? $this->filterQueryAndFragment($parts['fragment']) : '';
  2316. if (isset($parts['pass'])) {
  2317. $this->userInfo .= ':' . $parts['pass'];
  2318. }
  2319. }
  2320. }
  2321. public function __toString(): string
  2322. {
  2323. return self::createUriString($this->scheme, $this->getAuthority(), $this->path, $this->query, $this->fragment);
  2324. }
  2325. public function getScheme(): string
  2326. {
  2327. return $this->scheme;
  2328. }
  2329. public function getAuthority(): string
  2330. {
  2331. if ('' === $this->host) {
  2332. return '';
  2333. }
  2334. $authority = $this->host;
  2335. if ('' !== $this->userInfo) {
  2336. $authority = $this->userInfo . '@' . $authority;
  2337. }
  2338. if (null !== $this->port) {
  2339. $authority .= ':' . $this->port;
  2340. }
  2341. return $authority;
  2342. }
  2343. public function getUserInfo(): string
  2344. {
  2345. return $this->userInfo;
  2346. }
  2347. public function getHost(): string
  2348. {
  2349. return $this->host;
  2350. }
  2351. public function getPort() /*:?int*/
  2352. {
  2353. return $this->port;
  2354. }
  2355. public function getPath(): string
  2356. {
  2357. return $this->path;
  2358. }
  2359. public function getQuery(): string
  2360. {
  2361. return $this->query;
  2362. }
  2363. public function getFragment(): string
  2364. {
  2365. return $this->fragment;
  2366. }
  2367. public function withScheme($scheme): self
  2368. {
  2369. if (!\is_string($scheme)) {
  2370. throw new \InvalidArgumentException('Scheme must be a string');
  2371. }
  2372. if ($this->scheme === $scheme = \strtolower($scheme)) {
  2373. return $this;
  2374. }
  2375. $new = clone $this;
  2376. $new->scheme = $scheme;
  2377. $new->port = $new->filterPort($new->port);
  2378. return $new;
  2379. }
  2380. public function withUserInfo($user, $password = null): self
  2381. {
  2382. $info = $user;
  2383. if (null !== $password && '' !== $password) {
  2384. $info .= ':' . $password;
  2385. }
  2386. if ($this->userInfo === $info) {
  2387. return $this;
  2388. }
  2389. $new = clone $this;
  2390. $new->userInfo = $info;
  2391. return $new;
  2392. }
  2393. public function withHost($host): self
  2394. {
  2395. if (!\is_string($host)) {
  2396. throw new \InvalidArgumentException('Host must be a string');
  2397. }
  2398. if ($this->host === $host = \strtolower($host)) {
  2399. return $this;
  2400. }
  2401. $new = clone $this;
  2402. $new->host = $host;
  2403. return $new;
  2404. }
  2405. public function withPort($port): self
  2406. {
  2407. if ($this->port === $port = $this->filterPort($port)) {
  2408. return $this;
  2409. }
  2410. $new = clone $this;
  2411. $new->port = $port;
  2412. return $new;
  2413. }
  2414. public function withPath($path): self
  2415. {
  2416. if ($this->path === $path = $this->filterPath($path)) {
  2417. return $this;
  2418. }
  2419. $new = clone $this;
  2420. $new->path = $path;
  2421. return $new;
  2422. }
  2423. public function withQuery($query): self
  2424. {
  2425. if ($this->query === $query = $this->filterQueryAndFragment($query)) {
  2426. return $this;
  2427. }
  2428. $new = clone $this;
  2429. $new->query = $query;
  2430. return $new;
  2431. }
  2432. public function withFragment($fragment): self
  2433. {
  2434. if ($this->fragment === $fragment = $this->filterQueryAndFragment($fragment)) {
  2435. return $this;
  2436. }
  2437. $new = clone $this;
  2438. $new->fragment = $fragment;
  2439. return $new;
  2440. }
  2441. /**
  2442. * Create a URI string from its various parts.
  2443. */
  2444. private static function createUriString(string $scheme, string $authority, string $path, string $query, string $fragment): string
  2445. {
  2446. $uri = '';
  2447. if ('' !== $scheme) {
  2448. $uri .= $scheme . ':';
  2449. }
  2450. if ('' !== $authority) {
  2451. $uri .= '//' . $authority;
  2452. }
  2453. if ('' !== $path) {
  2454. if ('/' !== $path[0]) {
  2455. if ('' !== $authority) {
  2456. // If the path is rootless and an authority is present, the path MUST be prefixed by "/"
  2457. $path = '/' . $path;
  2458. }
  2459. } elseif (isset($path[1]) && '/' === $path[1]) {
  2460. if ('' === $authority) {
  2461. // If the path is starting with more than one "/" and no authority is present, the
  2462. // starting slashes MUST be reduced to one.
  2463. $path = '/' . \ltrim($path, '/');
  2464. }
  2465. }
  2466. $uri .= $path;
  2467. }
  2468. if ('' !== $query) {
  2469. $uri .= '?' . $query;
  2470. }
  2471. if ('' !== $fragment) {
  2472. $uri .= '#' . $fragment;
  2473. }
  2474. return $uri;
  2475. }
  2476. /**
  2477. * Is a given port non-standard for the current scheme?
  2478. */
  2479. private static function isNonStandardPort(string $scheme, int $port): bool
  2480. {
  2481. return !isset(self::SCHEMES[$scheme]) || $port !== self::SCHEMES[$scheme];
  2482. }
  2483. private function filterPort($port) /*:?int*/
  2484. {
  2485. if (null === $port) {
  2486. return null;
  2487. }
  2488. $port = (int) $port;
  2489. if (0 > $port || 0xffff < $port) {
  2490. throw new \InvalidArgumentException(\sprintf('Invalid port: %d. Must be between 0 and 65535', $port));
  2491. }
  2492. return self::isNonStandardPort($this->scheme, $port) ? $port : null;
  2493. }
  2494. private function filterPath($path): string
  2495. {
  2496. if (!\is_string($path)) {
  2497. throw new \InvalidArgumentException('Path must be a string');
  2498. }
  2499. return \preg_replace_callback('/(?:[^' . self::CHAR_UNRESERVED . self::CHAR_SUB_DELIMS . '%:@\/]++|%(?![A-Fa-f0-9]{2}))/', [__CLASS__, 'rawurlencodeMatchZero'], $path);
  2500. }
  2501. private function filterQueryAndFragment($str): string
  2502. {
  2503. if (!\is_string($str)) {
  2504. throw new \InvalidArgumentException('Query and fragment must be a string');
  2505. }
  2506. return \preg_replace_callback('/(?:[^' . self::CHAR_UNRESERVED . self::CHAR_SUB_DELIMS . '%:@\/\?]++|%(?![A-Fa-f0-9]{2}))/', [__CLASS__, 'rawurlencodeMatchZero'], $str);
  2507. }
  2508. private static function rawurlencodeMatchZero(array $match): string
  2509. {
  2510. return \rawurlencode($match[0]);
  2511. }
  2512. }
  2513. }
  2514. // file: vendor/nyholm/psr7-server/src/ServerRequestCreator.php
  2515. namespace Nyholm\Psr7Server {
  2516. use Psr\Http\Message\ServerRequestFactoryInterface;
  2517. use Psr\Http\Message\ServerRequestInterface;
  2518. use Psr\Http\Message\StreamFactoryInterface;
  2519. use Psr\Http\Message\StreamInterface;
  2520. use Psr\Http\Message\UploadedFileFactoryInterface;
  2521. use Psr\Http\Message\UploadedFileInterface;
  2522. use Psr\Http\Message\UriFactoryInterface;
  2523. use Psr\Http\Message\UriInterface;
  2524. /**
  2525. * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  2526. * @author Martijn van der Ven <martijn@vanderven.se>
  2527. */
  2528. final class ServerRequestCreator implements ServerRequestCreatorInterface
  2529. {
  2530. private $serverRequestFactory;
  2531. private $uriFactory;
  2532. private $uploadedFileFactory;
  2533. private $streamFactory;
  2534. public function __construct(
  2535. ServerRequestFactoryInterface $serverRequestFactory,
  2536. UriFactoryInterface $uriFactory,
  2537. UploadedFileFactoryInterface $uploadedFileFactory,
  2538. StreamFactoryInterface $streamFactory
  2539. ) {
  2540. $this->serverRequestFactory = $serverRequestFactory;
  2541. $this->uriFactory = $uriFactory;
  2542. $this->uploadedFileFactory = $uploadedFileFactory;
  2543. $this->streamFactory = $streamFactory;
  2544. }
  2545. /**
  2546. * {@inheritdoc}
  2547. */
  2548. public function fromGlobals(): ServerRequestInterface
  2549. {
  2550. $server = $_SERVER;
  2551. if (false === isset($server['REQUEST_METHOD'])) {
  2552. $server['REQUEST_METHOD'] = 'GET';
  2553. }
  2554. $headers = \function_exists('getallheaders') ? getallheaders() : static::getHeadersFromServer($_SERVER);
  2555. return $this->fromArrays($server, $headers, $_COOKIE, $_GET, $_POST, $_FILES, \fopen('php://input', 'r') ?: null);
  2556. }
  2557. /**
  2558. * {@inheritdoc}
  2559. */
  2560. public function fromArrays(array $server, array $headers = [], array $cookie = [], array $get = [], array $post = [], array $files = [], $body = null): ServerRequestInterface
  2561. {
  2562. $method = $this->getMethodFromEnv($server);
  2563. $uri = $this->getUriFromEnvWithHTTP($server);
  2564. $protocol = isset($server['SERVER_PROTOCOL']) ? \str_replace('HTTP/', '', $server['SERVER_PROTOCOL']) : '1.1';
  2565. $serverRequest = $this->serverRequestFactory->createServerRequest($method, $uri, $server);
  2566. foreach ($headers as $name => $value) {
  2567. $serverRequest = $serverRequest->withAddedHeader($name, $value);
  2568. }
  2569. $serverRequest = $serverRequest
  2570. ->withProtocolVersion($protocol)
  2571. ->withCookieParams($cookie)
  2572. ->withQueryParams($get)
  2573. ->withParsedBody($post)
  2574. ->withUploadedFiles($this->normalizeFiles($files));
  2575. if (null === $body) {
  2576. return $serverRequest;
  2577. }
  2578. if (\is_resource($body)) {
  2579. $body = $this->streamFactory->createStreamFromResource($body);
  2580. } elseif (\is_string($body)) {
  2581. $body = $this->streamFactory->createStream($body);
  2582. } elseif (!$body instanceof StreamInterface) {
  2583. throw new \InvalidArgumentException('The $body parameter to ServerRequestCreator::fromArrays must be string, resource or StreamInterface');
  2584. }
  2585. return $serverRequest->withBody($body);
  2586. }
  2587. /**
  2588. * Implementation from Zend\Diactoros\marshalHeadersFromSapi().
  2589. */
  2590. public static function getHeadersFromServer(array $server): array
  2591. {
  2592. $headers = [];
  2593. foreach ($server as $key => $value) {
  2594. // Apache prefixes environment variables with REDIRECT_
  2595. // if they are added by rewrite rules
  2596. if (0 === \strpos($key, 'REDIRECT_')) {
  2597. $key = \substr($key, 9);
  2598. // We will not overwrite existing variables with the
  2599. // prefixed versions, though
  2600. if (\array_key_exists($key, $server)) {
  2601. continue;
  2602. }
  2603. }
  2604. if ($value && 0 === \strpos($key, 'HTTP_')) {
  2605. $name = \strtr(\strtolower(\substr($key, 5)), '_', '-');
  2606. $headers[$name] = $value;
  2607. continue;
  2608. }
  2609. if ($value && 0 === \strpos($key, 'CONTENT_')) {
  2610. $name = 'content-'.\strtolower(\substr($key, 8));
  2611. $headers[$name] = $value;
  2612. continue;
  2613. }
  2614. }
  2615. return $headers;
  2616. }
  2617. private function getMethodFromEnv(array $environment): string
  2618. {
  2619. if (false === isset($environment['REQUEST_METHOD'])) {
  2620. throw new \InvalidArgumentException('Cannot determine HTTP method');
  2621. }
  2622. return $environment['REQUEST_METHOD'];
  2623. }
  2624. private function getUriFromEnvWithHTTP(array $environment): UriInterface
  2625. {
  2626. $uri = $this->createUriFromArray($environment);
  2627. if (empty($uri->getScheme())) {
  2628. $uri = $uri->withScheme('http');
  2629. }
  2630. return $uri;
  2631. }
  2632. /**
  2633. * Return an UploadedFile instance array.
  2634. *
  2635. * @param array $files A array which respect $_FILES structure
  2636. *
  2637. * @return UploadedFileInterface[]
  2638. *
  2639. * @throws \InvalidArgumentException for unrecognized values
  2640. */
  2641. private function normalizeFiles(array $files): array
  2642. {
  2643. $normalized = [];
  2644. foreach ($files as $key => $value) {
  2645. if ($value instanceof UploadedFileInterface) {
  2646. $normalized[$key] = $value;
  2647. } elseif (\is_array($value) && isset($value['tmp_name'])) {
  2648. $normalized[$key] = $this->createUploadedFileFromSpec($value);
  2649. } elseif (\is_array($value)) {
  2650. $normalized[$key] = $this->normalizeFiles($value);
  2651. } else {
  2652. throw new \InvalidArgumentException('Invalid value in files specification');
  2653. }
  2654. }
  2655. return $normalized;
  2656. }
  2657. /**
  2658. * Create and return an UploadedFile instance from a $_FILES specification.
  2659. *
  2660. * If the specification represents an array of values, this method will
  2661. * delegate to normalizeNestedFileSpec() and return that return value.
  2662. *
  2663. * @param array $value $_FILES struct
  2664. *
  2665. * @return array|UploadedFileInterface
  2666. */
  2667. private function createUploadedFileFromSpec(array $value)
  2668. {
  2669. if (\is_array($value['tmp_name'])) {
  2670. return $this->normalizeNestedFileSpec($value);
  2671. }
  2672. try {
  2673. $stream = $this->streamFactory->createStreamFromFile($value['tmp_name']);
  2674. } catch (\RuntimeException $e) {
  2675. $stream = $this->streamFactory->createStream();
  2676. }
  2677. return $this->uploadedFileFactory->createUploadedFile(
  2678. $stream,
  2679. (int) $value['size'],
  2680. (int) $value['error'],
  2681. $value['name'],
  2682. $value['type']
  2683. );
  2684. }
  2685. /**
  2686. * Normalize an array of file specifications.
  2687. *
  2688. * Loops through all nested files and returns a normalized array of
  2689. * UploadedFileInterface instances.
  2690. *
  2691. * @param array $files
  2692. *
  2693. * @return UploadedFileInterface[]
  2694. */
  2695. private function normalizeNestedFileSpec(array $files = []): array
  2696. {
  2697. $normalizedFiles = [];
  2698. foreach (\array_keys($files['tmp_name']) as $key) {
  2699. $spec = [
  2700. 'tmp_name' => $files['tmp_name'][$key],
  2701. 'size' => $files['size'][$key],
  2702. 'error' => $files['error'][$key],
  2703. 'name' => $files['name'][$key],
  2704. 'type' => $files['type'][$key],
  2705. ];
  2706. $normalizedFiles[$key] = $this->createUploadedFileFromSpec($spec);
  2707. }
  2708. return $normalizedFiles;
  2709. }
  2710. /**
  2711. * Create a new uri from server variable.
  2712. *
  2713. * @param array $server typically $_SERVER or similar structure
  2714. */
  2715. private function createUriFromArray(array $server): UriInterface
  2716. {
  2717. $uri = $this->uriFactory->createUri('');
  2718. if (isset($server['HTTP_X_FORWARDED_PROTO'])) {
  2719. $uri = $uri->withScheme($server['HTTP_X_FORWARDED_PROTO']);
  2720. } else {
  2721. if (isset($server['REQUEST_SCHEME'])) {
  2722. $uri = $uri->withScheme($server['REQUEST_SCHEME']);
  2723. } elseif (isset($server['HTTPS'])) {
  2724. $uri = $uri->withScheme('on' === $server['HTTPS'] ? 'https' : 'http');
  2725. }
  2726. if (isset($server['SERVER_PORT'])) {
  2727. $uri = $uri->withPort($server['SERVER_PORT']);
  2728. }
  2729. }
  2730. if (isset($server['HTTP_HOST'])) {
  2731. if (1 === \preg_match('/^(.+)\:(\d+)$/', $server['HTTP_HOST'], $matches)) {
  2732. $uri = $uri->withHost($matches[1])->withPort($matches[2]);
  2733. } else {
  2734. $uri = $uri->withHost($server['HTTP_HOST']);
  2735. }
  2736. } elseif (isset($server['SERVER_NAME'])) {
  2737. $uri = $uri->withHost($server['SERVER_NAME']);
  2738. }
  2739. if (isset($server['REQUEST_URI'])) {
  2740. $uri = $uri->withPath(\current(\explode('?', $server['REQUEST_URI'])));
  2741. }
  2742. if (isset($server['QUERY_STRING'])) {
  2743. $uri = $uri->withQuery($server['QUERY_STRING']);
  2744. }
  2745. return $uri;
  2746. }
  2747. }
  2748. }
  2749. // file: vendor/nyholm/psr7-server/src/ServerRequestCreatorInterface.php
  2750. namespace Nyholm\Psr7Server {
  2751. use Psr\Http\Message\ServerRequestInterface;
  2752. use Psr\Http\Message\StreamInterface;
  2753. /**
  2754. * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  2755. * @author Martijn van der Ven <martijn@vanderven.se>
  2756. */
  2757. interface ServerRequestCreatorInterface
  2758. {
  2759. /**
  2760. * Create a new server request from the current environment variables.
  2761. * Defaults to a GET request to minimise the risk of an \InvalidArgumentException.
  2762. * Includes the current request headers as supplied by the server through `getallheaders()`.
  2763. * If `getallheaders()` is unavailable on the current server it will fallback to its own `getHeadersFromServer()` method.
  2764. * Defaults to php://input for the request body.
  2765. *
  2766. * @throws \InvalidArgumentException if no valid method or URI can be determined
  2767. */
  2768. public function fromGlobals(): ServerRequestInterface;
  2769. /**
  2770. * Create a new server request from a set of arrays.
  2771. *
  2772. * @param array $server typically $_SERVER or similar structure
  2773. * @param array $headers typically the output of getallheaders() or similar structure
  2774. * @param array $cookie typically $_COOKIE or similar structure
  2775. * @param array $get typically $_GET or similar structure
  2776. * @param array $post typically $_POST or similar structure
  2777. * @param array $files typically $_FILES or similar structure
  2778. * @param StreamInterface|resource|string|null $body Typically stdIn
  2779. *
  2780. * @throws \InvalidArgumentException if no valid method or URI can be determined
  2781. */
  2782. public function fromArrays(
  2783. array $server,
  2784. array $headers = [],
  2785. array $cookie = [],
  2786. array $get = [],
  2787. array $post = [],
  2788. array $files = [],
  2789. $body = null
  2790. ): ServerRequestInterface;
  2791. /**
  2792. * Get parsed headers from ($_SERVER) array.
  2793. *
  2794. * @param array $server typically $_SERVER or similar structure
  2795. *
  2796. * @return array
  2797. */
  2798. public static function getHeadersFromServer(array $server): array;
  2799. }
  2800. }
  2801. // file: src/Tqdev/PhpCrudApi/Cache/Cache.php
  2802. namespace Tqdev\PhpCrudApi\Cache {
  2803. interface Cache
  2804. {
  2805. public function set(string $key, string $value, int $ttl = 0): bool;
  2806. public function get(string $key): string;
  2807. public function clear(): bool;
  2808. }
  2809. }
  2810. // file: src/Tqdev/PhpCrudApi/Cache/CacheFactory.php
  2811. namespace Tqdev\PhpCrudApi\Cache {
  2812. class CacheFactory
  2813. {
  2814. public static function create(string $type, string $prefix, string $config): Cache
  2815. {
  2816. switch ($type) {
  2817. case 'TempFile':
  2818. $cache = new TempFileCache($prefix, $config);
  2819. break;
  2820. case 'Redis':
  2821. $cache = new RedisCache($prefix, $config);
  2822. break;
  2823. case 'Memcache':
  2824. $cache = new MemcacheCache($prefix, $config);
  2825. break;
  2826. case 'Memcached':
  2827. $cache = new MemcachedCache($prefix, $config);
  2828. break;
  2829. default:
  2830. $cache = new NoCache();
  2831. }
  2832. return $cache;
  2833. }
  2834. }
  2835. }
  2836. // file: src/Tqdev/PhpCrudApi/Cache/MemcacheCache.php
  2837. namespace Tqdev\PhpCrudApi\Cache {
  2838. class MemcacheCache implements Cache
  2839. {
  2840. protected $prefix;
  2841. protected $memcache;
  2842. public function __construct(string $prefix, string $config)
  2843. {
  2844. $this->prefix = $prefix;
  2845. if ($config == '') {
  2846. $address = 'localhost';
  2847. $port = 11211;
  2848. } elseif (strpos($config, ':') === false) {
  2849. $address = $config;
  2850. $port = 11211;
  2851. } else {
  2852. list($address, $port) = explode(':', $config);
  2853. }
  2854. $this->memcache = $this->create();
  2855. $this->memcache->addServer($address, $port);
  2856. }
  2857. protected function create() /*: \Memcache*/
  2858. {
  2859. return new \Memcache();
  2860. }
  2861. public function set(string $key, string $value, int $ttl = 0): bool
  2862. {
  2863. return $this->memcache->set($this->prefix . $key, $value, 0, $ttl);
  2864. }
  2865. public function get(string $key): string
  2866. {
  2867. return $this->memcache->get($this->prefix . $key) ?: '';
  2868. }
  2869. public function clear(): bool
  2870. {
  2871. return $this->memcache->flush();
  2872. }
  2873. }
  2874. }
  2875. // file: src/Tqdev/PhpCrudApi/Cache/MemcachedCache.php
  2876. namespace Tqdev\PhpCrudApi\Cache {
  2877. class MemcachedCache extends MemcacheCache
  2878. {
  2879. protected function create() /*: \Memcached*/
  2880. {
  2881. return new \Memcached();
  2882. }
  2883. public function set(string $key, string $value, int $ttl = 0): bool
  2884. {
  2885. return $this->memcache->set($this->prefix . $key, $value, $ttl);
  2886. }
  2887. }
  2888. }
  2889. // file: src/Tqdev/PhpCrudApi/Cache/NoCache.php
  2890. namespace Tqdev\PhpCrudApi\Cache {
  2891. class NoCache implements Cache
  2892. {
  2893. public function __construct()
  2894. {
  2895. }
  2896. public function set(string $key, string $value, int $ttl = 0): bool
  2897. {
  2898. return true;
  2899. }
  2900. public function get(string $key): string
  2901. {
  2902. return '';
  2903. }
  2904. public function clear(): bool
  2905. {
  2906. return true;
  2907. }
  2908. }
  2909. }
  2910. // file: src/Tqdev/PhpCrudApi/Cache/RedisCache.php
  2911. namespace Tqdev\PhpCrudApi\Cache {
  2912. class RedisCache implements Cache
  2913. {
  2914. protected $prefix;
  2915. protected $redis;
  2916. public function __construct(string $prefix, string $config)
  2917. {
  2918. $this->prefix = $prefix;
  2919. if ($config == '') {
  2920. $config = '127.0.0.1';
  2921. }
  2922. $params = explode(':', $config, 6);
  2923. if (isset($params[3])) {
  2924. $params[3] = null;
  2925. }
  2926. $this->redis = new \Redis();
  2927. call_user_func_array(array($this->redis, 'pconnect'), $params);
  2928. }
  2929. public function set(string $key, string $value, int $ttl = 0): bool
  2930. {
  2931. return $this->redis->set($this->prefix . $key, $value, $ttl);
  2932. }
  2933. public function get(string $key): string
  2934. {
  2935. return $this->redis->get($this->prefix . $key) ?: '';
  2936. }
  2937. public function clear(): bool
  2938. {
  2939. return $this->redis->flushDb();
  2940. }
  2941. }
  2942. }
  2943. // file: src/Tqdev/PhpCrudApi/Cache/TempFileCache.php
  2944. namespace Tqdev\PhpCrudApi\Cache {
  2945. class TempFileCache implements Cache
  2946. {
  2947. const SUFFIX = 'cache';
  2948. private $path;
  2949. private $segments;
  2950. public function __construct(string $prefix, string $config)
  2951. {
  2952. $this->segments = [];
  2953. $s = DIRECTORY_SEPARATOR;
  2954. $ps = PATH_SEPARATOR;
  2955. if ($config == '') {
  2956. $this->path = sys_get_temp_dir() . $s . $prefix . self::SUFFIX;
  2957. } elseif (strpos($config, $ps) === false) {
  2958. $this->path = $config;
  2959. } else {
  2960. list($path, $segments) = explode($ps, $config);
  2961. $this->path = $path;
  2962. $this->segments = explode(',', $segments);
  2963. }
  2964. if (file_exists($this->path) && is_dir($this->path)) {
  2965. $this->clean($this->path, array_filter($this->segments), strlen(md5('')), false);
  2966. }
  2967. }
  2968. private function getFileName(string $key): string
  2969. {
  2970. $s = DIRECTORY_SEPARATOR;
  2971. $md5 = md5($key);
  2972. $filename = rtrim($this->path, $s) . $s;
  2973. $i = 0;
  2974. foreach ($this->segments as $segment) {
  2975. $filename .= substr($md5, $i, $segment) . $s;
  2976. $i += $segment;
  2977. }
  2978. $filename .= substr($md5, $i);
  2979. return $filename;
  2980. }
  2981. public function set(string $key, string $value, int $ttl = 0): bool
  2982. {
  2983. $filename = $this->getFileName($key);
  2984. $dirname = dirname($filename);
  2985. if (!file_exists($dirname)) {
  2986. if (!mkdir($dirname, 0755, true)) {
  2987. return false;
  2988. }
  2989. }
  2990. $string = $ttl . '|' . $value;
  2991. return $this->filePutContents($filename, $string) !== false;
  2992. }
  2993. private function filePutContents($filename, $string)
  2994. {
  2995. return file_put_contents($filename, $string, LOCK_EX);
  2996. }
  2997. private function fileGetContents($filename)
  2998. {
  2999. $file = fopen($filename, 'rb');
  3000. if ($file === false) {
  3001. return false;
  3002. }
  3003. $lock = flock($file, LOCK_SH);
  3004. if (!$lock) {
  3005. fclose($file);
  3006. return false;
  3007. }
  3008. $string = '';
  3009. while (!feof($file)) {
  3010. $string .= fread($file, 8192);
  3011. }
  3012. flock($file, LOCK_UN);
  3013. fclose($file);
  3014. return $string;
  3015. }
  3016. private function getString($filename): string
  3017. {
  3018. $data = $this->fileGetContents($filename);
  3019. if ($data === false) {
  3020. return '';
  3021. }
  3022. if (strpos($data, '|') === false) {
  3023. return '';
  3024. }
  3025. list($ttl, $string) = explode('|', $data, 2);
  3026. if ($ttl > 0 && time() - filemtime($filename) > $ttl) {
  3027. return '';
  3028. }
  3029. return $string;
  3030. }
  3031. public function get(string $key): string
  3032. {
  3033. $filename = $this->getFileName($key);
  3034. if (!file_exists($filename)) {
  3035. return '';
  3036. }
  3037. $string = $this->getString($filename);
  3038. if ($string == null) {
  3039. return '';
  3040. }
  3041. return $string;
  3042. }
  3043. private function clean(string $path, array $segments, int $len, bool $all) /*: void*/
  3044. {
  3045. $entries = scandir($path);
  3046. foreach ($entries as $entry) {
  3047. if ($entry === '.' || $entry === '..') {
  3048. continue;
  3049. }
  3050. $filename = $path . DIRECTORY_SEPARATOR . $entry;
  3051. if (count($segments) == 0) {
  3052. if (strlen($entry) != $len) {
  3053. continue;
  3054. }
  3055. if (file_exists($filename) && is_file($filename)) {
  3056. if ($all || $this->getString($filename) == null) {
  3057. @unlink($filename);
  3058. }
  3059. }
  3060. } else {
  3061. if (strlen($entry) != $segments[0]) {
  3062. continue;
  3063. }
  3064. if (file_exists($filename) && is_dir($filename)) {
  3065. $this->clean($filename, array_slice($segments, 1), $len - $segments[0], $all);
  3066. @rmdir($filename);
  3067. }
  3068. }
  3069. }
  3070. }
  3071. public function clear(): bool
  3072. {
  3073. if (!file_exists($this->path) || !is_dir($this->path)) {
  3074. return false;
  3075. }
  3076. $this->clean($this->path, array_filter($this->segments), strlen(md5('')), true);
  3077. return true;
  3078. }
  3079. }
  3080. }
  3081. // file: src/Tqdev/PhpCrudApi/Column/Reflection/ReflectedColumn.php
  3082. namespace Tqdev\PhpCrudApi\Column\Reflection {
  3083. use Tqdev\PhpCrudApi\Database\GenericReflection;
  3084. class ReflectedColumn implements \JsonSerializable
  3085. {
  3086. const DEFAULT_LENGTH = 255;
  3087. const DEFAULT_PRECISION = 19;
  3088. const DEFAULT_SCALE = 4;
  3089. private $name;
  3090. private $type;
  3091. private $length;
  3092. private $precision;
  3093. private $scale;
  3094. private $nullable;
  3095. private $pk;
  3096. private $fk;
  3097. public function __construct(string $name, string $type, int $length, int $precision, int $scale, bool $nullable, bool $pk, string $fk)
  3098. {
  3099. $this->name = $name;
  3100. $this->type = $type;
  3101. $this->length = $length;
  3102. $this->precision = $precision;
  3103. $this->scale = $scale;
  3104. $this->nullable = $nullable;
  3105. $this->pk = $pk;
  3106. $this->fk = $fk;
  3107. $this->sanitize();
  3108. }
  3109. private static function parseColumnType(string $columnType, int &$length, int &$precision, int &$scale) /*: void*/
  3110. {
  3111. if (!$columnType) {
  3112. return;
  3113. }
  3114. $pos = strpos($columnType, '(');
  3115. if ($pos) {
  3116. $dataSize = rtrim(substr($columnType, $pos + 1), ')');
  3117. if ($length) {
  3118. $length = (int) $dataSize;
  3119. } else {
  3120. $pos = strpos($dataSize, ',');
  3121. if ($pos) {
  3122. $precision = (int) substr($dataSize, 0, $pos);
  3123. $scale = (int) substr($dataSize, $pos + 1);
  3124. } else {
  3125. $precision = (int) $dataSize;
  3126. $scale = 0;
  3127. }
  3128. }
  3129. }
  3130. }
  3131. private static function getDataSize(int $length, int $precision, int $scale): string
  3132. {
  3133. $dataSize = '';
  3134. if ($length) {
  3135. $dataSize = $length;
  3136. } elseif ($precision) {
  3137. if ($scale) {
  3138. $dataSize = $precision . ',' . $scale;
  3139. } else {
  3140. $dataSize = $precision;
  3141. }
  3142. }
  3143. return $dataSize;
  3144. }
  3145. public static function fromReflection(GenericReflection $reflection, array $columnResult): ReflectedColumn
  3146. {
  3147. $name = $columnResult['COLUMN_NAME'];
  3148. $dataType = $columnResult['DATA_TYPE'];
  3149. $length = (int) $columnResult['CHARACTER_MAXIMUM_LENGTH'];
  3150. $precision = (int) $columnResult['NUMERIC_PRECISION'];
  3151. $scale = (int) $columnResult['NUMERIC_SCALE'];
  3152. $columnType = $columnResult['COLUMN_TYPE'];
  3153. self::parseColumnType($columnType, $length, $precision, $scale);
  3154. $dataSize = self::getDataSize($length, $precision, $scale);
  3155. $type = $reflection->toJdbcType($dataType, $dataSize);
  3156. $nullable = in_array(strtoupper($columnResult['IS_NULLABLE']), ['TRUE', 'YES', 'T', 'Y', '1']);
  3157. $pk = false;
  3158. $fk = '';
  3159. return new ReflectedColumn($name, $type, $length, $precision, $scale, $nullable, $pk, $fk);
  3160. }
  3161. public static function fromJson(/* object */$json): ReflectedColumn
  3162. {
  3163. $name = $json->name;
  3164. $type = $json->type;
  3165. $length = isset($json->length) ? (int) $json->length : 0;
  3166. $precision = isset($json->precision) ? (int) $json->precision : 0;
  3167. $scale = isset($json->scale) ? (int) $json->scale : 0;
  3168. $nullable = isset($json->nullable) ? (bool) $json->nullable : false;
  3169. $pk = isset($json->pk) ? (bool) $json->pk : false;
  3170. $fk = isset($json->fk) ? $json->fk : '';
  3171. return new ReflectedColumn($name, $type, $length, $precision, $scale, $nullable, $pk, $fk);
  3172. }
  3173. private function sanitize()
  3174. {
  3175. $this->length = $this->hasLength() ? $this->getLength() : 0;
  3176. $this->precision = $this->hasPrecision() ? $this->getPrecision() : 0;
  3177. $this->scale = $this->hasScale() ? $this->getScale() : 0;
  3178. }
  3179. public function getName(): string
  3180. {
  3181. return $this->name;
  3182. }
  3183. public function getNullable(): bool
  3184. {
  3185. return $this->nullable;
  3186. }
  3187. public function getType(): string
  3188. {
  3189. return $this->type;
  3190. }
  3191. public function getLength(): int
  3192. {
  3193. return $this->length ?: self::DEFAULT_LENGTH;
  3194. }
  3195. public function getPrecision(): int
  3196. {
  3197. return $this->precision ?: self::DEFAULT_PRECISION;
  3198. }
  3199. public function getScale(): int
  3200. {
  3201. return $this->scale ?: self::DEFAULT_SCALE;
  3202. }
  3203. public function hasLength(): bool
  3204. {
  3205. return in_array($this->type, ['varchar', 'varbinary']);
  3206. }
  3207. public function hasPrecision(): bool
  3208. {
  3209. return $this->type == 'decimal';
  3210. }
  3211. public function hasScale(): bool
  3212. {
  3213. return $this->type == 'decimal';
  3214. }
  3215. public function isBinary(): bool
  3216. {
  3217. return in_array($this->type, ['blob', 'varbinary']);
  3218. }
  3219. public function isBoolean(): bool
  3220. {
  3221. return $this->type == 'boolean';
  3222. }
  3223. public function isGeometry(): bool
  3224. {
  3225. return $this->type == 'geometry';
  3226. }
  3227. public function isInteger(): bool
  3228. {
  3229. return in_array($this->type, ['integer', 'bigint', 'smallint', 'tinyint']);
  3230. }
  3231. public function setPk($value) /*: void*/
  3232. {
  3233. $this->pk = $value;
  3234. }
  3235. public function getPk(): bool
  3236. {
  3237. return $this->pk;
  3238. }
  3239. public function setFk($value) /*: void*/
  3240. {
  3241. $this->fk = $value;
  3242. }
  3243. public function getFk(): string
  3244. {
  3245. return $this->fk;
  3246. }
  3247. public function serialize()
  3248. {
  3249. return [
  3250. 'name' => $this->name,
  3251. 'type' => $this->type,
  3252. 'length' => $this->length,
  3253. 'precision' => $this->precision,
  3254. 'scale' => $this->scale,
  3255. 'nullable' => $this->nullable,
  3256. 'pk' => $this->pk,
  3257. 'fk' => $this->fk,
  3258. ];
  3259. }
  3260. public function jsonSerialize()
  3261. {
  3262. return array_filter($this->serialize());
  3263. }
  3264. }
  3265. }
  3266. // file: src/Tqdev/PhpCrudApi/Column/Reflection/ReflectedDatabase.php
  3267. namespace Tqdev\PhpCrudApi\Column\Reflection {
  3268. use Tqdev\PhpCrudApi\Database\GenericReflection;
  3269. class ReflectedDatabase implements \JsonSerializable
  3270. {
  3271. private $tableTypes;
  3272. public function __construct(array $tableTypes)
  3273. {
  3274. $this->tableTypes = $tableTypes;
  3275. }
  3276. public static function fromReflection(GenericReflection $reflection): ReflectedDatabase
  3277. {
  3278. $tableTypes = [];
  3279. foreach ($reflection->getTables() as $table) {
  3280. $tableName = $table['TABLE_NAME'];
  3281. $tableType = $table['TABLE_TYPE'];
  3282. if (in_array($tableName, $reflection->getIgnoredTables())) {
  3283. continue;
  3284. }
  3285. $tableTypes[$tableName] = $tableType;
  3286. }
  3287. return new ReflectedDatabase($tableTypes);
  3288. }
  3289. public static function fromJson(/* object */$json): ReflectedDatabase
  3290. {
  3291. $tableTypes = (array) $json->tables;
  3292. return new ReflectedDatabase($tableTypes);
  3293. }
  3294. public function hasTable(string $tableName): bool
  3295. {
  3296. return isset($this->tableTypes[$tableName]);
  3297. }
  3298. public function getType(string $tableName): string
  3299. {
  3300. return isset($this->tableTypes[$tableName]) ? $this->tableTypes[$tableName] : '';
  3301. }
  3302. public function getTableNames(): array
  3303. {
  3304. return array_keys($this->tableTypes);
  3305. }
  3306. public function removeTable(string $tableName): bool
  3307. {
  3308. if (!isset($this->tableTypes[$tableName])) {
  3309. return false;
  3310. }
  3311. unset($this->tableTypes[$tableName]);
  3312. return true;
  3313. }
  3314. public function serialize()
  3315. {
  3316. return [
  3317. 'tables' => $this->tableTypes,
  3318. ];
  3319. }
  3320. public function jsonSerialize()
  3321. {
  3322. return $this->serialize();
  3323. }
  3324. }
  3325. }
  3326. // file: src/Tqdev/PhpCrudApi/Column/Reflection/ReflectedTable.php
  3327. namespace Tqdev\PhpCrudApi\Column\Reflection {
  3328. use Tqdev\PhpCrudApi\Database\GenericReflection;
  3329. class ReflectedTable implements \JsonSerializable
  3330. {
  3331. private $name;
  3332. private $type;
  3333. private $columns;
  3334. private $pk;
  3335. private $fks;
  3336. public function __construct(string $name, string $type, array $columns)
  3337. {
  3338. $this->name = $name;
  3339. $this->type = $type;
  3340. // set columns
  3341. $this->columns = [];
  3342. foreach ($columns as $column) {
  3343. $columnName = $column->getName();
  3344. $this->columns[$columnName] = $column;
  3345. }
  3346. // set primary key
  3347. $this->pk = null;
  3348. foreach ($columns as $column) {
  3349. if ($column->getPk() == true) {
  3350. $this->pk = $column;
  3351. }
  3352. }
  3353. // set foreign keys
  3354. $this->fks = [];
  3355. foreach ($columns as $column) {
  3356. $columnName = $column->getName();
  3357. $referencedTableName = $column->getFk();
  3358. if ($referencedTableName != '') {
  3359. $this->fks[$columnName] = $referencedTableName;
  3360. }
  3361. }
  3362. }
  3363. public static function fromReflection(GenericReflection $reflection, string $name, string $type): ReflectedTable
  3364. {
  3365. // set columns
  3366. $columns = [];
  3367. foreach ($reflection->getTableColumns($name, $type) as $tableColumn) {
  3368. $column = ReflectedColumn::fromReflection($reflection, $tableColumn);
  3369. $columns[$column->getName()] = $column;
  3370. }
  3371. // set primary key
  3372. $columnName = false;
  3373. if ($type == 'view') {
  3374. $columnName = 'id';
  3375. } else {
  3376. $columnNames = $reflection->getTablePrimaryKeys($name);
  3377. if (count($columnNames) == 1) {
  3378. $columnName = $columnNames[0];
  3379. }
  3380. }
  3381. if ($columnName && isset($columns[$columnName])) {
  3382. $pk = $columns[$columnName];
  3383. $pk->setPk(true);
  3384. }
  3385. // set foreign keys
  3386. if ($type == 'view') {
  3387. $tables = $reflection->getTables();
  3388. foreach ($columns as $columnName => $column) {
  3389. if (substr($columnName, -3) == '_id') {
  3390. foreach ($tables as $table) {
  3391. $tableName = $table['TABLE_NAME'];
  3392. $suffix = $tableName . '_id';
  3393. if (substr($columnName, -1 * strlen($suffix)) == $suffix) {
  3394. $column->setFk($tableName);
  3395. }
  3396. }
  3397. }
  3398. }
  3399. } else {
  3400. $fks = $reflection->getTableForeignKeys($name);
  3401. foreach ($fks as $columnName => $table) {
  3402. $columns[$columnName]->setFk($table);
  3403. }
  3404. }
  3405. return new ReflectedTable($name, $type, array_values($columns));
  3406. }
  3407. public static function fromJson( /* object */$json): ReflectedTable
  3408. {
  3409. $name = $json->name;
  3410. $type = isset($json->type) ? $json->type : 'table';
  3411. $columns = [];
  3412. if (isset($json->columns) && is_array($json->columns)) {
  3413. foreach ($json->columns as $column) {
  3414. $columns[] = ReflectedColumn::fromJson($column);
  3415. }
  3416. }
  3417. return new ReflectedTable($name, $type, $columns);
  3418. }
  3419. public function hasColumn(string $columnName): bool
  3420. {
  3421. return isset($this->columns[$columnName]);
  3422. }
  3423. public function hasPk(): bool
  3424. {
  3425. return $this->pk != null;
  3426. }
  3427. public function getPk() /*: ?ReflectedColumn */
  3428. {
  3429. return $this->pk;
  3430. }
  3431. public function getName(): string
  3432. {
  3433. return $this->name;
  3434. }
  3435. public function getType(): string
  3436. {
  3437. return $this->type;
  3438. }
  3439. public function getColumnNames(): array
  3440. {
  3441. return array_keys($this->columns);
  3442. }
  3443. public function getColumn($columnName): ReflectedColumn
  3444. {
  3445. return $this->columns[$columnName];
  3446. }
  3447. public function getFksTo(string $tableName): array
  3448. {
  3449. $columns = array();
  3450. foreach ($this->fks as $columnName => $referencedTableName) {
  3451. if ($tableName == $referencedTableName && !is_null($this->columns[$columnName])) {
  3452. $columns[] = $this->columns[$columnName];
  3453. }
  3454. }
  3455. return $columns;
  3456. }
  3457. public function removeColumn(string $columnName): bool
  3458. {
  3459. if (!isset($this->columns[$columnName])) {
  3460. return false;
  3461. }
  3462. unset($this->columns[$columnName]);
  3463. return true;
  3464. }
  3465. public function serialize()
  3466. {
  3467. return [
  3468. 'name' => $this->name,
  3469. 'type' => $this->type,
  3470. 'columns' => array_values($this->columns),
  3471. ];
  3472. }
  3473. public function jsonSerialize()
  3474. {
  3475. return $this->serialize();
  3476. }
  3477. }
  3478. }
  3479. // file: src/Tqdev/PhpCrudApi/Column/DefinitionService.php
  3480. namespace Tqdev\PhpCrudApi\Column {
  3481. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedColumn;
  3482. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedTable;
  3483. use Tqdev\PhpCrudApi\Database\GenericDB;
  3484. class DefinitionService
  3485. {
  3486. private $db;
  3487. private $reflection;
  3488. public function __construct(GenericDB $db, ReflectionService $reflection)
  3489. {
  3490. $this->db = $db;
  3491. $this->reflection = $reflection;
  3492. }
  3493. public function updateTable(string $tableName, /* object */ $changes): bool
  3494. {
  3495. $table = $this->reflection->getTable($tableName);
  3496. $newTable = ReflectedTable::fromJson((object) array_merge((array) $table->jsonSerialize(), (array) $changes));
  3497. if ($table->getName() != $newTable->getName()) {
  3498. if (!$this->db->definition()->renameTable($table->getName(), $newTable->getName())) {
  3499. return false;
  3500. }
  3501. }
  3502. return true;
  3503. }
  3504. public function updateColumn(string $tableName, string $columnName, /* object */ $changes): bool
  3505. {
  3506. $table = $this->reflection->getTable($tableName);
  3507. $column = $table->getColumn($columnName);
  3508. // remove constraints on other column
  3509. $newColumn = ReflectedColumn::fromJson((object) array_merge((array) $column->jsonSerialize(), (array) $changes));
  3510. if ($newColumn->getPk() != $column->getPk() && $table->hasPk()) {
  3511. $oldColumn = $table->getPk();
  3512. if ($oldColumn->getName() != $columnName) {
  3513. $oldColumn->setPk(false);
  3514. if (!$this->db->definition()->removeColumnPrimaryKey($table->getName(), $oldColumn->getName(), $oldColumn)) {
  3515. return false;
  3516. }
  3517. }
  3518. }
  3519. // remove constraints
  3520. $newColumn = ReflectedColumn::fromJson((object) array_merge((array) $column->jsonSerialize(), ['pk' => false, 'fk' => false]));
  3521. if ($newColumn->getPk() != $column->getPk() && !$newColumn->getPk()) {
  3522. if (!$this->db->definition()->removeColumnPrimaryKey($table->getName(), $column->getName(), $newColumn)) {
  3523. return false;
  3524. }
  3525. }
  3526. if ($newColumn->getFk() != $column->getFk() && !$newColumn->getFk()) {
  3527. if (!$this->db->definition()->removeColumnForeignKey($table->getName(), $column->getName(), $newColumn)) {
  3528. return false;
  3529. }
  3530. }
  3531. // name and type
  3532. $newColumn = ReflectedColumn::fromJson((object) array_merge((array) $column->jsonSerialize(), (array) $changes));
  3533. $newColumn->setPk(false);
  3534. $newColumn->setFk('');
  3535. if ($newColumn->getName() != $column->getName()) {
  3536. if (!$this->db->definition()->renameColumn($table->getName(), $column->getName(), $newColumn)) {
  3537. return false;
  3538. }
  3539. }
  3540. if (
  3541. $newColumn->getType() != $column->getType() ||
  3542. $newColumn->getLength() != $column->getLength() ||
  3543. $newColumn->getPrecision() != $column->getPrecision() ||
  3544. $newColumn->getScale() != $column->getScale()
  3545. ) {
  3546. if (!$this->db->definition()->retypeColumn($table->getName(), $newColumn->getName(), $newColumn)) {
  3547. return false;
  3548. }
  3549. }
  3550. if ($newColumn->getNullable() != $column->getNullable()) {
  3551. if (!$this->db->definition()->setColumnNullable($table->getName(), $newColumn->getName(), $newColumn)) {
  3552. return false;
  3553. }
  3554. }
  3555. // add constraints
  3556. $newColumn = ReflectedColumn::fromJson((object) array_merge((array) $column->jsonSerialize(), (array) $changes));
  3557. if ($newColumn->getFk()) {
  3558. if (!$this->db->definition()->addColumnForeignKey($table->getName(), $newColumn->getName(), $newColumn)) {
  3559. return false;
  3560. }
  3561. }
  3562. if ($newColumn->getPk()) {
  3563. if (!$this->db->definition()->addColumnPrimaryKey($table->getName(), $newColumn->getName(), $newColumn)) {
  3564. return false;
  3565. }
  3566. }
  3567. return true;
  3568. }
  3569. public function addTable(/* object */$definition)
  3570. {
  3571. $newTable = ReflectedTable::fromJson($definition);
  3572. if (!$this->db->definition()->addTable($newTable)) {
  3573. return false;
  3574. }
  3575. return true;
  3576. }
  3577. public function addColumn(string $tableName, /* object */ $definition)
  3578. {
  3579. $newColumn = ReflectedColumn::fromJson($definition);
  3580. if (!$this->db->definition()->addColumn($tableName, $newColumn)) {
  3581. return false;
  3582. }
  3583. if ($newColumn->getFk()) {
  3584. if (!$this->db->definition()->addColumnForeignKey($tableName, $newColumn->getName(), $newColumn)) {
  3585. return false;
  3586. }
  3587. }
  3588. if ($newColumn->getPk()) {
  3589. if (!$this->db->definition()->addColumnPrimaryKey($tableName, $newColumn->getName(), $newColumn)) {
  3590. return false;
  3591. }
  3592. }
  3593. return true;
  3594. }
  3595. public function removeTable(string $tableName)
  3596. {
  3597. if (!$this->db->definition()->removeTable($tableName)) {
  3598. return false;
  3599. }
  3600. return true;
  3601. }
  3602. public function removeColumn(string $tableName, string $columnName)
  3603. {
  3604. $table = $this->reflection->getTable($tableName);
  3605. $newColumn = $table->getColumn($columnName);
  3606. if ($newColumn->getPk()) {
  3607. $newColumn->setPk(false);
  3608. if (!$this->db->definition()->removeColumnPrimaryKey($table->getName(), $newColumn->getName(), $newColumn)) {
  3609. return false;
  3610. }
  3611. }
  3612. if ($newColumn->getFk()) {
  3613. $newColumn->setFk("");
  3614. if (!$this->db->definition()->removeColumnForeignKey($tableName, $columnName, $newColumn)) {
  3615. return false;
  3616. }
  3617. }
  3618. if (!$this->db->definition()->removeColumn($tableName, $columnName)) {
  3619. return false;
  3620. }
  3621. return true;
  3622. }
  3623. }
  3624. }
  3625. // file: src/Tqdev/PhpCrudApi/Column/ReflectionService.php
  3626. namespace Tqdev\PhpCrudApi\Column {
  3627. use Tqdev\PhpCrudApi\Cache\Cache;
  3628. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedDatabase;
  3629. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedTable;
  3630. use Tqdev\PhpCrudApi\Database\GenericDB;
  3631. class ReflectionService
  3632. {
  3633. private $db;
  3634. private $cache;
  3635. private $ttl;
  3636. private $database;
  3637. private $tables;
  3638. public function __construct(GenericDB $db, Cache $cache, int $ttl)
  3639. {
  3640. $this->db = $db;
  3641. $this->cache = $cache;
  3642. $this->ttl = $ttl;
  3643. $this->database = null;
  3644. $this->tables = [];
  3645. }
  3646. private function database(): ReflectedDatabase
  3647. {
  3648. if ($this->database) {
  3649. return $this->database;
  3650. }
  3651. $this->database = $this->loadDatabase(true);
  3652. return $this->database;
  3653. }
  3654. private function loadDatabase(bool $useCache): ReflectedDatabase
  3655. {
  3656. $key = sprintf('%s-ReflectedDatabase', $this->db->getCacheKey());
  3657. $data = $useCache ? $this->cache->get($key) : '';
  3658. if ($data != '') {
  3659. $database = ReflectedDatabase::fromJson(json_decode(gzuncompress($data)));
  3660. } else {
  3661. $database = ReflectedDatabase::fromReflection($this->db->reflection());
  3662. $data = gzcompress(json_encode($database, JSON_UNESCAPED_UNICODE));
  3663. $this->cache->set($key, $data, $this->ttl);
  3664. }
  3665. return $database;
  3666. }
  3667. private function loadTable(string $tableName, bool $useCache): ReflectedTable
  3668. {
  3669. $key = sprintf('%s-ReflectedTable(%s)', $this->db->getCacheKey(), $tableName);
  3670. $data = $useCache ? $this->cache->get($key) : '';
  3671. if ($data != '') {
  3672. $table = ReflectedTable::fromJson(json_decode(gzuncompress($data)));
  3673. } else {
  3674. $tableType = $this->database()->getType($tableName);
  3675. $table = ReflectedTable::fromReflection($this->db->reflection(), $tableName, $tableType);
  3676. $data = gzcompress(json_encode($table, JSON_UNESCAPED_UNICODE));
  3677. $this->cache->set($key, $data, $this->ttl);
  3678. }
  3679. return $table;
  3680. }
  3681. public function refreshTables()
  3682. {
  3683. $this->database = $this->loadDatabase(false);
  3684. }
  3685. public function refreshTable(string $tableName)
  3686. {
  3687. $this->tables[$tableName] = $this->loadTable($tableName, false);
  3688. }
  3689. public function hasTable(string $tableName): bool
  3690. {
  3691. return $this->database()->hasTable($tableName);
  3692. }
  3693. public function getType(string $tableName): string
  3694. {
  3695. return $this->database()->getType($tableName);
  3696. }
  3697. public function getTable(string $tableName): ReflectedTable
  3698. {
  3699. if (!isset($this->tables[$tableName])) {
  3700. $this->tables[$tableName] = $this->loadTable($tableName, true);
  3701. }
  3702. return $this->tables[$tableName];
  3703. }
  3704. public function getTableNames(): array
  3705. {
  3706. return $this->database()->getTableNames();
  3707. }
  3708. public function removeTable(string $tableName): bool
  3709. {
  3710. unset($this->tables[$tableName]);
  3711. return $this->database()->removeTable($tableName);
  3712. }
  3713. }
  3714. }
  3715. // file: src/Tqdev/PhpCrudApi/Controller/CacheController.php
  3716. namespace Tqdev\PhpCrudApi\Controller {
  3717. use Psr\Http\Message\ResponseInterface;
  3718. use Psr\Http\Message\ServerRequestInterface;
  3719. use Tqdev\PhpCrudApi\Cache\Cache;
  3720. use Tqdev\PhpCrudApi\Middleware\Router\Router;
  3721. class CacheController
  3722. {
  3723. private $cache;
  3724. private $responder;
  3725. public function __construct(Router $router, Responder $responder, Cache $cache)
  3726. {
  3727. $router->register('GET', '/cache/clear', array($this, 'clear'));
  3728. $this->cache = $cache;
  3729. $this->responder = $responder;
  3730. }
  3731. public function clear(ServerRequestInterface $request): ResponseInterface
  3732. {
  3733. return $this->responder->success($this->cache->clear());
  3734. }
  3735. }
  3736. }
  3737. // file: src/Tqdev/PhpCrudApi/Controller/ColumnController.php
  3738. namespace Tqdev\PhpCrudApi\Controller {
  3739. use Psr\Http\Message\ResponseInterface;
  3740. use Psr\Http\Message\ServerRequestInterface;
  3741. use Tqdev\PhpCrudApi\Column\DefinitionService;
  3742. use Tqdev\PhpCrudApi\Column\ReflectionService;
  3743. use Tqdev\PhpCrudApi\Middleware\Router\Router;
  3744. use Tqdev\PhpCrudApi\Record\ErrorCode;
  3745. use Tqdev\PhpCrudApi\RequestUtils;
  3746. class ColumnController
  3747. {
  3748. private $responder;
  3749. private $reflection;
  3750. private $definition;
  3751. public function __construct(Router $router, Responder $responder, ReflectionService $reflection, DefinitionService $definition)
  3752. {
  3753. $router->register('GET', '/columns', array($this, 'getDatabase'));
  3754. $router->register('GET', '/columns/*', array($this, 'getTable'));
  3755. $router->register('GET', '/columns/*/*', array($this, 'getColumn'));
  3756. $router->register('PUT', '/columns/*', array($this, 'updateTable'));
  3757. $router->register('PUT', '/columns/*/*', array($this, 'updateColumn'));
  3758. $router->register('POST', '/columns', array($this, 'addTable'));
  3759. $router->register('POST', '/columns/*', array($this, 'addColumn'));
  3760. $router->register('DELETE', '/columns/*', array($this, 'removeTable'));
  3761. $router->register('DELETE', '/columns/*/*', array($this, 'removeColumn'));
  3762. $this->responder = $responder;
  3763. $this->reflection = $reflection;
  3764. $this->definition = $definition;
  3765. }
  3766. public function getDatabase(ServerRequestInterface $request): ResponseInterface
  3767. {
  3768. $tables = [];
  3769. foreach ($this->reflection->getTableNames() as $table) {
  3770. $tables[] = $this->reflection->getTable($table);
  3771. }
  3772. $database = ['tables' => $tables];
  3773. return $this->responder->success($database);
  3774. }
  3775. public function getTable(ServerRequestInterface $request): ResponseInterface
  3776. {
  3777. $tableName = RequestUtils::getPathSegment($request, 2);
  3778. if (!$this->reflection->hasTable($tableName)) {
  3779. return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $tableName);
  3780. }
  3781. $table = $this->reflection->getTable($tableName);
  3782. return $this->responder->success($table);
  3783. }
  3784. public function getColumn(ServerRequestInterface $request): ResponseInterface
  3785. {
  3786. $tableName = RequestUtils::getPathSegment($request, 2);
  3787. $columnName = RequestUtils::getPathSegment($request, 3);
  3788. if (!$this->reflection->hasTable($tableName)) {
  3789. return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $tableName);
  3790. }
  3791. $table = $this->reflection->getTable($tableName);
  3792. if (!$table->hasColumn($columnName)) {
  3793. return $this->responder->error(ErrorCode::COLUMN_NOT_FOUND, $columnName);
  3794. }
  3795. $column = $table->getColumn($columnName);
  3796. return $this->responder->success($column);
  3797. }
  3798. public function updateTable(ServerRequestInterface $request): ResponseInterface
  3799. {
  3800. $tableName = RequestUtils::getPathSegment($request, 2);
  3801. if (!$this->reflection->hasTable($tableName)) {
  3802. return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $tableName);
  3803. }
  3804. $success = $this->definition->updateTable($tableName, $request->getParsedBody());
  3805. if ($success) {
  3806. $this->reflection->refreshTables();
  3807. }
  3808. return $this->responder->success($success);
  3809. }
  3810. public function updateColumn(ServerRequestInterface $request): ResponseInterface
  3811. {
  3812. $tableName = RequestUtils::getPathSegment($request, 2);
  3813. $columnName = RequestUtils::getPathSegment($request, 3);
  3814. if (!$this->reflection->hasTable($tableName)) {
  3815. return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $tableName);
  3816. }
  3817. $table = $this->reflection->getTable($tableName);
  3818. if (!$table->hasColumn($columnName)) {
  3819. return $this->responder->error(ErrorCode::COLUMN_NOT_FOUND, $columnName);
  3820. }
  3821. $success = $this->definition->updateColumn($tableName, $columnName, $request->getParsedBody());
  3822. if ($success) {
  3823. $this->reflection->refreshTable($tableName);
  3824. }
  3825. return $this->responder->success($success);
  3826. }
  3827. public function addTable(ServerRequestInterface $request): ResponseInterface
  3828. {
  3829. $tableName = $request->getParsedBody()->name;
  3830. if ($this->reflection->hasTable($tableName)) {
  3831. return $this->responder->error(ErrorCode::TABLE_ALREADY_EXISTS, $tableName);
  3832. }
  3833. $success = $this->definition->addTable($request->getParsedBody());
  3834. if ($success) {
  3835. $this->reflection->refreshTables();
  3836. }
  3837. return $this->responder->success($success);
  3838. }
  3839. public function addColumn(ServerRequestInterface $request): ResponseInterface
  3840. {
  3841. $tableName = RequestUtils::getPathSegment($request, 2);
  3842. if (!$this->reflection->hasTable($tableName)) {
  3843. return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $tableName);
  3844. }
  3845. $columnName = $request->getParsedBody()->name;
  3846. $table = $this->reflection->getTable($tableName);
  3847. if ($table->hasColumn($columnName)) {
  3848. return $this->responder->error(ErrorCode::COLUMN_ALREADY_EXISTS, $columnName);
  3849. }
  3850. $success = $this->definition->addColumn($tableName, $request->getParsedBody());
  3851. if ($success) {
  3852. $this->reflection->refreshTable($tableName);
  3853. }
  3854. return $this->responder->success($success);
  3855. }
  3856. public function removeTable(ServerRequestInterface $request): ResponseInterface
  3857. {
  3858. $tableName = RequestUtils::getPathSegment($request, 2);
  3859. if (!$this->reflection->hasTable($tableName)) {
  3860. return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $tableName);
  3861. }
  3862. $success = $this->definition->removeTable($tableName);
  3863. if ($success) {
  3864. $this->reflection->refreshTables();
  3865. }
  3866. return $this->responder->success($success);
  3867. }
  3868. public function removeColumn(ServerRequestInterface $request): ResponseInterface
  3869. {
  3870. $tableName = RequestUtils::getPathSegment($request, 2);
  3871. $columnName = RequestUtils::getPathSegment($request, 3);
  3872. if (!$this->reflection->hasTable($tableName)) {
  3873. return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $tableName);
  3874. }
  3875. $table = $this->reflection->getTable($tableName);
  3876. if (!$table->hasColumn($columnName)) {
  3877. return $this->responder->error(ErrorCode::COLUMN_NOT_FOUND, $columnName);
  3878. }
  3879. $success = $this->definition->removeColumn($tableName, $columnName);
  3880. if ($success) {
  3881. $this->reflection->refreshTable($tableName);
  3882. }
  3883. return $this->responder->success($success);
  3884. }
  3885. }
  3886. }
  3887. // file: src/Tqdev/PhpCrudApi/Controller/GeoJsonController.php
  3888. namespace Tqdev\PhpCrudApi\Controller {
  3889. use Psr\Http\Message\ResponseInterface;
  3890. use Psr\Http\Message\ServerRequestInterface;
  3891. use Tqdev\PhpCrudApi\GeoJson\GeoJsonService;
  3892. use Tqdev\PhpCrudApi\Middleware\Router\Router;
  3893. use Tqdev\PhpCrudApi\Record\ErrorCode;
  3894. use Tqdev\PhpCrudApi\RequestUtils;
  3895. class GeoJsonController
  3896. {
  3897. private $service;
  3898. private $responder;
  3899. public function __construct(Router $router, Responder $responder, GeoJsonService $service)
  3900. {
  3901. $router->register('GET', '/geojson/*', array($this, '_list'));
  3902. $router->register('GET', '/geojson/*/*', array($this, 'read'));
  3903. $this->service = $service;
  3904. $this->responder = $responder;
  3905. }
  3906. public function _list(ServerRequestInterface $request): ResponseInterface
  3907. {
  3908. $table = RequestUtils::getPathSegment($request, 2);
  3909. $params = RequestUtils::getParams($request);
  3910. if (!$this->service->hasTable($table)) {
  3911. return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $table);
  3912. }
  3913. return $this->responder->success($this->service->_list($table, $params));
  3914. }
  3915. public function read(ServerRequestInterface $request): ResponseInterface
  3916. {
  3917. $table = RequestUtils::getPathSegment($request, 2);
  3918. if (!$this->service->hasTable($table)) {
  3919. return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $table);
  3920. }
  3921. if ($this->service->getType($table) != 'table') {
  3922. return $this->responder->error(ErrorCode::OPERATION_NOT_SUPPORTED, __FUNCTION__);
  3923. }
  3924. $id = RequestUtils::getPathSegment($request, 3);
  3925. $params = RequestUtils::getParams($request);
  3926. if (strpos($id, ',') !== false) {
  3927. $ids = explode(',', $id);
  3928. $result = (object) array('type' => 'FeatureCollection', 'features' => array());
  3929. for ($i = 0; $i < count($ids); $i++) {
  3930. array_push($result->features, $this->service->read($table, $ids[$i], $params));
  3931. }
  3932. return $this->responder->success($result);
  3933. } else {
  3934. $response = $this->service->read($table, $id, $params);
  3935. if ($response === null) {
  3936. return $this->responder->error(ErrorCode::RECORD_NOT_FOUND, $id);
  3937. }
  3938. return $this->responder->success($response);
  3939. }
  3940. }
  3941. }
  3942. }
  3943. // file: src/Tqdev/PhpCrudApi/Controller/JsonResponder.php
  3944. namespace Tqdev\PhpCrudApi\Controller {
  3945. use Psr\Http\Message\ResponseInterface;
  3946. use Tqdev\PhpCrudApi\Record\Document\ErrorDocument;
  3947. use Tqdev\PhpCrudApi\Record\ErrorCode;
  3948. use Tqdev\PhpCrudApi\ResponseFactory;
  3949. class JsonResponder implements Responder
  3950. {
  3951. public function error(int $error, string $argument, $details = null): ResponseInterface
  3952. {
  3953. $errorCode = new ErrorCode($error);
  3954. $status = $errorCode->getStatus();
  3955. $document = new ErrorDocument($errorCode, $argument, $details);
  3956. return ResponseFactory::fromObject($status, $document);
  3957. }
  3958. public function success($result): ResponseInterface
  3959. {
  3960. return ResponseFactory::fromObject(ResponseFactory::OK, $result);
  3961. }
  3962. }
  3963. }
  3964. // file: src/Tqdev/PhpCrudApi/Controller/OpenApiController.php
  3965. namespace Tqdev\PhpCrudApi\Controller {
  3966. use Psr\Http\Message\ResponseInterface;
  3967. use Psr\Http\Message\ServerRequestInterface;
  3968. use Tqdev\PhpCrudApi\Middleware\Router\Router;
  3969. use Tqdev\PhpCrudApi\OpenApi\OpenApiService;
  3970. class OpenApiController
  3971. {
  3972. private $openApi;
  3973. private $responder;
  3974. public function __construct(Router $router, Responder $responder, OpenApiService $openApi)
  3975. {
  3976. $router->register('GET', '/openapi', array($this, 'openapi'));
  3977. $this->openApi = $openApi;
  3978. $this->responder = $responder;
  3979. }
  3980. public function openapi(ServerRequestInterface $request): ResponseInterface
  3981. {
  3982. return $this->responder->success($this->openApi->get());
  3983. }
  3984. }
  3985. }
  3986. // file: src/Tqdev/PhpCrudApi/Controller/RecordController.php
  3987. namespace Tqdev\PhpCrudApi\Controller {
  3988. use Psr\Http\Message\ResponseInterface;
  3989. use Psr\Http\Message\ServerRequestInterface;
  3990. use Tqdev\PhpCrudApi\Middleware\Router\Router;
  3991. use Tqdev\PhpCrudApi\Record\ErrorCode;
  3992. use Tqdev\PhpCrudApi\Record\RecordService;
  3993. use Tqdev\PhpCrudApi\RequestUtils;
  3994. class RecordController
  3995. {
  3996. private $service;
  3997. private $responder;
  3998. public function __construct(Router $router, Responder $responder, RecordService $service)
  3999. {
  4000. $router->register('GET', '/records/*', array($this, '_list'));
  4001. $router->register('POST', '/records/*', array($this, 'create'));
  4002. $router->register('GET', '/records/*/*', array($this, 'read'));
  4003. $router->register('PUT', '/records/*/*', array($this, 'update'));
  4004. $router->register('DELETE', '/records/*/*', array($this, 'delete'));
  4005. $router->register('PATCH', '/records/*/*', array($this, 'increment'));
  4006. $this->service = $service;
  4007. $this->responder = $responder;
  4008. }
  4009. public function _list(ServerRequestInterface $request): ResponseInterface
  4010. {
  4011. $table = RequestUtils::getPathSegment($request, 2);
  4012. $params = RequestUtils::getParams($request);
  4013. if (!$this->service->hasTable($table)) {
  4014. return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $table);
  4015. }
  4016. return $this->responder->success($this->service->_list($table, $params));
  4017. }
  4018. public function read(ServerRequestInterface $request): ResponseInterface
  4019. {
  4020. $table = RequestUtils::getPathSegment($request, 2);
  4021. if (!$this->service->hasTable($table)) {
  4022. return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $table);
  4023. }
  4024. $id = RequestUtils::getPathSegment($request, 3);
  4025. $params = RequestUtils::getParams($request);
  4026. if (strpos($id, ',') !== false) {
  4027. $ids = explode(',', $id);
  4028. $result = [];
  4029. for ($i = 0; $i < count($ids); $i++) {
  4030. array_push($result, $this->service->read($table, $ids[$i], $params));
  4031. }
  4032. return $this->responder->success($result);
  4033. } else {
  4034. $response = $this->service->read($table, $id, $params);
  4035. if ($response === null) {
  4036. return $this->responder->error(ErrorCode::RECORD_NOT_FOUND, $id);
  4037. }
  4038. return $this->responder->success($response);
  4039. }
  4040. }
  4041. public function create(ServerRequestInterface $request): ResponseInterface
  4042. {
  4043. $table = RequestUtils::getPathSegment($request, 2);
  4044. if (!$this->service->hasTable($table)) {
  4045. return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $table);
  4046. }
  4047. if ($this->service->getType($table) != 'table') {
  4048. return $this->responder->error(ErrorCode::OPERATION_NOT_SUPPORTED, __FUNCTION__);
  4049. }
  4050. $record = $request->getParsedBody();
  4051. if ($record === null) {
  4052. return $this->responder->error(ErrorCode::HTTP_MESSAGE_NOT_READABLE, '');
  4053. }
  4054. $params = RequestUtils::getParams($request);
  4055. if (is_array($record)) {
  4056. $result = array();
  4057. foreach ($record as $r) {
  4058. $result[] = $this->service->create($table, $r, $params);
  4059. }
  4060. return $this->responder->success($result);
  4061. } else {
  4062. return $this->responder->success($this->service->create($table, $record, $params));
  4063. }
  4064. }
  4065. public function update(ServerRequestInterface $request): ResponseInterface
  4066. {
  4067. $table = RequestUtils::getPathSegment($request, 2);
  4068. if (!$this->service->hasTable($table)) {
  4069. return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $table);
  4070. }
  4071. if ($this->service->getType($table) != 'table') {
  4072. return $this->responder->error(ErrorCode::OPERATION_NOT_SUPPORTED, __FUNCTION__);
  4073. }
  4074. $id = RequestUtils::getPathSegment($request, 3);
  4075. $params = RequestUtils::getParams($request);
  4076. $record = $request->getParsedBody();
  4077. if ($record === null) {
  4078. return $this->responder->error(ErrorCode::HTTP_MESSAGE_NOT_READABLE, '');
  4079. }
  4080. $ids = explode(',', $id);
  4081. if (is_array($record)) {
  4082. if (count($ids) != count($record)) {
  4083. return $this->responder->error(ErrorCode::ARGUMENT_COUNT_MISMATCH, $id);
  4084. }
  4085. $result = array();
  4086. for ($i = 0; $i < count($ids); $i++) {
  4087. $result[] = $this->service->update($table, $ids[$i], $record[$i], $params);
  4088. }
  4089. return $this->responder->success($result);
  4090. } else {
  4091. if (count($ids) != 1) {
  4092. return $this->responder->error(ErrorCode::ARGUMENT_COUNT_MISMATCH, $id);
  4093. }
  4094. return $this->responder->success($this->service->update($table, $id, $record, $params));
  4095. }
  4096. }
  4097. public function delete(ServerRequestInterface $request): ResponseInterface
  4098. {
  4099. $table = RequestUtils::getPathSegment($request, 2);
  4100. if (!$this->service->hasTable($table)) {
  4101. return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $table);
  4102. }
  4103. if ($this->service->getType($table) != 'table') {
  4104. return $this->responder->error(ErrorCode::OPERATION_NOT_SUPPORTED, __FUNCTION__);
  4105. }
  4106. $id = RequestUtils::getPathSegment($request, 3);
  4107. $params = RequestUtils::getParams($request);
  4108. $ids = explode(',', $id);
  4109. if (count($ids) > 1) {
  4110. $result = array();
  4111. for ($i = 0; $i < count($ids); $i++) {
  4112. $result[] = $this->service->delete($table, $ids[$i], $params);
  4113. }
  4114. return $this->responder->success($result);
  4115. } else {
  4116. return $this->responder->success($this->service->delete($table, $id, $params));
  4117. }
  4118. }
  4119. public function increment(ServerRequestInterface $request): ResponseInterface
  4120. {
  4121. $table = RequestUtils::getPathSegment($request, 2);
  4122. if (!$this->service->hasTable($table)) {
  4123. return $this->responder->error(ErrorCode::TABLE_NOT_FOUND, $table);
  4124. }
  4125. if ($this->service->getType($table) != 'table') {
  4126. return $this->responder->error(ErrorCode::OPERATION_NOT_SUPPORTED, __FUNCTION__);
  4127. }
  4128. $id = RequestUtils::getPathSegment($request, 3);
  4129. $record = $request->getParsedBody();
  4130. if ($record === null) {
  4131. return $this->responder->error(ErrorCode::HTTP_MESSAGE_NOT_READABLE, '');
  4132. }
  4133. $params = RequestUtils::getParams($request);
  4134. $ids = explode(',', $id);
  4135. if (is_array($record)) {
  4136. if (count($ids) != count($record)) {
  4137. return $this->responder->error(ErrorCode::ARGUMENT_COUNT_MISMATCH, $id);
  4138. }
  4139. $result = array();
  4140. for ($i = 0; $i < count($ids); $i++) {
  4141. $result[] = $this->service->increment($table, $ids[$i], $record[$i], $params);
  4142. }
  4143. return $this->responder->success($result);
  4144. } else {
  4145. if (count($ids) != 1) {
  4146. return $this->responder->error(ErrorCode::ARGUMENT_COUNT_MISMATCH, $id);
  4147. }
  4148. return $this->responder->success($this->service->increment($table, $id, $record, $params));
  4149. }
  4150. }
  4151. }
  4152. }
  4153. // file: src/Tqdev/PhpCrudApi/Controller/Responder.php
  4154. namespace Tqdev\PhpCrudApi\Controller {
  4155. use Psr\Http\Message\ResponseInterface;
  4156. interface Responder
  4157. {
  4158. public function error(int $error, string $argument, $details = null): ResponseInterface;
  4159. public function success($result): ResponseInterface;
  4160. }
  4161. }
  4162. // file: src/Tqdev/PhpCrudApi/Database/ColumnConverter.php
  4163. namespace Tqdev\PhpCrudApi\Database {
  4164. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedColumn;
  4165. class ColumnConverter
  4166. {
  4167. private $driver;
  4168. public function __construct(string $driver)
  4169. {
  4170. $this->driver = $driver;
  4171. }
  4172. public function convertColumnValue(ReflectedColumn $column): string
  4173. {
  4174. if ($column->isBoolean()) {
  4175. switch ($this->driver) {
  4176. case 'mysql':
  4177. return "IFNULL(IF(?,TRUE,FALSE),NULL)";
  4178. case 'pgsql':
  4179. return "?";
  4180. case 'sqlsrv':
  4181. return "?";
  4182. }
  4183. }
  4184. if ($column->isBinary()) {
  4185. switch ($this->driver) {
  4186. case 'mysql':
  4187. return "FROM_BASE64(?)";
  4188. case 'pgsql':
  4189. return "decode(?, 'base64')";
  4190. case 'sqlsrv':
  4191. return "CONVERT(XML, ?).value('.','varbinary(max)')";
  4192. }
  4193. }
  4194. if ($column->isGeometry()) {
  4195. switch ($this->driver) {
  4196. case 'mysql':
  4197. case 'pgsql':
  4198. return "ST_GeomFromText(?)";
  4199. case 'sqlsrv':
  4200. return "geometry::STGeomFromText(?,0)";
  4201. }
  4202. }
  4203. return '?';
  4204. }
  4205. public function convertColumnName(ReflectedColumn $column, $value): string
  4206. {
  4207. if ($column->isBinary()) {
  4208. switch ($this->driver) {
  4209. case 'mysql':
  4210. return "TO_BASE64($value) as $value";
  4211. case 'pgsql':
  4212. return "encode($value::bytea, 'base64') as $value";
  4213. case 'sqlsrv':
  4214. return "CASE WHEN $value IS NULL THEN NULL ELSE (SELECT CAST($value as varbinary(max)) FOR XML PATH(''), BINARY BASE64) END as $value";
  4215. }
  4216. }
  4217. if ($column->isGeometry()) {
  4218. switch ($this->driver) {
  4219. case 'mysql':
  4220. case 'pgsql':
  4221. return "ST_AsText($value) as $value";
  4222. case 'sqlsrv':
  4223. return "REPLACE($value.STAsText(),' (','(') as $value";
  4224. }
  4225. }
  4226. return $value;
  4227. }
  4228. }
  4229. }
  4230. // file: src/Tqdev/PhpCrudApi/Database/ColumnsBuilder.php
  4231. namespace Tqdev\PhpCrudApi\Database {
  4232. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedColumn;
  4233. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedTable;
  4234. class ColumnsBuilder
  4235. {
  4236. private $driver;
  4237. private $converter;
  4238. public function __construct(string $driver)
  4239. {
  4240. $this->driver = $driver;
  4241. $this->converter = new ColumnConverter($driver);
  4242. }
  4243. public function getOffsetLimit(int $offset, int $limit): string
  4244. {
  4245. if ($limit < 0 || $offset < 0) {
  4246. return '';
  4247. }
  4248. switch ($this->driver) {
  4249. case 'mysql':
  4250. return " LIMIT $offset, $limit";
  4251. case 'pgsql':
  4252. return " LIMIT $limit OFFSET $offset";
  4253. case 'sqlsrv':
  4254. return " OFFSET $offset ROWS FETCH NEXT $limit ROWS ONLY";
  4255. case 'sqlite':
  4256. return " LIMIT $limit OFFSET $offset";
  4257. }
  4258. }
  4259. private function quoteColumnName(ReflectedColumn $column): string
  4260. {
  4261. return '"' . $column->getName() . '"';
  4262. }
  4263. public function getOrderBy(ReflectedTable $table, array $columnOrdering): string
  4264. {
  4265. if (count($columnOrdering) == 0) {
  4266. return '';
  4267. }
  4268. $results = array();
  4269. foreach ($columnOrdering as $i => list($columnName, $ordering)) {
  4270. $column = $table->getColumn($columnName);
  4271. $quotedColumnName = $this->quoteColumnName($column);
  4272. $results[] = $quotedColumnName . ' ' . $ordering;
  4273. }
  4274. return ' ORDER BY ' . implode(',', $results);
  4275. }
  4276. public function getSelect(ReflectedTable $table, array $columnNames): string
  4277. {
  4278. $results = array();
  4279. foreach ($columnNames as $columnName) {
  4280. $column = $table->getColumn($columnName);
  4281. $quotedColumnName = $this->quoteColumnName($column);
  4282. $quotedColumnName = $this->converter->convertColumnName($column, $quotedColumnName);
  4283. $results[] = $quotedColumnName;
  4284. }
  4285. return implode(',', $results);
  4286. }
  4287. public function getInsert(ReflectedTable $table, array $columnValues): string
  4288. {
  4289. $columns = array();
  4290. $values = array();
  4291. foreach ($columnValues as $columnName => $columnValue) {
  4292. $column = $table->getColumn($columnName);
  4293. $quotedColumnName = $this->quoteColumnName($column);
  4294. $columns[] = $quotedColumnName;
  4295. $columnValue = $this->converter->convertColumnValue($column);
  4296. $values[] = $columnValue;
  4297. }
  4298. $columnsSql = '(' . implode(',', $columns) . ')';
  4299. $valuesSql = '(' . implode(',', $values) . ')';
  4300. $outputColumn = $this->quoteColumnName($table->getPk());
  4301. switch ($this->driver) {
  4302. case 'mysql':
  4303. return "$columnsSql VALUES $valuesSql";
  4304. case 'pgsql':
  4305. return "$columnsSql VALUES $valuesSql RETURNING $outputColumn";
  4306. case 'sqlsrv':
  4307. return "$columnsSql OUTPUT INSERTED.$outputColumn VALUES $valuesSql";
  4308. case 'sqlite':
  4309. return "$columnsSql VALUES $valuesSql";
  4310. }
  4311. }
  4312. public function getUpdate(ReflectedTable $table, array $columnValues): string
  4313. {
  4314. $results = array();
  4315. foreach ($columnValues as $columnName => $columnValue) {
  4316. $column = $table->getColumn($columnName);
  4317. $quotedColumnName = $this->quoteColumnName($column);
  4318. $columnValue = $this->converter->convertColumnValue($column);
  4319. $results[] = $quotedColumnName . '=' . $columnValue;
  4320. }
  4321. return implode(',', $results);
  4322. }
  4323. public function getIncrement(ReflectedTable $table, array $columnValues): string
  4324. {
  4325. $results = array();
  4326. foreach ($columnValues as $columnName => $columnValue) {
  4327. if (!is_numeric($columnValue)) {
  4328. continue;
  4329. }
  4330. $column = $table->getColumn($columnName);
  4331. $quotedColumnName = $this->quoteColumnName($column);
  4332. $columnValue = $this->converter->convertColumnValue($column);
  4333. $results[] = $quotedColumnName . '=' . $quotedColumnName . '+' . $columnValue;
  4334. }
  4335. return implode(',', $results);
  4336. }
  4337. }
  4338. }
  4339. // file: src/Tqdev/PhpCrudApi/Database/ConditionsBuilder.php
  4340. namespace Tqdev\PhpCrudApi\Database {
  4341. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedColumn;
  4342. use Tqdev\PhpCrudApi\Record\Condition\AndCondition;
  4343. use Tqdev\PhpCrudApi\Record\Condition\ColumnCondition;
  4344. use Tqdev\PhpCrudApi\Record\Condition\Condition;
  4345. use Tqdev\PhpCrudApi\Record\Condition\NoCondition;
  4346. use Tqdev\PhpCrudApi\Record\Condition\NotCondition;
  4347. use Tqdev\PhpCrudApi\Record\Condition\OrCondition;
  4348. use Tqdev\PhpCrudApi\Record\Condition\SpatialCondition;
  4349. class ConditionsBuilder
  4350. {
  4351. private $driver;
  4352. public function __construct(string $driver)
  4353. {
  4354. $this->driver = $driver;
  4355. }
  4356. private function getConditionSql(Condition $condition, array &$arguments): string
  4357. {
  4358. if ($condition instanceof AndCondition) {
  4359. return $this->getAndConditionSql($condition, $arguments);
  4360. }
  4361. if ($condition instanceof OrCondition) {
  4362. return $this->getOrConditionSql($condition, $arguments);
  4363. }
  4364. if ($condition instanceof NotCondition) {
  4365. return $this->getNotConditionSql($condition, $arguments);
  4366. }
  4367. if ($condition instanceof SpatialCondition) {
  4368. return $this->getSpatialConditionSql($condition, $arguments);
  4369. }
  4370. if ($condition instanceof ColumnCondition) {
  4371. return $this->getColumnConditionSql($condition, $arguments);
  4372. }
  4373. throw new \Exception('Unknown Condition: ' . get_class($condition));
  4374. }
  4375. private function getAndConditionSql(AndCondition $and, array &$arguments): string
  4376. {
  4377. $parts = [];
  4378. foreach ($and->getConditions() as $condition) {
  4379. $parts[] = $this->getConditionSql($condition, $arguments);
  4380. }
  4381. return '(' . implode(' AND ', $parts) . ')';
  4382. }
  4383. private function getOrConditionSql(OrCondition $or, array &$arguments): string
  4384. {
  4385. $parts = [];
  4386. foreach ($or->getConditions() as $condition) {
  4387. $parts[] = $this->getConditionSql($condition, $arguments);
  4388. }
  4389. return '(' . implode(' OR ', $parts) . ')';
  4390. }
  4391. private function getNotConditionSql(NotCondition $not, array &$arguments): string
  4392. {
  4393. $condition = $not->getCondition();
  4394. return '(NOT ' . $this->getConditionSql($condition, $arguments) . ')';
  4395. }
  4396. private function quoteColumnName(ReflectedColumn $column): string
  4397. {
  4398. return '"' . $column->getName() . '"';
  4399. }
  4400. private function escapeLikeValue(string $value): string
  4401. {
  4402. return addcslashes($value, '%_');
  4403. }
  4404. private function getColumnConditionSql(ColumnCondition $condition, array &$arguments): string
  4405. {
  4406. $column = $this->quoteColumnName($condition->getColumn());
  4407. $operator = $condition->getOperator();
  4408. $value = $condition->getValue();
  4409. switch ($operator) {
  4410. case 'cs':
  4411. $sql = "$column LIKE ?";
  4412. $arguments[] = '%' . $this->escapeLikeValue($value) . '%';
  4413. break;
  4414. case 'sw':
  4415. $sql = "$column LIKE ?";
  4416. $arguments[] = $this->escapeLikeValue($value) . '%';
  4417. break;
  4418. case 'ew':
  4419. $sql = "$column LIKE ?";
  4420. $arguments[] = '%' . $this->escapeLikeValue($value);
  4421. break;
  4422. case 'eq':
  4423. $sql = "$column = ?";
  4424. $arguments[] = $value;
  4425. break;
  4426. case 'lt':
  4427. $sql = "$column < ?";
  4428. $arguments[] = $value;
  4429. break;
  4430. case 'le':
  4431. $sql = "$column <= ?";
  4432. $arguments[] = $value;
  4433. break;
  4434. case 'ge':
  4435. $sql = "$column >= ?";
  4436. $arguments[] = $value;
  4437. break;
  4438. case 'gt':
  4439. $sql = "$column > ?";
  4440. $arguments[] = $value;
  4441. break;
  4442. case 'bt':
  4443. $parts = explode(',', $value, 2);
  4444. $count = count($parts);
  4445. if ($count == 2) {
  4446. $sql = "($column >= ? AND $column <= ?)";
  4447. $arguments[] = $parts[0];
  4448. $arguments[] = $parts[1];
  4449. } else {
  4450. $sql = "FALSE";
  4451. }
  4452. break;
  4453. case 'in':
  4454. $parts = explode(',', $value);
  4455. $count = count($parts);
  4456. if ($count > 0) {
  4457. $qmarks = implode(',', str_split(str_repeat('?', $count)));
  4458. $sql = "$column IN ($qmarks)";
  4459. for ($i = 0; $i < $count; $i++) {
  4460. $arguments[] = $parts[$i];
  4461. }
  4462. } else {
  4463. $sql = "FALSE";
  4464. }
  4465. break;
  4466. case 'is':
  4467. $sql = "$column IS NULL";
  4468. break;
  4469. }
  4470. return $sql;
  4471. }
  4472. private function getSpatialFunctionName(string $operator): string
  4473. {
  4474. switch ($operator) {
  4475. case 'co':
  4476. return 'ST_Contains';
  4477. case 'cr':
  4478. return 'ST_Crosses';
  4479. case 'di':
  4480. return 'ST_Disjoint';
  4481. case 'eq':
  4482. return 'ST_Equals';
  4483. case 'in':
  4484. return 'ST_Intersects';
  4485. case 'ov':
  4486. return 'ST_Overlaps';
  4487. case 'to':
  4488. return 'ST_Touches';
  4489. case 'wi':
  4490. return 'ST_Within';
  4491. case 'ic':
  4492. return 'ST_IsClosed';
  4493. case 'is':
  4494. return 'ST_IsSimple';
  4495. case 'iv':
  4496. return 'ST_IsValid';
  4497. }
  4498. }
  4499. private function hasSpatialArgument(string $operator): bool
  4500. {
  4501. return in_array($operator, ['ic', 'is', 'iv']) ? false : true;
  4502. }
  4503. private function getSpatialFunctionCall(string $functionName, string $column, bool $hasArgument): string
  4504. {
  4505. switch ($this->driver) {
  4506. case 'mysql':
  4507. case 'pgsql':
  4508. $argument = $hasArgument ? 'ST_GeomFromText(?)' : '';
  4509. return "$functionName($column, $argument)=TRUE";
  4510. case 'sqlsrv':
  4511. $functionName = str_replace('ST_', 'ST', $functionName);
  4512. $argument = $hasArgument ? 'geometry::STGeomFromText(?,0)' : '';
  4513. return "$column.$functionName($argument)=1";
  4514. case 'sqlite':
  4515. $argument = $hasArgument ? '?' : '0';
  4516. return "$functionName($column, $argument)=1";
  4517. }
  4518. }
  4519. private function getSpatialConditionSql(ColumnCondition $condition, array &$arguments): string
  4520. {
  4521. $column = $this->quoteColumnName($condition->getColumn());
  4522. $operator = $condition->getOperator();
  4523. $value = $condition->getValue();
  4524. $functionName = $this->getSpatialFunctionName($operator);
  4525. $hasArgument = $this->hasSpatialArgument($operator);
  4526. $sql = $this->getSpatialFunctionCall($functionName, $column, $hasArgument);
  4527. if ($hasArgument) {
  4528. $arguments[] = $value;
  4529. }
  4530. return $sql;
  4531. }
  4532. public function getWhereClause(Condition $condition, array &$arguments): string
  4533. {
  4534. if ($condition instanceof NoCondition) {
  4535. return '';
  4536. }
  4537. return ' WHERE ' . $this->getConditionSql($condition, $arguments);
  4538. }
  4539. }
  4540. }
  4541. // file: src/Tqdev/PhpCrudApi/Database/DataConverter.php
  4542. namespace Tqdev\PhpCrudApi\Database {
  4543. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedColumn;
  4544. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedTable;
  4545. class DataConverter
  4546. {
  4547. private $driver;
  4548. public function __construct(string $driver)
  4549. {
  4550. $this->driver = $driver;
  4551. }
  4552. private function convertRecordValue($conversion, $value)
  4553. {
  4554. $args = explode('|', $conversion);
  4555. $type = array_shift($args);
  4556. switch ($type) {
  4557. case 'boolean':
  4558. return $value ? true : false;
  4559. case 'integer':
  4560. return (int) $value;
  4561. case 'float':
  4562. return (float) $value;
  4563. case 'decimal':
  4564. return number_format($value, $args[0], '.', '');
  4565. }
  4566. return $value;
  4567. }
  4568. private function getRecordValueConversion(ReflectedColumn $column): string
  4569. {
  4570. if (in_array($this->driver, ['mysql', 'sqlsrv', 'sqlite']) && $column->isBoolean()) {
  4571. return 'boolean';
  4572. }
  4573. if (in_array($this->driver, ['sqlsrv', 'sqlite']) && in_array($column->getType(), ['integer', 'bigint'])) {
  4574. return 'integer';
  4575. }
  4576. if (in_array($this->driver, ['sqlite', 'pgsql']) && in_array($column->getType(), ['float', 'double'])) {
  4577. return 'float';
  4578. }
  4579. if (in_array($this->driver, ['sqlite']) && in_array($column->getType(), ['decimal'])) {
  4580. return 'decimal|' . $column->getScale();
  4581. }
  4582. return 'none';
  4583. }
  4584. public function convertRecords(ReflectedTable $table, array $columnNames, array &$records) /*: void*/
  4585. {
  4586. foreach ($columnNames as $columnName) {
  4587. $column = $table->getColumn($columnName);
  4588. $conversion = $this->getRecordValueConversion($column);
  4589. if ($conversion != 'none') {
  4590. foreach ($records as $i => $record) {
  4591. $value = $records[$i][$columnName];
  4592. if ($value === null) {
  4593. continue;
  4594. }
  4595. $records[$i][$columnName] = $this->convertRecordValue($conversion, $value);
  4596. }
  4597. }
  4598. }
  4599. }
  4600. private function convertInputValue($conversion, $value)
  4601. {
  4602. switch ($conversion) {
  4603. case 'boolean':
  4604. return $value ? 1 : 0;
  4605. case 'base64url_to_base64':
  4606. return str_pad(strtr($value, '-_', '+/'), ceil(strlen($value) / 4) * 4, '=', STR_PAD_RIGHT);
  4607. }
  4608. return $value;
  4609. }
  4610. private function getInputValueConversion(ReflectedColumn $column): string
  4611. {
  4612. if ($column->isBoolean()) {
  4613. return 'boolean';
  4614. }
  4615. if ($column->isBinary()) {
  4616. return 'base64url_to_base64';
  4617. }
  4618. return 'none';
  4619. }
  4620. public function convertColumnValues(ReflectedTable $table, array &$columnValues) /*: void*/
  4621. {
  4622. $columnNames = array_keys($columnValues);
  4623. foreach ($columnNames as $columnName) {
  4624. $column = $table->getColumn($columnName);
  4625. $conversion = $this->getInputValueConversion($column);
  4626. if ($conversion != 'none') {
  4627. $value = $columnValues[$columnName];
  4628. if ($value !== null) {
  4629. $columnValues[$columnName] = $this->convertInputValue($conversion, $value);
  4630. }
  4631. }
  4632. }
  4633. }
  4634. }
  4635. }
  4636. // file: src/Tqdev/PhpCrudApi/Database/GenericDB.php
  4637. namespace Tqdev\PhpCrudApi\Database {
  4638. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedTable;
  4639. use Tqdev\PhpCrudApi\Middleware\Communication\VariableStore;
  4640. use Tqdev\PhpCrudApi\Record\Condition\ColumnCondition;
  4641. use Tqdev\PhpCrudApi\Record\Condition\Condition;
  4642. class GenericDB
  4643. {
  4644. private $driver;
  4645. private $address;
  4646. private $port;
  4647. private $database;
  4648. private $tables;
  4649. private $username;
  4650. private $password;
  4651. private $pdo;
  4652. private $reflection;
  4653. private $definition;
  4654. private $conditions;
  4655. private $columns;
  4656. private $converter;
  4657. private function getDsn(): string
  4658. {
  4659. switch ($this->driver) {
  4660. case 'mysql':
  4661. return "$this->driver:host=$this->address;port=$this->port;dbname=$this->database;charset=utf8mb4";
  4662. case 'pgsql':
  4663. return "$this->driver:host=$this->address port=$this->port dbname=$this->database options='--client_encoding=UTF8'";
  4664. case 'sqlsrv':
  4665. return "$this->driver:Server=$this->address,$this->port;Database=$this->database";
  4666. case 'sqlite':
  4667. return "$this->driver:$this->address";
  4668. }
  4669. }
  4670. private function getCommands(): array
  4671. {
  4672. switch ($this->driver) {
  4673. case 'mysql':
  4674. return [
  4675. 'SET SESSION sql_warnings=1;',
  4676. 'SET NAMES utf8mb4;',
  4677. 'SET SESSION sql_mode = "ANSI,TRADITIONAL";',
  4678. ];
  4679. case 'pgsql':
  4680. return [
  4681. "SET NAMES 'UTF8';",
  4682. ];
  4683. case 'sqlsrv':
  4684. return [];
  4685. case 'sqlite':
  4686. return [
  4687. 'PRAGMA foreign_keys = on;',
  4688. ];
  4689. }
  4690. }
  4691. private function getOptions(): array
  4692. {
  4693. $options = array(
  4694. \PDO::ATTR_ERRMODE => \PDO::ERRMODE_EXCEPTION,
  4695. \PDO::ATTR_DEFAULT_FETCH_MODE => \PDO::FETCH_ASSOC,
  4696. );
  4697. switch ($this->driver) {
  4698. case 'mysql':
  4699. return $options + [
  4700. \PDO::ATTR_EMULATE_PREPARES => false,
  4701. \PDO::MYSQL_ATTR_FOUND_ROWS => true,
  4702. \PDO::ATTR_PERSISTENT => true,
  4703. ];
  4704. case 'pgsql':
  4705. return $options + [
  4706. \PDO::ATTR_EMULATE_PREPARES => false,
  4707. \PDO::ATTR_PERSISTENT => true,
  4708. ];
  4709. case 'sqlsrv':
  4710. return $options + [
  4711. \PDO::SQLSRV_ATTR_DIRECT_QUERY => false,
  4712. \PDO::SQLSRV_ATTR_FETCHES_NUMERIC_TYPE => true,
  4713. ];
  4714. case 'sqlite':
  4715. return $options + [];
  4716. }
  4717. }
  4718. private function initPdo(): bool
  4719. {
  4720. if ($this->pdo) {
  4721. $result = $this->pdo->reconstruct($this->getDsn(), $this->username, $this->password, $this->getOptions());
  4722. } else {
  4723. $this->pdo = new LazyPdo($this->getDsn(), $this->username, $this->password, $this->getOptions());
  4724. $result = true;
  4725. }
  4726. $commands = $this->getCommands();
  4727. foreach ($commands as $command) {
  4728. $this->pdo->addInitCommand($command);
  4729. }
  4730. $this->reflection = new GenericReflection($this->pdo, $this->driver, $this->database, $this->tables);
  4731. $this->definition = new GenericDefinition($this->pdo, $this->driver, $this->database, $this->tables);
  4732. $this->conditions = new ConditionsBuilder($this->driver);
  4733. $this->columns = new ColumnsBuilder($this->driver);
  4734. $this->converter = new DataConverter($this->driver);
  4735. return $result;
  4736. }
  4737. public function __construct(string $driver, string $address, int $port, string $database, array $tables, string $username, string $password)
  4738. {
  4739. $this->driver = $driver;
  4740. $this->address = $address;
  4741. $this->port = $port;
  4742. $this->database = $database;
  4743. $this->tables = $tables;
  4744. $this->username = $username;
  4745. $this->password = $password;
  4746. $this->initPdo();
  4747. }
  4748. public function reconstruct(string $driver, string $address, int $port, string $database, array $tables, string $username, string $password): bool
  4749. {
  4750. if ($driver) {
  4751. $this->driver = $driver;
  4752. }
  4753. if ($address) {
  4754. $this->address = $address;
  4755. }
  4756. if ($port) {
  4757. $this->port = $port;
  4758. }
  4759. if ($database) {
  4760. $this->database = $database;
  4761. }
  4762. if ($tables) {
  4763. $this->tables = $tables;
  4764. }
  4765. if ($username) {
  4766. $this->username = $username;
  4767. }
  4768. if ($password) {
  4769. $this->password = $password;
  4770. }
  4771. return $this->initPdo();
  4772. }
  4773. public function pdo(): LazyPdo
  4774. {
  4775. return $this->pdo;
  4776. }
  4777. public function reflection(): GenericReflection
  4778. {
  4779. return $this->reflection;
  4780. }
  4781. public function definition(): GenericDefinition
  4782. {
  4783. return $this->definition;
  4784. }
  4785. private function addMiddlewareConditions(string $tableName, Condition $condition): Condition
  4786. {
  4787. $condition1 = VariableStore::get("authorization.conditions.$tableName");
  4788. if ($condition1) {
  4789. $condition = $condition->_and($condition1);
  4790. }
  4791. $condition2 = VariableStore::get("multiTenancy.conditions.$tableName");
  4792. if ($condition2) {
  4793. $condition = $condition->_and($condition2);
  4794. }
  4795. return $condition;
  4796. }
  4797. public function createSingle(ReflectedTable $table, array $columnValues) /*: ?String*/
  4798. {
  4799. $this->converter->convertColumnValues($table, $columnValues);
  4800. $insertColumns = $this->columns->getInsert($table, $columnValues);
  4801. $tableName = $table->getName();
  4802. $pkName = $table->getPk()->getName();
  4803. $parameters = array_values($columnValues);
  4804. $sql = 'INSERT INTO "' . $tableName . '" ' . $insertColumns;
  4805. $stmt = $this->query($sql, $parameters);
  4806. // return primary key value if specified in the input
  4807. if (isset($columnValues[$pkName])) {
  4808. return $columnValues[$pkName];
  4809. }
  4810. // work around missing "returning" or "output" in mysql
  4811. switch ($this->driver) {
  4812. case 'mysql':
  4813. $stmt = $this->query('SELECT LAST_INSERT_ID()', []);
  4814. break;
  4815. case 'sqlite':
  4816. $stmt = $this->query('SELECT LAST_INSERT_ROWID()', []);
  4817. break;
  4818. }
  4819. $pkValue = $stmt->fetchColumn(0);
  4820. if ($this->driver == 'sqlsrv' && $table->getPk()->getType() == 'bigint') {
  4821. return (int) $pkValue;
  4822. }
  4823. if ($this->driver == 'sqlite' && in_array($table->getPk()->getType(), ['integer', 'bigint'])) {
  4824. return (int) $pkValue;
  4825. }
  4826. return $pkValue;
  4827. }
  4828. public function selectSingle(ReflectedTable $table, array $columnNames, string $id) /*: ?array*/
  4829. {
  4830. $selectColumns = $this->columns->getSelect($table, $columnNames);
  4831. $tableName = $table->getName();
  4832. $condition = new ColumnCondition($table->getPk(), 'eq', $id);
  4833. $condition = $this->addMiddlewareConditions($tableName, $condition);
  4834. $parameters = array();
  4835. $whereClause = $this->conditions->getWhereClause($condition, $parameters);
  4836. $sql = 'SELECT ' . $selectColumns . ' FROM "' . $tableName . '" ' . $whereClause;
  4837. $stmt = $this->query($sql, $parameters);
  4838. $record = $stmt->fetch() ?: null;
  4839. if ($record === null) {
  4840. return null;
  4841. }
  4842. $records = array($record);
  4843. $this->converter->convertRecords($table, $columnNames, $records);
  4844. return $records[0];
  4845. }
  4846. public function selectMultiple(ReflectedTable $table, array $columnNames, array $ids): array
  4847. {
  4848. if (count($ids) == 0) {
  4849. return [];
  4850. }
  4851. $selectColumns = $this->columns->getSelect($table, $columnNames);
  4852. $tableName = $table->getName();
  4853. $condition = new ColumnCondition($table->getPk(), 'in', implode(',', $ids));
  4854. $condition = $this->addMiddlewareConditions($tableName, $condition);
  4855. $parameters = array();
  4856. $whereClause = $this->conditions->getWhereClause($condition, $parameters);
  4857. $sql = 'SELECT ' . $selectColumns . ' FROM "' . $tableName . '" ' . $whereClause;
  4858. $stmt = $this->query($sql, $parameters);
  4859. $records = $stmt->fetchAll();
  4860. $this->converter->convertRecords($table, $columnNames, $records);
  4861. return $records;
  4862. }
  4863. public function selectCount(ReflectedTable $table, Condition $condition): int
  4864. {
  4865. $tableName = $table->getName();
  4866. $condition = $this->addMiddlewareConditions($tableName, $condition);
  4867. $parameters = array();
  4868. $whereClause = $this->conditions->getWhereClause($condition, $parameters);
  4869. $sql = 'SELECT COUNT(*) FROM "' . $tableName . '"' . $whereClause;
  4870. $stmt = $this->query($sql, $parameters);
  4871. return $stmt->fetchColumn(0);
  4872. }
  4873. public function selectAll(ReflectedTable $table, array $columnNames, Condition $condition, array $columnOrdering, int $offset, int $limit): array
  4874. {
  4875. if ($limit == 0) {
  4876. return array();
  4877. }
  4878. $selectColumns = $this->columns->getSelect($table, $columnNames);
  4879. $tableName = $table->getName();
  4880. $condition = $this->addMiddlewareConditions($tableName, $condition);
  4881. $parameters = array();
  4882. $whereClause = $this->conditions->getWhereClause($condition, $parameters);
  4883. $orderBy = $this->columns->getOrderBy($table, $columnOrdering);
  4884. $offsetLimit = $this->columns->getOffsetLimit($offset, $limit);
  4885. $sql = 'SELECT ' . $selectColumns . ' FROM "' . $tableName . '"' . $whereClause . $orderBy . $offsetLimit;
  4886. $stmt = $this->query($sql, $parameters);
  4887. $records = $stmt->fetchAll();
  4888. $this->converter->convertRecords($table, $columnNames, $records);
  4889. return $records;
  4890. }
  4891. public function updateSingle(ReflectedTable $table, array $columnValues, string $id)
  4892. {
  4893. if (count($columnValues) == 0) {
  4894. return 0;
  4895. }
  4896. $this->converter->convertColumnValues($table, $columnValues);
  4897. $updateColumns = $this->columns->getUpdate($table, $columnValues);
  4898. $tableName = $table->getName();
  4899. $condition = new ColumnCondition($table->getPk(), 'eq', $id);
  4900. $condition = $this->addMiddlewareConditions($tableName, $condition);
  4901. $parameters = array_values($columnValues);
  4902. $whereClause = $this->conditions->getWhereClause($condition, $parameters);
  4903. $sql = 'UPDATE "' . $tableName . '" SET ' . $updateColumns . $whereClause;
  4904. $stmt = $this->query($sql, $parameters);
  4905. return $stmt->rowCount();
  4906. }
  4907. public function deleteSingle(ReflectedTable $table, string $id)
  4908. {
  4909. $tableName = $table->getName();
  4910. $condition = new ColumnCondition($table->getPk(), 'eq', $id);
  4911. $condition = $this->addMiddlewareConditions($tableName, $condition);
  4912. $parameters = array();
  4913. $whereClause = $this->conditions->getWhereClause($condition, $parameters);
  4914. $sql = 'DELETE FROM "' . $tableName . '" ' . $whereClause;
  4915. $stmt = $this->query($sql, $parameters);
  4916. return $stmt->rowCount();
  4917. }
  4918. public function incrementSingle(ReflectedTable $table, array $columnValues, string $id)
  4919. {
  4920. if (count($columnValues) == 0) {
  4921. return 0;
  4922. }
  4923. $this->converter->convertColumnValues($table, $columnValues);
  4924. $updateColumns = $this->columns->getIncrement($table, $columnValues);
  4925. $tableName = $table->getName();
  4926. $condition = new ColumnCondition($table->getPk(), 'eq', $id);
  4927. $condition = $this->addMiddlewareConditions($tableName, $condition);
  4928. $parameters = array_values($columnValues);
  4929. $whereClause = $this->conditions->getWhereClause($condition, $parameters);
  4930. $sql = 'UPDATE "' . $tableName . '" SET ' . $updateColumns . $whereClause;
  4931. $stmt = $this->query($sql, $parameters);
  4932. return $stmt->rowCount();
  4933. }
  4934. private function query(string $sql, array $parameters): \PDOStatement
  4935. {
  4936. $stmt = $this->pdo->prepare($sql);
  4937. //echo "- $sql -- " . json_encode($parameters, JSON_UNESCAPED_UNICODE) . "\n";
  4938. $stmt->execute($parameters);
  4939. return $stmt;
  4940. }
  4941. public function getCacheKey(): string
  4942. {
  4943. return md5(json_encode([
  4944. $this->driver,
  4945. $this->address,
  4946. $this->port,
  4947. $this->database,
  4948. $this->tables,
  4949. $this->username
  4950. ]));
  4951. }
  4952. }
  4953. }
  4954. // file: src/Tqdev/PhpCrudApi/Database/GenericDefinition.php
  4955. namespace Tqdev\PhpCrudApi\Database {
  4956. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedColumn;
  4957. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedTable;
  4958. use Tqdev\PhpCrudApi\Database\LazyPdo;
  4959. class GenericDefinition
  4960. {
  4961. private $pdo;
  4962. private $driver;
  4963. private $database;
  4964. private $typeConverter;
  4965. private $reflection;
  4966. public function __construct(LazyPdo $pdo, string $driver, string $database, array $tables)
  4967. {
  4968. $this->pdo = $pdo;
  4969. $this->driver = $driver;
  4970. $this->database = $database;
  4971. $this->typeConverter = new TypeConverter($driver);
  4972. $this->reflection = new GenericReflection($pdo, $driver, $database, $tables);
  4973. }
  4974. private function quote(string $identifier): string
  4975. {
  4976. return '"' . str_replace('"', '', $identifier) . '"';
  4977. }
  4978. public function getColumnType(ReflectedColumn $column, bool $update): string
  4979. {
  4980. if ($this->driver == 'pgsql' && !$update && $column->getPk() && $this->canAutoIncrement($column)) {
  4981. return 'serial';
  4982. }
  4983. $type = $this->typeConverter->fromJdbc($column->getType());
  4984. if ($column->hasPrecision() && $column->hasScale()) {
  4985. $size = '(' . $column->getPrecision() . ',' . $column->getScale() . ')';
  4986. } elseif ($column->hasPrecision()) {
  4987. $size = '(' . $column->getPrecision() . ')';
  4988. } elseif ($column->hasLength()) {
  4989. $size = '(' . $column->getLength() . ')';
  4990. } else {
  4991. $size = '';
  4992. }
  4993. $null = $this->getColumnNullType($column, $update);
  4994. $auto = $this->getColumnAutoIncrement($column, $update);
  4995. return $type . $size . $null . $auto;
  4996. }
  4997. private function getPrimaryKey(string $tableName): string
  4998. {
  4999. $pks = $this->reflection->getTablePrimaryKeys($tableName);
  5000. if (count($pks) == 1) {
  5001. return $pks[0];
  5002. }
  5003. return "";
  5004. }
  5005. private function canAutoIncrement(ReflectedColumn $column): bool
  5006. {
  5007. return in_array($column->getType(), ['integer', 'bigint']);
  5008. }
  5009. private function getColumnAutoIncrement(ReflectedColumn $column, bool $update): string
  5010. {
  5011. if (!$this->canAutoIncrement($column)) {
  5012. return '';
  5013. }
  5014. switch ($this->driver) {
  5015. case 'mysql':
  5016. return $column->getPk() ? ' AUTO_INCREMENT' : '';
  5017. case 'pgsql':
  5018. case 'sqlsrv':
  5019. return $column->getPk() ? ' IDENTITY(1,1)' : '';
  5020. case 'sqlite':
  5021. return $column->getPk() ? ' AUTOINCREMENT' : '';
  5022. }
  5023. }
  5024. private function getColumnNullType(ReflectedColumn $column, bool $update): string
  5025. {
  5026. if ($this->driver == 'pgsql' && $update) {
  5027. return '';
  5028. }
  5029. return $column->getNullable() ? ' NULL' : ' NOT NULL';
  5030. }
  5031. private function getTableRenameSQL(string $tableName, string $newTableName): string
  5032. {
  5033. $p1 = $this->quote($tableName);
  5034. $p2 = $this->quote($newTableName);
  5035. switch ($this->driver) {
  5036. case 'mysql':
  5037. return "RENAME TABLE $p1 TO $p2";
  5038. case 'pgsql':
  5039. return "ALTER TABLE $p1 RENAME TO $p2";
  5040. case 'sqlsrv':
  5041. return "EXEC sp_rename $p1, $p2";
  5042. case 'sqlite':
  5043. return "ALTER TABLE $p1 RENAME TO $p2";
  5044. }
  5045. }
  5046. private function getColumnRenameSQL(string $tableName, string $columnName, ReflectedColumn $newColumn): string
  5047. {
  5048. $p1 = $this->quote($tableName);
  5049. $p2 = $this->quote($columnName);
  5050. $p3 = $this->quote($newColumn->getName());
  5051. switch ($this->driver) {
  5052. case 'mysql':
  5053. $p4 = $this->getColumnType($newColumn, true);
  5054. return "ALTER TABLE $p1 CHANGE $p2 $p3 $p4";
  5055. case 'pgsql':
  5056. return "ALTER TABLE $p1 RENAME COLUMN $p2 TO $p3";
  5057. case 'sqlsrv':
  5058. $p4 = $this->quote($tableName . '.' . $columnName);
  5059. return "EXEC sp_rename $p4, $p3, 'COLUMN'";
  5060. case 'sqlite':
  5061. return "ALTER TABLE $p1 RENAME COLUMN $p2 TO $p3";
  5062. }
  5063. }
  5064. private function getColumnRetypeSQL(string $tableName, string $columnName, ReflectedColumn $newColumn): string
  5065. {
  5066. $p1 = $this->quote($tableName);
  5067. $p2 = $this->quote($columnName);
  5068. $p3 = $this->quote($newColumn->getName());
  5069. $p4 = $this->getColumnType($newColumn, true);
  5070. switch ($this->driver) {
  5071. case 'mysql':
  5072. return "ALTER TABLE $p1 CHANGE $p2 $p3 $p4";
  5073. case 'pgsql':
  5074. return "ALTER TABLE $p1 ALTER COLUMN $p3 TYPE $p4";
  5075. case 'sqlsrv':
  5076. return "ALTER TABLE $p1 ALTER COLUMN $p3 $p4";
  5077. }
  5078. }
  5079. private function getSetColumnNullableSQL(string $tableName, string $columnName, ReflectedColumn $newColumn): string
  5080. {
  5081. $p1 = $this->quote($tableName);
  5082. $p2 = $this->quote($columnName);
  5083. $p3 = $this->quote($newColumn->getName());
  5084. $p4 = $this->getColumnType($newColumn, true);
  5085. switch ($this->driver) {
  5086. case 'mysql':
  5087. return "ALTER TABLE $p1 CHANGE $p2 $p3 $p4";
  5088. case 'pgsql':
  5089. $p5 = $newColumn->getNullable() ? 'DROP NOT NULL' : 'SET NOT NULL';
  5090. return "ALTER TABLE $p1 ALTER COLUMN $p2 $p5";
  5091. case 'sqlsrv':
  5092. return "ALTER TABLE $p1 ALTER COLUMN $p2 $p4";
  5093. }
  5094. }
  5095. private function getSetColumnPkConstraintSQL(string $tableName, string $columnName, ReflectedColumn $newColumn): string
  5096. {
  5097. $p1 = $this->quote($tableName);
  5098. $p2 = $this->quote($columnName);
  5099. $p3 = $this->quote($tableName . '_pkey');
  5100. switch ($this->driver) {
  5101. case 'mysql':
  5102. $p4 = $newColumn->getPk() ? "ADD PRIMARY KEY ($p2)" : 'DROP PRIMARY KEY';
  5103. return "ALTER TABLE $p1 $p4";
  5104. case 'pgsql':
  5105. case 'sqlsrv':
  5106. $p4 = $newColumn->getPk() ? "ADD CONSTRAINT $p3 PRIMARY KEY ($p2)" : "DROP CONSTRAINT $p3";
  5107. return "ALTER TABLE $p1 $p4";
  5108. }
  5109. }
  5110. private function getSetColumnPkSequenceSQL(string $tableName, string $columnName, ReflectedColumn $newColumn): string
  5111. {
  5112. $p1 = $this->quote($tableName);
  5113. $p2 = $this->quote($columnName);
  5114. $p3 = $this->quote($tableName . '_' . $columnName . '_seq');
  5115. switch ($this->driver) {
  5116. case 'mysql':
  5117. return "select 1";
  5118. case 'pgsql':
  5119. return $newColumn->getPk() ? "CREATE SEQUENCE $p3 OWNED BY $p1.$p2" : "DROP SEQUENCE $p3";
  5120. case 'sqlsrv':
  5121. return $newColumn->getPk() ? "CREATE SEQUENCE $p3" : "DROP SEQUENCE $p3";
  5122. }
  5123. }
  5124. private function getSetColumnPkSequenceStartSQL(string $tableName, string $columnName, ReflectedColumn $newColumn): string
  5125. {
  5126. $p1 = $this->quote($tableName);
  5127. $p2 = $this->quote($columnName);
  5128. switch ($this->driver) {
  5129. case 'mysql':
  5130. return "select 1";
  5131. case 'pgsql':
  5132. $p3 = $this->pdo->quote($tableName . '_' . $columnName . '_seq');
  5133. return "SELECT setval($p3, (SELECT max($p2)+1 FROM $p1));";
  5134. case 'sqlsrv':
  5135. $p3 = $this->quote($tableName . '_' . $columnName . '_seq');
  5136. $p4 = $this->pdo->query("SELECT max($p2)+1 FROM $p1")->fetchColumn();
  5137. return "ALTER SEQUENCE $p3 RESTART WITH $p4";
  5138. }
  5139. }
  5140. private function getSetColumnPkDefaultSQL(string $tableName, string $columnName, ReflectedColumn $newColumn): string
  5141. {
  5142. $p1 = $this->quote($tableName);
  5143. $p2 = $this->quote($columnName);
  5144. switch ($this->driver) {
  5145. case 'mysql':
  5146. $p3 = $this->quote($newColumn->getName());
  5147. $p4 = $this->getColumnType($newColumn, true);
  5148. return "ALTER TABLE $p1 CHANGE $p2 $p3 $p4";
  5149. case 'pgsql':
  5150. if ($newColumn->getPk()) {
  5151. $p3 = $this->pdo->quote($tableName . '_' . $columnName . '_seq');
  5152. $p4 = "SET DEFAULT nextval($p3)";
  5153. } else {
  5154. $p4 = 'DROP DEFAULT';
  5155. }
  5156. return "ALTER TABLE $p1 ALTER COLUMN $p2 $p4";
  5157. case 'sqlsrv':
  5158. $p3 = $this->quote($tableName . '_' . $columnName . '_seq');
  5159. $p4 = $this->quote($tableName . '_' . $columnName . '_def');
  5160. if ($newColumn->getPk()) {
  5161. return "ALTER TABLE $p1 ADD CONSTRAINT $p4 DEFAULT NEXT VALUE FOR $p3 FOR $p2";
  5162. } else {
  5163. return "ALTER TABLE $p1 DROP CONSTRAINT $p4";
  5164. }
  5165. }
  5166. }
  5167. private function getAddColumnFkConstraintSQL(string $tableName, string $columnName, ReflectedColumn $newColumn): string
  5168. {
  5169. $p1 = $this->quote($tableName);
  5170. $p2 = $this->quote($columnName);
  5171. $p3 = $this->quote($tableName . '_' . $columnName . '_fkey');
  5172. $p4 = $this->quote($newColumn->getFk());
  5173. $p5 = $this->quote($this->getPrimaryKey($newColumn->getFk()));
  5174. return "ALTER TABLE $p1 ADD CONSTRAINT $p3 FOREIGN KEY ($p2) REFERENCES $p4 ($p5)";
  5175. }
  5176. private function getRemoveColumnFkConstraintSQL(string $tableName, string $columnName, ReflectedColumn $newColumn): string
  5177. {
  5178. $p1 = $this->quote($tableName);
  5179. $p2 = $this->quote($tableName . '_' . $columnName . '_fkey');
  5180. switch ($this->driver) {
  5181. case 'mysql':
  5182. return "ALTER TABLE $p1 DROP FOREIGN KEY $p2";
  5183. case 'pgsql':
  5184. case 'sqlsrv':
  5185. return "ALTER TABLE $p1 DROP CONSTRAINT $p2";
  5186. }
  5187. }
  5188. private function getAddTableSQL(ReflectedTable $newTable): string
  5189. {
  5190. $tableName = $newTable->getName();
  5191. $p1 = $this->quote($tableName);
  5192. $fields = [];
  5193. $constraints = [];
  5194. foreach ($newTable->getColumnNames() as $columnName) {
  5195. $pkColumn = $this->getPrimaryKey($tableName);
  5196. $newColumn = $newTable->getColumn($columnName);
  5197. $f1 = $this->quote($columnName);
  5198. $f2 = $this->getColumnType($newColumn, false);
  5199. $f3 = $this->quote($tableName . '_' . $columnName . '_fkey');
  5200. $f4 = $this->quote($newColumn->getFk());
  5201. $f5 = $this->quote($this->getPrimaryKey($newColumn->getFk()));
  5202. $f6 = $this->quote($tableName . '_' . $pkColumn . '_pkey');
  5203. if ($this->driver == 'sqlite') {
  5204. if ($newColumn->getPk()) {
  5205. $f2 = str_replace('NULL', 'NULL PRIMARY KEY', $f2);
  5206. }
  5207. $fields[] = "$f1 $f2";
  5208. if ($newColumn->getFk()) {
  5209. $constraints[] = "FOREIGN KEY ($f1) REFERENCES $f4 ($f5)";
  5210. }
  5211. } else {
  5212. $fields[] = "$f1 $f2";
  5213. if ($newColumn->getPk()) {
  5214. $constraints[] = "CONSTRAINT $f6 PRIMARY KEY ($f1)";
  5215. }
  5216. if ($newColumn->getFk()) {
  5217. $constraints[] = "CONSTRAINT $f3 FOREIGN KEY ($f1) REFERENCES $f4 ($f5)";
  5218. }
  5219. }
  5220. }
  5221. $p2 = implode(',', array_merge($fields, $constraints));
  5222. return "CREATE TABLE $p1 ($p2);";
  5223. }
  5224. private function getAddColumnSQL(string $tableName, ReflectedColumn $newColumn): string
  5225. {
  5226. $p1 = $this->quote($tableName);
  5227. $p2 = $this->quote($newColumn->getName());
  5228. $p3 = $this->getColumnType($newColumn, false);
  5229. switch ($this->driver) {
  5230. case 'mysql':
  5231. case 'pgsql':
  5232. return "ALTER TABLE $p1 ADD COLUMN $p2 $p3";
  5233. case 'sqlsrv':
  5234. return "ALTER TABLE $p1 ADD $p2 $p3";
  5235. case 'sqlite':
  5236. return "ALTER TABLE $p1 ADD COLUMN $p2 $p3";
  5237. }
  5238. }
  5239. private function getRemoveTableSQL(string $tableName): string
  5240. {
  5241. $p1 = $this->quote($tableName);
  5242. switch ($this->driver) {
  5243. case 'mysql':
  5244. case 'pgsql':
  5245. return "DROP TABLE $p1 CASCADE;";
  5246. case 'sqlsrv':
  5247. return "DROP TABLE $p1;";
  5248. case 'sqlite':
  5249. return "DROP TABLE $p1;";
  5250. }
  5251. }
  5252. private function getRemoveColumnSQL(string $tableName, string $columnName): string
  5253. {
  5254. $p1 = $this->quote($tableName);
  5255. $p2 = $this->quote($columnName);
  5256. switch ($this->driver) {
  5257. case 'mysql':
  5258. case 'pgsql':
  5259. return "ALTER TABLE $p1 DROP COLUMN $p2 CASCADE;";
  5260. case 'sqlsrv':
  5261. return "ALTER TABLE $p1 DROP COLUMN $p2;";
  5262. case 'sqlite':
  5263. return "ALTER TABLE $p1 DROP COLUMN $p2;";
  5264. }
  5265. }
  5266. public function renameTable(string $tableName, string $newTableName)
  5267. {
  5268. $sql = $this->getTableRenameSQL($tableName, $newTableName);
  5269. return $this->query($sql, []);
  5270. }
  5271. public function renameColumn(string $tableName, string $columnName, ReflectedColumn $newColumn)
  5272. {
  5273. $sql = $this->getColumnRenameSQL($tableName, $columnName, $newColumn);
  5274. return $this->query($sql, []);
  5275. }
  5276. public function retypeColumn(string $tableName, string $columnName, ReflectedColumn $newColumn)
  5277. {
  5278. $sql = $this->getColumnRetypeSQL($tableName, $columnName, $newColumn);
  5279. return $this->query($sql, []);
  5280. }
  5281. public function setColumnNullable(string $tableName, string $columnName, ReflectedColumn $newColumn)
  5282. {
  5283. $sql = $this->getSetColumnNullableSQL($tableName, $columnName, $newColumn);
  5284. return $this->query($sql, []);
  5285. }
  5286. public function addColumnPrimaryKey(string $tableName, string $columnName, ReflectedColumn $newColumn)
  5287. {
  5288. $sql = $this->getSetColumnPkConstraintSQL($tableName, $columnName, $newColumn);
  5289. $this->query($sql, []);
  5290. if ($this->canAutoIncrement($newColumn)) {
  5291. $sql = $this->getSetColumnPkSequenceSQL($tableName, $columnName, $newColumn);
  5292. $this->query($sql, []);
  5293. $sql = $this->getSetColumnPkSequenceStartSQL($tableName, $columnName, $newColumn);
  5294. $this->query($sql, []);
  5295. $sql = $this->getSetColumnPkDefaultSQL($tableName, $columnName, $newColumn);
  5296. $this->query($sql, []);
  5297. }
  5298. return true;
  5299. }
  5300. public function removeColumnPrimaryKey(string $tableName, string $columnName, ReflectedColumn $newColumn)
  5301. {
  5302. if ($this->canAutoIncrement($newColumn)) {
  5303. $sql = $this->getSetColumnPkDefaultSQL($tableName, $columnName, $newColumn);
  5304. $this->query($sql, []);
  5305. $sql = $this->getSetColumnPkSequenceSQL($tableName, $columnName, $newColumn);
  5306. $this->query($sql, []);
  5307. }
  5308. $sql = $this->getSetColumnPkConstraintSQL($tableName, $columnName, $newColumn);
  5309. $this->query($sql, []);
  5310. return true;
  5311. }
  5312. public function addColumnForeignKey(string $tableName, string $columnName, ReflectedColumn $newColumn)
  5313. {
  5314. $sql = $this->getAddColumnFkConstraintSQL($tableName, $columnName, $newColumn);
  5315. return $this->query($sql, []);
  5316. }
  5317. public function removeColumnForeignKey(string $tableName, string $columnName, ReflectedColumn $newColumn)
  5318. {
  5319. $sql = $this->getRemoveColumnFkConstraintSQL($tableName, $columnName, $newColumn);
  5320. return $this->query($sql, []);
  5321. }
  5322. public function addTable(ReflectedTable $newTable)
  5323. {
  5324. $sql = $this->getAddTableSQL($newTable);
  5325. return $this->query($sql, []);
  5326. }
  5327. public function addColumn(string $tableName, ReflectedColumn $newColumn)
  5328. {
  5329. $sql = $this->getAddColumnSQL($tableName, $newColumn);
  5330. return $this->query($sql, []);
  5331. }
  5332. public function removeTable(string $tableName)
  5333. {
  5334. $sql = $this->getRemoveTableSQL($tableName);
  5335. return $this->query($sql, []);
  5336. }
  5337. public function removeColumn(string $tableName, string $columnName)
  5338. {
  5339. $sql = $this->getRemoveColumnSQL($tableName, $columnName);
  5340. return $this->query($sql, []);
  5341. }
  5342. private function query(string $sql, array $arguments): bool
  5343. {
  5344. $stmt = $this->pdo->prepare($sql);
  5345. // echo "- $sql -- " . json_encode($arguments) . "\n";
  5346. return $stmt->execute($arguments);
  5347. }
  5348. }
  5349. }
  5350. // file: src/Tqdev/PhpCrudApi/Database/GenericReflection.php
  5351. namespace Tqdev\PhpCrudApi\Database {
  5352. use Tqdev\PhpCrudApi\Database\LazyPdo;
  5353. class GenericReflection
  5354. {
  5355. private $pdo;
  5356. private $driver;
  5357. private $database;
  5358. private $tables;
  5359. private $typeConverter;
  5360. public function __construct(LazyPdo $pdo, string $driver, string $database, array $tables)
  5361. {
  5362. $this->pdo = $pdo;
  5363. $this->driver = $driver;
  5364. $this->database = $database;
  5365. $this->tables = $tables;
  5366. $this->typeConverter = new TypeConverter($driver);
  5367. }
  5368. public function getIgnoredTables(): array
  5369. {
  5370. switch ($this->driver) {
  5371. case 'mysql':
  5372. return [];
  5373. case 'pgsql':
  5374. return ['spatial_ref_sys', 'raster_columns', 'raster_overviews', 'geography_columns', 'geometry_columns'];
  5375. case 'sqlsrv':
  5376. return [];
  5377. case 'sqlite':
  5378. return [];
  5379. }
  5380. }
  5381. private function getTablesSQL(): string
  5382. {
  5383. switch ($this->driver) {
  5384. case 'mysql':
  5385. 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"';
  5386. case 'pgsql':
  5387. 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";';
  5388. case 'sqlsrv':
  5389. 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"';
  5390. case 'sqlite':
  5391. return 'SELECT t.name as "TABLE_NAME", t.type as "TABLE_TYPE" FROM sqlite_master t WHERE t.type IN (\'table\', \'view\') AND \'\' <> ? ORDER BY "TABLE_NAME"';
  5392. }
  5393. }
  5394. private function getTableColumnsSQL(): string
  5395. {
  5396. switch ($this->driver) {
  5397. case 'mysql':
  5398. return 'SELECT "COLUMN_NAME", "IS_NULLABLE", "DATA_TYPE", "CHARACTER_MAXIMUM_LENGTH" as "CHARACTER_MAXIMUM_LENGTH", "NUMERIC_PRECISION", "NUMERIC_SCALE", "COLUMN_TYPE" FROM "INFORMATION_SCHEMA"."COLUMNS" WHERE "TABLE_NAME" = ? AND "TABLE_SCHEMA" = ? ORDER BY "ORDINAL_POSITION"';
  5399. case 'pgsql':
  5400. return 'SELECT a.attname AS "COLUMN_NAME", case when a.attnotnull then \'NO\' else \'YES\' end as "IS_NULLABLE", pg_catalog.format_type(a.atttypid, -1) as "DATA_TYPE", case when a.atttypmod < 0 then NULL else a.atttypmod-4 end as "CHARACTER_MAXIMUM_LENGTH", case when a.atttypid != 1700 then NULL else ((a.atttypmod - 4) >> 16) & 65535 end as "NUMERIC_PRECISION", case when a.atttypid != 1700 then NULL else (a.atttypmod - 4) & 65535 end as "NUMERIC_SCALE", \'\' AS "COLUMN_TYPE" FROM pg_attribute a JOIN pg_class pgc ON pgc.oid = a.attrelid WHERE pgc.relname = ? AND \'\' <> ? AND a.attnum > 0 AND NOT a.attisdropped ORDER BY a.attnum;';
  5401. case 'sqlsrv':
  5402. return 'SELECT c.name AS "COLUMN_NAME", c.is_nullable AS "IS_NULLABLE", t.Name AS "DATA_TYPE", (c.max_length/2) AS "CHARACTER_MAXIMUM_LENGTH", c.precision AS "NUMERIC_PRECISION", c.scale AS "NUMERIC_SCALE", \'\' AS "COLUMN_TYPE" FROM sys.columns c INNER JOIN sys.types t ON c.user_type_id = t.user_type_id WHERE c.object_id = OBJECT_ID(?) AND \'\' <> ? ORDER BY c.column_id';
  5403. case 'sqlite':
  5404. return 'SELECT "name" AS "COLUMN_NAME", case when "notnull"==1 then \'no\' else \'yes\' end as "IS_NULLABLE", lower("type") AS "DATA_TYPE", 2147483647 AS "CHARACTER_MAXIMUM_LENGTH", 0 AS "NUMERIC_PRECISION", 0 AS "NUMERIC_SCALE", \'\' AS "COLUMN_TYPE" FROM pragma_table_info(?) WHERE \'\' <> ? ORDER BY "cid"';
  5405. }
  5406. }
  5407. private function getTablePrimaryKeysSQL(): string
  5408. {
  5409. switch ($this->driver) {
  5410. case 'mysql':
  5411. return 'SELECT "COLUMN_NAME" FROM "INFORMATION_SCHEMA"."KEY_COLUMN_USAGE" WHERE "CONSTRAINT_NAME" = \'PRIMARY\' AND "TABLE_NAME" = ? AND "TABLE_SCHEMA" = ?';
  5412. case 'pgsql':
  5413. 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\'';
  5414. case 'sqlsrv':
  5415. 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 \'\' <> ?';
  5416. case 'sqlite':
  5417. return 'SELECT "name" as "COLUMN_NAME" FROM pragma_table_info(?) WHERE "pk"=1 AND \'\' <> ?';
  5418. }
  5419. }
  5420. private function getTableForeignKeysSQL(): string
  5421. {
  5422. switch ($this->driver) {
  5423. case 'mysql':
  5424. 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" = ?';
  5425. case 'pgsql':
  5426. 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\'';
  5427. case 'sqlsrv':
  5428. 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 \'\' <> ?';
  5429. case 'sqlite':
  5430. return 'SELECT "from" AS "COLUMN_NAME", "table" AS "REFERENCED_TABLE_NAME" FROM pragma_foreign_key_list(?) WHERE \'\' <> ?';
  5431. }
  5432. }
  5433. public function getDatabaseName(): string
  5434. {
  5435. return $this->database;
  5436. }
  5437. public function getTables(): array
  5438. {
  5439. $sql = $this->getTablesSQL();
  5440. $results = $this->query($sql, [$this->database]);
  5441. $tables = $this->tables;
  5442. $results = array_filter($results, function ($v) use ($tables) {
  5443. return !$tables || in_array($v['TABLE_NAME'], $tables);
  5444. });
  5445. foreach ($results as &$result) {
  5446. $map = [];
  5447. switch ($this->driver) {
  5448. case 'mysql':
  5449. $map = ['BASE TABLE' => 'table', 'VIEW' => 'view'];
  5450. break;
  5451. case 'pgsql':
  5452. $map = ['r' => 'table', 'v' => 'view'];
  5453. break;
  5454. case 'sqlsrv':
  5455. $map = ['U' => 'table', 'V' => 'view'];
  5456. break;
  5457. case 'sqlite':
  5458. $map = ['table' => 'table', 'view' => 'view'];
  5459. break;
  5460. }
  5461. $result['TABLE_TYPE'] = $map[trim($result['TABLE_TYPE'])];
  5462. }
  5463. return $results;
  5464. }
  5465. public function getTableColumns(string $tableName, string $type): array
  5466. {
  5467. $sql = $this->getTableColumnsSQL();
  5468. $results = $this->query($sql, [$tableName, $this->database]);
  5469. if ($type == 'view') {
  5470. foreach ($results as &$result) {
  5471. $result['IS_NULLABLE'] = false;
  5472. }
  5473. }
  5474. if ($this->driver == 'mysql') {
  5475. foreach ($results as &$result) {
  5476. // mysql does not properly reflect display width of types
  5477. preg_match('|([a-z]+)(\(([0-9]+)(,([0-9]+))?\))?|', $result['DATA_TYPE'], $matches);
  5478. $result['DATA_TYPE'] = $matches[1];
  5479. if (!$result['CHARACTER_MAXIMUM_LENGTH']) {
  5480. if (isset($matches[3])) {
  5481. $result['NUMERIC_PRECISION'] = $matches[3];
  5482. }
  5483. if (isset($matches[5])) {
  5484. $result['NUMERIC_SCALE'] = $matches[5];
  5485. }
  5486. }
  5487. }
  5488. }
  5489. if ($this->driver == 'sqlite') {
  5490. foreach ($results as &$result) {
  5491. // sqlite does not properly reflect display width of types
  5492. preg_match('|([a-z]+)(\(([0-9]+)(,([0-9]+))?\))?|', $result['DATA_TYPE'], $matches);
  5493. if (isset($matches[1])) {
  5494. $result['DATA_TYPE'] = $matches[1];
  5495. } else {
  5496. $result['DATA_TYPE'] = 'integer';
  5497. }
  5498. if (isset($matches[5])) {
  5499. $result['NUMERIC_PRECISION'] = $matches[3];
  5500. $result['NUMERIC_SCALE'] = $matches[5];
  5501. } else if (isset($matches[3])) {
  5502. $result['CHARACTER_MAXIMUM_LENGTH'] = $matches[3];
  5503. }
  5504. }
  5505. }
  5506. return $results;
  5507. }
  5508. public function getTablePrimaryKeys(string $tableName): array
  5509. {
  5510. $sql = $this->getTablePrimaryKeysSQL();
  5511. $results = $this->query($sql, [$tableName, $this->database]);
  5512. $primaryKeys = [];
  5513. foreach ($results as $result) {
  5514. $primaryKeys[] = $result['COLUMN_NAME'];
  5515. }
  5516. return $primaryKeys;
  5517. }
  5518. public function getTableForeignKeys(string $tableName): array
  5519. {
  5520. $sql = $this->getTableForeignKeysSQL();
  5521. $results = $this->query($sql, [$tableName, $this->database]);
  5522. $foreignKeys = [];
  5523. foreach ($results as $result) {
  5524. $foreignKeys[$result['COLUMN_NAME']] = $result['REFERENCED_TABLE_NAME'];
  5525. }
  5526. return $foreignKeys;
  5527. }
  5528. public function toJdbcType(string $type, string $size): string
  5529. {
  5530. return $this->typeConverter->toJdbc($type, $size);
  5531. }
  5532. private function query(string $sql, array $parameters): array
  5533. {
  5534. $stmt = $this->pdo->prepare($sql);
  5535. //echo "- $sql -- " . json_encode($parameters, JSON_UNESCAPED_UNICODE) . "\n";
  5536. $stmt->execute($parameters);
  5537. return $stmt->fetchAll();
  5538. }
  5539. }
  5540. }
  5541. // file: src/Tqdev/PhpCrudApi/Database/LazyPdo.php
  5542. namespace Tqdev\PhpCrudApi\Database {
  5543. class LazyPdo extends \PDO
  5544. {
  5545. private $dsn;
  5546. private $user;
  5547. private $password;
  5548. private $options;
  5549. private $commands;
  5550. private $pdo = null;
  5551. public function __construct(string $dsn, /*?string*/ $user = null, /*?string*/ $password = null, array $options = array())
  5552. {
  5553. $this->dsn = $dsn;
  5554. $this->user = $user;
  5555. $this->password = $password;
  5556. $this->options = $options;
  5557. $this->commands = array();
  5558. // explicitly NOT calling super::__construct
  5559. }
  5560. public function addInitCommand(string $command)/*: void*/
  5561. {
  5562. $this->commands[] = $command;
  5563. }
  5564. private function pdo()
  5565. {
  5566. if (!$this->pdo) {
  5567. $this->pdo = new \PDO($this->dsn, $this->user, $this->password, $this->options);
  5568. foreach ($this->commands as $command) {
  5569. $this->pdo->query($command);
  5570. }
  5571. }
  5572. return $this->pdo;
  5573. }
  5574. public function reconstruct(string $dsn, /*?string*/ $user = null, /*?string*/ $password = null, array $options = array()): bool
  5575. {
  5576. $this->dsn = $dsn;
  5577. $this->user = $user;
  5578. $this->password = $password;
  5579. $this->options = $options;
  5580. $this->commands = array();
  5581. if ($this->pdo) {
  5582. $this->pdo = null;
  5583. return true;
  5584. }
  5585. return false;
  5586. }
  5587. public function inTransaction(): bool
  5588. {
  5589. // Do not call parent method if there is no pdo object
  5590. return $this->pdo && parent::inTransaction();
  5591. }
  5592. public function setAttribute($attribute, $value): bool
  5593. {
  5594. if ($this->pdo) {
  5595. return $this->pdo()->setAttribute($attribute, $value);
  5596. }
  5597. $this->options[$attribute] = $value;
  5598. return true;
  5599. }
  5600. public function getAttribute($attribute): mixed
  5601. {
  5602. return $this->pdo()->getAttribute($attribute);
  5603. }
  5604. public function beginTransaction(): bool
  5605. {
  5606. return $this->pdo()->beginTransaction();
  5607. }
  5608. public function commit(): bool
  5609. {
  5610. return $this->pdo()->commit();
  5611. }
  5612. public function rollBack(): bool
  5613. {
  5614. return $this->pdo()->rollBack();
  5615. }
  5616. public function errorCode(): mixed
  5617. {
  5618. return $this->pdo()->errorCode();
  5619. }
  5620. public function errorInfo(): array
  5621. {
  5622. return $this->pdo()->errorInfo();
  5623. }
  5624. public function exec($query): int
  5625. {
  5626. return $this->pdo()->exec($query);
  5627. }
  5628. public function prepare($statement, $options = array())
  5629. {
  5630. return $this->pdo()->prepare($statement, $options);
  5631. }
  5632. public function quote($string, $parameter_type = null): string
  5633. {
  5634. return $this->pdo()->quote($string, $parameter_type);
  5635. }
  5636. public function lastInsertId(/* ?string */$name = null): string
  5637. {
  5638. return $this->pdo()->lastInsertId($name);
  5639. }
  5640. public function query(string $statement): \PDOStatement
  5641. {
  5642. return call_user_func_array(array($this->pdo(), 'query'), func_get_args());
  5643. }
  5644. }
  5645. }
  5646. // file: src/Tqdev/PhpCrudApi/Database/TypeConverter.php
  5647. namespace Tqdev\PhpCrudApi\Database {
  5648. class TypeConverter
  5649. {
  5650. private $driver;
  5651. public function __construct(string $driver)
  5652. {
  5653. $this->driver = $driver;
  5654. }
  5655. private $fromJdbc = [
  5656. 'mysql' => [
  5657. 'clob' => 'longtext',
  5658. 'boolean' => 'tinyint(1)',
  5659. 'blob' => 'longblob',
  5660. 'timestamp' => 'datetime',
  5661. ],
  5662. 'pgsql' => [
  5663. 'clob' => 'text',
  5664. 'blob' => 'bytea',
  5665. 'float' => 'real',
  5666. 'double' => 'double precision',
  5667. 'varbinary' => 'bytea',
  5668. ],
  5669. 'sqlsrv' => [
  5670. 'boolean' => 'bit',
  5671. 'varchar' => 'nvarchar',
  5672. 'clob' => 'ntext',
  5673. 'blob' => 'image',
  5674. 'time' => 'time(0)',
  5675. 'timestamp' => 'datetime2(0)',
  5676. 'double' => 'float',
  5677. 'float' => 'real',
  5678. ],
  5679. ];
  5680. private $toJdbc = [
  5681. 'simplified' => [
  5682. 'char' => 'varchar',
  5683. 'longvarchar' => 'clob',
  5684. 'nchar' => 'varchar',
  5685. 'nvarchar' => 'varchar',
  5686. 'longnvarchar' => 'clob',
  5687. 'binary' => 'varbinary',
  5688. 'longvarbinary' => 'blob',
  5689. 'tinyint' => 'integer',
  5690. 'smallint' => 'integer',
  5691. 'real' => 'float',
  5692. 'numeric' => 'decimal',
  5693. 'nclob' => 'clob',
  5694. 'time_with_timezone' => 'time',
  5695. 'timestamp_with_timezone' => 'timestamp',
  5696. ],
  5697. 'mysql' => [
  5698. 'tinyint(1)' => 'boolean',
  5699. 'bit(1)' => 'boolean',
  5700. 'tinyblob' => 'blob',
  5701. 'mediumblob' => 'blob',
  5702. 'longblob' => 'blob',
  5703. 'tinytext' => 'clob',
  5704. 'mediumtext' => 'clob',
  5705. 'longtext' => 'clob',
  5706. 'text' => 'clob',
  5707. 'mediumint' => 'integer',
  5708. 'int' => 'integer',
  5709. 'polygon' => 'geometry',
  5710. 'point' => 'geometry',
  5711. 'datetime' => 'timestamp',
  5712. 'year' => 'integer',
  5713. 'enum' => 'varchar',
  5714. 'set' => 'varchar',
  5715. 'json' => 'clob',
  5716. ],
  5717. 'pgsql' => [
  5718. 'bigserial' => 'bigint',
  5719. 'bit varying' => 'bit',
  5720. 'box' => 'geometry',
  5721. 'bytea' => 'blob',
  5722. 'bpchar' => 'char',
  5723. 'character varying' => 'varchar',
  5724. 'character' => 'char',
  5725. 'cidr' => 'varchar',
  5726. 'circle' => 'geometry',
  5727. 'double precision' => 'double',
  5728. 'inet' => 'integer',
  5729. //'interval [ fields ]'
  5730. 'json' => 'clob',
  5731. 'jsonb' => 'clob',
  5732. 'line' => 'geometry',
  5733. 'lseg' => 'geometry',
  5734. 'macaddr' => 'varchar',
  5735. 'money' => 'decimal',
  5736. 'path' => 'geometry',
  5737. 'point' => 'geometry',
  5738. 'polygon' => 'geometry',
  5739. 'real' => 'float',
  5740. 'serial' => 'integer',
  5741. 'text' => 'clob',
  5742. 'time without time zone' => 'time',
  5743. 'time with time zone' => 'time_with_timezone',
  5744. 'timestamp without time zone' => 'timestamp',
  5745. 'timestamp with time zone' => 'timestamp_with_timezone',
  5746. //'tsquery'=
  5747. //'tsvector'
  5748. //'txid_snapshot'
  5749. 'uuid' => 'char',
  5750. 'xml' => 'clob',
  5751. ],
  5752. // source: https://docs.microsoft.com/en-us/sql/connect/jdbc/using-basic-data-types?view=sql-server-2017
  5753. 'sqlsrv' => [
  5754. 'varbinary()' => 'blob',
  5755. 'bit' => 'boolean',
  5756. 'datetime' => 'timestamp',
  5757. 'datetime2' => 'timestamp',
  5758. 'float' => 'double',
  5759. 'image' => 'blob',
  5760. 'int' => 'integer',
  5761. 'money' => 'decimal',
  5762. 'ntext' => 'clob',
  5763. 'smalldatetime' => 'timestamp',
  5764. 'smallmoney' => 'decimal',
  5765. 'text' => 'clob',
  5766. 'timestamp' => 'binary',
  5767. 'udt' => 'varbinary',
  5768. 'uniqueidentifier' => 'char',
  5769. 'xml' => 'clob',
  5770. ],
  5771. 'sqlite' => [
  5772. 'tinytext' => 'clob',
  5773. 'text' => 'clob',
  5774. 'mediumtext' => 'clob',
  5775. 'longtext' => 'clob',
  5776. 'mediumint' => 'integer',
  5777. 'int' => 'integer',
  5778. 'bigint' => 'bigint',
  5779. 'int2' => 'smallint',
  5780. 'int4' => 'integer',
  5781. 'int8' => 'bigint',
  5782. 'double precision' => 'double',
  5783. 'datetime' => 'timestamp'
  5784. ],
  5785. ];
  5786. // source: https://docs.oracle.com/javase/9/docs/api/java/sql/Types.html
  5787. private $valid = [
  5788. //'array' => true,
  5789. 'bigint' => true,
  5790. 'binary' => true,
  5791. 'bit' => true,
  5792. 'blob' => true,
  5793. 'boolean' => true,
  5794. 'char' => true,
  5795. 'clob' => true,
  5796. //'datalink' => true,
  5797. 'date' => true,
  5798. 'decimal' => true,
  5799. //'distinct' => true,
  5800. 'double' => true,
  5801. 'float' => true,
  5802. 'integer' => true,
  5803. //'java_object' => true,
  5804. 'longnvarchar' => true,
  5805. 'longvarbinary' => true,
  5806. 'longvarchar' => true,
  5807. 'nchar' => true,
  5808. 'nclob' => true,
  5809. //'null' => true,
  5810. 'numeric' => true,
  5811. 'nvarchar' => true,
  5812. //'other' => true,
  5813. 'real' => true,
  5814. //'ref' => true,
  5815. //'ref_cursor' => true,
  5816. //'rowid' => true,
  5817. 'smallint' => true,
  5818. //'sqlxml' => true,
  5819. //'struct' => true,
  5820. 'time' => true,
  5821. 'time_with_timezone' => true,
  5822. 'timestamp' => true,
  5823. 'timestamp_with_timezone' => true,
  5824. 'tinyint' => true,
  5825. 'varbinary' => true,
  5826. 'varchar' => true,
  5827. // extra:
  5828. 'geometry' => true,
  5829. ];
  5830. public function toJdbc(string $type, string $size): string
  5831. {
  5832. $jdbcType = strtolower($type);
  5833. if (isset($this->toJdbc[$this->driver]["$jdbcType($size)"])) {
  5834. $jdbcType = $this->toJdbc[$this->driver]["$jdbcType($size)"];
  5835. }
  5836. if (isset($this->toJdbc[$this->driver][$jdbcType])) {
  5837. $jdbcType = $this->toJdbc[$this->driver][$jdbcType];
  5838. }
  5839. if (isset($this->toJdbc['simplified'][$jdbcType])) {
  5840. $jdbcType = $this->toJdbc['simplified'][$jdbcType];
  5841. }
  5842. if (!isset($this->valid[$jdbcType])) {
  5843. //throw new \Exception("Unsupported type '$jdbcType' for driver '$this->driver'");
  5844. $jdbcType = 'clob';
  5845. }
  5846. return $jdbcType;
  5847. }
  5848. public function fromJdbc(string $type): string
  5849. {
  5850. $jdbcType = strtolower($type);
  5851. if (isset($this->fromJdbc[$this->driver][$jdbcType])) {
  5852. $jdbcType = $this->fromJdbc[$this->driver][$jdbcType];
  5853. }
  5854. return $jdbcType;
  5855. }
  5856. }
  5857. }
  5858. // file: src/Tqdev/PhpCrudApi/GeoJson/Feature.php
  5859. namespace Tqdev\PhpCrudApi\GeoJson {
  5860. class Feature implements \JsonSerializable
  5861. {
  5862. private $id;
  5863. private $properties;
  5864. private $geometry;
  5865. public function __construct($id, array $properties, /*?Geometry*/ $geometry)
  5866. {
  5867. $this->id = $id;
  5868. $this->properties = $properties;
  5869. $this->geometry = $geometry;
  5870. }
  5871. public function serialize()
  5872. {
  5873. return [
  5874. 'type' => 'Feature',
  5875. 'id' => $this->id,
  5876. 'properties' => $this->properties,
  5877. 'geometry' => $this->geometry,
  5878. ];
  5879. }
  5880. public function jsonSerialize()
  5881. {
  5882. return $this->serialize();
  5883. }
  5884. }
  5885. }
  5886. // file: src/Tqdev/PhpCrudApi/GeoJson/FeatureCollection.php
  5887. namespace Tqdev\PhpCrudApi\GeoJson {
  5888. class FeatureCollection implements \JsonSerializable
  5889. {
  5890. private $features;
  5891. private $results;
  5892. public function __construct(array $features, int $results)
  5893. {
  5894. $this->features = $features;
  5895. $this->results = $results;
  5896. }
  5897. public function serialize()
  5898. {
  5899. return [
  5900. 'type' => 'FeatureCollection',
  5901. 'features' => $this->features,
  5902. 'results' => $this->results,
  5903. ];
  5904. }
  5905. public function jsonSerialize()
  5906. {
  5907. return array_filter($this->serialize(), function ($v) {
  5908. return $v !== 0;
  5909. });
  5910. }
  5911. }
  5912. }
  5913. // file: src/Tqdev/PhpCrudApi/GeoJson/GeoJsonService.php
  5914. namespace Tqdev\PhpCrudApi\GeoJson {
  5915. use Tqdev\PhpCrudApi\Column\ReflectionService;
  5916. use Tqdev\PhpCrudApi\GeoJson\FeatureCollection;
  5917. use Tqdev\PhpCrudApi\Record\RecordService;
  5918. class GeoJsonService
  5919. {
  5920. private $reflection;
  5921. private $records;
  5922. public function __construct(ReflectionService $reflection, RecordService $records)
  5923. {
  5924. $this->reflection = $reflection;
  5925. $this->records = $records;
  5926. }
  5927. public function hasTable(string $table): bool
  5928. {
  5929. return $this->reflection->hasTable($table);
  5930. }
  5931. public function getType(string $table): string
  5932. {
  5933. return $this->reflection->getType($table);
  5934. }
  5935. private function getGeometryColumnName(string $tableName, array &$params): string
  5936. {
  5937. $geometryParam = isset($params['geometry']) ? $params['geometry'][0] : '';
  5938. $table = $this->reflection->getTable($tableName);
  5939. $geometryColumnName = '';
  5940. foreach ($table->getColumnNames() as $columnName) {
  5941. if ($geometryParam && $geometryParam != $columnName) {
  5942. continue;
  5943. }
  5944. $column = $table->getColumn($columnName);
  5945. if ($column->isGeometry()) {
  5946. $geometryColumnName = $columnName;
  5947. break;
  5948. }
  5949. }
  5950. if ($geometryColumnName) {
  5951. $params['mandatory'][] = $tableName . "." . $geometryColumnName;
  5952. }
  5953. return $geometryColumnName;
  5954. }
  5955. private function setBoudingBoxFilter(string $geometryColumnName, array &$params)
  5956. {
  5957. $boundingBox = isset($params['bbox']) ? $params['bbox'][0] : '';
  5958. if ($boundingBox) {
  5959. $c = explode(',', $boundingBox);
  5960. if (!isset($params['filter'])) {
  5961. $params['filter'] = array();
  5962. }
  5963. $params['filter'][] = "$geometryColumnName,sin,POLYGON(($c[0] $c[1],$c[2] $c[1],$c[2] $c[3],$c[0] $c[3],$c[0] $c[1]))";
  5964. }
  5965. $tile = isset($params['tile']) ? $params['tile'][0] : '';
  5966. if ($tile) {
  5967. $zxy = explode(',', $tile);
  5968. if (count($zxy) == 3) {
  5969. list($z, $x, $y) = $zxy;
  5970. $c = array();
  5971. $c = array_merge($c, $this->convertTileToLatLonOfUpperLeftCorner($z, $x, $y));
  5972. $c = array_merge($c, $this->convertTileToLatLonOfUpperLeftCorner($z, $x + 1, $y + 1));
  5973. $params['filter'][] = "$geometryColumnName,sin,POLYGON(($c[0] $c[1],$c[2] $c[1],$c[2] $c[3],$c[0] $c[3],$c[0] $c[1]))";
  5974. }
  5975. }
  5976. }
  5977. private function convertTileToLatLonOfUpperLeftCorner($z, $x, $y): array
  5978. {
  5979. $n = pow(2, $z);
  5980. $lon = $x / $n * 360.0 - 180.0;
  5981. $lat = rad2deg(atan(sinh(pi() * (1 - 2 * $y / $n))));
  5982. return [$lon, $lat];
  5983. }
  5984. private function convertRecordToFeature(/*object*/$record, string $primaryKeyColumnName, string $geometryColumnName)
  5985. {
  5986. $id = null;
  5987. if ($primaryKeyColumnName) {
  5988. $id = $record[$primaryKeyColumnName];
  5989. }
  5990. $geometry = null;
  5991. if (isset($record[$geometryColumnName])) {
  5992. $geometry = Geometry::fromWkt($record[$geometryColumnName]);
  5993. }
  5994. $properties = array_diff_key($record, [$primaryKeyColumnName => true, $geometryColumnName => true]);
  5995. return new Feature($id, $properties, $geometry);
  5996. }
  5997. private function getPrimaryKeyColumnName(string $tableName, array &$params): string
  5998. {
  5999. $primaryKeyColumn = $this->reflection->getTable($tableName)->getPk();
  6000. if (!$primaryKeyColumn) {
  6001. return '';
  6002. }
  6003. $primaryKeyColumnName = $primaryKeyColumn->getName();
  6004. $params['mandatory'][] = $tableName . "." . $primaryKeyColumnName;
  6005. return $primaryKeyColumnName;
  6006. }
  6007. public function _list(string $tableName, array $params): FeatureCollection
  6008. {
  6009. $geometryColumnName = $this->getGeometryColumnName($tableName, $params);
  6010. $this->setBoudingBoxFilter($geometryColumnName, $params);
  6011. $primaryKeyColumnName = $this->getPrimaryKeyColumnName($tableName, $params);
  6012. $records = $this->records->_list($tableName, $params);
  6013. $features = array();
  6014. foreach ($records->getRecords() as $record) {
  6015. $features[] = $this->convertRecordToFeature($record, $primaryKeyColumnName, $geometryColumnName);
  6016. }
  6017. return new FeatureCollection($features, $records->getResults());
  6018. }
  6019. public function read(string $tableName, string $id, array $params): Feature
  6020. {
  6021. $geometryColumnName = $this->getGeometryColumnName($tableName, $params);
  6022. $primaryKeyColumnName = $this->getPrimaryKeyColumnName($tableName, $params);
  6023. $record = $this->records->read($tableName, $id, $params);
  6024. return $this->convertRecordToFeature($record, $primaryKeyColumnName, $geometryColumnName);
  6025. }
  6026. }
  6027. }
  6028. // file: src/Tqdev/PhpCrudApi/GeoJson/Geometry.php
  6029. namespace Tqdev\PhpCrudApi\GeoJson {
  6030. class Geometry implements \JsonSerializable
  6031. {
  6032. private $type;
  6033. private $geometry;
  6034. public static $types = [
  6035. "Point",
  6036. "MultiPoint",
  6037. "LineString",
  6038. "MultiLineString",
  6039. "Polygon",
  6040. "MultiPolygon",
  6041. //"GeometryCollection",
  6042. ];
  6043. public function __construct(string $type, array $coordinates)
  6044. {
  6045. $this->type = $type;
  6046. $this->coordinates = $coordinates;
  6047. }
  6048. public static function fromWkt(string $wkt): Geometry
  6049. {
  6050. $bracket = strpos($wkt, '(');
  6051. $type = strtoupper(trim(substr($wkt, 0, $bracket)));
  6052. $supported = false;
  6053. foreach (Geometry::$types as $typeName) {
  6054. if (strtoupper($typeName) == $type) {
  6055. $type = $typeName;
  6056. $supported = true;
  6057. }
  6058. }
  6059. if (!$supported) {
  6060. throw new \Exception('Geometry type not supported: ' . $type);
  6061. }
  6062. $coordinates = substr($wkt, $bracket);
  6063. if (substr($type, -5) != 'Point' || ($type == 'MultiPoint' && $coordinates[1] != '(')) {
  6064. $coordinates = preg_replace('|([0-9\-\.]+ )+([0-9\-\.]+)|', '[\1\2]', $coordinates);
  6065. }
  6066. $coordinates = str_replace(['(', ')', ', ', ' '], ['[', ']', ',', ','], $coordinates);
  6067. $coordinates = json_decode($coordinates);
  6068. if (!$coordinates) {
  6069. throw new \Exception('Could not decode WKT: ' . $wkt);
  6070. }
  6071. return new Geometry($type, $coordinates);
  6072. }
  6073. public function serialize()
  6074. {
  6075. return [
  6076. 'type' => $this->type,
  6077. 'coordinates' => $this->coordinates,
  6078. ];
  6079. }
  6080. public function jsonSerialize()
  6081. {
  6082. return $this->serialize();
  6083. }
  6084. }
  6085. }
  6086. // file: src/Tqdev/PhpCrudApi/Middleware/Base/Middleware.php
  6087. namespace Tqdev\PhpCrudApi\Middleware\Base {
  6088. use Psr\Http\Server\MiddlewareInterface;
  6089. use Tqdev\PhpCrudApi\Controller\Responder;
  6090. use Tqdev\PhpCrudApi\Middleware\Router\Router;
  6091. abstract class Middleware implements MiddlewareInterface
  6092. {
  6093. protected $next;
  6094. protected $responder;
  6095. private $properties;
  6096. public function __construct(Router $router, Responder $responder, array $properties)
  6097. {
  6098. $router->load($this);
  6099. $this->responder = $responder;
  6100. $this->properties = $properties;
  6101. }
  6102. protected function getArrayProperty(string $key, string $default): array
  6103. {
  6104. return array_filter(array_map('trim', explode(',', $this->getProperty($key, $default))));
  6105. }
  6106. protected function getMapProperty(string $key, string $default): array
  6107. {
  6108. $pairs = $this->getArrayProperty($key, $default);
  6109. $result = array();
  6110. foreach ($pairs as $pair) {
  6111. if (strpos($pair, ':')) {
  6112. list($k, $v) = explode(':', $pair, 2);
  6113. $result[trim($k)] = trim($v);
  6114. } else {
  6115. $result[] = trim($pair);
  6116. }
  6117. }
  6118. return $result;
  6119. }
  6120. protected function getProperty(string $key, $default)
  6121. {
  6122. return isset($this->properties[$key]) ? $this->properties[$key] : $default;
  6123. }
  6124. }
  6125. }
  6126. // file: src/Tqdev/PhpCrudApi/Middleware/Communication/VariableStore.php
  6127. namespace Tqdev\PhpCrudApi\Middleware\Communication {
  6128. class VariableStore
  6129. {
  6130. public static $values = array();
  6131. public static function get(string $key)
  6132. {
  6133. if (isset(self::$values[$key])) {
  6134. return self::$values[$key];
  6135. }
  6136. return null;
  6137. }
  6138. public static function set(string $key, /* object */ $value)
  6139. {
  6140. self::$values[$key] = $value;
  6141. }
  6142. }
  6143. }
  6144. // file: src/Tqdev/PhpCrudApi/Middleware/Router/Router.php
  6145. namespace Tqdev\PhpCrudApi\Middleware\Router {
  6146. use Psr\Http\Message\ResponseInterface;
  6147. use Psr\Http\Message\ServerRequestInterface;
  6148. use Psr\Http\Server\RequestHandlerInterface;
  6149. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  6150. interface Router extends RequestHandlerInterface
  6151. {
  6152. public function register(string $method, string $path, array $handler);
  6153. public function load(Middleware $middleware);
  6154. public function route(ServerRequestInterface $request): ResponseInterface;
  6155. }
  6156. }
  6157. // file: src/Tqdev/PhpCrudApi/Middleware/Router/SimpleRouter.php
  6158. namespace Tqdev\PhpCrudApi\Middleware\Router {
  6159. use Psr\Http\Message\ResponseInterface;
  6160. use Psr\Http\Message\ServerRequestInterface;
  6161. use Tqdev\PhpCrudApi\Cache\Cache;
  6162. use Tqdev\PhpCrudApi\Controller\Responder;
  6163. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  6164. use Tqdev\PhpCrudApi\Record\ErrorCode;
  6165. use Tqdev\PhpCrudApi\Record\PathTree;
  6166. use Tqdev\PhpCrudApi\RequestUtils;
  6167. use Tqdev\PhpCrudApi\ResponseUtils;
  6168. class SimpleRouter implements Router
  6169. {
  6170. private $basePath;
  6171. private $responder;
  6172. private $cache;
  6173. private $ttl;
  6174. private $debug;
  6175. private $registration;
  6176. private $routes;
  6177. private $routeHandlers;
  6178. private $middlewares;
  6179. public function __construct(string $basePath, Responder $responder, Cache $cache, int $ttl, bool $debug)
  6180. {
  6181. $this->basePath = rtrim($this->detectBasePath($basePath), '/');
  6182. $this->responder = $responder;
  6183. $this->cache = $cache;
  6184. $this->ttl = $ttl;
  6185. $this->debug = $debug;
  6186. $this->registration = true;
  6187. $this->routes = $this->loadPathTree();
  6188. $this->routeHandlers = [];
  6189. $this->middlewares = array();
  6190. }
  6191. private function detectBasePath(string $basePath): string
  6192. {
  6193. if ($basePath) {
  6194. return $basePath;
  6195. }
  6196. if (isset($_SERVER['REQUEST_URI'])) {
  6197. $fullPath = urldecode(explode('?', $_SERVER['REQUEST_URI'])[0]);
  6198. if (isset($_SERVER['PATH_INFO'])) {
  6199. $path = $_SERVER['PATH_INFO'];
  6200. if (substr($fullPath, -1 * strlen($path)) == $path) {
  6201. return substr($fullPath, 0, -1 * strlen($path));
  6202. }
  6203. }
  6204. if ('/' . basename(__FILE__) == $fullPath) {
  6205. return $fullPath;
  6206. }
  6207. }
  6208. return '/';
  6209. }
  6210. private function loadPathTree(): PathTree
  6211. {
  6212. $data = $this->cache->get('PathTree');
  6213. if ($data != '') {
  6214. $tree = PathTree::fromJson(json_decode(gzuncompress($data)));
  6215. $this->registration = false;
  6216. } else {
  6217. $tree = new PathTree();
  6218. }
  6219. return $tree;
  6220. }
  6221. public function register(string $method, string $path, array $handler)
  6222. {
  6223. $routeNumber = count($this->routeHandlers);
  6224. $this->routeHandlers[$routeNumber] = $handler;
  6225. if ($this->registration) {
  6226. $path = trim($path, '/');
  6227. $parts = array();
  6228. if ($path) {
  6229. $parts = explode('/', $path);
  6230. }
  6231. array_unshift($parts, $method);
  6232. $this->routes->put($parts, $routeNumber);
  6233. }
  6234. }
  6235. public function load(Middleware $middleware) /*: void*/
  6236. {
  6237. array_push($this->middlewares, $middleware);
  6238. }
  6239. public function route(ServerRequestInterface $request): ResponseInterface
  6240. {
  6241. if ($this->registration) {
  6242. $data = gzcompress(json_encode($this->routes, JSON_UNESCAPED_UNICODE));
  6243. $this->cache->set('PathTree', $data, $this->ttl);
  6244. }
  6245. return $this->handle($request);
  6246. }
  6247. private function getRouteNumbers(ServerRequestInterface $request): array
  6248. {
  6249. $method = strtoupper($request->getMethod());
  6250. $path = array();
  6251. $segment = $method;
  6252. for ($i = 1; $segment; $i++) {
  6253. array_push($path, $segment);
  6254. $segment = RequestUtils::getPathSegment($request, $i);
  6255. }
  6256. return $this->routes->match($path);
  6257. }
  6258. private function removeBasePath(ServerRequestInterface $request): ServerRequestInterface
  6259. {
  6260. $path = $request->getUri()->getPath();
  6261. if (substr($path, 0, strlen($this->basePath)) == $this->basePath) {
  6262. $path = substr($path, strlen($this->basePath));
  6263. $request = $request->withUri($request->getUri()->withPath($path));
  6264. }
  6265. return $request;
  6266. }
  6267. public function getBasePath(): string
  6268. {
  6269. return $this->basePath;
  6270. }
  6271. public function handle(ServerRequestInterface $request): ResponseInterface
  6272. {
  6273. $request = $this->removeBasePath($request);
  6274. if (count($this->middlewares)) {
  6275. $handler = array_pop($this->middlewares);
  6276. return $handler->process($request, $this);
  6277. }
  6278. $routeNumbers = $this->getRouteNumbers($request);
  6279. if (count($routeNumbers) == 0) {
  6280. return $this->responder->error(ErrorCode::ROUTE_NOT_FOUND, $request->getUri()->getPath());
  6281. }
  6282. try {
  6283. $response = call_user_func($this->routeHandlers[$routeNumbers[0]], $request);
  6284. } catch (\PDOException $e) {
  6285. if (strpos(strtolower($e->getMessage()), 'duplicate') !== false) {
  6286. $response = $this->responder->error(ErrorCode::DUPLICATE_KEY_EXCEPTION, '');
  6287. } elseif (strpos(strtolower($e->getMessage()), 'unique constraint') !== false) {
  6288. $response = $this->responder->error(ErrorCode::DUPLICATE_KEY_EXCEPTION, '');
  6289. } elseif (strpos(strtolower($e->getMessage()), 'default value') !== false) {
  6290. $response = $this->responder->error(ErrorCode::DATA_INTEGRITY_VIOLATION, '');
  6291. } elseif (strpos(strtolower($e->getMessage()), 'allow nulls') !== false) {
  6292. $response = $this->responder->error(ErrorCode::DATA_INTEGRITY_VIOLATION, '');
  6293. } elseif (strpos(strtolower($e->getMessage()), 'constraint') !== false) {
  6294. $response = $this->responder->error(ErrorCode::DATA_INTEGRITY_VIOLATION, '');
  6295. } else {
  6296. $response = $this->responder->error(ErrorCode::ERROR_NOT_FOUND, '');
  6297. }
  6298. if ($this->debug) {
  6299. $response = ResponseUtils::addExceptionHeaders($response, $e);
  6300. }
  6301. }
  6302. return $response;
  6303. }
  6304. }
  6305. }
  6306. // file: src/Tqdev/PhpCrudApi/Middleware/AjaxOnlyMiddleware.php
  6307. namespace Tqdev\PhpCrudApi\Middleware {
  6308. use Psr\Http\Message\ResponseInterface;
  6309. use Psr\Http\Message\ServerRequestInterface;
  6310. use Psr\Http\Server\RequestHandlerInterface;
  6311. use Tqdev\PhpCrudApi\Controller\Responder;
  6312. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  6313. use Tqdev\PhpCrudApi\Record\ErrorCode;
  6314. use Tqdev\PhpCrudApi\RequestUtils;
  6315. class AjaxOnlyMiddleware extends Middleware
  6316. {
  6317. public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
  6318. {
  6319. $method = $request->getMethod();
  6320. $excludeMethods = $this->getArrayProperty('excludeMethods', 'OPTIONS,GET');
  6321. if (!in_array($method, $excludeMethods)) {
  6322. $headerName = $this->getProperty('headerName', 'X-Requested-With');
  6323. $headerValue = $this->getProperty('headerValue', 'XMLHttpRequest');
  6324. if ($headerValue != RequestUtils::getHeader($request, $headerName)) {
  6325. return $this->responder->error(ErrorCode::ONLY_AJAX_REQUESTS_ALLOWED, $method);
  6326. }
  6327. }
  6328. return $next->handle($request);
  6329. }
  6330. }
  6331. }
  6332. // file: src/Tqdev/PhpCrudApi/Middleware/AuthorizationMiddleware.php
  6333. namespace Tqdev\PhpCrudApi\Middleware {
  6334. use Psr\Http\Message\ResponseInterface;
  6335. use Psr\Http\Message\ServerRequestInterface;
  6336. use Psr\Http\Server\RequestHandlerInterface;
  6337. use Tqdev\PhpCrudApi\Column\ReflectionService;
  6338. use Tqdev\PhpCrudApi\Controller\Responder;
  6339. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  6340. use Tqdev\PhpCrudApi\Middleware\Communication\VariableStore;
  6341. use Tqdev\PhpCrudApi\Middleware\Router\Router;
  6342. use Tqdev\PhpCrudApi\Record\ErrorCode;
  6343. use Tqdev\PhpCrudApi\Record\FilterInfo;
  6344. use Tqdev\PhpCrudApi\RequestUtils;
  6345. class AuthorizationMiddleware extends Middleware
  6346. {
  6347. private $reflection;
  6348. public function __construct(Router $router, Responder $responder, array $properties, ReflectionService $reflection)
  6349. {
  6350. parent::__construct($router, $responder, $properties);
  6351. $this->reflection = $reflection;
  6352. }
  6353. private function handleColumns(string $operation, string $tableName) /*: void*/
  6354. {
  6355. $columnHandler = $this->getProperty('columnHandler', '');
  6356. if ($columnHandler) {
  6357. $table = $this->reflection->getTable($tableName);
  6358. foreach ($table->getColumnNames() as $columnName) {
  6359. $allowed = call_user_func($columnHandler, $operation, $tableName, $columnName);
  6360. if (!$allowed) {
  6361. $table->removeColumn($columnName);
  6362. }
  6363. }
  6364. }
  6365. }
  6366. private function handleTable(string $operation, string $tableName) /*: void*/
  6367. {
  6368. if (!$this->reflection->hasTable($tableName)) {
  6369. return;
  6370. }
  6371. $allowed = true;
  6372. $tableHandler = $this->getProperty('tableHandler', '');
  6373. if ($tableHandler) {
  6374. $allowed = call_user_func($tableHandler, $operation, $tableName);
  6375. }
  6376. if (!$allowed) {
  6377. $this->reflection->removeTable($tableName);
  6378. } else {
  6379. $this->handleColumns($operation, $tableName);
  6380. }
  6381. }
  6382. private function handleRecords(string $operation, string $tableName) /*: void*/
  6383. {
  6384. if (!$this->reflection->hasTable($tableName)) {
  6385. return;
  6386. }
  6387. $recordHandler = $this->getProperty('recordHandler', '');
  6388. if ($recordHandler) {
  6389. $query = call_user_func($recordHandler, $operation, $tableName);
  6390. $filters = new FilterInfo();
  6391. $table = $this->reflection->getTable($tableName);
  6392. $query = str_replace('][]=', ']=', str_replace('=', '[]=', $query));
  6393. parse_str($query, $params);
  6394. $condition = $filters->getCombinedConditions($table, $params);
  6395. VariableStore::set("authorization.conditions.$tableName", $condition);
  6396. }
  6397. }
  6398. private function pathHandler(string $path) /*: bool*/
  6399. {
  6400. $pathHandler = $this->getProperty('pathHandler', '');
  6401. return $pathHandler ? call_user_func($pathHandler, $path) : true;
  6402. }
  6403. public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
  6404. {
  6405. $path = RequestUtils::getPathSegment($request, 1);
  6406. if (!$this->pathHandler($path)) {
  6407. return $this->responder->error(ErrorCode::ROUTE_NOT_FOUND, $request->getUri()->getPath());
  6408. }
  6409. $operation = RequestUtils::getOperation($request);
  6410. $tableNames = RequestUtils::getTableNames($request, $this->reflection);
  6411. foreach ($tableNames as $tableName) {
  6412. $this->handleTable($operation, $tableName);
  6413. if ($path == 'records') {
  6414. $this->handleRecords($operation, $tableName);
  6415. }
  6416. }
  6417. if ($path == 'openapi') {
  6418. VariableStore::set('authorization.tableHandler', $this->getProperty('tableHandler', ''));
  6419. VariableStore::set('authorization.columnHandler', $this->getProperty('columnHandler', ''));
  6420. }
  6421. return $next->handle($request);
  6422. }
  6423. }
  6424. }
  6425. // file: src/Tqdev/PhpCrudApi/Middleware/BasicAuthMiddleware.php
  6426. namespace Tqdev\PhpCrudApi\Middleware {
  6427. use Psr\Http\Message\ResponseInterface;
  6428. use Psr\Http\Message\ServerRequestInterface;
  6429. use Psr\Http\Server\RequestHandlerInterface;
  6430. use Tqdev\PhpCrudApi\Controller\Responder;
  6431. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  6432. use Tqdev\PhpCrudApi\Record\ErrorCode;
  6433. use Tqdev\PhpCrudApi\RequestUtils;
  6434. class BasicAuthMiddleware extends Middleware
  6435. {
  6436. private function hasCorrectPassword(string $username, string $password, array &$passwords): bool
  6437. {
  6438. $hash = isset($passwords[$username]) ? $passwords[$username] : false;
  6439. if ($hash && password_verify($password, $hash)) {
  6440. if (password_needs_rehash($hash, PASSWORD_DEFAULT)) {
  6441. $passwords[$username] = password_hash($password, PASSWORD_DEFAULT);
  6442. }
  6443. return true;
  6444. }
  6445. return false;
  6446. }
  6447. private function getValidUsername(string $username, string $password, string $passwordFile): string
  6448. {
  6449. $passwords = $this->readPasswords($passwordFile);
  6450. $valid = $this->hasCorrectPassword($username, $password, $passwords);
  6451. $this->writePasswords($passwordFile, $passwords);
  6452. return $valid ? $username : '';
  6453. }
  6454. private function readPasswords(string $passwordFile): array
  6455. {
  6456. $passwords = [];
  6457. $passwordLines = file($passwordFile);
  6458. foreach ($passwordLines as $passwordLine) {
  6459. if (strpos($passwordLine, ':') !== false) {
  6460. list($username, $hash) = explode(':', trim($passwordLine), 2);
  6461. if (strlen($hash) > 0 && $hash[0] != '$') {
  6462. $hash = password_hash($hash, PASSWORD_DEFAULT);
  6463. }
  6464. $passwords[$username] = $hash;
  6465. }
  6466. }
  6467. return $passwords;
  6468. }
  6469. private function writePasswords(string $passwordFile, array $passwords): bool
  6470. {
  6471. $success = false;
  6472. $passwordFileContents = '';
  6473. foreach ($passwords as $username => $hash) {
  6474. $passwordFileContents .= "$username:$hash\n";
  6475. }
  6476. if (file_get_contents($passwordFile) != $passwordFileContents) {
  6477. $success = file_put_contents($passwordFile, $passwordFileContents) !== false;
  6478. }
  6479. return $success;
  6480. }
  6481. private function getAuthorizationCredentials(ServerRequestInterface $request): string
  6482. {
  6483. if (isset($_SERVER['PHP_AUTH_USER'])) {
  6484. return $_SERVER['PHP_AUTH_USER'] . ':' . $_SERVER['PHP_AUTH_PW'];
  6485. }
  6486. $header = RequestUtils::getHeader($request, 'Authorization');
  6487. $parts = explode(' ', trim($header), 2);
  6488. if (count($parts) != 2) {
  6489. return '';
  6490. }
  6491. if ($parts[0] != 'Basic') {
  6492. return '';
  6493. }
  6494. return base64_decode(strtr($parts[1], '-_', '+/'));
  6495. }
  6496. public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
  6497. {
  6498. if (session_status() == PHP_SESSION_NONE) {
  6499. if (!headers_sent()) {
  6500. $sessionName = $this->getProperty('sessionName', '');
  6501. if ($sessionName) {
  6502. session_name($sessionName);
  6503. }
  6504. session_start();
  6505. }
  6506. }
  6507. $credentials = $this->getAuthorizationCredentials($request);
  6508. if ($credentials) {
  6509. list($username, $password) = array('', '');
  6510. if (strpos($credentials, ':') !== false) {
  6511. list($username, $password) = explode(':', $credentials, 2);
  6512. }
  6513. $passwordFile = $this->getProperty('passwordFile', '.htpasswd');
  6514. $validUser = $this->getValidUsername($username, $password, $passwordFile);
  6515. $_SESSION['username'] = $validUser;
  6516. if (!$validUser) {
  6517. return $this->responder->error(ErrorCode::AUTHENTICATION_FAILED, $username);
  6518. }
  6519. if (!headers_sent()) {
  6520. session_regenerate_id();
  6521. }
  6522. }
  6523. if (!isset($_SESSION['username']) || !$_SESSION['username']) {
  6524. $authenticationMode = $this->getProperty('mode', 'required');
  6525. if ($authenticationMode == 'required') {
  6526. $response = $this->responder->error(ErrorCode::AUTHENTICATION_REQUIRED, '');
  6527. $realm = $this->getProperty('realm', 'Username and password required');
  6528. $response = $response->withHeader('WWW-Authenticate', "Basic realm=\"$realm\"");
  6529. return $response;
  6530. }
  6531. }
  6532. return $next->handle($request);
  6533. }
  6534. }
  6535. }
  6536. // file: src/Tqdev/PhpCrudApi/Middleware/CorsMiddleware.php
  6537. namespace Tqdev\PhpCrudApi\Middleware {
  6538. use Psr\Http\Message\ResponseInterface;
  6539. use Psr\Http\Message\ServerRequestInterface;
  6540. use Psr\Http\Server\RequestHandlerInterface;
  6541. use Tqdev\PhpCrudApi\Controller\Responder;
  6542. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  6543. use Tqdev\PhpCrudApi\Middleware\Router\Router;
  6544. use Tqdev\PhpCrudApi\Record\ErrorCode;
  6545. use Tqdev\PhpCrudApi\ResponseFactory;
  6546. use Tqdev\PhpCrudApi\ResponseUtils;
  6547. class CorsMiddleware extends Middleware
  6548. {
  6549. private $debug;
  6550. public function __construct(Router $router, Responder $responder, array $properties, bool $debug)
  6551. {
  6552. parent::__construct($router, $responder, $properties);
  6553. $this->debug = $debug;
  6554. }
  6555. private function isOriginAllowed(string $origin, string $allowedOrigins): bool
  6556. {
  6557. $found = false;
  6558. foreach (explode(',', $allowedOrigins) as $allowedOrigin) {
  6559. $hostname = preg_quote(strtolower(trim($allowedOrigin)));
  6560. $regex = '/^' . str_replace('\*', '.*', $hostname) . '$/';
  6561. if (preg_match($regex, $origin)) {
  6562. $found = true;
  6563. break;
  6564. }
  6565. }
  6566. return $found;
  6567. }
  6568. public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
  6569. {
  6570. $method = $request->getMethod();
  6571. $origin = count($request->getHeader('Origin')) ? $request->getHeader('Origin')[0] : '';
  6572. $allowedOrigins = $this->getProperty('allowedOrigins', '*');
  6573. if ($origin && !$this->isOriginAllowed($origin, $allowedOrigins)) {
  6574. $response = $this->responder->error(ErrorCode::ORIGIN_FORBIDDEN, $origin);
  6575. } elseif ($method == 'OPTIONS') {
  6576. $response = ResponseFactory::fromStatus(ResponseFactory::OK);
  6577. $allowHeaders = $this->getProperty('allowHeaders', 'Content-Type, X-XSRF-TOKEN, X-Authorization');
  6578. if ($this->debug) {
  6579. $allowHeaders = implode(', ', array_filter([$allowHeaders, 'X-Exception-Name, X-Exception-Message, X-Exception-File']));
  6580. }
  6581. if ($allowHeaders) {
  6582. $response = $response->withHeader('Access-Control-Allow-Headers', $allowHeaders);
  6583. }
  6584. $allowMethods = $this->getProperty('allowMethods', 'OPTIONS, GET, PUT, POST, DELETE, PATCH');
  6585. if ($allowMethods) {
  6586. $response = $response->withHeader('Access-Control-Allow-Methods', $allowMethods);
  6587. }
  6588. $allowCredentials = $this->getProperty('allowCredentials', 'true');
  6589. if ($allowCredentials) {
  6590. $response = $response->withHeader('Access-Control-Allow-Credentials', $allowCredentials);
  6591. }
  6592. $maxAge = $this->getProperty('maxAge', '1728000');
  6593. if ($maxAge) {
  6594. $response = $response->withHeader('Access-Control-Max-Age', $maxAge);
  6595. }
  6596. $exposeHeaders = $this->getProperty('exposeHeaders', '');
  6597. if ($this->debug) {
  6598. $exposeHeaders = implode(', ', array_filter([$exposeHeaders, 'X-Exception-Name, X-Exception-Message, X-Exception-File']));
  6599. }
  6600. if ($exposeHeaders) {
  6601. $response = $response->withHeader('Access-Control-Expose-Headers', $exposeHeaders);
  6602. }
  6603. } else {
  6604. $response = null;
  6605. try {
  6606. $response = $next->handle($request);
  6607. } catch (\Throwable $e) {
  6608. $response = $this->responder->error(ErrorCode::ERROR_NOT_FOUND, $e->getMessage());
  6609. if ($this->debug) {
  6610. $response = ResponseUtils::addExceptionHeaders($response, $e);
  6611. }
  6612. }
  6613. }
  6614. if ($origin) {
  6615. $allowCredentials = $this->getProperty('allowCredentials', 'true');
  6616. if ($allowCredentials) {
  6617. $response = $response->withHeader('Access-Control-Allow-Credentials', $allowCredentials);
  6618. }
  6619. $response = $response->withHeader('Access-Control-Allow-Origin', $origin);
  6620. }
  6621. return $response;
  6622. }
  6623. }
  6624. }
  6625. // file: src/Tqdev/PhpCrudApi/Middleware/CustomizationMiddleware.php
  6626. namespace Tqdev\PhpCrudApi\Middleware {
  6627. use Psr\Http\Message\ResponseInterface;
  6628. use Psr\Http\Message\ServerRequestInterface;
  6629. use Psr\Http\Server\RequestHandlerInterface;
  6630. use Tqdev\PhpCrudApi\Column\ReflectionService;
  6631. use Tqdev\PhpCrudApi\Controller\Responder;
  6632. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  6633. use Tqdev\PhpCrudApi\Middleware\Router\Router;
  6634. use Tqdev\PhpCrudApi\RequestUtils;
  6635. class CustomizationMiddleware extends Middleware
  6636. {
  6637. private $reflection;
  6638. public function __construct(Router $router, Responder $responder, array $properties, ReflectionService $reflection)
  6639. {
  6640. parent::__construct($router, $responder, $properties);
  6641. $this->reflection = $reflection;
  6642. }
  6643. public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
  6644. {
  6645. $operation = RequestUtils::getOperation($request);
  6646. $tableName = RequestUtils::getPathSegment($request, 2);
  6647. $beforeHandler = $this->getProperty('beforeHandler', '');
  6648. $environment = (object) array();
  6649. if ($beforeHandler !== '') {
  6650. $result = call_user_func($beforeHandler, $operation, $tableName, $request, $environment);
  6651. $request = $result ?: $request;
  6652. }
  6653. $response = $next->handle($request);
  6654. $afterHandler = $this->getProperty('afterHandler', '');
  6655. if ($afterHandler !== '') {
  6656. $result = call_user_func($afterHandler, $operation, $tableName, $response, $environment);
  6657. $response = $result ?: $response;
  6658. }
  6659. return $response;
  6660. }
  6661. }
  6662. }
  6663. // file: src/Tqdev/PhpCrudApi/Middleware/DbAuthMiddleware.php
  6664. namespace Tqdev\PhpCrudApi\Middleware {
  6665. use Psr\Http\Message\ResponseInterface;
  6666. use Psr\Http\Message\ServerRequestInterface;
  6667. use Psr\Http\Server\RequestHandlerInterface;
  6668. use Tqdev\PhpCrudApi\Column\ReflectionService;
  6669. use Tqdev\PhpCrudApi\Controller\Responder;
  6670. use Tqdev\PhpCrudApi\Database\GenericDB;
  6671. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  6672. use Tqdev\PhpCrudApi\Middleware\Router\Router;
  6673. use Tqdev\PhpCrudApi\Record\Condition\ColumnCondition;
  6674. use Tqdev\PhpCrudApi\Record\ErrorCode;
  6675. use Tqdev\PhpCrudApi\Record\OrderingInfo;
  6676. use Tqdev\PhpCrudApi\RequestUtils;
  6677. class DbAuthMiddleware extends Middleware
  6678. {
  6679. private $reflection;
  6680. private $db;
  6681. private $ordering;
  6682. public function __construct(Router $router, Responder $responder, array $properties, ReflectionService $reflection, GenericDB $db)
  6683. {
  6684. parent::__construct($router, $responder, $properties);
  6685. $this->reflection = $reflection;
  6686. $this->db = $db;
  6687. $this->ordering = new OrderingInfo();
  6688. }
  6689. public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
  6690. {
  6691. if (session_status() == PHP_SESSION_NONE) {
  6692. if (!headers_sent()) {
  6693. $sessionName = $this->getProperty('sessionName', '');
  6694. if ($sessionName) {
  6695. session_name($sessionName);
  6696. }
  6697. session_start();
  6698. }
  6699. }
  6700. $path = RequestUtils::getPathSegment($request, 1);
  6701. $method = $request->getMethod();
  6702. if ($method == 'POST' && in_array($path, ['login', 'register', 'password'])) {
  6703. $body = $request->getParsedBody();
  6704. $username = isset($body->username) ? $body->username : '';
  6705. $password = isset($body->password) ? $body->password : '';
  6706. $newPassword = isset($body->newPassword) ? $body->newPassword : '';
  6707. $tableName = $this->getProperty('usersTable', 'users');
  6708. $table = $this->reflection->getTable($tableName);
  6709. $usernameColumnName = $this->getProperty('usernameColumn', 'username');
  6710. $usernameColumn = $table->getColumn($usernameColumnName);
  6711. $passwordColumnName = $this->getProperty('passwordColumn', 'password');
  6712. $passwordLength = $this->getProperty('passwordLength', '12');
  6713. $pkName = $table->getPk()->getName();
  6714. $registerUser = $this->getProperty('registerUser', '');
  6715. $condition = new ColumnCondition($usernameColumn, 'eq', $username);
  6716. $returnedColumns = $this->getProperty('returnedColumns', '');
  6717. if (!$returnedColumns) {
  6718. $columnNames = $table->getColumnNames();
  6719. } else {
  6720. $columnNames = array_map('trim', explode(',', $returnedColumns));
  6721. $columnNames[] = $passwordColumnName;
  6722. $columnNames[] = $pkName;
  6723. }
  6724. $columnOrdering = $this->ordering->getDefaultColumnOrdering($table);
  6725. if ($path == 'register') {
  6726. if (!$registerUser) {
  6727. return $this->responder->error(ErrorCode::AUTHENTICATION_FAILED, $username);
  6728. }
  6729. if (strlen($password) < $passwordLength) {
  6730. return $this->responder->error(ErrorCode::PASSWORD_TOO_SHORT, $passwordLength);
  6731. }
  6732. $users = $this->db->selectAll($table, $columnNames, $condition, $columnOrdering, 0, 1);
  6733. if (!empty($users)) {
  6734. return $this->responder->error(ErrorCode::USER_ALREADY_EXIST, $username);
  6735. }
  6736. $data = json_decode($registerUser, true);
  6737. $data = is_array($data) ? $data : [];
  6738. $data[$usernameColumnName] = $username;
  6739. $data[$passwordColumnName] = password_hash($password, PASSWORD_DEFAULT);
  6740. $this->db->createSingle($table, $data);
  6741. $users = $this->db->selectAll($table, $columnNames, $condition, $columnOrdering, 0, 1);
  6742. foreach ($users as $user) {
  6743. unset($user[$passwordColumnName]);
  6744. return $this->responder->success($user);
  6745. }
  6746. return $this->responder->error(ErrorCode::AUTHENTICATION_FAILED, $username);
  6747. }
  6748. if ($path == 'login') {
  6749. $users = $this->db->selectAll($table, $columnNames, $condition, $columnOrdering, 0, 1);
  6750. foreach ($users as $user) {
  6751. if (password_verify($password, $user[$passwordColumnName]) == 1) {
  6752. if (!headers_sent()) {
  6753. session_regenerate_id(true);
  6754. }
  6755. unset($user[$passwordColumnName]);
  6756. $_SESSION['user'] = $user;
  6757. return $this->responder->success($user);
  6758. }
  6759. }
  6760. return $this->responder->error(ErrorCode::AUTHENTICATION_FAILED, $username);
  6761. }
  6762. if ($path == 'password') {
  6763. if ($username != ($_SESSION['user'][$usernameColumnName] ?? '')) {
  6764. return $this->responder->error(ErrorCode::AUTHENTICATION_FAILED, $username);
  6765. }
  6766. if (strlen($newPassword) < $passwordLength) {
  6767. return $this->responder->error(ErrorCode::PASSWORD_TOO_SHORT, $passwordLength);
  6768. }
  6769. $users = $this->db->selectAll($table, $columnNames, $condition, $columnOrdering, 0, 1);
  6770. foreach ($users as $user) {
  6771. if (password_verify($password, $user[$passwordColumnName]) == 1) {
  6772. if (!headers_sent()) {
  6773. session_regenerate_id(true);
  6774. }
  6775. $data = [$passwordColumnName => password_hash($newPassword, PASSWORD_DEFAULT)];
  6776. $this->db->updateSingle($table, $data, $user[$pkName]);
  6777. unset($user[$passwordColumnName]);
  6778. return $this->responder->success($user);
  6779. }
  6780. }
  6781. return $this->responder->error(ErrorCode::AUTHENTICATION_FAILED, $username);
  6782. }
  6783. }
  6784. if ($method == 'POST' && $path == 'logout') {
  6785. if (isset($_SESSION['user'])) {
  6786. $user = $_SESSION['user'];
  6787. unset($_SESSION['user']);
  6788. if (session_status() != PHP_SESSION_NONE) {
  6789. session_destroy();
  6790. }
  6791. return $this->responder->success($user);
  6792. }
  6793. return $this->responder->error(ErrorCode::AUTHENTICATION_REQUIRED, '');
  6794. }
  6795. if ($method == 'GET' && $path == 'me') {
  6796. if (isset($_SESSION['user'])) {
  6797. return $this->responder->success($_SESSION['user']);
  6798. }
  6799. return $this->responder->error(ErrorCode::AUTHENTICATION_REQUIRED, '');
  6800. }
  6801. if (!isset($_SESSION['user']) || !$_SESSION['user']) {
  6802. $authenticationMode = $this->getProperty('mode', 'required');
  6803. if ($authenticationMode == 'required') {
  6804. return $this->responder->error(ErrorCode::AUTHENTICATION_REQUIRED, '');
  6805. }
  6806. }
  6807. return $next->handle($request);
  6808. }
  6809. }
  6810. }
  6811. // file: src/Tqdev/PhpCrudApi/Middleware/FirewallMiddleware.php
  6812. namespace Tqdev\PhpCrudApi\Middleware {
  6813. use Psr\Http\Message\ResponseInterface;
  6814. use Psr\Http\Message\ServerRequestInterface;
  6815. use Psr\Http\Server\RequestHandlerInterface;
  6816. use Tqdev\PhpCrudApi\Controller\Responder;
  6817. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  6818. use Tqdev\PhpCrudApi\Record\ErrorCode;
  6819. class FirewallMiddleware extends Middleware
  6820. {
  6821. private function ipMatch(string $ip, string $cidr): bool
  6822. {
  6823. if (strpos($cidr, '/') !== false) {
  6824. list($subnet, $mask) = explode('/', trim($cidr));
  6825. if ((ip2long($ip) & ~((1 << (32 - $mask)) - 1)) == ip2long($subnet)) {
  6826. return true;
  6827. }
  6828. } else {
  6829. if (ip2long($ip) == ip2long($cidr)) {
  6830. return true;
  6831. }
  6832. }
  6833. return false;
  6834. }
  6835. private function isIpAllowed(string $ipAddress, string $allowedIpAddresses): bool
  6836. {
  6837. foreach (explode(',', $allowedIpAddresses) as $allowedIp) {
  6838. if ($this->ipMatch($ipAddress, $allowedIp)) {
  6839. return true;
  6840. }
  6841. }
  6842. return false;
  6843. }
  6844. public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
  6845. {
  6846. $reverseProxy = $this->getProperty('reverseProxy', '');
  6847. if ($reverseProxy) {
  6848. $ipAddress = array_pop(explode(',', $request->getHeader('X-Forwarded-For')));
  6849. } elseif (isset($_SERVER['REMOTE_ADDR'])) {
  6850. $ipAddress = $_SERVER['REMOTE_ADDR'];
  6851. } else {
  6852. $ipAddress = '127.0.0.1';
  6853. }
  6854. $allowedIpAddresses = $this->getProperty('allowedIpAddresses', '');
  6855. if (!$this->isIpAllowed($ipAddress, $allowedIpAddresses)) {
  6856. $response = $this->responder->error(ErrorCode::TEMPORARY_OR_PERMANENTLY_BLOCKED, '');
  6857. } else {
  6858. $response = $next->handle($request);
  6859. }
  6860. return $response;
  6861. }
  6862. }
  6863. }
  6864. // file: src/Tqdev/PhpCrudApi/Middleware/IpAddressMiddleware.php
  6865. namespace Tqdev\PhpCrudApi\Middleware {
  6866. use Psr\Http\Message\ResponseInterface;
  6867. use Psr\Http\Message\ServerRequestInterface;
  6868. use Psr\Http\Server\RequestHandlerInterface;
  6869. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedTable;
  6870. use Tqdev\PhpCrudApi\Column\ReflectionService;
  6871. use Tqdev\PhpCrudApi\Controller\Responder;
  6872. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  6873. use Tqdev\PhpCrudApi\Middleware\Router\Router;
  6874. use Tqdev\PhpCrudApi\RequestUtils;
  6875. class IpAddressMiddleware extends Middleware
  6876. {
  6877. private $reflection;
  6878. public function __construct(Router $router, Responder $responder, array $properties, ReflectionService $reflection)
  6879. {
  6880. parent::__construct($router, $responder, $properties);
  6881. $this->reflection = $reflection;
  6882. }
  6883. private function callHandler($record, string $operation, ReflectedTable $table) /*: object */
  6884. {
  6885. $context = (array) $record;
  6886. $columnNames = $this->getProperty('columns', '');
  6887. if ($columnNames) {
  6888. foreach (explode(',', $columnNames) as $columnName) {
  6889. if ($table->hasColumn($columnName)) {
  6890. if ($operation == 'create') {
  6891. $context[$columnName] = $_SERVER['REMOTE_ADDR'];
  6892. } else {
  6893. unset($context[$columnName]);
  6894. }
  6895. }
  6896. }
  6897. }
  6898. return (object) $context;
  6899. }
  6900. public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
  6901. {
  6902. $operation = RequestUtils::getOperation($request);
  6903. if (in_array($operation, ['create', 'update', 'increment'])) {
  6904. $tableNames = $this->getProperty('tables', '');
  6905. $tableName = RequestUtils::getPathSegment($request, 2);
  6906. if (!$tableNames || in_array($tableName, explode(',', $tableNames))) {
  6907. if ($this->reflection->hasTable($tableName)) {
  6908. $record = $request->getParsedBody();
  6909. if ($record !== null) {
  6910. $table = $this->reflection->getTable($tableName);
  6911. if (is_array($record)) {
  6912. foreach ($record as &$r) {
  6913. $r = $this->callHandler($r, $operation, $table);
  6914. }
  6915. } else {
  6916. $record = $this->callHandler($record, $operation, $table);
  6917. }
  6918. $request = $request->withParsedBody($record);
  6919. }
  6920. }
  6921. }
  6922. }
  6923. return $next->handle($request);
  6924. }
  6925. }
  6926. }
  6927. // file: src/Tqdev/PhpCrudApi/Middleware/JoinLimitsMiddleware.php
  6928. namespace Tqdev\PhpCrudApi\Middleware {
  6929. use Psr\Http\Message\ResponseInterface;
  6930. use Psr\Http\Message\ServerRequestInterface;
  6931. use Psr\Http\Server\RequestHandlerInterface;
  6932. use Tqdev\PhpCrudApi\Column\ReflectionService;
  6933. use Tqdev\PhpCrudApi\Controller\Responder;
  6934. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  6935. use Tqdev\PhpCrudApi\Middleware\Communication\VariableStore;
  6936. use Tqdev\PhpCrudApi\Middleware\Router\Router;
  6937. use Tqdev\PhpCrudApi\RequestUtils;
  6938. class JoinLimitsMiddleware extends Middleware
  6939. {
  6940. private $reflection;
  6941. public function __construct(Router $router, Responder $responder, array $properties, ReflectionService $reflection)
  6942. {
  6943. parent::__construct($router, $responder, $properties);
  6944. $this->reflection = $reflection;
  6945. }
  6946. public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
  6947. {
  6948. $operation = RequestUtils::getOperation($request);
  6949. $params = RequestUtils::getParams($request);
  6950. if (in_array($operation, ['read', 'list']) && isset($params['join'])) {
  6951. $maxDepth = (int) $this->getProperty('depth', '3');
  6952. $maxTables = (int) $this->getProperty('tables', '10');
  6953. $maxRecords = (int) $this->getProperty('records', '1000');
  6954. $tableCount = 0;
  6955. $joinPaths = array();
  6956. for ($i = 0; $i < count($params['join']); $i++) {
  6957. $joinPath = array();
  6958. $tables = explode(',', $params['join'][$i]);
  6959. for ($depth = 0; $depth < min($maxDepth, count($tables)); $depth++) {
  6960. array_push($joinPath, $tables[$depth]);
  6961. $tableCount += 1;
  6962. if ($tableCount == $maxTables) {
  6963. break;
  6964. }
  6965. }
  6966. array_push($joinPaths, implode(',', $joinPath));
  6967. if ($tableCount == $maxTables) {
  6968. break;
  6969. }
  6970. }
  6971. $params['join'] = $joinPaths;
  6972. $request = RequestUtils::setParams($request, $params);
  6973. VariableStore::set("joinLimits.maxRecords", $maxRecords);
  6974. }
  6975. return $next->handle($request);
  6976. }
  6977. }
  6978. }
  6979. // file: src/Tqdev/PhpCrudApi/Middleware/JwtAuthMiddleware.php
  6980. namespace Tqdev\PhpCrudApi\Middleware {
  6981. use Psr\Http\Message\ResponseInterface;
  6982. use Psr\Http\Message\ServerRequestInterface;
  6983. use Psr\Http\Server\RequestHandlerInterface;
  6984. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  6985. use Tqdev\PhpCrudApi\Record\ErrorCode;
  6986. use Tqdev\PhpCrudApi\RequestUtils;
  6987. class JwtAuthMiddleware extends Middleware
  6988. {
  6989. private function getVerifiedClaims(string $token, int $time, int $leeway, int $ttl, array $secrets, array $requirements): array
  6990. {
  6991. $algorithms = array(
  6992. 'HS256' => 'sha256',
  6993. 'HS384' => 'sha384',
  6994. 'HS512' => 'sha512',
  6995. 'RS256' => 'sha256',
  6996. 'RS384' => 'sha384',
  6997. 'RS512' => 'sha512',
  6998. );
  6999. $token = explode('.', $token);
  7000. if (count($token) < 3) {
  7001. return array();
  7002. }
  7003. $header = json_decode(base64_decode(strtr($token[0], '-_', '+/')), true);
  7004. $kid = 0;
  7005. if (isset($header['kid'])) {
  7006. $kid = $header['kid'];
  7007. }
  7008. if (!isset($secrets[$kid])) {
  7009. return array();
  7010. }
  7011. $secret = $secrets[$kid];
  7012. if ($header['typ'] != 'JWT') {
  7013. return array();
  7014. }
  7015. $algorithm = $header['alg'];
  7016. if (!isset($algorithms[$algorithm])) {
  7017. return array();
  7018. }
  7019. if (!empty($requirements['alg']) && !in_array($algorithm, $requirements['alg'])) {
  7020. return array();
  7021. }
  7022. $hmac = $algorithms[$algorithm];
  7023. $signature = base64_decode(strtr($token[2], '-_', '+/'));
  7024. $data = "$token[0].$token[1]";
  7025. switch ($algorithm[0]) {
  7026. case 'H':
  7027. $hash = hash_hmac($hmac, $data, $secret, true);
  7028. $equals = hash_equals($hash, $signature);
  7029. if (!$equals) {
  7030. return array();
  7031. }
  7032. break;
  7033. case 'R':
  7034. $equals = openssl_verify($data, $signature, $secret, $hmac) == 1;
  7035. if (!$equals) {
  7036. return array();
  7037. }
  7038. break;
  7039. }
  7040. $claims = json_decode(base64_decode(strtr($token[1], '-_', '+/')), true);
  7041. if (!$claims) {
  7042. return array();
  7043. }
  7044. foreach ($requirements as $field => $values) {
  7045. if (!empty($values)) {
  7046. if ($field != 'alg') {
  7047. if (!isset($claims[$field]) || !in_array($claims[$field], $values)) {
  7048. return array();
  7049. }
  7050. }
  7051. }
  7052. }
  7053. if (isset($claims['nbf']) && $time + $leeway < $claims['nbf']) {
  7054. return array();
  7055. }
  7056. if (isset($claims['iat']) && $time + $leeway < $claims['iat']) {
  7057. return array();
  7058. }
  7059. if (isset($claims['exp']) && $time - $leeway > $claims['exp']) {
  7060. return array();
  7061. }
  7062. if (isset($claims['iat']) && !isset($claims['exp'])) {
  7063. if ($time - $leeway > $claims['iat'] + $ttl) {
  7064. return array();
  7065. }
  7066. }
  7067. return $claims;
  7068. }
  7069. private function getClaims(string $token): array
  7070. {
  7071. $time = (int) $this->getProperty('time', time());
  7072. $leeway = (int) $this->getProperty('leeway', '5');
  7073. $ttl = (int) $this->getProperty('ttl', '30');
  7074. $secrets = $this->getMapProperty('secrets', '');
  7075. if (!$secrets) {
  7076. $secrets = [$this->getProperty('secret', '')];
  7077. }
  7078. $requirements = array(
  7079. 'alg' => $this->getArrayProperty('algorithms', ''),
  7080. 'aud' => $this->getArrayProperty('audiences', ''),
  7081. 'iss' => $this->getArrayProperty('issuers', ''),
  7082. );
  7083. return $this->getVerifiedClaims($token, $time, $leeway, $ttl, $secrets, $requirements);
  7084. }
  7085. private function getAuthorizationToken(ServerRequestInterface $request): string
  7086. {
  7087. $headerName = $this->getProperty('header', 'X-Authorization');
  7088. $headerValue = RequestUtils::getHeader($request, $headerName);
  7089. $parts = explode(' ', trim($headerValue), 2);
  7090. if (count($parts) != 2) {
  7091. return '';
  7092. }
  7093. if ($parts[0] != 'Bearer') {
  7094. return '';
  7095. }
  7096. return $parts[1];
  7097. }
  7098. public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
  7099. {
  7100. if (session_status() == PHP_SESSION_NONE) {
  7101. if (!headers_sent()) {
  7102. $sessionName = $this->getProperty('sessionName', '');
  7103. if ($sessionName) {
  7104. session_name($sessionName);
  7105. }
  7106. session_start();
  7107. }
  7108. }
  7109. $token = $this->getAuthorizationToken($request);
  7110. if ($token) {
  7111. $claims = $this->getClaims($token);
  7112. $_SESSION['claims'] = $claims;
  7113. if (empty($claims)) {
  7114. return $this->responder->error(ErrorCode::AUTHENTICATION_FAILED, 'JWT');
  7115. }
  7116. if (!headers_sent()) {
  7117. session_regenerate_id();
  7118. }
  7119. }
  7120. if (empty($_SESSION['claims'])) {
  7121. $authenticationMode = $this->getProperty('mode', 'required');
  7122. if ($authenticationMode == 'required') {
  7123. return $this->responder->error(ErrorCode::AUTHENTICATION_REQUIRED, '');
  7124. }
  7125. }
  7126. return $next->handle($request);
  7127. }
  7128. }
  7129. }
  7130. // file: src/Tqdev/PhpCrudApi/Middleware/MultiTenancyMiddleware.php
  7131. namespace Tqdev\PhpCrudApi\Middleware {
  7132. use Psr\Http\Message\ResponseInterface;
  7133. use Psr\Http\Message\ServerRequestInterface;
  7134. use Psr\Http\Server\RequestHandlerInterface;
  7135. use Tqdev\PhpCrudApi\Column\ReflectionService;
  7136. use Tqdev\PhpCrudApi\Controller\Responder;
  7137. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  7138. use Tqdev\PhpCrudApi\Middleware\Communication\VariableStore;
  7139. use Tqdev\PhpCrudApi\Middleware\Router\Router;
  7140. use Tqdev\PhpCrudApi\Record\Condition\ColumnCondition;
  7141. use Tqdev\PhpCrudApi\Record\Condition\Condition;
  7142. use Tqdev\PhpCrudApi\Record\Condition\NoCondition;
  7143. use Tqdev\PhpCrudApi\RequestUtils;
  7144. class MultiTenancyMiddleware extends Middleware
  7145. {
  7146. private $reflection;
  7147. public function __construct(Router $router, Responder $responder, array $properties, ReflectionService $reflection)
  7148. {
  7149. parent::__construct($router, $responder, $properties);
  7150. $this->reflection = $reflection;
  7151. }
  7152. private function getCondition(string $tableName, array $pairs): Condition
  7153. {
  7154. $condition = new NoCondition();
  7155. $table = $this->reflection->getTable($tableName);
  7156. foreach ($pairs as $k => $v) {
  7157. $condition = $condition->_and(new ColumnCondition($table->getColumn($k), 'eq', $v));
  7158. }
  7159. return $condition;
  7160. }
  7161. private function getPairs($handler, string $operation, string $tableName): array
  7162. {
  7163. $result = array();
  7164. $pairs = call_user_func($handler, $operation, $tableName) ?: [];
  7165. $table = $this->reflection->getTable($tableName);
  7166. foreach ($pairs as $k => $v) {
  7167. if ($table->hasColumn($k)) {
  7168. $result[$k] = $v;
  7169. }
  7170. }
  7171. return $result;
  7172. }
  7173. private function handleRecord(ServerRequestInterface $request, string $operation, array $pairs): ServerRequestInterface
  7174. {
  7175. $record = $request->getParsedBody();
  7176. if ($record === null) {
  7177. return $request;
  7178. }
  7179. $multi = is_array($record);
  7180. $records = $multi ? $record : [$record];
  7181. foreach ($records as &$record) {
  7182. foreach ($pairs as $column => $value) {
  7183. if ($operation == 'create') {
  7184. $record->$column = $value;
  7185. } else {
  7186. if (isset($record->$column)) {
  7187. unset($record->$column);
  7188. }
  7189. }
  7190. }
  7191. }
  7192. return $request->withParsedBody($multi ? $records : $records[0]);
  7193. }
  7194. public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
  7195. {
  7196. $handler = $this->getProperty('handler', '');
  7197. if ($handler !== '') {
  7198. $path = RequestUtils::getPathSegment($request, 1);
  7199. if ($path == 'records') {
  7200. $operation = RequestUtils::getOperation($request);
  7201. $tableNames = RequestUtils::getTableNames($request, $this->reflection);
  7202. foreach ($tableNames as $i => $tableName) {
  7203. if (!$this->reflection->hasTable($tableName)) {
  7204. continue;
  7205. }
  7206. $pairs = $this->getPairs($handler, $operation, $tableName);
  7207. if ($i == 0) {
  7208. if (in_array($operation, ['create', 'update', 'increment'])) {
  7209. $request = $this->handleRecord($request, $operation, $pairs);
  7210. }
  7211. }
  7212. $condition = $this->getCondition($tableName, $pairs);
  7213. VariableStore::set("multiTenancy.conditions.$tableName", $condition);
  7214. }
  7215. }
  7216. }
  7217. return $next->handle($request);
  7218. }
  7219. }
  7220. }
  7221. // file: src/Tqdev/PhpCrudApi/Middleware/PageLimitsMiddleware.php
  7222. namespace Tqdev\PhpCrudApi\Middleware {
  7223. use Psr\Http\Message\ResponseInterface;
  7224. use Psr\Http\Message\ServerRequestInterface;
  7225. use Psr\Http\Server\RequestHandlerInterface;
  7226. use Tqdev\PhpCrudApi\Column\ReflectionService;
  7227. use Tqdev\PhpCrudApi\Controller\Responder;
  7228. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  7229. use Tqdev\PhpCrudApi\Middleware\Router\Router;
  7230. use Tqdev\PhpCrudApi\Record\ErrorCode;
  7231. use Tqdev\PhpCrudApi\RequestUtils;
  7232. class PageLimitsMiddleware extends Middleware
  7233. {
  7234. private $reflection;
  7235. public function __construct(Router $router, Responder $responder, array $properties, ReflectionService $reflection)
  7236. {
  7237. parent::__construct($router, $responder, $properties);
  7238. $this->reflection = $reflection;
  7239. }
  7240. public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
  7241. {
  7242. $operation = RequestUtils::getOperation($request);
  7243. if ($operation == 'list') {
  7244. $params = RequestUtils::getParams($request);
  7245. $maxPage = (int) $this->getProperty('pages', '100');
  7246. if (isset($params['page']) && $params['page'] && $maxPage > 0) {
  7247. if (strpos($params['page'][0], ',') === false) {
  7248. $page = $params['page'][0];
  7249. } else {
  7250. list($page, $size) = explode(',', $params['page'][0], 2);
  7251. }
  7252. if ($page > $maxPage) {
  7253. return $this->responder->error(ErrorCode::PAGINATION_FORBIDDEN, '');
  7254. }
  7255. }
  7256. $maxSize = (int) $this->getProperty('records', '1000');
  7257. if (!isset($params['size']) || !$params['size'] && $maxSize > 0) {
  7258. $params['size'] = array($maxSize);
  7259. } else {
  7260. $params['size'] = array(min($params['size'][0], $maxSize));
  7261. }
  7262. $request = RequestUtils::setParams($request, $params);
  7263. }
  7264. return $next->handle($request);
  7265. }
  7266. }
  7267. }
  7268. // file: src/Tqdev/PhpCrudApi/Middleware/ReconnectMiddleware.php
  7269. namespace Tqdev\PhpCrudApi\Middleware {
  7270. use Psr\Http\Message\ResponseInterface;
  7271. use Psr\Http\Message\ServerRequestInterface;
  7272. use Psr\Http\Server\RequestHandlerInterface;
  7273. use Tqdev\PhpCrudApi\Column\ReflectionService;
  7274. use Tqdev\PhpCrudApi\Controller\Responder;
  7275. use Tqdev\PhpCrudApi\Database\GenericDB;
  7276. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  7277. use Tqdev\PhpCrudApi\Middleware\Router\Router;
  7278. class ReconnectMiddleware extends Middleware
  7279. {
  7280. private $reflection;
  7281. private $db;
  7282. public function __construct(Router $router, Responder $responder, array $properties, ReflectionService $reflection, GenericDB $db)
  7283. {
  7284. parent::__construct($router, $responder, $properties);
  7285. $this->reflection = $reflection;
  7286. $this->db = $db;
  7287. }
  7288. private function getDriver(): string
  7289. {
  7290. $driverHandler = $this->getProperty('driverHandler', '');
  7291. if ($driverHandler) {
  7292. return call_user_func($driverHandler);
  7293. }
  7294. return '';
  7295. }
  7296. private function getAddress(): string
  7297. {
  7298. $addressHandler = $this->getProperty('addressHandler', '');
  7299. if ($addressHandler) {
  7300. return call_user_func($addressHandler);
  7301. }
  7302. return '';
  7303. }
  7304. private function getPort(): int
  7305. {
  7306. $portHandler = $this->getProperty('portHandler', '');
  7307. if ($portHandler) {
  7308. return call_user_func($portHandler);
  7309. }
  7310. return 0;
  7311. }
  7312. private function getDatabase(): string
  7313. {
  7314. $databaseHandler = $this->getProperty('databaseHandler', '');
  7315. if ($databaseHandler) {
  7316. return call_user_func($databaseHandler);
  7317. }
  7318. return '';
  7319. }
  7320. private function getTables(): array
  7321. {
  7322. $tablesHandler = $this->getProperty('tablesHandler', '');
  7323. if ($tablesHandler) {
  7324. return call_user_func($tablesHandler);
  7325. }
  7326. return [];
  7327. }
  7328. private function getUsername(): string
  7329. {
  7330. $usernameHandler = $this->getProperty('usernameHandler', '');
  7331. if ($usernameHandler) {
  7332. return call_user_func($usernameHandler);
  7333. }
  7334. return '';
  7335. }
  7336. private function getPassword(): string
  7337. {
  7338. $passwordHandler = $this->getProperty('passwordHandler', '');
  7339. if ($passwordHandler) {
  7340. return call_user_func($passwordHandler);
  7341. }
  7342. return '';
  7343. }
  7344. public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
  7345. {
  7346. $driver = $this->getDriver();
  7347. $address = $this->getAddress();
  7348. $port = $this->getPort();
  7349. $database = $this->getDatabase();
  7350. $tables = $this->getTables();
  7351. $username = $this->getUsername();
  7352. $password = $this->getPassword();
  7353. if ($driver || $address || $port || $database || $tables || $username || $password) {
  7354. $this->db->reconstruct($driver, $address, $port, $database, $tables, $username, $password);
  7355. }
  7356. return $next->handle($request);
  7357. }
  7358. }
  7359. }
  7360. // file: src/Tqdev/PhpCrudApi/Middleware/SanitationMiddleware.php
  7361. namespace Tqdev\PhpCrudApi\Middleware {
  7362. use Psr\Http\Message\ResponseInterface;
  7363. use Psr\Http\Message\ServerRequestInterface;
  7364. use Psr\Http\Server\RequestHandlerInterface;
  7365. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedTable;
  7366. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedColumn;
  7367. use Tqdev\PhpCrudApi\Column\ReflectionService;
  7368. use Tqdev\PhpCrudApi\Controller\Responder;
  7369. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  7370. use Tqdev\PhpCrudApi\Middleware\Router\Router;
  7371. use Tqdev\PhpCrudApi\RequestUtils;
  7372. class SanitationMiddleware extends Middleware
  7373. {
  7374. private $reflection;
  7375. public function __construct(Router $router, Responder $responder, array $properties, ReflectionService $reflection)
  7376. {
  7377. parent::__construct($router, $responder, $properties);
  7378. $this->reflection = $reflection;
  7379. }
  7380. private function callHandler($handler, $record, string $operation, ReflectedTable $table) /*: object */
  7381. {
  7382. $context = (array) $record;
  7383. $tableName = $table->getName();
  7384. foreach ($context as $columnName => &$value) {
  7385. if ($table->hasColumn($columnName)) {
  7386. $column = $table->getColumn($columnName);
  7387. $value = call_user_func($handler, $operation, $tableName, $column->serialize(), $value);
  7388. $value = $this->sanitizeType($table, $column, $value);
  7389. }
  7390. }
  7391. return (object) $context;
  7392. }
  7393. private function sanitizeType(ReflectedTable $table, ReflectedColumn $column, $value)
  7394. {
  7395. $tables = $this->getArrayProperty('tables', 'all');
  7396. $types = $this->getArrayProperty('types', 'all');
  7397. if (
  7398. (in_array('all', $tables) || in_array($table->getName(), $tables)) &&
  7399. (in_array('all', $types) || in_array($column->getType(), $types))
  7400. ) {
  7401. if (is_null($value)) {
  7402. return $value;
  7403. }
  7404. if (is_string($value)) {
  7405. $newValue = null;
  7406. switch ($column->getType()) {
  7407. case 'integer':
  7408. case 'bigint':
  7409. $newValue = filter_var(trim($value), FILTER_VALIDATE_INT, FILTER_NULL_ON_FAILURE);
  7410. break;
  7411. case 'decimal':
  7412. $newValue = filter_var(trim($value), FILTER_VALIDATE_FLOAT, FILTER_NULL_ON_FAILURE);
  7413. if (is_float($newValue)) {
  7414. $newValue = number_format($newValue, $column->getScale(), '.', '');
  7415. }
  7416. break;
  7417. case 'float':
  7418. case 'double':
  7419. $newValue = filter_var(trim($value), FILTER_VALIDATE_FLOAT, FILTER_NULL_ON_FAILURE);
  7420. break;
  7421. case 'boolean':
  7422. $newValue = filter_var(trim($value), FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE);
  7423. break;
  7424. case 'date':
  7425. $time = strtotime(trim($value));
  7426. if ($time !== false) {
  7427. $newValue = date('Y-m-d', $time);
  7428. }
  7429. break;
  7430. case 'time':
  7431. $time = strtotime(trim($value));
  7432. if ($time !== false) {
  7433. $newValue = date('H:i:s', $time);
  7434. }
  7435. break;
  7436. case 'timestamp':
  7437. $time = strtotime(trim($value));
  7438. if ($time !== false) {
  7439. $newValue = date('Y-m-d H:i:s', $time);
  7440. }
  7441. break;
  7442. case 'blob':
  7443. case 'varbinary':
  7444. // allow base64url format
  7445. $newValue = strtr(trim($value), '-_', '+/');
  7446. break;
  7447. case 'clob':
  7448. case 'varchar':
  7449. $newValue = $value;
  7450. break;
  7451. case 'geometry':
  7452. $newValue = trim($value);
  7453. break;
  7454. }
  7455. if (!is_null($newValue)) {
  7456. $value = $newValue;
  7457. }
  7458. } else {
  7459. switch ($column->getType()) {
  7460. case 'integer':
  7461. case 'bigint':
  7462. if (is_float($value)) {
  7463. $value = (int) round($value);
  7464. }
  7465. break;
  7466. case 'decimal':
  7467. if (is_float($value) || is_int($value)) {
  7468. $value = number_format((float) $value, $column->getScale(), '.', '');
  7469. }
  7470. break;
  7471. }
  7472. }
  7473. // post process
  7474. }
  7475. return $value;
  7476. }
  7477. public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
  7478. {
  7479. $operation = RequestUtils::getOperation($request);
  7480. if (in_array($operation, ['create', 'update', 'increment'])) {
  7481. $tableName = RequestUtils::getPathSegment($request, 2);
  7482. if ($this->reflection->hasTable($tableName)) {
  7483. $record = $request->getParsedBody();
  7484. if ($record !== null) {
  7485. $handler = $this->getProperty('handler', '');
  7486. if ($handler !== '') {
  7487. $table = $this->reflection->getTable($tableName);
  7488. if (is_array($record)) {
  7489. foreach ($record as &$r) {
  7490. $r = $this->callHandler($handler, $r, $operation, $table);
  7491. }
  7492. } else {
  7493. $record = $this->callHandler($handler, $record, $operation, $table);
  7494. }
  7495. $request = $request->withParsedBody($record);
  7496. }
  7497. }
  7498. }
  7499. }
  7500. return $next->handle($request);
  7501. }
  7502. }
  7503. }
  7504. // file: src/Tqdev/PhpCrudApi/Middleware/SslRedirectMiddleware.php
  7505. namespace Tqdev\PhpCrudApi\Middleware {
  7506. use Psr\Http\Message\ResponseInterface;
  7507. use Psr\Http\Message\ServerRequestInterface;
  7508. use Psr\Http\Server\RequestHandlerInterface;
  7509. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  7510. use Tqdev\PhpCrudApi\ResponseFactory;
  7511. class SslRedirectMiddleware extends Middleware
  7512. {
  7513. public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
  7514. {
  7515. $uri = $request->getUri();
  7516. $scheme = $uri->getScheme();
  7517. if ($scheme == 'http') {
  7518. $uri = $request->getUri();
  7519. $uri = $uri->withScheme('https');
  7520. $response = ResponseFactory::fromStatus(301);
  7521. $response = $response->withHeader('Location', $uri->__toString());
  7522. } else {
  7523. $response = $next->handle($request);
  7524. }
  7525. return $response;
  7526. }
  7527. }
  7528. }
  7529. // file: src/Tqdev/PhpCrudApi/Middleware/ValidationMiddleware.php
  7530. namespace Tqdev\PhpCrudApi\Middleware {
  7531. use Psr\Http\Message\ResponseInterface;
  7532. use Psr\Http\Message\ServerRequestInterface;
  7533. use Psr\Http\Server\RequestHandlerInterface;
  7534. use Tqdev\PhpCrudApi\Column\ReflectionService;
  7535. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedTable;
  7536. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedColumn;
  7537. use Tqdev\PhpCrudApi\Controller\Responder;
  7538. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  7539. use Tqdev\PhpCrudApi\Middleware\Router\Router;
  7540. use Tqdev\PhpCrudApi\Record\ErrorCode;
  7541. use Tqdev\PhpCrudApi\RequestUtils;
  7542. class ValidationMiddleware extends Middleware
  7543. {
  7544. private $reflection;
  7545. public function __construct(Router $router, Responder $responder, array $properties, ReflectionService $reflection)
  7546. {
  7547. parent::__construct($router, $responder, $properties);
  7548. $this->reflection = $reflection;
  7549. }
  7550. private function callHandler($handler, $record, string $operation, ReflectedTable $table) /*: ResponseInterface?*/
  7551. {
  7552. $context = (array) $record;
  7553. $details = array();
  7554. $tableName = $table->getName();
  7555. foreach ($context as $columnName => $value) {
  7556. if ($table->hasColumn($columnName)) {
  7557. $column = $table->getColumn($columnName);
  7558. $valid = call_user_func($handler, $operation, $tableName, $column->serialize(), $value, $context);
  7559. if ($valid === true || $valid === '') {
  7560. $valid = $this->validateType($table, $column, $value);
  7561. }
  7562. if ($valid !== true && $valid !== '') {
  7563. $details[$columnName] = $valid;
  7564. }
  7565. }
  7566. }
  7567. if (count($details) > 0) {
  7568. return $this->responder->error(ErrorCode::INPUT_VALIDATION_FAILED, $tableName, $details);
  7569. }
  7570. return null;
  7571. }
  7572. private function validateType(ReflectedTable $table, ReflectedColumn $column, $value)
  7573. {
  7574. $tables = $this->getArrayProperty('tables', 'all');
  7575. $types = $this->getArrayProperty('types', 'all');
  7576. if (
  7577. (in_array('all', $tables) || in_array($table->getName(), $tables)) &&
  7578. (in_array('all', $types) || in_array($column->getType(), $types))
  7579. ) {
  7580. if (is_null($value)) {
  7581. return ($column->getNullable() ? true : "cannot be null");
  7582. }
  7583. if (is_string($value)) {
  7584. // check for whitespace
  7585. switch ($column->getType()) {
  7586. case 'varchar':
  7587. case 'clob':
  7588. break;
  7589. default:
  7590. if (strlen(trim($value)) != strlen($value)) {
  7591. return 'illegal whitespace';
  7592. }
  7593. break;
  7594. }
  7595. // try to parse
  7596. switch ($column->getType()) {
  7597. case 'integer':
  7598. case 'bigint':
  7599. if (
  7600. filter_var($value, FILTER_SANITIZE_NUMBER_INT) !== $value ||
  7601. filter_var($value, FILTER_VALIDATE_INT) === false
  7602. ) {
  7603. return 'invalid integer';
  7604. }
  7605. break;
  7606. case 'decimal':
  7607. if (strpos($value, '.') !== false) {
  7608. list($whole, $decimals) = explode('.', ltrim($value, '-'), 2);
  7609. } else {
  7610. list($whole, $decimals) = array(ltrim($value, '-'), '');
  7611. }
  7612. if (strlen($whole) > 0 && !ctype_digit($whole)) {
  7613. return 'invalid decimal';
  7614. }
  7615. if (strlen($decimals) > 0 && !ctype_digit($decimals)) {
  7616. return 'invalid decimal';
  7617. }
  7618. if (strlen($whole) > $column->getPrecision() - $column->getScale()) {
  7619. return 'decimal too large';
  7620. }
  7621. if (strlen($decimals) > $column->getScale()) {
  7622. return 'decimal too precise';
  7623. }
  7624. break;
  7625. case 'float':
  7626. case 'double':
  7627. if (
  7628. filter_var($value, FILTER_SANITIZE_NUMBER_FLOAT) !== $value ||
  7629. filter_var($value, FILTER_VALIDATE_FLOAT) === false
  7630. ) {
  7631. return 'invalid float';
  7632. }
  7633. break;
  7634. case 'boolean':
  7635. if (!in_array(strtolower($value), array('true', 'false'))) {
  7636. return 'invalid boolean';
  7637. }
  7638. break;
  7639. case 'date':
  7640. if (date_create_from_format('Y-m-d', $value) === false) {
  7641. return 'invalid date';
  7642. }
  7643. break;
  7644. case 'time':
  7645. if (date_create_from_format('H:i:s', $value) === false) {
  7646. return 'invalid time';
  7647. }
  7648. break;
  7649. case 'timestamp':
  7650. if (date_create_from_format('Y-m-d H:i:s', $value) === false) {
  7651. return 'invalid timestamp';
  7652. }
  7653. break;
  7654. case 'clob':
  7655. case 'varchar':
  7656. if ($column->hasLength() && mb_strlen($value, 'UTF-8') > $column->getLength()) {
  7657. return 'string too long';
  7658. }
  7659. break;
  7660. case 'blob':
  7661. case 'varbinary':
  7662. if (base64_decode($value, true) === false) {
  7663. return 'invalid base64';
  7664. }
  7665. if ($column->hasLength() && strlen(base64_decode($value)) > $column->getLength()) {
  7666. return 'string too long';
  7667. }
  7668. break;
  7669. case 'geometry':
  7670. // no checks yet
  7671. break;
  7672. }
  7673. } else { // check non-string types
  7674. switch ($column->getType()) {
  7675. case 'integer':
  7676. case 'bigint':
  7677. if (!is_int($value)) {
  7678. return 'invalid integer';
  7679. }
  7680. break;
  7681. case 'float':
  7682. case 'double':
  7683. if (!is_float($value) && !is_int($value)) {
  7684. return 'invalid float';
  7685. }
  7686. break;
  7687. case 'boolean':
  7688. if (!is_bool($value) && ($value !== 0) && ($value !== 1)) {
  7689. return 'invalid boolean';
  7690. }
  7691. break;
  7692. default:
  7693. return 'invalid ' . $column->getType();
  7694. }
  7695. }
  7696. // extra checks
  7697. switch ($column->getType()) {
  7698. case 'integer': // 4 byte signed
  7699. $value = filter_var($value, FILTER_VALIDATE_INT);
  7700. if ($value > 2147483647 || $value < -2147483648) {
  7701. return 'invalid integer';
  7702. }
  7703. break;
  7704. }
  7705. }
  7706. return (true);
  7707. }
  7708. public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
  7709. {
  7710. $operation = RequestUtils::getOperation($request);
  7711. if (in_array($operation, ['create', 'update', 'increment'])) {
  7712. $tableName = RequestUtils::getPathSegment($request, 2);
  7713. if ($this->reflection->hasTable($tableName)) {
  7714. $record = $request->getParsedBody();
  7715. if ($record !== null) {
  7716. $handler = $this->getProperty('handler', '');
  7717. if ($handler !== '') {
  7718. $table = $this->reflection->getTable($tableName);
  7719. if (is_array($record)) {
  7720. foreach ($record as $r) {
  7721. $response = $this->callHandler($handler, $r, $operation, $table);
  7722. if ($response !== null) {
  7723. return $response;
  7724. }
  7725. }
  7726. } else {
  7727. $response = $this->callHandler($handler, $record, $operation, $table);
  7728. if ($response !== null) {
  7729. return $response;
  7730. }
  7731. }
  7732. }
  7733. }
  7734. }
  7735. }
  7736. return $next->handle($request);
  7737. }
  7738. }
  7739. }
  7740. // file: src/Tqdev/PhpCrudApi/Middleware/XmlMiddleware.php
  7741. namespace Tqdev\PhpCrudApi\Middleware {
  7742. use Psr\Http\Message\ResponseInterface;
  7743. use Psr\Http\Message\ServerRequestInterface;
  7744. use Psr\Http\Server\RequestHandlerInterface;
  7745. use Tqdev\PhpCrudApi\Column\ReflectionService;
  7746. use Tqdev\PhpCrudApi\Controller\Responder;
  7747. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  7748. use Tqdev\PhpCrudApi\Middleware\Router\Router;
  7749. use Tqdev\PhpCrudApi\RequestUtils;
  7750. use Tqdev\PhpCrudApi\ResponseFactory;
  7751. class XmlMiddleware extends Middleware
  7752. {
  7753. private $reflection;
  7754. public function __construct(Router $router, Responder $responder, array $properties, ReflectionService $reflection)
  7755. {
  7756. parent::__construct($router, $responder, $properties);
  7757. $this->reflection = $reflection;
  7758. }
  7759. private function json2xml($json, $types = 'null,boolean,number,string,object,array')
  7760. {
  7761. $a = json_decode($json);
  7762. $d = new \DOMDocument();
  7763. $c = $d->createElement("root");
  7764. $d->appendChild($c);
  7765. $t = function ($v) {
  7766. $type = gettype($v);
  7767. switch ($type) {
  7768. case 'integer':
  7769. return 'number';
  7770. case 'double':
  7771. return 'number';
  7772. default:
  7773. return strtolower($type);
  7774. }
  7775. };
  7776. $ts = explode(',', $types);
  7777. $f = function ($f, $c, $a, $s = false) use ($t, $d, $ts) {
  7778. if (in_array($t($a), $ts)) {
  7779. $c->setAttribute('type', $t($a));
  7780. }
  7781. if ($t($a) != 'array' && $t($a) != 'object') {
  7782. if ($t($a) == 'boolean') {
  7783. $c->appendChild($d->createTextNode($a ? 'true' : 'false'));
  7784. } else {
  7785. $c->appendChild($d->createTextNode($a));
  7786. }
  7787. } else {
  7788. foreach ($a as $k => $v) {
  7789. if ($k == '__type' && $t($a) == 'object') {
  7790. $c->setAttribute('__type', $v);
  7791. } else {
  7792. if ($t($v) == 'object') {
  7793. $ch = $c->appendChild($d->createElementNS(null, $s ? 'item' : $k));
  7794. $f($f, $ch, $v);
  7795. } else if ($t($v) == 'array') {
  7796. $ch = $c->appendChild($d->createElementNS(null, $s ? 'item' : $k));
  7797. $f($f, $ch, $v, true);
  7798. } else {
  7799. $va = $d->createElementNS(null, $s ? 'item' : $k);
  7800. if ($t($v) == 'boolean') {
  7801. $va->appendChild($d->createTextNode($v ? 'true' : 'false'));
  7802. } else {
  7803. $va->appendChild($d->createTextNode($v));
  7804. }
  7805. $ch = $c->appendChild($va);
  7806. if (in_array($t($v), $ts)) {
  7807. $ch->setAttribute('type', $t($v));
  7808. }
  7809. }
  7810. }
  7811. }
  7812. }
  7813. };
  7814. $f($f, $c, $a, $t($a) == 'array');
  7815. return $d->saveXML($d->documentElement);
  7816. }
  7817. private function xml2json($xml)
  7818. {
  7819. $a = @dom_import_simplexml(simplexml_load_string($xml));
  7820. if (!$a) {
  7821. return null;
  7822. }
  7823. $t = function ($v) {
  7824. $t = $v->getAttribute('type');
  7825. $txt = $v->firstChild->nodeType == XML_TEXT_NODE;
  7826. return $t ?: ($txt ? 'string' : 'object');
  7827. };
  7828. $f = function ($f, $a) use ($t) {
  7829. $c = null;
  7830. if ($t($a) == 'null') {
  7831. $c = null;
  7832. } else if ($t($a) == 'boolean') {
  7833. $b = substr(strtolower($a->textContent), 0, 1);
  7834. $c = in_array($b, array('1', 't'));
  7835. } else if ($t($a) == 'number') {
  7836. $c = $a->textContent + 0;
  7837. } else if ($t($a) == 'string') {
  7838. $c = $a->textContent;
  7839. } else if ($t($a) == 'object') {
  7840. $c = array();
  7841. if ($a->getAttribute('__type')) {
  7842. $c['__type'] = $a->getAttribute('__type');
  7843. }
  7844. for ($i = 0; $i < $a->childNodes->length; $i++) {
  7845. $v = $a->childNodes[$i];
  7846. $c[$v->nodeName] = $f($f, $v);
  7847. }
  7848. $c = (object) $c;
  7849. } else if ($t($a) == 'array') {
  7850. $c = array();
  7851. for ($i = 0; $i < $a->childNodes->length; $i++) {
  7852. $v = $a->childNodes[$i];
  7853. $c[$i] = $f($f, $v);
  7854. }
  7855. }
  7856. return $c;
  7857. };
  7858. $c = $f($f, $a);
  7859. return json_encode($c);
  7860. }
  7861. public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
  7862. {
  7863. parse_str($request->getUri()->getQuery(), $params);
  7864. $isXml = isset($params['format']) && $params['format'] == 'xml';
  7865. if ($isXml) {
  7866. $body = $request->getBody()->getContents();
  7867. if ($body) {
  7868. $json = $this->xml2json($body);
  7869. $request = $request->withParsedBody(json_decode($json));
  7870. }
  7871. }
  7872. $response = $next->handle($request);
  7873. if ($isXml) {
  7874. $body = $response->getBody()->getContents();
  7875. if ($body) {
  7876. $types = implode(',', $this->getArrayProperty('types', 'null,array'));
  7877. if ($types == '' || $types == 'all') {
  7878. $xml = $this->json2xml($body);
  7879. } else {
  7880. $xml = $this->json2xml($body, $types);
  7881. }
  7882. $response = ResponseFactory::fromXml(ResponseFactory::OK, $xml);
  7883. }
  7884. }
  7885. return $response;
  7886. }
  7887. }
  7888. }
  7889. // file: src/Tqdev/PhpCrudApi/Middleware/XsrfMiddleware.php
  7890. namespace Tqdev\PhpCrudApi\Middleware {
  7891. use Psr\Http\Message\ResponseInterface;
  7892. use Psr\Http\Message\ServerRequestInterface;
  7893. use Psr\Http\Server\RequestHandlerInterface;
  7894. use Tqdev\PhpCrudApi\Controller\Responder;
  7895. use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
  7896. use Tqdev\PhpCrudApi\Record\ErrorCode;
  7897. class XsrfMiddleware extends Middleware
  7898. {
  7899. private function getToken(): string
  7900. {
  7901. $cookieName = $this->getProperty('cookieName', 'XSRF-TOKEN');
  7902. if (isset($_COOKIE[$cookieName])) {
  7903. $token = $_COOKIE[$cookieName];
  7904. } else {
  7905. $secure = isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on';
  7906. $token = bin2hex(random_bytes(8));
  7907. if (!headers_sent()) {
  7908. setcookie($cookieName, $token, 0, '', '', $secure);
  7909. }
  7910. }
  7911. return $token;
  7912. }
  7913. public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
  7914. {
  7915. $token = $this->getToken();
  7916. $method = $request->getMethod();
  7917. $excludeMethods = $this->getArrayProperty('excludeMethods', 'OPTIONS,GET');
  7918. if (!in_array($method, $excludeMethods)) {
  7919. $headerName = $this->getProperty('headerName', 'X-XSRF-TOKEN');
  7920. if ($token != $request->getHeader($headerName)) {
  7921. return $this->responder->error(ErrorCode::BAD_OR_MISSING_XSRF_TOKEN, '');
  7922. }
  7923. }
  7924. return $next->handle($request);
  7925. }
  7926. }
  7927. }
  7928. // file: src/Tqdev/PhpCrudApi/OpenApi/OpenApiBuilder.php
  7929. namespace Tqdev\PhpCrudApi\OpenApi {
  7930. use Tqdev\PhpCrudApi\Column\ReflectionService;
  7931. use Tqdev\PhpCrudApi\OpenApi\OpenApiDefinition;
  7932. class OpenApiBuilder
  7933. {
  7934. private $openapi;
  7935. private $records;
  7936. private $columns;
  7937. private $builders;
  7938. public function __construct(ReflectionService $reflection, array $base, array $controllers, array $builders)
  7939. {
  7940. $this->openapi = new OpenApiDefinition($base);
  7941. $this->records = in_array('records', $controllers) ? new OpenApiRecordsBuilder($this->openapi, $reflection) : null;
  7942. $this->columns = in_array('columns', $controllers) ? new OpenApiColumnsBuilder($this->openapi) : null;
  7943. $this->builders = array();
  7944. foreach ($builders as $className) {
  7945. $this->builders[] = new $className($this->openapi, $reflection);
  7946. }
  7947. }
  7948. private function getServerUrl(): string
  7949. {
  7950. $protocol = @$_SERVER['HTTP_X_FORWARDED_PROTO'] ?: @$_SERVER['REQUEST_SCHEME'] ?: ((isset($_SERVER["HTTPS"]) && $_SERVER["HTTPS"] == "on") ? "https" : "http");
  7951. $port = @intval($_SERVER['HTTP_X_FORWARDED_PORT']) ?: @intval($_SERVER["SERVER_PORT"]) ?: (($protocol === 'https') ? 443 : 80);
  7952. $host = @explode(":", $_SERVER['HTTP_HOST'])[0] ?: @$_SERVER['SERVER_NAME'] ?: @$_SERVER['SERVER_ADDR'];
  7953. $port = ($protocol === 'https' && $port === 443) || ($protocol === 'http' && $port === 80) ? '' : ':' . $port;
  7954. $path = @trim(substr($_SERVER['REQUEST_URI'], 0, strpos($_SERVER['REQUEST_URI'], '/openapi')), '/');
  7955. return sprintf('%s://%s%s/%s', $protocol, $host, $port, $path);
  7956. }
  7957. public function build(): OpenApiDefinition
  7958. {
  7959. $this->openapi->set("openapi", "3.0.0");
  7960. if (!$this->openapi->has("servers") && isset($_SERVER['REQUEST_URI'])) {
  7961. $this->openapi->set("servers|0|url", $this->getServerUrl());
  7962. }
  7963. if ($this->records) {
  7964. $this->records->build();
  7965. }
  7966. if ($this->columns) {
  7967. $this->columns->build();
  7968. }
  7969. foreach ($this->builders as $builder) {
  7970. $builder->build();
  7971. }
  7972. return $this->openapi;
  7973. }
  7974. }
  7975. }
  7976. // file: src/Tqdev/PhpCrudApi/OpenApi/OpenApiColumnsBuilder.php
  7977. namespace Tqdev\PhpCrudApi\OpenApi {
  7978. use Tqdev\PhpCrudApi\OpenApi\OpenApiDefinition;
  7979. class OpenApiColumnsBuilder
  7980. {
  7981. private $openapi;
  7982. private $operations = [
  7983. 'database' => [
  7984. 'read' => 'get',
  7985. ],
  7986. 'table' => [
  7987. 'create' => 'post',
  7988. 'read' => 'get',
  7989. 'update' => 'put', //rename
  7990. 'delete' => 'delete',
  7991. ],
  7992. 'column' => [
  7993. 'create' => 'post',
  7994. 'read' => 'get',
  7995. 'update' => 'put',
  7996. 'delete' => 'delete',
  7997. ]
  7998. ];
  7999. public function __construct(OpenApiDefinition $openapi)
  8000. {
  8001. $this->openapi = $openapi;
  8002. }
  8003. public function build() /*: void*/
  8004. {
  8005. $this->setPaths();
  8006. $this->openapi->set("components|responses|boolSuccess|description", "boolean indicating success or failure");
  8007. $this->openapi->set("components|responses|boolSuccess|content|application/json|schema|type", "boolean");
  8008. $this->setComponentSchema();
  8009. $this->setComponentResponse();
  8010. $this->setComponentRequestBody();
  8011. $this->setComponentParameters();
  8012. foreach (array_keys($this->operations) as $index => $type) {
  8013. $this->setTag($index, $type);
  8014. }
  8015. }
  8016. private function setPaths() /*: void*/
  8017. {
  8018. foreach (array_keys($this->operations) as $type) {
  8019. foreach ($this->operations[$type] as $operation => $method) {
  8020. $parameters = [];
  8021. switch ($type) {
  8022. case 'database':
  8023. $path = '/columns';
  8024. break;
  8025. case 'table':
  8026. $path = $operation == 'create' ? '/columns' : '/columns/{table}';
  8027. break;
  8028. case 'column':
  8029. $path = $operation == 'create' ? '/columns/{table}' : '/columns/{table}/{column}';
  8030. break;
  8031. }
  8032. if (strpos($path, '{table}')) {
  8033. $parameters[] = 'table';
  8034. }
  8035. if (strpos($path, '{column}')) {
  8036. $parameters[] = 'column';
  8037. }
  8038. foreach ($parameters as $p => $parameter) {
  8039. $this->openapi->set("paths|$path|$method|parameters|$p|\$ref", "#/components/parameters/$parameter");
  8040. }
  8041. $operationType = $operation . ucfirst($type);
  8042. if (in_array($operation, ['create', 'update'])) {
  8043. $this->openapi->set("paths|$path|$method|requestBody|\$ref", "#/components/requestBodies/$operationType");
  8044. }
  8045. $this->openapi->set("paths|$path|$method|tags|0", "$type");
  8046. $this->openapi->set("paths|$path|$method|operationId", "$operation" . "_" . "$type");
  8047. if ($operationType == 'updateTable') {
  8048. $this->openapi->set("paths|$path|$method|description", "rename table");
  8049. } else {
  8050. $this->openapi->set("paths|$path|$method|description", "$operation $type");
  8051. }
  8052. switch ($operation) {
  8053. case 'read':
  8054. $this->openapi->set("paths|$path|$method|responses|200|\$ref", "#/components/responses/$operationType");
  8055. break;
  8056. case 'create':
  8057. case 'update':
  8058. case 'delete':
  8059. $this->openapi->set("paths|$path|$method|responses|200|\$ref", "#/components/responses/boolSuccess");
  8060. break;
  8061. }
  8062. }
  8063. }
  8064. }
  8065. private function setComponentSchema() /*: void*/
  8066. {
  8067. foreach (array_keys($this->operations) as $type) {
  8068. foreach (array_keys($this->operations[$type]) as $operation) {
  8069. if ($operation == 'delete') {
  8070. continue;
  8071. }
  8072. $operationType = $operation . ucfirst($type);
  8073. $prefix = "components|schemas|$operationType";
  8074. $this->openapi->set("$prefix|type", "object");
  8075. switch ($type) {
  8076. case 'database':
  8077. $this->openapi->set("$prefix|properties|tables|type", 'array');
  8078. $this->openapi->set("$prefix|properties|tables|items|\$ref", "#/components/schemas/readTable");
  8079. break;
  8080. case 'table':
  8081. if ($operation == 'update') {
  8082. $this->openapi->set("$prefix|required", ['name']);
  8083. $this->openapi->set("$prefix|properties|name|type", 'string');
  8084. } else {
  8085. $this->openapi->set("$prefix|properties|name|type", 'string');
  8086. if ($operation == 'read') {
  8087. $this->openapi->set("$prefix|properties|type|type", 'string');
  8088. }
  8089. $this->openapi->set("$prefix|properties|columns|type", 'array');
  8090. $this->openapi->set("$prefix|properties|columns|items|\$ref", "#/components/schemas/readColumn");
  8091. }
  8092. break;
  8093. case 'column':
  8094. $this->openapi->set("$prefix|required", ['name', 'type']);
  8095. $this->openapi->set("$prefix|properties|name|type", 'string');
  8096. $this->openapi->set("$prefix|properties|type|type", 'string');
  8097. $this->openapi->set("$prefix|properties|length|type", 'integer');
  8098. $this->openapi->set("$prefix|properties|length|format", "int64");
  8099. $this->openapi->set("$prefix|properties|precision|type", 'integer');
  8100. $this->openapi->set("$prefix|properties|precision|format", "int64");
  8101. $this->openapi->set("$prefix|properties|scale|type", 'integer');
  8102. $this->openapi->set("$prefix|properties|scale|format", "int64");
  8103. $this->openapi->set("$prefix|properties|nullable|type", 'boolean');
  8104. $this->openapi->set("$prefix|properties|pk|type", 'boolean');
  8105. $this->openapi->set("$prefix|properties|fk|type", 'string');
  8106. break;
  8107. }
  8108. }
  8109. }
  8110. }
  8111. private function setComponentResponse() /*: void*/
  8112. {
  8113. foreach (array_keys($this->operations) as $type) {
  8114. foreach (array_keys($this->operations[$type]) as $operation) {
  8115. if ($operation != 'read') {
  8116. continue;
  8117. }
  8118. $operationType = $operation . ucfirst($type);
  8119. $this->openapi->set("components|responses|$operationType|description", "single $type record");
  8120. $this->openapi->set("components|responses|$operationType|content|application/json|schema|\$ref", "#/components/schemas/$operationType");
  8121. }
  8122. }
  8123. }
  8124. private function setComponentRequestBody() /*: void*/
  8125. {
  8126. foreach (array_keys($this->operations) as $type) {
  8127. foreach (array_keys($this->operations[$type]) as $operation) {
  8128. if (!in_array($operation, ['create', 'update'])) {
  8129. continue;
  8130. }
  8131. $operationType = $operation . ucfirst($type);
  8132. $this->openapi->set("components|requestBodies|$operationType|description", "single $type record");
  8133. $this->openapi->set("components|requestBodies|$operationType|content|application/json|schema|\$ref", "#/components/schemas/$operationType");
  8134. }
  8135. }
  8136. }
  8137. private function setComponentParameters() /*: void*/
  8138. {
  8139. $this->openapi->set("components|parameters|table|name", "table");
  8140. $this->openapi->set("components|parameters|table|in", "path");
  8141. $this->openapi->set("components|parameters|table|schema|type", "string");
  8142. $this->openapi->set("components|parameters|table|description", "table name");
  8143. $this->openapi->set("components|parameters|table|required", true);
  8144. $this->openapi->set("components|parameters|column|name", "column");
  8145. $this->openapi->set("components|parameters|column|in", "path");
  8146. $this->openapi->set("components|parameters|column|schema|type", "string");
  8147. $this->openapi->set("components|parameters|column|description", "column name");
  8148. $this->openapi->set("components|parameters|column|required", true);
  8149. }
  8150. private function setTag(int $index, string $type) /*: void*/
  8151. {
  8152. $this->openapi->set("tags|$index|name", "$type");
  8153. $this->openapi->set("tags|$index|description", "$type operations");
  8154. }
  8155. }
  8156. }
  8157. // file: src/Tqdev/PhpCrudApi/OpenApi/OpenApiDefinition.php
  8158. namespace Tqdev\PhpCrudApi\OpenApi {
  8159. class OpenApiDefinition implements \JsonSerializable
  8160. {
  8161. private $root;
  8162. public function __construct(array $base)
  8163. {
  8164. $this->root = $base;
  8165. }
  8166. public function set(string $path, $value) /*: void*/
  8167. {
  8168. $parts = explode('|', trim($path, '|'));
  8169. $current = &$this->root;
  8170. while (count($parts) > 0) {
  8171. $part = array_shift($parts);
  8172. if (!isset($current[$part])) {
  8173. $current[$part] = [];
  8174. }
  8175. $current = &$current[$part];
  8176. }
  8177. $current = $value;
  8178. }
  8179. public function has(string $path): bool
  8180. {
  8181. $parts = explode('|', trim($path, '|'));
  8182. $current = &$this->root;
  8183. while (count($parts) > 0) {
  8184. $part = array_shift($parts);
  8185. if (!isset($current[$part])) {
  8186. return false;
  8187. }
  8188. $current = &$current[$part];
  8189. }
  8190. return true;
  8191. }
  8192. public function jsonSerialize()
  8193. {
  8194. return $this->root;
  8195. }
  8196. }
  8197. }
  8198. // file: src/Tqdev/PhpCrudApi/OpenApi/OpenApiRecordsBuilder.php
  8199. namespace Tqdev\PhpCrudApi\OpenApi {
  8200. use Tqdev\PhpCrudApi\Column\ReflectionService;
  8201. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedColumn;
  8202. use Tqdev\PhpCrudApi\Middleware\Communication\VariableStore;
  8203. use Tqdev\PhpCrudApi\OpenApi\OpenApiDefinition;
  8204. class OpenApiRecordsBuilder
  8205. {
  8206. private $openapi;
  8207. private $reflection;
  8208. private $operations = [
  8209. 'list' => 'get',
  8210. 'create' => 'post',
  8211. 'read' => 'get',
  8212. 'update' => 'put',
  8213. 'delete' => 'delete',
  8214. 'increment' => 'patch',
  8215. ];
  8216. private $types = [
  8217. 'integer' => ['type' => 'integer', 'format' => 'int32'],
  8218. 'bigint' => ['type' => 'integer', 'format' => 'int64'],
  8219. 'varchar' => ['type' => 'string'],
  8220. 'clob' => ['type' => 'string', 'format' => 'large-string'], //custom format
  8221. 'varbinary' => ['type' => 'string', 'format' => 'byte'],
  8222. 'blob' => ['type' => 'string', 'format' => 'large-byte'], //custom format
  8223. 'decimal' => ['type' => 'string', 'format' => 'decimal'], //custom format
  8224. 'float' => ['type' => 'number', 'format' => 'float'],
  8225. 'double' => ['type' => 'number', 'format' => 'double'],
  8226. 'date' => ['type' => 'string', 'format' => 'date'],
  8227. 'time' => ['type' => 'string', 'format' => 'time'], //custom format
  8228. 'timestamp' => ['type' => 'string', 'format' => 'date-time'],
  8229. 'geometry' => ['type' => 'string', 'format' => 'geometry'], //custom format
  8230. 'boolean' => ['type' => 'boolean'],
  8231. ];
  8232. public function __construct(OpenApiDefinition $openapi, ReflectionService $reflection)
  8233. {
  8234. $this->openapi = $openapi;
  8235. $this->reflection = $reflection;
  8236. }
  8237. private function getAllTableReferences(): array
  8238. {
  8239. $tableReferences = array();
  8240. foreach ($this->reflection->getTableNames() as $tableName) {
  8241. $table = $this->reflection->getTable($tableName);
  8242. foreach ($table->getColumnNames() as $columnName) {
  8243. $column = $table->getColumn($columnName);
  8244. $referencedTableName = $column->getFk();
  8245. if ($referencedTableName) {
  8246. if (!isset($tableReferences[$referencedTableName])) {
  8247. $tableReferences[$referencedTableName] = array();
  8248. }
  8249. $tableReferences[$referencedTableName][] = "$tableName.$columnName";
  8250. }
  8251. }
  8252. }
  8253. return $tableReferences;
  8254. }
  8255. public function build() /*: void*/
  8256. {
  8257. $tableNames = $this->reflection->getTableNames();
  8258. foreach ($tableNames as $tableName) {
  8259. $this->setPath($tableName);
  8260. }
  8261. $this->openapi->set("components|responses|pk_integer|description", "inserted primary key value (integer)");
  8262. $this->openapi->set("components|responses|pk_integer|content|application/json|schema|type", "integer");
  8263. $this->openapi->set("components|responses|pk_integer|content|application/json|schema|format", "int64");
  8264. $this->openapi->set("components|responses|pk_string|description", "inserted primary key value (string)");
  8265. $this->openapi->set("components|responses|pk_string|content|application/json|schema|type", "string");
  8266. $this->openapi->set("components|responses|pk_string|content|application/json|schema|format", "uuid");
  8267. $this->openapi->set("components|responses|rows_affected|description", "number of rows affected (integer)");
  8268. $this->openapi->set("components|responses|rows_affected|content|application/json|schema|type", "integer");
  8269. $this->openapi->set("components|responses|rows_affected|content|application/json|schema|format", "int64");
  8270. $tableReferences = $this->getAllTableReferences();
  8271. foreach ($tableNames as $tableName) {
  8272. $references = isset($tableReferences[$tableName]) ? $tableReferences[$tableName] : array();
  8273. $this->setComponentSchema($tableName, $references);
  8274. $this->setComponentResponse($tableName);
  8275. $this->setComponentRequestBody($tableName);
  8276. }
  8277. $this->setComponentParameters();
  8278. foreach ($tableNames as $index => $tableName) {
  8279. $this->setTag($index, $tableName);
  8280. }
  8281. }
  8282. private function isOperationOnTableAllowed(string $operation, string $tableName): bool
  8283. {
  8284. $tableHandler = VariableStore::get('authorization.tableHandler');
  8285. if (!$tableHandler) {
  8286. return true;
  8287. }
  8288. return (bool) call_user_func($tableHandler, $operation, $tableName);
  8289. }
  8290. private function isOperationOnColumnAllowed(string $operation, string $tableName, string $columnName): bool
  8291. {
  8292. $columnHandler = VariableStore::get('authorization.columnHandler');
  8293. if (!$columnHandler) {
  8294. return true;
  8295. }
  8296. return (bool) call_user_func($columnHandler, $operation, $tableName, $columnName);
  8297. }
  8298. private function setPath(string $tableName) /*: void*/
  8299. {
  8300. $table = $this->reflection->getTable($tableName);
  8301. $type = $table->getType();
  8302. $pk = $table->getPk();
  8303. $pkName = $pk ? $pk->getName() : '';
  8304. foreach ($this->operations as $operation => $method) {
  8305. if (!$pkName && $operation != 'list') {
  8306. continue;
  8307. }
  8308. if ($type != 'table' && $operation != 'list') {
  8309. continue;
  8310. }
  8311. if (!$this->isOperationOnTableAllowed($operation, $tableName)) {
  8312. continue;
  8313. }
  8314. $parameters = [];
  8315. if (in_array($operation, ['list', 'create'])) {
  8316. $path = sprintf('/records/%s', $tableName);
  8317. if ($operation == 'list') {
  8318. $parameters = ['filter', 'include', 'exclude', 'order', 'size', 'page', 'join'];
  8319. }
  8320. } else {
  8321. $path = sprintf('/records/%s/{id}', $tableName);
  8322. if ($operation == 'read') {
  8323. $parameters = ['pk', 'include', 'exclude', 'join'];
  8324. } else {
  8325. $parameters = ['pk'];
  8326. }
  8327. }
  8328. foreach ($parameters as $p => $parameter) {
  8329. $this->openapi->set("paths|$path|$method|parameters|$p|\$ref", "#/components/parameters/$parameter");
  8330. }
  8331. if (in_array($operation, ['create', 'update', 'increment'])) {
  8332. $this->openapi->set("paths|$path|$method|requestBody|\$ref", "#/components/requestBodies/$operation-" . rawurlencode($tableName));
  8333. }
  8334. $this->openapi->set("paths|$path|$method|tags|0", "$tableName");
  8335. $this->openapi->set("paths|$path|$method|operationId", "$operation" . "_" . "$tableName");
  8336. $this->openapi->set("paths|$path|$method|description", "$operation $tableName");
  8337. switch ($operation) {
  8338. case 'list':
  8339. $this->openapi->set("paths|$path|$method|responses|200|\$ref", "#/components/responses/$operation-" . rawurlencode($tableName));
  8340. break;
  8341. case 'create':
  8342. if ($pk->getType() == 'integer') {
  8343. $this->openapi->set("paths|$path|$method|responses|200|\$ref", "#/components/responses/pk_integer");
  8344. } else {
  8345. $this->openapi->set("paths|$path|$method|responses|200|\$ref", "#/components/responses/pk_string");
  8346. }
  8347. break;
  8348. case 'read':
  8349. $this->openapi->set("paths|$path|$method|responses|200|\$ref", "#/components/responses/$operation-" . rawurlencode($tableName));
  8350. break;
  8351. case 'update':
  8352. case 'delete':
  8353. case 'increment':
  8354. $this->openapi->set("paths|$path|$method|responses|200|\$ref", "#/components/responses/rows_affected");
  8355. break;
  8356. }
  8357. }
  8358. }
  8359. private function getPattern(ReflectedColumn $column): string
  8360. {
  8361. switch ($column->getType()) {
  8362. case 'integer':
  8363. $n = strlen(pow(2, 31));
  8364. return '^-?[0-9]{1,' . $n . '}$';
  8365. case 'bigint':
  8366. $n = strlen(pow(2, 63));
  8367. return '^-?[0-9]{1,' . $n . '}$';
  8368. case 'varchar':
  8369. $l = $column->getLength();
  8370. return '^.{0,' . $l . '}$';
  8371. case 'clob':
  8372. return '^.*$';
  8373. case 'varbinary':
  8374. $l = $column->getLength();
  8375. $b = (int) 4 * ceil($l / 3);
  8376. return '^[A-Za-z0-9+/]{0,' . $b . '}=*$';
  8377. case 'blob':
  8378. return '^[A-Za-z0-9+/]*=*$';
  8379. case 'decimal':
  8380. $p = $column->getPrecision();
  8381. $s = $column->getScale();
  8382. return '^-?[0-9]{1,' . ($p - $s) . '}(\.[0-9]{1,' . $s . '})?$';
  8383. case 'float':
  8384. return '^-?[0-9]+(\.[0-9]+)?([eE]-?[0-9]+)?$';
  8385. case 'double':
  8386. return '^-?[0-9]+(\.[0-9]+)?([eE]-?[0-9]+)?$';
  8387. case 'date':
  8388. return '^[0-9]{4}-[0-9]{2}-[0-9]{2}$';
  8389. case 'time':
  8390. return '^[0-9]{2}:[0-9]{2}:[0-9]{2}$';
  8391. case 'timestamp':
  8392. return '^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$';
  8393. return '';
  8394. case 'geometry':
  8395. return '^(POINT|LINESTRING|POLYGON|MULTIPOINT|MULTILINESTRING|MULTIPOLYGON)\s*\(.*$';
  8396. case 'boolean':
  8397. return '^(true|false)$';
  8398. }
  8399. return '';
  8400. }
  8401. private function setComponentSchema(string $tableName, array $references) /*: void*/
  8402. {
  8403. $table = $this->reflection->getTable($tableName);
  8404. $type = $table->getType();
  8405. $pk = $table->getPk();
  8406. $pkName = $pk ? $pk->getName() : '';
  8407. foreach ($this->operations as $operation => $method) {
  8408. if (!$pkName && $operation != 'list') {
  8409. continue;
  8410. }
  8411. if ($type == 'view' && !in_array($operation, array('read', 'list'))) {
  8412. continue;
  8413. }
  8414. if ($type == 'view' && !$pkName && $operation == 'read') {
  8415. continue;
  8416. }
  8417. if ($operation == 'delete') {
  8418. continue;
  8419. }
  8420. if (!$this->isOperationOnTableAllowed($operation, $tableName)) {
  8421. continue;
  8422. }
  8423. if ($operation == 'list') {
  8424. $this->openapi->set("components|schemas|$operation-$tableName|type", "object");
  8425. $this->openapi->set("components|schemas|$operation-$tableName|properties|results|type", "integer");
  8426. $this->openapi->set("components|schemas|$operation-$tableName|properties|results|format", "int64");
  8427. $this->openapi->set("components|schemas|$operation-$tableName|properties|records|type", "array");
  8428. $prefix = "components|schemas|$operation-$tableName|properties|records|items";
  8429. } else {
  8430. $prefix = "components|schemas|$operation-$tableName";
  8431. }
  8432. $this->openapi->set("$prefix|type", "object");
  8433. foreach ($table->getColumnNames() as $columnName) {
  8434. if (!$this->isOperationOnColumnAllowed($operation, $tableName, $columnName)) {
  8435. continue;
  8436. }
  8437. $column = $table->getColumn($columnName);
  8438. $properties = $this->types[$column->getType()];
  8439. $properties['maxLength'] = $column->hasLength() ? $column->getLength() : 0;
  8440. $properties['nullable'] = $column->getNullable();
  8441. $properties['pattern'] = $this->getPattern($column);
  8442. foreach ($properties as $key => $value) {
  8443. if ($value) {
  8444. $this->openapi->set("$prefix|properties|$columnName|$key", $value);
  8445. }
  8446. }
  8447. if ($column->getPk()) {
  8448. $this->openapi->set("$prefix|properties|$columnName|x-primary-key", true);
  8449. $this->openapi->set("$prefix|properties|$columnName|x-referenced", $references);
  8450. }
  8451. $fk = $column->getFk();
  8452. if ($fk) {
  8453. $this->openapi->set("$prefix|properties|$columnName|x-references", $fk);
  8454. }
  8455. }
  8456. }
  8457. }
  8458. private function setComponentResponse(string $tableName) /*: void*/
  8459. {
  8460. $table = $this->reflection->getTable($tableName);
  8461. $type = $table->getType();
  8462. $pk = $table->getPk();
  8463. $pkName = $pk ? $pk->getName() : '';
  8464. foreach (['list', 'read'] as $operation) {
  8465. if (!$pkName && $operation != 'list') {
  8466. continue;
  8467. }
  8468. if ($type != 'table' && $operation != 'list') {
  8469. continue;
  8470. }
  8471. if (!$this->isOperationOnTableAllowed($operation, $tableName)) {
  8472. continue;
  8473. }
  8474. if ($operation == 'list') {
  8475. $this->openapi->set("components|responses|$operation-$tableName|description", "list of $tableName records");
  8476. } else {
  8477. $this->openapi->set("components|responses|$operation-$tableName|description", "single $tableName record");
  8478. }
  8479. $this->openapi->set("components|responses|$operation-$tableName|content|application/json|schema|\$ref", "#/components/schemas/$operation-" . rawurlencode($tableName));
  8480. }
  8481. }
  8482. private function setComponentRequestBody(string $tableName) /*: void*/
  8483. {
  8484. $table = $this->reflection->getTable($tableName);
  8485. $type = $table->getType();
  8486. $pk = $table->getPk();
  8487. $pkName = $pk ? $pk->getName() : '';
  8488. if ($pkName && $type == 'table') {
  8489. foreach (['create', 'update', 'increment'] as $operation) {
  8490. if (!$this->isOperationOnTableAllowed($operation, $tableName)) {
  8491. continue;
  8492. }
  8493. $this->openapi->set("components|requestBodies|$operation-$tableName|description", "single $tableName record");
  8494. $this->openapi->set("components|requestBodies|$operation-$tableName|content|application/json|schema|\$ref", "#/components/schemas/$operation-" . rawurlencode($tableName));
  8495. }
  8496. }
  8497. }
  8498. private function setComponentParameters() /*: void*/
  8499. {
  8500. $this->openapi->set("components|parameters|pk|name", "id");
  8501. $this->openapi->set("components|parameters|pk|in", "path");
  8502. $this->openapi->set("components|parameters|pk|schema|type", "string");
  8503. $this->openapi->set("components|parameters|pk|description", "primary key value");
  8504. $this->openapi->set("components|parameters|pk|required", true);
  8505. $this->openapi->set("components|parameters|filter|name", "filter");
  8506. $this->openapi->set("components|parameters|filter|in", "query");
  8507. $this->openapi->set("components|parameters|filter|schema|type", "array");
  8508. $this->openapi->set("components|parameters|filter|schema|items|type", "string");
  8509. $this->openapi->set("components|parameters|filter|description", "Filters to be applied. Each filter consists of a column, an operator and a value (comma separated). Example: id,eq,1");
  8510. $this->openapi->set("components|parameters|filter|required", false);
  8511. $this->openapi->set("components|parameters|include|name", "include");
  8512. $this->openapi->set("components|parameters|include|in", "query");
  8513. $this->openapi->set("components|parameters|include|schema|type", "string");
  8514. $this->openapi->set("components|parameters|include|description", "Columns you want to include in the output (comma separated). Example: posts.*,categories.name");
  8515. $this->openapi->set("components|parameters|include|required", false);
  8516. $this->openapi->set("components|parameters|exclude|name", "exclude");
  8517. $this->openapi->set("components|parameters|exclude|in", "query");
  8518. $this->openapi->set("components|parameters|exclude|schema|type", "string");
  8519. $this->openapi->set("components|parameters|exclude|description", "Columns you want to exclude from the output (comma separated). Example: posts.content");
  8520. $this->openapi->set("components|parameters|exclude|required", false);
  8521. $this->openapi->set("components|parameters|order|name", "order");
  8522. $this->openapi->set("components|parameters|order|in", "query");
  8523. $this->openapi->set("components|parameters|order|schema|type", "array");
  8524. $this->openapi->set("components|parameters|order|schema|items|type", "string");
  8525. $this->openapi->set("components|parameters|order|description", "Column you want to sort on and the sort direction (comma separated). Example: id,desc");
  8526. $this->openapi->set("components|parameters|order|required", false);
  8527. $this->openapi->set("components|parameters|size|name", "size");
  8528. $this->openapi->set("components|parameters|size|in", "query");
  8529. $this->openapi->set("components|parameters|size|schema|type", "string");
  8530. $this->openapi->set("components|parameters|size|description", "Maximum number of results (for top lists). Example: 10");
  8531. $this->openapi->set("components|parameters|size|required", false);
  8532. $this->openapi->set("components|parameters|page|name", "page");
  8533. $this->openapi->set("components|parameters|page|in", "query");
  8534. $this->openapi->set("components|parameters|page|schema|type", "string");
  8535. $this->openapi->set("components|parameters|page|description", "Page number and page size (comma separated). Example: 1,10");
  8536. $this->openapi->set("components|parameters|page|required", false);
  8537. $this->openapi->set("components|parameters|join|name", "join");
  8538. $this->openapi->set("components|parameters|join|in", "query");
  8539. $this->openapi->set("components|parameters|join|schema|type", "array");
  8540. $this->openapi->set("components|parameters|join|schema|items|type", "string");
  8541. $this->openapi->set("components|parameters|join|description", "Paths (comma separated) to related entities that you want to include. Example: comments,users");
  8542. $this->openapi->set("components|parameters|join|required", false);
  8543. }
  8544. private function setTag(int $index, string $tableName) /*: void*/
  8545. {
  8546. $this->openapi->set("tags|$index|name", "$tableName");
  8547. $this->openapi->set("tags|$index|description", "$tableName operations");
  8548. }
  8549. }
  8550. }
  8551. // file: src/Tqdev/PhpCrudApi/OpenApi/OpenApiService.php
  8552. namespace Tqdev\PhpCrudApi\OpenApi {
  8553. use Tqdev\PhpCrudApi\Column\ReflectionService;
  8554. use Tqdev\PhpCrudApi\OpenApi\OpenApiBuilder;
  8555. class OpenApiService
  8556. {
  8557. private $builder;
  8558. public function __construct(ReflectionService $reflection, array $base, array $controllers, array $customBuilders)
  8559. {
  8560. $this->builder = new OpenApiBuilder($reflection, $base, $controllers, $customBuilders);
  8561. }
  8562. public function get(): OpenApiDefinition
  8563. {
  8564. return $this->builder->build();
  8565. }
  8566. }
  8567. }
  8568. // file: src/Tqdev/PhpCrudApi/Record/Condition/AndCondition.php
  8569. namespace Tqdev\PhpCrudApi\Record\Condition {
  8570. class AndCondition extends Condition
  8571. {
  8572. private $conditions;
  8573. public function __construct(Condition $condition1, Condition $condition2)
  8574. {
  8575. $this->conditions = [$condition1, $condition2];
  8576. }
  8577. public function _and(Condition $condition): Condition
  8578. {
  8579. if ($condition instanceof NoCondition) {
  8580. return $this;
  8581. }
  8582. $this->conditions[] = $condition;
  8583. return $this;
  8584. }
  8585. public function getConditions(): array
  8586. {
  8587. return $this->conditions;
  8588. }
  8589. public static function fromArray(array $conditions): Condition
  8590. {
  8591. $condition = new NoCondition();
  8592. foreach ($conditions as $c) {
  8593. $condition = $condition->_and($c);
  8594. }
  8595. return $condition;
  8596. }
  8597. }
  8598. }
  8599. // file: src/Tqdev/PhpCrudApi/Record/Condition/ColumnCondition.php
  8600. namespace Tqdev\PhpCrudApi\Record\Condition {
  8601. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedColumn;
  8602. class ColumnCondition extends Condition
  8603. {
  8604. private $column;
  8605. private $operator;
  8606. private $value;
  8607. public function __construct(ReflectedColumn $column, string $operator, string $value)
  8608. {
  8609. $this->column = $column;
  8610. $this->operator = $operator;
  8611. $this->value = $value;
  8612. }
  8613. public function getColumn(): ReflectedColumn
  8614. {
  8615. return $this->column;
  8616. }
  8617. public function getOperator(): string
  8618. {
  8619. return $this->operator;
  8620. }
  8621. public function getValue(): string
  8622. {
  8623. return $this->value;
  8624. }
  8625. }
  8626. }
  8627. // file: src/Tqdev/PhpCrudApi/Record/Condition/Condition.php
  8628. namespace Tqdev\PhpCrudApi\Record\Condition {
  8629. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedTable;
  8630. abstract class Condition
  8631. {
  8632. public function _and(Condition $condition): Condition
  8633. {
  8634. if ($condition instanceof NoCondition) {
  8635. return $this;
  8636. }
  8637. return new AndCondition($this, $condition);
  8638. }
  8639. public function _or(Condition $condition): Condition
  8640. {
  8641. if ($condition instanceof NoCondition) {
  8642. return $this;
  8643. }
  8644. return new OrCondition($this, $condition);
  8645. }
  8646. public function _not(): Condition
  8647. {
  8648. return new NotCondition($this);
  8649. }
  8650. public static function fromString(ReflectedTable $table, string $value): Condition
  8651. {
  8652. $condition = new NoCondition();
  8653. $parts = explode(',', $value, 3);
  8654. if (count($parts) < 2) {
  8655. return $condition;
  8656. }
  8657. if (count($parts) < 3) {
  8658. $parts[2] = '';
  8659. }
  8660. $field = $table->getColumn($parts[0]);
  8661. $command = $parts[1];
  8662. $negate = false;
  8663. $spatial = false;
  8664. if (strlen($command) > 2) {
  8665. if (substr($command, 0, 1) == 'n') {
  8666. $negate = true;
  8667. $command = substr($command, 1);
  8668. }
  8669. if (substr($command, 0, 1) == 's') {
  8670. $spatial = true;
  8671. $command = substr($command, 1);
  8672. }
  8673. }
  8674. if ($spatial) {
  8675. if (in_array($command, ['co', 'cr', 'di', 'eq', 'in', 'ov', 'to', 'wi', 'ic', 'is', 'iv'])) {
  8676. $condition = new SpatialCondition($field, $command, $parts[2]);
  8677. }
  8678. } else {
  8679. if (in_array($command, ['cs', 'sw', 'ew', 'eq', 'lt', 'le', 'ge', 'gt', 'bt', 'in', 'is'])) {
  8680. $condition = new ColumnCondition($field, $command, $parts[2]);
  8681. }
  8682. }
  8683. if ($negate) {
  8684. $condition = $condition->_not();
  8685. }
  8686. return $condition;
  8687. }
  8688. }
  8689. }
  8690. // file: src/Tqdev/PhpCrudApi/Record/Condition/NoCondition.php
  8691. namespace Tqdev\PhpCrudApi\Record\Condition {
  8692. class NoCondition extends Condition
  8693. {
  8694. public function _and(Condition $condition): Condition
  8695. {
  8696. return $condition;
  8697. }
  8698. public function _or(Condition $condition): Condition
  8699. {
  8700. return $condition;
  8701. }
  8702. public function _not(): Condition
  8703. {
  8704. return $this;
  8705. }
  8706. }
  8707. }
  8708. // file: src/Tqdev/PhpCrudApi/Record/Condition/NotCondition.php
  8709. namespace Tqdev\PhpCrudApi\Record\Condition {
  8710. class NotCondition extends Condition
  8711. {
  8712. private $condition;
  8713. public function __construct(Condition $condition)
  8714. {
  8715. $this->condition = $condition;
  8716. }
  8717. public function getCondition(): Condition
  8718. {
  8719. return $this->condition;
  8720. }
  8721. }
  8722. }
  8723. // file: src/Tqdev/PhpCrudApi/Record/Condition/OrCondition.php
  8724. namespace Tqdev\PhpCrudApi\Record\Condition {
  8725. class OrCondition extends Condition
  8726. {
  8727. private $conditions;
  8728. public function __construct(Condition $condition1, Condition $condition2)
  8729. {
  8730. $this->conditions = [$condition1, $condition2];
  8731. }
  8732. public function _or(Condition $condition): Condition
  8733. {
  8734. if ($condition instanceof NoCondition) {
  8735. return $this;
  8736. }
  8737. $this->conditions[] = $condition;
  8738. return $this;
  8739. }
  8740. public function getConditions(): array
  8741. {
  8742. return $this->conditions;
  8743. }
  8744. public static function fromArray(array $conditions): Condition
  8745. {
  8746. $condition = new NoCondition();
  8747. foreach ($conditions as $c) {
  8748. $condition = $condition->_or($c);
  8749. }
  8750. return $condition;
  8751. }
  8752. }
  8753. }
  8754. // file: src/Tqdev/PhpCrudApi/Record/Condition/SpatialCondition.php
  8755. namespace Tqdev\PhpCrudApi\Record\Condition {
  8756. class SpatialCondition extends ColumnCondition
  8757. {
  8758. }
  8759. }
  8760. // file: src/Tqdev/PhpCrudApi/Record/Document/ErrorDocument.php
  8761. namespace Tqdev\PhpCrudApi\Record\Document {
  8762. use Tqdev\PhpCrudApi\Record\ErrorCode;
  8763. class ErrorDocument implements \JsonSerializable
  8764. {
  8765. public $code;
  8766. public $message;
  8767. public $details;
  8768. public function __construct(ErrorCode $errorCode, string $argument, $details)
  8769. {
  8770. $this->code = $errorCode->getCode();
  8771. $this->message = $errorCode->getMessage($argument);
  8772. $this->details = $details;
  8773. }
  8774. public function getCode(): int
  8775. {
  8776. return $this->code;
  8777. }
  8778. public function getMessage(): string
  8779. {
  8780. return $this->message;
  8781. }
  8782. public function serialize()
  8783. {
  8784. return [
  8785. 'code' => $this->code,
  8786. 'message' => $this->message,
  8787. 'details' => $this->details,
  8788. ];
  8789. }
  8790. public function jsonSerialize()
  8791. {
  8792. return array_filter($this->serialize());
  8793. }
  8794. }
  8795. }
  8796. // file: src/Tqdev/PhpCrudApi/Record/Document/ListDocument.php
  8797. namespace Tqdev\PhpCrudApi\Record\Document {
  8798. class ListDocument implements \JsonSerializable
  8799. {
  8800. private $records;
  8801. private $results;
  8802. public function __construct(array $records, int $results)
  8803. {
  8804. $this->records = $records;
  8805. $this->results = $results;
  8806. }
  8807. public function getRecords(): array
  8808. {
  8809. return $this->records;
  8810. }
  8811. public function getResults(): int
  8812. {
  8813. return $this->results;
  8814. }
  8815. public function serialize()
  8816. {
  8817. return [
  8818. 'records' => $this->records,
  8819. 'results' => $this->results,
  8820. ];
  8821. }
  8822. public function jsonSerialize()
  8823. {
  8824. return array_filter($this->serialize(), function ($v) {
  8825. return $v !== 0;
  8826. });
  8827. }
  8828. }
  8829. }
  8830. // file: src/Tqdev/PhpCrudApi/Record/ColumnIncluder.php
  8831. namespace Tqdev\PhpCrudApi\Record {
  8832. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedTable;
  8833. class ColumnIncluder
  8834. {
  8835. private function isMandatory(string $tableName, string $columnName, array $params): bool
  8836. {
  8837. return isset($params['mandatory']) && in_array($tableName . "." . $columnName, $params['mandatory']);
  8838. }
  8839. private function select(
  8840. string $tableName,
  8841. bool $primaryTable,
  8842. array $params,
  8843. string $paramName,
  8844. array $columnNames,
  8845. bool $include
  8846. ): array {
  8847. if (!isset($params[$paramName])) {
  8848. return $columnNames;
  8849. }
  8850. $columns = array();
  8851. foreach (explode(',', $params[$paramName][0]) as $columnName) {
  8852. $columns[$columnName] = true;
  8853. }
  8854. $result = array();
  8855. foreach ($columnNames as $columnName) {
  8856. $match = isset($columns['*.*']);
  8857. if (!$match) {
  8858. $match = isset($columns[$tableName . '.*']) || isset($columns[$tableName . '.' . $columnName]);
  8859. }
  8860. if ($primaryTable && !$match) {
  8861. $match = isset($columns['*']) || isset($columns[$columnName]);
  8862. }
  8863. if ($match) {
  8864. if ($include || $this->isMandatory($tableName, $columnName, $params)) {
  8865. $result[] = $columnName;
  8866. }
  8867. } else {
  8868. if (!$include || $this->isMandatory($tableName, $columnName, $params)) {
  8869. $result[] = $columnName;
  8870. }
  8871. }
  8872. }
  8873. return $result;
  8874. }
  8875. public function getNames(ReflectedTable $table, bool $primaryTable, array $params): array
  8876. {
  8877. $tableName = $table->getName();
  8878. $results = $table->getColumnNames();
  8879. $results = $this->select($tableName, $primaryTable, $params, 'include', $results, true);
  8880. $results = $this->select($tableName, $primaryTable, $params, 'exclude', $results, false);
  8881. return $results;
  8882. }
  8883. public function getValues(ReflectedTable $table, bool $primaryTable, /* object */ $record, array $params): array
  8884. {
  8885. $results = array();
  8886. $columnNames = $this->getNames($table, $primaryTable, $params);
  8887. foreach ($columnNames as $columnName) {
  8888. if (property_exists($record, $columnName)) {
  8889. $results[$columnName] = $record->$columnName;
  8890. }
  8891. }
  8892. return $results;
  8893. }
  8894. }
  8895. }
  8896. // file: src/Tqdev/PhpCrudApi/Record/ErrorCode.php
  8897. namespace Tqdev\PhpCrudApi\Record {
  8898. use Tqdev\PhpCrudApi\ResponseFactory;
  8899. class ErrorCode
  8900. {
  8901. private $code;
  8902. private $message;
  8903. private $status;
  8904. const ERROR_NOT_FOUND = 9999;
  8905. const ROUTE_NOT_FOUND = 1000;
  8906. const TABLE_NOT_FOUND = 1001;
  8907. const ARGUMENT_COUNT_MISMATCH = 1002;
  8908. const RECORD_NOT_FOUND = 1003;
  8909. const ORIGIN_FORBIDDEN = 1004;
  8910. const COLUMN_NOT_FOUND = 1005;
  8911. const TABLE_ALREADY_EXISTS = 1006;
  8912. const COLUMN_ALREADY_EXISTS = 1007;
  8913. const HTTP_MESSAGE_NOT_READABLE = 1008;
  8914. const DUPLICATE_KEY_EXCEPTION = 1009;
  8915. const DATA_INTEGRITY_VIOLATION = 1010;
  8916. const AUTHENTICATION_REQUIRED = 1011;
  8917. const AUTHENTICATION_FAILED = 1012;
  8918. const INPUT_VALIDATION_FAILED = 1013;
  8919. const OPERATION_FORBIDDEN = 1014;
  8920. const OPERATION_NOT_SUPPORTED = 1015;
  8921. const TEMPORARY_OR_PERMANENTLY_BLOCKED = 1016;
  8922. const BAD_OR_MISSING_XSRF_TOKEN = 1017;
  8923. const ONLY_AJAX_REQUESTS_ALLOWED = 1018;
  8924. const PAGINATION_FORBIDDEN = 1019;
  8925. const USER_ALREADY_EXIST = 1020;
  8926. const PASSWORD_TOO_SHORT = 1021;
  8927. private $values = [
  8928. 9999 => ["%s", ResponseFactory::INTERNAL_SERVER_ERROR],
  8929. 1000 => ["Route '%s' not found", ResponseFactory::NOT_FOUND],
  8930. 1001 => ["Table '%s' not found", ResponseFactory::NOT_FOUND],
  8931. 1002 => ["Argument count mismatch in '%s'", ResponseFactory::UNPROCESSABLE_ENTITY],
  8932. 1003 => ["Record '%s' not found", ResponseFactory::NOT_FOUND],
  8933. 1004 => ["Origin '%s' is forbidden", ResponseFactory::FORBIDDEN],
  8934. 1005 => ["Column '%s' not found", ResponseFactory::NOT_FOUND],
  8935. 1006 => ["Table '%s' already exists", ResponseFactory::CONFLICT],
  8936. 1007 => ["Column '%s' already exists", ResponseFactory::CONFLICT],
  8937. 1008 => ["Cannot read HTTP message", ResponseFactory::UNPROCESSABLE_ENTITY],
  8938. 1009 => ["Duplicate key exception", ResponseFactory::CONFLICT],
  8939. 1010 => ["Data integrity violation", ResponseFactory::CONFLICT],
  8940. 1011 => ["Authentication required", ResponseFactory::UNAUTHORIZED],
  8941. 1012 => ["Authentication failed for '%s'", ResponseFactory::FORBIDDEN],
  8942. 1013 => ["Input validation failed for '%s'", ResponseFactory::UNPROCESSABLE_ENTITY],
  8943. 1014 => ["Operation forbidden", ResponseFactory::FORBIDDEN],
  8944. 1015 => ["Operation '%s' not supported", ResponseFactory::METHOD_NOT_ALLOWED],
  8945. 1016 => ["Temporary or permanently blocked", ResponseFactory::FORBIDDEN],
  8946. 1017 => ["Bad or missing XSRF token", ResponseFactory::FORBIDDEN],
  8947. 1018 => ["Only AJAX requests allowed for '%s'", ResponseFactory::FORBIDDEN],
  8948. 1019 => ["Pagination forbidden", ResponseFactory::FORBIDDEN],
  8949. 1020 => ["User '%s' already exists", ResponseFactory::CONFLICT],
  8950. 1021 => ["Password too short (<%d characters)", ResponseFactory::UNPROCESSABLE_ENTITY],
  8951. ];
  8952. public function __construct(int $code)
  8953. {
  8954. if (!isset($this->values[$code])) {
  8955. $code = 9999;
  8956. }
  8957. $this->code = $code;
  8958. $this->message = $this->values[$code][0];
  8959. $this->status = $this->values[$code][1];
  8960. }
  8961. public function getCode(): int
  8962. {
  8963. return $this->code;
  8964. }
  8965. public function getMessage(string $argument): string
  8966. {
  8967. return sprintf($this->message, $argument);
  8968. }
  8969. public function getStatus(): int
  8970. {
  8971. return $this->status;
  8972. }
  8973. }
  8974. }
  8975. // file: src/Tqdev/PhpCrudApi/Record/FilterInfo.php
  8976. namespace Tqdev\PhpCrudApi\Record {
  8977. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedTable;
  8978. use Tqdev\PhpCrudApi\Record\Condition\AndCondition;
  8979. use Tqdev\PhpCrudApi\Record\Condition\Condition;
  8980. use Tqdev\PhpCrudApi\Record\Condition\NoCondition;
  8981. use Tqdev\PhpCrudApi\Record\Condition\OrCondition;
  8982. class FilterInfo
  8983. {
  8984. private function getConditionsAsPathTree(ReflectedTable $table, array $params): PathTree
  8985. {
  8986. $conditions = new PathTree();
  8987. foreach ($params as $key => $filters) {
  8988. if (substr($key, 0, 6) == 'filter') {
  8989. preg_match_all('/\d+|\D+/', substr($key, 6), $matches);
  8990. $path = $matches[0];
  8991. foreach ($filters as $filter) {
  8992. $condition = Condition::fromString($table, $filter);
  8993. if (($condition instanceof NoCondition) == false) {
  8994. $conditions->put($path, $condition);
  8995. }
  8996. }
  8997. }
  8998. }
  8999. return $conditions;
  9000. }
  9001. private function combinePathTreeOfConditions(PathTree $tree): Condition
  9002. {
  9003. $andConditions = $tree->getValues();
  9004. $and = AndCondition::fromArray($andConditions);
  9005. $orConditions = [];
  9006. foreach ($tree->getKeys() as $p) {
  9007. $orConditions[] = $this->combinePathTreeOfConditions($tree->get($p));
  9008. }
  9009. $or = OrCondition::fromArray($orConditions);
  9010. return $and->_and($or);
  9011. }
  9012. public function getCombinedConditions(ReflectedTable $table, array $params): Condition
  9013. {
  9014. return $this->combinePathTreeOfConditions($this->getConditionsAsPathTree($table, $params));
  9015. }
  9016. }
  9017. }
  9018. // file: src/Tqdev/PhpCrudApi/Record/HabtmValues.php
  9019. namespace Tqdev\PhpCrudApi\Record {
  9020. class HabtmValues
  9021. {
  9022. public $pkValues;
  9023. public $fkValues;
  9024. public function __construct(array $pkValues, array $fkValues)
  9025. {
  9026. $this->pkValues = $pkValues;
  9027. $this->fkValues = $fkValues;
  9028. }
  9029. }
  9030. }
  9031. // file: src/Tqdev/PhpCrudApi/Record/OrderingInfo.php
  9032. namespace Tqdev\PhpCrudApi\Record {
  9033. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedTable;
  9034. class OrderingInfo
  9035. {
  9036. public function getColumnOrdering(ReflectedTable $table, array $params): array
  9037. {
  9038. $fields = array();
  9039. if (isset($params['order'])) {
  9040. foreach ($params['order'] as $order) {
  9041. $parts = explode(',', $order, 3);
  9042. $columnName = $parts[0];
  9043. if (!$table->hasColumn($columnName)) {
  9044. continue;
  9045. }
  9046. $ascending = 'ASC';
  9047. if (count($parts) > 1) {
  9048. if (substr(strtoupper($parts[1]), 0, 4) == "DESC") {
  9049. $ascending = 'DESC';
  9050. }
  9051. }
  9052. $fields[] = [$columnName, $ascending];
  9053. }
  9054. }
  9055. if (count($fields) == 0) {
  9056. return $this->getDefaultColumnOrdering($table);
  9057. }
  9058. return $fields;
  9059. }
  9060. public function getDefaultColumnOrdering(ReflectedTable $table): array
  9061. {
  9062. $fields = array();
  9063. $pk = $table->getPk();
  9064. if ($pk) {
  9065. $fields[] = [$pk->getName(), 'ASC'];
  9066. } else {
  9067. foreach ($table->getColumnNames() as $columnName) {
  9068. $fields[] = [$columnName, 'ASC'];
  9069. }
  9070. }
  9071. return $fields;
  9072. }
  9073. }
  9074. }
  9075. // file: src/Tqdev/PhpCrudApi/Record/PaginationInfo.php
  9076. namespace Tqdev\PhpCrudApi\Record {
  9077. class PaginationInfo
  9078. {
  9079. public $DEFAULT_PAGE_SIZE = 20;
  9080. public function hasPage(array $params): bool
  9081. {
  9082. return isset($params['page']);
  9083. }
  9084. public function getPageOffset(array $params): int
  9085. {
  9086. $offset = 0;
  9087. $pageSize = $this->getPageSize($params);
  9088. if (isset($params['page'])) {
  9089. foreach ($params['page'] as $page) {
  9090. $parts = explode(',', $page, 2);
  9091. $page = intval($parts[0]) - 1;
  9092. $offset = $page * $pageSize;
  9093. }
  9094. }
  9095. return $offset;
  9096. }
  9097. private function getPageSize(array $params): int
  9098. {
  9099. $pageSize = $this->DEFAULT_PAGE_SIZE;
  9100. if (isset($params['page'])) {
  9101. foreach ($params['page'] as $page) {
  9102. $parts = explode(',', $page, 2);
  9103. if (count($parts) > 1) {
  9104. $pageSize = intval($parts[1]);
  9105. }
  9106. }
  9107. }
  9108. return $pageSize;
  9109. }
  9110. public function getResultSize(array $params): int
  9111. {
  9112. $numberOfRows = -1;
  9113. if (isset($params['size'])) {
  9114. foreach ($params['size'] as $size) {
  9115. $numberOfRows = intval($size);
  9116. }
  9117. }
  9118. return $numberOfRows;
  9119. }
  9120. public function getPageLimit(array $params): int
  9121. {
  9122. $pageLimit = -1;
  9123. if ($this->hasPage($params)) {
  9124. $pageLimit = $this->getPageSize($params);
  9125. }
  9126. $resultSize = $this->getResultSize($params);
  9127. if ($resultSize >= 0) {
  9128. if ($pageLimit >= 0) {
  9129. $pageLimit = min($pageLimit, $resultSize);
  9130. } else {
  9131. $pageLimit = $resultSize;
  9132. }
  9133. }
  9134. return $pageLimit;
  9135. }
  9136. }
  9137. }
  9138. // file: src/Tqdev/PhpCrudApi/Record/PathTree.php
  9139. namespace Tqdev\PhpCrudApi\Record {
  9140. class PathTree implements \JsonSerializable
  9141. {
  9142. const WILDCARD = '*';
  9143. private $tree;
  9144. public function __construct(/* object */&$tree = null)
  9145. {
  9146. if (!$tree) {
  9147. $tree = $this->newTree();
  9148. }
  9149. $this->tree = &$tree;
  9150. }
  9151. public function newTree()
  9152. {
  9153. return (object) ['values' => [], 'branches' => (object) []];
  9154. }
  9155. public function getKeys(): array
  9156. {
  9157. $branches = (array) $this->tree->branches;
  9158. return array_keys($branches);
  9159. }
  9160. public function getValues(): array
  9161. {
  9162. return $this->tree->values;
  9163. }
  9164. public function get(string $key): PathTree
  9165. {
  9166. if (!isset($this->tree->branches->$key)) {
  9167. return null;
  9168. }
  9169. return new PathTree($this->tree->branches->$key);
  9170. }
  9171. public function put(array $path, $value)
  9172. {
  9173. $tree = &$this->tree;
  9174. foreach ($path as $key) {
  9175. if (!isset($tree->branches->$key)) {
  9176. $tree->branches->$key = $this->newTree();
  9177. }
  9178. $tree = &$tree->branches->$key;
  9179. }
  9180. $tree->values[] = $value;
  9181. }
  9182. public function match(array $path): array
  9183. {
  9184. $star = self::WILDCARD;
  9185. $tree = &$this->tree;
  9186. foreach ($path as $key) {
  9187. if (isset($tree->branches->$key)) {
  9188. $tree = &$tree->branches->$key;
  9189. } elseif (isset($tree->branches->$star)) {
  9190. $tree = &$tree->branches->$star;
  9191. } else {
  9192. return [];
  9193. }
  9194. }
  9195. return $tree->values;
  9196. }
  9197. public static function fromJson(/* object */$tree): PathTree
  9198. {
  9199. return new PathTree($tree);
  9200. }
  9201. public function jsonSerialize()
  9202. {
  9203. return $this->tree;
  9204. }
  9205. }
  9206. }
  9207. // file: src/Tqdev/PhpCrudApi/Record/RecordService.php
  9208. namespace Tqdev\PhpCrudApi\Record {
  9209. use Tqdev\PhpCrudApi\Column\ReflectionService;
  9210. use Tqdev\PhpCrudApi\Database\GenericDB;
  9211. use Tqdev\PhpCrudApi\Record\Document\ListDocument;
  9212. class RecordService
  9213. {
  9214. private $db;
  9215. private $reflection;
  9216. private $columns;
  9217. private $joiner;
  9218. private $filters;
  9219. private $ordering;
  9220. private $pagination;
  9221. public function __construct(GenericDB $db, ReflectionService $reflection)
  9222. {
  9223. $this->db = $db;
  9224. $this->reflection = $reflection;
  9225. $this->columns = new ColumnIncluder();
  9226. $this->joiner = new RelationJoiner($reflection, $this->columns);
  9227. $this->filters = new FilterInfo();
  9228. $this->ordering = new OrderingInfo();
  9229. $this->pagination = new PaginationInfo();
  9230. }
  9231. private function sanitizeRecord(string $tableName, /* object */ $record, string $id)
  9232. {
  9233. $keyset = array_keys((array) $record);
  9234. foreach ($keyset as $key) {
  9235. if (!$this->reflection->getTable($tableName)->hasColumn($key)) {
  9236. unset($record->$key);
  9237. }
  9238. }
  9239. if ($id != '') {
  9240. $pk = $this->reflection->getTable($tableName)->getPk();
  9241. foreach ($this->reflection->getTable($tableName)->getColumnNames() as $key) {
  9242. $field = $this->reflection->getTable($tableName)->getColumn($key);
  9243. if ($field->getName() == $pk->getName()) {
  9244. unset($record->$key);
  9245. }
  9246. }
  9247. }
  9248. }
  9249. public function hasTable(string $table): bool
  9250. {
  9251. return $this->reflection->hasTable($table);
  9252. }
  9253. public function getType(string $table): string
  9254. {
  9255. return $this->reflection->getType($table);
  9256. }
  9257. public function create(string $tableName, /* object */ $record, array $params) /*: ?int*/
  9258. {
  9259. $this->sanitizeRecord($tableName, $record, '');
  9260. $table = $this->reflection->getTable($tableName);
  9261. $columnValues = $this->columns->getValues($table, true, $record, $params);
  9262. return $this->db->createSingle($table, $columnValues);
  9263. }
  9264. public function read(string $tableName, string $id, array $params) /*: ?object*/
  9265. {
  9266. $table = $this->reflection->getTable($tableName);
  9267. $this->joiner->addMandatoryColumns($table, $params);
  9268. $columnNames = $this->columns->getNames($table, true, $params);
  9269. $record = $this->db->selectSingle($table, $columnNames, $id);
  9270. if ($record == null) {
  9271. return null;
  9272. }
  9273. $records = array($record);
  9274. $this->joiner->addJoins($table, $records, $params, $this->db);
  9275. return $records[0];
  9276. }
  9277. public function update(string $tableName, string $id, /* object */ $record, array $params) /*: ?int*/
  9278. {
  9279. $this->sanitizeRecord($tableName, $record, $id);
  9280. $table = $this->reflection->getTable($tableName);
  9281. $columnValues = $this->columns->getValues($table, true, $record, $params);
  9282. return $this->db->updateSingle($table, $columnValues, $id);
  9283. }
  9284. public function delete(string $tableName, string $id, array $params) /*: ?int*/
  9285. {
  9286. $table = $this->reflection->getTable($tableName);
  9287. return $this->db->deleteSingle($table, $id);
  9288. }
  9289. public function increment(string $tableName, string $id, /* object */ $record, array $params) /*: ?int*/
  9290. {
  9291. $this->sanitizeRecord($tableName, $record, $id);
  9292. $table = $this->reflection->getTable($tableName);
  9293. $columnValues = $this->columns->getValues($table, true, $record, $params);
  9294. return $this->db->incrementSingle($table, $columnValues, $id);
  9295. }
  9296. public function _list(string $tableName, array $params): ListDocument
  9297. {
  9298. $table = $this->reflection->getTable($tableName);
  9299. $this->joiner->addMandatoryColumns($table, $params);
  9300. $columnNames = $this->columns->getNames($table, true, $params);
  9301. $condition = $this->filters->getCombinedConditions($table, $params);
  9302. $columnOrdering = $this->ordering->getColumnOrdering($table, $params);
  9303. if (!$this->pagination->hasPage($params)) {
  9304. $offset = 0;
  9305. $limit = $this->pagination->getPageLimit($params);
  9306. $count = 0;
  9307. } else {
  9308. $offset = $this->pagination->getPageOffset($params);
  9309. $limit = $this->pagination->getPageLimit($params);
  9310. $count = $this->db->selectCount($table, $condition);
  9311. }
  9312. $records = $this->db->selectAll($table, $columnNames, $condition, $columnOrdering, $offset, $limit);
  9313. $this->joiner->addJoins($table, $records, $params, $this->db);
  9314. return new ListDocument($records, $count);
  9315. }
  9316. }
  9317. }
  9318. // file: src/Tqdev/PhpCrudApi/Record/RelationJoiner.php
  9319. namespace Tqdev\PhpCrudApi\Record {
  9320. use Tqdev\PhpCrudApi\Column\Reflection\ReflectedTable;
  9321. use Tqdev\PhpCrudApi\Column\ReflectionService;
  9322. use Tqdev\PhpCrudApi\Database\GenericDB;
  9323. use Tqdev\PhpCrudApi\Middleware\Communication\VariableStore;
  9324. use Tqdev\PhpCrudApi\Record\Condition\ColumnCondition;
  9325. use Tqdev\PhpCrudApi\Record\Condition\OrCondition;
  9326. class RelationJoiner
  9327. {
  9328. private $reflection;
  9329. private $ordering;
  9330. private $columns;
  9331. public function __construct(ReflectionService $reflection, ColumnIncluder $columns)
  9332. {
  9333. $this->reflection = $reflection;
  9334. $this->ordering = new OrderingInfo();
  9335. $this->columns = $columns;
  9336. }
  9337. public function addMandatoryColumns(ReflectedTable $table, array &$params) /*: void*/
  9338. {
  9339. if (!isset($params['join']) || !isset($params['include'])) {
  9340. return;
  9341. }
  9342. $params['mandatory'] = array();
  9343. foreach ($params['join'] as $tableNames) {
  9344. $t1 = $table;
  9345. foreach (explode(',', $tableNames) as $tableName) {
  9346. if (!$this->reflection->hasTable($tableName)) {
  9347. continue;
  9348. }
  9349. $t2 = $this->reflection->getTable($tableName);
  9350. $fks1 = $t1->getFksTo($t2->getName());
  9351. $t3 = $this->hasAndBelongsToMany($t1, $t2);
  9352. if ($t3 != null || count($fks1) > 0) {
  9353. $params['mandatory'][] = $t2->getName() . '.' . $t2->getPk()->getName();
  9354. }
  9355. foreach ($fks1 as $fk) {
  9356. $params['mandatory'][] = $t1->getName() . '.' . $fk->getName();
  9357. }
  9358. $fks2 = $t2->getFksTo($t1->getName());
  9359. if ($t3 != null || count($fks2) > 0) {
  9360. $params['mandatory'][] = $t1->getName() . '.' . $t1->getPk()->getName();
  9361. }
  9362. foreach ($fks2 as $fk) {
  9363. $params['mandatory'][] = $t2->getName() . '.' . $fk->getName();
  9364. }
  9365. $t1 = $t2;
  9366. }
  9367. }
  9368. }
  9369. private function getJoinsAsPathTree(array $params): PathTree
  9370. {
  9371. $joins = new PathTree();
  9372. if (isset($params['join'])) {
  9373. foreach ($params['join'] as $tableNames) {
  9374. $path = array();
  9375. foreach (explode(',', $tableNames) as $tableName) {
  9376. if (!$this->reflection->hasTable($tableName)) {
  9377. continue;
  9378. }
  9379. $t = $this->reflection->getTable($tableName);
  9380. if ($t != null) {
  9381. $path[] = $t->getName();
  9382. }
  9383. }
  9384. $joins->put($path, true);
  9385. }
  9386. }
  9387. return $joins;
  9388. }
  9389. public function addJoins(ReflectedTable $table, array &$records, array $params, GenericDB $db) /*: void*/
  9390. {
  9391. $joins = $this->getJoinsAsPathTree($params);
  9392. $this->addJoinsForTables($table, $joins, $records, $params, $db);
  9393. }
  9394. private function hasAndBelongsToMany(ReflectedTable $t1, ReflectedTable $t2) /*: ?ReflectedTable*/
  9395. {
  9396. foreach ($this->reflection->getTableNames() as $tableName) {
  9397. $t3 = $this->reflection->getTable($tableName);
  9398. if (count($t3->getFksTo($t1->getName())) > 0 && count($t3->getFksTo($t2->getName())) > 0) {
  9399. return $t3;
  9400. }
  9401. }
  9402. return null;
  9403. }
  9404. private function addJoinsForTables(ReflectedTable $t1, PathTree $joins, array &$records, array $params, GenericDB $db)
  9405. {
  9406. foreach ($joins->getKeys() as $t2Name) {
  9407. $t2 = $this->reflection->getTable($t2Name);
  9408. $belongsTo = count($t1->getFksTo($t2->getName())) > 0;
  9409. $hasMany = count($t2->getFksTo($t1->getName())) > 0;
  9410. if (!$belongsTo && !$hasMany) {
  9411. $t3 = $this->hasAndBelongsToMany($t1, $t2);
  9412. } else {
  9413. $t3 = null;
  9414. }
  9415. $hasAndBelongsToMany = ($t3 != null);
  9416. $newRecords = array();
  9417. $fkValues = null;
  9418. $pkValues = null;
  9419. $habtmValues = null;
  9420. if ($belongsTo) {
  9421. $fkValues = $this->getFkEmptyValues($t1, $t2, $records);
  9422. $this->addFkRecords($t2, $fkValues, $params, $db, $newRecords);
  9423. }
  9424. if ($hasMany) {
  9425. $pkValues = $this->getPkEmptyValues($t1, $records);
  9426. $this->addPkRecords($t1, $t2, $pkValues, $params, $db, $newRecords);
  9427. }
  9428. if ($hasAndBelongsToMany) {
  9429. $habtmValues = $this->getHabtmEmptyValues($t1, $t2, $t3, $db, $records);
  9430. $this->addFkRecords($t2, $habtmValues->fkValues, $params, $db, $newRecords);
  9431. }
  9432. $this->addJoinsForTables($t2, $joins->get($t2Name), $newRecords, $params, $db);
  9433. if ($fkValues != null) {
  9434. $this->fillFkValues($t2, $newRecords, $fkValues);
  9435. $this->setFkValues($t1, $t2, $records, $fkValues);
  9436. }
  9437. if ($pkValues != null) {
  9438. $this->fillPkValues($t1, $t2, $newRecords, $pkValues);
  9439. $this->setPkValues($t1, $t2, $records, $pkValues);
  9440. }
  9441. if ($habtmValues != null) {
  9442. $this->fillFkValues($t2, $newRecords, $habtmValues->fkValues);
  9443. $this->setHabtmValues($t1, $t2, $records, $habtmValues);
  9444. }
  9445. }
  9446. }
  9447. private function getFkEmptyValues(ReflectedTable $t1, ReflectedTable $t2, array $records): array
  9448. {
  9449. $fkValues = array();
  9450. $fks = $t1->getFksTo($t2->getName());
  9451. foreach ($fks as $fk) {
  9452. $fkName = $fk->getName();
  9453. foreach ($records as $record) {
  9454. if (isset($record[$fkName])) {
  9455. $fkValue = $record[$fkName];
  9456. $fkValues[$fkValue] = null;
  9457. }
  9458. }
  9459. }
  9460. return $fkValues;
  9461. }
  9462. private function addFkRecords(ReflectedTable $t2, array $fkValues, array $params, GenericDB $db, array &$records) /*: void*/
  9463. {
  9464. $columnNames = $this->columns->getNames($t2, false, $params);
  9465. $fkIds = array_keys($fkValues);
  9466. foreach ($db->selectMultiple($t2, $columnNames, $fkIds) as $record) {
  9467. $records[] = $record;
  9468. }
  9469. }
  9470. private function fillFkValues(ReflectedTable $t2, array $fkRecords, array &$fkValues) /*: void*/
  9471. {
  9472. $pkName = $t2->getPk()->getName();
  9473. foreach ($fkRecords as $fkRecord) {
  9474. $pkValue = $fkRecord[$pkName];
  9475. $fkValues[$pkValue] = $fkRecord;
  9476. }
  9477. }
  9478. private function setFkValues(ReflectedTable $t1, ReflectedTable $t2, array &$records, array $fkValues) /*: void*/
  9479. {
  9480. $fks = $t1->getFksTo($t2->getName());
  9481. foreach ($fks as $fk) {
  9482. $fkName = $fk->getName();
  9483. foreach ($records as $i => $record) {
  9484. if (isset($record[$fkName])) {
  9485. $key = $record[$fkName];
  9486. $records[$i][$fkName] = $fkValues[$key];
  9487. }
  9488. }
  9489. }
  9490. }
  9491. private function getPkEmptyValues(ReflectedTable $t1, array $records): array
  9492. {
  9493. $pkValues = array();
  9494. $pkName = $t1->getPk()->getName();
  9495. foreach ($records as $record) {
  9496. $key = $record[$pkName];
  9497. $pkValues[$key] = array();
  9498. }
  9499. return $pkValues;
  9500. }
  9501. private function addPkRecords(ReflectedTable $t1, ReflectedTable $t2, array $pkValues, array $params, GenericDB $db, array &$records) /*: void*/
  9502. {
  9503. $fks = $t2->getFksTo($t1->getName());
  9504. $columnNames = $this->columns->getNames($t2, false, $params);
  9505. $pkValueKeys = implode(',', array_keys($pkValues));
  9506. $conditions = array();
  9507. foreach ($fks as $fk) {
  9508. $conditions[] = new ColumnCondition($fk, 'in', $pkValueKeys);
  9509. }
  9510. $condition = OrCondition::fromArray($conditions);
  9511. $columnOrdering = array();
  9512. $limit = VariableStore::get("joinLimits.maxRecords") ?: -1;
  9513. if ($limit != -1) {
  9514. $columnOrdering = $this->ordering->getDefaultColumnOrdering($t2);
  9515. }
  9516. foreach ($db->selectAll($t2, $columnNames, $condition, $columnOrdering, 0, $limit) as $record) {
  9517. $records[] = $record;
  9518. }
  9519. }
  9520. private function fillPkValues(ReflectedTable $t1, ReflectedTable $t2, array $pkRecords, array &$pkValues) /*: void*/
  9521. {
  9522. $fks = $t2->getFksTo($t1->getName());
  9523. foreach ($fks as $fk) {
  9524. $fkName = $fk->getName();
  9525. foreach ($pkRecords as $pkRecord) {
  9526. $key = $pkRecord[$fkName];
  9527. if (isset($pkValues[$key])) {
  9528. $pkValues[$key][] = $pkRecord;
  9529. }
  9530. }
  9531. }
  9532. }
  9533. private function setPkValues(ReflectedTable $t1, ReflectedTable $t2, array &$records, array $pkValues) /*: void*/
  9534. {
  9535. $pkName = $t1->getPk()->getName();
  9536. $t2Name = $t2->getName();
  9537. foreach ($records as $i => $record) {
  9538. $key = $record[$pkName];
  9539. $records[$i][$t2Name] = $pkValues[$key];
  9540. }
  9541. }
  9542. private function getHabtmEmptyValues(ReflectedTable $t1, ReflectedTable $t2, ReflectedTable $t3, GenericDB $db, array $records): HabtmValues
  9543. {
  9544. $pkValues = $this->getPkEmptyValues($t1, $records);
  9545. $fkValues = array();
  9546. $fk1 = $t3->getFksTo($t1->getName())[0];
  9547. $fk2 = $t3->getFksTo($t2->getName())[0];
  9548. $fk1Name = $fk1->getName();
  9549. $fk2Name = $fk2->getName();
  9550. $columnNames = array($fk1Name, $fk2Name);
  9551. $pkIds = implode(',', array_keys($pkValues));
  9552. $condition = new ColumnCondition($t3->getColumn($fk1Name), 'in', $pkIds);
  9553. $columnOrdering = array();
  9554. $limit = VariableStore::get("joinLimits.maxRecords") ?: -1;
  9555. if ($limit != -1) {
  9556. $columnOrdering = $this->ordering->getDefaultColumnOrdering($t3);
  9557. }
  9558. $records = $db->selectAll($t3, $columnNames, $condition, $columnOrdering, 0, $limit);
  9559. foreach ($records as $record) {
  9560. $val1 = $record[$fk1Name];
  9561. $val2 = $record[$fk2Name];
  9562. $pkValues[$val1][] = $val2;
  9563. $fkValues[$val2] = null;
  9564. }
  9565. return new HabtmValues($pkValues, $fkValues);
  9566. }
  9567. private function setHabtmValues(ReflectedTable $t1, ReflectedTable $t2, array &$records, HabtmValues $habtmValues) /*: void*/
  9568. {
  9569. $pkName = $t1->getPk()->getName();
  9570. $t2Name = $t2->getName();
  9571. foreach ($records as $i => $record) {
  9572. $key = $record[$pkName];
  9573. $val = array();
  9574. $fks = $habtmValues->pkValues[$key];
  9575. foreach ($fks as $fk) {
  9576. $val[] = $habtmValues->fkValues[$fk];
  9577. }
  9578. $records[$i][$t2Name] = $val;
  9579. }
  9580. }
  9581. }
  9582. }
  9583. // file: src/Tqdev/PhpCrudApi/Api.php
  9584. namespace Tqdev\PhpCrudApi {
  9585. use Psr\Http\Message\ResponseInterface;
  9586. use Psr\Http\Message\ServerRequestInterface;
  9587. use Psr\Http\Server\RequestHandlerInterface;
  9588. use Tqdev\PhpCrudApi\Cache\CacheFactory;
  9589. use Tqdev\PhpCrudApi\Column\DefinitionService;
  9590. use Tqdev\PhpCrudApi\Column\ReflectionService;
  9591. use Tqdev\PhpCrudApi\Controller\CacheController;
  9592. use Tqdev\PhpCrudApi\Controller\ColumnController;
  9593. use Tqdev\PhpCrudApi\Controller\GeoJsonController;
  9594. use Tqdev\PhpCrudApi\Controller\JsonResponder;
  9595. use Tqdev\PhpCrudApi\Controller\OpenApiController;
  9596. use Tqdev\PhpCrudApi\Controller\RecordController;
  9597. use Tqdev\PhpCrudApi\Database\GenericDB;
  9598. use Tqdev\PhpCrudApi\GeoJson\GeoJsonService;
  9599. use Tqdev\PhpCrudApi\Middleware\AuthorizationMiddleware;
  9600. use Tqdev\PhpCrudApi\Middleware\BasicAuthMiddleware;
  9601. use Tqdev\PhpCrudApi\Middleware\CorsMiddleware;
  9602. use Tqdev\PhpCrudApi\Middleware\CustomizationMiddleware;
  9603. use Tqdev\PhpCrudApi\Middleware\DbAuthMiddleware;
  9604. use Tqdev\PhpCrudApi\Middleware\FirewallMiddleware;
  9605. use Tqdev\PhpCrudApi\Middleware\IpAddressMiddleware;
  9606. use Tqdev\PhpCrudApi\Middleware\JoinLimitsMiddleware;
  9607. use Tqdev\PhpCrudApi\Middleware\JwtAuthMiddleware;
  9608. use Tqdev\PhpCrudApi\Middleware\MultiTenancyMiddleware;
  9609. use Tqdev\PhpCrudApi\Middleware\PageLimitsMiddleware;
  9610. use Tqdev\PhpCrudApi\Middleware\ReconnectMiddleware;
  9611. use Tqdev\PhpCrudApi\Middleware\Router\SimpleRouter;
  9612. use Tqdev\PhpCrudApi\Middleware\SanitationMiddleware;
  9613. use Tqdev\PhpCrudApi\Middleware\SslRedirectMiddleware;
  9614. use Tqdev\PhpCrudApi\Middleware\ValidationMiddleware;
  9615. use Tqdev\PhpCrudApi\Middleware\XmlMiddleware;
  9616. use Tqdev\PhpCrudApi\Middleware\XsrfMiddleware;
  9617. use Tqdev\PhpCrudApi\OpenApi\OpenApiService;
  9618. use Tqdev\PhpCrudApi\Record\ErrorCode;
  9619. use Tqdev\PhpCrudApi\Record\RecordService;
  9620. use Tqdev\PhpCrudApi\ResponseUtils;
  9621. class Api implements RequestHandlerInterface
  9622. {
  9623. private $router;
  9624. private $responder;
  9625. private $debug;
  9626. public function __construct(Config $config)
  9627. {
  9628. $db = new GenericDB(
  9629. $config->getDriver(),
  9630. $config->getAddress(),
  9631. $config->getPort(),
  9632. $config->getDatabase(),
  9633. $config->getTables(),
  9634. $config->getUsername(),
  9635. $config->getPassword()
  9636. );
  9637. $prefix = sprintf('phpcrudapi-%s-', substr(md5(__FILE__), 0, 8));
  9638. $cache = CacheFactory::create($config->getCacheType(), $prefix, $config->getCachePath());
  9639. $reflection = new ReflectionService($db, $cache, $config->getCacheTime());
  9640. $responder = new JsonResponder();
  9641. $router = new SimpleRouter($config->getBasePath(), $responder, $cache, $config->getCacheTime(), $config->getDebug());
  9642. foreach ($config->getMiddlewares() as $middleware => $properties) {
  9643. switch ($middleware) {
  9644. case 'sslRedirect':
  9645. new SslRedirectMiddleware($router, $responder, $properties);
  9646. break;
  9647. case 'cors':
  9648. new CorsMiddleware($router, $responder, $properties, $config->getDebug());
  9649. break;
  9650. case 'firewall':
  9651. new FirewallMiddleware($router, $responder, $properties);
  9652. break;
  9653. case 'basicAuth':
  9654. new BasicAuthMiddleware($router, $responder, $properties);
  9655. break;
  9656. case 'jwtAuth':
  9657. new JwtAuthMiddleware($router, $responder, $properties);
  9658. break;
  9659. case 'dbAuth':
  9660. new DbAuthMiddleware($router, $responder, $properties, $reflection, $db);
  9661. break;
  9662. case 'reconnect':
  9663. new ReconnectMiddleware($router, $responder, $properties, $reflection, $db);
  9664. break;
  9665. case 'validation':
  9666. new ValidationMiddleware($router, $responder, $properties, $reflection);
  9667. break;
  9668. case 'ipAddress':
  9669. new IpAddressMiddleware($router, $responder, $properties, $reflection);
  9670. break;
  9671. case 'sanitation':
  9672. new SanitationMiddleware($router, $responder, $properties, $reflection);
  9673. break;
  9674. case 'multiTenancy':
  9675. new MultiTenancyMiddleware($router, $responder, $properties, $reflection);
  9676. break;
  9677. case 'authorization':
  9678. new AuthorizationMiddleware($router, $responder, $properties, $reflection);
  9679. break;
  9680. case 'xsrf':
  9681. new XsrfMiddleware($router, $responder, $properties);
  9682. break;
  9683. case 'pageLimits':
  9684. new PageLimitsMiddleware($router, $responder, $properties, $reflection);
  9685. break;
  9686. case 'joinLimits':
  9687. new JoinLimitsMiddleware($router, $responder, $properties, $reflection);
  9688. break;
  9689. case 'customization':
  9690. new CustomizationMiddleware($router, $responder, $properties, $reflection);
  9691. break;
  9692. case 'xml':
  9693. new XmlMiddleware($router, $responder, $properties, $reflection);
  9694. break;
  9695. }
  9696. }
  9697. foreach ($config->getControllers() as $controller) {
  9698. switch ($controller) {
  9699. case 'records':
  9700. $records = new RecordService($db, $reflection);
  9701. new RecordController($router, $responder, $records);
  9702. break;
  9703. case 'columns':
  9704. $definition = new DefinitionService($db, $reflection);
  9705. new ColumnController($router, $responder, $reflection, $definition);
  9706. break;
  9707. case 'cache':
  9708. new CacheController($router, $responder, $cache);
  9709. break;
  9710. case 'openapi':
  9711. $openApi = new OpenApiService($reflection, $config->getOpenApiBase(), $config->getControllers(), $config->getCustomOpenApiBuilders());
  9712. new OpenApiController($router, $responder, $openApi);
  9713. break;
  9714. case 'geojson':
  9715. $records = new RecordService($db, $reflection);
  9716. $geoJson = new GeoJsonService($reflection, $records);
  9717. new GeoJsonController($router, $responder, $geoJson);
  9718. break;
  9719. }
  9720. }
  9721. foreach ($config->getCustomControllers() as $className) {
  9722. if (class_exists($className)) {
  9723. $records = new RecordService($db, $reflection);
  9724. new $className($router, $responder, $records);
  9725. }
  9726. }
  9727. $this->router = $router;
  9728. $this->responder = $responder;
  9729. $this->debug = $config->getDebug();
  9730. }
  9731. private function parseBody(string $body) /*: ?object*/
  9732. {
  9733. $first = substr($body, 0, 1);
  9734. if ($first == '[' || $first == '{') {
  9735. $object = json_decode($body);
  9736. $causeCode = json_last_error();
  9737. if ($causeCode !== JSON_ERROR_NONE) {
  9738. $object = null;
  9739. }
  9740. } else {
  9741. parse_str($body, $input);
  9742. foreach ($input as $key => $value) {
  9743. if (substr($key, -9) == '__is_null') {
  9744. $input[substr($key, 0, -9)] = null;
  9745. unset($input[$key]);
  9746. }
  9747. }
  9748. $object = (object) $input;
  9749. }
  9750. return $object;
  9751. }
  9752. private function addParsedBody(ServerRequestInterface $request): ServerRequestInterface
  9753. {
  9754. $parsedBody = $request->getParsedBody();
  9755. if ($parsedBody) {
  9756. $request = $this->applyParsedBodyHack($request);
  9757. } else {
  9758. $body = $request->getBody();
  9759. if ($body->isReadable()) {
  9760. if ($body->isSeekable()) {
  9761. $body->rewind();
  9762. }
  9763. $contents = $body->getContents();
  9764. if ($body->isSeekable()) {
  9765. $body->rewind();
  9766. }
  9767. if ($contents) {
  9768. $parsedBody = $this->parseBody($contents);
  9769. $request = $request->withParsedBody($parsedBody);
  9770. }
  9771. }
  9772. }
  9773. return $request;
  9774. }
  9775. private function applyParsedBodyHack(ServerRequestInterface $request): ServerRequestInterface
  9776. {
  9777. $parsedBody = $request->getParsedBody();
  9778. if (is_array($parsedBody)) { // is it really?
  9779. $contents = json_encode($parsedBody);
  9780. $parsedBody = $this->parseBody($contents);
  9781. $request = $request->withParsedBody($parsedBody);
  9782. }
  9783. return $request;
  9784. }
  9785. public function handle(ServerRequestInterface $request): ResponseInterface
  9786. {
  9787. return $this->router->route($this->addParsedBody($request));
  9788. }
  9789. }
  9790. }
  9791. // file: src/Tqdev/PhpCrudApi/Config.php
  9792. namespace Tqdev\PhpCrudApi {
  9793. class Config
  9794. {
  9795. private $values = [
  9796. 'driver' => null,
  9797. 'address' => 'localhost',
  9798. 'port' => null,
  9799. 'username' => null,
  9800. 'password' => null,
  9801. 'database' => null,
  9802. 'tables' => '',
  9803. 'middlewares' => 'cors,errors',
  9804. 'controllers' => 'records,geojson,openapi',
  9805. 'customControllers' => '',
  9806. 'customOpenApiBuilders' => '',
  9807. 'cacheType' => 'TempFile',
  9808. 'cachePath' => '',
  9809. 'cacheTime' => 10,
  9810. 'debug' => false,
  9811. 'basePath' => '',
  9812. 'openApiBase' => '{"info":{"title":"PHP-CRUD-API","version":"1.0.0"}}',
  9813. ];
  9814. private function getDefaultDriver(array $values): string
  9815. {
  9816. if (isset($values['driver'])) {
  9817. return $values['driver'];
  9818. }
  9819. return 'mysql';
  9820. }
  9821. private function getDefaultPort(string $driver): int
  9822. {
  9823. switch ($driver) {
  9824. case 'mysql':
  9825. return 3306;
  9826. case 'pgsql':
  9827. return 5432;
  9828. case 'sqlsrv':
  9829. return 1433;
  9830. case 'sqlite':
  9831. return 0;
  9832. }
  9833. }
  9834. private function getDefaultAddress(string $driver): string
  9835. {
  9836. switch ($driver) {
  9837. case 'mysql':
  9838. return 'localhost';
  9839. case 'pgsql':
  9840. return 'localhost';
  9841. case 'sqlsrv':
  9842. return 'localhost';
  9843. case 'sqlite':
  9844. return 'data.db';
  9845. }
  9846. }
  9847. private function getDriverDefaults(string $driver): array
  9848. {
  9849. return [
  9850. 'driver' => $driver,
  9851. 'address' => $this->getDefaultAddress($driver),
  9852. 'port' => $this->getDefaultPort($driver),
  9853. ];
  9854. }
  9855. private function applyEnvironmentVariables(array $values): array
  9856. {
  9857. $newValues = array();
  9858. foreach ($values as $key => $value) {
  9859. $environmentKey = 'PHP_CRUD_API_' . strtoupper(preg_replace('/(?<!^)[A-Z]/', '_$0', str_replace('.', '_', $key)));
  9860. $newValues[$key] = getenv($environmentKey, true) ?: $value;
  9861. }
  9862. return $newValues;
  9863. }
  9864. public function __construct(array $values)
  9865. {
  9866. $driver = $this->getDefaultDriver($values);
  9867. $defaults = $this->getDriverDefaults($driver);
  9868. $newValues = array_merge($this->values, $defaults, $values);
  9869. $newValues = $this->parseMiddlewares($newValues);
  9870. $diff = array_diff_key($newValues, $this->values);
  9871. if (!empty($diff)) {
  9872. $key = array_keys($diff)[0];
  9873. throw new \Exception("Config has invalid value '$key'");
  9874. }
  9875. $newValues = $this->applyEnvironmentVariables($newValues);
  9876. $this->values = $newValues;
  9877. }
  9878. private function parseMiddlewares(array $values): array
  9879. {
  9880. $newValues = array();
  9881. $properties = array();
  9882. $middlewares = array_map('trim', explode(',', $values['middlewares']));
  9883. foreach ($middlewares as $middleware) {
  9884. $properties[$middleware] = [];
  9885. }
  9886. foreach ($values as $key => $value) {
  9887. if (strpos($key, '.') === false) {
  9888. $newValues[$key] = $value;
  9889. } else {
  9890. list($middleware, $key2) = explode('.', $key, 2);
  9891. if (isset($properties[$middleware])) {
  9892. $properties[$middleware][$key2] = $value;
  9893. } else {
  9894. throw new \Exception("Config has invalid value '$key'");
  9895. }
  9896. }
  9897. }
  9898. $newValues['middlewares'] = array_reverse($properties, true);
  9899. return $newValues;
  9900. }
  9901. public function getDriver(): string
  9902. {
  9903. return $this->values['driver'];
  9904. }
  9905. public function getAddress(): string
  9906. {
  9907. return $this->values['address'];
  9908. }
  9909. public function getPort(): int
  9910. {
  9911. return $this->values['port'];
  9912. }
  9913. public function getUsername(): string
  9914. {
  9915. return $this->values['username'];
  9916. }
  9917. public function getPassword(): string
  9918. {
  9919. return $this->values['password'];
  9920. }
  9921. public function getDatabase(): string
  9922. {
  9923. return $this->values['database'];
  9924. }
  9925. public function getTables(): array
  9926. {
  9927. return array_filter(array_map('trim', explode(',', $this->values['tables'])));
  9928. }
  9929. public function getMiddlewares(): array
  9930. {
  9931. return $this->values['middlewares'];
  9932. }
  9933. public function getControllers(): array
  9934. {
  9935. return array_filter(array_map('trim', explode(',', $this->values['controllers'])));
  9936. }
  9937. public function getCustomControllers(): array
  9938. {
  9939. return array_filter(array_map('trim', explode(',', $this->values['customControllers'])));
  9940. }
  9941. public function getCustomOpenApiBuilders(): array
  9942. {
  9943. return array_filter(array_map('trim', explode(',', $this->values['customOpenApiBuilders'])));
  9944. }
  9945. public function getCacheType(): string
  9946. {
  9947. return $this->values['cacheType'];
  9948. }
  9949. public function getCachePath(): string
  9950. {
  9951. return $this->values['cachePath'];
  9952. }
  9953. public function getCacheTime(): int
  9954. {
  9955. return $this->values['cacheTime'];
  9956. }
  9957. public function getDebug(): bool
  9958. {
  9959. return $this->values['debug'];
  9960. }
  9961. public function getBasePath(): string
  9962. {
  9963. return $this->values['basePath'];
  9964. }
  9965. public function getOpenApiBase(): array
  9966. {
  9967. return json_decode($this->values['openApiBase'], true);
  9968. }
  9969. }
  9970. }
  9971. // file: src/Tqdev/PhpCrudApi/RequestFactory.php
  9972. namespace Tqdev\PhpCrudApi {
  9973. use Nyholm\Psr7\Factory\Psr17Factory;
  9974. use Nyholm\Psr7Server\ServerRequestCreator;
  9975. use Psr\Http\Message\ServerRequestInterface;
  9976. class RequestFactory
  9977. {
  9978. public static function fromGlobals(): ServerRequestInterface
  9979. {
  9980. $psr17Factory = new Psr17Factory();
  9981. $creator = new ServerRequestCreator($psr17Factory, $psr17Factory, $psr17Factory, $psr17Factory);
  9982. $serverRequest = $creator->fromGlobals();
  9983. $stream = $psr17Factory->createStreamFromFile('php://input');
  9984. $serverRequest = $serverRequest->withBody($stream);
  9985. return $serverRequest;
  9986. }
  9987. public static function fromString(string $request): ServerRequestInterface
  9988. {
  9989. $parts = explode("\n\n", trim($request), 2);
  9990. $lines = explode("\n", $parts[0]);
  9991. $first = explode(' ', trim(array_shift($lines)), 2);
  9992. $method = $first[0];
  9993. $body = isset($parts[1]) ? $parts[1] : '';
  9994. $url = isset($first[1]) ? $first[1] : '';
  9995. $psr17Factory = new Psr17Factory();
  9996. $serverRequest = $psr17Factory->createServerRequest($method, $url);
  9997. foreach ($lines as $line) {
  9998. list($key, $value) = explode(':', $line, 2);
  9999. $serverRequest = $serverRequest->withAddedHeader($key, $value);
  10000. }
  10001. if ($body) {
  10002. $stream = $psr17Factory->createStream($body);
  10003. $stream->rewind();
  10004. $serverRequest = $serverRequest->withBody($stream);
  10005. }
  10006. return $serverRequest;
  10007. }
  10008. }
  10009. }
  10010. // file: src/Tqdev/PhpCrudApi/RequestUtils.php
  10011. namespace Tqdev\PhpCrudApi {
  10012. use Psr\Http\Message\ServerRequestInterface;
  10013. use Tqdev\PhpCrudApi\Column\ReflectionService;
  10014. class RequestUtils
  10015. {
  10016. public static function setParams(ServerRequestInterface $request, array $params): ServerRequestInterface
  10017. {
  10018. $query = preg_replace('|%5B[0-9]+%5D=|', '=', http_build_query($params));
  10019. return $request->withUri($request->getUri()->withQuery($query));
  10020. }
  10021. public static function getHeader(ServerRequestInterface $request, string $header): string
  10022. {
  10023. $headers = $request->getHeader($header);
  10024. return isset($headers[0]) ? $headers[0] : '';
  10025. }
  10026. public static function getParams(ServerRequestInterface $request): array
  10027. {
  10028. $params = array();
  10029. $query = $request->getUri()->getQuery();
  10030. //$query = str_replace('][]=', ']=', str_replace('=', '[]=', $query));
  10031. $query = str_replace('%5D%5B%5D=', '%5D=', str_replace('=', '%5B%5D=', $query));
  10032. parse_str($query, $params);
  10033. return $params;
  10034. }
  10035. public static function getPathSegment(ServerRequestInterface $request, int $part): string
  10036. {
  10037. $path = $request->getUri()->getPath();
  10038. $pathSegments = explode('/', rtrim($path, '/'));
  10039. if ($part < 0 || $part >= count($pathSegments)) {
  10040. return '';
  10041. }
  10042. return urldecode($pathSegments[$part]);
  10043. }
  10044. public static function getOperation(ServerRequestInterface $request): string
  10045. {
  10046. $method = $request->getMethod();
  10047. $path = RequestUtils::getPathSegment($request, 1);
  10048. $hasPk = RequestUtils::getPathSegment($request, 3) != '';
  10049. switch ($path) {
  10050. case 'openapi':
  10051. return 'document';
  10052. case 'columns':
  10053. return $method == 'get' ? 'reflect' : 'remodel';
  10054. case 'geojson':
  10055. case 'records':
  10056. switch ($method) {
  10057. case 'POST':
  10058. return 'create';
  10059. case 'GET':
  10060. return $hasPk ? 'read' : 'list';
  10061. case 'PUT':
  10062. return 'update';
  10063. case 'DELETE':
  10064. return 'delete';
  10065. case 'PATCH':
  10066. return 'increment';
  10067. }
  10068. }
  10069. return 'unknown';
  10070. }
  10071. private static function getJoinTables(string $tableName, array $parameters): array
  10072. {
  10073. $uniqueTableNames = array();
  10074. $uniqueTableNames[$tableName] = true;
  10075. if (isset($parameters['join'])) {
  10076. foreach ($parameters['join'] as $parameter) {
  10077. $tableNames = explode(',', trim($parameter));
  10078. foreach ($tableNames as $tableName) {
  10079. $uniqueTableNames[$tableName] = true;
  10080. }
  10081. }
  10082. }
  10083. return array_keys($uniqueTableNames);
  10084. }
  10085. public static function getTableNames(ServerRequestInterface $request, ReflectionService $reflection): array
  10086. {
  10087. $path = RequestUtils::getPathSegment($request, 1);
  10088. $tableName = RequestUtils::getPathSegment($request, 2);
  10089. $allTableNames = $reflection->getTableNames();
  10090. switch ($path) {
  10091. case 'openapi':
  10092. return $allTableNames;
  10093. case 'columns':
  10094. return $tableName ? [$tableName] : $allTableNames;
  10095. case 'records':
  10096. return self::getJoinTables($tableName, RequestUtils::getParams($request));
  10097. }
  10098. return $allTableNames;
  10099. }
  10100. }
  10101. }
  10102. // file: src/Tqdev/PhpCrudApi/ResponseFactory.php
  10103. namespace Tqdev\PhpCrudApi {
  10104. use Nyholm\Psr7\Factory\Psr17Factory;
  10105. use Psr\Http\Message\ResponseInterface;
  10106. class ResponseFactory
  10107. {
  10108. const OK = 200;
  10109. const MOVED_PERMANENTLY = 301;
  10110. const FOUND = 302;
  10111. const UNAUTHORIZED = 401;
  10112. const FORBIDDEN = 403;
  10113. const NOT_FOUND = 404;
  10114. const METHOD_NOT_ALLOWED = 405;
  10115. const CONFLICT = 409;
  10116. const UNPROCESSABLE_ENTITY = 422;
  10117. const INTERNAL_SERVER_ERROR = 500;
  10118. public static function fromXml(int $status, string $xml): ResponseInterface
  10119. {
  10120. return self::from($status, 'text/xml', $xml);
  10121. }
  10122. public static function fromCsv(int $status, string $csv): ResponseInterface
  10123. {
  10124. return self::from($status, 'text/csv', $csv);
  10125. }
  10126. public static function fromHtml(int $status, string $html): ResponseInterface
  10127. {
  10128. return self::from($status, 'text/html', $html);
  10129. }
  10130. public static function fromObject(int $status, $body): ResponseInterface
  10131. {
  10132. $content = json_encode($body, JSON_UNESCAPED_UNICODE);
  10133. return self::from($status, 'application/json', $content);
  10134. }
  10135. public static function from(int $status, string $contentType, string $content): ResponseInterface
  10136. {
  10137. $psr17Factory = new Psr17Factory();
  10138. $response = $psr17Factory->createResponse($status);
  10139. $stream = $psr17Factory->createStream($content);
  10140. $stream->rewind();
  10141. $response = $response->withBody($stream);
  10142. $response = $response->withHeader('Content-Type', $contentType . '; charset=utf-8');
  10143. $response = $response->withHeader('Content-Length', strlen($content));
  10144. return $response;
  10145. }
  10146. public static function fromStatus(int $status): ResponseInterface
  10147. {
  10148. $psr17Factory = new Psr17Factory();
  10149. return $psr17Factory->createResponse($status);
  10150. }
  10151. }
  10152. }
  10153. // file: src/Tqdev/PhpCrudApi/ResponseUtils.php
  10154. namespace Tqdev\PhpCrudApi {
  10155. use Psr\Http\Message\ResponseInterface;
  10156. class ResponseUtils
  10157. {
  10158. public static function output(ResponseInterface $response)
  10159. {
  10160. $status = $response->getStatusCode();
  10161. $headers = $response->getHeaders();
  10162. $body = $response->getBody()->getContents();
  10163. http_response_code($status);
  10164. foreach ($headers as $key => $values) {
  10165. foreach ($values as $value) {
  10166. header("$key: $value");
  10167. }
  10168. }
  10169. echo $body;
  10170. }
  10171. public static function addExceptionHeaders(ResponseInterface $response, \Throwable $e): ResponseInterface
  10172. {
  10173. $response = $response->withHeader('X-Exception-Name', get_class($e));
  10174. $response = $response->withHeader('X-Exception-Message', preg_replace('|\n|', ' ', trim($e->getMessage())));
  10175. $response = $response->withHeader('X-Exception-File', $e->getFile() . ':' . $e->getLine());
  10176. return $response;
  10177. }
  10178. public static function toString(ResponseInterface $response): string
  10179. {
  10180. $status = $response->getStatusCode();
  10181. $headers = $response->getHeaders();
  10182. $body = $response->getBody()->getContents();
  10183. $str = "$status\n";
  10184. foreach ($headers as $key => $values) {
  10185. foreach ($values as $value) {
  10186. $str .= "$key: $value\n";
  10187. }
  10188. }
  10189. if ($body !== '') {
  10190. $str .= "\n";
  10191. $str .= "$body\n";
  10192. }
  10193. return $str;
  10194. }
  10195. }
  10196. }