Socketify pynut #2792
+102
−861
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -62,13 +62,7 @@ | |
| # stashed copy until a better solution is developed. | ||
| # | ||
|
|
||
| import socket | ||
|
|
||
| class PyNUTError( Exception ) : | ||
| """ Base class for custom exceptions """ | ||
|
|
@@ -84,6 +78,7 @@ class PyNUTClient : | |
| __password = None | ||
| __timeout = None | ||
| __srv_handler = None | ||
| __recv_leftover = b'' | ||
|
|
||
| __version = "1.7.0" | ||
| __release = "2024-07-01" | ||
|
|
@@ -110,18 +105,31 @@ timeout : Timeout used to wait for network response | |
| self.__port = port | ||
| self.__login = login | ||
| self.__password = password | ||
| self.__timeout = timeout | ||
|
|
||
|
|
||
| self.__connect() | ||
|
|
||
| # Try to disconnect cleanly when class is deleted ;) | ||
| def __del__( self ) : | ||
| """ Class destructor method """ | ||
| try : | ||
| self.__srv_handler.send( b"LOGOUT\n" ) | ||
| except : | ||
| pass | ||
|
|
||
| def __read_until(self, finished_reading_data): | ||
| data = self.__recv_leftover | ||
| while (data_end_index := data.find(finished_reading_data)) == -1: | ||
| data += self.__srv_handler.recv(50) # nut_telnetlib.py uses 50 | ||
| data_end_index += len(finished_reading_data) | ||
|
|
||
| if data_end_index == len(data): | ||
| self.__recv_leftover = b'' | ||
| else: | ||
| self.__recv_leftover = data[data_end_index:] | ||
| data = data[:data_end_index] | ||
| return data | ||
|
|
||
| def __connect( self ) : | ||
| """ Connects to the defined server | ||
|
|
||
|
|
@@ -131,23 +139,25 @@ if something goes wrong. | |
| if self.__debug : | ||
| print( "[DEBUG] Connecting to host" ) | ||
|
|
||
| self.__srv_handler = socket.socket( socket.AF_INET, socket.SOCK_STREAM ) | ||
| self.__srv_handler.connect( (self.__host, self.__port) ) | ||
| self.__srv_handler.settimeout( self.__timeout ) | ||
|
|
||
| if self.__login != None : | ||
| self.__srv_handler.send( ("USERNAME %s\n" % self.__login).encode('ascii') ) | ||
| result = self.__read_until( b"\n" ) | ||
| if result[:2] != b"OK" : | ||
| raise PyNUTError( result.replace( b"\n", b"" ).decode('ascii') ) | ||
|
|
||
| if self.__password != None : | ||
| self.__srv_handler.send( ("PASSWORD %s\n" % self.__password).encode('ascii') ) | ||
| result = self.__read_until( b"\n" ) | ||
| if result[:2] != b"OK" : | ||
| if result == b"ERR INVALID-ARGUMENT\n" : | ||
| # Quote the password (if it has whitespace etc) | ||
| # TODO: Escape special chard like NUT does? | ||
| self.__srv_handler.send( ("PASSWORD \"%s\"\n" % self.__password).encode('ascii') ) | ||
| result = self.__read_until( b"\n" ) | ||
| if result[:2] != b"OK" : | ||
| raise PyNUTError( result.replace( b"\n", b"" ).decode('ascii') ) | ||
| else: | ||
|
|
@@ -165,12 +175,12 @@ which is of little concern for Python2 but is important in Python3 | |
| if self.__debug : | ||
| print( "[DEBUG] GetUPSList from server" ) | ||
|
|
||
| self.__srv_handler.send( b"LIST UPS\n" ) | ||
| result = self.__read_until( b"\n" ) | ||
| if result != b"BEGIN LIST UPS\n": | ||
| raise PyNUTError( result.replace( b"\n", b"" ).decode('ascii') ) | ||
|
|
||
| result = self.__read_until( b"END LIST UPS\n" ) | ||
| ups_list = {} | ||
|
|
||
| for line in result.split( b"\n" ) : | ||
|
|
@@ -205,13 +215,13 @@ available vars. | |
| if self.__debug : | ||
| print( "[DEBUG] GetUPSVars called..." ) | ||
|
|
||
| self.__srv_handler.send( ("LIST VAR %s\n" % ups).encode('ascii') ) | ||
| result = self.__read_until( b"\n" ) | ||
| if result != ("BEGIN LIST VAR %s\n" % ups).encode('ascii') : | ||
| raise PyNUTError( result.replace( b"\n", b"" ).decode('ascii') ) | ||
|
|
||
| ups_vars = {} | ||
| result = self.__read_until( ("END LIST VAR %s\n" % ups).encode('ascii') ) | ||
| offset = len( ("VAR %s " % ups ).encode('ascii') ) | ||
| end_offset = 0 - ( len( ("END LIST VAR %s\n" % ups).encode('ascii') ) + 1 ) | ||
|
|
||
|
|
@@ -231,12 +241,12 @@ The result is True (reachable) or False (unreachable) | |
| if self.__debug : | ||
| print( "[DEBUG] CheckUPSAvailable called..." ) | ||
|
|
||
| self.__srv_handler.send( ("LIST CMD %s\n" % ups).encode('ascii') ) | ||
| result = self.__read_until( b"\n" ) | ||
| if result != ("BEGIN LIST CMD %s\n" % ups).encode('ascii') : | ||
| return False | ||
|
|
||
| self.__read_until( ("END LIST CMD %s\n" % ups).encode('ascii') ) | ||
| return True | ||
|
|
||
| def GetUPSCommands( self, ups="" ) : | ||
|
|
@@ -248,13 +258,13 @@ of the command as value | |
| if self.__debug : | ||
| print( "[DEBUG] GetUPSCommands called..." ) | ||
|
|
||
| self.__srv_handler.send( ("LIST CMD %s\n" % ups).encode('ascii') ) | ||
| result = self.__read_until( b"\n" ) | ||
| if result != ("BEGIN LIST CMD %s\n" % ups).encode('ascii') : | ||
| raise PyNUTError( result.replace( b"\n", b"" ).decode('ascii') ) | ||
|
|
||
| ups_cmds = {} | ||
| result = self.__read_until( ("END LIST CMD %s\n" % ups).encode('ascii') ) | ||
| offset = len( ("CMD %s " % ups).encode('ascii') ) | ||
| end_offset = 0 - ( len( ("END LIST CMD %s\n" % ups).encode('ascii') ) + 1 ) | ||
|
|
||
|
|
@@ -263,8 +273,8 @@ of the command as value | |
|
|
||
| # For each var we try to get the available description | ||
| try : | ||
| self.__srv_handler.send( ("GET CMDDESC %s %s\n" % ( ups, var )).encode('ascii') ) | ||
| temp = self.__read_until( b"\n" ) | ||
| if temp[:7] != b"CMDDESC" : | ||
| raise PyNUTError | ||
| else : | ||
|
|
@@ -285,12 +295,12 @@ The result is presented as a dictionary containing 'key->val' pairs | |
| if self.__debug : | ||
| print( "[DEBUG] GetUPSVars from '%s'..." % ups ) | ||
|
|
||
| self.__srv_handler.send( ("LIST RW %s\n" % ups).encode('ascii') ) | ||
| result = self.__read_until( b"\n" ) | ||
| if ( result != ("BEGIN LIST RW %s\n" % ups).encode('ascii') ) : | ||
| raise PyNUTError( result.replace( b"\n", b"" ).decode('ascii') ) | ||
|
|
||
| result = self.__read_until( ("END LIST RW %s\n" % ups).encode('ascii') ) | ||
| offset = len( ("VAR %s" % ups).encode('ascii') ) | ||
| end_offset = 0 - ( len( ("END LIST RW %s\n" % ups).encode('ascii') ) + 1 ) | ||
| rw_vars = {} | ||
|
|
@@ -313,8 +323,8 @@ The variable must be a writable value (cf GetRWVars) and you must have the prope | |
| rights to set it (maybe login/password). | ||
| """ | ||
|
|
||
| self.__srv_handler.send( ("SET VAR %s %s %s\n" % ( ups, var, value )).encode('ascii') ) | ||
| result = self.__read_until( b"\n" ) | ||
| if ( result == b"OK\n" ) : | ||
| return( "OK" ) | ||
| else : | ||
|
|
@@ -329,8 +339,8 @@ Returns OK on success or raises an error | |
| if self.__debug : | ||
| print( "[DEBUG] RunUPSCommand called..." ) | ||
|
|
||
| self.__srv_handler.send( ("INSTCMD %s %s\n" % ( ups, command )).encode('ascii') ) | ||
| result = self.__read_until( b"\n" ) | ||
| if ( result == b"OK\n" ) : | ||
| return( "OK" ) | ||
| else : | ||
|
|
@@ -355,12 +365,12 @@ of connection. | |
| print( "[DEBUG] DeviceLogin: %s is not a valid UPS" % ups ) | ||
| raise PyNUTError( "ERR UNKNOWN-UPS" ) | ||
|
|
||
| self.__srv_handler.send( ("LOGIN %s\n" % ups).encode('ascii') ) | ||
| result = self.__read_until( b"\n" ) | ||
| if ( result.startswith( ("User %s@" % self.__login).encode('ascii')) and result.endswith (("[%s]\n" % ups).encode('ascii')) ): | ||
| # User [email protected] logged into UPS [dummy] | ||
| # Read next line then | ||
| result = self.__read_until( b"\n" ) | ||
| if ( result == b"OK\n" ) : | ||
| return( "OK" ) | ||
| else : | ||
|
|
@@ -378,22 +388,22 @@ NOTE: API changed since NUT 2.8.0 to replace MASTER with PRIMARY | |
| if self.__debug : | ||
| print( "[DEBUG] PRIMARY called..." ) | ||
|
|
||
| self.__srv_handler.send( ("PRIMARY %s\n" % ups).encode('ascii') ) | ||
| result = self.__read_until( b"\n" ) | ||
| if ( result != b"OK PRIMARY-GRANTED\n" ) : | ||
| if self.__debug : | ||
| print( "[DEBUG] Retrying: MASTER called..." ) | ||
| self.__srv_handler.send( ("MASTER %s\n" % ups).encode('ascii') ) | ||
| result = self.__read_until( b"\n" ) | ||
| if ( result != b"OK MASTER-GRANTED\n" ) : | ||
| if self.__debug : | ||
| print( "[DEBUG] Primary level functions are not available" ) | ||
| raise PyNUTError( "ERR ACCESS-DENIED" ) | ||
|
|
||
| if self.__debug : | ||
| print( "[DEBUG] FSD called..." ) | ||
| self.__srv_handler.send( ("FSD %s\n" % ups).encode('ascii') ) | ||
| result = self.__read_until( b"\n" ) | ||
| if ( result == b"OK FSD-SET\n" ) : | ||
| return( "OK" ) | ||
| else : | ||
|
|
@@ -406,8 +416,8 @@ NOTE: API changed since NUT 2.8.0 to replace MASTER with PRIMARY | |
| if self.__debug : | ||
| print( "[DEBUG] HELP called..." ) | ||
|
|
||
| self.__srv_handler.send( b"HELP\n" ) | ||
| return self.__read_until( b"\n" ) | ||
|
|
||
| def ver(self) : | ||
| """ Send VER command | ||
|
|
@@ -416,8 +426,8 @@ NOTE: API changed since NUT 2.8.0 to replace MASTER with PRIMARY | |
| if self.__debug : | ||
| print( "[DEBUG] VER called..." ) | ||
|
|
||
| self.__srv_handler.send( b"VER\n" ) | ||
| return self.__read_until( b"\n" ) | ||
|
|
||
| def ListClients( self, ups = None ) : | ||
| """ Returns the list of connected clients from the NUT server | ||
|
|
@@ -435,12 +445,12 @@ The result is a dictionary containing 'key->val' pairs of 'UPSName' and a list o | |
| raise PyNUTError( "ERR UNKNOWN-UPS" ) | ||
|
|
||
| if ups: | ||
| self.__srv_handler.send( ("LIST CLIENT %s\n" % ups).encode('ascii') ) | ||
| else: | ||
| # NOTE: Currently NUT does not support just listing all clients | ||
| # (not providing an "ups" argument) => NUT_ERR_INVALID_ARGUMENT | ||
| self.__srv_handler.send( b"LIST CLIENT\n" ) | ||
| result = self.__read_until( b"\n" ) | ||
| if ( (ups and result != ("BEGIN LIST CLIENT %s\n" % ups).encode('ascii')) or (ups is None and result != b"BEGIN LIST CLIENT\n") ): | ||
| if ups is None and (result == b"ERR INVALID-ARGUMENT\n") : | ||
| # For ups==None, list all upses, list their clients | ||
|
|
@@ -458,11 +468,11 @@ The result is a dictionary containing 'key->val' pairs of 'UPSName' and a list o | |
|
|
||
| raise PyNUTError( result.replace( b"\n", b"" ).decode('ascii') ) | ||
|
|
||
| if ups: | ||
| result = self.__read_until( ("END LIST CLIENT %s\n" % ups).encode('ascii') ) | ||
| else: | ||
| # Should not get here with current NUT: | ||
| result = self.__read_until( b"END LIST CLIENT\n" ) | ||
| ups_list = {} | ||
|
|
||
| for line in result.split( b"\n" ): | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Probably makes sense to add to the changelog above, that a "better solution" did get developed. And in
NEWS.adoctoo.Eventually also drop
nut_telnetlibfrom Git,Makefile.am,setup.py...I gather that
socketis available in core of both 2.x and 3.x Pythons, right?