fhem.pl 138 KB

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