Fix not ignoring unknown optional parameters (as required by the spec)

See page 43 of https://smpp.org/SMPP_v3_4_Issue1_2.pdf for details.

Author: davidshepherd7

README.md

@@ -25,7 +25,7 @@ logging.basicConfig(level='DEBUG')
 # Two parts, UCS2, SMS with UDH
 parts, encoding_flag, msg_type_flag = smpplib.gsm.make_parts(u'Привет мир!\n'*10)
 
-client = smpplib.client.Client('example.com', SOMEPORTNUMBER)
+client = smpplib.client.Client('example.com', SOMEPORTNUMBER, allow_unknown_opt_params=True)
 
 # Print when obtain message_id
 client.set_message_sent_handler(

smpplib/client.py

@@ -63,10 +63,20 @@ class Client(object):
     _ssl_context = None
     sequence_generator = None
 
-    def __init__(self, host, port, timeout=5, sequence_generator=None, logger_name=None, ssl_context=None):
+    def __init__(
+        self,
+        host,
+        port,
+        timeout=5,
+        sequence_generator=None,
+        logger_name=None,
+        ssl_context=None,
+        allow_unknown_opt_params=False
+    ):
         self.host = host
         self.port = int(port)
         self._ssl_context = ssl_context
+        self.allow_unknown_opt_params = allow_unknown_opt_params
         self.timeout = timeout
         self.logger = logging.getLogger(logger_name or 'smpp.Client.{}'.format(id(self)))
         if sequence_generator is None:
@@ -233,7 +243,11 @@ def read_pdu(self):
 
         self.logger.debug('<<%s (%d bytes)', binascii.b2a_hex(raw_pdu), len(raw_pdu))
 
-        pdu = smpp.parse_pdu(raw_pdu, client=self)
+        pdu = smpp.parse_pdu(
+            raw_pdu,
+            client=self,
+            allow_unknown_opt_params=self.allow_unknown_opt_params
+        )
 
         self.logger.debug('Read %s PDU', pdu.command)
 

smpplib/command.py

@@ -93,9 +93,11 @@ class Command(pdu.PDU):
 
     params = {}
 
-    def __init__(self, command, need_sequence=True, **kwargs):
+    def __init__(self, command, need_sequence=True, allow_unknown_opt_params=False, **kwargs):
         super(Command, self).__init__(**kwargs)
 
+        self.allow_unknown_opt_params = allow_unknown_opt_params
+
         self.command = command
         if need_sequence and (kwargs.get('sequence') is None):
             self.sequence = self._next_seq()
@@ -328,9 +330,18 @@ def parse_optional_params(self, data):
 
         while pos < dlen:
             type_code, pos = unpack_short(data, pos)
-            field = get_optional_name(type_code)
             length, pos = unpack_short(data, pos)
 
+            try:
+                field = get_optional_name(type_code)
+            except exceptions.UnknownCommandError as e:
+                if self.allow_unknown_opt_params:
+                    logger.warning("Unknown optional parameter type 0x%x, skipping" % type_code)
+                    pos += length
+                    continue
+                else:
+                    raise
+
             param = self.params[field]
             if param.type is int:
                 data, pos = self._parse_int(field, data, pos)

tests/test_command.py

@@ -1,6 +1,8 @@
-from smpplib import consts
+from smpplib import consts, exceptions
 from smpplib.command import DeliverSM
 
+import pytest
+
 
 def test_parse_deliver_sm():
     pdu = DeliverSM('deliver_sm')
@@ -21,3 +23,24 @@ def test_parse_deliver_sm():
     assert pdu.source_network_type == consts.SMPP_NETWORK_TYPE_GSM
     assert pdu.message_state == consts.SMPP_MESSAGE_STATE_DELIVERED
     assert pdu.user_message_reference is None
+
+
+def test_unrecognised_optional_parameters():
+    pdu = DeliverSM("deliver_sm", allow_unknown_opt_params=True)
+    pdu.parse(b'\x00\x00\x00\xa8\x00\x00\x00\x05\x00\x00\x00\x00/p\xc6'
+              b'\x9a\x00\x00\x0022549909028\x00\x01\x00\x00\x04\x00\x00'
+              b'\x00\x00\x00\x00\x00\x00iid:795920026 sub:001 dlvrd:001 '
+              b'submit date:200319131913 done date:200319131913 stat:DELIVRD err:000 text:'
+              b'\x14\x03\x00\x07(null)\x00\x14\x02\x00\x04612\x00'
+    )
+
+    # This is only to avoid a breaking change, at some point the other behaviour
+    # should become the default.
+    with pytest.raises(exceptions.UnknownCommandError):
+        pdu2 = DeliverSM("deliver_sm")
+        pdu2.parse(b'\x00\x00\x00\xa8\x00\x00\x00\x05\x00\x00\x00\x00/p\xc6'
+                  b'\x9a\x00\x00\x0022549909028\x00\x01\x00\x00\x04\x00\x00'
+                  b'\x00\x00\x00\x00\x00\x00iid:795920026 sub:001 dlvrd:001 '
+                  b'submit date:200319131913 done date:200319131913 stat:DELIVRD err:000 text:'
+                  b'\x14\x03\x00\x07(null)\x00\x14\x02\x00\x04612\x00'
+        )