functions.lib.php 452 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210
  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-2018 Laurent Destailleur <eldy@users.sourceforge.net>
  5. * Copyright (C) 2004 Sebastien Di Cintio <sdicintio@ressource-toi.org>
  6. * Copyright (C) 2004 Benoit Mortier <benoit.mortier@opensides.be>
  7. * Copyright (C) 2004 Christophe Combelles <ccomb@free.fr>
  8. * Copyright (C) 2005-2019 Regis Houssin <regis.houssin@inodbox.com>
  9. * Copyright (C) 2008 Raphael Bertrand (Resultic) <raphael.bertrand@resultic.fr>
  10. * Copyright (C) 2010-2018 Juanjo Menent <jmenent@2byte.es>
  11. * Copyright (C) 2013 Cédric Salvador <csalvador@gpcsolutions.fr>
  12. * Copyright (C) 2013-2021 Alexandre Spangaro <aspangaro@open-dsi.fr>
  13. * Copyright (C) 2014 Cédric GROSS <c.gross@kreiz-it.fr>
  14. * Copyright (C) 2014-2015 Marcos García <marcosgdf@gmail.com>
  15. * Copyright (C) 2015 Jean-François Ferry <jfefe@aternatik.fr>
  16. * Copyright (C) 2018-2022 Frédéric France <frederic.france@netlogic.fr>
  17. * Copyright (C) 2019 Thibault Foucart <support@ptibogxiv.net>
  18. * Copyright (C) 2020 Open-Dsi <support@open-dsi.fr>
  19. * Copyright (C) 2021 Gauthier VERDOL <gauthier.verdol@atm-consulting.fr>
  20. * Copyright (C) 2022 Anthony Berton <anthony.berton@bb2a.fr>
  21. * Copyright (C) 2022 Ferran Marcet <fmarcet@2byte.es>
  22. *
  23. * This program is free software; you can redistribute it and/or modify
  24. * it under the terms of the GNU General Public License as published by
  25. * the Free Software Foundation; either version 3 of the License, or
  26. * (at your option) any later version.
  27. *
  28. * This program is distributed in the hope that it will be useful,
  29. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  30. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  31. * GNU General Public License for more details.
  32. *
  33. * You should have received a copy of the GNU General Public License
  34. * along with this program. If not, see <https://www.gnu.org/licenses/>.
  35. * or see https://www.gnu.org/
  36. */
  37. /**
  38. * \file htdocs/core/lib/functions.lib.php
  39. * \brief A set of functions for Dolibarr
  40. * This file contains all frequently used functions.
  41. */
  42. include_once DOL_DOCUMENT_ROOT.'/core/lib/json.lib.php';
  43. if (!function_exists('utf8_encode')) {
  44. /**
  45. * Implement utf8_encode for PHP that does not support it.
  46. *
  47. * @param mixed $elements PHP Object to json encode
  48. * @return string Json encoded string
  49. */
  50. function utf8_encode($elements)
  51. {
  52. return mb_convert_encoding($elements, 'UTF-8', 'ISO-8859-1');
  53. }
  54. }
  55. if (!function_exists('utf8_decode')) {
  56. /**
  57. * Implement utf8_decode for PHP that does not support it.
  58. *
  59. * @param mixed $elements PHP Object to json encode
  60. * @return string Json encoded string
  61. */
  62. function utf8_decode($elements)
  63. {
  64. return mb_convert_encoding($elements, 'ISO-8859-1', 'UTF-8');
  65. }
  66. }
  67. /**
  68. * Return dolibarr global constant string value
  69. * @param string $key key to return value, return '' if not set
  70. * @param string $default value to return
  71. * @return string
  72. */
  73. function getDolGlobalString($key, $default = '')
  74. {
  75. global $conf;
  76. // return $conf->global->$key ?? $default;
  77. return (string) (empty($conf->global->$key) ? $default : $conf->global->$key);
  78. }
  79. /**
  80. * Return dolibarr global constant int value
  81. * @param string $key key to return value, return 0 if not set
  82. * @param int $default value to return
  83. * @return int
  84. */
  85. function getDolGlobalInt($key, $default = 0)
  86. {
  87. global $conf;
  88. // return $conf->global->$key ?? $default;
  89. return (int) (empty($conf->global->$key) ? $default : $conf->global->$key);
  90. }
  91. /**
  92. * Is Dolibarr module enabled
  93. * @param string $module module name to check
  94. * @return int
  95. */
  96. function isModEnabled($module)
  97. {
  98. global $conf;
  99. return !empty($conf->$module->enabled);
  100. }
  101. /**
  102. * Return a DoliDB instance (database handler).
  103. *
  104. * @param string $type Type of database (mysql, pgsql...)
  105. * @param string $host Address of database server
  106. * @param string $user Authorized username
  107. * @param string $pass Password
  108. * @param string $name Name of database
  109. * @param int $port Port of database server
  110. * @return DoliDB A DoliDB instance
  111. */
  112. function getDoliDBInstance($type, $host, $user, $pass, $name, $port)
  113. {
  114. require_once DOL_DOCUMENT_ROOT."/core/db/".$type.'.class.php';
  115. $class = 'DoliDB'.ucfirst($type);
  116. $dolidb = new $class($type, $host, $user, $pass, $name, $port);
  117. return $dolidb;
  118. }
  119. /**
  120. * Get list of entity id to use.
  121. *
  122. * @param string $element Current element
  123. * 'societe', 'socpeople', 'actioncomm', 'agenda', 'resource',
  124. * 'product', 'productprice', 'stock', 'bom', 'mo',
  125. * 'propal', 'supplier_proposal', 'invoice', 'supplier_invoice', 'payment_various',
  126. * 'categorie', 'bank_account', 'bank_account', 'adherent', 'user',
  127. * 'commande', 'supplier_order', 'expedition', 'intervention', 'survey',
  128. * 'contract', 'tax', 'expensereport', 'holiday', 'multicurrency', 'project',
  129. * 'email_template', 'event', 'donation'
  130. * 'c_paiement', 'c_payment_term', ...
  131. * @param int $shared 0=Return id of current entity only,
  132. * 1=Return id of current entity + shared entities (default)
  133. * @param object $currentobject Current object if needed
  134. * @return mixed Entity id(s) to use ( eg. entity IN ('.getEntity(elementname).')' )
  135. */
  136. function getEntity($element, $shared = 1, $currentobject = null)
  137. {
  138. global $conf, $mc, $hookmanager, $object, $action, $db;
  139. if (! is_object($hookmanager)) {
  140. $hookmanager = new HookManager($db);
  141. }
  142. // fix different element names (France to English)
  143. switch ($element) {
  144. case 'contrat':
  145. $element = 'contract';
  146. break; // "/contrat/class/contrat.class.php"
  147. case 'order_supplier':
  148. $element = 'supplier_order';
  149. break; // "/fourn/class/fournisseur.commande.class.php"
  150. case 'invoice_supplier':
  151. $element = 'supplier_invoice';
  152. break; // "/fourn/class/fournisseur.facture.class.php"
  153. }
  154. if (is_object($mc)) {
  155. $out = $mc->getEntity($element, $shared, $currentobject);
  156. } else {
  157. $out = '';
  158. $addzero = array('user', 'usergroup', 'c_email_templates', 'email_template', 'default_values');
  159. if (in_array($element, $addzero)) {
  160. $out .= '0,';
  161. }
  162. $out .= ((int) $conf->entity);
  163. }
  164. // Manipulate entities to query on the fly
  165. $parameters = array(
  166. 'element' => $element,
  167. 'shared' => $shared,
  168. 'object' => $object,
  169. 'currentobject' => $currentobject,
  170. 'out' => $out
  171. );
  172. $reshook = $hookmanager->executeHooks('hookGetEntity', $parameters, $currentobject, $action); // Note that $action and $object may have been modified by some hooks
  173. if (is_numeric($reshook)) {
  174. if ($reshook == 0 && !empty($hookmanager->resPrint)) {
  175. $out .= ','.$hookmanager->resPrint; // add
  176. } elseif ($reshook == 1) {
  177. $out = $hookmanager->resPrint; // replace
  178. }
  179. }
  180. return $out;
  181. }
  182. /**
  183. * Set entity id to use when to create an object
  184. *
  185. * @param object $currentobject Current object
  186. * @return mixed Entity id to use ( eg. entity = '.setEntity($object) )
  187. */
  188. function setEntity($currentobject)
  189. {
  190. global $conf, $mc;
  191. if (is_object($mc) && method_exists($mc, 'setEntity')) {
  192. return $mc->setEntity($currentobject);
  193. } else {
  194. return ((is_object($currentobject) && $currentobject->id > 0 && $currentobject->entity > 0) ? $currentobject->entity : $conf->entity);
  195. }
  196. }
  197. /**
  198. * Return if string has a name dedicated to store a secret
  199. *
  200. * @param string $keyname Name of key to test
  201. * @return boolean True if key is used to store a secret
  202. */
  203. function isASecretKey($keyname)
  204. {
  205. return preg_match('/(_pass|password|_pw|_key|securekey|serverkey|secret\d?|p12key|exportkey|_PW_[a-z]+|token)$/i', $keyname);
  206. }
  207. /**
  208. * Return a numeric value into an Excel like column number. So 0 return 'A', 1 returns 'B'..., 26 return 'AA'
  209. *
  210. * @param int|string $n Numeric value
  211. * @return string Column in Excel format
  212. */
  213. function num2Alpha($n)
  214. {
  215. for ($r = ""; $n >= 0; $n = intval($n / 26) - 1)
  216. $r = chr($n % 26 + 0x41) . $r;
  217. return $r;
  218. }
  219. /**
  220. * Return information about user browser
  221. *
  222. * Returns array with the following format:
  223. * array(
  224. * 'browsername' => Browser name (firefox|chrome|iceweasel|epiphany|safari|opera|ie|unknown)
  225. * 'browserversion' => Browser version. Empty if unknown
  226. * 'browseros' => Set with mobile OS (android|blackberry|ios|palm|symbian|webos|maemo|windows|unknown)
  227. * 'layout' => (tablet|phone|classic)
  228. * 'phone' => empty if not mobile, (android|blackberry|ios|palm|unknown) if mobile
  229. * 'tablet' => true/false
  230. * )
  231. *
  232. * @param string $user_agent Content of $_SERVER["HTTP_USER_AGENT"] variable
  233. * @return array Check function documentation
  234. */
  235. function getBrowserInfo($user_agent)
  236. {
  237. include_once DOL_DOCUMENT_ROOT.'/includes/mobiledetect/mobiledetectlib/Mobile_Detect.php';
  238. $name = 'unknown';
  239. $version = '';
  240. $os = 'unknown';
  241. $phone = '';
  242. $user_agent = substr($user_agent, 0, 512); // Avoid to process too large user agent
  243. $detectmobile = new Mobile_Detect(null, $user_agent);
  244. $tablet = $detectmobile->isTablet();
  245. if ($detectmobile->isMobile()) {
  246. $phone = 'unknown';
  247. // If phone/smartphone, we set phone os name.
  248. if ($detectmobile->is('AndroidOS')) {
  249. $os = $phone = 'android';
  250. } elseif ($detectmobile->is('BlackBerryOS')) {
  251. $os = $phone = 'blackberry';
  252. } elseif ($detectmobile->is('iOS')) {
  253. $os = 'ios';
  254. $phone = 'iphone';
  255. } elseif ($detectmobile->is('PalmOS')) {
  256. $os = $phone = 'palm';
  257. } elseif ($detectmobile->is('SymbianOS')) {
  258. $os = 'symbian';
  259. } elseif ($detectmobile->is('webOS')) {
  260. $os = 'webos';
  261. } elseif ($detectmobile->is('MaemoOS')) {
  262. $os = 'maemo';
  263. } elseif ($detectmobile->is('WindowsMobileOS') || $detectmobile->is('WindowsPhoneOS')) {
  264. $os = 'windows';
  265. }
  266. }
  267. // OS
  268. if (preg_match('/linux/i', $user_agent)) {
  269. $os = 'linux';
  270. } elseif (preg_match('/macintosh/i', $user_agent)) {
  271. $os = 'macintosh';
  272. } elseif (preg_match('/windows/i', $user_agent)) {
  273. $os = 'windows';
  274. }
  275. // Name
  276. $reg = array();
  277. if (preg_match('/firefox(\/|\s)([\d\.]*)/i', $user_agent, $reg)) {
  278. $name = 'firefox';
  279. $version = $reg[2];
  280. } elseif (preg_match('/edge(\/|\s)([\d\.]*)/i', $user_agent, $reg)) {
  281. $name = 'edge';
  282. $version = $reg[2];
  283. } elseif (preg_match('/chrome(\/|\s)([\d\.]+)/i', $user_agent, $reg)) {
  284. $name = 'chrome';
  285. $version = $reg[2];
  286. } elseif (preg_match('/chrome/i', $user_agent, $reg)) {
  287. // we can have 'chrome (Mozilla...) chrome x.y' in one string
  288. $name = 'chrome';
  289. } elseif (preg_match('/iceweasel/i', $user_agent)) {
  290. $name = 'iceweasel';
  291. } elseif (preg_match('/epiphany/i', $user_agent)) {
  292. $name = 'epiphany';
  293. } elseif (preg_match('/safari(\/|\s)([\d\.]*)/i', $user_agent, $reg)) {
  294. $name = 'safari';
  295. $version = $reg[2];
  296. } elseif (preg_match('/opera(\/|\s)([\d\.]*)/i', $user_agent, $reg)) {
  297. // Safari is often present in string for mobile but its not.
  298. $name = 'opera';
  299. $version = $reg[2];
  300. } elseif (preg_match('/(MSIE\s([0-9]+\.[0-9]))|.*(Trident\/[0-9]+.[0-9];.*rv:([0-9]+\.[0-9]+))/i', $user_agent, $reg)) {
  301. $name = 'ie';
  302. $version = end($reg);
  303. } elseif (preg_match('/(Windows NT\s([0-9]+\.[0-9])).*(Trident\/[0-9]+.[0-9];.*rv:([0-9]+\.[0-9]+))/i', $user_agent, $reg)) {
  304. // MS products at end
  305. $name = 'ie';
  306. $version = end($reg);
  307. } elseif (preg_match('/l(i|y)n(x|ks)(\(|\/|\s)*([\d\.]+)/i', $user_agent, $reg)) {
  308. // MS products at end
  309. $name = 'lynxlinks';
  310. $version = $reg[4];
  311. }
  312. if ($tablet) {
  313. $layout = 'tablet';
  314. } elseif ($phone) {
  315. $layout = 'phone';
  316. } else {
  317. $layout = 'classic';
  318. }
  319. return array(
  320. 'browsername' => $name,
  321. 'browserversion' => $version,
  322. 'browseros' => $os,
  323. 'layout' => $layout,
  324. 'phone' => $phone,
  325. 'tablet' => $tablet
  326. );
  327. }
  328. /**
  329. * Function called at end of web php process
  330. *
  331. * @return void
  332. */
  333. function dol_shutdown()
  334. {
  335. global $conf, $user, $langs, $db;
  336. $disconnectdone = false;
  337. $depth = 0;
  338. if (is_object($db) && !empty($db->connected)) {
  339. $depth = $db->transaction_opened;
  340. $disconnectdone = $db->close();
  341. }
  342. dol_syslog("--- End access to ".$_SERVER["PHP_SELF"].(($disconnectdone && $depth) ? ' (Warn: db disconnection forced, transaction depth was '.$depth.')' : ''), (($disconnectdone && $depth) ? LOG_WARNING : LOG_INFO));
  343. }
  344. /**
  345. * Return true if we are in a context of submitting the parameter $paramname from a POST of a form.
  346. *
  347. * @param string $paramname Name or parameter to test
  348. * @return boolean True if we have just submit a POST or GET request with the parameter provided (even if param is empty)
  349. */
  350. function GETPOSTISSET($paramname)
  351. {
  352. $isset = false;
  353. $relativepathstring = $_SERVER["PHP_SELF"];
  354. // Clean $relativepathstring
  355. if (constant('DOL_URL_ROOT')) {
  356. $relativepathstring = preg_replace('/^'.preg_quote(constant('DOL_URL_ROOT'), '/').'/', '', $relativepathstring);
  357. }
  358. $relativepathstring = preg_replace('/^\//', '', $relativepathstring);
  359. $relativepathstring = preg_replace('/^custom\//', '', $relativepathstring);
  360. //var_dump($relativepathstring);
  361. //var_dump($user->default_values);
  362. // Code for search criteria persistence.
  363. // Retrieve values if restore_lastsearch_values
  364. if (!empty($_GET['restore_lastsearch_values'])) { // Use $_GET here and not GETPOST
  365. if (!empty($_SESSION['lastsearch_values_'.$relativepathstring])) { // If there is saved values
  366. $tmp = json_decode($_SESSION['lastsearch_values_'.$relativepathstring], true);
  367. if (is_array($tmp)) {
  368. foreach ($tmp as $key => $val) {
  369. if ($key == $paramname) { // We are on the requested parameter
  370. $isset = true;
  371. break;
  372. }
  373. }
  374. }
  375. }
  376. // If there is saved contextpage, limit, page or mode
  377. if ($paramname == 'contextpage' && !empty($_SESSION['lastsearch_contextpage_'.$relativepathstring])) {
  378. $isset = true;
  379. } elseif ($paramname == 'limit' && !empty($_SESSION['lastsearch_limit_'.$relativepathstring])) {
  380. $isset = true;
  381. } elseif ($paramname == 'page' && !empty($_SESSION['lastsearch_page_'.$relativepathstring])) {
  382. $isset = true;
  383. } elseif ($paramname == 'mode' && !empty($_SESSION['lastsearch_mode_'.$relativepathstring])) {
  384. $isset = true;
  385. }
  386. } else {
  387. $isset = (isset($_POST[$paramname]) || isset($_GET[$paramname])); // We must keep $_POST and $_GET here
  388. }
  389. return $isset;
  390. }
  391. /**
  392. * Return true if the parameter $paramname is submit from a POST OR GET as an array.
  393. * Can be used before GETPOST to know if the $check param of GETPOST need to check an array or a string
  394. *
  395. * @param string $paramname Name or parameter to test
  396. * @param int $method Type of method (0 = get then post, 1 = only get, 2 = only post, 3 = post then get)
  397. * @return bool True if we have just submit a POST or GET request with the parameter provided (even if param is empty)
  398. */
  399. function GETPOSTISARRAY($paramname, $method = 0)
  400. {
  401. // for $method test need return the same $val as GETPOST
  402. if (empty($method)) {
  403. $val = isset($_GET[$paramname]) ? $_GET[$paramname] : (isset($_POST[$paramname]) ? $_POST[$paramname] : '');
  404. } elseif ($method == 1) {
  405. $val = isset($_GET[$paramname]) ? $_GET[$paramname] : '';
  406. } elseif ($method == 2) {
  407. $val = isset($_POST[$paramname]) ? $_POST[$paramname] : '';
  408. } elseif ($method == 3) {
  409. $val = isset($_POST[$paramname]) ? $_POST[$paramname] : (isset($_GET[$paramname]) ? $_GET[$paramname] : '');
  410. } else {
  411. $val = 'BadFirstParameterForGETPOST';
  412. }
  413. return is_array($val);
  414. }
  415. /**
  416. * Return value of a param into GET or POST supervariable.
  417. * Use the property $user->default_values[path]['createform'] and/or $user->default_values[path]['filters'] and/or $user->default_values[path]['sortorder']
  418. * Note: The property $user->default_values is loaded by main.php when loading the user.
  419. *
  420. * @param string $paramname Name of parameter to found
  421. * @param string $check Type of check
  422. * ''=no check (deprecated)
  423. * 'none'=no check (only for param that should have very rich content like passwords)
  424. * 'array', 'array:restricthtml' or 'array:aZ09' to check it's an array
  425. * 'int'=check it's numeric (integer or float)
  426. * 'intcomma'=check it's integer+comma ('1,2,3,4...')
  427. * 'alpha'=Same than alphanohtml since v13
  428. * 'alphawithlgt'=alpha with lgt
  429. * 'alphanohtml'=check there is no html content and no " and no ../
  430. * 'aZ'=check it's a-z only
  431. * 'aZ09'=check it's simple alpha string (recommended for keys)
  432. * 'san_alpha'=Use filter_var with FILTER_SANITIZE_STRING (do not use this for free text string)
  433. * 'nohtml'=check there is no html content and no " and no ../
  434. * 'restricthtml'=check html content is restricted to some tags only
  435. * 'custom'= custom filter specify $filter and $options)
  436. * @param int $method Type of method (0 = get then post, 1 = only get, 2 = only post, 3 = post then get)
  437. * @param int $filter Filter to apply when $check is set to 'custom'. (See http://php.net/manual/en/filter.filters.php for détails)
  438. * @param mixed $options Options to pass to filter_var when $check is set to 'custom'
  439. * @param string $noreplace Force disable of replacement of __xxx__ strings.
  440. * @return string|array Value found (string or array), or '' if check fails
  441. */
  442. function GETPOST($paramname, $check = 'alphanohtml', $method = 0, $filter = null, $options = null, $noreplace = 0)
  443. {
  444. global $mysoc, $user, $conf;
  445. if (empty($paramname)) {
  446. return 'BadFirstParameterForGETPOST';
  447. }
  448. if (empty($check)) {
  449. dol_syslog("Deprecated use of GETPOST, called with 1st param = ".$paramname." and 2nd param is '', when calling page ".$_SERVER["PHP_SELF"], LOG_WARNING);
  450. // Enable this line to know who call the GETPOST with '' $check parameter.
  451. //var_dump(debug_backtrace()[0]);
  452. }
  453. if (empty($method)) {
  454. $out = isset($_GET[$paramname]) ? $_GET[$paramname] : (isset($_POST[$paramname]) ? $_POST[$paramname] : '');
  455. } elseif ($method == 1) {
  456. $out = isset($_GET[$paramname]) ? $_GET[$paramname] : '';
  457. } elseif ($method == 2) {
  458. $out = isset($_POST[$paramname]) ? $_POST[$paramname] : '';
  459. } elseif ($method == 3) {
  460. $out = isset($_POST[$paramname]) ? $_POST[$paramname] : (isset($_GET[$paramname]) ? $_GET[$paramname] : '');
  461. } else {
  462. return 'BadThirdParameterForGETPOST';
  463. }
  464. if (empty($method) || $method == 3 || $method == 4) {
  465. $relativepathstring = $_SERVER["PHP_SELF"];
  466. // Clean $relativepathstring
  467. if (constant('DOL_URL_ROOT')) {
  468. $relativepathstring = preg_replace('/^'.preg_quote(constant('DOL_URL_ROOT'), '/').'/', '', $relativepathstring);
  469. }
  470. $relativepathstring = preg_replace('/^\//', '', $relativepathstring);
  471. $relativepathstring = preg_replace('/^custom\//', '', $relativepathstring);
  472. //var_dump($relativepathstring);
  473. //var_dump($user->default_values);
  474. // Code for search criteria persistence.
  475. // Retrieve values if restore_lastsearch_values
  476. if (!empty($_GET['restore_lastsearch_values'])) { // Use $_GET here and not GETPOST
  477. if (!empty($_SESSION['lastsearch_values_'.$relativepathstring])) { // If there is saved values
  478. $tmp = json_decode($_SESSION['lastsearch_values_'.$relativepathstring], true);
  479. if (is_array($tmp)) {
  480. foreach ($tmp as $key => $val) {
  481. if ($key == $paramname) { // We are on the requested parameter
  482. $out = $val;
  483. break;
  484. }
  485. }
  486. }
  487. }
  488. // If there is saved contextpage, page or limit
  489. if ($paramname == 'contextpage' && !empty($_SESSION['lastsearch_contextpage_'.$relativepathstring])) {
  490. $out = $_SESSION['lastsearch_contextpage_'.$relativepathstring];
  491. } elseif ($paramname == 'limit' && !empty($_SESSION['lastsearch_limit_'.$relativepathstring])) {
  492. $out = $_SESSION['lastsearch_limit_'.$relativepathstring];
  493. } elseif ($paramname == 'page' && !empty($_SESSION['lastsearch_page_'.$relativepathstring])) {
  494. $out = $_SESSION['lastsearch_page_'.$relativepathstring];
  495. } elseif ($paramname == 'mode' && !empty($_SESSION['lastsearch_mode_'.$relativepathstring])) {
  496. $out = $_SESSION['lastsearch_mode_'.$relativepathstring];
  497. }
  498. } elseif (!isset($_GET['sortfield'])) {
  499. // Else, retrieve default values if we are not doing a sort
  500. // If we did a click on a field to sort, we do no apply default values. Same if option MAIN_ENABLE_DEFAULT_VALUES is not set
  501. if (!empty($_GET['action']) && $_GET['action'] == 'create' && !isset($_GET[$paramname]) && !isset($_POST[$paramname])) {
  502. // Search default value from $object->field
  503. global $object;
  504. if (is_object($object) && isset($object->fields[$paramname]['default'])) {
  505. $out = $object->fields[$paramname]['default'];
  506. }
  507. }
  508. if (!empty($conf->global->MAIN_ENABLE_DEFAULT_VALUES)) {
  509. if (!empty($_GET['action']) && (preg_match('/^create/', $_GET['action']) || preg_match('/^presend/', $_GET['action'])) && !isset($_GET[$paramname]) && !isset($_POST[$paramname])) {
  510. // Now search in setup to overwrite default values
  511. if (!empty($user->default_values)) { // $user->default_values defined from menu 'Setup - Default values'
  512. if (isset($user->default_values[$relativepathstring]['createform'])) {
  513. foreach ($user->default_values[$relativepathstring]['createform'] as $defkey => $defval) {
  514. $qualified = 0;
  515. if ($defkey != '_noquery_') {
  516. $tmpqueryarraytohave = explode('&', $defkey);
  517. $tmpqueryarraywehave = explode('&', dol_string_nohtmltag($_SERVER['QUERY_STRING']));
  518. $foundintru = 0;
  519. foreach ($tmpqueryarraytohave as $tmpquerytohave) {
  520. if (!in_array($tmpquerytohave, $tmpqueryarraywehave)) {
  521. $foundintru = 1;
  522. }
  523. }
  524. if (!$foundintru) {
  525. $qualified = 1;
  526. }
  527. //var_dump($defkey.'-'.$qualified);
  528. } else {
  529. $qualified = 1;
  530. }
  531. if ($qualified) {
  532. if (isset($user->default_values[$relativepathstring]['createform'][$defkey][$paramname])) {
  533. $out = $user->default_values[$relativepathstring]['createform'][$defkey][$paramname];
  534. break;
  535. }
  536. }
  537. }
  538. }
  539. }
  540. } elseif (!empty($paramname) && !isset($_GET[$paramname]) && !isset($_POST[$paramname])) {
  541. // Management of default search_filters and sort order
  542. if (!empty($user->default_values)) {
  543. // $user->default_values defined from menu 'Setup - Default values'
  544. //var_dump($user->default_values[$relativepathstring]);
  545. if ($paramname == 'sortfield' || $paramname == 'sortorder') {
  546. // Sorted on which fields ? ASC or DESC ?
  547. if (isset($user->default_values[$relativepathstring]['sortorder'])) {
  548. // Even if paramname is sortfield, data are stored into ['sortorder...']
  549. foreach ($user->default_values[$relativepathstring]['sortorder'] as $defkey => $defval) {
  550. $qualified = 0;
  551. if ($defkey != '_noquery_') {
  552. $tmpqueryarraytohave = explode('&', $defkey);
  553. $tmpqueryarraywehave = explode('&', dol_string_nohtmltag($_SERVER['QUERY_STRING']));
  554. $foundintru = 0;
  555. foreach ($tmpqueryarraytohave as $tmpquerytohave) {
  556. if (!in_array($tmpquerytohave, $tmpqueryarraywehave)) {
  557. $foundintru = 1;
  558. }
  559. }
  560. if (!$foundintru) {
  561. $qualified = 1;
  562. }
  563. //var_dump($defkey.'-'.$qualified);
  564. } else {
  565. $qualified = 1;
  566. }
  567. if ($qualified) {
  568. $forbidden_chars_to_replace = array(" ", "'", "/", "\\", ":", "*", "?", "\"", "<", ">", "|", "[", "]", ";", "="); // we accept _, -, . and ,
  569. foreach ($user->default_values[$relativepathstring]['sortorder'][$defkey] as $key => $val) {
  570. if ($out) {
  571. $out .= ', ';
  572. }
  573. if ($paramname == 'sortfield') {
  574. $out .= dol_string_nospecial($key, '', $forbidden_chars_to_replace);
  575. }
  576. if ($paramname == 'sortorder') {
  577. $out .= dol_string_nospecial($val, '', $forbidden_chars_to_replace);
  578. }
  579. }
  580. //break; // No break for sortfield and sortorder so we can cumulate fields (is it realy usefull ?)
  581. }
  582. }
  583. }
  584. } elseif (isset($user->default_values[$relativepathstring]['filters'])) {
  585. foreach ($user->default_values[$relativepathstring]['filters'] as $defkey => $defval) { // $defkey is a querystring like 'a=b&c=d', $defval is key of user
  586. if (!empty($_GET['disabledefaultvalues'])) { // If set of default values has been disabled by a request parameter
  587. continue;
  588. }
  589. $qualified = 0;
  590. if ($defkey != '_noquery_') {
  591. $tmpqueryarraytohave = explode('&', $defkey);
  592. $tmpqueryarraywehave = explode('&', dol_string_nohtmltag($_SERVER['QUERY_STRING']));
  593. $foundintru = 0;
  594. foreach ($tmpqueryarraytohave as $tmpquerytohave) {
  595. if (!in_array($tmpquerytohave, $tmpqueryarraywehave)) {
  596. $foundintru = 1;
  597. }
  598. }
  599. if (!$foundintru) {
  600. $qualified = 1;
  601. }
  602. //var_dump($defkey.'-'.$qualified);
  603. } else {
  604. $qualified = 1;
  605. }
  606. if ($qualified) {
  607. // We must keep $_POST and $_GET here
  608. if (isset($_POST['sall']) || isset($_POST['search_all']) || isset($_GET['sall']) || isset($_GET['search_all'])) {
  609. // We made a search from quick search menu, do we still use default filter ?
  610. if (empty($conf->global->MAIN_DISABLE_DEFAULT_FILTER_FOR_QUICK_SEARCH)) {
  611. $forbidden_chars_to_replace = array(" ", "'", "/", "\\", ":", "*", "?", "\"", "<", ">", "|", "[", "]", ";", "="); // we accept _, -, . and ,
  612. $out = dol_string_nospecial($user->default_values[$relativepathstring]['filters'][$defkey][$paramname], '', $forbidden_chars_to_replace);
  613. }
  614. } else {
  615. $forbidden_chars_to_replace = array(" ", "'", "/", "\\", ":", "*", "?", "\"", "<", ">", "|", "[", "]", ";", "="); // we accept _, -, . and ,
  616. $out = dol_string_nospecial($user->default_values[$relativepathstring]['filters'][$defkey][$paramname], '', $forbidden_chars_to_replace);
  617. }
  618. break;
  619. }
  620. }
  621. }
  622. }
  623. }
  624. }
  625. }
  626. }
  627. // Substitution variables for GETPOST (used to get final url with variable parameters or final default value with variable parameters)
  628. // Example of variables: __DAY__, __MONTH__, __YEAR__, __MYCOMPANY_COUNTRY_ID__, __USER_ID__, ...
  629. // We do this only if var is a GET. If it is a POST, may be we want to post the text with vars as the setup text.
  630. if (!is_array($out) && empty($_POST[$paramname]) && empty($noreplace)) {
  631. $reg = array();
  632. $maxloop = 20;
  633. $loopnb = 0; // Protection against infinite loop
  634. while (preg_match('/__([A-Z0-9]+_?[A-Z0-9]+)__/i', $out, $reg) && ($loopnb < $maxloop)) { // Detect '__ABCDEF__' as key 'ABCDEF' and '__ABC_DEF__' as key 'ABC_DEF'. Detection is also correct when 2 vars are side by side.
  635. $loopnb++;
  636. $newout = '';
  637. if ($reg[1] == 'DAY') {
  638. $tmp = dol_getdate(dol_now(), true);
  639. $newout = $tmp['mday'];
  640. } elseif ($reg[1] == 'MONTH') {
  641. $tmp = dol_getdate(dol_now(), true);
  642. $newout = $tmp['mon'];
  643. } elseif ($reg[1] == 'YEAR') {
  644. $tmp = dol_getdate(dol_now(), true);
  645. $newout = $tmp['year'];
  646. } elseif ($reg[1] == 'PREVIOUS_DAY') {
  647. $tmp = dol_getdate(dol_now(), true);
  648. $tmp2 = dol_get_prev_day($tmp['mday'], $tmp['mon'], $tmp['year']);
  649. $newout = $tmp2['day'];
  650. } elseif ($reg[1] == 'PREVIOUS_MONTH') {
  651. $tmp = dol_getdate(dol_now(), true);
  652. $tmp2 = dol_get_prev_month($tmp['mon'], $tmp['year']);
  653. $newout = $tmp2['month'];
  654. } elseif ($reg[1] == 'PREVIOUS_YEAR') {
  655. $tmp = dol_getdate(dol_now(), true);
  656. $newout = ($tmp['year'] - 1);
  657. } elseif ($reg[1] == 'NEXT_DAY') {
  658. $tmp = dol_getdate(dol_now(), true);
  659. $tmp2 = dol_get_next_day($tmp['mday'], $tmp['mon'], $tmp['year']);
  660. $newout = $tmp2['day'];
  661. } elseif ($reg[1] == 'NEXT_MONTH') {
  662. $tmp = dol_getdate(dol_now(), true);
  663. $tmp2 = dol_get_next_month($tmp['mon'], $tmp['year']);
  664. $newout = $tmp2['month'];
  665. } elseif ($reg[1] == 'NEXT_YEAR') {
  666. $tmp = dol_getdate(dol_now(), true);
  667. $newout = ($tmp['year'] + 1);
  668. } elseif ($reg[1] == 'MYCOMPANY_COUNTRY_ID' || $reg[1] == 'MYCOUNTRY_ID' || $reg[1] == 'MYCOUNTRYID') {
  669. $newout = $mysoc->country_id;
  670. } elseif ($reg[1] == 'USER_ID' || $reg[1] == 'USERID') {
  671. $newout = $user->id;
  672. } elseif ($reg[1] == 'USER_SUPERVISOR_ID' || $reg[1] == 'SUPERVISOR_ID' || $reg[1] == 'SUPERVISORID') {
  673. $newout = $user->fk_user;
  674. } elseif ($reg[1] == 'ENTITY_ID' || $reg[1] == 'ENTITYID') {
  675. $newout = $conf->entity;
  676. } else {
  677. $newout = ''; // Key not found, we replace with empty string
  678. }
  679. //var_dump('__'.$reg[1].'__ -> '.$newout);
  680. $out = preg_replace('/__'.preg_quote($reg[1], '/').'__/', $newout, $out);
  681. }
  682. }
  683. // Check rule
  684. if (preg_match('/^array/', $check)) { // If 'array' or 'array:restricthtml' or 'array:aZ09' or 'array:intcomma'
  685. if (!is_array($out) || empty($out)) {
  686. $out = array();
  687. } else {
  688. $tmparray = explode(':', $check);
  689. if (!empty($tmparray[1])) {
  690. $tmpcheck = $tmparray[1];
  691. } else {
  692. $tmpcheck = 'alphanohtml';
  693. }
  694. foreach ($out as $outkey => $outval) {
  695. $out[$outkey] = sanitizeVal($outval, $tmpcheck, $filter, $options);
  696. }
  697. }
  698. } else {
  699. $out = sanitizeVal($out, $check, $filter, $options);
  700. }
  701. // Sanitizing for special parameters.
  702. // Note: There is no reason to allow the backtopage, backtolist or backtourl parameter to contains an external URL. Only relative URLs are allowed.
  703. if ($paramname == 'backtopage' || $paramname == 'backtolist' || $paramname == 'backtourl') {
  704. $out = str_replace('\\', '/', $out); // Can be before the loop because only 1 char is replaced. No risk to get it after other replacements.
  705. $out = str_replace(array(':', ';', '@', "\t", ' '), '', $out); // Can be before the loop because only 1 char is replaced. No risk to retreive it after other replacements.
  706. do {
  707. $oldstringtoclean = $out;
  708. $out = str_ireplace(array('javascript', 'vbscript', '&colon', '&#'), '', $out);
  709. $out = preg_replace(array('/^[^\?]*%/'), '', $out); // We remove any % chars before the ?. Example in url: '/product/stock/card.php?action=create&backtopage=%2Fdolibarr_dev%2Fhtdocs%2Fpro%25duct%2Fcard.php%3Fid%3Dabc'
  710. $out = preg_replace(array('/^[a-z]*\/\s*\/+/i'), '', $out); // We remove schema*// to remove external URL
  711. } while ($oldstringtoclean != $out);
  712. }
  713. // Code for search criteria persistence.
  714. // Save data into session if key start with 'search_' or is 'smonth', 'syear', 'month', 'year'
  715. if (empty($method) || $method == 3 || $method == 4) {
  716. if (preg_match('/^search_/', $paramname) || in_array($paramname, array('sortorder', 'sortfield'))) {
  717. //var_dump($paramname.' - '.$out.' '.$user->default_values[$relativepathstring]['filters'][$paramname]);
  718. // We save search key only if $out not empty that means:
  719. // - posted value not empty, or
  720. // - if posted value is empty and a default value exists that is not empty (it means we did a filter to an empty value when default was not).
  721. if ($out != '' && isset($user)) {// $out = '0' or 'abc', it is a search criteria to keep
  722. $user->lastsearch_values_tmp[$relativepathstring][$paramname] = $out;
  723. }
  724. }
  725. }
  726. return $out;
  727. }
  728. /**
  729. * Return value of a param into GET or POST supervariable.
  730. * Use the property $user->default_values[path]['creatform'] and/or $user->default_values[path]['filters'] and/or $user->default_values[path]['sortorder']
  731. * Note: The property $user->default_values is loaded by main.php when loading the user.
  732. *
  733. * @param string $paramname Name of parameter to found
  734. * @param int $method Type of method (0 = get then post, 1 = only get, 2 = only post, 3 = post then get)
  735. * @return int Value found (int)
  736. */
  737. function GETPOSTINT($paramname, $method = 0)
  738. {
  739. return (int) GETPOST($paramname, 'int', $method, null, null, 0);
  740. }
  741. /**
  742. * Return a sanitized or empty value after checking value against a rule.
  743. *
  744. * @deprecated
  745. * @param string|array $out Value to check/clear.
  746. * @param string $check Type of check/sanitizing
  747. * @param int $filter Filter to apply when $check is set to 'custom'. (See http://php.net/manual/en/filter.filters.php for détails)
  748. * @param mixed $options Options to pass to filter_var when $check is set to 'custom'
  749. * @return string|array Value sanitized (string or array). It may be '' if format check fails.
  750. */
  751. function checkVal($out = '', $check = 'alphanohtml', $filter = null, $options = null)
  752. {
  753. return sanitizeVal($out, $check, $filter, $options);
  754. }
  755. /**
  756. * Return a sanitized or empty value after checking value against a rule.
  757. *
  758. * @param string|array $out Value to check/clear.
  759. * @param string $check Type of check/sanitizing
  760. * @param int $filter Filter to apply when $check is set to 'custom'. (See http://php.net/manual/en/filter.filters.php for détails)
  761. * @param mixed $options Options to pass to filter_var when $check is set to 'custom'
  762. * @return string|array Value sanitized (string or array). It may be '' if format check fails.
  763. */
  764. function sanitizeVal($out = '', $check = 'alphanohtml', $filter = null, $options = null)
  765. {
  766. global $conf;
  767. // TODO : use class "Validate" to perform tests (and add missing tests) if needed for factorize
  768. // Check is done after replacement
  769. switch ($check) {
  770. case 'none':
  771. break;
  772. case 'int': // Check param is a numeric value (integer but also float or hexadecimal)
  773. if (!is_numeric($out)) {
  774. $out = '';
  775. }
  776. break;
  777. case 'intcomma':
  778. if (preg_match('/[^0-9,-]+/i', $out)) {
  779. $out = '';
  780. }
  781. break;
  782. case 'san_alpha':
  783. $out = filter_var($out, FILTER_SANITIZE_STRING);
  784. break;
  785. case 'email':
  786. $out = filter_var($out, FILTER_SANITIZE_EMAIL);
  787. break;
  788. case 'aZ':
  789. if (!is_array($out)) {
  790. $out = trim($out);
  791. if (preg_match('/[^a-z]+/i', $out)) {
  792. $out = '';
  793. }
  794. }
  795. break;
  796. case 'aZ09':
  797. if (!is_array($out)) {
  798. $out = trim($out);
  799. if (preg_match('/[^a-z0-9_\-\.]+/i', $out)) {
  800. $out = '';
  801. }
  802. }
  803. break;
  804. case 'aZ09comma': // great to sanitize sortfield or sortorder params that can be t.abc,t.def_gh
  805. if (!is_array($out)) {
  806. $out = trim($out);
  807. if (preg_match('/[^a-z0-9_\-\.,]+/i', $out)) {
  808. $out = '';
  809. }
  810. }
  811. break;
  812. case 'nohtml': // No html
  813. $out = dol_string_nohtmltag($out, 0);
  814. break;
  815. case 'alpha': // No html and no ../ and "
  816. case 'alphanohtml': // Recommended for most scalar parameters and search parameters
  817. if (!is_array($out)) {
  818. $out = trim($out);
  819. do {
  820. $oldstringtoclean = $out;
  821. // Remove html tags
  822. $out = dol_string_nohtmltag($out, 0);
  823. // Remove also other dangerous string sequences
  824. // '"' is dangerous because param in url can close the href= or src= and add javascript functions.
  825. // '../' or '..\' is dangerous because it allows dir transversals
  826. // Note &#38, '&#0000038', '&#x26'... is a simple char like '&' alone but there is no reason to accept such way to encode input data.
  827. $out = str_ireplace(array('&#38', '&#0000038', '&#x26', '&quot', '&#34', '&#0000034', '&#x22', '"', '&#47', '&#0000047', '&#92', '&#0000092', '&#x2F', '../', '..\\'), '', $out);
  828. } while ($oldstringtoclean != $out);
  829. // keep lines feed
  830. }
  831. break;
  832. case 'alphawithlgt': // No " and no ../ but we keep balanced < > tags with no special chars inside. Can be used for email string like "Name <email>". Less secured than 'alphanohtml'
  833. if (!is_array($out)) {
  834. $out = trim($out);
  835. do {
  836. $oldstringtoclean = $out;
  837. // Remove html tags
  838. $out = dol_html_entity_decode($out, ENT_COMPAT | ENT_HTML5, 'UTF-8');
  839. // '"' is dangerous because param in url can close the href= or src= and add javascript functions.
  840. // '../' or '..\' is dangerous because it allows dir transversals
  841. // Note &#38, '&#0000038', '&#x26'... is a simple char like '&' alone but there is no reason to accept such way to encode input data.
  842. $out = str_ireplace(array('&#38', '&#0000038', '&#x26', '&quot', '&#34', '&#0000034', '&#x22', '"', '&#47', '&#0000047', '&#92', '&#0000092', '&#x2F', '../', '..\\'), '', $out);
  843. } while ($oldstringtoclean != $out);
  844. }
  845. break;
  846. case 'restricthtml': // Recommended for most html textarea
  847. case 'restricthtmlallowunvalid':
  848. do {
  849. $oldstringtoclean = $out;
  850. if (!empty($out) && !empty($conf->global->MAIN_RESTRICTHTML_ONLY_VALID_HTML) && $check != 'restricthtmlallowunvalid') {
  851. try {
  852. $dom = new DOMDocument;
  853. // Add a trick to solve pb with text without parent tag
  854. // like '<h1>Foo</h1><p>bar</p>' that ends up with '<h1>Foo<p>bar</p></h1>'
  855. // like 'abc' that ends up with '<p>abc</p>'
  856. $out = '<div class="tricktoremove">'.$out.'</div>';
  857. $dom->loadHTML($out, LIBXML_ERR_NONE|LIBXML_HTML_NOIMPLIED|LIBXML_HTML_NODEFDTD|LIBXML_NONET|LIBXML_NOWARNING|LIBXML_NOXMLDECL);
  858. $out = trim($dom->saveHTML());
  859. // Remove the trick added to solve pb with text without parent tag
  860. $out = preg_replace('/^<div class="tricktoremove">/', '', $out);
  861. $out = preg_replace('/<\/div>$/', '', $out);
  862. } catch (Exception $e) {
  863. //print $e->getMessage();
  864. return 'InvalidHTMLString';
  865. }
  866. }
  867. // Ckeditor use the numeric entitic for apostrophe so we force it to text entity (all other special chars are
  868. // encoded using text entities) so we can then exclude all numeric entities.
  869. $out = preg_replace('/&#39;/i', '&apos;', $out);
  870. // We replace chars from a/A to z/Z encoded with numeric HTML entities with the real char so we won't loose the chars at the next step (preg_replace).
  871. // No need to use a loop here, this step is not to sanitize (this is done at next step, this is to try to save chars, even if they are
  872. // using a non coventionnel way to be encoded, to not have them sanitized just after)
  873. //$out = preg_replace_callback('/&#(x?[0-9][0-9a-f]+;?)/i', 'realCharForNumericEntities', $out);
  874. $out = preg_replace_callback('/&#(x?[0-9][0-9a-f]+;?)/i', function ($m) {
  875. return realCharForNumericEntities($m); }, $out);
  876. // Now we remove all remaining HTML entities starting with a number. We don't want such entities.
  877. $out = preg_replace('/&#x?[0-9]+/i', '', $out); // For example if we have j&#x61vascript with an entities without the ; to hide the 'a' of 'javascript'.
  878. $out = dol_string_onlythesehtmltags($out, 0, 1, 1);
  879. // We should also exclude non expected HTML attributes and clean content of some attributes.
  880. if (!empty($conf->global->MAIN_RESTRICTHTML_REMOVE_ALSO_BAD_ATTRIBUTES)) {
  881. // Warning, the function may add a LF so we are forced to trim to compare with old $out without having always a difference and an infinit loop.
  882. $out = dol_string_onlythesehtmlattributes($out);
  883. }
  884. // Restore entity &apos; into &#39; (restricthtml is for html content so we can use html entity)
  885. $out = preg_replace('/&apos;/i', "&#39;", $out);
  886. } while ($oldstringtoclean != $out);
  887. break;
  888. case 'custom':
  889. if (empty($filter)) {
  890. return 'BadFourthParameterForGETPOST';
  891. }
  892. $out = filter_var($out, $filter, $options);
  893. break;
  894. }
  895. return $out;
  896. }
  897. if (!function_exists('dol_getprefix')) {
  898. /**
  899. * Return a prefix to use for this Dolibarr instance, for session/cookie names or email id.
  900. * The prefix is unique for instance and avoid conflict between multi-instances, even when having two instances with same root dir
  901. * or two instances in same virtual servers.
  902. * This function must not use dol_hash (that is used for password hash) and need to have all context $conf loaded.
  903. *
  904. * @param string $mode '' (prefix for session name) or 'email' (prefix for email id)
  905. * @return string A calculated prefix
  906. */
  907. function dol_getprefix($mode = '')
  908. {
  909. // If prefix is for email (we need to have $conf already loaded for this case)
  910. if ($mode == 'email') {
  911. global $conf;
  912. if (!empty($conf->global->MAIL_PREFIX_FOR_EMAIL_ID)) { // If MAIL_PREFIX_FOR_EMAIL_ID is set
  913. if ($conf->global->MAIL_PREFIX_FOR_EMAIL_ID != 'SERVER_NAME') {
  914. return $conf->global->MAIL_PREFIX_FOR_EMAIL_ID;
  915. } elseif (isset($_SERVER["SERVER_NAME"])) { // If MAIL_PREFIX_FOR_EMAIL_ID is set to 'SERVER_NAME'
  916. return $_SERVER["SERVER_NAME"];
  917. }
  918. }
  919. // The recommended value if MAIL_PREFIX_FOR_EMAIL_ID is not defined (may be not defined for old versions)
  920. if (!empty($conf->file->instance_unique_id)) {
  921. return sha1('dolibarr'.$conf->file->instance_unique_id);
  922. }
  923. // For backward compatibility when instance_unique_id is not set
  924. return sha1(DOL_DOCUMENT_ROOT.DOL_URL_ROOT);
  925. }
  926. // If prefix is for session (no need to have $conf loaded)
  927. global $dolibarr_main_instance_unique_id, $dolibarr_main_cookie_cryptkey; // This is loaded by filefunc.inc.php
  928. $tmp_instance_unique_id = empty($dolibarr_main_instance_unique_id) ? (empty($dolibarr_main_cookie_cryptkey) ? '' : $dolibarr_main_cookie_cryptkey) : $dolibarr_main_instance_unique_id; // Unique id of instance
  929. // The recommended value (may be not defined for old versions)
  930. if (!empty($tmp_instance_unique_id)) {
  931. return sha1('dolibarr'.$tmp_instance_unique_id);
  932. }
  933. // For backward compatibility when instance_unique_id is not set
  934. if (isset($_SERVER["SERVER_NAME"]) && isset($_SERVER["DOCUMENT_ROOT"])) {
  935. return sha1($_SERVER["SERVER_NAME"].$_SERVER["DOCUMENT_ROOT"].DOL_DOCUMENT_ROOT.DOL_URL_ROOT);
  936. } else {
  937. return sha1(DOL_DOCUMENT_ROOT.DOL_URL_ROOT);
  938. }
  939. }
  940. }
  941. /**
  942. * Make an include_once using default root and alternate root if it fails.
  943. * To link to a core file, use include(DOL_DOCUMENT_ROOT.'/pathtofile')
  944. * To link to a module file from a module file, use include './mymodulefile';
  945. * To link to a module file from a core file, then this function can be used (call by hook / trigger / speciales pages)
  946. *
  947. * @param string $relpath Relative path to file (Ie: mydir/myfile, ../myfile, ...)
  948. * @param string $classname Class name (deprecated)
  949. * @return bool True if load is a success, False if it fails
  950. */
  951. function dol_include_once($relpath, $classname = '')
  952. {
  953. global $conf, $langs, $user, $mysoc; // Do not remove this. They must be defined for files we include. Other globals var must be retrieved with $GLOBALS['var']
  954. $fullpath = dol_buildpath($relpath);
  955. if (!file_exists($fullpath)) {
  956. dol_syslog('functions::dol_include_once Tried to load unexisting file: '.$relpath, LOG_WARNING);
  957. return false;
  958. }
  959. if (!empty($classname) && !class_exists($classname)) {
  960. return include $fullpath;
  961. } else {
  962. return include_once $fullpath;
  963. }
  964. }
  965. /**
  966. * Return path of url or filesystem. Can check into alternate dir or alternate dir + main dir depending on value of $returnemptyifnotfound.
  967. *
  968. * @param string $path Relative path to file (if mode=0) or relative url (if mode=1). Ie: mydir/myfile, ../myfile
  969. * @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)
  970. * @param int $returnemptyifnotfound 0:If $type==0 and if file was not found into alternate dir, return default path into main dir (no test on it)
  971. * 1:If $type==0 and if file was not found into alternate dir, return empty string
  972. * 2:If $type==0 and if file was not found into alternate dir, test into main dir, return default path if found, empty string if not found
  973. * @return string Full filesystem path (if path=0) or '' if file not found, Full url path (if mode=1)
  974. */
  975. function dol_buildpath($path, $type = 0, $returnemptyifnotfound = 0)
  976. {
  977. global $conf;
  978. $path = preg_replace('/^\//', '', $path);
  979. if (empty($type)) { // For a filesystem path
  980. $res = DOL_DOCUMENT_ROOT.'/'.$path; // Standard default path
  981. if (is_array($conf->file->dol_document_root)) {
  982. foreach ($conf->file->dol_document_root as $key => $dirroot) { // ex: array("main"=>"/home/main/htdocs", "alt0"=>"/home/dirmod/htdocs", ...)
  983. if ($key == 'main') {
  984. continue;
  985. }
  986. if (file_exists($dirroot.'/'.$path)) {
  987. $res = $dirroot.'/'.$path;
  988. return $res;
  989. }
  990. }
  991. }
  992. if ($returnemptyifnotfound) {
  993. // Not found into alternate dir
  994. if ($returnemptyifnotfound == 1 || !file_exists($res)) {
  995. return '';
  996. }
  997. }
  998. } else {
  999. // For an url path
  1000. // We try to get local path of file on filesystem from url
  1001. // Note that trying to know if a file on disk exist by forging path on disk from url
  1002. // works only for some web server and some setup. This is bugged when
  1003. // using proxy, rewriting, virtual path, etc...
  1004. $res = '';
  1005. if ($type == 1) {
  1006. $res = DOL_URL_ROOT.'/'.$path; // Standard value
  1007. }
  1008. if ($type == 2) {
  1009. $res = DOL_MAIN_URL_ROOT.'/'.$path; // Standard value
  1010. }
  1011. if ($type == 3) {
  1012. $res = DOL_URL_ROOT.'/'.$path;
  1013. }
  1014. foreach ($conf->file->dol_document_root as $key => $dirroot) { // ex: array(["main"]=>"/home/main/htdocs", ["alt0"]=>"/home/dirmod/htdocs", ...)
  1015. if ($key == 'main') {
  1016. if ($type == 3) {
  1017. global $dolibarr_main_url_root;
  1018. // Define $urlwithroot
  1019. $urlwithouturlroot = preg_replace('/'.preg_quote(DOL_URL_ROOT, '/').'$/i', '', trim($dolibarr_main_url_root));
  1020. $urlwithroot = $urlwithouturlroot.DOL_URL_ROOT; // This is to use external domain name found into config file
  1021. //$urlwithroot=DOL_MAIN_URL_ROOT; // This is to use same domain name than current
  1022. $res = (preg_match('/^http/i', $conf->file->dol_url_root[$key]) ? '' : $urlwithroot).'/'.$path; // Test on start with http is for old conf syntax
  1023. }
  1024. continue;
  1025. }
  1026. preg_match('/^([^\?]+(\.css\.php|\.css|\.js\.php|\.js|\.png|\.jpg|\.php)?)/i', $path, $regs); // Take part before '?'
  1027. if (!empty($regs[1])) {
  1028. //print $key.'-'.$dirroot.'/'.$path.'-'.$conf->file->dol_url_root[$type].'<br>'."\n";
  1029. if (file_exists($dirroot.'/'.$regs[1])) {
  1030. if ($type == 1) {
  1031. $res = (preg_match('/^http/i', $conf->file->dol_url_root[$key]) ? '' : DOL_URL_ROOT).$conf->file->dol_url_root[$key].'/'.$path;
  1032. }
  1033. if ($type == 2) {
  1034. $res = (preg_match('/^http/i', $conf->file->dol_url_root[$key]) ? '' : DOL_MAIN_URL_ROOT).$conf->file->dol_url_root[$key].'/'.$path;
  1035. }
  1036. if ($type == 3) {
  1037. global $dolibarr_main_url_root;
  1038. // Define $urlwithroot
  1039. $urlwithouturlroot = preg_replace('/'.preg_quote(DOL_URL_ROOT, '/').'$/i', '', trim($dolibarr_main_url_root));
  1040. $urlwithroot = $urlwithouturlroot.DOL_URL_ROOT; // This is to use external domain name found into config file
  1041. //$urlwithroot=DOL_MAIN_URL_ROOT; // This is to use same domain name than current
  1042. $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
  1043. }
  1044. break;
  1045. }
  1046. }
  1047. }
  1048. }
  1049. return $res;
  1050. }
  1051. /**
  1052. * Create a clone of instance of object (new instance with same value for properties)
  1053. * With native = 0: Property that are reference are also new object (full isolation clone). This means $this->db of new object is not valid.
  1054. * With native = 1: Use PHP clone. Property that are reference are same pointer. This means $this->db of new object is still valid but point to same this->db than original object.
  1055. *
  1056. * @param object $object Object to clone
  1057. * @param int $native 0=Full isolation method, 1=Native PHP method
  1058. * @return object Clone object
  1059. * @see https://php.net/manual/language.oop5.cloning.php
  1060. */
  1061. function dol_clone($object, $native = 0)
  1062. {
  1063. if (empty($native)) {
  1064. $tmpsavdb = null;
  1065. if (isset($object->db) && isset($object->db->db) && is_object($object->db->db) && get_class($object->db->db) == 'PgSql\Connection') {
  1066. $tmpsavdb = $object->db;
  1067. unset($object->db); // Such property can not be serialized when PgSql/Connection
  1068. }
  1069. $myclone = unserialize(serialize($object)); // serialize then unserialize is hack to be sure to have a new object for all fields
  1070. if ($tmpsavdb) {
  1071. $object->db = $tmpsavdb;
  1072. }
  1073. } else {
  1074. $myclone = clone $object; // PHP clone is a shallow copy only, not a real clone, so properties of references will keep the reference (refering to the same target/variable)
  1075. }
  1076. return $myclone;
  1077. }
  1078. /**
  1079. * Optimize a size for some browsers (phone, smarphone, ...)
  1080. *
  1081. * @param int $size Size we want
  1082. * @param string $type Type of optimizing:
  1083. * '' = function used to define a size for truncation
  1084. * 'width' = function is used to define a width
  1085. * @return int New size after optimizing
  1086. */
  1087. function dol_size($size, $type = '')
  1088. {
  1089. global $conf;
  1090. if (empty($conf->dol_optimize_smallscreen)) {
  1091. return $size;
  1092. }
  1093. if ($type == 'width' && $size > 250) {
  1094. return 250;
  1095. } else {
  1096. return 10;
  1097. }
  1098. }
  1099. /**
  1100. * Clean a string to use it as a file name.
  1101. * Replace also '--' and ' -' strings, they are used for parameters separation (Note: ' - ' is allowed).
  1102. *
  1103. * @param string $str String to clean
  1104. * @param string $newstr String to replace bad chars with.
  1105. * @param int $unaccent 1=Remove also accent (default), 0 do not remove them
  1106. * @return string String cleaned (a-zA-Z_)
  1107. *
  1108. * @see dol_string_nospecial(), dol_string_unaccent(), dol_sanitizePathName()
  1109. */
  1110. function dol_sanitizeFileName($str, $newstr = '_', $unaccent = 1)
  1111. {
  1112. // List of special chars for filenames in windows are defined on page https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file
  1113. // Char '>' '<' '|' '$' and ';' are special chars for shells.
  1114. // Char '/' and '\' are file delimiters.
  1115. // Chars '--' can be used into filename to inject special paramaters like --use-compress-program to make command with file as parameter making remote execution of command
  1116. $filesystem_forbidden_chars = array('<', '>', '/', '\\', '?', '*', '|', '"', ':', '°', '$', ';');
  1117. $tmp = dol_string_nospecial($unaccent ? dol_string_unaccent($str) : $str, $newstr, $filesystem_forbidden_chars);
  1118. $tmp = preg_replace('/\-\-+/', '_', $tmp);
  1119. $tmp = preg_replace('/\s+\-([^\s])/', ' _$1', $tmp);
  1120. $tmp = str_replace('..', '', $tmp);
  1121. return $tmp;
  1122. }
  1123. /**
  1124. * Clean a string to use it as a path name.
  1125. * Replace also '--' and ' -' strings, they are used for parameters separation (Note: ' - ' is allowed).
  1126. *
  1127. * @param string $str String to clean
  1128. * @param string $newstr String to replace bad chars with
  1129. * @param int $unaccent 1=Remove also accent (default), 0 do not remove them
  1130. * @return string String cleaned (a-zA-Z_)
  1131. *
  1132. * @see dol_string_nospecial(), dol_string_unaccent(), dol_sanitizeFileName()
  1133. */
  1134. function dol_sanitizePathName($str, $newstr = '_', $unaccent = 1)
  1135. {
  1136. // List of special chars for filenames in windows are defined on page https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file
  1137. // Char '>' '<' '|' '$' and ';' are special chars for shells.
  1138. // Chars '--' can be used into filename to inject special paramaters like --use-compress-program to make command with file as parameter making remote execution of command
  1139. $filesystem_forbidden_chars = array('<', '>', '?', '*', '|', '"', '°', '$', ';');
  1140. $tmp = dol_string_nospecial($unaccent ? dol_string_unaccent($str) : $str, $newstr, $filesystem_forbidden_chars);
  1141. $tmp = preg_replace('/\-\-+/', '_', $tmp);
  1142. $tmp = preg_replace('/\s+\-([^\s])/', ' _$1', $tmp);
  1143. $tmp = str_replace('..', '', $tmp);
  1144. return $tmp;
  1145. }
  1146. /**
  1147. * Clean a string to use it as an URL (into a href or src attribute)
  1148. *
  1149. * @param string $stringtoclean String to clean
  1150. * @param int $type 0=Accept all Url, 1=Clean external Url (keep only relative Url)
  1151. * @return string Escaped string.
  1152. */
  1153. function dol_sanitizeUrl($stringtoclean, $type = 1)
  1154. {
  1155. // We clean string because some hacks try to obfuscate evil strings by inserting non printable chars. Example: 'java(ascci09)scr(ascii00)ipt' is processed like 'javascript' (whatever is place of evil ascii char)
  1156. // We should use dol_string_nounprintableascii but function may not be yet loaded/available
  1157. $stringtoclean = preg_replace('/[\x00-\x1F\x7F]/u', '', $stringtoclean); // /u operator makes UTF8 valid characters being ignored so are not included into the replace
  1158. // We clean html comments because some hacks try to obfuscate evil strings by inserting HTML comments. Example: on<!-- -->error=alert(1)
  1159. $stringtoclean = preg_replace('/<!--[^>]*-->/', '', $stringtoclean);
  1160. $stringtoclean = str_replace('\\', '/', $stringtoclean);
  1161. if ($type == 1) {
  1162. // removing : should disable links to external url like http:aaa)
  1163. // removing ';' should disable "named" html entities encode into an url (we should not have this into an url)
  1164. $stringtoclean = str_replace(array(':', ';', '@'), '', $stringtoclean);
  1165. }
  1166. do {
  1167. $oldstringtoclean = $stringtoclean;
  1168. // removing '&colon' should disable links to external url like http:aaa)
  1169. // removing '&#' should disable "numeric" html entities encode into an url (we should not have this into an url)
  1170. $stringtoclean = str_ireplace(array('javascript', 'vbscript', '&colon', '&#'), '', $stringtoclean);
  1171. } while ($oldstringtoclean != $stringtoclean);
  1172. if ($type == 1) {
  1173. // removing '//' should disable links to external url like //aaa or http//)
  1174. $stringtoclean = preg_replace(array('/^[a-z]*\/\/+/i'), '', $stringtoclean);
  1175. }
  1176. return $stringtoclean;
  1177. }
  1178. /**
  1179. * Clean a string from all accent characters to be used as ref, login or by dol_sanitizeFileName
  1180. *
  1181. * @param string $str String to clean
  1182. * @return string Cleaned string
  1183. *
  1184. * @see dol_sanitizeFilename(), dol_string_nospecial()
  1185. */
  1186. function dol_string_unaccent($str)
  1187. {
  1188. global $conf;
  1189. if (utf8_check($str)) {
  1190. if (extension_loaded('intl') && !empty($conf->global->MAIN_UNACCENT_USE_TRANSLITERATOR)) {
  1191. $transliterator = \Transliterator::createFromRules(':: Any-Latin; :: Latin-ASCII; :: NFD; :: [:Nonspacing Mark:] Remove; :: NFC;', \Transliterator::FORWARD);
  1192. return $transliterator->transliterate($str);
  1193. }
  1194. // See http://www.utf8-chartable.de/
  1195. $string = rawurlencode($str);
  1196. $replacements = array(
  1197. '%C3%80' => 'A', '%C3%81' => 'A', '%C3%82' => 'A', '%C3%83' => 'A', '%C3%84' => 'A', '%C3%85' => 'A',
  1198. '%C3%87' => 'C',
  1199. '%C3%88' => 'E', '%C3%89' => 'E', '%C3%8A' => 'E', '%C3%8B' => 'E',
  1200. '%C3%8C' => 'I', '%C3%8D' => 'I', '%C3%8E' => 'I', '%C3%8F' => 'I',
  1201. '%C3%91' => 'N',
  1202. '%C3%92' => 'O', '%C3%93' => 'O', '%C3%94' => 'O', '%C3%95' => 'O', '%C3%96' => 'O',
  1203. '%C5%A0' => 'S',
  1204. '%C3%99' => 'U', '%C3%9A' => 'U', '%C3%9B' => 'U', '%C3%9C' => 'U',
  1205. '%C3%9D' => 'Y', '%C5%B8' => 'y',
  1206. '%C3%A0' => 'a', '%C3%A1' => 'a', '%C3%A2' => 'a', '%C3%A3' => 'a', '%C3%A4' => 'a', '%C3%A5' => 'a',
  1207. '%C3%A7' => 'c',
  1208. '%C3%A8' => 'e', '%C3%A9' => 'e', '%C3%AA' => 'e', '%C3%AB' => 'e',
  1209. '%C3%AC' => 'i', '%C3%AD' => 'i', '%C3%AE' => 'i', '%C3%AF' => 'i',
  1210. '%C3%B1' => 'n',
  1211. '%C3%B2' => 'o', '%C3%B3' => 'o', '%C3%B4' => 'o', '%C3%B5' => 'o', '%C3%B6' => 'o',
  1212. '%C5%A1' => 's',
  1213. '%C3%B9' => 'u', '%C3%BA' => 'u', '%C3%BB' => 'u', '%C3%BC' => 'u',
  1214. '%C3%BD' => 'y', '%C3%BF' => 'y'
  1215. );
  1216. $string = strtr($string, $replacements);
  1217. $replacements = [];
  1218. foreach(['%CC%8','%CC%9','%CC%A','%CC%B','%CD%8','%CD%9','%CD%A'] as $i) foreach([0,1,2,3,4,5,6,7,8,9,'A','B','C','D','E','F'] as $j)
  1219. $replacements["$i$j"] = '';
  1220. $string = strtr($string, $replacements);
  1221. return rawurldecode($string);
  1222. } else {
  1223. // See http://www.ascii-code.com/
  1224. $string = strtr(
  1225. $str,
  1226. "\xC0\xC1\xC2\xC3\xC4\xC5\xC7
  1227. \xC8\xC9\xCA\xCB\xCC\xCD\xCE\xCF\xD0\xD1
  1228. \xD2\xD3\xD4\xD5\xD8\xD9\xDA\xDB\xDD
  1229. \xE0\xE1\xE2\xE3\xE4\xE5\xE7\xE8\xE9\xEA\xEB
  1230. \xEC\xED\xEE\xEF\xF0\xF1\xF2\xF3\xF4\xF5\xF8
  1231. \xF9\xFA\xFB\xFC\xFD\xFF",
  1232. "AAAAAAC
  1233. EEEEIIIIDN
  1234. OOOOOUUUY
  1235. aaaaaaceeee
  1236. iiiidnooooo
  1237. uuuuyy"
  1238. );
  1239. $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"));
  1240. return $string;
  1241. }
  1242. }
  1243. /**
  1244. * Clean a string from all punctuation characters to use it as a ref or login.
  1245. * This is a more complete function than dol_sanitizeFileName.
  1246. *
  1247. * @param string $str String to clean
  1248. * @param string $newstr String to replace forbidden chars with
  1249. * @param array|string $badcharstoreplace Array of forbidden characters to replace. Use '' to keep default list.
  1250. * @param array|string $badcharstoremove Array of forbidden characters to remove. Use '' to keep default list.
  1251. * @return string Cleaned string
  1252. *
  1253. * @see dol_sanitizeFilename(), dol_string_unaccent(), dol_string_nounprintableascii()
  1254. */
  1255. function dol_string_nospecial($str, $newstr = '_', $badcharstoreplace = '', $badcharstoremove = '')
  1256. {
  1257. $forbidden_chars_to_replace = array(" ", "'", "/", "\\", ":", "*", "?", "\"", "<", ">", "|", "[", "]", ",", ";", "=", '°'); // more complete than dol_sanitizeFileName
  1258. $forbidden_chars_to_remove = array();
  1259. //$forbidden_chars_to_remove=array("(",")");
  1260. if (is_array($badcharstoreplace)) {
  1261. $forbidden_chars_to_replace = $badcharstoreplace;
  1262. }
  1263. if (is_array($badcharstoremove)) {
  1264. $forbidden_chars_to_remove = $badcharstoremove;
  1265. }
  1266. return str_replace($forbidden_chars_to_replace, $newstr, str_replace($forbidden_chars_to_remove, "", $str));
  1267. }
  1268. /**
  1269. * Clean a string from all non printable ASCII chars (0x00-0x1F and 0x7F). It can also removes also Tab-CR-LF. UTF8 chars remains.
  1270. * This can be used to sanitize a string and view its real content. Some hacks try to obfuscate attacks by inserting non printable chars.
  1271. * Note, for information: UTF8 on 1 byte are: \x00-\7F
  1272. * 2 bytes are: byte 1 \xc0-\xdf, byte 2 = \x80-\xbf
  1273. * 3 bytes are: byte 1 \xe0-\xef, byte 2 = \x80-\xbf, byte 3 = \x80-\xbf
  1274. * 4 bytes are: byte 1 \xf0-\xf7, byte 2 = \x80-\xbf, byte 3 = \x80-\xbf, byte 4 = \x80-\xbf
  1275. * @param string $str String to clean
  1276. * @param int $removetabcrlf Remove also CR-LF
  1277. * @return string Cleaned string
  1278. *
  1279. * @see dol_sanitizeFilename(), dol_string_unaccent(), dol_string_nospecial()
  1280. */
  1281. function dol_string_nounprintableascii($str, $removetabcrlf = 1)
  1282. {
  1283. if ($removetabcrlf) {
  1284. return preg_replace('/[\x00-\x1F\x7F]/u', '', $str); // /u operator makes UTF8 valid characters being ignored so are not included into the replace
  1285. } else {
  1286. return preg_replace('/[\x00-\x08\x11-\x12\x14-\x1F\x7F]/u', '', $str); // /u operator should make UTF8 valid characters being ignored so are not included into the replace
  1287. }
  1288. }
  1289. /**
  1290. * Returns text escaped for inclusion into javascript code
  1291. *
  1292. * @param string $stringtoescape String to escape
  1293. * @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 \
  1294. * @param int $noescapebackslashn 0=Escape also \n. 1=Do not escape \n.
  1295. * @return string Escaped string. Both ' and " are escaped into ' if they are escaped.
  1296. */
  1297. function dol_escape_js($stringtoescape, $mode = 0, $noescapebackslashn = 0)
  1298. {
  1299. // escape quotes and backslashes, newlines, etc.
  1300. $substitjs = array("&#039;"=>"\\'", "\r"=>'\\r');
  1301. //$substitjs['</']='<\/'; // We removed this. Should be useless.
  1302. if (empty($noescapebackslashn)) {
  1303. $substitjs["\n"] = '\\n';
  1304. $substitjs['\\'] = '\\\\';
  1305. }
  1306. if (empty($mode)) {
  1307. $substitjs["'"] = "\\'";
  1308. $substitjs['"'] = "\\'";
  1309. } elseif ($mode == 1) {
  1310. $substitjs["'"] = "\\'";
  1311. } elseif ($mode == 2) {
  1312. $substitjs['"'] = '\\"';
  1313. } elseif ($mode == 3) {
  1314. $substitjs["'"] = "\\'";
  1315. $substitjs['"'] = "\\\"";
  1316. }
  1317. return strtr($stringtoescape, $substitjs);
  1318. }
  1319. /**
  1320. * Returns text escaped for inclusion into javascript code
  1321. *
  1322. * @param string $stringtoescape String to escape
  1323. * @return string Escaped string for json content.
  1324. */
  1325. function dol_escape_json($stringtoescape)
  1326. {
  1327. return str_replace('"', '\"', $stringtoescape);
  1328. }
  1329. /**
  1330. * Returns text escaped for inclusion in HTML alt or title tags, or into values of HTML input fields.
  1331. *
  1332. * @param string $stringtoescape String to escape
  1333. * @param int $keepb 1=Keep b tags, 0=remove them completely
  1334. * @param int $keepn 1=Preserve \r\n strings (otherwise, replace them with escaped value). Set to 1 when escaping for a <textarea>.
  1335. * @param string $noescapetags '' or 'common' or list of tags to not escape. TODO Does not works yet when there is attributes to tag.
  1336. * @param int $escapeonlyhtmltags 1=Escape only html tags, not the special chars like accents.
  1337. * @return string Escaped string
  1338. * @see dol_string_nohtmltag(), dol_string_nospecial(), dol_string_unaccent()
  1339. */
  1340. function dol_escape_htmltag($stringtoescape, $keepb = 0, $keepn = 0, $noescapetags = '', $escapeonlyhtmltags = 0)
  1341. {
  1342. if ($noescapetags == 'common') {
  1343. $noescapetags = 'html,body,a,b,em,hr,i,u,ul,li,br,div,img,font,p,span,strong,table,tr,td,th,tbody';
  1344. }
  1345. // escape quotes and backslashes, newlines, etc.
  1346. if ($escapeonlyhtmltags) {
  1347. $tmp = htmlspecialchars_decode((string) $stringtoescape, ENT_COMPAT);
  1348. } else {
  1349. $tmp = html_entity_decode((string) $stringtoescape, ENT_COMPAT, 'UTF-8');
  1350. }
  1351. if (!$keepb) {
  1352. $tmp = strtr($tmp, array("<b>"=>'', '</b>'=>''));
  1353. }
  1354. if (!$keepn) {
  1355. $tmp = strtr($tmp, array("\r"=>'\\r', "\n"=>'\\n'));
  1356. }
  1357. if ($escapeonlyhtmltags) {
  1358. return htmlspecialchars($tmp, ENT_COMPAT, 'UTF-8');
  1359. } else {
  1360. // Escape tags to keep
  1361. // TODO Does not works yet when there is attributes to tag
  1362. $tmparrayoftags = array();
  1363. if ($noescapetags) {
  1364. $tmparrayoftags = explode(',', $noescapetags);
  1365. }
  1366. if (count($tmparrayoftags)) {
  1367. foreach ($tmparrayoftags as $tagtoreplace) {
  1368. $tmp = str_ireplace('<'.$tagtoreplace.'>', '__BEGINTAGTOREPLACE'.$tagtoreplace.'__', $tmp);
  1369. $tmp = str_ireplace('</'.$tagtoreplace.'>', '__ENDTAGTOREPLACE'.$tagtoreplace.'__', $tmp);
  1370. $tmp = str_ireplace('<'.$tagtoreplace.' />', '__BEGINENDTAGTOREPLACE'.$tagtoreplace.'__', $tmp);
  1371. }
  1372. }
  1373. $result = htmlentities($tmp, ENT_COMPAT, 'UTF-8');
  1374. if (count($tmparrayoftags)) {
  1375. foreach ($tmparrayoftags as $tagtoreplace) {
  1376. $result = str_ireplace('__BEGINTAGTOREPLACE'.$tagtoreplace.'__', '<'.$tagtoreplace.'>', $result);
  1377. $result = str_ireplace('__ENDTAGTOREPLACE'.$tagtoreplace.'__', '</'.$tagtoreplace.'>', $result);
  1378. $result = str_ireplace('__BEGINENDTAGTOREPLACE'.$tagtoreplace.'__', '<'.$tagtoreplace.' />', $result);
  1379. }
  1380. }
  1381. return $result;
  1382. }
  1383. }
  1384. /**
  1385. * Convert a string to lower. Never use strtolower because it does not works with UTF8 strings.
  1386. *
  1387. * @param string $string String to encode
  1388. * @param string $encoding Character set encoding
  1389. * @return string String converted
  1390. */
  1391. function dol_strtolower($string, $encoding = "UTF-8")
  1392. {
  1393. if (function_exists('mb_strtolower')) {
  1394. return mb_strtolower($string, $encoding);
  1395. } else {
  1396. return strtolower($string);
  1397. }
  1398. }
  1399. /**
  1400. * Convert a string to upper. Never use strtolower because it does not works with UTF8 strings.
  1401. *
  1402. * @param string $string String to encode
  1403. * @param string $encoding Character set encoding
  1404. * @return string String converted
  1405. */
  1406. function dol_strtoupper($string, $encoding = "UTF-8")
  1407. {
  1408. if (function_exists('mb_strtoupper')) {
  1409. return mb_strtoupper($string, $encoding);
  1410. } else {
  1411. return strtoupper($string);
  1412. }
  1413. }
  1414. /**
  1415. * Convert first character of the first word of a string to upper. Never use ucfirst because it does not works with UTF8 strings.
  1416. *
  1417. * @param string $string String to encode
  1418. * @param string $encoding Character set encodign
  1419. * @return string String converted
  1420. */
  1421. function dol_ucfirst($string, $encoding = "UTF-8")
  1422. {
  1423. if (function_exists('mb_substr')) {
  1424. return mb_strtoupper(mb_substr($string, 0, 1, $encoding), $encoding).mb_substr($string, 1, null, $encoding);
  1425. } else {
  1426. return ucfirst($string);
  1427. }
  1428. }
  1429. /**
  1430. * Convert first character of all the words of a string to upper. Never use ucfirst because it does not works with UTF8 strings.
  1431. *
  1432. * @param string $string String to encode
  1433. * @param string $encoding Character set encodign
  1434. * @return string String converted
  1435. */
  1436. function dol_ucwords($string, $encoding = "UTF-8")
  1437. {
  1438. if (function_exists('mb_convert_case')) {
  1439. return mb_convert_case($string, MB_CASE_TITLE, $encoding);
  1440. } else {
  1441. return ucwords($string);
  1442. }
  1443. }
  1444. /**
  1445. * Write log message into outputs. Possible outputs can be:
  1446. * SYSLOG_HANDLERS = ["mod_syslog_file"] file name is then defined by SYSLOG_FILE
  1447. * SYSLOG_HANDLERS = ["mod_syslog_syslog"] facility is then defined by SYSLOG_FACILITY
  1448. * Warning, syslog functions are bugged on Windows, generating memory protection faults. To solve
  1449. * this, use logging to files instead of syslog (see setup of module).
  1450. * Note: If constant 'SYSLOG_FILE_NO_ERROR' defined, we never output any error message when writing to log fails.
  1451. * Note: You can get log message into html sources by adding parameter &logtohtml=1 (constant MAIN_LOGTOHTML must be set)
  1452. * This function works only if syslog module is enabled.
  1453. * This must not use any call to other function calling dol_syslog (avoid infinite loop).
  1454. *
  1455. * @param string $message Line to log. ''=Show nothing
  1456. * @param int $level Log level
  1457. * 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
  1458. * On Linux LOG_ERR=3, LOG_WARNING=4, LOG_NOTICE=5, LOG_INFO=6, LOG_DEBUG=7
  1459. * @param int $ident 1=Increase ident of 1, -1=Decrease ident of 1
  1460. * @param string $suffixinfilename When output is a file, append this suffix into default log filename.
  1461. * @param string $restricttologhandler Force output of log only to this log handler
  1462. * @param array|null $logcontext If defined, an array with extra informations (can be used by some log handlers)
  1463. * @return void
  1464. */
  1465. function dol_syslog($message, $level = LOG_INFO, $ident = 0, $suffixinfilename = '', $restricttologhandler = '', $logcontext = null)
  1466. {
  1467. global $conf, $user, $debugbar;
  1468. // If syslog module enabled
  1469. if (empty($conf->syslog->enabled)) {
  1470. return;
  1471. }
  1472. // Check if we are into execution of code of a website
  1473. if (defined('USEEXTERNALSERVER') && !defined('USEDOLIBARRSERVER') && !defined('USEDOLIBARREDITOR')) {
  1474. global $website, $websitekey;
  1475. if (is_object($website) && !empty($website->ref)) {
  1476. $suffixinfilename .= '_website_'.$website->ref;
  1477. } elseif (!empty($websitekey)) {
  1478. $suffixinfilename .= '_website_'.$websitekey;
  1479. }
  1480. }
  1481. // Check if we have a forced suffix
  1482. if (defined('USESUFFIXINLOG')) {
  1483. $suffixinfilename .= constant('USESUFFIXINLOG');
  1484. }
  1485. if ($ident < 0) {
  1486. foreach ($conf->loghandlers as $loghandlerinstance) {
  1487. $loghandlerinstance->setIdent($ident);
  1488. }
  1489. }
  1490. if (!empty($message)) {
  1491. // Test log level
  1492. $logLevels = array(LOG_EMERG=>'EMERG', LOG_ALERT=>'ALERT', LOG_CRIT=>'CRITICAL', LOG_ERR=>'ERR', LOG_WARNING=>'WARN', LOG_NOTICE=>'NOTICE', LOG_INFO=>'INFO', LOG_DEBUG=>'DEBUG');
  1493. if (!array_key_exists($level, $logLevels)) {
  1494. throw new Exception('Incorrect log level');
  1495. }
  1496. if ($level > $conf->global->SYSLOG_LEVEL) {
  1497. return;
  1498. }
  1499. if (empty($conf->global->MAIN_SHOW_PASSWORD_INTO_LOG)) {
  1500. $message = preg_replace('/password=\'[^\']*\'/', 'password=\'hidden\'', $message); // protection to avoid to have value of password in log
  1501. }
  1502. // If adding log inside HTML page is required
  1503. if ((!empty($_REQUEST['logtohtml']) && !empty($conf->global->MAIN_ENABLE_LOG_TO_HTML))
  1504. || (!empty($user->rights->debugbar->read) && is_object($debugbar))) {
  1505. $conf->logbuffer[] = dol_print_date(time(), "%Y-%m-%d %H:%M:%S")." ".$logLevels[$level]." ".$message;
  1506. }
  1507. //TODO: Remove this. MAIN_ENABLE_LOG_INLINE_HTML should be deprecated and use a log handler dedicated to HTML output
  1508. // If html log tag enabled and url parameter log defined, we show output log on HTML comments
  1509. if (!empty($conf->global->MAIN_ENABLE_LOG_INLINE_HTML) && !empty($_GET["log"])) {
  1510. print "\n\n<!-- Log start\n";
  1511. print dol_escape_htmltag($message)."\n";
  1512. print "Log end -->\n";
  1513. }
  1514. $data = array(
  1515. 'message' => $message,
  1516. 'script' => (isset($_SERVER['PHP_SELF']) ? basename($_SERVER['PHP_SELF'], '.php') : false),
  1517. 'level' => $level,
  1518. 'user' => ((is_object($user) && $user->id) ? $user->login : false),
  1519. 'ip' => false
  1520. );
  1521. $remoteip = getUserRemoteIP(); // Get ip when page run on a web server
  1522. if (!empty($remoteip)) {
  1523. $data['ip'] = $remoteip;
  1524. // This is when server run behind a reverse proxy
  1525. if (!empty($_SERVER['HTTP_X_FORWARDED_FOR']) && $_SERVER['HTTP_X_FORWARDED_FOR'] != $remoteip) {
  1526. $data['ip'] = $_SERVER['HTTP_X_FORWARDED_FOR'].' -> '.$data['ip'];
  1527. } elseif (!empty($_SERVER['HTTP_CLIENT_IP']) && $_SERVER['HTTP_CLIENT_IP'] != $remoteip) {
  1528. $data['ip'] = $_SERVER['HTTP_CLIENT_IP'].' -> '.$data['ip'];
  1529. }
  1530. } elseif (!empty($_SERVER['SERVER_ADDR'])) {
  1531. // This is when PHP session is ran inside a web server but not inside a client request (example: init code of apache)
  1532. $data['ip'] = $_SERVER['SERVER_ADDR'];
  1533. } elseif (!empty($_SERVER['COMPUTERNAME'])) {
  1534. // 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).
  1535. $data['ip'] = $_SERVER['COMPUTERNAME'].(empty($_SERVER['USERNAME']) ? '' : '@'.$_SERVER['USERNAME']);
  1536. } elseif (!empty($_SERVER['LOGNAME'])) {
  1537. // 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).
  1538. $data['ip'] = '???@'.$_SERVER['LOGNAME'];
  1539. }
  1540. // Loop on each log handler and send output
  1541. foreach ($conf->loghandlers as $loghandlerinstance) {
  1542. if ($restricttologhandler && $loghandlerinstance->code != $restricttologhandler) {
  1543. continue;
  1544. }
  1545. $loghandlerinstance->export($data, $suffixinfilename);
  1546. }
  1547. unset($data);
  1548. }
  1549. if ($ident > 0) {
  1550. foreach ($conf->loghandlers as $loghandlerinstance) {
  1551. $loghandlerinstance->setIdent($ident);
  1552. }
  1553. }
  1554. }
  1555. /**
  1556. * Return HTML code to output a button to open a dialog popup box.
  1557. * Such buttons must be included inside a HTML form.
  1558. *
  1559. * @param string $name A name for the html component
  1560. * @param string $label Label shown in Popup title top bar
  1561. * @param string $buttonstring button string
  1562. * @param string $url Url to open
  1563. * @param string $disabled Disabled text
  1564. * @param string $morecss More CSS
  1565. * @param string $backtopagejsfields The back to page must be managed using javascript instead of a redirect.
  1566. * Value is 'keyforpopupid:Name_of_html_component_to_set_with id,Name_of_html_component_to_set_with_label'
  1567. * @return string HTML component with button
  1568. */
  1569. function dolButtonToOpenUrlInDialogPopup($name, $label, $buttonstring, $url, $disabled = '', $morecss = 'button bordertransp', $backtopagejsfields = '')
  1570. {
  1571. if (strpos($url, '?') > 0) {
  1572. $url .= '&dol_hide_topmenu=1&dol_hide_leftmenu=1&dol_openinpopup='.urlencode($name);
  1573. } else {
  1574. $url .= '?dol_hide_topmenu=1&dol_hide_leftmenu=1&dol_openinpopup='.urlencode($name);
  1575. }
  1576. $out = '';
  1577. $backtopagejsfieldsid = ''; $backtopagejsfieldslabel = '';
  1578. if ($backtopagejsfields) {
  1579. $tmpbacktopagejsfields = explode(':', $backtopagejsfields);
  1580. if (empty($tmpbacktopagejsfields[1])) { // If the part 'keyforpopupid:' is missing, we add $name for it.
  1581. $backtopagejsfields = $name.":".$backtopagejsfields;
  1582. $tmp2backtopagejsfields = explode(',', $tmpbacktopagejsfields[0]);
  1583. } else {
  1584. $tmp2backtopagejsfields = explode(',', $tmpbacktopagejsfields[1]);
  1585. }
  1586. $backtopagejsfieldsid = empty($tmp2backtopagejsfields[0]) ? '' : $tmp2backtopagejsfields[0];
  1587. $backtopagejsfieldslabel = empty($tmp2backtopagejsfields[1]) ? '' : $tmp2backtopagejsfields[1];
  1588. $url .= '&backtopagejsfields='.urlencode($backtopagejsfields);
  1589. }
  1590. //print '<input type="submit" class="button bordertransp"'.$disabled.' value="'.dol_escape_htmltag($langs->trans("MediaFiles")).'" name="file_manager">';
  1591. $out .= '<!-- a link for button to open url into a dialog popup backtopagejsfields = '.$backtopagejsfields.' -->'."\n";
  1592. $out .= '<a class="cursorpointer button_'.$name.($morecss ? ' '.$morecss : '').'"'.$disabled.' title="'.dol_escape_htmltag($label).'">'.$buttonstring.'</a>';
  1593. $out .= '<div id="idfordialog'.$name.'" class="hidden">div for dialog</div>';
  1594. $out .= '<div id="varforreturndialogid'.$name.'" class="hidden">div for returned id</div>';
  1595. $out .= '<div id="varforreturndialoglabel'.$name.'" class="hidden">div for returned label</div>';
  1596. $out .= '<!-- Add js code to open dialog popup on dialog -->';
  1597. $out .= '<script type="text/javascript">
  1598. jQuery(document).ready(function () {
  1599. jQuery(".button_'.$name.'").click(function () {
  1600. console.log(\'Open popup with jQuery(...).dialog() on URL '.dol_escape_js(DOL_URL_ROOT.$url).'\');
  1601. var $tmpdialog = $(\'#idfordialog'.$name.'\');
  1602. $tmpdialog.html(\'<iframe class="iframedialog" id="iframedialog'.$name.'" style="border: 0px;" src="'.DOL_URL_ROOT.$url.'" width="100%" height="98%"></iframe>\');
  1603. $tmpdialog.dialog({
  1604. autoOpen: false,
  1605. modal: true,
  1606. height: (window.innerHeight - 150),
  1607. width: \'80%\',
  1608. title: \''.dol_escape_js($label).'\',
  1609. open: function (event, ui) {
  1610. console.log("open popup name='.$name.', backtopagejsfields='.$backtopagejsfields.'");
  1611. },
  1612. close: function (event, ui) {
  1613. returnedid = jQuery("#varforreturndialogid'.$name.'").text();
  1614. returnedlabel = jQuery("#varforreturndialoglabel'.$name.'").text();
  1615. console.log("popup has been closed. returnedid (js var defined into parent page)="+returnedid+" returnedlabel="+returnedlabel);
  1616. if (returnedid != "" && returnedid != "div for returned id") {
  1617. jQuery("#'.(empty($backtopagejsfieldsid)?"none":$backtopagejsfieldsid).'").val(returnedid);
  1618. }
  1619. if (returnedlabel != "" && returnedlabel != "div for returned label") {
  1620. jQuery("#'.(empty($backtopagejsfieldslabel)?"none":$backtopagejsfieldslabel).'").val(returnedlabel);
  1621. }
  1622. }
  1623. });
  1624. $tmpdialog.dialog(\'open\');
  1625. });
  1626. });
  1627. </script>';
  1628. return $out;
  1629. }
  1630. /**
  1631. * Show tab header of a card
  1632. *
  1633. * @param array $links Array of tabs. Currently initialized by calling a function xxx_admin_prepare_head
  1634. * @param string $active Active tab name (document', 'info', 'ldap', ....)
  1635. * @param string $title Title
  1636. * @param int $notab -1 or 0=Add tab header, 1=no tab header (if you set this to 1, using print dol_get_fiche_end() to close tab is not required), -2=Add tab header with no seaparation under tab (to start a tab just after)
  1637. * @param string $picto Add a picto on tab title
  1638. * @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.
  1639. * @param string $morehtmlright Add more html content on right of tabs title
  1640. * @param string $morecss More Css
  1641. * @param int $limittoshow Limit number of tabs to show. Use 0 to use automatic default value.
  1642. * @param string $moretabssuffix A suffix to use when you have several dol_get_fiche_head() in same page
  1643. * @return void
  1644. * @deprecated Use print dol_get_fiche_head() instead
  1645. */
  1646. function dol_fiche_head($links = array(), $active = '0', $title = '', $notab = 0, $picto = '', $pictoisfullpath = 0, $morehtmlright = '', $morecss = '', $limittoshow = 0, $moretabssuffix = '')
  1647. {
  1648. print dol_get_fiche_head($links, $active, $title, $notab, $picto, $pictoisfullpath, $morehtmlright, $morecss, $limittoshow, $moretabssuffix);
  1649. }
  1650. /**
  1651. * Show tabs of a record
  1652. *
  1653. * @param array $links Array of tabs. Note that label into $links[$i][1] must be already HTML escaped.
  1654. * @param string $active Active tab name
  1655. * @param string $title Title
  1656. * @param int $notab -1 or 0=Add tab header, 1=no tab header (if you set this to 1, using print dol_get_fiche_end() to close tab is not required), -2=Add tab header with no seaparation under tab (to start a tab just after)
  1657. * @param string $picto Add a picto on tab title
  1658. * @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.
  1659. * @param string $morehtmlright Add more html content on right of tabs title
  1660. * @param string $morecss More CSS on the link <a>
  1661. * @param int $limittoshow Limit number of tabs to show. Use 0 to use automatic default value.
  1662. * @param string $moretabssuffix A suffix to use when you have several dol_get_fiche_head() in same page
  1663. * @return string
  1664. */
  1665. function dol_get_fiche_head($links = array(), $active = '', $title = '', $notab = 0, $picto = '', $pictoisfullpath = 0, $morehtmlright = '', $morecss = '', $limittoshow = 0, $moretabssuffix = '')
  1666. {
  1667. global $conf, $langs, $hookmanager;
  1668. // Show title
  1669. $showtitle = 1;
  1670. if (!empty($conf->dol_optimize_smallscreen)) {
  1671. $showtitle = 0;
  1672. }
  1673. $out = "\n".'<!-- dol_fiche_head - dol_get_fiche_head -->';
  1674. if ((!empty($title) && $showtitle) || $morehtmlright || !empty($links)) {
  1675. $out .= '<div class="tabs'.($picto ? '' : ' nopaddingleft').'" data-role="controlgroup" data-type="horizontal">'."\n";
  1676. }
  1677. // Show right part
  1678. if ($morehtmlright) {
  1679. $out .= '<div class="inline-block floatright tabsElem">'.$morehtmlright.'</div>'; // Output right area first so when space is missing, text is in front of tabs and not under.
  1680. }
  1681. // Show title
  1682. if (!empty($title) && $showtitle && empty($conf->global->MAIN_OPTIMIZEFORTEXTBROWSER)) {
  1683. $limittitle = 30;
  1684. $out .= '<a class="tabTitle">';
  1685. if ($picto) {
  1686. $noprefix = $pictoisfullpath;
  1687. if (strpos($picto, 'fontawesome_') !== false) {
  1688. $noprefix = 1;
  1689. }
  1690. $out .= img_picto($title, ($noprefix ? '' : 'object_').$picto, '', $pictoisfullpath, 0, 0, '', 'imgTabTitle').' ';
  1691. }
  1692. $out .= '<span class="tabTitleText">'.dol_escape_htmltag(dol_trunc($title, $limittitle)).'</span>';
  1693. $out .= '</a>';
  1694. }
  1695. // Show tabs
  1696. // Define max of key (max may be higher than sizeof because of hole due to module disabling some tabs).
  1697. $maxkey = -1;
  1698. if (is_array($links) && !empty($links)) {
  1699. $keys = array_keys($links);
  1700. if (count($keys)) {
  1701. $maxkey = max($keys);
  1702. }
  1703. }
  1704. // Show tabs
  1705. // if =0 we don't use the feature
  1706. if (empty($limittoshow)) {
  1707. $limittoshow = (empty($conf->global->MAIN_MAXTABS_IN_CARD) ? 99 : $conf->global->MAIN_MAXTABS_IN_CARD);
  1708. }
  1709. if (!empty($conf->dol_optimize_smallscreen)) {
  1710. $limittoshow = 2;
  1711. }
  1712. $displaytab = 0;
  1713. $nbintab = 0;
  1714. $popuptab = 0;
  1715. $outmore = '';
  1716. for ($i = 0; $i <= $maxkey; $i++) {
  1717. if ((is_numeric($active) && $i == $active) || (!empty($links[$i][2]) && !is_numeric($active) && $active == $links[$i][2])) {
  1718. // If active tab is already present
  1719. if ($i >= $limittoshow) {
  1720. $limittoshow--;
  1721. }
  1722. }
  1723. }
  1724. for ($i = 0; $i <= $maxkey; $i++) {
  1725. if ((is_numeric($active) && $i == $active) || (!empty($links[$i][2]) && !is_numeric($active) && $active == $links[$i][2])) {
  1726. $isactive = true;
  1727. } else {
  1728. $isactive = false;
  1729. }
  1730. if ($i < $limittoshow || $isactive) {
  1731. // Output entry with a visible tab
  1732. $out .= '<div class="inline-block tabsElem'.($isactive ? ' tabsElemActive' : '').((!$isactive && !empty($conf->global->MAIN_HIDE_INACTIVETAB_ON_PRINT)) ? ' hideonprint' : '').'"><!-- id tab = '.(empty($links[$i][2]) ? '' : dol_escape_htmltag($links[$i][2])).' -->';
  1733. if (isset($links[$i][2]) && $links[$i][2] == 'image') {
  1734. if (!empty($links[$i][0])) {
  1735. $out .= '<a class="tabimage'.($morecss ? ' '.$morecss : '').'" href="'.$links[$i][0].'">'.$links[$i][1].'</a>'."\n";
  1736. } else {
  1737. $out .= '<span class="tabspan">'.$links[$i][1].'</span>'."\n";
  1738. }
  1739. } elseif (!empty($links[$i][1])) {
  1740. //print "x $i $active ".$links[$i][2]." z";
  1741. $out .= '<div class="tab tab'.($isactive?'active':'unactive').'" style="margin: 0 !important">';
  1742. if (!empty($links[$i][0])) {
  1743. $titletoshow = preg_replace('/<.*$/', '', $links[$i][1]);
  1744. $out .= '<a'.(!empty($links[$i][2]) ? ' id="'.$links[$i][2].'"' : '').' class="tab inline-block valignmiddle'.($morecss ? ' '.$morecss : '').'" href="'.$links[$i][0].'" title="'.dol_escape_htmltag($titletoshow).'">';
  1745. }
  1746. $out .= $links[$i][1];
  1747. if (!empty($links[$i][0])) {
  1748. $out .= '</a>'."\n";
  1749. }
  1750. $out .= empty($links[$i][4]) ? '' : $links[$i][4];
  1751. $out .= '</div>';
  1752. }
  1753. $out .= '</div>';
  1754. } else {
  1755. // Add entry into the combo popup with the other tabs
  1756. if (!$popuptab) {
  1757. $popuptab = 1;
  1758. $outmore .= '<div class="popuptabset wordwrap">'; // The css used to hide/show popup
  1759. }
  1760. $outmore .= '<div class="popuptab wordwrap" style="display:inherit;">';
  1761. if (isset($links[$i][2]) && $links[$i][2] == 'image') {
  1762. if (!empty($links[$i][0])) {
  1763. $outmore .= '<a class="tabimage'.($morecss ? ' '.$morecss : '').'" href="'.$links[$i][0].'">'.$links[$i][1].'</a>'."\n";
  1764. } else {
  1765. $outmore .= '<span class="tabspan">'.$links[$i][1].'</span>'."\n";
  1766. }
  1767. } elseif (!empty($links[$i][1])) {
  1768. $outmore .= '<a'.(!empty($links[$i][2]) ? ' id="'.$links[$i][2].'"' : '').' class="wordwrap inline-block'.($morecss ? ' '.$morecss : '').'" href="'.$links[$i][0].'">';
  1769. $outmore .= preg_replace('/([a-z])\/([a-z])/i', '\\1 / \\2', $links[$i][1]); // Replace x/y with x / y to allow wrap on long composed texts.
  1770. $outmore .= '</a>'."\n";
  1771. }
  1772. $outmore .= '</div>';
  1773. $nbintab++;
  1774. }
  1775. $displaytab = $i;
  1776. }
  1777. if ($popuptab) {
  1778. $outmore .= '</div>';
  1779. }
  1780. if ($popuptab) { // If there is some tabs not shown
  1781. $left = ($langs->trans("DIRECTION") == 'rtl' ? 'right' : 'left');
  1782. $right = ($langs->trans("DIRECTION") == 'rtl' ? 'left' : 'right');
  1783. $widthofpopup = 200;
  1784. $tabsname = $moretabssuffix;
  1785. if (empty($tabsname)) {
  1786. $tabsname = str_replace("@", "", $picto);
  1787. }
  1788. $out .= '<div id="moretabs'.$tabsname.'" class="inline-block tabsElem valignmiddle">';
  1789. $out .= '<div class="tab"><a href="#" class="tab moretab inline-block tabunactive"><span class="hideonsmartphone">'.$langs->trans("More").'</span>... ('.$nbintab.')</a></div>'; // Do not use "reposition" class in the "More".
  1790. $out .= '<div id="moretabsList'.$tabsname.'" style="width: '.$widthofpopup.'px; position: absolute; '.$left.': -999em; text-align: '.$left.'; margin:0px; padding:2px; z-index:10;">';
  1791. $out .= $outmore;
  1792. $out .= '</div>';
  1793. $out .= '<div></div>';
  1794. $out .= "</div>\n";
  1795. $out .= "<script>";
  1796. $out .= "$('#moretabs".$tabsname."').mouseenter( function() {
  1797. var x = this.offsetLeft, y = this.offsetTop;
  1798. console.log('mouseenter ".$left." x='+x+' y='+y+' window.innerWidth='+window.innerWidth);
  1799. if ((window.innerWidth - x) < ".($widthofpopup + 10).") {
  1800. $('#moretabsList".$tabsname."').css('".$right."','8px');
  1801. }
  1802. $('#moretabsList".$tabsname."').css('".$left."','auto');
  1803. });
  1804. ";
  1805. $out .= "$('#moretabs".$tabsname."').mouseleave( function() { console.log('mouseleave ".$left."'); $('#moretabsList".$tabsname."').css('".$left."','-999em');});";
  1806. $out .= "</script>";
  1807. }
  1808. if ((!empty($title) && $showtitle) || $morehtmlright || !empty($links)) {
  1809. $out .= "</div>\n";
  1810. }
  1811. if (!$notab || $notab == -1 || $notab == -2) {
  1812. $out .= "\n".'<div class="tabBar'.($notab == -1 ? '' : ($notab == -2 ? ' tabBarNoTop' : ' tabBarWithBottom')).'">'."\n";
  1813. }
  1814. $parameters = array('tabname' => $active, 'out' => $out);
  1815. $reshook = $hookmanager->executeHooks('printTabsHead', $parameters); // This hook usage is called just before output the head of tabs. Take also a look at "completeTabsHead"
  1816. if ($reshook > 0) {
  1817. $out = $hookmanager->resPrint;
  1818. }
  1819. return $out;
  1820. }
  1821. /**
  1822. * Show tab footer of a card
  1823. *
  1824. * @param int $notab -1 or 0=Add tab footer, 1=no tab footer
  1825. * @return void
  1826. * @deprecated Use print dol_get_fiche_end() instead
  1827. */
  1828. function dol_fiche_end($notab = 0)
  1829. {
  1830. print dol_get_fiche_end($notab);
  1831. }
  1832. /**
  1833. * Return tab footer of a card
  1834. *
  1835. * @param int $notab -1 or 0=Add tab footer, 1=no tab footer
  1836. * @return string
  1837. */
  1838. function dol_get_fiche_end($notab = 0)
  1839. {
  1840. if (!$notab || $notab == -1) {
  1841. return "\n</div>\n";
  1842. } else {
  1843. return '';
  1844. }
  1845. }
  1846. /**
  1847. * Show tab footer of a card.
  1848. * Note: $object->next_prev_filter can be set to restrict select to find next or previous record by $form->showrefnav.
  1849. *
  1850. * @param Object $object Object to show
  1851. * @param string $paramid Name of parameter to use to name the id into the URL next/previous link
  1852. * @param string $morehtml More html content to output just before the nav bar
  1853. * @param int $shownav Show Condition (navigation is shown if value is 1)
  1854. * @param string $fieldid Nom du champ en base a utiliser pour select next et previous (we make the select max and min on this field). Use 'none' for no prev/next search.
  1855. * @param string $fieldref Nom du champ objet ref (object->ref) a utiliser pour select next et previous
  1856. * @param string $morehtmlref More html to show after the ref (see $morehtmlleft for before)
  1857. * @param string $moreparam More param to add in nav link url.
  1858. * @param int $nodbprefix Do not include DB prefix to forge table name
  1859. * @param string $morehtmlleft More html code to show before the ref (see $morehtmlref for after)
  1860. * @param string $morehtmlstatus More html code to show under navigation arrows
  1861. * @param int $onlybanner Put this to 1, if the card will contains only a banner (this add css 'arearefnobottom' on div)
  1862. * @param string $morehtmlright More html code to show before navigation arrows
  1863. * @return void
  1864. */
  1865. function dol_banner_tab($object, $paramid, $morehtml = '', $shownav = 1, $fieldid = 'rowid', $fieldref = 'ref', $morehtmlref = '', $moreparam = '', $nodbprefix = 0, $morehtmlleft = '', $morehtmlstatus = '', $onlybanner = 0, $morehtmlright = '')
  1866. {
  1867. global $conf, $form, $user, $langs, $hookmanager, $action;
  1868. $error = 0;
  1869. $maxvisiblephotos = 1;
  1870. $showimage = 1;
  1871. $entity = (empty($object->entity) ? $conf->entity : $object->entity);
  1872. $showbarcode = empty($conf->barcode->enabled) ? 0 : (empty($object->barcode) ? 0 : 1);
  1873. if (!empty($conf->global->MAIN_USE_ADVANCED_PERMS) && empty($user->rights->barcode->lire_advance)) {
  1874. $showbarcode = 0;
  1875. }
  1876. $modulepart = 'unknown';
  1877. if ($object->element == 'societe' || $object->element == 'contact' || $object->element == 'product' || $object->element == 'ticket') {
  1878. $modulepart = $object->element;
  1879. } elseif ($object->element == 'member') {
  1880. $modulepart = 'memberphoto';
  1881. } elseif ($object->element == 'user') {
  1882. $modulepart = 'userphoto';
  1883. }
  1884. if (class_exists("Imagick")) {
  1885. if ($object->element == 'expensereport' || $object->element == 'propal' || $object->element == 'commande' || $object->element == 'facture' || $object->element == 'supplier_proposal') {
  1886. $modulepart = $object->element;
  1887. } elseif ($object->element == 'fichinter') {
  1888. $modulepart = 'ficheinter';
  1889. } elseif ($object->element == 'contrat') {
  1890. $modulepart = 'contract';
  1891. } elseif ($object->element == 'order_supplier') {
  1892. $modulepart = 'supplier_order';
  1893. } elseif ($object->element == 'invoice_supplier') {
  1894. $modulepart = 'supplier_invoice';
  1895. }
  1896. }
  1897. if ($object->element == 'product') {
  1898. $width = 80;
  1899. $cssclass = 'photowithmargin photoref';
  1900. $showimage = $object->is_photo_available($conf->product->multidir_output[$entity]);
  1901. $maxvisiblephotos = (isset($conf->global->PRODUCT_MAX_VISIBLE_PHOTO) ? $conf->global->PRODUCT_MAX_VISIBLE_PHOTO : 5);
  1902. if ($conf->browser->layout == 'phone') {
  1903. $maxvisiblephotos = 1;
  1904. }
  1905. if ($showimage) {
  1906. $morehtmlleft .= '<div class="floatleft inline-block valignmiddle divphotoref">'.$object->show_photos('product', $conf->product->multidir_output[$entity], 'small', $maxvisiblephotos, 0, 0, 0, $width, 0).'</div>';
  1907. } else {
  1908. if (!empty($conf->global->PRODUCT_NODISPLAYIFNOPHOTO)) {
  1909. $nophoto = '';
  1910. $morehtmlleft .= '<div class="floatleft inline-block valignmiddle divphotoref"></div>';
  1911. } else { // Show no photo link
  1912. $nophoto = '/public/theme/common/nophoto.png';
  1913. $morehtmlleft .= '<div class="floatleft inline-block valignmiddle divphotoref"><img class="photo'.$modulepart.($cssclass ? ' '.$cssclass : '').'" alt="No photo"'.($width ? ' style="width: '.$width.'px"' : '').' src="'.DOL_URL_ROOT.$nophoto.'"></div>';
  1914. }
  1915. }
  1916. } elseif ($object->element == 'ticket') {
  1917. $width = 80;
  1918. $cssclass = 'photoref';
  1919. $showimage = $object->is_photo_available($conf->ticket->multidir_output[$entity].'/'.$object->ref);
  1920. $maxvisiblephotos = (isset($conf->global->TICKET_MAX_VISIBLE_PHOTO) ? $conf->global->TICKET_MAX_VISIBLE_PHOTO : 2);
  1921. if ($conf->browser->layout == 'phone') {
  1922. $maxvisiblephotos = 1;
  1923. }
  1924. if ($showimage) {
  1925. $showphoto = $object->show_photos('ticket', $conf->ticket->multidir_output[$entity], 'small', $maxvisiblephotos, 0, 0, 0, $width, 0);
  1926. if ($object->nbphoto > 0) {
  1927. $morehtmlleft .= '<div class="floatleft inline-block valignmiddle divphotoref">'.$showphoto.'</div>';
  1928. } else {
  1929. $showimage = 0;
  1930. }
  1931. }
  1932. if (!$showimage) {
  1933. if (!empty($conf->global->TICKET_NODISPLAYIFNOPHOTO)) {
  1934. $nophoto = '';
  1935. $morehtmlleft .= '<div class="floatleft inline-block valignmiddle divphotoref"></div>';
  1936. } else { // Show no photo link
  1937. $nophoto = img_picto('No photo', 'object_ticket');
  1938. $morehtmlleft .= '<!-- No photo to show -->';
  1939. $morehtmlleft .= '<div class="floatleft inline-block valignmiddle divphotoref"><div class="photoref">';
  1940. $morehtmlleft .= $nophoto;
  1941. $morehtmlleft .= '</div></div>';
  1942. }
  1943. }
  1944. } else {
  1945. if ($showimage) {
  1946. if ($modulepart != 'unknown') {
  1947. $phototoshow = '';
  1948. // Check if a preview file is available
  1949. if (in_array($modulepart, array('propal', 'commande', 'facture', 'ficheinter', 'contract', 'supplier_order', 'supplier_proposal', 'supplier_invoice', 'expensereport')) && class_exists("Imagick")) {
  1950. $objectref = dol_sanitizeFileName($object->ref);
  1951. $dir_output = (empty($conf->$modulepart->multidir_output[$entity]) ? $conf->$modulepart->dir_output : $conf->$modulepart->multidir_output[$entity])."/";
  1952. if (in_array($modulepart, array('invoice_supplier', 'supplier_invoice'))) {
  1953. $subdir = get_exdir($object->id, 2, 0, 1, $object, $modulepart);
  1954. $subdir .= ((!empty($subdir) && !preg_match('/\/$/', $subdir)) ? '/' : '').$objectref; // the objectref dir is not included into get_exdir when used with level=2, so we add it at end
  1955. } else {
  1956. $subdir = get_exdir($object->id, 0, 0, 1, $object, $modulepart);
  1957. }
  1958. if (empty($subdir)) {
  1959. $subdir = 'errorgettingsubdirofobject'; // Protection to avoid to return empty path
  1960. }
  1961. $filepath = $dir_output.$subdir."/";
  1962. $filepdf = $filepath.$objectref.".pdf";
  1963. $relativepath = $subdir.'/'.$objectref.'.pdf';
  1964. // Define path to preview pdf file (preview precompiled "file.ext" are "file.ext_preview.png")
  1965. $fileimage = $filepdf.'_preview.png';
  1966. $relativepathimage = $relativepath.'_preview.png';
  1967. $pdfexists = file_exists($filepdf);
  1968. // If PDF file exists
  1969. if ($pdfexists) {
  1970. // Conversion du PDF en image png si fichier png non existant
  1971. if (!file_exists($fileimage) || (filemtime($fileimage) < filemtime($filepdf))) {
  1972. if (empty($conf->global->MAIN_DISABLE_PDF_THUMBS)) { // If you experience trouble with pdf thumb generation and imagick, you can disable here.
  1973. include_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
  1974. $ret = dol_convert_file($filepdf, 'png', $fileimage, '0'); // Convert first page of PDF into a file _preview.png
  1975. if ($ret < 0) {
  1976. $error++;
  1977. }
  1978. }
  1979. }
  1980. }
  1981. if ($pdfexists && !$error) {
  1982. $heightforphotref = 80;
  1983. if (!empty($conf->dol_optimize_smallscreen)) {
  1984. $heightforphotref = 60;
  1985. }
  1986. // If the preview file is found
  1987. if (file_exists($fileimage)) {
  1988. $phototoshow = '<div class="photoref">';
  1989. $phototoshow .= '<img height="'.$heightforphotref.'" class="photo photowithmargin photowithborder" src="'.DOL_URL_ROOT.'/viewimage.php?modulepart=apercu'.$modulepart.'&amp;file='.urlencode($relativepathimage).'">';
  1990. $phototoshow .= '</div>';
  1991. }
  1992. }
  1993. } elseif (!$phototoshow) { // example if modulepart = 'societe' or 'photo'
  1994. $phototoshow .= $form->showphoto($modulepart, $object, 0, 0, 0, 'photowithmargin photoref', 'small', 1, 0, $maxvisiblephotos);
  1995. }
  1996. if ($phototoshow) {
  1997. $morehtmlleft .= '<div class="floatleft inline-block valignmiddle divphotoref">';
  1998. $morehtmlleft .= $phototoshow;
  1999. $morehtmlleft .= '</div>';
  2000. }
  2001. }
  2002. if (empty($phototoshow)) { // Show No photo link (picto of object)
  2003. if ($object->element == 'action') {
  2004. $width = 80;
  2005. $cssclass = 'photorefcenter';
  2006. $nophoto = img_picto('No photo', 'title_agenda');
  2007. } else {
  2008. $width = 14;
  2009. $cssclass = 'photorefcenter';
  2010. $picto = $object->picto;
  2011. $prefix = 'object_';
  2012. if ($object->element == 'project' && !$object->public) {
  2013. $picto = 'project'; // instead of projectpub
  2014. }
  2015. if (strpos($picto, 'fontawesome_') !== false) {
  2016. $prefix = '';
  2017. }
  2018. $nophoto = img_picto('No photo', $prefix.$picto);
  2019. }
  2020. $morehtmlleft .= '<!-- No photo to show -->';
  2021. $morehtmlleft .= '<div class="floatleft inline-block valignmiddle divphotoref"><div class="photoref">';
  2022. $morehtmlleft .= $nophoto;
  2023. $morehtmlleft .= '</div></div>';
  2024. }
  2025. }
  2026. }
  2027. if ($showbarcode) {
  2028. $morehtmlleft .= '<div class="floatleft inline-block valignmiddle divphotoref">'.$form->showbarcode($object, 100, 'photoref valignmiddle').'</div>';
  2029. }
  2030. if ($object->element == 'societe') {
  2031. if (!empty($conf->use_javascript_ajax) && $user->rights->societe->creer && !empty($conf->global->MAIN_DIRECT_STATUS_UPDATE)) {
  2032. $morehtmlstatus .= ajax_object_onoff($object, 'status', 'status', 'InActivity', 'ActivityCeased');
  2033. } else {
  2034. $morehtmlstatus .= $object->getLibStatut(6);
  2035. }
  2036. } elseif ($object->element == 'product') {
  2037. //$morehtmlstatus.=$langs->trans("Status").' ('.$langs->trans("Sell").') ';
  2038. if (!empty($conf->use_javascript_ajax) && $user->rights->produit->creer && !empty($conf->global->MAIN_DIRECT_STATUS_UPDATE)) {
  2039. $morehtmlstatus .= ajax_object_onoff($object, 'status', 'tosell', 'ProductStatusOnSell', 'ProductStatusNotOnSell');
  2040. } else {
  2041. $morehtmlstatus .= '<span class="statusrefsell">'.$object->getLibStatut(6, 0).'</span>';
  2042. }
  2043. $morehtmlstatus .= ' &nbsp; ';
  2044. //$morehtmlstatus.=$langs->trans("Status").' ('.$langs->trans("Buy").') ';
  2045. if (!empty($conf->use_javascript_ajax) && $user->rights->produit->creer && !empty($conf->global->MAIN_DIRECT_STATUS_UPDATE)) {
  2046. $morehtmlstatus .= ajax_object_onoff($object, 'status_buy', 'tobuy', 'ProductStatusOnBuy', 'ProductStatusNotOnBuy');
  2047. } else {
  2048. $morehtmlstatus .= '<span class="statusrefbuy">'.$object->getLibStatut(6, 1).'</span>';
  2049. }
  2050. } elseif (in_array($object->element, array('facture', 'invoice', 'invoice_supplier', 'chargesociales', 'loan', 'tva', 'salary'))) {
  2051. $tmptxt = $object->getLibStatut(6, $object->totalpaid);
  2052. if (empty($tmptxt) || $tmptxt == $object->getLibStatut(3)) {
  2053. $tmptxt = $object->getLibStatut(5, $object->totalpaid);
  2054. }
  2055. $morehtmlstatus .= $tmptxt;
  2056. } elseif ($object->element == 'contrat' || $object->element == 'contract') {
  2057. if ($object->statut == 0) {
  2058. $morehtmlstatus .= $object->getLibStatut(5);
  2059. } else {
  2060. $morehtmlstatus .= $object->getLibStatut(4);
  2061. }
  2062. } elseif ($object->element == 'facturerec') {
  2063. if ($object->frequency == 0) {
  2064. $morehtmlstatus .= $object->getLibStatut(2);
  2065. } else {
  2066. $morehtmlstatus .= $object->getLibStatut(5);
  2067. }
  2068. } elseif ($object->element == 'project_task') {
  2069. $object->fk_statut = 1;
  2070. if ($object->progress > 0) {
  2071. $object->fk_statut = 2;
  2072. }
  2073. if ($object->progress >= 100) {
  2074. $object->fk_statut = 3;
  2075. }
  2076. $tmptxt = $object->getLibStatut(5);
  2077. $morehtmlstatus .= $tmptxt; // No status on task
  2078. } else { // Generic case
  2079. $tmptxt = $object->getLibStatut(6);
  2080. if (empty($tmptxt) || $tmptxt == $object->getLibStatut(3)) {
  2081. $tmptxt = $object->getLibStatut(5);
  2082. }
  2083. $morehtmlstatus .= $tmptxt;
  2084. }
  2085. // Add if object was dispatched "into accountancy"
  2086. if (!empty($conf->accounting->enabled) && in_array($object->element, array('bank', 'paiementcharge', 'facture', 'invoice', 'invoice_supplier', 'expensereport', 'payment_various'))) {
  2087. // Note: For 'chargesociales', 'salaries'... this is the payments that are dispatched (so element = 'bank')
  2088. if (method_exists($object, 'getVentilExportCompta')) {
  2089. $accounted = $object->getVentilExportCompta();
  2090. $langs->load("accountancy");
  2091. $morehtmlstatus .= '</div><div class="statusref statusrefbis"><span class="opacitymedium">'.($accounted > 0 ? $langs->trans("Accounted") : $langs->trans("NotYetAccounted")).'</span>';
  2092. }
  2093. }
  2094. // Add alias for thirdparty
  2095. if (!empty($object->name_alias)) {
  2096. $morehtmlref .= '<div class="refidno">'.$object->name_alias.'</div>';
  2097. }
  2098. // Add label
  2099. if (in_array($object->element, array('product', 'bank_account', 'project_task'))) {
  2100. if (!empty($object->label)) {
  2101. $morehtmlref .= '<div class="refidno">'.$object->label.'</div>';
  2102. }
  2103. }
  2104. // Show address and email
  2105. if (method_exists($object, 'getBannerAddress') && !in_array($object->element, array('product', 'bookmark', 'ecm_directories', 'ecm_files'))) {
  2106. $moreaddress = $object->getBannerAddress('refaddress', $object);
  2107. if ($moreaddress) {
  2108. $morehtmlref .= '<div class="refidno">';
  2109. $morehtmlref .= $moreaddress;
  2110. $morehtmlref .= '</div>';
  2111. }
  2112. }
  2113. if (!empty($conf->global->MAIN_SHOW_TECHNICAL_ID) && ($conf->global->MAIN_SHOW_TECHNICAL_ID == '1' || preg_match('/'.preg_quote($object->element, '/').'/i', $conf->global->MAIN_SHOW_TECHNICAL_ID)) && !empty($object->id)) {
  2114. $morehtmlref .= '<div style="clear: both;"></div>';
  2115. $morehtmlref .= '<div class="refidno">';
  2116. $morehtmlref .= $langs->trans("TechnicalID").': '.$object->id;
  2117. $morehtmlref .= '</div>';
  2118. }
  2119. $parameters=array('morehtmlref'=>$morehtmlref);
  2120. $reshook = $hookmanager->executeHooks('formDolBanner', $parameters, $object, $action);
  2121. if ($reshook < 0) {
  2122. setEventMessages($hookmanager->error, $hookmanager->errors, 'errors');
  2123. } elseif (empty($reshook)) {
  2124. $morehtmlref .= $hookmanager->resPrint;
  2125. } elseif ($reshook > 0) {
  2126. $morehtmlref = $hookmanager->resPrint;
  2127. }
  2128. print '<div class="'.($onlybanner ? 'arearefnobottom ' : 'arearef ').'heightref valignmiddle centpercent">';
  2129. print $form->showrefnav($object, $paramid, $morehtml, $shownav, $fieldid, $fieldref, $morehtmlref, $moreparam, $nodbprefix, $morehtmlleft, $morehtmlstatus, $morehtmlright);
  2130. print '</div>';
  2131. print '<div class="underrefbanner clearboth"></div>';
  2132. }
  2133. /**
  2134. * Show a string with the label tag dedicated to the HTML edit field.
  2135. *
  2136. * @param string $langkey Translation key
  2137. * @param string $fieldkey Key of the html select field the text refers to
  2138. * @param int $fieldrequired 1=Field is mandatory
  2139. * @return string
  2140. * @deprecated Form::editfieldkey
  2141. */
  2142. function fieldLabel($langkey, $fieldkey, $fieldrequired = 0)
  2143. {
  2144. global $langs;
  2145. $ret = '';
  2146. if ($fieldrequired) {
  2147. $ret .= '<span class="fieldrequired">';
  2148. }
  2149. $ret .= '<label for="'.$fieldkey.'">';
  2150. $ret .= $langs->trans($langkey);
  2151. $ret .= '</label>';
  2152. if ($fieldrequired) {
  2153. $ret .= '</span>';
  2154. }
  2155. return $ret;
  2156. }
  2157. /**
  2158. * Return string to add class property on html element with pair/impair.
  2159. *
  2160. * @param string $var 0 or 1
  2161. * @param string $moreclass More class to add
  2162. * @return string String to add class onto HTML element
  2163. */
  2164. function dol_bc($var, $moreclass = '')
  2165. {
  2166. global $bc;
  2167. $ret = ' '.$bc[$var];
  2168. if ($moreclass) {
  2169. $ret = preg_replace('/class=\"/', 'class="'.$moreclass.' ', $ret);
  2170. }
  2171. return $ret;
  2172. }
  2173. /**
  2174. * Return a formated address (part address/zip/town/state) according to country rules.
  2175. * See https://en.wikipedia.org/wiki/Address
  2176. *
  2177. * @param Object $object A company or contact object
  2178. * @param int $withcountry 1=Add country into address string
  2179. * @param string $sep Separator to use to build string
  2180. * @param Translate $outputlangs Object lang that contains language for text translation.
  2181. * @param int $mode 0=Standard output, 1=Remove address
  2182. * @param string $extralangcode User extralanguage $langcode as values for address, town
  2183. * @return string Formated string
  2184. * @see dol_print_address()
  2185. */
  2186. function dol_format_address($object, $withcountry = 0, $sep = "\n", $outputlangs = '', $mode = 0, $extralangcode = '')
  2187. {
  2188. global $conf, $langs, $hookmanager;
  2189. $ret = '';
  2190. $countriesusingstate = array('AU', 'CA', 'US', 'IN', 'GB', 'ES', 'UK', 'TR', 'CN'); // See also MAIN_FORCE_STATE_INTO_ADDRESS
  2191. // See format of addresses on https://en.wikipedia.org/wiki/Address
  2192. // Address
  2193. if (empty($mode)) {
  2194. $ret .= ($extralangcode ? $object->array_languages['address'][$extralangcode] : (empty($object->address) ? '' : $object->address));
  2195. }
  2196. // Added by MMI Mathieu Moulin iProspective
  2197. // MMIPrestaSync : Complément d'adresse
  2198. if (!empty($object->array_options['options_p_address2'])) {
  2199. $ret .= (empty($object->address) ? '' : ($ret ? $sep : '').$object->array_options['options_p_address2']);
  2200. }
  2201. // Zip/Town/State
  2202. if (isset($object->country_code) && in_array($object->country_code, array('AU', 'CA', 'US', 'CN')) || !empty($conf->global->MAIN_FORCE_STATE_INTO_ADDRESS)) {
  2203. // US: title firstname name \n address lines \n town, state, zip \n country
  2204. $town = ($extralangcode ? $object->array_languages['town'][$extralangcode] : (empty($object->town) ? '' : $object->town));
  2205. $ret .= (($ret && $town) ? $sep : '').$town;
  2206. if (!empty($object->state)) {
  2207. $ret .= ($ret ? ($town ? ", " : $sep) : '').$object->state;
  2208. }
  2209. if (!empty($object->zip)) {
  2210. $ret .= ($ret ? (($town || $object->state) ? ", " : $sep) : '').$object->zip;
  2211. }
  2212. } elseif (isset($object->country_code) && in_array($object->country_code, array('GB', 'UK'))) {
  2213. // UK: title firstname name \n address lines \n town state \n zip \n country
  2214. $town = ($extralangcode ? $object->array_languages['town'][$extralangcode] : (empty($object->town) ? '' : $object->town));
  2215. $ret .= ($ret ? $sep : '').$town;
  2216. if (!empty($object->state)) {
  2217. $ret .= ($ret ? ", " : '').$object->state;
  2218. }
  2219. if (!empty($object->zip)) {
  2220. $ret .= ($ret ? $sep : '').$object->zip;
  2221. }
  2222. } elseif (isset($object->country_code) && in_array($object->country_code, array('ES', 'TR'))) {
  2223. // ES: title firstname name \n address lines \n zip town \n state \n country
  2224. $ret .= ($ret ? $sep : '').$object->zip;
  2225. $town = ($extralangcode ? $object->array_languages['town'][$extralangcode] : (empty($object->town) ? '' : $object->town));
  2226. $ret .= ($town ? (($object->zip ? ' ' : '').$town) : '');
  2227. if (!empty($object->state)) {
  2228. $ret .= "\n".$object->state;
  2229. }
  2230. } elseif (isset($object->country_code) && in_array($object->country_code, array('JP'))) {
  2231. // JP: In romaji, title firstname name\n address lines \n [state,] town zip \n country
  2232. // See https://www.sljfaq.org/afaq/addresses.html
  2233. $town = ($extralangcode ? $object->array_languages['town'][$extralangcode] : (empty($object->town) ? '' : $object->town));
  2234. $ret .= ($ret ? $sep : '').($object->state ? $object->state.', ' : '').$town.($object->zip ? ' ' : '').$object->zip;
  2235. } elseif (isset($object->country_code) && in_array($object->country_code, array('IT'))) {
  2236. // IT: title firstname name\n address lines \n zip town state_code \n country
  2237. $ret .= ($ret ? $sep : '').$object->zip;
  2238. $town = ($extralangcode ? $object->array_languages['town'][$extralangcode] : (empty($object->town) ? '' : $object->town));
  2239. $ret .= ($town ? (($object->zip ? ' ' : '').$town) : '');
  2240. $ret .= (empty($object->state_code) ? '' : (' '.$object->state_code));
  2241. } else {
  2242. // Other: title firstname name \n address lines \n zip town[, state] \n country
  2243. $town = ($extralangcode ? $object->array_languages['town'][$extralangcode] : (empty($object->town) ? '' : $object->town));
  2244. $ret .= !empty($object->zip) ? (($ret ? $sep : '').$object->zip) : '';
  2245. $ret .= ($town ? (($object->zip ? ' ' : ($ret ? $sep : '')).$town) : '');
  2246. if (!empty($object->state) && in_array($object->country_code, $countriesusingstate)) {
  2247. $ret .= ($ret ? ", " : '').$object->state;
  2248. }
  2249. }
  2250. if (!is_object($outputlangs)) {
  2251. $outputlangs = $langs;
  2252. }
  2253. if ($withcountry) {
  2254. $langs->load("dict");
  2255. $ret .= (empty($object->country_code) ? '' : ($ret ? $sep : '').$outputlangs->convToOutputCharset($outputlangs->transnoentitiesnoconv("Country".$object->country_code)));
  2256. }
  2257. if ($hookmanager) {
  2258. $parameters = array('withcountry' => $withcountry, 'sep' => $sep, 'outputlangs' => $outputlangs,'mode' => $mode, 'extralangcode' => $extralangcode);
  2259. $reshook = $hookmanager->executeHooks('formatAddress', $parameters, $object);
  2260. if ($reshook > 0) {
  2261. $ret = '';
  2262. }
  2263. $ret .= $hookmanager->resPrint;
  2264. }
  2265. return $ret;
  2266. }
  2267. /**
  2268. * Format a string.
  2269. *
  2270. * @param string $fmt Format of strftime function (http://php.net/manual/fr/function.strftime.php)
  2271. * @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)
  2272. * @param int $is_gmt See comment of timestamp parameter
  2273. * @return string A formatted string
  2274. */
  2275. function dol_strftime($fmt, $ts = false, $is_gmt = false)
  2276. {
  2277. if ((abs($ts) <= 0x7FFFFFFF)) { // check if number in 32-bit signed range
  2278. return ($is_gmt) ? @gmstrftime($fmt, $ts) : @strftime($fmt, $ts);
  2279. } else {
  2280. return 'Error date into a not supported range';
  2281. }
  2282. }
  2283. /**
  2284. * Output date in a string format according to outputlangs (or langs if not defined).
  2285. * Return charset is always UTF-8, except if encodetoouput is defined. In this case charset is output charset
  2286. *
  2287. * @param int $time GM Timestamps date
  2288. * @param string $format Output date format (tag of strftime function)
  2289. * "%d %b %Y",
  2290. * "%d/%m/%Y %H:%M",
  2291. * "%d/%m/%Y %H:%M:%S",
  2292. * "%B"=Long text of month, "%A"=Long text of day, "%b"=Short text of month, "%a"=Short text of day
  2293. * "day", "daytext", "dayhour", "dayhourldap", "dayhourtext", "dayrfc", "dayhourrfc", "...inputnoreduce", "...reduceformat"
  2294. * @param string $tzoutput true or 'gmt' => string is for Greenwich location
  2295. * false or 'tzserver' => output string is for local PHP server TZ usage
  2296. * 'tzuser' => output string is for user TZ (current browser TZ with current dst) => In a future, we should have same behaviour than 'tzuserrel'
  2297. * 'tzuserrel' => output string is for user TZ (current browser TZ with dst or not, depending on date position)
  2298. * @param Translate $outputlangs Object lang that contains language for text translation.
  2299. * @param boolean $encodetooutput false=no convert into output pagecode
  2300. * @return string Formated date or '' if time is null
  2301. *
  2302. * @see dol_mktime(), dol_stringtotime(), dol_getdate()
  2303. */
  2304. function dol_print_date($time, $format = '', $tzoutput = 'auto', $outputlangs = '', $encodetooutput = false)
  2305. {
  2306. global $conf, $langs;
  2307. // If date undefined or "", we return ""
  2308. if (dol_strlen($time) == 0) {
  2309. return ''; // $time=0 allowed (it means 01/01/1970 00:00:00)
  2310. }
  2311. if ($tzoutput === 'auto') {
  2312. $tzoutput = (empty($conf) ? 'tzserver' : (isset($conf->tzuserinputkey) ? $conf->tzuserinputkey : 'tzserver'));
  2313. }
  2314. // Clean parameters
  2315. $to_gmt = false;
  2316. $offsettz = $offsetdst = 0;
  2317. if ($tzoutput) {
  2318. $to_gmt = true; // For backward compatibility
  2319. if (is_string($tzoutput)) {
  2320. if ($tzoutput == 'tzserver') {
  2321. $to_gmt = false;
  2322. $offsettzstring = @date_default_timezone_get(); // Example 'Europe/Berlin' or 'Indian/Reunion'
  2323. $offsettz = 0; // Timezone offset with server timezone, so 0
  2324. $offsetdst = 0; // Dst offset with server timezone, so 0
  2325. } elseif ($tzoutput == 'tzuser' || $tzoutput == 'tzuserrel') {
  2326. $to_gmt = true;
  2327. $offsettzstring = (empty($_SESSION['dol_tz_string']) ? 'UTC' : $_SESSION['dol_tz_string']); // Example 'Europe/Berlin' or 'Indian/Reunion'
  2328. if (class_exists('DateTimeZone')) {
  2329. $user_date_tz = new DateTimeZone($offsettzstring);
  2330. $user_dt = new DateTime();
  2331. $user_dt->setTimezone($user_date_tz);
  2332. $user_dt->setTimestamp($tzoutput == 'tzuser' ? dol_now() : (int) $time);
  2333. $offsettz = $user_dt->getOffset();
  2334. } else { // old method (The 'tzuser' was processed like the 'tzuserrel')
  2335. $offsettz = (empty($_SESSION['dol_tz']) ? 0 : $_SESSION['dol_tz']) * 60 * 60; // Will not be used anymore
  2336. $offsetdst = (empty($_SESSION['dol_dst']) ? 0 : $_SESSION['dol_dst']) * 60 * 60; // Will not be used anymore
  2337. }
  2338. }
  2339. }
  2340. }
  2341. if (!is_object($outputlangs)) {
  2342. $outputlangs = $langs;
  2343. }
  2344. if (!$format) {
  2345. $format = 'daytextshort';
  2346. }
  2347. // Do we have to reduce the length of date (year on 2 chars) to save space.
  2348. // Note: dayinputnoreduce is same than day but no reduction of year length will be done
  2349. $reduceformat = (!empty($conf->dol_optimize_smallscreen) && in_array($format, array('day', 'dayhour'))) ? 1 : 0; // Test on original $format param.
  2350. $format = preg_replace('/inputnoreduce/', '', $format); // so format 'dayinputnoreduce' is processed like day
  2351. $formatwithoutreduce = preg_replace('/reduceformat/', '', $format);
  2352. if ($formatwithoutreduce != $format) {
  2353. $format = $formatwithoutreduce;
  2354. $reduceformat = 1;
  2355. } // so format 'dayreduceformat' is processed like day
  2356. // Change predefined format into computer format. If found translation in lang file we use it, otherwise we use default.
  2357. // TODO Add format daysmallyear and dayhoursmallyear
  2358. if ($format == 'day') {
  2359. $format = ($outputlangs->trans("FormatDateShort") != "FormatDateShort" ? $outputlangs->trans("FormatDateShort") : $conf->format_date_short);
  2360. } elseif ($format == 'hour') {
  2361. $format = ($outputlangs->trans("FormatHourShort") != "FormatHourShort" ? $outputlangs->trans("FormatHourShort") : $conf->format_hour_short);
  2362. } elseif ($format == 'hourduration') {
  2363. $format = ($outputlangs->trans("FormatHourShortDuration") != "FormatHourShortDuration" ? $outputlangs->trans("FormatHourShortDuration") : $conf->format_hour_short_duration);
  2364. } elseif ($format == 'daytext') {
  2365. $format = ($outputlangs->trans("FormatDateText") != "FormatDateText" ? $outputlangs->trans("FormatDateText") : $conf->format_date_text);
  2366. } elseif ($format == 'daytextshort') {
  2367. $format = ($outputlangs->trans("FormatDateTextShort") != "FormatDateTextShort" ? $outputlangs->trans("FormatDateTextShort") : $conf->format_date_text_short);
  2368. } elseif ($format == 'dayhour') {
  2369. $format = ($outputlangs->trans("FormatDateHourShort") != "FormatDateHourShort" ? $outputlangs->trans("FormatDateHourShort") : $conf->format_date_hour_short);
  2370. } elseif ($format == 'dayhoursec') {
  2371. $format = ($outputlangs->trans("FormatDateHourSecShort") != "FormatDateHourSecShort" ? $outputlangs->trans("FormatDateHourSecShort") : $conf->format_date_hour_sec_short);
  2372. } elseif ($format == 'dayhourtext') {
  2373. $format = ($outputlangs->trans("FormatDateHourText") != "FormatDateHourText" ? $outputlangs->trans("FormatDateHourText") : $conf->format_date_hour_text);
  2374. } elseif ($format == 'dayhourtextshort') {
  2375. $format = ($outputlangs->trans("FormatDateHourTextShort") != "FormatDateHourTextShort" ? $outputlangs->trans("FormatDateHourTextShort") : $conf->format_date_hour_text_short);
  2376. } elseif ($format == 'dayhourlog') {
  2377. // Format not sensitive to language
  2378. $format = '%Y%m%d%H%M%S';
  2379. } elseif ($format == 'dayhourlogsmall') {
  2380. // Format not sensitive to language
  2381. $format = '%Y%m%d%H%M';
  2382. } elseif ($format == 'dayhourldap') {
  2383. $format = '%Y%m%d%H%M%SZ';
  2384. } elseif ($format == 'dayhourxcard') {
  2385. $format = '%Y%m%dT%H%M%SZ';
  2386. } elseif ($format == 'dayxcard') {
  2387. $format = '%Y%m%d';
  2388. } elseif ($format == 'dayrfc') {
  2389. $format = '%Y-%m-%d'; // DATE_RFC3339
  2390. } elseif ($format == 'dayhourrfc') {
  2391. $format = '%Y-%m-%dT%H:%M:%SZ'; // DATETIME RFC3339
  2392. } elseif ($format == 'standard') {
  2393. $format = '%Y-%m-%d %H:%M:%S';
  2394. }
  2395. if ($reduceformat) {
  2396. $format = str_replace('%Y', '%y', $format);
  2397. $format = str_replace('yyyy', 'yy', $format);
  2398. }
  2399. // Clean format
  2400. if (preg_match('/%b/i', $format)) { // There is some text to translate
  2401. // We inhibate translation to text made by strftime functions. We will use trans instead later.
  2402. $format = str_replace('%b', '__b__', $format);
  2403. $format = str_replace('%B', '__B__', $format);
  2404. }
  2405. if (preg_match('/%a/i', $format)) { // There is some text to translate
  2406. // We inhibate translation to text made by strftime functions. We will use trans instead later.
  2407. $format = str_replace('%a', '__a__', $format);
  2408. $format = str_replace('%A', '__A__', $format);
  2409. }
  2410. // Analyze date
  2411. $reg = array();
  2412. if (preg_match('/^([0-9][0-9][0-9][0-9])([0-9][0-9])([0-9][0-9])([0-9][0-9])([0-9][0-9])([0-9][0-9])$/i', $time, $reg)) { // Deprecated. Ex: 1970-01-01, 1970-01-01 01:00:00, 19700101010000
  2413. dol_print_error('', "Functions.lib::dol_print_date function called with a bad value from page ".$_SERVER["PHP_SELF"]);
  2414. return '';
  2415. } elseif (preg_match('/^([0-9]+)\-([0-9]+)\-([0-9]+) ?([0-9]+)?:?([0-9]+)?:?([0-9]+)?/i', $time, $reg)) { // Still available to solve problems in extrafields of type date
  2416. // This part of code should not be used anymore.
  2417. dol_syslog("Functions.lib::dol_print_date function called with a bad value from page ".$_SERVER["PHP_SELF"], LOG_WARNING);
  2418. //if (function_exists('debug_print_backtrace')) debug_print_backtrace();
  2419. // Date has format 'YYYY-MM-DD' or 'YYYY-MM-DD HH:MM:SS'
  2420. $syear = (!empty($reg[1]) ? $reg[1] : '');
  2421. $smonth = (!empty($reg[2]) ? $reg[2] : '');
  2422. $sday = (!empty($reg[3]) ? $reg[3] : '');
  2423. $shour = (!empty($reg[4]) ? $reg[4] : '');
  2424. $smin = (!empty($reg[5]) ? $reg[5] : '');
  2425. $ssec = (!empty($reg[6]) ? $reg[6] : '');
  2426. $time = dol_mktime($shour, $smin, $ssec, $smonth, $sday, $syear, true);
  2427. $ret = adodb_strftime($format, $time + $offsettz + $offsetdst, $to_gmt);
  2428. } else {
  2429. // Date is a timestamps
  2430. if ($time < 100000000000) { // Protection against bad date values
  2431. $timetouse = $time + $offsettz + $offsetdst; // TODO Replace this with function Date PHP. We also should not use anymore offsettz and offsetdst but only offsettzstring.
  2432. $ret = adodb_strftime($format, $timetouse, $to_gmt); // If to_gmt = false then adodb_strftime use TZ of server
  2433. } else {
  2434. $ret = 'Bad value '.$time.' for date';
  2435. }
  2436. }
  2437. if (preg_match('/__b__/i', $format)) {
  2438. $timetouse = $time + $offsettz + $offsetdst; // TODO Replace this with function Date PHP. We also should not use anymore offsettz and offsetdst but only offsettzstring.
  2439. // Here ret is string in PHP setup language (strftime was used). Now we convert to $outputlangs.
  2440. $month = adodb_strftime('%m', $timetouse, $to_gmt); // If to_gmt = false then adodb_strftime use TZ of server
  2441. $month = sprintf("%02d", $month); // $month may be return with format '06' on some installation and '6' on other, so we force it to '06'.
  2442. if ($encodetooutput) {
  2443. $monthtext = $outputlangs->transnoentities('Month'.$month);
  2444. $monthtextshort = $outputlangs->transnoentities('MonthShort'.$month);
  2445. } else {
  2446. $monthtext = $outputlangs->transnoentitiesnoconv('Month'.$month);
  2447. $monthtextshort = $outputlangs->transnoentitiesnoconv('MonthShort'.$month);
  2448. }
  2449. //print 'monthtext='.$monthtext.' monthtextshort='.$monthtextshort;
  2450. $ret = str_replace('__b__', $monthtextshort, $ret);
  2451. $ret = str_replace('__B__', $monthtext, $ret);
  2452. //print 'x'.$outputlangs->charset_output.'-'.$ret.'x';
  2453. //return $ret;
  2454. }
  2455. if (preg_match('/__a__/i', $format)) {
  2456. //print "time=$time offsettz=$offsettz offsetdst=$offsetdst offsettzstring=$offsettzstring";
  2457. $timetouse = $time + $offsettz + $offsetdst; // TODO Replace this with function Date PHP. We also should not use anymore offsettz and offsetdst but only offsettzstring.
  2458. $w = adodb_strftime('%w', $timetouse, $to_gmt); // If to_gmt = false then adodb_strftime use TZ of server
  2459. $dayweek = $outputlangs->transnoentitiesnoconv('Day'.$w);
  2460. $ret = str_replace('__A__', $dayweek, $ret);
  2461. $ret = str_replace('__a__', dol_substr($dayweek, 0, 3), $ret);
  2462. }
  2463. return $ret;
  2464. }
  2465. /**
  2466. * Return an array with locale date info.
  2467. * WARNING: This function use PHP server timezone by default to return locale informations.
  2468. * Be aware to add the third parameter to "UTC" if you need to work on UTC.
  2469. *
  2470. * @param int $timestamp Timestamp
  2471. * @param boolean $fast Fast mode. deprecated.
  2472. * @param string $forcetimezone '' to use the PHP server timezone. Or use a form like 'gmt', 'Europe/Paris' or '+0200' to force timezone.
  2473. * @return array Array of informations
  2474. * 'seconds' => $secs,
  2475. * 'minutes' => $min,
  2476. * 'hours' => $hour,
  2477. * 'mday' => $day,
  2478. * 'wday' => $dow, 0=sunday, 6=saturday
  2479. * 'mon' => $month,
  2480. * 'year' => $year,
  2481. * 'yday' => floor($secsInYear/$_day_power)
  2482. * '0' => original timestamp
  2483. * @see dol_print_date(), dol_stringtotime(), dol_mktime()
  2484. */
  2485. function dol_getdate($timestamp, $fast = false, $forcetimezone = '')
  2486. {
  2487. //$datetimeobj = new DateTime('@'.$timestamp);
  2488. $datetimeobj = new DateTime();
  2489. $datetimeobj->setTimestamp($timestamp); // Use local PHP server timezone
  2490. if ($forcetimezone) {
  2491. $datetimeobj->setTimezone(new DateTimeZone($forcetimezone == 'gmt' ? 'UTC' : $forcetimezone)); // (add timezone relative to the date entered)
  2492. }
  2493. $arrayinfo = array(
  2494. 'year'=>((int) date_format($datetimeobj, 'Y')),
  2495. 'mon'=>((int) date_format($datetimeobj, 'm')),
  2496. 'mday'=>((int) date_format($datetimeobj, 'd')),
  2497. 'wday'=>((int) date_format($datetimeobj, 'w')),
  2498. 'yday'=>((int) date_format($datetimeobj, 'z')),
  2499. 'hours'=>((int) date_format($datetimeobj, 'H')),
  2500. 'minutes'=>((int) date_format($datetimeobj, 'i')),
  2501. 'seconds'=>((int) date_format($datetimeobj, 's')),
  2502. '0'=>$timestamp
  2503. );
  2504. return $arrayinfo;
  2505. }
  2506. /**
  2507. * Return a timestamp date built from detailed informations (by default a local PHP server timestamp)
  2508. * Replace function mktime not available under Windows if year < 1970
  2509. * PHP mktime is restricted to the years 1901-2038 on Unix and 1970-2038 on Windows
  2510. *
  2511. * @param int $hour Hour (can be -1 for undefined)
  2512. * @param int $minute Minute (can be -1 for undefined)
  2513. * @param int $second Second (can be -1 for undefined)
  2514. * @param int $month Month (1 to 12)
  2515. * @param int $day Day (1 to 31)
  2516. * @param int $year Year
  2517. * @param mixed $gm True or 1 or 'gmt'=Input informations are GMT values
  2518. * False or 0 or 'tzserver' = local to server TZ
  2519. * 'auto'
  2520. * 'tzuser' = local to user TZ taking dst into account at the current date. Not yet implemented.
  2521. * 'tzuserrel' = local to user TZ taking dst into account at the given date. Use this one to convert date input from user into a GMT date.
  2522. * 'tz,TimeZone' = use specified timezone
  2523. * @param int $check 0=No check on parameters (Can use day 32, etc...)
  2524. * @return int|string Date as a timestamp, '' or false if error
  2525. * @see dol_print_date(), dol_stringtotime(), dol_getdate()
  2526. */
  2527. function dol_mktime($hour, $minute, $second, $month, $day, $year, $gm = 'auto', $check = 1)
  2528. {
  2529. global $conf;
  2530. //print "- ".$hour.",".$minute.",".$second.",".$month.",".$day.",".$year.",".$_SERVER["WINDIR"]." -";
  2531. if ($gm === 'auto') {
  2532. $gm = (empty($conf) ? 'tzserver' : $conf->tzuserinputkey);
  2533. }
  2534. //print 'gm:'.$gm.' gm === auto:'.($gm === 'auto').'<br>';exit;
  2535. // Clean parameters
  2536. if ($hour == -1 || empty($hour)) {
  2537. $hour = 0;
  2538. }
  2539. if ($minute == -1 || empty($minute)) {
  2540. $minute = 0;
  2541. }
  2542. if ($second == -1 || empty($second)) {
  2543. $second = 0;
  2544. }
  2545. // Check parameters
  2546. if ($check) {
  2547. if (!$month || !$day) {
  2548. return '';
  2549. }
  2550. if ($day > 31) {
  2551. return '';
  2552. }
  2553. if ($month > 12) {
  2554. return '';
  2555. }
  2556. if ($hour < 0 || $hour > 24) {
  2557. return '';
  2558. }
  2559. if ($minute < 0 || $minute > 60) {
  2560. return '';
  2561. }
  2562. if ($second < 0 || $second > 60) {
  2563. return '';
  2564. }
  2565. }
  2566. if (empty($gm) || ($gm === 'server' || $gm === 'tzserver')) {
  2567. $default_timezone = @date_default_timezone_get(); // Example 'Europe/Berlin'
  2568. $localtz = new DateTimeZone($default_timezone);
  2569. } elseif ($gm === 'user' || $gm === 'tzuser' || $gm === 'tzuserrel') {
  2570. // We use dol_tz_string first because it is more reliable.
  2571. $default_timezone = (empty($_SESSION["dol_tz_string"]) ? @date_default_timezone_get() : $_SESSION["dol_tz_string"]); // Example 'Europe/Berlin'
  2572. try {
  2573. $localtz = new DateTimeZone($default_timezone);
  2574. } catch (Exception $e) {
  2575. dol_syslog("Warning dol_tz_string contains an invalid value ".$_SESSION["dol_tz_string"], LOG_WARNING);
  2576. $default_timezone = @date_default_timezone_get();
  2577. }
  2578. } elseif (strrpos($gm, "tz,") !== false) {
  2579. $timezone = str_replace("tz,", "", $gm); // Example 'tz,Europe/Berlin'
  2580. try {
  2581. $localtz = new DateTimeZone($timezone);
  2582. } catch (Exception $e) {
  2583. dol_syslog("Warning passed timezone contains an invalid value ".$timezone, LOG_WARNING);
  2584. }
  2585. }
  2586. if (empty($localtz)) {
  2587. $localtz = new DateTimeZone('UTC');
  2588. }
  2589. //var_dump($localtz);
  2590. //var_dump($year.'-'.$month.'-'.$day.'-'.$hour.'-'.$minute);
  2591. $dt = new DateTime('now', $localtz);
  2592. $dt->setDate((int) $year, (int) $month, (int) $day);
  2593. $dt->setTime((int) $hour, (int) $minute, (int) $second);
  2594. $date = $dt->getTimestamp(); // should include daylight saving time
  2595. //var_dump($date);
  2596. return $date;
  2597. }
  2598. /**
  2599. * Return date for now. In most cases, we use this function without parameters (that means GMT time).
  2600. *
  2601. * @param string $mode 'auto' => for backward compatibility (avoid this),
  2602. * 'gmt' => we return GMT timestamp,
  2603. * 'tzserver' => we add the PHP server timezone
  2604. * 'tzref' => we add the company timezone. Not implemented.
  2605. * 'tzuser' or 'tzuserrel' => we add the user timezone
  2606. * @return int $date Timestamp
  2607. */
  2608. function dol_now($mode = 'auto')
  2609. {
  2610. $ret = 0;
  2611. if ($mode === 'auto') {
  2612. $mode = 'gmt';
  2613. }
  2614. if ($mode == 'gmt') {
  2615. $ret = time(); // Time for now at greenwich.
  2616. } elseif ($mode == 'tzserver') { // Time for now with PHP server timezone added
  2617. require_once DOL_DOCUMENT_ROOT.'/core/lib/date.lib.php';
  2618. $tzsecond = getServerTimeZoneInt('now'); // Contains tz+dayling saving time
  2619. $ret = (int) (dol_now('gmt') + ($tzsecond * 3600));
  2620. //} elseif ($mode == 'tzref') {// Time for now with parent company timezone is added
  2621. // require_once DOL_DOCUMENT_ROOT.'/core/lib/date.lib.php';
  2622. // $tzsecond=getParentCompanyTimeZoneInt(); // Contains tz+dayling saving time
  2623. // $ret=dol_now('gmt')+($tzsecond*3600);
  2624. //}
  2625. } elseif ($mode == 'tzuser' || $mode == 'tzuserrel') {
  2626. // Time for now with user timezone added
  2627. //print 'time: '.time();
  2628. $offsettz = (empty($_SESSION['dol_tz']) ? 0 : $_SESSION['dol_tz']) * 60 * 60;
  2629. $offsetdst = (empty($_SESSION['dol_dst']) ? 0 : $_SESSION['dol_dst']) * 60 * 60;
  2630. $ret = (int) (dol_now('gmt') + ($offsettz + $offsetdst));
  2631. }
  2632. return $ret;
  2633. }
  2634. /**
  2635. * Return string with formated size
  2636. *
  2637. * @param int $size Size to print
  2638. * @param int $shortvalue Tell if we want long value to use another unit (Ex: 1.5Kb instead of 1500b)
  2639. * @param int $shortunit Use short label of size unit (for example 'b' instead of 'bytes')
  2640. * @return string Link
  2641. */
  2642. function dol_print_size($size, $shortvalue = 0, $shortunit = 0)
  2643. {
  2644. global $conf, $langs;
  2645. $level = 1024;
  2646. if (!empty($conf->dol_optimize_smallscreen)) {
  2647. $shortunit = 1;
  2648. }
  2649. // Set value text
  2650. if (empty($shortvalue) || $size < ($level * 10)) {
  2651. $ret = $size;
  2652. $textunitshort = $langs->trans("b");
  2653. $textunitlong = $langs->trans("Bytes");
  2654. } else {
  2655. $ret = round($size / $level, 0);
  2656. $textunitshort = $langs->trans("Kb");
  2657. $textunitlong = $langs->trans("KiloBytes");
  2658. }
  2659. // Use long or short text unit
  2660. if (empty($shortunit)) {
  2661. $ret .= ' '.$textunitlong;
  2662. } else {
  2663. $ret .= ' '.$textunitshort;
  2664. }
  2665. return $ret;
  2666. }
  2667. /**
  2668. * Show Url link
  2669. *
  2670. * @param string $url Url to show
  2671. * @param string $target Target for link
  2672. * @param int $max Max number of characters to show
  2673. * @param int $withpicto With picto
  2674. * @return string HTML Link
  2675. */
  2676. function dol_print_url($url, $target = '_blank', $max = 32, $withpicto = 0)
  2677. {
  2678. global $langs;
  2679. if (empty($url)) {
  2680. return '';
  2681. }
  2682. $link = '<a href="';
  2683. if (!preg_match('/^http/i', $url)) {
  2684. $link .= 'http://';
  2685. }
  2686. $link .= $url;
  2687. $link .= '"';
  2688. if ($target) {
  2689. $link .= ' target="'.$target.'"';
  2690. }
  2691. $link .= '>';
  2692. if (!preg_match('/^http/i', $url)) {
  2693. $link .= 'http://';
  2694. }
  2695. $link .= dol_trunc($url, $max);
  2696. $link .= '</a>';
  2697. return '<div class="nospan float" style="margin-right: 10px">'.($withpicto ?img_picto($langs->trans("Url"), 'globe').' ' : '').$link.'</div>';
  2698. }
  2699. /**
  2700. * Show EMail link formatted for HTML output.
  2701. *
  2702. * @param string $email EMail to show (only email, without 'Name of recipient' before)
  2703. * @param int $cid Id of contact if known
  2704. * @param int $socid Id of third party if known
  2705. * @param int $addlink 0=no link, 1=email has a html email link (+ link to create action if constant AGENDA_ADDACTIONFOREMAIL is on)
  2706. * @param int $max Max number of characters to show
  2707. * @param int $showinvalid 1=Show warning if syntax email is wrong
  2708. * @param int|string $withpicto Show picto
  2709. * @return string HTML Link
  2710. */
  2711. function dol_print_email($email, $cid = 0, $socid = 0, $addlink = 0, $max = 64, $showinvalid = 1, $withpicto = 0)
  2712. {
  2713. global $conf, $user, $langs, $hookmanager;
  2714. $newemail = dol_escape_htmltag($email);
  2715. if (!empty($conf->global->MAIN_OPTIMIZEFORTEXTBROWSER) && $withpicto) {
  2716. $withpicto = 0;
  2717. }
  2718. if (empty($email)) {
  2719. return '&nbsp;';
  2720. }
  2721. if (!empty($addlink)) {
  2722. $newemail = '<a style="text-overflow: ellipsis;" href="';
  2723. if (!preg_match('/^mailto:/i', $email)) {
  2724. $newemail .= 'mailto:';
  2725. }
  2726. $newemail .= $email;
  2727. $newemail .= '">';
  2728. $newemail .= dol_trunc($email, $max);
  2729. $newemail .= '</a>';
  2730. if ($showinvalid && !isValidEmail($email)) {
  2731. $langs->load("errors");
  2732. $newemail .= img_warning($langs->trans("ErrorBadEMail", $email));
  2733. }
  2734. if (($cid || $socid) && !empty($conf->agenda->enabled) && $user->rights->agenda->myactions->create) {
  2735. $type = 'AC_EMAIL';
  2736. $link = '';
  2737. if (!empty($conf->global->AGENDA_ADDACTIONFOREMAIL)) {
  2738. $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>';
  2739. }
  2740. if ($link) {
  2741. $newemail = '<div>'.$newemail.' '.$link.'</div>';
  2742. }
  2743. }
  2744. } else {
  2745. if ($showinvalid && !isValidEmail($email)) {
  2746. $langs->load("errors");
  2747. $newemail .= img_warning($langs->trans("ErrorBadEMail", $email));
  2748. }
  2749. }
  2750. //$rep = '<div class="nospan" style="margin-right: 10px">';
  2751. $rep = ($withpicto ? img_picto($langs->trans("EMail").' : '.$email, (is_numeric($withpicto) ? 'email' : $withpicto)).' ' : '').$newemail;
  2752. //$rep .= '</div>';
  2753. if ($hookmanager) {
  2754. $parameters = array('cid' => $cid, 'socid' => $socid, 'addlink' => $addlink, 'picto' => $withpicto);
  2755. $reshook = $hookmanager->executeHooks('printEmail', $parameters, $email);
  2756. if ($reshook > 0) {
  2757. $rep = '';
  2758. }
  2759. $rep .= $hookmanager->resPrint;
  2760. }
  2761. return $rep;
  2762. }
  2763. /**
  2764. * Get array of social network dictionary
  2765. *
  2766. * @return array Array of Social Networks Dictionary
  2767. */
  2768. function getArrayOfSocialNetworks()
  2769. {
  2770. global $conf, $db;
  2771. $socialnetworks = array();
  2772. // Enable caching of array
  2773. require_once DOL_DOCUMENT_ROOT.'/core/lib/memory.lib.php';
  2774. $cachekey = 'socialnetworks_' . $conf->entity;
  2775. $dataretrieved = dol_getcache($cachekey);
  2776. if (!is_null($dataretrieved)) {
  2777. $socialnetworks = $dataretrieved;
  2778. } else {
  2779. $sql = "SELECT rowid, code, label, url, icon, active FROM ".MAIN_DB_PREFIX."c_socialnetworks";
  2780. $sql .= " WHERE entity=".$conf->entity;
  2781. $resql = $db->query($sql);
  2782. if ($resql) {
  2783. while ($obj = $db->fetch_object($resql)) {
  2784. $socialnetworks[$obj->code] = array(
  2785. 'rowid' => $obj->rowid,
  2786. 'label' => $obj->label,
  2787. 'url' => $obj->url,
  2788. 'icon' => $obj->icon,
  2789. 'active' => $obj->active,
  2790. );
  2791. }
  2792. }
  2793. dol_setcache($cachekey, $socialnetworks); // If setting cache fails, this is not a problem, so we do not test result.
  2794. }
  2795. return $socialnetworks;
  2796. }
  2797. /**
  2798. * Show social network link
  2799. *
  2800. * @param string $value Skype to show (only skype, without 'Name of recipient' before)
  2801. * @param int $cid Id of contact if known
  2802. * @param int $socid Id of third party if known
  2803. * @param string $type 'skype','facebook',...
  2804. * @param array $dictsocialnetworks socialnetworks availables
  2805. * @return string HTML Link
  2806. */
  2807. function dol_print_socialnetworks($value, $cid, $socid, $type, $dictsocialnetworks = array())
  2808. {
  2809. global $conf, $user, $langs;
  2810. $htmllink = $value;
  2811. if (empty($value)) {
  2812. return '&nbsp;';
  2813. }
  2814. if (!empty($type)) {
  2815. $htmllink = '<div class="divsocialnetwork inline-block valignmiddle">';
  2816. // Use dictionary definition for picto $dictsocialnetworks[$type]['icon']
  2817. $htmllink .= '<span class="fa paddingright '.($dictsocialnetworks[$type]['icon'] ? $dictsocialnetworks[$type]['icon'] : 'fa-link').'"></span>';
  2818. if ($type == 'skype') {
  2819. $htmllink .= dol_escape_htmltag($value);
  2820. $htmllink .= '&nbsp;';
  2821. $htmllink .= '<a href="skype:';
  2822. $htmllink .= dol_string_nospecial($value, '_', '', array('@'));
  2823. $htmllink .= '?call" alt="'.$langs->trans("Call").'&nbsp;'.$value.'" title="'.dol_escape_htmltag($langs->trans("Call").' '.$value).'">';
  2824. $htmllink .= '<img src="'.DOL_URL_ROOT.'/theme/common/skype_callbutton.png" border="0">';
  2825. $htmllink .= '</a><a href="skype:';
  2826. $htmllink .= dol_string_nospecial($value, '_', '', array('@'));
  2827. $htmllink .= '?chat" alt="'.$langs->trans("Chat").'&nbsp;'.$value.'" title="'.dol_escape_htmltag($langs->trans("Chat").' '.$value).'">';
  2828. $htmllink .= '<img class="paddingleft" src="'.DOL_URL_ROOT.'/theme/common/skype_chatbutton.png" border="0">';
  2829. $htmllink .= '</a>';
  2830. if (($cid || $socid) && !empty($conf->agenda->enabled) && $user->rights->agenda->myactions->create) {
  2831. $addlink = 'AC_SKYPE';
  2832. $link = '';
  2833. if (!empty($conf->global->AGENDA_ADDACTIONFORSKYPE)) {
  2834. $link = '<a href="'.DOL_URL_ROOT.'/comm/action/card.php?action=create&amp;backtopage=1&amp;actioncode='.$addlink.'&amp;contactid='.$cid.'&amp;socid='.$socid.'">'.img_object($langs->trans("AddAction"), "calendar").'</a>';
  2835. }
  2836. $htmllink .= ($link ? ' '.$link : '');
  2837. }
  2838. } else {
  2839. if (!empty($dictsocialnetworks[$type]['url'])) {
  2840. $tmpvirginurl = preg_replace('/\/?{socialid}/', '', $dictsocialnetworks[$type]['url']);
  2841. if ($tmpvirginurl) {
  2842. $value = preg_replace('/^www\.'.preg_quote($tmpvirginurl, '/').'\/?/', '', $value);
  2843. $value = preg_replace('/^'.preg_quote($tmpvirginurl, '/').'\/?/', '', $value);
  2844. $tmpvirginurl3 = preg_replace('/^https:\/\//i', 'https://www.', $tmpvirginurl);
  2845. if ($tmpvirginurl3) {
  2846. $value = preg_replace('/^www\.'.preg_quote($tmpvirginurl3, '/').'\/?/', '', $value);
  2847. $value = preg_replace('/^'.preg_quote($tmpvirginurl3, '/').'\/?/', '', $value);
  2848. }
  2849. $tmpvirginurl2 = preg_replace('/^https?:\/\//i', '', $tmpvirginurl);
  2850. if ($tmpvirginurl2) {
  2851. $value = preg_replace('/^www\.'.preg_quote($tmpvirginurl2, '/').'\/?/', '', $value);
  2852. $value = preg_replace('/^'.preg_quote($tmpvirginurl2, '/').'\/?/', '', $value);
  2853. }
  2854. }
  2855. $link = str_replace('{socialid}', $value, $dictsocialnetworks[$type]['url']);
  2856. if (preg_match('/^https?:\/\//i', $link)) {
  2857. $htmllink .= '&nbsp;<a href="'.dol_sanitizeUrl($link, 0).'" target="_blank" rel="noopener noreferrer">'.dol_escape_htmltag($value).'</a>';
  2858. } else {
  2859. $htmllink .= '&nbsp;<a href="'.dol_sanitizeUrl($link, 1).'" target="_blank" rel="noopener noreferrer">'.dol_escape_htmltag($value).'</a>';
  2860. }
  2861. } else {
  2862. $htmllink .= dol_escape_htmltag($value);
  2863. }
  2864. }
  2865. $htmllink .= '</div>';
  2866. } else {
  2867. $langs->load("errors");
  2868. $htmllink .= img_warning($langs->trans("ErrorBadSocialNetworkValue", $value));
  2869. }
  2870. return $htmllink;
  2871. }
  2872. /**
  2873. * Format profIDs according to country
  2874. *
  2875. * @param string $profID Value of profID to format
  2876. * @param string $profIDtype Type of profID to format ('1', '2', '3', '4', '5', '6' or 'VAT')
  2877. * @param string $countrycode Country code to use for formatting
  2878. * @param int $addcpButton Add button to copy to clipboard (1 => show only on hoover ; 2 => always display )
  2879. * @param string $separ Separation between numbers for a better visibility example : xxx xxx xxx xxxxx
  2880. * @return string Formated profID
  2881. */
  2882. function dol_print_profids($profID, $profIDtype, $countrycode = '', $addcpButton = 1, $separ = '&nbsp;')
  2883. {
  2884. global $mysoc;
  2885. if (empty($profID) || empty($profIDtype)) {
  2886. return '';
  2887. }
  2888. if (empty($countrycode)) $countrycode = $mysoc->country_code;
  2889. $newProfID = $profID;
  2890. $id = substr($profIDtype, -1);
  2891. $ret = '';
  2892. if (strtoupper($countrycode) == 'FR') {
  2893. // France
  2894. if ($id == 1 && dol_strlen($newProfID) == 9) $newProfID = substr($newProfID, 0, 3).$separ.substr($newProfID, 3, 3).$separ.substr($newProfID, 6, 3);
  2895. if ($id == 2 && dol_strlen($newProfID) == 14) $newProfID = substr($newProfID, 0, 3).$separ.substr($newProfID, 3, 3).$separ.substr($newProfID, 6, 3).$separ.substr($newProfID, 9, 5);
  2896. if ($profIDtype === 'VAT' && dol_strlen($newProfID) == 13) $newProfID = substr($newProfID, 0, 4).$separ.substr($newProfID, 4, 3).$separ.substr($newProfID, 7, 3).$separ.substr($newProfID, 10, 3);
  2897. }
  2898. if (!empty($addcpButton)) $ret = showValueWithClipboardCPButton(dol_escape_htmltag($profID), ($addcpButton == 1 ? 1 : 0), $newProfID);
  2899. else $ret = $newProfID;
  2900. return $ret;
  2901. }
  2902. /**
  2903. * Format phone numbers according to country
  2904. *
  2905. * @param string $phone Phone number to format
  2906. * @param string $countrycode Country code to use for formatting
  2907. * @param int $cid Id of contact if known
  2908. * @param int $socid Id of third party if known
  2909. * @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)
  2910. * @param string $separ Separation between numbers for a better visibility example : xx.xx.xx.xx.xx
  2911. * @param string $withpicto Show picto ('fax', 'phone', 'mobile')
  2912. * @param string $titlealt Text to show on alt
  2913. * @param int $adddivfloat Add div float around phone.
  2914. * @return string Formated phone number
  2915. */
  2916. function dol_print_phone($phone, $countrycode = '', $cid = 0, $socid = 0, $addlink = '', $separ = "&nbsp;", $withpicto = '', $titlealt = '', $adddivfloat = 0)
  2917. {
  2918. global $conf, $user, $langs, $mysoc, $hookmanager;
  2919. // Clean phone parameter
  2920. $phone = preg_replace("/[\s.-]/", "", trim($phone));
  2921. if (empty($phone)) {
  2922. return '';
  2923. }
  2924. if (!empty($conf->global->MAIN_PHONE_SEPAR)) {
  2925. $separ = $conf->global->MAIN_PHONE_SEPAR;
  2926. }
  2927. if (empty($countrycode) && is_object($mysoc)) {
  2928. $countrycode = $mysoc->country_code;
  2929. }
  2930. // Short format for small screens
  2931. if ($conf->dol_optimize_smallscreen) {
  2932. $separ = '';
  2933. }
  2934. $newphone = $phone;
  2935. if (strtoupper($countrycode) == "FR") {
  2936. // France
  2937. if (dol_strlen($phone) == 10) {
  2938. $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);
  2939. } elseif (dol_strlen($phone) == 7) {
  2940. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 2).$separ.substr($newphone, 5, 2);
  2941. } elseif (dol_strlen($phone) == 9) {
  2942. $newphone = substr($newphone, 0, 2).$separ.substr($newphone, 2, 3).$separ.substr($newphone, 5, 2).$separ.substr($newphone, 7, 2);
  2943. } elseif (dol_strlen($phone) == 11) {
  2944. $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);
  2945. } elseif (dol_strlen($phone) == 12) {
  2946. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 1).$separ.substr($newphone, 4, 2).$separ.substr($newphone, 6, 2).$separ.substr($newphone, 8, 2).$separ.substr($newphone, 10, 2);
  2947. } elseif (dol_strlen($phone) == 13) {
  2948. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 2).$separ.substr($newphone, 6, 2).$separ.substr($newphone, 8, 3).$separ.substr($newphone, 11, 2);
  2949. }
  2950. } elseif (strtoupper($countrycode) == "CA") {
  2951. if (dol_strlen($phone) == 10) {
  2952. $newphone = ($separ != '' ? '(' : '').substr($newphone, 0, 3).($separ != '' ? ')' : '').$separ.substr($newphone, 3, 3).($separ != '' ? '-' : '').substr($newphone, 6, 4);
  2953. }
  2954. } elseif (strtoupper($countrycode) == "PT") {//Portugal
  2955. if (dol_strlen($phone) == 13) {//ex: +351_ABC_DEF_GHI
  2956. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 3).$separ.substr($newphone, 7, 3).$separ.substr($newphone, 10, 3);
  2957. }
  2958. } elseif (strtoupper($countrycode) == "SR") {//Suriname
  2959. if (dol_strlen($phone) == 10) {//ex: +597_ABC_DEF
  2960. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 3).$separ.substr($newphone, 7, 3);
  2961. } elseif (dol_strlen($phone) == 11) {//ex: +597_ABC_DEFG
  2962. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 3).$separ.substr($newphone, 7, 4);
  2963. }
  2964. } elseif (strtoupper($countrycode) == "DE") {//Allemagne
  2965. if (dol_strlen($phone) == 14) {//ex: +49_ABCD_EFGH_IJK
  2966. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 4).$separ.substr($newphone, 7, 4).$separ.substr($newphone, 11, 3);
  2967. } elseif (dol_strlen($phone) == 13) {//ex: +49_ABC_DEFG_HIJ
  2968. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 3).$separ.substr($newphone, 6, 4).$separ.substr($newphone, 10, 3);
  2969. }
  2970. } elseif (strtoupper($countrycode) == "ES") {//Espagne
  2971. if (dol_strlen($phone) == 12) {//ex: +34_ABC_DEF_GHI
  2972. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 3).$separ.substr($newphone, 6, 3).$separ.substr($newphone, 9, 3);
  2973. }
  2974. } elseif (strtoupper($countrycode) == "BF") {// Burkina Faso
  2975. if (dol_strlen($phone) == 12) {//ex : +22 A BC_DE_FG_HI
  2976. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 1).$separ.substr($newphone, 4, 2).$separ.substr($newphone, 6, 2).$separ.substr($newphone, 8, 2).$separ.substr($newphone, 10, 2);
  2977. }
  2978. } elseif (strtoupper($countrycode) == "RO") {// Roumanie
  2979. if (dol_strlen($phone) == 12) {//ex : +40 AB_CDE_FG_HI
  2980. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 2).$separ.substr($newphone, 5, 3).$separ.substr($newphone, 8, 2).$separ.substr($newphone, 10, 2);
  2981. }
  2982. } elseif (strtoupper($countrycode) == "TR") {//Turquie
  2983. if (dol_strlen($phone) == 13) {//ex : +90 ABC_DEF_GHIJ
  2984. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 3).$separ.substr($newphone, 6, 3).$separ.substr($newphone, 9, 4);
  2985. }
  2986. } elseif (strtoupper($countrycode) == "US") {//Etat-Unis
  2987. if (dol_strlen($phone) == 12) {//ex: +1 ABC_DEF_GHIJ
  2988. $newphone = substr($newphone, 0, 2).$separ.substr($newphone, 2, 3).$separ.substr($newphone, 5, 3).$separ.substr($newphone, 8, 4);
  2989. }
  2990. } elseif (strtoupper($countrycode) == "MX") {//Mexique
  2991. if (dol_strlen($phone) == 12) {//ex: +52 ABCD_EFG_HI
  2992. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 4).$separ.substr($newphone, 7, 3).$separ.substr($newphone, 10, 2);
  2993. } elseif (dol_strlen($phone) == 11) {//ex: +52 AB_CD_EF_GH
  2994. $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);
  2995. } elseif (dol_strlen($phone) == 13) {//ex: +52 ABC_DEF_GHIJ
  2996. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 3).$separ.substr($newphone, 6, 3).$separ.substr($newphone, 9, 4);
  2997. }
  2998. } elseif (strtoupper($countrycode) == "ML") {//Mali
  2999. if (dol_strlen($phone) == 12) {//ex: +223 AB_CD_EF_GH
  3000. $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);
  3001. }
  3002. } elseif (strtoupper($countrycode) == "TH") {//Thaïlande
  3003. if (dol_strlen($phone) == 11) {//ex: +66_ABC_DE_FGH
  3004. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 3).$separ.substr($newphone, 6, 2).$separ.substr($newphone, 8, 3);
  3005. } elseif (dol_strlen($phone) == 12) {//ex: +66_A_BCD_EF_GHI
  3006. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 1).$separ.substr($newphone, 4, 3).$separ.substr($newphone, 7, 2).$separ.substr($newphone, 9, 3);
  3007. }
  3008. } elseif (strtoupper($countrycode) == "MU") {
  3009. //Maurice
  3010. if (dol_strlen($phone) == 11) {//ex: +230_ABC_DE_FG
  3011. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 3).$separ.substr($newphone, 7, 2).$separ.substr($newphone, 9, 2);
  3012. } elseif (dol_strlen($phone) == 12) {//ex: +230_ABCD_EF_GH
  3013. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 4).$separ.substr($newphone, 8, 2).$separ.substr($newphone, 10, 2);
  3014. }
  3015. } elseif (strtoupper($countrycode) == "ZA") {//Afrique du sud
  3016. if (dol_strlen($phone) == 12) {//ex: +27_AB_CDE_FG_HI
  3017. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 2).$separ.substr($newphone, 5, 3).$separ.substr($newphone, 8, 2).$separ.substr($newphone, 10, 2);
  3018. }
  3019. } elseif (strtoupper($countrycode) == "SY") {//Syrie
  3020. if (dol_strlen($phone) == 12) {//ex: +963_AB_CD_EF_GH
  3021. $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);
  3022. } elseif (dol_strlen($phone) == 13) {//ex: +963_AB_CD_EF_GHI
  3023. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 2).$separ.substr($newphone, 6, 2).$separ.substr($newphone, 8, 2).$separ.substr($newphone, 10, 3);
  3024. }
  3025. } elseif (strtoupper($countrycode) == "AE") {//Emirats Arabes Unis
  3026. if (dol_strlen($phone) == 12) {//ex: +971_ABC_DEF_GH
  3027. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 3).$separ.substr($newphone, 7, 3).$separ.substr($newphone, 10, 2);
  3028. } elseif (dol_strlen($phone) == 13) {//ex: +971_ABC_DEF_GHI
  3029. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 3).$separ.substr($newphone, 7, 3).$separ.substr($newphone, 10, 3);
  3030. } elseif (dol_strlen($phone) == 14) {//ex: +971_ABC_DEF_GHIK
  3031. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 3).$separ.substr($newphone, 7, 3).$separ.substr($newphone, 10, 4);
  3032. }
  3033. } elseif (strtoupper($countrycode) == "DZ") {//Algérie
  3034. if (dol_strlen($phone) == 13) {//ex: +213_ABC_DEF_GHI
  3035. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 3).$separ.substr($newphone, 7, 3).$separ.substr($newphone, 10, 3);
  3036. }
  3037. } elseif (strtoupper($countrycode) == "BE") {//Belgique
  3038. if (dol_strlen($phone) == 11) {//ex: +32_ABC_DE_FGH
  3039. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 3).$separ.substr($newphone, 6, 2).$separ.substr($newphone, 8, 3);
  3040. } elseif (dol_strlen($phone) == 12) {//ex: +32_ABC_DEF_GHI
  3041. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 3).$separ.substr($newphone, 6, 3).$separ.substr($newphone, 9, 3);
  3042. }
  3043. } elseif (strtoupper($countrycode) == "PF") {//Polynésie française
  3044. if (dol_strlen($phone) == 12) {//ex: +689_AB_CD_EF_GH
  3045. $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);
  3046. }
  3047. } elseif (strtoupper($countrycode) == "CO") {//Colombie
  3048. if (dol_strlen($phone) == 13) {//ex: +57_ABC_DEF_GH_IJ
  3049. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 3).$separ.substr($newphone, 6, 3).$separ.substr($newphone, 9, 2).$separ.substr($newphone, 11, 2);
  3050. }
  3051. } elseif (strtoupper($countrycode) == "JO") {//Jordanie
  3052. if (dol_strlen($phone) == 12) {//ex: +962_A_BCD_EF_GH
  3053. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 1).$separ.substr($newphone, 5, 3).$separ.substr($newphone, 7, 2).$separ.substr($newphone, 9, 2);
  3054. }
  3055. } elseif (strtoupper($countrycode) == "JM") {//Jamaïque
  3056. if (dol_strlen($newphone) == 12) {//ex: +1867_ABC_DEFG
  3057. $newphone = substr($newphone, 0, 5).$separ.substr($newphone, 5, 3).$separ.substr($newphone, 8, 4);
  3058. }
  3059. } elseif (strtoupper($countrycode) == "MG") {//Madagascar
  3060. if (dol_strlen($phone) == 13) {//ex: +261_AB_CD_EFG_HI
  3061. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 2).$separ.substr($newphone, 6, 2).$separ.substr($newphone, 8, 3).$separ.substr($newphone, 11, 2);
  3062. }
  3063. } elseif (strtoupper($countrycode) == "GB") {//Royaume uni
  3064. if (dol_strlen($phone) == 13) {//ex: +44_ABCD_EFG_HIJ
  3065. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 4).$separ.substr($newphone, 7, 3).$separ.substr($newphone, 10, 3);
  3066. }
  3067. } elseif (strtoupper($countrycode) == "CH") {//Suisse
  3068. if (dol_strlen($phone) == 12) {//ex: +41_AB_CDE_FG_HI
  3069. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 2).$separ.substr($newphone, 5, 3).$separ.substr($newphone, 8, 2).$separ.substr($newphone, 10, 2);
  3070. } elseif (dol_strlen($phone) == 15) {// +41_AB_CDE_FGH_IJKL
  3071. $newphone = $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 2).$separ.substr($newphone, 5, 3).$separ.substr($newphone, 8, 3).$separ.substr($newphone, 11, 4);
  3072. }
  3073. } elseif (strtoupper($countrycode) == "TN") {//Tunisie
  3074. if (dol_strlen($phone) == 12) {//ex: +216_AB_CDE_FGH
  3075. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 2).$separ.substr($newphone, 6, 3).$separ.substr($newphone, 9, 3);
  3076. }
  3077. } elseif (strtoupper($countrycode) == "GF") {//Guyane francaise
  3078. if (dol_strlen($phone) == 13) {//ex: +594_ABC_DE_FG_HI (ABC=594 de nouveau)
  3079. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 3).$separ.substr($newphone, 7, 2).$separ.substr($newphone, 9, 2).$separ.substr($newphone, 11, 2);
  3080. }
  3081. } elseif (strtoupper($countrycode) == "GP") {//Guadeloupe
  3082. if (dol_strlen($phone) == 13) {//ex: +590_ABC_DE_FG_HI (ABC=590 de nouveau)
  3083. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 3).$separ.substr($newphone, 7, 2).$separ.substr($newphone, 9, 2).$separ.substr($newphone, 11, 2);
  3084. }
  3085. } elseif (strtoupper($countrycode) == "MQ") {//Martinique
  3086. if (dol_strlen($phone) == 13) {//ex: +596_ABC_DE_FG_HI (ABC=596 de nouveau)
  3087. $newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 3).$separ.substr($newphone, 7, 2).$separ.substr($newphone, 9, 2).$separ.substr($newphone, 11, 2);
  3088. }
  3089. } elseif (strtoupper($countrycode) == "IT") {//Italie
  3090. if (dol_strlen($phone) == 12) {//ex: +39_ABC_DEF_GHI
  3091. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 3).$separ.substr($newphone, 6, 3).$separ.substr($newphone, 9, 3);
  3092. } elseif (dol_strlen($phone) == 13) {//ex: +39_ABC_DEF_GH_IJ
  3093. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 3).$separ.substr($newphone, 6, 3).$separ.substr($newphone, 9, 2).$separ.substr($newphone, 11, 2);
  3094. }
  3095. } elseif (strtoupper($countrycode) == "AU") {
  3096. //Australie
  3097. if (dol_strlen($phone) == 12) {
  3098. //ex: +61_A_BCDE_FGHI
  3099. $newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 1).$separ.substr($newphone, 4, 4).$separ.substr($newphone, 8, 4);
  3100. }
  3101. }
  3102. if (!empty($addlink)) { // Link on phone number (+ link to add action if conf->global->AGENDA_ADDACTIONFORPHONE set)
  3103. if ($conf->browser->layout == '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
  3104. $newphoneform = $newphone;
  3105. $newphone = '<a href="tel:'.$phone.'"';
  3106. $newphone .= '>'.$newphoneform.'</a>';
  3107. } elseif (!empty($conf->clicktodial->enabled) && $addlink == 'AC_TEL') { // If click to dial, we use click to dial url
  3108. if (empty($user->clicktodial_loaded)) {
  3109. $user->fetch_clicktodial();
  3110. }
  3111. // Define urlmask
  3112. $urlmask = 'ErrorClickToDialModuleNotConfigured';
  3113. if (!empty($conf->global->CLICKTODIAL_URL)) {
  3114. $urlmask = $conf->global->CLICKTODIAL_URL;
  3115. }
  3116. if (!empty($user->clicktodial_url)) {
  3117. $urlmask = $user->clicktodial_url;
  3118. }
  3119. $clicktodial_poste = (!empty($user->clicktodial_poste) ?urlencode($user->clicktodial_poste) : '');
  3120. $clicktodial_login = (!empty($user->clicktodial_login) ?urlencode($user->clicktodial_login) : '');
  3121. $clicktodial_password = (!empty($user->clicktodial_password) ?urlencode($user->clicktodial_password) : '');
  3122. // This line is for backward compatibility
  3123. $url = sprintf($urlmask, urlencode($phone), $clicktodial_poste, $clicktodial_login, $clicktodial_password);
  3124. // Thoose lines are for substitution
  3125. $substitarray = array('__PHONEFROM__'=>$clicktodial_poste,
  3126. '__PHONETO__'=>urlencode($phone),
  3127. '__LOGIN__'=>$clicktodial_login,
  3128. '__PASS__'=>$clicktodial_password);
  3129. $url = make_substitutions($url, $substitarray);
  3130. $newphonesav = $newphone;
  3131. if (empty($conf->global->CLICKTODIAL_DO_NOT_USE_AJAX_CALL)) {
  3132. // Default and recommended: New method using ajax without submiting a page making a javascript history.go(-1) back
  3133. $newphone = '<a href="'.$url.'" class="cssforclicktodial"'; // Call of ajax is handled by the lib_foot.js.php on class 'cssforclicktodial'
  3134. $newphone .= '>'.$newphonesav.'</a>';
  3135. } else {
  3136. // Old method
  3137. $newphone = '<a href="'.$url.'"';
  3138. if (!empty($conf->global->CLICKTODIAL_FORCENEWTARGET)) {
  3139. $newphone .= ' target="_blank" rel="noopener noreferrer"';
  3140. }
  3141. $newphone .= '>'.$newphonesav.'</a>';
  3142. }
  3143. }
  3144. //if (($cid || $socid) && ! empty($conf->agenda->enabled) && $user->rights->agenda->myactions->create)
  3145. if (isModEnabled('agenda') && $user->rights->agenda->myactions->create) {
  3146. $type = 'AC_TEL';
  3147. $link = '';
  3148. if ($addlink == 'AC_FAX') {
  3149. $type = 'AC_FAX';
  3150. }
  3151. if (!empty($conf->global->AGENDA_ADDACTIONFORPHONE)) {
  3152. $link = '<a href="'.DOL_URL_ROOT.'/comm/action/card.php?action=create&amp;backtopage='. urlencode($_SERVER['REQUEST_URI']) .'&amp;actioncode='.$type.($cid ? '&amp;contactid='.$cid : '').($socid ? '&amp;socid='.$socid : '').'">'.img_object($langs->trans("AddAction"), "calendar").'</a>';
  3153. }
  3154. if ($link) {
  3155. $newphone = '<div>'.$newphone.' '.$link.'</div>';
  3156. }
  3157. }
  3158. }
  3159. if (empty($titlealt)) {
  3160. $titlealt = ($withpicto == 'fax' ? $langs->trans("Fax") : $langs->trans("Phone"));
  3161. }
  3162. $rep = '';
  3163. if ($hookmanager) {
  3164. $parameters = array('countrycode' => $countrycode, 'cid' => $cid, 'socid' => $socid, 'titlealt' => $titlealt, 'picto' => $withpicto);
  3165. $reshook = $hookmanager->executeHooks('printPhone', $parameters, $phone);
  3166. $rep .= $hookmanager->resPrint;
  3167. }
  3168. if (empty($reshook)) {
  3169. $picto = '';
  3170. if ($withpicto) {
  3171. if ($withpicto == 'fax') {
  3172. $picto = 'phoning_fax';
  3173. } elseif ($withpicto == 'phone') {
  3174. $picto = 'phoning';
  3175. } elseif ($withpicto == 'mobile') {
  3176. $picto = 'phoning_mobile';
  3177. } else {
  3178. $picto = '';
  3179. }
  3180. }
  3181. if ($adddivfloat) {
  3182. $rep .= '<div class="nospan float" style="margin-right: 10px">';
  3183. } else {
  3184. $rep .= '<span style="margin-right: 10px;">';
  3185. }
  3186. $rep .= ($withpicto ?img_picto($titlealt, 'object_'.$picto.'.png').' ' : '').$newphone;
  3187. if ($adddivfloat) {
  3188. $rep .= '</div>';
  3189. } else {
  3190. $rep .= '</span>';
  3191. }
  3192. }
  3193. return $rep;
  3194. }
  3195. /**
  3196. * Return an IP formated to be shown on screen
  3197. *
  3198. * @param string $ip IP
  3199. * @param int $mode 0=return IP + country/flag, 1=return only country/flag, 2=return only IP
  3200. * @return string Formated IP, with country if GeoIP module is enabled
  3201. */
  3202. function dol_print_ip($ip, $mode = 0)
  3203. {
  3204. global $conf, $langs;
  3205. $ret = '';
  3206. if (empty($mode)) {
  3207. $ret .= $ip;
  3208. }
  3209. if ($mode != 2) {
  3210. $countrycode = dolGetCountryCodeFromIp($ip);
  3211. if ($countrycode) { // If success, countrycode is us, fr, ...
  3212. if (file_exists(DOL_DOCUMENT_ROOT.'/theme/common/flags/'.$countrycode.'.png')) {
  3213. $ret .= ' '.img_picto($countrycode.' '.$langs->trans("AccordingToGeoIPDatabase"), DOL_URL_ROOT.'/theme/common/flags/'.$countrycode.'.png', '', 1);
  3214. } else {
  3215. $ret .= ' ('.$countrycode.')';
  3216. }
  3217. } else {
  3218. // Nothing
  3219. }
  3220. }
  3221. return $ret;
  3222. }
  3223. /**
  3224. * Return the IP of remote user.
  3225. * Take HTTP_X_FORWARDED_FOR (defined when using proxy)
  3226. * Then HTTP_CLIENT_IP if defined (rare)
  3227. * Then REMOTE_ADDR (no way to be modified by user but may be wrong if user is using a proxy)
  3228. *
  3229. * @return string Ip of remote user.
  3230. */
  3231. function getUserRemoteIP()
  3232. {
  3233. if (empty($_SERVER['HTTP_X_FORWARDED_FOR']) || preg_match('/[^0-9\.\:,\[\]]/', $_SERVER['HTTP_X_FORWARDED_FOR'])) {
  3234. if (empty($_SERVER['HTTP_CLIENT_IP']) || preg_match('/[^0-9\.\:,\[\]]/', $_SERVER['HTTP_CLIENT_IP'])) {
  3235. if (empty($_SERVER["HTTP_CF_CONNECTING_IP"])) {
  3236. $ip = (empty($_SERVER['REMOTE_ADDR']) ? '' : $_SERVER['REMOTE_ADDR']); // value may have been the IP of the proxy and not the client
  3237. } else {
  3238. $ip = $_SERVER["HTTP_CF_CONNECTING_IP"]; // value here may have been forged by client
  3239. }
  3240. } else {
  3241. $ip = $_SERVER['HTTP_CLIENT_IP']; // value is clean here but may have been forged by proxy
  3242. }
  3243. } else {
  3244. $ip = $_SERVER['HTTP_X_FORWARDED_FOR']; // value is clean here but may have been forged by proxy
  3245. }
  3246. return $ip;
  3247. }
  3248. /**
  3249. * Return if we are using a HTTPS connexion
  3250. * Check HTTPS (no way to be modified by user but may be empty or wrong if user is using a proxy)
  3251. * Take HTTP_X_FORWARDED_PROTO (defined when using proxy)
  3252. * Then HTTP_X_FORWARDED_SSL
  3253. *
  3254. * @return boolean True if user is using HTTPS
  3255. */
  3256. function isHTTPS()
  3257. {
  3258. $isSecure = false;
  3259. if (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on') {
  3260. $isSecure = true;
  3261. } elseif (!empty($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https' || !empty($_SERVER['HTTP_X_FORWARDED_SSL']) && $_SERVER['HTTP_X_FORWARDED_SSL'] == 'on') {
  3262. $isSecure = true;
  3263. }
  3264. return $isSecure;
  3265. }
  3266. /**
  3267. * Return a country code from IP. Empty string if not found.
  3268. *
  3269. * @param string $ip IP
  3270. * @return string Country code ('us', 'fr', ...)
  3271. */
  3272. function dolGetCountryCodeFromIp($ip)
  3273. {
  3274. global $conf;
  3275. $countrycode = '';
  3276. if (!empty($conf->geoipmaxmind->enabled)) {
  3277. $datafile = getDolGlobalString('GEOIPMAXMIND_COUNTRY_DATAFILE');
  3278. //$ip='24.24.24.24';
  3279. //$datafile='/usr/share/GeoIP/GeoIP.dat'; Note that this must be downloaded datafile (not same than datafile provided with ubuntu packages)
  3280. include_once DOL_DOCUMENT_ROOT.'/core/class/dolgeoip.class.php';
  3281. $geoip = new DolGeoIP('country', $datafile);
  3282. //print 'ip='.$ip.' databaseType='.$geoip->gi->databaseType." GEOIP_CITY_EDITION_REV1=".GEOIP_CITY_EDITION_REV1."\n";
  3283. $countrycode = $geoip->getCountryCodeFromIP($ip);
  3284. }
  3285. return $countrycode;
  3286. }
  3287. /**
  3288. * Return country code for current user.
  3289. * If software is used inside a local network, detection may fails (we need a public ip)
  3290. *
  3291. * @return string Country code (fr, es, it, us, ...)
  3292. */
  3293. function dol_user_country()
  3294. {
  3295. global $conf, $langs, $user;
  3296. //$ret=$user->xxx;
  3297. $ret = '';
  3298. if (!empty($conf->geoipmaxmind->enabled)) {
  3299. $ip = getUserRemoteIP();
  3300. $datafile = getDolGlobalString('GEOIPMAXMIND_COUNTRY_DATAFILE');
  3301. //$ip='24.24.24.24';
  3302. //$datafile='E:\Mes Sites\Web\Admin1\awstats\maxmind\GeoIP.dat';
  3303. include_once DOL_DOCUMENT_ROOT.'/core/class/dolgeoip.class.php';
  3304. $geoip = new DolGeoIP('country', $datafile);
  3305. $countrycode = $geoip->getCountryCodeFromIP($ip);
  3306. $ret = $countrycode;
  3307. }
  3308. return $ret;
  3309. }
  3310. /**
  3311. * Format address string
  3312. *
  3313. * @param string $address Address string, already formatted with dol_format_address()
  3314. * @param int $htmlid Html ID (for example 'gmap')
  3315. * @param int $element 'thirdparty'|'contact'|'member'|'other'
  3316. * @param int $id Id of object
  3317. * @param int $noprint No output. Result is the function return
  3318. * @param string $charfornl Char to use instead of nl2br. '' means we use a standad nl2br.
  3319. * @return string|void Nothing if noprint is 0, formatted address if noprint is 1
  3320. * @see dol_format_address()
  3321. */
  3322. function dol_print_address($address, $htmlid, $element, $id, $noprint = 0, $charfornl = '')
  3323. {
  3324. global $conf, $user, $langs, $hookmanager;
  3325. $out = '';
  3326. if ($address) {
  3327. if ($hookmanager) {
  3328. $parameters = array('element' => $element, 'id' => $id);
  3329. $reshook = $hookmanager->executeHooks('printAddress', $parameters, $address);
  3330. $out .= $hookmanager->resPrint;
  3331. }
  3332. if (empty($reshook)) {
  3333. if (empty($charfornl)) {
  3334. $out .= nl2br($address);
  3335. } else {
  3336. $out .= preg_replace('/[\r\n]+/', $charfornl, $address);
  3337. }
  3338. // TODO Remove this block, we can add this using the hook now
  3339. $showgmap = $showomap = 0;
  3340. if (($element == 'thirdparty' || $element == 'societe') && !empty($conf->google->enabled) && !empty($conf->global->GOOGLE_ENABLE_GMAPS)) {
  3341. $showgmap = 1;
  3342. }
  3343. if ($element == 'contact' && !empty($conf->google->enabled) && !empty($conf->global->GOOGLE_ENABLE_GMAPS_CONTACTS)) {
  3344. $showgmap = 1;
  3345. }
  3346. if ($element == 'member' && !empty($conf->google->enabled) && !empty($conf->global->GOOGLE_ENABLE_GMAPS_MEMBERS)) {
  3347. $showgmap = 1;
  3348. }
  3349. if (($element == 'thirdparty' || $element == 'societe') && !empty($conf->openstreetmap->enabled) && !empty($conf->global->OPENSTREETMAP_ENABLE_MAPS)) {
  3350. $showomap = 1;
  3351. }
  3352. if ($element == 'contact' && !empty($conf->openstreetmap->enabled) && !empty($conf->global->OPENSTREETMAP_ENABLE_MAPS_CONTACTS)) {
  3353. $showomap = 1;
  3354. }
  3355. if ($element == 'member' && !empty($conf->openstreetmap->enabled) && !empty($conf->global->OPENSTREETMAP_ENABLE_MAPS_MEMBERS)) {
  3356. $showomap = 1;
  3357. }
  3358. if ($showgmap) {
  3359. $url = dol_buildpath('/google/gmaps.php?mode='.$element.'&id='.$id, 1);
  3360. $out .= ' <a href="'.$url.'" target="_gmaps"><img id="'.$htmlid.'" class="valigntextbottom" src="'.DOL_URL_ROOT.'/theme/common/gmap.png"></a>';
  3361. }
  3362. if ($showomap) {
  3363. $url = dol_buildpath('/openstreetmap/maps.php?mode='.$element.'&id='.$id, 1);
  3364. $out .= ' <a href="'.$url.'" target="_gmaps"><img id="'.$htmlid.'_openstreetmap" class="valigntextbottom" src="'.DOL_URL_ROOT.'/theme/common/gmap.png"></a>';
  3365. }
  3366. }
  3367. }
  3368. if ($noprint) {
  3369. return $out;
  3370. } else {
  3371. print $out;
  3372. }
  3373. }
  3374. /**
  3375. * Return true if email syntax is ok.
  3376. *
  3377. * @param string $address email (Ex: "toto@examle.com". Long form "John Do <johndo@example.com>" will be false)
  3378. * @param int $acceptsupervisorkey If 1, the special string '__SUPERVISOREMAIL__' is also accepted as valid
  3379. * @param int $acceptuserkey If 1, the special string '__USER_EMAIL__' is also accepted as valid
  3380. * @return boolean true if email syntax is OK, false if KO or empty string
  3381. * @see isValidMXRecord()
  3382. */
  3383. function isValidEmail($address, $acceptsupervisorkey = 0, $acceptuserkey = 0)
  3384. {
  3385. if ($acceptsupervisorkey && $address == '__SUPERVISOREMAIL__') {
  3386. return true;
  3387. }
  3388. if ($acceptuserkey && $address == '__USER_EMAIL__') {
  3389. return true;
  3390. }
  3391. if (filter_var($address, FILTER_VALIDATE_EMAIL)) {
  3392. return true;
  3393. }
  3394. return false;
  3395. }
  3396. /**
  3397. * Return if the domain name has a valid MX record.
  3398. * WARNING: This need function idn_to_ascii, checkdnsrr and getmxrr
  3399. *
  3400. * @param string $domain Domain name (Ex: "yahoo.com", "yhaoo.com", "dolibarr.fr")
  3401. * @return int -1 if error (function not available), 0=Not valid, 1=Valid
  3402. * @see isValidEmail()
  3403. */
  3404. function isValidMXRecord($domain)
  3405. {
  3406. if (function_exists('idn_to_ascii') && function_exists('checkdnsrr')) {
  3407. if (!checkdnsrr(idn_to_ascii($domain), 'MX')) {
  3408. return 0;
  3409. }
  3410. if (function_exists('getmxrr')) {
  3411. $mxhosts = array();
  3412. $weight = array();
  3413. getmxrr(idn_to_ascii($domain), $mxhosts, $weight);
  3414. if (count($mxhosts) > 1) {
  3415. return 1;
  3416. }
  3417. if (count($mxhosts) == 1 && !empty($mxhosts[0])) {
  3418. return 1;
  3419. }
  3420. return 0;
  3421. }
  3422. }
  3423. return -1;
  3424. }
  3425. /**
  3426. * Return true if phone number syntax is ok
  3427. * TODO Decide what to do with this
  3428. *
  3429. * @param string $phone phone (Ex: "0601010101")
  3430. * @return boolean true if phone syntax is OK, false if KO or empty string
  3431. */
  3432. function isValidPhone($phone)
  3433. {
  3434. return true;
  3435. }
  3436. /**
  3437. * Make a strlen call. Works even if mbstring module not enabled
  3438. *
  3439. * @param string $string String to calculate length
  3440. * @param string $stringencoding Encoding of string
  3441. * @return int Length of string
  3442. */
  3443. function dol_strlen($string, $stringencoding = 'UTF-8')
  3444. {
  3445. if (function_exists('mb_strlen')) {
  3446. return mb_strlen($string, $stringencoding);
  3447. } else {
  3448. return strlen($string);
  3449. }
  3450. }
  3451. /**
  3452. * Make a substring. Works even if mbstring module is not enabled for better compatibility.
  3453. *
  3454. * @param string $string String to scan
  3455. * @param string $start Start position
  3456. * @param int $length Length (in nb of characters or nb of bytes depending on trunconbytes param)
  3457. * @param string $stringencoding Page code used for input string encoding
  3458. * @param int $trunconbytes 1=Length is max of bytes instead of max of characters
  3459. * @return string substring
  3460. */
  3461. function dol_substr($string, $start, $length, $stringencoding = '', $trunconbytes = 0)
  3462. {
  3463. global $langs;
  3464. if (empty($stringencoding)) {
  3465. $stringencoding = $langs->charset_output;
  3466. }
  3467. $ret = '';
  3468. if (empty($trunconbytes)) {
  3469. if (function_exists('mb_substr')) {
  3470. $ret = mb_substr($string, $start, $length, $stringencoding);
  3471. } else {
  3472. $ret = substr($string, $start, $length);
  3473. }
  3474. } else {
  3475. if (function_exists('mb_strcut')) {
  3476. $ret = mb_strcut($string, $start, $length, $stringencoding);
  3477. } else {
  3478. $ret = substr($string, $start, $length);
  3479. }
  3480. }
  3481. return $ret;
  3482. }
  3483. /**
  3484. * Truncate a string to a particular length adding '…' if string larger than length.
  3485. * If length = max length+1, we do no truncate to avoid having just 1 char replaced with '…'.
  3486. * MAIN_DISABLE_TRUNC=1 can disable all truncings
  3487. *
  3488. * @param string $string String to truncate
  3489. * @param int $size Max string size visible (excluding …). 0 for no limit. WARNING: Final string size can have 3 more chars (if we added …, or if size was max+1 so it does not worse to replace with ...)
  3490. * @param string $trunc Where to trunc: 'right', 'left', 'middle' (size must be a 2 power), 'wrap'
  3491. * @param string $stringencoding Tell what is source string encoding
  3492. * @param int $nodot Truncation do not add … after truncation. So it's an exact truncation.
  3493. * @param int $display Trunc is used to display data and can be changed for small screen. TODO Remove this param (must be dealt with CSS)
  3494. * @return string Truncated string. WARNING: length is never higher than $size if $nodot is set, but can be 3 chars higher otherwise.
  3495. */
  3496. function dol_trunc($string, $size = 40, $trunc = 'right', $stringencoding = 'UTF-8', $nodot = 0, $display = 0)
  3497. {
  3498. global $conf;
  3499. if (empty($size) || !empty($conf->global->MAIN_DISABLE_TRUNC)) {
  3500. return $string;
  3501. }
  3502. if (empty($stringencoding)) {
  3503. $stringencoding = 'UTF-8';
  3504. }
  3505. // reduce for small screen
  3506. if ($conf->dol_optimize_smallscreen == 1 && $display == 1) {
  3507. $size = round($size / 3);
  3508. }
  3509. // We go always here
  3510. if ($trunc == 'right') {
  3511. $newstring = dol_textishtml($string) ? dol_string_nohtmltag($string, 1) : $string;
  3512. if (dol_strlen($newstring, $stringencoding) > ($size + ($nodot ? 0 : 1))) {
  3513. // If nodot is 0 and size is 1 chars more, we don't trunc and don't add …
  3514. return dol_substr($newstring, 0, $size, $stringencoding).($nodot ? '' : '…');
  3515. } else {
  3516. //return 'u'.$size.'-'.$newstring.'-'.dol_strlen($newstring,$stringencoding).'-'.$string;
  3517. return $string;
  3518. }
  3519. } elseif ($trunc == 'middle') {
  3520. $newstring = dol_textishtml($string) ? dol_string_nohtmltag($string, 1) : $string;
  3521. if (dol_strlen($newstring, $stringencoding) > 2 && dol_strlen($newstring, $stringencoding) > ($size + 1)) {
  3522. $size1 = round($size / 2);
  3523. $size2 = round($size / 2);
  3524. return dol_substr($newstring, 0, $size1, $stringencoding).'…'.dol_substr($newstring, dol_strlen($newstring, $stringencoding) - $size2, $size2, $stringencoding);
  3525. } else {
  3526. return $string;
  3527. }
  3528. } elseif ($trunc == 'left') {
  3529. $newstring = dol_textishtml($string) ? dol_string_nohtmltag($string, 1) : $string;
  3530. if (dol_strlen($newstring, $stringencoding) > ($size + ($nodot ? 0 : 1))) {
  3531. // If nodot is 0 and size is 1 chars more, we don't trunc and don't add …
  3532. return '…'.dol_substr($newstring, dol_strlen($newstring, $stringencoding) - $size, $size, $stringencoding);
  3533. } else {
  3534. return $string;
  3535. }
  3536. } elseif ($trunc == 'wrap') {
  3537. $newstring = dol_textishtml($string) ? dol_string_nohtmltag($string, 1) : $string;
  3538. if (dol_strlen($newstring, $stringencoding) > ($size + 1)) {
  3539. return dol_substr($newstring, 0, $size, $stringencoding)."\n".dol_trunc(dol_substr($newstring, $size, dol_strlen($newstring, $stringencoding) - $size, $stringencoding), $size, $trunc);
  3540. } else {
  3541. return $string;
  3542. }
  3543. } else {
  3544. return 'BadParam3CallingDolTrunc';
  3545. }
  3546. }
  3547. /**
  3548. * Show picto whatever it's its name (generic function)
  3549. *
  3550. * @param string $titlealt Text on title tag for tooltip. Not used if param notitle is set to 1.
  3551. * @param string $picto Name of image file to show ('filenew', ...)
  3552. * If no extension provided, we use '.png'. Image must be stored into theme/xxx/img directory.
  3553. * Example: picto.png if picto.png is stored into htdocs/theme/mytheme/img
  3554. * Example: picto.png@mymodule if picto.png is stored into htdocs/mymodule/img
  3555. * Example: /mydir/mysubdir/picto.png if picto.png is stored into htdocs/mydir/mysubdir (pictoisfullpath must be set to 1)
  3556. * Example: fontawesome_envelope-open-text_fas_red_1em if you want to use fontaweseome icons: fontawesome_<icon-name>_<style>_<color>_<size> (only icon-name is mandatory)
  3557. * @param string $moreatt Add more attribute on img tag (For example 'class="pictofixedwidth"')
  3558. * @param boolean|int $pictoisfullpath If true or 1, image path is a full path
  3559. * @param int $srconly Return only content of the src attribute of img.
  3560. * @param int $notitle 1=Disable tag title. Use it if you add js tooltip, to avoid duplicate tooltip.
  3561. * @param string $alt Force alt for bind people
  3562. * @param string $morecss Add more class css on img tag (For example 'myclascss').
  3563. * @param string $marginleftonlyshort 1 = Add a short left margin on picto, 2 = Add a larger left margin on picto, 0 = No margin left. Works for fontawesome picto only.
  3564. * @return string Return img tag
  3565. * @see img_object(), img_picto_common()
  3566. */
  3567. function img_picto($titlealt, $picto, $moreatt = '', $pictoisfullpath = false, $srconly = 0, $notitle = 0, $alt = '', $morecss = '', $marginleftonlyshort = 2)
  3568. {
  3569. global $conf, $langs;
  3570. // We forge fullpathpicto for image to $path/img/$picto. By default, we take DOL_URL_ROOT/theme/$conf->theme/img/$picto
  3571. $url = DOL_URL_ROOT;
  3572. $theme = isset($conf->theme) ? $conf->theme : null;
  3573. $path = 'theme/'.$theme;
  3574. // Define fullpathpicto to use into src
  3575. if ($pictoisfullpath) {
  3576. // Clean parameters
  3577. if (!preg_match('/(\.png|\.gif|\.svg)$/i', $picto)) {
  3578. $picto .= '.png';
  3579. }
  3580. $fullpathpicto = $picto;
  3581. $reg = array();
  3582. if (preg_match('/class="([^"]+)"/', $moreatt, $reg)) {
  3583. $morecss .= ($morecss ? ' ' : '').$reg[1];
  3584. $moreatt = str_replace('class="'.$reg[1].'"', '', $moreatt);
  3585. }
  3586. } else {
  3587. $pictowithouttext = preg_replace('/(\.png|\.gif|\.svg)$/', '', $picto);
  3588. $pictowithouttext = str_replace('object_', '', $pictowithouttext);
  3589. if (strpos($pictowithouttext, 'fontawesome_') !== false || preg_match('/^fa-/', $pictowithouttext)) {
  3590. // This is a font awesome image 'fonwtawesome_xxx' or 'fa-xxx'
  3591. $pictowithouttext = str_replace('fa-', '', $pictowithouttext);
  3592. $pictowithouttextarray = explode('_', $pictowithouttext);
  3593. $marginleftonlyshort = 0;
  3594. if (!empty($pictowithouttextarray[1])) {
  3595. $fakey = 'fa-'.$pictowithouttextarray[1];
  3596. $fa = empty($pictowithouttextarray[2]) ? 'fa' : $pictowithouttextarray[2];
  3597. $facolor = empty($pictowithouttextarray[3]) ? '' : $pictowithouttextarray[3];
  3598. $fasize = empty($pictowithouttextarray[4]) ? '' : $pictowithouttextarray[4];
  3599. } else {
  3600. $fakey = 'fa-'.$pictowithouttext;
  3601. $fa = 'fa';
  3602. $facolor = '';
  3603. $fasize = '';
  3604. }
  3605. // This snippet only needed since function img_edit accepts only one additional parameter: no separate one for css only.
  3606. // class/style need to be extracted to avoid duplicate class/style validation errors when $moreatt is added to the end of the attributes.
  3607. $morestyle = '';
  3608. $reg = array();
  3609. if (preg_match('/class="([^"]+)"/', $moreatt, $reg)) {
  3610. $morecss .= ($morecss ? ' ' : '').$reg[1];
  3611. $moreatt = str_replace('class="'.$reg[1].'"', '', $moreatt);
  3612. }
  3613. if (preg_match('/style="([^"]+)"/', $moreatt, $reg)) {
  3614. $morestyle = $reg[1];
  3615. $moreatt = str_replace('style="'.$reg[1].'"', '', $moreatt);
  3616. }
  3617. $moreatt = trim($moreatt);
  3618. $enabledisablehtml = '<span class="'.$fa.' '.$fakey.($marginleftonlyshort ? ($marginleftonlyshort == 1 ? ' marginleftonlyshort' : ' marginleftonly') : '');
  3619. $enabledisablehtml .= ($morecss ? ' '.$morecss : '').'" style="'.($fasize ? ('font-size: '.$fasize.';') : '').($facolor ? (' color: '.$facolor.';') : '').($morestyle ? ' '.$morestyle : '').'"'.(($notitle || empty($titlealt)) ? '' : ' title="'.dol_escape_htmltag($titlealt).'"').($moreatt ? ' '.$moreatt : '').'>';
  3620. /*if (!empty($conf->global->MAIN_OPTIMIZEFORTEXTBROWSER)) {
  3621. $enabledisablehtml .= $titlealt;
  3622. }*/
  3623. $enabledisablehtml .= '</span>';
  3624. return $enabledisablehtml;
  3625. }
  3626. if (empty($srconly) && in_array($pictowithouttext, array(
  3627. '1downarrow', '1uparrow', '1leftarrow', '1rightarrow', '1uparrow_selected', '1downarrow_selected', '1leftarrow_selected', '1rightarrow_selected',
  3628. 'accountancy', 'accounting_account', 'account', 'accountline', 'action', 'add', 'address', 'angle-double-down', 'angle-double-up', 'asset',
  3629. 'bank_account', 'barcode', 'bank', 'bell', 'bill', 'billa', 'billr', 'billd', 'bookmark', 'bom', 'briefcase-medical', 'bug', 'building',
  3630. 'card', 'calendarlist', 'calendar', 'calendarmonth', 'calendarweek', 'calendarday', 'calendarperuser', 'calendarpertype',
  3631. 'cash-register', 'category', 'chart', 'check', 'clock', 'close_title', 'cog', 'collab', 'company', 'contact', 'country', 'contract', 'conversation', 'cron', 'cubes',
  3632. 'currency', 'multicurrency',
  3633. 'delete', 'dolly', 'dollyrevert', 'donation', 'download', 'dynamicprice',
  3634. 'edit', 'ellipsis-h', 'email', 'entity', 'envelope', 'eraser', 'establishment', 'expensereport', 'external-link-alt', 'external-link-square-alt',
  3635. 'filter', 'file-code', 'file-export', 'file-import', 'file-upload', 'autofill', 'folder', 'folder-open', 'folder-plus',
  3636. 'generate', 'globe', 'globe-americas', 'graph', 'grip', 'grip_title', 'group',
  3637. 'help', 'holiday',
  3638. 'images', 'incoterm', 'info', 'intervention', 'inventory', 'intracommreport', 'knowledgemanagement',
  3639. 'label', 'language', 'line', 'link', 'list', 'list-alt', 'listlight', 'loan', 'lot', 'long-arrow-alt-right',
  3640. 'margin', 'map-marker-alt', 'member', 'meeting', 'money-bill-alt', 'movement', 'mrp', 'note', 'next',
  3641. 'off', 'on', 'order',
  3642. 'paiment', 'paragraph', 'play', 'pdf', 'phone', 'phoning', 'phoning_mobile', 'phoning_fax', 'playdisabled', 'previous', 'poll', 'pos', 'printer', 'product', 'propal', 'puce',
  3643. 'stock', 'resize', 'service', 'stats', 'trip',
  3644. 'security', 'setup', 'share-alt', 'sign-out', 'split', 'stripe', 'stripe-s', 'switch_off', 'switch_on', 'switch_on_red', 'tools', 'unlink', 'uparrow', 'user', 'user-tie', 'vcard', 'wrench',
  3645. 'github', 'google', 'jabber', 'skype', 'twitter', 'facebook', 'linkedin', 'instagram', 'snapchat', 'youtube', 'google-plus-g', 'whatsapp',
  3646. 'chevron-left', 'chevron-right', 'chevron-down', 'chevron-top', 'commercial', 'companies',
  3647. 'generic', 'home', 'hrm', 'members', 'products', 'invoicing',
  3648. 'partnership', 'payment', 'payment_vat', 'pencil-ruler', 'preview', 'project', 'projectpub', 'projecttask', 'question', 'refresh', 'region',
  3649. 'salary', 'shipment', 'state', 'supplier_invoice', 'supplier_invoicea', 'supplier_invoicer', 'supplier_invoiced',
  3650. 'technic', 'ticket',
  3651. 'error', 'warning',
  3652. 'recent', 'reception', 'recruitmentcandidature', 'recruitmentjobposition', 'resource', 'recurring',
  3653. 'shapes', 'square', 'stop-circle', 'supplier', 'supplier_proposal', 'supplier_order', 'supplier_invoice',
  3654. 'timespent', 'title_setup', 'title_accountancy', 'title_bank', 'title_hrm', 'title_agenda',
  3655. 'uncheck', 'user-cog', 'user-injured', 'user-md', 'vat', 'website', 'workstation', 'webhook', 'world', 'private',
  3656. 'conferenceorbooth', 'eventorganization',
  3657. 'stamp', 'signature'
  3658. ))) {
  3659. $fakey = $pictowithouttext;
  3660. $facolor = '';
  3661. $fasize = '';
  3662. $fa = 'fas';
  3663. if (in_array($pictowithouttext, array('card', 'bell', 'clock', 'establishment', 'generic', 'minus-square', 'object_generic', 'pdf', 'plus-square', 'timespent', 'note', 'off', 'on', 'object_bookmark', 'bookmark', 'vcard'))) {
  3664. $fa = 'far';
  3665. }
  3666. if (in_array($pictowithouttext, array('black-tie', 'github', 'google', 'skype', 'twitter', 'facebook', 'linkedin', 'instagram', 'snapchat', 'stripe', 'stripe-s', 'youtube', 'google-plus-g', 'whatsapp'))) {
  3667. $fa = 'fab';
  3668. }
  3669. $arrayconvpictotofa = array(
  3670. 'account'=>'university', 'accounting_account'=>'clipboard-list', 'accountline'=>'receipt', 'accountancy'=>'search-dollar', 'action'=>'calendar-alt', 'add'=>'plus-circle', 'address'=> 'address-book', 'asset'=>'money-check-alt', 'autofill'=>'fill',
  3671. 'bank_account'=>'university',
  3672. 'bill'=>'file-invoice-dollar', 'billa'=>'file-excel', 'billr'=>'file-invoice-dollar', 'billd'=>'file-medical',
  3673. 'supplier_invoice'=>'file-invoice-dollar', 'supplier_invoicea'=>'file-excel', 'supplier_invoicer'=>'file-invoice-dollar', 'supplier_invoiced'=>'file-medical',
  3674. 'bom'=>'shapes',
  3675. 'card'=>'address-card', 'chart'=>'chart-line', 'company'=>'building', 'contact'=>'address-book', 'contract'=>'suitcase', 'collab'=>'people-arrows', 'conversation'=>'comments', 'country'=>'globe-americas', 'cron'=>'business-time',
  3676. 'donation'=>'file-alt', 'dynamicprice'=>'hand-holding-usd',
  3677. 'setup'=>'cog', 'companies'=>'building', 'products'=>'cube', 'commercial'=>'suitcase', 'invoicing'=>'coins',
  3678. 'accounting'=>'search-dollar', 'category'=>'tag', 'dollyrevert'=>'dolly',
  3679. 'generate'=>'plus-square', 'hrm'=>'user-tie', 'incoterm'=>'truck-loading',
  3680. 'margin'=>'calculator', 'members'=>'user-friends', 'ticket'=>'ticket-alt', 'globe'=>'external-link-alt', 'lot'=>'barcode',
  3681. 'email'=>'at', 'establishment'=>'building', 'edit'=>'pencil-alt', 'entity'=>'globe',
  3682. 'graph'=>'chart-line', 'grip_title'=>'arrows-alt', 'grip'=>'arrows-alt', 'help'=>'question-circle',
  3683. 'generic'=>'file', 'holiday'=>'umbrella-beach',
  3684. 'info'=>'info-circle', 'inventory'=>'boxes', 'intracommreport'=>'globe-europe', 'knowledgemanagement'=>'ticket-alt', 'label'=>'layer-group', 'line'=>'bars', 'loan'=>'money-bill-alt',
  3685. 'member'=>'user-alt', 'meeting'=>'chalkboard-teacher', 'mrp'=>'cubes', 'next'=>'arrow-alt-circle-right',
  3686. 'trip'=>'wallet', 'expensereport'=>'wallet', 'group'=>'users', 'movement'=>'people-carry',
  3687. 'sign-out'=>'sign-out-alt',
  3688. 'switch_off'=>'toggle-off', 'switch_on'=>'toggle-on', 'switch_on_red'=>'toggle-on', 'check'=>'check', 'bookmark'=>'star',
  3689. 'bank'=>'university', 'close_title'=>'times', 'delete'=>'trash', 'filter'=>'filter',
  3690. 'list-alt'=>'list-alt', 'calendarlist'=>'bars', 'calendar'=>'calendar-alt', 'calendarmonth'=>'calendar-alt', 'calendarweek'=>'calendar-week', 'calendarday'=>'calendar-day', 'calendarperuser'=>'table',
  3691. 'intervention'=>'ambulance', 'invoice'=>'file-invoice-dollar', 'currency'=>'dollar-sign', 'multicurrency'=>'dollar-sign', 'order'=>'file-invoice',
  3692. 'error'=>'exclamation-triangle', 'warning'=>'exclamation-triangle',
  3693. 'other'=>'square',
  3694. 'playdisabled'=>'play', 'pdf'=>'file-pdf', 'poll'=>'check-double', 'pos'=>'cash-register', 'preview'=>'binoculars', 'project'=>'project-diagram', 'projectpub'=>'project-diagram', 'projecttask'=>'tasks', 'propal'=>'file-signature',
  3695. 'partnership'=>'handshake', 'payment'=>'money-check-alt', 'payment_vat'=>'money-check-alt', 'phoning'=>'phone', 'phoning_mobile'=>'mobile-alt', 'phoning_fax'=>'fax', 'previous'=>'arrow-alt-circle-left', 'printer'=>'print', 'product'=>'cube', 'puce'=>'angle-right',
  3696. 'recent' => 'question', 'reception'=>'dolly', 'recruitmentjobposition'=>'id-card-alt', 'recruitmentcandidature'=>'id-badge',
  3697. 'resize'=>'crop', 'supplier_order'=>'dol-order_supplier', 'supplier_proposal'=>'file-signature',
  3698. 'refresh'=>'redo', 'region'=>'map-marked', 'resource'=>'laptop-house', 'recurring'=>'history',
  3699. 'service'=>'concierge-bell',
  3700. 'state'=>'map-marked-alt', 'security'=>'key', 'salary'=>'wallet', 'shipment'=>'dolly', 'stock'=>'box-open', 'stats' => 'chart-bar', 'split'=>'code-branch', 'stripe'=>'stripe-s',
  3701. 'supplier'=>'building', 'technic'=>'cogs',
  3702. 'timespent'=>'clock', 'title_setup'=>'tools', 'title_accountancy'=>'money-check-alt', 'title_bank'=>'university', 'title_hrm'=>'umbrella-beach',
  3703. 'title_agenda'=>'calendar-alt',
  3704. 'uncheck'=>'times', 'uparrow'=>'share', 'vat'=>'money-check-alt', 'vcard'=>'address-card',
  3705. 'jabber'=>'comment-o',
  3706. 'website'=>'globe-americas', 'workstation'=>'pallet', 'webhook'=>'bullseye', 'world'=>'globe', 'private'=>'user-lock',
  3707. 'conferenceorbooth'=>'chalkboard-teacher', 'eventorganization'=>'project-diagram'
  3708. );
  3709. if ($pictowithouttext == 'off') {
  3710. $fakey = 'fa-square';
  3711. $fasize = '1.3em';
  3712. } elseif ($pictowithouttext == 'on') {
  3713. $fakey = 'fa-check-square';
  3714. $fasize = '1.3em';
  3715. } elseif ($pictowithouttext == 'listlight') {
  3716. $fakey = 'fa-download';
  3717. $marginleftonlyshort = 1;
  3718. } elseif ($pictowithouttext == 'printer') {
  3719. $fakey = 'fa-print';
  3720. $fasize = '1.2em';
  3721. } elseif ($pictowithouttext == 'note') {
  3722. $fakey = 'fa-sticky-note';
  3723. $marginleftonlyshort = 1;
  3724. } elseif (in_array($pictowithouttext, array('1uparrow', '1downarrow', '1leftarrow', '1rightarrow', '1uparrow_selected', '1downarrow_selected', '1leftarrow_selected', '1rightarrow_selected'))) {
  3725. $convertarray = array('1uparrow'=>'caret-up', '1downarrow'=>'caret-down', '1leftarrow'=>'caret-left', '1rightarrow'=>'caret-right', '1uparrow_selected'=>'caret-up', '1downarrow_selected'=>'caret-down', '1leftarrow_selected'=>'caret-left', '1rightarrow_selected'=>'caret-right');
  3726. $fakey = 'fa-'.$convertarray[$pictowithouttext];
  3727. if (preg_match('/selected/', $pictowithouttext)) {
  3728. $facolor = '#888';
  3729. }
  3730. $marginleftonlyshort = 1;
  3731. } elseif (!empty($arrayconvpictotofa[$pictowithouttext])) {
  3732. $fakey = 'fa-'.$arrayconvpictotofa[$pictowithouttext];
  3733. } else {
  3734. $fakey = 'fa-'.$pictowithouttext;
  3735. }
  3736. if (in_array($pictowithouttext, array('dollyrevert', 'member', 'members', 'contract', 'group', 'resource', 'shipment'))) {
  3737. $morecss .= ' em092';
  3738. }
  3739. if (in_array($pictowithouttext, array('conferenceorbooth', 'collab', 'eventorganization', 'holiday', 'info', 'project', 'workstation'))) {
  3740. $morecss .= ' em088';
  3741. }
  3742. if (in_array($pictowithouttext, array('asset', 'intervention', 'payment', 'loan', 'partnership', 'stock', 'technic'))) {
  3743. $morecss .= ' em080';
  3744. }
  3745. // Define $marginleftonlyshort
  3746. $arrayconvpictotomarginleftonly = array(
  3747. 'bank', 'check', 'delete', 'generic', 'grip', 'grip_title', 'jabber',
  3748. 'grip_title', 'grip', 'listlight', 'note', 'on', 'off', 'playdisabled', 'printer', 'resize', 'sign-out', 'stats', 'switch_on', 'switch_on_red', 'switch_off',
  3749. 'uparrow', '1uparrow', '1downarrow', '1leftarrow', '1rightarrow', '1uparrow_selected', '1downarrow_selected', '1leftarrow_selected', '1rightarrow_selected'
  3750. );
  3751. if (!isset($arrayconvpictotomarginleftonly[$pictowithouttext])) {
  3752. $marginleftonlyshort = 0;
  3753. }
  3754. // Add CSS
  3755. $arrayconvpictotomorcess = array(
  3756. 'action'=>'infobox-action', 'account'=>'infobox-bank_account', 'accounting_account'=>'infobox-bank_account', 'accountline'=>'infobox-bank_account', 'accountancy'=>'infobox-bank_account', 'asset'=>'infobox-bank_account',
  3757. 'bank_account'=>'infobox-bank_account',
  3758. 'bill'=>'infobox-commande', 'billa'=>'infobox-commande', 'billr'=>'infobox-commande', 'billd'=>'infobox-commande',
  3759. 'margin'=>'infobox-bank_account', 'conferenceorbooth'=>'infobox-project',
  3760. 'cash-register'=>'infobox-bank_account', 'contract'=>'infobox-contrat', 'check'=>'font-status4', 'collab'=>'infobox-action', 'conversation'=>'infobox-contrat',
  3761. 'donation'=>'infobox-commande', 'dolly'=>'infobox-commande', 'dollyrevert'=>'flip infobox-order_supplier',
  3762. 'ecm'=>'infobox-action', 'eventorganization'=>'infobox-project',
  3763. 'hrm'=>'infobox-adherent', 'group'=>'infobox-adherent', 'intervention'=>'infobox-contrat',
  3764. 'incoterm'=>'infobox-supplier_proposal',
  3765. 'currency'=>'infobox-bank_account', 'multicurrency'=>'infobox-bank_account',
  3766. 'members'=>'infobox-adherent', 'member'=>'infobox-adherent', 'money-bill-alt'=>'infobox-bank_account',
  3767. 'order'=>'infobox-commande',
  3768. 'user'=>'infobox-adherent', 'users'=>'infobox-adherent',
  3769. 'error'=>'pictoerror', 'warning'=>'pictowarning', 'switch_on'=>'font-status4', 'switch_on_red'=>'font-status8',
  3770. 'holiday'=>'infobox-holiday', 'info'=>'opacityhigh', 'invoice'=>'infobox-commande',
  3771. 'knowledgemanagement'=>'infobox-contrat rotate90', 'loan'=>'infobox-bank_account',
  3772. 'payment'=>'infobox-bank_account', 'payment_vat'=>'infobox-bank_account', 'poll'=>'infobox-adherent', 'pos'=>'infobox-bank_account', 'project'=>'infobox-project', 'projecttask'=>'infobox-project',
  3773. 'propal'=>'infobox-propal', 'private'=>'infobox-project',
  3774. 'reception'=>'flip', 'recruitmentjobposition'=>'infobox-adherent', 'recruitmentcandidature'=>'infobox-adherent',
  3775. 'resource'=>'infobox-action',
  3776. 'salary'=>'infobox-bank_account', 'shipment'=>'infobox-commande', 'supplier_invoice'=>'infobox-order_supplier', 'supplier_invoicea'=>'infobox-order_supplier', 'supplier_invoiced'=>'infobox-order_supplier',
  3777. 'supplier'=>'infobox-order_supplier', 'supplier_order'=>'infobox-order_supplier', 'supplier_proposal'=>'infobox-supplier_proposal',
  3778. 'ticket'=>'infobox-contrat', 'title_accountancy'=>'infobox-bank_account', 'title_hrm'=>'infobox-holiday', 'expensereport'=>'infobox-expensereport', 'trip'=>'infobox-expensereport', 'title_agenda'=>'infobox-action',
  3779. 'vat'=>'infobox-bank_account',
  3780. //'title_setup'=>'infobox-action', 'tools'=>'infobox-action',
  3781. 'list-alt'=>'imgforviewmode', 'calendar'=>'imgforviewmode', 'calendarweek'=>'imgforviewmode', 'calendarmonth'=>'imgforviewmode', 'calendarday'=>'imgforviewmode', 'calendarperuser'=>'imgforviewmode'
  3782. );
  3783. if (!empty($arrayconvpictotomorcess[$pictowithouttext])) {
  3784. $morecss .= ($morecss ? ' ' : '').$arrayconvpictotomorcess[$pictowithouttext];
  3785. }
  3786. // Define $color
  3787. $arrayconvpictotocolor = array(
  3788. 'address'=>'#6c6aa8', 'building'=>'#6c6aa8', 'bom'=>'#a69944',
  3789. 'cog'=>'#999', 'companies'=>'#6c6aa8', 'company'=>'#6c6aa8', 'contact'=>'#6c6aa8', 'cron'=>'#555',
  3790. 'dynamicprice'=>'#a69944',
  3791. 'edit'=>'#444', 'note'=>'#999', 'error'=>'', 'help'=>'#bbb', 'listlight'=>'#999', 'language'=>'#555',
  3792. //'dolly'=>'#a69944', 'dollyrevert'=>'#a69944',
  3793. 'lot'=>'#a69944',
  3794. 'map-marker-alt'=>'#aaa', 'mrp'=>'#a69944', 'product'=>'#a69944', 'service'=>'#a69944', 'inventory'=>'#a69944', 'stock'=>'#a69944', 'movement'=>'#a69944',
  3795. 'other'=>'#ddd', 'world'=>'#986c6a',
  3796. 'partnership'=>'#6c6aa8', 'playdisabled'=>'#ccc', 'printer'=>'#444', 'projectpub'=>'#986c6a', 'reception'=>'#a69944', 'resize'=>'#444', 'rss'=>'#cba',
  3797. //'shipment'=>'#a69944',
  3798. 'security'=>'#999', 'square'=>'#888', 'stop-circle'=>'#888', 'stats'=>'#444', 'switch_off'=>'#999', 'technic'=>'#999', 'timespent'=>'#555',
  3799. 'uncheck'=>'#800', 'uparrow'=>'#555', 'user-cog'=>'#999', 'country'=>'#aaa', 'globe-americas'=>'#aaa', 'region'=>'#aaa', 'state'=>'#aaa',
  3800. 'website'=>'#304', 'workstation'=>'#a69944'
  3801. );
  3802. if (isset($arrayconvpictotocolor[$pictowithouttext])) {
  3803. $facolor = $arrayconvpictotocolor[$pictowithouttext];
  3804. }
  3805. // This snippet only needed since function img_edit accepts only one additional parameter: no separate one for css only.
  3806. // class/style need to be extracted to avoid duplicate class/style validation errors when $moreatt is added to the end of the attributes.
  3807. $morestyle = '';
  3808. $reg = array();
  3809. if (preg_match('/class="([^"]+)"/', $moreatt, $reg)) {
  3810. $morecss .= ($morecss ? ' ' : '').$reg[1];
  3811. $moreatt = str_replace('class="'.$reg[1].'"', '', $moreatt);
  3812. }
  3813. if (preg_match('/style="([^"]+)"/', $moreatt, $reg)) {
  3814. $morestyle = $reg[1];
  3815. $moreatt = str_replace('style="'.$reg[1].'"', '', $moreatt);
  3816. }
  3817. $moreatt = trim($moreatt);
  3818. $enabledisablehtml = '<span class="'.$fa.' '.$fakey.($marginleftonlyshort ? ($marginleftonlyshort == 1 ? ' marginleftonlyshort' : ' marginleftonly') : '');
  3819. $enabledisablehtml .= ($morecss ? ' '.$morecss : '').'" style="'.($fasize ? ('font-size: '.$fasize.';') : '').($facolor ? (' color: '.$facolor.';') : '').($morestyle ? ' '.$morestyle : '').'"'.(($notitle || empty($titlealt)) ? '' : ' title="'.dol_escape_htmltag($titlealt).'"').($moreatt ? ' '.$moreatt : '').'>';
  3820. /*if (!empty($conf->global->MAIN_OPTIMIZEFORTEXTBROWSER)) {
  3821. $enabledisablehtml .= $titlealt;
  3822. }*/
  3823. $enabledisablehtml .= '</span>';
  3824. return $enabledisablehtml;
  3825. }
  3826. if (!empty($conf->global->MAIN_OVERWRITE_THEME_PATH)) {
  3827. $path = $conf->global->MAIN_OVERWRITE_THEME_PATH.'/theme/'.$theme; // If the theme does not have the same name as the module
  3828. } elseif (!empty($conf->global->MAIN_OVERWRITE_THEME_RES)) {
  3829. $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
  3830. } elseif (!empty($conf->modules_parts['theme']) && array_key_exists($theme, $conf->modules_parts['theme'])) {
  3831. $path = $theme.'/theme/'.$theme; // If the theme have the same name as the module
  3832. }
  3833. // If we ask an image into $url/$mymodule/img (instead of default path)
  3834. $regs = array();
  3835. if (preg_match('/^([^@]+)@([^@]+)$/i', $picto, $regs)) {
  3836. $picto = $regs[1];
  3837. $path = $regs[2]; // $path is $mymodule
  3838. }
  3839. // Clean parameters
  3840. if (!preg_match('/(\.png|\.gif|\.svg)$/i', $picto)) {
  3841. $picto .= '.png';
  3842. }
  3843. // If alt path are defined, define url where img file is, according to physical path
  3844. // ex: array(["main"]=>"/home/maindir/htdocs", ["alt0"]=>"/home/moddir0/htdocs", ...)
  3845. foreach ($conf->file->dol_document_root as $type => $dirroot) {
  3846. if ($type == 'main') {
  3847. continue;
  3848. }
  3849. // This need a lot of time, that's why enabling alternative dir like "custom" dir is not recommanded
  3850. if (file_exists($dirroot.'/'.$path.'/img/'.$picto)) {
  3851. $url = DOL_URL_ROOT.$conf->file->dol_url_root[$type];
  3852. break;
  3853. }
  3854. }
  3855. // $url is '' or '/custom', $path is current theme or
  3856. $fullpathpicto = $url.'/'.$path.'/img/'.$picto;
  3857. }
  3858. if ($srconly) {
  3859. return $fullpathpicto;
  3860. }
  3861. // tag title is used for tooltip on <a>, tag alt can be used with very simple text on image for blind people
  3862. return '<img src="'.$fullpathpicto.'"'.($notitle ? '' : ' alt="'.dol_escape_htmltag($alt).'"').(($notitle || empty($titlealt)) ? '' : ' title="'.dol_escape_htmltag($titlealt).'"').($moreatt ? ' '.$moreatt.($morecss ? ' class="'.$morecss.'"' : '') : ' class="inline-block'.($morecss ? ' '.$morecss : '').'"').'>'; // Alt is used for accessibility, title for popup
  3863. }
  3864. /**
  3865. * Show a picto called object_picto (generic function)
  3866. *
  3867. * @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.
  3868. * @param string $picto Name of image to show object_picto (example: user, group, action, bill, contract, propal, product, ...)
  3869. * For external modules use imagename@mymodule to search into directory "img" of module.
  3870. * @param string $moreatt Add more attribute on img tag (ie: class="datecallink")
  3871. * @param int $pictoisfullpath If 1, image path is a full path
  3872. * @param int $srconly Return only content of the src attribute of img.
  3873. * @param int $notitle 1=Disable tag title. Use it if you add js tooltip, to avoid duplicate tooltip.
  3874. * @return string Return img tag
  3875. * @see img_picto(), img_picto_common()
  3876. */
  3877. function img_object($titlealt, $picto, $moreatt = '', $pictoisfullpath = false, $srconly = 0, $notitle = 0)
  3878. {
  3879. if (strpos($picto, '^') === 0) {
  3880. return img_picto($titlealt, str_replace('^', '', $picto), $moreatt, $pictoisfullpath, $srconly, $notitle);
  3881. } else {
  3882. return img_picto($titlealt, 'object_'.$picto, $moreatt, $pictoisfullpath, $srconly, $notitle);
  3883. }
  3884. }
  3885. /**
  3886. * Show weather picto
  3887. *
  3888. * @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.
  3889. * @param string|int $picto Name of image file to show (If no extension provided, we use '.png'). Image must be stored into htdocs/theme/common directory. Or level of meteo image (0-4).
  3890. * @param string $moreatt Add more attribute on img tag
  3891. * @param int $pictoisfullpath If 1, image path is a full path
  3892. * @param string $morecss More CSS
  3893. * @return string Return img tag
  3894. * @see img_object(), img_picto()
  3895. */
  3896. function img_weather($titlealt, $picto, $moreatt = '', $pictoisfullpath = 0, $morecss = '')
  3897. {
  3898. global $conf;
  3899. if (is_numeric($picto)) {
  3900. //$leveltopicto = array(0=>'weather-clear.png', 1=>'weather-few-clouds.png', 2=>'weather-clouds.png', 3=>'weather-many-clouds.png', 4=>'weather-storm.png');
  3901. //$picto = $leveltopicto[$picto];
  3902. return '<i class="fa fa-weather-level'.$picto.'"></i>';
  3903. } elseif (!preg_match('/(\.png|\.gif)$/i', $picto)) {
  3904. $picto .= '.png';
  3905. }
  3906. $path = DOL_URL_ROOT.'/theme/'.$conf->theme.'/img/weather/'.$picto;
  3907. return img_picto($titlealt, $path, $moreatt, 1, 0, 0, '', $morecss);
  3908. }
  3909. /**
  3910. * Show picto (generic function)
  3911. *
  3912. * @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.
  3913. * @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.
  3914. * @param string $moreatt Add more attribute on img tag
  3915. * @param int $pictoisfullpath If 1, image path is a full path
  3916. * @param int $notitle 1=Disable tag title. Use it if you add js tooltip, to avoid duplicate tooltip.
  3917. * @return string Return img tag
  3918. * @see img_object(), img_picto()
  3919. */
  3920. function img_picto_common($titlealt, $picto, $moreatt = '', $pictoisfullpath = 0, $notitle = 0)
  3921. {
  3922. global $conf;
  3923. if (!preg_match('/(\.png|\.gif)$/i', $picto)) {
  3924. $picto .= '.png';
  3925. }
  3926. if ($pictoisfullpath) {
  3927. $path = $picto;
  3928. } else {
  3929. $path = DOL_URL_ROOT.'/theme/common/'.$picto;
  3930. if (!empty($conf->global->MAIN_MODULE_CAN_OVERWRITE_COMMONICONS)) {
  3931. $themepath = DOL_DOCUMENT_ROOT.'/theme/'.$conf->theme.'/img/'.$picto;
  3932. if (file_exists($themepath)) {
  3933. $path = $themepath;
  3934. }
  3935. }
  3936. }
  3937. return img_picto($titlealt, $path, $moreatt, 1, 0, $notitle);
  3938. }
  3939. /**
  3940. * Show logo action
  3941. *
  3942. * @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.
  3943. * @param string $numaction Action id or code to show
  3944. * @param string $picto Name of image file to show ('filenew', ...)
  3945. * If no extension provided, we use '.png'. Image must be stored into theme/xxx/img directory.
  3946. * Example: picto.png if picto.png is stored into htdocs/theme/mytheme/img
  3947. * Example: picto.png@mymodule if picto.png is stored into htdocs/mymodule/img
  3948. * Example: /mydir/mysubdir/picto.png if picto.png is stored into htdocs/mydir/mysubdir (pictoisfullpath must be set to 1)
  3949. * @return string Return an img tag
  3950. */
  3951. function img_action($titlealt, $numaction, $picto = '')
  3952. {
  3953. global $langs;
  3954. if (empty($titlealt) || $titlealt == 'default') {
  3955. if ($numaction == '-1' || $numaction == 'ST_NO') {
  3956. $numaction = -1;
  3957. $titlealt = $langs->transnoentitiesnoconv('ChangeDoNotContact');
  3958. } elseif ($numaction == '0' || $numaction == 'ST_NEVER') {
  3959. $numaction = 0;
  3960. $titlealt = $langs->transnoentitiesnoconv('ChangeNeverContacted');
  3961. } elseif ($numaction == '1' || $numaction == 'ST_TODO') {
  3962. $numaction = 1;
  3963. $titlealt = $langs->transnoentitiesnoconv('ChangeToContact');
  3964. } elseif ($numaction == '2' || $numaction == 'ST_PEND') {
  3965. $numaction = 2;
  3966. $titlealt = $langs->transnoentitiesnoconv('ChangeContactInProcess');
  3967. } elseif ($numaction == '3' || $numaction == 'ST_DONE') {
  3968. $numaction = 3;
  3969. $titlealt = $langs->transnoentitiesnoconv('ChangeContactDone');
  3970. } else {
  3971. $titlealt = $langs->transnoentitiesnoconv('ChangeStatus '.$numaction);
  3972. $numaction = 0;
  3973. }
  3974. }
  3975. if (!is_numeric($numaction)) {
  3976. $numaction = 0;
  3977. }
  3978. return img_picto($titlealt, !empty($picto) ? $picto : 'stcomm'.$numaction.'.png');
  3979. }
  3980. /**
  3981. * Show pdf logo
  3982. *
  3983. * @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.
  3984. * @param int $size Taille de l'icone : 3 = 16x16px , 2 = 14x14px
  3985. * @return string Retourne tag img
  3986. */
  3987. function img_pdf($titlealt = 'default', $size = 3)
  3988. {
  3989. global $langs;
  3990. if ($titlealt == 'default') {
  3991. $titlealt = $langs->trans('Show');
  3992. }
  3993. return img_picto($titlealt, 'pdf'.$size.'.png');
  3994. }
  3995. /**
  3996. * Show logo +
  3997. *
  3998. * @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.
  3999. * @param string $other Add more attributes on img
  4000. * @return string Return tag img
  4001. */
  4002. function img_edit_add($titlealt = 'default', $other = '')
  4003. {
  4004. global $langs;
  4005. if ($titlealt == 'default') {
  4006. $titlealt = $langs->trans('Add');
  4007. }
  4008. return img_picto($titlealt, 'edit_add.png', $other);
  4009. }
  4010. /**
  4011. * Show logo -
  4012. *
  4013. * @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.
  4014. * @param string $other Add more attributes on img
  4015. * @return string Return tag img
  4016. */
  4017. function img_edit_remove($titlealt = 'default', $other = '')
  4018. {
  4019. global $langs;
  4020. if ($titlealt == 'default') {
  4021. $titlealt = $langs->trans('Remove');
  4022. }
  4023. return img_picto($titlealt, 'edit_remove.png', $other);
  4024. }
  4025. /**
  4026. * Show logo editer/modifier fiche
  4027. *
  4028. * @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.
  4029. * @param integer $float If you have to put the style "float: right"
  4030. * @param string $other Add more attributes on img
  4031. * @return string Return tag img
  4032. */
  4033. function img_edit($titlealt = 'default', $float = 0, $other = '')
  4034. {
  4035. global $langs;
  4036. if ($titlealt == 'default') {
  4037. $titlealt = $langs->trans('Modify');
  4038. }
  4039. return img_picto($titlealt, 'edit.png', ($float ? 'style="float: '.($langs->tab_translate["DIRECTION"] == 'rtl' ? 'left' : 'right').'"' : "").($other ? ' '.$other : ''));
  4040. }
  4041. /**
  4042. * Show logo view card
  4043. *
  4044. * @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.
  4045. * @param integer $float If you have to put the style "float: right"
  4046. * @param string $other Add more attributes on img
  4047. * @return string Return tag img
  4048. */
  4049. function img_view($titlealt = 'default', $float = 0, $other = 'class="valignmiddle"')
  4050. {
  4051. global $langs;
  4052. if ($titlealt == 'default') {
  4053. $titlealt = $langs->trans('View');
  4054. }
  4055. $moreatt = ($float ? 'style="float: right" ' : '').$other;
  4056. return img_picto($titlealt, 'view.png', $moreatt);
  4057. }
  4058. /**
  4059. * Show delete logo
  4060. *
  4061. * @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.
  4062. * @param string $other Add more attributes on img
  4063. * @param string $morecss More CSS
  4064. * @return string Retourne tag img
  4065. */
  4066. function img_delete($titlealt = 'default', $other = 'class="pictodelete"', $morecss = '')
  4067. {
  4068. global $langs;
  4069. if ($titlealt == 'default') {
  4070. $titlealt = $langs->trans('Delete');
  4071. }
  4072. return img_picto($titlealt, 'delete.png', $other, false, 0, 0, '', $morecss);
  4073. }
  4074. /**
  4075. * Show printer logo
  4076. *
  4077. * @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.
  4078. * @param string $other Add more attributes on img
  4079. * @return string Retourne tag img
  4080. */
  4081. function img_printer($titlealt = "default", $other = '')
  4082. {
  4083. global $langs;
  4084. if ($titlealt == "default") {
  4085. $titlealt = $langs->trans("Print");
  4086. }
  4087. return img_picto($titlealt, 'printer.png', $other);
  4088. }
  4089. /**
  4090. * Show split logo
  4091. *
  4092. * @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.
  4093. * @param string $other Add more attributes on img
  4094. * @return string Retourne tag img
  4095. */
  4096. function img_split($titlealt = 'default', $other = 'class="pictosplit"')
  4097. {
  4098. global $langs;
  4099. if ($titlealt == 'default') {
  4100. $titlealt = $langs->trans('Split');
  4101. }
  4102. return img_picto($titlealt, 'split.png', $other);
  4103. }
  4104. /**
  4105. * Show help logo with cursor "?"
  4106. *
  4107. * @param int $usehelpcursor 1=Use help cursor, 2=Use click pointer cursor, 0=No specific cursor
  4108. * @param int|string $usealttitle Text to use as alt title
  4109. * @return string Return tag img
  4110. */
  4111. function img_help($usehelpcursor = 1, $usealttitle = 1)
  4112. {
  4113. global $langs;
  4114. if ($usealttitle) {
  4115. if (is_string($usealttitle)) {
  4116. $usealttitle = dol_escape_htmltag($usealttitle);
  4117. } else {
  4118. $usealttitle = $langs->trans('Info');
  4119. }
  4120. }
  4121. return img_picto($usealttitle, 'info.png', 'style="vertical-align: middle;'.($usehelpcursor == 1 ? ' cursor: help' : ($usehelpcursor == 2 ? ' cursor: pointer' : '')).'"');
  4122. }
  4123. /**
  4124. * Show info logo
  4125. *
  4126. * @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.
  4127. * @return string Return img tag
  4128. */
  4129. function img_info($titlealt = 'default')
  4130. {
  4131. global $langs;
  4132. if ($titlealt == 'default') {
  4133. $titlealt = $langs->trans('Informations');
  4134. }
  4135. return img_picto($titlealt, 'info.png', 'style="vertical-align: middle;"');
  4136. }
  4137. /**
  4138. * Show warning logo
  4139. *
  4140. * @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.
  4141. * @param string $moreatt Add more attribute on img tag (For example 'style="float: right"'). If 1, add float: right. Can't be "class" attribute.
  4142. * @param string $morecss Add more CSS
  4143. * @return string Return img tag
  4144. */
  4145. function img_warning($titlealt = 'default', $moreatt = '', $morecss = 'pictowarning')
  4146. {
  4147. global $langs;
  4148. if ($titlealt == 'default') {
  4149. $titlealt = $langs->trans('Warning');
  4150. }
  4151. //return '<div class="imglatecoin">'.img_picto($titlealt, 'warning_white.png', 'class="pictowarning valignmiddle"'.($moreatt ? ($moreatt == '1' ? ' style="float: right"' : ' '.$moreatt): '')).'</div>';
  4152. return img_picto($titlealt, 'warning.png', 'class="'.$morecss.'"'.($moreatt ? ($moreatt == '1' ? ' style="float: right"' : ' '.$moreatt) : ''));
  4153. }
  4154. /**
  4155. * Show error logo
  4156. *
  4157. * @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.
  4158. * @return string Return img tag
  4159. */
  4160. function img_error($titlealt = 'default')
  4161. {
  4162. global $langs;
  4163. if ($titlealt == 'default') {
  4164. $titlealt = $langs->trans('Error');
  4165. }
  4166. return img_picto($titlealt, 'error.png');
  4167. }
  4168. /**
  4169. * Show next logo
  4170. *
  4171. * @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.
  4172. * @param string $moreatt Add more attribute on img tag (For example 'style="float: right"')
  4173. * @return string Return img tag
  4174. */
  4175. function img_next($titlealt = 'default', $moreatt = '')
  4176. {
  4177. global $langs;
  4178. if ($titlealt == 'default') {
  4179. $titlealt = $langs->trans('Next');
  4180. }
  4181. //return img_picto($titlealt, 'next.png', $moreatt);
  4182. return '<span class="fa fa-chevron-right paddingright paddingleft" title="'.dol_escape_htmltag($titlealt).'"></span>';
  4183. }
  4184. /**
  4185. * Show previous logo
  4186. *
  4187. * @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.
  4188. * @param string $moreatt Add more attribute on img tag (For example 'style="float: right"')
  4189. * @return string Return img tag
  4190. */
  4191. function img_previous($titlealt = 'default', $moreatt = '')
  4192. {
  4193. global $langs;
  4194. if ($titlealt == 'default') {
  4195. $titlealt = $langs->trans('Previous');
  4196. }
  4197. //return img_picto($titlealt, 'previous.png', $moreatt);
  4198. return '<span class="fa fa-chevron-left paddingright paddingleft" title="'.dol_escape_htmltag($titlealt).'"></span>';
  4199. }
  4200. /**
  4201. * Show down arrow logo
  4202. *
  4203. * @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.
  4204. * @param int $selected Selected
  4205. * @param string $moreclass Add more CSS classes
  4206. * @return string Return img tag
  4207. */
  4208. function img_down($titlealt = 'default', $selected = 0, $moreclass = '')
  4209. {
  4210. global $langs;
  4211. if ($titlealt == 'default') {
  4212. $titlealt = $langs->trans('Down');
  4213. }
  4214. return img_picto($titlealt, ($selected ? '1downarrow_selected.png' : '1downarrow.png'), 'class="imgdown'.($moreclass ? " ".$moreclass : "").'"');
  4215. }
  4216. /**
  4217. * Show top arrow logo
  4218. *
  4219. * @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.
  4220. * @param int $selected Selected
  4221. * @param string $moreclass Add more CSS classes
  4222. * @return string Return img tag
  4223. */
  4224. function img_up($titlealt = 'default', $selected = 0, $moreclass = '')
  4225. {
  4226. global $langs;
  4227. if ($titlealt == 'default') {
  4228. $titlealt = $langs->trans('Up');
  4229. }
  4230. return img_picto($titlealt, ($selected ? '1uparrow_selected.png' : '1uparrow.png'), 'class="imgup'.($moreclass ? " ".$moreclass : "").'"');
  4231. }
  4232. /**
  4233. * Show left arrow logo
  4234. *
  4235. * @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.
  4236. * @param int $selected Selected
  4237. * @param string $moreatt Add more attribute on img tag (For example 'style="float: right"')
  4238. * @return string Return img tag
  4239. */
  4240. function img_left($titlealt = 'default', $selected = 0, $moreatt = '')
  4241. {
  4242. global $langs;
  4243. if ($titlealt == 'default') {
  4244. $titlealt = $langs->trans('Left');
  4245. }
  4246. return img_picto($titlealt, ($selected ? '1leftarrow_selected.png' : '1leftarrow.png'), $moreatt);
  4247. }
  4248. /**
  4249. * Show right arrow logo
  4250. *
  4251. * @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.
  4252. * @param int $selected Selected
  4253. * @param string $moreatt Add more attribute on img tag (For example 'style="float: right"')
  4254. * @return string Return img tag
  4255. */
  4256. function img_right($titlealt = 'default', $selected = 0, $moreatt = '')
  4257. {
  4258. global $langs;
  4259. if ($titlealt == 'default') {
  4260. $titlealt = $langs->trans('Right');
  4261. }
  4262. return img_picto($titlealt, ($selected ? '1rightarrow_selected.png' : '1rightarrow.png'), $moreatt);
  4263. }
  4264. /**
  4265. * Show tick logo if allowed
  4266. *
  4267. * @param string $allow Allow
  4268. * @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.
  4269. * @return string Return img tag
  4270. */
  4271. function img_allow($allow, $titlealt = 'default')
  4272. {
  4273. global $langs;
  4274. if ($titlealt == 'default') {
  4275. $titlealt = $langs->trans('Active');
  4276. }
  4277. if ($allow == 1) {
  4278. return img_picto($titlealt, 'tick.png');
  4279. }
  4280. return '-';
  4281. }
  4282. /**
  4283. * Return image of a credit card according to its brand name
  4284. *
  4285. * @param string $brand Brand name of credit card
  4286. * @param string $morecss More CSS
  4287. * @return string Return img tag
  4288. */
  4289. function img_credit_card($brand, $morecss = null)
  4290. {
  4291. if (is_null($morecss)) {
  4292. $morecss = 'fa-2x';
  4293. }
  4294. if ($brand == 'visa' || $brand == 'Visa') {
  4295. $brand = 'cc-visa';
  4296. } elseif ($brand == 'mastercard' || $brand == 'MasterCard') {
  4297. $brand = 'cc-mastercard';
  4298. } elseif ($brand == 'amex' || $brand == 'American Express') {
  4299. $brand = 'cc-amex';
  4300. } elseif ($brand == 'discover' || $brand == 'Discover') {
  4301. $brand = 'cc-discover';
  4302. } elseif ($brand == 'jcb' || $brand == 'JCB') {
  4303. $brand = 'cc-jcb';
  4304. } elseif ($brand == 'diners' || $brand == 'Diners club') {
  4305. $brand = 'cc-diners-club';
  4306. } elseif (!in_array($brand, array('cc-visa', 'cc-mastercard', 'cc-amex', 'cc-discover', 'cc-jcb', 'cc-diners-club'))) {
  4307. $brand = 'credit-card';
  4308. }
  4309. return '<span class="fa fa-'.$brand.' fa-fw'.($morecss ? ' '.$morecss : '').'"></span>';
  4310. }
  4311. /**
  4312. * Show MIME img of a file
  4313. *
  4314. * @param string $file Filename
  4315. * @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.
  4316. * @param string $morecss More css
  4317. * @return string Return img tag
  4318. */
  4319. function img_mime($file, $titlealt = '', $morecss = '')
  4320. {
  4321. require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
  4322. $mimetype = dol_mimetype($file, '', 1);
  4323. $mimeimg = dol_mimetype($file, '', 2);
  4324. $mimefa = dol_mimetype($file, '', 4);
  4325. if (empty($titlealt)) {
  4326. $titlealt = 'Mime type: '.$mimetype;
  4327. }
  4328. //return img_picto_common($titlealt, 'mime/'.$mimeimg, 'class="'.$morecss.'"');
  4329. return '<i class="fa fa-'.$mimefa.' paddingright'.($morecss ? ' '.$morecss : '').'"'.($titlealt ? ' title="'.$titlealt.'"' : '').'></i>';
  4330. }
  4331. /**
  4332. * Show search logo
  4333. *
  4334. * @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.
  4335. * @param string $other Add more attributes on img
  4336. * @return string Retourne tag img
  4337. */
  4338. function img_search($titlealt = 'default', $other = '')
  4339. {
  4340. global $conf, $langs;
  4341. if ($titlealt == 'default') {
  4342. $titlealt = $langs->trans('Search');
  4343. }
  4344. $img = img_picto($titlealt, 'search.png', $other, false, 1);
  4345. $input = '<input type="image" class="liste_titre" name="button_search" src="'.$img.'" ';
  4346. $input .= 'value="'.dol_escape_htmltag($titlealt).'" title="'.dol_escape_htmltag($titlealt).'" >';
  4347. return $input;
  4348. }
  4349. /**
  4350. * Show search logo
  4351. *
  4352. * @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.
  4353. * @param string $other Add more attributes on img
  4354. * @return string Retourne tag img
  4355. */
  4356. function img_searchclear($titlealt = 'default', $other = '')
  4357. {
  4358. global $conf, $langs;
  4359. if ($titlealt == 'default') {
  4360. $titlealt = $langs->trans('Search');
  4361. }
  4362. $img = img_picto($titlealt, 'searchclear.png', $other, false, 1);
  4363. $input = '<input type="image" class="liste_titre" name="button_removefilter" src="'.$img.'" ';
  4364. $input .= 'value="'.dol_escape_htmltag($titlealt).'" title="'.dol_escape_htmltag($titlealt).'" >';
  4365. return $input;
  4366. }
  4367. /**
  4368. * Show information for admin users or standard users
  4369. *
  4370. * @param string $text Text info
  4371. * @param integer $infoonimgalt Info is shown only on alt of star picto, otherwise it is show on output after the star picto
  4372. * @param int $nodiv No div
  4373. * @param string $admin '1'=Info for admin users. '0'=Info for standard users (change only the look), 'error', 'warning', 'xxx'=Other
  4374. * @param string $morecss More CSS ('', 'warning', 'error')
  4375. * @param string $textfordropdown Show a text to click to dropdown the info box.
  4376. * @return string String with info text
  4377. */
  4378. function info_admin($text, $infoonimgalt = 0, $nodiv = 0, $admin = '1', $morecss = 'hideonsmartphone', $textfordropdown = '')
  4379. {
  4380. global $conf, $langs;
  4381. if ($infoonimgalt) {
  4382. $result = img_picto($text, 'info', 'class="'.($morecss ? ' '.$morecss : '').'"');
  4383. } else {
  4384. if (empty($conf->use_javascript_ajax)) {
  4385. $textfordropdown = '';
  4386. }
  4387. $class = (empty($admin) ? 'undefined' : ($admin == '1' ? 'info' : $admin));
  4388. $result = ($nodiv ? '' : '<div class="'.$class.($morecss ? ' '.$morecss : '').($textfordropdown ? ' hidden' : '').'">').'<span class="fa fa-info-circle" title="'.dol_escape_htmltag($admin ? $langs->trans('InfoAdmin') : $langs->trans('Note')).'"></span> '.$text.($nodiv ? '' : '</div>');
  4389. if ($textfordropdown) {
  4390. $tmpresult = '<span class="'.$class.'text opacitymedium cursorpointer">'.$langs->trans($textfordropdown).' '.img_picto($langs->trans($textfordropdown), '1downarrow').'</span>';
  4391. $tmpresult .= '<script type="text/javascript">
  4392. jQuery(document).ready(function() {
  4393. jQuery(".'.$class.'text").click(function() {
  4394. console.log("toggle text");
  4395. jQuery(".'.$class.'").toggle();
  4396. });
  4397. });
  4398. </script>';
  4399. $result = $tmpresult.$result;
  4400. }
  4401. }
  4402. return $result;
  4403. }
  4404. /**
  4405. * Displays error message system with all the information to facilitate the diagnosis and the escalation of the bugs.
  4406. * This function must be called when a blocking technical error is encountered.
  4407. * However, one must try to call it only within php pages, classes must return their error through their property "error".
  4408. *
  4409. * @param DoliDB|string $db Database handler
  4410. * @param string|string[] $error String or array of errors strings to show
  4411. * @param array $errors Array of errors
  4412. * @return void
  4413. * @see dol_htmloutput_errors()
  4414. */
  4415. function dol_print_error($db = '', $error = '', $errors = null)
  4416. {
  4417. global $conf, $langs, $argv;
  4418. global $dolibarr_main_prod;
  4419. $out = '';
  4420. $syslog = '';
  4421. // If error occurs before the $lang object was loaded
  4422. if (!$langs) {
  4423. require_once DOL_DOCUMENT_ROOT.'/core/class/translate.class.php';
  4424. $langs = new Translate('', $conf);
  4425. $langs->load("main");
  4426. }
  4427. // Load translation files required by the error messages
  4428. $langs->loadLangs(array('main', 'errors'));
  4429. if ($_SERVER['DOCUMENT_ROOT']) { // Mode web
  4430. $out .= $langs->trans("DolibarrHasDetectedError").".<br>\n";
  4431. if (getDolGlobalInt('MAIN_FEATURES_LEVEL') > 0) {
  4432. $out .= "You use an experimental or develop level of features, so please do NOT report any bugs or vulnerability, except if problem is confirmed after moving option MAIN_FEATURES_LEVEL back to 0.<br>\n";
  4433. }
  4434. $out .= $langs->trans("InformationToHelpDiagnose").":<br>\n";
  4435. $out .= "<b>".$langs->trans("Date").":</b> ".dol_print_date(time(), 'dayhourlog')."<br>\n";
  4436. $out .= "<b>".$langs->trans("Dolibarr").":</b> ".DOL_VERSION." - https://www.dolibarr.org<br>\n";
  4437. if (isset($conf->global->MAIN_FEATURES_LEVEL)) {
  4438. $out .= "<b>".$langs->trans("LevelOfFeature").":</b> ".getDolGlobalInt('MAIN_FEATURES_LEVEL')."<br>\n";
  4439. }
  4440. if (function_exists("phpversion")) {
  4441. $out .= "<b>".$langs->trans("PHP").":</b> ".phpversion()."<br>\n";
  4442. }
  4443. $out .= "<b>".$langs->trans("Server").":</b> ".(isset($_SERVER["SERVER_SOFTWARE"]) ? dol_htmlentities($_SERVER["SERVER_SOFTWARE"], ENT_COMPAT) : '')."<br>\n";
  4444. if (function_exists("php_uname")) {
  4445. $out .= "<b>".$langs->trans("OS").":</b> ".php_uname()."<br>\n";
  4446. }
  4447. $out .= "<b>".$langs->trans("UserAgent").":</b> ".(isset($_SERVER["HTTP_USER_AGENT"]) ? dol_htmlentities($_SERVER["HTTP_USER_AGENT"], ENT_COMPAT) : '')."<br>\n";
  4448. $out .= "<br>\n";
  4449. $out .= "<b>".$langs->trans("RequestedUrl").":</b> ".dol_htmlentities($_SERVER["REQUEST_URI"], ENT_COMPAT)."<br>\n";
  4450. $out .= "<b>".$langs->trans("Referer").":</b> ".(isset($_SERVER["HTTP_REFERER"]) ? dol_htmlentities($_SERVER["HTTP_REFERER"], ENT_COMPAT) : '')."<br>\n";
  4451. $out .= "<b>".$langs->trans("MenuManager").":</b> ".(isset($conf->standard_menu) ? dol_htmlentities($conf->standard_menu, ENT_COMPAT) : '')."<br>\n";
  4452. $out .= "<br>\n";
  4453. $syslog .= "url=".dol_escape_htmltag($_SERVER["REQUEST_URI"]);
  4454. $syslog .= ", query_string=".dol_escape_htmltag($_SERVER["QUERY_STRING"]);
  4455. } else // Mode CLI
  4456. {
  4457. $out .= '> '.$langs->transnoentities("ErrorInternalErrorDetected").":\n".$argv[0]."\n";
  4458. $syslog .= "pid=".dol_getmypid();
  4459. }
  4460. if (!empty($conf->modules)) {
  4461. $out .= "<b>".$langs->trans("Modules").":</b> ".join(', ', $conf->modules)."<br>\n";
  4462. }
  4463. if (is_object($db)) {
  4464. if ($_SERVER['DOCUMENT_ROOT']) { // Mode web
  4465. $out .= "<b>".$langs->trans("DatabaseTypeManager").":</b> ".$db->type."<br>\n";
  4466. $out .= "<b>".$langs->trans("RequestLastAccessInError").":</b> ".($db->lastqueryerror() ? dol_escape_htmltag($db->lastqueryerror()) : $langs->trans("ErrorNoRequestInError"))."<br>\n";
  4467. $out .= "<b>".$langs->trans("ReturnCodeLastAccessInError").":</b> ".($db->lasterrno() ? dol_escape_htmltag($db->lasterrno()) : $langs->trans("ErrorNoRequestInError"))."<br>\n";
  4468. $out .= "<b>".$langs->trans("InformationLastAccessInError").":</b> ".($db->lasterror() ? dol_escape_htmltag($db->lasterror()) : $langs->trans("ErrorNoRequestInError"))."<br>\n";
  4469. $out .= "<br>\n";
  4470. } else // Mode CLI
  4471. {
  4472. // No dol_escape_htmltag for output, we are in CLI mode
  4473. $out .= '> '.$langs->transnoentities("DatabaseTypeManager").":\n".$db->type."\n";
  4474. $out .= '> '.$langs->transnoentities("RequestLastAccessInError").":\n".($db->lastqueryerror() ? $db->lastqueryerror() : $langs->transnoentities("ErrorNoRequestInError"))."\n";
  4475. $out .= '> '.$langs->transnoentities("ReturnCodeLastAccessInError").":\n".($db->lasterrno() ? $db->lasterrno() : $langs->transnoentities("ErrorNoRequestInError"))."\n";
  4476. $out .= '> '.$langs->transnoentities("InformationLastAccessInError").":\n".($db->lasterror() ? $db->lasterror() : $langs->transnoentities("ErrorNoRequestInError"))."\n";
  4477. }
  4478. $syslog .= ", sql=".$db->lastquery();
  4479. $syslog .= ", db_error=".$db->lasterror();
  4480. }
  4481. if ($error || $errors) {
  4482. $langs->load("errors");
  4483. // Merge all into $errors array
  4484. if (is_array($error) && is_array($errors)) {
  4485. $errors = array_merge($error, $errors);
  4486. } elseif (is_array($error)) {
  4487. $errors = $error;
  4488. } elseif (is_array($errors)) {
  4489. $errors = array_merge(array($error), $errors);
  4490. } else {
  4491. $errors = array_merge(array($error));
  4492. }
  4493. foreach ($errors as $msg) {
  4494. if (empty($msg)) {
  4495. continue;
  4496. }
  4497. if ($_SERVER['DOCUMENT_ROOT']) { // Mode web
  4498. $out .= "<b>".$langs->trans("Message").":</b> ".dol_escape_htmltag($msg)."<br>\n";
  4499. } else // Mode CLI
  4500. {
  4501. $out .= '> '.$langs->transnoentities("Message").":\n".$msg."\n";
  4502. }
  4503. $syslog .= ", msg=".$msg;
  4504. }
  4505. }
  4506. if (empty($dolibarr_main_prod) && $_SERVER['DOCUMENT_ROOT'] && function_exists('xdebug_print_function_stack') && function_exists('xdebug_call_file')) {
  4507. xdebug_print_function_stack();
  4508. $out .= '<b>XDebug informations:</b>'."<br>\n";
  4509. $out .= 'File: '.xdebug_call_file()."<br>\n";
  4510. $out .= 'Line: '.xdebug_call_line()."<br>\n";
  4511. $out .= 'Function: '.xdebug_call_function()."<br>\n";
  4512. $out .= "<br>\n";
  4513. }
  4514. // Return a http error code if possible
  4515. if (!headers_sent()) {
  4516. http_response_code(500);
  4517. }
  4518. if (empty($dolibarr_main_prod)) {
  4519. print $out;
  4520. } else {
  4521. if (empty($langs->defaultlang)) {
  4522. $langs->setDefaultLang();
  4523. }
  4524. $langs->loadLangs(array("main", "errors")); // Reload main because language may have been set only on previous line so we have to reload files we need.
  4525. // This should not happen, except if there is a bug somewhere. Enabled and check log in such case.
  4526. print 'This website or feature is currently temporarly not available or failed after a technical error.<br><br>This may be due to a maintenance operation. Current status of operation ('.dol_print_date(dol_now(), 'dayhourrfc').') are on next line...<br><br>'."\n";
  4527. print $langs->trans("DolibarrHasDetectedError").'. ';
  4528. print $langs->trans("YouCanSetOptionDolibarrMainProdToZero");
  4529. define("MAIN_CORE_ERROR", 1);
  4530. }
  4531. dol_syslog("Error ".$syslog, LOG_ERR);
  4532. }
  4533. /**
  4534. * Show a public email and error code to contact if technical error
  4535. *
  4536. * @param string $prefixcode Prefix of public error code
  4537. * @param string $errormessage Complete error message
  4538. * @param array $errormessages Array of error messages
  4539. * @param string $morecss More css
  4540. * @param string $email Email
  4541. * @return void
  4542. */
  4543. function dol_print_error_email($prefixcode, $errormessage = '', $errormessages = array(), $morecss = 'error', $email = '')
  4544. {
  4545. global $langs, $conf;
  4546. if (empty($email)) {
  4547. $email = $conf->global->MAIN_INFO_SOCIETE_MAIL;
  4548. }
  4549. $langs->load("errors");
  4550. $now = dol_now();
  4551. print '<br><div class="center login_main_message"><div class="'.$morecss.'">';
  4552. print $langs->trans("ErrorContactEMail", $email, $prefixcode.dol_print_date($now, '%Y%m%d%H%M%S'));
  4553. if ($errormessage) {
  4554. print '<br><br>'.$errormessage;
  4555. }
  4556. if (is_array($errormessages) && count($errormessages)) {
  4557. foreach ($errormessages as $mesgtoshow) {
  4558. print '<br><br>'.$mesgtoshow;
  4559. }
  4560. }
  4561. print '</div></div>';
  4562. }
  4563. /**
  4564. * Show title line of an array
  4565. *
  4566. * @param string $name Label of field
  4567. * @param string $file Url used when we click on sort picto
  4568. * @param string $field Field to use for new sorting
  4569. * @param string $begin ("" by defaut)
  4570. * @param string $moreparam Add more parameters on sort url links ("" by default)
  4571. * @param string $moreattrib Options of attribute td ("" by defaut)
  4572. * @param string $sortfield Current field used to sort
  4573. * @param string $sortorder Current sort order
  4574. * @param string $prefix Prefix for css. Use space after prefix to add your own CSS tag.
  4575. * @param string $tooltip Tooltip
  4576. * @param string $forcenowrapcolumntitle No need for use 'wrapcolumntitle' css style
  4577. * @return void
  4578. */
  4579. function print_liste_field_titre($name, $file = "", $field = "", $begin = "", $moreparam = "", $moreattrib = "", $sortfield = "", $sortorder = "", $prefix = "", $tooltip = "", $forcenowrapcolumntitle = 0)
  4580. {
  4581. print getTitleFieldOfList($name, 0, $file, $field, $begin, $moreparam, $moreattrib, $sortfield, $sortorder, $prefix, 0, $tooltip, $forcenowrapcolumntitle);
  4582. }
  4583. /**
  4584. * Get title line of an array
  4585. *
  4586. * @param string $name Translation key of field to show or complete HTML string to show
  4587. * @param int $thead 0=To use with standard table format, 1=To use inside <thead><tr>, 2=To use with <div>
  4588. * @param string $file Url used when we click on sort picto
  4589. * @param string $field Field to use for new sorting. Empty if this field is not sortable. Example "t.abc" or "t.abc,t.def"
  4590. * @param string $begin ("" by defaut)
  4591. * @param string $moreparam Add more parameters on sort url links ("" by default)
  4592. * @param string $moreattrib Add more attributes on th ("" by defaut). To add more css class, use param $prefix.
  4593. * @param string $sortfield Current field used to sort (Ex: 'd.datep,d.id')
  4594. * @param string $sortorder Current sort order (Ex: 'asc,desc')
  4595. * @param string $prefix Prefix for css. Use space after prefix to add your own CSS tag, for example 'mycss '.
  4596. * @param string $disablesortlink 1=Disable sort link
  4597. * @param string $tooltip Tooltip
  4598. * @param string $forcenowrapcolumntitle No need for use 'wrapcolumntitle' css style
  4599. * @return string
  4600. */
  4601. function getTitleFieldOfList($name, $thead = 0, $file = "", $field = "", $begin = "", $moreparam = "", $moreattrib = "", $sortfield = "", $sortorder = "", $prefix = "", $disablesortlink = 0, $tooltip = '', $forcenowrapcolumntitle = 0)
  4602. {
  4603. global $conf, $langs, $form;
  4604. //print "$name, $file, $field, $begin, $options, $moreattrib, $sortfield, $sortorder<br>\n";
  4605. if ($moreattrib == 'class="right"') {
  4606. $prefix .= 'right '; // For backward compatibility
  4607. }
  4608. $sortorder = strtoupper($sortorder);
  4609. $out = '';
  4610. $sortimg = '';
  4611. $tag = 'th';
  4612. if ($thead == 2) {
  4613. $tag = 'div';
  4614. }
  4615. $tmpsortfield = explode(',', $sortfield);
  4616. $sortfield1 = trim($tmpsortfield[0]); // If $sortfield is 'd.datep,d.id', it becomes 'd.datep'
  4617. $tmpfield = explode(',', $field);
  4618. $field1 = trim($tmpfield[0]); // If $field is 'd.datep,d.id', it becomes 'd.datep'
  4619. if (empty($conf->global->MAIN_DISABLE_WRAPPING_ON_COLUMN_TITLE) && empty($forcenowrapcolumntitle)) {
  4620. $prefix = 'wrapcolumntitle '.$prefix;
  4621. }
  4622. //var_dump('field='.$field.' field1='.$field1.' sortfield='.$sortfield.' sortfield1='.$sortfield1);
  4623. // If field is used as sort criteria we use a specific css class liste_titre_sel
  4624. // Example if (sortfield,field)=("nom","xxx.nom") or (sortfield,field)=("nom","nom")
  4625. $liste_titre = 'liste_titre';
  4626. if ($field1 && ($sortfield1 == $field1 || $sortfield1 == preg_replace("/^[^\.]+\./", "", $field1))) {
  4627. $liste_titre = 'liste_titre_sel';
  4628. }
  4629. $tagstart = '<'.$tag.' class="'.$prefix.$liste_titre.'" '.$moreattrib;
  4630. //$out .= (($field && empty($conf->global->MAIN_DISABLE_WRAPPING_ON_COLUMN_TITLE) && preg_match('/^[a-zA-Z_0-9\s\.\-:&;]*$/', $name)) ? ' title="'.dol_escape_htmltag($langs->trans($name)).'"' : '');
  4631. $tagstart .= ($name && empty($conf->global->MAIN_DISABLE_WRAPPING_ON_COLUMN_TITLE) && empty($forcenowrapcolumntitle) && !dol_textishtml($name)) ? ' title="'.dol_escape_htmltag($langs->trans($name)).'"' : '';
  4632. $tagstart .= '>';
  4633. if (empty($thead) && $field && empty($disablesortlink)) { // If this is a sort field
  4634. $options = preg_replace('/sortfield=([a-zA-Z0-9,\s\.]+)/i', '', (is_scalar($moreparam) ? $moreparam : ''));
  4635. $options = preg_replace('/sortorder=([a-zA-Z0-9,\s\.]+)/i', '', $options);
  4636. $options = preg_replace('/&+/i', '&', $options);
  4637. if (!preg_match('/^&/', $options)) {
  4638. $options = '&'.$options;
  4639. }
  4640. $sortordertouseinlink = '';
  4641. if ($field1 != $sortfield1) { // We are on another field than current sorted field
  4642. if (preg_match('/^DESC/i', $sortorder)) {
  4643. $sortordertouseinlink .= str_repeat('desc,', count(explode(',', $field)));
  4644. } else { // We reverse the var $sortordertouseinlink
  4645. $sortordertouseinlink .= str_repeat('asc,', count(explode(',', $field)));
  4646. }
  4647. } else { // We are on field that is the first current sorting criteria
  4648. if (preg_match('/^ASC/i', $sortorder)) { // We reverse the var $sortordertouseinlink
  4649. $sortordertouseinlink .= str_repeat('desc,', count(explode(',', $field)));
  4650. } else {
  4651. $sortordertouseinlink .= str_repeat('asc,', count(explode(',', $field)));
  4652. }
  4653. }
  4654. $sortordertouseinlink = preg_replace('/,$/', '', $sortordertouseinlink);
  4655. $out .= '<a class="reposition" href="'.$file.'?sortfield='.$field.'&sortorder='.$sortordertouseinlink.'&begin='.$begin.$options.'"';
  4656. //$out .= (empty($conf->global->MAIN_DISABLE_WRAPPING_ON_COLUMN_TITLE) ? ' title="'.dol_escape_htmltag($langs->trans($name)).'"' : '');
  4657. $out .= '>';
  4658. }
  4659. if ($tooltip) {
  4660. // You can also use 'TranslationString:keyfortooltiponlick' for a tooltip on click.
  4661. $tmptooltip = explode(':', $tooltip);
  4662. $out .= $form->textwithpicto($langs->trans($name), $langs->trans($tmptooltip[0]), 1, 'help', '', 0, 3, (empty($tmptooltip[1]) ? '' : 'extra_'.str_replace('.', '_', $field).'_'.$tmptooltip[1]));
  4663. } else {
  4664. $out .= $langs->trans($name);
  4665. }
  4666. if (empty($thead) && $field && empty($disablesortlink)) { // If this is a sort field
  4667. $out .= '</a>';
  4668. }
  4669. if (empty($thead) && $field) { // If this is a sort field
  4670. $options = preg_replace('/sortfield=([a-zA-Z0-9,\s\.]+)/i', '', (is_scalar($moreparam) ? $moreparam : ''));
  4671. $options = preg_replace('/sortorder=([a-zA-Z0-9,\s\.]+)/i', '', $options);
  4672. $options = preg_replace('/&+/i', '&', $options);
  4673. if (!preg_match('/^&/', $options)) {
  4674. $options = '&'.$options;
  4675. }
  4676. if (!$sortorder || $field1 != $sortfield1) {
  4677. //$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=asc&begin='.$begin.$options.'">'.img_down("A-Z",0).'</a>';
  4678. //$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=desc&begin='.$begin.$options.'">'.img_up("Z-A",0).'</a>';
  4679. } else {
  4680. if (preg_match('/^DESC/', $sortorder)) {
  4681. //$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=asc&begin='.$begin.$options.'">'.img_down("A-Z",0).'</a>';
  4682. //$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=desc&begin='.$begin.$options.'">'.img_up("Z-A",1).'</a>';
  4683. $sortimg .= '<span class="nowrap">'.img_up("Z-A", 0, 'paddingright').'</span>';
  4684. }
  4685. if (preg_match('/^ASC/', $sortorder)) {
  4686. //$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=asc&begin='.$begin.$options.'">'.img_down("A-Z",1).'</a>';
  4687. //$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=desc&begin='.$begin.$options.'">'.img_up("Z-A",0).'</a>';
  4688. $sortimg .= '<span class="nowrap">'.img_down("A-Z", 0, 'paddingright').'</span>';
  4689. }
  4690. }
  4691. }
  4692. $tagend = '</'.$tag.'>';
  4693. $out = $tagstart.$sortimg.$out.$tagend;
  4694. return $out;
  4695. }
  4696. /**
  4697. * Show a title.
  4698. *
  4699. * @param string $title Title to show
  4700. * @return void
  4701. * @deprecated Use load_fiche_titre instead
  4702. * @see load_fiche_titre()
  4703. */
  4704. function print_titre($title)
  4705. {
  4706. dol_syslog(__FUNCTION__." is deprecated", LOG_WARNING);
  4707. print '<div class="titre">'.$title.'</div>';
  4708. }
  4709. /**
  4710. * Show a title with picto
  4711. *
  4712. * @param string $title Title to show
  4713. * @param string $mesg Added message to show on right
  4714. * @param string $picto Icon to use before title (should be a 32x32 transparent png file)
  4715. * @param int $pictoisfullpath 1=Icon name is a full absolute url of image
  4716. * @param int $id To force an id on html objects
  4717. * @return void
  4718. * @deprecated Use print load_fiche_titre instead
  4719. */
  4720. function print_fiche_titre($title, $mesg = '', $picto = 'generic', $pictoisfullpath = 0, $id = '')
  4721. {
  4722. print load_fiche_titre($title, $mesg, $picto, $pictoisfullpath, $id);
  4723. }
  4724. /**
  4725. * Load a title with picto
  4726. *
  4727. * @param string $titre Title to show
  4728. * @param string $morehtmlright Added message to show on right
  4729. * @param string $picto Icon to use before title (should be a 32x32 transparent png file)
  4730. * @param int $pictoisfullpath 1=Icon name is a full absolute url of image
  4731. * @param string $id To force an id on html objects
  4732. * @param string $morecssontable More css on table
  4733. * @param string $morehtmlcenter Added message to show on center
  4734. * @return string
  4735. * @see print_barre_liste()
  4736. */
  4737. function load_fiche_titre($titre, $morehtmlright = '', $picto = 'generic', $pictoisfullpath = 0, $id = '', $morecssontable = '', $morehtmlcenter = '')
  4738. {
  4739. global $conf;
  4740. $return = '';
  4741. if ($picto == 'setup') {
  4742. $picto = 'generic';
  4743. }
  4744. $return .= "\n";
  4745. $return .= '<table '.($id ? 'id="'.$id.'" ' : '').'class="centpercent notopnoleftnoright table-fiche-title'.($morecssontable ? ' '.$morecssontable : '').'">'; // maring bottom must be same than into print_barre_list
  4746. $return .= '<tr class="titre">';
  4747. if ($picto) {
  4748. $return .= '<td class="nobordernopadding widthpictotitle valignmiddle col-picto">'.img_picto('', $picto, 'class="valignmiddle widthpictotitle pictotitle"', $pictoisfullpath).'</td>';
  4749. }
  4750. $return .= '<td class="nobordernopadding valignmiddle col-title">';
  4751. $return .= '<div class="titre inline-block">'.$titre.'</div>';
  4752. $return .= '</td>';
  4753. if (dol_strlen($morehtmlcenter)) {
  4754. $return .= '<td class="nobordernopadding center valignmiddle">'.$morehtmlcenter.'</td>';
  4755. }
  4756. if (dol_strlen($morehtmlright)) {
  4757. $return .= '<td class="nobordernopadding titre_right wordbreakimp right valignmiddle">'.$morehtmlright.'</td>';
  4758. }
  4759. $return .= '</tr></table>'."\n";
  4760. return $return;
  4761. }
  4762. /**
  4763. * Print a title with navigation controls for pagination
  4764. *
  4765. * @param string $titre Title to show (required)
  4766. * @param int $page Numero of page to show in navigation links (required)
  4767. * @param string $file Url of page (required)
  4768. * @param string $options More parameters for links ('' by default, does not include sortfield neither sortorder). Value must be 'urlencoded' before calling function.
  4769. * @param string $sortfield Field to sort on ('' by default)
  4770. * @param string $sortorder Order to sort ('' by default)
  4771. * @param string $morehtmlcenter String in the middle ('' by default). We often find here string $massaction comming from $form->selectMassAction()
  4772. * @param int $num Number of records found by select with limit+1
  4773. * @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.
  4774. * @param string $picto Icon to use before title (should be a 32x32 transparent png file)
  4775. * @param int $pictoisfullpath 1=Icon name is a full absolute url of image
  4776. * @param string $morehtmlright More html to show (after arrows)
  4777. * @param string $morecss More css to the table
  4778. * @param int $limit Max number of lines (-1 = use default, 0 = no limit, > 0 = limit).
  4779. * @param int $hideselectlimit Force to hide select limit
  4780. * @param int $hidenavigation Force to hide all navigation tools
  4781. * @param int $pagenavastextinput 1=Do not suggest list of pages to navigate but suggest the page number into an input field.
  4782. * @param string $morehtmlrightbeforearrow More html to show (before arrows)
  4783. * @return void
  4784. */
  4785. function print_barre_liste($titre, $page, $file, $options = '', $sortfield = '', $sortorder = '', $morehtmlcenter = '', $num = -1, $totalnboflines = '', $picto = 'generic', $pictoisfullpath = 0, $morehtmlright = '', $morecss = '', $limit = -1, $hideselectlimit = 0, $hidenavigation = 0, $pagenavastextinput = 0, $morehtmlrightbeforearrow = '')
  4786. {
  4787. global $conf, $langs;
  4788. $savlimit = $limit;
  4789. $savtotalnboflines = $totalnboflines;
  4790. $totalnboflines = abs((int) $totalnboflines);
  4791. if ($picto == 'setup') {
  4792. $picto = 'title_setup.png';
  4793. }
  4794. if (($conf->browser->name == 'ie') && $picto == 'generic') {
  4795. $picto = 'title.gif';
  4796. }
  4797. if ($limit < 0) {
  4798. $limit = $conf->liste_limit;
  4799. }
  4800. if ($savlimit != 0 && (($num > $limit) || ($num == -1) || ($limit == 0))) {
  4801. $nextpage = 1;
  4802. } else {
  4803. $nextpage = 0;
  4804. }
  4805. //print 'totalnboflines='.$totalnboflines.'-savlimit='.$savlimit.'-limit='.$limit.'-num='.$num.'-nextpage='.$nextpage;
  4806. print "\n";
  4807. print "<!-- Begin title -->\n";
  4808. print '<table class="centpercent notopnoleftnoright table-fiche-title'.($morecss ? ' '.$morecss : '').'"><tr>'; // maring bottom must be same than into load_fiche_tire
  4809. // Left
  4810. if ($picto && $titre) {
  4811. print '<td class="nobordernopadding widthpictotitle valignmiddle col-picto">'.img_picto('', $picto, 'class="valignmiddle pictotitle widthpictotitle"', $pictoisfullpath).'</td>';
  4812. }
  4813. print '<td class="nobordernopadding valignmiddle col-title">';
  4814. print '<div class="titre inline-block">'.$titre;
  4815. if (!empty($titre) && $savtotalnboflines >= 0 && (string) $savtotalnboflines != '') {
  4816. print '<span class="opacitymedium colorblack paddingleft">('.$totalnboflines.')</span>';
  4817. }
  4818. print '</div></td>';
  4819. // Center
  4820. if ($morehtmlcenter) {
  4821. print '<td class="nobordernopadding center valignmiddle">'.$morehtmlcenter.'</td>';
  4822. }
  4823. // Right
  4824. print '<td class="nobordernopadding valignmiddle right">';
  4825. print '<input type="hidden" name="pageplusoneold" value="'.((int) $page + 1).'">';
  4826. if ($sortfield) {
  4827. $options .= "&sortfield=".urlencode($sortfield);
  4828. }
  4829. if ($sortorder) {
  4830. $options .= "&sortorder=".urlencode($sortorder);
  4831. }
  4832. // Show navigation bar
  4833. $pagelist = '';
  4834. if ($savlimit != 0 && ($page > 0 || $num > $limit)) {
  4835. if ($totalnboflines) { // If we know total nb of lines
  4836. // Define nb of extra page links before and after selected page + ... + first or last
  4837. $maxnbofpage = (empty($conf->dol_optimize_smallscreen) ? 4 : 0);
  4838. if ($limit > 0) {
  4839. $nbpages = ceil($totalnboflines / $limit);
  4840. } else {
  4841. $nbpages = 1;
  4842. }
  4843. $cpt = ($page - $maxnbofpage);
  4844. if ($cpt < 0) {
  4845. $cpt = 0;
  4846. }
  4847. if ($cpt >= 1) {
  4848. if (empty($pagenavastextinput)) {
  4849. $pagelist .= '<li class="pagination"><a href="'.$file.'?page=0'.$options.'">1</a></li>';
  4850. if ($cpt > 2) {
  4851. $pagelist .= '<li class="pagination"><span class="inactive">...</span></li>';
  4852. } elseif ($cpt == 2) {
  4853. $pagelist .= '<li class="pagination"><a href="'.$file.'?page=1'.$options.'">2</a></li>';
  4854. }
  4855. }
  4856. }
  4857. do {
  4858. if ($pagenavastextinput) {
  4859. if ($cpt == $page) {
  4860. $pagelist .= '<li class="pagination"><input type="text" class="width25 center pageplusone" name="pageplusone" value="'.($page + 1).'"></li>';
  4861. $pagelist .= '/';
  4862. }
  4863. } else {
  4864. if ($cpt == $page) {
  4865. $pagelist .= '<li class="pagination"><span class="active">'.($page + 1).'</span></li>';
  4866. } else {
  4867. $pagelist .= '<li class="pagination"><a href="'.$file.'?page='.$cpt.$options.'">'.($cpt + 1).'</a></li>';
  4868. }
  4869. }
  4870. $cpt++;
  4871. } while ($cpt < $nbpages && $cpt <= ($page + $maxnbofpage));
  4872. if (empty($pagenavastextinput)) {
  4873. if ($cpt < $nbpages) {
  4874. if ($cpt < $nbpages - 2) {
  4875. $pagelist .= '<li class="pagination"><span class="inactive">...</span></li>';
  4876. } elseif ($cpt == $nbpages - 2) {
  4877. $pagelist .= '<li class="pagination"><a href="'.$file.'?page='.($nbpages - 2).$options.'">'.($nbpages - 1).'</a></li>';
  4878. }
  4879. $pagelist .= '<li class="pagination"><a href="'.$file.'?page='.($nbpages - 1).$options.'">'.$nbpages.'</a></li>';
  4880. }
  4881. } else {
  4882. //var_dump($page.' '.$cpt.' '.$nbpages);
  4883. $pagelist .= '<li class="pagination paginationlastpage"><a href="'.$file.'?page='.($nbpages - 1).$options.'">'.$nbpages.'</a></li>';
  4884. }
  4885. } else {
  4886. $pagelist .= '<li class="pagination"><span class="active">'.($page + 1)."</li>";
  4887. }
  4888. }
  4889. if ($savlimit || $morehtmlright || $morehtmlrightbeforearrow) {
  4890. print_fleche_navigation($page, $file, $options, $nextpage, $pagelist, $morehtmlright, $savlimit, $totalnboflines, $hideselectlimit, $morehtmlrightbeforearrow); // output the div and ul for previous/last completed with page numbers into $pagelist
  4891. }
  4892. // js to autoselect page field on focus
  4893. if ($pagenavastextinput) {
  4894. print ajax_autoselect('.pageplusone');
  4895. }
  4896. print '</td>';
  4897. print '</tr></table>'."\n";
  4898. print "<!-- End title -->\n\n";
  4899. }
  4900. /**
  4901. * Function to show navigation arrows into lists
  4902. *
  4903. * @param int $page Number of page
  4904. * @param string $file Page URL (in most cases provided with $_SERVER["PHP_SELF"])
  4905. * @param string $options Other url parameters to propagate ("" by default, may include sortfield and sortorder)
  4906. * @param integer $nextpage Do we show a next page button
  4907. * @param string $betweenarrows HTML content to show between arrows. MUST contains '<li> </li>' tags or '<li><span> </span></li>'.
  4908. * @param string $afterarrows HTML content to show after arrows. Must NOT contains '<li> </li>' tags.
  4909. * @param int $limit Max nb of record to show (-1 = no combo with limit, 0 = no limit, > 0 = limit)
  4910. * @param int $totalnboflines Total number of records/lines for all pages (if known)
  4911. * @param int $hideselectlimit Force to hide select limit
  4912. * @param string $beforearrows HTML content to show before arrows. Must NOT contains '<li> </li>' tags.
  4913. * @return void
  4914. */
  4915. function print_fleche_navigation($page, $file, $options = '', $nextpage = 0, $betweenarrows = '', $afterarrows = '', $limit = -1, $totalnboflines = 0, $hideselectlimit = 0, $beforearrows = '')
  4916. {
  4917. global $conf, $langs;
  4918. print '<div class="pagination"><ul>';
  4919. if ($beforearrows) {
  4920. print '<li class="paginationbeforearrows">';
  4921. print $beforearrows;
  4922. print '</li>';
  4923. }
  4924. if ((int) $limit > 0 && empty($hideselectlimit)) {
  4925. $pagesizechoices = '10:10,15:15,20:20,30:30,40:40,50:50,100:100,250:250,500:500,1000:1000';
  4926. $pagesizechoices .= ',5000:5000,10000:10000,20000:20000';
  4927. //$pagesizechoices.=',0:'.$langs->trans("All"); // Not yet supported
  4928. //$pagesizechoices.=',2:2';
  4929. if (!empty($conf->global->MAIN_PAGESIZE_CHOICES)) {
  4930. $pagesizechoices = $conf->global->MAIN_PAGESIZE_CHOICES;
  4931. }
  4932. print '<li class="pagination">';
  4933. print '<select class="flat selectlimit" name="limit" title="'.dol_escape_htmltag($langs->trans("MaxNbOfRecordPerPage")).'">';
  4934. $tmpchoice = explode(',', $pagesizechoices);
  4935. $tmpkey = $limit.':'.$limit;
  4936. if (!in_array($tmpkey, $tmpchoice)) {
  4937. $tmpchoice[] = $tmpkey;
  4938. }
  4939. $tmpkey = $conf->liste_limit.':'.$conf->liste_limit;
  4940. if (!in_array($tmpkey, $tmpchoice)) {
  4941. $tmpchoice[] = $tmpkey;
  4942. }
  4943. asort($tmpchoice, SORT_NUMERIC);
  4944. foreach ($tmpchoice as $val) {
  4945. $selected = '';
  4946. $tmp = explode(':', $val);
  4947. $key = $tmp[0];
  4948. $val = $tmp[1];
  4949. if ($key != '' && $val != '') {
  4950. if ((int) $key == (int) $limit) {
  4951. $selected = ' selected="selected"';
  4952. }
  4953. print '<option name="'.$key.'"'.$selected.'>'.dol_escape_htmltag($val).'</option>'."\n";
  4954. }
  4955. }
  4956. print '</select>';
  4957. if ($conf->use_javascript_ajax) {
  4958. print '<!-- JS CODE TO ENABLE select limit to launch submit of page -->
  4959. <script>
  4960. jQuery(document).ready(function () {
  4961. jQuery(".selectlimit").change(function() {
  4962. console.log("Change limit. Send submit");
  4963. $(this).parents(\'form:first\').submit();
  4964. });
  4965. });
  4966. </script>
  4967. ';
  4968. }
  4969. print '</li>';
  4970. }
  4971. if ($page > 0) {
  4972. print '<li class="pagination paginationpage paginationpageleft"><a class="paginationprevious" href="'.$file.'?page='.($page - 1).$options.'"><i class="fa fa-chevron-left" title="'.dol_escape_htmltag($langs->trans("Previous")).'"></i></a></li>';
  4973. }
  4974. if ($betweenarrows) {
  4975. print '<!--<div class="betweenarrows nowraponall inline-block">-->';
  4976. print $betweenarrows;
  4977. print '<!--</div>-->';
  4978. }
  4979. if ($nextpage > 0) {
  4980. print '<li class="pagination paginationpage paginationpageright"><a class="paginationnext" href="'.$file.'?page='.($page + 1).$options.'"><i class="fa fa-chevron-right" title="'.dol_escape_htmltag($langs->trans("Next")).'"></i></a></li>';
  4981. }
  4982. if ($afterarrows) {
  4983. print '<li class="paginationafterarrows">';
  4984. print $afterarrows;
  4985. print '</li>';
  4986. }
  4987. print '</ul></div>'."\n";
  4988. }
  4989. /**
  4990. * Return a string with VAT rate label formated for view output
  4991. * Used into pdf and HTML pages
  4992. *
  4993. * @param string $rate Rate value to format ('19.6', '19,6', '19.6%', '19,6%', '19.6 (CODEX)', ...)
  4994. * @param boolean $addpercent Add a percent % sign in output
  4995. * @param int $info_bits Miscellaneous information on vat (0=Default, 1=French NPR vat)
  4996. * @param int $usestarfornpr -1=Never show, 0 or 1=Use '*' for NPR vat rates
  4997. * @param int $html Used for html output
  4998. * @return string String with formated amounts ('19,6' or '19,6%' or '8.5% (NPR)' or '8.5% *' or '19,6 (CODEX)')
  4999. */
  5000. function vatrate($rate, $addpercent = false, $info_bits = 0, $usestarfornpr = 0, $html = 0)
  5001. {
  5002. $morelabel = '';
  5003. if (preg_match('/%/', $rate)) {
  5004. $rate = str_replace('%', '', $rate);
  5005. $addpercent = true;
  5006. }
  5007. $reg = array();
  5008. if (preg_match('/\((.*)\)/', $rate, $reg)) {
  5009. $morelabel = ' ('.$reg[1].')';
  5010. $rate = preg_replace('/\s*'.preg_quote($morelabel, '/').'/', '', $rate);
  5011. $morelabel = ' '.($html ? '<span class="opacitymedium">' : '').'('.$reg[1].')'.($html ? '</span>' : '');
  5012. }
  5013. if (preg_match('/\*/', $rate)) {
  5014. $rate = str_replace('*', '', $rate);
  5015. $info_bits |= 1;
  5016. }
  5017. // If rate is '9/9/9' we don't change it. If rate is '9.000' we apply price()
  5018. if (!preg_match('/\//', $rate)) {
  5019. $ret = price($rate, 0, '', 0, 0).($addpercent ? '%' : '');
  5020. } else {
  5021. // TODO Split on / and output with a price2num to have clean numbers without ton of 000.
  5022. $ret = $rate.($addpercent ? '%' : '');
  5023. }
  5024. if (($info_bits & 1) && $usestarfornpr >= 0) {
  5025. $ret .= ' *';
  5026. }
  5027. $ret .= $morelabel;
  5028. return $ret;
  5029. }
  5030. /**
  5031. * Function to format a value into an amount for visual output
  5032. * Function used into PDF and HTML pages
  5033. *
  5034. * @param float $amount Amount to format
  5035. * @param integer $form Type of format, HTML or not (not by default)
  5036. * @param Translate|string $outlangs Object langs for output. '' use default lang. 'none' use international separators.
  5037. * @param int $trunc 1=Truncate if there is more decimals than MAIN_MAX_DECIMALS_SHOWN (default), 0=Does not truncate. Deprecated because amount are rounded (to unit or total amount accurancy) before beeing inserted into database or after a computation, so this parameter should be useless.
  5038. * @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_TOT)
  5039. * @param int $forcerounding Force the number of decimal to forcerounding decimal (-1=do not force)
  5040. * @param string $currency_code To add currency symbol (''=add nothing, 'auto'=Use default currency, 'XXX'=add currency symbols for XXX currency)
  5041. * @return string String with formated amount
  5042. *
  5043. * @see price2num() Revert function of price
  5044. */
  5045. function price($amount, $form = 0, $outlangs = '', $trunc = 1, $rounding = -1, $forcerounding = -1, $currency_code = '')
  5046. {
  5047. global $langs, $conf;
  5048. // Clean parameters
  5049. if (empty($amount)) {
  5050. $amount = 0; // To have a numeric value if amount not defined or = ''
  5051. }
  5052. $amount = (is_numeric($amount) ? $amount : 0); // Check if amount is numeric, for example, an error occured when amount value = o (letter) instead 0 (number)
  5053. if ($rounding < 0) {
  5054. $rounding = min($conf->global->MAIN_MAX_DECIMALS_UNIT, $conf->global->MAIN_MAX_DECIMALS_TOT);
  5055. }
  5056. $nbdecimal = $rounding;
  5057. if ($outlangs === 'none') {
  5058. // Use international separators
  5059. $dec = '.';
  5060. $thousand = '';
  5061. } else {
  5062. // Output separators by default (french)
  5063. $dec = ',';
  5064. $thousand = ' ';
  5065. // If $outlangs not forced, we use use language
  5066. if (!is_object($outlangs)) {
  5067. $outlangs = $langs;
  5068. }
  5069. if ($outlangs->transnoentitiesnoconv("SeparatorDecimal") != "SeparatorDecimal") {
  5070. $dec = $outlangs->transnoentitiesnoconv("SeparatorDecimal");
  5071. }
  5072. if ($outlangs->transnoentitiesnoconv("SeparatorThousand") != "SeparatorThousand") {
  5073. $thousand = $outlangs->transnoentitiesnoconv("SeparatorThousand");
  5074. }
  5075. if ($thousand == 'None') {
  5076. $thousand = '';
  5077. } elseif ($thousand == 'Space') {
  5078. $thousand = ' ';
  5079. }
  5080. }
  5081. //print "outlangs=".$outlangs->defaultlang." amount=".$amount." html=".$form." trunc=".$trunc." nbdecimal=".$nbdecimal." dec='".$dec."' thousand='".$thousand."'<br>";
  5082. //print "amount=".$amount."-";
  5083. $amount = str_replace(',', '.', $amount); // should be useless
  5084. //print $amount."-";
  5085. $datas = explode('.', $amount);
  5086. $decpart = isset($datas[1]) ? $datas[1] : '';
  5087. $decpart = preg_replace('/0+$/i', '', $decpart); // Supprime les 0 de fin de partie decimale
  5088. //print "decpart=".$decpart."<br>";
  5089. $end = '';
  5090. // We increase nbdecimal if there is more decimal than asked (to not loose information)
  5091. if (dol_strlen($decpart) > $nbdecimal) {
  5092. $nbdecimal = dol_strlen($decpart);
  5093. }
  5094. // Si on depasse max
  5095. if ($trunc && $nbdecimal > $conf->global->MAIN_MAX_DECIMALS_SHOWN) {
  5096. $nbdecimal = $conf->global->MAIN_MAX_DECIMALS_SHOWN;
  5097. if (preg_match('/\.\.\./i', $conf->global->MAIN_MAX_DECIMALS_SHOWN)) {
  5098. // Si un affichage est tronque, on montre des ...
  5099. $end = '...';
  5100. }
  5101. }
  5102. // If force rounding
  5103. if ($forcerounding >= 0) {
  5104. $nbdecimal = $forcerounding;
  5105. }
  5106. // Format number
  5107. $output = number_format($amount, $nbdecimal, $dec, $thousand);
  5108. if ($form) {
  5109. $output = preg_replace('/\s/', '&nbsp;', $output);
  5110. $output = preg_replace('/\'/', '&#039;', $output);
  5111. }
  5112. // Add symbol of currency if requested
  5113. $cursymbolbefore = $cursymbolafter = '';
  5114. if ($currency_code && is_object($outlangs)) {
  5115. if ($currency_code == 'auto') {
  5116. $currency_code = $conf->currency;
  5117. }
  5118. $listofcurrenciesbefore = array('AUD', 'CAD', 'CNY', 'COP', 'CLP', 'GBP', 'HKD', 'MXN', 'PEN', 'USD');
  5119. $listoflanguagesbefore = array('nl_NL');
  5120. if (in_array($currency_code, $listofcurrenciesbefore) || in_array($outlangs->defaultlang, $listoflanguagesbefore)) {
  5121. $cursymbolbefore .= $outlangs->getCurrencySymbol($currency_code);
  5122. } else {
  5123. $tmpcur = $outlangs->getCurrencySymbol($currency_code);
  5124. $cursymbolafter .= ($tmpcur == $currency_code ? ' '.$tmpcur : $tmpcur);
  5125. }
  5126. }
  5127. $output = $cursymbolbefore.$output.$end.($cursymbolafter ? ' ' : '').$cursymbolafter;
  5128. return $output;
  5129. }
  5130. /**
  5131. * Function that return a number with universal decimal format (decimal separator is '.') from an amount typed by a user.
  5132. * Function to use on each input amount before any numeric test or database insert. A better name for this function
  5133. * should be roundtext2num().
  5134. *
  5135. * @param string|float $amount Amount to convert/clean or round
  5136. * @param string|int $rounding ''=No rounding
  5137. * 'MU'=Round to Max unit price (MAIN_MAX_DECIMALS_UNIT)
  5138. * 'MT'=Round to Max for totals with Tax (MAIN_MAX_DECIMALS_TOT)
  5139. * 'MS'=Round to Max for stock quantity (MAIN_MAX_DECIMALS_STOCK)
  5140. * 'CU'=Round to Max unit price of foreign currency accuracy
  5141. * 'CT'=Round to Max for totals with Tax of foreign currency accuracy
  5142. * Numeric = Nb of digits for rounding (For example 2 for a percentage)
  5143. * @param int $option Put 1 if you know that content is already universal format number (so no correction on decimal will be done)
  5144. * Put 2 if you know that number is a user input (so we know we have to fix decimal separator).
  5145. * @return string Amount with universal numeric format (Example: '99.99999').
  5146. * If conversion fails to return a numeric, it returns:
  5147. * - text unchanged or partial if ($rounding = ''): price2num('W9ç', '', 0) => '9ç', price2num('W9ç', '', 1) => 'W9ç', price2num('W9ç', '', 2) => '9ç'
  5148. * - '0' if ($rounding is defined): price2num('W9ç', 'MT', 0) => '9', price2num('W9ç', 'MT', 1) => '0', price2num('W9ç', 'MT', 2) => '9'
  5149. * Note: The best way to guarantee a numeric value is to add a cast (float) before the price2num().
  5150. * If amount is null or '', it returns '' if $rounding = '' or '0' if $rounding is defined.
  5151. *
  5152. * @see price() Opposite function of price2num
  5153. */
  5154. function price2num($amount, $rounding = '', $option = 0)
  5155. {
  5156. global $langs, $conf;
  5157. // Round PHP function does not allow number like '1,234.56' nor '1.234,56' nor '1 234,56'
  5158. // Numbers must be '1234.56'
  5159. // Decimal delimiter for PHP and database SQL requests must be '.'
  5160. $dec = ',';
  5161. $thousand = ' ';
  5162. if (is_null($langs)) { // $langs is not defined, we use english values.
  5163. $dec = '.';
  5164. $thousand = ',';
  5165. } else {
  5166. if ($langs->transnoentitiesnoconv("SeparatorDecimal") != "SeparatorDecimal") {
  5167. $dec = $langs->transnoentitiesnoconv("SeparatorDecimal");
  5168. }
  5169. if ($langs->transnoentitiesnoconv("SeparatorThousand") != "SeparatorThousand") {
  5170. $thousand = $langs->transnoentitiesnoconv("SeparatorThousand");
  5171. }
  5172. }
  5173. if ($thousand == 'None') {
  5174. $thousand = '';
  5175. } elseif ($thousand == 'Space') {
  5176. $thousand = ' ';
  5177. }
  5178. //print "amount=".$amount." html=".$form." trunc=".$trunc." nbdecimal=".$nbdecimal." dec='".$dec."' thousand='".$thousand."'<br>";
  5179. // Convert value to universal number format (no thousand separator, '.' as decimal separator)
  5180. if ($option != 1) { // If not a PHP number or unknown, we change or clean format
  5181. //print "\n".'PP'.$amount.' - '.$dec.' - '.$thousand.' - '.intval($amount).'<br>';
  5182. if (!is_numeric($amount)) {
  5183. $amount = preg_replace('/[a-zA-Z\/\\\*\(\)\<\>\_]/', '', $amount);
  5184. }
  5185. if ($option == 2 && $thousand == '.' && preg_match('/\.(\d\d\d)$/', (string) $amount)) { // It means the . is used as a thousand separator and string come from input data, so 1.123 is 1123
  5186. $amount = str_replace($thousand, '', $amount);
  5187. }
  5188. // Convert amount to format with dolibarr dec and thousand (this is because PHP convert a number
  5189. // to format defined by LC_NUMERIC after a calculation and we want source format to be like defined by Dolibarr setup.
  5190. // So if number was already a good number, it is converted into local Dolibarr setup.
  5191. if (is_numeric($amount)) {
  5192. // We put in temps value of decimal ("0.00001"). Works with 0 and 2.0E-5 and 9999.10
  5193. $temps = sprintf("%0.10F", $amount - intval($amount)); // temps=0.0000000000 or 0.0000200000 or 9999.1000000000
  5194. $temps = preg_replace('/([\.1-9])0+$/', '\\1', $temps); // temps=0. or 0.00002 or 9999.1
  5195. $nbofdec = max(0, dol_strlen($temps) - 2); // -2 to remove "0."
  5196. $amount = number_format($amount, $nbofdec, $dec, $thousand);
  5197. }
  5198. //print "QQ".$amount."<br>\n";
  5199. // Now make replace (the main goal of function)
  5200. if ($thousand != ',' && $thousand != '.') {
  5201. $amount = str_replace(',', '.', $amount); // To accept 2 notations for french users
  5202. }
  5203. $amount = str_replace(' ', '', $amount); // To avoid spaces
  5204. $amount = str_replace($thousand, '', $amount); // Replace of thousand before replace of dec to avoid pb if thousand is .
  5205. $amount = str_replace($dec, '.', $amount);
  5206. $amount = preg_replace('/[^0-9\-\.]/', '', $amount); // Clean non numeric chars (so it clean some UTF8 spaces for example.
  5207. }
  5208. //print ' XX'.$amount.' '.$rounding;
  5209. // Now, $amount is a real PHP float number. We make a rounding if required.
  5210. if ($rounding) {
  5211. $nbofdectoround = '';
  5212. if ($rounding == 'MU') {
  5213. $nbofdectoround = $conf->global->MAIN_MAX_DECIMALS_UNIT;
  5214. } elseif ($rounding == 'MT') {
  5215. $nbofdectoround = $conf->global->MAIN_MAX_DECIMALS_TOT;
  5216. } elseif ($rounding == 'MS') {
  5217. $nbofdectoround = isset($conf->global->MAIN_MAX_DECIMALS_STOCK) ? $conf->global->MAIN_MAX_DECIMALS_STOCK : 5;
  5218. } elseif ($rounding == 'CU') {
  5219. $nbofdectoround = max($conf->global->MAIN_MAX_DECIMALS_UNIT, 8); // TODO Use param of currency
  5220. } elseif ($rounding == 'CT') {
  5221. $nbofdectoround = max($conf->global->MAIN_MAX_DECIMALS_TOT, 8); // TODO Use param of currency
  5222. } elseif (is_numeric($rounding)) {
  5223. $nbofdectoround = (int) $rounding;
  5224. }
  5225. //print " RR".$amount.' - '.$nbofdectoround.'<br>';
  5226. if (dol_strlen($nbofdectoround)) {
  5227. $amount = round(is_string($amount) ? (float) $amount : $amount, $nbofdectoround); // $nbofdectoround can be 0.
  5228. } else {
  5229. return 'ErrorBadParameterProvidedToFunction';
  5230. }
  5231. //print ' SS'.$amount.' - '.$nbofdec.' - '.$dec.' - '.$thousand.' - '.$nbofdectoround.'<br>';
  5232. // Convert amount to format with dolibarr dec and thousand (this is because PHP convert a number
  5233. // to format defined by LC_NUMERIC after a calculation and we want source format to be defined by Dolibarr setup.
  5234. if (is_numeric($amount)) {
  5235. // We put in temps value of decimal ("0.00001"). Works with 0 and 2.0E-5 and 9999.10
  5236. $temps = sprintf("%0.10F", $amount - intval($amount)); // temps=0.0000000000 or 0.0000200000 or 9999.1000000000
  5237. $temps = preg_replace('/([\.1-9])0+$/', '\\1', $temps); // temps=0. or 0.00002 or 9999.1
  5238. $nbofdec = max(0, dol_strlen($temps) - 2); // -2 to remove "0."
  5239. $amount = number_format($amount, min($nbofdec, $nbofdectoround), $dec, $thousand); // Convert amount to format with dolibarr dec and thousand
  5240. }
  5241. //print "TT".$amount.'<br>';
  5242. // Always make replace because each math function (like round) replace
  5243. // with local values and we want a number that has a SQL string format x.y
  5244. if ($thousand != ',' && $thousand != '.') {
  5245. $amount = str_replace(',', '.', $amount); // To accept 2 notations for french users
  5246. }
  5247. $amount = str_replace(' ', '', $amount); // To avoid spaces
  5248. $amount = str_replace($thousand, '', $amount); // Replace of thousand before replace of dec to avoid pb if thousand is .
  5249. $amount = str_replace($dec, '.', $amount);
  5250. $amount = preg_replace('/[^0-9\-\.]/', '', $amount); // Clean non numeric chars (so it clean some UTF8 spaces for example.
  5251. }
  5252. return $amount;
  5253. }
  5254. /**
  5255. * Output a dimension with best unit
  5256. *
  5257. * @param float $dimension Dimension
  5258. * @param int $unit Unit scale of dimension (Example: 0=kg, -3=g, -6=mg, 98=ounce, 99=pound, ...)
  5259. * @param string $type 'weight', 'volume', ...
  5260. * @param Translate $outputlangs Translate language object
  5261. * @param int $round -1 = non rounding, x = number of decimal
  5262. * @param string $forceunitoutput 'no' or numeric (-3, -6, ...) compared to $unit (In most case, this value is value defined into $conf->global->MAIN_WEIGHT_DEFAULT_UNIT)
  5263. * @param int $use_short_label 1=Use short label ('g' instead of 'gram'). Short labels are not translated.
  5264. * @return string String to show dimensions
  5265. */
  5266. function showDimensionInBestUnit($dimension, $unit, $type, $outputlangs, $round = -1, $forceunitoutput = 'no', $use_short_label = 0)
  5267. {
  5268. require_once DOL_DOCUMENT_ROOT.'/core/lib/product.lib.php';
  5269. if (($forceunitoutput == 'no' && $dimension < 1 / 10000 && $unit < 90) || (is_numeric($forceunitoutput) && $forceunitoutput == -6)) {
  5270. $dimension = $dimension * 1000000;
  5271. $unit = $unit - 6;
  5272. } elseif (($forceunitoutput == 'no' && $dimension < 1 / 10 && $unit < 90) || (is_numeric($forceunitoutput) && $forceunitoutput == -3)) {
  5273. $dimension = $dimension * 1000;
  5274. $unit = $unit - 3;
  5275. } elseif (($forceunitoutput == 'no' && $dimension > 100000000 && $unit < 90) || (is_numeric($forceunitoutput) && $forceunitoutput == 6)) {
  5276. $dimension = $dimension / 1000000;
  5277. $unit = $unit + 6;
  5278. } elseif (($forceunitoutput == 'no' && $dimension > 100000 && $unit < 90) || (is_numeric($forceunitoutput) && $forceunitoutput == 3)) {
  5279. $dimension = $dimension / 1000;
  5280. $unit = $unit + 3;
  5281. }
  5282. // Special case when we want output unit into pound or ounce
  5283. /* TODO
  5284. if ($unit < 90 && $type == 'weight' && is_numeric($forceunitoutput) && (($forceunitoutput == 98) || ($forceunitoutput == 99))
  5285. {
  5286. $dimension = // convert dimension from standard unit into ounce or pound
  5287. $unit = $forceunitoutput;
  5288. }
  5289. if ($unit > 90 && $type == 'weight' && is_numeric($forceunitoutput) && $forceunitoutput < 90)
  5290. {
  5291. $dimension = // convert dimension from standard unit into ounce or pound
  5292. $unit = $forceunitoutput;
  5293. }*/
  5294. $ret = price($dimension, 0, $outputlangs, 0, 0, $round);
  5295. $ret .= ' '.measuringUnitString(0, $type, $unit, $use_short_label, $outputlangs);
  5296. return $ret;
  5297. }
  5298. /**
  5299. * Return localtax rate for a particular vat, when selling a product with vat $vatrate, from a $thirdparty_buyer to a $thirdparty_seller
  5300. * Note: This function applies same rules than get_default_tva
  5301. *
  5302. * @param float $vatrate Vat rate. Can be '8.5' or '8.5 (VATCODEX)' for example
  5303. * @param int $local Local tax to search and return (1 or 2 return only tax rate 1 or tax rate 2)
  5304. * @param Societe $thirdparty_buyer Object of buying third party
  5305. * @param Societe $thirdparty_seller Object of selling third party ($mysoc if not defined)
  5306. * @param int $vatnpr If vat rate is NPR or not
  5307. * @return mixed 0 if not found, localtax rate if found
  5308. * @see get_default_tva()
  5309. */
  5310. function get_localtax($vatrate, $local, $thirdparty_buyer = "", $thirdparty_seller = "", $vatnpr = 0)
  5311. {
  5312. global $db, $conf, $mysoc;
  5313. if (empty($thirdparty_seller) || !is_object($thirdparty_seller)) {
  5314. $thirdparty_seller = $mysoc;
  5315. }
  5316. 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);
  5317. $vatratecleaned = $vatrate;
  5318. $reg = array();
  5319. if (preg_match('/^(.*)\s*\((.*)\)$/', $vatrate, $reg)) { // If vat is "xx (yy)"
  5320. $vatratecleaned = trim($reg[1]);
  5321. $vatratecode = $reg[2];
  5322. }
  5323. /*if ($thirdparty_buyer->country_code != $thirdparty_seller->country_code)
  5324. {
  5325. return 0;
  5326. }*/
  5327. // Some test to guess with no need to make database access
  5328. if ($mysoc->country_code == 'ES') { // For spain localtaxes 1 and 2, tax is qualified if buyer use local tax
  5329. if ($local == 1) {
  5330. if (!$mysoc->localtax1_assuj || (string) $vatratecleaned == "0") {
  5331. return 0;
  5332. }
  5333. if ($thirdparty_seller->id == $mysoc->id) {
  5334. if (!$thirdparty_buyer->localtax1_assuj) {
  5335. return 0;
  5336. }
  5337. } else {
  5338. if (!$thirdparty_seller->localtax1_assuj) {
  5339. return 0;
  5340. }
  5341. }
  5342. }
  5343. if ($local == 2) {
  5344. //if (! $mysoc->localtax2_assuj || (string) $vatratecleaned == "0") return 0;
  5345. if (!$mysoc->localtax2_assuj) {
  5346. return 0; // If main vat is 0, IRPF may be different than 0.
  5347. }
  5348. if ($thirdparty_seller->id == $mysoc->id) {
  5349. if (!$thirdparty_buyer->localtax2_assuj) {
  5350. return 0;
  5351. }
  5352. } else {
  5353. if (!$thirdparty_seller->localtax2_assuj) {
  5354. return 0;
  5355. }
  5356. }
  5357. }
  5358. } else {
  5359. if ($local == 1 && !$thirdparty_seller->localtax1_assuj) {
  5360. return 0;
  5361. }
  5362. if ($local == 2 && !$thirdparty_seller->localtax2_assuj) {
  5363. return 0;
  5364. }
  5365. }
  5366. // For some country MAIN_GET_LOCALTAXES_VALUES_FROM_THIRDPARTY is forced to on.
  5367. if (in_array($mysoc->country_code, array('ES'))) {
  5368. $conf->global->MAIN_GET_LOCALTAXES_VALUES_FROM_THIRDPARTY = 1;
  5369. }
  5370. // Search local taxes
  5371. if (!empty($conf->global->MAIN_GET_LOCALTAXES_VALUES_FROM_THIRDPARTY)) {
  5372. if ($local == 1) {
  5373. if ($thirdparty_seller != $mysoc) {
  5374. if (!isOnlyOneLocalTax($local)) { // TODO We should provide $vatrate to search on correct line and not always on line with highest vat rate
  5375. return $thirdparty_seller->localtax1_value;
  5376. }
  5377. } else { // i am the seller
  5378. if (!isOnlyOneLocalTax($local)) { // TODO If seller is me, why not always returning this, even if there is only one locatax vat.
  5379. return $conf->global->MAIN_INFO_VALUE_LOCALTAX1;
  5380. }
  5381. }
  5382. }
  5383. if ($local == 2) {
  5384. if ($thirdparty_seller != $mysoc) {
  5385. if (!isOnlyOneLocalTax($local)) { // TODO We should provide $vatrate to search on correct line and not always on line with highest vat rate
  5386. // TODO We should also return value defined on thirdparty only if defined
  5387. return $thirdparty_seller->localtax2_value;
  5388. }
  5389. } else { // i am the seller
  5390. if (in_array($mysoc->country_code, array('ES'))) {
  5391. return $thirdparty_buyer->localtax2_value;
  5392. } else {
  5393. return $conf->global->MAIN_INFO_VALUE_LOCALTAX2;
  5394. }
  5395. }
  5396. }
  5397. }
  5398. // By default, search value of local tax on line of common tax
  5399. $sql = "SELECT t.localtax1, t.localtax2, t.localtax1_type, t.localtax2_type";
  5400. $sql .= " FROM ".MAIN_DB_PREFIX."c_tva as t, ".MAIN_DB_PREFIX."c_country as c";
  5401. $sql .= " WHERE t.fk_pays = c.rowid AND c.code = '".$db->escape($thirdparty_seller->country_code)."'";
  5402. $sql .= " AND t.taux = ".((float) $vatratecleaned)." AND t.active = 1";
  5403. if (!empty($vatratecode)) {
  5404. $sql .= " AND t.code ='".$db->escape($vatratecode)."'"; // If we have the code, we use it in priority
  5405. } else {
  5406. $sql .= " AND t.recuperableonly = '".$db->escape($vatnpr)."'";
  5407. }
  5408. $resql = $db->query($sql);
  5409. if ($resql) {
  5410. $obj = $db->fetch_object($resql);
  5411. if ($obj) {
  5412. if ($local == 1) {
  5413. return $obj->localtax1;
  5414. } elseif ($local == 2) {
  5415. return $obj->localtax2;
  5416. }
  5417. }
  5418. }
  5419. return 0;
  5420. }
  5421. /**
  5422. * Return true if LocalTax (1 or 2) is unique.
  5423. * Example: If localtax1 is 5 on line with highest common vat rate, return true
  5424. * Example: If localtax1 is 5:8:15 on line with highest common vat rate, return false
  5425. *
  5426. * @param int $local Local tax to test (1 or 2)
  5427. * @return boolean True if LocalTax have multiple values, False if not
  5428. */
  5429. function isOnlyOneLocalTax($local)
  5430. {
  5431. $tax = get_localtax_by_third($local);
  5432. $valors = explode(":", $tax);
  5433. if (count($valors) > 1) {
  5434. return false;
  5435. } else {
  5436. return true;
  5437. }
  5438. }
  5439. /**
  5440. * Get values of localtaxes (1 or 2) for company country for the common vat with the highest value
  5441. *
  5442. * @param int $local LocalTax to get
  5443. * @return string Values of localtax (Can be '20', '-19:-15:-9')
  5444. */
  5445. function get_localtax_by_third($local)
  5446. {
  5447. global $db, $mysoc;
  5448. $sql = " SELECT t.localtax".$local." as localtax";
  5449. $sql .= " FROM ".MAIN_DB_PREFIX."c_tva as t INNER JOIN ".MAIN_DB_PREFIX."c_country as c ON c.rowid = t.fk_pays";
  5450. $sql .= " WHERE c.code = '".$db->escape($mysoc->country_code)."' AND t.active = 1 AND t.taux = (";
  5451. $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";
  5452. $sql .= " WHERE c.code = '".$db->escape($mysoc->country_code)."' AND tt.active = 1)";
  5453. $sql .= " AND t.localtax".$local."_type <> '0'";
  5454. $sql .= " ORDER BY t.rowid DESC";
  5455. $resql = $db->query($sql);
  5456. if ($resql) {
  5457. $obj = $db->fetch_object($resql);
  5458. return $obj->localtax;
  5459. } else {
  5460. return 'Error';
  5461. }
  5462. return '0';
  5463. }
  5464. /**
  5465. * Get tax (VAT) main information from Id.
  5466. * You can also call getLocalTaxesFromRate() after to get only localtax fields.
  5467. *
  5468. * @param int|string $vatrate VAT ID or Rate. Value can be value or the string with code into parenthesis or rowid if $firstparamisid is 1. Example: '8.5' or '8.5 (8.5NPR)' or 123.
  5469. * @param Societe $buyer Company object
  5470. * @param Societe $seller Company object
  5471. * @param int $firstparamisid 1 if first param is id into table (use this if you can)
  5472. * @return array array('rowid'=> , 'code'=> ...)
  5473. * @see getLocalTaxesFromRate()
  5474. */
  5475. function getTaxesFromId($vatrate, $buyer = null, $seller = null, $firstparamisid = 1)
  5476. {
  5477. global $db, $mysoc;
  5478. dol_syslog("getTaxesFromId vat id or rate = ".$vatrate);
  5479. // Search local taxes
  5480. $sql = "SELECT t.rowid, t.code, t.taux as rate, t.recuperableonly as npr, t.accountancy_code_sell, t.accountancy_code_buy,";
  5481. $sql .= " t.localtax1, t.localtax1_type, t.localtax2, t.localtax2_type";
  5482. $sql .= " FROM ".MAIN_DB_PREFIX."c_tva as t";
  5483. if ($firstparamisid) {
  5484. $sql .= " WHERE t.rowid = ".(int) $vatrate;
  5485. } else {
  5486. $vatratecleaned = $vatrate;
  5487. $vatratecode = '';
  5488. $reg = array();
  5489. if (preg_match('/^(.*)\s*\((.*)\)$/', $vatrate, $reg)) { // If vat is "xx (yy)"
  5490. $vatratecleaned = $reg[1];
  5491. $vatratecode = $reg[2];
  5492. }
  5493. $sql .= ", ".MAIN_DB_PREFIX."c_country as c";
  5494. /*if ($mysoc->country_code == 'ES') $sql.= " WHERE t.fk_pays = c.rowid AND c.code = '".$db->escape($buyer->country_code)."'"; // vat in spain use the buyer country ??
  5495. else $sql.= " WHERE t.fk_pays = c.rowid AND c.code = '".$db->escape($seller->country_code)."'";*/
  5496. $sql .= " WHERE t.fk_pays = c.rowid AND c.code = '".$db->escape($seller->country_code)."'";
  5497. $sql .= " AND t.taux = ".((float) $vatratecleaned)." AND t.active = 1";
  5498. if ($vatratecode) {
  5499. $sql .= " AND t.code = '".$db->escape($vatratecode)."'";
  5500. }
  5501. }
  5502. $resql = $db->query($sql);
  5503. if ($resql) {
  5504. $obj = $db->fetch_object($resql);
  5505. if ($obj) {
  5506. return array(
  5507. 'rowid'=>$obj->rowid,
  5508. 'code'=>$obj->code,
  5509. 'rate'=>$obj->rate,
  5510. 'localtax1'=>$obj->localtax1,
  5511. 'localtax1_type'=>$obj->localtax1_type,
  5512. 'localtax2'=>$obj->localtax2,
  5513. 'localtax2_type'=>$obj->localtax2_type,
  5514. 'npr'=>$obj->npr,
  5515. 'accountancy_code_sell'=>$obj->accountancy_code_sell,
  5516. 'accountancy_code_buy'=>$obj->accountancy_code_buy
  5517. );
  5518. } else {
  5519. return array();
  5520. }
  5521. } else {
  5522. dol_print_error($db);
  5523. }
  5524. return array();
  5525. }
  5526. /**
  5527. * Get type and rate of localtaxes for a particular vat rate/country of a thirdparty.
  5528. * This does not take into account the seller setup if subject to vat or not, only country.
  5529. *
  5530. * TODO This function is ALSO called to retrieve type for building PDF. Such call of function must be removed.
  5531. * Instead this function must be called when adding a line to get the array of possible values for localtax and type, and then
  5532. * provide the selected value to the function calcul_price_total.
  5533. *
  5534. * @param int|string $vatrate VAT ID or Rate+Code. Value can be value or the string with code into parenthesis or rowid if $firstparamisid is 1. Example: '8.5' or '8.5 (8.5NPR)' or 123.
  5535. * @param int $local Number of localtax (1 or 2, or 0 to return 1 & 2)
  5536. * @param Societe $buyer Company object
  5537. * @param Societe $seller Company object
  5538. * @param int $firstparamisid 1 if first param is ID into table instead of Rate+code (use this if you can)
  5539. * @return array array(localtax_type1(1-6 or 0 if not found), rate localtax1, localtax_type2, rate localtax2, accountancycodecust, accountancycodesupp)
  5540. * @see getTaxesFromId()
  5541. */
  5542. function getLocalTaxesFromRate($vatrate, $local, $buyer, $seller, $firstparamisid = 0)
  5543. {
  5544. global $db, $mysoc;
  5545. dol_syslog("getLocalTaxesFromRate vatrate=".$vatrate." local=".$local);
  5546. // Search local taxes
  5547. $sql = "SELECT t.taux as rate, t.code, t.localtax1, t.localtax1_type, t.localtax2, t.localtax2_type, t.accountancy_code_sell, t.accountancy_code_buy";
  5548. $sql .= " FROM ".MAIN_DB_PREFIX."c_tva as t";
  5549. if ($firstparamisid) {
  5550. $sql .= " WHERE t.rowid = ".(int) $vatrate;
  5551. } else {
  5552. $vatratecleaned = $vatrate;
  5553. $vatratecode = '';
  5554. $reg = array();
  5555. if (preg_match('/^(.*)\s*\((.*)\)$/', $vatrate, $reg)) { // If vat is "x.x (yy)"
  5556. $vatratecleaned = $reg[1];
  5557. $vatratecode = $reg[2];
  5558. }
  5559. $sql .= ", ".MAIN_DB_PREFIX."c_country as c";
  5560. if (!empty($mysoc) && $mysoc->country_code == 'ES') {
  5561. $sql .= " WHERE t.fk_pays = c.rowid AND c.code = '".$db->escape($buyer->country_code)."'"; // local tax in spain use the buyer country ??
  5562. } else {
  5563. $sql .= " WHERE t.fk_pays = c.rowid AND c.code = '".$db->escape(empty($seller->country_code) ? $mysoc->country_code : $seller->country_code)."'";
  5564. }
  5565. $sql .= " AND t.taux = ".((float) $vatratecleaned)." AND t.active = 1";
  5566. if ($vatratecode) {
  5567. $sql .= " AND t.code = '".$db->escape($vatratecode)."'";
  5568. }
  5569. }
  5570. $resql = $db->query($sql);
  5571. if ($resql) {
  5572. $obj = $db->fetch_object($resql);
  5573. if ($obj) {
  5574. $vateratestring = $obj->rate.($obj->code ? ' ('.$obj->code.')' : '');
  5575. if ($local == 1) {
  5576. return array($obj->localtax1_type, get_localtax($vateratestring, $local, $buyer, $seller), $obj->accountancy_code_sell, $obj->accountancy_code_buy);
  5577. } elseif ($local == 2) {
  5578. return array($obj->localtax2_type, get_localtax($vateratestring, $local, $buyer, $seller), $obj->accountancy_code_sell, $obj->accountancy_code_buy);
  5579. } else {
  5580. return array($obj->localtax1_type, get_localtax($vateratestring, 1, $buyer, $seller), $obj->localtax2_type, get_localtax($vateratestring, 2, $buyer, $seller), $obj->accountancy_code_sell, $obj->accountancy_code_buy);
  5581. }
  5582. }
  5583. }
  5584. return array();
  5585. }
  5586. /**
  5587. * Return vat rate of a product in a particular country, or default country vat if product is unknown.
  5588. * Function called by get_default_tva().
  5589. *
  5590. * @param int $idprod Id of product or 0 if not a predefined product
  5591. * @param Societe $thirdpartytouse Thirdparty with a ->country_code defined (FR, US, IT, ...)
  5592. * @param int $idprodfournprice Id product_fournisseur_price (for "supplier" proposal/order/invoice)
  5593. * @return float|string Vat rate to use with format 5.0 or '5.0 (XXX)'
  5594. * @see get_product_localtax_for_country()
  5595. */
  5596. function get_product_vat_for_country($idprod, $thirdpartytouse, $idprodfournprice = 0)
  5597. {
  5598. global $db, $conf, $mysoc;
  5599. require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php';
  5600. $ret = 0;
  5601. $found = 0;
  5602. if ($idprod > 0) {
  5603. // Load product
  5604. $product = new Product($db);
  5605. $result = $product->fetch($idprod);
  5606. if ($mysoc->country_code == $thirdpartytouse->country_code) { // If country to consider is ours
  5607. if ($idprodfournprice > 0) { // We want vat for product for a "supplier" object
  5608. $product->get_buyprice($idprodfournprice, 0, 0, 0);
  5609. $ret = $product->vatrate_supplier;
  5610. if ($product->default_vat_code) {
  5611. $ret .= ' ('.$product->default_vat_code.')';
  5612. }
  5613. } else {
  5614. $ret = $product->tva_tx; // Default vat of product we defined
  5615. if ($product->default_vat_code) {
  5616. $ret .= ' ('.$product->default_vat_code.')';
  5617. }
  5618. }
  5619. $found = 1;
  5620. } else {
  5621. // TODO Read default product vat according to product and another countrycode.
  5622. // Vat for couple anothercountrycode/product is data that is not managed and store yet, so we will fallback on next rule.
  5623. }
  5624. }
  5625. if (!$found) {
  5626. if (empty($conf->global->MAIN_VAT_DEFAULT_IF_AUTODETECT_FAILS)) {
  5627. // If vat of product for the country not found or not defined, we return the first higher vat of country.
  5628. $sql = "SELECT t.taux as vat_rate, t.code as default_vat_code";
  5629. $sql .= " FROM ".MAIN_DB_PREFIX."c_tva as t, ".MAIN_DB_PREFIX."c_country as c";
  5630. $sql .= " WHERE t.active=1 AND t.fk_pays = c.rowid AND c.code='".$db->escape($thirdpartytouse->country_code)."'";
  5631. $sql .= " ORDER BY t.taux DESC, t.code ASC, t.recuperableonly ASC";
  5632. $sql .= $db->plimit(1);
  5633. $resql = $db->query($sql);
  5634. if ($resql) {
  5635. $obj = $db->fetch_object($resql);
  5636. if ($obj) {
  5637. $ret = $obj->vat_rate;
  5638. if ($obj->default_vat_code) {
  5639. $ret .= ' ('.$obj->default_vat_code.')';
  5640. }
  5641. }
  5642. $db->free($resql);
  5643. } else {
  5644. dol_print_error($db);
  5645. }
  5646. } else {
  5647. $ret = $conf->global->MAIN_VAT_DEFAULT_IF_AUTODETECT_FAILS; // Forced value if autodetect fails
  5648. }
  5649. }
  5650. dol_syslog("get_product_vat_for_country: ret=".$ret);
  5651. return $ret;
  5652. }
  5653. /**
  5654. * Return localtax vat rate of a product in a particular country or default country vat if product is unknown
  5655. *
  5656. * @param int $idprod Id of product
  5657. * @param int $local 1 for localtax1, 2 for localtax 2
  5658. * @param Societe $thirdpartytouse Thirdparty with a ->country_code defined (FR, US, IT, ...)
  5659. * @return int <0 if KO, Vat rate if OK
  5660. * @see get_product_vat_for_country()
  5661. */
  5662. function get_product_localtax_for_country($idprod, $local, $thirdpartytouse)
  5663. {
  5664. global $db, $mysoc;
  5665. if (!class_exists('Product')) {
  5666. require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php';
  5667. }
  5668. $ret = 0;
  5669. $found = 0;
  5670. if ($idprod > 0) {
  5671. // Load product
  5672. $product = new Product($db);
  5673. $result = $product->fetch($idprod);
  5674. if ($mysoc->country_code == $thirdpartytouse->country_code) { // If selling country is ours
  5675. /* Not defined yet, so we don't use this
  5676. if ($local==1) $ret=$product->localtax1_tx;
  5677. elseif ($local==2) $ret=$product->localtax2_tx;
  5678. $found=1;
  5679. */
  5680. } else {
  5681. // TODO Read default product vat according to product and another countrycode.
  5682. // Vat for couple anothercountrycode/product is data that is not managed and store yet, so we will fallback on next rule.
  5683. }
  5684. }
  5685. if (!$found) {
  5686. // If vat of product for the country not found or not defined, we return higher vat of country.
  5687. $sql = "SELECT taux as vat_rate, localtax1, localtax2";
  5688. $sql .= " FROM ".MAIN_DB_PREFIX."c_tva as t, ".MAIN_DB_PREFIX."c_country as c";
  5689. $sql .= " WHERE t.active=1 AND t.fk_pays = c.rowid AND c.code='".$db->escape($thirdpartytouse->country_code)."'";
  5690. $sql .= " ORDER BY t.taux DESC, t.recuperableonly ASC";
  5691. $sql .= $db->plimit(1);
  5692. $resql = $db->query($sql);
  5693. if ($resql) {
  5694. $obj = $db->fetch_object($resql);
  5695. if ($obj) {
  5696. if ($local == 1) {
  5697. $ret = $obj->localtax1;
  5698. } elseif ($local == 2) {
  5699. $ret = $obj->localtax2;
  5700. }
  5701. }
  5702. } else {
  5703. dol_print_error($db);
  5704. }
  5705. }
  5706. dol_syslog("get_product_localtax_for_country: ret=".$ret);
  5707. return $ret;
  5708. }
  5709. /**
  5710. * Function that return vat rate of a product line (according to seller, buyer and product vat rate)
  5711. * VATRULE 1: Si vendeur non assujeti a TVA, TVA par defaut=0. Fin de regle.
  5712. * VATRULE 2: Si le (pays vendeur = pays acheteur) alors TVA par defaut=TVA du produit vendu. Fin de regle.
  5713. * VATRULE 3: 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.
  5714. * VATRULE 4: Si (vendeur et acheteur dans Communaute europeenne) et (acheteur = particulier) alors TVA par defaut=TVA du produit vendu. Fin de regle
  5715. * VATRULE 5: Si (vendeur et acheteur dans Communaute europeenne) et (acheteur = entreprise) alors TVA par defaut=0. Fin de regle
  5716. * VATRULE 6: Sinon TVA proposee par defaut=0. Fin de regle.
  5717. *
  5718. * @param Societe $thirdparty_seller Objet societe vendeuse
  5719. * @param Societe $thirdparty_buyer Objet societe acheteuse
  5720. * @param int $idprod Id product
  5721. * @param int $idprodfournprice Id product_fournisseur_price (for supplier order/invoice)
  5722. * @return float|string Vat rate to use with format 5.0 or '5.0 (XXX)', -1 if we can't guess it
  5723. * @see get_default_npr(), get_default_localtax()
  5724. */
  5725. function get_default_tva(Societe $thirdparty_seller, Societe $thirdparty_buyer, $idprod = 0, $idprodfournprice = 0)
  5726. {
  5727. global $conf;
  5728. require_once DOL_DOCUMENT_ROOT.'/core/lib/company.lib.php';
  5729. // Note: possible values for tva_assuj are 0/1 or franchise/reel
  5730. $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;
  5731. $seller_country_code = $thirdparty_seller->country_code;
  5732. $seller_in_cee = isInEEC($thirdparty_seller);
  5733. $buyer_country_code = $thirdparty_buyer->country_code;
  5734. $buyer_in_cee = isInEEC($thirdparty_buyer);
  5735. dol_syslog("get_default_tva: seller use vat=".$seller_use_vat.", seller country=".$seller_country_code.", seller in cee=".$seller_in_cee.", buyer vat number=".$thirdparty_buyer->tva_intra." buyer country=".$buyer_country_code.", buyer in cee=".$buyer_in_cee.", idprod=".$idprod.", idprodfournprice=".$idprodfournprice.", SERVICE_ARE_ECOMMERCE_200238EC=".(!empty($conf->global->SERVICES_ARE_ECOMMERCE_200238EC) ? $conf->global->SERVICES_ARE_ECOMMERCE_200238EC : ''));
  5736. // 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)
  5737. // we use the buyer VAT.
  5738. if (!empty($conf->global->SERVICE_ARE_ECOMMERCE_200238EC)) {
  5739. if ($seller_in_cee && $buyer_in_cee) {
  5740. $isacompany = $thirdparty_buyer->isACompany();
  5741. if ($isacompany && !empty($conf->global->MAIN_USE_VAT_COMPANIES_IN_EEC_WITH_INVALID_VAT_ID_ARE_INDIVIDUAL)) {
  5742. require_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
  5743. if (!isValidVATID($thirdparty_buyer)) {
  5744. $isacompany = 0;
  5745. }
  5746. }
  5747. if (!$isacompany) {
  5748. //print 'VATRULE 0';
  5749. return get_product_vat_for_country($idprod, $thirdparty_buyer, $idprodfournprice);
  5750. }
  5751. }
  5752. }
  5753. // If seller does not use VAT
  5754. if (!$seller_use_vat) {
  5755. //print 'VATRULE 1';
  5756. return 0;
  5757. }
  5758. // 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.
  5759. // Si le (pays vendeur = pays acheteur) alors la TVA par defaut=TVA du produit vendu. Fin de regle.
  5760. if (($seller_country_code == $buyer_country_code)
  5761. || (in_array($seller_country_code, array('FR', 'MC')) && in_array($buyer_country_code, array('FR', 'MC')))) { // Warning ->country_code not always defined
  5762. //print 'VATRULE 2';
  5763. return get_product_vat_for_country($idprod, $thirdparty_seller, $idprodfournprice);
  5764. }
  5765. // 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.
  5766. // 'VATRULE 3' - Not supported
  5767. // Si (vendeur et acheteur dans Communaute europeenne) et (acheteur = entreprise) alors TVA par defaut=0. Fin de regle
  5768. // Si (vendeur et acheteur dans Communaute europeenne) et (acheteur = particulier) alors TVA par defaut=TVA du produit vendu. Fin de regle
  5769. if (($seller_in_cee && $buyer_in_cee)) {
  5770. $isacompany = $thirdparty_buyer->isACompany();
  5771. if ($isacompany && !empty($conf->global->MAIN_USE_VAT_COMPANIES_IN_EEC_WITH_INVALID_VAT_ID_ARE_INDIVIDUAL)) {
  5772. require_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
  5773. if (!isValidVATID($thirdparty_buyer)) {
  5774. $isacompany = 0;
  5775. }
  5776. }
  5777. if (!$isacompany) {
  5778. //print 'VATRULE 4';
  5779. return get_product_vat_for_country($idprod, $thirdparty_seller, $idprodfournprice);
  5780. } else {
  5781. //print 'VATRULE 5';
  5782. return 0;
  5783. }
  5784. }
  5785. // Si (vendeur dans Communaute europeene et acheteur hors Communaute europeenne et acheteur particulier) alors TVA par defaut=TVA du produit vendu. Fin de regle
  5786. // I don't see any use case that need this rule.
  5787. if (!empty($conf->global->MAIN_USE_VAT_OF_PRODUCT_FOR_INDIVIDUAL_CUSTOMER_OUT_OF_EEC) && empty($buyer_in_cee)) {
  5788. $isacompany = $thirdparty_buyer->isACompany();
  5789. if (!$isacompany) {
  5790. return get_product_vat_for_country($idprod, $thirdparty_seller, $idprodfournprice);
  5791. //print 'VATRULE extra';
  5792. }
  5793. }
  5794. // Sinon la TVA proposee par defaut=0. Fin de regle.
  5795. // Rem: Cela signifie qu'au moins un des 2 est hors Communaute europeenne et que le pays differe
  5796. //print 'VATRULE 6';
  5797. return 0;
  5798. }
  5799. /**
  5800. * Fonction qui renvoie si tva doit etre tva percue recuperable
  5801. *
  5802. * @param Societe $thirdparty_seller Thirdparty seller
  5803. * @param Societe $thirdparty_buyer Thirdparty buyer
  5804. * @param int $idprod Id product
  5805. * @param int $idprodfournprice Id supplier price for product
  5806. * @return float 0 or 1
  5807. * @see get_default_tva(), get_default_localtax()
  5808. */
  5809. function get_default_npr(Societe $thirdparty_seller, Societe $thirdparty_buyer, $idprod = 0, $idprodfournprice = 0)
  5810. {
  5811. global $db;
  5812. if ($idprodfournprice > 0) {
  5813. if (!class_exists('ProductFournisseur')) {
  5814. require_once DOL_DOCUMENT_ROOT.'/fourn/class/fournisseur.product.class.php';
  5815. }
  5816. $prodprice = new ProductFournisseur($db);
  5817. $prodprice->fetch_product_fournisseur_price($idprodfournprice);
  5818. return $prodprice->fourn_tva_npr;
  5819. } elseif ($idprod > 0) {
  5820. if (!class_exists('Product')) {
  5821. require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php';
  5822. }
  5823. $prod = new Product($db);
  5824. $prod->fetch($idprod);
  5825. return $prod->tva_npr;
  5826. }
  5827. return 0;
  5828. }
  5829. /**
  5830. * Function that return localtax of a product line (according to seller, buyer and product vat rate)
  5831. * Si vendeur non assujeti a TVA, TVA par defaut=0. Fin de regle.
  5832. * Si le (pays vendeur = pays acheteur) alors TVA par defaut=TVA du produit vendu. Fin de regle.
  5833. * Sinon TVA proposee par defaut=0. Fin de regle.
  5834. *
  5835. * @param Societe $thirdparty_seller Thirdparty seller
  5836. * @param Societe $thirdparty_buyer Thirdparty buyer
  5837. * @param int $local Localtax to process (1 or 2)
  5838. * @param int $idprod Id product
  5839. * @return integer localtax, -1 si ne peut etre determine
  5840. * @see get_default_tva(), get_default_npr()
  5841. */
  5842. function get_default_localtax($thirdparty_seller, $thirdparty_buyer, $local, $idprod = 0)
  5843. {
  5844. global $mysoc;
  5845. if (!is_object($thirdparty_seller)) {
  5846. return -1;
  5847. }
  5848. if (!is_object($thirdparty_buyer)) {
  5849. return -1;
  5850. }
  5851. if ($local == 1) { // Localtax 1
  5852. if ($mysoc->country_code == 'ES') {
  5853. if (is_numeric($thirdparty_buyer->localtax1_assuj) && !$thirdparty_buyer->localtax1_assuj) {
  5854. return 0;
  5855. }
  5856. } else {
  5857. // Si vendeur non assujeti a Localtax1, localtax1 par default=0
  5858. if (is_numeric($thirdparty_seller->localtax1_assuj) && !$thirdparty_seller->localtax1_assuj) {
  5859. return 0;
  5860. }
  5861. if (!is_numeric($thirdparty_seller->localtax1_assuj) && $thirdparty_seller->localtax1_assuj == 'localtax1off') {
  5862. return 0;
  5863. }
  5864. }
  5865. } elseif ($local == 2) { //I Localtax 2
  5866. // Si vendeur non assujeti a Localtax2, localtax2 par default=0
  5867. if (is_numeric($thirdparty_seller->localtax2_assuj) && !$thirdparty_seller->localtax2_assuj) {
  5868. return 0;
  5869. }
  5870. if (!is_numeric($thirdparty_seller->localtax2_assuj) && $thirdparty_seller->localtax2_assuj == 'localtax2off') {
  5871. return 0;
  5872. }
  5873. }
  5874. if ($thirdparty_seller->country_code == $thirdparty_buyer->country_code) {
  5875. return get_product_localtax_for_country($idprod, $local, $thirdparty_seller);
  5876. }
  5877. return 0;
  5878. }
  5879. /**
  5880. * Return yes or no in current language
  5881. *
  5882. * @param string|int $yesno Value to test (1, 'yes', 'true' or 0, 'no', 'false')
  5883. * @param integer $case 1=Yes/No, 0=yes/no, 2=Disabled checkbox, 3=Disabled checkbox + Yes/No
  5884. * @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.
  5885. * @return string HTML string
  5886. */
  5887. function yn($yesno, $case = 1, $color = 0)
  5888. {
  5889. global $langs;
  5890. $result = 'unknown';
  5891. $classname = '';
  5892. if ($yesno == 1 || strtolower($yesno) == 'yes' || strtolower($yesno) == 'true') { // A mettre avant test sur no a cause du == 0
  5893. $result = $langs->trans('yes');
  5894. if ($case == 1 || $case == 3) {
  5895. $result = $langs->trans("Yes");
  5896. }
  5897. if ($case == 2) {
  5898. $result = '<input type="checkbox" value="1" checked disabled>';
  5899. }
  5900. if ($case == 3) {
  5901. $result = '<input type="checkbox" value="1" checked disabled> '.$result;
  5902. }
  5903. $classname = 'ok';
  5904. } elseif ($yesno == 0 || strtolower($yesno) == 'no' || strtolower($yesno) == 'false') {
  5905. $result = $langs->trans("no");
  5906. if ($case == 1 || $case == 3) {
  5907. $result = $langs->trans("No");
  5908. }
  5909. if ($case == 2) {
  5910. $result = '<input type="checkbox" value="0" disabled>';
  5911. }
  5912. if ($case == 3) {
  5913. $result = '<input type="checkbox" value="0" disabled> '.$result;
  5914. }
  5915. if ($color == 2) {
  5916. $classname = 'ok';
  5917. } else {
  5918. $classname = 'error';
  5919. }
  5920. }
  5921. if ($color) {
  5922. return '<span class="'.$classname.'">'.$result.'</span>';
  5923. }
  5924. return $result;
  5925. }
  5926. /**
  5927. * Return a path to have a the directory according to object where files are stored.
  5928. * New usage: $conf->module->multidir_output[$object->entity].'/'.get_exdir(0, 0, 0, 1, $object, '').'/'
  5929. * or: $conf->module->dir_output.'/'.get_exdir(0, 0, 0, 0, $object, '') if multidir_output not defined.
  5930. * Example out with new usage: $object is invoice -> 'INYYMM-ABCD'
  5931. * Example out with old usage: '015' with level 3->"0/1/5/", '015' with level 1->"5/", 'ABC-1' with level 3 ->"0/0/1/"
  5932. *
  5933. * @param string|int $num Id of object (deprecated, $object will be used in future)
  5934. * @param int $level Level of subdirs to return (1, 2 or 3 levels). (deprecated, global option will be used in future)
  5935. * @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)
  5936. * @param int $withoutslash 0=With slash at end (except if '/', we return ''), 1=without slash at end
  5937. * @param Object $object Object to use to get ref to forge the path.
  5938. * @param string $modulepart Type of object ('invoice_supplier, 'donation', 'invoice', ...'). Use '' for autodetect from $object.
  5939. * @return string Dir to use ending. Example '' or '1/' or '1/2/'
  5940. */
  5941. function get_exdir($num, $level, $alpha, $withoutslash, $object, $modulepart = '')
  5942. {
  5943. global $conf;
  5944. if (empty($modulepart) && !empty($object->module)) {
  5945. $modulepart = $object->module;
  5946. }
  5947. $path = '';
  5948. $arrayforoldpath = array('cheque', 'category', 'holiday', 'supplier_invoice', 'invoice_supplier', 'mailing', 'supplier_payment');
  5949. if (!empty($conf->global->PRODUCT_USE_OLD_PATH_FOR_PHOTO)) {
  5950. $arrayforoldpath[] = 'product';
  5951. }
  5952. if (!empty($level) && in_array($modulepart, $arrayforoldpath)) {
  5953. // This part should be removed once all code is using "get_exdir" to forge path, with parameter $object and $modulepart provided.
  5954. if (empty($alpha)) {
  5955. $num = preg_replace('/([^0-9])/i', '', $num);
  5956. } else {
  5957. $num = preg_replace('/^.*\-/i', '', $num);
  5958. }
  5959. $num = substr("000".$num, -$level);
  5960. if ($level == 1) {
  5961. $path = substr($num, 0, 1);
  5962. }
  5963. if ($level == 2) {
  5964. $path = substr($num, 1, 1).'/'.substr($num, 0, 1);
  5965. }
  5966. if ($level == 3) {
  5967. $path = substr($num, 2, 1).'/'.substr($num, 1, 1).'/'.substr($num, 0, 1);
  5968. }
  5969. } else {
  5970. // We will enhance here a common way of forging path for document storage.
  5971. // In a future, we may distribute directories on several levels depending on setup and object.
  5972. // Here, $object->id, $object->ref and $modulepart are required.
  5973. //var_dump($modulepart);
  5974. $path = dol_sanitizeFileName(empty($object->ref) ? (string) $object->id : $object->ref);
  5975. }
  5976. if (empty($withoutslash) && !empty($path)) {
  5977. $path .= '/';
  5978. }
  5979. return $path;
  5980. }
  5981. /**
  5982. * Creation of a directory (this can create recursive subdir)
  5983. *
  5984. * @param string $dir Directory to create (Separator must be '/'. Example: '/mydir/mysubdir')
  5985. * @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)
  5986. * @param string $newmask Mask for new file (Defaults to $conf->global->MAIN_UMASK or 0755 if unavailable). Example: '0444'
  5987. * @return int < 0 if KO, 0 = already exists, > 0 if OK
  5988. */
  5989. function dol_mkdir($dir, $dataroot = '', $newmask = '')
  5990. {
  5991. global $conf;
  5992. dol_syslog("functions.lib::dol_mkdir: dir=".$dir, LOG_INFO);
  5993. $dir_osencoded = dol_osencode($dir);
  5994. if (@is_dir($dir_osencoded)) {
  5995. return 0;
  5996. }
  5997. $nberr = 0;
  5998. $nbcreated = 0;
  5999. $ccdir = '';
  6000. if (!empty($dataroot)) {
  6001. // Remove data root from loop
  6002. $dir = str_replace($dataroot.'/', '', $dir);
  6003. $ccdir = $dataroot.'/';
  6004. }
  6005. $cdir = explode("/", $dir);
  6006. $num = count($cdir);
  6007. for ($i = 0; $i < $num; $i++) {
  6008. if ($i > 0) {
  6009. $ccdir .= '/'.$cdir[$i];
  6010. } else {
  6011. $ccdir .= $cdir[$i];
  6012. }
  6013. if (preg_match("/^.:$/", $ccdir, $regs)) {
  6014. continue; // Si chemin Windows incomplet, on poursuit par rep suivant
  6015. }
  6016. // Attention, le is_dir() peut echouer bien que le rep existe.
  6017. // (ex selon config de open_basedir)
  6018. if ($ccdir) {
  6019. $ccdir_osencoded = dol_osencode($ccdir);
  6020. if (!@is_dir($ccdir_osencoded)) {
  6021. dol_syslog("functions.lib::dol_mkdir: Directory '".$ccdir."' does not exists or is outside open_basedir PHP setting.", LOG_DEBUG);
  6022. umask(0);
  6023. $dirmaskdec = octdec((string) $newmask);
  6024. if (empty($newmask)) {
  6025. $dirmaskdec = empty($conf->global->MAIN_UMASK) ? octdec('0755') : octdec($conf->global->MAIN_UMASK);
  6026. }
  6027. $dirmaskdec |= octdec('0111'); // Set x bit required for directories
  6028. if (!@mkdir($ccdir_osencoded, $dirmaskdec)) {
  6029. // Si le is_dir a renvoye une fausse info, alors on passe ici.
  6030. dol_syslog("functions.lib::dol_mkdir: Fails to create directory '".$ccdir."' or directory already exists.", LOG_WARNING);
  6031. $nberr++;
  6032. } else {
  6033. dol_syslog("functions.lib::dol_mkdir: Directory '".$ccdir."' created", LOG_DEBUG);
  6034. $nberr = 0; // On remet a zero car si on arrive ici, cela veut dire que les echecs precedents peuvent etre ignore
  6035. $nbcreated++;
  6036. }
  6037. } else {
  6038. $nberr = 0; // On remet a zero car si on arrive ici, cela veut dire que les echecs precedents peuvent etre ignores
  6039. }
  6040. }
  6041. }
  6042. return ($nberr ? -$nberr : $nbcreated);
  6043. }
  6044. /**
  6045. * Return picto saying a field is required
  6046. *
  6047. * @return string Chaine avec picto obligatoire
  6048. */
  6049. function picto_required()
  6050. {
  6051. return '<span class="fieldrequired">*</span>';
  6052. }
  6053. /**
  6054. * Clean a string from all HTML tags and entities.
  6055. * This function differs from strip_tags because:
  6056. * - <br> are replaced with \n if removelinefeed=0 or 1
  6057. * - if entities are found, they are decoded BEFORE the strip
  6058. * - you can decide to convert line feed into a space
  6059. *
  6060. * @param string $stringtoclean String to clean
  6061. * @param integer $removelinefeed 1=Replace all new lines by 1 space, 0=Only ending new lines are removed others are replaced with \n, 2=Ending new lines are removed but others are kept with a same number of \n than nb of <br> when there is both "...<br>\n..."
  6062. * @param string $pagecodeto Encoding of input/output string
  6063. * @param integer $strip_tags 0=Use internal strip, 1=Use strip_tags() php function (bugged when text contains a < char that is not for a html tag or when tags is not closed like '<img onload=aaa')
  6064. * @param integer $removedoublespaces Replace double space into one space
  6065. * @return string String cleaned
  6066. *
  6067. * @see dol_escape_htmltag() strip_tags() dol_string_onlythesehtmltags() dol_string_neverthesehtmltags(), dolStripPhpCode()
  6068. */
  6069. function dol_string_nohtmltag($stringtoclean, $removelinefeed = 1, $pagecodeto = 'UTF-8', $strip_tags = 0, $removedoublespaces = 1)
  6070. {
  6071. if ($removelinefeed == 2) {
  6072. $stringtoclean = preg_replace('/<br[^>]*>(\n|\r)+/ims', '<br>', $stringtoclean);
  6073. }
  6074. $temp = preg_replace('/<br[^>]*>/i', "\n", $stringtoclean);
  6075. // We remove entities BEFORE stripping (in case of an open separator char that is entity encoded and not the closing other, the strip will fails)
  6076. $temp = dol_html_entity_decode($temp, ENT_COMPAT | ENT_HTML5, $pagecodeto);
  6077. $temp = str_replace('< ', '__ltspace__', $temp);
  6078. if ($strip_tags) {
  6079. $temp = strip_tags($temp);
  6080. } else {
  6081. // Remove '<' into remainging, so remove non closing html tags like '<abc' or '<<abc'. Note: '<123abc' is not a html tag (can be kept), but '<abc123' is (must be removed).
  6082. $pattern = "/<[^<>]+>/";
  6083. // Example of $temp: <a href="/myurl" title="<u>A title</u>">0000-021</a>
  6084. // pass 1 - $temp after pass 1: <a href="/myurl" title="A title">0000-021
  6085. // pass 2 - $temp after pass 2: 0000-021
  6086. $tempbis = $temp;
  6087. do {
  6088. $temp = $tempbis;
  6089. $tempbis = str_replace('<>', '', $temp); // No reason to have this into a text, except if value is to try bypass the next html cleaning
  6090. $tempbis = preg_replace($pattern, '', $tempbis);
  6091. //$idowhile++; print $temp.'-'.$tempbis."\n"; if ($idowhile > 100) break;
  6092. } while ($tempbis != $temp);
  6093. $temp = $tempbis;
  6094. // Remove '<' into remaining, so remove non closing html tags like '<abc' or '<<abc'. Note: '<123abc' is not a html tag (can be kept), but '<abc123' is (must be removed).
  6095. $temp = preg_replace('/<+([a-z]+)/i', '\1', $temp);
  6096. }
  6097. $temp = dol_html_entity_decode($temp, ENT_COMPAT, $pagecodeto);
  6098. // Remove also carriage returns
  6099. if ($removelinefeed == 1) {
  6100. $temp = str_replace(array("\r\n", "\r", "\n"), " ", $temp);
  6101. }
  6102. // And double quotes
  6103. if ($removedoublespaces) {
  6104. while (strpos($temp, " ")) {
  6105. $temp = str_replace(" ", " ", $temp);
  6106. }
  6107. }
  6108. $temp = str_replace('__ltspace__', '< ', $temp);
  6109. return trim($temp);
  6110. }
  6111. /**
  6112. * Clean a string to keep only desirable HTML tags.
  6113. * WARNING: This also clean HTML comments (used to obfuscate tag name).
  6114. *
  6115. * @param string $stringtoclean String to clean
  6116. * @param int $cleanalsosomestyles Remove absolute/fixed positioning from inline styles
  6117. * @param int $removeclassattribute 1=Remove the class attribute from tags
  6118. * @param int $cleanalsojavascript Remove also occurence of 'javascript:'.
  6119. * @param int $allowiframe Allow iframe tags.
  6120. * @return string String cleaned
  6121. *
  6122. * @see dol_escape_htmltag() strip_tags() dol_string_nohtmltag() dol_string_neverthesehtmltags()
  6123. */
  6124. function dol_string_onlythesehtmltags($stringtoclean, $cleanalsosomestyles = 1, $removeclassattribute = 1, $cleanalsojavascript = 0, $allowiframe = 0)
  6125. {
  6126. $allowed_tags = array(
  6127. "html", "head", "meta", "body", "article", "a", "abbr", "b", "blockquote", "br", "cite", "div", "dl", "dd", "dt", "em", "font", "img", "ins", "hr", "i", "li", "link",
  6128. "ol", "p", "q", "s", "section", "span", "strike", "strong", "title", "table", "tr", "th", "td", "u", "ul", "sup", "sub", "blockquote", "pre", "h1", "h2", "h3", "h4", "h5", "h6",
  6129. "comment" // this tags is added to manage comment <!--...--> that are replaced into <comment>...</comment>
  6130. );
  6131. if ($allowiframe) {
  6132. $allowed_tags[] = "iframe";
  6133. }
  6134. $allowed_tags_string = join("><", $allowed_tags);
  6135. $allowed_tags_string = '<'.$allowed_tags_string.'>';
  6136. $stringtoclean = str_replace('<!DOCTYPE html>', '__!DOCTYPE_HTML__', $stringtoclean); // Replace DOCTYPE to avoid to have it removed by the strip_tags
  6137. $stringtoclean = dol_string_nounprintableascii($stringtoclean, 0);
  6138. //$stringtoclean = preg_replace('/<!--[^>]*-->/', '', $stringtoclean);
  6139. $stringtoclean = preg_replace('/<!--([^>]*)-->/', '<comment>\1</comment>', $stringtoclean);
  6140. $stringtoclean = preg_replace('/&colon;/i', ':', $stringtoclean);
  6141. $stringtoclean = preg_replace('/&#58;|&#0+58|&#x3A/i', '', $stringtoclean); // refused string ':' encoded (no reason to have a : encoded like this) to disable 'javascript:...'
  6142. $stringtoclean = preg_replace('/javascript\s*:/i', '', $stringtoclean);
  6143. $temp = strip_tags($stringtoclean, $allowed_tags_string); // Warning: This remove also undesired </> changing string obfuscated with </> that pass injection detection into harmfull string
  6144. if ($cleanalsosomestyles) { // Clean for remaining html tags
  6145. $temp = preg_replace('/position\s*:\s*(absolute|fixed)\s*!\s*important/i', '', $temp); // Note: If hacker try to introduce css comment into string to bypass this regex, the string must also be encoded by the dol_htmlentitiesbr during output so it become harmless
  6146. }
  6147. if ($removeclassattribute) { // Clean for remaining html tags
  6148. $temp = preg_replace('/(<[^>]+)\s+class=((["\']).*?\\3|\\w*)/i', '\\1', $temp);
  6149. }
  6150. // Remove 'javascript:' that we should not find into a text with
  6151. // Warning: This is not reliable to fight against obfuscated javascript, there is a lot of other solution to include js into a common html tag (only filtered by a GETPOST(.., powerfullfilter)).
  6152. if ($cleanalsojavascript) {
  6153. $temp = preg_replace('/javascript\s*:/i', '', $temp);
  6154. }
  6155. $temp = str_replace('__!DOCTYPE_HTML__', '<!DOCTYPE html>', $temp); // Restore the DOCTYPE
  6156. $temp = preg_replace('/<comment>([^>]*)<\/comment>/', '<!--\1-->', $temp); // Restore html comments
  6157. return $temp;
  6158. }
  6159. /**
  6160. * Clean a string from some undesirable HTML tags.
  6161. * Note: Complementary to dol_string_onlythesehtmltags().
  6162. * This method is used for example when option MAIN_RESTRICTHTML_REMOVE_ALSO_BAD_ATTRIBUTES is set to 1.
  6163. *
  6164. * @param string $stringtoclean String to clean
  6165. * @param array $allowed_attributes Array of tags not allowed
  6166. * @return string String cleaned
  6167. *
  6168. * @see dol_escape_htmltag() strip_tags() dol_string_nohtmltag() dol_string_onlythesehtmltags() dol_string_neverthesehtmltags()
  6169. */
  6170. function dol_string_onlythesehtmlattributes($stringtoclean, $allowed_attributes = array("allow", "allowfullscreen", "alt", "class", "contenteditable", "data-html", "frameborder", "height", "href", "id", "name", "src", "style", "target", "title", "width"))
  6171. {
  6172. if (class_exists('DOMDocument') && !empty($stringtoclean)) {
  6173. $stringtoclean = '<?xml encoding="UTF-8"><html><body>'.$stringtoclean.'</body></html>';
  6174. $dom = new DOMDocument(null, 'UTF-8');
  6175. $dom->loadHTML($stringtoclean, LIBXML_ERR_NONE|LIBXML_HTML_NOIMPLIED|LIBXML_HTML_NODEFDTD|LIBXML_NONET|LIBXML_NOWARNING|LIBXML_NOXMLDECL);
  6176. if (is_object($dom)) {
  6177. for ($els = $dom->getElementsByTagname('*'), $i = $els->length - 1; $i >= 0; $i--) {
  6178. for ($attrs = $els->item($i)->attributes, $ii = $attrs->length - 1; $ii >= 0; $ii--) {
  6179. //var_dump($attrs->item($ii));
  6180. if (! empty($attrs->item($ii)->name)) {
  6181. // Delete attribute if not into allowed_attributes
  6182. if (! in_array($attrs->item($ii)->name, $allowed_attributes)) {
  6183. $els->item($i)->removeAttribute($attrs->item($ii)->name);
  6184. } elseif (in_array($attrs->item($ii)->name, array('style'))) {
  6185. $valuetoclean = $attrs->item($ii)->value;
  6186. if (isset($valuetoclean)) {
  6187. do {
  6188. $oldvaluetoclean = $valuetoclean;
  6189. $valuetoclean = preg_replace('/\/\*.*\*\//m', '', $valuetoclean); // clean css comments
  6190. $valuetoclean = preg_replace('/position\s*:\s*[a-z]+/mi', '', $valuetoclean);
  6191. if ($els->item($i)->tagName == 'a') { // more paranoiac cleaning for clickable tags.
  6192. $valuetoclean = preg_replace('/display\s*://m', '', $valuetoclean);
  6193. $valuetoclean = preg_replace('/z-index\s*://m', '', $valuetoclean);
  6194. $valuetoclean = preg_replace('/\s+(top|left|right|bottom)\s*://m', '', $valuetoclean);
  6195. }
  6196. } while ($oldvaluetoclean != $valuetoclean);
  6197. }
  6198. $attrs->item($ii)->value = $valuetoclean;
  6199. }
  6200. }
  6201. }
  6202. }
  6203. }
  6204. $return = $dom->saveHTML();
  6205. //$return = '<html><body>aaaa</p>bb<p>ssdd</p>'."\n<p>aaa</p>aa<p>bb</p>";
  6206. $return = preg_replace('/^'.preg_quote('<?xml encoding="UTF-8">', '/').'/', '', $return);
  6207. $return = preg_replace('/^'.preg_quote('<html><body>', '/').'/', '', $return);
  6208. $return = preg_replace('/'.preg_quote('</body></html>', '/').'$/', '', $return);
  6209. return trim($return);
  6210. } else {
  6211. return $stringtoclean;
  6212. }
  6213. }
  6214. /**
  6215. * Clean a string from some undesirable HTML tags.
  6216. * Note. Not as secured as dol_string_onlythesehtmltags().
  6217. *
  6218. * @param string $stringtoclean String to clean
  6219. * @param array $disallowed_tags Array of tags not allowed
  6220. * @param string $cleanalsosomestyles Clean also some tags
  6221. * @return string String cleaned
  6222. *
  6223. * @see dol_escape_htmltag() strip_tags() dol_string_nohtmltag() dol_string_onlythesehtmltags() dol_string_onlythesehtmlattributes()
  6224. */
  6225. function dol_string_neverthesehtmltags($stringtoclean, $disallowed_tags = array('textarea'), $cleanalsosomestyles = 0)
  6226. {
  6227. $temp = $stringtoclean;
  6228. foreach ($disallowed_tags as $tagtoremove) {
  6229. $temp = preg_replace('/<\/?'.$tagtoremove.'>/', '', $temp);
  6230. $temp = preg_replace('/<\/?'.$tagtoremove.'\s+[^>]*>/', '', $temp);
  6231. }
  6232. if ($cleanalsosomestyles) {
  6233. $temp = preg_replace('/position\s*:\s*(absolute|fixed)\s*!\s*important/', '', $temp); // Note: If hacker try to introduce css comment into string to avoid this, string should be encoded by the dol_htmlentitiesbr so be harmless
  6234. }
  6235. return $temp;
  6236. }
  6237. /**
  6238. * Return first line of text. Cut will depends if content is HTML or not.
  6239. *
  6240. * @param string $text Input text
  6241. * @param int $nboflines Nb of lines to get (default is 1 = first line only)
  6242. * @param string $charset Charset of $text string (UTF-8 by default)
  6243. * @return string Output text
  6244. * @see dol_nboflines_bis(), dol_string_nohtmltag(), dol_escape_htmltag()
  6245. */
  6246. function dolGetFirstLineOfText($text, $nboflines = 1, $charset = 'UTF-8')
  6247. {
  6248. if ($nboflines == 1) {
  6249. if (dol_textishtml($text)) {
  6250. $firstline = preg_replace('/<br[^>]*>.*$/s', '', $text); // The s pattern modifier means the . can match newline characters
  6251. $firstline = preg_replace('/<div[^>]*>.*$/s', '', $firstline); // The s pattern modifier means the . can match newline characters
  6252. } else {
  6253. $firstline = preg_replace('/[\n\r].*/', '', $text);
  6254. }
  6255. return $firstline.((strlen($firstline) != strlen($text)) ? '...' : '');
  6256. } else {
  6257. $ishtml = 0;
  6258. if (dol_textishtml($text)) {
  6259. $text = preg_replace('/\n/', '', $text);
  6260. $ishtml = 1;
  6261. $repTable = array("\t" => " ", "\n" => " ", "\r" => " ", "\0" => " ", "\x0B" => " ");
  6262. } else {
  6263. $repTable = array("\t" => " ", "\n" => "<br>", "\r" => " ", "\0" => " ", "\x0B" => " ");
  6264. }
  6265. $text = strtr($text, $repTable);
  6266. if ($charset == 'UTF-8') {
  6267. $pattern = '/(<br[^>]*>)/Uu';
  6268. } else {
  6269. // /U is to have UNGREEDY regex to limit to one html tag. /u is for UTF8 support
  6270. $pattern = '/(<br[^>]*>)/U'; // /U is to have UNGREEDY regex to limit to one html tag.
  6271. }
  6272. $a = preg_split($pattern, $text, -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);
  6273. $firstline = '';
  6274. $i = 0;
  6275. $nba = count($a); // 2x nb of lines in $a because $a contains also a line for each new line separator
  6276. while (($i < $nba) && ($i < ($nboflines * 2))) {
  6277. if ($i % 2 == 0) {
  6278. $firstline .= $a[$i];
  6279. } elseif (($i < (($nboflines * 2) - 1)) && ($i < ($nba - 1))) {
  6280. $firstline .= ($ishtml ? "<br>\n" : "\n");
  6281. }
  6282. $i++;
  6283. }
  6284. unset($a);
  6285. return $firstline.(($i < $nba) ? '...' : '');
  6286. }
  6287. }
  6288. /**
  6289. * Replace CRLF in string with a HTML BR tag.
  6290. * WARNING: The content after operation contains some HTML tags (the <br>) so be sure to also have encode the special chars of stringtoencode into HTML before.
  6291. *
  6292. * @param string $stringtoencode String to encode
  6293. * @param int $nl2brmode 0=Adding br before \n, 1=Replacing \n by br
  6294. * @param bool $forxml false=Use <br>, true=Use <br />
  6295. * @return string String encoded
  6296. * @see dol_nboflines(), dolGetFirstLineOfText()
  6297. */
  6298. function dol_nl2br($stringtoencode, $nl2brmode = 0, $forxml = false)
  6299. {
  6300. if (!$nl2brmode) {
  6301. return nl2br($stringtoencode, $forxml);
  6302. } else {
  6303. $ret = preg_replace('/(\r\n|\r|\n)/i', ($forxml ? '<br />' : '<br>'), $stringtoencode);
  6304. return $ret;
  6305. }
  6306. }
  6307. /**
  6308. * This function is called to encode a string into a HTML string but differs from htmlentities because
  6309. * a detection is done before to see if text is already HTML or not. Also, all entities but &,<,>," are converted.
  6310. * This permits to encode special chars to entities with no double encoding for already encoded HTML strings.
  6311. * This function also remove last EOL or BR if $removelasteolbr=1 (default).
  6312. * For PDF usage, you can show text by 2 ways:
  6313. * - writeHTMLCell -> param must be encoded into HTML.
  6314. * - MultiCell -> param must not be encoded into HTML.
  6315. * Because writeHTMLCell convert also \n into <br>, if function
  6316. * is used to build PDF, nl2brmode must be 1.
  6317. *
  6318. * @param string $stringtoencode String to encode
  6319. * @param int $nl2brmode 0=Adding br before \n, 1=Replacing \n by br (for use with FPDF writeHTMLCell function for example)
  6320. * @param string $pagecodefrom Pagecode stringtoencode is encoded
  6321. * @param int $removelasteolbr 1=Remove last br or lasts \n (default), 0=Do nothing
  6322. * @return string String encoded
  6323. */
  6324. function dol_htmlentitiesbr($stringtoencode, $nl2brmode = 0, $pagecodefrom = 'UTF-8', $removelasteolbr = 1)
  6325. {
  6326. $newstring = $stringtoencode;
  6327. if (dol_textishtml($stringtoencode)) { // Check if text is already HTML or not
  6328. $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.
  6329. if ($removelasteolbr) {
  6330. $newstring = preg_replace('/<br>$/i', '', $newstring); // Remove last <br> (remove only last one)
  6331. }
  6332. $newstring = strtr($newstring, array('&'=>'__and__', '<'=>'__lt__', '>'=>'__gt__', '"'=>'__dquot__'));
  6333. $newstring = dol_htmlentities($newstring, ENT_COMPAT, $pagecodefrom); // Make entity encoding
  6334. $newstring = strtr($newstring, array('__and__'=>'&', '__lt__'=>'<', '__gt__'=>'>', '__dquot__'=>'"'));
  6335. } else {
  6336. if ($removelasteolbr) {
  6337. $newstring = preg_replace('/(\r\n|\r|\n)$/i', '', $newstring); // Remove last \n (may remove several)
  6338. }
  6339. $newstring = dol_nl2br(dol_htmlentities($newstring, ENT_COMPAT, $pagecodefrom), $nl2brmode);
  6340. }
  6341. // Other substitutions that htmlentities does not do
  6342. //$newstring=str_replace(chr(128),'&euro;',$newstring); // 128 = 0x80. Not in html entity table. // Seems useles with TCPDF. Make bug with UTF8 languages
  6343. return $newstring;
  6344. }
  6345. /**
  6346. * This function is called to decode a HTML string (it decodes entities and br tags)
  6347. *
  6348. * @param string $stringtodecode String to decode
  6349. * @param string $pagecodeto Page code for result
  6350. * @return string String decoded
  6351. */
  6352. function dol_htmlentitiesbr_decode($stringtodecode, $pagecodeto = 'UTF-8')
  6353. {
  6354. $ret = dol_html_entity_decode($stringtodecode, ENT_COMPAT | ENT_HTML5, $pagecodeto);
  6355. $ret = preg_replace('/'."\r\n".'<br(\s[\sa-zA-Z_="]*)?\/?>/i', "<br>", $ret);
  6356. $ret = preg_replace('/<br(\s[\sa-zA-Z_="]*)?\/?>'."\r\n".'/i', "\r\n", $ret);
  6357. $ret = preg_replace('/<br(\s[\sa-zA-Z_="]*)?\/?>'."\n".'/i', "\n", $ret);
  6358. $ret = preg_replace('/<br(\s[\sa-zA-Z_="]*)?\/?>/i', "\n", $ret);
  6359. return $ret;
  6360. }
  6361. /**
  6362. * This function remove all ending \n and br at end
  6363. *
  6364. * @param string $stringtodecode String to decode
  6365. * @return string String decoded
  6366. */
  6367. function dol_htmlcleanlastbr($stringtodecode)
  6368. {
  6369. $ret = preg_replace('/&nbsp;$/i', "", $stringtodecode); // Because wysiwyg editor may add a &nbsp; at end of last line
  6370. $ret = preg_replace('/(<br>|<br(\s[\sa-zA-Z_="]*)?\/?>|'."\n".'|'."\r".')+$/i', "", $ret);
  6371. return $ret;
  6372. }
  6373. /**
  6374. * Replace html_entity_decode functions to manage errors
  6375. *
  6376. * @param string $a Operand a
  6377. * @param string $b Operand b (ENT_QUOTES|ENT_HTML5=convert simple, double quotes, colon, e accent, ...)
  6378. * @param string $c Operand c
  6379. * @param string $keepsomeentities Entities but &, <, >, " are not converted.
  6380. * @return string String decoded
  6381. */
  6382. function dol_html_entity_decode($a, $b, $c = 'UTF-8', $keepsomeentities = 0)
  6383. {
  6384. $newstring = $a;
  6385. if ($keepsomeentities) {
  6386. $newstring = strtr($newstring, array('&amp;'=>'__andamp__', '&lt;'=>'__andlt__', '&gt;'=>'__andgt__', '"'=>'__dquot__'));
  6387. }
  6388. $newstring = html_entity_decode((string) $newstring, (int) $b, (string) $c);
  6389. if ($keepsomeentities) {
  6390. $newstring = strtr($newstring, array('__andamp__'=>'&amp;', '__andlt__'=>'&lt;', '__andgt__'=>'&gt;', '__dquot__'=>'"'));
  6391. }
  6392. return $newstring;
  6393. }
  6394. /**
  6395. * Replace htmlentities functions.
  6396. * Goal of this function is to be sure to have default values of htmlentities that match what we need.
  6397. *
  6398. * @param string $string The input string to encode
  6399. * @param int $flags Flags (see PHP doc above)
  6400. * @param string $encoding Encoding page code
  6401. * @param bool $double_encode When double_encode is turned off, PHP will not encode existing html entities
  6402. * @return string $ret Encoded string
  6403. */
  6404. function dol_htmlentities($string, $flags = ENT_QUOTES|ENT_SUBSTITUTE, $encoding = 'UTF-8', $double_encode = false)
  6405. {
  6406. return htmlentities($string, $flags, $encoding, $double_encode);
  6407. }
  6408. /**
  6409. * Check if a string is a correct iso string
  6410. * If not, it will we considered not HTML encoded even if it is by FPDF.
  6411. * Example, if string contains euro symbol that has ascii code 128
  6412. *
  6413. * @param string $s String to check
  6414. * @param string $clean Clean if it is not an ISO. Warning, if file is utf8, you will get a bad formated file.
  6415. * @return int|string 0 if bad iso, 1 if good iso, Or the clean string if $clean is 1
  6416. */
  6417. function dol_string_is_good_iso($s, $clean = 0)
  6418. {
  6419. $len = dol_strlen($s);
  6420. $out = '';
  6421. $ok = 1;
  6422. for ($scursor = 0; $scursor < $len; $scursor++) {
  6423. $ordchar = ord($s[$scursor]);
  6424. //print $scursor.'-'.$ordchar.'<br>';
  6425. if ($ordchar < 32 && $ordchar != 13 && $ordchar != 10) {
  6426. $ok = 0;
  6427. break;
  6428. } elseif ($ordchar > 126 && $ordchar < 160) {
  6429. $ok = 0;
  6430. break;
  6431. } elseif ($clean) {
  6432. $out .= $s[$scursor];
  6433. }
  6434. }
  6435. if ($clean) {
  6436. return $out;
  6437. }
  6438. return $ok;
  6439. }
  6440. /**
  6441. * Return nb of lines of a clear text
  6442. *
  6443. * @param string $s String to check
  6444. * @param int $maxchar Not yet used
  6445. * @return int Number of lines
  6446. * @see dol_nboflines_bis(), dolGetFirstLineOfText()
  6447. */
  6448. function dol_nboflines($s, $maxchar = 0)
  6449. {
  6450. if ($s == '') {
  6451. return 0;
  6452. }
  6453. $arraystring = explode("\n", $s);
  6454. $nb = count($arraystring);
  6455. return $nb;
  6456. }
  6457. /**
  6458. * Return nb of lines of a formated text with \n and <br> (WARNING: string must not have mixed \n and br separators)
  6459. *
  6460. * @param string $text Text
  6461. * @param int $maxlinesize Largeur de ligne en caracteres (ou 0 si pas de limite - defaut)
  6462. * @param string $charset Give the charset used to encode the $text variable in memory.
  6463. * @return int Number of lines
  6464. * @see dol_nboflines(), dolGetFirstLineOfText()
  6465. */
  6466. function dol_nboflines_bis($text, $maxlinesize = 0, $charset = 'UTF-8')
  6467. {
  6468. $repTable = array("\t" => " ", "\n" => "<br>", "\r" => " ", "\0" => " ", "\x0B" => " ");
  6469. if (dol_textishtml($text)) {
  6470. $repTable = array("\t" => " ", "\n" => " ", "\r" => " ", "\0" => " ", "\x0B" => " ");
  6471. }
  6472. $text = strtr($text, $repTable);
  6473. if ($charset == 'UTF-8') {
  6474. $pattern = '/(<br[^>]*>)/Uu';
  6475. } else {
  6476. // /U is to have UNGREEDY regex to limit to one html tag. /u is for UTF8 support
  6477. $pattern = '/(<br[^>]*>)/U'; // /U is to have UNGREEDY regex to limit to one html tag.
  6478. }
  6479. $a = preg_split($pattern, $text, -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);
  6480. $nblines = (int) floor((count($a) + 1) / 2);
  6481. // count possible auto line breaks
  6482. if ($maxlinesize) {
  6483. foreach ($a as $line) {
  6484. if (dol_strlen($line) > $maxlinesize) {
  6485. //$line_dec = html_entity_decode(strip_tags($line));
  6486. $line_dec = html_entity_decode($line);
  6487. if (dol_strlen($line_dec) > $maxlinesize) {
  6488. $line_dec = wordwrap($line_dec, $maxlinesize, '\n', true);
  6489. $nblines += substr_count($line_dec, '\n');
  6490. }
  6491. }
  6492. }
  6493. }
  6494. unset($a);
  6495. return $nblines;
  6496. }
  6497. /**
  6498. * Return if a text is a html content
  6499. *
  6500. * @param string $msg Content to check
  6501. * @param int $option 0=Full detection, 1=Fast check
  6502. * @return boolean true/false
  6503. * @see dol_concatdesc()
  6504. */
  6505. function dol_textishtml($msg, $option = 0)
  6506. {
  6507. if ($option == 1) {
  6508. if (preg_match('/<html/i', $msg)) {
  6509. return true;
  6510. } elseif (preg_match('/<body/i', $msg)) {
  6511. return true;
  6512. } elseif (preg_match('/<\/textarea/i', $msg)) {
  6513. return true;
  6514. } elseif (preg_match('/<(b|em|i|u)>/i', $msg)) {
  6515. return true;
  6516. } elseif (preg_match('/<br/i', $msg)) {
  6517. return true;
  6518. }
  6519. return false;
  6520. } else {
  6521. // Remove all urls because 'http://aa?param1=abc&amp;param2=def' must not be used inside detection
  6522. $msg = preg_replace('/https?:\/\/[^"\'\s]+/i', '', $msg);
  6523. if (preg_match('/<html/i', $msg)) {
  6524. return true;
  6525. } elseif (preg_match('/<body/i', $msg)) {
  6526. return true;
  6527. } elseif (preg_match('/<\/textarea/i', $msg)) {
  6528. return true;
  6529. } elseif (preg_match('/<(b|em|i|u)>/i', $msg)) {
  6530. return true;
  6531. } elseif (preg_match('/<br\/>/i', $msg)) {
  6532. return true;
  6533. } elseif (preg_match('/<(br|div|font|li|p|span|strong|table)>/i', $msg)) {
  6534. return true;
  6535. } elseif (preg_match('/<(br|div|font|li|p|span|strong|table)\s+[^<>\/]*\/?>/i', $msg)) {
  6536. return true;
  6537. } elseif (preg_match('/<img\s+[^<>]*src[^<>]*>/i', $msg)) {
  6538. return true; // must accept <img src="http://example.com/aaa.png" />
  6539. } elseif (preg_match('/<a\s+[^<>]*href[^<>]*>/i', $msg)) {
  6540. return true; // must accept <a href="http://example.com/aaa.png" />
  6541. } elseif (preg_match('/<h[0-9]>/i', $msg)) {
  6542. return true;
  6543. } elseif (preg_match('/&[A-Z0-9]{1,6};/i', $msg)) {
  6544. // TODO If content is 'A link https://aaa?param=abc&amp;param2=def', it return true but must be false
  6545. return true; // Html entities names (http://www.w3schools.com/tags/ref_entities.asp)
  6546. } elseif (preg_match('/&#[0-9]{2,3};/i', $msg)) {
  6547. return true; // Html entities numbers (http://www.w3schools.com/tags/ref_entities.asp)
  6548. }
  6549. return false;
  6550. }
  6551. }
  6552. /**
  6553. * Concat 2 descriptions with a new line between them (second operand after first one with appropriate new line separator)
  6554. * text1 html + text2 html => text1 + '<br>' + text2
  6555. * text1 html + text2 txt => text1 + '<br>' + dol_nl2br(text2)
  6556. * text1 txt + text2 html => dol_nl2br(text1) + '<br>' + text2
  6557. * text1 txt + text2 txt => text1 + '\n' + text2
  6558. *
  6559. * @param string $text1 Text 1
  6560. * @param string $text2 Text 2
  6561. * @param bool $forxml true=Use <br /> instead of <br> if we have to add a br tag
  6562. * @param bool $invert invert order of description lines (we often use config MAIN_CHANGE_ORDER_CONCAT_DESCRIPTION in this parameter)
  6563. * @return string Text 1 + new line + Text2
  6564. * @see dol_textishtml()
  6565. */
  6566. function dol_concatdesc($text1, $text2, $forxml = false, $invert = false)
  6567. {
  6568. if (!empty($invert)) {
  6569. $tmp = $text1;
  6570. $text1 = $text2;
  6571. $text2 = $tmp;
  6572. }
  6573. $ret = '';
  6574. $ret .= (!dol_textishtml($text1) && dol_textishtml($text2)) ? dol_nl2br(dol_escape_htmltag($text1, 0, 1, '', 1), 0, $forxml) : $text1;
  6575. $ret .= (!empty($text1) && !empty($text2)) ? ((dol_textishtml($text1) || dol_textishtml($text2)) ? ($forxml ? "<br \>\n" : "<br>\n") : "\n") : "";
  6576. $ret .= (dol_textishtml($text1) && !dol_textishtml($text2)) ? dol_nl2br(dol_escape_htmltag($text2, 0, 1, '', 1), 0, $forxml) : $text2;
  6577. return $ret;
  6578. }
  6579. /**
  6580. * Return array of possible common substitutions. This includes several families like: 'system', 'mycompany', 'object', 'objectamount', 'date', 'user'
  6581. *
  6582. * @param Translate $outputlangs Output language
  6583. * @param int $onlykey 1=Do not calculate some heavy values of keys (performance enhancement when we need only the keys), 2=Values are trunc and html sanitized (to use for help tooltip)
  6584. * @param array $exclude Array of family keys we want to exclude. For example array('system', 'mycompany', 'object', 'objectamount', 'date', 'user', ...)
  6585. * @param Object $object Object for keys on object
  6586. * @return array Array of substitutions
  6587. * @see setSubstitFromObject()
  6588. */
  6589. function getCommonSubstitutionArray($outputlangs, $onlykey = 0, $exclude = null, $object = null)
  6590. {
  6591. global $db, $conf, $mysoc, $user, $extrafields;
  6592. $substitutionarray = array();
  6593. if (empty($exclude) || !in_array('user', $exclude)) {
  6594. // Add SIGNATURE into substitutionarray first, so, when we will make the substitution,
  6595. // this will include signature content first and then replace var found into content of signature
  6596. $signature = $user->signature;
  6597. $substitutionarray = array_merge($substitutionarray, array(
  6598. '__USER_SIGNATURE__' => (string) (($signature && empty($conf->global->MAIN_MAIL_DO_NOT_USE_SIGN)) ? ($onlykey == 2 ? dol_trunc(dol_string_nohtmltag($signature), 30) : $signature) : '')
  6599. ));
  6600. if (is_object($user)) {
  6601. $substitutionarray = array_merge($substitutionarray, array(
  6602. '__USER_ID__' => (string) $user->id,
  6603. '__USER_LOGIN__' => (string) $user->login,
  6604. '__USER_EMAIL__' => (string) $user->email,
  6605. '__USER_PHONE__' => (string) dol_print_phone($user->office_phone),
  6606. '__USER_PHONEPRO__' => (string) dol_print_phone($user->user_mobile),
  6607. '__USER_PHONEMOBILE__' => (string) dol_print_phone($user->personal_mobile),
  6608. '__USER_FAX__' => (string) $user->office_fax,
  6609. '__USER_LASTNAME__' => (string) $user->lastname,
  6610. '__USER_FIRSTNAME__' => (string) $user->firstname,
  6611. '__USER_FULLNAME__' => (string) $user->getFullName($outputlangs),
  6612. '__USER_SUPERVISOR_ID__' => (string) ($user->fk_user ? $user->fk_user : '0'),
  6613. '__USER_JOB__' => (string) $user->job,
  6614. '__USER_REMOTE_IP__' => (string) getUserRemoteIP()
  6615. ));
  6616. }
  6617. }
  6618. if ((empty($exclude) || !in_array('mycompany', $exclude)) && is_object($mysoc)) {
  6619. $substitutionarray = array_merge($substitutionarray, array(
  6620. '__MYCOMPANY_NAME__' => $mysoc->name,
  6621. '__MYCOMPANY_EMAIL__' => $mysoc->email,
  6622. '__MYCOMPANY_PHONE__' => dol_print_phone($mysoc->phone),
  6623. '__MYCOMPANY_FAX__' => dol_print_phone($mysoc->fax),
  6624. '__MYCOMPANY_PROFID1__' => $mysoc->idprof1,
  6625. '__MYCOMPANY_PROFID2__' => $mysoc->idprof2,
  6626. '__MYCOMPANY_PROFID3__' => $mysoc->idprof3,
  6627. '__MYCOMPANY_PROFID4__' => $mysoc->idprof4,
  6628. '__MYCOMPANY_PROFID5__' => $mysoc->idprof5,
  6629. '__MYCOMPANY_PROFID6__' => $mysoc->idprof6,
  6630. '__MYCOMPANY_CAPITAL__' => $mysoc->capital,
  6631. '__MYCOMPANY_FULLADDRESS__' => (method_exists($mysoc, 'getFullAddress') ? $mysoc->getFullAddress(1, ', ') : ''), // $mysoc may be stdClass
  6632. '__MYCOMPANY_ADDRESS__' => $mysoc->address,
  6633. '__MYCOMPANY_ZIP__' => $mysoc->zip,
  6634. '__MYCOMPANY_TOWN__' => $mysoc->town,
  6635. '__MYCOMPANY_COUNTRY__' => $mysoc->country,
  6636. '__MYCOMPANY_COUNTRY_ID__' => $mysoc->country_id,
  6637. '__MYCOMPANY_COUNTRY_CODE__' => $mysoc->country_code,
  6638. '__MYCOMPANY_CURRENCY_CODE__' => $conf->currency
  6639. ));
  6640. }
  6641. if (($onlykey || is_object($object)) && (empty($exclude) || !in_array('object', $exclude))) {
  6642. if ($onlykey) {
  6643. $substitutionarray['__ID__'] = '__ID__';
  6644. $substitutionarray['__REF__'] = '__REF__';
  6645. $substitutionarray['__NEWREF__'] = '__NEWREF__';
  6646. $substitutionarray['__REF_CLIENT__'] = '__REF_CLIENT__';
  6647. $substitutionarray['__REF_SUPPLIER__'] = '__REF_SUPPLIER__';
  6648. $substitutionarray['__NOTE_PUBLIC__'] = '__NOTE_PUBLIC__';
  6649. $substitutionarray['__NOTE_PRIVATE__'] = '__NOTE_PRIVATE__';
  6650. $substitutionarray['__EXTRAFIELD_XXX__'] = '__EXTRAFIELD_XXX__';
  6651. if (!empty($conf->societe->enabled)) { // Most objects are concerned
  6652. $substitutionarray['__THIRDPARTY_ID__'] = '__THIRDPARTY_ID__';
  6653. $substitutionarray['__THIRDPARTY_NAME__'] = '__THIRDPARTY_NAME__';
  6654. $substitutionarray['__THIRDPARTY_NAME_ALIAS__'] = '__THIRDPARTY_NAME_ALIAS__';
  6655. $substitutionarray['__THIRDPARTY_CODE_CLIENT__'] = '__THIRDPARTY_CODE_CLIENT__';
  6656. $substitutionarray['__THIRDPARTY_CODE_FOURNISSEUR__'] = '__THIRDPARTY_CODE_FOURNISSEUR__';
  6657. $substitutionarray['__THIRDPARTY_EMAIL__'] = '__THIRDPARTY_EMAIL__';
  6658. $substitutionarray['__THIRDPARTY_PHONE__'] = '__THIRDPARTY_PHONE__';
  6659. $substitutionarray['__THIRDPARTY_FAX__'] = '__THIRDPARTY_FAX__';
  6660. $substitutionarray['__THIRDPARTY_ADDRESS__'] = '__THIRDPARTY_ADDRESS__';
  6661. $substitutionarray['__THIRDPARTY_ZIP__'] = '__THIRDPARTY_ZIP__';
  6662. $substitutionarray['__THIRDPARTY_TOWN__'] = '__THIRDPARTY_TOWN__';
  6663. $substitutionarray['__THIRDPARTY_IDPROF1__'] = '__THIRDPARTY_IDPROF1__';
  6664. $substitutionarray['__THIRDPARTY_IDPROF2__'] = '__THIRDPARTY_IDPROF2__';
  6665. $substitutionarray['__THIRDPARTY_IDPROF3__'] = '__THIRDPARTY_IDPROF3__';
  6666. $substitutionarray['__THIRDPARTY_IDPROF4__'] = '__THIRDPARTY_IDPROF4__';
  6667. $substitutionarray['__THIRDPARTY_IDPROF5__'] = '__THIRDPARTY_IDPROF5__';
  6668. $substitutionarray['__THIRDPARTY_IDPROF6__'] = '__THIRDPARTY_IDPROF6__';
  6669. $substitutionarray['__THIRDPARTY_TVAINTRA__'] = '__THIRDPARTY_TVAINTRA__';
  6670. $substitutionarray['__THIRDPARTY_NOTE_PUBLIC__'] = '__THIRDPARTY_NOTE_PUBLIC__';
  6671. $substitutionarray['__THIRDPARTY_NOTE_PRIVATE__'] = '__THIRDPARTY_NOTE_PRIVATE__';
  6672. }
  6673. if (!empty($conf->adherent->enabled) && (!is_object($object) || $object->element == 'adherent')) {
  6674. $substitutionarray['__MEMBER_ID__'] = '__MEMBER_ID__';
  6675. $substitutionarray['__MEMBER_CIVILITY__'] = '__MEMBER_CIVILITY__';
  6676. $substitutionarray['__MEMBER_FIRSTNAME__'] = '__MEMBER_FIRSTNAME__';
  6677. $substitutionarray['__MEMBER_LASTNAME__'] = '__MEMBER_LASTNAME__';
  6678. $substitutionarray['__MEMBER_USER_LOGIN_INFORMATION__'] = 'Login and pass of the external user account';
  6679. /*$substitutionarray['__MEMBER_NOTE_PUBLIC__'] = '__MEMBER_NOTE_PUBLIC__';
  6680. $substitutionarray['__MEMBER_NOTE_PRIVATE__'] = '__MEMBER_NOTE_PRIVATE__';*/
  6681. }
  6682. // add variables subtitutions ticket
  6683. if (!empty($conf->ticket->enabled) && (!is_object($object) || $object->element == 'ticket')) {
  6684. $substitutionarray['__TICKET_TRACKID__'] = '__TICKET_TRACKID__';
  6685. $substitutionarray['__TICKET_SUBJECT__'] = '__TICKET_SUBJECT__';
  6686. $substitutionarray['__TICKET_TYPE__'] = '__TICKET_TYPE__';
  6687. $substitutionarray['__TICKET_SEVERITY__'] = '__TICKET_SEVERITY__';
  6688. $substitutionarray['__TICKET_CATEGORY__'] = '__TICKET_CATEGORY__';
  6689. $substitutionarray['__TICKET_ANALYTIC_CODE__'] = '__TICKET_ANALYTIC_CODE__';
  6690. $substitutionarray['__TICKET_MESSAGE__'] = '__TICKET_MESSAGE__';
  6691. $substitutionarray['__TICKET_PROGRESSION__'] = '__TICKET_PROGRESSION__';
  6692. $substitutionarray['__TICKET_USER_ASSIGN__'] = '__TICKET_USER_ASSIGN__';
  6693. }
  6694. if (!empty($conf->recruitment->enabled) && (!is_object($object) || $object->element == 'recruitmentcandidature')) {
  6695. $substitutionarray['__CANDIDATE_FULLNAME__'] = '__CANDIDATE_FULLNAME__';
  6696. $substitutionarray['__CANDIDATE_FIRSTNAME__'] = '__CANDIDATE_FIRSTNAME__';
  6697. $substitutionarray['__CANDIDATE_LASTNAME__'] = '__CANDIDATE_LASTNAME__';
  6698. }
  6699. if (!empty($conf->project->enabled)) { // Most objects
  6700. $substitutionarray['__PROJECT_ID__'] = '__PROJECT_ID__';
  6701. $substitutionarray['__PROJECT_REF__'] = '__PROJECT_REF__';
  6702. $substitutionarray['__PROJECT_NAME__'] = '__PROJECT_NAME__';
  6703. /*$substitutionarray['__PROJECT_NOTE_PUBLIC__'] = '__PROJECT_NOTE_PUBLIC__';
  6704. $substitutionarray['__PROJECT_NOTE_PRIVATE__'] = '__PROJECT_NOTE_PRIVATE__';*/
  6705. }
  6706. if (!empty($conf->contrat->enabled) && (!is_object($object) || $object->element == 'contract')) {
  6707. $substitutionarray['__CONTRACT_HIGHEST_PLANNED_START_DATE__'] = 'Highest date planned for a service start';
  6708. $substitutionarray['__CONTRACT_HIGHEST_PLANNED_START_DATETIME__'] = 'Highest date and hour planned for service start';
  6709. $substitutionarray['__CONTRACT_LOWEST_EXPIRATION_DATE__'] = 'Lowest data for planned expiration of service';
  6710. $substitutionarray['__CONTRACT_LOWEST_EXPIRATION_DATETIME__'] = 'Lowest date and hour for planned expiration of service';
  6711. }
  6712. $substitutionarray['__ONLINE_PAYMENT_URL__'] = 'UrlToPayOnlineIfApplicable';
  6713. $substitutionarray['__ONLINE_PAYMENT_TEXT_AND_URL__'] = 'TextAndUrlToPayOnlineIfApplicable';
  6714. $substitutionarray['__SECUREKEYPAYMENT__'] = 'Security key (if key is not unique per record)';
  6715. $substitutionarray['__SECUREKEYPAYMENT_MEMBER__'] = 'Security key for payment on a member subscription (one key per member)';
  6716. $substitutionarray['__SECUREKEYPAYMENT_ORDER__'] = 'Security key for payment on an order';
  6717. $substitutionarray['__SECUREKEYPAYMENT_INVOICE__'] = 'Security key for payment on an invoice';
  6718. $substitutionarray['__SECUREKEYPAYMENT_CONTRACTLINE__'] = 'Security key for payment on a service of a contract';
  6719. $substitutionarray['__DIRECTDOWNLOAD_URL_PROPOSAL__'] = 'Direct download url of a proposal';
  6720. $substitutionarray['__DIRECTDOWNLOAD_URL_ORDER__'] = 'Direct download url of an order';
  6721. $substitutionarray['__DIRECTDOWNLOAD_URL_INVOICE__'] = 'Direct download url of an invoice';
  6722. $substitutionarray['__DIRECTDOWNLOAD_URL_CONTRACT__'] = 'Direct download url of a contract';
  6723. $substitutionarray['__DIRECTDOWNLOAD_URL_SUPPLIER_PROPOSAL__'] = 'Direct download url of a supplier proposal';
  6724. if (!empty($conf->expedition->enabled) && (!is_object($object) || $object->element == 'shipping')) {
  6725. $substitutionarray['__SHIPPINGTRACKNUM__'] = 'Shipping tracking number';
  6726. $substitutionarray['__SHIPPINGTRACKNUMURL__'] = 'Shipping tracking url';
  6727. }
  6728. if (!empty($conf->reception->enabled) && (!is_object($object) || $object->element == 'reception')) {
  6729. $substitutionarray['__RECEPTIONTRACKNUM__'] = 'Shippin tracking number of shipment';
  6730. $substitutionarray['__RECEPTIONTRACKNUMURL__'] = 'Shipping tracking url';
  6731. }
  6732. } else {
  6733. $substitutionarray['__ID__'] = $object->id;
  6734. $substitutionarray['__REF__'] = $object->ref;
  6735. $substitutionarray['__NEWREF__'] = $object->newref;
  6736. $substitutionarray['__REF_CLIENT__'] = (isset($object->ref_client) ? $object->ref_client : (isset($object->ref_customer) ? $object->ref_customer : null));
  6737. $substitutionarray['__REF_SUPPLIER__'] = (isset($object->ref_supplier) ? $object->ref_supplier : null);
  6738. $substitutionarray['__NOTE_PUBLIC__'] = (isset($object->note_public) ? $object->note_public : null);
  6739. $substitutionarray['__NOTE_PRIVATE__'] = (isset($object->note_private) ? $object->note_private : null);
  6740. if ($object->element == "shipping") {
  6741. $substitutionarray['__DATE_DELIVERY__'] = (isset($object->date_delivery) ? dol_print_date($object->date_delivery, 'day', 0, $outputlangs) : '');
  6742. } else {
  6743. $substitutionarray['__DATE_DELIVERY__'] = (isset($object->date_livraison) ? dol_print_date($object->date_livraison, 'day', 0, $outputlangs) : '');
  6744. }
  6745. $substitutionarray['__DATE_DELIVERY_DAY__'] = (isset($object->date_livraison) ? dol_print_date($object->date_livraison, "%d") : '');
  6746. $substitutionarray['__DATE_DELIVERY_DAY_TEXT__'] = (isset($object->date_livraison) ? dol_print_date($object->date_livraison, "%A") : '');
  6747. $substitutionarray['__DATE_DELIVERY_MON__'] = (isset($object->date_livraison) ? dol_print_date($object->date_livraison, "%m") : '');
  6748. $substitutionarray['__DATE_DELIVERY_MON_TEXT__'] = (isset($object->date_livraison) ? dol_print_date($object->date_livraison, "%b") : '');
  6749. $substitutionarray['__DATE_DELIVERY_YEAR__'] = (isset($object->date_livraison) ? dol_print_date($object->date_livraison, "%Y") : '');
  6750. $substitutionarray['__DATE_DELIVERY_HH__'] = (isset($object->date_livraison) ? dol_print_date($object->date_livraison, "%H") : '');
  6751. $substitutionarray['__DATE_DELIVERY_MM__'] = (isset($object->date_livraison) ? dol_print_date($object->date_livraison, "%M") : '');
  6752. $substitutionarray['__DATE_DELIVERY_SS__'] = (isset($object->date_livraison) ? dol_print_date($object->date_livraison, "%S") : '');
  6753. // For backward compatibility
  6754. $substitutionarray['__REFCLIENT__'] = (isset($object->ref_client) ? $object->ref_client : (isset($object->ref_customer) ? $object->ref_customer : null));
  6755. $substitutionarray['__REFSUPPLIER__'] = (isset($object->ref_supplier) ? $object->ref_supplier : null);
  6756. $substitutionarray['__SUPPLIER_ORDER_DATE_DELIVERY__'] = (isset($object->date_livraison) ? dol_print_date($object->date_livraison, 'day', 0, $outputlangs) : '');
  6757. $substitutionarray['__SUPPLIER_ORDER_DELAY_DELIVERY__'] = (isset($object->availability_code) ? ($outputlangs->transnoentities("AvailabilityType".$object->availability_code) != ('AvailabilityType'.$object->availability_code) ? $outputlangs->transnoentities("AvailabilityType".$object->availability_code) : $outputlangs->convToOutputCharset(isset($object->availability) ? $object->availability : '')) : '');
  6758. if (is_object($object) && ($object->element == 'adherent' || $object->element == 'member') && $object->id > 0) {
  6759. $birthday = (empty($object->birth) ? '' : dol_print_date($object->birth, 'day'));
  6760. $substitutionarray['__MEMBER_ID__'] = (isset($object->id) ? $object->id : '');
  6761. if (method_exists($object, 'getCivilityLabel')) {
  6762. $substitutionarray['__MEMBER_CIVILITY__'] = $object->getCivilityLabel();
  6763. }
  6764. $substitutionarray['__MEMBER_FIRSTNAME__'] = (isset($object->firstname) ? $object->firstname : '');
  6765. $substitutionarray['__MEMBER_LASTNAME__'] = (isset($object->lastname) ? $object->lastname : '');
  6766. $substitutionarray['__MEMBER_USER_LOGIN_INFORMATION__'] = '';
  6767. if (method_exists($object, 'getFullName')) {
  6768. $substitutionarray['__MEMBER_FULLNAME__'] = $object->getFullName($outputlangs);
  6769. }
  6770. $substitutionarray['__MEMBER_COMPANY__'] = (isset($object->societe) ? $object->societe : '');
  6771. $substitutionarray['__MEMBER_ADDRESS__'] = (isset($object->address) ? $object->address : '');
  6772. $substitutionarray['__MEMBER_ZIP__'] = (isset($object->zip) ? $object->zip : '');
  6773. $substitutionarray['__MEMBER_TOWN__'] = (isset($object->town) ? $object->town : '');
  6774. $substitutionarray['__MEMBER_COUNTRY__'] = (isset($object->country) ? $object->country : '');
  6775. $substitutionarray['__MEMBER_EMAIL__'] = (isset($object->email) ? $object->email : '');
  6776. $substitutionarray['__MEMBER_BIRTH__'] = (isset($birthday) ? $birthday : '');
  6777. $substitutionarray['__MEMBER_PHOTO__'] = (isset($object->photo) ? $object->photo : '');
  6778. $substitutionarray['__MEMBER_LOGIN__'] = (isset($object->login) ? $object->login : '');
  6779. $substitutionarray['__MEMBER_PASSWORD__'] = (isset($object->pass) ? $object->pass : '');
  6780. $substitutionarray['__MEMBER_PHONE__'] = (isset($object->phone) ? dol_print_phone($object->phone) : '');
  6781. $substitutionarray['__MEMBER_PHONEPRO__'] = (isset($object->phone_perso) ? dol_print_phone($object->phone_perso) : '');
  6782. $substitutionarray['__MEMBER_PHONEMOBILE__'] = (isset($object->phone_mobile) ? dol_print_phone($object->phone_mobile) : '');
  6783. $substitutionarray['__MEMBER_TYPE__'] = (isset($object->type) ? $object->type : '');
  6784. $substitutionarray['__MEMBER_FIRST_SUBSCRIPTION_DATE__'] = dol_print_date($object->first_subscription_date, 'dayrfc');
  6785. $substitutionarray['__MEMBER_FIRST_SUBSCRIPTION_DATE_START__'] = (isset($object->first_subscription_date_start) ? dol_print_date($object->first_subscription_date_start, 'dayrfc') : '');
  6786. $substitutionarray['__MEMBER_FIRST_SUBSCRIPTION_DATE_END__'] = (isset($object->first_subscription_date_end) ? dol_print_date($object->first_subscription_date_end, 'dayrfc') : '');
  6787. $substitutionarray['__MEMBER_LAST_SUBSCRIPTION_DATE__'] = dol_print_date($object->last_subscription_date, 'dayrfc');
  6788. $substitutionarray['__MEMBER_LAST_SUBSCRIPTION_DATE_START__'] = dol_print_date($object->last_subscription_date_start, 'dayrfc');
  6789. $substitutionarray['__MEMBER_LAST_SUBSCRIPTION_DATE_END__'] = dol_print_date($object->last_subscription_date_end, 'dayrfc');
  6790. }
  6791. if (is_object($object) && $object->element == 'societe') {
  6792. $substitutionarray['__THIRDPARTY_ID__'] = (is_object($object) ? $object->id : '');
  6793. $substitutionarray['__THIRDPARTY_NAME__'] = (is_object($object) ? $object->name : '');
  6794. $substitutionarray['__THIRDPARTY_NAME_ALIAS__'] = (is_object($object) ? $object->name_alias : '');
  6795. $substitutionarray['__THIRDPARTY_CODE_CLIENT__'] = (is_object($object) ? $object->code_client : '');
  6796. $substitutionarray['__THIRDPARTY_CODE_FOURNISSEUR__'] = (is_object($object) ? $object->code_fournisseur : '');
  6797. $substitutionarray['__THIRDPARTY_EMAIL__'] = (is_object($object) ? $object->email : '');
  6798. $substitutionarray['__THIRDPARTY_PHONE__'] = (is_object($object) ? dol_print_phone($object->phone) : '');
  6799. $substitutionarray['__THIRDPARTY_FAX__'] = (is_object($object) ? dol_print_phone($object->fax) : '');
  6800. $substitutionarray['__THIRDPARTY_ADDRESS__'] = (is_object($object) ? $object->address : '');
  6801. $substitutionarray['__THIRDPARTY_ZIP__'] = (is_object($object) ? $object->zip : '');
  6802. $substitutionarray['__THIRDPARTY_TOWN__'] = (is_object($object) ? $object->town : '');
  6803. $substitutionarray['__THIRDPARTY_COUNTRY_ID__'] = (is_object($object) ? $object->country_id : '');
  6804. $substitutionarray['__THIRDPARTY_COUNTRY_CODE__'] = (is_object($object) ? $object->country_code : '');
  6805. $substitutionarray['__THIRDPARTY_IDPROF1__'] = (is_object($object) ? $object->idprof1 : '');
  6806. $substitutionarray['__THIRDPARTY_IDPROF2__'] = (is_object($object) ? $object->idprof2 : '');
  6807. $substitutionarray['__THIRDPARTY_IDPROF3__'] = (is_object($object) ? $object->idprof3 : '');
  6808. $substitutionarray['__THIRDPARTY_IDPROF4__'] = (is_object($object) ? $object->idprof4 : '');
  6809. $substitutionarray['__THIRDPARTY_IDPROF5__'] = (is_object($object) ? $object->idprof5 : '');
  6810. $substitutionarray['__THIRDPARTY_IDPROF6__'] = (is_object($object) ? $object->idprof6 : '');
  6811. $substitutionarray['__THIRDPARTY_TVAINTRA__'] = (is_object($object) ? $object->tva_intra : '');
  6812. $substitutionarray['__THIRDPARTY_NOTE_PUBLIC__'] = (is_object($object) ? dol_htmlentitiesbr($object->note_public) : '');
  6813. $substitutionarray['__THIRDPARTY_NOTE_PRIVATE__'] = (is_object($object) ? dol_htmlentitiesbr($object->note_private) : '');
  6814. } elseif (is_object($object->thirdparty)) {
  6815. $substitutionarray['__THIRDPARTY_ID__'] = (is_object($object->thirdparty) ? $object->thirdparty->id : '');
  6816. $substitutionarray['__THIRDPARTY_NAME__'] = (is_object($object->thirdparty) ? $object->thirdparty->name : '');
  6817. $substitutionarray['__THIRDPARTY_NAME_ALIAS__'] = (is_object($object->thirdparty) ? $object->thirdparty->name_alias : '');
  6818. $substitutionarray['__THIRDPARTY_CODE_CLIENT__'] = (is_object($object->thirdparty) ? $object->thirdparty->code_client : '');
  6819. $substitutionarray['__THIRDPARTY_CODE_FOURNISSEUR__'] = (is_object($object->thirdparty) ? $object->thirdparty->code_fournisseur : '');
  6820. $substitutionarray['__THIRDPARTY_EMAIL__'] = (is_object($object->thirdparty) ? $object->thirdparty->email : '');
  6821. $substitutionarray['__THIRDPARTY_PHONE__'] = (is_object($object->thirdparty) ? dol_print_phone($object->thirdparty->phone) : '');
  6822. $substitutionarray['__THIRDPARTY_FAX__'] = (is_object($object->thirdparty) ? dol_print_phone($object->thirdparty->fax) : '');
  6823. $substitutionarray['__THIRDPARTY_ADDRESS__'] = (is_object($object->thirdparty) ? $object->thirdparty->address : '');
  6824. $substitutionarray['__THIRDPARTY_ZIP__'] = (is_object($object->thirdparty) ? $object->thirdparty->zip : '');
  6825. $substitutionarray['__THIRDPARTY_TOWN__'] = (is_object($object->thirdparty) ? $object->thirdparty->town : '');
  6826. $substitutionarray['__THIRDPARTY_COUNTRY_ID__'] = (is_object($object->thirdparty) ? $object->thirdparty->country_id : '');
  6827. $substitutionarray['__THIRDPARTY_COUNTRY_CODE__'] = (is_object($object->thirdparty) ? $object->thirdparty->country_code : '');
  6828. $substitutionarray['__THIRDPARTY_IDPROF1__'] = (is_object($object->thirdparty) ? $object->thirdparty->idprof1 : '');
  6829. $substitutionarray['__THIRDPARTY_IDPROF2__'] = (is_object($object->thirdparty) ? $object->thirdparty->idprof2 : '');
  6830. $substitutionarray['__THIRDPARTY_IDPROF3__'] = (is_object($object->thirdparty) ? $object->thirdparty->idprof3 : '');
  6831. $substitutionarray['__THIRDPARTY_IDPROF4__'] = (is_object($object->thirdparty) ? $object->thirdparty->idprof4 : '');
  6832. $substitutionarray['__THIRDPARTY_IDPROF5__'] = (is_object($object->thirdparty) ? $object->thirdparty->idprof5 : '');
  6833. $substitutionarray['__THIRDPARTY_IDPROF6__'] = (is_object($object->thirdparty) ? $object->thirdparty->idprof6 : '');
  6834. $substitutionarray['__THIRDPARTY_TVAINTRA__'] = (is_object($object->thirdparty) ? $object->thirdparty->tva_intra : '');
  6835. $substitutionarray['__THIRDPARTY_NOTE_PUBLIC__'] = (is_object($object->thirdparty) ? dol_htmlentitiesbr($object->thirdparty->note_public) : '');
  6836. $substitutionarray['__THIRDPARTY_NOTE_PRIVATE__'] = (is_object($object->thirdparty) ? dol_htmlentitiesbr($object->thirdparty->note_private) : '');
  6837. }
  6838. if (is_object($object) && $object->element == 'recruitmentcandidature') {
  6839. $substitutionarray['__CANDIDATE_FULLNAME__'] = $object->getFullName($outputlangs);
  6840. $substitutionarray['__CANDIDATE_FIRSTNAME__'] = isset($object->firstname) ? $object->firstname : '';
  6841. $substitutionarray['__CANDIDATE_LASTNAME__'] = isset($object->lastname) ? $object->lastname : '';
  6842. }
  6843. if (is_object($object->project)) {
  6844. $substitutionarray['__PROJECT_ID__'] = (is_object($object->project) ? $object->project->id : '');
  6845. $substitutionarray['__PROJECT_REF__'] = (is_object($object->project) ? $object->project->ref : '');
  6846. $substitutionarray['__PROJECT_NAME__'] = (is_object($object->project) ? $object->project->title : '');
  6847. }
  6848. if (is_object($object->projet)) { // Deprecated, for backward compatibility
  6849. $substitutionarray['__PROJECT_ID__'] = (is_object($object->projet) ? $object->projet->id : '');
  6850. $substitutionarray['__PROJECT_REF__'] = (is_object($object->projet) ? $object->projet->ref : '');
  6851. $substitutionarray['__PROJECT_NAME__'] = (is_object($object->projet) ? $object->projet->title : '');
  6852. }
  6853. if (is_object($object) && $object->element == 'project') {
  6854. $substitutionarray['__PROJECT_NAME__'] = $object->title;
  6855. }
  6856. if (is_object($object) && $object->element == 'shipping') {
  6857. $substitutionarray['__SHIPPINGTRACKNUM__'] = $object->tracking_number;
  6858. $substitutionarray['__SHIPPINGTRACKNUMURL__'] = $object->tracking_url;
  6859. }
  6860. if (is_object($object) && $object->element == 'reception') {
  6861. $substitutionarray['__RECEPTIONTRACKNUM__'] = $object->tracking_number;
  6862. $substitutionarray['__RECEPTIONTRACKNUMURL__'] = $object->tracking_url;
  6863. }
  6864. if (is_object($object) && $object->element == 'contrat' && $object->id > 0 && is_array($object->lines)) {
  6865. $dateplannedstart = '';
  6866. $datenextexpiration = '';
  6867. foreach ($object->lines as $line) {
  6868. if ($line->date_ouverture_prevue > $dateplannedstart) {
  6869. $dateplannedstart = $line->date_ouverture_prevue;
  6870. }
  6871. if ($line->statut == 4 && $line->date_fin_prevue && (!$datenextexpiration || $line->date_fin_prevue < $datenextexpiration)) {
  6872. $datenextexpiration = $line->date_fin_prevue;
  6873. }
  6874. }
  6875. $substitutionarray['__CONTRACT_HIGHEST_PLANNED_START_DATE__'] = dol_print_date($dateplannedstart, 'dayrfc');
  6876. $substitutionarray['__CONTRACT_HIGHEST_PLANNED_START_DATETIME__'] = dol_print_date($dateplannedstart, 'standard');
  6877. $substitutionarray['__CONTRACT_LOWEST_EXPIRATION_DATE__'] = dol_print_date($datenextexpiration, 'dayrfc');
  6878. $substitutionarray['__CONTRACT_LOWEST_EXPIRATION_DATETIME__'] = dol_print_date($datenextexpiration, 'standard');
  6879. }
  6880. // add substition variable for ticket
  6881. if (is_object($object) && $object->element == 'ticket') {
  6882. $substitutionarray['__TICKET_TRACKID__'] = $object->track_id;
  6883. $substitutionarray['__REF__'] = $object->ref;
  6884. $substitutionarray['__TICKET_SUBJECT__'] = $object->subject;
  6885. $substitutionarray['__TICKET_TYPE__'] = $object->type_code;
  6886. $substitutionarray['__TICKET_SEVERITY__'] = $object->severity_code;
  6887. $substitutionarray['__TICKET_CATEGORY__'] = $object->category_code; // For backward compatibility
  6888. $substitutionarray['__TICKET_ANALYTIC_CODE__'] = $object->category_code;
  6889. $substitutionarray['__TICKET_MESSAGE__'] = $object->message;
  6890. $substitutionarray['__TICKET_PROGRESSION__'] = $object->progress;
  6891. $userstat = new User($db);
  6892. if ($object->fk_user_assign > 0) {
  6893. $userstat->fetch($object->fk_user_assign);
  6894. $substitutionarray['__TICKET_USER_ASSIGN__'] = dolGetFirstLastname($userstat->firstname, $userstat->lastname);
  6895. }
  6896. if ($object->fk_user_create > 0) {
  6897. $userstat->fetch($object->fk_user_create);
  6898. $substitutionarray['__USER_CREATE__'] = dolGetFirstLastname($userstat->firstname, $userstat->lastname);
  6899. }
  6900. }
  6901. // Create dynamic tags for __EXTRAFIELD_FIELD__
  6902. if ($object->table_element && $object->id > 0) {
  6903. if (!is_object($extrafields)) {
  6904. $extrafields = new ExtraFields($db);
  6905. }
  6906. $extrafields->fetch_name_optionals_label($object->table_element, true);
  6907. if ($object->fetch_optionals() > 0) {
  6908. if (is_array($extrafields->attributes[$object->table_element]['label']) && count($extrafields->attributes[$object->table_element]['label']) > 0) {
  6909. foreach ($extrafields->attributes[$object->table_element]['label'] as $key => $label) {
  6910. $substitutionarray['__EXTRAFIELD_'.strtoupper($key).'__'] = $object->array_options['options_'.$key];
  6911. if ($extrafields->attributes[$object->table_element]['type'][$key] == 'date') {
  6912. $substitutionarray['__EXTRAFIELD_'.strtoupper($key).'__'] = dol_print_date($object->array_options['options_'.$key], 'day');
  6913. $substitutionarray['__EXTRAFIELD_'.strtoupper($key).'_LOCALE__'] = dol_print_date($object->array_options['options_'.$key], 'day', 'tzserver', $outputlangs);
  6914. $substitutionarray['__EXTRAFIELD_'.strtoupper($key).'_RFC__'] = dol_print_date($object->array_options['options_'.$key], 'dayrfc');
  6915. } elseif ($extrafields->attributes[$object->table_element]['type'][$key] == 'datetime') {
  6916. $datetime = $object->array_options['options_'.$key];
  6917. $substitutionarray['__EXTRAFIELD_'.strtoupper($key).'__'] = ($datetime != "0000-00-00 00:00:00" ? dol_print_date($datetime, 'dayhour') : '');
  6918. $substitutionarray['__EXTRAFIELD_'.strtoupper($key).'_LOCALE__'] = ($datetime != "0000-00-00 00:00:00" ? dol_print_date($datetime, 'dayhour', 'tzserver', $outputlangs) : '');
  6919. $substitutionarray['__EXTRAFIELD_'.strtoupper($key).'_DAY_LOCALE__'] = ($datetime != "0000-00-00 00:00:00" ? dol_print_date($datetime, 'day', 'tzserver', $outputlangs) : '');
  6920. $substitutionarray['__EXTRAFIELD_'.strtoupper($key).'_RFC__'] = ($datetime != "0000-00-00 00:00:00" ? dol_print_date($datetime, 'dayhourrfc') : '');
  6921. } elseif ($extrafields->attributes[$object->table_element]['type'][$key] == 'phone') {
  6922. $substitutionarray['__EXTRAFIELD_'.strtoupper($key).'__'] = dol_print_phone($object->array_options['options_'.$key]);
  6923. } elseif ($extrafields->attributes[$object->table_element]['type'][$key] == 'price') {
  6924. $substitutionarray['__EXTRAFIELD_'.strtoupper($key).'__'] = $object->array_options['options_'.$key];
  6925. $substitutionarray['__EXTRAFIELD_'.strtoupper($key).'_FORMATED__'] = price($object->array_options['options_'.$key]);
  6926. }
  6927. }
  6928. }
  6929. }
  6930. }
  6931. // Complete substitution array with the url to make online payment
  6932. $paymenturl = '';
  6933. if (empty($substitutionarray['__REF__'])) {
  6934. $paymenturl = '';
  6935. } else {
  6936. // Set the online payment url link into __ONLINE_PAYMENT_URL__ key
  6937. require_once DOL_DOCUMENT_ROOT.'/core/lib/payments.lib.php';
  6938. $outputlangs->loadLangs(array('paypal', 'other'));
  6939. $typeforonlinepayment = 'free';
  6940. if (is_object($object) && $object->element == 'propal') {
  6941. $typeforonlinepayment = 'propal';
  6942. }
  6943. if (is_object($object) && $object->element == 'commande') {
  6944. $typeforonlinepayment = 'order';
  6945. }
  6946. if (is_object($object) && $object->element == 'facture') {
  6947. $typeforonlinepayment = 'invoice';
  6948. }
  6949. if (is_object($object) && $object->element == 'member') {
  6950. $typeforonlinepayment = 'member';
  6951. }
  6952. if (is_object($object) && $object->element == 'contrat') {
  6953. $typeforonlinepayment = 'contract';
  6954. }
  6955. $url = getOnlinePaymentUrl(0, $typeforonlinepayment, $substitutionarray['__REF__']);
  6956. $paymenturl = $url;
  6957. }
  6958. if ($object->id > 0) {
  6959. $substitutionarray['__ONLINE_PAYMENT_TEXT_AND_URL__'] = ($paymenturl ?str_replace('\n', "\n", $outputlangs->trans("PredefinedMailContentLink", $paymenturl)) : '');
  6960. $substitutionarray['__ONLINE_PAYMENT_URL__'] = $paymenturl;
  6961. if (is_object($object) && $object->element == 'propal') {
  6962. require_once DOL_DOCUMENT_ROOT.'/core/lib/signature.lib.php';
  6963. $substitutionarray['__ONLINE_SIGN_URL__'] = getOnlineSignatureUrl(0, 'proposal', $object->ref);
  6964. }
  6965. if (!empty($conf->global->PROPOSAL_ALLOW_EXTERNAL_DOWNLOAD) && is_object($object) && $object->element == 'propal') {
  6966. $substitutionarray['__DIRECTDOWNLOAD_URL_PROPOSAL__'] = $object->getLastMainDocLink($object->element);
  6967. } else {
  6968. $substitutionarray['__DIRECTDOWNLOAD_URL_PROPOSAL__'] = '';
  6969. }
  6970. if (!empty($conf->global->ORDER_ALLOW_EXTERNAL_DOWNLOAD) && is_object($object) && $object->element == 'commande') {
  6971. $substitutionarray['__DIRECTDOWNLOAD_URL_ORDER__'] = $object->getLastMainDocLink($object->element);
  6972. } else {
  6973. $substitutionarray['__DIRECTDOWNLOAD_URL_ORDER__'] = '';
  6974. }
  6975. if (!empty($conf->global->INVOICE_ALLOW_EXTERNAL_DOWNLOAD) && is_object($object) && $object->element == 'facture') {
  6976. $substitutionarray['__DIRECTDOWNLOAD_URL_INVOICE__'] = $object->getLastMainDocLink($object->element);
  6977. } else {
  6978. $substitutionarray['__DIRECTDOWNLOAD_URL_INVOICE__'] = '';
  6979. }
  6980. if (!empty($conf->global->CONTRACT_ALLOW_EXTERNAL_DOWNLOAD) && is_object($object) && $object->element == 'contrat') {
  6981. $substitutionarray['__DIRECTDOWNLOAD_URL_CONTRACT__'] = $object->getLastMainDocLink($object->element);
  6982. } else {
  6983. $substitutionarray['__DIRECTDOWNLOAD_URL_CONTRACT__'] = '';
  6984. }
  6985. if (!empty($conf->global->SUPPLIER_PROPOSAL_ALLOW_EXTERNAL_DOWNLOAD) && is_object($object) && $object->element == 'supplier_proposal') {
  6986. $substitutionarray['__DIRECTDOWNLOAD_URL_SUPPLIER_PROPOSAL__'] = $object->getLastMainDocLink($object->element);
  6987. } else {
  6988. $substitutionarray['__DIRECTDOWNLOAD_URL_SUPPLIER_PROPOSAL__'] = '';
  6989. }
  6990. if (is_object($object) && $object->element == 'propal') {
  6991. $substitutionarray['__URL_PROPOSAL__'] = DOL_MAIN_URL_ROOT."/comm/propal/card.php?id=".$object->id;
  6992. }
  6993. if (is_object($object) && $object->element == 'commande') {
  6994. $substitutionarray['__URL_ORDER__'] = DOL_MAIN_URL_ROOT."/commande/card.php?id=".$object->id;
  6995. }
  6996. if (is_object($object) && $object->element == 'facture') {
  6997. $substitutionarray['__URL_INVOICE__'] = DOL_MAIN_URL_ROOT."/compta/facture/card.php?id=".$object->id;
  6998. }
  6999. if (is_object($object) && $object->element == 'contrat') {
  7000. $substitutionarray['__URL_CONTRACT__'] = DOL_MAIN_URL_ROOT."/contrat/card.php?id=".$object->id;
  7001. }
  7002. if (is_object($object) && $object->element == 'supplier_proposal') {
  7003. $substitutionarray['__URL_SUPPLIER_PROPOSAL__'] = DOL_MAIN_URL_ROOT."/supplier_proposal/card.php?id=".$object->id;
  7004. }
  7005. if (is_object($object) && $object->element == 'shipping') {
  7006. $substitutionarray['__URL_SHIPMENT__'] = DOL_MAIN_URL_ROOT."/expedition/card.php?id=".$object->id;
  7007. }
  7008. }
  7009. if (is_object($object) && $object->element == 'action') {
  7010. $substitutionarray['__EVENT_LABEL__'] = $object->label;
  7011. $substitutionarray['__EVENT_DATE__'] = dol_print_date($object->datep, '%A %d %b %Y');
  7012. $substitutionarray['__EVENT_TIME__'] = dol_print_date($object->datep, '%H:%M:%S');
  7013. }
  7014. }
  7015. }
  7016. if (empty($exclude) || !in_array('objectamount', $exclude)) {
  7017. include_once DOL_DOCUMENT_ROOT.'/core/lib/functionsnumtoword.lib.php';
  7018. $substitutionarray['__DATE_YMD__'] = is_object($object) ? (isset($object->date) ? dol_print_date($object->date, 'day', 0, $outputlangs) : null) : '';
  7019. $substitutionarray['__DATE_DUE_YMD__'] = is_object($object) ? (isset($object->date_lim_reglement) ? dol_print_date($object->date_lim_reglement, 'day', 0, $outputlangs) : null) : '';
  7020. $already_payed_all = 0;
  7021. if (is_object($object) && ($object instanceof Facture)) {
  7022. $already_payed_all = $object->sumpayed + $object->sumdeposit + $object->sumcreditnote;
  7023. }
  7024. $substitutionarray['__AMOUNT_EXCL_TAX__'] = is_object($object) ? $object->total_ht : '';
  7025. $substitutionarray['__AMOUNT__'] = is_object($object) ? $object->total_ttc : '';
  7026. $substitutionarray['__AMOUNT_TEXT__'] = is_object($object) ? dol_convertToWord($object->total_ttc, $outputlangs, '', true) : '';
  7027. $substitutionarray['__AMOUNT_TEXTCURRENCY__'] = is_object($object) ? dol_convertToWord($object->total_ttc, $outputlangs, $conf->currency, true) : '';
  7028. $substitutionarray['__AMOUNT_REMAIN__'] = is_object($object) ? price2num($object->total_ttc - $already_payed_all, 'MT') : '';
  7029. $substitutionarray['__AMOUNT_VAT__'] = is_object($object) ? (isset($object->total_vat) ? $object->total_vat : $object->total_tva) : '';
  7030. $substitutionarray['__AMOUNT_VAT_TEXT__'] = is_object($object) ? (isset($object->total_vat) ? dol_convertToWord($object->total_vat, $outputlangs, '', true) : dol_convertToWord($object->total_tva, $outputlangs, '', true)) : '';
  7031. $substitutionarray['__AMOUNT_VAT_TEXTCURRENCY__'] = is_object($object) ? (isset($object->total_vat) ? dol_convertToWord($object->total_vat, $outputlangs, $conf->currency, true) : dol_convertToWord($object->total_tva, $outputlangs, $conf->currency, true)) : '';
  7032. if ($onlykey != 2 || $mysoc->useLocalTax(1)) {
  7033. $substitutionarray['__AMOUNT_TAX2__'] = is_object($object) ? $object->total_localtax1 : '';
  7034. }
  7035. if ($onlykey != 2 || $mysoc->useLocalTax(2)) {
  7036. $substitutionarray['__AMOUNT_TAX3__'] = is_object($object) ? $object->total_localtax2 : '';
  7037. }
  7038. // Amount keys formated in a currency
  7039. $substitutionarray['__AMOUNT_EXCL_TAX_FORMATED__'] = is_object($object) ? ($object->total_ht ? price($object->total_ht, 0, $outputlangs, 0, -1, -1, $conf->currency) : null) : '';
  7040. $substitutionarray['__AMOUNT_FORMATED__'] = is_object($object) ? ($object->total_ttc ? price($object->total_ttc, 0, $outputlangs, 0, -1, -1, $conf->currency) : null) : '';
  7041. $substitutionarray['__AMOUNT_REMAIN_FORMATED__'] = is_object($object) ? ($object->total_ttc ? price($object->total_ttc - $already_payed_all, 0, $outputlangs, 0, -1, -1, $conf->currency) : null) : '';
  7042. $substitutionarray['__AMOUNT_VAT_FORMATED__'] = is_object($object) ? (isset($object->total_vat) ? price($object->total_vat, 0, $outputlangs, 0, -1, -1, $conf->currency) : ($object->total_tva ? price($object->total_tva, 0, $outputlangs, 0, -1, -1, $conf->currency) : null)) : '';
  7043. if ($onlykey != 2 || $mysoc->useLocalTax(1)) {
  7044. $substitutionarray['__AMOUNT_TAX2_FORMATED__'] = is_object($object) ? ($object->total_localtax1 ? price($object->total_localtax1, 0, $outputlangs, 0, -1, -1, $conf->currency) : null) : '';
  7045. }
  7046. if ($onlykey != 2 || $mysoc->useLocalTax(2)) {
  7047. $substitutionarray['__AMOUNT_TAX3_FORMATED__'] = is_object($object) ? ($object->total_localtax2 ? price($object->total_localtax2, 0, $outputlangs, 0, -1, -1, $conf->currency) : null) : '';
  7048. }
  7049. $substitutionarray['__AMOUNT_MULTICURRENCY__'] = (is_object($object) && isset($object->multicurrency_total_ttc)) ? $object->multicurrency_total_ttc : '';
  7050. $substitutionarray['__AMOUNT_MULTICURRENCY_TEXT__'] = (is_object($object) && isset($object->multicurrency_total_ttc)) ? dol_convertToWord($object->multicurrency_total_ttc, $outputlangs, '', true) : '';
  7051. $substitutionarray['__AMOUNT_MULTICURRENCY_TEXTCURRENCY__'] = (is_object($object) && isset($object->multicurrency_total_ttc)) ? dol_convertToWord($object->multicurrency_total_ttc, $outputlangs, $object->multicurrency_code, true) : '';
  7052. // TODO Add other keys for foreign multicurrency
  7053. // For backward compatibility
  7054. if ($onlykey != 2) {
  7055. $substitutionarray['__TOTAL_TTC__'] = is_object($object) ? $object->total_ttc : '';
  7056. $substitutionarray['__TOTAL_HT__'] = is_object($object) ? $object->total_ht : '';
  7057. $substitutionarray['__TOTAL_VAT__'] = is_object($object) ? (isset($object->total_vat) ? $object->total_vat : $object->total_tva) : '';
  7058. }
  7059. }
  7060. //var_dump($substitutionarray['__AMOUNT_FORMATED__']);
  7061. if (empty($exclude) || !in_array('date', $exclude)) {
  7062. include_once DOL_DOCUMENT_ROOT.'/core/lib/date.lib.php';
  7063. $tmp = dol_getdate(dol_now(), true);
  7064. $tmp2 = dol_get_prev_day($tmp['mday'], $tmp['mon'], $tmp['year']);
  7065. $tmp3 = dol_get_prev_month($tmp['mon'], $tmp['year']);
  7066. $tmp4 = dol_get_next_day($tmp['mday'], $tmp['mon'], $tmp['year']);
  7067. $tmp5 = dol_get_next_month($tmp['mon'], $tmp['year']);
  7068. $daytext = $outputlangs->trans('Day'.$tmp['wday']);
  7069. $substitutionarray = array_merge($substitutionarray, array(
  7070. '__DAY__' => (string) $tmp['mday'],
  7071. '__DAY_TEXT__' => $daytext, // Monday
  7072. '__DAY_TEXT_SHORT__' => dol_trunc($daytext, 3, 'right', 'UTF-8', 1), // Mon
  7073. '__DAY_TEXT_MIN__' => dol_trunc($daytext, 1, 'right', 'UTF-8', 1), // M
  7074. '__MONTH__' => (string) $tmp['mon'],
  7075. '__MONTH_TEXT__' => $outputlangs->trans('Month'.sprintf("%02d", $tmp['mon'])),
  7076. '__MONTH_TEXT_SHORT__' => $outputlangs->trans('MonthShort'.sprintf("%02d", $tmp['mon'])),
  7077. '__MONTH_TEXT_MIN__' => $outputlangs->trans('MonthVeryShort'.sprintf("%02d", $tmp['mon'])),
  7078. '__YEAR__' => (string) $tmp['year'],
  7079. '__PREVIOUS_DAY__' => (string) $tmp2['day'],
  7080. '__PREVIOUS_MONTH__' => (string) $tmp3['month'],
  7081. '__PREVIOUS_YEAR__' => (string) ($tmp['year'] - 1),
  7082. '__NEXT_DAY__' => (string) $tmp4['day'],
  7083. '__NEXT_MONTH__' => (string) $tmp5['month'],
  7084. '__NEXT_YEAR__' => (string) ($tmp['year'] + 1),
  7085. ));
  7086. }
  7087. if (!empty($conf->multicompany->enabled)) {
  7088. $substitutionarray = array_merge($substitutionarray, array('__ENTITY_ID__' => $conf->entity));
  7089. }
  7090. if (empty($exclude) || !in_array('system', $exclude)) {
  7091. $substitutionarray['__DOL_MAIN_URL_ROOT__'] = DOL_MAIN_URL_ROOT;
  7092. $substitutionarray['__(AnyTranslationKey)__'] = $outputlangs->trans('TranslationOfKey');
  7093. $substitutionarray['__(AnyTranslationKey|langfile)__'] = $outputlangs->trans('TranslationOfKey').' (load also language file before)';
  7094. $substitutionarray['__[AnyConstantKey]__'] = $outputlangs->trans('ValueOfConstantKey');
  7095. }
  7096. return $substitutionarray;
  7097. }
  7098. /**
  7099. * Make substitution into a text string, replacing keys with vals from $substitutionarray (oldval=>newval),
  7100. * and texts like __(TranslationKey|langfile)__ and __[ConstantKey]__ are also replaced.
  7101. * Example of usage:
  7102. * $substitutionarray = getCommonSubstitutionArray($langs, 0, null, $thirdparty);
  7103. * complete_substitutions_array($substitutionarray, $langs, $thirdparty);
  7104. * $mesg = make_substitutions($mesg, $substitutionarray, $langs);
  7105. *
  7106. * @param string $text Source string in which we must do substitution
  7107. * @param array $substitutionarray Array with key->val to substitute. Example: array('__MYKEY__' => 'MyVal', ...)
  7108. * @param Translate $outputlangs Output language
  7109. * @param int $converttextinhtmlifnecessary 0=Convert only value into HTML if text is already in HTML
  7110. * 1=Will also convert initial $text into HTML if we try to insert one value that is HTML
  7111. * @return string Output string after substitutions
  7112. * @see complete_substitutions_array(), getCommonSubstitutionArray()
  7113. */
  7114. function make_substitutions($text, $substitutionarray, $outputlangs = null, $converttextinhtmlifnecessary = 0)
  7115. {
  7116. global $conf, $langs;
  7117. if (!is_array($substitutionarray)) {
  7118. return 'ErrorBadParameterSubstitutionArrayWhenCalling_make_substitutions';
  7119. }
  7120. if (empty($outputlangs)) {
  7121. $outputlangs = $langs;
  7122. }
  7123. // Is initial text HTML or simple text ?
  7124. $msgishtml = 0;
  7125. if (dol_textishtml($text, 1)) {
  7126. $msgishtml = 1;
  7127. }
  7128. // Make substitution for language keys: __(AnyTranslationKey)__ or __(AnyTranslationKey|langfile)__
  7129. if (is_object($outputlangs)) {
  7130. $reg = array();
  7131. while (preg_match('/__\(([^\)]+)\)__/', $text, $reg)) {
  7132. // If key is __(TranslationKey|langfile)__, then force load of langfile.lang
  7133. $tmp = explode('|', $reg[1]);
  7134. if (!empty($tmp[1])) {
  7135. $outputlangs->load($tmp[1]);
  7136. }
  7137. $value = $outputlangs->transnoentitiesnoconv($reg[1]);
  7138. if (empty($converttextinhtmlifnecessary)) {
  7139. // convert $newval into HTML is necessary
  7140. $text = preg_replace('/__\('.preg_quote($reg[1], '/').'\)__/', $msgishtml ? dol_htmlentitiesbr($value) : $value, $text);
  7141. } else {
  7142. if (! $msgishtml) {
  7143. $valueishtml = dol_textishtml($value, 1);
  7144. var_dump("valueishtml=".$valueishtml);
  7145. if ($valueishtml) {
  7146. $text = dol_htmlentitiesbr($text);
  7147. $msgishtml = 1;
  7148. }
  7149. } else {
  7150. $value = dol_nl2br("$value");
  7151. }
  7152. $text = preg_replace('/__\('.preg_quote($reg[1], '/').'\)__/', $value, $text);
  7153. }
  7154. }
  7155. }
  7156. // Make substitution for constant keys.
  7157. // Must be after the substitution of translation, so if the text of translation contains a string __[xxx]__, it is also converted.
  7158. $reg = array();
  7159. while (preg_match('/__\[([^\]]+)\]__/', $text, $reg)) {
  7160. $keyfound = $reg[1];
  7161. if (isASecretKey($keyfound)) {
  7162. $value = '*****forbidden*****';
  7163. } else {
  7164. $value = empty($conf->global->$keyfound) ? '' : $conf->global->$keyfound;
  7165. }
  7166. if (empty($converttextinhtmlifnecessary)) {
  7167. // convert $newval into HTML is necessary
  7168. $text = preg_replace('/__\['.preg_quote($keyfound, '/').'\]__/', $msgishtml ? dol_htmlentitiesbr($value) : $value, $text);
  7169. } else {
  7170. if (! $msgishtml) {
  7171. $valueishtml = dol_textishtml($value, 1);
  7172. if ($valueishtml) {
  7173. $text = dol_htmlentitiesbr($text);
  7174. $msgishtml = 1;
  7175. }
  7176. } else {
  7177. $value = dol_nl2br("$value");
  7178. }
  7179. $text = preg_replace('/__\['.preg_quote($keyfound, '/').'\]__/', $value, $text);
  7180. }
  7181. }
  7182. // Make substitition for array $substitutionarray
  7183. foreach ($substitutionarray as $key => $value) {
  7184. if (!isset($value)) {
  7185. continue; // If value is null, it same than not having substitution key at all into array, we do not replace.
  7186. }
  7187. if ($key == '__USER_SIGNATURE__' && (!empty($conf->global->MAIN_MAIL_DO_NOT_USE_SIGN))) {
  7188. $value = ''; // Protection
  7189. }
  7190. if (empty($converttextinhtmlifnecessary)) {
  7191. $text = str_replace("$key", "$value", $text); // We must keep the " to work when value is 123.5 for example
  7192. } else {
  7193. if (! $msgishtml) {
  7194. $valueishtml = dol_textishtml($value, 1);
  7195. if ($valueishtml) {
  7196. $text = dol_htmlentitiesbr($text);
  7197. $msgishtml = 1;
  7198. }
  7199. } else {
  7200. $value = dol_nl2br("$value");
  7201. }
  7202. $text = str_replace("$key", "$value", $text); // We must keep the " to work when value is 123.5 for example
  7203. }
  7204. }
  7205. return $text;
  7206. }
  7207. /**
  7208. * Complete the $substitutionarray with more entries coming from external module that had set the "substitutions=1" into module_part array.
  7209. * In this case, method completesubstitutionarray provided by module is called.
  7210. *
  7211. * @param array $substitutionarray Array substitution old value => new value value
  7212. * @param Translate $outputlangs Output language
  7213. * @param Object $object Source object
  7214. * @param mixed $parameters Add more parameters (useful to pass product lines)
  7215. * @param string $callfunc What is the name of the custom function that will be called? (default: completesubstitutionarray)
  7216. * @return void
  7217. * @see make_substitutions()
  7218. */
  7219. function complete_substitutions_array(&$substitutionarray, $outputlangs, $object = null, $parameters = null, $callfunc = "completesubstitutionarray")
  7220. {
  7221. global $conf, $user;
  7222. require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
  7223. // Note: substitution key for each extrafields, using key __EXTRA_XXX__ is already available into the getCommonSubstitutionArray used to build the substitution array.
  7224. // Check if there is external substitution to do, requested by plugins
  7225. $dirsubstitutions = array_merge(array(), (array) $conf->modules_parts['substitutions']);
  7226. foreach ($dirsubstitutions as $reldir) {
  7227. $dir = dol_buildpath($reldir, 0);
  7228. // Check if directory exists
  7229. if (!dol_is_dir($dir)) {
  7230. continue;
  7231. }
  7232. $substitfiles = dol_dir_list($dir, 'files', 0, 'functions_');
  7233. foreach ($substitfiles as $substitfile) {
  7234. $reg = array();
  7235. if (preg_match('/functions_(.*)\.lib\.php/i', $substitfile['name'], $reg)) {
  7236. $module = $reg[1];
  7237. dol_syslog("Library ".$substitfile['name']." found into ".$dir);
  7238. // Include the user's functions file
  7239. require_once $dir.$substitfile['name'];
  7240. // Call the user's function, and only if it is defined
  7241. $function_name = $module."_".$callfunc;
  7242. if (function_exists($function_name)) {
  7243. $function_name($substitutionarray, $outputlangs, $object, $parameters);
  7244. }
  7245. }
  7246. }
  7247. }
  7248. if (!empty($conf->global->ODT_ENABLE_ALL_TAGS_IN_SUBSTITUTIONS)) {
  7249. // to list all tags in odt template
  7250. $tags = '';
  7251. foreach ($substitutionarray as $key => $value) {
  7252. $tags .= '{'.$key.'} => '.$value."\n";
  7253. }
  7254. $substitutionarray = array_merge($substitutionarray, array('__ALL_TAGS__' => $tags));
  7255. }
  7256. }
  7257. /**
  7258. * Format output for start and end date
  7259. *
  7260. * @param int $date_start Start date
  7261. * @param int $date_end End date
  7262. * @param string $format Output format
  7263. * @param Translate $outputlangs Output language
  7264. * @return void
  7265. */
  7266. function print_date_range($date_start, $date_end, $format = '', $outputlangs = '')
  7267. {
  7268. print get_date_range($date_start, $date_end, $format, $outputlangs);
  7269. }
  7270. /**
  7271. * Format output for start and end date
  7272. *
  7273. * @param int $date_start Start date
  7274. * @param int $date_end End date
  7275. * @param string $format Output format
  7276. * @param Translate $outputlangs Output language
  7277. * @param integer $withparenthesis 1=Add parenthesis, 0=no parenthesis
  7278. * @return string String
  7279. */
  7280. function get_date_range($date_start, $date_end, $format = '', $outputlangs = '', $withparenthesis = 1)
  7281. {
  7282. global $langs;
  7283. $out = '';
  7284. if (!is_object($outputlangs)) {
  7285. $outputlangs = $langs;
  7286. }
  7287. if ($date_start && $date_end) {
  7288. $out .= ($withparenthesis ? ' (' : '').$outputlangs->transnoentitiesnoconv('DateFromTo', dol_print_date($date_start, $format, false, $outputlangs), dol_print_date($date_end, $format, false, $outputlangs)).($withparenthesis ? ')' : '');
  7289. }
  7290. if ($date_start && !$date_end) {
  7291. $out .= ($withparenthesis ? ' (' : '').$outputlangs->transnoentitiesnoconv('DateFrom', dol_print_date($date_start, $format, false, $outputlangs)).($withparenthesis ? ')' : '');
  7292. }
  7293. if (!$date_start && $date_end) {
  7294. $out .= ($withparenthesis ? ' (' : '').$outputlangs->transnoentitiesnoconv('DateUntil', dol_print_date($date_end, $format, false, $outputlangs)).($withparenthesis ? ')' : '');
  7295. }
  7296. return $out;
  7297. }
  7298. /**
  7299. * Return firstname and lastname in correct order
  7300. *
  7301. * @param string $firstname Firstname
  7302. * @param string $lastname Lastname
  7303. * @param int $nameorder -1=Auto, 0=Lastname+Firstname, 1=Firstname+Lastname, 2=Firstname, 3=Firstname if defined else lastname, 4=Lastname, 5=Lastname if defined else firstname
  7304. * @return string Firstname + lastname or Lastname + firstname
  7305. */
  7306. function dolGetFirstLastname($firstname, $lastname, $nameorder = -1)
  7307. {
  7308. global $conf;
  7309. $ret = '';
  7310. // If order not defined, we use the setup
  7311. if ($nameorder < 0) {
  7312. $nameorder = (empty($conf->global->MAIN_FIRSTNAME_NAME_POSITION) ? 1 : 0);
  7313. }
  7314. if ($nameorder == 1) {
  7315. $ret .= $firstname;
  7316. if ($firstname && $lastname) {
  7317. $ret .= ' ';
  7318. }
  7319. $ret .= $lastname;
  7320. } elseif ($nameorder == 2 || $nameorder == 3) {
  7321. $ret .= $firstname;
  7322. if (empty($ret) && $nameorder == 3) {
  7323. $ret .= $lastname;
  7324. }
  7325. } else { // 0, 4 or 5
  7326. $ret .= $lastname;
  7327. if (empty($ret) && $nameorder == 5) {
  7328. $ret .= $firstname;
  7329. }
  7330. if ($nameorder == 0) {
  7331. if ($firstname && $lastname) {
  7332. $ret .= ' ';
  7333. }
  7334. $ret .= $firstname;
  7335. }
  7336. }
  7337. return $ret;
  7338. }
  7339. /**
  7340. * Set event message in dol_events session object. Will be output by calling dol_htmloutput_events.
  7341. * Note: Calling dol_htmloutput_events is done into pages by standard llxFooter() function.
  7342. * Note: Prefer to use setEventMessages instead.
  7343. *
  7344. * @param string|string[] $mesgs Message string or array
  7345. * @param string $style Which style to use ('mesgs' by default, 'warnings', 'errors')
  7346. * @return void
  7347. * @see dol_htmloutput_events()
  7348. */
  7349. function setEventMessage($mesgs, $style = 'mesgs')
  7350. {
  7351. //dol_syslog(__FUNCTION__ . " is deprecated", LOG_WARNING); This is not deprecated, it is used by setEventMessages function
  7352. if (!is_array($mesgs)) {
  7353. // If mesgs is a string
  7354. if ($mesgs) {
  7355. $_SESSION['dol_events'][$style][] = $mesgs;
  7356. }
  7357. } else {
  7358. // If mesgs is an array
  7359. foreach ($mesgs as $mesg) {
  7360. if ($mesg) {
  7361. $_SESSION['dol_events'][$style][] = $mesg;
  7362. }
  7363. }
  7364. }
  7365. }
  7366. /**
  7367. * Set event messages in dol_events session object. Will be output by calling dol_htmloutput_events.
  7368. * Note: Calling dol_htmloutput_events is done into pages by standard llxFooter() function.
  7369. *
  7370. * @param string $mesg Message string
  7371. * @param array $mesgs Message array
  7372. * @param string $style Which style to use ('mesgs' by default, 'warnings', 'errors')
  7373. * @param string $messagekey A key to be used to allow the feature "Never show this message again"
  7374. * @return void
  7375. * @see dol_htmloutput_events()
  7376. */
  7377. function setEventMessages($mesg, $mesgs, $style = 'mesgs', $messagekey = '')
  7378. {
  7379. if (empty($mesg) && empty($mesgs)) {
  7380. dol_syslog("Try to add a message in stack with empty message", LOG_WARNING);
  7381. } else {
  7382. if ($messagekey) {
  7383. // Complete message with a js link to set a cookie "DOLHIDEMESSAGE".$messagekey;
  7384. // TODO
  7385. $mesg .= '';
  7386. }
  7387. if (empty($messagekey) || empty($_COOKIE["DOLHIDEMESSAGE".$messagekey])) {
  7388. if (!in_array((string) $style, array('mesgs', 'warnings', 'errors'))) {
  7389. dol_print_error('', 'Bad parameter style='.$style.' for setEventMessages');
  7390. }
  7391. if (empty($mesgs)) {
  7392. setEventMessage($mesg, $style);
  7393. } else {
  7394. if (!empty($mesg) && !in_array($mesg, $mesgs)) {
  7395. setEventMessage($mesg, $style); // Add message string if not already into array
  7396. }
  7397. setEventMessage($mesgs, $style);
  7398. }
  7399. }
  7400. }
  7401. }
  7402. /**
  7403. * Print formated messages to output (Used to show messages on html output).
  7404. * Note: Calling dol_htmloutput_events is done into pages by standard llxFooter() function, so there is
  7405. * no need to call it explicitely.
  7406. *
  7407. * @param int $disabledoutputofmessages Clear all messages stored into session without diplaying them
  7408. * @return void
  7409. * @see dol_htmloutput_mesg()
  7410. */
  7411. function dol_htmloutput_events($disabledoutputofmessages = 0)
  7412. {
  7413. // Show mesgs
  7414. if (isset($_SESSION['dol_events']['mesgs'])) {
  7415. if (empty($disabledoutputofmessages)) {
  7416. dol_htmloutput_mesg('', $_SESSION['dol_events']['mesgs']);
  7417. }
  7418. unset($_SESSION['dol_events']['mesgs']);
  7419. }
  7420. // Show errors
  7421. if (isset($_SESSION['dol_events']['errors'])) {
  7422. if (empty($disabledoutputofmessages)) {
  7423. dol_htmloutput_mesg('', $_SESSION['dol_events']['errors'], 'error');
  7424. }
  7425. unset($_SESSION['dol_events']['errors']);
  7426. }
  7427. // Show warnings
  7428. if (isset($_SESSION['dol_events']['warnings'])) {
  7429. if (empty($disabledoutputofmessages)) {
  7430. dol_htmloutput_mesg('', $_SESSION['dol_events']['warnings'], 'warning');
  7431. }
  7432. unset($_SESSION['dol_events']['warnings']);
  7433. }
  7434. }
  7435. /**
  7436. * Get formated messages to output (Used to show messages on html output).
  7437. * This include also the translation of the message key.
  7438. *
  7439. * @param string $mesgstring Message string or message key
  7440. * @param string[] $mesgarray Array of message strings or message keys
  7441. * @param string $style Style of message output ('ok' or 'error')
  7442. * @param int $keepembedded Set to 1 in error message must be kept embedded into its html place (this disable jnotify)
  7443. * @return string Return html output
  7444. *
  7445. * @see dol_print_error()
  7446. * @see dol_htmloutput_errors()
  7447. * @see setEventMessages()
  7448. */
  7449. function get_htmloutput_mesg($mesgstring = '', $mesgarray = '', $style = 'ok', $keepembedded = 0)
  7450. {
  7451. global $conf, $langs;
  7452. $ret = 0;
  7453. $return = '';
  7454. $out = '';
  7455. $divstart = $divend = '';
  7456. // If inline message with no format, we add it.
  7457. if ((empty($conf->use_javascript_ajax) || !empty($conf->global->MAIN_DISABLE_JQUERY_JNOTIFY) || $keepembedded) && !preg_match('/<div class=".*">/i', $out)) {
  7458. $divstart = '<div class="'.$style.' clearboth">';
  7459. $divend = '</div>';
  7460. }
  7461. if ((is_array($mesgarray) && count($mesgarray)) || $mesgstring) {
  7462. $langs->load("errors");
  7463. $out .= $divstart;
  7464. if (is_array($mesgarray) && count($mesgarray)) {
  7465. foreach ($mesgarray as $message) {
  7466. $ret++;
  7467. $out .= $langs->trans($message);
  7468. if ($ret < count($mesgarray)) {
  7469. $out .= "<br>\n";
  7470. }
  7471. }
  7472. }
  7473. if ($mesgstring) {
  7474. $ret++;
  7475. $out .= $langs->trans($mesgstring);
  7476. }
  7477. $out .= $divend;
  7478. }
  7479. if ($out) {
  7480. if (!empty($conf->use_javascript_ajax) && empty($conf->global->MAIN_DISABLE_JQUERY_JNOTIFY) && empty($keepembedded)) {
  7481. $return = '<script>
  7482. $(document).ready(function() {
  7483. var block = '.(!empty($conf->global->MAIN_USE_JQUERY_BLOCKUI) ? "true" : "false").'
  7484. if (block) {
  7485. $.dolEventValid("","'.dol_escape_js($out).'");
  7486. } else {
  7487. /* jnotify(message, preset of message type, keepmessage) */
  7488. $.jnotify("'.dol_escape_js($out).'",
  7489. "'.($style == "ok" ? 3000 : $style).'",
  7490. '.($style == "ok" ? "false" : "true").',
  7491. { remove: function (){} } );
  7492. }
  7493. });
  7494. </script>';
  7495. } else {
  7496. $return = $out;
  7497. }
  7498. }
  7499. return $return;
  7500. }
  7501. /**
  7502. * Get formated error messages to output (Used to show messages on html output).
  7503. *
  7504. * @param string $mesgstring Error message
  7505. * @param array $mesgarray Error messages array
  7506. * @param int $keepembedded Set to 1 in error message must be kept embedded into its html place (this disable jnotify)
  7507. * @return string Return html output
  7508. *
  7509. * @see dol_print_error()
  7510. * @see dol_htmloutput_mesg()
  7511. */
  7512. function get_htmloutput_errors($mesgstring = '', $mesgarray = array(), $keepembedded = 0)
  7513. {
  7514. return get_htmloutput_mesg($mesgstring, $mesgarray, 'error', $keepembedded);
  7515. }
  7516. /**
  7517. * Print formated messages to output (Used to show messages on html output).
  7518. *
  7519. * @param string $mesgstring Message string or message key
  7520. * @param string[] $mesgarray Array of message strings or message keys
  7521. * @param string $style Which style to use ('ok', 'warning', 'error')
  7522. * @param int $keepembedded Set to 1 if message must be kept embedded into its html place (this disable jnotify)
  7523. * @return void
  7524. *
  7525. * @see dol_print_error()
  7526. * @see dol_htmloutput_errors()
  7527. * @see setEventMessages()
  7528. */
  7529. function dol_htmloutput_mesg($mesgstring = '', $mesgarray = array(), $style = 'ok', $keepembedded = 0)
  7530. {
  7531. if (empty($mesgstring) && (!is_array($mesgarray) || count($mesgarray) == 0)) {
  7532. return;
  7533. }
  7534. $iserror = 0;
  7535. $iswarning = 0;
  7536. if (is_array($mesgarray)) {
  7537. foreach ($mesgarray as $val) {
  7538. if ($val && preg_match('/class="error"/i', $val)) {
  7539. $iserror++;
  7540. break;
  7541. }
  7542. if ($val && preg_match('/class="warning"/i', $val)) {
  7543. $iswarning++;
  7544. break;
  7545. }
  7546. }
  7547. } elseif ($mesgstring && preg_match('/class="error"/i', $mesgstring)) {
  7548. $iserror++;
  7549. } elseif ($mesgstring && preg_match('/class="warning"/i', $mesgstring)) {
  7550. $iswarning++;
  7551. }
  7552. if ($style == 'error') {
  7553. $iserror++;
  7554. }
  7555. if ($style == 'warning') {
  7556. $iswarning++;
  7557. }
  7558. if ($iserror || $iswarning) {
  7559. // Remove div from texts
  7560. $mesgstring = preg_replace('/<\/div><div class="(error|warning)">/', '<br>', $mesgstring);
  7561. $mesgstring = preg_replace('/<div class="(error|warning)">/', '', $mesgstring);
  7562. $mesgstring = preg_replace('/<\/div>/', '', $mesgstring);
  7563. // Remove div from texts array
  7564. if (is_array($mesgarray)) {
  7565. $newmesgarray = array();
  7566. foreach ($mesgarray as $val) {
  7567. if (is_string($val)) {
  7568. $tmpmesgstring = preg_replace('/<\/div><div class="(error|warning)">/', '<br>', $val);
  7569. $tmpmesgstring = preg_replace('/<div class="(error|warning)">/', '', $tmpmesgstring);
  7570. $tmpmesgstring = preg_replace('/<\/div>/', '', $tmpmesgstring);
  7571. $newmesgarray[] = $tmpmesgstring;
  7572. } else {
  7573. dol_syslog("Error call of dol_htmloutput_mesg with an array with a value that is not a string", LOG_WARNING);
  7574. }
  7575. }
  7576. $mesgarray = $newmesgarray;
  7577. }
  7578. print get_htmloutput_mesg($mesgstring, $mesgarray, ($iserror ? 'error' : 'warning'), $keepembedded);
  7579. } else {
  7580. print get_htmloutput_mesg($mesgstring, $mesgarray, 'ok', $keepembedded);
  7581. }
  7582. }
  7583. /**
  7584. * Print formated error messages to output (Used to show messages on html output).
  7585. *
  7586. * @param string $mesgstring Error message
  7587. * @param array $mesgarray Error messages array
  7588. * @param int $keepembedded Set to 1 in error message must be kept embedded into its html place (this disable jnotify)
  7589. * @return void
  7590. *
  7591. * @see dol_print_error()
  7592. * @see dol_htmloutput_mesg()
  7593. */
  7594. function dol_htmloutput_errors($mesgstring = '', $mesgarray = array(), $keepembedded = 0)
  7595. {
  7596. dol_htmloutput_mesg($mesgstring, $mesgarray, 'error', $keepembedded);
  7597. }
  7598. /**
  7599. * Advanced sort array by second index function, which produces ascending (default)
  7600. * or descending output and uses optionally natural case insensitive sorting (which
  7601. * can be optionally case sensitive as well).
  7602. *
  7603. * @param array $array Array to sort (array of array('key1'=>val1,'key2'=>val2,'key3'...) or array of objects)
  7604. * @param string $index Key in array to use for sorting criteria
  7605. * @param int $order Sort order ('asc' or 'desc')
  7606. * @param int $natsort 1=use "natural" sort (natsort) for a search criteria thats is strings or unknown, 0=use "standard" sort (asort) for numbers
  7607. * @param int $case_sensitive 1=sort is case sensitive, 0=not case sensitive
  7608. * @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.
  7609. * @return array Sorted array
  7610. */
  7611. function dol_sort_array(&$array, $index, $order = 'asc', $natsort = 0, $case_sensitive = 0, $keepindex = 0)
  7612. {
  7613. // Clean parameters
  7614. $order = strtolower($order);
  7615. if (is_array($array)) {
  7616. $sizearray = count($array);
  7617. if ($sizearray > 0) {
  7618. $temp = array();
  7619. foreach (array_keys($array) as $key) {
  7620. if (is_object($array[$key])) {
  7621. $temp[$key] = empty($array[$key]->$index) ? 0 : $array[$key]->$index;
  7622. } else {
  7623. $temp[$key] = empty($array[$key][$index]) ? 0 : $array[$key][$index];
  7624. }
  7625. }
  7626. if (!$natsort) {
  7627. if ($order == 'asc') {
  7628. asort($temp);
  7629. } else {
  7630. arsort($temp);
  7631. }
  7632. } else {
  7633. if ($case_sensitive) {
  7634. natsort($temp);
  7635. } else {
  7636. natcasesort($temp); // natecasesort is not sensible to case
  7637. }
  7638. if ($order != 'asc') {
  7639. $temp = array_reverse($temp, true);
  7640. }
  7641. }
  7642. $sorted = array();
  7643. foreach (array_keys($temp) as $key) {
  7644. (is_numeric($key) && empty($keepindex)) ? $sorted[] = $array[$key] : $sorted[$key] = $array[$key];
  7645. }
  7646. return $sorted;
  7647. }
  7648. }
  7649. return $array;
  7650. }
  7651. /**
  7652. * Check if a string is in UTF8
  7653. *
  7654. * @param string $str String to check
  7655. * @return boolean True if string is UTF8 or ISO compatible with UTF8, False if not (ISO with special char or Binary)
  7656. */
  7657. function utf8_check($str)
  7658. {
  7659. $str = (string) $str; // Sometimes string is an int.
  7660. // We must use here a binary strlen function (so not dol_strlen)
  7661. $strLength = dol_strlen($str);
  7662. for ($i = 0; $i < $strLength; $i++) {
  7663. if (ord($str[$i]) < 0x80) {
  7664. continue; // 0bbbbbbb
  7665. } elseif ((ord($str[$i]) & 0xE0) == 0xC0) {
  7666. $n = 1; // 110bbbbb
  7667. } elseif ((ord($str[$i]) & 0xF0) == 0xE0) {
  7668. $n = 2; // 1110bbbb
  7669. } elseif ((ord($str[$i]) & 0xF8) == 0xF0) {
  7670. $n = 3; // 11110bbb
  7671. } elseif ((ord($str[$i]) & 0xFC) == 0xF8) {
  7672. $n = 4; // 111110bb
  7673. } elseif ((ord($str[$i]) & 0xFE) == 0xFC) {
  7674. $n = 5; // 1111110b
  7675. } else {
  7676. return false; // Does not match any model
  7677. }
  7678. for ($j = 0; $j < $n; $j++) { // n bytes matching 10bbbbbb follow ?
  7679. if ((++$i == strlen($str)) || ((ord($str[$i]) & 0xC0) != 0x80)) {
  7680. return false;
  7681. }
  7682. }
  7683. }
  7684. return true;
  7685. }
  7686. /**
  7687. * Check if a string is in ASCII
  7688. *
  7689. * @param string $str String to check
  7690. * @return boolean True if string is ASCII, False if not (byte value > 0x7F)
  7691. */
  7692. function ascii_check($str)
  7693. {
  7694. if (function_exists('mb_check_encoding')) {
  7695. //if (mb_detect_encoding($str, 'ASCII', true) return false;
  7696. if (!mb_check_encoding($str, 'ASCII')) {
  7697. return false;
  7698. }
  7699. } else {
  7700. if (preg_match('/[^\x00-\x7f]/', $str)) {
  7701. return false; // Contains a byte > 7f
  7702. }
  7703. }
  7704. return true;
  7705. }
  7706. /**
  7707. * Return a string encoded into OS filesystem encoding. This function is used to define
  7708. * value to pass to filesystem PHP functions.
  7709. *
  7710. * @param string $str String to encode (UTF-8)
  7711. * @return string Encoded string (UTF-8, ISO-8859-1)
  7712. */
  7713. function dol_osencode($str)
  7714. {
  7715. global $conf;
  7716. $tmp = ini_get("unicode.filesystem_encoding"); // Disponible avec PHP 6.0
  7717. if (empty($tmp) && !empty($_SERVER["WINDIR"])) {
  7718. $tmp = 'iso-8859-1'; // By default for windows
  7719. }
  7720. if (empty($tmp)) {
  7721. $tmp = 'utf-8'; // By default for other
  7722. }
  7723. if (!empty($conf->global->MAIN_FILESYSTEM_ENCODING)) {
  7724. $tmp = $conf->global->MAIN_FILESYSTEM_ENCODING;
  7725. }
  7726. if ($tmp == 'iso-8859-1') {
  7727. return utf8_decode($str);
  7728. }
  7729. return $str;
  7730. }
  7731. /**
  7732. * Return an id or code from a code or id.
  7733. * Store also Code-Id into a cache to speed up next request on same key.
  7734. *
  7735. * @param DoliDB $db Database handler
  7736. * @param string $key Code or Id to get Id or Code
  7737. * @param string $tablename Table name without prefix
  7738. * @param string $fieldkey Field to search the key into
  7739. * @param string $fieldid Field to get
  7740. * @param int $entityfilter Filter by entity
  7741. * @param string $filters Filters to add. WARNING: string must be escaped for SQL and not coming from user input.
  7742. * @return int <0 if KO, Id of code if OK
  7743. * @see $langs->getLabelFromKey
  7744. */
  7745. function dol_getIdFromCode($db, $key, $tablename, $fieldkey = 'code', $fieldid = 'id', $entityfilter = 0, $filters = '')
  7746. {
  7747. global $cache_codes;
  7748. // If key empty
  7749. if ($key == '') {
  7750. return '';
  7751. }
  7752. // Check in cache
  7753. if (isset($cache_codes[$tablename][$key][$fieldid])) { // Can be defined to 0 or ''
  7754. return $cache_codes[$tablename][$key][$fieldid]; // Found in cache
  7755. }
  7756. dol_syslog('dol_getIdFromCode (value for field '.$fieldid.' from key '.$key.' not found into cache)', LOG_DEBUG);
  7757. $sql = "SELECT ".$fieldid." as valuetoget";
  7758. $sql .= " FROM ".MAIN_DB_PREFIX.$tablename;
  7759. $sql .= " WHERE ".$fieldkey." = '".$db->escape($key)."'";
  7760. if (!empty($entityfilter)) {
  7761. $sql .= " AND entity IN (".getEntity($tablename).")";
  7762. }
  7763. if ($filters) {
  7764. $sql .= $filters;
  7765. }
  7766. $resql = $db->query($sql);
  7767. if ($resql) {
  7768. $obj = $db->fetch_object($resql);
  7769. if ($obj) {
  7770. $cache_codes[$tablename][$key][$fieldid] = $obj->valuetoget;
  7771. } else {
  7772. $cache_codes[$tablename][$key][$fieldid] = '';
  7773. }
  7774. $db->free($resql);
  7775. return $cache_codes[$tablename][$key][$fieldid];
  7776. } else {
  7777. return -1;
  7778. }
  7779. }
  7780. /**
  7781. * Verify if condition in string is ok or not
  7782. *
  7783. * @param string $strToEvaluate String with condition to check
  7784. * @return boolean True or False. Note: It returns also True if $strToEvaluate is ''. False if error
  7785. */
  7786. function verifCond($strToEvaluate)
  7787. {
  7788. global $user, $conf, $langs;
  7789. global $leftmenu;
  7790. global $rights; // To export to dol_eval function
  7791. //print $strToEvaluate."<br>\n";
  7792. $rights = true;
  7793. if (isset($strToEvaluate) && $strToEvaluate !== '') {
  7794. //$str = 'if(!('.$strToEvaluate.')) $rights = false;';
  7795. //dol_eval($str, 0, 1, '2'); // The dol_eval must contains all the global $xxx used into a condition
  7796. //var_dump($strToEvaluate);
  7797. $rep = dol_eval($strToEvaluate, 1, 1, '1'); // The dol_eval must contains all the global $xxx for all variables $xxx found into the string condition
  7798. $rights = $rep && (!is_string($rep) || strpos($rep, 'Bad string syntax to evaluate') === false);
  7799. //var_dump($rights);
  7800. }
  7801. return $rights;
  7802. }
  7803. /**
  7804. * Replace eval function to add more security.
  7805. * This function is called by verifCond() or trans() and transnoentitiesnoconv().
  7806. *
  7807. * @param string $s String to evaluate
  7808. * @param int $returnvalue 0=No return (used to execute eval($a=something)). 1=Value of eval is returned (used to eval($something)).
  7809. * @param int $hideerrors 1=Hide errors
  7810. * @param string $onlysimplestring 0=Accept all chars, 1=Accept only simple string with char 'a-z0-9\s^$_+-.*\/>&|=!?():"\',/';', 2=Accept also ';[]'
  7811. * @return mixed Nothing or return result of eval
  7812. */
  7813. function dol_eval($s, $returnvalue = 0, $hideerrors = 1, $onlysimplestring = '1')
  7814. {
  7815. // Only global variables can be changed by eval function and returned to caller
  7816. global $db, $langs, $user, $conf, $website, $websitepage;
  7817. global $action, $mainmenu, $leftmenu;
  7818. global $mysoc;
  7819. global $objectoffield;
  7820. // Old variables used
  7821. global $rights;
  7822. global $object;
  7823. global $obj; // To get $obj used into list when dol_eval is used for computed fields and $obj is not yet $object
  7824. global $soc; // For backward compatibility
  7825. // Test on dangerous char (used for RCE), we allow only characters to make PHP variable testing
  7826. if ($onlysimplestring == '1') {
  7827. // We must accept: '1 && getDolGlobalInt("doesnotexist1") && $conf->global->MAIN_FEATURES_LEVEL'
  7828. // We must accept: '$conf->barcode->enabled && preg_match(\'/^(AAA|BBB)/\',$leftmenu)'
  7829. // We must accept: '$user->rights->cabinetmed->read && $object->canvas=="patient@cabinetmed"'
  7830. if (preg_match('/[^a-z0-9\s'.preg_quote('^$_+-.*>&|=!?():"\',/@', '/').']/i', $s)) {
  7831. if ($returnvalue) {
  7832. return 'Bad string syntax to evaluate (found chars that are not chars for simplestring): '.$s;
  7833. } else {
  7834. dol_syslog('Bad string syntax to evaluate (found chars that are not chars for simplestring): '.$s);
  7835. return '';
  7836. }
  7837. // TODO We can exclude all () that is not '($db)' and 'getDolGlobalInt(' and 'getDolGlobalString(' and 'preg_match('
  7838. // ...
  7839. }
  7840. } elseif ($onlysimplestring == '2') {
  7841. // We must accept: (($reloadedobj = new Task($db)) && ($reloadedobj->fetchNoCompute($object->id) > 0) && ($secondloadedobj = new Project($db)) && ($secondloadedobj->fetchNoCompute($reloadedobj->fk_project) > 0)) ? $secondloadedobj->ref : "Parent project not found"
  7842. if (preg_match('/[^a-z0-9\s'.preg_quote('^$_+-.*>&|=!?():"\',/@;[]', '/').']/i', $s)) {
  7843. if ($returnvalue) {
  7844. return 'Bad string syntax to evaluate (found chars that are not chars for simplestring): '.$s;
  7845. } else {
  7846. dol_syslog('Bad string syntax to evaluate (found chars that are not chars for simplestring): '.$s);
  7847. return '';
  7848. }
  7849. }
  7850. }
  7851. if (is_array($s) || $s === 'Array') {
  7852. return 'Bad string syntax to evaluate (value is Array) '.var_export($s, true);
  7853. }
  7854. if (strpos($s, '::') !== false) {
  7855. if ($returnvalue) {
  7856. return 'Bad string syntax to evaluate (double : char is forbidden): '.$s;
  7857. } else {
  7858. dol_syslog('Bad string syntax to evaluate (double : char is forbidden): '.$s);
  7859. return '';
  7860. }
  7861. }
  7862. if (strpos($s, '`') !== false) {
  7863. if ($returnvalue) {
  7864. return 'Bad string syntax to evaluate (backtick char is forbidden): '.$s;
  7865. } else {
  7866. dol_syslog('Bad string syntax to evaluate (backtick char is forbidden): '.$s);
  7867. return '';
  7868. }
  7869. }
  7870. if (preg_match('/[^0-9]+\.[^0-9]+/', $s)) { // We refuse . if not between 2 numbers
  7871. if ($returnvalue) {
  7872. return 'Bad string syntax to evaluate (dot char is forbidden): '.$s;
  7873. } else {
  7874. dol_syslog('Bad string syntax to evaluate (dot char is forbidden): '.$s);
  7875. return '';
  7876. }
  7877. }
  7878. // We block use of php exec or php file functions
  7879. $forbiddenphpstrings = array('$$');
  7880. $forbiddenphpstrings = array_merge($forbiddenphpstrings, array('_ENV', '_SESSION', '_COOKIE', '_GET', '_POST', '_REQUEST'));
  7881. $forbiddenphpfunctions = array("exec", "passthru", "shell_exec", "system", "proc_open", "popen", "eval", "dol_eval", "executeCLI", "verifCond", "base64_decode");
  7882. $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("fopen", "file_put_contents", "fputs", "fputscsv", "fwrite", "fpassthru", "require", "include", "mkdir", "rmdir", "symlink", "touch", "unlink", "umask"));
  7883. $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("function", "call_user_func"));
  7884. $forbiddenphpregex = 'global\s+\$|\b('.implode('|', $forbiddenphpfunctions).')\b';
  7885. do {
  7886. $oldstringtoclean = $s;
  7887. $s = str_ireplace($forbiddenphpstrings, '__forbiddenstring__', $s);
  7888. $s = preg_replace('/'.$forbiddenphpregex.'/i', '__forbiddenstring__', $s);
  7889. //$s = preg_replace('/\$[a-zA-Z0-9_\->\$]+\(/i', '', $s); // Remove $function( call and $mycall->mymethod(
  7890. } while ($oldstringtoclean != $s);
  7891. if (strpos($s, '__forbiddenstring__') !== false) {
  7892. dol_syslog('Bad string syntax to evaluate: '.$s, LOG_WARNING);
  7893. if ($returnvalue) {
  7894. return 'Bad string syntax to evaluate: '.$s;
  7895. } else {
  7896. dol_syslog('Bad string syntax to evaluate: '.$s);
  7897. return '';
  7898. }
  7899. }
  7900. //print $s."<br>\n";
  7901. if ($returnvalue) {
  7902. if ($hideerrors) {
  7903. return @eval('return '.$s.';');
  7904. } else {
  7905. return eval('return '.$s.';');
  7906. }
  7907. } else {
  7908. if ($hideerrors) {
  7909. @eval($s);
  7910. } else {
  7911. eval($s);
  7912. }
  7913. }
  7914. }
  7915. /**
  7916. * Return if var element is ok
  7917. *
  7918. * @param string $element Variable to check
  7919. * @return boolean Return true of variable is not empty
  7920. */
  7921. function dol_validElement($element)
  7922. {
  7923. return (trim($element) != '');
  7924. }
  7925. /**
  7926. * Return img flag of country for a language code or country code.
  7927. *
  7928. * @param string $codelang Language code ('en_IN', 'fr_CA', ...) or ISO Country code on 2 characters in uppercase ('IN', 'FR')
  7929. * @param string $moreatt Add more attribute on img tag (For example 'style="float: right"' or 'class="saturatemedium"')
  7930. * @param int $notitlealt No title alt
  7931. * @return string HTML img string with flag.
  7932. */
  7933. function picto_from_langcode($codelang, $moreatt = '', $notitlealt = 0)
  7934. {
  7935. if (empty($codelang)) {
  7936. return '';
  7937. }
  7938. if ($codelang == 'auto') {
  7939. return '<span class="fa fa-language"></span>';
  7940. }
  7941. $langtocountryflag = array(
  7942. 'ar_AR' => '',
  7943. 'ca_ES' => 'catalonia',
  7944. 'da_DA' => 'dk',
  7945. 'fr_CA' => 'mq',
  7946. 'sv_SV' => 'se',
  7947. 'sw_SW' => 'unknown',
  7948. 'AQ' => 'unknown',
  7949. 'CW' => 'unknown',
  7950. 'IM' => 'unknown',
  7951. 'JE' => 'unknown',
  7952. 'MF' => 'unknown',
  7953. 'BL' => 'unknown',
  7954. 'SX' => 'unknown'
  7955. );
  7956. if (isset($langtocountryflag[$codelang])) {
  7957. $flagImage = $langtocountryflag[$codelang];
  7958. } else {
  7959. $tmparray = explode('_', $codelang);
  7960. $flagImage = empty($tmparray[1]) ? $tmparray[0] : $tmparray[1];
  7961. }
  7962. return img_picto_common($codelang, 'flags/'.strtolower($flagImage).'.png', $moreatt, 0, $notitlealt);
  7963. }
  7964. /**
  7965. * Return default language from country code.
  7966. * Return null if not found.
  7967. *
  7968. * @param string $countrycode Country code like 'US', 'FR', 'CA', 'ES', 'IN', 'MX', ...
  7969. * @return string Value of locale like 'en_US', 'fr_FR', ... or null if not found
  7970. */
  7971. function getLanguageCodeFromCountryCode($countrycode)
  7972. {
  7973. global $mysoc;
  7974. if (empty($countrycode)) {
  7975. return null;
  7976. }
  7977. if (strtoupper($countrycode) == 'MQ') {
  7978. return 'fr_CA';
  7979. }
  7980. if (strtoupper($countrycode) == 'SE') {
  7981. return 'sv_SE'; // se_SE is Sami/Sweden, and we want in priority sv_SE for SE country
  7982. }
  7983. if (strtoupper($countrycode) == 'CH') {
  7984. if ($mysoc->country_code == 'FR') {
  7985. return 'fr_CH';
  7986. }
  7987. if ($mysoc->country_code == 'DE') {
  7988. return 'de_CH';
  7989. }
  7990. if ($mysoc->country_code == 'IT') {
  7991. return 'it_CH';
  7992. }
  7993. }
  7994. // Locale list taken from:
  7995. // http://stackoverflow.com/questions/3191664/
  7996. // list-of-all-locales-and-their-short-codes
  7997. $locales = array(
  7998. 'af-ZA',
  7999. 'am-ET',
  8000. 'ar-AE',
  8001. 'ar-BH',
  8002. 'ar-DZ',
  8003. 'ar-EG',
  8004. 'ar-IQ',
  8005. 'ar-JO',
  8006. 'ar-KW',
  8007. 'ar-LB',
  8008. 'ar-LY',
  8009. 'ar-MA',
  8010. 'ar-OM',
  8011. 'ar-QA',
  8012. 'ar-SA',
  8013. 'ar-SY',
  8014. 'ar-TN',
  8015. 'ar-YE',
  8016. //'as-IN', // Moved after en-IN
  8017. 'ba-RU',
  8018. 'be-BY',
  8019. 'bg-BG',
  8020. 'bn-BD',
  8021. //'bn-IN', // Moved after en-IN
  8022. 'bo-CN',
  8023. 'br-FR',
  8024. 'ca-ES',
  8025. 'co-FR',
  8026. 'cs-CZ',
  8027. 'cy-GB',
  8028. 'da-DK',
  8029. 'de-AT',
  8030. 'de-CH',
  8031. 'de-DE',
  8032. 'de-LI',
  8033. 'de-LU',
  8034. 'dv-MV',
  8035. 'el-GR',
  8036. 'en-AU',
  8037. 'en-BZ',
  8038. 'en-CA',
  8039. 'en-GB',
  8040. 'en-IE',
  8041. 'en-IN',
  8042. 'as-IN', // as-IN must be after en-IN (en in priority if country is IN)
  8043. 'bn-IN', // bn-IN must be after en-IN (en in priority if country is IN)
  8044. 'en-JM',
  8045. 'en-MY',
  8046. 'en-NZ',
  8047. 'en-PH',
  8048. 'en-SG',
  8049. 'en-TT',
  8050. 'en-US',
  8051. 'en-ZA',
  8052. 'en-ZW',
  8053. 'es-AR',
  8054. 'es-BO',
  8055. 'es-CL',
  8056. 'es-CO',
  8057. 'es-CR',
  8058. 'es-DO',
  8059. 'es-EC',
  8060. 'es-ES',
  8061. 'es-GT',
  8062. 'es-HN',
  8063. 'es-MX',
  8064. 'es-NI',
  8065. 'es-PA',
  8066. 'es-PE',
  8067. 'es-PR',
  8068. 'es-PY',
  8069. 'es-SV',
  8070. 'es-US',
  8071. 'es-UY',
  8072. 'es-VE',
  8073. 'et-EE',
  8074. 'eu-ES',
  8075. 'fa-IR',
  8076. 'fi-FI',
  8077. 'fo-FO',
  8078. 'fr-BE',
  8079. 'fr-CA',
  8080. 'fr-CH',
  8081. 'fr-FR',
  8082. 'fr-LU',
  8083. 'fr-MC',
  8084. 'fy-NL',
  8085. 'ga-IE',
  8086. 'gd-GB',
  8087. 'gl-ES',
  8088. 'gu-IN',
  8089. 'he-IL',
  8090. 'hi-IN',
  8091. 'hr-BA',
  8092. 'hr-HR',
  8093. 'hu-HU',
  8094. 'hy-AM',
  8095. 'id-ID',
  8096. 'ig-NG',
  8097. 'ii-CN',
  8098. 'is-IS',
  8099. 'it-CH',
  8100. 'it-IT',
  8101. 'ja-JP',
  8102. 'ka-GE',
  8103. 'kk-KZ',
  8104. 'kl-GL',
  8105. 'km-KH',
  8106. 'kn-IN',
  8107. 'ko-KR',
  8108. 'ky-KG',
  8109. 'lb-LU',
  8110. 'lo-LA',
  8111. 'lt-LT',
  8112. 'lv-LV',
  8113. 'mi-NZ',
  8114. 'mk-MK',
  8115. 'ml-IN',
  8116. 'mn-MN',
  8117. 'mr-IN',
  8118. 'ms-BN',
  8119. 'ms-MY',
  8120. 'mt-MT',
  8121. 'nb-NO',
  8122. 'ne-NP',
  8123. 'nl-BE',
  8124. 'nl-NL',
  8125. 'nn-NO',
  8126. 'oc-FR',
  8127. 'or-IN',
  8128. 'pa-IN',
  8129. 'pl-PL',
  8130. 'ps-AF',
  8131. 'pt-BR',
  8132. 'pt-PT',
  8133. 'rm-CH',
  8134. 'ro-MD',
  8135. 'ro-RO',
  8136. 'ru-RU',
  8137. 'rw-RW',
  8138. 'sa-IN',
  8139. 'se-FI',
  8140. 'se-NO',
  8141. 'se-SE',
  8142. 'si-LK',
  8143. 'sk-SK',
  8144. 'sl-SI',
  8145. 'sq-AL',
  8146. 'sv-FI',
  8147. 'sv-SE',
  8148. 'sw-KE',
  8149. 'ta-IN',
  8150. 'te-IN',
  8151. 'th-TH',
  8152. 'tk-TM',
  8153. 'tn-ZA',
  8154. 'tr-TR',
  8155. 'tt-RU',
  8156. 'ug-CN',
  8157. 'uk-UA',
  8158. 'ur-PK',
  8159. 'vi-VN',
  8160. 'wo-SN',
  8161. 'xh-ZA',
  8162. 'yo-NG',
  8163. 'zh-CN',
  8164. 'zh-HK',
  8165. 'zh-MO',
  8166. 'zh-SG',
  8167. 'zh-TW',
  8168. 'zu-ZA',
  8169. );
  8170. $buildprimarykeytotest = strtolower($countrycode).'-'.strtoupper($countrycode);
  8171. if (in_array($buildprimarykeytotest, $locales)) {
  8172. return strtolower($countrycode).'_'.strtoupper($countrycode);
  8173. }
  8174. if (function_exists('locale_get_primary_language') && function_exists('locale_get_region')) { // Need extension php-intl
  8175. foreach ($locales as $locale) {
  8176. $locale_language = locale_get_primary_language($locale);
  8177. $locale_region = locale_get_region($locale);
  8178. if (strtoupper($countrycode) == $locale_region) {
  8179. //var_dump($locale.' - '.$locale_language.' - '.$locale_region);
  8180. return strtolower($locale_language).'_'.strtoupper($locale_region);
  8181. }
  8182. }
  8183. } else {
  8184. dol_syslog("Warning Exention php-intl is not available", LOG_WARNING);
  8185. }
  8186. return null;
  8187. }
  8188. /**
  8189. * Complete or removed entries into a head array (used to build tabs).
  8190. * For example, with value added by external modules. Such values are declared into $conf->modules_parts['tab'].
  8191. * Or by change using hook completeTabsHead
  8192. *
  8193. * @param Conf $conf Object conf
  8194. * @param Translate $langs Object langs
  8195. * @param object|null $object Object object
  8196. * @param array $head Object head
  8197. * @param int $h New position to fill
  8198. * @param string $type Value for object where objectvalue can be
  8199. * 'thirdparty' to add a tab in third party view
  8200. * 'intervention' to add a tab in intervention view
  8201. * 'supplier_order' to add a tab in supplier order view
  8202. * 'supplier_invoice' to add a tab in supplier invoice view
  8203. * 'invoice' to add a tab in customer invoice view
  8204. * 'order' to add a tab in customer order view
  8205. * 'contract' to add a tabl in contract view
  8206. * 'product' to add a tab in product view
  8207. * 'propal' to add a tab in propal view
  8208. * 'user' to add a tab in user view
  8209. * 'group' to add a tab in group view
  8210. * 'member' to add a tab in fundation member view
  8211. * 'categories_x' to add a tab in category view ('x': type of category (0=product, 1=supplier, 2=customer, 3=member)
  8212. * 'ecm' to add a tab for another ecm view
  8213. * 'stock' to add a tab for warehouse view
  8214. * @param string $mode 'add' to complete head, 'remove' to remove entries
  8215. * @return void
  8216. */
  8217. function complete_head_from_modules($conf, $langs, $object, &$head, &$h, $type, $mode = 'add')
  8218. {
  8219. global $hookmanager, $db;
  8220. if (isset($conf->modules_parts['tabs'][$type]) && is_array($conf->modules_parts['tabs'][$type])) {
  8221. foreach ($conf->modules_parts['tabs'][$type] as $value) {
  8222. $values = explode(':', $value);
  8223. $reg = array();
  8224. if ($mode == 'add' && !preg_match('/^\-/', $values[1])) {
  8225. if (count($values) == 6) {
  8226. // new declaration with permissions:
  8227. // $value='objecttype:+tabname1:Title1:langfile@mymodule:$user->rights->mymodule->read:/mymodule/mynewtab1.php?id=__ID__'
  8228. // $value='objecttype:+tabname1:Title1,class,pathfile,method:langfile@mymodule:$user->rights->mymodule->read:/mymodule/mynewtab1.php?id=__ID__'
  8229. if ($values[0] != $type) {
  8230. continue;
  8231. }
  8232. //var_dump(verifCond($values[4]));
  8233. if (verifCond($values[4])) {
  8234. if ($values[3]) {
  8235. $langs->load($values[3]);
  8236. }
  8237. if (preg_match('/SUBSTITUTION_([^_]+)/i', $values[2], $reg)) {
  8238. $substitutionarray = array();
  8239. complete_substitutions_array($substitutionarray, $langs, $object, array('needforkey'=>$values[2]));
  8240. $label = make_substitutions($reg[1], $substitutionarray);
  8241. } else {
  8242. $labeltemp = explode(',', $values[2]);
  8243. $label = $langs->trans($labeltemp[0]);
  8244. if (!empty($labeltemp[1]) && is_object($object) && !empty($object->id)) {
  8245. dol_include_once($labeltemp[2]);
  8246. $classtoload = $labeltemp[1];
  8247. if (class_exists($classtoload)) {
  8248. $obj = new $classtoload($db);
  8249. $function = $labeltemp[3];
  8250. if ($obj && $function && method_exists($obj, $function)) {
  8251. $nbrec = $obj->$function($object->id, $obj);
  8252. $label .= '<span class="badge marginleftonlyshort">'.$nbrec.'</span>';
  8253. }
  8254. }
  8255. }
  8256. }
  8257. $head[$h][0] = dol_buildpath(preg_replace('/__ID__/i', ((is_object($object) && !empty($object->id)) ? $object->id : ''), $values[5]), 1);
  8258. $head[$h][1] = $label;
  8259. $head[$h][2] = str_replace('+', '', $values[1]);
  8260. $h++;
  8261. }
  8262. } elseif (count($values) == 5) { // deprecated
  8263. dol_syslog('Passing 5 values in tabs module_parts is deprecated. Please update to 6 with permissions.', LOG_WARNING);
  8264. if ($values[0] != $type) {
  8265. continue;
  8266. }
  8267. if ($values[3]) {
  8268. $langs->load($values[3]);
  8269. }
  8270. if (preg_match('/SUBSTITUTION_([^_]+)/i', $values[2], $reg)) {
  8271. $substitutionarray = array();
  8272. complete_substitutions_array($substitutionarray, $langs, $object, array('needforkey'=>$values[2]));
  8273. $label = make_substitutions($reg[1], $substitutionarray);
  8274. } else {
  8275. $label = $langs->trans($values[2]);
  8276. }
  8277. $head[$h][0] = dol_buildpath(preg_replace('/__ID__/i', ((is_object($object) && !empty($object->id)) ? $object->id : ''), $values[4]), 1);
  8278. $head[$h][1] = $label;
  8279. $head[$h][2] = str_replace('+', '', $values[1]);
  8280. $h++;
  8281. }
  8282. } elseif ($mode == 'remove' && preg_match('/^\-/', $values[1])) {
  8283. if ($values[0] != $type) {
  8284. continue;
  8285. }
  8286. $tabname = str_replace('-', '', $values[1]);
  8287. foreach ($head as $key => $val) {
  8288. $condition = (!empty($values[3]) ? verifCond($values[3]) : 1);
  8289. //var_dump($key.' - '.$tabname.' - '.$head[$key][2].' - '.$values[3].' - '.$condition);
  8290. if ($head[$key][2] == $tabname && $condition) {
  8291. unset($head[$key]);
  8292. break;
  8293. }
  8294. }
  8295. }
  8296. }
  8297. }
  8298. // No need to make a return $head. Var is modified as a reference
  8299. if (!empty($hookmanager)) {
  8300. $parameters = array('object' => $object, 'mode' => $mode, 'head' => &$head);
  8301. $reshook = $hookmanager->executeHooks('completeTabsHead', $parameters);
  8302. if ($reshook > 0) { // Hook ask to replace completely the array
  8303. $head = $hookmanager->resArray;
  8304. } else { // Hook
  8305. $head = array_merge($head, $hookmanager->resArray);
  8306. }
  8307. $h = count($head);
  8308. }
  8309. }
  8310. /**
  8311. * Print common footer :
  8312. * conf->global->MAIN_HTML_FOOTER
  8313. * js for switch of menu hider
  8314. * js for conf->global->MAIN_GOOGLE_AN_ID
  8315. * js for conf->global->MAIN_SHOW_TUNING_INFO or $_SERVER["MAIN_SHOW_TUNING_INFO"]
  8316. * js for conf->logbuffer
  8317. *
  8318. * @param string $zone 'private' (for private pages) or 'public' (for public pages)
  8319. * @return void
  8320. */
  8321. function printCommonFooter($zone = 'private')
  8322. {
  8323. global $conf, $hookmanager, $user, $debugbar;
  8324. global $action;
  8325. global $micro_start_time;
  8326. if ($zone == 'private') {
  8327. print "\n".'<!-- Common footer for private page -->'."\n";
  8328. } else {
  8329. print "\n".'<!-- Common footer for public page -->'."\n";
  8330. }
  8331. // A div to store page_y POST parameter so we can read it using javascript
  8332. print "\n<!-- A div to store page_y POST parameter -->\n";
  8333. print '<div id="page_y" style="display: none;">'.(GETPOST('page_y') ? GETPOST('page_y') : '').'</div>'."\n";
  8334. $parameters = array();
  8335. $reshook = $hookmanager->executeHooks('printCommonFooter', $parameters); // Note that $action and $object may have been modified by some hooks
  8336. if (empty($reshook)) {
  8337. if (!empty($conf->global->MAIN_HTML_FOOTER)) {
  8338. print $conf->global->MAIN_HTML_FOOTER."\n";
  8339. }
  8340. print "\n";
  8341. if (!empty($conf->use_javascript_ajax)) {
  8342. print '<script>'."\n";
  8343. print 'jQuery(document).ready(function() {'."\n";
  8344. if ($zone == 'private' && empty($conf->dol_use_jmobile)) {
  8345. print "\n";
  8346. print '/* JS CODE TO ENABLE to manage handler to switch left menu page (menuhider) */'."\n";
  8347. print 'jQuery("li.menuhider").click(function(event) {';
  8348. print ' if (!$( "body" ).hasClass( "sidebar-collapse" )){ event.preventDefault(); }'."\n";
  8349. print ' console.log("We click on .menuhider");'."\n";
  8350. print ' $("body").toggleClass("sidebar-collapse")'."\n";
  8351. print '});'."\n";
  8352. }
  8353. // Management of focus and mandatory for fields
  8354. if ($action == 'create' || $action == 'edit' || (empty($action) && (preg_match('/new\.php/', $_SERVER["PHP_SELF"])))) {
  8355. print '/* JS CODE TO ENABLE to manage focus and mandatory form fields */'."\n";
  8356. $relativepathstring = $_SERVER["PHP_SELF"];
  8357. // Clean $relativepathstring
  8358. if (constant('DOL_URL_ROOT')) {
  8359. $relativepathstring = preg_replace('/^'.preg_quote(constant('DOL_URL_ROOT'), '/').'/', '', $relativepathstring);
  8360. }
  8361. $relativepathstring = preg_replace('/^\//', '', $relativepathstring);
  8362. $relativepathstring = preg_replace('/^custom\//', '', $relativepathstring);
  8363. //$tmpqueryarraywehave = explode('&', dol_string_nohtmltag($_SERVER['QUERY_STRING']));
  8364. if (!empty($user->default_values[$relativepathstring]['focus'])) {
  8365. foreach ($user->default_values[$relativepathstring]['focus'] as $defkey => $defval) {
  8366. $qualified = 0;
  8367. if ($defkey != '_noquery_') {
  8368. $tmpqueryarraytohave = explode('&', $defkey);
  8369. $foundintru = 0;
  8370. foreach ($tmpqueryarraytohave as $tmpquerytohave) {
  8371. $tmpquerytohaveparam = explode('=', $tmpquerytohave);
  8372. //print "console.log('".$tmpquerytohaveparam[0]." ".$tmpquerytohaveparam[1]." ".GETPOST($tmpquerytohaveparam[0])."');";
  8373. if (!GETPOSTISSET($tmpquerytohaveparam[0]) || ($tmpquerytohaveparam[1] != GETPOST($tmpquerytohaveparam[0]))) {
  8374. $foundintru = 1;
  8375. }
  8376. }
  8377. if (!$foundintru) {
  8378. $qualified = 1;
  8379. }
  8380. //var_dump($defkey.'-'.$qualified);
  8381. } else {
  8382. $qualified = 1;
  8383. }
  8384. if ($qualified) {
  8385. foreach ($defval as $paramkey => $paramval) {
  8386. // Set focus on field
  8387. print 'jQuery("input[name=\''.$paramkey.'\']").focus();'."\n";
  8388. print 'jQuery("textarea[name=\''.$paramkey.'\']").focus();'."\n";
  8389. print 'jQuery("select[name=\''.$paramkey.'\']").focus();'."\n"; // Not really usefull, but we keep it in case of.
  8390. }
  8391. }
  8392. }
  8393. }
  8394. if (!empty($user->default_values[$relativepathstring]['mandatory'])) {
  8395. foreach ($user->default_values[$relativepathstring]['mandatory'] as $defkey => $defval) {
  8396. $qualified = 0;
  8397. if ($defkey != '_noquery_') {
  8398. $tmpqueryarraytohave = explode('&', $defkey);
  8399. $foundintru = 0;
  8400. foreach ($tmpqueryarraytohave as $tmpquerytohave) {
  8401. $tmpquerytohaveparam = explode('=', $tmpquerytohave);
  8402. //print "console.log('".$tmpquerytohaveparam[0]." ".$tmpquerytohaveparam[1]." ".GETPOST($tmpquerytohaveparam[0])."');";
  8403. if (!GETPOSTISSET($tmpquerytohaveparam[0]) || ($tmpquerytohaveparam[1] != GETPOST($tmpquerytohaveparam[0]))) {
  8404. $foundintru = 1;
  8405. }
  8406. }
  8407. if (!$foundintru) {
  8408. $qualified = 1;
  8409. }
  8410. //var_dump($defkey.'-'.$qualified);
  8411. } else {
  8412. $qualified = 1;
  8413. }
  8414. if ($qualified) {
  8415. foreach ($defval as $paramkey => $paramval) {
  8416. // Add property 'required' on input
  8417. print 'jQuery("input[name=\''.$paramkey.'\']").prop(\'required\',true);'."\n";
  8418. print 'jQuery("textarea[name=\''.$paramkey.'\']").prop(\'required\',true);'."\n";
  8419. print '// required on a select works only if key is "", so we add the required attributes but also we reset the key -1 or 0 to an empty string'."\n";
  8420. print 'jQuery("select[name=\''.$paramkey.'\']").prop(\'required\',true);'."\n";
  8421. print 'jQuery("select[name=\''.$paramkey.'\'] option[value=\'-1\']").prop(\'value\', \'\');'."\n";
  8422. print 'jQuery("select[name=\''.$paramkey.'\'] option[value=\'0\']").prop(\'value\', \'\');'."\n";
  8423. // Add 'field required' class on closest td for all input elements : input, textarea and select
  8424. print 'jQuery(":input[name=\'' . $paramkey . '\']").closest("tr").find("td:first").addClass("fieldrequired");' . "\n";
  8425. }
  8426. }
  8427. }
  8428. }
  8429. }
  8430. print '});'."\n";
  8431. // End of tuning
  8432. if (!empty($_SERVER['MAIN_SHOW_TUNING_INFO']) || !empty($conf->global->MAIN_SHOW_TUNING_INFO)) {
  8433. print "\n";
  8434. print "/* JS CODE TO ENABLE to add memory info */\n";
  8435. print 'window.console && console.log("';
  8436. if (!empty($conf->global->MEMCACHED_SERVER)) {
  8437. print 'MEMCACHED_SERVER='.$conf->global->MEMCACHED_SERVER.' - ';
  8438. }
  8439. print 'MAIN_OPTIMIZE_SPEED='.(isset($conf->global->MAIN_OPTIMIZE_SPEED) ? $conf->global->MAIN_OPTIMIZE_SPEED : 'off');
  8440. if (!empty($micro_start_time)) { // Works only if MAIN_SHOW_TUNING_INFO is defined at $_SERVER level. Not in global variable.
  8441. $micro_end_time = microtime(true);
  8442. print ' - Build time: '.ceil(1000 * ($micro_end_time - $micro_start_time)).' ms';
  8443. }
  8444. if (function_exists("memory_get_usage")) {
  8445. print ' - Mem: '.memory_get_usage(); // Do not use true here, it seems it takes the peak amount
  8446. }
  8447. if (function_exists("memory_get_peak_usage")) {
  8448. print ' - Real mem peak: '.memory_get_peak_usage(true);
  8449. }
  8450. if (function_exists("zend_loader_file_encoded")) {
  8451. print ' - Zend encoded file: '.(zend_loader_file_encoded() ? 'yes' : 'no');
  8452. }
  8453. print '");'."\n";
  8454. }
  8455. print "\n".'</script>'."\n";
  8456. // Google Analytics
  8457. // TODO Add a hook here
  8458. if (!empty($conf->google->enabled) && !empty($conf->global->MAIN_GOOGLE_AN_ID)) {
  8459. $tmptagarray = explode(',', $conf->global->MAIN_GOOGLE_AN_ID);
  8460. foreach ($tmptagarray as $tmptag) {
  8461. print "\n";
  8462. print "<!-- JS CODE TO ENABLE for google analtics tag -->\n";
  8463. print "
  8464. <!-- Global site tag (gtag.js) - Google Analytics -->
  8465. <script async src=\"https://www.googletagmanager.com/gtag/js?id=".trim($tmptag)."\"></script>
  8466. <script>
  8467. window.dataLayer = window.dataLayer || [];
  8468. function gtag(){dataLayer.push(arguments);}
  8469. gtag('js', new Date());
  8470. gtag('config', '".trim($tmptag)."');
  8471. </script>";
  8472. print "\n";
  8473. }
  8474. }
  8475. }
  8476. // Add Xdebug coverage of code
  8477. if (defined('XDEBUGCOVERAGE')) {
  8478. print_r(xdebug_get_code_coverage());
  8479. }
  8480. // Add DebugBar data
  8481. if (!empty($user->rights->debugbar->read) && is_object($debugbar)) {
  8482. $debugbar['time']->stopMeasure('pageaftermaster');
  8483. print '<!-- Output debugbar data -->'."\n";
  8484. $renderer = $debugbar->getRenderer();
  8485. print $debugbar->getRenderer()->render();
  8486. } elseif (count($conf->logbuffer)) { // If there is some logs in buffer to show
  8487. print "\n";
  8488. print "<!-- Start of log output\n";
  8489. //print '<div class="hidden">'."\n";
  8490. foreach ($conf->logbuffer as $logline) {
  8491. print $logline."<br>\n";
  8492. }
  8493. //print '</div>'."\n";
  8494. print "End of log output -->\n";
  8495. }
  8496. }
  8497. }
  8498. /**
  8499. * Split a string with 2 keys into key array.
  8500. * For example: "A=1;B=2;C=2" is exploded into array('A'=>1,'B'=>2,'C'=>3)
  8501. *
  8502. * @param string $string String to explode
  8503. * @param string $delimiter Delimiter between each couple of data
  8504. * @param string $kv Delimiter between key and value
  8505. * @return array Array of data exploded
  8506. */
  8507. function dolExplodeIntoArray($string, $delimiter = ';', $kv = '=')
  8508. {
  8509. if ($a = explode($delimiter, $string)) {
  8510. $ka = array();
  8511. foreach ($a as $s) { // each part
  8512. if ($s) {
  8513. if ($pos = strpos($s, $kv)) { // key/value delimiter
  8514. $ka[trim(substr($s, 0, $pos))] = trim(substr($s, $pos + strlen($kv)));
  8515. } else { // key delimiter not found
  8516. $ka[] = trim($s);
  8517. }
  8518. }
  8519. }
  8520. return $ka;
  8521. }
  8522. return array();
  8523. }
  8524. /**
  8525. * Set focus onto field with selector (similar behaviour of 'autofocus' HTML5 tag)
  8526. *
  8527. * @param string $selector Selector ('#id' or 'input[name="ref"]') to use to find the HTML input field that must get the autofocus. You must use a CSS selector, so unique id preceding with the '#' char.
  8528. * @return void
  8529. */
  8530. function dol_set_focus($selector)
  8531. {
  8532. print "\n".'<!-- Set focus onto a specific field -->'."\n";
  8533. print '<script>jQuery(document).ready(function() { jQuery("'.dol_escape_js($selector).'").focus(); });</script>'."\n";
  8534. }
  8535. /**
  8536. * Return getmypid() or random PID when function is disabled
  8537. * Some web hosts disable this php function for security reasons
  8538. * and sometimes we can't redeclare function
  8539. *
  8540. * @return int
  8541. */
  8542. function dol_getmypid()
  8543. {
  8544. if (!function_exists('getmypid')) {
  8545. return mt_rand(1, 32768);
  8546. } else {
  8547. return getmypid();
  8548. }
  8549. }
  8550. /**
  8551. * Generate natural SQL search string for a criteria (this criteria can be tested on one or several fields)
  8552. *
  8553. * @param string|string[] $fields String or array of strings, filled with the name of all fields in the SQL query we must check (combined with a OR). Example: array("p.field1","p.field2")
  8554. * @param string $value The value to look for.
  8555. * If param $mode is 0, can contains several keywords separated with a space or |
  8556. * like "keyword1 keyword2" = We want record field like keyword1 AND field like keyword2
  8557. * or like "keyword1|keyword2" = We want record field like keyword1 OR field like keyword2
  8558. * If param $mode is 1, can contains an operator <, > or = like "<10" or ">=100.5 < 1000"
  8559. * If param $mode is 2, can contains a list of int id separated by comma like "1,3,4"
  8560. * If param $mode is 3, can contains a list of string separated by comma like "a,b,c"
  8561. * @param integer $mode 0=value is list of keyword strings, 1=value is a numeric test (Example ">5.5 <10"), 2=value is a list of ID separated with comma (Example '1,3,4')
  8562. * 3=value is list of string separated with comma (Example 'text 1,text 2'), 4=value is a list of ID separated with comma (Example '2,7') to be used to search into a multiselect string '1,2,3,4'
  8563. * @param integer $nofirstand 1=Do not output the first 'AND'
  8564. * @return string $res The statement to append to the SQL query
  8565. * @see dolSqlDateFilter()
  8566. */
  8567. function natural_search($fields, $value, $mode = 0, $nofirstand = 0)
  8568. {
  8569. global $db, $langs;
  8570. $value = trim($value);
  8571. if ($mode == 0) {
  8572. $value = preg_replace('/\*/', '%', $value); // Replace * with %
  8573. }
  8574. if ($mode == 1) {
  8575. $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
  8576. }
  8577. $value = preg_replace('/\s*\|\s*/', '|', $value);
  8578. $crits = explode(' ', $value);
  8579. $res = '';
  8580. if (!is_array($fields)) {
  8581. $fields = array($fields);
  8582. }
  8583. $j = 0;
  8584. foreach ($crits as $crit) {
  8585. $crit = trim($crit);
  8586. $i = 0;
  8587. $i2 = 0;
  8588. $newres = '';
  8589. foreach ($fields as $field) {
  8590. if ($mode == 1) {
  8591. $operator = '=';
  8592. $newcrit = preg_replace('/([<>=]+)/', '', $crit);
  8593. $reg = array();
  8594. preg_match('/([<>=]+)/', $crit, $reg);
  8595. if (!empty($reg[1])) {
  8596. $operator = $reg[1];
  8597. }
  8598. if ($newcrit != '') {
  8599. $numnewcrit = price2num($newcrit);
  8600. if (is_numeric($numnewcrit)) {
  8601. $newres .= ($i2 > 0 ? ' OR ' : '').$field.' '.$operator.' '.((float) $numnewcrit); // should be a numeric
  8602. } else {
  8603. $newres .= ($i2 > 0 ? ' OR ' : '').'1 = 2'; // force false
  8604. }
  8605. $i2++; // a criteria was added to string
  8606. }
  8607. } elseif ($mode == 2 || $mode == -2) {
  8608. $crit = preg_replace('/[^0-9,]/', '', $crit); // ID are always integer
  8609. $newres .= ($i2 > 0 ? ' OR ' : '').$field." ".($mode == -2 ? 'NOT ' : '');
  8610. $newres .= $crit ? "IN (".$db->sanitize($db->escape($crit)).")" : "IN (0)";
  8611. if ($mode == -2) {
  8612. $newres .= ' OR '.$field.' IS NULL';
  8613. }
  8614. $i2++; // a criteria was added to string
  8615. } elseif ($mode == 3 || $mode == -3) {
  8616. $tmparray = explode(',', $crit);
  8617. if (count($tmparray)) {
  8618. $listofcodes = '';
  8619. foreach ($tmparray as $val) {
  8620. $val = trim($val);
  8621. if ($val) {
  8622. $listofcodes .= ($listofcodes ? ',' : '');
  8623. $listofcodes .= "'".$db->escape($val)."'";
  8624. }
  8625. }
  8626. $newres .= ($i2 > 0 ? ' OR ' : '').$field." ".($mode == -3 ? 'NOT ' : '')."IN (".$db->sanitize($listofcodes, 1).")";
  8627. $i2++; // a criteria was added to string
  8628. }
  8629. if ($mode == -3) {
  8630. $newres .= ' OR '.$field.' IS NULL';
  8631. }
  8632. } elseif ($mode == 4) {
  8633. $tmparray = explode(',', $crit);
  8634. if (count($tmparray)) {
  8635. $listofcodes = '';
  8636. foreach ($tmparray as $val) {
  8637. $val = trim($val);
  8638. if ($val) {
  8639. $newres .= ($i2 > 0 ? " OR (" : "(").$field." LIKE '".$db->escape($val).",%'";
  8640. $newres .= ' OR '.$field." = '".$db->escape($val)."'";
  8641. $newres .= ' OR '.$field." LIKE '%,".$db->escape($val)."'";
  8642. $newres .= ' OR '.$field." LIKE '%,".$db->escape($val).",%'";
  8643. $newres .= ')';
  8644. $i2++;
  8645. }
  8646. }
  8647. }
  8648. } else // $mode=0
  8649. {
  8650. $tmpcrits = explode('|', $crit);
  8651. $i3 = 0;
  8652. foreach ($tmpcrits as $tmpcrit) {
  8653. if ($tmpcrit !== '0' && empty($tmpcrit)) {
  8654. continue;
  8655. }
  8656. $newres .= (($i2 > 0 || $i3 > 0) ? ' OR ' : '');
  8657. if (preg_match('/\.(id|rowid)$/', $field)) { // Special case for rowid that is sometimes a ref so used as a search field
  8658. $newres .= $field." = ".(is_numeric(trim($tmpcrit)) ? ((float) trim($tmpcrit)) : '0');
  8659. } else {
  8660. $tmpcrit = trim($tmpcrit);
  8661. $tmpcrit2 = $tmpcrit;
  8662. $tmpbefore = '%';
  8663. $tmpafter = '%';
  8664. if (preg_match('/^!/', $tmpcrit)) {
  8665. $newres .= $field." NOT LIKE '"; // ! as exclude character
  8666. $tmpcrit2 = preg_replace('/^!/', '', $tmpcrit2);
  8667. } else $newres .= $field." LIKE '";
  8668. if (preg_match('/^[\^\$]/', $tmpcrit)) {
  8669. $tmpbefore = '';
  8670. $tmpcrit2 = preg_replace('/^[\^\$]/', '', $tmpcrit2);
  8671. }
  8672. if (preg_match('/[\^\$]$/', $tmpcrit)) {
  8673. $tmpafter = '';
  8674. $tmpcrit2 = preg_replace('/[\^\$]$/', '', $tmpcrit2);
  8675. }
  8676. $newres .= $tmpbefore;
  8677. $newres .= $db->escape($tmpcrit2);
  8678. $newres .= $tmpafter;
  8679. $newres .= "'";
  8680. if ($tmpcrit2 == '') {
  8681. $newres .= " OR ".$field." IS NULL";
  8682. }
  8683. }
  8684. $i3++;
  8685. }
  8686. $i2++; // a criteria was added to string
  8687. }
  8688. $i++;
  8689. }
  8690. if ($newres) {
  8691. $res = $res.($res ? ' AND ' : '').($i2 > 1 ? '(' : '').$newres.($i2 > 1 ? ')' : '');
  8692. }
  8693. $j++;
  8694. }
  8695. $res = ($nofirstand ? "" : " AND ")."(".$res.")";
  8696. //print 'xx'.$res.'yy';
  8697. return $res;
  8698. }
  8699. /**
  8700. * Return string with full Url. The file qualified is the one defined by relative path in $object->last_main_doc
  8701. *
  8702. * @param Object $object Object
  8703. * @return string Url string
  8704. */
  8705. function showDirectDownloadLink($object)
  8706. {
  8707. global $conf, $langs;
  8708. $out = '';
  8709. $url = $object->getLastMainDocLink($object->element);
  8710. $out .= img_picto($langs->trans("PublicDownloadLinkDesc"), 'globe').' <span class="opacitymedium">'.$langs->trans("DirectDownloadLink").'</span><br>';
  8711. if ($url) {
  8712. $out .= '<div class="urllink"><input type="text" id="directdownloadlink" class="quatrevingtpercent" value="'.$url.'"></div>';
  8713. $out .= ajax_autoselect("directdownloadlink", 0);
  8714. } else {
  8715. $out .= '<div class="urllink">'.$langs->trans("FileNotShared").'</div>';
  8716. }
  8717. return $out;
  8718. }
  8719. /**
  8720. * Return the filename of file to get the thumbs
  8721. *
  8722. * @param string $file Original filename (full or relative path)
  8723. * @param string $extName Extension to differenciate thumb file name ('', '_small', '_mini')
  8724. * @param string $extImgTarget Force image extension for thumbs. Use '' to keep same extension than original image (default).
  8725. * @return string New file name (full or relative path, including the thumbs/)
  8726. */
  8727. function getImageFileNameForSize($file, $extName, $extImgTarget = '')
  8728. {
  8729. $dirName = dirname($file);
  8730. if ($dirName == '.') {
  8731. $dirName = '';
  8732. }
  8733. $fileName = preg_replace('/(\.gif|\.jpeg|\.jpg|\.png|\.bmp|\.webp)$/i', '', $file); // We remove extension, whatever is its case
  8734. $fileName = basename($fileName);
  8735. if (empty($extImgTarget)) {
  8736. $extImgTarget = (preg_match('/\.jpg$/i', $file) ? '.jpg' : '');
  8737. }
  8738. if (empty($extImgTarget)) {
  8739. $extImgTarget = (preg_match('/\.jpeg$/i', $file) ? '.jpeg' : '');
  8740. }
  8741. if (empty($extImgTarget)) {
  8742. $extImgTarget = (preg_match('/\.gif$/i', $file) ? '.gif' : '');
  8743. }
  8744. if (empty($extImgTarget)) {
  8745. $extImgTarget = (preg_match('/\.png$/i', $file) ? '.png' : '');
  8746. }
  8747. if (empty($extImgTarget)) {
  8748. $extImgTarget = (preg_match('/\.bmp$/i', $file) ? '.bmp' : '');
  8749. }
  8750. if (empty($extImgTarget)) {
  8751. $extImgTarget = (preg_match('/\.webp$/i', $file) ? '.webp' : '');
  8752. }
  8753. if (!$extImgTarget) {
  8754. return $file;
  8755. }
  8756. $subdir = '';
  8757. if ($extName) {
  8758. $subdir = 'thumbs/';
  8759. }
  8760. return ($dirName ? $dirName.'/' : '').$subdir.$fileName.$extName.$extImgTarget; // New filename for thumb
  8761. }
  8762. /**
  8763. * Return URL we can use for advanced preview links
  8764. *
  8765. * @param string $modulepart propal, facture, facture_fourn, ...
  8766. * @param string $relativepath Relative path of docs.
  8767. * @param int $alldata Return array with all components (1 is recommended, then use a simple a href link with the class, target and mime attribute added. 'documentpreview' css class is handled by jquery code into main.inc.php)
  8768. * @param string $param More param on http links
  8769. * @return string|array Output string with href link or array with all components of link
  8770. */
  8771. function getAdvancedPreviewUrl($modulepart, $relativepath, $alldata = 0, $param = '')
  8772. {
  8773. global $conf, $langs;
  8774. if (empty($conf->use_javascript_ajax)) {
  8775. return '';
  8776. }
  8777. $isAllowedForPreview = dolIsAllowedForPreview($relativepath);
  8778. if ($alldata == 1) {
  8779. if ($isAllowedForPreview) {
  8780. return array('target'=>'_blank', 'css'=>'documentpreview', 'url'=>DOL_URL_ROOT.'/document.php?modulepart='.$modulepart.'&attachment=0&file='.urlencode($relativepath).($param ? '&'.$param : ''), 'mime'=>dol_mimetype($relativepath));
  8781. } else {
  8782. return array();
  8783. }
  8784. }
  8785. // old behavior, return a string
  8786. if ($isAllowedForPreview) {
  8787. return 'javascript:document_preview(\''.dol_escape_js(DOL_URL_ROOT.'/document.php?modulepart='.$modulepart.'&attachment=0&file='.urlencode($relativepath).($param ? '&'.$param : '')).'\', \''.dol_mimetype($relativepath).'\', \''.dol_escape_js($langs->trans('Preview')).'\')';
  8788. } else {
  8789. return '';
  8790. }
  8791. }
  8792. /**
  8793. * Make content of an input box selected when we click into input field.
  8794. *
  8795. * @param string $htmlname Id of html object ('#idvalue' or '.classvalue')
  8796. * @param string $addlink Add a 'link to' after
  8797. * @param string $textonlink Text to show on link or 'image'
  8798. * @return string
  8799. */
  8800. function ajax_autoselect($htmlname, $addlink = '', $textonlink = 'Link')
  8801. {
  8802. global $langs;
  8803. $out = '<script>
  8804. jQuery(document).ready(function () {
  8805. jQuery("'.((strpos($htmlname, '.') === 0 ? '' : '#').$htmlname).'").click(function() { jQuery(this).select(); } );
  8806. });
  8807. </script>';
  8808. if ($addlink) {
  8809. if ($textonlink === 'image') {
  8810. $out .= ' <a href="'.$addlink.'" target="_blank" rel="noopener noreferrer">'.img_picto('', 'globe').'</a>';
  8811. } else {
  8812. $out .= ' <a href="'.$addlink.'" target="_blank" rel="noopener noreferrer">'.$langs->trans("Link").'</a>';
  8813. }
  8814. }
  8815. return $out;
  8816. }
  8817. /**
  8818. * Return if a file is qualified for preview
  8819. *
  8820. * @param string $file Filename we looking for information
  8821. * @return int 1 If allowed, 0 otherwise
  8822. * @see dol_mimetype(), image_format_supported() from images.lib.php
  8823. */
  8824. function dolIsAllowedForPreview($file)
  8825. {
  8826. global $conf;
  8827. // Check .noexe extension in filename
  8828. if (preg_match('/\.noexe$/i', $file)) {
  8829. return 0;
  8830. }
  8831. // Check mime types
  8832. $mime_preview = array('bmp', 'jpeg', 'png', 'gif', 'tiff', 'pdf', 'plain', 'css', 'webp');
  8833. if (!empty($conf->global->MAIN_ALLOW_SVG_FILES_AS_IMAGES)) {
  8834. $mime_preview[] = 'svg+xml';
  8835. }
  8836. //$mime_preview[]='vnd.oasis.opendocument.presentation';
  8837. //$mime_preview[]='archive';
  8838. $num_mime = array_search(dol_mimetype($file, '', 1), $mime_preview);
  8839. if ($num_mime !== false) {
  8840. return 1;
  8841. }
  8842. // By default, not allowed for preview
  8843. return 0;
  8844. }
  8845. /**
  8846. * Return MIME type of a file from its name with extension.
  8847. *
  8848. * @param string $file Filename we looking for MIME type
  8849. * @param string $default Default mime type if extension not found in known list
  8850. * @param int $mode 0=Return full mime, 1=otherwise short mime string, 2=image for mime type, 3=source language, 4=css of font fa
  8851. * @return string Return a mime type family (text/xxx, application/xxx, image/xxx, audio, video, archive)
  8852. * @see dolIsAllowedForPreview(), image_format_supported() from images.lib.php
  8853. */
  8854. function dol_mimetype($file, $default = 'application/octet-stream', $mode = 0)
  8855. {
  8856. $mime = $default;
  8857. $imgmime = 'other.png';
  8858. $famime = 'file-o';
  8859. $srclang = '';
  8860. $tmpfile = preg_replace('/\.noexe$/', '', $file);
  8861. // Plain text files
  8862. if (preg_match('/\.txt$/i', $tmpfile)) {
  8863. $mime = 'text/plain';
  8864. $imgmime = 'text.png';
  8865. $famime = 'file-text-o';
  8866. }
  8867. if (preg_match('/\.rtx$/i', $tmpfile)) {
  8868. $mime = 'text/richtext';
  8869. $imgmime = 'text.png';
  8870. $famime = 'file-text-o';
  8871. }
  8872. if (preg_match('/\.csv$/i', $tmpfile)) {
  8873. $mime = 'text/csv';
  8874. $imgmime = 'text.png';
  8875. $famime = 'file-text-o';
  8876. }
  8877. if (preg_match('/\.tsv$/i', $tmpfile)) {
  8878. $mime = 'text/tab-separated-values';
  8879. $imgmime = 'text.png';
  8880. $famime = 'file-text-o';
  8881. }
  8882. if (preg_match('/\.(cf|conf|log)$/i', $tmpfile)) {
  8883. $mime = 'text/plain';
  8884. $imgmime = 'text.png';
  8885. $famime = 'file-text-o';
  8886. }
  8887. if (preg_match('/\.ini$/i', $tmpfile)) {
  8888. $mime = 'text/plain';
  8889. $imgmime = 'text.png';
  8890. $srclang = 'ini';
  8891. $famime = 'file-text-o';
  8892. }
  8893. if (preg_match('/\.md$/i', $tmpfile)) {
  8894. $mime = 'text/plain';
  8895. $imgmime = 'text.png';
  8896. $srclang = 'md';
  8897. $famime = 'file-text-o';
  8898. }
  8899. if (preg_match('/\.css$/i', $tmpfile)) {
  8900. $mime = 'text/css';
  8901. $imgmime = 'css.png';
  8902. $srclang = 'css';
  8903. $famime = 'file-text-o';
  8904. }
  8905. if (preg_match('/\.lang$/i', $tmpfile)) {
  8906. $mime = 'text/plain';
  8907. $imgmime = 'text.png';
  8908. $srclang = 'lang';
  8909. $famime = 'file-text-o';
  8910. }
  8911. // Certificate files
  8912. if (preg_match('/\.(crt|cer|key|pub)$/i', $tmpfile)) {
  8913. $mime = 'text/plain';
  8914. $imgmime = 'text.png';
  8915. $famime = 'file-text-o';
  8916. }
  8917. // XML based (HTML/XML/XAML)
  8918. if (preg_match('/\.(html|htm|shtml)$/i', $tmpfile)) {
  8919. $mime = 'text/html';
  8920. $imgmime = 'html.png';
  8921. $srclang = 'html';
  8922. $famime = 'file-text-o';
  8923. }
  8924. if (preg_match('/\.(xml|xhtml)$/i', $tmpfile)) {
  8925. $mime = 'text/xml';
  8926. $imgmime = 'other.png';
  8927. $srclang = 'xml';
  8928. $famime = 'file-text-o';
  8929. }
  8930. if (preg_match('/\.xaml$/i', $tmpfile)) {
  8931. $mime = 'text/xml';
  8932. $imgmime = 'other.png';
  8933. $srclang = 'xaml';
  8934. $famime = 'file-text-o';
  8935. }
  8936. // Languages
  8937. if (preg_match('/\.bas$/i', $tmpfile)) {
  8938. $mime = 'text/plain';
  8939. $imgmime = 'text.png';
  8940. $srclang = 'bas';
  8941. $famime = 'file-code-o';
  8942. }
  8943. if (preg_match('/\.(c)$/i', $tmpfile)) {
  8944. $mime = 'text/plain';
  8945. $imgmime = 'text.png';
  8946. $srclang = 'c';
  8947. $famime = 'file-code-o';
  8948. }
  8949. if (preg_match('/\.(cpp)$/i', $tmpfile)) {
  8950. $mime = 'text/plain';
  8951. $imgmime = 'text.png';
  8952. $srclang = 'cpp';
  8953. $famime = 'file-code-o';
  8954. }
  8955. if (preg_match('/\.cs$/i', $tmpfile)) {
  8956. $mime = 'text/plain';
  8957. $imgmime = 'text.png';
  8958. $srclang = 'cs';
  8959. $famime = 'file-code-o';
  8960. }
  8961. if (preg_match('/\.(h)$/i', $tmpfile)) {
  8962. $mime = 'text/plain';
  8963. $imgmime = 'text.png';
  8964. $srclang = 'h';
  8965. $famime = 'file-code-o';
  8966. }
  8967. if (preg_match('/\.(java|jsp)$/i', $tmpfile)) {
  8968. $mime = 'text/plain';
  8969. $imgmime = 'text.png';
  8970. $srclang = 'java';
  8971. $famime = 'file-code-o';
  8972. }
  8973. if (preg_match('/\.php([0-9]{1})?$/i', $tmpfile)) {
  8974. $mime = 'text/plain';
  8975. $imgmime = 'php.png';
  8976. $srclang = 'php';
  8977. $famime = 'file-code-o';
  8978. }
  8979. if (preg_match('/\.phtml$/i', $tmpfile)) {
  8980. $mime = 'text/plain';
  8981. $imgmime = 'php.png';
  8982. $srclang = 'php';
  8983. $famime = 'file-code-o';
  8984. }
  8985. if (preg_match('/\.(pl|pm)$/i', $tmpfile)) {
  8986. $mime = 'text/plain';
  8987. $imgmime = 'pl.png';
  8988. $srclang = 'perl';
  8989. $famime = 'file-code-o';
  8990. }
  8991. if (preg_match('/\.sql$/i', $tmpfile)) {
  8992. $mime = 'text/plain';
  8993. $imgmime = 'text.png';
  8994. $srclang = 'sql';
  8995. $famime = 'file-code-o';
  8996. }
  8997. if (preg_match('/\.js$/i', $tmpfile)) {
  8998. $mime = 'text/x-javascript';
  8999. $imgmime = 'jscript.png';
  9000. $srclang = 'js';
  9001. $famime = 'file-code-o';
  9002. }
  9003. // Open office
  9004. if (preg_match('/\.odp$/i', $tmpfile)) {
  9005. $mime = 'application/vnd.oasis.opendocument.presentation';
  9006. $imgmime = 'ooffice.png';
  9007. $famime = 'file-powerpoint-o';
  9008. }
  9009. if (preg_match('/\.ods$/i', $tmpfile)) {
  9010. $mime = 'application/vnd.oasis.opendocument.spreadsheet';
  9011. $imgmime = 'ooffice.png';
  9012. $famime = 'file-excel-o';
  9013. }
  9014. if (preg_match('/\.odt$/i', $tmpfile)) {
  9015. $mime = 'application/vnd.oasis.opendocument.text';
  9016. $imgmime = 'ooffice.png';
  9017. $famime = 'file-word-o';
  9018. }
  9019. // MS Office
  9020. if (preg_match('/\.mdb$/i', $tmpfile)) {
  9021. $mime = 'application/msaccess';
  9022. $imgmime = 'mdb.png';
  9023. $famime = 'file-o';
  9024. }
  9025. if (preg_match('/\.doc(x|m)?$/i', $tmpfile)) {
  9026. $mime = 'application/msword';
  9027. $imgmime = 'doc.png';
  9028. $famime = 'file-word-o';
  9029. }
  9030. if (preg_match('/\.dot(x|m)?$/i', $tmpfile)) {
  9031. $mime = 'application/msword';
  9032. $imgmime = 'doc.png';
  9033. $famime = 'file-word-o';
  9034. }
  9035. if (preg_match('/\.xlt(x)?$/i', $tmpfile)) {
  9036. $mime = 'application/vnd.ms-excel';
  9037. $imgmime = 'xls.png';
  9038. $famime = 'file-excel-o';
  9039. }
  9040. if (preg_match('/\.xla(m)?$/i', $tmpfile)) {
  9041. $mime = 'application/vnd.ms-excel';
  9042. $imgmime = 'xls.png';
  9043. $famime = 'file-excel-o';
  9044. }
  9045. if (preg_match('/\.xls$/i', $tmpfile)) {
  9046. $mime = 'application/vnd.ms-excel';
  9047. $imgmime = 'xls.png';
  9048. $famime = 'file-excel-o';
  9049. }
  9050. if (preg_match('/\.xls(b|m|x)$/i', $tmpfile)) {
  9051. $mime = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet';
  9052. $imgmime = 'xls.png';
  9053. $famime = 'file-excel-o';
  9054. }
  9055. if (preg_match('/\.pps(m|x)?$/i', $tmpfile)) {
  9056. $mime = 'application/vnd.ms-powerpoint';
  9057. $imgmime = 'ppt.png';
  9058. $famime = 'file-powerpoint-o';
  9059. }
  9060. if (preg_match('/\.ppt(m|x)?$/i', $tmpfile)) {
  9061. $mime = 'application/x-mspowerpoint';
  9062. $imgmime = 'ppt.png';
  9063. $famime = 'file-powerpoint-o';
  9064. }
  9065. // Other
  9066. if (preg_match('/\.pdf$/i', $tmpfile)) {
  9067. $mime = 'application/pdf';
  9068. $imgmime = 'pdf.png';
  9069. $famime = 'file-pdf-o';
  9070. }
  9071. // Scripts
  9072. if (preg_match('/\.bat$/i', $tmpfile)) {
  9073. $mime = 'text/x-bat';
  9074. $imgmime = 'script.png';
  9075. $srclang = 'dos';
  9076. $famime = 'file-code-o';
  9077. }
  9078. if (preg_match('/\.sh$/i', $tmpfile)) {
  9079. $mime = 'text/x-sh';
  9080. $imgmime = 'script.png';
  9081. $srclang = 'bash';
  9082. $famime = 'file-code-o';
  9083. }
  9084. if (preg_match('/\.ksh$/i', $tmpfile)) {
  9085. $mime = 'text/x-ksh';
  9086. $imgmime = 'script.png';
  9087. $srclang = 'bash';
  9088. $famime = 'file-code-o';
  9089. }
  9090. if (preg_match('/\.bash$/i', $tmpfile)) {
  9091. $mime = 'text/x-bash';
  9092. $imgmime = 'script.png';
  9093. $srclang = 'bash';
  9094. $famime = 'file-code-o';
  9095. }
  9096. // Images
  9097. if (preg_match('/\.ico$/i', $tmpfile)) {
  9098. $mime = 'image/x-icon';
  9099. $imgmime = 'image.png';
  9100. $famime = 'file-image-o';
  9101. }
  9102. if (preg_match('/\.(jpg|jpeg)$/i', $tmpfile)) {
  9103. $mime = 'image/jpeg';
  9104. $imgmime = 'image.png';
  9105. $famime = 'file-image-o';
  9106. }
  9107. if (preg_match('/\.png$/i', $tmpfile)) {
  9108. $mime = 'image/png';
  9109. $imgmime = 'image.png';
  9110. $famime = 'file-image-o';
  9111. }
  9112. if (preg_match('/\.gif$/i', $tmpfile)) {
  9113. $mime = 'image/gif';
  9114. $imgmime = 'image.png';
  9115. $famime = 'file-image-o';
  9116. }
  9117. if (preg_match('/\.bmp$/i', $tmpfile)) {
  9118. $mime = 'image/bmp';
  9119. $imgmime = 'image.png';
  9120. $famime = 'file-image-o';
  9121. }
  9122. if (preg_match('/\.(tif|tiff)$/i', $tmpfile)) {
  9123. $mime = 'image/tiff';
  9124. $imgmime = 'image.png';
  9125. $famime = 'file-image-o';
  9126. }
  9127. if (preg_match('/\.svg$/i', $tmpfile)) {
  9128. $mime = 'image/svg+xml';
  9129. $imgmime = 'image.png';
  9130. $famime = 'file-image-o';
  9131. }
  9132. if (preg_match('/\.webp$/i', $tmpfile)) {
  9133. $mime = 'image/webp';
  9134. $imgmime = 'image.png';
  9135. $famime = 'file-image-o';
  9136. }
  9137. // Calendar
  9138. if (preg_match('/\.vcs$/i', $tmpfile)) {
  9139. $mime = 'text/calendar';
  9140. $imgmime = 'other.png';
  9141. $famime = 'file-text-o';
  9142. }
  9143. if (preg_match('/\.ics$/i', $tmpfile)) {
  9144. $mime = 'text/calendar';
  9145. $imgmime = 'other.png';
  9146. $famime = 'file-text-o';
  9147. }
  9148. // Other
  9149. if (preg_match('/\.torrent$/i', $tmpfile)) {
  9150. $mime = 'application/x-bittorrent';
  9151. $imgmime = 'other.png';
  9152. $famime = 'file-o';
  9153. }
  9154. // Audio
  9155. if (preg_match('/\.(mp3|ogg|au|wav|wma|mid)$/i', $tmpfile)) {
  9156. $mime = 'audio';
  9157. $imgmime = 'audio.png';
  9158. $famime = 'file-audio-o';
  9159. }
  9160. // Video
  9161. if (preg_match('/\.mp4$/i', $tmpfile)) {
  9162. $mime = 'video/mp4';
  9163. $imgmime = 'video.png';
  9164. $famime = 'file-video-o';
  9165. }
  9166. if (preg_match('/\.ogv$/i', $tmpfile)) {
  9167. $mime = 'video/ogg';
  9168. $imgmime = 'video.png';
  9169. $famime = 'file-video-o';
  9170. }
  9171. if (preg_match('/\.webm$/i', $tmpfile)) {
  9172. $mime = 'video/webm';
  9173. $imgmime = 'video.png';
  9174. $famime = 'file-video-o';
  9175. }
  9176. if (preg_match('/\.avi$/i', $tmpfile)) {
  9177. $mime = 'video/x-msvideo';
  9178. $imgmime = 'video.png';
  9179. $famime = 'file-video-o';
  9180. }
  9181. if (preg_match('/\.divx$/i', $tmpfile)) {
  9182. $mime = 'video/divx';
  9183. $imgmime = 'video.png';
  9184. $famime = 'file-video-o';
  9185. }
  9186. if (preg_match('/\.xvid$/i', $tmpfile)) {
  9187. $mime = 'video/xvid';
  9188. $imgmime = 'video.png';
  9189. $famime = 'file-video-o';
  9190. }
  9191. if (preg_match('/\.(wmv|mpg|mpeg)$/i', $tmpfile)) {
  9192. $mime = 'video';
  9193. $imgmime = 'video.png';
  9194. $famime = 'file-video-o';
  9195. }
  9196. // Archive
  9197. if (preg_match('/\.(zip|rar|gz|tgz|z|cab|bz2|7z|tar|lzh|zst)$/i', $tmpfile)) {
  9198. $mime = 'archive';
  9199. $imgmime = 'archive.png';
  9200. $famime = 'file-archive-o';
  9201. } // application/xxx where zzz is zip, ...
  9202. // Exe
  9203. if (preg_match('/\.(exe|com)$/i', $tmpfile)) {
  9204. $mime = 'application/octet-stream';
  9205. $imgmime = 'other.png';
  9206. $famime = 'file-o';
  9207. }
  9208. // Lib
  9209. if (preg_match('/\.(dll|lib|o|so|a)$/i', $tmpfile)) {
  9210. $mime = 'library';
  9211. $imgmime = 'library.png';
  9212. $famime = 'file-o';
  9213. }
  9214. // Err
  9215. if (preg_match('/\.err$/i', $tmpfile)) {
  9216. $mime = 'error';
  9217. $imgmime = 'error.png';
  9218. $famime = 'file-text-o';
  9219. }
  9220. // Return string
  9221. if ($mode == 1) {
  9222. $tmp = explode('/', $mime);
  9223. return (!empty($tmp[1]) ? $tmp[1] : $tmp[0]);
  9224. }
  9225. if ($mode == 2) {
  9226. return $imgmime;
  9227. }
  9228. if ($mode == 3) {
  9229. return $srclang;
  9230. }
  9231. if ($mode == 4) {
  9232. return $famime;
  9233. }
  9234. return $mime;
  9235. }
  9236. /**
  9237. * Return the value of a filed into a dictionary for the record $id.
  9238. * This also set all the values into a cache for a next search.
  9239. *
  9240. * @param string $tablename Name of table dictionary (without the MAIN_DB_PREFIX, example: 'c_holiday_types')
  9241. * @param string $field The name of field where to find the value to return
  9242. * @param int $id Id of line record
  9243. * @param bool $checkentity Add filter on entity
  9244. * @param string $rowidfield Name of the column rowid (to use for the filter on $id)
  9245. * @return string The value of field $field. This also set $dictvalues cache.
  9246. */
  9247. function getDictionaryValue($tablename, $field, $id, $checkentity = false, $rowidfield = 'rowid')
  9248. {
  9249. global $conf, $db;
  9250. $tablename = preg_replace('/^'.preg_quote(MAIN_DB_PREFIX, '/').'/', '', $tablename); // Clean name of table for backward compatibility.
  9251. $dictvalues = (isset($conf->cache['dictvalues_'.$tablename]) ? $conf->cache['dictvalues_'.$tablename] : null);
  9252. if (is_null($dictvalues)) {
  9253. $dictvalues = array();
  9254. $sql = "SELECT * FROM ".MAIN_DB_PREFIX.$tablename." WHERE 1 = 1"; // Here select * is allowed as it is generic code and we don't have list of fields
  9255. if ($checkentity) {
  9256. $sql .= ' AND entity IN (0,'.getEntity($tablename).')';
  9257. }
  9258. $resql = $db->query($sql);
  9259. if ($resql) {
  9260. while ($obj = $db->fetch_object($resql)) {
  9261. $dictvalues[$obj->{$rowidfield}] = $obj; // $obj is stdClass
  9262. }
  9263. } else {
  9264. dol_print_error($db);
  9265. }
  9266. $conf->cache['dictvalues_'.$tablename] = $dictvalues;
  9267. }
  9268. if (!empty($dictvalues[$id])) {
  9269. // Found
  9270. $tmp = $dictvalues[$id];
  9271. return (property_exists($tmp, $field) ? $tmp->$field : '');
  9272. } else {
  9273. // Not found
  9274. return '';
  9275. }
  9276. }
  9277. /**
  9278. * Return true if the color is light
  9279. *
  9280. * @param string $stringcolor String with hex (FFFFFF) or comma RGB ('255,255,255')
  9281. * @return int -1 : Error with argument passed |0 : color is dark | 1 : color is light
  9282. */
  9283. function colorIsLight($stringcolor)
  9284. {
  9285. $stringcolor = str_replace('#', '', $stringcolor);
  9286. $res = -1;
  9287. if (!empty($stringcolor)) {
  9288. $res = 0;
  9289. $tmp = explode(',', $stringcolor);
  9290. if (count($tmp) > 1) { // This is a comma RGB ('255','255','255')
  9291. $r = $tmp[0];
  9292. $g = $tmp[1];
  9293. $b = $tmp[2];
  9294. } else {
  9295. $hexr = $stringcolor[0].$stringcolor[1];
  9296. $hexg = $stringcolor[2].$stringcolor[3];
  9297. $hexb = $stringcolor[4].$stringcolor[5];
  9298. $r = hexdec($hexr);
  9299. $g = hexdec($hexg);
  9300. $b = hexdec($hexb);
  9301. }
  9302. $bright = (max($r, $g, $b) + min($r, $g, $b)) / 510.0; // HSL algorithm
  9303. if ($bright > 0.6) {
  9304. $res = 1;
  9305. }
  9306. }
  9307. return $res;
  9308. }
  9309. /**
  9310. * Function to test if an entry is enabled or not
  9311. *
  9312. * @param string $type_user 0=We test for internal user, 1=We test for external user
  9313. * @param array $menuentry Array for feature entry to test
  9314. * @param array $listofmodulesforexternal Array with list of modules allowed to external users
  9315. * @return int 0=Hide, 1=Show, 2=Show gray
  9316. */
  9317. function isVisibleToUserType($type_user, &$menuentry, &$listofmodulesforexternal)
  9318. {
  9319. global $conf;
  9320. //print 'type_user='.$type_user.' module='.$menuentry['module'].' enabled='.$menuentry['enabled'].' perms='.$menuentry['perms'];
  9321. //print 'ok='.in_array($menuentry['module'], $listofmodulesforexternal);
  9322. if (empty($menuentry['enabled'])) {
  9323. return 0; // Entry disabled by condition
  9324. }
  9325. if ($type_user && $menuentry['module']) {
  9326. $tmploops = explode('|', $menuentry['module']);
  9327. $found = 0;
  9328. foreach ($tmploops as $tmploop) {
  9329. if (in_array($tmploop, $listofmodulesforexternal)) {
  9330. $found++;
  9331. break;
  9332. }
  9333. }
  9334. if (!$found) {
  9335. return 0; // Entry is for menus all excluded to external users
  9336. }
  9337. }
  9338. if (!$menuentry['perms'] && $type_user) {
  9339. return 0; // No permissions and user is external
  9340. }
  9341. if (!$menuentry['perms'] && !empty($conf->global->MAIN_MENU_HIDE_UNAUTHORIZED)) {
  9342. return 0; // No permissions and option to hide when not allowed, even for internal user, is on
  9343. }
  9344. if (!$menuentry['perms']) {
  9345. return 2; // No permissions and user is external
  9346. }
  9347. return 1;
  9348. }
  9349. /**
  9350. * Round to next multiple.
  9351. *
  9352. * @param double $n Number to round up
  9353. * @param integer $x Multiple. For example 60 to round up to nearest exact minute for a date with seconds.
  9354. * @return integer Value rounded.
  9355. */
  9356. function roundUpToNextMultiple($n, $x = 5)
  9357. {
  9358. return (ceil($n) % $x === 0) ? ceil($n) : round(($n + $x / 2) / $x) * $x;
  9359. }
  9360. /**
  9361. * Function dolGetBadge
  9362. *
  9363. * @param string $label label of badge no html : use in alt attribute for accessibility
  9364. * @param string $html optional : label of badge with html
  9365. * @param string $type type of badge : Primary Secondary Success Danger Warning Info Light Dark status0 status1 status2 status3 status4 status5 status6 status7 status8 status9
  9366. * @param string $mode default '' , 'pill', 'dot'
  9367. * @param string $url the url for link
  9368. * @param array $params various params for future : recommended rather than adding more fuction arguments. array('attr'=>array('title'=>'abc'))
  9369. * @return string Html badge
  9370. */
  9371. function dolGetBadge($label, $html = '', $type = 'primary', $mode = '', $url = '', $params = array())
  9372. {
  9373. $attr = array(
  9374. 'class'=>'badge '.(!empty($mode) ? ' badge-'.$mode : '').(!empty($type) ? ' badge-'.$type : '').(empty($params['css']) ? '' : ' '.$params['css'])
  9375. );
  9376. if (empty($html)) {
  9377. $html = $label;
  9378. }
  9379. if (!empty($url)) {
  9380. $attr['href'] = $url;
  9381. }
  9382. if ($mode === 'dot') {
  9383. $attr['class'] .= ' classfortooltip';
  9384. $attr['title'] = $html;
  9385. $attr['aria-label'] = $label;
  9386. $html = '';
  9387. }
  9388. // Override attr
  9389. if (!empty($params['attr']) && is_array($params['attr'])) {
  9390. foreach ($params['attr'] as $key => $value) {
  9391. if ($key == 'class') {
  9392. $attr['class'] .= ' '.$value;
  9393. } elseif ($key == 'classOverride') {
  9394. $attr['class'] = $value;
  9395. } else {
  9396. $attr[$key] = $value;
  9397. }
  9398. }
  9399. }
  9400. // TODO: add hook
  9401. // escape all attribute
  9402. $attr = array_map('dol_escape_htmltag', $attr);
  9403. $TCompiledAttr = array();
  9404. foreach ($attr as $key => $value) {
  9405. $TCompiledAttr[] = $key.'="'.$value.'"';
  9406. }
  9407. $compiledAttributes = !empty($TCompiledAttr) ?implode(' ', $TCompiledAttr) : '';
  9408. $tag = !empty($url) ? 'a' : 'span';
  9409. return '<'.$tag.' '.$compiledAttributes.'>'.$html.'</'.$tag.'>';
  9410. }
  9411. /**
  9412. * Output the badge of a status.
  9413. *
  9414. * @param string $statusLabel Label of badge no html : use in alt attribute for accessibility
  9415. * @param string $statusLabelShort Short label of badge no html
  9416. * @param string $html Optional : label of badge with html
  9417. * @param string $statusType status0 status1 status2 status3 status4 status5 status6 status7 status8 status9 : image name or badge name
  9418. * @param int $displayMode 0=Long label, 1=Short label, 2=Picto + Short label, 3=Picto, 4=Picto + Long label, 5=Short label + Picto, 6=Long label + Picto
  9419. * @param string $url The url for link
  9420. * @param array $params Various params. Example: array('tooltip'=>'no|...', 'badgeParams'=>...)
  9421. * @return string Html status string
  9422. */
  9423. function dolGetStatus($statusLabel = '', $statusLabelShort = '', $html = '', $statusType = 'status0', $displayMode = 0, $url = '', $params = array())
  9424. {
  9425. global $conf;
  9426. $return = '';
  9427. $dolGetBadgeParams = array();
  9428. if (!empty($params['badgeParams'])) {
  9429. $dolGetBadgeParams = $params['badgeParams'];
  9430. }
  9431. // TODO : add a hook
  9432. if ($displayMode == 0) {
  9433. $return = !empty($html) ? $html : (empty($conf->dol_optimize_smallscreen) ? $statusLabel : (empty($statusLabelShort) ? $statusLabel : $statusLabelShort));
  9434. } elseif ($displayMode == 1) {
  9435. $return = !empty($html) ? $html : (empty($statusLabelShort) ? $statusLabel : $statusLabelShort);
  9436. } elseif (!empty($conf->global->MAIN_STATUS_USES_IMAGES)) {
  9437. // Use status with images (for backward compatibility)
  9438. $return = '';
  9439. $htmlLabel = (in_array($displayMode, array(1, 2, 5)) ? '<span class="hideonsmartphone">' : '').(!empty($html) ? $html : $statusLabel).(in_array($displayMode, array(1, 2, 5)) ? '</span>' : '');
  9440. $htmlLabelShort = (in_array($displayMode, array(1, 2, 5)) ? '<span class="hideonsmartphone">' : '').(!empty($html) ? $html : (!empty($statusLabelShort) ? $statusLabelShort : $statusLabel)).(in_array($displayMode, array(1, 2, 5)) ? '</span>' : '');
  9441. // For small screen, we always use the short label instead of long label.
  9442. if (!empty($conf->dol_optimize_smallscreen)) {
  9443. if ($displayMode == 0) {
  9444. $displayMode = 1;
  9445. } elseif ($displayMode == 4) {
  9446. $displayMode = 2;
  9447. } elseif ($displayMode == 6) {
  9448. $displayMode = 5;
  9449. }
  9450. }
  9451. // For backward compatibility. Image's filename are still in French, so we use this array to convert
  9452. $statusImg = array(
  9453. 'status0' => 'statut0',
  9454. 'status1' => 'statut1',
  9455. 'status2' => 'statut2',
  9456. 'status3' => 'statut3',
  9457. 'status4' => 'statut4',
  9458. 'status5' => 'statut5',
  9459. 'status6' => 'statut6',
  9460. 'status7' => 'statut7',
  9461. 'status8' => 'statut8',
  9462. 'status9' => 'statut9'
  9463. );
  9464. if (!empty($statusImg[$statusType])) {
  9465. $htmlImg = img_picto($statusLabel, $statusImg[$statusType]);
  9466. } else {
  9467. $htmlImg = img_picto($statusLabel, $statusType);
  9468. }
  9469. if ($displayMode === 2) {
  9470. $return = $htmlImg.' '.$htmlLabelShort;
  9471. } elseif ($displayMode === 3) {
  9472. $return = $htmlImg;
  9473. } elseif ($displayMode === 4) {
  9474. $return = $htmlImg.' '.$htmlLabel;
  9475. } elseif ($displayMode === 5) {
  9476. $return = $htmlLabelShort.' '.$htmlImg;
  9477. } else { // $displayMode >= 6
  9478. $return = $htmlLabel.' '.$htmlImg;
  9479. }
  9480. } elseif (empty($conf->global->MAIN_STATUS_USES_IMAGES) && !empty($displayMode)) {
  9481. // Use new badge
  9482. $statusLabelShort = (empty($statusLabelShort) ? $statusLabel : $statusLabelShort);
  9483. $dolGetBadgeParams['attr']['class'] = 'badge-status';
  9484. $dolGetBadgeParams['attr']['title'] = empty($params['tooltip']) ? $statusLabel : ($params['tooltip'] != 'no' ? $params['tooltip'] : '');
  9485. if ($displayMode == 3) {
  9486. $return = dolGetBadge((empty($conf->dol_optimize_smallscreen) ? $statusLabel : (empty($statusLabelShort) ? $statusLabel : $statusLabelShort)), '', $statusType, 'dot', $url, $dolGetBadgeParams);
  9487. } elseif ($displayMode === 5) {
  9488. $return = dolGetBadge($statusLabelShort, $html, $statusType, '', $url, $dolGetBadgeParams);
  9489. } else {
  9490. $return = dolGetBadge((empty($conf->dol_optimize_smallscreen) ? $statusLabel : (empty($statusLabelShort) ? $statusLabel : $statusLabelShort)), $html, $statusType, '', $url, $dolGetBadgeParams);
  9491. }
  9492. }
  9493. return $return;
  9494. }
  9495. /**
  9496. * Function dolGetButtonAction
  9497. *
  9498. * @param string $label label of button without HTML : use in alt attribute for accessibility $html is not empty
  9499. * @param string $html optional : content with html
  9500. * @param string $actionType default, delete, danger
  9501. * @param string $url the url for link
  9502. * @param string $id attribute id of button
  9503. * @param int $userRight user action right
  9504. * // phpcs:disable
  9505. * @param array $params = [ // Various params for future : recommended rather than adding more function arguments
  9506. * 'attr' => [ // to add or override button attributes
  9507. * 'xxxxx' => '', // your xxxxx attribute you want
  9508. * 'class' => '', // to add more css class to the button class attribute
  9509. * 'classOverride' => '' // to replace class attribute of the button
  9510. * ],
  9511. * 'confirm' => [
  9512. * 'url' => 'http://', // Overide Url to go when user click on action btn, if empty default url is $url.?confirm=yes, for no js compatibility use $url for fallback confirm.
  9513. * 'title' => '', // Overide title of modal, if empty default title use "ConfirmBtnCommonTitle" lang key
  9514. * 'action-btn-label' => '', // Overide label of action button, if empty default label use "Confirm" lang key
  9515. * 'cancel-btn-label' => '', // Overide label of cancel button, if empty default label use "CloseDialog" lang key
  9516. * 'content' => '', // Overide text of content, if empty default content use "ConfirmBtnCommonContent" lang key
  9517. * 'modal' => true, // true|false to display dialog as a modal (with dark background)
  9518. * ],
  9519. * ]
  9520. * // phpcs:enable
  9521. * @return string html button
  9522. */
  9523. function dolGetButtonAction($label, $html = '', $actionType = 'default', $url = '', $id = '', $userRight = 1, $params = array())
  9524. {
  9525. global $hookmanager, $action, $object, $langs;
  9526. $class = 'butAction';
  9527. if ($actionType == 'danger' || $actionType == 'delete') {
  9528. $class = 'butActionDelete';
  9529. if (!empty($url) && strpos($url, 'token=') === false) $url .= '&token='.newToken();
  9530. }
  9531. $attr = array(
  9532. 'class' => $class,
  9533. 'href' => empty($url) ? '' : $url,
  9534. 'title' => $label
  9535. );
  9536. if (empty($html)) {
  9537. $html = $label;
  9538. $attr['title'] = ''; // if html not set, leave label on title is redundant
  9539. } else {
  9540. $attr['aria-label'] = $label;
  9541. }
  9542. if (empty($userRight)) {
  9543. $attr['class'] = 'butActionRefused';
  9544. $attr['href'] = '';
  9545. }
  9546. if (!empty($id)) {
  9547. $attr['id'] = $id;
  9548. }
  9549. // Override attr
  9550. if (!empty($params['attr']) && is_array($params['attr'])) {
  9551. foreach ($params['attr'] as $key => $value) {
  9552. if ($key == 'class') {
  9553. $attr['class'] .= ' '.$value;
  9554. } elseif ($key == 'classOverride') {
  9555. $attr['class'] = $value;
  9556. } else {
  9557. $attr[$key] = $value;
  9558. }
  9559. }
  9560. }
  9561. // automatic add tooltip when title is detected
  9562. if (!empty($attr['title']) && !empty($attr['class']) && strpos($attr['class'], 'classfortooltip') === false) {
  9563. $attr['class'].= ' classfortooltip';
  9564. }
  9565. // Js Confirm button
  9566. if ($userRight && !empty($params['confirm'])) {
  9567. if (!is_array($params['confirm'])) {
  9568. $params['confirm'] = array();
  9569. }
  9570. if (empty($params['confirm']['url'])) {
  9571. $params['confirm']['url'] = $url . (strpos($url, '?') > 0 ? '&' : '?') . 'confirm=yes';
  9572. }
  9573. // for js desabled compatibility set $url as call to confirm action and $params['confirm']['url'] to confirmed action
  9574. $attr['data-confirm-url'] = $params['confirm']['url'];
  9575. $attr['data-confirm-title'] = !empty($params['confirm']['title']) ? $params['confirm']['title'] : $langs->trans('ConfirmBtnCommonTitle', $label);
  9576. $attr['data-confirm-content'] = !empty($params['confirm']['content']) ? $params['confirm']['content'] : $langs->trans('ConfirmBtnCommonContent', $label);
  9577. $attr['data-confirm-content'] = preg_replace("/\r|\n/", "", $attr['data-confirm-content']);
  9578. $attr['data-confirm-action-btn-label'] = !empty($params['confirm']['action-btn-label']) ? $params['confirm']['action-btn-label'] : $langs->trans('Confirm');
  9579. $attr['data-confirm-cancel-btn-label'] = !empty($params['confirm']['cancel-btn-label']) ? $params['confirm']['cancel-btn-label'] : $langs->trans('CloseDialog');
  9580. $attr['data-confirm-modal'] = !empty($params['confirm']['modal']) ? $params['confirm']['modal'] : true;
  9581. $attr['class'].= ' butActionConfirm';
  9582. }
  9583. if (isset($attr['href']) && empty($attr['href'])) {
  9584. unset($attr['href']);
  9585. }
  9586. // escape all attribute
  9587. $attr = array_map('dol_escape_htmltag', $attr);
  9588. $TCompiledAttr = array();
  9589. foreach ($attr as $key => $value) {
  9590. $TCompiledAttr[] = $key.'="'.$value.'"';
  9591. }
  9592. $compiledAttributes = empty($TCompiledAttr) ? '' : implode(' ', $TCompiledAttr);
  9593. $tag = !empty($attr['href']) ? 'a' : 'span';
  9594. $parameters = array(
  9595. 'TCompiledAttr' => $TCompiledAttr, // array
  9596. 'compiledAttributes' => $compiledAttributes, // string
  9597. 'attr' => $attr,
  9598. 'tag' => $tag,
  9599. 'label' => $label,
  9600. 'html' => $html,
  9601. 'actionType' => $actionType,
  9602. 'url' => $url,
  9603. 'id' => $id,
  9604. 'userRight' => $userRight,
  9605. 'params' => $params
  9606. );
  9607. $reshook = $hookmanager->executeHooks('dolGetButtonAction', $parameters, $object, $action); // Note that $action and $object may have been modified by some hooks
  9608. if ($reshook < 0) setEventMessages($hookmanager->error, $hookmanager->errors, 'errors');
  9609. if (empty($reshook)) {
  9610. return '<' . $tag . ' ' . $compiledAttributes . '>' . $html . '</' . $tag . '>';
  9611. } else {
  9612. return $hookmanager->resPrint;
  9613. }
  9614. }
  9615. /**
  9616. * Add space between dolGetButtonTitle
  9617. *
  9618. * @param string $moreClass more css class label
  9619. * @return string html of title separator
  9620. */
  9621. function dolGetButtonTitleSeparator($moreClass = "")
  9622. {
  9623. return '<span class="button-title-separator '.$moreClass.'" ></span>';
  9624. }
  9625. /**
  9626. * get field error icon
  9627. *
  9628. * @param string $fieldValidationErrorMsg message to add in tooltip
  9629. * @return string html output
  9630. */
  9631. function getFieldErrorIcon($fieldValidationErrorMsg)
  9632. {
  9633. $out = '';
  9634. if (!empty($fieldValidationErrorMsg)) {
  9635. $out.= '<span class="field-error-icon classfortooltip" title="'.dol_escape_htmltag($fieldValidationErrorMsg, 1).'" role="alert" >'; // role alert is used for accessibility
  9636. $out.= '<span class="fa fa-exclamation-circle" aria-hidden="true" ></span>'; // For accessibility icon is separated and aria-hidden
  9637. $out.= '</span>';
  9638. }
  9639. return $out;
  9640. }
  9641. /**
  9642. * Function dolGetButtonTitle : this kind of buttons are used in title in list
  9643. *
  9644. * @param string $label label of button
  9645. * @param string $helpText optional : content for help tooltip
  9646. * @param string $iconClass class for icon element (Example: 'fa fa-file')
  9647. * @param string $url the url for link
  9648. * @param string $id attribute id of button
  9649. * @param int $status 0 no user rights, 1 active, 2 current action or selected, -1 Feature Disabled, -2 disable Other reason use helpText as tooltip
  9650. * @param array $params various params for future : recommended rather than adding more function arguments
  9651. * @return string html button
  9652. */
  9653. function dolGetButtonTitle($label, $helpText = '', $iconClass = 'fa fa-file', $url = '', $id = '', $status = 1, $params = array())
  9654. {
  9655. global $langs, $conf, $user;
  9656. // Actually this conf is used in css too for external module compatibility and smooth transition to this function
  9657. if (!empty($conf->global->MAIN_BUTTON_HIDE_UNAUTHORIZED) && (!$user->admin) && $status <= 0) {
  9658. return '';
  9659. }
  9660. $class = 'btnTitle';
  9661. if (in_array($iconClass, array('fa fa-plus-circle', 'fa fa-plus-circle size15x', 'fa fa-comment-dots'))) {
  9662. $class .= ' btnTitlePlus';
  9663. }
  9664. $useclassfortooltip = 1;
  9665. if (!empty($params['morecss'])) {
  9666. $class .= ' '.$params['morecss'];
  9667. }
  9668. $attr = array(
  9669. 'class' => $class,
  9670. 'href' => empty($url) ? '' : $url
  9671. );
  9672. if (!empty($helpText)) {
  9673. $attr['title'] = dol_escape_htmltag($helpText);
  9674. } elseif (empty($attr['title']) && $label) {
  9675. $attr['title'] = $label;
  9676. $useclassfortooltip = 0;
  9677. }
  9678. if ($status == 2) {
  9679. $attr['class'] .= ' btnTitleSelected';
  9680. } elseif ($status <= 0) {
  9681. $attr['class'] .= ' refused';
  9682. $attr['href'] = '';
  9683. if ($status == -1) { // disable
  9684. $attr['title'] = dol_escape_htmltag($langs->transnoentitiesnoconv("FeatureDisabled"));
  9685. } elseif ($status == 0) { // Not enough permissions
  9686. $attr['title'] = dol_escape_htmltag($langs->transnoentitiesnoconv("NotEnoughPermissions"));
  9687. }
  9688. }
  9689. if (!empty($attr['title']) && $useclassfortooltip) {
  9690. $attr['class'] .= ' classfortooltip';
  9691. }
  9692. if (!empty($id)) {
  9693. $attr['id'] = $id;
  9694. }
  9695. // Override attr
  9696. if (!empty($params['attr']) && is_array($params['attr'])) {
  9697. foreach ($params['attr'] as $key => $value) {
  9698. if ($key == 'class') {
  9699. $attr['class'] .= ' '.$value;
  9700. } elseif ($key == 'classOverride') {
  9701. $attr['class'] = $value;
  9702. } else {
  9703. $attr[$key] = $value;
  9704. }
  9705. }
  9706. }
  9707. if (isset($attr['href']) && empty($attr['href'])) {
  9708. unset($attr['href']);
  9709. }
  9710. // TODO : add a hook
  9711. // escape all attribute
  9712. $attr = array_map('dol_escape_htmltag', $attr);
  9713. $TCompiledAttr = array();
  9714. foreach ($attr as $key => $value) {
  9715. $TCompiledAttr[] = $key.'="'.$value.'"';
  9716. }
  9717. $compiledAttributes = (empty($TCompiledAttr) ? '' : implode(' ', $TCompiledAttr));
  9718. $tag = (empty($attr['href']) ? 'span' : 'a');
  9719. $button = '<'.$tag.' '.$compiledAttributes.'>';
  9720. $button .= '<span class="'.$iconClass.' valignmiddle btnTitle-icon"></span>';
  9721. if (!empty($params['forcenohideoftext'])) {
  9722. $button .= '<span class="valignmiddle text-plus-circle btnTitle-label'.(empty($params['forcenohideoftext']) ? ' hideonsmartphone' : '').'">'.$label.'</span>';
  9723. }
  9724. $button .= '</'.$tag.'>';
  9725. return $button;
  9726. }
  9727. /**
  9728. * Get an array with properties of an element.
  9729. * Called by fetchObjectByElement.
  9730. *
  9731. * @param string $element_type Element type (Value of $object->element). Example: 'action', 'facture', 'project_task' or 'object@mymodule'...
  9732. * @return array (module, classpath, element, subelement, classfile, classname)
  9733. */
  9734. function getElementProperties($element_type)
  9735. {
  9736. $regs = array();
  9737. $classfile = $classname = $classpath = '';
  9738. // Parse element/subelement (ex: project_task)
  9739. $module = $element_type;
  9740. $element = $element_type;
  9741. $subelement = $element_type;
  9742. // If we ask an resource form external module (instead of default path)
  9743. if (preg_match('/^([^@]+)@([^@]+)$/i', $element_type, $regs)) {
  9744. $element = $subelement = $regs[1];
  9745. $module = $regs[2];
  9746. }
  9747. //print '<br>1. element : '.$element.' - module : '.$module .'<br>';
  9748. if (preg_match('/^([^_]+)_([^_]+)/i', $element, $regs)) {
  9749. $module = $element = $regs[1];
  9750. $subelement = $regs[2];
  9751. }
  9752. // For compat
  9753. if ($element_type == "action") {
  9754. $classpath = 'comm/action/class';
  9755. $subelement = 'Actioncomm';
  9756. $module = 'agenda';
  9757. }
  9758. // To work with non standard path
  9759. if ($element_type == 'facture' || $element_type == 'invoice') {
  9760. $classpath = 'compta/facture/class';
  9761. $module = 'facture';
  9762. $subelement = 'facture';
  9763. }
  9764. if ($element_type == 'commande' || $element_type == 'order') {
  9765. $classpath = 'commande/class';
  9766. $module = 'commande';
  9767. $subelement = 'commande';
  9768. }
  9769. if ($element_type == 'propal') {
  9770. $classpath = 'comm/propal/class';
  9771. }
  9772. if ($element_type == 'supplier_proposal') {
  9773. $classpath = 'supplier_proposal/class';
  9774. }
  9775. if ($element_type == 'shipping') {
  9776. $classpath = 'expedition/class';
  9777. $subelement = 'expedition';
  9778. $module = 'expedition_bon';
  9779. }
  9780. if ($element_type == 'delivery') {
  9781. $classpath = 'delivery/class';
  9782. $subelement = 'delivery';
  9783. $module = 'delivery_note';
  9784. }
  9785. if ($element_type == 'contract') {
  9786. $classpath = 'contrat/class';
  9787. $module = 'contrat';
  9788. $subelement = 'contrat';
  9789. }
  9790. if ($element_type == 'member') {
  9791. $classpath = 'adherents/class';
  9792. $module = 'adherent';
  9793. $subelement = 'adherent';
  9794. }
  9795. if ($element_type == 'cabinetmed_cons') {
  9796. $classpath = 'cabinetmed/class';
  9797. $module = 'cabinetmed';
  9798. $subelement = 'cabinetmedcons';
  9799. }
  9800. if ($element_type == 'fichinter') {
  9801. $classpath = 'fichinter/class';
  9802. $module = 'ficheinter';
  9803. $subelement = 'fichinter';
  9804. }
  9805. if ($element_type == 'dolresource' || $element_type == 'resource') {
  9806. $classpath = 'resource/class';
  9807. $module = 'resource';
  9808. $subelement = 'dolresource';
  9809. }
  9810. if ($element_type == 'propaldet') {
  9811. $classpath = 'comm/propal/class';
  9812. $module = 'propal';
  9813. $subelement = 'propaleligne';
  9814. }
  9815. if ($element_type == 'order_supplier') {
  9816. $classpath = 'fourn/class';
  9817. $module = 'fournisseur';
  9818. $subelement = 'commandefournisseur';
  9819. $classfile = 'fournisseur.commande';
  9820. }
  9821. if ($element_type == 'invoice_supplier') {
  9822. $classpath = 'fourn/class';
  9823. $module = 'fournisseur';
  9824. $subelement = 'facturefournisseur';
  9825. $classfile = 'fournisseur.facture';
  9826. }
  9827. if ($element_type == "service") {
  9828. $classpath = 'product/class';
  9829. $subelement = 'product';
  9830. }
  9831. if (empty($classfile)) {
  9832. $classfile = strtolower($subelement);
  9833. }
  9834. if (empty($classname)) {
  9835. $classname = ucfirst($subelement);
  9836. }
  9837. if (empty($classpath)) {
  9838. $classpath = $module.'/class';
  9839. }
  9840. $element_properties = array(
  9841. 'module' => $module,
  9842. 'classpath' => $classpath,
  9843. 'element' => $element,
  9844. 'subelement' => $subelement,
  9845. 'classfile' => $classfile,
  9846. 'classname' => $classname
  9847. );
  9848. return $element_properties;
  9849. }
  9850. /**
  9851. * Fetch an object from its id and element_type
  9852. * Inclusion of classes is automatic
  9853. *
  9854. * @param int $element_id Element id
  9855. * @param string $element_type Element type
  9856. * @param string $element_ref Element ref (Use this or element_id but not both)
  9857. * @return int|object object || 0 || -1 if error
  9858. */
  9859. function fetchObjectByElement($element_id, $element_type, $element_ref = '')
  9860. {
  9861. global $conf, $db;
  9862. $element_prop = getElementProperties($element_type);
  9863. if (is_array($element_prop) && $conf->{$element_prop['module']}->enabled) {
  9864. dol_include_once('/'.$element_prop['classpath'].'/'.$element_prop['classfile'].'.class.php');
  9865. $objecttmp = new $element_prop['classname']($db);
  9866. $ret = $objecttmp->fetch($element_id, $element_ref);
  9867. if ($ret >= 0) {
  9868. return $objecttmp;
  9869. }
  9870. }
  9871. return 0;
  9872. }
  9873. /**
  9874. * Return if a file can contains executable content
  9875. *
  9876. * @param string $filename File name to test
  9877. * @return boolean True if yes, False if no
  9878. */
  9879. function isAFileWithExecutableContent($filename)
  9880. {
  9881. if (preg_match('/\.(htm|html|js|phar|php|php\d+|phtml|pht|pl|py|cgi|ksh|sh|shtml|bash|bat|cmd|wpk|exe|dmg)$/i', $filename)) {
  9882. return true;
  9883. }
  9884. return false;
  9885. }
  9886. /**
  9887. * Return the value of token currently saved into session with name 'newtoken'.
  9888. * This token must be send by any POST as it will be used by next page for comparison with value in session.
  9889. *
  9890. * @return string
  9891. */
  9892. function newToken()
  9893. {
  9894. return empty($_SESSION['newtoken']) ? '' : $_SESSION['newtoken'];
  9895. }
  9896. /**
  9897. * Return the value of token currently saved into session with name 'token'.
  9898. * For ajax call, you must use this token as a parameter of the call into the js calling script (the called ajax php page must also set constant NOTOKENRENEWAL).
  9899. *
  9900. * @return string
  9901. */
  9902. function currentToken()
  9903. {
  9904. return isset($_SESSION['token']) ? $_SESSION['token'] : '';
  9905. }
  9906. /**
  9907. * Start a table with headers and a optinal clickable number (don't forget to use "finishSimpleTable()" after the last table row)
  9908. *
  9909. * @param string $header The first left header of the table (automatic translated)
  9910. * @param string $link (optional) The link to a internal dolibarr page, when click on the number (without the first "/")
  9911. * @param string $arguments (optional) Additional arguments for the link (e.g. "search_status=0")
  9912. * @param integer $emptyRows (optional) The count of empty rows after the first header
  9913. * @param integer $number (optional) The number that is shown right after the first header, when not set the link is shown on the right side of the header as "FullList"
  9914. * @return void
  9915. *
  9916. * @see finishSimpleTable()
  9917. */
  9918. function startSimpleTable($header, $link = "", $arguments = "", $emptyRows = 0, $number = -1)
  9919. {
  9920. global $langs;
  9921. print '<div class="div-table-responsive-no-min">';
  9922. print '<table class="noborder centpercent">';
  9923. print '<tr class="liste_titre">';
  9924. print $emptyRows < 1 ? '<th>' : '<th colspan="'.($emptyRows + 1).'">';
  9925. print $langs->trans($header);
  9926. // extra space between the first header and the number
  9927. if ($number > -1) {
  9928. print ' ';
  9929. }
  9930. if (!empty($link)) {
  9931. if (!empty($arguments)) {
  9932. print '<a href="'.DOL_URL_ROOT.'/'.$link.'?'.$arguments.'">';
  9933. } else {
  9934. print '<a href="'.DOL_URL_ROOT.'/'.$link.'">';
  9935. }
  9936. }
  9937. if ($number > -1) {
  9938. print '<span class="badge">'.$number.'</span>';
  9939. }
  9940. if (!empty($link)) {
  9941. print '</a>';
  9942. }
  9943. print '</th>';
  9944. if ($number < 0 && !empty($link)) {
  9945. print '<th class="right">';
  9946. if (!empty($arguments)) {
  9947. print '<a class="commonlink" href="'.DOL_URL_ROOT.'/'.$link.'?'.$arguments.'">';
  9948. } else {
  9949. print '<a class="commonlink" href="'.DOL_URL_ROOT.'/'.$link.'">';
  9950. }
  9951. print $langs->trans("FullList");
  9952. print '</a>';
  9953. print '</th>';
  9954. }
  9955. print '</tr>';
  9956. }
  9957. /**
  9958. * Add the correct HTML close tags for "startSimpleTable(...)" (use after the last table line)
  9959. *
  9960. * @param bool $addLineBreak (optional) Add a extra line break after the complete table (\<br\>)
  9961. * @return void
  9962. *
  9963. * @see startSimpleTable()
  9964. */
  9965. function finishSimpleTable($addLineBreak = false)
  9966. {
  9967. print '</table>';
  9968. print '</div>';
  9969. if ($addLineBreak) {
  9970. print '<br>';
  9971. }
  9972. }
  9973. /**
  9974. * Add a summary line to the current open table ("None", "XMoreLines" or "Total xxx")
  9975. *
  9976. * @param integer $tableColumnCount The complete count columns of the table
  9977. * @param integer $num The count of the rows of the table, when it is zero (0) the "$noneWord" is shown instead
  9978. * @param integer $nbofloop (optional) The maximum count of rows thaht the table show (when it is zero (0) no summary line will show, expect "$noneWord" when $num === 0)
  9979. * @param integer $total (optional) The total value thaht is shown after when the table has minimum of one entire
  9980. * @param string $noneWord (optional) The word that is shown when the table has no entires ($num === 0)
  9981. * @param boolean $extraRightColumn (optional) Add a addtional column after the summary word and total number
  9982. * @return void
  9983. */
  9984. function addSummaryTableLine($tableColumnCount, $num, $nbofloop = 0, $total = 0, $noneWord = "None", $extraRightColumn = false)
  9985. {
  9986. global $langs;
  9987. if ($num === 0) {
  9988. print '<tr class="oddeven">';
  9989. print '<td colspan="'.$tableColumnCount.'" class="opacitymedium">'.$langs->trans($noneWord).'</td>';
  9990. print '</tr>';
  9991. return;
  9992. }
  9993. if ($nbofloop === 0) {
  9994. // don't show a summary line
  9995. return;
  9996. }
  9997. if ($num === 0) {
  9998. $colspan = $tableColumnCount;
  9999. } elseif ($num > $nbofloop) {
  10000. $colspan = $tableColumnCount;
  10001. } else {
  10002. $colspan = $tableColumnCount - 1;
  10003. }
  10004. if ($extraRightColumn) {
  10005. $colspan--;
  10006. }
  10007. print '<tr class="liste_total">';
  10008. if ($nbofloop > 0 && $num > $nbofloop) {
  10009. print '<td colspan="'.$colspan.'" class="right">'.$langs->trans("XMoreLines", ($num - $nbofloop)).'</td>';
  10010. } else {
  10011. print '<td colspan="'.$colspan.'" class="right"> '.$langs->trans("Total").'</td>';
  10012. print '<td class="right" width="100">'.price($total).'</td>';
  10013. }
  10014. if ($extraRightColumn) {
  10015. print '<td></td>';
  10016. }
  10017. print '</tr>';
  10018. }
  10019. /**
  10020. * Return a file on output using a low memory. It can return very large files with no need of memory.
  10021. * WARNING: This close output buffers.
  10022. *
  10023. * @param string $fullpath_original_file_osencoded Full path of file to return.
  10024. * @param int $method -1 automatic, 0=readfile, 1=fread, 2=stream_copy_to_stream
  10025. * @return void
  10026. */
  10027. function readfileLowMemory($fullpath_original_file_osencoded, $method = -1)
  10028. {
  10029. global $conf;
  10030. if ($method == -1) {
  10031. $method = 0;
  10032. if (!empty($conf->global->MAIN_FORCE_READFILE_WITH_FREAD)) {
  10033. $method = 1;
  10034. }
  10035. if (!empty($conf->global->MAIN_FORCE_READFILE_WITH_STREAM_COPY)) {
  10036. $method = 2;
  10037. }
  10038. }
  10039. // Be sure we don't have output buffering enabled to have readfile working correctly
  10040. while (ob_get_level()) {
  10041. ob_end_flush();
  10042. }
  10043. // Solution 0
  10044. if ($method == 0) {
  10045. readfile($fullpath_original_file_osencoded);
  10046. } elseif ($method == 1) {
  10047. // Solution 1
  10048. $handle = fopen($fullpath_original_file_osencoded, "rb");
  10049. while (!feof($handle)) {
  10050. print fread($handle, 8192);
  10051. }
  10052. fclose($handle);
  10053. } elseif ($method == 2) {
  10054. // Solution 2
  10055. $handle1 = fopen($fullpath_original_file_osencoded, "rb");
  10056. $handle2 = fopen("php://output", "wb");
  10057. stream_copy_to_stream($handle1, $handle2);
  10058. fclose($handle1);
  10059. fclose($handle2);
  10060. }
  10061. }
  10062. /**
  10063. * Create a button to copy $valuetocopy in the clipboard (for copy and paste feature).
  10064. * Code that handle the click is inside core/js/lib_foot.js.php.
  10065. *
  10066. * @param string $valuetocopy The value to print
  10067. * @param int $showonlyonhover Show the copy-paste button only on hover
  10068. * @param string $texttoshow Replace the value to show with this text. Use 'none' to show no text (only the copy-paste picto)
  10069. * @return string The string to print for the button
  10070. */
  10071. function showValueWithClipboardCPButton($valuetocopy, $showonlyonhover = 1, $texttoshow = '')
  10072. {
  10073. /*
  10074. global $conf;
  10075. if (!empty($conf->dol_no_mouse_hover)) {
  10076. $showonlyonhover = 0;
  10077. }*/
  10078. $tag = 'span'; // Using div (like any style of type 'block') does not work when using the js copy code.
  10079. if ($texttoshow === 'none') {
  10080. $result = '<span class="clipboardCP'.($showonlyonhover ? ' clipboardCPShowOnHover' : '').'"><'.$tag.' class="clipboardCPValue hidewithsize">'.dol_escape_htmltag($valuetocopy, 1, 1).'</'.$tag.'><span class="clipboardCPValueToPrint"></span><span class="clipboardCPButton far fa-clipboard opacitymedium paddingleft paddingright"></span><span class="clipboardCPText"></span></span>';
  10081. } elseif ($texttoshow) {
  10082. $result = '<span class="clipboardCP'.($showonlyonhover ? ' clipboardCPShowOnHover' : '').'"><'.$tag.' class="clipboardCPValue hidewithsize">'.dol_escape_htmltag($valuetocopy, 1, 1).'</'.$tag.'><span class="clipboardCPValueToPrint">'.dol_escape_htmltag($texttoshow, 1, 1).'</span><span class="clipboardCPButton far fa-clipboard opacitymedium paddingleft paddingright"></span><span class="clipboardCPText"></span></span>';
  10083. } else {
  10084. $result = '<span class="clipboardCP'.($showonlyonhover ? ' clipboardCPShowOnHover' : '').'"><'.$tag.' class="clipboardCPValue">'.dol_escape_htmltag($valuetocopy, 1, 1).'</'.$tag.'><span class="clipboardCPButton far fa-clipboard opacitymedium paddingleft paddingright"></span><span class="clipboardCPText"></span></span>';
  10085. }
  10086. return $result;
  10087. }
  10088. /**
  10089. * Decode an encode string. The string can be encoded in json format (recommended) or with serialize (avoid this)
  10090. *
  10091. * @param string $stringtodecode String to decode (json or serialize coded)
  10092. * @return mixed The decoded object.
  10093. */
  10094. function jsonOrUnserialize($stringtodecode)
  10095. {
  10096. $result = json_decode($stringtodecode);
  10097. if ($result === null) {
  10098. $result = unserialize($stringtodecode);
  10099. }
  10100. return $result;
  10101. }
  10102. /**
  10103. * Return if a $sqlfilters parameter is valid and will pass the preg_replace_callback() to replace Generic filter string with SQL filter string
  10104. * Example of usage:
  10105. * if ($sqlfilters) {
  10106. * $errormessage = '';
  10107. * if (dolCheckFilters($sqlfilters, $errormessage)) {
  10108. * $regexstring = '\(([^:\'\(\)]+:[^:\'\(\)]+:[^\(\)]+)\)';
  10109. * $sql .= " AND (".preg_replace_callback('/'.$regexstring.'/', 'dolForgeCriteriaCallback', $sqlfilters).")";
  10110. * }
  10111. * }
  10112. *
  10113. * @param string $sqlfilters sqlfilter string
  10114. * @param string $error Error message
  10115. * @return boolean True if valid, False if not valid ($error is filled with the reason in such a case)
  10116. */
  10117. function dolCheckFilters($sqlfilters, &$error = '')
  10118. {
  10119. //$regexstring='\(([^:\'\(\)]+:[^:\'\(\)]+:[^:\(\)]+)\)';
  10120. //$tmp=preg_replace_all('/'.$regexstring.'/', '', $sqlfilters);
  10121. $tmp = $sqlfilters;
  10122. $i = 0; $nb = strlen($tmp);
  10123. $counter = 0;
  10124. while ($i < $nb) {
  10125. if ($tmp[$i] == '(') {
  10126. $counter++;
  10127. }
  10128. if ($tmp[$i] == ')') {
  10129. $counter--;
  10130. }
  10131. if ($counter < 0) {
  10132. $error = "Bad sqlfilters=".$sqlfilters;
  10133. dol_syslog($error, LOG_WARNING);
  10134. return false;
  10135. }
  10136. $i++;
  10137. }
  10138. return true;
  10139. }
  10140. /**
  10141. * Function to forge a SQL criteria from a Generic filter string.
  10142. * Example of usage:
  10143. * if ($sqlfilters) {
  10144. * $errormessage = '';
  10145. * if (dolCheckFilters($sqlfilters, $errormessage)) {
  10146. * $regexstring = '\(([^:\'\(\)]+:[^:\'\(\)]+:[^\(\)]+)\)';
  10147. * $sql .= " AND (".preg_replace_callback('/'.$regexstring.'/', 'dolForgeCriteriaCallback', $sqlfilters).")";
  10148. * }
  10149. * }
  10150. *
  10151. * @param array $matches Array of found string by regex search.
  10152. * Example: "t.ref:like:'SO-%'" or "t.date_creation:<:'20160101'" or "t.date_creation:<:'2016-01-01 12:30:00'" or "t.nature:is:NULL"
  10153. * @return string Forged criteria. Example: "t.field like 'abc%'"
  10154. */
  10155. function dolForgeCriteriaCallback($matches)
  10156. {
  10157. global $db;
  10158. dol_syslog("Convert matches ".$matches[1]);
  10159. if (empty($matches[1])) {
  10160. return '';
  10161. }
  10162. $tmp = explode(':', $matches[1], 3);
  10163. if (count($tmp) < 3) {
  10164. return '';
  10165. }
  10166. $operand = preg_replace('/[^a-z0-9\._]/i', '', trim($tmp[0]));
  10167. $operator = strtoupper(preg_replace('/[^a-z<>!=]/i', '', trim($tmp[1])));
  10168. if ($operator == 'NOTLIKE') {
  10169. $operator = 'NOT LIKE';
  10170. }
  10171. $tmpescaped = trim($tmp[2]);
  10172. $regbis = array();
  10173. if ($operator == 'IN') {
  10174. $tmpescaped = "(".$db->sanitize($tmpescaped, 1).")";
  10175. } elseif (preg_match('/^\'(.*)\'$/', $tmpescaped, $regbis)) {
  10176. $tmpescaped = "'".$db->escape($regbis[1])."'";
  10177. } else {
  10178. $tmpescaped = $db->sanitize($db->escape($tmpescaped));
  10179. }
  10180. return $db->escape($operand).' '.$db->escape($operator)." ".$tmpescaped;
  10181. }