functions.lib.php 229 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973
  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-2013 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-2012 Regis Houssin <regis.houssin@capnetworks.com>
  9. * Copyright (C) 2008 Raphael Bertrand (Resultic) <raphael.bertrand@resultic.fr>
  10. * Copyright (C) 2010-2016 Juanjo Menent <jmenent@2byte.es>
  11. * Copyright (C) 2013 Cédric Salvador <csalvador@gpcsolutions.fr>
  12. * Copyright (C) 2013-2017 Alexandre Spangaro <aspangaro@zendsi.com>
  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. *
  17. * This program is free software; you can redistribute it and/or modify
  18. * it under the terms of the GNU General Public License as published by
  19. * the Free Software Foundation; either version 3 of the License, or
  20. * (at your option) any later version.
  21. *
  22. * This program is distributed in the hope that it will be useful,
  23. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  25. * GNU General Public License for more details.
  26. *
  27. * You should have received a copy of the GNU General Public License
  28. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  29. * or see http://www.gnu.org/
  30. */
  31. /**
  32. * \file htdocs/core/lib/functions.lib.php
  33. * \brief A set of functions for Dolibarr
  34. * This file contains all frequently used functions.
  35. */
  36. include_once DOL_DOCUMENT_ROOT .'/core/lib/json.lib.php';
  37. /**
  38. * Function to return value of a static property when class
  39. * name is dynamically defined (not hard coded).
  40. * This is because $myclass::$myvar works from PHP 5.3.0+ only
  41. *
  42. * @param string $class Class name
  43. * @param string $member Name of property
  44. * @return mixed Return value of static property
  45. * @deprecated Dolibarr now requires 5.3.0+, use $class::$property syntax
  46. * @see https://php.net/manual/language.oop5.static.php
  47. */
  48. function getStaticMember($class, $member)
  49. {
  50. dol_syslog(__FUNCTION__ . " is deprecated", LOG_WARNING);
  51. // This part is deprecated. Uncomment if for php 5.2.*, and comment next isset class::member
  52. /*if (version_compare(phpversion(), '5.3.0', '<'))
  53. {
  54. if (is_object($class)) $class = get_class($class);
  55. $classObj = new ReflectionClass($class);
  56. $result = null;
  57. $found=0;
  58. foreach($classObj->getStaticProperties() as $prop => $value)
  59. {
  60. if ($prop == $member)
  61. {
  62. $result = $value;
  63. $found++;
  64. break;
  65. }
  66. }
  67. if ($found) return $result;
  68. }*/
  69. if (isset($class::$member)) return $class::$member;
  70. dol_print_error('','Try to get a static member "'.$member.'" in class "'.$class.'" that does not exists or is not static.');
  71. return null;
  72. }
  73. /**
  74. * Return a DoliDB instance (database handler).
  75. *
  76. * @param string $type Type of database (mysql, pgsql...)
  77. * @param string $host Address of database server
  78. * @param string $user Nom de l'utilisateur autorise
  79. * @param string $pass Mot de passe
  80. * @param string $name Nom de la database
  81. * @param int $port Port of database server
  82. * @return DoliDB A DoliDB instance
  83. */
  84. function getDoliDBInstance($type, $host, $user, $pass, $name, $port)
  85. {
  86. require_once DOL_DOCUMENT_ROOT ."/core/db/".$type.'.class.php';
  87. $class='DoliDB'.ucfirst($type);
  88. $dolidb=new $class($type, $host, $user, $pass, $name, $port);
  89. return $dolidb;
  90. }
  91. /**
  92. * Get list of entity id to use
  93. *
  94. * @param string $element Current element
  95. * 'societe', 'socpeople', 'actioncomm', 'agenda', 'resource',
  96. * 'product', 'productprice', 'stock',
  97. * 'propal', 'facture', 'facture_fourn',
  98. * 'categorie', 'bank_account', 'bank_account', 'adherent', 'user',
  99. * 'commande', 'commande_fournisseur', 'expedition', 'intervention', 'survey',
  100. * 'contract', 'tax', 'expensereport', 'holiday', 'multicurrency', 'project',
  101. * 'email_template', 'event',
  102. * @param int $shared 0=Return id of entity, 1=Return id entity + shared entities
  103. * @return mixed Entity id(s) to use
  104. */
  105. function getEntity($element=false, $shared=0)
  106. {
  107. global $conf, $mc;
  108. // For backward compatibilty
  109. if ($element == 'actioncomm') $element='agenda';
  110. if ($element == 'fichinter') $element='intervention';
  111. if ($element == 'categorie') $element='category';
  112. if (is_object($mc))
  113. {
  114. return $mc->getEntity($element, $shared);
  115. }
  116. else
  117. {
  118. $out='';
  119. $addzero = array('user', 'usergroup');
  120. if (in_array($element, $addzero)) $out.= '0,';
  121. $out.= $conf->entity;
  122. return $out;
  123. }
  124. }
  125. /**
  126. * Return information about user browser
  127. *
  128. * Returns array with the following format:
  129. * array(
  130. * 'browsername' => Browser name (firefox|chrome|iceweasel|epiphany|safari|opera|ie|unknown)
  131. * 'browserversion' => Browser version. Empty if unknown
  132. * 'browseros' => Set with mobile OS (android|blackberry|ios|palm|symbian|webos|maemo|windows|unknown)
  133. * 'layout' => (tablet|phone|classic)
  134. * 'phone' => empty if not mobile, (android|blackberry|ios|palm|unknown) if mobile
  135. * 'tablet' => true/false
  136. * )
  137. *
  138. * @param string $user_agent Content of $_SERVER["HTTP_USER_AGENT"] variable
  139. * @return array Check function documentation
  140. */
  141. function getBrowserInfo($user_agent)
  142. {
  143. include_once DOL_DOCUMENT_ROOT.'/includes/mobiledetect/mobiledetectlib/Mobile_Detect.php';
  144. $name='unknown';
  145. $version='';
  146. $os='unknown';
  147. $phone = '';
  148. $detectmobile = new Mobile_Detect(null, $user_agent);
  149. $tablet = $detectmobile->isTablet();
  150. if ($detectmobile->isMobile()) {
  151. $phone = 'unknown';
  152. // If phone/smartphone, we set phone os name.
  153. if ($detectmobile->is('AndroidOS')) {
  154. $os = $phone = 'android';
  155. } elseif ($detectmobile->is('BlackBerryOS')) {
  156. $os = $phone = 'blackberry';
  157. } elseif ($detectmobile->is('iOS')) {
  158. $os = 'ios';
  159. $phone = 'iphone';
  160. } elseif ($detectmobile->is('PalmOS')) {
  161. $os = $phone = 'palm';
  162. } elseif ($detectmobile->is('SymbianOS')) {
  163. $os = 'symbian';
  164. } elseif ($detectmobile->is('webOS')) {
  165. $os = 'webos';
  166. } elseif ($detectmobile->is('MaemoOS')) {
  167. $os = 'maemo';
  168. } elseif ($detectmobile->is('WindowsMobileOS') || $detectmobile->is('WindowsPhoneOS')) {
  169. $os = 'windows';
  170. }
  171. }
  172. // OS
  173. if (preg_match('/linux/i', $user_agent)) { $os='linux'; }
  174. elseif (preg_match('/macintosh/i', $user_agent)) { $os='macintosh'; }
  175. // Name
  176. if (preg_match('/firefox(\/|\s)([\d\.]*)/i', $user_agent, $reg)) { $name='firefox'; $version=$reg[2]; }
  177. elseif (preg_match('/chrome(\/|\s)([\d\.]+)/i', $user_agent, $reg)) { $name='chrome'; $version=$reg[2]; } // we can have 'chrome (Mozilla...) chrome x.y' in one string
  178. elseif (preg_match('/chrome/i', $user_agent, $reg)) { $name='chrome'; }
  179. elseif (preg_match('/iceweasel/i', $user_agent)) { $name='iceweasel'; }
  180. elseif (preg_match('/epiphany/i', $user_agent)) { $name='epiphany'; }
  181. elseif (preg_match('/safari(\/|\s)([\d\.]*)/i', $user_agent, $reg)) { $name='safari'; $version=$reg[2]; } // Safari is often present in string for mobile but its not.
  182. elseif (preg_match('/opera(\/|\s)([\d\.]*)/i', $user_agent, $reg)) { $name='opera'; $version=$reg[2]; }
  183. elseif (preg_match('/(MSIE\s([0-9]+\.[0-9]))|.*(Trident\/[0-9]+.[0-9];\srv:([0-9]+\.[0-9]+))/i', $user_agent, $reg)) { $name='ie'; $version=end($reg); } // MS products at end
  184. elseif (preg_match('/l(i|y)n(x|ks)(\(|\/|\s)*([\d\.]+)/i', $user_agent, $reg)) { $name='lynxlinks'; $version=$reg[4]; }
  185. if ($tablet) {
  186. $layout = 'tablet';
  187. } elseif ($phone) {
  188. $layout = 'phone';
  189. } else {
  190. $layout = 'classic';
  191. }
  192. return array(
  193. 'browsername' => $name,
  194. 'browserversion' => $version,
  195. 'browseros' => $os,
  196. 'layout' => $layout,
  197. 'phone' => $phone,
  198. 'tablet' => $tablet
  199. );
  200. }
  201. /**
  202. * Function called at end of web php process
  203. *
  204. * @return void
  205. */
  206. function dol_shutdown()
  207. {
  208. global $conf,$user,$langs,$db;
  209. $disconnectdone=false; $depth=0;
  210. if (is_object($db) && ! empty($db->connected)) { $depth=$db->transaction_opened; $disconnectdone=$db->close(); }
  211. dol_syslog("--- End access to ".$_SERVER["PHP_SELF"].(($disconnectdone && $depth)?' (Warn: db disconnection forced, transaction depth was '.$depth.')':''), (($disconnectdone && $depth)?LOG_WARNING:LOG_INFO));
  212. }
  213. /**
  214. * Return value of a param into GET or POST supervariable
  215. *
  216. * @param string $paramname Name of parameter to found
  217. * @param string $check Type of check (''=no check, 'int'=check it's numeric, 'alpha'=check it's text and sign, 'aZ'=check it's a-z only, 'array'=check it's array, 'san_alpha'=Use filter_var with FILTER_SANITIZE_STRING (do not use this for free text string), 'day', 'month', 'year', 'custom'= custom filter specify $filter and $options)
  218. * @param int $method Type of method (0 = get then post, 1 = only get, 2 = only post, 3 = post then get, 4 = post then get then cookie)
  219. * @param int $filter Filter to apply when $check is set to custom. (See http://php.net/manual/en/filter.filters.php for détails)
  220. * @param mixed $options Options to pass to filter_var when $check is set to custom
  221. * @return string|string[] Value found (string or array), or '' if check fails
  222. */
  223. function GETPOST($paramname,$check='',$method=0,$filter=NULL,$options=NULL)
  224. {
  225. if (empty($method)) $out = isset($_GET[$paramname])?$_GET[$paramname]:(isset($_POST[$paramname])?$_POST[$paramname]:'');
  226. elseif ($method==1) $out = isset($_GET[$paramname])?$_GET[$paramname]:'';
  227. elseif ($method==2) $out = isset($_POST[$paramname])?$_POST[$paramname]:'';
  228. elseif ($method==3) $out = isset($_POST[$paramname])?$_POST[$paramname]:(isset($_GET[$paramname])?$_GET[$paramname]:'');
  229. elseif ($method==4) $out = isset($_POST[$paramname])?$_POST[$paramname]:(isset($_GET[$paramname])?$_GET[$paramname]:(isset($_COOKIE[$paramname])?$_COOKIE[$paramname]:''));
  230. else return 'BadThirdParameterForGETPOST';
  231. if (! empty($check))
  232. {
  233. if (! is_array($out) && preg_match('/^__([a-z0-9]+)__$/i', $out, $reg))
  234. {
  235. if ($reg[1] == 'DAY')
  236. {
  237. $tmp=dol_getdate(dol_now(), true);
  238. $out = $tmp['mday'];
  239. }
  240. elseif ($reg[1] == 'MONTH')
  241. {
  242. $tmp=dol_getdate(dol_now(), true);
  243. $out = $tmp['mon'];
  244. }
  245. elseif ($reg[1] == 'YEAR')
  246. {
  247. $tmp=dol_getdate(dol_now(), true);
  248. $out = $tmp['year'];
  249. }
  250. elseif ($reg[1] == 'MYCOUNTRYID')
  251. {
  252. global $mysoc;
  253. $out = $mysoc->country_id;
  254. }
  255. }
  256. switch ($check)
  257. {
  258. case 'int':
  259. if (! is_numeric($out)) { $out=''; }
  260. break;
  261. case 'intcomma':
  262. if (preg_match('/[^0-9,]+/i',$out)) $out='';
  263. break;
  264. case 'alpha':
  265. $out=trim($out);
  266. // '"' is dangerous because param in url can close the href= or src= and add javascript functions.
  267. // '../' is dangerous because it allows dir transversals
  268. if (preg_match('/"/',$out)) $out='';
  269. else if (preg_match('/\.\.\//',$out)) $out='';
  270. break;
  271. case 'san_alpha':
  272. $out=filter_var($out,FILTER_SANITIZE_STRING);
  273. break;
  274. case 'aZ':
  275. $out=trim($out);
  276. if (preg_match('/[^a-z]+/i',$out)) $out='';
  277. break;
  278. case 'aZ09':
  279. $out=trim($out);
  280. if (preg_match('/[^a-z0-9_\-]+/i',$out)) $out='';
  281. break;
  282. case 'array':
  283. if (! is_array($out) || empty($out)) $out=array();
  284. break;
  285. case 'nohtml':
  286. $out=dol_string_nohtmltag($out);
  287. break;
  288. case 'alphanohtml': // Recommended for search params
  289. $out=trim($out);
  290. // '"' is dangerous because param in url can close the href= or src= and add javascript functions.
  291. // '../' is dangerous because it allows dir transversals
  292. if (preg_match('/"/',$out)) $out='';
  293. else if (preg_match('/\.\.\//',$out)) $out='';
  294. $out=dol_string_nohtmltag($out);
  295. break;
  296. case 'custom':
  297. if (empty($filter)) return 'BadFourthParameterForGETPOST';
  298. $out=filter_var($out, $filter, $options);
  299. break;
  300. }
  301. }
  302. return $out;
  303. }
  304. /**
  305. * Return a prefix to use for this Dolibarr instance for session or cookie names.
  306. * This prefix is unique for instance and avoid conflict between multi-instances,
  307. * even when having two instances with one root dir or two instances in virtual servers
  308. *
  309. * @param string $mode '' or 'email'
  310. * @return string A calculated prefix
  311. */
  312. function dol_getprefix($mode='')
  313. {
  314. global $conf;
  315. // If MAIL_PREFIX_FOR_EMAIL_ID is set and prefix is for email
  316. if ($mode == 'email' && ! empty($conf->global->MAIL_PREFIX_FOR_EMAIL_ID))
  317. {
  318. if ($conf->global->MAIL_PREFIX_FOR_EMAIL_ID != 'SERVER_NAME') return $conf->global->MAIL_PREFIX_FOR_EMAIL_ID;
  319. else if (isset($_SERVER["SERVER_NAME"])) return $_SERVER["SERVER_NAME"];
  320. }
  321. if (isset($_SERVER["SERVER_NAME"]) && isset($_SERVER["DOCUMENT_ROOT"]))
  322. {
  323. return dol_hash($_SERVER["SERVER_NAME"].$_SERVER["DOCUMENT_ROOT"].DOL_DOCUMENT_ROOT.DOL_URL_ROOT);
  324. // Use this for a "clear" cookie name
  325. //return dol_sanitizeFileName($_SERVER["SERVER_NAME"].$_SERVER["DOCUMENT_ROOT"].DOL_DOCUMENT_ROOT.DOL_URL_ROOT);
  326. }
  327. else return dol_hash(DOL_DOCUMENT_ROOT.DOL_URL_ROOT);
  328. }
  329. /**
  330. * Make an include_once using default root and alternate root if it fails.
  331. * To link to a core file, use include(DOL_DOCUMENT_ROOT.'/pathtofile')
  332. * To link to a module file from a module file, use include './mymodulefile';
  333. * To link to a module file from a core file, then this function can be used (call by hook / trigger / speciales pages)
  334. *
  335. * @param string $relpath Relative path to file (Ie: mydir/myfile, ../myfile, ...)
  336. * @param string $classname Class name (deprecated)
  337. * @return bool True if load is a success, False if it fails
  338. */
  339. function dol_include_once($relpath, $classname='')
  340. {
  341. global $conf,$langs,$user,$mysoc; // Do not remove this. They must be defined for files we include. Other globals var must be retreived with $GLOBALS['var']
  342. $fullpath = dol_buildpath($relpath);
  343. if (!file_exists($fullpath)) {
  344. dol_syslog('functions::dol_include_once Tried to load unexisting file: '.$relpath, LOG_ERR);
  345. return false;
  346. }
  347. if (! empty($classname) && ! class_exists($classname)) {
  348. return include $fullpath;
  349. } else {
  350. return include_once $fullpath;
  351. }
  352. }
  353. /**
  354. * Return path of url or filesystem. Return alternate root if exists.
  355. *
  356. * @param string $path Relative path to file (if mode=0) or relative url (if mode=1). Ie: mydir/myfile, ../myfile
  357. * @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)
  358. * @return string Full filesystem path (if mode=0), Full url path (if mode=1)
  359. */
  360. function dol_buildpath($path, $type=0)
  361. {
  362. global $conf;
  363. $path=preg_replace('/^\//','',$path);
  364. if (empty($type)) // For a filesystem path
  365. {
  366. $res = DOL_DOCUMENT_ROOT.'/'.$path; // Standard value
  367. foreach ($conf->file->dol_document_root as $key => $dirroot) // ex: array(["main"]=>"/home/main/htdocs", ["alt0"]=>"/home/dirmod/htdocs", ...)
  368. {
  369. if ($key == 'main') continue;
  370. if (file_exists($dirroot.'/'.$path))
  371. {
  372. $res=$dirroot.'/'.$path;
  373. break;
  374. }
  375. }
  376. }
  377. else // For an url path
  378. {
  379. // We try to get local path of file on filesystem from url
  380. // Note that trying to know if a file on disk exist by forging path on disk from url
  381. // works only for some web server and some setup. This is bugged when
  382. // using proxy, rewriting, virtual path, etc...
  383. $res='';
  384. if ($type == 1) $res = DOL_URL_ROOT.'/'.$path; // Standard value
  385. if ($type == 2) $res = DOL_MAIN_URL_ROOT.'/'.$path; // Standard value
  386. if ($type == 3) $res = DOL_URL_ROOT.'/'.$path;
  387. foreach ($conf->file->dol_document_root as $key => $dirroot) // ex: array(["main"]=>"/home/main/htdocs", ["alt0"]=>"/home/dirmod/htdocs", ...)
  388. {
  389. if ($key == 'main')
  390. {
  391. if ($type == 3)
  392. {
  393. global $dolibarr_main_url_root;
  394. // Define $urlwithroot
  395. $urlwithouturlroot=preg_replace('/'.preg_quote(DOL_URL_ROOT,'/').'$/i','',trim($dolibarr_main_url_root));
  396. $urlwithroot=$urlwithouturlroot.DOL_URL_ROOT; // This is to use external domain name found into config file
  397. //$urlwithroot=DOL_MAIN_URL_ROOT; // This is to use same domain name than current
  398. $res=(preg_match('/^http/i',$conf->file->dol_url_root[$key])?'':$urlwithroot).'/'.$path; // Test on start with http is for old conf syntax
  399. }
  400. continue;
  401. }
  402. preg_match('/^([^\?]+(\.css\.php|\.css|\.js\.php|\.js|\.png|\.jpg|\.php)?)/i',$path,$regs); // Take part before '?'
  403. if (! empty($regs[1]))
  404. {
  405. //print $key.'-'.$dirroot.'/'.$path.'-'.$conf->file->dol_url_root[$type].'<br>'."\n";
  406. if (file_exists($dirroot.'/'.$regs[1]))
  407. {
  408. if ($type == 1)
  409. {
  410. $res=(preg_match('/^http/i',$conf->file->dol_url_root[$key])?'':DOL_URL_ROOT).$conf->file->dol_url_root[$key].'/'.$path;
  411. }
  412. if ($type == 2)
  413. {
  414. $res=(preg_match('/^http/i',$conf->file->dol_url_root[$key])?'':DOL_MAIN_URL_ROOT).$conf->file->dol_url_root[$key].'/'.$path;
  415. }
  416. if ($type == 3)
  417. {
  418. global $dolibarr_main_url_root;
  419. // Define $urlwithroot
  420. $urlwithouturlroot=preg_replace('/'.preg_quote(DOL_URL_ROOT,'/').'$/i','',trim($dolibarr_main_url_root));
  421. $urlwithroot=$urlwithouturlroot.DOL_URL_ROOT; // This is to use external domain name found into config file
  422. //$urlwithroot=DOL_MAIN_URL_ROOT; // This is to use same domain name than current
  423. $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
  424. }
  425. break;
  426. }
  427. }
  428. }
  429. }
  430. return $res;
  431. }
  432. /**
  433. * Create a clone of instance of object (new instance with same properties)
  434. * This function works for both PHP4 and PHP5
  435. *
  436. * @param object $object Object to clone
  437. * @return object Object clone
  438. * @deprecated Dolibarr no longer supports PHP4, use PHP5 native clone construct
  439. * @see https://php.net/manual/language.oop5.cloning.php
  440. */
  441. function dol_clone($object)
  442. {
  443. dol_syslog(__FUNCTION__ . " is deprecated", LOG_WARNING);
  444. $myclone = clone $object;
  445. return $myclone;
  446. }
  447. /**
  448. * Optimize a size for some browsers (phone, smarphone, ...)
  449. *
  450. * @param int $size Size we want
  451. * @param string $type Type of optimizing:
  452. * '' = function used to define a size for truncation
  453. * 'width' = function is used to define a width
  454. * @return int New size after optimizing
  455. */
  456. function dol_size($size,$type='')
  457. {
  458. global $conf;
  459. if (empty($conf->dol_optimize_smallscreen)) return $size;
  460. if ($type == 'width' && $size > 250) return 250;
  461. else return 10;
  462. }
  463. /**
  464. * Clean a string to use it as a file name
  465. *
  466. * @param string $str String to clean
  467. * @param string $newstr String to replace bad chars with
  468. * @param int $unaccent 1=Remove also accent (default), 0 do not remove them
  469. * @return string String cleaned (a-zA-Z_)
  470. *
  471. * @see dol_string_nospecial, dol_string_unaccent, dol_sanitizePathName
  472. */
  473. function dol_sanitizeFileName($str,$newstr='_',$unaccent=1)
  474. {
  475. $filesystem_forbidden_chars = array('<','>',':','/','\\','?','*','|','"','°');
  476. return dol_string_nospecial($unaccent?dol_string_unaccent($str):$str, $newstr, $filesystem_forbidden_chars);
  477. }
  478. /**
  479. * Clean a string to use it as a path name
  480. *
  481. * @param string $str String to clean
  482. * @param string $newstr String to replace bad chars with
  483. * @param int $unaccent 1=Remove also accent (default), 0 do not remove them
  484. * @return string String cleaned (a-zA-Z_)
  485. *
  486. * @see dol_string_nospecial, dol_string_unaccent, dol_sanitizeFileName
  487. */
  488. function dol_sanitizePathName($str,$newstr='_',$unaccent=1)
  489. {
  490. $filesystem_forbidden_chars = array('<','>','?','*','|','"','°');
  491. return dol_string_nospecial($unaccent?dol_string_unaccent($str):$str, $newstr, $filesystem_forbidden_chars);
  492. }
  493. /**
  494. * Clean a string from all accent characters to be used as ref, login or by dol_sanitizeFileName
  495. *
  496. * @param string $str String to clean
  497. * @return string Cleaned string
  498. *
  499. * @see dol_sanitizeFilename, dol_string_nospecial
  500. */
  501. function dol_string_unaccent($str)
  502. {
  503. if (utf8_check($str))
  504. {
  505. // See http://www.utf8-chartable.de/
  506. $string = rawurlencode($str);
  507. $replacements = array(
  508. '%C3%80' => 'A','%C3%81' => 'A','%C3%82' => 'A','%C3%83' => 'A','%C3%84' => 'A','%C3%85' => 'A',
  509. '%C3%88' => 'E','%C3%89' => 'E','%C3%8A' => 'E','%C3%8B' => 'E',
  510. '%C3%8C' => 'I','%C3%8D' => 'I','%C3%8E' => 'I','%C3%8F' => 'I',
  511. '%C3%92' => 'O','%C3%93' => 'O','%C3%94' => 'O','%C3%95' => 'O','%C3%96' => 'O',
  512. '%C3%99' => 'U','%C3%9A' => 'U','%C3%9B' => 'U','%C3%9C' => 'U',
  513. '%C3%A0' => 'a','%C3%A1' => 'a','%C3%A2' => 'a','%C3%A3' => 'a','%C3%A4' => 'a','%C3%A5' => 'a',
  514. '%C3%A7' => 'c',
  515. '%C3%A8' => 'e','%C3%A9' => 'e','%C3%AA' => 'e','%C3%AB' => 'e',
  516. '%C3%AC' => 'i','%C3%AD' => 'i','%C3%AE' => 'i','%C3%AF' => 'i',
  517. '%C3%B1' => 'n',
  518. '%C3%B2' => 'o','%C3%B3' => 'o','%C3%B4' => 'o','%C3%B5' => 'o','%C3%B6' => 'o',
  519. '%C3%B9' => 'u','%C3%BA' => 'u','%C3%BB' => 'u','%C3%BC' => 'u',
  520. '%C3%BF' => 'y'
  521. );
  522. $string=strtr($string, $replacements);
  523. return rawurldecode($string);
  524. }
  525. else
  526. {
  527. // See http://www.ascii-code.com/
  528. $string = strtr(
  529. $str,
  530. "\xC0\xC1\xC2\xC3\xC4\xC5\xC7
  531. \xC8\xC9\xCA\xCB\xCC\xCD\xCE\xCF\xD0\xD1
  532. \xD2\xD3\xD4\xD5\xD8\xD9\xDA\xDB\xDD
  533. \xE0\xE1\xE2\xE3\xE4\xE5\xE7\xE8\xE9\xEA\xEB
  534. \xEC\xED\xEE\xEF\xF0\xF1\xF2\xF3\xF4\xF5\xF8
  535. \xF9\xFA\xFB\xFC\xFD\xFF",
  536. "AAAAAAC
  537. EEEEIIIIDN
  538. OOOOOUUUY
  539. aaaaaaceeee
  540. iiiidnooooo
  541. uuuuyy"
  542. );
  543. $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"));
  544. return $string;
  545. }
  546. }
  547. /**
  548. * Clean a string from all punctuation characters to use it as a ref or login
  549. *
  550. * @param string $str String to clean
  551. * @param string $newstr String to replace forbidden chars with
  552. * @param array $badcharstoreplace List of forbidden characters
  553. * @return string Cleaned string
  554. *
  555. * @see dol_sanitizeFilename, dol_string_unaccent
  556. */
  557. function dol_string_nospecial($str,$newstr='_',$badcharstoreplace='')
  558. {
  559. $forbidden_chars_to_replace=array(" ","'","/","\\",":","*","?","\"","<",">","|","[","]",",",";","=");
  560. $forbidden_chars_to_remove=array();
  561. if (is_array($badcharstoreplace)) $forbidden_chars_to_replace=$badcharstoreplace;
  562. //$forbidden_chars_to_remove=array("(",")");
  563. return str_replace($forbidden_chars_to_replace,$newstr,str_replace($forbidden_chars_to_remove,"",$str));
  564. }
  565. /**
  566. * Encode string for xml usage
  567. *
  568. * @param string $string String to encode
  569. * @return string String encoded
  570. */
  571. function dolEscapeXML($string)
  572. {
  573. return strtr($string, array('\''=>'&apos;','"'=>'&quot;','&'=>'&amp;','<'=>'&lt;','>'=>'&gt;'));
  574. }
  575. /**
  576. * Returns text escaped for inclusion into javascript code
  577. *
  578. * @param string $stringtoescape String to escape
  579. * @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 \
  580. * @param int $noescapebackslashn 0=Escape also \n. 1=Do not escape \n.
  581. * @return string Escaped string. Both ' and " are escaped into ' if they are escaped.
  582. */
  583. function dol_escape_js($stringtoescape, $mode=0, $noescapebackslashn=0)
  584. {
  585. // escape quotes and backslashes, newlines, etc.
  586. $substitjs=array("&#039;"=>"\\'","\r"=>'\\r');
  587. //$substitjs['</']='<\/'; // We removed this. Should be useless.
  588. if (empty($noescapebackslashn)) { $substitjs["\n"]='\\n'; $substitjs['\\']='\\\\'; }
  589. if (empty($mode)) { $substitjs["'"]="\\'"; $substitjs['"']="\\'"; }
  590. else if ($mode == 1) $substitjs["'"]="\\'";
  591. else if ($mode == 2) { $substitjs['"']='\\"'; }
  592. else if ($mode == 3) { $substitjs["'"]="\\'"; $substitjs['"']="\\\""; }
  593. return strtr($stringtoescape, $substitjs);
  594. }
  595. /**
  596. * Returns text escaped for inclusion in HTML alt or title tags, or into values of HTML input fields.
  597. *
  598. * @param string $stringtoescape String to escape
  599. * @param int $keepb 1=Preserve b tags (otherwise, remove them)
  600. * @param int $keepn 1=Preserve \r\n strings (otherwise, remove them)
  601. * @return string Escaped string
  602. *
  603. * @see dol_string_nohtmltag
  604. */
  605. function dol_escape_htmltag($stringtoescape, $keepb=0, $keepn=0)
  606. {
  607. // escape quotes and backslashes, newlines, etc.
  608. $tmp=dol_html_entity_decode($stringtoescape,ENT_COMPAT,'UTF-8');
  609. if (! $keepb) $tmp=strtr($tmp, array("<b>"=>'','</b>'=>''));
  610. if (! $keepn) $tmp=strtr($tmp, array("\r"=>'\\r',"\n"=>'\\n'));
  611. return dol_htmlentities($tmp,ENT_COMPAT,'UTF-8');
  612. }
  613. /**
  614. * Convert a string to lower. Never use strtolower because it does not works with UTF8 strings.
  615. *
  616. * @param string $utf8_string String to encode
  617. * @return string String converted
  618. */
  619. function dol_strtolower($utf8_string)
  620. {
  621. return mb_strtolower($utf8_string, "UTF-8");
  622. }
  623. /**
  624. * Convert a string to upper. Never use strtolower because it does not works with UTF8 strings.
  625. *
  626. * @param string $utf8_string String to encode
  627. * @return string String converted
  628. */
  629. function dol_strtoupper($utf8_string)
  630. {
  631. return mb_strtoupper($utf8_string, "UTF-8");
  632. }
  633. /**
  634. * Write log message into outputs. Possible outputs can be:
  635. * SYSLOG_HANDLERS = ["mod_syslog_file"] file name is then defined by SYSLOG_FILE
  636. * SYSLOG_HANDLERS = ["mod_syslog_syslog"] facility is then defined by SYSLOG_FACILITY
  637. * Warning, syslog functions are bugged on Windows, generating memory protection faults. To solve
  638. * this, use logging to files instead of syslog (see setup of module).
  639. * Note: If SYSLOG_FILE_NO_ERROR defined, we never output any error message when writing to log fails.
  640. * Note: You can get log message into html sources by adding parameter &logtohtml=1 (constant MAIN_LOGTOHTML must be set)
  641. * This function works only if syslog module is enabled.
  642. * This must not use any call to other function calling dol_syslog (avoid infinite loop).
  643. *
  644. * @param string $message Line to log. ''=Show nothing
  645. * @param int $level Log level
  646. * 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
  647. * On Linux LOG_ERR=3, LOG_WARNING=4, LOG_INFO=6, LOG_DEBUG=7
  648. * @param int $ident 1=Increase ident of 1, -1=Decrease ident of 1
  649. * @param string $suffixinfilename When output is a file, append this suffix into default log filename.
  650. * @param string $restricttologhandler Output log only for this log handler
  651. * @return void
  652. */
  653. function dol_syslog($message, $level = LOG_INFO, $ident = 0, $suffixinfilename='', $restricttologhandler='')
  654. {
  655. global $conf, $user;
  656. // If syslog module enabled
  657. if (empty($conf->syslog->enabled)) return;
  658. if (! empty($message))
  659. {
  660. // Test log level
  661. $logLevels = array(LOG_EMERG, LOG_ALERT, LOG_CRIT, LOG_ERR, LOG_WARNING, LOG_NOTICE, LOG_INFO, LOG_DEBUG);
  662. if (!in_array($level, $logLevels, true))
  663. {
  664. throw new Exception('Incorrect log level');
  665. }
  666. if ($level > $conf->global->SYSLOG_LEVEL) return;
  667. // If adding log inside HTML page is required
  668. if (! empty($_REQUEST['logtohtml']) && (! empty($conf->global->MAIN_ENABLE_LOG_TO_HTML) || ! empty($conf->global->MAIN_LOGTOHTML))) // MAIN_LOGTOHTML kept for backward compatibility
  669. {
  670. $conf->logbuffer[] = dol_print_date(time(),"%Y-%m-%d %H:%M:%S")." ".$message;
  671. }
  672. //TODO: Remove this. MAIN_ENABLE_LOG_INLINE_HTML should be deprecated and use a log handler dedicated to HTML output
  673. // If enable html log tag enabled and url parameter log defined, we show output log on HTML comments
  674. if (! empty($conf->global->MAIN_ENABLE_LOG_INLINE_HTML) && ! empty($_GET["log"]))
  675. {
  676. print "\n\n<!-- Log start\n";
  677. print $message."\n";
  678. print "Log end -->\n";
  679. }
  680. $data = array(
  681. 'message' => $message,
  682. 'script' => (isset($_SERVER['PHP_SELF'])? basename($_SERVER['PHP_SELF'],'.php') : false),
  683. 'level' => $level,
  684. 'user' => ((is_object($user) && $user->id) ? $user->login : false),
  685. 'ip' => false
  686. );
  687. if (! empty($_SERVER["REMOTE_ADDR"])) $data['ip'] = $_SERVER['REMOTE_ADDR'];
  688. // This is when PHP session is ran inside a web server but not inside a client request (example: init code of apache)
  689. else if (! empty($_SERVER['SERVER_ADDR'])) $data['ip'] = $_SERVER['SERVER_ADDR'];
  690. // 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).
  691. else if (! empty($_SERVER['COMPUTERNAME'])) $data['ip'] = $_SERVER['COMPUTERNAME'].(empty($_SERVER['USERNAME'])?'':'@'.$_SERVER['USERNAME']);
  692. // 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).
  693. else if (! empty($_SERVER['LOGNAME'])) $data['ip'] = '???@'.$_SERVER['LOGNAME'];
  694. // Loop on each log handler and send output
  695. foreach ($conf->loghandlers as $loghandlerinstance)
  696. {
  697. if ($restricttologhandler && $loghandlerinstance->code != $restricttologhandler) continue;
  698. $loghandlerinstance->export($data,$suffixinfilename);
  699. }
  700. unset($data);
  701. }
  702. if (! empty($ident))
  703. {
  704. foreach ($conf->loghandlers as $loghandlerinstance)
  705. {
  706. $loghandlerinstance->setIdent($ident);
  707. }
  708. }
  709. }
  710. /**
  711. * Show tab header of a card
  712. *
  713. * @param array $links Array of tabs. Currently initialized by calling a function xxx_admin_prepare_head
  714. * @param string $active Active tab name (document', 'info', 'ldap', ....)
  715. * @param string $title Title
  716. * @param int $notab 0=Add tab header, 1=no tab header. If you set this to 1, using dol_fiche_end() to close tab is not required.
  717. * @param string $picto Add a picto on tab title
  718. * @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.
  719. * @return void
  720. */
  721. function dol_fiche_head($links=array(), $active='0', $title='', $notab=0, $picto='', $pictoisfullpath=0)
  722. {
  723. print dol_get_fiche_head($links, $active, $title, $notab, $picto, $pictoisfullpath);
  724. }
  725. /**
  726. * Show tab header of a card
  727. *
  728. * @param array $links Array of tabs
  729. * @param string $active Active tab name
  730. * @param string $title Title
  731. * @param int $notab 0=Add tab header, 1=no tab header. If you set this to 1, using dol_fiche_end() to close tab is not required.
  732. * @param string $picto Add a picto on tab title
  733. * @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.
  734. * @return string
  735. */
  736. function dol_get_fiche_head($links=array(), $active='', $title='', $notab=0, $picto='', $pictoisfullpath=0)
  737. {
  738. global $conf, $langs, $hookmanager;
  739. if ($notab == -1) $notab = 0; // For better compatiblity with modules for 6.0
  740. $out="\n".'<div class="tabs" data-role="controlgroup" data-type="horizontal">'."\n";
  741. // Show title
  742. $showtitle=1;
  743. if (! empty($conf->dol_optimize_smallscreen)) $showtitle=0;
  744. if (! empty($title) && $showtitle)
  745. {
  746. $limittitle=30;
  747. $out.='<a class="tabTitle">';
  748. if ($picto) $out.=img_picto($title,($pictoisfullpath?'':'object_').$picto,'',$pictoisfullpath).' ';
  749. $out.='<span class="tabTitleText">'.dol_trunc($title,$limittitle).'</span>';
  750. $out.='</a>';
  751. }
  752. // Define max of key (max may be higher than sizeof because of hole due to module disabling some tabs).
  753. $maxkey=-1;
  754. if (is_array($links) && ! empty($links))
  755. {
  756. $keys=array_keys($links);
  757. if (count($keys)) $maxkey=max($keys);
  758. }
  759. // Show tabs
  760. $bactive=false;
  761. // if =0 we don't use the feature
  762. $limittoshow=(empty($conf->global->MAIN_MAXTABS_IN_CARD)?99:$conf->global->MAIN_MAXTABS_IN_CARD);
  763. $displaytab=0;
  764. $nbintab=0;
  765. $popuptab=0;
  766. for ($i = 0 ; $i <= $maxkey ; $i++)
  767. {
  768. if ((is_numeric($active) && $i == $active) || (! empty($links[$i][2]) && ! is_numeric($active) && $active == $links[$i][2]))
  769. {
  770. // si l'active est présent dans la box
  771. if ($i >= $limittoshow)
  772. $limittoshow--;
  773. }
  774. }
  775. for ($i = 0 ; $i <= $maxkey ; $i++)
  776. {
  777. if ((is_numeric($active) && $i == $active) || (! empty($links[$i][2]) && ! is_numeric($active) && $active == $links[$i][2]))
  778. {
  779. $isactive=true;
  780. $bactive=true;
  781. }
  782. else
  783. $isactive=false;
  784. if ($i < $limittoshow || $isactive)
  785. {
  786. $out.='<div class="inline-block tabsElem'.($isactive ? ' tabsElemActive' : '').((! $isactive && ! empty($conf->global->MAIN_HIDE_INACTIVETAB_ON_PRINT))?' hideonprint':'').'"><!-- id tab = '.(empty($links[$i][2])?'':$links[$i][2]).' -->';
  787. if (isset($links[$i][2]) && $links[$i][2] == 'image')
  788. {
  789. if (!empty($links[$i][0]))
  790. {
  791. $out.='<a data-role="button" class="tabimage" href="'.$links[$i][0].'">'.$links[$i][1].'</a>'."\n";
  792. }
  793. else
  794. {
  795. $out.='<span data-role="button" class="tabspan">'.$links[$i][1].'</span>'."\n";
  796. }
  797. }
  798. else if (! empty($links[$i][1]))
  799. {
  800. //print "x $i $active ".$links[$i][2]." z";
  801. if ($isactive)
  802. {
  803. $out.='<a data-role="button"'.(! empty($links[$i][2])?' id="'.$links[$i][2].'"':'').' class="tabactive tab inline-block" href="'.$links[$i][0].'">'.$links[$i][1].'</a>'."\n";
  804. }
  805. else
  806. {
  807. $out.='<a data-role="button"'.(! empty($links[$i][2])?' id="'.$links[$i][2].'"':'').' class="tabunactive tab inline-block" href="'.$links[$i][0].'">'.$links[$i][1].'</a>'."\n";
  808. }
  809. }
  810. $out.='</div>';
  811. }
  812. else
  813. {
  814. // The popup with the other tabs
  815. if (! $popuptab)
  816. {
  817. $popuptab=1;
  818. $outmore.='<div class="popuptabset">';
  819. }
  820. $outmore.='<div class="popuptab" style="display:inherit;">';
  821. if (isset($links[$i][2]) && $links[$i][2] == 'image')
  822. {
  823. if (!empty($links[$i][0]))
  824. $outmore.='<a class="tabimage" href="'.$links[$i][0].'">'.$links[$i][1].'</a>'."\n";
  825. else
  826. $outmore.='<span class="tabspan">'.$links[$i][1].'</span>'."\n";
  827. }
  828. else if (! empty($links[$i][1]))
  829. $outmore.='<a'.(! empty($links[$i][2])?' id="'.$links[$i][2].'"':'').' class="inline-block" href="'.$links[$i][0].'">'.$links[$i][1].'</a>'."\n";
  830. $outmore.='</div>';
  831. $nbintab++;
  832. }
  833. $displaytab=$i;
  834. }
  835. if ($popuptab) $outmore.='</div>';
  836. if ($displaytab > $limittoshow)
  837. {
  838. $tabsname=str_replace("@", "", $picto);
  839. $out.='<div id="moretabs'.$tabsname.'" class="inline-block tabsElem">';
  840. $out.='<a href="#" data-role="button" class="tab moretab inline-block">'.$langs->trans("More").'... ('.$nbintab.')</a>';
  841. $out.='<div id="moretabsList'.$tabsname.'" style="position: absolute; left: -999em;text-align: left;margin:0px;padding:2px">'.$outmore.'</div>';
  842. $out.="</div>\n";
  843. $out.="<script>";
  844. $out.="$('#moretabs".$tabsname."').mouseenter( function() { $('#moretabsList".$tabsname."').css('left','auto');});";
  845. $out.="$('#moretabs".$tabsname."').mouseleave( function() { $('#moretabsList".$tabsname."').css('left','-999em');});";
  846. $out.="</script>";
  847. }
  848. $out.="</div>\n";
  849. if (! $notab) $out.="\n".'<div class="tabBar">'."\n";
  850. $parameters=array('tabname' => $active, 'out' => $out);
  851. $reshook=$hookmanager->executeHooks('printTabsHead',$parameters); // This hook usage is called just before output the head of tabs. Take also a look at "completeTabsHead"
  852. if ($reshook > 0)
  853. {
  854. $out = $hookmanager->resPrint;
  855. }
  856. return $out;
  857. }
  858. /**
  859. * Show tab footer of a card
  860. *
  861. * @param int $notab 0=Add tab footer, 1=no tab footer
  862. * @return void
  863. */
  864. function dol_fiche_end($notab=0)
  865. {
  866. print dol_get_fiche_end($notab);
  867. }
  868. /**
  869. * Return tab footer of a card
  870. *
  871. * @param int $notab 0=Add tab footer, 1=no tab footer
  872. * @return string
  873. */
  874. function dol_get_fiche_end($notab=0)
  875. {
  876. if (! $notab) return "\n</div>\n";
  877. else return '';
  878. }
  879. /**
  880. * Show tab footer of a card
  881. *
  882. * @param object $object Object to show
  883. * @param string $paramid Name of parameter to use to name the id into the URL next/previous link
  884. * @param string $morehtml More html content to output just before the nav bar
  885. * @param int $shownav Show Condition (navigation is shown if value is 1)
  886. * @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)
  887. * @param string $fieldref Nom du champ objet ref (object->ref) a utiliser pour select next et previous
  888. * @param string $morehtmlref More html to show after ref
  889. * @param string $moreparam More param to add in nav link url.
  890. * @param int $nodbprefix Do not include DB prefix to forge table name
  891. * @param string $morehtmlleft More html code to show before ref
  892. * @param string $morehtmlstatus More html code to show under navigation arrows
  893. * @param int $onlybanner Put this to 1, if the card will contains only a banner (add css 'arearefnobottom' on div)
  894. * @param string $morehtmlright More html code to show before navigation arrows
  895. * @return void
  896. */
  897. function dol_banner_tab($object, $paramid, $morehtml='', $shownav=1, $fieldid='rowid', $fieldref='ref', $morehtmlref='', $moreparam='', $nodbprefix=0, $morehtmlleft='', $morehtmlstatus='', $onlybanner=0, $morehtmlright='')
  898. {
  899. global $conf, $form, $user, $langs;
  900. $maxvisiblephotos=1;
  901. $showimage=1;
  902. $showbarcode=empty($conf->barcode->enabled)?0:($object->barcode?1:0);
  903. if (! empty($conf->global->MAIN_USE_ADVANCED_PERMS) && empty($user->rights->barcode->lire_advance)) $showbarcode=0;
  904. $modulepart='unknown';
  905. if ($object->element == 'societe') $modulepart='societe';
  906. if ($object->element == 'contact') $modulepart='contact';
  907. if ($object->element == 'member') $modulepart='memberphoto';
  908. if ($object->element == 'user') $modulepart='userphoto';
  909. if ($object->element == 'product') $modulepart='product';
  910. if ($object->element == 'product')
  911. {
  912. $width=80; $cssclass='photoref';
  913. $showimage=$object->is_photo_available($conf->product->multidir_output[$object->entity]);
  914. $maxvisiblephotos=(isset($conf->global->PRODUCT_MAX_VISIBLE_PHOTO)?$conf->global->PRODUCT_MAX_VISIBLE_PHOTO:5);
  915. if ($conf->browser->phone) $maxvisiblephotos=1;
  916. if ($showimage) $morehtmlleft.='<div class="floatleft inline-block valignmiddle divphotoref">'.$object->show_photos($conf->product->multidir_output[$object->entity],'small',$maxvisiblephotos,0,0,0,$width,0).'</div>';
  917. else
  918. {
  919. if (!empty($conf->global->PRODUCT_NODISPLAYIFNOPHOTO)) {
  920. $nophoto='';
  921. $morehtmlleft.='<div class="floatleft inline-block valignmiddle divphotoref"></div>';
  922. }
  923. elseif ($conf->browser->layout != 'phone') { // Show no photo link
  924. $nophoto='/public/theme/common/nophoto.png';
  925. $morehtmlleft.='<div class="floatleft inline-block valignmiddle divphotoref"><img class="photo'.$modulepart.($cssclass?' '.$cssclass:'').'" alt="No photo" border="0"'.($width?' width="'.$width.'"':'').($height?' height="'.$height.'"':'').' src="'.DOL_URL_ROOT.$nophoto.'"></div>';
  926. }
  927. }
  928. }
  929. else
  930. {
  931. if ($showimage)
  932. {
  933. if ($modulepart != 'unknown')
  934. {
  935. $phototoshow = $form->showphoto($modulepart,$object,0,0,0,'photoref','small',1,0,$maxvisiblephotos);
  936. if ($phototoshow)
  937. {
  938. $morehtmlleft.='<div class="floatleft inline-block valignmiddle divphotoref">';
  939. $morehtmlleft.=$phototoshow;
  940. $morehtmlleft.='</div>';
  941. }
  942. }
  943. elseif ($conf->browser->layout != 'phone') // Show No photo link (picto of pbject)
  944. {
  945. $morehtmlleft.='<div class="floatleft inline-block valignmiddle divphotoref">';
  946. if ($object->element == 'action')
  947. {
  948. $cssclass='photorefcenter';
  949. $nophoto=img_picto('', 'title_agenda', '', false, 1);
  950. $morehtmlleft.='<div class="floatleft inline-block valignmiddle divphotoref"><div class="photoref"><img class="photo'.$modulepart.($cssclass?' '.$cssclass:'').'" alt="No photo" border="0"'.($width?' width="'.$width.'"':'').($height?' height="'.$height.'"':'').' src="'.$nophoto.'"></div></div>';
  951. }
  952. else
  953. {
  954. $width=14; $cssclass='photorefcenter';
  955. $picto = $object->picto;
  956. if ($object->element == 'project' && ! $object->public) $picto = 'project'; // instead of projectpub
  957. $nophoto=img_picto('', 'object_'.$picto, '', false, 1);
  958. $morehtmlleft.='<div class="floatleft inline-block valignmiddle divphotoref"><div class="photoref"><img class="photo'.$modulepart.($cssclass?' '.$cssclass:'').'" alt="No photo" border="0"'.($width?' width="'.$width.'"':'').($height?' height="'.$height.'"':'').' src="'.$nophoto.'"></div></div>';
  959. }
  960. $morehtmlleft.='</div>';
  961. }
  962. }
  963. }
  964. if ($showbarcode) $morehtmlleft.='<div class="floatleft inline-block valignmiddle divphotoref">'.$form->showbarcode($object).'</div>';
  965. if ($object->element == 'societe' && ! empty($conf->use_javascript_ajax) && $user->rights->societe->creer && ! empty($conf->global->MAIN_DIRECT_STATUS_UPDATE)) {
  966. $morehtmlstatus.=ajax_object_onoff($object, 'status', 'status', 'InActivity', 'ActivityCeased');
  967. }
  968. elseif ($object->element == 'product')
  969. {
  970. //$morehtmlstatus.=$langs->trans("Status").' ('.$langs->trans("Sell").') ';
  971. if (! empty($conf->use_javascript_ajax) && $user->rights->produit->creer && ! empty($conf->global->MAIN_DIRECT_STATUS_UPDATE)) {
  972. $morehtmlstatus.=ajax_object_onoff($object, 'status', 'tosell', 'ProductStatusOnSell', 'ProductStatusNotOnSell');
  973. } else {
  974. $morehtmlstatus.=$object->getLibStatut(5,0);
  975. }
  976. $morehtmlstatus.=' &nbsp; ';
  977. //$morehtmlstatus.=$langs->trans("Status").' ('.$langs->trans("Buy").') ';
  978. if (! empty($conf->use_javascript_ajax) && $user->rights->produit->creer && ! empty($conf->global->MAIN_DIRECT_STATUS_UPDATE)) {
  979. $morehtmlstatus.=ajax_object_onoff($object, 'status_buy', 'tobuy', 'ProductStatusOnBuy', 'ProductStatusNotOnBuy');
  980. } else {
  981. $morehtmlstatus.=$object->getLibStatut(5,1);
  982. }
  983. }
  984. elseif ($object->element == 'facture' || $object->element == 'invoice' || $object->element == 'invoice_supplier')
  985. {
  986. $tmptxt=$object->getLibStatut(6, $object->totalpaye);
  987. if (empty($tmptxt) || $tmptxt == $object->getLibStatut(3) || $conf->browser->layout=='phone') $tmptxt=$object->getLibStatut(5, $object->totalpaye);
  988. $morehtmlstatus.=$tmptxt;
  989. }
  990. elseif ($object->element == 'chargesociales')
  991. {
  992. $tmptxt=$object->getLibStatut(6, $object->totalpaye);
  993. if (empty($tmptxt) || $tmptxt == $object->getLibStatut(3) || $conf->browser->layout=='phone') $tmptxt=$object->getLibStatut(5, $object->totalpaye);
  994. $morehtmlstatus.=$tmptxt;
  995. }
  996. elseif ($object->element == 'loan')
  997. {
  998. $tmptxt=$object->getLibStatut(6, $object->totalpaye);
  999. if (empty($tmptxt) || $tmptxt == $object->getLibStatut(3) || $conf->browser->layout=='phone') $tmptxt=$object->getLibStatut(5, $object->totalpaye);
  1000. $morehtmlstatus.=$tmptxt;
  1001. }
  1002. elseif ($object->element == 'contrat')
  1003. {
  1004. if ($object->statut==0) $morehtmlstatus.=$object->getLibStatut(2);
  1005. else $morehtmlstatus.=$object->getLibStatut(4);
  1006. }
  1007. else { // Generic case
  1008. $tmptxt=$object->getLibStatut(6);
  1009. if (empty($tmptxt) || $tmptxt == $object->getLibStatut(3) || $conf->browser->layout=='phone') $tmptxt=$object->getLibStatut(5);
  1010. $morehtmlstatus.=$tmptxt;
  1011. }
  1012. if (! empty($object->name_alias)) $morehtmlref.='<div class="refidno">'.$object->name_alias.'</div>'; // For thirdparty
  1013. if ($object->element == 'product' || $object->element == 'bank_account')
  1014. {
  1015. if(! empty($object->label)) $morehtmlref.='<div class="refidno">'.$object->label.'</div>';
  1016. }
  1017. if ($object->element != 'product' && $object->element != 'bookmark')
  1018. {
  1019. $morehtmlref.='<div class="refidno">';
  1020. $morehtmlref.=$object->getBannerAddress('refaddress',$object);
  1021. $morehtmlref.='</div>';
  1022. }
  1023. if (! empty($conf->global->MAIN_SHOW_TECHNICAL_ID) && in_array($object->element, array('societe', 'contact', 'member', 'product')))
  1024. {
  1025. $morehtmlref.='<div style="clear: both;"></div><div class="refidno">';
  1026. $morehtmlref.=$langs->trans("TechnicalID").': '.$object->id;
  1027. $morehtmlref.='</div>';
  1028. }
  1029. print '<div class="'.($onlybanner?'arearefnobottom ':'arearef ').'heightref valignmiddle" width="100%">';
  1030. print $form->showrefnav($object, $paramid, $morehtml, $shownav, $fieldid, $fieldref, $morehtmlref, $moreparam, $nodbprefix, $morehtmlleft, $morehtmlstatus, $morehtmlright);
  1031. print '</div>';
  1032. print '<div class="underrefbanner clearboth"></div>';
  1033. }
  1034. /**
  1035. * Show a string with the label tag dedicated to the HTML edit field.
  1036. *
  1037. * @param string $langkey Translation key
  1038. * @param string $fieldkey Key of the html select field the text refers to
  1039. * @param int $fieldrequired 1=Field is mandatory
  1040. * @deprecated Form::editfieldkey
  1041. */
  1042. function fieldLabel($langkey, $fieldkey, $fieldrequired=0)
  1043. {
  1044. global $conf, $langs;
  1045. $ret='';
  1046. if ($fieldrequired) $ret.='<span class="fieldrequired">';
  1047. if (($conf->dol_use_jmobile != 4)) $ret.='<label for="'.$fieldkey.'">';
  1048. $ret.=$langs->trans($langkey);
  1049. if (($conf->dol_use_jmobile != 4)) $ret.='</label>';
  1050. if ($fieldrequired) $ret.='</span>';
  1051. return $ret;
  1052. }
  1053. /**
  1054. * Return string to add class property on html element with pair/impair.
  1055. *
  1056. * @param string $var 0 or 1
  1057. * @param string $moreclass More class to add
  1058. * @return string String to add class onto HTML element
  1059. */
  1060. function dol_bc($var,$moreclass='')
  1061. {
  1062. global $bc;
  1063. $ret=' '.$bc[$var];
  1064. if ($moreclass) $ret=preg_replace('/class=\"/','class="'.$moreclass.' ',$ret);
  1065. return $ret;
  1066. }
  1067. /**
  1068. * Return a formated address (part address/zip/town/state) according to country rules
  1069. *
  1070. * @param Object $object A company or contact object
  1071. * @param int $withcountry 1=Add country into address string
  1072. * @param string $sep Separator to use to build string
  1073. * @param Translate $outputlangs Object lang that contains language for text translation.
  1074. * @return string Formated string
  1075. * @see dol_print_address
  1076. */
  1077. function dol_format_address($object,$withcountry=0,$sep="\n",$outputlangs='')
  1078. {
  1079. global $conf,$langs;
  1080. $ret='';
  1081. $countriesusingstate=array('AU','CA','US','IN','GB','ES','UK','TR'); // See also MAIN_FORCE_STATE_INTO_ADDRESS
  1082. // Address
  1083. $ret .= $object->address;
  1084. // Zip/Town/State
  1085. if (in_array($object->country_code,array('AU', 'CA', 'US')) || ! empty($conf->global->MAIN_FORCE_STATE_INTO_ADDRESS)) // US: title firstname name \n address lines \n town, state, zip \n country
  1086. {
  1087. $ret .= ($ret ? $sep : '' ).$object->town;
  1088. if ($object->state)
  1089. {
  1090. $ret.=($ret?", ":'').$object->state;
  1091. }
  1092. if ($object->zip) $ret .= ($ret?", ":'').$object->zip;
  1093. }
  1094. else if (in_array($object->country_code,array('GB','UK'))) // UK: title firstname name \n address lines \n town state \n zip \n country
  1095. {
  1096. $ret .= ($ret ? $sep : '' ).$object->town;
  1097. if ($object->state)
  1098. {
  1099. $ret.=($ret?", ":'').$object->state;
  1100. }
  1101. if ($object->zip) $ret .= ($ret ? $sep : '' ).$object->zip;
  1102. }
  1103. else if (in_array($object->country_code,array('ES','TR'))) // ES: title firstname name \n address lines \n zip town \n state \n country
  1104. {
  1105. $ret .= ($ret ? $sep : '' ).$object->zip;
  1106. $ret .= ($object->town?(($object->zip?' ':'').$object->town):'');
  1107. if ($object->state)
  1108. {
  1109. $ret.="\n".$object->state;
  1110. }
  1111. }
  1112. else // Other: title firstname name \n address lines \n zip town \n country
  1113. {
  1114. $ret .= $object->zip ? (($ret ? $sep : '' ).$object->zip) : '';
  1115. $ret .= ($object->town?(($object->zip?' ':($ret ? $sep : '' )).$object->town):'');
  1116. if ($object->state && in_array($object->country_code,$countriesusingstate))
  1117. {
  1118. $ret.=($ret?", ":'').$object->state;
  1119. }
  1120. }
  1121. if (! is_object($outputlangs)) $outputlangs=$langs;
  1122. if ($withcountry) $ret.=($object->country_code?($ret?$sep:'').$outputlangs->convToOutputCharset($outputlangs->transnoentitiesnoconv("Country".$object->country_code)):'');
  1123. return $ret;
  1124. }
  1125. /**
  1126. * Format a string.
  1127. *
  1128. * @param string $fmt Format of strftime function (http://php.net/manual/fr/function.strftime.php)
  1129. * @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)
  1130. * @param int $is_gmt See comment of timestamp parameter
  1131. * @return string A formatted string
  1132. */
  1133. function dol_strftime($fmt, $ts=false, $is_gmt=false)
  1134. {
  1135. if ((abs($ts) <= 0x7FFFFFFF)) { // check if number in 32-bit signed range
  1136. return ($is_gmt)? @gmstrftime($fmt,$ts): @strftime($fmt,$ts);
  1137. }
  1138. else return 'Error date into a not supported range';
  1139. }
  1140. /**
  1141. * Output date in a string format according to outputlangs (or langs if not defined).
  1142. * Return charset is always UTF-8, except if encodetoouput is defined. In this case charset is output charset
  1143. *
  1144. * @param int $time GM Timestamps date
  1145. * @param string $format Output date format (tag of strftime function)
  1146. * "%d %b %Y",
  1147. * "%d/%m/%Y %H:%M",
  1148. * "%d/%m/%Y %H:%M:%S",
  1149. * "%B"=Long text of month, "%A"=Long text of day, "%b"=Short text of month, "%a"=Short text of day
  1150. * "day", "daytext", "dayhour", "dayhourldap", "dayhourtext", "dayrfc", "dayhourrfc", "...reduceformat"
  1151. * @param string $tzoutput true or 'gmt' => string is for Greenwich location
  1152. * false or 'tzserver' => output string is for local PHP server TZ usage
  1153. * 'tzuser' => output string is for user TZ (current browser TZ with current dst)
  1154. * 'tzuserrel' => output string is for user TZ (current browser TZ with dst or not, depending on date position)
  1155. * @param Translate $outputlangs Object lang that contains language for text translation.
  1156. * @param boolean $encodetooutput false=no convert into output pagecode
  1157. * @return string Formated date or '' if time is null
  1158. *
  1159. * @see dol_mktime, dol_stringtotime, dol_getdate
  1160. */
  1161. function dol_print_date($time,$format='',$tzoutput='tzserver',$outputlangs='',$encodetooutput=false)
  1162. {
  1163. global $conf,$langs;
  1164. // Clean parameters
  1165. $to_gmt=false;
  1166. $offsettz=$offsetdst=0;
  1167. if ($tzoutput)
  1168. {
  1169. $to_gmt=true; // For backward compatibility
  1170. if (is_string($tzoutput))
  1171. {
  1172. if ($tzoutput == 'tzserver')
  1173. {
  1174. $to_gmt=false;
  1175. $offsettzstring=@date_default_timezone_get(); // Example 'Europe/Berlin' or 'Indian/Reunion'
  1176. $offsettz=0;
  1177. $offsetdst=0;
  1178. }
  1179. elseif ($tzoutput == 'tzuser')
  1180. {
  1181. $to_gmt=true;
  1182. $offsettzstring=(empty($_SESSION['dol_tz_string'])?'UTC':$_SESSION['dol_tz_string']); // Example 'Europe/Berlin' or 'Indian/Reunion'
  1183. $offsettz=(empty($_SESSION['dol_tz'])?0:$_SESSION['dol_tz'])*60*60;
  1184. $offsetdst=(empty($_SESSION['dol_dst'])?0:$_SESSION['dol_dst'])*60*60;
  1185. }
  1186. }
  1187. }
  1188. if (! is_object($outputlangs)) $outputlangs=$langs;
  1189. if (! $format) $format='daytextshort';
  1190. $reduceformat=(! empty($conf->dol_optimize_smallscreen) && in_array($format,array('day','dayhour')))?1:0;
  1191. $formatwithoutreduce = preg_replace('/reduceformat/','',$format);
  1192. if ($formatwithoutreduce != $format) { $format = $formatwithoutreduce; $reduceformat=1; } // so format 'dayreduceformat' is processed like day
  1193. // Change predefined format into computer format. If found translation in lang file we use it, otherwise we use default.
  1194. // TODO Add format daysmallyear and dayhoursmallyear
  1195. if ($format == 'day') $format=($outputlangs->trans("FormatDateShort")!="FormatDateShort"?$outputlangs->trans("FormatDateShort"):$conf->format_date_short);
  1196. else if ($format == 'hour') $format=($outputlangs->trans("FormatHourShort")!="FormatHourShort"?$outputlangs->trans("FormatHourShort"):$conf->format_hour_short);
  1197. else if ($format == 'hourduration') $format=($outputlangs->trans("FormatHourShortDuration")!="FormatHourShortDuration"?$outputlangs->trans("FormatHourShortDuration"):$conf->format_hour_short_duration);
  1198. else if ($format == 'daytext') $format=($outputlangs->trans("FormatDateText")!="FormatDateText"?$outputlangs->trans("FormatDateText"):$conf->format_date_text);
  1199. else if ($format == 'daytextshort') $format=($outputlangs->trans("FormatDateTextShort")!="FormatDateTextShort"?$outputlangs->trans("FormatDateTextShort"):$conf->format_date_text_short);
  1200. else if ($format == 'dayhour') $format=($outputlangs->trans("FormatDateHourShort")!="FormatDateHourShort"?$outputlangs->trans("FormatDateHourShort"):$conf->format_date_hour_short);
  1201. else if ($format == 'dayhoursec') $format=($outputlangs->trans("FormatDateHourSecShort")!="FormatDateHourSecShort"?$outputlangs->trans("FormatDateHourSecShort"):$conf->format_date_hour_sec_short);
  1202. else if ($format == 'dayhourtext') $format=($outputlangs->trans("FormatDateHourText")!="FormatDateHourText"?$outputlangs->trans("FormatDateHourText"):$conf->format_date_hour_text);
  1203. else if ($format == 'dayhourtextshort') $format=($outputlangs->trans("FormatDateHourTextShort")!="FormatDateHourTextShort"?$outputlangs->trans("FormatDateHourTextShort"):$conf->format_date_hour_text_short);
  1204. // Format not sensitive to language
  1205. else if ($format == 'dayhourlog') $format='%Y%m%d%H%M%S';
  1206. else if ($format == 'dayhourldap') $format='%Y%m%d%H%M%SZ';
  1207. else if ($format == 'dayhourxcard') $format='%Y%m%dT%H%M%SZ';
  1208. else if ($format == 'dayxcard') $format='%Y%m%d';
  1209. else if ($format == 'dayrfc') $format='%Y-%m-%d'; // DATE_RFC3339
  1210. else if ($format == 'dayhourrfc') $format='%Y-%m-%dT%H:%M:%SZ'; // DATETIME RFC3339
  1211. else if ($format == 'standard') $format='%Y-%m-%d %H:%M:%S';
  1212. if ($reduceformat)
  1213. {
  1214. $format=str_replace('%Y','%y',$format);
  1215. $format=str_replace('yyyy','yy',$format);
  1216. }
  1217. // If date undefined or "", we return ""
  1218. if (dol_strlen($time) == 0) return ''; // $time=0 allowed (it means 01/01/1970 00:00:00)
  1219. // Clean format
  1220. if (preg_match('/%b/i',$format)) // There is some text to translate
  1221. {
  1222. // We inhibate translation to text made by strftime functions. We will use trans instead later.
  1223. $format=str_replace('%b','__b__',$format);
  1224. $format=str_replace('%B','__B__',$format);
  1225. }
  1226. if (preg_match('/%a/i',$format)) // There is some text to translate
  1227. {
  1228. // We inhibate translation to text made by strftime functions. We will use trans instead later.
  1229. $format=str_replace('%a','__a__',$format);
  1230. $format=str_replace('%A','__A__',$format);
  1231. }
  1232. // Analyze date
  1233. if (preg_match('/^([0-9]+)\-([0-9]+)\-([0-9]+) ?([0-9]+)?:?([0-9]+)?:?([0-9]+)?/i',$time,$reg)
  1234. || 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
  1235. {
  1236. // This part of code should not be used. TODO Remove this.
  1237. dol_syslog("Functions.lib::dol_print_date function call with deprecated value of time in page ".$_SERVER["PHP_SELF"], LOG_WARNING);
  1238. // Date has format 'YYYY-MM-DD' or 'YYYY-MM-DD HH:MM:SS' or 'YYYYMMDDHHMMSS'
  1239. $syear = (! empty($reg[1]) ? $reg[1] : '');
  1240. $smonth = (! empty($reg[2]) ? $reg[2] : '');
  1241. $sday = (! empty($reg[3]) ? $reg[3] : '');
  1242. $shour = (! empty($reg[4]) ? $reg[4] : '');
  1243. $smin = (! empty($reg[5]) ? $reg[5] : '');
  1244. $ssec = (! empty($reg[6]) ? $reg[6] : '');
  1245. $time=dol_mktime($shour,$smin,$ssec,$smonth,$sday,$syear,true);
  1246. $ret=adodb_strftime($format,$time+$offsettz+$offsetdst,$to_gmt);
  1247. }
  1248. else
  1249. {
  1250. // Date is a timestamps
  1251. if ($time < 100000000000) // Protection against bad date values
  1252. {
  1253. $ret=adodb_strftime($format,$time+$offsettz+$offsetdst,$to_gmt); // TODO Replace this with function Date PHP. We also should not use anymore offsettz and offsetdst but only offsettzstring.
  1254. }
  1255. else $ret='Bad value '.$time.' for date';
  1256. }
  1257. if (preg_match('/__b__/i',$format))
  1258. {
  1259. // Here ret is string in PHP setup language (strftime was used). Now we convert to $outputlangs.
  1260. $month=adodb_strftime('%m',$time+$offsettz+$offsetdst); // TODO Remove this
  1261. if ($encodetooutput)
  1262. {
  1263. $monthtext=$outputlangs->transnoentities('Month'.$month);
  1264. $monthtextshort=$outputlangs->transnoentities('MonthShort'.$month);
  1265. }
  1266. else
  1267. {
  1268. $monthtext=$outputlangs->transnoentitiesnoconv('Month'.$month);
  1269. $monthtextshort=$outputlangs->transnoentitiesnoconv('MonthShort'.$month);
  1270. }
  1271. //print 'monthtext='.$monthtext.' monthtextshort='.$monthtextshort;
  1272. $ret=str_replace('__b__',$monthtextshort,$ret);
  1273. $ret=str_replace('__B__',$monthtext,$ret);
  1274. //print 'x'.$outputlangs->charset_output.'-'.$ret.'x';
  1275. //return $ret;
  1276. }
  1277. if (preg_match('/__a__/i',$format))
  1278. {
  1279. $w=adodb_strftime('%w',$time+$offsettz+$offsetdst); // TODO Remove this
  1280. $dayweek=$outputlangs->transnoentitiesnoconv('Day'.$w);
  1281. $ret=str_replace('__A__',$dayweek,$ret);
  1282. $ret=str_replace('__a__',dol_substr($dayweek,0,3),$ret);
  1283. }
  1284. return $ret;
  1285. }
  1286. /**
  1287. * Return an array with locale date info.
  1288. * PHP getdate is restricted to the years 1901-2038 on Unix and 1970-2038 on Windows
  1289. * WARNING: This function always use PHP server timezone to return locale informations !!!
  1290. * Usage must be avoid.
  1291. * FIXME: Replace this with PHP date function and a parameter $gm
  1292. *
  1293. * @param int $timestamp Timestamp
  1294. * @param boolean $fast Fast mode
  1295. * @return array Array of informations
  1296. * If no fast mode:
  1297. * 'seconds' => $secs,
  1298. * 'minutes' => $min,
  1299. * 'hours' => $hour,
  1300. * 'mday' => $day,
  1301. * 'wday' => $dow, 0=sunday, 6=saturday
  1302. * 'mon' => $month,
  1303. * 'year' => $year,
  1304. * 'yday' => floor($secsInYear/$_day_power),
  1305. * 'weekday' => gmdate('l',$_day_power*(3+$dow)),
  1306. * 'month' => gmdate('F',mktime(0,0,0,$month,2,1971)),
  1307. * If fast mode:
  1308. * 'seconds' => $secs,
  1309. * 'minutes' => $min,
  1310. * 'hours' => $hour,
  1311. * 'mday' => $day,
  1312. * 'mon' => $month,
  1313. * 'year' => $year,
  1314. * 'yday' => floor($secsInYear/$_day_power),
  1315. * 'leap' => $leaf,
  1316. * 'ndays' => $ndays
  1317. * @see dol_print_date, dol_stringtotime, dol_mktime
  1318. */
  1319. function dol_getdate($timestamp,$fast=false)
  1320. {
  1321. global $conf;
  1322. $usealternatemethod=false;
  1323. if ($timestamp <= 0) $usealternatemethod=true; // <= 1970
  1324. if ($timestamp >= 2145913200) $usealternatemethod=true; // >= 2038
  1325. if ($usealternatemethod)
  1326. {
  1327. $arrayinfo=adodb_getdate($timestamp,$fast);
  1328. }
  1329. else
  1330. {
  1331. $arrayinfo=getdate($timestamp);
  1332. }
  1333. return $arrayinfo;
  1334. }
  1335. /**
  1336. * Return a timestamp date built from detailed informations (by default a local PHP server timestamp)
  1337. * Replace function mktime not available under Windows if year < 1970
  1338. * PHP mktime is restricted to the years 1901-2038 on Unix and 1970-2038 on Windows
  1339. *
  1340. * @param int $hour Hour (can be -1 for undefined)
  1341. * @param int $minute Minute (can be -1 for undefined)
  1342. * @param int $second Second (can be -1 for undefined)
  1343. * @param int $month Month (1 to 12)
  1344. * @param int $day Day (1 to 31)
  1345. * @param int $year Year
  1346. * @param mixed $gm True or 1 or 'gmt'=Input informations are GMT values
  1347. * False or 0 or 'server' = local to server TZ
  1348. * 'user' = local to user TZ
  1349. * 'tz,TimeZone' = use specified timezone
  1350. * @param int $check 0=No check on parameters (Can use day 32, etc...)
  1351. * @return int|string Date as a timestamp, '' or false if error
  1352. * @see dol_print_date, dol_stringtotime, dol_getdate
  1353. */
  1354. function dol_mktime($hour,$minute,$second,$month,$day,$year,$gm=false,$check=1)
  1355. {
  1356. global $conf;
  1357. //print "- ".$hour.",".$minute.",".$second.",".$month.",".$day.",".$year.",".$_SERVER["WINDIR"]." -";
  1358. // Clean parameters
  1359. if ($hour == -1 || empty($hour)) $hour=0;
  1360. if ($minute == -1 || empty($minute)) $minute=0;
  1361. if ($second == -1 || empty($second)) $second=0;
  1362. // Check parameters
  1363. if ($check)
  1364. {
  1365. if (! $month || ! $day) return '';
  1366. if ($day > 31) return '';
  1367. if ($month > 12) return '';
  1368. if ($hour < 0 || $hour > 24) return '';
  1369. if ($minute< 0 || $minute > 60) return '';
  1370. if ($second< 0 || $second > 60) return '';
  1371. }
  1372. if (method_exists('DateTime','getTimestamp'))
  1373. {
  1374. if (empty($gm) || $gm === 'server')
  1375. {
  1376. $default_timezone=@date_default_timezone_get(); // Example 'Europe/Berlin'
  1377. $localtz = new DateTimeZone($default_timezone);
  1378. }
  1379. else if ($gm === 'user')
  1380. {
  1381. // We use dol_tz_string first because it is more reliable.
  1382. $default_timezone=(empty($_SESSION["dol_tz_string"])?@date_default_timezone_get():$_SESSION["dol_tz_string"]); // Example 'Europe/Berlin'
  1383. try {
  1384. $localtz = new DateTimeZone($default_timezone);
  1385. }
  1386. catch(Exception $e)
  1387. {
  1388. dol_syslog("Warning dol_tz_string contains an invalid value ".$_SESSION["dol_tz_string"], LOG_WARNING);
  1389. $default_timezone=@date_default_timezone_get();
  1390. }
  1391. }
  1392. else if (strrpos($gm, "tz,") !== false)
  1393. {
  1394. $timezone=str_replace("tz,", "", $gm); // Example 'tz,Europe/Berlin'
  1395. try
  1396. {
  1397. $localtz = new DateTimeZone($timezone);
  1398. }
  1399. catch(Exception $e)
  1400. {
  1401. dol_syslog("Warning passed timezone contains an invalid value ".$timezone, LOG_WARNING);
  1402. }
  1403. }
  1404. if (empty($localtz)) {
  1405. $localtz = new DateTimeZone('UTC');
  1406. }
  1407. $dt = new DateTime(null,$localtz);
  1408. $dt->setDate($year,$month,$day);
  1409. $dt->setTime((int) $hour, (int) $minute, (int) $second);
  1410. $date=$dt->getTimestamp(); // should include daylight saving time
  1411. return $date;
  1412. }
  1413. else
  1414. {
  1415. dol_print_error('','PHP version must be 5.3+');
  1416. return '';
  1417. }
  1418. }
  1419. /**
  1420. * Return date for now. In mot cases, we use this function without parameters (that means GMT time).
  1421. *
  1422. * @param string $mode 'gmt' => we return GMT timestamp,
  1423. * 'tzserver' => we add the PHP server timezone
  1424. * 'tzref' => we add the company timezone
  1425. * 'tzuser' => we add the user timezone
  1426. * @return int $date Timestamp
  1427. */
  1428. function dol_now($mode='gmt')
  1429. {
  1430. // Note that gmmktime and mktime return same value (GMT) when used without parameters
  1431. //if ($mode == 'gmt') $ret=gmmktime(); // Strict Standards: gmmktime(): You should be using the time() function instead
  1432. if ($mode == 'gmt') $ret=time(); // Time for now at greenwich.
  1433. else if ($mode == 'tzserver') // Time for now with PHP server timezone added
  1434. {
  1435. require_once DOL_DOCUMENT_ROOT.'/core/lib/date.lib.php';
  1436. $tzsecond=getServerTimeZoneInt('now'); // Contains tz+dayling saving time
  1437. $ret=dol_now('gmt')+($tzsecond*3600);
  1438. }
  1439. /*else if ($mode == 'tzref') // Time for now with parent company timezone is added
  1440. {
  1441. require_once DOL_DOCUMENT_ROOT.'/core/lib/date.lib.php';
  1442. $tzsecond=getParentCompanyTimeZoneInt(); // Contains tz+dayling saving time
  1443. $ret=dol_now('gmt')+($tzsecond*3600);
  1444. }*/
  1445. else if ($mode == 'tzuser') // Time for now with user timezone added
  1446. {
  1447. //print 'eeee'.time().'-'.mktime().'-'.gmmktime();
  1448. $offsettz=(empty($_SESSION['dol_tz'])?0:$_SESSION['dol_tz'])*60*60;
  1449. $offsetdst=(empty($_SESSION['dol_dst'])?0:$_SESSION['dol_dst'])*60*60;
  1450. $ret=dol_now('gmt')+($offsettz+$offsetdst);
  1451. }
  1452. return $ret;
  1453. }
  1454. /**
  1455. * Return string with formated size
  1456. *
  1457. * @param int $size Size to print
  1458. * @param int $shortvalue Tell if we want long value to use another unit (Ex: 1.5Kb instead of 1500b)
  1459. * @param int $shortunit Use short value of size unit
  1460. * @return string Link
  1461. */
  1462. function dol_print_size($size,$shortvalue=0,$shortunit=0)
  1463. {
  1464. global $conf,$langs;
  1465. $level=1024;
  1466. if (! empty($conf->dol_optimize_smallscreen)) $shortunit=1;
  1467. // Set value text
  1468. if (empty($shortvalue) || $size < ($level*10))
  1469. {
  1470. $ret=$size;
  1471. $textunitshort=$langs->trans("b");
  1472. $textunitlong=$langs->trans("Bytes");
  1473. }
  1474. else
  1475. {
  1476. $ret=round($size/$level,0);
  1477. $textunitshort=$langs->trans("Kb");
  1478. $textunitlong=$langs->trans("KiloBytes");
  1479. }
  1480. // Use long or short text unit
  1481. if (empty($shortunit)) { $ret.=' '.$textunitlong; }
  1482. else { $ret.=' '.$textunitshort; }
  1483. return $ret;
  1484. }
  1485. /**
  1486. * Show Url link
  1487. *
  1488. * @param string $url Url to show
  1489. * @param string $target Target for link
  1490. * @param int $max Max number of characters to show
  1491. * @param int $withpicto With picto
  1492. * @return string HTML Link
  1493. */
  1494. function dol_print_url($url,$target='_blank',$max=32,$withpicto=0)
  1495. {
  1496. global $langs;
  1497. if (empty($url)) return '';
  1498. $link='<a href="';
  1499. if (! preg_match('/^http/i',$url)) $link.='http://';
  1500. $link.=$url;
  1501. $link.='"';
  1502. if ($target) $link.=' target="'.$target.'"';
  1503. $link.='>';
  1504. if (! preg_match('/^http/i',$url)) $link.='http://';
  1505. $link.=dol_trunc($url,$max);
  1506. $link.='</a>';
  1507. return '<div class="nospan float" style="margin-right: 10px">'.($withpicto?img_picto($langs->trans("Url"), 'object_globe.png').' ':'').$link.'</div>';
  1508. }
  1509. /**
  1510. * Show EMail link
  1511. *
  1512. * @param string $email EMail to show (only email, without 'Name of recipient' before)
  1513. * @param int $cid Id of contact if known
  1514. * @param int $socid Id of third party if known
  1515. * @param int $addlink 0=no link, 1=email has a html email link (+ link to create action if constant AGENDA_ADDACTIONFOREMAIL is on)
  1516. * @param int $max Max number of characters to show
  1517. * @param int $showinvalid Show warning if syntax email is wrong
  1518. * @param int $withpicto Show picto
  1519. * @return string HTML Link
  1520. */
  1521. function dol_print_email($email,$cid=0,$socid=0,$addlink=0,$max=64,$showinvalid=1,$withpicto=0)
  1522. {
  1523. global $conf,$user,$langs;
  1524. $newemail=$email;
  1525. if (empty($email)) return '&nbsp;';
  1526. if (! empty($addlink))
  1527. {
  1528. $newemail='<a style="text-overflow: ellipsis;" href="';
  1529. if (! preg_match('/^mailto:/i',$email)) $newemail.='mailto:';
  1530. $newemail.=$email;
  1531. $newemail.='">';
  1532. $newemail.=dol_trunc($email,$max);
  1533. $newemail.='</a>';
  1534. if ($showinvalid && ! isValidEmail($email))
  1535. {
  1536. $langs->load("errors");
  1537. $newemail.=img_warning($langs->trans("ErrorBadEMail",$email));
  1538. }
  1539. if (($cid || $socid) && ! empty($conf->agenda->enabled) && $user->rights->agenda->myactions->create)
  1540. {
  1541. $type='AC_EMAIL'; $link='';
  1542. if (! empty($conf->global->AGENDA_ADDACTIONFOREMAIL)) $link='<a href="'.DOL_URL_ROOT.'/comm/action/card.php?action=create&amp;backtopage=1&amp;actioncode='.$type.'&amp;contactid='.$cid.'&amp;socid='.$socid.'">'.img_object($langs->trans("AddAction"),"calendar").'</a>';
  1543. if ($link) $newemail='<div>'.$newemail.' '.$link.'</div>';
  1544. }
  1545. }
  1546. else
  1547. {
  1548. if ($showinvalid && ! isValidEmail($email))
  1549. {
  1550. $langs->load("errors");
  1551. $newemail.=img_warning($langs->trans("ErrorBadEMail",$email));
  1552. }
  1553. }
  1554. return '<div class="nospan float" style="margin-right: 10px">'.($withpicto?img_picto($langs->trans("EMail"), 'object_email.png').' ':'').$newemail.'</div>';
  1555. }
  1556. /**
  1557. * Show Skype link
  1558. *
  1559. * @param string $skype Skype to show (only skype, without 'Name of recipient' before)
  1560. * @param int $cid Id of contact if known
  1561. * @param int $socid Id of third party if known
  1562. * @param int $addlink 0=no link to create action
  1563. * @param int $max Max number of characters to show
  1564. * @return string HTML Link
  1565. */
  1566. function dol_print_skype($skype,$cid=0,$socid=0,$addlink=0,$max=64)
  1567. {
  1568. global $conf,$user,$langs;
  1569. $newskype=$skype;
  1570. if (empty($skype)) return '&nbsp;';
  1571. if (! empty($addlink))
  1572. {
  1573. $newskype =img_picto($langs->trans("Skype"), 'object_skype.png');
  1574. $newskype.= '&nbsp;';
  1575. $newskype.=dol_trunc($skype,$max);
  1576. $newskype.= '&nbsp;';
  1577. $newskype.='<a href="skype:';
  1578. $newskype.=dol_trunc($skype,$max);
  1579. $newskype.='?call" alt="'.$langs->trans("Call").'&nbsp;'.$skype.'" title="'.$langs->trans("Call").'&nbsp;'.$skype.'">';
  1580. $newskype.='<img src="'.DOL_URL_ROOT.'/theme/common/skype_callbutton.png" border="0">';
  1581. $newskype.='</a>&nbsp;&nbsp;&nbsp;<a href="skype:';
  1582. $newskype.=dol_trunc($skype,$max);
  1583. $newskype.='?chat" alt="'.$langs->trans("Chat").'&nbsp;'.$skype.'" title="'.$langs->trans("Chat").'&nbsp;'.$skype.'">';
  1584. $newskype.='<img src="'.DOL_URL_ROOT.'/theme/common/skype_chatbutton.png" border="0">';
  1585. $newskype.='</a>';
  1586. if (($cid || $socid) && ! empty($conf->agenda->enabled) && $user->rights->agenda->myactions->create)
  1587. {
  1588. $type='AC_SKYPE'; $link='';
  1589. if (! empty($conf->global->AGENDA_ADDACTIONFORSKYPE)) $link='<a href="'.DOL_URL_ROOT.'/comm/action/card.php?action=create&amp;backtopage=1&amp;actioncode='.$type.'&amp;contactid='.$cid.'&amp;socid='.$socid.'">'.img_object($langs->trans("AddAction"),"calendar").'</a>';
  1590. $newskype='<div class="divskype nowrap">'.$newskype.($link?' '.$link:'').'</div>';
  1591. }
  1592. }
  1593. else
  1594. {
  1595. $langs->load("errors");
  1596. $newskype.=img_warning($langs->trans("ErrorBadSkype",$skype));
  1597. }
  1598. return $newskype;
  1599. }
  1600. /**
  1601. * Format phone numbers according to country
  1602. *
  1603. * @param string $phone Phone number to format
  1604. * @param string $countrycode Country code to use for formatting
  1605. * @param int $cid Id of contact if known
  1606. * @param int $socid Id of third party if known
  1607. * @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)
  1608. * @param string $separ Separation between numbers for a better visibility example : xx.xx.xx.xx.xx
  1609. * @param string $withpicto Show picto
  1610. * @param string $titlealt Text to show on alt
  1611. * @param int $adddivfloat Add div float around phone.
  1612. * @return string Formated phone number
  1613. */
  1614. function dol_print_phone($phone,$countrycode='',$cid=0,$socid=0,$addlink='',$separ="&nbsp;",$withpicto='',$titlealt='',$adddivfloat=0)
  1615. {
  1616. global $conf,$user,$langs,$mysoc;
  1617. // Clean phone parameter
  1618. $phone = preg_replace("/[\s.-]/","",trim($phone));
  1619. if (empty($phone)) { return ''; }
  1620. if (empty($countrycode)) $countrycode=$mysoc->country_code;
  1621. // Short format for small screens
  1622. if ($conf->dol_optimize_smallscreen) $separ='';
  1623. $newphone=$phone;
  1624. if (strtoupper($countrycode) == "FR")
  1625. {
  1626. // France
  1627. if (dol_strlen($phone) == 10) {
  1628. $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);
  1629. }
  1630. elseif (dol_strlen($newphone) == 7)
  1631. {
  1632. $newphone=substr($newphone,0,3).$separ.substr($newphone,3,2).$separ.substr($newphone,5,2);
  1633. }
  1634. elseif (dol_strlen($newphone) == 9)
  1635. {
  1636. $newphone=substr($newphone,0,2).$separ.substr($newphone,2,3).$separ.substr($newphone,5,2).$separ.substr($newphone,7,2);
  1637. }
  1638. elseif (dol_strlen($newphone) == 11)
  1639. {
  1640. $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);
  1641. }
  1642. elseif (dol_strlen($newphone) == 12)
  1643. {
  1644. $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);
  1645. }
  1646. }
  1647. if (strtoupper($countrycode) == "CA")
  1648. {
  1649. if (dol_strlen($phone) == 10) {
  1650. $newphone=($separ!=''?'(':'').substr($newphone,0,3).($separ!=''?')':'').$separ.substr($newphone,3,3).($separ!=''?'-':'').substr($newphone,6,4);
  1651. }
  1652. }
  1653. if (! empty($addlink)) // Link on phone number (+ link to add action if conf->global->AGENDA_ADDACTIONFORPHONE set)
  1654. {
  1655. if (! empty($conf->browser->phone) || (! empty($conf->clicktodial->enabled) && ! empty($conf->global->CLICKTODIAL_USE_TEL_LINK_ON_PHONE_NUMBERS))) // If phone or option for, we use link of phone
  1656. {
  1657. $newphone ='<a href="tel:'.$phone.'"';
  1658. $newphone.='>'.$phone.'</a>';
  1659. }
  1660. else if (! empty($conf->clicktodial->enabled) && $addlink == 'AC_TEL') // If click to dial, we use click to dial url
  1661. {
  1662. if (empty($user->clicktodial_loaded)) $user->fetch_clicktodial();
  1663. // Define urlmask
  1664. $urlmask='ErrorClickToDialModuleNotConfigured';
  1665. if (! empty($conf->global->CLICKTODIAL_URL)) $urlmask=$conf->global->CLICKTODIAL_URL;
  1666. if (! empty($user->clicktodial_url)) $urlmask=$user->clicktodial_url;
  1667. $clicktodial_poste=(! empty($user->clicktodial_poste)?urlencode($user->clicktodial_poste):'');
  1668. $clicktodial_login=(! empty($user->clicktodial_login)?urlencode($user->clicktodial_login):'');
  1669. $clicktodial_password=(! empty($user->clicktodial_password)?urlencode($user->clicktodial_password):'');
  1670. // This line is for backward compatibility
  1671. $url = sprintf($urlmask, urlencode($phone), $clicktodial_poste, $clicktodial_login, $clicktodial_password);
  1672. // Thoose lines are for substitution
  1673. $substitarray=array('__PHONEFROM__'=>$clicktodial_poste,
  1674. '__PHONETO__'=>urlencode($phone),
  1675. '__LOGIN__'=>$clicktodial_login,
  1676. '__PASS__'=>$clicktodial_password);
  1677. $url = make_substitutions($url, $substitarray);
  1678. $newphonesav=$newphone;
  1679. $newphone ='<a href="'.$url.'"';
  1680. if (! empty($conf->global->CLICKTODIAL_FORCENEWTARGET)) $newphone.=' target="_blank"';
  1681. $newphone.='>'.$newphonesav.'</a>';
  1682. }
  1683. //if (($cid || $socid) && ! empty($conf->agenda->enabled) && $user->rights->agenda->myactions->create)
  1684. if (! empty($conf->agenda->enabled) && $user->rights->agenda->myactions->create)
  1685. {
  1686. $type='AC_TEL'; $link='';
  1687. if ($addlink == 'AC_FAX') $type='AC_FAX';
  1688. if (! empty($conf->global->AGENDA_ADDACTIONFORPHONE)) $link='<a href="'.DOL_URL_ROOT.'/comm/action/card.php?action=create&amp;backtopage=1&amp;actioncode='.$type.($cid?'&amp;contactid='.$cid:'').($socid?'&amp;socid='.$socid:'').'">'.img_object($langs->trans("AddAction"),"calendar").'</a>';
  1689. if ($link) $newphone='<div>'.$newphone.' '.$link.'</div>';
  1690. }
  1691. }
  1692. if (empty($titlealt))
  1693. {
  1694. $titlealt=($withpicto=='fax'?$langs->trans("Fax"):$langs->trans("Phone"));
  1695. }
  1696. $rep='';
  1697. if ($adddivfloat) $rep.='<div class="nospan float" style="margin-right: 10px">';
  1698. else $rep.='<span style="margin-right: 10px;">';
  1699. $rep.=($withpicto?img_picto($titlealt, 'object_'.($withpicto=='fax'?'phoning_fax':'phoning').'.png').' ':'').$newphone;
  1700. if ($adddivfloat) $rep.='</div>';
  1701. else $rep.='</span>';
  1702. return $rep;
  1703. }
  1704. /**
  1705. * Return an IP formated to be shown on screen
  1706. *
  1707. * @param string $ip IP
  1708. * @param int $mode 0=return IP + country/flag, 1=return only country/flag, 2=return only IP
  1709. * @return string Formated IP, with country if GeoIP module is enabled
  1710. */
  1711. function dol_print_ip($ip,$mode=0)
  1712. {
  1713. global $conf,$langs;
  1714. $ret='';
  1715. if (empty($mode)) $ret.=$ip;
  1716. if (! empty($conf->geoipmaxmind->enabled) && $mode != 2)
  1717. {
  1718. $datafile=$conf->global->GEOIPMAXMIND_COUNTRY_DATAFILE;
  1719. //$ip='24.24.24.24';
  1720. //$datafile='E:\Mes Sites\Web\Admin1\awstats\maxmind\GeoIP.dat'; Note that this must be downloaded datafile (not same than datafile provided with ubuntu packages)
  1721. include_once DOL_DOCUMENT_ROOT.'/core/class/dolgeoip.class.php';
  1722. $geoip=new DolGeoIP('country',$datafile);
  1723. //print 'ip='.$ip.' databaseType='.$geoip->gi->databaseType." GEOIP_CITY_EDITION_REV1=".GEOIP_CITY_EDITION_REV1."\n";
  1724. //print "geoip_country_id_by_addr=".geoip_country_id_by_addr($geoip->gi,$ip)."\n";
  1725. $countrycode=$geoip->getCountryCodeFromIP($ip);
  1726. if ($countrycode) // If success, countrycode is us, fr, ...
  1727. {
  1728. if (file_exists(DOL_DOCUMENT_ROOT.'/theme/common/flags/'.$countrycode.'.png'))
  1729. {
  1730. $ret.=' '.img_picto($countrycode.' '.$langs->trans("AccordingToGeoIPDatabase"),DOL_URL_ROOT.'/theme/common/flags/'.$countrycode.'.png','',1);
  1731. }
  1732. else $ret.=' ('.$countrycode.')';
  1733. }
  1734. }
  1735. return $ret;
  1736. }
  1737. /**
  1738. * Return country code for current user.
  1739. * If software is used inside a local network, detection may fails (we need a public ip)
  1740. *
  1741. * @return string Country code (fr, es, it, us, ...)
  1742. */
  1743. function dol_user_country()
  1744. {
  1745. global $conf,$langs,$user;
  1746. //$ret=$user->xxx;
  1747. $ret='';
  1748. if (! empty($conf->geoipmaxmind->enabled))
  1749. {
  1750. $ip=$_SERVER["REMOTE_ADDR"];
  1751. $datafile=$conf->global->GEOIPMAXMIND_COUNTRY_DATAFILE;
  1752. //$ip='24.24.24.24';
  1753. //$datafile='E:\Mes Sites\Web\Admin1\awstats\maxmind\GeoIP.dat';
  1754. include_once DOL_DOCUMENT_ROOT.'/core/class/dolgeoip.class.php';
  1755. $geoip=new DolGeoIP('country',$datafile);
  1756. $countrycode=$geoip->getCountryCodeFromIP($ip);
  1757. $ret=$countrycode;
  1758. }
  1759. return $ret;
  1760. }
  1761. /**
  1762. * Format address string
  1763. *
  1764. * @param string $address Address
  1765. * @param int $htmlid Html ID (for example 'gmap')
  1766. * @param int $mode thirdparty|contact|member|other
  1767. * @param int $id Id of object
  1768. * @param int $noprint No output. Result is the function return
  1769. * @param string $charfornl Char to use instead of nl2br. '' means we use a standad nl2br.
  1770. * @return string|void Nothing if noprint is 0, formatted address if noprint is 1
  1771. * @see dol_format_address
  1772. */
  1773. function dol_print_address($address, $htmlid, $mode, $id, $noprint=0, $charfornl='')
  1774. {
  1775. global $conf, $user, $langs, $hookmanager;
  1776. $out = '';
  1777. if ($address)
  1778. {
  1779. if ($hookmanager) {
  1780. $parameters = array('element' => $mode, 'id' => $id);
  1781. $reshook = $hookmanager->executeHooks('printAddress', $parameters, $address);
  1782. $out.=$hookmanager->resPrint;
  1783. }
  1784. if (empty($reshook))
  1785. {
  1786. if (empty($charfornl)) $out.=nl2br($address);
  1787. else $out.=preg_replace('/[\r\n]+/', $charfornl, $address);
  1788. $showgmap=$showomap=0;
  1789. // TODO Add a hook here
  1790. if (($mode=='thirdparty' || $mode =='societe') && ! empty($conf->google->enabled) && ! empty($conf->global->GOOGLE_ENABLE_GMAPS)) $showgmap=1;
  1791. if ($mode=='contact' && ! empty($conf->google->enabled) && ! empty($conf->global->GOOGLE_ENABLE_GMAPS_CONTACTS)) $showgmap=1;
  1792. if ($mode=='member' && ! empty($conf->google->enabled) && ! empty($conf->global->GOOGLE_ENABLE_GMAPS_MEMBERS)) $showgmap=1;
  1793. if (($mode=='thirdparty' || $mode =='societe') && ! empty($conf->openstreetmap->enabled) && ! empty($conf->global->OPENSTREETMAP_ENABLE_MAPS)) $showomap=1;
  1794. if ($mode=='contact' && ! empty($conf->openstreetmap->enabled) && ! empty($conf->global->OPENSTREETMAP_ENABLE_MAPS_CONTACTS)) $showomap=1;
  1795. if ($mode=='member' && ! empty($conf->openstreetmap->enabled) && ! empty($conf->global->OPENSTREETMAP_ENABLE_MAPS_MEMBERS)) $showomap=1;
  1796. if ($showgmap)
  1797. {
  1798. $url=dol_buildpath('/google/gmaps.php?mode='.$mode.'&id='.$id,1);
  1799. $out.=' <a href="'.$url.'" target="_gmaps"><img id="'.$htmlid.'" border="0" src="'.DOL_URL_ROOT.'/theme/common/gmap.png"></a>';
  1800. }
  1801. if ($showomap)
  1802. {
  1803. $url=dol_buildpath('/openstreetmap/maps.php?mode='.$mode.'&id='.$id,1);
  1804. $out.=' <a href="'.$url.'" target="_gmaps"><img id="'.$htmlid.'_openstreetmap" border="0" src="'.DOL_URL_ROOT.'/theme/common/gmap.png"></a>';
  1805. }
  1806. }
  1807. }
  1808. if ($noprint) return $out;
  1809. else print $out;
  1810. }
  1811. /**
  1812. * Return true if email syntax is ok
  1813. *
  1814. * @param string $address email (Ex: "toto@examle.com", "John Do <johndo@example.com>")
  1815. * @param int $acceptsupervisorkey If 1, the special string '__SUPERVISOREMAIL__' is also accepted as valid
  1816. * @return boolean true if email syntax is OK, false if KO or empty string
  1817. */
  1818. function isValidEmail($address, $acceptsupervisorkey=0)
  1819. {
  1820. if ($acceptsupervisorkey && $address == '__SUPERVISOREMAIL__') return true;
  1821. if (filter_var($address, FILTER_VALIDATE_EMAIL)) return true;
  1822. return false;
  1823. }
  1824. /**
  1825. * Return true if phone number syntax is ok
  1826. * TODO Decide what to do with this
  1827. *
  1828. * @param string $phone phone (Ex: "0601010101")
  1829. * @return boolean true if phone syntax is OK, false if KO or empty string
  1830. */
  1831. function isValidPhone($phone)
  1832. {
  1833. return true;
  1834. }
  1835. /**
  1836. * Make a strlen call. Works even if mbstring module not enabled
  1837. *
  1838. * @param string $string String to calculate length
  1839. * @param string $stringencoding Encoding of string
  1840. * @return int Length of string
  1841. */
  1842. function dol_strlen($string,$stringencoding='UTF-8')
  1843. {
  1844. if (function_exists('mb_strlen')) return mb_strlen($string,$stringencoding);
  1845. else return strlen($string);
  1846. }
  1847. /**
  1848. * Make a substring. Works even in mbstring module is not enabled.
  1849. *
  1850. * @param string $string String to scan
  1851. * @param string $start Start position
  1852. * @param int $length Length
  1853. * @param string $stringencoding Page code used for input string encoding
  1854. * @return string substring
  1855. */
  1856. function dol_substr($string,$start,$length,$stringencoding='')
  1857. {
  1858. global $langs;
  1859. if (empty($stringencoding)) $stringencoding=$langs->charset_output;
  1860. $ret='';
  1861. if (function_exists('mb_substr'))
  1862. {
  1863. $ret=mb_substr($string,$start,$length,$stringencoding);
  1864. }
  1865. else
  1866. {
  1867. $ret=substr($string,$start,$length);
  1868. }
  1869. return $ret;
  1870. }
  1871. /**
  1872. * Show a javascript graph.
  1873. * Do not use this function anymore. Use DolGraph class instead.
  1874. *
  1875. * @param string $htmlid Html id name
  1876. * @param int $width Width in pixel
  1877. * @param int $height Height in pixel
  1878. * @param array $data Data array
  1879. * @param int $showlegend 1 to show legend, 0 otherwise
  1880. * @param string $type Type of graph ('pie', 'barline')
  1881. * @param int $showpercent Show percent (with type='pie' only)
  1882. * @param string $url Param to add an url to click values
  1883. * @param int $combineother 0=No combine, 0.05=Combine if lower than 5%
  1884. * @param int $shownographyet Show graph to say there is not enough data
  1885. * @return void
  1886. * @deprecated
  1887. * @see DolGraph
  1888. */
  1889. function dol_print_graph($htmlid,$width,$height,$data,$showlegend=0,$type='pie',$showpercent=0,$url='',$combineother=0.05,$shownographyet=0)
  1890. {
  1891. dol_syslog(__FUNCTION__ . " is deprecated", LOG_WARNING);
  1892. global $conf,$langs;
  1893. global $theme_datacolor; // To have var kept when function is called several times
  1894. if ($shownographyet)
  1895. {
  1896. print '<div class="nographyet" style="width:'.$width.'px;height:'.$height.'px;"></div>';
  1897. print '<div class="nographyettext">'.$langs->trans("NotEnoughDataYet").'</div>';
  1898. return;
  1899. }
  1900. if (empty($conf->use_javascript_ajax)) return;
  1901. $jsgraphlib='flot';
  1902. $datacolor=array();
  1903. // Load colors of theme into $datacolor array
  1904. $color_file = DOL_DOCUMENT_ROOT."/theme/".$conf->theme."/graph-color.php";
  1905. if (is_readable($color_file))
  1906. {
  1907. include_once $color_file;
  1908. if (isset($theme_datacolor))
  1909. {
  1910. $datacolor=array();
  1911. foreach($theme_datacolor as $val)
  1912. {
  1913. $datacolor[]="#".sprintf("%02x",$val[0]).sprintf("%02x",$val[1]).sprintf("%02x",$val[2]);
  1914. }
  1915. }
  1916. }
  1917. print '<div id="'.$htmlid.'" style="width:'.$width.'px;height:'.$height.'px;"></div>';
  1918. // We use Flot js lib
  1919. if ($jsgraphlib == 'flot')
  1920. {
  1921. if ($type == 'pie')
  1922. {
  1923. // data is array('series'=>array(serie1,serie2,...),
  1924. // 'seriestype'=>array('bar','line',...),
  1925. // 'seriescolor'=>array(0=>'#999999',1=>'#999999',...)
  1926. // 'xlabel'=>array(0=>labelx1,1=>labelx2,...));
  1927. // serieX is array('label'=>'label', data=>val)
  1928. print '
  1929. <script type="text/javascript">
  1930. $(function () {
  1931. var data = '.json_encode($data['series']).';
  1932. function plotWithOptions() {
  1933. $.plot($("#'.$htmlid.'"), data,
  1934. {
  1935. series: {
  1936. pie: {
  1937. show: true,
  1938. radius: 0.8,';
  1939. if ($combineother)
  1940. {
  1941. print '
  1942. combine: {
  1943. threshold: '.$combineother.'
  1944. },';
  1945. }
  1946. print '
  1947. label: {
  1948. show: true,
  1949. radius: 0.9,
  1950. formatter: function(label, series) {
  1951. var percent=Math.round(series.percent);
  1952. var number=series.data[0][1];
  1953. return \'';
  1954. print '<div style="font-size:8pt;text-align:center;padding:2px;color:black;">';
  1955. if ($url) print '<a style="color: #FFFFFF;" border="0" href="'.$url.'=">';
  1956. print '\'+'.($showlegend?'number':'label+\' \'+number');
  1957. if (! empty($showpercent)) print '+\'<br/>\'+percent+\'%\'';
  1958. print '+\'';
  1959. if ($url) print '</a>';
  1960. print '</div>\';
  1961. },
  1962. background: {
  1963. opacity: 0.0,
  1964. color: \'#000000\'
  1965. },
  1966. }
  1967. }
  1968. },
  1969. zoom: {
  1970. interactive: true
  1971. },
  1972. pan: {
  1973. interactive: true
  1974. },';
  1975. if (count($datacolor))
  1976. {
  1977. print 'colors: '.(! empty($data['seriescolor']) ? json_encode($data['seriescolor']) : json_encode($datacolor)).',';
  1978. }
  1979. print 'legend: {show: '.($showlegend?'true':'false').', position: \'ne\' }
  1980. });
  1981. }
  1982. plotWithOptions();
  1983. });
  1984. </script>';
  1985. }
  1986. else if ($type == 'barline')
  1987. {
  1988. // data is array('series'=>array(serie1,serie2,...),
  1989. // 'seriestype'=>array('bar','line',...),
  1990. // 'seriescolor'=>array(0=>'#999999',1=>'#999999',...)
  1991. // 'xlabel'=>array(0=>labelx1,1=>labelx2,...));
  1992. // serieX is array('label'=>'label', data=>array(0=>y1,1=>y2,...)) with same nb of value than into xlabel
  1993. print '
  1994. <script type="text/javascript">
  1995. $(function () {
  1996. var data = [';
  1997. $i=0; $outputserie=0;
  1998. foreach($data['series'] as $serie)
  1999. {
  2000. if ($data['seriestype'][$i]=='line') { $i++; continue; };
  2001. if ($outputserie > 0) print ',';
  2002. print '{ bars: { stack: 0, show: true, barWidth: 0.9, align: \'center\' }, label: \''.dol_escape_js($serie['label']).'\', data: '.json_encode($serie['data']).'}'."\n";
  2003. $outputserie++; $i++;
  2004. }
  2005. if ($outputserie) print ', ';
  2006. //print '];
  2007. //var datalines = [';
  2008. $i=0; $outputserie=0;
  2009. foreach($data['series'] as $serie)
  2010. {
  2011. if (empty($data['seriestype'][$i]) || $data['seriestype'][$i]=='bar') { $i++; continue; };
  2012. if ($outputserie > 0) print ',';
  2013. print '{ lines: { show: true }, label: \''.dol_escape_js($serie['label']).'\', data: '.json_encode($serie['data']).'}'."\n";
  2014. $outputserie++; $i++;
  2015. }
  2016. print '];
  2017. var dataticks = '.json_encode($data['xlabel']).'
  2018. function plotWithOptions() {
  2019. $.plot(jQuery("#'.$htmlid.'"), data,
  2020. {
  2021. series: {
  2022. stack: 0
  2023. },
  2024. zoom: {
  2025. interactive: true
  2026. },
  2027. pan: {
  2028. interactive: true
  2029. },';
  2030. if (count($datacolor))
  2031. {
  2032. print 'colors: '.json_encode($datacolor).',';
  2033. }
  2034. print 'legend: {show: '.($showlegend?'true':'false').'},
  2035. xaxis: {ticks: dataticks}
  2036. });
  2037. }
  2038. plotWithOptions();
  2039. });
  2040. </script>';
  2041. }
  2042. else print 'BadValueForParameterType';
  2043. }
  2044. }
  2045. /**
  2046. * Truncate a string to a particular length adding '...' if string larger than length.
  2047. * If length = max length+1, we do no truncate to avoid having just 1 char replaced with '...'.
  2048. * MAIN_DISABLE_TRUNC=1 can disable all truncings
  2049. *
  2050. * @param string $string String to truncate
  2051. * @param int $size Max string size visible. 0 for no limit. Final string size can be 1 more (if size was max+1) or 3 more (if we added ...)
  2052. * @param string $trunc Where to trunc: right, left, middle (size must be a 2 power), wrap
  2053. * @param string $stringencoding Tell what is source string encoding
  2054. * @param int $nodot Truncation do not add ... after truncation. So it's an exact truncation.
  2055. * @param int $display Trunc is use to display and can be changed for small screen. TODO Remove this param (must be dealt with CSS)
  2056. * @return string Truncated string
  2057. */
  2058. function dol_trunc($string,$size=40,$trunc='right',$stringencoding='UTF-8',$nodot=0, $display=0)
  2059. {
  2060. global $conf;
  2061. if ($size==0 || ! empty($conf->global->MAIN_DISABLE_TRUNC)) return $string;
  2062. if (empty($stringencoding)) $stringencoding='UTF-8';
  2063. // reduce for small screen
  2064. if ($conf->dol_optimize_smallscreen==1 && $display==1) $size = round($size/3);
  2065. // We go always here
  2066. if ($trunc == 'right')
  2067. {
  2068. $newstring=dol_textishtml($string)?dol_string_nohtmltag($string,1):$string;
  2069. if (dol_strlen($newstring,$stringencoding) > ($size+($nodot?0:1)))
  2070. return dol_substr($newstring,0,$size,$stringencoding).($nodot?'':'...');
  2071. else
  2072. return $string;
  2073. }
  2074. elseif ($trunc == 'middle')
  2075. {
  2076. $newstring=dol_textishtml($string)?dol_string_nohtmltag($string,1):$string;
  2077. if (dol_strlen($newstring,$stringencoding) > 2 && dol_strlen($newstring,$stringencoding) > ($size+1))
  2078. {
  2079. $size1=round($size/2);
  2080. $size2=round($size/2);
  2081. return dol_substr($newstring,0,$size1,$stringencoding).'...'.dol_substr($newstring,dol_strlen($newstring,$stringencoding) - $size2,$size2,$stringencoding);
  2082. }
  2083. else
  2084. return $string;
  2085. }
  2086. elseif ($trunc == 'left')
  2087. {
  2088. $newstring=dol_textishtml($string)?dol_string_nohtmltag($string,1):$string;
  2089. if (dol_strlen($newstring,$stringencoding) > ($size+1))
  2090. return '...'.dol_substr($newstring,dol_strlen($newstring,$stringencoding) - $size,$size,$stringencoding);
  2091. else
  2092. return $string;
  2093. }
  2094. elseif ($trunc == 'wrap')
  2095. {
  2096. $newstring=dol_textishtml($string)?dol_string_nohtmltag($string,1):$string;
  2097. if (dol_strlen($newstring,$stringencoding) > ($size+1))
  2098. return dol_substr($newstring,0,$size,$stringencoding)."\n".dol_trunc(dol_substr($newstring,$size,dol_strlen($newstring,$stringencoding)-$size,$stringencoding),$size,$trunc);
  2099. else
  2100. return $string;
  2101. }
  2102. else return 'BadParam3CallingDolTrunc';
  2103. }
  2104. /**
  2105. * Show picto whatever it's its name (generic function)
  2106. *
  2107. * @param string $titlealt Text on title and alt. If text is "TextA:TextB", use Text A on alt and Text B on title. Alt only if param notitle is set to 1.
  2108. * @param string $picto Name of image file to show ('filenew', ...)
  2109. * If no extension provided, we use '.png'. Image must be stored into theme/xxx/img directory.
  2110. * Example: picto.png if picto.png is stored into htdocs/theme/mytheme/img
  2111. * Example: picto.png@mymodule if picto.png is stored into htdocs/mymodule/img
  2112. * Example: /mydir/mysubdir/picto.png if picto.png is stored into htdocs/mydir/mysubdir (pictoisfullpath must be set to 1)
  2113. * @param string $morealt Add more attribute on img tag (For example 'style="float: right"')
  2114. * @param int $pictoisfullpath If 1, image path is a full path
  2115. * @param int $srconly Return only content of the src attribute of img.
  2116. * @param int $notitle 1=Disable tag title. Use it if you add js tooltip, to avoid duplicate tooltip.
  2117. * @return string Return img tag
  2118. * @see #img_object, #img_picto_common
  2119. */
  2120. function img_picto($titlealt, $picto, $morealt = '', $pictoisfullpath = false, $srconly=0, $notitle=0)
  2121. {
  2122. global $conf;
  2123. // Define fullpathpicto to use into src
  2124. if ($pictoisfullpath)
  2125. {
  2126. // Clean parameters
  2127. if (! preg_match('/(\.png|\.gif)$/i',$picto)) $picto .= '.png';
  2128. $fullpathpicto = $picto;
  2129. }
  2130. else
  2131. {
  2132. // We forge fullpathpicto for image to $path/img/$picto. By default, we take DOL_URL_ROOT/theme/$conf->theme/img/$picto
  2133. $url = DOL_URL_ROOT;
  2134. $theme = $conf->theme;
  2135. $path = 'theme/'.$theme;
  2136. if (! empty($conf->global->MAIN_OVERWRITE_THEME_PATH)) $path = $conf->global->MAIN_OVERWRITE_THEME_PATH.'/theme/'.$theme; // If the theme does not have the same name as the module
  2137. else if (! empty($conf->global->MAIN_OVERWRITE_THEME_RES)) $path = $conf->global->MAIN_OVERWRITE_THEME_RES.'/theme/'.$conf->global->MAIN_OVERWRITE_THEME_RES; // To allow an external module to overwrite image resources whatever is activated theme
  2138. else if (! empty($conf->modules_parts['theme']) && array_key_exists($theme, $conf->modules_parts['theme'])) $path = $theme.'/theme/'.$theme; // If the theme have the same name as the module
  2139. // If we ask an image into $url/$mymodule/img (instead of default path)
  2140. if (preg_match('/^([^@]+)@([^@]+)$/i',$picto,$regs))
  2141. {
  2142. $picto = $regs[1];
  2143. $path = $regs[2]; // $path is $mymodule
  2144. }
  2145. // Clean parameters
  2146. if (! preg_match('/(\.png|\.gif)$/i',$picto)) $picto .= '.png';
  2147. // If alt path are defined, define url where img file is, according to physical path
  2148. foreach ($conf->file->dol_document_root as $type => $dirroot) // ex: array(["main"]=>"/home/maindir/htdocs", ["alt0"]=>"/home/moddir0/htdocs", ...)
  2149. {
  2150. if ($type == 'main') continue;
  2151. if (file_exists($dirroot.'/'.$path.'/img/'.$picto)) // This need a lot of time, that's why enabling alternative dir like "custom" dir is not recommanded
  2152. {
  2153. $url=DOL_URL_ROOT.$conf->file->dol_url_root[$type];
  2154. break;
  2155. }
  2156. }
  2157. // $url is '' or '/custom', $path is current theme or
  2158. $fullpathpicto = $url.'/'.$path.'/img/'.$picto;
  2159. }
  2160. if ($srconly) return $fullpathpicto;
  2161. else
  2162. {
  2163. $tmparray=array(0=>$titlealt);
  2164. if (preg_match('/:[^\s0-9]/',$titlealt)) $tmparray=explode(':',$titlealt); // We explode if we have TextA:TextB. Not if we have TextA: TextB
  2165. $title=$tmparray[0];
  2166. $alt=empty($tmparray[1])?'':$tmparray[1];
  2167. return '<img src="'.$fullpathpicto.'" border="0" alt="'.dol_escape_htmltag($alt).'"'.($notitle?'':' title="'.dol_escape_htmltag($title).'"').($morealt?' '.$morealt:'').'>'; // Alt is used for accessibility, title for popup
  2168. }
  2169. }
  2170. /**
  2171. * Show a picto called object_picto (generic function)
  2172. *
  2173. * @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.
  2174. * @param string $picto Name of image to show object_picto (example: user, group, action, bill, contract, propal, product, ...)
  2175. * For external modules use imagename@mymodule to search into directory "img" of module.
  2176. * @param string $morealt Add more attribute on img tag (ie: class="datecallink")
  2177. * @param int $pictoisfullpath If 1, image path is a full path
  2178. * @param int $srconly Return only content of the src attribute of img.
  2179. * @param int $notitle 1=Disable tag title. Use it if you add js tooltip, to avoid duplicate tooltip.
  2180. * @return string Return img tag
  2181. * @see #img_picto, #img_picto_common
  2182. */
  2183. function img_object($titlealt, $picto, $morealt = '', $pictoisfullpath = false, $srconly=0, $notitle=0)
  2184. {
  2185. return img_picto($titlealt, 'object_'.$picto, $morealt, $pictoisfullpath, $srconly, $notitle);
  2186. }
  2187. /**
  2188. * Show weather picto
  2189. *
  2190. * @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.
  2191. * @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.
  2192. * @param string $morealt Add more attribute on img tag
  2193. * @param int $pictoisfullpath If 1, image path is a full path
  2194. * @return string Return img tag
  2195. * @see #img_object, #img_picto
  2196. */
  2197. function img_weather($titlealt, $picto, $morealt = '', $pictoisfullpath = 0)
  2198. {
  2199. global $conf;
  2200. if (! preg_match('/(\.png|\.gif)$/i', $picto)) $picto .= '.png';
  2201. $path = DOL_URL_ROOT.'/theme/'.$conf->theme.'/img/weather/'.$picto;
  2202. return img_picto($titlealt, $path, $morealt, 1);
  2203. }
  2204. /**
  2205. * Show picto (generic function)
  2206. *
  2207. * @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.
  2208. * @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.
  2209. * @param string $morealt Add more attribute on img tag
  2210. * @param int $pictoisfullpath If 1, image path is a full path
  2211. * @return string Return img tag
  2212. * @see #img_object, #img_picto
  2213. */
  2214. function img_picto_common($titlealt, $picto, $morealt = '', $pictoisfullpath = 0)
  2215. {
  2216. global $conf;
  2217. if (! preg_match('/(\.png|\.gif)$/i', $picto)) $picto .= '.png';
  2218. if ($pictoisfullpath) $path = $picto;
  2219. else
  2220. {
  2221. $path = DOL_URL_ROOT.'/theme/common/'.$picto;
  2222. if (! empty($conf->global->MAIN_MODULE_CAN_OVERWRITE_COMMONICONS))
  2223. {
  2224. $themepath = DOL_DOCUMENT_ROOT.'/theme/'.$conf->theme.'/img/'.$picto;
  2225. if (file_exists($themepath)) $path = $themepath;
  2226. }
  2227. }
  2228. return img_picto($titlealt, $path, $morealt, 1);
  2229. }
  2230. /**
  2231. * Show logo action
  2232. *
  2233. * @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.
  2234. * @param string $numaction Action id or code to show
  2235. * @return string Return an img tag
  2236. */
  2237. function img_action($titlealt, $numaction)
  2238. {
  2239. global $conf, $langs;
  2240. if (empty($titlealt) || $titlealt == 'default')
  2241. {
  2242. if ($numaction == '-1' || $numaction == 'ST_NO') { $numaction = -1; $titlealt = $langs->transnoentitiesnoconv('ChangeDoNotContact'); }
  2243. elseif ($numaction == '0' || $numaction == 'ST_NEVER') { $numaction = 0; $titlealt = $langs->transnoentitiesnoconv('ChangeNeverContacted'); }
  2244. elseif ($numaction == '1' || $numaction == 'ST_TODO') { $numaction = 1; $titlealt = $langs->transnoentitiesnoconv('ChangeToContact'); }
  2245. elseif ($numaction == '2' || $numaction == 'ST_PEND') { $numaction = 2; $titlealt = $langs->transnoentitiesnoconv('ChangeContactInProcess'); }
  2246. elseif ($numaction == '3' || $numaction == 'ST_DONE') { $numaction = 3; $titlealt = $langs->transnoentitiesnoconv('ChangeContactDone'); }
  2247. else { $titlealt = $langs->transnoentitiesnoconv('ChangeStatus '.$numaction); $numaction = 0; }
  2248. }
  2249. if (! is_numeric($numaction)) $numaction=0;
  2250. return img_picto($titlealt, 'stcomm'.$numaction.'.png');
  2251. }
  2252. /**
  2253. * Show pdf logo
  2254. *
  2255. * @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.
  2256. * @param int $size Taille de l'icone : 3 = 16x16px , 2 = 14x14px
  2257. * @return string Retourne tag img
  2258. */
  2259. function img_pdf($titlealt = 'default', $size = 3)
  2260. {
  2261. global $conf, $langs;
  2262. if ($titlealt == 'default') $titlealt = $langs->trans('Show');
  2263. return img_picto($titlealt, 'pdf'.$size.'.png');
  2264. }
  2265. /**
  2266. * Show logo +
  2267. *
  2268. * @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.
  2269. * @param string $other Add more attributes on img
  2270. * @return string Return tag img
  2271. */
  2272. function img_edit_add($titlealt = 'default', $other = '')
  2273. {
  2274. global $conf, $langs;
  2275. if ($titlealt == 'default') $titlealt = $langs->trans('Add');
  2276. return img_picto($titlealt, 'edit_add.png', $other);
  2277. }
  2278. /**
  2279. * Show logo -
  2280. *
  2281. * @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.
  2282. * @param string $other Add more attributes on img
  2283. * @return string Return tag img
  2284. */
  2285. function img_edit_remove($titlealt = 'default', $other='')
  2286. {
  2287. global $conf, $langs;
  2288. if ($titlealt == 'default') $titlealt = $langs->trans('Remove');
  2289. return img_picto($titlealt, 'edit_remove.png', $other);
  2290. }
  2291. /**
  2292. * Show logo editer/modifier fiche
  2293. *
  2294. * @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.
  2295. * @param integer $float Si il faut y mettre le style "float: right"
  2296. * @param string $other Add more attributes on img
  2297. * @return string Return tag img
  2298. */
  2299. function img_edit($titlealt = 'default', $float = 0, $other = '')
  2300. {
  2301. global $conf, $langs;
  2302. if ($titlealt == 'default') $titlealt = $langs->trans('Modify');
  2303. return img_picto($titlealt, 'edit.png', ($float ? 'style="float: '.($langs->tab_translate["DIRECTION"] == 'rtl'?'left':'right').'"' : $other));
  2304. }
  2305. /**
  2306. * Show logo view card
  2307. *
  2308. * @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.
  2309. * @param integer $float Si il faut y mettre le style "float: right"
  2310. * @param string $other Add more attributes on img
  2311. * @return string Return tag img
  2312. */
  2313. function img_view($titlealt = 'default', $float = 0, $other = '')
  2314. {
  2315. global $conf, $langs;
  2316. if ($titlealt == 'default') $titlealt = $langs->trans('View');
  2317. $morealt = ($float ? 'style="float: right" ' : '').$other;
  2318. return img_picto($titlealt, 'view.png', $morealt);
  2319. }
  2320. /**
  2321. * Show delete logo
  2322. *
  2323. * @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.
  2324. * @param string $other Add more attributes on img
  2325. * @return string Retourne tag img
  2326. */
  2327. function img_delete($titlealt = 'default', $other = '')
  2328. {
  2329. global $conf, $langs;
  2330. if ($titlealt == 'default') $titlealt = $langs->trans('Delete');
  2331. return img_picto($titlealt, 'delete.png', $other);
  2332. }
  2333. /**
  2334. * Show printer logo
  2335. *
  2336. * @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.
  2337. * @param string $other Add more attributes on img
  2338. * @return string Retourne tag img
  2339. */
  2340. function img_printer($titlealt = "default", $other='')
  2341. {
  2342. global $conf,$langs;
  2343. if ($titlealt=="default") $titlealt=$langs->trans("Print");
  2344. return img_picto($titlealt,'printer.png',$other);
  2345. }
  2346. /**
  2347. * Show help logo with cursor "?"
  2348. *
  2349. * @param int $usehelpcursor Use help cursor
  2350. * @param int|string $usealttitle Text to use as alt title
  2351. * @return string Return tag img
  2352. */
  2353. function img_help($usehelpcursor = 1, $usealttitle = 1)
  2354. {
  2355. global $conf, $langs;
  2356. if ($usealttitle)
  2357. {
  2358. if (is_string($usealttitle)) $usealttitle = dol_escape_htmltag($usealttitle);
  2359. else $usealttitle = $langs->trans('Info');
  2360. }
  2361. return img_picto($usealttitle, 'info.png', ($usehelpcursor ? 'style="vertical-align: middle; cursor: help"' : 'style="vertical-align: middle;"'));
  2362. }
  2363. /**
  2364. * Show info logo
  2365. *
  2366. * @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.
  2367. * @return string Return img tag
  2368. */
  2369. function img_info($titlealt = 'default')
  2370. {
  2371. global $conf, $langs;
  2372. if ($titlealt == 'default') $titlealt = $langs->trans('Informations');
  2373. return img_picto($titlealt, 'info.png', 'style="vertical-align: middle;"');
  2374. }
  2375. /**
  2376. * Show warning logo
  2377. *
  2378. * @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.
  2379. * @param string $morealt Add more attribute on img tag (For example 'style="float: right"'). If 1
  2380. * @return string Return img tag
  2381. */
  2382. function img_warning($titlealt = 'default', $morealt = '')
  2383. {
  2384. global $conf, $langs;
  2385. if ($titlealt == 'default') $titlealt = $langs->trans('Warning');
  2386. return img_picto($titlealt, 'warning.png', 'class="pictowarning valignmiddle"'.($morealt ? ($morealt == '1' ? ' style="float: right"' : ' '.$morealt): ''));
  2387. }
  2388. /**
  2389. * Show error logo
  2390. *
  2391. * @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.
  2392. * @return string Return img tag
  2393. */
  2394. function img_error($titlealt = 'default')
  2395. {
  2396. global $conf, $langs;
  2397. if ($titlealt == 'default') $titlealt = $langs->trans('Error');
  2398. return img_picto($titlealt, 'error.png');
  2399. }
  2400. /**
  2401. * Show next logo
  2402. *
  2403. * @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.
  2404. * @param string $morealt Add more attribute on img tag (For example 'style="float: right"')
  2405. * @return string Return img tag
  2406. */
  2407. function img_next($titlealt = 'default', $morealt='')
  2408. {
  2409. global $conf, $langs;
  2410. if ($titlealt == 'default') $titlealt = $langs->trans('Next');
  2411. return img_picto($titlealt, 'next.png', $morealt);
  2412. }
  2413. /**
  2414. * Show previous logo
  2415. *
  2416. * @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.
  2417. * @param string $morealt Add more attribute on img tag (For example 'style="float: right"')
  2418. * @return string Return img tag
  2419. */
  2420. function img_previous($titlealt = 'default', $morealt='')
  2421. {
  2422. global $conf, $langs;
  2423. if ($titlealt == 'default') $titlealt = $langs->trans('Previous');
  2424. return img_picto($titlealt, 'previous.png', $morealt);
  2425. }
  2426. /**
  2427. * Show down arrow logo
  2428. *
  2429. * @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.
  2430. * @param int $selected Selected
  2431. * @param string $moreclass Add more CSS classes
  2432. * @return string Return img tag
  2433. */
  2434. function img_down($titlealt = 'default', $selected = 0, $moreclass='')
  2435. {
  2436. global $conf, $langs;
  2437. if ($titlealt == 'default') $titlealt = $langs->trans('Down');
  2438. return img_picto($titlealt, ($selected ? '1downarrow_selected.png' : '1downarrow.png'), 'class="imgdown'.($moreclass?" ".$moreclass:"").'"');
  2439. }
  2440. /**
  2441. * Show top arrow logo
  2442. *
  2443. * @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.
  2444. * @param int $selected Selected
  2445. * @param string $moreclass Add more CSS classes
  2446. * @return string Return img tag
  2447. */
  2448. function img_up($titlealt = 'default', $selected = 0, $moreclass='')
  2449. {
  2450. global $conf, $langs;
  2451. if ($titlealt == 'default') $titlealt = $langs->trans('Up');
  2452. return img_picto($titlealt, ($selected ? '1uparrow_selected.png' : '1uparrow.png'), 'class="imgup'.($moreclass?" ".$moreclass:"").'"');
  2453. }
  2454. /**
  2455. * Show left arrow logo
  2456. *
  2457. * @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.
  2458. * @param int $selected Selected
  2459. * @param string $morealt Add more attribute on img tag (For example 'style="float: right"')
  2460. * @return string Return img tag
  2461. */
  2462. function img_left($titlealt = 'default', $selected = 0, $morealt='')
  2463. {
  2464. global $conf, $langs;
  2465. if ($titlealt == 'default') $titlealt = $langs->trans('Left');
  2466. return img_picto($titlealt, ($selected ? '1leftarrow_selected.png' : '1leftarrow.png'), $morealt);
  2467. }
  2468. /**
  2469. * Show right arrow logo
  2470. *
  2471. * @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.
  2472. * @param int $selected Selected
  2473. * @param string $morealt Add more attribute on img tag (For example 'style="float: right"')
  2474. * @return string Return img tag
  2475. */
  2476. function img_right($titlealt = 'default', $selected = 0, $morealt='')
  2477. {
  2478. global $conf, $langs;
  2479. if ($titlealt == 'default') $titlealt = $langs->trans('Right');
  2480. return img_picto($titlealt, ($selected ? '1rightarrow_selected.png' : '1rightarrow.png'), $morealt);
  2481. }
  2482. /**
  2483. * Show tick logo if allowed
  2484. *
  2485. * @param string $allow Allow
  2486. * @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.
  2487. * @return string Return img tag
  2488. */
  2489. function img_allow($allow, $titlealt = 'default')
  2490. {
  2491. global $conf, $langs;
  2492. if ($titlealt == 'default') $titlealt = $langs->trans('Active');
  2493. if ($allow == 1) return img_picto($titlealt, 'tick.png');
  2494. return '-';
  2495. }
  2496. /**
  2497. * Show MIME img of a file
  2498. *
  2499. * @param string $file Filename
  2500. * @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.
  2501. * @return string Return img tag
  2502. */
  2503. function img_mime($file, $titlealt = '')
  2504. {
  2505. require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
  2506. $mimetype = dol_mimetype($file, '', 1);
  2507. $mimeimg = dol_mimetype($file, '', 2);
  2508. if (empty($titlealt)) $titlealt = 'Mime type: '.$mimetype;
  2509. return img_picto_common($titlealt, 'mime/'.$mimeimg);
  2510. }
  2511. /**
  2512. * Show phone logo.
  2513. * Use img_picto instead.
  2514. *
  2515. * @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.
  2516. * @param int $option Option
  2517. * @return string Return img tag
  2518. * @deprecated
  2519. * @see img_picto
  2520. */
  2521. function img_phone($titlealt = 'default', $option = 0)
  2522. {
  2523. dol_syslog(__FUNCTION__ . " is deprecated", LOG_WARNING);
  2524. global $conf,$langs;
  2525. if ($titlealt == 'default') $titlealt = $langs->trans('Call');
  2526. if ($option == 1) $img = 'call';
  2527. else $img = 'call_out';
  2528. return img_picto($titlealt, $img);
  2529. }
  2530. /**
  2531. * Show search logo
  2532. *
  2533. * @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.
  2534. * @param string $other Add more attributes on img
  2535. * @return string Retourne tag img
  2536. */
  2537. function img_search($titlealt = 'default', $other = '')
  2538. {
  2539. global $conf, $langs;
  2540. if ($titlealt == 'default') $titlealt = $langs->trans('Search');
  2541. $img = img_picto($titlealt, 'search.png', $other, false, 1);
  2542. $input = '<input type="image" class="liste_titre" name="button_search" src="'.$img.'" ';
  2543. $input.= 'value="'.dol_escape_htmltag($titlealt).'" title="'.dol_escape_htmltag($titlealt).'" >';
  2544. return $input;
  2545. }
  2546. /**
  2547. * Show search logo
  2548. *
  2549. * @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.
  2550. * @param string $other Add more attributes on img
  2551. * @return string Retourne tag img
  2552. */
  2553. function img_searchclear($titlealt = 'default', $other = '')
  2554. {
  2555. global $conf, $langs;
  2556. if ($titlealt == 'default') $titlealt = $langs->trans('Search');
  2557. $img = img_picto($titlealt, 'searchclear.png', $other, false, 1);
  2558. $input = '<input type="image" class="liste_titre" name="button_removefilter" src="'.$img.'" ';
  2559. $input.= 'value="'.dol_escape_htmltag($titlealt).'" title="'.dol_escape_htmltag($titlealt).'" >';
  2560. return $input;
  2561. }
  2562. /**
  2563. * Show information for admin users or standard users
  2564. *
  2565. * @param string $text Text info
  2566. * @param integer $infoonimgalt Info is shown only on alt of star picto, otherwise it is show on output after the star picto
  2567. * @param int $nodiv No div
  2568. * @param string $admin '1'=Info for admin users. '0'=Info for standard users (change only the look), 'xxx'=Other
  2569. * @return string String with info text
  2570. */
  2571. function info_admin($text, $infoonimgalt = 0, $nodiv=0, $admin='1')
  2572. {
  2573. global $conf, $langs;
  2574. if ($infoonimgalt)
  2575. {
  2576. return img_picto($text, 'info', 'class="hideonsmartphone"');
  2577. }
  2578. return ($nodiv?'':'<div class="'.(empty($admin)?'':($admin=='1'?'info':$admin)).' hideonsmartphone">').img_picto($admin?$langs->trans('InfoAdmin'):$langs->trans('Note'), ($nodiv?'info':'info_black'), 'class="hideonsmartphone"').' '.$text.($nodiv?'':'</div>');
  2579. }
  2580. /**
  2581. * Affiche message erreur system avec toutes les informations pour faciliter le diagnostic et la remontee des bugs.
  2582. * On doit appeler cette fonction quand une erreur technique bloquante est rencontree.
  2583. * Toutefois, il faut essayer de ne l'appeler qu'au sein de pages php, les classes devant
  2584. * renvoyer leur erreur par l'intermediaire de leur propriete "error".
  2585. *
  2586. * @param DoliDB $db Database handler
  2587. * @param mixed $error String or array of errors strings to show
  2588. * @param array $errors Array of errors
  2589. * @return void
  2590. * @see dol_htmloutput_errors
  2591. */
  2592. function dol_print_error($db='',$error='',$errors=null)
  2593. {
  2594. global $conf,$langs,$argv;
  2595. global $dolibarr_main_prod;
  2596. $out = '';
  2597. $syslog = '';
  2598. // Si erreur intervenue avant chargement langue
  2599. if (! $langs)
  2600. {
  2601. require_once DOL_DOCUMENT_ROOT .'/core/class/translate.class.php';
  2602. $langs = new Translate('', $conf);
  2603. $langs->load("main");
  2604. }
  2605. $langs->load("main");
  2606. $langs->load("errors");
  2607. if ($_SERVER['DOCUMENT_ROOT']) // Mode web
  2608. {
  2609. $out.=$langs->trans("DolibarrHasDetectedError").".<br>\n";
  2610. if (! empty($conf->global->MAIN_FEATURES_LEVEL)) $out.="You use an experimental or develop level of features, so please do NOT report any bugs, except if problem is confirmed moving option MAIN_FEATURES_LEVEL back to 0.<br>\n";
  2611. $out.=$langs->trans("InformationToHelpDiagnose").":<br>\n";
  2612. $out.="<b>".$langs->trans("Date").":</b> ".dol_print_date(time(),'dayhourlog')."<br>\n";
  2613. $out.="<b>".$langs->trans("Dolibarr").":</b> ".DOL_VERSION."<br>\n";
  2614. if (isset($conf->global->MAIN_FEATURES_LEVEL)) $out.="<b>".$langs->trans("LevelOfFeature").":</b> ".$conf->global->MAIN_FEATURES_LEVEL."<br>\n";
  2615. if (function_exists("phpversion"))
  2616. {
  2617. $out.="<b>".$langs->trans("PHP").":</b> ".phpversion()."<br>\n";
  2618. }
  2619. $out.="<b>".$langs->trans("Server").":</b> ".$_SERVER["SERVER_SOFTWARE"]."<br>\n";
  2620. if (function_exists("php_uname"))
  2621. {
  2622. $out.="<b>".$langs->trans("OS").":</b> ".php_uname()."<br>\n";
  2623. }
  2624. $out.="<b>".$langs->trans("UserAgent").":</b> ".$_SERVER["HTTP_USER_AGENT"]."<br>\n";
  2625. $out.="<br>\n";
  2626. $out.="<b>".$langs->trans("RequestedUrl").":</b> ".dol_htmlentities($_SERVER["REQUEST_URI"],ENT_COMPAT,'UTF-8')."<br>\n";
  2627. $out.="<b>".$langs->trans("Referer").":</b> ".(isset($_SERVER["HTTP_REFERER"])?dol_htmlentities($_SERVER["HTTP_REFERER"],ENT_COMPAT,'UTF-8'):'')."<br>\n";
  2628. $out.="<b>".$langs->trans("MenuManager").":</b> ".(isset($conf->standard_menu)?$conf->standard_menu:'')."<br>\n";
  2629. $out.="<br>\n";
  2630. $syslog.="url=".$_SERVER["REQUEST_URI"];
  2631. $syslog.=", query_string=".$_SERVER["QUERY_STRING"];
  2632. }
  2633. else // Mode CLI
  2634. {
  2635. $out.='> '.$langs->transnoentities("ErrorInternalErrorDetected").":\n".$argv[0]."\n";
  2636. $syslog.="pid=".dol_getmypid();
  2637. }
  2638. if (is_object($db))
  2639. {
  2640. if ($_SERVER['DOCUMENT_ROOT']) // Mode web
  2641. {
  2642. $out.="<b>".$langs->trans("DatabaseTypeManager").":</b> ".$db->type."<br>\n";
  2643. $out.="<b>".$langs->trans("RequestLastAccessInError").":</b> ".($db->lastqueryerror()?dol_escape_htmltag($db->lastqueryerror()):$langs->trans("ErrorNoRequestInError"))."<br>\n";
  2644. $out.="<b>".$langs->trans("ReturnCodeLastAccessInError").":</b> ".($db->lasterrno()?dol_escape_htmltag($db->lasterrno()):$langs->trans("ErrorNoRequestInError"))."<br>\n";
  2645. $out.="<b>".$langs->trans("InformationLastAccessInError").":</b> ".($db->lasterror()?dol_escape_htmltag($db->lasterror()):$langs->trans("ErrorNoRequestInError"))."<br>\n";
  2646. $out.="<br>\n";
  2647. }
  2648. else // Mode CLI
  2649. {
  2650. // No dol_escape_htmltag for output, we are in CLI mode
  2651. $out.='> '.$langs->transnoentities("DatabaseTypeManager").":\n".$db->type."\n";
  2652. $out.='> '.$langs->transnoentities("RequestLastAccessInError").":\n".($db->lastqueryerror()?$db->lastqueryerror():$langs->transnoentities("ErrorNoRequestInError"))."\n";
  2653. $out.='> '.$langs->transnoentities("ReturnCodeLastAccessInError").":\n".($db->lasterrno()?$db->lasterrno():$langs->transnoentities("ErrorNoRequestInError"))."\n";
  2654. $out.='> '.$langs->transnoentities("InformationLastAccessInError").":\n".($db->lasterror()?$db->lasterror():$langs->transnoentities("ErrorNoRequestInError"))."\n";
  2655. }
  2656. $syslog.=", sql=".$db->lastquery();
  2657. $syslog.=", db_error=".$db->lasterror();
  2658. }
  2659. if ($error || $errors)
  2660. {
  2661. $langs->load("errors");
  2662. // Merge all into $errors array
  2663. if (is_array($error) && is_array($errors)) $errors=array_merge($error,$errors);
  2664. elseif (is_array($error)) $errors=$error;
  2665. elseif (is_array($errors)) $errors=array_merge(array($error),$errors);
  2666. else $errors=array_merge(array($error));
  2667. foreach($errors as $msg)
  2668. {
  2669. if (empty($msg)) continue;
  2670. if ($_SERVER['DOCUMENT_ROOT']) // Mode web
  2671. {
  2672. $out.="<b>".$langs->trans("Message").":</b> ".dol_escape_htmltag($msg)."<br>\n" ;
  2673. }
  2674. else // Mode CLI
  2675. {
  2676. $out.='> '.$langs->transnoentities("Message").":\n".$msg."\n" ;
  2677. }
  2678. $syslog.=", msg=".$msg;
  2679. }
  2680. }
  2681. if (empty($dolibarr_main_prod) && $_SERVER['DOCUMENT_ROOT'] && function_exists('xdebug_print_function_stack') && function_exists('xdebug_call_file'))
  2682. {
  2683. xdebug_print_function_stack();
  2684. $out.='<b>XDebug informations:</b>'."<br>\n";
  2685. $out.='File: '.xdebug_call_file()."<br>\n";
  2686. $out.='Line: '.xdebug_call_line()."<br>\n";
  2687. $out.='Function: '.xdebug_call_function()."<br>\n";
  2688. $out.="<br>\n";
  2689. }
  2690. if (empty($dolibarr_main_prod)) print $out;
  2691. else define("MAIN_CORE_ERROR", 1);
  2692. //else print 'Sorry, an error occured but the parameter $dolibarr_main_prod is defined in conf file so no message is reported to your browser. Please read the log file for error message.';
  2693. dol_syslog("Error ".$syslog, LOG_ERR);
  2694. }
  2695. /**
  2696. * Show a public email and error code to contact if technical error
  2697. *
  2698. * @param string $prefixcode Prefix of public error code
  2699. * @return void
  2700. */
  2701. function dol_print_error_email($prefixcode)
  2702. {
  2703. global $langs,$conf;
  2704. $langs->load("errors");
  2705. $now=dol_now();
  2706. print '<br><div class="error">'.$langs->trans("ErrorContactEMail", $conf->global->MAIN_INFO_SOCIETE_MAIL, $prefixcode.dol_print_date($now,'%Y%m%d')).'</div>';
  2707. }
  2708. /**
  2709. * Show title line of an array
  2710. *
  2711. * @param string $name Label of field
  2712. * @param string $file Url used when we click on sort picto
  2713. * @param string $field Field to use for new sorting
  2714. * @param string $begin ("" by defaut)
  2715. * @param string $moreparam Add more parameters on sort url links ("" by default)
  2716. * @param string $td Options of attribute td ("" by defaut, example: 'align="center"')
  2717. * @param string $sortfield Current field used to sort
  2718. * @param string $sortorder Current sort order
  2719. * @param string $prefix Prefix for css. Use space after prefix to add your own CSS tag.
  2720. * @return void
  2721. */
  2722. function print_liste_field_titre($name, $file="", $field="", $begin="", $moreparam="", $td="", $sortfield="", $sortorder="", $prefix="")
  2723. {
  2724. print getTitleFieldOfList($name, 0, $file, $field, $begin, $moreparam, $td, $sortfield, $sortorder, $prefix);
  2725. }
  2726. /**
  2727. * Get title line of an array
  2728. *
  2729. * @param string $name Label of field
  2730. * @param int $thead 0=To use with standard table format, 1=To use inside <thead><tr>, 2=To use with <div>
  2731. * @param string $file Url used when we click on sort picto
  2732. * @param string $field Field to use for new sorting. Empty if this field is not sortable.
  2733. * @param string $begin ("" by defaut)
  2734. * @param string $moreparam Add more parameters on sort url links ("" by default)
  2735. * @param string $moreattrib Add more attributes on th ("" by defaut)
  2736. * @param string $sortfield Current field used to sort
  2737. * @param string $sortorder Current sort order
  2738. * @param string $prefix Prefix for css. Use space after prefix to add your own CSS tag.
  2739. * @return string
  2740. */
  2741. function getTitleFieldOfList($name, $thead=0, $file="", $field="", $begin="", $moreparam="", $moreattrib="", $sortfield="", $sortorder="", $prefix="")
  2742. {
  2743. global $conf;
  2744. //print "$name, $file, $field, $begin, $options, $moreattrib, $sortfield, $sortorder<br>\n";
  2745. $sortorder=strtoupper($sortorder);
  2746. $out='';
  2747. $sortimg='';
  2748. $tag='th';
  2749. if ($thead==2) $tag='div';
  2750. // If field is used as sort criteria we use a specific class
  2751. // Example if (sortfield,field)=("nom","xxx.nom") or (sortfield,field)=("nom","nom")
  2752. if ($field && ($sortfield == $field || $sortfield == preg_replace("/^[^\.]+\./","",$field))) $out.= '<'.$tag.' class="'.$prefix.'liste_titre_sel" '. $moreattrib.'>';
  2753. else $out.= '<'.$tag.' class="'.$prefix.'liste_titre" '. $moreattrib.'>';
  2754. if (empty($thead) && $field) // If this is a sort field
  2755. {
  2756. $options=preg_replace('/sortfield=([a-zA-Z0-9,\s\.]+)/i','',$moreparam);
  2757. $options=preg_replace('/sortorder=([a-zA-Z0-9,\s\.]+)/i','',$options);
  2758. $options=preg_replace('/&+/i','&',$options);
  2759. if (! preg_match('/^&/',$options)) $options='&'.$options;
  2760. if ($field != $sortfield)
  2761. {
  2762. if ($sortorder == 'DESC') $out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=desc&begin='.$begin.$options.'">';
  2763. if ($sortorder == 'ASC' || ! $sortorder) $out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=asc&begin='.$begin.$options.'">';
  2764. }
  2765. else
  2766. {
  2767. if ($sortorder == 'DESC' || ! $sortorder) $out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=asc&begin='.$begin.$options.'">';
  2768. if ($sortorder == 'ASC') $out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=desc&begin='.$begin.$options.'">';
  2769. }
  2770. }
  2771. $out.=$name;
  2772. if (empty($thead) && $field) // If this is a sort field
  2773. {
  2774. $out.='</a>';
  2775. }
  2776. if (empty($thead) && $field) // If this is a sort field
  2777. {
  2778. $options=preg_replace('/sortfield=([a-zA-Z0-9,\s\.]+)/i','',$moreparam);
  2779. $options=preg_replace('/sortorder=([a-zA-Z0-9,\s\.]+)/i','',$options);
  2780. $options=preg_replace('/&+/i','&',$options);
  2781. if (! preg_match('/^&/',$options)) $options='&'.$options;
  2782. //print "&nbsp;";
  2783. //$sortimg.= '<img width="2" src="'.DOL_URL_ROOT.'/theme/common/transparent.png" alt="">';
  2784. //$sortimg.= '<span class="nowrap">';
  2785. if (! $sortorder || $field != $sortfield)
  2786. {
  2787. //$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=asc&begin='.$begin.$options.'">'.img_down("A-Z",0).'</a>';
  2788. //$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=desc&begin='.$begin.$options.'">'.img_up("Z-A",0).'</a>';
  2789. }
  2790. else
  2791. {
  2792. if ($sortorder == 'DESC' ) {
  2793. //$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=asc&begin='.$begin.$options.'">'.img_down("A-Z",0).'</a>';
  2794. //$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=desc&begin='.$begin.$options.'">'.img_up("Z-A",1).'</a>';
  2795. $sortimg.= '<span class="nowrap">'.img_up("Z-A",0).'</span>';
  2796. }
  2797. if ($sortorder == 'ASC' ) {
  2798. //$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=asc&begin='.$begin.$options.'">'.img_down("A-Z",1).'</a>';
  2799. //$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=desc&begin='.$begin.$options.'">'.img_up("Z-A",0).'</a>';
  2800. $sortimg.= '<span class="nowrap">'.img_down("A-Z",0).'</span>';
  2801. }
  2802. }
  2803. //$sortimg.= '</span>';
  2804. }
  2805. $out.=$sortimg;
  2806. $out.='</'.$tag.'>';
  2807. return $out;
  2808. }
  2809. /**
  2810. * Show a title.
  2811. *
  2812. * @param string $title Title to show
  2813. * @return string Title to show
  2814. * @deprecated Use load_fiche_titre instead
  2815. * @see load_fiche_titre
  2816. */
  2817. function print_titre($title)
  2818. {
  2819. dol_syslog(__FUNCTION__ . " is deprecated", LOG_WARNING);
  2820. print '<div class="titre">'.$title.'</div>';
  2821. }
  2822. /**
  2823. * Show a title with picto
  2824. *
  2825. * @param string $title Title to show
  2826. * @param string $mesg Added message to show on right
  2827. * @param string $picto Icon to use before title (should be a 32x32 transparent png file)
  2828. * @param int $pictoisfullpath 1=Icon name is a full absolute url of image
  2829. * @param int $id To force an id on html objects
  2830. * @return void
  2831. * @deprecated Use print load_fiche_titre instead
  2832. */
  2833. function print_fiche_titre($title, $mesg='', $picto='title_generic.png', $pictoisfullpath=0, $id='')
  2834. {
  2835. print load_fiche_titre($title, $mesg, $picto, $pictoisfullpath, $id);
  2836. }
  2837. /**
  2838. * Load a title with picto
  2839. *
  2840. * @param string $titre Title to show
  2841. * @param string $morehtmlright Added message to show on right
  2842. * @param string $picto Icon to use before title (should be a 32x32 transparent png file)
  2843. * @param int $pictoisfullpath 1=Icon name is a full absolute url of image
  2844. * @param int $id To force an id on html objects
  2845. * @param string $morecssontable More css on table
  2846. * @return string
  2847. * @see print_barre_liste
  2848. */
  2849. function load_fiche_titre($titre, $morehtmlright='', $picto='title_generic.png', $pictoisfullpath=0, $id=0, $morecssontable='')
  2850. {
  2851. global $conf;
  2852. $return='';
  2853. if ($picto == 'setup') $picto='title.png';
  2854. if (($conf->browser->name == 'ie') && $picto=='title.png') $picto='title.gif';
  2855. $return.= "\n";
  2856. $return.= '<table '.($id?'id="'.$id.'" ':'').'summary="" class="centpercent notopnoleftnoright'.($morecssontable?' '.$morecssontable:'').'" style="margin-bottom: 2px;"><tr>';
  2857. if ($picto) $return.= '<td class="nobordernopadding widthpictotitle" valign="middle">'.img_picto('',$picto, 'id="pictotitle"', $pictoisfullpath).'</td>';
  2858. $return.= '<td class="nobordernopadding" valign="middle">';
  2859. $return.= '<div class="titre">'.$titre.'</div>';
  2860. $return.= '</td>';
  2861. if (dol_strlen($morehtmlright))
  2862. {
  2863. $return.= '<td class="nobordernopadding titre_right" align="right" valign="middle">'.$morehtmlright.'</td>';
  2864. }
  2865. $return.= '</tr></table>'."\n";
  2866. return $return;
  2867. }
  2868. /**
  2869. * Print a title with navigation controls for pagination
  2870. *
  2871. * @param string $titre Title to show (required)
  2872. * @param int $page Numero of page to show in navigation links (required)
  2873. * @param string $file Url of page (required)
  2874. * @param string $options More parameters for links ('' by default, does not include sortfield neither sortorder)
  2875. * @param string $sortfield Field to sort on ('' by default)
  2876. * @param string $sortorder Order to sort ('' by default)
  2877. * @param string $center String in the middle ('' by default). We often find here string $massaction comming from $form->selectMassAction()
  2878. * @param int $num Number of records found by select with limit+1
  2879. * @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.
  2880. * @param string $picto Icon to use before title (should be a 32x32 transparent png file)
  2881. * @param int $pictoisfullpath 1=Icon name is a full absolute url of image
  2882. * @param string $morehtml More html to show
  2883. * @param string $morecss More css to the table
  2884. * @param int $limit Max number of lines (-1 = use default, 0 = no limit, > 0 = limit).
  2885. * @param int $hideselectlimit Force to hide select limit
  2886. * @return void
  2887. */
  2888. function print_barre_liste($titre, $page, $file, $options='', $sortfield='', $sortorder='', $center='', $num=-1, $totalnboflines='', $picto='title_generic.png', $pictoisfullpath=0, $morehtml='', $morecss='', $limit=-1, $hideselectlimit=0)
  2889. {
  2890. global $conf,$langs;
  2891. $savlimit = $limit;
  2892. $savtotalnboflines = $totalnboflines;
  2893. $totalnboflines=abs($totalnboflines);
  2894. if ($picto == 'setup') $picto='title_setup.png';
  2895. if (($conf->browser->name == 'ie') && $picto=='title_generic.png') $picto='title.gif';
  2896. if ($limit < 0) $limit = $conf->liste_limit;
  2897. if ($savlimit != 0 && (($num > $limit) || ($num == -1) || ($limit == 0)))
  2898. {
  2899. $nextpage = 1;
  2900. }
  2901. else
  2902. {
  2903. $nextpage = 0;
  2904. }
  2905. //print 'totalnboflines='.$totalnboflines.'-savlimit='.$savlimit.'-limit='.$limit.'-num='.$num.'-nextpage='.$nextpage;
  2906. print "\n";
  2907. print "<!-- Begin title '".$titre."' -->\n";
  2908. print '<table width="100%" border="0" class="notopnoleftnoright'.($morecss?' '.$morecss:'').'" style="margin-bottom: 6px;"><tr>';
  2909. // Left
  2910. //if ($picto && $titre) print '<td class="nobordernopadding hideonsmartphone" width="40" align="left" valign="middle">'.img_picto('', $picto, 'id="pictotitle"', $pictoisfullpath).'</td>';
  2911. print '<td class="nobordernopadding valignmiddle">';
  2912. if ($picto && $titre) print img_picto('', $picto, 'class="hideonsmartphone valignmiddle" id="pictotitle"', $pictoisfullpath);
  2913. print '<div class="titre inline-block">'.$titre;
  2914. if (!empty($titre) && $savtotalnboflines >= 0 && (string) $savtotalnboflines != '') print ' ('.$totalnboflines.')';
  2915. print '</div></td>';
  2916. // Center
  2917. if ($center)
  2918. {
  2919. print '<td class="nobordernopadding center valignmiddle">'.$center.'</td>';
  2920. }
  2921. // Right
  2922. print '<td class="nobordernopadding valignmiddle" align="right">';
  2923. if ($sortfield) $options .= "&amp;sortfield=".$sortfield;
  2924. if ($sortorder) $options .= "&amp;sortorder=".$sortorder;
  2925. // Show navigation bar
  2926. $pagelist = '';
  2927. if ($savlimit != 0 && ($page > 0 || $num > $limit))
  2928. {
  2929. if ($totalnboflines) // If we know total nb of lines
  2930. {
  2931. $maxnbofpage=(empty($conf->dol_optimize_smallscreen) ? 4 : 1); // page nb before and after selected page + ... + first or last
  2932. if ($limit > 0) $nbpages=ceil($totalnboflines/$limit);
  2933. else $nbpages=1;
  2934. $cpt=($page-$maxnbofpage);
  2935. if ($cpt < 0) { $cpt=0; }
  2936. if ($cpt>=1)
  2937. {
  2938. $pagelist.= '<li'.(($conf->dol_use_jmobile != 4)?' class="pagination"':'').'><a '.(($conf->dol_use_jmobile != 4)?'':'data-role="button" ').'href="'.$file.'?page=0'.$options.'">1</a></li>';
  2939. if ($cpt > 2) $pagelist.='<li'.(($conf->dol_use_jmobile != 4)?' class="pagination"':'').'><span '.(($conf->dol_use_jmobile != 4)?'class="inactive"':'data-role="button"').'>...</span></li>';
  2940. else if ($cpt == 2) $pagelist.='<li'.(($conf->dol_use_jmobile != 4)?' class="pagination"':'').'><a '.(($conf->dol_use_jmobile != 4)?'':'data-role="button" ').'href="'.$file.'?page=1'.$options.'">2</a></li>';
  2941. }
  2942. do
  2943. {
  2944. if ($cpt==$page)
  2945. {
  2946. $pagelist.= '<li'.(($conf->dol_use_jmobile != 4)?' class="pagination"':'').'><span '.(($conf->dol_use_jmobile != 4)?'class="active"':'data-role="button"').'>'.($page+1).'</span></li>';
  2947. }
  2948. else
  2949. {
  2950. $pagelist.= '<li'.(($conf->dol_use_jmobile != 4)?' class="pagination"':'').'><a '.(($conf->dol_use_jmobile != 4)?'':'data-role="button" ').'href="'.$file.'?page='.$cpt.$options.'">'.($cpt+1).'</a></li>';
  2951. }
  2952. $cpt++;
  2953. }
  2954. while ($cpt < $nbpages && $cpt<=$page+$maxnbofpage);
  2955. if ($cpt<$nbpages)
  2956. {
  2957. if ($cpt<$nbpages-2) $pagelist.= '<li'.(($conf->dol_use_jmobile != 4)?' class="pagination"':'').'><span '.(($conf->dol_use_jmobile != 4)?'class="inactive"':'data-role="button"').'>...</span></li>';
  2958. else if ($cpt == $nbpages-2) $pagelist.= '<li'.(($conf->dol_use_jmobile != 4)?' class="pagination"':'').'><a '.(($conf->dol_use_jmobile != 4)?'':'data-role="button" ').'href="'.$file.'?page='.($nbpages-2).$options.'">'.($nbpages - 1).'</a></li>';
  2959. $pagelist.= '<li'.(($conf->dol_use_jmobile != 4)?' class="pagination"':'').'><a '.(($conf->dol_use_jmobile != 4)?'':'data-role="button" ').'href="'.$file.'?page='.($nbpages-1).$options.'">'.$nbpages.'</a></li>';
  2960. }
  2961. }
  2962. else
  2963. {
  2964. $pagelist.= '<li'.(($conf->dol_use_jmobile != 4)?' class="pagination"':'').'><span '.(($conf->dol_use_jmobile != 4)?'class="active"':'data-role="button"').'>'.($page+1)."</li>";
  2965. }
  2966. }
  2967. print_fleche_navigation($page, $file, $options, $nextpage, $pagelist, $morehtml, $savlimit, $totalnboflines, $hideselectlimit); // output the div and ul for previous/last completed with page numbers into $pagelist
  2968. print '</td>';
  2969. print '</tr></table>'."\n";
  2970. print "<!-- End title -->\n\n";
  2971. }
  2972. /**
  2973. * Function to show navigation arrows into lists
  2974. *
  2975. * @param int $page Number of page
  2976. * @param string $file Page URL (in most cases provided with $_SERVER["PHP_SELF"])
  2977. * @param string $options Other url paramaters to propagate ("" by default, may include sortfield and sortorder)
  2978. * @param integer $nextpage Do we show a next page button
  2979. * @param string $betweenarrows HTML content to show between arrows. MUST contains '<li> </li>' tags or '<li><span> </span></li>'.
  2980. * @param string $afterarrows HTML content to show after arrows. Must NOT contains '<li> </li>' tags.
  2981. * @param int $limit Max nb of record to show (-1 = no combo with limit, 0 = no limit, > 0 = limit)
  2982. * @param int $totalnboflines Total number of records/lines for all pages (if known)
  2983. * @param int $hideselectlimit Force to hide select limit
  2984. * @return void
  2985. */
  2986. function print_fleche_navigation($page, $file, $options='', $nextpage=0, $betweenarrows='', $afterarrows='', $limit=-1, $totalnboflines=0, $hideselectlimit=0)
  2987. {
  2988. global $conf, $langs;
  2989. print '<div class="pagination"><ul>';
  2990. if ((int) $limit >= 0 && empty($hideselectlimit))
  2991. {
  2992. $pagesizechoices='10:10,20:20,30:30,40:40,50:50,100:100,250:250,500:500,1000:1000,5000:5000';
  2993. //$pagesizechoices.=',0:'.$langs->trans("All"); // Not yet supported
  2994. //$pagesizechoices.=',2:2';
  2995. if (! empty($conf->global->MAIN_PAGESIZE_CHOICES)) $pagesizechoices=$conf->global->MAIN_PAGESIZE_CHOICES;
  2996. print '<li class="pagination">';
  2997. print '<select class="flat selectlimit" name="limit" title="'.dol_escape_htmltag($langs->trans("MaxNbOfRecordPerPage")).'">';
  2998. $tmpchoice=explode(',',$pagesizechoices);
  2999. $tmpkey=$limit.':'.$limit;
  3000. if (! in_array($tmpkey, $tmpchoice)) $tmpchoice[]=$tmpkey;
  3001. $tmpkey=$conf->liste_limit.':'.$conf->liste_limit;
  3002. if (! in_array($tmpkey, $tmpchoice)) $tmpchoice[]=$tmpkey;
  3003. asort($tmpchoice, SORT_NUMERIC);
  3004. $found=false;
  3005. foreach($tmpchoice as $val)
  3006. {
  3007. $selected='';
  3008. $tmp=explode(':',$val);
  3009. $key=$tmp[0];
  3010. $val=$tmp[1];
  3011. if ($key != '' && $val != '')
  3012. {
  3013. if ((int) $key == (int) $limit)
  3014. {
  3015. $selected = ' selected="selected"';
  3016. $found = true;
  3017. }
  3018. print '<option name="'.$key.'"'.$selected.'>'.dol_escape_htmltag($val).'</option>'."\n";
  3019. }
  3020. }
  3021. print '</select>';
  3022. if ($conf->use_javascript_ajax)
  3023. {
  3024. print '<!-- JS CODE TO ENABLE select limit to launch submit of page -->
  3025. <script type="text/javascript">
  3026. jQuery(document).ready(function () {
  3027. jQuery(".selectlimit").change(function() {
  3028. console.log("Change limit. Send submit");
  3029. $(this).parents(\'form:first\').submit();
  3030. });
  3031. });
  3032. </script>
  3033. ';
  3034. }
  3035. print '</li>';
  3036. }
  3037. if ($page > 0)
  3038. {
  3039. if (($conf->dol_use_jmobile != 4)) print '<li class="pagination"><a class="paginationprevious" href="'.$file.'?page='.($page-1).$options.'"><</a></li>';
  3040. else print '<li><a data-role="button" data-icon="arrow-l" data-iconpos="left" href="'.$file.'?page='.($page-1).$options.'">'.$langs->trans("Previous").'</a></li>';
  3041. }
  3042. if ($betweenarrows)
  3043. {
  3044. print $betweenarrows;
  3045. }
  3046. if ($nextpage > 0)
  3047. {
  3048. if (($conf->dol_use_jmobile != 4)) print '<li class="pagination"><a class="paginationnext" href="'.$file.'?page='.($page+1).$options.'">></a></li>';
  3049. else print '<li><a data-role="button" data-icon="arrow-r" data-iconpos="right" href="'.$file.'?page='.($page+1).$options.'">'.$langs->trans("Next").'</a></li>';
  3050. }
  3051. if ($afterarrows)
  3052. {
  3053. print '<li class="paginationafterarrows">';
  3054. print $afterarrows;
  3055. print '</li>';
  3056. }
  3057. print '</ul></div>'."\n";
  3058. }
  3059. /**
  3060. * Return a string with VAT rate label formated for view output
  3061. * Used into pdf and HTML pages
  3062. *
  3063. * @param string $rate Rate value to format ('19.6', '19,6', '19.6%', '19,6%', '19.6 (CODEX)', ...)
  3064. * @param boolean $addpercent Add a percent % sign in output
  3065. * @param int $info_bits Miscellaneous information on vat (0=Default, 1=French NPR vat)
  3066. * @param int $usestarfornpr 1=Use '*' for NPR vat rate intead of MAIN_LABEL_MENTION_NPR
  3067. * @return string String with formated amounts ('19,6' or '19,6%' or '8.5% (NPR)' or '8.5% *' or '19,6 (CODEX)')
  3068. */
  3069. function vatrate($rate, $addpercent=false, $info_bits=0, $usestarfornpr=0)
  3070. {
  3071. $morelabel='';
  3072. if (preg_match('/%/',$rate))
  3073. {
  3074. $rate=str_replace('%','',$rate);
  3075. $addpercent=true;
  3076. }
  3077. if (preg_match('/\((.*)\)/',$rate,$reg))
  3078. {
  3079. $morelabel=' ('.$reg[1].')';
  3080. $rate=preg_replace('/\s*'.preg_quote($morelabel,'/').'/','',$rate);
  3081. }
  3082. if (preg_match('/\*/',$rate) || preg_match('/'.constant('MAIN_LABEL_MENTION_NPR').'/i',$rate))
  3083. {
  3084. $rate=str_replace('*','',$rate);
  3085. $info_bits |= 1;
  3086. }
  3087. $ret=price($rate,0,'',0,0).($addpercent?'%':'');
  3088. if ($info_bits & 1) $ret.=' '.($usestarfornpr?'*':constant('MAIN_LABEL_MENTION_NPR'));
  3089. $ret.=$morelabel;
  3090. return $ret;
  3091. }
  3092. /**
  3093. * Function to format a value into an amount for visual output
  3094. * Function used into PDF and HTML pages
  3095. *
  3096. * @param float $amount Amount to format
  3097. * @param integer $form Type of format, HTML or not (not by default)
  3098. * @param Translate $outlangs Object langs for output
  3099. * @param int $trunc 1=Truncate if there is too much decimals (default), 0=Does not truncate. Deprecated because amount are rounded (to unit or total amount accurancy) before inserted into database or after a computation, so this parameter should be useless.
  3100. * @param int $rounding Minimum number of decimal to show. If 0, no change, if -1, we use min($conf->global->MAIN_MAX_DECIMALS_UNIT,$conf->global->MAIN_MAX_DECIMALS_TOTAL)
  3101. * @param int $forcerounding Force the number of decimal to forcerounding decimal (-1=do not force)
  3102. * @param string $currency_code To add currency symbol (''=add nothing, 'auto'=Use default currency, 'XXX'=add currency symbols for XXX currency)
  3103. * @return string Chaine avec montant formate
  3104. *
  3105. * @see price2num Revert function of price
  3106. */
  3107. function price($amount, $form=0, $outlangs='', $trunc=1, $rounding=-1, $forcerounding=-1, $currency_code='')
  3108. {
  3109. global $langs,$conf;
  3110. // Clean parameters
  3111. if (empty($amount)) $amount=0; // To have a numeric value if amount not defined or = ''
  3112. $amount = (is_numeric($amount)?$amount:0); // Check if amount is numeric, for example, an error occured when amount value = o (letter) instead 0 (number)
  3113. if ($rounding < 0) $rounding=min($conf->global->MAIN_MAX_DECIMALS_UNIT,$conf->global->MAIN_MAX_DECIMALS_TOT);
  3114. $nbdecimal=$rounding;
  3115. // Output separators by default (french)
  3116. $dec=','; $thousand=' ';
  3117. // If $outlangs not forced, we use use language
  3118. if (! is_object($outlangs)) $outlangs=$langs;
  3119. if ($outlangs->transnoentitiesnoconv("SeparatorDecimal") != "SeparatorDecimal") $dec=$outlangs->transnoentitiesnoconv("SeparatorDecimal");
  3120. if ($outlangs->transnoentitiesnoconv("SeparatorThousand")!= "SeparatorThousand") $thousand=$outlangs->transnoentitiesnoconv("SeparatorThousand");
  3121. if ($thousand == 'None') $thousand='';
  3122. else if ($thousand == 'Space') $thousand=' ';
  3123. //print "outlangs=".$outlangs->defaultlang." amount=".$amount." html=".$form." trunc=".$trunc." nbdecimal=".$nbdecimal." dec='".$dec."' thousand='".$thousand."'<br>";
  3124. //print "amount=".$amount."-";
  3125. $amount = str_replace(',','.',$amount); // should be useless
  3126. //print $amount."-";
  3127. $datas = explode('.',$amount);
  3128. $decpart = isset($datas[1])?$datas[1]:'';
  3129. $decpart = preg_replace('/0+$/i','',$decpart); // Supprime les 0 de fin de partie decimale
  3130. //print "decpart=".$decpart."<br>";
  3131. $end='';
  3132. // We increase nbdecimal if there is more decimal than asked (to not loose information)
  3133. if (dol_strlen($decpart) > $nbdecimal) $nbdecimal=dol_strlen($decpart);
  3134. // Si on depasse max
  3135. if ($trunc && $nbdecimal > $conf->global->MAIN_MAX_DECIMALS_SHOWN)
  3136. {
  3137. $nbdecimal=$conf->global->MAIN_MAX_DECIMALS_SHOWN;
  3138. if (preg_match('/\.\.\./i',$conf->global->MAIN_MAX_DECIMALS_SHOWN))
  3139. {
  3140. // Si un affichage est tronque, on montre des ...
  3141. $end='...';
  3142. }
  3143. }
  3144. // If force rounding
  3145. if ($forcerounding >= 0) $nbdecimal = $forcerounding;
  3146. // Format number
  3147. $output=number_format($amount, $nbdecimal, $dec, $thousand);
  3148. if ($form)
  3149. {
  3150. $output=preg_replace('/\s/','&nbsp;',$output);
  3151. $output=preg_replace('/\'/','&#039;',$output);
  3152. }
  3153. // Add symbol of currency if requested
  3154. $cursymbolbefore=$cursymbolafter='';
  3155. if ($currency_code)
  3156. {
  3157. if ($currency_code == 'auto') $currency_code=$conf->currency;
  3158. $listofcurrenciesbefore=array('USD','GBP','AUD','MXN');
  3159. if (in_array($currency_code,$listofcurrenciesbefore)) $cursymbolbefore.=$outlangs->getCurrencySymbol($currency_code);
  3160. else
  3161. {
  3162. $tmpcur=$outlangs->getCurrencySymbol($currency_code);
  3163. $cursymbolafter.=($tmpcur == $currency_code ? ' '.$tmpcur : $tmpcur);
  3164. }
  3165. }
  3166. $output=$cursymbolbefore.$output.$end.($cursymbolafter?' ':'').$cursymbolafter;
  3167. return $output;
  3168. }
  3169. /**
  3170. * Function that return a number with universal decimal format (decimal separator is '.') from an amount typed by a user.
  3171. * Function to use on each input amount before any numeric test or database insert
  3172. *
  3173. * @param float $amount Amount to convert/clean
  3174. * @param string $rounding ''=No rounding
  3175. * 'MU'=Round to Max unit price (MAIN_MAX_DECIMALS_UNIT)
  3176. * 'MT'=Round to Max for totals with Tax (MAIN_MAX_DECIMALS_TOT)
  3177. * 'MS'=Round to Max for stock quantity (MAIN_MAX_DECIMALS_STOCK)
  3178. * @param int $alreadysqlnb Put 1 if you know that content is already universal format number
  3179. * @return string Amount with universal numeric format (Example: '99.99999') or unchanged text if conversion fails.
  3180. *
  3181. * @see price Opposite function of price2num
  3182. */
  3183. function price2num($amount,$rounding='',$alreadysqlnb=0)
  3184. {
  3185. global $langs,$conf;
  3186. // Round PHP function does not allow number like '1,234.56' nor '1.234,56' nor '1 234,56'
  3187. // Numbers must be '1234.56'
  3188. // Decimal delimiter for PHP and database SQL requests must be '.'
  3189. $dec=','; $thousand=' ';
  3190. if ($langs->transnoentitiesnoconv("SeparatorDecimal") != "SeparatorDecimal") $dec=$langs->transnoentitiesnoconv("SeparatorDecimal");
  3191. if ($langs->transnoentitiesnoconv("SeparatorThousand")!= "SeparatorThousand") $thousand=$langs->transnoentitiesnoconv("SeparatorThousand");
  3192. if ($thousand == 'None') $thousand='';
  3193. elseif ($thousand == 'Space') $thousand=' ';
  3194. //print "amount=".$amount." html=".$form." trunc=".$trunc." nbdecimal=".$nbdecimal." dec='".$dec."' thousand='".$thousand."'<br>";
  3195. // Convert value to universal number format (no thousand separator, '.' as decimal separator)
  3196. if ($alreadysqlnb != 1) // If not a PHP number or unknown, we change format
  3197. {
  3198. //print 'PP'.$amount.' - '.$dec.' - '.$thousand.' - '.intval($amount).'<br>';
  3199. // Convert amount to format with dolibarr dec and thousand (this is because PHP convert a number
  3200. // to format defined by LC_NUMERIC after a calculation and we want source format to be like defined by Dolibarr setup.
  3201. if (is_numeric($amount))
  3202. {
  3203. // We put in temps value of decimal ("0.00001"). Works with 0 and 2.0E-5 and 9999.10
  3204. $temps=sprintf("%0.10F",$amount-intval($amount)); // temps=0.0000000000 or 0.0000200000 or 9999.1000000000
  3205. $temps=preg_replace('/([\.1-9])0+$/','\\1',$temps); // temps=0. or 0.00002 or 9999.1
  3206. $nbofdec=max(0,dol_strlen($temps)-2); // -2 to remove "0."
  3207. $amount=number_format($amount,$nbofdec,$dec,$thousand);
  3208. }
  3209. //print "QQ".$amount.'<br>';
  3210. // Now make replace (the main goal of function)
  3211. if ($thousand != ',' && $thousand != '.') $amount=str_replace(',','.',$amount); // To accept 2 notations for french users
  3212. $amount=str_replace(' ','',$amount); // To avoid spaces
  3213. $amount=str_replace($thousand,'',$amount); // Replace of thousand before replace of dec to avoid pb if thousand is .
  3214. $amount=str_replace($dec,'.',$amount);
  3215. }
  3216. // Now, make a rounding if required
  3217. if ($rounding)
  3218. {
  3219. $nbofdectoround='';
  3220. if ($rounding == 'MU') $nbofdectoround=$conf->global->MAIN_MAX_DECIMALS_UNIT;
  3221. elseif ($rounding == 'MT') $nbofdectoround=$conf->global->MAIN_MAX_DECIMALS_TOT;
  3222. elseif ($rounding == 'MS') $nbofdectoround=empty($conf->global->MAIN_MAX_DECIMALS_STOCK)?5:$conf->global->MAIN_MAX_DECIMALS_STOCK;
  3223. elseif (is_numeric($rounding)) $nbofdectoround=$rounding; // For admin info page
  3224. //print "RR".$amount.' - '.$nbofdectoround.'<br>';
  3225. if (dol_strlen($nbofdectoround)) $amount = round($amount,$nbofdectoround); // $nbofdectoround can be 0.
  3226. else return 'ErrorBadParameterProvidedToFunction';
  3227. //print 'SS'.$amount.' - '.$nbofdec.' - '.$dec.' - '.$thousand.' - '.$nbofdectoround.'<br>';
  3228. // Convert amount to format with dolibarr dec and thousand (this is because PHP convert a number
  3229. // to format defined by LC_NUMERIC after a calculation and we want source format to be defined by Dolibarr setup.
  3230. if (is_numeric($amount))
  3231. {
  3232. // We put in temps value of decimal ("0.00001"). Works with 0 and 2.0E-5 and 9999.10
  3233. $temps=sprintf("%0.10F",$amount-intval($amount)); // temps=0.0000000000 or 0.0000200000 or 9999.1000000000
  3234. $temps=preg_replace('/([\.1-9])0+$/','\\1',$temps); // temps=0. or 0.00002 or 9999.1
  3235. $nbofdec=max(0,dol_strlen($temps)-2); // -2 to remove "0."
  3236. $amount=number_format($amount,min($nbofdec,$nbofdectoround),$dec,$thousand); // Convert amount to format with dolibarr dec and thousand
  3237. }
  3238. //print "TT".$amount.'<br>';
  3239. // Always make replace because each math function (like round) replace
  3240. // with local values and we want a number that has a SQL string format x.y
  3241. if ($thousand != ',' && $thousand != '.') $amount=str_replace(',','.',$amount); // To accept 2 notations for french users
  3242. $amount=str_replace(' ','',$amount); // To avoid spaces
  3243. $amount=str_replace($thousand,'',$amount); // Replace of thousand before replace of dec to avoid pb if thousand is .
  3244. $amount=str_replace($dec,'.',$amount);
  3245. }
  3246. return $amount;
  3247. }
  3248. /**
  3249. * Output a dimension with best unit
  3250. *
  3251. * @param float $dimension Dimension
  3252. * @param int $unit Unit of dimension (0, -3, ...)
  3253. * @param string $type 'weight', 'volume', ...
  3254. * @param Translate $outputlangs Translate language object
  3255. * @param int $round -1 = non rounding, x = number of decimal
  3256. * @param string $forceunitoutput 'no' or numeric (-3, -6, ...) compared to $unit
  3257. * @return string String to show dimensions
  3258. */
  3259. function showDimensionInBestUnit($dimension, $unit, $type, $outputlangs, $round=-1, $forceunitoutput='no')
  3260. {
  3261. require_once DOL_DOCUMENT_ROOT.'/core/lib/product.lib.php';
  3262. if (($forceunitoutput == 'no' && $dimension < 1/10000) || (is_numeric($forceunitoutput) && $forceunitoutput == -6))
  3263. {
  3264. $dimension = $dimension * 1000000;
  3265. $unit = $unit - 6;
  3266. }
  3267. elseif (($forceunitoutput == 'no' && $dimension < 1/10) || (is_numeric($forceunitoutput) && $forceunitoutput == -3))
  3268. {
  3269. $dimension = $dimension * 1000;
  3270. $unit = $unit - 3;
  3271. }
  3272. elseif (($forceunitoutput == 'no' && $dimension > 100000000) || (is_numeric($forceunitoutput) && $forceunitoutput == 6))
  3273. {
  3274. $dimension = $dimension / 1000000;
  3275. $unit = $unit + 6;
  3276. }
  3277. elseif (($forceunitoutput == 'no' && $dimension > 100000) || (is_numeric($forceunitoutput) && $forceunitoutput == 3))
  3278. {
  3279. $dimension = $dimension / 1000;
  3280. $unit = $unit + 3;
  3281. }
  3282. $ret=price($dimension, 0, $outputlangs, 0, 0, $round).' '.measuring_units_string($unit, $type);
  3283. return $ret;
  3284. }
  3285. /**
  3286. * Return localtax rate for a particular vat, when selling a product with vat $vatrate, from a $thirdparty_buyer to a $thirdparty_seller
  3287. * Note: This function applies same rules than get_default_tva
  3288. *
  3289. * @param float $vatrate Vat rate. Can be '8.5' or '8.5 (VATCODEX)' for example
  3290. * @param int $local Local tax to search and return (1 or 2 return only tax rate 1 or tax rate 2)
  3291. * @param Societe $thirdparty_buyer Object of buying third party
  3292. * @param Societe $thirdparty_seller Object of selling third party ($mysoc if not defined)
  3293. * @param int $vatnpr If vat rate is NPR or not
  3294. * @return mixed 0 if not found, localtax rate if found
  3295. * @see get_default_tva
  3296. */
  3297. function get_localtax($vatrate, $local, $thirdparty_buyer="", $thirdparty_seller="", $vatnpr=0)
  3298. {
  3299. global $db, $conf, $mysoc;
  3300. if (empty($thirdparty_seller) || ! is_object($thirdparty_seller)) $thirdparty_seller=$mysoc;
  3301. 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);
  3302. $vatratecleaned = $vatrate;
  3303. if (preg_match('/^(.*)\s*\((.*)\)$/', $vatrate, $reg)) // If vat is "xx (yy)"
  3304. {
  3305. $vatratecleaned = trim($reg[1]);
  3306. $vatratecode = $reg[2];
  3307. }
  3308. /*if ($thirdparty_buyer->country_code != $thirdparty_seller->country_code)
  3309. {
  3310. return 0;
  3311. }*/
  3312. // Some test to guess with no need to make database access
  3313. if ($mysoc->country_code == 'ES') // For spain localtaxes 1 and 2, tax is qualified if buyer use local taxe
  3314. {
  3315. if ($local == 1)
  3316. {
  3317. if (! $mysoc->localtax1_assuj || (string) $vatratecleaned == "0") return 0;
  3318. if ($thirdparty_seller->id == $mysoc->id)
  3319. {
  3320. if (! $thirdparty_buyer->localtax1_assuj) return 0;
  3321. }
  3322. else
  3323. {
  3324. if (! $thirdparty_seller->localtax1_assuj) return 0;
  3325. }
  3326. }
  3327. if ($local == 2)
  3328. {
  3329. if (! $mysoc->localtax2_assuj || (string) $vatratecleaned == "0") return 0;
  3330. if ($thirdparty_seller->id == $mysoc->id)
  3331. {
  3332. if (! $thirdparty_buyer->localtax2_assuj) return 0;
  3333. }
  3334. else
  3335. {
  3336. if (! $thirdparty_seller->localtax2_assuj) return 0;
  3337. }
  3338. }
  3339. }
  3340. else
  3341. {
  3342. if ($local == 1 && ! $thirdparty_seller->localtax1_assuj) return 0;
  3343. if ($local == 2 && ! $thirdparty_seller->localtax2_assuj) return 0;
  3344. }
  3345. // For some country MAIN_GET_LOCALTAXES_VALUES_FROM_THIRDPARTY is forced to on.
  3346. if (in_array($mysoc->country_code, array('ES')))
  3347. {
  3348. $conf->global->MAIN_GET_LOCALTAXES_VALUES_FROM_THIRDPARTY = 1;
  3349. }
  3350. // Search local taxes
  3351. if (! empty($conf->global->MAIN_GET_LOCALTAXES_VALUES_FROM_THIRDPARTY))
  3352. {
  3353. if ($local==1)
  3354. {
  3355. if ($thirdparty_seller != $mysoc)
  3356. {
  3357. if (!isOnlyOneLocalTax($local)) // TODO We should provide $vatrate to search on correct line and not always on line with highest vat rate
  3358. {
  3359. return $thirdparty_seller->localtax1_value;
  3360. }
  3361. }
  3362. else // i am the seller
  3363. {
  3364. if (!isOnlyOneLocalTax($local)) // TODO If seller is me, why not always returning this, even if there is only one locatax vat.
  3365. {
  3366. return $conf->global->MAIN_INFO_VALUE_LOCALTAX1;
  3367. }
  3368. }
  3369. }
  3370. if ($local==2)
  3371. {
  3372. if ($thirdparty_seller != $mysoc)
  3373. {
  3374. if (!isOnlyOneLocalTax($local)) // TODO We should provide $vatrate to search on correct line and not always on line with highest vat rate
  3375. // TODO We should also return value defined on thirdparty only if defined
  3376. {
  3377. return $thirdparty_seller->localtax2_value;
  3378. }
  3379. }
  3380. else // i am the seller
  3381. {
  3382. if (!isOnlyOneLocalTax($local)) // This is for spain only, we don't return value found into datbase even if there is only one locatax vat.
  3383. {
  3384. return $conf->global->MAIN_INFO_VALUE_LOCALTAX2;
  3385. }
  3386. }
  3387. }
  3388. }
  3389. // By default, search value of local tax on line of common tax
  3390. $sql = "SELECT t.localtax1, t.localtax2, t.localtax1_type, t.localtax2_type";
  3391. $sql .= " FROM ".MAIN_DB_PREFIX."c_tva as t, ".MAIN_DB_PREFIX."c_country as c";
  3392. $sql .= " WHERE t.fk_pays = c.rowid AND c.code = '".$thirdparty_seller->country_code."'";
  3393. $sql .= " AND t.taux = ".((float) $vatratecleaned)." AND t.active = 1";
  3394. if ($vatratecode) $sql.= " AND t.code ='".$vatratecode."'"; // If we have the code, we use it in priority
  3395. else $sql.= " AND t.recuperableonly ='".$vatnpr."'";
  3396. dol_syslog("get_localtax", LOG_DEBUG);
  3397. $resql=$db->query($sql);
  3398. if ($resql)
  3399. {
  3400. $obj = $db->fetch_object($resql);
  3401. if ($local==1) return $obj->localtax1;
  3402. elseif ($local==2) return $obj->localtax2;
  3403. }
  3404. return 0;
  3405. }
  3406. /**
  3407. * Return true if LocalTax (1 or 2) is unique.
  3408. * Example: If localtax1 is 5 on line with highest common vat rate, return true
  3409. * Example: If localtax1 is 5:8:15 on line with highest common vat rate, return false
  3410. *
  3411. * @param int $local Local tax to test (1 or 2)
  3412. * @return boolean True if LocalTax have multiple values, False if not
  3413. */
  3414. function isOnlyOneLocalTax($local)
  3415. {
  3416. $tax=get_localtax_by_third($local);
  3417. $valors=explode(":", $tax);
  3418. if (count($valors)>1)
  3419. {
  3420. return false;
  3421. }
  3422. else
  3423. {
  3424. return true;
  3425. }
  3426. }
  3427. /**
  3428. * Get values of localtaxes (1 or 2) for company country for the common vat with the highest value
  3429. *
  3430. * @param int $local LocalTax to get
  3431. * @return number Values of localtax
  3432. */
  3433. function get_localtax_by_third($local)
  3434. {
  3435. global $db, $mysoc;
  3436. $sql ="SELECT t.localtax1, t.localtax2 ";
  3437. $sql.=" FROM ".MAIN_DB_PREFIX."c_tva as t inner join ".MAIN_DB_PREFIX."c_country as c ON c.rowid=t.fk_pays";
  3438. $sql.=" WHERE c.code = '".$mysoc->country_code."' AND t.active = 1 AND t.taux=(";
  3439. $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";
  3440. $sql.=" WHERE c.code = '".$mysoc->country_code."' AND tt.active = 1";
  3441. $sql.=" )";
  3442. $resql=$db->query($sql);
  3443. if ($resql)
  3444. {
  3445. $obj = $db->fetch_object($resql);
  3446. if ($local==1) return $obj->localtax1;
  3447. elseif ($local==2) return $obj->localtax2;
  3448. }
  3449. return 0;
  3450. }
  3451. /**
  3452. * Get vat rate and npr from id.
  3453. * You can call getLocalTaxesFromRate after to get other fields
  3454. *
  3455. * @param int $vatrowid Line ID into vat rate table.
  3456. * @return array array(localtax_type1(1-6 / 0 if not found), rate of localtax1, ...)
  3457. */
  3458. function getTaxesFromId($vatrowid)
  3459. {
  3460. global $db, $mysoc;
  3461. dol_syslog("getTaxesFromId vatrowid=".$vatrowid);
  3462. // Search local taxes
  3463. $sql = "SELECT t.rowid, t.code, t.taux as rate, t.recuperableonly as npr";
  3464. $sql.= " FROM ".MAIN_DB_PREFIX."c_tva as t";
  3465. $sql.= " WHERE t.rowid ='".$vatrowid."'";
  3466. $resql=$db->query($sql);
  3467. if ($resql)
  3468. {
  3469. $obj = $db->fetch_object($resql);
  3470. return array('rowid'=>$obj->rowid, 'code'=>$obj->code, 'rate'=>$obj->rate, 'npr'=>$obj->npr);
  3471. }
  3472. else dol_print_error($db);
  3473. return array();
  3474. }
  3475. /**
  3476. * Get type and rate of localtaxes for a particular vat rate/country fo thirdparty
  3477. * TODO
  3478. * This function is ALSO called to retrieve type for building PDF. Such call of function must be removed.
  3479. * Instead this function must be called when adding a line to get the array of localtax and type, and then
  3480. * provide it to the function calcul_price_total.
  3481. *
  3482. * @param string $vatrate VAT 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.
  3483. * @param int $local Number of localtax (1 or 2, or 0 to return 1 & 2)
  3484. * @param Societe $buyer Company object
  3485. * @param Societe $seller Company object
  3486. * @param int $firstparamisid 1 if first param is id into table (use this if you can)
  3487. * @return array array(localtax_type1(1-6 / 0 if not found), rate of localtax1, ...)
  3488. */
  3489. function getLocalTaxesFromRate($vatrate, $local, $buyer, $seller, $firstparamisid=0)
  3490. {
  3491. global $db, $mysoc;
  3492. dol_syslog("getLocalTaxesFromRate vatrate=".$vatrate." local=".$local);
  3493. $vatratecleaned = $vatrate;
  3494. if (preg_match('/^(.*)\s*\((.*)\)$/', $vatrate, $reg)) // If vat is "xx (yy)"
  3495. {
  3496. $vatratecleaned = $reg[1];
  3497. $vatratecode = $reg[2];
  3498. }
  3499. // Search local taxes
  3500. $sql = "SELECT t.localtax1, t.localtax1_type, t.localtax2, t.localtax2_type, t.accountancy_code_sell, t.accountancy_code_buy";
  3501. $sql .= " FROM ".MAIN_DB_PREFIX."c_tva as t";
  3502. if ($firstparamisid) $sql.= " WHERE t.rowid ='".$vatrate."'";
  3503. else
  3504. {
  3505. $sql.=", ".MAIN_DB_PREFIX."c_country as c";
  3506. if ($mysoc->country_code == 'ES') $sql .= " WHERE t.fk_pays = c.rowid AND c.code = '".$buyer->country_code."'"; // local tax in spain use the buyer country ??
  3507. else $sql .= " WHERE t.fk_pays = c.rowid AND c.code = '".$seller->country_code."'";
  3508. $sql.= " AND t.taux = ".((float) $vatratecleaned)." AND t.active = 1";
  3509. if ($vatratecode) $sql.= " AND t.code ='".$vatratecode."'";
  3510. }
  3511. $resql=$db->query($sql);
  3512. if ($resql)
  3513. {
  3514. $obj = $db->fetch_object($resql);
  3515. if ($local == 1)
  3516. {
  3517. if (! isOnlyOneLocalTax(1))
  3518. {
  3519. return array($obj->localtax1_type, get_localtax($vatrate, $local, $buyer, $seller), $obj->accountancy_code_sell,$obj->accountancy_code_buy);
  3520. }
  3521. else
  3522. {
  3523. return array($obj->localtax1_type, $obj->localtax1,$obj->accountancy_code_sell,$obj->accountancy_code_buy);
  3524. }
  3525. }
  3526. elseif ($local == 2)
  3527. {
  3528. if (! isOnlyOneLocalTax(2))
  3529. {
  3530. return array($obj->localtax2_type, get_localtax($vatrate, $local, $buyer, $seller),$obj->accountancy_code_sell,$obj->accountancy_code_buy);
  3531. }
  3532. else
  3533. {
  3534. return array($obj->localtax2_type, $obj->localtax2,$obj->accountancy_code_sell,$obj->accountancy_code_buy);
  3535. }
  3536. }
  3537. else
  3538. {
  3539. if(! isOnlyOneLocalTax(1))
  3540. {
  3541. if(! isOnlyOneLocalTax(2))
  3542. {
  3543. return array($obj->localtax1_type, get_localtax($vatrate, 1, $buyer, $seller), $obj->localtax2_type, get_localtax($vatrate, 2, $buyer, $seller),$obj->accountancy_code_sell,$obj->accountancy_code_buy);
  3544. }
  3545. else
  3546. {
  3547. return array($obj->localtax1_type, get_localtax($vatrate, 1, $buyer, $seller), $obj->localtax2_type, $obj->localtax2,$obj->accountancy_code_sell,$obj->accountancy_code_buy);
  3548. }
  3549. }
  3550. else
  3551. {
  3552. if(! isOnlyOneLocalTax(2))
  3553. {
  3554. return array($obj->localtax1_type, $obj->localtax1, $obj->localtax2_type,get_localtax($vatrate, 2, $buyer, $seller) ,$obj->accountancy_code_sell,$obj->accountancy_code_buy);
  3555. }
  3556. else
  3557. {
  3558. return array($obj->localtax1_type, $obj->localtax1, $obj->localtax2_type, $obj->localtax2,$obj->accountancy_code_sell,$obj->accountancy_code_buy);
  3559. }
  3560. }
  3561. }
  3562. }
  3563. return 0;
  3564. }
  3565. /**
  3566. * Return vat rate of a product in a particular selling country or default country vat if product is unknown
  3567. * Function called by get_default_tva
  3568. *
  3569. * @param int $idprod Id of product or 0 if not a predefined product
  3570. * @param Societe $thirdparty_seller Thirdparty with a ->country_code defined (FR, US, IT, ...)
  3571. * @param int $idprodfournprice Id product_fournisseur_price (for "supplier" order/invoice)
  3572. * @return float|string Vat rate to use with format 5.0 or '5.0 (XXX)'
  3573. * @see get_product_localtax_for_country
  3574. */
  3575. function get_product_vat_for_country($idprod, $thirdparty_seller, $idprodfournprice=0)
  3576. {
  3577. global $db,$conf,$mysoc;
  3578. require_once DOL_DOCUMENT_ROOT . '/product/class/product.class.php';
  3579. $ret=0;
  3580. $found=0;
  3581. if ($idprod > 0)
  3582. {
  3583. // Load product
  3584. $product=new Product($db);
  3585. $result=$product->fetch($idprod);
  3586. if ($mysoc->country_code == $thirdparty_seller->country_code) // If selling country is ours
  3587. {
  3588. if ($idprodfournprice > 0) // We want vat for product for a "supplier" order or invoice
  3589. {
  3590. $product->get_buyprice($idprodfournprice,0,0,0);
  3591. $ret=$product->vatrate_supplier;
  3592. }
  3593. else
  3594. {
  3595. $ret=$product->tva_tx; // Default vat of product we defined
  3596. if ($product->default_vat_code) $ret.=' ('.$product->default_vat_code.')';
  3597. }
  3598. $found=1;
  3599. }
  3600. else
  3601. {
  3602. // TODO Read default product vat according to countrycode and product. Vat for couple countrycode/product is a feature not implemeted yet.
  3603. // May be usefull/required if hidden option SERVICE_ARE_ECOMMERCE_200238EC is on
  3604. }
  3605. }
  3606. if (! $found)
  3607. {
  3608. if (empty($conf->global->MAIN_VAT_DEFAULT_IF_AUTODETECT_FAILS))
  3609. {
  3610. // If vat of product for the country not found or not defined, we return the first higher vat of country.
  3611. $sql = "SELECT taux as vat_rate";
  3612. $sql.= " FROM ".MAIN_DB_PREFIX."c_tva as t, ".MAIN_DB_PREFIX."c_country as c";
  3613. $sql.= " WHERE t.active=1 AND t.fk_pays = c.rowid AND c.code='".$thirdparty_seller->country_code."'";
  3614. $sql.= " ORDER BY t.taux DESC, t.code ASC, t.recuperableonly ASC";
  3615. $sql.= $db->plimit(1);
  3616. $resql=$db->query($sql);
  3617. if ($resql)
  3618. {
  3619. $obj=$db->fetch_object($resql);
  3620. if ($obj)
  3621. {
  3622. $ret=$obj->vat_rate;
  3623. }
  3624. $db->free($sql);
  3625. }
  3626. else dol_print_error($db);
  3627. }
  3628. else $ret=$conf->global->MAIN_VAT_DEFAULT_IF_AUTODETECT_FAILS; // Forced value if autodetect fails
  3629. }
  3630. dol_syslog("get_product_vat_for_country: ret=".$ret);
  3631. return $ret;
  3632. }
  3633. /**
  3634. * Return localtax vat rate of a product in a particular selling country or default country vat if product is unknown
  3635. *
  3636. * @param int $idprod Id of product
  3637. * @param int $local 1 for localtax1, 2 for localtax 2
  3638. * @param Societe $thirdparty_seller Thirdparty with a ->country_code defined (FR, US, IT, ...)
  3639. * @return int <0 if KO, Vat rate if OK
  3640. * @see get_product_vat_for_country
  3641. */
  3642. function get_product_localtax_for_country($idprod, $local, $thirdparty_seller)
  3643. {
  3644. global $db,$mysoc;
  3645. if (! class_exists('Product')) {
  3646. require_once DOL_DOCUMENT_ROOT . '/product/class/product.class.php';
  3647. }
  3648. $ret=0;
  3649. $found=0;
  3650. if ($idprod > 0)
  3651. {
  3652. // Load product
  3653. $product=new Product($db);
  3654. $result=$product->fetch($idprod);
  3655. if ($mysoc->country_code == $thirdparty_seller->country_code) // If selling country is ours
  3656. {
  3657. /* Not defined yet, so we don't use this
  3658. if ($local==1) $ret=$product->localtax1_tx;
  3659. elseif ($local==2) $ret=$product->localtax2_tx;
  3660. $found=1;
  3661. */
  3662. }
  3663. else
  3664. {
  3665. // TODO Read default product vat according to countrycode and product
  3666. }
  3667. }
  3668. if (! $found)
  3669. {
  3670. // If vat of product for the country not found or not defined, we return higher vat of country.
  3671. $sql = "SELECT taux as vat_rate, localtax1, localtax2";
  3672. $sql.= " FROM ".MAIN_DB_PREFIX."c_tva as t, ".MAIN_DB_PREFIX."c_country as c";
  3673. $sql.= " WHERE t.active=1 AND t.fk_pays = c.rowid AND c.code='".$thirdparty_seller->country_code."'";
  3674. $sql.= " ORDER BY t.taux DESC, t.recuperableonly ASC";
  3675. $sql.= $db->plimit(1);
  3676. $resql=$db->query($sql);
  3677. if ($resql)
  3678. {
  3679. $obj=$db->fetch_object($resql);
  3680. if ($obj)
  3681. {
  3682. if ($local==1) $ret=$obj->localtax1;
  3683. elseif ($local==2) $ret=$obj->localtax2;
  3684. }
  3685. }
  3686. else dol_print_error($db);
  3687. }
  3688. dol_syslog("get_product_localtax_for_country: ret=".$ret);
  3689. return $ret;
  3690. }
  3691. /**
  3692. * Function that return vat rate of a product line (according to seller, buyer and product vat rate)
  3693. * Si vendeur non assujeti a TVA, TVA par defaut=0. Fin de regle.
  3694. * Si le (pays vendeur = pays acheteur) alors TVA par defaut=TVA du produit vendu. Fin de regle.
  3695. * Si (vendeur et acheteur dans Communaute europeenne) et (bien vendu = moyen de transports neuf comme auto, bateau, avion) alors TVA par defaut=0 (La TVA doit etre paye par acheteur au centre d'impots de son pays et non au vendeur). Fin de regle.
  3696. * Si (vendeur et acheteur dans Communaute europeenne) et (acheteur = particulier ou entreprise sans num TVA intra) alors TVA par defaut=TVA du produit vendu. Fin de regle
  3697. * Si (vendeur et acheteur dans Communaute europeenne) et (acheteur = entreprise avec num TVA) intra alors TVA par defaut=0. Fin de regle
  3698. * Sinon TVA proposee par defaut=0. Fin de regle.
  3699. *
  3700. * @param Societe $thirdparty_seller Objet societe vendeuse
  3701. * @param Societe $thirdparty_buyer Objet societe acheteuse
  3702. * @param int $idprod Id product
  3703. * @param int $idprodfournprice Id product_fournisseur_price (for supplier order/invoice)
  3704. * @return float|string Vat rate to use with format 5.0 or '5.0 (XXX)', -1 if we can't guess it
  3705. * @see get_default_npr, get_default_localtax
  3706. */
  3707. function get_default_tva(Societe $thirdparty_seller, Societe $thirdparty_buyer, $idprod=0, $idprodfournprice=0)
  3708. {
  3709. global $conf;
  3710. // Note: possible values for tva_assuj are 0/1 or franchise/reel
  3711. $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;
  3712. $seller_country_code=$thirdparty_seller->country_code;
  3713. $seller_in_cee=$thirdparty_seller->isInEEC();
  3714. $buyer_country_code=$thirdparty_buyer->country_code;
  3715. $buyer_in_cee=$thirdparty_buyer->isInEEC();
  3716. dol_syslog("get_default_tva: seller use vat=".$seller_use_vat.", seller country=".$seller_country_code.", seller in cee=".$seller_in_cee.", buyer country=".$buyer_country_code.", buyer in cee=".$buyer_in_cee.", idprod=".$idprod.", idprodfournprice=".$idprodfournprice.", SERVICE_ARE_ECOMMERCE_200238EC=".(! empty($conf->global->SERVICES_ARE_ECOMMERCE_200238EC)?$conf->global->SERVICES_ARE_ECOMMERCE_200238EC:''));
  3717. // 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)
  3718. // we use the buyer VAT.
  3719. if (! empty($conf->global->SERVICE_ARE_ECOMMERCE_200238EC))
  3720. {
  3721. if ($seller_in_cee && $buyer_in_cee && ! $thirdparty_buyer->isACompany())
  3722. {
  3723. //print 'VATRULE 0';
  3724. return get_product_vat_for_country($idprod,$thirdparty_buyer,$idprodfournprice);
  3725. }
  3726. }
  3727. // If seller does not use VAT
  3728. if (! $seller_use_vat)
  3729. {
  3730. //print 'VATRULE 1';
  3731. return 0;
  3732. }
  3733. // Le test ci-dessus ne devrait pas etre necessaire. Me signaler l'exemple du cas juridique concerne si le test suivant n'est pas suffisant.
  3734. // Si le (pays vendeur = pays acheteur) alors la TVA par defaut=TVA du produit vendu. Fin de regle.
  3735. if (($seller_country_code == $buyer_country_code)
  3736. || (in_array($seller_country_code,array('FR,MC')) && in_array($buyer_country_code,array('FR','MC')))) // Warning ->country_code not always defined
  3737. {
  3738. //print 'VATRULE 2';
  3739. return get_product_vat_for_country($idprod,$thirdparty_seller,$idprodfournprice);
  3740. }
  3741. // Si (vendeur et acheteur dans Communaute europeenne) et (bien vendu = moyen de transports neuf comme auto, bateau, avion) alors TVA par defaut=0 (La TVA doit etre paye par l'acheteur au centre d'impots de son pays et non au vendeur). Fin de regle.
  3742. // Not supported
  3743. // Si (vendeur et acheteur dans Communaute europeenne) et (acheteur = entreprise) alors TVA par defaut=0. Fin de regle
  3744. // Si (vendeur et acheteur dans Communaute europeenne) et (acheteur = particulier) alors TVA par defaut=TVA du produit vendu. Fin de regle
  3745. if (($seller_in_cee && $buyer_in_cee))
  3746. {
  3747. $isacompany=$thirdparty_buyer->isACompany();
  3748. if ($isacompany)
  3749. {
  3750. //print 'VATRULE 3';
  3751. return 0;
  3752. }
  3753. else
  3754. {
  3755. //print 'VATRULE 4';
  3756. return get_product_vat_for_country($idprod,$thirdparty_seller,$idprodfournprice);
  3757. }
  3758. }
  3759. // Sinon la TVA proposee par defaut=0. Fin de regle.
  3760. // Rem: Cela signifie qu'au moins un des 2 est hors Communaute europeenne et que le pays differe
  3761. //print 'VATRULE 5';
  3762. return 0;
  3763. }
  3764. /**
  3765. * Fonction qui renvoie si tva doit etre tva percue recuperable
  3766. *
  3767. * @param Societe $thirdparty_seller Thirdparty seller
  3768. * @param Societe $thirdparty_buyer Thirdparty buyer
  3769. * @param int $idprod Id product
  3770. * @param int $idprodfournprice Id supplier price for product
  3771. * @return float 0 or 1
  3772. * @see get_default_tva, get_default_localtax
  3773. */
  3774. function get_default_npr(Societe $thirdparty_seller, Societe $thirdparty_buyer, $idprod=0, $idprodfournprice=0)
  3775. {
  3776. global $db;
  3777. if ($idprodfournprice > 0)
  3778. {
  3779. if (! class_exists('ProductFournisseur'))
  3780. require_once DOL_DOCUMENT_ROOT . '/fourn/class/fournisseur.product.class.php';
  3781. $prodprice = new ProductFournisseur($db);
  3782. $prodprice->fetch_product_fournisseur_price($idprodfournprice);
  3783. return $prodprice->fourn_tva_npr;
  3784. }
  3785. elseif ($idprod > 0)
  3786. {
  3787. if (! class_exists('Product'))
  3788. require_once DOL_DOCUMENT_ROOT . '/product/class/product.class.php';
  3789. $prod = new Product($db);
  3790. $prod->fetch($idprod);
  3791. return $prod->tva_npr;
  3792. }
  3793. return 0;
  3794. }
  3795. /**
  3796. * Function that return localtax of a product line (according to seller, buyer and product vat rate)
  3797. * Si vendeur non assujeti a TVA, TVA par defaut=0. Fin de regle.
  3798. * Si le (pays vendeur = pays acheteur) alors TVA par defaut=TVA du produit vendu. Fin de regle.
  3799. * Sinon TVA proposee par defaut=0. Fin de regle.
  3800. *
  3801. * @param Societe $thirdparty_seller Thirdparty seller
  3802. * @param Societe $thirdparty_buyer Thirdparty buyer
  3803. * @param int $local Localtax to process (1 or 2)
  3804. * @param int $idprod Id product
  3805. * @return integer localtax, -1 si ne peut etre determine
  3806. * @see get_default_tva, get_default_npr
  3807. */
  3808. function get_default_localtax($thirdparty_seller, $thirdparty_buyer, $local, $idprod=0)
  3809. {
  3810. global $mysoc;
  3811. if (!is_object($thirdparty_seller)) return -1;
  3812. if (!is_object($thirdparty_buyer)) return -1;
  3813. if ($local==1) // Localtax 1
  3814. {
  3815. if ($mysoc->country_code == 'ES')
  3816. {
  3817. if (is_numeric($thirdparty_buyer->localtax1_assuj) && ! $thirdparty_buyer->localtax1_assuj) return 0;
  3818. }
  3819. else
  3820. {
  3821. // Si vendeur non assujeti a Localtax1, localtax1 par default=0
  3822. if (is_numeric($thirdparty_seller->localtax1_assuj) && ! $thirdparty_seller->localtax1_assuj) return 0;
  3823. if (! is_numeric($thirdparty_seller->localtax1_assuj) && $thirdparty_seller->localtax1_assuj=='localtax1off') return 0;
  3824. }
  3825. }
  3826. elseif ($local==2) //I Localtax 2
  3827. {
  3828. // Si vendeur non assujeti a Localtax2, localtax2 par default=0
  3829. if (is_numeric($thirdparty_seller->localtax2_assuj) && ! $thirdparty_seller->localtax2_assuj) return 0;
  3830. if (! is_numeric($thirdparty_seller->localtax2_assuj) && $thirdparty_seller->localtax2_assuj=='localtax2off') return 0;
  3831. }
  3832. if ($thirdparty_seller->country_code == $thirdparty_buyer->country_code)
  3833. {
  3834. return get_product_localtax_for_country($idprod, $local, $thirdparty_seller);
  3835. }
  3836. return 0;
  3837. }
  3838. /**
  3839. * Return yes or no in current language
  3840. *
  3841. * @param string $yesno Value to test (1, 'yes', 'true' or 0, 'no', 'false')
  3842. * @param integer $case 1=Yes/No, 0=yes/no, 2=Disabled checkbox, 3=Disabled checkbox + Yes/No
  3843. * @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.
  3844. * @return string HTML string
  3845. */
  3846. function yn($yesno, $case=1, $color=0)
  3847. {
  3848. global $langs;
  3849. $result='unknown';
  3850. if ($yesno == 1 || strtolower($yesno) == 'yes' || strtolower($yesno) == 'true') // A mettre avant test sur no a cause du == 0
  3851. {
  3852. $result=$langs->trans('yes');
  3853. if ($case == 1 || $case == 3) $result=$langs->trans("Yes");
  3854. if ($case == 2) $result='<input type="checkbox" value="1" checked disabled>';
  3855. if ($case == 3) $result='<input type="checkbox" value="1" checked disabled> '.$result;
  3856. $classname='ok';
  3857. }
  3858. elseif ($yesno == 0 || strtolower($yesno) == 'no' || strtolower($yesno) == 'false')
  3859. {
  3860. $result=$langs->trans("no");
  3861. if ($case == 1 || $case == 3) $result=$langs->trans("No");
  3862. if ($case == 2) $result='<input type="checkbox" value="0" disabled>';
  3863. if ($case == 3) $result='<input type="checkbox" value="0" disabled> '.$result;
  3864. if ($color == 2) $classname='ok';
  3865. else $classname='error';
  3866. }
  3867. if ($color) return '<font class="'.$classname.'">'.$result.'</font>';
  3868. return $result;
  3869. }
  3870. /**
  3871. * Return a path to have a directory according to object.
  3872. * New usage: $conf->product->multidir_output[$object->entity].'/'.get_exdir(0, 0, 0, 1, $object, 'modulepart')
  3873. * Old usage: '015' with level 3->"0/1/5/", '015' with level 1->"5/", 'ABC-1' with level 3 ->"0/0/1/"
  3874. *
  3875. * @param string $num Id of object (deprecated, $object will be used in future)
  3876. * @param int $level Level of subdirs to return (1, 2 or 3 levels). (deprecated, global option will be used in future)
  3877. * @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)
  3878. * @param int $withoutslash 0=With slash at end (except if '/', we return ''), 1=without slash at end
  3879. * @param Object $object Object
  3880. * @param string $modulepart Type of object ('invoice_supplier, 'donation', 'invoice', ...')
  3881. * @return string Dir to use ending. Example '' or '1/' or '1/2/'
  3882. */
  3883. function get_exdir($num, $level, $alpha, $withoutslash, $object, $modulepart)
  3884. {
  3885. global $conf;
  3886. $path = '';
  3887. $arrayforoldpath=array('cheque','user','category','holiday','shipment','supplier_invoice','invoice_supplier','mailing');
  3888. if (! empty($conf->global->PRODUCT_USE_OLD_PATH_FOR_PHOTO)) $arrayforoldpath[]='product';
  3889. if (! empty($level) && in_array($modulepart, $arrayforoldpath))
  3890. {
  3891. // This part should be removed once all code is using "get_exdir" to forge path, with all parameters provided
  3892. if (empty($alpha)) $num = preg_replace('/([^0-9])/i','',$num);
  3893. else $num = preg_replace('/^.*\-/i','',$num);
  3894. $num = substr("000".$num, -$level);
  3895. if ($level == 1) $path = substr($num,0,1);
  3896. if ($level == 2) $path = substr($num,1,1).'/'.substr($num,0,1);
  3897. if ($level == 3) $path = substr($num,2,1).'/'.substr($num,1,1).'/'.substr($num,0,1);
  3898. }
  3899. else
  3900. {
  3901. // TODO
  3902. // We will enhance here a common way of forging path for document storage
  3903. // Here, object->id, object->ref and object->modulepart are required.
  3904. if (in_array($modulepart, array('thirdparty','contact','member')))
  3905. {
  3906. $path=$object->ref?$object->ref:$object->id;
  3907. }
  3908. }
  3909. if (empty($withoutslash) && ! empty($path)) $path.='/';
  3910. return $path;
  3911. }
  3912. /**
  3913. * Creation of a directory (this can create recursive subdir)
  3914. *
  3915. * @param string $dir Directory to create (Separator must be '/'. Example: '/mydir/mysubdir')
  3916. * @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 PHP has no permission when open_basedir is used)
  3917. * @param int $newmask Mask for new file (Defaults to $conf->global->MAIN_UMASK or 0755 if unavailable). Example: '0444'
  3918. * @return int < 0 if KO, 0 = already exists, > 0 if OK
  3919. */
  3920. function dol_mkdir($dir, $dataroot='', $newmask=null)
  3921. {
  3922. global $conf;
  3923. dol_syslog("functions.lib::dol_mkdir: dir=".$dir,LOG_INFO);
  3924. $dir_osencoded=dol_osencode($dir);
  3925. if (@is_dir($dir_osencoded)) return 0;
  3926. $nberr=0;
  3927. $nbcreated=0;
  3928. $ccdir='';
  3929. if (! empty($dataroot)) {
  3930. // Remove data root from loop
  3931. $dir = str_replace($dataroot.'/', '', $dir);
  3932. $ccdir = $dataroot.'/';
  3933. }
  3934. $cdir = explode("/", $dir);
  3935. $num=count($cdir);
  3936. for ($i = 0; $i < $num; $i++)
  3937. {
  3938. if ($i > 0) $ccdir .= '/'.$cdir[$i];
  3939. else $ccdir .= $cdir[$i];
  3940. if (preg_match("/^.:$/",$ccdir,$regs)) continue; // Si chemin Windows incomplet, on poursuit par rep suivant
  3941. // Attention, le is_dir() peut echouer bien que le rep existe.
  3942. // (ex selon config de open_basedir)
  3943. if ($ccdir)
  3944. {
  3945. $ccdir_osencoded=dol_osencode($ccdir);
  3946. if (! @is_dir($ccdir_osencoded))
  3947. {
  3948. dol_syslog("functions.lib::dol_mkdir: Directory '".$ccdir."' does not exists or is outside open_basedir PHP setting.",LOG_DEBUG);
  3949. umask(0);
  3950. $dirmaskdec=octdec($newmask);
  3951. if (empty($newmask)) {
  3952. $dirmaskdec = empty( $conf->global->MAIN_UMASK ) ? octdec( '0755' ) : octdec( $conf->global->MAIN_UMASK );
  3953. }
  3954. $dirmaskdec |= octdec('0111'); // Set x bit required for directories
  3955. if (! @mkdir($ccdir_osencoded, $dirmaskdec))
  3956. {
  3957. // Si le is_dir a renvoye une fausse info, alors on passe ici.
  3958. dol_syslog("functions.lib::dol_mkdir: Fails to create directory '".$ccdir."' or directory already exists.",LOG_WARNING);
  3959. $nberr++;
  3960. }
  3961. else
  3962. {
  3963. dol_syslog("functions.lib::dol_mkdir: Directory '".$ccdir."' created",LOG_DEBUG);
  3964. $nberr=0; // On remet a zero car si on arrive ici, cela veut dire que les echecs precedents peuvent etre ignore
  3965. $nbcreated++;
  3966. }
  3967. }
  3968. else
  3969. {
  3970. $nberr=0; // On remet a zero car si on arrive ici, cela veut dire que les echecs precedents peuvent etre ignores
  3971. }
  3972. }
  3973. }
  3974. return ($nberr ? -$nberr : $nbcreated);
  3975. }
  3976. /**
  3977. * Return picto saying a field is required
  3978. *
  3979. * @return string Chaine avec picto obligatoire
  3980. */
  3981. function picto_required()
  3982. {
  3983. return '<span class="fieldrequired">*</span>';
  3984. }
  3985. /**
  3986. * Clean a string from all HTML tags and entities
  3987. *
  3988. * @param string $StringHtml String to clean
  3989. * @param integer $removelinefeed 1=Replace also new lines by a space, 0=Only last one are removed
  3990. * @param string $pagecodeto Encoding of input/output string
  3991. * @return string String cleaned
  3992. *
  3993. * @see dol_escape_htmltag
  3994. */
  3995. function dol_string_nohtmltag($StringHtml,$removelinefeed=1,$pagecodeto='UTF-8')
  3996. {
  3997. $pattern = "/<[^<>]+>/";
  3998. $StringHtml = preg_replace('/<br[^>]*>/', "\n", $StringHtml);
  3999. $temp = dol_html_entity_decode($StringHtml,ENT_COMPAT,$pagecodeto);
  4000. $temp = preg_replace($pattern,"",$temp);
  4001. // Supprime aussi les retours
  4002. if ($removelinefeed) $temp=str_replace(array("\r\n","\r","\n")," ",$temp);
  4003. // et les espaces doubles
  4004. while(strpos($temp," "))
  4005. {
  4006. $temp = str_replace(" "," ",$temp);
  4007. }
  4008. $CleanString = trim($temp);
  4009. return $CleanString;
  4010. }
  4011. /**
  4012. * Return first line of text. Cut will depends if content is HTML or not.
  4013. *
  4014. * @param string $text Input text
  4015. * @return string Output text
  4016. * @see dol_nboflines_bis, dol_string_nohtmltag, dol_escape_htmltag
  4017. */
  4018. function dolGetFirstLineOfText($text)
  4019. {
  4020. if (dol_textishtml($text))
  4021. {
  4022. $firstline=preg_replace('/<br[^>]*>.*$/s','',$text); // The s pattern modifier means the . can match newline characters
  4023. $firstline=preg_replace('/<div[^>]*>.*$/s','',$firstline); // The s pattern modifier means the . can match newline characters
  4024. }
  4025. else
  4026. {
  4027. $firstline=preg_replace('/[\n\r].*/','',$text);
  4028. }
  4029. return $firstline.((strlen($firstline) != strlen($text))?'...':'');
  4030. }
  4031. /**
  4032. * Replace CRLF in string with a HTML BR tag
  4033. *
  4034. * @param string $stringtoencode String to encode
  4035. * @param int $nl2brmode 0=Adding br before \n, 1=Replacing \n by br
  4036. * @param bool $forxml false=Use <br>, true=Use <br />
  4037. * @return string String encoded
  4038. * @see dol_nboflines, dolGetFirstLineOfText
  4039. */
  4040. function dol_nl2br($stringtoencode,$nl2brmode=0,$forxml=false)
  4041. {
  4042. if (!$nl2brmode) {
  4043. return nl2br($stringtoencode, $forxml);
  4044. } else {
  4045. $ret=preg_replace('/(\r\n|\r|\n)/i', ($forxml?'<br />':'<br>'), $stringtoencode);
  4046. return $ret;
  4047. }
  4048. }
  4049. /**
  4050. * This function is called to encode a string into a HTML string but differs from htmlentities because
  4051. * a detection is done before to see if text is already HTML or not. Also, all entities but &,<,> are converted.
  4052. * This permits to encode special chars to entities with no double encoding for already encoded HTML strings.
  4053. * This function also remove last EOL or BR if $removelasteolbr=1 (default).
  4054. * For PDF usage, you can show text by 2 ways:
  4055. * - writeHTMLCell -> param must be encoded into HTML.
  4056. * - MultiCell -> param must not be encoded into HTML.
  4057. * Because writeHTMLCell convert also \n into <br>, if function
  4058. * is used to build PDF, nl2brmode must be 1.
  4059. *
  4060. * @param string $stringtoencode String to encode
  4061. * @param int $nl2brmode 0=Adding br before \n, 1=Replacing \n by br (for use with FPDF writeHTMLCell function for example)
  4062. * @param string $pagecodefrom Pagecode stringtoencode is encoded
  4063. * @param int $removelasteolbr 1=Remove last br or lasts \n (default), 0=Do nothing
  4064. * @return string String encoded
  4065. */
  4066. function dol_htmlentitiesbr($stringtoencode,$nl2brmode=0,$pagecodefrom='UTF-8',$removelasteolbr=1)
  4067. {
  4068. $newstring=$stringtoencode;
  4069. if (dol_textishtml($stringtoencode)) // Check if text is already HTML or not
  4070. {
  4071. $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.
  4072. if ($removelasteolbr) $newstring=preg_replace('/<br>$/i','',$newstring); // Remove last <br> (remove only last one)
  4073. $newstring=strtr($newstring,array('&'=>'__and__','<'=>'__lt__','>'=>'__gt__','"'=>'__dquot__'));
  4074. $newstring=dol_htmlentities($newstring,ENT_COMPAT,$pagecodefrom); // Make entity encoding
  4075. $newstring=strtr($newstring,array('__and__'=>'&','__lt__'=>'<','__gt__'=>'>','__dquot__'=>'"'));
  4076. }
  4077. else
  4078. {
  4079. if ($removelasteolbr) $newstring=preg_replace('/(\r\n|\r|\n)$/i','',$newstring); // Remove last \n (may remove several)
  4080. $newstring=dol_nl2br(dol_htmlentities($newstring,ENT_COMPAT,$pagecodefrom),$nl2brmode);
  4081. }
  4082. // Other substitutions that htmlentities does not do
  4083. //$newstring=str_replace(chr(128),'&euro;',$newstring); // 128 = 0x80. Not in html entity table. // Seems useles with TCPDF. Make bug with UTF8 languages
  4084. return $newstring;
  4085. }
  4086. /**
  4087. * This function is called to decode a HTML string (it decodes entities and br tags)
  4088. *
  4089. * @param string $stringtodecode String to decode
  4090. * @param string $pagecodeto Page code for result
  4091. * @return string String decoded
  4092. */
  4093. function dol_htmlentitiesbr_decode($stringtodecode,$pagecodeto='UTF-8')
  4094. {
  4095. $ret=dol_html_entity_decode($stringtodecode,ENT_COMPAT,$pagecodeto);
  4096. $ret=preg_replace('/'."\r\n".'<br(\s[\sa-zA-Z_="]*)?\/?>/i',"<br>",$ret);
  4097. $ret=preg_replace('/<br(\s[\sa-zA-Z_="]*)?\/?>'."\r\n".'/i',"\r\n",$ret);
  4098. $ret=preg_replace('/<br(\s[\sa-zA-Z_="]*)?\/?>'."\n".'/i',"\n",$ret);
  4099. $ret=preg_replace('/<br(\s[\sa-zA-Z_="]*)?\/?>/i',"\n",$ret);
  4100. return $ret;
  4101. }
  4102. /**
  4103. * This function remove all ending \n and br at end
  4104. *
  4105. * @param string $stringtodecode String to decode
  4106. * @return string String decoded
  4107. */
  4108. function dol_htmlcleanlastbr($stringtodecode)
  4109. {
  4110. $ret=preg_replace('/(<br>|<br(\s[\sa-zA-Z_="]*)?\/?>|'."\n".'|'."\r".')+$/i',"",$stringtodecode);
  4111. return $ret;
  4112. }
  4113. /**
  4114. * Replace html_entity_decode functions to manage errors
  4115. *
  4116. * @param string $a Operand a
  4117. * @param string $b Operand b (ENT_QUOTES=convert simple and double quotes)
  4118. * @param string $c Operand c
  4119. * @return string String decoded
  4120. */
  4121. function dol_html_entity_decode($a,$b,$c='UTF-8')
  4122. {
  4123. return html_entity_decode($a,$b,$c);
  4124. }
  4125. /**
  4126. * Replace htmlentities functions to manage errors http://php.net/manual/en/function.htmlentities.php
  4127. * Goal of this function is to be sure to have default values of htmlentities that match what we need.
  4128. *
  4129. * @param string $string The input string.
  4130. * @param int $flags Flags(see PHP doc above)
  4131. * @param string $encoding Encoding
  4132. * @param bool $double_encode When double_encode is turned off PHP will not encode existing html entities
  4133. * @return string $ret Encoded string
  4134. */
  4135. function dol_htmlentities($string, $flags=null, $encoding='UTF-8', $double_encode=false)
  4136. {
  4137. return htmlentities($string, $flags, $encoding, $double_encode);
  4138. }
  4139. /**
  4140. * Check if a string is a correct iso string
  4141. * If not, it will we considered not HTML encoded even if it is by FPDF.
  4142. * Example, if string contains euro symbol that has ascii code 128
  4143. *
  4144. * @param string $s String to check
  4145. * @return int 0 if bad iso, 1 if good iso
  4146. */
  4147. function dol_string_is_good_iso($s)
  4148. {
  4149. $len=dol_strlen($s);
  4150. $ok=1;
  4151. for($scursor=0;$scursor<$len;$scursor++)
  4152. {
  4153. $ordchar=ord($s{$scursor});
  4154. //print $scursor.'-'.$ordchar.'<br>';
  4155. if ($ordchar < 32 && $ordchar != 13 && $ordchar != 10) { $ok=0; break; }
  4156. if ($ordchar > 126 && $ordchar < 160) { $ok=0; break; }
  4157. }
  4158. return $ok;
  4159. }
  4160. /**
  4161. * Return nb of lines of a clear text
  4162. *
  4163. * @param string $s String to check
  4164. * @param int $maxchar Not yet used
  4165. * @return int Number of lines
  4166. * @see dol_nboflines_bis, dolGetFirstLineOfText
  4167. */
  4168. function dol_nboflines($s,$maxchar=0)
  4169. {
  4170. if ($s == '') return 0;
  4171. $arraystring=explode("\n",$s);
  4172. $nb=count($arraystring);
  4173. return $nb;
  4174. }
  4175. /**
  4176. * Return nb of lines of a formated text with \n and <br> (we can't have both \n and br)
  4177. *
  4178. * @param string $text Text
  4179. * @param int $maxlinesize Largeur de ligne en caracteres (ou 0 si pas de limite - defaut)
  4180. * @param string $charset Give the charset used to encode the $text variable in memory.
  4181. * @return int Number of lines
  4182. * @see dol_nboflines, dolGetFirstLineOfText
  4183. */
  4184. function dol_nboflines_bis($text,$maxlinesize=0,$charset='UTF-8')
  4185. {
  4186. $repTable = array("\t" => " ", "\n" => "<br>", "\r" => " ", "\0" => " ", "\x0B" => " ");
  4187. if (dol_textishtml($text)) $repTable = array("\t" => " ", "\n" => " ", "\r" => " ", "\0" => " ", "\x0B" => " ");
  4188. $text = strtr($text, $repTable);
  4189. if ($charset == 'UTF-8') { $pattern = '/(<br[^>]*>)/Uu'; } // /U is to have UNGREEDY regex to limit to one html tag. /u is for UTF8 support
  4190. else $pattern = '/(<br[^>]*>)/U'; // /U is to have UNGREEDY regex to limit to one html tag.
  4191. $a = preg_split($pattern, $text, -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);
  4192. $nblines = (int) floor((count($a)+1)/2);
  4193. // count possible auto line breaks
  4194. if($maxlinesize)
  4195. {
  4196. foreach ($a as $line)
  4197. {
  4198. if (dol_strlen($line)>$maxlinesize)
  4199. {
  4200. //$line_dec = html_entity_decode(strip_tags($line));
  4201. $line_dec = html_entity_decode($line);
  4202. if(dol_strlen($line_dec)>$maxlinesize)
  4203. {
  4204. $line_dec=wordwrap($line_dec,$maxlinesize,'\n',true);
  4205. $nblines+=substr_count($line_dec,'\n');
  4206. }
  4207. }
  4208. }
  4209. }
  4210. return $nblines;
  4211. }
  4212. /**
  4213. * Same function than microtime in PHP 5 but compatible with PHP4
  4214. *
  4215. * @return float Time (millisecondes) with microsecondes in decimal part
  4216. * @deprecated Dolibarr does not support PHP4, you should use native function
  4217. * @see microtime()
  4218. */
  4219. function dol_microtime_float()
  4220. {
  4221. dol_syslog(__FUNCTION__ . " is deprecated", LOG_WARNING);
  4222. return microtime(true);
  4223. }
  4224. /**
  4225. * Return if a text is a html content
  4226. *
  4227. * @param string $msg Content to check
  4228. * @param int $option 0=Full detection, 1=Fast check
  4229. * @return boolean true/false
  4230. * @see dol_concatdesc
  4231. */
  4232. function dol_textishtml($msg,$option=0)
  4233. {
  4234. if ($option == 1)
  4235. {
  4236. if (preg_match('/<html/i',$msg)) return true;
  4237. elseif (preg_match('/<body/i',$msg)) return true;
  4238. elseif (preg_match('/<br/i',$msg)) return true;
  4239. return false;
  4240. }
  4241. else
  4242. {
  4243. if (preg_match('/<html/i',$msg)) return true;
  4244. elseif (preg_match('/<body/i',$msg)) return true;
  4245. elseif (preg_match('/<(b|em|i|u)>/i',$msg)) return true;
  4246. elseif (preg_match('/<(br|div|font|li|p|span|strong|table)>/i',$msg)) return true;
  4247. elseif (preg_match('/<(br|div|font|li|p|span|strong|table)\s+[^<>\/]*>/i',$msg)) return true;
  4248. elseif (preg_match('/<(br|div|font|li|p|span|strong|table)\s+[^<>\/]*\/>/i',$msg)) return true;
  4249. elseif (preg_match('/<img\s+[^<>]*src[^<>]*>/i',$msg)) return true; // must accept <img src="http://example.com/aaa.png" />
  4250. elseif (preg_match('/<a\s+[^<>]*href[^<>]*>/i',$msg)) return true; // must accept <a href="http://example.com/aaa.png" />
  4251. elseif (preg_match('/<h[0-9]>/i',$msg)) return true;
  4252. elseif (preg_match('/&[A-Z0-9]{1,6};/i',$msg)) return true; // Html entities names (http://www.w3schools.com/tags/ref_entities.asp)
  4253. elseif (preg_match('/&#[0-9]{2,3};/i',$msg)) return true; // Html entities numbers (http://www.w3schools.com/tags/ref_entities.asp)
  4254. return false;
  4255. }
  4256. }
  4257. /**
  4258. * Concat 2 descriptions with a new line between them (second operand after first one with appropriate new line separator)
  4259. * text1 html + text2 html => text1 + '<br>' + text2
  4260. * text1 html + text2 txt => text1 + '<br>' + dol_nl2br(text2)
  4261. * text1 txt + text2 html => dol_nl2br(text1) + '<br>' + text2
  4262. * text1 txt + text2 txt => text1 + '\n' + text2
  4263. *
  4264. * @param string $text1 Text 1
  4265. * @param string $text2 Text 2
  4266. * @param bool $forxml false=Use <br>, true=Use <br />
  4267. * @return string Text 1 + new line + Text2
  4268. * @see dol_textishtml
  4269. */
  4270. function dol_concatdesc($text1,$text2,$forxml=false)
  4271. {
  4272. $ret='';
  4273. $ret.= (! dol_textishtml($text1) && dol_textishtml($text2))?dol_nl2br($text1, 0, $forxml):$text1;
  4274. $ret.= (! empty($text1) && ! empty($text2)) ? ((dol_textishtml($text1) || dol_textishtml($text2))?($forxml?"<br \>\n":"<br>\n") : "\n") : "";
  4275. $ret.= (dol_textishtml($text1) && ! dol_textishtml($text2))?dol_nl2br($text2, 0, $forxml):$text2;
  4276. return $ret;
  4277. }
  4278. /**
  4279. * Make substition into a string replacing key with vals from $substitutionarray (oldval=>newval)
  4280. *
  4281. * @param string $chaine Source string in which we must do substitution
  4282. * @param array $substitutionarray Array with key->val to substitute
  4283. * @return string Output string after subsitutions
  4284. * @see complete_substitutions_array
  4285. */
  4286. function make_substitutions($chaine,$substitutionarray)
  4287. {
  4288. global $conf;
  4289. if (! is_array($substitutionarray)) return 'ErrorBadParameterSubstitutionArrayWhenCalling_make_substitutions';
  4290. // Make substitition
  4291. foreach ($substitutionarray as $key => $value)
  4292. {
  4293. if ($key == '__SIGNATURE__' && (! empty($conf->global->MAIN_MAIL_DO_NOT_USE_SIGN))) $value='';
  4294. $chaine=str_replace("$key","$value",$chaine); // We must keep the " to work when value is 123.5 for example
  4295. }
  4296. return $chaine;
  4297. }
  4298. /**
  4299. * Complete the $substitutionarray with more entries
  4300. *
  4301. * @param array $substitutionarray Array substitution old value => new value value
  4302. * @param Translate $outputlangs If we want substitution from special constants, we provide a language
  4303. * @param object $object If we want substitution from special constants, we provide data in a source object
  4304. * @param Mixed $parameters Add more parameters (useful to pass product lines)
  4305. * @param string $callfunc What is the name of the custom function that will be called? (default: completesubstitutionarray)
  4306. * @return void
  4307. * @see make_substitutions
  4308. */
  4309. function complete_substitutions_array(&$substitutionarray,$outputlangs,$object='',$parameters=null,$callfunc="completesubstitutionarray")
  4310. {
  4311. global $conf,$user;
  4312. require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
  4313. // Check if there is external substitution to do asked by plugins
  4314. $dirsubstitutions=array_merge(array(),(array) $conf->modules_parts['substitutions']);
  4315. foreach($dirsubstitutions as $reldir)
  4316. {
  4317. $dir=dol_buildpath($reldir,0);
  4318. // Check if directory exists
  4319. if (! dol_is_dir($dir)) continue;
  4320. $substitfiles=dol_dir_list($dir,'files',0,'functions_');
  4321. foreach($substitfiles as $substitfile)
  4322. {
  4323. if (preg_match('/functions_(.*)\.lib\.php/i',$substitfile['name'],$reg))
  4324. {
  4325. $module=$reg[1];
  4326. dol_syslog("Library functions_".$substitfile['name']." found into ".$dir);
  4327. // Include the user's functions file
  4328. require_once $dir.$substitfile['name'];
  4329. // Call the user's function, and only if it is defined
  4330. $function_name=$module."_".$callfunc;
  4331. if (function_exists($function_name)) $function_name($substitutionarray,$outputlangs,$object,$parameters);
  4332. }
  4333. }
  4334. }
  4335. }
  4336. /**
  4337. * Format output for start and end date
  4338. *
  4339. * @param int $date_start Start date
  4340. * @param int $date_end End date
  4341. * @param string $format Output format
  4342. * @param Translate $outputlangs Output language
  4343. * @return void
  4344. */
  4345. function print_date_range($date_start,$date_end,$format = '',$outputlangs='')
  4346. {
  4347. print get_date_range($date_start,$date_end,$format,$outputlangs);
  4348. }
  4349. /**
  4350. * Format output for start and end date
  4351. *
  4352. * @param int $date_start Start date
  4353. * @param int $date_end End date
  4354. * @param string $format Output format
  4355. * @param Translate $outputlangs Output language
  4356. * @param integer $withparenthesis 1=Add parenthesis, 0=non parenthesis
  4357. * @return string String
  4358. */
  4359. function get_date_range($date_start,$date_end,$format = '',$outputlangs='', $withparenthesis=1)
  4360. {
  4361. global $langs;
  4362. $out='';
  4363. if (! is_object($outputlangs)) $outputlangs=$langs;
  4364. if ($date_start && $date_end)
  4365. {
  4366. $out.= ($withparenthesis?' (':'').$outputlangs->transnoentitiesnoconv('DateFromTo',dol_print_date($date_start, $format, false, $outputlangs),dol_print_date($date_end, $format, false, $outputlangs)).($withparenthesis?')':'');
  4367. }
  4368. if ($date_start && ! $date_end)
  4369. {
  4370. $out.= ($withparenthesis?' (':'').$outputlangs->transnoentitiesnoconv('DateFrom',dol_print_date($date_start, $format, false, $outputlangs)).($withparenthesis?')':'');
  4371. }
  4372. if (! $date_start && $date_end)
  4373. {
  4374. $out.= ($withparenthesis?' (':'').$outputlangs->transnoentitiesnoconv('DateUntil',dol_print_date($date_end, $format, false, $outputlangs)).($withparenthesis?')':'');
  4375. }
  4376. return $out;
  4377. }
  4378. /**
  4379. * Return firstname and lastname in correct order
  4380. *
  4381. * @param string $firstname Firstname
  4382. * @param string $lastname Lastname
  4383. * @param int $nameorder -1=Auto, 0=Lastname+Firstname, 1=Firstname+Lastname, 2=Firstname
  4384. * @return string Firstname + lastname or Lastname + firstname
  4385. */
  4386. function dolGetFirstLastname($firstname,$lastname,$nameorder=-1)
  4387. {
  4388. global $conf;
  4389. $ret='';
  4390. // If order not defined, we use the setup
  4391. if ($nameorder < 0) $nameorder=(empty($conf->global->MAIN_FIRSTNAME_NAME_POSITION));
  4392. if ($nameorder && ((string) $nameorder != '2'))
  4393. {
  4394. $ret.=$firstname;
  4395. if ($firstname && $lastname) $ret.=' ';
  4396. $ret.=$lastname;
  4397. }
  4398. else if ($nameorder == 2)
  4399. {
  4400. $ret.=$firstname;
  4401. }
  4402. else
  4403. {
  4404. $ret.=$lastname;
  4405. if ($firstname && $lastname) $ret.=' ';
  4406. $ret.=$firstname;
  4407. }
  4408. return $ret;
  4409. }
  4410. /**
  4411. * Set event message in dol_events session object. Will be output by calling dol_htmloutput_events.
  4412. * Note: Calling dol_htmloutput_events is done into pages by standard llxFooter() function.
  4413. * Note: Prefer to use setEventMessages instead.
  4414. *
  4415. * @param mixed $mesgs Message string or array
  4416. * @param string $style Which style to use ('mesgs' by default, 'warnings', 'errors')
  4417. * @return void
  4418. * @see dol_htmloutput_events
  4419. */
  4420. function setEventMessage($mesgs, $style='mesgs')
  4421. {
  4422. //dol_syslog(__FUNCTION__ . " is deprecated", LOG_WARNING); This is not deprecated, it is used by setEventMessages function
  4423. if (! is_array($mesgs)) // If mesgs is a string
  4424. {
  4425. if ($mesgs) $_SESSION['dol_events'][$style][] = $mesgs;
  4426. }
  4427. else // If mesgs is an array
  4428. {
  4429. foreach($mesgs as $mesg)
  4430. {
  4431. if ($mesg) $_SESSION['dol_events'][$style][] = $mesg;
  4432. }
  4433. }
  4434. }
  4435. /**
  4436. * Set event messages in dol_events session object. Will be output by calling dol_htmloutput_events.
  4437. * Note: Calling dol_htmloutput_events is done into pages by standard llxFooter() function.
  4438. *
  4439. * @param string $mesg Message string
  4440. * @param array $mesgs Message array
  4441. * @param string $style Which style to use ('mesgs' by default, 'warnings', 'errors')
  4442. * @return void
  4443. * @see dol_htmloutput_events
  4444. */
  4445. function setEventMessages($mesg, $mesgs, $style='mesgs')
  4446. {
  4447. if (! in_array((string) $style, array('mesgs','warnings','errors'))) dol_print_error('','Bad parameter style='.$style.' for setEventMessages');
  4448. if (empty($mesgs)) setEventMessage($mesg, $style);
  4449. else
  4450. {
  4451. if (! empty($mesg) && ! in_array($mesg, $mesgs)) setEventMessage($mesg, $style); // Add message string if not already into array
  4452. setEventMessage($mesgs, $style);
  4453. }
  4454. }
  4455. /**
  4456. * Print formated messages to output (Used to show messages on html output).
  4457. * Note: Calling dol_htmloutput_events is done into pages by standard llxFooter() function, so there is
  4458. * no need to call it explicitely.
  4459. *
  4460. * @return void
  4461. * @see dol_htmloutput_mesg
  4462. */
  4463. function dol_htmloutput_events()
  4464. {
  4465. // Show mesgs
  4466. if (isset($_SESSION['dol_events']['mesgs'])) {
  4467. dol_htmloutput_mesg('', $_SESSION['dol_events']['mesgs']);
  4468. unset($_SESSION['dol_events']['mesgs']);
  4469. }
  4470. // Show errors
  4471. if (isset($_SESSION['dol_events']['errors'])) {
  4472. dol_htmloutput_mesg('', $_SESSION['dol_events']['errors'], 'error');
  4473. unset($_SESSION['dol_events']['errors']);
  4474. }
  4475. // Show warnings
  4476. if (isset($_SESSION['dol_events']['warnings'])) {
  4477. dol_htmloutput_mesg('', $_SESSION['dol_events']['warnings'], 'warning');
  4478. unset($_SESSION['dol_events']['warnings']);
  4479. }
  4480. }
  4481. /**
  4482. * Get formated messages to output (Used to show messages on html output).
  4483. * This include also the translation of the message key.
  4484. *
  4485. * @param string $mesgstring Message string or message key
  4486. * @param string[] $mesgarray Array of message strings or message keys
  4487. * @param string $style Style of message output ('ok' or 'error')
  4488. * @param int $keepembedded Set to 1 in error message must be kept embedded into its html place (this disable jnotify)
  4489. * @return string Return html output
  4490. *
  4491. * @see dol_print_error
  4492. * @see dol_htmloutput_errors
  4493. * @see setEventMessages
  4494. */
  4495. function get_htmloutput_mesg($mesgstring='',$mesgarray='', $style='ok', $keepembedded=0)
  4496. {
  4497. global $conf, $langs;
  4498. $ret='';
  4499. $out='';
  4500. $divstart=$divend='';
  4501. // If inline message with no format, we add it.
  4502. if ((empty($conf->use_javascript_ajax) || ! empty($conf->global->MAIN_DISABLE_JQUERY_JNOTIFY) || $keepembedded) && ! preg_match('/<div class=".*">/i',$out))
  4503. {
  4504. $divstart='<div class="'.$style.'">';
  4505. $divend='</div>';
  4506. }
  4507. if ((is_array($mesgarray) && count($mesgarray)) || $mesgstring)
  4508. {
  4509. $langs->load("errors");
  4510. $out.=$divstart;
  4511. if (is_array($mesgarray) && count($mesgarray))
  4512. {
  4513. foreach($mesgarray as $message)
  4514. {
  4515. $ret++;
  4516. $out.= $langs->trans($message);
  4517. if ($ret < count($mesgarray)) $out.= "<br>\n";
  4518. }
  4519. }
  4520. if ($mesgstring)
  4521. {
  4522. $langs->load("errors");
  4523. $ret++;
  4524. $out.= $langs->trans($mesgstring);
  4525. }
  4526. $out.=$divend;
  4527. }
  4528. if ($out)
  4529. {
  4530. if (! empty($conf->use_javascript_ajax) && empty($conf->global->MAIN_DISABLE_JQUERY_JNOTIFY) && empty($keepembedded))
  4531. {
  4532. $return = '<script type="text/javascript">
  4533. $(document).ready(function() {
  4534. var block = '.(! empty($conf->global->MAIN_USE_JQUERY_BLOCKUI)?"true":"false").'
  4535. if (block) {
  4536. $.dolEventValid("","'.dol_escape_js($out).'");
  4537. } else {
  4538. /* jnotify(message, preset of message type, keepmessage) */
  4539. $.jnotify("'.dol_escape_js($out).'",
  4540. "'.($style=="ok" ? 3000 : $style).'",
  4541. '.($style=="ok" ? "false" : "true").',
  4542. { remove: function (){} } );
  4543. }
  4544. });
  4545. </script>';
  4546. }
  4547. else
  4548. {
  4549. $return = $out;
  4550. }
  4551. }
  4552. return $return;
  4553. }
  4554. /**
  4555. * Get formated error messages to output (Used to show messages on html output).
  4556. *
  4557. * @param string $mesgstring Error message
  4558. * @param array $mesgarray Error messages array
  4559. * @param int $keepembedded Set to 1 in error message must be kept embedded into its html place (this disable jnotify)
  4560. * @return string Return html output
  4561. *
  4562. * @see dol_print_error
  4563. * @see dol_htmloutput_mesg
  4564. */
  4565. function get_htmloutput_errors($mesgstring='', $mesgarray='', $keepembedded=0)
  4566. {
  4567. return get_htmloutput_mesg($mesgstring, $mesgarray,'error',$keepembedded);
  4568. }
  4569. /**
  4570. * Print formated messages to output (Used to show messages on html output).
  4571. *
  4572. * @param string $mesgstring Message string or message key
  4573. * @param string[] $mesgarray Array of message strings or message keys
  4574. * @param string $style Which style to use ('ok', 'warning', 'error')
  4575. * @param int $keepembedded Set to 1 if message must be kept embedded into its html place (this disable jnotify)
  4576. * @return void
  4577. *
  4578. * @see dol_print_error
  4579. * @see dol_htmloutput_errors
  4580. * @see setEventMessages
  4581. */
  4582. function dol_htmloutput_mesg($mesgstring='',$mesgarray='', $style='ok', $keepembedded=0)
  4583. {
  4584. if (empty($mesgstring) && (! is_array($mesgarray) || count($mesgarray) == 0)) return;
  4585. $iserror=0;
  4586. $iswarning=0;
  4587. if (is_array($mesgarray))
  4588. {
  4589. foreach($mesgarray as $val)
  4590. {
  4591. if ($val && preg_match('/class="error"/i',$val)) { $iserror++; break; }
  4592. if ($val && preg_match('/class="warning"/i',$val)) { $iswarning++; break; }
  4593. }
  4594. }
  4595. else if ($mesgstring && preg_match('/class="error"/i',$mesgstring)) $iserror++;
  4596. else if ($mesgstring && preg_match('/class="warning"/i',$mesgstring)) $iswarning++;
  4597. if ($style=='error') $iserror++;
  4598. if ($style=='warning') $iswarning++;
  4599. if ($iserror || $iswarning)
  4600. {
  4601. // Remove div from texts
  4602. $mesgstring=preg_replace('/<\/div><div class="(error|warning)">/','<br>',$mesgstring);
  4603. $mesgstring=preg_replace('/<div class="(error|warning)">/','',$mesgstring);
  4604. $mesgstring=preg_replace('/<\/div>/','',$mesgstring);
  4605. // Remove div from texts array
  4606. if (is_array($mesgarray))
  4607. {
  4608. $newmesgarray=array();
  4609. foreach($mesgarray as $val)
  4610. {
  4611. $tmpmesgstring=preg_replace('/<\/div><div class="(error|warning)">/','<br>',$val);
  4612. $tmpmesgstring=preg_replace('/<div class="(error|warning)">/','',$tmpmesgstring);
  4613. $tmpmesgstring=preg_replace('/<\/div>/','',$tmpmesgstring);
  4614. $newmesgarray[]=$tmpmesgstring;
  4615. }
  4616. $mesgarray=$newmesgarray;
  4617. }
  4618. print get_htmloutput_mesg($mesgstring,$mesgarray,($iserror?'error':'warning'),$keepembedded);
  4619. }
  4620. else print get_htmloutput_mesg($mesgstring,$mesgarray,'ok',$keepembedded);
  4621. }
  4622. /**
  4623. * Print formated error messages to output (Used to show messages on html output).
  4624. *
  4625. * @param string $mesgstring Error message
  4626. * @param array $mesgarray Error messages array
  4627. * @param int $keepembedded Set to 1 in error message must be kept embedded into its html place (this disable jnotify)
  4628. * @return void
  4629. *
  4630. * @see dol_print_error
  4631. * @see dol_htmloutput_mesg
  4632. */
  4633. function dol_htmloutput_errors($mesgstring='', $mesgarray='', $keepembedded=0)
  4634. {
  4635. dol_htmloutput_mesg($mesgstring, $mesgarray, 'error', $keepembedded);
  4636. }
  4637. /**
  4638. * Advanced sort array by second index function, which produces ascending (default)
  4639. * or descending output and uses optionally natural case insensitive sorting (which
  4640. * can be optionally case sensitive as well).
  4641. *
  4642. * @param array $array Array to sort (array of array('key','otherkey1','otherkey2'...))
  4643. * @param string $index Key in array to use for sorting criteria
  4644. * @param int $order Sort order ('asc' or 'desc')
  4645. * @param int $natsort 1=use "natural" sort (natsort), 0=use "standard" sort (asort)
  4646. * @param int $case_sensitive 1=sort is case sensitive, 0=not case sensitive
  4647. * @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.
  4648. * @return array Sorted array
  4649. */
  4650. function dol_sort_array(&$array, $index, $order='asc', $natsort=0, $case_sensitive=0, $keepindex=0)
  4651. {
  4652. // Clean parameters
  4653. $order=strtolower($order);
  4654. $sizearray=count($array);
  4655. if (is_array($array) && $sizearray>0)
  4656. {
  4657. foreach(array_keys($array) as $key) $temp[$key]=$array[$key][$index];
  4658. if (!$natsort) ($order=='asc') ? asort($temp) : arsort($temp);
  4659. else
  4660. {
  4661. ($case_sensitive) ? natsort($temp) : natcasesort($temp);
  4662. if($order!='asc') $temp=array_reverse($temp,TRUE);
  4663. }
  4664. $sorted = array();
  4665. foreach(array_keys($temp) as $key)
  4666. {
  4667. (is_numeric($key) && empty($keepindex)) ? $sorted[]=$array[$key] : $sorted[$key]=$array[$key];
  4668. }
  4669. return $sorted;
  4670. }
  4671. return $array;
  4672. }
  4673. /**
  4674. * Check if a string is in UTF8
  4675. *
  4676. * @param string $str String to check
  4677. * @return boolean True if string is UTF8 or ISO compatible with UTF8, False if not (ISO with special char or Binary)
  4678. */
  4679. function utf8_check($str)
  4680. {
  4681. // We must use here a binary strlen function (so not dol_strlen)
  4682. $strLength = dol_strlen($str);
  4683. for ($i=0; $i<$strLength; $i++)
  4684. {
  4685. if (ord($str[$i]) < 0x80) continue; // 0bbbbbbb
  4686. elseif ((ord($str[$i]) & 0xE0) == 0xC0) $n=1; // 110bbbbb
  4687. elseif ((ord($str[$i]) & 0xF0) == 0xE0) $n=2; // 1110bbbb
  4688. elseif ((ord($str[$i]) & 0xF8) == 0xF0) $n=3; // 11110bbb
  4689. elseif ((ord($str[$i]) & 0xFC) == 0xF8) $n=4; // 111110bb
  4690. elseif ((ord($str[$i]) & 0xFE) == 0xFC) $n=5; // 1111110b
  4691. else return false; // Does not match any model
  4692. for ($j=0; $j<$n; $j++) { // n bytes matching 10bbbbbb follow ?
  4693. if ((++$i == strlen($str)) || ((ord($str[$i]) & 0xC0) != 0x80))
  4694. return false;
  4695. }
  4696. }
  4697. return true;
  4698. }
  4699. /**
  4700. * Return a string encoded into OS filesystem encoding. This function is used to define
  4701. * value to pass to filesystem PHP functions.
  4702. *
  4703. * @param string $str String to encode (UTF-8)
  4704. * @return string Encoded string (UTF-8, ISO-8859-1)
  4705. */
  4706. function dol_osencode($str)
  4707. {
  4708. global $conf;
  4709. $tmp=ini_get("unicode.filesystem_encoding"); // Disponible avec PHP 6.0
  4710. if (empty($tmp) && ! empty($_SERVER["WINDIR"])) $tmp='iso-8859-1'; // By default for windows
  4711. if (empty($tmp)) $tmp='utf-8'; // By default for other
  4712. if (! empty($conf->global->MAIN_FILESYSTEM_ENCODING)) $tmp=$conf->global->MAIN_FILESYSTEM_ENCODING;
  4713. if ($tmp == 'iso-8859-1') return utf8_decode($str);
  4714. return $str;
  4715. }
  4716. /**
  4717. * Return an id or code from a code or id.
  4718. * Store also Code-Id into a cache to speed up next request on same key.
  4719. *
  4720. * @param DoliDB $db Database handler
  4721. * @param string $key Code or Id to get Id or Code
  4722. * @param string $tablename Table name without prefix
  4723. * @param string $fieldkey Field for code
  4724. * @param string $fieldid Field for id
  4725. * @return int <0 if KO, Id of code if OK
  4726. * @see $langs->getLabelFromKey
  4727. */
  4728. function dol_getIdFromCode($db,$key,$tablename,$fieldkey='code',$fieldid='id')
  4729. {
  4730. global $cache_codes;
  4731. // If key empty
  4732. if ($key == '') return '';
  4733. // Check in cache
  4734. if (isset($cache_codes[$tablename][$key])) // Can be defined to 0 or ''
  4735. {
  4736. return $cache_codes[$tablename][$key]; // Found in cache
  4737. }
  4738. $sql = "SELECT ".$fieldid." as valuetoget";
  4739. $sql.= " FROM ".MAIN_DB_PREFIX.$tablename;
  4740. $sql.= " WHERE ".$fieldkey." = '".$db->escape($key)."'";
  4741. dol_syslog('dol_getIdFromCode', LOG_DEBUG);
  4742. $resql = $db->query($sql);
  4743. if ($resql)
  4744. {
  4745. $obj = $db->fetch_object($resql);
  4746. if ($obj) $cache_codes[$tablename][$key]=$obj->valuetoget;
  4747. else $cache_codes[$tablename][$key]='';
  4748. $db->free($resql);
  4749. return $cache_codes[$tablename][$key];
  4750. }
  4751. else
  4752. {
  4753. return -1;
  4754. }
  4755. }
  4756. /**
  4757. * Verify if condition in string is ok or not
  4758. *
  4759. * @param string $strRights String with condition to check
  4760. * @return boolean True or False. Return true if strRights is ''
  4761. */
  4762. function verifCond($strRights)
  4763. {
  4764. global $user,$conf,$langs;
  4765. global $leftmenu;
  4766. global $rights; // To export to dol_eval function
  4767. //print $strRights."<br>\n";
  4768. $rights = true;
  4769. if ($strRights != '')
  4770. {
  4771. //$tab_rights = explode('&&', $strRights);
  4772. //$i = 0;
  4773. //while (($i < count($tab_rights)) && ($rights == true)) {
  4774. $str = 'if(!(' . $strRights . ')) { $rights = false; }';
  4775. dol_eval($str);
  4776. // $i++;
  4777. //}
  4778. }
  4779. return $rights;
  4780. }
  4781. /**
  4782. * Replace eval function to add more security.
  4783. * This function is called by verifCond() or trans() and transnoentitiesnoconv().
  4784. *
  4785. * @param string $s String to evaluate
  4786. * @param int $returnvalue 0=No return (used to execute eval($a=something)). 1=Value of eval is returned (used to eval($something)).
  4787. * @return mixed Nothing or return of eval
  4788. */
  4789. function dol_eval($s,$returnvalue=0)
  4790. {
  4791. // Only global variables can be changed by eval function and returned to caller
  4792. global $langs, $user, $conf;
  4793. global $leftmenu;
  4794. global $rights;
  4795. global $object;
  4796. global $soc;
  4797. //print $s."<br>\n";
  4798. if ($returnvalue) return @eval('return '.$s.';');
  4799. else @eval($s);
  4800. }
  4801. /**
  4802. * Return if var element is ok
  4803. *
  4804. * @param string $element Variable to check
  4805. * @return boolean Return true of variable is not empty
  4806. */
  4807. function dol_validElement($element)
  4808. {
  4809. return (trim($element) != '');
  4810. }
  4811. /**
  4812. * Return img flag of country for a language code or country code
  4813. *
  4814. * @param string $codelang Language code (en_IN, fr_CA...) or Country code (IN, FR)
  4815. * @return string HTML img string with flag.
  4816. */
  4817. function picto_from_langcode($codelang)
  4818. {
  4819. global $langs;
  4820. if (empty($codelang)) return '';
  4821. if (empty($codelang)) return '';
  4822. if ($codelang == 'auto')
  4823. {
  4824. return img_picto_common($langs->trans('AutoDetectLang'), 'flags/int.png');
  4825. }
  4826. $langtocountryflag = array(
  4827. 'ar_AR' => '',
  4828. 'ca_ES' => 'catalonia',
  4829. 'da_DA' => 'dk',
  4830. 'fr_CA' => 'mq',
  4831. 'sv_SV' => 'se'
  4832. );
  4833. if (isset($langtocountryflag[$codelang])) $flagImage = $langtocountryflag[$codelang];
  4834. else
  4835. {
  4836. $tmparray = explode('_', $codelang);
  4837. $flagImage = empty($tmparray[1]) ? $tmparray[0] : $tmparray[1];
  4838. }
  4839. return img_picto_common($codelang, 'flags/'.strtolower($flagImage).'.png');
  4840. }
  4841. /**
  4842. * Complete or removed entries into a head array (used to build tabs).
  4843. * For example, with value added by external modules. Such values are declared into $conf->modules_parts['tab'].
  4844. * Or by change using hook completeTabsHead
  4845. *
  4846. * @param Conf $conf Object conf
  4847. * @param Translate $langs Object langs
  4848. * @param object|null $object Object object
  4849. * @param array $head Object head
  4850. * @param int $h New position to fill
  4851. * @param string $type Value for object where objectvalue can be
  4852. * 'thirdparty' to add a tab in third party view
  4853. * 'intervention' to add a tab in intervention view
  4854. * 'supplier_order' to add a tab in supplier order view
  4855. * 'supplier_invoice' to add a tab in supplier invoice view
  4856. * 'invoice' to add a tab in customer invoice view
  4857. * 'order' to add a tab in customer order view
  4858. * 'product' to add a tab in product view
  4859. * 'propal' to add a tab in propal view
  4860. * 'user' to add a tab in user view
  4861. * 'group' to add a tab in group view
  4862. * 'member' to add a tab in fundation member view
  4863. * 'categories_x' to add a tab in category view ('x': type of category (0=product, 1=supplier, 2=customer, 3=member)
  4864. * 'ecm' to add a tab for another ecm view
  4865. * 'stock' to add a tab for warehouse view
  4866. * @param string $mode 'add' to complete head, 'remove' to remove entries
  4867. * @return void
  4868. */
  4869. function complete_head_from_modules($conf,$langs,$object,&$head,&$h,$type,$mode='add')
  4870. {
  4871. global $hookmanager;
  4872. if (isset($conf->modules_parts['tabs'][$type]) && is_array($conf->modules_parts['tabs'][$type]))
  4873. {
  4874. foreach ($conf->modules_parts['tabs'][$type] as $value)
  4875. {
  4876. $values=explode(':',$value);
  4877. if ($mode == 'add' && ! preg_match('/^\-/',$values[1]))
  4878. {
  4879. if (count($values) == 6) // new declaration with permissions: $value='objecttype:+tabname1:Title1:langfile@mymodule:$user->rights->mymodule->read:/mymodule/mynewtab1.php?id=__ID__'
  4880. {
  4881. if ($values[0] != $type) continue;
  4882. if (verifCond($values[4]))
  4883. {
  4884. if ($values[3]) $langs->load($values[3]);
  4885. if (preg_match('/SUBSTITUTION_([^_]+)/i',$values[2],$reg))
  4886. {
  4887. $substitutionarray=array();
  4888. complete_substitutions_array($substitutionarray,$langs,$object,array('needforkey'=>$values[2]));
  4889. $label=make_substitutions($reg[1], $substitutionarray);
  4890. }
  4891. else $label=$langs->trans($values[2]);
  4892. $head[$h][0] = dol_buildpath(preg_replace('/__ID__/i', ((is_object($object) && ! empty($object->id))?$object->id:''), $values[5]), 1);
  4893. $head[$h][1] = $label;
  4894. $head[$h][2] = str_replace('+','',$values[1]);
  4895. $h++;
  4896. }
  4897. }
  4898. else if (count($values) == 5) // deprecated
  4899. {
  4900. dol_syslog('Passing 5 values in tabs module_parts is deprecated. Please update to 6 with permissions.', LOG_WARNING);
  4901. if ($values[0] != $type) continue;
  4902. if ($values[3]) $langs->load($values[3]);
  4903. if (preg_match('/SUBSTITUTION_([^_]+)/i',$values[2],$reg))
  4904. {
  4905. $substitutionarray=array();
  4906. complete_substitutions_array($substitutionarray,$langs,$object,array('needforkey'=>$values[2]));
  4907. $label=make_substitutions($reg[1], $substitutionarray);
  4908. }
  4909. else $label=$langs->trans($values[2]);
  4910. $head[$h][0] = dol_buildpath(preg_replace('/__ID__/i', ((is_object($object) && ! empty($object->id))?$object->id:''), $values[4]), 1);
  4911. $head[$h][1] = $label;
  4912. $head[$h][2] = str_replace('+','',$values[1]);
  4913. $h++;
  4914. }
  4915. }
  4916. else if ($mode == 'remove' && preg_match('/^\-/',$values[1]))
  4917. {
  4918. if ($values[0] != $type) continue;
  4919. $tabname=str_replace('-','',$values[1]);
  4920. foreach($head as $key => $val)
  4921. {
  4922. $condition = (! empty($values[3]) ? verifCond($values[3]) : 1);
  4923. if ($head[$key][2]==$tabname && $condition)
  4924. {
  4925. unset($head[$key]);
  4926. break;
  4927. }
  4928. }
  4929. }
  4930. }
  4931. }
  4932. // No need to make a return $head. Var is modified as a reference
  4933. if (! empty($hookmanager))
  4934. {
  4935. $parameters=array('object' => $object, 'mode' => $mode, 'head'=>$head);
  4936. $reshook=$hookmanager->executeHooks('completeTabsHead',$parameters);
  4937. if ($reshook > 0)
  4938. {
  4939. $head = $hookmanager->resArray;
  4940. }
  4941. }
  4942. }
  4943. /**
  4944. * Print common footer :
  4945. * conf->global->MAIN_HTML_FOOTER
  4946. * conf->global->MAIN_GOOGLE_AN_ID
  4947. * conf->global->MAIN_SHOW_TUNING_INFO or $_SERVER["MAIN_SHOW_TUNING_INFO"]
  4948. * conf->logbuffer
  4949. *
  4950. * @param string $zone 'private' (for private pages) or 'public' (for public pages)
  4951. * @return void
  4952. */
  4953. function printCommonFooter($zone='private')
  4954. {
  4955. global $conf, $hookmanager;
  4956. global $micro_start_time;
  4957. if ($zone == 'private') print "\n".'<!-- Common footer for private page -->'."\n";
  4958. else print "\n".'<!-- Common footer for public page -->'."\n";
  4959. if (! empty($conf->global->MAIN_HTML_FOOTER)) print $conf->global->MAIN_HTML_FOOTER."\n";
  4960. print "\n";
  4961. if (! empty($conf->use_javascript_ajax))
  4962. {
  4963. print '<!-- Reposition management (does not work if a redirect is done after action of submission) -->'."\n";
  4964. print '<script type="text/javascript" language="javascript">jQuery(document).ready(function() {'."\n";
  4965. print '<!-- If page_y set, we set scollbar with it -->'."\n";
  4966. print "page_y=getParameterByName('page_y', 0);";
  4967. print "if (page_y > 0) $('html, body').scrollTop(page_y);\n";
  4968. print '<!-- Set handler to add page_y param on some a href links -->'."\n";
  4969. print 'jQuery(".reposition").click(function() {
  4970. var page_y = $(document).scrollTop();
  4971. /*alert(page_y);*/
  4972. this.href=this.href+\'&page_y=\'+page_y;
  4973. });'."\n";
  4974. print '});'."\n";
  4975. if (empty($conf->dol_use_jmobile))
  4976. {
  4977. print '<!-- Set handler to switch left menu page -->'."\n";
  4978. print 'jQuery(".menuhider").click(function() {';
  4979. print " $('.side-nav').toggle();";
  4980. if ($conf->theme == 'md') print " $('.login_block').toggle();";
  4981. print '});'."\n";
  4982. }
  4983. print '</script>'."\n";
  4984. }
  4985. // Google Analytics (need Google module)
  4986. if (! empty($conf->google->enabled) && ! empty($conf->global->MAIN_GOOGLE_AN_ID))
  4987. {
  4988. if (($conf->dol_use_jmobile != 4))
  4989. {
  4990. print "\n";
  4991. print '<script type="text/javascript">'."\n";
  4992. print ' var _gaq = _gaq || [];'."\n";
  4993. print ' _gaq.push([\'_setAccount\', \''.$conf->global->MAIN_GOOGLE_AN_ID.'\']);'."\n";
  4994. print ' _gaq.push([\'_trackPageview\']);'."\n";
  4995. print ''."\n";
  4996. print ' (function() {'."\n";
  4997. print ' var ga = document.createElement(\'script\'); ga.type = \'text/javascript\'; ga.async = true;'."\n";
  4998. print ' ga.src = (\'https:\' == document.location.protocol ? \'https://ssl\' : \'http://www\') + \'.google-analytics.com/ga.js\';'."\n";
  4999. print ' var s = document.getElementsByTagName(\'script\')[0]; s.parentNode.insertBefore(ga, s);'."\n";
  5000. print ' })();'."\n";
  5001. print '</script>'."\n";
  5002. }
  5003. }
  5004. // End of tuning
  5005. if (! empty($_SERVER['MAIN_SHOW_TUNING_INFO']) || ! empty($conf->global->MAIN_SHOW_TUNING_INFO))
  5006. {
  5007. print "\n".'<script type="text/javascript">'."\n";
  5008. print 'window.console && console.log("';
  5009. if (! empty($conf->global->MEMCACHED_SERVER)) print 'MEMCACHED_SERVER='.$conf->global->MEMCACHED_SERVER.' - ';
  5010. print 'MAIN_OPTIMIZE_SPEED='.(isset($conf->global->MAIN_OPTIMIZE_SPEED)?$conf->global->MAIN_OPTIMIZE_SPEED:'off');
  5011. if (! empty($micro_start_time)) // Works only if MAIN_SHOW_TUNING_INFO is defined at $_SERVER level. Not in global variable.
  5012. {
  5013. $micro_end_time = microtime(true);
  5014. print ' - Build time: '.ceil(1000*($micro_end_time-$micro_start_time)).' ms';
  5015. }
  5016. if (function_exists("memory_get_usage"))
  5017. {
  5018. print ' - Mem: '.memory_get_usage();
  5019. }
  5020. if (function_exists("xdebug_memory_usage"))
  5021. {
  5022. print ' - XDebug time: '.ceil(1000*xdebug_time_index()).' ms';
  5023. print ' - XDebug mem: '.xdebug_memory_usage();
  5024. print ' - XDebug mem peak: '.xdebug_peak_memory_usage();
  5025. }
  5026. if (function_exists("zend_loader_file_encoded"))
  5027. {
  5028. print ' - Zend encoded file: '.(zend_loader_file_encoded()?'yes':'no');
  5029. }
  5030. print '");'."\n";
  5031. print '</script>'."\n";
  5032. // Add Xdebug coverage of code
  5033. if (defined('XDEBUGCOVERAGE'))
  5034. {
  5035. print_r(xdebug_get_code_coverage());
  5036. }
  5037. }
  5038. // If there is some logs in buffer to show
  5039. if (count($conf->logbuffer))
  5040. {
  5041. print "\n";
  5042. print "<!-- Start of log output\n";
  5043. //print '<div class="hidden">'."\n";
  5044. foreach($conf->logbuffer as $logline)
  5045. {
  5046. print $logline."<br>\n";
  5047. }
  5048. //print '</div>'."\n";
  5049. print "End of log output -->\n";
  5050. }
  5051. $parameters=array();
  5052. $reshook=$hookmanager->executeHooks('printCommonFooter',$parameters); // Note that $action and $object may have been modified by some hooks
  5053. }
  5054. /**
  5055. * Split a string with 2 keys into key array.
  5056. * For example: "A=1;B=2;C=2" is exploded into array('A'=>1,'B'=>2,'C'=>3)
  5057. *
  5058. * @param string $string String to explode
  5059. * @param string $delimiter Delimiter between each couple of data
  5060. * @param string $kv Delimiter between key and value
  5061. * @return array Array of data exploded
  5062. */
  5063. function dolExplodeIntoArray($string, $delimiter = ';', $kv = '=')
  5064. {
  5065. if ($a = explode($delimiter, $string))
  5066. {
  5067. foreach ($a as $s) { // each part
  5068. if ($s) {
  5069. if ($pos = strpos($s, $kv)) { // key/value delimiter
  5070. $ka[trim(substr($s, 0, $pos))] = trim(substr($s, $pos + strlen($kv)));
  5071. } else { // key delimiter not found
  5072. $ka[] = trim($s);
  5073. }
  5074. }
  5075. }
  5076. return $ka;
  5077. }
  5078. return array();
  5079. }
  5080. /**
  5081. * Set focus onto field with selector
  5082. *
  5083. * @param string $selector Selector ('#id')
  5084. * @return string HTML code to set focus
  5085. */
  5086. function dol_set_focus($selector)
  5087. {
  5088. print '<!-- Set focus onto a specific field -->'."\n";
  5089. print '<script type="text/javascript" language="javascript">jQuery(document).ready(function() { jQuery("'.$selector.'").focus(); });</script>'."\n";
  5090. }
  5091. /**
  5092. * Return getmypid() or random PID when function is disabled
  5093. * Some web hosts disable this php function for security reasons
  5094. * and sometimes we can't redeclare function
  5095. *
  5096. * @return int
  5097. */
  5098. function dol_getmypid()
  5099. {
  5100. if (! function_exists('getmypid')) {
  5101. return mt_rand(1,32768);
  5102. } else {
  5103. return getmypid();
  5104. }
  5105. }
  5106. /**
  5107. * Generate natural SQL search string for a criteria (this criteria can be tested on one or several fields)
  5108. *
  5109. * @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)
  5110. * @param string $value The value to look for.
  5111. * If param $mode is 0, can contains several keywords separated with a space or |
  5112. * like "keyword1 keyword2" = We want record field like keyword1 AND field like keyword2
  5113. * or like "keyword1|keyword2" = We want record field like keyword1 OR field like keyword2
  5114. * If param $mode is 1, can contains an operator <, > or = like "<10" or ">=100.5 < 1000"
  5115. * If param $mode is 2, can contains a list of id separated by comma like "1,3,4"
  5116. * @param integer $mode 0=value is list of keywords, 1=value is a numeric test (Example ">5.5 <10"), 2=value is a list of id separated with comma (Example '1,3,4')
  5117. * @param integer $nofirstand 1=Do not output the first 'AND'
  5118. * @return string $res The statement to append to the SQL query
  5119. */
  5120. function natural_search($fields, $value, $mode=0, $nofirstand=0)
  5121. {
  5122. global $db,$langs;
  5123. if ($mode == 0)
  5124. {
  5125. $value=preg_replace('/\*/','%',$value); // Replace * with %
  5126. }
  5127. if ($mode == 1)
  5128. {
  5129. $value=preg_replace('/([<>=]+)\s+([0-9'.preg_quote($langs->trans("DecimalSeparator"),'/').'\-])/','\1\2',$value); // Clean string '< 10' into '<10' so we can the explode on space to get all tests to do
  5130. }
  5131. $value = preg_replace('/\s*\|\s*/','|', $value);
  5132. $crits = explode(' ', $value);
  5133. $res = '';
  5134. if (! is_array($fields)) $fields = array($fields);
  5135. $nboffields = count($fields);
  5136. $end2 = count($crits);
  5137. $j = 0;
  5138. foreach ($crits as $crit)
  5139. {
  5140. $i = 0; $i2 = 0;
  5141. $newres = '';
  5142. foreach ($fields as $field)
  5143. {
  5144. if ($mode == 1)
  5145. {
  5146. $operator='=';
  5147. $newcrit = preg_replace('/([<>=]+)/','',trim($crit));
  5148. preg_match('/([<>=]+)/',trim($crit), $reg);
  5149. if ($reg[1])
  5150. {
  5151. $operator = $reg[1];
  5152. }
  5153. if ($newcrit != '')
  5154. {
  5155. $numnewcrit = price2num($newcrit);
  5156. if (is_numeric($numnewcrit))
  5157. {
  5158. $newres .= ($i2 > 0 ? ' OR ' : '') . $field . ' '.$operator.' '.$numnewcrit;
  5159. }
  5160. else
  5161. {
  5162. $newres .= ($i2 > 0 ? ' OR ' : '') . '1 = 2'; // force false
  5163. }
  5164. $i2++; // a criteria was added to string
  5165. }
  5166. }
  5167. else if ($mode == 2)
  5168. {
  5169. $newres .= ($i2 > 0 ? ' OR ' : '') . $field . " IN (" . $db->escape(trim($crit)) . ")";
  5170. $i2++; // a criteria was added to string
  5171. }
  5172. else // $mode=0
  5173. {
  5174. $textcrit = '';
  5175. $tmpcrits = explode('|',$crit);
  5176. $i3 = 0;
  5177. foreach($tmpcrits as $tmpcrit)
  5178. {
  5179. $newres .= (($i2 > 0 || $i3 > 0) ? ' OR ' : '') . $field . " LIKE '";
  5180. $tmpcrit=trim($tmpcrit);
  5181. $tmpcrit2=$tmpcrit;
  5182. $tmpbefore='%'; $tmpafter='%';
  5183. if (preg_match('/^[\^\$]/', $tmpcrit))
  5184. {
  5185. $tmpbefore='';
  5186. $tmpcrit2 = preg_replace('/^[\^\$]/', '', $tmpcrit2);
  5187. }
  5188. if (preg_match('/[\^\$]$/', $tmpcrit))
  5189. {
  5190. $tmpafter='';
  5191. $tmpcrit2 = preg_replace('/[\^\$]$/', '', $tmpcrit2);
  5192. }
  5193. $newres .= $tmpbefore;
  5194. $newres .= $db->escape($tmpcrit2);
  5195. $newres .= $tmpafter;
  5196. $newres .= "'";
  5197. if (empty($tmpcrit2))
  5198. {
  5199. $newres .= ' OR ' . $field . " IS NULL";
  5200. }
  5201. $i3++;
  5202. }
  5203. $i2++; // a criteria was added to string
  5204. }
  5205. $i++;
  5206. }
  5207. if ($newres) $res = $res . ($res ? ' AND ' : '') . ($i2 > 1 ? '(' : '') .$newres . ($i2 > 1 ? ')' : '');
  5208. $j++;
  5209. }
  5210. $res = ($nofirstand?"":" AND ")."(" . $res . ")";
  5211. //print 'xx'.$res.'yy';
  5212. return $res;
  5213. }
  5214. /**
  5215. * Return the filename of file to get the thumbs
  5216. *
  5217. * @param string $file Original filename (full or relative path)
  5218. * @param string $extName Extension to differenciate thumb file name ('', '_small', '_mini')
  5219. * @param string $extImgTarget Force image extension for thumbs. Use '' to keep same extension than original image (default).
  5220. * @return string New file name (full or relative path, including the thumbs/)
  5221. */
  5222. function getImageFileNameForSize($file, $extName, $extImgTarget='')
  5223. {
  5224. $dirName = dirname($file);
  5225. if ($dirName == '.') $dirName='';
  5226. $fileName = preg_replace('/(\.gif|\.jpeg|\.jpg|\.png|\.bmp)$/i','',$file); // We remove extension, whatever is its case
  5227. $fileName = basename($fileName);
  5228. if (empty($extImgTarget)) $extImgTarget = (preg_match('/\.jpg$/i',$file)?'.jpg':'');
  5229. if (empty($extImgTarget)) $extImgTarget = (preg_match('/\.jpeg$/i',$file)?'.jpeg':'');
  5230. if (empty($extImgTarget)) $extImgTarget = (preg_match('/\.gif$/i',$file)?'.gif':'');
  5231. if (empty($extImgTarget)) $extImgTarget = (preg_match('/\.png$/i',$file)?'.png':'');
  5232. if (empty($extImgTarget)) $extImgTarget = (preg_match('/\.bmp$/i',$file)?'.bmp':'');
  5233. if (! $extImgTarget) return $file;
  5234. $subdir='';
  5235. if ($extName) $subdir = 'thumbs/';
  5236. return ($dirName?$dirName.'/':'').$subdir.$fileName.$extName.$extImgTarget; // New filename for thumb
  5237. }
  5238. /**
  5239. * Return URL we can use for advanced preview links
  5240. *
  5241. * @param string $modulepart propal, facture, facture_fourn, ...
  5242. * @param string $relativepath Relative path of docs
  5243. * @param string $param More param on http links
  5244. * @return string Output string with HTML
  5245. */
  5246. function getAdvancedPreviewUrl($modulepart, $relativepath, $param='')
  5247. {
  5248. global $conf;
  5249. if (empty($conf->use_javascript_ajax)) return '';
  5250. $mime_preview = array('bmp', 'jpeg', 'png', 'gif', 'tiff', 'pdf', 'plain', 'css');
  5251. //$mime_preview[]='vnd.oasis.opendocument.presentation';
  5252. //$mime_preview[]='archive';
  5253. $num_mime = array_search(dol_mimetype($relativepath, '', 1), $mime_preview);
  5254. if ($num_mime !== false) return 'javascript:document_preview(\''.dol_escape_js(DOL_URL_ROOT.'/document.php?modulepart='.$modulepart.'&amp;attachment=0&amp;file='.$relativepath.($param?'&amp;'.$param:'')).'\', \''.dol_mimetype($relativepath).'\', \''.dol_escape_js('Preview').'\')';
  5255. else return '';
  5256. }
  5257. /**
  5258. * Return mime type of a file
  5259. *
  5260. * @param string $file Filename we looking for MIME type
  5261. * @param string $default Default mime type if extension not found in known list
  5262. * @param int $mode 0=Return full mime, 1=otherwise short mime string, 2=image for mime type, 3=source language
  5263. * @return string Return a mime type family (text/xxx, application/xxx, image/xxx, audio, video, archive)
  5264. * @see image_format_supported (images.lib.php)
  5265. */
  5266. function dol_mimetype($file,$default='application/octet-stream',$mode=0)
  5267. {
  5268. $mime=$default;
  5269. $imgmime='other.png';
  5270. $srclang='';
  5271. $tmpfile=preg_replace('/\.noexe$/','',$file);
  5272. // Text files
  5273. if (preg_match('/\.txt$/i',$tmpfile)) { $mime='text/plain'; $imgmime='text.png'; }
  5274. if (preg_match('/\.rtx$/i',$tmpfile)) { $mime='text/richtext'; $imgmime='text.png'; }
  5275. if (preg_match('/\.csv$/i',$tmpfile)) { $mime='text/csv'; $imgmime='text.png'; }
  5276. if (preg_match('/\.tsv$/i',$tmpfile)) { $mime='text/tab-separated-values'; $imgmime='text.png'; }
  5277. if (preg_match('/\.(cf|conf|log)$/i',$tmpfile)) { $mime='text/plain'; $imgmime='text.png'; }
  5278. if (preg_match('/\.ini$/i',$tmpfile)) { $mime='text/plain'; $imgmime='text.png'; $srclang='ini'; }
  5279. if (preg_match('/\.css$/i',$tmpfile)) { $mime='text/css'; $imgmime='css.png'; $srclang='css'; }
  5280. // Certificate files
  5281. if (preg_match('/\.(crt|cer|key|pub)$/i',$tmpfile)) { $mime='text/plain'; $imgmime='text.png'; }
  5282. // HTML/XML
  5283. if (preg_match('/\.(html|htm|shtml)$/i',$tmpfile)) { $mime='text/html'; $imgmime='html.png'; $srclang='html'; }
  5284. if (preg_match('/\.(xml|xhtml)$/i',$tmpfile)) { $mime='text/xml'; $imgmime='other.png'; $srclang='xml'; }
  5285. // Languages
  5286. if (preg_match('/\.bas$/i',$tmpfile)) { $mime='text/plain'; $imgmime='text.png'; $srclang='bas'; }
  5287. if (preg_match('/\.(c)$/i',$tmpfile)) { $mime='text/plain'; $imgmime='text.png'; $srclang='c'; }
  5288. if (preg_match('/\.(cpp)$/i',$tmpfile)) { $mime='text/plain'; $imgmime='text.png'; $srclang='cpp'; }
  5289. if (preg_match('/\.(h)$/i',$tmpfile)) { $mime='text/plain'; $imgmime='text.png'; $srclang='h'; }
  5290. if (preg_match('/\.(java|jsp)$/i',$tmpfile)) { $mime='text/plain'; $imgmime='text.png'; $srclang='java'; }
  5291. if (preg_match('/\.php([0-9]{1})?$/i',$tmpfile)) { $mime='text/plain'; $imgmime='php.png'; $srclang='php'; }
  5292. if (preg_match('/\.phtml$/i',$tmpfile)) { $mime='text/plain'; $imgmime='php.png'; $srclang='php'; }
  5293. if (preg_match('/\.(pl|pm)$/i',$tmpfile)) { $mime='text/plain'; $imgmime='pl.png'; $srclang='perl'; }
  5294. if (preg_match('/\.sql$/i',$tmpfile)) { $mime='text/plain'; $imgmime='text.png'; $srclang='sql'; }
  5295. if (preg_match('/\.js$/i',$tmpfile)) { $mime='text/x-javascript'; $imgmime='jscript.png'; $srclang='js'; }
  5296. // Open office
  5297. if (preg_match('/\.odp$/i',$tmpfile)) { $mime='application/vnd.oasis.opendocument.presentation'; $imgmime='ooffice.png'; }
  5298. if (preg_match('/\.ods$/i',$tmpfile)) { $mime='application/vnd.oasis.opendocument.spreadsheet'; $imgmime='ooffice.png'; }
  5299. if (preg_match('/\.odt$/i',$tmpfile)) { $mime='application/vnd.oasis.opendocument.text'; $imgmime='ooffice.png'; }
  5300. // MS Office
  5301. if (preg_match('/\.mdb$/i',$tmpfile)) { $mime='application/msaccess'; $imgmime='mdb.png'; }
  5302. if (preg_match('/\.doc(x|m)?$/i',$tmpfile)) { $mime='application/msword'; $imgmime='doc.png'; }
  5303. if (preg_match('/\.dot(x|m)?$/i',$tmpfile)) { $mime='application/msword'; $imgmime='doc.png'; }
  5304. if (preg_match('/\.xlt(x)?$/i',$tmpfile)) { $mime='application/vnd.ms-excel'; $imgmime='xls.png'; }
  5305. if (preg_match('/\.xla(m)?$/i',$tmpfile)) { $mime='application/vnd.ms-excel'; $imgmime='xls.png'; }
  5306. if (preg_match('/\.xls$/i',$tmpfile)) { $mime='application/vnd.ms-excel'; $imgmime='xls.png'; }
  5307. if (preg_match('/\.xls(b|m|x)$/i',$tmpfile)) { $mime='application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'; $imgmime='xls.png'; }
  5308. if (preg_match('/\.pps(m|x)?$/i',$tmpfile)) { $mime='application/vnd.ms-powerpoint'; $imgmime='ppt.png'; }
  5309. if (preg_match('/\.ppt(m|x)?$/i',$tmpfile)) { $mime='application/x-mspowerpoint'; $imgmime='ppt.png'; }
  5310. // Other
  5311. if (preg_match('/\.pdf$/i',$tmpfile)) { $mime='application/pdf'; $imgmime='pdf.png'; }
  5312. // Scripts
  5313. if (preg_match('/\.bat$/i',$tmpfile)) { $mime='text/x-bat'; $imgmime='script.png'; $srclang='dos'; }
  5314. if (preg_match('/\.sh$/i',$tmpfile)) { $mime='text/x-sh'; $imgmime='script.png'; $srclang='bash'; }
  5315. if (preg_match('/\.ksh$/i',$tmpfile)) { $mime='text/x-ksh'; $imgmime='script.png'; $srclang='bash'; }
  5316. if (preg_match('/\.bash$/i',$tmpfile)) { $mime='text/x-bash'; $imgmime='script.png'; $srclang='bash'; }
  5317. // Images
  5318. if (preg_match('/\.ico$/i',$tmpfile)) { $mime='image/x-icon'; $imgmime='image.png'; }
  5319. if (preg_match('/\.(jpg|jpeg)$/i',$tmpfile)) { $mime='image/jpeg'; $imgmime='image.png'; }
  5320. if (preg_match('/\.png$/i',$tmpfile)) { $mime='image/png'; $imgmime='image.png'; }
  5321. if (preg_match('/\.gif$/i',$tmpfile)) { $mime='image/gif'; $imgmime='image.png'; }
  5322. if (preg_match('/\.bmp$/i',$tmpfile)) { $mime='image/bmp'; $imgmime='image.png'; }
  5323. if (preg_match('/\.(tif|tiff)$/i',$tmpfile)) { $mime='image/tiff'; $imgmime='image.png'; }
  5324. // Calendar
  5325. if (preg_match('/\.vcs$/i',$tmpfile)) { $mime='text/calendar'; $imgmime='other.png'; }
  5326. if (preg_match('/\.ics$/i',$tmpfile)) { $mime='text/calendar'; $imgmime='other.png'; }
  5327. // Other
  5328. if (preg_match('/\.torrent$/i',$tmpfile)) { $mime='application/x-bittorrent'; $imgmime='other.png'; }
  5329. // Audio
  5330. if (preg_match('/\.(mp3|ogg|au|wav|wma|mid)$/i',$tmpfile)) { $mime='audio'; $imgmime='audio.png'; }
  5331. // Video
  5332. if (preg_match('/\.ogv$/i',$tmpfile)) { $mime='video/ogg'; $imgmime='video.png'; }
  5333. if (preg_match('/\.webm$/i',$tmpfile)) { $mime='video/webm'; $imgmime='video.png'; }
  5334. if (preg_match('/\.avi$/i',$tmpfile)) { $mime='video/x-msvideo'; $imgmime='video.png'; }
  5335. if (preg_match('/\.divx$/i',$tmpfile)) { $mime='video/divx'; $imgmime='video.png'; }
  5336. if (preg_match('/\.xvid$/i',$tmpfile)) { $mime='video/xvid'; $imgmime='video.png'; }
  5337. if (preg_match('/\.(wmv|mpg|mpeg)$/i',$tmpfile)) { $mime='video'; $imgmime='video.png'; }
  5338. // Archive
  5339. if (preg_match('/\.(zip|rar|gz|tgz|z|cab|bz2|7z|tar|lzh)$/i',$tmpfile)) { $mime='archive'; $imgmime='archive.png'; } // application/xxx where zzz is zip, ...
  5340. // Exe
  5341. if (preg_match('/\.(exe|com)$/i',$tmpfile)) { $mime='application/octet-stream'; $imgmime='other.png'; }
  5342. // Lib
  5343. if (preg_match('/\.(dll|lib|o|so|a)$/i',$tmpfile)) { $mime='library'; $imgmime='library.png'; }
  5344. // Err
  5345. if (preg_match('/\.err$/i',$tmpfile)) { $mime='error'; $imgmime='error.png'; }
  5346. // Return string
  5347. if ($mode == 1)
  5348. {
  5349. $tmp=explode('/',$mime);
  5350. return (! empty($tmp[1])?$tmp[1]:$tmp[0]);
  5351. }
  5352. if ($mode == 2)
  5353. {
  5354. return $imgmime;
  5355. }
  5356. if ($mode == 3)
  5357. {
  5358. return $srclang;
  5359. }
  5360. return $mime;
  5361. }