fhem.pl 142 KB

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