fhem.pl 147 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723
  1. #!/usr/bin/perl
  2. ################################################################
  3. #
  4. # Copyright notice
  5. #
  6. # (c) 2005-2018
  7. # Copyright: Rudolf Koenig (r dot koenig at koeniglich dot de)
  8. # All rights reserved
  9. #
  10. # This script free software; you can redistribute it and/or modify
  11. # it under the terms of the GNU General Public License as published by
  12. # the Free Software Foundation; either version 2 of the License, or
  13. # (at your option) any later version.
  14. #
  15. # The GNU General Public License can be found at
  16. # http://www.gnu.org/copyleft/gpl.html.
  17. # A copy is found in the textfile GPL.txt and important notices to the license
  18. # from the author is found in LICENSE.txt distributed with these scripts.
  19. #
  20. # This script is distributed in the hope that it will be useful,
  21. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  22. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  23. # GNU General Public License for more details.
  24. #
  25. # This copyright notice MUST APPEAR in all copies of the script!
  26. #
  27. # Homepage: http://fhem.de
  28. #
  29. # $Id: fhem.pl 17329 2018-09-12 07:03:11Z rudolfkoenig $
  30. use strict;
  31. use warnings;
  32. use lib '.';
  33. use IO::Socket;
  34. use IO::Socket::INET;
  35. use Time::HiRes qw(gettimeofday);
  36. use Scalar::Util qw(looks_like_number);
  37. use POSIX;
  38. use File::Copy qw(copy);
  39. ##################################################
  40. # Forward declarations
  41. #
  42. sub AddDuplicate($$);
  43. sub AnalyzeCommand($$;$);
  44. sub AnalyzeCommandChain($$;$);
  45. sub AnalyzeInput($);
  46. sub AnalyzePerlCommand($$;$);
  47. sub AssignIoPort($;$);
  48. sub AttrVal($$$);
  49. sub AttrNum($$$;$);
  50. sub CallFn(@);
  51. sub CallInstanceFn(@);
  52. sub CheckDuplicate($$@);
  53. sub Debug($);
  54. sub DoSet(@);
  55. sub Dispatch($$;$$);
  56. sub DoTrigger($$@);
  57. sub EvalSpecials($%);
  58. sub Each($$;$);
  59. sub FileDelete($);
  60. sub FileRead($);
  61. sub FileWrite($@);
  62. sub FmtDateTime($);
  63. sub FmtTime($);
  64. sub GetLogLevel(@);
  65. sub GetTimeSpec($);
  66. sub GetType($;$);
  67. sub GlobalAttr($$$$);
  68. sub HandleArchiving($;$);
  69. sub HandleTimeout();
  70. sub IOWrite($@);
  71. sub InternalTimer($$$;$);
  72. sub InternalVal($$$);
  73. sub InternalNum($$$;$);
  74. sub IsDevice($;$);
  75. sub IsDisabled($);
  76. sub IsDummy($);
  77. sub IsIgnored($);
  78. sub IsIoDummy($);
  79. sub LoadModule($;$);
  80. sub Log($$);
  81. sub Log3($$$);
  82. sub OldTimestamp($);
  83. sub OldValue($);
  84. sub OldReadingsAge($$$);
  85. sub OldReadingsNum($$$;$);
  86. sub OldReadingsTimestamp($$$);
  87. sub OldReadingsVal($$$);
  88. sub OpenLogfile($);
  89. sub PrintHash($$);
  90. sub ReadingsAge($$$);
  91. sub ReadingsNum($$$;$);
  92. sub ReadingsTimestamp($$$);
  93. sub ReadingsVal($$$);
  94. sub RefreshAuthList();
  95. sub RemoveInternalTimer($;$);
  96. sub ReplaceEventMap($$$);
  97. sub ResolveDateWildcards($@);
  98. sub SecurityCheck();
  99. sub SemicolonEscape($);
  100. sub SignalHandling();
  101. sub TimeNow();
  102. sub Value($);
  103. sub WakeUpFn($);
  104. sub WriteStatefile();
  105. sub XmlEscape($);
  106. sub addEvent($$);
  107. sub addToDevAttrList($$);
  108. sub delFromDevAttrList($$);
  109. sub addToAttrList($);
  110. sub delFromAttrList($);
  111. sub addToWritebuffer($$@);
  112. sub attrSplit($);
  113. sub computeClientArray($$);
  114. sub concatc($$$);
  115. sub configDBUsed();
  116. sub createNtfyHash();
  117. sub createUniqueId();
  118. sub devspec2array($;$);
  119. sub doGlobalDef($);
  120. sub escapeLogLine($);
  121. sub evalStateFormat($);
  122. sub fhem($@);
  123. sub fhemTimeGm($$$$$$);
  124. sub fhemTimeLocal($$$$$$);
  125. sub fhemTzOffset($);
  126. sub getAllAttr($;$);
  127. sub getAllGets($;$);
  128. sub getAllSets($;$);
  129. sub getPawList($);
  130. sub getUniqueId();
  131. sub json2nameValue($;$);
  132. sub latin1ToUtf8($);
  133. sub myrename($$$);
  134. sub notifyRegexpChanged($$);
  135. sub parseParams($;$$$);
  136. sub perlSyntaxCheck($%);
  137. sub readingsBeginUpdate($);
  138. sub readingsBulkUpdate($$$@);
  139. sub readingsEndUpdate($$);
  140. sub readingsSingleUpdate($$$$);
  141. sub readingsDelete($$);
  142. sub redirectStdinStdErr();
  143. sub rejectDuplicate($$$);
  144. sub resolveAttrRename($$);
  145. sub restoreDir_init(;$);
  146. sub restoreDir_rmTree($);
  147. sub restoreDir_saveFile($$);
  148. sub restoreDir_mkDir($$$);
  149. sub setGlobalAttrBeforeFork($);
  150. sub setReadingsVal($$$$);
  151. sub setAttrList($$);
  152. sub setDevAttrList($;$);
  153. sub toJSON($);
  154. sub utf8ToLatin1($);
  155. sub CommandAttr($$);
  156. sub CommandCancel($$);
  157. sub CommandDefaultAttr($$);
  158. sub CommandDefine($$);
  159. sub CommandDefMod($$);
  160. sub CommandDelete($$);
  161. sub CommandDeleteAttr($$);
  162. sub CommandDeleteReading($$);
  163. sub CommandDisplayAttr($$);
  164. sub CommandGet($$);
  165. sub CommandIOWrite($$);
  166. sub CommandInclude($$);
  167. sub CommandList($$);
  168. sub CommandModify($$);
  169. sub CommandQuit($$);
  170. sub CommandReload($$;$);
  171. sub CommandRename($$);
  172. sub CommandRereadCfg($$);
  173. sub CommandSave($$);
  174. sub CommandSet($$);
  175. sub CommandSetReading($$);
  176. sub CommandSetstate($$);
  177. sub CommandShutdown($$);
  178. sub CommandSleep($$);
  179. sub CommandTrigger($$);
  180. # configDB special
  181. sub cfgDB_Init;
  182. sub cfgDB_ReadAll($);
  183. sub cfgDB_SaveState;
  184. sub cfgDB_SaveCfg;
  185. sub cfgDB_AttrRead($);
  186. sub cfgDB_ReadFile($);
  187. sub cfgDB_UpdateFile($);
  188. sub cfgDB_WriteFile($@);
  189. ##################################################
  190. # Variables:
  191. # global, to be able to access them from modules
  192. #Special values in %modules (used if set):
  193. # AttrFn - called for attribute changes
  194. # DefFn - define a "device" of this type
  195. # DeleteFn - clean up (delete logfile), called by delete after UndefFn
  196. # ExceptFn - called if the global select reports an except field
  197. # FingerprintFn - convert messages for duplicate detection
  198. # GetFn - get some data from this device
  199. # NotifyFn - call this if some device changed its properties
  200. # ParseFn - Interpret a raw message
  201. # ReadFn - Reading from a Device (see FHZ/WS300)
  202. # ReadyFn - check for available data, if no FD
  203. # RenameFn - inform the device about its renameing
  204. # SetFn - set/activate this device
  205. # ShutdownFn-called before shutdown
  206. # StateFn - set local info for this device, do not activate anything
  207. # UndefFn - clean up (delete timer, close fd), called by delete and rereadcfg
  208. #Special values in %defs:
  209. # TYPE - The name of the module it belongs to
  210. # STATE - Oneliner describing its state
  211. # NR - its "serial" number
  212. # DEF - its definition
  213. # READINGS- The readings. Each value has a "VAL" and a "TIME" component.
  214. # FD - FileDescriptor. Used by selectlist / readyfnlist
  215. # IODev - attached to io device
  216. # CHANGED - Currently changed attributes of this device. Used by NotifyFn
  217. # VOLATILE- Set if the definition should be saved to the "statefile"
  218. # NOTIFYDEV - if set, the notifyFn will only be called for this device
  219. use vars qw($auth_refresh);
  220. use vars qw($cmdFromAnalyze); # used by the warnings-sub
  221. use vars qw($lastWarningMsg); # set by the warnings-sub
  222. use vars qw($cvsid); # used in 98_version.pm
  223. use vars qw($devcount); # Maximum device number, used for storing
  224. use vars qw($featurelevel);
  225. use vars qw($fhem_started); # used for uptime calculation
  226. use vars qw($init_done); #
  227. use vars qw($internal_data); # FileLog/DbLog -> SVG data transport
  228. use vars qw($lastDefChange); # number of last def/attr change
  229. use vars qw($nextat); # Time when next timer will be triggered.
  230. use vars qw($readytimeout); # Polling interval. UNIX: device search only
  231. use vars qw($reread_active);
  232. use vars qw($selectTimestamp); # used to check last select exit timestamp
  233. use vars qw($winService); # the Windows Service object
  234. use vars qw(%attr); # Attributes
  235. use vars qw(%cmds); # Global command name hash.
  236. use vars qw(%data); # Hash for user data
  237. use vars qw(%defaultattr); # Default attributes, used by FHEM2FHEM
  238. use vars qw(%defs); # FHEM device/button definitions
  239. use vars qw(%inform); # Used by telnet_ActivateInform
  240. use vars qw(%intAt); # Internal timer hash, used by apptime
  241. use vars qw(@intAtA); # Internal timer array
  242. use vars qw(%logInform); # Used by FHEMWEB/Event-Monitor
  243. use vars qw(%modules); # List of loaded modules (device/log/etc)
  244. use vars qw(%ntfyHash); # hash of devices needed to be notified.
  245. use vars qw(%oldvalue); # Old values, see commandref.html
  246. use vars qw(%readyfnlist); # devices which want a "readyfn"
  247. use vars qw(%selectlist); # devices which want a "select"
  248. use vars qw(%value); # Current values, see commandref.html
  249. use vars qw(@authenticate); # List of authentication devices
  250. use vars qw(@authorize); # List of authorization devices
  251. use vars qw(@structChangeHist); # Contains the last 10 structural changes
  252. use vars qw($haveInet6); # Using INET6
  253. use vars qw(%prioQueues); #
  254. use vars qw($fhemForked); # 1 in a fhemFork()'ed process, else undef
  255. use vars qw($addTimerStacktrace);# set to 1 by fhemdebug
  256. $selectTimestamp = gettimeofday();
  257. $cvsid = '$Id: fhem.pl 17329 2018-09-12 07:03:11Z rudolfkoenig $';
  258. my $AttrList = "alias comment:textField-long eventMap:textField-long ".
  259. "group room suppressReading userReadings:textField-long ".
  260. "verbose:0,1,2,3,4,5";
  261. my $currcfgfile=""; # current config/include file
  262. my $currlogfile; # logfile, without wildcards
  263. my $duplidx=0; # helper for the above pool
  264. my $evalSpecials; # Used by EvalSpecials->AnalyzeCommand
  265. my $intAtCnt=0;
  266. my $logopened = 0; # logfile opened or using stdout
  267. my $namedef = "where <name> is a single device name, a list separated by comma (,) or a regexp. See the devspec section in the commandref.html for details.\n";
  268. my $rcvdquit; # Used for quit handling in init files
  269. my $readingsUpdateDelayTrigger; # needed internally
  270. my $gotSig; # non-undef if got a signal
  271. my $wbName = ".WRITEBUFFER"; # Buffer-name for delayed writing via select
  272. my %comments; # Comments from the include files
  273. my %duplicate; # Pool of received msg for multi-fhz/cul setups
  274. my @cmdList; # Remaining commands in a chain. Used by sleep
  275. my %sleepers; # list of sleepers
  276. $init_done = 0;
  277. $lastDefChange = 0;
  278. $readytimeout = ($^O eq "MSWin32") ? 0.1 : 5.0;
  279. $featurelevel = 5.8; # see also GlobalAttr
  280. $modules{Global}{ORDER} = -1;
  281. $modules{Global}{LOADED} = 1;
  282. no warnings 'qw';
  283. my @globalAttrList = qw(
  284. altitude
  285. apiversion
  286. archivecmd
  287. archivedir
  288. archivesort:timestamp,alphanum
  289. archiveCompress
  290. autoload_undefined_devices:1,0
  291. autosave:1,0
  292. backup_before_update
  293. backupcmd
  294. backupdir
  295. backupsymlink
  296. blockingCallMax
  297. commandref:modular,full
  298. configfile
  299. dnsHostsFile
  300. dnsServer
  301. dupTimeout
  302. exclude_from_update
  303. featurelevel:5.5,5.6,5.7,5.8,99.99
  304. genericDisplayType:switch,outlet,light,blind,speaker,thermostat
  305. holiday2we
  306. httpcompress:0,1
  307. keyFileName
  308. language:EN,DE
  309. lastinclude
  310. latitude
  311. logdir
  312. logfile
  313. longitude
  314. modpath
  315. motd
  316. mseclog:1,0
  317. nofork:1,0
  318. nrarchive
  319. perlSyntaxCheck:0,1
  320. pidfilename
  321. proxy
  322. proxyAuth
  323. proxyExclude
  324. restartDelay
  325. restoreDirs
  326. sendStatistics:onUpdate,manually,never
  327. showInternalValues:1,0
  328. sslVersion
  329. stacktrace:1,0
  330. statefile
  331. title
  332. updateInBackground:1,0
  333. updateNoFileCheck:1,0
  334. useInet6:1,0
  335. version
  336. );
  337. use warnings 'qw';
  338. $modules{Global}{AttrList} = join(" ", @globalAttrList);
  339. $modules{Global}{AttrFn} = "GlobalAttr";
  340. use vars qw($readingFnAttributes);
  341. no warnings 'qw';
  342. my @attrList = qw(
  343. event-aggregator
  344. event-min-interval
  345. event-on-change-reading
  346. event-on-update-reading
  347. oldreadings
  348. stateFormat:textField-long
  349. timestamp-on-change-reading
  350. );
  351. $readingFnAttributes = join(" ", @attrList);
  352. my %ra = (
  353. "suppressReading" => { s=>"\n" },
  354. "event-aggregator" => { s=>",", c=>".attraggr" },
  355. "event-on-update-reading" => { s=>",", c=>".attreour" },
  356. "event-on-change-reading" => { s=>",", c=>".attreocr", r=>":.*" },
  357. "timestamp-on-change-reading"=> { s=>",", c=>".attrtocr" },
  358. "event-min-interval" => { s=>",", c=>".attrminint", r=>":.*" },
  359. "oldreadings" => { s=>",", c=>".or" },
  360. "devStateIcon" => { s=>" ", r=>":.*", p=>"^{.*}\$",
  361. pv=>{"%name"=>1, "%state"=>1, "%type"=>1} },
  362. );
  363. %cmds = (
  364. "?" => { ReplacedBy => "help" },
  365. "attr" => { Fn=>"CommandAttr",
  366. Hlp=>"<devspec> <attrname> [<attrval>],set attribute for <devspec>"},
  367. "cancel" => { Fn=>"CommandCancel",
  368. Hlp=>"[<id> [quiet]],list sleepers, cancel sleeper with <id>" },
  369. "createlog"=> { ModuleName => "autocreate" },
  370. "define" => { Fn=>"CommandDefine",
  371. Hlp=>"<name> <type> <options>,define a device" },
  372. "defmod" => { Fn=>"CommandDefMod",
  373. Hlp=>"<name> <type> <options>,define or modify a device" },
  374. "deleteattr" => { Fn=>"CommandDeleteAttr",
  375. Hlp=>"<devspec> [<attrname>],delete attribute for <devspec>" },
  376. "deletereading" => { Fn=>"CommandDeleteReading",
  377. Hlp=>"<devspec> [<attrname>],delete user defined reading for ".
  378. "<devspec>" },
  379. "delete" => { Fn=>"CommandDelete",
  380. Hlp=>"<devspec>,delete the corresponding definition(s)"},
  381. "displayattr"=> { Fn=>"CommandDisplayAttr",
  382. Hlp=>"<devspec> [attrname],display attributes" },
  383. "get" => { Fn=>"CommandGet",
  384. Hlp=>"<devspec> <type dependent>,request data from <devspec>" },
  385. "include" => { Fn=>"CommandInclude",
  386. Hlp=>"<filename>,read the commands from <filenname>" },
  387. "iowrite" => { Fn=>"CommandIOWrite",
  388. Hlp=>"<iodev> <data>,write raw data with iodev" },
  389. "list" => { Fn=>"CommandList",
  390. Hlp=>"[-r] [devspec],list definitions and status info" },
  391. "modify" => { Fn=>"CommandModify",
  392. Hlp=>"device <options>,modify the definition (e.g. at, notify)" },
  393. "quit" => { Fn=>"CommandQuit",
  394. ClientFilter => "telnet",
  395. Hlp=>",end the client session" },
  396. "exit" => { Fn=>"CommandQuit",
  397. ClientFilter => "telnet",
  398. Hlp=>",end the client session" },
  399. "reload" => { Fn=>"CommandReload",
  400. Hlp=>"<module-name>,reload the given module (e.g. 99_PRIV)" },
  401. "rename" => { Fn=>"CommandRename",
  402. Hlp=>"<old> <new>,rename a definition" },
  403. "rereadcfg" => { Fn=>"CommandRereadCfg",
  404. Hlp=>"[configfile],read in the config after deleting everything" },
  405. "restore" => {
  406. Hlp=>"[list] [<filename|directory>],restore files saved by update"},
  407. "save" => { Fn=>"CommandSave",
  408. Hlp=>"[configfile],write the configfile and the statefile" },
  409. "set" => { Fn=>"CommandSet",
  410. Hlp=>"<devspec> <type dependent>,transmit code for <devspec>" },
  411. "setreading" => { Fn=>"CommandSetReading",
  412. Hlp=>"<devspec> <reading> <value>,set reading for <devspec>" },
  413. "setstate"=> { Fn=>"CommandSetstate",
  414. Hlp=>"<devspec> <state>,set the state shown in the command list" },
  415. "setdefaultattr" => { Fn=>"CommandDefaultAttr",
  416. Hlp=>"<attrname> <attrvalue>,set attr for following definitions" },
  417. "shutdown"=> { Fn=>"CommandShutdown",
  418. Hlp=>"[restart|exitValue],terminate the server" },
  419. "sleep" => { Fn=>"CommandSleep",
  420. Hlp=>"<sec> [<id>] [quiet],sleep for sec, 3 decimal places" },
  421. "trigger" => { Fn=>"CommandTrigger",
  422. Hlp=>"<devspec> <state>,trigger notify command" },
  423. "update" => {
  424. Hlp => "[<fileName>|all|check|force] ".
  425. "[http://.../controlfile],update FHEM" },
  426. "updatefhem" => { ReplacedBy => "update" },
  427. "usb" => { ModuleName => "autocreate" },
  428. );
  429. ###################################################
  430. # Start the program
  431. my $fhemdebug;
  432. $fhemdebug = shift @ARGV if($ARGV[0] eq "-d");
  433. if(int(@ARGV) < 1) {
  434. print "Usage:\n";
  435. print "as server: fhem configfile\n";
  436. print "as client: fhem [host:]port cmd cmd cmd...\n";
  437. if($^O =~ m/Win/) {
  438. print "install as windows service: fhem.pl configfile -i\n";
  439. print "uninstall the windows service: fhem.pl -u\n";
  440. }
  441. exit(1);
  442. }
  443. # If started as root, and there is a fhem user in the /etc/passwd, su to it
  444. if($^O !~ m/Win/ && $< == 0) {
  445. my @pw = getpwnam("fhem");
  446. if(@pw) {
  447. use POSIX qw(setuid setgid);
  448. # set primary group
  449. setgid($pw[3]);
  450. # read all secondary groups into an array:
  451. my @groups;
  452. while ( my ($name, $pw, $gid, $members) = getgrent() ) {
  453. push(@groups, $gid) if ( grep($_ eq $pw[0],split(/\s+/,$members)) );
  454. }
  455. # set the secondary groups via $)
  456. if (@groups) {
  457. $) = "$pw[3] ".join(" ",@groups);
  458. } else {
  459. $) = "$pw[3] $pw[3]";
  460. }
  461. setuid($pw[2]);
  462. }
  463. }
  464. ###################################################
  465. # Client code
  466. if(int(@ARGV) > 1 && $ARGV[$#ARGV] ne "-i") {
  467. my $buf;
  468. my $addr = shift @ARGV;
  469. $addr = "localhost:$addr" if($addr !~ m/:/);
  470. my $client = IO::Socket::INET->new(PeerAddr => $addr);
  471. die "Can't connect to $addr\n" if(!$client);
  472. for(my $i=0; $i < int(@ARGV); $i++) {
  473. syswrite($client, $ARGV[$i]."\n");
  474. }
  475. shutdown($client, 1);
  476. while(sysread($client, $buf, 256) > 0) {
  477. $buf =~ s/\xff\xfb\x01Password: //;
  478. $buf =~ s/\xff\xfc\x01\r\n//;
  479. $buf =~ s/\xff\xfd\x00//;
  480. print($buf);
  481. }
  482. exit(0);
  483. }
  484. # End of client code
  485. ###################################################
  486. SignalHandling();
  487. ###################################################
  488. # Windows Service Support: install/remove or start the fhem service
  489. if($^O =~ m/Win/) {
  490. (my $dir = $0) =~ s+[/\\][^/\\]*$++; # Find the FHEM directory
  491. chdir($dir);
  492. $winService = eval {require FHEM::WinService; FHEM::WinService->new(\@ARGV);};
  493. if((!$winService || $@) && ($ARGV[$#ARGV] eq "-i" || $ARGV[$#ARGV] eq "-u")) {
  494. print "Cannot initialize FHEM::WinService: $@, exiting.\n";
  495. exit 0;
  496. }
  497. }
  498. $winService ||= {};
  499. ###################################################
  500. # Server initialization
  501. doGlobalDef($ARGV[0]);
  502. if(configDBUsed()) {
  503. eval "use configDB";
  504. Log 1, $@ if($@);
  505. cfgDB_Init();
  506. }
  507. # As newer Linux versions reset serial parameters after fork, we parse the
  508. # config file after the fork. But we need some global attr parameters before, so we
  509. # read them here.
  510. setGlobalAttrBeforeFork($attr{global}{configfile});
  511. Log 1, $_ for eval{@{$winService->{ServiceLog}};};
  512. # Go to background if the logfile is a real file (not stdout)
  513. if($^O =~ m/Win/ && !$attr{global}{nofork}) {
  514. $attr{global}{nofork}=1;
  515. }
  516. if($attr{global}{logfile} ne "-" && !$attr{global}{nofork}) {
  517. defined(my $pid = fork) || die "Can't fork: $!";
  518. exit(0) if $pid;
  519. }
  520. # FritzBox special: Wait until the time is set via NTP,
  521. # but not more than 2 hours
  522. if(gettimeofday() < 2*3600) {
  523. Log 1, "date/time not set, waiting up to 2 hours to be set.";
  524. while(gettimeofday() < 2*3600) {
  525. sleep(5);
  526. }
  527. }
  528. ###################################################
  529. # initialize the readings semantics meta information
  530. require RTypes;
  531. RTypes_Initialize();
  532. my $cfgErrMsg = "Messages collected while initializing FHEM:";
  533. my $cfgRet="";
  534. if(configDBUsed()) {
  535. my $ret = cfgDB_ReadAll(undef);
  536. $cfgRet .= "configDB: $ret\n" if($ret);
  537. } else {
  538. my $ret = CommandInclude(undef, $attr{global}{configfile});
  539. $cfgRet .= "configfile: $ret\n" if($ret);
  540. my $stateFile = $attr{global}{statefile};
  541. if($stateFile) {
  542. my @t = localtime(gettimeofday());
  543. $stateFile = ResolveDateWildcards($stateFile, @t);
  544. if(-r $stateFile) {
  545. $ret = CommandInclude(undef, $stateFile);
  546. $cfgRet .= "$stateFile: $ret\n" if($ret);
  547. }
  548. }
  549. }
  550. my $pfn = $attr{global}{pidfilename};
  551. if($pfn) {
  552. die "$pfn: $!\n" if(!open(PID, ">$pfn"));
  553. print PID $$ . "\n";
  554. close(PID);
  555. }
  556. $init_done = 1;
  557. $lastDefChange = 1;
  558. foreach my $d (keys %defs) {
  559. if($defs{$d}{IODevMissing}) {
  560. if($defs{$d}{IODevName} && $defs{$defs{$d}{IODevName}}) {
  561. $defs{$d}{IODev} = $defs{$defs{$d}{IODevName}};
  562. delete $defs{$d}{IODevName};
  563. } else {
  564. Log 3, "No I/O device found for $defs{$d}{NAME}";
  565. }
  566. delete $defs{$d}{IODevMissing};
  567. }
  568. }
  569. if($cfgRet) {
  570. $attr{global}{autosave} = 0;
  571. $attr{global}{motd} = "$cfgErrMsg\n$cfgRet\nAutosave deactivated";
  572. Log 1, $cfgRet;
  573. } elsif($attr{global}{motd} && $attr{global}{motd} =~ m/^$cfgErrMsg/) {
  574. $attr{global}{motd} = "";
  575. } else {
  576. SecurityCheck();
  577. }
  578. $fhem_started = int(gettimeofday());
  579. DoTrigger("global", "INITIALIZED", 1);
  580. my $osuser = "os:$^O user:".(getlogin || getpwuid($<) || "unknown");
  581. Log 0, "Featurelevel: $featurelevel";
  582. Log 0, "Server started with ".int(keys %defs).
  583. " defined entities ($attr{global}{version} perl:$] $osuser pid:$$)";
  584. ################################################
  585. # Main Loop
  586. sub MAIN {MAIN:}; #Dummy
  587. my $errcount= 0;
  588. $gotSig = undef if($gotSig && $gotSig eq "HUP");
  589. while (1) {
  590. my ($rout,$rin, $wout,$win, $eout,$ein) = ('','', '','', '','');
  591. my $nfound = 0;
  592. my $timeout = HandleTimeout();
  593. foreach my $p (keys %selectlist) {
  594. my $hash = $selectlist{$p};
  595. if(defined($hash->{FD})) {
  596. vec($rin, $hash->{FD}, 1) = 1
  597. if(!defined($hash->{directWriteFn}) && !$hash->{wantWrite} );
  598. vec($win, $hash->{FD}, 1) = 1
  599. if( (defined($hash->{directWriteFn}) ||
  600. defined($hash->{$wbName}) ||
  601. $hash->{wantWrite} ) && !$hash->{wantRead} );
  602. }
  603. vec($ein, $hash->{EXCEPT_FD}, 1) = 1
  604. if(defined($hash->{"EXCEPT_FD"}));
  605. if($hash->{SSL} && $hash->{CD} &&
  606. $hash->{CD}->can('pending') && $hash->{CD}->pending()) {
  607. vec($rout, $hash->{FD}, 1) = 1;
  608. $nfound++;
  609. }
  610. }
  611. $timeout = $readytimeout if(keys(%readyfnlist) &&
  612. (!defined($timeout) || $timeout > $readytimeout));
  613. $timeout = 5 if $winService->{AsAService} && $timeout > 5;
  614. $nfound = select($rout=$rin, $wout=$win, $eout=$ein, $timeout) if(!$nfound);
  615. $winService->{serviceCheck}->() if($winService->{serviceCheck});
  616. if($gotSig) {
  617. CommandShutdown(undef, undef) if($gotSig eq "TERM");
  618. CommandRereadCfg(undef, "") if($gotSig eq "HUP");
  619. $gotSig = undef;
  620. }
  621. if($nfound < 0) {
  622. my $err = int($!);
  623. next if($err==0 || $err==4); # 4==EINTR
  624. Log 1, "ERROR: Select error $nfound ($err), error count= $errcount";
  625. $errcount++;
  626. # Handling "Bad file descriptor". This is a programming error.
  627. if($err == 9) { # BADF, don't want to "use errno.ph"
  628. my $nbad = 0;
  629. foreach my $p (keys %selectlist) {
  630. my ($tin, $tout) = ('', '');
  631. vec($tin, $selectlist{$p}{FD}, 1) = 1;
  632. if(select($tout=$tin, undef, undef, 0) < 0) {
  633. Log 1, "Found and deleted bad fileno for $p";
  634. delete($selectlist{$p});
  635. $nbad++;
  636. }
  637. }
  638. next if($nbad > 0);
  639. next if($errcount <= 3);
  640. }
  641. die("Select error $nfound ($err)\n");
  642. } else {
  643. $errcount= 0;
  644. }
  645. ###############################
  646. # Message from the hardware (FHZ1000/WS3000/etc) via select or the Ready
  647. # Function. The latter ist needed for Windows, where USB devices are not
  648. # reported by select, but is used by unix too, to check if the device is
  649. # attached again.
  650. foreach my $p (keys %selectlist) {
  651. next if(!$p); # Deleted in the loop
  652. my $hash = $selectlist{$p};
  653. my $isDev = ($hash && $hash->{NAME} && $defs{$hash->{NAME}});
  654. my $isDirect = ($hash && ($hash->{directReadFn} || $hash->{directWriteFn}));
  655. next if(!$isDev && !$isDirect);
  656. if(defined($hash->{FD}) && vec($rout, $hash->{FD}, 1)) {
  657. delete $hash->{wantRead};
  658. if($hash->{directReadFn}) {
  659. $hash->{directReadFn}($hash);
  660. } else {
  661. CallFn($hash->{NAME}, "ReadFn", $hash);
  662. }
  663. }
  664. if( defined($hash->{FD}) && vec($wout, $hash->{FD}, 1)) {
  665. delete $hash->{wantWrite};
  666. if($hash->{directWriteFn}) {
  667. $hash->{directWriteFn}($hash);
  668. } elsif(defined($hash->{$wbName})) {
  669. my $wb = $hash->{$wbName};
  670. alarm($hash->{ALARMTIMEOUT}) if($hash->{ALARMTIMEOUT});
  671. my $ret;
  672. eval { $ret = syswrite($hash->{CD}, $wb); };
  673. if($@) {
  674. Log 4, "Syswrite: $@, deleting $hash->{NAME}";
  675. TcpServer_Close($hash);
  676. CommandDelete(undef, $hash->{NAME});
  677. next;
  678. }
  679. my $werr = int($!);
  680. alarm(0) if($hash->{ALARMTIMEOUT});
  681. if(!defined($ret) && $werr == EWOULDBLOCK ) {
  682. $hash->{wantRead} = 1
  683. if(TcpServer_WantRead($hash));
  684. } elsif(!$ret) { # zero=EOF, undef=error
  685. Log 4, "Write error to $p, deleting $hash->{NAME}";
  686. TcpServer_Close($hash);
  687. CommandDelete(undef, $hash->{NAME});
  688. } else {
  689. if($ret >= length($wb)) { # for the > see Forum #29963
  690. delete($hash->{$wbName});
  691. if($hash->{WBCallback}) {
  692. no strict "refs";
  693. my $ret = &{$hash->{WBCallback}}($hash);
  694. use strict "refs";
  695. delete $hash->{WBCallback};
  696. }
  697. } else {
  698. $hash->{$wbName} = substr($wb, $ret);
  699. }
  700. }
  701. }
  702. }
  703. if(defined($hash->{"EXCEPT_FD"}) && vec($eout, $hash->{EXCEPT_FD}, 1)) {
  704. CallFn($hash->{NAME}, "ExceptFn", $hash);
  705. }
  706. }
  707. foreach my $p (keys %readyfnlist) {
  708. next if(!$readyfnlist{$p}); # due to rereadcfg / delete
  709. if(CallFn($readyfnlist{$p}{NAME}, "ReadyFn", $readyfnlist{$p})) {
  710. if($readyfnlist{$p}) { # delete itself inside ReadyFn
  711. CallFn($readyfnlist{$p}{NAME}, "ReadFn", $readyfnlist{$p});
  712. }
  713. }
  714. }
  715. }
  716. ################################################
  717. #Functions ahead, no more "plain" code
  718. ################################################
  719. sub
  720. IsDevice($;$)
  721. {
  722. my $devname = shift;
  723. my $devtype = shift;
  724. return 1
  725. if ( defined($devname)
  726. && defined( $defs{$devname} )
  727. && (!$devtype || $devtype eq "" ) );
  728. return 1
  729. if ( defined($devname)
  730. && defined( $defs{$devname} )
  731. && defined( $defs{$devname}{TYPE} )
  732. && $defs{$devname}{TYPE} =~ m/^$devtype$/ );
  733. return 0;
  734. }
  735. sub
  736. IsDummy($)
  737. {
  738. my $devname = shift;
  739. return 1 if(defined($attr{$devname}) && defined($attr{$devname}{dummy}));
  740. return 0;
  741. }
  742. sub
  743. IsIgnored($)
  744. {
  745. my $devname = shift;
  746. if($devname &&
  747. defined($attr{$devname}) && $attr{$devname}{ignore}) {
  748. Log 4, "Ignoring $devname";
  749. return 1;
  750. }
  751. return 0;
  752. }
  753. sub
  754. IsDisabled($)
  755. {
  756. my $devname = shift;
  757. return 0 if(!$devname || !defined($attr{$devname}));
  758. return 1 if($attr{$devname}{disable});
  759. return 3 if($defs{$devname} && $defs{$devname}{STATE} &&
  760. $defs{$devname}{STATE} eq "inactive");
  761. return 3 if(ReadingsVal($devname, "state", "") eq "inactive");
  762. my $dfi = $attr{$devname}{disabledForIntervals};
  763. if(defined($dfi)) {
  764. $dfi =~ s/{([^\x7d]*)}/$cmdFromAnalyze=$1; eval $1/ge; # Forum #69787
  765. my ($sec,$min,$hour,$mday,$month,$year,$wday,$yday,$isdst) =
  766. localtime(gettimeofday());
  767. my $dhms = sprintf("%s\@%02d:%02d:%02d", $wday, $hour, $min, $sec);
  768. foreach my $ft (split(" ", $dfi)) {
  769. my ($from, $to) = split("-", $ft);
  770. if(defined($from) && defined($to)) {
  771. $from = "$wday\@$from" if(index($from,"@") < 0);
  772. $to = "$wday\@$to" if(index($to, "@") < 0);
  773. return 2 if($from le $dhms && $dhms le $to);
  774. }
  775. }
  776. }
  777. return 0;
  778. }
  779. ################################################
  780. sub
  781. IsIoDummy($)
  782. {
  783. my $name = shift;
  784. return IsDummy($defs{$name}{IODev}{NAME})
  785. if($defs{$name} && $defs{$name}{IODev});
  786. return 1;
  787. }
  788. ################################################
  789. sub
  790. GetLogLevel(@)
  791. {
  792. my ($dev,$deflev) = @_;
  793. my $df = defined($deflev) ? $deflev : 2;
  794. return $df if(!defined($dev));
  795. return $attr{$dev}{loglevel}
  796. if(defined($attr{$dev}) && defined($attr{$dev}{loglevel}));
  797. return $df;
  798. }
  799. sub
  800. GetVerbose($)
  801. {
  802. my ($dev) = @_;
  803. if(defined($dev) &&
  804. defined($attr{$dev}) &&
  805. defined (my $devlevel = $attr{$dev}{verbose})) {
  806. return $devlevel;
  807. } else {
  808. return $attr{global}{verbose};
  809. }
  810. }
  811. sub
  812. GetType($;$)
  813. {
  814. my $devname = shift;
  815. my $default = shift;
  816. return $default unless ( IsDevice($devname) && $defs{$devname}{TYPE} );
  817. return $defs{$devname}{TYPE};
  818. }
  819. ################################################
  820. # the new Log with integrated loglevel checking
  821. sub
  822. Log3($$$)
  823. {
  824. my ($dev, $loglevel, $text) = @_;
  825. $dev = $dev->{NAME} if(defined($dev) && ref($dev) eq "HASH");
  826. if(defined($dev) &&
  827. defined($attr{$dev}) &&
  828. defined (my $devlevel = $attr{$dev}{verbose})) {
  829. return if($loglevel > $devlevel);
  830. } else {
  831. return if($loglevel > $attr{global}{verbose});
  832. }
  833. my ($seconds, $microseconds) = gettimeofday();
  834. my @t = localtime($seconds);
  835. my $nfile = ResolveDateWildcards($attr{global}{logfile}, @t);
  836. OpenLogfile($nfile) if(!$currlogfile || $currlogfile ne $nfile);
  837. my $tim = sprintf("%04d.%02d.%02d %02d:%02d:%02d",
  838. $t[5]+1900,$t[4]+1,$t[3], $t[2],$t[1],$t[0]);
  839. if($attr{global}{mseclog}) {
  840. $tim .= sprintf(".%03d", $microseconds/1000);
  841. }
  842. if($logopened) {
  843. print LOG "$tim $loglevel: $text\n";
  844. } else {
  845. print "$tim $loglevel: $text\n";
  846. }
  847. no strict "refs";
  848. foreach my $li (keys %logInform) {
  849. if($defs{$li}) {
  850. &{$logInform{$li}}($li, "$tim $loglevel : $text");
  851. } else {
  852. delete $logInform{$li};
  853. }
  854. }
  855. use strict "refs";
  856. return undef;
  857. }
  858. ################################################
  859. sub
  860. Log($$)
  861. {
  862. my ($loglevel, $text) = @_;
  863. Log3(undef, $loglevel, $text);
  864. }
  865. #####################################
  866. sub
  867. IOWrite($@)
  868. {
  869. my ($hash, @a) = @_;
  870. my $dev = $hash->{NAME};
  871. return if(IsDummy($dev) || IsIgnored($dev));
  872. my $iohash = $hash->{IODev};
  873. if(!$iohash ||
  874. !$iohash->{TYPE} ||
  875. !$modules{$iohash->{TYPE}} ||
  876. !$modules{$iohash->{TYPE}}{WriteFn}) {
  877. Log 5, "No IO device or WriteFn found for $dev";
  878. return;
  879. }
  880. return if(IsDummy($iohash->{NAME}));
  881. no strict "refs";
  882. my $ret = &{$modules{$iohash->{TYPE}}{WriteFn}}($iohash, @a);
  883. use strict "refs";
  884. return $ret;
  885. }
  886. #####################################
  887. sub
  888. CommandIOWrite($$)
  889. {
  890. my ($cl, $param) = @_;
  891. my @a = split(" ", $param);
  892. return "Usage: iowrite <iodev> <param> ..." if(int(@a) < 2);
  893. my $name = shift(@a);
  894. my $hash = $defs{$name};
  895. return "$name not found" if(!$hash);
  896. return undef if(IsDummy($name) || IsIgnored($name));
  897. if(!$hash->{TYPE} ||
  898. !$modules{$hash->{TYPE}} ||
  899. !$modules{$hash->{TYPE}}{WriteFn}) {
  900. Log 1, "No IO device or WriteFn found for $name";
  901. return;
  902. }
  903. unshift(@a, "") if(int(@a) == 1);
  904. no strict "refs";
  905. my $ret = &{$modules{$hash->{TYPE}}{WriteFn}}($hash, @a);
  906. use strict "refs";
  907. return $ret;
  908. }
  909. #####################################
  910. # i.e. split a line by ; (escape ;;), and execute each
  911. sub
  912. AnalyzeCommandChain($$;$)
  913. {
  914. my ($c, $cmd) = @_;
  915. my @ret;
  916. if($cmd =~ m/^[ \t]*(#.*)?$/) { # Save comments
  917. if(!$init_done) {
  918. if($currcfgfile ne AttrVal("global", "statefile", "")) {
  919. my $nr = $devcount++;
  920. $comments{$nr}{TEXT} = $cmd;
  921. $comments{$nr}{CFGFN} = $currcfgfile
  922. if($currcfgfile ne AttrVal("global", "configfile", ""));
  923. }
  924. }
  925. return undef;
  926. }
  927. $cmd =~ s/^\s*#.*$//s; # Remove comments at the beginning of the line
  928. $cmd =~ s/;;/SeMiCoLoN/g;
  929. my @saveCmdList = @cmdList; # Needed for recursive calls
  930. @cmdList = split(";", $cmd);
  931. my $subcmd;
  932. my $localEvalSpecials = $evalSpecials;
  933. while(defined($subcmd = shift @cmdList)) {
  934. $subcmd =~ s/SeMiCoLoN/;/g;
  935. $evalSpecials = $localEvalSpecials;
  936. my $lret = AnalyzeCommand($c, $subcmd, "ACC");
  937. push(@ret, $lret) if(defined($lret));
  938. }
  939. @cmdList = @saveCmdList;
  940. $evalSpecials = undef;
  941. return join("\n", @ret) if(@ret);
  942. return undef;
  943. }
  944. #####################################
  945. sub
  946. AnalyzePerlCommand($$;$)
  947. {
  948. my ($cl, $cmd, $calledFromChain) = @_; # third parmeter is deprecated
  949. return "Forbidden command $cmd." if($cl && !Authorized($cl, "cmd", "perl"));
  950. $cmd =~ s/\\ *\n/ /g; # Multi-line. Probably not needed anymore
  951. # Make life easier for oneliners:
  952. if($featurelevel <= 5.6) {
  953. %value = ();
  954. foreach my $d (keys %defs) {
  955. $value{$d} = $defs{$d}{STATE}
  956. }
  957. }
  958. my ($sec,$min,$hour,$mday,$month,$year,$wday,$yday,$isdst) =
  959. localtime(gettimeofday());
  960. my $hms = sprintf("%02d:%02d:%02d", $hour, $min, $sec);
  961. my $we = (($wday==0 || $wday==6) ? 1 : 0);
  962. if(!$we) {
  963. foreach my $h2we (split(",", AttrVal("global", "holiday2we", ""))) {
  964. my ($a, $b) = ReplaceEventMap($h2we, [$h2we, Value($h2we)], 0);
  965. $we = 1 if($b && $b ne "none");
  966. }
  967. }
  968. $month++;
  969. $year+=1900;
  970. my $today = sprintf('%04d-%02d-%02d', $year,$month,$mday);
  971. if($evalSpecials) {
  972. $cmd = join("", map { my $n = substr($_,1); # ignore the %
  973. my $v = $evalSpecials->{$_};
  974. $v =~ s/(['\\])/\\$1/g;
  975. "my \$$n='$v';";
  976. } keys %{$evalSpecials})
  977. . $cmd;
  978. # Normally this is deleted in AnalyzeCommandChain, but ECMDDevice calls us
  979. # directly, and combining perl with something else isnt allowed anyway.
  980. $evalSpecials = undef if(!$calledFromChain);
  981. }
  982. $cmdFromAnalyze = $cmd;
  983. my $ret = eval $cmd;
  984. if($@) {
  985. $ret = $@;
  986. Log 1, "ERROR evaluating $cmd: $ret";
  987. }
  988. $cmdFromAnalyze = undef;
  989. return $ret;
  990. }
  991. sub
  992. AnalyzeCommand($$;$)
  993. {
  994. my ($cl, $cmd, $calledFromChain) = @_;
  995. $cmd = "" if(!defined($cmd)); # Forum #29963
  996. $cmd =~ s/^(\n|[ \t])*//;# Strip space or \n at the begginning
  997. $cmd =~ s/[ \t]*$//;
  998. Log 5, "Cmd: >$cmd<";
  999. if(!$cmd) {
  1000. $evalSpecials = undef if(!$calledFromChain || $calledFromChain ne "ACC");
  1001. return undef;
  1002. }
  1003. if($cmd =~ m/^{.*}$/s) { # Perl code
  1004. return AnalyzePerlCommand($cl, $cmd, 1);
  1005. }
  1006. if($cmd =~ m/^"(.*)"$/s) { # Shell code in bg, to be able to call us from it
  1007. return "Forbidden command $cmd." if($cl && !Authorized($cl,"cmd","shell"));
  1008. if($evalSpecials) {
  1009. map { $ENV{substr($_,1)} = $evalSpecials->{$_}; } keys %{$evalSpecials};
  1010. $evalSpecials = undef if(!$calledFromChain || $calledFromChain ne "ACC");
  1011. }
  1012. my $out = "";
  1013. $out = ">> $currlogfile 2>&1" if($currlogfile ne "-" && $^O ne "MSWin32");
  1014. system("$1 $out &");
  1015. return undef;
  1016. }
  1017. $cmd =~ s/^[ \t]*//;
  1018. if($evalSpecials) {
  1019. map { my $n = substr($_,1); my $v = $evalSpecials->{$_};
  1020. $cmd =~ s/\$$n/$v/g; } sort { $b cmp $a } keys %{$evalSpecials};
  1021. $evalSpecials = undef if(!$calledFromChain || $calledFromChain ne "ACC");
  1022. }
  1023. my ($fn, $param) = split("[ \t][ \t]*", $cmd, 2);
  1024. return undef if(!$fn);
  1025. #############
  1026. # Search for abbreviation
  1027. sub
  1028. getAbbr($$)
  1029. {
  1030. my ($fn,$h) = @_;
  1031. my $lcfn = lc($fn);
  1032. my $fnlen = length($fn);
  1033. return $fn if(defined($h->{$fn}));
  1034. foreach my $f (sort keys %{$h}) {
  1035. if(length($f) >= $fnlen && lc(substr($f,0,$fnlen)) eq $lcfn) {
  1036. Log 5, "AnalyzeCommand: trying $f for $fn";
  1037. return $f;
  1038. }
  1039. }
  1040. return undef;
  1041. }
  1042. my $lfn = getAbbr($fn,\%cmds);
  1043. $fn = $lfn if($lfn);
  1044. $fn = $cmds{$fn}{ReplacedBy}
  1045. if(defined($cmds{$fn}) && defined($cmds{$fn}{ReplacedBy}));
  1046. #############
  1047. # autoload command with ModuleName
  1048. if(!$cmds{$fn} || !defined($cmds{$fn}{Fn})) {
  1049. my $modName;
  1050. $modName = $cmds{$fn}{ModuleName} if($cmds{$fn} && $cmds{$fn}{ModuleName});
  1051. $modName = getAbbr($fn,\%modules) if(!$modName);
  1052. LoadModule($modName) if($modName);
  1053. my $lfn = getAbbr($fn,\%cmds);
  1054. $fn = $lfn if($lfn);
  1055. }
  1056. return "Unknown command $fn, try help." if(!$cmds{$fn} || !$cmds{$fn}{Fn});
  1057. return "Forbidden command $fn."
  1058. if($cl &&
  1059. $cmd !~ m/^(set|get|attr)\s+[^ ]+\s+\?$/ &&
  1060. !Authorized($cl, "cmd", $fn));
  1061. if($cl && $cmds{$fn}{ClientFilter} &&
  1062. $cl->{TYPE} !~ m/$cmds{$fn}{ClientFilter}/) {
  1063. return "This command ($fn) is not valid for this input channel.";
  1064. }
  1065. $param = "" if(!defined($param));
  1066. no strict "refs";
  1067. my $ret = &{$cmds{$fn}{Fn} }($cl, $param, $fn);
  1068. use strict "refs";
  1069. return undef if(defined($ret) && $ret eq "");
  1070. return $ret;
  1071. }
  1072. sub
  1073. devspec2array($;$)
  1074. {
  1075. my ($name, $cl) = @_;
  1076. return "" if(!defined($name));
  1077. if(defined($defs{$name})) {
  1078. if($cl && !Authorized($cl, "devicename", $name)) {
  1079. Log 4, "Forbidden device $name";
  1080. return "";
  1081. }
  1082. # FHEM2FHEM LOG mode fake device, avoid local set/attr/etc operations on it
  1083. return "FHEM2FHEM_FAKE_$name" if($defs{$name}{FAKEDEVICE});
  1084. return $name;
  1085. }
  1086. my (@ret, $isAttr);
  1087. foreach my $l (split(",", $name)) { # List of elements
  1088. if(defined($defs{$l})) {
  1089. push @ret, $l;
  1090. next;
  1091. }
  1092. my @names = sort keys %defs;
  1093. my @res;
  1094. foreach my $dName (split(":FILTER=", $l)) {
  1095. my ($n,$op,$re) = ("NAME","=",$dName);
  1096. if($dName =~ m/^(.*?)(=|!=|~|!~|<=|>=|<|>)(.*)$/) {
  1097. ($n,$op,$re) = ($1,$2,$3);
  1098. $isAttr = 1; # Compatibility: return "" instead of $name
  1099. }
  1100. ($n,$op,$re) = ($1,"eval","") if($dName =~ m/^{(.*)}$/);
  1101. my $fType="";
  1102. if($n =~ m/^(.:)(.*$)/) {
  1103. $fType = $1;
  1104. $n = $2;
  1105. }
  1106. @res=();
  1107. foreach my $d (@names) {
  1108. next if($attr{$d} && $attr{$d}{ignore});
  1109. if($op eq "eval") {
  1110. my $exec = EvalSpecials($n, %{{"%DEVICE"=>$d}});
  1111. push @res, $d if(AnalyzePerlCommand($cl, $exec));
  1112. next;
  1113. }
  1114. my $hash = $defs{$d};
  1115. if(!$hash->{TYPE}) {
  1116. Log 1, "Error: >$d< has no TYPE, but following keys: >".
  1117. join(",", sort keys %{$hash})."<";
  1118. delete($defs{$d});
  1119. next;
  1120. }
  1121. my $val;
  1122. $val = $hash->{$n} if(!$fType || $fType eq "i:");
  1123. if(!defined($val) && (!$fType || $fType eq "r:")) {
  1124. my $r = $hash->{READINGS};
  1125. $val = $r->{$n}{VAL} if($r && $r->{$n});
  1126. }
  1127. if(!defined($val) && (!$fType || $fType eq "a:")) {
  1128. $val = $attr{$d}{$n} if($attr{$d});
  1129. }
  1130. $val="" if(!defined($val));
  1131. $val = $val->{NAME} if(ref($val) eq 'HASH' && $val->{NAME}); # IODev
  1132. my $lre = ($n eq "room" || $n eq "group") ?
  1133. "(^|,)($re)(,|\$)" : "^($re)\$";
  1134. my $valReNum =(looks_like_number($val) && looks_like_number($re) ? 1:0);
  1135. eval { # a bad regexp is deadly
  1136. if(($op eq "=" && $val =~ m/$lre/s) ||
  1137. ($op eq "!=" && $val !~ m/$lre/s) ||
  1138. ($op eq "~" && $val =~ m/$lre/is) ||
  1139. ($op eq "!~" && $val !~ m/$lre/is) ||
  1140. ($op eq "<" && $valReNum && $val < $re) ||
  1141. ($op eq ">" && $valReNum && $val > $re) ||
  1142. ($op eq "<=" && $valReNum && $val <= $re) ||
  1143. ($op eq ">=" && $valReNum && $val >= $re)) {
  1144. push @res, $d
  1145. }
  1146. };
  1147. if($@) {
  1148. Log 1, "devspec2array $name: $@";
  1149. stacktrace();
  1150. return $name;
  1151. }
  1152. }
  1153. @names = @res;
  1154. }
  1155. push @ret,@res;
  1156. }
  1157. return $name if(!@ret && !$isAttr);
  1158. @ret = grep { Authorized($cl, "devicename", $_) } @ret if($cl);
  1159. return @ret;
  1160. }
  1161. #####################################
  1162. sub
  1163. CommandInclude($$)
  1164. {
  1165. my ($cl, $arg) = @_;
  1166. my $fh;
  1167. my @ret;
  1168. my $oldcfgfile;
  1169. if(!open($fh, $arg)) {
  1170. return "Can't open $arg: $!";
  1171. }
  1172. Log 1, "Including $arg";
  1173. my @t = localtime(gettimeofday());
  1174. my $gcfg = ResolveDateWildcards(AttrVal("global", "configfile", ""), @t);
  1175. my $stf = ResolveDateWildcards(AttrVal("global", "statefile", ""), @t);
  1176. if(!$init_done && $arg ne $stf && $arg ne $gcfg) {
  1177. my $nr = $devcount++;
  1178. $comments{$nr}{TEXT} = "include $arg";
  1179. $comments{$nr}{CFGFN} = $currcfgfile if($currcfgfile ne $gcfg);
  1180. }
  1181. $oldcfgfile = $currcfgfile;
  1182. $currcfgfile = $arg;
  1183. my $bigcmd = "";
  1184. my $lineno = 0;
  1185. $rcvdquit = 0;
  1186. while(my $l = <$fh>) {
  1187. $lineno++;
  1188. $l =~ s/[\r\n]//g;
  1189. if($l =~ m/^(.*)\\ *$/) { # Multiline commands
  1190. $bigcmd .= "$1\n";
  1191. } else {
  1192. my $tret = AnalyzeCommandChain($cl, $bigcmd . $l);
  1193. if(defined($tret)) {
  1194. Log 5, "$arg line $lineno returned >$tret<";
  1195. push @ret, $tret;
  1196. }
  1197. $bigcmd = "";
  1198. }
  1199. last if($rcvdquit);
  1200. }
  1201. $currcfgfile = $oldcfgfile;
  1202. close($fh);
  1203. return join("\n", @ret) if(@ret);
  1204. return undef;
  1205. }
  1206. #####################################
  1207. sub
  1208. OpenLogfile($)
  1209. {
  1210. my $param = shift;
  1211. close(LOG);
  1212. $logopened=0;
  1213. $currlogfile = $param;
  1214. # STDOUT is closed in windows services per default
  1215. if(!$winService->{AsAService} && $currlogfile eq "-") {
  1216. open LOG, '>&STDOUT' || die "Can't dup stdout: $!";
  1217. } else {
  1218. HandleArchiving($defs{global}) if($defs{global}{currentlogfile});
  1219. $defs{global}{currentlogfile} = $param;
  1220. $defs{global}{logfile} = $attr{global}{logfile};
  1221. open(LOG, ">>$currlogfile") || return("Can't open $currlogfile: $!");
  1222. redirectStdinStdErr();
  1223. }
  1224. LOG->autoflush(1);
  1225. $logopened = 1;
  1226. $defs{global}{FD} = LOG->fileno();
  1227. return undef;
  1228. }
  1229. sub
  1230. redirectStdinStdErr()
  1231. {
  1232. # Redirect stdin/stderr
  1233. return if(!$currlogfile || $currlogfile eq "-");
  1234. open STDIN, '</dev/null' or print "Can't read /dev/null: $!\n";
  1235. close(STDERR);
  1236. open(STDERR, ">>$currlogfile") or print "Can't append STDERR to log: $!\n";
  1237. STDERR->autoflush(1);
  1238. close(STDOUT);
  1239. open STDOUT, '>&STDERR' or print "Can't dup stdout: $!\n";
  1240. STDOUT->autoflush(1);
  1241. }
  1242. #####################################
  1243. sub
  1244. CommandRereadCfg($$)
  1245. {
  1246. my ($cl, $param) = @_;
  1247. my $name = ($cl ? $cl->{NAME} : "__anonymous__");
  1248. my $cfgfile = ($param ? $param : $attr{global}{configfile});
  1249. return "Cannot open $cfgfile: $!"
  1250. if(! -f $cfgfile && !configDBUsed());
  1251. $attr{global}{configfile} = $cfgfile;
  1252. WriteStatefile();
  1253. $reread_active=1;
  1254. $init_done = 0;
  1255. foreach my $d (sort { $defs{$b}{NR} <=> $defs{$a}{NR} } keys %defs) {
  1256. my $ret = CallFn($d, "UndefFn", $defs{$d}, $d)
  1257. if($name && $name ne $d);
  1258. Log 1, "$d is against deletion ($ret), continuing with rereadcfg anyway"
  1259. if($ret);
  1260. delete $defs{$d};
  1261. }
  1262. %comments = ();
  1263. %defs = ();
  1264. %attr = ();
  1265. %selectlist = ();
  1266. %readyfnlist = ();
  1267. my $informMe = $inform{$name};
  1268. %inform = ();
  1269. doGlobalDef($cfgfile);
  1270. my $ret;
  1271. if(configDBUsed()) {
  1272. $ret = cfgDB_ReadAll($cl);
  1273. } else {
  1274. setGlobalAttrBeforeFork($cfgfile);
  1275. $ret = CommandInclude($cl, $cfgfile);
  1276. if($attr{global}{statefile} && -r $attr{global}{statefile}) {
  1277. my $ret2 = CommandInclude($cl, $attr{global}{statefile});
  1278. $ret = (defined($ret) ? "$ret\n$ret2" : $ret2) if(defined($ret2));
  1279. }
  1280. }
  1281. $defs{$name} = $selectlist{$name} = $cl if($name && $name ne "__anonymous__");
  1282. $inform{$name} = $informMe if($informMe);
  1283. @structChangeHist = ();
  1284. $lastDefChange++;
  1285. DoTrigger("global", "REREADCFG", 1);
  1286. $init_done = 1;
  1287. $reread_active=0;
  1288. return $ret;
  1289. }
  1290. #####################################
  1291. sub
  1292. CommandQuit($$)
  1293. {
  1294. my ($cl, $param) = @_;
  1295. if(!$cl) {
  1296. $rcvdquit = 1;
  1297. } else {
  1298. $cl->{rcvdQuit} = 1;
  1299. return "Bye..." if($cl->{prompt});
  1300. }
  1301. return undef;
  1302. }
  1303. sub
  1304. GetAllReadings($)
  1305. {
  1306. my ($d) = @_;
  1307. my @ret;
  1308. my $val = $defs{$d}{STATE};
  1309. if(defined($val) &&
  1310. $val ne "unknown" &&
  1311. $val ne "Initialized" &&
  1312. $val ne "" &&
  1313. $val ne "???") {
  1314. $val =~ s/;/;;/g;
  1315. $val =~ s/([ \t])/sprintf("\\%03o",ord($1))/eg if($val =~ m/^[ \t]*$/);
  1316. $val =~ s/\n/\\\n/g;
  1317. push @ret, "setstate $d $val";
  1318. }
  1319. #############
  1320. # Now the detailed list
  1321. my $r = $defs{$d}{READINGS};
  1322. if($r) {
  1323. foreach my $c (sort keys %{$r}) {
  1324. my $rd = $r->{$c};
  1325. if(!defined($rd->{TIME})) {
  1326. Log 4, "WriteStatefile $d $c: Missing TIME, using current time";
  1327. $rd->{TIME} = TimeNow();
  1328. }
  1329. if(!defined($rd->{VAL})) {
  1330. Log 4, "WriteStatefile $d $c: Missing VAL, setting it to 0";
  1331. $rd->{VAL} = 0;
  1332. }
  1333. my $val = $rd->{VAL};
  1334. $val =~ s/;/;;/g;
  1335. $val =~ s/\n/\\\n/g;
  1336. push @ret,"setstate $d $rd->{TIME} $c $val";
  1337. }
  1338. }
  1339. return @ret;
  1340. }
  1341. #####################################
  1342. sub
  1343. WriteStatefile()
  1344. {
  1345. if(configDBUsed()) {
  1346. return cfgDB_SaveState();
  1347. }
  1348. my $stateFile = AttrVal('global','statefile',undef);
  1349. return "No statefile specified" if(!defined($stateFile));
  1350. my $now = gettimeofday();
  1351. my @t = localtime($now);
  1352. $stateFile = ResolveDateWildcards($stateFile, @t);
  1353. if(!open(SFH, ">$stateFile")) {
  1354. my $msg = "WriteStatefile: Cannot open $stateFile: $!";
  1355. Log 1, $msg;
  1356. return $msg;
  1357. }
  1358. my $t = localtime($now);
  1359. print SFH "#$t\n";
  1360. foreach my $d (sort keys %defs) {
  1361. next if($defs{$d}{TEMPORARY});
  1362. if($defs{$d}{VOLATILE}) {
  1363. my $def = $defs{$d}{DEF};
  1364. $def =~ s/;/;;/g; # follow-on-for-timer at
  1365. print SFH "define $d $defs{$d}{TYPE} $def\n";
  1366. }
  1367. my @arr = GetAllReadings($d);
  1368. print SFH join("\n", @arr)."\n" if(@arr);
  1369. }
  1370. return "$attr{global}{statefile}: $!" if(!close(SFH));
  1371. return "";
  1372. }
  1373. sub
  1374. GetDefAndAttr($)
  1375. {
  1376. my ($d) = @_;
  1377. my @ret;
  1378. if($d ne "global") {
  1379. my $def = $defs{$d}{DEF};
  1380. if(defined($def)) {
  1381. $def =~ s/;/;;/g;
  1382. $def =~ s/\n/\\\n/g;
  1383. push @ret,"define $d $defs{$d}{TYPE} $def";
  1384. } else {
  1385. push @ret,"define $d $defs{$d}{TYPE}";
  1386. }
  1387. }
  1388. foreach my $a (sort {
  1389. return -1 if($a eq "userattr"); # userattr must be first
  1390. return 1 if($b eq "userattr");
  1391. return $a cmp $b;
  1392. } keys %{$attr{$d}}) {
  1393. next if($d eq "global" &&
  1394. ($a eq "configfile" || $a eq "version"));
  1395. my $val = $attr{$d}{$a};
  1396. $val =~ s/;/;;/g;
  1397. $val =~ s/\n/\\\n/g;
  1398. push @ret,"attr $d $a $val";
  1399. }
  1400. return @ret;
  1401. }
  1402. #####################################
  1403. sub
  1404. CommandSave($$)
  1405. {
  1406. my ($cl, $param) = @_;
  1407. if($param && $param eq "?") {
  1408. return "No structural changes." if(!@structChangeHist);
  1409. return "Last 10 structural changes:\n ".join("\n ", @structChangeHist);
  1410. }
  1411. if(!$cl && !AttrVal("global", "autosave", 1)) { # Forum #78769
  1412. Log 4, "Skipping save, as autosave is disabled";
  1413. return;
  1414. }
  1415. my $restoreDir;
  1416. $restoreDir = restoreDir_init("save") if(!configDBUsed());
  1417. @structChangeHist = ();
  1418. DoTrigger("global", "SAVE", 1);
  1419. restoreDir_saveFile($restoreDir, $attr{global}{statefile});
  1420. my $ret = WriteStatefile();
  1421. return $ret if($ret);
  1422. $ret = ""; # cfgDB_SaveState may return undef
  1423. if(configDBUsed()) {
  1424. $ret = cfgDB_SaveCfg();
  1425. return ($ret ? $ret : "Saved configuration to the DB");
  1426. }
  1427. $param = $attr{global}{configfile} if(!$param);
  1428. return "No configfile attribute set and no argument specified" if(!$param);
  1429. restoreDir_saveFile($restoreDir, $param);
  1430. if(!open(SFH, ">$param")) {
  1431. return "Cannot open $param: $!";
  1432. }
  1433. my %fh = ("configfile" => *SFH);
  1434. my %skip;
  1435. my %devByNr;
  1436. map { $devByNr{$defs{$_}{NR}} = $_ } keys %defs;
  1437. for(my $i = 0; $i < $devcount; $i++) {
  1438. my ($h, $d);
  1439. if($comments{$i}) {
  1440. $h = $comments{$i};
  1441. } else {
  1442. $d = $devByNr{$i};
  1443. next if(!defined($d) ||
  1444. $defs{$d}{TEMPORARY} || # e.g. WEBPGM connections
  1445. $defs{$d}{VOLATILE}); # e.g at, will be saved to the statefile
  1446. $h = $defs{$d};
  1447. }
  1448. my $cfgfile = $h->{CFGFN} ? $h->{CFGFN} : "configfile";
  1449. my $fh = $fh{$cfgfile};
  1450. if(!$fh) {
  1451. restoreDir_saveFile($restoreDir, $cfgfile);
  1452. if(!open($fh, ">$cfgfile")) {
  1453. $ret .= "Cannot open $cfgfile: $!, ignoring its content\n";
  1454. $fh{$cfgfile} = 1;
  1455. $skip{$cfgfile} = 1;
  1456. } else {
  1457. $fh{$cfgfile} = $fh;
  1458. }
  1459. }
  1460. next if($skip{$cfgfile});
  1461. if(!defined($d)) {
  1462. print $fh $h->{TEXT},"\n";
  1463. next;
  1464. }
  1465. my @arr = GetDefAndAttr($d);
  1466. print $fh join("\n", @arr)."\n" if(@arr);
  1467. }
  1468. print SFH "include $attr{global}{lastinclude}\n"
  1469. if($attr{global}{lastinclude} && $featurelevel <= 5.6);
  1470. foreach my $key (keys %fh) {
  1471. next if($fh{$key} eq "1"); ## R/O include files
  1472. $ret .= "$key: $!" if(!close($fh{$key}));
  1473. }
  1474. return ($ret ? $ret : "Wrote configuration to $param");
  1475. }
  1476. #####################################
  1477. sub
  1478. CommandShutdown($$)
  1479. {
  1480. my ($cl, $param) = @_;
  1481. my $exitValue = 0;
  1482. if($param && $param =~ m/^(\d+)$/) {
  1483. $exitValue = $1;
  1484. $param = "";
  1485. }
  1486. return "Usage: shutdown [restart|exitvalue]"
  1487. if($param && $param ne "restart");
  1488. DoTrigger("global", "SHUTDOWN", 1);
  1489. Log 0, "Server shutdown";
  1490. foreach my $d (sort keys %defs) {
  1491. CallFn($d, "ShutdownFn", $defs{$d});
  1492. }
  1493. WriteStatefile();
  1494. unlink($attr{global}{pidfilename}) if($attr{global}{pidfilename});
  1495. if($param && $param eq "restart") {
  1496. if ($^O !~ m/Win/) {
  1497. system("(sleep " . AttrVal("global", "restartDelay", 2) .
  1498. "; exec $^X $0 $attr{global}{configfile})&");
  1499. } elsif ($winService->{AsAService}) {
  1500. # use the OS SCM to stop and start the service
  1501. exec('cmd.exe /C net stop fhem & net start fhem');
  1502. }
  1503. }
  1504. exit($exitValue);
  1505. }
  1506. #####################################
  1507. sub
  1508. ReplaceSetMagic($$@) # Forum #38276
  1509. {
  1510. my $hash = shift;
  1511. my $nsplit = shift;
  1512. my $a = join(" ", @_);
  1513. my $oa = $a;
  1514. sub
  1515. rsmVal($$$$$)
  1516. {
  1517. my ($all, $t, $d, $n, $s, $val) = @_;
  1518. my $hash = $defs{$d};
  1519. return $all if(!$hash);
  1520. if(!$t || $t eq "r:") {
  1521. my $r = $hash->{READINGS};
  1522. if($s && ($s eq ":t" || $s eq ":sec")) {
  1523. return $all if (!$r || !$r->{$n});
  1524. $val = $r->{$n}{TIME};
  1525. $val = int(gettimeofday()) - time_str2num($val) if($s eq ":sec");
  1526. return $val;
  1527. }
  1528. $val = $r->{$n}{VAL} if($r && $r->{$n});
  1529. }
  1530. $val = $hash->{$n} if(!defined($val) && (!$t || $t eq "i:"));
  1531. $val = $attr{$d}{$n} if(!defined($val) && (!$t || $t eq "a:") && $attr{$d});
  1532. return $all if(!defined($val));
  1533. if($s && $s =~ /:d|:r|:i/ && $val =~ /(-?\d+(\.\d+)?)/) {
  1534. $val = $1;
  1535. $val = int($val) if ( $s eq ":i" );
  1536. $val = round($val, defined($1) ? $1 : 1) if($s =~ /^:r(\d)?/);
  1537. }
  1538. return $val;
  1539. }
  1540. $a =~s/(\[([ari]:)?([a-zA-Z\d._]+):([a-zA-Z\d._\/-]+)(:(t|sec|i|d|r|r\d))?\])/
  1541. rsmVal($1,$2,$3,$4,$5)/eg;
  1542. my $esDef = ($evalSpecials ? 1 : 0);
  1543. $evalSpecials->{'%DEV'} = $hash->{NAME};
  1544. $a =~ s/{\((.*?)\)}/AnalyzePerlCommand($hash->{CL},$1,1)/egs;
  1545. $evalSpecials = undef if(!$esDef);;
  1546. return (undef, @_) if($oa eq $a);
  1547. return (undef, split(/ /, $a, $nsplit));
  1548. }
  1549. #####################################
  1550. sub
  1551. DoSet(@)
  1552. {
  1553. my @a = @_;
  1554. my $dev = $a[0];
  1555. my $hash = $defs{$dev};
  1556. return "Please define $dev first" if(!$hash);
  1557. return "Bogus entry $dev without TYPE" if(!$hash->{TYPE});
  1558. return "No set implemented for $dev" if(!$modules{$hash->{TYPE}}{SetFn});
  1559. # No special handling needed fo the Usage check
  1560. return CallFn($dev, "SetFn", $hash,
  1561. $modules{$hash->{TYPE}}->{parseParams} ? parseParams(\@a) : @a)
  1562. if($a[1] && $a[1] eq "?");
  1563. @a = ReplaceEventMap($dev, \@a, 0) if($attr{$dev}{eventMap});
  1564. my $err;
  1565. ($err, @a) = ReplaceSetMagic($hash, 0, @a) if($featurelevel >= 5.7);
  1566. return $err if($err);
  1567. $hash->{".triggerUsed"} = 0;
  1568. my ($ret, $skipTrigger) = CallFn($dev, "SetFn", $hash,
  1569. $modules{$hash->{TYPE}}->{parseParams} ? parseParams(\@a) : @a);
  1570. return $ret if($ret);
  1571. return undef if($skipTrigger);
  1572. # Backward compatibility. Use readingsUpdate in SetFn now
  1573. # case: DoSet is called from a notify triggered by DoSet with same dev
  1574. if(defined($hash->{".triggerUsed"}) && $hash->{".triggerUsed"} == 0) {
  1575. shift @a;
  1576. # set arg if the module did not triggered events
  1577. my $arg;
  1578. $arg = join(" ", @a) if(!$hash->{CHANGED} || !int(@{$hash->{CHANGED}}));
  1579. DoTrigger($dev, $arg, 0);
  1580. }
  1581. delete($hash->{".triggerUsed"});
  1582. return undef;
  1583. }
  1584. #####################################
  1585. sub
  1586. CommandSet($$)
  1587. {
  1588. my ($cl, $param) = @_;
  1589. my @a = split("[ \t][ \t]*", $param);
  1590. return "Usage: set <name> <type-dependent-options>\n$namedef" if(int(@a)<1);
  1591. my @rets;
  1592. foreach my $sdev (devspec2array($a[0], $a[1] && $a[1] eq "?" ? undef : $cl)) {
  1593. $a[0] = $sdev;
  1594. $defs{$sdev}->{CL} = $cl if($defs{$sdev});
  1595. my $ret = DoSet(@a);
  1596. delete $defs{$sdev}->{CL} if($defs{$sdev});
  1597. push @rets, $ret if($ret);
  1598. }
  1599. return join("\n", @rets);
  1600. }
  1601. #####################################
  1602. sub
  1603. CommandGet($$)
  1604. {
  1605. my ($cl, $param) = @_;
  1606. my @a = split("[ \t][ \t]*", $param);
  1607. return "Usage: get <name> <type-dependent-options>\n$namedef" if(int(@a) < 1);
  1608. my @rets;
  1609. foreach my $sdev (devspec2array($a[0], $a[1] && $a[1] eq "?" ? undef : $cl)) {
  1610. if(!defined($defs{$sdev})) {
  1611. push @rets, "Please define $sdev first";
  1612. next;
  1613. }
  1614. if(!$modules{$defs{$sdev}{TYPE}}{GetFn}) {
  1615. push @rets, "No get implemented for $sdev";
  1616. next;
  1617. }
  1618. $a[0] = $sdev;
  1619. $defs{$sdev}->{CL} = $cl;
  1620. my $ret = CallFn($sdev, "GetFn", $defs{$sdev},
  1621. $modules{$defs{$sdev}->{TYPE}}->{parseParams} ? parseParams(\@a) : @a);
  1622. delete $defs{$sdev}->{CL};
  1623. push @rets, $ret if(defined($ret) && $ret ne "");
  1624. }
  1625. return join("\n", @rets);
  1626. }
  1627. sub
  1628. asyncOutput($$)
  1629. {
  1630. my ($cl, $ret) = @_;
  1631. return undef if(!$cl || !$cl->{NAME});
  1632. my $temporary;
  1633. if($defs{$cl->{NAME}}) {
  1634. $cl = $defs{$cl->{NAME}}; # Compatibility
  1635. } else {
  1636. $defs{$cl->{NAME}} = $cl; # timeconsuming answer: get fd ist already closed
  1637. $temporary = 1;
  1638. }
  1639. CallFn($cl->{NAME}, "AsyncOutputFn", $cl, $ret);
  1640. delete $defs{$cl->{NAME}} if($temporary);
  1641. return undef;
  1642. }
  1643. #####################################
  1644. sub
  1645. LoadModule($;$)
  1646. {
  1647. my ($m, $ignoreErr) = @_;
  1648. if($modules{$m} && !$modules{$m}{LOADED}) { # autoload
  1649. my $o = $modules{$m}{ORDER};
  1650. my $ret = CommandReload(undef, "${o}_$m", $ignoreErr);
  1651. if($ret) {
  1652. Log 0, $ret if(!$ignoreErr);
  1653. return "UNDEFINED";
  1654. }
  1655. if(!$modules{$m}{LOADED}) { # Case corrected by reload?
  1656. foreach my $i (keys %modules) {
  1657. if(uc($m) eq uc($i) && $modules{$i}{LOADED}) {
  1658. delete($modules{$m});
  1659. $m = $i;
  1660. last;
  1661. }
  1662. }
  1663. }
  1664. }
  1665. return $m;
  1666. }
  1667. #####################################
  1668. sub
  1669. CommandDefine($$)
  1670. {
  1671. my ($cl, $def) = @_;
  1672. my @a = split("[ \t]+", $def, 3);
  1673. my ($ignoreErr, $temporary);
  1674. # used by RSS in fhem.cfg.demo, with no GD installed
  1675. if($a[0] && $a[0] eq "-ignoreErr") {
  1676. $def =~ s/\s*-ignoreErr\s*//;
  1677. @a = split("[ \t][ \t]*", $def, 3);
  1678. $ignoreErr = 1;
  1679. }
  1680. if($a[0] && $a[0] eq "-temporary") { # Forum #39610, 46640
  1681. $def =~ s/\s*-temporary\s*//;
  1682. @a = split("[ \t][ \t]*", $def, 3);
  1683. $temporary = 1;
  1684. }
  1685. my $name = $a[0];
  1686. return "Usage: define <name> <type> <type dependent arguments>"
  1687. if(int(@a) < 2);
  1688. return "$name already defined, delete it first" if(defined($defs{$name}));
  1689. return "Invalid characters in name (not A-Za-z0-9._): $name"
  1690. if(!goodDeviceName($name));
  1691. my $m = $a[1];
  1692. if(!$modules{$m}) { # Perhaps just wrong case?
  1693. foreach my $i (keys %modules) {
  1694. if(uc($m) eq uc($i)) {
  1695. $m = $i;
  1696. last;
  1697. }
  1698. }
  1699. }
  1700. my $newm = LoadModule($m, $ignoreErr);
  1701. return "Cannot load module $m" if($newm eq "UNDEFINED");
  1702. $m = $newm;
  1703. return "Unknown module $m" if(!$modules{$m} || !$modules{$m}{DefFn});
  1704. my %hash;
  1705. $hash{NAME} = $name;
  1706. $hash{TYPE} = $m;
  1707. $hash{STATE} = "???";
  1708. $hash{DEF} = $a[2] if(int(@a) > 2);
  1709. $hash{NR} = $devcount++;
  1710. $hash{CFGFN} = $currcfgfile
  1711. if($currcfgfile ne AttrVal("global", "configfile", ""));
  1712. $hash{CL} = $cl;
  1713. # If the device wants to issue initialization gets/sets, then it needs to be
  1714. # in the global hash.
  1715. $defs{$name} = \%hash;
  1716. my $ret = CallFn($name, "DefFn", \%hash,
  1717. $modules{$m}->{parseParams} ? parseParams($def) : $def);
  1718. if($ret) {
  1719. Log 1, "define $def: $ret" if(!$ignoreErr);
  1720. delete $defs{$name}; # Veto
  1721. delete $attr{$name};
  1722. } else {
  1723. delete $hash{CL};
  1724. $hash{TEMPORARY} = 1 if($temporary);
  1725. foreach my $da (sort keys (%defaultattr)) { # Default attributes
  1726. CommandAttr($cl, "$name $da $defaultattr{$da}");
  1727. }
  1728. if($modules{$m}{NotifyFn} && !$hash{NTFY_ORDER}) {
  1729. $hash{NTFY_ORDER} = ($modules{$m}{NotifyOrderPrefix} ?
  1730. $modules{$m}{NotifyOrderPrefix} : "50-") . $name;
  1731. }
  1732. %ntfyHash = ();
  1733. addStructChange("define", $name, $def);
  1734. DoTrigger("global", "DEFINED $name", 1) if($init_done);
  1735. }
  1736. return ($ret && $ignoreErr ?
  1737. "Cannot define $name, remove -ignoreErr for details" : $ret);
  1738. }
  1739. #####################################
  1740. sub
  1741. CommandModify($$)
  1742. {
  1743. my ($cl, $def) = @_;
  1744. my @a = split("[ \t]+", $def, 2);
  1745. return "Usage: modify <name> <type dependent arguments>"
  1746. if(int(@a) < 1);
  1747. # Return a list of modules
  1748. return "Define $a[0] first" if(!defined($defs{$a[0]}));
  1749. my $hash = $defs{$a[0]};
  1750. %ntfyHash = () if($hash->{NTFY_ORDER});
  1751. $hash->{OLDDEF} = $hash->{DEF};
  1752. $hash->{DEF} = $a[1];
  1753. $hash->{CL} = $cl;
  1754. my $ret = CallFn($a[0], "DefFn", $hash,
  1755. $modules{$hash->{TYPE}}->{parseParams} ?
  1756. parseParams("$a[0] $hash->{TYPE}".(defined($a[1]) ? " $a[1]":"")):
  1757. "$a[0] $hash->{TYPE}".(defined($a[1]) ? " $a[1]" : ""));
  1758. delete $hash->{CL};
  1759. if($ret) {
  1760. $hash->{DEF} = $hash->{OLDDEF};
  1761. } else {
  1762. addStructChange("modify", $a[0], $def);
  1763. DoTrigger("global", "MODIFIED $a[0]", 1) if($init_done);
  1764. }
  1765. delete($hash->{OLDDEF});
  1766. return $ret;
  1767. }
  1768. #####################################
  1769. sub
  1770. CommandDefMod($$)
  1771. {
  1772. my ($cl, $def) = @_;
  1773. my @a = split("[ \t]+", $def, 3);
  1774. return "Usage: defmod <name> <type> <type dependent arguments>"
  1775. if(int(@a) < 2);
  1776. if($a[0] eq "-temporary" && $defs{$a[1]}) {
  1777. @a = split("[ \t]+", $def, 4);
  1778. shift @a;
  1779. }
  1780. if($defs{$a[0]}) {
  1781. $def = $a[2] ? "$a[0] $a[2]" : $a[0];
  1782. return "defmod $a[0]: Cannot change the TYPE of an existing definition"
  1783. if($a[1] ne $defs{$a[0]}{TYPE});
  1784. return CommandModify($cl, $def);
  1785. } else {
  1786. return CommandDefine($cl, $def);
  1787. }
  1788. }
  1789. #############
  1790. # internal
  1791. sub
  1792. AssignIoPort($;$)
  1793. {
  1794. my ($hash, $proposed) = @_;
  1795. my $ht = $hash->{TYPE};
  1796. my $hn = $hash->{NAME};
  1797. my $hasIODevAttr = ($ht &&
  1798. $modules{$ht}{AttrList} &&
  1799. $modules{$ht}{AttrList} =~ m/IODev/);
  1800. $proposed = $attr{$hn}{IODev}
  1801. if(!$proposed && $attr{$hn} && $attr{$hn}{IODev});
  1802. if($proposed && $defs{$proposed} && IsDisabled($proposed) != 1) {
  1803. $hash->{IODev} = $defs{$proposed};
  1804. $attr{$hn}{IODev} = $proposed if($hasIODevAttr);
  1805. delete($defs{$proposed}{".clientArray"});
  1806. return;
  1807. }
  1808. # Set the I/O device, search for the last compatible one.
  1809. for my $p (sort { $defs{$b}{NR} <=> $defs{$a}{NR} } keys %defs) {
  1810. next if(IsDisabled($p) == 1);
  1811. next if($defs{$p}{TEMPORARY}); # e.g. server clients
  1812. my $cl = $defs{$p}{Clients};
  1813. $cl = $modules{$defs{$p}{TYPE}}{Clients} if(!$cl);
  1814. if($cl && $defs{$p}{NAME} ne $hn) { # e.g. RFR
  1815. my @fnd = grep { $hash->{TYPE} =~ m/^$_$/; } split(":", $cl);
  1816. if(@fnd) {
  1817. $hash->{IODev} = $defs{$p};
  1818. delete($defs{$p}{".clientArray"}); # Force a recompute
  1819. last;
  1820. }
  1821. }
  1822. }
  1823. if($hash->{IODev}) {
  1824. # See CUL_WS_Attr() for details
  1825. $attr{$hn}{IODev} = $hash->{IODev}{NAME}
  1826. if($hasIODevAttr && $hash->{TYPE} ne "CUL_WS");
  1827. } else {
  1828. if($init_done) {
  1829. Log 3, "No I/O device found for $hn";
  1830. } else {
  1831. $hash->{IODevMissing} = 1;
  1832. }
  1833. }
  1834. return undef;
  1835. }
  1836. #############
  1837. sub
  1838. CommandDelete($$)
  1839. {
  1840. my ($cl, $def) = @_;
  1841. return "Usage: delete <name>$namedef\n" if(!$def);
  1842. my @rets;
  1843. foreach my $sdev (devspec2array($def, $cl)) {
  1844. if(!defined($defs{$sdev})) {
  1845. push @rets, "Please define $sdev first";
  1846. next;
  1847. }
  1848. my $ret = CallFn($sdev, "UndefFn", $defs{$sdev}, $sdev);
  1849. if($ret) {
  1850. push @rets, $ret;
  1851. next;
  1852. }
  1853. $ret = CallFn($sdev, "DeleteFn", $defs{$sdev}, $sdev);
  1854. if($ret) {
  1855. push @rets, $ret;
  1856. next;
  1857. }
  1858. # Delete releated hashes
  1859. foreach my $p (keys %selectlist) {
  1860. if($selectlist{$p} && $selectlist{$p}{NAME} eq $sdev) {
  1861. delete $selectlist{$p};
  1862. }
  1863. }
  1864. foreach my $p (keys %readyfnlist) {
  1865. delete $readyfnlist{$p}
  1866. if($readyfnlist{$p} && $readyfnlist{$p}{NAME} eq $sdev);
  1867. }
  1868. my $temporary = $defs{$sdev}{TEMPORARY};
  1869. addStructChange("delete", $sdev, $sdev) if(!$temporary);
  1870. delete($attr{$sdev});
  1871. delete($defs{$sdev});
  1872. DoTrigger("global", "DELETED $sdev", 1) if(!$temporary);
  1873. }
  1874. return join("\n", @rets);
  1875. }
  1876. #############
  1877. sub
  1878. CommandDeleteAttr($$)
  1879. {
  1880. my ($cl, $def) = @_;
  1881. my @a = split(" ", $def, 2);
  1882. return "Usage: deleteattr <name> [<attrname>]\n$namedef" if(@a < 1);
  1883. my @rets;
  1884. foreach my $sdev (devspec2array($a[0], $cl)) {
  1885. if(!defined($defs{$sdev})) {
  1886. push @rets, "Please define $sdev first";
  1887. next;
  1888. }
  1889. $a[0] = $sdev;
  1890. if($a[1]) {
  1891. if($a[1] eq "userReadings") {
  1892. delete($defs{$sdev}{'.userReadings'});
  1893. } elsif($ra{$a[1]}) {
  1894. my $cache = $ra{$a[1]}{c};
  1895. delete $defs{$sdev}{$cache} if( $cache );
  1896. }
  1897. }
  1898. my $ret = CallFn($sdev, "AttrFn", "del", @a);
  1899. if($ret) {
  1900. push @rets, $ret;
  1901. next;
  1902. }
  1903. if(@a == 1) {
  1904. delete($attr{$sdev});
  1905. addStructChange("deleteAttr", $sdev, $sdev);
  1906. DoTrigger("global", "DELETEATTR $sdev", 1) if($init_done);
  1907. } else {
  1908. delete($attr{$sdev}{$a[1]}) if(defined($attr{$sdev}));
  1909. addStructChange("deleteAttr", $sdev, join(" ", @a));
  1910. DoTrigger("global", "DELETEATTR $sdev $a[1]", 1) if($init_done);
  1911. }
  1912. }
  1913. return join("\n", @rets);
  1914. }
  1915. #############
  1916. sub
  1917. CommandDisplayAttr($$)
  1918. {
  1919. my ($cl, $def) = @_;
  1920. my @a = split(" ", $def, 2);
  1921. return "Usage: displayattr <name> [<attrname>]\n$namedef" if(@a < 1);
  1922. my @rets;
  1923. my @devspec = devspec2array($a[0],$cl);
  1924. foreach my $sdev (@devspec) {
  1925. if(!defined($defs{$sdev})) {
  1926. push @rets, "Please define $sdev first";
  1927. next;
  1928. }
  1929. my $ap = $attr{$sdev};
  1930. next if(!$ap);
  1931. my $d = (@devspec > 1 ? "$sdev " : "");
  1932. if(defined($a[1])) {
  1933. push @rets, "$d$ap->{$a[1]}" if(defined($ap->{$a[1]}));
  1934. } else {
  1935. push @rets, map { "$d$_ $ap->{$_}" } sort keys %{$ap};
  1936. }
  1937. }
  1938. return join("\n", @rets);
  1939. }
  1940. #############
  1941. sub
  1942. CommandDeleteReading($$)
  1943. {
  1944. my ($cl, $def) = @_;
  1945. my @a = split(" ", $def, 2);
  1946. return "Usage: deletereading <name> <reading>\n$namedef" if(@a != 2);
  1947. eval { "" =~ m/$a[1]/ };
  1948. return "Bad regexp $a[1]: $@" if($@);
  1949. %ntfyHash = ();
  1950. my @rets;
  1951. foreach my $sdev (devspec2array($a[0],$cl)) {
  1952. if(!defined($defs{$sdev})) {
  1953. push @rets, "Please define $sdev first";
  1954. next;
  1955. }
  1956. $a[0] = $sdev;
  1957. my $readingspec= '^' . $a[1] . '$';
  1958. foreach my $reading (grep { /$readingspec/ }
  1959. keys %{$defs{$sdev}{READINGS}} ) {
  1960. readingsDelete($defs{$sdev}, $reading);
  1961. push @rets, "Deleted reading $reading for device $sdev";
  1962. }
  1963. }
  1964. return join("\n", @rets);
  1965. }
  1966. sub
  1967. CommandSetReading($$)
  1968. {
  1969. my ($cl, $def) = @_;
  1970. my @a = split(" ", $def, 3);
  1971. return "Usage: setreading <name> <reading> <value>\n$namedef" if(@a != 3);
  1972. my $err;
  1973. my @b = @a;
  1974. my @rets;
  1975. foreach my $sdev (devspec2array($a[0],$cl)) {
  1976. if(!defined($defs{$sdev})) {
  1977. push @rets, "Please define $sdev first";
  1978. next;
  1979. }
  1980. my $hash = $defs{$sdev};
  1981. if($featurelevel >= 5.7) {
  1982. $hash->{CL} = $cl;
  1983. ($err, @b) = ReplaceSetMagic($hash, 3, @a);
  1984. delete $hash->{CL};
  1985. }
  1986. return "WARNING: unsupported character in reading $b[1] ".
  1987. "(not A-Za-z/\\d_\\.-)" if(!goodReadingName($b[1]));
  1988. readingsSingleUpdate($defs{$sdev}, $b[1], $b[2], 1);
  1989. }
  1990. return join("\n", @rets);
  1991. }
  1992. #############
  1993. sub
  1994. PrintHash($$)
  1995. {
  1996. my ($h, $lev) = @_;
  1997. my $si = AttrVal("global", "showInternalValues", 0);
  1998. return "" if($h->{".visited"});
  1999. $h->{".visited"} = 1;
  2000. my ($str,$sstr) = ("","");
  2001. foreach my $c (sort keys %{$h}) {
  2002. next if(!$si && $c =~ m/^\./ || $c eq ".visited");
  2003. if(ref($h->{$c})) {
  2004. if(ref($h->{$c}) eq "HASH") {
  2005. if(defined($h->{$c}{TIME}) && defined($h->{$c}{VAL})) {
  2006. $str .= sprintf("%*s %-19s %-15s %s\n",
  2007. $lev," ", $h->{$c}{TIME},$c,$h->{$c}{VAL});
  2008. } elsif($c eq "IODev" || $c eq "HASH") {
  2009. $str .= sprintf("%*s %-10s %s\n", $lev," ",$c, $h->{$c}{NAME});
  2010. } else {
  2011. $sstr .= sprintf("%*s %s:\n", $lev, " ", $c);
  2012. $sstr .= PrintHash($h->{$c}, $lev+2);
  2013. }
  2014. } elsif(ref($h->{$c}) eq "ARRAY") {
  2015. $sstr .= sprintf("%*s %s:\n", $lev, " ", $c);
  2016. foreach my $v (@{$h->{$c}}) {
  2017. $sstr .= sprintf("%*s %s\n", $lev+2, " ", defined($v) ? $v:"undef");
  2018. }
  2019. }
  2020. } else {
  2021. my $v = $h->{$c};
  2022. $str .= sprintf("%*s %-10s %s\n", $lev," ",$c, defined($v) ? $v : "");
  2023. }
  2024. }
  2025. delete $h->{".visited"};
  2026. return $str . $sstr;
  2027. }
  2028. #####################################
  2029. sub
  2030. CommandList($$)
  2031. {
  2032. my ($cl, $param) = @_;
  2033. my $str = "";
  2034. if($param =~ m/^-r *(.*)$/i) {
  2035. my @list;
  2036. my $arg = $1;
  2037. if($param =~ m/^-R/) {
  2038. return "-R needs a valid device as argument" if(!$arg);
  2039. push @list, $arg;
  2040. push @list, getPawList($arg);
  2041. } else {
  2042. @list = devspec2array($arg ? $arg : ".*", $cl);
  2043. }
  2044. foreach my $d (@list) {
  2045. return "No device named $d found" if(!defined($defs{$d}));
  2046. $str .= "\n" if($str);
  2047. my @a = GetDefAndAttr($d);
  2048. $str .= join("\n", @a)."\n" if(@a);
  2049. }
  2050. foreach my $d (sort @list) {
  2051. $str .= "\n" if($str);
  2052. my @a = GetAllReadings($d);
  2053. $str .= join("\n", @a)."\n" if(@a);
  2054. }
  2055. return $str;
  2056. }
  2057. if(!$param) { # List of all devices
  2058. $str = "\nType list <name> for detailed info.\n";
  2059. my $lt = "";
  2060. # Sort first by type then by name
  2061. for my $d (sort { my $x=$modules{$defs{$a}{TYPE}}{ORDER}.$defs{$a}{TYPE} cmp
  2062. $modules{$defs{$b}{TYPE}}{ORDER}.$defs{$b}{TYPE};
  2063. $x=($a cmp $b) if($x == 0); $x; } keys %defs) {
  2064. next if(IsIgnored($d) || ($cl && !Authorized($cl,"devicename",$d)));
  2065. my $t = $defs{$d}{TYPE};
  2066. $str .= "\n$t:\n" if($t ne $lt);
  2067. $str .= sprintf(" %-20s (%s)\n", $d, $defs{$d}{STATE});
  2068. $lt = $t;
  2069. }
  2070. } else { # devspecArray
  2071. my @arg = split(" ", $param);
  2072. my @list = devspec2array($arg[0],$cl);
  2073. if($arg[1]) {
  2074. foreach my $sdev (@list) { # Show a Hash-Entry or Reading for each device
  2075. my $first = 1;
  2076. foreach my $n (@arg[1..@arg-1]) {
  2077. my $n = $n; # Forum #53223, for some perl versions $n is a reference
  2078. my $fType="";
  2079. if($n =~ m/^(.:)(.*$)/) {
  2080. $fType = $1;
  2081. $n = $2;
  2082. }
  2083. if($defs{$sdev}) {
  2084. if(defined($defs{$sdev}{$n}) && (!$fType || $fType eq "i:")) {
  2085. my $val = $defs{$sdev}{$n};
  2086. if(ref($val) eq 'HASH') {
  2087. $val = ($val->{NAME} ? $val->{NAME} : # ???
  2088. join(" ", map { "$_=$val->{$_}" } sort keys %{$val}));
  2089. }
  2090. $str .= sprintf("%-20s %*s %*s %s\n", $first?$sdev:'',
  2091. $arg[2]?19:0, '', $arg[2]?-15:0, $arg[2]?$n:'', $val);
  2092. } elsif($defs{$sdev}{READINGS} &&
  2093. defined($defs{$sdev}{READINGS}{$n})
  2094. && (!$fType || $fType eq "r:")) {
  2095. $str .= sprintf("%-20s %s %*s %s\n", $first?$sdev:'',
  2096. $defs{$sdev}{READINGS}{$n}{TIME},
  2097. $arg[2]?-15:0, $arg[2]?$n:'',
  2098. $defs{$sdev}{READINGS}{$n}{VAL});
  2099. } elsif($attr{$sdev} &&
  2100. defined($attr{$sdev}{$n})
  2101. && (!$fType || $fType eq "a:")) {
  2102. $str .= sprintf("%-20s %*s %*s %s\n", $first?$sdev:'',
  2103. $arg[2]?19:0, '', $arg[2]?-15:0, $arg[2]?$n:'',
  2104. $attr{$sdev}{$n});
  2105. }
  2106. }
  2107. $first = 0;
  2108. }
  2109. }
  2110. } elsif(@list == 1) { # Details
  2111. my $sdev = $list[0];
  2112. if(!defined($defs{$sdev})) {
  2113. $str .= "No device named $param found";
  2114. } else {
  2115. $str .= "Internals:\n";
  2116. $str .= PrintHash($defs{$sdev}, 2);
  2117. $str .= "Attributes:\n";
  2118. $str .= PrintHash($attr{$sdev}, 2);
  2119. }
  2120. } else {
  2121. foreach my $sdev (@list) { # List of devices
  2122. $str .= "$sdev\n";
  2123. }
  2124. }
  2125. }
  2126. return $str;
  2127. }
  2128. #####################################
  2129. sub
  2130. CommandReload($$;$)
  2131. {
  2132. my ($cl, $param, $ignoreErr) = @_;
  2133. my %hash;
  2134. $param =~ s,/,,g;
  2135. $param =~ s,\.pm$,,g;
  2136. my $file = "$attr{global}{modpath}/FHEM/$param.pm";
  2137. my $cfgDB = '-';
  2138. if( ! -r "$file" ) {
  2139. if(configDBUsed()) {
  2140. # try to find the file in configDB
  2141. my $r = _cfgDB_Fileexport($file); # create file temporarily
  2142. return "Can't read $file from configDB." if ($r =~ m/^0/);
  2143. $cfgDB = 'X';
  2144. } else {
  2145. # configDB not used and file not found: it's a real error!
  2146. return "Can't read $file: $!";
  2147. }
  2148. }
  2149. my $m = $param;
  2150. $m =~ s,^([0-9][0-9])_,,;
  2151. my $order = (defined($1) ? $1 : "00");
  2152. Log 5, "Loading $file";
  2153. no strict "refs";
  2154. my $ret = eval {
  2155. my $ret=do "$file";
  2156. unlink($file) if($cfgDB eq 'X'); # delete temp file
  2157. if(!$ret) {
  2158. Log 1, "reload: Error:Modul $param deactivated:\n $@" if(!$ignoreErr);
  2159. return $@;
  2160. }
  2161. # Get the name of the initialize function. This may differ from the
  2162. # filename as sometimes we live on a FAT fs with wrong case.
  2163. my $fnname = $m;
  2164. foreach my $i (keys %main::) {
  2165. if($i =~ m/^(${m})_initialize$/i) {
  2166. $fnname = $1;
  2167. last;
  2168. }
  2169. }
  2170. &{ "${fnname}_Initialize" }(\%hash);
  2171. $m = $fnname;
  2172. return undef;
  2173. };
  2174. use strict "refs";
  2175. return "$@" if($@);
  2176. return $ret if($ret);
  2177. my ($defptr, $ldata);
  2178. if($modules{$m}) {
  2179. $defptr = $modules{$m}{defptr};
  2180. $ldata = $modules{$m}{ldata};
  2181. }
  2182. $modules{$m} = \%hash;
  2183. $modules{$m}{ORDER} = $order;
  2184. $modules{$m}{LOADED} = 1;
  2185. $modules{$m}{defptr} = $defptr if($defptr);
  2186. $modules{$m}{ldata} = $ldata if($ldata);
  2187. return undef;
  2188. }
  2189. #####################################
  2190. sub
  2191. CommandRename($$)
  2192. {
  2193. my ($cl, $param) = @_;
  2194. my ($old, $new) = split(" ", $param);
  2195. return "old name is empty" if(!defined($old));
  2196. return "new name is empty" if(!defined($new));
  2197. return "Please define $old first" if(!defined($defs{$old}));
  2198. return "$new already defined" if(defined($defs{$new}));
  2199. return "Invalid characters in name (not A-Za-z0-9._): $new"
  2200. if(!goodDeviceName($new));
  2201. return "Cannot rename global" if($old eq "global");
  2202. %ntfyHash = ();
  2203. $defs{$new} = $defs{$old};
  2204. $defs{$new}{NAME} = $new;
  2205. delete($defs{$old}); # The new pointer will preserve the hash
  2206. $attr{$new} = $attr{$old} if(defined($attr{$old}));
  2207. delete($attr{$old});
  2208. $oldvalue{$new} = $oldvalue{$old} if(defined($oldvalue{$old}));
  2209. delete($oldvalue{$old});
  2210. CallFn($new, "RenameFn", $new,$old);# ignore replies
  2211. addStructChange("rename", $new, $param);
  2212. DoTrigger("global", "RENAMED $old $new", 1);
  2213. return undef;
  2214. }
  2215. #####################################
  2216. sub
  2217. getAllAttr($;$)
  2218. {
  2219. my ($d, $cl) = @_;
  2220. return "" if(!$defs{$d});
  2221. my $list = $AttrList; # Global values
  2222. if($defs{$d}{".AttrList"}) {
  2223. $list .= " " . $defs{$d}{".AttrList"};
  2224. } elsif($modules{$defs{$d}{TYPE}}{AttrList}) {
  2225. $list .= " " . $modules{$defs{$d}{TYPE}}{AttrList};
  2226. }
  2227. $list .= " " . $attr{global}{userattr} if($attr{global}{userattr});
  2228. $list .= " " . $attr{$d}{userattr} if($attr{$d} && $attr{$d}{userattr});
  2229. $list .= " userattr";
  2230. return $list;
  2231. }
  2232. #####################################
  2233. sub
  2234. getAllGets($;$)
  2235. {
  2236. my ($d, $cl) = @_;
  2237. my $a2 = CommandGet($cl, "$d ?");
  2238. return "" if($a2 !~ m/unknown.*choose one of /i);
  2239. $a2 =~ s/.*choose one of //;
  2240. return $a2;
  2241. }
  2242. #####################################
  2243. sub
  2244. getAllSets($;$)
  2245. {
  2246. my ($d, $cl) = @_;
  2247. return "" if(!$defs{$d}); # Just safeguarding
  2248. if(AttrVal("global", "apiversion", 1)> 1) {
  2249. my @setters= getSetters($defs{$d});
  2250. return join(" ", @setters);
  2251. }
  2252. my $a2 = CommandSet($cl, "$d ?");
  2253. $a2 =~ s/.*choose one of //;
  2254. $a2 = "" if($a2 =~ /^No set implemented for/);
  2255. return "" if($a2 eq "");
  2256. $a2 = $defs{$d}{".eventMapCmd"}." $a2" if(defined($defs{$d}{".eventMapCmd"}));
  2257. return $a2;
  2258. }
  2259. sub
  2260. GlobalAttr($$$$)
  2261. {
  2262. my ($type, $me, $name, $val) = @_;
  2263. if($type eq "del") {
  2264. my %noDel = ( modpath=>1, verbose=>1, logfile=>1 );
  2265. return "The global attribute $name cannot be deleted" if($noDel{$name});
  2266. $featurelevel = 5.8 if($name eq "featurelevel");
  2267. $haveInet6 = 0 if($name eq "useInet6"); # IPv6
  2268. return undef;
  2269. }
  2270. return undef if($type ne "set");
  2271. ################
  2272. if($name eq "logfile") {
  2273. my @t = localtime(gettimeofday());
  2274. my $ret = OpenLogfile(ResolveDateWildcards($val, @t));
  2275. if($ret) {
  2276. return $ret if($init_done);
  2277. die($ret);
  2278. }
  2279. }
  2280. ################
  2281. elsif($name eq "verbose") {
  2282. if($val =~ m/^[0-5]$/) {
  2283. return undef;
  2284. } else {
  2285. $attr{global}{verbose} = 3;
  2286. return "Valid value for verbose are 0,1,2,3,4,5";
  2287. }
  2288. }
  2289. elsif($name eq "modpath") {
  2290. return "modpath must point to a directory where the FHEM subdir is"
  2291. if(! -d "$val/FHEM");
  2292. my $modpath = "$val/FHEM";
  2293. opendir(DH, $modpath) || return "Can't read $modpath: $!";
  2294. push @INC, $modpath if(!grep(/\Q$modpath\E/, @INC));
  2295. $cvsid =~ m/(fhem.pl) (\d+) (\d+-\d+-\d+)/;
  2296. $attr{global}{version} = "$1:$2/$3";
  2297. my $counter = 0;
  2298. if(configDBUsed()) {
  2299. my $list = cfgDB_Read99(); # retrieve filelist from configDB
  2300. if($list) {
  2301. foreach my $m (split(/,/,$list)) {
  2302. $m =~ m/^([0-9][0-9])_(.*)\.pm$/;
  2303. CommandReload(undef, $m) if(!$modules{$2}{LOADED});
  2304. $counter++;
  2305. }
  2306. }
  2307. }
  2308. foreach my $m (sort readdir(DH)) {
  2309. next if($m !~ m/^([0-9][0-9])_(.*)\.pm$/);
  2310. $modules{$2}{ORDER} = $1;
  2311. CommandReload(undef, $m) # Always load utility modules
  2312. if($1 eq "99" && !$modules{$2}{LOADED});
  2313. $counter++;
  2314. }
  2315. closedir(DH);
  2316. if(!$counter) {
  2317. return "No modules found, set modpath to a directory in which a " .
  2318. "subdirectory called \"FHEM\" exists wich in turn contains " .
  2319. "the fhem module files <*>.pm";
  2320. }
  2321. }
  2322. elsif($name eq "featurelevel") {
  2323. return "$val is not in the form N.N" if($val !~ m/^\d+\.\d+$/);
  2324. $featurelevel = $val;
  2325. }
  2326. elsif($name eq "commandref" && $init_done) {
  2327. my $root = $attr{global}{modpath};
  2328. my $out = "";
  2329. $out = ">> $currlogfile 2>&1" if($currlogfile ne "-" && $^O ne "MSWin32");
  2330. if($val eq "full") {
  2331. system("$^X $root/contrib/commandref_join.pl -noWarnings $out")
  2332. } else {
  2333. system("$^X $root/contrib/commandref_modular.pl $out");
  2334. }
  2335. }
  2336. elsif($name eq "useInet6") {
  2337. if($val || !defined($val)) {
  2338. eval { require IO::Socket::INET6; require Socket6; };
  2339. return $@ if($@);
  2340. $haveInet6 = 1;
  2341. } else {
  2342. $haveInet6 = 0;
  2343. }
  2344. }
  2345. return undef;
  2346. }
  2347. #####################################
  2348. sub
  2349. CommandAttr($$)
  2350. {
  2351. my ($cl, $param) = @_;
  2352. my ($ret, $append, $remove, @a);
  2353. $append = ($param =~ s/^-a //);
  2354. $remove = ($param =~ s/^-r //);
  2355. @a = split(" ", $param, 3) if($param);
  2356. return "Usage: attr [-a|-r] <name> <attrname> [<attrvalue>]\n$namedef"
  2357. if(@a && @a < 2);
  2358. my @rets;
  2359. foreach my $sdev (devspec2array($a[0], $a[1] && $a[1] eq "?" ? undef : $cl)) {
  2360. my $hash = $defs{$sdev};
  2361. my $attrName = $a[1];
  2362. my $attrVal = (defined($a[2]) ? $a[2] : 1);
  2363. if(!defined($hash)) {
  2364. push @rets, "Please define $sdev first" if($init_done);#define -ignoreErr
  2365. next;
  2366. }
  2367. my $list = getAllAttr($sdev);
  2368. if($attrName eq "?") {
  2369. push @rets, "$sdev: unknown attribute $attrName, choose one of $list";
  2370. next;
  2371. }
  2372. $attrName = resolveAttrRename($sdev,$attrName);
  2373. if(" $list " !~ m/ ${attrName}[ :;]/) {
  2374. my $found = 0;
  2375. foreach my $atr (split("[ \t]", $list)) { # is it a regexp?
  2376. $atr =~ /^([^;:]+)(:.*)?$/;
  2377. my $base = $1;
  2378. if(${attrName} =~ m/^$base$/) {
  2379. $found++;
  2380. last;
  2381. }
  2382. }
  2383. if(!$found) {
  2384. push @rets, "$sdev: unknown attribute $attrName. ".
  2385. "Type 'attr $sdev ?' for a detailed list.";
  2386. next;
  2387. }
  2388. }
  2389. if($append && $attr{$sdev} && $attr{$sdev}{$attrName}) {
  2390. $attrVal = $attr{$sdev}{$attrName} .
  2391. ($attrVal =~ m/^,/ ? $attrVal : " $attrVal");
  2392. }
  2393. if($remove && $attr{$sdev} && $attr{$sdev}{$attrName}) {
  2394. my $v = $attr{$sdev}{$attrName};
  2395. $v =~ s/\s*$attrVal\s*//;
  2396. $attrVal = $v;
  2397. }
  2398. if($attrName eq 'disable' && $attrVal eq 'toggle') {
  2399. $attrVal = IsDisabled($sdev) ? 0 : 1;
  2400. }
  2401. if($attrName eq "userReadings") {
  2402. my @userReadings;
  2403. # myReading1[:trigger1] [modifier1] { codecodecode1 }, ...
  2404. my $arg= $attrVal;
  2405. # matches myReading1[:trigger2] { codecode1 }
  2406. my $regexi= '\s*([\w.-]+)(:\S*)?\s+((\w+)\s+)?({.*?})\s*';
  2407. my $regexo= '^(' . $regexi . ')(,\s*(.*))*$';
  2408. my $rNo=0;
  2409. while($arg =~ /$regexo/s) {
  2410. my $reading= $2;
  2411. my $trigger= $3 ? $3 : undef;
  2412. my $modifier= $5 ? $5 : "none";
  2413. my $perlCode= $6;
  2414. #Log 1, sprintf("userReading %s has perlCode %s with modifier %s%s",
  2415. # $userReading,$perlCode,$modifier,$trigger?" and trigger $trigger":"");
  2416. if(grep { /$modifier/ }
  2417. qw(none difference differential offset monotonic integral)) {
  2418. $trigger =~ s/^:// if($trigger);
  2419. my %userReading = ( reading => $reading,
  2420. trigger => $trigger,
  2421. modifier => $modifier,
  2422. perlCode => $perlCode );
  2423. push @userReadings, \%userReading;
  2424. } else {
  2425. push @rets, "$sdev: unknown modifier $modifier for ".
  2426. "userReading $reading, this userReading will be ignored";
  2427. }
  2428. $arg= defined($8) ? $8 : "";
  2429. }
  2430. $hash->{'.userReadings'}= \@userReadings;
  2431. }
  2432. my $oVal = ($attr{$sdev} ? $attr{$sdev}{$attrName} : "");
  2433. if($attrName eq "eventMap") {
  2434. delete $hash->{".eventMapHash"};
  2435. delete $hash->{".eventMapCmd"};
  2436. $attr{$sdev}{eventMap} = $attrVal;
  2437. my $r = ReplaceEventMap($sdev, "test", 1); # refresh eventMapCmd
  2438. if($r =~ m/^ERROR in eventMap for /) {
  2439. delete($attr{$sdev}{eventMap});
  2440. return $r;
  2441. }
  2442. }
  2443. if($ra{$attrName}) {
  2444. my ($lval,$rp,$cache) = ($attrVal, $ra{$attrName}{p}, $ra{$attrName}{c});
  2445. if($rp && $lval =~ m/$rp/) {
  2446. my $err = perlSyntaxCheck($attrVal, %{$ra{$attrName}{pv}});
  2447. return "attr $sdev $attrName: $err" if($err);
  2448. } else {
  2449. delete $hash->{$cache} if( $cache );
  2450. my @a = split($ra{$attrName}{s}, $lval) ;
  2451. for my $v (@a) {
  2452. my $v = $v; # resolve the reference to avoid changing @a itself
  2453. $v =~ s/$ra{$attrName}{r}// if($ra{$attrName}{r});
  2454. my $err ="Argument $v for attr $sdev $attrName is not a valid regexp";
  2455. return "$err: use .* instead of *" if($v =~ /^\*/); # no err in eval!?
  2456. eval { "Hallo" =~ m/^$v$/ };
  2457. return "$err: $@" if($@);
  2458. }
  2459. $hash->{$cache} = \@a if( $cache );
  2460. }
  2461. }
  2462. if($fhemdebug && $sdev eq "global") {
  2463. $attrVal = "-" if($attrName eq "logfile");
  2464. $attrVal = 5 if($attrName eq "verbose");
  2465. }
  2466. $ret = CallFn($sdev, "AttrFn", "set", $sdev, $attrName, $attrVal);
  2467. if($ret) {
  2468. push @rets, $ret;
  2469. next;
  2470. }
  2471. $attr{$sdev}{$attrName} = $attrVal;
  2472. if($attrName eq "IODev") {
  2473. if(!$attrVal || !defined($defs{$attrVal})) {
  2474. if($init_done) {
  2475. push @rets,"$sdev: unknown IODev $attrVal specified";
  2476. } else {
  2477. $hash->{IODevMissing} = 1;
  2478. $hash->{IODevName} = $attrVal;
  2479. }
  2480. next;
  2481. }
  2482. my $ioname = $attrVal;
  2483. $hash->{IODev} = $defs{$ioname};
  2484. delete($defs{$ioname}{".clientArray"}); # Force a recompute
  2485. }
  2486. if($attrName eq "stateFormat" && $init_done) {
  2487. my $err = perlSyntaxCheck($attrVal, ("%name"=>""));
  2488. return $err if($err);
  2489. evalStateFormat($hash);
  2490. }
  2491. addStructChange("attr", $sdev, "$sdev $attrName $attrVal")
  2492. if(!defined($oVal) || $oVal ne $attrVal);
  2493. DoTrigger("global", "ATTR $sdev $attrName $attrVal", 1) if($init_done);
  2494. }
  2495. Log 3, join(" ", @rets) if(!$cl && @rets);
  2496. return join("\n", @rets);
  2497. }
  2498. #####################################
  2499. # Default Attr
  2500. sub
  2501. CommandDefaultAttr($$)
  2502. {
  2503. my ($cl, $param) = @_;
  2504. my @a = split(" ", $param, 2);
  2505. if(int(@a) == 0) {
  2506. %defaultattr = ();
  2507. } elsif(int(@a) == 1) {
  2508. $defaultattr{$a[0]} = 1;
  2509. } else {
  2510. $defaultattr{$a[0]} = $a[1];
  2511. }
  2512. return undef;
  2513. }
  2514. #####################################
  2515. sub
  2516. CommandSetstate($$)
  2517. {
  2518. my ($cl, $param) = @_;
  2519. my @a = split(" ", $param, 2);
  2520. my $addMsg = ($init_done ? "" : "Bogus command was: setstate $param");
  2521. return "Usage: setstate <name> <state>\n${namedef}$addMsg" if(@a != 2);
  2522. my @rets;
  2523. foreach my $sdev (devspec2array($a[0],$cl)) {
  2524. if(!defined($defs{$sdev})) {
  2525. push @rets, "Please define $sdev first";
  2526. next;
  2527. }
  2528. my $d = $defs{$sdev};
  2529. # Detailed state with timestamp
  2530. if($a[1] =~ m/^(\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}) +([^ ].*)$/s) {
  2531. my ($tim, $nameval) = ($1, $2);
  2532. my ($sname, $sval) = split(" ", $nameval, 2);
  2533. $sval = "" if(!defined($sval));
  2534. my $ret = CallFn($sdev, "StateFn", $d, $tim, $sname, $sval);
  2535. if($ret) {
  2536. push @rets, $ret;
  2537. next;
  2538. }
  2539. Log3 $d, 3, "WARNING: unsupported character in reading $sname ".
  2540. "(not A-Za-z/\\d_\\.-), notify the $d->{TYPE} module maintainer."
  2541. if(!goodReadingName($sname));
  2542. if(!defined($d->{READINGS}{$sname}) ||
  2543. !defined($d->{READINGS}{$sname}{TIME}) ||
  2544. $d->{READINGS}{$sname}{TIME} lt $tim) {
  2545. $d->{READINGS}{$sname}{VAL} = $sval;
  2546. $d->{READINGS}{$sname}{TIME} = $tim;
  2547. }
  2548. } else {
  2549. # The timestamp is not the correct one, but we do not store a timestamp
  2550. # for this reading.
  2551. my $tn = TimeNow();
  2552. $a[1] =~ s/\\(...)/chr(oct($1))/ge if($a[1] =~ m/^(\\011|\\040)+$/);
  2553. $oldvalue{$sdev}{TIME} = $tn;
  2554. $oldvalue{$sdev}{VAL} = ($init_done ? $d->{STATE} : $a[1]);
  2555. # Do not overwrite state like "opened" or "initialized"
  2556. $d->{STATE} = $a[1] if($init_done || $d->{STATE} eq "???");
  2557. my $ret = CallFn($sdev, "StateFn", $d, $tn, "STATE", $a[1]);
  2558. if($ret) {
  2559. push @rets, $ret;
  2560. next;
  2561. }
  2562. }
  2563. }
  2564. return join("\n", @rets);
  2565. }
  2566. #####################################
  2567. sub
  2568. CommandTrigger($$)
  2569. {
  2570. my ($cl, $param) = @_;
  2571. my ($dev, $state) = split(" ", $param, 2);
  2572. return "Usage: trigger <name> <state>\n$namedef" if(!$dev);
  2573. $state = "" if(!defined($state));
  2574. my @rets;
  2575. foreach my $sdev (devspec2array($dev,$cl)) {
  2576. if(!defined($defs{$sdev})) {
  2577. push @rets, "Please define $sdev first";
  2578. next;
  2579. }
  2580. my $ret = DoTrigger($sdev, $state);
  2581. if($ret) {
  2582. push @rets, $ret;
  2583. next;
  2584. }
  2585. }
  2586. return join("\n", @rets);
  2587. }
  2588. #####################################
  2589. sub
  2590. WakeUpFn($)
  2591. {
  2592. my $h = shift;
  2593. delete $sleepers{$h->{id}} if( $h->{id} );
  2594. $evalSpecials = $h->{evalSpecials};
  2595. my $ret = AnalyzeCommandChain($h->{cl}, $h->{cmd});
  2596. Log 2, "After sleep: $ret" if($ret && !$h->{quiet});
  2597. }
  2598. sub
  2599. CommandCancel($$)
  2600. {
  2601. my ($cl, $param) = @_;
  2602. my ($id, $quiet) = split(" ", $param, 3);
  2603. return "Last parameter must be quiet" if($quiet && $quiet ne "quiet");
  2604. if( !$id ) {
  2605. my $ret;
  2606. foreach $id (keys %sleepers) {
  2607. $ret .= "\n" if( $ret );
  2608. $ret .= sprintf( "%-10s %s", $id, $sleepers{$id}->{cmd} );
  2609. }
  2610. $ret = "no pending sleeps" if( !$ret );
  2611. return $ret;
  2612. } elsif( my $h = $sleepers{$id} ) {
  2613. RemoveInternalTimer( $h );
  2614. delete $sleepers{$h->{id}};
  2615. } else {
  2616. return "no such id: $id" if( !$quiet );
  2617. }
  2618. return undef;
  2619. }
  2620. sub
  2621. CommandSleep($$)
  2622. {
  2623. my ($cl, $param) = @_;
  2624. my ($sec, $id, $quiet) = split(" ", $param, 3);
  2625. if( $id && $id eq 'quiet' ) {
  2626. $quiet = $id;
  2627. $id = undef;
  2628. }
  2629. return "Argument missing" if(!defined($sec));
  2630. return "Cannot interpret $sec as seconds" if($sec !~ m/^[0-9\.]+$/);
  2631. return "Last parameter must be quiet" if($quiet && $quiet ne "quiet");
  2632. Log 4, "sleeping for $sec";
  2633. if(@cmdList && $init_done) {
  2634. my %h = (cmd => join(";", @cmdList),
  2635. evalSpecials => $evalSpecials,
  2636. quiet => $quiet,
  2637. cl => $cl,
  2638. id => $id);
  2639. if( $id ) {
  2640. RemoveInternalTimer( $sleepers{$id} ) if( $sleepers{$id} );
  2641. $sleepers{$id} = \%h;
  2642. }
  2643. InternalTimer(gettimeofday()+$sec, "WakeUpFn", \%h, 0);
  2644. @cmdList=();
  2645. } else {
  2646. Log 1,
  2647. "WARNING: sleep without additional commands is deprecated and blocks FHEM";
  2648. select(undef, undef, undef, $sec);
  2649. }
  2650. return undef;
  2651. }
  2652. #####################################
  2653. # Add a function to be executed after select returns. Only one function is
  2654. # executed after select returns.
  2655. # fn: a function reference
  2656. # arg: function argument
  2657. # nice: a number like in unix "nice". Smaller numbers mean higher priority.
  2658. # limited to [-20,19], default 0
  2659. # returns the number of elements in the corrsponding queue
  2660. sub
  2661. PrioQueue_add($$;$)
  2662. {
  2663. my ($fn, $arg, $nice) = @_;
  2664. $nice = 0 if(!defined($nice) || !looks_like_number($nice));
  2665. $nice = -20 if($nice <-20);
  2666. $nice = 19 if($nice > 19);
  2667. $nextat = 1;
  2668. $prioQueues{$nice} = [] if(!defined $prioQueues{$nice});
  2669. push(@{$prioQueues{$nice}},{fn=>$fn, arg=>$arg});
  2670. };
  2671. #####################################
  2672. # Return the time to the next event (or undef if there is none)
  2673. # and call each function which was scheduled for this time
  2674. sub
  2675. HandleTimeout()
  2676. {
  2677. return undef if(!$nextat);
  2678. my $now = gettimeofday();
  2679. if($now < $nextat) {
  2680. $selectTimestamp = $now;
  2681. return ($nextat-$now);
  2682. }
  2683. $nextat = 0;
  2684. while(@intAtA) {
  2685. my $at = $intAtA[0];
  2686. my $tim = $at->{TRIGGERTIME};
  2687. if($tim && $tim > $now) {
  2688. $nextat = $tim;
  2689. last;
  2690. }
  2691. delete $intAt{$at->{atNr}} if($at->{atNr});
  2692. shift(@intAtA);
  2693. if($tim && $at->{FN}) {
  2694. no strict "refs";
  2695. &{$at->{FN}}($at->{ARG});
  2696. use strict "refs";
  2697. }
  2698. }
  2699. if(%prioQueues) {
  2700. my $nice = minNum(keys %prioQueues);
  2701. my $entry = shift(@{$prioQueues{$nice}});
  2702. delete $prioQueues{$nice} if(!@{$prioQueues{$nice}});
  2703. &{$entry->{fn}}($entry->{arg});
  2704. $nextat = 1 if(%prioQueues);
  2705. }
  2706. if(!$nextat) {
  2707. $selectTimestamp = $now;
  2708. return undef;
  2709. }
  2710. $now = gettimeofday(); # if some callbacks took longer
  2711. $selectTimestamp = $now;
  2712. return ($now < $nextat) ? ($nextat-$now) : 0;
  2713. }
  2714. #####################################
  2715. sub
  2716. InternalTimer($$$;$)
  2717. {
  2718. my ($tim, $fn, $arg, $waitIfInitNotDone) = @_;
  2719. $tim = 1 if(!$tim);
  2720. if(!$init_done && $waitIfInitNotDone) {
  2721. select(undef, undef, undef, $tim-gettimeofday());
  2722. no strict "refs";
  2723. &{$fn}($arg);
  2724. use strict "refs";
  2725. return;
  2726. }
  2727. $nextat = $tim if(!$nextat || $nextat > $tim);
  2728. my %h = (TRIGGERTIME=>$tim, FN=>$fn, ARG=>$arg, atNr=>++$intAtCnt);
  2729. $h{STACKTRACE} = stacktraceAsString(1) if($addTimerStacktrace);
  2730. $intAt{$h{atNr}} = \%h;
  2731. if(!@intAtA) {
  2732. push @intAtA, \%h;
  2733. return;
  2734. }
  2735. my $idx = $#intAtA; # binary insert
  2736. my ($lowerIdx,$upperIdx) = (0, $idx);
  2737. while($lowerIdx <= $upperIdx) {
  2738. $idx = int(($upperIdx-$lowerIdx)/2)+$lowerIdx;
  2739. if($tim >= $intAtA[$idx]->{TRIGGERTIME}) {
  2740. $lowerIdx = ++$idx;
  2741. } else {
  2742. $upperIdx = $idx-1;
  2743. }
  2744. }
  2745. splice(@intAtA, $idx, 0, \%h);
  2746. }
  2747. sub
  2748. RemoveInternalTimer($;$)
  2749. {
  2750. my ($arg, $fn) = @_;
  2751. return if(!$arg && !$fn);
  2752. for(my $i=0; $i<@intAtA; $i++) {
  2753. my ($ia, $if) = ($intAtA[$i]->{ARG}, $intAtA[$i]->{FN});
  2754. if((!$arg || ($ia && $ia eq $arg)) &&
  2755. (!$fn || ($if && $if eq $fn))) {
  2756. my $t = $intAtA[$i]->{atNr};
  2757. delete $intAt{$t} if($intAt{$t});
  2758. splice @intAtA, $i, 1;
  2759. $i--;
  2760. }
  2761. }
  2762. }
  2763. #####################################
  2764. sub
  2765. stacktrace()
  2766. {
  2767. my $i = 1;
  2768. my $max_depth = 50;
  2769. # Forum #59831
  2770. Log 1, "eval: $cmdFromAnalyze"
  2771. if($cmdFromAnalyze && $attr{global}{verbose} < 3);
  2772. Log 1, "stacktrace:";
  2773. while( (my @call_details = (caller($i++))) && ($i<$max_depth) ) {
  2774. Log 1, sprintf (" %-35s called by %s (%s)",
  2775. $call_details[3], $call_details[1], $call_details[2]);
  2776. }
  2777. }
  2778. sub
  2779. stacktraceAsString($)
  2780. {
  2781. my ($offset) = @_;
  2782. $offset = 1 if (!$offset);
  2783. my ($max_depth,$ret) = (50,"");
  2784. while( (my @call_details = (caller($offset++))) && ($offset<$max_depth) ) {
  2785. $call_details[3] =~ s/main:://;
  2786. $ret .= sprintf(" %s:%s", $call_details[3], $call_details[2]);
  2787. }
  2788. return $ret;
  2789. }
  2790. my $inWarnSub;
  2791. sub
  2792. SignalHandling()
  2793. {
  2794. if($^O ne "MSWin32") {
  2795. $SIG{TERM} = sub { $gotSig = "TERM"; };
  2796. $SIG{PIPE} = 'IGNORE';
  2797. $SIG{CHLD} = 'IGNORE';
  2798. $SIG{HUP} = sub { $gotSig = "HUP"; };
  2799. $SIG{ALRM} = sub { Log 1, "ALARM signal, blocking write?" };
  2800. #$SIG{'XFSZ'} = sub { Log 1, "XFSZ signal" }; # to test with limit filesize
  2801. }
  2802. $SIG{__WARN__} = sub {
  2803. my ($msg) = @_;
  2804. return if($inWarnSub);
  2805. $lastWarningMsg = $msg;
  2806. if(!$attr{global}{stacktrace} && $data{WARNING}{$msg}) {
  2807. $data{WARNING}{$msg}++;
  2808. return;
  2809. }
  2810. $inWarnSub = 1;
  2811. $data{WARNING}{$msg}++;
  2812. chomp($msg);
  2813. Log 1, "PERL WARNING: $msg";
  2814. Log 3, "eval: $cmdFromAnalyze" if($cmdFromAnalyze);
  2815. stacktrace() if($attr{global}{stacktrace} &&
  2816. $msg !~ m/ redefined at /);
  2817. $inWarnSub = 0;
  2818. };
  2819. # $SIG{__DIE__} = sub {...} #Removed. Forum #35796
  2820. }
  2821. #####################################
  2822. sub
  2823. TimeNow()
  2824. {
  2825. return FmtDateTime(gettimeofday());
  2826. }
  2827. #####################################
  2828. sub
  2829. FmtDateTime($)
  2830. {
  2831. my @t = localtime(shift);
  2832. return sprintf("%04d-%02d-%02d %02d:%02d:%02d",
  2833. $t[5]+1900, $t[4]+1, $t[3], $t[2], $t[1], $t[0]);
  2834. }
  2835. sub
  2836. FmtTime($)
  2837. {
  2838. my @t = localtime(shift);
  2839. return sprintf("%02d:%02d:%02d", $t[2], $t[1], $t[0]);
  2840. }
  2841. sub
  2842. FmtDateTimeRFC1123($)
  2843. {
  2844. my $t = gmtime(shift);
  2845. if($t =~ m/^(...) (...) (..) (..:..:..) (....)$/) {
  2846. return sprintf("$1, %02d $2 $5 $4 GMT", $3);
  2847. }
  2848. return $t;
  2849. }
  2850. #####################################
  2851. sub
  2852. ResolveDateWildcards($@)
  2853. {
  2854. use POSIX qw(strftime);
  2855. my ($f, @t) = @_;
  2856. return $f if(!$f);
  2857. return $f if($f !~ m/%/); # Be fast if there is no wildcard
  2858. $f =~ s/%L/$attr{global}{logdir}/g if($attr{global}{logdir}); #log directory
  2859. return strftime($f,@t);
  2860. }
  2861. sub
  2862. SemicolonEscape($)
  2863. {
  2864. my $cmd = shift;
  2865. $cmd =~ s/^[ \t]*//;
  2866. $cmd =~ s/[ \t]*$//;
  2867. if($cmd =~ m/^{.*}$/s || $cmd =~ m/^".*"$/s) {
  2868. $cmd =~ s/;/;;/g
  2869. }
  2870. return $cmd;
  2871. }
  2872. sub
  2873. EvalSpecials($%)
  2874. {
  2875. # $NAME will be replaced with the device name which generated the event
  2876. # $EVENT will be replaced with the whole event string
  2877. # $EVTPART<N> will be replaced with single words of an event
  2878. my ($exec, %specials)= @_;
  2879. if($specials{__UNIQUECMD__}) {
  2880. delete $specials{__UNIQUECMD__};
  2881. } else {
  2882. $exec = SemicolonEscape($exec);
  2883. }
  2884. my $idx = 0;
  2885. if(defined($specials{"%EVENT"})) {
  2886. foreach my $part (split(" ", $specials{"%EVENT"})) {
  2887. $specials{"%EVTPART$idx"} = $part;
  2888. $idx++;
  2889. }
  2890. }
  2891. if($featurelevel > 5.6) {
  2892. $evalSpecials = \%specials;
  2893. return $exec;
  2894. }
  2895. # featurelevel <= 5.6 only:
  2896. # The character % will be replaced with the received event,
  2897. # e.g. with on or off or measured-temp: 21.7 (Celsius)
  2898. # The character @ will be replaced with the device name.
  2899. # To use % or @ in the text itself, use the double mode (%% or @@).
  2900. my $re = join("|", keys %specials); # Found the $syntax, skip the rest
  2901. $re =~ s/%//g;
  2902. if($exec =~ m/\$($re)\b/) {
  2903. $evalSpecials = \%specials;
  2904. return $exec;
  2905. }
  2906. $exec =~ s/%%/____/g;
  2907. # perform macro substitution
  2908. my $extsyntax= 0;
  2909. foreach my $special (keys %specials) {
  2910. $extsyntax+= ($exec =~ s/$special/$specials{$special}/g);
  2911. }
  2912. if(!$extsyntax) {
  2913. $exec =~ s/%/$specials{"%EVENT"}/g;
  2914. }
  2915. $exec =~ s/____/%/g;
  2916. $exec =~ s/@@/____/g;
  2917. $exec =~ s/@/$specials{"%NAME"}/g;
  2918. $exec =~ s/____/@/g;
  2919. return $exec;
  2920. }
  2921. #####################################
  2922. # Parse a timespec: HH:MM:SS, HH:MM or { perfunc() }
  2923. sub
  2924. GetTimeSpec($)
  2925. {
  2926. my ($tspec) = @_;
  2927. my ($hr, $min, $sec, $fn);
  2928. if($tspec =~ m/^([0-9]+):([0-5][0-9]):([0-5][0-9])$/) { # HH:MM:SS
  2929. ($hr, $min, $sec) = ($1, $2, $3);
  2930. } elsif($tspec =~ m/^([0-9]+):([0-5][0-9])$/) { # HH:MM
  2931. ($hr, $min, $sec) = ($1, $2, 0);
  2932. } elsif($tspec =~ m/^{(.*)}$/) { # {function}
  2933. $fn = $1;
  2934. $tspec = AnalyzeCommand(undef, "{$fn}");
  2935. $tspec = "<empty string>" if(!$tspec);
  2936. my ($err, $fn2);
  2937. ($err, $hr, $min, $sec, $fn2) = GetTimeSpec($tspec);
  2938. return ("the function \"$fn\" must return a timespec and not $tspec.",
  2939. undef, undef, undef, undef) if($err);
  2940. } else {
  2941. return ("Wrong timespec $tspec: either HH:MM:SS or {perlcode}",
  2942. undef, undef, undef, undef);
  2943. }
  2944. return (undef, $hr, $min, $sec, $fn);
  2945. }
  2946. sub
  2947. deviceEvents($$)
  2948. {
  2949. my ($hash, $withState) = @_; # withState returns stateEvent as state:event
  2950. return undef if(!$hash || !$hash->{CHANGED});
  2951. if($withState) {
  2952. my $cws = $hash->{CHANGEDWITHSTATE};
  2953. if(defined($cws)){
  2954. if(int(@{$cws}) == 0) {
  2955. if($hash->{READINGS} && $hash->{READINGS}{state}) {
  2956. my $ostate = $hash->{READINGS}{state}{VAL};
  2957. my $mstate = ReplaceEventMap($hash->{NAME}, $ostate, 1);
  2958. @{$cws} = map { $_ eq $mstate ? "state: $ostate" : $_ }
  2959. @{$hash->{CHANGED}};
  2960. } else {
  2961. @{$cws} = @{$hash->{CHANGED}};
  2962. }
  2963. }
  2964. return $cws;
  2965. }
  2966. }
  2967. return $hash->{CHANGED};
  2968. }
  2969. #####################################
  2970. # Do the notification
  2971. sub
  2972. DoTrigger($$@)
  2973. {
  2974. my ($dev, $newState, $noreplace) = @_;
  2975. my $ret = "";
  2976. my $hash = $defs{$dev};
  2977. return "" if(!defined($hash));
  2978. $hash->{".triggerUsed"} = 1 if(defined($hash->{".triggerUsed"}));
  2979. if(defined($newState)) {
  2980. if($hash->{CHANGED}) {
  2981. push @{$hash->{CHANGED}}, $newState;
  2982. } else {
  2983. $hash->{CHANGED}[0] = $newState;
  2984. }
  2985. } elsif(!defined($hash->{CHANGED})) {
  2986. return "";
  2987. }
  2988. if(!$noreplace) { # Backward compatibility for code without readingsUpdate
  2989. if($attr{$dev}{eventMap}) {
  2990. my $c = $hash->{CHANGED};
  2991. for(my $i = 0; $i < @{$c}; $i++) {
  2992. $c->[$i] = ReplaceEventMap($dev, $c->[$i], 1);
  2993. }
  2994. $hash->{STATE} = ReplaceEventMap($dev, $hash->{STATE}, 1);
  2995. }
  2996. }
  2997. my $max = int(@{$hash->{CHANGED}});
  2998. if(AttrVal($dev, "do_not_notify", 0)) {
  2999. delete($hash->{CHANGED});
  3000. delete($hash->{CHANGETIME});
  3001. delete($hash->{CHANGEDWITHSTATE});
  3002. return "";
  3003. }
  3004. my $now = TimeNow();
  3005. ################
  3006. # Log/notify modules
  3007. # If modifying a device in its own trigger, do not call the triggers from
  3008. # the inner loop.
  3009. if($max && !defined($hash->{INTRIGGER})) {
  3010. $hash->{INTRIGGER}=1;
  3011. if($attr{global}{verbose} >= 5) {
  3012. Log 5, "Starting notify loop for $dev, " . scalar(@{$hash->{CHANGED}}) .
  3013. " event(s), first is " . escapeLogLine($hash->{CHANGED}->[0]);
  3014. }
  3015. createNtfyHash() if(!%ntfyHash);
  3016. $hash->{NTFY_TRIGGERTIME} = $now; # Optimize FileLog
  3017. my $ntfyLst = (defined($ntfyHash{$dev}) ? $ntfyHash{$dev} : $ntfyHash{"*"});
  3018. foreach my $n (@{$ntfyLst}) {
  3019. next if(!defined($defs{$n})); # Was deleted in a previous notify
  3020. my $r = CallFn($n, "NotifyFn", $defs{$n}, $hash);
  3021. $ret .= " $n:$r" if($r);
  3022. }
  3023. delete($hash->{NTFY_TRIGGERTIME});
  3024. Log 5, "End notify loop for $dev";
  3025. ################
  3026. # Inform
  3027. if($hash->{CHANGED}) { # It gets deleted sometimes (?)
  3028. foreach my $c (keys %inform) {
  3029. my $dc = $defs{$c};
  3030. if(!$dc || $dc->{NR} != $inform{$c}{NR}) {
  3031. delete($inform{$c});
  3032. next;
  3033. }
  3034. next if($inform{$c}{type} eq "raw");
  3035. my $tn = $now;
  3036. if($attr{global}{mseclog}) {
  3037. my ($seconds, $microseconds) = gettimeofday();
  3038. $tn .= sprintf(".%03d", $microseconds/1000);
  3039. }
  3040. my $re = $inform{$c}{regexp};
  3041. my $events = deviceEvents($hash, $inform{$c}{type} =~ m/WithState/);
  3042. $max = int(@{$events});
  3043. for(my $i = 0; $i < $max; $i++) {
  3044. my $event = $events->[$i];
  3045. next if($re && !($dev =~ m/$re/ || "$dev:$event" =~ m/$re/));
  3046. addToWritebuffer($dc,($inform{$c}{type} eq "timer" ? "$tn " : "").
  3047. "$hash->{TYPE} $dev $event\n");
  3048. }
  3049. }
  3050. }
  3051. delete($hash->{INTRIGGER});
  3052. }
  3053. ####################
  3054. # Used by triggered perl programs to check the old value
  3055. # Not suited for multi-valued devices (KS300, etc)
  3056. $oldvalue{$dev}{TIME} = $now;
  3057. $oldvalue{$dev}{VAL} = $hash->{STATE};
  3058. if(!defined($hash->{INTRIGGER})) {
  3059. delete($hash->{CHANGED});
  3060. delete($hash->{CHANGETIME});
  3061. delete($hash->{CHANGEDWITHSTATE});
  3062. }
  3063. Log 3, "NTFY return: $ret" if($ret);
  3064. return $ret;
  3065. }
  3066. #####################################
  3067. # Wrapper for calling a module function
  3068. sub
  3069. CallFn(@)
  3070. {
  3071. my $d = shift;
  3072. my $n = shift;
  3073. if(!$d || !$defs{$d}) {
  3074. $d = "<undefined>" if(!defined($d));
  3075. Log 0, "Strange call for nonexistent $d: $n";
  3076. return undef;
  3077. }
  3078. if(!$defs{$d}{TYPE}) {
  3079. Log 0, "Strange call for typeless $d: $n";
  3080. return undef;
  3081. }
  3082. my $fn = $modules{$defs{$d}{TYPE}}{$n};
  3083. return "" if(!$fn);
  3084. if(wantarray) {
  3085. no strict "refs";
  3086. my @ret = &{$fn}(@_);
  3087. use strict "refs";
  3088. return @ret;
  3089. } else {
  3090. no strict "refs";
  3091. my $ret = &{$fn}(@_);
  3092. use strict "refs";
  3093. return $ret;
  3094. }
  3095. }
  3096. #####################################
  3097. # Alternative to CallFn with optional functions in $defs, Forum #64741
  3098. sub
  3099. CallInstanceFn(@)
  3100. {
  3101. my $d = shift;
  3102. my $n = shift;
  3103. if(!$d || !$defs{$d}) {
  3104. $d = "<undefined>" if(!defined($d));
  3105. Log 0, "Strange call for nonexistent $d: $n";
  3106. return undef;
  3107. }
  3108. my $fn = $defs{$d}{$n} ? $defs{$d}{$n} : $defs{$d}{".$n"};
  3109. return CallFn($d, $n, @_) if(!$fn);
  3110. if(wantarray) {
  3111. no strict "refs";
  3112. my @ret = &{$fn}(@_);
  3113. use strict "refs";
  3114. return @ret;
  3115. } else {
  3116. no strict "refs";
  3117. my $ret = &{$fn}(@_);
  3118. use strict "refs";
  3119. return $ret;
  3120. }
  3121. }
  3122. #####################################
  3123. # Used from perl oneliners inside of scripts
  3124. sub
  3125. fhem($@)
  3126. {
  3127. my ($param, $silent) = @_;
  3128. my $ret = AnalyzeCommandChain(undef, $param);
  3129. Log 3, "$param : $ret" if($ret && !$silent);
  3130. return $ret;
  3131. }
  3132. #####################################
  3133. # initialize the global device
  3134. sub
  3135. doGlobalDef($)
  3136. {
  3137. my ($arg) = @_;
  3138. $devcount = 1;
  3139. $defs{global}{NR} = $devcount++;
  3140. $defs{global}{TYPE} = "Global";
  3141. $defs{global}{STATE} = "no definition";
  3142. $defs{global}{DEF} = "no definition";
  3143. $defs{global}{NAME} = "global";
  3144. CommandAttr(undef, "global verbose 3");
  3145. CommandAttr(undef, "global configfile $arg");
  3146. CommandAttr(undef, "global logfile -");
  3147. }
  3148. #####################################
  3149. # rename does not work over Filesystems: lets copy it
  3150. sub
  3151. myrename($$$)
  3152. {
  3153. my ($name, $from, $to) = @_;
  3154. my $ca = AttrVal($name, "archiveCompress", 0);
  3155. if($ca) {
  3156. eval { require Compress::Zlib; };
  3157. if($@) {
  3158. $ca = 0;
  3159. Log 1, $@;
  3160. }
  3161. }
  3162. $to .= ".gz" if($ca);
  3163. if(!open(F, $from)) {
  3164. Log(1, "Rename: Cannot open $from: $!");
  3165. return;
  3166. }
  3167. if(!open(T, ">$to")) {
  3168. Log(1, "Rename: Cannot open $to: $!");
  3169. return;
  3170. }
  3171. if($ca) {
  3172. my $d = Compress::Zlib::deflateInit(-WindowBits=>31);
  3173. my $buf;
  3174. while(sysread(F,$buf,32768) > 0) {
  3175. syswrite(T, $d->deflate($buf));
  3176. }
  3177. syswrite(T, $d->flush());
  3178. } else {
  3179. while(my $l = <F>) {
  3180. print T $l;
  3181. }
  3182. }
  3183. close(F);
  3184. close(T);
  3185. unlink($from);
  3186. }
  3187. #####################################
  3188. # Make a directory and its parent directories if needed.
  3189. sub
  3190. HandleArchiving($;$)
  3191. {
  3192. my ($log,$flogInitial) = @_;
  3193. my $ln = $log->{NAME};
  3194. return if(!$attr{$ln});
  3195. # If there is a command, call that
  3196. my $cmd = $attr{$ln}{archivecmd};
  3197. if($cmd) {
  3198. return if($flogInitial); # Forum #41245
  3199. $cmd =~ s/%/$log->{currentlogfile}/g;
  3200. Log 2, "Archive: calling $cmd";
  3201. system($cmd);
  3202. return;
  3203. }
  3204. my $nra = $attr{$ln}{nrarchive};
  3205. my $ard = $attr{$ln}{archivedir};
  3206. return if(!defined($nra));
  3207. $nra++ if($ln eq "global"); # Forum #61450
  3208. # If nrarchive is set, then check the last files:
  3209. # Get a list of files:
  3210. my ($dir, $file);
  3211. if($log->{logfile} =~ m,^(.+)/([^/]+)$,) {
  3212. ($dir, $file) = ($1, $2);
  3213. } else {
  3214. ($dir, $file) = (".", $log->{logfile});
  3215. }
  3216. $file =~ s/%./.+/g;
  3217. my @t = localtime(gettimeofday());
  3218. $dir = ResolveDateWildcards($dir, @t);
  3219. return if(!opendir(DH, $dir));
  3220. my @files = sort grep {/^$file$/} readdir(DH);
  3221. @files = sort { (stat("$dir/$a"))[9] cmp (stat("$dir/$b"))[9] } @files
  3222. if(AttrVal("global", "archivesort", "alphanum") eq "timestamp");
  3223. closedir(DH);
  3224. my $max = int(@files)-$nra;
  3225. $max-- if($flogInitial);
  3226. for(my $i = 0; $i < $max; $i++) {
  3227. if($ard) {
  3228. Log 2, "Moving $files[$i] to $ard";
  3229. myrename($ln, "$dir/$files[$i]", "$ard/$files[$i]");
  3230. } else {
  3231. Log 2, "Deleting $files[$i]";
  3232. unlink("$dir/$files[$i]");
  3233. }
  3234. }
  3235. }
  3236. #####################################
  3237. # Call a logical device (FS20) ParseMessage with data from a physical device
  3238. # (FHZ). Note: $hash may be dummy, used by FHEM2FHEM
  3239. sub
  3240. Dispatch($$;$$)
  3241. {
  3242. my ($hash, $dmsg, $addvals, $nounknown) = @_;
  3243. my $module = $modules{$hash->{TYPE}};
  3244. my $name = $hash->{NAME};
  3245. if(GetVerbose($name) == 5) {
  3246. Log3 $hash, 5, escapeLogLine("$name: dispatch $dmsg");
  3247. }
  3248. my ($isdup, $idx) = CheckDuplicate($name, $dmsg, $module->{FingerprintFn});
  3249. return rejectDuplicate($name,$idx,$addvals) if($isdup);
  3250. my @found;
  3251. my $parserMod="";
  3252. my $clientArray = $hash->{".clientArray"};
  3253. $clientArray = computeClientArray($hash, $module) if(!$clientArray);
  3254. foreach my $m (@{$clientArray}) {
  3255. # Module is not loaded or the message is not for this module
  3256. next if(!$modules{$m} || $dmsg !~ m/$modules{$m}{Match}/i);
  3257. if( my $ffn = $modules{$m}{FingerprintFn} ) {
  3258. ($isdup, $idx) = CheckDuplicate($name, $dmsg, $ffn);
  3259. return rejectDuplicate($name,$idx,$addvals) if($isdup);
  3260. }
  3261. no strict "refs"; $readingsUpdateDelayTrigger = 1;
  3262. @found = &{$modules{$m}{ParseFn}}($hash,$dmsg);
  3263. use strict "refs"; $readingsUpdateDelayTrigger = 0;
  3264. $parserMod = $m;
  3265. last if(int(@found));
  3266. }
  3267. if((!int(@found) || !defined($found[0])) && !$nounknown) {
  3268. my $h = $hash->{MatchList};
  3269. $h = $module->{MatchList} if(!$h);
  3270. if(defined($h)) {
  3271. foreach my $m (sort keys %{$h}) {
  3272. if($dmsg =~ m/$h->{$m}/) {
  3273. my ($order, $mname) = split(":", $m);
  3274. if($attr{global}{autoload_undefined_devices}) {
  3275. my $newm = LoadModule($mname);
  3276. $mname = $newm if($newm ne "UNDEFINED");
  3277. if($modules{$mname} && $modules{$mname}{ParseFn}) {
  3278. no strict "refs"; $readingsUpdateDelayTrigger = 1;
  3279. @found = &{$modules{$mname}{ParseFn}}($hash,$dmsg);
  3280. use strict "refs"; $readingsUpdateDelayTrigger = 0;
  3281. $parserMod = $mname;
  3282. last if(defined($found[0]));
  3283. } else {
  3284. Log 0, "ERROR: Cannot autoload $mname";
  3285. }
  3286. } else {
  3287. Log3 $name, 3, "$name: Unknown $mname device detected, " .
  3288. "define one to get detailed information.";
  3289. return undef;
  3290. }
  3291. }
  3292. }
  3293. }
  3294. if((!int(@found) || !defined($found[0])) && !$nounknown) {
  3295. DoTrigger($name, "UNKNOWNCODE $dmsg");
  3296. Log3 $name, 3, "$name: Unknown code $dmsg, help me!";
  3297. return undef;
  3298. }
  3299. }
  3300. ################
  3301. # Inform raw
  3302. if(!$module->{noRawInform}) {
  3303. foreach my $c (keys %inform) {
  3304. if(!$defs{$c} || $defs{$c}{NR} != $inform{$c}{NR}) {
  3305. delete($inform{$c});
  3306. next;
  3307. }
  3308. next if($inform{$c}{type} ne "raw");
  3309. syswrite($defs{$c}{CD}, "$hash->{TYPE} $name $dmsg\n");
  3310. }
  3311. }
  3312. # Special return: Do not notify
  3313. return undef if(!defined($found[0]) || $found[0] eq "");
  3314. foreach my $found (@found) {
  3315. if($found =~ m/^(UNDEFINED.*)/) {
  3316. DoTrigger("global", $1);
  3317. return undef;
  3318. } else {
  3319. if($defs{$found}) {
  3320. if(!$defs{$found}{".noDispatchVars"}) { # CUL_HM special
  3321. $defs{$found}{MSGCNT}++;
  3322. my $avtrigger = ($attr{$name} && $attr{$name}{addvaltrigger});
  3323. if($addvals) {
  3324. foreach my $av (keys %{$addvals}) {
  3325. $defs{$found}{"${name}_$av"} = $addvals->{$av};
  3326. push(@{$defs{$found}{CHANGED}}, "$av: $addvals->{$av}")
  3327. if($avtrigger);
  3328. }
  3329. }
  3330. $defs{$found}{"${name}_MSGCNT"}++;
  3331. $defs{$found}{"${name}_TIME"} = TimeNow();
  3332. $defs{$found}{LASTInputDev} = $name;
  3333. }
  3334. delete($defs{$found}{".noDispatchVars"});
  3335. DoTrigger($found, undef);
  3336. } else {
  3337. Log 1, "ERROR: >$found< returned by the $parserMod ParseFn is invalid,".
  3338. " notify the module maintainer";
  3339. return undef;
  3340. }
  3341. }
  3342. }
  3343. $duplicate{$idx}{FND} = \@found
  3344. if(defined($idx) && defined($duplicate{$idx}));
  3345. return \@found;
  3346. }
  3347. sub
  3348. CheckDuplicate($$@)
  3349. {
  3350. my ($ioname, $msg, $ffn) = @_;
  3351. if($ffn) {
  3352. no strict "refs";
  3353. ($ioname,$msg) = &{$ffn}($ioname,$msg);
  3354. use strict "refs";
  3355. return (0, undef) if( !defined($msg) );
  3356. #Debug "got $ffn ". $ioname .":". $msg;
  3357. }
  3358. my $now = gettimeofday();
  3359. my $lim = $now-AttrVal("global","dupTimeout", 0.5);
  3360. foreach my $oidx (keys %duplicate) {
  3361. if($duplicate{$oidx}{TIM} < $lim) {
  3362. delete($duplicate{$oidx});
  3363. } elsif($duplicate{$oidx}{MSG} eq $msg &&
  3364. $duplicate{$oidx}{ION} eq "") {
  3365. return (1, $oidx);
  3366. } elsif($duplicate{$oidx}{MSG} eq $msg &&
  3367. $duplicate{$oidx}{ION} ne $ioname) {
  3368. return (1, $oidx);
  3369. }
  3370. }
  3371. #Debug "is unique";
  3372. $duplicate{$duplidx}{ION} = $ioname;
  3373. $duplicate{$duplidx}{MSG} = $msg;
  3374. $duplicate{$duplidx}{TIM} = $now;
  3375. $duplidx++;
  3376. return (0, $duplidx-1);
  3377. }
  3378. sub
  3379. rejectDuplicate($$$)
  3380. {
  3381. #Debug "is duplicate";
  3382. my ($name,$idx,$addvals) = @_;
  3383. my $found = $duplicate{$idx}{FND};
  3384. foreach my $found (@{$found}) {
  3385. if($addvals) {
  3386. foreach my $av (keys %{$addvals}) {
  3387. $defs{$found}{"${name}_$av"} = $addvals->{$av};
  3388. }
  3389. }
  3390. $defs{$found}{"${name}_MSGCNT"}++;
  3391. $defs{$found}{"${name}_TIME"} = TimeNow();
  3392. }
  3393. return $duplicate{$idx}{FND};
  3394. }
  3395. sub
  3396. AddDuplicate($$)
  3397. {
  3398. $duplicate{$duplidx}{ION} = shift;
  3399. $duplicate{$duplidx}{MSG} = shift;
  3400. $duplicate{$duplidx}{TIM} = gettimeofday();
  3401. $duplidx++;
  3402. }
  3403. # Add an attribute to the userattr list, if not yet present
  3404. sub
  3405. addToDevAttrList($$)
  3406. {
  3407. my ($dev,$arg) = @_;
  3408. my $ua = $attr{$dev}{userattr};
  3409. $ua = "" if(!$ua);
  3410. my %hash = map { ($_ => 1) }
  3411. grep { " $AttrList " !~ m/ $_ / }
  3412. split(" ", "$ua $arg");
  3413. $attr{$dev}{userattr} = join(" ", sort keys %hash);
  3414. }
  3415. # The counterpart: delete it.
  3416. sub
  3417. delFromDevAttrList($$)
  3418. {
  3419. my ($dev,$arg) = @_;
  3420. my $ua = $attr{$dev}{userattr};
  3421. $ua = "" if(!$ua);
  3422. my %hash = map { ($_ => 1) }
  3423. grep { " $arg " !~ m/ $_ / }
  3424. split(" ", "$ua $arg");
  3425. $attr{$dev}{userattr} = join(" ", sort keys %hash);
  3426. delete $attr{$dev}{userattr}
  3427. if(!keys %hash && defined($attr{$dev}{userattr}));
  3428. map { delete $attr{$dev}{$_} } split(" ", (split(":", $arg))[0]);
  3429. }
  3430. sub
  3431. addToAttrList($)
  3432. {
  3433. addToDevAttrList("global", shift);
  3434. }
  3435. sub
  3436. delFromAttrList($)
  3437. {
  3438. delFromDevAttrList("global", shift);
  3439. }
  3440. # device specific attrList, overwrites module AttrList, user undef for $argList
  3441. # to delete it
  3442. sub
  3443. setDevAttrList($;$)
  3444. {
  3445. my ($dev,$argList) = @_;
  3446. return if(!$defs{$dev});
  3447. if(defined($argList)) {
  3448. $defs{$dev}{".AttrList"} = $argList;
  3449. } else {
  3450. delete($defs{$dev}{".AttrList"});
  3451. }
  3452. }
  3453. sub
  3454. attrSplit($)
  3455. {
  3456. my ($em) = @_;
  3457. my $sc = " "; # Split character
  3458. my $fc = substr($em, 0, 1); # First character of the eventMap
  3459. if($fc eq "," || $fc eq "/") {
  3460. $sc = $fc;
  3461. $em = substr($em, 1);
  3462. }
  3463. return split($sc, $em);
  3464. }
  3465. #######################
  3466. # $dir: 0: User to Device (i.e. set), $str is an array pointer
  3467. # $dir: 1: Device to Usr (i.e trigger), $str is a a string
  3468. sub
  3469. ReplaceEventMap($$$)
  3470. {
  3471. my ($dev, $str, $dir) = @_;
  3472. my $em = AttrVal($dev, "eventMap", undef);
  3473. return $str if($dir && !$em);
  3474. return @{$str} if(!$dir && (!$em || int(@{$str}) < 2 ||
  3475. !defined($str->[1]) || $str->[1] eq "?"));
  3476. return ReplaceEventMap2($dev, $str, $dir, $em) if($em =~ m/^{.*}$/s);
  3477. my @emList = attrSplit($em);
  3478. if(!defined $defs{$dev}{".eventMapCmd"}) {
  3479. # Delete the first word of the translation (.*:), else it will be
  3480. # interpreted as the single possible value for a dropdown
  3481. # Why is the .*= deleted?
  3482. $defs{$dev}{".eventMapCmd"} = join(" ", grep { !/ / }
  3483. map { $_ =~ s/.*?=//s; $_ =~ s/.*?://s;
  3484. $_ =~ m/:/ ? $_ : "$_:noArg" } @emList);
  3485. }
  3486. my ($dname, $nstr);
  3487. $dname = shift @{$str} if(!$dir);
  3488. $nstr = join(" ", @{$str}) if(!$dir);
  3489. my $changed;
  3490. foreach my $rv (@emList) {
  3491. # Real-Event-Regexp:GivenName[:modifier]
  3492. my ($re, $val, $modifier) = split(":", $rv, 3);
  3493. next if(!defined($val));
  3494. if($dir) { # dev -> usr
  3495. my $reIsWord = ($re =~ m/^\w*$/); # dim100% is not \w only, cant use \b
  3496. if($reIsWord) {
  3497. if($str =~ m/\b$re\b/) {
  3498. $str =~ s/\b$re\b/$val/;
  3499. $changed = 1;
  3500. }
  3501. } else {
  3502. if($str =~ m/$re/) {
  3503. $str =~ s/$re/$val/;
  3504. $changed = 1;
  3505. }
  3506. }
  3507. } else { # usr -> dev
  3508. if($nstr eq $val) { # for special translations like <> and <<
  3509. $nstr = $re;
  3510. $changed = 1;
  3511. } else {
  3512. my $reIsWord = ($val =~ m/^\w*$/);
  3513. if($reIsWord) {
  3514. if($nstr =~ m/\b$val\b/) {
  3515. $nstr =~ s/\b$val\b/$re/;
  3516. $changed = 1;
  3517. }
  3518. } elsif($nstr =~ m/$val/) {
  3519. $nstr =~ s/$val/$re/;
  3520. $changed = 1;
  3521. }
  3522. }
  3523. }
  3524. last if($changed);
  3525. }
  3526. return $str if($dir);
  3527. if($changed) {
  3528. my @arr = split(" ",$nstr);
  3529. unshift @arr, $dname;
  3530. return @arr;
  3531. } else {
  3532. unshift @{$str}, $dname;
  3533. return @{$str};
  3534. }
  3535. }
  3536. # $dir: 0:usr,$str is array pointer, 1:dev, $str is string
  3537. # perl notation: { dev=>{"re1"=>"Evt1",...}, fw=>{"re1"=>"Set 1",...}}
  3538. sub
  3539. ReplaceEventMap2($$$)
  3540. {
  3541. my ($dev, $str, $dir) = @_;
  3542. my $hash = $defs{$dev};
  3543. my $emh = $hash->{".eventMapHash"};
  3544. if(!$emh) {
  3545. eval "\$emh = $attr{$dev}{eventMap}";
  3546. if($@) {
  3547. my $msg = "ERROR in eventMap for $dev: $@";
  3548. Log 1, $msg;
  3549. return $msg;
  3550. }
  3551. $hash->{".eventMapHash"} = $emh;
  3552. $defs{$dev}{".eventMapCmd"} = "";
  3553. if($emh->{usr}) {
  3554. my @cmd;
  3555. my $fw = $emh->{fw};
  3556. $defs{$dev}{".eventMapCmd"} = join(" ",
  3557. map { ($fw && $fw->{$_}) ? $fw->{$_}:$_} sort keys %{$emh->{usr} });
  3558. }
  3559. }
  3560. if($dir == 1) {
  3561. $emh = $emh->{dev};
  3562. if($emh) {
  3563. foreach my $k (keys %{$emh}) {
  3564. return $emh->{$k} if($str eq $k);
  3565. return eval '"'.$emh->{$k}.'"' if($str =~ m/$k/);
  3566. }
  3567. }
  3568. return $str;
  3569. }
  3570. $emh = $emh->{usr};
  3571. return @{$str} if(!$emh);
  3572. my $dname = shift @{$str};
  3573. my $nstr = join(" ", @{$str});
  3574. foreach my $k (keys %{$emh}) {
  3575. my $nv;
  3576. if($nstr eq $k) {
  3577. $nv = $emh->{$k};
  3578. } elsif($nstr =~ m/$k/) {
  3579. my $NAME = $dev; # Compatibility, Forum #43023
  3580. $nv = eval '"'.$emh->{$k}.'"';
  3581. }
  3582. if(defined($nv)) {
  3583. my @arr = split(" ",$nv);
  3584. unshift @arr, $dname;
  3585. return @arr;
  3586. }
  3587. }
  3588. unshift @{$str}, $dname;
  3589. return @{$str};
  3590. }
  3591. sub
  3592. setGlobalAttrBeforeFork($)
  3593. {
  3594. my ($f) = @_;
  3595. my ($err, @rows);
  3596. if($f eq 'configDB') {
  3597. @rows = cfgDB_AttrRead('global');
  3598. } else {
  3599. ($err, @rows) = FileRead($f);
  3600. die("$err\n") if($err);
  3601. }
  3602. foreach my $l (@rows) {
  3603. $l =~ s/[\r\n]//g;
  3604. next if($l !~ m/^attr\s+global\s+([^\s]+)\s+(.*)$/);
  3605. my ($n,$v) = ($1,$2);
  3606. $v =~ s/#.*//;
  3607. $v =~ s/ .*$//;
  3608. if($fhemdebug) {
  3609. $v = "-" if($n eq "logfile");
  3610. $v = 5 if($n eq "verbose");
  3611. }
  3612. $attr{global}{$n} = $v;
  3613. GlobalAttr("set", "global", $n, $v);
  3614. }
  3615. }
  3616. sub
  3617. resolveAttrRename($$)
  3618. {
  3619. my ($d,$n) = @_;
  3620. return $n if(!$d || !$defs{$d});
  3621. my $m = $modules{$defs{$d}{TYPE}};
  3622. if($m->{AttrRenameMap} && defined($m->{AttrRenameMap}{$n})) {
  3623. Log 3, "WARNING: $d attribute $n was renamed to ".$m->{AttrRenameMap}{$n};
  3624. return $m->{AttrRenameMap}{$n};
  3625. }
  3626. return $n;
  3627. }
  3628. ###########################################
  3629. # Functions used to make fhem-oneliners more readable,
  3630. # but also recommended to be used by modules
  3631. sub
  3632. InternalVal($$$)
  3633. {
  3634. my ($d,$n,$default) = @_;
  3635. if(defined($defs{$d}) &&
  3636. defined($defs{$d}{$n})) {
  3637. return $defs{$d}{$n};
  3638. }
  3639. return $default;
  3640. }
  3641. sub
  3642. InternalNum($$$;$)
  3643. {
  3644. my ($d,$n,$default,$round) = @_;
  3645. my $val = InternalVal($d,$n,$default);
  3646. $val = ($val =~ /(-?\d+(\.\d+)?)/ ? $1 : "");
  3647. $val = round($val,$round) if($round);
  3648. return $val;
  3649. }
  3650. sub
  3651. OldReadingsVal($$$)
  3652. {
  3653. my ($d,$n,$default) = @_;
  3654. if(defined($defs{$d}) &&
  3655. defined($defs{$d}{OLDREADINGS}) &&
  3656. defined($defs{$d}{OLDREADINGS}{$n}) &&
  3657. defined($defs{$d}{OLDREADINGS}{$n}{VAL})) {
  3658. return $defs{$d}{OLDREADINGS}{$n}{VAL};
  3659. }
  3660. return $default;
  3661. }
  3662. sub
  3663. OldReadingsNum($$$;$)
  3664. {
  3665. my ($d,$n,$default,$round) = @_;
  3666. my $val = OldReadingsVal($d,$n,$default);
  3667. return undef if(!defined($val));
  3668. $val = ($val =~ /(-?\d+(\.\d+)?)/ ? $1 : "");
  3669. return $default if($val eq "");
  3670. $val = round($val,$round) if($round);
  3671. return $val;
  3672. }
  3673. sub
  3674. OldReadingsTimestamp($$$)
  3675. {
  3676. my ($d,$n,$default) = @_;
  3677. if(defined($defs{$d}) &&
  3678. defined($defs{$d}{OLDREADINGS}) &&
  3679. defined($defs{$d}{OLDREADINGS}{$n}) &&
  3680. defined($defs{$d}{OLDREADINGS}{$n}{TIME})) {
  3681. return $defs{$d}{OLDREADINGS}{$n}{TIME};
  3682. }
  3683. return $default;
  3684. }
  3685. sub
  3686. OldReadingsAge($$$)
  3687. {
  3688. my ($device,$reading,$default) = @_;
  3689. my $ts = OldReadingsTimestamp($device,$reading,undef);
  3690. return int(gettimeofday() - time_str2num($ts)) if(defined($ts));
  3691. return $default;
  3692. }
  3693. sub
  3694. ReadingsVal($$$)
  3695. {
  3696. my ($d,$n,$default) = @_;
  3697. if(defined($defs{$d}) &&
  3698. defined($defs{$d}{READINGS}) &&
  3699. defined($defs{$d}{READINGS}{$n}) &&
  3700. defined($defs{$d}{READINGS}{$n}{VAL})) {
  3701. return $defs{$d}{READINGS}{$n}{VAL};
  3702. }
  3703. return $default;
  3704. }
  3705. sub
  3706. ReadingsNum($$$;$)
  3707. {
  3708. my ($d,$n,$default,$round) = @_;
  3709. my $val = ReadingsVal($d,$n,$default);
  3710. return undef if(!defined($val));
  3711. $val = ($val =~ /(-?\d+(\.\d+)?)/ ? $1 : "");
  3712. return $default if($val eq "");
  3713. $val = round($val,$round) if($round);
  3714. return $val;
  3715. }
  3716. sub
  3717. ReadingsTimestamp($$$)
  3718. {
  3719. my ($d,$n,$default) = @_;
  3720. if(defined($defs{$d}) &&
  3721. defined($defs{$d}{READINGS}) &&
  3722. defined($defs{$d}{READINGS}{$n}) &&
  3723. defined($defs{$d}{READINGS}{$n}{TIME})) {
  3724. return $defs{$d}{READINGS}{$n}{TIME};
  3725. }
  3726. return $default;
  3727. }
  3728. sub
  3729. ReadingsAge($$$)
  3730. {
  3731. my ($device,$reading,$default) = @_;
  3732. my $ts = ReadingsTimestamp($device,$reading,undef);
  3733. return int(gettimeofday() - time_str2num($ts)) if(defined($ts));
  3734. return $default;
  3735. }
  3736. sub
  3737. Value($)
  3738. {
  3739. my ($d) = @_;
  3740. if(defined($defs{$d}) &&
  3741. defined($defs{$d}{STATE})) {
  3742. return $defs{$d}{STATE};
  3743. }
  3744. return "";
  3745. }
  3746. sub
  3747. OldValue($)
  3748. {
  3749. my ($d) = @_;
  3750. return $oldvalue{$d}{VAL} if(defined($oldvalue{$d})) ;
  3751. return "";
  3752. }
  3753. sub
  3754. OldTimestamp($)
  3755. {
  3756. my ($d) = @_;
  3757. return $oldvalue{$d}{TIME} if(defined($oldvalue{$d})) ;
  3758. return "";
  3759. }
  3760. sub
  3761. AttrVal($$$)
  3762. {
  3763. my ($d,$n,$default) = @_;
  3764. $n = resolveAttrRename($d, $n);
  3765. return $attr{$d}{$n} if(defined($attr{$d}) && defined($attr{$d}{$n}));
  3766. return $default;
  3767. }
  3768. sub
  3769. AttrNum($$$;$)
  3770. {
  3771. my ($d,$n,$default,$round) = @_;
  3772. my $val = AttrVal($d,$n,$default);
  3773. return undef if(!defined($val));
  3774. $val = ($val =~ /(-?\d+(\.\d+)?)/ ? $1 : "");
  3775. $val = round($val,$round) if($round);
  3776. return $val;
  3777. }
  3778. ################################################################
  3779. # Functions used by modules.
  3780. sub
  3781. setReadingsVal($$$$)
  3782. {
  3783. my ($hash,$rname,$val,$ts) = @_;
  3784. if($hash->{".or"} && grep($rname =~ m/^$_$/, @{$hash->{".or"}}) ) {
  3785. if(defined($hash->{READINGS}{$rname}) &&
  3786. defined($hash->{READINGS}{$rname}{VAL}) &&
  3787. $hash->{READINGS}{$rname}{VAL} ne $val ) {
  3788. $hash->{OLDREADINGS}{$rname}{VAL} = $hash->{READINGS}{$rname}{VAL};
  3789. $hash->{OLDREADINGS}{$rname}{TIME} = $hash->{READINGS}{$rname}{TIME};
  3790. }
  3791. }
  3792. $hash->{READINGS}{$rname}{VAL} = $val;
  3793. $hash->{READINGS}{$rname}{TIME} = $ts;
  3794. }
  3795. sub
  3796. addEvent($$)
  3797. {
  3798. my ($hash,$event) = @_;
  3799. push(@{$hash->{CHANGED}}, $event);
  3800. }
  3801. sub
  3802. concatc($$$) {
  3803. my ($separator,$a,$b)= @_;;
  3804. return($a && $b ? $a . $separator . $b : $a . $b);
  3805. }
  3806. ################################################################
  3807. #
  3808. # Wrappers for commonly used core functions in device-specific modules.
  3809. #
  3810. ################################################################
  3811. #
  3812. # Call readingsBeginUpdate before you start updating readings.
  3813. # The updated readings will all get the same timestamp,
  3814. # which is the time when you called this subroutine.
  3815. #
  3816. sub
  3817. readingsBeginUpdate($)
  3818. {
  3819. my ($hash)= @_;
  3820. my $name = $hash->{NAME};
  3821. if(!$name) {
  3822. Log 1, "ERROR: empty name in readingsBeginUpdate";
  3823. stacktrace();
  3824. return;
  3825. }
  3826. # get timestamp
  3827. my $now = gettimeofday();
  3828. my $fmtDateTime = FmtDateTime($now);
  3829. $hash->{".updateTime"} = $now; # in seconds since the epoch
  3830. $hash->{".updateTimestamp"} = $fmtDateTime;
  3831. $hash->{CHANGED}= () if(!defined($hash->{CHANGED}));
  3832. return $fmtDateTime;
  3833. }
  3834. sub
  3835. evalStateFormat($)
  3836. {
  3837. my ($hash) = @_;
  3838. my $name = $hash->{NAME};
  3839. ###########################
  3840. # Set STATE
  3841. my $sr = AttrVal($name, "stateFormat", undef);
  3842. my $st = $hash->{READINGS}{state};
  3843. if(!$sr) {
  3844. $st = $st->{VAL} if(defined($st));
  3845. } elsif($sr =~ m/^{(.*)}$/s) {
  3846. $st = eval $1;
  3847. if($@) {
  3848. $st = "Error evaluating $name stateFormat: $@";
  3849. Log 1, $st;
  3850. }
  3851. } else {
  3852. # Substitute reading names with their values, leave the rest untouched.
  3853. $st = $sr;
  3854. my $r = $hash->{READINGS};
  3855. $st =~ s/\$name/$name/g;
  3856. (undef, $st) = ReplaceSetMagic($hash, 1, $st);
  3857. $st =~ s/\b([A-Za-z\d_\.-]+)\b/($r->{$1} ? $r->{$1}{VAL} : $1)/ge
  3858. if($st eq $sr);
  3859. }
  3860. $hash->{STATE} = ReplaceEventMap($name, $st, 1) if(defined($st));
  3861. }
  3862. #
  3863. # Call readingsEndUpdate when you are done updating readings.
  3864. # This optionally calls DoTrigger to propagate the changes.
  3865. #
  3866. sub
  3867. readingsEndUpdate($$)
  3868. {
  3869. my ($hash,$dotrigger)= @_;
  3870. my $name = $hash->{NAME};
  3871. $hash->{".triggerUsed"} = 1 if(defined($hash->{".triggerUsed"}));
  3872. # process user readings
  3873. if(defined($hash->{'.userReadings'})) {
  3874. foreach my $userReading (@{$hash->{'.userReadings'}}) {
  3875. my $trigger = $userReading->{trigger};
  3876. my $reading= $userReading->{reading};
  3877. my ($event, $eventName, $eventValue, $ownRead);
  3878. if(defined($trigger)) {
  3879. map { $event = $_ if($_ && $_ =~ m/^$trigger$/);
  3880. $ownRead = 1 if($_ && $_ =~ m/^$reading:/); } @{$hash->{CHANGED}};
  3881. next if(!$event || $ownRead);
  3882. ($eventName, $eventValue) = ($1, $2) if($event =~ m/^([^:]*): (.*)$/);
  3883. }
  3884. my $modifier= $userReading->{modifier};
  3885. my $perlCode= $userReading->{perlCode};
  3886. my $oldvalue= $userReading->{value};
  3887. my $oldt= $userReading->{t};
  3888. #Debug "Evaluating " . $reading;
  3889. $cmdFromAnalyze = $perlCode; # For the __WARN__ sub
  3890. my $NAME = $name; # no exceptions, #53069
  3891. my $value= eval $perlCode;
  3892. $cmdFromAnalyze = undef;
  3893. my $result;
  3894. # store result
  3895. if($@) {
  3896. $value = "Error evaluating $name userReading $reading: $@";
  3897. Log 1, $value;
  3898. $result= $value;
  3899. } elsif(!defined($value)) {
  3900. $cmdFromAnalyze = $perlCode; # For the __WARN__ sub
  3901. warn("$name userReadings $reading evaluated to undef");
  3902. next;
  3903. } elsif($modifier eq "none") {
  3904. $result= $value;
  3905. } elsif($modifier eq "difference") {
  3906. $result= $value - $oldvalue if(defined($oldvalue));
  3907. } elsif($modifier eq "differential") {
  3908. my ($deltav, $deltat);
  3909. $deltav = $value - $oldvalue if(defined($oldvalue));
  3910. $deltat = $hash->{".updateTime"} - $oldt if(defined($oldt));
  3911. if(defined($deltav) && defined($deltat) && ($deltat>= 1.0)) {
  3912. $result= $deltav/$deltat;
  3913. }
  3914. } elsif($modifier eq "integral") {
  3915. if(defined($oldt) && defined($oldvalue)) {
  3916. my $deltat;
  3917. $deltat = $hash->{".updateTime"} - $oldt if(defined($oldt));
  3918. my $avgval= ($value + $oldvalue) / 2;
  3919. $result = ReadingsVal($name,$reading,$value);
  3920. if(defined($deltat) && $deltat>= 1.0) {
  3921. $result+= $avgval*$deltat;
  3922. }
  3923. }
  3924. } elsif($modifier eq "offset") {
  3925. $oldvalue = $value if( !defined($oldvalue) );
  3926. $result = ReadingsVal($name,$reading,0);
  3927. $result += $oldvalue if( $value < $oldvalue );
  3928. } elsif($modifier eq "monotonic") {
  3929. $oldvalue = $value if( !defined($oldvalue) );
  3930. $result = ReadingsVal($name,$reading,$value);
  3931. $result += $value - $oldvalue if( $value > $oldvalue );
  3932. }
  3933. readingsBulkUpdate($hash,$reading,$result,1) if(defined($result));
  3934. # store value
  3935. $userReading->{TIME}= $hash->{".updateTimestamp"};
  3936. $userReading->{t}= $hash->{".updateTime"};
  3937. $userReading->{value}= $value;
  3938. }
  3939. }
  3940. evalStateFormat($hash);
  3941. # turn off updating mode
  3942. delete $hash->{".updateTimestamp"};
  3943. delete $hash->{".updateTime"};
  3944. # propagate changes
  3945. if($dotrigger && $init_done) {
  3946. DoTrigger($name, undef, 0) if(!$readingsUpdateDelayTrigger);
  3947. } else {
  3948. if(!defined($hash->{INTRIGGER})) {
  3949. delete($hash->{CHANGED});
  3950. delete($hash->{CHANGEDWITHSTATE})
  3951. }
  3952. }
  3953. return undef;
  3954. }
  3955. sub
  3956. readingsBulkUpdateIfChanged($$$@) # Forum #58797
  3957. {
  3958. my ($hash,$reading,$value,$changed)= @_;
  3959. return undef if($value eq ReadingsVal($hash->{NAME},$reading,""));
  3960. return readingsBulkUpdate($hash,$reading,$value,$changed);
  3961. }
  3962. # Call readingsBulkUpdate to update the reading.
  3963. # Example: readingsUpdate($hash,"temperature",$value);
  3964. # Optional parameter $changed: if defined, and is 0, do not trigger events. If
  3965. # 1, trigger. If not defined, the name of the reading decides (starting with .
  3966. # is 0, else 1). The event-on-* filtering is done additionally.
  3967. #
  3968. sub
  3969. readingsBulkUpdate($$$@)
  3970. {
  3971. my ($hash,$reading,$value,$changed)= @_;
  3972. my $name= $hash->{NAME};
  3973. return if(!defined($reading) || !defined($value));
  3974. # sanity check
  3975. if(!defined($hash->{".updateTimestamp"})) {
  3976. Log 1, "readingsUpdate($name,$reading,$value) missed to call ".
  3977. "readingsBeginUpdate first.";
  3978. stacktrace();
  3979. return;
  3980. }
  3981. my $sp = AttrVal($name, "suppressReading", undef);
  3982. return if($sp && $reading =~ m/^$sp$/);
  3983. # shorthand
  3984. my $readings = $hash->{READINGS}{$reading};
  3985. if(!defined($changed)) {
  3986. $changed = (substr($reading,0,1) ne "."); # Dont trigger dot-readings
  3987. }
  3988. $changed = 0 if($hash->{".ignoreEvent"});
  3989. # if reading does not exist yet: fake entry to allow filtering
  3990. $readings = { VAL => "" } if( !defined($readings) );
  3991. my $update_timestamp = 1;
  3992. if($changed) {
  3993. # these flags determine if any of the "event-on" attributes are set
  3994. my $attreocr = $hash->{".attreocr"};
  3995. my $attreour = $hash->{".attreour"};
  3996. # determine whether the reading is listed in any of the attributes
  3997. my $eocr = $attreocr &&
  3998. ( my @eocrv = grep { my $l = $_; $l =~ s/:.*//;
  3999. ($reading=~ m/^$l$/) ? $_ : undef} @{$attreocr});
  4000. my $eour = $attreour && grep($reading =~ m/^$_$/, @{$attreour});
  4001. # check if threshold is given
  4002. my $eocrExists = $eocr;
  4003. if( $eocr
  4004. && $eocrv[0] =~ m/.*:(.*)/ ) {
  4005. my $threshold = $1;
  4006. if($value =~ m/([\d\.\-eE]+)/ && looks_like_number($1)) { #41083, #62190
  4007. my $mv = $1;
  4008. my $last_value = $hash->{".attreocr-threshold$reading"};
  4009. if( !defined($last_value) ) {
  4010. $hash->{".attreocr-threshold$reading"} = $mv;
  4011. } elsif( abs($mv - $last_value) < $threshold ) {
  4012. $eocr = 0;
  4013. } else {
  4014. $hash->{".attreocr-threshold$reading"} = $mv;
  4015. }
  4016. }
  4017. }
  4018. # determine if an event should be created:
  4019. # always create event if no attribute is set
  4020. # or if the reading is listed in event-on-update-reading
  4021. # or if the reading is listed in event-on-change-reading...
  4022. # ...and its value has changed...
  4023. # ...and the change greater then the threshold
  4024. $changed= !($attreocr || $attreour)
  4025. || $eour
  4026. || ($eocr && ($value ne $readings->{VAL}));
  4027. #Log 1, "EOCR:$eocr EOUR:$eour CHANGED:$changed";
  4028. my @v = grep { my $l = $_;
  4029. $l =~ s/:.*//;
  4030. ($reading=~ m/^$l$/) ? $_ : undef} @{$hash->{".attrminint"}};
  4031. if(@v) {
  4032. my (undef, $minInt) = split(":", $v[0]);
  4033. my $now = $hash->{".updateTime"};
  4034. my $le = $hash->{".lastTime$reading"};
  4035. if($le && $now-$le < $minInt) {
  4036. if(!$eocr || ($eocr && $value eq $readings->{VAL})){
  4037. $changed = 0;
  4038. } else {
  4039. $hash->{".lastTime$reading"} = $now;
  4040. }
  4041. } else {
  4042. $hash->{".lastTime$reading"} = $now;
  4043. $changed = 1 if($eocrExists);
  4044. }
  4045. }
  4046. if( $attreocr ) {
  4047. if( my $attrtocr = $hash->{".attrtocr"} ) {
  4048. $update_timestamp = $changed
  4049. if( $attrtocr && grep($reading =~ m/^$_$/, @{$attrtocr}) );
  4050. }
  4051. }
  4052. }
  4053. if($changed) {
  4054. #Debug "Processing $reading: $value";
  4055. my @v = grep { my $l = $_;
  4056. $l =~ s/:.*//;
  4057. ($reading=~ m/^$l$/) ? $_ : undef} @{$hash->{".attraggr"}};
  4058. if(@v) {
  4059. # e.g. power:20:linear:avg
  4060. my (undef,$duration,$method,$function,$holdTime) = split(":", $v[0], 5);
  4061. my $ts;
  4062. if(defined($readings->{".ts"})) {
  4063. $ts= $readings->{".ts"};
  4064. } else {
  4065. require "TimeSeries.pm";
  4066. $ts= TimeSeries->new( { method => $method,
  4067. autoreset => $duration,
  4068. holdTime => $holdTime } );
  4069. $readings->{".ts"}= $ts;
  4070. # access from command line:
  4071. # { $defs{"myClient"}{READINGS}{"myValue"}{".ts"}{max} }
  4072. #Debug "TimeSeries created.";
  4073. }
  4074. my $now = $hash->{".updateTime"};
  4075. my $val = $value; # save value
  4076. $changed = $ts->elapsed($now);
  4077. $value = $ts->{$function} if($changed);
  4078. $ts->add($now, $val);
  4079. } else {
  4080. # If no event-aggregator attribute, then remove stale series if any.
  4081. delete $readings->{".ts"};
  4082. }
  4083. }
  4084. setReadingsVal($hash, $reading, $value, $hash->{".updateTimestamp"})
  4085. if($update_timestamp);
  4086. my $rv = "$reading: $value";
  4087. if($changed) {
  4088. if($reading eq "state") {
  4089. $rv = $value;
  4090. $hash->{CHANGEDWITHSTATE} = [];
  4091. }
  4092. addEvent($hash, $rv);
  4093. }
  4094. return $rv;
  4095. }
  4096. #
  4097. # this is a shorthand call
  4098. #
  4099. sub
  4100. readingsSingleUpdate($$$$)
  4101. {
  4102. my ($hash,$reading,$value,$dotrigger)= @_;
  4103. readingsBeginUpdate($hash);
  4104. my $rv = readingsBulkUpdate($hash,$reading,$value);
  4105. readingsEndUpdate($hash,$dotrigger);
  4106. return $rv;
  4107. }
  4108. sub
  4109. readingsDelete($$)
  4110. {
  4111. my ($hash,$reading) = @_;
  4112. delete $hash->{READINGS}{$reading};
  4113. delete $hash->{OLDREADINGS}{$reading};
  4114. }
  4115. ##############################################################################
  4116. #
  4117. # date and time routines
  4118. #
  4119. ##############################################################################
  4120. sub
  4121. fhemTzOffset($)
  4122. {
  4123. # see http://stackoverflow.com/questions/2143528/whats-the-best-way-to-get-the-utc-offset-in-perl
  4124. my $t = shift;
  4125. my @l = localtime($t);
  4126. my @g = gmtime($t);
  4127. # the offset is positive if the local timezone is ahead of GMT, e.g. we get
  4128. # 2*3600 seconds for CET DST vs GMT
  4129. return 60*(($l[2] - $g[2] +
  4130. ((($l[5] << 9)|$l[7]) <=> (($g[5] << 9)|$g[7])) * 24)*60 +
  4131. $l[1] - $g[1]);
  4132. }
  4133. sub
  4134. fhemTimeGm($$$$$$)
  4135. {
  4136. # see http://de.wikipedia.org/wiki/Unixzeit
  4137. my ($sec,$min,$hour,$mday,$month,$year) = @_;
  4138. # $mday= 1..
  4139. # $month= 0..11
  4140. # $year is year-1900
  4141. $year += 1900;
  4142. my $isleapyear= $year % 4 ? 0 : $year % 100 ? 1 : $year % 400 ? 0 : 1;
  4143. # Forum #38610
  4144. my $leapyears_date = int(($year-1)/4) -int(($year-1)/100) +int(($year-1)/400);
  4145. my $leapyears_1970 = int((1970 -1)/4) -int((1970 -1)/100) +int((1970 -1)/400);
  4146. my $leapyears = $leapyears_date - $leapyears_1970;
  4147. if ( $^O eq 'MacOS' ) {
  4148. $year -= 1904;
  4149. } else {
  4150. $year -= 1970; # the Unix Epoch
  4151. }
  4152. my @d = (0,31,59,90,120,151,181,212,243,273,304,334); # no leap day
  4153. # add one day in leap years if month is later than February
  4154. $mday++ if($month>1 && $isleapyear);
  4155. return $sec+60*($min+60*($hour+24*
  4156. ($d[$month]+$mday-1+365*$year+$leapyears)));
  4157. }
  4158. sub
  4159. fhemTimeLocal($$$$$$) {
  4160. my $t= fhemTimeGm($_[0],$_[1],$_[2],$_[3],$_[4],$_[5]);
  4161. return $t-fhemTzOffset($t);
  4162. }
  4163. # compute the list of defined logical modules for a physical module
  4164. sub
  4165. computeClientArray($$)
  4166. {
  4167. my ($hash, $module) = @_;
  4168. my @a = ();
  4169. my @mRe = split(":", $hash->{Clients} ? $hash->{Clients}:$module->{Clients});
  4170. foreach my $m (sort { $modules{$a}{ORDER}.$a cmp $modules{$b}{ORDER}.$b }
  4171. grep { defined($modules{$_}{ORDER}) } keys %modules) {
  4172. foreach my $re (@mRe) {
  4173. if($m =~ m/^$re$/) {
  4174. push @a, $m if($modules{$m}{Match});
  4175. last;
  4176. }
  4177. }
  4178. }
  4179. $hash->{".clientArray"} = \@a;
  4180. return \@a;
  4181. }
  4182. # http://perldoc.perl.org/perluniintro.html, UNICODE IN OLDER PERLS
  4183. sub
  4184. latin1ToUtf8($)
  4185. {
  4186. my ($s)= @_;
  4187. $s =~ s/([\x80-\xFF])/chr(0xC0|ord($1)>>6).chr(0x80|ord($1)&0x3F)/eg;
  4188. return $s;
  4189. }
  4190. sub
  4191. utf8ToLatin1($)
  4192. {
  4193. my ($s)= @_;
  4194. $s =~ s/([\xC2\xC3])([\x80-\xBF])/chr(ord($1)<<6&0xC0|ord($2)&0x3F)/eg;
  4195. return $s;
  4196. }
  4197. # replaces some common control chars by escape sequences
  4198. # in order to make logs more readable
  4199. sub escapeLogLine($) {
  4200. my ($s)= @_;
  4201. # http://perldoc.perl.org/perlrebackslash.html
  4202. my %escSequences = (
  4203. '\a' => "\\a",
  4204. '\e' => "\\e",
  4205. '\f' => "\\f",
  4206. '\n' => "\\n",
  4207. '\r' => "\\r",
  4208. '\t' => "\\t",
  4209. );
  4210. $s =~ s/\\/\\\\/g;
  4211. foreach my $regex (keys %escSequences) {
  4212. $s =~ s/$regex/$escSequences{$regex}/g;
  4213. }
  4214. $s =~ s/([\000-\037])/sprintf("\\%03o", ord($1))/eg;
  4215. return $s;
  4216. }
  4217. sub
  4218. toJSON($)
  4219. {
  4220. my $val = shift;
  4221. if(not defined $val) {
  4222. return "null";
  4223. } elsif (not ref $val) {
  4224. $val =~ s/([\x00-\x1f\x22\x5c\x7f])/sprintf '\u%04x', ord($1)/ge;
  4225. return '"' . $val . '"';
  4226. } elsif (ref $val eq 'ARRAY') {
  4227. return '[' . join(',', map toJSON($_), @$val) . ']';
  4228. } elsif (ref $val eq 'HASH') {
  4229. return '{' . join(',',
  4230. map { toJSON($_).":".toJSON($val->{$_}) }
  4231. sort keys %$val) . '}';
  4232. } else {
  4233. return toJSON("toJSON: Cannot encode $val");
  4234. }
  4235. }
  4236. #############################
  4237. # will return a hash of name:value pairs.
  4238. # Note: doesnt know arrays, just objects and simple types
  4239. sub
  4240. json2nameValue($;$)
  4241. {
  4242. my ($in,$prefix) = @_;
  4243. $prefix = "" if(!defined($prefix));
  4244. my %ret;
  4245. sub
  4246. lStr($) # extract a string
  4247. {
  4248. my ($t) = @_;
  4249. my $esc;
  4250. for(my $off = 1; $off < length($t); $off++){
  4251. my $s = substr($t,$off,1);
  4252. if($s eq '\\') {
  4253. $esc = !$esc;
  4254. } elsif($s eq '"' && !$esc) {
  4255. return (substr($t,1,$off-1), substr($t,$off+1));
  4256. } else {
  4257. $esc = 0;
  4258. }
  4259. }
  4260. return ($t, "");
  4261. }
  4262. sub
  4263. lObj($$$) # extract one object: {} or []
  4264. {
  4265. my ($t, $oc, $cc) = @_;
  4266. my $depth=1;
  4267. my ($esc, $inquote);
  4268. for(my $off = 1; $off < length($t); $off++){
  4269. my $s = substr($t,$off,1);
  4270. if($s eq $cc && !$inquote) { # close character
  4271. $depth--;
  4272. return (substr($t,1,$off-1), substr($t,$off+1)) if(!$depth);
  4273. } elsif($s eq $oc && !$inquote) { # open character
  4274. $depth++;
  4275. } elsif($s eq '"' && !$esc) {
  4276. $inquote = !$inquote;
  4277. } elsif($s eq '\\') {
  4278. $esc = !$esc;
  4279. } else {
  4280. $esc = 0;
  4281. }
  4282. }
  4283. return ($t, ""); # error
  4284. }
  4285. sub eObj($$$$$);
  4286. sub
  4287. eObj($$$$$)
  4288. {
  4289. my ($ret,$name,$val,$in,$prefix) = @_;
  4290. if($val =~ m/^"/) {
  4291. ($val, $in) = lStr($val);
  4292. $val =~ s/\\u([0-9A-F]{4})/chr(hex($1))/gsie; # toJSON reverse
  4293. $ret->{"$prefix$name"} = $val;
  4294. } elsif($val =~ m/^{/) { # }
  4295. ($val, $in) = lObj($val, '{', '}');
  4296. my $r2 = json2nameValue($val);
  4297. foreach my $k (keys %{$r2}) {
  4298. $ret->{"$prefix${name}_$k"} = $r2->{$k};
  4299. }
  4300. } elsif($val =~ m/^\[/) {
  4301. ($val, $in) = lObj($val, '[', ']');
  4302. my $idx = 1;
  4303. $val =~ s/^\s*//;
  4304. while($val) {
  4305. $val = eObj($ret, $name."_$idx", $val, $val, $prefix);
  4306. $val =~ s/^\s*,\s*//;
  4307. $idx++
  4308. }
  4309. } elsif($val =~ m/^([0-9.-]+)(.*)$/s) {
  4310. $ret->{"$prefix$name"} = $1;
  4311. $in = $2;
  4312. } elsif($val =~ m/^(true|false)(.*)$/s) {
  4313. $ret->{"$prefix$name"} = $1;
  4314. $in = $2;
  4315. } else {
  4316. Log 1, "Error parsing $val";
  4317. $in = "";
  4318. }
  4319. return $in;
  4320. }
  4321. $in = $1 if($in =~ m/^{(.*)}$/s);
  4322. while($in =~ m/^\s*"([^"]+)"\s*:\s*(.*)$/s) {
  4323. my ($name,$val) = ($1,$2);
  4324. $name =~ s/[^a-z0-9._\-\/]/_/gsi;
  4325. $in = eObj(\%ret, $name, $val, $in, $prefix);
  4326. $in =~ s/^\s*,\s*//;
  4327. }
  4328. return \%ret;
  4329. }
  4330. # generate readings from the json string (parsed by json2reading) for $hash
  4331. sub
  4332. json2reading($$)
  4333. {
  4334. my ($hash, $json) = @_;
  4335. $hash = $defs{$hash} if(ref($hash) ne "HASH");
  4336. return "json2reading: first arg is not a FHEM device"
  4337. if(!$hash || ref $hash ne "HASH" || !$hash->{TYPE});
  4338. my $ret = json2nameValue($json);
  4339. if($ret && ref $ret eq "HASH") {
  4340. readingsBeginUpdate($hash);
  4341. foreach my $k (keys %{$ret}) {
  4342. readingsBulkUpdate($hash, $k, $ret->{$k});
  4343. }
  4344. readingsEndUpdate($hash, 1);
  4345. }
  4346. return undef;
  4347. }
  4348. sub
  4349. Debug($) {
  4350. my $msg= shift;
  4351. Log 1, "DEBUG>" . $msg;
  4352. }
  4353. sub
  4354. addToWritebuffer($$@)
  4355. {
  4356. my ($hash, $txt, $callback, $nolimit) = @_;
  4357. if($hash->{isChild}) { # Wont go to the main select in a forked process
  4358. TcpServer_WriteBlocking( $hash, $txt );
  4359. if($callback) {
  4360. no strict "refs";
  4361. my $ret = &{$callback}($hash);
  4362. use strict "refs";
  4363. }
  4364. return;
  4365. }
  4366. $hash->{WBCallback} = $callback;
  4367. if(!$hash->{$wbName}) {
  4368. $hash->{$wbName} = $txt;
  4369. } elsif($nolimit || length($hash->{$wbName}) < 102400) {
  4370. $hash->{$wbName} .= $txt;
  4371. } else {
  4372. return 0;
  4373. }
  4374. return 1; # success
  4375. }
  4376. sub
  4377. createNtfyHash()
  4378. {
  4379. Log 5, "createNotifyHash";
  4380. my @ntfyList = sort { $defs{$a}{NTFY_ORDER} cmp $defs{$b}{NTFY_ORDER} }
  4381. grep { $defs{$_}{NTFY_ORDER} &&
  4382. $defs{$_}{TYPE} &&
  4383. $modules{$defs{$_}{TYPE}}{NotifyFn} } keys %defs;
  4384. my %d2a_cache;
  4385. %ntfyHash = ("*" => []);
  4386. foreach my $d (@ntfyList) {
  4387. my $ndl = $defs{$d}{NOTIFYDEV};
  4388. next if(!$ndl);
  4389. my @ndlarr;
  4390. if($d2a_cache{$ndl}) {
  4391. @ndlarr = @{$d2a_cache{$ndl}};
  4392. } else {
  4393. @ndlarr = devspec2array($ndl);
  4394. if(@ndlarr > 1) {
  4395. my %h = map { $_ => 1 } @ndlarr;
  4396. @ndlarr = keys %h;
  4397. }
  4398. $d2a_cache{$ndl} = \@ndlarr;
  4399. }
  4400. map { $ntfyHash{$_} = [] } @ndlarr;
  4401. }
  4402. my @nhk = keys %ntfyHash;
  4403. foreach my $d (@ntfyList) {
  4404. my $ndl = $defs{$d}{NOTIFYDEV};
  4405. my $arr = ($ndl ? $d2a_cache{$ndl} : \@nhk);
  4406. map { push @{$ntfyHash{$_}}, $d } @{$arr};
  4407. }
  4408. }
  4409. sub
  4410. notifyRegexpChanged($$)
  4411. {
  4412. my ($hash, $re) = @_;
  4413. my @list2 = split(/\|/, $re);
  4414. my @list = grep { m/./ } # Forum #62369
  4415. map { (m/^\(?([A-Za-z0-9\.\_]+(?:\.[\+\*])?)(?::.*)?\)?$/ &&
  4416. ($defs{$1} || devspec2array($1) ne $1)) ? $1 : ""} @list2;
  4417. if(@list && int(@list) == int(@list2)) {
  4418. my %h = map { $_ => 1 } @list;
  4419. @list = keys %h; # remove duplicates
  4420. $hash->{NOTIFYDEV} = join(",", @list);
  4421. } else {
  4422. delete($hash->{NOTIFYDEV});
  4423. }
  4424. %ntfyHash = ();
  4425. }
  4426. sub
  4427. configDBUsed()
  4428. {
  4429. return ($attr{global}{configfile} eq 'configDB');
  4430. }
  4431. sub
  4432. FileRead($)
  4433. {
  4434. my ($param) = @_;
  4435. my ($err, @ret, $fileName, $forceType);
  4436. $forceType = "" if(!defined($forceType));
  4437. if(ref($param) eq "HASH") {
  4438. $fileName = $param->{FileName};
  4439. $forceType = lc($param->{ForceType});
  4440. } else {
  4441. $fileName = $param;
  4442. }
  4443. if(configDBUsed() && $forceType ne "file") {
  4444. ($err, @ret) = cfgDB_FileRead($fileName);
  4445. } else {
  4446. if(open(FH, $fileName)) {
  4447. @ret = <FH>;
  4448. close(FH);
  4449. chomp(@ret);
  4450. } else {
  4451. $err = "Can't open $fileName: $!";
  4452. }
  4453. }
  4454. return ($err, @ret);
  4455. }
  4456. sub
  4457. FileWrite($@)
  4458. {
  4459. my ($param, @rows) = @_;
  4460. my ($err, @ret, $fileName, $forceType, $nl);
  4461. if(ref($param) eq "HASH") {
  4462. $fileName = $param->{FileName};
  4463. $forceType = $param->{ForceType};
  4464. $nl = $param->{NoNL} ? "" : "\n";
  4465. } else {
  4466. $fileName = $param;
  4467. $nl = "\n";
  4468. }
  4469. $forceType = "" if(!defined($forceType));
  4470. if(configDBUsed() && $forceType ne "file") {
  4471. return cfgDB_FileWrite($fileName, @rows);
  4472. } else {
  4473. if(open(FH, ">$fileName")) {
  4474. binmode (FH);
  4475. foreach my $l (@rows) {
  4476. print FH $l,$nl;
  4477. }
  4478. close(FH);
  4479. return undef;
  4480. } else {
  4481. return "Can't open $fileName: $!";
  4482. }
  4483. }
  4484. }
  4485. sub
  4486. FileDelete($)
  4487. {
  4488. my ($param) = @_;
  4489. my ($fileName, $forceType);
  4490. if(ref($param) eq "HASH") {
  4491. $fileName = $param->{FileName};
  4492. $forceType = $param->{ForceType};
  4493. } else {
  4494. $fileName = $param;
  4495. }
  4496. $forceType //= '';
  4497. if(configDBUsed() && lc($forceType) ne "file") {
  4498. my $ret = _cfgDB_Filedelete($fileName);
  4499. return ($ret ? undef : "$fileName: _cfgDB_Filedelete failed");
  4500. } else {
  4501. my $ret = unlink($fileName);
  4502. return ($ret ? undef : "$fileName: $!");
  4503. }
  4504. }
  4505. sub
  4506. getUniqueId()
  4507. {
  4508. my ($err, $uniqueID) = getKeyValue("uniqueID");
  4509. return $uniqueID if(defined($uniqueID));
  4510. $uniqueID = createUniqueId();
  4511. setKeyValue("uniqueID", $uniqueID);
  4512. return $uniqueID;
  4513. }
  4514. my $srandUsed;
  4515. sub
  4516. createUniqueId()
  4517. {
  4518. my $uniqueID;
  4519. srand(gettimeofday()) if(!$srandUsed);
  4520. $srandUsed = 1;
  4521. $uniqueID = join "",map { unpack "H*", chr(rand(256)) } 1..16;
  4522. return $uniqueID;
  4523. }
  4524. sub
  4525. getKeyValue($)
  4526. {
  4527. my ($key) = @_;
  4528. my $fName = AttrVal("global", "keyFileName", "uniqueID");
  4529. $fName =~ s/\.\.//g;
  4530. $fName = $attr{global}{modpath}."/FHEM/FhemUtils/$fName";
  4531. my ($err, @l) = FileRead($fName);
  4532. return ($err, undef) if($err);
  4533. for my $l (@l) {
  4534. return (undef, $1) if($l =~ m/^$key:(.*)/);
  4535. }
  4536. return (undef, undef);
  4537. }
  4538. # Use an undefined value to delete the key
  4539. sub
  4540. setKeyValue($$)
  4541. {
  4542. my ($key,$value) = @_;
  4543. my $fName = AttrVal("global", "keyFileName", "uniqueID");
  4544. $fName =~ s/\.\.//g;
  4545. $fName = $attr{global}{modpath}."/FHEM/FhemUtils/$fName";
  4546. my ($err, @old) = FileRead($fName);
  4547. my @new;
  4548. if($err) {
  4549. push(@new, "# This file is auto generated.",
  4550. "# Please do not modify, move or delete it.",
  4551. "");
  4552. @old = ();
  4553. }
  4554. my $fnd;
  4555. foreach my $l (@old) {
  4556. if($l =~ m/^$key:/) {
  4557. $fnd = 1;
  4558. push @new, "$key:$value" if(defined($value));
  4559. } else {
  4560. push @new, $l;
  4561. }
  4562. }
  4563. push @new, "$key:$value" if(!$fnd && defined($value));
  4564. return FileWrite($fName, @new);
  4565. }
  4566. sub
  4567. addStructChange($$$)
  4568. {
  4569. return if(!$init_done);
  4570. my ($cmd, $dev, $param) = @_;
  4571. return if(!$defs{$dev} || $defs{$dev}{TEMPORARY});
  4572. $lastDefChange++;
  4573. return if($defs{$dev}{VOLATILE});
  4574. shift @structChangeHist if(@structChangeHist > 9);
  4575. $param = substr($param, 0, 40)."..." if(length($param) > 40);
  4576. push @structChangeHist, "$cmd $param";
  4577. }
  4578. sub
  4579. fhemFork()
  4580. {
  4581. my $pid = fork;
  4582. if(!defined($pid)) {
  4583. Log 1, "Cannot fork: $!";
  4584. stacktrace() if($attr{global}{stacktrace});
  4585. return undef;
  4586. }
  4587. return $pid if($pid);
  4588. # Child here
  4589. # Close FDs as we cannot restart FHEM if child keeps TCP Serverports open
  4590. foreach my $d (sort keys %defs) {
  4591. my $h = $defs{$d};
  4592. $h->{DBH}->{InactiveDestroy} = 1
  4593. if($h->{DBH} && $h->{TYPE} eq 'DbLog'); #Forum #43271
  4594. TcpServer_Close($h) if($h->{SERVERSOCKET});
  4595. if($h->{DeviceName}) {
  4596. require "$attr{global}{modpath}/FHEM/DevIo.pm";
  4597. DevIo_CloseDev($h,1);
  4598. }
  4599. }
  4600. $SIG{CHLD} = 'DEFAULT'; # Forum #50898
  4601. $fhemForked = 1;
  4602. return 0;
  4603. }
  4604. # Return the next element from the string (list) for each consecutive call.
  4605. # The index for the next call is stored in the device hash
  4606. sub
  4607. Each($$;$) # can be used e.g. in at, Forum #40022
  4608. {
  4609. my ($dev, $string, $sep) = @_;
  4610. return "" if(!$defs{$dev});
  4611. my $idx = ($defs{$dev}{EACH_INDEX} ? $defs{$dev}{EACH_INDEX} : 0);
  4612. $sep = "," if(!$sep);
  4613. my @arr = split($sep, $string);
  4614. $idx = 0 if(@arr <= $idx);
  4615. $defs{$dev}{EACH_INDEX} = $idx+1;
  4616. return $arr[$idx];
  4617. }
  4618. ##################
  4619. # Return 1 if Authorized, else 0
  4620. # Note: AuthorizeFn's returning 1 are not stackable.
  4621. sub
  4622. Authorized($$$)
  4623. {
  4624. my ($cl, $type, $arg) = @_;
  4625. return 1 if(!$init_done || !$cl || !$cl->{SNAME}); # Safeguarding
  4626. RefreshAuthList() if($auth_refresh);
  4627. my $sname = $cl->{SNAME};
  4628. my $verbose = AttrVal($sname, "verbose", 1); # Speedup?
  4629. foreach my $a (@authorize) {
  4630. my $r = CallFn($a, "AuthorizeFn", $defs{$a}, $cl, $type, $arg);
  4631. if($verbose >= 4) {
  4632. Log3 $sname, 4, "authorize $sname/$type/$arg: $a returned ".
  4633. ($r == 0 ? "dont care" : $r == 1 ? "allowed" : "prohibited");
  4634. }
  4635. return 1 if($r == 1);
  4636. return 0 if($r == 2);
  4637. }
  4638. return 1;
  4639. }
  4640. ##################
  4641. # Return 0 if not needed, 1 if authenticated, 2 if authentication failed
  4642. # Loop until one Authenticate is ok
  4643. sub
  4644. Authenticate($$)
  4645. {
  4646. my ($cl, $arg) = @_;
  4647. return 1 if(!$init_done || !$cl || !$cl->{SNAME}); # Safeguarding
  4648. RefreshAuthList() if($auth_refresh);
  4649. my $needed = 0;
  4650. foreach my $a (@authenticate) {
  4651. my $r = CallFn($a, "AuthenticateFn", $defs{$a}, $cl, $arg);
  4652. $needed = $r if($r);
  4653. return $r if($r == 1);
  4654. }
  4655. return $needed;
  4656. }
  4657. #####################################
  4658. sub
  4659. RefreshAuthList()
  4660. {
  4661. @authorize = ();
  4662. @authenticate = ();
  4663. foreach my $d (sort keys %defs) {
  4664. my $h = $defs{$d};
  4665. next if(!$h->{TYPE} || !$modules{$h->{TYPE}});
  4666. push @authorize, $d if($modules{$h->{TYPE}}{AuthorizeFn});
  4667. push @authenticate, $d if($modules{$h->{TYPE}}{AuthenticateFn});
  4668. }
  4669. $auth_refresh = 0;
  4670. }
  4671. #####################################
  4672. sub
  4673. perlSyntaxCheck($%)
  4674. {
  4675. my ($exec, %specials)= @_;
  4676. my $psc = AttrVal("global", "perlSyntaxCheck", ($featurelevel>5.7) ? 1 : 0);
  4677. return undef if(!$psc || !$init_done);
  4678. my ($arr, $hash) = parseParams($exec, ';');
  4679. $arr = [ $exec ] if(!@$arr); # temporary bugfix
  4680. for my $cmd (@{$arr}) {
  4681. next if($cmd !~ m/^\s*{/); # } for match
  4682. $specials{__UNIQUECMD__}=1;
  4683. $cmd = EvalSpecials("{return undef; $cmd}", %specials);
  4684. my $r = AnalyzePerlCommand(undef, $cmd);
  4685. return $r if($r);
  4686. }
  4687. return undef;
  4688. }
  4689. #####################################
  4690. sub
  4691. parseParams($;$$$)
  4692. {
  4693. my($cmd, $separator, $joiner, $keyvalueseparator) = @_;
  4694. $separator = ' ' if(!$separator);
  4695. $joiner = $separator if(!$joiner); # needed if separator is a regexp
  4696. $keyvalueseparator = '=' if(!$keyvalueseparator);
  4697. my(@a, %h);
  4698. my @params;
  4699. if( ref($cmd) eq 'ARRAY' ) {
  4700. @params = @{$cmd};
  4701. } else {
  4702. @params = split($separator, $cmd);
  4703. }
  4704. while (@params) {
  4705. my $param = shift(@params);
  4706. next if($param eq "");
  4707. my ($key, $value) = split( $keyvalueseparator, $param, 2 );
  4708. if( !defined( $value ) ) {
  4709. $value = $key;
  4710. $key = undef;
  4711. # the key can not start with a { -> it must be a perl expression # vim:}
  4712. } elsif( $key =~ m/^\s*{/ ) { # for vim: }
  4713. $value = $param;
  4714. $key = undef;
  4715. }
  4716. #collect all parts until the closing ' or "
  4717. while( $param && $value =~ m/^('|")/ && $value !~ m/$1$/ ) {
  4718. my $next = shift(@params);
  4719. last if( !defined($next) );
  4720. $value .= $joiner . $next;
  4721. }
  4722. #remove matching ' or " from the start and end
  4723. if( $value =~ m/^('|")/ && $value =~ m/$1$/ ) {
  4724. $value =~ s/^.(.*).$/$1/;
  4725. }
  4726. #collect all parts until opening { and closing } are matched
  4727. if( $value =~ m/^\s*{/ ) { # } for match
  4728. my $count = 0;
  4729. for my $i (0..length($value)-1) {
  4730. my $c = substr($value, $i, 1);
  4731. ++$count if( $c eq '{' );
  4732. --$count if( $c eq '}' );
  4733. }
  4734. while( $param && $count != 0 ) {
  4735. my $next = shift(@params);
  4736. last if( !defined($next) );
  4737. $value .= $joiner . $next;
  4738. for my $i (0..length($next)-1) {
  4739. my $c = substr($next, $i, 1);
  4740. ++$count if( $c eq '{' );
  4741. --$count if( $c eq '}' );
  4742. }
  4743. }
  4744. }
  4745. if( defined($key) ) {
  4746. $h{$key} = $value;
  4747. } else {
  4748. push @a, $value;
  4749. }
  4750. }
  4751. return(\@a, \%h);
  4752. }
  4753. # get "Porbably Associated With" list for a devicename
  4754. sub
  4755. getPawList($)
  4756. {
  4757. my ($d) = @_;
  4758. my $h = $defs{$d};
  4759. my @dob;
  4760. foreach my $dn (sort keys %defs) {
  4761. next if(!$dn || $dn eq $d);
  4762. my $dh = $defs{$dn};
  4763. if(($dh->{DEF} && $dh->{DEF} =~ m/\b$d\b/) ||
  4764. ($h->{DEF} && $h->{DEF} =~ m/\b$dn\b/)) {
  4765. push(@dob, $dn);
  4766. }
  4767. }
  4768. return @dob;
  4769. }
  4770. sub
  4771. goodDeviceName($)
  4772. {
  4773. my ($name) = @_;
  4774. return ($name && $name =~ m/^[a-z0-9._]*$/i);
  4775. }
  4776. sub
  4777. makeDeviceName($) # Convert non-valid characters to _
  4778. {
  4779. my ($name) = @_;
  4780. $name = "UNDEFINED" if(!defined($name));
  4781. $name =~ s/[^a-z0-9._]/_/gi;
  4782. return $name;
  4783. }
  4784. sub
  4785. goodReadingName($)
  4786. {
  4787. my ($name) = @_;
  4788. return ($name && ($name =~ m/^[a-z0-9._\-\/]+$/i || $name =~ m/^\./));
  4789. }
  4790. sub
  4791. makeReadingName($) # Convert non-valid characters to _
  4792. {
  4793. my ($name) = @_;
  4794. $name = "UNDEFINED" if(!defined($name));
  4795. return $name if($name =~ m/^\./);
  4796. $name =~ s/[^a-z0-9._\-\/]/_/gi;
  4797. return $name;
  4798. }
  4799. sub
  4800. computeAlignTime($$@)
  4801. {
  4802. my ($timeSpec, $alignSpec, $triggertime) = @_; # triggertime is now if absent
  4803. my ($alErr, $alHr, $alMin, $alSec, undef) = GetTimeSpec($alignSpec);
  4804. return ("alignTime: $alErr", undef) if($alErr);
  4805. my ($tmErr, $hr, $min, $sec, undef) = GetTimeSpec($timeSpec);
  4806. return ("timeSpec: $tmErr", undef) if($alErr);
  4807. my $now = int(gettimeofday());
  4808. my $alTime = ($alHr*60+$alMin)*60+$alSec-fhemTzOffset($now);
  4809. my $step = ($hr*60+$min)*60+$sec;
  4810. my $ttime = ($triggertime ? int($triggertime) : $now);
  4811. my $off = ($ttime % 86400) - 86400;
  4812. while($off < $alTime) {
  4813. $off += $step;
  4814. }
  4815. $ttime += ($alTime-$off);
  4816. $ttime += $step if($ttime < $now);
  4817. return (undef, $ttime);
  4818. }
  4819. ############################
  4820. my %restoreDir_dirs;
  4821. sub
  4822. restoreDir_mkDir($$$)
  4823. {
  4824. my ($root, $dir, $isFile) = @_;
  4825. if($isFile) { # Delete the file Component
  4826. $dir =~ m,^(.*)/([^/]*)$,;
  4827. $dir = $1;
  4828. }
  4829. return if($restoreDir_dirs{$dir});
  4830. $restoreDir_dirs{$dir} = 1;
  4831. my @p = split("/", $dir);
  4832. for(my $i = 0; $i < int(@p); $i++) {
  4833. my $path = "$root/".join("/", @p[0..$i]);
  4834. if(!-d $path) {
  4835. mkdir $path;
  4836. Log 4, "MKDIR $root/".join("/", @p[0..$i]);
  4837. }
  4838. }
  4839. }
  4840. sub
  4841. restoreDir_rmTree($)
  4842. {
  4843. my ($dir) = @_;
  4844. my $dh;
  4845. if(!opendir($dh, $dir)) {
  4846. Log 1, "opendir $dir: $!";
  4847. return;
  4848. }
  4849. my @files = grep { $_ ne "." && $_ ne ".." } readdir($dh);
  4850. closedir($dh);
  4851. foreach my $f (@files) {
  4852. if(-d "$dir/$f") {
  4853. restoreDir_rmTree("$dir/$f");
  4854. } else {
  4855. Log 4, "rm $dir/$f";
  4856. if(!unlink("$dir/$f")) {
  4857. Log 1, "rm $dir/$f failed: $!";
  4858. }
  4859. }
  4860. }
  4861. Log 4, "rmdir $dir";
  4862. if(!rmdir($dir)) {
  4863. Log 1, "rmdir $dir failed: $!";
  4864. }
  4865. }
  4866. sub
  4867. restoreDir_init(;$)
  4868. {
  4869. my ($subDir) = @_;
  4870. my $root = $attr{global}{modpath};
  4871. my $nDirs = AttrVal("global","restoreDirs", 3);
  4872. if($nDirs !~ m/^\d+$/ || $nDirs < 0) {
  4873. Log 1, "invalid restoreDirs value $nDirs, setting it to 3";
  4874. $nDirs = 3;
  4875. }
  4876. return "" if($nDirs == 0);
  4877. my $rdName = "restoreDir";
  4878. $rdName .= "/$subDir" if($subDir);
  4879. my @t = localtime(gettimeofday());
  4880. my $restoreDir = sprintf("$rdName/%04d-%02d-%02d",
  4881. $t[5]+1900, $t[4]+1, $t[3]);
  4882. Log 1, "MKDIR $restoreDir" if(! -d "$root/restoreDir");
  4883. restoreDir_mkDir($root, $restoreDir, 0);
  4884. if(!opendir(DH, "$root/$rdName")) {
  4885. Log 1, "opendir $root/$rdName: $!";
  4886. return "";
  4887. }
  4888. my @oldDirs = sort grep { $_ =~ m/^20\d\d-\d\d-\d\d/ } readdir(DH);
  4889. closedir(DH);
  4890. while(int(@oldDirs) > $nDirs) {
  4891. my $dir = "$root/$rdName/". shift(@oldDirs);
  4892. next if($dir =~ m/$restoreDir/); # Just in case
  4893. Log 1, "RMDIR: $dir";
  4894. restoreDir_rmTree($dir);
  4895. }
  4896. return $restoreDir;
  4897. }
  4898. sub
  4899. restoreDir_saveFile($$)
  4900. {
  4901. my($restoreDir, $fName) = @_;
  4902. return if(!$restoreDir || !$fName);
  4903. my $root = $attr{global}{modpath};
  4904. restoreDir_mkDir($root, "$restoreDir/$fName", 1);
  4905. if(!copy($fName, "$root/$restoreDir/$fName")) {
  4906. log 1, "copy $fName $root/$restoreDir/$fName failed:$!";
  4907. }
  4908. }
  4909. sub
  4910. SecurityCheck()
  4911. {
  4912. return if(AttrVal("global", "motd", "") eq "none");
  4913. my @fnd;
  4914. foreach my $sdev (keys %defs) {
  4915. next if($defs{$sdev}{TEMPORARY});
  4916. my $type = $defs{$sdev}{TYPE};
  4917. next if(!$modules{$type}{CanAuthenticate});
  4918. my $hash = { SNAME=>$sdev, TYPE=>$type, NAME=>"SecurityCheck"};
  4919. push(@fnd, " $sdev is not password protected")
  4920. if(!Authenticate($hash, undef));
  4921. }
  4922. if(@fnd) {
  4923. push @fnd, "";
  4924. my @l = devspec2array("TYPE=allowed");
  4925. if(@l) {
  4926. push @fnd, "Protect this FHEM installation by ".
  4927. "configuring the allowed device $l[0]";
  4928. } else {
  4929. push @fnd, "Protect this FHEM installation by ".
  4930. "defining an allowed device with define allowed allowed";
  4931. }
  4932. }
  4933. if($^O !~ m/Win/ && $<==0) {
  4934. push(@fnd, "Running with root privileges is discouraged.")
  4935. }
  4936. if(@fnd) {
  4937. unshift(@fnd, "SecurityCheck:");
  4938. push(@fnd, "You can disable this message with attr global motd none");
  4939. $attr{global}{motd} = join("\n", @fnd);
  4940. } elsif(AttrVal('global','motd','') =~ m/^SecurityCheck/) {
  4941. delete $attr{global}{motd};
  4942. }
  4943. }
  4944. 1;