functions.lib.php 552 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489
  1. <?php
  2. /* Copyright (C) 2000-2007 Rodolphe Quiedeville <rodolphe@quiedeville.org>
  3. * Copyright (C) 2003 Jean-Louis Bergamo <jlb@j1b.org>
  4. * Copyright (C) 2004-2022 Laurent Destailleur <eldy@users.sourceforge.net>
  5. * Copyright (C) 2004 Sebastien Di Cintio <sdicintio@ressource-toi.org>
  6. * Copyright (C) 2004 Benoit Mortier <benoit.mortier@opensides.be>
  7. * Copyright (C) 2004 Christophe Combelles <ccomb@free.fr>
  8. * Copyright (C) 2005-2019 Regis Houssin <regis.houssin@inodbox.com>
  9. * Copyright (C) 2008 Raphael Bertrand (Resultic) <raphael.bertrand@resultic.fr>
  10. * Copyright (C) 2010-2018 Juanjo Menent <jmenent@2byte.es>
  11. * Copyright (C) 2013 Cédric Salvador <csalvador@gpcsolutions.fr>
  12. * Copyright (C) 2013-2021 Alexandre Spangaro <aspangaro@open-dsi.fr>
  13. * Copyright (C) 2014 Cédric GROSS <c.gross@kreiz-it.fr>
  14. * Copyright (C) 2014-2015 Marcos García <marcosgdf@gmail.com>
  15. * Copyright (C) 2015 Jean-François Ferry <jfefe@aternatik.fr>
  16. * Copyright (C) 2018-2023 Frédéric France <frederic.france@netlogic.fr>
  17. * Copyright (C) 2019-2023 Thibault Foucart <support@ptibogxiv.net>
  18. * Copyright (C) 2020 Open-Dsi <support@open-dsi.fr>
  19. * Copyright (C) 2021 Gauthier VERDOL <gauthier.verdol@atm-consulting.fr>
  20. * Copyright (C) 2022 Anthony Berton <anthony.berton@bb2a.fr>
  21. * Copyright (C) 2022 Ferran Marcet <fmarcet@2byte.es>
  22. * Copyright (C) 2022 Charlene Benke <charlene@patas-monkey.com>
  23. * Copyright (C) 2023 Joachim Kueter <git-jk@bloxera.com>
  24. *
  25. * This program is free software; you can redistribute it and/or modify
  26. * it under the terms of the GNU General Public License as published by
  27. * the Free Software Foundation; either version 3 of the License, or
  28. * (at your option) any later version.
  29. *
  30. * This program is distributed in the hope that it will be useful,
  31. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  32. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  33. * GNU General Public License for more details.
  34. *
  35. * You should have received a copy of the GNU General Public License
  36. * along with this program. If not, see <https://www.gnu.org/licenses/>.
  37. * or see https://www.gnu.org/
  38. */
  39. /**
  40. * \file htdocs/core/lib/functions.lib.php
  41. * \brief A set of functions for Dolibarr
  42. * This file contains all frequently used functions.
  43. */
  44. include_once DOL_DOCUMENT_ROOT.'/core/lib/json.lib.php';
  45. // Function for better PHP x compatibility
  46. if (!function_exists('utf8_encode')) {
  47. /**
  48. * Implement utf8_encode for PHP that does not support it.
  49. *
  50. * @param mixed $elements PHP Object to json encode
  51. * @return string Json encoded string
  52. */
  53. function utf8_encode($elements)
  54. {
  55. return mb_convert_encoding($elements, 'UTF-8', 'ISO-8859-1');
  56. }
  57. }
  58. if (!function_exists('utf8_decode')) {
  59. /**
  60. * Implement utf8_decode for PHP that does not support it.
  61. *
  62. * @param mixed $elements PHP Object to json encode
  63. * @return string Json encoded string
  64. */
  65. function utf8_decode($elements)
  66. {
  67. return mb_convert_encoding($elements, 'ISO-8859-1', 'UTF-8');
  68. }
  69. }
  70. if (!function_exists('str_starts_with')) {
  71. /**
  72. * str_starts_with
  73. *
  74. * @param string $haystack haystack
  75. * @param string $needle needle
  76. * @return boolean
  77. */
  78. function str_starts_with($haystack, $needle)
  79. {
  80. return (string) $needle !== '' && strncmp($haystack, $needle, strlen($needle)) === 0;
  81. }
  82. }
  83. if (!function_exists('str_ends_with')) {
  84. /**
  85. * str_ends_with
  86. *
  87. * @param string $haystack haystack
  88. * @param string $needle needle
  89. * @return boolean
  90. */
  91. function str_ends_with($haystack, $needle)
  92. {
  93. return $needle !== '' && substr($haystack, -strlen($needle)) === (string) $needle;
  94. }
  95. }
  96. if (!function_exists('str_contains')) {
  97. /**
  98. * str_contains
  99. *
  100. * @param string $haystack haystack
  101. * @param string $needle needle
  102. * @return boolean
  103. */
  104. function str_contains($haystack, $needle)
  105. {
  106. return $needle !== '' && mb_strpos($haystack, $needle) !== false;
  107. }
  108. }
  109. /**
  110. * Return the full path of the directory where a module (or an object of a module) stores its files. Path may depends on the entity if a multicompany module is enabled.
  111. *
  112. * @param CommonObject $object Dolibarr common object
  113. * @param string $module Override object element, for example to use 'mycompany' instead of 'societe'
  114. * @return string|void The path of the relative directory of the module
  115. * @since Dolibarr V18
  116. */
  117. function getMultidirOutput($object, $module = '')
  118. {
  119. global $conf;
  120. if (!is_object($object) && empty($module)) {
  121. return null;
  122. }
  123. if (empty($module) && !empty($object->element)) {
  124. $module = $object->element;
  125. }
  126. // Special case for backward compatibility
  127. if ($module == 'fichinter') {
  128. $module = 'ficheinter';
  129. }
  130. if (isset($conf->$module) && property_exists($conf->$module, 'multidir_output')) {
  131. return $conf->$module->multidir_output[(empty($object->entity) ? $conf->entity : $object->entity)];
  132. } else {
  133. return 'error-diroutput-not-defined-for-this-object='.$module;
  134. }
  135. }
  136. /**
  137. * Return dolibarr global constant string value
  138. *
  139. * @param string $key key to return value, return '' if not set
  140. * @param string $default value to return
  141. * @return string
  142. */
  143. function getDolGlobalString($key, $default = '')
  144. {
  145. global $conf;
  146. return (string) (isset($conf->global->$key) ? $conf->global->$key : $default);
  147. }
  148. /**
  149. * Return a Dolibarr global constant int value.
  150. * The constants $conf->global->xxx are loaded by the script master.inc.php included at begin of any PHP page.
  151. *
  152. * @param string $key key to return value, return 0 if not set
  153. * @param int $default value to return
  154. * @return int
  155. */
  156. function getDolGlobalInt($key, $default = 0)
  157. {
  158. global $conf;
  159. return (int) (isset($conf->global->$key) ? $conf->global->$key : $default);
  160. }
  161. /**
  162. * Return Dolibarr user constant string value
  163. *
  164. * @param string $key key to return value, return '' if not set
  165. * @param string $default value to return
  166. * @param User $tmpuser To get another user than current user
  167. * @return string
  168. */
  169. function getDolUserString($key, $default = '', $tmpuser = null)
  170. {
  171. if (empty($tmpuser)) {
  172. global $user;
  173. $tmpuser = $user;
  174. }
  175. return (string) (empty($tmpuser->conf->$key) ? $default : $tmpuser->conf->$key);
  176. }
  177. /**
  178. * Return Dolibarr user constant int value
  179. *
  180. * @param string $key key to return value, return 0 if not set
  181. * @param int $default value to return
  182. * @param User $tmpuser To get another user than current user
  183. * @return int
  184. */
  185. function getDolUserInt($key, $default = 0, $tmpuser = null)
  186. {
  187. if (empty($tmpuser)) {
  188. global $user;
  189. $tmpuser = $user;
  190. }
  191. return (int) (empty($tmpuser->conf->$key) ? $default : $tmpuser->conf->$key);
  192. }
  193. /**
  194. * Is Dolibarr module enabled
  195. *
  196. * @param string $module Module name to check
  197. * @return boolean True if module is enabled
  198. */
  199. function isModEnabled($module)
  200. {
  201. global $conf;
  202. // Fix special cases
  203. $arrayconv = array(
  204. 'bank' => 'banque',
  205. 'category' => 'categorie',
  206. 'contract' => 'contrat',
  207. 'project' => 'projet',
  208. 'delivery_note' => 'expedition'
  209. );
  210. if (!getDolGlobalString('MAIN_USE_NEW_SUPPLIERMOD')) {
  211. $arrayconv['supplier_order'] = 'fournisseur';
  212. $arrayconv['supplier_invoice'] = 'fournisseur';
  213. }
  214. if (!empty($arrayconv[$module])) {
  215. $module = $arrayconv[$module];
  216. }
  217. return !empty($conf->modules[$module]);
  218. //return !empty($conf->$module->enabled);
  219. }
  220. /**
  221. * Return a DoliDB instance (database handler).
  222. *
  223. * @param string $type Type of database (mysql, pgsql...)
  224. * @param string $host Address of database server
  225. * @param string $user Authorized username
  226. * @param string $pass Password
  227. * @param string $name Name of database
  228. * @param int $port Port of database server
  229. * @return DoliDB A DoliDB instance
  230. */
  231. function getDoliDBInstance($type, $host, $user, $pass, $name, $port)
  232. {
  233. require_once DOL_DOCUMENT_ROOT."/core/db/".$type.'.class.php';
  234. $class = 'DoliDB'.ucfirst($type);
  235. $dolidb = new $class($type, $host, $user, $pass, $name, $port);
  236. return $dolidb;
  237. }
  238. /**
  239. * Get list of entity id to use.
  240. *
  241. * @param string $element Current element
  242. * 'societe', 'socpeople', 'actioncomm', 'agenda', 'resource',
  243. * 'product', 'productprice', 'stock', 'bom', 'mo',
  244. * 'propal', 'supplier_proposal', 'invoice', 'supplier_invoice', 'payment_various',
  245. * 'categorie', 'bank_account', 'bank_account', 'adherent', 'user',
  246. * 'commande', 'supplier_order', 'expedition', 'intervention', 'survey',
  247. * 'contract', 'tax', 'expensereport', 'holiday', 'multicurrency', 'project',
  248. * 'email_template', 'event', 'donation'
  249. * 'c_paiement', 'c_payment_term', ...
  250. * @param int $shared 0=Return id of current entity only,
  251. * 1=Return id of current entity + shared entities (default)
  252. * @param object $currentobject Current object if needed
  253. * @return mixed Entity id(s) to use ( eg. entity IN ('.getEntity(elementname).')' )
  254. */
  255. function getEntity($element, $shared = 1, $currentobject = null)
  256. {
  257. global $conf, $mc, $hookmanager, $object, $action, $db;
  258. if (!is_object($hookmanager)) {
  259. include_once DOL_DOCUMENT_ROOT.'/core/class/hookmanager.class.php';
  260. $hookmanager = new HookManager($db);
  261. }
  262. // fix different element names (France to English)
  263. switch ($element) {
  264. case 'projet':
  265. $element = 'project';
  266. break;
  267. case 'contrat':
  268. $element = 'contract';
  269. break; // "/contrat/class/contrat.class.php"
  270. case 'order_supplier':
  271. $element = 'supplier_order';
  272. break; // "/fourn/class/fournisseur.commande.class.php"
  273. case 'invoice_supplier':
  274. $element = 'supplier_invoice';
  275. break; // "/fourn/class/fournisseur.facture.class.php"
  276. }
  277. if (is_object($mc)) {
  278. $out = $mc->getEntity($element, $shared, $currentobject);
  279. } else {
  280. $out = '';
  281. $addzero = array('user', 'usergroup', 'cronjob', 'c_email_templates', 'email_template', 'default_values', 'overwrite_trans');
  282. if (in_array($element, $addzero)) {
  283. $out .= '0,';
  284. }
  285. $out .= ((int) $conf->entity);
  286. }
  287. // Manipulate entities to query on the fly
  288. $parameters = array(
  289. 'element' => $element,
  290. 'shared' => $shared,
  291. 'object' => $object,
  292. 'currentobject' => $currentobject,
  293. 'out' => $out
  294. );
  295. $reshook = $hookmanager->executeHooks('hookGetEntity', $parameters, $currentobject, $action); // Note that $action and $object may have been modified by some hooks
  296. if (is_numeric($reshook)) {
  297. if ($reshook == 0 && !empty($hookmanager->resPrint)) {
  298. $out .= ','.$hookmanager->resPrint; // add
  299. } elseif ($reshook == 1) {
  300. $out = $hookmanager->resPrint; // replace
  301. }
  302. }
  303. return $out;
  304. }
  305. /**
  306. * Set entity id to use when to create an object
  307. *
  308. * @param object $currentobject Current object
  309. * @return mixed Entity id to use ( eg. entity = '.setEntity($object) )
  310. */
  311. function setEntity($currentobject)
  312. {
  313. global $conf, $mc;
  314. if (is_object($mc) && method_exists($mc, 'setEntity')) {
  315. return $mc->setEntity($currentobject);
  316. } else {
  317. return ((is_object($currentobject) && $currentobject->id > 0 && $currentobject->entity > 0) ? $currentobject->entity : $conf->entity);
  318. }
  319. }
  320. /**
  321. * Return if string has a name dedicated to store a secret
  322. *
  323. * @param string $keyname Name of key to test
  324. * @return boolean True if key is used to store a secret
  325. */
  326. function isASecretKey($keyname)
  327. {
  328. return preg_match('/(_pass|password|_pw|_key|securekey|serverkey|secret\d?|p12key|exportkey|_PW_[a-z]+|token)$/i', $keyname);
  329. }
  330. /**
  331. * Return a numeric value into an Excel like column number. So 0 return 'A', 1 returns 'B'..., 26 return 'AA'
  332. *
  333. * @param int|string $n Numeric value
  334. * @return string Column in Excel format
  335. */
  336. function num2Alpha($n)
  337. {
  338. for ($r = ""; $n >= 0; $n = intval($n / 26) - 1) {
  339. $r = chr($n % 26 + 0x41) . $r;
  340. }
  341. return $r;
  342. }
  343. /**
  344. * Return information about user browser
  345. *
  346. * Returns array with the following format:
  347. * array(
  348. * 'browsername' => Browser name (firefox|chrome|iceweasel|epiphany|safari|opera|ie|unknown)
  349. * 'browserversion' => Browser version. Empty if unknown
  350. * 'browseros' => Set with mobile OS (android|blackberry|ios|palm|symbian|webos|maemo|windows|unknown)
  351. * 'layout' => (tablet|phone|classic)
  352. * 'phone' => empty if not mobile, (android|blackberry|ios|palm|unknown) if mobile
  353. * 'tablet' => true/false
  354. * )
  355. *
  356. * @param string $user_agent Content of $_SERVER["HTTP_USER_AGENT"] variable
  357. * @return array Check function documentation
  358. */
  359. function getBrowserInfo($user_agent)
  360. {
  361. include_once DOL_DOCUMENT_ROOT.'/includes/mobiledetect/mobiledetectlib/Mobile_Detect.php';
  362. $name = 'unknown';
  363. $version = '';
  364. $os = 'unknown';
  365. $phone = '';
  366. $user_agent = substr($user_agent, 0, 512); // Avoid to process too large user agent
  367. $detectmobile = new Mobile_Detect(null, $user_agent);
  368. $tablet = $detectmobile->isTablet();
  369. if ($detectmobile->isMobile()) {
  370. $phone = 'unknown';
  371. // If phone/smartphone, we set phone os name.
  372. if ($detectmobile->is('AndroidOS')) {
  373. $os = $phone = 'android';
  374. } elseif ($detectmobile->is('BlackBerryOS')) {
  375. $os = $phone = 'blackberry';
  376. } elseif ($detectmobile->is('iOS')) {
  377. $os = 'ios';
  378. $phone = 'iphone';
  379. } elseif ($detectmobile->is('PalmOS')) {
  380. $os = $phone = 'palm';
  381. } elseif ($detectmobile->is('SymbianOS')) {
  382. $os = 'symbian';
  383. } elseif ($detectmobile->is('webOS')) {
  384. $os = 'webos';
  385. } elseif ($detectmobile->is('MaemoOS')) {
  386. $os = 'maemo';
  387. } elseif ($detectmobile->is('WindowsMobileOS') || $detectmobile->is('WindowsPhoneOS')) {
  388. $os = 'windows';
  389. }
  390. }
  391. // OS
  392. if (preg_match('/linux/i', $user_agent)) {
  393. $os = 'linux';
  394. } elseif (preg_match('/macintosh/i', $user_agent)) {
  395. $os = 'macintosh';
  396. } elseif (preg_match('/windows/i', $user_agent)) {
  397. $os = 'windows';
  398. }
  399. // Name
  400. $reg = array();
  401. if (preg_match('/firefox(\/|\s)([\d\.]*)/i', $user_agent, $reg)) {
  402. $name = 'firefox';
  403. $version = empty($reg[2]) ? '' : $reg[2];
  404. } elseif (preg_match('/edge(\/|\s)([\d\.]*)/i', $user_agent, $reg)) {
  405. $name = 'edge';
  406. $version = empty($reg[2]) ? '' : $reg[2];
  407. } elseif (preg_match('/chrome(\/|\s)([\d\.]+)/i', $user_agent, $reg)) {
  408. $name = 'chrome';
  409. $version = empty($reg[2]) ? '' : $reg[2];
  410. } elseif (preg_match('/chrome/i', $user_agent, $reg)) {
  411. // we can have 'chrome (Mozilla...) chrome x.y' in one string
  412. $name = 'chrome';
  413. } elseif (preg_match('/iceweasel/i', $user_agent)) {
  414. $name = 'iceweasel';
  415. } elseif (preg_match('/epiphany/i', $user_agent)) {
  416. $name = 'epiphany';
  417. } elseif (preg_match('/safari(\/|\s)([\d\.]*)/i', $user_agent, $reg)) {
  418. $name = 'safari';
  419. $version = empty($reg[2]) ? '' : $reg[2];
  420. } elseif (preg_match('/opera(\/|\s)([\d\.]*)/i', $user_agent, $reg)) {
  421. // Safari is often present in string for mobile but its not.
  422. $name = 'opera';
  423. $version = empty($reg[2]) ? '' : $reg[2];
  424. } elseif (preg_match('/(MSIE\s([0-9]+\.[0-9]))|.*(Trident\/[0-9]+.[0-9];.*rv:([0-9]+\.[0-9]+))/i', $user_agent, $reg)) {
  425. $name = 'ie';
  426. $version = end($reg);
  427. } elseif (preg_match('/(Windows NT\s([0-9]+\.[0-9])).*(Trident\/[0-9]+.[0-9];.*rv:([0-9]+\.[0-9]+))/i', $user_agent, $reg)) {
  428. // MS products at end
  429. $name = 'ie';
  430. $version = end($reg);
  431. } elseif (preg_match('/l[iy]n(x|ks)(\(|\/|\s)*([\d\.]+)/i', $user_agent, $reg)) {
  432. // MS products at end
  433. $name = 'lynxlinks';
  434. $version = empty($reg[3]) ? '' : $reg[3];
  435. }
  436. if ($tablet) {
  437. $layout = 'tablet';
  438. } elseif ($phone) {
  439. $layout = 'phone';
  440. } else {
  441. $layout = 'classic';
  442. }
  443. return array(
  444. 'browsername' => $name,
  445. 'browserversion' => $version,
  446. 'browseros' => $os,
  447. 'browserua' => $user_agent,
  448. 'layout' => $layout, // tablet, phone, classic
  449. 'phone' => $phone, // deprecated
  450. 'tablet' => $tablet // deprecated
  451. );
  452. }
  453. /**
  454. * Function called at end of web php process
  455. *
  456. * @return void
  457. */
  458. function dol_shutdown()
  459. {
  460. global $db;
  461. $disconnectdone = false;
  462. $depth = 0;
  463. if (is_object($db) && !empty($db->connected)) {
  464. $depth = $db->transaction_opened;
  465. $disconnectdone = $db->close();
  466. }
  467. dol_syslog("--- End access to ".(empty($_SERVER["PHP_SELF"]) ? 'unknown' : $_SERVER["PHP_SELF"]).(($disconnectdone && $depth) ? ' (Warn: db disconnection forced, transaction depth was '.$depth.')' : ''), (($disconnectdone && $depth) ? LOG_WARNING : LOG_INFO));
  468. }
  469. /**
  470. * Return true if we are in a context of submitting the parameter $paramname from a POST of a form.
  471. * Warning:
  472. * For action=add, use: $var = GETPOST('var'); // No GETPOSTISSET, so GETPOST always called and default value is retreived if not a form POST, and value of form is retreived if it is a form POST.
  473. * For action=update, use: $var = GETPOSTISSET('var') ? GETPOST('var') : $object->var;
  474. *
  475. * @param string $paramname Name or parameter to test
  476. * @return boolean True if we have just submit a POST or GET request with the parameter provided (even if param is empty)
  477. */
  478. function GETPOSTISSET($paramname)
  479. {
  480. $isset = false;
  481. $relativepathstring = $_SERVER["PHP_SELF"];
  482. // Clean $relativepathstring
  483. if (constant('DOL_URL_ROOT')) {
  484. $relativepathstring = preg_replace('/^'.preg_quote(constant('DOL_URL_ROOT'), '/').'/', '', $relativepathstring);
  485. }
  486. $relativepathstring = preg_replace('/^\//', '', $relativepathstring);
  487. $relativepathstring = preg_replace('/^custom\//', '', $relativepathstring);
  488. //var_dump($relativepathstring);
  489. //var_dump($user->default_values);
  490. // Code for search criteria persistence.
  491. // Retrieve values if restore_lastsearch_values
  492. if (!empty($_GET['restore_lastsearch_values'])) { // Use $_GET here and not GETPOST
  493. if (!empty($_SESSION['lastsearch_values_'.$relativepathstring])) { // If there is saved values
  494. $tmp = json_decode($_SESSION['lastsearch_values_'.$relativepathstring], true);
  495. if (is_array($tmp)) {
  496. foreach ($tmp as $key => $val) {
  497. if ($key == $paramname) { // We are on the requested parameter
  498. $isset = true;
  499. break;
  500. }
  501. }
  502. }
  503. }
  504. // If there is saved contextpage, limit, page or mode
  505. if ($paramname == 'contextpage' && !empty($_SESSION['lastsearch_contextpage_'.$relativepathstring])) {
  506. $isset = true;
  507. } elseif ($paramname == 'limit' && !empty($_SESSION['lastsearch_limit_'.$relativepathstring])) {
  508. $isset = true;
  509. } elseif ($paramname == 'page' && !empty($_SESSION['lastsearch_page_'.$relativepathstring])) {
  510. $isset = true;
  511. } elseif ($paramname == 'mode' && !empty($_SESSION['lastsearch_mode_'.$relativepathstring])) {
  512. $isset = true;
  513. }
  514. } else {
  515. $isset = (isset($_POST[$paramname]) || isset($_GET[$paramname])); // We must keep $_POST and $_GET here
  516. }
  517. return $isset;
  518. }
  519. /**
  520. * Return true if the parameter $paramname is submit from a POST OR GET as an array.
  521. * Can be used before GETPOST to know if the $check param of GETPOST need to check an array or a string
  522. *
  523. * @param string $paramname Name or parameter to test
  524. * @param int $method Type of method (0 = get then post, 1 = only get, 2 = only post, 3 = post then get)
  525. * @return bool True if we have just submit a POST or GET request with the parameter provided (even if param is empty)
  526. */
  527. function GETPOSTISARRAY($paramname, $method = 0)
  528. {
  529. // for $method test need return the same $val as GETPOST
  530. if (empty($method)) {
  531. $val = isset($_GET[$paramname]) ? $_GET[$paramname] : (isset($_POST[$paramname]) ? $_POST[$paramname] : '');
  532. } elseif ($method == 1) {
  533. $val = isset($_GET[$paramname]) ? $_GET[$paramname] : '';
  534. } elseif ($method == 2) {
  535. $val = isset($_POST[$paramname]) ? $_POST[$paramname] : '';
  536. } elseif ($method == 3) {
  537. $val = isset($_POST[$paramname]) ? $_POST[$paramname] : (isset($_GET[$paramname]) ? $_GET[$paramname] : '');
  538. } else {
  539. $val = 'BadFirstParameterForGETPOST';
  540. }
  541. return is_array($val);
  542. }
  543. /**
  544. * Return value of a param into GET or POST supervariable.
  545. * Use the property $user->default_values[path]['createform'] and/or $user->default_values[path]['filters'] and/or $user->default_values[path]['sortorder']
  546. * Note: The property $user->default_values is loaded by main.php when loading the user.
  547. *
  548. * @param string $paramname Name of parameter to found
  549. * @param string $check Type of check
  550. * ''=no check (deprecated)
  551. * 'none'=no check (only for param that should have very rich content like passwords)
  552. * 'array', 'array:restricthtml' or 'array:aZ09' to check it's an array
  553. * 'int'=check it's numeric (integer or float)
  554. * 'intcomma'=check it's integer+comma ('1,2,3,4...')
  555. * 'alpha'=Same than alphanohtml since v13
  556. * 'alphawithlgt'=alpha with lgt
  557. * 'alphanohtml'=check there is no html content and no " and no ../
  558. * 'aZ'=check it's a-z only
  559. * 'aZ09'=check it's simple alpha string (recommended for keys)
  560. * 'aZ09arobase'=check it's a string for an element type
  561. * 'aZ09comma'=check it's a string for a sortfield or sortorder
  562. * 'san_alpha'=Use filter_var with FILTER_SANITIZE_STRING (do not use this for free text string)
  563. * 'nohtml'=check there is no html content
  564. * 'restricthtml'=check html content is restricted to some tags only
  565. * 'custom'= custom filter specify $filter and $options)
  566. * @param int $method Type of method (0 = get then post, 1 = only get, 2 = only post, 3 = post then get)
  567. * @param int $filter Filter to apply when $check is set to 'custom'. (See http://php.net/manual/en/filter.filters.php for détails)
  568. * @param mixed $options Options to pass to filter_var when $check is set to 'custom'
  569. * @param string $noreplace Force disable of replacement of __xxx__ strings.
  570. * @return string|array Value found (string or array), or '' if check fails
  571. */
  572. function GETPOST($paramname, $check = 'alphanohtml', $method = 0, $filter = null, $options = null, $noreplace = 0)
  573. {
  574. global $mysoc, $user, $conf;
  575. if (empty($paramname)) {
  576. return 'BadFirstParameterForGETPOST';
  577. }
  578. if (empty($check)) {
  579. dol_syslog("Deprecated use of GETPOST, called with 1st param = ".$paramname." and a 2nd param that is '', when calling page ".$_SERVER["PHP_SELF"], LOG_WARNING);
  580. // Enable this line to know who call the GETPOST with '' $check parameter.
  581. //var_dump(debug_backtrace()[0]);
  582. }
  583. if (empty($method)) {
  584. $out = isset($_GET[$paramname]) ? $_GET[$paramname] : (isset($_POST[$paramname]) ? $_POST[$paramname] : '');
  585. } elseif ($method == 1) {
  586. $out = isset($_GET[$paramname]) ? $_GET[$paramname] : '';
  587. } elseif ($method == 2) {
  588. $out = isset($_POST[$paramname]) ? $_POST[$paramname] : '';
  589. } elseif ($method == 3) {
  590. $out = isset($_POST[$paramname]) ? $_POST[$paramname] : (isset($_GET[$paramname]) ? $_GET[$paramname] : '');
  591. } else {
  592. return 'BadThirdParameterForGETPOST';
  593. }
  594. if (empty($method) || $method == 3 || $method == 4) {
  595. $relativepathstring = (empty($_SERVER["PHP_SELF"]) ? '' : $_SERVER["PHP_SELF"]);
  596. // Clean $relativepathstring
  597. if (constant('DOL_URL_ROOT')) {
  598. $relativepathstring = preg_replace('/^'.preg_quote(constant('DOL_URL_ROOT'), '/').'/', '', $relativepathstring);
  599. }
  600. $relativepathstring = preg_replace('/^\//', '', $relativepathstring);
  601. $relativepathstring = preg_replace('/^custom\//', '', $relativepathstring);
  602. //var_dump($relativepathstring);
  603. //var_dump($user->default_values);
  604. // Code for search criteria persistence.
  605. // Retrieve saved values if restore_lastsearch_values is set
  606. if (!empty($_GET['restore_lastsearch_values'])) { // Use $_GET here and not GETPOST
  607. if (!empty($_SESSION['lastsearch_values_'.$relativepathstring])) { // If there is saved values
  608. $tmp = json_decode($_SESSION['lastsearch_values_'.$relativepathstring], true);
  609. if (is_array($tmp)) {
  610. foreach ($tmp as $key => $val) {
  611. if ($key == $paramname) { // We are on the requested parameter
  612. $out = $val;
  613. break;
  614. }
  615. }
  616. }
  617. }
  618. // If there is saved contextpage, page or limit
  619. if ($paramname == 'contextpage' && !empty($_SESSION['lastsearch_contextpage_'.$relativepathstring])) {
  620. $out = $_SESSION['lastsearch_contextpage_'.$relativepathstring];
  621. } elseif ($paramname == 'limit' && !empty($_SESSION['lastsearch_limit_'.$relativepathstring])) {
  622. $out = $_SESSION['lastsearch_limit_'.$relativepathstring];
  623. } elseif ($paramname == 'page' && !empty($_SESSION['lastsearch_page_'.$relativepathstring])) {
  624. $out = $_SESSION['lastsearch_page_'.$relativepathstring];
  625. } elseif ($paramname == 'mode' && !empty($_SESSION['lastsearch_mode_'.$relativepathstring])) {
  626. $out = $_SESSION['lastsearch_mode_'.$relativepathstring];
  627. }
  628. } elseif (!isset($_GET['sortfield'])) {
  629. // Else, retrieve default values if we are not doing a sort
  630. // If we did a click on a field to sort, we do no apply default values. Same if option MAIN_ENABLE_DEFAULT_VALUES is not set
  631. if (!empty($_GET['action']) && $_GET['action'] == 'create' && !isset($_GET[$paramname]) && !isset($_POST[$paramname])) {
  632. // Search default value from $object->field
  633. global $object;
  634. if (is_object($object) && isset($object->fields[$paramname]['default'])) {
  635. $out = $object->fields[$paramname]['default'];
  636. }
  637. }
  638. if (getDolGlobalString('MAIN_ENABLE_DEFAULT_VALUES')) {
  639. if (!empty($_GET['action']) && (preg_match('/^create/', $_GET['action']) || preg_match('/^presend/', $_GET['action'])) && !isset($_GET[$paramname]) && !isset($_POST[$paramname])) {
  640. // Now search in setup to overwrite default values
  641. if (!empty($user->default_values)) { // $user->default_values defined from menu 'Setup - Default values'
  642. if (isset($user->default_values[$relativepathstring]['createform'])) {
  643. foreach ($user->default_values[$relativepathstring]['createform'] as $defkey => $defval) {
  644. $qualified = 0;
  645. if ($defkey != '_noquery_') {
  646. $tmpqueryarraytohave = explode('&', $defkey);
  647. $tmpqueryarraywehave = explode('&', dol_string_nohtmltag($_SERVER['QUERY_STRING']));
  648. $foundintru = 0;
  649. foreach ($tmpqueryarraytohave as $tmpquerytohave) {
  650. if (!in_array($tmpquerytohave, $tmpqueryarraywehave)) {
  651. $foundintru = 1;
  652. }
  653. }
  654. if (!$foundintru) {
  655. $qualified = 1;
  656. }
  657. //var_dump($defkey.'-'.$qualified);
  658. } else {
  659. $qualified = 1;
  660. }
  661. if ($qualified) {
  662. if (isset($user->default_values[$relativepathstring]['createform'][$defkey][$paramname])) {
  663. $out = $user->default_values[$relativepathstring]['createform'][$defkey][$paramname];
  664. break;
  665. }
  666. }
  667. }
  668. }
  669. }
  670. } elseif (!empty($paramname) && !isset($_GET[$paramname]) && !isset($_POST[$paramname])) {
  671. // Management of default search_filters and sort order
  672. if (!empty($user->default_values)) {
  673. // $user->default_values defined from menu 'Setup - Default values'
  674. //var_dump($user->default_values[$relativepathstring]);
  675. if ($paramname == 'sortfield' || $paramname == 'sortorder') {
  676. // Sorted on which fields ? ASC or DESC ?
  677. if (isset($user->default_values[$relativepathstring]['sortorder'])) {
  678. // Even if paramname is sortfield, data are stored into ['sortorder...']
  679. foreach ($user->default_values[$relativepathstring]['sortorder'] as $defkey => $defval) {
  680. $qualified = 0;
  681. if ($defkey != '_noquery_') {
  682. $tmpqueryarraytohave = explode('&', $defkey);
  683. $tmpqueryarraywehave = explode('&', dol_string_nohtmltag($_SERVER['QUERY_STRING']));
  684. $foundintru = 0;
  685. foreach ($tmpqueryarraytohave as $tmpquerytohave) {
  686. if (!in_array($tmpquerytohave, $tmpqueryarraywehave)) {
  687. $foundintru = 1;
  688. }
  689. }
  690. if (!$foundintru) {
  691. $qualified = 1;
  692. }
  693. //var_dump($defkey.'-'.$qualified);
  694. } else {
  695. $qualified = 1;
  696. }
  697. if ($qualified) {
  698. $forbidden_chars_to_replace = array(" ", "'", "/", "\\", ":", "*", "?", "\"", "<", ">", "|", "[", "]", ";", "="); // we accept _, -, . and ,
  699. foreach ($user->default_values[$relativepathstring]['sortorder'][$defkey] as $key => $val) {
  700. if ($out) {
  701. $out .= ', ';
  702. }
  703. if ($paramname == 'sortfield') {
  704. $out .= dol_string_nospecial($key, '', $forbidden_chars_to_replace);
  705. }
  706. if ($paramname == 'sortorder') {
  707. $out .= dol_string_nospecial($val, '', $forbidden_chars_to_replace);
  708. }
  709. }
  710. //break; // No break for sortfield and sortorder so we can cumulate fields (is it realy usefull ?)
  711. }
  712. }
  713. }
  714. } elseif (isset($user->default_values[$relativepathstring]['filters'])) {
  715. foreach ($user->default_values[$relativepathstring]['filters'] as $defkey => $defval) { // $defkey is a querystring like 'a=b&c=d', $defval is key of user
  716. if (!empty($_GET['disabledefaultvalues'])) { // If set of default values has been disabled by a request parameter
  717. continue;
  718. }
  719. $qualified = 0;
  720. if ($defkey != '_noquery_') {
  721. $tmpqueryarraytohave = explode('&', $defkey);
  722. $tmpqueryarraywehave = explode('&', dol_string_nohtmltag($_SERVER['QUERY_STRING']));
  723. $foundintru = 0;
  724. foreach ($tmpqueryarraytohave as $tmpquerytohave) {
  725. if (!in_array($tmpquerytohave, $tmpqueryarraywehave)) {
  726. $foundintru = 1;
  727. }
  728. }
  729. if (!$foundintru) {
  730. $qualified = 1;
  731. }
  732. //var_dump($defkey.'-'.$qualified);
  733. } else {
  734. $qualified = 1;
  735. }
  736. if ($qualified && isset($user->default_values[$relativepathstring]['filters'][$defkey][$paramname])) {
  737. // We must keep $_POST and $_GET here
  738. if (isset($_POST['sall']) || isset($_POST['search_all']) || isset($_GET['sall']) || isset($_GET['search_all'])) {
  739. // We made a search from quick search menu, do we still use default filter ?
  740. if (!getDolGlobalString('MAIN_DISABLE_DEFAULT_FILTER_FOR_QUICK_SEARCH')) {
  741. $forbidden_chars_to_replace = array(" ", "'", "/", "\\", ":", "*", "?", "\"", "<", ">", "|", "[", "]", ";", "="); // we accept _, -, . and ,
  742. $out = dol_string_nospecial($user->default_values[$relativepathstring]['filters'][$defkey][$paramname], '', $forbidden_chars_to_replace);
  743. }
  744. } else {
  745. $forbidden_chars_to_replace = array(" ", "'", "/", "\\", ":", "*", "?", "\"", "<", ">", "|", "[", "]", ";", "="); // we accept _, -, . and ,
  746. $out = dol_string_nospecial($user->default_values[$relativepathstring]['filters'][$defkey][$paramname], '', $forbidden_chars_to_replace);
  747. }
  748. break;
  749. }
  750. }
  751. }
  752. }
  753. }
  754. }
  755. }
  756. }
  757. // Substitution variables for GETPOST (used to get final url with variable parameters or final default value, when using variable parameters __XXX__ in the GET URL)
  758. // Example of variables: __DAY__, __MONTH__, __YEAR__, __MYCOMPANY_COUNTRY_ID__, __USER_ID__, ...
  759. // We do this only if var is a GET. If it is a POST, may be we want to post the text with vars as the setup text.
  760. if (!is_array($out) && empty($_POST[$paramname]) && empty($noreplace)) {
  761. $reg = array();
  762. $maxloop = 20;
  763. $loopnb = 0; // Protection against infinite loop
  764. while (preg_match('/__([A-Z0-9]+_?[A-Z0-9]+)__/i', $out, $reg) && ($loopnb < $maxloop)) { // Detect '__ABCDEF__' as key 'ABCDEF' and '__ABC_DEF__' as key 'ABC_DEF'. Detection is also correct when 2 vars are side by side.
  765. $loopnb++;
  766. $newout = '';
  767. if ($reg[1] == 'DAY') {
  768. $tmp = dol_getdate(dol_now(), true);
  769. $newout = $tmp['mday'];
  770. } elseif ($reg[1] == 'MONTH') {
  771. $tmp = dol_getdate(dol_now(), true);
  772. $newout = $tmp['mon'];
  773. } elseif ($reg[1] == 'YEAR') {
  774. $tmp = dol_getdate(dol_now(), true);
  775. $newout = $tmp['year'];
  776. } elseif ($reg[1] == 'PREVIOUS_DAY') {
  777. $tmp = dol_getdate(dol_now(), true);
  778. $tmp2 = dol_get_prev_day($tmp['mday'], $tmp['mon'], $tmp['year']);
  779. $newout = $tmp2['day'];
  780. } elseif ($reg[1] == 'PREVIOUS_MONTH') {
  781. $tmp = dol_getdate(dol_now(), true);
  782. $tmp2 = dol_get_prev_month($tmp['mon'], $tmp['year']);
  783. $newout = $tmp2['month'];
  784. } elseif ($reg[1] == 'PREVIOUS_YEAR') {
  785. $tmp = dol_getdate(dol_now(), true);
  786. $newout = ($tmp['year'] - 1);
  787. } elseif ($reg[1] == 'NEXT_DAY') {
  788. $tmp = dol_getdate(dol_now(), true);
  789. $tmp2 = dol_get_next_day($tmp['mday'], $tmp['mon'], $tmp['year']);
  790. $newout = $tmp2['day'];
  791. } elseif ($reg[1] == 'NEXT_MONTH') {
  792. $tmp = dol_getdate(dol_now(), true);
  793. $tmp2 = dol_get_next_month($tmp['mon'], $tmp['year']);
  794. $newout = $tmp2['month'];
  795. } elseif ($reg[1] == 'NEXT_YEAR') {
  796. $tmp = dol_getdate(dol_now(), true);
  797. $newout = ($tmp['year'] + 1);
  798. } elseif ($reg[1] == 'MYCOMPANY_COUNTRY_ID' || $reg[1] == 'MYCOUNTRY_ID' || $reg[1] == 'MYCOUNTRYID') {
  799. $newout = $mysoc->country_id;
  800. } elseif ($reg[1] == 'USER_ID' || $reg[1] == 'USERID') {
  801. $newout = $user->id;
  802. } elseif ($reg[1] == 'USER_SUPERVISOR_ID' || $reg[1] == 'SUPERVISOR_ID' || $reg[1] == 'SUPERVISORID') {
  803. $newout = $user->fk_user;
  804. } elseif ($reg[1] == 'ENTITY_ID' || $reg[1] == 'ENTITYID') {
  805. $newout = $conf->entity;
  806. } else {
  807. $newout = ''; // Key not found, we replace with empty string
  808. }
  809. //var_dump('__'.$reg[1].'__ -> '.$newout);
  810. $out = preg_replace('/__'.preg_quote($reg[1], '/').'__/', $newout, $out);
  811. }
  812. }
  813. // Check type of variable and make sanitization according to this
  814. if (preg_match('/^array/', $check)) { // If 'array' or 'array:restricthtml' or 'array:aZ09' or 'array:intcomma'
  815. if (!is_array($out) || empty($out)) {
  816. $out = array();
  817. } else {
  818. $tmparray = explode(':', $check);
  819. if (!empty($tmparray[1])) {
  820. $tmpcheck = $tmparray[1];
  821. } else {
  822. $tmpcheck = 'alphanohtml';
  823. }
  824. foreach ($out as $outkey => $outval) {
  825. $out[$outkey] = sanitizeVal($outval, $tmpcheck, $filter, $options);
  826. }
  827. }
  828. } else {
  829. // If field name is 'search_xxx' then we force the add of space after each < and > (when following char is numeric) because it means
  830. // we use the < or > to make a search on a numeric value to do higher or lower so we can add a space to break html tags
  831. if (strpos($paramname, 'search_') === 0) {
  832. $out = preg_replace('/([<>])([-+]?\d)/', '\1 \2', $out);
  833. }
  834. $out = sanitizeVal($out, $check, $filter, $options);
  835. }
  836. // Sanitizing for special parameters.
  837. // Note: There is no reason to allow the backtopage, backtolist or backtourl parameter to contains an external URL. Only relative URLs are allowed.
  838. if ($paramname == 'backtopage' || $paramname == 'backtolist' || $paramname == 'backtourl') {
  839. $out = str_replace('\\', '/', $out); // Can be before the loop because only 1 char is replaced. No risk to get it after other replacements.
  840. $out = str_replace(array(':', ';', '@', "\t", ' '), '', $out); // Can be before the loop because only 1 char is replaced. No risk to retreive it after other replacements.
  841. do {
  842. $oldstringtoclean = $out;
  843. $out = str_ireplace(array('javascript', 'vbscript', '&colon', '&#'), '', $out);
  844. $out = preg_replace(array('/^[^\?]*%/'), '', $out); // We remove any % chars before the ?. Example in url: '/product/stock/card.php?action=create&backtopage=%2Fdolibarr_dev%2Fhtdocs%2Fpro%25duct%2Fcard.php%3Fid%3Dabc'
  845. $out = preg_replace(array('/^[a-z]*\/\s*\/+/i'), '', $out); // We remove schema*// to remove external URL
  846. } while ($oldstringtoclean != $out);
  847. }
  848. // Code for search criteria persistence.
  849. // Save data into session if key start with 'search_' or is 'smonth', 'syear', 'month', 'year'
  850. if (empty($method) || $method == 3 || $method == 4) {
  851. if (preg_match('/^search_/', $paramname) || in_array($paramname, array('sortorder', 'sortfield'))) {
  852. //var_dump($paramname.' - '.$out.' '.$user->default_values[$relativepathstring]['filters'][$paramname]);
  853. // We save search key only if $out not empty that means:
  854. // - posted value not empty, or
  855. // - if posted value is empty and a default value exists that is not empty (it means we did a filter to an empty value when default was not).
  856. if ($out != '' && isset($user)) {// $out = '0' or 'abc', it is a search criteria to keep
  857. $user->lastsearch_values_tmp[$relativepathstring][$paramname] = $out;
  858. }
  859. }
  860. }
  861. return $out;
  862. }
  863. /**
  864. * Return value of a param into GET or POST supervariable.
  865. * Use the property $user->default_values[path]['creatform'] and/or $user->default_values[path]['filters'] and/or $user->default_values[path]['sortorder']
  866. * Note: The property $user->default_values is loaded by main.php when loading the user.
  867. *
  868. * @param string $paramname Name of parameter to found
  869. * @param int $method Type of method (0 = get then post, 1 = only get, 2 = only post, 3 = post then get)
  870. * @return int Value found (int)
  871. */
  872. function GETPOSTINT($paramname, $method = 0)
  873. {
  874. return (int) GETPOST($paramname, 'int', $method, null, null, 0);
  875. }
  876. /**
  877. * Return a sanitized or empty value after checking value against a rule.
  878. *
  879. * @deprecated
  880. * @param string|array $out Value to check/clear.
  881. * @param string $check Type of check/sanitizing
  882. * @param int $filter Filter to apply when $check is set to 'custom'. (See http://php.net/manual/en/filter.filters.php for détails)
  883. * @param mixed $options Options to pass to filter_var when $check is set to 'custom'
  884. * @return string|array Value sanitized (string or array). It may be '' if format check fails.
  885. */
  886. function checkVal($out = '', $check = 'alphanohtml', $filter = null, $options = null)
  887. {
  888. return sanitizeVal($out, $check, $filter, $options);
  889. }
  890. /**
  891. * Return a sanitized or empty value after checking value against a rule.
  892. *
  893. * @param string|array $out Value to check/clear.
  894. * @param string $check Type of check/sanitizing
  895. * @param int $filter Filter to apply when $check is set to 'custom'. (See http://php.net/manual/en/filter.filters.php for détails)
  896. * @param mixed $options Options to pass to filter_var when $check is set to 'custom'
  897. * @return string|array Value sanitized (string or array). It may be '' if format check fails.
  898. */
  899. function sanitizeVal($out = '', $check = 'alphanohtml', $filter = null, $options = null)
  900. {
  901. // TODO : use class "Validate" to perform tests (and add missing tests) if needed for factorize
  902. // Check is done after replacement
  903. switch ($check) {
  904. case 'none':
  905. break;
  906. case 'int': // Check param is a numeric value (integer but also float or hexadecimal)
  907. if (!is_numeric($out)) {
  908. $out = '';
  909. }
  910. break;
  911. case 'intcomma':
  912. if (preg_match('/[^0-9,-]+/i', $out)) {
  913. $out = '';
  914. }
  915. break;
  916. case 'san_alpha':
  917. $out = filter_var($out, FILTER_SANITIZE_STRING);
  918. break;
  919. case 'email':
  920. $out = filter_var($out, FILTER_SANITIZE_EMAIL);
  921. break;
  922. case 'aZ':
  923. if (!is_array($out)) {
  924. $out = trim($out);
  925. if (preg_match('/[^a-z]+/i', $out)) {
  926. $out = '';
  927. }
  928. }
  929. break;
  930. case 'aZ09':
  931. if (!is_array($out)) {
  932. $out = trim($out);
  933. if (preg_match('/[^a-z0-9_\-\.]+/i', $out)) {
  934. $out = '';
  935. }
  936. }
  937. break;
  938. case 'aZ09arobase': // great to sanitize $objecttype parameter
  939. if (!is_array($out)) {
  940. $out = trim($out);
  941. if (preg_match('/[^a-z0-9_\-\.@]+/i', $out)) {
  942. $out = '';
  943. }
  944. }
  945. break;
  946. case 'aZ09comma': // great to sanitize $sortfield or $sortorder params that can be 't.abc,t.def_gh'
  947. if (!is_array($out)) {
  948. $out = trim($out);
  949. if (preg_match('/[^a-z0-9_\-\.,]+/i', $out)) {
  950. $out = '';
  951. }
  952. }
  953. break;
  954. case 'alpha': // No html and no ../ and "
  955. case 'alphanohtml': // Recommended for most scalar parameters and search parameters
  956. if (!is_array($out)) {
  957. $out = trim($out);
  958. do {
  959. $oldstringtoclean = $out;
  960. // Remove html tags
  961. $out = dol_string_nohtmltag($out, 0);
  962. // Remove also other dangerous string sequences
  963. // '"' is dangerous because param in url can close the href= or src= and add javascript functions.
  964. // '../' or '..\' is dangerous because it allows dir transversals
  965. // Note &#38, '&#0000038', '&#x26'... is a simple char like '&' alone but there is no reason to accept such way to encode input data.
  966. $out = str_ireplace(array('&#38', '&#0000038', '&#x26', '&quot', '&#34', '&#0000034', '&#x22', '"', '&#47', '&#0000047', '&#92', '&#0000092', '&#x2F', '../', '..\\'), '', $out);
  967. } while ($oldstringtoclean != $out);
  968. // keep lines feed
  969. }
  970. break;
  971. case 'alphawithlgt': // No " and no ../ but we keep balanced < > tags with no special chars inside. Can be used for email string like "Name <email>". Less secured than 'alphanohtml'
  972. if (!is_array($out)) {
  973. $out = trim($out);
  974. do {
  975. $oldstringtoclean = $out;
  976. // Remove html tags
  977. $out = dol_html_entity_decode($out, ENT_COMPAT | ENT_HTML5, 'UTF-8');
  978. // '"' is dangerous because param in url can close the href= or src= and add javascript functions.
  979. // '../' or '..\' is dangerous because it allows dir transversals
  980. // Note &#38, '&#0000038', '&#x26'... is a simple char like '&' alone but there is no reason to accept such way to encode input data.
  981. $out = str_ireplace(array('&#38', '&#0000038', '&#x26', '&quot', '&#34', '&#0000034', '&#x22', '"', '&#47', '&#0000047', '&#92', '&#0000092', '&#x2F', '../', '..\\'), '', $out);
  982. } while ($oldstringtoclean != $out);
  983. }
  984. break;
  985. case 'nohtml': // No html
  986. $out = dol_string_nohtmltag($out, 0);
  987. break;
  988. case 'restricthtmlnolink':
  989. case 'restricthtml': // Recommended for most html textarea
  990. case 'restricthtmlallowclass':
  991. case 'restricthtmlallowunvalid':
  992. $out = dol_htmlwithnojs($out, 1, $check);
  993. break;
  994. case 'custom':
  995. if (!empty($out)) {
  996. if (empty($filter)) {
  997. return 'BadParameterForGETPOST - Param 3 of sanitizeVal()';
  998. }
  999. /*if (empty($options)) {
  1000. return 'BadParameterForGETPOST - Param 4 of sanitizeVal()';
  1001. }*/
  1002. $out = filter_var($out, $filter, $options);
  1003. }
  1004. break;
  1005. default:
  1006. dol_syslog("Error, you call sanitizeVal() with a bad value for the check type. Data can't be sanitized.", LOG_ERR);
  1007. break;
  1008. }
  1009. return $out;
  1010. }
  1011. if (!function_exists('dol_getprefix')) {
  1012. /**
  1013. * Return a prefix to use for this Dolibarr instance, for session/cookie names or email id.
  1014. * The prefix is unique for instance and avoid conflict between multi-instances, even when having two instances with same root dir
  1015. * or two instances in same virtual servers.
  1016. * This function must not use dol_hash (that is used for password hash) and need to have all context $conf loaded.
  1017. *
  1018. * @param string $mode '' (prefix for session name) or 'email' (prefix for email id)
  1019. * @return string A calculated prefix
  1020. */
  1021. function dol_getprefix($mode = '')
  1022. {
  1023. // If prefix is for email (we need to have $conf already loaded for this case)
  1024. if ($mode == 'email') {
  1025. global $conf;
  1026. if (getDolGlobalString('MAIL_PREFIX_FOR_EMAIL_ID')) { // If MAIL_PREFIX_FOR_EMAIL_ID is set
  1027. if (getDolGlobalString('MAIL_PREFIX_FOR_EMAIL_ID') != 'SERVER_NAME') {
  1028. return $conf->global->MAIL_PREFIX_FOR_EMAIL_ID;
  1029. } elseif (isset($_SERVER["SERVER_NAME"])) { // If MAIL_PREFIX_FOR_EMAIL_ID is set to 'SERVER_NAME'
  1030. return $_SERVER["SERVER_NAME"];
  1031. }
  1032. }
  1033. // The recommended value if MAIL_PREFIX_FOR_EMAIL_ID is not defined (may be not defined for old versions)
  1034. if (!empty($conf->file->instance_unique_id)) {
  1035. return sha1('dolibarr'.$conf->file->instance_unique_id);
  1036. }
  1037. // For backward compatibility when instance_unique_id is not set
  1038. return sha1(DOL_DOCUMENT_ROOT.DOL_URL_ROOT);
  1039. }
  1040. // If prefix is for session (no need to have $conf loaded)
  1041. global $dolibarr_main_instance_unique_id, $dolibarr_main_cookie_cryptkey; // This is loaded by filefunc.inc.php
  1042. $tmp_instance_unique_id = empty($dolibarr_main_instance_unique_id) ? (empty($dolibarr_main_cookie_cryptkey) ? '' : $dolibarr_main_cookie_cryptkey) : $dolibarr_main_instance_unique_id; // Unique id of instance
  1043. // The recommended value (may be not defined for old versions)
  1044. if (!empty($tmp_instance_unique_id)) {
  1045. return sha1('dolibarr'.$tmp_instance_unique_id);
  1046. }
  1047. // For backward compatibility when instance_unique_id is not set
  1048. if (isset($_SERVER["SERVER_NAME"]) && isset($_SERVER["DOCUMENT_ROOT"])) {
  1049. return sha1($_SERVER["SERVER_NAME"].$_SERVER["DOCUMENT_ROOT"].DOL_DOCUMENT_ROOT.DOL_URL_ROOT);
  1050. } else {
  1051. return sha1(DOL_DOCUMENT_ROOT.DOL_URL_ROOT);
  1052. }
  1053. }
  1054. }
  1055. /**
  1056. * Make an include_once using default root and alternate root if it fails.
  1057. * To link to a core file, use include(DOL_DOCUMENT_ROOT.'/pathtofile')
  1058. * To link to a module file from a module file, use include './mymodulefile';
  1059. * To link to a module file from a core file, then this function can be used (call by hook / trigger / speciales pages)
  1060. *
  1061. * @param string $relpath Relative path to file (Ie: mydir/myfile, ../myfile, ...)
  1062. * @param string $classname Class name (deprecated)
  1063. * @return bool True if load is a success, False if it fails
  1064. */
  1065. function dol_include_once($relpath, $classname = '')
  1066. {
  1067. global $conf, $langs, $user, $mysoc; // Do not remove this. They must be defined for files we include. Other globals var must be retrieved with $GLOBALS['var']
  1068. $fullpath = dol_buildpath($relpath);
  1069. if (!file_exists($fullpath)) {
  1070. dol_syslog('functions::dol_include_once Tried to load unexisting file: '.$relpath, LOG_WARNING);
  1071. return false;
  1072. }
  1073. if (!empty($classname) && !class_exists($classname)) {
  1074. return include $fullpath;
  1075. } else {
  1076. return include_once $fullpath;
  1077. }
  1078. }
  1079. /**
  1080. * Return path of url or filesystem. Can check into alternate dir or alternate dir + main dir depending on value of $returnemptyifnotfound.
  1081. *
  1082. * @param string $path Relative path to file (if mode=0) or relative url (if mode=1). Ie: mydir/myfile, ../myfile
  1083. * @param int $type 0=Used for a Filesystem path, 1=Used for an URL path (output relative), 2=Used for an URL path (output full path using same host that current url), 3=Used for an URL path (output full path using host defined into $dolibarr_main_url_root of conf file)
  1084. * @param int $returnemptyifnotfound 0:If $type==0 and if file was not found into alternate dir, return default path into main dir (no test on it)
  1085. * 1:If $type==0 and if file was not found into alternate dir, return empty string
  1086. * 2:If $type==0 and if file was not found into alternate dir, test into main dir, return default path if found, empty string if not found
  1087. * @return string Full filesystem path (if path=0) or '' if file not found, Full url path (if mode=1)
  1088. */
  1089. function dol_buildpath($path, $type = 0, $returnemptyifnotfound = 0)
  1090. {
  1091. global $conf;
  1092. $path = preg_replace('/^\//', '', $path);
  1093. if (empty($type)) { // For a filesystem path
  1094. $res = DOL_DOCUMENT_ROOT.'/'.$path; // Standard default path
  1095. if (is_array($conf->file->dol_document_root)) {
  1096. foreach ($conf->file->dol_document_root as $key => $dirroot) { // ex: array("main"=>"/home/main/htdocs", "alt0"=>"/home/dirmod/htdocs", ...)
  1097. if ($key == 'main') {
  1098. continue;
  1099. }
  1100. // if (@file_exists($dirroot.'/'.$path)) {
  1101. if (@file_exists($dirroot.'/'.$path)) { // avoid [php:warn]
  1102. $res = $dirroot.'/'.$path;
  1103. return $res;
  1104. }
  1105. }
  1106. }
  1107. if ($returnemptyifnotfound) {
  1108. // Not found into alternate dir
  1109. if ($returnemptyifnotfound == 1 || !file_exists($res)) {
  1110. return '';
  1111. }
  1112. }
  1113. } else {
  1114. // For an url path
  1115. // We try to get local path of file on filesystem from url
  1116. // Note that trying to know if a file on disk exist by forging path on disk from url
  1117. // works only for some web server and some setup. This is bugged when
  1118. // using proxy, rewriting, virtual path, etc...
  1119. $res = '';
  1120. if ($type == 1) {
  1121. $res = DOL_URL_ROOT.'/'.$path; // Standard value
  1122. }
  1123. if ($type == 2) {
  1124. $res = DOL_MAIN_URL_ROOT.'/'.$path; // Standard value
  1125. }
  1126. if ($type == 3) {
  1127. $res = DOL_URL_ROOT.'/'.$path;
  1128. }
  1129. foreach ($conf->file->dol_document_root as $key => $dirroot) { // ex: array(["main"]=>"/home/main/htdocs", ["alt0"]=>"/home/dirmod/htdocs", ...)
  1130. if ($key == 'main') {
  1131. if ($type == 3) {
  1132. /*global $dolibarr_main_url_root;*/
  1133. // Define $urlwithroot
  1134. $urlwithouturlroot = preg_replace('/'.preg_quote(DOL_URL_ROOT, '/').'$/i', '', trim($conf->file->dol_main_url_root));
  1135. $urlwithroot = $urlwithouturlroot.DOL_URL_ROOT; // This is to use external domain name found into config file
  1136. //$urlwithroot=DOL_MAIN_URL_ROOT; // This is to use same domain name than current
  1137. $res = (preg_match('/^http/i', $conf->file->dol_url_root[$key]) ? '' : $urlwithroot).'/'.$path; // Test on start with http is for old conf syntax
  1138. }
  1139. continue;
  1140. }
  1141. $regs = array();
  1142. preg_match('/^([^\?]+(\.css\.php|\.css|\.js\.php|\.js|\.png|\.jpg|\.php)?)/i', $path, $regs); // Take part before '?'
  1143. if (!empty($regs[1])) {
  1144. //print $key.'-'.$dirroot.'/'.$path.'-'.$conf->file->dol_url_root[$type].'<br>'."\n";
  1145. //if (file_exists($dirroot.'/'.$regs[1])) {
  1146. if (@file_exists($dirroot.'/'.$regs[1])) { // avoid [php:warn]
  1147. if ($type == 1) {
  1148. $res = (preg_match('/^http/i', $conf->file->dol_url_root[$key]) ? '' : DOL_URL_ROOT).$conf->file->dol_url_root[$key].'/'.$path;
  1149. }
  1150. if ($type == 2) {
  1151. $res = (preg_match('/^http/i', $conf->file->dol_url_root[$key]) ? '' : DOL_MAIN_URL_ROOT).$conf->file->dol_url_root[$key].'/'.$path;
  1152. }
  1153. if ($type == 3) {
  1154. /*global $dolibarr_main_url_root;*/
  1155. // Define $urlwithroot
  1156. $urlwithouturlroot = preg_replace('/'.preg_quote(DOL_URL_ROOT, '/').'$/i', '', trim($conf->file->dol_main_url_root));
  1157. $urlwithroot = $urlwithouturlroot.DOL_URL_ROOT; // This is to use external domain name found into config file
  1158. //$urlwithroot=DOL_MAIN_URL_ROOT; // This is to use same domain name than current
  1159. $res = (preg_match('/^http/i', $conf->file->dol_url_root[$key]) ? '' : $urlwithroot).$conf->file->dol_url_root[$key].'/'.$path; // Test on start with http is for old conf syntax
  1160. }
  1161. break;
  1162. }
  1163. }
  1164. }
  1165. }
  1166. return $res;
  1167. }
  1168. /**
  1169. * Create a clone of instance of object (new instance with same value for each properties)
  1170. * With native = 0: Property that are reference are different memory area in the new object (full isolation clone). This means $this->db of new object may not be valid.
  1171. * With native = 1: Use PHP clone. Property that are reference are same pointer. This means $this->db of new object is still valid but point to same this->db than original object.
  1172. * With native = 2: Property that are reference are different memory area in the new object (full isolation clone). Only scalar and array values are cloned. This means method are not availables and $this->db of new object is not valid.
  1173. *
  1174. * @param object $object Object to clone
  1175. * @param int $native 0=Full isolation method, 1=Native PHP method, 2=Full isolation method keeping only scalar and array properties (recommended)
  1176. * @return object Clone object
  1177. * @see https://php.net/manual/language.oop5.cloning.php
  1178. */
  1179. function dol_clone($object, $native = 0)
  1180. {
  1181. if ($native == 0) {
  1182. // deprecated method, use the method with native = 2 instead
  1183. $tmpsavdb = null;
  1184. if (isset($object->db) && isset($object->db->db) && is_object($object->db->db) && get_class($object->db->db) == 'PgSql\Connection') {
  1185. $tmpsavdb = $object->db;
  1186. unset($object->db); // Such property can not be serialized with pgsl (when object->db->db = 'PgSql\Connection')
  1187. }
  1188. $myclone = unserialize(serialize($object)); // serialize then unserialize is a hack to be sure to have a new object for all fields
  1189. if (!empty($tmpsavdb)) {
  1190. $object->db = $tmpsavdb;
  1191. }
  1192. } elseif ($native == 2) {
  1193. // recommended method to have a full isolated cloned object
  1194. $myclone = new stdClass();
  1195. $tmparray = get_object_vars($object); // return only public properties
  1196. if (is_array($tmparray)) {
  1197. foreach ($tmparray as $propertykey => $propertyval) {
  1198. if (is_scalar($propertyval) || is_array($propertyval)) {
  1199. $myclone->$propertykey = $propertyval;
  1200. }
  1201. }
  1202. }
  1203. } else {
  1204. $myclone = clone $object; // PHP clone is a shallow copy only, not a real clone, so properties of references will keep the reference (refering to the same target/variable)
  1205. }
  1206. return $myclone;
  1207. }
  1208. /**
  1209. * Optimize a size for some browsers (phone, smarphone, ...)
  1210. *
  1211. * @param int $size Size we want
  1212. * @param string $type Type of optimizing:
  1213. * '' = function used to define a size for truncation
  1214. * 'width' = function is used to define a width
  1215. * @return int New size after optimizing
  1216. */
  1217. function dol_size($size, $type = '')
  1218. {
  1219. global $conf;
  1220. if (empty($conf->dol_optimize_smallscreen)) {
  1221. return $size;
  1222. }
  1223. if ($type == 'width' && $size > 250) {
  1224. return 250;
  1225. } else {
  1226. return 10;
  1227. }
  1228. }
  1229. /**
  1230. * Clean a string to use it as a file name.
  1231. * Replace also '--' and ' -' strings, they are used for parameters separation (Note: ' - ' is allowed).
  1232. *
  1233. * @param string $str String to clean
  1234. * @param string $newstr String to replace bad chars with.
  1235. * @param int $unaccent 1=Remove also accent (default), 0 do not remove them
  1236. * @return string String cleaned (a-zA-Z_)
  1237. *
  1238. * @see dol_string_nospecial(), dol_string_unaccent(), dol_sanitizePathName()
  1239. */
  1240. function dol_sanitizeFileName($str, $newstr = '_', $unaccent = 1)
  1241. {
  1242. // List of special chars for filenames in windows are defined on page https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file
  1243. // Char '>' '<' '|' '$' and ';' are special chars for shells.
  1244. // Char '/' and '\' are file delimiters.
  1245. // Chars '--' can be used into filename to inject special paramaters like --use-compress-program to make command with file as parameter making remote execution of command
  1246. $filesystem_forbidden_chars = array('<', '>', '/', '\\', '?', '*', '|', '"', ':', '°', '$', ';', '`');
  1247. $tmp = dol_string_nospecial($unaccent ? dol_string_unaccent($str) : $str, $newstr, $filesystem_forbidden_chars);
  1248. $tmp = preg_replace('/\-\-+/', '_', $tmp);
  1249. $tmp = preg_replace('/\s+\-([^\s])/', ' _$1', $tmp);
  1250. $tmp = preg_replace('/\s+\-$/', '', $tmp);
  1251. $tmp = str_replace('..', '', $tmp);
  1252. return $tmp;
  1253. }
  1254. /**
  1255. * Clean a string to use it as a path name. Similare to dol_sanitizeFileName but accept / and \ chars.
  1256. * Replace also '--' and ' -' strings, they are used for parameters separation (Note: ' - ' is allowed).
  1257. *
  1258. * @param string $str String to clean
  1259. * @param string $newstr String to replace bad chars with
  1260. * @param int $unaccent 1=Remove also accent (default), 0 do not remove them
  1261. * @return string String cleaned (a-zA-Z_)
  1262. *
  1263. * @see dol_string_nospecial(), dol_string_unaccent(), dol_sanitizeFileName()
  1264. */
  1265. function dol_sanitizePathName($str, $newstr = '_', $unaccent = 1)
  1266. {
  1267. // List of special chars for filenames in windows are defined on page https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file
  1268. // Char '>' '<' '|' '$' and ';' are special chars for shells.
  1269. // Chars '--' can be used into filename to inject special paramaters like --use-compress-program to make command with file as parameter making remote execution of command
  1270. $filesystem_forbidden_chars = array('<', '>', '?', '*', '|', '"', '°', '$', ';', '`');
  1271. $tmp = dol_string_nospecial($unaccent ? dol_string_unaccent($str) : $str, $newstr, $filesystem_forbidden_chars);
  1272. $tmp = preg_replace('/\-\-+/', '_', $tmp);
  1273. $tmp = preg_replace('/\s+\-([^\s])/', ' _$1', $tmp);
  1274. $tmp = preg_replace('/\s+\-$/', '', $tmp);
  1275. $tmp = str_replace('..', '', $tmp);
  1276. return $tmp;
  1277. }
  1278. /**
  1279. * Clean a string to use it as an URL (into a href or src attribute)
  1280. *
  1281. * @param string $stringtoclean String to clean
  1282. * @param int $type 0=Accept all Url, 1=Clean external Url (keep only relative Url)
  1283. * @return string Escaped string.
  1284. */
  1285. function dol_sanitizeUrl($stringtoclean, $type = 1)
  1286. {
  1287. // We clean string because some hacks try to obfuscate evil strings by inserting non printable chars. Example: 'java(ascci09)scr(ascii00)ipt' is processed like 'javascript' (whatever is place of evil ascii char)
  1288. // We should use dol_string_nounprintableascii but function may not be yet loaded/available
  1289. $stringtoclean = preg_replace('/[\x00-\x1F\x7F]/u', '', $stringtoclean); // /u operator makes UTF8 valid characters being ignored so are not included into the replace
  1290. // We clean html comments because some hacks try to obfuscate evil strings by inserting HTML comments. Example: on<!-- -->error=alert(1)
  1291. $stringtoclean = preg_replace('/<!--[^>]*-->/', '', $stringtoclean);
  1292. $stringtoclean = str_replace('\\', '/', $stringtoclean);
  1293. if ($type == 1) {
  1294. // removing : should disable links to external url like http:aaa)
  1295. // removing ';' should disable "named" html entities encode into an url (we should not have this into an url)
  1296. $stringtoclean = str_replace(array(':', ';', '@'), '', $stringtoclean);
  1297. }
  1298. do {
  1299. $oldstringtoclean = $stringtoclean;
  1300. // removing '&colon' should disable links to external url like http:aaa)
  1301. // removing '&#' should disable "numeric" html entities encode into an url (we should not have this into an url)
  1302. $stringtoclean = str_ireplace(array('javascript', 'vbscript', '&colon', '&#'), '', $stringtoclean);
  1303. } while ($oldstringtoclean != $stringtoclean);
  1304. if ($type == 1) {
  1305. // removing '//' should disable links to external url like //aaa or http//)
  1306. $stringtoclean = preg_replace(array('/^[a-z]*\/\/+/i'), '', $stringtoclean);
  1307. }
  1308. return $stringtoclean;
  1309. }
  1310. /**
  1311. * Clean a string to use it as an Email.
  1312. *
  1313. * @param string $stringtoclean String to clean. Example 'abc@mycompany.com <My name>'
  1314. * @return string Escaped string.
  1315. */
  1316. function dol_sanitizeEmail($stringtoclean)
  1317. {
  1318. do {
  1319. $oldstringtoclean = $stringtoclean;
  1320. $stringtoclean = str_ireplace(array('"', ':', '[', ']',"\n", "\r", '\\', '\/'), '', $stringtoclean);
  1321. } while ($oldstringtoclean != $stringtoclean);
  1322. return $stringtoclean;
  1323. }
  1324. /**
  1325. * Clean a string from all accent characters to be used as ref, login or by dol_sanitizeFileName
  1326. *
  1327. * @param string $str String to clean
  1328. * @return string Cleaned string
  1329. *
  1330. * @see dol_sanitizeFilename(), dol_string_nospecial()
  1331. */
  1332. function dol_string_unaccent($str)
  1333. {
  1334. global $conf;
  1335. if (is_null($str)) {
  1336. return '';
  1337. }
  1338. if (utf8_check($str)) {
  1339. if (extension_loaded('intl') && getDolGlobalString('MAIN_UNACCENT_USE_TRANSLITERATOR')) {
  1340. $transliterator = Transliterator::createFromRules(':: Any-Latin; :: Latin-ASCII; :: NFD; :: [:Nonspacing Mark:] Remove; :: NFC;', Transliterator::FORWARD);
  1341. return $transliterator->transliterate($str);
  1342. }
  1343. // See http://www.utf8-chartable.de/
  1344. $string = rawurlencode($str);
  1345. $replacements = array(
  1346. '%C3%80' => 'A', '%C3%81' => 'A', '%C3%82' => 'A', '%C3%83' => 'A', '%C3%84' => 'A', '%C3%85' => 'A',
  1347. '%C3%87' => 'C',
  1348. '%C3%88' => 'E', '%C3%89' => 'E', '%C3%8A' => 'E', '%C3%8B' => 'E',
  1349. '%C3%8C' => 'I', '%C3%8D' => 'I', '%C3%8E' => 'I', '%C3%8F' => 'I',
  1350. '%C3%91' => 'N',
  1351. '%C3%92' => 'O', '%C3%93' => 'O', '%C3%94' => 'O', '%C3%95' => 'O', '%C3%96' => 'O',
  1352. '%C5%A0' => 'S',
  1353. '%C3%99' => 'U', '%C3%9A' => 'U', '%C3%9B' => 'U', '%C3%9C' => 'U',
  1354. '%C3%9D' => 'Y', '%C5%B8' => 'y',
  1355. '%C3%A0' => 'a', '%C3%A1' => 'a', '%C3%A2' => 'a', '%C3%A3' => 'a', '%C3%A4' => 'a', '%C3%A5' => 'a',
  1356. '%C3%A7' => 'c',
  1357. '%C3%A8' => 'e', '%C3%A9' => 'e', '%C3%AA' => 'e', '%C3%AB' => 'e',
  1358. '%C3%AC' => 'i', '%C3%AD' => 'i', '%C3%AE' => 'i', '%C3%AF' => 'i',
  1359. '%C3%B1' => 'n',
  1360. '%C3%B2' => 'o', '%C3%B3' => 'o', '%C3%B4' => 'o', '%C3%B5' => 'o', '%C3%B6' => 'o',
  1361. '%C5%A1' => 's',
  1362. '%C3%B9' => 'u', '%C3%BA' => 'u', '%C3%BB' => 'u', '%C3%BC' => 'u',
  1363. '%C3%BD' => 'y', '%C3%BF' => 'y'
  1364. );
  1365. $string = strtr($string, $replacements);
  1366. return rawurldecode($string);
  1367. } else {
  1368. // See http://www.ascii-code.com/
  1369. $string = strtr(
  1370. $str,
  1371. "\xC0\xC1\xC2\xC3\xC4\xC5\xC7
  1372. \xC8\xC9\xCA\xCB\xCC\xCD\xCE\xCF\xD0\xD1
  1373. \xD2\xD3\xD4\xD5\xD8\xD9\xDA\xDB\xDD
  1374. \xE0\xE1\xE2\xE3\xE4\xE5\xE7\xE8\xE9\xEA\xEB
  1375. \xEC\xED\xEE\xEF\xF0\xF1\xF2\xF3\xF4\xF5\xF8
  1376. \xF9\xFA\xFB\xFC\xFD\xFF",
  1377. "AAAAAAC
  1378. EEEEIIIIDN
  1379. OOOOOUUUY
  1380. aaaaaaceeee
  1381. iiiidnooooo
  1382. uuuuyy"
  1383. );
  1384. $string = strtr($string, array("\xC4"=>"Ae", "\xC6"=>"AE", "\xD6"=>"Oe", "\xDC"=>"Ue", "\xDE"=>"TH", "\xDF"=>"ss", "\xE4"=>"ae", "\xE6"=>"ae", "\xF6"=>"oe", "\xFC"=>"ue", "\xFE"=>"th"));
  1385. return $string;
  1386. }
  1387. }
  1388. /**
  1389. * Clean a string from all punctuation characters to use it as a ref or login.
  1390. * This is a more complete function than dol_sanitizeFileName().
  1391. *
  1392. * @param string $str String to clean
  1393. * @param string $newstr String to replace forbidden chars with
  1394. * @param array|string $badcharstoreplace Array of forbidden characters to replace. Use '' to keep default list.
  1395. * @param array|string $badcharstoremove Array of forbidden characters to remove. Use '' to keep default list.
  1396. * @param int $keepspaces 1=Do not treat space as a special char to replace or remove
  1397. * @return string Cleaned string
  1398. *
  1399. * @see dol_sanitizeFilename(), dol_string_unaccent(), dol_string_nounprintableascii()
  1400. */
  1401. function dol_string_nospecial($str, $newstr = '_', $badcharstoreplace = '', $badcharstoremove = '', $keepspaces = 0)
  1402. {
  1403. $forbidden_chars_to_replace = array("'", "/", "\\", ":", "*", "?", "\"", "<", ">", "|", "[", "]", ",", ";", "=", '°', '$', ';'); // more complete than dol_sanitizeFileName
  1404. if (empty($keepspaces)) {
  1405. $forbidden_chars_to_replace[] = " ";
  1406. }
  1407. $forbidden_chars_to_remove = array();
  1408. //$forbidden_chars_to_remove=array("(",")");
  1409. if (is_array($badcharstoreplace)) {
  1410. $forbidden_chars_to_replace = $badcharstoreplace;
  1411. }
  1412. if (is_array($badcharstoremove)) {
  1413. $forbidden_chars_to_remove = $badcharstoremove;
  1414. }
  1415. return str_replace($forbidden_chars_to_replace, $newstr, str_replace($forbidden_chars_to_remove, "", $str));
  1416. }
  1417. /**
  1418. * Clean a string from all non printable ASCII chars (0x00-0x1F and 0x7F). It can also removes also Tab-CR-LF. UTF8 chars remains.
  1419. * This can be used to sanitize a string and view its real content. Some hacks try to obfuscate attacks by inserting non printable chars.
  1420. * Note, for information: UTF8 on 1 byte are: \x00-\7F
  1421. * 2 bytes are: byte 1 \xc0-\xdf, byte 2 = \x80-\xbf
  1422. * 3 bytes are: byte 1 \xe0-\xef, byte 2 = \x80-\xbf, byte 3 = \x80-\xbf
  1423. * 4 bytes are: byte 1 \xf0-\xf7, byte 2 = \x80-\xbf, byte 3 = \x80-\xbf, byte 4 = \x80-\xbf
  1424. * @param string $str String to clean
  1425. * @param int $removetabcrlf Remove also CR-LF
  1426. * @return string Cleaned string
  1427. *
  1428. * @see dol_sanitizeFilename(), dol_string_unaccent(), dol_string_nospecial()
  1429. */
  1430. function dol_string_nounprintableascii($str, $removetabcrlf = 1)
  1431. {
  1432. if ($removetabcrlf) {
  1433. return preg_replace('/[\x00-\x1F\x7F]/u', '', $str); // /u operator makes UTF8 valid characters being ignored so are not included into the replace
  1434. } else {
  1435. return preg_replace('/[\x00-\x08\x11-\x12\x14-\x1F\x7F]/u', '', $str); // /u operator should make UTF8 valid characters being ignored so are not included into the replace
  1436. }
  1437. }
  1438. /**
  1439. * Returns text escaped for inclusion into javascript code
  1440. *
  1441. * @param string $stringtoescape String to escape
  1442. * @param int $mode 0=Escape also ' and " into ', 1=Escape ' but not " for usage into 'string', 2=Escape " but not ' for usage into "string", 3=Escape ' and " with \
  1443. * @param int $noescapebackslashn 0=Escape also \n. 1=Do not escape \n.
  1444. * @return string Escaped string. Both ' and " are escaped into ' if they are escaped.
  1445. */
  1446. function dol_escape_js($stringtoescape, $mode = 0, $noescapebackslashn = 0)
  1447. {
  1448. if (is_null($stringtoescape)) {
  1449. return '';
  1450. }
  1451. // escape quotes and backslashes, newlines, etc.
  1452. $substitjs = array("&#039;"=>"\\'", "\r"=>'\\r');
  1453. //$substitjs['</']='<\/'; // We removed this. Should be useless.
  1454. if (empty($noescapebackslashn)) {
  1455. $substitjs["\n"] = '\\n';
  1456. $substitjs['\\'] = '\\\\';
  1457. }
  1458. if (empty($mode)) {
  1459. $substitjs["'"] = "\\'";
  1460. $substitjs['"'] = "\\'";
  1461. } elseif ($mode == 1) {
  1462. $substitjs["'"] = "\\'";
  1463. } elseif ($mode == 2) {
  1464. $substitjs['"'] = '\\"';
  1465. } elseif ($mode == 3) {
  1466. $substitjs["'"] = "\\'";
  1467. $substitjs['"'] = "\\\"";
  1468. }
  1469. return strtr($stringtoescape, $substitjs);
  1470. }
  1471. /**
  1472. * Returns text escaped for inclusion into javascript code
  1473. *
  1474. * @param string $stringtoescape String to escape
  1475. * @return string Escaped string for json content.
  1476. */
  1477. function dol_escape_json($stringtoescape)
  1478. {
  1479. return str_replace('"', '\"', $stringtoescape);
  1480. }
  1481. /**
  1482. * Returns text escaped for inclusion into a php string, build with double quotes " or '
  1483. *
  1484. * @param string $stringtoescape String to escape
  1485. * @param string $stringforquotes 2=String for doublequotes, 1=String for simple quotes
  1486. * @return string Escaped string for json content.
  1487. */
  1488. function dol_escape_php($stringtoescape, $stringforquotes = 2)
  1489. {
  1490. if (is_null($stringtoescape)) {
  1491. return '';
  1492. }
  1493. if ($stringforquotes == 2) {
  1494. return str_replace('"', "'", $stringtoescape);
  1495. }
  1496. if ($stringforquotes == 1) {
  1497. return str_replace("'", "\'", str_replace('"', "'", $stringtoescape));
  1498. }
  1499. return 'Bad parameter for stringforquotes in dol_escape_php';
  1500. }
  1501. /**
  1502. * Return a string label ready to be output on HTML content
  1503. * To use text inside an attribute, use can simply only dol_escape_htmltag()
  1504. *
  1505. * @param string $s String to print
  1506. * @return string String ready for HTML output
  1507. */
  1508. function dolPrintLabel($s)
  1509. {
  1510. return dol_escape_htmltag(dol_htmlentitiesbr($s));
  1511. }
  1512. /**
  1513. * Return a string ready to be output on HTML page
  1514. * To use text inside an attribute, you can simply use dol_escape_htmltag()
  1515. *
  1516. * @param string $s String to print
  1517. * @param int $allowiframe Allow iframe tags
  1518. * @return string String ready for HTML output
  1519. */
  1520. function dolPrintHTML($s, $allowiframe = 0)
  1521. {
  1522. return dol_escape_htmltag(dol_htmlwithnojs(dol_string_onlythesehtmltags(dol_htmlentitiesbr($s), 1, 1, 1, $allowiframe)), 1, 1, 'common', 0, 1);
  1523. }
  1524. /**
  1525. * Return a string ready to be output on an HTML attribute (alt, title, data-html, ...)
  1526. *
  1527. * @param string $s String to print
  1528. * @return string String ready for HTML output
  1529. */
  1530. function dolPrintHTMLForAttribute($s)
  1531. {
  1532. // The dol_htmlentitiesbr will convert simple text into html
  1533. // The dol_escape_htmltag will escape html chars.
  1534. return dol_escape_htmltag(dol_string_onlythesehtmltags(dol_htmlentitiesbr($s), 1, 0, 0, 0, array('br', 'b', 'font', 'span')), 1, -1, '', 0, 1);
  1535. }
  1536. /**
  1537. * Return a string ready to be output on input textarea
  1538. * To use text inside an attribute, use can use only dol_escape_htmltag()
  1539. *
  1540. * @param string $s String to print
  1541. * @param int $allowiframe Allow iframe tags
  1542. * @return string String ready for HTML output into a textarea
  1543. */
  1544. function dolPrintHTMLForTextArea($s, $allowiframe = 0)
  1545. {
  1546. return dol_escape_htmltag(dol_htmlwithnojs(dol_string_onlythesehtmltags(dol_htmlentitiesbr($s), 1, 1, 1, $allowiframe)), 1, 1, '', 0, 1);
  1547. }
  1548. /**
  1549. * Return a string ready to be output on an HTML attribute (alt, title, ...)
  1550. *
  1551. * @param string $s String to print
  1552. * @return string String ready for HTML output
  1553. */
  1554. function dolPrintPassword($s)
  1555. {
  1556. return htmlspecialchars($s, ENT_COMPAT, 'UTF-8');
  1557. }
  1558. /**
  1559. * Returns text escaped for inclusion in HTML alt or title or value tags, or into values of HTML input fields.
  1560. * When we need to output strings on pages, we should use:
  1561. * - dolPrintHTML... that is dol_escape_htmltag(dol_htmlwithnojs(dol_string_onlythesehtmltags(dol_htmlentitiesbr(), 1, 1, 1)), 1, 1) for notes or descriptions into textarea, add 'common' if into a html content
  1562. * - dolPrintLabel... that is dol_escape_htmltag(dol_htmlentitiesbr()) for simple labels.
  1563. * - dolPrintPassword that is abelhtmlspecialchars( , ENT_COMPAT, 'UTF-8') for passwords.
  1564. *
  1565. * @param string $stringtoescape String to escape
  1566. * @param int $keepb 1=Keep b tags, 0=remove them completely
  1567. * @param int $keepn 1=Preserve \r\n strings, 0=Replace them with escaped value, -1=Remove them. Set to 1 when escaping for a <textarea>.
  1568. * @param string $noescapetags '' or 'common' or list of tags to not escape. TODO Does not works yet when there is attributes into tag.
  1569. * @param int $escapeonlyhtmltags 1=Escape only html tags, not the special chars like accents.
  1570. * @param int $cleanalsojavascript Clean also javascript. @TODO switch this option to 1 by default.
  1571. * @return string Escaped string
  1572. * @see dol_string_nohtmltag(), dol_string_onlythesehtmltags(), dol_string_nospecial(), dol_string_unaccent(), dol_htmlentitiesbr()
  1573. */
  1574. function dol_escape_htmltag($stringtoescape, $keepb = 0, $keepn = 0, $noescapetags = '', $escapeonlyhtmltags = 0, $cleanalsojavascript = 0)
  1575. {
  1576. if ($noescapetags == 'common') {
  1577. $noescapetags = 'html,body,a,b,em,hr,i,u,ul,li,br,div,img,font,p,span,strong,table,tr,td,th,tbody,h1,h2,h3,h4,h5,h6,h7,h8,h9';
  1578. // Add also html5 tags
  1579. $noescapetags .= ',header,footer,nav,section,menu,menuitem';
  1580. }
  1581. if ($cleanalsojavascript) {
  1582. $stringtoescape = dol_string_onlythesehtmltags($stringtoescape, 0, 0, $cleanalsojavascript, 0, array(), 0);
  1583. }
  1584. // escape quotes and backslashes, newlines, etc.
  1585. if ($escapeonlyhtmltags) {
  1586. $tmp = htmlspecialchars_decode((string) $stringtoescape, ENT_COMPAT);
  1587. } else {
  1588. $tmp = html_entity_decode((string) $stringtoescape, ENT_COMPAT, 'UTF-8');
  1589. }
  1590. if (!$keepb) {
  1591. $tmp = strtr($tmp, array("<b>"=>'', '</b>'=>'', '<strong>'=>'', '</strong>'=>''));
  1592. }
  1593. if (!$keepn) {
  1594. $tmp = strtr($tmp, array("\r"=>'\\r', "\n"=>'\\n'));
  1595. } elseif ($keepn == -1) {
  1596. $tmp = strtr($tmp, array("\r"=>'', "\n"=>''));
  1597. }
  1598. if ($escapeonlyhtmltags) {
  1599. return htmlspecialchars($tmp, ENT_COMPAT, 'UTF-8');
  1600. } else {
  1601. // Escape tags to keep
  1602. $tmparrayoftags = array();
  1603. if ($noescapetags) {
  1604. $tmparrayoftags = explode(',', $noescapetags);
  1605. }
  1606. if (count($tmparrayoftags)) {
  1607. // TODO Does not works yet when there is attributes into tag
  1608. foreach ($tmparrayoftags as $tagtoreplace) {
  1609. $tmp = str_ireplace('<'.$tagtoreplace.'>', '__BEGINTAGTOREPLACE'.$tagtoreplace.'__', $tmp);
  1610. $tmp = str_ireplace('</'.$tagtoreplace.'>', '__ENDTAGTOREPLACE'.$tagtoreplace.'__', $tmp);
  1611. $tmp = str_ireplace('<'.$tagtoreplace.' />', '__BEGINENDTAGTOREPLACE'.$tagtoreplace.'__', $tmp);
  1612. }
  1613. }
  1614. $result = htmlentities($tmp, ENT_COMPAT, 'UTF-8');
  1615. if (count($tmparrayoftags)) {
  1616. foreach ($tmparrayoftags as $tagtoreplace) {
  1617. $result = str_ireplace('__BEGINTAGTOREPLACE'.$tagtoreplace.'__', '<'.$tagtoreplace.'>', $result);
  1618. $result = str_ireplace('__ENDTAGTOREPLACE'.$tagtoreplace.'__', '</'.$tagtoreplace.'>', $result);
  1619. $result = str_ireplace('__BEGINENDTAGTOREPLACE'.$tagtoreplace.'__', '<'.$tagtoreplace.' />', $result);
  1620. }
  1621. }
  1622. return $result;
  1623. }
  1624. }
  1625. /**
  1626. * Convert a string to lower. Never use strtolower because it does not works with UTF8 strings.
  1627. *
  1628. * @param string $string String to encode
  1629. * @param string $encoding Character set encoding
  1630. * @return string String converted
  1631. */
  1632. function dol_strtolower($string, $encoding = "UTF-8")
  1633. {
  1634. if (function_exists('mb_strtolower')) {
  1635. return mb_strtolower($string, $encoding);
  1636. } else {
  1637. return strtolower($string);
  1638. }
  1639. }
  1640. /**
  1641. * Convert a string to upper. Never use strtolower because it does not works with UTF8 strings.
  1642. *
  1643. * @param string $string String to encode
  1644. * @param string $encoding Character set encoding
  1645. * @return string String converted
  1646. * @see dol_ucfirst(), dol_ucwords()
  1647. */
  1648. function dol_strtoupper($string, $encoding = "UTF-8")
  1649. {
  1650. if (function_exists('mb_strtoupper')) {
  1651. return mb_strtoupper($string, $encoding);
  1652. } else {
  1653. return strtoupper($string);
  1654. }
  1655. }
  1656. /**
  1657. * Convert first character of the first word of a string to upper. Never use ucfirst because it does not works with UTF8 strings.
  1658. *
  1659. * @param string $string String to encode
  1660. * @param string $encoding Character set encodign
  1661. * @return string String converted
  1662. * @see dol_strtoupper(), dol_ucwords()
  1663. */
  1664. function dol_ucfirst($string, $encoding = "UTF-8")
  1665. {
  1666. if (function_exists('mb_substr')) {
  1667. return mb_strtoupper(mb_substr($string, 0, 1, $encoding), $encoding).mb_substr($string, 1, null, $encoding);
  1668. } else {
  1669. return ucfirst($string);
  1670. }
  1671. }
  1672. /**
  1673. * Convert first character of all the words of a string to upper.
  1674. *
  1675. * @param string $string String to encode
  1676. * @param string $encoding Character set encodign
  1677. * @return string String converted
  1678. * @see dol_strtoupper(), dol_ucfirst()
  1679. */
  1680. function dol_ucwords($string, $encoding = "UTF-8")
  1681. {
  1682. if (function_exists('mb_convert_case')) {
  1683. return mb_convert_case($string, MB_CASE_TITLE, $encoding);
  1684. } else {
  1685. return ucwords($string);
  1686. }
  1687. }
  1688. /**
  1689. * Write log message into outputs. Possible outputs can be:
  1690. * SYSLOG_HANDLERS = ["mod_syslog_file"] file name is then defined by SYSLOG_FILE
  1691. * SYSLOG_HANDLERS = ["mod_syslog_syslog"] facility is then defined by SYSLOG_FACILITY
  1692. * Warning, syslog functions are bugged on Windows, generating memory protection faults. To solve
  1693. * this, use logging to files instead of syslog (see setup of module).
  1694. * Note: If constant 'SYSLOG_FILE_NO_ERROR' defined, we never output any error message when writing to log fails.
  1695. * Note: You can get log message into html sources by adding parameter &logtohtml=1 (constant MAIN_LOGTOHTML must be set)
  1696. * This function works only if syslog module is enabled.
  1697. * This must not use any call to other function calling dol_syslog (avoid infinite loop).
  1698. *
  1699. * @param string $message Line to log. ''=Show nothing
  1700. * @param int $level Log level
  1701. * On Windows LOG_ERR=4, LOG_WARNING=5, LOG_NOTICE=LOG_INFO=6, LOG_DEBUG=6 si define_syslog_variables ou PHP 5.3+, 7 si dolibarr
  1702. * On Linux LOG_ERR=3, LOG_WARNING=4, LOG_NOTICE=5, LOG_INFO=6, LOG_DEBUG=7
  1703. * @param int $ident 1=Increase ident of 1 (after log), -1=Decrease ident of 1 (before log)
  1704. * @param string $suffixinfilename When output is a file, append this suffix into default log filename. Example '_stripe', '_mail'
  1705. * @param string $restricttologhandler Force output of log only to this log handler
  1706. * @param array|null $logcontext If defined, an array with extra informations (can be used by some log handlers)
  1707. * @return void
  1708. */
  1709. function dol_syslog($message, $level = LOG_INFO, $ident = 0, $suffixinfilename = '', $restricttologhandler = '', $logcontext = null)
  1710. {
  1711. global $conf, $user, $debugbar;
  1712. // If syslog module enabled
  1713. if (!isModEnabled('syslog')) {
  1714. return;
  1715. }
  1716. // Check if we are into execution of code of a website
  1717. if (defined('USEEXTERNALSERVER') && !defined('USEDOLIBARRSERVER') && !defined('USEDOLIBARREDITOR')) {
  1718. global $website, $websitekey;
  1719. if (is_object($website) && !empty($website->ref)) {
  1720. $suffixinfilename .= '_website_'.$website->ref;
  1721. } elseif (!empty($websitekey)) {
  1722. $suffixinfilename .= '_website_'.$websitekey;
  1723. }
  1724. }
  1725. // Check if we have a forced suffix
  1726. if (defined('USESUFFIXINLOG')) {
  1727. $suffixinfilename .= constant('USESUFFIXINLOG');
  1728. }
  1729. if ($ident < 0) {
  1730. foreach ($conf->loghandlers as $loghandlerinstance) {
  1731. $loghandlerinstance->setIdent($ident);
  1732. }
  1733. }
  1734. if (!empty($message)) {
  1735. // Test log level
  1736. $logLevels = array(LOG_EMERG=>'EMERG', LOG_ALERT=>'ALERT', LOG_CRIT=>'CRITICAL', LOG_ERR=>'ERR', LOG_WARNING=>'WARN', LOG_NOTICE=>'NOTICE', LOG_INFO=>'INFO', LOG_DEBUG=>'DEBUG');
  1737. if (!array_key_exists($level, $logLevels)) {
  1738. throw new Exception('Incorrect log level');
  1739. }
  1740. if ($level > getDolGlobalInt('SYSLOG_LEVEL')) {
  1741. return;
  1742. }
  1743. if (!getDolGlobalString('MAIN_SHOW_PASSWORD_INTO_LOG')) {
  1744. $message = preg_replace('/password=\'[^\']*\'/', 'password=\'hidden\'', $message); // protection to avoid to have value of password in log
  1745. }
  1746. // If adding log inside HTML page is required
  1747. if ((!empty($_REQUEST['logtohtml']) && getDolGlobalString('MAIN_ENABLE_LOG_TO_HTML'))
  1748. || (is_object($user) && $user->hasRight('debugbar', 'read') && is_object($debugbar))) {
  1749. $conf->logbuffer[] = dol_print_date(time(), "%Y-%m-%d %H:%M:%S")." ".$logLevels[$level]." ".$message;
  1750. }
  1751. //TODO: Remove this. MAIN_ENABLE_LOG_INLINE_HTML should be deprecated and use a log handler dedicated to HTML output
  1752. // If html log tag enabled and url parameter log defined, we show output log on HTML comments
  1753. if (getDolGlobalString('MAIN_ENABLE_LOG_INLINE_HTML') && !empty($_GET["log"])) {
  1754. print "\n\n<!-- Log start\n";
  1755. print dol_escape_htmltag($message)."\n";
  1756. print "Log end -->\n";
  1757. }
  1758. $data = array(
  1759. 'message' => $message,
  1760. 'script' => (isset($_SERVER['PHP_SELF']) ? basename($_SERVER['PHP_SELF'], '.php') : false),
  1761. 'level' => $level,
  1762. 'user' => ((is_object($user) && $user->id) ? $user->login : false),
  1763. 'ip' => false
  1764. );
  1765. $remoteip = getUserRemoteIP(); // Get ip when page run on a web server
  1766. if (!empty($remoteip)) {
  1767. $data['ip'] = $remoteip;
  1768. // This is when server run behind a reverse proxy
  1769. if (!empty($_SERVER['HTTP_X_FORWARDED_FOR']) && $_SERVER['HTTP_X_FORWARDED_FOR'] != $remoteip) {
  1770. $data['ip'] = $_SERVER['HTTP_X_FORWARDED_FOR'].' -> '.$data['ip'];
  1771. } elseif (!empty($_SERVER['HTTP_CLIENT_IP']) && $_SERVER['HTTP_CLIENT_IP'] != $remoteip) {
  1772. $data['ip'] = $_SERVER['HTTP_CLIENT_IP'].' -> '.$data['ip'];
  1773. }
  1774. } elseif (!empty($_SERVER['SERVER_ADDR'])) {
  1775. // This is when PHP session is ran inside a web server but not inside a client request (example: init code of apache)
  1776. $data['ip'] = $_SERVER['SERVER_ADDR'];
  1777. } elseif (!empty($_SERVER['COMPUTERNAME'])) {
  1778. // This is when PHP session is ran outside a web server, like from Windows command line (Not always defined, but useful if OS defined it).
  1779. $data['ip'] = $_SERVER['COMPUTERNAME'].(empty($_SERVER['USERNAME']) ? '' : '@'.$_SERVER['USERNAME']);
  1780. } elseif (!empty($_SERVER['LOGNAME'])) {
  1781. // This is when PHP session is ran outside a web server, like from Linux command line (Not always defined, but usefull if OS defined it).
  1782. $data['ip'] = '???@'.$_SERVER['LOGNAME'];
  1783. }
  1784. // Loop on each log handler and send output
  1785. foreach ($conf->loghandlers as $loghandlerinstance) {
  1786. if ($restricttologhandler && $loghandlerinstance->code != $restricttologhandler) {
  1787. continue;
  1788. }
  1789. $loghandlerinstance->export($data, $suffixinfilename);
  1790. }
  1791. unset($data);
  1792. }
  1793. if ($ident > 0) {
  1794. foreach ($conf->loghandlers as $loghandlerinstance) {
  1795. $loghandlerinstance->setIdent($ident);
  1796. }
  1797. }
  1798. }
  1799. /**
  1800. * Return HTML code to output a button to open a dialog popup box.
  1801. * Such buttons must be included inside a HTML form.
  1802. *
  1803. * @param string $name A name for the html component
  1804. * @param string $label Label shown in Popup title top bar
  1805. * @param string $buttonstring button string (HTML text we can click on)
  1806. * @param string $url Relative Url to open. For example '/project/card.php'
  1807. * @param string $disabled Disabled text
  1808. * @param string $morecss More CSS
  1809. * @param string $jsonopen Some JS code to execute on click/open of popup
  1810. * @param string $backtopagejsfields The back to page must be managed using javascript instead of a redirect.
  1811. * Value is 'keyforpopupid:Name_of_html_component_to_set_with id,Name_of_html_component_to_set_with_label'
  1812. * @param string $accesskey A key to use shortcut
  1813. * @return string HTML component with button
  1814. */
  1815. function dolButtonToOpenUrlInDialogPopup($name, $label, $buttonstring, $url, $disabled = '', $morecss = 'classlink button bordertransp', $jsonopen = '', $backtopagejsfields = '', $accesskey = '')
  1816. {
  1817. global $conf;
  1818. if (strpos($url, '?') > 0) {
  1819. $url .= '&dol_hide_topmenu=1&dol_hide_leftmenu=1&dol_openinpopup='.urlencode($name);
  1820. } else {
  1821. $url .= '?dol_hide_topmenu=1&dol_hide_leftmenu=1&dol_openinpopup='.urlencode($name);
  1822. }
  1823. $out = '';
  1824. $backtopagejsfieldsid = '';
  1825. $backtopagejsfieldslabel = '';
  1826. if ($backtopagejsfields) {
  1827. $tmpbacktopagejsfields = explode(':', $backtopagejsfields);
  1828. if (empty($tmpbacktopagejsfields[1])) { // If the part 'keyforpopupid:' is missing, we add $name for it.
  1829. $backtopagejsfields = $name.":".$backtopagejsfields;
  1830. $tmp2backtopagejsfields = explode(',', $tmpbacktopagejsfields[0]);
  1831. } else {
  1832. $tmp2backtopagejsfields = explode(',', $tmpbacktopagejsfields[1]);
  1833. }
  1834. $backtopagejsfieldsid = empty($tmp2backtopagejsfields[0]) ? '' : $tmp2backtopagejsfields[0];
  1835. $backtopagejsfieldslabel = empty($tmp2backtopagejsfields[1]) ? '' : $tmp2backtopagejsfields[1];
  1836. $url .= '&backtopagejsfields='.urlencode($backtopagejsfields);
  1837. }
  1838. //print '<input type="submit" class="button bordertransp"'.$disabled.' value="'.dol_escape_htmltag($langs->trans("MediaFiles")).'" name="file_manager">';
  1839. $out .= '<!-- a link for button to open url into a dialog popup with backtopagejsfields = '.$backtopagejsfields.' -->';
  1840. $out .= '<a '.($accesskey ? ' accesskey="'.$accesskey.'"' : '').' class="cursorpointer reposition button_'.$name.($morecss ? ' '.$morecss : '').'"'.$disabled.' title="'.dol_escape_htmltag($label).'"';
  1841. if (empty($conf->use_javascript_ajax)) {
  1842. $out .= ' href="'.DOL_URL_ROOT.$url.'" target="_blank"';
  1843. } elseif ($jsonopen) {
  1844. $out .= ' href="#" onclick="'.$jsonopen.'"';
  1845. } else {
  1846. $out .= ' href="#"';
  1847. }
  1848. $out .= '>'.$buttonstring.'</a>';
  1849. if (!empty($conf->use_javascript_ajax)) {
  1850. // Add code to open url using the popup. Add also hidden field to retreive the returned variables
  1851. $out .= '<!-- code to open popup and variables to retreive returned variables -->';
  1852. $out .= '<div id="idfordialog'.$name.'" class="hidden">div for dialog</div>';
  1853. $out .= '<div id="varforreturndialogid'.$name.'" class="hidden">div for returned id</div>';
  1854. $out .= '<div id="varforreturndialoglabel'.$name.'" class="hidden">div for returned label</div>';
  1855. $out .= '<!-- Add js code to open dialog popup on dialog -->';
  1856. $out .= '<script nonce="'.getNonce().'" type="text/javascript">
  1857. jQuery(document).ready(function () {
  1858. jQuery(".button_'.$name.'").click(function () {
  1859. console.log(\'Open popup with jQuery(...).dialog() on URL '.dol_escape_js(DOL_URL_ROOT.$url).'\');
  1860. var $tmpdialog = $(\'#idfordialog'.$name.'\');
  1861. $tmpdialog.html(\'<iframe class="iframedialog" id="iframedialog'.$name.'" style="border: 0px;" src="'.DOL_URL_ROOT.$url.'" width="100%" height="98%"></iframe>\');
  1862. $tmpdialog.dialog({
  1863. autoOpen: false,
  1864. modal: true,
  1865. height: (window.innerHeight - 150),
  1866. width: \'80%\',
  1867. title: \''.dol_escape_js($label).'\',
  1868. open: function (event, ui) {
  1869. console.log("open popup name='.$name.', backtopagejsfields='.$backtopagejsfields.'");
  1870. },
  1871. close: function (event, ui) {
  1872. var returnedid = jQuery("#varforreturndialogid'.$name.'").text();
  1873. var returnedlabel = jQuery("#varforreturndialoglabel'.$name.'").text();
  1874. console.log("popup has been closed. returnedid (js var defined into parent page)="+returnedid+" returnedlabel="+returnedlabel);
  1875. if (returnedid != "" && returnedid != "div for returned id") {
  1876. jQuery("#'.(empty($backtopagejsfieldsid) ? "none" : $backtopagejsfieldsid).'").val(returnedid);
  1877. }
  1878. if (returnedlabel != "" && returnedlabel != "div for returned label") {
  1879. jQuery("#'.(empty($backtopagejsfieldslabel) ? "none" : $backtopagejsfieldslabel).'").val(returnedlabel);
  1880. }
  1881. }
  1882. });
  1883. $tmpdialog.dialog(\'open\');
  1884. return false;
  1885. });
  1886. });
  1887. </script>';
  1888. }
  1889. return $out;
  1890. }
  1891. /**
  1892. * Show tab header of a card
  1893. *
  1894. * @param array $links Array of tabs (0=>url, 1=>label, 2=>code, 3=>not used, 4=>text after link, 5=>morecssonlink). Currently initialized by calling a function xxx_admin_prepare_head. Note that label into $links[$i][1] must be already HTML escaped.
  1895. * @param string $active Active tab name (document', 'info', 'ldap', ....)
  1896. * @param string $title Title
  1897. * @param int $notab -1 or 0=Add tab header, 1=no tab header (if you set this to 1, using print dol_get_fiche_end() to close tab is not required), -2=Add tab header with no sepaaration under tab (to start a tab just after), -3=Add tab header but no footer separation
  1898. * @param string $picto Add a picto on tab title
  1899. * @param int $pictoisfullpath If 1, image path is a full path. If you set this to 1, you can use url returned by dol_buildpath('/mymodyle/img/myimg.png',1) for $picto.
  1900. * @param string $morehtmlright Add more html content on right of tabs title
  1901. * @param string $morecss More Css
  1902. * @param int $limittoshow Limit number of tabs to show. Use 0 to use automatic default value.
  1903. * @param string $moretabssuffix A suffix to use when you have several dol_get_fiche_head() in same page
  1904. * @return void
  1905. * @deprecated Use print dol_get_fiche_head() instead
  1906. */
  1907. function dol_fiche_head($links = array(), $active = '0', $title = '', $notab = 0, $picto = '', $pictoisfullpath = 0, $morehtmlright = '', $morecss = '', $limittoshow = 0, $moretabssuffix = '')
  1908. {
  1909. print dol_get_fiche_head($links, $active, $title, $notab, $picto, $pictoisfullpath, $morehtmlright, $morecss, $limittoshow, $moretabssuffix);
  1910. }
  1911. /**
  1912. * Show tabs of a record
  1913. *
  1914. * @param array $links Array of tabs (0=>url, 1=>label, 2=>code, 3=>not used, 4=>text after link, 5=>morecssonlink). Currently initialized by calling a function xxx_admin_prepare_head. Note that label into $links[$i][1] must be already HTML escaped.
  1915. * @param string $active Active tab name
  1916. * @param string $title Title
  1917. * @param int $notab -1 or 0=Add tab header, 1=no tab header (if you set this to 1, using print dol_get_fiche_end() to close tab is not required), -2=Add tab header with no seaparation under tab (to start a tab just after), -3=-2+'noborderbottom'
  1918. * @param string $picto Add a picto on tab title
  1919. * @param int $pictoisfullpath If 1, image path is a full path. If you set this to 1, you can use url returned by dol_buildpath('/mymodyle/img/myimg.png',1) for $picto.
  1920. * @param string $morehtmlright Add more html content on right of tabs title
  1921. * @param string $morecss More CSS on the link <a>
  1922. * @param int $limittoshow Limit number of tabs to show. Use 0 to use automatic default value.
  1923. * @param string $moretabssuffix A suffix to use when you have several dol_get_fiche_head() in same page
  1924. * @param int $dragdropfile 0 (default) or 1. 1 enable a drop zone for file to be upload, 0 disable it
  1925. * @return string
  1926. */
  1927. function dol_get_fiche_head($links = array(), $active = '', $title = '', $notab = 0, $picto = '', $pictoisfullpath = 0, $morehtmlright = '', $morecss = '', $limittoshow = 0, $moretabssuffix = '', $dragdropfile = 0)
  1928. {
  1929. global $conf, $langs, $hookmanager;
  1930. // Show title
  1931. $showtitle = 1;
  1932. if (!empty($conf->dol_optimize_smallscreen)) {
  1933. $showtitle = 0;
  1934. }
  1935. $out = "\n".'<!-- dol_fiche_head - dol_get_fiche_head -->';
  1936. if ((!empty($title) && $showtitle) || $morehtmlright || !empty($links)) {
  1937. $out .= '<div class="tabs'.($picto ? '' : ' nopaddingleft').'" data-role="controlgroup" data-type="horizontal">'."\n";
  1938. }
  1939. // Show right part
  1940. if ($morehtmlright) {
  1941. $out .= '<div class="inline-block floatright tabsElem">'.$morehtmlright.'</div>'; // Output right area first so when space is missing, text is in front of tabs and not under.
  1942. }
  1943. // Show title
  1944. if (!empty($title) && $showtitle && !getDolGlobalString('MAIN_OPTIMIZEFORTEXTBROWSER')) {
  1945. $limittitle = 30;
  1946. $out .= '<a class="tabTitle">';
  1947. if ($picto) {
  1948. $noprefix = $pictoisfullpath;
  1949. if (strpos($picto, 'fontawesome_') !== false) {
  1950. $noprefix = 1;
  1951. }
  1952. $out .= img_picto($title, ($noprefix ? '' : 'object_').$picto, '', $pictoisfullpath, 0, 0, '', 'imgTabTitle').' ';
  1953. }
  1954. $out .= '<span class="tabTitleText">'.dol_escape_htmltag(dol_trunc($title, $limittitle)).'</span>';
  1955. $out .= '</a>';
  1956. }
  1957. // Show tabs
  1958. // Define max of key (max may be higher than sizeof because of hole due to module disabling some tabs).
  1959. $maxkey = -1;
  1960. if (is_array($links) && !empty($links)) {
  1961. $keys = array_keys($links);
  1962. if (count($keys)) {
  1963. $maxkey = max($keys);
  1964. }
  1965. }
  1966. // Show tabs
  1967. // if =0 we don't use the feature
  1968. if (empty($limittoshow)) {
  1969. $limittoshow = (!getDolGlobalString('MAIN_MAXTABS_IN_CARD') ? 99 : $conf->global->MAIN_MAXTABS_IN_CARD);
  1970. }
  1971. if (!empty($conf->dol_optimize_smallscreen)) {
  1972. $limittoshow = 2;
  1973. }
  1974. $displaytab = 0;
  1975. $nbintab = 0;
  1976. $popuptab = 0;
  1977. $outmore = '';
  1978. for ($i = 0; $i <= $maxkey; $i++) {
  1979. if ((is_numeric($active) && $i == $active) || (!empty($links[$i][2]) && !is_numeric($active) && $active == $links[$i][2])) {
  1980. // If active tab is already present
  1981. if ($i >= $limittoshow) {
  1982. $limittoshow--;
  1983. }
  1984. }
  1985. }
  1986. for ($i = 0; $i <= $maxkey; $i++) {
  1987. if ((is_numeric($active) && $i == $active) || (!empty($links[$i][2]) && !is_numeric($active) && $active == $links[$i][2])) {
  1988. $isactive = true;
  1989. } else {
  1990. $isactive = false;
  1991. }
  1992. if ($i < $limittoshow || $isactive) {
  1993. // Output entry with a visible tab
  1994. $out .= '<div class="inline-block tabsElem'.($isactive ? ' tabsElemActive' : '').((!$isactive && getDolGlobalString('MAIN_HIDE_INACTIVETAB_ON_PRINT')) ? ' hideonprint' : '').'"><!-- id tab = '.(empty($links[$i][2]) ? '' : dol_escape_htmltag($links[$i][2])).' -->';
  1995. if (isset($links[$i][2]) && $links[$i][2] == 'image') {
  1996. if (!empty($links[$i][0])) {
  1997. $out .= '<a class="tabimage'.($morecss ? ' '.$morecss : '').'" href="'.$links[$i][0].'">'.$links[$i][1].'</a>'."\n";
  1998. } else {
  1999. $out .= '<span class="tabspan">'.$links[$i][1].'</span>'."\n";
  2000. }
  2001. } elseif (!empty($links[$i][1])) {
  2002. //print "x $i $active ".$links[$i][2]." z";
  2003. $out .= '<div class="tab tab'.($isactive ? 'active' : 'unactive').'" style="margin: 0 !important">';
  2004. if (!empty($links[$i][0])) {
  2005. $titletoshow = preg_replace('/<.*$/', '', $links[$i][1]);
  2006. $out .= '<a'.(!empty($links[$i][2]) ? ' id="'.$links[$i][2].'"' : '').' class="tab inline-block valignmiddle'.($morecss ? ' '.$morecss : '').(!empty($links[$i][5]) ? ' '.$links[$i][5] : '').'" href="'.$links[$i][0].'" title="'.dol_escape_htmltag($titletoshow).'">';
  2007. }
  2008. $out .= $links[$i][1];
  2009. if (!empty($links[$i][0])) {
  2010. $out .= '</a>'."\n";
  2011. }
  2012. $out .= empty($links[$i][4]) ? '' : $links[$i][4];
  2013. $out .= '</div>';
  2014. }
  2015. $out .= '</div>';
  2016. } else {
  2017. // Add entry into the combo popup with the other tabs
  2018. if (!$popuptab) {
  2019. $popuptab = 1;
  2020. $outmore .= '<div class="popuptabset wordwrap">'; // The css used to hide/show popup
  2021. }
  2022. $outmore .= '<div class="popuptab wordwrap" style="display:inherit;">';
  2023. if (isset($links[$i][2]) && $links[$i][2] == 'image') {
  2024. if (!empty($links[$i][0])) {
  2025. $outmore .= '<a class="tabimage'.($morecss ? ' '.$morecss : '').'" href="'.$links[$i][0].'">'.$links[$i][1].'</a>'."\n";
  2026. } else {
  2027. $outmore .= '<span class="tabspan">'.$links[$i][1].'</span>'."\n";
  2028. }
  2029. } elseif (!empty($links[$i][1])) {
  2030. $outmore .= '<a'.(!empty($links[$i][2]) ? ' id="'.$links[$i][2].'"' : '').' class="wordwrap inline-block'.($morecss ? ' '.$morecss : '').'" href="'.$links[$i][0].'">';
  2031. $outmore .= preg_replace('/([a-z])\|([a-z])/i', '\\1 | \\2', $links[$i][1]); // Replace x|y with x | y to allow wrap on long composed texts.
  2032. $outmore .= '</a>'."\n";
  2033. }
  2034. $outmore .= '</div>';
  2035. $nbintab++;
  2036. }
  2037. $displaytab = $i;
  2038. }
  2039. if ($popuptab) {
  2040. $outmore .= '</div>';
  2041. }
  2042. if ($popuptab) { // If there is some tabs not shown
  2043. $left = ($langs->trans("DIRECTION") == 'rtl' ? 'right' : 'left');
  2044. $right = ($langs->trans("DIRECTION") == 'rtl' ? 'left' : 'right');
  2045. $widthofpopup = 200;
  2046. $tabsname = $moretabssuffix;
  2047. if (empty($tabsname)) {
  2048. $tabsname = str_replace("@", "", $picto);
  2049. }
  2050. $out .= '<div id="moretabs'.$tabsname.'" class="inline-block tabsElem valignmiddle">';
  2051. $out .= '<div class="tab valignmiddle"><a href="#" class="tab moretab inline-block tabunactive valignmiddle"><span class="hideonsmartphone">'.$langs->trans("More").'</span>... ('.$nbintab.')</a></div>'; // Do not use "reposition" class in the "More".
  2052. $out .= '<div id="moretabsList'.$tabsname.'" style="width: '.$widthofpopup.'px; position: absolute; '.$left.': -999em; text-align: '.$left.'; margin:0px; padding:2px; z-index:10;">';
  2053. $out .= $outmore;
  2054. $out .= '</div>';
  2055. $out .= '<div></div>';
  2056. $out .= "</div>\n";
  2057. $out .= '<script nonce="'.getNonce().'">';
  2058. $out .= "$('#moretabs".$tabsname."').mouseenter( function() {
  2059. var x = this.offsetLeft, y = this.offsetTop;
  2060. console.log('mouseenter ".$left." x='+x+' y='+y+' window.innerWidth='+window.innerWidth);
  2061. if ((window.innerWidth - x) < ".($widthofpopup + 10).") {
  2062. $('#moretabsList".$tabsname."').css('".$right."','8px');
  2063. }
  2064. $('#moretabsList".$tabsname."').css('".$left."','auto');
  2065. });
  2066. ";
  2067. $out .= "$('#moretabs".$tabsname."').mouseleave( function() { console.log('mouseleave ".$left."'); $('#moretabsList".$tabsname."').css('".$left."','-999em');});";
  2068. $out .= "</script>";
  2069. }
  2070. if ((!empty($title) && $showtitle) || $morehtmlright || !empty($links)) {
  2071. $out .= "</div>\n";
  2072. }
  2073. if (!$notab || $notab == -1 || $notab == -2 || $notab == -3) {
  2074. $out .= "\n".'<div id="dragDropAreaTabBar" class="tabBar'.($notab == -1 ? '' : ($notab == -2 ? ' tabBarNoTop' : (($notab == -3 ? ' noborderbottom' : '').' tabBarWithBottom'))).'">'."\n";
  2075. }
  2076. if (!empty($dragdropfile)) {
  2077. include_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
  2078. $out .= dragAndDropFileUpload("dragDropAreaTabBar");
  2079. }
  2080. $parameters = array('tabname' => $active, 'out' => $out);
  2081. $reshook = $hookmanager->executeHooks('printTabsHead', $parameters); // This hook usage is called just before output the head of tabs. Take also a look at "completeTabsHead"
  2082. if ($reshook > 0) {
  2083. $out = $hookmanager->resPrint;
  2084. }
  2085. return $out;
  2086. }
  2087. /**
  2088. * Show tab footer of a card
  2089. *
  2090. * @param int $notab -1 or 0=Add tab footer, 1=no tab footer
  2091. * @return void
  2092. * @deprecated Use print dol_get_fiche_end() instead
  2093. */
  2094. function dol_fiche_end($notab = 0)
  2095. {
  2096. print dol_get_fiche_end($notab);
  2097. }
  2098. /**
  2099. * Return tab footer of a card
  2100. *
  2101. * @param int $notab -1 or 0=Add tab footer, 1=no tab footer
  2102. * @return string
  2103. */
  2104. function dol_get_fiche_end($notab = 0)
  2105. {
  2106. if (!$notab || $notab == -1) {
  2107. return "\n</div>\n";
  2108. } else {
  2109. return '';
  2110. }
  2111. }
  2112. /**
  2113. * Show tab footer of a card.
  2114. * Note: $object->next_prev_filter can be set to restrict select to find next or previous record by $form->showrefnav.
  2115. *
  2116. * @param Object $object Object to show
  2117. * @param string $paramid Name of parameter to use to name the id into the URL next/previous link
  2118. * @param string $morehtml More html content to output just before the nav bar
  2119. * @param int $shownav Show Condition (navigation is shown if value is 1)
  2120. * @param string $fieldid Nom du champ en base a utiliser pour select next et previous (we make the select max and min on this field). Use 'none' for no prev/next search.
  2121. * @param string $fieldref Nom du champ objet ref (object->ref) a utiliser pour select next et previous
  2122. * @param string $morehtmlref More html to show after the ref (see $morehtmlleft for before)
  2123. * @param string $moreparam More param to add in nav link url.
  2124. * @param int $nodbprefix Do not include DB prefix to forge table name
  2125. * @param string $morehtmlleft More html code to show before the ref (see $morehtmlref for after)
  2126. * @param string $morehtmlstatus More html code to show under navigation arrows
  2127. * @param int $onlybanner Put this to 1, if the card will contains only a banner (this add css 'arearefnobottom' on div)
  2128. * @param string $morehtmlright More html code to show before navigation arrows
  2129. * @return void
  2130. */
  2131. function dol_banner_tab($object, $paramid, $morehtml = '', $shownav = 1, $fieldid = 'rowid', $fieldref = 'ref', $morehtmlref = '', $moreparam = '', $nodbprefix = 0, $morehtmlleft = '', $morehtmlstatus = '', $onlybanner = 0, $morehtmlright = '')
  2132. {
  2133. global $conf, $form, $user, $langs, $hookmanager, $action;
  2134. $error = 0;
  2135. $maxvisiblephotos = 1;
  2136. $showimage = 1;
  2137. $entity = (empty($object->entity) ? $conf->entity : $object->entity);
  2138. $showbarcode = empty($conf->barcode->enabled) ? 0 : (empty($object->barcode) ? 0 : 1);
  2139. if (getDolGlobalString('MAIN_USE_ADVANCED_PERMS') && !$user->hasRight('barcode', 'lire_advance')) {
  2140. $showbarcode = 0;
  2141. }
  2142. $modulepart = 'unknown';
  2143. if ($object->element == 'societe' || $object->element == 'contact' || $object->element == 'product' || $object->element == 'ticket') {
  2144. $modulepart = $object->element;
  2145. } elseif ($object->element == 'member') {
  2146. $modulepart = 'memberphoto';
  2147. } elseif ($object->element == 'user') {
  2148. $modulepart = 'userphoto';
  2149. }
  2150. if (class_exists("Imagick")) {
  2151. if ($object->element == 'expensereport' || $object->element == 'propal' || $object->element == 'commande' || $object->element == 'facture' || $object->element == 'supplier_proposal') {
  2152. $modulepart = $object->element;
  2153. } elseif ($object->element == 'fichinter') {
  2154. $modulepart = 'ficheinter';
  2155. } elseif ($object->element == 'contrat') {
  2156. $modulepart = 'contract';
  2157. } elseif ($object->element == 'order_supplier') {
  2158. $modulepart = 'supplier_order';
  2159. } elseif ($object->element == 'invoice_supplier') {
  2160. $modulepart = 'supplier_invoice';
  2161. }
  2162. }
  2163. if ($object->element == 'product') {
  2164. $width = 80;
  2165. $cssclass = 'photowithmargin photoref';
  2166. $showimage = $object->is_photo_available($conf->product->multidir_output[$entity]);
  2167. $maxvisiblephotos = (isset($conf->global->PRODUCT_MAX_VISIBLE_PHOTO) ? $conf->global->PRODUCT_MAX_VISIBLE_PHOTO : 5);
  2168. if ($conf->browser->layout == 'phone') {
  2169. $maxvisiblephotos = 1;
  2170. }
  2171. if ($showimage) {
  2172. $morehtmlleft .= '<div class="floatleft inline-block valignmiddle divphotoref">'.$object->show_photos('product', $conf->product->multidir_output[$entity], 'small', $maxvisiblephotos, 0, 0, 0, 0, $width, 0, '').'</div>';
  2173. } else {
  2174. if (getDolGlobalString('PRODUCT_NODISPLAYIFNOPHOTO')) {
  2175. $nophoto = '';
  2176. $morehtmlleft .= '<div class="floatleft inline-block valignmiddle divphotoref"></div>';
  2177. } else { // Show no photo link
  2178. $nophoto = '/public/theme/common/nophoto.png';
  2179. $morehtmlleft .= '<div class="floatleft inline-block valignmiddle divphotoref"><img class="photo'.$modulepart.($cssclass ? ' '.$cssclass : '').'" title="'.dol_escape_htmltag($langs->trans("UploadAnImageToSeeAPhotoHere", $langs->transnoentitiesnoconv("Documents"))).'" alt="No photo"'.($width ? ' style="width: '.$width.'px"' : '').' src="'.DOL_URL_ROOT.$nophoto.'"></div>';
  2180. }
  2181. }
  2182. } elseif ($object->element == 'ticket') {
  2183. $width = 80;
  2184. $cssclass = 'photoref';
  2185. $showimage = $object->is_photo_available($conf->ticket->multidir_output[$entity].'/'.$object->ref);
  2186. $maxvisiblephotos = (isset($conf->global->TICKET_MAX_VISIBLE_PHOTO) ? $conf->global->TICKET_MAX_VISIBLE_PHOTO : 2);
  2187. if ($conf->browser->layout == 'phone') {
  2188. $maxvisiblephotos = 1;
  2189. }
  2190. if ($showimage) {
  2191. $showphoto = $object->show_photos('ticket', $conf->ticket->multidir_output[$entity], 'small', $maxvisiblephotos, 0, 0, 0, $width, 0);
  2192. if ($object->nbphoto > 0) {
  2193. $morehtmlleft .= '<div class="floatleft inline-block valignmiddle divphotoref">'.$showphoto.'</div>';
  2194. } else {
  2195. $showimage = 0;
  2196. }
  2197. }
  2198. if (!$showimage) {
  2199. if (getDolGlobalString('TICKET_NODISPLAYIFNOPHOTO')) {
  2200. $nophoto = '';
  2201. $morehtmlleft .= '<div class="floatleft inline-block valignmiddle divphotoref"></div>';
  2202. } else { // Show no photo link
  2203. $nophoto = img_picto('No photo', 'object_ticket');
  2204. $morehtmlleft .= '<!-- No photo to show -->';
  2205. $morehtmlleft .= '<div class="floatleft inline-block valignmiddle divphotoref"><div class="photoref">';
  2206. $morehtmlleft .= $nophoto;
  2207. $morehtmlleft .= '</div></div>';
  2208. }
  2209. }
  2210. } else {
  2211. if ($showimage) {
  2212. if ($modulepart != 'unknown') {
  2213. $phototoshow = '';
  2214. // Check if a preview file is available
  2215. if (in_array($modulepart, array('propal', 'commande', 'facture', 'ficheinter', 'contract', 'supplier_order', 'supplier_proposal', 'supplier_invoice', 'expensereport')) && class_exists("Imagick")) {
  2216. $objectref = dol_sanitizeFileName($object->ref);
  2217. $dir_output = (empty($conf->$modulepart->multidir_output[$entity]) ? $conf->$modulepart->dir_output : $conf->$modulepart->multidir_output[$entity])."/";
  2218. if (in_array($modulepart, array('invoice_supplier', 'supplier_invoice'))) {
  2219. $subdir = get_exdir($object->id, 2, 0, 1, $object, $modulepart);
  2220. $subdir .= ((!empty($subdir) && !preg_match('/\/$/', $subdir)) ? '/' : '').$objectref; // the objectref dir is not included into get_exdir when used with level=2, so we add it at end
  2221. } else {
  2222. $subdir = get_exdir($object->id, 0, 0, 1, $object, $modulepart);
  2223. }
  2224. if (empty($subdir)) {
  2225. $subdir = 'errorgettingsubdirofobject'; // Protection to avoid to return empty path
  2226. }
  2227. $filepath = $dir_output.$subdir."/";
  2228. $filepdf = $filepath.$objectref.".pdf";
  2229. $relativepath = $subdir.'/'.$objectref.'.pdf';
  2230. // Define path to preview pdf file (preview precompiled "file.ext" are "file.ext_preview.png")
  2231. $fileimage = $filepdf.'_preview.png';
  2232. $relativepathimage = $relativepath.'_preview.png';
  2233. $pdfexists = file_exists($filepdf);
  2234. // If PDF file exists
  2235. if ($pdfexists) {
  2236. // Conversion du PDF en image png si fichier png non existant
  2237. if (!file_exists($fileimage) || (filemtime($fileimage) < filemtime($filepdf))) {
  2238. if (!getDolGlobalString('MAIN_DISABLE_PDF_THUMBS')) { // If you experience trouble with pdf thumb generation and imagick, you can disable here.
  2239. include_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
  2240. $ret = dol_convert_file($filepdf, 'png', $fileimage, '0'); // Convert first page of PDF into a file _preview.png
  2241. if ($ret < 0) {
  2242. $error++;
  2243. }
  2244. }
  2245. }
  2246. }
  2247. if ($pdfexists && !$error) {
  2248. $heightforphotref = 80;
  2249. if (!empty($conf->dol_optimize_smallscreen)) {
  2250. $heightforphotref = 60;
  2251. }
  2252. // If the preview file is found
  2253. if (file_exists($fileimage)) {
  2254. $phototoshow = '<div class="photoref">';
  2255. $phototoshow .= '<img height="'.$heightforphotref.'" class="photo photowithborder" src="'.DOL_URL_ROOT.'/viewimage.php?modulepart=apercu'.$modulepart.'&amp;file='.urlencode($relativepathimage).'">';
  2256. $phototoshow .= '</div>';
  2257. }
  2258. }
  2259. } elseif (!$phototoshow) { // example if modulepart = 'societe' or 'photo'
  2260. $phototoshow .= $form->showphoto($modulepart, $object, 0, 0, 0, 'photowithmargin photoref', 'small', 1, 0, $maxvisiblephotos);
  2261. }
  2262. if ($phototoshow) {
  2263. $morehtmlleft .= '<div class="floatleft inline-block valignmiddle divphotoref">';
  2264. $morehtmlleft .= $phototoshow;
  2265. $morehtmlleft .= '</div>';
  2266. }
  2267. }
  2268. if (empty($phototoshow)) { // Show No photo link (picto of object)
  2269. if ($object->element == 'action') {
  2270. $width = 80;
  2271. $cssclass = 'photorefcenter';
  2272. $nophoto = img_picto('No photo', 'title_agenda');
  2273. } else {
  2274. $width = 14;
  2275. $cssclass = 'photorefcenter';
  2276. $picto = $object->picto;
  2277. $prefix = 'object_';
  2278. if ($object->element == 'project' && !$object->public) {
  2279. $picto = 'project'; // instead of projectpub
  2280. }
  2281. if (strpos($picto, 'fontawesome_') !== false) {
  2282. $prefix = '';
  2283. }
  2284. $nophoto = img_picto('No photo', $prefix.$picto);
  2285. }
  2286. $morehtmlleft .= '<!-- No photo to show -->';
  2287. $morehtmlleft .= '<div class="floatleft inline-block valignmiddle divphotoref"><div class="photoref">';
  2288. $morehtmlleft .= $nophoto;
  2289. $morehtmlleft .= '</div></div>';
  2290. }
  2291. }
  2292. }
  2293. // Show barcode
  2294. if ($showbarcode) {
  2295. $morehtmlleft .= '<div class="floatleft inline-block valignmiddle divphotoref">'.$form->showbarcode($object, 100, 'photoref valignmiddle').'</div>';
  2296. }
  2297. if ($object->element == 'societe') {
  2298. if (!empty($conf->use_javascript_ajax) && $user->hasRight('societe', 'creer') && getDolGlobalString('MAIN_DIRECT_STATUS_UPDATE')) {
  2299. $morehtmlstatus .= ajax_object_onoff($object, 'status', 'status', 'InActivity', 'ActivityCeased');
  2300. } else {
  2301. $morehtmlstatus .= $object->getLibStatut(6);
  2302. }
  2303. } elseif ($object->element == 'product') {
  2304. //$morehtmlstatus.=$langs->trans("Status").' ('.$langs->trans("Sell").') ';
  2305. if (!empty($conf->use_javascript_ajax) && $user->hasRight('produit', 'creer') && getDolGlobalString('MAIN_DIRECT_STATUS_UPDATE')) {
  2306. $morehtmlstatus .= ajax_object_onoff($object, 'status', 'tosell', 'ProductStatusOnSell', 'ProductStatusNotOnSell');
  2307. } else {
  2308. $morehtmlstatus .= '<span class="statusrefsell">'.$object->getLibStatut(6, 0).'</span>';
  2309. }
  2310. $morehtmlstatus .= ' &nbsp; ';
  2311. //$morehtmlstatus.=$langs->trans("Status").' ('.$langs->trans("Buy").') ';
  2312. if (!empty($conf->use_javascript_ajax) && $user->hasRight('produit', 'creer') && getDolGlobalString('MAIN_DIRECT_STATUS_UPDATE')) {
  2313. $morehtmlstatus .= ajax_object_onoff($object, 'status_buy', 'tobuy', 'ProductStatusOnBuy', 'ProductStatusNotOnBuy');
  2314. } else {
  2315. $morehtmlstatus .= '<span class="statusrefbuy">'.$object->getLibStatut(6, 1).'</span>';
  2316. }
  2317. } elseif (in_array($object->element, array('salary'))) {
  2318. $tmptxt = $object->getLibStatut(6, $object->alreadypaid);
  2319. if (empty($tmptxt) || $tmptxt == $object->getLibStatut(3)) {
  2320. $tmptxt = $object->getLibStatut(5, $object->alreadypaid);
  2321. }
  2322. $morehtmlstatus .= $tmptxt;
  2323. } elseif (in_array($object->element, array('facture', 'invoice', 'invoice_supplier', 'chargesociales', 'loan', 'tva'))) { // TODO Move this to use ->alreadypaid
  2324. $tmptxt = $object->getLibStatut(6, $object->totalpaid);
  2325. if (empty($tmptxt) || $tmptxt == $object->getLibStatut(3)) {
  2326. $tmptxt = $object->getLibStatut(5, $object->totalpaid);
  2327. }
  2328. $morehtmlstatus .= $tmptxt;
  2329. } elseif ($object->element == 'contrat' || $object->element == 'contract') {
  2330. if ($object->statut == 0) {
  2331. $morehtmlstatus .= $object->getLibStatut(5);
  2332. } else {
  2333. $morehtmlstatus .= $object->getLibStatut(4);
  2334. }
  2335. } elseif ($object->element == 'facturerec') {
  2336. if ($object->frequency == 0) {
  2337. $morehtmlstatus .= $object->getLibStatut(2);
  2338. } else {
  2339. $morehtmlstatus .= $object->getLibStatut(5);
  2340. }
  2341. } elseif ($object->element == 'project_task') {
  2342. $object->fk_statut = 1;
  2343. if ($object->progress > 0) {
  2344. $object->fk_statut = 2;
  2345. }
  2346. if ($object->progress >= 100) {
  2347. $object->fk_statut = 3;
  2348. }
  2349. $tmptxt = $object->getLibStatut(5);
  2350. $morehtmlstatus .= $tmptxt; // No status on task
  2351. } elseif (method_exists($object, 'getLibStatut')) { // Generic case for status
  2352. $tmptxt = $object->getLibStatut(6);
  2353. if (empty($tmptxt) || $tmptxt == $object->getLibStatut(3)) {
  2354. $tmptxt = $object->getLibStatut(5);
  2355. }
  2356. $morehtmlstatus .= $tmptxt;
  2357. }
  2358. // Add if object was dispatched "into accountancy"
  2359. if (isModEnabled('accounting') && in_array($object->element, array('bank', 'paiementcharge', 'facture', 'invoice', 'invoice_supplier', 'expensereport', 'payment_various'))) {
  2360. // Note: For 'chargesociales', 'salaries'... this is the payments that are dispatched (so element = 'bank')
  2361. if (method_exists($object, 'getVentilExportCompta')) {
  2362. $accounted = $object->getVentilExportCompta();
  2363. $langs->load("accountancy");
  2364. $morehtmlstatus .= '</div><div class="statusref statusrefbis"><span class="opacitymedium">'.($accounted > 0 ? $langs->trans("Accounted") : $langs->trans("NotYetAccounted")).'</span>';
  2365. }
  2366. }
  2367. // Add alias for thirdparty
  2368. if (!empty($object->name_alias)) {
  2369. $morehtmlref .= '<div class="refidno opacitymedium">'.dol_escape_htmltag($object->name_alias).'</div>';
  2370. }
  2371. // Add label
  2372. if (in_array($object->element, array('product', 'bank_account', 'project_task'))) {
  2373. if (!empty($object->label)) {
  2374. $morehtmlref .= '<div class="refidno opacitymedium">'.$object->label.'</div>';
  2375. }
  2376. }
  2377. // Show address and email
  2378. if (method_exists($object, 'getBannerAddress') && !in_array($object->element, array('product', 'bookmark', 'ecm_directories', 'ecm_files'))) {
  2379. $moreaddress = $object->getBannerAddress('refaddress', $object); // address, email, url, social networks
  2380. if ($moreaddress) {
  2381. $morehtmlref .= '<div class="refidno refaddress">';
  2382. $morehtmlref .= $moreaddress;
  2383. $morehtmlref .= '</div>';
  2384. }
  2385. }
  2386. if (getDolGlobalString('MAIN_SHOW_TECHNICAL_ID') && (getDolGlobalString('MAIN_SHOW_TECHNICAL_ID') == '1' || preg_match('/'.preg_quote($object->element, '/').'/i', $conf->global->MAIN_SHOW_TECHNICAL_ID)) && !empty($object->id)) {
  2387. $morehtmlref .= '<div style="clear: both;"></div>';
  2388. $morehtmlref .= '<div class="refidno opacitymedium">';
  2389. $morehtmlref .= $langs->trans("TechnicalID").': '.((int) $object->id);
  2390. $morehtmlref .= '</div>';
  2391. }
  2392. $parameters=array('morehtmlref'=>$morehtmlref);
  2393. $reshook = $hookmanager->executeHooks('formDolBanner', $parameters, $object, $action);
  2394. if ($reshook < 0) {
  2395. setEventMessages($hookmanager->error, $hookmanager->errors, 'errors');
  2396. } elseif (empty($reshook)) {
  2397. $morehtmlref .= $hookmanager->resPrint;
  2398. } elseif ($reshook > 0) {
  2399. $morehtmlref = $hookmanager->resPrint;
  2400. }
  2401. print '<div class="'.($onlybanner ? 'arearefnobottom ' : 'arearef ').'heightref valignmiddle centpercent">';
  2402. print $form->showrefnav($object, $paramid, $morehtml, $shownav, $fieldid, $fieldref, $morehtmlref, $moreparam, $nodbprefix, $morehtmlleft, $morehtmlstatus, $morehtmlright);
  2403. print '</div>';
  2404. print '<div class="underrefbanner clearboth"></div>';
  2405. }
  2406. /**
  2407. * Show a string with the label tag dedicated to the HTML edit field.
  2408. *
  2409. * @param string $langkey Translation key
  2410. * @param string $fieldkey Key of the html select field the text refers to
  2411. * @param int $fieldrequired 1=Field is mandatory
  2412. * @return string
  2413. * @deprecated Form::editfieldkey
  2414. */
  2415. function fieldLabel($langkey, $fieldkey, $fieldrequired = 0)
  2416. {
  2417. global $langs;
  2418. $ret = '';
  2419. if ($fieldrequired) {
  2420. $ret .= '<span class="fieldrequired">';
  2421. }
  2422. $ret .= '<label for="'.$fieldkey.'">';
  2423. $ret .= $langs->trans($langkey);
  2424. $ret .= '</label>';
  2425. if ($fieldrequired) {
  2426. $ret .= '</span>';
  2427. }
  2428. return $ret;
  2429. }
  2430. /**
  2431. * Return string to add class property on html element with pair/impair.
  2432. *
  2433. * @param string $var 0 or 1
  2434. * @param string $moreclass More class to add
  2435. * @return string String to add class onto HTML element
  2436. */
  2437. function dol_bc($var, $moreclass = '')
  2438. {
  2439. global $bc;
  2440. $ret = ' '.$bc[$var];
  2441. if ($moreclass) {
  2442. $ret = preg_replace('/class=\"/', 'class="'.$moreclass.' ', $ret);
  2443. }
  2444. return $ret;
  2445. }
  2446. /**
  2447. * Return a formated address (part address/zip/town/state) according to country rules.
  2448. * See https://en.wikipedia.org/wiki/Address
  2449. *
  2450. * @param Object $object A company or contact object
  2451. * @param int $withcountry 1=Add country into address string
  2452. * @param string $sep Separator to use to separate info when building string
  2453. * @param Translate $outputlangs Object lang that contains language for text translation.
  2454. * @param int $mode 0=Standard output, 1=Remove address
  2455. * @param string $extralangcode User extralanguage $langcode as values for address, town
  2456. * @return string Formated string
  2457. * @see dol_print_address()
  2458. */
  2459. function dol_format_address($object, $withcountry = 0, $sep = "\n", $outputlangs = '', $mode = 0, $extralangcode = '')
  2460. {
  2461. global $conf, $langs, $hookmanager;
  2462. $ret = '';
  2463. $countriesusingstate = array('AU', 'CA', 'US', 'IN', 'GB', 'ES', 'UK', 'TR', 'CN'); // See also MAIN_FORCE_STATE_INTO_ADDRESS
  2464. // See format of addresses on https://en.wikipedia.org/wiki/Address
  2465. // Address
  2466. if (empty($mode)) {
  2467. $ret .= ($extralangcode ? $object->array_languages['address'][$extralangcode] : (empty($object->address) ? '' : preg_replace('/(\r\n|\r|\n)+/', $sep, $object->address)));
  2468. }
  2469. // Zip/Town/State
  2470. if (isset($object->country_code) && in_array($object->country_code, array('AU', 'CA', 'US', 'CN')) || getDolGlobalString('MAIN_FORCE_STATE_INTO_ADDRESS')) {
  2471. // US: title firstname name \n address lines \n town, state, zip \n country
  2472. $town = ($extralangcode ? $object->array_languages['town'][$extralangcode] : (empty($object->town) ? '' : $object->town));
  2473. $ret .= (($ret && $town) ? $sep : '').$town;
  2474. if (!empty($object->state)) {
  2475. $ret .= ($ret ? ($town ? ", " : $sep) : '').$object->state;
  2476. }
  2477. if (!empty($object->zip)) {
  2478. $ret .= ($ret ? (($town || $object->state) ? ", " : $sep) : '').$object->zip;
  2479. }
  2480. } elseif (isset($object->country_code) && in_array($object->country_code, array('GB', 'UK'))) {
  2481. // UK: title firstname name \n address lines \n town state \n zip \n country
  2482. $town = ($extralangcode ? $object->array_languages['town'][$extralangcode] : (empty($object->town) ? '' : $object->town));
  2483. $ret .= ($ret ? $sep : '').$town;
  2484. if (!empty($object->state)) {
  2485. $ret .= ($ret ? ", " : '').$object->state;
  2486. }
  2487. if (!empty($object->zip)) {
  2488. $ret .= ($ret ? $sep : '').$object->zip;
  2489. }
  2490. } elseif (isset($object->country_code) && in_array($object->country_code, array('ES', 'TR'))) {
  2491. // ES: title firstname name \n address lines \n zip town \n state \n country
  2492. $ret .= ($ret ? $sep : '').$object->zip;
  2493. $town = ($extralangcode ? $object->array_languages['town'][$extralangcode] : (empty($object->town) ? '' : $object->town));
  2494. $ret .= ($town ? (($object->zip ? ' ' : '').$town) : '');
  2495. if (!empty($object->state)) {
  2496. $ret .= $sep.$object->state;
  2497. }
  2498. } elseif (isset($object->country_code) && in_array($object->country_code, array('JP'))) {
  2499. // JP: In romaji, title firstname name\n address lines \n [state,] town zip \n country
  2500. // See https://www.sljfaq.org/afaq/addresses.html
  2501. $town = ($extralangcode ? $object->array_languages['town'][$extralangcode] : (empty($object->town) ? '' : $object->town));
  2502. $ret .= ($ret ? $sep : '').($object->state ? $object->state.', ' : '').$town.($object->zip ? ' ' : '').$object->zip;
  2503. } elseif (isset($object->country_code) && in_array($object->country_code, array('IT'))) {
  2504. // IT: title firstname name\n address lines \n zip town state_code \n country
  2505. $ret .= ($ret ? $sep : '').$object->zip;
  2506. $town = ($extralangcode ? $object->array_languages['town'][$extralangcode] : (empty($object->town) ? '' : $object->town));
  2507. $ret .= ($town ? (($object->zip ? ' ' : '').$town) : '');
  2508. $ret .= (empty($object->state_code) ? '' : (' '.$object->state_code));
  2509. } else {
  2510. // Other: title firstname name \n address lines \n zip town[, state] \n country
  2511. $town = ($extralangcode ? $object->array_languages['town'][$extralangcode] : (empty($object->town) ? '' : $object->town));
  2512. $ret .= !empty($object->zip) ? (($ret ? $sep : '').$object->zip) : '';
  2513. $ret .= ($town ? (($object->zip ? ' ' : ($ret ? $sep : '')).$town) : '');
  2514. if (!empty($object->state) && in_array($object->country_code, $countriesusingstate)) {
  2515. $ret .= ($ret ? ", " : '').$object->state;
  2516. }
  2517. }
  2518. if (!is_object($outputlangs)) {
  2519. $outputlangs = $langs;
  2520. }
  2521. if ($withcountry) {
  2522. $langs->load("dict");
  2523. $ret .= (empty($object->country_code) ? '' : ($ret ? $sep : '').$outputlangs->convToOutputCharset($outputlangs->transnoentitiesnoconv("Country".$object->country_code)));
  2524. }
  2525. if ($hookmanager) {
  2526. $parameters = array('withcountry' => $withcountry, 'sep' => $sep, 'outputlangs' => $outputlangs,'mode' => $mode, 'extralangcode' => $extralangcode);
  2527. $reshook = $hookmanager->executeHooks('formatAddress', $parameters, $object);
  2528. if ($reshook > 0) {
  2529. $ret = '';
  2530. }
  2531. $ret .= $hookmanager->resPrint;
  2532. }
  2533. return $ret;
  2534. }
  2535. /**
  2536. * Format a string.
  2537. *
  2538. * @param string $fmt Format of strftime function (http://php.net/manual/fr/function.strftime.php)
  2539. * @param int $ts Timesamp (If is_gmt is true, timestamp is already includes timezone and daylight saving offset, if is_gmt is false, timestamp is a GMT timestamp and we must compensate with server PHP TZ)
  2540. * @param int $is_gmt See comment of timestamp parameter
  2541. * @return string A formatted string
  2542. */
  2543. function dol_strftime($fmt, $ts = false, $is_gmt = false)
  2544. {
  2545. if ((abs($ts) <= 0x7FFFFFFF)) { // check if number in 32-bit signed range
  2546. return ($is_gmt) ? @gmstrftime($fmt, $ts) : @strftime($fmt, $ts);
  2547. } else {
  2548. return 'Error date into a not supported range';
  2549. }
  2550. }
  2551. /**
  2552. * Output date in a string format according to outputlangs (or langs if not defined).
  2553. * Return charset is always UTF-8, except if encodetoouput is defined. In this case charset is output charset
  2554. *
  2555. * @param int $time GM Timestamps date
  2556. * @param string $format Output date format (tag of strftime function)
  2557. * "%d %b %Y",
  2558. * "%d/%m/%Y %H:%M",
  2559. * "%d/%m/%Y %H:%M:%S",
  2560. * "%B"=Long text of month, "%A"=Long text of day, "%b"=Short text of month, "%a"=Short text of day
  2561. * "day", "daytext", "dayhour", "dayhourldap", "dayhourtext", "dayrfc", "dayhourrfc", "...inputnoreduce", "...reduceformat"
  2562. * @param string $tzoutput true or 'gmt' => string is for Greenwich location
  2563. * false or 'tzserver' => output string is for local PHP server TZ usage
  2564. * 'tzuser' => output string is for user TZ (current browser TZ with current dst) => In a future, we should have same behaviour than 'tzuserrel'
  2565. * 'tzuserrel' => output string is for user TZ (current browser TZ with dst or not, depending on date position)
  2566. * @param Translate $outputlangs Object lang that contains language for text translation.
  2567. * @param boolean $encodetooutput false=no convert into output pagecode
  2568. * @return string Formated date or '' if time is null
  2569. *
  2570. * @see dol_mktime(), dol_stringtotime(), dol_getdate(), selectDate()
  2571. */
  2572. function dol_print_date($time, $format = '', $tzoutput = 'auto', $outputlangs = '', $encodetooutput = false)
  2573. {
  2574. global $conf, $langs;
  2575. // If date undefined or "", we return ""
  2576. if (dol_strlen($time) == 0) {
  2577. return ''; // $time=0 allowed (it means 01/01/1970 00:00:00)
  2578. }
  2579. if ($tzoutput === 'auto') {
  2580. $tzoutput = (empty($conf) ? 'tzserver' : (isset($conf->tzuserinputkey) ? $conf->tzuserinputkey : 'tzserver'));
  2581. }
  2582. // Clean parameters
  2583. $to_gmt = false;
  2584. $offsettz = $offsetdst = 0;
  2585. if ($tzoutput) {
  2586. $to_gmt = true; // For backward compatibility
  2587. if (is_string($tzoutput)) {
  2588. if ($tzoutput == 'tzserver') {
  2589. $to_gmt = false;
  2590. $offsettzstring = @date_default_timezone_get(); // Example 'Europe/Berlin' or 'Indian/Reunion'
  2591. $offsettz = 0; // Timezone offset with server timezone (because to_gmt is false), so 0
  2592. $offsetdst = 0; // Dst offset with server timezone (because to_gmt is false), so 0
  2593. } elseif ($tzoutput == 'tzuser' || $tzoutput == 'tzuserrel') {
  2594. $to_gmt = true;
  2595. $offsettzstring = (empty($_SESSION['dol_tz_string']) ? 'UTC' : $_SESSION['dol_tz_string']); // Example 'Europe/Berlin' or 'Indian/Reunion'
  2596. if (class_exists('DateTimeZone')) {
  2597. $user_date_tz = new DateTimeZone($offsettzstring);
  2598. $user_dt = new DateTime();
  2599. $user_dt->setTimezone($user_date_tz);
  2600. $user_dt->setTimestamp($tzoutput == 'tzuser' ? dol_now() : (int) $time);
  2601. $offsettz = $user_dt->getOffset(); // should include dst ?
  2602. } else { // with old method (The 'tzuser' was processed like the 'tzuserrel')
  2603. $offsettz = (empty($_SESSION['dol_tz']) ? 0 : $_SESSION['dol_tz']) * 60 * 60; // Will not be used anymore
  2604. $offsetdst = (empty($_SESSION['dol_dst']) ? 0 : $_SESSION['dol_dst']) * 60 * 60; // Will not be used anymore
  2605. }
  2606. }
  2607. }
  2608. }
  2609. if (!is_object($outputlangs)) {
  2610. $outputlangs = $langs;
  2611. }
  2612. if (!$format) {
  2613. $format = 'daytextshort';
  2614. }
  2615. // Do we have to reduce the length of date (year on 2 chars) to save space.
  2616. // Note: dayinputnoreduce is same than day but no reduction of year length will be done
  2617. $reduceformat = (!empty($conf->dol_optimize_smallscreen) && in_array($format, array('day', 'dayhour', 'dayhoursec'))) ? 1 : 0; // Test on original $format param.
  2618. $format = preg_replace('/inputnoreduce/', '', $format); // so format 'dayinputnoreduce' is processed like day
  2619. $formatwithoutreduce = preg_replace('/reduceformat/', '', $format);
  2620. if ($formatwithoutreduce != $format) {
  2621. $format = $formatwithoutreduce;
  2622. $reduceformat = 1;
  2623. } // so format 'dayreduceformat' is processed like day
  2624. // Change predefined format into computer format. If found translation in lang file we use it, otherwise we use default.
  2625. // TODO Add format daysmallyear and dayhoursmallyear
  2626. if ($format == 'day') {
  2627. $format = ($outputlangs->trans("FormatDateShort") != "FormatDateShort" ? $outputlangs->trans("FormatDateShort") : $conf->format_date_short);
  2628. } elseif ($format == 'hour') {
  2629. $format = ($outputlangs->trans("FormatHourShort") != "FormatHourShort" ? $outputlangs->trans("FormatHourShort") : $conf->format_hour_short);
  2630. } elseif ($format == 'hourduration') {
  2631. $format = ($outputlangs->trans("FormatHourShortDuration") != "FormatHourShortDuration" ? $outputlangs->trans("FormatHourShortDuration") : $conf->format_hour_short_duration);
  2632. } elseif ($format == 'daytext') {
  2633. $format = ($outputlangs->trans("FormatDateText") != "FormatDateText" ? $outputlangs->trans("FormatDateText") : $conf->format_date_text);
  2634. } elseif ($format == 'daytextshort') {
  2635. $format = ($outputlangs->trans("FormatDateTextShort") != "FormatDateTextShort" ? $outputlangs->trans("FormatDateTextShort") : $conf->format_date_text_short);
  2636. } elseif ($format == 'dayhour') {
  2637. $format = ($outputlangs->trans("FormatDateHourShort") != "FormatDateHourShort" ? $outputlangs->trans("FormatDateHourShort") : $conf->format_date_hour_short);
  2638. } elseif ($format == 'dayhoursec') {
  2639. $format = ($outputlangs->trans("FormatDateHourSecShort") != "FormatDateHourSecShort" ? $outputlangs->trans("FormatDateHourSecShort") : $conf->format_date_hour_sec_short);
  2640. } elseif ($format == 'dayhourtext') {
  2641. $format = ($outputlangs->trans("FormatDateHourText") != "FormatDateHourText" ? $outputlangs->trans("FormatDateHourText") : $conf->format_date_hour_text);
  2642. } elseif ($format == 'dayhourtextshort') {
  2643. $format = ($outputlangs->trans("FormatDateHourTextShort") != "FormatDateHourTextShort" ? $outputlangs->trans("FormatDateHourTextShort") : $conf->format_date_hour_text_short);
  2644. } elseif ($format == 'dayhourlog') {
  2645. // Format not sensitive to language
  2646. $format = '%Y%m%d%H%M%S';
  2647. } elseif ($format == 'dayhourlogsmall') {
  2648. // Format not sensitive to language
  2649. $format = '%y%m%d%H%M';
  2650. } elseif ($format == 'dayhourldap') {
  2651. $format = '%Y%m%d%H%M%SZ';
  2652. } elseif ($format == 'dayhourxcard') {
  2653. $format = '%Y%m%dT%H%M%SZ';
  2654. } elseif ($format == 'dayxcard') {
  2655. $format = '%Y%m%d';
  2656. } elseif ($format == 'dayrfc') {
  2657. $format = '%Y-%m-%d'; // DATE_RFC3339
  2658. } elseif ($format == 'dayhourrfc') {
  2659. $format = '%Y-%m-%dT%H:%M:%SZ'; // DATETIME RFC3339
  2660. } elseif ($format == 'standard') {
  2661. $format = '%Y-%m-%d %H:%M:%S';
  2662. }
  2663. if ($reduceformat) {
  2664. $format = str_replace('%Y', '%y', $format);
  2665. $format = str_replace('yyyy', 'yy', $format);
  2666. }
  2667. // Clean format
  2668. if (preg_match('/%b/i', $format)) { // There is some text to translate
  2669. // We inhibate translation to text made by strftime functions. We will use trans instead later.
  2670. $format = str_replace('%b', '__b__', $format);
  2671. $format = str_replace('%B', '__B__', $format);
  2672. }
  2673. if (preg_match('/%a/i', $format)) { // There is some text to translate
  2674. // We inhibate translation to text made by strftime functions. We will use trans instead later.
  2675. $format = str_replace('%a', '__a__', $format);
  2676. $format = str_replace('%A', '__A__', $format);
  2677. }
  2678. // Analyze date
  2679. $reg = array();
  2680. if (preg_match('/^([0-9][0-9][0-9][0-9])([0-9][0-9])([0-9][0-9])([0-9][0-9])([0-9][0-9])([0-9][0-9])$/i', $time, $reg)) { // Deprecated. Ex: 1970-01-01, 1970-01-01 01:00:00, 19700101010000
  2681. dol_print_error('', "Functions.lib::dol_print_date function called with a bad value from page ".(empty($_SERVER["PHP_SELF"]) ? 'unknown' : $_SERVER["PHP_SELF"]));
  2682. return '';
  2683. } elseif (preg_match('/^([0-9]+)\-([0-9]+)\-([0-9]+) ?([0-9]+)?:?([0-9]+)?:?([0-9]+)?/i', $time, $reg)) { // Still available to solve problems in extrafields of type date
  2684. // This part of code should not be used anymore.
  2685. dol_syslog("Functions.lib::dol_print_date function called with a bad value from page ".(empty($_SERVER["PHP_SELF"]) ? 'unknown' : $_SERVER["PHP_SELF"]), LOG_WARNING);
  2686. //if (function_exists('debug_print_backtrace')) debug_print_backtrace();
  2687. // Date has format 'YYYY-MM-DD' or 'YYYY-MM-DD HH:MM:SS'
  2688. $syear = (!empty($reg[1]) ? $reg[1] : '');
  2689. $smonth = (!empty($reg[2]) ? $reg[2] : '');
  2690. $sday = (!empty($reg[3]) ? $reg[3] : '');
  2691. $shour = (!empty($reg[4]) ? $reg[4] : '');
  2692. $smin = (!empty($reg[5]) ? $reg[5] : '');
  2693. $ssec = (!empty($reg[6]) ? $reg[6] : '');
  2694. $time = dol_mktime($shour, $smin, $ssec, $smonth, $sday, $syear, true);
  2695. if ($to_gmt) {
  2696. $tzo = new DateTimeZone('UTC'); // when to_gmt is true, base for offsettz and offsetdst (so timetouse) is UTC
  2697. } else {
  2698. $tzo = new DateTimeZone(date_default_timezone_get()); // when to_gmt is false, base for offsettz and offsetdst (so timetouse) is PHP server
  2699. }
  2700. $dtts = new DateTime();
  2701. $dtts->setTimestamp($time);
  2702. $dtts->setTimezone($tzo);
  2703. $newformat = str_replace(
  2704. array('%Y', '%y', '%m', '%d', '%H', '%I', '%M', '%S', '%p', 'T', 'Z', '__a__', '__A__', '__b__', '__B__'),
  2705. array('Y', 'y', 'm', 'd', 'H', 'h', 'i', 's', 'A', '__£__', '__$__', '__{__', '__}__', '__[__', '__]__'),
  2706. $format
  2707. );
  2708. $ret = $dtts->format($newformat);
  2709. $ret = str_replace(
  2710. array('__£__', '__$__', '__{__', '__}__', '__[__', '__]__'),
  2711. array('T', 'Z', '__a__', '__A__', '__b__', '__B__'),
  2712. $ret
  2713. );
  2714. } else {
  2715. // Date is a timestamps
  2716. if ($time < 100000000000) { // Protection against bad date values
  2717. $timetouse = $time + $offsettz + $offsetdst; // TODO We could be able to disable use of offsettz and offsetdst to use only offsettzstring.
  2718. if ($to_gmt) {
  2719. $tzo = new DateTimeZone('UTC'); // when to_gmt is true, base for offsettz and offsetdst (so timetouse) is UTC
  2720. } else {
  2721. $tzo = new DateTimeZone(date_default_timezone_get()); // when to_gmt is false, base for offsettz and offsetdst (so timetouse) is PHP server
  2722. }
  2723. $dtts = new DateTime();
  2724. $dtts->setTimestamp($timetouse);
  2725. $dtts->setTimezone($tzo);
  2726. $newformat = str_replace(
  2727. array('%Y', '%y', '%m', '%d', '%H', '%I', '%M', '%S', '%p', '%w', 'T', 'Z', '__a__', '__A__', '__b__', '__B__'),
  2728. array('Y', 'y', 'm', 'd', 'H', 'h', 'i', 's', 'A', 'w', '__£__', '__$__', '__{__', '__}__', '__[__', '__]__'),
  2729. $format
  2730. );
  2731. $ret = $dtts->format($newformat);
  2732. $ret = str_replace(
  2733. array('__£__', '__$__', '__{__', '__}__', '__[__', '__]__'),
  2734. array('T', 'Z', '__a__', '__A__', '__b__', '__B__'),
  2735. $ret
  2736. );
  2737. //var_dump($ret);exit;
  2738. } else {
  2739. $ret = 'Bad value '.$time.' for date';
  2740. }
  2741. }
  2742. if (preg_match('/__b__/i', $format)) {
  2743. $timetouse = $time + $offsettz + $offsetdst; // TODO We could be able to disable use of offsettz and offsetdst to use only offsettzstring.
  2744. if ($to_gmt) {
  2745. $tzo = new DateTimeZone('UTC'); // when to_gmt is true, base for offsettz and offsetdst (so timetouse) is UTC
  2746. } else {
  2747. $tzo = new DateTimeZone(date_default_timezone_get()); // when to_gmt is false, base for offsettz and offsetdst (so timetouse) is PHP server
  2748. }
  2749. $dtts = new DateTime();
  2750. $dtts->setTimestamp($timetouse);
  2751. $dtts->setTimezone($tzo);
  2752. $month = $dtts->format("m");
  2753. $month = sprintf("%02d", $month); // $month may be return with format '06' on some installation and '6' on other, so we force it to '06'.
  2754. if ($encodetooutput) {
  2755. $monthtext = $outputlangs->transnoentities('Month'.$month);
  2756. $monthtextshort = $outputlangs->transnoentities('MonthShort'.$month);
  2757. } else {
  2758. $monthtext = $outputlangs->transnoentitiesnoconv('Month'.$month);
  2759. $monthtextshort = $outputlangs->transnoentitiesnoconv('MonthShort'.$month);
  2760. }
  2761. //print 'monthtext='.$monthtext.' monthtextshort='.$monthtextshort;
  2762. $ret = str_replace('__b__', $monthtextshort, $ret);
  2763. $ret = str_replace('__B__', $monthtext, $ret);
  2764. //print 'x'.$outputlangs->charset_output.'-'.$ret.'x';
  2765. //return $ret;
  2766. }
  2767. if (preg_match('/__a__/i', $format)) {
  2768. //print "time=$time offsettz=$offsettz offsetdst=$offsetdst offsettzstring=$offsettzstring";
  2769. $timetouse = $time + $offsettz + $offsetdst; // TODO Replace this with function Date PHP. We also should not use anymore offsettz and offsetdst but only offsettzstring.
  2770. if ($to_gmt) {
  2771. $tzo = new DateTimeZone('UTC');
  2772. } else {
  2773. $tzo = new DateTimeZone(date_default_timezone_get());
  2774. }
  2775. $dtts = new DateTime();
  2776. $dtts->setTimestamp($timetouse);
  2777. $dtts->setTimezone($tzo);
  2778. $w = $dtts->format("w");
  2779. $dayweek = $outputlangs->transnoentitiesnoconv('Day'.$w);
  2780. $ret = str_replace('__A__', $dayweek, $ret);
  2781. $ret = str_replace('__a__', dol_substr($dayweek, 0, 3), $ret);
  2782. }
  2783. return $ret;
  2784. }
  2785. /**
  2786. * Return an array with locale date info.
  2787. * WARNING: This function use PHP server timezone by default to return locale informations.
  2788. * Be aware to add the third parameter to "UTC" if you need to work on UTC.
  2789. *
  2790. * @param int $timestamp Timestamp
  2791. * @param boolean $fast Fast mode. deprecated.
  2792. * @param string $forcetimezone '' to use the PHP server timezone. Or use a form like 'gmt', 'Europe/Paris' or '+0200' to force timezone.
  2793. * @return array Array of informations
  2794. * 'seconds' => $secs,
  2795. * 'minutes' => $min,
  2796. * 'hours' => $hour,
  2797. * 'mday' => $day,
  2798. * 'wday' => $dow, 0=sunday, 6=saturday
  2799. * 'mon' => $month,
  2800. * 'year' => $year,
  2801. * 'yday' => floor($secsInYear/$_day_power)
  2802. * '0' => original timestamp
  2803. * @see dol_print_date(), dol_stringtotime(), dol_mktime()
  2804. */
  2805. function dol_getdate($timestamp, $fast = false, $forcetimezone = '')
  2806. {
  2807. if ($timestamp === '') {
  2808. return array();
  2809. }
  2810. $datetimeobj = new DateTime();
  2811. $datetimeobj->setTimestamp($timestamp); // Use local PHP server timezone
  2812. if ($forcetimezone) {
  2813. $datetimeobj->setTimezone(new DateTimeZone($forcetimezone == 'gmt' ? 'UTC' : $forcetimezone)); // (add timezone relative to the date entered)
  2814. }
  2815. $arrayinfo = array(
  2816. 'year'=>((int) date_format($datetimeobj, 'Y')),
  2817. 'mon'=>((int) date_format($datetimeobj, 'm')),
  2818. 'mday'=>((int) date_format($datetimeobj, 'd')),
  2819. 'wday'=>((int) date_format($datetimeobj, 'w')),
  2820. 'yday'=>((int) date_format($datetimeobj, 'z')),
  2821. 'hours'=>((int) date_format($datetimeobj, 'H')),
  2822. 'minutes'=>((int) date_format($datetimeobj, 'i')),
  2823. 'seconds'=>((int) date_format($datetimeobj, 's')),
  2824. '0'=>$timestamp
  2825. );
  2826. return $arrayinfo;
  2827. }
  2828. /**
  2829. * Return a timestamp date built from detailed informations (by default a local PHP server timestamp)
  2830. * Replace function mktime not available under Windows if year < 1970
  2831. * PHP mktime is restricted to the years 1901-2038 on Unix and 1970-2038 on Windows
  2832. *
  2833. * @param int $hour Hour (can be -1 for undefined)
  2834. * @param int $minute Minute (can be -1 for undefined)
  2835. * @param int $second Second (can be -1 for undefined)
  2836. * @param int $month Month (1 to 12)
  2837. * @param int $day Day (1 to 31)
  2838. * @param int $year Year
  2839. * @param mixed $gm True or 1 or 'gmt'=Input informations are GMT values
  2840. * False or 0 or 'tzserver' = local to server TZ
  2841. * 'auto'
  2842. * 'tzuser' = local to user TZ taking dst into account at the current date. Not yet implemented.
  2843. * 'tzuserrel' = local to user TZ taking dst into account at the given date. Use this one to convert date input from user into a GMT date.
  2844. * 'tz,TimeZone' = use specified timezone
  2845. * @param int $check 0=No check on parameters (Can use day 32, etc...)
  2846. * @return int|string Date as a timestamp, '' or false if error
  2847. * @see dol_print_date(), dol_stringtotime(), dol_getdate()
  2848. */
  2849. function dol_mktime($hour, $minute, $second, $month, $day, $year, $gm = 'auto', $check = 1)
  2850. {
  2851. global $conf;
  2852. //print "- ".$hour.",".$minute.",".$second.",".$month.",".$day.",".$year.",".$_SERVER["WINDIR"]." -";
  2853. if ($gm === 'auto') {
  2854. $gm = (empty($conf) ? 'tzserver' : $conf->tzuserinputkey);
  2855. }
  2856. //print 'gm:'.$gm.' gm === auto:'.($gm === 'auto').'<br>';exit;
  2857. // Clean parameters
  2858. if ($hour == -1 || empty($hour)) {
  2859. $hour = 0;
  2860. }
  2861. if ($minute == -1 || empty($minute)) {
  2862. $minute = 0;
  2863. }
  2864. if ($second == -1 || empty($second)) {
  2865. $second = 0;
  2866. }
  2867. // Check parameters
  2868. if ($check) {
  2869. if (!$month || !$day) {
  2870. return '';
  2871. }
  2872. if ($day > 31) {
  2873. return '';
  2874. }
  2875. if ($month > 12) {
  2876. return '';
  2877. }
  2878. if ($hour < 0 || $hour > 24) {
  2879. return '';
  2880. }
  2881. if ($minute < 0 || $minute > 60) {
  2882. return '';
  2883. }
  2884. if ($second < 0 || $second > 60) {
  2885. return '';
  2886. }
  2887. }
  2888. if (empty($gm) || ($gm === 'server' || $gm === 'tzserver')) {
  2889. $default_timezone = @date_default_timezone_get(); // Example 'Europe/Berlin'
  2890. $localtz = new DateTimeZone($default_timezone);
  2891. } elseif ($gm === 'user' || $gm === 'tzuser' || $gm === 'tzuserrel') {
  2892. // We use dol_tz_string first because it is more reliable.
  2893. $default_timezone = (empty($_SESSION["dol_tz_string"]) ? @date_default_timezone_get() : $_SESSION["dol_tz_string"]); // Example 'Europe/Berlin'
  2894. try {
  2895. $localtz = new DateTimeZone($default_timezone);
  2896. } catch (Exception $e) {
  2897. dol_syslog("Warning dol_tz_string contains an invalid value ".$_SESSION["dol_tz_string"], LOG_WARNING);
  2898. $default_timezone = @date_default_timezone_get();
  2899. }
  2900. } elseif (strrpos($gm, "tz,") !== false) {
  2901. $timezone = str_replace("tz,", "", $gm); // Example 'tz,Europe/Berlin'
  2902. try {
  2903. $localtz = new DateTimeZone($timezone);
  2904. } catch (Exception $e) {
  2905. dol_syslog("Warning passed timezone contains an invalid value ".$timezone, LOG_WARNING);
  2906. }
  2907. }
  2908. if (empty($localtz)) {
  2909. $localtz = new DateTimeZone('UTC');
  2910. }
  2911. //var_dump($localtz);
  2912. //var_dump($year.'-'.$month.'-'.$day.'-'.$hour.'-'.$minute);
  2913. $dt = new DateTime('now', $localtz);
  2914. $dt->setDate((int) $year, (int) $month, (int) $day);
  2915. $dt->setTime((int) $hour, (int) $minute, (int) $second);
  2916. $date = $dt->getTimestamp(); // should include daylight saving time
  2917. //var_dump($date);
  2918. return $date;
  2919. }
  2920. /**
  2921. * Return date for now. In most cases, we use this function without parameters (that means GMT time).
  2922. *
  2923. * @param string $mode 'auto' => for backward compatibility (avoid this),
  2924. * 'gmt' => we return GMT timestamp,
  2925. * 'tzserver' => we add the PHP server timezone
  2926. * 'tzref' => we add the company timezone. Not implemented.
  2927. * 'tzuser' or 'tzuserrel' => we add the user timezone
  2928. * @return int $date Timestamp
  2929. */
  2930. function dol_now($mode = 'auto')
  2931. {
  2932. $ret = 0;
  2933. if ($mode === 'auto') {
  2934. $mode = 'gmt';
  2935. }
  2936. if ($mode == 'gmt') {
  2937. $ret = time(); // Time for now at greenwich.
  2938. } elseif ($mode == 'tzserver') { // Time for now with PHP server timezone added
  2939. require_once DOL_DOCUMENT_ROOT.'/core/lib/date.lib.php';
  2940. $tzsecond = getServerTimeZoneInt('now'); // Contains tz+dayling saving time
  2941. $ret = (int) (dol_now('gmt') + ($tzsecond * 3600));
  2942. //} elseif ($mode == 'tzref') {// Time for now with parent company timezone is added
  2943. // require_once DOL_DOCUMENT_ROOT.'/core/lib/date.lib.php';
  2944. // $tzsecond=getParentCompanyTimeZoneInt(); // Contains tz+dayling saving time
  2945. // $ret=dol_now('gmt')+($tzsecond*3600);
  2946. //}
  2947. } elseif ($mode == 'tzuser' || $mode == 'tzuserrel') {
  2948. // Time for now with user timezone added
  2949. //print 'time: '.time();
  2950. $offsettz = (empty($_SESSION['dol_tz']) ? 0 : $_SESSION['dol_tz']) * 60 * 60;
  2951. $offsetdst = (empty($_SESSION['dol_dst']) ? 0 : $_SESSION['dol_dst']) * 60 * 60;
  2952. $ret = (int) (dol_now('gmt') + ($offsettz + $offsetdst));
  2953. }
  2954. return $ret;
  2955. }
  2956. /**
  2957. * Return string with formated size
  2958. *
  2959. * @param int $size Size to print
  2960. * @param int $shortvalue Tell if we want long value to use another unit (Ex: 1.5Kb instead of 1500b)
  2961. * @param int $shortunit Use short label of size unit (for example 'b' instead of 'bytes')
  2962. * @return string Link
  2963. */
  2964. function dol_print_size($size, $shortvalue = 0, $shortunit = 0)
  2965. {
  2966. global $conf, $langs;
  2967. $level = 1024;
  2968. if (!empty($conf->dol_optimize_smallscreen)) {
  2969. $shortunit = 1;
  2970. }
  2971. // Set value text
  2972. if (empty($shortvalue) || $size < ($level * 10)) {
  2973. $ret = $size;
  2974. $textunitshort = $langs->trans("b");
  2975. $textunitlong = $langs->trans("Bytes");
  2976. } else {
  2977. $ret = round($size / $level, 0);
  2978. $textunitshort = $langs->trans("Kb");
  2979. $textunitlong = $langs->trans("KiloBytes");
  2980. }
  2981. // Use long or short text unit
  2982. if (empty($shortunit)) {
  2983. $ret .= ' '.$textunitlong;
  2984. } else {
  2985. $ret .= ' '.$textunitshort;
  2986. }
  2987. return $ret;
  2988. }
  2989. /**
  2990. * Show Url link
  2991. *
  2992. * @param string $url Url to show
  2993. * @param string $target Target for link
  2994. * @param int $max Max number of characters to show
  2995. * @param int $withpicto With picto
  2996. * @param string $morecss More CSS
  2997. * @return string HTML Link
  2998. */
  2999. function dol_print_url($url, $target = '_blank', $max = 32, $withpicto = 0, $morecss = '')
  3000. {
  3001. global $langs;
  3002. if (empty($url)) {
  3003. return '';
  3004. }
  3005. $linkstart = '<a href="';
  3006. if (!preg_match('/^http/i', $url)) {
  3007. $linkstart .= 'http://';
  3008. }
  3009. $linkstart .= $url;
  3010. $linkstart .= '"';
  3011. if ($target) {
  3012. $linkstart .= ' target="'.$target.'"';
  3013. }
  3014. $linkstart .= ' title="'.$langs->trans("URL").': '.$url.'"';
  3015. $linkstart .= '>';
  3016. $link = '';
  3017. if (!preg_match('/^http/i', $url)) {
  3018. $link .= 'http://';
  3019. }
  3020. $link .= dol_trunc($url, $max);
  3021. $linkend = '</a>';
  3022. if ($morecss == 'float') { // deprecated
  3023. return '<div class="nospan'.($morecss ? ' '.$morecss : '').'" style="margin-right: 10px">'.($withpicto ? img_picto($langs->trans("Url"), 'globe', 'class="paddingrightonly"') : '').$link.'</div>';
  3024. } else {
  3025. return $linkstart.'<span class="nospan'.($morecss ? ' '.$morecss : '').'" style="margin-right: 10px">'.($withpicto ? img_picto('', 'globe', 'class="paddingrightonly"') : '').$link.'</span>'.$linkend;
  3026. }
  3027. }
  3028. /**
  3029. * Show EMail link formatted for HTML output.
  3030. *
  3031. * @param string $email EMail to show (only email, without 'Name of recipient' before)
  3032. * @param int $cid Id of contact if known
  3033. * @param int $socid Id of third party if known
  3034. * @param int $addlink 0=no link, 1=email has a html email link (+ link to create action if constant AGENDA_ADDACTIONFOREMAIL is on)
  3035. * @param int $max Max number of characters to show
  3036. * @param int $showinvalid 1=Show warning if syntax email is wrong
  3037. * @param int|string $withpicto Show picto
  3038. * @return string HTML Link
  3039. */
  3040. function dol_print_email($email, $cid = 0, $socid = 0, $addlink = 0, $max = 64, $showinvalid = 1, $withpicto = 0)
  3041. {
  3042. global $user, $langs, $hookmanager;
  3043. //global $conf; $conf->global->AGENDA_ADDACTIONFOREMAIL = 1;
  3044. //$showinvalid = 1; $email = 'rrrrr';
  3045. $newemail = dol_escape_htmltag($email);
  3046. if (getDolGlobalString('MAIN_OPTIMIZEFORTEXTBROWSER') && $withpicto) {
  3047. $withpicto = 0;
  3048. }
  3049. if (empty($email)) {
  3050. return '&nbsp;';
  3051. }
  3052. if (!empty($addlink)) {
  3053. $newemail = '<a class="paddingrightonly" style="text-overflow: ellipsis;" href="';
  3054. if (!preg_match('/^mailto:/i', $email)) {
  3055. $newemail .= 'mailto:';
  3056. }
  3057. $newemail .= $email;
  3058. $newemail .= '">';
  3059. $newemail .= ($withpicto ? img_picto($langs->trans("EMail").' : '.$email, (is_numeric($withpicto) ? 'email' : $withpicto), 'class="paddingrightonly"') : '');
  3060. $newemail .= dol_trunc($email, $max);
  3061. $newemail .= '</a>';
  3062. if ($showinvalid && !isValidEmail($email)) {
  3063. $langs->load("errors");
  3064. $newemail .= img_warning($langs->trans("ErrorBadEMail", $email), '', 'paddingrightonly');
  3065. }
  3066. if (($cid || $socid) && isModEnabled('agenda') && $user->hasRight("agenda", "myactions", "create")) {
  3067. $type = 'AC_EMAIL';
  3068. $linktoaddaction = '';
  3069. if (getDolGlobalString('AGENDA_ADDACTIONFOREMAIL')) {
  3070. $linktoaddaction = '<a href="'.DOL_URL_ROOT.'/comm/action/card.php?action=create&amp;backtopage=1&amp;actioncode='.urlencode($type).'&amp;contactid='.((int) $cid).'&amp;socid='.((int) $socid).'">'.img_object($langs->trans("AddAction"), "calendar").'</a>';
  3071. }
  3072. if ($linktoaddaction) {
  3073. $newemail = '<div>'.$newemail.' '.$linktoaddaction.'</div>';
  3074. }
  3075. }
  3076. } else {
  3077. $newemail = ($withpicto ? img_picto($langs->trans("EMail").' : '.$email, (is_numeric($withpicto) ? 'email' : $withpicto), 'class="paddingrightonly"') : '').$newemail;
  3078. if ($showinvalid && !isValidEmail($email)) {
  3079. $langs->load("errors");
  3080. $newemail .= img_warning($langs->trans("ErrorBadEMail", $email));
  3081. }
  3082. }
  3083. //$rep = '<div class="nospan" style="margin-right: 10px">';
  3084. //$rep = ($withpicto ? img_picto($langs->trans("EMail").' : '.$email, (is_numeric($withpicto) ? 'email' : $withpicto), 'class="paddingrightonly"') : '').$newemail;
  3085. //$rep .= '</div>';
  3086. $rep = $newemail;
  3087. if ($hookmanager) {
  3088. $parameters = array('cid' => $cid, 'socid' => $socid, 'addlink' => $addlink, 'picto' => $withpicto);
  3089. $reshook = $hookmanager->executeHooks('printEmail', $parameters, $email);
  3090. if ($reshook > 0) {
  3091. $rep = '';
  3092. }
  3093. $rep .= $hookmanager->resPrint;
  3094. }
  3095. return $rep;
  3096. }
  3097. /**
  3098. * Get array of social network dictionary
  3099. *
  3100. * @return array Array of Social Networks Dictionary
  3101. */
  3102. function getArrayOfSocialNetworks()
  3103. {
  3104. global $conf, $db;
  3105. $socialnetworks = array();
  3106. // Enable caching of array
  3107. require_once DOL_DOCUMENT_ROOT.'/core/lib/memory.lib.php';
  3108. $cachekey = 'socialnetworks_' . $conf->entity;
  3109. $dataretrieved = dol_getcache($cachekey);
  3110. if (!is_null($dataretrieved)) {
  3111. $socialnetworks = $dataretrieved;
  3112. } else {
  3113. $sql = "SELECT rowid, code, label, url, icon, active FROM ".MAIN_DB_PREFIX."c_socialnetworks";
  3114. $sql .= " WHERE entity=".$conf->entity;
  3115. $resql = $db->query($sql);
  3116. if ($resql) {
  3117. while ($obj = $db->fetch_object($resql)) {
  3118. $socialnetworks[$obj->code] = array(
  3119. 'rowid' => $obj->rowid,
  3120. 'label' => $obj->label,
  3121. 'url' => $obj->url,
  3122. 'icon' => $obj->icon,
  3123. 'active' => $obj->active,
  3124. );
  3125. }
  3126. }
  3127. dol_setcache($cachekey, $socialnetworks); // If setting cache fails, this is not a problem, so we do not test result.
  3128. }
  3129. return $socialnetworks;
  3130. }
  3131. /**
  3132. * Show social network link
  3133. *
  3134. * @param string $value Social network ID to show (only skype, without 'Name of recipient' before)
  3135. * @param int $cid Id of contact if known
  3136. * @param int $socid Id of third party if known
  3137. * @param string $type 'skype','facebook',...
  3138. * @param array $dictsocialnetworks List of socialnetworks availables
  3139. * @return string HTML Link
  3140. */
  3141. function dol_print_socialnetworks($value, $cid, $socid, $type, $dictsocialnetworks = array())
  3142. {
  3143. global $conf, $user, $langs;
  3144. $htmllink = $value;
  3145. if (empty($value)) {
  3146. return '&nbsp;';
  3147. }
  3148. if (!empty($type)) {
  3149. $htmllink = '<div class="divsocialnetwork inline-block valignmiddle">';
  3150. // Use dictionary definition for picto $dictsocialnetworks[$type]['icon']
  3151. $htmllink .= '<span class="fab pictofixedwidth '.($dictsocialnetworks[$type]['icon'] ? $dictsocialnetworks[$type]['icon'] : 'fa-link').'"></span>';
  3152. if ($type == 'skype') {
  3153. $htmllink .= dol_escape_htmltag($value);
  3154. $htmllink .= '&nbsp; <a href="skype:';
  3155. $htmllink .= dol_string_nospecial($value, '_', '', array('@'));
  3156. $htmllink .= '?call" alt="'.$langs->trans("Call").'&nbsp;'.$value.'" title="'.dol_escape_htmltag($langs->trans("Call").' '.$value).'">';
  3157. $htmllink .= '<img src="'.DOL_URL_ROOT.'/theme/common/skype_callbutton.png" border="0">';
  3158. $htmllink .= '</a><a href="skype:';
  3159. $htmllink .= dol_string_nospecial($value, '_', '', array('@'));
  3160. $htmllink .= '?chat" alt="'.$langs->trans("Chat").'&nbsp;'.$value.'" title="'.dol_escape_htmltag($langs->trans("Chat").' '.$value).'">';
  3161. $htmllink .= '<img class="paddingleft" src="'.DOL_URL_ROOT.'/theme/common/skype_chatbutton.png" border="0">';
  3162. $htmllink .= '</a>';
  3163. if (($cid || $socid) && isModEnabled('agenda') && $user->hasRight('agenda', 'myactions', 'create')) {
  3164. $addlink = 'AC_SKYPE';
  3165. $link = '';
  3166. if (getDolGlobalString('AGENDA_ADDACTIONFORSKYPE')) {
  3167. $link = '<a href="'.DOL_URL_ROOT.'/comm/action/card.php?action=create&amp;backtopage=1&amp;actioncode='.$addlink.'&amp;contactid='.$cid.'&amp;socid='.$socid.'">'.img_object($langs->trans("AddAction"), "calendar").'</a>';
  3168. }
  3169. $htmllink .= ($link ? ' '.$link : '');
  3170. }
  3171. } else {
  3172. $networkconstname = 'MAIN_INFO_SOCIETE_'.strtoupper($type).'_URL';
  3173. if (getDolGlobalString($networkconstname)) {
  3174. $link = str_replace('{socialid}', $value, getDolGlobalString($networkconstname));
  3175. if (preg_match('/^https?:\/\//i', $link)) {
  3176. $htmllink .= '<a href="'.dol_sanitizeUrl($link, 0).'" target="_blank" rel="noopener noreferrer">'.dol_escape_htmltag($value).'</a>';
  3177. } else {
  3178. $htmllink .= '<a href="'.dol_sanitizeUrl($link, 1).'" target="_blank" rel="noopener noreferrer">'.dol_escape_htmltag($value).'</a>';
  3179. }
  3180. } elseif (!empty($dictsocialnetworks[$type]['url'])) {
  3181. $tmpvirginurl = preg_replace('/\/?{socialid}/', '', $dictsocialnetworks[$type]['url']);
  3182. if ($tmpvirginurl) {
  3183. $value = preg_replace('/^www\.'.preg_quote($tmpvirginurl, '/').'\/?/', '', $value);
  3184. $value = preg_replace('/^'.preg_quote($tmpvirginurl, '/').'\/?/', '', $value);
  3185. $tmpvirginurl3 = preg_replace('/^https:\/\//i', 'https://www.', $tmpvirginurl);
  3186. if ($tmpvirginurl3) {
  3187. $value = preg_replace('/^www\.'.preg_quote($tmpvirginurl3, '/').'\/?/', '', $value);
  3188. $value = preg_replace('/^'.preg_quote($tmpvirginurl3, '/').'\/?/', '', $value);
  3189. }
  3190. $tmpvirginurl2 = preg_replace('/^https?:\/\//i', '', $tmpvirginurl);
  3191. if ($tmpvirginurl2) {
  3192. $value = preg_replace('/^www\.'.preg_quote($tmpvirginurl2, '/').'\/?/', '', $value);
  3193. $value = preg_replace('/^'.preg_quote($tmpvirginurl2, '/').'\/?/', '', $value);
  3194. }
  3195. }
  3196. $link = str_replace('{socialid}', $value, $dictsocialnetworks[$type]['url']);
  3197. if (preg_match('/^https?:\/\//i', $link)) {
  3198. $htmllink .= '<a href="'.dol_sanitizeUrl($link, 0).'" target="_blank" rel="noopener noreferrer">'.dol_escape_htmltag($value).'</a>';
  3199. } else {
  3200. $htmllink .= '<a href="'.dol_sanitizeUrl($link, 1).'" target="_blank" rel="noopener noreferrer">'.dol_escape_htmltag($value).'</a>';
  3201. }
  3202. } else {
  3203. $htmllink .= dol_escape_htmltag($value);
  3204. }
  3205. }
  3206. $htmllink .= '</div>';
  3207. } else {
  3208. $langs->load("errors");
  3209. $htmllink .= img_warning($langs->trans("ErrorBadSocialNetworkValue", $value));
  3210. }
  3211. return $htmllink;
  3212. }
  3213. /**
  3214. * Format professional IDs according to their country
  3215. *
  3216. * @param string $profID Value of profID to format
  3217. * @param string $profIDtype Type of profID to format ('1', '2', '3', '4', '5', '6' or 'VAT')
  3218. * @param string $countrycode Country code to use for formatting
  3219. * @param int $addcpButton Add button to copy to clipboard (1 => show only on hoover ; 2 => always display )
  3220. * @return string Formated profID
  3221. */
  3222. function dol_print_profids($profID, $profIDtype, $countrycode = '', $addcpButton = 1)
  3223. {
  3224. global $mysoc;
  3225. if (empty($profID) || empty($profIDtype)) {
  3226. return '';
  3227. }
  3228. if (empty($countrycode)) {
  3229. $countrycode = $mysoc->country_code;
  3230. }
  3231. $newProfID = $profID;
  3232. $id = substr($profIDtype, -1);
  3233. $ret = '';
  3234. if (strtoupper($countrycode) == 'FR') {
  3235. // France
  3236. // (see https://www.economie.gouv.fr/entreprises/numeros-identification-entreprise)
  3237. if ($id == 1 && dol_strlen($newProfID) == 9) {
  3238. // SIREN (ex: 123 123 123)
  3239. $newProfID = substr($newProfID, 0, 3).' '.substr($newProfID, 3, 3).' '.substr($newProfID, 6, 3);
  3240. }
  3241. if ($id == 2 && dol_strlen($newProfID) == 14) {
  3242. // SIRET (ex: 123 123 123 12345)
  3243. $newProfID = substr($newProfID, 0, 3).' '.substr($newProfID, 3, 3).' '.substr($newProfID, 6, 3).' '.substr($newProfID, 9, 5);
  3244. }
  3245. if ($id == 3 && dol_strlen($newProfID) == 5) {
  3246. // NAF/APE (ex: 69.20Z)
  3247. $newProfID = substr($newProfID, 0, 2).'.'.substr($newProfID, 2, 3);
  3248. }
  3249. if ($profIDtype === 'VAT' && dol_strlen($newProfID) == 13) {
  3250. // TVA intracommunautaire (ex: FR12 123 123 123)
  3251. $newProfID = substr($newProfID, 0, 4).' '.substr($newProfID, 4, 3).' '.substr($newProfID, 7, 3).' '.substr($newProfID, 10, 3);
  3252. }
  3253. }
  3254. if (!empty($addcpButton)) {
  3255. $ret = showValueWithClipboardCPButton(dol_escape_htmltag($profID), ($addcpButton == 1 ? 1 : 0), $newProfID);
  3256. } else {
  3257. $ret = $newProfID;
  3258. }
  3259. return $ret;
  3260. }
  3261. /**
  3262. * Format phone numbers according to country
  3263. *
  3264. * @param string $phone Phone number to format
  3265. * @param string $countrycode Country code to use for formatting
  3266. * @param int $cid Id of contact if known
  3267. * @param int $socid Id of third party if known
  3268. * @param string $addlink ''=no link to create action, 'AC_TEL'=add link to clicktodial (if module enabled) and add link to create event (if conf->global->AGENDA_ADDACTIONFORPHONE set), 'tel'=Force "tel:..." link
  3269. * @param string $separ Separation between numbers for a better visibility example : xx.xx.xx.xx.xx. You can also use 'hidenum' to hide the number, keep only the picto.
  3270. * @param string $withpicto Show picto ('fax', 'phone', 'mobile')
  3271. * @param string $titlealt Text to show on alt
  3272. * @param int $adddivfloat Add div float around phone.
  3273. * @return string Formated phone number
  3274. */
  3275. function dol_print_phone($phone, $countrycode = '', $cid = 0, $socid = 0, $addlink = '', $separ = "&nbsp;", $withpicto = '', $titlealt = '', $adddivfloat = 0)
  3276. {
  3277. global $conf, $user, $langs, $mysoc, $hookmanager;
  3278. // Clean phone parameter
  3279. $phone = is_null($phone) ? '' : preg_replace("/[\s.-]/", "", trim($phone));
  3280. if (empty($phone)) {
  3281. return '';
  3282. }
  3283. if (getDolGlobalString('MAIN_PHONE_SEPAR')) {
  3284. $separ = $conf->global->MAIN_PHONE_SEPAR;
  3285. }
  3286. if (empty($countrycode) && is_object($mysoc)) {
  3287. $countrycode = $mysoc->country_code;
  3288. }
  3289. // Short format for small screens
  3290. if ($conf->dol_optimize_smallscreen) {
  3291. $separ = '';
  3292. }
  3293. $newphone = $phone;
  3294. if (strtoupper($countrycode) == "FR") {
  3295. // France
  3296. if (dol_strlen($phone) == 10) {
  3297. $newphone = substr($newphone, 0, 2).$separ.substr($newphone, 2, 2).$separ.substr($newphone, 4, 2).$separ.substr($newphone, 6, 2).$separ.substr($newphone, 8, 2);
  3298. } elseif (dol_strlen($phone) == 7) {
  3299. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 2).$separ.substr($newphone, 5, 2);
  3300. } elseif (dol_strlen($phone) == 9) {
  3301. $newphone = substr($newphone, 0, 2).$separ.substr($newphone, 2, 3).$separ.substr($newphone, 5, 2).$separ.substr($newphone, 7, 2);
  3302. } elseif (dol_strlen($phone) == 11) {
  3303. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 2).$separ.substr($newphone, 5, 2).$separ.substr($newphone, 7, 2).$separ.substr($newphone, 9, 2);
  3304. } elseif (dol_strlen($phone) == 12) {
  3305. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 1).$separ.substr($newphone, 4, 2).$separ.substr($newphone, 6, 2).$separ.substr($newphone, 8, 2).$separ.substr($newphone, 10, 2);
  3306. } elseif (dol_strlen($phone) == 13) {
  3307. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 2).$separ.substr($newphone, 6, 2).$separ.substr($newphone, 8, 3).$separ.substr($newphone, 11, 2);
  3308. }
  3309. } elseif (strtoupper($countrycode) == "CA") {
  3310. if (dol_strlen($phone) == 10) {
  3311. $newphone = ($separ != '' ? '(' : '').substr($newphone, 0, 3).($separ != '' ? ')' : '').$separ.substr($newphone, 3, 3).($separ != '' ? '-' : '').substr($newphone, 6, 4);
  3312. }
  3313. } elseif (strtoupper($countrycode) == "PT") {//Portugal
  3314. if (dol_strlen($phone) == 13) {//ex: +351_ABC_DEF_GHI
  3315. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 3).$separ.substr($newphone, 7, 3).$separ.substr($newphone, 10, 3);
  3316. }
  3317. } elseif (strtoupper($countrycode) == "SR") {//Suriname
  3318. if (dol_strlen($phone) == 10) {//ex: +597_ABC_DEF
  3319. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 3).$separ.substr($newphone, 7, 3);
  3320. } elseif (dol_strlen($phone) == 11) {//ex: +597_ABC_DEFG
  3321. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 3).$separ.substr($newphone, 7, 4);
  3322. }
  3323. } elseif (strtoupper($countrycode) == "DE") {//Allemagne
  3324. if (dol_strlen($phone) == 14) {//ex: +49_ABCD_EFGH_IJK
  3325. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 4).$separ.substr($newphone, 7, 4).$separ.substr($newphone, 11, 3);
  3326. } elseif (dol_strlen($phone) == 13) {//ex: +49_ABC_DEFG_HIJ
  3327. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 3).$separ.substr($newphone, 6, 4).$separ.substr($newphone, 10, 3);
  3328. }
  3329. } elseif (strtoupper($countrycode) == "ES") {//Espagne
  3330. if (dol_strlen($phone) == 12) {//ex: +34_ABC_DEF_GHI
  3331. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 3).$separ.substr($newphone, 6, 3).$separ.substr($newphone, 9, 3);
  3332. }
  3333. } elseif (strtoupper($countrycode) == "BF") {// Burkina Faso
  3334. if (dol_strlen($phone) == 12) {//ex : +22 A BC_DE_FG_HI
  3335. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 1).$separ.substr($newphone, 4, 2).$separ.substr($newphone, 6, 2).$separ.substr($newphone, 8, 2).$separ.substr($newphone, 10, 2);
  3336. }
  3337. } elseif (strtoupper($countrycode) == "RO") {// Roumanie
  3338. if (dol_strlen($phone) == 12) {//ex : +40 AB_CDE_FG_HI
  3339. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 2).$separ.substr($newphone, 5, 3).$separ.substr($newphone, 8, 2).$separ.substr($newphone, 10, 2);
  3340. }
  3341. } elseif (strtoupper($countrycode) == "TR") {//Turquie
  3342. if (dol_strlen($phone) == 13) {//ex : +90 ABC_DEF_GHIJ
  3343. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 3).$separ.substr($newphone, 6, 3).$separ.substr($newphone, 9, 4);
  3344. }
  3345. } elseif (strtoupper($countrycode) == "US") {//Etat-Unis
  3346. if (dol_strlen($phone) == 12) {//ex: +1 ABC_DEF_GHIJ
  3347. $newphone = substr($newphone, 0, 2).$separ.substr($newphone, 2, 3).$separ.substr($newphone, 5, 3).$separ.substr($newphone, 8, 4);
  3348. }
  3349. } elseif (strtoupper($countrycode) == "MX") {//Mexique
  3350. if (dol_strlen($phone) == 12) {//ex: +52 ABCD_EFG_HI
  3351. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 4).$separ.substr($newphone, 7, 3).$separ.substr($newphone, 10, 2);
  3352. } elseif (dol_strlen($phone) == 11) {//ex: +52 AB_CD_EF_GH
  3353. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 2).$separ.substr($newphone, 5, 2).$separ.substr($newphone, 7, 2).$separ.substr($newphone, 9, 2);
  3354. } elseif (dol_strlen($phone) == 13) {//ex: +52 ABC_DEF_GHIJ
  3355. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 3).$separ.substr($newphone, 6, 3).$separ.substr($newphone, 9, 4);
  3356. }
  3357. } elseif (strtoupper($countrycode) == "ML") {//Mali
  3358. if (dol_strlen($phone) == 12) {//ex: +223 AB_CD_EF_GH
  3359. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 2).$separ.substr($newphone, 6, 2).$separ.substr($newphone, 8, 2).$separ.substr($newphone, 10, 2);
  3360. }
  3361. } elseif (strtoupper($countrycode) == "TH") {//Thaïlande
  3362. if (dol_strlen($phone) == 11) {//ex: +66_ABC_DE_FGH
  3363. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 3).$separ.substr($newphone, 6, 2).$separ.substr($newphone, 8, 3);
  3364. } elseif (dol_strlen($phone) == 12) {//ex: +66_A_BCD_EF_GHI
  3365. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 1).$separ.substr($newphone, 4, 3).$separ.substr($newphone, 7, 2).$separ.substr($newphone, 9, 3);
  3366. }
  3367. } elseif (strtoupper($countrycode) == "MU") {
  3368. //Maurice
  3369. if (dol_strlen($phone) == 11) {//ex: +230_ABC_DE_FG
  3370. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 3).$separ.substr($newphone, 7, 2).$separ.substr($newphone, 9, 2);
  3371. } elseif (dol_strlen($phone) == 12) {//ex: +230_ABCD_EF_GH
  3372. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 4).$separ.substr($newphone, 8, 2).$separ.substr($newphone, 10, 2);
  3373. }
  3374. } elseif (strtoupper($countrycode) == "ZA") {//Afrique du sud
  3375. if (dol_strlen($phone) == 12) {//ex: +27_AB_CDE_FG_HI
  3376. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 2).$separ.substr($newphone, 5, 3).$separ.substr($newphone, 8, 2).$separ.substr($newphone, 10, 2);
  3377. }
  3378. } elseif (strtoupper($countrycode) == "SY") {//Syrie
  3379. if (dol_strlen($phone) == 12) {//ex: +963_AB_CD_EF_GH
  3380. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 2).$separ.substr($newphone, 6, 2).$separ.substr($newphone, 8, 2).$separ.substr($newphone, 10, 2);
  3381. } elseif (dol_strlen($phone) == 13) {//ex: +963_AB_CD_EF_GHI
  3382. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 2).$separ.substr($newphone, 6, 2).$separ.substr($newphone, 8, 2).$separ.substr($newphone, 10, 3);
  3383. }
  3384. } elseif (strtoupper($countrycode) == "AE") {//Emirats Arabes Unis
  3385. if (dol_strlen($phone) == 12) {//ex: +971_ABC_DEF_GH
  3386. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 3).$separ.substr($newphone, 7, 3).$separ.substr($newphone, 10, 2);
  3387. } elseif (dol_strlen($phone) == 13) {//ex: +971_ABC_DEF_GHI
  3388. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 3).$separ.substr($newphone, 7, 3).$separ.substr($newphone, 10, 3);
  3389. } elseif (dol_strlen($phone) == 14) {//ex: +971_ABC_DEF_GHIK
  3390. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 3).$separ.substr($newphone, 7, 3).$separ.substr($newphone, 10, 4);
  3391. }
  3392. } elseif (strtoupper($countrycode) == "DZ") {//Algérie
  3393. if (dol_strlen($phone) == 13) {//ex: +213_ABC_DEF_GHI
  3394. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 3).$separ.substr($newphone, 7, 3).$separ.substr($newphone, 10, 3);
  3395. }
  3396. } elseif (strtoupper($countrycode) == "BE") {//Belgique
  3397. if (dol_strlen($phone) == 11) {//ex: +32_ABC_DE_FGH
  3398. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 3).$separ.substr($newphone, 6, 2).$separ.substr($newphone, 8, 3);
  3399. } elseif (dol_strlen($phone) == 12) {//ex: +32_ABC_DEF_GHI
  3400. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 3).$separ.substr($newphone, 6, 3).$separ.substr($newphone, 9, 3);
  3401. }
  3402. } elseif (strtoupper($countrycode) == "PF") {//Polynésie française
  3403. if (dol_strlen($phone) == 12) {//ex: +689_AB_CD_EF_GH
  3404. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 2).$separ.substr($newphone, 6, 2).$separ.substr($newphone, 8, 2).$separ.substr($newphone, 10, 2);
  3405. }
  3406. } elseif (strtoupper($countrycode) == "CO") {//Colombie
  3407. if (dol_strlen($phone) == 13) {//ex: +57_ABC_DEF_GH_IJ
  3408. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 3).$separ.substr($newphone, 6, 3).$separ.substr($newphone, 9, 2).$separ.substr($newphone, 11, 2);
  3409. }
  3410. } elseif (strtoupper($countrycode) == "JO") {//Jordanie
  3411. if (dol_strlen($phone) == 12) {//ex: +962_A_BCD_EF_GH
  3412. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 1).$separ.substr($newphone, 5, 3).$separ.substr($newphone, 7, 2).$separ.substr($newphone, 9, 2);
  3413. }
  3414. } elseif (strtoupper($countrycode) == "JM") {//Jamaïque
  3415. if (dol_strlen($newphone) == 12) {//ex: +1867_ABC_DEFG
  3416. $newphone = substr($newphone, 0, 5).$separ.substr($newphone, 5, 3).$separ.substr($newphone, 8, 4);
  3417. }
  3418. } elseif (strtoupper($countrycode) == "MG") {//Madagascar
  3419. if (dol_strlen($phone) == 13) {//ex: +261_AB_CD_EFG_HI
  3420. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 2).$separ.substr($newphone, 6, 2).$separ.substr($newphone, 8, 3).$separ.substr($newphone, 11, 2);
  3421. }
  3422. } elseif (strtoupper($countrycode) == "GB") {//Royaume uni
  3423. if (dol_strlen($phone) == 13) {//ex: +44_ABCD_EFG_HIJ
  3424. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 4).$separ.substr($newphone, 7, 3).$separ.substr($newphone, 10, 3);
  3425. }
  3426. } elseif (strtoupper($countrycode) == "CH") {//Suisse
  3427. if (dol_strlen($phone) == 12) {//ex: +41_AB_CDE_FG_HI
  3428. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 2).$separ.substr($newphone, 5, 3).$separ.substr($newphone, 8, 2).$separ.substr($newphone, 10, 2);
  3429. } elseif (dol_strlen($phone) == 15) {// +41_AB_CDE_FGH_IJKL
  3430. $newphone = $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 2).$separ.substr($newphone, 5, 3).$separ.substr($newphone, 8, 3).$separ.substr($newphone, 11, 4);
  3431. }
  3432. } elseif (strtoupper($countrycode) == "TN") {//Tunisie
  3433. if (dol_strlen($phone) == 12) {//ex: +216_AB_CDE_FGH
  3434. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 2).$separ.substr($newphone, 6, 3).$separ.substr($newphone, 9, 3);
  3435. }
  3436. } elseif (strtoupper($countrycode) == "GF") {//Guyane francaise
  3437. if (dol_strlen($phone) == 13) {//ex: +594_ABC_DE_FG_HI (ABC=594 de nouveau)
  3438. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 3).$separ.substr($newphone, 7, 2).$separ.substr($newphone, 9, 2).$separ.substr($newphone, 11, 2);
  3439. }
  3440. } elseif (strtoupper($countrycode) == "GP") {//Guadeloupe
  3441. if (dol_strlen($phone) == 13) {//ex: +590_ABC_DE_FG_HI (ABC=590 de nouveau)
  3442. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 3).$separ.substr($newphone, 7, 2).$separ.substr($newphone, 9, 2).$separ.substr($newphone, 11, 2);
  3443. }
  3444. } elseif (strtoupper($countrycode) == "MQ") {//Martinique
  3445. if (dol_strlen($phone) == 13) {//ex: +596_ABC_DE_FG_HI (ABC=596 de nouveau)
  3446. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 3).$separ.substr($newphone, 7, 2).$separ.substr($newphone, 9, 2).$separ.substr($newphone, 11, 2);
  3447. }
  3448. } elseif (strtoupper($countrycode) == "IT") {//Italie
  3449. if (dol_strlen($phone) == 12) {//ex: +39_ABC_DEF_GHI
  3450. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 3).$separ.substr($newphone, 6, 3).$separ.substr($newphone, 9, 3);
  3451. } elseif (dol_strlen($phone) == 13) {//ex: +39_ABC_DEF_GH_IJ
  3452. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 3).$separ.substr($newphone, 6, 3).$separ.substr($newphone, 9, 2).$separ.substr($newphone, 11, 2);
  3453. }
  3454. } elseif (strtoupper($countrycode) == "AU") {
  3455. //Australie
  3456. if (dol_strlen($phone) == 12) {
  3457. //ex: +61_A_BCDE_FGHI
  3458. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 1).$separ.substr($newphone, 4, 4).$separ.substr($newphone, 8, 4);
  3459. }
  3460. } elseif (strtoupper($countrycode) == "LU") {
  3461. // Luxembourg
  3462. if (dol_strlen($phone) == 10) {// fixe 6 chiffres +352_AA_BB_CC
  3463. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 2).$separ.substr($newphone, 6, 2).$separ.substr($newphone, 8, 2);
  3464. } elseif (dol_strlen($phone) == 11) {// fixe 7 chiffres +352_AA_BB_CC_D
  3465. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 2).$separ.substr($newphone, 6, 2).$separ.substr($newphone, 8, 2).$separ.substr($newphone, 10, 1);
  3466. } elseif (dol_strlen($phone) == 12) {// fixe 8 chiffres +352_AA_BB_CC_DD
  3467. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 2).$separ.substr($newphone, 6, 2).$separ.substr($newphone, 8, 2).$separ.substr($newphone, 10, 2);
  3468. } elseif (dol_strlen($phone) == 13) {// mobile +352_AAA_BB_CC_DD
  3469. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 3).$separ.substr($newphone, 7, 2).$separ.substr($newphone, 9, 2).$separ.substr($newphone, 11, 2);
  3470. }
  3471. }
  3472. $newphoneastart = $newphoneaend = '';
  3473. if (!empty($addlink)) { // Link on phone number (+ link to add action if conf->global->AGENDA_ADDACTIONFORPHONE set)
  3474. if ($addlink == 'tel' || $conf->browser->layout == 'phone' || (isModEnabled('clicktodial') && getDolGlobalString('CLICKTODIAL_USE_TEL_LINK_ON_PHONE_NUMBERS'))) { // If phone or option for, we use link of phone
  3475. $newphoneastart = '<a href="tel:'.$phone.'">';
  3476. $newphoneaend .= '</a>';
  3477. } elseif (isModEnabled('clicktodial') && $addlink == 'AC_TEL') { // If click to dial, we use click to dial url
  3478. if (empty($user->clicktodial_loaded)) {
  3479. $user->fetch_clicktodial();
  3480. }
  3481. // Define urlmask
  3482. $urlmask = getDolGlobalString('CLICKTODIAL_URL', 'ErrorClickToDialModuleNotConfigured');
  3483. if (!empty($user->clicktodial_url)) {
  3484. $urlmask = $user->clicktodial_url;
  3485. }
  3486. $clicktodial_poste = (!empty($user->clicktodial_poste) ? urlencode($user->clicktodial_poste) : '');
  3487. $clicktodial_login = (!empty($user->clicktodial_login) ? urlencode($user->clicktodial_login) : '');
  3488. $clicktodial_password = (!empty($user->clicktodial_password) ? urlencode($user->clicktodial_password) : '');
  3489. // This line is for backward compatibility
  3490. $url = sprintf($urlmask, urlencode($phone), $clicktodial_poste, $clicktodial_login, $clicktodial_password);
  3491. // Thoose lines are for substitution
  3492. $substitarray = array('__PHONEFROM__'=>$clicktodial_poste,
  3493. '__PHONETO__'=>urlencode($phone),
  3494. '__LOGIN__'=>$clicktodial_login,
  3495. '__PASS__'=>$clicktodial_password);
  3496. $url = make_substitutions($url, $substitarray);
  3497. if (!getDolGlobalString('CLICKTODIAL_DO_NOT_USE_AJAX_CALL')) {
  3498. // Default and recommended: New method using ajax without submiting a page making a javascript history.go(-1) back
  3499. $newphoneastart = '<a href="'.$url.'" class="cssforclicktodial">'; // Call of ajax is handled by the lib_foot.js.php on class 'cssforclicktodial'
  3500. $newphoneaend = '</a>';
  3501. } else {
  3502. // Old method
  3503. $newphoneastart = '<a href="'.$url.'"';
  3504. if (getDolGlobalString('CLICKTODIAL_FORCENEWTARGET')) {
  3505. $newphoneastart .= ' target="_blank" rel="noopener noreferrer"';
  3506. }
  3507. $newphoneastart .= '>';
  3508. $newphoneaend .= '</a>';
  3509. }
  3510. }
  3511. //if (($cid || $socid) && isModEnabled('agenda') && $user->hasRight('agenda', 'myactions', 'create'))
  3512. if (isModEnabled('agenda') && $user->hasRight("agenda", "myactions", "create")) {
  3513. $type = 'AC_TEL';
  3514. $addlinktoagenda = '';
  3515. if ($addlink == 'AC_FAX') {
  3516. $type = 'AC_FAX';
  3517. }
  3518. if (getDolGlobalString('AGENDA_ADDACTIONFORPHONE')) {
  3519. $addlinktoagenda = '<a href="'.DOL_URL_ROOT.'/comm/action/card.php?action=create&amp;backtopage='. urlencode($_SERVER['REQUEST_URI']) .'&amp;actioncode='.$type.($cid ? '&amp;contactid='.$cid : '').($socid ? '&amp;socid='.$socid : '').'">'.img_object($langs->trans("AddAction"), "calendar").'</a>';
  3520. }
  3521. if ($addlinktoagenda) {
  3522. $newphone = '<span>'.$newphone.' '.$addlinktoagenda.'</span>';
  3523. }
  3524. }
  3525. }
  3526. if (empty($titlealt)) {
  3527. $titlealt = ($withpicto == 'fax' ? $langs->trans("Fax") : $langs->trans("Phone"));
  3528. }
  3529. $rep = '';
  3530. if ($hookmanager) {
  3531. $parameters = array('countrycode' => $countrycode, 'cid' => $cid, 'socid' => $socid, 'titlealt' => $titlealt, 'picto' => $withpicto);
  3532. $reshook = $hookmanager->executeHooks('printPhone', $parameters, $phone);
  3533. $rep .= $hookmanager->resPrint;
  3534. }
  3535. if (empty($reshook)) {
  3536. $picto = '';
  3537. if ($withpicto) {
  3538. if ($withpicto == 'fax') {
  3539. $picto = 'phoning_fax';
  3540. } elseif ($withpicto == 'phone') {
  3541. $picto = 'phoning';
  3542. } elseif ($withpicto == 'mobile') {
  3543. $picto = 'phoning_mobile';
  3544. } else {
  3545. $picto = '';
  3546. }
  3547. }
  3548. if ($adddivfloat == 1) {
  3549. $rep .= '<div class="nospan float" style="margin-right: 10px">';
  3550. } elseif (empty($adddivfloat)) {
  3551. $rep .= '<span style="margin-right: 10px;">';
  3552. }
  3553. $rep .= $newphoneastart;
  3554. $rep .= ($withpicto ? img_picto($titlealt, 'object_'.$picto.'.png') : '');
  3555. if ($separ != 'hidenum') {
  3556. $rep .= ($withpicto ? ' ' : '').$newphone;
  3557. }
  3558. $rep .= $newphoneaend;
  3559. if ($adddivfloat == 1) {
  3560. $rep .= '</div>';
  3561. } elseif (empty($adddivfloat)) {
  3562. $rep .= '</span>';
  3563. }
  3564. }
  3565. return $rep;
  3566. }
  3567. /**
  3568. * Return an IP formated to be shown on screen
  3569. *
  3570. * @param string $ip IP
  3571. * @param int $mode 0=return IP + country/flag, 1=return only country/flag, 2=return only IP
  3572. * @return string Formated IP, with country if GeoIP module is enabled
  3573. */
  3574. function dol_print_ip($ip, $mode = 0)
  3575. {
  3576. global $langs;
  3577. $ret = '';
  3578. if (empty($mode)) {
  3579. $ret .= $ip;
  3580. }
  3581. if ($mode != 2) {
  3582. $countrycode = dolGetCountryCodeFromIp($ip);
  3583. if ($countrycode) { // If success, countrycode is us, fr, ...
  3584. if (file_exists(DOL_DOCUMENT_ROOT.'/theme/common/flags/'.$countrycode.'.png')) {
  3585. $ret .= ' '.img_picto($countrycode.' '.$langs->trans("AccordingToGeoIPDatabase"), DOL_URL_ROOT.'/theme/common/flags/'.$countrycode.'.png', '', 1);
  3586. } else {
  3587. $ret .= ' ('.$countrycode.')';
  3588. }
  3589. } else {
  3590. // Nothing
  3591. }
  3592. }
  3593. return $ret;
  3594. }
  3595. /**
  3596. * Return the IP of remote user.
  3597. * Take HTTP_X_FORWARDED_FOR (defined when using proxy)
  3598. * Then HTTP_CLIENT_IP if defined (rare)
  3599. * Then REMOTE_ADDR (no way to be modified by user but may be wrong if user is using a proxy)
  3600. *
  3601. * @return string Ip of remote user.
  3602. */
  3603. function getUserRemoteIP()
  3604. {
  3605. if (empty($_SERVER['HTTP_X_FORWARDED_FOR']) || preg_match('/[^0-9\.\:,\[\]]/', $_SERVER['HTTP_X_FORWARDED_FOR'])) {
  3606. if (empty($_SERVER['HTTP_CLIENT_IP']) || preg_match('/[^0-9\.\:,\[\]]/', $_SERVER['HTTP_CLIENT_IP'])) {
  3607. if (empty($_SERVER["HTTP_CF_CONNECTING_IP"])) {
  3608. $ip = (empty($_SERVER['REMOTE_ADDR']) ? '' : $_SERVER['REMOTE_ADDR']); // value may have been the IP of the proxy and not the client
  3609. } else {
  3610. $ip = $_SERVER["HTTP_CF_CONNECTING_IP"]; // value here may have been forged by client
  3611. }
  3612. } else {
  3613. $ip = $_SERVER['HTTP_CLIENT_IP']; // value is clean here but may have been forged by proxy
  3614. }
  3615. } else {
  3616. $ip = $_SERVER['HTTP_X_FORWARDED_FOR']; // value is clean here but may have been forged by proxy
  3617. }
  3618. return $ip;
  3619. }
  3620. /**
  3621. * Return if we are using a HTTPS connexion
  3622. * Check HTTPS (no way to be modified by user but may be empty or wrong if user is using a proxy)
  3623. * Take HTTP_X_FORWARDED_PROTO (defined when using proxy)
  3624. * Then HTTP_X_FORWARDED_SSL
  3625. *
  3626. * @return boolean True if user is using HTTPS
  3627. */
  3628. function isHTTPS()
  3629. {
  3630. $isSecure = false;
  3631. if (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on') {
  3632. $isSecure = true;
  3633. } elseif (!empty($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https' || !empty($_SERVER['HTTP_X_FORWARDED_SSL']) && $_SERVER['HTTP_X_FORWARDED_SSL'] == 'on') {
  3634. $isSecure = true;
  3635. }
  3636. return $isSecure;
  3637. }
  3638. /**
  3639. * Return a country code from IP. Empty string if not found.
  3640. *
  3641. * @param string $ip IP
  3642. * @return string Country code ('us', 'fr', ...)
  3643. */
  3644. function dolGetCountryCodeFromIp($ip)
  3645. {
  3646. global $conf;
  3647. $countrycode = '';
  3648. if (!empty($conf->geoipmaxmind->enabled)) {
  3649. $datafile = getDolGlobalString('GEOIPMAXMIND_COUNTRY_DATAFILE');
  3650. //$ip='24.24.24.24';
  3651. //$datafile='/usr/share/GeoIP/GeoIP.dat'; Note that this must be downloaded datafile (not same than datafile provided with ubuntu packages)
  3652. include_once DOL_DOCUMENT_ROOT.'/core/class/dolgeoip.class.php';
  3653. $geoip = new DolGeoIP('country', $datafile);
  3654. //print 'ip='.$ip.' databaseType='.$geoip->gi->databaseType." GEOIP_CITY_EDITION_REV1=".GEOIP_CITY_EDITION_REV1."\n";
  3655. $countrycode = $geoip->getCountryCodeFromIP($ip);
  3656. }
  3657. return $countrycode;
  3658. }
  3659. /**
  3660. * Return country code for current user.
  3661. * If software is used inside a local network, detection may fails (we need a public ip)
  3662. *
  3663. * @return string Country code (fr, es, it, us, ...)
  3664. */
  3665. function dol_user_country()
  3666. {
  3667. global $conf, $langs, $user;
  3668. //$ret=$user->xxx;
  3669. $ret = '';
  3670. if (!empty($conf->geoipmaxmind->enabled)) {
  3671. $ip = getUserRemoteIP();
  3672. $datafile = getDolGlobalString('GEOIPMAXMIND_COUNTRY_DATAFILE');
  3673. //$ip='24.24.24.24';
  3674. //$datafile='E:\Mes Sites\Web\Admin1\awstats\maxmind\GeoIP.dat';
  3675. include_once DOL_DOCUMENT_ROOT.'/core/class/dolgeoip.class.php';
  3676. $geoip = new DolGeoIP('country', $datafile);
  3677. $countrycode = $geoip->getCountryCodeFromIP($ip);
  3678. $ret = $countrycode;
  3679. }
  3680. return $ret;
  3681. }
  3682. /**
  3683. * Format address string
  3684. *
  3685. * @param string $address Address string, already formatted with dol_format_address()
  3686. * @param int $htmlid Html ID (for example 'gmap')
  3687. * @param int $element 'thirdparty'|'contact'|'member'|'other'
  3688. * @param int $id Id of object
  3689. * @param int $noprint No output. Result is the function return
  3690. * @param string $charfornl Char to use instead of nl2br. '' means we use a standad nl2br.
  3691. * @return string|void Nothing if noprint is 0, formatted address if noprint is 1
  3692. * @see dol_format_address()
  3693. */
  3694. function dol_print_address($address, $htmlid, $element, $id, $noprint = 0, $charfornl = '')
  3695. {
  3696. global $conf, $user, $langs, $hookmanager;
  3697. $out = '';
  3698. if ($address) {
  3699. if ($hookmanager) {
  3700. $parameters = array('element' => $element, 'id' => $id);
  3701. $reshook = $hookmanager->executeHooks('printAddress', $parameters, $address);
  3702. $out .= $hookmanager->resPrint;
  3703. }
  3704. if (empty($reshook)) {
  3705. if (empty($charfornl)) {
  3706. $out .= nl2br($address);
  3707. } else {
  3708. $out .= preg_replace('/[\r\n]+/', $charfornl, $address);
  3709. }
  3710. // TODO Remove this block, we can add this using the hook now
  3711. $showgmap = $showomap = 0;
  3712. if (($element == 'thirdparty' || $element == 'societe') && isModEnabled('google') && getDolGlobalString('GOOGLE_ENABLE_GMAPS')) {
  3713. $showgmap = 1;
  3714. }
  3715. if ($element == 'contact' && isModEnabled('google') && getDolGlobalString('GOOGLE_ENABLE_GMAPS_CONTACTS')) {
  3716. $showgmap = 1;
  3717. }
  3718. if ($element == 'member' && isModEnabled('google') && getDolGlobalString('GOOGLE_ENABLE_GMAPS_MEMBERS')) {
  3719. $showgmap = 1;
  3720. }
  3721. if ($element == 'user' && isModEnabled('google') && getDolGlobalString('GOOGLE_ENABLE_GMAPS_USERS')) {
  3722. $showgmap = 1;
  3723. }
  3724. if (($element == 'thirdparty' || $element == 'societe') && isModEnabled('openstreetmap') && getDolGlobalString('OPENSTREETMAP_ENABLE_MAPS')) {
  3725. $showomap = 1;
  3726. }
  3727. if ($element == 'contact' && isModEnabled('openstreetmap') && getDolGlobalString('OPENSTREETMAP_ENABLE_MAPS_CONTACTS')) {
  3728. $showomap = 1;
  3729. }
  3730. if ($element == 'member' && isModEnabled('openstreetmap') && getDolGlobalString('OPENSTREETMAP_ENABLE_MAPS_MEMBERS')) {
  3731. $showomap = 1;
  3732. }
  3733. if ($element == 'user' && isModEnabled('openstreetmap') && getDolGlobalString('OPENSTREETMAP_ENABLE_MAPS_USERS')) {
  3734. $showomap = 1;
  3735. }
  3736. if ($showgmap) {
  3737. $url = dol_buildpath('/google/gmaps.php?mode='.$element.'&id='.$id, 1);
  3738. $out .= ' <a href="'.$url.'" target="_gmaps"><img id="'.$htmlid.'" class="valigntextbottom" src="'.DOL_URL_ROOT.'/theme/common/gmap.png"></a>';
  3739. }
  3740. if ($showomap) {
  3741. $url = dol_buildpath('/openstreetmap/maps.php?mode='.$element.'&id='.$id, 1);
  3742. $out .= ' <a href="'.$url.'" target="_gmaps"><img id="'.$htmlid.'_openstreetmap" class="valigntextbottom" src="'.DOL_URL_ROOT.'/theme/common/gmap.png"></a>';
  3743. }
  3744. }
  3745. }
  3746. if ($noprint) {
  3747. return $out;
  3748. } else {
  3749. print $out;
  3750. }
  3751. }
  3752. /**
  3753. * Return true if email syntax is ok.
  3754. *
  3755. * @param string $address email (Ex: "toto@examle.com". Long form "John Do <johndo@example.com>" will be false)
  3756. * @param int $acceptsupervisorkey If 1, the special string '__SUPERVISOREMAIL__' is also accepted as valid
  3757. * @param int $acceptuserkey If 1, the special string '__USER_EMAIL__' is also accepted as valid
  3758. * @return boolean true if email syntax is OK, false if KO or empty string
  3759. * @see isValidMXRecord()
  3760. */
  3761. function isValidEmail($address, $acceptsupervisorkey = 0, $acceptuserkey = 0)
  3762. {
  3763. if ($acceptsupervisorkey && $address == '__SUPERVISOREMAIL__') {
  3764. return true;
  3765. }
  3766. if ($acceptuserkey && $address == '__USER_EMAIL__') {
  3767. return true;
  3768. }
  3769. if (filter_var($address, FILTER_VALIDATE_EMAIL)) {
  3770. return true;
  3771. }
  3772. return false;
  3773. }
  3774. /**
  3775. * Return if the domain name has a valid MX record.
  3776. * WARNING: This need function idn_to_ascii, checkdnsrr and getmxrr
  3777. *
  3778. * @param string $domain Domain name (Ex: "yahoo.com", "yhaoo.com", "dolibarr.fr")
  3779. * @return int -1 if error (function not available), 0=Not valid, 1=Valid
  3780. * @see isValidEmail()
  3781. */
  3782. function isValidMXRecord($domain)
  3783. {
  3784. if (function_exists('idn_to_ascii') && function_exists('checkdnsrr')) {
  3785. if (!checkdnsrr(idn_to_ascii($domain), 'MX')) {
  3786. return 0;
  3787. }
  3788. if (function_exists('getmxrr')) {
  3789. $mxhosts = array();
  3790. $weight = array();
  3791. getmxrr(idn_to_ascii($domain), $mxhosts, $weight);
  3792. if (count($mxhosts) > 1) {
  3793. return 1;
  3794. }
  3795. if (count($mxhosts) == 1 && !empty($mxhosts[0])) {
  3796. return 1;
  3797. }
  3798. return 0;
  3799. }
  3800. }
  3801. // function idn_to_ascii or checkdnsrr or getmxrr does not exists
  3802. return -1;
  3803. }
  3804. /**
  3805. * Return true if phone number syntax is ok
  3806. * TODO Decide what to do with this
  3807. *
  3808. * @param string $phone phone (Ex: "0601010101")
  3809. * @return boolean true if phone syntax is OK, false if KO or empty string
  3810. */
  3811. function isValidPhone($phone)
  3812. {
  3813. return true;
  3814. }
  3815. /**
  3816. * Return first letters of a strings.
  3817. * Example with nbofchar=1: 'ghi' will return 'g' but 'abc def' will return 'ad'
  3818. * Example with nbofchar=2: 'ghi' will return 'gh' but 'abc def' will return 'abde'
  3819. *
  3820. * @param string $s String to truncate
  3821. * @param int $nbofchar Nb of characters to keep
  3822. * @return string Return first chars.
  3823. */
  3824. function dolGetFirstLetters($s, $nbofchar = 1)
  3825. {
  3826. $ret = '';
  3827. $tmparray = explode(' ', $s);
  3828. foreach ($tmparray as $tmps) {
  3829. $ret .= dol_substr($tmps, 0, $nbofchar);
  3830. }
  3831. return $ret;
  3832. }
  3833. /**
  3834. * Make a strlen call. Works even if mbstring module not enabled
  3835. *
  3836. * @param string $string String to calculate length
  3837. * @param string $stringencoding Encoding of string
  3838. * @return int Length of string
  3839. */
  3840. function dol_strlen($string, $stringencoding = 'UTF-8')
  3841. {
  3842. if (is_null($string)) {
  3843. return 0;
  3844. }
  3845. if (function_exists('mb_strlen')) {
  3846. return mb_strlen($string, $stringencoding);
  3847. } else {
  3848. return strlen($string);
  3849. }
  3850. }
  3851. /**
  3852. * Make a substring. Works even if mbstring module is not enabled for better compatibility.
  3853. *
  3854. * @param string $string String to scan
  3855. * @param string $start Start position
  3856. * @param int|null $length Length (in nb of characters or nb of bytes depending on trunconbytes param)
  3857. * @param string $stringencoding Page code used for input string encoding
  3858. * @param int $trunconbytes 1=Length is max of bytes instead of max of characters
  3859. * @return string substring
  3860. */
  3861. function dol_substr($string, $start, $length = null, $stringencoding = '', $trunconbytes = 0)
  3862. {
  3863. global $langs;
  3864. if (empty($stringencoding)) {
  3865. $stringencoding = $langs->charset_output;
  3866. }
  3867. $ret = '';
  3868. if (empty($trunconbytes)) {
  3869. if (function_exists('mb_substr')) {
  3870. $ret = mb_substr($string, $start, $length, $stringencoding);
  3871. } else {
  3872. $ret = substr($string, $start, $length);
  3873. }
  3874. } else {
  3875. if (function_exists('mb_strcut')) {
  3876. $ret = mb_strcut($string, $start, $length, $stringencoding);
  3877. } else {
  3878. $ret = substr($string, $start, $length);
  3879. }
  3880. }
  3881. return $ret;
  3882. }
  3883. /**
  3884. * Truncate a string to a particular length adding '…' if string larger than length.
  3885. * If length = max length+1, we do no truncate to avoid having just 1 char replaced with '…'.
  3886. * MAIN_DISABLE_TRUNC=1 can disable all truncings
  3887. *
  3888. * @param string $string String to truncate
  3889. * @param int $size Max string size visible (excluding …). 0 for no limit. WARNING: Final string size can have 3 more chars (if we added …, or if size was max+1 so it does not worse to replace with ...)
  3890. * @param string $trunc Where to trunc: 'right', 'left', 'middle' (size must be a 2 power), 'wrap'
  3891. * @param string $stringencoding Tell what is source string encoding
  3892. * @param int $nodot Truncation do not add … after truncation. So it's an exact truncation.
  3893. * @param int $display Trunc is used to display data and can be changed for small screen. TODO Remove this param (must be dealt with CSS)
  3894. * @return string Truncated string. WARNING: length is never higher than $size if $nodot is set, but can be 3 chars higher otherwise.
  3895. */
  3896. function dol_trunc($string, $size = 40, $trunc = 'right', $stringencoding = 'UTF-8', $nodot = 0, $display = 0)
  3897. {
  3898. global $conf;
  3899. if (empty($size) || getDolGlobalString('MAIN_DISABLE_TRUNC')) {
  3900. return $string;
  3901. }
  3902. if (empty($stringencoding)) {
  3903. $stringencoding = 'UTF-8';
  3904. }
  3905. // reduce for small screen
  3906. if ($conf->dol_optimize_smallscreen == 1 && $display == 1) {
  3907. $size = round($size / 3);
  3908. }
  3909. // We go always here
  3910. if ($trunc == 'right') {
  3911. $newstring = dol_textishtml($string) ? dol_string_nohtmltag($string, 1) : $string;
  3912. if (dol_strlen($newstring, $stringencoding) > ($size + ($nodot ? 0 : 1))) {
  3913. // If nodot is 0 and size is 1 chars more, we don't trunc and don't add …
  3914. return dol_substr($newstring, 0, $size, $stringencoding).($nodot ? '' : '…');
  3915. } else {
  3916. //return 'u'.$size.'-'.$newstring.'-'.dol_strlen($newstring,$stringencoding).'-'.$string;
  3917. return $string;
  3918. }
  3919. } elseif ($trunc == 'middle') {
  3920. $newstring = dol_textishtml($string) ? dol_string_nohtmltag($string, 1) : $string;
  3921. if (dol_strlen($newstring, $stringencoding) > 2 && dol_strlen($newstring, $stringencoding) > ($size + 1)) {
  3922. $size1 = round($size / 2);
  3923. $size2 = round($size / 2);
  3924. return dol_substr($newstring, 0, $size1, $stringencoding).'…'.dol_substr($newstring, dol_strlen($newstring, $stringencoding) - $size2, $size2, $stringencoding);
  3925. } else {
  3926. return $string;
  3927. }
  3928. } elseif ($trunc == 'left') {
  3929. $newstring = dol_textishtml($string) ? dol_string_nohtmltag($string, 1) : $string;
  3930. if (dol_strlen($newstring, $stringencoding) > ($size + ($nodot ? 0 : 1))) {
  3931. // If nodot is 0 and size is 1 chars more, we don't trunc and don't add …
  3932. return '…'.dol_substr($newstring, dol_strlen($newstring, $stringencoding) - $size, $size, $stringencoding);
  3933. } else {
  3934. return $string;
  3935. }
  3936. } elseif ($trunc == 'wrap') {
  3937. $newstring = dol_textishtml($string) ? dol_string_nohtmltag($string, 1) : $string;
  3938. if (dol_strlen($newstring, $stringencoding) > ($size + 1)) {
  3939. return dol_substr($newstring, 0, $size, $stringencoding)."\n".dol_trunc(dol_substr($newstring, $size, dol_strlen($newstring, $stringencoding) - $size, $stringencoding), $size, $trunc);
  3940. } else {
  3941. return $string;
  3942. }
  3943. } else {
  3944. return 'BadParam3CallingDolTrunc';
  3945. }
  3946. }
  3947. /**
  3948. * Return the picto for a data type
  3949. *
  3950. * @param string $key Key
  3951. * @return string Pïcto for the key
  3952. */
  3953. function getPictoForType($key)
  3954. {
  3955. // Set array with type -> picto
  3956. $type2picto = array(
  3957. 'varchar'=>'font',
  3958. 'text'=>'font',
  3959. 'html'=>'code',
  3960. 'int'=>'sort-numeric-down',
  3961. 'double'=>'sort-numeric-down',
  3962. 'price'=>'currency',
  3963. 'pricecy'=>'multicurrency',
  3964. 'password' => 'key',
  3965. 'boolean'=>'check-square',
  3966. 'date'=>'calendar',
  3967. 'datetime'=>'calendar',
  3968. 'phone'=> 'phone',
  3969. 'mail'=> 'email',
  3970. 'url'=> 'url',
  3971. 'ip'=> 'country',
  3972. 'select' => 'list',
  3973. 'sellist' => 'list',
  3974. 'radio' => 'check-circle',
  3975. 'checkbox' => 'check-square',
  3976. 'chkbxlst' => 'check-square',
  3977. 'link' => 'link',
  3978. 'separate'=> 'minus'
  3979. );
  3980. if (!empty($type2picto[$key])) {
  3981. return img_picto('', $type2picto[$key], 'class="pictofixedwidth"');
  3982. }
  3983. return img_picto('', 'generic', 'class="pictofixedwidth"');
  3984. }
  3985. /**
  3986. * Show picto whatever it's its name (generic function)
  3987. *
  3988. * @param string $titlealt Text on title tag for tooltip. Not used if param notitle is set to 1.
  3989. * @param string $picto Name of image file to show ('filenew', ...).
  3990. * For font awesome icon (example 'user'), you can use picto_nocolor to not have the color of picto forced.
  3991. * If no extension provided and it is not a font awesome icon, we use '.png'. Image must be stored into theme/xxx/img directory.
  3992. * Example: picto.png if picto.png is stored into htdocs/theme/mytheme/img
  3993. * Example: picto.png@mymodule if picto.png is stored into htdocs/mymodule/img
  3994. * Example: /mydir/mysubdir/picto.png if picto.png is stored into htdocs/mydir/mysubdir (pictoisfullpath must be set to 1)
  3995. * Example: fontawesome_envelope-open-text_fas_red_1em if you want to use fontaweseome icons: fontawesome_<icon-name>_<style>_<color>_<size> (only icon-name is mandatory)
  3996. * @param string $moreatt Add more attribute on img tag (For example 'class="pictofixedwidth"')
  3997. * @param boolean|int $pictoisfullpath If true or 1, image path is a full path
  3998. * @param int $srconly Return only content of the src attribute of img.
  3999. * @param int $notitle 1=Disable tag title. Use it if you add js tooltip, to avoid duplicate tooltip.
  4000. * @param string $alt Force alt for bind people
  4001. * @param string $morecss Add more class css on img tag (For example 'myclascss').
  4002. * @param string $marginleftonlyshort 1 = Add a short left margin on picto, 2 = Add a larger left margin on picto, 0 = No margin left. Works for fontawesome picto only.
  4003. * @return string Return img tag
  4004. * @see img_object(), img_picto_common()
  4005. */
  4006. function img_picto($titlealt, $picto, $moreatt = '', $pictoisfullpath = false, $srconly = 0, $notitle = 0, $alt = '', $morecss = '', $marginleftonlyshort = 2)
  4007. {
  4008. global $conf, $langs;
  4009. // We forge fullpathpicto for image to $path/img/$picto. By default, we take DOL_URL_ROOT/theme/$conf->theme/img/$picto
  4010. $url = DOL_URL_ROOT;
  4011. $theme = isset($conf->theme) ? $conf->theme : null;
  4012. $path = 'theme/'.$theme;
  4013. if (empty($picto)) {
  4014. $picto = 'generic';
  4015. }
  4016. // Define fullpathpicto to use into src
  4017. if ($pictoisfullpath) {
  4018. // Clean parameters
  4019. if (!preg_match('/(\.png|\.gif|\.svg)$/i', $picto)) {
  4020. $picto .= '.png';
  4021. }
  4022. $fullpathpicto = $picto;
  4023. $reg = array();
  4024. if (preg_match('/class="([^"]+)"/', $moreatt, $reg)) {
  4025. $morecss .= ($morecss ? ' ' : '').$reg[1];
  4026. $moreatt = str_replace('class="'.$reg[1].'"', '', $moreatt);
  4027. }
  4028. } else {
  4029. $pictowithouttext = preg_replace('/(\.png|\.gif|\.svg)$/', '', (is_null($picto) ? '' : $picto));
  4030. $pictowithouttext = str_replace('object_', '', $pictowithouttext);
  4031. $pictowithouttext = str_replace('_nocolor', '', $pictowithouttext);
  4032. if (strpos($pictowithouttext, 'fontawesome_') === 0 || strpos($pictowithouttext, 'fa-') === 0) {
  4033. // This is a font awesome image 'fontawesome_xxx' or 'fa-xxx'
  4034. $pictowithouttext = str_replace('fontawesome_', '', $pictowithouttext);
  4035. $pictowithouttext = str_replace('fa-', '', $pictowithouttext);
  4036. // Compatibility with old fontawesome versions
  4037. if ($pictowithouttext == 'file-o') {
  4038. $pictowithouttext = 'file';
  4039. }
  4040. $pictowithouttextarray = explode('_', $pictowithouttext);
  4041. $marginleftonlyshort = 0;
  4042. if (!empty($pictowithouttextarray[1])) {
  4043. // Syntax is 'fontawesome_fakey_faprefix_facolor_fasize' or 'fa-fakey_faprefix_facolor_fasize'
  4044. $fakey = 'fa-'.$pictowithouttextarray[0];
  4045. $faprefix = empty($pictowithouttextarray[1]) ? 'fas' : $pictowithouttextarray[1];
  4046. $facolor = empty($pictowithouttextarray[2]) ? '' : $pictowithouttextarray[2];
  4047. $fasize = empty($pictowithouttextarray[3]) ? '' : $pictowithouttextarray[3];
  4048. } else {
  4049. $fakey = 'fa-'.$pictowithouttext;
  4050. $faprefix = 'fas';
  4051. $facolor = '';
  4052. $fasize = '';
  4053. }
  4054. // This snippet only needed since function img_edit accepts only one additional parameter: no separate one for css only.
  4055. // class/style need to be extracted to avoid duplicate class/style validation errors when $moreatt is added to the end of the attributes.
  4056. $morestyle = '';
  4057. $reg = array();
  4058. if (preg_match('/class="([^"]+)"/', $moreatt, $reg)) {
  4059. $morecss .= ($morecss ? ' ' : '').$reg[1];
  4060. $moreatt = str_replace('class="'.$reg[1].'"', '', $moreatt);
  4061. }
  4062. if (preg_match('/style="([^"]+)"/', $moreatt, $reg)) {
  4063. $morestyle = $reg[1];
  4064. $moreatt = str_replace('style="'.$reg[1].'"', '', $moreatt);
  4065. }
  4066. $moreatt = trim($moreatt);
  4067. $enabledisablehtml = '<span class="'.$faprefix.' '.$fakey.($marginleftonlyshort ? ($marginleftonlyshort == 1 ? ' marginleftonlyshort' : ' marginleftonly') : '');
  4068. $enabledisablehtml .= ($morecss ? ' '.$morecss : '').'" style="'.($fasize ? ('font-size: '.$fasize.';') : '').($facolor ? (' color: '.$facolor.';') : '').($morestyle ? ' '.$morestyle : '').'"'.(($notitle || empty($titlealt)) ? '' : ' title="'.dol_escape_htmltag($titlealt).'"').($moreatt ? ' '.$moreatt : '').'>';
  4069. /*if (!empty($conf->global->MAIN_OPTIMIZEFORTEXTBROWSER)) {
  4070. $enabledisablehtml .= $titlealt;
  4071. }*/
  4072. $enabledisablehtml .= '</span>';
  4073. return $enabledisablehtml;
  4074. }
  4075. if (empty($srconly) && in_array($pictowithouttext, array(
  4076. '1downarrow', '1uparrow', '1leftarrow', '1rightarrow', '1uparrow_selected', '1downarrow_selected', '1leftarrow_selected', '1rightarrow_selected',
  4077. 'accountancy', 'accounting_account', 'account', 'accountline', 'action', 'add', 'address', 'angle-double-down', 'angle-double-up', 'asset',
  4078. 'bank_account', 'barcode', 'bank', 'bell', 'bill', 'billa', 'billr', 'billd', 'birthday-cake', 'bookmark', 'bom', 'briefcase-medical', 'bug', 'building',
  4079. 'card', 'calendarlist', 'calendar', 'calendarmonth', 'calendarweek', 'calendarday', 'calendarperuser', 'calendarpertype',
  4080. 'cash-register', 'category', 'chart', 'check', 'clock', 'clone', 'close_title', 'code', 'cog', 'collab', 'company', 'contact', 'country', 'contract', 'conversation', 'cron', 'cross', 'cubes',
  4081. 'check-circle', 'check-square', 'currency', 'multicurrency',
  4082. 'chevron-left', 'chevron-right', 'chevron-down', 'chevron-top', 'commercial', 'companies',
  4083. 'delete', 'dolly', 'dollyrevert', 'donation', 'download', 'dynamicprice',
  4084. 'edit', 'ellipsis-h', 'email', 'entity', 'envelope', 'eraser', 'establishment', 'expensereport', 'external-link-alt', 'external-link-square-alt', 'eye',
  4085. 'filter', 'file', 'file-o', 'file-code', 'file-export', 'file-import', 'file-upload', 'autofill', 'folder', 'folder-open', 'folder-plus', 'font',
  4086. 'gears', 'generate', 'generic', 'globe', 'globe-americas', 'graph', 'grip', 'grip_title', 'group',
  4087. 'hands-helping', 'help', 'holiday',
  4088. 'id-card', 'images', 'incoterm', 'info', 'intervention', 'inventory', 'intracommreport', 'jobprofile',
  4089. 'key', 'knowledgemanagement',
  4090. 'label', 'language', 'line', 'link', 'list', 'list-alt', 'listlight', 'loan', 'lock', 'lot', 'long-arrow-alt-right',
  4091. 'margin', 'map-marker-alt', 'member', 'meeting', 'minus', 'money-bill-alt', 'movement', 'mrp', 'note', 'next',
  4092. 'off', 'on', 'order',
  4093. 'paiment', 'paragraph', 'play', 'pdf', 'phone', 'phoning', 'phoning_mobile', 'phoning_fax', 'playdisabled', 'previous', 'poll', 'pos', 'printer', 'product', 'propal', 'proposal', 'puce',
  4094. 'stock', 'resize', 'service', 'stats', 'trip',
  4095. 'security', 'setup', 'share-alt', 'sign-out', 'split', 'stripe', 'stripe-s', 'switch_off', 'switch_on', 'switch_on_warning', 'switch_on_red', 'tools', 'unlink', 'uparrow', 'user', 'user-tie', 'vcard', 'wrench',
  4096. 'github', 'google', 'jabber', 'microsoft', 'skype', 'twitter', 'facebook', 'linkedin', 'instagram', 'snapchat', 'youtube', 'google-plus-g', 'whatsapp',
  4097. 'generic', 'home', 'hrm', 'members', 'products', 'invoicing',
  4098. 'partnership', 'payment', 'payment_vat', 'pencil-ruler', 'pictoconfirm', 'preview', 'project', 'projectpub', 'projecttask', 'question', 'refresh', 'region',
  4099. 'salary', 'shipment', 'state', 'supplier_invoice', 'supplier_invoicea', 'supplier_invoicer', 'supplier_invoiced',
  4100. 'technic', 'ticket',
  4101. 'error', 'warning',
  4102. 'recent', 'reception', 'recruitmentcandidature', 'recruitmentjobposition', 'replacement', 'resource', 'recurring','rss',
  4103. 'shapes', 'skill', 'square', 'sort-numeric-down', 'stop-circle', 'supplier', 'supplier_proposal', 'supplier_order', 'supplier_invoice',
  4104. 'timespent', 'title_setup', 'title_accountancy', 'title_bank', 'title_hrm', 'title_agenda',
  4105. 'uncheck', 'url', 'user-cog', 'user-injured', 'user-md', 'vat', 'website', 'workstation', 'webhook', 'world', 'private',
  4106. 'conferenceorbooth', 'eventorganization',
  4107. 'stamp', 'signature'
  4108. ))) {
  4109. $fakey = $pictowithouttext;
  4110. $facolor = '';
  4111. $fasize = '';
  4112. $fa = getDolGlobalString('MAIN_FONTAWESOME_ICON_STYLE', 'fas');
  4113. if (in_array($pictowithouttext, array('card', 'bell', 'clock', 'establishment', 'file', 'file-o', 'generic', 'minus-square', 'object_generic', 'pdf', 'plus-square', 'timespent', 'note', 'off', 'on', 'object_bookmark', 'bookmark', 'vcard'))) {
  4114. $fa = 'far';
  4115. }
  4116. if (in_array($pictowithouttext, array('black-tie', 'github', 'google', 'microsoft', 'skype', 'twitter', 'facebook', 'linkedin', 'instagram', 'snapchat', 'stripe', 'stripe-s', 'youtube', 'google-plus-g', 'whatsapp'))) {
  4117. $fa = 'fab';
  4118. }
  4119. $arrayconvpictotofa = array(
  4120. 'account'=>'university', 'accounting_account'=>'clipboard-list', 'accountline'=>'receipt', 'accountancy'=>'search-dollar', 'action'=>'calendar-alt', 'add'=>'plus-circle', 'address'=> 'address-book', 'asset'=>'money-check-alt', 'autofill'=>'fill',
  4121. 'bank_account'=>'university',
  4122. 'bill'=>'file-invoice-dollar', 'billa'=>'file-excel', 'billr'=>'file-invoice-dollar', 'billd'=>'file-medical',
  4123. 'supplier_invoice'=>'file-invoice-dollar', 'supplier_invoicea'=>'file-excel', 'supplier_invoicer'=>'file-invoice-dollar', 'supplier_invoiced'=>'file-medical',
  4124. 'bom'=>'shapes',
  4125. 'card'=>'address-card', 'chart'=>'chart-line', 'company'=>'building', 'contact'=>'address-book', 'contract'=>'suitcase', 'collab'=>'people-arrows', 'conversation'=>'comments', 'country'=>'globe-americas', 'cron'=>'business-time', 'cross'=>'times',
  4126. 'donation'=>'file-alt', 'dynamicprice'=>'hand-holding-usd',
  4127. 'setup'=>'cog', 'companies'=>'building', 'products'=>'cube', 'commercial'=>'suitcase', 'invoicing'=>'coins',
  4128. 'accounting'=>'search-dollar', 'category'=>'tag', 'dollyrevert'=>'dolly',
  4129. 'file-o'=>'file', 'generate'=>'plus-square', 'hrm'=>'user-tie', 'incoterm'=>'truck-loading',
  4130. 'margin'=>'calculator', 'members'=>'user-friends', 'ticket'=>'ticket-alt', 'globe'=>'external-link-alt', 'lot'=>'barcode',
  4131. 'email'=>'at', 'establishment'=>'building', 'edit'=>'pencil-alt', 'entity'=>'globe',
  4132. 'graph'=>'chart-line', 'grip_title'=>'arrows-alt', 'grip'=>'arrows-alt', 'help'=>'question-circle',
  4133. 'generic'=>'file', 'holiday'=>'umbrella-beach',
  4134. 'info'=>'info-circle', 'inventory'=>'boxes', 'intracommreport'=>'globe-europe', 'jobprofile'=>'cogs',
  4135. 'knowledgemanagement'=>'ticket-alt', 'label'=>'layer-group', 'line'=>'bars', 'loan'=>'money-bill-alt',
  4136. 'member'=>'user-alt', 'meeting'=>'chalkboard-teacher', 'mrp'=>'cubes', 'next'=>'arrow-alt-circle-right',
  4137. 'trip'=>'wallet', 'expensereport'=>'wallet', 'group'=>'users', 'movement'=>'people-carry',
  4138. 'sign-out'=>'sign-out-alt',
  4139. 'switch_off'=>'toggle-off', 'switch_on'=>'toggle-on', 'switch_on_warning'=>'toggle-on', 'switch_on_red'=>'toggle-on', 'check'=>'check', 'bookmark'=>'star',
  4140. 'bank'=>'university', 'close_title'=>'times', 'delete'=>'trash', 'filter'=>'filter',
  4141. 'list-alt'=>'list-alt', 'calendarlist'=>'bars', 'calendar'=>'calendar-alt', 'calendarmonth'=>'calendar-alt', 'calendarweek'=>'calendar-week', 'calendarday'=>'calendar-day', 'calendarperuser'=>'table',
  4142. 'intervention'=>'ambulance', 'invoice'=>'file-invoice-dollar', 'order'=>'file-invoice',
  4143. 'error'=>'exclamation-triangle', 'warning'=>'exclamation-triangle',
  4144. 'other'=>'square',
  4145. 'playdisabled'=>'play', 'pdf'=>'file-pdf', 'poll'=>'check-double', 'pos'=>'cash-register', 'preview'=>'binoculars', 'project'=>'project-diagram', 'projectpub'=>'project-diagram', 'projecttask'=>'tasks', 'propal'=>'file-signature', 'proposal'=>'file-signature',
  4146. 'partnership'=>'handshake', 'payment'=>'money-check-alt', 'payment_vat'=>'money-check-alt', 'pictoconfirm'=>'check-square', 'phoning'=>'phone', 'phoning_mobile'=>'mobile-alt', 'phoning_fax'=>'fax', 'previous'=>'arrow-alt-circle-left', 'printer'=>'print', 'product'=>'cube', 'puce'=>'angle-right',
  4147. 'recent' => 'check-square', 'reception'=>'dolly', 'recruitmentjobposition'=>'id-card-alt', 'recruitmentcandidature'=>'id-badge',
  4148. 'resize'=>'crop', 'supplier_order'=>'dol-order_supplier', 'supplier_proposal'=>'file-signature',
  4149. 'refresh'=>'redo', 'region'=>'map-marked', 'replacement'=>'exchange-alt', 'resource'=>'laptop-house', 'recurring'=>'history',
  4150. 'service'=>'concierge-bell',
  4151. 'skill'=>'shapes', 'state'=>'map-marked-alt', 'security'=>'key', 'salary'=>'wallet', 'shipment'=>'dolly', 'stock'=>'box-open', 'stats' => 'chart-bar', 'split'=>'code-branch', 'stripe'=>'stripe-s',
  4152. 'supplier'=>'building', 'technic'=>'cogs',
  4153. 'timespent'=>'clock', 'title_setup'=>'tools', 'title_accountancy'=>'money-check-alt', 'title_bank'=>'university', 'title_hrm'=>'umbrella-beach',
  4154. 'title_agenda'=>'calendar-alt',
  4155. 'uncheck'=>'times', 'uparrow'=>'share', 'url'=>'external-link-alt', 'vat'=>'money-check-alt', 'vcard'=>'arrow-alt-circle-down',
  4156. 'jabber'=>'comment-o',
  4157. 'website'=>'globe-americas', 'workstation'=>'pallet', 'webhook'=>'bullseye', 'world'=>'globe', 'private'=>'user-lock',
  4158. 'conferenceorbooth'=>'chalkboard-teacher', 'eventorganization'=>'project-diagram'
  4159. );
  4160. if ($conf->currency == 'EUR') {
  4161. $arrayconvpictotofa['currency'] = 'euro-sign';
  4162. $arrayconvpictotofa['multicurrency'] = 'dollar-sign';
  4163. } else {
  4164. $arrayconvpictotofa['currency'] = 'dollar-sign';
  4165. $arrayconvpictotofa['multicurrency'] = 'euro-sign';
  4166. }
  4167. if ($pictowithouttext == 'off') {
  4168. $fakey = 'fa-square';
  4169. $fasize = '1.3em';
  4170. } elseif ($pictowithouttext == 'on') {
  4171. $fakey = 'fa-check-square';
  4172. $fasize = '1.3em';
  4173. } elseif ($pictowithouttext == 'listlight') {
  4174. $fakey = 'fa-download';
  4175. $marginleftonlyshort = 1;
  4176. } elseif ($pictowithouttext == 'printer') {
  4177. $fakey = 'fa-print';
  4178. $fasize = '1.2em';
  4179. } elseif ($pictowithouttext == 'note') {
  4180. $fakey = 'fa-sticky-note';
  4181. $marginleftonlyshort = 1;
  4182. } elseif (in_array($pictowithouttext, array('1uparrow', '1downarrow', '1leftarrow', '1rightarrow', '1uparrow_selected', '1downarrow_selected', '1leftarrow_selected', '1rightarrow_selected'))) {
  4183. $convertarray = array('1uparrow'=>'caret-up', '1downarrow'=>'caret-down', '1leftarrow'=>'caret-left', '1rightarrow'=>'caret-right', '1uparrow_selected'=>'caret-up', '1downarrow_selected'=>'caret-down', '1leftarrow_selected'=>'caret-left', '1rightarrow_selected'=>'caret-right');
  4184. $fakey = 'fa-'.$convertarray[$pictowithouttext];
  4185. if (preg_match('/selected/', $pictowithouttext)) {
  4186. $facolor = '#888';
  4187. }
  4188. $marginleftonlyshort = 1;
  4189. } elseif (!empty($arrayconvpictotofa[$pictowithouttext])) {
  4190. $fakey = 'fa-'.$arrayconvpictotofa[$pictowithouttext];
  4191. } else {
  4192. $fakey = 'fa-'.$pictowithouttext;
  4193. }
  4194. if (in_array($pictowithouttext, array('dollyrevert', 'member', 'members', 'contract', 'group', 'resource', 'shipment'))) {
  4195. $morecss .= ' em092';
  4196. }
  4197. if (in_array($pictowithouttext, array('conferenceorbooth', 'collab', 'eventorganization', 'holiday', 'info', 'project', 'workstation'))) {
  4198. $morecss .= ' em088';
  4199. }
  4200. if (in_array($pictowithouttext, array('asset', 'intervention', 'payment', 'loan', 'partnership', 'stock', 'technic'))) {
  4201. $morecss .= ' em080';
  4202. }
  4203. // Define $marginleftonlyshort
  4204. $arrayconvpictotomarginleftonly = array(
  4205. 'bank', 'check', 'delete', 'generic', 'grip', 'grip_title', 'jabber',
  4206. 'grip_title', 'grip', 'listlight', 'note', 'on', 'off', 'playdisabled', 'printer', 'resize', 'sign-out', 'stats', 'switch_on', 'switch_on_red', 'switch_off',
  4207. 'uparrow', '1uparrow', '1downarrow', '1leftarrow', '1rightarrow', '1uparrow_selected', '1downarrow_selected', '1leftarrow_selected', '1rightarrow_selected'
  4208. );
  4209. if (!isset($arrayconvpictotomarginleftonly[$pictowithouttext])) {
  4210. $marginleftonlyshort = 0;
  4211. }
  4212. // Add CSS
  4213. $arrayconvpictotomorcess = array(
  4214. 'action'=>'infobox-action', 'account'=>'infobox-bank_account', 'accounting_account'=>'infobox-bank_account', 'accountline'=>'infobox-bank_account', 'accountancy'=>'infobox-bank_account', 'asset'=>'infobox-bank_account',
  4215. 'bank_account'=>'infobox-bank_account',
  4216. 'bill'=>'infobox-commande', 'billa'=>'infobox-commande', 'billr'=>'infobox-commande', 'billd'=>'infobox-commande',
  4217. 'margin'=>'infobox-bank_account', 'conferenceorbooth'=>'infobox-project',
  4218. 'cash-register'=>'infobox-bank_account', 'contract'=>'infobox-contrat', 'check'=>'font-status4', 'collab'=>'infobox-action', 'conversation'=>'infobox-contrat',
  4219. 'donation'=>'infobox-commande', 'dolly'=>'infobox-commande', 'dollyrevert'=>'flip infobox-order_supplier',
  4220. 'ecm'=>'infobox-action', 'eventorganization'=>'infobox-project',
  4221. 'hrm'=>'infobox-adherent', 'group'=>'infobox-adherent', 'intervention'=>'infobox-contrat',
  4222. 'incoterm'=>'infobox-supplier_proposal',
  4223. 'currency'=>'infobox-bank_account', 'multicurrency'=>'infobox-bank_account',
  4224. 'members'=>'infobox-adherent', 'member'=>'infobox-adherent', 'money-bill-alt'=>'infobox-bank_account',
  4225. 'order'=>'infobox-commande',
  4226. 'user'=>'infobox-adherent', 'users'=>'infobox-adherent',
  4227. 'error'=>'pictoerror', 'warning'=>'pictowarning', 'switch_on'=>'font-status4', 'switch_on_warning'=>'font-status4 warning', 'switch_on_red'=>'font-status8',
  4228. 'holiday'=>'infobox-holiday', 'info'=>'opacityhigh', 'invoice'=>'infobox-commande',
  4229. 'knowledgemanagement'=>'infobox-contrat rotate90', 'loan'=>'infobox-bank_account',
  4230. 'payment'=>'infobox-bank_account', 'payment_vat'=>'infobox-bank_account', 'poll'=>'infobox-adherent', 'pos'=>'infobox-bank_account', 'project'=>'infobox-project', 'projecttask'=>'infobox-project',
  4231. 'propal'=>'infobox-propal', 'proposal'=>'infobox-propal','private'=>'infobox-project',
  4232. 'reception'=>'flip', 'recruitmentjobposition'=>'infobox-adherent', 'recruitmentcandidature'=>'infobox-adherent',
  4233. 'resource'=>'infobox-action',
  4234. 'salary'=>'infobox-bank_account', 'shapes'=>'infobox-adherent', 'shipment'=>'infobox-commande', 'supplier_invoice'=>'infobox-order_supplier', 'supplier_invoicea'=>'infobox-order_supplier', 'supplier_invoiced'=>'infobox-order_supplier',
  4235. 'supplier'=>'infobox-order_supplier', 'supplier_order'=>'infobox-order_supplier', 'supplier_proposal'=>'infobox-supplier_proposal',
  4236. 'ticket'=>'infobox-contrat', 'title_accountancy'=>'infobox-bank_account', 'title_hrm'=>'infobox-holiday', 'expensereport'=>'infobox-expensereport', 'trip'=>'infobox-expensereport', 'title_agenda'=>'infobox-action',
  4237. 'vat'=>'infobox-bank_account',
  4238. //'title_setup'=>'infobox-action', 'tools'=>'infobox-action',
  4239. 'list-alt'=>'imgforviewmode', 'calendar'=>'imgforviewmode', 'calendarweek'=>'imgforviewmode', 'calendarmonth'=>'imgforviewmode', 'calendarday'=>'imgforviewmode', 'calendarperuser'=>'imgforviewmode'
  4240. );
  4241. if (!empty($arrayconvpictotomorcess[$pictowithouttext]) && strpos($picto, '_nocolor') === false) {
  4242. $morecss .= ($morecss ? ' ' : '').$arrayconvpictotomorcess[$pictowithouttext];
  4243. }
  4244. // Define $color
  4245. $arrayconvpictotocolor = array(
  4246. 'address'=>'#6c6aa8', 'building'=>'#6c6aa8', 'bom'=>'#a69944',
  4247. 'clone'=>'#999', 'cog'=>'#999', 'companies'=>'#6c6aa8', 'company'=>'#6c6aa8', 'contact'=>'#6c6aa8', 'cron'=>'#555',
  4248. 'dynamicprice'=>'#a69944',
  4249. 'edit'=>'#444', 'note'=>'#999', 'error'=>'', 'help'=>'#bbb', 'listlight'=>'#999', 'language'=>'#555',
  4250. //'dolly'=>'#a69944', 'dollyrevert'=>'#a69944',
  4251. 'lock'=>'#ddd', 'lot'=>'#a69944',
  4252. 'map-marker-alt'=>'#aaa', 'mrp'=>'#a69944', 'product'=>'#a69944', 'service'=>'#a69944', 'inventory'=>'#a69944', 'stock'=>'#a69944', 'movement'=>'#a69944',
  4253. 'other'=>'#ddd', 'world'=>'#986c6a',
  4254. 'partnership'=>'#6c6aa8', 'playdisabled'=>'#ccc', 'printer'=>'#444', 'projectpub'=>'#986c6a', 'reception'=>'#a69944', 'resize'=>'#444', 'rss'=>'#cba',
  4255. //'shipment'=>'#a69944',
  4256. 'security'=>'#999', 'square'=>'#888', 'stop-circle'=>'#888', 'stats'=>'#444', 'switch_off'=>'#999', 'technic'=>'#999', 'timespent'=>'#555',
  4257. 'uncheck'=>'#800', 'uparrow'=>'#555', 'user-cog'=>'#999', 'country'=>'#aaa', 'globe-americas'=>'#aaa', 'region'=>'#aaa', 'state'=>'#aaa',
  4258. 'website'=>'#304', 'workstation'=>'#a69944'
  4259. );
  4260. if (isset($arrayconvpictotocolor[$pictowithouttext]) && strpos($picto, '_nocolor') === false) {
  4261. $facolor = $arrayconvpictotocolor[$pictowithouttext];
  4262. }
  4263. // This snippet only needed since function img_edit accepts only one additional parameter: no separate one for css only.
  4264. // class/style need to be extracted to avoid duplicate class/style validation errors when $moreatt is added to the end of the attributes.
  4265. $morestyle = '';
  4266. $reg = array();
  4267. if (preg_match('/class="([^"]+)"/', $moreatt, $reg)) {
  4268. $morecss .= ($morecss ? ' ' : '').$reg[1];
  4269. $moreatt = str_replace('class="'.$reg[1].'"', '', $moreatt);
  4270. }
  4271. if (preg_match('/style="([^"]+)"/', $moreatt, $reg)) {
  4272. $morestyle = $reg[1];
  4273. $moreatt = str_replace('style="'.$reg[1].'"', '', $moreatt);
  4274. }
  4275. $moreatt = trim($moreatt);
  4276. $enabledisablehtml = '<span class="'.$fa.' '.$fakey.($marginleftonlyshort ? ($marginleftonlyshort == 1 ? ' marginleftonlyshort' : ' marginleftonly') : '');
  4277. $enabledisablehtml .= ($morecss ? ' '.$morecss : '').'" style="'.($fasize ? ('font-size: '.$fasize.';') : '').($facolor ? (' color: '.$facolor.';') : '').($morestyle ? ' '.$morestyle : '').'"'.(($notitle || empty($titlealt)) ? '' : ' title="'.dol_escape_htmltag($titlealt).'"').($moreatt ? ' '.$moreatt : '').'>';
  4278. /*if (!empty($conf->global->MAIN_OPTIMIZEFORTEXTBROWSER)) {
  4279. $enabledisablehtml .= $titlealt;
  4280. }*/
  4281. $enabledisablehtml .= '</span>';
  4282. return $enabledisablehtml;
  4283. }
  4284. if (getDolGlobalString('MAIN_OVERWRITE_THEME_PATH')) {
  4285. $path = getDolGlobalString('MAIN_OVERWRITE_THEME_PATH') . '/theme/'.$theme; // If the theme does not have the same name as the module
  4286. } elseif (getDolGlobalString('MAIN_OVERWRITE_THEME_RES')) {
  4287. $path = getDolGlobalString('MAIN_OVERWRITE_THEME_RES') . '/theme/' . getDolGlobalString('MAIN_OVERWRITE_THEME_RES'); // To allow an external module to overwrite image resources whatever is activated theme
  4288. } elseif (!empty($conf->modules_parts['theme']) && array_key_exists($theme, $conf->modules_parts['theme'])) {
  4289. $path = $theme.'/theme/'.$theme; // If the theme have the same name as the module
  4290. }
  4291. // If we ask an image into $url/$mymodule/img (instead of default path)
  4292. $regs = array();
  4293. if (preg_match('/^([^@]+)@([^@]+)$/i', $picto, $regs)) {
  4294. $picto = $regs[1];
  4295. $path = $regs[2]; // $path is $mymodule
  4296. }
  4297. // Clean parameters
  4298. if (!preg_match('/(\.png|\.gif|\.svg)$/i', $picto)) {
  4299. $picto .= '.png';
  4300. }
  4301. // If alt path are defined, define url where img file is, according to physical path
  4302. // ex: array(["main"]=>"/home/maindir/htdocs", ["alt0"]=>"/home/moddir0/htdocs", ...)
  4303. foreach ($conf->file->dol_document_root as $type => $dirroot) {
  4304. if ($type == 'main') {
  4305. continue;
  4306. }
  4307. // This need a lot of time, that's why enabling alternative dir like "custom" dir is not recommanded
  4308. if (file_exists($dirroot.'/'.$path.'/img/'.$picto)) {
  4309. $url = DOL_URL_ROOT.$conf->file->dol_url_root[$type];
  4310. break;
  4311. }
  4312. }
  4313. // $url is '' or '/custom', $path is current theme or
  4314. $fullpathpicto = $url.'/'.$path.'/img/'.$picto;
  4315. }
  4316. if ($srconly) {
  4317. return $fullpathpicto;
  4318. }
  4319. // tag title is used for tooltip on <a>, tag alt can be used with very simple text on image for blind people
  4320. return '<img src="'.$fullpathpicto.'"'.($notitle ? '' : ' alt="'.dol_escape_htmltag($alt).'"').(($notitle || empty($titlealt)) ? '' : ' title="'.dol_escape_htmltag($titlealt).'"').($moreatt ? ' '.$moreatt.($morecss ? ' class="'.$morecss.'"' : '') : ' class="inline-block'.($morecss ? ' '.$morecss : '').'"').'>'; // Alt is used for accessibility, title for popup
  4321. }
  4322. /**
  4323. * Show a picto called object_picto (generic function)
  4324. *
  4325. * @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
  4326. * @param string $picto Name of image to show object_picto (example: user, group, action, bill, contract, propal, product, ...)
  4327. * For external modules use imagename@mymodule to search into directory "img" of module.
  4328. * @param string $moreatt Add more attribute on img tag (ie: class="datecallink")
  4329. * @param int $pictoisfullpath If 1, image path is a full path
  4330. * @param int $srconly Return only content of the src attribute of img.
  4331. * @param int $notitle 1=Disable tag title. Use it if you add js tooltip, to avoid duplicate tooltip.
  4332. * @return string Return img tag
  4333. * @see img_picto(), img_picto_common()
  4334. */
  4335. function img_object($titlealt, $picto, $moreatt = '', $pictoisfullpath = false, $srconly = 0, $notitle = 0)
  4336. {
  4337. if (strpos($picto, '^') === 0) {
  4338. return img_picto($titlealt, str_replace('^', '', $picto), $moreatt, $pictoisfullpath, $srconly, $notitle);
  4339. } else {
  4340. return img_picto($titlealt, 'object_'.$picto, $moreatt, $pictoisfullpath, $srconly, $notitle);
  4341. }
  4342. }
  4343. /**
  4344. * Show weather picto
  4345. *
  4346. * @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
  4347. * @param string|int $picto Name of image file to show (If no extension provided, we use '.png'). Image must be stored into htdocs/theme/common directory. Or level of meteo image (0-4).
  4348. * @param string $moreatt Add more attribute on img tag
  4349. * @param int $pictoisfullpath If 1, image path is a full path
  4350. * @param string $morecss More CSS
  4351. * @return string Return img tag
  4352. * @see img_object(), img_picto()
  4353. */
  4354. function img_weather($titlealt, $picto, $moreatt = '', $pictoisfullpath = 0, $morecss = '')
  4355. {
  4356. global $conf;
  4357. if (is_numeric($picto)) {
  4358. //$leveltopicto = array(0=>'weather-clear.png', 1=>'weather-few-clouds.png', 2=>'weather-clouds.png', 3=>'weather-many-clouds.png', 4=>'weather-storm.png');
  4359. //$picto = $leveltopicto[$picto];
  4360. return '<i class="fa fa-weather-level'.$picto.'"></i>';
  4361. } elseif (!preg_match('/(\.png|\.gif)$/i', $picto)) {
  4362. $picto .= '.png';
  4363. }
  4364. $path = DOL_URL_ROOT.'/theme/'.$conf->theme.'/img/weather/'.$picto;
  4365. return img_picto($titlealt, $path, $moreatt, 1, 0, 0, '', $morecss);
  4366. }
  4367. /**
  4368. * Show picto (generic function)
  4369. *
  4370. * @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
  4371. * @param string $picto Name of image file to show (If no extension provided, we use '.png'). Image must be stored into htdocs/theme/common directory.
  4372. * @param string $moreatt Add more attribute on img tag
  4373. * @param int $pictoisfullpath If 1, image path is a full path
  4374. * @param int $notitle 1=Disable tag title. Use it if you add js tooltip, to avoid duplicate tooltip.
  4375. * @return string Return img tag
  4376. * @see img_object(), img_picto()
  4377. */
  4378. function img_picto_common($titlealt, $picto, $moreatt = '', $pictoisfullpath = 0, $notitle = 0)
  4379. {
  4380. global $conf;
  4381. if (!preg_match('/(\.png|\.gif)$/i', $picto)) {
  4382. $picto .= '.png';
  4383. }
  4384. if ($pictoisfullpath) {
  4385. $path = $picto;
  4386. } else {
  4387. $path = DOL_URL_ROOT.'/theme/common/'.$picto;
  4388. if (getDolGlobalInt('MAIN_MODULE_CAN_OVERWRITE_COMMONICONS')) {
  4389. $themepath = DOL_DOCUMENT_ROOT.'/theme/'.$conf->theme.'/img/'.$picto;
  4390. if (file_exists($themepath)) {
  4391. $path = $themepath;
  4392. }
  4393. }
  4394. }
  4395. return img_picto($titlealt, $path, $moreatt, 1, 0, $notitle);
  4396. }
  4397. /**
  4398. * Show logo action
  4399. *
  4400. * @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
  4401. * @param string $numaction Action id or code to show
  4402. * @param string $picto Name of image file to show ('filenew', ...)
  4403. * If no extension provided, we use '.png'. Image must be stored into theme/xxx/img directory.
  4404. * Example: picto.png if picto.png is stored into htdocs/theme/mytheme/img
  4405. * Example: picto.png@mymodule if picto.png is stored into htdocs/mymodule/img
  4406. * Example: /mydir/mysubdir/picto.png if picto.png is stored into htdocs/mydir/mysubdir (pictoisfullpath must be set to 1)
  4407. * @param string $moreatt More attributes
  4408. * @return string Return an img tag
  4409. */
  4410. function img_action($titlealt, $numaction, $picto = '', $moreatt = '')
  4411. {
  4412. global $langs;
  4413. if (empty($titlealt) || $titlealt == 'default') {
  4414. if ($numaction == '-1' || $numaction == 'ST_NO') {
  4415. $numaction = -1;
  4416. $titlealt = $langs->transnoentitiesnoconv('ChangeDoNotContact');
  4417. } elseif ($numaction == '0' || $numaction == 'ST_NEVER') {
  4418. $numaction = 0;
  4419. $titlealt = $langs->transnoentitiesnoconv('ChangeNeverContacted');
  4420. } elseif ($numaction == '1' || $numaction == 'ST_TODO') {
  4421. $numaction = 1;
  4422. $titlealt = $langs->transnoentitiesnoconv('ChangeToContact');
  4423. } elseif ($numaction == '2' || $numaction == 'ST_PEND') {
  4424. $numaction = 2;
  4425. $titlealt = $langs->transnoentitiesnoconv('ChangeContactInProcess');
  4426. } elseif ($numaction == '3' || $numaction == 'ST_DONE') {
  4427. $numaction = 3;
  4428. $titlealt = $langs->transnoentitiesnoconv('ChangeContactDone');
  4429. } else {
  4430. $titlealt = $langs->transnoentitiesnoconv('ChangeStatus '.$numaction);
  4431. $numaction = 0;
  4432. }
  4433. }
  4434. if (!is_numeric($numaction)) {
  4435. $numaction = 0;
  4436. }
  4437. return img_picto($titlealt, (empty($picto) ? 'stcomm'.$numaction.'.png' : $picto), $moreatt);
  4438. }
  4439. /**
  4440. * Show pdf logo
  4441. *
  4442. * @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
  4443. * @param int $size Taille de l'icone : 3 = 16x16px , 2 = 14x14px
  4444. * @return string Retourne tag img
  4445. */
  4446. function img_pdf($titlealt = 'default', $size = 3)
  4447. {
  4448. global $langs;
  4449. if ($titlealt == 'default') {
  4450. $titlealt = $langs->trans('Show');
  4451. }
  4452. return img_picto($titlealt, 'pdf'.$size.'.png');
  4453. }
  4454. /**
  4455. * Show logo +
  4456. *
  4457. * @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
  4458. * @param string $other Add more attributes on img
  4459. * @return string Return tag img
  4460. */
  4461. function img_edit_add($titlealt = 'default', $other = '')
  4462. {
  4463. global $langs;
  4464. if ($titlealt == 'default') {
  4465. $titlealt = $langs->trans('Add');
  4466. }
  4467. return img_picto($titlealt, 'edit_add.png', $other);
  4468. }
  4469. /**
  4470. * Show logo -
  4471. *
  4472. * @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
  4473. * @param string $other Add more attributes on img
  4474. * @return string Return tag img
  4475. */
  4476. function img_edit_remove($titlealt = 'default', $other = '')
  4477. {
  4478. global $langs;
  4479. if ($titlealt == 'default') {
  4480. $titlealt = $langs->trans('Remove');
  4481. }
  4482. return img_picto($titlealt, 'edit_remove.png', $other);
  4483. }
  4484. /**
  4485. * Show logo editer/modifier fiche
  4486. *
  4487. * @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
  4488. * @param integer $float If you have to put the style "float: right"
  4489. * @param string $other Add more attributes on img
  4490. * @return string Return tag img
  4491. */
  4492. function img_edit($titlealt = 'default', $float = 0, $other = '')
  4493. {
  4494. global $langs;
  4495. if ($titlealt == 'default') {
  4496. $titlealt = $langs->trans('Modify');
  4497. }
  4498. return img_picto($titlealt, 'edit.png', ($float ? 'style="float: '.($langs->tab_translate["DIRECTION"] == 'rtl' ? 'left' : 'right').'"' : "").($other ? ' '.$other : ''));
  4499. }
  4500. /**
  4501. * Show logo view card
  4502. *
  4503. * @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
  4504. * @param integer $float If you have to put the style "float: right"
  4505. * @param string $other Add more attributes on img
  4506. * @return string Return tag img
  4507. */
  4508. function img_view($titlealt = 'default', $float = 0, $other = 'class="valignmiddle"')
  4509. {
  4510. global $langs;
  4511. if ($titlealt == 'default') {
  4512. $titlealt = $langs->trans('View');
  4513. }
  4514. $moreatt = ($float ? 'style="float: right" ' : '').$other;
  4515. return img_picto($titlealt, 'eye', $moreatt);
  4516. }
  4517. /**
  4518. * Show delete logo
  4519. *
  4520. * @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
  4521. * @param string $other Add more attributes on img
  4522. * @param string $morecss More CSS
  4523. * @return string Retourne tag img
  4524. */
  4525. function img_delete($titlealt = 'default', $other = 'class="pictodelete"', $morecss = '')
  4526. {
  4527. global $langs;
  4528. if ($titlealt == 'default') {
  4529. $titlealt = $langs->trans('Delete');
  4530. }
  4531. return img_picto($titlealt, 'delete.png', $other, false, 0, 0, '', $morecss);
  4532. }
  4533. /**
  4534. * Show printer logo
  4535. *
  4536. * @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
  4537. * @param string $other Add more attributes on img
  4538. * @return string Retourne tag img
  4539. */
  4540. function img_printer($titlealt = "default", $other = '')
  4541. {
  4542. global $langs;
  4543. if ($titlealt == "default") {
  4544. $titlealt = $langs->trans("Print");
  4545. }
  4546. return img_picto($titlealt, 'printer.png', $other);
  4547. }
  4548. /**
  4549. * Show split logo
  4550. *
  4551. * @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
  4552. * @param string $other Add more attributes on img
  4553. * @return string Retourne tag img
  4554. */
  4555. function img_split($titlealt = 'default', $other = 'class="pictosplit"')
  4556. {
  4557. global $langs;
  4558. if ($titlealt == 'default') {
  4559. $titlealt = $langs->trans('Split');
  4560. }
  4561. return img_picto($titlealt, 'split.png', $other);
  4562. }
  4563. /**
  4564. * Show help logo with cursor "?"
  4565. *
  4566. * @param int $usehelpcursor 1=Use help cursor, 2=Use click pointer cursor, 0=No specific cursor
  4567. * @param int|string $usealttitle Text to use as alt title
  4568. * @return string Return tag img
  4569. */
  4570. function img_help($usehelpcursor = 1, $usealttitle = 1)
  4571. {
  4572. global $langs;
  4573. if ($usealttitle) {
  4574. if (is_string($usealttitle)) {
  4575. $usealttitle = dol_escape_htmltag($usealttitle);
  4576. } else {
  4577. $usealttitle = $langs->trans('Info');
  4578. }
  4579. }
  4580. return img_picto($usealttitle, 'info.png', 'style="vertical-align: middle;'.($usehelpcursor == 1 ? ' cursor: help' : ($usehelpcursor == 2 ? ' cursor: pointer' : '')).'"');
  4581. }
  4582. /**
  4583. * Show info logo
  4584. *
  4585. * @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
  4586. * @return string Return img tag
  4587. */
  4588. function img_info($titlealt = 'default')
  4589. {
  4590. global $langs;
  4591. if ($titlealt == 'default') {
  4592. $titlealt = $langs->trans('Informations');
  4593. }
  4594. return img_picto($titlealt, 'info.png', 'style="vertical-align: middle;"');
  4595. }
  4596. /**
  4597. * Show warning logo
  4598. *
  4599. * @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
  4600. * @param string $moreatt Add more attribute on img tag (For example 'style="float: right"'). If 1, add float: right. Can't be "class" attribute.
  4601. * @param string $morecss Add more CSS
  4602. * @return string Return img tag
  4603. */
  4604. function img_warning($titlealt = 'default', $moreatt = '', $morecss = 'pictowarning')
  4605. {
  4606. global $langs;
  4607. if ($titlealt == 'default') {
  4608. $titlealt = $langs->trans('Warning');
  4609. }
  4610. //return '<div class="imglatecoin">'.img_picto($titlealt, 'warning_white.png', 'class="pictowarning valignmiddle"'.($moreatt ? ($moreatt == '1' ? ' style="float: right"' : ' '.$moreatt): '')).'</div>';
  4611. return img_picto($titlealt, 'warning.png', 'class="'.$morecss.'"'.($moreatt ? ($moreatt == '1' ? ' style="float: right"' : ' '.$moreatt) : ''));
  4612. }
  4613. /**
  4614. * Show error logo
  4615. *
  4616. * @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
  4617. * @return string Return img tag
  4618. */
  4619. function img_error($titlealt = 'default')
  4620. {
  4621. global $langs;
  4622. if ($titlealt == 'default') {
  4623. $titlealt = $langs->trans('Error');
  4624. }
  4625. return img_picto($titlealt, 'error.png');
  4626. }
  4627. /**
  4628. * Show next logo
  4629. *
  4630. * @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
  4631. * @param string $moreatt Add more attribute on img tag (For example 'style="float: right"')
  4632. * @return string Return img tag
  4633. */
  4634. function img_next($titlealt = 'default', $moreatt = '')
  4635. {
  4636. global $langs;
  4637. if ($titlealt == 'default') {
  4638. $titlealt = $langs->trans('Next');
  4639. }
  4640. //return img_picto($titlealt, 'next.png', $moreatt);
  4641. return '<span class="fa fa-chevron-right paddingright paddingleft" title="'.dol_escape_htmltag($titlealt).'"></span>';
  4642. }
  4643. /**
  4644. * Show previous logo
  4645. *
  4646. * @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
  4647. * @param string $moreatt Add more attribute on img tag (For example 'style="float: right"')
  4648. * @return string Return img tag
  4649. */
  4650. function img_previous($titlealt = 'default', $moreatt = '')
  4651. {
  4652. global $langs;
  4653. if ($titlealt == 'default') {
  4654. $titlealt = $langs->trans('Previous');
  4655. }
  4656. //return img_picto($titlealt, 'previous.png', $moreatt);
  4657. return '<span class="fa fa-chevron-left paddingright paddingleft" title="'.dol_escape_htmltag($titlealt).'"></span>';
  4658. }
  4659. /**
  4660. * Show down arrow logo
  4661. *
  4662. * @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
  4663. * @param int $selected Selected
  4664. * @param string $moreclass Add more CSS classes
  4665. * @return string Return img tag
  4666. */
  4667. function img_down($titlealt = 'default', $selected = 0, $moreclass = '')
  4668. {
  4669. global $langs;
  4670. if ($titlealt == 'default') {
  4671. $titlealt = $langs->trans('Down');
  4672. }
  4673. return img_picto($titlealt, ($selected ? '1downarrow_selected.png' : '1downarrow.png'), 'class="imgdown'.($moreclass ? " ".$moreclass : "").'"');
  4674. }
  4675. /**
  4676. * Show top arrow logo
  4677. *
  4678. * @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
  4679. * @param int $selected Selected
  4680. * @param string $moreclass Add more CSS classes
  4681. * @return string Return img tag
  4682. */
  4683. function img_up($titlealt = 'default', $selected = 0, $moreclass = '')
  4684. {
  4685. global $langs;
  4686. if ($titlealt == 'default') {
  4687. $titlealt = $langs->trans('Up');
  4688. }
  4689. return img_picto($titlealt, ($selected ? '1uparrow_selected.png' : '1uparrow.png'), 'class="imgup'.($moreclass ? " ".$moreclass : "").'"');
  4690. }
  4691. /**
  4692. * Show left arrow logo
  4693. *
  4694. * @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
  4695. * @param int $selected Selected
  4696. * @param string $moreatt Add more attribute on img tag (For example 'style="float: right"')
  4697. * @return string Return img tag
  4698. */
  4699. function img_left($titlealt = 'default', $selected = 0, $moreatt = '')
  4700. {
  4701. global $langs;
  4702. if ($titlealt == 'default') {
  4703. $titlealt = $langs->trans('Left');
  4704. }
  4705. return img_picto($titlealt, ($selected ? '1leftarrow_selected.png' : '1leftarrow.png'), $moreatt);
  4706. }
  4707. /**
  4708. * Show right arrow logo
  4709. *
  4710. * @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
  4711. * @param int $selected Selected
  4712. * @param string $moreatt Add more attribute on img tag (For example 'style="float: right"')
  4713. * @return string Return img tag
  4714. */
  4715. function img_right($titlealt = 'default', $selected = 0, $moreatt = '')
  4716. {
  4717. global $langs;
  4718. if ($titlealt == 'default') {
  4719. $titlealt = $langs->trans('Right');
  4720. }
  4721. return img_picto($titlealt, ($selected ? '1rightarrow_selected.png' : '1rightarrow.png'), $moreatt);
  4722. }
  4723. /**
  4724. * Show tick logo if allowed
  4725. *
  4726. * @param string $allow Allow
  4727. * @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
  4728. * @return string Return img tag
  4729. */
  4730. function img_allow($allow, $titlealt = 'default')
  4731. {
  4732. global $langs;
  4733. if ($titlealt == 'default') {
  4734. $titlealt = $langs->trans('Active');
  4735. }
  4736. if ($allow == 1) {
  4737. return img_picto($titlealt, 'tick.png');
  4738. }
  4739. return '-';
  4740. }
  4741. /**
  4742. * Return image of a credit card according to its brand name
  4743. *
  4744. * @param string $brand Brand name of credit card
  4745. * @param string $morecss More CSS
  4746. * @return string Return img tag
  4747. */
  4748. function img_credit_card($brand, $morecss = null)
  4749. {
  4750. if (is_null($morecss)) {
  4751. $morecss = 'fa-2x';
  4752. }
  4753. if ($brand == 'visa' || $brand == 'Visa') {
  4754. $brand = 'cc-visa';
  4755. } elseif ($brand == 'mastercard' || $brand == 'MasterCard') {
  4756. $brand = 'cc-mastercard';
  4757. } elseif ($brand == 'amex' || $brand == 'American Express') {
  4758. $brand = 'cc-amex';
  4759. } elseif ($brand == 'discover' || $brand == 'Discover') {
  4760. $brand = 'cc-discover';
  4761. } elseif ($brand == 'jcb' || $brand == 'JCB') {
  4762. $brand = 'cc-jcb';
  4763. } elseif ($brand == 'diners' || $brand == 'Diners club') {
  4764. $brand = 'cc-diners-club';
  4765. } elseif (!in_array($brand, array('cc-visa', 'cc-mastercard', 'cc-amex', 'cc-discover', 'cc-jcb', 'cc-diners-club'))) {
  4766. $brand = 'credit-card';
  4767. }
  4768. return '<span class="fa fa-'.$brand.' fa-fw'.($morecss ? ' '.$morecss : '').'"></span>';
  4769. }
  4770. /**
  4771. * Show MIME img of a file
  4772. *
  4773. * @param string $file Filename
  4774. * @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
  4775. * @param string $morecss More css
  4776. * @return string Return img tag
  4777. */
  4778. function img_mime($file, $titlealt = '', $morecss = '')
  4779. {
  4780. require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
  4781. $mimetype = dol_mimetype($file, '', 1);
  4782. $mimeimg = dol_mimetype($file, '', 2);
  4783. $mimefa = dol_mimetype($file, '', 4);
  4784. if (empty($titlealt)) {
  4785. $titlealt = 'Mime type: '.$mimetype;
  4786. }
  4787. //return img_picto_common($titlealt, 'mime/'.$mimeimg, 'class="'.$morecss.'"');
  4788. return '<i class="fa fa-'.$mimefa.' paddingright'.($morecss ? ' '.$morecss : '').'"'.($titlealt ? ' title="'.$titlealt.'"' : '').'></i>';
  4789. }
  4790. /**
  4791. * Show search logo
  4792. *
  4793. * @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
  4794. * @param string $other Add more attributes on img
  4795. * @return string Retourne tag img
  4796. */
  4797. function img_search($titlealt = 'default', $other = '')
  4798. {
  4799. global $conf, $langs;
  4800. if ($titlealt == 'default') {
  4801. $titlealt = $langs->trans('Search');
  4802. }
  4803. $img = img_picto($titlealt, 'search.png', $other, false, 1);
  4804. $input = '<input type="image" class="liste_titre" name="button_search" src="'.$img.'" ';
  4805. $input .= 'value="'.dol_escape_htmltag($titlealt).'" title="'.dol_escape_htmltag($titlealt).'" >';
  4806. return $input;
  4807. }
  4808. /**
  4809. * Show search logo
  4810. *
  4811. * @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
  4812. * @param string $other Add more attributes on img
  4813. * @return string Retourne tag img
  4814. */
  4815. function img_searchclear($titlealt = 'default', $other = '')
  4816. {
  4817. global $conf, $langs;
  4818. if ($titlealt == 'default') {
  4819. $titlealt = $langs->trans('Search');
  4820. }
  4821. $img = img_picto($titlealt, 'searchclear.png', $other, false, 1);
  4822. $input = '<input type="image" class="liste_titre" name="button_removefilter" src="'.$img.'" ';
  4823. $input .= 'value="'.dol_escape_htmltag($titlealt).'" title="'.dol_escape_htmltag($titlealt).'" >';
  4824. return $input;
  4825. }
  4826. /**
  4827. * Show information for admin users or standard users
  4828. *
  4829. * @param string $text Text info
  4830. * @param integer $infoonimgalt Info is shown only on alt of star picto, otherwise it is show on output after the star picto
  4831. * @param int $nodiv No div
  4832. * @param string $admin '1'=Info for admin users. '0'=Info for standard users (change only the look), 'error', 'warning', 'xxx'=Other
  4833. * @param string $morecss More CSS ('', 'warning', 'error')
  4834. * @param string $textfordropdown Show a text to click to dropdown the info box.
  4835. * @return string String with info text
  4836. */
  4837. function info_admin($text, $infoonimgalt = 0, $nodiv = 0, $admin = '1', $morecss = 'hideonsmartphone', $textfordropdown = '')
  4838. {
  4839. global $conf, $langs;
  4840. if ($infoonimgalt) {
  4841. $result = img_picto($text, 'info', 'class="'.($morecss ? ' '.$morecss : '').'"');
  4842. } else {
  4843. if (empty($conf->use_javascript_ajax)) {
  4844. $textfordropdown = '';
  4845. }
  4846. $class = (empty($admin) ? 'undefined' : ($admin == '1' ? 'info' : $admin));
  4847. $result = ($nodiv ? '' : '<div class="'.$class.($morecss ? ' '.$morecss : '').($textfordropdown ? ' hidden' : '').'">').'<span class="fa fa-info-circle" title="'.dol_escape_htmltag($admin ? $langs->trans('InfoAdmin') : $langs->trans('Note')).'"></span> '.$text.($nodiv ? '' : '</div>');
  4848. if ($textfordropdown) {
  4849. $tmpresult = '<span class="'.$class.'text opacitymedium cursorpointer">'.$langs->trans($textfordropdown).' '.img_picto($langs->trans($textfordropdown), '1downarrow').'</span>';
  4850. $tmpresult .= '<script nonce="'.getNonce().'" type="text/javascript">
  4851. jQuery(document).ready(function() {
  4852. jQuery(".'.$class.'text").click(function() {
  4853. console.log("toggle text");
  4854. jQuery(".'.$class.'").toggle();
  4855. });
  4856. });
  4857. </script>';
  4858. $result = $tmpresult.$result;
  4859. }
  4860. }
  4861. return $result;
  4862. }
  4863. /**
  4864. * Displays error message system with all the information to facilitate the diagnosis and the escalation of the bugs.
  4865. * This function must be called when a blocking technical error is encountered.
  4866. * However, one must try to call it only within php pages, classes must return their error through their property "error".
  4867. *
  4868. * @param DoliDB|string $db Database handler
  4869. * @param string|string[] $error String or array of errors strings to show
  4870. * @param array $errors Array of errors
  4871. * @return void
  4872. * @see dol_htmloutput_errors()
  4873. */
  4874. function dol_print_error($db = '', $error = '', $errors = null)
  4875. {
  4876. global $conf, $langs, $argv;
  4877. global $dolibarr_main_prod;
  4878. $out = '';
  4879. $syslog = '';
  4880. // If error occurs before the $lang object was loaded
  4881. if (!$langs) {
  4882. require_once DOL_DOCUMENT_ROOT.'/core/class/translate.class.php';
  4883. $langs = new Translate('', $conf);
  4884. $langs->load("main");
  4885. }
  4886. // Load translation files required by the error messages
  4887. $langs->loadLangs(array('main', 'errors'));
  4888. if ($_SERVER['DOCUMENT_ROOT']) { // Mode web
  4889. $out .= $langs->trans("DolibarrHasDetectedError").".<br>\n";
  4890. if (getDolGlobalInt('MAIN_FEATURES_LEVEL') > 0) {
  4891. $out .= "You use an experimental or develop level of features, so please do NOT report any bugs or vulnerability, except if problem is confirmed after moving option MAIN_FEATURES_LEVEL back to 0.<br>\n";
  4892. }
  4893. $out .= $langs->trans("InformationToHelpDiagnose").":<br>\n";
  4894. $out .= "<b>".$langs->trans("Date").":</b> ".dol_print_date(time(), 'dayhourlog')."<br>\n";
  4895. $out .= "<b>".$langs->trans("Dolibarr").":</b> ".DOL_VERSION." - https://www.dolibarr.org<br>\n";
  4896. if (isset($conf->global->MAIN_FEATURES_LEVEL)) {
  4897. $out .= "<b>".$langs->trans("LevelOfFeature").":</b> ".getDolGlobalInt('MAIN_FEATURES_LEVEL')."<br>\n";
  4898. }
  4899. if (function_exists("phpversion")) {
  4900. $out .= "<b>".$langs->trans("PHP").":</b> ".phpversion()."<br>\n";
  4901. }
  4902. $out .= "<b>".$langs->trans("Server").":</b> ".(isset($_SERVER["SERVER_SOFTWARE"]) ? dol_htmlentities($_SERVER["SERVER_SOFTWARE"], ENT_COMPAT) : '')."<br>\n";
  4903. if (function_exists("php_uname")) {
  4904. $out .= "<b>".$langs->trans("OS").":</b> ".php_uname()."<br>\n";
  4905. }
  4906. $out .= "<b>".$langs->trans("UserAgent").":</b> ".(isset($_SERVER["HTTP_USER_AGENT"]) ? dol_htmlentities($_SERVER["HTTP_USER_AGENT"], ENT_COMPAT) : '')."<br>\n";
  4907. $out .= "<br>\n";
  4908. $out .= "<b>".$langs->trans("RequestedUrl").":</b> ".dol_htmlentities($_SERVER["REQUEST_URI"], ENT_COMPAT)."<br>\n";
  4909. $out .= "<b>".$langs->trans("Referer").":</b> ".(isset($_SERVER["HTTP_REFERER"]) ? dol_htmlentities($_SERVER["HTTP_REFERER"], ENT_COMPAT) : '')."<br>\n";
  4910. $out .= "<b>".$langs->trans("MenuManager").":</b> ".(isset($conf->standard_menu) ? dol_htmlentities($conf->standard_menu, ENT_COMPAT) : '')."<br>\n";
  4911. $out .= "<br>\n";
  4912. $syslog .= "url=".dol_escape_htmltag($_SERVER["REQUEST_URI"]);
  4913. $syslog .= ", query_string=".dol_escape_htmltag($_SERVER["QUERY_STRING"]);
  4914. } else { // Mode CLI
  4915. $out .= '> '.$langs->transnoentities("ErrorInternalErrorDetected").":\n".$argv[0]."\n";
  4916. $syslog .= "pid=".dol_getmypid();
  4917. }
  4918. if (!empty($conf->modules)) {
  4919. $out .= "<b>".$langs->trans("Modules").":</b> ".join(', ', $conf->modules)."<br>\n";
  4920. }
  4921. if (is_object($db)) {
  4922. if ($_SERVER['DOCUMENT_ROOT']) { // Mode web
  4923. $out .= "<b>".$langs->trans("DatabaseTypeManager").":</b> ".$db->type."<br>\n";
  4924. $lastqueryerror = $db->lastqueryerror();
  4925. if (!utf8_check($lastqueryerror)) {
  4926. $lastqueryerror = "SQL error string is not a valid UTF8 string. We can't show it.";
  4927. }
  4928. $out .= "<b>".$langs->trans("RequestLastAccessInError").":</b> ".($lastqueryerror ? dol_escape_htmltag($lastqueryerror) : $langs->trans("ErrorNoRequestInError"))."<br>\n";
  4929. $out .= "<b>".$langs->trans("ReturnCodeLastAccessInError").":</b> ".($db->lasterrno() ? dol_escape_htmltag($db->lasterrno()) : $langs->trans("ErrorNoRequestInError"))."<br>\n";
  4930. $out .= "<b>".$langs->trans("InformationLastAccessInError").":</b> ".($db->lasterror() ? dol_escape_htmltag($db->lasterror()) : $langs->trans("ErrorNoRequestInError"))."<br>\n";
  4931. $out .= "<br>\n";
  4932. } else { // Mode CLI
  4933. // No dol_escape_htmltag for output, we are in CLI mode
  4934. $out .= '> '.$langs->transnoentities("DatabaseTypeManager").":\n".$db->type."\n";
  4935. $out .= '> '.$langs->transnoentities("RequestLastAccessInError").":\n".($db->lastqueryerror() ? $db->lastqueryerror() : $langs->transnoentities("ErrorNoRequestInError"))."\n";
  4936. $out .= '> '.$langs->transnoentities("ReturnCodeLastAccessInError").":\n".($db->lasterrno() ? $db->lasterrno() : $langs->transnoentities("ErrorNoRequestInError"))."\n";
  4937. $out .= '> '.$langs->transnoentities("InformationLastAccessInError").":\n".($db->lasterror() ? $db->lasterror() : $langs->transnoentities("ErrorNoRequestInError"))."\n";
  4938. }
  4939. $syslog .= ", sql=".$db->lastquery();
  4940. $syslog .= ", db_error=".$db->lasterror();
  4941. }
  4942. if ($error || $errors) {
  4943. $langs->load("errors");
  4944. // Merge all into $errors array
  4945. if (is_array($error) && is_array($errors)) {
  4946. $errors = array_merge($error, $errors);
  4947. } elseif (is_array($error)) {
  4948. $errors = $error;
  4949. } elseif (is_array($errors)) {
  4950. $errors = array_merge(array($error), $errors);
  4951. } else {
  4952. $errors = array_merge(array($error), array($errors));
  4953. }
  4954. foreach ($errors as $msg) {
  4955. if (empty($msg)) {
  4956. continue;
  4957. }
  4958. if ($_SERVER['DOCUMENT_ROOT']) { // Mode web
  4959. $out .= "<b>".$langs->trans("Message").":</b> ".dol_escape_htmltag($msg)."<br>\n";
  4960. } else { // Mode CLI
  4961. $out .= '> '.$langs->transnoentities("Message").":\n".$msg."\n";
  4962. }
  4963. $syslog .= ", msg=".$msg;
  4964. }
  4965. }
  4966. if (empty($dolibarr_main_prod) && $_SERVER['DOCUMENT_ROOT'] && function_exists('xdebug_print_function_stack') && function_exists('xdebug_call_file')) {
  4967. xdebug_print_function_stack();
  4968. $out .= '<b>XDebug informations:</b>'."<br>\n";
  4969. $out .= 'File: '.xdebug_call_file()."<br>\n";
  4970. $out .= 'Line: '.xdebug_call_line()."<br>\n";
  4971. $out .= 'Function: '.xdebug_call_function()."<br>\n";
  4972. $out .= "<br>\n";
  4973. }
  4974. // Return a http header with error code if possible
  4975. if (!headers_sent()) {
  4976. if (function_exists('top_httphead')) { // In CLI context, the method does not exists
  4977. top_httphead();
  4978. }
  4979. //http_response_code(500); // If we use 500, message is not ouput with some command line tools
  4980. http_response_code(202); // If we use 202, this is not really an error message, but this allow to ouput message on command line tools
  4981. }
  4982. if (empty($dolibarr_main_prod)) {
  4983. print $out;
  4984. } else {
  4985. if (empty($langs->defaultlang)) {
  4986. $langs->setDefaultLang();
  4987. }
  4988. $langs->loadLangs(array("main", "errors")); // Reload main because language may have been set only on previous line so we have to reload files we need.
  4989. // This should not happen, except if there is a bug somewhere. Enabled and check log in such case.
  4990. print 'This website or feature is currently temporarly not available or failed after a technical error.<br><br>This may be due to a maintenance operation. Current status of operation ('.dol_print_date(dol_now(), 'dayhourrfc').') are on next line...<br><br>'."\n";
  4991. print $langs->trans("DolibarrHasDetectedError").'. ';
  4992. print $langs->trans("YouCanSetOptionDolibarrMainProdToZero");
  4993. if (!defined("MAIN_CORE_ERROR")) {
  4994. define("MAIN_CORE_ERROR", 1);
  4995. }
  4996. }
  4997. dol_syslog("Error ".$syslog, LOG_ERR);
  4998. }
  4999. /**
  5000. * Show a public email and error code to contact if technical error
  5001. *
  5002. * @param string $prefixcode Prefix of public error code
  5003. * @param string $errormessage Complete error message
  5004. * @param array $errormessages Array of error messages
  5005. * @param string $morecss More css
  5006. * @param string $email Email
  5007. * @return void
  5008. */
  5009. function dol_print_error_email($prefixcode, $errormessage = '', $errormessages = array(), $morecss = 'error', $email = '')
  5010. {
  5011. global $langs, $conf;
  5012. if (empty($email)) {
  5013. $email = $conf->global->MAIN_INFO_SOCIETE_MAIL;
  5014. }
  5015. $langs->load("errors");
  5016. $now = dol_now();
  5017. print '<br><div class="center login_main_message"><div class="'.$morecss.'">';
  5018. print $langs->trans("ErrorContactEMail", $email, $prefixcode.'-'.dol_print_date($now, '%Y%m%d%H%M%S'));
  5019. if ($errormessage) {
  5020. print '<br><br>'.$errormessage;
  5021. }
  5022. if (is_array($errormessages) && count($errormessages)) {
  5023. foreach ($errormessages as $mesgtoshow) {
  5024. print '<br><br>'.$mesgtoshow;
  5025. }
  5026. }
  5027. print '</div></div>';
  5028. }
  5029. /**
  5030. * Show title line of an array
  5031. *
  5032. * @param string $name Label of field
  5033. * @param string $file Url used when we click on sort picto
  5034. * @param string $field Field to use for new sorting
  5035. * @param string $begin ("" by defaut)
  5036. * @param string $moreparam Add more parameters on sort url links ("" by default)
  5037. * @param string $moreattrib Options of attribute td ("" by defaut)
  5038. * @param string $sortfield Current field used to sort
  5039. * @param string $sortorder Current sort order
  5040. * @param string $prefix Prefix for css. Use space after prefix to add your own CSS tag, for example 'mycss '.
  5041. * @param string $tooltip Tooltip
  5042. * @param string $forcenowrapcolumntitle No need for use 'wrapcolumntitle' css style
  5043. * @return void
  5044. */
  5045. function print_liste_field_titre($name, $file = "", $field = "", $begin = "", $moreparam = "", $moreattrib = "", $sortfield = "", $sortorder = "", $prefix = "", $tooltip = "", $forcenowrapcolumntitle = 0)
  5046. {
  5047. print getTitleFieldOfList($name, 0, $file, $field, $begin, $moreparam, $moreattrib, $sortfield, $sortorder, $prefix, 0, $tooltip, $forcenowrapcolumntitle);
  5048. }
  5049. /**
  5050. * Get title line of an array
  5051. *
  5052. * @param string $name Translation key of field to show or complete HTML string to show
  5053. * @param int $thead 0=To use with standard table format, 1=To use inside <thead><tr>, 2=To use with <div>
  5054. * @param string $file Url used when we click on sort picto
  5055. * @param string $field Field to use for new sorting. Empty if this field is not sortable. Example "t.abc" or "t.abc,t.def"
  5056. * @param string $begin ("" by defaut)
  5057. * @param string $moreparam Add more parameters on sort url links ("" by default)
  5058. * @param string $moreattrib Add more attributes on th ("" by defaut). To add more css class, use param $prefix.
  5059. * @param string $sortfield Current field used to sort (Ex: 'd.datep,d.id')
  5060. * @param string $sortorder Current sort order (Ex: 'asc,desc')
  5061. * @param string $prefix Prefix for css. Use space after prefix to add your own CSS tag, for example 'mycss '.
  5062. * @param string $disablesortlink 1=Disable sort link
  5063. * @param string $tooltip Tooltip
  5064. * @param string $forcenowrapcolumntitle No need for use 'wrapcolumntitle' css style
  5065. * @return string
  5066. */
  5067. function getTitleFieldOfList($name, $thead = 0, $file = "", $field = "", $begin = "", $moreparam = "", $moreattrib = "", $sortfield = "", $sortorder = "", $prefix = "", $disablesortlink = 0, $tooltip = '', $forcenowrapcolumntitle = 0)
  5068. {
  5069. global $conf, $langs, $form;
  5070. //print "$name, $file, $field, $begin, $options, $moreattrib, $sortfield, $sortorder<br>\n";
  5071. if ($moreattrib == 'class="right"') {
  5072. $prefix .= 'right '; // For backward compatibility
  5073. }
  5074. $sortorder = strtoupper($sortorder);
  5075. $out = '';
  5076. $sortimg = '';
  5077. $tag = 'th';
  5078. if ($thead == 2) {
  5079. $tag = 'div';
  5080. }
  5081. $tmpsortfield = explode(',', $sortfield);
  5082. $sortfield1 = trim($tmpsortfield[0]); // If $sortfield is 'd.datep,d.id', it becomes 'd.datep'
  5083. $tmpfield = explode(',', $field);
  5084. $field1 = trim($tmpfield[0]); // If $field is 'd.datep,d.id', it becomes 'd.datep'
  5085. if (!getDolGlobalString('MAIN_DISABLE_WRAPPING_ON_COLUMN_TITLE') && empty($forcenowrapcolumntitle)) {
  5086. $prefix = 'wrapcolumntitle '.$prefix;
  5087. }
  5088. //var_dump('field='.$field.' field1='.$field1.' sortfield='.$sortfield.' sortfield1='.$sortfield1);
  5089. // If field is used as sort criteria we use a specific css class liste_titre_sel
  5090. // Example if (sortfield,field)=("nom","xxx.nom") or (sortfield,field)=("nom","nom")
  5091. $liste_titre = 'liste_titre';
  5092. if ($field1 && ($sortfield1 == $field1 || $sortfield1 == preg_replace("/^[^\.]+\./", "", $field1))) {
  5093. $liste_titre = 'liste_titre_sel';
  5094. }
  5095. $tagstart = '<'.$tag.' class="'.$prefix.$liste_titre.'" '.$moreattrib;
  5096. //$out .= (($field && empty($conf->global->MAIN_DISABLE_WRAPPING_ON_COLUMN_TITLE) && preg_match('/^[a-zA-Z_0-9\s\.\-:&;]*$/', $name)) ? ' title="'.dol_escape_htmltag($langs->trans($name)).'"' : '');
  5097. $tagstart .= ($name && !getDolGlobalString('MAIN_DISABLE_WRAPPING_ON_COLUMN_TITLE') && empty($forcenowrapcolumntitle) && !dol_textishtml($name)) ? ' title="'.dol_escape_htmltag($langs->trans($name)).'"' : '';
  5098. $tagstart .= '>';
  5099. if (empty($thead) && $field && empty($disablesortlink)) { // If this is a sort field
  5100. $options = preg_replace('/sortfield=([a-zA-Z0-9,\s\.]+)/i', '', (is_scalar($moreparam) ? $moreparam : ''));
  5101. $options = preg_replace('/sortorder=([a-zA-Z0-9,\s\.]+)/i', '', $options);
  5102. $options = preg_replace('/&+/i', '&', $options);
  5103. if (!preg_match('/^&/', $options)) {
  5104. $options = '&'.$options;
  5105. }
  5106. $sortordertouseinlink = '';
  5107. if ($field1 != $sortfield1) { // We are on another field than current sorted field
  5108. if (preg_match('/^DESC/i', $sortorder)) {
  5109. $sortordertouseinlink .= str_repeat('desc,', count(explode(',', $field)));
  5110. } else { // We reverse the var $sortordertouseinlink
  5111. $sortordertouseinlink .= str_repeat('asc,', count(explode(',', $field)));
  5112. }
  5113. } else { // We are on field that is the first current sorting criteria
  5114. if (preg_match('/^ASC/i', $sortorder)) { // We reverse the var $sortordertouseinlink
  5115. $sortordertouseinlink .= str_repeat('desc,', count(explode(',', $field)));
  5116. } else {
  5117. $sortordertouseinlink .= str_repeat('asc,', count(explode(',', $field)));
  5118. }
  5119. }
  5120. $sortordertouseinlink = preg_replace('/,$/', '', $sortordertouseinlink);
  5121. $out .= '<a class="reposition" href="'.$file.'?sortfield='.$field.'&sortorder='.$sortordertouseinlink.'&begin='.$begin.$options.'"';
  5122. //$out .= (empty($conf->global->MAIN_DISABLE_WRAPPING_ON_COLUMN_TITLE) ? ' title="'.dol_escape_htmltag($langs->trans($name)).'"' : '');
  5123. $out .= '>';
  5124. }
  5125. if ($tooltip) {
  5126. // You can also use 'TranslationString:keyfortooltiponclick' for a tooltip on click.
  5127. if (preg_match('/:\w+$/', $tooltip)) {
  5128. $tmptooltip = explode(':', $tooltip);
  5129. } else {
  5130. $tmptooltip = array($tooltip);
  5131. }
  5132. $out .= $form->textwithpicto($langs->trans($name), $langs->trans($tmptooltip[0]), 1, 'help', '', 0, 3, (empty($tmptooltip[1]) ? '' : 'extra_'.str_replace('.', '_', $field).'_'.$tmptooltip[1]));
  5133. } else {
  5134. $out .= $langs->trans($name);
  5135. }
  5136. if (empty($thead) && $field && empty($disablesortlink)) { // If this is a sort field
  5137. $out .= '</a>';
  5138. }
  5139. if (empty($thead) && $field) { // If this is a sort field
  5140. $options = preg_replace('/sortfield=([a-zA-Z0-9,\s\.]+)/i', '', (is_scalar($moreparam) ? $moreparam : ''));
  5141. $options = preg_replace('/sortorder=([a-zA-Z0-9,\s\.]+)/i', '', $options);
  5142. $options = preg_replace('/&+/i', '&', $options);
  5143. if (!preg_match('/^&/', $options)) {
  5144. $options = '&'.$options;
  5145. }
  5146. if (!$sortorder || ($field1 != $sortfield1)) {
  5147. //$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=asc&begin='.$begin.$options.'">'.img_down("A-Z",0).'</a>';
  5148. //$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=desc&begin='.$begin.$options.'">'.img_up("Z-A",0).'</a>';
  5149. } else {
  5150. if (preg_match('/^DESC/', $sortorder)) {
  5151. //$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=asc&begin='.$begin.$options.'">'.img_down("A-Z",0).'</a>';
  5152. //$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=desc&begin='.$begin.$options.'">'.img_up("Z-A",1).'</a>';
  5153. $sortimg .= '<span class="nowrap">'.img_up("Z-A", 0, 'paddingright').'</span>';
  5154. }
  5155. if (preg_match('/^ASC/', $sortorder)) {
  5156. //$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=asc&begin='.$begin.$options.'">'.img_down("A-Z",1).'</a>';
  5157. //$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=desc&begin='.$begin.$options.'">'.img_up("Z-A",0).'</a>';
  5158. $sortimg .= '<span class="nowrap">'.img_down("A-Z", 0, 'paddingright').'</span>';
  5159. }
  5160. }
  5161. }
  5162. $tagend = '</'.$tag.'>';
  5163. $out = $tagstart.$sortimg.$out.$tagend;
  5164. return $out;
  5165. }
  5166. /**
  5167. * Show a title.
  5168. *
  5169. * @param string $title Title to show
  5170. * @return void
  5171. * @deprecated Use load_fiche_titre instead
  5172. * @see load_fiche_titre()
  5173. */
  5174. function print_titre($title)
  5175. {
  5176. dol_syslog(__FUNCTION__." is deprecated", LOG_WARNING);
  5177. print '<div class="titre">'.$title.'</div>';
  5178. }
  5179. /**
  5180. * Show a title with picto
  5181. *
  5182. * @param string $title Title to show
  5183. * @param string $mesg Added message to show on right
  5184. * @param string $picto Icon to use before title (should be a 32x32 transparent png file)
  5185. * @param int $pictoisfullpath 1=Icon name is a full absolute url of image
  5186. * @param int $id To force an id on html objects
  5187. * @return void
  5188. * @deprecated Use print load_fiche_titre instead
  5189. */
  5190. function print_fiche_titre($title, $mesg = '', $picto = 'generic', $pictoisfullpath = 0, $id = '')
  5191. {
  5192. print load_fiche_titre($title, $mesg, $picto, $pictoisfullpath, $id);
  5193. }
  5194. /**
  5195. * Load a title with picto
  5196. *
  5197. * @param string $titre Title to show
  5198. * @param string $morehtmlright Added message to show on right
  5199. * @param string $picto Icon to use before title (should be a 32x32 transparent png file)
  5200. * @param int $pictoisfullpath 1=Icon name is a full absolute url of image
  5201. * @param string $id To force an id on html objects
  5202. * @param string $morecssontable More css on table
  5203. * @param string $morehtmlcenter Added message to show on center
  5204. * @return string
  5205. * @see print_barre_liste()
  5206. */
  5207. function load_fiche_titre($titre, $morehtmlright = '', $picto = 'generic', $pictoisfullpath = 0, $id = '', $morecssontable = '', $morehtmlcenter = '')
  5208. {
  5209. global $conf;
  5210. $return = '';
  5211. if ($picto == 'setup') {
  5212. $picto = 'generic';
  5213. }
  5214. $return .= "\n";
  5215. $return .= '<table '.($id ? 'id="'.$id.'" ' : '').'class="centpercent notopnoleftnoright table-fiche-title'.($morecssontable ? ' '.$morecssontable : '').'">'; // maring bottom must be same than into print_barre_list
  5216. $return .= '<tr class="titre">';
  5217. if ($picto) {
  5218. $return .= '<td class="nobordernopadding widthpictotitle valignmiddle col-picto">'.img_picto('', $picto, 'class="valignmiddle widthpictotitle pictotitle"', $pictoisfullpath).'</td>';
  5219. }
  5220. $return .= '<td class="nobordernopadding valignmiddle col-title">';
  5221. $return .= '<div class="titre inline-block">'.$titre.'</div>';
  5222. $return .= '</td>';
  5223. if (dol_strlen($morehtmlcenter)) {
  5224. $return .= '<td class="nobordernopadding center valignmiddle col-center">'.$morehtmlcenter.'</td>';
  5225. }
  5226. if (dol_strlen($morehtmlright)) {
  5227. $return .= '<td class="nobordernopadding titre_right wordbreakimp right valignmiddle col-right">'.$morehtmlright.'</td>';
  5228. }
  5229. $return .= '</tr></table>'."\n";
  5230. return $return;
  5231. }
  5232. /**
  5233. * Print a title with navigation controls for pagination
  5234. *
  5235. * @param string $titre Title to show (required)
  5236. * @param int|null $page Numero of page to show in navigation links (required)
  5237. * @param string $file Url of page (required)
  5238. * @param string $options More parameters for links ('' by default, does not include sortfield neither sortorder). Value must be 'urlencoded' before calling function.
  5239. * @param string $sortfield Field to sort on ('' by default)
  5240. * @param string $sortorder Order to sort ('' by default)
  5241. * @param string $morehtmlcenter String in the middle ('' by default). We often find here string $massaction comming from $form->selectMassAction()
  5242. * @param int $num Number of records found by select with limit+1
  5243. * @param int|string $totalnboflines Total number of records/lines for all pages (if known). Use a negative value of number to not show number. Use '' if unknown.
  5244. * @param string $picto Icon to use before title (should be a 32x32 transparent png file)
  5245. * @param int $pictoisfullpath 1=Icon name is a full absolute url of image
  5246. * @param string $morehtmlright More html to show (after arrows)
  5247. * @param string $morecss More css to the table
  5248. * @param int $limit Max number of lines (-1 = use default, 0 = no limit, > 0 = limit).
  5249. * @param int $hideselectlimit Force to hide select limit
  5250. * @param int $hidenavigation Force to hide the arrows and page for navigation
  5251. * @param int $pagenavastextinput 1=Do not suggest list of pages to navigate but suggest the page number into an input field.
  5252. * @param string $morehtmlrightbeforearrow More html to show (before arrows)
  5253. * @return void
  5254. */
  5255. function print_barre_liste($titre, $page, $file, $options = '', $sortfield = '', $sortorder = '', $morehtmlcenter = '', $num = -1, $totalnboflines = '', $picto = 'generic', $pictoisfullpath = 0, $morehtmlright = '', $morecss = '', $limit = -1, $hideselectlimit = 0, $hidenavigation = 0, $pagenavastextinput = 0, $morehtmlrightbeforearrow = '')
  5256. {
  5257. global $conf;
  5258. $savlimit = $limit;
  5259. $savtotalnboflines = $totalnboflines;
  5260. $totalnboflines = abs((int) $totalnboflines);
  5261. $page = (int) $page;
  5262. if ($picto == 'setup') {
  5263. $picto = 'title_setup.png';
  5264. }
  5265. if (($conf->browser->name == 'ie') && $picto == 'generic') {
  5266. $picto = 'title.gif';
  5267. }
  5268. if ($limit < 0) {
  5269. $limit = $conf->liste_limit;
  5270. }
  5271. if ($savlimit != 0 && (($num > $limit) || ($num == -1) || ($limit == 0))) {
  5272. $nextpage = 1;
  5273. } else {
  5274. $nextpage = 0;
  5275. }
  5276. //print 'totalnboflines='.$totalnboflines.'-savlimit='.$savlimit.'-limit='.$limit.'-num='.$num.'-nextpage='.$nextpage.'-hideselectlimit='.$hideselectlimit.'-hidenavigation='.$hidenavigation;
  5277. print "\n";
  5278. print "<!-- Begin title -->\n";
  5279. print '<table class="centpercent notopnoleftnoright table-fiche-title'.($morecss ? ' '.$morecss : '').'"><tr>'; // maring bottom must be same than into load_fiche_tire
  5280. // Left
  5281. if ($picto && $titre) {
  5282. print '<td class="nobordernopadding widthpictotitle valignmiddle col-picto">'.img_picto('', $picto, 'class="valignmiddle pictotitle widthpictotitle"', $pictoisfullpath).'</td>';
  5283. }
  5284. print '<td class="nobordernopadding valignmiddle col-title">';
  5285. print '<div class="titre inline-block">'.$titre;
  5286. if (!empty($titre) && $savtotalnboflines >= 0 && (string) $savtotalnboflines != '') {
  5287. print '<span class="opacitymedium colorblack paddingleft">('.$totalnboflines.')</span>';
  5288. }
  5289. print '</div></td>';
  5290. // Center
  5291. if ($morehtmlcenter && empty($conf->dol_optimize_smallscreen)) {
  5292. print '<td class="nobordernopadding center valignmiddle col-center">'.$morehtmlcenter.'</td>';
  5293. }
  5294. // Right
  5295. print '<td class="nobordernopadding valignmiddle right col-right">';
  5296. print '<input type="hidden" name="pageplusoneold" value="'.((int) $page + 1).'">';
  5297. if ($sortfield) {
  5298. $options .= "&sortfield=".urlencode($sortfield);
  5299. }
  5300. if ($sortorder) {
  5301. $options .= "&sortorder=".urlencode($sortorder);
  5302. }
  5303. // Show navigation bar
  5304. $pagelist = '';
  5305. if ($savlimit != 0 && ($page > 0 || $num > $limit)) {
  5306. if ($totalnboflines) { // If we know total nb of lines
  5307. // Define nb of extra page links before and after selected page + ... + first or last
  5308. $maxnbofpage = (empty($conf->dol_optimize_smallscreen) ? 4 : 0);
  5309. if ($limit > 0) {
  5310. $nbpages = ceil($totalnboflines / $limit);
  5311. } else {
  5312. $nbpages = 1;
  5313. }
  5314. $cpt = ($page - $maxnbofpage);
  5315. if ($cpt < 0) {
  5316. $cpt = 0;
  5317. }
  5318. if ($cpt >= 1) {
  5319. if (empty($pagenavastextinput)) {
  5320. $pagelist .= '<li class="pagination"><a class="reposition" href="'.$file.'?page=0'.$options.'">1</a></li>';
  5321. if ($cpt > 2) {
  5322. $pagelist .= '<li class="pagination"><span class="inactive">...</span></li>';
  5323. } elseif ($cpt == 2) {
  5324. $pagelist .= '<li class="pagination"><a class="reposition" href="'.$file.'?page=1'.$options.'">2</a></li>';
  5325. }
  5326. }
  5327. }
  5328. do {
  5329. if ($pagenavastextinput) {
  5330. if ($cpt == $page) {
  5331. $pagelist .= '<li class="pagination"><input type="text" class="'.($totalnboflines > 100 ? 'width40' : 'width25').' center pageplusone" name="pageplusone" value="'.($page + 1).'"></li>';
  5332. $pagelist .= '/';
  5333. }
  5334. } else {
  5335. if ($cpt == $page) {
  5336. $pagelist .= '<li class="pagination"><span class="active">'.($page + 1).'</span></li>';
  5337. } else {
  5338. $pagelist .= '<li class="pagination"><a class="reposition" href="'.$file.'?page='.$cpt.$options.'">'.($cpt + 1).'</a></li>';
  5339. }
  5340. }
  5341. $cpt++;
  5342. } while ($cpt < $nbpages && $cpt <= ($page + $maxnbofpage));
  5343. if (empty($pagenavastextinput)) {
  5344. if ($cpt < $nbpages) {
  5345. if ($cpt < $nbpages - 2) {
  5346. $pagelist .= '<li class="pagination"><span class="inactive">...</span></li>';
  5347. } elseif ($cpt == $nbpages - 2) {
  5348. $pagelist .= '<li class="pagination"><a class="reposition" href="'.$file.'?page='.($nbpages - 2).$options.'">'.($nbpages - 1).'</a></li>';
  5349. }
  5350. $pagelist .= '<li class="pagination"><a class="reposition" href="'.$file.'?page='.($nbpages - 1).$options.'">'.$nbpages.'</a></li>';
  5351. }
  5352. } else {
  5353. //var_dump($page.' '.$cpt.' '.$nbpages);
  5354. $pagelist .= '<li class="pagination paginationlastpage"><a class="reposition" href="'.$file.'?page='.($nbpages - 1).$options.'">'.$nbpages.'</a></li>';
  5355. }
  5356. } else {
  5357. $pagelist .= '<li class="pagination"><span class="active">'.($page + 1)."</li>";
  5358. }
  5359. }
  5360. if ($savlimit || $morehtmlright || $morehtmlrightbeforearrow) {
  5361. print_fleche_navigation($page, $file, $options, $nextpage, $pagelist, $morehtmlright, $savlimit, $totalnboflines, $hideselectlimit, $morehtmlrightbeforearrow, $hidenavigation); // output the div and ul for previous/last completed with page numbers into $pagelist
  5362. }
  5363. // js to autoselect page field on focus
  5364. if ($pagenavastextinput) {
  5365. print ajax_autoselect('.pageplusone');
  5366. }
  5367. print '</td>';
  5368. print '</tr>';
  5369. print '</table>'."\n";
  5370. // Center
  5371. if ($morehtmlcenter && !empty($conf->dol_optimize_smallscreen)) {
  5372. print '<div class="nobordernopadding marginbottomonly center valignmiddle col-center centpercent">'.$morehtmlcenter.'</div>';
  5373. }
  5374. print "<!-- End title -->\n\n";
  5375. }
  5376. /**
  5377. * Function to show navigation arrows into lists
  5378. *
  5379. * @param int $page Number of page
  5380. * @param string $file Page URL (in most cases provided with $_SERVER["PHP_SELF"])
  5381. * @param string $options Other url parameters to propagate ("" by default, may include sortfield and sortorder)
  5382. * @param integer $nextpage Do we show a next page button
  5383. * @param string $betweenarrows HTML content to show between arrows. MUST contains '<li> </li>' tags or '<li><span> </span></li>'.
  5384. * @param string $afterarrows HTML content to show after arrows. Must NOT contains '<li> </li>' tags.
  5385. * @param int $limit Max nb of record to show (-1 = no combo with limit, 0 = no limit, > 0 = limit)
  5386. * @param int $totalnboflines Total number of records/lines for all pages (if known)
  5387. * @param int $hideselectlimit Force to hide select limit
  5388. * @param string $beforearrows HTML content to show before arrows. Must NOT contains '<li> </li>' tags.
  5389. * @param int $hidenavigation Force to hide the switch mode view and the navigation tool (hide limit section, html in $betweenarrows and $afterarrows but not $beforearrows)
  5390. * @return void
  5391. */
  5392. function print_fleche_navigation($page, $file, $options = '', $nextpage = 0, $betweenarrows = '', $afterarrows = '', $limit = -1, $totalnboflines = 0, $hideselectlimit = 0, $beforearrows = '', $hidenavigation = 0)
  5393. {
  5394. global $conf, $langs;
  5395. print '<div class="pagination"><ul>';
  5396. if ($beforearrows) {
  5397. print '<li class="paginationbeforearrows">';
  5398. print $beforearrows;
  5399. print '</li>';
  5400. }
  5401. if (empty($hidenavigation)) {
  5402. if ((int) $limit > 0 && empty($hideselectlimit)) {
  5403. $pagesizechoices = '10:10,15:15,20:20,30:30,40:40,50:50,100:100,250:250,500:500,1000:1000';
  5404. $pagesizechoices .= ',5000:5000,10000:10000,20000:20000';
  5405. //$pagesizechoices.=',0:'.$langs->trans("All"); // Not yet supported
  5406. //$pagesizechoices.=',2:2';
  5407. if (getDolGlobalString('MAIN_PAGESIZE_CHOICES')) {
  5408. $pagesizechoices = $conf->global->MAIN_PAGESIZE_CHOICES;
  5409. }
  5410. print '<li class="pagination">';
  5411. print '<select class="flat selectlimit" name="limit" title="'.dol_escape_htmltag($langs->trans("MaxNbOfRecordPerPage")).'">';
  5412. $tmpchoice = explode(',', $pagesizechoices);
  5413. $tmpkey = $limit.':'.$limit;
  5414. if (!in_array($tmpkey, $tmpchoice)) {
  5415. $tmpchoice[] = $tmpkey;
  5416. }
  5417. $tmpkey = $conf->liste_limit.':'.$conf->liste_limit;
  5418. if (!in_array($tmpkey, $tmpchoice)) {
  5419. $tmpchoice[] = $tmpkey;
  5420. }
  5421. asort($tmpchoice, SORT_NUMERIC);
  5422. foreach ($tmpchoice as $val) {
  5423. $selected = '';
  5424. $tmp = explode(':', $val);
  5425. $key = $tmp[0];
  5426. $val = $tmp[1];
  5427. if ($key != '' && $val != '') {
  5428. if ((int) $key == (int) $limit) {
  5429. $selected = ' selected="selected"';
  5430. }
  5431. print '<option name="'.$key.'"'.$selected.'>'.dol_escape_htmltag($val).'</option>'."\n";
  5432. }
  5433. }
  5434. print '</select>';
  5435. if ($conf->use_javascript_ajax) {
  5436. print '<!-- JS CODE TO ENABLE select limit to launch submit of page -->
  5437. <script>
  5438. jQuery(document).ready(function () {
  5439. jQuery(".selectlimit").change(function() {
  5440. console.log("Change limit. Send submit");
  5441. $(this).parents(\'form:first\').submit();
  5442. });
  5443. });
  5444. </script>
  5445. ';
  5446. }
  5447. print '</li>';
  5448. }
  5449. if ($page > 0) {
  5450. print '<li class="pagination paginationpage paginationpageleft"><a class="paginationprevious reposition" href="'.$file.'?page='.($page - 1).$options.'"><i class="fa fa-chevron-left" title="'.dol_escape_htmltag($langs->trans("Previous")).'"></i></a></li>';
  5451. }
  5452. if ($betweenarrows) {
  5453. print '<!--<div class="betweenarrows nowraponall inline-block">-->';
  5454. print $betweenarrows;
  5455. print '<!--</div>-->';
  5456. }
  5457. if ($nextpage > 0) {
  5458. print '<li class="pagination paginationpage paginationpageright"><a class="paginationnext reposition" href="'.$file.'?page='.($page + 1).$options.'"><i class="fa fa-chevron-right" title="'.dol_escape_htmltag($langs->trans("Next")).'"></i></a></li>';
  5459. }
  5460. if ($afterarrows) {
  5461. print '<li class="paginationafterarrows">';
  5462. print $afterarrows;
  5463. print '</li>';
  5464. }
  5465. }
  5466. print '</ul></div>'."\n";
  5467. }
  5468. /**
  5469. * Return a string with VAT rate label formated for view output
  5470. * Used into pdf and HTML pages
  5471. *
  5472. * @param string $rate Rate value to format ('19.6', '19,6', '19.6%', '19,6%', '19.6 (CODEX)', ...)
  5473. * @param boolean $addpercent Add a percent % sign in output
  5474. * @param int $info_bits Miscellaneous information on vat (0=Default, 1=French NPR vat)
  5475. * @param int $usestarfornpr -1=Never show, 0 or 1=Use '*' for NPR vat rates
  5476. * @param int $html Used for html output
  5477. * @return string String with formated amounts ('19,6' or '19,6%' or '8.5% (NPR)' or '8.5% *' or '19,6 (CODEX)')
  5478. */
  5479. function vatrate($rate, $addpercent = false, $info_bits = 0, $usestarfornpr = 0, $html = 0)
  5480. {
  5481. $morelabel = '';
  5482. if (preg_match('/%/', $rate)) {
  5483. $rate = str_replace('%', '', $rate);
  5484. $addpercent = true;
  5485. }
  5486. $reg = array();
  5487. if (preg_match('/\((.*)\)/', $rate, $reg)) {
  5488. $morelabel = ' ('.$reg[1].')';
  5489. $rate = preg_replace('/\s*'.preg_quote($morelabel, '/').'/', '', $rate);
  5490. $morelabel = ' '.($html ? '<span class="opacitymedium">' : '').'('.$reg[1].')'.($html ? '</span>' : '');
  5491. }
  5492. if (preg_match('/\*/', $rate)) {
  5493. $rate = str_replace('*', '', $rate);
  5494. $info_bits |= 1;
  5495. }
  5496. // If rate is '9/9/9' we don't change it. If rate is '9.000' we apply price()
  5497. if (!preg_match('/\//', $rate)) {
  5498. $ret = price($rate, 0, '', 0, 0).($addpercent ? '%' : '');
  5499. } else {
  5500. // TODO Split on / and output with a price2num to have clean numbers without ton of 000.
  5501. $ret = $rate.($addpercent ? '%' : '');
  5502. }
  5503. if (($info_bits & 1) && $usestarfornpr >= 0) {
  5504. $ret .= ' *';
  5505. }
  5506. $ret .= $morelabel;
  5507. return $ret;
  5508. }
  5509. /**
  5510. * Function to format a value into an amount for visual output
  5511. * Function used into PDF and HTML pages
  5512. *
  5513. * @param float $amount Amount to format
  5514. * @param integer $form Type of format, HTML or not (not by default)
  5515. * @param Translate|string $outlangs Object langs for output. '' use default lang. 'none' use international separators.
  5516. * @param int $trunc 1=Truncate if there is more decimals than MAIN_MAX_DECIMALS_SHOWN (default), 0=Does not truncate. Deprecated because amount are rounded (to unit or total amount accurancy) before beeing inserted into database or after a computation, so this parameter should be useless.
  5517. * @param int $rounding MINIMUM number of decimal to show: 0=no change, -1=we use min($conf->global->MAIN_MAX_DECIMALS_UNIT,$conf->global->MAIN_MAX_DECIMALS_TOT)
  5518. * @param int|string $forcerounding MAXIMUM number of decimal to forcerounding decimal: -1=no change, 'MU' or 'MT' or numeric to round to MU or MT or to a given number of decimal
  5519. * @param string $currency_code To add currency symbol (''=add nothing, 'auto'=Use default currency, 'XXX'=add currency symbols for XXX currency)
  5520. * @return string String with formated amount
  5521. *
  5522. * @see price2num() Revert function of price
  5523. */
  5524. function price($amount, $form = 0, $outlangs = '', $trunc = 1, $rounding = -1, $forcerounding = -1, $currency_code = '')
  5525. {
  5526. global $langs, $conf;
  5527. // Clean parameters
  5528. if (empty($amount)) {
  5529. $amount = 0; // To have a numeric value if amount not defined or = ''
  5530. }
  5531. $amount = (is_numeric($amount) ? $amount : 0); // Check if amount is numeric, for example, an error occured when amount value = o (letter) instead 0 (number)
  5532. if ($rounding == -1) {
  5533. $rounding = min(getDolGlobalString('MAIN_MAX_DECIMALS_UNIT'), getDolGlobalString('MAIN_MAX_DECIMALS_TOT'));
  5534. }
  5535. $nbdecimal = $rounding;
  5536. if ($outlangs === 'none') {
  5537. // Use international separators
  5538. $dec = '.';
  5539. $thousand = '';
  5540. } else {
  5541. // Output separators by default (french)
  5542. $dec = ',';
  5543. $thousand = ' ';
  5544. // If $outlangs not forced, we use use language
  5545. if (!is_object($outlangs)) {
  5546. $outlangs = $langs;
  5547. }
  5548. if ($outlangs->transnoentitiesnoconv("SeparatorDecimal") != "SeparatorDecimal") {
  5549. $dec = $outlangs->transnoentitiesnoconv("SeparatorDecimal");
  5550. }
  5551. if ($outlangs->transnoentitiesnoconv("SeparatorThousand") != "SeparatorThousand") {
  5552. $thousand = $outlangs->transnoentitiesnoconv("SeparatorThousand");
  5553. }
  5554. if ($thousand == 'None') {
  5555. $thousand = '';
  5556. } elseif ($thousand == 'Space') {
  5557. $thousand = ' ';
  5558. }
  5559. }
  5560. //print "outlangs=".$outlangs->defaultlang." amount=".$amount." html=".$form." trunc=".$trunc." nbdecimal=".$nbdecimal." dec='".$dec."' thousand='".$thousand."'<br>";
  5561. //print "amount=".$amount."-";
  5562. $amount = str_replace(',', '.', $amount); // should be useless
  5563. //print $amount."-";
  5564. $datas = explode('.', $amount);
  5565. $decpart = isset($datas[1]) ? $datas[1] : '';
  5566. $decpart = preg_replace('/0+$/i', '', $decpart); // Supprime les 0 de fin de partie decimale
  5567. //print "decpart=".$decpart."<br>";
  5568. $end = '';
  5569. // We increase nbdecimal if there is more decimal than asked (to not loose information)
  5570. if (dol_strlen($decpart) > $nbdecimal) {
  5571. $nbdecimal = dol_strlen($decpart);
  5572. }
  5573. // Si on depasse max
  5574. if ($trunc && $nbdecimal > $conf->global->MAIN_MAX_DECIMALS_SHOWN) {
  5575. $nbdecimal = $conf->global->MAIN_MAX_DECIMALS_SHOWN;
  5576. if (preg_match('/\.\.\./i', $conf->global->MAIN_MAX_DECIMALS_SHOWN)) {
  5577. // Si un affichage est tronque, on montre des ...
  5578. $end = '...';
  5579. }
  5580. }
  5581. // If force rounding
  5582. if ((string) $forcerounding != '-1') {
  5583. if ($forcerounding === 'MU') {
  5584. $nbdecimal = $conf->global->MAIN_MAX_DECIMALS_UNIT;
  5585. } elseif ($forcerounding === 'MT') {
  5586. $nbdecimal = $conf->global->MAIN_MAX_DECIMALS_TOT;
  5587. } elseif ($forcerounding >= 0) {
  5588. $nbdecimal = $forcerounding;
  5589. }
  5590. }
  5591. // Format number
  5592. $output = number_format($amount, $nbdecimal, $dec, $thousand);
  5593. if ($form) {
  5594. $output = preg_replace('/\s/', '&nbsp;', $output);
  5595. $output = preg_replace('/\'/', '&#039;', $output);
  5596. }
  5597. // Add symbol of currency if requested
  5598. $cursymbolbefore = $cursymbolafter = '';
  5599. if ($currency_code && is_object($outlangs)) {
  5600. if ($currency_code == 'auto') {
  5601. $currency_code = $conf->currency;
  5602. }
  5603. $listofcurrenciesbefore = array('AUD', 'CAD', 'CNY', 'COP', 'CLP', 'GBP', 'HKD', 'MXN', 'PEN', 'USD', 'CRC');
  5604. $listoflanguagesbefore = array('nl_NL');
  5605. if (in_array($currency_code, $listofcurrenciesbefore) || in_array($outlangs->defaultlang, $listoflanguagesbefore)) {
  5606. $cursymbolbefore .= $outlangs->getCurrencySymbol($currency_code);
  5607. } else {
  5608. $tmpcur = $outlangs->getCurrencySymbol($currency_code);
  5609. $cursymbolafter .= ($tmpcur == $currency_code ? ' '.$tmpcur : $tmpcur);
  5610. }
  5611. }
  5612. $output = $cursymbolbefore.$output.$end.($cursymbolafter ? ' ' : '').$cursymbolafter;
  5613. return $output;
  5614. }
  5615. /**
  5616. * Function that return a number with universal decimal format (decimal separator is '.') from an amount typed by a user.
  5617. * Function to use on each input amount before any numeric test or database insert. A better name for this function
  5618. * should be roundtext2num().
  5619. *
  5620. * @param string|float $amount Amount to convert/clean or round
  5621. * @param string|int $rounding ''=No rounding
  5622. * 'MU'=Round to Max unit price (MAIN_MAX_DECIMALS_UNIT)
  5623. * 'MT'=Round to Max for totals with Tax (MAIN_MAX_DECIMALS_TOT)
  5624. * 'MS'=Round to Max for stock quantity (MAIN_MAX_DECIMALS_STOCK)
  5625. * 'CU'=Round to Max unit price of foreign currency accuracy
  5626. * 'CT'=Round to Max for totals with Tax of foreign currency accuracy
  5627. * Numeric = Nb of digits for rounding (For example 2 for a percentage)
  5628. * @param int $option Put 1 if you know that content is already universal format number (so no correction on decimal will be done)
  5629. * Put 2 if you know that number is a user input (so we know we have to fix decimal separator).
  5630. * @return string Amount with universal numeric format (Example: '99.99999').
  5631. * If conversion fails to return a numeric, it returns:
  5632. * - text unchanged or partial if ($rounding = ''): price2num('W9ç', '', 0) => '9ç', price2num('W9ç', '', 1) => 'W9ç', price2num('W9ç', '', 2) => '9ç'
  5633. * - '0' if ($rounding is defined): price2num('W9ç', 'MT', 0) => '9', price2num('W9ç', 'MT', 1) => '0', price2num('W9ç', 'MT', 2) => '9'
  5634. * Note: The best way to guarantee a numeric value is to add a cast (float) before the price2num().
  5635. * If amount is null or '', it returns '' if $rounding = '', it returns '0' if $rounding is defined.
  5636. *
  5637. * @see price() Opposite function of price2num
  5638. */
  5639. function price2num($amount, $rounding = '', $option = 0)
  5640. {
  5641. global $langs, $conf;
  5642. // Clean parameters
  5643. if (is_null($amount)) {
  5644. $amount = '';
  5645. }
  5646. // Round PHP function does not allow number like '1,234.56' nor '1.234,56' nor '1 234,56'
  5647. // Numbers must be '1234.56'
  5648. // Decimal delimiter for PHP and database SQL requests must be '.'
  5649. $dec = ',';
  5650. $thousand = ' ';
  5651. if (is_null($langs)) { // $langs is not defined, we use english values.
  5652. $dec = '.';
  5653. $thousand = ',';
  5654. } else {
  5655. if ($langs->transnoentitiesnoconv("SeparatorDecimal") != "SeparatorDecimal") {
  5656. $dec = $langs->transnoentitiesnoconv("SeparatorDecimal");
  5657. }
  5658. if ($langs->transnoentitiesnoconv("SeparatorThousand") != "SeparatorThousand") {
  5659. $thousand = $langs->transnoentitiesnoconv("SeparatorThousand");
  5660. }
  5661. }
  5662. if ($thousand == 'None') {
  5663. $thousand = '';
  5664. } elseif ($thousand == 'Space') {
  5665. $thousand = ' ';
  5666. }
  5667. //print "amount=".$amount." html=".$form." trunc=".$trunc." nbdecimal=".$nbdecimal." dec='".$dec."' thousand='".$thousand."'<br>";
  5668. // Convert value to universal number format (no thousand separator, '.' as decimal separator)
  5669. if ($option != 1) { // If not a PHP number or unknown, we change or clean format
  5670. //print "\n".'PP'.$amount.' - '.$dec.' - '.$thousand.' - '.intval($amount).'<br>';
  5671. if (!is_numeric($amount)) {
  5672. $amount = preg_replace('/[a-zA-Z\/\\\*\(\)\<\>\_]/', '', $amount);
  5673. }
  5674. if ($option == 2 && $thousand == '.' && preg_match('/\.(\d\d\d)$/', (string) $amount)) { // It means the . is used as a thousand separator and string come from input data, so 1.123 is 1123
  5675. $amount = str_replace($thousand, '', $amount);
  5676. }
  5677. // Convert amount to format with dolibarr dec and thousand (this is because PHP convert a number
  5678. // to format defined by LC_NUMERIC after a calculation and we want source format to be like defined by Dolibarr setup.
  5679. // So if number was already a good number, it is converted into local Dolibarr setup.
  5680. if (is_numeric($amount)) {
  5681. // We put in temps value of decimal ("0.00001"). Works with 0 and 2.0E-5 and 9999.10
  5682. $temps = sprintf("%0.10F", $amount - intval($amount)); // temps=0.0000000000 or 0.0000200000 or 9999.1000000000
  5683. $temps = preg_replace('/([\.1-9])0+$/', '\\1', $temps); // temps=0. or 0.00002 or 9999.1
  5684. $nbofdec = max(0, dol_strlen($temps) - 2); // -2 to remove "0."
  5685. $amount = number_format($amount, $nbofdec, $dec, $thousand);
  5686. }
  5687. //print "QQ".$amount."<br>\n";
  5688. // Now make replace (the main goal of function)
  5689. if ($thousand != ',' && $thousand != '.') {
  5690. $amount = str_replace(',', '.', $amount); // To accept 2 notations for french users
  5691. }
  5692. $amount = str_replace(' ', '', $amount); // To avoid spaces
  5693. $amount = str_replace($thousand, '', $amount); // Replace of thousand before replace of dec to avoid pb if thousand is .
  5694. $amount = str_replace($dec, '.', $amount);
  5695. $amount = preg_replace('/[^0-9\-\.]/', '', $amount); // Clean non numeric chars (so it clean some UTF8 spaces for example.
  5696. }
  5697. //print ' XX'.$amount.' '.$rounding;
  5698. // Now, $amount is a real PHP float number. We make a rounding if required.
  5699. if ($rounding) {
  5700. $nbofdectoround = '';
  5701. if ($rounding == 'MU') {
  5702. $nbofdectoround = $conf->global->MAIN_MAX_DECIMALS_UNIT;
  5703. } elseif ($rounding == 'MT') {
  5704. $nbofdectoround = $conf->global->MAIN_MAX_DECIMALS_TOT;
  5705. } elseif ($rounding == 'MS') {
  5706. $nbofdectoround = isset($conf->global->MAIN_MAX_DECIMALS_STOCK) ? $conf->global->MAIN_MAX_DECIMALS_STOCK : 5;
  5707. } elseif ($rounding == 'CU') {
  5708. $nbofdectoround = max(getDolGlobalString('MAIN_MAX_DECIMALS_UNIT'), 8); // TODO Use param of currency
  5709. } elseif ($rounding == 'CT') {
  5710. $nbofdectoround = max(getDolGlobalString('MAIN_MAX_DECIMALS_TOT'), 8); // TODO Use param of currency
  5711. } elseif (is_numeric($rounding)) {
  5712. $nbofdectoround = (int) $rounding;
  5713. }
  5714. //print " RR".$amount.' - '.$nbofdectoround.'<br>';
  5715. if (dol_strlen($nbofdectoround)) {
  5716. $amount = round(is_string($amount) ? (float) $amount : $amount, $nbofdectoround); // $nbofdectoround can be 0.
  5717. } else {
  5718. return 'ErrorBadParameterProvidedToFunction';
  5719. }
  5720. //print ' SS'.$amount.' - '.$nbofdec.' - '.$dec.' - '.$thousand.' - '.$nbofdectoround.'<br>';
  5721. // Convert amount to format with dolibarr dec and thousand (this is because PHP convert a number
  5722. // to format defined by LC_NUMERIC after a calculation and we want source format to be defined by Dolibarr setup.
  5723. if (is_numeric($amount)) {
  5724. // We put in temps value of decimal ("0.00001"). Works with 0 and 2.0E-5 and 9999.10
  5725. $temps = sprintf("%0.10F", $amount - intval($amount)); // temps=0.0000000000 or 0.0000200000 or 9999.1000000000
  5726. $temps = preg_replace('/([\.1-9])0+$/', '\\1', $temps); // temps=0. or 0.00002 or 9999.1
  5727. $nbofdec = max(0, dol_strlen($temps) - 2); // -2 to remove "0."
  5728. $amount = number_format($amount, min($nbofdec, $nbofdectoround), $dec, $thousand); // Convert amount to format with dolibarr dec and thousand
  5729. }
  5730. //print "TT".$amount.'<br>';
  5731. // Always make replace because each math function (like round) replace
  5732. // with local values and we want a number that has a SQL string format x.y
  5733. if ($thousand != ',' && $thousand != '.') {
  5734. $amount = str_replace(',', '.', $amount); // To accept 2 notations for french users
  5735. }
  5736. $amount = str_replace(' ', '', $amount); // To avoid spaces
  5737. $amount = str_replace($thousand, '', $amount); // Replace of thousand before replace of dec to avoid pb if thousand is .
  5738. $amount = str_replace($dec, '.', $amount);
  5739. $amount = preg_replace('/[^0-9\-\.]/', '', $amount); // Clean non numeric chars (so it clean some UTF8 spaces for example.
  5740. }
  5741. return $amount;
  5742. }
  5743. /**
  5744. * Output a dimension with best unit
  5745. *
  5746. * @param float $dimension Dimension
  5747. * @param int $unit Unit scale of dimension (Example: 0=kg, -3=g, -6=mg, 98=ounce, 99=pound, ...)
  5748. * @param string $type 'weight', 'volume', ...
  5749. * @param Translate $outputlangs Translate language object
  5750. * @param int $round -1 = non rounding, x = number of decimal
  5751. * @param string $forceunitoutput 'no' or numeric (-3, -6, ...) compared to $unit (In most case, this value is value defined into $conf->global->MAIN_WEIGHT_DEFAULT_UNIT)
  5752. * @param int $use_short_label 1=Use short label ('g' instead of 'gram'). Short labels are not translated.
  5753. * @return string String to show dimensions
  5754. */
  5755. function showDimensionInBestUnit($dimension, $unit, $type, $outputlangs, $round = -1, $forceunitoutput = 'no', $use_short_label = 0)
  5756. {
  5757. require_once DOL_DOCUMENT_ROOT.'/core/lib/product.lib.php';
  5758. if (($forceunitoutput == 'no' && $dimension < 1 / 10000 && $unit < 90) || (is_numeric($forceunitoutput) && $forceunitoutput == -6)) {
  5759. $dimension = $dimension * 1000000;
  5760. $unit = $unit - 6;
  5761. } elseif (($forceunitoutput == 'no' && $dimension < 1 / 10 && $unit < 90) || (is_numeric($forceunitoutput) && $forceunitoutput == -3)) {
  5762. $dimension = $dimension * 1000;
  5763. $unit = $unit - 3;
  5764. } elseif (($forceunitoutput == 'no' && $dimension > 100000000 && $unit < 90) || (is_numeric($forceunitoutput) && $forceunitoutput == 6)) {
  5765. $dimension = $dimension / 1000000;
  5766. $unit = $unit + 6;
  5767. } elseif (($forceunitoutput == 'no' && $dimension > 100000 && $unit < 90) || (is_numeric($forceunitoutput) && $forceunitoutput == 3)) {
  5768. $dimension = $dimension / 1000;
  5769. $unit = $unit + 3;
  5770. }
  5771. // Special case when we want output unit into pound or ounce
  5772. /* TODO
  5773. if ($unit < 90 && $type == 'weight' && is_numeric($forceunitoutput) && (($forceunitoutput == 98) || ($forceunitoutput == 99))
  5774. {
  5775. $dimension = // convert dimension from standard unit into ounce or pound
  5776. $unit = $forceunitoutput;
  5777. }
  5778. if ($unit > 90 && $type == 'weight' && is_numeric($forceunitoutput) && $forceunitoutput < 90)
  5779. {
  5780. $dimension = // convert dimension from standard unit into ounce or pound
  5781. $unit = $forceunitoutput;
  5782. }*/
  5783. $ret = price($dimension, 0, $outputlangs, 0, 0, $round);
  5784. $ret .= ' '.measuringUnitString(0, $type, $unit, $use_short_label, $outputlangs);
  5785. return $ret;
  5786. }
  5787. /**
  5788. * Return localtax rate for a particular vat, when selling a product with vat $vatrate, from a $thirdparty_buyer to a $thirdparty_seller
  5789. * Note: This function applies same rules than get_default_tva
  5790. *
  5791. * @param float $vatrate Vat rate. Can be '8.5' or '8.5 (VATCODEX)' for example
  5792. * @param int $local Local tax to search and return (1 or 2 return only tax rate 1 or tax rate 2)
  5793. * @param Societe $thirdparty_buyer Object of buying third party
  5794. * @param Societe $thirdparty_seller Object of selling third party ($mysoc if not defined)
  5795. * @param int $vatnpr If vat rate is NPR or not
  5796. * @return mixed 0 if not found, localtax rate if found
  5797. * @see get_default_tva()
  5798. */
  5799. function get_localtax($vatrate, $local, $thirdparty_buyer = "", $thirdparty_seller = "", $vatnpr = 0)
  5800. {
  5801. global $db, $conf, $mysoc;
  5802. if (empty($thirdparty_seller) || !is_object($thirdparty_seller)) {
  5803. $thirdparty_seller = $mysoc;
  5804. }
  5805. dol_syslog("get_localtax tva=".$vatrate." local=".$local." thirdparty_buyer id=".(is_object($thirdparty_buyer) ? $thirdparty_buyer->id : '')."/country_code=".(is_object($thirdparty_buyer) ? $thirdparty_buyer->country_code : '')." thirdparty_seller id=".$thirdparty_seller->id."/country_code=".$thirdparty_seller->country_code." thirdparty_seller localtax1_assuj=".$thirdparty_seller->localtax1_assuj." thirdparty_seller localtax2_assuj=".$thirdparty_seller->localtax2_assuj);
  5806. $vatratecleaned = $vatrate;
  5807. $reg = array();
  5808. if (preg_match('/^(.*)\s*\((.*)\)$/', $vatrate, $reg)) { // If vat is "xx (yy)"
  5809. $vatratecleaned = trim($reg[1]);
  5810. $vatratecode = $reg[2];
  5811. }
  5812. /*if ($thirdparty_buyer->country_code != $thirdparty_seller->country_code)
  5813. {
  5814. return 0;
  5815. }*/
  5816. // Some test to guess with no need to make database access
  5817. if ($mysoc->country_code == 'ES') { // For spain localtaxes 1 and 2, tax is qualified if buyer use local tax
  5818. if ($local == 1) {
  5819. if (!$mysoc->localtax1_assuj || (string) $vatratecleaned == "0") {
  5820. return 0;
  5821. }
  5822. if ($thirdparty_seller->id == $mysoc->id) {
  5823. if (!$thirdparty_buyer->localtax1_assuj) {
  5824. return 0;
  5825. }
  5826. } else {
  5827. if (!$thirdparty_seller->localtax1_assuj) {
  5828. return 0;
  5829. }
  5830. }
  5831. }
  5832. if ($local == 2) {
  5833. //if (! $mysoc->localtax2_assuj || (string) $vatratecleaned == "0") return 0;
  5834. if (!$mysoc->localtax2_assuj) {
  5835. return 0; // If main vat is 0, IRPF may be different than 0.
  5836. }
  5837. if ($thirdparty_seller->id == $mysoc->id) {
  5838. if (!$thirdparty_buyer->localtax2_assuj) {
  5839. return 0;
  5840. }
  5841. } else {
  5842. if (!$thirdparty_seller->localtax2_assuj) {
  5843. return 0;
  5844. }
  5845. }
  5846. }
  5847. } else {
  5848. if ($local == 1 && !$thirdparty_seller->localtax1_assuj) {
  5849. return 0;
  5850. }
  5851. if ($local == 2 && !$thirdparty_seller->localtax2_assuj) {
  5852. return 0;
  5853. }
  5854. }
  5855. // For some country MAIN_GET_LOCALTAXES_VALUES_FROM_THIRDPARTY is forced to on.
  5856. if (in_array($mysoc->country_code, array('ES'))) {
  5857. $conf->global->MAIN_GET_LOCALTAXES_VALUES_FROM_THIRDPARTY = 1;
  5858. }
  5859. // Search local taxes
  5860. if (getDolGlobalString('MAIN_GET_LOCALTAXES_VALUES_FROM_THIRDPARTY')) {
  5861. if ($local == 1) {
  5862. if ($thirdparty_seller != $mysoc) {
  5863. if (!isOnlyOneLocalTax($local)) { // TODO We should provide $vatrate to search on correct line and not always on line with highest vat rate
  5864. return $thirdparty_seller->localtax1_value;
  5865. }
  5866. } else { // i am the seller
  5867. if (!isOnlyOneLocalTax($local)) { // TODO If seller is me, why not always returning this, even if there is only one locatax vat.
  5868. return $conf->global->MAIN_INFO_VALUE_LOCALTAX1;
  5869. }
  5870. }
  5871. }
  5872. if ($local == 2) {
  5873. if ($thirdparty_seller != $mysoc) {
  5874. if (!isOnlyOneLocalTax($local)) { // TODO We should provide $vatrate to search on correct line and not always on line with highest vat rate
  5875. // TODO We should also return value defined on thirdparty only if defined
  5876. return $thirdparty_seller->localtax2_value;
  5877. }
  5878. } else { // i am the seller
  5879. if (in_array($mysoc->country_code, array('ES'))) {
  5880. return $thirdparty_buyer->localtax2_value;
  5881. } else {
  5882. return $conf->global->MAIN_INFO_VALUE_LOCALTAX2;
  5883. }
  5884. }
  5885. }
  5886. }
  5887. // By default, search value of local tax on line of common tax
  5888. $sql = "SELECT t.localtax1, t.localtax2, t.localtax1_type, t.localtax2_type";
  5889. $sql .= " FROM ".MAIN_DB_PREFIX."c_tva as t, ".MAIN_DB_PREFIX."c_country as c";
  5890. $sql .= " WHERE t.fk_pays = c.rowid AND c.code = '".$db->escape($thirdparty_seller->country_code)."'";
  5891. $sql .= " AND t.taux = ".((float) $vatratecleaned)." AND t.active = 1";
  5892. $sql .= " AND t.entity IN (".getEntity('c_tva').")";
  5893. if (!empty($vatratecode)) {
  5894. $sql .= " AND t.code ='".$db->escape($vatratecode)."'"; // If we have the code, we use it in priority
  5895. } else {
  5896. $sql .= " AND t.recuperableonly = '".$db->escape($vatnpr)."'";
  5897. }
  5898. $resql = $db->query($sql);
  5899. if ($resql) {
  5900. $obj = $db->fetch_object($resql);
  5901. if ($obj) {
  5902. if ($local == 1) {
  5903. return $obj->localtax1;
  5904. } elseif ($local == 2) {
  5905. return $obj->localtax2;
  5906. }
  5907. }
  5908. }
  5909. return 0;
  5910. }
  5911. /**
  5912. * Return true if LocalTax (1 or 2) is unique.
  5913. * Example: If localtax1 is 5 on line with highest common vat rate, return true
  5914. * Example: If localtax1 is 5:8:15 on line with highest common vat rate, return false
  5915. *
  5916. * @param int $local Local tax to test (1 or 2)
  5917. * @return boolean True if LocalTax have multiple values, False if not
  5918. */
  5919. function isOnlyOneLocalTax($local)
  5920. {
  5921. $tax = get_localtax_by_third($local);
  5922. $valors = explode(":", $tax);
  5923. if (count($valors) > 1) {
  5924. return false;
  5925. } else {
  5926. return true;
  5927. }
  5928. }
  5929. /**
  5930. * Get values of localtaxes (1 or 2) for company country for the common vat with the highest value
  5931. *
  5932. * @param int $local LocalTax to get
  5933. * @return string Values of localtax (Can be '20', '-19:-15:-9') or 'Error'
  5934. */
  5935. function get_localtax_by_third($local)
  5936. {
  5937. global $db, $mysoc;
  5938. $sql = " SELECT t.localtax".$local." as localtax";
  5939. $sql .= " FROM ".MAIN_DB_PREFIX."c_tva as t INNER JOIN ".MAIN_DB_PREFIX."c_country as c ON c.rowid = t.fk_pays";
  5940. $sql .= " WHERE c.code = '".$db->escape($mysoc->country_code)."' AND t.active = 1 AND t.entity IN (".getEntity('c_tva').") AND t.taux = (";
  5941. $sql .= "SELECT MAX(tt.taux) FROM ".MAIN_DB_PREFIX."c_tva as tt INNER JOIN ".MAIN_DB_PREFIX."c_country as c ON c.rowid = tt.fk_pays";
  5942. $sql .= " WHERE c.code = '".$db->escape($mysoc->country_code)."' AND t.entity IN (".getEntity('c_tva').") AND tt.active = 1)";
  5943. $sql .= " AND t.localtax".$local."_type <> '0'";
  5944. $sql .= " ORDER BY t.rowid DESC";
  5945. $resql = $db->query($sql);
  5946. if ($resql) {
  5947. $obj = $db->fetch_object($resql);
  5948. if ($obj) {
  5949. return $obj->localtax;
  5950. } else {
  5951. return '0';
  5952. }
  5953. }
  5954. return 'Error';
  5955. }
  5956. /**
  5957. * Get tax (VAT) main information from Id.
  5958. * You can also call getLocalTaxesFromRate() after to get only localtax fields.
  5959. *
  5960. * @param int|string $vatrate VAT ID or Rate. Value can be value or the string with code into parenthesis or rowid if $firstparamisid is 1. Example: '8.5' or '8.5 (8.5NPR)' or 123.
  5961. * @param Societe $buyer Company object
  5962. * @param Societe $seller Company object
  5963. * @param int $firstparamisid 1 if first param is id into table (use this if you can)
  5964. * @return array array('rowid'=> , 'code'=> ...)
  5965. * @see getLocalTaxesFromRate()
  5966. */
  5967. function getTaxesFromId($vatrate, $buyer = null, $seller = null, $firstparamisid = 1)
  5968. {
  5969. global $db, $mysoc;
  5970. dol_syslog("getTaxesFromId vat id or rate = ".$vatrate);
  5971. // Search local taxes
  5972. $sql = "SELECT t.rowid, t.code, t.taux as rate, t.recuperableonly as npr, t.accountancy_code_sell, t.accountancy_code_buy,";
  5973. $sql .= " t.localtax1, t.localtax1_type, t.localtax2, t.localtax2_type";
  5974. $sql .= " FROM ".MAIN_DB_PREFIX."c_tva as t";
  5975. if ($firstparamisid) {
  5976. $sql .= " WHERE t.rowid = ".(int) $vatrate;
  5977. } else {
  5978. $vatratecleaned = $vatrate;
  5979. $vatratecode = '';
  5980. $reg = array();
  5981. if (preg_match('/^(.*)\s*\((.*)\)$/', $vatrate, $reg)) { // If vat is "xx (yy)"
  5982. $vatratecleaned = $reg[1];
  5983. $vatratecode = $reg[2];
  5984. }
  5985. $sql .= ", ".MAIN_DB_PREFIX."c_country as c";
  5986. /*if ($mysoc->country_code == 'ES') $sql.= " WHERE t.fk_pays = c.rowid AND c.code = '".$db->escape($buyer->country_code)."'"; // vat in spain use the buyer country ??
  5987. else $sql.= " WHERE t.fk_pays = c.rowid AND c.code = '".$db->escape($seller->country_code)."'";*/
  5988. $sql .= " WHERE t.fk_pays = c.rowid AND c.code = '".$db->escape($seller->country_code)."'";
  5989. $sql .= " AND t.taux = ".((float) $vatratecleaned)." AND t.active = 1";
  5990. $sql .= " AND t.entity IN (".getEntity('c_tva').")";
  5991. if ($vatratecode) {
  5992. $sql .= " AND t.code = '".$db->escape($vatratecode)."'";
  5993. }
  5994. }
  5995. $resql = $db->query($sql);
  5996. if ($resql) {
  5997. $obj = $db->fetch_object($resql);
  5998. if ($obj) {
  5999. return array(
  6000. 'rowid'=>$obj->rowid,
  6001. 'code'=>$obj->code,
  6002. 'rate'=>$obj->rate,
  6003. 'localtax1'=>$obj->localtax1,
  6004. 'localtax1_type'=>$obj->localtax1_type,
  6005. 'localtax2'=>$obj->localtax2,
  6006. 'localtax2_type'=>$obj->localtax2_type,
  6007. 'npr'=>$obj->npr,
  6008. 'accountancy_code_sell'=>$obj->accountancy_code_sell,
  6009. 'accountancy_code_buy'=>$obj->accountancy_code_buy
  6010. );
  6011. } else {
  6012. return array();
  6013. }
  6014. } else {
  6015. dol_print_error($db);
  6016. }
  6017. return array();
  6018. }
  6019. /**
  6020. * Get type and rate of localtaxes for a particular vat rate/country of a thirdparty.
  6021. * This does not take into account the seller setup if subject to vat or not, only country.
  6022. *
  6023. * TODO This function is ALSO called to retrieve type for building PDF. Such call of function must be removed.
  6024. * Instead this function must be called when adding a line to get the array of possible values for localtax and type, and then
  6025. * provide the selected value to the function calcul_price_total.
  6026. *
  6027. * @param int|string $vatrate VAT ID or Rate+Code. Value can be value or the string with code into parenthesis or rowid if $firstparamisid is 1. Example: '8.5' or '8.5 (8.5NPR)' or 123.
  6028. * @param int $local Number of localtax (1 or 2, or 0 to return 1 & 2)
  6029. * @param Societe $buyer Company object
  6030. * @param Societe $seller Company object
  6031. * @param int $firstparamisid 1 if first param is ID into table instead of Rate+code (use this if you can)
  6032. * @return array array(localtax_type1(1-6 or 0 if not found), rate localtax1, localtax_type2, rate localtax2, accountancycodecust, accountancycodesupp)
  6033. * @see getTaxesFromId()
  6034. */
  6035. function getLocalTaxesFromRate($vatrate, $local, $buyer, $seller, $firstparamisid = 0)
  6036. {
  6037. global $db, $mysoc;
  6038. dol_syslog("getLocalTaxesFromRate vatrate=".$vatrate." local=".$local);
  6039. // Search local taxes
  6040. $sql = "SELECT t.taux as rate, t.code, t.localtax1, t.localtax1_type, t.localtax2, t.localtax2_type, t.accountancy_code_sell, t.accountancy_code_buy";
  6041. $sql .= " FROM ".MAIN_DB_PREFIX."c_tva as t";
  6042. if ($firstparamisid) {
  6043. $sql .= " WHERE t.rowid = ".(int) $vatrate;
  6044. } else {
  6045. $vatratecleaned = $vatrate;
  6046. $vatratecode = '';
  6047. $reg = array();
  6048. if (preg_match('/^(.*)\s*\((.*)\)$/', $vatrate, $reg)) { // If vat is "x.x (yy)"
  6049. $vatratecleaned = $reg[1];
  6050. $vatratecode = $reg[2];
  6051. }
  6052. $sql .= ", ".MAIN_DB_PREFIX."c_country as c";
  6053. if (!empty($mysoc) && $mysoc->country_code == 'ES') {
  6054. $countrycodetouse = ((empty($buyer) || empty($buyer->country_code)) ? $mysoc->country_code : $buyer->country_code);
  6055. $sql .= " WHERE t.fk_pays = c.rowid AND c.code = '".$db->escape($countrycodetouse)."'"; // local tax in spain use the buyer country ??
  6056. } else {
  6057. $countrycodetouse = ((empty($seller) || empty($seller->country_code)) ? $mysoc->country_code : $seller->country_code);
  6058. $sql .= " WHERE t.fk_pays = c.rowid AND c.code = '".$db->escape($countrycodetouse)."'";
  6059. }
  6060. $sql .= " AND t.taux = ".((float) $vatratecleaned)." AND t.active = 1";
  6061. if ($vatratecode) {
  6062. $sql .= " AND t.code = '".$db->escape($vatratecode)."'";
  6063. }
  6064. }
  6065. $resql = $db->query($sql);
  6066. if ($resql) {
  6067. $obj = $db->fetch_object($resql);
  6068. if ($obj) {
  6069. $vateratestring = $obj->rate.($obj->code ? ' ('.$obj->code.')' : '');
  6070. if ($local == 1) {
  6071. return array($obj->localtax1_type, get_localtax($vateratestring, $local, $buyer, $seller), $obj->accountancy_code_sell, $obj->accountancy_code_buy);
  6072. } elseif ($local == 2) {
  6073. return array($obj->localtax2_type, get_localtax($vateratestring, $local, $buyer, $seller), $obj->accountancy_code_sell, $obj->accountancy_code_buy);
  6074. } else {
  6075. return array($obj->localtax1_type, get_localtax($vateratestring, 1, $buyer, $seller), $obj->localtax2_type, get_localtax($vateratestring, 2, $buyer, $seller), $obj->accountancy_code_sell, $obj->accountancy_code_buy);
  6076. }
  6077. }
  6078. }
  6079. return array();
  6080. }
  6081. /**
  6082. * Return vat rate of a product in a particular country, or default country vat if product is unknown.
  6083. * Function called by get_default_tva().
  6084. *
  6085. * @param int $idprod Id of product or 0 if not a predefined product
  6086. * @param Societe $thirdpartytouse Thirdparty with a ->country_code defined (FR, US, IT, ...)
  6087. * @param int $idprodfournprice Id product_fournisseur_price (for "supplier" proposal/order/invoice)
  6088. * @return float|string Vat rate to use with format 5.0 or '5.0 (XXX)'
  6089. * @see get_product_localtax_for_country()
  6090. */
  6091. function get_product_vat_for_country($idprod, $thirdpartytouse, $idprodfournprice = 0)
  6092. {
  6093. global $db, $conf, $mysoc;
  6094. require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php';
  6095. $ret = 0;
  6096. $found = 0;
  6097. if ($idprod > 0) {
  6098. // Load product
  6099. $product = new Product($db);
  6100. $product->fetch($idprod);
  6101. if ($mysoc->country_code == $thirdpartytouse->country_code) {
  6102. // If country to consider is ours
  6103. if ($idprodfournprice > 0) { // We want vat for product for a "supplier" object
  6104. $result = $product->get_buyprice($idprodfournprice, 0, 0, 0);
  6105. if ($result > 0) {
  6106. $ret = $product->vatrate_supplier;
  6107. if ($product->default_vat_code_supplier) {
  6108. $ret .= ' ('.$product->default_vat_code_supplier.')';
  6109. }
  6110. $found = 1;
  6111. }
  6112. }
  6113. if (!$found) {
  6114. $ret = $product->tva_tx; // Default sales vat of product
  6115. if ($product->default_vat_code) {
  6116. $ret .= ' ('.$product->default_vat_code.')';
  6117. }
  6118. $found = 1;
  6119. }
  6120. } else {
  6121. // TODO Read default product vat according to product and an other countrycode.
  6122. // Vat for couple anothercountrycode/product is data that is not managed and store yet, so we will fallback on next rule.
  6123. }
  6124. }
  6125. if (!$found) {
  6126. if (!getDolGlobalString('MAIN_VAT_DEFAULT_IF_AUTODETECT_FAILS')) {
  6127. // If vat of product for the country not found or not defined, we return the first rate found (sorting on use_default, then on higher vat of country).
  6128. $sql = "SELECT t.taux as vat_rate, t.code as default_vat_code";
  6129. $sql .= " FROM ".MAIN_DB_PREFIX."c_tva as t, ".MAIN_DB_PREFIX."c_country as c";
  6130. $sql .= " WHERE t.active = 1 AND t.fk_pays = c.rowid AND c.code = '".$db->escape($thirdpartytouse->country_code)."'";
  6131. $sql .= " AND t.entity IN (".getEntity('c_tva').")";
  6132. $sql .= " ORDER BY t.use_default DESC, t.taux DESC, t.code ASC, t.recuperableonly ASC";
  6133. $sql .= $db->plimit(1);
  6134. $resql = $db->query($sql);
  6135. if ($resql) {
  6136. $obj = $db->fetch_object($resql);
  6137. if ($obj) {
  6138. $ret = $obj->vat_rate;
  6139. if ($obj->default_vat_code) {
  6140. $ret .= ' ('.$obj->default_vat_code.')';
  6141. }
  6142. }
  6143. $db->free($resql);
  6144. } else {
  6145. dol_print_error($db);
  6146. }
  6147. } else {
  6148. // Forced value if autodetect fails. MAIN_VAT_DEFAULT_IF_AUTODETECT_FAILS can be
  6149. // '1.23'
  6150. // or '1.23 (CODE)'
  6151. $defaulttx = '';
  6152. if (getDolGlobalString('MAIN_VAT_DEFAULT_IF_AUTODETECT_FAILS') != 'none') {
  6153. $defaulttx = $conf->global->MAIN_VAT_DEFAULT_IF_AUTODETECT_FAILS;
  6154. }
  6155. /*if (preg_match('/\((.*)\)/', $defaulttx, $reg)) {
  6156. $defaultcode = $reg[1];
  6157. $defaulttx = preg_replace('/\s*\(.*\)/', '', $defaulttx);
  6158. }*/
  6159. $ret = $defaulttx;
  6160. }
  6161. }
  6162. dol_syslog("get_product_vat_for_country: ret=".$ret);
  6163. return $ret;
  6164. }
  6165. /**
  6166. * Return localtax vat rate of a product in a particular country or default country vat if product is unknown
  6167. *
  6168. * @param int $idprod Id of product
  6169. * @param int $local 1 for localtax1, 2 for localtax 2
  6170. * @param Societe $thirdpartytouse Thirdparty with a ->country_code defined (FR, US, IT, ...)
  6171. * @return int Return integer <0 if KO, Vat rate if OK
  6172. * @see get_product_vat_for_country()
  6173. */
  6174. function get_product_localtax_for_country($idprod, $local, $thirdpartytouse)
  6175. {
  6176. global $db, $mysoc;
  6177. if (!class_exists('Product')) {
  6178. require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php';
  6179. }
  6180. $ret = 0;
  6181. $found = 0;
  6182. if ($idprod > 0) {
  6183. // Load product
  6184. $product = new Product($db);
  6185. $result = $product->fetch($idprod);
  6186. if ($mysoc->country_code == $thirdpartytouse->country_code) { // If selling country is ours
  6187. /* Not defined yet, so we don't use this
  6188. if ($local==1) $ret=$product->localtax1_tx;
  6189. elseif ($local==2) $ret=$product->localtax2_tx;
  6190. $found=1;
  6191. */
  6192. } else {
  6193. // TODO Read default product vat according to product and another countrycode.
  6194. // Vat for couple anothercountrycode/product is data that is not managed and store yet, so we will fallback on next rule.
  6195. }
  6196. }
  6197. if (!$found) {
  6198. // If vat of product for the country not found or not defined, we return higher vat of country.
  6199. $sql = "SELECT taux as vat_rate, localtax1, localtax2";
  6200. $sql .= " FROM ".MAIN_DB_PREFIX."c_tva as t, ".MAIN_DB_PREFIX."c_country as c";
  6201. $sql .= " WHERE t.active=1 AND t.fk_pays = c.rowid AND c.code='".$db->escape($thirdpartytouse->country_code)."'";
  6202. $sql .= " AND t.entity IN (".getEntity('c_tva').")";
  6203. $sql .= " ORDER BY t.taux DESC, t.recuperableonly ASC";
  6204. $sql .= $db->plimit(1);
  6205. $resql = $db->query($sql);
  6206. if ($resql) {
  6207. $obj = $db->fetch_object($resql);
  6208. if ($obj) {
  6209. if ($local == 1) {
  6210. $ret = $obj->localtax1;
  6211. } elseif ($local == 2) {
  6212. $ret = $obj->localtax2;
  6213. }
  6214. }
  6215. } else {
  6216. dol_print_error($db);
  6217. }
  6218. }
  6219. dol_syslog("get_product_localtax_for_country: ret=".$ret);
  6220. return $ret;
  6221. }
  6222. /**
  6223. * Function that return vat rate of a product line (according to seller, buyer and product vat rate)
  6224. * VATRULE 1: If seller does not use VAT, default VAT is 0. End of rule.
  6225. * VATRULE 2: If the (seller country = buyer country) then the default VAT = VAT of the product sold. End of rule.
  6226. * VATRULE 3: If (seller and buyer in the European Community) and (property sold = new means of transport such as car, boat, plane) then VAT by default = 0 (VAT must be paid by the buyer to the tax center of his country and not to the seller). End of rule.
  6227. * VATRULE 4: If (seller and buyer in the European Community) and (buyer = individual) then VAT by default = VAT of the product sold. End of rule
  6228. * VATRULE 5: If (seller and buyer in European Community) and (buyer = company) then VAT by default=0. End of rule
  6229. * VATRULE 6: Otherwise the VAT proposed by default=0. End of rule.
  6230. *
  6231. * @param Societe $thirdparty_seller Objet societe vendeuse
  6232. * @param Societe $thirdparty_buyer Objet societe acheteuse
  6233. * @param int $idprod Id product
  6234. * @param int $idprodfournprice Id product_fournisseur_price (for supplier order/invoice)
  6235. * @return float|string Vat rate to use with format 5.0 or '5.0 (XXX)', -1 if we can't guess it
  6236. * @see get_default_npr(), get_default_localtax()
  6237. */
  6238. function get_default_tva(Societe $thirdparty_seller, Societe $thirdparty_buyer, $idprod = 0, $idprodfournprice = 0)
  6239. {
  6240. global $conf;
  6241. require_once DOL_DOCUMENT_ROOT.'/core/lib/company.lib.php';
  6242. // Note: possible values for tva_assuj are 0/1 or franchise/reel
  6243. $seller_use_vat = ((is_numeric($thirdparty_seller->tva_assuj) && !$thirdparty_seller->tva_assuj) || (!is_numeric($thirdparty_seller->tva_assuj) && $thirdparty_seller->tva_assuj == 'franchise')) ? 0 : 1;
  6244. $seller_country_code = $thirdparty_seller->country_code;
  6245. $seller_in_cee = isInEEC($thirdparty_seller);
  6246. $buyer_country_code = $thirdparty_buyer->country_code;
  6247. $buyer_in_cee = isInEEC($thirdparty_buyer);
  6248. dol_syslog("get_default_tva: seller use vat=".$seller_use_vat.", seller country=".$seller_country_code.", seller in cee=".$seller_in_cee.", buyer vat number=".$thirdparty_buyer->tva_intra." buyer country=".$buyer_country_code.", buyer in cee=".$buyer_in_cee.", idprod=".$idprod.", idprodfournprice=".$idprodfournprice.", SERVICE_ARE_ECOMMERCE_200238EC=".(getDolGlobalString('SERVICES_ARE_ECOMMERCE_200238EC') ? $conf->global->SERVICES_ARE_ECOMMERCE_200238EC : ''));
  6249. // If services are eServices according to EU Council Directive 2002/38/EC (http://ec.europa.eu/taxation_customs/taxation/vat/traders/e-commerce/article_1610_en.htm)
  6250. // we use the buyer VAT.
  6251. if (getDolGlobalString('SERVICE_ARE_ECOMMERCE_200238EC')) {
  6252. if ($seller_in_cee && $buyer_in_cee) {
  6253. $isacompany = $thirdparty_buyer->isACompany();
  6254. if ($isacompany && getDolGlobalString('MAIN_USE_VAT_COMPANIES_IN_EEC_WITH_INVALID_VAT_ID_ARE_INDIVIDUAL')) {
  6255. require_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
  6256. if (!isValidVATID($thirdparty_buyer)) {
  6257. $isacompany = 0;
  6258. }
  6259. }
  6260. if (!$isacompany) {
  6261. //print 'VATRULE 0';
  6262. return get_product_vat_for_country($idprod, $thirdparty_buyer, $idprodfournprice);
  6263. }
  6264. }
  6265. }
  6266. // If seller does not use VAT, default VAT is 0. End of rule.
  6267. if (!$seller_use_vat) {
  6268. //print 'VATRULE 1';
  6269. return 0;
  6270. }
  6271. // If the (seller country = buyer country) then the default VAT = VAT of the product sold. End of rule.
  6272. if (($seller_country_code == $buyer_country_code)
  6273. || (in_array($seller_country_code, array('FR', 'MC')) && in_array($buyer_country_code, array('FR', 'MC')))) { // Warning ->country_code not always defined
  6274. //print 'VATRULE 2';
  6275. $tmpvat = get_product_vat_for_country($idprod, $thirdparty_seller, $idprodfournprice);
  6276. if ($seller_country_code == 'IN' && getDolGlobalString('MAIN_SALETAX_AUTOSWITCH_I_CS_FOR_INDIA')) {
  6277. // Special case for india.
  6278. //print 'VATRULE 2b';
  6279. $reg = array();
  6280. if (preg_match('/C+S-(\d+)/', $tmpvat, $reg) && $thirdparty_seller->state_id != $thirdparty_buyer->state_id) {
  6281. // we must revert the C+S into I
  6282. $tmpvat = str_replace("C+S", "I", $tmpvat);
  6283. } elseif (preg_match('/I-(\d+)/', $tmpvat, $reg) && $thirdparty_seller->state_id == $thirdparty_buyer->state_id) {
  6284. // we must revert the I into C+S
  6285. $tmpvat = str_replace("I", "C+S", $tmpvat);
  6286. }
  6287. }
  6288. return $tmpvat;
  6289. }
  6290. // If (seller and buyer in the European Community) and (property sold = new means of transport such as car, boat, plane) then VAT by default = 0 (VAT must be paid by the buyer to the tax center of his country and not to the seller). End of rule.
  6291. // 'VATRULE 3' - Not supported
  6292. // If (seller and buyer in the European Community) and (buyer = individual) then VAT by default = VAT of the product sold. End of rule
  6293. // If (seller and buyer in European Community) and (buyer = company) then VAT by default=0. End of rule
  6294. if (($seller_in_cee && $buyer_in_cee)) {
  6295. $isacompany = $thirdparty_buyer->isACompany();
  6296. if ($isacompany && getDolGlobalString('MAIN_USE_VAT_COMPANIES_IN_EEC_WITH_INVALID_VAT_ID_ARE_INDIVIDUAL')) {
  6297. require_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
  6298. if (!isValidVATID($thirdparty_buyer)) {
  6299. $isacompany = 0;
  6300. }
  6301. }
  6302. if (!$isacompany) {
  6303. //print 'VATRULE 4';
  6304. return get_product_vat_for_country($idprod, $thirdparty_seller, $idprodfournprice);
  6305. } else {
  6306. //print 'VATRULE 5';
  6307. return 0;
  6308. }
  6309. }
  6310. // If (seller in the European Community and buyer outside the European Community and private buyer) then VAT by default = VAT of the product sold. End of rule
  6311. // I don't see any use case that need this rule.
  6312. if (getDolGlobalString('MAIN_USE_VAT_OF_PRODUCT_FOR_INDIVIDUAL_CUSTOMER_OUT_OF_EEC') && empty($buyer_in_cee)) {
  6313. $isacompany = $thirdparty_buyer->isACompany();
  6314. if (!$isacompany) {
  6315. return get_product_vat_for_country($idprod, $thirdparty_seller, $idprodfournprice);
  6316. //print 'VATRULE extra';
  6317. }
  6318. }
  6319. // Otherwise the VAT proposed by default=0. End of rule.
  6320. // Rem: This means that at least one of the 2 is outside the European Community and the country differs
  6321. //print 'VATRULE 6';
  6322. return 0;
  6323. }
  6324. /**
  6325. * Function that returns whether VAT must be recoverable collected VAT (e.g.: VAT NPR in France)
  6326. *
  6327. * @param Societe $thirdparty_seller Thirdparty seller
  6328. * @param Societe $thirdparty_buyer Thirdparty buyer
  6329. * @param int $idprod Id product
  6330. * @param int $idprodfournprice Id supplier price for product
  6331. * @return float 0 or 1
  6332. * @see get_default_tva(), get_default_localtax()
  6333. */
  6334. function get_default_npr(Societe $thirdparty_seller, Societe $thirdparty_buyer, $idprod = 0, $idprodfournprice = 0)
  6335. {
  6336. global $db;
  6337. if ($idprodfournprice > 0) {
  6338. if (!class_exists('ProductFournisseur')) {
  6339. require_once DOL_DOCUMENT_ROOT.'/fourn/class/fournisseur.product.class.php';
  6340. }
  6341. $prodprice = new ProductFournisseur($db);
  6342. $prodprice->fetch_product_fournisseur_price($idprodfournprice);
  6343. return $prodprice->fourn_tva_npr;
  6344. } elseif ($idprod > 0) {
  6345. if (!class_exists('Product')) {
  6346. require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php';
  6347. }
  6348. $prod = new Product($db);
  6349. $prod->fetch($idprod);
  6350. return $prod->tva_npr;
  6351. }
  6352. return 0;
  6353. }
  6354. /**
  6355. * Function that return localtax of a product line (according to seller, buyer and product vat rate)
  6356. * Si vendeur non assujeti a TVA, TVA par defaut=0. Fin de regle.
  6357. * Si le (pays vendeur = pays acheteur) alors TVA par defaut=TVA du produit vendu. Fin de regle.
  6358. * Sinon TVA proposee par defaut=0. Fin de regle.
  6359. *
  6360. * @param Societe $thirdparty_seller Thirdparty seller
  6361. * @param Societe $thirdparty_buyer Thirdparty buyer
  6362. * @param int $local Localtax to process (1 or 2)
  6363. * @param int $idprod Id product
  6364. * @return integer localtax, -1 si ne peut etre determine
  6365. * @see get_default_tva(), get_default_npr()
  6366. */
  6367. function get_default_localtax($thirdparty_seller, $thirdparty_buyer, $local, $idprod = 0)
  6368. {
  6369. global $mysoc;
  6370. if (!is_object($thirdparty_seller)) {
  6371. return -1;
  6372. }
  6373. if (!is_object($thirdparty_buyer)) {
  6374. return -1;
  6375. }
  6376. if ($local == 1) { // Localtax 1
  6377. if ($mysoc->country_code == 'ES') {
  6378. if (is_numeric($thirdparty_buyer->localtax1_assuj) && !$thirdparty_buyer->localtax1_assuj) {
  6379. return 0;
  6380. }
  6381. } else {
  6382. // Si vendeur non assujeti a Localtax1, localtax1 par default=0
  6383. if (is_numeric($thirdparty_seller->localtax1_assuj) && !$thirdparty_seller->localtax1_assuj) {
  6384. return 0;
  6385. }
  6386. if (!is_numeric($thirdparty_seller->localtax1_assuj) && $thirdparty_seller->localtax1_assuj == 'localtax1off') {
  6387. return 0;
  6388. }
  6389. }
  6390. } elseif ($local == 2) { //I Localtax 2
  6391. // Si vendeur non assujeti a Localtax2, localtax2 par default=0
  6392. if (is_numeric($thirdparty_seller->localtax2_assuj) && !$thirdparty_seller->localtax2_assuj) {
  6393. return 0;
  6394. }
  6395. if (!is_numeric($thirdparty_seller->localtax2_assuj) && $thirdparty_seller->localtax2_assuj == 'localtax2off') {
  6396. return 0;
  6397. }
  6398. }
  6399. if ($thirdparty_seller->country_code == $thirdparty_buyer->country_code) {
  6400. return get_product_localtax_for_country($idprod, $local, $thirdparty_seller);
  6401. }
  6402. return 0;
  6403. }
  6404. /**
  6405. * Return yes or no in current language
  6406. *
  6407. * @param string|int $yesno Value to test (1, 'yes', 'true' or 0, 'no', 'false')
  6408. * @param integer $case 1=Yes/No, 0=yes/no, 2=Disabled checkbox, 3=Disabled checkbox + Yes/No
  6409. * @param int $color 0=texte only, 1=Text is formated with a color font style ('ok' or 'error'), 2=Text is formated with 'ok' color.
  6410. * @return string HTML string
  6411. */
  6412. function yn($yesno, $case = 1, $color = 0)
  6413. {
  6414. global $langs;
  6415. $result = 'unknown';
  6416. $classname = '';
  6417. if ($yesno == 1 || (isset($yesno) && (strtolower($yesno) == 'yes' || strtolower($yesno) == 'true'))) { // A mettre avant test sur no a cause du == 0
  6418. $result = $langs->trans('yes');
  6419. if ($case == 1 || $case == 3) {
  6420. $result = $langs->trans("Yes");
  6421. }
  6422. if ($case == 2) {
  6423. $result = '<input type="checkbox" value="1" checked disabled>';
  6424. }
  6425. if ($case == 3) {
  6426. $result = '<input type="checkbox" value="1" checked disabled> '.$result;
  6427. }
  6428. $classname = 'ok';
  6429. } elseif ($yesno == 0 || strtolower($yesno) == 'no' || strtolower($yesno) == 'false') {
  6430. $result = $langs->trans("no");
  6431. if ($case == 1 || $case == 3) {
  6432. $result = $langs->trans("No");
  6433. }
  6434. if ($case == 2) {
  6435. $result = '<input type="checkbox" value="0" disabled>';
  6436. }
  6437. if ($case == 3) {
  6438. $result = '<input type="checkbox" value="0" disabled> '.$result;
  6439. }
  6440. if ($color == 2) {
  6441. $classname = 'ok';
  6442. } else {
  6443. $classname = 'error';
  6444. }
  6445. }
  6446. if ($color) {
  6447. return '<span class="'.$classname.'">'.$result.'</span>';
  6448. }
  6449. return $result;
  6450. }
  6451. /**
  6452. * Return a path to have a the directory according to object where files are stored.
  6453. * New usage: $conf->module->multidir_output[$object->entity].'/'.get_exdir(0, 0, 0, 1, $object, '').'/'
  6454. * or: $conf->module->dir_output.'/'.get_exdir(0, 0, 0, 0, $object, '') if multidir_output not defined.
  6455. * Example out with new usage: $object is invoice -> 'INYYMM-ABCD'
  6456. * Example out with old usage: '015' with level 3->"0/1/5/", '015' with level 1->"5/", 'ABC-1' with level 3 ->"0/0/1/"
  6457. *
  6458. * @param string|int $num Id of object (deprecated, $object will be used in future)
  6459. * @param int $level Level of subdirs to return (1, 2 or 3 levels). (deprecated, global option will be used in future)
  6460. * @param int $alpha 0=Keep number only to forge path, 1=Use alpha part afer the - (By default, use 0). (deprecated, global option will be used in future)
  6461. * @param int $withoutslash 0=With slash at end (except if '/', we return ''), 1=without slash at end
  6462. * @param Object $object Object to use to get ref to forge the path.
  6463. * @param string $modulepart Type of object ('invoice_supplier, 'donation', 'invoice', ...'). Use '' for autodetect from $object.
  6464. * @return string Dir to use ending. Example '' or '1/' or '1/2/'
  6465. */
  6466. function get_exdir($num, $level, $alpha, $withoutslash, $object, $modulepart = '')
  6467. {
  6468. global $conf;
  6469. if (empty($modulepart) && !empty($object->module)) {
  6470. $modulepart = $object->module;
  6471. }
  6472. $path = '';
  6473. $arrayforoldpath = array('cheque', 'category', 'holiday', 'supplier_invoice', 'invoice_supplier', 'mailing', 'supplier_payment');
  6474. if (getDolGlobalInt('PRODUCT_USE_OLD_PATH_FOR_PHOTO')) {
  6475. $arrayforoldpath[] = 'product';
  6476. }
  6477. if (!empty($level) && in_array($modulepart, $arrayforoldpath)) {
  6478. // This part should be removed once all code is using "get_exdir" to forge path, with parameter $object and $modulepart provided.
  6479. if (empty($alpha)) {
  6480. $num = preg_replace('/([^0-9])/i', '', $num);
  6481. } else {
  6482. $num = preg_replace('/^.*\-/i', '', $num);
  6483. }
  6484. $num = substr("000".$num, -$level);
  6485. if ($level == 1) {
  6486. $path = substr($num, 0, 1);
  6487. }
  6488. if ($level == 2) {
  6489. $path = substr($num, 1, 1).'/'.substr($num, 0, 1);
  6490. }
  6491. if ($level == 3) {
  6492. $path = substr($num, 2, 1).'/'.substr($num, 1, 1).'/'.substr($num, 0, 1);
  6493. }
  6494. } else {
  6495. // We will enhance here a common way of forging path for document storage.
  6496. // In a future, we may distribute directories on several levels depending on setup and object.
  6497. // Here, $object->id, $object->ref and $modulepart are required.
  6498. //var_dump($modulepart);
  6499. $path = dol_sanitizeFileName(empty($object->ref) ? (string) $object->id : $object->ref);
  6500. }
  6501. if (empty($withoutslash) && !empty($path)) {
  6502. $path .= '/';
  6503. }
  6504. return $path;
  6505. }
  6506. /**
  6507. * Creation of a directory (this can create recursive subdir)
  6508. *
  6509. * @param string $dir Directory to create (Separator must be '/'. Example: '/mydir/mysubdir')
  6510. * @param string $dataroot Data root directory (To avoid having the data root in the loop. Using this will also lost the warning, on first dir, saying PHP has no permission when open_basedir is used)
  6511. * @param string $newmask Mask for new file (Defaults to $conf->global->MAIN_UMASK or 0755 if unavailable). Example: '0444'
  6512. * @return int Return integer < 0 if KO, 0 = already exists, > 0 if OK
  6513. */
  6514. function dol_mkdir($dir, $dataroot = '', $newmask = '')
  6515. {
  6516. global $conf;
  6517. dol_syslog("functions.lib::dol_mkdir: dir=".$dir, LOG_INFO);
  6518. $dir_osencoded = dol_osencode($dir);
  6519. if (@is_dir($dir_osencoded)) {
  6520. return 0;
  6521. }
  6522. $nberr = 0;
  6523. $nbcreated = 0;
  6524. $ccdir = '';
  6525. if (!empty($dataroot)) {
  6526. // Remove data root from loop
  6527. $dir = str_replace($dataroot.'/', '', $dir);
  6528. $ccdir = $dataroot.'/';
  6529. }
  6530. $cdir = explode("/", $dir);
  6531. $num = count($cdir);
  6532. for ($i = 0; $i < $num; $i++) {
  6533. if ($i > 0) {
  6534. $ccdir .= '/'.$cdir[$i];
  6535. } else {
  6536. $ccdir .= $cdir[$i];
  6537. }
  6538. $regs = array();
  6539. if (preg_match("/^.:$/", $ccdir, $regs)) {
  6540. continue; // Si chemin Windows incomplet, on poursuit par rep suivant
  6541. }
  6542. // Attention, le is_dir() peut echouer bien que le rep existe.
  6543. // (ex selon config de open_basedir)
  6544. if ($ccdir) {
  6545. $ccdir_osencoded = dol_osencode($ccdir);
  6546. if (!@is_dir($ccdir_osencoded)) {
  6547. dol_syslog("functions.lib::dol_mkdir: Directory '".$ccdir."' does not exists or is outside open_basedir PHP setting.", LOG_DEBUG);
  6548. umask(0);
  6549. $dirmaskdec = octdec((string) $newmask);
  6550. if (empty($newmask)) {
  6551. $dirmaskdec = !getDolGlobalString('MAIN_UMASK') ? octdec('0755') : octdec($conf->global->MAIN_UMASK);
  6552. }
  6553. $dirmaskdec |= octdec('0111'); // Set x bit required for directories
  6554. if (!@mkdir($ccdir_osencoded, $dirmaskdec)) {
  6555. // Si le is_dir a renvoye une fausse info, alors on passe ici.
  6556. dol_syslog("functions.lib::dol_mkdir: Fails to create directory '".$ccdir."' or directory already exists.", LOG_WARNING);
  6557. $nberr++;
  6558. } else {
  6559. dol_syslog("functions.lib::dol_mkdir: Directory '".$ccdir."' created", LOG_DEBUG);
  6560. $nberr = 0; // On remet a zero car si on arrive ici, cela veut dire que les echecs precedents peuvent etre ignore
  6561. $nbcreated++;
  6562. }
  6563. } else {
  6564. $nberr = 0; // On remet a zero car si on arrive ici, cela veut dire que les echecs precedents peuvent etre ignores
  6565. }
  6566. }
  6567. }
  6568. return ($nberr ? -$nberr : $nbcreated);
  6569. }
  6570. /**
  6571. * Change mod of a file
  6572. *
  6573. * @param string $filepath Full file path
  6574. * @param string $newmask Force new mask. For example '0644'
  6575. * @return void
  6576. */
  6577. function dolChmod($filepath, $newmask = '')
  6578. {
  6579. global $conf;
  6580. if (!empty($newmask)) {
  6581. @chmod($filepath, octdec($newmask));
  6582. } elseif (getDolGlobalString('MAIN_UMASK')) {
  6583. @chmod($filepath, octdec($conf->global->MAIN_UMASK));
  6584. }
  6585. }
  6586. /**
  6587. * Return picto saying a field is required
  6588. *
  6589. * @return string Chaine avec picto obligatoire
  6590. */
  6591. function picto_required()
  6592. {
  6593. return '<span class="fieldrequired">*</span>';
  6594. }
  6595. /**
  6596. * Clean a string from all HTML tags and entities.
  6597. * This function differs from strip_tags because:
  6598. * - <br> are replaced with \n if removelinefeed=0 or 1
  6599. * - if entities are found, they are decoded BEFORE the strip
  6600. * - you can decide to convert line feed into a space
  6601. *
  6602. * @param string $stringtoclean String to clean
  6603. * @param integer $removelinefeed 1=Replace all new lines by 1 space, 0=Only ending new lines are removed others are replaced with \n, 2=Ending new lines are removed but others are kept with a same number of \n than nb of <br> when there is both "...<br>\n..."
  6604. * @param string $pagecodeto Encoding of input/output string
  6605. * @param integer $strip_tags 0=Use internal strip, 1=Use strip_tags() php function (bugged when text contains a < char that is not for a html tag or when tags is not closed like '<img onload=aaa')
  6606. * @param integer $removedoublespaces Replace double space into one space
  6607. * @return string String cleaned
  6608. *
  6609. * @see dol_escape_htmltag() strip_tags() dol_string_onlythesehtmltags() dol_string_neverthesehtmltags(), dolStripPhpCode()
  6610. */
  6611. function dol_string_nohtmltag($stringtoclean, $removelinefeed = 1, $pagecodeto = 'UTF-8', $strip_tags = 0, $removedoublespaces = 1)
  6612. {
  6613. if (is_null($stringtoclean)) {
  6614. return '';
  6615. }
  6616. if ($removelinefeed == 2) {
  6617. $stringtoclean = preg_replace('/<br[^>]*>(\n|\r)+/ims', '<br>', $stringtoclean);
  6618. }
  6619. $temp = preg_replace('/<br[^>]*>/i', "\n", $stringtoclean);
  6620. // We remove entities BEFORE stripping (in case of an open separator char that is entity encoded and not the closing other, the strip will fails)
  6621. $temp = dol_html_entity_decode($temp, ENT_COMPAT | ENT_HTML5, $pagecodeto);
  6622. $temp = str_replace('< ', '__ltspace__', $temp);
  6623. if ($strip_tags) {
  6624. $temp = strip_tags($temp);
  6625. } else {
  6626. // Remove '<' into remainging, so remove non closing html tags like '<abc' or '<<abc'. Note: '<123abc' is not a html tag (can be kept), but '<abc123' is (must be removed).
  6627. $pattern = "/<[^<>]+>/";
  6628. // Example of $temp: <a href="/myurl" title="<u>A title</u>">0000-021</a>
  6629. // pass 1 - $temp after pass 1: <a href="/myurl" title="A title">0000-021
  6630. // pass 2 - $temp after pass 2: 0000-021
  6631. $tempbis = $temp;
  6632. do {
  6633. $temp = $tempbis;
  6634. $tempbis = str_replace('<>', '', $temp); // No reason to have this into a text, except if value is to try bypass the next html cleaning
  6635. $tempbis = preg_replace($pattern, '', $tempbis);
  6636. //$idowhile++; print $temp.'-'.$tempbis."\n"; if ($idowhile > 100) break;
  6637. } while ($tempbis != $temp);
  6638. $temp = $tempbis;
  6639. // Remove '<' into remaining, so remove non closing html tags like '<abc' or '<<abc'. Note: '<123abc' is not a html tag (can be kept), but '<abc123' is (must be removed).
  6640. $temp = preg_replace('/<+([a-z]+)/i', '\1', $temp);
  6641. }
  6642. $temp = dol_html_entity_decode($temp, ENT_COMPAT, $pagecodeto);
  6643. // Remove also carriage returns
  6644. if ($removelinefeed == 1) {
  6645. $temp = str_replace(array("\r\n", "\r", "\n"), " ", $temp);
  6646. }
  6647. // And double quotes
  6648. if ($removedoublespaces) {
  6649. while (strpos($temp, " ")) {
  6650. $temp = str_replace(" ", " ", $temp);
  6651. }
  6652. }
  6653. $temp = str_replace('__ltspace__', '< ', $temp);
  6654. return trim($temp);
  6655. }
  6656. /**
  6657. * Clean a string to keep only desirable HTML tags.
  6658. * WARNING: This also clean HTML comments (because they can be used to obfuscate tag name).
  6659. *
  6660. * @param string $stringtoclean String to clean
  6661. * @param int $cleanalsosomestyles Remove absolute/fixed positioning from inline styles
  6662. * @param int $removeclassattribute 1=Remove the class attribute from tags
  6663. * @param int $cleanalsojavascript Remove also occurence of 'javascript:'.
  6664. * @param int $allowiframe Allow iframe tags.
  6665. * @param array $allowed_tags List of allowed tags to replace the default list
  6666. * @param int $allowlink Allow "link" tags.
  6667. * @return string String cleaned
  6668. *
  6669. * @see dol_htmlwithnojs() dol_escape_htmltag() strip_tags() dol_string_nohtmltag() dol_string_neverthesehtmltags()
  6670. */
  6671. function dol_string_onlythesehtmltags($stringtoclean, $cleanalsosomestyles = 1, $removeclassattribute = 1, $cleanalsojavascript = 0, $allowiframe = 0, $allowed_tags = array(), $allowlink = 0)
  6672. {
  6673. if (empty($allowed_tags)) {
  6674. $allowed_tags = array(
  6675. "html", "head", "meta", "body", "article", "a", "abbr", "b", "blockquote", "br", "cite", "div", "dl", "dd", "dt", "em", "font", "img", "ins", "hr", "i", "li",
  6676. "ol", "p", "q", "s", "span", "strike", "strong", "title", "table", "tr", "th", "td", "u", "ul", "sup", "sub", "blockquote", "pre", "h1", "h2", "h3", "h4", "h5", "h6",
  6677. "header", "footer", "nav", "section", "menu", "menuitem" // html5 tags
  6678. );
  6679. }
  6680. $allowed_tags[] = "comment"; // this tags is added to manage comment <!--...--> that are replaced into <comment>...</comment>
  6681. if ($allowiframe) {
  6682. if (!in_array('iframe', $allowed_tags)) {
  6683. $allowed_tags[] = "iframe";
  6684. }
  6685. }
  6686. if ($allowlink) {
  6687. if (!in_array('link', $allowed_tags)) {
  6688. $allowed_tags[] = "link";
  6689. }
  6690. }
  6691. $allowed_tags_string = join("><", $allowed_tags);
  6692. $allowed_tags_string = '<'.$allowed_tags_string.'>';
  6693. $stringtoclean = str_replace('<!DOCTYPE html>', '__!DOCTYPE_HTML__', $stringtoclean); // Replace DOCTYPE to avoid to have it removed by the strip_tags
  6694. $stringtoclean = dol_string_nounprintableascii($stringtoclean, 0);
  6695. //$stringtoclean = preg_replace('/<!--[^>]*-->/', '', $stringtoclean);
  6696. $stringtoclean = preg_replace('/<!--([^>]*)-->/', '<comment>\1</comment>', $stringtoclean);
  6697. $stringtoclean = preg_replace('/&colon;/i', ':', $stringtoclean);
  6698. $stringtoclean = preg_replace('/&#58;|&#0+58|&#x3A/i', '', $stringtoclean); // refused string ':' encoded (no reason to have a : encoded like this) to disable 'javascript:...'
  6699. $temp = strip_tags($stringtoclean, $allowed_tags_string); // Warning: This remove also undesired </>, so may changes string obfuscated with </> that pass the injection detection into a harmfull string
  6700. if ($cleanalsosomestyles) { // Clean for remaining html tags
  6701. $temp = preg_replace('/position\s*:\s*(absolute|fixed)\s*!\s*important/i', '', $temp); // Note: If hacker try to introduce css comment into string to bypass this regex, the string must also be encoded by the dol_htmlentitiesbr during output so it become harmless
  6702. }
  6703. if ($removeclassattribute) { // Clean for remaining html tags
  6704. $temp = preg_replace('/(<[^>]+)\s+class=((["\']).*?\\3|\\w*)/i', '\\1', $temp);
  6705. }
  6706. // Remove 'javascript:' that we should not find into a text with
  6707. // Warning: This is not reliable to fight against obfuscated javascript, there is a lot of other solution to include js into a common html tag (only filtered by a GETPOST(.., powerfullfilter)).
  6708. if ($cleanalsojavascript) {
  6709. $temp = preg_replace('/j\s*a\s*v\s*a\s*s\s*c\s*r\s*i\s*p\s*t\s*:/i', '', $temp);
  6710. }
  6711. $temp = str_replace('__!DOCTYPE_HTML__', '<!DOCTYPE html>', $temp); // Restore the DOCTYPE
  6712. $temp = preg_replace('/<comment>([^>]*)<\/comment>/', '<!--\1-->', $temp); // Restore html comments
  6713. return $temp;
  6714. }
  6715. /**
  6716. * Clean a string from some undesirable HTML tags.
  6717. * Note: Complementary to dol_string_onlythesehtmltags().
  6718. * This method is used for example by dol_htmlwithnojs() when option MAIN_RESTRICTHTML_REMOVE_ALSO_BAD_ATTRIBUTES is set to 1.
  6719. *
  6720. * @param string $stringtoclean String to clean
  6721. * @param array $allowed_attributes Array of tags not allowed
  6722. * @return string String cleaned
  6723. *
  6724. * @see dol_escape_htmltag() strip_tags() dol_string_nohtmltag() dol_string_onlythesehtmltags() dol_string_neverthesehtmltags()
  6725. */
  6726. function dol_string_onlythesehtmlattributes($stringtoclean, $allowed_attributes = null)
  6727. {
  6728. if (is_null($allowed_attributes)) {
  6729. $allowed_attributes = array(
  6730. "allow", "allowfullscreen", "alt", "class", "contenteditable", "data-html", "frameborder", "height", "href", "id", "name", "src", "style", "target", "title", "width",
  6731. // HTML5
  6732. "header", "footer", "nav", "section", "menu", "menuitem"
  6733. );
  6734. }
  6735. if (class_exists('DOMDocument') && !empty($stringtoclean)) {
  6736. $stringtoclean = '<?xml encoding="UTF-8"><html><body>'.$stringtoclean.'</body></html>';
  6737. // Warning: loadHTML does not support HTML5 on old libxml versions.
  6738. $dom = new DOMDocument(null, 'UTF-8');
  6739. $dom->loadHTML($stringtoclean, LIBXML_ERR_NONE|LIBXML_HTML_NOIMPLIED|LIBXML_HTML_NODEFDTD|LIBXML_NONET|LIBXML_NOWARNING|LIBXML_NOXMLDECL);
  6740. if (is_object($dom)) {
  6741. for ($els = $dom->getElementsByTagname('*'), $i = $els->length - 1; $i >= 0; $i--) {
  6742. for ($attrs = $els->item($i)->attributes, $ii = $attrs->length - 1; $ii >= 0; $ii--) {
  6743. //var_dump($attrs->item($ii));
  6744. if (!empty($attrs->item($ii)->name)) {
  6745. if (! in_array($attrs->item($ii)->name, $allowed_attributes)) {
  6746. // Delete attribute if not into allowed_attributes
  6747. $els->item($i)->removeAttribute($attrs->item($ii)->name);
  6748. } elseif (in_array($attrs->item($ii)->name, array('style'))) {
  6749. // If attribute is 'style'
  6750. $valuetoclean = $attrs->item($ii)->value;
  6751. if (isset($valuetoclean)) {
  6752. do {
  6753. $oldvaluetoclean = $valuetoclean;
  6754. $valuetoclean = preg_replace('/\/\*.*\*\//m', '', $valuetoclean); // clean css comments
  6755. $valuetoclean = preg_replace('/position\s*:\s*[a-z]+/mi', '', $valuetoclean);
  6756. if ($els->item($i)->tagName == 'a') { // more paranoiac cleaning for clickable tags.
  6757. $valuetoclean = preg_replace('/display\s*:/mi', '', $valuetoclean);
  6758. $valuetoclean = preg_replace('/z-index\s*:/mi', '', $valuetoclean);
  6759. $valuetoclean = preg_replace('/\s+(top|left|right|bottom)\s*:/mi', '', $valuetoclean);
  6760. }
  6761. // We do not allow logout|passwordforgotten.php and action= into the content of a "style" tag
  6762. $valuetoclean = preg_replace('/(logout|passwordforgotten)\.php/mi', '', $valuetoclean);
  6763. $valuetoclean = preg_replace('/action=/mi', '', $valuetoclean);
  6764. } while ($oldvaluetoclean != $valuetoclean);
  6765. }
  6766. $attrs->item($ii)->value = $valuetoclean;
  6767. }
  6768. }
  6769. }
  6770. }
  6771. }
  6772. $return = $dom->saveHTML(); // This may add a LF at end of lines, so we will trim later
  6773. //$return = '<html><body>aaaa</p>bb<p>ssdd</p>'."\n<p>aaa</p>aa<p>bb</p>";
  6774. $return = preg_replace('/^'.preg_quote('<?xml encoding="UTF-8">', '/').'/', '', $return);
  6775. $return = preg_replace('/^'.preg_quote('<html><body>', '/').'/', '', $return);
  6776. $return = preg_replace('/'.preg_quote('</body></html>', '/').'$/', '', $return);
  6777. return trim($return);
  6778. } else {
  6779. return $stringtoclean;
  6780. }
  6781. }
  6782. /**
  6783. * Clean a string from some undesirable HTML tags.
  6784. * Note: You should use instead dol_string_onlythesehtmltags() that is more secured if you can.
  6785. *
  6786. * @param string $stringtoclean String to clean
  6787. * @param array $disallowed_tags Array of tags not allowed
  6788. * @param string $cleanalsosomestyles Clean also some tags
  6789. * @return string String cleaned
  6790. *
  6791. * @see dol_escape_htmltag() strip_tags() dol_string_nohtmltag() dol_string_onlythesehtmltags() dol_string_onlythesehtmlattributes()
  6792. */
  6793. function dol_string_neverthesehtmltags($stringtoclean, $disallowed_tags = array('textarea'), $cleanalsosomestyles = 0)
  6794. {
  6795. $temp = $stringtoclean;
  6796. foreach ($disallowed_tags as $tagtoremove) {
  6797. $temp = preg_replace('/<\/?'.$tagtoremove.'>/', '', $temp);
  6798. $temp = preg_replace('/<\/?'.$tagtoremove.'\s+[^>]*>/', '', $temp);
  6799. }
  6800. if ($cleanalsosomestyles) {
  6801. $temp = preg_replace('/position\s*:\s*(absolute|fixed)\s*!\s*important/', '', $temp); // Note: If hacker try to introduce css comment into string to avoid this, string should be encoded by the dol_htmlentitiesbr so be harmless
  6802. }
  6803. return $temp;
  6804. }
  6805. /**
  6806. * Return first line of text. Cut will depends if content is HTML or not.
  6807. *
  6808. * @param string $text Input text
  6809. * @param int $nboflines Nb of lines to get (default is 1 = first line only)
  6810. * @param string $charset Charset of $text string (UTF-8 by default)
  6811. * @return string Output text
  6812. * @see dol_nboflines_bis(), dol_string_nohtmltag(), dol_escape_htmltag()
  6813. */
  6814. function dolGetFirstLineOfText($text, $nboflines = 1, $charset = 'UTF-8')
  6815. {
  6816. if ($nboflines == 1) {
  6817. if (dol_textishtml($text)) {
  6818. $firstline = preg_replace('/<br[^>]*>.*$/s', '', $text); // The s pattern modifier means the . can match newline characters
  6819. $firstline = preg_replace('/<div[^>]*>.*$/s', '', $firstline); // The s pattern modifier means the . can match newline characters
  6820. } else {
  6821. if (isset($text)) {
  6822. $firstline = preg_replace('/[\n\r].*/', '', $text);
  6823. } else {
  6824. $firstline = '';
  6825. }
  6826. }
  6827. return $firstline.(isset($firstline) && isset($text) && (strlen($firstline) != strlen($text)) ? '...' : '');
  6828. } else {
  6829. $ishtml = 0;
  6830. if (dol_textishtml($text)) {
  6831. $text = preg_replace('/\n/', '', $text);
  6832. $ishtml = 1;
  6833. $repTable = array("\t" => " ", "\n" => " ", "\r" => " ", "\0" => " ", "\x0B" => " ");
  6834. } else {
  6835. $repTable = array("\t" => " ", "\n" => "<br>", "\r" => " ", "\0" => " ", "\x0B" => " ");
  6836. }
  6837. $text = strtr($text, $repTable);
  6838. if ($charset == 'UTF-8') {
  6839. $pattern = '/(<br[^>]*>)/Uu';
  6840. } else {
  6841. // /U is to have UNGREEDY regex to limit to one html tag. /u is for UTF8 support
  6842. $pattern = '/(<br[^>]*>)/U'; // /U is to have UNGREEDY regex to limit to one html tag.
  6843. }
  6844. $a = preg_split($pattern, $text, -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);
  6845. $firstline = '';
  6846. $i = 0;
  6847. $countline = 0;
  6848. $lastaddediscontent = 1;
  6849. while ($countline < $nboflines && isset($a[$i])) {
  6850. if (preg_match('/<br[^>]*>/', $a[$i])) {
  6851. if (array_key_exists($i+1, $a) && !empty($a[$i+1])) {
  6852. $firstline .= ($ishtml ? "<br>\n" : "\n");
  6853. // Is it a br for a new line of after a printed line ?
  6854. if (!$lastaddediscontent) {
  6855. $countline++;
  6856. }
  6857. $lastaddediscontent = 0;
  6858. }
  6859. } else {
  6860. $firstline .= $a[$i];
  6861. $lastaddediscontent = 1;
  6862. $countline++;
  6863. }
  6864. $i++;
  6865. }
  6866. $adddots = (isset($a[$i]) && (!preg_match('/<br[^>]*>/', $a[$i]) || (array_key_exists($i+1, $a) && !empty($a[$i+1]))));
  6867. //unset($a);
  6868. $ret = $firstline.($adddots ? '...' : '');
  6869. //exit;
  6870. return $ret;
  6871. }
  6872. }
  6873. /**
  6874. * Replace CRLF in string with a HTML BR tag.
  6875. * WARNING: The content after operation contains some HTML tags (the <br>) so be sure to also have
  6876. * encoded the special chars of stringtoencode into HTML before with dol_htmlentitiesbr().
  6877. *
  6878. * @param string $stringtoencode String to encode
  6879. * @param int $nl2brmode 0=Adding br before \n, 1=Replacing \n by br
  6880. * @param bool $forxml false=Use <br>, true=Use <br />
  6881. * @return string String encoded
  6882. * @see dol_htmlentitiesbr(), dol_nboflines(), dolGetFirstLineOfText()
  6883. */
  6884. function dol_nl2br($stringtoencode, $nl2brmode = 0, $forxml = false)
  6885. {
  6886. if (is_null($stringtoencode)) {
  6887. return '';
  6888. }
  6889. if (!$nl2brmode) {
  6890. return nl2br($stringtoencode, $forxml);
  6891. } else {
  6892. $ret = preg_replace('/(\r\n|\r|\n)/i', ($forxml ? '<br />' : '<br>'), $stringtoencode);
  6893. return $ret;
  6894. }
  6895. }
  6896. /**
  6897. * Sanitize a HTML to remove js, dangerous content and external link.
  6898. * This function is used by dolPrintHTML... function for example.
  6899. *
  6900. * @param string $stringtoencode String to encode
  6901. * @param int $nouseofiframesandbox 0=Default, 1=Allow use of option MAIN_SECURITY_USE_SANDBOX_FOR_HTMLWITHNOJS for html sanitizing (not yet working)
  6902. * @param string $check 'restricthtmlnolink' or 'restricthtml' or 'restricthtmlallowclass' or 'restricthtmlallowunvalid'
  6903. * @return string HTML sanitized
  6904. */
  6905. function dol_htmlwithnojs($stringtoencode, $nouseofiframesandbox = 0, $check = 'restricthtml')
  6906. {
  6907. if (empty($nouseofiframesandbox) && getDolGlobalString('MAIN_SECURITY_USE_SANDBOX_FOR_HTMLWITHNOJS')) {
  6908. // TODO using sandbox on inline html content is not possible yet with current browsers
  6909. //$s = '<iframe class="iframewithsandbox" sandbox><html><body>';
  6910. //$s .= $stringtoencode;
  6911. //$s .= '</body></html></iframe>';
  6912. return $stringtoencode;
  6913. } else {
  6914. $out = $stringtoencode;
  6915. do {
  6916. $oldstringtoclean = $out;
  6917. if (!empty($out) && getDolGlobalString('MAIN_RESTRICTHTML_ONLY_VALID_HTML') && $check != 'restricthtmlallowunvalid') {
  6918. try {
  6919. libxml_use_internal_errors(false); // Avoid to fill memory with xml errors
  6920. if (LIBXML_VERSION < 20900) {
  6921. // Avoid load of external entities (security problem).
  6922. // Required only if LIBXML_VERSION < 20900
  6923. libxml_disable_entity_loader(true);
  6924. }
  6925. $dom = new DOMDocument();
  6926. // Add a trick to solve pb with text without parent tag
  6927. // like '<h1>Foo</h1><p>bar</p>' that wrongly ends up, without the trick, with '<h1>Foo<p>bar</p></h1>'
  6928. // like 'abc' that wrongly ends up, without the trick, with '<p>abc</p>'
  6929. if (dol_textishtml($out)) {
  6930. $out = '<?xml encoding="UTF-8"><div class="tricktoremove">'.$out.'</div>';
  6931. } else {
  6932. $out = '<?xml encoding="UTF-8"><div class="tricktoremove">'.dol_nl2br($out).'</div>';
  6933. }
  6934. $dom->loadHTML($out, LIBXML_HTML_NODEFDTD | LIBXML_ERR_NONE | LIBXML_HTML_NOIMPLIED | LIBXML_NONET | LIBXML_NOWARNING | LIBXML_NOERROR | LIBXML_NOXMLDECL);
  6935. $out = trim($dom->saveHTML());
  6936. // Remove the trick added to solve pb with text without parent tag
  6937. $out = preg_replace('/^<\?xml encoding="UTF-8"><div class="tricktoremove">/', '', $out);
  6938. $out = preg_replace('/<\/div>$/', '', $out);
  6939. } catch (Exception $e) {
  6940. // If error, invalid HTML string with no way to clean it
  6941. //print $e->getMessage();
  6942. $out = 'InvalidHTMLStringCantBeCleaned '.$e->getMessage();
  6943. }
  6944. }
  6945. if (!empty($out) && getDolGlobalString('MAIN_RESTRICTHTML_ONLY_VALID_HTML_TIDY') && $check != 'restricthtmlallowunvalid') {
  6946. try {
  6947. // Try cleaning using tidy
  6948. if (extension_loaded('tidy') && class_exists("tidy")) {
  6949. //print "aaa".$out."\n";
  6950. // See options at https://tidy.sourceforge.net/docs/quickref.html
  6951. $config = array(
  6952. 'clean' => false,
  6953. 'quote-marks' => false, // do not replace " that are used for real text content (not a string symbol for html attribute) into &quot;
  6954. 'doctype' => 'strict',
  6955. 'show-body-only' => true,
  6956. "indent-attributes" => false,
  6957. "vertical-space" => false,
  6958. 'ident' => false,
  6959. "wrap" => 0
  6960. // HTML5 tags
  6961. //'new-blocklevel-tags' => 'article aside audio bdi canvas details dialog figcaption figure footer header hgroup main menu menuitem nav section source summary template track video',
  6962. //'new-blocklevel-tags' => 'footer header section menu menuitem'
  6963. //'new-empty-tags' => 'command embed keygen source track wbr',
  6964. //'new-inline-tags' => 'audio command datalist embed keygen mark menuitem meter output progress source time video wbr',
  6965. );
  6966. // Tidy
  6967. $tidy = new tidy();
  6968. $out = $tidy->repairString($out, $config, 'utf8');
  6969. //print "xxx".$out;exit;
  6970. }
  6971. } catch (Exception $e) {
  6972. // If error, invalid HTML string with no way to clean it
  6973. //print $e->getMessage();
  6974. $out = 'InvalidHTMLStringCantBeCleaned '.$e->getMessage();
  6975. }
  6976. }
  6977. // Clean some html entities that are useless so text is cleaner
  6978. $out = preg_replace('/&(tab|newline);/i', ' ', $out);
  6979. // Ckeditor use the numeric entitic for apostrophe so we force it to text entity (all other special chars are
  6980. // encoded using text entities) so we can then exclude all numeric entities.
  6981. $out = preg_replace('/&#39;/i', '&apos;', $out);
  6982. // We replace chars from a/A to z/Z encoded with numeric HTML entities with the real char so we won't loose the chars at the next step (preg_replace).
  6983. // No need to use a loop here, this step is not to sanitize (this is done at next step, this is to try to save chars, even if they are
  6984. // using a non coventionnel way to be encoded, to not have them sanitized just after)
  6985. $out = preg_replace_callback('/&#(x?[0-9][0-9a-f]+;?)/i', function ($m) {
  6986. return realCharForNumericEntities($m);
  6987. }, $out);
  6988. // Now we remove all remaining HTML entities starting with a number. We don't want such entities.
  6989. $out = preg_replace('/&#x?[0-9]+/i', '', $out); // For example if we have j&#x61vascript with an entities without the ; to hide the 'a' of 'javascript'.
  6990. // Keep only some html tags and remove also some 'javascript:' strings
  6991. $out = dol_string_onlythesehtmltags($out, 0, ($check == 'restricthtmlallowclass' ? 0 : 1), 1);
  6992. // Keep only some html attributes and exclude non expected HTML attributes and clean content of some attributes (keep only alt=, title=...).
  6993. if (getDolGlobalString('MAIN_RESTRICTHTML_REMOVE_ALSO_BAD_ATTRIBUTES')) {
  6994. $out = dol_string_onlythesehtmlattributes($out);
  6995. }
  6996. // Restore entity &apos; into &#39; (restricthtml is for html content so we can use html entity)
  6997. $out = preg_replace('/&apos;/i', "&#39;", $out);
  6998. } while ($oldstringtoclean != $out);
  6999. // Check the limit of external links that are automatically executed in a Rich text content. We count:
  7000. // '<img' to avoid <img src="http...">, we can only accept "<img src="data:..."
  7001. // 'url(' to avoid inline style like background: url(http...
  7002. // '<link' to avoid <link href="http...">
  7003. $reg = array();
  7004. $tmpout = preg_replace('/<img src="data:/mi', '<__IMG_SRC_DATA__ src="data:', $out);
  7005. preg_match_all('/(<img|url\(|<link)/i', $tmpout, $reg);
  7006. $nblinks = count($reg[0]);
  7007. if ($nblinks > getDolGlobalInt("MAIN_SECURITY_MAX_IMG_IN_HTML_CONTENT", 1000)) {
  7008. $out = 'ErrorTooManyLinksIntoHTMLString';
  7009. }
  7010. if (getDolGlobalInt('MAIN_DISALLOW_URL_INTO_DESCRIPTIONS') == 2 || $check == 'restricthtmlnolink') {
  7011. if ($nblinks > 0) {
  7012. $out = 'ErrorHTMLLinksNotAllowed';
  7013. }
  7014. } elseif (getDolGlobalInt('MAIN_DISALLOW_URL_INTO_DESCRIPTIONS') == 1) {
  7015. $nblinks = 0;
  7016. // Loop on each url in src= and url(
  7017. $pattern = '/src=["\']?(http[^"\']+)|url\(["\']?(http[^\)]+)/';
  7018. $matches = array();
  7019. if (preg_match_all($pattern, $out, $matches)) {
  7020. // URLs are into $matches[1]
  7021. $urls = $matches[1];
  7022. // Affiche les URLs
  7023. foreach ($urls as $url) {
  7024. $nblinks++;
  7025. echo "Found url = ".$url . "\n";
  7026. }
  7027. if ($nblinks > 0) {
  7028. $out = 'ErrorHTMLExternalLinksNotAllowed';
  7029. }
  7030. }
  7031. }
  7032. return $out;
  7033. }
  7034. }
  7035. /**
  7036. * This function is called to encode a string into a HTML string but differs from htmlentities because
  7037. * a detection is done before to see if text is already HTML or not. Also, all entities but &,<,>," are converted.
  7038. * This permits to encode special chars to entities with no double encoding for already encoded HTML strings.
  7039. * This function also remove last EOL or BR if $removelasteolbr=1 (default).
  7040. * For PDF usage, you can show text by 2 ways:
  7041. * - writeHTMLCell -> param must be encoded into HTML.
  7042. * - MultiCell -> param must not be encoded into HTML.
  7043. * Because writeHTMLCell convert also \n into <br>, if function is used to build PDF, nl2brmode must be 1.
  7044. * Note: When we output string on pages, we should use
  7045. * - dolPrintHTML... that is dol_escape_htmltag(dol_htmlwithnojs(dol_string_onlythesehtmltags(dol_htmlentitiesbr(), 1, 1, 1), 1, 1) for notes or descriptions,
  7046. * - dolPrintLabel... that is dol_escape_htmltag(dol_htmlentitiesbr()) for simple labels.
  7047. * - dolPrintPassword that is abelhtmlspecialchars( , ENT_COMPAT, 'UTF-8') for passwords.
  7048. *
  7049. * @param string $stringtoencode String to encode
  7050. * @param int $nl2brmode 0=Adding br before \n, 1=Replacing \n by br (for use with FPDF writeHTMLCell function for example)
  7051. * @param string $pagecodefrom Pagecode stringtoencode is encoded
  7052. * @param int $removelasteolbr 1=Remove last br or lasts \n (default), 0=Do nothing
  7053. * @return string String encoded
  7054. * @see dol_escape_htmltag(), dolGetFirstLineOfText(), dol_string_onlythesehtmltags()
  7055. */
  7056. function dol_htmlentitiesbr($stringtoencode, $nl2brmode = 0, $pagecodefrom = 'UTF-8', $removelasteolbr = 1)
  7057. {
  7058. if (is_null($stringtoencode)) {
  7059. return '';
  7060. }
  7061. $newstring = $stringtoencode;
  7062. if (dol_textishtml($stringtoencode)) { // Check if text is already HTML or not
  7063. $newstring = preg_replace('/<br(\s[\sa-zA-Z_="]*)?\/?>/i', '<br>', $newstring); // Replace "<br type="_moz" />" by "<br>". It's same and avoid pb with FPDF.
  7064. if ($removelasteolbr) {
  7065. $newstring = preg_replace('/<br>$/i', '', $newstring); // Remove last <br> (remove only last one)
  7066. }
  7067. $newstring = strtr($newstring, array('&'=>'__and__', '<'=>'__lt__', '>'=>'__gt__', '"'=>'__dquot__'));
  7068. $newstring = dol_htmlentities($newstring, ENT_COMPAT, $pagecodefrom); // Make entity encoding
  7069. $newstring = strtr($newstring, array('__and__'=>'&', '__lt__'=>'<', '__gt__'=>'>', '__dquot__'=>'"'));
  7070. } else {
  7071. if ($removelasteolbr) {
  7072. $newstring = preg_replace('/(\r\n|\r|\n)$/i', '', $newstring); // Remove last \n (may remove several)
  7073. }
  7074. $newstring = dol_nl2br(dol_htmlentities($newstring, ENT_COMPAT, $pagecodefrom), $nl2brmode);
  7075. }
  7076. // Other substitutions that htmlentities does not do
  7077. //$newstring=str_replace(chr(128),'&euro;',$newstring); // 128 = 0x80. Not in html entity table. // Seems useles with TCPDF. Make bug with UTF8 languages
  7078. return $newstring;
  7079. }
  7080. /**
  7081. * This function is called to decode a HTML string (it decodes entities and br tags)
  7082. *
  7083. * @param string $stringtodecode String to decode
  7084. * @param string $pagecodeto Page code for result
  7085. * @return string String decoded
  7086. */
  7087. function dol_htmlentitiesbr_decode($stringtodecode, $pagecodeto = 'UTF-8')
  7088. {
  7089. $ret = dol_html_entity_decode($stringtodecode, ENT_COMPAT | ENT_HTML5, $pagecodeto);
  7090. $ret = preg_replace('/'."\r\n".'<br(\s[\sa-zA-Z_="]*)?\/?>/i', "<br>", $ret);
  7091. $ret = preg_replace('/<br(\s[\sa-zA-Z_="]*)?\/?>'."\r\n".'/i', "\r\n", $ret);
  7092. $ret = preg_replace('/<br(\s[\sa-zA-Z_="]*)?\/?>'."\n".'/i', "\n", $ret);
  7093. $ret = preg_replace('/<br(\s[\sa-zA-Z_="]*)?\/?>/i', "\n", $ret);
  7094. return $ret;
  7095. }
  7096. /**
  7097. * This function remove all ending \n and br at end
  7098. *
  7099. * @param string $stringtodecode String to decode
  7100. * @return string String decoded
  7101. */
  7102. function dol_htmlcleanlastbr($stringtodecode)
  7103. {
  7104. $ret = preg_replace('/&nbsp;$/i', "", $stringtodecode); // Because wysiwyg editor may add a &nbsp; at end of last line
  7105. $ret = preg_replace('/(<br>|<br(\s[\sa-zA-Z_="]*)?\/?>|'."\n".'|'."\r".')+$/i', "", $ret);
  7106. return $ret;
  7107. }
  7108. /**
  7109. * Replace html_entity_decode functions to manage errors
  7110. *
  7111. * @param string $a Operand a
  7112. * @param string $b Operand b (ENT_QUOTES|ENT_HTML5=convert simple, double quotes, colon, e accent, ...)
  7113. * @param string $c Operand c
  7114. * @param string $keepsomeentities Entities but &, <, >, " are not converted.
  7115. * @return string String decoded
  7116. */
  7117. function dol_html_entity_decode($a, $b, $c = 'UTF-8', $keepsomeentities = 0)
  7118. {
  7119. $newstring = $a;
  7120. if ($keepsomeentities) {
  7121. $newstring = strtr($newstring, array('&amp;'=>'__andamp__', '&lt;'=>'__andlt__', '&gt;'=>'__andgt__', '"'=>'__dquot__'));
  7122. }
  7123. $newstring = html_entity_decode((string) $newstring, (int) $b, (string) $c);
  7124. if ($keepsomeentities) {
  7125. $newstring = strtr($newstring, array('__andamp__'=>'&amp;', '__andlt__'=>'&lt;', '__andgt__'=>'&gt;', '__dquot__'=>'"'));
  7126. }
  7127. return $newstring;
  7128. }
  7129. /**
  7130. * Replace htmlentities functions.
  7131. * Goal of this function is to be sure to have default values of htmlentities that match what we need.
  7132. *
  7133. * @param string $string The input string to encode
  7134. * @param int $flags Flags (see PHP doc above)
  7135. * @param string $encoding Encoding page code
  7136. * @param bool $double_encode When double_encode is turned off, PHP will not encode existing html entities
  7137. * @return string $ret Encoded string
  7138. * @see dol_htmlentitiesbr()
  7139. */
  7140. function dol_htmlentities($string, $flags = ENT_QUOTES|ENT_SUBSTITUTE, $encoding = 'UTF-8', $double_encode = false)
  7141. {
  7142. return htmlentities($string, $flags, $encoding, $double_encode);
  7143. }
  7144. /**
  7145. * Check if a string is a correct iso string
  7146. * If not, it will not be considered as HTML encoded even if it is by FPDF.
  7147. * Example, if string contains euro symbol that has ascii code 128
  7148. *
  7149. * @param string $s String to check
  7150. * @param string $clean Clean if it is not an ISO. Warning, if file is utf8, you will get a bad formated file.
  7151. * @return int|string 0 if bad iso, 1 if good iso, Or the clean string if $clean is 1
  7152. * @deprecated Duplicate of ascii_check()
  7153. * @see ascii_check()
  7154. */
  7155. function dol_string_is_good_iso($s, $clean = 0)
  7156. {
  7157. $len = dol_strlen($s);
  7158. $out = '';
  7159. $ok = 1;
  7160. for ($scursor = 0; $scursor < $len; $scursor++) {
  7161. $ordchar = ord($s[$scursor]);
  7162. //print $scursor.'-'.$ordchar.'<br>';
  7163. if ($ordchar < 32 && $ordchar != 13 && $ordchar != 10) {
  7164. $ok = 0;
  7165. break;
  7166. } elseif ($ordchar > 126 && $ordchar < 160) {
  7167. $ok = 0;
  7168. break;
  7169. } elseif ($clean) {
  7170. $out .= $s[$scursor];
  7171. }
  7172. }
  7173. if ($clean) {
  7174. return $out;
  7175. }
  7176. return $ok;
  7177. }
  7178. /**
  7179. * Return nb of lines of a clear text
  7180. *
  7181. * @param string $s String to check
  7182. * @param int $maxchar Not yet used
  7183. * @return int Number of lines
  7184. * @see dol_nboflines_bis(), dolGetFirstLineOfText()
  7185. */
  7186. function dol_nboflines($s, $maxchar = 0)
  7187. {
  7188. if ($s == '') {
  7189. return 0;
  7190. }
  7191. $arraystring = explode("\n", $s);
  7192. $nb = count($arraystring);
  7193. return $nb;
  7194. }
  7195. /**
  7196. * Return nb of lines of a formated text with \n and <br> (WARNING: string must not have mixed \n and br separators)
  7197. *
  7198. * @param string $text Text
  7199. * @param int $maxlinesize Largeur de ligne en caracteres (ou 0 si pas de limite - defaut)
  7200. * @param string $charset Give the charset used to encode the $text variable in memory.
  7201. * @return int Number of lines
  7202. * @see dol_nboflines(), dolGetFirstLineOfText()
  7203. */
  7204. function dol_nboflines_bis($text, $maxlinesize = 0, $charset = 'UTF-8')
  7205. {
  7206. $repTable = array("\t" => " ", "\n" => "<br>", "\r" => " ", "\0" => " ", "\x0B" => " ");
  7207. if (dol_textishtml($text)) {
  7208. $repTable = array("\t" => " ", "\n" => " ", "\r" => " ", "\0" => " ", "\x0B" => " ");
  7209. }
  7210. $text = strtr($text, $repTable);
  7211. if ($charset == 'UTF-8') {
  7212. $pattern = '/(<br[^>]*>)/Uu';
  7213. } else {
  7214. // /U is to have UNGREEDY regex to limit to one html tag. /u is for UTF8 support
  7215. $pattern = '/(<br[^>]*>)/U'; // /U is to have UNGREEDY regex to limit to one html tag.
  7216. }
  7217. $a = preg_split($pattern, $text, -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);
  7218. $nblines = (int) floor((count($a) + 1) / 2);
  7219. // count possible auto line breaks
  7220. if ($maxlinesize) {
  7221. foreach ($a as $line) {
  7222. if (dol_strlen($line) > $maxlinesize) {
  7223. //$line_dec = html_entity_decode(strip_tags($line));
  7224. $line_dec = html_entity_decode($line);
  7225. if (dol_strlen($line_dec) > $maxlinesize) {
  7226. $line_dec = wordwrap($line_dec, $maxlinesize, '\n', true);
  7227. $nblines += substr_count($line_dec, '\n');
  7228. }
  7229. }
  7230. }
  7231. }
  7232. unset($a);
  7233. return $nblines;
  7234. }
  7235. /**
  7236. * Return if a text is a html content
  7237. *
  7238. * @param string $msg Content to check
  7239. * @param int $option 0=Full detection, 1=Fast check
  7240. * @return boolean true/false
  7241. * @see dol_concatdesc()
  7242. */
  7243. function dol_textishtml($msg, $option = 0)
  7244. {
  7245. if (is_null($msg)) {
  7246. return false;
  7247. }
  7248. if ($option == 1) {
  7249. if (preg_match('/<html/i', $msg)) {
  7250. return true;
  7251. } elseif (preg_match('/<body/i', $msg)) {
  7252. return true;
  7253. } elseif (preg_match('/<\/textarea/i', $msg)) {
  7254. return true;
  7255. } elseif (preg_match('/<(b|em|i|u)(\s+[^>]+)?>/i', $msg)) {
  7256. return true;
  7257. } elseif (preg_match('/<br/i', $msg)) {
  7258. return true;
  7259. }
  7260. return false;
  7261. } else {
  7262. // Remove all urls because 'http://aa?param1=abc&amp;param2=def' must not be used inside detection
  7263. $msg = preg_replace('/https?:\/\/[^"\'\s]+/i', '', $msg);
  7264. if (preg_match('/<html/i', $msg)) {
  7265. return true;
  7266. } elseif (preg_match('/<body/i', $msg)) {
  7267. return true;
  7268. } elseif (preg_match('/<\/textarea/i', $msg)) {
  7269. return true;
  7270. } elseif (preg_match('/<(b|em|i|u)(\s+[^>]+)?>/i', $msg)) {
  7271. return true;
  7272. } elseif (preg_match('/<(br|hr)\/>/i', $msg)) {
  7273. return true;
  7274. } elseif (preg_match('/<(br|hr|div|font|li|p|span|strong|table)>/i', $msg)) {
  7275. return true;
  7276. } elseif (preg_match('/<(br|hr|div|font|li|p|span|strong|table)\s+[^<>\/]*\/?>/i', $msg)) {
  7277. return true;
  7278. } elseif (preg_match('/<img\s+[^<>]*src[^<>]*>/i', $msg)) {
  7279. return true; // must accept <img src="http://example.com/aaa.png" />
  7280. } elseif (preg_match('/<a\s+[^<>]*href[^<>]*>/i', $msg)) {
  7281. return true; // must accept <a href="http://example.com/aaa.png" />
  7282. } elseif (preg_match('/<h[0-9]>/i', $msg)) {
  7283. return true;
  7284. } elseif (preg_match('/&[A-Z0-9]{1,6};/i', $msg)) {
  7285. // TODO If content is 'A link https://aaa?param=abc&amp;param2=def', it return true but must be false
  7286. return true; // Html entities names (http://www.w3schools.com/tags/ref_entities.asp)
  7287. } elseif (preg_match('/&#[0-9]{2,3};/i', $msg)) {
  7288. return true; // Html entities numbers (http://www.w3schools.com/tags/ref_entities.asp)
  7289. }
  7290. return false;
  7291. }
  7292. }
  7293. /**
  7294. * Concat 2 descriptions with a new line between them (second operand after first one with appropriate new line separator)
  7295. * text1 html + text2 html => text1 + '<br>' + text2
  7296. * text1 html + text2 txt => text1 + '<br>' + dol_nl2br(text2)
  7297. * text1 txt + text2 html => dol_nl2br(text1) + '<br>' + text2
  7298. * text1 txt + text2 txt => text1 + '\n' + text2
  7299. *
  7300. * @param string $text1 Text 1
  7301. * @param string $text2 Text 2
  7302. * @param bool $forxml true=Use <br /> instead of <br> if we have to add a br tag
  7303. * @param bool $invert invert order of description lines (we often use config MAIN_CHANGE_ORDER_CONCAT_DESCRIPTION in this parameter)
  7304. * @return string Text 1 + new line + Text2
  7305. * @see dol_textishtml()
  7306. */
  7307. function dol_concatdesc($text1, $text2, $forxml = false, $invert = false)
  7308. {
  7309. if (!empty($invert)) {
  7310. $tmp = $text1;
  7311. $text1 = $text2;
  7312. $text2 = $tmp;
  7313. }
  7314. $ret = '';
  7315. $ret .= (!dol_textishtml($text1) && dol_textishtml($text2)) ? dol_nl2br(dol_escape_htmltag($text1, 0, 1, '', 1), 0, $forxml) : $text1;
  7316. $ret .= (!empty($text1) && !empty($text2)) ? ((dol_textishtml($text1) || dol_textishtml($text2)) ? ($forxml ? "<br \>\n" : "<br>\n") : "\n") : "";
  7317. $ret .= (dol_textishtml($text1) && !dol_textishtml($text2)) ? dol_nl2br(dol_escape_htmltag($text2, 0, 1, '', 1), 0, $forxml) : $text2;
  7318. return $ret;
  7319. }
  7320. /**
  7321. * Return array of possible common substitutions. This includes several families like: 'system', 'mycompany', 'object', 'objectamount', 'date', 'user'
  7322. *
  7323. * @param Translate $outputlangs Output language
  7324. * @param int $onlykey 1=Do not calculate some heavy values of keys (performance enhancement when we need only the keys), 2=Values are trunc and html sanitized (to use for help tooltip)
  7325. * @param array $exclude Array of family keys we want to exclude. For example array('system', 'mycompany', 'object', 'objectamount', 'date', 'user', ...)
  7326. * @param Object $object Object for keys on object
  7327. * @param array $include Array of family keys we want to include. For example array('system', 'mycompany', 'object', 'objectamount', 'date', 'user', ...)
  7328. * @return array Array of substitutions
  7329. * @see setSubstitFromObject()
  7330. */
  7331. function getCommonSubstitutionArray($outputlangs, $onlykey = 0, $exclude = null, $object = null, $include = null)
  7332. {
  7333. global $db, $conf, $mysoc, $user, $extrafields;
  7334. $substitutionarray = array();
  7335. if ((empty($exclude) || !in_array('user', $exclude)) && (empty($include) || in_array('user', $include))) {
  7336. // Add SIGNATURE into substitutionarray first, so, when we will make the substitution,
  7337. // this will include signature content first and then replace var found into content of signature
  7338. //var_dump($onlykey);
  7339. $emailsendersignature = $user->signature; // dy default, we use the signature of current user. We must complete substitution with signature in c_email_senderprofile of array after calling getCommonSubstitutionArray()
  7340. $usersignature = $user->signature;
  7341. $substitutionarray = array_merge($substitutionarray, array(
  7342. '__SENDEREMAIL_SIGNATURE__' => (string) ((!getDolGlobalString('MAIN_MAIL_DO_NOT_USE_SIGN')) ? ($onlykey == 2 ? dol_trunc('SignatureFromTheSelectedSenderProfile', 30) : $emailsendersignature) : ''),
  7343. '__USER_SIGNATURE__' => (string) (($usersignature && !getDolGlobalString('MAIN_MAIL_DO_NOT_USE_SIGN')) ? ($onlykey == 2 ? dol_trunc(dol_string_nohtmltag($usersignature), 30) : $usersignature) : '')
  7344. ));
  7345. if (is_object($user)) {
  7346. $substitutionarray = array_merge($substitutionarray, array(
  7347. '__USER_ID__' => (string) $user->id,
  7348. '__USER_LOGIN__' => (string) $user->login,
  7349. '__USER_EMAIL__' => (string) $user->email,
  7350. '__USER_PHONE__' => (string) dol_print_phone($user->office_phone, '', 0, 0, '', " ", '', '', -1),
  7351. '__USER_PHONEPRO__' => (string) dol_print_phone($user->user_mobile, '', 0, 0, '', " ", '', '', -1),
  7352. '__USER_PHONEMOBILE__' => (string) dol_print_phone($user->personal_mobile, '', 0, 0, '', " ", '', '', -1),
  7353. '__USER_FAX__' => (string) $user->office_fax,
  7354. '__USER_LASTNAME__' => (string) $user->lastname,
  7355. '__USER_FIRSTNAME__' => (string) $user->firstname,
  7356. '__USER_FULLNAME__' => (string) $user->getFullName($outputlangs),
  7357. '__USER_SUPERVISOR_ID__' => (string) ($user->fk_user ? $user->fk_user : '0'),
  7358. '__USER_JOB__' => (string) $user->job,
  7359. '__USER_REMOTE_IP__' => (string) getUserRemoteIP(),
  7360. '__USER_VCARD_URL__' => (string) $user->getOnlineVirtualCardUrl('', 'external')
  7361. ));
  7362. }
  7363. }
  7364. if ((empty($exclude) || !in_array('mycompany', $exclude)) && is_object($mysoc) && (empty($include) || in_array('mycompany', $include))) {
  7365. $substitutionarray = array_merge($substitutionarray, array(
  7366. '__MYCOMPANY_NAME__' => $mysoc->name,
  7367. '__MYCOMPANY_EMAIL__' => $mysoc->email,
  7368. '__MYCOMPANY_PHONE__' => dol_print_phone($mysoc->phone, '', 0, 0, '', " ", '', '', -1),
  7369. '__MYCOMPANY_FAX__' => dol_print_phone($mysoc->fax, '', 0, 0, '', " ", '', '', -1),
  7370. '__MYCOMPANY_PROFID1__' => $mysoc->idprof1,
  7371. '__MYCOMPANY_PROFID2__' => $mysoc->idprof2,
  7372. '__MYCOMPANY_PROFID3__' => $mysoc->idprof3,
  7373. '__MYCOMPANY_PROFID4__' => $mysoc->idprof4,
  7374. '__MYCOMPANY_PROFID5__' => $mysoc->idprof5,
  7375. '__MYCOMPANY_PROFID6__' => $mysoc->idprof6,
  7376. '__MYCOMPANY_CAPITAL__' => $mysoc->capital,
  7377. '__MYCOMPANY_FULLADDRESS__' => (method_exists($mysoc, 'getFullAddress') ? $mysoc->getFullAddress(1, ', ') : ''), // $mysoc may be stdClass
  7378. '__MYCOMPANY_ADDRESS__' => $mysoc->address,
  7379. '__MYCOMPANY_ZIP__' => $mysoc->zip,
  7380. '__MYCOMPANY_TOWN__' => $mysoc->town,
  7381. '__MYCOMPANY_COUNTRY__' => $mysoc->country,
  7382. '__MYCOMPANY_COUNTRY_ID__' => $mysoc->country_id,
  7383. '__MYCOMPANY_COUNTRY_CODE__' => $mysoc->country_code,
  7384. '__MYCOMPANY_CURRENCY_CODE__' => $conf->currency
  7385. ));
  7386. }
  7387. if (($onlykey || is_object($object)) && (empty($exclude) || !in_array('object', $exclude)) && (empty($include) || in_array('object', $include))) {
  7388. if ($onlykey) {
  7389. $substitutionarray['__ID__'] = '__ID__';
  7390. $substitutionarray['__REF__'] = '__REF__';
  7391. $substitutionarray['__NEWREF__'] = '__NEWREF__';
  7392. $substitutionarray['__LABEL__'] = '__LABEL__';
  7393. $substitutionarray['__REF_CLIENT__'] = '__REF_CLIENT__';
  7394. $substitutionarray['__REF_SUPPLIER__'] = '__REF_SUPPLIER__';
  7395. $substitutionarray['__NOTE_PUBLIC__'] = '__NOTE_PUBLIC__';
  7396. $substitutionarray['__NOTE_PRIVATE__'] = '__NOTE_PRIVATE__';
  7397. $substitutionarray['__EXTRAFIELD_XXX__'] = '__EXTRAFIELD_XXX__';
  7398. if (isModEnabled("societe")) { // Most objects are concerned
  7399. $substitutionarray['__THIRDPARTY_ID__'] = '__THIRDPARTY_ID__';
  7400. $substitutionarray['__THIRDPARTY_NAME__'] = '__THIRDPARTY_NAME__';
  7401. $substitutionarray['__THIRDPARTY_NAME_ALIAS__'] = '__THIRDPARTY_NAME_ALIAS__';
  7402. $substitutionarray['__THIRDPARTY_CODE_CLIENT__'] = '__THIRDPARTY_CODE_CLIENT__';
  7403. $substitutionarray['__THIRDPARTY_CODE_FOURNISSEUR__'] = '__THIRDPARTY_CODE_FOURNISSEUR__';
  7404. $substitutionarray['__THIRDPARTY_EMAIL__'] = '__THIRDPARTY_EMAIL__';
  7405. $substitutionarray['__THIRDPARTY_PHONE__'] = '__THIRDPARTY_PHONE__';
  7406. $substitutionarray['__THIRDPARTY_FAX__'] = '__THIRDPARTY_FAX__';
  7407. $substitutionarray['__THIRDPARTY_ADDRESS__'] = '__THIRDPARTY_ADDRESS__';
  7408. $substitutionarray['__THIRDPARTY_ZIP__'] = '__THIRDPARTY_ZIP__';
  7409. $substitutionarray['__THIRDPARTY_TOWN__'] = '__THIRDPARTY_TOWN__';
  7410. $substitutionarray['__THIRDPARTY_IDPROF1__'] = '__THIRDPARTY_IDPROF1__';
  7411. $substitutionarray['__THIRDPARTY_IDPROF2__'] = '__THIRDPARTY_IDPROF2__';
  7412. $substitutionarray['__THIRDPARTY_IDPROF3__'] = '__THIRDPARTY_IDPROF3__';
  7413. $substitutionarray['__THIRDPARTY_IDPROF4__'] = '__THIRDPARTY_IDPROF4__';
  7414. $substitutionarray['__THIRDPARTY_IDPROF5__'] = '__THIRDPARTY_IDPROF5__';
  7415. $substitutionarray['__THIRDPARTY_IDPROF6__'] = '__THIRDPARTY_IDPROF6__';
  7416. $substitutionarray['__THIRDPARTY_TVAINTRA__'] = '__THIRDPARTY_TVAINTRA__';
  7417. $substitutionarray['__THIRDPARTY_NOTE_PUBLIC__'] = '__THIRDPARTY_NOTE_PUBLIC__';
  7418. $substitutionarray['__THIRDPARTY_NOTE_PRIVATE__'] = '__THIRDPARTY_NOTE_PRIVATE__';
  7419. }
  7420. if (isModEnabled('adherent') && (!is_object($object) || $object->element == 'adherent') && (empty($exclude) || !in_array('member', $exclude)) && (empty($include) || in_array('member', $include))) {
  7421. $substitutionarray['__MEMBER_ID__'] = '__MEMBER_ID__';
  7422. $substitutionarray['__MEMBER_CIVILITY__'] = '__MEMBER_CIVILITY__';
  7423. $substitutionarray['__MEMBER_FIRSTNAME__'] = '__MEMBER_FIRSTNAME__';
  7424. $substitutionarray['__MEMBER_LASTNAME__'] = '__MEMBER_LASTNAME__';
  7425. $substitutionarray['__MEMBER_USER_LOGIN_INFORMATION__'] = 'Login and pass of the external user account';
  7426. /*$substitutionarray['__MEMBER_NOTE_PUBLIC__'] = '__MEMBER_NOTE_PUBLIC__';
  7427. $substitutionarray['__MEMBER_NOTE_PRIVATE__'] = '__MEMBER_NOTE_PRIVATE__';*/
  7428. }
  7429. // add variables subtitutions ticket
  7430. if (isModEnabled('ticket') && (!is_object($object) || $object->element == 'ticket') && (empty($exclude) || !in_array('ticket', $exclude)) && (empty($include) || in_array('ticket', $include))) {
  7431. $substitutionarray['__TICKET_TRACKID__'] = '__TICKET_TRACKID__';
  7432. $substitutionarray['__TICKET_SUBJECT__'] = '__TICKET_SUBJECT__';
  7433. $substitutionarray['__TICKET_TYPE__'] = '__TICKET_TYPE__';
  7434. $substitutionarray['__TICKET_SEVERITY__'] = '__TICKET_SEVERITY__';
  7435. $substitutionarray['__TICKET_CATEGORY__'] = '__TICKET_CATEGORY__';
  7436. $substitutionarray['__TICKET_ANALYTIC_CODE__'] = '__TICKET_ANALYTIC_CODE__';
  7437. $substitutionarray['__TICKET_MESSAGE__'] = '__TICKET_MESSAGE__';
  7438. $substitutionarray['__TICKET_PROGRESSION__'] = '__TICKET_PROGRESSION__';
  7439. $substitutionarray['__TICKET_USER_ASSIGN__'] = '__TICKET_USER_ASSIGN__';
  7440. }
  7441. if (isModEnabled('recruitment') && (!is_object($object) || $object->element == 'recruitmentcandidature') && (empty($exclude) || !in_array('recruitment', $exclude)) && (empty($include) || in_array('recruitment', $include))) {
  7442. $substitutionarray['__CANDIDATE_FULLNAME__'] = '__CANDIDATE_FULLNAME__';
  7443. $substitutionarray['__CANDIDATE_FIRSTNAME__'] = '__CANDIDATE_FIRSTNAME__';
  7444. $substitutionarray['__CANDIDATE_LASTNAME__'] = '__CANDIDATE_LASTNAME__';
  7445. }
  7446. if (isModEnabled('project') && (empty($exclude) || !in_array('project', $exclude)) && (empty($include) || in_array('project', $include))) { // Most objects
  7447. $substitutionarray['__PROJECT_ID__'] = '__PROJECT_ID__';
  7448. $substitutionarray['__PROJECT_REF__'] = '__PROJECT_REF__';
  7449. $substitutionarray['__PROJECT_NAME__'] = '__PROJECT_NAME__';
  7450. /*$substitutionarray['__PROJECT_NOTE_PUBLIC__'] = '__PROJECT_NOTE_PUBLIC__';
  7451. $substitutionarray['__PROJECT_NOTE_PRIVATE__'] = '__PROJECT_NOTE_PRIVATE__';*/
  7452. }
  7453. if (isModEnabled('contrat') && (!is_object($object) || $object->element == 'contract') && (empty($exclude) || !in_array('contract', $exclude)) && (empty($include) || in_array('contract', $include))) {
  7454. $substitutionarray['__CONTRACT_HIGHEST_PLANNED_START_DATE__'] = 'Highest date planned for a service start';
  7455. $substitutionarray['__CONTRACT_HIGHEST_PLANNED_START_DATETIME__'] = 'Highest date and hour planned for service start';
  7456. $substitutionarray['__CONTRACT_LOWEST_EXPIRATION_DATE__'] = 'Lowest data for planned expiration of service';
  7457. $substitutionarray['__CONTRACT_LOWEST_EXPIRATION_DATETIME__'] = 'Lowest date and hour for planned expiration of service';
  7458. }
  7459. if (isModEnabled("propal") && (!is_object($object) || $object->element == 'propal') && (empty($exclude) || !in_array('propal', $exclude)) && (empty($include) || in_array('propal', $include))) {
  7460. $substitutionarray['__ONLINE_SIGN_URL__'] = 'ToOfferALinkForOnlineSignature';
  7461. }
  7462. if (isModEnabled("ficheinter") && (!is_object($object) || $object->element == 'fichinter') && (empty($exclude) || !in_array('intervention', $exclude)) && (empty($include) || in_array('intervention', $include))) {
  7463. $substitutionarray['__ONLINE_SIGN_FICHINTER_URL__'] = 'ToOfferALinkForOnlineSignature';
  7464. }
  7465. $substitutionarray['__ONLINE_PAYMENT_URL__'] = 'UrlToPayOnlineIfApplicable';
  7466. $substitutionarray['__ONLINE_PAYMENT_TEXT_AND_URL__'] = 'TextAndUrlToPayOnlineIfApplicable';
  7467. $substitutionarray['__SECUREKEYPAYMENT__'] = 'Security key (if key is not unique per record)';
  7468. $substitutionarray['__SECUREKEYPAYMENT_MEMBER__'] = 'Security key for payment on a member subscription (one key per member)';
  7469. $substitutionarray['__SECUREKEYPAYMENT_ORDER__'] = 'Security key for payment on an order';
  7470. $substitutionarray['__SECUREKEYPAYMENT_INVOICE__'] = 'Security key for payment on an invoice';
  7471. $substitutionarray['__SECUREKEYPAYMENT_CONTRACTLINE__'] = 'Security key for payment on a service of a contract';
  7472. $substitutionarray['__DIRECTDOWNLOAD_URL_PROPOSAL__'] = 'Direct download url of a proposal';
  7473. $substitutionarray['__DIRECTDOWNLOAD_URL_ORDER__'] = 'Direct download url of an order';
  7474. $substitutionarray['__DIRECTDOWNLOAD_URL_INVOICE__'] = 'Direct download url of an invoice';
  7475. $substitutionarray['__DIRECTDOWNLOAD_URL_CONTRACT__'] = 'Direct download url of a contract';
  7476. $substitutionarray['__DIRECTDOWNLOAD_URL_SUPPLIER_PROPOSAL__'] = 'Direct download url of a supplier proposal';
  7477. if (isModEnabled("expedition") && (!is_object($object) || $object->element == 'shipping')) {
  7478. $substitutionarray['__SHIPPINGTRACKNUM__'] = 'Shipping tracking number';
  7479. $substitutionarray['__SHIPPINGTRACKNUMURL__'] = 'Shipping tracking url';
  7480. $substitutionarray['__SHIPPINGMETHOD__'] = 'Shipping method';
  7481. }
  7482. if (isModEnabled("reception") && (!is_object($object) || $object->element == 'reception')) {
  7483. $substitutionarray['__RECEPTIONTRACKNUM__'] = 'Shippin tracking number of shipment';
  7484. $substitutionarray['__RECEPTIONTRACKNUMURL__'] = 'Shipping tracking url';
  7485. }
  7486. } else {
  7487. $substitutionarray['__ID__'] = $object->id;
  7488. $substitutionarray['__REF__'] = $object->ref;
  7489. $substitutionarray['__NEWREF__'] = $object->newref;
  7490. $substitutionarray['__LABEL__'] = (isset($object->label) ? $object->label : (isset($object->title) ? $object->title : null));
  7491. $substitutionarray['__REF_CLIENT__'] = (isset($object->ref_client) ? $object->ref_client : (isset($object->ref_customer) ? $object->ref_customer : null));
  7492. $substitutionarray['__REF_SUPPLIER__'] = (isset($object->ref_supplier) ? $object->ref_supplier : null);
  7493. $substitutionarray['__NOTE_PUBLIC__'] = (isset($object->note_public) ? $object->note_public : null);
  7494. $substitutionarray['__NOTE_PRIVATE__'] = (isset($object->note_private) ? $object->note_private : null);
  7495. $substitutionarray['__DATE_DELIVERY__'] = (isset($object->date_delivery) ? dol_print_date($object->date_delivery, 'day', 0, $outputlangs) : '');
  7496. $substitutionarray['__DATE_DELIVERY_DAY__'] = (isset($object->date_delivery) ? dol_print_date($object->date_delivery, "%d") : '');
  7497. $substitutionarray['__DATE_DELIVERY_DAY_TEXT__'] = (isset($object->date_delivery) ? dol_print_date($object->date_delivery, "%A") : '');
  7498. $substitutionarray['__DATE_DELIVERY_MON__'] = (isset($object->date_delivery) ? dol_print_date($object->date_delivery, "%m") : '');
  7499. $substitutionarray['__DATE_DELIVERY_MON_TEXT__'] = (isset($object->date_delivery) ? dol_print_date($object->date_delivery, "%b") : '');
  7500. $substitutionarray['__DATE_DELIVERY_YEAR__'] = (isset($object->date_delivery) ? dol_print_date($object->date_delivery, "%Y") : '');
  7501. $substitutionarray['__DATE_DELIVERY_HH__'] = (isset($object->date_delivery) ? dol_print_date($object->date_delivery, "%H") : '');
  7502. $substitutionarray['__DATE_DELIVERY_MM__'] = (isset($object->date_delivery) ? dol_print_date($object->date_delivery, "%M") : '');
  7503. $substitutionarray['__DATE_DELIVERY_SS__'] = (isset($object->date_delivery) ? dol_print_date($object->date_delivery, "%S") : '');
  7504. // For backward compatibility (deprecated)
  7505. $substitutionarray['__REFCLIENT__'] = (isset($object->ref_client) ? $object->ref_client : (isset($object->ref_customer) ? $object->ref_customer : null));
  7506. $substitutionarray['__REFSUPPLIER__'] = (isset($object->ref_supplier) ? $object->ref_supplier : null);
  7507. $substitutionarray['__SUPPLIER_ORDER_DATE_DELIVERY__'] = (isset($object->delivery_date) ? dol_print_date($object->delivery_date, 'day', 0, $outputlangs) : '');
  7508. $substitutionarray['__SUPPLIER_ORDER_DELAY_DELIVERY__'] = (isset($object->availability_code) ? ($outputlangs->transnoentities("AvailabilityType".$object->availability_code) != 'AvailabilityType'.$object->availability_code ? $outputlangs->transnoentities("AvailabilityType".$object->availability_code) : $outputlangs->convToOutputCharset(isset($object->availability) ? $object->availability : '')) : '');
  7509. $substitutionarray['__EXPIRATION_DATE__'] = (isset($object->fin_validite) ? dol_print_date($object->fin_validite, 'daytext') : '');
  7510. if (is_object($object) && ($object->element == 'adherent' || $object->element == 'member') && $object->id > 0) {
  7511. $birthday = (empty($object->birth) ? '' : dol_print_date($object->birth, 'day'));
  7512. $substitutionarray['__MEMBER_ID__'] = (isset($object->id) ? $object->id : '');
  7513. if (method_exists($object, 'getCivilityLabel')) {
  7514. $substitutionarray['__MEMBER_CIVILITY__'] = $object->getCivilityLabel();
  7515. }
  7516. $substitutionarray['__MEMBER_FIRSTNAME__'] = (isset($object->firstname) ? $object->firstname : '');
  7517. $substitutionarray['__MEMBER_LASTNAME__'] = (isset($object->lastname) ? $object->lastname : '');
  7518. $substitutionarray['__MEMBER_USER_LOGIN_INFORMATION__'] = '';
  7519. if (method_exists($object, 'getFullName')) {
  7520. $substitutionarray['__MEMBER_FULLNAME__'] = $object->getFullName($outputlangs);
  7521. }
  7522. $substitutionarray['__MEMBER_COMPANY__'] = (isset($object->societe) ? $object->societe : '');
  7523. $substitutionarray['__MEMBER_ADDRESS__'] = (isset($object->address) ? $object->address : '');
  7524. $substitutionarray['__MEMBER_ZIP__'] = (isset($object->zip) ? $object->zip : '');
  7525. $substitutionarray['__MEMBER_TOWN__'] = (isset($object->town) ? $object->town : '');
  7526. $substitutionarray['__MEMBER_COUNTRY__'] = (isset($object->country) ? $object->country : '');
  7527. $substitutionarray['__MEMBER_EMAIL__'] = (isset($object->email) ? $object->email : '');
  7528. $substitutionarray['__MEMBER_BIRTH__'] = (isset($birthday) ? $birthday : '');
  7529. $substitutionarray['__MEMBER_PHOTO__'] = (isset($object->photo) ? $object->photo : '');
  7530. $substitutionarray['__MEMBER_LOGIN__'] = (isset($object->login) ? $object->login : '');
  7531. $substitutionarray['__MEMBER_PASSWORD__'] = (isset($object->pass) ? $object->pass : '');
  7532. $substitutionarray['__MEMBER_PHONE__'] = (isset($object->phone) ? dol_print_phone($object->phone) : '');
  7533. $substitutionarray['__MEMBER_PHONEPRO__'] = (isset($object->phone_perso) ? dol_print_phone($object->phone_perso) : '');
  7534. $substitutionarray['__MEMBER_PHONEMOBILE__'] = (isset($object->phone_mobile) ? dol_print_phone($object->phone_mobile) : '');
  7535. $substitutionarray['__MEMBER_TYPE__'] = (isset($object->type) ? $object->type : '');
  7536. $substitutionarray['__MEMBER_FIRST_SUBSCRIPTION_DATE__'] = dol_print_date($object->first_subscription_date, 'dayrfc');
  7537. $substitutionarray['__MEMBER_FIRST_SUBSCRIPTION_DATE_START__'] = (isset($object->first_subscription_date_start) ? dol_print_date($object->first_subscription_date_start, 'dayrfc') : '');
  7538. $substitutionarray['__MEMBER_FIRST_SUBSCRIPTION_DATE_END__'] = (isset($object->first_subscription_date_end) ? dol_print_date($object->first_subscription_date_end, 'dayrfc') : '');
  7539. $substitutionarray['__MEMBER_LAST_SUBSCRIPTION_DATE__'] = dol_print_date($object->last_subscription_date, 'dayrfc');
  7540. $substitutionarray['__MEMBER_LAST_SUBSCRIPTION_DATE_START__'] = dol_print_date($object->last_subscription_date_start, 'dayrfc');
  7541. $substitutionarray['__MEMBER_LAST_SUBSCRIPTION_DATE_END__'] = dol_print_date($object->last_subscription_date_end, 'dayrfc');
  7542. }
  7543. if (is_object($object) && $object->element == 'societe') {
  7544. $substitutionarray['__THIRDPARTY_ID__'] = (is_object($object) ? $object->id : '');
  7545. $substitutionarray['__THIRDPARTY_NAME__'] = (is_object($object) ? $object->name : '');
  7546. $substitutionarray['__THIRDPARTY_NAME_ALIAS__'] = (is_object($object) ? $object->name_alias : '');
  7547. $substitutionarray['__THIRDPARTY_CODE_CLIENT__'] = (is_object($object) ? $object->code_client : '');
  7548. $substitutionarray['__THIRDPARTY_CODE_FOURNISSEUR__'] = (is_object($object) ? $object->code_fournisseur : '');
  7549. $substitutionarray['__THIRDPARTY_EMAIL__'] = (is_object($object) ? $object->email : '');
  7550. $substitutionarray['__THIRDPARTY_PHONE__'] = (is_object($object) ? dol_print_phone($object->phone) : '');
  7551. $substitutionarray['__THIRDPARTY_FAX__'] = (is_object($object) ? dol_print_phone($object->fax) : '');
  7552. $substitutionarray['__THIRDPARTY_ADDRESS__'] = (is_object($object) ? $object->address : '');
  7553. $substitutionarray['__THIRDPARTY_ZIP__'] = (is_object($object) ? $object->zip : '');
  7554. $substitutionarray['__THIRDPARTY_TOWN__'] = (is_object($object) ? $object->town : '');
  7555. $substitutionarray['__THIRDPARTY_COUNTRY_ID__'] = (is_object($object) ? $object->country_id : '');
  7556. $substitutionarray['__THIRDPARTY_COUNTRY_CODE__'] = (is_object($object) ? $object->country_code : '');
  7557. $substitutionarray['__THIRDPARTY_IDPROF1__'] = (is_object($object) ? $object->idprof1 : '');
  7558. $substitutionarray['__THIRDPARTY_IDPROF2__'] = (is_object($object) ? $object->idprof2 : '');
  7559. $substitutionarray['__THIRDPARTY_IDPROF3__'] = (is_object($object) ? $object->idprof3 : '');
  7560. $substitutionarray['__THIRDPARTY_IDPROF4__'] = (is_object($object) ? $object->idprof4 : '');
  7561. $substitutionarray['__THIRDPARTY_IDPROF5__'] = (is_object($object) ? $object->idprof5 : '');
  7562. $substitutionarray['__THIRDPARTY_IDPROF6__'] = (is_object($object) ? $object->idprof6 : '');
  7563. $substitutionarray['__THIRDPARTY_TVAINTRA__'] = (is_object($object) ? $object->tva_intra : '');
  7564. $substitutionarray['__THIRDPARTY_NOTE_PUBLIC__'] = (is_object($object) ? dol_htmlentitiesbr($object->note_public) : '');
  7565. $substitutionarray['__THIRDPARTY_NOTE_PRIVATE__'] = (is_object($object) ? dol_htmlentitiesbr($object->note_private) : '');
  7566. } elseif (is_object($object->thirdparty)) {
  7567. $substitutionarray['__THIRDPARTY_ID__'] = (is_object($object->thirdparty) ? $object->thirdparty->id : '');
  7568. $substitutionarray['__THIRDPARTY_NAME__'] = (is_object($object->thirdparty) ? $object->thirdparty->name : '');
  7569. $substitutionarray['__THIRDPARTY_NAME_ALIAS__'] = (is_object($object->thirdparty) ? $object->thirdparty->name_alias : '');
  7570. $substitutionarray['__THIRDPARTY_CODE_CLIENT__'] = (is_object($object->thirdparty) ? $object->thirdparty->code_client : '');
  7571. $substitutionarray['__THIRDPARTY_CODE_FOURNISSEUR__'] = (is_object($object->thirdparty) ? $object->thirdparty->code_fournisseur : '');
  7572. $substitutionarray['__THIRDPARTY_EMAIL__'] = (is_object($object->thirdparty) ? $object->thirdparty->email : '');
  7573. $substitutionarray['__THIRDPARTY_PHONE__'] = (is_object($object->thirdparty) ? dol_print_phone($object->thirdparty->phone) : '');
  7574. $substitutionarray['__THIRDPARTY_FAX__'] = (is_object($object->thirdparty) ? dol_print_phone($object->thirdparty->fax) : '');
  7575. $substitutionarray['__THIRDPARTY_ADDRESS__'] = (is_object($object->thirdparty) ? $object->thirdparty->address : '');
  7576. $substitutionarray['__THIRDPARTY_ZIP__'] = (is_object($object->thirdparty) ? $object->thirdparty->zip : '');
  7577. $substitutionarray['__THIRDPARTY_TOWN__'] = (is_object($object->thirdparty) ? $object->thirdparty->town : '');
  7578. $substitutionarray['__THIRDPARTY_COUNTRY_ID__'] = (is_object($object->thirdparty) ? $object->thirdparty->country_id : '');
  7579. $substitutionarray['__THIRDPARTY_COUNTRY_CODE__'] = (is_object($object->thirdparty) ? $object->thirdparty->country_code : '');
  7580. $substitutionarray['__THIRDPARTY_IDPROF1__'] = (is_object($object->thirdparty) ? $object->thirdparty->idprof1 : '');
  7581. $substitutionarray['__THIRDPARTY_IDPROF2__'] = (is_object($object->thirdparty) ? $object->thirdparty->idprof2 : '');
  7582. $substitutionarray['__THIRDPARTY_IDPROF3__'] = (is_object($object->thirdparty) ? $object->thirdparty->idprof3 : '');
  7583. $substitutionarray['__THIRDPARTY_IDPROF4__'] = (is_object($object->thirdparty) ? $object->thirdparty->idprof4 : '');
  7584. $substitutionarray['__THIRDPARTY_IDPROF5__'] = (is_object($object->thirdparty) ? $object->thirdparty->idprof5 : '');
  7585. $substitutionarray['__THIRDPARTY_IDPROF6__'] = (is_object($object->thirdparty) ? $object->thirdparty->idprof6 : '');
  7586. $substitutionarray['__THIRDPARTY_TVAINTRA__'] = (is_object($object->thirdparty) ? $object->thirdparty->tva_intra : '');
  7587. $substitutionarray['__THIRDPARTY_NOTE_PUBLIC__'] = (is_object($object->thirdparty) ? dol_htmlentitiesbr($object->thirdparty->note_public) : '');
  7588. $substitutionarray['__THIRDPARTY_NOTE_PRIVATE__'] = (is_object($object->thirdparty) ? dol_htmlentitiesbr($object->thirdparty->note_private) : '');
  7589. }
  7590. if (is_object($object) && $object->element == 'recruitmentcandidature') {
  7591. $substitutionarray['__CANDIDATE_FULLNAME__'] = $object->getFullName($outputlangs);
  7592. $substitutionarray['__CANDIDATE_FIRSTNAME__'] = isset($object->firstname) ? $object->firstname : '';
  7593. $substitutionarray['__CANDIDATE_LASTNAME__'] = isset($object->lastname) ? $object->lastname : '';
  7594. }
  7595. if (is_object($object) && $object->element == 'conferenceorboothattendee') {
  7596. $substitutionarray['__ATTENDEE_FULLNAME__'] = $object->getFullName($outputlangs);
  7597. $substitutionarray['__ATTENDEE_FIRSTNAME__'] = isset($object->firstname) ? $object->firstname : '';
  7598. $substitutionarray['__ATTENDEE_LASTNAME__'] = isset($object->lastname) ? $object->lastname : '';
  7599. }
  7600. if (is_object($object) && $object->element == 'project') {
  7601. $substitutionarray['__PROJECT_ID__'] = $object->id;
  7602. $substitutionarray['__PROJECT_REF__'] = $object->ref;
  7603. $substitutionarray['__PROJECT_NAME__'] = $object->title;
  7604. } elseif (is_object($object)) {
  7605. $project = null;
  7606. if (!empty($object->project)) {
  7607. $project = $object->project;
  7608. } elseif (!empty($object->projet)) { // Deprecated, for backward compatibility
  7609. $project = $object->projet;
  7610. }
  7611. if (!is_null($project) && is_object($project)) {
  7612. $substitutionarray['__PROJECT_ID__'] = $project->id;
  7613. $substitutionarray['__PROJECT_REF__'] = $project->ref;
  7614. $substitutionarray['__PROJECT_NAME__'] = $project->title;
  7615. } else {
  7616. // can substitute variables for project : uses lazy load in "make_substitutions" method
  7617. $project_id = 0;
  7618. if (!empty($object->fk_project) && $object->fk_project > 0) {
  7619. $project_id = $object->fk_project;
  7620. } elseif (!empty($object->fk_projet) && $object->fk_projet > 0) {
  7621. $project_id = $object->fk_project;
  7622. }
  7623. if ($project_id > 0) {
  7624. // path:class:method:id
  7625. $substitutionarray['__PROJECT_ID__@lazyload'] = '/projet/class/project.class.php:Project:fetchAndSetSubstitution:' . $project_id;
  7626. $substitutionarray['__PROJECT_REF__@lazyload'] = '/projet/class/project.class.php:Project:fetchAndSetSubstitution:' . $project_id;
  7627. $substitutionarray['__PROJECT_NAME__@lazyload'] = '/projet/class/project.class.php:Project:fetchAndSetSubstitution:' . $project_id;
  7628. }
  7629. }
  7630. }
  7631. if (is_object($object) && $object->element == 'shipping') {
  7632. $substitutionarray['__SHIPPINGTRACKNUM__'] = $object->tracking_number;
  7633. $substitutionarray['__SHIPPINGTRACKNUMURL__'] = $object->tracking_url;
  7634. $substitutionarray['__SHIPPINGMETHOD__'] = $object->shipping_method;
  7635. }
  7636. if (is_object($object) && $object->element == 'reception') {
  7637. $substitutionarray['__RECEPTIONTRACKNUM__'] = $object->tracking_number;
  7638. $substitutionarray['__RECEPTIONTRACKNUMURL__'] = $object->tracking_url;
  7639. }
  7640. if (is_object($object) && $object->element == 'contrat' && $object->id > 0 && is_array($object->lines)) {
  7641. $dateplannedstart = '';
  7642. $datenextexpiration = '';
  7643. foreach ($object->lines as $line) {
  7644. if ($line->date_start > $dateplannedstart) {
  7645. $dateplannedstart = $line->date_start;
  7646. }
  7647. if ($line->statut == 4 && $line->date_end && (!$datenextexpiration || $line->date_end < $datenextexpiration)) {
  7648. $datenextexpiration = $line->date_end;
  7649. }
  7650. }
  7651. $substitutionarray['__CONTRACT_HIGHEST_PLANNED_START_DATE__'] = dol_print_date($dateplannedstart, 'dayrfc');
  7652. $substitutionarray['__CONTRACT_HIGHEST_PLANNED_START_DATETIME__'] = dol_print_date($dateplannedstart, 'standard');
  7653. $substitutionarray['__CONTRACT_LOWEST_EXPIRATION_DATE__'] = dol_print_date($datenextexpiration, 'dayrfc');
  7654. $substitutionarray['__CONTRACT_LOWEST_EXPIRATION_DATETIME__'] = dol_print_date($datenextexpiration, 'standard');
  7655. }
  7656. // add substition variable for ticket
  7657. if (is_object($object) && $object->element == 'ticket') {
  7658. $substitutionarray['__TICKET_TRACKID__'] = $object->track_id;
  7659. $substitutionarray['__REF__'] = $object->ref;
  7660. $substitutionarray['__TICKET_SUBJECT__'] = $object->subject;
  7661. $substitutionarray['__TICKET_TYPE__'] = $object->type_code;
  7662. $substitutionarray['__TICKET_SEVERITY__'] = $object->severity_code;
  7663. $substitutionarray['__TICKET_CATEGORY__'] = $object->category_code; // For backward compatibility
  7664. $substitutionarray['__TICKET_ANALYTIC_CODE__'] = $object->category_code;
  7665. $substitutionarray['__TICKET_MESSAGE__'] = $object->message;
  7666. $substitutionarray['__TICKET_PROGRESSION__'] = $object->progress;
  7667. $userstat = new User($db);
  7668. if ($object->fk_user_assign > 0) {
  7669. $userstat->fetch($object->fk_user_assign);
  7670. $substitutionarray['__TICKET_USER_ASSIGN__'] = dolGetFirstLastname($userstat->firstname, $userstat->lastname);
  7671. }
  7672. if ($object->fk_user_create > 0) {
  7673. $userstat->fetch($object->fk_user_create);
  7674. $substitutionarray['__USER_CREATE__'] = dolGetFirstLastname($userstat->firstname, $userstat->lastname);
  7675. }
  7676. }
  7677. // Create dynamic tags for __EXTRAFIELD_FIELD__
  7678. if ($object->table_element && $object->id > 0) {
  7679. if (!is_object($extrafields)) {
  7680. $extrafields = new ExtraFields($db);
  7681. }
  7682. $extrafields->fetch_name_optionals_label($object->table_element, true);
  7683. if ($object->fetch_optionals() > 0) {
  7684. if (is_array($extrafields->attributes[$object->table_element]['label']) && count($extrafields->attributes[$object->table_element]['label']) > 0) {
  7685. foreach ($extrafields->attributes[$object->table_element]['label'] as $key => $label) {
  7686. if ($extrafields->attributes[$object->table_element]['type'][$key] == 'date') {
  7687. $substitutionarray['__EXTRAFIELD_'.strtoupper($key).'__'] = dol_print_date($object->array_options['options_'.$key], 'day');
  7688. $substitutionarray['__EXTRAFIELD_'.strtoupper($key).'_LOCALE__'] = dol_print_date($object->array_options['options_'.$key], 'day', 'tzserver', $outputlangs);
  7689. $substitutionarray['__EXTRAFIELD_'.strtoupper($key).'_RFC__'] = dol_print_date($object->array_options['options_'.$key], 'dayrfc');
  7690. } elseif ($extrafields->attributes[$object->table_element]['type'][$key] == 'datetime') {
  7691. $datetime = $object->array_options['options_'.$key];
  7692. $substitutionarray['__EXTRAFIELD_'.strtoupper($key).'__'] = ($datetime != "0000-00-00 00:00:00" ? dol_print_date($datetime, 'dayhour') : '');
  7693. $substitutionarray['__EXTRAFIELD_'.strtoupper($key).'_LOCALE__'] = ($datetime != "0000-00-00 00:00:00" ? dol_print_date($datetime, 'dayhour', 'tzserver', $outputlangs) : '');
  7694. $substitutionarray['__EXTRAFIELD_'.strtoupper($key).'_DAY_LOCALE__'] = ($datetime != "0000-00-00 00:00:00" ? dol_print_date($datetime, 'day', 'tzserver', $outputlangs) : '');
  7695. $substitutionarray['__EXTRAFIELD_'.strtoupper($key).'_RFC__'] = ($datetime != "0000-00-00 00:00:00" ? dol_print_date($datetime, 'dayhourrfc') : '');
  7696. } elseif ($extrafields->attributes[$object->table_element]['type'][$key] == 'phone') {
  7697. $substitutionarray['__EXTRAFIELD_'.strtoupper($key).'__'] = dol_print_phone($object->array_options['options_'.$key]);
  7698. } elseif ($extrafields->attributes[$object->table_element]['type'][$key] == 'price') {
  7699. $substitutionarray['__EXTRAFIELD_'.strtoupper($key).'__'] = $object->array_options['options_'.$key];
  7700. $substitutionarray['__EXTRAFIELD_'.strtoupper($key).'_FORMATED__'] = price($object->array_options['options_'.$key]);
  7701. } elseif ($extrafields->attributes[$object->table_element]['type'][$key] != 'separator') {
  7702. $substitutionarray['__EXTRAFIELD_'.strtoupper($key).'__'] = !empty($object->array_options['options_'.$key]) ? $object->array_options['options_'.$key] : '';
  7703. }
  7704. }
  7705. }
  7706. }
  7707. }
  7708. // Complete substitution array with the url to make online payment
  7709. $paymenturl = '';
  7710. if (empty($substitutionarray['__REF__'])) {
  7711. $paymenturl = '';
  7712. } else {
  7713. // Set the online payment url link into __ONLINE_PAYMENT_URL__ key
  7714. require_once DOL_DOCUMENT_ROOT.'/core/lib/payments.lib.php';
  7715. $outputlangs->loadLangs(array('paypal', 'other'));
  7716. $amounttouse = 0;
  7717. $typeforonlinepayment = 'free';
  7718. if (is_object($object) && $object->element == 'commande') {
  7719. $typeforonlinepayment = 'order';
  7720. }
  7721. if (is_object($object) && $object->element == 'facture') {
  7722. $typeforonlinepayment = 'invoice';
  7723. }
  7724. if (is_object($object) && $object->element == 'member') {
  7725. $typeforonlinepayment = 'member';
  7726. if (!empty($object->last_subscription_amount)) {
  7727. $amounttouse = $object->last_subscription_amount;
  7728. }
  7729. }
  7730. if (is_object($object) && $object->element == 'contrat') {
  7731. $typeforonlinepayment = 'contract';
  7732. }
  7733. if (is_object($object) && $object->element == 'fichinter') {
  7734. $typeforonlinepayment = 'ficheinter';
  7735. }
  7736. $url = getOnlinePaymentUrl(0, $typeforonlinepayment, $substitutionarray['__REF__'], $amounttouse);
  7737. $paymenturl = $url;
  7738. }
  7739. if ($object->id > 0) {
  7740. $substitutionarray['__ONLINE_PAYMENT_TEXT_AND_URL__'] = ($paymenturl ? str_replace('\n', "\n", $outputlangs->trans("PredefinedMailContentLink", $paymenturl)) : '');
  7741. $substitutionarray['__ONLINE_PAYMENT_URL__'] = $paymenturl;
  7742. if (getDolGlobalString('PROPOSAL_ALLOW_EXTERNAL_DOWNLOAD') && is_object($object) && $object->element == 'propal') {
  7743. $substitutionarray['__DIRECTDOWNLOAD_URL_PROPOSAL__'] = $object->getLastMainDocLink($object->element);
  7744. } else {
  7745. $substitutionarray['__DIRECTDOWNLOAD_URL_PROPOSAL__'] = '';
  7746. }
  7747. if (getDolGlobalString('ORDER_ALLOW_EXTERNAL_DOWNLOAD') && is_object($object) && $object->element == 'commande') {
  7748. $substitutionarray['__DIRECTDOWNLOAD_URL_ORDER__'] = $object->getLastMainDocLink($object->element);
  7749. } else {
  7750. $substitutionarray['__DIRECTDOWNLOAD_URL_ORDER__'] = '';
  7751. }
  7752. if (getDolGlobalString('INVOICE_ALLOW_EXTERNAL_DOWNLOAD') && is_object($object) && $object->element == 'facture') {
  7753. $substitutionarray['__DIRECTDOWNLOAD_URL_INVOICE__'] = $object->getLastMainDocLink($object->element);
  7754. } else {
  7755. $substitutionarray['__DIRECTDOWNLOAD_URL_INVOICE__'] = '';
  7756. }
  7757. if (getDolGlobalString('CONTRACT_ALLOW_EXTERNAL_DOWNLOAD') && is_object($object) && $object->element == 'contrat') {
  7758. $substitutionarray['__DIRECTDOWNLOAD_URL_CONTRACT__'] = $object->getLastMainDocLink($object->element);
  7759. } else {
  7760. $substitutionarray['__DIRECTDOWNLOAD_URL_CONTRACT__'] = '';
  7761. }
  7762. if (getDolGlobalString('FICHINTER_ALLOW_EXTERNAL_DOWNLOAD') && is_object($object) && $object->element == 'fichinter') {
  7763. $substitutionarray['__DIRECTDOWNLOAD_URL_FICHINTER__'] = $object->getLastMainDocLink($object->element);
  7764. } else {
  7765. $substitutionarray['__DIRECTDOWNLOAD_URL_FICHINTER__'] = '';
  7766. }
  7767. if (getDolGlobalString('SUPPLIER_PROPOSAL_ALLOW_EXTERNAL_DOWNLOAD') && is_object($object) && $object->element == 'supplier_proposal') {
  7768. $substitutionarray['__DIRECTDOWNLOAD_URL_SUPPLIER_PROPOSAL__'] = $object->getLastMainDocLink($object->element);
  7769. } else {
  7770. $substitutionarray['__DIRECTDOWNLOAD_URL_SUPPLIER_PROPOSAL__'] = '';
  7771. }
  7772. if (is_object($object) && $object->element == 'propal') {
  7773. $substitutionarray['__URL_PROPOSAL__'] = DOL_MAIN_URL_ROOT."/comm/propal/card.php?id=".$object->id;
  7774. require_once DOL_DOCUMENT_ROOT.'/core/lib/signature.lib.php';
  7775. $substitutionarray['__ONLINE_SIGN_URL__'] = getOnlineSignatureUrl(0, 'proposal', $object->ref);
  7776. }
  7777. if (is_object($object) && $object->element == 'commande') {
  7778. $substitutionarray['__URL_ORDER__'] = DOL_MAIN_URL_ROOT."/commande/card.php?id=".$object->id;
  7779. }
  7780. if (is_object($object) && $object->element == 'facture') {
  7781. $substitutionarray['__URL_INVOICE__'] = DOL_MAIN_URL_ROOT."/compta/facture/card.php?id=".$object->id;
  7782. }
  7783. if (is_object($object) && $object->element == 'contrat') {
  7784. $substitutionarray['__URL_CONTRACT__'] = DOL_MAIN_URL_ROOT."/contrat/card.php?id=".$object->id;
  7785. require_once DOL_DOCUMENT_ROOT.'/core/lib/signature.lib.php';
  7786. $substitutionarray['__ONLINE_SIGN_URL__'] = getOnlineSignatureUrl(0, 'contract', $object->ref);
  7787. }
  7788. if (is_object($object) && $object->element == 'fichinter') {
  7789. $substitutionarray['__URL_FICHINTER__'] = DOL_MAIN_URL_ROOT."/fichinter/card.php?id=".$object->id;
  7790. require_once DOL_DOCUMENT_ROOT.'/core/lib/signature.lib.php';
  7791. $substitutionarray['__ONLINE_SIGN_FICHINTER_URL__'] = getOnlineSignatureUrl(0, 'fichinter', $object->ref);
  7792. }
  7793. if (is_object($object) && $object->element == 'supplier_proposal') {
  7794. $substitutionarray['__URL_SUPPLIER_PROPOSAL__'] = DOL_MAIN_URL_ROOT."/supplier_proposal/card.php?id=".$object->id;
  7795. }
  7796. if (is_object($object) && $object->element == 'shipping') {
  7797. $substitutionarray['__URL_SHIPMENT__'] = DOL_MAIN_URL_ROOT."/expedition/card.php?id=".$object->id;
  7798. }
  7799. }
  7800. if (is_object($object) && $object->element == 'action') {
  7801. $substitutionarray['__EVENT_LABEL__'] = $object->label;
  7802. $substitutionarray['__EVENT_TYPE__'] = $outputlangs->trans("Action".$object->type_code);
  7803. $substitutionarray['__EVENT_DATE__'] = dol_print_date($object->datep, 'day', 'auto', $outputlangs);
  7804. $substitutionarray['__EVENT_TIME__'] = dol_print_date($object->datep, 'hour', 'auto', $outputlangs);
  7805. }
  7806. }
  7807. }
  7808. if ((empty($exclude) || !in_array('objectamount', $exclude)) && (empty($include) || in_array('objectamount', $include))) {
  7809. include_once DOL_DOCUMENT_ROOT.'/core/lib/functionsnumtoword.lib.php';
  7810. $substitutionarray['__DATE_YMD__'] = is_object($object) ? (isset($object->date) ? dol_print_date($object->date, 'day', 0, $outputlangs) : null) : '';
  7811. $substitutionarray['__DATE_DUE_YMD__'] = is_object($object) ? (isset($object->date_lim_reglement) ? dol_print_date($object->date_lim_reglement, 'day', 0, $outputlangs) : null) : '';
  7812. $already_payed_all = 0;
  7813. if (is_object($object) && ($object instanceof Facture)) {
  7814. $already_payed_all = $object->sumpayed + $object->sumdeposit + $object->sumcreditnote;
  7815. }
  7816. $substitutionarray['__AMOUNT_EXCL_TAX__'] = is_object($object) ? $object->total_ht : '';
  7817. $substitutionarray['__AMOUNT__'] = is_object($object) ? $object->total_ttc : '';
  7818. $substitutionarray['__AMOUNT_TEXT__'] = is_object($object) ? dol_convertToWord($object->total_ttc, $outputlangs, '', true) : '';
  7819. $substitutionarray['__AMOUNT_TEXTCURRENCY__'] = is_object($object) ? dol_convertToWord($object->total_ttc, $outputlangs, $conf->currency, true) : '';
  7820. $substitutionarray['__AMOUNT_REMAIN__'] = is_object($object) ? price2num($object->total_ttc - $already_payed_all, 'MT') : '';
  7821. $substitutionarray['__AMOUNT_VAT__'] = is_object($object) ? (isset($object->total_vat) ? $object->total_vat : $object->total_tva) : '';
  7822. $substitutionarray['__AMOUNT_VAT_TEXT__'] = is_object($object) ? (isset($object->total_vat) ? dol_convertToWord($object->total_vat, $outputlangs, '', true) : dol_convertToWord($object->total_tva, $outputlangs, '', true)) : '';
  7823. $substitutionarray['__AMOUNT_VAT_TEXTCURRENCY__'] = is_object($object) ? (isset($object->total_vat) ? dol_convertToWord($object->total_vat, $outputlangs, $conf->currency, true) : dol_convertToWord($object->total_tva, $outputlangs, $conf->currency, true)) : '';
  7824. if ($onlykey != 2 || $mysoc->useLocalTax(1)) {
  7825. $substitutionarray['__AMOUNT_TAX2__'] = is_object($object) ? $object->total_localtax1 : '';
  7826. }
  7827. if ($onlykey != 2 || $mysoc->useLocalTax(2)) {
  7828. $substitutionarray['__AMOUNT_TAX3__'] = is_object($object) ? $object->total_localtax2 : '';
  7829. }
  7830. // Amount keys formated in a currency
  7831. $substitutionarray['__AMOUNT_EXCL_TAX_FORMATED__'] = is_object($object) ? ($object->total_ht ? price($object->total_ht, 0, $outputlangs, 0, -1, -1, $conf->currency) : null) : '';
  7832. $substitutionarray['__AMOUNT_FORMATED__'] = is_object($object) ? ($object->total_ttc ? price($object->total_ttc, 0, $outputlangs, 0, -1, -1, $conf->currency) : null) : '';
  7833. $substitutionarray['__AMOUNT_REMAIN_FORMATED__'] = is_object($object) ? ($object->total_ttc ? price($object->total_ttc - $already_payed_all, 0, $outputlangs, 0, -1, -1, $conf->currency) : null) : '';
  7834. $substitutionarray['__AMOUNT_VAT_FORMATED__'] = is_object($object) ? (isset($object->total_vat) ? price($object->total_vat, 0, $outputlangs, 0, -1, -1, $conf->currency) : ($object->total_tva ? price($object->total_tva, 0, $outputlangs, 0, -1, -1, $conf->currency) : null)) : '';
  7835. if ($onlykey != 2 || $mysoc->useLocalTax(1)) {
  7836. $substitutionarray['__AMOUNT_TAX2_FORMATED__'] = is_object($object) ? ($object->total_localtax1 ? price($object->total_localtax1, 0, $outputlangs, 0, -1, -1, $conf->currency) : null) : '';
  7837. }
  7838. if ($onlykey != 2 || $mysoc->useLocalTax(2)) {
  7839. $substitutionarray['__AMOUNT_TAX3_FORMATED__'] = is_object($object) ? ($object->total_localtax2 ? price($object->total_localtax2, 0, $outputlangs, 0, -1, -1, $conf->currency) : null) : '';
  7840. }
  7841. $substitutionarray['__AMOUNT_MULTICURRENCY__'] = (is_object($object) && isset($object->multicurrency_total_ttc)) ? $object->multicurrency_total_ttc : '';
  7842. $substitutionarray['__AMOUNT_MULTICURRENCY_TEXT__'] = (is_object($object) && isset($object->multicurrency_total_ttc)) ? dol_convertToWord($object->multicurrency_total_ttc, $outputlangs, '', true) : '';
  7843. $substitutionarray['__AMOUNT_MULTICURRENCY_TEXTCURRENCY__'] = (is_object($object) && isset($object->multicurrency_total_ttc)) ? dol_convertToWord($object->multicurrency_total_ttc, $outputlangs, $object->multicurrency_code, true) : '';
  7844. // TODO Add other keys for foreign multicurrency
  7845. // For backward compatibility
  7846. if ($onlykey != 2) {
  7847. $substitutionarray['__TOTAL_TTC__'] = is_object($object) ? $object->total_ttc : '';
  7848. $substitutionarray['__TOTAL_HT__'] = is_object($object) ? $object->total_ht : '';
  7849. $substitutionarray['__TOTAL_VAT__'] = is_object($object) ? (isset($object->total_vat) ? $object->total_vat : $object->total_tva) : '';
  7850. }
  7851. }
  7852. //var_dump($substitutionarray['__AMOUNT_FORMATED__']);
  7853. if ((empty($exclude) || !in_array('date', $exclude)) && (empty($include) || in_array('date', $include))) {
  7854. include_once DOL_DOCUMENT_ROOT.'/core/lib/date.lib.php';
  7855. $now = dol_now();
  7856. $tmp = dol_getdate($now, true);
  7857. $tmp2 = dol_get_prev_day($tmp['mday'], $tmp['mon'], $tmp['year']);
  7858. $tmp3 = dol_get_prev_month($tmp['mon'], $tmp['year']);
  7859. $tmp4 = dol_get_next_day($tmp['mday'], $tmp['mon'], $tmp['year']);
  7860. $tmp5 = dol_get_next_month($tmp['mon'], $tmp['year']);
  7861. $daytext = $outputlangs->trans('Day'.$tmp['wday']);
  7862. $substitutionarray = array_merge($substitutionarray, array(
  7863. '__NOW_TMS__' => (string) $now, // Must be the string that represent the int
  7864. '__NOW_TMS_YMD__' => dol_print_date($now, 'day', 'auto', $outputlangs),
  7865. '__DAY__' => (string) $tmp['mday'],
  7866. '__DAY_TEXT__' => $daytext, // Monday
  7867. '__DAY_TEXT_SHORT__' => dol_trunc($daytext, 3, 'right', 'UTF-8', 1), // Mon
  7868. '__DAY_TEXT_MIN__' => dol_trunc($daytext, 1, 'right', 'UTF-8', 1), // M
  7869. '__MONTH__' => (string) $tmp['mon'],
  7870. '__MONTH_TEXT__' => $outputlangs->trans('Month'.sprintf("%02d", $tmp['mon'])),
  7871. '__MONTH_TEXT_SHORT__' => $outputlangs->trans('MonthShort'.sprintf("%02d", $tmp['mon'])),
  7872. '__MONTH_TEXT_MIN__' => $outputlangs->trans('MonthVeryShort'.sprintf("%02d", $tmp['mon'])),
  7873. '__YEAR__' => (string) $tmp['year'],
  7874. '__PREVIOUS_DAY__' => (string) $tmp2['day'],
  7875. '__PREVIOUS_MONTH__' => (string) $tmp3['month'],
  7876. '__PREVIOUS_YEAR__' => (string) ($tmp['year'] - 1),
  7877. '__NEXT_DAY__' => (string) $tmp4['day'],
  7878. '__NEXT_MONTH__' => (string) $tmp5['month'],
  7879. '__NEXT_MONTH_TEXT__' => $outputlangs->trans('Month'.sprintf("%02d", $tmp5['month'])),
  7880. '__NEXT_MONTH_TEXT_SHORT__' => $outputlangs->trans('MonthShort'.sprintf("%02d", $tmp5['month'])),
  7881. '__NEXT_MONTH_TEXT_MIN__' => $outputlangs->trans('MonthVeryShort'.sprintf("%02d", $tmp5['month'])),
  7882. '__NEXT_YEAR__' => (string) ($tmp['year'] + 1),
  7883. ));
  7884. }
  7885. if (isModEnabled('multicompany')) {
  7886. $substitutionarray = array_merge($substitutionarray, array('__ENTITY_ID__' => $conf->entity));
  7887. }
  7888. if ((empty($exclude) || !in_array('system', $exclude)) && (empty($include) || in_array('user', $include))) {
  7889. $substitutionarray['__DOL_MAIN_URL_ROOT__'] = DOL_MAIN_URL_ROOT;
  7890. $substitutionarray['__(AnyTranslationKey)__'] = $outputlangs->trans('TranslationOfKey');
  7891. $substitutionarray['__(AnyTranslationKey|langfile)__'] = $outputlangs->trans('TranslationOfKey').' (load also language file before)';
  7892. $substitutionarray['__[AnyConstantKey]__'] = $outputlangs->trans('ValueOfConstantKey');
  7893. }
  7894. // Note: The lazyload variables are replaced only during the call by make_substitutions, and only if necessary
  7895. return $substitutionarray;
  7896. }
  7897. /**
  7898. * Make substitution into a text string, replacing keys with vals from $substitutionarray (oldval=>newval),
  7899. * and texts like __(TranslationKey|langfile)__ and __[ConstantKey]__ are also replaced.
  7900. * Example of usage:
  7901. * $substitutionarray = getCommonSubstitutionArray($langs, 0, null, $thirdparty);
  7902. * complete_substitutions_array($substitutionarray, $langs, $thirdparty);
  7903. * $mesg = make_substitutions($mesg, $substitutionarray, $langs);
  7904. *
  7905. * @param string $text Source string in which we must do substitution
  7906. * @param array $substitutionarray Array with key->val to substitute. Example: array('__MYKEY__' => 'MyVal', ...)
  7907. * @param Translate $outputlangs Output language
  7908. * @param int $converttextinhtmlifnecessary 0=Convert only value into HTML if text is already in HTML
  7909. * 1=Will also convert initial $text into HTML if we try to insert one value that is HTML
  7910. * @return string Output string after substitutions
  7911. * @see complete_substitutions_array(), getCommonSubstitutionArray()
  7912. */
  7913. function make_substitutions($text, $substitutionarray, $outputlangs = null, $converttextinhtmlifnecessary = 0)
  7914. {
  7915. global $conf, $db, $langs;
  7916. if (!is_array($substitutionarray)) {
  7917. return 'ErrorBadParameterSubstitutionArrayWhenCalling_make_substitutions';
  7918. }
  7919. if (empty($outputlangs)) {
  7920. $outputlangs = $langs;
  7921. }
  7922. // Is initial text HTML or simple text ?
  7923. $msgishtml = 0;
  7924. if (dol_textishtml($text, 1)) {
  7925. $msgishtml = 1;
  7926. }
  7927. // Make substitution for language keys: __(AnyTranslationKey)__ or __(AnyTranslationKey|langfile)__
  7928. if (is_object($outputlangs)) {
  7929. $reg = array();
  7930. while (preg_match('/__\(([^\)]+)\)__/', $text, $reg)) {
  7931. // If key is __(TranslationKey|langfile)__, then force load of langfile.lang
  7932. $tmp = explode('|', $reg[1]);
  7933. if (!empty($tmp[1])) {
  7934. $outputlangs->load($tmp[1]);
  7935. }
  7936. $value = $outputlangs->transnoentitiesnoconv($reg[1]);
  7937. if (empty($converttextinhtmlifnecessary)) {
  7938. // convert $newval into HTML is necessary
  7939. $text = preg_replace('/__\('.preg_quote($reg[1], '/').'\)__/', $msgishtml ? dol_htmlentitiesbr($value) : $value, $text);
  7940. } else {
  7941. if (! $msgishtml) {
  7942. $valueishtml = dol_textishtml($value, 1);
  7943. //var_dump("valueishtml=".$valueishtml);
  7944. if ($valueishtml) {
  7945. $text = dol_htmlentitiesbr($text);
  7946. $msgishtml = 1;
  7947. }
  7948. } else {
  7949. $value = dol_nl2br("$value");
  7950. }
  7951. $text = preg_replace('/__\('.preg_quote($reg[1], '/').'\)__/', $value, $text);
  7952. }
  7953. }
  7954. }
  7955. // Make substitution for constant keys.
  7956. // Must be after the substitution of translation, so if the text of translation contains a string __[xxx]__, it is also converted.
  7957. $reg = array();
  7958. while (preg_match('/__\[([^\]]+)\]__/', $text, $reg)) {
  7959. $keyfound = $reg[1];
  7960. if (isASecretKey($keyfound)) {
  7961. $value = '*****forbidden*****';
  7962. } else {
  7963. $value = empty($conf->global->$keyfound) ? '' : $conf->global->$keyfound;
  7964. }
  7965. if (empty($converttextinhtmlifnecessary)) {
  7966. // convert $newval into HTML is necessary
  7967. $text = preg_replace('/__\['.preg_quote($keyfound, '/').'\]__/', $msgishtml ? dol_htmlentitiesbr($value) : $value, $text);
  7968. } else {
  7969. if (! $msgishtml) {
  7970. $valueishtml = dol_textishtml($value, 1);
  7971. if ($valueishtml) {
  7972. $text = dol_htmlentitiesbr($text);
  7973. $msgishtml = 1;
  7974. }
  7975. } else {
  7976. $value = dol_nl2br("$value");
  7977. }
  7978. $text = preg_replace('/__\['.preg_quote($keyfound, '/').'\]__/', $value, $text);
  7979. }
  7980. }
  7981. // Make substitution for array $substitutionarray
  7982. foreach ($substitutionarray as $key => $value) {
  7983. if (!isset($value)) {
  7984. continue; // If value is null, it same than not having substitution key at all into array, we do not replace.
  7985. }
  7986. if (($key == '__USER_SIGNATURE__' || $key == '__SENDEREMAIL_SIGNATURE__') && (getDolGlobalString('MAIN_MAIL_DO_NOT_USE_SIGN'))) {
  7987. $value = ''; // Protection
  7988. }
  7989. if (empty($converttextinhtmlifnecessary)) {
  7990. $text = str_replace("$key", "$value", $text); // We must keep the " to work when value is 123.5 for example
  7991. } else {
  7992. if (! $msgishtml) {
  7993. $valueishtml = dol_textishtml($value, 1);
  7994. if ($valueishtml) {
  7995. $text = dol_htmlentitiesbr($text);
  7996. $msgishtml = 1;
  7997. }
  7998. } else {
  7999. $value = dol_nl2br("$value");
  8000. }
  8001. $text = str_replace("$key", "$value", $text); // We must keep the " to work when value is 123.5 for example
  8002. }
  8003. }
  8004. // TODO Implement the lazyload substitution
  8005. /*
  8006. add a loop to scan $substitutionarray:
  8007. For each key ending with '@lazyload', we extract the substitution key 'XXX' and we check inside the $text (the 1st parameter of make_substitutions), if the string XXX exists.
  8008. If no, we don't need to make replacement, so we do nothing.
  8009. If yes, we can make the substitution:
  8010. include_once $path;
  8011. $tmpobj = new $class($db);
  8012. $valuetouseforsubstitution = $tmpobj->$method($id, '__XXX__');
  8013. And make the replacement of "__XXX__@lazyload" with $valuetouseforsubstitution
  8014. */
  8015. $memory_object_list = array();
  8016. foreach ($substitutionarray as $key => $value) {
  8017. $lazy_load_arr = array();
  8018. if (preg_match('/(__[A-Z\_]+__)@lazyload$/', $key, $lazy_load_arr)) {
  8019. if (isset($lazy_load_arr[1]) && !empty($lazy_load_arr[1])) {
  8020. $key_to_substitute = $lazy_load_arr[1];
  8021. if (preg_match('/' . preg_quote($key_to_substitute, '/') . '/', $text)) {
  8022. $param_arr = explode(':', $value);
  8023. // path:class:method:id
  8024. if (count($param_arr) == 4) {
  8025. $path = $param_arr[0];
  8026. $class = $param_arr[1];
  8027. $method = $param_arr[2];
  8028. $id = (int) $param_arr[3];
  8029. // load class file and init object list in memory
  8030. if (!isset($memory_object_list[$class])) {
  8031. if (dol_is_file(DOL_DOCUMENT_ROOT . $path)) {
  8032. require_once DOL_DOCUMENT_ROOT . $path;
  8033. if (class_exists($class)) {
  8034. $memory_object_list[$class] = array(
  8035. 'list' => array(),
  8036. );
  8037. }
  8038. }
  8039. }
  8040. // fetch object and set substitution
  8041. if (isset($memory_object_list[$class]) && isset($memory_object_list[$class]['list'])) {
  8042. if (method_exists($class, $method)) {
  8043. if (!isset($memory_object_list[$class]['list'][$id])) {
  8044. $tmpobj = new $class($db);
  8045. $valuetouseforsubstitution = $tmpobj->$method($id, $key_to_substitute);
  8046. $memory_object_list[$class]['list'][$id] = $tmpobj;
  8047. } else {
  8048. $tmpobj = $memory_object_list[$class]['list'][$id];
  8049. $valuetouseforsubstitution = $tmpobj->$method($id, $key_to_substitute, true);
  8050. }
  8051. $text = str_replace("$key_to_substitute", "$valuetouseforsubstitution", $text); // We must keep the " to work when value is 123.5 for example
  8052. }
  8053. }
  8054. }
  8055. }
  8056. }
  8057. }
  8058. }
  8059. return $text;
  8060. }
  8061. /**
  8062. * Complete the $substitutionarray with more entries coming from external module that had set the "substitutions=1" into module_part array.
  8063. * In this case, method completesubstitutionarray provided by module is called.
  8064. *
  8065. * @param array $substitutionarray Array substitution old value => new value value
  8066. * @param Translate $outputlangs Output language
  8067. * @param Object $object Source object
  8068. * @param mixed $parameters Add more parameters (useful to pass product lines)
  8069. * @param string $callfunc What is the name of the custom function that will be called? (default: completesubstitutionarray)
  8070. * @return void
  8071. * @see make_substitutions()
  8072. */
  8073. function complete_substitutions_array(&$substitutionarray, $outputlangs, $object = null, $parameters = null, $callfunc = "completesubstitutionarray")
  8074. {
  8075. global $conf, $user;
  8076. require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
  8077. // Note: substitution key for each extrafields, using key __EXTRA_XXX__ is already available into the getCommonSubstitutionArray used to build the substitution array.
  8078. // Check if there is external substitution to do, requested by plugins
  8079. $dirsubstitutions = array_merge(array(), (array) $conf->modules_parts['substitutions']);
  8080. foreach ($dirsubstitutions as $reldir) {
  8081. $dir = dol_buildpath($reldir, 0);
  8082. // Check if directory exists
  8083. if (!dol_is_dir($dir)) {
  8084. continue;
  8085. }
  8086. $substitfiles = dol_dir_list($dir, 'files', 0, 'functions_');
  8087. foreach ($substitfiles as $substitfile) {
  8088. $reg = array();
  8089. if (preg_match('/functions_(.*)\.lib\.php/i', $substitfile['name'], $reg)) {
  8090. $module = $reg[1];
  8091. dol_syslog("Library ".$substitfile['name']." found into ".$dir);
  8092. // Include the user's functions file
  8093. require_once $dir.$substitfile['name'];
  8094. // Call the user's function, and only if it is defined
  8095. $function_name = $module."_".$callfunc;
  8096. if (function_exists($function_name)) {
  8097. $function_name($substitutionarray, $outputlangs, $object, $parameters);
  8098. }
  8099. }
  8100. }
  8101. }
  8102. if (getDolGlobalString('ODT_ENABLE_ALL_TAGS_IN_SUBSTITUTIONS')) {
  8103. // to list all tags in odt template
  8104. $tags = '';
  8105. foreach ($substitutionarray as $key => $value) {
  8106. $tags .= '{'.$key.'} => '.$value."\n";
  8107. }
  8108. $substitutionarray = array_merge($substitutionarray, array('__ALL_TAGS__' => $tags));
  8109. }
  8110. }
  8111. /**
  8112. * Format output for start and end date
  8113. *
  8114. * @param int $date_start Start date
  8115. * @param int $date_end End date
  8116. * @param string $format Output format
  8117. * @param Translate $outputlangs Output language
  8118. * @return void
  8119. */
  8120. function print_date_range($date_start, $date_end, $format = '', $outputlangs = '')
  8121. {
  8122. print get_date_range($date_start, $date_end, $format, $outputlangs);
  8123. }
  8124. /**
  8125. * Format output for start and end date
  8126. *
  8127. * @param int $date_start Start date
  8128. * @param int $date_end End date
  8129. * @param string $format Output date format ('day', 'dayhour', ...)
  8130. * @param Translate $outputlangs Output language
  8131. * @param integer $withparenthesis 1=Add parenthesis, 0=no parenthesis
  8132. * @return string String
  8133. */
  8134. function get_date_range($date_start, $date_end, $format = '', $outputlangs = '', $withparenthesis = 1)
  8135. {
  8136. global $langs;
  8137. $out = '';
  8138. if (!is_object($outputlangs)) {
  8139. $outputlangs = $langs;
  8140. }
  8141. if ($date_start && $date_end) {
  8142. $out .= ($withparenthesis ? ' (' : '').$outputlangs->transnoentitiesnoconv('DateFromTo', dol_print_date($date_start, $format, false, $outputlangs), dol_print_date($date_end, $format, false, $outputlangs)).($withparenthesis ? ')' : '');
  8143. }
  8144. if ($date_start && !$date_end) {
  8145. $out .= ($withparenthesis ? ' (' : '').$outputlangs->transnoentitiesnoconv('DateFrom', dol_print_date($date_start, $format, false, $outputlangs)).($withparenthesis ? ')' : '');
  8146. }
  8147. if (!$date_start && $date_end) {
  8148. $out .= ($withparenthesis ? ' (' : '').$outputlangs->transnoentitiesnoconv('DateUntil', dol_print_date($date_end, $format, false, $outputlangs)).($withparenthesis ? ')' : '');
  8149. }
  8150. return $out;
  8151. }
  8152. /**
  8153. * Return firstname and lastname in correct order
  8154. *
  8155. * @param string $firstname Firstname
  8156. * @param string $lastname Lastname
  8157. * @param int $nameorder -1=Auto, 0=Lastname+Firstname, 1=Firstname+Lastname, 2=Firstname, 3=Firstname if defined else lastname, 4=Lastname, 5=Lastname if defined else firstname
  8158. * @return string Firstname + lastname or Lastname + firstname
  8159. */
  8160. function dolGetFirstLastname($firstname, $lastname, $nameorder = -1)
  8161. {
  8162. global $conf;
  8163. $ret = '';
  8164. // If order not defined, we use the setup
  8165. if ($nameorder < 0) {
  8166. $nameorder = (!getDolGlobalString('MAIN_FIRSTNAME_NAME_POSITION') ? 1 : 0);
  8167. }
  8168. if ($nameorder == 1) {
  8169. $ret .= $firstname;
  8170. if ($firstname && $lastname) {
  8171. $ret .= ' ';
  8172. }
  8173. $ret .= $lastname;
  8174. } elseif ($nameorder == 2 || $nameorder == 3) {
  8175. $ret .= $firstname;
  8176. if (empty($ret) && $nameorder == 3) {
  8177. $ret .= $lastname;
  8178. }
  8179. } else { // 0, 4 or 5
  8180. $ret .= $lastname;
  8181. if (empty($ret) && $nameorder == 5) {
  8182. $ret .= $firstname;
  8183. }
  8184. if ($nameorder == 0) {
  8185. if ($firstname && $lastname) {
  8186. $ret .= ' ';
  8187. }
  8188. $ret .= $firstname;
  8189. }
  8190. }
  8191. return $ret;
  8192. }
  8193. /**
  8194. * Set event message in dol_events session object. Will be output by calling dol_htmloutput_events.
  8195. * Note: Calling dol_htmloutput_events is done into pages by standard llxFooter() function.
  8196. * Note: Prefer to use setEventMessages instead.
  8197. *
  8198. * @param string|string[] $mesgs Message string or array
  8199. * @param string $style Which style to use ('mesgs' by default, 'warnings', 'errors')
  8200. * @param int $noduplicate 1 means we do not add the message if already present in session stack
  8201. * @return void
  8202. * @see dol_htmloutput_events()
  8203. */
  8204. function setEventMessage($mesgs, $style = 'mesgs', $noduplicate = 0)
  8205. {
  8206. //dol_syslog(__FUNCTION__ . " is deprecated", LOG_WARNING); This is not deprecated, it is used by setEventMessages function
  8207. if (!is_array($mesgs)) {
  8208. $mesgs = trim((string) $mesgs);
  8209. // If mesgs is a not an empty string
  8210. if ($mesgs) {
  8211. if (!empty($noduplicate) && isset($_SESSION['dol_events'][$style]) && in_array($mesgs, $_SESSION['dol_events'][$style])) {
  8212. return;
  8213. }
  8214. $_SESSION['dol_events'][$style][] = $mesgs;
  8215. }
  8216. } else {
  8217. // If mesgs is an array
  8218. foreach ($mesgs as $mesg) {
  8219. $mesg = trim((string) $mesg);
  8220. if ($mesg) {
  8221. if (!empty($noduplicate) && isset($_SESSION['dol_events'][$style]) && in_array($mesg, $_SESSION['dol_events'][$style])) {
  8222. return;
  8223. }
  8224. $_SESSION['dol_events'][$style][] = $mesg;
  8225. }
  8226. }
  8227. }
  8228. }
  8229. /**
  8230. * Set event messages in dol_events session object. Will be output by calling dol_htmloutput_events.
  8231. * Note: Calling dol_htmloutput_events is done into pages by standard llxFooter() function.
  8232. *
  8233. * @param string $mesg Message string
  8234. * @param array|null $mesgs Message array
  8235. * @param string $style Which style to use ('mesgs' by default, 'warnings', 'errors')
  8236. * @param string $messagekey A key to be used to allow the feature "Never show this message again"
  8237. * @param int $noduplicate 1 means we do not add the message if already present in session stack
  8238. * @return void
  8239. * @see dol_htmloutput_events()
  8240. */
  8241. function setEventMessages($mesg, $mesgs, $style = 'mesgs', $messagekey = '', $noduplicate = 0)
  8242. {
  8243. if (empty($mesg) && empty($mesgs)) {
  8244. dol_syslog("Try to add a message in stack, but value to add is empty message", LOG_WARNING);
  8245. } else {
  8246. if ($messagekey) {
  8247. // Complete message with a js link to set a cookie "DOLHIDEMESSAGE".$messagekey;
  8248. // TODO
  8249. $mesg .= '';
  8250. }
  8251. if (empty($messagekey) || empty($_COOKIE["DOLHIDEMESSAGE".$messagekey])) {
  8252. if (!in_array((string) $style, array('mesgs', 'warnings', 'errors'))) {
  8253. dol_print_error('', 'Bad parameter style='.$style.' for setEventMessages');
  8254. }
  8255. if (empty($mesgs)) {
  8256. setEventMessage($mesg, $style, $noduplicate);
  8257. } else {
  8258. if (!empty($mesg) && !in_array($mesg, $mesgs)) {
  8259. setEventMessage($mesg, $style, $noduplicate); // Add message string if not already into array
  8260. }
  8261. setEventMessage($mesgs, $style, $noduplicate);
  8262. }
  8263. }
  8264. }
  8265. }
  8266. /**
  8267. * Print formated messages to output (Used to show messages on html output).
  8268. * Note: Calling dol_htmloutput_events is done into pages by standard llxFooter() function, so there is
  8269. * no need to call it explicitely.
  8270. *
  8271. * @param int $disabledoutputofmessages Clear all messages stored into session without diplaying them
  8272. * @return void
  8273. * @see dol_htmloutput_mesg()
  8274. */
  8275. function dol_htmloutput_events($disabledoutputofmessages = 0)
  8276. {
  8277. // Show mesgs
  8278. if (isset($_SESSION['dol_events']['mesgs'])) {
  8279. if (empty($disabledoutputofmessages)) {
  8280. dol_htmloutput_mesg('', $_SESSION['dol_events']['mesgs']);
  8281. }
  8282. unset($_SESSION['dol_events']['mesgs']);
  8283. }
  8284. // Show errors
  8285. if (isset($_SESSION['dol_events']['errors'])) {
  8286. if (empty($disabledoutputofmessages)) {
  8287. dol_htmloutput_mesg('', $_SESSION['dol_events']['errors'], 'error');
  8288. }
  8289. unset($_SESSION['dol_events']['errors']);
  8290. }
  8291. // Show warnings
  8292. if (isset($_SESSION['dol_events']['warnings'])) {
  8293. if (empty($disabledoutputofmessages)) {
  8294. dol_htmloutput_mesg('', $_SESSION['dol_events']['warnings'], 'warning');
  8295. }
  8296. unset($_SESSION['dol_events']['warnings']);
  8297. }
  8298. }
  8299. /**
  8300. * Get formated messages to output (Used to show messages on html output).
  8301. * This include also the translation of the message key.
  8302. *
  8303. * @param string $mesgstring Message string or message key
  8304. * @param string[] $mesgarray Array of message strings or message keys
  8305. * @param string $style Style of message output ('ok' or 'error')
  8306. * @param int $keepembedded Set to 1 in error message must be kept embedded into its html place (this disable jnotify)
  8307. * @return string Return html output
  8308. *
  8309. * @see dol_print_error()
  8310. * @see dol_htmloutput_errors()
  8311. * @see setEventMessages()
  8312. */
  8313. function get_htmloutput_mesg($mesgstring = '', $mesgarray = '', $style = 'ok', $keepembedded = 0)
  8314. {
  8315. global $conf, $langs;
  8316. $ret = 0;
  8317. $return = '';
  8318. $out = '';
  8319. $divstart = $divend = '';
  8320. // If inline message with no format, we add it.
  8321. if ((empty($conf->use_javascript_ajax) || getDolGlobalString('MAIN_DISABLE_JQUERY_JNOTIFY') || $keepembedded) && !preg_match('/<div class=".*">/i', $out)) {
  8322. $divstart = '<div class="'.$style.' clearboth">';
  8323. $divend = '</div>';
  8324. }
  8325. if ((is_array($mesgarray) && count($mesgarray)) || $mesgstring) {
  8326. $langs->load("errors");
  8327. $out .= $divstart;
  8328. if (is_array($mesgarray) && count($mesgarray)) {
  8329. foreach ($mesgarray as $message) {
  8330. $ret++;
  8331. $out .= $langs->trans($message);
  8332. if ($ret < count($mesgarray)) {
  8333. $out .= "<br>\n";
  8334. }
  8335. }
  8336. }
  8337. if ($mesgstring) {
  8338. $ret++;
  8339. $out .= $langs->trans($mesgstring);
  8340. }
  8341. $out .= $divend;
  8342. }
  8343. if ($out) {
  8344. if (!empty($conf->use_javascript_ajax) && !getDolGlobalString('MAIN_DISABLE_JQUERY_JNOTIFY') && empty($keepembedded)) {
  8345. $return = '<script nonce="'.getNonce().'">
  8346. $(document).ready(function() {
  8347. var block = '.(getDolGlobalString('MAIN_USE_JQUERY_BLOCKUI') ? "true" : "false").'
  8348. if (block) {
  8349. $.dolEventValid("","'.dol_escape_js($out).'");
  8350. } else {
  8351. /* jnotify(message, preset of message type, keepmessage) */
  8352. $.jnotify("'.dol_escape_js($out).'",
  8353. "'.($style == "ok" ? 3000 : $style).'",
  8354. '.($style == "ok" ? "false" : "true").',
  8355. { remove: function (){} } );
  8356. }
  8357. });
  8358. </script>';
  8359. } else {
  8360. $return = $out;
  8361. }
  8362. }
  8363. return $return;
  8364. }
  8365. /**
  8366. * Get formated error messages to output (Used to show messages on html output).
  8367. *
  8368. * @param string $mesgstring Error message
  8369. * @param array $mesgarray Error messages array
  8370. * @param int $keepembedded Set to 1 in error message must be kept embedded into its html place (this disable jnotify)
  8371. * @return string Return html output
  8372. *
  8373. * @see dol_print_error()
  8374. * @see dol_htmloutput_mesg()
  8375. */
  8376. function get_htmloutput_errors($mesgstring = '', $mesgarray = array(), $keepembedded = 0)
  8377. {
  8378. return get_htmloutput_mesg($mesgstring, $mesgarray, 'error', $keepembedded);
  8379. }
  8380. /**
  8381. * Print formated messages to output (Used to show messages on html output).
  8382. *
  8383. * @param string $mesgstring Message string or message key
  8384. * @param string[] $mesgarray Array of message strings or message keys
  8385. * @param string $style Which style to use ('ok', 'warning', 'error')
  8386. * @param int $keepembedded Set to 1 if message must be kept embedded into its html place (this disable jnotify)
  8387. * @return void
  8388. *
  8389. * @see dol_print_error()
  8390. * @see dol_htmloutput_errors()
  8391. * @see setEventMessages()
  8392. */
  8393. function dol_htmloutput_mesg($mesgstring = '', $mesgarray = array(), $style = 'ok', $keepembedded = 0)
  8394. {
  8395. if (empty($mesgstring) && (!is_array($mesgarray) || count($mesgarray) == 0)) {
  8396. return;
  8397. }
  8398. $iserror = 0;
  8399. $iswarning = 0;
  8400. if (is_array($mesgarray)) {
  8401. foreach ($mesgarray as $val) {
  8402. if ($val && preg_match('/class="error"/i', $val)) {
  8403. $iserror++;
  8404. break;
  8405. }
  8406. if ($val && preg_match('/class="warning"/i', $val)) {
  8407. $iswarning++;
  8408. break;
  8409. }
  8410. }
  8411. } elseif ($mesgstring && preg_match('/class="error"/i', $mesgstring)) {
  8412. $iserror++;
  8413. } elseif ($mesgstring && preg_match('/class="warning"/i', $mesgstring)) {
  8414. $iswarning++;
  8415. }
  8416. if ($style == 'error') {
  8417. $iserror++;
  8418. }
  8419. if ($style == 'warning') {
  8420. $iswarning++;
  8421. }
  8422. if ($iserror || $iswarning) {
  8423. // Remove div from texts
  8424. $mesgstring = preg_replace('/<\/div><div class="(error|warning)">/', '<br>', $mesgstring);
  8425. $mesgstring = preg_replace('/<div class="(error|warning)">/', '', $mesgstring);
  8426. $mesgstring = preg_replace('/<\/div>/', '', $mesgstring);
  8427. // Remove div from texts array
  8428. if (is_array($mesgarray)) {
  8429. $newmesgarray = array();
  8430. foreach ($mesgarray as $val) {
  8431. if (is_string($val)) {
  8432. $tmpmesgstring = preg_replace('/<\/div><div class="(error|warning)">/', '<br>', $val);
  8433. $tmpmesgstring = preg_replace('/<div class="(error|warning)">/', '', $tmpmesgstring);
  8434. $tmpmesgstring = preg_replace('/<\/div>/', '', $tmpmesgstring);
  8435. $newmesgarray[] = $tmpmesgstring;
  8436. } else {
  8437. dol_syslog("Error call of dol_htmloutput_mesg with an array with a value that is not a string", LOG_WARNING);
  8438. }
  8439. }
  8440. $mesgarray = $newmesgarray;
  8441. }
  8442. print get_htmloutput_mesg($mesgstring, $mesgarray, ($iserror ? 'error' : 'warning'), $keepembedded);
  8443. } else {
  8444. print get_htmloutput_mesg($mesgstring, $mesgarray, 'ok', $keepembedded);
  8445. }
  8446. }
  8447. /**
  8448. * Print formated error messages to output (Used to show messages on html output).
  8449. *
  8450. * @param string $mesgstring Error message
  8451. * @param array $mesgarray Error messages array
  8452. * @param int $keepembedded Set to 1 in error message must be kept embedded into its html place (this disable jnotify)
  8453. * @return void
  8454. *
  8455. * @see dol_print_error()
  8456. * @see dol_htmloutput_mesg()
  8457. */
  8458. function dol_htmloutput_errors($mesgstring = '', $mesgarray = array(), $keepembedded = 0)
  8459. {
  8460. dol_htmloutput_mesg($mesgstring, $mesgarray, 'error', $keepembedded);
  8461. }
  8462. /**
  8463. * Advanced sort array by second index function, which produces ascending (default)
  8464. * or descending output and uses optionally natural case insensitive sorting (which
  8465. * can be optionally case sensitive as well).
  8466. *
  8467. * @param array $array Array to sort (array of array('key1'=>val1,'key2'=>val2,'key3'...) or array of objects)
  8468. * @param string $index Key in array to use for sorting criteria
  8469. * @param int $order Sort order ('asc' or 'desc')
  8470. * @param int $natsort If values are strings (I said value not type): 0=Use alphabetical order, 1=use "natural" sort (natsort)
  8471. * If values are numeric (I said value not type): 0=Use numeric order (even if type is string) so use a "natural" sort, 1=use "natural" sort too (same than 0), -1=Force alphabetical order
  8472. * @param int $case_sensitive 1=sort is case sensitive, 0=not case sensitive
  8473. * @param int $keepindex If 0 and index key of array to sort is a numeric, than index will be rewrote. If 1 or index key is not numeric, key for index is kept after sorting.
  8474. * @return array Sorted array
  8475. */
  8476. function dol_sort_array(&$array, $index, $order = 'asc', $natsort = 0, $case_sensitive = 0, $keepindex = 0)
  8477. {
  8478. // Clean parameters
  8479. $order = strtolower($order);
  8480. if (is_array($array)) {
  8481. $sizearray = count($array);
  8482. if ($sizearray > 0) {
  8483. $temp = array();
  8484. foreach (array_keys($array) as $key) {
  8485. if (is_object($array[$key])) {
  8486. $temp[$key] = empty($array[$key]->$index) ? 0 : $array[$key]->$index;
  8487. } else {
  8488. $temp[$key] = empty($array[$key][$index]) ? 0 : $array[$key][$index];
  8489. }
  8490. if ($natsort == -1) {
  8491. $temp[$key] = '___'.$temp[$key]; // We add a string at begin of value to force an alpha order when using asort.
  8492. }
  8493. }
  8494. if (empty($natsort) || $natsort == -1) {
  8495. if ($order == 'asc') {
  8496. asort($temp);
  8497. } else {
  8498. arsort($temp);
  8499. }
  8500. } else {
  8501. if ($case_sensitive) {
  8502. natsort($temp);
  8503. } else {
  8504. natcasesort($temp); // natecasesort is not sensible to case
  8505. }
  8506. if ($order != 'asc') {
  8507. $temp = array_reverse($temp, true);
  8508. }
  8509. }
  8510. $sorted = array();
  8511. foreach (array_keys($temp) as $key) {
  8512. (is_numeric($key) && empty($keepindex)) ? $sorted[] = $array[$key] : $sorted[$key] = $array[$key];
  8513. }
  8514. return $sorted;
  8515. }
  8516. }
  8517. return $array;
  8518. }
  8519. /**
  8520. * Check if a string is in UTF8. Seems similar to utf8_valid() but in pure PHP.
  8521. *
  8522. * @param string $str String to check
  8523. * @return boolean True if string is UTF8 or ISO compatible with UTF8, False if not (ISO with special non utf8 char or Binary)
  8524. * @see utf8_valid()
  8525. */
  8526. function utf8_check($str)
  8527. {
  8528. $str = (string) $str; // Sometimes string is an int.
  8529. // We must use here a binary strlen function (so not dol_strlen)
  8530. $strLength = strlen($str);
  8531. for ($i = 0; $i < $strLength; $i++) {
  8532. if (ord($str[$i]) < 0x80) {
  8533. continue; // 0bbbbbbb
  8534. } elseif ((ord($str[$i]) & 0xE0) == 0xC0) {
  8535. $n = 1; // 110bbbbb
  8536. } elseif ((ord($str[$i]) & 0xF0) == 0xE0) {
  8537. $n = 2; // 1110bbbb
  8538. } elseif ((ord($str[$i]) & 0xF8) == 0xF0) {
  8539. $n = 3; // 11110bbb
  8540. } elseif ((ord($str[$i]) & 0xFC) == 0xF8) {
  8541. $n = 4; // 111110bb
  8542. } elseif ((ord($str[$i]) & 0xFE) == 0xFC) {
  8543. $n = 5; // 1111110b
  8544. } else {
  8545. return false; // Does not match any model
  8546. }
  8547. for ($j = 0; $j < $n; $j++) { // n bytes matching 10bbbbbb follow ?
  8548. if ((++$i == strlen($str)) || ((ord($str[$i]) & 0xC0) != 0x80)) {
  8549. return false;
  8550. }
  8551. }
  8552. }
  8553. return true;
  8554. }
  8555. /**
  8556. * Check if a string is in UTF8. Seems similar to utf8_check().
  8557. *
  8558. * @param string $str String to check
  8559. * @return boolean True if string is valid UTF8 string, false if corrupted
  8560. * @see utf8_check()
  8561. */
  8562. function utf8_valid($str)
  8563. {
  8564. /* 2 other methods to test if string is utf8
  8565. $validUTF8 = mb_check_encoding($messagetext, 'UTF-8');
  8566. $validUTF8b = ! (false === mb_detect_encoding($messagetext, 'UTF-8', true));
  8567. */
  8568. return preg_match('//u', $str) ? true : false;
  8569. }
  8570. /**
  8571. * Check if a string is in ASCII
  8572. *
  8573. * @param string $str String to check
  8574. * @return boolean True if string is ASCII, False if not (byte value > 0x7F)
  8575. */
  8576. function ascii_check($str)
  8577. {
  8578. if (function_exists('mb_check_encoding')) {
  8579. //if (mb_detect_encoding($str, 'ASCII', true) return false;
  8580. if (!mb_check_encoding($str, 'ASCII')) {
  8581. return false;
  8582. }
  8583. } else {
  8584. if (preg_match('/[^\x00-\x7f]/', $str)) {
  8585. return false; // Contains a byte > 7f
  8586. }
  8587. }
  8588. return true;
  8589. }
  8590. /**
  8591. * Return a string encoded into OS filesystem encoding. This function is used to define
  8592. * value to pass to filesystem PHP functions.
  8593. *
  8594. * @param string $str String to encode (UTF-8)
  8595. * @return string Encoded string (UTF-8, ISO-8859-1)
  8596. */
  8597. function dol_osencode($str)
  8598. {
  8599. global $conf;
  8600. $tmp = ini_get("unicode.filesystem_encoding"); // Disponible avec PHP 6.0
  8601. if (empty($tmp) && !empty($_SERVER["WINDIR"])) {
  8602. $tmp = 'iso-8859-1'; // By default for windows
  8603. }
  8604. if (empty($tmp)) {
  8605. $tmp = 'utf-8'; // By default for other
  8606. }
  8607. if (getDolGlobalString('MAIN_FILESYSTEM_ENCODING')) {
  8608. $tmp = $conf->global->MAIN_FILESYSTEM_ENCODING;
  8609. }
  8610. if ($tmp == 'iso-8859-1') {
  8611. return mb_convert_encoding($str, 'ISO-8859-1', 'UTF-8');
  8612. }
  8613. return $str;
  8614. }
  8615. /**
  8616. * Return an id or code from a code or id.
  8617. * Store also Code-Id into a cache to speed up next request on same key.
  8618. *
  8619. * @param DoliDB $db Database handler
  8620. * @param string $key Code or Id to get Id or Code
  8621. * @param string $tablename Table name without prefix
  8622. * @param string $fieldkey Field to search the key into
  8623. * @param string $fieldid Field to get
  8624. * @param int $entityfilter Filter by entity
  8625. * @param string $filters Filters to add. WARNING: string must be escaped for SQL and not coming from user input.
  8626. * @return int Return integer <0 if KO, Id of code if OK
  8627. * @see $langs->getLabelFromKey
  8628. */
  8629. function dol_getIdFromCode($db, $key, $tablename, $fieldkey = 'code', $fieldid = 'id', $entityfilter = 0, $filters = '')
  8630. {
  8631. global $cache_codes;
  8632. // If key empty
  8633. if ($key == '') {
  8634. return '';
  8635. }
  8636. // Check in cache
  8637. if (isset($cache_codes[$tablename][$key][$fieldid])) { // Can be defined to 0 or ''
  8638. return $cache_codes[$tablename][$key][$fieldid]; // Found in cache
  8639. }
  8640. dol_syslog('dol_getIdFromCode (value for field '.$fieldid.' from key '.$key.' not found into cache)', LOG_DEBUG);
  8641. $sql = "SELECT ".$fieldid." as valuetoget";
  8642. $sql .= " FROM ".MAIN_DB_PREFIX.$tablename;
  8643. $sql .= " WHERE ".$fieldkey." = '".$db->escape($key)."'";
  8644. if (!empty($entityfilter)) {
  8645. $sql .= " AND entity IN (".getEntity($tablename).")";
  8646. }
  8647. if ($filters) {
  8648. $sql .= $filters;
  8649. }
  8650. $resql = $db->query($sql);
  8651. if ($resql) {
  8652. $obj = $db->fetch_object($resql);
  8653. if ($obj) {
  8654. $cache_codes[$tablename][$key][$fieldid] = $obj->valuetoget;
  8655. } else {
  8656. $cache_codes[$tablename][$key][$fieldid] = '';
  8657. }
  8658. $db->free($resql);
  8659. return $cache_codes[$tablename][$key][$fieldid];
  8660. } else {
  8661. return -1;
  8662. }
  8663. }
  8664. /**
  8665. * Check if a variable with name $var start with $text.
  8666. * Can be used to forge dol_eval() conditions.
  8667. *
  8668. * @param $var string Variable
  8669. * @param $regextext string Text that must be a valid regex string
  8670. * @param $matchrule int 1=Test if start with, 0=Test if equal
  8671. * @return boolean|string True or False, text if bad use.
  8672. */
  8673. function isStringVarMatching($var, $regextext, $matchrule = 1)
  8674. {
  8675. if ($matchrule == 1) {
  8676. if ($var == 'mainmenu') {
  8677. global $mainmenu;
  8678. return (preg_match('/^'.$regextext.'/', $mainmenu));
  8679. } elseif ($var == 'leftmenu') {
  8680. global $leftmenu;
  8681. return (preg_match('/^'.$regextext.'/', $leftmenu));
  8682. } else {
  8683. return 'This variable is not accessible with dol_eval';
  8684. }
  8685. } else {
  8686. return 'This value for matchrule is not implemented';
  8687. }
  8688. }
  8689. /**
  8690. * Verify if condition in string is ok or not
  8691. *
  8692. * @param string $strToEvaluate String with condition to check
  8693. * @return boolean True or False. Note: It returns also True if $strToEvaluate is ''. False if error
  8694. */
  8695. function verifCond($strToEvaluate)
  8696. {
  8697. //print $strToEvaluate."<br>\n";
  8698. $rights = true;
  8699. if (isset($strToEvaluate) && $strToEvaluate !== '') {
  8700. //var_dump($strToEvaluate);
  8701. //$rep = dol_eval($strToEvaluate, 1, 0, '1'); // to show the error
  8702. $rep = dol_eval($strToEvaluate, 1, 1, '1'); // The dol_eval() must contains all the "global $xxx;" for all variables $xxx found into the string condition
  8703. $rights = $rep && (!is_string($rep) || strpos($rep, 'Bad string syntax to evaluate') === false);
  8704. //var_dump($rights);
  8705. }
  8706. return $rights;
  8707. }
  8708. /**
  8709. * Replace eval function to add more security.
  8710. * This function is called by verifCond() or trans() and transnoentitiesnoconv().
  8711. *
  8712. * @param string $s String to evaluate
  8713. * @param int $returnvalue 0=No return (used to execute eval($a=something)). 1=Value of eval is returned (used to eval($something)).
  8714. * @param int $hideerrors 1=Hide errors
  8715. * @param string $onlysimplestring '0' (deprecated, used for computed property of extrafields)=Accept all chars,
  8716. * '1' (most common use)=Accept only simple string with char 'a-z0-9\s^$_+-.*>&|=!?():"\',/@';',
  8717. * '2' (rarely used)=Accept also '[]'
  8718. * @return mixed Nothing or return result of eval
  8719. * @see verifCond()
  8720. */
  8721. function dol_eval($s, $returnvalue = 0, $hideerrors = 1, $onlysimplestring = '1')
  8722. {
  8723. // Only this global variables can be read by eval function and returned to caller
  8724. global $conf; // Read of const is done with getDolGlobalString() but we need $conf->currency for example
  8725. global $db, $langs, $user, $website, $websitepage;
  8726. global $action, $mainmenu, $leftmenu;
  8727. global $mysoc;
  8728. global $objectoffield; // To allow the use of $objectoffield in computed fields
  8729. // Old variables used
  8730. global $object;
  8731. global $obj; // To get $obj used into list when dol_eval() is used for computed fields and $obj is not yet $object
  8732. if (!in_array($onlysimplestring, array('0', '1', '2'))) {
  8733. return "Bad call of dol_eval. Parameter onlysimplestring must be '0' (deprecated), '1' or '2'";
  8734. }
  8735. try {
  8736. // Test on dangerous char (used for RCE), we allow only characters to make PHP variable testing
  8737. if ($onlysimplestring == '1') {
  8738. // We must accept: '1 && getDolGlobalInt("doesnotexist1") && getDolGlobalString("MAIN_FEATURES_LEVEL")'
  8739. // We must accept: '$user->hasRight("cabinetmed", "read") && !$object->canvas=="patient@cabinetmed"'
  8740. $specialcharsallowed = '^$_+-.*>&|=!?():"\',/@';
  8741. if (getDolGlobalString('MAIN_ALLOW_UNSECURED_SPECIAL_CHARS_IN_DOL_EVAL')) {
  8742. $specialcharsallowed .= getDolGlobalString('MAIN_ALLOW_UNSECURED_SPECIAL_CHARS_IN_DOL_EVAL');
  8743. }
  8744. if (preg_match('/[^a-z0-9\s'.preg_quote($specialcharsallowed, '/').']/i', $s)) {
  8745. if ($returnvalue) {
  8746. return 'Bad string syntax to evaluate (found chars that are not chars for simplestring): '.$s;
  8747. } else {
  8748. dol_syslog('Bad string syntax to evaluate (found chars that are not chars for simplestring): '.$s);
  8749. return '';
  8750. }
  8751. }
  8752. $savescheck = '';
  8753. $scheck = $s;
  8754. while ($scheck && $savescheck != $scheck) {
  8755. $savescheck = $scheck;
  8756. $scheck = preg_replace('/->[a-zA-Z0-9_]+\(/', '->__METHOD__', $scheck); // accept parenthesis in '...->method(...'
  8757. $scheck = preg_replace('/^\(/', '__PARENTHESIS__ ', $scheck); // accept parenthesis in '(...'. Must replace with __PARENTHESIS__ with a space after to allow following substitutions
  8758. $scheck = preg_replace('/\s\(/', '__PARENTHESIS__ ', $scheck); // accept parenthesis in '... ('. Must replace with __PARENTHESIS__ with a space after to allow following substitutions
  8759. $scheck = preg_replace('/^!?[a-zA-Z0-9_]+\(/', '__FUNCTION__', $scheck); // accept parenthesis in 'function(' and '!function('
  8760. $scheck = preg_replace('/\s!?[a-zA-Z0-9_]+\(/', '__FUNCTION__', $scheck); // accept parenthesis in '... function(' and '... !function('
  8761. $scheck = preg_replace('/(\^|\')\(/', '__REGEXSTART__', $scheck); // To allow preg_match('/^(aaa|bbb)/'... or isStringVarMatching('leftmenu', '(aaa|bbb)')
  8762. }
  8763. //print 'scheck='.$scheck." : ".strpos($scheck, '(')."<br>\n";
  8764. if (strpos($scheck, '(') !== false) {
  8765. if ($returnvalue) {
  8766. return 'Bad string syntax to evaluate (mode 1, found call of a function or method without using the direct name of the function): '.$s;
  8767. } else {
  8768. dol_syslog('Bad string syntax to evaluate (mode 1, found call of a function or method without using the direct name of the function): '.$s);
  8769. return '';
  8770. }
  8771. }
  8772. // TODO
  8773. // We can exclude $ char that are not: $db, $langs, $leftmenu, $topmenu, $user, $langs, $objectoffield, $object...,
  8774. } elseif ($onlysimplestring == '2') {
  8775. // We must accept: (($reloadedobj = new Task($db)) && ($reloadedobj->fetchNoCompute($object->id) > 0) && ($secondloadedobj = new Project($db)) && ($secondloadedobj->fetchNoCompute($reloadedobj->fk_project) > 0)) ? $secondloadedobj->ref : "Parent project not found"
  8776. $specialcharsallowed = '^$_+-.*>&|=!?():"\',/@[]';
  8777. if (getDolGlobalString('MAIN_ALLOW_UNSECURED_SPECIAL_CHARS_IN_DOL_EVAL')) {
  8778. $specialcharsallowed .= getDolGlobalString('MAIN_ALLOW_UNSECURED_SPECIAL_CHARS_IN_DOL_EVAL');
  8779. }
  8780. if (preg_match('/[^a-z0-9\s'.preg_quote($specialcharsallowed, '/').']/i', $s)) {
  8781. if ($returnvalue) {
  8782. return 'Bad string syntax to evaluate (found chars that are not chars for simplestring): '.$s;
  8783. } else {
  8784. dol_syslog('Bad string syntax to evaluate (found chars that are not chars for simplestring): '.$s);
  8785. return '';
  8786. }
  8787. }
  8788. $savescheck = '';
  8789. $scheck = $s;
  8790. while ($scheck && $savescheck != $scheck) {
  8791. $savescheck = $scheck;
  8792. $scheck = preg_replace('/->[a-zA-Z0-9_]+\(/', '->__METHOD__', $scheck); // accept parenthesis in '...->method(...'
  8793. $scheck = preg_replace('/^\(/', '__PARENTHESIS__ ', $scheck); // accept parenthesis in '(...'. Must replace with __PARENTHESIS__ with a space after to allow following substitutions
  8794. $scheck = preg_replace('/\s\(/', '__PARENTHESIS__ ', $scheck); // accept parenthesis in '... ('. Must replace with __PARENTHESIS__ with a space after to allow following substitutions
  8795. $scheck = preg_replace('/^!?[a-zA-Z0-9_]+\(/', '__FUNCTION__', $scheck); // accept parenthesis in 'function(' and '!function('
  8796. $scheck = preg_replace('/\s!?[a-zA-Z0-9_]+\(/', '__FUNCTION__', $scheck); // accept parenthesis in '... function(' and '... !function('
  8797. $scheck = preg_replace('/(\^|\')\(/', '__REGEXSTART__', $scheck); // To allow preg_match('/^(aaa|bbb)/'... or isStringVarMatching('leftmenu', '(aaa|bbb)')
  8798. }
  8799. //print 'scheck='.$scheck." : ".strpos($scheck, '(')."<br>\n";
  8800. if (strpos($scheck, '(') !== false) {
  8801. if ($returnvalue) {
  8802. return 'Bad string syntax to evaluate (mode 2, found call of a function or method without using the direct name of the function): '.$s;
  8803. } else {
  8804. dol_syslog('Bad string syntax to evaluate (mode 2, found call of a function or method without using the direct name of the function): '.$s);
  8805. return '';
  8806. }
  8807. }
  8808. // TODO
  8809. // We can exclude $ char that are not: $db, $leftmenu, $topmenu, $user, $langs, $object...,
  8810. }
  8811. if (is_array($s) || $s === 'Array') {
  8812. return 'Bad string syntax to evaluate (value is Array) '.var_export($s, true);
  8813. }
  8814. if (strpos($s, '::') !== false) {
  8815. if ($returnvalue) {
  8816. return 'Bad string syntax to evaluate (double : char is forbidden): '.$s;
  8817. } else {
  8818. dol_syslog('Bad string syntax to evaluate (double : char is forbidden): '.$s);
  8819. return '';
  8820. }
  8821. }
  8822. if (strpos($s, '`') !== false) {
  8823. if ($returnvalue) {
  8824. return 'Bad string syntax to evaluate (backtick char is forbidden): '.$s;
  8825. } else {
  8826. dol_syslog('Bad string syntax to evaluate (backtick char is forbidden): '.$s);
  8827. return '';
  8828. }
  8829. }
  8830. if (preg_match('/[^0-9]+\.[^0-9]+/', $s)) { // We refuse . if not between 2 numbers
  8831. if ($returnvalue) {
  8832. return 'Bad string syntax to evaluate (dot char is forbidden): '.$s;
  8833. } else {
  8834. dol_syslog('Bad string syntax to evaluate (dot char is forbidden): '.$s);
  8835. return '';
  8836. }
  8837. }
  8838. // We block use of php exec or php file functions
  8839. $forbiddenphpstrings = array('$$');
  8840. $forbiddenphpstrings = array_merge($forbiddenphpstrings, array('_ENV', '_SESSION', '_COOKIE', '_GET', '_POST', '_REQUEST', 'ReflectionFunction'));
  8841. $forbiddenphpfunctions = array("exec", "passthru", "shell_exec", "system", "proc_open", "popen");
  8842. $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("dol_eval", "executeCLI", "verifCond")); // native dolibarr functions
  8843. $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("base64_decode", "rawurldecode", "urldecode", "str_rot13", "hex2bin")); // decode string functions used to obfuscated function name
  8844. $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("fopen", "file_put_contents", "fputs", "fputscsv", "fwrite", "fpassthru", "require", "include", "mkdir", "rmdir", "symlink", "touch", "unlink", "umask"));
  8845. $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("get_defined_functions", "get_defined_vars", "get_defined_constants", "get_declared_classes"));
  8846. $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("function", "call_user_func"));
  8847. $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("require", "include", "require_once", "include_once"));
  8848. $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("eval", "create_function", "assert", "mb_ereg_replace")); // function with eval capabilities
  8849. $forbiddenphpmethods = array('invoke', 'invokeArgs'); // Method of ReflectionFunction to execute a function
  8850. $forbiddenphpregex = 'global\s+\$|\b('.implode('|', $forbiddenphpfunctions).')\b';
  8851. $forbiddenphpmethodsregex = '->('.implode('|', $forbiddenphpmethods).')';
  8852. do {
  8853. $oldstringtoclean = $s;
  8854. $s = str_ireplace($forbiddenphpstrings, '__forbiddenstring__', $s);
  8855. $s = preg_replace('/'.$forbiddenphpregex.'/i', '__forbiddenstring__', $s);
  8856. $s = preg_replace('/'.$forbiddenphpmethodsregex.'/i', '__forbiddenstring__', $s);
  8857. //$s = preg_replace('/\$[a-zA-Z0-9_\->\$]+\(/i', '', $s); // Remove $function( call and $mycall->mymethod(
  8858. } while ($oldstringtoclean != $s);
  8859. if (strpos($s, '__forbiddenstring__') !== false) {
  8860. dol_syslog('Bad string syntax to evaluate: '.$s, LOG_WARNING);
  8861. if ($returnvalue) {
  8862. return 'Bad string syntax to evaluate: '.$s;
  8863. } else {
  8864. dol_syslog('Bad string syntax to evaluate: '.$s);
  8865. return '';
  8866. }
  8867. }
  8868. //print $s."<br>\n";
  8869. if ($returnvalue) {
  8870. if ($hideerrors) {
  8871. return @eval('return '.$s.';');
  8872. } else {
  8873. return eval('return '.$s.';');
  8874. }
  8875. } else {
  8876. if ($hideerrors) {
  8877. @eval($s);
  8878. } else {
  8879. eval($s);
  8880. }
  8881. }
  8882. } catch (Error $e) {
  8883. $error = 'dol_eval try/catch error : ';
  8884. $error .= $e->getMessage();
  8885. dol_syslog($error, LOG_WARNING);
  8886. }
  8887. }
  8888. /**
  8889. * Return if var element is ok
  8890. *
  8891. * @param string $element Variable to check
  8892. * @return boolean Return true of variable is not empty
  8893. * @see getElementProperties()
  8894. */
  8895. function dol_validElement($element)
  8896. {
  8897. return (trim($element) != '');
  8898. }
  8899. /**
  8900. * Return img flag of country for a language code or country code.
  8901. *
  8902. * @param string $codelang Language code ('en_IN', 'fr_CA', ...) or ISO Country code on 2 characters in uppercase ('IN', 'FR')
  8903. * @param string $moreatt Add more attribute on img tag (For example 'style="float: right"' or 'class="saturatemedium"')
  8904. * @param int $notitlealt No title alt
  8905. * @return string HTML img string with flag.
  8906. */
  8907. function picto_from_langcode($codelang, $moreatt = '', $notitlealt = 0)
  8908. {
  8909. if (empty($codelang)) {
  8910. return '';
  8911. }
  8912. if ($codelang == 'auto') {
  8913. return '<span class="fa fa-language"></span>';
  8914. }
  8915. $langtocountryflag = array(
  8916. 'ar_AR' => '',
  8917. 'ca_ES' => 'catalonia',
  8918. 'da_DA' => 'dk',
  8919. 'fr_CA' => 'mq',
  8920. 'sv_SV' => 'se',
  8921. 'sw_SW' => 'unknown',
  8922. 'AQ' => 'unknown',
  8923. 'CW' => 'unknown',
  8924. 'IM' => 'unknown',
  8925. 'JE' => 'unknown',
  8926. 'MF' => 'unknown',
  8927. 'BL' => 'unknown',
  8928. 'SX' => 'unknown'
  8929. );
  8930. if (isset($langtocountryflag[$codelang])) {
  8931. $flagImage = $langtocountryflag[$codelang];
  8932. } else {
  8933. $tmparray = explode('_', $codelang);
  8934. $flagImage = empty($tmparray[1]) ? $tmparray[0] : $tmparray[1];
  8935. }
  8936. $morecss = '';
  8937. $reg = array();
  8938. if (preg_match('/class="([^"]+)"/', $moreatt, $reg)) {
  8939. $morecss = $reg[1];
  8940. $moreatt = "";
  8941. }
  8942. // return img_picto_common($codelang, 'flags/'.strtolower($flagImage).'.png', $moreatt, 0, $notitlealt);
  8943. return '<span class="flag-sprite '.strtolower($flagImage).($morecss ? ' '.$morecss : '').'"'.($moreatt ? ' '.$moreatt : '').(!$notitlealt ? ' title="'.$codelang.'"' : '').'></span>';
  8944. }
  8945. /**
  8946. * Return default language from country code.
  8947. * Return null if not found.
  8948. *
  8949. * @param string $countrycode Country code like 'US', 'FR', 'CA', 'ES', 'IN', 'MX', ...
  8950. * @return string Value of locale like 'en_US', 'fr_FR', ... or null if not found
  8951. */
  8952. function getLanguageCodeFromCountryCode($countrycode)
  8953. {
  8954. global $mysoc;
  8955. if (empty($countrycode)) {
  8956. return null;
  8957. }
  8958. if (strtoupper($countrycode) == 'MQ') {
  8959. return 'fr_CA';
  8960. }
  8961. if (strtoupper($countrycode) == 'SE') {
  8962. return 'sv_SE'; // se_SE is Sami/Sweden, and we want in priority sv_SE for SE country
  8963. }
  8964. if (strtoupper($countrycode) == 'CH') {
  8965. if ($mysoc->country_code == 'FR') {
  8966. return 'fr_CH';
  8967. }
  8968. if ($mysoc->country_code == 'DE') {
  8969. return 'de_CH';
  8970. }
  8971. if ($mysoc->country_code == 'IT') {
  8972. return 'it_CH';
  8973. }
  8974. }
  8975. // Locale list taken from:
  8976. // http://stackoverflow.com/questions/3191664/
  8977. // list-of-all-locales-and-their-short-codes
  8978. $locales = array(
  8979. 'af-ZA',
  8980. 'am-ET',
  8981. 'ar-AE',
  8982. 'ar-BH',
  8983. 'ar-DZ',
  8984. 'ar-EG',
  8985. 'ar-IQ',
  8986. 'ar-JO',
  8987. 'ar-KW',
  8988. 'ar-LB',
  8989. 'ar-LY',
  8990. 'ar-MA',
  8991. 'ar-OM',
  8992. 'ar-QA',
  8993. 'ar-SA',
  8994. 'ar-SY',
  8995. 'ar-TN',
  8996. 'ar-YE',
  8997. //'as-IN', // Moved after en-IN
  8998. 'ba-RU',
  8999. 'be-BY',
  9000. 'bg-BG',
  9001. 'bn-BD',
  9002. //'bn-IN', // Moved after en-IN
  9003. 'bo-CN',
  9004. 'br-FR',
  9005. 'ca-ES',
  9006. 'co-FR',
  9007. 'cs-CZ',
  9008. 'cy-GB',
  9009. 'da-DK',
  9010. 'de-AT',
  9011. 'de-CH',
  9012. 'de-DE',
  9013. 'de-LI',
  9014. 'de-LU',
  9015. 'dv-MV',
  9016. 'el-GR',
  9017. 'en-AU',
  9018. 'en-BZ',
  9019. 'en-CA',
  9020. 'en-GB',
  9021. 'en-IE',
  9022. 'en-IN',
  9023. 'as-IN', // as-IN must be after en-IN (en in priority if country is IN)
  9024. 'bn-IN', // bn-IN must be after en-IN (en in priority if country is IN)
  9025. 'en-JM',
  9026. 'en-MY',
  9027. 'en-NZ',
  9028. 'en-PH',
  9029. 'en-SG',
  9030. 'en-TT',
  9031. 'en-US',
  9032. 'en-ZA',
  9033. 'en-ZW',
  9034. 'es-AR',
  9035. 'es-BO',
  9036. 'es-CL',
  9037. 'es-CO',
  9038. 'es-CR',
  9039. 'es-DO',
  9040. 'es-EC',
  9041. 'es-ES',
  9042. 'es-GT',
  9043. 'es-HN',
  9044. 'es-MX',
  9045. 'es-NI',
  9046. 'es-PA',
  9047. 'es-PE',
  9048. 'es-PR',
  9049. 'es-PY',
  9050. 'es-SV',
  9051. 'es-US',
  9052. 'es-UY',
  9053. 'es-VE',
  9054. 'et-EE',
  9055. 'eu-ES',
  9056. 'fa-IR',
  9057. 'fi-FI',
  9058. 'fo-FO',
  9059. 'fr-BE',
  9060. 'fr-CA',
  9061. 'fr-CH',
  9062. 'fr-FR',
  9063. 'fr-LU',
  9064. 'fr-MC',
  9065. 'fy-NL',
  9066. 'ga-IE',
  9067. 'gd-GB',
  9068. 'gl-ES',
  9069. 'gu-IN',
  9070. 'he-IL',
  9071. 'hi-IN',
  9072. 'hr-BA',
  9073. 'hr-HR',
  9074. 'hu-HU',
  9075. 'hy-AM',
  9076. 'id-ID',
  9077. 'ig-NG',
  9078. 'ii-CN',
  9079. 'is-IS',
  9080. 'it-CH',
  9081. 'it-IT',
  9082. 'ja-JP',
  9083. 'ka-GE',
  9084. 'kk-KZ',
  9085. 'kl-GL',
  9086. 'km-KH',
  9087. 'kn-IN',
  9088. 'ko-KR',
  9089. 'ky-KG',
  9090. 'lb-LU',
  9091. 'lo-LA',
  9092. 'lt-LT',
  9093. 'lv-LV',
  9094. 'mi-NZ',
  9095. 'mk-MK',
  9096. 'ml-IN',
  9097. 'mn-MN',
  9098. 'mr-IN',
  9099. 'ms-BN',
  9100. 'ms-MY',
  9101. 'mt-MT',
  9102. 'nb-NO',
  9103. 'ne-NP',
  9104. 'nl-BE',
  9105. 'nl-NL',
  9106. 'nn-NO',
  9107. 'oc-FR',
  9108. 'or-IN',
  9109. 'pa-IN',
  9110. 'pl-PL',
  9111. 'ps-AF',
  9112. 'pt-BR',
  9113. 'pt-PT',
  9114. 'rm-CH',
  9115. 'ro-MD',
  9116. 'ro-RO',
  9117. 'ru-RU',
  9118. 'rw-RW',
  9119. 'sa-IN',
  9120. 'se-FI',
  9121. 'se-NO',
  9122. 'se-SE',
  9123. 'si-LK',
  9124. 'sk-SK',
  9125. 'sl-SI',
  9126. 'sq-AL',
  9127. 'sv-FI',
  9128. 'sv-SE',
  9129. 'sw-KE',
  9130. 'ta-IN',
  9131. 'te-IN',
  9132. 'th-TH',
  9133. 'tk-TM',
  9134. 'tn-ZA',
  9135. 'tr-TR',
  9136. 'tt-RU',
  9137. 'ug-CN',
  9138. 'uk-UA',
  9139. 'ur-PK',
  9140. 'vi-VN',
  9141. 'wo-SN',
  9142. 'xh-ZA',
  9143. 'yo-NG',
  9144. 'zh-CN',
  9145. 'zh-HK',
  9146. 'zh-MO',
  9147. 'zh-SG',
  9148. 'zh-TW',
  9149. 'zu-ZA',
  9150. );
  9151. $buildprimarykeytotest = strtolower($countrycode).'-'.strtoupper($countrycode);
  9152. if (in_array($buildprimarykeytotest, $locales)) {
  9153. return strtolower($countrycode).'_'.strtoupper($countrycode);
  9154. }
  9155. if (function_exists('locale_get_primary_language') && function_exists('locale_get_region')) { // Need extension php-intl
  9156. foreach ($locales as $locale) {
  9157. $locale_language = locale_get_primary_language($locale);
  9158. $locale_region = locale_get_region($locale);
  9159. if (strtoupper($countrycode) == $locale_region) {
  9160. //var_dump($locale.' - '.$locale_language.' - '.$locale_region);
  9161. return strtolower($locale_language).'_'.strtoupper($locale_region);
  9162. }
  9163. }
  9164. } else {
  9165. dol_syslog("Warning Exention php-intl is not available", LOG_WARNING);
  9166. }
  9167. return null;
  9168. }
  9169. /**
  9170. * Complete or removed entries into a head array (used to build tabs).
  9171. * For example, with value added by external modules. Such values are declared into $conf->modules_parts['tab'].
  9172. * Or by change using hook completeTabsHead
  9173. *
  9174. * @param Conf $conf Object conf
  9175. * @param Translate $langs Object langs
  9176. * @param object|null $object Object object
  9177. * @param array $head Object head
  9178. * @param int $h New position to fill
  9179. * @param string $type Value for object where objectvalue can be
  9180. * 'thirdparty' to add a tab in third party view
  9181. * 'intervention' to add a tab in intervention view
  9182. * 'supplier_order' to add a tab in purchase order view
  9183. * 'supplier_invoice' to add a tab in purchase invoice view
  9184. * 'invoice' to add a tab in sales invoice view
  9185. * 'order' to add a tab in sales order view
  9186. * 'contract' to add a tabl in contract view
  9187. * 'product' to add a tab in product view
  9188. * 'propal' to add a tab in propal view
  9189. * 'user' to add a tab in user view
  9190. * 'group' to add a tab in group view
  9191. * 'member' to add a tab in fundation member view
  9192. * 'categories_x' to add a tab in category view ('x': type of category (0=product, 1=supplier, 2=customer, 3=member)
  9193. * 'ecm' to add a tab for another ecm view
  9194. * 'stock' to add a tab for warehouse view
  9195. * @param string $mode 'add' to complete head, 'remove' to remove entries
  9196. * @param string $filterorigmodule Filter on module origin: 'external' will show only external modules. 'core' only core modules. No filter (default) will add both.
  9197. * @return void
  9198. */
  9199. function complete_head_from_modules($conf, $langs, $object, &$head, &$h, $type, $mode = 'add', $filterorigmodule = '')
  9200. {
  9201. global $hookmanager, $db;
  9202. if (isset($conf->modules_parts['tabs'][$type]) && is_array($conf->modules_parts['tabs'][$type])) {
  9203. foreach ($conf->modules_parts['tabs'][$type] as $value) {
  9204. $values = explode(':', $value);
  9205. $reg = array();
  9206. if ($mode == 'add' && !preg_match('/^\-/', $values[1])) {
  9207. $newtab = array();
  9208. $postab = $h;
  9209. // detect if position set in $values[1] ie : +(2)mytab@mymodule (first tab is 0, second is one, ...)
  9210. $str = $values[1];
  9211. $posstart = strpos($str, '(');
  9212. if ($posstart > 0) {
  9213. $posend = strpos($str, ')');
  9214. if ($posstart > 0) {
  9215. $res1 = substr($str, $posstart + 1, $posend - $posstart -1);
  9216. if (is_numeric($res1)) {
  9217. $postab = (int) $res1;
  9218. $values[1] = '+' . substr($str, $posend + 1);
  9219. }
  9220. }
  9221. }
  9222. if (count($values) == 6) {
  9223. // new declaration with permissions:
  9224. // $value='objecttype:+tabname1:Title1:langfile@mymodule:$user->rights->mymodule->read:/mymodule/mynewtab1.php?id=__ID__'
  9225. // $value='objecttype:+tabname1:Title1,class,pathfile,method:langfile@mymodule:$user->rights->mymodule->read:/mymodule/mynewtab1.php?id=__ID__'
  9226. if ($values[0] != $type) {
  9227. continue;
  9228. }
  9229. if (verifCond($values[4])) {
  9230. if ($values[3]) {
  9231. if ($filterorigmodule) { // If a filter of module origin has been requested
  9232. if (strpos($values[3], '@')) { // This is an external module
  9233. if ($filterorigmodule != 'external') {
  9234. continue;
  9235. }
  9236. } else { // This looks a core module
  9237. if ($filterorigmodule != 'core') {
  9238. continue;
  9239. }
  9240. }
  9241. }
  9242. $langs->load($values[3]);
  9243. }
  9244. if (preg_match('/SUBSTITUTION_([^_]+)/i', $values[2], $reg)) {
  9245. // If label is "SUBSTITUION_..."
  9246. $substitutionarray = array();
  9247. complete_substitutions_array($substitutionarray, $langs, $object, array('needforkey'=>$values[2]));
  9248. $label = make_substitutions($reg[1], $substitutionarray);
  9249. } else {
  9250. // If label is "Label,Class,File,Method", we call the method to show content inside the badge
  9251. $labeltemp = explode(',', $values[2]);
  9252. $label = $langs->trans($labeltemp[0]);
  9253. if (!empty($labeltemp[1]) && is_object($object) && !empty($object->id)) {
  9254. dol_include_once($labeltemp[2]);
  9255. $classtoload = $labeltemp[1];
  9256. if (class_exists($classtoload)) {
  9257. $obj = new $classtoload($db);
  9258. $function = $labeltemp[3];
  9259. if ($obj && $function && method_exists($obj, $function)) {
  9260. $nbrec = $obj->$function($object->id, $obj);
  9261. if (!empty($nbrec)) {
  9262. $label .= '<span class="badge marginleftonlyshort">'.$nbrec.'</span>';
  9263. }
  9264. }
  9265. }
  9266. }
  9267. }
  9268. $newtab[0] = dol_buildpath(preg_replace('/__ID__/i', ((is_object($object) && !empty($object->id)) ? $object->id : ''), $values[5]), 1);
  9269. $newtab[1] = $label;
  9270. $newtab[2] = str_replace('+', '', $values[1]);
  9271. $h++;
  9272. }
  9273. } elseif (count($values) == 5) { // case deprecated
  9274. dol_syslog('Passing 5 values in tabs module_parts is deprecated. Please update to 6 with permissions.', LOG_WARNING);
  9275. if ($values[0] != $type) {
  9276. continue;
  9277. }
  9278. if ($values[3]) {
  9279. if ($filterorigmodule) { // If a filter of module origin has been requested
  9280. if (strpos($values[3], '@')) { // This is an external module
  9281. if ($filterorigmodule != 'external') {
  9282. continue;
  9283. }
  9284. } else { // This looks a core module
  9285. if ($filterorigmodule != 'core') {
  9286. continue;
  9287. }
  9288. }
  9289. }
  9290. $langs->load($values[3]);
  9291. }
  9292. if (preg_match('/SUBSTITUTION_([^_]+)/i', $values[2], $reg)) {
  9293. $substitutionarray = array();
  9294. complete_substitutions_array($substitutionarray, $langs, $object, array('needforkey'=>$values[2]));
  9295. $label = make_substitutions($reg[1], $substitutionarray);
  9296. } else {
  9297. $label = $langs->trans($values[2]);
  9298. }
  9299. $newtab[0] = dol_buildpath(preg_replace('/__ID__/i', ((is_object($object) && !empty($object->id)) ? $object->id : ''), $values[4]), 1);
  9300. $newtab[1] = $label;
  9301. $newtab[2] = str_replace('+', '', $values[1]);
  9302. $h++;
  9303. }
  9304. // set tab at its position
  9305. $head = array_merge(array_slice($head, 0, $postab), array($newtab), array_slice($head, $postab));
  9306. } elseif ($mode == 'remove' && preg_match('/^\-/', $values[1])) {
  9307. if ($values[0] != $type) {
  9308. continue;
  9309. }
  9310. $tabname = str_replace('-', '', $values[1]);
  9311. foreach ($head as $key => $val) {
  9312. $condition = (!empty($values[3]) ? verifCond($values[3]) : 1);
  9313. //var_dump($key.' - '.$tabname.' - '.$head[$key][2].' - '.$values[3].' - '.$condition);
  9314. if ($head[$key][2] == $tabname && $condition) {
  9315. unset($head[$key]);
  9316. break;
  9317. }
  9318. }
  9319. }
  9320. }
  9321. }
  9322. // No need to make a return $head. Var is modified as a reference
  9323. if (!empty($hookmanager)) {
  9324. $parameters = array('object' => $object, 'mode' => $mode, 'head' => &$head, 'filterorigmodule' => $filterorigmodule);
  9325. $reshook = $hookmanager->executeHooks('completeTabsHead', $parameters, $object);
  9326. if ($reshook > 0) { // Hook ask to replace completely the array
  9327. $head = $hookmanager->resArray;
  9328. } else { // Hook
  9329. $head = array_merge($head, $hookmanager->resArray);
  9330. }
  9331. $h = count($head);
  9332. }
  9333. }
  9334. /**
  9335. * Print common footer :
  9336. * conf->global->MAIN_HTML_FOOTER
  9337. * js for switch of menu hider
  9338. * js for conf->global->MAIN_GOOGLE_AN_ID
  9339. * js for conf->global->MAIN_SHOW_TUNING_INFO or $_SERVER["MAIN_SHOW_TUNING_INFO"]
  9340. * js for conf->logbuffer
  9341. *
  9342. * @param string $zone 'private' (for private pages) or 'public' (for public pages)
  9343. * @return void
  9344. */
  9345. function printCommonFooter($zone = 'private')
  9346. {
  9347. global $conf, $hookmanager, $user, $debugbar;
  9348. global $action;
  9349. global $micro_start_time;
  9350. if ($zone == 'private') {
  9351. print "\n".'<!-- Common footer for private page -->'."\n";
  9352. } else {
  9353. print "\n".'<!-- Common footer for public page -->'."\n";
  9354. }
  9355. // A div to store page_y POST parameter so we can read it using javascript
  9356. print "\n<!-- A div to store page_y POST parameter -->\n";
  9357. print '<div id="page_y" style="display: none;">'.(GETPOST('page_y') ? GETPOST('page_y') : '').'</div>'."\n";
  9358. $parameters = array();
  9359. $reshook = $hookmanager->executeHooks('printCommonFooter', $parameters); // Note that $action and $object may have been modified by some hooks
  9360. if (empty($reshook)) {
  9361. if (getDolGlobalString('MAIN_HTML_FOOTER')) {
  9362. print getDolGlobalString('MAIN_HTML_FOOTER') . "\n";
  9363. }
  9364. print "\n";
  9365. if (!empty($conf->use_javascript_ajax)) {
  9366. print "\n<!-- A script section to add menuhider handler on backoffice, manage focus and madatory fields, tuning info, ... -->\n";
  9367. print '<script>'."\n";
  9368. print 'jQuery(document).ready(function() {'."\n";
  9369. if ($zone == 'private' && empty($conf->dol_use_jmobile)) {
  9370. print "\n";
  9371. print '/* JS CODE TO ENABLE to manage handler to switch left menu page (menuhider) */'."\n";
  9372. print 'jQuery("li.menuhider").click(function(event) {';
  9373. print ' if (!$( "body" ).hasClass( "sidebar-collapse" )){ event.preventDefault(); }'."\n";
  9374. print ' console.log("We click on .menuhider");'."\n";
  9375. print ' $("body").toggleClass("sidebar-collapse")'."\n";
  9376. print '});'."\n";
  9377. }
  9378. // Management of focus and mandatory for fields
  9379. if ($action == 'create' || $action == 'edit' || (empty($action) && (preg_match('/new\.php/', $_SERVER["PHP_SELF"]))) || ((empty($action) || $action == 'addline') && (preg_match('/card\.php/', $_SERVER["PHP_SELF"])))) {
  9380. print '/* JS CODE TO ENABLE to manage focus and mandatory form fields */'."\n";
  9381. $relativepathstring = $_SERVER["PHP_SELF"];
  9382. // Clean $relativepathstring
  9383. if (constant('DOL_URL_ROOT')) {
  9384. $relativepathstring = preg_replace('/^'.preg_quote(constant('DOL_URL_ROOT'), '/').'/', '', $relativepathstring);
  9385. }
  9386. $relativepathstring = preg_replace('/^\//', '', $relativepathstring);
  9387. $relativepathstring = preg_replace('/^custom\//', '', $relativepathstring);
  9388. //$tmpqueryarraywehave = explode('&', dol_string_nohtmltag($_SERVER['QUERY_STRING']));
  9389. if (!empty($user->default_values[$relativepathstring]['focus'])) {
  9390. foreach ($user->default_values[$relativepathstring]['focus'] as $defkey => $defval) {
  9391. $qualified = 0;
  9392. if ($defkey != '_noquery_') {
  9393. $tmpqueryarraytohave = explode('&', $defkey);
  9394. $foundintru = 0;
  9395. foreach ($tmpqueryarraytohave as $tmpquerytohave) {
  9396. $tmpquerytohaveparam = explode('=', $tmpquerytohave);
  9397. //print "console.log('".$tmpquerytohaveparam[0]." ".$tmpquerytohaveparam[1]." ".GETPOST($tmpquerytohaveparam[0])."');";
  9398. if (!GETPOSTISSET($tmpquerytohaveparam[0]) || ($tmpquerytohaveparam[1] != GETPOST($tmpquerytohaveparam[0]))) {
  9399. $foundintru = 1;
  9400. }
  9401. }
  9402. if (!$foundintru) {
  9403. $qualified = 1;
  9404. }
  9405. //var_dump($defkey.'-'.$qualified);
  9406. } else {
  9407. $qualified = 1;
  9408. }
  9409. if ($qualified) {
  9410. foreach ($defval as $paramkey => $paramval) {
  9411. // Set focus on field
  9412. print 'jQuery("input[name=\''.$paramkey.'\']").focus();'."\n";
  9413. print 'jQuery("textarea[name=\''.$paramkey.'\']").focus();'."\n";
  9414. print 'jQuery("select[name=\''.$paramkey.'\']").focus();'."\n"; // Not really usefull, but we keep it in case of.
  9415. }
  9416. }
  9417. }
  9418. }
  9419. if (!empty($user->default_values[$relativepathstring]['mandatory'])) {
  9420. foreach ($user->default_values[$relativepathstring]['mandatory'] as $defkey => $defval) {
  9421. $qualified = 0;
  9422. if ($defkey != '_noquery_') {
  9423. $tmpqueryarraytohave = explode('&', $defkey);
  9424. $foundintru = 0;
  9425. foreach ($tmpqueryarraytohave as $tmpquerytohave) {
  9426. $tmpquerytohaveparam = explode('=', $tmpquerytohave);
  9427. //print "console.log('".$tmpquerytohaveparam[0]." ".$tmpquerytohaveparam[1]." ".GETPOST($tmpquerytohaveparam[0])."');";
  9428. if (!GETPOSTISSET($tmpquerytohaveparam[0]) || ($tmpquerytohaveparam[1] != GETPOST($tmpquerytohaveparam[0]))) {
  9429. $foundintru = 1;
  9430. }
  9431. }
  9432. if (!$foundintru) {
  9433. $qualified = 1;
  9434. }
  9435. //var_dump($defkey.'-'.$qualified);
  9436. } else {
  9437. $qualified = 1;
  9438. }
  9439. if ($qualified) {
  9440. foreach ($defval as $paramkey => $paramval) {
  9441. // Add property 'required' on input
  9442. print 'jQuery("input[name=\''.$paramkey.'\']").prop(\'required\',true);'."\n";
  9443. print 'jQuery("textarea[name=\''.$paramkey.'\']").prop(\'required\',true);'."\n";
  9444. print '// required on a select works only if key is "", so we add the required attributes but also we reset the key -1 or 0 to an empty string'."\n";
  9445. print 'jQuery("select[name=\''.$paramkey.'\']").prop(\'required\',true);'."\n";
  9446. print 'jQuery("select[name=\''.$paramkey.'\'] option[value=\'-1\']").prop(\'value\', \'\');'."\n";
  9447. print 'jQuery("select[name=\''.$paramkey.'\'] option[value=\'0\']").prop(\'value\', \'\');'."\n";
  9448. // Add 'field required' class on closest td for all input elements : input, textarea and select
  9449. print 'jQuery(":input[name=\'' . $paramkey . '\']").closest("tr").find("td:first").addClass("fieldrequired");' . "\n";
  9450. }
  9451. // If we submit the cancel button we remove the required attributes
  9452. print 'jQuery("input[name=\'cancel\']").click(function() {
  9453. console.log("We click on cancel button so removed all required attribute");
  9454. jQuery("input, textarea, select").each(function(){this.removeAttribute(\'required\');});
  9455. });'."\n";
  9456. }
  9457. }
  9458. }
  9459. }
  9460. print '});'."\n";
  9461. // End of tuning
  9462. if (!empty($_SERVER['MAIN_SHOW_TUNING_INFO']) || getDolGlobalString('MAIN_SHOW_TUNING_INFO')) {
  9463. print "\n";
  9464. print "/* JS CODE TO ENABLE to add memory info */\n";
  9465. print 'window.console && console.log("';
  9466. if (getDolGlobalString('MEMCACHED_SERVER')) {
  9467. print 'MEMCACHED_SERVER=' . getDolGlobalString('MEMCACHED_SERVER').' - ';
  9468. }
  9469. print 'MAIN_OPTIMIZE_SPEED='.(isset($conf->global->MAIN_OPTIMIZE_SPEED) ? $conf->global->MAIN_OPTIMIZE_SPEED : 'off');
  9470. if (!empty($micro_start_time)) { // Works only if MAIN_SHOW_TUNING_INFO is defined at $_SERVER level. Not in global variable.
  9471. $micro_end_time = microtime(true);
  9472. print ' - Build time: '.ceil(1000 * ($micro_end_time - $micro_start_time)).' ms';
  9473. }
  9474. if (function_exists("memory_get_usage")) {
  9475. print ' - Mem: '.memory_get_usage(); // Do not use true here, it seems it takes the peak amount
  9476. }
  9477. if (function_exists("memory_get_peak_usage")) {
  9478. print ' - Real mem peak: '.memory_get_peak_usage(true);
  9479. }
  9480. if (function_exists("zend_loader_file_encoded")) {
  9481. print ' - Zend encoded file: '.(zend_loader_file_encoded() ? 'yes' : 'no');
  9482. }
  9483. print '");'."\n";
  9484. }
  9485. print "\n".'</script>'."\n";
  9486. // Google Analytics
  9487. // TODO Add a hook here
  9488. if (isModEnabled('google') && getDolGlobalString('MAIN_GOOGLE_AN_ID')) {
  9489. $tmptagarray = explode(',', getDolGlobalString('MAIN_GOOGLE_AN_ID'));
  9490. foreach ($tmptagarray as $tmptag) {
  9491. print "\n";
  9492. print "<!-- JS CODE TO ENABLE for google analtics tag -->\n";
  9493. print '
  9494. <!-- Global site tag (gtag.js) - Google Analytics -->
  9495. <script nonce="'.getNonce().'" async src="https://www.googletagmanager.com/gtag/js?id='.trim($tmptag).'"></script>
  9496. <script>
  9497. window.dataLayer = window.dataLayer || [];
  9498. function gtag(){dataLayer.push(arguments);}
  9499. gtag(\'js\', new Date());
  9500. gtag(\'config\', \''.trim($tmptag).'\');
  9501. </script>';
  9502. print "\n";
  9503. }
  9504. }
  9505. }
  9506. // Add Xdebug coverage of code
  9507. if (defined('XDEBUGCOVERAGE')) {
  9508. print_r(xdebug_get_code_coverage());
  9509. }
  9510. // Add DebugBar data
  9511. if ($user->hasRight('debugbar', 'read') && is_object($debugbar)) {
  9512. $debugbar['time']->stopMeasure('pageaftermaster');
  9513. print '<!-- Output debugbar data -->'."\n";
  9514. $renderer = $debugbar->getRenderer();
  9515. print $debugbar->getRenderer()->render();
  9516. } elseif (count($conf->logbuffer)) { // If there is some logs in buffer to show
  9517. print "\n";
  9518. print "<!-- Start of log output\n";
  9519. //print '<div class="hidden">'."\n";
  9520. foreach ($conf->logbuffer as $logline) {
  9521. print $logline."<br>\n";
  9522. }
  9523. //print '</div>'."\n";
  9524. print "End of log output -->\n";
  9525. }
  9526. }
  9527. }
  9528. /**
  9529. * Split a string with 2 keys into key array.
  9530. * For example: "A=1;B=2;C=2" is exploded into array('A'=>1,'B'=>2,'C'=>3)
  9531. *
  9532. * @param string|null $string String to explode
  9533. * @param string $delimiter Delimiter between each couple of data. Example: ';' or '[\n;]+' or '(\n\r|\r|\n|;)'
  9534. * @param string $kv Delimiter between key and value
  9535. * @return array Array of data exploded
  9536. */
  9537. function dolExplodeIntoArray($string, $delimiter = ';', $kv = '=')
  9538. {
  9539. if (is_null($string)) {
  9540. return array();
  9541. }
  9542. if (preg_match('/^\[.*\]$/sm', $delimiter) || preg_match('/^\(.*\)$/sm', $delimiter)) {
  9543. // This is a regex string
  9544. $newdelimiter = $delimiter;
  9545. } else {
  9546. // This is a simple string
  9547. $newdelimiter = preg_quote($delimiter, '/');
  9548. }
  9549. if ($a = preg_split('/'.$newdelimiter.'/', $string)) {
  9550. $ka = array();
  9551. foreach ($a as $s) { // each part
  9552. if ($s) {
  9553. if ($pos = strpos($s, $kv)) { // key/value delimiter
  9554. $ka[trim(substr($s, 0, $pos))] = trim(substr($s, $pos + strlen($kv)));
  9555. } else { // key delimiter not found
  9556. $ka[] = trim($s);
  9557. }
  9558. }
  9559. }
  9560. return $ka;
  9561. }
  9562. return array();
  9563. }
  9564. /**
  9565. * Set focus onto field with selector (similar behaviour of 'autofocus' HTML5 tag)
  9566. *
  9567. * @param string $selector Selector ('#id' or 'input[name="ref"]') to use to find the HTML input field that must get the autofocus. You must use a CSS selector, so unique id preceding with the '#' char.
  9568. * @return void
  9569. */
  9570. function dol_set_focus($selector)
  9571. {
  9572. print "\n".'<!-- Set focus onto a specific field -->'."\n";
  9573. print '<script nonce="'.getNonce().'">jQuery(document).ready(function() { jQuery("'.dol_escape_js($selector).'").focus(); });</script>'."\n";
  9574. }
  9575. /**
  9576. * Return getmypid() or random PID when function is disabled
  9577. * Some web hosts disable this php function for security reasons
  9578. * and sometimes we can't redeclare function.
  9579. *
  9580. * @return int
  9581. */
  9582. function dol_getmypid()
  9583. {
  9584. if (!function_exists('getmypid')) {
  9585. return mt_rand(99900000, 99965535);
  9586. } else {
  9587. return getmypid(); // May be a number on 64 bits (depending on OS)
  9588. }
  9589. }
  9590. /**
  9591. * Generate natural SQL search string for a criteria (this criteria can be tested on one or several fields)
  9592. *
  9593. * @param string|string[] $fields String or array of strings, filled with the name of all fields in the SQL query we must check (combined with a OR). Example: array("p.field1","p.field2")
  9594. * @param string $value The value to look for.
  9595. * If param $mode is 0, can contains several keywords separated with a space or |
  9596. * like "keyword1 keyword2" = We want record field like keyword1 AND field like keyword2
  9597. * or like "keyword1|keyword2" = We want record field like keyword1 OR field like keyword2
  9598. * If param $mode is 1, can contains an operator <, > or = like "<10" or ">=100.5 < -1000"
  9599. * If param $mode is 2 or -2, can contains a list of int id separated by comma like "1,3,4"
  9600. * If param $mode is 3 or -3, can contains a list of string separated by comma like "a,b,c".
  9601. * @param integer $mode 0=value is list of keyword strings, 1=value is a numeric test (Example ">5.5 <10"), 2=value is a list of ID separated with comma (Example '1,3,4'), -2 is for exclude list,
  9602. * 3=value is list of string separated with comma (Example 'text 1,text 2'), -3 if for exclude list, 4=value is a list of ID separated with comma (Example '2,7') to be used to search into a multiselect string '1,2,3,4'
  9603. * @param integer $nofirstand 1=Do not output the first 'AND'
  9604. * @return string $res The statement to append to the SQL query
  9605. * @see dolSqlDateFilter()
  9606. */
  9607. function natural_search($fields, $value, $mode = 0, $nofirstand = 0)
  9608. {
  9609. global $db, $langs;
  9610. $value = trim($value);
  9611. if ($mode == 0) {
  9612. $value = preg_replace('/\*/', '%', $value); // Replace * with %
  9613. }
  9614. if ($mode == 1) {
  9615. $value = preg_replace('/([!<>=]+)\s+([0-9'.preg_quote($langs->trans("DecimalSeparator"), '/').'\-])/', '\1\2', $value); // Clean string '< 10' into '<10' so we can then explode on space to get all tests to do
  9616. }
  9617. $value = preg_replace('/\s*\|\s*/', '|', $value);
  9618. $crits = explode(' ', $value);
  9619. $res = '';
  9620. if (!is_array($fields)) {
  9621. $fields = array($fields);
  9622. }
  9623. $i1 = 0; // count the nb of and criteria added (all fields / criterias)
  9624. foreach ($crits as $crit) { // Loop on each AND criteria
  9625. $crit = trim($crit);
  9626. $i2 = 0; // count the nb of valid criteria added for this this first criteria
  9627. $newres = '';
  9628. foreach ($fields as $field) {
  9629. if ($mode == 1) {
  9630. $tmpcrits = explode('|', $crit);
  9631. $i3 = 0; // count the nb of valid criteria added for this current field
  9632. foreach ($tmpcrits as $tmpcrit) {
  9633. if ($tmpcrit !== '0' && empty($tmpcrit)) {
  9634. continue;
  9635. }
  9636. $tmpcrit = trim($tmpcrit);
  9637. $newres .= (($i2 > 0 || $i3 > 0) ? ' OR ' : '');
  9638. $operator = '=';
  9639. $newcrit = preg_replace('/([!<>=]+)/', '', $tmpcrit);
  9640. $reg = array();
  9641. preg_match('/([!<>=]+)/', $tmpcrit, $reg);
  9642. if (!empty($reg[1])) {
  9643. $operator = $reg[1];
  9644. }
  9645. if ($newcrit != '') {
  9646. $numnewcrit = price2num($newcrit);
  9647. if (is_numeric($numnewcrit)) {
  9648. $newres .= $field.' '.$operator.' '.((float) $numnewcrit); // should be a numeric
  9649. } else {
  9650. $newres .= '1 = 2'; // force false, we received a corrupted data
  9651. }
  9652. $i3++; // a criteria was added to string
  9653. }
  9654. }
  9655. $i2++; // a criteria for 1 more field was added to string
  9656. } elseif ($mode == 2 || $mode == -2) {
  9657. $crit = preg_replace('/[^0-9,]/', '', $crit); // ID are always integer
  9658. $newres .= ($i2 > 0 ? ' OR ' : '').$field." ".($mode == -2 ? 'NOT ' : '');
  9659. $newres .= $crit ? "IN (".$db->sanitize($db->escape($crit)).")" : "IN (0)";
  9660. if ($mode == -2) {
  9661. $newres .= ' OR '.$field.' IS NULL';
  9662. }
  9663. $i2++; // a criteria for 1 more field was added to string
  9664. } elseif ($mode == 3 || $mode == -3) {
  9665. $tmparray = explode(',', $crit);
  9666. if (count($tmparray)) {
  9667. $listofcodes = '';
  9668. foreach ($tmparray as $val) {
  9669. $val = trim($val);
  9670. if ($val) {
  9671. $listofcodes .= ($listofcodes ? ',' : '');
  9672. $listofcodes .= "'".$db->escape($val)."'";
  9673. }
  9674. }
  9675. $newres .= ($i2 > 0 ? ' OR ' : '').$field." ".($mode == -3 ? 'NOT ' : '')."IN (".$db->sanitize($listofcodes, 1).")";
  9676. $i2++; // a criteria for 1 more field was added to string
  9677. }
  9678. if ($mode == -3) {
  9679. $newres .= ' OR '.$field.' IS NULL';
  9680. }
  9681. } elseif ($mode == 4) {
  9682. $tmparray = explode(',', $crit);
  9683. if (count($tmparray)) {
  9684. $listofcodes = '';
  9685. foreach ($tmparray as $val) {
  9686. $val = trim($val);
  9687. if ($val) {
  9688. $newres .= ($i2 > 0 ? " OR (" : "(").$field." LIKE '".$db->escape($val).",%'";
  9689. $newres .= ' OR '.$field." = '".$db->escape($val)."'";
  9690. $newres .= ' OR '.$field." LIKE '%,".$db->escape($val)."'";
  9691. $newres .= ' OR '.$field." LIKE '%,".$db->escape($val).",%'";
  9692. $newres .= ')';
  9693. $i2++; // a criteria for 1 more field was added to string (we can add several citeria for the same field as it is a multiselect search criteria)
  9694. }
  9695. }
  9696. }
  9697. } else { // $mode=0
  9698. $tmpcrits = explode('|', $crit);
  9699. $i3 = 0; // count the nb of valid criteria added for the current couple criteria/field
  9700. foreach ($tmpcrits as $tmpcrit) { // loop on each OR criteria
  9701. if ($tmpcrit !== '0' && empty($tmpcrit)) {
  9702. continue;
  9703. }
  9704. $tmpcrit = trim($tmpcrit);
  9705. if ($tmpcrit == '^$' || strpos($crit, '!') === 0) { // If we search empty, we must combined different OR fields with AND
  9706. $newres .= (($i2 > 0 || $i3 > 0) ? ' AND ' : '');
  9707. } else {
  9708. $newres .= (($i2 > 0 || $i3 > 0) ? ' OR ' : '');
  9709. }
  9710. if (preg_match('/\.(id|rowid)$/', $field)) { // Special case for rowid that is sometimes a ref so used as a search field
  9711. $newres .= $field." = ".(is_numeric($tmpcrit) ? ((float) $tmpcrit) : '0');
  9712. } else {
  9713. $tmpcrit2 = $tmpcrit;
  9714. $tmpbefore = '%';
  9715. $tmpafter = '%';
  9716. $tmps = '';
  9717. if (preg_match('/^!/', $tmpcrit)) {
  9718. $tmps .= $field." NOT LIKE "; // ! as exclude character
  9719. $tmpcrit2 = preg_replace('/^!/', '', $tmpcrit2);
  9720. } else {
  9721. $tmps .= $field." LIKE ";
  9722. }
  9723. $tmps .= "'";
  9724. if (preg_match('/^[\^\$]/', $tmpcrit)) {
  9725. $tmpbefore = '';
  9726. $tmpcrit2 = preg_replace('/^[\^\$]/', '', $tmpcrit2);
  9727. }
  9728. if (preg_match('/[\^\$]$/', $tmpcrit)) {
  9729. $tmpafter = '';
  9730. $tmpcrit2 = preg_replace('/[\^\$]$/', '', $tmpcrit2);
  9731. }
  9732. if ($tmpcrit2 == '' || preg_match('/^!/', $tmpcrit)) {
  9733. $tmps = "(".$tmps;
  9734. }
  9735. $newres .= $tmps;
  9736. $newres .= $tmpbefore;
  9737. $newres .= $db->escape($tmpcrit2);
  9738. $newres .= $tmpafter;
  9739. $newres .= "'";
  9740. if ($tmpcrit2 == '' || preg_match('/^!/', $tmpcrit)) {
  9741. $newres .= " OR ".$field." IS NULL)";
  9742. }
  9743. }
  9744. $i3++;
  9745. }
  9746. $i2++; // a criteria for 1 more field was added to string
  9747. }
  9748. }
  9749. if ($newres) {
  9750. $res = $res.($res ? ' AND ' : '').($i2 > 1 ? '(' : '').$newres.($i2 > 1 ? ')' : '');
  9751. }
  9752. $i1++;
  9753. }
  9754. $res = ($nofirstand ? "" : " AND ")."(".$res.")";
  9755. return $res;
  9756. }
  9757. /**
  9758. * Return string with full Url. The file qualified is the one defined by relative path in $object->last_main_doc
  9759. *
  9760. * @param Object $object Object
  9761. * @return string Url string
  9762. */
  9763. function showDirectDownloadLink($object)
  9764. {
  9765. global $conf, $langs;
  9766. $out = '';
  9767. $url = $object->getLastMainDocLink($object->element);
  9768. $out .= img_picto($langs->trans("PublicDownloadLinkDesc"), 'globe').' <span class="opacitymedium">'.$langs->trans("DirectDownloadLink").'</span><br>';
  9769. if ($url) {
  9770. $out .= '<div class="urllink"><input type="text" id="directdownloadlink" class="quatrevingtpercent" value="'.$url.'"></div>';
  9771. $out .= ajax_autoselect("directdownloadlink", 0);
  9772. } else {
  9773. $out .= '<div class="urllink">'.$langs->trans("FileNotShared").'</div>';
  9774. }
  9775. return $out;
  9776. }
  9777. /**
  9778. * Return the filename of file to get the thumbs
  9779. *
  9780. * @param string $file Original filename (full or relative path)
  9781. * @param string $extName Extension to differenciate thumb file name ('', '_small', '_mini')
  9782. * @param string $extImgTarget Force image extension for thumbs. Use '' to keep same extension than original image (default).
  9783. * @return string New file name (full or relative path, including the thumbs/). May be the original path if no thumb can exists.
  9784. */
  9785. function getImageFileNameForSize($file, $extName, $extImgTarget = '')
  9786. {
  9787. $dirName = dirname($file);
  9788. if ($dirName == '.') {
  9789. $dirName = '';
  9790. }
  9791. $fileName = preg_replace('/(\.gif|\.jpeg|\.jpg|\.png|\.bmp|\.webp)$/i', '', $file); // We remove extension, whatever is its case
  9792. $fileName = basename($fileName);
  9793. if (empty($extImgTarget)) {
  9794. $extImgTarget = (preg_match('/\.jpg$/i', $file) ? '.jpg' : '');
  9795. }
  9796. if (empty($extImgTarget)) {
  9797. $extImgTarget = (preg_match('/\.jpeg$/i', $file) ? '.jpeg' : '');
  9798. }
  9799. if (empty($extImgTarget)) {
  9800. $extImgTarget = (preg_match('/\.gif$/i', $file) ? '.gif' : '');
  9801. }
  9802. if (empty($extImgTarget)) {
  9803. $extImgTarget = (preg_match('/\.png$/i', $file) ? '.png' : '');
  9804. }
  9805. if (empty($extImgTarget)) {
  9806. $extImgTarget = (preg_match('/\.bmp$/i', $file) ? '.bmp' : '');
  9807. }
  9808. if (empty($extImgTarget)) {
  9809. $extImgTarget = (preg_match('/\.webp$/i', $file) ? '.webp' : '');
  9810. }
  9811. if (!$extImgTarget) {
  9812. return $file;
  9813. }
  9814. $subdir = '';
  9815. if ($extName) {
  9816. $subdir = 'thumbs/';
  9817. }
  9818. return ($dirName ? $dirName.'/' : '').$subdir.$fileName.$extName.$extImgTarget; // New filename for thumb
  9819. }
  9820. /**
  9821. * Return URL we can use for advanced preview links
  9822. *
  9823. * @param string $modulepart propal, facture, facture_fourn, ...
  9824. * @param string $relativepath Relative path of docs.
  9825. * @param int $alldata Return array with all components (1 is recommended, then use a simple a href link with the class, target and mime attribute added. 'documentpreview' css class is handled by jquery code into main.inc.php)
  9826. * @param string $param More param on http links
  9827. * @return string|array Output string with href link or array with all components of link
  9828. */
  9829. function getAdvancedPreviewUrl($modulepart, $relativepath, $alldata = 0, $param = '')
  9830. {
  9831. global $conf, $langs;
  9832. if (empty($conf->use_javascript_ajax)) {
  9833. return '';
  9834. }
  9835. $isAllowedForPreview = dolIsAllowedForPreview($relativepath);
  9836. if ($alldata == 1) {
  9837. if ($isAllowedForPreview) {
  9838. return array('target'=>'_blank', 'css'=>'documentpreview', 'url'=>DOL_URL_ROOT.'/document.php?modulepart='.urlencode($modulepart).'&attachment=0&file='.urlencode($relativepath).($param ? '&'.$param : ''), 'mime'=>dol_mimetype($relativepath));
  9839. } else {
  9840. return array();
  9841. }
  9842. }
  9843. // old behavior, return a string
  9844. if ($isAllowedForPreview) {
  9845. $tmpurl = DOL_URL_ROOT.'/document.php?modulepart='.urlencode($modulepart).'&attachment=0&file='.urlencode($relativepath).($param ? '&'.$param : '');
  9846. $title = $langs->trans("Preview");
  9847. //$title = '%27-alert(document.domain)-%27';
  9848. //$tmpurl = 'file='.urlencode("'-alert(document.domain)-'_small.jpg");
  9849. // We need to urlencode the parameter after the dol_escape_js($tmpurl) because $tmpurl may contain n url with param file=abc%27def if file has a ' inside.
  9850. // and when we click on href with this javascript string, a urlcode is done by browser, converted the %27 of file param
  9851. return 'javascript:document_preview(\''.urlencode(dol_escape_js($tmpurl)).'\', \''.urlencode(dol_mimetype($relativepath)).'\', \''.urlencode(dol_escape_js($title)).'\')';
  9852. } else {
  9853. return '';
  9854. }
  9855. }
  9856. /**
  9857. * Make content of an input box selected when we click into input field.
  9858. *
  9859. * @param string $htmlname Id of html object ('#idvalue' or '.classvalue')
  9860. * @param string $addlink Add a 'link to' after
  9861. * @param string $textonlink Text to show on link or 'image'
  9862. * @return string
  9863. */
  9864. function ajax_autoselect($htmlname, $addlink = '', $textonlink = 'Link')
  9865. {
  9866. global $langs;
  9867. $out = '<script nonce="'.getNonce().'">
  9868. jQuery(document).ready(function () {
  9869. jQuery("'.((strpos($htmlname, '.') === 0 ? '' : '#').$htmlname).'").click(function() { jQuery(this).select(); } );
  9870. });
  9871. </script>';
  9872. if ($addlink) {
  9873. if ($textonlink === 'image') {
  9874. $out .= ' <a href="'.$addlink.'" target="_blank" rel="noopener noreferrer">'.img_picto('', 'globe').'</a>';
  9875. } else {
  9876. $out .= ' <a href="'.$addlink.'" target="_blank" rel="noopener noreferrer">'.$langs->trans("Link").'</a>';
  9877. }
  9878. }
  9879. return $out;
  9880. }
  9881. /**
  9882. * Return if a file is qualified for preview
  9883. *
  9884. * @param string $file Filename we looking for information
  9885. * @return int 1 If allowed, 0 otherwise
  9886. * @see dol_mimetype(), image_format_supported() from images.lib.php
  9887. */
  9888. function dolIsAllowedForPreview($file)
  9889. {
  9890. global $conf;
  9891. // Check .noexe extension in filename
  9892. if (preg_match('/\.noexe$/i', $file)) {
  9893. return 0;
  9894. }
  9895. // Check mime types
  9896. $mime_preview = array('bmp', 'jpeg', 'png', 'gif', 'tiff', 'pdf', 'plain', 'css', 'webp');
  9897. if (getDolGlobalString('MAIN_ALLOW_SVG_FILES_AS_IMAGES')) {
  9898. $mime_preview[] = 'svg+xml';
  9899. }
  9900. //$mime_preview[]='vnd.oasis.opendocument.presentation';
  9901. //$mime_preview[]='archive';
  9902. $num_mime = array_search(dol_mimetype($file, '', 1), $mime_preview);
  9903. if ($num_mime !== false) {
  9904. return 1;
  9905. }
  9906. // By default, not allowed for preview
  9907. return 0;
  9908. }
  9909. /**
  9910. * Return MIME type of a file from its name with extension.
  9911. *
  9912. * @param string $file Filename we looking for MIME type
  9913. * @param string $default Default mime type if extension not found in known list
  9914. * @param int $mode 0=Return full mime, 1=otherwise short mime string, 2=image for mime type, 3=source language, 4=css of font fa
  9915. * @return string Return a mime type family (text/xxx, application/xxx, image/xxx, audio, video, archive)
  9916. * @see dolIsAllowedForPreview(), image_format_supported() from images.lib.php
  9917. */
  9918. function dol_mimetype($file, $default = 'application/octet-stream', $mode = 0)
  9919. {
  9920. $mime = $default;
  9921. $imgmime = 'other.png';
  9922. $famime = 'file-o';
  9923. $srclang = '';
  9924. $tmpfile = preg_replace('/\.noexe$/', '', $file);
  9925. // Plain text files
  9926. if (preg_match('/\.txt$/i', $tmpfile)) {
  9927. $mime = 'text/plain';
  9928. $imgmime = 'text.png';
  9929. $famime = 'file-alt';
  9930. } elseif (preg_match('/\.rtx$/i', $tmpfile)) {
  9931. $mime = 'text/richtext';
  9932. $imgmime = 'text.png';
  9933. $famime = 'file-alt';
  9934. } elseif (preg_match('/\.csv$/i', $tmpfile)) {
  9935. $mime = 'text/csv';
  9936. $imgmime = 'text.png';
  9937. $famime = 'file-csv';
  9938. } elseif (preg_match('/\.tsv$/i', $tmpfile)) {
  9939. $mime = 'text/tab-separated-values';
  9940. $imgmime = 'text.png';
  9941. $famime = 'file-alt';
  9942. } elseif (preg_match('/\.(cf|conf|log)$/i', $tmpfile)) {
  9943. $mime = 'text/plain';
  9944. $imgmime = 'text.png';
  9945. $famime = 'file-alt';
  9946. } elseif (preg_match('/\.ini$/i', $tmpfile)) {
  9947. $mime = 'text/plain';
  9948. $imgmime = 'text.png';
  9949. $srclang = 'ini';
  9950. $famime = 'file-alt';
  9951. } elseif (preg_match('/\.md$/i', $tmpfile)) {
  9952. $mime = 'text/plain';
  9953. $imgmime = 'text.png';
  9954. $srclang = 'md';
  9955. $famime = 'file-alt';
  9956. } elseif (preg_match('/\.css$/i', $tmpfile)) {
  9957. $mime = 'text/css';
  9958. $imgmime = 'css.png';
  9959. $srclang = 'css';
  9960. $famime = 'file-alt';
  9961. } elseif (preg_match('/\.lang$/i', $tmpfile)) {
  9962. $mime = 'text/plain';
  9963. $imgmime = 'text.png';
  9964. $srclang = 'lang';
  9965. $famime = 'file-alt';
  9966. } elseif (preg_match('/\.(crt|cer|key|pub)$/i', $tmpfile)) { // Certificate files
  9967. $mime = 'text/plain';
  9968. $imgmime = 'text.png';
  9969. $famime = 'file-alt';
  9970. } elseif (preg_match('/\.(html|htm|shtml)$/i', $tmpfile)) { // XML based (HTML/XML/XAML)
  9971. $mime = 'text/html';
  9972. $imgmime = 'html.png';
  9973. $srclang = 'html';
  9974. $famime = 'file-alt';
  9975. } elseif (preg_match('/\.(xml|xhtml)$/i', $tmpfile)) {
  9976. $mime = 'text/xml';
  9977. $imgmime = 'other.png';
  9978. $srclang = 'xml';
  9979. $famime = 'file-alt';
  9980. } elseif (preg_match('/\.xaml$/i', $tmpfile)) {
  9981. $mime = 'text/xml';
  9982. $imgmime = 'other.png';
  9983. $srclang = 'xaml';
  9984. $famime = 'file-alt';
  9985. } elseif (preg_match('/\.bas$/i', $tmpfile)) { // Languages
  9986. $mime = 'text/plain';
  9987. $imgmime = 'text.png';
  9988. $srclang = 'bas';
  9989. $famime = 'file-code';
  9990. } elseif (preg_match('/\.(c)$/i', $tmpfile)) {
  9991. $mime = 'text/plain';
  9992. $imgmime = 'text.png';
  9993. $srclang = 'c';
  9994. $famime = 'file-code';
  9995. } elseif (preg_match('/\.(cpp)$/i', $tmpfile)) {
  9996. $mime = 'text/plain';
  9997. $imgmime = 'text.png';
  9998. $srclang = 'cpp';
  9999. $famime = 'file-code';
  10000. } elseif (preg_match('/\.cs$/i', $tmpfile)) {
  10001. $mime = 'text/plain';
  10002. $imgmime = 'text.png';
  10003. $srclang = 'cs';
  10004. $famime = 'file-code';
  10005. } elseif (preg_match('/\.(h)$/i', $tmpfile)) {
  10006. $mime = 'text/plain';
  10007. $imgmime = 'text.png';
  10008. $srclang = 'h';
  10009. $famime = 'file-code';
  10010. } elseif (preg_match('/\.(java|jsp)$/i', $tmpfile)) {
  10011. $mime = 'text/plain';
  10012. $imgmime = 'text.png';
  10013. $srclang = 'java';
  10014. $famime = 'file-code';
  10015. } elseif (preg_match('/\.php([0-9]{1})?$/i', $tmpfile)) {
  10016. $mime = 'text/plain';
  10017. $imgmime = 'php.png';
  10018. $srclang = 'php';
  10019. $famime = 'file-code';
  10020. } elseif (preg_match('/\.phtml$/i', $tmpfile)) {
  10021. $mime = 'text/plain';
  10022. $imgmime = 'php.png';
  10023. $srclang = 'php';
  10024. $famime = 'file-code';
  10025. } elseif (preg_match('/\.(pl|pm)$/i', $tmpfile)) {
  10026. $mime = 'text/plain';
  10027. $imgmime = 'pl.png';
  10028. $srclang = 'perl';
  10029. $famime = 'file-code';
  10030. } elseif (preg_match('/\.sql$/i', $tmpfile)) {
  10031. $mime = 'text/plain';
  10032. $imgmime = 'text.png';
  10033. $srclang = 'sql';
  10034. $famime = 'file-code';
  10035. } elseif (preg_match('/\.js$/i', $tmpfile)) {
  10036. $mime = 'text/x-javascript';
  10037. $imgmime = 'jscript.png';
  10038. $srclang = 'js';
  10039. $famime = 'file-code';
  10040. } elseif (preg_match('/\.odp$/i', $tmpfile)) { // Open office
  10041. $mime = 'application/vnd.oasis.opendocument.presentation';
  10042. $imgmime = 'ooffice.png';
  10043. $famime = 'file-powerpoint';
  10044. } elseif (preg_match('/\.ods$/i', $tmpfile)) {
  10045. $mime = 'application/vnd.oasis.opendocument.spreadsheet';
  10046. $imgmime = 'ooffice.png';
  10047. $famime = 'file-excel';
  10048. } elseif (preg_match('/\.odt$/i', $tmpfile)) {
  10049. $mime = 'application/vnd.oasis.opendocument.text';
  10050. $imgmime = 'ooffice.png';
  10051. $famime = 'file-word';
  10052. } elseif (preg_match('/\.mdb$/i', $tmpfile)) { // MS Office
  10053. $mime = 'application/msaccess';
  10054. $imgmime = 'mdb.png';
  10055. $famime = 'file';
  10056. } elseif (preg_match('/\.doc[xm]?$/i', $tmpfile)) {
  10057. $mime = 'application/msword';
  10058. $imgmime = 'doc.png';
  10059. $famime = 'file-word';
  10060. } elseif (preg_match('/\.dot[xm]?$/i', $tmpfile)) {
  10061. $mime = 'application/msword';
  10062. $imgmime = 'doc.png';
  10063. $famime = 'file-word';
  10064. } elseif (preg_match('/\.xlt(x)?$/i', $tmpfile)) {
  10065. $mime = 'application/vnd.ms-excel';
  10066. $imgmime = 'xls.png';
  10067. $famime = 'file-excel';
  10068. } elseif (preg_match('/\.xla(m)?$/i', $tmpfile)) {
  10069. $mime = 'application/vnd.ms-excel';
  10070. $imgmime = 'xls.png';
  10071. $famime = 'file-excel';
  10072. } elseif (preg_match('/\.xls$/i', $tmpfile)) {
  10073. $mime = 'application/vnd.ms-excel';
  10074. $imgmime = 'xls.png';
  10075. $famime = 'file-excel';
  10076. } elseif (preg_match('/\.xls[bmx]$/i', $tmpfile)) {
  10077. $mime = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet';
  10078. $imgmime = 'xls.png';
  10079. $famime = 'file-excel';
  10080. } elseif (preg_match('/\.pps[mx]?$/i', $tmpfile)) {
  10081. $mime = 'application/vnd.ms-powerpoint';
  10082. $imgmime = 'ppt.png';
  10083. $famime = 'file-powerpoint';
  10084. } elseif (preg_match('/\.ppt[mx]?$/i', $tmpfile)) {
  10085. $mime = 'application/x-mspowerpoint';
  10086. $imgmime = 'ppt.png';
  10087. $famime = 'file-powerpoint';
  10088. } elseif (preg_match('/\.pdf$/i', $tmpfile)) { // Other
  10089. $mime = 'application/pdf';
  10090. $imgmime = 'pdf.png';
  10091. $famime = 'file-pdf';
  10092. } elseif (preg_match('/\.bat$/i', $tmpfile)) { // Scripts
  10093. $mime = 'text/x-bat';
  10094. $imgmime = 'script.png';
  10095. $srclang = 'dos';
  10096. $famime = 'file-code';
  10097. } elseif (preg_match('/\.sh$/i', $tmpfile)) {
  10098. $mime = 'text/x-sh';
  10099. $imgmime = 'script.png';
  10100. $srclang = 'bash';
  10101. $famime = 'file-code';
  10102. } elseif (preg_match('/\.ksh$/i', $tmpfile)) {
  10103. $mime = 'text/x-ksh';
  10104. $imgmime = 'script.png';
  10105. $srclang = 'bash';
  10106. $famime = 'file-code';
  10107. } elseif (preg_match('/\.bash$/i', $tmpfile)) {
  10108. $mime = 'text/x-bash';
  10109. $imgmime = 'script.png';
  10110. $srclang = 'bash';
  10111. $famime = 'file-code';
  10112. } elseif (preg_match('/\.ico$/i', $tmpfile)) { // Images
  10113. $mime = 'image/x-icon';
  10114. $imgmime = 'image.png';
  10115. $famime = 'file-image';
  10116. } elseif (preg_match('/\.(jpg|jpeg)$/i', $tmpfile)) {
  10117. $mime = 'image/jpeg';
  10118. $imgmime = 'image.png';
  10119. $famime = 'file-image';
  10120. } elseif (preg_match('/\.png$/i', $tmpfile)) {
  10121. $mime = 'image/png';
  10122. $imgmime = 'image.png';
  10123. $famime = 'file-image';
  10124. } elseif (preg_match('/\.gif$/i', $tmpfile)) {
  10125. $mime = 'image/gif';
  10126. $imgmime = 'image.png';
  10127. $famime = 'file-image';
  10128. } elseif (preg_match('/\.bmp$/i', $tmpfile)) {
  10129. $mime = 'image/bmp';
  10130. $imgmime = 'image.png';
  10131. $famime = 'file-image';
  10132. } elseif (preg_match('/\.(tif|tiff)$/i', $tmpfile)) {
  10133. $mime = 'image/tiff';
  10134. $imgmime = 'image.png';
  10135. $famime = 'file-image';
  10136. } elseif (preg_match('/\.svg$/i', $tmpfile)) {
  10137. $mime = 'image/svg+xml';
  10138. $imgmime = 'image.png';
  10139. $famime = 'file-image';
  10140. } elseif (preg_match('/\.webp$/i', $tmpfile)) {
  10141. $mime = 'image/webp';
  10142. $imgmime = 'image.png';
  10143. $famime = 'file-image';
  10144. } elseif (preg_match('/\.vcs$/i', $tmpfile)) { // Calendar
  10145. $mime = 'text/calendar';
  10146. $imgmime = 'other.png';
  10147. $famime = 'file-alt';
  10148. } elseif (preg_match('/\.ics$/i', $tmpfile)) {
  10149. $mime = 'text/calendar';
  10150. $imgmime = 'other.png';
  10151. $famime = 'file-alt';
  10152. } elseif (preg_match('/\.torrent$/i', $tmpfile)) { // Other
  10153. $mime = 'application/x-bittorrent';
  10154. $imgmime = 'other.png';
  10155. $famime = 'file-o';
  10156. } elseif (preg_match('/\.(mp3|ogg|au|wav|wma|mid)$/i', $tmpfile)) { // Audio
  10157. $mime = 'audio';
  10158. $imgmime = 'audio.png';
  10159. $famime = 'file-audio';
  10160. } elseif (preg_match('/\.mp4$/i', $tmpfile)) { // Video
  10161. $mime = 'video/mp4';
  10162. $imgmime = 'video.png';
  10163. $famime = 'file-video';
  10164. } elseif (preg_match('/\.ogv$/i', $tmpfile)) {
  10165. $mime = 'video/ogg';
  10166. $imgmime = 'video.png';
  10167. $famime = 'file-video';
  10168. } elseif (preg_match('/\.webm$/i', $tmpfile)) {
  10169. $mime = 'video/webm';
  10170. $imgmime = 'video.png';
  10171. $famime = 'file-video';
  10172. } elseif (preg_match('/\.avi$/i', $tmpfile)) {
  10173. $mime = 'video/x-msvideo';
  10174. $imgmime = 'video.png';
  10175. $famime = 'file-video';
  10176. } elseif (preg_match('/\.divx$/i', $tmpfile)) {
  10177. $mime = 'video/divx';
  10178. $imgmime = 'video.png';
  10179. $famime = 'file-video';
  10180. } elseif (preg_match('/\.xvid$/i', $tmpfile)) {
  10181. $mime = 'video/xvid';
  10182. $imgmime = 'video.png';
  10183. $famime = 'file-video';
  10184. } elseif (preg_match('/\.(wmv|mpg|mpeg)$/i', $tmpfile)) {
  10185. $mime = 'video';
  10186. $imgmime = 'video.png';
  10187. $famime = 'file-video';
  10188. } elseif (preg_match('/\.(zip|rar|gz|tgz|z|cab|bz2|7z|tar|lzh|zst)$/i', $tmpfile)) { // Archive
  10189. // application/xxx where zzz is zip, ...
  10190. $mime = 'archive';
  10191. $imgmime = 'archive.png';
  10192. $famime = 'file-archive';
  10193. } elseif (preg_match('/\.(exe|com)$/i', $tmpfile)) { // Exe
  10194. $mime = 'application/octet-stream';
  10195. $imgmime = 'other.png';
  10196. $famime = 'file-o';
  10197. } elseif (preg_match('/\.(dll|lib|o|so|a)$/i', $tmpfile)) { // Lib
  10198. $mime = 'library';
  10199. $imgmime = 'library.png';
  10200. $famime = 'file-o';
  10201. } elseif (preg_match('/\.err$/i', $tmpfile)) { // phpcs:ignore
  10202. $mime = 'error';
  10203. $imgmime = 'error.png';
  10204. $famime = 'file-alt';
  10205. }
  10206. // Return mimetype string
  10207. switch ((int) $mode) {
  10208. case 1:
  10209. $tmp = explode('/', $mime);
  10210. return (!empty($tmp[1]) ? $tmp[1] : $tmp[0]);
  10211. case 2:
  10212. return $imgmime;
  10213. case 3:
  10214. return $srclang;
  10215. case 4:
  10216. return $famime;
  10217. }
  10218. return $mime;
  10219. }
  10220. /**
  10221. * Return the value of a filed into a dictionary for the record $id.
  10222. * This also set all the values into a cache for a next search.
  10223. *
  10224. * @param string $tablename Name of table dictionary (without the MAIN_DB_PREFIX, example: 'c_holiday_types')
  10225. * @param string $field The name of field where to find the value to return
  10226. * @param int $id Id of line record
  10227. * @param bool $checkentity Add filter on entity
  10228. * @param string $rowidfield Name of the column rowid (to use for the filter on $id)
  10229. * @return string The value of field $field. This also set $dictvalues cache.
  10230. */
  10231. function getDictionaryValue($tablename, $field, $id, $checkentity = false, $rowidfield = 'rowid')
  10232. {
  10233. global $conf, $db;
  10234. $tablename = preg_replace('/^'.preg_quote(MAIN_DB_PREFIX, '/').'/', '', $tablename); // Clean name of table for backward compatibility.
  10235. $dictvalues = (isset($conf->cache['dictvalues_'.$tablename]) ? $conf->cache['dictvalues_'.$tablename] : null);
  10236. if (is_null($dictvalues)) {
  10237. $dictvalues = array();
  10238. $sql = "SELECT * FROM ".MAIN_DB_PREFIX.$tablename." WHERE 1 = 1"; // Here select * is allowed as it is generic code and we don't have list of fields
  10239. if ($checkentity) {
  10240. $sql .= ' AND entity IN (0,'.getEntity($tablename).')';
  10241. }
  10242. $resql = $db->query($sql);
  10243. if ($resql) {
  10244. while ($obj = $db->fetch_object($resql)) {
  10245. $dictvalues[$obj->$rowidfield] = $obj; // $obj is stdClass
  10246. }
  10247. } else {
  10248. dol_print_error($db);
  10249. }
  10250. $conf->cache['dictvalues_'.$tablename] = $dictvalues;
  10251. }
  10252. if (!empty($dictvalues[$id])) {
  10253. // Found
  10254. $tmp = $dictvalues[$id];
  10255. return (property_exists($tmp, $field) ? $tmp->$field : '');
  10256. } else {
  10257. // Not found
  10258. return '';
  10259. }
  10260. }
  10261. /**
  10262. * Return true if the color is light
  10263. *
  10264. * @param string $stringcolor String with hex (FFFFFF) or comma RGB ('255,255,255')
  10265. * @return int -1 : Error with argument passed |0 : color is dark | 1 : color is light
  10266. */
  10267. function colorIsLight($stringcolor)
  10268. {
  10269. $stringcolor = str_replace('#', '', $stringcolor);
  10270. $res = -1;
  10271. if (!empty($stringcolor)) {
  10272. $res = 0;
  10273. $tmp = explode(',', $stringcolor);
  10274. if (count($tmp) > 1) { // This is a comma RGB ('255','255','255')
  10275. $r = $tmp[0];
  10276. $g = $tmp[1];
  10277. $b = $tmp[2];
  10278. } else {
  10279. $hexr = $stringcolor[0].$stringcolor[1];
  10280. $hexg = $stringcolor[2].$stringcolor[3];
  10281. $hexb = $stringcolor[4].$stringcolor[5];
  10282. $r = hexdec($hexr);
  10283. $g = hexdec($hexg);
  10284. $b = hexdec($hexb);
  10285. }
  10286. $bright = (max($r, $g, $b) + min($r, $g, $b)) / 510.0; // HSL algorithm
  10287. if ($bright > 0.6) {
  10288. $res = 1;
  10289. }
  10290. }
  10291. return $res;
  10292. }
  10293. /**
  10294. * Function to test if an entry is enabled or not
  10295. *
  10296. * @param string $type_user 0=We test for internal user, 1=We test for external user
  10297. * @param array $menuentry Array for feature entry to test
  10298. * @param array $listofmodulesforexternal Array with list of modules allowed to external users
  10299. * @return int 0=Hide, 1=Show, 2=Show gray
  10300. */
  10301. function isVisibleToUserType($type_user, &$menuentry, &$listofmodulesforexternal)
  10302. {
  10303. global $conf;
  10304. //print 'type_user='.$type_user.' module='.$menuentry['module'].' enabled='.$menuentry['enabled'].' perms='.$menuentry['perms'];
  10305. //print 'ok='.in_array($menuentry['module'], $listofmodulesforexternal);
  10306. if (empty($menuentry['enabled'])) {
  10307. return 0; // Entry disabled by condition
  10308. }
  10309. if ($type_user && $menuentry['module']) {
  10310. $tmploops = explode('|', $menuentry['module']);
  10311. $found = 0;
  10312. foreach ($tmploops as $tmploop) {
  10313. if (in_array($tmploop, $listofmodulesforexternal)) {
  10314. $found++;
  10315. break;
  10316. }
  10317. }
  10318. if (!$found) {
  10319. return 0; // Entry is for menus all excluded to external users
  10320. }
  10321. }
  10322. if (!$menuentry['perms'] && $type_user) {
  10323. return 0; // No permissions and user is external
  10324. }
  10325. if (!$menuentry['perms'] && getDolGlobalString('MAIN_MENU_HIDE_UNAUTHORIZED')) {
  10326. return 0; // No permissions and option to hide when not allowed, even for internal user, is on
  10327. }
  10328. if (!$menuentry['perms']) {
  10329. return 2; // No permissions and user is external
  10330. }
  10331. return 1;
  10332. }
  10333. /**
  10334. * Round to next multiple.
  10335. *
  10336. * @param double $n Number to round up
  10337. * @param integer $x Multiple. For example 60 to round up to nearest exact minute for a date with seconds.
  10338. * @return integer Value rounded.
  10339. */
  10340. function roundUpToNextMultiple($n, $x = 5)
  10341. {
  10342. return (ceil($n) % $x === 0) ? ceil($n) : round(($n + $x / 2) / $x) * $x;
  10343. }
  10344. /**
  10345. * Function dolGetBadge
  10346. *
  10347. * @param string $label label of badge no html : use in alt attribute for accessibility
  10348. * @param string $html optional : label of badge with html
  10349. * @param string $type type of badge : Primary Secondary Success Danger Warning Info Light Dark status0 status1 status2 status3 status4 status5 status6 status7 status8 status9
  10350. * @param string $mode default '' , 'pill', 'dot'
  10351. * @param string $url the url for link
  10352. * @param array $params various params for future : recommended rather than adding more fuction arguments. array('attr'=>array('title'=>'abc'))
  10353. * @return string Html badge
  10354. */
  10355. function dolGetBadge($label, $html = '', $type = 'primary', $mode = '', $url = '', $params = array())
  10356. {
  10357. $attr = array(
  10358. 'class'=>'badge '.(!empty($mode) ? ' badge-'.$mode : '').(!empty($type) ? ' badge-'.$type : '').(empty($params['css']) ? '' : ' '.$params['css'])
  10359. );
  10360. if (empty($html)) {
  10361. $html = $label;
  10362. }
  10363. if (!empty($url)) {
  10364. $attr['href'] = $url;
  10365. }
  10366. if ($mode === 'dot') {
  10367. $attr['class'] .= ' classfortooltip';
  10368. $attr['title'] = $html;
  10369. $attr['aria-label'] = $label;
  10370. $html = '';
  10371. }
  10372. // Override attr
  10373. if (!empty($params['attr']) && is_array($params['attr'])) {
  10374. foreach ($params['attr'] as $key => $value) {
  10375. if ($key == 'class') {
  10376. $attr['class'] .= ' '.$value;
  10377. } elseif ($key == 'classOverride') {
  10378. $attr['class'] = $value;
  10379. } else {
  10380. $attr[$key] = $value;
  10381. }
  10382. }
  10383. }
  10384. // TODO: add hook
  10385. // escape all attribute
  10386. $attr = array_map('dol_escape_htmltag', $attr);
  10387. $TCompiledAttr = array();
  10388. foreach ($attr as $key => $value) {
  10389. $TCompiledAttr[] = $key.'="'.$value.'"';
  10390. }
  10391. $compiledAttributes = !empty($TCompiledAttr) ? implode(' ', $TCompiledAttr) : '';
  10392. $tag = !empty($url) ? 'a' : 'span';
  10393. return '<'.$tag.' '.$compiledAttributes.'>'.$html.'</'.$tag.'>';
  10394. }
  10395. /**
  10396. * Output the badge of a status.
  10397. *
  10398. * @param string $statusLabel Label of badge no html : use in alt attribute for accessibility
  10399. * @param string $statusLabelShort Short label of badge no html
  10400. * @param string $html Optional : label of badge with html
  10401. * @param string $statusType status0 status1 status2 status3 status4 status5 status6 status7 status8 status9 : image name or badge name
  10402. * @param int $displayMode 0=Long label, 1=Short label, 2=Picto + Short label, 3=Picto, 4=Picto + Long label, 5=Short label + Picto, 6=Long label + Picto
  10403. * @param string $url The url for link
  10404. * @param array $params Various params. Example: array('tooltip'=>'no|...', 'badgeParams'=>...)
  10405. * @return string Html status string
  10406. */
  10407. function dolGetStatus($statusLabel = '', $statusLabelShort = '', $html = '', $statusType = 'status0', $displayMode = 0, $url = '', $params = array())
  10408. {
  10409. global $conf;
  10410. $return = '';
  10411. $dolGetBadgeParams = array();
  10412. if (!empty($params['badgeParams'])) {
  10413. $dolGetBadgeParams = $params['badgeParams'];
  10414. }
  10415. // TODO : add a hook
  10416. if ($displayMode == 0) {
  10417. $return = !empty($html) ? $html : (empty($conf->dol_optimize_smallscreen) ? $statusLabel : (empty($statusLabelShort) ? $statusLabel : $statusLabelShort));
  10418. } elseif ($displayMode == 1) {
  10419. $return = !empty($html) ? $html : (empty($statusLabelShort) ? $statusLabel : $statusLabelShort);
  10420. } elseif (getDolGlobalString('MAIN_STATUS_USES_IMAGES')) {
  10421. // Use status with images (for backward compatibility)
  10422. $return = '';
  10423. $htmlLabel = (in_array($displayMode, array(1, 2, 5)) ? '<span class="hideonsmartphone">' : '').(!empty($html) ? $html : $statusLabel).(in_array($displayMode, array(1, 2, 5)) ? '</span>' : '');
  10424. $htmlLabelShort = (in_array($displayMode, array(1, 2, 5)) ? '<span class="hideonsmartphone">' : '').(!empty($html) ? $html : (!empty($statusLabelShort) ? $statusLabelShort : $statusLabel)).(in_array($displayMode, array(1, 2, 5)) ? '</span>' : '');
  10425. // For small screen, we always use the short label instead of long label.
  10426. if (!empty($conf->dol_optimize_smallscreen)) {
  10427. if ($displayMode == 0) {
  10428. $displayMode = 1;
  10429. } elseif ($displayMode == 4) {
  10430. $displayMode = 2;
  10431. } elseif ($displayMode == 6) {
  10432. $displayMode = 5;
  10433. }
  10434. }
  10435. // For backward compatibility. Image's filename are still in French, so we use this array to convert
  10436. $statusImg = array(
  10437. 'status0' => 'statut0',
  10438. 'status1' => 'statut1',
  10439. 'status2' => 'statut2',
  10440. 'status3' => 'statut3',
  10441. 'status4' => 'statut4',
  10442. 'status5' => 'statut5',
  10443. 'status6' => 'statut6',
  10444. 'status7' => 'statut7',
  10445. 'status8' => 'statut8',
  10446. 'status9' => 'statut9'
  10447. );
  10448. if (!empty($statusImg[$statusType])) {
  10449. $htmlImg = img_picto($statusLabel, $statusImg[$statusType]);
  10450. } else {
  10451. $htmlImg = img_picto($statusLabel, $statusType);
  10452. }
  10453. if ($displayMode === 2) {
  10454. $return = $htmlImg.' '.$htmlLabelShort;
  10455. } elseif ($displayMode === 3) {
  10456. $return = $htmlImg;
  10457. } elseif ($displayMode === 4) {
  10458. $return = $htmlImg.' '.$htmlLabel;
  10459. } elseif ($displayMode === 5) {
  10460. $return = $htmlLabelShort.' '.$htmlImg;
  10461. } else { // $displayMode >= 6
  10462. $return = $htmlLabel.' '.$htmlImg;
  10463. }
  10464. } elseif (!getDolGlobalString('MAIN_STATUS_USES_IMAGES') && !empty($displayMode)) {
  10465. // Use new badge
  10466. $statusLabelShort = (empty($statusLabelShort) ? $statusLabel : $statusLabelShort);
  10467. $dolGetBadgeParams['attr']['class'] = 'badge-status';
  10468. $dolGetBadgeParams['attr']['title'] = empty($params['tooltip']) ? $statusLabel : ($params['tooltip'] != 'no' ? $params['tooltip'] : '');
  10469. if ($displayMode == 3) {
  10470. $return = dolGetBadge((empty($conf->dol_optimize_smallscreen) ? $statusLabel : (empty($statusLabelShort) ? $statusLabel : $statusLabelShort)), '', $statusType, 'dot', $url, $dolGetBadgeParams);
  10471. } elseif ($displayMode === 5) {
  10472. $return = dolGetBadge($statusLabelShort, $html, $statusType, '', $url, $dolGetBadgeParams);
  10473. } else {
  10474. $return = dolGetBadge((empty($conf->dol_optimize_smallscreen) ? $statusLabel : (empty($statusLabelShort) ? $statusLabel : $statusLabelShort)), $html, $statusType, '', $url, $dolGetBadgeParams);
  10475. }
  10476. }
  10477. return $return;
  10478. }
  10479. /**
  10480. * Function dolGetButtonAction
  10481. *
  10482. * @param string $label Label or tooltip of button if $text is provided. Also used as tooltip in title attribute. Can be escaped HTML content or full simple text.
  10483. * @param string $text Optional : short label on button. Can be escaped HTML content or full simple text.
  10484. * @param string $actionType 'default', 'danger', 'email', 'clone', 'cancel', 'delete', ...
  10485. * @param string|array $url Url for link or array of subbutton description ('label'=>, 'url'=>, 'lang'=>, 'perm'=> )
  10486. * Example when an array is used: $arrayforbutaction = array(
  10487. * 10 => array('lang'=>'propal', 'enabled'=>isModEnabled("propal"), 'perm'=>$user->hasRight('propal', 'creer'), 'label' => 'AddProp', 'url'=>'/comm/propal/card.php?action=create&amp;projectid='.$object->id.'&amp;socid='.$object->socid),
  10488. * 20 => array('lang'=>'orders', 'enabled'=>isModEnabled("commande"), 'perm'=>$user->hasRight('commande', 'creer'), 'label' => 'CreateOrder', 'url'=>'/commande/card.php?action=create&amp;projectid='.$object->id.'&amp;socid='.$object->socid),
  10489. * 30 => array('lang'=>'bills', 'enabled'=>isModEnabled("facture"), 'perm'=>$user->hasRight('facture', 'creer'), 'label' => 'CreateBill', 'url'=>'/compta/facture/card.php?action=create&amp;projectid='.$object->id.'&amp;socid='.$object->socid),
  10490. * );
  10491. * @param string $id Attribute id of action button. Example 'action-delete'. This can be used for full ajax confirm if this code is reused into the ->formconfirm() method.
  10492. * @param int|boolean $userRight User action right
  10493. * // phpcs:disable
  10494. * @param array $params = [ // Various params for future : recommended rather than adding more function arguments
  10495. * 'attr' => [ // to add or override button attributes
  10496. * 'xxxxx' => '', // your xxxxx attribute you want
  10497. * 'class' => 'reposition', // to add more css class to the button class attribute
  10498. * 'classOverride' => '' // to replace class attribute of the button
  10499. * ],
  10500. * 'confirm' => [
  10501. * 'url' => 'http://', // Overide Url to go when user click on action btn, if empty default url is $url.?confirm=yes, for no js compatibility use $url for fallback confirm.
  10502. * 'title' => '', // Overide title of modal, if empty default title use "ConfirmBtnCommonTitle" lang key
  10503. * 'action-btn-label' => '', // Overide label of action button, if empty default label use "Confirm" lang key
  10504. * 'cancel-btn-label' => '', // Overide label of cancel button, if empty default label use "CloseDialog" lang key
  10505. * 'content' => '', // Overide text of content, if empty default content use "ConfirmBtnCommonContent" lang key
  10506. * 'modal' => true, // true|false to display dialog as a modal (with dark background)
  10507. * 'isDropDrown' => false, // true|false to display dialog as a dropdown (with dark background)
  10508. * ],
  10509. * ]
  10510. * // phpcs:enable
  10511. * @return string html button
  10512. */
  10513. function dolGetButtonAction($label, $text = '', $actionType = 'default', $url = '', $id = '', $userRight = 1, $params = array())
  10514. {
  10515. global $hookmanager, $action, $object, $langs;
  10516. // If $url is an array, we must build a dropdown button
  10517. if (is_array($url)) {
  10518. $out = '';
  10519. if (count($url) > 1) {
  10520. $out .= '<div class="dropdown inline-block dropdown-holder">';
  10521. $out .= '<a style="margin-right: auto;" class="dropdown-toggle classfortooltip butAction'.($userRight ? '' : 'Refused').'" title="'.dol_escape_htmltag($label).'" data-toggle="dropdown">'.($text ? $text : $label).'</a>';
  10522. $out .= '<div class="dropdown-content">';
  10523. foreach ($url as $subbutton) {
  10524. if (!empty($subbutton['lang'])) {
  10525. $langs->load($subbutton['lang']);
  10526. }
  10527. $tmpurl = DOL_URL_ROOT.$subbutton['url'].(empty($params['backtopage']) ? '' : '&amp;backtopage='.urlencode($params['backtopage']));
  10528. $out .= dolGetButtonAction('', $langs->trans($subbutton['label']), 'default', $tmpurl, '', $subbutton['perm'], array('isDropDown' => true));
  10529. }
  10530. $out .= "</div>";
  10531. $out .= "</div>";
  10532. } else {
  10533. foreach ($url as $subbutton) { // Should loop on 1 record only
  10534. if (!empty($subbutton['lang'])) {
  10535. $langs->load($subbutton['lang']);
  10536. }
  10537. $tmpurl = DOL_URL_ROOT.$subbutton['url'].(empty($params['backtopage']) ? '' : '&amp;backtopage='.urlencode($params['backtopage']));
  10538. $out .= dolGetButtonAction('', $langs->trans($subbutton['label']), 'default', $tmpurl, '', $subbutton['perm']);
  10539. }
  10540. }
  10541. return $out;
  10542. }
  10543. // Here, $url is a simple link
  10544. if (!empty($params['isDropdown'])) {
  10545. $class = "dropdown-item";
  10546. } else {
  10547. $class = 'butAction';
  10548. if ($actionType == 'danger' || $actionType == 'delete') {
  10549. $class = 'butActionDelete';
  10550. if (!empty($url) && strpos($url, 'token=') === false) {
  10551. $url .= '&token='.newToken();
  10552. }
  10553. }
  10554. }
  10555. $attr = array(
  10556. 'class' => $class,
  10557. 'href' => empty($url) ? '' : $url,
  10558. 'title' => $label
  10559. );
  10560. if (empty($text)) {
  10561. $text = $label;
  10562. $attr['title'] = ''; // if html not set, leave label on title is redundant
  10563. } else {
  10564. $attr['title'] = $label;
  10565. $attr['aria-label'] = $label;
  10566. }
  10567. if (empty($userRight)) {
  10568. $attr['class'] = 'butActionRefused';
  10569. $attr['href'] = '';
  10570. $attr['title'] = (($label && $text && $label != $text) ? $label : $langs->trans('NotEnoughPermissions'));
  10571. }
  10572. if (!empty($id)) {
  10573. $attr['id'] = $id;
  10574. }
  10575. // Override attr
  10576. if (!empty($params['attr']) && is_array($params['attr'])) {
  10577. foreach ($params['attr'] as $key => $value) {
  10578. if ($key == 'class') {
  10579. $attr['class'] .= ' '.$value;
  10580. } elseif ($key == 'classOverride') {
  10581. $attr['class'] = $value;
  10582. } else {
  10583. $attr[$key] = $value;
  10584. }
  10585. }
  10586. }
  10587. // automatic add tooltip when title is detected
  10588. if (!empty($attr['title']) && !empty($attr['class']) && strpos($attr['class'], 'classfortooltip') === false) {
  10589. $attr['class'].= ' classfortooltip';
  10590. }
  10591. // Js Confirm button
  10592. if ($userRight && !empty($params['confirm'])) {
  10593. if (!is_array($params['confirm'])) {
  10594. $params['confirm'] = array();
  10595. }
  10596. if (empty($params['confirm']['url'])) {
  10597. $params['confirm']['url'] = $url . (strpos($url, '?') > 0 ? '&' : '?') . 'confirm=yes';
  10598. }
  10599. // for js desabled compatibility set $url as call to confirm action and $params['confirm']['url'] to confirmed action
  10600. $attr['data-confirm-url'] = $params['confirm']['url'];
  10601. $attr['data-confirm-title'] = !empty($params['confirm']['title']) ? $params['confirm']['title'] : $langs->trans('ConfirmBtnCommonTitle', $label);
  10602. $attr['data-confirm-content'] = !empty($params['confirm']['content']) ? $params['confirm']['content'] : $langs->trans('ConfirmBtnCommonContent', $label);
  10603. $attr['data-confirm-content'] = preg_replace("/\r|\n/", "", $attr['data-confirm-content']);
  10604. $attr['data-confirm-action-btn-label'] = !empty($params['confirm']['action-btn-label']) ? $params['confirm']['action-btn-label'] : $langs->trans('Confirm');
  10605. $attr['data-confirm-cancel-btn-label'] = !empty($params['confirm']['cancel-btn-label']) ? $params['confirm']['cancel-btn-label'] : $langs->trans('CloseDialog');
  10606. $attr['data-confirm-modal'] = !empty($params['confirm']['modal']) ? $params['confirm']['modal'] : true;
  10607. $attr['class'].= ' butActionConfirm';
  10608. }
  10609. if (isset($attr['href']) && empty($attr['href'])) {
  10610. unset($attr['href']);
  10611. }
  10612. // escape all attribute
  10613. $attr = array_map('dol_escape_htmltag', $attr);
  10614. $TCompiledAttr = array();
  10615. foreach ($attr as $key => $value) {
  10616. $TCompiledAttr[] = $key.'= "'.$value.'"';
  10617. }
  10618. $compiledAttributes = empty($TCompiledAttr) ? '' : implode(' ', $TCompiledAttr);
  10619. $tag = !empty($attr['href']) ? 'a' : 'span';
  10620. $parameters = array(
  10621. 'TCompiledAttr' => $TCompiledAttr, // array
  10622. 'compiledAttributes' => $compiledAttributes, // string
  10623. 'attr' => $attr,
  10624. 'tag' => $tag,
  10625. 'label' => $label,
  10626. 'html' => $text,
  10627. 'actionType' => $actionType,
  10628. 'url' => $url,
  10629. 'id' => $id,
  10630. 'userRight' => $userRight,
  10631. 'params' => $params
  10632. );
  10633. $reshook = $hookmanager->executeHooks('dolGetButtonAction', $parameters, $object, $action); // Note that $action and $object may have been modified by some hooks
  10634. if ($reshook < 0) {
  10635. setEventMessages($hookmanager->error, $hookmanager->errors, 'errors');
  10636. }
  10637. if (empty($reshook)) {
  10638. if (dol_textishtml($text)) { // If content already HTML encoded
  10639. return '<' . $tag . ' ' . $compiledAttributes . '>' . $text . '</' . $tag . '>';
  10640. } else {
  10641. return '<' . $tag . ' ' . $compiledAttributes . '>' . dol_escape_htmltag($text) . '</' . $tag . '>';
  10642. }
  10643. } else {
  10644. return $hookmanager->resPrint;
  10645. }
  10646. }
  10647. /**
  10648. * Add space between dolGetButtonTitle
  10649. *
  10650. * @param string $moreClass more css class label
  10651. * @return string html of title separator
  10652. */
  10653. function dolGetButtonTitleSeparator($moreClass = "")
  10654. {
  10655. return '<span class="button-title-separator '.$moreClass.'" ></span>';
  10656. }
  10657. /**
  10658. * get field error icon
  10659. *
  10660. * @param string $fieldValidationErrorMsg message to add in tooltip
  10661. * @return string html output
  10662. */
  10663. function getFieldErrorIcon($fieldValidationErrorMsg)
  10664. {
  10665. $out = '';
  10666. if (!empty($fieldValidationErrorMsg)) {
  10667. $out.= '<span class="field-error-icon classfortooltip" title="'.dol_escape_htmltag($fieldValidationErrorMsg, 1).'" role="alert" >'; // role alert is used for accessibility
  10668. $out.= '<span class="fa fa-exclamation-circle" aria-hidden="true" ></span>'; // For accessibility icon is separated and aria-hidden
  10669. $out.= '</span>';
  10670. }
  10671. return $out;
  10672. }
  10673. /**
  10674. * Function dolGetButtonTitle : this kind of buttons are used in title in list
  10675. *
  10676. * @param string $label label of button
  10677. * @param string $helpText optional : content for help tooltip
  10678. * @param string $iconClass class for icon element (Example: 'fa fa-file')
  10679. * @param string $url the url for link
  10680. * @param string $id attribute id of button
  10681. * @param int $status 0 no user rights, 1 active, 2 current action or selected, -1 Feature Disabled, -2 disable Other reason use param $helpText as tooltip help
  10682. * @param array $params various params for future : recommended rather than adding more function arguments
  10683. * @return string html button
  10684. */
  10685. function dolGetButtonTitle($label, $helpText = '', $iconClass = 'fa fa-file', $url = '', $id = '', $status = 1, $params = array())
  10686. {
  10687. global $langs, $conf, $user;
  10688. // Actually this conf is used in css too for external module compatibility and smooth transition to this function
  10689. if (getDolGlobalString('MAIN_BUTTON_HIDE_UNAUTHORIZED') && (!$user->admin) && $status <= 0) {
  10690. return '';
  10691. }
  10692. $class = 'btnTitle';
  10693. if (in_array($iconClass, array('fa fa-plus-circle', 'fa fa-plus-circle size15x', 'fa fa-comment-dots', 'fa fa-paper-plane'))) {
  10694. $class .= ' btnTitlePlus';
  10695. }
  10696. $useclassfortooltip = 1;
  10697. if (!empty($params['morecss'])) {
  10698. $class .= ' '.$params['morecss'];
  10699. }
  10700. $attr = array(
  10701. 'class' => $class,
  10702. 'href' => empty($url) ? '' : $url
  10703. );
  10704. if (!empty($helpText)) {
  10705. $attr['title'] = dol_escape_htmltag($helpText);
  10706. } elseif (empty($attr['title']) && $label) {
  10707. $attr['title'] = $label;
  10708. $useclassfortooltip = 0;
  10709. }
  10710. if ($status == 2) {
  10711. $attr['class'] .= ' btnTitleSelected';
  10712. } elseif ($status <= 0) {
  10713. $attr['class'] .= ' refused';
  10714. $attr['href'] = '';
  10715. if ($status == -1) { // disable
  10716. $attr['title'] = dol_escape_htmltag($langs->transnoentitiesnoconv("FeatureDisabled"));
  10717. } elseif ($status == 0) { // Not enough permissions
  10718. $attr['title'] = dol_escape_htmltag($langs->transnoentitiesnoconv("NotEnoughPermissions"));
  10719. }
  10720. }
  10721. if (!empty($attr['title']) && $useclassfortooltip) {
  10722. $attr['class'] .= ' classfortooltip';
  10723. }
  10724. if (!empty($id)) {
  10725. $attr['id'] = $id;
  10726. }
  10727. // Override attr
  10728. if (!empty($params['attr']) && is_array($params['attr'])) {
  10729. foreach ($params['attr'] as $key => $value) {
  10730. if ($key == 'class') {
  10731. $attr['class'] .= ' '.$value;
  10732. } elseif ($key == 'classOverride') {
  10733. $attr['class'] = $value;
  10734. } else {
  10735. $attr[$key] = $value;
  10736. }
  10737. }
  10738. }
  10739. if (isset($attr['href']) && empty($attr['href'])) {
  10740. unset($attr['href']);
  10741. }
  10742. // TODO : add a hook
  10743. // escape all attribute
  10744. $attr = array_map('dol_escape_htmltag', $attr);
  10745. $TCompiledAttr = array();
  10746. foreach ($attr as $key => $value) {
  10747. $TCompiledAttr[] = $key.'="'.$value.'"';
  10748. }
  10749. $compiledAttributes = (empty($TCompiledAttr) ? '' : implode(' ', $TCompiledAttr));
  10750. $tag = (empty($attr['href']) ? 'span' : 'a');
  10751. $button = '<'.$tag.' '.$compiledAttributes.'>';
  10752. $button .= '<span class="'.$iconClass.' valignmiddle btnTitle-icon"></span>';
  10753. if (!empty($params['forcenohideoftext'])) {
  10754. $button .= '<span class="valignmiddle text-plus-circle btnTitle-label'.(empty($params['forcenohideoftext']) ? ' hideonsmartphone' : '').'">'.$label.'</span>';
  10755. }
  10756. $button .= '</'.$tag.'>';
  10757. return $button;
  10758. }
  10759. /**
  10760. * Get an array with properties of an element.
  10761. *
  10762. * @param string $element_type Element type (Value of $object->element). Example:
  10763. * 'action', 'facture', 'project', 'project_task' or
  10764. * 'myobject@mymodule' or
  10765. * 'myobject_mysubobject' (where mymodule = myobject, like 'project_task')
  10766. * @return array array('module'=>, 'classpath'=>, 'element'=>, 'subelement'=>, 'classfile'=>, 'classname'=>, 'dir_output'=>)
  10767. * @see fetchObjectByElement()
  10768. */
  10769. function getElementProperties($element_type)
  10770. {
  10771. global $conf;
  10772. $regs = array();
  10773. //$element_type='facture';
  10774. $classfile = $classname = $classpath = $subdir = $dir_output = '';
  10775. // Parse element/subelement
  10776. $module = $element_type;
  10777. $element = $element_type;
  10778. $subelement = $element_type;
  10779. $table_element = $element_type;
  10780. // If we ask a resource form external module (instead of default path)
  10781. if (preg_match('/^([^@]+)@([^@]+)$/i', $element_type, $regs)) { // 'myobject@mymodule'
  10782. $element = $subelement = $regs[1];
  10783. $module = $regs[2];
  10784. }
  10785. // If we ask a resource for a string with an element and a subelement
  10786. // Example 'project_task'
  10787. if (preg_match('/^([^_]+)_([^_]+)/i', $element, $regs)) { // 'myobject_mysubobject' with myobject=mymodule
  10788. $module = $element = $regs[1];
  10789. $subelement = $regs[2];
  10790. }
  10791. // For compatibility and to work with non standard path
  10792. if ($element_type == "action") {
  10793. $classpath = 'comm/action/class';
  10794. $subelement = 'Actioncomm';
  10795. $module = 'agenda';
  10796. $table_element = 'actioncomm';
  10797. } elseif ($element_type == 'cronjob') {
  10798. $classpath = 'cron/class';
  10799. $module = 'cron';
  10800. $table_element = 'cron';
  10801. } elseif ($element_type == 'adherent_type') {
  10802. $classpath = 'adherents/class';
  10803. $classfile = 'adherent_type';
  10804. $module = 'adherent';
  10805. $subelement = 'adherent_type';
  10806. $classname = 'AdherentType';
  10807. $table_element = 'adherent_type';
  10808. } elseif ($element_type == 'bank_account') {
  10809. $classpath = 'compta/bank/class';
  10810. $module = 'bank'; // We need $conf->bank->dir_output and not $conf->banque->dir_output
  10811. $classfile = 'account';
  10812. $classname = 'Account';
  10813. } elseif ($element_type == 'category') {
  10814. $classpath = 'categories/class';
  10815. $module = 'categorie';
  10816. $subelement = 'categorie';
  10817. $table_element = 'categorie';
  10818. } elseif ($element_type == 'contact') {
  10819. $classpath = 'contact/class';
  10820. $classfile = 'contact';
  10821. $module = 'societe';
  10822. $subelement = 'contact';
  10823. $table_element = 'socpeople';
  10824. } elseif ($element_type == 'inventory') {
  10825. $module = 'product';
  10826. $classpath = 'product/inventory/class';
  10827. } elseif ($element_type == 'stock') {
  10828. $classpath = 'product/stock/class';
  10829. $classfile = 'entrepot';
  10830. $classname = 'Entrepot';
  10831. $table_element = 'entrepot';
  10832. } elseif ($element_type == 'project') {
  10833. $classpath = 'projet/class';
  10834. $module = 'projet';
  10835. $table_element = 'projet';
  10836. } elseif ($element_type == 'project_task') {
  10837. $classpath = 'projet/class';
  10838. $module = 'projet';
  10839. $subelement = 'task';
  10840. $table_element = 'projet_task';
  10841. } elseif ($element_type == 'facture' || $element_type == 'invoice') {
  10842. $classpath = 'compta/facture/class';
  10843. $module = 'facture';
  10844. $subelement = 'facture';
  10845. $table_element = 'facture';
  10846. } elseif ($element_type == 'commande' || $element_type == 'order') {
  10847. $classpath = 'commande/class';
  10848. $module = 'commande';
  10849. $subelement = 'commande';
  10850. $table_element = 'commande';
  10851. } elseif ($element_type == 'propal') {
  10852. $classpath = 'comm/propal/class';
  10853. $table_element = 'propal';
  10854. } elseif ($element_type == 'shipping') {
  10855. $classpath = 'expedition/class';
  10856. $classfile = 'expedition';
  10857. $classname = 'Expedition';
  10858. $module = 'expedition';
  10859. $table_element = 'expedition';
  10860. } elseif ($element_type == 'supplier_proposal') {
  10861. $classpath = 'supplier_proposal/class';
  10862. $module = 'supplier_proposal';
  10863. $element = 'supplierproposal';
  10864. $classfile = 'supplier_proposal';
  10865. $subelement = 'supplierproposal';
  10866. } elseif ($element_type == 'shipping') {
  10867. $classpath = 'expedition/class';
  10868. $subelement = 'expedition';
  10869. $module = 'expedition_bon';
  10870. } elseif ($element_type == 'delivery') {
  10871. $classpath = 'delivery/class';
  10872. $subelement = 'delivery';
  10873. $module = 'expedition';
  10874. } elseif ($element_type == 'contract') {
  10875. $classpath = 'contrat/class';
  10876. $module = 'contrat';
  10877. $subelement = 'contrat';
  10878. $table_element = 'contract';
  10879. } elseif ($element_type == 'mailing') {
  10880. $classpath = 'comm/mailing/class';
  10881. $module = 'mailing';
  10882. $classfile = 'mailing';
  10883. $classname = 'Mailing';
  10884. $subelement = '';
  10885. } elseif ($element_type == 'member') {
  10886. $classpath = 'adherents/class';
  10887. $module = 'adherent';
  10888. $subelement = 'adherent';
  10889. $table_element = 'adherent';
  10890. } elseif ($element_type == 'usergroup') {
  10891. $classpath = 'user/class';
  10892. $module = 'user';
  10893. } elseif ($element_type == 'mo') {
  10894. $classpath = 'mrp/class';
  10895. $classfile = 'mo';
  10896. $classname = 'Mo';
  10897. $module = 'mrp';
  10898. $subelement = '';
  10899. $table_element = 'mrp_mo';
  10900. } elseif ($element_type == 'cabinetmed_cons') {
  10901. $classpath = 'cabinetmed/class';
  10902. $module = 'cabinetmed';
  10903. $subelement = 'cabinetmedcons';
  10904. $table_element = 'cabinetmedcons';
  10905. } elseif ($element_type == 'fichinter') {
  10906. $classpath = 'fichinter/class';
  10907. $module = 'ficheinter';
  10908. $subelement = 'fichinter';
  10909. $table_element = 'fichinter';
  10910. } elseif ($element_type == 'dolresource' || $element_type == 'resource') {
  10911. $classpath = 'resource/class';
  10912. $module = 'resource';
  10913. $subelement = 'dolresource';
  10914. $table_element = 'resource';
  10915. } elseif ($element_type == 'propaldet') {
  10916. $classpath = 'comm/propal/class';
  10917. $module = 'propal';
  10918. $subelement = 'propaleligne';
  10919. } elseif ($element_type == 'opensurvey_sondage') {
  10920. $classpath = 'opensurvey/class';
  10921. $module = 'opensurvey';
  10922. $subelement = 'opensurveysondage';
  10923. } elseif ($element_type == 'order_supplier') {
  10924. $classpath = 'fourn/class';
  10925. $module = 'fournisseur';
  10926. $classfile = 'fournisseur.commande';
  10927. $element = 'order_supplier';
  10928. $subelement = '';
  10929. $classname = 'CommandeFournisseur';
  10930. $table_element = 'commande_fournisseur';
  10931. } elseif ($element_type == 'invoice_supplier') {
  10932. $classpath = 'fourn/class';
  10933. $module = 'fournisseur';
  10934. $classfile = 'fournisseur.facture';
  10935. $element = 'invoice_supplier';
  10936. $subelement = '';
  10937. $classname = 'FactureFournisseur';
  10938. $table_element = 'facture_fourn';
  10939. } elseif ($element_type == "service") {
  10940. $classpath = 'product/class';
  10941. $subelement = 'product';
  10942. $table_element = 'product';
  10943. } elseif ($element_type == 'salary') {
  10944. $classpath = 'salaries/class';
  10945. $module = 'salaries';
  10946. } elseif ($element_type == 'payment_salary') {
  10947. $classpath = 'salaries/class';
  10948. $classfile = 'paymentsalary';
  10949. $classname = 'PaymentSalary';
  10950. $module = 'salaries';
  10951. } elseif ($element_type == 'productlot') {
  10952. $module = 'productbatch';
  10953. $classpath = 'product/stock/class';
  10954. $classfile = 'productlot';
  10955. $classname = 'Productlot';
  10956. $element = 'productlot';
  10957. $subelement = '';
  10958. $table_element = 'product_lot';
  10959. } elseif ($element_type == 'websitepage') {
  10960. $classpath = 'website/class';
  10961. $classfile = 'websitepage';
  10962. $classname = 'Websitepage';
  10963. $module = 'website';
  10964. $subelement = 'websitepage';
  10965. $table_element = 'website_page';
  10966. } elseif ($element_type == 'fiscalyear') {
  10967. $classpath = 'core/class';
  10968. $module = 'accounting';
  10969. $subelement = 'fiscalyear';
  10970. } elseif ($element_type == 'chargesociales') {
  10971. $classpath = 'compta/sociales/class';
  10972. $module = 'tax';
  10973. $table_element = 'chargesociales';
  10974. } elseif ($element_type == 'tva') {
  10975. $classpath = 'compta/tva/class';
  10976. $module = 'tax';
  10977. $subdir = '/vat';
  10978. $table_element = 'tva';
  10979. } elseif ($element_type == 'emailsenderprofile') {
  10980. $module = '';
  10981. $classpath = 'core/class';
  10982. $classfile = 'emailsenderprofile';
  10983. $classname = 'EmailSenderProfile';
  10984. $table_element = 'c_email_senderprofile';
  10985. $subelement = '';
  10986. }
  10987. if (empty($classfile)) {
  10988. $classfile = strtolower($subelement);
  10989. }
  10990. if (empty($classname)) {
  10991. $classname = ucfirst($subelement);
  10992. }
  10993. if (empty($classpath)) {
  10994. $classpath = $module.'/class';
  10995. }
  10996. //print 'getElementProperties subdir='.$subdir;
  10997. // Set dir_output
  10998. if ($module && isset($conf->$module)) { // The generic case
  10999. if (!empty($conf->$module->multidir_output[$conf->entity])) {
  11000. $dir_output = $conf->$module->multidir_output[$conf->entity];
  11001. } elseif (!empty($conf->$module->output[$conf->entity])) {
  11002. $dir_output = $conf->$module->output[$conf->entity];
  11003. } elseif (!empty($conf->$module->dir_output)) {
  11004. $dir_output = $conf->$module->dir_output;
  11005. }
  11006. }
  11007. // Overwrite value for special cases
  11008. if ($element == 'order_supplier') {
  11009. $dir_output = $conf->fournisseur->commande->dir_output;
  11010. } elseif ($element == 'invoice_supplier') {
  11011. $dir_output = $conf->fournisseur->facture->dir_output;
  11012. }
  11013. $dir_output .= $subdir;
  11014. $element_properties = array(
  11015. 'module' => $module,
  11016. 'element' => $element,
  11017. 'table_element' => $table_element,
  11018. 'subelement' => $subelement,
  11019. 'classpath' => $classpath,
  11020. 'classfile' => $classfile,
  11021. 'classname' => $classname,
  11022. 'dir_output' => $dir_output
  11023. );
  11024. //var_dump($element_properties);
  11025. return $element_properties;
  11026. }
  11027. /**
  11028. * Fetch an object from its id and element_type
  11029. * Inclusion of classes is automatic
  11030. *
  11031. * @param int $element_id Element id (Use this or element_id but not both)
  11032. * @param string $element_type Element type ('module' or 'myobject@mymodule' or 'mymodule_myobject')
  11033. * @param string $element_ref Element ref (Use this or element_id but not both)
  11034. * @return int|object object || 0 || <0 if error
  11035. * @see getElementProperties()
  11036. */
  11037. function fetchObjectByElement($element_id, $element_type, $element_ref = '')
  11038. {
  11039. global $db;
  11040. $ret = 0;
  11041. $element_prop = getElementProperties($element_type);
  11042. if ($element_prop['module'] == 'product' || $element_prop['module'] == 'service') {
  11043. // For example, for an extrafield 'product' (shared for both product and service) that is a link to an object,
  11044. // this is called with $element_type = 'product' when we need element properties of a service, we must return a product. If we create the
  11045. // extrafield for a service, it is not supported and not found when editing the product/service card. So we must keep 'product' for extrafields
  11046. // of service and we will return properties of a product.
  11047. $ismodenabled = (isModEnabled('product') || isModEnabled('service'));
  11048. } else {
  11049. $ismodenabled = isModEnabled($element_prop['module']);
  11050. }
  11051. if (is_array($element_prop) && (empty($element_prop['module']) || $ismodenabled)) {
  11052. dol_include_once('/'.$element_prop['classpath'].'/'.$element_prop['classfile'].'.class.php');
  11053. if (class_exists($element_prop['classname'])) {
  11054. $classname = $element_prop['classname'];
  11055. $objecttmp = new $classname($db);
  11056. if ($element_id > 0 || !empty($element_ref)) {
  11057. $ret = $objecttmp->fetch($element_id, $element_ref);
  11058. if ($ret >= 0) {
  11059. if (empty($objecttmp->module)) {
  11060. $objecttmp->module = $element_prop['module'];
  11061. }
  11062. return $objecttmp;
  11063. }
  11064. } else {
  11065. return $objecttmp; // returned an object without fetch
  11066. }
  11067. } else {
  11068. return -1;
  11069. }
  11070. }
  11071. return $ret;
  11072. }
  11073. /**
  11074. * Return if a file can contains executable content
  11075. *
  11076. * @param string $filename File name to test
  11077. * @return boolean True if yes, False if no
  11078. */
  11079. function isAFileWithExecutableContent($filename)
  11080. {
  11081. if (preg_match('/\.(htm|html|js|phar|php|php\d+|phtml|pht|pl|py|cgi|ksh|sh|shtml|bash|bat|cmd|wpk|exe|dmg)$/i', $filename)) {
  11082. return true;
  11083. }
  11084. return false;
  11085. }
  11086. /**
  11087. * Return the value of token currently saved into session with name 'newtoken'.
  11088. * This token must be send by any POST as it will be used by next page for comparison with value in session.
  11089. *
  11090. * @since Dolibarr v10.0.7
  11091. * @return string
  11092. */
  11093. function newToken()
  11094. {
  11095. return empty($_SESSION['newtoken']) ? '' : $_SESSION['newtoken'];
  11096. }
  11097. /**
  11098. * Return the value of token currently saved into session with name 'token'.
  11099. * For ajax call, you must use this token as a parameter of the call into the js calling script (the called ajax php page must also set constant NOTOKENRENEWAL).
  11100. *
  11101. * @since Dolibarr v10.0.7
  11102. * @return string
  11103. */
  11104. function currentToken()
  11105. {
  11106. return isset($_SESSION['token']) ? $_SESSION['token'] : '';
  11107. }
  11108. /**
  11109. * Return a random string to be used as a nonce value for js
  11110. *
  11111. * @return string
  11112. */
  11113. function getNonce()
  11114. {
  11115. global $conf;
  11116. if (empty($conf->cache['nonce'])) {
  11117. $conf->cache['nonce'] = dolGetRandomBytes(8);
  11118. }
  11119. return $conf->cache['nonce'];
  11120. }
  11121. /**
  11122. * Start a table with headers and a optinal clickable number (don't forget to use "finishSimpleTable()" after the last table row)
  11123. *
  11124. * @param string $header The first left header of the table (automatic translated)
  11125. * @param string $link (optional) The link to a internal dolibarr page, when click on the number (without the first "/")
  11126. * @param string $arguments (optional) Additional arguments for the link (e.g. "search_status=0")
  11127. * @param integer $emptyRows (optional) The count of empty rows after the first header
  11128. * @param integer $number (optional) The number that is shown right after the first header, when not set the link is shown on the right side of the header as "FullList"
  11129. * @return void
  11130. *
  11131. * @see finishSimpleTable()
  11132. */
  11133. function startSimpleTable($header, $link = "", $arguments = "", $emptyRows = 0, $number = -1)
  11134. {
  11135. global $langs;
  11136. print '<div class="div-table-responsive-no-min">';
  11137. print '<table class="noborder centpercent">';
  11138. print '<tr class="liste_titre">';
  11139. print $emptyRows < 1 ? '<th>' : '<th colspan="'.($emptyRows + 1).'">';
  11140. print $langs->trans($header);
  11141. // extra space between the first header and the number
  11142. if ($number > -1) {
  11143. print ' ';
  11144. }
  11145. if (!empty($link)) {
  11146. if (!empty($arguments)) {
  11147. print '<a href="'.DOL_URL_ROOT.'/'.$link.'?'.$arguments.'">';
  11148. } else {
  11149. print '<a href="'.DOL_URL_ROOT.'/'.$link.'">';
  11150. }
  11151. }
  11152. if ($number > -1) {
  11153. print '<span class="badge">'.$number.'</span>';
  11154. }
  11155. if (!empty($link)) {
  11156. print '</a>';
  11157. }
  11158. print '</th>';
  11159. if ($number < 0 && !empty($link)) {
  11160. print '<th class="right">';
  11161. if (!empty($arguments)) {
  11162. print '<a class="commonlink" href="'.DOL_URL_ROOT.'/'.$link.'?'.$arguments.'">';
  11163. } else {
  11164. print '<a class="commonlink" href="'.DOL_URL_ROOT.'/'.$link.'">';
  11165. }
  11166. print $langs->trans("FullList");
  11167. print '</a>';
  11168. print '</th>';
  11169. }
  11170. print '</tr>';
  11171. }
  11172. /**
  11173. * Add the correct HTML close tags for "startSimpleTable(...)" (use after the last table line)
  11174. *
  11175. * @param bool $addLineBreak (optional) Add a extra line break after the complete table (\<br\>)
  11176. * @return void
  11177. *
  11178. * @see startSimpleTable()
  11179. */
  11180. function finishSimpleTable($addLineBreak = false)
  11181. {
  11182. print '</table>';
  11183. print '</div>';
  11184. if ($addLineBreak) {
  11185. print '<br>';
  11186. }
  11187. }
  11188. /**
  11189. * Add a summary line to the current open table ("None", "XMoreLines" or "Total xxx")
  11190. *
  11191. * @param integer $tableColumnCount The complete count columns of the table
  11192. * @param integer $num The count of the rows of the table, when it is zero (0) the "$noneWord" is shown instead
  11193. * @param integer $nbofloop (optional) The maximum count of rows thaht the table show (when it is zero (0) no summary line will show, expect "$noneWord" when $num === 0)
  11194. * @param integer $total (optional) The total value thaht is shown after when the table has minimum of one entire
  11195. * @param string $noneWord (optional) The word that is shown when the table has no entires ($num === 0)
  11196. * @param boolean $extraRightColumn (optional) Add a addtional column after the summary word and total number
  11197. * @return void
  11198. */
  11199. function addSummaryTableLine($tableColumnCount, $num, $nbofloop = 0, $total = 0, $noneWord = "None", $extraRightColumn = false)
  11200. {
  11201. global $langs;
  11202. if ($num === 0) {
  11203. print '<tr class="oddeven">';
  11204. print '<td colspan="'.$tableColumnCount.'"><span class="opacitymedium">'.$langs->trans($noneWord).'</span></td>';
  11205. print '</tr>';
  11206. return;
  11207. }
  11208. if ($nbofloop === 0) {
  11209. // don't show a summary line
  11210. return;
  11211. }
  11212. if ($num === 0) {
  11213. $colspan = $tableColumnCount;
  11214. } elseif ($num > $nbofloop) {
  11215. $colspan = $tableColumnCount;
  11216. } else {
  11217. $colspan = $tableColumnCount - 1;
  11218. }
  11219. if ($extraRightColumn) {
  11220. $colspan--;
  11221. }
  11222. print '<tr class="liste_total">';
  11223. if ($nbofloop > 0 && $num > $nbofloop) {
  11224. print '<td colspan="'.$colspan.'" class="right">'.$langs->trans("XMoreLines", ($num - $nbofloop)).'</td>';
  11225. } else {
  11226. print '<td colspan="'.$colspan.'" class="right"> '.$langs->trans("Total").'</td>';
  11227. print '<td class="right centpercent">'.price($total).'</td>';
  11228. }
  11229. if ($extraRightColumn) {
  11230. print '<td></td>';
  11231. }
  11232. print '</tr>';
  11233. }
  11234. /**
  11235. * Return a file on output using a low memory. It can return very large files with no need of memory.
  11236. * WARNING: This close output buffers.
  11237. *
  11238. * @param string $fullpath_original_file_osencoded Full path of file to return.
  11239. * @param int $method -1 automatic, 0=readfile, 1=fread, 2=stream_copy_to_stream
  11240. * @return void
  11241. */
  11242. function readfileLowMemory($fullpath_original_file_osencoded, $method = -1)
  11243. {
  11244. if ($method == -1) {
  11245. $method = 0;
  11246. if (getDolGlobalString('MAIN_FORCE_READFILE_WITH_FREAD')) {
  11247. $method = 1;
  11248. }
  11249. if (getDolGlobalString('MAIN_FORCE_READFILE_WITH_STREAM_COPY')) {
  11250. $method = 2;
  11251. }
  11252. }
  11253. // Be sure we don't have output buffering enabled to have readfile working correctly
  11254. while (ob_get_level()) {
  11255. ob_end_flush();
  11256. }
  11257. // Solution 0
  11258. if ($method == 0) {
  11259. readfile($fullpath_original_file_osencoded);
  11260. } elseif ($method == 1) {
  11261. // Solution 1
  11262. $handle = fopen($fullpath_original_file_osencoded, "rb");
  11263. while (!feof($handle)) {
  11264. print fread($handle, 8192);
  11265. }
  11266. fclose($handle);
  11267. } elseif ($method == 2) {
  11268. // Solution 2
  11269. $handle1 = fopen($fullpath_original_file_osencoded, "rb");
  11270. $handle2 = fopen("php://output", "wb");
  11271. stream_copy_to_stream($handle1, $handle2);
  11272. fclose($handle1);
  11273. fclose($handle2);
  11274. }
  11275. }
  11276. /**
  11277. * Create a button to copy $valuetocopy in the clipboard (for copy and paste feature).
  11278. * Code that handle the click is inside core/js/lib_foot.js.php.
  11279. *
  11280. * @param string $valuetocopy The value to print
  11281. * @param int $showonlyonhover Show the copy-paste button only on hover
  11282. * @param string $texttoshow Replace the value to show with this text. Use 'none' to show no text (only the copy-paste picto)
  11283. * @return string The string to print for the button
  11284. */
  11285. function showValueWithClipboardCPButton($valuetocopy, $showonlyonhover = 1, $texttoshow = '')
  11286. {
  11287. /*
  11288. global $conf;
  11289. if (!empty($conf->dol_no_mouse_hover)) {
  11290. $showonlyonhover = 0;
  11291. }*/
  11292. $tag = 'span'; // Using div (like any style of type 'block') does not work when using the js copy code.
  11293. if ($texttoshow === 'none') {
  11294. $result = '<span class="clipboardCP'.($showonlyonhover ? ' clipboardCPShowOnHover' : '').'"><'.$tag.' class="clipboardCPValue hidewithsize">'.dol_escape_htmltag($valuetocopy, 1, 1).'</'.$tag.'><span class="clipboardCPValueToPrint"></span><span class="clipboardCPButton far fa-clipboard opacitymedium paddingleft paddingright"></span><span class="clipboardCPText"></span></span>';
  11295. } elseif ($texttoshow) {
  11296. $result = '<span class="clipboardCP'.($showonlyonhover ? ' clipboardCPShowOnHover' : '').'"><'.$tag.' class="clipboardCPValue hidewithsize">'.dol_escape_htmltag($valuetocopy, 1, 1).'</'.$tag.'><span class="clipboardCPValueToPrint">'.dol_escape_htmltag($texttoshow, 1, 1).'</span><span class="clipboardCPButton far fa-clipboard opacitymedium paddingleft paddingright"></span><span class="clipboardCPText"></span></span>';
  11297. } else {
  11298. $result = '<span class="clipboardCP'.($showonlyonhover ? ' clipboardCPShowOnHover' : '').'"><'.$tag.' class="clipboardCPValue">'.dol_escape_htmltag($valuetocopy, 1, 1).'</'.$tag.'><span class="clipboardCPButton far fa-clipboard opacitymedium paddingleft paddingright"></span><span class="clipboardCPText"></span></span>';
  11299. }
  11300. return $result;
  11301. }
  11302. /**
  11303. * Decode an encode string. The string can be encoded in json format (recommended) or with serialize (avoid this)
  11304. *
  11305. * @param string $stringtodecode String to decode (json or serialize coded)
  11306. * @return mixed The decoded object.
  11307. */
  11308. function jsonOrUnserialize($stringtodecode)
  11309. {
  11310. $result = json_decode($stringtodecode);
  11311. if ($result === null) {
  11312. $result = unserialize($stringtodecode);
  11313. }
  11314. return $result;
  11315. }
  11316. /**
  11317. * forgeSQLFromUniversalSearchCriteria
  11318. *
  11319. * @param string $filter String with universal search string. Must be '(aaa:bbb:...) OR (ccc:ddd:...) ...' with
  11320. * aaa is a field name (with alias or not) and
  11321. * bbb is one of this operator '=', '<', '>', '<=', '>=', '!=', 'in', 'notin', 'like', 'notlike', 'is', 'isnot'.
  11322. * Example: '((client:=:1) OR ((client:>=:2) AND (client:<=:3))) AND (client:!=:8) AND (nom:like:'a%')'
  11323. * @param string $errorstr Error message string
  11324. * @param int $noand 1=Do not add the AND before the condition string.
  11325. * @param int $nopar 1=Do not add the perenthesis around the condition string.
  11326. * @param int $noerror 1=If search criteria is not valid, does not return an error string but invalidate the SQL
  11327. * @return string Return forged SQL string
  11328. */
  11329. function forgeSQLFromUniversalSearchCriteria($filter, &$errorstr = '', $noand = 0, $nopar = 0, $noerror = 0)
  11330. {
  11331. if (!preg_match('/^\(.*\)$/', $filter)) { // If $filter does not start and end with ()
  11332. $filter = '(' . $filter . ')';
  11333. }
  11334. $regexstring = '\(([a-zA-Z0-9_\.]+:[<>!=insotlke]+:[^\(\)]+)\)'; // Must be (aaa:bbb:...) with aaa is a field name (with alias or not) and bbb is one of this operator '=', '<', '>', '<=', '>=', '!=', 'in', 'notin', 'like', 'notlike', 'is', 'isnot'
  11335. if (!dolCheckFilters($filter, $errorstr)) {
  11336. if ($noerror) {
  11337. return '1 = 2';
  11338. } else {
  11339. return 'Filter syntax error - '.$errorstr; // Bad balance of parenthesis, we return an error message or force a SQL not found
  11340. }
  11341. }
  11342. // Test the filter syntax
  11343. $t = preg_replace_callback('/'.$regexstring.'/i', 'dolForgeDummyCriteriaCallback', $filter);
  11344. $t = str_replace(array('and','or','AND','OR',' '), '', $t); // Remove the only strings allowed between each () criteria
  11345. // If the string result contains something else than '()', the syntax was wrong
  11346. if (preg_match('/[^\(\)]/', $t)) {
  11347. $errorstr = 'Bad syntax of the search string';
  11348. if ($noerror) {
  11349. return '1 = 2';
  11350. } else {
  11351. return 'Filter syntax error - '.$errorstr; // Bad syntax of the search string, we return an error message or force a SQL not found
  11352. }
  11353. }
  11354. return ($noand ? "" : " AND ").($nopar ? "" : '(').preg_replace_callback('/'.$regexstring.'/i', 'dolForgeCriteriaCallback', $filter).($nopar ? "" : ')');
  11355. }
  11356. /**
  11357. * Return if a $sqlfilters parameter has a valid balance of parenthesis
  11358. *
  11359. * @param string $sqlfilters sqlfilter string
  11360. * @param string $error Error message
  11361. * @return boolean True if valid, False if not valid ($error is filled with the reason in such a case)
  11362. */
  11363. function dolCheckFilters($sqlfilters, &$error = '')
  11364. {
  11365. //$regexstring='\(([^:\'\(\)]+:[^:\'\(\)]+:[^:\(\)]+)\)';
  11366. //$tmp=preg_replace_all('/'.$regexstring.'/', '', $sqlfilters);
  11367. $tmp = $sqlfilters;
  11368. $i = 0;
  11369. $nb = strlen($tmp);
  11370. $counter = 0;
  11371. while ($i < $nb) {
  11372. if ($tmp[$i] == '(') {
  11373. $counter++;
  11374. }
  11375. if ($tmp[$i] == ')') {
  11376. $counter--;
  11377. }
  11378. if ($counter < 0) {
  11379. $error = "Wrond balance of parenthesis in sqlfilters=".$sqlfilters;
  11380. dol_syslog($error, LOG_WARNING);
  11381. return false;
  11382. }
  11383. $i++;
  11384. }
  11385. return true;
  11386. }
  11387. /**
  11388. * Function to forge a SQL criteria from a Dolibarr filter syntax string.
  11389. * This method is called by forgeSQLFromUniversalSearchCriteria()
  11390. *
  11391. * @param array $matches Array of found string by regex search. Example: "t.ref:like:'SO-%'" or "t.date_creation:<:'20160101'" or "t.nature:is:NULL"
  11392. * @return string Forged criteria. Example: "" or "()"
  11393. */
  11394. function dolForgeDummyCriteriaCallback($matches)
  11395. {
  11396. //dol_syslog("Convert matches ".$matches[1]);
  11397. if (empty($matches[1])) {
  11398. return '';
  11399. }
  11400. $tmp = explode(':', $matches[1]);
  11401. if (count($tmp) < 3) {
  11402. return '';
  11403. }
  11404. return '()'; // An empty criteria
  11405. }
  11406. /**
  11407. * Function to forge a SQL criteria from a Dolibarr filter syntax string.
  11408. * This method is called by forgeSQLFromUniversalSearchCriteria()
  11409. *
  11410. * @param array $matches Array of found string by regex search.
  11411. * Example: "t.ref:like:'SO-%'" or "t.date_creation:<:'20160101'" or "t.date_creation:<:'2016-01-01 12:30:00'" or "t.nature:is:NULL"
  11412. * @return string Forged criteria. Example: "t.field LIKE 'abc%'"
  11413. */
  11414. function dolForgeCriteriaCallback($matches)
  11415. {
  11416. global $db;
  11417. //dol_syslog("Convert matches ".$matches[1]);
  11418. if (empty($matches[1])) {
  11419. return '';
  11420. }
  11421. $tmp = explode(':', $matches[1]);
  11422. if (count($tmp) < 3) {
  11423. return '';
  11424. }
  11425. $operand = preg_replace('/[^a-z0-9\._]/i', '', trim($tmp[0]));
  11426. $operator = strtoupper(preg_replace('/[^a-z<>!=]/i', '', trim($tmp[1])));
  11427. $realOperator = [
  11428. 'NOTLIKE' => 'NOT LIKE',
  11429. 'ISNOT' => 'IS NOT',
  11430. 'NOTIN' => 'NOT IN',
  11431. '!=' => '<>',
  11432. ];
  11433. if (array_key_exists($operator, $realOperator)) {
  11434. $operator = $realOperator[$operator];
  11435. }
  11436. $tmpescaped = $tmp[2];
  11437. $regbis = array();
  11438. if ($operator == 'IN' || $operator == 'NOT IN') { // IN is allowed for list of ID or code only
  11439. //if (!preg_match('/^\(.*\)$/', $tmpescaped)) {
  11440. $tmpescaped2 = '(';
  11441. // Explode and sanitize each element in list
  11442. $tmpelemarray = explode(',', $tmpescaped);
  11443. foreach ($tmpelemarray as $tmpkey => $tmpelem) {
  11444. $reg = array();
  11445. if (preg_match('/^\'(.*)\'$/', $tmpelem, $reg)) {
  11446. $tmpelemarray[$tmpkey] = "'".$db->escape($db->sanitize($reg[1], 1, 1, 1))."'";
  11447. } else {
  11448. $tmpelemarray[$tmpkey] = $db->escape($db->sanitize($tmpelem, 1, 1, 1));
  11449. }
  11450. }
  11451. $tmpescaped2 .= join(',', $tmpelemarray);
  11452. $tmpescaped2 .= ')';
  11453. $tmpescaped = $tmpescaped2;
  11454. } elseif ($operator == 'LIKE' || $operator == 'NOT LIKE') {
  11455. if (preg_match('/^\'(.*)\'$/', $tmpescaped, $regbis)) {
  11456. $tmpescaped = $regbis[1];
  11457. }
  11458. //$tmpescaped = "'".$db->escape($db->escapeforlike($regbis[1]))."'";
  11459. $tmpescaped = "'".$db->escape($tmpescaped)."'"; // We do not escape the _ and % so the like will works
  11460. } elseif (preg_match('/^\'(.*)\'$/', $tmpescaped, $regbis)) {
  11461. $tmpescaped = "'".$db->escape($regbis[1])."'";
  11462. } else {
  11463. if (strtoupper($tmpescaped) == 'NULL') {
  11464. $tmpescaped = 'NULL';
  11465. } elseif (is_int($tmpescaped)) {
  11466. $tmpescaped = (int) $tmpescaped;
  11467. } else {
  11468. $tmpescaped = (float) $tmpescaped;
  11469. }
  11470. }
  11471. return '('.$db->escape($operand).' '.strtoupper($operator).' '.$tmpescaped.')';
  11472. }
  11473. /**
  11474. * Get timeline icon
  11475. *
  11476. * @param ActionComm $actionstatic actioncomm
  11477. * @param array $histo histo
  11478. * @param int $key key
  11479. * @return string String with timeline icon
  11480. * @deprecated Use actioncomm->getPictoType() instead
  11481. */
  11482. function getTimelineIcon($actionstatic, &$histo, $key)
  11483. {
  11484. global $conf, $langs;
  11485. $out = '<!-- timeline icon -->'."\n";
  11486. $iconClass = 'fa fa-comments';
  11487. $img_picto = '';
  11488. $colorClass = '';
  11489. $pictoTitle = '';
  11490. if ($histo[$key]['percent'] == -1) {
  11491. $colorClass = 'timeline-icon-not-applicble';
  11492. $pictoTitle = $langs->trans('StatusNotApplicable');
  11493. } elseif ($histo[$key]['percent'] == 0) {
  11494. $colorClass = 'timeline-icon-todo';
  11495. $pictoTitle = $langs->trans('StatusActionToDo').' (0%)';
  11496. } elseif ($histo[$key]['percent'] > 0 && $histo[$key]['percent'] < 100) {
  11497. $colorClass = 'timeline-icon-in-progress';
  11498. $pictoTitle = $langs->trans('StatusActionInProcess').' ('.$histo[$key]['percent'].'%)';
  11499. } elseif ($histo[$key]['percent'] >= 100) {
  11500. $colorClass = 'timeline-icon-done';
  11501. $pictoTitle = $langs->trans('StatusActionDone').' (100%)';
  11502. }
  11503. if ($actionstatic->code == 'AC_TICKET_CREATE') {
  11504. $iconClass = 'fa fa-ticket';
  11505. } elseif ($actionstatic->code == 'AC_TICKET_MODIFY') {
  11506. $iconClass = 'fa fa-pencilxxx';
  11507. } elseif (preg_match('/^TICKET_MSG/', $actionstatic->code)) {
  11508. $iconClass = 'fa fa-comments';
  11509. } elseif (preg_match('/^TICKET_MSG_PRIVATE/', $actionstatic->code)) {
  11510. $iconClass = 'fa fa-mask';
  11511. } elseif (getDolGlobalString('AGENDA_USE_EVENT_TYPE')) {
  11512. if ($actionstatic->type_picto) {
  11513. $img_picto = img_picto('', $actionstatic->type_picto);
  11514. } else {
  11515. if ($actionstatic->type_code == 'AC_RDV') {
  11516. $iconClass = 'fa fa-handshake';
  11517. } elseif ($actionstatic->type_code == 'AC_TEL') {
  11518. $iconClass = 'fa fa-phone';
  11519. } elseif ($actionstatic->type_code == 'AC_FAX') {
  11520. $iconClass = 'fa fa-fax';
  11521. } elseif ($actionstatic->type_code == 'AC_EMAIL') {
  11522. $iconClass = 'fa fa-envelope';
  11523. } elseif ($actionstatic->type_code == 'AC_INT') {
  11524. $iconClass = 'fa fa-shipping-fast';
  11525. } elseif ($actionstatic->type_code == 'AC_OTH_AUTO') {
  11526. $iconClass = 'fa fa-robot';
  11527. } elseif (!preg_match('/_AUTO/', $actionstatic->type_code)) {
  11528. $iconClass = 'fa fa-robot';
  11529. }
  11530. }
  11531. }
  11532. $out .= '<i class="'.$iconClass.' '.$colorClass.'" title="'.$pictoTitle.'">'.$img_picto.'</i>'."\n";
  11533. return $out;
  11534. }
  11535. /**
  11536. * getActionCommEcmList
  11537. *
  11538. * @param ActionComm $object Object ActionComm
  11539. * @return array Array of documents in index table
  11540. */
  11541. function getActionCommEcmList($object)
  11542. {
  11543. global $conf, $db;
  11544. $documents = array();
  11545. $sql = 'SELECT ecm.rowid as id, ecm.src_object_type, ecm.src_object_id, ecm.filepath, ecm.filename';
  11546. $sql .= ' FROM '.MAIN_DB_PREFIX.'ecm_files ecm';
  11547. $sql .= " WHERE ecm.filepath = 'agenda/".((int) $object->id)."'";
  11548. //$sql.= " ecm.src_object_type = '".$db->escape($object->element)."' AND ecm.src_object_id = ".((int) $object->id); // Old version didn't add object_type during upload
  11549. $sql .= ' ORDER BY ecm.position ASC';
  11550. $resql = $db->query($sql);
  11551. if ($resql) {
  11552. if ($db->num_rows($resql)) {
  11553. while ($obj = $db->fetch_object($resql)) {
  11554. $documents[$obj->id] = $obj;
  11555. }
  11556. }
  11557. }
  11558. return $documents;
  11559. }
  11560. /**
  11561. * Show html area with actions in messaging format.
  11562. * Note: Global parameter $param must be defined.
  11563. *
  11564. * @param Conf $conf Object conf
  11565. * @param Translate $langs Object langs
  11566. * @param DoliDB $db Object db
  11567. * @param mixed $filterobj Filter on object Adherent|Societe|Project|Product|CommandeFournisseur|Dolresource|Ticket|... to list events linked to an object
  11568. * @param Contact $objcon Filter on object contact to filter events on a contact
  11569. * @param int $noprint Return string but does not output it
  11570. * @param string $actioncode Filter on actioncode
  11571. * @param string $donetodo Filter on event 'done' or 'todo' or ''=nofilter (all).
  11572. * @param array $filters Filter on other fields
  11573. * @param string $sortfield Sort field
  11574. * @param string $sortorder Sort order
  11575. * @return string|void Return html part or void if noprint is 1
  11576. */
  11577. function show_actions_messaging($conf, $langs, $db, $filterobj, $objcon = '', $noprint = 0, $actioncode = '', $donetodo = 'done', $filters = array(), $sortfield = 'a.datep,a.id', $sortorder = 'DESC')
  11578. {
  11579. global $user, $conf;
  11580. global $form;
  11581. global $param, $massactionbutton;
  11582. dol_include_once('/comm/action/class/actioncomm.class.php');
  11583. // Check parameters
  11584. if (!is_object($filterobj) && !is_object($objcon)) {
  11585. dol_print_error('', 'BadParameter');
  11586. }
  11587. $histo = array();
  11588. $numaction = 0;
  11589. $now = dol_now();
  11590. $sortfield_list = explode(',', $sortfield);
  11591. $sortfield_label_list = array('a.id' => 'id', 'a.datep' => 'dp', 'a.percent' => 'percent');
  11592. $sortfield_new_list = array();
  11593. foreach ($sortfield_list as $sortfield_value) {
  11594. $sortfield_new_list[] = $sortfield_label_list[trim($sortfield_value)];
  11595. }
  11596. $sortfield_new = implode(',', $sortfield_new_list);
  11597. if (isModEnabled('agenda')) {
  11598. // Search histo on actioncomm
  11599. if (is_object($objcon) && $objcon->id > 0) {
  11600. $sql = "SELECT DISTINCT a.id, a.label as label,";
  11601. } else {
  11602. $sql = "SELECT a.id, a.label as label,";
  11603. }
  11604. $sql .= " a.datep as dp,";
  11605. $sql .= " a.note as message,";
  11606. $sql .= " a.datep2 as dp2,";
  11607. $sql .= " a.percent as percent, 'action' as type,";
  11608. $sql .= " a.fk_element, a.elementtype,";
  11609. $sql .= " a.fk_contact,";
  11610. $sql .= " a.email_from as msg_from,";
  11611. $sql .= " c.code as acode, c.libelle as alabel, c.picto as apicto,";
  11612. $sql .= " u.rowid as user_id, u.login as user_login, u.photo as user_photo, u.firstname as user_firstname, u.lastname as user_lastname";
  11613. if (is_object($filterobj) && get_class($filterobj) == 'Societe') {
  11614. $sql .= ", sp.lastname, sp.firstname";
  11615. } elseif (is_object($filterobj) && get_class($filterobj) == 'Adherent') {
  11616. $sql .= ", m.lastname, m.firstname";
  11617. } elseif (is_object($filterobj) && get_class($filterobj) == 'CommandeFournisseur') {
  11618. $sql .= ", o.ref";
  11619. } elseif (is_object($filterobj) && get_class($filterobj) == 'Product') {
  11620. $sql .= ", o.ref";
  11621. } elseif (is_object($filterobj) && get_class($filterobj) == 'Ticket') {
  11622. $sql .= ", o.ref";
  11623. } elseif (is_object($filterobj) && get_class($filterobj) == 'BOM') {
  11624. $sql .= ", o.ref";
  11625. } elseif (is_object($filterobj) && get_class($filterobj) == 'Contrat') {
  11626. $sql .= ", o.ref";
  11627. }
  11628. $sql .= " FROM ".MAIN_DB_PREFIX."actioncomm as a";
  11629. $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."user as u on u.rowid = a.fk_user_action";
  11630. $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."c_actioncomm as c ON a.fk_action = c.id";
  11631. $force_filter_contact = false;
  11632. if (is_object($objcon) && $objcon->id > 0) {
  11633. $force_filter_contact = true;
  11634. $sql .= " INNER JOIN ".MAIN_DB_PREFIX."actioncomm_resources as r ON a.id = r.fk_actioncomm";
  11635. $sql .= " AND r.element_type = '".$db->escape($objcon->table_element)."' AND r.fk_element = ".((int) $objcon->id);
  11636. }
  11637. if (is_object($filterobj) && get_class($filterobj) == 'Societe') {
  11638. $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."socpeople as sp ON a.fk_contact = sp.rowid";
  11639. } elseif (is_object($filterobj) && get_class($filterobj) == 'Dolresource') {
  11640. $sql .= " INNER JOIN ".MAIN_DB_PREFIX."element_resources as er";
  11641. $sql .= " ON er.resource_type = 'dolresource'";
  11642. $sql .= " AND er.element_id = a.id";
  11643. $sql .= " AND er.resource_id = ".((int) $filterobj->id);
  11644. } elseif (is_object($filterobj) && get_class($filterobj) == 'Adherent') {
  11645. $sql .= ", ".MAIN_DB_PREFIX."adherent as m";
  11646. } elseif (is_object($filterobj) && get_class($filterobj) == 'CommandeFournisseur') {
  11647. $sql .= ", ".MAIN_DB_PREFIX."commande_fournisseur as o";
  11648. } elseif (is_object($filterobj) && get_class($filterobj) == 'Product') {
  11649. $sql .= ", ".MAIN_DB_PREFIX."product as o";
  11650. } elseif (is_object($filterobj) && get_class($filterobj) == 'Ticket') {
  11651. $sql .= ", ".MAIN_DB_PREFIX."ticket as o";
  11652. } elseif (is_object($filterobj) && get_class($filterobj) == 'BOM') {
  11653. $sql .= ", ".MAIN_DB_PREFIX."bom_bom as o";
  11654. } elseif (is_object($filterobj) && get_class($filterobj) == 'Contrat') {
  11655. $sql .= ", ".MAIN_DB_PREFIX."contrat as o";
  11656. }
  11657. $sql .= " WHERE a.entity IN (".getEntity('agenda').")";
  11658. if ($force_filter_contact === false) {
  11659. if (is_object($filterobj) && in_array(get_class($filterobj), array('Societe', 'Client', 'Fournisseur')) && $filterobj->id) {
  11660. $sql .= " AND a.fk_soc = ".((int) $filterobj->id);
  11661. } elseif (is_object($filterobj) && get_class($filterobj) == 'Project' && $filterobj->id) {
  11662. $sql .= " AND a.fk_project = ".((int) $filterobj->id);
  11663. } elseif (is_object($filterobj) && get_class($filterobj) == 'Adherent') {
  11664. $sql .= " AND a.fk_element = m.rowid AND a.elementtype = 'member'";
  11665. if ($filterobj->id) {
  11666. $sql .= " AND a.fk_element = ".((int) $filterobj->id);
  11667. }
  11668. } elseif (is_object($filterobj) && get_class($filterobj) == 'CommandeFournisseur') {
  11669. $sql .= " AND a.fk_element = o.rowid AND a.elementtype = 'order_supplier'";
  11670. if ($filterobj->id) {
  11671. $sql .= " AND a.fk_element = ".((int) $filterobj->id);
  11672. }
  11673. } elseif (is_object($filterobj) && get_class($filterobj) == 'Product') {
  11674. $sql .= " AND a.fk_element = o.rowid AND a.elementtype = 'product'";
  11675. if ($filterobj->id) {
  11676. $sql .= " AND a.fk_element = ".((int) $filterobj->id);
  11677. }
  11678. } elseif (is_object($filterobj) && get_class($filterobj) == 'Ticket') {
  11679. $sql .= " AND a.fk_element = o.rowid AND a.elementtype = 'ticket'";
  11680. if ($filterobj->id) {
  11681. $sql .= " AND a.fk_element = ".((int) $filterobj->id);
  11682. }
  11683. } elseif (is_object($filterobj) && get_class($filterobj) == 'BOM') {
  11684. $sql .= " AND a.fk_element = o.rowid AND a.elementtype = 'bom'";
  11685. if ($filterobj->id) {
  11686. $sql .= " AND a.fk_element = ".((int) $filterobj->id);
  11687. }
  11688. } elseif (is_object($filterobj) && get_class($filterobj) == 'Contrat') {
  11689. $sql .= " AND a.fk_element = o.rowid AND a.elementtype = 'contract'";
  11690. if ($filterobj->id) {
  11691. $sql .= " AND a.fk_element = ".((int) $filterobj->id);
  11692. }
  11693. }
  11694. }
  11695. // Condition on actioncode
  11696. if (!empty($actioncode)) {
  11697. if (!getDolGlobalString('AGENDA_USE_EVENT_TYPE')) {
  11698. if ($actioncode == 'AC_NON_AUTO') {
  11699. $sql .= " AND c.type != 'systemauto'";
  11700. } elseif ($actioncode == 'AC_ALL_AUTO') {
  11701. $sql .= " AND c.type = 'systemauto'";
  11702. } else {
  11703. if ($actioncode == 'AC_OTH') {
  11704. $sql .= " AND c.type != 'systemauto'";
  11705. } elseif ($actioncode == 'AC_OTH_AUTO') {
  11706. $sql .= " AND c.type = 'systemauto'";
  11707. }
  11708. }
  11709. } else {
  11710. if ($actioncode == 'AC_NON_AUTO') {
  11711. $sql .= " AND c.type != 'systemauto'";
  11712. } elseif ($actioncode == 'AC_ALL_AUTO') {
  11713. $sql .= " AND c.type = 'systemauto'";
  11714. } else {
  11715. $sql .= " AND c.code = '".$db->escape($actioncode)."'";
  11716. }
  11717. }
  11718. }
  11719. if ($donetodo == 'todo') {
  11720. $sql .= " AND ((a.percent >= 0 AND a.percent < 100) OR (a.percent = -1 AND a.datep > '".$db->idate($now)."'))";
  11721. } elseif ($donetodo == 'done') {
  11722. $sql .= " AND (a.percent = 100 OR (a.percent = -1 AND a.datep <= '".$db->idate($now)."'))";
  11723. }
  11724. if (is_array($filters) && $filters['search_agenda_label']) {
  11725. $sql .= natural_search('a.label', $filters['search_agenda_label']);
  11726. }
  11727. }
  11728. // Add also event from emailings. TODO This should be replaced by an automatic event ? May be it's too much for very large emailing.
  11729. if (isModEnabled('mailing') && !empty($objcon->email)
  11730. && (empty($actioncode) || $actioncode == 'AC_OTH_AUTO' || $actioncode == 'AC_EMAILING')) {
  11731. $langs->load("mails");
  11732. $sql2 = "SELECT m.rowid as id, m.titre as label, mc.date_envoi as dp, mc.date_envoi as dp2, '100' as percent, 'mailing' as type";
  11733. $sql2 .= ", null as fk_element, '' as elementtype, null as contact_id";
  11734. $sql2 .= ", 'AC_EMAILING' as acode, '' as alabel, '' as apicto";
  11735. $sql2 .= ", u.rowid as user_id, u.login as user_login, u.photo as user_photo, u.firstname as user_firstname, u.lastname as user_lastname"; // User that valid action
  11736. if (is_object($filterobj) && get_class($filterobj) == 'Societe') {
  11737. $sql2 .= ", '' as lastname, '' as firstname";
  11738. } elseif (is_object($filterobj) && get_class($filterobj) == 'Adherent') {
  11739. $sql2 .= ", '' as lastname, '' as firstname";
  11740. } elseif (is_object($filterobj) && get_class($filterobj) == 'CommandeFournisseur') {
  11741. $sql2 .= ", '' as ref";
  11742. } elseif (is_object($filterobj) && get_class($filterobj) == 'Product') {
  11743. $sql2 .= ", '' as ref";
  11744. } elseif (is_object($filterobj) && get_class($filterobj) == 'Ticket') {
  11745. $sql2 .= ", '' as ref";
  11746. }
  11747. $sql2 .= " FROM ".MAIN_DB_PREFIX."mailing as m, ".MAIN_DB_PREFIX."mailing_cibles as mc, ".MAIN_DB_PREFIX."user as u";
  11748. $sql2 .= " WHERE mc.email = '".$db->escape($objcon->email)."'"; // Search is done on email.
  11749. $sql2 .= " AND mc.statut = 1";
  11750. $sql2 .= " AND u.rowid = m.fk_user_valid";
  11751. $sql2 .= " AND mc.fk_mailing=m.rowid";
  11752. }
  11753. if (!empty($sql) && !empty($sql2)) {
  11754. $sql = $sql." UNION ".$sql2;
  11755. } elseif (empty($sql) && !empty($sql2)) {
  11756. $sql = $sql2;
  11757. }
  11758. // TODO Add limit in nb of results
  11759. if ($sql) { // May not be defined if module Agenda is not enabled and mailing module disabled too
  11760. $sql .= $db->order($sortfield_new, $sortorder);
  11761. dol_syslog("function.lib::show_actions_messaging", LOG_DEBUG);
  11762. $resql = $db->query($sql);
  11763. if ($resql) {
  11764. $i = 0;
  11765. $num = $db->num_rows($resql);
  11766. while ($i < $num) {
  11767. $obj = $db->fetch_object($resql);
  11768. if ($obj->type == 'action') {
  11769. $contactaction = new ActionComm($db);
  11770. $contactaction->id = $obj->id;
  11771. $result = $contactaction->fetchResources();
  11772. if ($result < 0) {
  11773. dol_print_error($db);
  11774. setEventMessage("actions.lib::show_actions_messaging Error fetch ressource", 'errors');
  11775. }
  11776. //if ($donetodo == 'todo') $sql.= " AND ((a.percent >= 0 AND a.percent < 100) OR (a.percent = -1 AND a.datep > '".$db->idate($now)."'))";
  11777. //elseif ($donetodo == 'done') $sql.= " AND (a.percent = 100 OR (a.percent = -1 AND a.datep <= '".$db->idate($now)."'))";
  11778. $tododone = '';
  11779. if (($obj->percent >= 0 and $obj->percent < 100) || ($obj->percent == -1 && $obj->dp > $now)) {
  11780. $tododone = 'todo';
  11781. }
  11782. $histo[$numaction] = array(
  11783. 'type'=>$obj->type,
  11784. 'tododone'=>$tododone,
  11785. 'id'=>$obj->id,
  11786. 'datestart'=>$db->jdate($obj->dp),
  11787. 'dateend'=>$db->jdate($obj->dp2),
  11788. 'note'=>$obj->label,
  11789. 'message'=>$obj->message,
  11790. 'percent'=>$obj->percent,
  11791. 'userid'=>$obj->user_id,
  11792. 'login'=>$obj->user_login,
  11793. 'userfirstname'=>$obj->user_firstname,
  11794. 'userlastname'=>$obj->user_lastname,
  11795. 'userphoto'=>$obj->user_photo,
  11796. 'msg_from'=>$obj->msg_from,
  11797. 'contact_id'=>$obj->fk_contact,
  11798. 'socpeopleassigned' => $contactaction->socpeopleassigned,
  11799. 'lastname' => (empty($obj->lastname) ? '' : $obj->lastname),
  11800. 'firstname' => (empty($obj->firstname) ? '' : $obj->firstname),
  11801. 'fk_element'=>$obj->fk_element,
  11802. 'elementtype'=>$obj->elementtype,
  11803. // Type of event
  11804. 'acode'=>$obj->acode,
  11805. 'alabel'=>$obj->alabel,
  11806. 'libelle'=>$obj->alabel, // deprecated
  11807. 'apicto'=>$obj->apicto
  11808. );
  11809. } else {
  11810. $histo[$numaction] = array(
  11811. 'type'=>$obj->type,
  11812. 'tododone'=>'done',
  11813. 'id'=>$obj->id,
  11814. 'datestart'=>$db->jdate($obj->dp),
  11815. 'dateend'=>$db->jdate($obj->dp2),
  11816. 'note'=>$obj->label,
  11817. 'message'=>$obj->message,
  11818. 'percent'=>$obj->percent,
  11819. 'acode'=>$obj->acode,
  11820. 'userid'=>$obj->user_id,
  11821. 'login'=>$obj->user_login,
  11822. 'userfirstname'=>$obj->user_firstname,
  11823. 'userlastname'=>$obj->user_lastname,
  11824. 'userphoto'=>$obj->user_photo
  11825. );
  11826. }
  11827. $numaction++;
  11828. $i++;
  11829. }
  11830. } else {
  11831. dol_print_error($db);
  11832. }
  11833. }
  11834. // Set $out to show events
  11835. $out = '';
  11836. if (!isModEnabled('agenda')) {
  11837. $langs->loadLangs(array("admin", "errors"));
  11838. $out = info_admin($langs->trans("WarningModuleXDisabledSoYouMayMissEventHere", $langs->transnoentitiesnoconv("Module2400Name")), 0, 0, 'warning');
  11839. }
  11840. if (isModEnabled('agenda') || (isModEnabled('mailing') && !empty($objcon->email))) {
  11841. $delay_warning = $conf->global->MAIN_DELAY_ACTIONS_TODO * 24 * 60 * 60;
  11842. require_once DOL_DOCUMENT_ROOT.'/comm/action/class/actioncomm.class.php';
  11843. include_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
  11844. require_once DOL_DOCUMENT_ROOT.'/core/class/html.formactions.class.php';
  11845. require_once DOL_DOCUMENT_ROOT.'/contact/class/contact.class.php';
  11846. $formactions = new FormActions($db);
  11847. $actionstatic = new ActionComm($db);
  11848. $userstatic = new User($db);
  11849. $contactstatic = new Contact($db);
  11850. $userGetNomUrlCache = array();
  11851. $contactGetNomUrlCache = array();
  11852. $out .= '<div class="filters-container" >';
  11853. $out .= '<form name="listactionsfilter" class="listactionsfilter" action="'.$_SERVER["PHP_SELF"].'" method="POST">';
  11854. $out .= '<input type="hidden" name="token" value="'.newToken().'">';
  11855. if ($objcon && get_class($objcon) == 'Contact' &&
  11856. (is_null($filterobj) || get_class($filterobj) == 'Societe')) {
  11857. $out .= '<input type="hidden" name="id" value="'.$objcon->id.'" />';
  11858. } else {
  11859. $out .= '<input type="hidden" name="id" value="'.$filterobj->id.'" />';
  11860. }
  11861. if ($filterobj && get_class($filterobj) == 'Societe') {
  11862. $out .= '<input type="hidden" name="socid" value="'.$filterobj->id.'" />';
  11863. }
  11864. $out .= "\n";
  11865. $out .= '<div class="div-table-responsive-no-min">';
  11866. $out .= '<table class="noborder borderbottom centpercent">';
  11867. $out .= '<tr class="liste_titre">';
  11868. // Action column
  11869. if (getDolGlobalString('MAIN_CHECKBOX_LEFT_COLUMN')) {
  11870. $out .= '<th class="liste_titre width50 middle">';
  11871. $searchpicto = $form->showFilterAndCheckAddButtons($massactionbutton ? 1 : 0, 'checkforselect', 1);
  11872. $out .= $searchpicto;
  11873. $out .= '</th>';
  11874. }
  11875. $out .= getTitleFieldOfList('Date', 0, $_SERVER["PHP_SELF"], 'a.datep', '', $param, '', $sortfield, $sortorder, '')."\n";
  11876. $out .= '<th class="liste_titre"><strong class="hideonsmartphone">'.$langs->trans("Search").' : </strong></th>';
  11877. if ($donetodo) {
  11878. $out .= '<th class="liste_titre"></th>';
  11879. }
  11880. $out .= '<th class="liste_titre">';
  11881. $out .= '<span class="fas fa-square inline-block fawidth30" style=" color: #ddd;" title="'.$langs->trans("ActionType").'"></span>';
  11882. //$out .= img_picto($langs->trans("Type"), 'type');
  11883. $out .= $formactions->select_type_actions($actioncode, "actioncode", '', !getDolGlobalString('AGENDA_USE_EVENT_TYPE') ? 1 : -1, 0, 0, 1, 'minwidth200imp');
  11884. $out .= '</th>';
  11885. $out .= '<th class="liste_titre maxwidth100onsmartphone">';
  11886. $out .= '<input type="text" class="maxwidth100onsmartphone" name="search_agenda_label" value="'.$filters['search_agenda_label'].'" placeholder="'.$langs->trans("Label").'">';
  11887. $out .= '</th>';
  11888. // Action column
  11889. if (!getDolGlobalString('MAIN_CHECKBOX_LEFT_COLUMN')) {
  11890. $out .= '<th class="liste_titre width50 middle">';
  11891. $searchpicto = $form->showFilterAndCheckAddButtons($massactionbutton ? 1 : 0, 'checkforselect', 1);
  11892. $out .= $searchpicto;
  11893. $out .= '</th>';
  11894. }
  11895. $out .= '</tr>';
  11896. $out .= '</table>';
  11897. $out .= '</form>';
  11898. $out .= '</div>';
  11899. $out .= "\n";
  11900. $out .= '<ul class="timeline">';
  11901. if ($donetodo) {
  11902. $tmp = '';
  11903. if (get_class($filterobj) == 'Societe') {
  11904. $tmp .= '<a href="'.DOL_URL_ROOT.'/comm/action/list.php?mode=show_list&socid='.$filterobj->id.'&status=done">';
  11905. }
  11906. $tmp .= ($donetodo != 'done' ? $langs->trans("ActionsToDoShort") : '');
  11907. $tmp .= ($donetodo != 'done' && $donetodo != 'todo' ? ' / ' : '');
  11908. $tmp .= ($donetodo != 'todo' ? $langs->trans("ActionsDoneShort") : '');
  11909. //$out.=$langs->trans("ActionsToDoShort").' / '.$langs->trans("ActionsDoneShort");
  11910. if (get_class($filterobj) == 'Societe') {
  11911. $tmp .= '</a>';
  11912. }
  11913. $out .= getTitleFieldOfList($tmp);
  11914. }
  11915. require_once DOL_DOCUMENT_ROOT.'/comm/action/class/cactioncomm.class.php';
  11916. $caction = new CActionComm($db);
  11917. $arraylist = $caction->liste_array(1, 'code', '', (!getDolGlobalString('AGENDA_USE_EVENT_TYPE') ? 1 : 0), '', 1);
  11918. $actualCycleDate = false;
  11919. // Loop on each event to show it
  11920. foreach ($histo as $key => $value) {
  11921. $actionstatic->fetch($histo[$key]['id']); // TODO Do we need this, we already have a lot of data of line into $histo
  11922. $actionstatic->type_picto = $histo[$key]['apicto'];
  11923. $actionstatic->type_code = $histo[$key]['acode'];
  11924. $labeltype = $actionstatic->type_code;
  11925. if (!getDolGlobalString('AGENDA_USE_EVENT_TYPE') && empty($arraylist[$labeltype])) {
  11926. $labeltype = 'AC_OTH';
  11927. }
  11928. if (!empty($actionstatic->code) && preg_match('/^TICKET_MSG/', $actionstatic->code)) {
  11929. $labeltype = $langs->trans("Message");
  11930. } else {
  11931. if (!empty($arraylist[$labeltype])) {
  11932. $labeltype = $arraylist[$labeltype];
  11933. }
  11934. if ($actionstatic->type_code == 'AC_OTH_AUTO' && ($actionstatic->type_code != $actionstatic->code) && $labeltype && !empty($arraylist[$actionstatic->code])) {
  11935. $labeltype .= ' - '.$arraylist[$actionstatic->code]; // Use code in priority on type_code
  11936. }
  11937. }
  11938. $url = DOL_URL_ROOT.'/comm/action/card.php?id='.$histo[$key]['id'];
  11939. $tmpa = dol_getdate($histo[$key]['datestart'], false);
  11940. if (isset($tmpa['year']) && isset($tmpa['yday']) && $actualCycleDate !== $tmpa['year'].'-'.$tmpa['yday']) {
  11941. $actualCycleDate = $tmpa['year'].'-'.$tmpa['yday'];
  11942. $out .= '<!-- timeline time label -->';
  11943. $out .= '<li class="time-label">';
  11944. $out .= '<span class="timeline-badge-date">';
  11945. $out .= dol_print_date($histo[$key]['datestart'], 'daytext', 'tzuserrel', $langs);
  11946. $out .= '</span>';
  11947. $out .= '</li>';
  11948. $out .= '<!-- /.timeline-label -->';
  11949. }
  11950. $out .= '<!-- timeline item -->'."\n";
  11951. $out .= '<li class="timeline-code-'.strtolower($actionstatic->code).'">';
  11952. //$timelineicon = getTimelineIcon($actionstatic, $histo, $key);
  11953. $typeicon = $actionstatic->getTypePicto('pictofixedwidth timeline-icon-not-applicble', $labeltype);
  11954. //$out .= $timelineicon;
  11955. //var_dump($timelineicon);
  11956. $out .= $typeicon;
  11957. $out .= '<div class="timeline-item">'."\n";
  11958. $out .= '<span class="time timeline-header-action2">';
  11959. if (isset($histo[$key]['type']) && $histo[$key]['type'] == 'mailing') {
  11960. $out .= '<a class="paddingleft paddingright timeline-btn2 editfielda" href="'.DOL_URL_ROOT.'/comm/mailing/card.php?id='.$histo[$key]['id'].'">'.img_object($langs->trans("ShowEMailing"), "email").' ';
  11961. $out .= $histo[$key]['id'];
  11962. $out .= '</a> ';
  11963. } else {
  11964. $out .= $actionstatic->getNomUrl(1, -1, 'valignmiddle').' ';
  11965. }
  11966. if ($user->hasRight('agenda', 'allactions', 'create') ||
  11967. (($actionstatic->authorid == $user->id || $actionstatic->userownerid == $user->id) && $user->hasRight('agenda', 'myactions', 'create'))) {
  11968. $out .= '<a class="paddingleft paddingright timeline-btn2 editfielda" href="'.DOL_MAIN_URL_ROOT.'/comm/action/card.php?action=edit&token='.newToken().'&id='.$actionstatic->id.'&backtopage='.urlencode($_SERVER["PHP_SELF"].'?'.$param).'">';
  11969. //$out .= '<i class="fa fa-pencil" title="'.$langs->trans("Modify").'" ></i>';
  11970. $out .= img_picto($langs->trans("Modify"), 'edit', 'class="edita"');
  11971. $out .= '</a>';
  11972. }
  11973. $out .= '</span>';
  11974. // Date
  11975. $out .= '<span class="time"><i class="fa fa-clock-o valignmiddle"></i> <span class="valignmiddle">';
  11976. $out .= dol_print_date($histo[$key]['datestart'], 'dayhour', 'tzuserrel');
  11977. if ($histo[$key]['dateend'] && $histo[$key]['dateend'] != $histo[$key]['datestart']) {
  11978. $tmpa = dol_getdate($histo[$key]['datestart'], true);
  11979. $tmpb = dol_getdate($histo[$key]['dateend'], true);
  11980. if ($tmpa['mday'] == $tmpb['mday'] && $tmpa['mon'] == $tmpb['mon'] && $tmpa['year'] == $tmpb['year']) {
  11981. $out .= '-'.dol_print_date($histo[$key]['dateend'], 'hour', 'tzuserrel');
  11982. } else {
  11983. $out .= '-'.dol_print_date($histo[$key]['dateend'], 'dayhour', 'tzuserrel');
  11984. }
  11985. }
  11986. $late = 0;
  11987. if ($histo[$key]['percent'] == 0 && $histo[$key]['datestart'] && $histo[$key]['datestart'] < ($now - $delay_warning)) {
  11988. $late = 1;
  11989. }
  11990. if ($histo[$key]['percent'] == 0 && !$histo[$key]['datestart'] && $histo[$key]['dateend'] && $histo[$key]['datestart'] < ($now - $delay_warning)) {
  11991. $late = 1;
  11992. }
  11993. if ($histo[$key]['percent'] > 0 && $histo[$key]['percent'] < 100 && $histo[$key]['dateend'] && $histo[$key]['dateend'] < ($now - $delay_warning)) {
  11994. $late = 1;
  11995. }
  11996. if ($histo[$key]['percent'] > 0 && $histo[$key]['percent'] < 100 && !$histo[$key]['dateend'] && $histo[$key]['datestart'] && $histo[$key]['datestart'] < ($now - $delay_warning)) {
  11997. $late = 1;
  11998. }
  11999. if ($late) {
  12000. $out .= img_warning($langs->trans("Late")).' ';
  12001. }
  12002. $out .= "</span></span>\n";
  12003. // Ref
  12004. $out .= '<h3 class="timeline-header">';
  12005. // Author of event
  12006. $out .= '<div class="messaging-author inline-block tdoverflowmax150 valignmiddle marginrightonly">';
  12007. if ($histo[$key]['userid'] > 0) {
  12008. if (!isset($userGetNomUrlCache[$histo[$key]['userid']])) { // is in cache ?
  12009. $userstatic->fetch($histo[$key]['userid']);
  12010. $userGetNomUrlCache[$histo[$key]['userid']] = $userstatic->getNomUrl(-1, '', 0, 0, 16, 0, 'firstelselast', '');
  12011. }
  12012. $out .= $userGetNomUrlCache[$histo[$key]['userid']];
  12013. } elseif (!empty($histo[$key]['msg_from']) && $actionstatic->code == 'TICKET_MSG') {
  12014. if (!isset($contactGetNomUrlCache[$histo[$key]['msg_from']])) {
  12015. if ($contactstatic->fetch(0, null, '', $histo[$key]['msg_from']) > 0) {
  12016. $contactGetNomUrlCache[$histo[$key]['msg_from']] = $contactstatic->getNomUrl(-1, '', 16);
  12017. } else {
  12018. $contactGetNomUrlCache[$histo[$key]['msg_from']] = $histo[$key]['msg_from'];
  12019. }
  12020. }
  12021. $out .= $contactGetNomUrlCache[$histo[$key]['msg_from']];
  12022. }
  12023. $out .= '</div>';
  12024. // Title
  12025. $out .= ' <div class="messaging-title inline-block">';
  12026. //$out .= $actionstatic->getTypePicto();
  12027. if (empty($conf->dol_optimize_smallscreen) && $actionstatic->type_code != 'AC_OTH_AUTO') {
  12028. $out .= $labeltype.' - ';
  12029. }
  12030. $libelle = '';
  12031. if (preg_match('/^TICKET_MSG/', $actionstatic->code)) {
  12032. $out .= $langs->trans('TicketNewMessage');
  12033. } elseif (preg_match('/^TICKET_MSG_PRIVATE/', $actionstatic->code)) {
  12034. $out .= $langs->trans('TicketNewMessage').' <em>('.$langs->trans('Private').')</em>';
  12035. } elseif (isset($histo[$key]['type'])) {
  12036. if ($histo[$key]['type'] == 'action') {
  12037. $transcode = $langs->transnoentitiesnoconv("Action".$histo[$key]['acode']);
  12038. $libelle = ($transcode != "Action".$histo[$key]['acode'] ? $transcode : $histo[$key]['alabel']);
  12039. $libelle = $histo[$key]['note'];
  12040. $actionstatic->id = $histo[$key]['id'];
  12041. $out .= dol_escape_htmltag(dol_trunc($libelle, 120));
  12042. } elseif ($histo[$key]['type'] == 'mailing') {
  12043. $out .= '<a href="'.DOL_URL_ROOT.'/comm/mailing/card.php?id='.$histo[$key]['id'].'">'.img_object($langs->trans("ShowEMailing"), "email").' ';
  12044. $transcode = $langs->transnoentitiesnoconv("Action".$histo[$key]['acode']);
  12045. $libelle = ($transcode != "Action".$histo[$key]['acode'] ? $transcode : 'Send mass mailing');
  12046. $out .= dol_escape_htmltag(dol_trunc($libelle, 120));
  12047. } else {
  12048. $libelle .= $histo[$key]['note'];
  12049. $out .= dol_escape_htmltag(dol_trunc($libelle, 120));
  12050. }
  12051. }
  12052. if (isset($histo[$key]['elementtype']) && !empty($histo[$key]['fk_element'])) {
  12053. if (isset($conf->cache['elementlinkcache'][$histo[$key]['elementtype']]) && isset($conf->cache['elementlinkcache'][$histo[$key]['elementtype']][$histo[$key]['fk_element']])) {
  12054. $link = $conf->cache['elementlinkcache'][$histo[$key]['elementtype']][$histo[$key]['fk_element']];
  12055. } else {
  12056. if (!isset($conf->cache['elementlinkcache'][$histo[$key]['elementtype']])) {
  12057. $conf->cache['elementlinkcache'][$histo[$key]['elementtype']] = array();
  12058. }
  12059. $link = dolGetElementUrl($histo[$key]['fk_element'], $histo[$key]['elementtype'], 1);
  12060. $conf->cache['elementlinkcache'][$histo[$key]['elementtype']][$histo[$key]['fk_element']] = $link;
  12061. }
  12062. if ($link) {
  12063. $out .= ' - '.$link;
  12064. }
  12065. }
  12066. $out .= '</div>';
  12067. $out .= '</h3>';
  12068. // Message
  12069. if (!empty($histo[$key]['message'] && $histo[$key]['message'] != $libelle)
  12070. && $actionstatic->code != 'AC_TICKET_CREATE'
  12071. && $actionstatic->code != 'AC_TICKET_MODIFY'
  12072. ) {
  12073. $out .= '<div class="timeline-body classfortooltip" title="'.dol_escape_htmltag(dol_htmlwithnojs(dol_string_onlythesehtmltags(dol_htmlentitiesbr($histo[$key]['message']), 1, 1, 1)), 1, 1).'">';
  12074. $out .= dolGetFirstLineOfText($histo[$key]['message'], 3);
  12075. $out .= '</div>';
  12076. }
  12077. // Timeline footer
  12078. $footer = '';
  12079. // Contact for this action
  12080. if (isset($histo[$key]['socpeopleassigned']) && is_array($histo[$key]['socpeopleassigned']) && count($histo[$key]['socpeopleassigned']) > 0) {
  12081. $contactList = '';
  12082. foreach ($histo[$key]['socpeopleassigned'] as $cid => $Tab) {
  12083. if (empty($conf->cache['contact'][$histo[$key]['contact_id']])) {
  12084. $contact = new Contact($db);
  12085. $contact->fetch($cid);
  12086. $conf->cache['contact'][$histo[$key]['contact_id']] = $contact;
  12087. } else {
  12088. $contact = $conf->cache['contact'][$histo[$key]['contact_id']];
  12089. }
  12090. if ($contact) {
  12091. $contactList .= !empty($contactList) ? ', ' : '';
  12092. $contactList .= $contact->getNomUrl(1);
  12093. if (isset($histo[$key]['acode']) && $histo[$key]['acode'] == 'AC_TEL') {
  12094. if (!empty($contact->phone_pro)) {
  12095. $contactList .= '('.dol_print_phone($contact->phone_pro).')';
  12096. }
  12097. }
  12098. }
  12099. }
  12100. $footer .= $langs->trans('ActionOnContact').' : '.$contactList;
  12101. } elseif (empty($objcon->id) && isset($histo[$key]['contact_id']) && $histo[$key]['contact_id'] > 0) {
  12102. if (empty($conf->cache['contact'][$histo[$key]['contact_id']])) {
  12103. $contact = new Contact($db);
  12104. $result = $contact->fetch($histo[$key]['contact_id']);
  12105. $conf->cache['contact'][$histo[$key]['contact_id']] = $contact;
  12106. } else {
  12107. $contact = $conf->cache['contact'][$histo[$key]['contact_id']];
  12108. }
  12109. if ($result > 0) {
  12110. $footer .= $contact->getNomUrl(1);
  12111. if (isset($histo[$key]['acode']) && $histo[$key]['acode'] == 'AC_TEL') {
  12112. if (!empty($contact->phone_pro)) {
  12113. $footer .= '('.dol_print_phone($contact->phone_pro).')';
  12114. }
  12115. }
  12116. }
  12117. }
  12118. $documents = getActionCommEcmList($actionstatic);
  12119. if (!empty($documents)) {
  12120. $footer .= '<div class="timeline-documents-container">';
  12121. foreach ($documents as $doc) {
  12122. $footer .= '<span id="document_'.$doc->id.'" class="timeline-documents" ';
  12123. $footer .= ' data-id="'.$doc->id.'" ';
  12124. $footer .= ' data-path="'.$doc->filepath.'"';
  12125. $footer .= ' data-filename="'.dol_escape_htmltag($doc->filename).'" ';
  12126. $footer .= '>';
  12127. $filePath = DOL_DATA_ROOT.'/'.$doc->filepath.'/'.$doc->filename;
  12128. $mime = dol_mimetype($filePath);
  12129. $file = $actionstatic->id.'/'.$doc->filename;
  12130. $thumb = $actionstatic->id.'/thumbs/'.substr($doc->filename, 0, strrpos($doc->filename, '.')).'_mini'.substr($doc->filename, strrpos($doc->filename, '.'));
  12131. $doclink = dol_buildpath('document.php', 1).'?modulepart=actions&attachment=0&file='.urlencode($file).'&entity='.$conf->entity;
  12132. $viewlink = dol_buildpath('viewimage.php', 1).'?modulepart=actions&file='.urlencode($thumb).'&entity='.$conf->entity;
  12133. $mimeAttr = ' mime="'.$mime.'" ';
  12134. $class = '';
  12135. if (in_array($mime, array('image/png', 'image/jpeg', 'application/pdf'))) {
  12136. $class .= ' documentpreview';
  12137. }
  12138. $footer .= '<a href="'.$doclink.'" class="btn-link '.$class.'" target="_blank" rel="noopener noreferrer" '.$mimeAttr.' >';
  12139. $footer .= img_mime($filePath).' '.$doc->filename;
  12140. $footer .= '</a>';
  12141. $footer .= '</span>';
  12142. }
  12143. $footer .= '</div>';
  12144. }
  12145. if (!empty($footer)) {
  12146. $out .= '<div class="timeline-footer">'.$footer.'</div>';
  12147. }
  12148. $out .= '</div>'."\n"; // end timeline-item
  12149. $out .= '</li>';
  12150. $out .= '<!-- END timeline item -->';
  12151. $i++;
  12152. }
  12153. $out .= "</ul>\n";
  12154. if (empty($histo)) {
  12155. $out .= '<span class="opacitymedium">'.$langs->trans("NoRecordFound").'</span>';
  12156. }
  12157. }
  12158. if ($noprint) {
  12159. return $out;
  12160. } else {
  12161. print $out;
  12162. }
  12163. }
  12164. /**
  12165. * Helper function that combines values of a dolibarr DatePicker (such as Form::selectDate) for year, month, day (and
  12166. * optionally hour, minute, second) fields to return a timestamp.
  12167. *
  12168. * @param string $prefix Prefix used to build the date selector (for instance using Form::selectDate)
  12169. * @param string $hourTime 'getpost' to include hour, minute, second values from the HTTP request, 'XX:YY:ZZ' to set
  12170. * hour, minute, second respectively (for instance '23:59:59')
  12171. * @param string $gm Passed to dol_mktime
  12172. * @return int|string Date as a timestamp, '' or false if error
  12173. */
  12174. function GETPOSTDATE($prefix, $hourTime = '', $gm = 'auto')
  12175. {
  12176. if ($hourTime === 'getpost') {
  12177. $hour = GETPOSTINT($prefix . 'hour');
  12178. $minute = GETPOSTINT($prefix . 'minute');
  12179. $second = GETPOSTINT($prefix . 'second');
  12180. } elseif (preg_match('/^(\d\d):(\d\d):(\d\d)$/', $hourTime, $m)) {
  12181. $hour = intval($m[1]);
  12182. $minute = intval($m[2]);
  12183. $second = intval($m[3]);
  12184. } else {
  12185. $hour = $minute = $second = 0;
  12186. }
  12187. // normalize out of range values
  12188. $hour = min($hour, 23);
  12189. $minute = min($minute, 59);
  12190. $second = min($second, 59);
  12191. return dol_mktime($hour, $minute, $second, GETPOSTINT($prefix . 'month'), GETPOSTINT($prefix . 'day'), GETPOSTINT($prefix . 'year'), $gm);
  12192. }
  12193. /**
  12194. * Helper function that combines values of a dolibarr DatePicker (such as Form::selectDate) for year, month, day (and
  12195. * optionally hour, minute, second) fields to return a a portion of URL reproducing the values from the current HTTP
  12196. * request.
  12197. *
  12198. * @param string $prefix Prefix used to build the date selector (for instance using Form::selectDate)
  12199. * @param int $timestamp If null, the timestamp will be created from request data
  12200. * @param bool $hourTime If timestamp is null, will be passed to GETPOSTDATE to construct the timestamp
  12201. * @param bool $gm If timestamp is null, will be passed to GETPOSTDATE to construct the timestamp
  12202. * @return string Portion of URL with query parameters for the specified date
  12203. */
  12204. function buildParamDate($prefix, $timestamp = null, $hourTime = '', $gm = 'auto')
  12205. {
  12206. if ($timestamp === null) {
  12207. $timestamp = GETPOSTDATE($prefix, $hourTime, $gm);
  12208. }
  12209. $TParam = array(
  12210. $prefix . 'day' => intval(dol_print_date($timestamp, '%d')),
  12211. $prefix . 'month' => intval(dol_print_date($timestamp, '%m')),
  12212. $prefix . 'year' => intval(dol_print_date($timestamp, '%Y')),
  12213. );
  12214. if ($hourTime === 'getpost' || ($timestamp !== null && dol_print_date($timestamp, '%H:%M:%S') !== '00:00:00')) {
  12215. $TParam = array_merge($TParam, array(
  12216. $prefix . 'hour' => intval(dol_print_date($timestamp, '%H')),
  12217. $prefix . 'minute' => intval(dol_print_date($timestamp, '%M')),
  12218. $prefix . 'second' => intval(dol_print_date($timestamp, '%S'))
  12219. ));
  12220. }
  12221. return '&' . http_build_query($TParam);
  12222. }