From 2bf4b7c60e475cb8b0e91a1d1c9793f7e94dc0a9 Mon Sep 17 00:00:00 2001
From: Norbert Richter <norbert.richter@prsolution.eu>
Date: Fri, 4 Jan 2019 10:24:46 +0100
Subject: [PATCH] decode-config.py: adapt settings, fix warning

- add SetOption55 (mdns_enabled)
- fix string warning
- change file handling
---
 tools/decode-config.py | 120 ++++++++++++++++++-----------------------
 1 file changed, 52 insertions(+), 68 deletions(-)

diff --git a/tools/decode-config.py b/tools/decode-config.py
index 52cb63673..7816ff728 100755
--- a/tools/decode-config.py
+++ b/tools/decode-config.py
@@ -1,11 +1,11 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
-VER = '2.1.0015'
+VER = '2.1.0016'
 
 """
     decode-config.py - Backup/Restore Sonoff-Tasmota configuration data
 
-    Copyright (C) 2019 Norbert Richter <nr@prsolution.eu>
+    Copyright (C) 2018 Norbert Richter <nr@prsolution.eu>
 
     This program is free software: you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -814,7 +814,13 @@ Setting_6_3_0_16['flag3'][0].update ({
 Setting_6_4_0_2 = copy.deepcopy(Setting_6_3_0_16)
 Setting_6_4_0_2['flag3'][0].pop('hass_short_discovery_msg',None)
 # ======================================================================
+Setting_6_4_1_4 = copy.deepcopy(Setting_6_4_0_2)
+Setting_6_4_1_4['flag3'][0].update ({
+        'mdns_enabled':             ('<L', (0x3A0,1, 5), (None, None,                           ('SetOption',   '"SetOption55 {}".format($)')) ),
+                                    })
+# ======================================================================
 Settings = [
+            (0x6040104, 0xe00, Setting_6_4_1_4),
             (0x6040002, 0xe00, Setting_6_4_0_2),
             (0x6030010, 0xe00, Setting_6_3_0_16),
             (0x603000F, 0xe00, Setting_6_3_0_15),
@@ -1072,47 +1078,40 @@ def GetFileType(filename):
     try:
         isfile = os.path.isfile(filename)
         try:
-            f = open(filename, "r")
-            try:
-                # try reading as json
-                inputjson = json.load(f)
-                if 'header' in inputjson:
-                    filetype = FileType.JSON
-                else:
-                    filetype = FileType.INCOMPLETE_JSON
-            except ValueError:
-                filetype = FileType.INVALID_JSON
-                # not a valid json, get filesize and compare it with all possible sizes
+            with open(filename, "r") as f:
                 try:
-                    size = os.path.getsize(filename)
-                except:
-                    filetype = FileType.UNKNOWN
-                sizes = GetTemplateSizes()
-
-                # size is one of a dmp file size
-                if size in sizes:
-                    filetype = FileType.DMP
-                elif (size - ((len(hex(BINARYFILE_MAGIC))-2)/2)) in sizes:
-                    # check if the binary file has the magic header
+                    # try reading as json
+                    inputjson = json.load(f)
+                    if 'header' in inputjson:
+                        filetype = FileType.JSON
+                    else:
+                        filetype = FileType.INCOMPLETE_JSON
+                except ValueError:
+                    filetype = FileType.INVALID_JSON
+                    # not a valid json, get filesize and compare it with all possible sizes
                     try:
-                        inputfile = open(filename, "rb")
-                        inputbin = inputfile.read()
-                        inputfile.close()
+                        size = os.path.getsize(filename)
+                    except:
+                        filetype = FileType.UNKNOWN
+                    sizes = GetTemplateSizes()
+
+                    # size is one of a dmp file size
+                    if size in sizes:
+                        filetype = FileType.DMP
+                    elif (size - ((len(hex(BINARYFILE_MAGIC))-2)/2)) in sizes:
+                        # check if the binary file has the magic header
+                        with open(filename, "rb") as inputfile:
+                            inputbin = inputfile.read()
                         if struct.unpack_from('<L', inputbin, 0)[0] == BINARYFILE_MAGIC:
                             filetype = FileType.BIN
                         else:
                             filetype = FileType.INVALID_BIN
-
-                    except:
-                        pass
-                # ~ else:
-                    # ~ filetype = FileType.UNKNOWN
-            finally:
-                f.close()
         except:
             filetype = FileType.FILE_NOT_FOUND
+            pass
     except:
         filetype = FileType.FILE_NOT_FOUND
+        pass
 
     return filetype
 
@@ -1260,9 +1259,8 @@ def LoadTasmotaConfig(filename):
     if not os.path.isfile(filename):    # check file exists
         exit(ExitCode.FILE_NOT_FOUND, "File '{}' not found".format(filename),line=inspect.getlineno(inspect.currentframe()))
     try:
-        tasmotafile = open(filename, "rb")
-        encode_cfg = tasmotafile.read()
-        tasmotafile.close()
+        with open(filename, "rb") as tasmotafile:
+            encode_cfg = tasmotafile.read()
     except Exception, e:
         exit(e[0], "'{}' {}".format(filename, e[1]),line=inspect.getlineno(inspect.currentframe()))
 
@@ -2083,9 +2081,8 @@ def SetField(dobj, fieldname, fielddef, restore, addroffset=0, filename=""):
             value = ReadWriteConverter(restore.encode(STR_ENCODING), fielddef, read=False)
             err = "string length exceeding"
             if value is not None:
-                # be aware 0 byte at end of string (str must be < max, not <= max)
                 _max -= 1
-                valid = _min <= len(value) < _max
+                valid = _min <= len(value) <= _max
             else:
                 skip = True
                 valid = True
@@ -2389,12 +2386,10 @@ def Backup(backupfile, backupfileformat, encode_cfg, decode_cfg, configmapping):
         if args.verbose:
             message("Writing backup file '{}' ({} format)".format(backup_filename, fileformat), typ=LogType.INFO)
         try:
-            backupfp = open(backup_filename, "wb")
-            backupfp.write(encode_cfg)
+            with open(backup_filename, "wb") as backupfp:
+                backupfp.write(encode_cfg)
         except Exception, e:
             exit(e[0], "'{}' {}".format(backup_filename, e[1]),line=inspect.getlineno(inspect.currentframe()))
-        finally:
-            backupfp.close()
 
     # binary format
     elif backupfileformat.lower() == FileType.BIN.lower():
@@ -2403,14 +2398,11 @@ def Backup(backupfile, backupfileformat, encode_cfg, decode_cfg, configmapping):
         if args.verbose:
             message("Writing backup file '{}' ({} format)".format(backup_filename, fileformat), typ=LogType.INFO)
         try:
-            backupfp = open(backup_filename, "wb")
-            magic = BINARYFILE_MAGIC
-            backupfp.write(struct.pack('<L',magic))
-            backupfp.write(decode_cfg)
+            with open(backup_filename, "wb") as backupfp:
+                backupfp.write(struct.pack('<L',BINARYFILE_MAGIC))
+                backupfp.write(decode_cfg)
         except Exception, e:
             exit(e[0], "'{}' {}".format(backup_filename, e[1]),line=inspect.getlineno(inspect.currentframe()))
-        finally:
-            backupfp.close()
 
     # JSON format
     elif backupfileformat.lower() == FileType.JSON.lower():
@@ -2419,12 +2411,10 @@ def Backup(backupfile, backupfileformat, encode_cfg, decode_cfg, configmapping):
         if args.verbose:
             message("Writing backup file '{}' ({} format)".format(backup_filename, fileformat), typ=LogType.INFO)
         try:
-            backupfp = open(backup_filename, "w")
-            json.dump(configmapping, backupfp, sort_keys=args.jsonsort, indent=None if args.jsonindent < 0 else args.jsonindent, separators=(',', ':') if args.jsoncompact else (', ', ': ') )
+            with open(backup_filename, "w") as backupfp:
+                json.dump(configmapping, backupfp, sort_keys=args.jsonsort, indent=None if args.jsonindent < 0 else args.jsonindent, separators=(',', ':') if args.jsoncompact else (', ', ': ') )
         except Exception, e:
             exit(e[0], "'{}' {}".format(backup_filename, e[1]),line=inspect.getlineno(inspect.currentframe()))
-        finally:
-            backupfp.close()
 
     if args.verbose:
         srctype = 'device'
@@ -2465,9 +2455,8 @@ def Restore(restorefile, backupfileformat, encode_cfg, decode_cfg, configmapping
         if args.verbose:
             message("Reading restore file '{}' (Tasmota format)".format(restorefilename), typ=LogType.INFO)
         try:
-            restorefp = open(restorefilename, "rb")
-            new_encode_cfg = restorefp.read()
-            restorefp.close()
+            with open(restorefilename, "rb") as restorefp:
+                new_encode_cfg = restorefp.read()
         except Exception, e:
             exit(e[0], "'{}' {}".format(restorefilename, e[1]),line=inspect.getlineno(inspect.currentframe()))
 
@@ -2475,9 +2464,8 @@ def Restore(restorefile, backupfileformat, encode_cfg, decode_cfg, configmapping
         if args.verbose:
             message("Reading restore file '{}' (binary format)".format(restorefilename), typ=LogType.INFO)
         try:
-            restorefp = open(restorefilename, "rb")
-            restorebin = restorefp.read()
-            restorefp.close()
+            with open(restorefilename, "rb") as restorefp:
+                restorebin = restorefp.read()
         except Exception, e:
             exit(e[0], "'{}' {}".format(restorefilename, e[1]),line=inspect.getlineno(inspect.currentframe()))
         header = struct.unpack_from('<L', restorebin, 0)[0]
@@ -2489,12 +2477,10 @@ def Restore(restorefile, backupfileformat, encode_cfg, decode_cfg, configmapping
         if args.verbose:
             message("Reading restore file '{}' (JSON format)".format(restorefilename), typ=LogType.INFO)
         try:
-            restorefp = open(restorefilename, "r")
-            jsonconfig = json.load(restorefp)
+            with open(restorefilename, "r") as restorefp:
+                jsonconfig = json.load(restorefp)
         except ValueError as e:
             exit(ExitCode.JSON_READ_ERROR, "File '{}' invalid JSON: {}".format(restorefilename, e), line=inspect.getlineno(inspect.currentframe()))
-        finally:
-            restorefp.close()
         # process json config to binary config
         new_decode_cfg = Mapping2Bin(decode_cfg, jsonconfig, restorefilename)
         new_encode_cfg = DecryptEncrypt(new_decode_cfg)
@@ -2526,14 +2512,12 @@ def Restore(restorefile, backupfileformat, encode_cfg, decode_cfg, configmapping
                 if args.verbose:
                     message("Write new data to file '{}' using restore file '{}'".format(args.tasmotafile, restorefilename), typ=LogType.INFO)
                 try:
-                    outputfile = open(args.tasmotafile, "wb")
-                    outputfile.write(new_encode_cfg)
+                    with open(args.tasmotafile, "wb") as outputfile:
+                        outputfile.write(new_encode_cfg)
                 except Exception, e:
                     exit(e[0], "'{}' {}".format(args.tasmotafile, e[1]),line=inspect.getlineno(inspect.currentframe()))
-                finally:
-                    outputfile.close()
-                    if args.verbose:
-                        message("Restore successful to file '{}' using restore file '{}'".format(args.tasmotafile, restorefilename), typ=LogType.INFO)
+                if args.verbose:
+                    message("Restore successful to file '{}' using restore file '{}'".format(args.tasmotafile, restorefilename), typ=LogType.INFO)
 
         else:
             global exitcode