functions.lib.php 229 KB

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