fhem.pl 127 KB

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