Merge pull request #5 from psmode/TL-SG1024DE-support

Adding TL-SG1024DE support to address #4

Author: psmode

CHANGELOG.md

@@ -1,17 +1,26 @@
 # Change Log
 All notable changes to this project will be documented in this file.
- 
+
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
- 
+
+
+## [0.5.0] - 2021-04-25
+
+### Addeded
+ - [essstat.py] Added propper support for TL-SG1024DE model as per Issue #4.
+Many thanks to @FreedThx for his report and for providing the output from
+that model that enabled the devlopment of this code change.
+
+
 ## [0.4.1] - 2021-04-03
 
 ### Fixed
 
 - [essstat.xlsm] Dynamic rescaling of X-axis labels and tickmarks
-- [essstat.py] Fix for Issue #3 reported by jan-lukes, AttributeError: 'NoneType' 
+- [essstat.py] Fix for Issue #3 reported by jan-lukes, AttributeError: 'NoneType'
 object has no attribute 'group'. The problem was a code compatibility issue
-with newer versions of BeautifulSoup sometime after version 4.8.2. Changing 
+with newer versions of BeautifulSoup sometime after version 4.8.2. Changing
 references to soup.script.text to soup.script.string fixes the problem and
 is backwards compatible, at least to beautifulsoup4-4.8.2.
 
@@ -23,10 +32,10 @@ is backwards compatible, at least to beautifulsoup4-4.8.2.
 - [essstat.xlsm] Macro-enabled Excel workbook will automatically construct 
 a query and execute a web GET operation against the monitoring server using 
 the `essstat2.cgi` script. It uses the returned data to plot charts of the
-port statistics using dynaic chart ranges. 
+port statistics using dynaic chart ranges.
 - [essstat2.cgi] This CGI script is designed to support operation of the essstat.xlsm
-Excel workbook. This script will return the average packets per second rate since 
-the previous record. 
+Excel workbook. This script will return the average packets per second rate since
+the previous record.
 
 
 ## [0.3.2] - 2020-03-30
@@ -40,7 +49,7 @@ the previous record.
  statistics.
 
 ### Changed
- - [essstat.py] Modified --1line output to use only numeric codes for 
+ - [essstat.py] Modified --1line output to use only numeric codes for
  port state and link status. This is a preferred approach since it will use
  much less disk space when accumulating in a CSV file.
 

essstat.py

@@ -1,35 +1,35 @@
 #!/usr/bin/env python3
 # coding: utf-8
 
-# In[ ]:
+# In[1]:
 
 
 __author__ = "Peter Smode"
 __copyright__ = "Copyright 2021, Peter Smode"
 __credits__ = "Peter Smode"
 __license__ = "GPL 3.0"
-__version__ = "0.4.1"
+__version__ = "0.5.0"
 __maintainer__ = "Peter Smode"
 __email__ = "psmode@kitsnet.us"
 __status__ = "Beta"
 
 
-# In[3]:
+# In[2]:
 
 
 import argparse, pprint, re, requests, sys
 from datetime import datetime
 from bs4 import BeautifulSoup
 
 
-# In[4]:
+# In[3]:
 
 
 TPlinkStatus = {'0': "Link Down", '1': "LS 1", '2': "10M Half", '3': "10M Full", '4': "LS 4", '5': "100M Full", '6': "1000M Full"}
 TPstate = {'0': 'Disabled', '1': 'Enabled'}
 
 
-# In[5]:
+# In[4]:
 
 
 def isnotebook():
@@ -45,7 +45,7 @@ def isnotebook():
         return False      # Probably standard Python interpreter
 
 
-# In[6]:
+# In[5]:
 
 
 if not isnotebook():
@@ -66,7 +66,7 @@ def isnotebook():
     TPLdebug = args['debug']
 
 
-# In[7]:
+# In[6]:
 
 
 if isnotebook():
@@ -78,7 +78,7 @@ def isnotebook():
     TPLdebug = True
 
 
-# In[8]:
+# In[7]:
 
 
 if TPLdebug:
@@ -87,13 +87,13 @@ def isnotebook():
     print(BASE_URL)
 
 
-# In[87]:
+# In[8]:
 
 
 s = requests.Session()
 
 
