Fix not ignoring unknown optional parameters (as required by the spec) · python-smpplib/python-smpplib@0a75bba · GitHub

python-smpplib / python-smpplib Public

• Notifications You must be signed in to change notification settings
• Fork 144
• Star 190

• Code
• Issues 21
• Pull requests 15
• Discussions
• Actions
• Security and quality
• Insights

Additional navigation options

Commit 0a75bba

Browse filesBrowse the repository at this point in the historyBrowse files

davidshepherd7

authored and

code-of-kpp

committed

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.

1 parent 81f79b2 commit 0a75bba
Copy full SHA for 0a75bba

4 files changed

+54-6Lines changed: 54 additions & 6 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• README.md
• smpplib
  • client.py
  • command.py
• tests
  • test_command.py

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎README.md‎

Copy file name to clipboardExpand all lines: README.md

+1-1Lines changed: 1 addition & 1 deletion

• Display the source diff
• Display the rich diff

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

Collapse file

‎smpplib/client.py‎

Copy file name to clipboardExpand all lines: smpplib/client.py

+16-2Lines changed: 16 additions & 2 deletions

Original file line number	Diff line number	Diff line change
@@ -63,10 +63,20 @@ class Client(object):
63	63	_ssl_context = None
64	64	sequence_generator = None
65	65
66		- def __init__(self, host, port, timeout=5, sequence_generator=None, logger_name=None, ssl_context=None):
	66	+ def __init__(
	67	+ self,
	68	+ host,
	69	+ port,
	70	+ timeout=5,
	71	+ sequence_generator=None,
	72	+ logger_name=None,
	73	+ ssl_context=None,
	74	+ allow_unknown_opt_params=False
	75	+ ):
67	76	self.host = host
68	77	self.port = int(port)
69	78	self._ssl_context = ssl_context
	79	+ self.allow_unknown_opt_params = allow_unknown_opt_params
70	80	self.timeout = timeout
71	81	self.logger = logging.getLogger(logger_name or 'smpp.Client.{}'.format(id(self)))
72	82	if sequence_generator is None:
@@ -233,7 +243,11 @@ def read_pdu(self):
233	243
234	244	self.logger.debug('<<%s (%d bytes)', binascii.b2a_hex(raw_pdu), len(raw_pdu))
235	245
236		- pdu = smpp.parse_pdu(raw_pdu, client=self)
	246	+ pdu = smpp.parse_pdu(
	247	+ raw_pdu,
	248	+ client=self,
	249	+ allow_unknown_opt_params=self.allow_unknown_opt_params
	250	+ )
237	251
238	252	self.logger.debug('Read %s PDU', pdu.command)
239	253

Collapse file

‎smpplib/command.py‎

Copy file name to clipboardExpand all lines: smpplib/command.py

+13-2Lines changed: 13 additions & 2 deletions

Original file line number	Diff line number	Diff line change
@@ -93,9 +93,11 @@ class Command(pdu.PDU):
93	93
94	94	params = {}
95	95
96		- def __init__(self, command, need_sequence=True, **kwargs):
	96	+ def __init__(self, command, need_sequence=True, allow_unknown_opt_params=False, **kwargs):
97	97	super(Command, self).__init__(**kwargs)
98	98
	99	+ self.allow_unknown_opt_params = allow_unknown_opt_params
	100	+
99	101	self.command = command
100	102	if need_sequence and (kwargs.get('sequence') is None):
101	103	self.sequence = self._next_seq()
@@ -328,9 +330,18 @@ def parse_optional_params(self, data):
328	330
329	331	while pos < dlen:
330	332	type_code, pos = unpack_short(data, pos)
331		- field = get_optional_name(type_code)
332	333	length, pos = unpack_short(data, pos)
333	334
	335	+ try:
	336	+ field = get_optional_name(type_code)
	337	+ except exceptions.UnknownCommandError as e:
	338	+ if self.allow_unknown_opt_params:
	339	+ logger.warning("Unknown optional parameter type 0x%x, skipping" % type_code)
	340	+ pos += length
	341	+ continue
	342	+ else:
	343	+ raise
	344	+
334	345	param = self.params[field]
335	346	if param.type is int:
336	347	data, pos = self._parse_int(field, data, pos)

Collapse file

‎tests/test_command.py‎

Copy file name to clipboardExpand all lines: tests/test_command.py

+24-1Lines changed: 24 additions & 1 deletion

Original file line number	Diff line number	Diff line change
@@ -1,6 +1,8 @@
1		- from smpplib import consts
	1	+ from smpplib import consts, exceptions
2	2	from smpplib.command import DeliverSM
3	3
	4	+ import pytest
	5	+
4	6
5	7	def test_parse_deliver_sm():
6	8	pdu = DeliverSM('deliver_sm')
@@ -21,3 +23,24 @@ def test_parse_deliver_sm():
21	23	assert pdu.source_network_type == consts.SMPP_NETWORK_TYPE_GSM
22	24	assert pdu.message_state == consts.SMPP_MESSAGE_STATE_DELIVERED
23	25	assert pdu.user_message_reference is None
	26	+
	27	+
	28	+ def test_unrecognised_optional_parameters():
	29	+ pdu = DeliverSM("deliver_sm", allow_unknown_opt_params=True)
	30	+ pdu.parse(b'\x00\x00\x00\xa8\x00\x00\x00\x05\x00\x00\x00\x00/p\xc6'
	31	+ b'\x9a\x00\x00\x0022549909028\x00\x01\x00\x00\x04\x00\x00'
	32	+ b'\x00\x00\x00\x00\x00\x00iid:795920026 sub:001 dlvrd:001 '
	33	+ b'submit date:200319131913 done date:200319131913 stat:DELIVRD err:000 text:'
	34	+ b'\x14\x03\x00\x07(null)\x00\x14\x02\x00\x04612\x00'
	35	+ )
	36	+
	37	+ # This is only to avoid a breaking change, at some point the other behaviour
	38	+ # should become the default.
	39	+ with pytest.raises(exceptions.UnknownCommandError):
	40	+ pdu2 = DeliverSM("deliver_sm")
	41	+ pdu2.parse(b'\x00\x00\x00\xa8\x00\x00\x00\x05\x00\x00\x00\x00/p\xc6'
	42	+ b'\x9a\x00\x00\x0022549909028\x00\x01\x00\x00\x04\x00\x00'
	43	+ b'\x00\x00\x00\x00\x00\x00iid:795920026 sub:001 dlvrd:001 '
	44	+ b'submit date:200319131913 done date:200319131913 stat:DELIVRD err:000 text:'
	45	+ b'\x14\x03\x00\x07(null)\x00\x14\x02\x00\x04612\x00'
	46	+ )

0 commit comments

Comments

0 (0)