-# In[88]:
+# In[9]:
 
 
 data = {"logon": "Login", "username": TPLuser, "password": TPLpswd}
@@ -106,7 +106,7 @@ def isnotebook():
        sys.exit("ERROR: General error at login: "+str(err))
 
 
-# In[90]:
+# In[10]:
 
 
 headers = {'Referer': f'{BASE_URL}/',
@@ -115,79 +115,112 @@ def isnotebook():
 r = s.get(f'{BASE_URL}/PortStatisticsRpm.htm', headers=headers, timeout=6)
 
 
-# In[91]:
+# In[11]:
 
 
 soup = BeautifulSoup(r.text, 'html.parser')
 if TPLdebug:
+    from bs4 import __version__ as bs4__version__
+    print("BeautifulSoup4 version: " + bs4__version__)
     print(r)
 
 
-# In[92]:
+# In[12]:
 
 
+convoluted = (soup.script == soup.head.script)     #TL-SG1016DE and TL-SG108E models have a script before the HEAD block
 if TPLdebug:
-    pprint.pprint(soup.script)
+    pprint.pprint(convoluted)
 
 
-# In[93]:
+# In[13]:
+
+
+if TPLdebug:
+    if convoluted:
+        # This is the 24 port TL-SG1024DE model with the stats in a different place (and convoluted coding)
+        pprint.pprint(soup.head.find_all("script"))
+        pprint.pprint(soup.body.script)
+    else:
+        # This should be a TL-SG1016DE or a TL-SG108E
+        pprint.pprint(soup.script)
+
+
+# In[14]:
 
 
 if str(r) != "<Response [200]>":
     sys.exit("ERROR: Login failure - bad credential?")
 
 
-# In[94]:
+# In[15]:
+
 
 pattern = re.compile(r"var (max_port_num) = (.*?);$", re.MULTILINE)
 
 
-# In[95]:
+# In[16]:
 
 
 if TPLdebug:
-    print(pattern.search(soup.script.string).group(0))
-    print(pattern.search(soup.script.string).group(1))
-    print(pattern.search(soup.script.string).group(2))
+    if convoluted:
+        print(pattern.search(str(soup.head.find_all("script"))).group(0))
+        print(pattern.search(str(soup.head.find_all("script"))).group(1))
+        print(pattern.search(str(soup.head.find_all("script"))).group(2))
+    else:
+        print(pattern.search(str(soup.script)).group(0))
+        print(pattern.search(str(soup.script)).group(1))
+        print(pattern.search(str(soup.script)).group(2))
 
 
-# In[117]:
+# In[17]:
 
 
 current_dt = datetime.now().strftime("%Y-%m-%d %H:%M:%S")
-max_port_num = int(pattern.search(soup.script.string).group(2))
+if convoluted:
+    max_port_num = int(pattern.search(str(soup.head.find_all("script"))).group(2))
+else:
+    max_port_num = int(pattern.search(str(soup.script)).group(2))
 if not (TPLstatsonly or TPL1line):
    print(current_dt)
    print("max_port_num={0:d}".format(max_port_num))
 
 
-# In[97]:
+# In[18]:
 
 
-pattern2 = re.compile(r"var all_info = {\n?(.*?)\n?};$", re.MULTILINE | re.DOTALL)
+if convoluted:
+    i1 = re.compile(r'tmp_info = "(.*?)";$', re.MULTILINE | re.DOTALL).search(str(soup.body.script)).group(1)
+    i2 = re.compile(r'tmp_info2 = "(.*?)";$', re.MULTILINE | re.DOTALL).search(str(soup.body.script)).group(1)
+    # We simulate bug for bug the way the variables are loaded on the "normal" switch models. In those, each
+    # data array has two extra 0 cells at the end. To remain compatible with the balance of the code here,
+    # we need to add in these redundant entries so they can be removed later. (smh)
+    script_vars = ('tmp_info:[' + i1.rstrip() + ' ' + i2.rstrip() + ',0,0]').replace(" ", ",")
+else:
+    script_vars = re.compile(r"var all_info = {\n?(.*?)\n?};$", re.MULTILINE | re.DOTALL).search(str(soup.script)).group(1)
 
 
-# In[98]:
+# In[19]:
 
 
 if TPLdebug:
-    print(pattern2.search(soup.script.string).group(1))
+    print(script_vars)
 
 
-# In[99]:
+# In[20]:
 
 
-entries = re.split(",?\n+", pattern2.search(soup.script.string).group(1))
+entries = re.split(",?\n+", script_vars)
 
 
-# In[100]:
+# In[21]:
 
 
 if TPLdebug:
     pprint.pprint(entries)
 
 
-# In[101]:
+# In[22]:
 
 
 edict = {}
@@ -197,61 +230,73 @@ def isnotebook():
     edict[str(e2[0])] = drop2.search(e2[1]).group(1)
 
 
-# In[102]:
+# In[23]:
 
 
 if TPLdebug:
     pprint.pprint(edict)
 
 
-# In[103]:
+# In[24]:
 
 
-e3 = re.split(",", edict['state'])
-e4 = re.split(",", edict['link_status'])
-e5 = re.split(",", edict['pkts'])
+if convoluted:
+    e3 = {}
+    e4 = {}
+    e5 = {}
+    ee = re.split(",", edict['tmp_info'])
+    for x in range (0, max_port_num):
+        e3[x] = ee[(x*6)]
+        e4[x] = ee[(x*6)+1]
+        e5[(x*4)] = ee[(x*6)+2]
+        e5[(x*4)+1] = ee[(x*6)+3]
+        e5[(x*4)+2] = ee[(x*6)+4]
+        e5[(x*4)+3] = ee[(x*6)+5]
+else:
+    e3 = re.split(",", edict['state'])
+    e4 = re.split(",", edict['link_status'])
+    e5 = re.split(",", edict['pkts'])
 
 
-# In[122]:
+# In[25]:
 
 
 if TPL1line:
-	print(current_dt+"," + str(max_port_num)+",", end="")
-	output_format = "{0:d},{1:s},{2:s},{3:s},{4:s},{5:s},{6:s}"
-	myend = ","
+    print(current_dt+"," + str(max_port_num)+",", end="")
+    output_format = "{0:d},{1:s},{2:s},{3:s},{4:s},{5:s},{6:s}"
+    myend = ","
 else:
-	output_format = "{0:d};{1:s};{2:s};{3:s},{4:s},{5:s},{6:s}"
-	myend = "\n"
+    output_format = "{0:d};{1:s};{2:s};{3:s},{4:s},{5:s},{6:s}"
+    myend = "\n"
 
 pdict = {}
 for x in range(1, max_port_num+1):
     #print(x, ((x-1)*4), ((x-1)*4)+1, ((x-1)*4)+2, ((x-1)*4)+3 )
     pdict[x] = {}
     if TPL1line:
-    	pdict[x]['state'] = e3[x-1]
-    	pdict[x]['link_status'] = e4[x-1]
+        pdict[x]['state'] = e3[x-1]
+        pdict[x]['link_status'] = e4[x-1]
     else:
-    	pdict[x]['state'] = TPstate[e3[x-1]]
-    	pdict[x]['link_status'] = TPlinkStatus[e4[x-1]]
+        pdict[x]['state'] = TPstate[e3[x-1]]
+        pdict[x]['link_status'] = TPlinkStatus[e4[x-1]]
     pdict[x]['TxGoodPkt'] = e5[((x-1)*4)]
     pdict[x]['TxBadPkt'] = e5[((x-1)*4)+1]
     pdict[x]['RxGoodPkt'] = e5[((x-1)*4)+2]
     pdict[x]['RxBadPkt'] = e5[((x-1)*4)+3]
-	
+
     if (x == max_port_num):
-    	myend = "\n"
-    print(output_format.format(	x,
-								pdict[x]['state'],
+        myend = "\n"
+    print(output_format.format(x,
+                                pdict[x]['state'],
                                 pdict[x]['link_status'],
                                 pdict[x]['TxGoodPkt'],
                                 pdict[x]['TxBadPkt'],
                                 pdict[x]['RxGoodPkt'],
                                 pdict[x]['RxBadPkt']), end=myend)
 
 
-# In[120]:
+# In[26]:
 
 
 if TPLdebug:
     pprint.pprint(pdict)
-