repo
stringlengths 5
75
| commit
stringlengths 40
40
| message
stringlengths 6
18.2k
| diff
stringlengths 60
262k
|
|---|---|---|---|
dmaclay/python-smpp
|
3e01fc04a9d3f91dcdcef3215a43337c588951eb
|
there's the bug
|
diff --git a/smpp/pdu.py b/smpp/pdu.py
index 11aaeea..b22c817 100644
--- a/smpp/pdu.py
+++ b/smpp/pdu.py
@@ -517,530 +517,531 @@ maps['esm_class_bits'] = {
'type_0011' :'0a',
'type_user_ack' :'10',
'type_0101' :'14',
'type_conversation_abort' :'18',
'type_0111' :'1a',
'type_intermed_deliv_notif' :'20',
'type_1001' :'24',
'type_1010' :'28',
'type_1011' :'2a',
'type_1100' :'30',
'type_1101' :'34',
'type_1110' :'38',
'type_1111' :'3a',
'feature_none' :'00',
'feature_UDHI' :'40',
'feature_reply_path' :'80',
'feature_UDHI_and_reply_path':'c0'
}
# Registered Delivery bits - SMPP v3.4, section 5.2.17, page 124
maps['registered_delivery_bits'] = {
'receipt_mask' :'03',
'ack_mask' :'0c',
'intermed_notif_mask' :'80',
'receipt_none' :'00',
'receipt_always' :'01',
'receipt_on_fail' :'02',
'receipt_res' :'03',
'ack_none' :'00',
'ack_delivery' :'04',
'ack_user' :'08',
'ack_delivery_and_user':'0c',
'intermed_notif_none' :'00',
'intermed_notif' :'10'
}
# submit_multi dest_flag constants - SMPP v3.4, section 5.2.25, page 129
#maps['dest_flag_by_name'] = {
#'SME Address' :1,
#'Distribution List Name':2
#}
# Message State codes returned in query_sm_resp PDUs - SMPP v3.4, section 5.2.28, table 5-6, page 130
maps['message_state_by_name'] = {
'ENROUTE' :1,
'DELIVERED' :2,
'EXPIRED' :3,
'DELETED' :4,
'UNDELIVERABLE':5,
'ACCEPTED' :6,
'UNKNOWN' :7,
'REJECTED' :8
}
# Facility Code bits for SMPP v4
maps['facility_code_bits'] = {
'GF_PVCY' :'00000001',
'GF_SUBADDR':'00000002',
'NF_CC' :'00080000',
'NF_PDC' :'00010000',
'NF_IS136' :'00020000',
'NF_IS95A' :'00040000'
}
# Optional Parameter Tags - SMPP v3.4, section 5.3.2, Table 5-7, page 132-133
optional_parameter_tag_by_hex = {
'0005':{'hex':'0005', 'name':'dest_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.1, page 134
'0006':{'hex':'0006', 'name':'dest_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.3, page 135
'0007':{'hex':'0007', 'name':'dest_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.5, page 136
'0008':{'hex':'0008', 'name':'dest_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.7, page 137
'000d':{'hex':'000d', 'name':'source_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.2, page 134
'000e':{'hex':'000e', 'name':'source_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.4, page 135
'000f':{'hex':'000f', 'name':'source_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.6, page 136
'0010':{'hex':'0010', 'name':'source_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.8, page 137
'0017':{'hex':'0017', 'name':'qos_time_to_live', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.9, page 138
'0019':{'hex':'0019', 'name':'payload_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.10, page 138
'001d':{'hex':'001d', 'name':'additional_status_info_text', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.11, page 139
'001e':{'hex':'001e', 'name':'receipted_message_id', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.12, page 139
'0030':{'hex':'0030', 'name':'ms_msg_wait_facilities', 'type':'bitmask', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.13, page 140
'0101':{'hex':'0101', 'name':'PVCY_AuthenticationStr', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 58-62
'0201':{'hex':'0201', 'name':'privacy_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.14, page 141
'0202':{'hex':'0202', 'name':'source_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.15, page 142
'0203':{'hex':'0203', 'name':'dest_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.16, page 143
'0204':{'hex':'0204', 'name':'user_message_reference', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.17, page 143
'0205':{'hex':'0205', 'name':'user_response_code', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.18, page 144
'020a':{'hex':'020a', 'name':'source_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.20, page 145
'020b':{'hex':'020b', 'name':'destination_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.21, page 145
'020c':{'hex':'020c', 'name':'sar_msg_ref_num', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.22, page 146
'020d':{'hex':'020d', 'name':'language_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.19, page 144
'020e':{'hex':'020e', 'name':'sar_total_segments', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.23, page 147
'020f':{'hex':'020f', 'name':'sar_segment_seqnum', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.24, page 147
'0210':{'hex':'0210', 'name':'sc_interface_version', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.25, page 148
'0301':{'hex':'0301', 'name':'CC_CBN', 'type':None, 'tech':'V4'}, # v4 page 70
'0302':{'hex':'0302', 'name':'callback_num_pres_ind', 'type':'bitmask', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.37, page 156
'0303':{'hex':'0303', 'name':'callback_num_atag', 'type':'hex', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.38, page 157
'0304':{'hex':'0304', 'name':'number_of_messages', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.39, page 158
'0381':{'hex':'0381', 'name':'callback_num', 'type':'hex', 'tech':'CDMA, TDMA, GSM, iDEN'}, # SMPP v3.4, section 5.3.2.36, page 155
'0420':{'hex':'0420', 'name':'dpf_result', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.28, page 149
'0421':{'hex':'0421', 'name':'set_dpf', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.29, page 150
'0422':{'hex':'0422', 'name':'ms_availability_status', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.30, page 151
'0423':{'hex':'0423', 'name':'network_error_code', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.31, page 152
'0424':{'hex':'0424', 'name':'message_payload', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.32, page 153
'0425':{'hex':'0425', 'name':'delivery_failure_reason', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.33, page 153
'0426':{'hex':'0426', 'name':'more_messages_to_send', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.34, page 154
'0427':{'hex':'0427', 'name':'message_state', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.35, page 154
'0428':{'hex':'0428', 'name':'congestion_state', 'type':None, 'tech':'Generic'},
'0501':{'hex':'0501', 'name':'ussd_service_op', 'type':'hex', 'tech':'GSM (USSD)'}, # SMPP v3.4, section 5.3.2.44, page 161
'0600':{'hex':'0600', 'name':'broadcast_channel_indicator', 'type':None, 'tech':'GSM'},
'0601':{'hex':'0601', 'name':'broadcast_content_type', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'0602':{'hex':'0602', 'name':'broadcast_content_type_info', 'type':None, 'tech':'CDMA, TDMA'},
'0603':{'hex':'0603', 'name':'broadcast_message_class', 'type':None, 'tech':'GSM'},
'0604':{'hex':'0604', 'name':'broadcast_rep_num', 'type':None, 'tech':'GSM'},
'0605':{'hex':'0605', 'name':'broadcast_frequency_interval', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'0606':{'hex':'0606', 'name':'broadcast_area_identifier', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'0607':{'hex':'0607', 'name':'broadcast_error_status', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'0608':{'hex':'0608', 'name':'broadcast_area_success', 'type':None, 'tech':'GSM'},
'0609':{'hex':'0609', 'name':'broadcast_end_time', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'060a':{'hex':'060a', 'name':'broadcast_service_group', 'type':None, 'tech':'CDMA, TDMA'},
'060b':{'hex':'060b', 'name':'billing_identification', 'type':None, 'tech':'Generic'},
'060d':{'hex':'060d', 'name':'source_network_id', 'type':None, 'tech':'Generic'},
'060e':{'hex':'060e', 'name':'dest_network_id', 'type':None, 'tech':'Generic'},
'060f':{'hex':'060f', 'name':'source_node_id', 'type':None, 'tech':'Generic'},
'0610':{'hex':'0610', 'name':'dest_node_id', 'type':None, 'tech':'Generic'},
'0611':{'hex':'0611', 'name':'dest_addr_np_resolution', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'0612':{'hex':'0612', 'name':'dest_addr_np_information', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'0613':{'hex':'0613', 'name':'dest_addr_np_country', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'1101':{'hex':'1101', 'name':'PDC_MessageClass', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 75
'1102':{'hex':'1102', 'name':'PDC_PresentationOption', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
'1103':{'hex':'1103', 'name':'PDC_AlertMechanism', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
'1104':{'hex':'1104', 'name':'PDC_Teleservice', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
'1105':{'hex':'1105', 'name':'PDC_MultiPartMessage', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
'1106':{'hex':'1106', 'name':'PDC_PredefinedMsg', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 78
'1201':{'hex':'1201', 'name':'display_time', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.26, page 148
'1203':{'hex':'1203', 'name':'sms_signal', 'type':'integer', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.40, page 158
'1204':{'hex':'1204', 'name':'ms_validity', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.27, page 149
'1304':{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'type':None, 'tech':'CDMA'}, # v4 page 85
'1306':{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'type':None, 'tech':'CDMA'}, # v4 page 86
'130c':{'hex':'130c', 'name':'alert_on_message_delivery', 'type':None, 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.41, page 159
'1380':{'hex':'1380', 'name':'its_reply_type', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.42, page 159
'1383':{'hex':'1383', 'name':'its_session_info', 'type':'hex', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.43, page 160
'1402':{'hex':'1402', 'name':'operator_id', 'type':None, 'tech':'vendor extension'},
'1403':{'hex':'1403', 'name':'tariff', 'type':None, 'tech':'Mobile Network Code vendor extension'},
'1450':{'hex':'1450', 'name':'mcc', 'type':None, 'tech':'Mobile Country Code vendor extension'},
'1451':{'hex':'1451', 'name':'mnc', 'type':None, 'tech':'Mobile Network Code vendor extension'}
}
def optional_parameter_tag_name_by_hex(x):
return optional_parameter_tag_by_hex.get(x,{}).get('name')
def optional_parameter_tag_type_by_hex(x):
return optional_parameter_tag_by_hex.get(x,{}).get('type')
optional_parameter_tag_by_name = {
'dest_addr_subunit' :{'hex':'0005', 'name':'dest_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.1, page 134
'dest_network_type' :{'hex':'0006', 'name':'dest_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.3, page 135
'dest_bearer_type' :{'hex':'0007', 'name':'dest_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.5, page 136
'dest_telematics_id' :{'hex':'0008', 'name':'dest_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.7, page 137
'source_addr_subunit' :{'hex':'000d', 'name':'source_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.2, page 134
'source_network_type' :{'hex':'000e', 'name':'source_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.4, page 135
'source_bearer_type' :{'hex':'000f', 'name':'source_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.6, page 136
'source_telematics_id' :{'hex':'0010', 'name':'source_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.8, page 137
'qos_time_to_live' :{'hex':'0017', 'name':'qos_time_to_live', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.9, page 138
'payload_type' :{'hex':'0019', 'name':'payload_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.10, page 138
'additional_status_info_text' :{'hex':'001d', 'name':'additional_status_info_text', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.11, page 139
'receipted_message_id' :{'hex':'001e', 'name':'receipted_message_id', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.12, page 139
'ms_msg_wait_facilities' :{'hex':'0030', 'name':'ms_msg_wait_facilities', 'type':'bitmask', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.13, page 140
'PVCY_AuthenticationStr' :{'hex':'0101', 'name':'PVCY_AuthenticationStr', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 58-62
'privacy_indicator' :{'hex':'0201', 'name':'privacy_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.14, page 141
'source_subaddress' :{'hex':'0202', 'name':'source_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.15, page 142
'dest_subaddress' :{'hex':'0203', 'name':'dest_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.16, page 143
'user_message_reference' :{'hex':'0204', 'name':'user_message_reference', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.17, page 143
'user_response_code' :{'hex':'0205', 'name':'user_response_code', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.18, page 144
'source_port' :{'hex':'020a', 'name':'source_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.20, page 145
'destination_port' :{'hex':'020b', 'name':'destination_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.21, page 145
'sar_msg_ref_num' :{'hex':'020c', 'name':'sar_msg_ref_num', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.22, page 146
'language_indicator' :{'hex':'020d', 'name':'language_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.19, page 144
'sar_total_segments' :{'hex':'020e', 'name':'sar_total_segments', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.23, page 147
'sar_segment_seqnum' :{'hex':'020f', 'name':'sar_segment_seqnum', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.24, page 147
'sc_interface_version' :{'hex':'0210', 'name':'sc_interface_version', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.25, page 148
'CC_CBN' :{'hex':'0301', 'name':'CC_CBN', 'type':None, 'tech':'V4'}, # v4 page 70
'callback_num_pres_ind' :{'hex':'0302', 'name':'callback_num_pres_ind', 'type':'bitmask', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.37, page 156
'callback_num_atag' :{'hex':'0303', 'name':'callback_num_atag', 'type':'hex', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.38, page 157
'number_of_messages' :{'hex':'0304', 'name':'number_of_messages', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.39, page 158
'callback_num' :{'hex':'0381', 'name':'callback_num', 'type':'hex', 'tech':'CDMA, TDMA, GSM, iDEN'}, # SMPP v3.4, section 5.3.2.36, page 155
'dpf_result' :{'hex':'0420', 'name':'dpf_result', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.28, page 149
'set_dpf' :{'hex':'0421', 'name':'set_dpf', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.29, page 150
'ms_availability_status' :{'hex':'0422', 'name':'ms_availability_status', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.30, page 151
'network_error_code' :{'hex':'0423', 'name':'network_error_code', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.31, page 152
'message_payload' :{'hex':'0424', 'name':'message_payload', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.32, page 153
'delivery_failure_reason' :{'hex':'0425', 'name':'delivery_failure_reason', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.33, page 153
'more_messages_to_send' :{'hex':'0426', 'name':'more_messages_to_send', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.34, page 154
'message_state' :{'hex':'0427', 'name':'message_state', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.35, page 154
'congestion_state' :{'hex':'0428', 'name':'congestion_state', 'type':None, 'tech':'Generic'},
'ussd_service_op' :{'hex':'0501', 'name':'ussd_service_op', 'type':'hex', 'tech':'GSM (USSD)'}, # SMPP v3.4, section 5.3.2.44, page 161
'broadcast_channel_indicator' :{'hex':'0600', 'name':'broadcast_channel_indicator', 'type':None, 'tech':'GSM'},
'broadcast_content_type' :{'hex':'0601', 'name':'broadcast_content_type', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_content_type_info' :{'hex':'0602', 'name':'broadcast_content_type_info', 'type':None, 'tech':'CDMA, TDMA'},
'broadcast_message_class' :{'hex':'0603', 'name':'broadcast_message_class', 'type':None, 'tech':'GSM'},
'broadcast_rep_num' :{'hex':'0604', 'name':'broadcast_rep_num', 'type':None, 'tech':'GSM'},
'broadcast_frequency_interval':{'hex':'0605', 'name':'broadcast_frequency_interval', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_area_identifier' :{'hex':'0606', 'name':'broadcast_area_identifier', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_error_status' :{'hex':'0607', 'name':'broadcast_error_status', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_area_success' :{'hex':'0608', 'name':'broadcast_area_success', 'type':None, 'tech':'GSM'},
'broadcast_end_time' :{'hex':'0609', 'name':'broadcast_end_time', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_service_group' :{'hex':'060a', 'name':'broadcast_service_group', 'type':None, 'tech':'CDMA, TDMA'},
'billing_identification' :{'hex':'060b', 'name':'billing_identification', 'type':None, 'tech':'Generic'},
'source_network_id' :{'hex':'060d', 'name':'source_network_id', 'type':None, 'tech':'Generic'},
'dest_network_id' :{'hex':'060e', 'name':'dest_network_id', 'type':None, 'tech':'Generic'},
'source_node_id' :{'hex':'060f', 'name':'source_node_id', 'type':None, 'tech':'Generic'},
'dest_node_id' :{'hex':'0610', 'name':'dest_node_id', 'type':None, 'tech':'Generic'},
'dest_addr_np_resolution' :{'hex':'0611', 'name':'dest_addr_np_resolution', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'dest_addr_np_information' :{'hex':'0612', 'name':'dest_addr_np_information', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'dest_addr_np_country' :{'hex':'0613', 'name':'dest_addr_np_country', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'PDC_MessageClass' :{'hex':'1101', 'name':'PDC_MessageClass', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 75
'PDC_PresentationOption' :{'hex':'1102', 'name':'PDC_PresentationOption', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
'PDC_AlertMechanism' :{'hex':'1103', 'name':'PDC_AlertMechanism', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
'PDC_Teleservice' :{'hex':'1104', 'name':'PDC_Teleservice', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
'PDC_MultiPartMessage' :{'hex':'1105', 'name':'PDC_MultiPartMessage', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
'PDC_PredefinedMsg' :{'hex':'1106', 'name':'PDC_PredefinedMsg', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 78
'display_time' :{'hex':'1201', 'name':'display_time', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.26, page 148
'sms_signal' :{'hex':'1203', 'name':'sms_signal', 'type':'integer', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.40, page 158
'ms_validity' :{'hex':'1204', 'name':'ms_validity', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.27, page 149
'IS95A_AlertOnDelivery' :{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'type':None, 'tech':'CDMA'}, # v4 page 85
'IS95A_LanguageIndicator' :{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'type':None, 'tech':'CDMA'}, # v4 page 86
'alert_on_message_delivery' :{'hex':'130c', 'name':'alert_on_message_delivery', 'type':None, 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.41, page 159
'its_reply_type' :{'hex':'1380', 'name':'its_reply_type', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.42, page 159
'its_session_info' :{'hex':'1383', 'name':'its_session_info', 'type':'hex', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.43, page 160
'operator_id' :{'hex':'1402', 'name':'operator_id', 'type':None, 'tech':'vendor extension'},
'tariff' :{'hex':'1403', 'name':'tariff', 'type':None, 'tech':'Mobile Network Code vendor extension'},
'mcc' :{'hex':'1450', 'name':'mcc', 'type':None, 'tech':'Mobile Country Code vendor extension'},
'mnc' :{'hex':'1451', 'name':'mnc', 'type':None, 'tech':'Mobile Network Code vendor extension'}
}
def optional_parameter_tag_hex_by_name(n):
return optional_parameter_tag_by_name.get(n,{}).get('hex')
#### Decoding functions #######################################################
def unpack_pdu(pdu_bin):
return decode_pdu(binascii.b2a_hex(pdu_bin))
def decode_pdu(pdu_hex):
hex_ref = [pdu_hex]
pdu = {}
pdu['header'] = decode_header(hex_ref)
command = pdu['header'].get('command_id', None)
if command != None:
body = decode_body(command, hex_ref)
if len(body) > 0:
pdu['body'] = body
return pdu
def decode_header(hex_ref):
pdu_hex = hex_ref[0]
header = {}
(command_length, command_id, command_status, sequence_number, hex_ref[0]) = \
(pdu_hex[0:8], pdu_hex[8:16], pdu_hex[16:24], pdu_hex[24:32], pdu_hex[32: ])
length = int(command_length, 16)
command = command_id_name_by_hex(command_id)
status = command_status_name_by_hex(command_status)
sequence = int(sequence_number, 16)
header = {}
header['command_length'] = length
header['command_id'] = command
header['command_status'] = status
header['sequence_number'] = sequence
return header
def decode_body(command, hex_ref):
body = {}
if command != None:
fields = mandatory_parameter_list_by_command_name(command)
mandatory = decode_mandatory_parameters(fields, hex_ref)
if len(mandatory) > 0:
body['mandatory_parameters'] = mandatory
optional = decode_optional_parameters(hex_ref)
if len(optional) > 0:
body['optional_parameters'] = optional
return body
def decode_mandatory_parameters(fields, hex_ref):
mandatory_parameters = {}
if len(hex_ref[0]) > 1:
for field in fields:
#old = len(hex_ref[0])
data = ''
octet = ''
count = 0
if field['var'] == True or field['var'] == False:
while (len(hex_ref[0]) > 1
and (count < field['min']
or (field['var'] == True
and count < field['max']+1
and octet != '00'))):
octet = octpop(hex_ref)
data += octet
count += 1
elif field['type'] in ['string', 'xstring']:
count = mandatory_parameters[field['var']]
if count == 0:
data = None
else:
for i in range(count):
if len(hex_ref[0]) > 1:
data += octpop(hex_ref)
else:
count = mandatory_parameters[field['var']]
if field['map'] != None:
mandatory_parameters[field['name']] = maps[field['map']+'_by_hex'].get(data, None)
if field['map'] == None or mandatory_parameters[field['name']] == None:
mandatory_parameters[field['name']] = decode_hex_type(data, field['type'], count, hex_ref)
#print field['type'], (old - len(hex_ref[0]))/2, repr(data), field['name'], mandatory_parameters[field['name']]
return mandatory_parameters
def decode_optional_parameters(hex_ref):
optional_parameters = []
hex = hex_ref[0]
while len(hex) > 0:
(tag_hex, length_hex, rest) = (hex[0:4], hex[4:8], hex[8: ])
tag = optional_parameter_tag_name_by_hex(tag_hex)
if tag == None:
tag = tag_hex
length = int(length_hex, 16)
(value_hex, tail) = (rest[0:length*2], rest[length*2: ])
if len(value_hex) == 0:
value = None
else:
value = decode_hex_type(value_hex, optional_parameter_tag_type_by_hex(tag_hex))
hex = tail
optional_parameters.append({'tag':tag, 'length':length, 'value':value})
return optional_parameters
def decode_hex_type(hex, type, count=0, hex_ref=['']):
if hex == None:
return hex
elif type == 'integer':
return int(hex, 16)
elif type == 'string':
return re.sub('00','',hex).decode('hex')
elif type == 'xstring':
return hex.decode('hex')
elif (type == 'dest_address'
or type == 'unsuccess_sme'):
list = []
fields = mandatory_parameter_list_by_command_name(type)
for i in range(count):
item = decode_mandatory_parameters(fields, hex_ref)
if item.get('dest_flag', None) == 1: # 'dest_address' only
subfields = mandatory_parameter_list_by_command_name('sme_dest_address')
rest = decode_mandatory_parameters(subfields, hex_ref)
item.update(rest)
elif item.get('dest_flag', None) == 2: # 'dest_address' only
subfields = mandatory_parameter_list_by_command_name('distribution_list')
rest = decode_mandatory_parameters(subfields, hex_ref)
item.update(rest)
list.append(item)
return list
else:
return hex
def octpop(hex_ref):
octet = None
if len(hex_ref[0]) > 1:
(octet, hex_ref[0]) = (hex_ref[0][0:2], hex_ref[0][2: ])
return octet
#### Encoding functions #######################################################
def pack_pdu(pdu_obj):
return binascii.a2b_hex(encode_pdu(pdu_obj))
def encode_pdu(pdu_obj):
header = pdu_obj.get('header', {})
body = pdu_obj.get('body', {})
mandatory = body.get('mandatory_parameters', {})
optional = body.get('optional_parameters', [])
body_hex = ''
fields = mandatory_parameter_list_by_command_name(header['command_id'])
body_hex += encode_mandatory_parameters(mandatory, fields)
for opt in optional:
body_hex += encode_optional_parameter(opt['tag'], opt['value'])
actual_length = 16 + len(body_hex)/2
command_length = '%08x' % actual_length
command_id = command_id_hex_by_name(header['command_id'])
command_status = command_status_hex_by_name(header['command_status'])
sequence_number = '%08x' % header['sequence_number']
pdu_hex = command_length + command_id + command_status + sequence_number + body_hex
return pdu_hex
def encode_mandatory_parameters(mandatory_obj, fields):
mandatory_hex_array = []
index_names = {}
index = 0
for field in fields:
param = mandatory_obj.get(field['name'], None)
param_length = None
if param != None or field['min'] > 0:
map = None
if field['map'] != None:
map = maps.get(field['map']+'_by_name', None)
if isinstance(param, list):
hex_list = []
for item in param:
flagfields = mandatory_parameter_list_by_command_name(field['type'])
plusfields = []
if item.get('dest_flag', None) == 1:
plusfields = mandatory_parameter_list_by_command_name('sme_dest_address')
elif item.get('dest_flag', None) == 2:
plusfields = mandatory_parameter_list_by_command_name('distribution_list')
hex_item = encode_mandatory_parameters(item, flagfields + plusfields)
if isinstance(hex_item, str) and len(hex_item) > 0:
hex_list.append(hex_item)
param_length = len(hex_list)
mandatory_hex_array.append(''.join(hex_list))
else:
hex_param = encode_param_type(
param, field['type'], field['min'], field['max'], map)
param_length = len(hex_param)/2
mandatory_hex_array.append(hex_param)
index_names[field['name']] = index
length_index = index_names.get(field['var'], None)
if length_index != None and param_length != None:
mandatory_hex_array[length_index] = encode_param_type(
param_length,
'integer',
len(mandatory_hex_array[length_index])/2)
index += 1
return ''.join(mandatory_hex_array)
def encode_optional_parameter(tag, value):
optional_hex_array = []
tag_hex = optional_parameter_tag_hex_by_name(tag)
if tag_hex != None:
value_hex = encode_param_type(
value,
optional_parameter_tag_type_by_hex(tag_hex))
length_hex = '%04x' % (len(value_hex)/2)
optional_hex_array.append(tag_hex + length_hex + value_hex)
return ''.join(optional_hex_array)
def encode_param_type(param, type, min=0, max=None, map=None):
if param == None:
hex = None
elif map != None:
if type == 'integer' and isinstance(param, int):
hex = ('%0'+str(min*2)+'x') % param
else:
hex = map.get(param, ('%0'+str(min*2)+'x') % 0)
elif type == 'integer':
hex = ('%0'+str(min*2)+'x') % int(param)
+ print "HEX: ",hex
elif type == 'string':
hex = param.encode('hex') + '00'
elif type == 'xstring':
hex = param.encode('hex')
elif type == 'bitmask':
hex = param
elif type == 'hex':
hex = param
else:
hex = None
#if hex == None:
#hex = ''
#if min > 0:
#hex = ('%0'+str(min*2)+'x') % 0
#print type, min, max, repr(param), hex, map
return hex
diff --git a/test/test_multipart.py b/test/test_multipart.py
index 2300453..885924f 100644
--- a/test/test_multipart.py
+++ b/test/test_multipart.py
@@ -1,92 +1,94 @@
import operator
from smpp.pdu_builder import *
#from twisted.trial.unittest import TestCase
tlv = DeliverSM(1, short_message='the first message part')
tlv.set_sar_msg_ref_num(65017)
-tlv.set_sar_total_segments(22)
-tlv.set_sar_segment_seqnum(21)
+tlv.set_sar_total_segments(2)
+tlv.set_sar_segment_seqnum(1)
sar = DeliverSM(1, short_message='\x00\x03\xff\x02\x01the first message part')
csm = DeliverSM(1, short_message='\x05\x00\x03\xff\x02\x01the first message part')
csm16 = DeliverSM(1, short_message='\x06\x00\x04\xff\xff\x02\x01the first message part')
def detect_multipart(pdu):
short_message = pdu['body']['mandatory_parameters']['short_message']
optional_parameters = {}
for d in pdu['body'].get('optional_parameters',[]):
optional_parameters[d['tag']] = d['value']
#print repr(pdu)
try:
mdict = {'multipart_type':'TLV'}
mdict['reference_number'] = optional_parameters['sar_msg_ref_num']
mdict['total_number'] = optional_parameters['sar_total_segments']
mdict['part_number'] = optional_parameters['sar_segment_seqnum']
mdict['part_message'] = short_message
return mdict
except:
pass
if (short_message[0:1] == '\x00'
and short_message[1:2] == '\x03'
and len(short_message) >= 5):
mdict = {'multipart_type':'SAR'}
mdict['reference_number'] = int(binascii.b2a_hex(short_message[2:3]), 16)
mdict['total_number'] = int(binascii.b2a_hex(short_message[3:4]), 16)
mdict['part_number'] = int(binascii.b2a_hex(short_message[4:5]), 16)
mdict['part_message'] = short_message[5:]
return mdict
if (short_message[0:1] == '\x05'
and short_message[1:2] == '\x00'
and short_message[2:3] == '\x03'
and len(short_message) >= 6):
mdict = {'multipart_type':'CSM'}
mdict['reference_number'] = int(binascii.b2a_hex(short_message[3:4]), 16)
mdict['total_number'] = int(binascii.b2a_hex(short_message[4:5]), 16)
mdict['part_number'] = int(binascii.b2a_hex(short_message[5:6]), 16)
mdict['part_message'] = short_message[6:]
return mdict
if (short_message[0:1] == '\x06'
and short_message[1:2] == '\x00'
and short_message[2:3] == '\x04'
and len(short_message) >= 7):
mdict = {'multipart_type':'CSM16'}
mdict['reference_number'] = int(binascii.b2a_hex(short_message[3:5]), 16)
mdict['total_number'] = int(binascii.b2a_hex(short_message[5:6]), 16)
mdict['part_number'] = int(binascii.b2a_hex(short_message[6:7]), 16)
mdict['part_message'] = short_message[7:]
return mdict
return None
print '\n', detect_multipart(unpack_pdu(tlv.get_bin()))
+
+quit()
print '\n', detect_multipart(unpack_pdu(sar.get_bin()))
print '\n', detect_multipart(unpack_pdu(csm.get_bin()))
print '\n', detect_multipart(unpack_pdu(csm16.get_bin()))
sar_1 = DeliverSM(1, short_message='\x00\x03\xff\x04\x01There she was just a')
sar_2 = DeliverSM(1, short_message='\x00\x03\xff\x04\x02 walking down the street,')
sar_3 = DeliverSM(1, short_message='\x00\x03\xff\x04\x03 singing doo wa diddy')
sar_4 = DeliverSM(1, short_message='\x00\x03\xff\x04\x04 diddy dum diddy do')
mess_list = []
mess_list.append(detect_multipart(unpack_pdu(sar_3.get_bin())))
mess_list.append(detect_multipart(unpack_pdu(sar_4.get_bin())))
mess_list.append(detect_multipart(unpack_pdu(sar_2.get_bin())))
mess_list.append(detect_multipart(unpack_pdu(sar_1.get_bin())))
print mess_list
print ''.join([i['part_message'] for i in mess_list])
print '\n'
mess_list.sort(key=operator.itemgetter('part_number'))
print mess_list
print ''.join([i['part_message'] for i in mess_list])
|
dmaclay/python-smpp
|
85910201927d7beb8f7add50d7e0d80a7eb678d8
|
all sar_
|
diff --git a/smpp/pdu_builder.py b/smpp/pdu_builder.py
index 75acd20..e143905 100644
--- a/smpp/pdu_builder.py
+++ b/smpp/pdu_builder.py
@@ -1,352 +1,358 @@
from pdu import *
class PDU(object):
def __init__(self,
command_id,
command_status,
sequence_number,
**kwargs):
super(PDU, self).__init__()
self.obj = {}
self.obj['header'] = {}
self.obj['header']['command_length'] = 0
self.obj['header']['command_id'] = command_id
self.obj['header']['command_status'] = command_status
self.obj['header']['sequence_number'] = sequence_number
def __add_optional_parameter(self, tag, value):
if self.obj.get('body') == None:
self.obj['body'] = {}
if self.obj['body'].get('optional_parameters') == None:
self.obj['body']['optional_parameters'] = []
self.obj['body']['optional_parameters'].append({
'tag':tag,
'length':0,
'value':value,
})
def set_sar_msg_ref_num(self, value):
self.__add_optional_parameter('sar_msg_ref_num', value)
+ def set_sar_segment_seqnum(self, value):
+ self.__add_optional_parameter('sar_segment_seqnum', value)
+
+ def set_sar_total_segments(self, value):
+ self.__add_optional_parameter('sar_total_segments', value)
+
def get_obj(self):
return self.obj
def get_hex(self):
return encode_pdu(self.obj)
def get_bin(self):
return pack_pdu(self.obj)
class Bind(PDU):
def __init__(self,
command_id,
sequence_number,
system_id = '',
password = '',
system_type = '',
interface_version = '34',
addr_ton = 0,
addr_npi = 0,
address_range = '',
**kwargs):
super(Bind, self).__init__(
command_id,
'ESME_ROK',
sequence_number,
)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['system_id'] = system_id
self.obj['body']['mandatory_parameters']['password'] = password
self.obj['body']['mandatory_parameters']['system_type'] = system_type
self.obj['body']['mandatory_parameters']['interface_version'] = interface_version
self.obj['body']['mandatory_parameters']['addr_ton'] = addr_ton
self.obj['body']['mandatory_parameters']['addr_npi'] = addr_npi
self.obj['body']['mandatory_parameters']['address_range'] = address_range
class BindTransmitter(Bind):
def __init__(self,
sequence_number,
**kwargs):
super(BindTransmitter, self).__init__('bind_transmitter', sequence_number, **kwargs)
class BindReceiver(Bind):
def __init__(self,
sequence_number,
**kwargs):
super(BindReceiver, self).__init__('bind_receiver', sequence_number, **kwargs)
class BindTransceiver(Bind):
def __init__(self,
sequence_number,
**kwargs):
super(BindTransceiver, self).__init__('bind_transceiver', sequence_number, **kwargs)
class BindResp(PDU):
def __init__(self,
command_id,
sequence_number,
system_id = '',
**kwargs):
super(BindResp, self).__init__(
command_id,
'ESME_ROK',
sequence_number,
)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['system_id'] = system_id
class BindTransmitterResp(BindResp):
def __init__(self,
sequence_number,
**kwargs):
super(BindTransmitterResp, self).__init__('bind_transmitter_resp', sequence_number, **kwargs)
class BindReceiverResp(BindResp):
def __init__(self,
sequence_number,
**kwargs):
super(BindReceiverResp, self).__init__('bind_receiver_resp', sequence_number, **kwargs)
class BindTransceiverResp(BindResp):
def __init__(self,
sequence_number,
**kwargs):
super(BindTransceiverResp, self).__init__('bind_transceiver_resp', sequence_number, **kwargs)
class Unbind(PDU):
def __init__(self,
sequence_number,
**kwargs):
super(Unbind, self).__init__('unbind', 'ESME_ROK', sequence_number, **kwargs)
class SM1(PDU):
def __init__(self,
command_id,
sequence_number,
service_type = '',
source_addr_ton = 0,
source_addr_npi = 0,
source_addr = '',
esm_class = 0,
protocol_id = 0,
priority_flag = 0,
schedule_delivery_time = '',
validity_period = '',
registered_delivery = 0,
replace_if_present_flag = 0,
data_coding = 0,
sm_default_msg_id = 0,
sm_length = 0,
short_message = None,
**kwargs):
super(SM1, self).__init__(
command_id,
'ESME_ROK',
sequence_number,
)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['service_type'] = service_type
self.obj['body']['mandatory_parameters']['source_addr_ton'] = source_addr_ton
self.obj['body']['mandatory_parameters']['source_addr_npi'] = source_addr_npi
self.obj['body']['mandatory_parameters']['source_addr'] = source_addr
self.obj['body']['mandatory_parameters']['esm_class'] = esm_class
self.obj['body']['mandatory_parameters']['protocol_id'] = protocol_id
self.obj['body']['mandatory_parameters']['priority_flag'] = priority_flag
self.obj['body']['mandatory_parameters']['schedule_delivery_time'] = schedule_delivery_time
self.obj['body']['mandatory_parameters']['validity_period'] = validity_period
self.obj['body']['mandatory_parameters']['registered_delivery'] = registered_delivery
self.obj['body']['mandatory_parameters']['replace_if_present_flag'] = replace_if_present_flag
self.obj['body']['mandatory_parameters']['data_coding'] = data_coding
self.obj['body']['mandatory_parameters']['sm_default_msg_id'] = sm_default_msg_id
self.obj['body']['mandatory_parameters']['sm_length'] = sm_length
self.obj['body']['mandatory_parameters']['short_message'] = short_message
def add_message_payload(self, value):
self.obj['body']['mandatory_parameters']['sm_length'] = 0
self.obj['body']['mandatory_parameters']['short_message'] = None
self._PDU__add_optional_parameter('message_payload', value)
class SubmitMulti(SM1):
def __init__(self,
sequence_number,
number_of_dests = 0,
dest_address = [],
**kwargs):
super(SubmitMulti, self).__init__('submit_multi', sequence_number, **kwargs)
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['number_of_dests'] = number_of_dests
mandatory_parameters['dest_address'] = [] + dest_address
def addDestinationAddress(self,
destination_addr,
dest_addr_ton = 0,
dest_addr_npi = 0,
):
if isinstance(destination_addr, str) and len(destination_addr) > 0:
new_entry = {
'dest_flag':1,
'dest_addr_ton':dest_addr_ton,
'dest_addr_npi':dest_addr_npi,
'destination_addr':destination_addr,
}
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_address'].append(new_entry)
mandatory_parameters['number_of_dests'] = len(
mandatory_parameters['dest_address'])
return True
else:
return False
def addDistributionList(self,
dl_name,
):
if isinstance(dl_name, str) and len(dl_name) > 0:
new_entry = {
'dest_flag':2,
'dl_name':dl_name,
}
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_address'].append(new_entry)
mandatory_parameters['number_of_dests'] = len(
mandatory_parameters['dest_address'])
return True
else:
return False
class SM2(SM1):
def __init__(self,
command_id,
sequence_number,
dest_addr_ton = 0,
dest_addr_npi = 0,
destination_addr = '',
**kwargs):
super(SM2, self).__init__(command_id, sequence_number, **kwargs)
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_addr_ton'] = dest_addr_ton
mandatory_parameters['dest_addr_npi'] = dest_addr_npi
mandatory_parameters['destination_addr'] = destination_addr
class SubmitSM(SM2):
def __init__(self,
sequence_number,
**kwargs):
super(SubmitSM, self).__init__('submit_sm', sequence_number, **kwargs)
class SubmitSMResp(PDU):
def __init__(self,
sequence_number,
message_id,
command_status = 'ESME_ROK',
**kwargs):
super(SubmitSMResp, self).__init__(
'submit_sm_resp',
command_status,
sequence_number,
**kwargs)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['message_id'] = message_id
class DeliverSM(SM2):
def __init__(self,
sequence_number,
**kwargs):
super(DeliverSM, self).__init__('deliver_sm',sequence_number, **kwargs)
class DeliverSMResp(PDU):
def __init__(self,
sequence_number,
message_id = '',
command_status = 'ESME_ROK',
**kwargs):
super(DeliverSMResp, self).__init__(
'deliver_sm_resp',
command_status,
sequence_number,
**kwargs)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['message_id'] = message_id
class EnquireLink(PDU):
def __init__(self,
sequence_number,
**kwargs):
super(EnquireLink, self).__init__(
'enquire_link',
'ESME_ROK',
sequence_number,
**kwargs)
class EnquireLinkResp(PDU):
def __init__(self,
sequence_number,
**kwargs):
super(EnquireLinkResp, self).__init__(
'enquire_link_resp',
'ESME_ROK',
sequence_number,
**kwargs)
class QuerySM(PDU):
def __init__(self,
sequence_number,
message_id,
source_addr = '',
source_addr_ton = 0,
source_addr_npi = 0,
**kwargs):
super(QuerySM, self).__init__(
'query_sm',
'ESME_ROK',
sequence_number,
**kwargs)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['message_id'] = message_id
self.obj['body']['mandatory_parameters']['source_addr'] = source_addr
self.obj['body']['mandatory_parameters']['source_addr_ton'] = source_addr_ton
self.obj['body']['mandatory_parameters']['source_addr_npi'] = source_addr_npi
#bind = BindTransmitter(system_id='test_id', password='abc123')
#print bind.get_obj()
#print bind.get_hex()
#print bind.get_bin()
##print json.dumps(bind.get_obj(), indent=4, sort_keys=True)
##print json.dumps(decode_pdu(bind.get_hex()), indent=4, sort_keys=True)
#print json.dumps(unpack_pdu(bind.get_bin()), indent=4, sort_keys=True)
#sm = SubmitSM(short_message='testing testing')
#print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
#sm.add_message_payload('616263646566676869')
#print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
|
dmaclay/python-smpp
|
f5242eb859a3d06ec20db8b9fd5c81d98f737040
|
sar_msg_ref_num
|
diff --git a/smpp/pdu_builder.py b/smpp/pdu_builder.py
index 5ee37f6..75acd20 100644
--- a/smpp/pdu_builder.py
+++ b/smpp/pdu_builder.py
@@ -1,349 +1,352 @@
from pdu import *
class PDU(object):
def __init__(self,
command_id,
command_status,
sequence_number,
**kwargs):
super(PDU, self).__init__()
self.obj = {}
self.obj['header'] = {}
self.obj['header']['command_length'] = 0
self.obj['header']['command_id'] = command_id
self.obj['header']['command_status'] = command_status
self.obj['header']['sequence_number'] = sequence_number
def __add_optional_parameter(self, tag, value):
if self.obj.get('body') == None:
self.obj['body'] = {}
if self.obj['body'].get('optional_parameters') == None:
self.obj['body']['optional_parameters'] = []
self.obj['body']['optional_parameters'].append({
'tag':tag,
'length':0,
'value':value,
})
+ def set_sar_msg_ref_num(self, value):
+ self.__add_optional_parameter('sar_msg_ref_num', value)
+
def get_obj(self):
return self.obj
def get_hex(self):
return encode_pdu(self.obj)
def get_bin(self):
return pack_pdu(self.obj)
class Bind(PDU):
def __init__(self,
command_id,
sequence_number,
system_id = '',
password = '',
system_type = '',
interface_version = '34',
addr_ton = 0,
addr_npi = 0,
address_range = '',
**kwargs):
super(Bind, self).__init__(
command_id,
'ESME_ROK',
sequence_number,
)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['system_id'] = system_id
self.obj['body']['mandatory_parameters']['password'] = password
self.obj['body']['mandatory_parameters']['system_type'] = system_type
self.obj['body']['mandatory_parameters']['interface_version'] = interface_version
self.obj['body']['mandatory_parameters']['addr_ton'] = addr_ton
self.obj['body']['mandatory_parameters']['addr_npi'] = addr_npi
self.obj['body']['mandatory_parameters']['address_range'] = address_range
class BindTransmitter(Bind):
def __init__(self,
sequence_number,
**kwargs):
super(BindTransmitter, self).__init__('bind_transmitter', sequence_number, **kwargs)
class BindReceiver(Bind):
def __init__(self,
sequence_number,
**kwargs):
super(BindReceiver, self).__init__('bind_receiver', sequence_number, **kwargs)
class BindTransceiver(Bind):
def __init__(self,
sequence_number,
**kwargs):
super(BindTransceiver, self).__init__('bind_transceiver', sequence_number, **kwargs)
class BindResp(PDU):
def __init__(self,
command_id,
sequence_number,
system_id = '',
**kwargs):
super(BindResp, self).__init__(
command_id,
'ESME_ROK',
sequence_number,
)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['system_id'] = system_id
class BindTransmitterResp(BindResp):
def __init__(self,
sequence_number,
**kwargs):
super(BindTransmitterResp, self).__init__('bind_transmitter_resp', sequence_number, **kwargs)
class BindReceiverResp(BindResp):
def __init__(self,
sequence_number,
**kwargs):
super(BindReceiverResp, self).__init__('bind_receiver_resp', sequence_number, **kwargs)
class BindTransceiverResp(BindResp):
def __init__(self,
sequence_number,
**kwargs):
super(BindTransceiverResp, self).__init__('bind_transceiver_resp', sequence_number, **kwargs)
class Unbind(PDU):
def __init__(self,
sequence_number,
**kwargs):
super(Unbind, self).__init__('unbind', 'ESME_ROK', sequence_number, **kwargs)
class SM1(PDU):
def __init__(self,
command_id,
sequence_number,
service_type = '',
source_addr_ton = 0,
source_addr_npi = 0,
source_addr = '',
esm_class = 0,
protocol_id = 0,
priority_flag = 0,
schedule_delivery_time = '',
validity_period = '',
registered_delivery = 0,
replace_if_present_flag = 0,
data_coding = 0,
sm_default_msg_id = 0,
sm_length = 0,
short_message = None,
**kwargs):
super(SM1, self).__init__(
command_id,
'ESME_ROK',
sequence_number,
)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['service_type'] = service_type
self.obj['body']['mandatory_parameters']['source_addr_ton'] = source_addr_ton
self.obj['body']['mandatory_parameters']['source_addr_npi'] = source_addr_npi
self.obj['body']['mandatory_parameters']['source_addr'] = source_addr
self.obj['body']['mandatory_parameters']['esm_class'] = esm_class
self.obj['body']['mandatory_parameters']['protocol_id'] = protocol_id
self.obj['body']['mandatory_parameters']['priority_flag'] = priority_flag
self.obj['body']['mandatory_parameters']['schedule_delivery_time'] = schedule_delivery_time
self.obj['body']['mandatory_parameters']['validity_period'] = validity_period
self.obj['body']['mandatory_parameters']['registered_delivery'] = registered_delivery
self.obj['body']['mandatory_parameters']['replace_if_present_flag'] = replace_if_present_flag
self.obj['body']['mandatory_parameters']['data_coding'] = data_coding
self.obj['body']['mandatory_parameters']['sm_default_msg_id'] = sm_default_msg_id
self.obj['body']['mandatory_parameters']['sm_length'] = sm_length
self.obj['body']['mandatory_parameters']['short_message'] = short_message
def add_message_payload(self, value):
self.obj['body']['mandatory_parameters']['sm_length'] = 0
self.obj['body']['mandatory_parameters']['short_message'] = None
self._PDU__add_optional_parameter('message_payload', value)
class SubmitMulti(SM1):
def __init__(self,
sequence_number,
number_of_dests = 0,
dest_address = [],
**kwargs):
super(SubmitMulti, self).__init__('submit_multi', sequence_number, **kwargs)
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['number_of_dests'] = number_of_dests
mandatory_parameters['dest_address'] = [] + dest_address
def addDestinationAddress(self,
destination_addr,
dest_addr_ton = 0,
dest_addr_npi = 0,
):
if isinstance(destination_addr, str) and len(destination_addr) > 0:
new_entry = {
'dest_flag':1,
'dest_addr_ton':dest_addr_ton,
'dest_addr_npi':dest_addr_npi,
'destination_addr':destination_addr,
}
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_address'].append(new_entry)
mandatory_parameters['number_of_dests'] = len(
mandatory_parameters['dest_address'])
return True
else:
return False
def addDistributionList(self,
dl_name,
):
if isinstance(dl_name, str) and len(dl_name) > 0:
new_entry = {
'dest_flag':2,
'dl_name':dl_name,
}
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_address'].append(new_entry)
mandatory_parameters['number_of_dests'] = len(
mandatory_parameters['dest_address'])
return True
else:
return False
class SM2(SM1):
def __init__(self,
command_id,
sequence_number,
dest_addr_ton = 0,
dest_addr_npi = 0,
destination_addr = '',
**kwargs):
super(SM2, self).__init__(command_id, sequence_number, **kwargs)
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_addr_ton'] = dest_addr_ton
mandatory_parameters['dest_addr_npi'] = dest_addr_npi
mandatory_parameters['destination_addr'] = destination_addr
class SubmitSM(SM2):
def __init__(self,
sequence_number,
**kwargs):
super(SubmitSM, self).__init__('submit_sm', sequence_number, **kwargs)
class SubmitSMResp(PDU):
def __init__(self,
sequence_number,
message_id,
command_status = 'ESME_ROK',
**kwargs):
super(SubmitSMResp, self).__init__(
'submit_sm_resp',
command_status,
sequence_number,
**kwargs)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['message_id'] = message_id
class DeliverSM(SM2):
def __init__(self,
sequence_number,
**kwargs):
super(DeliverSM, self).__init__('deliver_sm',sequence_number, **kwargs)
class DeliverSMResp(PDU):
def __init__(self,
sequence_number,
message_id = '',
command_status = 'ESME_ROK',
**kwargs):
super(DeliverSMResp, self).__init__(
'deliver_sm_resp',
command_status,
sequence_number,
**kwargs)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['message_id'] = message_id
class EnquireLink(PDU):
def __init__(self,
sequence_number,
**kwargs):
super(EnquireLink, self).__init__(
'enquire_link',
'ESME_ROK',
sequence_number,
**kwargs)
class EnquireLinkResp(PDU):
def __init__(self,
sequence_number,
**kwargs):
super(EnquireLinkResp, self).__init__(
'enquire_link_resp',
'ESME_ROK',
sequence_number,
**kwargs)
class QuerySM(PDU):
def __init__(self,
sequence_number,
message_id,
source_addr = '',
source_addr_ton = 0,
source_addr_npi = 0,
**kwargs):
super(QuerySM, self).__init__(
'query_sm',
'ESME_ROK',
sequence_number,
**kwargs)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['message_id'] = message_id
self.obj['body']['mandatory_parameters']['source_addr'] = source_addr
self.obj['body']['mandatory_parameters']['source_addr_ton'] = source_addr_ton
self.obj['body']['mandatory_parameters']['source_addr_npi'] = source_addr_npi
#bind = BindTransmitter(system_id='test_id', password='abc123')
#print bind.get_obj()
#print bind.get_hex()
#print bind.get_bin()
##print json.dumps(bind.get_obj(), indent=4, sort_keys=True)
##print json.dumps(decode_pdu(bind.get_hex()), indent=4, sort_keys=True)
#print json.dumps(unpack_pdu(bind.get_bin()), indent=4, sort_keys=True)
#sm = SubmitSM(short_message='testing testing')
#print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
#sm.add_message_payload('616263646566676869')
#print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
|
dmaclay/python-smpp
|
95bd7fe6ac9a26cba5258cd0da445eef034a13db
|
better message_id treatment
|
diff --git a/smpp/pdu_builder.py b/smpp/pdu_builder.py
index 0bb3114..5ee37f6 100644
--- a/smpp/pdu_builder.py
+++ b/smpp/pdu_builder.py
@@ -1,348 +1,349 @@
from pdu import *
class PDU(object):
def __init__(self,
command_id,
command_status,
sequence_number,
**kwargs):
super(PDU, self).__init__()
self.obj = {}
self.obj['header'] = {}
self.obj['header']['command_length'] = 0
self.obj['header']['command_id'] = command_id
self.obj['header']['command_status'] = command_status
self.obj['header']['sequence_number'] = sequence_number
def __add_optional_parameter(self, tag, value):
if self.obj.get('body') == None:
self.obj['body'] = {}
if self.obj['body'].get('optional_parameters') == None:
self.obj['body']['optional_parameters'] = []
self.obj['body']['optional_parameters'].append({
'tag':tag,
'length':0,
'value':value,
})
def get_obj(self):
return self.obj
def get_hex(self):
return encode_pdu(self.obj)
def get_bin(self):
return pack_pdu(self.obj)
class Bind(PDU):
def __init__(self,
command_id,
sequence_number,
system_id = '',
password = '',
system_type = '',
interface_version = '34',
addr_ton = 0,
addr_npi = 0,
address_range = '',
**kwargs):
super(Bind, self).__init__(
command_id,
'ESME_ROK',
sequence_number,
)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['system_id'] = system_id
self.obj['body']['mandatory_parameters']['password'] = password
self.obj['body']['mandatory_parameters']['system_type'] = system_type
self.obj['body']['mandatory_parameters']['interface_version'] = interface_version
self.obj['body']['mandatory_parameters']['addr_ton'] = addr_ton
self.obj['body']['mandatory_parameters']['addr_npi'] = addr_npi
self.obj['body']['mandatory_parameters']['address_range'] = address_range
class BindTransmitter(Bind):
def __init__(self,
sequence_number,
**kwargs):
super(BindTransmitter, self).__init__('bind_transmitter', sequence_number, **kwargs)
class BindReceiver(Bind):
def __init__(self,
sequence_number,
**kwargs):
super(BindReceiver, self).__init__('bind_receiver', sequence_number, **kwargs)
class BindTransceiver(Bind):
def __init__(self,
sequence_number,
**kwargs):
super(BindTransceiver, self).__init__('bind_transceiver', sequence_number, **kwargs)
class BindResp(PDU):
def __init__(self,
command_id,
sequence_number,
system_id = '',
**kwargs):
super(BindResp, self).__init__(
command_id,
'ESME_ROK',
sequence_number,
)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['system_id'] = system_id
class BindTransmitterResp(BindResp):
def __init__(self,
sequence_number,
**kwargs):
super(BindTransmitterResp, self).__init__('bind_transmitter_resp', sequence_number, **kwargs)
class BindReceiverResp(BindResp):
def __init__(self,
sequence_number,
**kwargs):
super(BindReceiverResp, self).__init__('bind_receiver_resp', sequence_number, **kwargs)
class BindTransceiverResp(BindResp):
def __init__(self,
sequence_number,
**kwargs):
super(BindTransceiverResp, self).__init__('bind_transceiver_resp', sequence_number, **kwargs)
class Unbind(PDU):
def __init__(self,
sequence_number,
**kwargs):
super(Unbind, self).__init__('unbind', 'ESME_ROK', sequence_number, **kwargs)
class SM1(PDU):
def __init__(self,
command_id,
sequence_number,
service_type = '',
source_addr_ton = 0,
source_addr_npi = 0,
source_addr = '',
esm_class = 0,
protocol_id = 0,
priority_flag = 0,
schedule_delivery_time = '',
validity_period = '',
registered_delivery = 0,
replace_if_present_flag = 0,
data_coding = 0,
sm_default_msg_id = 0,
sm_length = 0,
short_message = None,
**kwargs):
super(SM1, self).__init__(
command_id,
'ESME_ROK',
sequence_number,
)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['service_type'] = service_type
self.obj['body']['mandatory_parameters']['source_addr_ton'] = source_addr_ton
self.obj['body']['mandatory_parameters']['source_addr_npi'] = source_addr_npi
self.obj['body']['mandatory_parameters']['source_addr'] = source_addr
self.obj['body']['mandatory_parameters']['esm_class'] = esm_class
self.obj['body']['mandatory_parameters']['protocol_id'] = protocol_id
self.obj['body']['mandatory_parameters']['priority_flag'] = priority_flag
self.obj['body']['mandatory_parameters']['schedule_delivery_time'] = schedule_delivery_time
self.obj['body']['mandatory_parameters']['validity_period'] = validity_period
self.obj['body']['mandatory_parameters']['registered_delivery'] = registered_delivery
self.obj['body']['mandatory_parameters']['replace_if_present_flag'] = replace_if_present_flag
self.obj['body']['mandatory_parameters']['data_coding'] = data_coding
self.obj['body']['mandatory_parameters']['sm_default_msg_id'] = sm_default_msg_id
self.obj['body']['mandatory_parameters']['sm_length'] = sm_length
self.obj['body']['mandatory_parameters']['short_message'] = short_message
def add_message_payload(self, value):
self.obj['body']['mandatory_parameters']['sm_length'] = 0
self.obj['body']['mandatory_parameters']['short_message'] = None
self._PDU__add_optional_parameter('message_payload', value)
class SubmitMulti(SM1):
def __init__(self,
sequence_number,
number_of_dests = 0,
dest_address = [],
**kwargs):
super(SubmitMulti, self).__init__('submit_multi', sequence_number, **kwargs)
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['number_of_dests'] = number_of_dests
mandatory_parameters['dest_address'] = [] + dest_address
def addDestinationAddress(self,
destination_addr,
dest_addr_ton = 0,
dest_addr_npi = 0,
):
if isinstance(destination_addr, str) and len(destination_addr) > 0:
new_entry = {
'dest_flag':1,
'dest_addr_ton':dest_addr_ton,
'dest_addr_npi':dest_addr_npi,
'destination_addr':destination_addr,
}
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_address'].append(new_entry)
mandatory_parameters['number_of_dests'] = len(
mandatory_parameters['dest_address'])
return True
else:
return False
def addDistributionList(self,
dl_name,
):
if isinstance(dl_name, str) and len(dl_name) > 0:
new_entry = {
'dest_flag':2,
'dl_name':dl_name,
}
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_address'].append(new_entry)
mandatory_parameters['number_of_dests'] = len(
mandatory_parameters['dest_address'])
return True
else:
return False
class SM2(SM1):
def __init__(self,
command_id,
sequence_number,
dest_addr_ton = 0,
dest_addr_npi = 0,
destination_addr = '',
**kwargs):
super(SM2, self).__init__(command_id, sequence_number, **kwargs)
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_addr_ton'] = dest_addr_ton
mandatory_parameters['dest_addr_npi'] = dest_addr_npi
mandatory_parameters['destination_addr'] = destination_addr
class SubmitSM(SM2):
def __init__(self,
sequence_number,
**kwargs):
super(SubmitSM, self).__init__('submit_sm', sequence_number, **kwargs)
class SubmitSMResp(PDU):
def __init__(self,
sequence_number,
message_id,
command_status = 'ESME_ROK',
**kwargs):
super(SubmitSMResp, self).__init__(
'submit_sm_resp',
command_status,
sequence_number,
**kwargs)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['message_id'] = message_id
class DeliverSM(SM2):
def __init__(self,
sequence_number,
**kwargs):
super(DeliverSM, self).__init__('deliver_sm',sequence_number, **kwargs)
class DeliverSMResp(PDU):
def __init__(self,
sequence_number,
+ message_id = '',
command_status = 'ESME_ROK',
**kwargs):
super(DeliverSMResp, self).__init__(
'deliver_sm_resp',
command_status,
sequence_number,
**kwargs)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
- self.obj['body']['mandatory_parameters']['message_id'] = ''
+ self.obj['body']['mandatory_parameters']['message_id'] = message_id
class EnquireLink(PDU):
def __init__(self,
sequence_number,
**kwargs):
super(EnquireLink, self).__init__(
'enquire_link',
'ESME_ROK',
sequence_number,
**kwargs)
class EnquireLinkResp(PDU):
def __init__(self,
sequence_number,
**kwargs):
super(EnquireLinkResp, self).__init__(
'enquire_link_resp',
'ESME_ROK',
sequence_number,
**kwargs)
class QuerySM(PDU):
def __init__(self,
sequence_number,
message_id,
source_addr = '',
source_addr_ton = 0,
source_addr_npi = 0,
**kwargs):
super(QuerySM, self).__init__(
'query_sm',
'ESME_ROK',
sequence_number,
**kwargs)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['message_id'] = message_id
self.obj['body']['mandatory_parameters']['source_addr'] = source_addr
self.obj['body']['mandatory_parameters']['source_addr_ton'] = source_addr_ton
self.obj['body']['mandatory_parameters']['source_addr_npi'] = source_addr_npi
#bind = BindTransmitter(system_id='test_id', password='abc123')
#print bind.get_obj()
#print bind.get_hex()
#print bind.get_bin()
##print json.dumps(bind.get_obj(), indent=4, sort_keys=True)
##print json.dumps(decode_pdu(bind.get_hex()), indent=4, sort_keys=True)
#print json.dumps(unpack_pdu(bind.get_bin()), indent=4, sort_keys=True)
#sm = SubmitSM(short_message='testing testing')
#print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
#sm.add_message_payload('616263646566676869')
#print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
|
dmaclay/python-smpp
|
4b8e978fc41146556849c0fc785d2484a5a4fa9e
|
fix messsage_id
|
diff --git a/smpp/pdu_builder.py b/smpp/pdu_builder.py
index 5fbeb9b..0bb3114 100644
--- a/smpp/pdu_builder.py
+++ b/smpp/pdu_builder.py
@@ -1,347 +1,348 @@
from pdu import *
class PDU(object):
def __init__(self,
command_id,
command_status,
sequence_number,
**kwargs):
super(PDU, self).__init__()
self.obj = {}
self.obj['header'] = {}
self.obj['header']['command_length'] = 0
self.obj['header']['command_id'] = command_id
self.obj['header']['command_status'] = command_status
self.obj['header']['sequence_number'] = sequence_number
def __add_optional_parameter(self, tag, value):
if self.obj.get('body') == None:
self.obj['body'] = {}
if self.obj['body'].get('optional_parameters') == None:
self.obj['body']['optional_parameters'] = []
self.obj['body']['optional_parameters'].append({
'tag':tag,
'length':0,
'value':value,
})
def get_obj(self):
return self.obj
def get_hex(self):
return encode_pdu(self.obj)
def get_bin(self):
return pack_pdu(self.obj)
class Bind(PDU):
def __init__(self,
command_id,
sequence_number,
system_id = '',
password = '',
system_type = '',
interface_version = '34',
addr_ton = 0,
addr_npi = 0,
address_range = '',
**kwargs):
super(Bind, self).__init__(
command_id,
'ESME_ROK',
sequence_number,
)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['system_id'] = system_id
self.obj['body']['mandatory_parameters']['password'] = password
self.obj['body']['mandatory_parameters']['system_type'] = system_type
self.obj['body']['mandatory_parameters']['interface_version'] = interface_version
self.obj['body']['mandatory_parameters']['addr_ton'] = addr_ton
self.obj['body']['mandatory_parameters']['addr_npi'] = addr_npi
self.obj['body']['mandatory_parameters']['address_range'] = address_range
class BindTransmitter(Bind):
def __init__(self,
sequence_number,
**kwargs):
super(BindTransmitter, self).__init__('bind_transmitter', sequence_number, **kwargs)
class BindReceiver(Bind):
def __init__(self,
sequence_number,
**kwargs):
super(BindReceiver, self).__init__('bind_receiver', sequence_number, **kwargs)
class BindTransceiver(Bind):
def __init__(self,
sequence_number,
**kwargs):
super(BindTransceiver, self).__init__('bind_transceiver', sequence_number, **kwargs)
class BindResp(PDU):
def __init__(self,
command_id,
sequence_number,
system_id = '',
**kwargs):
super(BindResp, self).__init__(
command_id,
'ESME_ROK',
sequence_number,
)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['system_id'] = system_id
class BindTransmitterResp(BindResp):
def __init__(self,
sequence_number,
**kwargs):
super(BindTransmitterResp, self).__init__('bind_transmitter_resp', sequence_number, **kwargs)
class BindReceiverResp(BindResp):
def __init__(self,
sequence_number,
**kwargs):
super(BindReceiverResp, self).__init__('bind_receiver_resp', sequence_number, **kwargs)
class BindTransceiverResp(BindResp):
def __init__(self,
sequence_number,
**kwargs):
super(BindTransceiverResp, self).__init__('bind_transceiver_resp', sequence_number, **kwargs)
class Unbind(PDU):
def __init__(self,
sequence_number,
**kwargs):
super(Unbind, self).__init__('unbind', 'ESME_ROK', sequence_number, **kwargs)
class SM1(PDU):
def __init__(self,
command_id,
sequence_number,
service_type = '',
source_addr_ton = 0,
source_addr_npi = 0,
source_addr = '',
esm_class = 0,
protocol_id = 0,
priority_flag = 0,
schedule_delivery_time = '',
validity_period = '',
registered_delivery = 0,
replace_if_present_flag = 0,
data_coding = 0,
sm_default_msg_id = 0,
sm_length = 0,
short_message = None,
**kwargs):
super(SM1, self).__init__(
command_id,
'ESME_ROK',
sequence_number,
)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['service_type'] = service_type
self.obj['body']['mandatory_parameters']['source_addr_ton'] = source_addr_ton
self.obj['body']['mandatory_parameters']['source_addr_npi'] = source_addr_npi
self.obj['body']['mandatory_parameters']['source_addr'] = source_addr
self.obj['body']['mandatory_parameters']['esm_class'] = esm_class
self.obj['body']['mandatory_parameters']['protocol_id'] = protocol_id
self.obj['body']['mandatory_parameters']['priority_flag'] = priority_flag
self.obj['body']['mandatory_parameters']['schedule_delivery_time'] = schedule_delivery_time
self.obj['body']['mandatory_parameters']['validity_period'] = validity_period
self.obj['body']['mandatory_parameters']['registered_delivery'] = registered_delivery
self.obj['body']['mandatory_parameters']['replace_if_present_flag'] = replace_if_present_flag
self.obj['body']['mandatory_parameters']['data_coding'] = data_coding
self.obj['body']['mandatory_parameters']['sm_default_msg_id'] = sm_default_msg_id
self.obj['body']['mandatory_parameters']['sm_length'] = sm_length
self.obj['body']['mandatory_parameters']['short_message'] = short_message
def add_message_payload(self, value):
self.obj['body']['mandatory_parameters']['sm_length'] = 0
self.obj['body']['mandatory_parameters']['short_message'] = None
self._PDU__add_optional_parameter('message_payload', value)
class SubmitMulti(SM1):
def __init__(self,
sequence_number,
number_of_dests = 0,
dest_address = [],
**kwargs):
super(SubmitMulti, self).__init__('submit_multi', sequence_number, **kwargs)
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['number_of_dests'] = number_of_dests
mandatory_parameters['dest_address'] = [] + dest_address
def addDestinationAddress(self,
destination_addr,
dest_addr_ton = 0,
dest_addr_npi = 0,
):
if isinstance(destination_addr, str) and len(destination_addr) > 0:
new_entry = {
'dest_flag':1,
'dest_addr_ton':dest_addr_ton,
'dest_addr_npi':dest_addr_npi,
'destination_addr':destination_addr,
}
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_address'].append(new_entry)
mandatory_parameters['number_of_dests'] = len(
mandatory_parameters['dest_address'])
return True
else:
return False
def addDistributionList(self,
dl_name,
):
if isinstance(dl_name, str) and len(dl_name) > 0:
new_entry = {
'dest_flag':2,
'dl_name':dl_name,
}
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_address'].append(new_entry)
mandatory_parameters['number_of_dests'] = len(
mandatory_parameters['dest_address'])
return True
else:
return False
class SM2(SM1):
def __init__(self,
command_id,
sequence_number,
dest_addr_ton = 0,
dest_addr_npi = 0,
destination_addr = '',
**kwargs):
super(SM2, self).__init__(command_id, sequence_number, **kwargs)
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_addr_ton'] = dest_addr_ton
mandatory_parameters['dest_addr_npi'] = dest_addr_npi
mandatory_parameters['destination_addr'] = destination_addr
class SubmitSM(SM2):
def __init__(self,
sequence_number,
**kwargs):
super(SubmitSM, self).__init__('submit_sm', sequence_number, **kwargs)
class SubmitSMResp(PDU):
def __init__(self,
sequence_number,
+ message_id,
command_status = 'ESME_ROK',
**kwargs):
super(SubmitSMResp, self).__init__(
'submit_sm_resp',
command_status,
sequence_number,
**kwargs)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
- self.obj['body']['mandatory_parameters']['message_id'] = ''
+ self.obj['body']['mandatory_parameters']['message_id'] = message_id
class DeliverSM(SM2):
def __init__(self,
sequence_number,
**kwargs):
super(DeliverSM, self).__init__('deliver_sm',sequence_number, **kwargs)
class DeliverSMResp(PDU):
def __init__(self,
sequence_number,
command_status = 'ESME_ROK',
**kwargs):
super(DeliverSMResp, self).__init__(
'deliver_sm_resp',
command_status,
sequence_number,
**kwargs)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['message_id'] = ''
class EnquireLink(PDU):
def __init__(self,
sequence_number,
**kwargs):
super(EnquireLink, self).__init__(
'enquire_link',
'ESME_ROK',
sequence_number,
**kwargs)
class EnquireLinkResp(PDU):
def __init__(self,
sequence_number,
**kwargs):
super(EnquireLinkResp, self).__init__(
'enquire_link_resp',
'ESME_ROK',
sequence_number,
**kwargs)
class QuerySM(PDU):
def __init__(self,
sequence_number,
message_id,
source_addr = '',
source_addr_ton = 0,
source_addr_npi = 0,
**kwargs):
super(QuerySM, self).__init__(
'query_sm',
'ESME_ROK',
sequence_number,
**kwargs)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['message_id'] = message_id
self.obj['body']['mandatory_parameters']['source_addr'] = source_addr
self.obj['body']['mandatory_parameters']['source_addr_ton'] = source_addr_ton
self.obj['body']['mandatory_parameters']['source_addr_npi'] = source_addr_npi
#bind = BindTransmitter(system_id='test_id', password='abc123')
#print bind.get_obj()
#print bind.get_hex()
#print bind.get_bin()
##print json.dumps(bind.get_obj(), indent=4, sort_keys=True)
##print json.dumps(decode_pdu(bind.get_hex()), indent=4, sort_keys=True)
#print json.dumps(unpack_pdu(bind.get_bin()), indent=4, sort_keys=True)
#sm = SubmitSM(short_message='testing testing')
#print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
#sm.add_message_payload('616263646566676869')
#print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
|
dmaclay/python-smpp
|
f1673c11466f35eeb0b4744604d23028af5141a9
|
submit sm response
|
diff --git a/smpp/pdu_builder.py b/smpp/pdu_builder.py
index aea4a0c..5fbeb9b 100644
--- a/smpp/pdu_builder.py
+++ b/smpp/pdu_builder.py
@@ -1,332 +1,347 @@
from pdu import *
class PDU(object):
def __init__(self,
command_id,
command_status,
sequence_number,
**kwargs):
super(PDU, self).__init__()
self.obj = {}
self.obj['header'] = {}
self.obj['header']['command_length'] = 0
self.obj['header']['command_id'] = command_id
self.obj['header']['command_status'] = command_status
self.obj['header']['sequence_number'] = sequence_number
def __add_optional_parameter(self, tag, value):
if self.obj.get('body') == None:
self.obj['body'] = {}
if self.obj['body'].get('optional_parameters') == None:
self.obj['body']['optional_parameters'] = []
self.obj['body']['optional_parameters'].append({
'tag':tag,
'length':0,
'value':value,
})
def get_obj(self):
return self.obj
def get_hex(self):
return encode_pdu(self.obj)
def get_bin(self):
return pack_pdu(self.obj)
class Bind(PDU):
def __init__(self,
command_id,
sequence_number,
system_id = '',
password = '',
system_type = '',
interface_version = '34',
addr_ton = 0,
addr_npi = 0,
address_range = '',
**kwargs):
super(Bind, self).__init__(
command_id,
'ESME_ROK',
sequence_number,
)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['system_id'] = system_id
self.obj['body']['mandatory_parameters']['password'] = password
self.obj['body']['mandatory_parameters']['system_type'] = system_type
self.obj['body']['mandatory_parameters']['interface_version'] = interface_version
self.obj['body']['mandatory_parameters']['addr_ton'] = addr_ton
self.obj['body']['mandatory_parameters']['addr_npi'] = addr_npi
self.obj['body']['mandatory_parameters']['address_range'] = address_range
class BindTransmitter(Bind):
def __init__(self,
sequence_number,
**kwargs):
super(BindTransmitter, self).__init__('bind_transmitter', sequence_number, **kwargs)
class BindReceiver(Bind):
def __init__(self,
sequence_number,
**kwargs):
super(BindReceiver, self).__init__('bind_receiver', sequence_number, **kwargs)
class BindTransceiver(Bind):
def __init__(self,
sequence_number,
**kwargs):
super(BindTransceiver, self).__init__('bind_transceiver', sequence_number, **kwargs)
class BindResp(PDU):
def __init__(self,
command_id,
sequence_number,
system_id = '',
**kwargs):
super(BindResp, self).__init__(
command_id,
'ESME_ROK',
sequence_number,
)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['system_id'] = system_id
class BindTransmitterResp(BindResp):
def __init__(self,
sequence_number,
**kwargs):
super(BindTransmitterResp, self).__init__('bind_transmitter_resp', sequence_number, **kwargs)
class BindReceiverResp(BindResp):
def __init__(self,
sequence_number,
**kwargs):
super(BindReceiverResp, self).__init__('bind_receiver_resp', sequence_number, **kwargs)
class BindTransceiverResp(BindResp):
def __init__(self,
sequence_number,
**kwargs):
super(BindTransceiverResp, self).__init__('bind_transceiver_resp', sequence_number, **kwargs)
class Unbind(PDU):
def __init__(self,
sequence_number,
**kwargs):
super(Unbind, self).__init__('unbind', 'ESME_ROK', sequence_number, **kwargs)
class SM1(PDU):
def __init__(self,
command_id,
sequence_number,
service_type = '',
source_addr_ton = 0,
source_addr_npi = 0,
source_addr = '',
esm_class = 0,
protocol_id = 0,
priority_flag = 0,
schedule_delivery_time = '',
validity_period = '',
registered_delivery = 0,
replace_if_present_flag = 0,
data_coding = 0,
sm_default_msg_id = 0,
sm_length = 0,
short_message = None,
**kwargs):
super(SM1, self).__init__(
command_id,
'ESME_ROK',
sequence_number,
)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['service_type'] = service_type
self.obj['body']['mandatory_parameters']['source_addr_ton'] = source_addr_ton
self.obj['body']['mandatory_parameters']['source_addr_npi'] = source_addr_npi
self.obj['body']['mandatory_parameters']['source_addr'] = source_addr
self.obj['body']['mandatory_parameters']['esm_class'] = esm_class
self.obj['body']['mandatory_parameters']['protocol_id'] = protocol_id
self.obj['body']['mandatory_parameters']['priority_flag'] = priority_flag
self.obj['body']['mandatory_parameters']['schedule_delivery_time'] = schedule_delivery_time
self.obj['body']['mandatory_parameters']['validity_period'] = validity_period
self.obj['body']['mandatory_parameters']['registered_delivery'] = registered_delivery
self.obj['body']['mandatory_parameters']['replace_if_present_flag'] = replace_if_present_flag
self.obj['body']['mandatory_parameters']['data_coding'] = data_coding
self.obj['body']['mandatory_parameters']['sm_default_msg_id'] = sm_default_msg_id
self.obj['body']['mandatory_parameters']['sm_length'] = sm_length
self.obj['body']['mandatory_parameters']['short_message'] = short_message
def add_message_payload(self, value):
self.obj['body']['mandatory_parameters']['sm_length'] = 0
self.obj['body']['mandatory_parameters']['short_message'] = None
self._PDU__add_optional_parameter('message_payload', value)
class SubmitMulti(SM1):
def __init__(self,
sequence_number,
number_of_dests = 0,
dest_address = [],
**kwargs):
super(SubmitMulti, self).__init__('submit_multi', sequence_number, **kwargs)
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['number_of_dests'] = number_of_dests
mandatory_parameters['dest_address'] = [] + dest_address
def addDestinationAddress(self,
destination_addr,
dest_addr_ton = 0,
dest_addr_npi = 0,
):
if isinstance(destination_addr, str) and len(destination_addr) > 0:
new_entry = {
'dest_flag':1,
'dest_addr_ton':dest_addr_ton,
'dest_addr_npi':dest_addr_npi,
'destination_addr':destination_addr,
}
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_address'].append(new_entry)
mandatory_parameters['number_of_dests'] = len(
mandatory_parameters['dest_address'])
return True
else:
return False
def addDistributionList(self,
dl_name,
):
if isinstance(dl_name, str) and len(dl_name) > 0:
new_entry = {
'dest_flag':2,
'dl_name':dl_name,
}
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_address'].append(new_entry)
mandatory_parameters['number_of_dests'] = len(
mandatory_parameters['dest_address'])
return True
else:
return False
class SM2(SM1):
def __init__(self,
command_id,
sequence_number,
dest_addr_ton = 0,
dest_addr_npi = 0,
destination_addr = '',
**kwargs):
super(SM2, self).__init__(command_id, sequence_number, **kwargs)
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_addr_ton'] = dest_addr_ton
mandatory_parameters['dest_addr_npi'] = dest_addr_npi
mandatory_parameters['destination_addr'] = destination_addr
class SubmitSM(SM2):
def __init__(self,
sequence_number,
**kwargs):
super(SubmitSM, self).__init__('submit_sm', sequence_number, **kwargs)
+class SubmitSMResp(PDU):
+ def __init__(self,
+ sequence_number,
+ command_status = 'ESME_ROK',
+ **kwargs):
+ super(SubmitSMResp, self).__init__(
+ 'submit_sm_resp',
+ command_status,
+ sequence_number,
+ **kwargs)
+ self.obj['body'] = {}
+ self.obj['body']['mandatory_parameters'] = {}
+ self.obj['body']['mandatory_parameters']['message_id'] = ''
+
+
class DeliverSM(SM2):
def __init__(self,
sequence_number,
**kwargs):
super(DeliverSM, self).__init__('deliver_sm',sequence_number, **kwargs)
class DeliverSMResp(PDU):
def __init__(self,
sequence_number,
command_status = 'ESME_ROK',
**kwargs):
super(DeliverSMResp, self).__init__(
'deliver_sm_resp',
command_status,
sequence_number,
**kwargs)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['message_id'] = ''
class EnquireLink(PDU):
def __init__(self,
sequence_number,
**kwargs):
super(EnquireLink, self).__init__(
'enquire_link',
'ESME_ROK',
sequence_number,
**kwargs)
class EnquireLinkResp(PDU):
def __init__(self,
sequence_number,
**kwargs):
super(EnquireLinkResp, self).__init__(
'enquire_link_resp',
'ESME_ROK',
sequence_number,
**kwargs)
class QuerySM(PDU):
def __init__(self,
sequence_number,
message_id,
source_addr = '',
source_addr_ton = 0,
source_addr_npi = 0,
**kwargs):
super(QuerySM, self).__init__(
'query_sm',
'ESME_ROK',
sequence_number,
**kwargs)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['message_id'] = message_id
self.obj['body']['mandatory_parameters']['source_addr'] = source_addr
self.obj['body']['mandatory_parameters']['source_addr_ton'] = source_addr_ton
self.obj['body']['mandatory_parameters']['source_addr_npi'] = source_addr_npi
#bind = BindTransmitter(system_id='test_id', password='abc123')
#print bind.get_obj()
#print bind.get_hex()
#print bind.get_bin()
##print json.dumps(bind.get_obj(), indent=4, sort_keys=True)
##print json.dumps(decode_pdu(bind.get_hex()), indent=4, sort_keys=True)
#print json.dumps(unpack_pdu(bind.get_bin()), indent=4, sort_keys=True)
#sm = SubmitSM(short_message='testing testing')
#print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
#sm.add_message_payload('616263646566676869')
#print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
|
dmaclay/python-smpp
|
d26351e8eccecac32d971222bd0747c54c0f3b58
|
enquire link response
|
diff --git a/smpp/pdu_builder.py b/smpp/pdu_builder.py
index eeca679..aea4a0c 100644
--- a/smpp/pdu_builder.py
+++ b/smpp/pdu_builder.py
@@ -1,321 +1,332 @@
from pdu import *
class PDU(object):
def __init__(self,
command_id,
command_status,
sequence_number,
**kwargs):
super(PDU, self).__init__()
self.obj = {}
self.obj['header'] = {}
self.obj['header']['command_length'] = 0
self.obj['header']['command_id'] = command_id
self.obj['header']['command_status'] = command_status
self.obj['header']['sequence_number'] = sequence_number
def __add_optional_parameter(self, tag, value):
if self.obj.get('body') == None:
self.obj['body'] = {}
if self.obj['body'].get('optional_parameters') == None:
self.obj['body']['optional_parameters'] = []
self.obj['body']['optional_parameters'].append({
'tag':tag,
'length':0,
'value':value,
})
def get_obj(self):
return self.obj
def get_hex(self):
return encode_pdu(self.obj)
def get_bin(self):
return pack_pdu(self.obj)
class Bind(PDU):
def __init__(self,
command_id,
sequence_number,
system_id = '',
password = '',
system_type = '',
interface_version = '34',
addr_ton = 0,
addr_npi = 0,
address_range = '',
**kwargs):
super(Bind, self).__init__(
command_id,
'ESME_ROK',
sequence_number,
)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['system_id'] = system_id
self.obj['body']['mandatory_parameters']['password'] = password
self.obj['body']['mandatory_parameters']['system_type'] = system_type
self.obj['body']['mandatory_parameters']['interface_version'] = interface_version
self.obj['body']['mandatory_parameters']['addr_ton'] = addr_ton
self.obj['body']['mandatory_parameters']['addr_npi'] = addr_npi
self.obj['body']['mandatory_parameters']['address_range'] = address_range
class BindTransmitter(Bind):
def __init__(self,
sequence_number,
**kwargs):
super(BindTransmitter, self).__init__('bind_transmitter', sequence_number, **kwargs)
class BindReceiver(Bind):
def __init__(self,
sequence_number,
**kwargs):
super(BindReceiver, self).__init__('bind_receiver', sequence_number, **kwargs)
class BindTransceiver(Bind):
def __init__(self,
sequence_number,
**kwargs):
super(BindTransceiver, self).__init__('bind_transceiver', sequence_number, **kwargs)
class BindResp(PDU):
def __init__(self,
command_id,
sequence_number,
system_id = '',
**kwargs):
super(BindResp, self).__init__(
command_id,
'ESME_ROK',
sequence_number,
)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['system_id'] = system_id
class BindTransmitterResp(BindResp):
def __init__(self,
sequence_number,
**kwargs):
super(BindTransmitterResp, self).__init__('bind_transmitter_resp', sequence_number, **kwargs)
class BindReceiverResp(BindResp):
def __init__(self,
sequence_number,
**kwargs):
super(BindReceiverResp, self).__init__('bind_receiver_resp', sequence_number, **kwargs)
class BindTransceiverResp(BindResp):
def __init__(self,
sequence_number,
**kwargs):
super(BindTransceiverResp, self).__init__('bind_transceiver_resp', sequence_number, **kwargs)
class Unbind(PDU):
def __init__(self,
sequence_number,
**kwargs):
super(Unbind, self).__init__('unbind', 'ESME_ROK', sequence_number, **kwargs)
class SM1(PDU):
def __init__(self,
command_id,
sequence_number,
service_type = '',
source_addr_ton = 0,
source_addr_npi = 0,
source_addr = '',
esm_class = 0,
protocol_id = 0,
priority_flag = 0,
schedule_delivery_time = '',
validity_period = '',
registered_delivery = 0,
replace_if_present_flag = 0,
data_coding = 0,
sm_default_msg_id = 0,
sm_length = 0,
short_message = None,
**kwargs):
super(SM1, self).__init__(
command_id,
'ESME_ROK',
sequence_number,
)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['service_type'] = service_type
self.obj['body']['mandatory_parameters']['source_addr_ton'] = source_addr_ton
self.obj['body']['mandatory_parameters']['source_addr_npi'] = source_addr_npi
self.obj['body']['mandatory_parameters']['source_addr'] = source_addr
self.obj['body']['mandatory_parameters']['esm_class'] = esm_class
self.obj['body']['mandatory_parameters']['protocol_id'] = protocol_id
self.obj['body']['mandatory_parameters']['priority_flag'] = priority_flag
self.obj['body']['mandatory_parameters']['schedule_delivery_time'] = schedule_delivery_time
self.obj['body']['mandatory_parameters']['validity_period'] = validity_period
self.obj['body']['mandatory_parameters']['registered_delivery'] = registered_delivery
self.obj['body']['mandatory_parameters']['replace_if_present_flag'] = replace_if_present_flag
self.obj['body']['mandatory_parameters']['data_coding'] = data_coding
self.obj['body']['mandatory_parameters']['sm_default_msg_id'] = sm_default_msg_id
self.obj['body']['mandatory_parameters']['sm_length'] = sm_length
self.obj['body']['mandatory_parameters']['short_message'] = short_message
def add_message_payload(self, value):
self.obj['body']['mandatory_parameters']['sm_length'] = 0
self.obj['body']['mandatory_parameters']['short_message'] = None
self._PDU__add_optional_parameter('message_payload', value)
class SubmitMulti(SM1):
def __init__(self,
sequence_number,
number_of_dests = 0,
dest_address = [],
**kwargs):
super(SubmitMulti, self).__init__('submit_multi', sequence_number, **kwargs)
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['number_of_dests'] = number_of_dests
mandatory_parameters['dest_address'] = [] + dest_address
def addDestinationAddress(self,
destination_addr,
dest_addr_ton = 0,
dest_addr_npi = 0,
):
if isinstance(destination_addr, str) and len(destination_addr) > 0:
new_entry = {
'dest_flag':1,
'dest_addr_ton':dest_addr_ton,
'dest_addr_npi':dest_addr_npi,
'destination_addr':destination_addr,
}
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_address'].append(new_entry)
mandatory_parameters['number_of_dests'] = len(
mandatory_parameters['dest_address'])
return True
else:
return False
def addDistributionList(self,
dl_name,
):
if isinstance(dl_name, str) and len(dl_name) > 0:
new_entry = {
'dest_flag':2,
'dl_name':dl_name,
}
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_address'].append(new_entry)
mandatory_parameters['number_of_dests'] = len(
mandatory_parameters['dest_address'])
return True
else:
return False
class SM2(SM1):
def __init__(self,
command_id,
sequence_number,
dest_addr_ton = 0,
dest_addr_npi = 0,
destination_addr = '',
**kwargs):
super(SM2, self).__init__(command_id, sequence_number, **kwargs)
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_addr_ton'] = dest_addr_ton
mandatory_parameters['dest_addr_npi'] = dest_addr_npi
mandatory_parameters['destination_addr'] = destination_addr
class SubmitSM(SM2):
def __init__(self,
sequence_number,
**kwargs):
super(SubmitSM, self).__init__('submit_sm', sequence_number, **kwargs)
class DeliverSM(SM2):
def __init__(self,
sequence_number,
**kwargs):
super(DeliverSM, self).__init__('deliver_sm',sequence_number, **kwargs)
class DeliverSMResp(PDU):
def __init__(self,
sequence_number,
command_status = 'ESME_ROK',
**kwargs):
super(DeliverSMResp, self).__init__(
'deliver_sm_resp',
command_status,
sequence_number,
**kwargs)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['message_id'] = ''
class EnquireLink(PDU):
def __init__(self,
sequence_number,
**kwargs):
super(EnquireLink, self).__init__(
'enquire_link',
'ESME_ROK',
sequence_number,
**kwargs)
+class EnquireLinkResp(PDU):
+ def __init__(self,
+ sequence_number,
+ **kwargs):
+ super(EnquireLinkResp, self).__init__(
+ 'enquire_link_resp',
+ 'ESME_ROK',
+ sequence_number,
+ **kwargs)
+
+
class QuerySM(PDU):
def __init__(self,
sequence_number,
message_id,
source_addr = '',
source_addr_ton = 0,
source_addr_npi = 0,
**kwargs):
super(QuerySM, self).__init__(
'query_sm',
'ESME_ROK',
sequence_number,
**kwargs)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['message_id'] = message_id
self.obj['body']['mandatory_parameters']['source_addr'] = source_addr
self.obj['body']['mandatory_parameters']['source_addr_ton'] = source_addr_ton
self.obj['body']['mandatory_parameters']['source_addr_npi'] = source_addr_npi
#bind = BindTransmitter(system_id='test_id', password='abc123')
#print bind.get_obj()
#print bind.get_hex()
#print bind.get_bin()
##print json.dumps(bind.get_obj(), indent=4, sort_keys=True)
##print json.dumps(decode_pdu(bind.get_hex()), indent=4, sort_keys=True)
#print json.dumps(unpack_pdu(bind.get_bin()), indent=4, sort_keys=True)
#sm = SubmitSM(short_message='testing testing')
#print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
#sm.add_message_payload('616263646566676869')
#print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
|
dmaclay/python-smpp
|
2fa38205f66d6f1f99f3a03be727f7ac6f0894c6
|
bind responses
|
diff --git a/smpp/pdu_builder.py b/smpp/pdu_builder.py
index 1ac7ef7..eeca679 100644
--- a/smpp/pdu_builder.py
+++ b/smpp/pdu_builder.py
@@ -1,284 +1,321 @@
from pdu import *
class PDU(object):
def __init__(self,
command_id,
command_status,
sequence_number,
**kwargs):
super(PDU, self).__init__()
self.obj = {}
self.obj['header'] = {}
self.obj['header']['command_length'] = 0
self.obj['header']['command_id'] = command_id
self.obj['header']['command_status'] = command_status
self.obj['header']['sequence_number'] = sequence_number
def __add_optional_parameter(self, tag, value):
if self.obj.get('body') == None:
self.obj['body'] = {}
if self.obj['body'].get('optional_parameters') == None:
self.obj['body']['optional_parameters'] = []
self.obj['body']['optional_parameters'].append({
'tag':tag,
'length':0,
'value':value,
})
def get_obj(self):
return self.obj
def get_hex(self):
return encode_pdu(self.obj)
def get_bin(self):
return pack_pdu(self.obj)
class Bind(PDU):
def __init__(self,
command_id,
sequence_number,
system_id = '',
password = '',
system_type = '',
interface_version = '34',
addr_ton = 0,
addr_npi = 0,
address_range = '',
**kwargs):
super(Bind, self).__init__(
command_id,
'ESME_ROK',
sequence_number,
)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['system_id'] = system_id
self.obj['body']['mandatory_parameters']['password'] = password
self.obj['body']['mandatory_parameters']['system_type'] = system_type
self.obj['body']['mandatory_parameters']['interface_version'] = interface_version
self.obj['body']['mandatory_parameters']['addr_ton'] = addr_ton
self.obj['body']['mandatory_parameters']['addr_npi'] = addr_npi
self.obj['body']['mandatory_parameters']['address_range'] = address_range
class BindTransmitter(Bind):
def __init__(self,
sequence_number,
**kwargs):
super(BindTransmitter, self).__init__('bind_transmitter', sequence_number, **kwargs)
class BindReceiver(Bind):
def __init__(self,
sequence_number,
**kwargs):
super(BindReceiver, self).__init__('bind_receiver', sequence_number, **kwargs)
class BindTransceiver(Bind):
def __init__(self,
sequence_number,
**kwargs):
super(BindTransceiver, self).__init__('bind_transceiver', sequence_number, **kwargs)
+class BindResp(PDU):
+ def __init__(self,
+ command_id,
+ sequence_number,
+ system_id = '',
+ **kwargs):
+ super(BindResp, self).__init__(
+ command_id,
+ 'ESME_ROK',
+ sequence_number,
+ )
+ self.obj['body'] = {}
+ self.obj['body']['mandatory_parameters'] = {}
+ self.obj['body']['mandatory_parameters']['system_id'] = system_id
+
+
+class BindTransmitterResp(BindResp):
+ def __init__(self,
+ sequence_number,
+ **kwargs):
+ super(BindTransmitterResp, self).__init__('bind_transmitter_resp', sequence_number, **kwargs)
+
+
+class BindReceiverResp(BindResp):
+ def __init__(self,
+ sequence_number,
+ **kwargs):
+ super(BindReceiverResp, self).__init__('bind_receiver_resp', sequence_number, **kwargs)
+
+
+class BindTransceiverResp(BindResp):
+ def __init__(self,
+ sequence_number,
+ **kwargs):
+ super(BindTransceiverResp, self).__init__('bind_transceiver_resp', sequence_number, **kwargs)
+
+
class Unbind(PDU):
def __init__(self,
sequence_number,
**kwargs):
super(Unbind, self).__init__('unbind', 'ESME_ROK', sequence_number, **kwargs)
class SM1(PDU):
def __init__(self,
command_id,
sequence_number,
service_type = '',
source_addr_ton = 0,
source_addr_npi = 0,
source_addr = '',
esm_class = 0,
protocol_id = 0,
priority_flag = 0,
schedule_delivery_time = '',
validity_period = '',
registered_delivery = 0,
replace_if_present_flag = 0,
data_coding = 0,
sm_default_msg_id = 0,
sm_length = 0,
short_message = None,
**kwargs):
super(SM1, self).__init__(
command_id,
'ESME_ROK',
sequence_number,
)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['service_type'] = service_type
self.obj['body']['mandatory_parameters']['source_addr_ton'] = source_addr_ton
self.obj['body']['mandatory_parameters']['source_addr_npi'] = source_addr_npi
self.obj['body']['mandatory_parameters']['source_addr'] = source_addr
self.obj['body']['mandatory_parameters']['esm_class'] = esm_class
self.obj['body']['mandatory_parameters']['protocol_id'] = protocol_id
self.obj['body']['mandatory_parameters']['priority_flag'] = priority_flag
self.obj['body']['mandatory_parameters']['schedule_delivery_time'] = schedule_delivery_time
self.obj['body']['mandatory_parameters']['validity_period'] = validity_period
self.obj['body']['mandatory_parameters']['registered_delivery'] = registered_delivery
self.obj['body']['mandatory_parameters']['replace_if_present_flag'] = replace_if_present_flag
self.obj['body']['mandatory_parameters']['data_coding'] = data_coding
self.obj['body']['mandatory_parameters']['sm_default_msg_id'] = sm_default_msg_id
self.obj['body']['mandatory_parameters']['sm_length'] = sm_length
self.obj['body']['mandatory_parameters']['short_message'] = short_message
def add_message_payload(self, value):
self.obj['body']['mandatory_parameters']['sm_length'] = 0
self.obj['body']['mandatory_parameters']['short_message'] = None
self._PDU__add_optional_parameter('message_payload', value)
class SubmitMulti(SM1):
def __init__(self,
sequence_number,
number_of_dests = 0,
dest_address = [],
**kwargs):
super(SubmitMulti, self).__init__('submit_multi', sequence_number, **kwargs)
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['number_of_dests'] = number_of_dests
mandatory_parameters['dest_address'] = [] + dest_address
def addDestinationAddress(self,
destination_addr,
dest_addr_ton = 0,
dest_addr_npi = 0,
):
if isinstance(destination_addr, str) and len(destination_addr) > 0:
new_entry = {
'dest_flag':1,
'dest_addr_ton':dest_addr_ton,
'dest_addr_npi':dest_addr_npi,
'destination_addr':destination_addr,
}
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_address'].append(new_entry)
mandatory_parameters['number_of_dests'] = len(
mandatory_parameters['dest_address'])
return True
else:
return False
def addDistributionList(self,
dl_name,
):
if isinstance(dl_name, str) and len(dl_name) > 0:
new_entry = {
'dest_flag':2,
'dl_name':dl_name,
}
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_address'].append(new_entry)
mandatory_parameters['number_of_dests'] = len(
mandatory_parameters['dest_address'])
return True
else:
return False
class SM2(SM1):
def __init__(self,
command_id,
sequence_number,
dest_addr_ton = 0,
dest_addr_npi = 0,
destination_addr = '',
**kwargs):
super(SM2, self).__init__(command_id, sequence_number, **kwargs)
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_addr_ton'] = dest_addr_ton
mandatory_parameters['dest_addr_npi'] = dest_addr_npi
mandatory_parameters['destination_addr'] = destination_addr
class SubmitSM(SM2):
def __init__(self,
sequence_number,
**kwargs):
super(SubmitSM, self).__init__('submit_sm', sequence_number, **kwargs)
class DeliverSM(SM2):
def __init__(self,
sequence_number,
**kwargs):
super(DeliverSM, self).__init__('deliver_sm',sequence_number, **kwargs)
class DeliverSMResp(PDU):
def __init__(self,
sequence_number,
command_status = 'ESME_ROK',
**kwargs):
super(DeliverSMResp, self).__init__(
'deliver_sm_resp',
command_status,
sequence_number,
**kwargs)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['message_id'] = ''
class EnquireLink(PDU):
def __init__(self,
sequence_number,
**kwargs):
super(EnquireLink, self).__init__(
'enquire_link',
'ESME_ROK',
sequence_number,
**kwargs)
class QuerySM(PDU):
def __init__(self,
sequence_number,
message_id,
source_addr = '',
source_addr_ton = 0,
source_addr_npi = 0,
**kwargs):
super(QuerySM, self).__init__(
'query_sm',
'ESME_ROK',
sequence_number,
**kwargs)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['message_id'] = message_id
self.obj['body']['mandatory_parameters']['source_addr'] = source_addr
self.obj['body']['mandatory_parameters']['source_addr_ton'] = source_addr_ton
self.obj['body']['mandatory_parameters']['source_addr_npi'] = source_addr_npi
#bind = BindTransmitter(system_id='test_id', password='abc123')
#print bind.get_obj()
#print bind.get_hex()
#print bind.get_bin()
##print json.dumps(bind.get_obj(), indent=4, sort_keys=True)
##print json.dumps(decode_pdu(bind.get_hex()), indent=4, sort_keys=True)
#print json.dumps(unpack_pdu(bind.get_bin()), indent=4, sort_keys=True)
#sm = SubmitSM(short_message='testing testing')
#print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
#sm.add_message_payload('616263646566676869')
#print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
|
dmaclay/python-smpp
|
8d376ad230065767348442f59f541f0a420cf3bd
|
ascii & utf 8-16-32 in one string
|
diff --git a/tests.py b/tests.py
index 9088e25..810f140 100644
--- a/tests.py
+++ b/tests.py
@@ -1,308 +1,339 @@
# -*- coding: utf-8 -*-
import unittest, collections
from datetime import datetime, timedelta
from smpp.esme import *
from smpp.clickatell import *
from smpp import pdu
import credentials_test
try:import credentials_priv
except:pass
from test.pdu import pdu_objects
from test import pdu_asserts
from test.pdu_hex import pdu_hex_strings
from test import pdu_hex_asserts
def unpack_hex(pdu_hex):
"""Unpack PDU hex string and return it as a dictionary"""
return unpack_pdu(binascii.a2b_hex(hexclean(pdu_hex)))
def hexclean(dirtyhex):
"""Remove whitespace, comments & newlines from hex string"""
return re.sub(r'\s','',re.sub(r'#.*\n','\n',dirtyhex))
def prettydump(pdu_obj):
"""Unpack PDU dictionary and dump it as a JSON formatted string"""
return json.dumps(pdu_obj, indent=4, sort_keys=True)
def hex_to_named(dictionary):
"""
Recursive function to convert values in test dictionaries to
their named counterparts that unpack_pdu returns
"""
clone = dictionary.copy()
for key, value in clone.items():
if isinstance(value, collections.Mapping):
clone[key] = hex_to_named(value)
else:
lookup_table = pdu.maps.get('%s_by_hex' % key)
if lookup_table:
# overwrite with mapped value or keep using
# default if the dictionary key doesn't exist
clone[key] = lookup_table.get("%.2d" % value, value)
return clone
def create_pdu_asserts():
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_pdu(pack_pdu(pdu)))
pstr += "'''"
print pstr
def create_pdu_hex_asserts():
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_hex(pdu_hex))
pstr += "'''"
print pstr
## :w|!python % > test/pdu_asserts.py
#create_pdu_asserts()
#quit()
## :w|!python % > test/pdu_hex_asserts.py
#create_pdu_hex_asserts()
#quit()
class PduTestCase(unittest.TestCase):
def setUp(self):
pass
def tearDown(self):
pass
def assertDictEquals(self, dictionary1, dictionary2, depth=[]):
"""
Recursive dictionary comparison, will fail if any keys and values
in the two dictionaries don't match. Displays the key chain / depth
and which parts of the two dictionaries didn't match.
"""
d1_keys = dictionary1.keys()
d1_keys.sort()
d2_keys = dictionary2.keys()
d2_keys.sort()
self.failUnlessEqual(d1_keys, d2_keys,
"Dictionary keys do not match, %s vs %s" % (
d1_keys, d2_keys))
for key, value in dictionary1.items():
if isinstance(value, collections.Mapping):
# go recursive
depth.append(key)
self.assertDictEquals(value, dictionary2[key], depth)
else:
self.failUnlessEqual(value, dictionary2[key],
"Dictionary values do not match for key '%s' " \
"(%s vs %s) at depth: %s.\nDictionary 1: %s\n" \
"Dictionary 2: %s\n" % (
key, value, dictionary2[key], ".".join(depth),
prettydump(dictionary1), prettydump(dictionary2)))
def test_pack_unpack_pdu_objects(self):
print ''
"""
Take a dictionary, pack and unpack it and dump it as JSON correctly
"""
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
padded_index = '%010d' % pdu_index
print '...', padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_pdu(pack_pdu(pdu)))),
re.sub('\n *','',
eval('pdu_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_pdu_hex_strings(self):
print ''
"""
Read the hex data, clean it, and unpack it to JSON correctly
"""
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
padded_index = '%010d' % pdu_index
print '...', padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_hex(pdu_hex))),
re.sub('\n *','',
eval('pdu_hex_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_performance(self):
print ''
"""
Pack & unpack 2000 submit_sm PDUs in under 1 second
"""
submit_sm = {
'header': {
'command_length': 0,
'command_id': 'submit_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
'esm_class':0,
'protocol_id':0,
'priority_flag':0,
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
'sm_length':1,
'short_message':'',
},
},
}
start = datetime.now()
for x in range(1000):
x += 1
submit_sm['header']['sequence_number'] = x
sm = 'testing: x = '+str(x)+''
submit_sm['body']['mandatory_parameters']['short_message'] = sm
u = unpack_pdu(pack_pdu(submit_sm))
delta = datetime.now() - start
print '... 1000 pack & unpacks in:', delta
self.assertTrue(delta < timedelta(seconds=1))
def test_pack_unpack_of_unicode(self):
"""
SMPP module should be able to pack & unpack unicode characters
without a problem
"""
submit_sm = {
'header': {
'command_length': 67,
'command_id': 'submit_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'source_addr_ton':'international',
'source_addr_npi':'unknown',
'source_addr':'',
'dest_addr_ton':'international',
'dest_addr_npi':'unknown',
'destination_addr':'',
'esm_class':0,
'protocol_id':0,
'priority_flag':0,
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
'sm_length':34,
- #'short_message':'Vumi says: أب٠اÙشرÙ
Ùطة',
- 'short_message':u'\u0623\u0628\u0646 \u0627\u0644\u0634\u0631\u0645\u0648\u0637\u0629',
+ 'short_message':u'Vumi says: أب٠اÙشرÙ
Ùطة'.encode('utf-8'),
},
},
}
self.assertDictEquals(
hex_to_named(submit_sm),
unpack_pdu(pack_pdu(submit_sm))
)
- print "UNICODE ROUNDTRIP INPUT:", repr(submit_sm), "\n"
- print "UNICODE ROUNDTRIP RESULT:", repr(unpack_pdu(pack_pdu(submit_sm))), "\n\n"
- print "UNICODE ROUNDTRIP INPUT:", submit_sm, "\n"
- print "UNICODE ROUNDTRIP RESULT:", unpack_pdu(pack_pdu(submit_sm)), "\n\n"
- print submit_sm['body']['mandatory_parameters']['short_message']
- print unpack_pdu(pack_pdu(submit_sm))['body']['mandatory_parameters']['short_message']
- print u'\u0623\u0628\u0646 \u0627\u0644\u0634\u0631\u0645\u0648\u0637\u0629'
+ def test_pack_unpack_of_ascii_and_unicode_8_16_32(self):
+ """
+ SMPP module should be able to pack & unpack unicode characters
+ without a problem
+ """
+ submit_sm = {
+ 'header': {
+ 'command_length': 65,
+ 'command_id': 'submit_sm',
+ 'command_status': 'ESME_ROK',
+ 'sequence_number': 0,
+ },
+ 'body': {
+ 'mandatory_parameters': {
+ 'service_type':'',
+ 'source_addr_ton':'international',
+ 'source_addr_npi':'unknown',
+ 'source_addr':'',
+ 'dest_addr_ton':'international',
+ 'dest_addr_npi':'unknown',
+ 'destination_addr':'',
+ 'esm_class':0,
+ 'protocol_id':0,
+ 'priority_flag':0,
+ 'schedule_delivery_time':'',
+ 'validity_period':'',
+ 'registered_delivery':0,
+ 'replace_if_present_flag':0,
+ 'data_coding':0,
+ 'sm_default_msg_id':0,
+ 'sm_length':32,
+ 'short_message':u'a \xf0\x20\u0373\u0020\u0433\u0020\u0533\u0020\u05f3\u0020\u0633\u0020\u13a3\u0020\u16a3 \U0001f090'.encode('utf-8'),
+ },
+ },
+ }
+ self.assertDictEquals(
+ hex_to_named(submit_sm),
+ unpack_pdu(pack_pdu(submit_sm))
+ )
class PduBuilderTestCase(unittest.TestCase):
def test_true(self):
print ''
self.assertTrue(True)
if __name__ == '__main__':
print '\n##########################################################\n'
#deliv_sm_resp = DeliverSMResp(23)
#print deliv_sm_resp.get_obj()
#print deliv_sm_resp.get_hex()
#enq_lnk = EnquireLink(7)
#print enq_lnk.get_obj()
#print enq_lnk.get_hex()
#sub_sm = SubmitSM(5, short_message='testing testing')
#print sub_sm.get_obj()
#print sub_sm.get_hex()
#sub_sm.add_message_payload('01020304')
#print sub_sm.get_obj()
#print sub_sm.get_hex()
#print unpack_pdu(sub_sm.get_bin())
print '\n##########################################################\n'
esme = ESME()
esme.loadDefaults(clickatell_defaults)
esme.loadDefaults(credentials_test.logica)
print esme.defaults
esme.bind_transmitter()
print esme.state
start = datetime.now()
for x in range(1):
esme.submit_sm(
short_message = 'gobbledygook',
destination_addr = '555',
)
print esme.state
for x in range(1):
esme.submit_multi(
short_message = 'gobbledygook',
dest_address = ['444','333'],
)
print esme.state
for x in range(1):
esme.submit_multi(
short_message = 'gobbledygook',
dest_address = [
{'dest_flag':1, 'destination_addr':'111'},
{'dest_flag':2, 'dl_name':'list22222'},
],
)
print esme.state
delta = datetime.now() - start
esme.disconnect()
print esme.state
print 'excluding binding ... time to send messages =', delta
#if __name__ == '__main__':
#unittest.main()
|
dmaclay/python-smpp
|
ec74641276100d6f3ad8bfa79f4f35f91766187f
|
works in testing ... but \xd8 blows up in deploy
|
diff --git a/tests.py b/tests.py
index 13e54bb..3e184e7 100644
--- a/tests.py
+++ b/tests.py
@@ -1,299 +1,301 @@
# -*- coding: utf-8 -*-
import unittest, collections
from datetime import datetime, timedelta
from smpp.esme import *
from smpp.clickatell import *
from smpp import pdu
import credentials_test
try:import credentials_priv
except:pass
from test.pdu import pdu_objects
from test import pdu_asserts
from test.pdu_hex import pdu_hex_strings
from test import pdu_hex_asserts
def unpack_hex(pdu_hex):
"""Unpack PDU hex string and return it as a dictionary"""
return unpack_pdu(binascii.a2b_hex(hexclean(pdu_hex)))
def hexclean(dirtyhex):
"""Remove whitespace, comments & newlines from hex string"""
return re.sub(r'\s','',re.sub(r'#.*\n','\n',dirtyhex))
def prettydump(pdu_obj):
"""Unpack PDU dictionary and dump it as a JSON formatted string"""
return json.dumps(pdu_obj, indent=4, sort_keys=True)
def hex_to_named(dictionary):
"""
Recursive function to convert values in test dictionaries to
their named counterparts that unpack_pdu returns
"""
clone = dictionary.copy()
for key, value in clone.items():
if isinstance(value, collections.Mapping):
clone[key] = hex_to_named(value)
else:
lookup_table = pdu.maps.get('%s_by_hex' % key)
if lookup_table:
# overwrite with mapped value or keep using
# default if the dictionary key doesn't exist
clone[key] = lookup_table.get("%.2d" % value, value)
return clone
def create_pdu_asserts():
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_pdu(pack_pdu(pdu)))
pstr += "'''"
print pstr
def create_pdu_hex_asserts():
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_hex(pdu_hex))
pstr += "'''"
print pstr
## :w|!python % > test/pdu_asserts.py
#create_pdu_asserts()
#quit()
## :w|!python % > test/pdu_hex_asserts.py
#create_pdu_hex_asserts()
#quit()
class PduTestCase(unittest.TestCase):
def setUp(self):
pass
def tearDown(self):
pass
def assertDictEquals(self, dictionary1, dictionary2, depth=[]):
"""
Recursive dictionary comparison, will fail if any keys and values
in the two dictionaries don't match. Displays the key chain / depth
and which parts of the two dictionaries didn't match.
"""
d1_keys = dictionary1.keys()
d1_keys.sort()
d2_keys = dictionary2.keys()
d2_keys.sort()
self.failUnlessEqual(d1_keys, d2_keys,
"Dictionary keys do not match, %s vs %s" % (
d1_keys, d2_keys))
for key, value in dictionary1.items():
if isinstance(value, collections.Mapping):
# go recursive
depth.append(key)
self.assertDictEquals(value, dictionary2[key], depth)
else:
self.failUnlessEqual(value, dictionary2[key],
"Dictionary values do not match for key '%s' " \
"(%s vs %s) at depth: %s.\nDictionary 1: %s\n" \
"Dictionary 2: %s\n" % (
key, value, dictionary2[key], ".".join(depth),
prettydump(dictionary1), prettydump(dictionary2)))
def test_pack_unpack_pdu_objects(self):
print ''
"""
Take a dictionary, pack and unpack it and dump it as JSON correctly
"""
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
padded_index = '%010d' % pdu_index
print '...', padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_pdu(pack_pdu(pdu)))),
re.sub('\n *','',
eval('pdu_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_pdu_hex_strings(self):
print ''
"""
Read the hex data, clean it, and unpack it to JSON correctly
"""
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
padded_index = '%010d' % pdu_index
print '...', padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_hex(pdu_hex))),
re.sub('\n *','',
eval('pdu_hex_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_performance(self):
print ''
"""
Pack & unpack 2000 submit_sm PDUs in under 1 second
"""
submit_sm = {
'header': {
'command_length': 0,
'command_id': 'submit_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
'esm_class':0,
'protocol_id':0,
'priority_flag':0,
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
'sm_length':1,
'short_message':'',
},
},
}
start = datetime.now()
- for x in range(2000):
+ for x in range(1000):
x += 1
submit_sm['header']['sequence_number'] = x
sm = 'testing: x = '+str(x)+''
submit_sm['body']['mandatory_parameters']['short_message'] = sm
u = unpack_pdu(pack_pdu(submit_sm))
delta = datetime.now() - start
- print '... 2000 pack & unpacks in:', delta
+ print '... 1000 pack & unpacks in:', delta
self.assertTrue(delta < timedelta(seconds=1))
def test_pack_unpack_of_unicode(self):
"""
SMPP module should be able to pack & unpack unicode characters
without a problem
"""
submit_sm = {
'header': {
- 'command_length': 0,
+ 'command_length': 67,
'command_id': 'submit_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
- 'source_addr_ton':1,
- 'source_addr_npi':1,
+ 'source_addr_ton':'international',
+ 'source_addr_npi':'unknown',
'source_addr':'',
- 'dest_addr_ton':1,
- 'dest_addr_npi':1,
+ 'dest_addr_ton':'international',
+ 'dest_addr_npi':'unknown',
'destination_addr':'',
'esm_class':0,
'protocol_id':0,
'priority_flag':0,
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
- 'sm_length':12,
- 'short_message':'أب٠اÙشرÙ
Ùطة',
+ 'sm_length':34,
+ 'short_message':'Vumi says: أب٠اÙشرÙ
Ùطة',
},
},
}
self.assertDictEquals(
hex_to_named(submit_sm),
unpack_pdu(pack_pdu(submit_sm))
)
+ print "UNICODE ROUNDTRIP RESULT:", repr(unpack_pdu(pack_pdu(submit_sm))), "\n\n"
+
class PduBuilderTestCase(unittest.TestCase):
def test_true(self):
print ''
self.assertTrue(True)
if __name__ == '__main__':
print '\n##########################################################\n'
#deliv_sm_resp = DeliverSMResp(23)
#print deliv_sm_resp.get_obj()
#print deliv_sm_resp.get_hex()
#enq_lnk = EnquireLink(7)
#print enq_lnk.get_obj()
#print enq_lnk.get_hex()
#sub_sm = SubmitSM(5, short_message='testing testing')
#print sub_sm.get_obj()
#print sub_sm.get_hex()
#sub_sm.add_message_payload('01020304')
#print sub_sm.get_obj()
#print sub_sm.get_hex()
#print unpack_pdu(sub_sm.get_bin())
print '\n##########################################################\n'
esme = ESME()
esme.loadDefaults(clickatell_defaults)
esme.loadDefaults(credentials_test.logica)
print esme.defaults
esme.bind_transmitter()
print esme.state
start = datetime.now()
for x in range(1):
esme.submit_sm(
short_message = 'gobbledygook',
destination_addr = '555',
)
print esme.state
for x in range(1):
esme.submit_multi(
short_message = 'gobbledygook',
dest_address = ['444','333'],
)
print esme.state
for x in range(1):
esme.submit_multi(
short_message = 'gobbledygook',
dest_address = [
{'dest_flag':1, 'destination_addr':'111'},
{'dest_flag':2, 'dl_name':'list22222'},
],
)
print esme.state
delta = datetime.now() - start
esme.disconnect()
print esme.state
print 'excluding binding ... time to send messages =', delta
#if __name__ == '__main__':
#unittest.main()
|
dmaclay/python-smpp
|
c204d1f611454ddeb88f36ec7364ff78373245fb
|
fixing submit_sm sample, the short_message is 12chr long
|
diff --git a/tests.py b/tests.py
index e443394..13e54bb 100644
--- a/tests.py
+++ b/tests.py
@@ -1,299 +1,299 @@
# -*- coding: utf-8 -*-
import unittest, collections
from datetime import datetime, timedelta
from smpp.esme import *
from smpp.clickatell import *
from smpp import pdu
import credentials_test
try:import credentials_priv
except:pass
from test.pdu import pdu_objects
from test import pdu_asserts
from test.pdu_hex import pdu_hex_strings
from test import pdu_hex_asserts
def unpack_hex(pdu_hex):
"""Unpack PDU hex string and return it as a dictionary"""
return unpack_pdu(binascii.a2b_hex(hexclean(pdu_hex)))
def hexclean(dirtyhex):
"""Remove whitespace, comments & newlines from hex string"""
return re.sub(r'\s','',re.sub(r'#.*\n','\n',dirtyhex))
def prettydump(pdu_obj):
"""Unpack PDU dictionary and dump it as a JSON formatted string"""
return json.dumps(pdu_obj, indent=4, sort_keys=True)
def hex_to_named(dictionary):
"""
Recursive function to convert values in test dictionaries to
their named counterparts that unpack_pdu returns
"""
clone = dictionary.copy()
for key, value in clone.items():
if isinstance(value, collections.Mapping):
clone[key] = hex_to_named(value)
else:
lookup_table = pdu.maps.get('%s_by_hex' % key)
if lookup_table:
# overwrite with mapped value or keep using
# default if the dictionary key doesn't exist
clone[key] = lookup_table.get("%.2d" % value, value)
return clone
def create_pdu_asserts():
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_pdu(pack_pdu(pdu)))
pstr += "'''"
print pstr
def create_pdu_hex_asserts():
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_hex(pdu_hex))
pstr += "'''"
print pstr
## :w|!python % > test/pdu_asserts.py
#create_pdu_asserts()
#quit()
## :w|!python % > test/pdu_hex_asserts.py
#create_pdu_hex_asserts()
#quit()
class PduTestCase(unittest.TestCase):
def setUp(self):
pass
def tearDown(self):
pass
def assertDictEquals(self, dictionary1, dictionary2, depth=[]):
"""
Recursive dictionary comparison, will fail if any keys and values
in the two dictionaries don't match. Displays the key chain / depth
and which parts of the two dictionaries didn't match.
"""
d1_keys = dictionary1.keys()
d1_keys.sort()
d2_keys = dictionary2.keys()
d2_keys.sort()
self.failUnlessEqual(d1_keys, d2_keys,
"Dictionary keys do not match, %s vs %s" % (
d1_keys, d2_keys))
for key, value in dictionary1.items():
if isinstance(value, collections.Mapping):
# go recursive
depth.append(key)
self.assertDictEquals(value, dictionary2[key], depth)
else:
self.failUnlessEqual(value, dictionary2[key],
"Dictionary values do not match for key '%s' " \
"(%s vs %s) at depth: %s.\nDictionary 1: %s\n" \
"Dictionary 2: %s\n" % (
key, value, dictionary2[key], ".".join(depth),
- dictionary1, dictionary2))
+ prettydump(dictionary1), prettydump(dictionary2)))
def test_pack_unpack_pdu_objects(self):
print ''
"""
Take a dictionary, pack and unpack it and dump it as JSON correctly
"""
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
padded_index = '%010d' % pdu_index
print '...', padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_pdu(pack_pdu(pdu)))),
re.sub('\n *','',
eval('pdu_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_pdu_hex_strings(self):
print ''
"""
Read the hex data, clean it, and unpack it to JSON correctly
"""
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
padded_index = '%010d' % pdu_index
print '...', padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_hex(pdu_hex))),
re.sub('\n *','',
eval('pdu_hex_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_performance(self):
print ''
"""
Pack & unpack 2000 submit_sm PDUs in under 1 second
"""
submit_sm = {
'header': {
'command_length': 0,
'command_id': 'submit_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
'esm_class':0,
'protocol_id':0,
'priority_flag':0,
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
'sm_length':1,
'short_message':'',
},
},
}
start = datetime.now()
for x in range(2000):
x += 1
submit_sm['header']['sequence_number'] = x
sm = 'testing: x = '+str(x)+''
submit_sm['body']['mandatory_parameters']['short_message'] = sm
u = unpack_pdu(pack_pdu(submit_sm))
delta = datetime.now() - start
print '... 2000 pack & unpacks in:', delta
self.assertTrue(delta < timedelta(seconds=1))
def test_pack_unpack_of_unicode(self):
"""
SMPP module should be able to pack & unpack unicode characters
without a problem
"""
submit_sm = {
'header': {
'command_length': 0,
'command_id': 'submit_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
'esm_class':0,
'protocol_id':0,
'priority_flag':0,
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
- 'sm_length':1,
+ 'sm_length':12,
'short_message':'أب٠اÙشرÙ
Ùطة',
},
},
}
self.assertDictEquals(
hex_to_named(submit_sm),
unpack_pdu(pack_pdu(submit_sm))
)
class PduBuilderTestCase(unittest.TestCase):
def test_true(self):
print ''
self.assertTrue(True)
if __name__ == '__main__':
print '\n##########################################################\n'
#deliv_sm_resp = DeliverSMResp(23)
#print deliv_sm_resp.get_obj()
#print deliv_sm_resp.get_hex()
#enq_lnk = EnquireLink(7)
#print enq_lnk.get_obj()
#print enq_lnk.get_hex()
#sub_sm = SubmitSM(5, short_message='testing testing')
#print sub_sm.get_obj()
#print sub_sm.get_hex()
#sub_sm.add_message_payload('01020304')
#print sub_sm.get_obj()
#print sub_sm.get_hex()
#print unpack_pdu(sub_sm.get_bin())
print '\n##########################################################\n'
esme = ESME()
esme.loadDefaults(clickatell_defaults)
esme.loadDefaults(credentials_test.logica)
print esme.defaults
esme.bind_transmitter()
print esme.state
start = datetime.now()
for x in range(1):
esme.submit_sm(
short_message = 'gobbledygook',
destination_addr = '555',
)
print esme.state
for x in range(1):
esme.submit_multi(
short_message = 'gobbledygook',
dest_address = ['444','333'],
)
print esme.state
for x in range(1):
esme.submit_multi(
short_message = 'gobbledygook',
dest_address = [
{'dest_flag':1, 'destination_addr':'111'},
{'dest_flag':2, 'dl_name':'list22222'},
],
)
print esme.state
delta = datetime.now() - start
esme.disconnect()
print esme.state
print 'excluding binding ... time to send messages =', delta
#if __name__ == '__main__':
#unittest.main()
|
dmaclay/python-smpp
|
4a7ab4360c50485c1e2ec3e3cfa7562cbe12e6bb
|
oops, half finished code
|
diff --git a/tests.py b/tests.py
index dd4ac2d..e443394 100644
--- a/tests.py
+++ b/tests.py
@@ -1,301 +1,299 @@
# -*- coding: utf-8 -*-
import unittest, collections
from datetime import datetime, timedelta
from smpp.esme import *
from smpp.clickatell import *
from smpp import pdu
import credentials_test
try:import credentials_priv
except:pass
from test.pdu import pdu_objects
from test import pdu_asserts
from test.pdu_hex import pdu_hex_strings
from test import pdu_hex_asserts
def unpack_hex(pdu_hex):
"""Unpack PDU hex string and return it as a dictionary"""
return unpack_pdu(binascii.a2b_hex(hexclean(pdu_hex)))
def hexclean(dirtyhex):
"""Remove whitespace, comments & newlines from hex string"""
return re.sub(r'\s','',re.sub(r'#.*\n','\n',dirtyhex))
def prettydump(pdu_obj):
"""Unpack PDU dictionary and dump it as a JSON formatted string"""
return json.dumps(pdu_obj, indent=4, sort_keys=True)
def hex_to_named(dictionary):
"""
Recursive function to convert values in test dictionaries to
their named counterparts that unpack_pdu returns
"""
clone = dictionary.copy()
for key, value in clone.items():
if isinstance(value, collections.Mapping):
clone[key] = hex_to_named(value)
else:
lookup_table = pdu.maps.get('%s_by_hex' % key)
if lookup_table:
# overwrite with mapped value or keep using
# default if the dictionary key doesn't exist
clone[key] = lookup_table.get("%.2d" % value, value)
return clone
def create_pdu_asserts():
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_pdu(pack_pdu(pdu)))
pstr += "'''"
print pstr
def create_pdu_hex_asserts():
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_hex(pdu_hex))
pstr += "'''"
print pstr
## :w|!python % > test/pdu_asserts.py
#create_pdu_asserts()
#quit()
## :w|!python % > test/pdu_hex_asserts.py
#create_pdu_hex_asserts()
#quit()
class PduTestCase(unittest.TestCase):
def setUp(self):
pass
def tearDown(self):
pass
- def assertDictEquals(self, dictionary1, dictionary2, depth=[], full_scan=False):
+ def assertDictEquals(self, dictionary1, dictionary2, depth=[]):
"""
Recursive dictionary comparison, will fail if any keys and values
in the two dictionaries don't match. Displays the key chain / depth
and which parts of the two dictionaries didn't match.
"""
d1_keys = dictionary1.keys()
d1_keys.sort()
d2_keys = dictionary2.keys()
d2_keys.sort()
self.failUnlessEqual(d1_keys, d2_keys,
"Dictionary keys do not match, %s vs %s" % (
d1_keys, d2_keys))
for key, value in dictionary1.items():
if isinstance(value, collections.Mapping):
# go recursive
depth.append(key)
- self.assertDictEquals(value, dictionary2[key], depth, full_scan)
+ self.assertDictEquals(value, dictionary2[key], depth)
else:
- if full_scan:
- else:
- self.failUnlessEqual(value, dictionary2[key],
- "Dictionary values do not match for key '%s' " \
- "(%s vs %s) at depth: %s.\nDictionary 1: %s\n" \
- "Dictionary 2: %s\n" % (
- key, value, dictionary2[key], ".".join(depth),
- dictionary1, dictionary2))
+ self.failUnlessEqual(value, dictionary2[key],
+ "Dictionary values do not match for key '%s' " \
+ "(%s vs %s) at depth: %s.\nDictionary 1: %s\n" \
+ "Dictionary 2: %s\n" % (
+ key, value, dictionary2[key], ".".join(depth),
+ dictionary1, dictionary2))
def test_pack_unpack_pdu_objects(self):
print ''
"""
Take a dictionary, pack and unpack it and dump it as JSON correctly
"""
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
padded_index = '%010d' % pdu_index
print '...', padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_pdu(pack_pdu(pdu)))),
re.sub('\n *','',
eval('pdu_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_pdu_hex_strings(self):
print ''
"""
Read the hex data, clean it, and unpack it to JSON correctly
"""
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
padded_index = '%010d' % pdu_index
print '...', padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_hex(pdu_hex))),
re.sub('\n *','',
eval('pdu_hex_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_performance(self):
print ''
"""
Pack & unpack 2000 submit_sm PDUs in under 1 second
"""
submit_sm = {
'header': {
'command_length': 0,
'command_id': 'submit_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
'esm_class':0,
'protocol_id':0,
'priority_flag':0,
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
'sm_length':1,
'short_message':'',
},
},
}
start = datetime.now()
for x in range(2000):
x += 1
submit_sm['header']['sequence_number'] = x
sm = 'testing: x = '+str(x)+''
submit_sm['body']['mandatory_parameters']['short_message'] = sm
u = unpack_pdu(pack_pdu(submit_sm))
delta = datetime.now() - start
print '... 2000 pack & unpacks in:', delta
self.assertTrue(delta < timedelta(seconds=1))
def test_pack_unpack_of_unicode(self):
"""
SMPP module should be able to pack & unpack unicode characters
without a problem
"""
submit_sm = {
'header': {
'command_length': 0,
'command_id': 'submit_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
'esm_class':0,
'protocol_id':0,
'priority_flag':0,
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
'sm_length':1,
'short_message':'أب٠اÙشرÙ
Ùطة',
},
},
}
self.assertDictEquals(
hex_to_named(submit_sm),
unpack_pdu(pack_pdu(submit_sm))
)
class PduBuilderTestCase(unittest.TestCase):
def test_true(self):
print ''
self.assertTrue(True)
if __name__ == '__main__':
print '\n##########################################################\n'
#deliv_sm_resp = DeliverSMResp(23)
#print deliv_sm_resp.get_obj()
#print deliv_sm_resp.get_hex()
#enq_lnk = EnquireLink(7)
#print enq_lnk.get_obj()
#print enq_lnk.get_hex()
#sub_sm = SubmitSM(5, short_message='testing testing')
#print sub_sm.get_obj()
#print sub_sm.get_hex()
#sub_sm.add_message_payload('01020304')
#print sub_sm.get_obj()
#print sub_sm.get_hex()
#print unpack_pdu(sub_sm.get_bin())
print '\n##########################################################\n'
esme = ESME()
esme.loadDefaults(clickatell_defaults)
esme.loadDefaults(credentials_test.logica)
print esme.defaults
esme.bind_transmitter()
print esme.state
start = datetime.now()
for x in range(1):
esme.submit_sm(
short_message = 'gobbledygook',
destination_addr = '555',
)
print esme.state
for x in range(1):
esme.submit_multi(
short_message = 'gobbledygook',
dest_address = ['444','333'],
)
print esme.state
for x in range(1):
esme.submit_multi(
short_message = 'gobbledygook',
dest_address = [
{'dest_flag':1, 'destination_addr':'111'},
{'dest_flag':2, 'dl_name':'list22222'},
],
)
print esme.state
delta = datetime.now() - start
esme.disconnect()
print esme.state
print 'excluding binding ... time to send messages =', delta
#if __name__ == '__main__':
#unittest.main()
|
dmaclay/python-smpp
|
eeabc63423e1ec293795bc19603965888ce5248d
|
adding failing unicode test
|
diff --git a/tests.py b/tests.py
index e443394..dd4ac2d 100644
--- a/tests.py
+++ b/tests.py
@@ -1,299 +1,301 @@
# -*- coding: utf-8 -*-
import unittest, collections
from datetime import datetime, timedelta
from smpp.esme import *
from smpp.clickatell import *
from smpp import pdu
import credentials_test
try:import credentials_priv
except:pass
from test.pdu import pdu_objects
from test import pdu_asserts
from test.pdu_hex import pdu_hex_strings
from test import pdu_hex_asserts
def unpack_hex(pdu_hex):
"""Unpack PDU hex string and return it as a dictionary"""
return unpack_pdu(binascii.a2b_hex(hexclean(pdu_hex)))
def hexclean(dirtyhex):
"""Remove whitespace, comments & newlines from hex string"""
return re.sub(r'\s','',re.sub(r'#.*\n','\n',dirtyhex))
def prettydump(pdu_obj):
"""Unpack PDU dictionary and dump it as a JSON formatted string"""
return json.dumps(pdu_obj, indent=4, sort_keys=True)
def hex_to_named(dictionary):
"""
Recursive function to convert values in test dictionaries to
their named counterparts that unpack_pdu returns
"""
clone = dictionary.copy()
for key, value in clone.items():
if isinstance(value, collections.Mapping):
clone[key] = hex_to_named(value)
else:
lookup_table = pdu.maps.get('%s_by_hex' % key)
if lookup_table:
# overwrite with mapped value or keep using
# default if the dictionary key doesn't exist
clone[key] = lookup_table.get("%.2d" % value, value)
return clone
def create_pdu_asserts():
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_pdu(pack_pdu(pdu)))
pstr += "'''"
print pstr
def create_pdu_hex_asserts():
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_hex(pdu_hex))
pstr += "'''"
print pstr
## :w|!python % > test/pdu_asserts.py
#create_pdu_asserts()
#quit()
## :w|!python % > test/pdu_hex_asserts.py
#create_pdu_hex_asserts()
#quit()
class PduTestCase(unittest.TestCase):
def setUp(self):
pass
def tearDown(self):
pass
- def assertDictEquals(self, dictionary1, dictionary2, depth=[]):
+ def assertDictEquals(self, dictionary1, dictionary2, depth=[], full_scan=False):
"""
Recursive dictionary comparison, will fail if any keys and values
in the two dictionaries don't match. Displays the key chain / depth
and which parts of the two dictionaries didn't match.
"""
d1_keys = dictionary1.keys()
d1_keys.sort()
d2_keys = dictionary2.keys()
d2_keys.sort()
self.failUnlessEqual(d1_keys, d2_keys,
"Dictionary keys do not match, %s vs %s" % (
d1_keys, d2_keys))
for key, value in dictionary1.items():
if isinstance(value, collections.Mapping):
# go recursive
depth.append(key)
- self.assertDictEquals(value, dictionary2[key], depth)
+ self.assertDictEquals(value, dictionary2[key], depth, full_scan)
else:
- self.failUnlessEqual(value, dictionary2[key],
- "Dictionary values do not match for key '%s' " \
- "(%s vs %s) at depth: %s.\nDictionary 1: %s\n" \
- "Dictionary 2: %s\n" % (
- key, value, dictionary2[key], ".".join(depth),
- dictionary1, dictionary2))
+ if full_scan:
+ else:
+ self.failUnlessEqual(value, dictionary2[key],
+ "Dictionary values do not match for key '%s' " \
+ "(%s vs %s) at depth: %s.\nDictionary 1: %s\n" \
+ "Dictionary 2: %s\n" % (
+ key, value, dictionary2[key], ".".join(depth),
+ dictionary1, dictionary2))
def test_pack_unpack_pdu_objects(self):
print ''
"""
Take a dictionary, pack and unpack it and dump it as JSON correctly
"""
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
padded_index = '%010d' % pdu_index
print '...', padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_pdu(pack_pdu(pdu)))),
re.sub('\n *','',
eval('pdu_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_pdu_hex_strings(self):
print ''
"""
Read the hex data, clean it, and unpack it to JSON correctly
"""
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
padded_index = '%010d' % pdu_index
print '...', padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_hex(pdu_hex))),
re.sub('\n *','',
eval('pdu_hex_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_performance(self):
print ''
"""
Pack & unpack 2000 submit_sm PDUs in under 1 second
"""
submit_sm = {
'header': {
'command_length': 0,
'command_id': 'submit_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
'esm_class':0,
'protocol_id':0,
'priority_flag':0,
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
'sm_length':1,
'short_message':'',
},
},
}
start = datetime.now()
for x in range(2000):
x += 1
submit_sm['header']['sequence_number'] = x
sm = 'testing: x = '+str(x)+''
submit_sm['body']['mandatory_parameters']['short_message'] = sm
u = unpack_pdu(pack_pdu(submit_sm))
delta = datetime.now() - start
print '... 2000 pack & unpacks in:', delta
self.assertTrue(delta < timedelta(seconds=1))
def test_pack_unpack_of_unicode(self):
"""
SMPP module should be able to pack & unpack unicode characters
without a problem
"""
submit_sm = {
'header': {
'command_length': 0,
'command_id': 'submit_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
'esm_class':0,
'protocol_id':0,
'priority_flag':0,
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
'sm_length':1,
'short_message':'أب٠اÙشرÙ
Ùطة',
},
},
}
self.assertDictEquals(
hex_to_named(submit_sm),
unpack_pdu(pack_pdu(submit_sm))
)
class PduBuilderTestCase(unittest.TestCase):
def test_true(self):
print ''
self.assertTrue(True)
if __name__ == '__main__':
print '\n##########################################################\n'
#deliv_sm_resp = DeliverSMResp(23)
#print deliv_sm_resp.get_obj()
#print deliv_sm_resp.get_hex()
#enq_lnk = EnquireLink(7)
#print enq_lnk.get_obj()
#print enq_lnk.get_hex()
#sub_sm = SubmitSM(5, short_message='testing testing')
#print sub_sm.get_obj()
#print sub_sm.get_hex()
#sub_sm.add_message_payload('01020304')
#print sub_sm.get_obj()
#print sub_sm.get_hex()
#print unpack_pdu(sub_sm.get_bin())
print '\n##########################################################\n'
esme = ESME()
esme.loadDefaults(clickatell_defaults)
esme.loadDefaults(credentials_test.logica)
print esme.defaults
esme.bind_transmitter()
print esme.state
start = datetime.now()
for x in range(1):
esme.submit_sm(
short_message = 'gobbledygook',
destination_addr = '555',
)
print esme.state
for x in range(1):
esme.submit_multi(
short_message = 'gobbledygook',
dest_address = ['444','333'],
)
print esme.state
for x in range(1):
esme.submit_multi(
short_message = 'gobbledygook',
dest_address = [
{'dest_flag':1, 'destination_addr':'111'},
{'dest_flag':2, 'dl_name':'list22222'},
],
)
print esme.state
delta = datetime.now() - start
esme.disconnect()
print esme.state
print 'excluding binding ... time to send messages =', delta
#if __name__ == '__main__':
#unittest.main()
|
dmaclay/python-smpp
|
83496446b74a441cb4c593b5ea1230aaa5e470dd
|
adding failing unicode test
|
diff --git a/tests.py b/tests.py
index 60b8485..e443394 100644
--- a/tests.py
+++ b/tests.py
@@ -1,215 +1,299 @@
-import unittest
+# -*- coding: utf-8 -*-
+import unittest, collections
from datetime import datetime, timedelta
from smpp.esme import *
from smpp.clickatell import *
+from smpp import pdu
import credentials_test
try:import credentials_priv
except:pass
from test.pdu import pdu_objects
from test import pdu_asserts
from test.pdu_hex import pdu_hex_strings
from test import pdu_hex_asserts
def unpack_hex(pdu_hex):
"""Unpack PDU hex string and return it as a dictionary"""
return unpack_pdu(binascii.a2b_hex(hexclean(pdu_hex)))
def hexclean(dirtyhex):
"""Remove whitespace, comments & newlines from hex string"""
return re.sub(r'\s','',re.sub(r'#.*\n','\n',dirtyhex))
def prettydump(pdu_obj):
"""Unpack PDU dictionary and dump it as a JSON formatted string"""
return json.dumps(pdu_obj, indent=4, sort_keys=True)
+def hex_to_named(dictionary):
+ """
+ Recursive function to convert values in test dictionaries to
+ their named counterparts that unpack_pdu returns
+ """
+ clone = dictionary.copy()
+ for key, value in clone.items():
+ if isinstance(value, collections.Mapping):
+ clone[key] = hex_to_named(value)
+ else:
+ lookup_table = pdu.maps.get('%s_by_hex' % key)
+ if lookup_table:
+ # overwrite with mapped value or keep using
+ # default if the dictionary key doesn't exist
+ clone[key] = lookup_table.get("%.2d" % value, value)
+ return clone
def create_pdu_asserts():
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_pdu(pack_pdu(pdu)))
pstr += "'''"
print pstr
def create_pdu_hex_asserts():
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_hex(pdu_hex))
pstr += "'''"
print pstr
## :w|!python % > test/pdu_asserts.py
#create_pdu_asserts()
#quit()
## :w|!python % > test/pdu_hex_asserts.py
#create_pdu_hex_asserts()
#quit()
class PduTestCase(unittest.TestCase):
def setUp(self):
pass
def tearDown(self):
pass
+ def assertDictEquals(self, dictionary1, dictionary2, depth=[]):
+ """
+ Recursive dictionary comparison, will fail if any keys and values
+ in the two dictionaries don't match. Displays the key chain / depth
+ and which parts of the two dictionaries didn't match.
+ """
+ d1_keys = dictionary1.keys()
+ d1_keys.sort()
+
+ d2_keys = dictionary2.keys()
+ d2_keys.sort()
+
+ self.failUnlessEqual(d1_keys, d2_keys,
+ "Dictionary keys do not match, %s vs %s" % (
+ d1_keys, d2_keys))
+ for key, value in dictionary1.items():
+ if isinstance(value, collections.Mapping):
+ # go recursive
+ depth.append(key)
+ self.assertDictEquals(value, dictionary2[key], depth)
+ else:
+ self.failUnlessEqual(value, dictionary2[key],
+ "Dictionary values do not match for key '%s' " \
+ "(%s vs %s) at depth: %s.\nDictionary 1: %s\n" \
+ "Dictionary 2: %s\n" % (
+ key, value, dictionary2[key], ".".join(depth),
+ dictionary1, dictionary2))
+
def test_pack_unpack_pdu_objects(self):
print ''
"""
Take a dictionary, pack and unpack it and dump it as JSON correctly
"""
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
padded_index = '%010d' % pdu_index
print '...', padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_pdu(pack_pdu(pdu)))),
re.sub('\n *','',
eval('pdu_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_pdu_hex_strings(self):
print ''
"""
Read the hex data, clean it, and unpack it to JSON correctly
"""
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
padded_index = '%010d' % pdu_index
print '...', padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_hex(pdu_hex))),
re.sub('\n *','',
eval('pdu_hex_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_performance(self):
print ''
"""
Pack & unpack 2000 submit_sm PDUs in under 1 second
"""
submit_sm = {
'header': {
'command_length': 0,
'command_id': 'submit_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
'esm_class':0,
'protocol_id':0,
'priority_flag':0,
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
'sm_length':1,
'short_message':'',
},
},
}
start = datetime.now()
for x in range(2000):
x += 1
submit_sm['header']['sequence_number'] = x
sm = 'testing: x = '+str(x)+''
submit_sm['body']['mandatory_parameters']['short_message'] = sm
u = unpack_pdu(pack_pdu(submit_sm))
delta = datetime.now() - start
print '... 2000 pack & unpacks in:', delta
self.assertTrue(delta < timedelta(seconds=1))
-
+ def test_pack_unpack_of_unicode(self):
+ """
+ SMPP module should be able to pack & unpack unicode characters
+ without a problem
+ """
+ submit_sm = {
+ 'header': {
+ 'command_length': 0,
+ 'command_id': 'submit_sm',
+ 'command_status': 'ESME_ROK',
+ 'sequence_number': 0,
+ },
+ 'body': {
+ 'mandatory_parameters': {
+ 'service_type':'',
+ 'source_addr_ton':1,
+ 'source_addr_npi':1,
+ 'source_addr':'',
+ 'dest_addr_ton':1,
+ 'dest_addr_npi':1,
+ 'destination_addr':'',
+ 'esm_class':0,
+ 'protocol_id':0,
+ 'priority_flag':0,
+ 'schedule_delivery_time':'',
+ 'validity_period':'',
+ 'registered_delivery':0,
+ 'replace_if_present_flag':0,
+ 'data_coding':0,
+ 'sm_default_msg_id':0,
+ 'sm_length':1,
+ 'short_message':'أب٠اÙشرÙ
Ùطة',
+ },
+ },
+ }
+ self.assertDictEquals(
+ hex_to_named(submit_sm),
+ unpack_pdu(pack_pdu(submit_sm))
+ )
class PduBuilderTestCase(unittest.TestCase):
def test_true(self):
print ''
self.assertTrue(True)
if __name__ == '__main__':
print '\n##########################################################\n'
#deliv_sm_resp = DeliverSMResp(23)
#print deliv_sm_resp.get_obj()
#print deliv_sm_resp.get_hex()
#enq_lnk = EnquireLink(7)
#print enq_lnk.get_obj()
#print enq_lnk.get_hex()
#sub_sm = SubmitSM(5, short_message='testing testing')
#print sub_sm.get_obj()
#print sub_sm.get_hex()
#sub_sm.add_message_payload('01020304')
#print sub_sm.get_obj()
#print sub_sm.get_hex()
#print unpack_pdu(sub_sm.get_bin())
print '\n##########################################################\n'
esme = ESME()
esme.loadDefaults(clickatell_defaults)
esme.loadDefaults(credentials_test.logica)
print esme.defaults
esme.bind_transmitter()
print esme.state
start = datetime.now()
for x in range(1):
esme.submit_sm(
short_message = 'gobbledygook',
destination_addr = '555',
)
print esme.state
for x in range(1):
esme.submit_multi(
short_message = 'gobbledygook',
dest_address = ['444','333'],
)
print esme.state
for x in range(1):
esme.submit_multi(
short_message = 'gobbledygook',
dest_address = [
{'dest_flag':1, 'destination_addr':'111'},
{'dest_flag':2, 'dl_name':'list22222'},
],
)
print esme.state
delta = datetime.now() - start
esme.disconnect()
print esme.state
print 'excluding binding ... time to send messages =', delta
#if __name__ == '__main__':
#unittest.main()
|
dmaclay/python-smpp
|
46d3951af896c3f35b425623bda26580570ea148
|
adding coverage to nosetests, html report is in coverage-html/index.html
|
diff --git a/.gitignore b/.gitignore
index 1654d20..992b512 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,5 +1,7 @@
*.swp
*.pyc
*.egg-info
ve/
*_priv.py
+.coverage
+coverage-html/
diff --git a/setup.cfg b/setup.cfg
index 9eec931..de3db3e 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -1,3 +1,7 @@
[nosetests]
with-doctest=1
nocapture=1
+with-coverage=1
+cover-package=smpp
+cover-html=1
+cover-html-dir=./coverage-html/
|
dmaclay/python-smpp
|
99858d87b3cc755ae1c366cd6da1ec8f44e9e767
|
redoing how python-smpp is packaged
|
diff --git a/LICENCE b/LICENCE
index 08cd4b2..523815d 100644
--- a/LICENCE
+++ b/LICENCE
@@ -1,18 +1,28 @@
Copyright (c) Praekelt Foundation and individual contributors.
All rights reserved.
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
- 1. Redistributions of source code must retain the above copyright notice,
+ 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
-
+
3. Neither the name of the Praekelt Foundation nor the names of its
- contributors may be used to endorse or promote products derived from
+ contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
\ No newline at end of file
diff --git a/MANIFEST.in b/MANIFEST.in
new file mode 100644
index 0000000..02d53f8
--- /dev/null
+++ b/MANIFEST.in
@@ -0,0 +1,6 @@
+exclude test/*
+exclude tests.py
+exclude *.egg-info/*
+include LICENCE
+include README.rst
+include requirements.pip
diff --git a/README.md b/README.rst
similarity index 69%
rename from README.md
rename to README.rst
index 631e0b0..5f07f5b 100644
--- a/README.md
+++ b/README.rst
@@ -1,20 +1,19 @@
Python SMPP
===========
-An SMPP version 3.4 library written in Python, suitable for use in [Twisted][twisted]
+An SMPP version 3.4 library written in Python, suitable for use in Twisted_.
-To get started with development:
+To get started with development::
$ virtualenv --no-site-packges ve/
$ source ve/bin/activate
(ve)$ pip install -r requirements.pip
- (ve)$ python setup.py develop
(ve)$ python
>>> import smpp
>>>
Run the tests with nose
(ve)$ nosetests
-[twisted]: http://www.twistedmatrix.com
+.. _Twisted: http://www.twistedmatrix.com
diff --git a/setup.py b/setup.py
index 3883e9c..b58d684 100644
--- a/setup.py
+++ b/setup.py
@@ -1,14 +1,26 @@
from setuptools import setup, find_packages
+def listify(filename):
+ return filter(None, open(filename, 'r').readlines())
+
setup(
name = "python-smpp",
version = "0.1",
url = 'http://github.com/dmaclay/python-smpp',
license = 'BSD',
description = "Python SMPP Library",
+ long_description = open('README.rst','r').read(),
author = 'David Maclay',
- packages = find_packages('src'),
- package_dir = {'': 'src'},
- install_requires = [],
+ author_email = '[email protected]',
+ packages = find_packages(),
+ install_requires = ['setuptools'].extend(listify('requirements.pip')),
+ classifiers = [
+ 'Development Status :: 4 - Beta',
+ 'Intended Audience :: Developers',
+ 'License :: OSI Approved :: BSD License',
+ 'Operating System :: OS Independent',
+ 'Programming Language :: Python',
+ 'Topic :: Software Development :: Libraries :: Python Modules',
+ ]
)
diff --git a/src/__init__.py b/smpp/__init__.py
similarity index 100%
rename from src/__init__.py
rename to smpp/__init__.py
diff --git a/src/smpp/clickatell.py b/smpp/clickatell.py
similarity index 100%
rename from src/smpp/clickatell.py
rename to smpp/clickatell.py
diff --git a/src/smpp/esme.py b/smpp/esme.py
similarity index 100%
rename from src/smpp/esme.py
rename to smpp/esme.py
diff --git a/src/smpp/pdu.py b/smpp/pdu.py
similarity index 100%
rename from src/smpp/pdu.py
rename to smpp/pdu.py
diff --git a/src/smpp/pdu_builder.py b/smpp/pdu_builder.py
similarity index 100%
rename from src/smpp/pdu_builder.py
rename to smpp/pdu_builder.py
diff --git a/src/smpp/smsc.py b/smpp/smsc.py
similarity index 100%
rename from src/smpp/smsc.py
rename to smpp/smsc.py
diff --git a/src/smpp/__init__.py b/src/smpp/__init__.py
deleted file mode 100644
index e69de29..0000000
|
dmaclay/python-smpp
|
dbb4e97723f17a27f23a81cd3d045b5127b97090
|
QuerySM parameter ordering
|
diff --git a/src/smpp/pdu_builder.py b/src/smpp/pdu_builder.py
index 0ed93e7..1ac7ef7 100644
--- a/src/smpp/pdu_builder.py
+++ b/src/smpp/pdu_builder.py
@@ -1,284 +1,284 @@
from pdu import *
class PDU(object):
def __init__(self,
command_id,
command_status,
sequence_number,
**kwargs):
super(PDU, self).__init__()
self.obj = {}
self.obj['header'] = {}
self.obj['header']['command_length'] = 0
self.obj['header']['command_id'] = command_id
self.obj['header']['command_status'] = command_status
self.obj['header']['sequence_number'] = sequence_number
def __add_optional_parameter(self, tag, value):
if self.obj.get('body') == None:
self.obj['body'] = {}
if self.obj['body'].get('optional_parameters') == None:
self.obj['body']['optional_parameters'] = []
self.obj['body']['optional_parameters'].append({
'tag':tag,
'length':0,
'value':value,
})
def get_obj(self):
return self.obj
def get_hex(self):
return encode_pdu(self.obj)
def get_bin(self):
return pack_pdu(self.obj)
class Bind(PDU):
def __init__(self,
command_id,
sequence_number,
system_id = '',
password = '',
system_type = '',
interface_version = '34',
addr_ton = 0,
addr_npi = 0,
address_range = '',
**kwargs):
super(Bind, self).__init__(
command_id,
'ESME_ROK',
sequence_number,
)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['system_id'] = system_id
self.obj['body']['mandatory_parameters']['password'] = password
self.obj['body']['mandatory_parameters']['system_type'] = system_type
self.obj['body']['mandatory_parameters']['interface_version'] = interface_version
self.obj['body']['mandatory_parameters']['addr_ton'] = addr_ton
self.obj['body']['mandatory_parameters']['addr_npi'] = addr_npi
self.obj['body']['mandatory_parameters']['address_range'] = address_range
class BindTransmitter(Bind):
def __init__(self,
sequence_number,
**kwargs):
super(BindTransmitter, self).__init__('bind_transmitter', sequence_number, **kwargs)
class BindReceiver(Bind):
def __init__(self,
sequence_number,
**kwargs):
super(BindReceiver, self).__init__('bind_receiver', sequence_number, **kwargs)
class BindTransceiver(Bind):
def __init__(self,
sequence_number,
**kwargs):
super(BindTransceiver, self).__init__('bind_transceiver', sequence_number, **kwargs)
class Unbind(PDU):
def __init__(self,
sequence_number,
**kwargs):
super(Unbind, self).__init__('unbind', 'ESME_ROK', sequence_number, **kwargs)
class SM1(PDU):
def __init__(self,
command_id,
sequence_number,
service_type = '',
source_addr_ton = 0,
source_addr_npi = 0,
source_addr = '',
esm_class = 0,
protocol_id = 0,
priority_flag = 0,
schedule_delivery_time = '',
validity_period = '',
registered_delivery = 0,
replace_if_present_flag = 0,
data_coding = 0,
sm_default_msg_id = 0,
sm_length = 0,
short_message = None,
**kwargs):
super(SM1, self).__init__(
command_id,
'ESME_ROK',
sequence_number,
)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['service_type'] = service_type
self.obj['body']['mandatory_parameters']['source_addr_ton'] = source_addr_ton
self.obj['body']['mandatory_parameters']['source_addr_npi'] = source_addr_npi
self.obj['body']['mandatory_parameters']['source_addr'] = source_addr
self.obj['body']['mandatory_parameters']['esm_class'] = esm_class
self.obj['body']['mandatory_parameters']['protocol_id'] = protocol_id
self.obj['body']['mandatory_parameters']['priority_flag'] = priority_flag
self.obj['body']['mandatory_parameters']['schedule_delivery_time'] = schedule_delivery_time
self.obj['body']['mandatory_parameters']['validity_period'] = validity_period
self.obj['body']['mandatory_parameters']['registered_delivery'] = registered_delivery
self.obj['body']['mandatory_parameters']['replace_if_present_flag'] = replace_if_present_flag
self.obj['body']['mandatory_parameters']['data_coding'] = data_coding
self.obj['body']['mandatory_parameters']['sm_default_msg_id'] = sm_default_msg_id
self.obj['body']['mandatory_parameters']['sm_length'] = sm_length
self.obj['body']['mandatory_parameters']['short_message'] = short_message
def add_message_payload(self, value):
self.obj['body']['mandatory_parameters']['sm_length'] = 0
self.obj['body']['mandatory_parameters']['short_message'] = None
self._PDU__add_optional_parameter('message_payload', value)
class SubmitMulti(SM1):
def __init__(self,
sequence_number,
number_of_dests = 0,
dest_address = [],
**kwargs):
super(SubmitMulti, self).__init__('submit_multi', sequence_number, **kwargs)
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['number_of_dests'] = number_of_dests
mandatory_parameters['dest_address'] = [] + dest_address
def addDestinationAddress(self,
destination_addr,
dest_addr_ton = 0,
dest_addr_npi = 0,
):
if isinstance(destination_addr, str) and len(destination_addr) > 0:
new_entry = {
'dest_flag':1,
'dest_addr_ton':dest_addr_ton,
'dest_addr_npi':dest_addr_npi,
'destination_addr':destination_addr,
}
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_address'].append(new_entry)
mandatory_parameters['number_of_dests'] = len(
mandatory_parameters['dest_address'])
return True
else:
return False
def addDistributionList(self,
dl_name,
):
if isinstance(dl_name, str) and len(dl_name) > 0:
new_entry = {
'dest_flag':2,
'dl_name':dl_name,
}
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_address'].append(new_entry)
mandatory_parameters['number_of_dests'] = len(
mandatory_parameters['dest_address'])
return True
else:
return False
class SM2(SM1):
def __init__(self,
command_id,
sequence_number,
dest_addr_ton = 0,
dest_addr_npi = 0,
destination_addr = '',
**kwargs):
super(SM2, self).__init__(command_id, sequence_number, **kwargs)
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_addr_ton'] = dest_addr_ton
mandatory_parameters['dest_addr_npi'] = dest_addr_npi
mandatory_parameters['destination_addr'] = destination_addr
class SubmitSM(SM2):
def __init__(self,
sequence_number,
**kwargs):
super(SubmitSM, self).__init__('submit_sm', sequence_number, **kwargs)
class DeliverSM(SM2):
def __init__(self,
sequence_number,
**kwargs):
super(DeliverSM, self).__init__('deliver_sm',sequence_number, **kwargs)
class DeliverSMResp(PDU):
def __init__(self,
sequence_number,
command_status = 'ESME_ROK',
**kwargs):
super(DeliverSMResp, self).__init__(
'deliver_sm_resp',
command_status,
sequence_number,
**kwargs)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['message_id'] = ''
class EnquireLink(PDU):
def __init__(self,
sequence_number,
**kwargs):
super(EnquireLink, self).__init__(
'enquire_link',
'ESME_ROK',
sequence_number,
**kwargs)
class QuerySM(PDU):
def __init__(self,
sequence_number,
message_id,
+ source_addr = '',
source_addr_ton = 0,
source_addr_npi = 0,
- source_addr = '',
**kwargs):
super(QuerySM, self).__init__(
'query_sm',
'ESME_ROK',
sequence_number,
**kwargs)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['message_id'] = message_id
+ self.obj['body']['mandatory_parameters']['source_addr'] = source_addr
self.obj['body']['mandatory_parameters']['source_addr_ton'] = source_addr_ton
self.obj['body']['mandatory_parameters']['source_addr_npi'] = source_addr_npi
- self.obj['body']['mandatory_parameters']['source_addr'] = source_addr
#bind = BindTransmitter(system_id='test_id', password='abc123')
#print bind.get_obj()
#print bind.get_hex()
#print bind.get_bin()
##print json.dumps(bind.get_obj(), indent=4, sort_keys=True)
##print json.dumps(decode_pdu(bind.get_hex()), indent=4, sort_keys=True)
#print json.dumps(unpack_pdu(bind.get_bin()), indent=4, sort_keys=True)
#sm = SubmitSM(short_message='testing testing')
#print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
#sm.add_message_payload('616263646566676869')
#print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
|
dmaclay/python-smpp
|
e09e2264410c7e96435487c3d985904679f2217e
|
query_sm builder
|
diff --git a/src/smpp/pdu_builder.py b/src/smpp/pdu_builder.py
index c42772d..5706387 100644
--- a/src/smpp/pdu_builder.py
+++ b/src/smpp/pdu_builder.py
@@ -1,263 +1,284 @@
from pdu import *
class PDU(object):
def __init__(self,
command_id,
command_status,
sequence_number,
**kwargs):
super(PDU, self).__init__()
self.obj = {}
self.obj['header'] = {}
self.obj['header']['command_length'] = 0
self.obj['header']['command_id'] = command_id
self.obj['header']['command_status'] = command_status
self.obj['header']['sequence_number'] = sequence_number
def __add_optional_parameter(self, tag, value):
if self.obj.get('body') == None:
self.obj['body'] = {}
if self.obj['body'].get('optional_parameters') == None:
self.obj['body']['optional_parameters'] = []
self.obj['body']['optional_parameters'].append({
'tag':tag,
'length':0,
'value':value,
})
def get_obj(self):
return self.obj
def get_hex(self):
return encode_pdu(self.obj)
def get_bin(self):
return pack_pdu(self.obj)
class Bind(PDU):
def __init__(self,
command_id,
sequence_number,
system_id = '',
password = '',
system_type = '',
interface_version = '34',
addr_ton = 0,
addr_npi = 0,
address_range = '',
**kwargs):
super(Bind, self).__init__(
command_id,
'ESME_ROK',
sequence_number,
)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['system_id'] = system_id
self.obj['body']['mandatory_parameters']['password'] = password
self.obj['body']['mandatory_parameters']['system_type'] = system_type
self.obj['body']['mandatory_parameters']['interface_version'] = interface_version
self.obj['body']['mandatory_parameters']['addr_ton'] = addr_ton
self.obj['body']['mandatory_parameters']['addr_npi'] = addr_npi
self.obj['body']['mandatory_parameters']['address_range'] = address_range
class BindTransmitter(Bind):
def __init__(self,
sequence_number,
**kwargs):
super(BindTransmitter, self).__init__('bind_transmitter', sequence_number, **kwargs)
class BindReceiver(Bind):
def __init__(self,
sequence_number,
**kwargs):
super(BindReceiver, self).__init__('bind_receiver', sequence_number, **kwargs)
class BindTransceiver(Bind):
def __init__(self,
sequence_number,
**kwargs):
super(BindTransceiver, self).__init__('bind_transceiver', sequence_number, **kwargs)
class Unbind(PDU):
def __init__(self,
sequence_number,
**kwargs):
super(Unbind, self).__init__('unbind', 'ESME_ROK', sequence_number, **kwargs)
class SM1(PDU):
def __init__(self,
command_id,
sequence_number,
service_type = '',
source_addr_ton = 0,
source_addr_npi = 0,
source_addr = '',
esm_class = 0,
protocol_id = 0,
priority_flag = 0,
schedule_delivery_time = '',
validity_period = '',
registered_delivery = 0,
replace_if_present_flag = 0,
data_coding = 0,
sm_default_msg_id = 0,
sm_length = 0,
short_message = None,
**kwargs):
super(SM1, self).__init__(
command_id,
'ESME_ROK',
sequence_number,
)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['service_type'] = service_type
self.obj['body']['mandatory_parameters']['source_addr_ton'] = source_addr_ton
self.obj['body']['mandatory_parameters']['source_addr_npi'] = source_addr_npi
self.obj['body']['mandatory_parameters']['source_addr'] = source_addr
self.obj['body']['mandatory_parameters']['esm_class'] = esm_class
self.obj['body']['mandatory_parameters']['protocol_id'] = protocol_id
self.obj['body']['mandatory_parameters']['priority_flag'] = priority_flag
self.obj['body']['mandatory_parameters']['schedule_delivery_time'] = schedule_delivery_time
self.obj['body']['mandatory_parameters']['validity_period'] = validity_period
self.obj['body']['mandatory_parameters']['registered_delivery'] = registered_delivery
self.obj['body']['mandatory_parameters']['replace_if_present_flag'] = replace_if_present_flag
self.obj['body']['mandatory_parameters']['data_coding'] = data_coding
self.obj['body']['mandatory_parameters']['sm_default_msg_id'] = sm_default_msg_id
self.obj['body']['mandatory_parameters']['sm_length'] = sm_length
self.obj['body']['mandatory_parameters']['short_message'] = short_message
def add_message_payload(self, value):
self.obj['body']['mandatory_parameters']['sm_length'] = 0
self.obj['body']['mandatory_parameters']['short_message'] = None
self._PDU__add_optional_parameter('message_payload', value)
class SubmitMulti(SM1):
def __init__(self,
sequence_number,
number_of_dests = 0,
dest_address = [],
**kwargs):
super(SubmitMulti, self).__init__('submit_multi', sequence_number, **kwargs)
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['number_of_dests'] = number_of_dests
mandatory_parameters['dest_address'] = [] + dest_address
def addDestinationAddress(self,
destination_addr,
dest_addr_ton = 0,
dest_addr_npi = 0,
):
if isinstance(destination_addr, str) and len(destination_addr) > 0:
new_entry = {
'dest_flag':1,
'dest_addr_ton':dest_addr_ton,
'dest_addr_npi':dest_addr_npi,
'destination_addr':destination_addr,
}
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_address'].append(new_entry)
mandatory_parameters['number_of_dests'] = len(
mandatory_parameters['dest_address'])
return True
else:
return False
def addDistributionList(self,
dl_name,
):
if isinstance(dl_name, str) and len(dl_name) > 0:
new_entry = {
'dest_flag':2,
'dl_name':dl_name,
}
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_address'].append(new_entry)
mandatory_parameters['number_of_dests'] = len(
mandatory_parameters['dest_address'])
return True
else:
return False
class SM2(SM1):
def __init__(self,
command_id,
sequence_number,
dest_addr_ton = 0,
dest_addr_npi = 0,
destination_addr = '',
**kwargs):
super(SM2, self).__init__(command_id, sequence_number, **kwargs)
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_addr_ton'] = dest_addr_ton
mandatory_parameters['dest_addr_npi'] = dest_addr_npi
mandatory_parameters['destination_addr'] = destination_addr
class SubmitSM(SM2):
def __init__(self,
sequence_number,
**kwargs):
super(SubmitSM, self).__init__('submit_sm', sequence_number, **kwargs)
class DeliverSM(SM2):
def __init__(self,
sequence_number,
**kwargs):
super(DeliverSM, self).__init__('deliver_sm',sequence_number, **kwargs)
class DeliverSMResp(PDU):
def __init__(self,
sequence_number,
command_status = 'ESME_ROK',
**kwargs):
super(DeliverSMResp, self).__init__(
'deliver_sm_resp',
command_status,
sequence_number,
**kwargs)
self.obj['body'] = {}
self.obj['body']['mandatory_parameters'] = {}
self.obj['body']['mandatory_parameters']['message_id'] = ''
class EnquireLink(PDU):
def __init__(self,
sequence_number,
**kwargs):
super(EnquireLink, self).__init__(
'enquire_link',
'ESME_ROK',
sequence_number,
**kwargs)
+class QuerySM(PDU):
+ def __init__(self,
+ sequence_number,
+ message_id,
+ source_addr_ton = 0,
+ source_addr_npi = 0,
+ source_addr = '',
+ **kwargs):
+ super(EnquireLink, self).__init__(
+ 'query_sm',
+ 'ESME_ROK',
+ sequence_number,
+ **kwargs)
+ self.obj['body'] = {}
+ self.obj['body']['mandatory_parameters'] = {}
+ self.obj['body']['mandatory_parameters']['message_id'] = message_id
+ self.obj['body']['mandatory_parameters']['source_addr_ton'] = source_addr_ton
+ self.obj['body']['mandatory_parameters']['source_addr_npi'] = source_addr_npi
+ self.obj['body']['mandatory_parameters']['source_addr'] = source_addr
+
+
#bind = BindTransmitter(system_id='test_id', password='abc123')
#print bind.get_obj()
#print bind.get_hex()
#print bind.get_bin()
##print json.dumps(bind.get_obj(), indent=4, sort_keys=True)
##print json.dumps(decode_pdu(bind.get_hex()), indent=4, sort_keys=True)
#print json.dumps(unpack_pdu(bind.get_bin()), indent=4, sort_keys=True)
#sm = SubmitSM(short_message='testing testing')
#print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
#sm.add_message_payload('616263646566676869')
#print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
|
dmaclay/python-smpp
|
a4bfe08e15c35f56ecf27f1e36fe4b3eaba5a8cb
|
variable length null octet terminatd strings do not count the null octet as part of the length
|
diff --git a/src/smpp/pdu.py b/src/smpp/pdu.py
index 8fe756b..11aaeea 100644
--- a/src/smpp/pdu.py
+++ b/src/smpp/pdu.py
@@ -350,696 +350,697 @@ command_status_by_hex = {
'00000006':{'hex':'00000006', 'name':'ESME_RINVPRTFLG', 'description':'Invalid priority flag'},
'00000007':{'hex':'00000007', 'name':'ESME_RINVREGDLVFLG', 'description':'Invalid registered delivery flag'},
'00000008':{'hex':'00000008', 'name':'ESME_RSYSERR', 'description':'System Error'},
'0000000a':{'hex':'0000000a', 'name':'ESME_RINVSRCADR', 'description':'Invalid source address'},
'0000000b':{'hex':'0000000b', 'name':'ESME_RINVDSTADR', 'description':'Invalid destination address'},
'0000000c':{'hex':'0000000c', 'name':'ESME_RINVMSGID', 'description':'Message ID is invalid'},
'0000000d':{'hex':'0000000d', 'name':'ESME_RBINDFAIL', 'description':'Bind failed'},
'0000000e':{'hex':'0000000e', 'name':'ESME_RINVPASWD', 'description':'Invalid password'},
'0000000f':{'hex':'0000000f', 'name':'ESME_RINVSYSID', 'description':'Invalid System ID'},
'00000011':{'hex':'00000011', 'name':'ESME_RCANCELFAIL', 'description':'Cancel SM Failed'},
'00000013':{'hex':'00000013', 'name':'ESME_RREPLACEFAIL', 'description':'Replace SM Failed'},
'00000014':{'hex':'00000014', 'name':'ESME_RMSGQFUL', 'description':'Message queue full'},
'00000015':{'hex':'00000015', 'name':'ESME_RINVSERTYP', 'description':'Invalid service type'},
'00000033':{'hex':'00000033', 'name':'ESME_RINVNUMDESTS', 'description':'Invalid number of destinations'},
'00000034':{'hex':'00000034', 'name':'ESME_RINVDLNAME', 'description':'Invalid distribution list name'},
'00000040':{'hex':'00000040', 'name':'ESME_RINVDESTFLAG', 'description':'Destination flag is invalid (submit_multi)'},
'00000042':{'hex':'00000042', 'name':'ESME_RINVSUBREP', 'description':"Invalid `submit with replace' request (i.e. submit_sm with replace_if_present_flag set)"},
'00000043':{'hex':'00000043', 'name':'ESME_RINVESMCLASS', 'description':'Invalid esm_class field data'},
'00000044':{'hex':'00000044', 'name':'ESME_RCNTSUBDL', 'description':'Cannot submit to distribution list'},
'00000045':{'hex':'00000045', 'name':'ESME_RSUBMITFAIL', 'description':'submit_sm or submit_multi failed'},
'00000048':{'hex':'00000048', 'name':'ESME_RINVSRCTON', 'description':'Invalid source address TON'},
'00000049':{'hex':'00000049', 'name':'ESME_RINVSRCNPI', 'description':'Invalid source address NPI'},
'00000050':{'hex':'00000050', 'name':'ESME_RINVDSTTON', 'description':'Invalid destination address TON'},
'00000051':{'hex':'00000051', 'name':'ESME_RINVDSTNPI', 'description':'Invalid destination address NPI'},
'00000053':{'hex':'00000053', 'name':'ESME_RINVSYSTYP', 'description':'Invalid system_type field'},
'00000054':{'hex':'00000054', 'name':'ESME_RINVREPFLAG', 'description':'Invalid replace_if_present flag'},
'00000055':{'hex':'00000055', 'name':'ESME_RINVNUMMSGS', 'description':'Invalid number of messages'},
'00000058':{'hex':'00000058', 'name':'ESME_RTHROTTLED', 'description':'Throttling error (ESME has exceeded allowed message limits)'},
'00000061':{'hex':'00000061', 'name':'ESME_RINVSCHED', 'description':'Invalid scheduled delivery time'},
'00000062':{'hex':'00000062', 'name':'ESME_RINVEXPIRY', 'description':'Invalid message validity period (expiry time)'},
'00000063':{'hex':'00000063', 'name':'ESME_RINVDFTMSGID', 'description':'Predefined message invalid or not found'},
'00000064':{'hex':'00000064', 'name':'ESME_RX_T_APPN', 'description':'ESME Receiver Temporary App Error Code'},
'00000065':{'hex':'00000065', 'name':'ESME_RX_P_APPN', 'description':'ESME Receiver Permanent App Error Code'},
'00000066':{'hex':'00000066', 'name':'ESME_RX_R_APPN', 'description':'ESME Receiver Reject Message Error Code'},
'00000067':{'hex':'00000067', 'name':'ESME_RQUERYFAIL', 'description':'query_sm request failed'},
'000000c0':{'hex':'000000c0', 'name':'ESME_RINVOPTPARSTREAM', 'description':'Error in the optional part of the PDU Body'},
'000000c1':{'hex':'000000c1', 'name':'ESME_ROPTPARNOTALLWD', 'description':'Optional paramenter not allowed'},
'000000c2':{'hex':'000000c2', 'name':'ESME_RINVPARLEN', 'description':'Invalid parameter length'},
'000000c3':{'hex':'000000c3', 'name':'ESME_RMISSINGOPTPARAM', 'description':'Expected optional parameter missing'},
'000000c4':{'hex':'000000c4', 'name':'ESME_RINVOPTPARAMVAL', 'description':'Invalid optional parameter value'},
'000000fe':{'hex':'000000fe', 'name':'ESME_RDELIVERYFAILURE', 'description':'Delivery Failure (used for data_sm_resp)'},
'000000ff':{'hex':'000000ff', 'name':'ESME_RUNKNOWNERR', 'description':'Unknown error'}
}
def command_status_name_by_hex(x):
return command_status_by_hex.get(x,{}).get('name')
command_status_by_name = {
'ESME_ROK' :{'hex':'00000000', 'name':'ESME_ROK', 'description':'No error'},
'ESME_RINVMSGLEN' :{'hex':'00000001', 'name':'ESME_RINVMSGLEN', 'description':'Message Length is invalid'},
'ESME_RINVCMDLEN' :{'hex':'00000002', 'name':'ESME_RINVCMDLEN', 'description':'Command Length is invalid'},
'ESME_RINVCMDID' :{'hex':'00000003', 'name':'ESME_RINVCMDID', 'description':'Invalid Command ID'},
'ESME_RINVBNDSTS' :{'hex':'00000004', 'name':'ESME_RINVBNDSTS', 'description':'Incorrect BIND Status for given command'},
'ESME_RALYBND' :{'hex':'00000005', 'name':'ESME_RALYBND', 'description':'ESME Already in bound state'},
'ESME_RINVPRTFLG' :{'hex':'00000006', 'name':'ESME_RINVPRTFLG', 'description':'Invalid priority flag'},
'ESME_RINVREGDLVFLG' :{'hex':'00000007', 'name':'ESME_RINVREGDLVFLG', 'description':'Invalid registered delivery flag'},
'ESME_RSYSERR' :{'hex':'00000008', 'name':'ESME_RSYSERR', 'description':'System Error'},
'ESME_RINVSRCADR' :{'hex':'0000000a', 'name':'ESME_RINVSRCADR', 'description':'Invalid source address'},
'ESME_RINVDSTADR' :{'hex':'0000000b', 'name':'ESME_RINVDSTADR', 'description':'Invalid destination address'},
'ESME_RINVMSGID' :{'hex':'0000000c', 'name':'ESME_RINVMSGID', 'description':'Message ID is invalid'},
'ESME_RBINDFAIL' :{'hex':'0000000d', 'name':'ESME_RBINDFAIL', 'description':'Bind failed'},
'ESME_RINVPASWD' :{'hex':'0000000e', 'name':'ESME_RINVPASWD', 'description':'Invalid password'},
'ESME_RINVSYSID' :{'hex':'0000000f', 'name':'ESME_RINVSYSID', 'description':'Invalid System ID'},
'ESME_RCANCELFAIL' :{'hex':'00000011', 'name':'ESME_RCANCELFAIL', 'description':'Cancel SM Failed'},
'ESME_RREPLACEFAIL' :{'hex':'00000013', 'name':'ESME_RREPLACEFAIL', 'description':'Replace SM Failed'},
'ESME_RMSGQFUL' :{'hex':'00000014', 'name':'ESME_RMSGQFUL', 'description':'Message queue full'},
'ESME_RINVSERTYP' :{'hex':'00000015', 'name':'ESME_RINVSERTYP', 'description':'Invalid service type'},
'ESME_RINVNUMDESTS' :{'hex':'00000033', 'name':'ESME_RINVNUMDESTS', 'description':'Invalid number of destinations'},
'ESME_RINVDLNAME' :{'hex':'00000034', 'name':'ESME_RINVDLNAME', 'description':'Invalid distribution list name'},
'ESME_RINVDESTFLAG' :{'hex':'00000040', 'name':'ESME_RINVDESTFLAG', 'description':'Destination flag is invalid (submit_multi)'},
'ESME_RINVSUBREP' :{'hex':'00000042', 'name':'ESME_RINVSUBREP', 'description':"Invalid `submit with replace' request (i.e. submit_sm with replace_if_present_flag set)"},
'ESME_RINVESMCLASS' :{'hex':'00000043', 'name':'ESME_RINVESMCLASS', 'description':'Invalid esm_class field data'},
'ESME_RCNTSUBDL' :{'hex':'00000044', 'name':'ESME_RCNTSUBDL', 'description':'Cannot submit to distribution list'},
'ESME_RSUBMITFAIL' :{'hex':'00000045', 'name':'ESME_RSUBMITFAIL', 'description':'submit_sm or submit_multi failed'},
'ESME_RINVSRCTON' :{'hex':'00000048', 'name':'ESME_RINVSRCTON', 'description':'Invalid source address TON'},
'ESME_RINVSRCNPI' :{'hex':'00000049', 'name':'ESME_RINVSRCNPI', 'description':'Invalid source address NPI'},
'ESME_RINVDSTTON' :{'hex':'00000050', 'name':'ESME_RINVDSTTON', 'description':'Invalid destination address TON'},
'ESME_RINVDSTNPI' :{'hex':'00000051', 'name':'ESME_RINVDSTNPI', 'description':'Invalid destination address NPI'},
'ESME_RINVSYSTYP' :{'hex':'00000053', 'name':'ESME_RINVSYSTYP', 'description':'Invalid system_type field'},
'ESME_RINVREPFLAG' :{'hex':'00000054', 'name':'ESME_RINVREPFLAG', 'description':'Invalid replace_if_present flag'},
'ESME_RINVNUMMSGS' :{'hex':'00000055', 'name':'ESME_RINVNUMMSGS', 'description':'Invalid number of messages'},
'ESME_RTHROTTLED' :{'hex':'00000058', 'name':'ESME_RTHROTTLED', 'description':'Throttling error (ESME has exceeded allowed message limits)'},
'ESME_RINVSCHED' :{'hex':'00000061', 'name':'ESME_RINVSCHED', 'description':'Invalid scheduled delivery time'},
'ESME_RINVEXPIRY' :{'hex':'00000062', 'name':'ESME_RINVEXPIRY', 'description':'Invalid message validity period (expiry time)'},
'ESME_RINVDFTMSGID' :{'hex':'00000063', 'name':'ESME_RINVDFTMSGID', 'description':'Predefined message invalid or not found'},
'ESME_RX_T_APPN' :{'hex':'00000064', 'name':'ESME_RX_T_APPN', 'description':'ESME Receiver Temporary App Error Code'},
'ESME_RX_P_APPN' :{'hex':'00000065', 'name':'ESME_RX_P_APPN', 'description':'ESME Receiver Permanent App Error Code'},
'ESME_RX_R_APPN' :{'hex':'00000066', 'name':'ESME_RX_R_APPN', 'description':'ESME Receiver Reject Message Error Code'},
'ESME_RQUERYFAIL' :{'hex':'00000067', 'name':'ESME_RQUERYFAIL', 'description':'query_sm request failed'},
'ESME_RINVOPTPARSTREAM':{'hex':'000000c0', 'name':'ESME_RINVOPTPARSTREAM', 'description':'Error in the optional part of the PDU Body'},
'ESME_ROPTPARNOTALLWD' :{'hex':'000000c1', 'name':'ESME_ROPTPARNOTALLWD', 'description':'Optional paramenter not allowed'},
'ESME_RINVPARLEN' :{'hex':'000000c2', 'name':'ESME_RINVPARLEN', 'description':'Invalid parameter length'},
'ESME_RMISSINGOPTPARAM':{'hex':'000000c3', 'name':'ESME_RMISSINGOPTPARAM', 'description':'Expected optional parameter missing'},
'ESME_RINVOPTPARAMVAL' :{'hex':'000000c4', 'name':'ESME_RINVOPTPARAMVAL', 'description':'Invalid optional parameter value'},
'ESME_RDELIVERYFAILURE':{'hex':'000000fe', 'name':'ESME_RDELIVERYFAILURE', 'description':'Delivery Failure (used for data_sm_resp)'},
'ESME_RUNKNOWNERR' :{'hex':'000000ff', 'name':'ESME_RUNKNOWNERR', 'description':'Unknown error'}
}
def command_status_hex_by_name(n):
return command_status_by_name.get(n,{}).get('hex')
# Type of Number (TON) - SMPP v3.4, section 5.2.5, table 5-3, page 117
maps['addr_ton_by_name'] = {
'unknown' :'00',
'international' :'01',
'national' :'02',
'network_specific' :'03',
'subscriber_number':'04',
'alphanumeric' :'05',
'abbreviated' :'06'
}
maps['addr_ton_by_hex'] = {
'00':'unknown',
'01':'international',
'02':'national',
'03':'network_specific',
'04':'subscriber_number',
'05':'alphanumeric',
'06':'abbreviated'
}
# Numberic Plan Indicator (NPI) - SMPP v3.4, section 5.2.6, table 5-4, page 118
maps['addr_npi_by_name'] = {
'unknown' :'00',
'ISDN' :'01',
'data' :'03',
'telex' :'04',
'land_mobile':'06',
'national' :'08',
'private' :'09',
'ERMES' :'0a',
'internet' :'0e',
'WAP' :'12'
}
maps['addr_npi_by_hex'] = {
'00':'unknown',
'01':'ISDN',
'03':'data',
'04':'telex',
'06':'land_mobile',
'08':'national',
'09':'private',
'0a':'ERMES',
'0e':'internet',
'12':'WAP'
}
# ESM Class bits - SMPP v3.4, section 5.2.12, page 121
maps['esm_class_bits'] = {
'mode_mask' :'03',
'type_mask' :'3c',
'feature_mask' :'c0',
'mode_default' :'00',
'mode_datagram' :'01',
'mode_forward' :'02',
'mode_store_and_forward' :'03',
'type_default' :'00',
'type_delivery_receipt' :'04',
'type_delivery_ack' :'08',
'type_0011' :'0a',
'type_user_ack' :'10',
'type_0101' :'14',
'type_conversation_abort' :'18',
'type_0111' :'1a',
'type_intermed_deliv_notif' :'20',
'type_1001' :'24',
'type_1010' :'28',
'type_1011' :'2a',
'type_1100' :'30',
'type_1101' :'34',
'type_1110' :'38',
'type_1111' :'3a',
'feature_none' :'00',
'feature_UDHI' :'40',
'feature_reply_path' :'80',
'feature_UDHI_and_reply_path':'c0'
}
# Registered Delivery bits - SMPP v3.4, section 5.2.17, page 124
maps['registered_delivery_bits'] = {
'receipt_mask' :'03',
'ack_mask' :'0c',
'intermed_notif_mask' :'80',
'receipt_none' :'00',
'receipt_always' :'01',
'receipt_on_fail' :'02',
'receipt_res' :'03',
'ack_none' :'00',
'ack_delivery' :'04',
'ack_user' :'08',
'ack_delivery_and_user':'0c',
'intermed_notif_none' :'00',
'intermed_notif' :'10'
}
# submit_multi dest_flag constants - SMPP v3.4, section 5.2.25, page 129
#maps['dest_flag_by_name'] = {
#'SME Address' :1,
#'Distribution List Name':2
#}
# Message State codes returned in query_sm_resp PDUs - SMPP v3.4, section 5.2.28, table 5-6, page 130
maps['message_state_by_name'] = {
'ENROUTE' :1,
'DELIVERED' :2,
'EXPIRED' :3,
'DELETED' :4,
'UNDELIVERABLE':5,
'ACCEPTED' :6,
'UNKNOWN' :7,
'REJECTED' :8
}
# Facility Code bits for SMPP v4
maps['facility_code_bits'] = {
'GF_PVCY' :'00000001',
'GF_SUBADDR':'00000002',
'NF_CC' :'00080000',
'NF_PDC' :'00010000',
'NF_IS136' :'00020000',
'NF_IS95A' :'00040000'
}
# Optional Parameter Tags - SMPP v3.4, section 5.3.2, Table 5-7, page 132-133
optional_parameter_tag_by_hex = {
'0005':{'hex':'0005', 'name':'dest_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.1, page 134
'0006':{'hex':'0006', 'name':'dest_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.3, page 135
'0007':{'hex':'0007', 'name':'dest_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.5, page 136
'0008':{'hex':'0008', 'name':'dest_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.7, page 137
'000d':{'hex':'000d', 'name':'source_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.2, page 134
'000e':{'hex':'000e', 'name':'source_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.4, page 135
'000f':{'hex':'000f', 'name':'source_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.6, page 136
'0010':{'hex':'0010', 'name':'source_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.8, page 137
'0017':{'hex':'0017', 'name':'qos_time_to_live', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.9, page 138
'0019':{'hex':'0019', 'name':'payload_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.10, page 138
'001d':{'hex':'001d', 'name':'additional_status_info_text', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.11, page 139
'001e':{'hex':'001e', 'name':'receipted_message_id', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.12, page 139
'0030':{'hex':'0030', 'name':'ms_msg_wait_facilities', 'type':'bitmask', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.13, page 140
'0101':{'hex':'0101', 'name':'PVCY_AuthenticationStr', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 58-62
'0201':{'hex':'0201', 'name':'privacy_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.14, page 141
'0202':{'hex':'0202', 'name':'source_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.15, page 142
'0203':{'hex':'0203', 'name':'dest_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.16, page 143
'0204':{'hex':'0204', 'name':'user_message_reference', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.17, page 143
'0205':{'hex':'0205', 'name':'user_response_code', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.18, page 144
'020a':{'hex':'020a', 'name':'source_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.20, page 145
'020b':{'hex':'020b', 'name':'destination_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.21, page 145
'020c':{'hex':'020c', 'name':'sar_msg_ref_num', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.22, page 146
'020d':{'hex':'020d', 'name':'language_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.19, page 144
'020e':{'hex':'020e', 'name':'sar_total_segments', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.23, page 147
'020f':{'hex':'020f', 'name':'sar_segment_seqnum', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.24, page 147
'0210':{'hex':'0210', 'name':'sc_interface_version', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.25, page 148
'0301':{'hex':'0301', 'name':'CC_CBN', 'type':None, 'tech':'V4'}, # v4 page 70
'0302':{'hex':'0302', 'name':'callback_num_pres_ind', 'type':'bitmask', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.37, page 156
'0303':{'hex':'0303', 'name':'callback_num_atag', 'type':'hex', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.38, page 157
'0304':{'hex':'0304', 'name':'number_of_messages', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.39, page 158
'0381':{'hex':'0381', 'name':'callback_num', 'type':'hex', 'tech':'CDMA, TDMA, GSM, iDEN'}, # SMPP v3.4, section 5.3.2.36, page 155
'0420':{'hex':'0420', 'name':'dpf_result', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.28, page 149
'0421':{'hex':'0421', 'name':'set_dpf', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.29, page 150
'0422':{'hex':'0422', 'name':'ms_availability_status', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.30, page 151
'0423':{'hex':'0423', 'name':'network_error_code', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.31, page 152
'0424':{'hex':'0424', 'name':'message_payload', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.32, page 153
'0425':{'hex':'0425', 'name':'delivery_failure_reason', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.33, page 153
'0426':{'hex':'0426', 'name':'more_messages_to_send', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.34, page 154
'0427':{'hex':'0427', 'name':'message_state', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.35, page 154
'0428':{'hex':'0428', 'name':'congestion_state', 'type':None, 'tech':'Generic'},
'0501':{'hex':'0501', 'name':'ussd_service_op', 'type':'hex', 'tech':'GSM (USSD)'}, # SMPP v3.4, section 5.3.2.44, page 161
'0600':{'hex':'0600', 'name':'broadcast_channel_indicator', 'type':None, 'tech':'GSM'},
'0601':{'hex':'0601', 'name':'broadcast_content_type', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'0602':{'hex':'0602', 'name':'broadcast_content_type_info', 'type':None, 'tech':'CDMA, TDMA'},
'0603':{'hex':'0603', 'name':'broadcast_message_class', 'type':None, 'tech':'GSM'},
'0604':{'hex':'0604', 'name':'broadcast_rep_num', 'type':None, 'tech':'GSM'},
'0605':{'hex':'0605', 'name':'broadcast_frequency_interval', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'0606':{'hex':'0606', 'name':'broadcast_area_identifier', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'0607':{'hex':'0607', 'name':'broadcast_error_status', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'0608':{'hex':'0608', 'name':'broadcast_area_success', 'type':None, 'tech':'GSM'},
'0609':{'hex':'0609', 'name':'broadcast_end_time', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'060a':{'hex':'060a', 'name':'broadcast_service_group', 'type':None, 'tech':'CDMA, TDMA'},
'060b':{'hex':'060b', 'name':'billing_identification', 'type':None, 'tech':'Generic'},
'060d':{'hex':'060d', 'name':'source_network_id', 'type':None, 'tech':'Generic'},
'060e':{'hex':'060e', 'name':'dest_network_id', 'type':None, 'tech':'Generic'},
'060f':{'hex':'060f', 'name':'source_node_id', 'type':None, 'tech':'Generic'},
'0610':{'hex':'0610', 'name':'dest_node_id', 'type':None, 'tech':'Generic'},
'0611':{'hex':'0611', 'name':'dest_addr_np_resolution', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'0612':{'hex':'0612', 'name':'dest_addr_np_information', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'0613':{'hex':'0613', 'name':'dest_addr_np_country', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'1101':{'hex':'1101', 'name':'PDC_MessageClass', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 75
'1102':{'hex':'1102', 'name':'PDC_PresentationOption', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
'1103':{'hex':'1103', 'name':'PDC_AlertMechanism', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
'1104':{'hex':'1104', 'name':'PDC_Teleservice', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
'1105':{'hex':'1105', 'name':'PDC_MultiPartMessage', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
'1106':{'hex':'1106', 'name':'PDC_PredefinedMsg', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 78
'1201':{'hex':'1201', 'name':'display_time', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.26, page 148
'1203':{'hex':'1203', 'name':'sms_signal', 'type':'integer', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.40, page 158
'1204':{'hex':'1204', 'name':'ms_validity', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.27, page 149
'1304':{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'type':None, 'tech':'CDMA'}, # v4 page 85
'1306':{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'type':None, 'tech':'CDMA'}, # v4 page 86
'130c':{'hex':'130c', 'name':'alert_on_message_delivery', 'type':None, 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.41, page 159
'1380':{'hex':'1380', 'name':'its_reply_type', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.42, page 159
'1383':{'hex':'1383', 'name':'its_session_info', 'type':'hex', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.43, page 160
'1402':{'hex':'1402', 'name':'operator_id', 'type':None, 'tech':'vendor extension'},
'1403':{'hex':'1403', 'name':'tariff', 'type':None, 'tech':'Mobile Network Code vendor extension'},
'1450':{'hex':'1450', 'name':'mcc', 'type':None, 'tech':'Mobile Country Code vendor extension'},
'1451':{'hex':'1451', 'name':'mnc', 'type':None, 'tech':'Mobile Network Code vendor extension'}
}
def optional_parameter_tag_name_by_hex(x):
return optional_parameter_tag_by_hex.get(x,{}).get('name')
def optional_parameter_tag_type_by_hex(x):
return optional_parameter_tag_by_hex.get(x,{}).get('type')
optional_parameter_tag_by_name = {
'dest_addr_subunit' :{'hex':'0005', 'name':'dest_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.1, page 134
'dest_network_type' :{'hex':'0006', 'name':'dest_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.3, page 135
'dest_bearer_type' :{'hex':'0007', 'name':'dest_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.5, page 136
'dest_telematics_id' :{'hex':'0008', 'name':'dest_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.7, page 137
'source_addr_subunit' :{'hex':'000d', 'name':'source_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.2, page 134
'source_network_type' :{'hex':'000e', 'name':'source_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.4, page 135
'source_bearer_type' :{'hex':'000f', 'name':'source_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.6, page 136
'source_telematics_id' :{'hex':'0010', 'name':'source_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.8, page 137
'qos_time_to_live' :{'hex':'0017', 'name':'qos_time_to_live', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.9, page 138
'payload_type' :{'hex':'0019', 'name':'payload_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.10, page 138
'additional_status_info_text' :{'hex':'001d', 'name':'additional_status_info_text', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.11, page 139
'receipted_message_id' :{'hex':'001e', 'name':'receipted_message_id', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.12, page 139
'ms_msg_wait_facilities' :{'hex':'0030', 'name':'ms_msg_wait_facilities', 'type':'bitmask', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.13, page 140
'PVCY_AuthenticationStr' :{'hex':'0101', 'name':'PVCY_AuthenticationStr', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 58-62
'privacy_indicator' :{'hex':'0201', 'name':'privacy_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.14, page 141
'source_subaddress' :{'hex':'0202', 'name':'source_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.15, page 142
'dest_subaddress' :{'hex':'0203', 'name':'dest_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.16, page 143
'user_message_reference' :{'hex':'0204', 'name':'user_message_reference', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.17, page 143
'user_response_code' :{'hex':'0205', 'name':'user_response_code', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.18, page 144
'source_port' :{'hex':'020a', 'name':'source_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.20, page 145
'destination_port' :{'hex':'020b', 'name':'destination_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.21, page 145
'sar_msg_ref_num' :{'hex':'020c', 'name':'sar_msg_ref_num', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.22, page 146
'language_indicator' :{'hex':'020d', 'name':'language_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.19, page 144
'sar_total_segments' :{'hex':'020e', 'name':'sar_total_segments', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.23, page 147
'sar_segment_seqnum' :{'hex':'020f', 'name':'sar_segment_seqnum', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.24, page 147
'sc_interface_version' :{'hex':'0210', 'name':'sc_interface_version', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.25, page 148
'CC_CBN' :{'hex':'0301', 'name':'CC_CBN', 'type':None, 'tech':'V4'}, # v4 page 70
'callback_num_pres_ind' :{'hex':'0302', 'name':'callback_num_pres_ind', 'type':'bitmask', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.37, page 156
'callback_num_atag' :{'hex':'0303', 'name':'callback_num_atag', 'type':'hex', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.38, page 157
'number_of_messages' :{'hex':'0304', 'name':'number_of_messages', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.39, page 158
'callback_num' :{'hex':'0381', 'name':'callback_num', 'type':'hex', 'tech':'CDMA, TDMA, GSM, iDEN'}, # SMPP v3.4, section 5.3.2.36, page 155
'dpf_result' :{'hex':'0420', 'name':'dpf_result', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.28, page 149
'set_dpf' :{'hex':'0421', 'name':'set_dpf', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.29, page 150
'ms_availability_status' :{'hex':'0422', 'name':'ms_availability_status', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.30, page 151
'network_error_code' :{'hex':'0423', 'name':'network_error_code', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.31, page 152
'message_payload' :{'hex':'0424', 'name':'message_payload', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.32, page 153
'delivery_failure_reason' :{'hex':'0425', 'name':'delivery_failure_reason', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.33, page 153
'more_messages_to_send' :{'hex':'0426', 'name':'more_messages_to_send', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.34, page 154
'message_state' :{'hex':'0427', 'name':'message_state', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.35, page 154
'congestion_state' :{'hex':'0428', 'name':'congestion_state', 'type':None, 'tech':'Generic'},
'ussd_service_op' :{'hex':'0501', 'name':'ussd_service_op', 'type':'hex', 'tech':'GSM (USSD)'}, # SMPP v3.4, section 5.3.2.44, page 161
'broadcast_channel_indicator' :{'hex':'0600', 'name':'broadcast_channel_indicator', 'type':None, 'tech':'GSM'},
'broadcast_content_type' :{'hex':'0601', 'name':'broadcast_content_type', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_content_type_info' :{'hex':'0602', 'name':'broadcast_content_type_info', 'type':None, 'tech':'CDMA, TDMA'},
'broadcast_message_class' :{'hex':'0603', 'name':'broadcast_message_class', 'type':None, 'tech':'GSM'},
'broadcast_rep_num' :{'hex':'0604', 'name':'broadcast_rep_num', 'type':None, 'tech':'GSM'},
'broadcast_frequency_interval':{'hex':'0605', 'name':'broadcast_frequency_interval', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_area_identifier' :{'hex':'0606', 'name':'broadcast_area_identifier', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_error_status' :{'hex':'0607', 'name':'broadcast_error_status', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_area_success' :{'hex':'0608', 'name':'broadcast_area_success', 'type':None, 'tech':'GSM'},
'broadcast_end_time' :{'hex':'0609', 'name':'broadcast_end_time', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_service_group' :{'hex':'060a', 'name':'broadcast_service_group', 'type':None, 'tech':'CDMA, TDMA'},
'billing_identification' :{'hex':'060b', 'name':'billing_identification', 'type':None, 'tech':'Generic'},
'source_network_id' :{'hex':'060d', 'name':'source_network_id', 'type':None, 'tech':'Generic'},
'dest_network_id' :{'hex':'060e', 'name':'dest_network_id', 'type':None, 'tech':'Generic'},
'source_node_id' :{'hex':'060f', 'name':'source_node_id', 'type':None, 'tech':'Generic'},
'dest_node_id' :{'hex':'0610', 'name':'dest_node_id', 'type':None, 'tech':'Generic'},
'dest_addr_np_resolution' :{'hex':'0611', 'name':'dest_addr_np_resolution', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'dest_addr_np_information' :{'hex':'0612', 'name':'dest_addr_np_information', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'dest_addr_np_country' :{'hex':'0613', 'name':'dest_addr_np_country', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'PDC_MessageClass' :{'hex':'1101', 'name':'PDC_MessageClass', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 75
'PDC_PresentationOption' :{'hex':'1102', 'name':'PDC_PresentationOption', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
'PDC_AlertMechanism' :{'hex':'1103', 'name':'PDC_AlertMechanism', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
'PDC_Teleservice' :{'hex':'1104', 'name':'PDC_Teleservice', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
'PDC_MultiPartMessage' :{'hex':'1105', 'name':'PDC_MultiPartMessage', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
'PDC_PredefinedMsg' :{'hex':'1106', 'name':'PDC_PredefinedMsg', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 78
'display_time' :{'hex':'1201', 'name':'display_time', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.26, page 148
'sms_signal' :{'hex':'1203', 'name':'sms_signal', 'type':'integer', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.40, page 158
'ms_validity' :{'hex':'1204', 'name':'ms_validity', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.27, page 149
'IS95A_AlertOnDelivery' :{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'type':None, 'tech':'CDMA'}, # v4 page 85
'IS95A_LanguageIndicator' :{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'type':None, 'tech':'CDMA'}, # v4 page 86
'alert_on_message_delivery' :{'hex':'130c', 'name':'alert_on_message_delivery', 'type':None, 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.41, page 159
'its_reply_type' :{'hex':'1380', 'name':'its_reply_type', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.42, page 159
'its_session_info' :{'hex':'1383', 'name':'its_session_info', 'type':'hex', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.43, page 160
'operator_id' :{'hex':'1402', 'name':'operator_id', 'type':None, 'tech':'vendor extension'},
'tariff' :{'hex':'1403', 'name':'tariff', 'type':None, 'tech':'Mobile Network Code vendor extension'},
'mcc' :{'hex':'1450', 'name':'mcc', 'type':None, 'tech':'Mobile Country Code vendor extension'},
'mnc' :{'hex':'1451', 'name':'mnc', 'type':None, 'tech':'Mobile Network Code vendor extension'}
}
def optional_parameter_tag_hex_by_name(n):
return optional_parameter_tag_by_name.get(n,{}).get('hex')
#### Decoding functions #######################################################
def unpack_pdu(pdu_bin):
return decode_pdu(binascii.b2a_hex(pdu_bin))
def decode_pdu(pdu_hex):
hex_ref = [pdu_hex]
pdu = {}
pdu['header'] = decode_header(hex_ref)
command = pdu['header'].get('command_id', None)
if command != None:
body = decode_body(command, hex_ref)
if len(body) > 0:
pdu['body'] = body
return pdu
def decode_header(hex_ref):
pdu_hex = hex_ref[0]
header = {}
(command_length, command_id, command_status, sequence_number, hex_ref[0]) = \
(pdu_hex[0:8], pdu_hex[8:16], pdu_hex[16:24], pdu_hex[24:32], pdu_hex[32: ])
length = int(command_length, 16)
command = command_id_name_by_hex(command_id)
status = command_status_name_by_hex(command_status)
sequence = int(sequence_number, 16)
header = {}
header['command_length'] = length
header['command_id'] = command
header['command_status'] = status
header['sequence_number'] = sequence
return header
def decode_body(command, hex_ref):
body = {}
if command != None:
fields = mandatory_parameter_list_by_command_name(command)
mandatory = decode_mandatory_parameters(fields, hex_ref)
if len(mandatory) > 0:
body['mandatory_parameters'] = mandatory
optional = decode_optional_parameters(hex_ref)
if len(optional) > 0:
body['optional_parameters'] = optional
return body
def decode_mandatory_parameters(fields, hex_ref):
mandatory_parameters = {}
if len(hex_ref[0]) > 1:
for field in fields:
#old = len(hex_ref[0])
data = ''
octet = ''
count = 0
if field['var'] == True or field['var'] == False:
while (len(hex_ref[0]) > 1
and (count < field['min']
- or (count < field['max']
+ or (field['var'] == True
+ and count < field['max']+1
and octet != '00'))):
octet = octpop(hex_ref)
data += octet
count += 1
elif field['type'] in ['string', 'xstring']:
count = mandatory_parameters[field['var']]
if count == 0:
data = None
else:
for i in range(count):
if len(hex_ref[0]) > 1:
data += octpop(hex_ref)
else:
count = mandatory_parameters[field['var']]
if field['map'] != None:
mandatory_parameters[field['name']] = maps[field['map']+'_by_hex'].get(data, None)
if field['map'] == None or mandatory_parameters[field['name']] == None:
mandatory_parameters[field['name']] = decode_hex_type(data, field['type'], count, hex_ref)
#print field['type'], (old - len(hex_ref[0]))/2, repr(data), field['name'], mandatory_parameters[field['name']]
return mandatory_parameters
def decode_optional_parameters(hex_ref):
optional_parameters = []
hex = hex_ref[0]
while len(hex) > 0:
(tag_hex, length_hex, rest) = (hex[0:4], hex[4:8], hex[8: ])
tag = optional_parameter_tag_name_by_hex(tag_hex)
if tag == None:
tag = tag_hex
length = int(length_hex, 16)
(value_hex, tail) = (rest[0:length*2], rest[length*2: ])
if len(value_hex) == 0:
value = None
else:
value = decode_hex_type(value_hex, optional_parameter_tag_type_by_hex(tag_hex))
hex = tail
optional_parameters.append({'tag':tag, 'length':length, 'value':value})
return optional_parameters
def decode_hex_type(hex, type, count=0, hex_ref=['']):
if hex == None:
return hex
elif type == 'integer':
return int(hex, 16)
elif type == 'string':
return re.sub('00','',hex).decode('hex')
elif type == 'xstring':
return hex.decode('hex')
elif (type == 'dest_address'
or type == 'unsuccess_sme'):
list = []
fields = mandatory_parameter_list_by_command_name(type)
for i in range(count):
item = decode_mandatory_parameters(fields, hex_ref)
if item.get('dest_flag', None) == 1: # 'dest_address' only
subfields = mandatory_parameter_list_by_command_name('sme_dest_address')
rest = decode_mandatory_parameters(subfields, hex_ref)
item.update(rest)
elif item.get('dest_flag', None) == 2: # 'dest_address' only
subfields = mandatory_parameter_list_by_command_name('distribution_list')
rest = decode_mandatory_parameters(subfields, hex_ref)
item.update(rest)
list.append(item)
return list
else:
return hex
def octpop(hex_ref):
octet = None
if len(hex_ref[0]) > 1:
(octet, hex_ref[0]) = (hex_ref[0][0:2], hex_ref[0][2: ])
return octet
#### Encoding functions #######################################################
def pack_pdu(pdu_obj):
return binascii.a2b_hex(encode_pdu(pdu_obj))
def encode_pdu(pdu_obj):
header = pdu_obj.get('header', {})
body = pdu_obj.get('body', {})
mandatory = body.get('mandatory_parameters', {})
optional = body.get('optional_parameters', [])
body_hex = ''
fields = mandatory_parameter_list_by_command_name(header['command_id'])
body_hex += encode_mandatory_parameters(mandatory, fields)
for opt in optional:
body_hex += encode_optional_parameter(opt['tag'], opt['value'])
actual_length = 16 + len(body_hex)/2
command_length = '%08x' % actual_length
command_id = command_id_hex_by_name(header['command_id'])
command_status = command_status_hex_by_name(header['command_status'])
sequence_number = '%08x' % header['sequence_number']
pdu_hex = command_length + command_id + command_status + sequence_number + body_hex
return pdu_hex
def encode_mandatory_parameters(mandatory_obj, fields):
mandatory_hex_array = []
index_names = {}
index = 0
for field in fields:
param = mandatory_obj.get(field['name'], None)
param_length = None
if param != None or field['min'] > 0:
map = None
if field['map'] != None:
map = maps.get(field['map']+'_by_name', None)
if isinstance(param, list):
hex_list = []
for item in param:
flagfields = mandatory_parameter_list_by_command_name(field['type'])
plusfields = []
if item.get('dest_flag', None) == 1:
plusfields = mandatory_parameter_list_by_command_name('sme_dest_address')
elif item.get('dest_flag', None) == 2:
plusfields = mandatory_parameter_list_by_command_name('distribution_list')
hex_item = encode_mandatory_parameters(item, flagfields + plusfields)
if isinstance(hex_item, str) and len(hex_item) > 0:
hex_list.append(hex_item)
param_length = len(hex_list)
mandatory_hex_array.append(''.join(hex_list))
else:
hex_param = encode_param_type(
param, field['type'], field['min'], field['max'], map)
param_length = len(hex_param)/2
mandatory_hex_array.append(hex_param)
index_names[field['name']] = index
length_index = index_names.get(field['var'], None)
if length_index != None and param_length != None:
mandatory_hex_array[length_index] = encode_param_type(
param_length,
'integer',
len(mandatory_hex_array[length_index])/2)
index += 1
return ''.join(mandatory_hex_array)
def encode_optional_parameter(tag, value):
optional_hex_array = []
tag_hex = optional_parameter_tag_hex_by_name(tag)
if tag_hex != None:
value_hex = encode_param_type(
value,
optional_parameter_tag_type_by_hex(tag_hex))
length_hex = '%04x' % (len(value_hex)/2)
optional_hex_array.append(tag_hex + length_hex + value_hex)
return ''.join(optional_hex_array)
def encode_param_type(param, type, min=0, max=None, map=None):
if param == None:
hex = None
elif map != None:
if type == 'integer' and isinstance(param, int):
hex = ('%0'+str(min*2)+'x') % param
else:
hex = map.get(param, ('%0'+str(min*2)+'x') % 0)
elif type == 'integer':
hex = ('%0'+str(min*2)+'x') % int(param)
elif type == 'string':
hex = param.encode('hex') + '00'
elif type == 'xstring':
hex = param.encode('hex')
elif type == 'bitmask':
hex = param
elif type == 'hex':
hex = param
else:
hex = None
#if hex == None:
#hex = ''
#if min > 0:
#hex = ('%0'+str(min*2)+'x') % 0
#print type, min, max, repr(param), hex, map
return hex
|
dmaclay/python-smpp
|
1b2feb174da585fb03558d70ac65588dbcd75832
|
short_message fix -> added 'xstring' type = no trailing '00'
|
diff --git a/src/smpp/pdu.py b/src/smpp/pdu.py
index 64eed55..8fe756b 100644
--- a/src/smpp/pdu.py
+++ b/src/smpp/pdu.py
@@ -1,1041 +1,1045 @@
import binascii
import re
try:
import json
except:
import simplejson as json
maps = {} # Inserting certain referenced dicts in here means they can be declared in the same order as in the spec.
# SMPP PDU Definition - SMPP v3.4, section 4, page 45
mandatory_parameter_lists = {
'bind_transmitter':[ # SMPP v3.4, section 4.1.1, table 4-1, page 46
{'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None},
{'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'map':None},
{'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'map':None},
{'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'hex', 'map':None},
{'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'map':None}
],
'bind_transmitter_resp':[ # SMPP v3.4, section 4.1.2, table 4-2, page 47
{'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None}
],
'bind_receiver':[ # SMPP v3.4, section 4.1.3, table 4-3, page 48
{'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None},
{'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'map':None},
{'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'map':None},
{'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'hex', 'map':None},
{'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'map':None}
],
'bind_receiver_resp':[ # SMPP v3.4, section 4.1.4, table 4-4, page 50
{'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None}
],
'bind_transceiver':[ # SMPP v3.4, section 4.1.5, table 4-5, page 51
{'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None},
{'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'map':None},
{'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'map':None},
{'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'hex', 'map':None},
{'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'map':None}
],
'bind_transceiver_resp':[ # SMPP v3.4, section 4.1.6, table 4-6, page 52
{'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None}
],
'outbind':[ # SMPP v3.4, section 4.1.7.1, page 54
{'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None},
{'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'map':None}
],
'unbind':[ # SMPP v3.4, section 4.2.1, table 4-7, page 56
],
'unbind_resp':[ # SMPP v3.4, section 4.2.2, table 4-8, page 56
],
'generic_nack':[ # SMPP v3.4, section 4.3.1, table 4-9, page 57
],
'submit_sm':[ # SMPP v3.4, section 4.4.1, table 4-10, page 59-61
{'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
{'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
{'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
- {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'map':None}
+ {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'xstring', 'map':None}
],
'submit_sm_resp':[ # SMPP v3.4, section 4.4.2, table 4-11, page 67
{'name':'message_id', 'min':0, 'max':65, 'var':True, 'type':'string', 'map':None}
],
'submit_multi':[ # SMPP v3.4, section 4.5.1, table 4-12, page 69-71
{'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'number_of_dests', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'dest_address', 'min':0, 'max':0, 'var':'number_of_dests', 'type':'dest_address', 'map':None},
{'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
{'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
{'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
- {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'map':None}
+ {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'xstring', 'map':None}
],
'dest_address':[ # SMPP v3.4, section 4.5.1.1, table 4-13, page 75
{'name':'dest_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None}
# 'sme_dest_address' or 'distribution_list' goes here
],
'sme_dest_address':[ # SMPP v3.4, section 4.5.1.1, table 4-14, page 75
{'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None}
],
'distribution_list':[ # SMPP v3.4, section 4.5.1.2, table 4-15, page 75
{'name':'dl_name', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None}
],
'submit_multi_resp':[ # SMPP v3.4, section 4.5.2, table 4-16, page 76
{'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'no_unsuccess', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'unsuccess_sme', 'min':0, 'max':0, 'var':'no_unsuccess', 'type':'unsuccess_sme', 'map':None}
],
'unsuccess_sme':[ # SMPP v3.4, section 4.5.2.1, table 4-17, page 77
{'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'error_status_code', 'min':4, 'max':4, 'var':False, 'type':'integer', 'map':None}
],
'deliver_sm':[ # SMPP v3.4, section 4.6.1, table 4-18, page 79-81
{'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'schedule_delivery_time', 'min':1, 'max':1, 'var':False, 'type':'string', 'map':None},
{'name':'validity_period', 'min':1, 'max':1, 'var':False, 'type':'string', 'map':None},
{'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
- {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'map':None}
+ {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'xstring', 'map':None}
],
'deliver_sm_resp':[ # SMPP v3.4, section 4.6.2, table 4-19, page 85
{'name':'message_id', 'min':1, 'max':1, 'var':False, 'type':'string', 'map':None}
],
'data_sm':[ # SMPP v3.4, section 4.7.1, table 4-20, page 87-88
{'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'destination_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None}
],
'data_sm_resp':[ # SMPP v3.4, section 4.7.2, table 4-21, page 93
{'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None}
],
'query_sm':[ # SMPP v3.4, section 4.8.1, table 4-22, page 95
{'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None}
],
'query_sm_resp':[ # SMPP v3.4, section 4.7.2, table 4-21, page 93
{'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'final_date', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
{'name':'message_state', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'error_code', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None}
],
'cancel_sm':[ # SMPP v3.4, section 4.9.1, table 4-24, page 98-99
{'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'map':None},
{'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None}
],
'cancel_sm_resp':[ # SMPP v3.4, section 4.9.2, table 4-25, page 100
],
'replace_sm':[ # SMPP v3.4, section 4.10.1, table 4-26, page 102-103
{'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
{'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
{'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
- {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'map':None}
+ {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'xstring', 'map':None}
],
'replace_sm_resp':[ # SMPP v3.4, section 4.10.2, table 4-27, page 104
],
'enquire_link':[ # SMPP v3.4, section 4.11.1, table 4-28, page 106
],
'enquire_link_resp':[ # SMPP v3.4, section 4.11.2, table 4-29, page 106
],
'alert_notification':[ # SMPP v3.4, section 4.12.1, table 4-30, page 108
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'esme_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'esme_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'esme_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
]
}
def mandatory_parameter_list_by_command_name(command_name):
return mandatory_parameter_lists.get(command_name,[])
# Command IDs - SMPP v3.4, section 5.1.2.1, table 5-1, page 110-111
command_id_by_hex = {
'80000000':{'hex':'80000000', 'name':'generic_nack'},
'00000001':{'hex':'00000001', 'name':'bind_receiver'},
'80000001':{'hex':'80000001', 'name':'bind_receiver_resp'},
'00000002':{'hex':'00000002', 'name':'bind_transmitter'},
'80000002':{'hex':'80000002', 'name':'bind_transmitter_resp'},
'00000003':{'hex':'00000003', 'name':'query_sm'},
'80000003':{'hex':'80000003', 'name':'query_sm_resp'},
'00000004':{'hex':'00000004', 'name':'submit_sm'},
'80000004':{'hex':'80000004', 'name':'submit_sm_resp'},
'00000005':{'hex':'00000005', 'name':'deliver_sm'},
'80000005':{'hex':'80000005', 'name':'deliver_sm_resp'},
'00000006':{'hex':'00000006', 'name':'unbind'},
'80000006':{'hex':'80000006', 'name':'unbind_resp'},
'00000007':{'hex':'00000007', 'name':'replace_sm'},
'80000007':{'hex':'80000007', 'name':'replace_sm_resp'},
'00000008':{'hex':'00000008', 'name':'cancel_sm'},
'80000008':{'hex':'80000008', 'name':'cancel_sm_resp'},
'00000009':{'hex':'00000009', 'name':'bind_transceiver'},
'80000009':{'hex':'80000009', 'name':'bind_transceiver_resp'},
'0000000b':{'hex':'0000000b', 'name':'outbind'},
'00000015':{'hex':'00000015', 'name':'enquire_link'},
'80000015':{'hex':'80000015', 'name':'enquire_link_resp'},
'00000021':{'hex':'00000021', 'name':'submit_multi'},
'80000021':{'hex':'80000021', 'name':'submit_multi_resp'},
'00000102':{'hex':'00000102', 'name':'alert_notification'},
'00000103':{'hex':'00000103', 'name':'data_sm'},
'80000103':{'hex':'80000103', 'name':'data_sm_resp'},
# v4 codes
'80010000':{'hex':'80010000', 'name':'generic_nack_v4'},
'00010001':{'hex':'00010001', 'name':'bind_receiver_v4'},
'80010001':{'hex':'80010001', 'name':'bind_receiver_resp_v4'},
'00010002':{'hex':'00010002', 'name':'bind_transmitter_v4'},
'80010002':{'hex':'80010002', 'name':'bind_transmitter_resp_v4'},
'00010003':{'hex':'00010003', 'name':'query_sm_v4'},
'80010003':{'hex':'80010003', 'name':'query_sm_resp_v4'},
'00010004':{'hex':'00010004', 'name':'submit_sm_v4'},
'80010004':{'hex':'80010004', 'name':'submit_sm_resp_v4'},
'00010005':{'hex':'00010005', 'name':'deliver_sm_v4'},
'80010005':{'hex':'80010005', 'name':'deliver_sm_resp_v4'},
'00010006':{'hex':'00010006', 'name':'unbind_v4'},
'80010006':{'hex':'80010006', 'name':'unbind_resp_v4'},
'00010007':{'hex':'00010007', 'name':'replace_sm_v4'},
'80010007':{'hex':'80010007', 'name':'replace_sm_resp_v4'},
'00010008':{'hex':'00010008', 'name':'cancel_sm_v4'},
'80010008':{'hex':'80010008', 'name':'cancel_sm_resp_v4'},
'00010009':{'hex':'00010009', 'name':'delivery_receipt_v4'},
'80010009':{'hex':'80010009', 'name':'delivery_receipt_resp_v4'},
'0001000a':{'hex':'0001000a', 'name':'enquire_link_v4'},
'8001000a':{'hex':'8001000a', 'name':'enquire_link_resp_v4'},
'0001000b':{'hex':'0001000b', 'name':'outbind_v4'},
}
def command_id_name_by_hex(x):
return command_id_by_hex.get(x,{}).get('name')
command_id_by_name = {
'generic_nack' :{'hex':'80000000', 'name':'generic_nack'},
'bind_receiver' :{'hex':'00000001', 'name':'bind_receiver'},
'bind_receiver_resp' :{'hex':'80000001', 'name':'bind_receiver_resp'},
'bind_transmitter' :{'hex':'00000002', 'name':'bind_transmitter'},
'bind_transmitter_resp' :{'hex':'80000002', 'name':'bind_transmitter_resp'},
'query_sm' :{'hex':'00000003', 'name':'query_sm'},
'query_sm_resp' :{'hex':'80000003', 'name':'query_sm_resp'},
'submit_sm' :{'hex':'00000004', 'name':'submit_sm'},
'submit_sm_resp' :{'hex':'80000004', 'name':'submit_sm_resp'},
'deliver_sm' :{'hex':'00000005', 'name':'deliver_sm'},
'deliver_sm_resp' :{'hex':'80000005', 'name':'deliver_sm_resp'},
'unbind' :{'hex':'00000006', 'name':'unbind'},
'unbind_resp' :{'hex':'80000006', 'name':'unbind_resp'},
'replace_sm' :{'hex':'00000007', 'name':'replace_sm'},
'replace_sm_resp' :{'hex':'80000007', 'name':'replace_sm_resp'},
'cancel_sm' :{'hex':'00000008', 'name':'cancel_sm'},
'cancel_sm_resp' :{'hex':'80000008', 'name':'cancel_sm_resp'},
'bind_transceiver' :{'hex':'00000009', 'name':'bind_transceiver'},
'bind_transceiver_resp' :{'hex':'80000009', 'name':'bind_transceiver_resp'},
'outbind' :{'hex':'0000000b', 'name':'outbind'},
'enquire_link' :{'hex':'00000015', 'name':'enquire_link'},
'enquire_link_resp' :{'hex':'80000015', 'name':'enquire_link_resp'},
'submit_multi' :{'hex':'00000021', 'name':'submit_multi'},
'submit_multi_resp' :{'hex':'80000021', 'name':'submit_multi_resp'},
'alert_notification' :{'hex':'00000102', 'name':'alert_notification'},
'data_sm' :{'hex':'00000103', 'name':'data_sm'},
'data_sm_resp' :{'hex':'80000103', 'name':'data_sm_resp'},
# v4 codes
'generic_nack_v4' :{'hex':'80010000', 'name':'generic_nack_v4'},
'bind_receiver_v4' :{'hex':'00010001', 'name':'bind_receiver_v4'},
'bind_receiver_resp_v4' :{'hex':'80010001', 'name':'bind_receiver_resp_v4'},
'bind_transmitter_v4' :{'hex':'00010002', 'name':'bind_transmitter_v4'},
'bind_transmitter_resp_v4':{'hex':'80010002', 'name':'bind_transmitter_resp_v4'},
'query_sm_v4' :{'hex':'00010003', 'name':'query_sm_v4'},
'query_sm_resp_v4' :{'hex':'80010003', 'name':'query_sm_resp_v4'},
'submit_sm_v4' :{'hex':'00010004', 'name':'submit_sm_v4'},
'submit_sm_resp_v4' :{'hex':'80010004', 'name':'submit_sm_resp_v4'},
'deliver_sm_v4' :{'hex':'00010005', 'name':'deliver_sm_v4'},
'deliver_sm_resp_v4' :{'hex':'80010005', 'name':'deliver_sm_resp_v4'},
'unbind_v4' :{'hex':'00010006', 'name':'unbind_v4'},
'unbind_resp_v4' :{'hex':'80010006', 'name':'unbind_resp_v4'},
'replace_sm_v4' :{'hex':'00010007', 'name':'replace_sm_v4'},
'replace_sm_resp_v4' :{'hex':'80010007', 'name':'replace_sm_resp_v4'},
'cancel_sm_v4' :{'hex':'00010008', 'name':'cancel_sm_v4'},
'cancel_sm_resp_v4' :{'hex':'80010008', 'name':'cancel_sm_resp_v4'},
'delivery_receipt_v4' :{'hex':'00010009', 'name':'delivery_receipt_v4'},
'delivery_receipt_resp_v4':{'hex':'80010009', 'name':'delivery_receipt_resp_v4'},
'enquire_link_v4' :{'hex':'0001000a', 'name':'enquire_link_v4'},
'enquire_link_resp_v4' :{'hex':'8001000a', 'name':'enquire_link_resp_v4'},
'outbind_v4' :{'hex':'0001000b', 'name':'outbind_v4'}
}
def command_id_hex_by_name(n):
return command_id_by_name.get(n,{}).get('hex')
# SMPP Error Codes (ESME) - SMPP v3.4, section 5.1.3, table 5-2, page 112-114
command_status_by_hex = {
'00000000':{'hex':'00000000', 'name':'ESME_ROK', 'description':'No error'},
'00000001':{'hex':'00000001', 'name':'ESME_RINVMSGLEN', 'description':'Message Length is invalid'},
'00000002':{'hex':'00000002', 'name':'ESME_RINVCMDLEN', 'description':'Command Length is invalid'},
'00000003':{'hex':'00000003', 'name':'ESME_RINVCMDID', 'description':'Invalid Command ID'},
'00000004':{'hex':'00000004', 'name':'ESME_RINVBNDSTS', 'description':'Incorrect BIND Status for given command'},
'00000005':{'hex':'00000005', 'name':'ESME_RALYBND', 'description':'ESME Already in bound state'},
'00000006':{'hex':'00000006', 'name':'ESME_RINVPRTFLG', 'description':'Invalid priority flag'},
'00000007':{'hex':'00000007', 'name':'ESME_RINVREGDLVFLG', 'description':'Invalid registered delivery flag'},
'00000008':{'hex':'00000008', 'name':'ESME_RSYSERR', 'description':'System Error'},
'0000000a':{'hex':'0000000a', 'name':'ESME_RINVSRCADR', 'description':'Invalid source address'},
'0000000b':{'hex':'0000000b', 'name':'ESME_RINVDSTADR', 'description':'Invalid destination address'},
'0000000c':{'hex':'0000000c', 'name':'ESME_RINVMSGID', 'description':'Message ID is invalid'},
'0000000d':{'hex':'0000000d', 'name':'ESME_RBINDFAIL', 'description':'Bind failed'},
'0000000e':{'hex':'0000000e', 'name':'ESME_RINVPASWD', 'description':'Invalid password'},
'0000000f':{'hex':'0000000f', 'name':'ESME_RINVSYSID', 'description':'Invalid System ID'},
'00000011':{'hex':'00000011', 'name':'ESME_RCANCELFAIL', 'description':'Cancel SM Failed'},
'00000013':{'hex':'00000013', 'name':'ESME_RREPLACEFAIL', 'description':'Replace SM Failed'},
'00000014':{'hex':'00000014', 'name':'ESME_RMSGQFUL', 'description':'Message queue full'},
'00000015':{'hex':'00000015', 'name':'ESME_RINVSERTYP', 'description':'Invalid service type'},
'00000033':{'hex':'00000033', 'name':'ESME_RINVNUMDESTS', 'description':'Invalid number of destinations'},
'00000034':{'hex':'00000034', 'name':'ESME_RINVDLNAME', 'description':'Invalid distribution list name'},
'00000040':{'hex':'00000040', 'name':'ESME_RINVDESTFLAG', 'description':'Destination flag is invalid (submit_multi)'},
'00000042':{'hex':'00000042', 'name':'ESME_RINVSUBREP', 'description':"Invalid `submit with replace' request (i.e. submit_sm with replace_if_present_flag set)"},
'00000043':{'hex':'00000043', 'name':'ESME_RINVESMCLASS', 'description':'Invalid esm_class field data'},
'00000044':{'hex':'00000044', 'name':'ESME_RCNTSUBDL', 'description':'Cannot submit to distribution list'},
'00000045':{'hex':'00000045', 'name':'ESME_RSUBMITFAIL', 'description':'submit_sm or submit_multi failed'},
'00000048':{'hex':'00000048', 'name':'ESME_RINVSRCTON', 'description':'Invalid source address TON'},
'00000049':{'hex':'00000049', 'name':'ESME_RINVSRCNPI', 'description':'Invalid source address NPI'},
'00000050':{'hex':'00000050', 'name':'ESME_RINVDSTTON', 'description':'Invalid destination address TON'},
'00000051':{'hex':'00000051', 'name':'ESME_RINVDSTNPI', 'description':'Invalid destination address NPI'},
'00000053':{'hex':'00000053', 'name':'ESME_RINVSYSTYP', 'description':'Invalid system_type field'},
'00000054':{'hex':'00000054', 'name':'ESME_RINVREPFLAG', 'description':'Invalid replace_if_present flag'},
'00000055':{'hex':'00000055', 'name':'ESME_RINVNUMMSGS', 'description':'Invalid number of messages'},
'00000058':{'hex':'00000058', 'name':'ESME_RTHROTTLED', 'description':'Throttling error (ESME has exceeded allowed message limits)'},
'00000061':{'hex':'00000061', 'name':'ESME_RINVSCHED', 'description':'Invalid scheduled delivery time'},
'00000062':{'hex':'00000062', 'name':'ESME_RINVEXPIRY', 'description':'Invalid message validity period (expiry time)'},
'00000063':{'hex':'00000063', 'name':'ESME_RINVDFTMSGID', 'description':'Predefined message invalid or not found'},
'00000064':{'hex':'00000064', 'name':'ESME_RX_T_APPN', 'description':'ESME Receiver Temporary App Error Code'},
'00000065':{'hex':'00000065', 'name':'ESME_RX_P_APPN', 'description':'ESME Receiver Permanent App Error Code'},
'00000066':{'hex':'00000066', 'name':'ESME_RX_R_APPN', 'description':'ESME Receiver Reject Message Error Code'},
'00000067':{'hex':'00000067', 'name':'ESME_RQUERYFAIL', 'description':'query_sm request failed'},
'000000c0':{'hex':'000000c0', 'name':'ESME_RINVOPTPARSTREAM', 'description':'Error in the optional part of the PDU Body'},
'000000c1':{'hex':'000000c1', 'name':'ESME_ROPTPARNOTALLWD', 'description':'Optional paramenter not allowed'},
'000000c2':{'hex':'000000c2', 'name':'ESME_RINVPARLEN', 'description':'Invalid parameter length'},
'000000c3':{'hex':'000000c3', 'name':'ESME_RMISSINGOPTPARAM', 'description':'Expected optional parameter missing'},
'000000c4':{'hex':'000000c4', 'name':'ESME_RINVOPTPARAMVAL', 'description':'Invalid optional parameter value'},
'000000fe':{'hex':'000000fe', 'name':'ESME_RDELIVERYFAILURE', 'description':'Delivery Failure (used for data_sm_resp)'},
'000000ff':{'hex':'000000ff', 'name':'ESME_RUNKNOWNERR', 'description':'Unknown error'}
}
def command_status_name_by_hex(x):
return command_status_by_hex.get(x,{}).get('name')
command_status_by_name = {
'ESME_ROK' :{'hex':'00000000', 'name':'ESME_ROK', 'description':'No error'},
'ESME_RINVMSGLEN' :{'hex':'00000001', 'name':'ESME_RINVMSGLEN', 'description':'Message Length is invalid'},
'ESME_RINVCMDLEN' :{'hex':'00000002', 'name':'ESME_RINVCMDLEN', 'description':'Command Length is invalid'},
'ESME_RINVCMDID' :{'hex':'00000003', 'name':'ESME_RINVCMDID', 'description':'Invalid Command ID'},
'ESME_RINVBNDSTS' :{'hex':'00000004', 'name':'ESME_RINVBNDSTS', 'description':'Incorrect BIND Status for given command'},
'ESME_RALYBND' :{'hex':'00000005', 'name':'ESME_RALYBND', 'description':'ESME Already in bound state'},
'ESME_RINVPRTFLG' :{'hex':'00000006', 'name':'ESME_RINVPRTFLG', 'description':'Invalid priority flag'},
'ESME_RINVREGDLVFLG' :{'hex':'00000007', 'name':'ESME_RINVREGDLVFLG', 'description':'Invalid registered delivery flag'},
'ESME_RSYSERR' :{'hex':'00000008', 'name':'ESME_RSYSERR', 'description':'System Error'},
'ESME_RINVSRCADR' :{'hex':'0000000a', 'name':'ESME_RINVSRCADR', 'description':'Invalid source address'},
'ESME_RINVDSTADR' :{'hex':'0000000b', 'name':'ESME_RINVDSTADR', 'description':'Invalid destination address'},
'ESME_RINVMSGID' :{'hex':'0000000c', 'name':'ESME_RINVMSGID', 'description':'Message ID is invalid'},
'ESME_RBINDFAIL' :{'hex':'0000000d', 'name':'ESME_RBINDFAIL', 'description':'Bind failed'},
'ESME_RINVPASWD' :{'hex':'0000000e', 'name':'ESME_RINVPASWD', 'description':'Invalid password'},
'ESME_RINVSYSID' :{'hex':'0000000f', 'name':'ESME_RINVSYSID', 'description':'Invalid System ID'},
'ESME_RCANCELFAIL' :{'hex':'00000011', 'name':'ESME_RCANCELFAIL', 'description':'Cancel SM Failed'},
'ESME_RREPLACEFAIL' :{'hex':'00000013', 'name':'ESME_RREPLACEFAIL', 'description':'Replace SM Failed'},
'ESME_RMSGQFUL' :{'hex':'00000014', 'name':'ESME_RMSGQFUL', 'description':'Message queue full'},
'ESME_RINVSERTYP' :{'hex':'00000015', 'name':'ESME_RINVSERTYP', 'description':'Invalid service type'},
'ESME_RINVNUMDESTS' :{'hex':'00000033', 'name':'ESME_RINVNUMDESTS', 'description':'Invalid number of destinations'},
'ESME_RINVDLNAME' :{'hex':'00000034', 'name':'ESME_RINVDLNAME', 'description':'Invalid distribution list name'},
'ESME_RINVDESTFLAG' :{'hex':'00000040', 'name':'ESME_RINVDESTFLAG', 'description':'Destination flag is invalid (submit_multi)'},
'ESME_RINVSUBREP' :{'hex':'00000042', 'name':'ESME_RINVSUBREP', 'description':"Invalid `submit with replace' request (i.e. submit_sm with replace_if_present_flag set)"},
'ESME_RINVESMCLASS' :{'hex':'00000043', 'name':'ESME_RINVESMCLASS', 'description':'Invalid esm_class field data'},
'ESME_RCNTSUBDL' :{'hex':'00000044', 'name':'ESME_RCNTSUBDL', 'description':'Cannot submit to distribution list'},
'ESME_RSUBMITFAIL' :{'hex':'00000045', 'name':'ESME_RSUBMITFAIL', 'description':'submit_sm or submit_multi failed'},
'ESME_RINVSRCTON' :{'hex':'00000048', 'name':'ESME_RINVSRCTON', 'description':'Invalid source address TON'},
'ESME_RINVSRCNPI' :{'hex':'00000049', 'name':'ESME_RINVSRCNPI', 'description':'Invalid source address NPI'},
'ESME_RINVDSTTON' :{'hex':'00000050', 'name':'ESME_RINVDSTTON', 'description':'Invalid destination address TON'},
'ESME_RINVDSTNPI' :{'hex':'00000051', 'name':'ESME_RINVDSTNPI', 'description':'Invalid destination address NPI'},
'ESME_RINVSYSTYP' :{'hex':'00000053', 'name':'ESME_RINVSYSTYP', 'description':'Invalid system_type field'},
'ESME_RINVREPFLAG' :{'hex':'00000054', 'name':'ESME_RINVREPFLAG', 'description':'Invalid replace_if_present flag'},
'ESME_RINVNUMMSGS' :{'hex':'00000055', 'name':'ESME_RINVNUMMSGS', 'description':'Invalid number of messages'},
'ESME_RTHROTTLED' :{'hex':'00000058', 'name':'ESME_RTHROTTLED', 'description':'Throttling error (ESME has exceeded allowed message limits)'},
'ESME_RINVSCHED' :{'hex':'00000061', 'name':'ESME_RINVSCHED', 'description':'Invalid scheduled delivery time'},
'ESME_RINVEXPIRY' :{'hex':'00000062', 'name':'ESME_RINVEXPIRY', 'description':'Invalid message validity period (expiry time)'},
'ESME_RINVDFTMSGID' :{'hex':'00000063', 'name':'ESME_RINVDFTMSGID', 'description':'Predefined message invalid or not found'},
'ESME_RX_T_APPN' :{'hex':'00000064', 'name':'ESME_RX_T_APPN', 'description':'ESME Receiver Temporary App Error Code'},
'ESME_RX_P_APPN' :{'hex':'00000065', 'name':'ESME_RX_P_APPN', 'description':'ESME Receiver Permanent App Error Code'},
'ESME_RX_R_APPN' :{'hex':'00000066', 'name':'ESME_RX_R_APPN', 'description':'ESME Receiver Reject Message Error Code'},
'ESME_RQUERYFAIL' :{'hex':'00000067', 'name':'ESME_RQUERYFAIL', 'description':'query_sm request failed'},
'ESME_RINVOPTPARSTREAM':{'hex':'000000c0', 'name':'ESME_RINVOPTPARSTREAM', 'description':'Error in the optional part of the PDU Body'},
'ESME_ROPTPARNOTALLWD' :{'hex':'000000c1', 'name':'ESME_ROPTPARNOTALLWD', 'description':'Optional paramenter not allowed'},
'ESME_RINVPARLEN' :{'hex':'000000c2', 'name':'ESME_RINVPARLEN', 'description':'Invalid parameter length'},
'ESME_RMISSINGOPTPARAM':{'hex':'000000c3', 'name':'ESME_RMISSINGOPTPARAM', 'description':'Expected optional parameter missing'},
'ESME_RINVOPTPARAMVAL' :{'hex':'000000c4', 'name':'ESME_RINVOPTPARAMVAL', 'description':'Invalid optional parameter value'},
'ESME_RDELIVERYFAILURE':{'hex':'000000fe', 'name':'ESME_RDELIVERYFAILURE', 'description':'Delivery Failure (used for data_sm_resp)'},
'ESME_RUNKNOWNERR' :{'hex':'000000ff', 'name':'ESME_RUNKNOWNERR', 'description':'Unknown error'}
}
def command_status_hex_by_name(n):
return command_status_by_name.get(n,{}).get('hex')
# Type of Number (TON) - SMPP v3.4, section 5.2.5, table 5-3, page 117
maps['addr_ton_by_name'] = {
'unknown' :'00',
'international' :'01',
'national' :'02',
'network_specific' :'03',
'subscriber_number':'04',
'alphanumeric' :'05',
'abbreviated' :'06'
}
maps['addr_ton_by_hex'] = {
'00':'unknown',
'01':'international',
'02':'national',
'03':'network_specific',
'04':'subscriber_number',
'05':'alphanumeric',
'06':'abbreviated'
}
# Numberic Plan Indicator (NPI) - SMPP v3.4, section 5.2.6, table 5-4, page 118
maps['addr_npi_by_name'] = {
'unknown' :'00',
'ISDN' :'01',
'data' :'03',
'telex' :'04',
'land_mobile':'06',
'national' :'08',
'private' :'09',
'ERMES' :'0a',
'internet' :'0e',
'WAP' :'12'
}
maps['addr_npi_by_hex'] = {
'00':'unknown',
'01':'ISDN',
'03':'data',
'04':'telex',
'06':'land_mobile',
'08':'national',
'09':'private',
'0a':'ERMES',
'0e':'internet',
'12':'WAP'
}
# ESM Class bits - SMPP v3.4, section 5.2.12, page 121
maps['esm_class_bits'] = {
'mode_mask' :'03',
'type_mask' :'3c',
'feature_mask' :'c0',
'mode_default' :'00',
'mode_datagram' :'01',
'mode_forward' :'02',
'mode_store_and_forward' :'03',
'type_default' :'00',
'type_delivery_receipt' :'04',
'type_delivery_ack' :'08',
'type_0011' :'0a',
'type_user_ack' :'10',
'type_0101' :'14',
'type_conversation_abort' :'18',
'type_0111' :'1a',
'type_intermed_deliv_notif' :'20',
'type_1001' :'24',
'type_1010' :'28',
'type_1011' :'2a',
'type_1100' :'30',
'type_1101' :'34',
'type_1110' :'38',
'type_1111' :'3a',
'feature_none' :'00',
'feature_UDHI' :'40',
'feature_reply_path' :'80',
'feature_UDHI_and_reply_path':'c0'
}
# Registered Delivery bits - SMPP v3.4, section 5.2.17, page 124
maps['registered_delivery_bits'] = {
'receipt_mask' :'03',
'ack_mask' :'0c',
'intermed_notif_mask' :'80',
'receipt_none' :'00',
'receipt_always' :'01',
'receipt_on_fail' :'02',
'receipt_res' :'03',
'ack_none' :'00',
'ack_delivery' :'04',
'ack_user' :'08',
'ack_delivery_and_user':'0c',
'intermed_notif_none' :'00',
'intermed_notif' :'10'
}
# submit_multi dest_flag constants - SMPP v3.4, section 5.2.25, page 129
#maps['dest_flag_by_name'] = {
#'SME Address' :1,
#'Distribution List Name':2
#}
# Message State codes returned in query_sm_resp PDUs - SMPP v3.4, section 5.2.28, table 5-6, page 130
maps['message_state_by_name'] = {
'ENROUTE' :1,
'DELIVERED' :2,
'EXPIRED' :3,
'DELETED' :4,
'UNDELIVERABLE':5,
'ACCEPTED' :6,
'UNKNOWN' :7,
'REJECTED' :8
}
# Facility Code bits for SMPP v4
maps['facility_code_bits'] = {
'GF_PVCY' :'00000001',
'GF_SUBADDR':'00000002',
'NF_CC' :'00080000',
'NF_PDC' :'00010000',
'NF_IS136' :'00020000',
'NF_IS95A' :'00040000'
}
# Optional Parameter Tags - SMPP v3.4, section 5.3.2, Table 5-7, page 132-133
optional_parameter_tag_by_hex = {
'0005':{'hex':'0005', 'name':'dest_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.1, page 134
'0006':{'hex':'0006', 'name':'dest_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.3, page 135
'0007':{'hex':'0007', 'name':'dest_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.5, page 136
'0008':{'hex':'0008', 'name':'dest_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.7, page 137
'000d':{'hex':'000d', 'name':'source_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.2, page 134
'000e':{'hex':'000e', 'name':'source_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.4, page 135
'000f':{'hex':'000f', 'name':'source_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.6, page 136
'0010':{'hex':'0010', 'name':'source_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.8, page 137
'0017':{'hex':'0017', 'name':'qos_time_to_live', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.9, page 138
'0019':{'hex':'0019', 'name':'payload_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.10, page 138
'001d':{'hex':'001d', 'name':'additional_status_info_text', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.11, page 139
'001e':{'hex':'001e', 'name':'receipted_message_id', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.12, page 139
'0030':{'hex':'0030', 'name':'ms_msg_wait_facilities', 'type':'bitmask', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.13, page 140
'0101':{'hex':'0101', 'name':'PVCY_AuthenticationStr', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 58-62
'0201':{'hex':'0201', 'name':'privacy_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.14, page 141
'0202':{'hex':'0202', 'name':'source_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.15, page 142
'0203':{'hex':'0203', 'name':'dest_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.16, page 143
'0204':{'hex':'0204', 'name':'user_message_reference', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.17, page 143
'0205':{'hex':'0205', 'name':'user_response_code', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.18, page 144
'020a':{'hex':'020a', 'name':'source_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.20, page 145
'020b':{'hex':'020b', 'name':'destination_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.21, page 145
'020c':{'hex':'020c', 'name':'sar_msg_ref_num', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.22, page 146
'020d':{'hex':'020d', 'name':'language_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.19, page 144
'020e':{'hex':'020e', 'name':'sar_total_segments', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.23, page 147
'020f':{'hex':'020f', 'name':'sar_segment_seqnum', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.24, page 147
'0210':{'hex':'0210', 'name':'sc_interface_version', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.25, page 148
'0301':{'hex':'0301', 'name':'CC_CBN', 'type':None, 'tech':'V4'}, # v4 page 70
'0302':{'hex':'0302', 'name':'callback_num_pres_ind', 'type':'bitmask', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.37, page 156
'0303':{'hex':'0303', 'name':'callback_num_atag', 'type':'hex', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.38, page 157
'0304':{'hex':'0304', 'name':'number_of_messages', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.39, page 158
'0381':{'hex':'0381', 'name':'callback_num', 'type':'hex', 'tech':'CDMA, TDMA, GSM, iDEN'}, # SMPP v3.4, section 5.3.2.36, page 155
'0420':{'hex':'0420', 'name':'dpf_result', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.28, page 149
'0421':{'hex':'0421', 'name':'set_dpf', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.29, page 150
'0422':{'hex':'0422', 'name':'ms_availability_status', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.30, page 151
'0423':{'hex':'0423', 'name':'network_error_code', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.31, page 152
'0424':{'hex':'0424', 'name':'message_payload', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.32, page 153
'0425':{'hex':'0425', 'name':'delivery_failure_reason', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.33, page 153
'0426':{'hex':'0426', 'name':'more_messages_to_send', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.34, page 154
'0427':{'hex':'0427', 'name':'message_state', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.35, page 154
'0428':{'hex':'0428', 'name':'congestion_state', 'type':None, 'tech':'Generic'},
'0501':{'hex':'0501', 'name':'ussd_service_op', 'type':'hex', 'tech':'GSM (USSD)'}, # SMPP v3.4, section 5.3.2.44, page 161
'0600':{'hex':'0600', 'name':'broadcast_channel_indicator', 'type':None, 'tech':'GSM'},
'0601':{'hex':'0601', 'name':'broadcast_content_type', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'0602':{'hex':'0602', 'name':'broadcast_content_type_info', 'type':None, 'tech':'CDMA, TDMA'},
'0603':{'hex':'0603', 'name':'broadcast_message_class', 'type':None, 'tech':'GSM'},
'0604':{'hex':'0604', 'name':'broadcast_rep_num', 'type':None, 'tech':'GSM'},
'0605':{'hex':'0605', 'name':'broadcast_frequency_interval', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'0606':{'hex':'0606', 'name':'broadcast_area_identifier', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'0607':{'hex':'0607', 'name':'broadcast_error_status', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'0608':{'hex':'0608', 'name':'broadcast_area_success', 'type':None, 'tech':'GSM'},
'0609':{'hex':'0609', 'name':'broadcast_end_time', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'060a':{'hex':'060a', 'name':'broadcast_service_group', 'type':None, 'tech':'CDMA, TDMA'},
'060b':{'hex':'060b', 'name':'billing_identification', 'type':None, 'tech':'Generic'},
'060d':{'hex':'060d', 'name':'source_network_id', 'type':None, 'tech':'Generic'},
'060e':{'hex':'060e', 'name':'dest_network_id', 'type':None, 'tech':'Generic'},
'060f':{'hex':'060f', 'name':'source_node_id', 'type':None, 'tech':'Generic'},
'0610':{'hex':'0610', 'name':'dest_node_id', 'type':None, 'tech':'Generic'},
'0611':{'hex':'0611', 'name':'dest_addr_np_resolution', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'0612':{'hex':'0612', 'name':'dest_addr_np_information', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'0613':{'hex':'0613', 'name':'dest_addr_np_country', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'1101':{'hex':'1101', 'name':'PDC_MessageClass', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 75
'1102':{'hex':'1102', 'name':'PDC_PresentationOption', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
'1103':{'hex':'1103', 'name':'PDC_AlertMechanism', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
'1104':{'hex':'1104', 'name':'PDC_Teleservice', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
'1105':{'hex':'1105', 'name':'PDC_MultiPartMessage', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
'1106':{'hex':'1106', 'name':'PDC_PredefinedMsg', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 78
'1201':{'hex':'1201', 'name':'display_time', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.26, page 148
'1203':{'hex':'1203', 'name':'sms_signal', 'type':'integer', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.40, page 158
'1204':{'hex':'1204', 'name':'ms_validity', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.27, page 149
'1304':{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'type':None, 'tech':'CDMA'}, # v4 page 85
'1306':{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'type':None, 'tech':'CDMA'}, # v4 page 86
'130c':{'hex':'130c', 'name':'alert_on_message_delivery', 'type':None, 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.41, page 159
'1380':{'hex':'1380', 'name':'its_reply_type', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.42, page 159
'1383':{'hex':'1383', 'name':'its_session_info', 'type':'hex', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.43, page 160
'1402':{'hex':'1402', 'name':'operator_id', 'type':None, 'tech':'vendor extension'},
'1403':{'hex':'1403', 'name':'tariff', 'type':None, 'tech':'Mobile Network Code vendor extension'},
'1450':{'hex':'1450', 'name':'mcc', 'type':None, 'tech':'Mobile Country Code vendor extension'},
'1451':{'hex':'1451', 'name':'mnc', 'type':None, 'tech':'Mobile Network Code vendor extension'}
}
def optional_parameter_tag_name_by_hex(x):
return optional_parameter_tag_by_hex.get(x,{}).get('name')
def optional_parameter_tag_type_by_hex(x):
return optional_parameter_tag_by_hex.get(x,{}).get('type')
optional_parameter_tag_by_name = {
'dest_addr_subunit' :{'hex':'0005', 'name':'dest_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.1, page 134
'dest_network_type' :{'hex':'0006', 'name':'dest_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.3, page 135
'dest_bearer_type' :{'hex':'0007', 'name':'dest_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.5, page 136
'dest_telematics_id' :{'hex':'0008', 'name':'dest_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.7, page 137
'source_addr_subunit' :{'hex':'000d', 'name':'source_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.2, page 134
'source_network_type' :{'hex':'000e', 'name':'source_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.4, page 135
'source_bearer_type' :{'hex':'000f', 'name':'source_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.6, page 136
'source_telematics_id' :{'hex':'0010', 'name':'source_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.8, page 137
'qos_time_to_live' :{'hex':'0017', 'name':'qos_time_to_live', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.9, page 138
'payload_type' :{'hex':'0019', 'name':'payload_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.10, page 138
'additional_status_info_text' :{'hex':'001d', 'name':'additional_status_info_text', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.11, page 139
'receipted_message_id' :{'hex':'001e', 'name':'receipted_message_id', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.12, page 139
'ms_msg_wait_facilities' :{'hex':'0030', 'name':'ms_msg_wait_facilities', 'type':'bitmask', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.13, page 140
'PVCY_AuthenticationStr' :{'hex':'0101', 'name':'PVCY_AuthenticationStr', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 58-62
'privacy_indicator' :{'hex':'0201', 'name':'privacy_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.14, page 141
'source_subaddress' :{'hex':'0202', 'name':'source_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.15, page 142
'dest_subaddress' :{'hex':'0203', 'name':'dest_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.16, page 143
'user_message_reference' :{'hex':'0204', 'name':'user_message_reference', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.17, page 143
'user_response_code' :{'hex':'0205', 'name':'user_response_code', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.18, page 144
'source_port' :{'hex':'020a', 'name':'source_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.20, page 145
'destination_port' :{'hex':'020b', 'name':'destination_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.21, page 145
'sar_msg_ref_num' :{'hex':'020c', 'name':'sar_msg_ref_num', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.22, page 146
'language_indicator' :{'hex':'020d', 'name':'language_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.19, page 144
'sar_total_segments' :{'hex':'020e', 'name':'sar_total_segments', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.23, page 147
'sar_segment_seqnum' :{'hex':'020f', 'name':'sar_segment_seqnum', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.24, page 147
'sc_interface_version' :{'hex':'0210', 'name':'sc_interface_version', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.25, page 148
'CC_CBN' :{'hex':'0301', 'name':'CC_CBN', 'type':None, 'tech':'V4'}, # v4 page 70
'callback_num_pres_ind' :{'hex':'0302', 'name':'callback_num_pres_ind', 'type':'bitmask', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.37, page 156
'callback_num_atag' :{'hex':'0303', 'name':'callback_num_atag', 'type':'hex', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.38, page 157
'number_of_messages' :{'hex':'0304', 'name':'number_of_messages', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.39, page 158
'callback_num' :{'hex':'0381', 'name':'callback_num', 'type':'hex', 'tech':'CDMA, TDMA, GSM, iDEN'}, # SMPP v3.4, section 5.3.2.36, page 155
'dpf_result' :{'hex':'0420', 'name':'dpf_result', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.28, page 149
'set_dpf' :{'hex':'0421', 'name':'set_dpf', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.29, page 150
'ms_availability_status' :{'hex':'0422', 'name':'ms_availability_status', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.30, page 151
'network_error_code' :{'hex':'0423', 'name':'network_error_code', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.31, page 152
'message_payload' :{'hex':'0424', 'name':'message_payload', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.32, page 153
'delivery_failure_reason' :{'hex':'0425', 'name':'delivery_failure_reason', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.33, page 153
'more_messages_to_send' :{'hex':'0426', 'name':'more_messages_to_send', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.34, page 154
'message_state' :{'hex':'0427', 'name':'message_state', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.35, page 154
'congestion_state' :{'hex':'0428', 'name':'congestion_state', 'type':None, 'tech':'Generic'},
'ussd_service_op' :{'hex':'0501', 'name':'ussd_service_op', 'type':'hex', 'tech':'GSM (USSD)'}, # SMPP v3.4, section 5.3.2.44, page 161
'broadcast_channel_indicator' :{'hex':'0600', 'name':'broadcast_channel_indicator', 'type':None, 'tech':'GSM'},
'broadcast_content_type' :{'hex':'0601', 'name':'broadcast_content_type', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_content_type_info' :{'hex':'0602', 'name':'broadcast_content_type_info', 'type':None, 'tech':'CDMA, TDMA'},
'broadcast_message_class' :{'hex':'0603', 'name':'broadcast_message_class', 'type':None, 'tech':'GSM'},
'broadcast_rep_num' :{'hex':'0604', 'name':'broadcast_rep_num', 'type':None, 'tech':'GSM'},
'broadcast_frequency_interval':{'hex':'0605', 'name':'broadcast_frequency_interval', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_area_identifier' :{'hex':'0606', 'name':'broadcast_area_identifier', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_error_status' :{'hex':'0607', 'name':'broadcast_error_status', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_area_success' :{'hex':'0608', 'name':'broadcast_area_success', 'type':None, 'tech':'GSM'},
'broadcast_end_time' :{'hex':'0609', 'name':'broadcast_end_time', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_service_group' :{'hex':'060a', 'name':'broadcast_service_group', 'type':None, 'tech':'CDMA, TDMA'},
'billing_identification' :{'hex':'060b', 'name':'billing_identification', 'type':None, 'tech':'Generic'},
'source_network_id' :{'hex':'060d', 'name':'source_network_id', 'type':None, 'tech':'Generic'},
'dest_network_id' :{'hex':'060e', 'name':'dest_network_id', 'type':None, 'tech':'Generic'},
'source_node_id' :{'hex':'060f', 'name':'source_node_id', 'type':None, 'tech':'Generic'},
'dest_node_id' :{'hex':'0610', 'name':'dest_node_id', 'type':None, 'tech':'Generic'},
'dest_addr_np_resolution' :{'hex':'0611', 'name':'dest_addr_np_resolution', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'dest_addr_np_information' :{'hex':'0612', 'name':'dest_addr_np_information', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'dest_addr_np_country' :{'hex':'0613', 'name':'dest_addr_np_country', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'PDC_MessageClass' :{'hex':'1101', 'name':'PDC_MessageClass', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 75
'PDC_PresentationOption' :{'hex':'1102', 'name':'PDC_PresentationOption', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
'PDC_AlertMechanism' :{'hex':'1103', 'name':'PDC_AlertMechanism', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
'PDC_Teleservice' :{'hex':'1104', 'name':'PDC_Teleservice', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
'PDC_MultiPartMessage' :{'hex':'1105', 'name':'PDC_MultiPartMessage', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
'PDC_PredefinedMsg' :{'hex':'1106', 'name':'PDC_PredefinedMsg', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 78
'display_time' :{'hex':'1201', 'name':'display_time', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.26, page 148
'sms_signal' :{'hex':'1203', 'name':'sms_signal', 'type':'integer', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.40, page 158
'ms_validity' :{'hex':'1204', 'name':'ms_validity', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.27, page 149
'IS95A_AlertOnDelivery' :{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'type':None, 'tech':'CDMA'}, # v4 page 85
'IS95A_LanguageIndicator' :{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'type':None, 'tech':'CDMA'}, # v4 page 86
'alert_on_message_delivery' :{'hex':'130c', 'name':'alert_on_message_delivery', 'type':None, 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.41, page 159
'its_reply_type' :{'hex':'1380', 'name':'its_reply_type', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.42, page 159
'its_session_info' :{'hex':'1383', 'name':'its_session_info', 'type':'hex', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.43, page 160
'operator_id' :{'hex':'1402', 'name':'operator_id', 'type':None, 'tech':'vendor extension'},
'tariff' :{'hex':'1403', 'name':'tariff', 'type':None, 'tech':'Mobile Network Code vendor extension'},
'mcc' :{'hex':'1450', 'name':'mcc', 'type':None, 'tech':'Mobile Country Code vendor extension'},
'mnc' :{'hex':'1451', 'name':'mnc', 'type':None, 'tech':'Mobile Network Code vendor extension'}
}
def optional_parameter_tag_hex_by_name(n):
return optional_parameter_tag_by_name.get(n,{}).get('hex')
#### Decoding functions #######################################################
def unpack_pdu(pdu_bin):
return decode_pdu(binascii.b2a_hex(pdu_bin))
def decode_pdu(pdu_hex):
hex_ref = [pdu_hex]
pdu = {}
pdu['header'] = decode_header(hex_ref)
command = pdu['header'].get('command_id', None)
if command != None:
body = decode_body(command, hex_ref)
if len(body) > 0:
pdu['body'] = body
return pdu
def decode_header(hex_ref):
pdu_hex = hex_ref[0]
header = {}
(command_length, command_id, command_status, sequence_number, hex_ref[0]) = \
(pdu_hex[0:8], pdu_hex[8:16], pdu_hex[16:24], pdu_hex[24:32], pdu_hex[32: ])
length = int(command_length, 16)
command = command_id_name_by_hex(command_id)
status = command_status_name_by_hex(command_status)
sequence = int(sequence_number, 16)
header = {}
header['command_length'] = length
header['command_id'] = command
header['command_status'] = status
header['sequence_number'] = sequence
return header
def decode_body(command, hex_ref):
body = {}
if command != None:
fields = mandatory_parameter_list_by_command_name(command)
mandatory = decode_mandatory_parameters(fields, hex_ref)
if len(mandatory) > 0:
body['mandatory_parameters'] = mandatory
optional = decode_optional_parameters(hex_ref)
if len(optional) > 0:
body['optional_parameters'] = optional
return body
def decode_mandatory_parameters(fields, hex_ref):
mandatory_parameters = {}
if len(hex_ref[0]) > 1:
for field in fields:
#old = len(hex_ref[0])
data = ''
octet = ''
count = 0
if field['var'] == True or field['var'] == False:
while (len(hex_ref[0]) > 1
and (count < field['min']
or (count < field['max']
and octet != '00'))):
octet = octpop(hex_ref)
data += octet
count += 1
- elif field['type'] == 'string':
+ elif field['type'] in ['string', 'xstring']:
count = mandatory_parameters[field['var']]
if count == 0:
data = None
else:
for i in range(count):
if len(hex_ref[0]) > 1:
data += octpop(hex_ref)
else:
count = mandatory_parameters[field['var']]
if field['map'] != None:
mandatory_parameters[field['name']] = maps[field['map']+'_by_hex'].get(data, None)
if field['map'] == None or mandatory_parameters[field['name']] == None:
mandatory_parameters[field['name']] = decode_hex_type(data, field['type'], count, hex_ref)
#print field['type'], (old - len(hex_ref[0]))/2, repr(data), field['name'], mandatory_parameters[field['name']]
return mandatory_parameters
def decode_optional_parameters(hex_ref):
optional_parameters = []
hex = hex_ref[0]
while len(hex) > 0:
(tag_hex, length_hex, rest) = (hex[0:4], hex[4:8], hex[8: ])
tag = optional_parameter_tag_name_by_hex(tag_hex)
if tag == None:
tag = tag_hex
length = int(length_hex, 16)
(value_hex, tail) = (rest[0:length*2], rest[length*2: ])
if len(value_hex) == 0:
value = None
else:
value = decode_hex_type(value_hex, optional_parameter_tag_type_by_hex(tag_hex))
hex = tail
optional_parameters.append({'tag':tag, 'length':length, 'value':value})
return optional_parameters
def decode_hex_type(hex, type, count=0, hex_ref=['']):
if hex == None:
return hex
elif type == 'integer':
return int(hex, 16)
elif type == 'string':
return re.sub('00','',hex).decode('hex')
+ elif type == 'xstring':
+ return hex.decode('hex')
elif (type == 'dest_address'
or type == 'unsuccess_sme'):
list = []
fields = mandatory_parameter_list_by_command_name(type)
for i in range(count):
item = decode_mandatory_parameters(fields, hex_ref)
if item.get('dest_flag', None) == 1: # 'dest_address' only
subfields = mandatory_parameter_list_by_command_name('sme_dest_address')
rest = decode_mandatory_parameters(subfields, hex_ref)
item.update(rest)
elif item.get('dest_flag', None) == 2: # 'dest_address' only
subfields = mandatory_parameter_list_by_command_name('distribution_list')
rest = decode_mandatory_parameters(subfields, hex_ref)
item.update(rest)
list.append(item)
return list
else:
return hex
def octpop(hex_ref):
octet = None
if len(hex_ref[0]) > 1:
(octet, hex_ref[0]) = (hex_ref[0][0:2], hex_ref[0][2: ])
return octet
#### Encoding functions #######################################################
def pack_pdu(pdu_obj):
return binascii.a2b_hex(encode_pdu(pdu_obj))
def encode_pdu(pdu_obj):
header = pdu_obj.get('header', {})
body = pdu_obj.get('body', {})
mandatory = body.get('mandatory_parameters', {})
optional = body.get('optional_parameters', [])
body_hex = ''
fields = mandatory_parameter_list_by_command_name(header['command_id'])
body_hex += encode_mandatory_parameters(mandatory, fields)
for opt in optional:
body_hex += encode_optional_parameter(opt['tag'], opt['value'])
actual_length = 16 + len(body_hex)/2
command_length = '%08x' % actual_length
command_id = command_id_hex_by_name(header['command_id'])
command_status = command_status_hex_by_name(header['command_status'])
sequence_number = '%08x' % header['sequence_number']
pdu_hex = command_length + command_id + command_status + sequence_number + body_hex
return pdu_hex
def encode_mandatory_parameters(mandatory_obj, fields):
mandatory_hex_array = []
index_names = {}
index = 0
for field in fields:
param = mandatory_obj.get(field['name'], None)
param_length = None
if param != None or field['min'] > 0:
map = None
if field['map'] != None:
map = maps.get(field['map']+'_by_name', None)
if isinstance(param, list):
hex_list = []
for item in param:
flagfields = mandatory_parameter_list_by_command_name(field['type'])
plusfields = []
if item.get('dest_flag', None) == 1:
plusfields = mandatory_parameter_list_by_command_name('sme_dest_address')
elif item.get('dest_flag', None) == 2:
plusfields = mandatory_parameter_list_by_command_name('distribution_list')
hex_item = encode_mandatory_parameters(item, flagfields + plusfields)
if isinstance(hex_item, str) and len(hex_item) > 0:
hex_list.append(hex_item)
param_length = len(hex_list)
mandatory_hex_array.append(''.join(hex_list))
else:
hex_param = encode_param_type(
param, field['type'], field['min'], field['max'], map)
param_length = len(hex_param)/2
mandatory_hex_array.append(hex_param)
index_names[field['name']] = index
length_index = index_names.get(field['var'], None)
if length_index != None and param_length != None:
mandatory_hex_array[length_index] = encode_param_type(
param_length,
'integer',
len(mandatory_hex_array[length_index])/2)
index += 1
return ''.join(mandatory_hex_array)
def encode_optional_parameter(tag, value):
optional_hex_array = []
tag_hex = optional_parameter_tag_hex_by_name(tag)
if tag_hex != None:
value_hex = encode_param_type(
value,
optional_parameter_tag_type_by_hex(tag_hex))
length_hex = '%04x' % (len(value_hex)/2)
optional_hex_array.append(tag_hex + length_hex + value_hex)
return ''.join(optional_hex_array)
def encode_param_type(param, type, min=0, max=None, map=None):
if param == None:
hex = None
elif map != None:
if type == 'integer' and isinstance(param, int):
hex = ('%0'+str(min*2)+'x') % param
else:
hex = map.get(param, ('%0'+str(min*2)+'x') % 0)
elif type == 'integer':
hex = ('%0'+str(min*2)+'x') % int(param)
elif type == 'string':
hex = param.encode('hex') + '00'
+ elif type == 'xstring':
+ hex = param.encode('hex')
elif type == 'bitmask':
hex = param
elif type == 'hex':
hex = param
else:
hex = None
#if hex == None:
#hex = ''
#if min > 0:
#hex = ('%0'+str(min*2)+'x') % 0
#print type, min, max, repr(param), hex, map
return hex
diff --git a/test/pdu_asserts.py b/test/pdu_asserts.py
index faa0705..e92d019 100644
--- a/test/pdu_asserts.py
+++ b/test/pdu_asserts.py
@@ -1,563 +1,563 @@
########################################
pdu_json_0000000001 = '''{
"body": {
"mandatory_parameters": {
"addr_npi": "ISDN",
"addr_ton": "international",
"address_range": "",
"interface_version": "34",
"password": "abc123",
"system_id": "test_system",
"system_type": ""
}
},
"header": {
"command_id": "bind_transmitter",
"command_length": 40,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000002 = '''{
"body": {
"mandatory_parameters": {
"system_id": "test_system"
}
},
"header": {
"command_id": "bind_transmitter_resp",
"command_length": 28,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000003 = '''{
"body": {
"mandatory_parameters": {
"addr_npi": "ISDN",
"addr_ton": "international",
"address_range": "",
"interface_version": "34",
"password": "abc123",
"system_id": "test_system",
"system_type": ""
}
},
"header": {
"command_id": "bind_receiver",
"command_length": 40,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000004 = '''{
"body": {
"mandatory_parameters": {
"system_id": "test_system"
}
},
"header": {
"command_id": "bind_receiver_resp",
"command_length": 28,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000005 = '''{
"body": {
"mandatory_parameters": {
"addr_npi": "ISDN",
"addr_ton": "international",
"address_range": "",
"interface_version": "34",
"password": "abc123",
"system_id": "test_system",
"system_type": ""
}
},
"header": {
"command_id": "bind_transceiver",
"command_length": 40,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000006 = '''{
"body": {
"mandatory_parameters": {
"system_id": "test_system"
}
},
"header": {
"command_id": "bind_transceiver_resp",
"command_length": 28,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000007 = '''{
"body": {
"mandatory_parameters": {
"password": "abc123",
"system_id": "test_system"
}
},
"header": {
"command_id": "outbind",
"command_length": 35,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000008 = '''{
"header": {
"command_id": "unbind",
"command_length": 16,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000009 = '''{
"header": {
"command_id": "unbind_resp",
"command_length": 16,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000010 = '''{
"header": {
"command_id": "generic_nack",
"command_length": 16,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000011 = '''{
"body": {
"mandatory_parameters": {
"data_coding": 0,
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "",
"esm_class": 0,
"priority_flag": 0,
"protocol_id": 0,
"registered_delivery": 0,
"replace_if_present_flag": 0,
"schedule_delivery_time": "",
"service_type": "",
"short_message": "testing 123",
"sm_default_msg_id": 0,
- "sm_length": 12,
+ "sm_length": 11,
"source_addr": "",
"source_addr_npi": "ISDN",
"source_addr_ton": "international",
"validity_period": ""
}
},
"header": {
"command_id": "submit_sm",
- "command_length": 45,
+ "command_length": 44,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000012 = '''{
"body": {
"mandatory_parameters": {
"data_coding": 0,
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "",
"esm_class": 0,
"priority_flag": 0,
"protocol_id": 0,
"registered_delivery": 0,
"replace_if_present_flag": 0,
"schedule_delivery_time": "",
"service_type": "",
"short_message": null,
"sm_default_msg_id": 0,
"sm_length": 0,
"source_addr": "",
"source_addr_npi": "ISDN",
"source_addr_ton": "international",
"validity_period": ""
},
"optional_parameters": [
{
"length": 2,
"tag": "message_payload",
"value": "5666"
}
]
},
"header": {
"command_id": "submit_sm",
"command_length": 39,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000013 = '''{
"body": {
"mandatory_parameters": {
"message_id": ""
}
},
"header": {
"command_id": "submit_sm_resp",
"command_length": 17,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000014 = '''{
"header": {
"command_id": "submit_sm_resp",
"command_length": 16,
"command_status": "ESME_RSYSERR",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000015 = '''{
"body": {
"mandatory_parameters": {
"data_coding": 0,
"dest_address": [
{
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"dest_flag": 1,
"destination_addr": "the address"
},
{
"dest_flag": 2,
"dl_name": "the list"
},
{
"dest_flag": 2,
"dl_name": "the other list"
}
],
"esm_class": 0,
"number_of_dests": 3,
"priority_flag": 0,
"protocol_id": 0,
"registered_delivery": 0,
"replace_if_present_flag": 0,
"schedule_delivery_time": "",
"service_type": "",
"short_message": "testing 123",
"sm_default_msg_id": 0,
- "sm_length": 12,
+ "sm_length": 11,
"source_addr": "",
"source_addr_npi": "ISDN",
"source_addr_ton": "international",
"validity_period": ""
}
},
"header": {
"command_id": "submit_multi",
- "command_length": 84,
+ "command_length": 83,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000016 = '''{
"body": {
"mandatory_parameters": {
"message_id": "",
"no_unsuccess": 2,
"unsuccess_sme": [
{
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "",
"error_status_code": 0
},
{
"dest_addr_npi": "ISDN",
"dest_addr_ton": "network_specific",
"destination_addr": "555",
"error_status_code": 0
}
]
}
},
"header": {
"command_id": "submit_multi_resp",
"command_length": 35,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000017 = '''{
"body": {
"mandatory_parameters": {
"data_coding": 0,
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "",
"esm_class": 0,
"priority_flag": 0,
"protocol_id": 0,
"registered_delivery": 0,
"replace_if_present_flag": 0,
"schedule_delivery_time": "",
"service_type": "",
- "short_message": "",
+ "short_message": null,
"sm_default_msg_id": 0,
- "sm_length": 1,
+ "sm_length": 0,
"source_addr": "",
"source_addr_npi": "ISDN",
"source_addr_ton": "international",
"validity_period": ""
}
},
"header": {
"command_id": "deliver_sm",
- "command_length": 34,
+ "command_length": 33,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000018 = '''{
"body": {
"mandatory_parameters": {
"message_id": ""
}
},
"header": {
"command_id": "deliver_sm_resp",
"command_length": 17,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000019 = '''{
"body": {
"mandatory_parameters": {
"data_coding": 0,
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "",
"esm_class": 0,
"registered_delivery": 0,
"service_type": "",
"source_addr": "",
"source_addr_npi": "ISDN",
"source_addr_ton": "international"
},
"optional_parameters": [
{
"length": 0,
"tag": "message_payload",
"value": null
}
]
},
"header": {
"command_id": "data_sm",
"command_length": 30,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000020 = '''{
"body": {
"mandatory_parameters": {
"message_id": ""
}
},
"header": {
"command_id": "data_sm_resp",
"command_length": 17,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000021 = '''{
"body": {
"mandatory_parameters": {
"message_id": "",
"source_addr": "",
"source_addr_npi": "ISDN",
"source_addr_ton": "international"
}
},
"header": {
"command_id": "query_sm",
"command_length": 20,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000022 = '''{
"body": {
"mandatory_parameters": {
"error_code": 0,
"final_date": "",
"message_id": "",
"message_state": 0
}
},
"header": {
"command_id": "query_sm_resp",
"command_length": 20,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000023 = '''{
"body": {
"mandatory_parameters": {
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "",
"message_id": "",
"service_type": "",
"source_addr": "",
"source_addr_npi": "ISDN",
"source_addr_ton": "international"
}
},
"header": {
"command_id": "cancel_sm",
"command_length": 24,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000024 = '''{
"header": {
"command_id": "cancel_sm_resp",
"command_length": 16,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000025 = '''{
"body": {
"mandatory_parameters": {
"data_coding": 0,
"message_id": "",
"registered_delivery": 0,
"replace_if_present_flag": 0,
"schedule_delivery_time": "",
"short_message": "is this an = sign?",
"sm_default_msg_id": 0,
- "sm_length": 19,
+ "sm_length": 18,
"source_addr": "",
"source_addr_npi": "ISDN",
"source_addr_ton": "international",
"validity_period": ""
}
},
"header": {
"command_id": "replace_sm",
- "command_length": 46,
+ "command_length": 45,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000026 = '''{
"header": {
"command_id": "replace_sm_resp",
"command_length": 16,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000027 = '''{
"header": {
"command_id": "enquire_link",
"command_length": 16,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000028 = '''{
"header": {
"command_id": "enquire_link_resp",
"command_length": 16,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000029 = '''{
"body": {
"mandatory_parameters": {
"esme_addr": "",
"esme_addr_npi": "unknown",
"esme_addr_ton": 9,
"source_addr": "",
"source_addr_npi": "ISDN",
"source_addr_ton": "international"
}
},
"header": {
"command_id": "alert_notification",
"command_length": 22,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
|
dmaclay/python-smpp
|
02ad352233a6bc81e1e8fa1d433dab7ca2f7a5b7
|
deliver_sm_resp, enquire_link and got rid of accidental class variables
|
diff --git a/src/smpp/pdu_builder.py b/src/smpp/pdu_builder.py
index 858e059..c42772d 100644
--- a/src/smpp/pdu_builder.py
+++ b/src/smpp/pdu_builder.py
@@ -1,245 +1,263 @@
from pdu import *
class PDU(object):
def __init__(self,
command_id,
command_status,
sequence_number,
**kwargs):
super(PDU, self).__init__()
self.obj = {}
- header = {}
- self.obj['header'] = header
- header['command_length'] = 0
- header['command_id'] = command_id
- header['command_status'] = command_status
- header['sequence_number'] = sequence_number
+ self.obj['header'] = {}
+ self.obj['header']['command_length'] = 0
+ self.obj['header']['command_id'] = command_id
+ self.obj['header']['command_status'] = command_status
+ self.obj['header']['sequence_number'] = sequence_number
def __add_optional_parameter(self, tag, value):
- optional_parameters = self.obj['body'].get('optional_parameters')
- if optional_parameters == None:
- optional_parameters = []
- self.obj['body']['optional_parameters'] = optional_parameters
- optional_parameters.append({
+ if self.obj.get('body') == None:
+ self.obj['body'] = {}
+ if self.obj['body'].get('optional_parameters') == None:
+ self.obj['body']['optional_parameters'] = []
+ self.obj['body']['optional_parameters'].append({
'tag':tag,
'length':0,
'value':value,
})
def get_obj(self):
return self.obj
def get_hex(self):
return encode_pdu(self.obj)
def get_bin(self):
return pack_pdu(self.obj)
class Bind(PDU):
def __init__(self,
command_id,
sequence_number,
system_id = '',
password = '',
system_type = '',
interface_version = '34',
addr_ton = 0,
addr_npi = 0,
address_range = '',
**kwargs):
super(Bind, self).__init__(
command_id,
'ESME_ROK',
sequence_number,
)
- body = {}
- self.obj['body'] = body
- mandatory_parameters = {}
- body['mandatory_parameters'] = mandatory_parameters
- mandatory_parameters['system_id'] = system_id
- mandatory_parameters['password'] = password
- mandatory_parameters['system_type'] = system_type
- mandatory_parameters['interface_version'] = interface_version
- mandatory_parameters['addr_ton'] = addr_ton
- mandatory_parameters['addr_npi'] = addr_npi
- mandatory_parameters['address_range'] = address_range
+ self.obj['body'] = {}
+ self.obj['body']['mandatory_parameters'] = {}
+ self.obj['body']['mandatory_parameters']['system_id'] = system_id
+ self.obj['body']['mandatory_parameters']['password'] = password
+ self.obj['body']['mandatory_parameters']['system_type'] = system_type
+ self.obj['body']['mandatory_parameters']['interface_version'] = interface_version
+ self.obj['body']['mandatory_parameters']['addr_ton'] = addr_ton
+ self.obj['body']['mandatory_parameters']['addr_npi'] = addr_npi
+ self.obj['body']['mandatory_parameters']['address_range'] = address_range
class BindTransmitter(Bind):
def __init__(self,
sequence_number,
**kwargs):
super(BindTransmitter, self).__init__('bind_transmitter', sequence_number, **kwargs)
class BindReceiver(Bind):
def __init__(self,
sequence_number,
**kwargs):
super(BindReceiver, self).__init__('bind_receiver', sequence_number, **kwargs)
class BindTransceiver(Bind):
def __init__(self,
sequence_number,
**kwargs):
super(BindTransceiver, self).__init__('bind_transceiver', sequence_number, **kwargs)
class Unbind(PDU):
def __init__(self,
sequence_number,
**kwargs):
- super(Unbind, self).__init__(
- 'unbind',
- 'ESME_ROK',
- sequence_number,
- )
+ super(Unbind, self).__init__('unbind', 'ESME_ROK', sequence_number, **kwargs)
class SM1(PDU):
def __init__(self,
command_id,
sequence_number,
service_type = '',
source_addr_ton = 0,
source_addr_npi = 0,
source_addr = '',
esm_class = 0,
protocol_id = 0,
priority_flag = 0,
schedule_delivery_time = '',
validity_period = '',
registered_delivery = 0,
replace_if_present_flag = 0,
data_coding = 0,
sm_default_msg_id = 0,
sm_length = 0,
short_message = None,
**kwargs):
super(SM1, self).__init__(
command_id,
'ESME_ROK',
sequence_number,
)
- body = {}
- self.obj['body'] = body
- mandatory_parameters = {}
- body['mandatory_parameters'] = mandatory_parameters
- mandatory_parameters['service_type'] = service_type
- mandatory_parameters['source_addr_ton'] = source_addr_ton
- mandatory_parameters['source_addr_npi'] = source_addr_npi
- mandatory_parameters['source_addr'] = source_addr
- mandatory_parameters['esm_class'] = esm_class
- mandatory_parameters['protocol_id'] = protocol_id
- mandatory_parameters['priority_flag'] = priority_flag
- mandatory_parameters['schedule_delivery_time'] = schedule_delivery_time
- mandatory_parameters['validity_period'] = validity_period
- mandatory_parameters['registered_delivery'] = registered_delivery
- mandatory_parameters['replace_if_present_flag'] = replace_if_present_flag
- mandatory_parameters['data_coding'] = data_coding
- mandatory_parameters['sm_default_msg_id'] = sm_default_msg_id
- mandatory_parameters['sm_length'] = sm_length
- mandatory_parameters['short_message'] = short_message
+ self.obj['body'] = {}
+ self.obj['body']['mandatory_parameters'] = {}
+ self.obj['body']['mandatory_parameters']['service_type'] = service_type
+ self.obj['body']['mandatory_parameters']['source_addr_ton'] = source_addr_ton
+ self.obj['body']['mandatory_parameters']['source_addr_npi'] = source_addr_npi
+ self.obj['body']['mandatory_parameters']['source_addr'] = source_addr
+ self.obj['body']['mandatory_parameters']['esm_class'] = esm_class
+ self.obj['body']['mandatory_parameters']['protocol_id'] = protocol_id
+ self.obj['body']['mandatory_parameters']['priority_flag'] = priority_flag
+ self.obj['body']['mandatory_parameters']['schedule_delivery_time'] = schedule_delivery_time
+ self.obj['body']['mandatory_parameters']['validity_period'] = validity_period
+ self.obj['body']['mandatory_parameters']['registered_delivery'] = registered_delivery
+ self.obj['body']['mandatory_parameters']['replace_if_present_flag'] = replace_if_present_flag
+ self.obj['body']['mandatory_parameters']['data_coding'] = data_coding
+ self.obj['body']['mandatory_parameters']['sm_default_msg_id'] = sm_default_msg_id
+ self.obj['body']['mandatory_parameters']['sm_length'] = sm_length
+ self.obj['body']['mandatory_parameters']['short_message'] = short_message
def add_message_payload(self, value):
self.obj['body']['mandatory_parameters']['sm_length'] = 0
self.obj['body']['mandatory_parameters']['short_message'] = None
self._PDU__add_optional_parameter('message_payload', value)
class SubmitMulti(SM1):
def __init__(self,
sequence_number,
number_of_dests = 0,
dest_address = [],
**kwargs):
super(SubmitMulti, self).__init__('submit_multi', sequence_number, **kwargs)
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['number_of_dests'] = number_of_dests
mandatory_parameters['dest_address'] = [] + dest_address
def addDestinationAddress(self,
destination_addr,
dest_addr_ton = 0,
dest_addr_npi = 0,
):
if isinstance(destination_addr, str) and len(destination_addr) > 0:
new_entry = {
'dest_flag':1,
'dest_addr_ton':dest_addr_ton,
'dest_addr_npi':dest_addr_npi,
'destination_addr':destination_addr,
}
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_address'].append(new_entry)
mandatory_parameters['number_of_dests'] = len(
mandatory_parameters['dest_address'])
return True
else:
return False
def addDistributionList(self,
dl_name,
):
if isinstance(dl_name, str) and len(dl_name) > 0:
new_entry = {
'dest_flag':2,
'dl_name':dl_name,
}
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_address'].append(new_entry)
mandatory_parameters['number_of_dests'] = len(
mandatory_parameters['dest_address'])
return True
else:
return False
class SM2(SM1):
def __init__(self,
command_id,
sequence_number,
dest_addr_ton = 0,
dest_addr_npi = 0,
destination_addr = '',
**kwargs):
super(SM2, self).__init__(command_id, sequence_number, **kwargs)
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_addr_ton'] = dest_addr_ton
mandatory_parameters['dest_addr_npi'] = dest_addr_npi
mandatory_parameters['destination_addr'] = destination_addr
class SubmitSM(SM2):
def __init__(self,
sequence_number,
**kwargs):
super(SubmitSM, self).__init__('submit_sm', sequence_number, **kwargs)
+
class DeliverSM(SM2):
def __init__(self,
sequence_number,
**kwargs):
super(DeliverSM, self).__init__('deliver_sm',sequence_number, **kwargs)
+class DeliverSMResp(PDU):
+ def __init__(self,
+ sequence_number,
+ command_status = 'ESME_ROK',
+ **kwargs):
+ super(DeliverSMResp, self).__init__(
+ 'deliver_sm_resp',
+ command_status,
+ sequence_number,
+ **kwargs)
+ self.obj['body'] = {}
+ self.obj['body']['mandatory_parameters'] = {}
+ self.obj['body']['mandatory_parameters']['message_id'] = ''
+
+
+class EnquireLink(PDU):
+ def __init__(self,
+ sequence_number,
+ **kwargs):
+ super(EnquireLink, self).__init__(
+ 'enquire_link',
+ 'ESME_ROK',
+ sequence_number,
+ **kwargs)
+
+
#bind = BindTransmitter(system_id='test_id', password='abc123')
#print bind.get_obj()
#print bind.get_hex()
#print bind.get_bin()
##print json.dumps(bind.get_obj(), indent=4, sort_keys=True)
##print json.dumps(decode_pdu(bind.get_hex()), indent=4, sort_keys=True)
#print json.dumps(unpack_pdu(bind.get_bin()), indent=4, sort_keys=True)
#sm = SubmitSM(short_message='testing testing')
#print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
#sm.add_message_payload('616263646566676869')
#print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
diff --git a/tests.py b/tests.py
index 80afab5..60b8485 100644
--- a/tests.py
+++ b/tests.py
@@ -1,200 +1,215 @@
import unittest
from datetime import datetime, timedelta
from smpp.esme import *
from smpp.clickatell import *
import credentials_test
try:import credentials_priv
except:pass
from test.pdu import pdu_objects
from test import pdu_asserts
from test.pdu_hex import pdu_hex_strings
from test import pdu_hex_asserts
def unpack_hex(pdu_hex):
"""Unpack PDU hex string and return it as a dictionary"""
return unpack_pdu(binascii.a2b_hex(hexclean(pdu_hex)))
def hexclean(dirtyhex):
"""Remove whitespace, comments & newlines from hex string"""
return re.sub(r'\s','',re.sub(r'#.*\n','\n',dirtyhex))
def prettydump(pdu_obj):
"""Unpack PDU dictionary and dump it as a JSON formatted string"""
return json.dumps(pdu_obj, indent=4, sort_keys=True)
def create_pdu_asserts():
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_pdu(pack_pdu(pdu)))
pstr += "'''"
print pstr
def create_pdu_hex_asserts():
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_hex(pdu_hex))
pstr += "'''"
print pstr
## :w|!python % > test/pdu_asserts.py
#create_pdu_asserts()
#quit()
## :w|!python % > test/pdu_hex_asserts.py
#create_pdu_hex_asserts()
#quit()
class PduTestCase(unittest.TestCase):
def setUp(self):
pass
def tearDown(self):
pass
def test_pack_unpack_pdu_objects(self):
print ''
"""
Take a dictionary, pack and unpack it and dump it as JSON correctly
"""
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
padded_index = '%010d' % pdu_index
print '...', padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_pdu(pack_pdu(pdu)))),
re.sub('\n *','',
eval('pdu_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_pdu_hex_strings(self):
print ''
"""
Read the hex data, clean it, and unpack it to JSON correctly
"""
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
padded_index = '%010d' % pdu_index
print '...', padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_hex(pdu_hex))),
re.sub('\n *','',
eval('pdu_hex_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_performance(self):
print ''
"""
Pack & unpack 2000 submit_sm PDUs in under 1 second
"""
submit_sm = {
'header': {
'command_length': 0,
'command_id': 'submit_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
'esm_class':0,
'protocol_id':0,
'priority_flag':0,
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
'sm_length':1,
'short_message':'',
},
},
}
start = datetime.now()
for x in range(2000):
x += 1
submit_sm['header']['sequence_number'] = x
sm = 'testing: x = '+str(x)+''
submit_sm['body']['mandatory_parameters']['short_message'] = sm
u = unpack_pdu(pack_pdu(submit_sm))
delta = datetime.now() - start
print '... 2000 pack & unpacks in:', delta
self.assertTrue(delta < timedelta(seconds=1))
class PduBuilderTestCase(unittest.TestCase):
def test_true(self):
print ''
self.assertTrue(True)
if __name__ == '__main__':
print '\n##########################################################\n'
+ #deliv_sm_resp = DeliverSMResp(23)
+ #print deliv_sm_resp.get_obj()
+ #print deliv_sm_resp.get_hex()
+ #enq_lnk = EnquireLink(7)
+ #print enq_lnk.get_obj()
+ #print enq_lnk.get_hex()
+ #sub_sm = SubmitSM(5, short_message='testing testing')
+ #print sub_sm.get_obj()
+ #print sub_sm.get_hex()
+ #sub_sm.add_message_payload('01020304')
+ #print sub_sm.get_obj()
+ #print sub_sm.get_hex()
+ #print unpack_pdu(sub_sm.get_bin())
+ print '\n##########################################################\n'
+
esme = ESME()
esme.loadDefaults(clickatell_defaults)
esme.loadDefaults(credentials_test.logica)
print esme.defaults
esme.bind_transmitter()
print esme.state
start = datetime.now()
for x in range(1):
esme.submit_sm(
short_message = 'gobbledygook',
destination_addr = '555',
)
print esme.state
for x in range(1):
esme.submit_multi(
short_message = 'gobbledygook',
dest_address = ['444','333'],
)
print esme.state
for x in range(1):
esme.submit_multi(
short_message = 'gobbledygook',
dest_address = [
{'dest_flag':1, 'destination_addr':'111'},
{'dest_flag':2, 'dl_name':'list22222'},
],
)
print esme.state
delta = datetime.now() - start
esme.disconnect()
print esme.state
print 'excluding binding ... time to send messages =', delta
#if __name__ == '__main__':
#unittest.main()
|
dmaclay/python-smpp
|
0b78f3dbefc91f5612e78674c931fde25b042427
|
different bind types
|
diff --git a/src/smpp/pdu_builder.py b/src/smpp/pdu_builder.py
index 5a95e32..858e059 100644
--- a/src/smpp/pdu_builder.py
+++ b/src/smpp/pdu_builder.py
@@ -1,223 +1,245 @@
from pdu import *
class PDU(object):
def __init__(self,
command_id,
command_status,
sequence_number,
**kwargs):
super(PDU, self).__init__()
self.obj = {}
header = {}
self.obj['header'] = header
header['command_length'] = 0
header['command_id'] = command_id
header['command_status'] = command_status
header['sequence_number'] = sequence_number
def __add_optional_parameter(self, tag, value):
optional_parameters = self.obj['body'].get('optional_parameters')
if optional_parameters == None:
optional_parameters = []
self.obj['body']['optional_parameters'] = optional_parameters
optional_parameters.append({
'tag':tag,
'length':0,
'value':value,
})
def get_obj(self):
return self.obj
def get_hex(self):
return encode_pdu(self.obj)
def get_bin(self):
return pack_pdu(self.obj)
-class BindTransmitter(PDU):
+class Bind(PDU):
def __init__(self,
+ command_id,
sequence_number,
system_id = '',
password = '',
system_type = '',
interface_version = '34',
addr_ton = 0,
addr_npi = 0,
address_range = '',
**kwargs):
- super(BindTransmitter, self).__init__(
- 'bind_transmitter',
+ super(Bind, self).__init__(
+ command_id,
'ESME_ROK',
sequence_number,
)
body = {}
self.obj['body'] = body
mandatory_parameters = {}
body['mandatory_parameters'] = mandatory_parameters
mandatory_parameters['system_id'] = system_id
mandatory_parameters['password'] = password
mandatory_parameters['system_type'] = system_type
mandatory_parameters['interface_version'] = interface_version
mandatory_parameters['addr_ton'] = addr_ton
mandatory_parameters['addr_npi'] = addr_npi
mandatory_parameters['address_range'] = address_range
+class BindTransmitter(Bind):
+ def __init__(self,
+ sequence_number,
+ **kwargs):
+ super(BindTransmitter, self).__init__('bind_transmitter', sequence_number, **kwargs)
+
+
+class BindReceiver(Bind):
+ def __init__(self,
+ sequence_number,
+ **kwargs):
+ super(BindReceiver, self).__init__('bind_receiver', sequence_number, **kwargs)
+
+
+class BindTransceiver(Bind):
+ def __init__(self,
+ sequence_number,
+ **kwargs):
+ super(BindTransceiver, self).__init__('bind_transceiver', sequence_number, **kwargs)
+
+
class Unbind(PDU):
def __init__(self,
sequence_number,
**kwargs):
super(Unbind, self).__init__(
'unbind',
'ESME_ROK',
sequence_number,
)
class SM1(PDU):
def __init__(self,
command_id,
sequence_number,
service_type = '',
source_addr_ton = 0,
source_addr_npi = 0,
source_addr = '',
esm_class = 0,
protocol_id = 0,
priority_flag = 0,
schedule_delivery_time = '',
validity_period = '',
registered_delivery = 0,
replace_if_present_flag = 0,
data_coding = 0,
sm_default_msg_id = 0,
sm_length = 0,
short_message = None,
**kwargs):
super(SM1, self).__init__(
command_id,
'ESME_ROK',
sequence_number,
)
body = {}
self.obj['body'] = body
mandatory_parameters = {}
body['mandatory_parameters'] = mandatory_parameters
mandatory_parameters['service_type'] = service_type
mandatory_parameters['source_addr_ton'] = source_addr_ton
mandatory_parameters['source_addr_npi'] = source_addr_npi
mandatory_parameters['source_addr'] = source_addr
mandatory_parameters['esm_class'] = esm_class
mandatory_parameters['protocol_id'] = protocol_id
mandatory_parameters['priority_flag'] = priority_flag
mandatory_parameters['schedule_delivery_time'] = schedule_delivery_time
mandatory_parameters['validity_period'] = validity_period
mandatory_parameters['registered_delivery'] = registered_delivery
mandatory_parameters['replace_if_present_flag'] = replace_if_present_flag
mandatory_parameters['data_coding'] = data_coding
mandatory_parameters['sm_default_msg_id'] = sm_default_msg_id
mandatory_parameters['sm_length'] = sm_length
mandatory_parameters['short_message'] = short_message
def add_message_payload(self, value):
self.obj['body']['mandatory_parameters']['sm_length'] = 0
self.obj['body']['mandatory_parameters']['short_message'] = None
self._PDU__add_optional_parameter('message_payload', value)
class SubmitMulti(SM1):
def __init__(self,
sequence_number,
number_of_dests = 0,
dest_address = [],
**kwargs):
super(SubmitMulti, self).__init__('submit_multi', sequence_number, **kwargs)
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['number_of_dests'] = number_of_dests
mandatory_parameters['dest_address'] = [] + dest_address
def addDestinationAddress(self,
destination_addr,
dest_addr_ton = 0,
dest_addr_npi = 0,
):
if isinstance(destination_addr, str) and len(destination_addr) > 0:
new_entry = {
'dest_flag':1,
'dest_addr_ton':dest_addr_ton,
'dest_addr_npi':dest_addr_npi,
'destination_addr':destination_addr,
}
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_address'].append(new_entry)
mandatory_parameters['number_of_dests'] = len(
mandatory_parameters['dest_address'])
return True
else:
return False
def addDistributionList(self,
dl_name,
):
if isinstance(dl_name, str) and len(dl_name) > 0:
new_entry = {
'dest_flag':2,
'dl_name':dl_name,
}
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_address'].append(new_entry)
mandatory_parameters['number_of_dests'] = len(
mandatory_parameters['dest_address'])
return True
else:
return False
class SM2(SM1):
def __init__(self,
command_id,
sequence_number,
dest_addr_ton = 0,
dest_addr_npi = 0,
destination_addr = '',
**kwargs):
super(SM2, self).__init__(command_id, sequence_number, **kwargs)
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_addr_ton'] = dest_addr_ton
mandatory_parameters['dest_addr_npi'] = dest_addr_npi
mandatory_parameters['destination_addr'] = destination_addr
class SubmitSM(SM2):
def __init__(self,
sequence_number,
**kwargs):
super(SubmitSM, self).__init__('submit_sm', sequence_number, **kwargs)
class DeliverSM(SM2):
def __init__(self,
sequence_number,
**kwargs):
super(DeliverSM, self).__init__('deliver_sm',sequence_number, **kwargs)
#bind = BindTransmitter(system_id='test_id', password='abc123')
#print bind.get_obj()
#print bind.get_hex()
#print bind.get_bin()
##print json.dumps(bind.get_obj(), indent=4, sort_keys=True)
##print json.dumps(decode_pdu(bind.get_hex()), indent=4, sort_keys=True)
#print json.dumps(unpack_pdu(bind.get_bin()), indent=4, sort_keys=True)
#sm = SubmitSM(short_message='testing testing')
#print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
#sm.add_message_payload('616263646566676869')
#print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
|
dmaclay/python-smpp
|
c27f3006c61365721f868d2d7e0d1d304428c798
|
cleanup
|
diff --git a/tests.py b/tests.py
index 08d6c86..80afab5 100644
--- a/tests.py
+++ b/tests.py
@@ -1,200 +1,200 @@
import unittest
from datetime import datetime, timedelta
from smpp.esme import *
from smpp.clickatell import *
+import credentials_test
try:import credentials_priv
except:pass
-import credentials_test
from test.pdu import pdu_objects
from test import pdu_asserts
from test.pdu_hex import pdu_hex_strings
from test import pdu_hex_asserts
def unpack_hex(pdu_hex):
"""Unpack PDU hex string and return it as a dictionary"""
return unpack_pdu(binascii.a2b_hex(hexclean(pdu_hex)))
def hexclean(dirtyhex):
"""Remove whitespace, comments & newlines from hex string"""
return re.sub(r'\s','',re.sub(r'#.*\n','\n',dirtyhex))
def prettydump(pdu_obj):
"""Unpack PDU dictionary and dump it as a JSON formatted string"""
return json.dumps(pdu_obj, indent=4, sort_keys=True)
def create_pdu_asserts():
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_pdu(pack_pdu(pdu)))
pstr += "'''"
print pstr
def create_pdu_hex_asserts():
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_hex(pdu_hex))
pstr += "'''"
print pstr
## :w|!python % > test/pdu_asserts.py
#create_pdu_asserts()
#quit()
## :w|!python % > test/pdu_hex_asserts.py
#create_pdu_hex_asserts()
#quit()
class PduTestCase(unittest.TestCase):
def setUp(self):
pass
def tearDown(self):
pass
def test_pack_unpack_pdu_objects(self):
print ''
"""
Take a dictionary, pack and unpack it and dump it as JSON correctly
"""
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
padded_index = '%010d' % pdu_index
print '...', padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_pdu(pack_pdu(pdu)))),
re.sub('\n *','',
eval('pdu_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_pdu_hex_strings(self):
print ''
"""
Read the hex data, clean it, and unpack it to JSON correctly
"""
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
padded_index = '%010d' % pdu_index
print '...', padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_hex(pdu_hex))),
re.sub('\n *','',
eval('pdu_hex_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_performance(self):
print ''
"""
Pack & unpack 2000 submit_sm PDUs in under 1 second
"""
submit_sm = {
'header': {
'command_length': 0,
'command_id': 'submit_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
'esm_class':0,
'protocol_id':0,
'priority_flag':0,
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
'sm_length':1,
'short_message':'',
},
},
}
start = datetime.now()
for x in range(2000):
x += 1
submit_sm['header']['sequence_number'] = x
sm = 'testing: x = '+str(x)+''
submit_sm['body']['mandatory_parameters']['short_message'] = sm
u = unpack_pdu(pack_pdu(submit_sm))
delta = datetime.now() - start
print '... 2000 pack & unpacks in:', delta
self.assertTrue(delta < timedelta(seconds=1))
class PduBuilderTestCase(unittest.TestCase):
def test_true(self):
print ''
self.assertTrue(True)
if __name__ == '__main__':
print '\n##########################################################\n'
esme = ESME()
esme.loadDefaults(clickatell_defaults)
esme.loadDefaults(credentials_test.logica)
print esme.defaults
esme.bind_transmitter()
print esme.state
start = datetime.now()
for x in range(1):
esme.submit_sm(
short_message = 'gobbledygook',
destination_addr = '555',
)
print esme.state
for x in range(1):
esme.submit_multi(
short_message = 'gobbledygook',
dest_address = ['444','333'],
)
print esme.state
for x in range(1):
esme.submit_multi(
short_message = 'gobbledygook',
dest_address = [
{'dest_flag':1, 'destination_addr':'111'},
{'dest_flag':2, 'dl_name':'list22222'},
],
)
print esme.state
delta = datetime.now() - start
esme.disconnect()
print esme.state
print 'excluding binding ... time to send messages =', delta
#if __name__ == '__main__':
#unittest.main()
|
dmaclay/python-smpp
|
078ed67e68082ec032f9ad3af5de18c3bcb04fee
|
setup develop
|
diff --git a/tests.py b/tests.py
index 769646f..08d6c86 100644
--- a/tests.py
+++ b/tests.py
@@ -1,204 +1,200 @@
import unittest
from datetime import datetime, timedelta
-try:from smpp.esme import *
-except:from src.smpp.esme import *
-
-try:from smpp.clickatell import *
-except:from src.smpp.clickatell import *
-
+from smpp.esme import *
+from smpp.clickatell import *
try:import credentials_priv
except:pass
import credentials_test
from test.pdu import pdu_objects
from test import pdu_asserts
from test.pdu_hex import pdu_hex_strings
from test import pdu_hex_asserts
def unpack_hex(pdu_hex):
"""Unpack PDU hex string and return it as a dictionary"""
return unpack_pdu(binascii.a2b_hex(hexclean(pdu_hex)))
def hexclean(dirtyhex):
"""Remove whitespace, comments & newlines from hex string"""
return re.sub(r'\s','',re.sub(r'#.*\n','\n',dirtyhex))
def prettydump(pdu_obj):
"""Unpack PDU dictionary and dump it as a JSON formatted string"""
return json.dumps(pdu_obj, indent=4, sort_keys=True)
def create_pdu_asserts():
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_pdu(pack_pdu(pdu)))
pstr += "'''"
print pstr
def create_pdu_hex_asserts():
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_hex(pdu_hex))
pstr += "'''"
print pstr
## :w|!python % > test/pdu_asserts.py
#create_pdu_asserts()
#quit()
## :w|!python % > test/pdu_hex_asserts.py
#create_pdu_hex_asserts()
#quit()
class PduTestCase(unittest.TestCase):
def setUp(self):
pass
def tearDown(self):
pass
def test_pack_unpack_pdu_objects(self):
print ''
"""
Take a dictionary, pack and unpack it and dump it as JSON correctly
"""
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
padded_index = '%010d' % pdu_index
print '...', padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_pdu(pack_pdu(pdu)))),
re.sub('\n *','',
eval('pdu_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_pdu_hex_strings(self):
print ''
"""
Read the hex data, clean it, and unpack it to JSON correctly
"""
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
padded_index = '%010d' % pdu_index
print '...', padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_hex(pdu_hex))),
re.sub('\n *','',
eval('pdu_hex_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_performance(self):
print ''
"""
Pack & unpack 2000 submit_sm PDUs in under 1 second
"""
submit_sm = {
'header': {
'command_length': 0,
'command_id': 'submit_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
'esm_class':0,
'protocol_id':0,
'priority_flag':0,
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
'sm_length':1,
'short_message':'',
},
},
}
start = datetime.now()
for x in range(2000):
x += 1
submit_sm['header']['sequence_number'] = x
sm = 'testing: x = '+str(x)+''
submit_sm['body']['mandatory_parameters']['short_message'] = sm
u = unpack_pdu(pack_pdu(submit_sm))
delta = datetime.now() - start
print '... 2000 pack & unpacks in:', delta
self.assertTrue(delta < timedelta(seconds=1))
class PduBuilderTestCase(unittest.TestCase):
def test_true(self):
print ''
self.assertTrue(True)
if __name__ == '__main__':
print '\n##########################################################\n'
esme = ESME()
esme.loadDefaults(clickatell_defaults)
esme.loadDefaults(credentials_test.logica)
print esme.defaults
esme.bind_transmitter()
print esme.state
start = datetime.now()
for x in range(1):
esme.submit_sm(
short_message = 'gobbledygook',
destination_addr = '555',
)
print esme.state
for x in range(1):
esme.submit_multi(
short_message = 'gobbledygook',
dest_address = ['444','333'],
)
print esme.state
for x in range(1):
esme.submit_multi(
short_message = 'gobbledygook',
dest_address = [
{'dest_flag':1, 'destination_addr':'111'},
{'dest_flag':2, 'dl_name':'list22222'},
],
)
print esme.state
delta = datetime.now() - start
esme.disconnect()
print esme.state
print 'excluding binding ... time to send messages =', delta
#if __name__ == '__main__':
#unittest.main()
|
dmaclay/python-smpp
|
f704d089b6e54d546966f0c3d572cf277de69ab8
|
interface version is an octet 0x34
|
diff --git a/src/smpp/clickatell.py b/src/smpp/clickatell.py
index d54999f..2108e51 100644
--- a/src/smpp/clickatell.py
+++ b/src/smpp/clickatell.py
@@ -1,7 +1,7 @@
clickatell_defaults = {
- 'interface_version':'', #TODO should be '34' - fix pdu.py
+ 'interface_version':'34',
'dest_addr_ton':1,
'dest_addr_npi':1,
}
diff --git a/src/smpp/pdu.py b/src/smpp/pdu.py
index 97cba18..64eed55 100644
--- a/src/smpp/pdu.py
+++ b/src/smpp/pdu.py
@@ -1,557 +1,557 @@
import binascii
import re
try:
import json
except:
import simplejson as json
maps = {} # Inserting certain referenced dicts in here means they can be declared in the same order as in the spec.
# SMPP PDU Definition - SMPP v3.4, section 4, page 45
mandatory_parameter_lists = {
'bind_transmitter':[ # SMPP v3.4, section 4.1.1, table 4-1, page 46
{'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None},
{'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'map':None},
{'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'map':None},
- {'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'string', 'map':None},
+ {'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'hex', 'map':None},
{'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'map':None}
],
'bind_transmitter_resp':[ # SMPP v3.4, section 4.1.2, table 4-2, page 47
{'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None}
],
'bind_receiver':[ # SMPP v3.4, section 4.1.3, table 4-3, page 48
{'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None},
{'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'map':None},
{'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'map':None},
- {'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'string', 'map':None},
+ {'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'hex', 'map':None},
{'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'map':None}
],
'bind_receiver_resp':[ # SMPP v3.4, section 4.1.4, table 4-4, page 50
{'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None}
],
'bind_transceiver':[ # SMPP v3.4, section 4.1.5, table 4-5, page 51
{'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None},
{'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'map':None},
{'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'map':None},
- {'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'string', 'map':None},
+ {'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'hex', 'map':None},
{'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'map':None}
],
'bind_transceiver_resp':[ # SMPP v3.4, section 4.1.6, table 4-6, page 52
{'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None}
],
'outbind':[ # SMPP v3.4, section 4.1.7.1, page 54
{'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None},
{'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'map':None}
],
'unbind':[ # SMPP v3.4, section 4.2.1, table 4-7, page 56
],
'unbind_resp':[ # SMPP v3.4, section 4.2.2, table 4-8, page 56
],
'generic_nack':[ # SMPP v3.4, section 4.3.1, table 4-9, page 57
],
'submit_sm':[ # SMPP v3.4, section 4.4.1, table 4-10, page 59-61
{'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
{'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
{'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'map':None}
],
'submit_sm_resp':[ # SMPP v3.4, section 4.4.2, table 4-11, page 67
{'name':'message_id', 'min':0, 'max':65, 'var':True, 'type':'string', 'map':None}
],
'submit_multi':[ # SMPP v3.4, section 4.5.1, table 4-12, page 69-71
{'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'number_of_dests', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'dest_address', 'min':0, 'max':0, 'var':'number_of_dests', 'type':'dest_address', 'map':None},
{'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
{'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
{'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'map':None}
],
'dest_address':[ # SMPP v3.4, section 4.5.1.1, table 4-13, page 75
{'name':'dest_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None}
# 'sme_dest_address' or 'distribution_list' goes here
],
'sme_dest_address':[ # SMPP v3.4, section 4.5.1.1, table 4-14, page 75
{'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None}
],
'distribution_list':[ # SMPP v3.4, section 4.5.1.2, table 4-15, page 75
{'name':'dl_name', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None}
],
'submit_multi_resp':[ # SMPP v3.4, section 4.5.2, table 4-16, page 76
{'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'no_unsuccess', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'unsuccess_sme', 'min':0, 'max':0, 'var':'no_unsuccess', 'type':'unsuccess_sme', 'map':None}
],
'unsuccess_sme':[ # SMPP v3.4, section 4.5.2.1, table 4-17, page 77
{'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'error_status_code', 'min':4, 'max':4, 'var':False, 'type':'integer', 'map':None}
],
'deliver_sm':[ # SMPP v3.4, section 4.6.1, table 4-18, page 79-81
{'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'schedule_delivery_time', 'min':1, 'max':1, 'var':False, 'type':'string', 'map':None},
{'name':'validity_period', 'min':1, 'max':1, 'var':False, 'type':'string', 'map':None},
{'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'map':None}
],
'deliver_sm_resp':[ # SMPP v3.4, section 4.6.2, table 4-19, page 85
{'name':'message_id', 'min':1, 'max':1, 'var':False, 'type':'string', 'map':None}
],
'data_sm':[ # SMPP v3.4, section 4.7.1, table 4-20, page 87-88
{'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'destination_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None}
],
'data_sm_resp':[ # SMPP v3.4, section 4.7.2, table 4-21, page 93
{'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None}
],
'query_sm':[ # SMPP v3.4, section 4.8.1, table 4-22, page 95
{'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None}
],
'query_sm_resp':[ # SMPP v3.4, section 4.7.2, table 4-21, page 93
{'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'final_date', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
{'name':'message_state', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'error_code', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None}
],
'cancel_sm':[ # SMPP v3.4, section 4.9.1, table 4-24, page 98-99
{'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'map':None},
{'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None}
],
'cancel_sm_resp':[ # SMPP v3.4, section 4.9.2, table 4-25, page 100
],
'replace_sm':[ # SMPP v3.4, section 4.10.1, table 4-26, page 102-103
{'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
{'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
{'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'map':None}
],
'replace_sm_resp':[ # SMPP v3.4, section 4.10.2, table 4-27, page 104
],
'enquire_link':[ # SMPP v3.4, section 4.11.1, table 4-28, page 106
],
'enquire_link_resp':[ # SMPP v3.4, section 4.11.2, table 4-29, page 106
],
'alert_notification':[ # SMPP v3.4, section 4.12.1, table 4-30, page 108
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'esme_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'esme_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'esme_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
]
}
def mandatory_parameter_list_by_command_name(command_name):
return mandatory_parameter_lists.get(command_name,[])
# Command IDs - SMPP v3.4, section 5.1.2.1, table 5-1, page 110-111
command_id_by_hex = {
'80000000':{'hex':'80000000', 'name':'generic_nack'},
'00000001':{'hex':'00000001', 'name':'bind_receiver'},
'80000001':{'hex':'80000001', 'name':'bind_receiver_resp'},
'00000002':{'hex':'00000002', 'name':'bind_transmitter'},
'80000002':{'hex':'80000002', 'name':'bind_transmitter_resp'},
'00000003':{'hex':'00000003', 'name':'query_sm'},
'80000003':{'hex':'80000003', 'name':'query_sm_resp'},
'00000004':{'hex':'00000004', 'name':'submit_sm'},
'80000004':{'hex':'80000004', 'name':'submit_sm_resp'},
'00000005':{'hex':'00000005', 'name':'deliver_sm'},
'80000005':{'hex':'80000005', 'name':'deliver_sm_resp'},
'00000006':{'hex':'00000006', 'name':'unbind'},
'80000006':{'hex':'80000006', 'name':'unbind_resp'},
'00000007':{'hex':'00000007', 'name':'replace_sm'},
'80000007':{'hex':'80000007', 'name':'replace_sm_resp'},
'00000008':{'hex':'00000008', 'name':'cancel_sm'},
'80000008':{'hex':'80000008', 'name':'cancel_sm_resp'},
'00000009':{'hex':'00000009', 'name':'bind_transceiver'},
'80000009':{'hex':'80000009', 'name':'bind_transceiver_resp'},
'0000000b':{'hex':'0000000b', 'name':'outbind'},
'00000015':{'hex':'00000015', 'name':'enquire_link'},
'80000015':{'hex':'80000015', 'name':'enquire_link_resp'},
'00000021':{'hex':'00000021', 'name':'submit_multi'},
'80000021':{'hex':'80000021', 'name':'submit_multi_resp'},
'00000102':{'hex':'00000102', 'name':'alert_notification'},
'00000103':{'hex':'00000103', 'name':'data_sm'},
'80000103':{'hex':'80000103', 'name':'data_sm_resp'},
# v4 codes
'80010000':{'hex':'80010000', 'name':'generic_nack_v4'},
'00010001':{'hex':'00010001', 'name':'bind_receiver_v4'},
'80010001':{'hex':'80010001', 'name':'bind_receiver_resp_v4'},
'00010002':{'hex':'00010002', 'name':'bind_transmitter_v4'},
'80010002':{'hex':'80010002', 'name':'bind_transmitter_resp_v4'},
'00010003':{'hex':'00010003', 'name':'query_sm_v4'},
'80010003':{'hex':'80010003', 'name':'query_sm_resp_v4'},
'00010004':{'hex':'00010004', 'name':'submit_sm_v4'},
'80010004':{'hex':'80010004', 'name':'submit_sm_resp_v4'},
'00010005':{'hex':'00010005', 'name':'deliver_sm_v4'},
'80010005':{'hex':'80010005', 'name':'deliver_sm_resp_v4'},
'00010006':{'hex':'00010006', 'name':'unbind_v4'},
'80010006':{'hex':'80010006', 'name':'unbind_resp_v4'},
'00010007':{'hex':'00010007', 'name':'replace_sm_v4'},
'80010007':{'hex':'80010007', 'name':'replace_sm_resp_v4'},
'00010008':{'hex':'00010008', 'name':'cancel_sm_v4'},
'80010008':{'hex':'80010008', 'name':'cancel_sm_resp_v4'},
'00010009':{'hex':'00010009', 'name':'delivery_receipt_v4'},
'80010009':{'hex':'80010009', 'name':'delivery_receipt_resp_v4'},
'0001000a':{'hex':'0001000a', 'name':'enquire_link_v4'},
'8001000a':{'hex':'8001000a', 'name':'enquire_link_resp_v4'},
'0001000b':{'hex':'0001000b', 'name':'outbind_v4'},
}
def command_id_name_by_hex(x):
return command_id_by_hex.get(x,{}).get('name')
command_id_by_name = {
'generic_nack' :{'hex':'80000000', 'name':'generic_nack'},
'bind_receiver' :{'hex':'00000001', 'name':'bind_receiver'},
'bind_receiver_resp' :{'hex':'80000001', 'name':'bind_receiver_resp'},
'bind_transmitter' :{'hex':'00000002', 'name':'bind_transmitter'},
'bind_transmitter_resp' :{'hex':'80000002', 'name':'bind_transmitter_resp'},
'query_sm' :{'hex':'00000003', 'name':'query_sm'},
'query_sm_resp' :{'hex':'80000003', 'name':'query_sm_resp'},
'submit_sm' :{'hex':'00000004', 'name':'submit_sm'},
'submit_sm_resp' :{'hex':'80000004', 'name':'submit_sm_resp'},
'deliver_sm' :{'hex':'00000005', 'name':'deliver_sm'},
'deliver_sm_resp' :{'hex':'80000005', 'name':'deliver_sm_resp'},
'unbind' :{'hex':'00000006', 'name':'unbind'},
'unbind_resp' :{'hex':'80000006', 'name':'unbind_resp'},
'replace_sm' :{'hex':'00000007', 'name':'replace_sm'},
'replace_sm_resp' :{'hex':'80000007', 'name':'replace_sm_resp'},
'cancel_sm' :{'hex':'00000008', 'name':'cancel_sm'},
'cancel_sm_resp' :{'hex':'80000008', 'name':'cancel_sm_resp'},
'bind_transceiver' :{'hex':'00000009', 'name':'bind_transceiver'},
'bind_transceiver_resp' :{'hex':'80000009', 'name':'bind_transceiver_resp'},
'outbind' :{'hex':'0000000b', 'name':'outbind'},
'enquire_link' :{'hex':'00000015', 'name':'enquire_link'},
'enquire_link_resp' :{'hex':'80000015', 'name':'enquire_link_resp'},
'submit_multi' :{'hex':'00000021', 'name':'submit_multi'},
'submit_multi_resp' :{'hex':'80000021', 'name':'submit_multi_resp'},
'alert_notification' :{'hex':'00000102', 'name':'alert_notification'},
'data_sm' :{'hex':'00000103', 'name':'data_sm'},
'data_sm_resp' :{'hex':'80000103', 'name':'data_sm_resp'},
# v4 codes
'generic_nack_v4' :{'hex':'80010000', 'name':'generic_nack_v4'},
'bind_receiver_v4' :{'hex':'00010001', 'name':'bind_receiver_v4'},
'bind_receiver_resp_v4' :{'hex':'80010001', 'name':'bind_receiver_resp_v4'},
'bind_transmitter_v4' :{'hex':'00010002', 'name':'bind_transmitter_v4'},
'bind_transmitter_resp_v4':{'hex':'80010002', 'name':'bind_transmitter_resp_v4'},
'query_sm_v4' :{'hex':'00010003', 'name':'query_sm_v4'},
'query_sm_resp_v4' :{'hex':'80010003', 'name':'query_sm_resp_v4'},
'submit_sm_v4' :{'hex':'00010004', 'name':'submit_sm_v4'},
'submit_sm_resp_v4' :{'hex':'80010004', 'name':'submit_sm_resp_v4'},
'deliver_sm_v4' :{'hex':'00010005', 'name':'deliver_sm_v4'},
'deliver_sm_resp_v4' :{'hex':'80010005', 'name':'deliver_sm_resp_v4'},
'unbind_v4' :{'hex':'00010006', 'name':'unbind_v4'},
'unbind_resp_v4' :{'hex':'80010006', 'name':'unbind_resp_v4'},
'replace_sm_v4' :{'hex':'00010007', 'name':'replace_sm_v4'},
'replace_sm_resp_v4' :{'hex':'80010007', 'name':'replace_sm_resp_v4'},
'cancel_sm_v4' :{'hex':'00010008', 'name':'cancel_sm_v4'},
'cancel_sm_resp_v4' :{'hex':'80010008', 'name':'cancel_sm_resp_v4'},
'delivery_receipt_v4' :{'hex':'00010009', 'name':'delivery_receipt_v4'},
'delivery_receipt_resp_v4':{'hex':'80010009', 'name':'delivery_receipt_resp_v4'},
'enquire_link_v4' :{'hex':'0001000a', 'name':'enquire_link_v4'},
'enquire_link_resp_v4' :{'hex':'8001000a', 'name':'enquire_link_resp_v4'},
'outbind_v4' :{'hex':'0001000b', 'name':'outbind_v4'}
}
def command_id_hex_by_name(n):
return command_id_by_name.get(n,{}).get('hex')
# SMPP Error Codes (ESME) - SMPP v3.4, section 5.1.3, table 5-2, page 112-114
command_status_by_hex = {
'00000000':{'hex':'00000000', 'name':'ESME_ROK', 'description':'No error'},
'00000001':{'hex':'00000001', 'name':'ESME_RINVMSGLEN', 'description':'Message Length is invalid'},
'00000002':{'hex':'00000002', 'name':'ESME_RINVCMDLEN', 'description':'Command Length is invalid'},
'00000003':{'hex':'00000003', 'name':'ESME_RINVCMDID', 'description':'Invalid Command ID'},
'00000004':{'hex':'00000004', 'name':'ESME_RINVBNDSTS', 'description':'Incorrect BIND Status for given command'},
'00000005':{'hex':'00000005', 'name':'ESME_RALYBND', 'description':'ESME Already in bound state'},
'00000006':{'hex':'00000006', 'name':'ESME_RINVPRTFLG', 'description':'Invalid priority flag'},
'00000007':{'hex':'00000007', 'name':'ESME_RINVREGDLVFLG', 'description':'Invalid registered delivery flag'},
'00000008':{'hex':'00000008', 'name':'ESME_RSYSERR', 'description':'System Error'},
'0000000a':{'hex':'0000000a', 'name':'ESME_RINVSRCADR', 'description':'Invalid source address'},
'0000000b':{'hex':'0000000b', 'name':'ESME_RINVDSTADR', 'description':'Invalid destination address'},
'0000000c':{'hex':'0000000c', 'name':'ESME_RINVMSGID', 'description':'Message ID is invalid'},
'0000000d':{'hex':'0000000d', 'name':'ESME_RBINDFAIL', 'description':'Bind failed'},
'0000000e':{'hex':'0000000e', 'name':'ESME_RINVPASWD', 'description':'Invalid password'},
'0000000f':{'hex':'0000000f', 'name':'ESME_RINVSYSID', 'description':'Invalid System ID'},
'00000011':{'hex':'00000011', 'name':'ESME_RCANCELFAIL', 'description':'Cancel SM Failed'},
'00000013':{'hex':'00000013', 'name':'ESME_RREPLACEFAIL', 'description':'Replace SM Failed'},
'00000014':{'hex':'00000014', 'name':'ESME_RMSGQFUL', 'description':'Message queue full'},
'00000015':{'hex':'00000015', 'name':'ESME_RINVSERTYP', 'description':'Invalid service type'},
'00000033':{'hex':'00000033', 'name':'ESME_RINVNUMDESTS', 'description':'Invalid number of destinations'},
'00000034':{'hex':'00000034', 'name':'ESME_RINVDLNAME', 'description':'Invalid distribution list name'},
'00000040':{'hex':'00000040', 'name':'ESME_RINVDESTFLAG', 'description':'Destination flag is invalid (submit_multi)'},
'00000042':{'hex':'00000042', 'name':'ESME_RINVSUBREP', 'description':"Invalid `submit with replace' request (i.e. submit_sm with replace_if_present_flag set)"},
'00000043':{'hex':'00000043', 'name':'ESME_RINVESMCLASS', 'description':'Invalid esm_class field data'},
'00000044':{'hex':'00000044', 'name':'ESME_RCNTSUBDL', 'description':'Cannot submit to distribution list'},
'00000045':{'hex':'00000045', 'name':'ESME_RSUBMITFAIL', 'description':'submit_sm or submit_multi failed'},
'00000048':{'hex':'00000048', 'name':'ESME_RINVSRCTON', 'description':'Invalid source address TON'},
'00000049':{'hex':'00000049', 'name':'ESME_RINVSRCNPI', 'description':'Invalid source address NPI'},
'00000050':{'hex':'00000050', 'name':'ESME_RINVDSTTON', 'description':'Invalid destination address TON'},
'00000051':{'hex':'00000051', 'name':'ESME_RINVDSTNPI', 'description':'Invalid destination address NPI'},
'00000053':{'hex':'00000053', 'name':'ESME_RINVSYSTYP', 'description':'Invalid system_type field'},
'00000054':{'hex':'00000054', 'name':'ESME_RINVREPFLAG', 'description':'Invalid replace_if_present flag'},
'00000055':{'hex':'00000055', 'name':'ESME_RINVNUMMSGS', 'description':'Invalid number of messages'},
'00000058':{'hex':'00000058', 'name':'ESME_RTHROTTLED', 'description':'Throttling error (ESME has exceeded allowed message limits)'},
'00000061':{'hex':'00000061', 'name':'ESME_RINVSCHED', 'description':'Invalid scheduled delivery time'},
'00000062':{'hex':'00000062', 'name':'ESME_RINVEXPIRY', 'description':'Invalid message validity period (expiry time)'},
'00000063':{'hex':'00000063', 'name':'ESME_RINVDFTMSGID', 'description':'Predefined message invalid or not found'},
'00000064':{'hex':'00000064', 'name':'ESME_RX_T_APPN', 'description':'ESME Receiver Temporary App Error Code'},
'00000065':{'hex':'00000065', 'name':'ESME_RX_P_APPN', 'description':'ESME Receiver Permanent App Error Code'},
'00000066':{'hex':'00000066', 'name':'ESME_RX_R_APPN', 'description':'ESME Receiver Reject Message Error Code'},
'00000067':{'hex':'00000067', 'name':'ESME_RQUERYFAIL', 'description':'query_sm request failed'},
'000000c0':{'hex':'000000c0', 'name':'ESME_RINVOPTPARSTREAM', 'description':'Error in the optional part of the PDU Body'},
'000000c1':{'hex':'000000c1', 'name':'ESME_ROPTPARNOTALLWD', 'description':'Optional paramenter not allowed'},
'000000c2':{'hex':'000000c2', 'name':'ESME_RINVPARLEN', 'description':'Invalid parameter length'},
'000000c3':{'hex':'000000c3', 'name':'ESME_RMISSINGOPTPARAM', 'description':'Expected optional parameter missing'},
'000000c4':{'hex':'000000c4', 'name':'ESME_RINVOPTPARAMVAL', 'description':'Invalid optional parameter value'},
'000000fe':{'hex':'000000fe', 'name':'ESME_RDELIVERYFAILURE', 'description':'Delivery Failure (used for data_sm_resp)'},
'000000ff':{'hex':'000000ff', 'name':'ESME_RUNKNOWNERR', 'description':'Unknown error'}
}
def command_status_name_by_hex(x):
return command_status_by_hex.get(x,{}).get('name')
command_status_by_name = {
'ESME_ROK' :{'hex':'00000000', 'name':'ESME_ROK', 'description':'No error'},
'ESME_RINVMSGLEN' :{'hex':'00000001', 'name':'ESME_RINVMSGLEN', 'description':'Message Length is invalid'},
'ESME_RINVCMDLEN' :{'hex':'00000002', 'name':'ESME_RINVCMDLEN', 'description':'Command Length is invalid'},
'ESME_RINVCMDID' :{'hex':'00000003', 'name':'ESME_RINVCMDID', 'description':'Invalid Command ID'},
'ESME_RINVBNDSTS' :{'hex':'00000004', 'name':'ESME_RINVBNDSTS', 'description':'Incorrect BIND Status for given command'},
'ESME_RALYBND' :{'hex':'00000005', 'name':'ESME_RALYBND', 'description':'ESME Already in bound state'},
'ESME_RINVPRTFLG' :{'hex':'00000006', 'name':'ESME_RINVPRTFLG', 'description':'Invalid priority flag'},
'ESME_RINVREGDLVFLG' :{'hex':'00000007', 'name':'ESME_RINVREGDLVFLG', 'description':'Invalid registered delivery flag'},
'ESME_RSYSERR' :{'hex':'00000008', 'name':'ESME_RSYSERR', 'description':'System Error'},
'ESME_RINVSRCADR' :{'hex':'0000000a', 'name':'ESME_RINVSRCADR', 'description':'Invalid source address'},
'ESME_RINVDSTADR' :{'hex':'0000000b', 'name':'ESME_RINVDSTADR', 'description':'Invalid destination address'},
'ESME_RINVMSGID' :{'hex':'0000000c', 'name':'ESME_RINVMSGID', 'description':'Message ID is invalid'},
'ESME_RBINDFAIL' :{'hex':'0000000d', 'name':'ESME_RBINDFAIL', 'description':'Bind failed'},
'ESME_RINVPASWD' :{'hex':'0000000e', 'name':'ESME_RINVPASWD', 'description':'Invalid password'},
'ESME_RINVSYSID' :{'hex':'0000000f', 'name':'ESME_RINVSYSID', 'description':'Invalid System ID'},
'ESME_RCANCELFAIL' :{'hex':'00000011', 'name':'ESME_RCANCELFAIL', 'description':'Cancel SM Failed'},
'ESME_RREPLACEFAIL' :{'hex':'00000013', 'name':'ESME_RREPLACEFAIL', 'description':'Replace SM Failed'},
'ESME_RMSGQFUL' :{'hex':'00000014', 'name':'ESME_RMSGQFUL', 'description':'Message queue full'},
'ESME_RINVSERTYP' :{'hex':'00000015', 'name':'ESME_RINVSERTYP', 'description':'Invalid service type'},
'ESME_RINVNUMDESTS' :{'hex':'00000033', 'name':'ESME_RINVNUMDESTS', 'description':'Invalid number of destinations'},
'ESME_RINVDLNAME' :{'hex':'00000034', 'name':'ESME_RINVDLNAME', 'description':'Invalid distribution list name'},
'ESME_RINVDESTFLAG' :{'hex':'00000040', 'name':'ESME_RINVDESTFLAG', 'description':'Destination flag is invalid (submit_multi)'},
'ESME_RINVSUBREP' :{'hex':'00000042', 'name':'ESME_RINVSUBREP', 'description':"Invalid `submit with replace' request (i.e. submit_sm with replace_if_present_flag set)"},
'ESME_RINVESMCLASS' :{'hex':'00000043', 'name':'ESME_RINVESMCLASS', 'description':'Invalid esm_class field data'},
'ESME_RCNTSUBDL' :{'hex':'00000044', 'name':'ESME_RCNTSUBDL', 'description':'Cannot submit to distribution list'},
'ESME_RSUBMITFAIL' :{'hex':'00000045', 'name':'ESME_RSUBMITFAIL', 'description':'submit_sm or submit_multi failed'},
'ESME_RINVSRCTON' :{'hex':'00000048', 'name':'ESME_RINVSRCTON', 'description':'Invalid source address TON'},
'ESME_RINVSRCNPI' :{'hex':'00000049', 'name':'ESME_RINVSRCNPI', 'description':'Invalid source address NPI'},
'ESME_RINVDSTTON' :{'hex':'00000050', 'name':'ESME_RINVDSTTON', 'description':'Invalid destination address TON'},
'ESME_RINVDSTNPI' :{'hex':'00000051', 'name':'ESME_RINVDSTNPI', 'description':'Invalid destination address NPI'},
'ESME_RINVSYSTYP' :{'hex':'00000053', 'name':'ESME_RINVSYSTYP', 'description':'Invalid system_type field'},
'ESME_RINVREPFLAG' :{'hex':'00000054', 'name':'ESME_RINVREPFLAG', 'description':'Invalid replace_if_present flag'},
'ESME_RINVNUMMSGS' :{'hex':'00000055', 'name':'ESME_RINVNUMMSGS', 'description':'Invalid number of messages'},
'ESME_RTHROTTLED' :{'hex':'00000058', 'name':'ESME_RTHROTTLED', 'description':'Throttling error (ESME has exceeded allowed message limits)'},
'ESME_RINVSCHED' :{'hex':'00000061', 'name':'ESME_RINVSCHED', 'description':'Invalid scheduled delivery time'},
'ESME_RINVEXPIRY' :{'hex':'00000062', 'name':'ESME_RINVEXPIRY', 'description':'Invalid message validity period (expiry time)'},
'ESME_RINVDFTMSGID' :{'hex':'00000063', 'name':'ESME_RINVDFTMSGID', 'description':'Predefined message invalid or not found'},
'ESME_RX_T_APPN' :{'hex':'00000064', 'name':'ESME_RX_T_APPN', 'description':'ESME Receiver Temporary App Error Code'},
'ESME_RX_P_APPN' :{'hex':'00000065', 'name':'ESME_RX_P_APPN', 'description':'ESME Receiver Permanent App Error Code'},
'ESME_RX_R_APPN' :{'hex':'00000066', 'name':'ESME_RX_R_APPN', 'description':'ESME Receiver Reject Message Error Code'},
'ESME_RQUERYFAIL' :{'hex':'00000067', 'name':'ESME_RQUERYFAIL', 'description':'query_sm request failed'},
'ESME_RINVOPTPARSTREAM':{'hex':'000000c0', 'name':'ESME_RINVOPTPARSTREAM', 'description':'Error in the optional part of the PDU Body'},
'ESME_ROPTPARNOTALLWD' :{'hex':'000000c1', 'name':'ESME_ROPTPARNOTALLWD', 'description':'Optional paramenter not allowed'},
'ESME_RINVPARLEN' :{'hex':'000000c2', 'name':'ESME_RINVPARLEN', 'description':'Invalid parameter length'},
'ESME_RMISSINGOPTPARAM':{'hex':'000000c3', 'name':'ESME_RMISSINGOPTPARAM', 'description':'Expected optional parameter missing'},
'ESME_RINVOPTPARAMVAL' :{'hex':'000000c4', 'name':'ESME_RINVOPTPARAMVAL', 'description':'Invalid optional parameter value'},
'ESME_RDELIVERYFAILURE':{'hex':'000000fe', 'name':'ESME_RDELIVERYFAILURE', 'description':'Delivery Failure (used for data_sm_resp)'},
'ESME_RUNKNOWNERR' :{'hex':'000000ff', 'name':'ESME_RUNKNOWNERR', 'description':'Unknown error'}
}
def command_status_hex_by_name(n):
return command_status_by_name.get(n,{}).get('hex')
# Type of Number (TON) - SMPP v3.4, section 5.2.5, table 5-3, page 117
maps['addr_ton_by_name'] = {
'unknown' :'00',
'international' :'01',
'national' :'02',
'network_specific' :'03',
'subscriber_number':'04',
'alphanumeric' :'05',
'abbreviated' :'06'
}
maps['addr_ton_by_hex'] = {
'00':'unknown',
'01':'international',
'02':'national',
'03':'network_specific',
'04':'subscriber_number',
'05':'alphanumeric',
'06':'abbreviated'
}
# Numberic Plan Indicator (NPI) - SMPP v3.4, section 5.2.6, table 5-4, page 118
maps['addr_npi_by_name'] = {
'unknown' :'00',
'ISDN' :'01',
'data' :'03',
'telex' :'04',
'land_mobile':'06',
'national' :'08',
'private' :'09',
'ERMES' :'0a',
'internet' :'0e',
'WAP' :'12'
}
maps['addr_npi_by_hex'] = {
'00':'unknown',
'01':'ISDN',
'03':'data',
'04':'telex',
'06':'land_mobile',
'08':'national',
'09':'private',
'0a':'ERMES',
'0e':'internet',
'12':'WAP'
}
# ESM Class bits - SMPP v3.4, section 5.2.12, page 121
maps['esm_class_bits'] = {
'mode_mask' :'03',
'type_mask' :'3c',
'feature_mask' :'c0',
'mode_default' :'00',
'mode_datagram' :'01',
'mode_forward' :'02',
'mode_store_and_forward' :'03',
'type_default' :'00',
'type_delivery_receipt' :'04',
'type_delivery_ack' :'08',
'type_0011' :'0a',
'type_user_ack' :'10',
'type_0101' :'14',
'type_conversation_abort' :'18',
'type_0111' :'1a',
'type_intermed_deliv_notif' :'20',
'type_1001' :'24',
'type_1010' :'28',
'type_1011' :'2a',
'type_1100' :'30',
'type_1101' :'34',
'type_1110' :'38',
'type_1111' :'3a',
'feature_none' :'00',
'feature_UDHI' :'40',
'feature_reply_path' :'80',
'feature_UDHI_and_reply_path':'c0'
}
# Registered Delivery bits - SMPP v3.4, section 5.2.17, page 124
maps['registered_delivery_bits'] = {
'receipt_mask' :'03',
'ack_mask' :'0c',
'intermed_notif_mask' :'80',
'receipt_none' :'00',
'receipt_always' :'01',
'receipt_on_fail' :'02',
'receipt_res' :'03',
'ack_none' :'00',
'ack_delivery' :'04',
'ack_user' :'08',
'ack_delivery_and_user':'0c',
'intermed_notif_none' :'00',
'intermed_notif' :'10'
}
diff --git a/src/smpp/pdu_builder.py b/src/smpp/pdu_builder.py
index ec3fab9..5a95e32 100644
--- a/src/smpp/pdu_builder.py
+++ b/src/smpp/pdu_builder.py
@@ -1,223 +1,223 @@
from pdu import *
class PDU(object):
def __init__(self,
command_id,
command_status,
sequence_number,
**kwargs):
super(PDU, self).__init__()
self.obj = {}
header = {}
self.obj['header'] = header
header['command_length'] = 0
header['command_id'] = command_id
header['command_status'] = command_status
header['sequence_number'] = sequence_number
def __add_optional_parameter(self, tag, value):
optional_parameters = self.obj['body'].get('optional_parameters')
if optional_parameters == None:
optional_parameters = []
self.obj['body']['optional_parameters'] = optional_parameters
optional_parameters.append({
'tag':tag,
'length':0,
'value':value,
})
def get_obj(self):
return self.obj
def get_hex(self):
return encode_pdu(self.obj)
def get_bin(self):
return pack_pdu(self.obj)
class BindTransmitter(PDU):
def __init__(self,
sequence_number,
system_id = '',
password = '',
system_type = '',
- interface_version = '',
+ interface_version = '34',
addr_ton = 0,
addr_npi = 0,
address_range = '',
**kwargs):
super(BindTransmitter, self).__init__(
'bind_transmitter',
'ESME_ROK',
sequence_number,
)
body = {}
self.obj['body'] = body
mandatory_parameters = {}
body['mandatory_parameters'] = mandatory_parameters
mandatory_parameters['system_id'] = system_id
mandatory_parameters['password'] = password
mandatory_parameters['system_type'] = system_type
mandatory_parameters['interface_version'] = interface_version
mandatory_parameters['addr_ton'] = addr_ton
mandatory_parameters['addr_npi'] = addr_npi
mandatory_parameters['address_range'] = address_range
class Unbind(PDU):
def __init__(self,
sequence_number,
**kwargs):
super(Unbind, self).__init__(
'unbind',
'ESME_ROK',
sequence_number,
)
class SM1(PDU):
def __init__(self,
command_id,
sequence_number,
service_type = '',
source_addr_ton = 0,
source_addr_npi = 0,
source_addr = '',
esm_class = 0,
protocol_id = 0,
priority_flag = 0,
schedule_delivery_time = '',
validity_period = '',
registered_delivery = 0,
replace_if_present_flag = 0,
data_coding = 0,
sm_default_msg_id = 0,
sm_length = 0,
short_message = None,
**kwargs):
super(SM1, self).__init__(
command_id,
'ESME_ROK',
sequence_number,
)
body = {}
self.obj['body'] = body
mandatory_parameters = {}
body['mandatory_parameters'] = mandatory_parameters
mandatory_parameters['service_type'] = service_type
mandatory_parameters['source_addr_ton'] = source_addr_ton
mandatory_parameters['source_addr_npi'] = source_addr_npi
mandatory_parameters['source_addr'] = source_addr
mandatory_parameters['esm_class'] = esm_class
mandatory_parameters['protocol_id'] = protocol_id
mandatory_parameters['priority_flag'] = priority_flag
mandatory_parameters['schedule_delivery_time'] = schedule_delivery_time
mandatory_parameters['validity_period'] = validity_period
mandatory_parameters['registered_delivery'] = registered_delivery
mandatory_parameters['replace_if_present_flag'] = replace_if_present_flag
mandatory_parameters['data_coding'] = data_coding
mandatory_parameters['sm_default_msg_id'] = sm_default_msg_id
mandatory_parameters['sm_length'] = sm_length
mandatory_parameters['short_message'] = short_message
def add_message_payload(self, value):
self.obj['body']['mandatory_parameters']['sm_length'] = 0
self.obj['body']['mandatory_parameters']['short_message'] = None
self._PDU__add_optional_parameter('message_payload', value)
class SubmitMulti(SM1):
def __init__(self,
sequence_number,
number_of_dests = 0,
dest_address = [],
**kwargs):
super(SubmitMulti, self).__init__('submit_multi', sequence_number, **kwargs)
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['number_of_dests'] = number_of_dests
mandatory_parameters['dest_address'] = [] + dest_address
def addDestinationAddress(self,
destination_addr,
dest_addr_ton = 0,
dest_addr_npi = 0,
):
if isinstance(destination_addr, str) and len(destination_addr) > 0:
new_entry = {
'dest_flag':1,
'dest_addr_ton':dest_addr_ton,
'dest_addr_npi':dest_addr_npi,
'destination_addr':destination_addr,
}
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_address'].append(new_entry)
mandatory_parameters['number_of_dests'] = len(
mandatory_parameters['dest_address'])
return True
else:
return False
def addDistributionList(self,
dl_name,
):
if isinstance(dl_name, str) and len(dl_name) > 0:
new_entry = {
'dest_flag':2,
'dl_name':dl_name,
}
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_address'].append(new_entry)
mandatory_parameters['number_of_dests'] = len(
mandatory_parameters['dest_address'])
return True
else:
return False
class SM2(SM1):
def __init__(self,
command_id,
sequence_number,
dest_addr_ton = 0,
dest_addr_npi = 0,
destination_addr = '',
**kwargs):
super(SM2, self).__init__(command_id, sequence_number, **kwargs)
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_addr_ton'] = dest_addr_ton
mandatory_parameters['dest_addr_npi'] = dest_addr_npi
mandatory_parameters['destination_addr'] = destination_addr
class SubmitSM(SM2):
def __init__(self,
sequence_number,
**kwargs):
super(SubmitSM, self).__init__('submit_sm', sequence_number, **kwargs)
class DeliverSM(SM2):
def __init__(self,
sequence_number,
**kwargs):
super(DeliverSM, self).__init__('deliver_sm',sequence_number, **kwargs)
#bind = BindTransmitter(system_id='test_id', password='abc123')
#print bind.get_obj()
#print bind.get_hex()
#print bind.get_bin()
##print json.dumps(bind.get_obj(), indent=4, sort_keys=True)
##print json.dumps(decode_pdu(bind.get_hex()), indent=4, sort_keys=True)
#print json.dumps(unpack_pdu(bind.get_bin()), indent=4, sort_keys=True)
#sm = SubmitSM(short_message='testing testing')
#print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
#sm.add_message_payload('616263646566676869')
#print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
diff --git a/test/pdu.py b/test/pdu.py
index be771cf..97998ac 100644
--- a/test/pdu.py
+++ b/test/pdu.py
@@ -1,516 +1,516 @@
pdu_objects = [
{
'header': {
'command_length': 0,
'command_id': 'bind_transmitter',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'system_id':'test_system',
'password':'abc123',
'system_type':'',
- 'interface_version':'',
+ 'interface_version':'34',
'addr_ton':1,
'addr_npi':1,
'address_range':'',
},
},
},
{
'header': {
'command_length': 0,
'command_id': 'bind_transmitter_resp',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'system_id':'test_system',
},
},
},
{
'header': {
'command_length': 0,
'command_id': 'bind_receiver',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'system_id':'test_system',
'password':'abc123',
'system_type':'',
- 'interface_version':'',
+ 'interface_version':'34',
'addr_ton':1,
'addr_npi':1,
'address_range':'',
},
},
},
{
'header': {
'command_length': 0,
'command_id': 'bind_receiver_resp',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'system_id':'test_system',
},
},
},
{
'header': {
'command_length': 0,
'command_id': 'bind_transceiver',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'system_id':'test_system',
'password':'abc123',
'system_type':'',
- 'interface_version':'',
+ 'interface_version':'34',
'addr_ton':1,
'addr_npi':1,
'address_range':'',
},
},
},
{
'header': {
'command_length': 0,
'command_id': 'bind_transceiver_resp',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'system_id':'test_system',
},
},
},
{
'header': {
'command_length': 0,
'command_id': 'outbind',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'system_id':'test_system',
'password':'abc123',
},
},
},
{
'header': {
'command_length': 0,
'command_id': 'unbind',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
},
{
'header': {
'command_length': 0,
'command_id': 'unbind_resp',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
},
{
'header': {
'command_length': 0,
'command_id': 'generic_nack',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
},
{
'header': {
'command_length': 0,
'command_id': 'submit_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
'esm_class':0,
'protocol_id':0,
'priority_flag':0,
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
'sm_length':1,
'short_message':'testing 123',
},
},
},
{
'header': {
'command_length': 0,
'command_id': 'submit_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
'esm_class':0,
'protocol_id':0,
'priority_flag':0,
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
'sm_length':0,
'short_message':None,
# 'short_message' can be of zero length
},
'optional_parameters': [
{
'tag':'message_payload',
'length':0,
'value':'5666',
},
],
},
},
#]
#breaker = [
{
'header': {
'command_length': 0,
'command_id': 'submit_sm_resp',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'message_id':'',
},
},
},
{
'header': {
'command_length': 0,
'command_id': 'submit_sm_resp',
'command_status': 'ESME_RSYSERR',
'sequence_number': 0,
},
# submit_sm_resp can have no body for failures
},
{
'header': {
'command_length': 0,
'command_id': 'submit_multi',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'number_of_dests':0,
'dest_address':[
{
'dest_flag':1,
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'the address'
},
{
'dest_flag':2,
'dl_name':'the list',
},
{
'dest_flag':2,
'dl_name':'the other list',
},
#{}
],
'esm_class':0,
'protocol_id':0,
'priority_flag':0,
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
'sm_length':1,
'short_message':'testing 123',
},
},
},
{
'header': {
'command_length': 0,
'command_id': 'submit_multi_resp',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'message_id':'',
'no_unsuccess':5,
'unsuccess_sme':[
{
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
'error_status_code':0,
},
{
'dest_addr_ton':3,
'dest_addr_npi':1,
'destination_addr':'555',
'error_status_code':0,
},
],
},
},
},
#]
#breaker = [
{
'header': {
'command_length': 0,
'command_id': 'deliver_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
'esm_class':0,
'protocol_id':0,
'priority_flag':0,
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
'sm_length':1,
'short_message':'',
},
},
},
{
'header': {
'command_length': 0,
'command_id': 'deliver_sm_resp',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'message_id':'',
},
},
},
{
'header': {
'command_length': 0,
'command_id': 'data_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
'esm_class':0,
'registered_delivery':0,
'data_coding':0,
},
'optional_parameters': [
{
'tag':'message_payload',
'length':0,
'value':'',
},
],
},
},
{
'header': {
'command_length': 0,
'command_id': 'data_sm_resp',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'message_id':'',
},
},
},
{
'header': {
'command_length': 0,
'command_id': 'query_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'message_id':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
},
},
},
{
'header': {
'command_length': 0,
'command_id': 'query_sm_resp',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'message_id':'',
'final_date':'',
'message_state':0,
'error_code':0,
},
},
},
{
'header': {
'command_length': 0,
'command_id': 'cancel_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'message_id':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
},
},
},
{
'header': {
'command_length': 0,
'command_id': 'cancel_sm_resp',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
},
{
'header': {
'command_length': 0,
'command_id': 'replace_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'message_id':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
'sm_length':1,
'short_message':'is this an = sign?',
},
},
},
{
'header': {
'command_length': 0,
'command_id': 'replace_sm_resp',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
},
{
'header': {
'command_length': 0,
'command_id': 'enquire_link',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
},
{
'header': {
'command_length': 0,
'command_id': 'enquire_link_resp',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
},
{
'header': {
'command_length': 0,
'command_id': 'alert_notification',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'source_addr_ton':'international',
'source_addr_npi':1,
'source_addr':'',
'esme_addr_ton':9,
'esme_addr_npi':'',
'esme_addr':'',
},
},
},
]
diff --git a/test/pdu_asserts.py b/test/pdu_asserts.py
index 75d3891..faa0705 100644
--- a/test/pdu_asserts.py
+++ b/test/pdu_asserts.py
@@ -1,563 +1,563 @@
########################################
pdu_json_0000000001 = '''{
"body": {
"mandatory_parameters": {
"addr_npi": "ISDN",
"addr_ton": "international",
"address_range": "",
- "interface_version": "",
+ "interface_version": "34",
"password": "abc123",
"system_id": "test_system",
"system_type": ""
}
},
"header": {
"command_id": "bind_transmitter",
"command_length": 40,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000002 = '''{
"body": {
"mandatory_parameters": {
"system_id": "test_system"
}
},
"header": {
"command_id": "bind_transmitter_resp",
"command_length": 28,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000003 = '''{
"body": {
"mandatory_parameters": {
"addr_npi": "ISDN",
"addr_ton": "international",
"address_range": "",
- "interface_version": "",
+ "interface_version": "34",
"password": "abc123",
"system_id": "test_system",
"system_type": ""
}
},
"header": {
"command_id": "bind_receiver",
"command_length": 40,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000004 = '''{
"body": {
"mandatory_parameters": {
"system_id": "test_system"
}
},
"header": {
"command_id": "bind_receiver_resp",
"command_length": 28,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000005 = '''{
"body": {
"mandatory_parameters": {
"addr_npi": "ISDN",
"addr_ton": "international",
"address_range": "",
- "interface_version": "",
+ "interface_version": "34",
"password": "abc123",
"system_id": "test_system",
"system_type": ""
}
},
"header": {
"command_id": "bind_transceiver",
"command_length": 40,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000006 = '''{
"body": {
"mandatory_parameters": {
"system_id": "test_system"
}
},
"header": {
"command_id": "bind_transceiver_resp",
"command_length": 28,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000007 = '''{
"body": {
"mandatory_parameters": {
"password": "abc123",
"system_id": "test_system"
}
},
"header": {
"command_id": "outbind",
"command_length": 35,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000008 = '''{
"header": {
"command_id": "unbind",
"command_length": 16,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000009 = '''{
"header": {
"command_id": "unbind_resp",
"command_length": 16,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000010 = '''{
"header": {
"command_id": "generic_nack",
"command_length": 16,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000011 = '''{
"body": {
"mandatory_parameters": {
"data_coding": 0,
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "",
"esm_class": 0,
"priority_flag": 0,
"protocol_id": 0,
"registered_delivery": 0,
"replace_if_present_flag": 0,
"schedule_delivery_time": "",
"service_type": "",
"short_message": "testing 123",
"sm_default_msg_id": 0,
"sm_length": 12,
"source_addr": "",
"source_addr_npi": "ISDN",
"source_addr_ton": "international",
"validity_period": ""
}
},
"header": {
"command_id": "submit_sm",
"command_length": 45,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000012 = '''{
"body": {
"mandatory_parameters": {
"data_coding": 0,
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "",
"esm_class": 0,
"priority_flag": 0,
"protocol_id": 0,
"registered_delivery": 0,
"replace_if_present_flag": 0,
"schedule_delivery_time": "",
"service_type": "",
"short_message": null,
"sm_default_msg_id": 0,
"sm_length": 0,
"source_addr": "",
"source_addr_npi": "ISDN",
"source_addr_ton": "international",
"validity_period": ""
},
"optional_parameters": [
{
"length": 2,
"tag": "message_payload",
"value": "5666"
}
]
},
"header": {
"command_id": "submit_sm",
"command_length": 39,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000013 = '''{
"body": {
"mandatory_parameters": {
"message_id": ""
}
},
"header": {
"command_id": "submit_sm_resp",
"command_length": 17,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000014 = '''{
"header": {
"command_id": "submit_sm_resp",
"command_length": 16,
"command_status": "ESME_RSYSERR",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000015 = '''{
"body": {
"mandatory_parameters": {
"data_coding": 0,
"dest_address": [
{
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"dest_flag": 1,
"destination_addr": "the address"
},
{
"dest_flag": 2,
"dl_name": "the list"
},
{
"dest_flag": 2,
"dl_name": "the other list"
}
],
"esm_class": 0,
"number_of_dests": 3,
"priority_flag": 0,
"protocol_id": 0,
"registered_delivery": 0,
"replace_if_present_flag": 0,
"schedule_delivery_time": "",
"service_type": "",
"short_message": "testing 123",
"sm_default_msg_id": 0,
"sm_length": 12,
"source_addr": "",
"source_addr_npi": "ISDN",
"source_addr_ton": "international",
"validity_period": ""
}
},
"header": {
"command_id": "submit_multi",
"command_length": 84,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000016 = '''{
"body": {
"mandatory_parameters": {
"message_id": "",
"no_unsuccess": 2,
"unsuccess_sme": [
{
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "",
"error_status_code": 0
},
{
"dest_addr_npi": "ISDN",
"dest_addr_ton": "network_specific",
"destination_addr": "555",
"error_status_code": 0
}
]
}
},
"header": {
"command_id": "submit_multi_resp",
"command_length": 35,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000017 = '''{
"body": {
"mandatory_parameters": {
"data_coding": 0,
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "",
"esm_class": 0,
"priority_flag": 0,
"protocol_id": 0,
"registered_delivery": 0,
"replace_if_present_flag": 0,
"schedule_delivery_time": "",
"service_type": "",
"short_message": "",
"sm_default_msg_id": 0,
"sm_length": 1,
"source_addr": "",
"source_addr_npi": "ISDN",
"source_addr_ton": "international",
"validity_period": ""
}
},
"header": {
"command_id": "deliver_sm",
"command_length": 34,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000018 = '''{
"body": {
"mandatory_parameters": {
"message_id": ""
}
},
"header": {
"command_id": "deliver_sm_resp",
"command_length": 17,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000019 = '''{
"body": {
"mandatory_parameters": {
"data_coding": 0,
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "",
"esm_class": 0,
"registered_delivery": 0,
"service_type": "",
"source_addr": "",
"source_addr_npi": "ISDN",
"source_addr_ton": "international"
},
"optional_parameters": [
{
"length": 0,
"tag": "message_payload",
"value": null
}
]
},
"header": {
"command_id": "data_sm",
"command_length": 30,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000020 = '''{
"body": {
"mandatory_parameters": {
"message_id": ""
}
},
"header": {
"command_id": "data_sm_resp",
"command_length": 17,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000021 = '''{
"body": {
"mandatory_parameters": {
"message_id": "",
"source_addr": "",
"source_addr_npi": "ISDN",
"source_addr_ton": "international"
}
},
"header": {
"command_id": "query_sm",
"command_length": 20,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000022 = '''{
"body": {
"mandatory_parameters": {
"error_code": 0,
"final_date": "",
"message_id": "",
"message_state": 0
}
},
"header": {
"command_id": "query_sm_resp",
"command_length": 20,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000023 = '''{
"body": {
"mandatory_parameters": {
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "",
"message_id": "",
"service_type": "",
"source_addr": "",
"source_addr_npi": "ISDN",
"source_addr_ton": "international"
}
},
"header": {
"command_id": "cancel_sm",
"command_length": 24,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000024 = '''{
"header": {
"command_id": "cancel_sm_resp",
"command_length": 16,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000025 = '''{
"body": {
"mandatory_parameters": {
"data_coding": 0,
"message_id": "",
"registered_delivery": 0,
"replace_if_present_flag": 0,
"schedule_delivery_time": "",
"short_message": "is this an = sign?",
"sm_default_msg_id": 0,
"sm_length": 19,
"source_addr": "",
"source_addr_npi": "ISDN",
"source_addr_ton": "international",
"validity_period": ""
}
},
"header": {
"command_id": "replace_sm",
"command_length": 46,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000026 = '''{
"header": {
"command_id": "replace_sm_resp",
"command_length": 16,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000027 = '''{
"header": {
"command_id": "enquire_link",
"command_length": 16,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000028 = '''{
"header": {
"command_id": "enquire_link_resp",
"command_length": 16,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000029 = '''{
"body": {
"mandatory_parameters": {
"esme_addr": "",
"esme_addr_npi": "unknown",
"esme_addr_ton": 9,
"source_addr": "",
"source_addr_npi": "ISDN",
"source_addr_ton": "international"
}
},
"header": {
"command_id": "alert_notification",
"command_length": 22,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
|
dmaclay/python-smpp
|
80e80227fe17ebb82de2712e50672c8b6dabdaca
|
better default behavioir
|
diff --git a/src/smpp/esme.py b/src/smpp/esme.py
index e991af4..21d6c2d 100644
--- a/src/smpp/esme.py
+++ b/src/smpp/esme.py
@@ -1,126 +1,126 @@
import socket
from pdu_builder import *
class ESME(object):
def __init__(self):
self.state = 'CLOSED'
self.sequence_number = 1
self.conn = None
- self.system_id = None
- self.password = None
- self.defaults = {}
+ self.defaults = {
+ 'host':'127.0.0.1',
+ 'port':2775,
+ 'dest_addr_ton':0,
+ 'dest_addr_npi':0,
+ }
def loadDefaults(self, defaults):
self.defaults = dict(self.defaults, **defaults)
def connect(self):
if self.state in ['CLOSED']:
self.conn = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
- self.conn.connect((
- self.defaults.get('host', '127.0.0.1'),
- self.defaults.get('port', 2775),
- ))
+ self.conn.connect((self.defaults['host'], self.defaults['port']))
self.state = 'OPEN'
def disconnect(self):
if self.state in ['BOUND_TX', 'BOUND_RX', 'BOUND_TRX']:
self.__unbind()
if self.state in ['OPEN']:
self.conn.close()
self.state = 'CLOSED'
def __recv(self):
pdu = None
length_bin = self.conn.recv(4)
if not length_bin:
return None
else:
#print 'length_bin', len(length_bin), length_bin
if len(length_bin) == 4:
length = int(binascii.b2a_hex(length_bin),16)
rest_bin = self.conn.recv(length-4)
pdu = unpack_pdu(length_bin + rest_bin)
print '...', pdu['header']['sequence_number'],
print '>', pdu['header']['command_id'],
print '...', pdu['header']['command_status']
return pdu
def __is_ok(self, pdu, id_check=None):
if (isinstance(pdu, dict)
and pdu.get('header',{}).get('command_status') == 'ESME_ROK'
and (id_check == None
or id_check == pdu['header'].get('command_id'))):
return True
else:
return False
def bind_transmitter(self):
if self.state in ['CLOSED']:
self.connect()
if self.state in ['OPEN']:
pdu = BindTransmitter(self.sequence_number, **self.defaults)
self.conn.send(pdu.get_bin())
self.sequence_number +=1
if self.__is_ok(self.__recv(), 'bind_transmitter_resp'):
self.state = 'BOUND_TX'
def __unbind(self):
if self.state in ['BOUND_TX', 'BOUND_RX', 'BOUND_TRX']:
pdu = Unbind(self.sequence_number)
self.conn.send(pdu.get_bin())
self.sequence_number +=1
if self.__is_ok(self.__recv(), 'unbind_resp'):
self.state = 'OPEN'
#def unbind(self): # will probably be deprecated
#self.__unbind()
def submit_sm(self, **kwargs):
if self.state in ['BOUND_TX', 'BOUND_TRX']:
print dict(self.defaults, **kwargs)
pdu = SubmitSM(self.sequence_number, **dict(self.defaults, **kwargs))
self.conn.send(pdu.get_bin())
self.sequence_number +=1
submit_sm_resp = self.__recv()
#print self.__is_ok(submit_sm_resp, 'submit_sm_resp')
def submit_multi(self, dest_address=[], **kwargs):
if self.state in ['BOUND_TX', 'BOUND_TRX']:
pdu = SubmitMulti(self.sequence_number, **dict(self.defaults, **kwargs))
for item in dest_address:
if isinstance(item, str): # assume strings are addresses not lists
pdu.addDestinationAddress(
item,
- dest_addr_ton = self.defaults.get('dest_addr_ton', 0),
- dest_addr_npi = self.defaults.get('dest_addr_npi', 0),
+ dest_addr_ton = self.defaults['dest_addr_ton'],
+ dest_addr_npi = self.defaults['dest_addr_npi'],
)
elif isinstance(item, dict):
if item.get('dest_flag') == 1:
pdu.addDestinationAddress(
- item.get('destination_addr'),
+ item.get('destination_addr', ''),
dest_addr_ton = item.get('dest_addr_ton',
- self.defaults.get('dest_addr_ton', 0)),
+ self.defaults['dest_addr_ton']),
dest_addr_npi = item.get('dest_addr_npi',
- self.defaults.get('dest_addr_npi', 0)),
+ self.defaults['dest_addr_npi']),
)
elif item.get('dest_flag') == 2:
pdu.addDistributionList(item.get('dl_name'))
self.conn.send(pdu.get_bin())
self.sequence_number +=1
submit_multi_resp = self.__recv()
#print self.__is_ok(submit_multi_resp, 'submit_multi_resp')
diff --git a/tests.py b/tests.py
index 67bd945..769646f 100644
--- a/tests.py
+++ b/tests.py
@@ -1,203 +1,204 @@
import unittest
from datetime import datetime, timedelta
try:from smpp.esme import *
except:from src.smpp.esme import *
try:from smpp.clickatell import *
except:from src.smpp.clickatell import *
-import credentials_priv
+try:import credentials_priv
+except:pass
import credentials_test
from test.pdu import pdu_objects
from test import pdu_asserts
from test.pdu_hex import pdu_hex_strings
from test import pdu_hex_asserts
def unpack_hex(pdu_hex):
"""Unpack PDU hex string and return it as a dictionary"""
return unpack_pdu(binascii.a2b_hex(hexclean(pdu_hex)))
def hexclean(dirtyhex):
"""Remove whitespace, comments & newlines from hex string"""
return re.sub(r'\s','',re.sub(r'#.*\n','\n',dirtyhex))
def prettydump(pdu_obj):
"""Unpack PDU dictionary and dump it as a JSON formatted string"""
return json.dumps(pdu_obj, indent=4, sort_keys=True)
def create_pdu_asserts():
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_pdu(pack_pdu(pdu)))
pstr += "'''"
print pstr
def create_pdu_hex_asserts():
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_hex(pdu_hex))
pstr += "'''"
print pstr
## :w|!python % > test/pdu_asserts.py
#create_pdu_asserts()
#quit()
## :w|!python % > test/pdu_hex_asserts.py
#create_pdu_hex_asserts()
#quit()
class PduTestCase(unittest.TestCase):
def setUp(self):
pass
def tearDown(self):
pass
def test_pack_unpack_pdu_objects(self):
print ''
"""
Take a dictionary, pack and unpack it and dump it as JSON correctly
"""
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
padded_index = '%010d' % pdu_index
print '...', padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_pdu(pack_pdu(pdu)))),
re.sub('\n *','',
eval('pdu_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_pdu_hex_strings(self):
print ''
"""
Read the hex data, clean it, and unpack it to JSON correctly
"""
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
padded_index = '%010d' % pdu_index
print '...', padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_hex(pdu_hex))),
re.sub('\n *','',
eval('pdu_hex_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_performance(self):
print ''
"""
Pack & unpack 2000 submit_sm PDUs in under 1 second
"""
submit_sm = {
'header': {
'command_length': 0,
'command_id': 'submit_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
'esm_class':0,
'protocol_id':0,
'priority_flag':0,
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
'sm_length':1,
'short_message':'',
},
},
}
start = datetime.now()
for x in range(2000):
x += 1
submit_sm['header']['sequence_number'] = x
sm = 'testing: x = '+str(x)+''
submit_sm['body']['mandatory_parameters']['short_message'] = sm
u = unpack_pdu(pack_pdu(submit_sm))
delta = datetime.now() - start
print '... 2000 pack & unpacks in:', delta
self.assertTrue(delta < timedelta(seconds=1))
class PduBuilderTestCase(unittest.TestCase):
def test_true(self):
print ''
self.assertTrue(True)
if __name__ == '__main__':
print '\n##########################################################\n'
esme = ESME()
esme.loadDefaults(clickatell_defaults)
esme.loadDefaults(credentials_test.logica)
print esme.defaults
esme.bind_transmitter()
print esme.state
start = datetime.now()
for x in range(1):
esme.submit_sm(
short_message = 'gobbledygook',
destination_addr = '555',
)
print esme.state
for x in range(1):
esme.submit_multi(
short_message = 'gobbledygook',
dest_address = ['444','333'],
)
print esme.state
for x in range(1):
esme.submit_multi(
short_message = 'gobbledygook',
dest_address = [
{'dest_flag':1, 'destination_addr':'111'},
{'dest_flag':2, 'dl_name':'list22222'},
],
)
print esme.state
delta = datetime.now() - start
esme.disconnect()
print esme.state
print 'excluding binding ... time to send messages =', delta
#if __name__ == '__main__':
#unittest.main()
|
dmaclay/python-smpp
|
b323cc36d8fbc8defc302b8bf04780d70744cbf4
|
separate credentials
|
diff --git a/.gitignore b/.gitignore
index 739d7a0..1654d20 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,5 +1,5 @@
*.swp
*.pyc
*.egg-info
ve/
-*.priv.py
+*_priv.py
diff --git a/credentials_test.py b/credentials_test.py
new file mode 100644
index 0000000..e803e5b
--- /dev/null
+++ b/credentials_test.py
@@ -0,0 +1,7 @@
+
+logica = {
+ 'host':'localhost',
+ 'port':2775,
+ 'system_id':'test id',
+ 'password':'abc 123',
+}
diff --git a/tests.py b/tests.py
index 92ef865..67bd945 100644
--- a/tests.py
+++ b/tests.py
@@ -1,207 +1,203 @@
import unittest
from datetime import datetime, timedelta
try:from smpp.esme import *
except:from src.smpp.esme import *
try:from smpp.clickatell import *
except:from src.smpp.clickatell import *
+import credentials_priv
+import credentials_test
from test.pdu import pdu_objects
from test import pdu_asserts
from test.pdu_hex import pdu_hex_strings
from test import pdu_hex_asserts
def unpack_hex(pdu_hex):
"""Unpack PDU hex string and return it as a dictionary"""
return unpack_pdu(binascii.a2b_hex(hexclean(pdu_hex)))
def hexclean(dirtyhex):
"""Remove whitespace, comments & newlines from hex string"""
return re.sub(r'\s','',re.sub(r'#.*\n','\n',dirtyhex))
def prettydump(pdu_obj):
"""Unpack PDU dictionary and dump it as a JSON formatted string"""
return json.dumps(pdu_obj, indent=4, sort_keys=True)
def create_pdu_asserts():
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_pdu(pack_pdu(pdu)))
pstr += "'''"
print pstr
def create_pdu_hex_asserts():
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_hex(pdu_hex))
pstr += "'''"
print pstr
## :w|!python % > test/pdu_asserts.py
#create_pdu_asserts()
#quit()
## :w|!python % > test/pdu_hex_asserts.py
#create_pdu_hex_asserts()
#quit()
class PduTestCase(unittest.TestCase):
def setUp(self):
pass
def tearDown(self):
pass
def test_pack_unpack_pdu_objects(self):
print ''
"""
Take a dictionary, pack and unpack it and dump it as JSON correctly
"""
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
padded_index = '%010d' % pdu_index
print '...', padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_pdu(pack_pdu(pdu)))),
re.sub('\n *','',
eval('pdu_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_pdu_hex_strings(self):
print ''
"""
Read the hex data, clean it, and unpack it to JSON correctly
"""
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
padded_index = '%010d' % pdu_index
print '...', padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_hex(pdu_hex))),
re.sub('\n *','',
eval('pdu_hex_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_performance(self):
print ''
"""
Pack & unpack 2000 submit_sm PDUs in under 1 second
"""
submit_sm = {
'header': {
'command_length': 0,
'command_id': 'submit_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
'esm_class':0,
'protocol_id':0,
'priority_flag':0,
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
'sm_length':1,
'short_message':'',
},
},
}
start = datetime.now()
for x in range(2000):
x += 1
submit_sm['header']['sequence_number'] = x
sm = 'testing: x = '+str(x)+''
submit_sm['body']['mandatory_parameters']['short_message'] = sm
u = unpack_pdu(pack_pdu(submit_sm))
delta = datetime.now() - start
print '... 2000 pack & unpacks in:', delta
self.assertTrue(delta < timedelta(seconds=1))
class PduBuilderTestCase(unittest.TestCase):
def test_true(self):
print ''
self.assertTrue(True)
if __name__ == '__main__':
print '\n##########################################################\n'
- credentials = {
- 'host':'localhost',
- 'port':2775,
- 'system_id':'test id',
- 'password':'abc 123',
- }
esme = ESME()
esme.loadDefaults(clickatell_defaults)
- esme.loadDefaults(credentials)
+ esme.loadDefaults(credentials_test.logica)
print esme.defaults
esme.bind_transmitter()
print esme.state
start = datetime.now()
for x in range(1):
esme.submit_sm(
short_message = 'gobbledygook',
destination_addr = '555',
)
print esme.state
for x in range(1):
esme.submit_multi(
short_message = 'gobbledygook',
dest_address = ['444','333'],
)
print esme.state
for x in range(1):
esme.submit_multi(
short_message = 'gobbledygook',
dest_address = [
{'dest_flag':1, 'destination_addr':'111'},
{'dest_flag':2, 'dl_name':'list22222'},
],
)
print esme.state
delta = datetime.now() - start
esme.disconnect()
print esme.state
print 'excluding binding ... time to send messages =', delta
#if __name__ == '__main__':
#unittest.main()
|
dmaclay/python-smpp
|
242c5f295dcae765e50e7d8d9bfc0ddb0beaf967
|
cascading defaults
|
diff --git a/.gitignore b/.gitignore
index 0ec0997..739d7a0 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,5 @@
*.swp
*.pyc
*.egg-info
ve/
+*.priv.py
diff --git a/src/smpp/clickatell.py b/src/smpp/clickatell.py
new file mode 100644
index 0000000..d54999f
--- /dev/null
+++ b/src/smpp/clickatell.py
@@ -0,0 +1,7 @@
+
+clickatell_defaults = {
+ 'interface_version':'', #TODO should be '34' - fix pdu.py
+ 'dest_addr_ton':1,
+ 'dest_addr_npi':1,
+}
+
diff --git a/src/smpp/esme.py b/src/smpp/esme.py
index 472bfac..e991af4 100644
--- a/src/smpp/esme.py
+++ b/src/smpp/esme.py
@@ -1,113 +1,126 @@
import socket
from pdu_builder import *
class ESME(object):
def __init__(self):
self.state = 'CLOSED'
self.sequence_number = 1
self.conn = None
self.system_id = None
self.password = None
+ self.defaults = {}
- def connect(self, host='127.0.0.1', port=2775):
+ def loadDefaults(self, defaults):
+ self.defaults = dict(self.defaults, **defaults)
+
+
+ def connect(self):
if self.state in ['CLOSED']:
self.conn = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
- self.conn.connect((host, port))
+ self.conn.connect((
+ self.defaults.get('host', '127.0.0.1'),
+ self.defaults.get('port', 2775),
+ ))
self.state = 'OPEN'
def disconnect(self):
if self.state in ['BOUND_TX', 'BOUND_RX', 'BOUND_TRX']:
self.__unbind()
if self.state in ['OPEN']:
self.conn.close()
self.state = 'CLOSED'
def __recv(self):
pdu = None
length_bin = self.conn.recv(4)
if not length_bin:
return None
else:
#print 'length_bin', len(length_bin), length_bin
if len(length_bin) == 4:
length = int(binascii.b2a_hex(length_bin),16)
rest_bin = self.conn.recv(length-4)
pdu = unpack_pdu(length_bin + rest_bin)
print '...', pdu['header']['sequence_number'],
print '>', pdu['header']['command_id'],
print '...', pdu['header']['command_status']
return pdu
def __is_ok(self, pdu, id_check=None):
if (isinstance(pdu, dict)
and pdu.get('header',{}).get('command_status') == 'ESME_ROK'
and (id_check == None
or id_check == pdu['header'].get('command_id'))):
return True
else:
return False
- def bind_transmitter(self, system_id=None, password=None):
+ def bind_transmitter(self):
+ if self.state in ['CLOSED']:
+ self.connect()
if self.state in ['OPEN']:
- if system_id != None: self.system_id = system_id
- if password != None: self.password = password
- pdu = BindTransmitter(self.sequence_number,
- system_id = self.system_id,
- password = self.password)
+ pdu = BindTransmitter(self.sequence_number, **self.defaults)
self.conn.send(pdu.get_bin())
self.sequence_number +=1
if self.__is_ok(self.__recv(), 'bind_transmitter_resp'):
self.state = 'BOUND_TX'
def __unbind(self):
if self.state in ['BOUND_TX', 'BOUND_RX', 'BOUND_TRX']:
pdu = Unbind(self.sequence_number)
self.conn.send(pdu.get_bin())
self.sequence_number +=1
if self.__is_ok(self.__recv(), 'unbind_resp'):
self.state = 'OPEN'
- def unbind(self): # will probably be deprecated
- self.__unbind()
+ #def unbind(self): # will probably be deprecated
+ #self.__unbind()
def submit_sm(self, **kwargs):
if self.state in ['BOUND_TX', 'BOUND_TRX']:
- pdu = SubmitSM(self.sequence_number, **kwargs)
+ print dict(self.defaults, **kwargs)
+ pdu = SubmitSM(self.sequence_number, **dict(self.defaults, **kwargs))
self.conn.send(pdu.get_bin())
self.sequence_number +=1
submit_sm_resp = self.__recv()
#print self.__is_ok(submit_sm_resp, 'submit_sm_resp')
def submit_multi(self, dest_address=[], **kwargs):
if self.state in ['BOUND_TX', 'BOUND_TRX']:
- pdu = SubmitMulti(self.sequence_number, **kwargs)
+ pdu = SubmitMulti(self.sequence_number, **dict(self.defaults, **kwargs))
for item in dest_address:
if isinstance(item, str): # assume strings are addresses not lists
- pdu.addDestinationAddress(item)
+ pdu.addDestinationAddress(
+ item,
+ dest_addr_ton = self.defaults.get('dest_addr_ton', 0),
+ dest_addr_npi = self.defaults.get('dest_addr_npi', 0),
+ )
elif isinstance(item, dict):
if item.get('dest_flag') == 1:
pdu.addDestinationAddress(
item.get('destination_addr'),
- dest_addr_ton = item.get('dest_addr_ton', 0),
- dest_addr_npi = item.get('dest_addr_npi', 0),
+ dest_addr_ton = item.get('dest_addr_ton',
+ self.defaults.get('dest_addr_ton', 0)),
+ dest_addr_npi = item.get('dest_addr_npi',
+ self.defaults.get('dest_addr_npi', 0)),
)
elif item.get('dest_flag') == 2:
pdu.addDistributionList(item.get('dl_name'))
self.conn.send(pdu.get_bin())
self.sequence_number +=1
submit_multi_resp = self.__recv()
#print self.__is_ok(submit_multi_resp, 'submit_multi_resp')
diff --git a/src/smpp/pdu_builder.py b/src/smpp/pdu_builder.py
index ba752da..ec3fab9 100644
--- a/src/smpp/pdu_builder.py
+++ b/src/smpp/pdu_builder.py
@@ -1,219 +1,223 @@
from pdu import *
class PDU(object):
def __init__(self,
command_id,
command_status,
sequence_number,
- ):
+ **kwargs):
super(PDU, self).__init__()
self.obj = {}
header = {}
self.obj['header'] = header
header['command_length'] = 0
header['command_id'] = command_id
header['command_status'] = command_status
header['sequence_number'] = sequence_number
def __add_optional_parameter(self, tag, value):
optional_parameters = self.obj['body'].get('optional_parameters')
if optional_parameters == None:
optional_parameters = []
self.obj['body']['optional_parameters'] = optional_parameters
optional_parameters.append({
'tag':tag,
'length':0,
'value':value,
})
def get_obj(self):
return self.obj
def get_hex(self):
return encode_pdu(self.obj)
def get_bin(self):
return pack_pdu(self.obj)
class BindTransmitter(PDU):
def __init__(self,
sequence_number,
system_id = '',
password = '',
system_type = '',
interface_version = '',
addr_ton = 0,
addr_npi = 0,
address_range = '',
- ):
+ **kwargs):
super(BindTransmitter, self).__init__(
'bind_transmitter',
'ESME_ROK',
sequence_number,
)
body = {}
self.obj['body'] = body
mandatory_parameters = {}
body['mandatory_parameters'] = mandatory_parameters
mandatory_parameters['system_id'] = system_id
mandatory_parameters['password'] = password
mandatory_parameters['system_type'] = system_type
mandatory_parameters['interface_version'] = interface_version
mandatory_parameters['addr_ton'] = addr_ton
mandatory_parameters['addr_npi'] = addr_npi
mandatory_parameters['address_range'] = address_range
class Unbind(PDU):
def __init__(self,
sequence_number,
- ):
+ **kwargs):
super(Unbind, self).__init__(
'unbind',
'ESME_ROK',
sequence_number,
)
class SM1(PDU):
def __init__(self,
command_id,
sequence_number,
service_type = '',
source_addr_ton = 0,
source_addr_npi = 0,
source_addr = '',
esm_class = 0,
protocol_id = 0,
priority_flag = 0,
schedule_delivery_time = '',
validity_period = '',
registered_delivery = 0,
replace_if_present_flag = 0,
data_coding = 0,
sm_default_msg_id = 0,
sm_length = 0,
short_message = None,
- ):
+ **kwargs):
super(SM1, self).__init__(
command_id,
'ESME_ROK',
sequence_number,
)
body = {}
self.obj['body'] = body
mandatory_parameters = {}
body['mandatory_parameters'] = mandatory_parameters
mandatory_parameters['service_type'] = service_type
mandatory_parameters['source_addr_ton'] = source_addr_ton
mandatory_parameters['source_addr_npi'] = source_addr_npi
mandatory_parameters['source_addr'] = source_addr
mandatory_parameters['esm_class'] = esm_class
mandatory_parameters['protocol_id'] = protocol_id
mandatory_parameters['priority_flag'] = priority_flag
mandatory_parameters['schedule_delivery_time'] = schedule_delivery_time
mandatory_parameters['validity_period'] = validity_period
mandatory_parameters['registered_delivery'] = registered_delivery
mandatory_parameters['replace_if_present_flag'] = replace_if_present_flag
mandatory_parameters['data_coding'] = data_coding
mandatory_parameters['sm_default_msg_id'] = sm_default_msg_id
mandatory_parameters['sm_length'] = sm_length
mandatory_parameters['short_message'] = short_message
def add_message_payload(self, value):
self.obj['body']['mandatory_parameters']['sm_length'] = 0
self.obj['body']['mandatory_parameters']['short_message'] = None
self._PDU__add_optional_parameter('message_payload', value)
class SubmitMulti(SM1):
def __init__(self,
sequence_number,
number_of_dests = 0,
dest_address = [],
**kwargs):
super(SubmitMulti, self).__init__('submit_multi', sequence_number, **kwargs)
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['number_of_dests'] = number_of_dests
mandatory_parameters['dest_address'] = [] + dest_address
def addDestinationAddress(self,
destination_addr,
dest_addr_ton = 0,
dest_addr_npi = 0,
):
if isinstance(destination_addr, str) and len(destination_addr) > 0:
new_entry = {
'dest_flag':1,
'dest_addr_ton':dest_addr_ton,
'dest_addr_npi':dest_addr_npi,
'destination_addr':destination_addr,
}
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_address'].append(new_entry)
mandatory_parameters['number_of_dests'] = len(
mandatory_parameters['dest_address'])
return True
else:
return False
def addDistributionList(self,
dl_name,
):
if isinstance(dl_name, str) and len(dl_name) > 0:
new_entry = {
'dest_flag':2,
'dl_name':dl_name,
}
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_address'].append(new_entry)
mandatory_parameters['number_of_dests'] = len(
mandatory_parameters['dest_address'])
return True
else:
return False
class SM2(SM1):
def __init__(self,
command_id,
sequence_number,
dest_addr_ton = 0,
dest_addr_npi = 0,
destination_addr = '',
**kwargs):
super(SM2, self).__init__(command_id, sequence_number, **kwargs)
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_addr_ton'] = dest_addr_ton
mandatory_parameters['dest_addr_npi'] = dest_addr_npi
mandatory_parameters['destination_addr'] = destination_addr
class SubmitSM(SM2):
- def __init__(self, sequence_number, **kwargs):
+ def __init__(self,
+ sequence_number,
+ **kwargs):
super(SubmitSM, self).__init__('submit_sm', sequence_number, **kwargs)
class DeliverSM(SM2):
- def __init__(self, sequence_number, **kwargs):
+ def __init__(self,
+ sequence_number,
+ **kwargs):
super(DeliverSM, self).__init__('deliver_sm',sequence_number, **kwargs)
#bind = BindTransmitter(system_id='test_id', password='abc123')
#print bind.get_obj()
#print bind.get_hex()
#print bind.get_bin()
##print json.dumps(bind.get_obj(), indent=4, sort_keys=True)
##print json.dumps(decode_pdu(bind.get_hex()), indent=4, sort_keys=True)
#print json.dumps(unpack_pdu(bind.get_bin()), indent=4, sort_keys=True)
#sm = SubmitSM(short_message='testing testing')
#print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
#sm.add_message_payload('616263646566676869')
#print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
diff --git a/tests.py b/tests.py
index 433460b..92ef865 100644
--- a/tests.py
+++ b/tests.py
@@ -1,198 +1,207 @@
import unittest
from datetime import datetime, timedelta
-try:
- from smpp.esme import *
-except:
- from src.smpp.esme import *
+try:from smpp.esme import *
+except:from src.smpp.esme import *
+
+try:from smpp.clickatell import *
+except:from src.smpp.clickatell import *
+
from test.pdu import pdu_objects
from test import pdu_asserts
from test.pdu_hex import pdu_hex_strings
from test import pdu_hex_asserts
def unpack_hex(pdu_hex):
"""Unpack PDU hex string and return it as a dictionary"""
return unpack_pdu(binascii.a2b_hex(hexclean(pdu_hex)))
def hexclean(dirtyhex):
"""Remove whitespace, comments & newlines from hex string"""
return re.sub(r'\s','',re.sub(r'#.*\n','\n',dirtyhex))
def prettydump(pdu_obj):
"""Unpack PDU dictionary and dump it as a JSON formatted string"""
return json.dumps(pdu_obj, indent=4, sort_keys=True)
def create_pdu_asserts():
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_pdu(pack_pdu(pdu)))
pstr += "'''"
print pstr
def create_pdu_hex_asserts():
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_hex(pdu_hex))
pstr += "'''"
print pstr
## :w|!python % > test/pdu_asserts.py
#create_pdu_asserts()
#quit()
## :w|!python % > test/pdu_hex_asserts.py
#create_pdu_hex_asserts()
#quit()
class PduTestCase(unittest.TestCase):
def setUp(self):
pass
def tearDown(self):
pass
def test_pack_unpack_pdu_objects(self):
print ''
"""
Take a dictionary, pack and unpack it and dump it as JSON correctly
"""
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
padded_index = '%010d' % pdu_index
print '...', padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_pdu(pack_pdu(pdu)))),
re.sub('\n *','',
eval('pdu_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_pdu_hex_strings(self):
print ''
"""
Read the hex data, clean it, and unpack it to JSON correctly
"""
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
padded_index = '%010d' % pdu_index
print '...', padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_hex(pdu_hex))),
re.sub('\n *','',
eval('pdu_hex_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_performance(self):
print ''
"""
Pack & unpack 2000 submit_sm PDUs in under 1 second
"""
submit_sm = {
'header': {
'command_length': 0,
'command_id': 'submit_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
'esm_class':0,
'protocol_id':0,
'priority_flag':0,
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
'sm_length':1,
'short_message':'',
},
},
}
start = datetime.now()
for x in range(2000):
x += 1
submit_sm['header']['sequence_number'] = x
sm = 'testing: x = '+str(x)+''
submit_sm['body']['mandatory_parameters']['short_message'] = sm
u = unpack_pdu(pack_pdu(submit_sm))
delta = datetime.now() - start
print '... 2000 pack & unpacks in:', delta
self.assertTrue(delta < timedelta(seconds=1))
class PduBuilderTestCase(unittest.TestCase):
def test_true(self):
print ''
self.assertTrue(True)
if __name__ == '__main__':
print '\n##########################################################\n'
+ credentials = {
+ 'host':'localhost',
+ 'port':2775,
+ 'system_id':'test id',
+ 'password':'abc 123',
+ }
esme = ESME()
- esme.connect('localhost', 2775)
- print esme.state
- esme.bind_transmitter('test id', 'abc 123')
+ esme.loadDefaults(clickatell_defaults)
+ esme.loadDefaults(credentials)
+ print esme.defaults
+ esme.bind_transmitter()
print esme.state
start = datetime.now()
for x in range(1):
esme.submit_sm(
short_message = 'gobbledygook',
destination_addr = '555',
)
print esme.state
for x in range(1):
esme.submit_multi(
short_message = 'gobbledygook',
dest_address = ['444','333'],
)
print esme.state
for x in range(1):
esme.submit_multi(
short_message = 'gobbledygook',
dest_address = [
{'dest_flag':1, 'destination_addr':'111'},
{'dest_flag':2, 'dl_name':'list22222'},
],
)
print esme.state
delta = datetime.now() - start
esme.disconnect()
print esme.state
print 'excluding binding ... time to send messages =', delta
#if __name__ == '__main__':
#unittest.main()
|
dmaclay/python-smpp
|
8d4a64e4b90fa6fb4a3cbba3124a106e7e1a8079
|
consistent super
|
diff --git a/src/smpp/pdu_builder.py b/src/smpp/pdu_builder.py
index 3995cb2..ba752da 100644
--- a/src/smpp/pdu_builder.py
+++ b/src/smpp/pdu_builder.py
@@ -1,218 +1,219 @@
from pdu import *
class PDU(object):
def __init__(self,
command_id,
command_status,
sequence_number,
):
+ super(PDU, self).__init__()
self.obj = {}
header = {}
self.obj['header'] = header
header['command_length'] = 0
header['command_id'] = command_id
header['command_status'] = command_status
header['sequence_number'] = sequence_number
def __add_optional_parameter(self, tag, value):
optional_parameters = self.obj['body'].get('optional_parameters')
if optional_parameters == None:
optional_parameters = []
self.obj['body']['optional_parameters'] = optional_parameters
optional_parameters.append({
'tag':tag,
'length':0,
'value':value,
})
def get_obj(self):
return self.obj
def get_hex(self):
return encode_pdu(self.obj)
def get_bin(self):
return pack_pdu(self.obj)
class BindTransmitter(PDU):
def __init__(self,
sequence_number,
system_id = '',
password = '',
system_type = '',
interface_version = '',
addr_ton = 0,
addr_npi = 0,
address_range = '',
):
super(BindTransmitter, self).__init__(
'bind_transmitter',
'ESME_ROK',
sequence_number,
)
body = {}
self.obj['body'] = body
mandatory_parameters = {}
body['mandatory_parameters'] = mandatory_parameters
mandatory_parameters['system_id'] = system_id
mandatory_parameters['password'] = password
mandatory_parameters['system_type'] = system_type
mandatory_parameters['interface_version'] = interface_version
mandatory_parameters['addr_ton'] = addr_ton
mandatory_parameters['addr_npi'] = addr_npi
mandatory_parameters['address_range'] = address_range
class Unbind(PDU):
def __init__(self,
sequence_number,
):
super(Unbind, self).__init__(
'unbind',
'ESME_ROK',
sequence_number,
)
class SM1(PDU):
def __init__(self,
command_id,
sequence_number,
service_type = '',
source_addr_ton = 0,
source_addr_npi = 0,
source_addr = '',
esm_class = 0,
protocol_id = 0,
priority_flag = 0,
schedule_delivery_time = '',
validity_period = '',
registered_delivery = 0,
replace_if_present_flag = 0,
data_coding = 0,
sm_default_msg_id = 0,
sm_length = 0,
short_message = None,
):
super(SM1, self).__init__(
command_id,
'ESME_ROK',
sequence_number,
)
body = {}
self.obj['body'] = body
mandatory_parameters = {}
body['mandatory_parameters'] = mandatory_parameters
mandatory_parameters['service_type'] = service_type
mandatory_parameters['source_addr_ton'] = source_addr_ton
mandatory_parameters['source_addr_npi'] = source_addr_npi
mandatory_parameters['source_addr'] = source_addr
mandatory_parameters['esm_class'] = esm_class
mandatory_parameters['protocol_id'] = protocol_id
mandatory_parameters['priority_flag'] = priority_flag
mandatory_parameters['schedule_delivery_time'] = schedule_delivery_time
mandatory_parameters['validity_period'] = validity_period
mandatory_parameters['registered_delivery'] = registered_delivery
mandatory_parameters['replace_if_present_flag'] = replace_if_present_flag
mandatory_parameters['data_coding'] = data_coding
mandatory_parameters['sm_default_msg_id'] = sm_default_msg_id
mandatory_parameters['sm_length'] = sm_length
mandatory_parameters['short_message'] = short_message
def add_message_payload(self, value):
self.obj['body']['mandatory_parameters']['sm_length'] = 0
self.obj['body']['mandatory_parameters']['short_message'] = None
self._PDU__add_optional_parameter('message_payload', value)
class SubmitMulti(SM1):
def __init__(self,
sequence_number,
number_of_dests = 0,
dest_address = [],
**kwargs):
super(SubmitMulti, self).__init__('submit_multi', sequence_number, **kwargs)
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['number_of_dests'] = number_of_dests
mandatory_parameters['dest_address'] = [] + dest_address
def addDestinationAddress(self,
destination_addr,
dest_addr_ton = 0,
dest_addr_npi = 0,
):
if isinstance(destination_addr, str) and len(destination_addr) > 0:
new_entry = {
'dest_flag':1,
'dest_addr_ton':dest_addr_ton,
'dest_addr_npi':dest_addr_npi,
'destination_addr':destination_addr,
}
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_address'].append(new_entry)
mandatory_parameters['number_of_dests'] = len(
mandatory_parameters['dest_address'])
return True
else:
return False
def addDistributionList(self,
dl_name,
):
if isinstance(dl_name, str) and len(dl_name) > 0:
new_entry = {
'dest_flag':2,
'dl_name':dl_name,
}
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_address'].append(new_entry)
mandatory_parameters['number_of_dests'] = len(
mandatory_parameters['dest_address'])
return True
else:
return False
class SM2(SM1):
def __init__(self,
command_id,
sequence_number,
dest_addr_ton = 0,
dest_addr_npi = 0,
destination_addr = '',
**kwargs):
super(SM2, self).__init__(command_id, sequence_number, **kwargs)
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_addr_ton'] = dest_addr_ton
mandatory_parameters['dest_addr_npi'] = dest_addr_npi
mandatory_parameters['destination_addr'] = destination_addr
class SubmitSM(SM2):
def __init__(self, sequence_number, **kwargs):
super(SubmitSM, self).__init__('submit_sm', sequence_number, **kwargs)
class DeliverSM(SM2):
def __init__(self, sequence_number, **kwargs):
super(DeliverSM, self).__init__('deliver_sm',sequence_number, **kwargs)
#bind = BindTransmitter(system_id='test_id', password='abc123')
#print bind.get_obj()
#print bind.get_hex()
#print bind.get_bin()
##print json.dumps(bind.get_obj(), indent=4, sort_keys=True)
##print json.dumps(decode_pdu(bind.get_hex()), indent=4, sort_keys=True)
#print json.dumps(unpack_pdu(bind.get_bin()), indent=4, sort_keys=True)
#sm = SubmitSM(short_message='testing testing')
#print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
#sm.add_message_payload('616263646566676869')
#print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
|
dmaclay/python-smpp
|
04bdbc06ed93fd62b6202b3fb057f3d4b093ab21
|
cleanup
|
diff --git a/src/smpp/pdu_builder.py b/src/smpp/pdu_builder.py
index c3d8303..3995cb2 100644
--- a/src/smpp/pdu_builder.py
+++ b/src/smpp/pdu_builder.py
@@ -1,219 +1,218 @@
from pdu import *
class PDU(object):
def __init__(self,
command_id,
command_status,
sequence_number,
):
self.obj = {}
header = {}
self.obj['header'] = header
header['command_length'] = 0
header['command_id'] = command_id
header['command_status'] = command_status
header['sequence_number'] = sequence_number
def __add_optional_parameter(self, tag, value):
optional_parameters = self.obj['body'].get('optional_parameters')
if optional_parameters == None:
optional_parameters = []
self.obj['body']['optional_parameters'] = optional_parameters
optional_parameters.append({
'tag':tag,
'length':0,
'value':value,
})
def get_obj(self):
return self.obj
def get_hex(self):
return encode_pdu(self.obj)
def get_bin(self):
return pack_pdu(self.obj)
class BindTransmitter(PDU):
def __init__(self,
sequence_number,
system_id = '',
password = '',
system_type = '',
interface_version = '',
addr_ton = 0,
addr_npi = 0,
address_range = '',
):
super(BindTransmitter, self).__init__(
'bind_transmitter',
'ESME_ROK',
sequence_number,
)
body = {}
self.obj['body'] = body
mandatory_parameters = {}
body['mandatory_parameters'] = mandatory_parameters
mandatory_parameters['system_id'] = system_id
mandatory_parameters['password'] = password
mandatory_parameters['system_type'] = system_type
mandatory_parameters['interface_version'] = interface_version
mandatory_parameters['addr_ton'] = addr_ton
mandatory_parameters['addr_npi'] = addr_npi
mandatory_parameters['address_range'] = address_range
class Unbind(PDU):
def __init__(self,
sequence_number,
):
super(Unbind, self).__init__(
'unbind',
'ESME_ROK',
sequence_number,
)
class SM1(PDU):
def __init__(self,
command_id,
sequence_number,
service_type = '',
source_addr_ton = 0,
source_addr_npi = 0,
source_addr = '',
esm_class = 0,
protocol_id = 0,
priority_flag = 0,
schedule_delivery_time = '',
validity_period = '',
registered_delivery = 0,
replace_if_present_flag = 0,
data_coding = 0,
sm_default_msg_id = 0,
sm_length = 0,
short_message = None,
):
super(SM1, self).__init__(
command_id,
'ESME_ROK',
sequence_number,
)
body = {}
self.obj['body'] = body
mandatory_parameters = {}
body['mandatory_parameters'] = mandatory_parameters
mandatory_parameters['service_type'] = service_type
mandatory_parameters['source_addr_ton'] = source_addr_ton
mandatory_parameters['source_addr_npi'] = source_addr_npi
mandatory_parameters['source_addr'] = source_addr
mandatory_parameters['esm_class'] = esm_class
mandatory_parameters['protocol_id'] = protocol_id
mandatory_parameters['priority_flag'] = priority_flag
mandatory_parameters['schedule_delivery_time'] = schedule_delivery_time
mandatory_parameters['validity_period'] = validity_period
mandatory_parameters['registered_delivery'] = registered_delivery
mandatory_parameters['replace_if_present_flag'] = replace_if_present_flag
mandatory_parameters['data_coding'] = data_coding
mandatory_parameters['sm_default_msg_id'] = sm_default_msg_id
mandatory_parameters['sm_length'] = sm_length
mandatory_parameters['short_message'] = short_message
def add_message_payload(self, value):
self.obj['body']['mandatory_parameters']['sm_length'] = 0
self.obj['body']['mandatory_parameters']['short_message'] = None
self._PDU__add_optional_parameter('message_payload', value)
class SubmitMulti(SM1):
def __init__(self,
sequence_number,
number_of_dests = 0,
dest_address = [],
**kwargs):
- print '####', number_of_dests, dest_address
super(SubmitMulti, self).__init__('submit_multi', sequence_number, **kwargs)
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['number_of_dests'] = number_of_dests
mandatory_parameters['dest_address'] = [] + dest_address
def addDestinationAddress(self,
destination_addr,
dest_addr_ton = 0,
dest_addr_npi = 0,
):
if isinstance(destination_addr, str) and len(destination_addr) > 0:
new_entry = {
'dest_flag':1,
'dest_addr_ton':dest_addr_ton,
'dest_addr_npi':dest_addr_npi,
'destination_addr':destination_addr,
}
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_address'].append(new_entry)
mandatory_parameters['number_of_dests'] = len(
mandatory_parameters['dest_address'])
return True
else:
return False
def addDistributionList(self,
dl_name,
):
if isinstance(dl_name, str) and len(dl_name) > 0:
new_entry = {
'dest_flag':2,
'dl_name':dl_name,
}
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_address'].append(new_entry)
mandatory_parameters['number_of_dests'] = len(
mandatory_parameters['dest_address'])
return True
else:
return False
class SM2(SM1):
def __init__(self,
command_id,
sequence_number,
dest_addr_ton = 0,
dest_addr_npi = 0,
destination_addr = '',
**kwargs):
super(SM2, self).__init__(command_id, sequence_number, **kwargs)
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_addr_ton'] = dest_addr_ton
mandatory_parameters['dest_addr_npi'] = dest_addr_npi
mandatory_parameters['destination_addr'] = destination_addr
class SubmitSM(SM2):
def __init__(self, sequence_number, **kwargs):
super(SubmitSM, self).__init__('submit_sm', sequence_number, **kwargs)
class DeliverSM(SM2):
def __init__(self, sequence_number, **kwargs):
super(DeliverSM, self).__init__('deliver_sm',sequence_number, **kwargs)
#bind = BindTransmitter(system_id='test_id', password='abc123')
#print bind.get_obj()
#print bind.get_hex()
#print bind.get_bin()
##print json.dumps(bind.get_obj(), indent=4, sort_keys=True)
##print json.dumps(decode_pdu(bind.get_hex()), indent=4, sort_keys=True)
#print json.dumps(unpack_pdu(bind.get_bin()), indent=4, sort_keys=True)
#sm = SubmitSM(short_message='testing testing')
#print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
#sm.add_message_payload('616263646566676869')
#print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
|
dmaclay/python-smpp
|
fcd2ccc325f5cf5ebee9123e9b511719c2fa4b53
|
i always forget lists/dicts are pointers to mutable objects
|
diff --git a/src/smpp/pdu_builder.py b/src/smpp/pdu_builder.py
index e609bf1..c3d8303 100644
--- a/src/smpp/pdu_builder.py
+++ b/src/smpp/pdu_builder.py
@@ -1,216 +1,219 @@
from pdu import *
class PDU(object):
def __init__(self,
command_id,
command_status,
sequence_number,
):
self.obj = {}
header = {}
self.obj['header'] = header
header['command_length'] = 0
header['command_id'] = command_id
header['command_status'] = command_status
header['sequence_number'] = sequence_number
def __add_optional_parameter(self, tag, value):
optional_parameters = self.obj['body'].get('optional_parameters')
if optional_parameters == None:
optional_parameters = []
self.obj['body']['optional_parameters'] = optional_parameters
optional_parameters.append({
'tag':tag,
'length':0,
'value':value,
})
def get_obj(self):
return self.obj
def get_hex(self):
return encode_pdu(self.obj)
def get_bin(self):
return pack_pdu(self.obj)
class BindTransmitter(PDU):
def __init__(self,
sequence_number,
system_id = '',
password = '',
system_type = '',
interface_version = '',
addr_ton = 0,
addr_npi = 0,
address_range = '',
):
super(BindTransmitter, self).__init__(
'bind_transmitter',
'ESME_ROK',
sequence_number,
)
body = {}
self.obj['body'] = body
mandatory_parameters = {}
body['mandatory_parameters'] = mandatory_parameters
mandatory_parameters['system_id'] = system_id
mandatory_parameters['password'] = password
mandatory_parameters['system_type'] = system_type
mandatory_parameters['interface_version'] = interface_version
mandatory_parameters['addr_ton'] = addr_ton
mandatory_parameters['addr_npi'] = addr_npi
mandatory_parameters['address_range'] = address_range
class Unbind(PDU):
def __init__(self,
sequence_number,
):
super(Unbind, self).__init__(
'unbind',
'ESME_ROK',
sequence_number,
)
class SM1(PDU):
def __init__(self,
command_id,
sequence_number,
service_type = '',
source_addr_ton = 0,
source_addr_npi = 0,
source_addr = '',
esm_class = 0,
protocol_id = 0,
priority_flag = 0,
schedule_delivery_time = '',
validity_period = '',
registered_delivery = 0,
replace_if_present_flag = 0,
data_coding = 0,
sm_default_msg_id = 0,
sm_length = 0,
short_message = None,
):
super(SM1, self).__init__(
command_id,
'ESME_ROK',
sequence_number,
)
body = {}
self.obj['body'] = body
mandatory_parameters = {}
body['mandatory_parameters'] = mandatory_parameters
mandatory_parameters['service_type'] = service_type
mandatory_parameters['source_addr_ton'] = source_addr_ton
mandatory_parameters['source_addr_npi'] = source_addr_npi
mandatory_parameters['source_addr'] = source_addr
mandatory_parameters['esm_class'] = esm_class
mandatory_parameters['protocol_id'] = protocol_id
mandatory_parameters['priority_flag'] = priority_flag
mandatory_parameters['schedule_delivery_time'] = schedule_delivery_time
mandatory_parameters['validity_period'] = validity_period
mandatory_parameters['registered_delivery'] = registered_delivery
mandatory_parameters['replace_if_present_flag'] = replace_if_present_flag
mandatory_parameters['data_coding'] = data_coding
mandatory_parameters['sm_default_msg_id'] = sm_default_msg_id
mandatory_parameters['sm_length'] = sm_length
mandatory_parameters['short_message'] = short_message
def add_message_payload(self, value):
self.obj['body']['mandatory_parameters']['sm_length'] = 0
self.obj['body']['mandatory_parameters']['short_message'] = None
self._PDU__add_optional_parameter('message_payload', value)
class SubmitMulti(SM1):
def __init__(self,
sequence_number,
+ number_of_dests = 0,
+ dest_address = [],
**kwargs):
+ print '####', number_of_dests, dest_address
super(SubmitMulti, self).__init__('submit_multi', sequence_number, **kwargs)
mandatory_parameters = self.obj['body']['mandatory_parameters']
- mandatory_parameters['number_of_dests'] = 0
- mandatory_parameters['dest_address'] = []
+ mandatory_parameters['number_of_dests'] = number_of_dests
+ mandatory_parameters['dest_address'] = [] + dest_address
def addDestinationAddress(self,
destination_addr,
dest_addr_ton = 0,
dest_addr_npi = 0,
):
if isinstance(destination_addr, str) and len(destination_addr) > 0:
new_entry = {
'dest_flag':1,
'dest_addr_ton':dest_addr_ton,
'dest_addr_npi':dest_addr_npi,
'destination_addr':destination_addr,
}
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_address'].append(new_entry)
mandatory_parameters['number_of_dests'] = len(
mandatory_parameters['dest_address'])
return True
else:
return False
def addDistributionList(self,
dl_name,
):
if isinstance(dl_name, str) and len(dl_name) > 0:
new_entry = {
'dest_flag':2,
'dl_name':dl_name,
}
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_address'].append(new_entry)
mandatory_parameters['number_of_dests'] = len(
mandatory_parameters['dest_address'])
return True
else:
return False
class SM2(SM1):
def __init__(self,
command_id,
sequence_number,
dest_addr_ton = 0,
dest_addr_npi = 0,
destination_addr = '',
**kwargs):
super(SM2, self).__init__(command_id, sequence_number, **kwargs)
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_addr_ton'] = dest_addr_ton
mandatory_parameters['dest_addr_npi'] = dest_addr_npi
mandatory_parameters['destination_addr'] = destination_addr
class SubmitSM(SM2):
def __init__(self, sequence_number, **kwargs):
super(SubmitSM, self).__init__('submit_sm', sequence_number, **kwargs)
class DeliverSM(SM2):
def __init__(self, sequence_number, **kwargs):
super(DeliverSM, self).__init__('deliver_sm',sequence_number, **kwargs)
#bind = BindTransmitter(system_id='test_id', password='abc123')
#print bind.get_obj()
#print bind.get_hex()
#print bind.get_bin()
##print json.dumps(bind.get_obj(), indent=4, sort_keys=True)
##print json.dumps(decode_pdu(bind.get_hex()), indent=4, sort_keys=True)
#print json.dumps(unpack_pdu(bind.get_bin()), indent=4, sort_keys=True)
#sm = SubmitSM(short_message='testing testing')
#print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
#sm.add_message_payload('616263646566676869')
#print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
|
dmaclay/python-smpp
|
be857868c1ee1a8385c1072abd283980e0e3e508
|
ESME.submit_multi() seems ok ...
|
diff --git a/src/smpp/esme.py b/src/smpp/esme.py
index f60aab9..472bfac 100644
--- a/src/smpp/esme.py
+++ b/src/smpp/esme.py
@@ -1,103 +1,113 @@
import socket
from pdu_builder import *
class ESME(object):
def __init__(self):
self.state = 'CLOSED'
self.sequence_number = 1
self.conn = None
self.system_id = None
self.password = None
def connect(self, host='127.0.0.1', port=2775):
if self.state in ['CLOSED']:
self.conn = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
self.conn.connect((host, port))
self.state = 'OPEN'
def disconnect(self):
if self.state in ['BOUND_TX', 'BOUND_RX', 'BOUND_TRX']:
self.__unbind()
if self.state in ['OPEN']:
self.conn.close()
self.state = 'CLOSED'
def __recv(self):
pdu = None
length_bin = self.conn.recv(4)
if not length_bin:
return None
else:
#print 'length_bin', len(length_bin), length_bin
if len(length_bin) == 4:
length = int(binascii.b2a_hex(length_bin),16)
rest_bin = self.conn.recv(length-4)
pdu = unpack_pdu(length_bin + rest_bin)
print '...', pdu['header']['sequence_number'],
print '>', pdu['header']['command_id'],
print '...', pdu['header']['command_status']
return pdu
def __is_ok(self, pdu, id_check=None):
if (isinstance(pdu, dict)
and pdu.get('header',{}).get('command_status') == 'ESME_ROK'
and (id_check == None
or id_check == pdu['header'].get('command_id'))):
return True
else:
return False
def bind_transmitter(self, system_id=None, password=None):
if self.state in ['OPEN']:
if system_id != None: self.system_id = system_id
if password != None: self.password = password
- pdu = BindTransmitter(sequence_number = self.sequence_number,
+ pdu = BindTransmitter(self.sequence_number,
system_id = self.system_id,
password = self.password)
self.conn.send(pdu.get_bin())
self.sequence_number +=1
if self.__is_ok(self.__recv(), 'bind_transmitter_resp'):
self.state = 'BOUND_TX'
def __unbind(self):
if self.state in ['BOUND_TX', 'BOUND_RX', 'BOUND_TRX']:
- pdu = Unbind(sequence_number = self.sequence_number)
+ pdu = Unbind(self.sequence_number)
self.conn.send(pdu.get_bin())
self.sequence_number +=1
if self.__is_ok(self.__recv(), 'unbind_resp'):
self.state = 'OPEN'
def unbind(self): # will probably be deprecated
self.__unbind()
def submit_sm(self, **kwargs):
if self.state in ['BOUND_TX', 'BOUND_TRX']:
- pdu = SubmitSM(sequence_number = self.sequence_number, **kwargs)
- #print pdu.get_obj()
+ pdu = SubmitSM(self.sequence_number, **kwargs)
self.conn.send(pdu.get_bin())
self.sequence_number +=1
submit_sm_resp = self.__recv()
#print self.__is_ok(submit_sm_resp, 'submit_sm_resp')
- def submit_multi(self, **kwargs):
+ def submit_multi(self, dest_address=[], **kwargs):
if self.state in ['BOUND_TX', 'BOUND_TRX']:
- pdu = SubmitMulti(sequence_number = self.sequence_number, **kwargs)
- #print pdu.get_obj()
+ pdu = SubmitMulti(self.sequence_number, **kwargs)
+ for item in dest_address:
+ if isinstance(item, str): # assume strings are addresses not lists
+ pdu.addDestinationAddress(item)
+ elif isinstance(item, dict):
+ if item.get('dest_flag') == 1:
+ pdu.addDestinationAddress(
+ item.get('destination_addr'),
+ dest_addr_ton = item.get('dest_addr_ton', 0),
+ dest_addr_npi = item.get('dest_addr_npi', 0),
+ )
+ elif item.get('dest_flag') == 2:
+ pdu.addDistributionList(item.get('dl_name'))
self.conn.send(pdu.get_bin())
self.sequence_number +=1
submit_multi_resp = self.__recv()
#print self.__is_ok(submit_multi_resp, 'submit_multi_resp')
diff --git a/src/smpp/pdu_builder.py b/src/smpp/pdu_builder.py
index c4fd406..e609bf1 100644
--- a/src/smpp/pdu_builder.py
+++ b/src/smpp/pdu_builder.py
@@ -1,180 +1,216 @@
from pdu import *
class PDU(object):
def __init__(self,
command_id,
command_status,
- sequence_number = 0,
+ sequence_number,
):
self.obj = {}
header = {}
self.obj['header'] = header
header['command_length'] = 0
header['command_id'] = command_id
header['command_status'] = command_status
header['sequence_number'] = sequence_number
def __add_optional_parameter(self, tag, value):
optional_parameters = self.obj['body'].get('optional_parameters')
if optional_parameters == None:
optional_parameters = []
self.obj['body']['optional_parameters'] = optional_parameters
optional_parameters.append({
'tag':tag,
'length':0,
'value':value,
})
def get_obj(self):
return self.obj
def get_hex(self):
return encode_pdu(self.obj)
def get_bin(self):
return pack_pdu(self.obj)
class BindTransmitter(PDU):
def __init__(self,
- sequence_number = 0,
+ sequence_number,
system_id = '',
password = '',
system_type = '',
interface_version = '',
addr_ton = 0,
addr_npi = 0,
address_range = '',
):
super(BindTransmitter, self).__init__(
'bind_transmitter',
'ESME_ROK',
sequence_number,
)
body = {}
self.obj['body'] = body
mandatory_parameters = {}
body['mandatory_parameters'] = mandatory_parameters
mandatory_parameters['system_id'] = system_id
mandatory_parameters['password'] = password
mandatory_parameters['system_type'] = system_type
mandatory_parameters['interface_version'] = interface_version
mandatory_parameters['addr_ton'] = addr_ton
mandatory_parameters['addr_npi'] = addr_npi
mandatory_parameters['address_range'] = address_range
class Unbind(PDU):
def __init__(self,
- sequence_number = 0,
+ sequence_number,
):
super(Unbind, self).__init__(
'unbind',
'ESME_ROK',
sequence_number,
)
class SM1(PDU):
def __init__(self,
command_id,
- sequence_number = 0,
+ sequence_number,
service_type = '',
source_addr_ton = 0,
source_addr_npi = 0,
source_addr = '',
esm_class = 0,
protocol_id = 0,
priority_flag = 0,
schedule_delivery_time = '',
validity_period = '',
registered_delivery = 0,
replace_if_present_flag = 0,
data_coding = 0,
sm_default_msg_id = 0,
sm_length = 0,
short_message = None,
):
super(SM1, self).__init__(
command_id,
'ESME_ROK',
sequence_number,
)
body = {}
self.obj['body'] = body
mandatory_parameters = {}
body['mandatory_parameters'] = mandatory_parameters
mandatory_parameters['service_type'] = service_type
mandatory_parameters['source_addr_ton'] = source_addr_ton
mandatory_parameters['source_addr_npi'] = source_addr_npi
mandatory_parameters['source_addr'] = source_addr
mandatory_parameters['esm_class'] = esm_class
mandatory_parameters['protocol_id'] = protocol_id
mandatory_parameters['priority_flag'] = priority_flag
mandatory_parameters['schedule_delivery_time'] = schedule_delivery_time
mandatory_parameters['validity_period'] = validity_period
mandatory_parameters['registered_delivery'] = registered_delivery
mandatory_parameters['replace_if_present_flag'] = replace_if_present_flag
mandatory_parameters['data_coding'] = data_coding
mandatory_parameters['sm_default_msg_id'] = sm_default_msg_id
mandatory_parameters['sm_length'] = sm_length
mandatory_parameters['short_message'] = short_message
def add_message_payload(self, value):
self.obj['body']['mandatory_parameters']['sm_length'] = 0
self.obj['body']['mandatory_parameters']['short_message'] = None
self._PDU__add_optional_parameter('message_payload', value)
class SubmitMulti(SM1):
def __init__(self,
- number_of_dests = 0,
- dest_address = [],
+ sequence_number,
**kwargs):
- super(SubmitMulti, self).__init__('submit_multi', **kwargs)
+ super(SubmitMulti, self).__init__('submit_multi', sequence_number, **kwargs)
mandatory_parameters = self.obj['body']['mandatory_parameters']
- mandatory_parameters['number_of_dests'] = number_of_dests
- mandatory_parameters['dest_address'] = dest_address
+ mandatory_parameters['number_of_dests'] = 0
+ mandatory_parameters['dest_address'] = []
+
+ def addDestinationAddress(self,
+ destination_addr,
+ dest_addr_ton = 0,
+ dest_addr_npi = 0,
+ ):
+ if isinstance(destination_addr, str) and len(destination_addr) > 0:
+ new_entry = {
+ 'dest_flag':1,
+ 'dest_addr_ton':dest_addr_ton,
+ 'dest_addr_npi':dest_addr_npi,
+ 'destination_addr':destination_addr,
+ }
+ mandatory_parameters = self.obj['body']['mandatory_parameters']
+ mandatory_parameters['dest_address'].append(new_entry)
+ mandatory_parameters['number_of_dests'] = len(
+ mandatory_parameters['dest_address'])
+ return True
+ else:
+ return False
+
+ def addDistributionList(self,
+ dl_name,
+ ):
+ if isinstance(dl_name, str) and len(dl_name) > 0:
+ new_entry = {
+ 'dest_flag':2,
+ 'dl_name':dl_name,
+ }
+ mandatory_parameters = self.obj['body']['mandatory_parameters']
+ mandatory_parameters['dest_address'].append(new_entry)
+ mandatory_parameters['number_of_dests'] = len(
+ mandatory_parameters['dest_address'])
+ return True
+ else:
+ return False
class SM2(SM1):
def __init__(self,
command_id,
+ sequence_number,
dest_addr_ton = 0,
dest_addr_npi = 0,
destination_addr = '',
**kwargs):
- super(SM2, self).__init__(command_id, **kwargs)
+ super(SM2, self).__init__(command_id, sequence_number, **kwargs)
mandatory_parameters = self.obj['body']['mandatory_parameters']
mandatory_parameters['dest_addr_ton'] = dest_addr_ton
mandatory_parameters['dest_addr_npi'] = dest_addr_npi
mandatory_parameters['destination_addr'] = destination_addr
class SubmitSM(SM2):
- def __init__(self, **kwargs):
- super(SubmitSM, self).__init__('submit_sm', **kwargs)
+ def __init__(self, sequence_number, **kwargs):
+ super(SubmitSM, self).__init__('submit_sm', sequence_number, **kwargs)
class DeliverSM(SM2):
- def __init__(self, **kwargs):
- super(DeliverSM, self).__init__('deliver_sm', **kwargs)
+ def __init__(self, sequence_number, **kwargs):
+ super(DeliverSM, self).__init__('deliver_sm',sequence_number, **kwargs)
#bind = BindTransmitter(system_id='test_id', password='abc123')
#print bind.get_obj()
#print bind.get_hex()
#print bind.get_bin()
##print json.dumps(bind.get_obj(), indent=4, sort_keys=True)
##print json.dumps(decode_pdu(bind.get_hex()), indent=4, sort_keys=True)
#print json.dumps(unpack_pdu(bind.get_bin()), indent=4, sort_keys=True)
#sm = SubmitSM(short_message='testing testing')
#print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
#sm.add_message_payload('616263646566676869')
#print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
diff --git a/tests.py b/tests.py
index c606bc8..433460b 100644
--- a/tests.py
+++ b/tests.py
@@ -1,188 +1,198 @@
import unittest
from datetime import datetime, timedelta
try:
from smpp.esme import *
except:
from src.smpp.esme import *
from test.pdu import pdu_objects
from test import pdu_asserts
from test.pdu_hex import pdu_hex_strings
from test import pdu_hex_asserts
def unpack_hex(pdu_hex):
"""Unpack PDU hex string and return it as a dictionary"""
return unpack_pdu(binascii.a2b_hex(hexclean(pdu_hex)))
def hexclean(dirtyhex):
"""Remove whitespace, comments & newlines from hex string"""
return re.sub(r'\s','',re.sub(r'#.*\n','\n',dirtyhex))
def prettydump(pdu_obj):
"""Unpack PDU dictionary and dump it as a JSON formatted string"""
return json.dumps(pdu_obj, indent=4, sort_keys=True)
def create_pdu_asserts():
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_pdu(pack_pdu(pdu)))
pstr += "'''"
print pstr
def create_pdu_hex_asserts():
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_hex(pdu_hex))
pstr += "'''"
print pstr
## :w|!python % > test/pdu_asserts.py
#create_pdu_asserts()
#quit()
## :w|!python % > test/pdu_hex_asserts.py
#create_pdu_hex_asserts()
#quit()
class PduTestCase(unittest.TestCase):
def setUp(self):
pass
def tearDown(self):
pass
def test_pack_unpack_pdu_objects(self):
print ''
"""
Take a dictionary, pack and unpack it and dump it as JSON correctly
"""
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
padded_index = '%010d' % pdu_index
print '...', padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_pdu(pack_pdu(pdu)))),
re.sub('\n *','',
eval('pdu_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_pdu_hex_strings(self):
print ''
"""
Read the hex data, clean it, and unpack it to JSON correctly
"""
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
padded_index = '%010d' % pdu_index
print '...', padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_hex(pdu_hex))),
re.sub('\n *','',
eval('pdu_hex_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_performance(self):
print ''
"""
Pack & unpack 2000 submit_sm PDUs in under 1 second
"""
submit_sm = {
'header': {
'command_length': 0,
'command_id': 'submit_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
'esm_class':0,
'protocol_id':0,
'priority_flag':0,
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
'sm_length':1,
'short_message':'',
},
},
}
start = datetime.now()
for x in range(2000):
x += 1
submit_sm['header']['sequence_number'] = x
sm = 'testing: x = '+str(x)+''
submit_sm['body']['mandatory_parameters']['short_message'] = sm
u = unpack_pdu(pack_pdu(submit_sm))
delta = datetime.now() - start
print '... 2000 pack & unpacks in:', delta
self.assertTrue(delta < timedelta(seconds=1))
class PduBuilderTestCase(unittest.TestCase):
def test_true(self):
print ''
self.assertTrue(True)
if __name__ == '__main__':
+ print '\n##########################################################\n'
esme = ESME()
esme.connect('localhost', 2775)
print esme.state
esme.bind_transmitter('test id', 'abc 123')
- #esme.unbind()
- #esme.bind_transmitter('test id', 'abc 123')
print esme.state
start = datetime.now()
- for x in range(3):
+ for x in range(1):
esme.submit_sm(
short_message = 'gobbledygook',
destination_addr = '555',
)
+ print esme.state
+ for x in range(1):
+ esme.submit_multi(
+ short_message = 'gobbledygook',
+ dest_address = ['444','333'],
+ )
+ print esme.state
+ for x in range(1):
esme.submit_multi(
short_message = 'gobbledygook',
- dest_address = [],
+ dest_address = [
+ {'dest_flag':1, 'destination_addr':'111'},
+ {'dest_flag':2, 'dl_name':'list22222'},
+ ],
)
print esme.state
delta = datetime.now() - start
- print delta
esme.disconnect()
print esme.state
+ print 'excluding binding ... time to send messages =', delta
#if __name__ == '__main__':
#unittest.main()
|
dmaclay/python-smpp
|
605f18d07755278e0eb8787ce65107475f5817b5
|
better subclassing (**kwargs)
|
diff --git a/src/smpp/esme.py b/src/smpp/esme.py
index 38b1176..f60aab9 100644
--- a/src/smpp/esme.py
+++ b/src/smpp/esme.py
@@ -1,93 +1,103 @@
import socket
from pdu_builder import *
-class ESME:
+class ESME(object):
def __init__(self):
self.state = 'CLOSED'
self.sequence_number = 1
self.conn = None
self.system_id = None
self.password = None
def connect(self, host='127.0.0.1', port=2775):
if self.state in ['CLOSED']:
self.conn = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
self.conn.connect((host, port))
self.state = 'OPEN'
def disconnect(self):
if self.state in ['BOUND_TX', 'BOUND_RX', 'BOUND_TRX']:
self.__unbind()
if self.state in ['OPEN']:
self.conn.close()
self.state = 'CLOSED'
def __recv(self):
pdu = None
length_bin = self.conn.recv(4)
if not length_bin:
return None
else:
#print 'length_bin', len(length_bin), length_bin
if len(length_bin) == 4:
length = int(binascii.b2a_hex(length_bin),16)
rest_bin = self.conn.recv(length-4)
pdu = unpack_pdu(length_bin + rest_bin)
print '...', pdu['header']['sequence_number'],
print '>', pdu['header']['command_id'],
print '...', pdu['header']['command_status']
return pdu
def __is_ok(self, pdu, id_check=None):
if (isinstance(pdu, dict)
and pdu.get('header',{}).get('command_status') == 'ESME_ROK'
and (id_check == None
or id_check == pdu['header'].get('command_id'))):
return True
else:
return False
def bind_transmitter(self, system_id=None, password=None):
if self.state in ['OPEN']:
if system_id != None: self.system_id = system_id
if password != None: self.password = password
pdu = BindTransmitter(sequence_number = self.sequence_number,
system_id = self.system_id,
password = self.password)
self.conn.send(pdu.get_bin())
self.sequence_number +=1
if self.__is_ok(self.__recv(), 'bind_transmitter_resp'):
self.state = 'BOUND_TX'
def __unbind(self):
if self.state in ['BOUND_TX', 'BOUND_RX', 'BOUND_TRX']:
pdu = Unbind(sequence_number = self.sequence_number)
self.conn.send(pdu.get_bin())
self.sequence_number +=1
if self.__is_ok(self.__recv(), 'unbind_resp'):
self.state = 'OPEN'
def unbind(self): # will probably be deprecated
self.__unbind()
- def submit_sm(self, message=''):
+ def submit_sm(self, **kwargs):
if self.state in ['BOUND_TX', 'BOUND_TRX']:
- pdu = SubmitSM(sequence_number = self.sequence_number,
- short_message = message)
+ pdu = SubmitSM(sequence_number = self.sequence_number, **kwargs)
+ #print pdu.get_obj()
self.conn.send(pdu.get_bin())
self.sequence_number +=1
submit_sm_resp = self.__recv()
#print self.__is_ok(submit_sm_resp, 'submit_sm_resp')
+ def submit_multi(self, **kwargs):
+ if self.state in ['BOUND_TX', 'BOUND_TRX']:
+ pdu = SubmitMulti(sequence_number = self.sequence_number, **kwargs)
+ #print pdu.get_obj()
+ self.conn.send(pdu.get_bin())
+ self.sequence_number +=1
+ submit_multi_resp = self.__recv()
+ #print self.__is_ok(submit_multi_resp, 'submit_multi_resp')
+
+
diff --git a/src/smpp/pdu_builder.py b/src/smpp/pdu_builder.py
index 0b5adca..c4fd406 100644
--- a/src/smpp/pdu_builder.py
+++ b/src/smpp/pdu_builder.py
@@ -1,151 +1,180 @@
from pdu import *
-class PDU:
+class PDU(object):
def __init__(self,
command_id,
command_status,
sequence_number = 0,
):
self.obj = {}
header = {}
self.obj['header'] = header
header['command_length'] = 0
header['command_id'] = command_id
header['command_status'] = command_status
header['sequence_number'] = sequence_number
def __add_optional_parameter(self, tag, value):
optional_parameters = self.obj['body'].get('optional_parameters')
if optional_parameters == None:
optional_parameters = []
self.obj['body']['optional_parameters'] = optional_parameters
optional_parameters.append({
'tag':tag,
'length':0,
'value':value,
})
def get_obj(self):
return self.obj
def get_hex(self):
return encode_pdu(self.obj)
def get_bin(self):
return pack_pdu(self.obj)
class BindTransmitter(PDU):
def __init__(self,
sequence_number = 0,
system_id = '',
password = '',
system_type = '',
interface_version = '',
addr_ton = 0,
addr_npi = 0,
address_range = '',
):
- PDU.__init__(self,
+ super(BindTransmitter, self).__init__(
'bind_transmitter',
'ESME_ROK',
- sequence_number)
+ sequence_number,
+ )
body = {}
self.obj['body'] = body
mandatory_parameters = {}
body['mandatory_parameters'] = mandatory_parameters
mandatory_parameters['system_id'] = system_id
mandatory_parameters['password'] = password
mandatory_parameters['system_type'] = system_type
mandatory_parameters['interface_version'] = interface_version
mandatory_parameters['addr_ton'] = addr_ton
mandatory_parameters['addr_npi'] = addr_npi
mandatory_parameters['address_range'] = address_range
class Unbind(PDU):
def __init__(self,
sequence_number = 0,
):
- PDU.__init__(self,
+ super(Unbind, self).__init__(
'unbind',
'ESME_ROK',
- sequence_number)
+ sequence_number,
+ )
-class SubmitSM(PDU):
-
+class SM1(PDU):
def __init__(self,
+ command_id,
sequence_number = 0,
service_type = '',
source_addr_ton = 0,
source_addr_npi = 0,
source_addr = '',
- dest_addr_ton = 0,
- dest_addr_npi = 0,
- destination_addr = '',
esm_class = 0,
protocol_id = 0,
priority_flag = 0,
schedule_delivery_time = '',
validity_period = '',
registered_delivery = 0,
replace_if_present_flag = 0,
data_coding = 0,
sm_default_msg_id = 0,
sm_length = 0,
short_message = None,
):
- PDU.__init__(self,
- 'submit_sm',
+ super(SM1, self).__init__(
+ command_id,
'ESME_ROK',
- sequence_number)
+ sequence_number,
+ )
body = {}
self.obj['body'] = body
mandatory_parameters = {}
body['mandatory_parameters'] = mandatory_parameters
mandatory_parameters['service_type'] = service_type
mandatory_parameters['source_addr_ton'] = source_addr_ton
mandatory_parameters['source_addr_npi'] = source_addr_npi
mandatory_parameters['source_addr'] = source_addr
- mandatory_parameters['dest_addr_ton'] = dest_addr_ton
- mandatory_parameters['dest_addr_npi'] = dest_addr_npi
- mandatory_parameters['destination_addr'] = destination_addr
mandatory_parameters['esm_class'] = esm_class
mandatory_parameters['protocol_id'] = protocol_id
mandatory_parameters['priority_flag'] = priority_flag
mandatory_parameters['schedule_delivery_time'] = schedule_delivery_time
mandatory_parameters['validity_period'] = validity_period
mandatory_parameters['registered_delivery'] = registered_delivery
mandatory_parameters['replace_if_present_flag'] = replace_if_present_flag
mandatory_parameters['data_coding'] = data_coding
mandatory_parameters['sm_default_msg_id'] = sm_default_msg_id
mandatory_parameters['sm_length'] = sm_length
mandatory_parameters['short_message'] = short_message
def add_message_payload(self, value):
self.obj['body']['mandatory_parameters']['sm_length'] = 0
self.obj['body']['mandatory_parameters']['short_message'] = None
self._PDU__add_optional_parameter('message_payload', value)
+class SubmitMulti(SM1):
+ def __init__(self,
+ number_of_dests = 0,
+ dest_address = [],
+ **kwargs):
+ super(SubmitMulti, self).__init__('submit_multi', **kwargs)
+ mandatory_parameters = self.obj['body']['mandatory_parameters']
+ mandatory_parameters['number_of_dests'] = number_of_dests
+ mandatory_parameters['dest_address'] = dest_address
+
+
+class SM2(SM1):
+ def __init__(self,
+ command_id,
+ dest_addr_ton = 0,
+ dest_addr_npi = 0,
+ destination_addr = '',
+ **kwargs):
+ super(SM2, self).__init__(command_id, **kwargs)
+ mandatory_parameters = self.obj['body']['mandatory_parameters']
+ mandatory_parameters['dest_addr_ton'] = dest_addr_ton
+ mandatory_parameters['dest_addr_npi'] = dest_addr_npi
+ mandatory_parameters['destination_addr'] = destination_addr
+
+
+class SubmitSM(SM2):
+ def __init__(self, **kwargs):
+ super(SubmitSM, self).__init__('submit_sm', **kwargs)
+
+class DeliverSM(SM2):
+ def __init__(self, **kwargs):
+ super(DeliverSM, self).__init__('deliver_sm', **kwargs)
#bind = BindTransmitter(system_id='test_id', password='abc123')
#print bind.get_obj()
#print bind.get_hex()
#print bind.get_bin()
##print json.dumps(bind.get_obj(), indent=4, sort_keys=True)
##print json.dumps(decode_pdu(bind.get_hex()), indent=4, sort_keys=True)
#print json.dumps(unpack_pdu(bind.get_bin()), indent=4, sort_keys=True)
#sm = SubmitSM(short_message='testing testing')
#print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
#sm.add_message_payload('616263646566676869')
#print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
diff --git a/tests.py b/tests.py
index 0d2be84..c606bc8 100644
--- a/tests.py
+++ b/tests.py
@@ -1,181 +1,188 @@
import unittest
from datetime import datetime, timedelta
try:
from smpp.esme import *
except:
from src.smpp.esme import *
from test.pdu import pdu_objects
from test import pdu_asserts
from test.pdu_hex import pdu_hex_strings
from test import pdu_hex_asserts
def unpack_hex(pdu_hex):
"""Unpack PDU hex string and return it as a dictionary"""
return unpack_pdu(binascii.a2b_hex(hexclean(pdu_hex)))
def hexclean(dirtyhex):
"""Remove whitespace, comments & newlines from hex string"""
return re.sub(r'\s','',re.sub(r'#.*\n','\n',dirtyhex))
def prettydump(pdu_obj):
"""Unpack PDU dictionary and dump it as a JSON formatted string"""
return json.dumps(pdu_obj, indent=4, sort_keys=True)
def create_pdu_asserts():
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_pdu(pack_pdu(pdu)))
pstr += "'''"
print pstr
def create_pdu_hex_asserts():
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_hex(pdu_hex))
pstr += "'''"
print pstr
## :w|!python % > test/pdu_asserts.py
#create_pdu_asserts()
#quit()
## :w|!python % > test/pdu_hex_asserts.py
#create_pdu_hex_asserts()
#quit()
class PduTestCase(unittest.TestCase):
def setUp(self):
pass
def tearDown(self):
pass
def test_pack_unpack_pdu_objects(self):
print ''
"""
Take a dictionary, pack and unpack it and dump it as JSON correctly
"""
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
padded_index = '%010d' % pdu_index
print '...', padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_pdu(pack_pdu(pdu)))),
re.sub('\n *','',
eval('pdu_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_pdu_hex_strings(self):
print ''
"""
Read the hex data, clean it, and unpack it to JSON correctly
"""
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
padded_index = '%010d' % pdu_index
print '...', padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_hex(pdu_hex))),
re.sub('\n *','',
eval('pdu_hex_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_performance(self):
print ''
"""
Pack & unpack 2000 submit_sm PDUs in under 1 second
"""
submit_sm = {
'header': {
'command_length': 0,
'command_id': 'submit_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
'esm_class':0,
'protocol_id':0,
'priority_flag':0,
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
'sm_length':1,
'short_message':'',
},
},
}
start = datetime.now()
for x in range(2000):
x += 1
submit_sm['header']['sequence_number'] = x
sm = 'testing: x = '+str(x)+''
submit_sm['body']['mandatory_parameters']['short_message'] = sm
u = unpack_pdu(pack_pdu(submit_sm))
delta = datetime.now() - start
print '... 2000 pack & unpacks in:', delta
self.assertTrue(delta < timedelta(seconds=1))
class PduBuilderTestCase(unittest.TestCase):
def test_true(self):
print ''
self.assertTrue(True)
if __name__ == '__main__':
esme = ESME()
- esme.connect('localhost', 2777)
+ esme.connect('localhost', 2775)
print esme.state
esme.bind_transmitter('test id', 'abc 123')
#esme.unbind()
#esme.bind_transmitter('test id', 'abc 123')
print esme.state
start = datetime.now()
- for x in range(5):
- esme.submit_sm('gobbledygook')
+ for x in range(3):
+ esme.submit_sm(
+ short_message = 'gobbledygook',
+ destination_addr = '555',
+ )
+ esme.submit_multi(
+ short_message = 'gobbledygook',
+ dest_address = [],
+ )
print esme.state
delta = datetime.now() - start
print delta
esme.disconnect()
print esme.state
#if __name__ == '__main__':
#unittest.main()
|
dmaclay/python-smpp
|
e8ba486f35f3f3ff4d994a49c3f97d7b38de005f
|
connection state
|
diff --git a/src/smpp/esme.py b/src/smpp/esme.py
index af201f6..d6a41ca 100644
--- a/src/smpp/esme.py
+++ b/src/smpp/esme.py
@@ -1,67 +1,90 @@
import socket
from pdu_builder import *
class ESME:
def __init__(self):
- self.state = None
+ self.state = 'CLOSED'
self.sequence_number = 1
self.conn = None
self.system_id = None
self.password = None
def connect(self, host='127.0.0.1', port=2775):
- self.conn = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
- self.conn.connect((host, port))
- self.state = 'OPEN'
+ if self.state in ['CLOSED']:
+ self.conn = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+ self.conn.connect((host, port))
+ self.state = 'OPEN'
def disconnect(self):
- if self.state in ['BOUND_TX', 'BOUND_TR', 'BOUND_TRX']:
+ if self.state in ['BOUND_TX', 'BOUND_RX', 'BOUND_TRX']:
self.__unbind()
- self.conn.close()
- self.state = 'CLOSED'
+ if self.state in ['OPEN']:
+ self.conn.close()
+ self.state = 'CLOSED'
def do_recv(self):
+ resp_pdu = None
length_bin = self.conn.recv(4)
- length = int(binascii.b2a_hex(length_bin),16)
- rest_bin = self.conn.recv(length-4)
- resp_pdu = unpack_pdu(length_bin + rest_bin)
- print '...', resp_pdu['header']['sequence_number'],
- print '>', resp_pdu['header']['command_id'],
- print '...', resp_pdu['header']['command_status']
+ #print 'length_bin', len(length_bin), length_bin
+ if len(length_bin) == 4:
+ length = int(binascii.b2a_hex(length_bin),16)
+ rest_bin = self.conn.recv(length-4)
+ resp_pdu = unpack_pdu(length_bin + rest_bin)
+ print '...', resp_pdu['header']['sequence_number'],
+ print '>', resp_pdu['header']['command_id'],
+ print '...', resp_pdu['header']['command_status']
return resp_pdu
+ def __is_ok(self, pdu, id_check=None):
+ if (isinstance(pdu, dict)
+ and pdu.get('header',{}).get('command_status') == 'ESME_ROK'
+ and (id_check == None
+ or id_check == pdu['header'].get('command_id'))):
+ return True
+ else:
+ return False
+
+
def bind_transmitter(self, system_id=None, password=None):
- if system_id != None: self.system_id = system_id
- if password != None: self.password = password
- pdu = BindTransmitter(sequence_number = self.sequence_number,
- system_id = self.system_id,
- password = self.password)
- self.conn.send(pdu.get_bin())
- self.sequence_number +=1
- self.do_recv()
- self.state = 'BOUND_TX'
+ if self.state in ['OPEN']:
+ if system_id != None: self.system_id = system_id
+ if password != None: self.password = password
+ pdu = BindTransmitter(sequence_number = self.sequence_number,
+ system_id = self.system_id,
+ password = self.password)
+ self.conn.send(pdu.get_bin())
+ self.sequence_number +=1
+ if self.__is_ok(self.do_recv(), 'bind_transmitter_resp'):
+ self.state = 'BOUND_TX'
def __unbind(self):
- pdu = Unbind(sequence_number = self.sequence_number)
- self.conn.send(pdu.get_bin())
- self.sequence_number +=1
- self.do_recv()
- self.state = None
+ if self.state in ['BOUND_TX', 'BOUND_RX', 'BOUND_TRX']:
+ pdu = Unbind(sequence_number = self.sequence_number)
+ self.conn.send(pdu.get_bin())
+ self.sequence_number +=1
+ if self.__is_ok(self.do_recv(), 'unbind_resp'):
+ self.state = 'OPEN'
+
+
+ def unbind(self): # will probably be deprecated
+ self.__unbind()
def submit_sm(self, message=''):
- pdu = SubmitSM(sequence_number = self.sequence_number,
- short_message = message)
- self.conn.send(pdu.get_bin())
- self.sequence_number +=1
- self.do_recv()
+ if self.state in ['BOUND_TX', 'BOUND_TRX']:
+ pdu = SubmitSM(sequence_number = self.sequence_number,
+ short_message = message)
+ self.conn.send(pdu.get_bin())
+ self.sequence_number +=1
+ submit_sm_resp = self.do_recv()
+ #print self.__is_ok(submit_sm_resp, 'submit_sm_resp')
diff --git a/tests.py b/tests.py
index 5fe4e45..f40951f 100644
--- a/tests.py
+++ b/tests.py
@@ -1,174 +1,180 @@
import unittest
from datetime import datetime, timedelta
try:
from smpp.esme import *
except:
from src.smpp.esme import *
from test.pdu import pdu_objects
from test import pdu_asserts
from test.pdu_hex import pdu_hex_strings
from test import pdu_hex_asserts
def unpack_hex(pdu_hex):
"""Unpack PDU hex string and return it as a dictionary"""
return unpack_pdu(binascii.a2b_hex(hexclean(pdu_hex)))
def hexclean(dirtyhex):
"""Remove whitespace, comments & newlines from hex string"""
return re.sub(r'\s','',re.sub(r'#.*\n','\n',dirtyhex))
def prettydump(pdu_obj):
"""Unpack PDU dictionary and dump it as a JSON formatted string"""
return json.dumps(pdu_obj, indent=4, sort_keys=True)
def create_pdu_asserts():
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_pdu(pack_pdu(pdu)))
pstr += "'''"
print pstr
def create_pdu_hex_asserts():
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_hex(pdu_hex))
pstr += "'''"
print pstr
## :w|!python % > test/pdu_asserts.py
#create_pdu_asserts()
#quit()
## :w|!python % > test/pdu_hex_asserts.py
#create_pdu_hex_asserts()
#quit()
class PduTestCase(unittest.TestCase):
def setUp(self):
pass
def tearDown(self):
pass
def test_pack_unpack_pdu_objects(self):
print ''
"""
Take a dictionary, pack and unpack it and dump it as JSON correctly
"""
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
padded_index = '%010d' % pdu_index
print '...', padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_pdu(pack_pdu(pdu)))),
re.sub('\n *','',
eval('pdu_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_pdu_hex_strings(self):
print ''
"""
Read the hex data, clean it, and unpack it to JSON correctly
"""
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
padded_index = '%010d' % pdu_index
print '...', padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_hex(pdu_hex))),
re.sub('\n *','',
eval('pdu_hex_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_performance(self):
print ''
"""
Pack & unpack 2000 submit_sm PDUs in under 1 second
"""
submit_sm = {
'header': {
'command_length': 0,
'command_id': 'submit_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
'esm_class':0,
'protocol_id':0,
'priority_flag':0,
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
'sm_length':1,
'short_message':'',
},
},
}
start = datetime.now()
for x in range(2000):
x += 1
submit_sm['header']['sequence_number'] = x
sm = 'testing: x = '+str(x)+''
submit_sm['body']['mandatory_parameters']['short_message'] = sm
u = unpack_pdu(pack_pdu(submit_sm))
delta = datetime.now() - start
print '... 2000 pack & unpacks in:', delta
self.assertTrue(delta < timedelta(seconds=1))
class PduBuilderTestCase(unittest.TestCase):
def test_true(self):
print ''
self.assertTrue(True)
esme = ESME()
esme.connect('localhost')
+print esme.state
esme.bind_transmitter('test id', 'abc 123')
+#esme.unbind()
+#esme.bind_transmitter('test id', 'abc 123')
+print esme.state
start = datetime.now()
for x in range(5):
esme.submit_sm('gobbledygook')
+ print esme.state
delta = datetime.now() - start
print delta
esme.disconnect()
+print esme.state
#if __name__ == '__main__':
#unittest.main()
|
dmaclay/python-smpp
|
0c11cbf933187951b3b5d245bde79c9b6b3c3dbb
|
unbind is now private
|
diff --git a/src/smpp/esme.py b/src/smpp/esme.py
index fea2a39..af201f6 100644
--- a/src/smpp/esme.py
+++ b/src/smpp/esme.py
@@ -1,59 +1,67 @@
import socket
from pdu_builder import *
class ESME:
def __init__(self):
+ self.state = None
self.sequence_number = 1
self.conn = None
self.system_id = None
self.password = None
- def connect_SMSC(self, host='127.0.0.1', port=2775):
+
+ def connect(self, host='127.0.0.1', port=2775):
self.conn = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
self.conn.connect((host, port))
+ self.state = 'OPEN'
+
- def disconnect_SMSC(self):
+ def disconnect(self):
+ if self.state in ['BOUND_TX', 'BOUND_TR', 'BOUND_TRX']:
+ self.__unbind()
self.conn.close()
+ self.state = 'CLOSED'
+
def do_recv(self):
length_bin = self.conn.recv(4)
length = int(binascii.b2a_hex(length_bin),16)
rest_bin = self.conn.recv(length-4)
- print '...',
- print unpack_pdu(length_bin + rest_bin)['header']['sequence_number'],
- print '>',
- print unpack_pdu(length_bin + rest_bin)['header']['command_id'],
- print '...',
- print unpack_pdu(length_bin + rest_bin)['header']['command_status']
-
- def bind_SMSC(self, system_id=None, password=None):
+ resp_pdu = unpack_pdu(length_bin + rest_bin)
+ print '...', resp_pdu['header']['sequence_number'],
+ print '>', resp_pdu['header']['command_id'],
+ print '...', resp_pdu['header']['command_status']
+ return resp_pdu
+
+
+ def bind_transmitter(self, system_id=None, password=None):
if system_id != None: self.system_id = system_id
if password != None: self.password = password
pdu = BindTransmitter(sequence_number = self.sequence_number,
system_id = self.system_id,
password = self.password)
self.conn.send(pdu.get_bin())
self.sequence_number +=1
self.do_recv()
+ self.state = 'BOUND_TX'
- def unbind_SMSC(self, system_id=None, password=None):
- if system_id != None: self.system_id = system_id
- if password != None: self.password = password
+ def __unbind(self):
pdu = Unbind(sequence_number = self.sequence_number)
self.conn.send(pdu.get_bin())
self.sequence_number +=1
self.do_recv()
+ self.state = None
def submit_sm(self, message=''):
pdu = SubmitSM(sequence_number = self.sequence_number,
short_message = message)
self.conn.send(pdu.get_bin())
self.sequence_number +=1
self.do_recv()
diff --git a/tests.py b/tests.py
index 9be01db..5fe4e45 100644
--- a/tests.py
+++ b/tests.py
@@ -1,175 +1,174 @@
import unittest
from datetime import datetime, timedelta
try:
from smpp.esme import *
except:
from src.smpp.esme import *
from test.pdu import pdu_objects
from test import pdu_asserts
from test.pdu_hex import pdu_hex_strings
from test import pdu_hex_asserts
def unpack_hex(pdu_hex):
"""Unpack PDU hex string and return it as a dictionary"""
return unpack_pdu(binascii.a2b_hex(hexclean(pdu_hex)))
def hexclean(dirtyhex):
"""Remove whitespace, comments & newlines from hex string"""
return re.sub(r'\s','',re.sub(r'#.*\n','\n',dirtyhex))
def prettydump(pdu_obj):
"""Unpack PDU dictionary and dump it as a JSON formatted string"""
return json.dumps(pdu_obj, indent=4, sort_keys=True)
def create_pdu_asserts():
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_pdu(pack_pdu(pdu)))
pstr += "'''"
print pstr
def create_pdu_hex_asserts():
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_hex(pdu_hex))
pstr += "'''"
print pstr
## :w|!python % > test/pdu_asserts.py
#create_pdu_asserts()
#quit()
## :w|!python % > test/pdu_hex_asserts.py
#create_pdu_hex_asserts()
#quit()
class PduTestCase(unittest.TestCase):
def setUp(self):
pass
def tearDown(self):
pass
def test_pack_unpack_pdu_objects(self):
print ''
"""
Take a dictionary, pack and unpack it and dump it as JSON correctly
"""
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
padded_index = '%010d' % pdu_index
print '...', padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_pdu(pack_pdu(pdu)))),
re.sub('\n *','',
eval('pdu_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_pdu_hex_strings(self):
print ''
"""
Read the hex data, clean it, and unpack it to JSON correctly
"""
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
padded_index = '%010d' % pdu_index
print '...', padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_hex(pdu_hex))),
re.sub('\n *','',
eval('pdu_hex_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_performance(self):
print ''
"""
Pack & unpack 2000 submit_sm PDUs in under 1 second
"""
submit_sm = {
'header': {
'command_length': 0,
'command_id': 'submit_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
'esm_class':0,
'protocol_id':0,
'priority_flag':0,
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
'sm_length':1,
'short_message':'',
},
},
}
start = datetime.now()
for x in range(2000):
x += 1
submit_sm['header']['sequence_number'] = x
sm = 'testing: x = '+str(x)+''
submit_sm['body']['mandatory_parameters']['short_message'] = sm
u = unpack_pdu(pack_pdu(submit_sm))
delta = datetime.now() - start
print '... 2000 pack & unpacks in:', delta
self.assertTrue(delta < timedelta(seconds=1))
class PduBuilderTestCase(unittest.TestCase):
def test_true(self):
print ''
self.assertTrue(True)
esme = ESME()
-esme.connect_SMSC('localhost')
-esme.bind_SMSC('test id', 'abc 123')
+esme.connect('localhost')
+esme.bind_transmitter('test id', 'abc 123')
start = datetime.now()
for x in range(5):
esme.submit_sm('gobbledygook')
delta = datetime.now() - start
print delta
-esme.unbind_SMSC()
-esme.disconnect_SMSC()
+esme.disconnect()
#if __name__ == '__main__':
#unittest.main()
|
dmaclay/python-smpp
|
50a59f07cd4e3ca65528aa1c0589fd4c4f88b2a2
|
using builder to bind
|
diff --git a/src/smpp/esme.py b/src/smpp/esme.py
index 75497e7..8c60474 100644
--- a/src/smpp/esme.py
+++ b/src/smpp/esme.py
@@ -1,29 +1,37 @@
import socket
-from pdu import *
+from pdu_builder import *
class ESME:
def __init__(self):
+ self.sequence_number = 1
self.conn = None
+ self.system_id = None
+ self.password = None
def connect_SMSC(self, host='127.0.0.1', port=2775):
self.conn = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
self.conn.connect((host, port))
def disconnect_SMSC(self):
self.conn.close()
- def bind_SMSC(self):
- out_hex = re.sub(r'\s','','''00 00 00 2F 00 00 00 02 00 00 00 00 00 00 00 01 53 4D 50 50 33 54 45 53 54 00 73 65 63 72 65 74 30 38 00 53 55 42 4D 49 54 31 00 00 01 01 00''')
- print '<<<< bind_SMSC out_hex >>>>', out_hex
- out_bin = binascii.a2b_hex(out_hex)
- self.conn.send(out_bin)
+ def bind_SMSC(self, system_id=None, password=None):
+ if system_id != None: self.system_id = system_id
+ if password != None: self.password = password
+ bind = BindTransmitter(
+ sequence_number = self.sequence_number,
+ system_id = self.system_id,
+ password = self.password)
+ self.conn.send(bind.get_bin())
+ self.sequence_number +=1
+
length_bin = self.conn.recv(4)
length = int(binascii.b2a_hex(length_bin),16)
rest_bin = self.conn.recv(length-4)
- unpack_pdu(length_bin + rest_bin)
+ print '<<<<', unpack_pdu(length_bin + rest_bin)
diff --git a/src/smpp/pdu_builder.py b/src/smpp/pdu_builder.py
index 8e20dc8..2cff4ac 100644
--- a/src/smpp/pdu_builder.py
+++ b/src/smpp/pdu_builder.py
@@ -1,142 +1,143 @@
+
from pdu import *
class PDU:
def __init__(self,
command_id,
command_status,
sequence_number = 1,
):
self.obj = {}
header = {}
self.obj['header'] = header
header['command_length'] = 0
header['command_id'] = command_id
header['command_status'] = command_status
header['sequence_number'] = sequence_number
def __add_optional_parameter(self, tag, value):
optional_parameters = self.obj['body'].get('optional_parameters')
if optional_parameters == None:
optional_parameters = []
self.obj['body']['optional_parameters'] = optional_parameters
optional_parameters.append({
'tag':tag,
'length':0,
'value':value,
})
def get_obj(self):
return self.obj
def get_hex(self):
return encode_pdu(self.obj)
def get_bin(self):
return pack_pdu(self.obj)
class BindTransmitter(PDU):
def __init__(self,
- system_id,
- password,
+ sequence_number = 0,
+ system_id = '',
+ password = '',
system_type = '',
interface_version = '',
addr_ton = 0,
addr_npi = 0,
address_range = '',
- sequence_number = 1,
):
PDU.__init__(self,
'bind_transmitter',
'ESME_ROK',
sequence_number)
body = {}
self.obj['body'] = body
mandatory_parameters = {}
body['mandatory_parameters'] = mandatory_parameters
mandatory_parameters['system_id'] = system_id
mandatory_parameters['password'] = password
mandatory_parameters['system_type'] = system_type
mandatory_parameters['interface_version'] = interface_version
mandatory_parameters['addr_ton'] = addr_ton
mandatory_parameters['addr_npi'] = addr_npi
mandatory_parameters['address_range'] = address_range
class SubmitSM(PDU):
def __init__(self,
- sequence_number = 1,
+ sequence_number = 0,
service_type = '',
source_addr_ton = 0,
source_addr_npi = 0,
source_addr = '',
dest_addr_ton = 0,
dest_addr_npi = 0,
destination_addr = '',
esm_class = 0,
protocol_id = 0,
priority_flag = 0,
schedule_delivery_time = '',
validity_period = '',
registered_delivery = 0,
replace_if_present_flag = 0,
data_coding = 0,
sm_default_msg_id = 0,
sm_length = 0,
short_message = None,
):
PDU.__init__(self,
'submit_sm',
'ESME_ROK',
sequence_number)
body = {}
self.obj['body'] = body
mandatory_parameters = {}
body['mandatory_parameters'] = mandatory_parameters
mandatory_parameters['service_type'] = service_type
mandatory_parameters['source_addr_ton'] = source_addr_ton
mandatory_parameters['source_addr_npi'] = source_addr_npi
mandatory_parameters['source_addr'] = source_addr
mandatory_parameters['dest_addr_ton'] = dest_addr_ton
mandatory_parameters['dest_addr_npi'] = dest_addr_npi
mandatory_parameters['destination_addr'] = destination_addr
mandatory_parameters['esm_class'] = esm_class
mandatory_parameters['protocol_id'] = protocol_id
mandatory_parameters['priority_flag'] = priority_flag
mandatory_parameters['schedule_delivery_time'] = schedule_delivery_time
mandatory_parameters['validity_period'] = validity_period
mandatory_parameters['registered_delivery'] = registered_delivery
mandatory_parameters['replace_if_present_flag'] = replace_if_present_flag
mandatory_parameters['data_coding'] = data_coding
mandatory_parameters['sm_default_msg_id'] = sm_default_msg_id
mandatory_parameters['sm_length'] = sm_length
mandatory_parameters['short_message'] = short_message
def add_message_payload(self, value):
self.obj['body']['mandatory_parameters']['sm_length'] = 0
self.obj['body']['mandatory_parameters']['short_message'] = None
self._PDU__add_optional_parameter('message_payload', value)
-bind = BindTransmitter('test_id', 'abc123')
+bind = BindTransmitter(system_id='test_id', password='abc123')
print bind.get_obj()
print bind.get_hex()
print bind.get_bin()
#print json.dumps(bind.get_obj(), indent=4, sort_keys=True)
#print json.dumps(decode_pdu(bind.get_hex()), indent=4, sort_keys=True)
print json.dumps(unpack_pdu(bind.get_bin()), indent=4, sort_keys=True)
sm = SubmitSM(short_message='testing testing')
print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
sm.add_message_payload('616263646566676869')
print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
diff --git a/tests.py b/tests.py
index 6f4eef3..7a21cff 100644
--- a/tests.py
+++ b/tests.py
@@ -1,169 +1,169 @@
import unittest
from datetime import datetime, timedelta
try:
from smpp.esme import *
except:
from src.smpp.esme import *
from test.pdu import pdu_objects
from test import pdu_asserts
from test.pdu_hex import pdu_hex_strings
from test import pdu_hex_asserts
def unpack_hex(pdu_hex):
"""Unpack PDU hex string and return it as a dictionary"""
return unpack_pdu(binascii.a2b_hex(hexclean(pdu_hex)))
def hexclean(dirtyhex):
"""Remove whitespace, comments & newlines from hex string"""
return re.sub(r'\s','',re.sub(r'#.*\n','\n',dirtyhex))
def prettydump(pdu_obj):
"""Unpack PDU dictionary and dump it as a JSON formatted string"""
return json.dumps(pdu_obj, indent=4, sort_keys=True)
def create_pdu_asserts():
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_pdu(pack_pdu(pdu)))
pstr += "'''"
print pstr
def create_pdu_hex_asserts():
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_hex(pdu_hex))
pstr += "'''"
print pstr
## :w|!python % > test/pdu_asserts.py
#create_pdu_asserts()
#quit()
## :w|!python % > test/pdu_hex_asserts.py
#create_pdu_hex_asserts()
#quit()
class PduTestCase(unittest.TestCase):
def setUp(self):
pass
def tearDown(self):
pass
def test_pack_unpack_pdu_objects(self):
print ''
"""
Take a dictionary, pack and unpack it and dump it as JSON correctly
"""
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
padded_index = '%010d' % pdu_index
print '...', padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_pdu(pack_pdu(pdu)))),
re.sub('\n *','',
eval('pdu_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_pdu_hex_strings(self):
print ''
"""
Read the hex data, clean it, and unpack it to JSON correctly
"""
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
padded_index = '%010d' % pdu_index
print '...', padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_hex(pdu_hex))),
re.sub('\n *','',
eval('pdu_hex_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_performance(self):
print ''
"""
Pack & unpack 2000 submit_sm PDUs in under 1 second
"""
submit_sm = {
'header': {
'command_length': 0,
'command_id': 'submit_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
'esm_class':0,
'protocol_id':0,
'priority_flag':0,
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
'sm_length':1,
'short_message':'',
},
},
}
start = datetime.now()
for x in range(2000):
x += 1
submit_sm['header']['sequence_number'] = x
sm = 'testing: x = '+str(x)+''
submit_sm['body']['mandatory_parameters']['short_message'] = sm
u = unpack_pdu(pack_pdu(submit_sm))
delta = datetime.now() - start
print '... 2000 pack & unpacks in:', delta
self.assertTrue(delta < timedelta(seconds=1))
class PduBuilderTestCase(unittest.TestCase):
def test_true(self):
print ''
self.assertTrue(True)
-#esme = ESME()
-#esme.connect_SMSC('localhost')
-#esme.bind_SMSC()
-#esme.disconnect_SMSC()
+esme = ESME()
+esme.connect_SMSC('localhost')
+esme.bind_SMSC('test id', 'abc 123')
+esme.disconnect_SMSC()
-if __name__ == '__main__':
- unittest.main()
+#if __name__ == '__main__':
+ #unittest.main()
|
dmaclay/python-smpp
|
efaf44d5ccea576ca458ea6498ec561396133afe
|
short_message can be set to None/null
|
diff --git a/test/pdu.py b/test/pdu.py
index e34992e..be771cf 100644
--- a/test/pdu.py
+++ b/test/pdu.py
@@ -1,515 +1,516 @@
pdu_objects = [
{
'header': {
'command_length': 0,
'command_id': 'bind_transmitter',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'system_id':'test_system',
'password':'abc123',
'system_type':'',
'interface_version':'',
'addr_ton':1,
'addr_npi':1,
'address_range':'',
},
},
},
{
'header': {
'command_length': 0,
'command_id': 'bind_transmitter_resp',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'system_id':'test_system',
},
},
},
{
'header': {
'command_length': 0,
'command_id': 'bind_receiver',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'system_id':'test_system',
'password':'abc123',
'system_type':'',
'interface_version':'',
'addr_ton':1,
'addr_npi':1,
'address_range':'',
},
},
},
{
'header': {
'command_length': 0,
'command_id': 'bind_receiver_resp',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'system_id':'test_system',
},
},
},
{
'header': {
'command_length': 0,
'command_id': 'bind_transceiver',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'system_id':'test_system',
'password':'abc123',
'system_type':'',
'interface_version':'',
'addr_ton':1,
'addr_npi':1,
'address_range':'',
},
},
},
{
'header': {
'command_length': 0,
'command_id': 'bind_transceiver_resp',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'system_id':'test_system',
},
},
},
{
'header': {
'command_length': 0,
'command_id': 'outbind',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'system_id':'test_system',
'password':'abc123',
},
},
},
{
'header': {
'command_length': 0,
'command_id': 'unbind',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
},
{
'header': {
'command_length': 0,
'command_id': 'unbind_resp',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
},
{
'header': {
'command_length': 0,
'command_id': 'generic_nack',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
},
{
'header': {
'command_length': 0,
'command_id': 'submit_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
'esm_class':0,
'protocol_id':0,
'priority_flag':0,
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
'sm_length':1,
'short_message':'testing 123',
},
},
},
{
'header': {
'command_length': 0,
'command_id': 'submit_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
'esm_class':0,
'protocol_id':0,
'priority_flag':0,
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
'sm_length':0,
+ 'short_message':None,
# 'short_message' can be of zero length
},
'optional_parameters': [
{
'tag':'message_payload',
'length':0,
'value':'5666',
},
],
},
},
#]
#breaker = [
{
'header': {
'command_length': 0,
'command_id': 'submit_sm_resp',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'message_id':'',
},
},
},
{
'header': {
'command_length': 0,
'command_id': 'submit_sm_resp',
'command_status': 'ESME_RSYSERR',
'sequence_number': 0,
},
# submit_sm_resp can have no body for failures
},
{
'header': {
'command_length': 0,
'command_id': 'submit_multi',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'number_of_dests':0,
'dest_address':[
{
'dest_flag':1,
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'the address'
},
{
'dest_flag':2,
'dl_name':'the list',
},
{
'dest_flag':2,
'dl_name':'the other list',
},
#{}
],
'esm_class':0,
'protocol_id':0,
'priority_flag':0,
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
'sm_length':1,
'short_message':'testing 123',
},
},
},
{
'header': {
'command_length': 0,
'command_id': 'submit_multi_resp',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'message_id':'',
'no_unsuccess':5,
'unsuccess_sme':[
{
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
'error_status_code':0,
},
{
'dest_addr_ton':3,
'dest_addr_npi':1,
'destination_addr':'555',
'error_status_code':0,
},
],
},
},
},
#]
#breaker = [
{
'header': {
'command_length': 0,
'command_id': 'deliver_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
'esm_class':0,
'protocol_id':0,
'priority_flag':0,
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
'sm_length':1,
'short_message':'',
},
},
},
{
'header': {
'command_length': 0,
'command_id': 'deliver_sm_resp',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'message_id':'',
},
},
},
{
'header': {
'command_length': 0,
'command_id': 'data_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
'esm_class':0,
'registered_delivery':0,
'data_coding':0,
},
'optional_parameters': [
{
'tag':'message_payload',
'length':0,
'value':'',
},
],
},
},
{
'header': {
'command_length': 0,
'command_id': 'data_sm_resp',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'message_id':'',
},
},
},
{
'header': {
'command_length': 0,
'command_id': 'query_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'message_id':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
},
},
},
{
'header': {
'command_length': 0,
'command_id': 'query_sm_resp',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'message_id':'',
'final_date':'',
'message_state':0,
'error_code':0,
},
},
},
{
'header': {
'command_length': 0,
'command_id': 'cancel_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'message_id':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
},
},
},
{
'header': {
'command_length': 0,
'command_id': 'cancel_sm_resp',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
},
{
'header': {
'command_length': 0,
'command_id': 'replace_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'message_id':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
'sm_length':1,
'short_message':'is this an = sign?',
},
},
},
{
'header': {
'command_length': 0,
'command_id': 'replace_sm_resp',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
},
{
'header': {
'command_length': 0,
'command_id': 'enquire_link',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
},
{
'header': {
'command_length': 0,
'command_id': 'enquire_link_resp',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
},
{
'header': {
'command_length': 0,
'command_id': 'alert_notification',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'source_addr_ton':'international',
'source_addr_npi':1,
'source_addr':'',
'esme_addr_ton':9,
'esme_addr_npi':'',
'esme_addr':'',
},
},
},
]
|
dmaclay/python-smpp
|
ac16057c24da2b938fdf0b26ec18f3b929660b74
|
PduBuilderTestCase
|
diff --git a/tests.py b/tests.py
index b817c77..6f4eef3 100644
--- a/tests.py
+++ b/tests.py
@@ -1,168 +1,169 @@
import unittest
from datetime import datetime, timedelta
try:
from smpp.esme import *
except:
from src.smpp.esme import *
from test.pdu import pdu_objects
from test import pdu_asserts
from test.pdu_hex import pdu_hex_strings
from test import pdu_hex_asserts
def unpack_hex(pdu_hex):
"""Unpack PDU hex string and return it as a dictionary"""
return unpack_pdu(binascii.a2b_hex(hexclean(pdu_hex)))
def hexclean(dirtyhex):
"""Remove whitespace, comments & newlines from hex string"""
return re.sub(r'\s','',re.sub(r'#.*\n','\n',dirtyhex))
def prettydump(pdu_obj):
"""Unpack PDU dictionary and dump it as a JSON formatted string"""
return json.dumps(pdu_obj, indent=4, sort_keys=True)
def create_pdu_asserts():
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_pdu(pack_pdu(pdu)))
pstr += "'''"
print pstr
def create_pdu_hex_asserts():
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_hex(pdu_hex))
pstr += "'''"
print pstr
## :w|!python % > test/pdu_asserts.py
#create_pdu_asserts()
#quit()
## :w|!python % > test/pdu_hex_asserts.py
#create_pdu_hex_asserts()
#quit()
class PduTestCase(unittest.TestCase):
def setUp(self):
pass
def tearDown(self):
pass
def test_pack_unpack_pdu_objects(self):
print ''
"""
Take a dictionary, pack and unpack it and dump it as JSON correctly
"""
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
padded_index = '%010d' % pdu_index
- print padded_index
+ print '...', padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_pdu(pack_pdu(pdu)))),
re.sub('\n *','',
eval('pdu_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_pdu_hex_strings(self):
print ''
"""
Read the hex data, clean it, and unpack it to JSON correctly
"""
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
padded_index = '%010d' % pdu_index
- print padded_index
+ print '...', padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_hex(pdu_hex))),
re.sub('\n *','',
eval('pdu_hex_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_performance(self):
print ''
"""
Pack & unpack 2000 submit_sm PDUs in under 1 second
"""
submit_sm = {
'header': {
'command_length': 0,
'command_id': 'submit_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
'esm_class':0,
'protocol_id':0,
'priority_flag':0,
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
'sm_length':1,
'short_message':'',
},
},
}
start = datetime.now()
for x in range(2000):
x += 1
submit_sm['header']['sequence_number'] = x
sm = 'testing: x = '+str(x)+''
submit_sm['body']['mandatory_parameters']['short_message'] = sm
u = unpack_pdu(pack_pdu(submit_sm))
delta = datetime.now() - start
- print '2000 pack & unpacks in:', delta
+ print '... 2000 pack & unpacks in:', delta
self.assertTrue(delta < timedelta(seconds=1))
class PduBuilderTestCase(unittest.TestCase):
def test_true(self):
+ print ''
self.assertTrue(True)
#esme = ESME()
#esme.connect_SMSC('localhost')
#esme.bind_SMSC()
#esme.disconnect_SMSC()
if __name__ == '__main__':
unittest.main()
|
dmaclay/python-smpp
|
57f577e7a6de47f6fb6ad380e20e1b2846b5981d
|
PduBuilderTestCase
|
diff --git a/tests.py b/tests.py
index db2748c..b817c77 100644
--- a/tests.py
+++ b/tests.py
@@ -1,161 +1,168 @@
import unittest
from datetime import datetime, timedelta
try:
from smpp.esme import *
except:
from src.smpp.esme import *
from test.pdu import pdu_objects
from test import pdu_asserts
from test.pdu_hex import pdu_hex_strings
from test import pdu_hex_asserts
def unpack_hex(pdu_hex):
"""Unpack PDU hex string and return it as a dictionary"""
return unpack_pdu(binascii.a2b_hex(hexclean(pdu_hex)))
def hexclean(dirtyhex):
"""Remove whitespace, comments & newlines from hex string"""
return re.sub(r'\s','',re.sub(r'#.*\n','\n',dirtyhex))
def prettydump(pdu_obj):
"""Unpack PDU dictionary and dump it as a JSON formatted string"""
return json.dumps(pdu_obj, indent=4, sort_keys=True)
def create_pdu_asserts():
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_pdu(pack_pdu(pdu)))
pstr += "'''"
print pstr
def create_pdu_hex_asserts():
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_hex(pdu_hex))
pstr += "'''"
print pstr
## :w|!python % > test/pdu_asserts.py
#create_pdu_asserts()
#quit()
## :w|!python % > test/pdu_hex_asserts.py
#create_pdu_hex_asserts()
#quit()
-class SmppTestCase(unittest.TestCase):
+class PduTestCase(unittest.TestCase):
def setUp(self):
pass
def tearDown(self):
pass
def test_pack_unpack_pdu_objects(self):
+ print ''
"""
- pdu_objects ... take a dictionary, pack and unpack it and dump it as JSON correctly
+ Take a dictionary, pack and unpack it and dump it as JSON correctly
"""
- print ''
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
padded_index = '%010d' % pdu_index
print padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_pdu(pack_pdu(pdu)))),
re.sub('\n *','',
eval('pdu_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_pdu_hex_strings(self):
+ print ''
"""
- pdu_hex_strings ... read the hex data, clean it, and unpack it to JSON correctly
+ Read the hex data, clean it, and unpack it to JSON correctly
"""
- print ''
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
padded_index = '%010d' % pdu_index
print padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_hex(pdu_hex))),
re.sub('\n *','',
eval('pdu_hex_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_performance(self):
+ print ''
"""
- pack_unpack_performance ... pack & unpack 2000 submit_sm PDUs in under 1 second
+ Pack & unpack 2000 submit_sm PDUs in under 1 second
"""
- print ''
submit_sm = {
'header': {
'command_length': 0,
'command_id': 'submit_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
'esm_class':0,
'protocol_id':0,
'priority_flag':0,
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
'sm_length':1,
'short_message':'',
},
},
}
start = datetime.now()
for x in range(2000):
x += 1
submit_sm['header']['sequence_number'] = x
sm = 'testing: x = '+str(x)+''
submit_sm['body']['mandatory_parameters']['short_message'] = sm
u = unpack_pdu(pack_pdu(submit_sm))
delta = datetime.now() - start
print '2000 pack & unpacks in:', delta
self.assertTrue(delta < timedelta(seconds=1))
+class PduBuilderTestCase(unittest.TestCase):
+
+ def test_true(self):
+ self.assertTrue(True)
+
+
+
#esme = ESME()
#esme.connect_SMSC('localhost')
#esme.bind_SMSC()
#esme.disconnect_SMSC()
if __name__ == '__main__':
unittest.main()
|
dmaclay/python-smpp
|
6650ba517465897d52af9a6feac294671a78d697
|
ton & npi default to 0
|
diff --git a/src/smpp/pdu_builder.py b/src/smpp/pdu_builder.py
index 17ed146..8e20dc8 100644
--- a/src/smpp/pdu_builder.py
+++ b/src/smpp/pdu_builder.py
@@ -1,142 +1,142 @@
from pdu import *
class PDU:
def __init__(self,
command_id,
command_status,
sequence_number = 1,
):
self.obj = {}
header = {}
self.obj['header'] = header
header['command_length'] = 0
header['command_id'] = command_id
header['command_status'] = command_status
header['sequence_number'] = sequence_number
def __add_optional_parameter(self, tag, value):
optional_parameters = self.obj['body'].get('optional_parameters')
if optional_parameters == None:
optional_parameters = []
self.obj['body']['optional_parameters'] = optional_parameters
optional_parameters.append({
'tag':tag,
'length':0,
'value':value,
})
def get_obj(self):
return self.obj
def get_hex(self):
return encode_pdu(self.obj)
def get_bin(self):
return pack_pdu(self.obj)
class BindTransmitter(PDU):
def __init__(self,
system_id,
password,
system_type = '',
interface_version = '',
- addr_ton = 1,
- addr_npi = 1,
+ addr_ton = 0,
+ addr_npi = 0,
address_range = '',
sequence_number = 1,
):
PDU.__init__(self,
'bind_transmitter',
'ESME_ROK',
sequence_number)
body = {}
self.obj['body'] = body
mandatory_parameters = {}
body['mandatory_parameters'] = mandatory_parameters
mandatory_parameters['system_id'] = system_id
mandatory_parameters['password'] = password
mandatory_parameters['system_type'] = system_type
mandatory_parameters['interface_version'] = interface_version
mandatory_parameters['addr_ton'] = addr_ton
mandatory_parameters['addr_npi'] = addr_npi
mandatory_parameters['address_range'] = address_range
class SubmitSM(PDU):
def __init__(self,
sequence_number = 1,
service_type = '',
- source_addr_ton = 1,
- source_addr_npi = 1,
+ source_addr_ton = 0,
+ source_addr_npi = 0,
source_addr = '',
- dest_addr_ton = 1,
- dest_addr_npi = 1,
+ dest_addr_ton = 0,
+ dest_addr_npi = 0,
destination_addr = '',
esm_class = 0,
protocol_id = 0,
priority_flag = 0,
schedule_delivery_time = '',
validity_period = '',
registered_delivery = 0,
replace_if_present_flag = 0,
data_coding = 0,
sm_default_msg_id = 0,
sm_length = 0,
short_message = None,
):
PDU.__init__(self,
'submit_sm',
'ESME_ROK',
sequence_number)
body = {}
self.obj['body'] = body
mandatory_parameters = {}
body['mandatory_parameters'] = mandatory_parameters
mandatory_parameters['service_type'] = service_type
mandatory_parameters['source_addr_ton'] = source_addr_ton
mandatory_parameters['source_addr_npi'] = source_addr_npi
mandatory_parameters['source_addr'] = source_addr
mandatory_parameters['dest_addr_ton'] = dest_addr_ton
mandatory_parameters['dest_addr_npi'] = dest_addr_npi
mandatory_parameters['destination_addr'] = destination_addr
mandatory_parameters['esm_class'] = esm_class
mandatory_parameters['protocol_id'] = protocol_id
mandatory_parameters['priority_flag'] = priority_flag
mandatory_parameters['schedule_delivery_time'] = schedule_delivery_time
mandatory_parameters['validity_period'] = validity_period
mandatory_parameters['registered_delivery'] = registered_delivery
mandatory_parameters['replace_if_present_flag'] = replace_if_present_flag
mandatory_parameters['data_coding'] = data_coding
mandatory_parameters['sm_default_msg_id'] = sm_default_msg_id
mandatory_parameters['sm_length'] = sm_length
mandatory_parameters['short_message'] = short_message
def add_message_payload(self, value):
self.obj['body']['mandatory_parameters']['sm_length'] = 0
self.obj['body']['mandatory_parameters']['short_message'] = None
self._PDU__add_optional_parameter('message_payload', value)
bind = BindTransmitter('test_id', 'abc123')
print bind.get_obj()
print bind.get_hex()
print bind.get_bin()
#print json.dumps(bind.get_obj(), indent=4, sort_keys=True)
#print json.dumps(decode_pdu(bind.get_hex()), indent=4, sort_keys=True)
-#print json.dumps(unpack_pdu(bind.get_bin()), indent=4, sort_keys=True)
+print json.dumps(unpack_pdu(bind.get_bin()), indent=4, sort_keys=True)
sm = SubmitSM(short_message='testing testing')
print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
sm.add_message_payload('616263646566676869')
print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
|
dmaclay/python-smpp
|
50c92619df267cf592d48c58c4e1330425f0c733
|
bind_transmitter & submit_sm
|
diff --git a/src/smpp/pdu_builder.py b/src/smpp/pdu_builder.py
index e69de29..17ed146 100644
--- a/src/smpp/pdu_builder.py
+++ b/src/smpp/pdu_builder.py
@@ -0,0 +1,142 @@
+from pdu import *
+
+class PDU:
+
+ def __init__(self,
+ command_id,
+ command_status,
+ sequence_number = 1,
+ ):
+ self.obj = {}
+ header = {}
+ self.obj['header'] = header
+ header['command_length'] = 0
+ header['command_id'] = command_id
+ header['command_status'] = command_status
+ header['sequence_number'] = sequence_number
+
+
+ def __add_optional_parameter(self, tag, value):
+ optional_parameters = self.obj['body'].get('optional_parameters')
+ if optional_parameters == None:
+ optional_parameters = []
+ self.obj['body']['optional_parameters'] = optional_parameters
+ optional_parameters.append({
+ 'tag':tag,
+ 'length':0,
+ 'value':value,
+ })
+
+
+ def get_obj(self):
+ return self.obj
+
+
+ def get_hex(self):
+ return encode_pdu(self.obj)
+
+
+ def get_bin(self):
+ return pack_pdu(self.obj)
+
+
+class BindTransmitter(PDU):
+
+ def __init__(self,
+ system_id,
+ password,
+ system_type = '',
+ interface_version = '',
+ addr_ton = 1,
+ addr_npi = 1,
+ address_range = '',
+ sequence_number = 1,
+ ):
+ PDU.__init__(self,
+ 'bind_transmitter',
+ 'ESME_ROK',
+ sequence_number)
+ body = {}
+ self.obj['body'] = body
+ mandatory_parameters = {}
+ body['mandatory_parameters'] = mandatory_parameters
+ mandatory_parameters['system_id'] = system_id
+ mandatory_parameters['password'] = password
+ mandatory_parameters['system_type'] = system_type
+ mandatory_parameters['interface_version'] = interface_version
+ mandatory_parameters['addr_ton'] = addr_ton
+ mandatory_parameters['addr_npi'] = addr_npi
+ mandatory_parameters['address_range'] = address_range
+
+
+class SubmitSM(PDU):
+
+ def __init__(self,
+ sequence_number = 1,
+ service_type = '',
+ source_addr_ton = 1,
+ source_addr_npi = 1,
+ source_addr = '',
+ dest_addr_ton = 1,
+ dest_addr_npi = 1,
+ destination_addr = '',
+ esm_class = 0,
+ protocol_id = 0,
+ priority_flag = 0,
+ schedule_delivery_time = '',
+ validity_period = '',
+ registered_delivery = 0,
+ replace_if_present_flag = 0,
+ data_coding = 0,
+ sm_default_msg_id = 0,
+ sm_length = 0,
+ short_message = None,
+ ):
+ PDU.__init__(self,
+ 'submit_sm',
+ 'ESME_ROK',
+ sequence_number)
+ body = {}
+ self.obj['body'] = body
+ mandatory_parameters = {}
+ body['mandatory_parameters'] = mandatory_parameters
+ mandatory_parameters['service_type'] = service_type
+ mandatory_parameters['source_addr_ton'] = source_addr_ton
+ mandatory_parameters['source_addr_npi'] = source_addr_npi
+ mandatory_parameters['source_addr'] = source_addr
+ mandatory_parameters['dest_addr_ton'] = dest_addr_ton
+ mandatory_parameters['dest_addr_npi'] = dest_addr_npi
+ mandatory_parameters['destination_addr'] = destination_addr
+ mandatory_parameters['esm_class'] = esm_class
+ mandatory_parameters['protocol_id'] = protocol_id
+ mandatory_parameters['priority_flag'] = priority_flag
+ mandatory_parameters['schedule_delivery_time'] = schedule_delivery_time
+ mandatory_parameters['validity_period'] = validity_period
+ mandatory_parameters['registered_delivery'] = registered_delivery
+ mandatory_parameters['replace_if_present_flag'] = replace_if_present_flag
+ mandatory_parameters['data_coding'] = data_coding
+ mandatory_parameters['sm_default_msg_id'] = sm_default_msg_id
+ mandatory_parameters['sm_length'] = sm_length
+ mandatory_parameters['short_message'] = short_message
+
+
+ def add_message_payload(self, value):
+ self.obj['body']['mandatory_parameters']['sm_length'] = 0
+ self.obj['body']['mandatory_parameters']['short_message'] = None
+ self._PDU__add_optional_parameter('message_payload', value)
+
+
+
+
+bind = BindTransmitter('test_id', 'abc123')
+print bind.get_obj()
+print bind.get_hex()
+print bind.get_bin()
+#print json.dumps(bind.get_obj(), indent=4, sort_keys=True)
+#print json.dumps(decode_pdu(bind.get_hex()), indent=4, sort_keys=True)
+#print json.dumps(unpack_pdu(bind.get_bin()), indent=4, sort_keys=True)
+
+sm = SubmitSM(short_message='testing testing')
+print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
+sm.add_message_payload('616263646566676869')
+print json.dumps(unpack_pdu(sm.get_bin()), indent=4, sort_keys=True)
|
dmaclay/python-smpp
|
941f0be15cbcd7a68975d635de3b6872bca57a0a
|
no sm = null, not ''
|
diff --git a/src/smpp/pdu.py b/src/smpp/pdu.py
index 979af1e..97cba18 100644
--- a/src/smpp/pdu.py
+++ b/src/smpp/pdu.py
@@ -357,680 +357,685 @@ command_status_by_hex = {
'0000000e':{'hex':'0000000e', 'name':'ESME_RINVPASWD', 'description':'Invalid password'},
'0000000f':{'hex':'0000000f', 'name':'ESME_RINVSYSID', 'description':'Invalid System ID'},
'00000011':{'hex':'00000011', 'name':'ESME_RCANCELFAIL', 'description':'Cancel SM Failed'},
'00000013':{'hex':'00000013', 'name':'ESME_RREPLACEFAIL', 'description':'Replace SM Failed'},
'00000014':{'hex':'00000014', 'name':'ESME_RMSGQFUL', 'description':'Message queue full'},
'00000015':{'hex':'00000015', 'name':'ESME_RINVSERTYP', 'description':'Invalid service type'},
'00000033':{'hex':'00000033', 'name':'ESME_RINVNUMDESTS', 'description':'Invalid number of destinations'},
'00000034':{'hex':'00000034', 'name':'ESME_RINVDLNAME', 'description':'Invalid distribution list name'},
'00000040':{'hex':'00000040', 'name':'ESME_RINVDESTFLAG', 'description':'Destination flag is invalid (submit_multi)'},
'00000042':{'hex':'00000042', 'name':'ESME_RINVSUBREP', 'description':"Invalid `submit with replace' request (i.e. submit_sm with replace_if_present_flag set)"},
'00000043':{'hex':'00000043', 'name':'ESME_RINVESMCLASS', 'description':'Invalid esm_class field data'},
'00000044':{'hex':'00000044', 'name':'ESME_RCNTSUBDL', 'description':'Cannot submit to distribution list'},
'00000045':{'hex':'00000045', 'name':'ESME_RSUBMITFAIL', 'description':'submit_sm or submit_multi failed'},
'00000048':{'hex':'00000048', 'name':'ESME_RINVSRCTON', 'description':'Invalid source address TON'},
'00000049':{'hex':'00000049', 'name':'ESME_RINVSRCNPI', 'description':'Invalid source address NPI'},
'00000050':{'hex':'00000050', 'name':'ESME_RINVDSTTON', 'description':'Invalid destination address TON'},
'00000051':{'hex':'00000051', 'name':'ESME_RINVDSTNPI', 'description':'Invalid destination address NPI'},
'00000053':{'hex':'00000053', 'name':'ESME_RINVSYSTYP', 'description':'Invalid system_type field'},
'00000054':{'hex':'00000054', 'name':'ESME_RINVREPFLAG', 'description':'Invalid replace_if_present flag'},
'00000055':{'hex':'00000055', 'name':'ESME_RINVNUMMSGS', 'description':'Invalid number of messages'},
'00000058':{'hex':'00000058', 'name':'ESME_RTHROTTLED', 'description':'Throttling error (ESME has exceeded allowed message limits)'},
'00000061':{'hex':'00000061', 'name':'ESME_RINVSCHED', 'description':'Invalid scheduled delivery time'},
'00000062':{'hex':'00000062', 'name':'ESME_RINVEXPIRY', 'description':'Invalid message validity period (expiry time)'},
'00000063':{'hex':'00000063', 'name':'ESME_RINVDFTMSGID', 'description':'Predefined message invalid or not found'},
'00000064':{'hex':'00000064', 'name':'ESME_RX_T_APPN', 'description':'ESME Receiver Temporary App Error Code'},
'00000065':{'hex':'00000065', 'name':'ESME_RX_P_APPN', 'description':'ESME Receiver Permanent App Error Code'},
'00000066':{'hex':'00000066', 'name':'ESME_RX_R_APPN', 'description':'ESME Receiver Reject Message Error Code'},
'00000067':{'hex':'00000067', 'name':'ESME_RQUERYFAIL', 'description':'query_sm request failed'},
'000000c0':{'hex':'000000c0', 'name':'ESME_RINVOPTPARSTREAM', 'description':'Error in the optional part of the PDU Body'},
'000000c1':{'hex':'000000c1', 'name':'ESME_ROPTPARNOTALLWD', 'description':'Optional paramenter not allowed'},
'000000c2':{'hex':'000000c2', 'name':'ESME_RINVPARLEN', 'description':'Invalid parameter length'},
'000000c3':{'hex':'000000c3', 'name':'ESME_RMISSINGOPTPARAM', 'description':'Expected optional parameter missing'},
'000000c4':{'hex':'000000c4', 'name':'ESME_RINVOPTPARAMVAL', 'description':'Invalid optional parameter value'},
'000000fe':{'hex':'000000fe', 'name':'ESME_RDELIVERYFAILURE', 'description':'Delivery Failure (used for data_sm_resp)'},
'000000ff':{'hex':'000000ff', 'name':'ESME_RUNKNOWNERR', 'description':'Unknown error'}
}
def command_status_name_by_hex(x):
return command_status_by_hex.get(x,{}).get('name')
command_status_by_name = {
'ESME_ROK' :{'hex':'00000000', 'name':'ESME_ROK', 'description':'No error'},
'ESME_RINVMSGLEN' :{'hex':'00000001', 'name':'ESME_RINVMSGLEN', 'description':'Message Length is invalid'},
'ESME_RINVCMDLEN' :{'hex':'00000002', 'name':'ESME_RINVCMDLEN', 'description':'Command Length is invalid'},
'ESME_RINVCMDID' :{'hex':'00000003', 'name':'ESME_RINVCMDID', 'description':'Invalid Command ID'},
'ESME_RINVBNDSTS' :{'hex':'00000004', 'name':'ESME_RINVBNDSTS', 'description':'Incorrect BIND Status for given command'},
'ESME_RALYBND' :{'hex':'00000005', 'name':'ESME_RALYBND', 'description':'ESME Already in bound state'},
'ESME_RINVPRTFLG' :{'hex':'00000006', 'name':'ESME_RINVPRTFLG', 'description':'Invalid priority flag'},
'ESME_RINVREGDLVFLG' :{'hex':'00000007', 'name':'ESME_RINVREGDLVFLG', 'description':'Invalid registered delivery flag'},
'ESME_RSYSERR' :{'hex':'00000008', 'name':'ESME_RSYSERR', 'description':'System Error'},
'ESME_RINVSRCADR' :{'hex':'0000000a', 'name':'ESME_RINVSRCADR', 'description':'Invalid source address'},
'ESME_RINVDSTADR' :{'hex':'0000000b', 'name':'ESME_RINVDSTADR', 'description':'Invalid destination address'},
'ESME_RINVMSGID' :{'hex':'0000000c', 'name':'ESME_RINVMSGID', 'description':'Message ID is invalid'},
'ESME_RBINDFAIL' :{'hex':'0000000d', 'name':'ESME_RBINDFAIL', 'description':'Bind failed'},
'ESME_RINVPASWD' :{'hex':'0000000e', 'name':'ESME_RINVPASWD', 'description':'Invalid password'},
'ESME_RINVSYSID' :{'hex':'0000000f', 'name':'ESME_RINVSYSID', 'description':'Invalid System ID'},
'ESME_RCANCELFAIL' :{'hex':'00000011', 'name':'ESME_RCANCELFAIL', 'description':'Cancel SM Failed'},
'ESME_RREPLACEFAIL' :{'hex':'00000013', 'name':'ESME_RREPLACEFAIL', 'description':'Replace SM Failed'},
'ESME_RMSGQFUL' :{'hex':'00000014', 'name':'ESME_RMSGQFUL', 'description':'Message queue full'},
'ESME_RINVSERTYP' :{'hex':'00000015', 'name':'ESME_RINVSERTYP', 'description':'Invalid service type'},
'ESME_RINVNUMDESTS' :{'hex':'00000033', 'name':'ESME_RINVNUMDESTS', 'description':'Invalid number of destinations'},
'ESME_RINVDLNAME' :{'hex':'00000034', 'name':'ESME_RINVDLNAME', 'description':'Invalid distribution list name'},
'ESME_RINVDESTFLAG' :{'hex':'00000040', 'name':'ESME_RINVDESTFLAG', 'description':'Destination flag is invalid (submit_multi)'},
'ESME_RINVSUBREP' :{'hex':'00000042', 'name':'ESME_RINVSUBREP', 'description':"Invalid `submit with replace' request (i.e. submit_sm with replace_if_present_flag set)"},
'ESME_RINVESMCLASS' :{'hex':'00000043', 'name':'ESME_RINVESMCLASS', 'description':'Invalid esm_class field data'},
'ESME_RCNTSUBDL' :{'hex':'00000044', 'name':'ESME_RCNTSUBDL', 'description':'Cannot submit to distribution list'},
'ESME_RSUBMITFAIL' :{'hex':'00000045', 'name':'ESME_RSUBMITFAIL', 'description':'submit_sm or submit_multi failed'},
'ESME_RINVSRCTON' :{'hex':'00000048', 'name':'ESME_RINVSRCTON', 'description':'Invalid source address TON'},
'ESME_RINVSRCNPI' :{'hex':'00000049', 'name':'ESME_RINVSRCNPI', 'description':'Invalid source address NPI'},
'ESME_RINVDSTTON' :{'hex':'00000050', 'name':'ESME_RINVDSTTON', 'description':'Invalid destination address TON'},
'ESME_RINVDSTNPI' :{'hex':'00000051', 'name':'ESME_RINVDSTNPI', 'description':'Invalid destination address NPI'},
'ESME_RINVSYSTYP' :{'hex':'00000053', 'name':'ESME_RINVSYSTYP', 'description':'Invalid system_type field'},
'ESME_RINVREPFLAG' :{'hex':'00000054', 'name':'ESME_RINVREPFLAG', 'description':'Invalid replace_if_present flag'},
'ESME_RINVNUMMSGS' :{'hex':'00000055', 'name':'ESME_RINVNUMMSGS', 'description':'Invalid number of messages'},
'ESME_RTHROTTLED' :{'hex':'00000058', 'name':'ESME_RTHROTTLED', 'description':'Throttling error (ESME has exceeded allowed message limits)'},
'ESME_RINVSCHED' :{'hex':'00000061', 'name':'ESME_RINVSCHED', 'description':'Invalid scheduled delivery time'},
'ESME_RINVEXPIRY' :{'hex':'00000062', 'name':'ESME_RINVEXPIRY', 'description':'Invalid message validity period (expiry time)'},
'ESME_RINVDFTMSGID' :{'hex':'00000063', 'name':'ESME_RINVDFTMSGID', 'description':'Predefined message invalid or not found'},
'ESME_RX_T_APPN' :{'hex':'00000064', 'name':'ESME_RX_T_APPN', 'description':'ESME Receiver Temporary App Error Code'},
'ESME_RX_P_APPN' :{'hex':'00000065', 'name':'ESME_RX_P_APPN', 'description':'ESME Receiver Permanent App Error Code'},
'ESME_RX_R_APPN' :{'hex':'00000066', 'name':'ESME_RX_R_APPN', 'description':'ESME Receiver Reject Message Error Code'},
'ESME_RQUERYFAIL' :{'hex':'00000067', 'name':'ESME_RQUERYFAIL', 'description':'query_sm request failed'},
'ESME_RINVOPTPARSTREAM':{'hex':'000000c0', 'name':'ESME_RINVOPTPARSTREAM', 'description':'Error in the optional part of the PDU Body'},
'ESME_ROPTPARNOTALLWD' :{'hex':'000000c1', 'name':'ESME_ROPTPARNOTALLWD', 'description':'Optional paramenter not allowed'},
'ESME_RINVPARLEN' :{'hex':'000000c2', 'name':'ESME_RINVPARLEN', 'description':'Invalid parameter length'},
'ESME_RMISSINGOPTPARAM':{'hex':'000000c3', 'name':'ESME_RMISSINGOPTPARAM', 'description':'Expected optional parameter missing'},
'ESME_RINVOPTPARAMVAL' :{'hex':'000000c4', 'name':'ESME_RINVOPTPARAMVAL', 'description':'Invalid optional parameter value'},
'ESME_RDELIVERYFAILURE':{'hex':'000000fe', 'name':'ESME_RDELIVERYFAILURE', 'description':'Delivery Failure (used for data_sm_resp)'},
'ESME_RUNKNOWNERR' :{'hex':'000000ff', 'name':'ESME_RUNKNOWNERR', 'description':'Unknown error'}
}
def command_status_hex_by_name(n):
return command_status_by_name.get(n,{}).get('hex')
# Type of Number (TON) - SMPP v3.4, section 5.2.5, table 5-3, page 117
maps['addr_ton_by_name'] = {
'unknown' :'00',
'international' :'01',
'national' :'02',
'network_specific' :'03',
'subscriber_number':'04',
'alphanumeric' :'05',
'abbreviated' :'06'
}
maps['addr_ton_by_hex'] = {
'00':'unknown',
'01':'international',
'02':'national',
'03':'network_specific',
'04':'subscriber_number',
'05':'alphanumeric',
'06':'abbreviated'
}
# Numberic Plan Indicator (NPI) - SMPP v3.4, section 5.2.6, table 5-4, page 118
maps['addr_npi_by_name'] = {
'unknown' :'00',
'ISDN' :'01',
'data' :'03',
'telex' :'04',
'land_mobile':'06',
'national' :'08',
'private' :'09',
'ERMES' :'0a',
'internet' :'0e',
'WAP' :'12'
}
maps['addr_npi_by_hex'] = {
'00':'unknown',
'01':'ISDN',
'03':'data',
'04':'telex',
'06':'land_mobile',
'08':'national',
'09':'private',
'0a':'ERMES',
'0e':'internet',
'12':'WAP'
}
# ESM Class bits - SMPP v3.4, section 5.2.12, page 121
maps['esm_class_bits'] = {
'mode_mask' :'03',
'type_mask' :'3c',
'feature_mask' :'c0',
'mode_default' :'00',
'mode_datagram' :'01',
'mode_forward' :'02',
'mode_store_and_forward' :'03',
'type_default' :'00',
'type_delivery_receipt' :'04',
'type_delivery_ack' :'08',
'type_0011' :'0a',
'type_user_ack' :'10',
'type_0101' :'14',
'type_conversation_abort' :'18',
'type_0111' :'1a',
'type_intermed_deliv_notif' :'20',
'type_1001' :'24',
'type_1010' :'28',
'type_1011' :'2a',
'type_1100' :'30',
'type_1101' :'34',
'type_1110' :'38',
'type_1111' :'3a',
'feature_none' :'00',
'feature_UDHI' :'40',
'feature_reply_path' :'80',
'feature_UDHI_and_reply_path':'c0'
}
# Registered Delivery bits - SMPP v3.4, section 5.2.17, page 124
maps['registered_delivery_bits'] = {
'receipt_mask' :'03',
'ack_mask' :'0c',
'intermed_notif_mask' :'80',
'receipt_none' :'00',
'receipt_always' :'01',
'receipt_on_fail' :'02',
'receipt_res' :'03',
'ack_none' :'00',
'ack_delivery' :'04',
'ack_user' :'08',
'ack_delivery_and_user':'0c',
'intermed_notif_none' :'00',
'intermed_notif' :'10'
}
# submit_multi dest_flag constants - SMPP v3.4, section 5.2.25, page 129
#maps['dest_flag_by_name'] = {
#'SME Address' :1,
#'Distribution List Name':2
#}
# Message State codes returned in query_sm_resp PDUs - SMPP v3.4, section 5.2.28, table 5-6, page 130
maps['message_state_by_name'] = {
'ENROUTE' :1,
'DELIVERED' :2,
'EXPIRED' :3,
'DELETED' :4,
'UNDELIVERABLE':5,
'ACCEPTED' :6,
'UNKNOWN' :7,
'REJECTED' :8
}
# Facility Code bits for SMPP v4
maps['facility_code_bits'] = {
'GF_PVCY' :'00000001',
'GF_SUBADDR':'00000002',
'NF_CC' :'00080000',
'NF_PDC' :'00010000',
'NF_IS136' :'00020000',
'NF_IS95A' :'00040000'
}
# Optional Parameter Tags - SMPP v3.4, section 5.3.2, Table 5-7, page 132-133
optional_parameter_tag_by_hex = {
'0005':{'hex':'0005', 'name':'dest_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.1, page 134
'0006':{'hex':'0006', 'name':'dest_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.3, page 135
'0007':{'hex':'0007', 'name':'dest_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.5, page 136
'0008':{'hex':'0008', 'name':'dest_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.7, page 137
'000d':{'hex':'000d', 'name':'source_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.2, page 134
'000e':{'hex':'000e', 'name':'source_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.4, page 135
'000f':{'hex':'000f', 'name':'source_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.6, page 136
'0010':{'hex':'0010', 'name':'source_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.8, page 137
'0017':{'hex':'0017', 'name':'qos_time_to_live', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.9, page 138
'0019':{'hex':'0019', 'name':'payload_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.10, page 138
'001d':{'hex':'001d', 'name':'additional_status_info_text', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.11, page 139
'001e':{'hex':'001e', 'name':'receipted_message_id', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.12, page 139
'0030':{'hex':'0030', 'name':'ms_msg_wait_facilities', 'type':'bitmask', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.13, page 140
'0101':{'hex':'0101', 'name':'PVCY_AuthenticationStr', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 58-62
'0201':{'hex':'0201', 'name':'privacy_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.14, page 141
'0202':{'hex':'0202', 'name':'source_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.15, page 142
'0203':{'hex':'0203', 'name':'dest_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.16, page 143
'0204':{'hex':'0204', 'name':'user_message_reference', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.17, page 143
'0205':{'hex':'0205', 'name':'user_response_code', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.18, page 144
'020a':{'hex':'020a', 'name':'source_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.20, page 145
'020b':{'hex':'020b', 'name':'destination_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.21, page 145
'020c':{'hex':'020c', 'name':'sar_msg_ref_num', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.22, page 146
'020d':{'hex':'020d', 'name':'language_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.19, page 144
'020e':{'hex':'020e', 'name':'sar_total_segments', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.23, page 147
'020f':{'hex':'020f', 'name':'sar_segment_seqnum', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.24, page 147
'0210':{'hex':'0210', 'name':'sc_interface_version', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.25, page 148
'0301':{'hex':'0301', 'name':'CC_CBN', 'type':None, 'tech':'V4'}, # v4 page 70
'0302':{'hex':'0302', 'name':'callback_num_pres_ind', 'type':'bitmask', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.37, page 156
'0303':{'hex':'0303', 'name':'callback_num_atag', 'type':'hex', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.38, page 157
'0304':{'hex':'0304', 'name':'number_of_messages', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.39, page 158
'0381':{'hex':'0381', 'name':'callback_num', 'type':'hex', 'tech':'CDMA, TDMA, GSM, iDEN'}, # SMPP v3.4, section 5.3.2.36, page 155
'0420':{'hex':'0420', 'name':'dpf_result', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.28, page 149
'0421':{'hex':'0421', 'name':'set_dpf', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.29, page 150
'0422':{'hex':'0422', 'name':'ms_availability_status', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.30, page 151
'0423':{'hex':'0423', 'name':'network_error_code', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.31, page 152
'0424':{'hex':'0424', 'name':'message_payload', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.32, page 153
'0425':{'hex':'0425', 'name':'delivery_failure_reason', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.33, page 153
'0426':{'hex':'0426', 'name':'more_messages_to_send', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.34, page 154
'0427':{'hex':'0427', 'name':'message_state', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.35, page 154
'0428':{'hex':'0428', 'name':'congestion_state', 'type':None, 'tech':'Generic'},
'0501':{'hex':'0501', 'name':'ussd_service_op', 'type':'hex', 'tech':'GSM (USSD)'}, # SMPP v3.4, section 5.3.2.44, page 161
'0600':{'hex':'0600', 'name':'broadcast_channel_indicator', 'type':None, 'tech':'GSM'},
'0601':{'hex':'0601', 'name':'broadcast_content_type', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'0602':{'hex':'0602', 'name':'broadcast_content_type_info', 'type':None, 'tech':'CDMA, TDMA'},
'0603':{'hex':'0603', 'name':'broadcast_message_class', 'type':None, 'tech':'GSM'},
'0604':{'hex':'0604', 'name':'broadcast_rep_num', 'type':None, 'tech':'GSM'},
'0605':{'hex':'0605', 'name':'broadcast_frequency_interval', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'0606':{'hex':'0606', 'name':'broadcast_area_identifier', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'0607':{'hex':'0607', 'name':'broadcast_error_status', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'0608':{'hex':'0608', 'name':'broadcast_area_success', 'type':None, 'tech':'GSM'},
'0609':{'hex':'0609', 'name':'broadcast_end_time', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'060a':{'hex':'060a', 'name':'broadcast_service_group', 'type':None, 'tech':'CDMA, TDMA'},
'060b':{'hex':'060b', 'name':'billing_identification', 'type':None, 'tech':'Generic'},
'060d':{'hex':'060d', 'name':'source_network_id', 'type':None, 'tech':'Generic'},
'060e':{'hex':'060e', 'name':'dest_network_id', 'type':None, 'tech':'Generic'},
'060f':{'hex':'060f', 'name':'source_node_id', 'type':None, 'tech':'Generic'},
'0610':{'hex':'0610', 'name':'dest_node_id', 'type':None, 'tech':'Generic'},
'0611':{'hex':'0611', 'name':'dest_addr_np_resolution', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'0612':{'hex':'0612', 'name':'dest_addr_np_information', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'0613':{'hex':'0613', 'name':'dest_addr_np_country', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'1101':{'hex':'1101', 'name':'PDC_MessageClass', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 75
'1102':{'hex':'1102', 'name':'PDC_PresentationOption', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
'1103':{'hex':'1103', 'name':'PDC_AlertMechanism', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
'1104':{'hex':'1104', 'name':'PDC_Teleservice', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
'1105':{'hex':'1105', 'name':'PDC_MultiPartMessage', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
'1106':{'hex':'1106', 'name':'PDC_PredefinedMsg', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 78
'1201':{'hex':'1201', 'name':'display_time', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.26, page 148
'1203':{'hex':'1203', 'name':'sms_signal', 'type':'integer', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.40, page 158
'1204':{'hex':'1204', 'name':'ms_validity', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.27, page 149
'1304':{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'type':None, 'tech':'CDMA'}, # v4 page 85
'1306':{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'type':None, 'tech':'CDMA'}, # v4 page 86
'130c':{'hex':'130c', 'name':'alert_on_message_delivery', 'type':None, 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.41, page 159
'1380':{'hex':'1380', 'name':'its_reply_type', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.42, page 159
'1383':{'hex':'1383', 'name':'its_session_info', 'type':'hex', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.43, page 160
'1402':{'hex':'1402', 'name':'operator_id', 'type':None, 'tech':'vendor extension'},
'1403':{'hex':'1403', 'name':'tariff', 'type':None, 'tech':'Mobile Network Code vendor extension'},
'1450':{'hex':'1450', 'name':'mcc', 'type':None, 'tech':'Mobile Country Code vendor extension'},
'1451':{'hex':'1451', 'name':'mnc', 'type':None, 'tech':'Mobile Network Code vendor extension'}
}
def optional_parameter_tag_name_by_hex(x):
return optional_parameter_tag_by_hex.get(x,{}).get('name')
def optional_parameter_tag_type_by_hex(x):
return optional_parameter_tag_by_hex.get(x,{}).get('type')
optional_parameter_tag_by_name = {
'dest_addr_subunit' :{'hex':'0005', 'name':'dest_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.1, page 134
'dest_network_type' :{'hex':'0006', 'name':'dest_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.3, page 135
'dest_bearer_type' :{'hex':'0007', 'name':'dest_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.5, page 136
'dest_telematics_id' :{'hex':'0008', 'name':'dest_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.7, page 137
'source_addr_subunit' :{'hex':'000d', 'name':'source_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.2, page 134
'source_network_type' :{'hex':'000e', 'name':'source_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.4, page 135
'source_bearer_type' :{'hex':'000f', 'name':'source_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.6, page 136
'source_telematics_id' :{'hex':'0010', 'name':'source_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.8, page 137
'qos_time_to_live' :{'hex':'0017', 'name':'qos_time_to_live', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.9, page 138
'payload_type' :{'hex':'0019', 'name':'payload_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.10, page 138
'additional_status_info_text' :{'hex':'001d', 'name':'additional_status_info_text', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.11, page 139
'receipted_message_id' :{'hex':'001e', 'name':'receipted_message_id', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.12, page 139
'ms_msg_wait_facilities' :{'hex':'0030', 'name':'ms_msg_wait_facilities', 'type':'bitmask', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.13, page 140
'PVCY_AuthenticationStr' :{'hex':'0101', 'name':'PVCY_AuthenticationStr', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 58-62
'privacy_indicator' :{'hex':'0201', 'name':'privacy_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.14, page 141
'source_subaddress' :{'hex':'0202', 'name':'source_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.15, page 142
'dest_subaddress' :{'hex':'0203', 'name':'dest_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.16, page 143
'user_message_reference' :{'hex':'0204', 'name':'user_message_reference', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.17, page 143
'user_response_code' :{'hex':'0205', 'name':'user_response_code', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.18, page 144
'source_port' :{'hex':'020a', 'name':'source_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.20, page 145
'destination_port' :{'hex':'020b', 'name':'destination_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.21, page 145
'sar_msg_ref_num' :{'hex':'020c', 'name':'sar_msg_ref_num', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.22, page 146
'language_indicator' :{'hex':'020d', 'name':'language_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.19, page 144
'sar_total_segments' :{'hex':'020e', 'name':'sar_total_segments', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.23, page 147
'sar_segment_seqnum' :{'hex':'020f', 'name':'sar_segment_seqnum', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.24, page 147
'sc_interface_version' :{'hex':'0210', 'name':'sc_interface_version', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.25, page 148
'CC_CBN' :{'hex':'0301', 'name':'CC_CBN', 'type':None, 'tech':'V4'}, # v4 page 70
'callback_num_pres_ind' :{'hex':'0302', 'name':'callback_num_pres_ind', 'type':'bitmask', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.37, page 156
'callback_num_atag' :{'hex':'0303', 'name':'callback_num_atag', 'type':'hex', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.38, page 157
'number_of_messages' :{'hex':'0304', 'name':'number_of_messages', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.39, page 158
'callback_num' :{'hex':'0381', 'name':'callback_num', 'type':'hex', 'tech':'CDMA, TDMA, GSM, iDEN'}, # SMPP v3.4, section 5.3.2.36, page 155
'dpf_result' :{'hex':'0420', 'name':'dpf_result', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.28, page 149
'set_dpf' :{'hex':'0421', 'name':'set_dpf', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.29, page 150
'ms_availability_status' :{'hex':'0422', 'name':'ms_availability_status', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.30, page 151
'network_error_code' :{'hex':'0423', 'name':'network_error_code', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.31, page 152
'message_payload' :{'hex':'0424', 'name':'message_payload', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.32, page 153
'delivery_failure_reason' :{'hex':'0425', 'name':'delivery_failure_reason', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.33, page 153
'more_messages_to_send' :{'hex':'0426', 'name':'more_messages_to_send', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.34, page 154
'message_state' :{'hex':'0427', 'name':'message_state', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.35, page 154
'congestion_state' :{'hex':'0428', 'name':'congestion_state', 'type':None, 'tech':'Generic'},
'ussd_service_op' :{'hex':'0501', 'name':'ussd_service_op', 'type':'hex', 'tech':'GSM (USSD)'}, # SMPP v3.4, section 5.3.2.44, page 161
'broadcast_channel_indicator' :{'hex':'0600', 'name':'broadcast_channel_indicator', 'type':None, 'tech':'GSM'},
'broadcast_content_type' :{'hex':'0601', 'name':'broadcast_content_type', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_content_type_info' :{'hex':'0602', 'name':'broadcast_content_type_info', 'type':None, 'tech':'CDMA, TDMA'},
'broadcast_message_class' :{'hex':'0603', 'name':'broadcast_message_class', 'type':None, 'tech':'GSM'},
'broadcast_rep_num' :{'hex':'0604', 'name':'broadcast_rep_num', 'type':None, 'tech':'GSM'},
'broadcast_frequency_interval':{'hex':'0605', 'name':'broadcast_frequency_interval', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_area_identifier' :{'hex':'0606', 'name':'broadcast_area_identifier', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_error_status' :{'hex':'0607', 'name':'broadcast_error_status', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_area_success' :{'hex':'0608', 'name':'broadcast_area_success', 'type':None, 'tech':'GSM'},
'broadcast_end_time' :{'hex':'0609', 'name':'broadcast_end_time', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_service_group' :{'hex':'060a', 'name':'broadcast_service_group', 'type':None, 'tech':'CDMA, TDMA'},
'billing_identification' :{'hex':'060b', 'name':'billing_identification', 'type':None, 'tech':'Generic'},
'source_network_id' :{'hex':'060d', 'name':'source_network_id', 'type':None, 'tech':'Generic'},
'dest_network_id' :{'hex':'060e', 'name':'dest_network_id', 'type':None, 'tech':'Generic'},
'source_node_id' :{'hex':'060f', 'name':'source_node_id', 'type':None, 'tech':'Generic'},
'dest_node_id' :{'hex':'0610', 'name':'dest_node_id', 'type':None, 'tech':'Generic'},
'dest_addr_np_resolution' :{'hex':'0611', 'name':'dest_addr_np_resolution', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'dest_addr_np_information' :{'hex':'0612', 'name':'dest_addr_np_information', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'dest_addr_np_country' :{'hex':'0613', 'name':'dest_addr_np_country', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'PDC_MessageClass' :{'hex':'1101', 'name':'PDC_MessageClass', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 75
'PDC_PresentationOption' :{'hex':'1102', 'name':'PDC_PresentationOption', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
'PDC_AlertMechanism' :{'hex':'1103', 'name':'PDC_AlertMechanism', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
'PDC_Teleservice' :{'hex':'1104', 'name':'PDC_Teleservice', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
'PDC_MultiPartMessage' :{'hex':'1105', 'name':'PDC_MultiPartMessage', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
'PDC_PredefinedMsg' :{'hex':'1106', 'name':'PDC_PredefinedMsg', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 78
'display_time' :{'hex':'1201', 'name':'display_time', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.26, page 148
'sms_signal' :{'hex':'1203', 'name':'sms_signal', 'type':'integer', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.40, page 158
'ms_validity' :{'hex':'1204', 'name':'ms_validity', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.27, page 149
'IS95A_AlertOnDelivery' :{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'type':None, 'tech':'CDMA'}, # v4 page 85
'IS95A_LanguageIndicator' :{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'type':None, 'tech':'CDMA'}, # v4 page 86
'alert_on_message_delivery' :{'hex':'130c', 'name':'alert_on_message_delivery', 'type':None, 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.41, page 159
'its_reply_type' :{'hex':'1380', 'name':'its_reply_type', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.42, page 159
'its_session_info' :{'hex':'1383', 'name':'its_session_info', 'type':'hex', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.43, page 160
'operator_id' :{'hex':'1402', 'name':'operator_id', 'type':None, 'tech':'vendor extension'},
'tariff' :{'hex':'1403', 'name':'tariff', 'type':None, 'tech':'Mobile Network Code vendor extension'},
'mcc' :{'hex':'1450', 'name':'mcc', 'type':None, 'tech':'Mobile Country Code vendor extension'},
'mnc' :{'hex':'1451', 'name':'mnc', 'type':None, 'tech':'Mobile Network Code vendor extension'}
}
def optional_parameter_tag_hex_by_name(n):
return optional_parameter_tag_by_name.get(n,{}).get('hex')
#### Decoding functions #######################################################
def unpack_pdu(pdu_bin):
return decode_pdu(binascii.b2a_hex(pdu_bin))
def decode_pdu(pdu_hex):
hex_ref = [pdu_hex]
pdu = {}
pdu['header'] = decode_header(hex_ref)
command = pdu['header'].get('command_id', None)
if command != None:
body = decode_body(command, hex_ref)
if len(body) > 0:
pdu['body'] = body
return pdu
def decode_header(hex_ref):
pdu_hex = hex_ref[0]
header = {}
(command_length, command_id, command_status, sequence_number, hex_ref[0]) = \
(pdu_hex[0:8], pdu_hex[8:16], pdu_hex[16:24], pdu_hex[24:32], pdu_hex[32: ])
length = int(command_length, 16)
command = command_id_name_by_hex(command_id)
status = command_status_name_by_hex(command_status)
sequence = int(sequence_number, 16)
header = {}
header['command_length'] = length
header['command_id'] = command
header['command_status'] = status
header['sequence_number'] = sequence
return header
def decode_body(command, hex_ref):
body = {}
if command != None:
fields = mandatory_parameter_list_by_command_name(command)
mandatory = decode_mandatory_parameters(fields, hex_ref)
if len(mandatory) > 0:
body['mandatory_parameters'] = mandatory
optional = decode_optional_parameters(hex_ref)
if len(optional) > 0:
body['optional_parameters'] = optional
return body
def decode_mandatory_parameters(fields, hex_ref):
mandatory_parameters = {}
if len(hex_ref[0]) > 1:
for field in fields:
#old = len(hex_ref[0])
data = ''
octet = ''
count = 0
if field['var'] == True or field['var'] == False:
while (len(hex_ref[0]) > 1
and (count < field['min']
or (count < field['max']
and octet != '00'))):
octet = octpop(hex_ref)
data += octet
count += 1
elif field['type'] == 'string':
count = mandatory_parameters[field['var']]
- for i in range(count):
- if len(hex_ref[0]) > 1:
- data += octpop(hex_ref)
+ if count == 0:
+ data = None
+ else:
+ for i in range(count):
+ if len(hex_ref[0]) > 1:
+ data += octpop(hex_ref)
else:
count = mandatory_parameters[field['var']]
if field['map'] != None:
mandatory_parameters[field['name']] = maps[field['map']+'_by_hex'].get(data, None)
if field['map'] == None or mandatory_parameters[field['name']] == None:
mandatory_parameters[field['name']] = decode_hex_type(data, field['type'], count, hex_ref)
#print field['type'], (old - len(hex_ref[0]))/2, repr(data), field['name'], mandatory_parameters[field['name']]
return mandatory_parameters
def decode_optional_parameters(hex_ref):
optional_parameters = []
hex = hex_ref[0]
while len(hex) > 0:
(tag_hex, length_hex, rest) = (hex[0:4], hex[4:8], hex[8: ])
tag = optional_parameter_tag_name_by_hex(tag_hex)
if tag == None:
tag = tag_hex
length = int(length_hex, 16)
(value_hex, tail) = (rest[0:length*2], rest[length*2: ])
if len(value_hex) == 0:
value = None
else:
value = decode_hex_type(value_hex, optional_parameter_tag_type_by_hex(tag_hex))
hex = tail
optional_parameters.append({'tag':tag, 'length':length, 'value':value})
return optional_parameters
def decode_hex_type(hex, type, count=0, hex_ref=['']):
- if type == 'integer':
+ if hex == None:
+ return hex
+ elif type == 'integer':
return int(hex, 16)
elif type == 'string':
return re.sub('00','',hex).decode('hex')
elif (type == 'dest_address'
or type == 'unsuccess_sme'):
list = []
fields = mandatory_parameter_list_by_command_name(type)
for i in range(count):
item = decode_mandatory_parameters(fields, hex_ref)
if item.get('dest_flag', None) == 1: # 'dest_address' only
subfields = mandatory_parameter_list_by_command_name('sme_dest_address')
rest = decode_mandatory_parameters(subfields, hex_ref)
item.update(rest)
elif item.get('dest_flag', None) == 2: # 'dest_address' only
subfields = mandatory_parameter_list_by_command_name('distribution_list')
rest = decode_mandatory_parameters(subfields, hex_ref)
item.update(rest)
list.append(item)
return list
else:
return hex
def octpop(hex_ref):
octet = None
if len(hex_ref[0]) > 1:
(octet, hex_ref[0]) = (hex_ref[0][0:2], hex_ref[0][2: ])
return octet
#### Encoding functions #######################################################
def pack_pdu(pdu_obj):
return binascii.a2b_hex(encode_pdu(pdu_obj))
def encode_pdu(pdu_obj):
header = pdu_obj.get('header', {})
body = pdu_obj.get('body', {})
mandatory = body.get('mandatory_parameters', {})
optional = body.get('optional_parameters', [])
body_hex = ''
fields = mandatory_parameter_list_by_command_name(header['command_id'])
body_hex += encode_mandatory_parameters(mandatory, fields)
for opt in optional:
body_hex += encode_optional_parameter(opt['tag'], opt['value'])
actual_length = 16 + len(body_hex)/2
command_length = '%08x' % actual_length
command_id = command_id_hex_by_name(header['command_id'])
command_status = command_status_hex_by_name(header['command_status'])
sequence_number = '%08x' % header['sequence_number']
pdu_hex = command_length + command_id + command_status + sequence_number + body_hex
return pdu_hex
def encode_mandatory_parameters(mandatory_obj, fields):
mandatory_hex_array = []
index_names = {}
index = 0
for field in fields:
param = mandatory_obj.get(field['name'], None)
param_length = None
if param != None or field['min'] > 0:
map = None
if field['map'] != None:
map = maps.get(field['map']+'_by_name', None)
if isinstance(param, list):
hex_list = []
for item in param:
flagfields = mandatory_parameter_list_by_command_name(field['type'])
plusfields = []
if item.get('dest_flag', None) == 1:
plusfields = mandatory_parameter_list_by_command_name('sme_dest_address')
elif item.get('dest_flag', None) == 2:
plusfields = mandatory_parameter_list_by_command_name('distribution_list')
hex_item = encode_mandatory_parameters(item, flagfields + plusfields)
if isinstance(hex_item, str) and len(hex_item) > 0:
hex_list.append(hex_item)
param_length = len(hex_list)
mandatory_hex_array.append(''.join(hex_list))
else:
hex_param = encode_param_type(
param, field['type'], field['min'], field['max'], map)
param_length = len(hex_param)/2
mandatory_hex_array.append(hex_param)
index_names[field['name']] = index
length_index = index_names.get(field['var'], None)
if length_index != None and param_length != None:
mandatory_hex_array[length_index] = encode_param_type(
param_length,
'integer',
len(mandatory_hex_array[length_index])/2)
index += 1
return ''.join(mandatory_hex_array)
def encode_optional_parameter(tag, value):
optional_hex_array = []
tag_hex = optional_parameter_tag_hex_by_name(tag)
if tag_hex != None:
value_hex = encode_param_type(
value,
optional_parameter_tag_type_by_hex(tag_hex))
length_hex = '%04x' % (len(value_hex)/2)
optional_hex_array.append(tag_hex + length_hex + value_hex)
return ''.join(optional_hex_array)
def encode_param_type(param, type, min=0, max=None, map=None):
if param == None:
hex = None
elif map != None:
if type == 'integer' and isinstance(param, int):
hex = ('%0'+str(min*2)+'x') % param
else:
hex = map.get(param, ('%0'+str(min*2)+'x') % 0)
elif type == 'integer':
hex = ('%0'+str(min*2)+'x') % int(param)
elif type == 'string':
hex = param.encode('hex') + '00'
elif type == 'bitmask':
hex = param
elif type == 'hex':
hex = param
else:
hex = None
#if hex == None:
#hex = ''
#if min > 0:
#hex = ('%0'+str(min*2)+'x') % 0
#print type, min, max, repr(param), hex, map
return hex
|
dmaclay/python-smpp
|
4db62bded22047d82ef62260503e118874eebb8e
|
no sm = null, not ''
|
diff --git a/test/pdu_hex_asserts.py b/test/pdu_hex_asserts.py
index 9a553b1..313209a 100644
--- a/test/pdu_hex_asserts.py
+++ b/test/pdu_hex_asserts.py
@@ -1,128 +1,128 @@
########################################
pdu_json_0000000001 = '''{
"body": {
"mandatory_parameters": {
"data_coding": 0,
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "555555555",
"esm_class": 0,
"priority_flag": 0,
"protocol_id": 0,
"registered_delivery": 0,
"replace_if_present_flag": 0,
"schedule_delivery_time": "",
"service_type": "",
"short_message": "Hello wikipedia",
"sm_default_msg_id": 0,
"sm_length": 15,
"source_addr": "555",
"source_addr_npi": "national",
"source_addr_ton": "national",
"validity_period": ""
},
"optional_parameters": [
{
"length": 0,
"tag": "0000",
"value": null
},
{
"length": 2,
"tag": "additional_status_info_text",
"value": "ef"
}
]
},
"header": {
"command_id": "submit_sm",
"command_length": 60,
"command_status": "ESME_ROK",
"sequence_number": 5
}
}'''
########################################
pdu_json_0000000002 = '''{
"body": {
"mandatory_parameters": {
"data_coding": 0,
"dest_address": [
{
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"dest_flag": 1,
"destination_addr": "e"
},
{
"dest_flag": 2,
"dl_name": "f"
}
],
"esm_class": 0,
"number_of_dests": 2,
"priority_flag": 0,
"protocol_id": 0,
"registered_delivery": 0,
"replace_if_present_flag": 0,
"schedule_delivery_time": "",
"service_type": "",
- "short_message": "",
+ "short_message": null,
"sm_default_msg_id": 0,
"sm_length": 0,
"source_addr": "",
"source_addr_npi": "unknown",
"source_addr_ton": "unknown",
"validity_period": ""
},
"optional_parameters": [
{
"length": 2,
"tag": "dest_addr_subunit",
"value": 0
},
{
"length": 4,
"tag": "0000",
"value": "00000000"
}
]
},
"header": {
"command_id": "submit_multi",
"command_length": 0,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000003 = '''{
"body": {
"mandatory_parameters": {
"message_id": "",
"no_unsuccess": 2,
"unsuccess_sme": [
{
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "eee",
"error_status_code": 0
},
{
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "fff",
"error_status_code": 0
}
]
}
},
"header": {
"command_id": "submit_multi_resp",
"command_length": 0,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
|
dmaclay/python-smpp
|
7c0f3feaa086859491dbf3b0171ee907ccf32a1f
|
no sm = null, not ''
|
diff --git a/test/pdu_asserts.py b/test/pdu_asserts.py
index 37a6c80..75d3891 100644
--- a/test/pdu_asserts.py
+++ b/test/pdu_asserts.py
@@ -1,563 +1,563 @@
########################################
pdu_json_0000000001 = '''{
"body": {
"mandatory_parameters": {
"addr_npi": "ISDN",
"addr_ton": "international",
"address_range": "",
"interface_version": "",
"password": "abc123",
"system_id": "test_system",
"system_type": ""
}
},
"header": {
"command_id": "bind_transmitter",
"command_length": 40,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000002 = '''{
"body": {
"mandatory_parameters": {
"system_id": "test_system"
}
},
"header": {
"command_id": "bind_transmitter_resp",
"command_length": 28,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000003 = '''{
"body": {
"mandatory_parameters": {
"addr_npi": "ISDN",
"addr_ton": "international",
"address_range": "",
"interface_version": "",
"password": "abc123",
"system_id": "test_system",
"system_type": ""
}
},
"header": {
"command_id": "bind_receiver",
"command_length": 40,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000004 = '''{
"body": {
"mandatory_parameters": {
"system_id": "test_system"
}
},
"header": {
"command_id": "bind_receiver_resp",
"command_length": 28,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000005 = '''{
"body": {
"mandatory_parameters": {
"addr_npi": "ISDN",
"addr_ton": "international",
"address_range": "",
"interface_version": "",
"password": "abc123",
"system_id": "test_system",
"system_type": ""
}
},
"header": {
"command_id": "bind_transceiver",
"command_length": 40,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000006 = '''{
"body": {
"mandatory_parameters": {
"system_id": "test_system"
}
},
"header": {
"command_id": "bind_transceiver_resp",
"command_length": 28,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000007 = '''{
"body": {
"mandatory_parameters": {
"password": "abc123",
"system_id": "test_system"
}
},
"header": {
"command_id": "outbind",
"command_length": 35,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000008 = '''{
"header": {
"command_id": "unbind",
"command_length": 16,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000009 = '''{
"header": {
"command_id": "unbind_resp",
"command_length": 16,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000010 = '''{
"header": {
"command_id": "generic_nack",
"command_length": 16,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000011 = '''{
"body": {
"mandatory_parameters": {
"data_coding": 0,
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "",
"esm_class": 0,
"priority_flag": 0,
"protocol_id": 0,
"registered_delivery": 0,
"replace_if_present_flag": 0,
"schedule_delivery_time": "",
"service_type": "",
"short_message": "testing 123",
"sm_default_msg_id": 0,
"sm_length": 12,
"source_addr": "",
"source_addr_npi": "ISDN",
"source_addr_ton": "international",
"validity_period": ""
}
},
"header": {
"command_id": "submit_sm",
"command_length": 45,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000012 = '''{
"body": {
"mandatory_parameters": {
"data_coding": 0,
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "",
"esm_class": 0,
"priority_flag": 0,
"protocol_id": 0,
"registered_delivery": 0,
"replace_if_present_flag": 0,
"schedule_delivery_time": "",
"service_type": "",
- "short_message": "",
+ "short_message": null,
"sm_default_msg_id": 0,
"sm_length": 0,
"source_addr": "",
"source_addr_npi": "ISDN",
"source_addr_ton": "international",
"validity_period": ""
},
"optional_parameters": [
{
"length": 2,
"tag": "message_payload",
"value": "5666"
}
]
},
"header": {
"command_id": "submit_sm",
"command_length": 39,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000013 = '''{
"body": {
"mandatory_parameters": {
"message_id": ""
}
},
"header": {
"command_id": "submit_sm_resp",
"command_length": 17,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000014 = '''{
"header": {
"command_id": "submit_sm_resp",
"command_length": 16,
"command_status": "ESME_RSYSERR",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000015 = '''{
"body": {
"mandatory_parameters": {
"data_coding": 0,
"dest_address": [
{
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"dest_flag": 1,
"destination_addr": "the address"
},
{
"dest_flag": 2,
"dl_name": "the list"
},
{
"dest_flag": 2,
"dl_name": "the other list"
}
],
"esm_class": 0,
"number_of_dests": 3,
"priority_flag": 0,
"protocol_id": 0,
"registered_delivery": 0,
"replace_if_present_flag": 0,
"schedule_delivery_time": "",
"service_type": "",
"short_message": "testing 123",
"sm_default_msg_id": 0,
"sm_length": 12,
"source_addr": "",
"source_addr_npi": "ISDN",
"source_addr_ton": "international",
"validity_period": ""
}
},
"header": {
"command_id": "submit_multi",
"command_length": 84,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000016 = '''{
"body": {
"mandatory_parameters": {
"message_id": "",
"no_unsuccess": 2,
"unsuccess_sme": [
{
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "",
"error_status_code": 0
},
{
"dest_addr_npi": "ISDN",
"dest_addr_ton": "network_specific",
"destination_addr": "555",
"error_status_code": 0
}
]
}
},
"header": {
"command_id": "submit_multi_resp",
"command_length": 35,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000017 = '''{
"body": {
"mandatory_parameters": {
"data_coding": 0,
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "",
"esm_class": 0,
"priority_flag": 0,
"protocol_id": 0,
"registered_delivery": 0,
"replace_if_present_flag": 0,
"schedule_delivery_time": "",
"service_type": "",
"short_message": "",
"sm_default_msg_id": 0,
"sm_length": 1,
"source_addr": "",
"source_addr_npi": "ISDN",
"source_addr_ton": "international",
"validity_period": ""
}
},
"header": {
"command_id": "deliver_sm",
"command_length": 34,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000018 = '''{
"body": {
"mandatory_parameters": {
"message_id": ""
}
},
"header": {
"command_id": "deliver_sm_resp",
"command_length": 17,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000019 = '''{
"body": {
"mandatory_parameters": {
"data_coding": 0,
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "",
"esm_class": 0,
"registered_delivery": 0,
"service_type": "",
"source_addr": "",
"source_addr_npi": "ISDN",
"source_addr_ton": "international"
},
"optional_parameters": [
{
"length": 0,
"tag": "message_payload",
"value": null
}
]
},
"header": {
"command_id": "data_sm",
"command_length": 30,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000020 = '''{
"body": {
"mandatory_parameters": {
"message_id": ""
}
},
"header": {
"command_id": "data_sm_resp",
"command_length": 17,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000021 = '''{
"body": {
"mandatory_parameters": {
"message_id": "",
"source_addr": "",
"source_addr_npi": "ISDN",
"source_addr_ton": "international"
}
},
"header": {
"command_id": "query_sm",
"command_length": 20,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000022 = '''{
"body": {
"mandatory_parameters": {
"error_code": 0,
"final_date": "",
"message_id": "",
"message_state": 0
}
},
"header": {
"command_id": "query_sm_resp",
"command_length": 20,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000023 = '''{
"body": {
"mandatory_parameters": {
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "",
"message_id": "",
"service_type": "",
"source_addr": "",
"source_addr_npi": "ISDN",
"source_addr_ton": "international"
}
},
"header": {
"command_id": "cancel_sm",
"command_length": 24,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000024 = '''{
"header": {
"command_id": "cancel_sm_resp",
"command_length": 16,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000025 = '''{
"body": {
"mandatory_parameters": {
"data_coding": 0,
"message_id": "",
"registered_delivery": 0,
"replace_if_present_flag": 0,
"schedule_delivery_time": "",
"short_message": "is this an = sign?",
"sm_default_msg_id": 0,
"sm_length": 19,
"source_addr": "",
"source_addr_npi": "ISDN",
"source_addr_ton": "international",
"validity_period": ""
}
},
"header": {
"command_id": "replace_sm",
"command_length": 46,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000026 = '''{
"header": {
"command_id": "replace_sm_resp",
"command_length": 16,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000027 = '''{
"header": {
"command_id": "enquire_link",
"command_length": 16,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000028 = '''{
"header": {
"command_id": "enquire_link_resp",
"command_length": 16,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
########################################
pdu_json_0000000029 = '''{
"body": {
"mandatory_parameters": {
"esme_addr": "",
"esme_addr_npi": "unknown",
"esme_addr_ton": 9,
"source_addr": "",
"source_addr_npi": "ISDN",
"source_addr_ton": "international"
}
},
"header": {
"command_id": "alert_notification",
"command_length": 22,
"command_status": "ESME_ROK",
"sequence_number": 0
}
}'''
|
dmaclay/python-smpp
|
45f15be3e9d742da4a42798fa8e03f588b150d34
|
pdu helper classes
|
diff --git a/src/smpp/pdu_builder.py b/src/smpp/pdu_builder.py
new file mode 100644
index 0000000..e69de29
|
dmaclay/python-smpp
|
e79c52e7d452ed3450b0523927fa5017b2e6dc7e
|
cleaner
|
diff --git a/tests.py b/tests.py
index 84eadbf..e2a2454 100644
--- a/tests.py
+++ b/tests.py
@@ -1,165 +1,161 @@
import unittest
from datetime import datetime, timedelta
try:
from smpp.esme import *
except:
from src.smpp.esme import *
from test.pdu import pdu_objects
from test import pdu_asserts
from test.pdu_hex import pdu_hex_strings
from test import pdu_hex_asserts
def unpack_hex(pdu_hex):
"""Unpack PDU hex string and return it as a dictionary"""
return unpack_pdu(binascii.a2b_hex(hexclean(pdu_hex)))
def hexclean(dirtyhex):
"""Remove whitespace, comments & newlines from hex string"""
return re.sub(r'\s','',re.sub(r'#.*\n','\n',dirtyhex))
def prettydump(pdu_obj):
"""Unpack PDU dictionary and dump it as a JSON formatted string"""
return json.dumps(pdu_obj, indent=4, sort_keys=True)
def create_pdu_asserts():
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_pdu(pack_pdu(pdu)))
pstr += "'''"
print pstr
def create_pdu_hex_asserts():
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_hex(pdu_hex))
pstr += "'''"
print pstr
## :w|!python % > test/pdu_asserts.py
#create_pdu_asserts()
#quit()
## :w|!python % > test/pdu_hex_asserts.py
#create_pdu_hex_asserts()
#quit()
class SmppTestCase(unittest.TestCase):
def setUp(self):
pass
def tearDown(self):
pass
def test_pack_unpack_pdu_objects(self):
"""
- It should take a dictionary, pack and unpack it and dump
- it as JSON correctly.
+ pdu_objects: take a dictionary, pack and unpack it and dump it as JSON correctly.
"""
- print '\npdu_objects'
+ print ''
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
padded_index = '%010d' % pdu_index
print padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_pdu(pack_pdu(pdu)))),
re.sub('\n *','',
eval('pdu_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_pdu_hex_strings(self):
"""
- Read the hex data, clean it, and unpack it
- to JSON correctly.
+ pdu_hex_strings: read the hex data, clean it, and unpack it to JSON correctly.
"""
- print '\npdu_hex_strings'
+ print ''
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
padded_index = '%010d' % pdu_index
print padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_hex(pdu_hex))),
re.sub('\n *','',
eval('pdu_hex_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_performance(self):
"""
- Test that time to pack & unpack 2000 dictionaries
- is less than 1 second.
+ pack_unpack_performance: pack & unpack 2000 submit_sm PDUs in under 1 second.
"""
- print '\npack_unpack_performance'
+ print ''
submit_sm = {
'header': {
'command_length': 0,
'command_id': 'submit_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
'esm_class':0,
'protocol_id':0,
'priority_flag':0,
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
'sm_length':1,
'short_message':'',
},
},
}
start = datetime.now()
for x in range(2000):
x += 1
submit_sm['header']['sequence_number'] = x
sm = 'testing: x = '+str(x)+''
submit_sm['body']['mandatory_parameters']['short_message'] = sm
u = unpack_pdu(pack_pdu(submit_sm))
delta = datetime.now() - start
- print '2000 pack/unpacks in:', delta
+ print '2000 pack & unpacks in:', delta
self.assertTrue(delta < timedelta(seconds=1))
-if __name__ == '__main__':
- unittest.main()
-
-
#esme = ESME()
#esme.connect_SMSC('localhost')
#esme.bind_SMSC()
#esme.disconnect_SMSC()
+if __name__ == '__main__':
+ unittest.main()
+
|
dmaclay/python-smpp
|
9f277aef925dc7a8fe7eafe89eae3767fd2797c1
|
cleanup
|
diff --git a/tests.py b/tests.py
index 6fad583..84eadbf 100644
--- a/tests.py
+++ b/tests.py
@@ -1,481 +1,165 @@
import unittest
from datetime import datetime, timedelta
try:
from smpp.esme import *
except:
from src.smpp.esme import *
from test.pdu import pdu_objects
from test import pdu_asserts
from test.pdu_hex import pdu_hex_strings
from test import pdu_hex_asserts
def unpack_hex(pdu_hex):
"""Unpack PDU hex string and return it as a dictionary"""
return unpack_pdu(binascii.a2b_hex(hexclean(pdu_hex)))
def hexclean(dirtyhex):
"""Remove whitespace, comments & newlines from hex string"""
return re.sub(r'\s','',re.sub(r'#.*\n','\n',dirtyhex))
def prettydump(pdu_obj):
"""Unpack PDU dictionary and dump it as a JSON formatted string"""
return json.dumps(pdu_obj, indent=4, sort_keys=True)
def create_pdu_asserts():
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_pdu(pack_pdu(pdu)))
pstr += "'''"
print pstr
def create_pdu_hex_asserts():
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_hex(pdu_hex))
pstr += "'''"
print pstr
## :w|!python % > test/pdu_asserts.py
#create_pdu_asserts()
#quit()
## :w|!python % > test/pdu_hex_asserts.py
#create_pdu_hex_asserts()
#quit()
class SmppTestCase(unittest.TestCase):
def setUp(self):
pass
def tearDown(self):
pass
def test_pack_unpack_pdu_objects(self):
+ """
+ It should take a dictionary, pack and unpack it and dump
+ it as JSON correctly.
+ """
print '\npdu_objects'
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
padded_index = '%010d' % pdu_index
print padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_pdu(pack_pdu(pdu)))),
re.sub('\n *','',
eval('pdu_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_pdu_hex_strings(self):
+ """
+ Read the hex data, clean it, and unpack it
+ to JSON correctly.
+ """
print '\npdu_hex_strings'
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
padded_index = '%010d' % pdu_index
print padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_hex(pdu_hex))),
re.sub('\n *','',
eval('pdu_hex_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_performance(self):
+ """
+ Test that time to pack & unpack 2000 dictionaries
+ is less than 1 second.
+ """
print '\npack_unpack_performance'
submit_sm = {
'header': {
'command_length': 0,
'command_id': 'submit_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
'esm_class':0,
'protocol_id':0,
'priority_flag':0,
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
'sm_length':1,
'short_message':'',
},
},
}
start = datetime.now()
for x in range(2000):
x += 1
submit_sm['header']['sequence_number'] = x
sm = 'testing: x = '+str(x)+''
submit_sm['body']['mandatory_parameters']['short_message'] = sm
u = unpack_pdu(pack_pdu(submit_sm))
delta = datetime.now() - start
print '2000 pack/unpacks in:', delta
self.assertTrue(delta < timedelta(seconds=1))
if __name__ == '__main__':
unittest.main()
-quit()
-
-
-
-
-
-
-
-
-
-stars = "\n******************************************************************\n"
-
-
-
-print ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>"
#esme = ESME()
#esme.connect_SMSC('localhost')
#esme.bind_SMSC()
#esme.disconnect_SMSC()
-print ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>"
-
-x = '''
- 0000003C # command_length
- 00000004 # command_id
- 00000000 # command_status
- 00000005 # sequence_number
- 00
- 02
- 08
- 35353500
- 01
- 01
- 35353535353535353500
- 00
- 00
- 00
- 00
- 00
- 00
- 00
- 00
- 00
- 0F
- 48656C6C6F2077696B697065646961
- 00000000
- 001d00026566
-'''
-print stars, prettydump(x)
-
-
-x = '''
- 00000000 # command_length
- 00000021 # command_id
- 00000000 # command_status
- 00000000 # sequence_number
- 00
- 00
- 00
- 00
- 02
- 01 01 01 6500
- 02 6600
- 00
- 00
- 00
- 00
- 00
- 00
- 00
- 00
- 00
- 00
- 0005 0002 0000
- 0000 0004 00000000
-'''
-print stars, prettydump(x)
-
-
-x = '''
- 00000000
- 80000021
- 00000000
- 00000000
- 00
- 02
- 01016565650000000000
- 01016666660000000000
-'''
-print stars, prettydump(x)
-
-
-
-
-quit()
-class PythonSmppTestCase(TestCase):
-
- def setUp(self):
- # Sample dictionary used for packing & unpacking
- self.dictionary = {
- 'header': {
- 'command_length': 16,
- 'command_id': 'bind_transmitter',
- 'command_status': 'ESME_ROK',
- 'sequence_number': 0
- },
- 'body': {
- 'mandatory_parameters': {
- 'system_id':'test_system',
- 'password':'abc123',
- 'system_type':'',
- 'interface_version':'',
- 'addr_ton':1,
- 'addr_npi':1,
- 'address_range':'',
- },
- 'optional_parameters': [
- {
- 'tag':'payload_type',
- 'value':0
- }
- ]
- }
- }
-
- def tearDown(self):
- pass
-
- def test_pretty_dump_1(self):
- """Read the hex data, clean it and display the JSON"""
- x = '''
- 0000003C # command_length
- 00000004 # command_id
- 00000000 # command_status
- 00000005 # sequence_number
- 00
- 02
- 08
- 35353500
- 01
- 01
- 35353535353535353500
- 00
- 00
- 00
- 00
- 00
- 00
- 00
- 00
- 00
- 0F
- 48656C6C6F2077696B697065646961
- 00000000
- 001d00026566
- '''
-
- self.assertEquals(unpack(x), {
- "body": {
- "mandatory_parameters": {
- "data_coding": 0,
- "dest_addr_npi": "ISDN",
- "dest_addr_ton": "international",
- "destination_addr": "555555555",
- "esm_class": 0,
- "priority_flag": 0,
- "protocol_id": 0,
- "registered_delivery": 0,
- "replace_if_present_flag": 0,
- "schedule_delivery_time": "",
- "service_type": "",
- "short_message": "Hello wikipedia",
- "sm_default_msg_id": 0,
- "sm_length": 15,
- "source_addr": "555",
- "source_addr_npi": "national",
- "source_addr_ton": "national",
- "validity_period": ""
- },
- "optional_parameters": [
- {
- "length": 0,
- "tag": "0000",
- "value": None
- },
- {
- "length": 2,
- "tag": "additional_status_info_text",
- "value": "ef"
- }
- ]
- },
- "header": {
- "command_id": "submit_sm",
- "command_length": 60,
- "command_status": "ESME_ROK",
- "sequence_number": 5
- }
- })
-
- def test_pretty_dump_2(self):
- """Read the hex data, clean it and display the JSON"""
- x = '''
- 00000000 # command_length
- 00000021 # command_id
- 00000000 # command_status
- 00000000 # sequence_number
- 00
- 00
- 00
- 00
- 02
- 01 01 01 6500
- 02 6600
- 00
- 00
- 00
- 00
- 00
- 00
- 00
- 00
- 00
- 00
- 0005 0002 0000
- 0000 0004 00000000
- '''
- self.assertEquals(unpack(x), {
- "body": {
- "mandatory_parameters": {
- "priority_flag": 0,
- "number_of_dests": 2,
- "protocol_id": 0,
- "dest_address": [{
- "dest_flag": 1,
- "dest_addr_npi": "ISDN",
- "dest_addr_ton": "international",
- "destination_addr": "e"
- },
- {
- "dest_flag": 2,
- "dl_name": "f"
- }],
- "replace_if_present_flag": 0,
- "registered_delivery": 0,
- "source_addr_npi": "unknown",
- "schedule_delivery_time": "",
- "sm_default_msg_id": 0,
- "sm_length": 0,
- "esm_class": 0,
- "data_coding": 0,
- "service_type": "",
- "source_addr": "",
- "source_addr_ton": "unknown",
- "validity_period": "",
- "short_message": ""
- },
- "optional_parameters": [{
- "length": 2,
- "tag": "dest_addr_subunit",
- "value": 0
- },
- {
- "length": 4,
- "tag": "0000",
- "value": "00000000"
- }]
- },
- "header": {
- "command_status": "ESME_ROK",
- "command_length": 0,
- "sequence_number": 0,
- "command_id": "submit_multi"
- }
- })
-
- def test_pretty_dump_3(self):
- """Read the hex data, clean it and display the JSON"""
- x = '''
- 00000000
- 80000021
- 00000000
- 00000000
- 00
- 02
- 01016565650000000000
- 01016666660000000000
- '''
- self.assertEquals(unpack(x), {
- "body": {
- "mandatory_parameters": {
- "message_id": "",
- "no_unsuccess": 2,
- "unsuccess_sme": [{
- "error_status_code": 0,
- "dest_addr_npi": "ISDN",
- "dest_addr_ton": "international",
- "destination_addr": "eee"
- },
- {
- "error_status_code": 0,
- "dest_addr_npi": "ISDN",
- "dest_addr_ton": "international",
- "destination_addr": "fff"
- }]
- }
- },
- "header": {
- "command_status": "ESME_ROK",
- "command_length": 0,
- "sequence_number": 0,
- "command_id": "submit_multi_resp"
- }
- })
-
- def test_packing_of_dictionary(self):
- """
- It should take a dictionary, pack and unpack it and dump
- it as JSON correctly.
- """
- dictionary = self.dictionary.copy()
- print json.dumps(unpack_pdu(pack_pdu(dictionary)), indent=4, sort_keys=True)
-
- def test_packing_of_100000_sequence(self):
- """Test time to pack & unpack 10000 dictionaries"""
- dictionary = self.dictionary.copy()
- start = datetime.now()
- for x in range(100000):
- dictionary['header']['sequence_number'] = x
- u = unpack_pdu(pack_pdu(dictionary))
- print x+1, ':', datetime.now() - start
-
-
|
dmaclay/python-smpp
|
fb512d0a6cbfcbbdb6a8ec42c72cc3d91437a496
|
hex strings test
|
diff --git a/tests.py b/tests.py
index 5c24ca3..6fad583 100644
--- a/tests.py
+++ b/tests.py
@@ -1,464 +1,481 @@
import unittest
from datetime import datetime, timedelta
try:
from smpp.esme import *
except:
from src.smpp.esme import *
from test.pdu import pdu_objects
from test import pdu_asserts
from test.pdu_hex import pdu_hex_strings
+from test import pdu_hex_asserts
def unpack_hex(pdu_hex):
"""Unpack PDU hex string and return it as a dictionary"""
return unpack_pdu(binascii.a2b_hex(hexclean(pdu_hex)))
def hexclean(dirtyhex):
"""Remove whitespace, comments & newlines from hex string"""
return re.sub(r'\s','',re.sub(r'#.*\n','\n',dirtyhex))
def prettydump(pdu_obj):
"""Unpack PDU dictionary and dump it as a JSON formatted string"""
return json.dumps(pdu_obj, indent=4, sort_keys=True)
def create_pdu_asserts():
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_pdu(pack_pdu(pdu)))
pstr += "'''"
print pstr
def create_pdu_hex_asserts():
pdu_index = 0
for pdu_hex in pdu_hex_strings:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
pstr += prettydump(unpack_hex(pdu_hex))
pstr += "'''"
print pstr
## :w|!python % > test/pdu_asserts.py
#create_pdu_asserts()
#quit()
## :w|!python % > test/pdu_hex_asserts.py
-create_pdu_hex_asserts()
-quit()
+#create_pdu_hex_asserts()
+#quit()
class SmppTestCase(unittest.TestCase):
def setUp(self):
pass
def tearDown(self):
pass
def test_pack_unpack_pdu_objects(self):
+ print '\npdu_objects'
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
padded_index = '%010d' % pdu_index
print padded_index
self.assertEquals(
re.sub('\n *','',
prettydump(unpack_pdu(pack_pdu(pdu)))),
re.sub('\n *','',
eval('pdu_asserts.pdu_json_'+padded_index)))
- def test_pack_unpack_preformance(self):
+ def test_pack_unpack_pdu_hex_strings(self):
+ print '\npdu_hex_strings'
+ pdu_index = 0
+ for pdu_hex in pdu_hex_strings:
+ pdu_index += 1
+ padded_index = '%010d' % pdu_index
+ print padded_index
+ self.assertEquals(
+ re.sub('\n *','',
+ prettydump(unpack_hex(pdu_hex))),
+ re.sub('\n *','',
+ eval('pdu_hex_asserts.pdu_json_'+padded_index)))
+
+
+ def test_pack_unpack_performance(self):
+ print '\npack_unpack_performance'
submit_sm = {
'header': {
'command_length': 0,
'command_id': 'submit_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
'esm_class':0,
'protocol_id':0,
'priority_flag':0,
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
'sm_length':1,
'short_message':'',
},
},
}
start = datetime.now()
for x in range(2000):
x += 1
submit_sm['header']['sequence_number'] = x
sm = 'testing: x = '+str(x)+''
submit_sm['body']['mandatory_parameters']['short_message'] = sm
u = unpack_pdu(pack_pdu(submit_sm))
delta = datetime.now() - start
- print '\n2000 pack/unpacks:', delta
+ print '2000 pack/unpacks in:', delta
self.assertTrue(delta < timedelta(seconds=1))
if __name__ == '__main__':
unittest.main()
quit()
stars = "\n******************************************************************\n"
print ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>"
#esme = ESME()
#esme.connect_SMSC('localhost')
#esme.bind_SMSC()
#esme.disconnect_SMSC()
print ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>"
x = '''
0000003C # command_length
00000004 # command_id
00000000 # command_status
00000005 # sequence_number
00
02
08
35353500
01
01
35353535353535353500
00
00
00
00
00
00
00
00
00
0F
48656C6C6F2077696B697065646961
00000000
001d00026566
'''
print stars, prettydump(x)
x = '''
00000000 # command_length
00000021 # command_id
00000000 # command_status
00000000 # sequence_number
00
00
00
00
02
01 01 01 6500
02 6600
00
00
00
00
00
00
00
00
00
00
0005 0002 0000
0000 0004 00000000
'''
print stars, prettydump(x)
x = '''
00000000
80000021
00000000
00000000
00
02
01016565650000000000
01016666660000000000
'''
print stars, prettydump(x)
quit()
class PythonSmppTestCase(TestCase):
def setUp(self):
# Sample dictionary used for packing & unpacking
self.dictionary = {
'header': {
'command_length': 16,
'command_id': 'bind_transmitter',
'command_status': 'ESME_ROK',
'sequence_number': 0
},
'body': {
'mandatory_parameters': {
'system_id':'test_system',
'password':'abc123',
'system_type':'',
'interface_version':'',
'addr_ton':1,
'addr_npi':1,
'address_range':'',
},
'optional_parameters': [
{
'tag':'payload_type',
'value':0
}
]
}
}
def tearDown(self):
pass
def test_pretty_dump_1(self):
"""Read the hex data, clean it and display the JSON"""
x = '''
0000003C # command_length
00000004 # command_id
00000000 # command_status
00000005 # sequence_number
00
02
08
35353500
01
01
35353535353535353500
00
00
00
00
00
00
00
00
00
0F
48656C6C6F2077696B697065646961
00000000
001d00026566
'''
self.assertEquals(unpack(x), {
"body": {
"mandatory_parameters": {
"data_coding": 0,
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "555555555",
"esm_class": 0,
"priority_flag": 0,
"protocol_id": 0,
"registered_delivery": 0,
"replace_if_present_flag": 0,
"schedule_delivery_time": "",
"service_type": "",
"short_message": "Hello wikipedia",
"sm_default_msg_id": 0,
"sm_length": 15,
"source_addr": "555",
"source_addr_npi": "national",
"source_addr_ton": "national",
"validity_period": ""
},
"optional_parameters": [
{
"length": 0,
"tag": "0000",
"value": None
},
{
"length": 2,
"tag": "additional_status_info_text",
"value": "ef"
}
]
},
"header": {
"command_id": "submit_sm",
"command_length": 60,
"command_status": "ESME_ROK",
"sequence_number": 5
}
})
def test_pretty_dump_2(self):
"""Read the hex data, clean it and display the JSON"""
x = '''
00000000 # command_length
00000021 # command_id
00000000 # command_status
00000000 # sequence_number
00
00
00
00
02
01 01 01 6500
02 6600
00
00
00
00
00
00
00
00
00
00
0005 0002 0000
0000 0004 00000000
'''
self.assertEquals(unpack(x), {
"body": {
"mandatory_parameters": {
"priority_flag": 0,
"number_of_dests": 2,
"protocol_id": 0,
"dest_address": [{
"dest_flag": 1,
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "e"
},
{
"dest_flag": 2,
"dl_name": "f"
}],
"replace_if_present_flag": 0,
"registered_delivery": 0,
"source_addr_npi": "unknown",
"schedule_delivery_time": "",
"sm_default_msg_id": 0,
"sm_length": 0,
"esm_class": 0,
"data_coding": 0,
"service_type": "",
"source_addr": "",
"source_addr_ton": "unknown",
"validity_period": "",
"short_message": ""
},
"optional_parameters": [{
"length": 2,
"tag": "dest_addr_subunit",
"value": 0
},
{
"length": 4,
"tag": "0000",
"value": "00000000"
}]
},
"header": {
"command_status": "ESME_ROK",
"command_length": 0,
"sequence_number": 0,
"command_id": "submit_multi"
}
})
def test_pretty_dump_3(self):
"""Read the hex data, clean it and display the JSON"""
x = '''
00000000
80000021
00000000
00000000
00
02
01016565650000000000
01016666660000000000
'''
self.assertEquals(unpack(x), {
"body": {
"mandatory_parameters": {
"message_id": "",
"no_unsuccess": 2,
"unsuccess_sme": [{
"error_status_code": 0,
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "eee"
},
{
"error_status_code": 0,
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "fff"
}]
}
},
"header": {
"command_status": "ESME_ROK",
"command_length": 0,
"sequence_number": 0,
"command_id": "submit_multi_resp"
}
})
def test_packing_of_dictionary(self):
"""
It should take a dictionary, pack and unpack it and dump
it as JSON correctly.
"""
dictionary = self.dictionary.copy()
print json.dumps(unpack_pdu(pack_pdu(dictionary)), indent=4, sort_keys=True)
def test_packing_of_100000_sequence(self):
"""Test time to pack & unpack 10000 dictionaries"""
dictionary = self.dictionary.copy()
start = datetime.now()
for x in range(100000):
dictionary['header']['sequence_number'] = x
u = unpack_pdu(pack_pdu(dictionary))
print x+1, ':', datetime.now() - start
|
dmaclay/python-smpp
|
e17c792e3003ad3d9bef1336d5c8ab69db7bd5eb
|
pdu hex asserts
|
diff --git a/test/pdu_hex.py b/test/pdu_hex.py
new file mode 100644
index 0000000..df5a1c4
--- /dev/null
+++ b/test/pdu_hex.py
@@ -0,0 +1,68 @@
+
+pdu_hex_strings = [
+ '''
+ 0000003C # command_length
+ 00000004 # command_id
+ 00000000 # command_status
+ 00000005 # sequence_number
+ 00
+ 02
+ 08
+ 35353500
+ 01
+ 01
+ 35353535353535353500
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 0F
+ 48656C6C6F2077696B697065646961
+ 00000000
+ 001d00026566
+ ''',
+
+ '''
+ 00000000 # command_length
+ 00000021 # command_id
+ 00000000 # command_status
+ 00000000 # sequence_number
+ 00
+ 00
+ 00
+ 00
+ 02
+ 01 01 01 6500
+ 02 6600
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 0005 0002 0000
+ 0000 0004 00000000
+ ''',
+
+ '''
+ 00000000
+ 80000021
+ 00000000
+ 00000000
+ 00
+ 02
+ 01016565650000000000
+ 01016666660000000000
+ ''',
+
+]
+
diff --git a/test/pdu_hex_asserts.py b/test/pdu_hex_asserts.py
new file mode 100644
index 0000000..9a553b1
--- /dev/null
+++ b/test/pdu_hex_asserts.py
@@ -0,0 +1,128 @@
+
+########################################
+pdu_json_0000000001 = '''{
+ "body": {
+ "mandatory_parameters": {
+ "data_coding": 0,
+ "dest_addr_npi": "ISDN",
+ "dest_addr_ton": "international",
+ "destination_addr": "555555555",
+ "esm_class": 0,
+ "priority_flag": 0,
+ "protocol_id": 0,
+ "registered_delivery": 0,
+ "replace_if_present_flag": 0,
+ "schedule_delivery_time": "",
+ "service_type": "",
+ "short_message": "Hello wikipedia",
+ "sm_default_msg_id": 0,
+ "sm_length": 15,
+ "source_addr": "555",
+ "source_addr_npi": "national",
+ "source_addr_ton": "national",
+ "validity_period": ""
+ },
+ "optional_parameters": [
+ {
+ "length": 0,
+ "tag": "0000",
+ "value": null
+ },
+ {
+ "length": 2,
+ "tag": "additional_status_info_text",
+ "value": "ef"
+ }
+ ]
+ },
+ "header": {
+ "command_id": "submit_sm",
+ "command_length": 60,
+ "command_status": "ESME_ROK",
+ "sequence_number": 5
+ }
+}'''
+
+########################################
+pdu_json_0000000002 = '''{
+ "body": {
+ "mandatory_parameters": {
+ "data_coding": 0,
+ "dest_address": [
+ {
+ "dest_addr_npi": "ISDN",
+ "dest_addr_ton": "international",
+ "dest_flag": 1,
+ "destination_addr": "e"
+ },
+ {
+ "dest_flag": 2,
+ "dl_name": "f"
+ }
+ ],
+ "esm_class": 0,
+ "number_of_dests": 2,
+ "priority_flag": 0,
+ "protocol_id": 0,
+ "registered_delivery": 0,
+ "replace_if_present_flag": 0,
+ "schedule_delivery_time": "",
+ "service_type": "",
+ "short_message": "",
+ "sm_default_msg_id": 0,
+ "sm_length": 0,
+ "source_addr": "",
+ "source_addr_npi": "unknown",
+ "source_addr_ton": "unknown",
+ "validity_period": ""
+ },
+ "optional_parameters": [
+ {
+ "length": 2,
+ "tag": "dest_addr_subunit",
+ "value": 0
+ },
+ {
+ "length": 4,
+ "tag": "0000",
+ "value": "00000000"
+ }
+ ]
+ },
+ "header": {
+ "command_id": "submit_multi",
+ "command_length": 0,
+ "command_status": "ESME_ROK",
+ "sequence_number": 0
+ }
+}'''
+
+########################################
+pdu_json_0000000003 = '''{
+ "body": {
+ "mandatory_parameters": {
+ "message_id": "",
+ "no_unsuccess": 2,
+ "unsuccess_sme": [
+ {
+ "dest_addr_npi": "ISDN",
+ "dest_addr_ton": "international",
+ "destination_addr": "eee",
+ "error_status_code": 0
+ },
+ {
+ "dest_addr_npi": "ISDN",
+ "dest_addr_ton": "international",
+ "destination_addr": "fff",
+ "error_status_code": 0
+ }
+ ]
+ }
+ },
+ "header": {
+ "command_id": "submit_multi_resp",
+ "command_length": 0,
+ "command_status": "ESME_ROK",
+ "sequence_number": 0
+ }
+}'''
diff --git a/tests.py b/tests.py
index a300fcf..5c24ca3 100644
--- a/tests.py
+++ b/tests.py
@@ -1,451 +1,464 @@
import unittest
from datetime import datetime, timedelta
try:
from smpp.esme import *
except:
from src.smpp.esme import *
from test.pdu import pdu_objects
from test import pdu_asserts
+from test.pdu_hex import pdu_hex_strings
+def unpack_hex(pdu_hex):
+ """Unpack PDU hex string and return it as a dictionary"""
+ return unpack_pdu(binascii.a2b_hex(hexclean(pdu_hex)))
+
+def hexclean(dirtyhex):
+ """Remove whitespace, comments & newlines from hex string"""
+ return re.sub(r'\s','',re.sub(r'#.*\n','\n',dirtyhex))
+
+def prettydump(pdu_obj):
+ """Unpack PDU dictionary and dump it as a JSON formatted string"""
+ return json.dumps(pdu_obj, indent=4, sort_keys=True)
+
def create_pdu_asserts():
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
pstr = "\n########################################\n"
pstr += "pdu_json_"
pstr += ('%010d' % pdu_index)
pstr += " = '''"
- pstr += json.dumps(
- unpack_pdu(pack_pdu(pdu)),
- indent=4,
- sort_keys=True)
+ pstr += prettydump(unpack_pdu(pack_pdu(pdu)))
+ pstr += "'''"
+ print pstr
+
+
+def create_pdu_hex_asserts():
+ pdu_index = 0
+ for pdu_hex in pdu_hex_strings:
+ pdu_index += 1
+ pstr = "\n########################################\n"
+ pstr += "pdu_json_"
+ pstr += ('%010d' % pdu_index)
+ pstr += " = '''"
+ pstr += prettydump(unpack_hex(pdu_hex))
pstr += "'''"
print pstr
## :w|!python % > test/pdu_asserts.py
#create_pdu_asserts()
#quit()
+## :w|!python % > test/pdu_hex_asserts.py
+create_pdu_hex_asserts()
+quit()
+
class SmppTestCase(unittest.TestCase):
def setUp(self):
pass
def tearDown(self):
pass
def test_pack_unpack_pdu_objects(self):
pdu_index = 0
for pdu in pdu_objects:
pdu_index += 1
padded_index = '%010d' % pdu_index
print padded_index
self.assertEquals(
re.sub('\n *','',
- json.dumps(
- unpack_pdu(pack_pdu(pdu)),
- indent=4,
- sort_keys=True)),
+ prettydump(unpack_pdu(pack_pdu(pdu)))),
re.sub('\n *','',
eval('pdu_asserts.pdu_json_'+padded_index)))
def test_pack_unpack_preformance(self):
submit_sm = {
'header': {
'command_length': 0,
'command_id': 'submit_sm',
'command_status': 'ESME_ROK',
'sequence_number': 0,
},
'body': {
'mandatory_parameters': {
'service_type':'',
'source_addr_ton':1,
'source_addr_npi':1,
'source_addr':'',
'dest_addr_ton':1,
'dest_addr_npi':1,
'destination_addr':'',
'esm_class':0,
'protocol_id':0,
'priority_flag':0,
'schedule_delivery_time':'',
'validity_period':'',
'registered_delivery':0,
'replace_if_present_flag':0,
'data_coding':0,
'sm_default_msg_id':0,
'sm_length':1,
'short_message':'',
},
},
}
start = datetime.now()
for x in range(2000):
x += 1
submit_sm['header']['sequence_number'] = x
sm = 'testing: x = '+str(x)+''
submit_sm['body']['mandatory_parameters']['short_message'] = sm
u = unpack_pdu(pack_pdu(submit_sm))
delta = datetime.now() - start
print '\n2000 pack/unpacks:', delta
self.assertTrue(delta < timedelta(seconds=1))
if __name__ == '__main__':
unittest.main()
quit()
-def unpack(pdu_hex):
- """Unpack PDU and return it as a dictionary"""
- return unpack_pdu(binascii.a2b_hex(hexclean(pdu_hex)))
-
-def prettydump(pdu_hex):
- """Unpack PDU and dump it as a JSON formatted string"""
- return json.dumps(unpack_pdu(binascii.a2b_hex(hexclean(x))), indent=4, sort_keys=True)
-
-def hexclean(dirtyhex):
- """Remove whitespace, comments & newlines from hex string"""
- return re.sub(r'\s','',re.sub(r'#.*\n','\n',dirtyhex))
stars = "\n******************************************************************\n"
print ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>"
#esme = ESME()
#esme.connect_SMSC('localhost')
#esme.bind_SMSC()
#esme.disconnect_SMSC()
print ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>"
x = '''
0000003C # command_length
00000004 # command_id
00000000 # command_status
00000005 # sequence_number
00
02
08
35353500
01
01
35353535353535353500
00
00
00
00
00
00
00
00
00
0F
48656C6C6F2077696B697065646961
00000000
001d00026566
'''
print stars, prettydump(x)
x = '''
00000000 # command_length
00000021 # command_id
00000000 # command_status
00000000 # sequence_number
00
00
00
00
02
01 01 01 6500
02 6600
00
00
00
00
00
00
00
00
00
00
0005 0002 0000
0000 0004 00000000
'''
print stars, prettydump(x)
x = '''
00000000
80000021
00000000
00000000
00
02
01016565650000000000
01016666660000000000
'''
print stars, prettydump(x)
quit()
class PythonSmppTestCase(TestCase):
def setUp(self):
# Sample dictionary used for packing & unpacking
self.dictionary = {
'header': {
'command_length': 16,
'command_id': 'bind_transmitter',
'command_status': 'ESME_ROK',
'sequence_number': 0
},
'body': {
'mandatory_parameters': {
'system_id':'test_system',
'password':'abc123',
'system_type':'',
'interface_version':'',
'addr_ton':1,
'addr_npi':1,
'address_range':'',
},
'optional_parameters': [
{
'tag':'payload_type',
'value':0
}
]
}
}
def tearDown(self):
pass
def test_pretty_dump_1(self):
"""Read the hex data, clean it and display the JSON"""
x = '''
0000003C # command_length
00000004 # command_id
00000000 # command_status
00000005 # sequence_number
00
02
08
35353500
01
01
35353535353535353500
00
00
00
00
00
00
00
00
00
0F
48656C6C6F2077696B697065646961
00000000
001d00026566
'''
self.assertEquals(unpack(x), {
"body": {
"mandatory_parameters": {
"data_coding": 0,
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "555555555",
"esm_class": 0,
"priority_flag": 0,
"protocol_id": 0,
"registered_delivery": 0,
"replace_if_present_flag": 0,
"schedule_delivery_time": "",
"service_type": "",
"short_message": "Hello wikipedia",
"sm_default_msg_id": 0,
"sm_length": 15,
"source_addr": "555",
"source_addr_npi": "national",
"source_addr_ton": "national",
"validity_period": ""
},
"optional_parameters": [
{
"length": 0,
"tag": "0000",
"value": None
},
{
"length": 2,
"tag": "additional_status_info_text",
"value": "ef"
}
]
},
"header": {
"command_id": "submit_sm",
"command_length": 60,
"command_status": "ESME_ROK",
"sequence_number": 5
}
})
def test_pretty_dump_2(self):
"""Read the hex data, clean it and display the JSON"""
x = '''
00000000 # command_length
00000021 # command_id
00000000 # command_status
00000000 # sequence_number
00
00
00
00
02
01 01 01 6500
02 6600
00
00
00
00
00
00
00
00
00
00
0005 0002 0000
0000 0004 00000000
'''
self.assertEquals(unpack(x), {
"body": {
"mandatory_parameters": {
"priority_flag": 0,
"number_of_dests": 2,
"protocol_id": 0,
"dest_address": [{
"dest_flag": 1,
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "e"
},
{
"dest_flag": 2,
"dl_name": "f"
}],
"replace_if_present_flag": 0,
"registered_delivery": 0,
"source_addr_npi": "unknown",
"schedule_delivery_time": "",
"sm_default_msg_id": 0,
"sm_length": 0,
"esm_class": 0,
"data_coding": 0,
"service_type": "",
"source_addr": "",
"source_addr_ton": "unknown",
"validity_period": "",
"short_message": ""
},
"optional_parameters": [{
"length": 2,
"tag": "dest_addr_subunit",
"value": 0
},
{
"length": 4,
"tag": "0000",
"value": "00000000"
}]
},
"header": {
"command_status": "ESME_ROK",
"command_length": 0,
"sequence_number": 0,
"command_id": "submit_multi"
}
})
def test_pretty_dump_3(self):
"""Read the hex data, clean it and display the JSON"""
x = '''
00000000
80000021
00000000
00000000
00
02
01016565650000000000
01016666660000000000
'''
self.assertEquals(unpack(x), {
"body": {
"mandatory_parameters": {
"message_id": "",
"no_unsuccess": 2,
"unsuccess_sme": [{
"error_status_code": 0,
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "eee"
},
{
"error_status_code": 0,
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "fff"
}]
}
},
"header": {
"command_status": "ESME_ROK",
"command_length": 0,
"sequence_number": 0,
"command_id": "submit_multi_resp"
}
})
def test_packing_of_dictionary(self):
"""
It should take a dictionary, pack and unpack it and dump
it as JSON correctly.
"""
dictionary = self.dictionary.copy()
print json.dumps(unpack_pdu(pack_pdu(dictionary)), indent=4, sort_keys=True)
def test_packing_of_100000_sequence(self):
"""Test time to pack & unpack 10000 dictionaries"""
dictionary = self.dictionary.copy()
start = datetime.now()
for x in range(100000):
dictionary['header']['sequence_number'] = x
u = unpack_pdu(pack_pdu(dictionary))
print x+1, ':', datetime.now() - start
|
dmaclay/python-smpp
|
18ecfac7534625d560fd44a57b382923c6c574e4
|
performance test
|
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..0ec0997
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,4 @@
+*.swp
+*.pyc
+*.egg-info
+ve/
diff --git a/LICENCE b/LICENCE
new file mode 100644
index 0000000..08cd4b2
--- /dev/null
+++ b/LICENCE
@@ -0,0 +1,18 @@
+Copyright (c) Praekelt Foundation and individual contributors.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+ 1. Redistributions of source code must retain the above copyright notice,
+ this list of conditions and the following disclaimer.
+
+ 2. Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+
+ 3. Neither the name of the Praekelt Foundation nor the names of its
+ contributors may be used to endorse or promote products derived from
+ this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..631e0b0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+Python SMPP
+===========
+
+An SMPP version 3.4 library written in Python, suitable for use in [Twisted][twisted]
+
+To get started with development:
+
+ $ virtualenv --no-site-packges ve/
+ $ source ve/bin/activate
+ (ve)$ pip install -r requirements.pip
+ (ve)$ python setup.py develop
+ (ve)$ python
+ >>> import smpp
+ >>>
+
+Run the tests with nose
+
+ (ve)$ nosetests
+
+[twisted]: http://www.twistedmatrix.com
diff --git a/requirements.pip b/requirements.pip
new file mode 100644
index 0000000..a6c88f5
--- /dev/null
+++ b/requirements.pip
@@ -0,0 +1,2 @@
+nose
+coverage
diff --git a/setup.cfg b/setup.cfg
new file mode 100644
index 0000000..9eec931
--- /dev/null
+++ b/setup.cfg
@@ -0,0 +1,3 @@
+[nosetests]
+with-doctest=1
+nocapture=1
diff --git a/setup.py b/setup.py
new file mode 100644
index 0000000..3883e9c
--- /dev/null
+++ b/setup.py
@@ -0,0 +1,14 @@
+from setuptools import setup, find_packages
+
+setup(
+ name = "python-smpp",
+ version = "0.1",
+ url = 'http://github.com/dmaclay/python-smpp',
+ license = 'BSD',
+ description = "Python SMPP Library",
+ author = 'David Maclay',
+ packages = find_packages('src'),
+ package_dir = {'': 'src'},
+ install_requires = [],
+)
+
diff --git a/src/__init__.py b/src/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/src/smpp/__init__.py b/src/smpp/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/src/smpp/esme.py b/src/smpp/esme.py
new file mode 100644
index 0000000..75497e7
--- /dev/null
+++ b/src/smpp/esme.py
@@ -0,0 +1,29 @@
+import socket
+
+from pdu import *
+
+
+class ESME:
+
+ def __init__(self):
+ self.conn = None
+
+ def connect_SMSC(self, host='127.0.0.1', port=2775):
+ self.conn = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+ self.conn.connect((host, port))
+
+ def disconnect_SMSC(self):
+ self.conn.close()
+
+
+ def bind_SMSC(self):
+ out_hex = re.sub(r'\s','','''00 00 00 2F 00 00 00 02 00 00 00 00 00 00 00 01 53 4D 50 50 33 54 45 53 54 00 73 65 63 72 65 74 30 38 00 53 55 42 4D 49 54 31 00 00 01 01 00''')
+ print '<<<< bind_SMSC out_hex >>>>', out_hex
+ out_bin = binascii.a2b_hex(out_hex)
+ self.conn.send(out_bin)
+ length_bin = self.conn.recv(4)
+ length = int(binascii.b2a_hex(length_bin),16)
+ rest_bin = self.conn.recv(length-4)
+ unpack_pdu(length_bin + rest_bin)
+
+
diff --git a/src/smpp/pdu.py b/src/smpp/pdu.py
new file mode 100644
index 0000000..979af1e
--- /dev/null
+++ b/src/smpp/pdu.py
@@ -0,0 +1,1036 @@
+import binascii
+import re
+try:
+ import json
+except:
+ import simplejson as json
+
+
+
+
+maps = {} # Inserting certain referenced dicts in here means they can be declared in the same order as in the spec.
+
+
+# SMPP PDU Definition - SMPP v3.4, section 4, page 45
+
+mandatory_parameter_lists = {
+ 'bind_transmitter':[ # SMPP v3.4, section 4.1.1, table 4-1, page 46
+ {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None},
+ {'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'map':None},
+ {'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'map':None},
+ {'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'string', 'map':None},
+ {'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
+ {'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
+ {'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'map':None}
+ ],
+ 'bind_transmitter_resp':[ # SMPP v3.4, section 4.1.2, table 4-2, page 47
+ {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None}
+ ],
+ 'bind_receiver':[ # SMPP v3.4, section 4.1.3, table 4-3, page 48
+ {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None},
+ {'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'map':None},
+ {'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'map':None},
+ {'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'string', 'map':None},
+ {'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
+ {'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
+ {'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'map':None}
+ ],
+ 'bind_receiver_resp':[ # SMPP v3.4, section 4.1.4, table 4-4, page 50
+ {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None}
+ ],
+ 'bind_transceiver':[ # SMPP v3.4, section 4.1.5, table 4-5, page 51
+ {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None},
+ {'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'map':None},
+ {'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'map':None},
+ {'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'string', 'map':None},
+ {'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
+ {'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
+ {'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'map':None}
+ ],
+ 'bind_transceiver_resp':[ # SMPP v3.4, section 4.1.6, table 4-6, page 52
+ {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None}
+ ],
+ 'outbind':[ # SMPP v3.4, section 4.1.7.1, page 54
+ {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None},
+ {'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'map':None}
+ ],
+ 'unbind':[ # SMPP v3.4, section 4.2.1, table 4-7, page 56
+ ],
+ 'unbind_resp':[ # SMPP v3.4, section 4.2.2, table 4-8, page 56
+ ],
+ 'generic_nack':[ # SMPP v3.4, section 4.3.1, table 4-9, page 57
+ ],
+ 'submit_sm':[ # SMPP v3.4, section 4.4.1, table 4-10, page 59-61
+ {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'map':None},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
+ {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
+ {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
+ {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
+ {'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
+ {'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
+ {'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
+ {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'map':None}
+ ],
+ 'submit_sm_resp':[ # SMPP v3.4, section 4.4.2, table 4-11, page 67
+ {'name':'message_id', 'min':0, 'max':65, 'var':True, 'type':'string', 'map':None}
+ ],
+ 'submit_multi':[ # SMPP v3.4, section 4.5.1, table 4-12, page 69-71
+ {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'map':None},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
+ {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
+ {'name':'number_of_dests', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'dest_address', 'min':0, 'max':0, 'var':'number_of_dests', 'type':'dest_address', 'map':None},
+ {'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
+ {'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
+ {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'map':None}
+ ],
+ 'dest_address':[ # SMPP v3.4, section 4.5.1.1, table 4-13, page 75
+ {'name':'dest_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None}
+ # 'sme_dest_address' or 'distribution_list' goes here
+ ],
+ 'sme_dest_address':[ # SMPP v3.4, section 4.5.1.1, table 4-14, page 75
+ {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
+ {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
+ {'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None}
+ ],
+ 'distribution_list':[ # SMPP v3.4, section 4.5.1.2, table 4-15, page 75
+ {'name':'dl_name', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None}
+ ],
+ 'submit_multi_resp':[ # SMPP v3.4, section 4.5.2, table 4-16, page 76
+ {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
+ {'name':'no_unsuccess', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'unsuccess_sme', 'min':0, 'max':0, 'var':'no_unsuccess', 'type':'unsuccess_sme', 'map':None}
+ ],
+ 'unsuccess_sme':[ # SMPP v3.4, section 4.5.2.1, table 4-17, page 77
+ {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
+ {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
+ {'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
+ {'name':'error_status_code', 'min':4, 'max':4, 'var':False, 'type':'integer', 'map':None}
+ ],
+ 'deliver_sm':[ # SMPP v3.4, section 4.6.1, table 4-18, page 79-81
+ {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'map':None},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
+ {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
+ {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
+ {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
+ {'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
+ {'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'schedule_delivery_time', 'min':1, 'max':1, 'var':False, 'type':'string', 'map':None},
+ {'name':'validity_period', 'min':1, 'max':1, 'var':False, 'type':'string', 'map':None},
+ {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'map':None}
+ ],
+ 'deliver_sm_resp':[ # SMPP v3.4, section 4.6.2, table 4-19, page 85
+ {'name':'message_id', 'min':1, 'max':1, 'var':False, 'type':'string', 'map':None}
+ ],
+ 'data_sm':[ # SMPP v3.4, section 4.7.1, table 4-20, page 87-88
+ {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'map':None},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
+ {'name':'source_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
+ {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
+ {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
+ {'name':'destination_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
+ {'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None}
+ ],
+ 'data_sm_resp':[ # SMPP v3.4, section 4.7.2, table 4-21, page 93
+ {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None}
+ ],
+ 'query_sm':[ # SMPP v3.4, section 4.8.1, table 4-22, page 95
+ {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
+ {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None}
+ ],
+ 'query_sm_resp':[ # SMPP v3.4, section 4.7.2, table 4-21, page 93
+ {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
+ {'name':'final_date', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
+ {'name':'message_state', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'error_code', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None}
+ ],
+ 'cancel_sm':[ # SMPP v3.4, section 4.9.1, table 4-24, page 98-99
+ {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'map':None},
+ {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
+ {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
+ {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
+ {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
+ {'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None}
+ ],
+ 'cancel_sm_resp':[ # SMPP v3.4, section 4.9.2, table 4-25, page 100
+ ],
+ 'replace_sm':[ # SMPP v3.4, section 4.10.1, table 4-26, page 102-103
+ {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
+ {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
+ {'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
+ {'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
+ {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'map':None}
+ ],
+ 'replace_sm_resp':[ # SMPP v3.4, section 4.10.2, table 4-27, page 104
+ ],
+ 'enquire_link':[ # SMPP v3.4, section 4.11.1, table 4-28, page 106
+ ],
+ 'enquire_link_resp':[ # SMPP v3.4, section 4.11.2, table 4-29, page 106
+ ],
+ 'alert_notification':[ # SMPP v3.4, section 4.12.1, table 4-30, page 108
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
+ {'name':'source_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
+ {'name':'esme_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
+ {'name':'esme_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
+ {'name':'esme_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
+ ]
+}
+def mandatory_parameter_list_by_command_name(command_name):
+ return mandatory_parameter_lists.get(command_name,[])
+
+
+# Command IDs - SMPP v3.4, section 5.1.2.1, table 5-1, page 110-111
+
+command_id_by_hex = {
+ '80000000':{'hex':'80000000', 'name':'generic_nack'},
+ '00000001':{'hex':'00000001', 'name':'bind_receiver'},
+ '80000001':{'hex':'80000001', 'name':'bind_receiver_resp'},
+ '00000002':{'hex':'00000002', 'name':'bind_transmitter'},
+ '80000002':{'hex':'80000002', 'name':'bind_transmitter_resp'},
+ '00000003':{'hex':'00000003', 'name':'query_sm'},
+ '80000003':{'hex':'80000003', 'name':'query_sm_resp'},
+ '00000004':{'hex':'00000004', 'name':'submit_sm'},
+ '80000004':{'hex':'80000004', 'name':'submit_sm_resp'},
+ '00000005':{'hex':'00000005', 'name':'deliver_sm'},
+ '80000005':{'hex':'80000005', 'name':'deliver_sm_resp'},
+ '00000006':{'hex':'00000006', 'name':'unbind'},
+ '80000006':{'hex':'80000006', 'name':'unbind_resp'},
+ '00000007':{'hex':'00000007', 'name':'replace_sm'},
+ '80000007':{'hex':'80000007', 'name':'replace_sm_resp'},
+ '00000008':{'hex':'00000008', 'name':'cancel_sm'},
+ '80000008':{'hex':'80000008', 'name':'cancel_sm_resp'},
+ '00000009':{'hex':'00000009', 'name':'bind_transceiver'},
+ '80000009':{'hex':'80000009', 'name':'bind_transceiver_resp'},
+ '0000000b':{'hex':'0000000b', 'name':'outbind'},
+ '00000015':{'hex':'00000015', 'name':'enquire_link'},
+ '80000015':{'hex':'80000015', 'name':'enquire_link_resp'},
+ '00000021':{'hex':'00000021', 'name':'submit_multi'},
+ '80000021':{'hex':'80000021', 'name':'submit_multi_resp'},
+ '00000102':{'hex':'00000102', 'name':'alert_notification'},
+ '00000103':{'hex':'00000103', 'name':'data_sm'},
+ '80000103':{'hex':'80000103', 'name':'data_sm_resp'},
+
+ # v4 codes
+
+ '80010000':{'hex':'80010000', 'name':'generic_nack_v4'},
+ '00010001':{'hex':'00010001', 'name':'bind_receiver_v4'},
+ '80010001':{'hex':'80010001', 'name':'bind_receiver_resp_v4'},
+ '00010002':{'hex':'00010002', 'name':'bind_transmitter_v4'},
+ '80010002':{'hex':'80010002', 'name':'bind_transmitter_resp_v4'},
+ '00010003':{'hex':'00010003', 'name':'query_sm_v4'},
+ '80010003':{'hex':'80010003', 'name':'query_sm_resp_v4'},
+ '00010004':{'hex':'00010004', 'name':'submit_sm_v4'},
+ '80010004':{'hex':'80010004', 'name':'submit_sm_resp_v4'},
+ '00010005':{'hex':'00010005', 'name':'deliver_sm_v4'},
+ '80010005':{'hex':'80010005', 'name':'deliver_sm_resp_v4'},
+ '00010006':{'hex':'00010006', 'name':'unbind_v4'},
+ '80010006':{'hex':'80010006', 'name':'unbind_resp_v4'},
+ '00010007':{'hex':'00010007', 'name':'replace_sm_v4'},
+ '80010007':{'hex':'80010007', 'name':'replace_sm_resp_v4'},
+ '00010008':{'hex':'00010008', 'name':'cancel_sm_v4'},
+ '80010008':{'hex':'80010008', 'name':'cancel_sm_resp_v4'},
+ '00010009':{'hex':'00010009', 'name':'delivery_receipt_v4'},
+ '80010009':{'hex':'80010009', 'name':'delivery_receipt_resp_v4'},
+ '0001000a':{'hex':'0001000a', 'name':'enquire_link_v4'},
+ '8001000a':{'hex':'8001000a', 'name':'enquire_link_resp_v4'},
+ '0001000b':{'hex':'0001000b', 'name':'outbind_v4'},
+}
+def command_id_name_by_hex(x):
+ return command_id_by_hex.get(x,{}).get('name')
+
+
+command_id_by_name = {
+ 'generic_nack' :{'hex':'80000000', 'name':'generic_nack'},
+ 'bind_receiver' :{'hex':'00000001', 'name':'bind_receiver'},
+ 'bind_receiver_resp' :{'hex':'80000001', 'name':'bind_receiver_resp'},
+ 'bind_transmitter' :{'hex':'00000002', 'name':'bind_transmitter'},
+ 'bind_transmitter_resp' :{'hex':'80000002', 'name':'bind_transmitter_resp'},
+ 'query_sm' :{'hex':'00000003', 'name':'query_sm'},
+ 'query_sm_resp' :{'hex':'80000003', 'name':'query_sm_resp'},
+ 'submit_sm' :{'hex':'00000004', 'name':'submit_sm'},
+ 'submit_sm_resp' :{'hex':'80000004', 'name':'submit_sm_resp'},
+ 'deliver_sm' :{'hex':'00000005', 'name':'deliver_sm'},
+ 'deliver_sm_resp' :{'hex':'80000005', 'name':'deliver_sm_resp'},
+ 'unbind' :{'hex':'00000006', 'name':'unbind'},
+ 'unbind_resp' :{'hex':'80000006', 'name':'unbind_resp'},
+ 'replace_sm' :{'hex':'00000007', 'name':'replace_sm'},
+ 'replace_sm_resp' :{'hex':'80000007', 'name':'replace_sm_resp'},
+ 'cancel_sm' :{'hex':'00000008', 'name':'cancel_sm'},
+ 'cancel_sm_resp' :{'hex':'80000008', 'name':'cancel_sm_resp'},
+ 'bind_transceiver' :{'hex':'00000009', 'name':'bind_transceiver'},
+ 'bind_transceiver_resp' :{'hex':'80000009', 'name':'bind_transceiver_resp'},
+ 'outbind' :{'hex':'0000000b', 'name':'outbind'},
+ 'enquire_link' :{'hex':'00000015', 'name':'enquire_link'},
+ 'enquire_link_resp' :{'hex':'80000015', 'name':'enquire_link_resp'},
+ 'submit_multi' :{'hex':'00000021', 'name':'submit_multi'},
+ 'submit_multi_resp' :{'hex':'80000021', 'name':'submit_multi_resp'},
+ 'alert_notification' :{'hex':'00000102', 'name':'alert_notification'},
+ 'data_sm' :{'hex':'00000103', 'name':'data_sm'},
+ 'data_sm_resp' :{'hex':'80000103', 'name':'data_sm_resp'},
+
+ # v4 codes
+
+ 'generic_nack_v4' :{'hex':'80010000', 'name':'generic_nack_v4'},
+ 'bind_receiver_v4' :{'hex':'00010001', 'name':'bind_receiver_v4'},
+ 'bind_receiver_resp_v4' :{'hex':'80010001', 'name':'bind_receiver_resp_v4'},
+ 'bind_transmitter_v4' :{'hex':'00010002', 'name':'bind_transmitter_v4'},
+ 'bind_transmitter_resp_v4':{'hex':'80010002', 'name':'bind_transmitter_resp_v4'},
+ 'query_sm_v4' :{'hex':'00010003', 'name':'query_sm_v4'},
+ 'query_sm_resp_v4' :{'hex':'80010003', 'name':'query_sm_resp_v4'},
+ 'submit_sm_v4' :{'hex':'00010004', 'name':'submit_sm_v4'},
+ 'submit_sm_resp_v4' :{'hex':'80010004', 'name':'submit_sm_resp_v4'},
+ 'deliver_sm_v4' :{'hex':'00010005', 'name':'deliver_sm_v4'},
+ 'deliver_sm_resp_v4' :{'hex':'80010005', 'name':'deliver_sm_resp_v4'},
+ 'unbind_v4' :{'hex':'00010006', 'name':'unbind_v4'},
+ 'unbind_resp_v4' :{'hex':'80010006', 'name':'unbind_resp_v4'},
+ 'replace_sm_v4' :{'hex':'00010007', 'name':'replace_sm_v4'},
+ 'replace_sm_resp_v4' :{'hex':'80010007', 'name':'replace_sm_resp_v4'},
+ 'cancel_sm_v4' :{'hex':'00010008', 'name':'cancel_sm_v4'},
+ 'cancel_sm_resp_v4' :{'hex':'80010008', 'name':'cancel_sm_resp_v4'},
+ 'delivery_receipt_v4' :{'hex':'00010009', 'name':'delivery_receipt_v4'},
+ 'delivery_receipt_resp_v4':{'hex':'80010009', 'name':'delivery_receipt_resp_v4'},
+ 'enquire_link_v4' :{'hex':'0001000a', 'name':'enquire_link_v4'},
+ 'enquire_link_resp_v4' :{'hex':'8001000a', 'name':'enquire_link_resp_v4'},
+ 'outbind_v4' :{'hex':'0001000b', 'name':'outbind_v4'}
+}
+def command_id_hex_by_name(n):
+ return command_id_by_name.get(n,{}).get('hex')
+
+
+# SMPP Error Codes (ESME) - SMPP v3.4, section 5.1.3, table 5-2, page 112-114
+
+command_status_by_hex = {
+ '00000000':{'hex':'00000000', 'name':'ESME_ROK', 'description':'No error'},
+ '00000001':{'hex':'00000001', 'name':'ESME_RINVMSGLEN', 'description':'Message Length is invalid'},
+ '00000002':{'hex':'00000002', 'name':'ESME_RINVCMDLEN', 'description':'Command Length is invalid'},
+ '00000003':{'hex':'00000003', 'name':'ESME_RINVCMDID', 'description':'Invalid Command ID'},
+ '00000004':{'hex':'00000004', 'name':'ESME_RINVBNDSTS', 'description':'Incorrect BIND Status for given command'},
+ '00000005':{'hex':'00000005', 'name':'ESME_RALYBND', 'description':'ESME Already in bound state'},
+ '00000006':{'hex':'00000006', 'name':'ESME_RINVPRTFLG', 'description':'Invalid priority flag'},
+ '00000007':{'hex':'00000007', 'name':'ESME_RINVREGDLVFLG', 'description':'Invalid registered delivery flag'},
+ '00000008':{'hex':'00000008', 'name':'ESME_RSYSERR', 'description':'System Error'},
+ '0000000a':{'hex':'0000000a', 'name':'ESME_RINVSRCADR', 'description':'Invalid source address'},
+ '0000000b':{'hex':'0000000b', 'name':'ESME_RINVDSTADR', 'description':'Invalid destination address'},
+ '0000000c':{'hex':'0000000c', 'name':'ESME_RINVMSGID', 'description':'Message ID is invalid'},
+ '0000000d':{'hex':'0000000d', 'name':'ESME_RBINDFAIL', 'description':'Bind failed'},
+ '0000000e':{'hex':'0000000e', 'name':'ESME_RINVPASWD', 'description':'Invalid password'},
+ '0000000f':{'hex':'0000000f', 'name':'ESME_RINVSYSID', 'description':'Invalid System ID'},
+ '00000011':{'hex':'00000011', 'name':'ESME_RCANCELFAIL', 'description':'Cancel SM Failed'},
+ '00000013':{'hex':'00000013', 'name':'ESME_RREPLACEFAIL', 'description':'Replace SM Failed'},
+ '00000014':{'hex':'00000014', 'name':'ESME_RMSGQFUL', 'description':'Message queue full'},
+ '00000015':{'hex':'00000015', 'name':'ESME_RINVSERTYP', 'description':'Invalid service type'},
+ '00000033':{'hex':'00000033', 'name':'ESME_RINVNUMDESTS', 'description':'Invalid number of destinations'},
+ '00000034':{'hex':'00000034', 'name':'ESME_RINVDLNAME', 'description':'Invalid distribution list name'},
+ '00000040':{'hex':'00000040', 'name':'ESME_RINVDESTFLAG', 'description':'Destination flag is invalid (submit_multi)'},
+ '00000042':{'hex':'00000042', 'name':'ESME_RINVSUBREP', 'description':"Invalid `submit with replace' request (i.e. submit_sm with replace_if_present_flag set)"},
+ '00000043':{'hex':'00000043', 'name':'ESME_RINVESMCLASS', 'description':'Invalid esm_class field data'},
+ '00000044':{'hex':'00000044', 'name':'ESME_RCNTSUBDL', 'description':'Cannot submit to distribution list'},
+ '00000045':{'hex':'00000045', 'name':'ESME_RSUBMITFAIL', 'description':'submit_sm or submit_multi failed'},
+ '00000048':{'hex':'00000048', 'name':'ESME_RINVSRCTON', 'description':'Invalid source address TON'},
+ '00000049':{'hex':'00000049', 'name':'ESME_RINVSRCNPI', 'description':'Invalid source address NPI'},
+ '00000050':{'hex':'00000050', 'name':'ESME_RINVDSTTON', 'description':'Invalid destination address TON'},
+ '00000051':{'hex':'00000051', 'name':'ESME_RINVDSTNPI', 'description':'Invalid destination address NPI'},
+ '00000053':{'hex':'00000053', 'name':'ESME_RINVSYSTYP', 'description':'Invalid system_type field'},
+ '00000054':{'hex':'00000054', 'name':'ESME_RINVREPFLAG', 'description':'Invalid replace_if_present flag'},
+ '00000055':{'hex':'00000055', 'name':'ESME_RINVNUMMSGS', 'description':'Invalid number of messages'},
+ '00000058':{'hex':'00000058', 'name':'ESME_RTHROTTLED', 'description':'Throttling error (ESME has exceeded allowed message limits)'},
+ '00000061':{'hex':'00000061', 'name':'ESME_RINVSCHED', 'description':'Invalid scheduled delivery time'},
+ '00000062':{'hex':'00000062', 'name':'ESME_RINVEXPIRY', 'description':'Invalid message validity period (expiry time)'},
+ '00000063':{'hex':'00000063', 'name':'ESME_RINVDFTMSGID', 'description':'Predefined message invalid or not found'},
+ '00000064':{'hex':'00000064', 'name':'ESME_RX_T_APPN', 'description':'ESME Receiver Temporary App Error Code'},
+ '00000065':{'hex':'00000065', 'name':'ESME_RX_P_APPN', 'description':'ESME Receiver Permanent App Error Code'},
+ '00000066':{'hex':'00000066', 'name':'ESME_RX_R_APPN', 'description':'ESME Receiver Reject Message Error Code'},
+ '00000067':{'hex':'00000067', 'name':'ESME_RQUERYFAIL', 'description':'query_sm request failed'},
+ '000000c0':{'hex':'000000c0', 'name':'ESME_RINVOPTPARSTREAM', 'description':'Error in the optional part of the PDU Body'},
+ '000000c1':{'hex':'000000c1', 'name':'ESME_ROPTPARNOTALLWD', 'description':'Optional paramenter not allowed'},
+ '000000c2':{'hex':'000000c2', 'name':'ESME_RINVPARLEN', 'description':'Invalid parameter length'},
+ '000000c3':{'hex':'000000c3', 'name':'ESME_RMISSINGOPTPARAM', 'description':'Expected optional parameter missing'},
+ '000000c4':{'hex':'000000c4', 'name':'ESME_RINVOPTPARAMVAL', 'description':'Invalid optional parameter value'},
+ '000000fe':{'hex':'000000fe', 'name':'ESME_RDELIVERYFAILURE', 'description':'Delivery Failure (used for data_sm_resp)'},
+ '000000ff':{'hex':'000000ff', 'name':'ESME_RUNKNOWNERR', 'description':'Unknown error'}
+}
+def command_status_name_by_hex(x):
+ return command_status_by_hex.get(x,{}).get('name')
+
+command_status_by_name = {
+ 'ESME_ROK' :{'hex':'00000000', 'name':'ESME_ROK', 'description':'No error'},
+ 'ESME_RINVMSGLEN' :{'hex':'00000001', 'name':'ESME_RINVMSGLEN', 'description':'Message Length is invalid'},
+ 'ESME_RINVCMDLEN' :{'hex':'00000002', 'name':'ESME_RINVCMDLEN', 'description':'Command Length is invalid'},
+ 'ESME_RINVCMDID' :{'hex':'00000003', 'name':'ESME_RINVCMDID', 'description':'Invalid Command ID'},
+ 'ESME_RINVBNDSTS' :{'hex':'00000004', 'name':'ESME_RINVBNDSTS', 'description':'Incorrect BIND Status for given command'},
+ 'ESME_RALYBND' :{'hex':'00000005', 'name':'ESME_RALYBND', 'description':'ESME Already in bound state'},
+ 'ESME_RINVPRTFLG' :{'hex':'00000006', 'name':'ESME_RINVPRTFLG', 'description':'Invalid priority flag'},
+ 'ESME_RINVREGDLVFLG' :{'hex':'00000007', 'name':'ESME_RINVREGDLVFLG', 'description':'Invalid registered delivery flag'},
+ 'ESME_RSYSERR' :{'hex':'00000008', 'name':'ESME_RSYSERR', 'description':'System Error'},
+ 'ESME_RINVSRCADR' :{'hex':'0000000a', 'name':'ESME_RINVSRCADR', 'description':'Invalid source address'},
+ 'ESME_RINVDSTADR' :{'hex':'0000000b', 'name':'ESME_RINVDSTADR', 'description':'Invalid destination address'},
+ 'ESME_RINVMSGID' :{'hex':'0000000c', 'name':'ESME_RINVMSGID', 'description':'Message ID is invalid'},
+ 'ESME_RBINDFAIL' :{'hex':'0000000d', 'name':'ESME_RBINDFAIL', 'description':'Bind failed'},
+ 'ESME_RINVPASWD' :{'hex':'0000000e', 'name':'ESME_RINVPASWD', 'description':'Invalid password'},
+ 'ESME_RINVSYSID' :{'hex':'0000000f', 'name':'ESME_RINVSYSID', 'description':'Invalid System ID'},
+ 'ESME_RCANCELFAIL' :{'hex':'00000011', 'name':'ESME_RCANCELFAIL', 'description':'Cancel SM Failed'},
+ 'ESME_RREPLACEFAIL' :{'hex':'00000013', 'name':'ESME_RREPLACEFAIL', 'description':'Replace SM Failed'},
+ 'ESME_RMSGQFUL' :{'hex':'00000014', 'name':'ESME_RMSGQFUL', 'description':'Message queue full'},
+ 'ESME_RINVSERTYP' :{'hex':'00000015', 'name':'ESME_RINVSERTYP', 'description':'Invalid service type'},
+ 'ESME_RINVNUMDESTS' :{'hex':'00000033', 'name':'ESME_RINVNUMDESTS', 'description':'Invalid number of destinations'},
+ 'ESME_RINVDLNAME' :{'hex':'00000034', 'name':'ESME_RINVDLNAME', 'description':'Invalid distribution list name'},
+ 'ESME_RINVDESTFLAG' :{'hex':'00000040', 'name':'ESME_RINVDESTFLAG', 'description':'Destination flag is invalid (submit_multi)'},
+ 'ESME_RINVSUBREP' :{'hex':'00000042', 'name':'ESME_RINVSUBREP', 'description':"Invalid `submit with replace' request (i.e. submit_sm with replace_if_present_flag set)"},
+ 'ESME_RINVESMCLASS' :{'hex':'00000043', 'name':'ESME_RINVESMCLASS', 'description':'Invalid esm_class field data'},
+ 'ESME_RCNTSUBDL' :{'hex':'00000044', 'name':'ESME_RCNTSUBDL', 'description':'Cannot submit to distribution list'},
+ 'ESME_RSUBMITFAIL' :{'hex':'00000045', 'name':'ESME_RSUBMITFAIL', 'description':'submit_sm or submit_multi failed'},
+ 'ESME_RINVSRCTON' :{'hex':'00000048', 'name':'ESME_RINVSRCTON', 'description':'Invalid source address TON'},
+ 'ESME_RINVSRCNPI' :{'hex':'00000049', 'name':'ESME_RINVSRCNPI', 'description':'Invalid source address NPI'},
+ 'ESME_RINVDSTTON' :{'hex':'00000050', 'name':'ESME_RINVDSTTON', 'description':'Invalid destination address TON'},
+ 'ESME_RINVDSTNPI' :{'hex':'00000051', 'name':'ESME_RINVDSTNPI', 'description':'Invalid destination address NPI'},
+ 'ESME_RINVSYSTYP' :{'hex':'00000053', 'name':'ESME_RINVSYSTYP', 'description':'Invalid system_type field'},
+ 'ESME_RINVREPFLAG' :{'hex':'00000054', 'name':'ESME_RINVREPFLAG', 'description':'Invalid replace_if_present flag'},
+ 'ESME_RINVNUMMSGS' :{'hex':'00000055', 'name':'ESME_RINVNUMMSGS', 'description':'Invalid number of messages'},
+ 'ESME_RTHROTTLED' :{'hex':'00000058', 'name':'ESME_RTHROTTLED', 'description':'Throttling error (ESME has exceeded allowed message limits)'},
+ 'ESME_RINVSCHED' :{'hex':'00000061', 'name':'ESME_RINVSCHED', 'description':'Invalid scheduled delivery time'},
+ 'ESME_RINVEXPIRY' :{'hex':'00000062', 'name':'ESME_RINVEXPIRY', 'description':'Invalid message validity period (expiry time)'},
+ 'ESME_RINVDFTMSGID' :{'hex':'00000063', 'name':'ESME_RINVDFTMSGID', 'description':'Predefined message invalid or not found'},
+ 'ESME_RX_T_APPN' :{'hex':'00000064', 'name':'ESME_RX_T_APPN', 'description':'ESME Receiver Temporary App Error Code'},
+ 'ESME_RX_P_APPN' :{'hex':'00000065', 'name':'ESME_RX_P_APPN', 'description':'ESME Receiver Permanent App Error Code'},
+ 'ESME_RX_R_APPN' :{'hex':'00000066', 'name':'ESME_RX_R_APPN', 'description':'ESME Receiver Reject Message Error Code'},
+ 'ESME_RQUERYFAIL' :{'hex':'00000067', 'name':'ESME_RQUERYFAIL', 'description':'query_sm request failed'},
+ 'ESME_RINVOPTPARSTREAM':{'hex':'000000c0', 'name':'ESME_RINVOPTPARSTREAM', 'description':'Error in the optional part of the PDU Body'},
+ 'ESME_ROPTPARNOTALLWD' :{'hex':'000000c1', 'name':'ESME_ROPTPARNOTALLWD', 'description':'Optional paramenter not allowed'},
+ 'ESME_RINVPARLEN' :{'hex':'000000c2', 'name':'ESME_RINVPARLEN', 'description':'Invalid parameter length'},
+ 'ESME_RMISSINGOPTPARAM':{'hex':'000000c3', 'name':'ESME_RMISSINGOPTPARAM', 'description':'Expected optional parameter missing'},
+ 'ESME_RINVOPTPARAMVAL' :{'hex':'000000c4', 'name':'ESME_RINVOPTPARAMVAL', 'description':'Invalid optional parameter value'},
+ 'ESME_RDELIVERYFAILURE':{'hex':'000000fe', 'name':'ESME_RDELIVERYFAILURE', 'description':'Delivery Failure (used for data_sm_resp)'},
+ 'ESME_RUNKNOWNERR' :{'hex':'000000ff', 'name':'ESME_RUNKNOWNERR', 'description':'Unknown error'}
+}
+def command_status_hex_by_name(n):
+ return command_status_by_name.get(n,{}).get('hex')
+
+
+# Type of Number (TON) - SMPP v3.4, section 5.2.5, table 5-3, page 117
+
+maps['addr_ton_by_name'] = {
+ 'unknown' :'00',
+ 'international' :'01',
+ 'national' :'02',
+ 'network_specific' :'03',
+ 'subscriber_number':'04',
+ 'alphanumeric' :'05',
+ 'abbreviated' :'06'
+}
+
+maps['addr_ton_by_hex'] = {
+ '00':'unknown',
+ '01':'international',
+ '02':'national',
+ '03':'network_specific',
+ '04':'subscriber_number',
+ '05':'alphanumeric',
+ '06':'abbreviated'
+}
+
+
+# Numberic Plan Indicator (NPI) - SMPP v3.4, section 5.2.6, table 5-4, page 118
+
+maps['addr_npi_by_name'] = {
+ 'unknown' :'00',
+ 'ISDN' :'01',
+ 'data' :'03',
+ 'telex' :'04',
+ 'land_mobile':'06',
+ 'national' :'08',
+ 'private' :'09',
+ 'ERMES' :'0a',
+ 'internet' :'0e',
+ 'WAP' :'12'
+}
+
+maps['addr_npi_by_hex'] = {
+ '00':'unknown',
+ '01':'ISDN',
+ '03':'data',
+ '04':'telex',
+ '06':'land_mobile',
+ '08':'national',
+ '09':'private',
+ '0a':'ERMES',
+ '0e':'internet',
+ '12':'WAP'
+}
+
+
+# ESM Class bits - SMPP v3.4, section 5.2.12, page 121
+
+maps['esm_class_bits'] = {
+ 'mode_mask' :'03',
+ 'type_mask' :'3c',
+ 'feature_mask' :'c0',
+
+ 'mode_default' :'00',
+ 'mode_datagram' :'01',
+ 'mode_forward' :'02',
+ 'mode_store_and_forward' :'03',
+
+ 'type_default' :'00',
+ 'type_delivery_receipt' :'04',
+ 'type_delivery_ack' :'08',
+ 'type_0011' :'0a',
+ 'type_user_ack' :'10',
+ 'type_0101' :'14',
+ 'type_conversation_abort' :'18',
+ 'type_0111' :'1a',
+ 'type_intermed_deliv_notif' :'20',
+ 'type_1001' :'24',
+ 'type_1010' :'28',
+ 'type_1011' :'2a',
+ 'type_1100' :'30',
+ 'type_1101' :'34',
+ 'type_1110' :'38',
+ 'type_1111' :'3a',
+
+ 'feature_none' :'00',
+ 'feature_UDHI' :'40',
+ 'feature_reply_path' :'80',
+ 'feature_UDHI_and_reply_path':'c0'
+}
+
+
+# Registered Delivery bits - SMPP v3.4, section 5.2.17, page 124
+
+maps['registered_delivery_bits'] = {
+ 'receipt_mask' :'03',
+ 'ack_mask' :'0c',
+ 'intermed_notif_mask' :'80',
+
+ 'receipt_none' :'00',
+ 'receipt_always' :'01',
+ 'receipt_on_fail' :'02',
+ 'receipt_res' :'03',
+
+ 'ack_none' :'00',
+ 'ack_delivery' :'04',
+ 'ack_user' :'08',
+ 'ack_delivery_and_user':'0c',
+
+ 'intermed_notif_none' :'00',
+ 'intermed_notif' :'10'
+}
+
+
+# submit_multi dest_flag constants - SMPP v3.4, section 5.2.25, page 129
+#maps['dest_flag_by_name'] = {
+ #'SME Address' :1,
+ #'Distribution List Name':2
+#}
+
+
+# Message State codes returned in query_sm_resp PDUs - SMPP v3.4, section 5.2.28, table 5-6, page 130
+maps['message_state_by_name'] = {
+ 'ENROUTE' :1,
+ 'DELIVERED' :2,
+ 'EXPIRED' :3,
+ 'DELETED' :4,
+ 'UNDELIVERABLE':5,
+ 'ACCEPTED' :6,
+ 'UNKNOWN' :7,
+ 'REJECTED' :8
+}
+
+
+# Facility Code bits for SMPP v4
+
+maps['facility_code_bits'] = {
+ 'GF_PVCY' :'00000001',
+ 'GF_SUBADDR':'00000002',
+ 'NF_CC' :'00080000',
+ 'NF_PDC' :'00010000',
+ 'NF_IS136' :'00020000',
+ 'NF_IS95A' :'00040000'
+}
+
+
+# Optional Parameter Tags - SMPP v3.4, section 5.3.2, Table 5-7, page 132-133
+
+optional_parameter_tag_by_hex = {
+ '0005':{'hex':'0005', 'name':'dest_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.1, page 134
+ '0006':{'hex':'0006', 'name':'dest_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.3, page 135
+ '0007':{'hex':'0007', 'name':'dest_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.5, page 136
+ '0008':{'hex':'0008', 'name':'dest_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.7, page 137
+
+ '000d':{'hex':'000d', 'name':'source_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.2, page 134
+ '000e':{'hex':'000e', 'name':'source_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.4, page 135
+ '000f':{'hex':'000f', 'name':'source_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.6, page 136
+ '0010':{'hex':'0010', 'name':'source_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.8, page 137
+
+ '0017':{'hex':'0017', 'name':'qos_time_to_live', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.9, page 138
+ '0019':{'hex':'0019', 'name':'payload_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.10, page 138
+
+ '001d':{'hex':'001d', 'name':'additional_status_info_text', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.11, page 139
+ '001e':{'hex':'001e', 'name':'receipted_message_id', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.12, page 139
+
+ '0030':{'hex':'0030', 'name':'ms_msg_wait_facilities', 'type':'bitmask', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.13, page 140
+
+ '0101':{'hex':'0101', 'name':'PVCY_AuthenticationStr', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 58-62
+
+ '0201':{'hex':'0201', 'name':'privacy_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.14, page 141
+ '0202':{'hex':'0202', 'name':'source_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.15, page 142
+ '0203':{'hex':'0203', 'name':'dest_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.16, page 143
+ '0204':{'hex':'0204', 'name':'user_message_reference', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.17, page 143
+ '0205':{'hex':'0205', 'name':'user_response_code', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.18, page 144
+
+ '020a':{'hex':'020a', 'name':'source_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.20, page 145
+ '020b':{'hex':'020b', 'name':'destination_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.21, page 145
+ '020c':{'hex':'020c', 'name':'sar_msg_ref_num', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.22, page 146
+ '020d':{'hex':'020d', 'name':'language_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.19, page 144
+ '020e':{'hex':'020e', 'name':'sar_total_segments', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.23, page 147
+ '020f':{'hex':'020f', 'name':'sar_segment_seqnum', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.24, page 147
+ '0210':{'hex':'0210', 'name':'sc_interface_version', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.25, page 148
+
+ '0301':{'hex':'0301', 'name':'CC_CBN', 'type':None, 'tech':'V4'}, # v4 page 70
+ '0302':{'hex':'0302', 'name':'callback_num_pres_ind', 'type':'bitmask', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.37, page 156
+ '0303':{'hex':'0303', 'name':'callback_num_atag', 'type':'hex', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.38, page 157
+ '0304':{'hex':'0304', 'name':'number_of_messages', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.39, page 158
+ '0381':{'hex':'0381', 'name':'callback_num', 'type':'hex', 'tech':'CDMA, TDMA, GSM, iDEN'}, # SMPP v3.4, section 5.3.2.36, page 155
+
+ '0420':{'hex':'0420', 'name':'dpf_result', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.28, page 149
+ '0421':{'hex':'0421', 'name':'set_dpf', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.29, page 150
+ '0422':{'hex':'0422', 'name':'ms_availability_status', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.30, page 151
+ '0423':{'hex':'0423', 'name':'network_error_code', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.31, page 152
+ '0424':{'hex':'0424', 'name':'message_payload', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.32, page 153
+ '0425':{'hex':'0425', 'name':'delivery_failure_reason', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.33, page 153
+ '0426':{'hex':'0426', 'name':'more_messages_to_send', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.34, page 154
+ '0427':{'hex':'0427', 'name':'message_state', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.35, page 154
+ '0428':{'hex':'0428', 'name':'congestion_state', 'type':None, 'tech':'Generic'},
+
+ '0501':{'hex':'0501', 'name':'ussd_service_op', 'type':'hex', 'tech':'GSM (USSD)'}, # SMPP v3.4, section 5.3.2.44, page 161
+
+ '0600':{'hex':'0600', 'name':'broadcast_channel_indicator', 'type':None, 'tech':'GSM'},
+ '0601':{'hex':'0601', 'name':'broadcast_content_type', 'type':None, 'tech':'CDMA, TDMA, GSM'},
+ '0602':{'hex':'0602', 'name':'broadcast_content_type_info', 'type':None, 'tech':'CDMA, TDMA'},
+ '0603':{'hex':'0603', 'name':'broadcast_message_class', 'type':None, 'tech':'GSM'},
+ '0604':{'hex':'0604', 'name':'broadcast_rep_num', 'type':None, 'tech':'GSM'},
+ '0605':{'hex':'0605', 'name':'broadcast_frequency_interval', 'type':None, 'tech':'CDMA, TDMA, GSM'},
+ '0606':{'hex':'0606', 'name':'broadcast_area_identifier', 'type':None, 'tech':'CDMA, TDMA, GSM'},
+ '0607':{'hex':'0607', 'name':'broadcast_error_status', 'type':None, 'tech':'CDMA, TDMA, GSM'},
+ '0608':{'hex':'0608', 'name':'broadcast_area_success', 'type':None, 'tech':'GSM'},
+ '0609':{'hex':'0609', 'name':'broadcast_end_time', 'type':None, 'tech':'CDMA, TDMA, GSM'},
+ '060a':{'hex':'060a', 'name':'broadcast_service_group', 'type':None, 'tech':'CDMA, TDMA'},
+ '060b':{'hex':'060b', 'name':'billing_identification', 'type':None, 'tech':'Generic'},
+
+ '060d':{'hex':'060d', 'name':'source_network_id', 'type':None, 'tech':'Generic'},
+ '060e':{'hex':'060e', 'name':'dest_network_id', 'type':None, 'tech':'Generic'},
+ '060f':{'hex':'060f', 'name':'source_node_id', 'type':None, 'tech':'Generic'},
+ '0610':{'hex':'0610', 'name':'dest_node_id', 'type':None, 'tech':'Generic'},
+ '0611':{'hex':'0611', 'name':'dest_addr_np_resolution', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
+ '0612':{'hex':'0612', 'name':'dest_addr_np_information', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
+ '0613':{'hex':'0613', 'name':'dest_addr_np_country', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
+
+ '1101':{'hex':'1101', 'name':'PDC_MessageClass', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 75
+ '1102':{'hex':'1102', 'name':'PDC_PresentationOption', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
+ '1103':{'hex':'1103', 'name':'PDC_AlertMechanism', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
+ '1104':{'hex':'1104', 'name':'PDC_Teleservice', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
+ '1105':{'hex':'1105', 'name':'PDC_MultiPartMessage', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
+ '1106':{'hex':'1106', 'name':'PDC_PredefinedMsg', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 78
+
+ '1201':{'hex':'1201', 'name':'display_time', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.26, page 148
+
+ '1203':{'hex':'1203', 'name':'sms_signal', 'type':'integer', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.40, page 158
+ '1204':{'hex':'1204', 'name':'ms_validity', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.27, page 149
+
+ '1304':{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'type':None, 'tech':'CDMA'}, # v4 page 85
+ '1306':{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'type':None, 'tech':'CDMA'}, # v4 page 86
+
+ '130c':{'hex':'130c', 'name':'alert_on_message_delivery', 'type':None, 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.41, page 159
+
+ '1380':{'hex':'1380', 'name':'its_reply_type', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.42, page 159
+ '1383':{'hex':'1383', 'name':'its_session_info', 'type':'hex', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.43, page 160
+
+ '1402':{'hex':'1402', 'name':'operator_id', 'type':None, 'tech':'vendor extension'},
+ '1403':{'hex':'1403', 'name':'tariff', 'type':None, 'tech':'Mobile Network Code vendor extension'},
+ '1450':{'hex':'1450', 'name':'mcc', 'type':None, 'tech':'Mobile Country Code vendor extension'},
+ '1451':{'hex':'1451', 'name':'mnc', 'type':None, 'tech':'Mobile Network Code vendor extension'}
+}
+def optional_parameter_tag_name_by_hex(x):
+ return optional_parameter_tag_by_hex.get(x,{}).get('name')
+
+def optional_parameter_tag_type_by_hex(x):
+ return optional_parameter_tag_by_hex.get(x,{}).get('type')
+
+
+optional_parameter_tag_by_name = {
+ 'dest_addr_subunit' :{'hex':'0005', 'name':'dest_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.1, page 134
+ 'dest_network_type' :{'hex':'0006', 'name':'dest_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.3, page 135
+ 'dest_bearer_type' :{'hex':'0007', 'name':'dest_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.5, page 136
+ 'dest_telematics_id' :{'hex':'0008', 'name':'dest_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.7, page 137
+
+ 'source_addr_subunit' :{'hex':'000d', 'name':'source_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.2, page 134
+ 'source_network_type' :{'hex':'000e', 'name':'source_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.4, page 135
+ 'source_bearer_type' :{'hex':'000f', 'name':'source_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.6, page 136
+ 'source_telematics_id' :{'hex':'0010', 'name':'source_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.8, page 137
+
+ 'qos_time_to_live' :{'hex':'0017', 'name':'qos_time_to_live', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.9, page 138
+ 'payload_type' :{'hex':'0019', 'name':'payload_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.10, page 138
+
+ 'additional_status_info_text' :{'hex':'001d', 'name':'additional_status_info_text', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.11, page 139
+ 'receipted_message_id' :{'hex':'001e', 'name':'receipted_message_id', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.12, page 139
+
+ 'ms_msg_wait_facilities' :{'hex':'0030', 'name':'ms_msg_wait_facilities', 'type':'bitmask', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.13, page 140
+
+ 'PVCY_AuthenticationStr' :{'hex':'0101', 'name':'PVCY_AuthenticationStr', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 58-62
+
+ 'privacy_indicator' :{'hex':'0201', 'name':'privacy_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.14, page 141
+ 'source_subaddress' :{'hex':'0202', 'name':'source_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.15, page 142
+ 'dest_subaddress' :{'hex':'0203', 'name':'dest_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.16, page 143
+ 'user_message_reference' :{'hex':'0204', 'name':'user_message_reference', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.17, page 143
+ 'user_response_code' :{'hex':'0205', 'name':'user_response_code', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.18, page 144
+
+ 'source_port' :{'hex':'020a', 'name':'source_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.20, page 145
+ 'destination_port' :{'hex':'020b', 'name':'destination_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.21, page 145
+ 'sar_msg_ref_num' :{'hex':'020c', 'name':'sar_msg_ref_num', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.22, page 146
+ 'language_indicator' :{'hex':'020d', 'name':'language_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.19, page 144
+ 'sar_total_segments' :{'hex':'020e', 'name':'sar_total_segments', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.23, page 147
+ 'sar_segment_seqnum' :{'hex':'020f', 'name':'sar_segment_seqnum', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.24, page 147
+ 'sc_interface_version' :{'hex':'0210', 'name':'sc_interface_version', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.25, page 148
+
+ 'CC_CBN' :{'hex':'0301', 'name':'CC_CBN', 'type':None, 'tech':'V4'}, # v4 page 70
+ 'callback_num_pres_ind' :{'hex':'0302', 'name':'callback_num_pres_ind', 'type':'bitmask', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.37, page 156
+ 'callback_num_atag' :{'hex':'0303', 'name':'callback_num_atag', 'type':'hex', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.38, page 157
+ 'number_of_messages' :{'hex':'0304', 'name':'number_of_messages', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.39, page 158
+ 'callback_num' :{'hex':'0381', 'name':'callback_num', 'type':'hex', 'tech':'CDMA, TDMA, GSM, iDEN'}, # SMPP v3.4, section 5.3.2.36, page 155
+
+ 'dpf_result' :{'hex':'0420', 'name':'dpf_result', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.28, page 149
+ 'set_dpf' :{'hex':'0421', 'name':'set_dpf', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.29, page 150
+ 'ms_availability_status' :{'hex':'0422', 'name':'ms_availability_status', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.30, page 151
+ 'network_error_code' :{'hex':'0423', 'name':'network_error_code', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.31, page 152
+ 'message_payload' :{'hex':'0424', 'name':'message_payload', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.32, page 153
+ 'delivery_failure_reason' :{'hex':'0425', 'name':'delivery_failure_reason', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.33, page 153
+ 'more_messages_to_send' :{'hex':'0426', 'name':'more_messages_to_send', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.34, page 154
+ 'message_state' :{'hex':'0427', 'name':'message_state', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.35, page 154
+ 'congestion_state' :{'hex':'0428', 'name':'congestion_state', 'type':None, 'tech':'Generic'},
+
+ 'ussd_service_op' :{'hex':'0501', 'name':'ussd_service_op', 'type':'hex', 'tech':'GSM (USSD)'}, # SMPP v3.4, section 5.3.2.44, page 161
+
+ 'broadcast_channel_indicator' :{'hex':'0600', 'name':'broadcast_channel_indicator', 'type':None, 'tech':'GSM'},
+ 'broadcast_content_type' :{'hex':'0601', 'name':'broadcast_content_type', 'type':None, 'tech':'CDMA, TDMA, GSM'},
+ 'broadcast_content_type_info' :{'hex':'0602', 'name':'broadcast_content_type_info', 'type':None, 'tech':'CDMA, TDMA'},
+ 'broadcast_message_class' :{'hex':'0603', 'name':'broadcast_message_class', 'type':None, 'tech':'GSM'},
+ 'broadcast_rep_num' :{'hex':'0604', 'name':'broadcast_rep_num', 'type':None, 'tech':'GSM'},
+ 'broadcast_frequency_interval':{'hex':'0605', 'name':'broadcast_frequency_interval', 'type':None, 'tech':'CDMA, TDMA, GSM'},
+ 'broadcast_area_identifier' :{'hex':'0606', 'name':'broadcast_area_identifier', 'type':None, 'tech':'CDMA, TDMA, GSM'},
+ 'broadcast_error_status' :{'hex':'0607', 'name':'broadcast_error_status', 'type':None, 'tech':'CDMA, TDMA, GSM'},
+ 'broadcast_area_success' :{'hex':'0608', 'name':'broadcast_area_success', 'type':None, 'tech':'GSM'},
+ 'broadcast_end_time' :{'hex':'0609', 'name':'broadcast_end_time', 'type':None, 'tech':'CDMA, TDMA, GSM'},
+ 'broadcast_service_group' :{'hex':'060a', 'name':'broadcast_service_group', 'type':None, 'tech':'CDMA, TDMA'},
+ 'billing_identification' :{'hex':'060b', 'name':'billing_identification', 'type':None, 'tech':'Generic'},
+
+ 'source_network_id' :{'hex':'060d', 'name':'source_network_id', 'type':None, 'tech':'Generic'},
+ 'dest_network_id' :{'hex':'060e', 'name':'dest_network_id', 'type':None, 'tech':'Generic'},
+ 'source_node_id' :{'hex':'060f', 'name':'source_node_id', 'type':None, 'tech':'Generic'},
+ 'dest_node_id' :{'hex':'0610', 'name':'dest_node_id', 'type':None, 'tech':'Generic'},
+ 'dest_addr_np_resolution' :{'hex':'0611', 'name':'dest_addr_np_resolution', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
+ 'dest_addr_np_information' :{'hex':'0612', 'name':'dest_addr_np_information', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
+ 'dest_addr_np_country' :{'hex':'0613', 'name':'dest_addr_np_country', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
+
+ 'PDC_MessageClass' :{'hex':'1101', 'name':'PDC_MessageClass', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 75
+ 'PDC_PresentationOption' :{'hex':'1102', 'name':'PDC_PresentationOption', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
+ 'PDC_AlertMechanism' :{'hex':'1103', 'name':'PDC_AlertMechanism', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
+ 'PDC_Teleservice' :{'hex':'1104', 'name':'PDC_Teleservice', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
+ 'PDC_MultiPartMessage' :{'hex':'1105', 'name':'PDC_MultiPartMessage', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
+ 'PDC_PredefinedMsg' :{'hex':'1106', 'name':'PDC_PredefinedMsg', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 78
+
+ 'display_time' :{'hex':'1201', 'name':'display_time', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.26, page 148
+
+ 'sms_signal' :{'hex':'1203', 'name':'sms_signal', 'type':'integer', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.40, page 158
+ 'ms_validity' :{'hex':'1204', 'name':'ms_validity', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.27, page 149
+
+ 'IS95A_AlertOnDelivery' :{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'type':None, 'tech':'CDMA'}, # v4 page 85
+ 'IS95A_LanguageIndicator' :{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'type':None, 'tech':'CDMA'}, # v4 page 86
+
+ 'alert_on_message_delivery' :{'hex':'130c', 'name':'alert_on_message_delivery', 'type':None, 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.41, page 159
+
+ 'its_reply_type' :{'hex':'1380', 'name':'its_reply_type', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.42, page 159
+ 'its_session_info' :{'hex':'1383', 'name':'its_session_info', 'type':'hex', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.43, page 160
+
+ 'operator_id' :{'hex':'1402', 'name':'operator_id', 'type':None, 'tech':'vendor extension'},
+ 'tariff' :{'hex':'1403', 'name':'tariff', 'type':None, 'tech':'Mobile Network Code vendor extension'},
+ 'mcc' :{'hex':'1450', 'name':'mcc', 'type':None, 'tech':'Mobile Country Code vendor extension'},
+ 'mnc' :{'hex':'1451', 'name':'mnc', 'type':None, 'tech':'Mobile Network Code vendor extension'}
+}
+def optional_parameter_tag_hex_by_name(n):
+ return optional_parameter_tag_by_name.get(n,{}).get('hex')
+
+
+#### Decoding functions #######################################################
+
+def unpack_pdu(pdu_bin):
+ return decode_pdu(binascii.b2a_hex(pdu_bin))
+
+
+def decode_pdu(pdu_hex):
+ hex_ref = [pdu_hex]
+ pdu = {}
+ pdu['header'] = decode_header(hex_ref)
+ command = pdu['header'].get('command_id', None)
+ if command != None:
+ body = decode_body(command, hex_ref)
+ if len(body) > 0:
+ pdu['body'] = body
+ return pdu
+
+
+def decode_header(hex_ref):
+ pdu_hex = hex_ref[0]
+ header = {}
+ (command_length, command_id, command_status, sequence_number, hex_ref[0]) = \
+ (pdu_hex[0:8], pdu_hex[8:16], pdu_hex[16:24], pdu_hex[24:32], pdu_hex[32: ])
+ length = int(command_length, 16)
+ command = command_id_name_by_hex(command_id)
+ status = command_status_name_by_hex(command_status)
+ sequence = int(sequence_number, 16)
+ header = {}
+ header['command_length'] = length
+ header['command_id'] = command
+ header['command_status'] = status
+ header['sequence_number'] = sequence
+ return header
+
+
+def decode_body(command, hex_ref):
+ body = {}
+ if command != None:
+ fields = mandatory_parameter_list_by_command_name(command)
+ mandatory = decode_mandatory_parameters(fields, hex_ref)
+ if len(mandatory) > 0:
+ body['mandatory_parameters'] = mandatory
+ optional = decode_optional_parameters(hex_ref)
+ if len(optional) > 0:
+ body['optional_parameters'] = optional
+ return body
+
+
+def decode_mandatory_parameters(fields, hex_ref):
+ mandatory_parameters = {}
+ if len(hex_ref[0]) > 1:
+ for field in fields:
+ #old = len(hex_ref[0])
+ data = ''
+ octet = ''
+ count = 0
+ if field['var'] == True or field['var'] == False:
+ while (len(hex_ref[0]) > 1
+ and (count < field['min']
+ or (count < field['max']
+ and octet != '00'))):
+ octet = octpop(hex_ref)
+ data += octet
+ count += 1
+ elif field['type'] == 'string':
+ count = mandatory_parameters[field['var']]
+ for i in range(count):
+ if len(hex_ref[0]) > 1:
+ data += octpop(hex_ref)
+ else:
+ count = mandatory_parameters[field['var']]
+ if field['map'] != None:
+ mandatory_parameters[field['name']] = maps[field['map']+'_by_hex'].get(data, None)
+ if field['map'] == None or mandatory_parameters[field['name']] == None:
+ mandatory_parameters[field['name']] = decode_hex_type(data, field['type'], count, hex_ref)
+ #print field['type'], (old - len(hex_ref[0]))/2, repr(data), field['name'], mandatory_parameters[field['name']]
+ return mandatory_parameters
+
+
+def decode_optional_parameters(hex_ref):
+ optional_parameters = []
+ hex = hex_ref[0]
+ while len(hex) > 0:
+ (tag_hex, length_hex, rest) = (hex[0:4], hex[4:8], hex[8: ])
+ tag = optional_parameter_tag_name_by_hex(tag_hex)
+ if tag == None:
+ tag = tag_hex
+ length = int(length_hex, 16)
+ (value_hex, tail) = (rest[0:length*2], rest[length*2: ])
+ if len(value_hex) == 0:
+ value = None
+ else:
+ value = decode_hex_type(value_hex, optional_parameter_tag_type_by_hex(tag_hex))
+ hex = tail
+ optional_parameters.append({'tag':tag, 'length':length, 'value':value})
+ return optional_parameters
+
+
+def decode_hex_type(hex, type, count=0, hex_ref=['']):
+ if type == 'integer':
+ return int(hex, 16)
+ elif type == 'string':
+ return re.sub('00','',hex).decode('hex')
+ elif (type == 'dest_address'
+ or type == 'unsuccess_sme'):
+ list = []
+ fields = mandatory_parameter_list_by_command_name(type)
+ for i in range(count):
+ item = decode_mandatory_parameters(fields, hex_ref)
+ if item.get('dest_flag', None) == 1: # 'dest_address' only
+ subfields = mandatory_parameter_list_by_command_name('sme_dest_address')
+ rest = decode_mandatory_parameters(subfields, hex_ref)
+ item.update(rest)
+ elif item.get('dest_flag', None) == 2: # 'dest_address' only
+ subfields = mandatory_parameter_list_by_command_name('distribution_list')
+ rest = decode_mandatory_parameters(subfields, hex_ref)
+ item.update(rest)
+ list.append(item)
+ return list
+ else:
+ return hex
+
+
+def octpop(hex_ref):
+ octet = None
+ if len(hex_ref[0]) > 1:
+ (octet, hex_ref[0]) = (hex_ref[0][0:2], hex_ref[0][2: ])
+ return octet
+
+
+#### Encoding functions #######################################################
+
+def pack_pdu(pdu_obj):
+ return binascii.a2b_hex(encode_pdu(pdu_obj))
+
+
+def encode_pdu(pdu_obj):
+ header = pdu_obj.get('header', {})
+ body = pdu_obj.get('body', {})
+ mandatory = body.get('mandatory_parameters', {})
+ optional = body.get('optional_parameters', [])
+ body_hex = ''
+ fields = mandatory_parameter_list_by_command_name(header['command_id'])
+ body_hex += encode_mandatory_parameters(mandatory, fields)
+ for opt in optional:
+ body_hex += encode_optional_parameter(opt['tag'], opt['value'])
+ actual_length = 16 + len(body_hex)/2
+ command_length = '%08x' % actual_length
+ command_id = command_id_hex_by_name(header['command_id'])
+ command_status = command_status_hex_by_name(header['command_status'])
+ sequence_number = '%08x' % header['sequence_number']
+ pdu_hex = command_length + command_id + command_status + sequence_number + body_hex
+ return pdu_hex
+
+
+def encode_mandatory_parameters(mandatory_obj, fields):
+ mandatory_hex_array = []
+ index_names = {}
+ index = 0
+ for field in fields:
+ param = mandatory_obj.get(field['name'], None)
+ param_length = None
+ if param != None or field['min'] > 0:
+ map = None
+ if field['map'] != None:
+ map = maps.get(field['map']+'_by_name', None)
+ if isinstance(param, list):
+ hex_list = []
+ for item in param:
+ flagfields = mandatory_parameter_list_by_command_name(field['type'])
+ plusfields = []
+ if item.get('dest_flag', None) == 1:
+ plusfields = mandatory_parameter_list_by_command_name('sme_dest_address')
+ elif item.get('dest_flag', None) == 2:
+ plusfields = mandatory_parameter_list_by_command_name('distribution_list')
+ hex_item = encode_mandatory_parameters(item, flagfields + plusfields)
+ if isinstance(hex_item, str) and len(hex_item) > 0:
+ hex_list.append(hex_item)
+ param_length = len(hex_list)
+ mandatory_hex_array.append(''.join(hex_list))
+ else:
+ hex_param = encode_param_type(
+ param, field['type'], field['min'], field['max'], map)
+ param_length = len(hex_param)/2
+ mandatory_hex_array.append(hex_param)
+ index_names[field['name']] = index
+ length_index = index_names.get(field['var'], None)
+ if length_index != None and param_length != None:
+ mandatory_hex_array[length_index] = encode_param_type(
+ param_length,
+ 'integer',
+ len(mandatory_hex_array[length_index])/2)
+ index += 1
+ return ''.join(mandatory_hex_array)
+
+
+def encode_optional_parameter(tag, value):
+ optional_hex_array = []
+ tag_hex = optional_parameter_tag_hex_by_name(tag)
+ if tag_hex != None:
+ value_hex = encode_param_type(
+ value,
+ optional_parameter_tag_type_by_hex(tag_hex))
+ length_hex = '%04x' % (len(value_hex)/2)
+ optional_hex_array.append(tag_hex + length_hex + value_hex)
+ return ''.join(optional_hex_array)
+
+
+def encode_param_type(param, type, min=0, max=None, map=None):
+ if param == None:
+ hex = None
+ elif map != None:
+ if type == 'integer' and isinstance(param, int):
+ hex = ('%0'+str(min*2)+'x') % param
+ else:
+ hex = map.get(param, ('%0'+str(min*2)+'x') % 0)
+ elif type == 'integer':
+ hex = ('%0'+str(min*2)+'x') % int(param)
+ elif type == 'string':
+ hex = param.encode('hex') + '00'
+ elif type == 'bitmask':
+ hex = param
+ elif type == 'hex':
+ hex = param
+ else:
+ hex = None
+ #if hex == None:
+ #hex = ''
+ #if min > 0:
+ #hex = ('%0'+str(min*2)+'x') % 0
+ #print type, min, max, repr(param), hex, map
+ return hex
+
+
diff --git a/test/__init__.py b/test/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/test/pdu.py b/test/pdu.py
new file mode 100644
index 0000000..e34992e
--- /dev/null
+++ b/test/pdu.py
@@ -0,0 +1,515 @@
+
+
+pdu_objects = [
+ {
+ 'header': {
+ 'command_length': 0,
+ 'command_id': 'bind_transmitter',
+ 'command_status': 'ESME_ROK',
+ 'sequence_number': 0,
+ },
+ 'body': {
+ 'mandatory_parameters': {
+ 'system_id':'test_system',
+ 'password':'abc123',
+ 'system_type':'',
+ 'interface_version':'',
+ 'addr_ton':1,
+ 'addr_npi':1,
+ 'address_range':'',
+ },
+ },
+ },
+ {
+ 'header': {
+ 'command_length': 0,
+ 'command_id': 'bind_transmitter_resp',
+ 'command_status': 'ESME_ROK',
+ 'sequence_number': 0,
+ },
+ 'body': {
+ 'mandatory_parameters': {
+ 'system_id':'test_system',
+ },
+ },
+ },
+ {
+ 'header': {
+ 'command_length': 0,
+ 'command_id': 'bind_receiver',
+ 'command_status': 'ESME_ROK',
+ 'sequence_number': 0,
+ },
+ 'body': {
+ 'mandatory_parameters': {
+ 'system_id':'test_system',
+ 'password':'abc123',
+ 'system_type':'',
+ 'interface_version':'',
+ 'addr_ton':1,
+ 'addr_npi':1,
+ 'address_range':'',
+ },
+ },
+ },
+ {
+ 'header': {
+ 'command_length': 0,
+ 'command_id': 'bind_receiver_resp',
+ 'command_status': 'ESME_ROK',
+ 'sequence_number': 0,
+ },
+ 'body': {
+ 'mandatory_parameters': {
+ 'system_id':'test_system',
+ },
+ },
+ },
+ {
+ 'header': {
+ 'command_length': 0,
+ 'command_id': 'bind_transceiver',
+ 'command_status': 'ESME_ROK',
+ 'sequence_number': 0,
+ },
+ 'body': {
+ 'mandatory_parameters': {
+ 'system_id':'test_system',
+ 'password':'abc123',
+ 'system_type':'',
+ 'interface_version':'',
+ 'addr_ton':1,
+ 'addr_npi':1,
+ 'address_range':'',
+ },
+ },
+ },
+ {
+ 'header': {
+ 'command_length': 0,
+ 'command_id': 'bind_transceiver_resp',
+ 'command_status': 'ESME_ROK',
+ 'sequence_number': 0,
+ },
+ 'body': {
+ 'mandatory_parameters': {
+ 'system_id':'test_system',
+ },
+ },
+ },
+ {
+ 'header': {
+ 'command_length': 0,
+ 'command_id': 'outbind',
+ 'command_status': 'ESME_ROK',
+ 'sequence_number': 0,
+ },
+ 'body': {
+ 'mandatory_parameters': {
+ 'system_id':'test_system',
+ 'password':'abc123',
+ },
+ },
+ },
+ {
+ 'header': {
+ 'command_length': 0,
+ 'command_id': 'unbind',
+ 'command_status': 'ESME_ROK',
+ 'sequence_number': 0,
+ },
+ },
+ {
+ 'header': {
+ 'command_length': 0,
+ 'command_id': 'unbind_resp',
+ 'command_status': 'ESME_ROK',
+ 'sequence_number': 0,
+ },
+ },
+ {
+ 'header': {
+ 'command_length': 0,
+ 'command_id': 'generic_nack',
+ 'command_status': 'ESME_ROK',
+ 'sequence_number': 0,
+ },
+ },
+ {
+ 'header': {
+ 'command_length': 0,
+ 'command_id': 'submit_sm',
+ 'command_status': 'ESME_ROK',
+ 'sequence_number': 0,
+ },
+ 'body': {
+ 'mandatory_parameters': {
+ 'service_type':'',
+ 'source_addr_ton':1,
+ 'source_addr_npi':1,
+ 'source_addr':'',
+ 'dest_addr_ton':1,
+ 'dest_addr_npi':1,
+ 'destination_addr':'',
+ 'esm_class':0,
+ 'protocol_id':0,
+ 'priority_flag':0,
+ 'schedule_delivery_time':'',
+ 'validity_period':'',
+ 'registered_delivery':0,
+ 'replace_if_present_flag':0,
+ 'data_coding':0,
+ 'sm_default_msg_id':0,
+ 'sm_length':1,
+ 'short_message':'testing 123',
+ },
+ },
+ },
+ {
+ 'header': {
+ 'command_length': 0,
+ 'command_id': 'submit_sm',
+ 'command_status': 'ESME_ROK',
+ 'sequence_number': 0,
+ },
+ 'body': {
+ 'mandatory_parameters': {
+ 'service_type':'',
+ 'source_addr_ton':1,
+ 'source_addr_npi':1,
+ 'source_addr':'',
+ 'dest_addr_ton':1,
+ 'dest_addr_npi':1,
+ 'destination_addr':'',
+ 'esm_class':0,
+ 'protocol_id':0,
+ 'priority_flag':0,
+ 'schedule_delivery_time':'',
+ 'validity_period':'',
+ 'registered_delivery':0,
+ 'replace_if_present_flag':0,
+ 'data_coding':0,
+ 'sm_default_msg_id':0,
+ 'sm_length':0,
+ # 'short_message' can be of zero length
+ },
+ 'optional_parameters': [
+ {
+ 'tag':'message_payload',
+ 'length':0,
+ 'value':'5666',
+ },
+ ],
+ },
+ },
+#]
+#breaker = [
+ {
+ 'header': {
+ 'command_length': 0,
+ 'command_id': 'submit_sm_resp',
+ 'command_status': 'ESME_ROK',
+ 'sequence_number': 0,
+ },
+ 'body': {
+ 'mandatory_parameters': {
+ 'message_id':'',
+ },
+ },
+ },
+ {
+ 'header': {
+ 'command_length': 0,
+ 'command_id': 'submit_sm_resp',
+ 'command_status': 'ESME_RSYSERR',
+ 'sequence_number': 0,
+ },
+ # submit_sm_resp can have no body for failures
+ },
+ {
+ 'header': {
+ 'command_length': 0,
+ 'command_id': 'submit_multi',
+ 'command_status': 'ESME_ROK',
+ 'sequence_number': 0,
+ },
+ 'body': {
+ 'mandatory_parameters': {
+ 'service_type':'',
+ 'source_addr_ton':1,
+ 'source_addr_npi':1,
+ 'source_addr':'',
+ 'number_of_dests':0,
+ 'dest_address':[
+ {
+ 'dest_flag':1,
+ 'dest_addr_ton':1,
+ 'dest_addr_npi':1,
+ 'destination_addr':'the address'
+ },
+ {
+ 'dest_flag':2,
+ 'dl_name':'the list',
+ },
+ {
+ 'dest_flag':2,
+ 'dl_name':'the other list',
+ },
+ #{}
+ ],
+ 'esm_class':0,
+ 'protocol_id':0,
+ 'priority_flag':0,
+ 'schedule_delivery_time':'',
+ 'validity_period':'',
+ 'registered_delivery':0,
+ 'replace_if_present_flag':0,
+ 'data_coding':0,
+ 'sm_default_msg_id':0,
+ 'sm_length':1,
+ 'short_message':'testing 123',
+ },
+ },
+ },
+ {
+ 'header': {
+ 'command_length': 0,
+ 'command_id': 'submit_multi_resp',
+ 'command_status': 'ESME_ROK',
+ 'sequence_number': 0,
+ },
+ 'body': {
+ 'mandatory_parameters': {
+ 'message_id':'',
+ 'no_unsuccess':5,
+ 'unsuccess_sme':[
+ {
+ 'dest_addr_ton':1,
+ 'dest_addr_npi':1,
+ 'destination_addr':'',
+ 'error_status_code':0,
+ },
+ {
+ 'dest_addr_ton':3,
+ 'dest_addr_npi':1,
+ 'destination_addr':'555',
+ 'error_status_code':0,
+ },
+ ],
+ },
+ },
+ },
+#]
+#breaker = [
+ {
+ 'header': {
+ 'command_length': 0,
+ 'command_id': 'deliver_sm',
+ 'command_status': 'ESME_ROK',
+ 'sequence_number': 0,
+ },
+ 'body': {
+ 'mandatory_parameters': {
+ 'service_type':'',
+ 'source_addr_ton':1,
+ 'source_addr_npi':1,
+ 'source_addr':'',
+ 'dest_addr_ton':1,
+ 'dest_addr_npi':1,
+ 'destination_addr':'',
+ 'esm_class':0,
+ 'protocol_id':0,
+ 'priority_flag':0,
+ 'schedule_delivery_time':'',
+ 'validity_period':'',
+ 'registered_delivery':0,
+ 'replace_if_present_flag':0,
+ 'data_coding':0,
+ 'sm_default_msg_id':0,
+ 'sm_length':1,
+ 'short_message':'',
+ },
+ },
+ },
+ {
+ 'header': {
+ 'command_length': 0,
+ 'command_id': 'deliver_sm_resp',
+ 'command_status': 'ESME_ROK',
+ 'sequence_number': 0,
+ },
+ 'body': {
+ 'mandatory_parameters': {
+ 'message_id':'',
+ },
+ },
+ },
+ {
+ 'header': {
+ 'command_length': 0,
+ 'command_id': 'data_sm',
+ 'command_status': 'ESME_ROK',
+ 'sequence_number': 0,
+ },
+ 'body': {
+ 'mandatory_parameters': {
+ 'service_type':'',
+ 'source_addr_ton':1,
+ 'source_addr_npi':1,
+ 'source_addr':'',
+ 'dest_addr_ton':1,
+ 'dest_addr_npi':1,
+ 'destination_addr':'',
+ 'esm_class':0,
+ 'registered_delivery':0,
+ 'data_coding':0,
+ },
+ 'optional_parameters': [
+ {
+ 'tag':'message_payload',
+ 'length':0,
+ 'value':'',
+ },
+ ],
+ },
+ },
+ {
+ 'header': {
+ 'command_length': 0,
+ 'command_id': 'data_sm_resp',
+ 'command_status': 'ESME_ROK',
+ 'sequence_number': 0,
+ },
+ 'body': {
+ 'mandatory_parameters': {
+ 'message_id':'',
+ },
+ },
+ },
+ {
+ 'header': {
+ 'command_length': 0,
+ 'command_id': 'query_sm',
+ 'command_status': 'ESME_ROK',
+ 'sequence_number': 0,
+ },
+ 'body': {
+ 'mandatory_parameters': {
+ 'message_id':'',
+ 'source_addr_ton':1,
+ 'source_addr_npi':1,
+ 'source_addr':'',
+ },
+ },
+ },
+ {
+ 'header': {
+ 'command_length': 0,
+ 'command_id': 'query_sm_resp',
+ 'command_status': 'ESME_ROK',
+ 'sequence_number': 0,
+ },
+ 'body': {
+ 'mandatory_parameters': {
+ 'message_id':'',
+ 'final_date':'',
+ 'message_state':0,
+ 'error_code':0,
+ },
+ },
+ },
+ {
+ 'header': {
+ 'command_length': 0,
+ 'command_id': 'cancel_sm',
+ 'command_status': 'ESME_ROK',
+ 'sequence_number': 0,
+ },
+ 'body': {
+ 'mandatory_parameters': {
+ 'service_type':'',
+ 'message_id':'',
+ 'source_addr_ton':1,
+ 'source_addr_npi':1,
+ 'source_addr':'',
+ 'dest_addr_ton':1,
+ 'dest_addr_npi':1,
+ 'destination_addr':'',
+ },
+ },
+ },
+ {
+ 'header': {
+ 'command_length': 0,
+ 'command_id': 'cancel_sm_resp',
+ 'command_status': 'ESME_ROK',
+ 'sequence_number': 0,
+ },
+ },
+ {
+ 'header': {
+ 'command_length': 0,
+ 'command_id': 'replace_sm',
+ 'command_status': 'ESME_ROK',
+ 'sequence_number': 0,
+ },
+ 'body': {
+ 'mandatory_parameters': {
+ 'message_id':'',
+ 'source_addr_ton':1,
+ 'source_addr_npi':1,
+ 'source_addr':'',
+ 'schedule_delivery_time':'',
+ 'validity_period':'',
+ 'registered_delivery':0,
+ 'replace_if_present_flag':0,
+ 'data_coding':0,
+ 'sm_default_msg_id':0,
+ 'sm_length':1,
+ 'short_message':'is this an = sign?',
+ },
+ },
+ },
+ {
+ 'header': {
+ 'command_length': 0,
+ 'command_id': 'replace_sm_resp',
+ 'command_status': 'ESME_ROK',
+ 'sequence_number': 0,
+ },
+ },
+ {
+ 'header': {
+ 'command_length': 0,
+ 'command_id': 'enquire_link',
+ 'command_status': 'ESME_ROK',
+ 'sequence_number': 0,
+ },
+ },
+ {
+ 'header': {
+ 'command_length': 0,
+ 'command_id': 'enquire_link_resp',
+ 'command_status': 'ESME_ROK',
+ 'sequence_number': 0,
+ },
+ },
+ {
+ 'header': {
+ 'command_length': 0,
+ 'command_id': 'alert_notification',
+ 'command_status': 'ESME_ROK',
+ 'sequence_number': 0,
+ },
+ 'body': {
+ 'mandatory_parameters': {
+ 'source_addr_ton':'international',
+ 'source_addr_npi':1,
+ 'source_addr':'',
+ 'esme_addr_ton':9,
+ 'esme_addr_npi':'',
+ 'esme_addr':'',
+ },
+ },
+ },
+]
diff --git a/test/pdu_asserts.py b/test/pdu_asserts.py
new file mode 100644
index 0000000..37a6c80
--- /dev/null
+++ b/test/pdu_asserts.py
@@ -0,0 +1,563 @@
+
+########################################
+pdu_json_0000000001 = '''{
+ "body": {
+ "mandatory_parameters": {
+ "addr_npi": "ISDN",
+ "addr_ton": "international",
+ "address_range": "",
+ "interface_version": "",
+ "password": "abc123",
+ "system_id": "test_system",
+ "system_type": ""
+ }
+ },
+ "header": {
+ "command_id": "bind_transmitter",
+ "command_length": 40,
+ "command_status": "ESME_ROK",
+ "sequence_number": 0
+ }
+}'''
+
+########################################
+pdu_json_0000000002 = '''{
+ "body": {
+ "mandatory_parameters": {
+ "system_id": "test_system"
+ }
+ },
+ "header": {
+ "command_id": "bind_transmitter_resp",
+ "command_length": 28,
+ "command_status": "ESME_ROK",
+ "sequence_number": 0
+ }
+}'''
+
+########################################
+pdu_json_0000000003 = '''{
+ "body": {
+ "mandatory_parameters": {
+ "addr_npi": "ISDN",
+ "addr_ton": "international",
+ "address_range": "",
+ "interface_version": "",
+ "password": "abc123",
+ "system_id": "test_system",
+ "system_type": ""
+ }
+ },
+ "header": {
+ "command_id": "bind_receiver",
+ "command_length": 40,
+ "command_status": "ESME_ROK",
+ "sequence_number": 0
+ }
+}'''
+
+########################################
+pdu_json_0000000004 = '''{
+ "body": {
+ "mandatory_parameters": {
+ "system_id": "test_system"
+ }
+ },
+ "header": {
+ "command_id": "bind_receiver_resp",
+ "command_length": 28,
+ "command_status": "ESME_ROK",
+ "sequence_number": 0
+ }
+}'''
+
+########################################
+pdu_json_0000000005 = '''{
+ "body": {
+ "mandatory_parameters": {
+ "addr_npi": "ISDN",
+ "addr_ton": "international",
+ "address_range": "",
+ "interface_version": "",
+ "password": "abc123",
+ "system_id": "test_system",
+ "system_type": ""
+ }
+ },
+ "header": {
+ "command_id": "bind_transceiver",
+ "command_length": 40,
+ "command_status": "ESME_ROK",
+ "sequence_number": 0
+ }
+}'''
+
+########################################
+pdu_json_0000000006 = '''{
+ "body": {
+ "mandatory_parameters": {
+ "system_id": "test_system"
+ }
+ },
+ "header": {
+ "command_id": "bind_transceiver_resp",
+ "command_length": 28,
+ "command_status": "ESME_ROK",
+ "sequence_number": 0
+ }
+}'''
+
+########################################
+pdu_json_0000000007 = '''{
+ "body": {
+ "mandatory_parameters": {
+ "password": "abc123",
+ "system_id": "test_system"
+ }
+ },
+ "header": {
+ "command_id": "outbind",
+ "command_length": 35,
+ "command_status": "ESME_ROK",
+ "sequence_number": 0
+ }
+}'''
+
+########################################
+pdu_json_0000000008 = '''{
+ "header": {
+ "command_id": "unbind",
+ "command_length": 16,
+ "command_status": "ESME_ROK",
+ "sequence_number": 0
+ }
+}'''
+
+########################################
+pdu_json_0000000009 = '''{
+ "header": {
+ "command_id": "unbind_resp",
+ "command_length": 16,
+ "command_status": "ESME_ROK",
+ "sequence_number": 0
+ }
+}'''
+
+########################################
+pdu_json_0000000010 = '''{
+ "header": {
+ "command_id": "generic_nack",
+ "command_length": 16,
+ "command_status": "ESME_ROK",
+ "sequence_number": 0
+ }
+}'''
+
+########################################
+pdu_json_0000000011 = '''{
+ "body": {
+ "mandatory_parameters": {
+ "data_coding": 0,
+ "dest_addr_npi": "ISDN",
+ "dest_addr_ton": "international",
+ "destination_addr": "",
+ "esm_class": 0,
+ "priority_flag": 0,
+ "protocol_id": 0,
+ "registered_delivery": 0,
+ "replace_if_present_flag": 0,
+ "schedule_delivery_time": "",
+ "service_type": "",
+ "short_message": "testing 123",
+ "sm_default_msg_id": 0,
+ "sm_length": 12,
+ "source_addr": "",
+ "source_addr_npi": "ISDN",
+ "source_addr_ton": "international",
+ "validity_period": ""
+ }
+ },
+ "header": {
+ "command_id": "submit_sm",
+ "command_length": 45,
+ "command_status": "ESME_ROK",
+ "sequence_number": 0
+ }
+}'''
+
+########################################
+pdu_json_0000000012 = '''{
+ "body": {
+ "mandatory_parameters": {
+ "data_coding": 0,
+ "dest_addr_npi": "ISDN",
+ "dest_addr_ton": "international",
+ "destination_addr": "",
+ "esm_class": 0,
+ "priority_flag": 0,
+ "protocol_id": 0,
+ "registered_delivery": 0,
+ "replace_if_present_flag": 0,
+ "schedule_delivery_time": "",
+ "service_type": "",
+ "short_message": "",
+ "sm_default_msg_id": 0,
+ "sm_length": 0,
+ "source_addr": "",
+ "source_addr_npi": "ISDN",
+ "source_addr_ton": "international",
+ "validity_period": ""
+ },
+ "optional_parameters": [
+ {
+ "length": 2,
+ "tag": "message_payload",
+ "value": "5666"
+ }
+ ]
+ },
+ "header": {
+ "command_id": "submit_sm",
+ "command_length": 39,
+ "command_status": "ESME_ROK",
+ "sequence_number": 0
+ }
+}'''
+
+########################################
+pdu_json_0000000013 = '''{
+ "body": {
+ "mandatory_parameters": {
+ "message_id": ""
+ }
+ },
+ "header": {
+ "command_id": "submit_sm_resp",
+ "command_length": 17,
+ "command_status": "ESME_ROK",
+ "sequence_number": 0
+ }
+}'''
+
+########################################
+pdu_json_0000000014 = '''{
+ "header": {
+ "command_id": "submit_sm_resp",
+ "command_length": 16,
+ "command_status": "ESME_RSYSERR",
+ "sequence_number": 0
+ }
+}'''
+
+########################################
+pdu_json_0000000015 = '''{
+ "body": {
+ "mandatory_parameters": {
+ "data_coding": 0,
+ "dest_address": [
+ {
+ "dest_addr_npi": "ISDN",
+ "dest_addr_ton": "international",
+ "dest_flag": 1,
+ "destination_addr": "the address"
+ },
+ {
+ "dest_flag": 2,
+ "dl_name": "the list"
+ },
+ {
+ "dest_flag": 2,
+ "dl_name": "the other list"
+ }
+ ],
+ "esm_class": 0,
+ "number_of_dests": 3,
+ "priority_flag": 0,
+ "protocol_id": 0,
+ "registered_delivery": 0,
+ "replace_if_present_flag": 0,
+ "schedule_delivery_time": "",
+ "service_type": "",
+ "short_message": "testing 123",
+ "sm_default_msg_id": 0,
+ "sm_length": 12,
+ "source_addr": "",
+ "source_addr_npi": "ISDN",
+ "source_addr_ton": "international",
+ "validity_period": ""
+ }
+ },
+ "header": {
+ "command_id": "submit_multi",
+ "command_length": 84,
+ "command_status": "ESME_ROK",
+ "sequence_number": 0
+ }
+}'''
+
+########################################
+pdu_json_0000000016 = '''{
+ "body": {
+ "mandatory_parameters": {
+ "message_id": "",
+ "no_unsuccess": 2,
+ "unsuccess_sme": [
+ {
+ "dest_addr_npi": "ISDN",
+ "dest_addr_ton": "international",
+ "destination_addr": "",
+ "error_status_code": 0
+ },
+ {
+ "dest_addr_npi": "ISDN",
+ "dest_addr_ton": "network_specific",
+ "destination_addr": "555",
+ "error_status_code": 0
+ }
+ ]
+ }
+ },
+ "header": {
+ "command_id": "submit_multi_resp",
+ "command_length": 35,
+ "command_status": "ESME_ROK",
+ "sequence_number": 0
+ }
+}'''
+
+########################################
+pdu_json_0000000017 = '''{
+ "body": {
+ "mandatory_parameters": {
+ "data_coding": 0,
+ "dest_addr_npi": "ISDN",
+ "dest_addr_ton": "international",
+ "destination_addr": "",
+ "esm_class": 0,
+ "priority_flag": 0,
+ "protocol_id": 0,
+ "registered_delivery": 0,
+ "replace_if_present_flag": 0,
+ "schedule_delivery_time": "",
+ "service_type": "",
+ "short_message": "",
+ "sm_default_msg_id": 0,
+ "sm_length": 1,
+ "source_addr": "",
+ "source_addr_npi": "ISDN",
+ "source_addr_ton": "international",
+ "validity_period": ""
+ }
+ },
+ "header": {
+ "command_id": "deliver_sm",
+ "command_length": 34,
+ "command_status": "ESME_ROK",
+ "sequence_number": 0
+ }
+}'''
+
+########################################
+pdu_json_0000000018 = '''{
+ "body": {
+ "mandatory_parameters": {
+ "message_id": ""
+ }
+ },
+ "header": {
+ "command_id": "deliver_sm_resp",
+ "command_length": 17,
+ "command_status": "ESME_ROK",
+ "sequence_number": 0
+ }
+}'''
+
+########################################
+pdu_json_0000000019 = '''{
+ "body": {
+ "mandatory_parameters": {
+ "data_coding": 0,
+ "dest_addr_npi": "ISDN",
+ "dest_addr_ton": "international",
+ "destination_addr": "",
+ "esm_class": 0,
+ "registered_delivery": 0,
+ "service_type": "",
+ "source_addr": "",
+ "source_addr_npi": "ISDN",
+ "source_addr_ton": "international"
+ },
+ "optional_parameters": [
+ {
+ "length": 0,
+ "tag": "message_payload",
+ "value": null
+ }
+ ]
+ },
+ "header": {
+ "command_id": "data_sm",
+ "command_length": 30,
+ "command_status": "ESME_ROK",
+ "sequence_number": 0
+ }
+}'''
+
+########################################
+pdu_json_0000000020 = '''{
+ "body": {
+ "mandatory_parameters": {
+ "message_id": ""
+ }
+ },
+ "header": {
+ "command_id": "data_sm_resp",
+ "command_length": 17,
+ "command_status": "ESME_ROK",
+ "sequence_number": 0
+ }
+}'''
+
+########################################
+pdu_json_0000000021 = '''{
+ "body": {
+ "mandatory_parameters": {
+ "message_id": "",
+ "source_addr": "",
+ "source_addr_npi": "ISDN",
+ "source_addr_ton": "international"
+ }
+ },
+ "header": {
+ "command_id": "query_sm",
+ "command_length": 20,
+ "command_status": "ESME_ROK",
+ "sequence_number": 0
+ }
+}'''
+
+########################################
+pdu_json_0000000022 = '''{
+ "body": {
+ "mandatory_parameters": {
+ "error_code": 0,
+ "final_date": "",
+ "message_id": "",
+ "message_state": 0
+ }
+ },
+ "header": {
+ "command_id": "query_sm_resp",
+ "command_length": 20,
+ "command_status": "ESME_ROK",
+ "sequence_number": 0
+ }
+}'''
+
+########################################
+pdu_json_0000000023 = '''{
+ "body": {
+ "mandatory_parameters": {
+ "dest_addr_npi": "ISDN",
+ "dest_addr_ton": "international",
+ "destination_addr": "",
+ "message_id": "",
+ "service_type": "",
+ "source_addr": "",
+ "source_addr_npi": "ISDN",
+ "source_addr_ton": "international"
+ }
+ },
+ "header": {
+ "command_id": "cancel_sm",
+ "command_length": 24,
+ "command_status": "ESME_ROK",
+ "sequence_number": 0
+ }
+}'''
+
+########################################
+pdu_json_0000000024 = '''{
+ "header": {
+ "command_id": "cancel_sm_resp",
+ "command_length": 16,
+ "command_status": "ESME_ROK",
+ "sequence_number": 0
+ }
+}'''
+
+########################################
+pdu_json_0000000025 = '''{
+ "body": {
+ "mandatory_parameters": {
+ "data_coding": 0,
+ "message_id": "",
+ "registered_delivery": 0,
+ "replace_if_present_flag": 0,
+ "schedule_delivery_time": "",
+ "short_message": "is this an = sign?",
+ "sm_default_msg_id": 0,
+ "sm_length": 19,
+ "source_addr": "",
+ "source_addr_npi": "ISDN",
+ "source_addr_ton": "international",
+ "validity_period": ""
+ }
+ },
+ "header": {
+ "command_id": "replace_sm",
+ "command_length": 46,
+ "command_status": "ESME_ROK",
+ "sequence_number": 0
+ }
+}'''
+
+########################################
+pdu_json_0000000026 = '''{
+ "header": {
+ "command_id": "replace_sm_resp",
+ "command_length": 16,
+ "command_status": "ESME_ROK",
+ "sequence_number": 0
+ }
+}'''
+
+########################################
+pdu_json_0000000027 = '''{
+ "header": {
+ "command_id": "enquire_link",
+ "command_length": 16,
+ "command_status": "ESME_ROK",
+ "sequence_number": 0
+ }
+}'''
+
+########################################
+pdu_json_0000000028 = '''{
+ "header": {
+ "command_id": "enquire_link_resp",
+ "command_length": 16,
+ "command_status": "ESME_ROK",
+ "sequence_number": 0
+ }
+}'''
+
+########################################
+pdu_json_0000000029 = '''{
+ "body": {
+ "mandatory_parameters": {
+ "esme_addr": "",
+ "esme_addr_npi": "unknown",
+ "esme_addr_ton": 9,
+ "source_addr": "",
+ "source_addr_npi": "ISDN",
+ "source_addr_ton": "international"
+ }
+ },
+ "header": {
+ "command_id": "alert_notification",
+ "command_length": 22,
+ "command_status": "ESME_ROK",
+ "sequence_number": 0
+ }
+}'''
diff --git a/tests.py b/tests.py
new file mode 100644
index 0000000..a300fcf
--- /dev/null
+++ b/tests.py
@@ -0,0 +1,451 @@
+import unittest
+from datetime import datetime, timedelta
+
+try:
+ from smpp.esme import *
+except:
+ from src.smpp.esme import *
+
+from test.pdu import pdu_objects
+from test import pdu_asserts
+
+
+
+def create_pdu_asserts():
+ pdu_index = 0
+ for pdu in pdu_objects:
+ pdu_index += 1
+ pstr = "\n########################################\n"
+ pstr += "pdu_json_"
+ pstr += ('%010d' % pdu_index)
+ pstr += " = '''"
+ pstr += json.dumps(
+ unpack_pdu(pack_pdu(pdu)),
+ indent=4,
+ sort_keys=True)
+ pstr += "'''"
+ print pstr
+
+
+## :w|!python % > test/pdu_asserts.py
+#create_pdu_asserts()
+#quit()
+
+
+class SmppTestCase(unittest.TestCase):
+
+ def setUp(self):
+ pass
+
+ def tearDown(self):
+ pass
+
+ def test_pack_unpack_pdu_objects(self):
+ pdu_index = 0
+ for pdu in pdu_objects:
+ pdu_index += 1
+ padded_index = '%010d' % pdu_index
+ print padded_index
+ self.assertEquals(
+ re.sub('\n *','',
+ json.dumps(
+ unpack_pdu(pack_pdu(pdu)),
+ indent=4,
+ sort_keys=True)),
+ re.sub('\n *','',
+ eval('pdu_asserts.pdu_json_'+padded_index)))
+
+
+ def test_pack_unpack_preformance(self):
+ submit_sm = {
+ 'header': {
+ 'command_length': 0,
+ 'command_id': 'submit_sm',
+ 'command_status': 'ESME_ROK',
+ 'sequence_number': 0,
+ },
+ 'body': {
+ 'mandatory_parameters': {
+ 'service_type':'',
+ 'source_addr_ton':1,
+ 'source_addr_npi':1,
+ 'source_addr':'',
+ 'dest_addr_ton':1,
+ 'dest_addr_npi':1,
+ 'destination_addr':'',
+ 'esm_class':0,
+ 'protocol_id':0,
+ 'priority_flag':0,
+ 'schedule_delivery_time':'',
+ 'validity_period':'',
+ 'registered_delivery':0,
+ 'replace_if_present_flag':0,
+ 'data_coding':0,
+ 'sm_default_msg_id':0,
+ 'sm_length':1,
+ 'short_message':'',
+ },
+ },
+ }
+ start = datetime.now()
+ for x in range(2000):
+ x += 1
+ submit_sm['header']['sequence_number'] = x
+ sm = 'testing: x = '+str(x)+''
+ submit_sm['body']['mandatory_parameters']['short_message'] = sm
+ u = unpack_pdu(pack_pdu(submit_sm))
+ delta = datetime.now() - start
+ print '\n2000 pack/unpacks:', delta
+ self.assertTrue(delta < timedelta(seconds=1))
+
+
+if __name__ == '__main__':
+ unittest.main()
+
+
+quit()
+
+
+
+
+
+
+
+
+def unpack(pdu_hex):
+ """Unpack PDU and return it as a dictionary"""
+ return unpack_pdu(binascii.a2b_hex(hexclean(pdu_hex)))
+
+def prettydump(pdu_hex):
+ """Unpack PDU and dump it as a JSON formatted string"""
+ return json.dumps(unpack_pdu(binascii.a2b_hex(hexclean(x))), indent=4, sort_keys=True)
+
+def hexclean(dirtyhex):
+ """Remove whitespace, comments & newlines from hex string"""
+ return re.sub(r'\s','',re.sub(r'#.*\n','\n',dirtyhex))
+
+stars = "\n******************************************************************\n"
+
+
+
+print ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>"
+
+#esme = ESME()
+#esme.connect_SMSC('localhost')
+#esme.bind_SMSC()
+#esme.disconnect_SMSC()
+
+print ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>"
+
+x = '''
+ 0000003C # command_length
+ 00000004 # command_id
+ 00000000 # command_status
+ 00000005 # sequence_number
+ 00
+ 02
+ 08
+ 35353500
+ 01
+ 01
+ 35353535353535353500
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 0F
+ 48656C6C6F2077696B697065646961
+ 00000000
+ 001d00026566
+'''
+print stars, prettydump(x)
+
+
+x = '''
+ 00000000 # command_length
+ 00000021 # command_id
+ 00000000 # command_status
+ 00000000 # sequence_number
+ 00
+ 00
+ 00
+ 00
+ 02
+ 01 01 01 6500
+ 02 6600
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 0005 0002 0000
+ 0000 0004 00000000
+'''
+print stars, prettydump(x)
+
+
+x = '''
+ 00000000
+ 80000021
+ 00000000
+ 00000000
+ 00
+ 02
+ 01016565650000000000
+ 01016666660000000000
+'''
+print stars, prettydump(x)
+
+
+
+
+quit()
+class PythonSmppTestCase(TestCase):
+
+ def setUp(self):
+ # Sample dictionary used for packing & unpacking
+ self.dictionary = {
+ 'header': {
+ 'command_length': 16,
+ 'command_id': 'bind_transmitter',
+ 'command_status': 'ESME_ROK',
+ 'sequence_number': 0
+ },
+ 'body': {
+ 'mandatory_parameters': {
+ 'system_id':'test_system',
+ 'password':'abc123',
+ 'system_type':'',
+ 'interface_version':'',
+ 'addr_ton':1,
+ 'addr_npi':1,
+ 'address_range':'',
+ },
+ 'optional_parameters': [
+ {
+ 'tag':'payload_type',
+ 'value':0
+ }
+ ]
+ }
+ }
+
+ def tearDown(self):
+ pass
+
+ def test_pretty_dump_1(self):
+ """Read the hex data, clean it and display the JSON"""
+ x = '''
+ 0000003C # command_length
+ 00000004 # command_id
+ 00000000 # command_status
+ 00000005 # sequence_number
+ 00
+ 02
+ 08
+ 35353500
+ 01
+ 01
+ 35353535353535353500
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 0F
+ 48656C6C6F2077696B697065646961
+ 00000000
+ 001d00026566
+ '''
+
+ self.assertEquals(unpack(x), {
+ "body": {
+ "mandatory_parameters": {
+ "data_coding": 0,
+ "dest_addr_npi": "ISDN",
+ "dest_addr_ton": "international",
+ "destination_addr": "555555555",
+ "esm_class": 0,
+ "priority_flag": 0,
+ "protocol_id": 0,
+ "registered_delivery": 0,
+ "replace_if_present_flag": 0,
+ "schedule_delivery_time": "",
+ "service_type": "",
+ "short_message": "Hello wikipedia",
+ "sm_default_msg_id": 0,
+ "sm_length": 15,
+ "source_addr": "555",
+ "source_addr_npi": "national",
+ "source_addr_ton": "national",
+ "validity_period": ""
+ },
+ "optional_parameters": [
+ {
+ "length": 0,
+ "tag": "0000",
+ "value": None
+ },
+ {
+ "length": 2,
+ "tag": "additional_status_info_text",
+ "value": "ef"
+ }
+ ]
+ },
+ "header": {
+ "command_id": "submit_sm",
+ "command_length": 60,
+ "command_status": "ESME_ROK",
+ "sequence_number": 5
+ }
+ })
+
+ def test_pretty_dump_2(self):
+ """Read the hex data, clean it and display the JSON"""
+ x = '''
+ 00000000 # command_length
+ 00000021 # command_id
+ 00000000 # command_status
+ 00000000 # sequence_number
+ 00
+ 00
+ 00
+ 00
+ 02
+ 01 01 01 6500
+ 02 6600
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 0005 0002 0000
+ 0000 0004 00000000
+ '''
+ self.assertEquals(unpack(x), {
+ "body": {
+ "mandatory_parameters": {
+ "priority_flag": 0,
+ "number_of_dests": 2,
+ "protocol_id": 0,
+ "dest_address": [{
+ "dest_flag": 1,
+ "dest_addr_npi": "ISDN",
+ "dest_addr_ton": "international",
+ "destination_addr": "e"
+ },
+ {
+ "dest_flag": 2,
+ "dl_name": "f"
+ }],
+ "replace_if_present_flag": 0,
+ "registered_delivery": 0,
+ "source_addr_npi": "unknown",
+ "schedule_delivery_time": "",
+ "sm_default_msg_id": 0,
+ "sm_length": 0,
+ "esm_class": 0,
+ "data_coding": 0,
+ "service_type": "",
+ "source_addr": "",
+ "source_addr_ton": "unknown",
+ "validity_period": "",
+ "short_message": ""
+ },
+ "optional_parameters": [{
+ "length": 2,
+ "tag": "dest_addr_subunit",
+ "value": 0
+ },
+ {
+ "length": 4,
+ "tag": "0000",
+ "value": "00000000"
+ }]
+ },
+ "header": {
+ "command_status": "ESME_ROK",
+ "command_length": 0,
+ "sequence_number": 0,
+ "command_id": "submit_multi"
+ }
+ })
+
+ def test_pretty_dump_3(self):
+ """Read the hex data, clean it and display the JSON"""
+ x = '''
+ 00000000
+ 80000021
+ 00000000
+ 00000000
+ 00
+ 02
+ 01016565650000000000
+ 01016666660000000000
+ '''
+ self.assertEquals(unpack(x), {
+ "body": {
+ "mandatory_parameters": {
+ "message_id": "",
+ "no_unsuccess": 2,
+ "unsuccess_sme": [{
+ "error_status_code": 0,
+ "dest_addr_npi": "ISDN",
+ "dest_addr_ton": "international",
+ "destination_addr": "eee"
+ },
+ {
+ "error_status_code": 0,
+ "dest_addr_npi": "ISDN",
+ "dest_addr_ton": "international",
+ "destination_addr": "fff"
+ }]
+ }
+ },
+ "header": {
+ "command_status": "ESME_ROK",
+ "command_length": 0,
+ "sequence_number": 0,
+ "command_id": "submit_multi_resp"
+ }
+ })
+
+ def test_packing_of_dictionary(self):
+ """
+ It should take a dictionary, pack and unpack it and dump
+ it as JSON correctly.
+ """
+ dictionary = self.dictionary.copy()
+ print json.dumps(unpack_pdu(pack_pdu(dictionary)), indent=4, sort_keys=True)
+
+ def test_packing_of_100000_sequence(self):
+ """Test time to pack & unpack 10000 dictionaries"""
+ dictionary = self.dictionary.copy()
+ start = datetime.now()
+ for x in range(100000):
+ dictionary['header']['sequence_number'] = x
+ u = unpack_pdu(pack_pdu(dictionary))
+ print x+1, ':', datetime.now() - start
+
+
+
|
dmaclay/python-smpp
|
22acd7343d78613ff3ecc3a9d35af9f82d0d43df
|
sample dictionary for calculating length of PDU packet was wrong
|
diff --git a/tests.py b/tests.py
index 3fe89cd..85840f6 100644
--- a/tests.py
+++ b/tests.py
@@ -1,307 +1,307 @@
from unittest import TestCase
from datetime import datetime
from smpp.esme import *
from smpp import pdu
import collections
def unpack(pdu_hex):
"""Unpack PDU and return it as a dictionary"""
return unpack_pdu(binascii.a2b_hex(hexclean(pdu_hex)))
def prettydump(pdu_hex):
"""Unpack PDU and dump it as a JSON formatted string"""
return json.dumps(unpack_pdu(pdu_hex), indent=4, sort_keys=True)
def hexclean(dirtyhex):
"""Remove whitespace, comments & newlines from hex string"""
return re.sub(r'\s','',re.sub(r'#.*\n','\n',dirtyhex))
def hex_to_named(dictionary):
"""
Recursive function to convert values in test dictionaries to
their named counterparts that unpack_pdu returns
"""
clone = dictionary.copy()
for key, value in clone.items():
if isinstance(value, collections.Mapping):
clone[key] = hex_to_named(value)
else:
lookup_table = pdu.maps.get('%s_by_hex' % key)
if lookup_table:
# overwrite with mapped value or keep using
# default if the dictionary key doesn't exist
clone[key] = lookup_table.get("%.2d" % value, value)
return clone
class PythonSmppTestCase(TestCase):
def setUp(self):
# Sample dictionary used for packing & unpacking
self.dictionary = {
'header': {
- 'command_length': 16,
+ 'command_length': 45,
'command_id': 'bind_transmitter',
'command_status': 'ESME_ROK',
'sequence_number': 0
},
'body': {
'mandatory_parameters': {
'system_id':'test_system',
'password':'abc123',
'system_type':'',
'interface_version':'',
'addr_ton':1,
'addr_npi':1,
'address_range':'',
},
'optional_parameters': [
{
'tag':'payload_type',
'value':0,
'length':1
}
]
}
}
def tearDown(self):
pass
def assertDictEquals(self, dictionary1, dictionary2, depth=[]):
"""
Recursive dictionary comparison, will fail if any keys and values
in the two dictionaries don't match. Displays the key chain / depth
and which parts of the two dictionaries didn't match.
"""
d1_keys = dictionary1.keys()
d1_keys.sort()
d2_keys = dictionary2.keys()
d2_keys.sort()
self.failUnlessEqual(d1_keys, d2_keys,
"Dictionary keys do not match, %s vs %s" % (
d1_keys, d2_keys))
for key, value in dictionary1.items():
if isinstance(value, collections.Mapping):
# go recursive
depth.append(key)
self.assertDictEquals(value, dictionary2[key], depth)
else:
self.failUnlessEqual(value, dictionary2[key],
"Dictionary values do not match for key '%s' " \
"(%s vs %s) at depth: %s.\nDictionary 1: %s\n" \
"Dictionary 2: %s\n" % (
key, value, dictionary2[key], ".".join(depth),
dictionary1, dictionary2))
def test_pretty_dump_1(self):
"""Read the hex data, clean it and display the JSON"""
x = '''
0000003C # command_length
00000004 # command_id
00000000 # command_status
00000005 # sequence_number
00
02
08
35353500
01
01
35353535353535353500
00
00
00
00
00
00
00
00
00
0F
48656C6C6F2077696B697065646961
00000000
001d00026566
'''
self.assertDictEquals(unpack(x), {
"body": {
"mandatory_parameters": {
"data_coding": 0,
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "555555555",
"esm_class": 0,
"priority_flag": 0,
"protocol_id": 0,
"registered_delivery": 0,
"replace_if_present_flag": 0,
"schedule_delivery_time": "",
"service_type": "",
"short_message": "Hello wikipedia",
"sm_default_msg_id": 0,
"sm_length": 15,
"source_addr": "555",
"source_addr_npi": "national",
"source_addr_ton": "national",
"validity_period": ""
},
"optional_parameters": [
{
"length": 0,
"tag": "0000",
"value": None
},
{
"length": 2,
"tag": "additional_status_info_text",
"value": "ef"
}
]
},
"header": {
"command_id": "submit_sm",
"command_length": 60,
"command_status": "ESME_ROK",
"sequence_number": 5
}
})
def test_pretty_dump_2(self):
"""Read the hex data, clean it and display the JSON"""
x = '''
00000000 # command_length
00000021 # command_id
00000000 # command_status
00000000 # sequence_number
00
00
00
00
02
01 01 01 6500
02 6600
00
00
00
00
00
00
00
00
00
00
0005 0002 0000
0000 0004 00000000
'''
self.assertDictEquals(unpack(x), {
"body": {
"mandatory_parameters": {
"priority_flag": 0,
"number_of_dests": 2,
"protocol_id": 0,
"dest_address": [{
"dest_flag": 1,
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "e"
},
{
"dest_flag": 2,
"dl_name": "f"
}],
"replace_if_present_flag": 0,
"registered_delivery": 0,
"source_addr_npi": "unknown",
"schedule_delivery_time": "",
"sm_default_msg_id": 0,
"sm_length": 0,
"esm_class": 0,
"data_coding": 0,
"service_type": "",
"source_addr": "",
"source_addr_ton": "unknown",
"validity_period": "",
"short_message": ""
},
"optional_parameters": [{
"length": 2,
"tag": "dest_addr_subunit",
"value": 0
},
{
"length": 4,
"tag": "0000",
"value": "00000000"
}]
},
"header": {
"command_status": "ESME_ROK",
"command_length": 0,
"sequence_number": 0,
"command_id": "submit_multi"
}
})
def test_pretty_dump_3(self):
"""Read the hex data, clean it and display the JSON"""
x = '''
00000000
80000021
00000000
00000000
00
02
01016565650000000000
01016666660000000000
'''
self.assertDictEquals(unpack(x), {
"body": {
"mandatory_parameters": {
"message_id": "",
"no_unsuccess": 2,
"unsuccess_sme": [{
"error_status_code": 0,
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "eee"
},
{
"error_status_code": 0,
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "fff"
}]
}
},
"header": {
"command_status": "ESME_ROK",
"command_length": 0,
"sequence_number": 0,
"command_id": "submit_multi_resp"
}
})
def test_packing_and_unpacking_of_dictionary(self):
"""
It should take a dictionary, pack and unpack it and dump
it as JSON correctly.
"""
dictionary = self.dictionary.copy()
self.assertDictEquals(
hex_to_named(dictionary),
unpack_pdu(pack_pdu(dictionary))
)
def test_packing_of_100000_sequence(self):
"""Test time to pack & unpack 10000 dictionaries"""
dictionary = self.dictionary.copy()
start = datetime.now()
for x in range(100000):
dictionary['header']['sequence_number'] = x
u = unpack_pdu(pack_pdu(dictionary))
print x+1, ':', datetime.now() - start
|
dmaclay/python-smpp
|
423476e83c52dec9f804ee1ccd9178397a2963b9
|
adding assertDictEquals(dict,dict), gives a more sane output when two dictionaries dont equal, much easier to debug encoding / decoding issues
|
diff --git a/tests.py b/tests.py
index 1f0655e..3fe89cd 100644
--- a/tests.py
+++ b/tests.py
@@ -1,256 +1,307 @@
from unittest import TestCase
from datetime import datetime
from smpp.esme import *
+from smpp import pdu
+import collections
def unpack(pdu_hex):
"""Unpack PDU and return it as a dictionary"""
return unpack_pdu(binascii.a2b_hex(hexclean(pdu_hex)))
def prettydump(pdu_hex):
"""Unpack PDU and dump it as a JSON formatted string"""
return json.dumps(unpack_pdu(pdu_hex), indent=4, sort_keys=True)
def hexclean(dirtyhex):
"""Remove whitespace, comments & newlines from hex string"""
return re.sub(r'\s','',re.sub(r'#.*\n','\n',dirtyhex))
+def hex_to_named(dictionary):
+ """
+ Recursive function to convert values in test dictionaries to
+ their named counterparts that unpack_pdu returns
+ """
+ clone = dictionary.copy()
+ for key, value in clone.items():
+ if isinstance(value, collections.Mapping):
+ clone[key] = hex_to_named(value)
+ else:
+ lookup_table = pdu.maps.get('%s_by_hex' % key)
+ if lookup_table:
+ # overwrite with mapped value or keep using
+ # default if the dictionary key doesn't exist
+ clone[key] = lookup_table.get("%.2d" % value, value)
+ return clone
class PythonSmppTestCase(TestCase):
def setUp(self):
# Sample dictionary used for packing & unpacking
self.dictionary = {
'header': {
'command_length': 16,
'command_id': 'bind_transmitter',
'command_status': 'ESME_ROK',
'sequence_number': 0
},
'body': {
'mandatory_parameters': {
'system_id':'test_system',
'password':'abc123',
'system_type':'',
'interface_version':'',
'addr_ton':1,
'addr_npi':1,
'address_range':'',
},
'optional_parameters': [
{
'tag':'payload_type',
- 'value':0
+ 'value':0,
+ 'length':1
}
]
}
}
def tearDown(self):
pass
+ def assertDictEquals(self, dictionary1, dictionary2, depth=[]):
+ """
+ Recursive dictionary comparison, will fail if any keys and values
+ in the two dictionaries don't match. Displays the key chain / depth
+ and which parts of the two dictionaries didn't match.
+ """
+ d1_keys = dictionary1.keys()
+ d1_keys.sort()
+
+ d2_keys = dictionary2.keys()
+ d2_keys.sort()
+
+ self.failUnlessEqual(d1_keys, d2_keys,
+ "Dictionary keys do not match, %s vs %s" % (
+ d1_keys, d2_keys))
+ for key, value in dictionary1.items():
+ if isinstance(value, collections.Mapping):
+ # go recursive
+ depth.append(key)
+ self.assertDictEquals(value, dictionary2[key], depth)
+ else:
+ self.failUnlessEqual(value, dictionary2[key],
+ "Dictionary values do not match for key '%s' " \
+ "(%s vs %s) at depth: %s.\nDictionary 1: %s\n" \
+ "Dictionary 2: %s\n" % (
+ key, value, dictionary2[key], ".".join(depth),
+ dictionary1, dictionary2))
+
+
def test_pretty_dump_1(self):
"""Read the hex data, clean it and display the JSON"""
x = '''
0000003C # command_length
00000004 # command_id
00000000 # command_status
00000005 # sequence_number
00
02
08
35353500
01
01
35353535353535353500
00
00
00
00
00
00
00
00
00
0F
48656C6C6F2077696B697065646961
00000000
001d00026566
'''
- self.assertEquals(unpack(x), {
+ self.assertDictEquals(unpack(x), {
"body": {
"mandatory_parameters": {
"data_coding": 0,
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "555555555",
"esm_class": 0,
"priority_flag": 0,
"protocol_id": 0,
"registered_delivery": 0,
"replace_if_present_flag": 0,
"schedule_delivery_time": "",
"service_type": "",
"short_message": "Hello wikipedia",
"sm_default_msg_id": 0,
"sm_length": 15,
"source_addr": "555",
"source_addr_npi": "national",
"source_addr_ton": "national",
"validity_period": ""
},
"optional_parameters": [
{
"length": 0,
"tag": "0000",
"value": None
},
{
"length": 2,
"tag": "additional_status_info_text",
"value": "ef"
}
]
},
"header": {
"command_id": "submit_sm",
"command_length": 60,
"command_status": "ESME_ROK",
"sequence_number": 5
}
})
def test_pretty_dump_2(self):
"""Read the hex data, clean it and display the JSON"""
x = '''
00000000 # command_length
00000021 # command_id
00000000 # command_status
00000000 # sequence_number
00
00
00
00
02
01 01 01 6500
02 6600
00
00
00
00
00
00
00
00
00
00
0005 0002 0000
0000 0004 00000000
'''
- self.assertEquals(unpack(x), {
+ self.assertDictEquals(unpack(x), {
"body": {
"mandatory_parameters": {
"priority_flag": 0,
"number_of_dests": 2,
"protocol_id": 0,
"dest_address": [{
"dest_flag": 1,
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "e"
},
{
"dest_flag": 2,
"dl_name": "f"
}],
"replace_if_present_flag": 0,
"registered_delivery": 0,
"source_addr_npi": "unknown",
"schedule_delivery_time": "",
"sm_default_msg_id": 0,
"sm_length": 0,
"esm_class": 0,
"data_coding": 0,
"service_type": "",
"source_addr": "",
"source_addr_ton": "unknown",
"validity_period": "",
"short_message": ""
},
"optional_parameters": [{
"length": 2,
"tag": "dest_addr_subunit",
"value": 0
},
{
"length": 4,
"tag": "0000",
"value": "00000000"
}]
},
"header": {
"command_status": "ESME_ROK",
"command_length": 0,
"sequence_number": 0,
"command_id": "submit_multi"
}
})
def test_pretty_dump_3(self):
"""Read the hex data, clean it and display the JSON"""
x = '''
00000000
80000021
00000000
00000000
00
02
01016565650000000000
01016666660000000000
'''
- self.assertEquals(unpack(x), {
+ self.assertDictEquals(unpack(x), {
"body": {
"mandatory_parameters": {
"message_id": "",
"no_unsuccess": 2,
"unsuccess_sme": [{
"error_status_code": 0,
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "eee"
},
{
"error_status_code": 0,
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "fff"
}]
}
},
"header": {
"command_status": "ESME_ROK",
"command_length": 0,
"sequence_number": 0,
"command_id": "submit_multi_resp"
}
})
- def test_packing_of_dictionary(self):
+ def test_packing_and_unpacking_of_dictionary(self):
"""
It should take a dictionary, pack and unpack it and dump
it as JSON correctly.
"""
dictionary = self.dictionary.copy()
- print json.dumps(unpack_pdu(pack_pdu(dictionary)), indent=4, sort_keys=True)
+ self.assertDictEquals(
+ hex_to_named(dictionary),
+ unpack_pdu(pack_pdu(dictionary))
+ )
def test_packing_of_100000_sequence(self):
"""Test time to pack & unpack 10000 dictionaries"""
dictionary = self.dictionary.copy()
start = datetime.now()
for x in range(100000):
dictionary['header']['sequence_number'] = x
u = unpack_pdu(pack_pdu(dictionary))
- print x+1, ':', datetime.now() - start
+ print x+1, ':', datetime.now() - start
|
dmaclay/python-smpp
|
b7b7cc48e9e7ab42d357679b1fbabb02ee1acc56
|
in the process of converting tests.py to a TestCase for nosetests
|
diff --git a/README b/README
new file mode 100644
index 0000000..501008a
--- /dev/null
+++ b/README
@@ -0,0 +1,16 @@
+Python SMPP
+===========
+
+An SMPP version 3.4 library written in Python, suitable for use in [Twisted][twisted]
+
+To get started with development:
+
+ $ virtualenv --no-site-packges ve/
+ $ source ve/bin/activate
+ (ve)$ pip install -r requirements.pip
+ (ve)$ python setup.py develop
+ (ve)$ python
+ >>> import smpp
+ >>>
+
+[twisted]: http://www.twistedmatrix.com
diff --git a/requirements.pip b/requirements.pip
index e69de29..a6c88f5 100644
--- a/requirements.pip
+++ b/requirements.pip
@@ -0,0 +1,2 @@
+nose
+coverage
diff --git a/setup.cfg b/setup.cfg
new file mode 100644
index 0000000..9eec931
--- /dev/null
+++ b/setup.cfg
@@ -0,0 +1,3 @@
+[nosetests]
+with-doctest=1
+nocapture=1
diff --git a/tests.py b/tests.py
index ff7442f..1f0655e 100644
--- a/tests.py
+++ b/tests.py
@@ -1,132 +1,256 @@
+from unittest import TestCase
from datetime import datetime
-
from smpp.esme import *
+def unpack(pdu_hex):
+ """Unpack PDU and return it as a dictionary"""
+ return unpack_pdu(binascii.a2b_hex(hexclean(pdu_hex)))
def prettydump(pdu_hex):
- return json.dumps(unpack_pdu(binascii.a2b_hex(hexclean(x))), indent=4, sort_keys=True)
+ """Unpack PDU and dump it as a JSON formatted string"""
+ return json.dumps(unpack_pdu(pdu_hex), indent=4, sort_keys=True)
def hexclean(dirtyhex):
+ """Remove whitespace, comments & newlines from hex string"""
return re.sub(r'\s','',re.sub(r'#.*\n','\n',dirtyhex))
-stars = "\n******************************************************************\n"
-
-
-
-print ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>"
-
-#esme = ESME()
-#esme.connect_SMSC('localhost')
-#esme.bind_SMSC()
-#esme.disconnect_SMSC()
-
-print ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>"
-
-x = '''
- 0000003C # command_length
- 00000004 # command_id
- 00000000 # command_status
- 00000005 # sequence_number
- 00
- 02
- 08
- 35353500
- 01
- 01
- 35353535353535353500
- 00
- 00
- 00
- 00
- 00
- 00
- 00
- 00
- 00
- 0F
- 48656C6C6F2077696B697065646961
- 00000000
- 001d00026566
-'''
-print stars, prettydump(x)
-
-
-x = '''
- 00000000 # command_length
- 00000021 # command_id
- 00000000 # command_status
- 00000000 # sequence_number
- 00
- 00
- 00
- 00
- 02
- 01 01 01 6500
- 02 6600
- 00
- 00
- 00
- 00
- 00
- 00
- 00
- 00
- 00
- 00
- 0005 0002 0000
- 0000 0004 00000000
-'''
-print stars, prettydump(x)
-
-x = '''
- 00000000
- 80000021
- 00000000
- 00000000
- 00
- 02
- 01016565650000000000
- 01016666660000000000
-'''
-print stars, prettydump(x)
-
-
-
-
-b = {
- 'header': {
- 'command_length': 16,
- 'command_id': 'bind_transmitter',
- 'command_status': 'ESME_ROK',
- 'sequence_number': 0
- },
- 'body': {
- 'mandatory_parameters': {
- 'system_id':'test_system',
- 'password':'abc123',
- 'system_type':'',
- 'interface_version':'',
- 'addr_ton':1,
- 'addr_npi':1,
- 'address_range':'',
- },
- 'optional_parameters': [
- {
- 'tag':'payload_type',
- 'value':0
+class PythonSmppTestCase(TestCase):
+
+ def setUp(self):
+ # Sample dictionary used for packing & unpacking
+ self.dictionary = {
+ 'header': {
+ 'command_length': 16,
+ 'command_id': 'bind_transmitter',
+ 'command_status': 'ESME_ROK',
+ 'sequence_number': 0
+ },
+ 'body': {
+ 'mandatory_parameters': {
+ 'system_id':'test_system',
+ 'password':'abc123',
+ 'system_type':'',
+ 'interface_version':'',
+ 'addr_ton':1,
+ 'addr_npi':1,
+ 'address_range':'',
+ },
+ 'optional_parameters': [
+ {
+ 'tag':'payload_type',
+ 'value':0
+ }
+ ]
}
- ]
- }
-}
-
-print stars, json.dumps(unpack_pdu(pack_pdu(b)), indent=4, sort_keys=True)
-
-start = datetime.now()
-for x in range(100000):
- b['header']['sequence_number'] = x
- u = unpack_pdu(pack_pdu(b))
-print stars, x+1, ':', datetime.now() - start
+ }
+
+ def tearDown(self):
+ pass
+
+ def test_pretty_dump_1(self):
+ """Read the hex data, clean it and display the JSON"""
+ x = '''
+ 0000003C # command_length
+ 00000004 # command_id
+ 00000000 # command_status
+ 00000005 # sequence_number
+ 00
+ 02
+ 08
+ 35353500
+ 01
+ 01
+ 35353535353535353500
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 0F
+ 48656C6C6F2077696B697065646961
+ 00000000
+ 001d00026566
+ '''
+
+ self.assertEquals(unpack(x), {
+ "body": {
+ "mandatory_parameters": {
+ "data_coding": 0,
+ "dest_addr_npi": "ISDN",
+ "dest_addr_ton": "international",
+ "destination_addr": "555555555",
+ "esm_class": 0,
+ "priority_flag": 0,
+ "protocol_id": 0,
+ "registered_delivery": 0,
+ "replace_if_present_flag": 0,
+ "schedule_delivery_time": "",
+ "service_type": "",
+ "short_message": "Hello wikipedia",
+ "sm_default_msg_id": 0,
+ "sm_length": 15,
+ "source_addr": "555",
+ "source_addr_npi": "national",
+ "source_addr_ton": "national",
+ "validity_period": ""
+ },
+ "optional_parameters": [
+ {
+ "length": 0,
+ "tag": "0000",
+ "value": None
+ },
+ {
+ "length": 2,
+ "tag": "additional_status_info_text",
+ "value": "ef"
+ }
+ ]
+ },
+ "header": {
+ "command_id": "submit_sm",
+ "command_length": 60,
+ "command_status": "ESME_ROK",
+ "sequence_number": 5
+ }
+ })
+
+ def test_pretty_dump_2(self):
+ """Read the hex data, clean it and display the JSON"""
+ x = '''
+ 00000000 # command_length
+ 00000021 # command_id
+ 00000000 # command_status
+ 00000000 # sequence_number
+ 00
+ 00
+ 00
+ 00
+ 02
+ 01 01 01 6500
+ 02 6600
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 0005 0002 0000
+ 0000 0004 00000000
+ '''
+ self.assertEquals(unpack(x), {
+ "body": {
+ "mandatory_parameters": {
+ "priority_flag": 0,
+ "number_of_dests": 2,
+ "protocol_id": 0,
+ "dest_address": [{
+ "dest_flag": 1,
+ "dest_addr_npi": "ISDN",
+ "dest_addr_ton": "international",
+ "destination_addr": "e"
+ },
+ {
+ "dest_flag": 2,
+ "dl_name": "f"
+ }],
+ "replace_if_present_flag": 0,
+ "registered_delivery": 0,
+ "source_addr_npi": "unknown",
+ "schedule_delivery_time": "",
+ "sm_default_msg_id": 0,
+ "sm_length": 0,
+ "esm_class": 0,
+ "data_coding": 0,
+ "service_type": "",
+ "source_addr": "",
+ "source_addr_ton": "unknown",
+ "validity_period": "",
+ "short_message": ""
+ },
+ "optional_parameters": [{
+ "length": 2,
+ "tag": "dest_addr_subunit",
+ "value": 0
+ },
+ {
+ "length": 4,
+ "tag": "0000",
+ "value": "00000000"
+ }]
+ },
+ "header": {
+ "command_status": "ESME_ROK",
+ "command_length": 0,
+ "sequence_number": 0,
+ "command_id": "submit_multi"
+ }
+ })
+
+ def test_pretty_dump_3(self):
+ """Read the hex data, clean it and display the JSON"""
+ x = '''
+ 00000000
+ 80000021
+ 00000000
+ 00000000
+ 00
+ 02
+ 01016565650000000000
+ 01016666660000000000
+ '''
+ self.assertEquals(unpack(x), {
+ "body": {
+ "mandatory_parameters": {
+ "message_id": "",
+ "no_unsuccess": 2,
+ "unsuccess_sme": [{
+ "error_status_code": 0,
+ "dest_addr_npi": "ISDN",
+ "dest_addr_ton": "international",
+ "destination_addr": "eee"
+ },
+ {
+ "error_status_code": 0,
+ "dest_addr_npi": "ISDN",
+ "dest_addr_ton": "international",
+ "destination_addr": "fff"
+ }]
+ }
+ },
+ "header": {
+ "command_status": "ESME_ROK",
+ "command_length": 0,
+ "sequence_number": 0,
+ "command_id": "submit_multi_resp"
+ }
+ })
+ def test_packing_of_dictionary(self):
+ """
+ It should take a dictionary, pack and unpack it and dump
+ it as JSON correctly.
+ """
+ dictionary = self.dictionary.copy()
+ print json.dumps(unpack_pdu(pack_pdu(dictionary)), indent=4, sort_keys=True)
+
+ def test_packing_of_100000_sequence(self):
+ """Test time to pack & unpack 10000 dictionaries"""
+ dictionary = self.dictionary.copy()
+ start = datetime.now()
+ for x in range(100000):
+ dictionary['header']['sequence_number'] = x
+ u = unpack_pdu(pack_pdu(dictionary))
+ print x+1, ':', datetime.now() - start
+
|
dmaclay/python-smpp
|
4a0e656ba9b8606f10c7116987653403a6f412e0
|
Updating README and adding setup.py for easier installation into other projects using pip & friends.
|
diff --git a/.gitignore b/.gitignore
index c4e79a4..0ec0997 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,4 @@
*.swp
*.pyc
*.egg-info
-
+ve/
diff --git a/README b/README
deleted file mode 100644
index 71757c9..0000000
--- a/README
+++ /dev/null
@@ -1,2 +0,0 @@
-
- coming soon ... ish
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e057ebe
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+Python SMPP
+===========
+
+An SMPP version 3.4 library written in Python, suitable for using in [Twisted][twisted]
+
+To get started with development:
+
+ $ virtualenv --no-site-packges ve/
+ $ source ve/bin/activate
+ (ve)$ pip install -r requirements.pip
+ (ve)$ python setup.py develop
+ (ve)$ python
+ >>> import smpp
+ >>>
+
+[twisted]: http://www.twistedmatrix.com
diff --git a/smpp/__init__.py b/requirements.pip
similarity index 100%
rename from smpp/__init__.py
rename to requirements.pip
diff --git a/setup.py b/setup.py
new file mode 100644
index 0000000..0e251ca
--- /dev/null
+++ b/setup.py
@@ -0,0 +1,14 @@
+from setuptools import setup, find_packages
+
+setup(
+ name = "python-smpp",
+ version = "0.1",
+ url = 'http://github.com/smn/python-smpp',
+ license = 'BSD',
+ description = "Python SMPP Library",
+ author = 'David Maclay',
+ packages = find_packages('src'),
+ package_dir = {'': 'src'},
+ install_requires = [],
+)
+
diff --git a/src/smpp/__init__.py b/src/smpp/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/smpp/esme.py b/src/smpp/esme.py
similarity index 100%
rename from smpp/esme.py
rename to src/smpp/esme.py
diff --git a/smpp/pdu.py b/src/smpp/pdu.py
similarity index 100%
rename from smpp/pdu.py
rename to src/smpp/pdu.py
|
dmaclay/python-smpp
|
dc14d104b8146508bb9da96723fddf496a3b2133
|
sample dictionary for calculating length of PDU packet was wrong
|
diff --git a/tests.py b/tests.py
index 3fe89cd..85840f6 100644
--- a/tests.py
+++ b/tests.py
@@ -1,307 +1,307 @@
from unittest import TestCase
from datetime import datetime
from smpp.esme import *
from smpp import pdu
import collections
def unpack(pdu_hex):
"""Unpack PDU and return it as a dictionary"""
return unpack_pdu(binascii.a2b_hex(hexclean(pdu_hex)))
def prettydump(pdu_hex):
"""Unpack PDU and dump it as a JSON formatted string"""
return json.dumps(unpack_pdu(pdu_hex), indent=4, sort_keys=True)
def hexclean(dirtyhex):
"""Remove whitespace, comments & newlines from hex string"""
return re.sub(r'\s','',re.sub(r'#.*\n','\n',dirtyhex))
def hex_to_named(dictionary):
"""
Recursive function to convert values in test dictionaries to
their named counterparts that unpack_pdu returns
"""
clone = dictionary.copy()
for key, value in clone.items():
if isinstance(value, collections.Mapping):
clone[key] = hex_to_named(value)
else:
lookup_table = pdu.maps.get('%s_by_hex' % key)
if lookup_table:
# overwrite with mapped value or keep using
# default if the dictionary key doesn't exist
clone[key] = lookup_table.get("%.2d" % value, value)
return clone
class PythonSmppTestCase(TestCase):
def setUp(self):
# Sample dictionary used for packing & unpacking
self.dictionary = {
'header': {
- 'command_length': 16,
+ 'command_length': 45,
'command_id': 'bind_transmitter',
'command_status': 'ESME_ROK',
'sequence_number': 0
},
'body': {
'mandatory_parameters': {
'system_id':'test_system',
'password':'abc123',
'system_type':'',
'interface_version':'',
'addr_ton':1,
'addr_npi':1,
'address_range':'',
},
'optional_parameters': [
{
'tag':'payload_type',
'value':0,
'length':1
}
]
}
}
def tearDown(self):
pass
def assertDictEquals(self, dictionary1, dictionary2, depth=[]):
"""
Recursive dictionary comparison, will fail if any keys and values
in the two dictionaries don't match. Displays the key chain / depth
and which parts of the two dictionaries didn't match.
"""
d1_keys = dictionary1.keys()
d1_keys.sort()
d2_keys = dictionary2.keys()
d2_keys.sort()
self.failUnlessEqual(d1_keys, d2_keys,
"Dictionary keys do not match, %s vs %s" % (
d1_keys, d2_keys))
for key, value in dictionary1.items():
if isinstance(value, collections.Mapping):
# go recursive
depth.append(key)
self.assertDictEquals(value, dictionary2[key], depth)
else:
self.failUnlessEqual(value, dictionary2[key],
"Dictionary values do not match for key '%s' " \
"(%s vs %s) at depth: %s.\nDictionary 1: %s\n" \
"Dictionary 2: %s\n" % (
key, value, dictionary2[key], ".".join(depth),
dictionary1, dictionary2))
def test_pretty_dump_1(self):
"""Read the hex data, clean it and display the JSON"""
x = '''
0000003C # command_length
00000004 # command_id
00000000 # command_status
00000005 # sequence_number
00
02
08
35353500
01
01
35353535353535353500
00
00
00
00
00
00
00
00
00
0F
48656C6C6F2077696B697065646961
00000000
001d00026566
'''
self.assertDictEquals(unpack(x), {
"body": {
"mandatory_parameters": {
"data_coding": 0,
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "555555555",
"esm_class": 0,
"priority_flag": 0,
"protocol_id": 0,
"registered_delivery": 0,
"replace_if_present_flag": 0,
"schedule_delivery_time": "",
"service_type": "",
"short_message": "Hello wikipedia",
"sm_default_msg_id": 0,
"sm_length": 15,
"source_addr": "555",
"source_addr_npi": "national",
"source_addr_ton": "national",
"validity_period": ""
},
"optional_parameters": [
{
"length": 0,
"tag": "0000",
"value": None
},
{
"length": 2,
"tag": "additional_status_info_text",
"value": "ef"
}
]
},
"header": {
"command_id": "submit_sm",
"command_length": 60,
"command_status": "ESME_ROK",
"sequence_number": 5
}
})
def test_pretty_dump_2(self):
"""Read the hex data, clean it and display the JSON"""
x = '''
00000000 # command_length
00000021 # command_id
00000000 # command_status
00000000 # sequence_number
00
00
00
00
02
01 01 01 6500
02 6600
00
00
00
00
00
00
00
00
00
00
0005 0002 0000
0000 0004 00000000
'''
self.assertDictEquals(unpack(x), {
"body": {
"mandatory_parameters": {
"priority_flag": 0,
"number_of_dests": 2,
"protocol_id": 0,
"dest_address": [{
"dest_flag": 1,
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "e"
},
{
"dest_flag": 2,
"dl_name": "f"
}],
"replace_if_present_flag": 0,
"registered_delivery": 0,
"source_addr_npi": "unknown",
"schedule_delivery_time": "",
"sm_default_msg_id": 0,
"sm_length": 0,
"esm_class": 0,
"data_coding": 0,
"service_type": "",
"source_addr": "",
"source_addr_ton": "unknown",
"validity_period": "",
"short_message": ""
},
"optional_parameters": [{
"length": 2,
"tag": "dest_addr_subunit",
"value": 0
},
{
"length": 4,
"tag": "0000",
"value": "00000000"
}]
},
"header": {
"command_status": "ESME_ROK",
"command_length": 0,
"sequence_number": 0,
"command_id": "submit_multi"
}
})
def test_pretty_dump_3(self):
"""Read the hex data, clean it and display the JSON"""
x = '''
00000000
80000021
00000000
00000000
00
02
01016565650000000000
01016666660000000000
'''
self.assertDictEquals(unpack(x), {
"body": {
"mandatory_parameters": {
"message_id": "",
"no_unsuccess": 2,
"unsuccess_sme": [{
"error_status_code": 0,
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "eee"
},
{
"error_status_code": 0,
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "fff"
}]
}
},
"header": {
"command_status": "ESME_ROK",
"command_length": 0,
"sequence_number": 0,
"command_id": "submit_multi_resp"
}
})
def test_packing_and_unpacking_of_dictionary(self):
"""
It should take a dictionary, pack and unpack it and dump
it as JSON correctly.
"""
dictionary = self.dictionary.copy()
self.assertDictEquals(
hex_to_named(dictionary),
unpack_pdu(pack_pdu(dictionary))
)
def test_packing_of_100000_sequence(self):
"""Test time to pack & unpack 10000 dictionaries"""
dictionary = self.dictionary.copy()
start = datetime.now()
for x in range(100000):
dictionary['header']['sequence_number'] = x
u = unpack_pdu(pack_pdu(dictionary))
print x+1, ':', datetime.now() - start
|
dmaclay/python-smpp
|
662759651be51305b66251af3dbe622b28747ce2
|
adding assertDictEquals(dict,dict), gives a more sane output when two dictionaries dont equal, much easier to debug encoding / decoding issues
|
diff --git a/tests.py b/tests.py
index 1f0655e..3fe89cd 100644
--- a/tests.py
+++ b/tests.py
@@ -1,256 +1,307 @@
from unittest import TestCase
from datetime import datetime
from smpp.esme import *
+from smpp import pdu
+import collections
def unpack(pdu_hex):
"""Unpack PDU and return it as a dictionary"""
return unpack_pdu(binascii.a2b_hex(hexclean(pdu_hex)))
def prettydump(pdu_hex):
"""Unpack PDU and dump it as a JSON formatted string"""
return json.dumps(unpack_pdu(pdu_hex), indent=4, sort_keys=True)
def hexclean(dirtyhex):
"""Remove whitespace, comments & newlines from hex string"""
return re.sub(r'\s','',re.sub(r'#.*\n','\n',dirtyhex))
+def hex_to_named(dictionary):
+ """
+ Recursive function to convert values in test dictionaries to
+ their named counterparts that unpack_pdu returns
+ """
+ clone = dictionary.copy()
+ for key, value in clone.items():
+ if isinstance(value, collections.Mapping):
+ clone[key] = hex_to_named(value)
+ else:
+ lookup_table = pdu.maps.get('%s_by_hex' % key)
+ if lookup_table:
+ # overwrite with mapped value or keep using
+ # default if the dictionary key doesn't exist
+ clone[key] = lookup_table.get("%.2d" % value, value)
+ return clone
class PythonSmppTestCase(TestCase):
def setUp(self):
# Sample dictionary used for packing & unpacking
self.dictionary = {
'header': {
'command_length': 16,
'command_id': 'bind_transmitter',
'command_status': 'ESME_ROK',
'sequence_number': 0
},
'body': {
'mandatory_parameters': {
'system_id':'test_system',
'password':'abc123',
'system_type':'',
'interface_version':'',
'addr_ton':1,
'addr_npi':1,
'address_range':'',
},
'optional_parameters': [
{
'tag':'payload_type',
- 'value':0
+ 'value':0,
+ 'length':1
}
]
}
}
def tearDown(self):
pass
+ def assertDictEquals(self, dictionary1, dictionary2, depth=[]):
+ """
+ Recursive dictionary comparison, will fail if any keys and values
+ in the two dictionaries don't match. Displays the key chain / depth
+ and which parts of the two dictionaries didn't match.
+ """
+ d1_keys = dictionary1.keys()
+ d1_keys.sort()
+
+ d2_keys = dictionary2.keys()
+ d2_keys.sort()
+
+ self.failUnlessEqual(d1_keys, d2_keys,
+ "Dictionary keys do not match, %s vs %s" % (
+ d1_keys, d2_keys))
+ for key, value in dictionary1.items():
+ if isinstance(value, collections.Mapping):
+ # go recursive
+ depth.append(key)
+ self.assertDictEquals(value, dictionary2[key], depth)
+ else:
+ self.failUnlessEqual(value, dictionary2[key],
+ "Dictionary values do not match for key '%s' " \
+ "(%s vs %s) at depth: %s.\nDictionary 1: %s\n" \
+ "Dictionary 2: %s\n" % (
+ key, value, dictionary2[key], ".".join(depth),
+ dictionary1, dictionary2))
+
+
def test_pretty_dump_1(self):
"""Read the hex data, clean it and display the JSON"""
x = '''
0000003C # command_length
00000004 # command_id
00000000 # command_status
00000005 # sequence_number
00
02
08
35353500
01
01
35353535353535353500
00
00
00
00
00
00
00
00
00
0F
48656C6C6F2077696B697065646961
00000000
001d00026566
'''
- self.assertEquals(unpack(x), {
+ self.assertDictEquals(unpack(x), {
"body": {
"mandatory_parameters": {
"data_coding": 0,
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "555555555",
"esm_class": 0,
"priority_flag": 0,
"protocol_id": 0,
"registered_delivery": 0,
"replace_if_present_flag": 0,
"schedule_delivery_time": "",
"service_type": "",
"short_message": "Hello wikipedia",
"sm_default_msg_id": 0,
"sm_length": 15,
"source_addr": "555",
"source_addr_npi": "national",
"source_addr_ton": "national",
"validity_period": ""
},
"optional_parameters": [
{
"length": 0,
"tag": "0000",
"value": None
},
{
"length": 2,
"tag": "additional_status_info_text",
"value": "ef"
}
]
},
"header": {
"command_id": "submit_sm",
"command_length": 60,
"command_status": "ESME_ROK",
"sequence_number": 5
}
})
def test_pretty_dump_2(self):
"""Read the hex data, clean it and display the JSON"""
x = '''
00000000 # command_length
00000021 # command_id
00000000 # command_status
00000000 # sequence_number
00
00
00
00
02
01 01 01 6500
02 6600
00
00
00
00
00
00
00
00
00
00
0005 0002 0000
0000 0004 00000000
'''
- self.assertEquals(unpack(x), {
+ self.assertDictEquals(unpack(x), {
"body": {
"mandatory_parameters": {
"priority_flag": 0,
"number_of_dests": 2,
"protocol_id": 0,
"dest_address": [{
"dest_flag": 1,
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "e"
},
{
"dest_flag": 2,
"dl_name": "f"
}],
"replace_if_present_flag": 0,
"registered_delivery": 0,
"source_addr_npi": "unknown",
"schedule_delivery_time": "",
"sm_default_msg_id": 0,
"sm_length": 0,
"esm_class": 0,
"data_coding": 0,
"service_type": "",
"source_addr": "",
"source_addr_ton": "unknown",
"validity_period": "",
"short_message": ""
},
"optional_parameters": [{
"length": 2,
"tag": "dest_addr_subunit",
"value": 0
},
{
"length": 4,
"tag": "0000",
"value": "00000000"
}]
},
"header": {
"command_status": "ESME_ROK",
"command_length": 0,
"sequence_number": 0,
"command_id": "submit_multi"
}
})
def test_pretty_dump_3(self):
"""Read the hex data, clean it and display the JSON"""
x = '''
00000000
80000021
00000000
00000000
00
02
01016565650000000000
01016666660000000000
'''
- self.assertEquals(unpack(x), {
+ self.assertDictEquals(unpack(x), {
"body": {
"mandatory_parameters": {
"message_id": "",
"no_unsuccess": 2,
"unsuccess_sme": [{
"error_status_code": 0,
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "eee"
},
{
"error_status_code": 0,
"dest_addr_npi": "ISDN",
"dest_addr_ton": "international",
"destination_addr": "fff"
}]
}
},
"header": {
"command_status": "ESME_ROK",
"command_length": 0,
"sequence_number": 0,
"command_id": "submit_multi_resp"
}
})
- def test_packing_of_dictionary(self):
+ def test_packing_and_unpacking_of_dictionary(self):
"""
It should take a dictionary, pack and unpack it and dump
it as JSON correctly.
"""
dictionary = self.dictionary.copy()
- print json.dumps(unpack_pdu(pack_pdu(dictionary)), indent=4, sort_keys=True)
+ self.assertDictEquals(
+ hex_to_named(dictionary),
+ unpack_pdu(pack_pdu(dictionary))
+ )
def test_packing_of_100000_sequence(self):
"""Test time to pack & unpack 10000 dictionaries"""
dictionary = self.dictionary.copy()
start = datetime.now()
for x in range(100000):
dictionary['header']['sequence_number'] = x
u = unpack_pdu(pack_pdu(dictionary))
- print x+1, ':', datetime.now() - start
+ print x+1, ':', datetime.now() - start
|
dmaclay/python-smpp
|
0711313866bdde5032cc85f977c7f75ac87cb1b3
|
pre pull merge
|
diff --git a/smpp/pdu.py b/smpp/pdu.py
index ab8162c..ce6deb3 100644
--- a/smpp/pdu.py
+++ b/smpp/pdu.py
@@ -426,562 +426,562 @@ command_status_by_name = {
'ESME_RINVDSTNPI' :{'hex':'00000051', 'name':'ESME_RINVDSTNPI', 'description':'Invalid destination address NPI'},
'ESME_RINVSYSTYP' :{'hex':'00000053', 'name':'ESME_RINVSYSTYP', 'description':'Invalid system_type field'},
'ESME_RINVREPFLAG' :{'hex':'00000054', 'name':'ESME_RINVREPFLAG', 'description':'Invalid replace_if_present flag'},
'ESME_RINVNUMMSGS' :{'hex':'00000055', 'name':'ESME_RINVNUMMSGS', 'description':'Invalid number of messages'},
'ESME_RTHROTTLED' :{'hex':'00000058', 'name':'ESME_RTHROTTLED', 'description':'Throttling error (ESME has exceeded allowed message limits)'},
'ESME_RINVSCHED' :{'hex':'00000061', 'name':'ESME_RINVSCHED', 'description':'Invalid scheduled delivery time'},
'ESME_RINVEXPIRY' :{'hex':'00000062', 'name':'ESME_RINVEXPIRY', 'description':'Invalid message validity period (expiry time)'},
'ESME_RINVDFTMSGID' :{'hex':'00000063', 'name':'ESME_RINVDFTMSGID', 'description':'Predefined message invalid or not found'},
'ESME_RX_T_APPN' :{'hex':'00000064', 'name':'ESME_RX_T_APPN', 'description':'ESME Receiver Temporary App Error Code'},
'ESME_RX_P_APPN' :{'hex':'00000065', 'name':'ESME_RX_P_APPN', 'description':'ESME Receiver Permanent App Error Code'},
'ESME_RX_R_APPN' :{'hex':'00000066', 'name':'ESME_RX_R_APPN', 'description':'ESME Receiver Reject Message Error Code'},
'ESME_RQUERYFAIL' :{'hex':'00000067', 'name':'ESME_RQUERYFAIL', 'description':'query_sm request failed'},
'ESME_RINVOPTPARSTREAM':{'hex':'000000c0', 'name':'ESME_RINVOPTPARSTREAM', 'description':'Error in the optional part of the PDU Body'},
'ESME_ROPTPARNOTALLWD' :{'hex':'000000c1', 'name':'ESME_ROPTPARNOTALLWD', 'description':'Optional paramenter not allowed'},
'ESME_RINVPARLEN' :{'hex':'000000c2', 'name':'ESME_RINVPARLEN', 'description':'Invalid parameter length'},
'ESME_RMISSINGOPTPARAM':{'hex':'000000c3', 'name':'ESME_RMISSINGOPTPARAM', 'description':'Expected optional parameter missing'},
'ESME_RINVOPTPARAMVAL' :{'hex':'000000c4', 'name':'ESME_RINVOPTPARAMVAL', 'description':'Invalid optional parameter value'},
'ESME_RDELIVERYFAILURE':{'hex':'000000fe', 'name':'ESME_RDELIVERYFAILURE', 'description':'Delivery Failure (used for data_sm_resp)'},
'ESME_RUNKNOWNERR' :{'hex':'000000ff', 'name':'ESME_RUNKNOWNERR', 'description':'Unknown error'}
}
def command_status_hex_by_name(n):
return command_status_by_name.get(n,{}).get('hex')
# Type of Number (TON) - SMPP v3.4, section 5.2.5, table 5-3, page 117
maps['addr_ton_by_name'] = {
'' :'00',
'unknown' :'00',
'international' :'01',
'national' :'02',
'network_specific' :'03',
'subscriber_number':'04',
'alphanumeric' :'05',
'abbreviated' :'06'
}
maps['addr_ton_by_hex'] = {
'00':'unknown',
'01':'international',
'02':'national',
'03':'network_specific',
'04':'subscriber_number',
'05':'alphanumeric',
'06':'abbreviated'
}
# Numberic Plan Indicator (NPI) - SMPP v3.4, section 5.2.6, table 5-4, page 118
maps['addr_npi_by_name'] = {
'' :'00',
'unknown' :'00',
'ISDN' :'01',
'data' :'03',
'telex' :'04',
'land_mobile':'06',
'national' :'08',
'private' :'09',
'ERMES' :'0a',
'internet' :'0e',
'WAP' :'12'
}
maps['addr_npi_by_hex'] = {
'00':'unknown',
'01':'ISDN',
'03':'data',
'04':'telex',
'06':'land_mobile',
'08':'national',
'09':'private',
'0a':'ERMES',
'0e':'internet',
'12':'WAP'
}
# ESM Class bits - SMPP v3.4, section 5.2.12, page 121
maps['esm_class_bits'] = {
'mode_mask' :'03',
'type_mask' :'3c',
'feature_mask' :'c0',
'mode_default' :'00',
'mode_datagram' :'01',
'mode_forward' :'02',
'mode_store_and_forward' :'03',
'type_default' :'00',
'type_delivery_receipt' :'04',
'type_delivery_ack' :'08',
'type_0011' :'0a',
'type_user_ack' :'10',
'type_0101' :'14',
'type_conversation_abort' :'18',
'type_0111' :'1a',
'type_intermed_deliv_notif' :'20',
'type_1001' :'24',
'type_1010' :'28',
'type_1011' :'2a',
'type_1100' :'30',
'type_1101' :'34',
'type_1110' :'38',
'type_1111' :'3a',
'feature_none' :'00',
'feature_UDHI' :'40',
'feature_reply_path' :'80',
'feature_UDHI_and_reply_path':'c0'
}
# Registered Delivery bits - SMPP v3.4, section 5.2.17, page 124
maps['registered_delivery_bits'] = {
'receipt_mask' :'03',
'ack_mask' :'0c',
'intermed_notif_mask' :'80',
'receipt_none' :'00',
'receipt_always' :'01',
'receipt_on_fail' :'02',
'receipt_res' :'03',
'ack_none' :'00',
'ack_delivery' :'04',
'ack_user' :'08',
'ack_delivery_and_user':'0c',
'intermed_notif_none' :'00',
'intermed_notif' :'10'
}
# submit_multi dest_flag constants - SMPP v3.4, section 5.2.25, page 129
#maps['dest_flag_by_name'] = {
#'SME Address' :1,
#'Distribution List Name':2
#}
# Message State codes returned in query_sm_resp PDUs - SMPP v3.4, section 5.2.28, table 5-6, page 130
maps['message_state_by_name'] = {
'ENROUTE' :1,
'DELIVERED' :2,
'EXPIRED' :3,
'DELETED' :4,
'UNDELIVERABLE':5,
'ACCEPTED' :6,
'UNKNOWN' :7,
'REJECTED' :8
}
# Facility Code bits for SMPP v4
maps['facility_code_bits'] = {
'GF_PVCY' :'00000001',
'GF_SUBADDR':'00000002',
'NF_CC' :'00080000',
'NF_PDC' :'00010000',
'NF_IS136' :'00020000',
'NF_IS95A' :'00040000'
}
# Optional Parameter Tags - SMPP v3.4, section 5.3.2, Table 5-7, page 132-133
optional_parameter_tag_by_hex = {
'0005':{'hex':'0005', 'name':'dest_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.1, page 134
'0006':{'hex':'0006', 'name':'dest_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.3, page 135
'0007':{'hex':'0007', 'name':'dest_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.5, page 136
'0008':{'hex':'0008', 'name':'dest_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.7, page 137
'000d':{'hex':'000d', 'name':'source_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.2, page 134
'000e':{'hex':'000e', 'name':'source_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.4, page 135
'000f':{'hex':'000f', 'name':'source_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.6, page 136
'0010':{'hex':'0010', 'name':'source_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.8, page 137
'0017':{'hex':'0017', 'name':'qos_time_to_live', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.9, page 138
'0019':{'hex':'0019', 'name':'payload_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.10, page 138
'001d':{'hex':'001d', 'name':'additional_status_info_text', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.11, page 139
'001e':{'hex':'001e', 'name':'receipted_message_id', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.12, page 139
'0030':{'hex':'0030', 'name':'ms_msg_wait_facilities', 'type':'bitmask', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.13, page 140
'0101':{'hex':'0101', 'name':'PVCY_AuthenticationStr', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 58-62
'0201':{'hex':'0201', 'name':'privacy_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.14, page 141
'0202':{'hex':'0202', 'name':'source_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.15, page 142
'0203':{'hex':'0203', 'name':'dest_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.16, page 143
'0204':{'hex':'0204', 'name':'user_message_reference', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.17, page 143
'0205':{'hex':'0205', 'name':'user_response_code', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.18, page 144
'020a':{'hex':'020a', 'name':'source_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.20, page 145
'020b':{'hex':'020b', 'name':'destination_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.21, page 145
'020c':{'hex':'020c', 'name':'sar_msg_ref_num', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.22, page 146
'020d':{'hex':'020d', 'name':'language_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.19, page 144
'020e':{'hex':'020e', 'name':'sar_total_segments', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.23, page 147
'020f':{'hex':'020f', 'name':'sar_segment_seqnum', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.24, page 147
'0210':{'hex':'0210', 'name':'sc_interface_version', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.25, page 148
'0301':{'hex':'0301', 'name':'CC_CBN', 'type':None, 'tech':'V4'}, # v4 page 70
'0302':{'hex':'0302', 'name':'callback_num_pres_ind', 'type':'bitmask', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.37, page 156
'0303':{'hex':'0303', 'name':'callback_num_atag', 'type':'hex', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.38, page 157
'0304':{'hex':'0304', 'name':'number_of_messages', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.39, page 158
'0381':{'hex':'0381', 'name':'callback_num', 'type':'hex', 'tech':'CDMA, TDMA, GSM, iDEN'}, # SMPP v3.4, section 5.3.2.36, page 155
'0420':{'hex':'0420', 'name':'dpf_result', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.28, page 149
'0421':{'hex':'0421', 'name':'set_dpf', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.29, page 150
'0422':{'hex':'0422', 'name':'ms_availability_status', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.30, page 151
'0423':{'hex':'0423', 'name':'network_error_code', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.31, page 152
'0424':{'hex':'0424', 'name':'message_payload', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.32, page 153
'0425':{'hex':'0425', 'name':'delivery_failure_reason', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.33, page 153
'0426':{'hex':'0426', 'name':'more_messages_to_send', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.34, page 154
'0427':{'hex':'0427', 'name':'message_state', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.35, page 154
'0428':{'hex':'0428', 'name':'congestion_state', 'type':None, 'tech':'Generic'},
'0501':{'hex':'0501', 'name':'ussd_service_op', 'type':'hex', 'tech':'GSM (USSD)'}, # SMPP v3.4, section 5.3.2.44, page 161
'0600':{'hex':'0600', 'name':'broadcast_channel_indicator', 'type':None, 'tech':'GSM'},
'0601':{'hex':'0601', 'name':'broadcast_content_type', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'0602':{'hex':'0602', 'name':'broadcast_content_type_info', 'type':None, 'tech':'CDMA, TDMA'},
'0603':{'hex':'0603', 'name':'broadcast_message_class', 'type':None, 'tech':'GSM'},
'0604':{'hex':'0604', 'name':'broadcast_rep_num', 'type':None, 'tech':'GSM'},
'0605':{'hex':'0605', 'name':'broadcast_frequency_interval', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'0606':{'hex':'0606', 'name':'broadcast_area_identifier', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'0607':{'hex':'0607', 'name':'broadcast_error_status', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'0608':{'hex':'0608', 'name':'broadcast_area_success', 'type':None, 'tech':'GSM'},
'0609':{'hex':'0609', 'name':'broadcast_end_time', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'060a':{'hex':'060a', 'name':'broadcast_service_group', 'type':None, 'tech':'CDMA, TDMA'},
'060b':{'hex':'060b', 'name':'billing_identification', 'type':None, 'tech':'Generic'},
'060d':{'hex':'060d', 'name':'source_network_id', 'type':None, 'tech':'Generic'},
'060e':{'hex':'060e', 'name':'dest_network_id', 'type':None, 'tech':'Generic'},
'060f':{'hex':'060f', 'name':'source_node_id', 'type':None, 'tech':'Generic'},
'0610':{'hex':'0610', 'name':'dest_node_id', 'type':None, 'tech':'Generic'},
'0611':{'hex':'0611', 'name':'dest_addr_np_resolution', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'0612':{'hex':'0612', 'name':'dest_addr_np_information', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'0613':{'hex':'0613', 'name':'dest_addr_np_country', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'1101':{'hex':'1101', 'name':'PDC_MessageClass', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 75
'1102':{'hex':'1102', 'name':'PDC_PresentationOption', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
'1103':{'hex':'1103', 'name':'PDC_AlertMechanism', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
'1104':{'hex':'1104', 'name':'PDC_Teleservice', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
'1105':{'hex':'1105', 'name':'PDC_MultiPartMessage', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
'1106':{'hex':'1106', 'name':'PDC_PredefinedMsg', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 78
'1201':{'hex':'1201', 'name':'display_time', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.26, page 148
'1203':{'hex':'1203', 'name':'sms_signal', 'type':'integer', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.40, page 158
'1204':{'hex':'1204', 'name':'ms_validity', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.27, page 149
'1304':{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'type':None, 'tech':'CDMA'}, # v4 page 85
'1306':{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'type':None, 'tech':'CDMA'}, # v4 page 86
'130c':{'hex':'130c', 'name':'alert_on_message_delivery', 'type':None, 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.41, page 159
'1380':{'hex':'1380', 'name':'its_reply_type', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.42, page 159
'1383':{'hex':'1383', 'name':'its_session_info', 'type':'hex', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.43, page 160
'1402':{'hex':'1402', 'name':'operator_id', 'type':None, 'tech':'vendor extension'},
'1403':{'hex':'1403', 'name':'tariff', 'type':None, 'tech':'Mobile Network Code vendor extension'},
'1450':{'hex':'1450', 'name':'mcc', 'type':None, 'tech':'Mobile Country Code vendor extension'},
'1451':{'hex':'1451', 'name':'mnc', 'type':None, 'tech':'Mobile Network Code vendor extension'}
}
def optional_parameter_tag_name_by_hex(x):
return optional_parameter_tag_by_hex.get(x,{}).get('name')
def optional_parameter_tag_type_by_hex(x):
return optional_parameter_tag_by_hex.get(x,{}).get('type')
optional_parameter_tag_by_name = {
'dest_addr_subunit' :{'hex':'0005', 'name':'dest_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.1, page 134
'dest_network_type' :{'hex':'0006', 'name':'dest_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.3, page 135
'dest_bearer_type' :{'hex':'0007', 'name':'dest_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.5, page 136
'dest_telematics_id' :{'hex':'0008', 'name':'dest_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.7, page 137
'source_addr_subunit' :{'hex':'000d', 'name':'source_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.2, page 134
'source_network_type' :{'hex':'000e', 'name':'source_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.4, page 135
'source_bearer_type' :{'hex':'000f', 'name':'source_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.6, page 136
'source_telematics_id' :{'hex':'0010', 'name':'source_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.8, page 137
'qos_time_to_live' :{'hex':'0017', 'name':'qos_time_to_live', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.9, page 138
'payload_type' :{'hex':'0019', 'name':'payload_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.10, page 138
'additional_status_info_text' :{'hex':'001d', 'name':'additional_status_info_text', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.11, page 139
'receipted_message_id' :{'hex':'001e', 'name':'receipted_message_id', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.12, page 139
'ms_msg_wait_facilities' :{'hex':'0030', 'name':'ms_msg_wait_facilities', 'type':'bitmask', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.13, page 140
'PVCY_AuthenticationStr' :{'hex':'0101', 'name':'PVCY_AuthenticationStr', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 58-62
'privacy_indicator' :{'hex':'0201', 'name':'privacy_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.14, page 141
'source_subaddress' :{'hex':'0202', 'name':'source_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.15, page 142
'dest_subaddress' :{'hex':'0203', 'name':'dest_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.16, page 143
'user_message_reference' :{'hex':'0204', 'name':'user_message_reference', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.17, page 143
'user_response_code' :{'hex':'0205', 'name':'user_response_code', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.18, page 144
'source_port' :{'hex':'020a', 'name':'source_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.20, page 145
'destination_port' :{'hex':'020b', 'name':'destination_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.21, page 145
'sar_msg_ref_num' :{'hex':'020c', 'name':'sar_msg_ref_num', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.22, page 146
'language_indicator' :{'hex':'020d', 'name':'language_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.19, page 144
'sar_total_segments' :{'hex':'020e', 'name':'sar_total_segments', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.23, page 147
'sar_segment_seqnum' :{'hex':'020f', 'name':'sar_segment_seqnum', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.24, page 147
'sc_interface_version' :{'hex':'0210', 'name':'sc_interface_version', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.25, page 148
'CC_CBN' :{'hex':'0301', 'name':'CC_CBN', 'type':None, 'tech':'V4'}, # v4 page 70
'callback_num_pres_ind' :{'hex':'0302', 'name':'callback_num_pres_ind', 'type':'bitmask', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.37, page 156
'callback_num_atag' :{'hex':'0303', 'name':'callback_num_atag', 'type':'hex', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.38, page 157
'number_of_messages' :{'hex':'0304', 'name':'number_of_messages', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.39, page 158
'callback_num' :{'hex':'0381', 'name':'callback_num', 'type':'hex', 'tech':'CDMA, TDMA, GSM, iDEN'}, # SMPP v3.4, section 5.3.2.36, page 155
'dpf_result' :{'hex':'0420', 'name':'dpf_result', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.28, page 149
'set_dpf' :{'hex':'0421', 'name':'set_dpf', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.29, page 150
'ms_availability_status' :{'hex':'0422', 'name':'ms_availability_status', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.30, page 151
'network_error_code' :{'hex':'0423', 'name':'network_error_code', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.31, page 152
'message_payload' :{'hex':'0424', 'name':'message_payload', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.32, page 153
'delivery_failure_reason' :{'hex':'0425', 'name':'delivery_failure_reason', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.33, page 153
'more_messages_to_send' :{'hex':'0426', 'name':'more_messages_to_send', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.34, page 154
'message_state' :{'hex':'0427', 'name':'message_state', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.35, page 154
'congestion_state' :{'hex':'0428', 'name':'congestion_state', 'type':None, 'tech':'Generic'},
'ussd_service_op' :{'hex':'0501', 'name':'ussd_service_op', 'type':'hex', 'tech':'GSM (USSD)'}, # SMPP v3.4, section 5.3.2.44, page 161
'broadcast_channel_indicator' :{'hex':'0600', 'name':'broadcast_channel_indicator', 'type':None, 'tech':'GSM'},
'broadcast_content_type' :{'hex':'0601', 'name':'broadcast_content_type', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_content_type_info' :{'hex':'0602', 'name':'broadcast_content_type_info', 'type':None, 'tech':'CDMA, TDMA'},
'broadcast_message_class' :{'hex':'0603', 'name':'broadcast_message_class', 'type':None, 'tech':'GSM'},
'broadcast_rep_num' :{'hex':'0604', 'name':'broadcast_rep_num', 'type':None, 'tech':'GSM'},
'broadcast_frequency_interval':{'hex':'0605', 'name':'broadcast_frequency_interval', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_area_identifier' :{'hex':'0606', 'name':'broadcast_area_identifier', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_error_status' :{'hex':'0607', 'name':'broadcast_error_status', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_area_success' :{'hex':'0608', 'name':'broadcast_area_success', 'type':None, 'tech':'GSM'},
'broadcast_end_time' :{'hex':'0609', 'name':'broadcast_end_time', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_service_group' :{'hex':'060a', 'name':'broadcast_service_group', 'type':None, 'tech':'CDMA, TDMA'},
'billing_identification' :{'hex':'060b', 'name':'billing_identification', 'type':None, 'tech':'Generic'},
'source_network_id' :{'hex':'060d', 'name':'source_network_id', 'type':None, 'tech':'Generic'},
'dest_network_id' :{'hex':'060e', 'name':'dest_network_id', 'type':None, 'tech':'Generic'},
'source_node_id' :{'hex':'060f', 'name':'source_node_id', 'type':None, 'tech':'Generic'},
'dest_node_id' :{'hex':'0610', 'name':'dest_node_id', 'type':None, 'tech':'Generic'},
'dest_addr_np_resolution' :{'hex':'0611', 'name':'dest_addr_np_resolution', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'dest_addr_np_information' :{'hex':'0612', 'name':'dest_addr_np_information', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'dest_addr_np_country' :{'hex':'0613', 'name':'dest_addr_np_country', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'PDC_MessageClass' :{'hex':'1101', 'name':'PDC_MessageClass', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 75
'PDC_PresentationOption' :{'hex':'1102', 'name':'PDC_PresentationOption', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
'PDC_AlertMechanism' :{'hex':'1103', 'name':'PDC_AlertMechanism', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
'PDC_Teleservice' :{'hex':'1104', 'name':'PDC_Teleservice', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
'PDC_MultiPartMessage' :{'hex':'1105', 'name':'PDC_MultiPartMessage', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
'PDC_PredefinedMsg' :{'hex':'1106', 'name':'PDC_PredefinedMsg', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 78
'display_time' :{'hex':'1201', 'name':'display_time', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.26, page 148
'sms_signal' :{'hex':'1203', 'name':'sms_signal', 'type':'integer', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.40, page 158
'ms_validity' :{'hex':'1204', 'name':'ms_validity', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.27, page 149
'IS95A_AlertOnDelivery' :{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'type':None, 'tech':'CDMA'}, # v4 page 85
'IS95A_LanguageIndicator' :{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'type':None, 'tech':'CDMA'}, # v4 page 86
'alert_on_message_delivery' :{'hex':'130c', 'name':'alert_on_message_delivery', 'type':None, 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.41, page 159
'its_reply_type' :{'hex':'1380', 'name':'its_reply_type', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.42, page 159
'its_session_info' :{'hex':'1383', 'name':'its_session_info', 'type':'hex', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.43, page 160
'operator_id' :{'hex':'1402', 'name':'operator_id', 'type':None, 'tech':'vendor extension'},
'tariff' :{'hex':'1403', 'name':'tariff', 'type':None, 'tech':'Mobile Network Code vendor extension'},
'mcc' :{'hex':'1450', 'name':'mcc', 'type':None, 'tech':'Mobile Country Code vendor extension'},
'mnc' :{'hex':'1451', 'name':'mnc', 'type':None, 'tech':'Mobile Network Code vendor extension'}
}
def optional_parameter_tag_hex_by_name(n):
return optional_parameter_tag_by_name.get(n,{}).get('hex')
#### Decoding functions #######################################################
def unpack_pdu(pdu_bin):
return decode_pdu(binascii.b2a_hex(pdu_bin))
def decode_pdu(pdu_hex):
hex_ref = [pdu_hex]
pdu = {}
pdu['header'] = decode_header(hex_ref)
command = pdu['header'].get('command_id', None)
if command != None:
body = decode_body(command, hex_ref)
if len(body) > 0:
pdu['body'] = body
return pdu
def decode_header(hex_ref):
pdu_hex = hex_ref[0]
header = {}
(command_length, command_id, command_status, sequence_number, hex_ref[0]) = \
(pdu_hex[0:8], pdu_hex[8:16], pdu_hex[16:24], pdu_hex[24:32], pdu_hex[32: ])
length = int(command_length, 16)
command = command_id_name_by_hex(command_id)
status = command_status_name_by_hex(command_status)
sequence = int(sequence_number, 16)
header = {}
header['command_length'] = length
header['command_id'] = command
header['command_status'] = status
header['sequence_number'] = sequence
return header
def decode_body(command, hex_ref):
body = {}
if command != None:
fields = mandatory_parameter_list_by_command_name(command)
mandatory = decode_mandatory_parameters(fields, hex_ref)
if len(mandatory) > 0:
body['mandatory_parameters'] = mandatory
optional = decode_optional_parameters(hex_ref)
if len(optional) > 0:
body['optional_parameters'] = optional
return body
def decode_mandatory_parameters(fields, hex_ref):
mandatory_parameters = {}
if len(hex_ref[0]) > 1:
for field in fields:
old = len(hex_ref[0])
data = ''
octet = ''
count = 0
if field['var'] == True or field['var'] == False:
while (len(hex_ref[0]) > 1
and (count < field['min']
or (count < field['max']
and octet != '00'))):
octet = octpop(hex_ref)
data += octet
count += 1
elif field['type'] == 'string':
count = mandatory_parameters[field['var']]
for i in range(count):
if len(hex_ref[0]) > 1:
data += octpop(hex_ref)
else:
count = mandatory_parameters[field['var']]
if field['map'] != None:
#print field, data
mandatory_parameters[field['name']] = maps.get(field['map']+'_by_hex',{data:data})[data]
else:
mandatory_parameters[field['name']] = decode_hex_type(data, field['type'], count, hex_ref)
#print field['type'], (old - len(hex_ref[0]))/2, repr(data), field['name'], mandatory_parameters[field['name']]
return mandatory_parameters
def decode_optional_parameters(hex_ref):
optional_parameters = []
hex = hex_ref[0]
while len(hex) > 0:
(tag_hex, length_hex, rest) = (hex[0:4], hex[4:8], hex[8: ])
tag = optional_parameter_tag_name_by_hex(tag_hex)
if tag == None:
tag = tag_hex
length = int(length_hex, 16)
(value_hex, tail) = (rest[0:length*2], rest[length*2: ])
if len(value_hex) == 0:
value = None
else:
value = decode_hex_type(value_hex, optional_parameter_tag_type_by_hex(tag_hex))
hex = tail
optional_parameters.append({'tag':tag, 'length':length, 'value':value})
return optional_parameters
def decode_hex_type(hex, type, count=0, hex_ref=['']):
if type == 'integer':
return int(hex, 16)
elif type == 'string':
return binascii.b2a_qp(binascii.a2b_hex(re.sub('00','',hex)))
elif (type == 'dest_address'
or type == 'unsuccess_sme'):
list = []
fields = mandatory_parameter_list_by_command_name(type)
for i in range(count):
item = decode_mandatory_parameters(fields, hex_ref)
if item.get('dest_flag', None) == 1: # 'dest_address' only
subfields = mandatory_parameter_list_by_command_name('sme_dest_address')
rest = decode_mandatory_parameters(subfields, hex_ref)
item.update(rest)
elif item.get('dest_flag', None) == 2: # 'dest_address' only
subfields = mandatory_parameter_list_by_command_name('distribution_list')
rest = decode_mandatory_parameters(subfields, hex_ref)
item.update(rest)
list.append(item)
return list
else:
return hex
def octpop(hex_ref):
octet = None
if len(hex_ref[0]) > 1:
(octet, hex_ref[0]) = (hex_ref[0][0:2], hex_ref[0][2: ])
return octet
#### Encoding functions #######################################################
-def pack_pdu(pdu_obj):
- return binascii.a2b_hex(encode_pdu(pdu_obj))
+def pack_pdu(json_obj):
+ return binascii.a2b_hex(encode_pdu(json_obj))
-def encode_pdu(pdu_obj):
- header = pdu_obj.get('header', {})
- body = pdu_obj.get('body', {})
+def encode_pdu(json_obj):
+ header = json_obj.get('header', {})
+ body = json_obj.get('body', {})
mandatory = body.get('mandatory_parameters', {})
optional = body.get('optional_parameters', [])
body_hex = ''
fields = mandatory_parameter_list_by_command_name(header['command_id'])
body_hex += encode_mandatory_parameters(mandatory, fields)
for opt in optional:
body_hex += encode_optional_parameter(opt['tag'], opt['value'])
actual_length = 16 + len(body_hex)/2
command_length = '%08x' % actual_length
command_id = command_id_hex_by_name(header['command_id'])
command_status = command_status_hex_by_name(header['command_status'])
sequence_number = '%08x' % header['sequence_number']
pdu_hex = command_length + command_id + command_status + sequence_number + body_hex
return pdu_hex
def encode_mandatory_parameters(mandatory_obj, fields):
mandatory_hex = ''
for field in fields:
param = mandatory_obj[field['name']]
mandatory_hex += encode_param_type(param, field['type'], field['min'], field['max'])
return mandatory_hex
def encode_optional_parameter(tag, value):
optional_hex = ''
tag_hex = optional_parameter_tag_hex_by_name(tag)
if tag_hex != None:
value_hex = '%02x' % value #TODO need encoding mapping
length_hex = '%04x' % (len(value_hex)/2)
optional_hex = tag_hex + length_hex + value_hex
return optional_hex
def encode_param_type(param, type, min=0, max=None):
if type == 'integer':
return '%02x' % int(param)
elif type == 'string':
hex = binascii.b2a_hex(binascii.a2b_qp(str(param))) + '00'
#print 'xxx', hex
return hex
else:
return '00'
|
dmaclay/python-smpp
|
3c8e0f7e9fb9860bf8c68c773612f2d91f988030
|
in the process of converting tests.py to a TestCase for nosetests
|
diff --git a/README b/README
new file mode 100644
index 0000000..501008a
--- /dev/null
+++ b/README
@@ -0,0 +1,16 @@
+Python SMPP
+===========
+
+An SMPP version 3.4 library written in Python, suitable for use in [Twisted][twisted]
+
+To get started with development:
+
+ $ virtualenv --no-site-packges ve/
+ $ source ve/bin/activate
+ (ve)$ pip install -r requirements.pip
+ (ve)$ python setup.py develop
+ (ve)$ python
+ >>> import smpp
+ >>>
+
+[twisted]: http://www.twistedmatrix.com
diff --git a/requirements.pip b/requirements.pip
index e69de29..a6c88f5 100644
--- a/requirements.pip
+++ b/requirements.pip
@@ -0,0 +1,2 @@
+nose
+coverage
diff --git a/setup.cfg b/setup.cfg
new file mode 100644
index 0000000..9eec931
--- /dev/null
+++ b/setup.cfg
@@ -0,0 +1,3 @@
+[nosetests]
+with-doctest=1
+nocapture=1
diff --git a/tests.py b/tests.py
index ff7442f..1f0655e 100644
--- a/tests.py
+++ b/tests.py
@@ -1,132 +1,256 @@
+from unittest import TestCase
from datetime import datetime
-
from smpp.esme import *
+def unpack(pdu_hex):
+ """Unpack PDU and return it as a dictionary"""
+ return unpack_pdu(binascii.a2b_hex(hexclean(pdu_hex)))
def prettydump(pdu_hex):
- return json.dumps(unpack_pdu(binascii.a2b_hex(hexclean(x))), indent=4, sort_keys=True)
+ """Unpack PDU and dump it as a JSON formatted string"""
+ return json.dumps(unpack_pdu(pdu_hex), indent=4, sort_keys=True)
def hexclean(dirtyhex):
+ """Remove whitespace, comments & newlines from hex string"""
return re.sub(r'\s','',re.sub(r'#.*\n','\n',dirtyhex))
-stars = "\n******************************************************************\n"
-
-
-
-print ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>"
-
-#esme = ESME()
-#esme.connect_SMSC('localhost')
-#esme.bind_SMSC()
-#esme.disconnect_SMSC()
-
-print ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>"
-
-x = '''
- 0000003C # command_length
- 00000004 # command_id
- 00000000 # command_status
- 00000005 # sequence_number
- 00
- 02
- 08
- 35353500
- 01
- 01
- 35353535353535353500
- 00
- 00
- 00
- 00
- 00
- 00
- 00
- 00
- 00
- 0F
- 48656C6C6F2077696B697065646961
- 00000000
- 001d00026566
-'''
-print stars, prettydump(x)
-
-
-x = '''
- 00000000 # command_length
- 00000021 # command_id
- 00000000 # command_status
- 00000000 # sequence_number
- 00
- 00
- 00
- 00
- 02
- 01 01 01 6500
- 02 6600
- 00
- 00
- 00
- 00
- 00
- 00
- 00
- 00
- 00
- 00
- 0005 0002 0000
- 0000 0004 00000000
-'''
-print stars, prettydump(x)
-
-x = '''
- 00000000
- 80000021
- 00000000
- 00000000
- 00
- 02
- 01016565650000000000
- 01016666660000000000
-'''
-print stars, prettydump(x)
-
-
-
-
-b = {
- 'header': {
- 'command_length': 16,
- 'command_id': 'bind_transmitter',
- 'command_status': 'ESME_ROK',
- 'sequence_number': 0
- },
- 'body': {
- 'mandatory_parameters': {
- 'system_id':'test_system',
- 'password':'abc123',
- 'system_type':'',
- 'interface_version':'',
- 'addr_ton':1,
- 'addr_npi':1,
- 'address_range':'',
- },
- 'optional_parameters': [
- {
- 'tag':'payload_type',
- 'value':0
+class PythonSmppTestCase(TestCase):
+
+ def setUp(self):
+ # Sample dictionary used for packing & unpacking
+ self.dictionary = {
+ 'header': {
+ 'command_length': 16,
+ 'command_id': 'bind_transmitter',
+ 'command_status': 'ESME_ROK',
+ 'sequence_number': 0
+ },
+ 'body': {
+ 'mandatory_parameters': {
+ 'system_id':'test_system',
+ 'password':'abc123',
+ 'system_type':'',
+ 'interface_version':'',
+ 'addr_ton':1,
+ 'addr_npi':1,
+ 'address_range':'',
+ },
+ 'optional_parameters': [
+ {
+ 'tag':'payload_type',
+ 'value':0
+ }
+ ]
}
- ]
- }
-}
-
-print stars, json.dumps(unpack_pdu(pack_pdu(b)), indent=4, sort_keys=True)
-
-start = datetime.now()
-for x in range(100000):
- b['header']['sequence_number'] = x
- u = unpack_pdu(pack_pdu(b))
-print stars, x+1, ':', datetime.now() - start
+ }
+
+ def tearDown(self):
+ pass
+
+ def test_pretty_dump_1(self):
+ """Read the hex data, clean it and display the JSON"""
+ x = '''
+ 0000003C # command_length
+ 00000004 # command_id
+ 00000000 # command_status
+ 00000005 # sequence_number
+ 00
+ 02
+ 08
+ 35353500
+ 01
+ 01
+ 35353535353535353500
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 0F
+ 48656C6C6F2077696B697065646961
+ 00000000
+ 001d00026566
+ '''
+
+ self.assertEquals(unpack(x), {
+ "body": {
+ "mandatory_parameters": {
+ "data_coding": 0,
+ "dest_addr_npi": "ISDN",
+ "dest_addr_ton": "international",
+ "destination_addr": "555555555",
+ "esm_class": 0,
+ "priority_flag": 0,
+ "protocol_id": 0,
+ "registered_delivery": 0,
+ "replace_if_present_flag": 0,
+ "schedule_delivery_time": "",
+ "service_type": "",
+ "short_message": "Hello wikipedia",
+ "sm_default_msg_id": 0,
+ "sm_length": 15,
+ "source_addr": "555",
+ "source_addr_npi": "national",
+ "source_addr_ton": "national",
+ "validity_period": ""
+ },
+ "optional_parameters": [
+ {
+ "length": 0,
+ "tag": "0000",
+ "value": None
+ },
+ {
+ "length": 2,
+ "tag": "additional_status_info_text",
+ "value": "ef"
+ }
+ ]
+ },
+ "header": {
+ "command_id": "submit_sm",
+ "command_length": 60,
+ "command_status": "ESME_ROK",
+ "sequence_number": 5
+ }
+ })
+
+ def test_pretty_dump_2(self):
+ """Read the hex data, clean it and display the JSON"""
+ x = '''
+ 00000000 # command_length
+ 00000021 # command_id
+ 00000000 # command_status
+ 00000000 # sequence_number
+ 00
+ 00
+ 00
+ 00
+ 02
+ 01 01 01 6500
+ 02 6600
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 0005 0002 0000
+ 0000 0004 00000000
+ '''
+ self.assertEquals(unpack(x), {
+ "body": {
+ "mandatory_parameters": {
+ "priority_flag": 0,
+ "number_of_dests": 2,
+ "protocol_id": 0,
+ "dest_address": [{
+ "dest_flag": 1,
+ "dest_addr_npi": "ISDN",
+ "dest_addr_ton": "international",
+ "destination_addr": "e"
+ },
+ {
+ "dest_flag": 2,
+ "dl_name": "f"
+ }],
+ "replace_if_present_flag": 0,
+ "registered_delivery": 0,
+ "source_addr_npi": "unknown",
+ "schedule_delivery_time": "",
+ "sm_default_msg_id": 0,
+ "sm_length": 0,
+ "esm_class": 0,
+ "data_coding": 0,
+ "service_type": "",
+ "source_addr": "",
+ "source_addr_ton": "unknown",
+ "validity_period": "",
+ "short_message": ""
+ },
+ "optional_parameters": [{
+ "length": 2,
+ "tag": "dest_addr_subunit",
+ "value": 0
+ },
+ {
+ "length": 4,
+ "tag": "0000",
+ "value": "00000000"
+ }]
+ },
+ "header": {
+ "command_status": "ESME_ROK",
+ "command_length": 0,
+ "sequence_number": 0,
+ "command_id": "submit_multi"
+ }
+ })
+
+ def test_pretty_dump_3(self):
+ """Read the hex data, clean it and display the JSON"""
+ x = '''
+ 00000000
+ 80000021
+ 00000000
+ 00000000
+ 00
+ 02
+ 01016565650000000000
+ 01016666660000000000
+ '''
+ self.assertEquals(unpack(x), {
+ "body": {
+ "mandatory_parameters": {
+ "message_id": "",
+ "no_unsuccess": 2,
+ "unsuccess_sme": [{
+ "error_status_code": 0,
+ "dest_addr_npi": "ISDN",
+ "dest_addr_ton": "international",
+ "destination_addr": "eee"
+ },
+ {
+ "error_status_code": 0,
+ "dest_addr_npi": "ISDN",
+ "dest_addr_ton": "international",
+ "destination_addr": "fff"
+ }]
+ }
+ },
+ "header": {
+ "command_status": "ESME_ROK",
+ "command_length": 0,
+ "sequence_number": 0,
+ "command_id": "submit_multi_resp"
+ }
+ })
+ def test_packing_of_dictionary(self):
+ """
+ It should take a dictionary, pack and unpack it and dump
+ it as JSON correctly.
+ """
+ dictionary = self.dictionary.copy()
+ print json.dumps(unpack_pdu(pack_pdu(dictionary)), indent=4, sort_keys=True)
+
+ def test_packing_of_100000_sequence(self):
+ """Test time to pack & unpack 10000 dictionaries"""
+ dictionary = self.dictionary.copy()
+ start = datetime.now()
+ for x in range(100000):
+ dictionary['header']['sequence_number'] = x
+ u = unpack_pdu(pack_pdu(dictionary))
+ print x+1, ':', datetime.now() - start
+
|
dmaclay/python-smpp
|
400d1680443b5e2d183aede275a56b8c23b71fcb
|
Updating README and adding setup.py for easier installation into other projects using pip & friends.
|
diff --git a/.gitignore b/.gitignore
index c4e79a4..0ec0997 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,4 @@
*.swp
*.pyc
*.egg-info
-
+ve/
diff --git a/README b/README
deleted file mode 100644
index 71757c9..0000000
--- a/README
+++ /dev/null
@@ -1,2 +0,0 @@
-
- coming soon ... ish
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e057ebe
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+Python SMPP
+===========
+
+An SMPP version 3.4 library written in Python, suitable for using in [Twisted][twisted]
+
+To get started with development:
+
+ $ virtualenv --no-site-packges ve/
+ $ source ve/bin/activate
+ (ve)$ pip install -r requirements.pip
+ (ve)$ python setup.py develop
+ (ve)$ python
+ >>> import smpp
+ >>>
+
+[twisted]: http://www.twistedmatrix.com
diff --git a/smpp/__init__.py b/requirements.pip
similarity index 100%
rename from smpp/__init__.py
rename to requirements.pip
diff --git a/setup.py b/setup.py
new file mode 100644
index 0000000..0e251ca
--- /dev/null
+++ b/setup.py
@@ -0,0 +1,14 @@
+from setuptools import setup, find_packages
+
+setup(
+ name = "python-smpp",
+ version = "0.1",
+ url = 'http://github.com/smn/python-smpp',
+ license = 'BSD',
+ description = "Python SMPP Library",
+ author = 'David Maclay',
+ packages = find_packages('src'),
+ package_dir = {'': 'src'},
+ install_requires = [],
+)
+
diff --git a/src/smpp/__init__.py b/src/smpp/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/smpp/esme.py b/src/smpp/esme.py
similarity index 100%
rename from smpp/esme.py
rename to src/smpp/esme.py
diff --git a/smpp/pdu.py b/src/smpp/pdu.py
similarity index 100%
rename from smpp/pdu.py
rename to src/smpp/pdu.py
|
dmaclay/python-smpp
|
5174d4e4636e56ba290512fb466bcc4ee898acd6
|
100,000 pack & unpack
|
diff --git a/tests.py b/tests.py
index 203587b..ff7442f 100644
--- a/tests.py
+++ b/tests.py
@@ -1,129 +1,132 @@
+from datetime import datetime
from smpp.esme import *
+
def prettydump(pdu_hex):
return json.dumps(unpack_pdu(binascii.a2b_hex(hexclean(x))), indent=4, sort_keys=True)
def hexclean(dirtyhex):
return re.sub(r'\s','',re.sub(r'#.*\n','\n',dirtyhex))
-lines = "\n==================================================================\n"
+stars = "\n******************************************************************\n"
print ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>"
#esme = ESME()
#esme.connect_SMSC('localhost')
#esme.bind_SMSC()
#esme.disconnect_SMSC()
print ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>"
x = '''
0000003C # command_length
00000004 # command_id
00000000 # command_status
00000005 # sequence_number
00
02
08
35353500
01
01
35353535353535353500
00
00
00
00
00
00
00
00
00
0F
48656C6C6F2077696B697065646961
00000000
001d00026566
'''
-print lines, prettydump(x)
+print stars, prettydump(x)
x = '''
00000000 # command_length
00000021 # command_id
00000000 # command_status
00000000 # sequence_number
00
00
00
00
02
01 01 01 6500
02 6600
00
00
00
00
00
00
00
00
00
00
0005 0002 0000
0000 0004 00000000
'''
-print lines, prettydump(x)
+print stars, prettydump(x)
x = '''
00000000
80000021
00000000
00000000
00
02
01016565650000000000
01016666660000000000
'''
-print lines, prettydump(x)
+print stars, prettydump(x)
b = {
'header': {
'command_length': 16,
'command_id': 'bind_transmitter',
'command_status': 'ESME_ROK',
'sequence_number': 0
},
'body': {
'mandatory_parameters': {
'system_id':'test_system',
'password':'abc123',
'system_type':'',
'interface_version':'',
'addr_ton':1,
'addr_npi':1,
'address_range':'',
},
'optional_parameters': [
{
'tag':'payload_type',
'value':0
}
]
}
}
-print '**********************************************************'
-print json.dumps(unpack_pdu(pack_pdu(b)), indent=4, sort_keys=True)
+print stars, json.dumps(unpack_pdu(pack_pdu(b)), indent=4, sort_keys=True)
-print "'''''"
-for x in range(10000):
+start = datetime.now()
+for x in range(100000):
b['header']['sequence_number'] = x
u = unpack_pdu(pack_pdu(b))
- print u['header']['sequence_number']
-print "'''''"
+print stars, x+1, ':', datetime.now() - start
+
+
+
|
dmaclay/python-smpp
|
2989e0d2cde58ae7be39308e3ea0bd639d25037a
|
pack / unpack speed test
|
diff --git a/tests.py b/tests.py
index 9436781..203587b 100644
--- a/tests.py
+++ b/tests.py
@@ -1,122 +1,129 @@
from smpp.esme import *
def prettydump(pdu_hex):
return json.dumps(unpack_pdu(binascii.a2b_hex(hexclean(x))), indent=4, sort_keys=True)
def hexclean(dirtyhex):
return re.sub(r'\s','',re.sub(r'#.*\n','\n',dirtyhex))
lines = "\n==================================================================\n"
print ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>"
#esme = ESME()
#esme.connect_SMSC('localhost')
#esme.bind_SMSC()
#esme.disconnect_SMSC()
print ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>"
x = '''
0000003C # command_length
00000004 # command_id
00000000 # command_status
00000005 # sequence_number
00
02
08
35353500
01
01
35353535353535353500
00
00
00
00
00
00
00
00
00
0F
48656C6C6F2077696B697065646961
00000000
001d00026566
'''
print lines, prettydump(x)
x = '''
00000000 # command_length
00000021 # command_id
00000000 # command_status
00000000 # sequence_number
00
00
00
00
02
01 01 01 6500
02 6600
00
00
00
00
00
00
00
00
00
00
0005 0002 0000
0000 0004 00000000
'''
print lines, prettydump(x)
x = '''
00000000
80000021
00000000
00000000
00
02
01016565650000000000
01016666660000000000
'''
print lines, prettydump(x)
b = {
'header': {
'command_length': 16,
'command_id': 'bind_transmitter',
'command_status': 'ESME_ROK',
'sequence_number': 0
},
'body': {
'mandatory_parameters': {
- 'system_id':'eee',
- 'password':'fff',
+ 'system_id':'test_system',
+ 'password':'abc123',
'system_type':'',
'interface_version':'',
'addr_ton':1,
'addr_npi':1,
'address_range':'',
},
'optional_parameters': [
{
'tag':'payload_type',
'value':0
}
]
}
}
-
+print '**********************************************************'
print json.dumps(unpack_pdu(pack_pdu(b)), indent=4, sort_keys=True)
+
+print "'''''"
+for x in range(10000):
+ b['header']['sequence_number'] = x
+ u = unpack_pdu(pack_pdu(b))
+ print u['header']['sequence_number']
+print "'''''"
|
dmaclay/python-smpp
|
4e2114b99f25dfdd58a8fb08a9320c57fa03d6f0
|
pack / unpack speed test
|
diff --git a/smpp/pdu.py b/smpp/pdu.py
index eac188d..ab8162c 100644
--- a/smpp/pdu.py
+++ b/smpp/pdu.py
@@ -365,623 +365,623 @@ command_status_by_hex = {
'00000040':{'hex':'00000040', 'name':'ESME_RINVDESTFLAG', 'description':'Destination flag is invalid (submit_multi)'},
'00000042':{'hex':'00000042', 'name':'ESME_RINVSUBREP', 'description':"Invalid `submit with replace' request (i.e. submit_sm with replace_if_present_flag set)"},
'00000043':{'hex':'00000043', 'name':'ESME_RINVESMCLASS', 'description':'Invalid esm_class field data'},
'00000044':{'hex':'00000044', 'name':'ESME_RCNTSUBDL', 'description':'Cannot submit to distribution list'},
'00000045':{'hex':'00000045', 'name':'ESME_RSUBMITFAIL', 'description':'submit_sm or submit_multi failed'},
'00000048':{'hex':'00000048', 'name':'ESME_RINVSRCTON', 'description':'Invalid source address TON'},
'00000049':{'hex':'00000049', 'name':'ESME_RINVSRCNPI', 'description':'Invalid source address NPI'},
'00000050':{'hex':'00000050', 'name':'ESME_RINVDSTTON', 'description':'Invalid destination address TON'},
'00000051':{'hex':'00000051', 'name':'ESME_RINVDSTNPI', 'description':'Invalid destination address NPI'},
'00000053':{'hex':'00000053', 'name':'ESME_RINVSYSTYP', 'description':'Invalid system_type field'},
'00000054':{'hex':'00000054', 'name':'ESME_RINVREPFLAG', 'description':'Invalid replace_if_present flag'},
'00000055':{'hex':'00000055', 'name':'ESME_RINVNUMMSGS', 'description':'Invalid number of messages'},
'00000058':{'hex':'00000058', 'name':'ESME_RTHROTTLED', 'description':'Throttling error (ESME has exceeded allowed message limits)'},
'00000061':{'hex':'00000061', 'name':'ESME_RINVSCHED', 'description':'Invalid scheduled delivery time'},
'00000062':{'hex':'00000062', 'name':'ESME_RINVEXPIRY', 'description':'Invalid message validity period (expiry time)'},
'00000063':{'hex':'00000063', 'name':'ESME_RINVDFTMSGID', 'description':'Predefined message invalid or not found'},
'00000064':{'hex':'00000064', 'name':'ESME_RX_T_APPN', 'description':'ESME Receiver Temporary App Error Code'},
'00000065':{'hex':'00000065', 'name':'ESME_RX_P_APPN', 'description':'ESME Receiver Permanent App Error Code'},
'00000066':{'hex':'00000066', 'name':'ESME_RX_R_APPN', 'description':'ESME Receiver Reject Message Error Code'},
'00000067':{'hex':'00000067', 'name':'ESME_RQUERYFAIL', 'description':'query_sm request failed'},
'000000c0':{'hex':'000000c0', 'name':'ESME_RINVOPTPARSTREAM', 'description':'Error in the optional part of the PDU Body'},
'000000c1':{'hex':'000000c1', 'name':'ESME_ROPTPARNOTALLWD', 'description':'Optional paramenter not allowed'},
'000000c2':{'hex':'000000c2', 'name':'ESME_RINVPARLEN', 'description':'Invalid parameter length'},
'000000c3':{'hex':'000000c3', 'name':'ESME_RMISSINGOPTPARAM', 'description':'Expected optional parameter missing'},
'000000c4':{'hex':'000000c4', 'name':'ESME_RINVOPTPARAMVAL', 'description':'Invalid optional parameter value'},
'000000fe':{'hex':'000000fe', 'name':'ESME_RDELIVERYFAILURE', 'description':'Delivery Failure (used for data_sm_resp)'},
'000000ff':{'hex':'000000ff', 'name':'ESME_RUNKNOWNERR', 'description':'Unknown error'}
}
def command_status_name_by_hex(x):
return command_status_by_hex.get(x,{}).get('name')
command_status_by_name = {
'ESME_ROK' :{'hex':'00000000', 'name':'ESME_ROK', 'description':'No error'},
'ESME_RINVMSGLEN' :{'hex':'00000001', 'name':'ESME_RINVMSGLEN', 'description':'Message Length is invalid'},
'ESME_RINVCMDLEN' :{'hex':'00000002', 'name':'ESME_RINVCMDLEN', 'description':'Command Length is invalid'},
'ESME_RINVCMDID' :{'hex':'00000003', 'name':'ESME_RINVCMDID', 'description':'Invalid Command ID'},
'ESME_RINVBNDSTS' :{'hex':'00000004', 'name':'ESME_RINVBNDSTS', 'description':'Incorrect BIND Status for given command'},
'ESME_RALYBND' :{'hex':'00000005', 'name':'ESME_RALYBND', 'description':'ESME Already in bound state'},
'ESME_RINVPRTFLG' :{'hex':'00000006', 'name':'ESME_RINVPRTFLG', 'description':'Invalid priority flag'},
'ESME_RINVREGDLVFLG' :{'hex':'00000007', 'name':'ESME_RINVREGDLVFLG', 'description':'Invalid registered delivery flag'},
'ESME_RSYSERR' :{'hex':'00000008', 'name':'ESME_RSYSERR', 'description':'System Error'},
'ESME_RINVSRCADR' :{'hex':'0000000a', 'name':'ESME_RINVSRCADR', 'description':'Invalid source address'},
'ESME_RINVDSTADR' :{'hex':'0000000b', 'name':'ESME_RINVDSTADR', 'description':'Invalid destination address'},
'ESME_RINVMSGID' :{'hex':'0000000c', 'name':'ESME_RINVMSGID', 'description':'Message ID is invalid'},
'ESME_RBINDFAIL' :{'hex':'0000000d', 'name':'ESME_RBINDFAIL', 'description':'Bind failed'},
'ESME_RINVPASWD' :{'hex':'0000000e', 'name':'ESME_RINVPASWD', 'description':'Invalid password'},
'ESME_RINVSYSID' :{'hex':'0000000f', 'name':'ESME_RINVSYSID', 'description':'Invalid System ID'},
'ESME_RCANCELFAIL' :{'hex':'00000011', 'name':'ESME_RCANCELFAIL', 'description':'Cancel SM Failed'},
'ESME_RREPLACEFAIL' :{'hex':'00000013', 'name':'ESME_RREPLACEFAIL', 'description':'Replace SM Failed'},
'ESME_RMSGQFUL' :{'hex':'00000014', 'name':'ESME_RMSGQFUL', 'description':'Message queue full'},
'ESME_RINVSERTYP' :{'hex':'00000015', 'name':'ESME_RINVSERTYP', 'description':'Invalid service type'},
'ESME_RINVNUMDESTS' :{'hex':'00000033', 'name':'ESME_RINVNUMDESTS', 'description':'Invalid number of destinations'},
'ESME_RINVDLNAME' :{'hex':'00000034', 'name':'ESME_RINVDLNAME', 'description':'Invalid distribution list name'},
'ESME_RINVDESTFLAG' :{'hex':'00000040', 'name':'ESME_RINVDESTFLAG', 'description':'Destination flag is invalid (submit_multi)'},
'ESME_RINVSUBREP' :{'hex':'00000042', 'name':'ESME_RINVSUBREP', 'description':"Invalid `submit with replace' request (i.e. submit_sm with replace_if_present_flag set)"},
'ESME_RINVESMCLASS' :{'hex':'00000043', 'name':'ESME_RINVESMCLASS', 'description':'Invalid esm_class field data'},
'ESME_RCNTSUBDL' :{'hex':'00000044', 'name':'ESME_RCNTSUBDL', 'description':'Cannot submit to distribution list'},
'ESME_RSUBMITFAIL' :{'hex':'00000045', 'name':'ESME_RSUBMITFAIL', 'description':'submit_sm or submit_multi failed'},
'ESME_RINVSRCTON' :{'hex':'00000048', 'name':'ESME_RINVSRCTON', 'description':'Invalid source address TON'},
'ESME_RINVSRCNPI' :{'hex':'00000049', 'name':'ESME_RINVSRCNPI', 'description':'Invalid source address NPI'},
'ESME_RINVDSTTON' :{'hex':'00000050', 'name':'ESME_RINVDSTTON', 'description':'Invalid destination address TON'},
'ESME_RINVDSTNPI' :{'hex':'00000051', 'name':'ESME_RINVDSTNPI', 'description':'Invalid destination address NPI'},
'ESME_RINVSYSTYP' :{'hex':'00000053', 'name':'ESME_RINVSYSTYP', 'description':'Invalid system_type field'},
'ESME_RINVREPFLAG' :{'hex':'00000054', 'name':'ESME_RINVREPFLAG', 'description':'Invalid replace_if_present flag'},
'ESME_RINVNUMMSGS' :{'hex':'00000055', 'name':'ESME_RINVNUMMSGS', 'description':'Invalid number of messages'},
'ESME_RTHROTTLED' :{'hex':'00000058', 'name':'ESME_RTHROTTLED', 'description':'Throttling error (ESME has exceeded allowed message limits)'},
'ESME_RINVSCHED' :{'hex':'00000061', 'name':'ESME_RINVSCHED', 'description':'Invalid scheduled delivery time'},
'ESME_RINVEXPIRY' :{'hex':'00000062', 'name':'ESME_RINVEXPIRY', 'description':'Invalid message validity period (expiry time)'},
'ESME_RINVDFTMSGID' :{'hex':'00000063', 'name':'ESME_RINVDFTMSGID', 'description':'Predefined message invalid or not found'},
'ESME_RX_T_APPN' :{'hex':'00000064', 'name':'ESME_RX_T_APPN', 'description':'ESME Receiver Temporary App Error Code'},
'ESME_RX_P_APPN' :{'hex':'00000065', 'name':'ESME_RX_P_APPN', 'description':'ESME Receiver Permanent App Error Code'},
'ESME_RX_R_APPN' :{'hex':'00000066', 'name':'ESME_RX_R_APPN', 'description':'ESME Receiver Reject Message Error Code'},
'ESME_RQUERYFAIL' :{'hex':'00000067', 'name':'ESME_RQUERYFAIL', 'description':'query_sm request failed'},
'ESME_RINVOPTPARSTREAM':{'hex':'000000c0', 'name':'ESME_RINVOPTPARSTREAM', 'description':'Error in the optional part of the PDU Body'},
'ESME_ROPTPARNOTALLWD' :{'hex':'000000c1', 'name':'ESME_ROPTPARNOTALLWD', 'description':'Optional paramenter not allowed'},
'ESME_RINVPARLEN' :{'hex':'000000c2', 'name':'ESME_RINVPARLEN', 'description':'Invalid parameter length'},
'ESME_RMISSINGOPTPARAM':{'hex':'000000c3', 'name':'ESME_RMISSINGOPTPARAM', 'description':'Expected optional parameter missing'},
'ESME_RINVOPTPARAMVAL' :{'hex':'000000c4', 'name':'ESME_RINVOPTPARAMVAL', 'description':'Invalid optional parameter value'},
'ESME_RDELIVERYFAILURE':{'hex':'000000fe', 'name':'ESME_RDELIVERYFAILURE', 'description':'Delivery Failure (used for data_sm_resp)'},
'ESME_RUNKNOWNERR' :{'hex':'000000ff', 'name':'ESME_RUNKNOWNERR', 'description':'Unknown error'}
}
def command_status_hex_by_name(n):
return command_status_by_name.get(n,{}).get('hex')
# Type of Number (TON) - SMPP v3.4, section 5.2.5, table 5-3, page 117
maps['addr_ton_by_name'] = {
'' :'00',
'unknown' :'00',
'international' :'01',
'national' :'02',
'network_specific' :'03',
'subscriber_number':'04',
'alphanumeric' :'05',
'abbreviated' :'06'
}
maps['addr_ton_by_hex'] = {
'00':'unknown',
'01':'international',
'02':'national',
'03':'network_specific',
'04':'subscriber_number',
'05':'alphanumeric',
'06':'abbreviated'
}
# Numberic Plan Indicator (NPI) - SMPP v3.4, section 5.2.6, table 5-4, page 118
maps['addr_npi_by_name'] = {
'' :'00',
'unknown' :'00',
'ISDN' :'01',
'data' :'03',
'telex' :'04',
'land_mobile':'06',
'national' :'08',
'private' :'09',
'ERMES' :'0a',
'internet' :'0e',
'WAP' :'12'
}
maps['addr_npi_by_hex'] = {
'00':'unknown',
'01':'ISDN',
'03':'data',
'04':'telex',
'06':'land_mobile',
'08':'national',
'09':'private',
'0a':'ERMES',
'0e':'internet',
'12':'WAP'
}
# ESM Class bits - SMPP v3.4, section 5.2.12, page 121
maps['esm_class_bits'] = {
'mode_mask' :'03',
'type_mask' :'3c',
'feature_mask' :'c0',
'mode_default' :'00',
'mode_datagram' :'01',
'mode_forward' :'02',
'mode_store_and_forward' :'03',
'type_default' :'00',
'type_delivery_receipt' :'04',
'type_delivery_ack' :'08',
'type_0011' :'0a',
'type_user_ack' :'10',
'type_0101' :'14',
'type_conversation_abort' :'18',
'type_0111' :'1a',
'type_intermed_deliv_notif' :'20',
'type_1001' :'24',
'type_1010' :'28',
'type_1011' :'2a',
'type_1100' :'30',
'type_1101' :'34',
'type_1110' :'38',
'type_1111' :'3a',
'feature_none' :'00',
'feature_UDHI' :'40',
'feature_reply_path' :'80',
'feature_UDHI_and_reply_path':'c0'
}
# Registered Delivery bits - SMPP v3.4, section 5.2.17, page 124
maps['registered_delivery_bits'] = {
'receipt_mask' :'03',
'ack_mask' :'0c',
'intermed_notif_mask' :'80',
'receipt_none' :'00',
'receipt_always' :'01',
'receipt_on_fail' :'02',
'receipt_res' :'03',
'ack_none' :'00',
'ack_delivery' :'04',
'ack_user' :'08',
'ack_delivery_and_user':'0c',
'intermed_notif_none' :'00',
'intermed_notif' :'10'
}
# submit_multi dest_flag constants - SMPP v3.4, section 5.2.25, page 129
#maps['dest_flag_by_name'] = {
#'SME Address' :1,
#'Distribution List Name':2
#}
# Message State codes returned in query_sm_resp PDUs - SMPP v3.4, section 5.2.28, table 5-6, page 130
maps['message_state_by_name'] = {
'ENROUTE' :1,
'DELIVERED' :2,
'EXPIRED' :3,
'DELETED' :4,
'UNDELIVERABLE':5,
'ACCEPTED' :6,
'UNKNOWN' :7,
'REJECTED' :8
}
# Facility Code bits for SMPP v4
maps['facility_code_bits'] = {
'GF_PVCY' :'00000001',
'GF_SUBADDR':'00000002',
'NF_CC' :'00080000',
'NF_PDC' :'00010000',
'NF_IS136' :'00020000',
'NF_IS95A' :'00040000'
}
# Optional Parameter Tags - SMPP v3.4, section 5.3.2, Table 5-7, page 132-133
optional_parameter_tag_by_hex = {
'0005':{'hex':'0005', 'name':'dest_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.1, page 134
'0006':{'hex':'0006', 'name':'dest_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.3, page 135
'0007':{'hex':'0007', 'name':'dest_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.5, page 136
'0008':{'hex':'0008', 'name':'dest_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.7, page 137
'000d':{'hex':'000d', 'name':'source_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.2, page 134
'000e':{'hex':'000e', 'name':'source_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.4, page 135
'000f':{'hex':'000f', 'name':'source_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.6, page 136
'0010':{'hex':'0010', 'name':'source_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.8, page 137
'0017':{'hex':'0017', 'name':'qos_time_to_live', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.9, page 138
'0019':{'hex':'0019', 'name':'payload_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.10, page 138
'001d':{'hex':'001d', 'name':'additional_status_info_text', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.11, page 139
'001e':{'hex':'001e', 'name':'receipted_message_id', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.12, page 139
'0030':{'hex':'0030', 'name':'ms_msg_wait_facilities', 'type':'bitmask', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.13, page 140
'0101':{'hex':'0101', 'name':'PVCY_AuthenticationStr', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 58-62
'0201':{'hex':'0201', 'name':'privacy_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.14, page 141
'0202':{'hex':'0202', 'name':'source_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.15, page 142
'0203':{'hex':'0203', 'name':'dest_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.16, page 143
'0204':{'hex':'0204', 'name':'user_message_reference', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.17, page 143
'0205':{'hex':'0205', 'name':'user_response_code', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.18, page 144
'020a':{'hex':'020a', 'name':'source_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.20, page 145
'020b':{'hex':'020b', 'name':'destination_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.21, page 145
'020c':{'hex':'020c', 'name':'sar_msg_ref_num', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.22, page 146
'020d':{'hex':'020d', 'name':'language_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.19, page 144
'020e':{'hex':'020e', 'name':'sar_total_segments', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.23, page 147
'020f':{'hex':'020f', 'name':'sar_segment_seqnum', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.24, page 147
'0210':{'hex':'0210', 'name':'sc_interface_version', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.25, page 148
'0301':{'hex':'0301', 'name':'CC_CBN', 'type':None, 'tech':'V4'}, # v4 page 70
'0302':{'hex':'0302', 'name':'callback_num_pres_ind', 'type':'bitmask', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.37, page 156
'0303':{'hex':'0303', 'name':'callback_num_atag', 'type':'hex', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.38, page 157
'0304':{'hex':'0304', 'name':'number_of_messages', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.39, page 158
'0381':{'hex':'0381', 'name':'callback_num', 'type':'hex', 'tech':'CDMA, TDMA, GSM, iDEN'}, # SMPP v3.4, section 5.3.2.36, page 155
'0420':{'hex':'0420', 'name':'dpf_result', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.28, page 149
'0421':{'hex':'0421', 'name':'set_dpf', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.29, page 150
'0422':{'hex':'0422', 'name':'ms_availability_status', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.30, page 151
'0423':{'hex':'0423', 'name':'network_error_code', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.31, page 152
'0424':{'hex':'0424', 'name':'message_payload', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.32, page 153
'0425':{'hex':'0425', 'name':'delivery_failure_reason', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.33, page 153
'0426':{'hex':'0426', 'name':'more_messages_to_send', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.34, page 154
'0427':{'hex':'0427', 'name':'message_state', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.35, page 154
'0428':{'hex':'0428', 'name':'congestion_state', 'type':None, 'tech':'Generic'},
'0501':{'hex':'0501', 'name':'ussd_service_op', 'type':'hex', 'tech':'GSM (USSD)'}, # SMPP v3.4, section 5.3.2.44, page 161
'0600':{'hex':'0600', 'name':'broadcast_channel_indicator', 'type':None, 'tech':'GSM'},
'0601':{'hex':'0601', 'name':'broadcast_content_type', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'0602':{'hex':'0602', 'name':'broadcast_content_type_info', 'type':None, 'tech':'CDMA, TDMA'},
'0603':{'hex':'0603', 'name':'broadcast_message_class', 'type':None, 'tech':'GSM'},
'0604':{'hex':'0604', 'name':'broadcast_rep_num', 'type':None, 'tech':'GSM'},
'0605':{'hex':'0605', 'name':'broadcast_frequency_interval', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'0606':{'hex':'0606', 'name':'broadcast_area_identifier', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'0607':{'hex':'0607', 'name':'broadcast_error_status', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'0608':{'hex':'0608', 'name':'broadcast_area_success', 'type':None, 'tech':'GSM'},
'0609':{'hex':'0609', 'name':'broadcast_end_time', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'060a':{'hex':'060a', 'name':'broadcast_service_group', 'type':None, 'tech':'CDMA, TDMA'},
'060b':{'hex':'060b', 'name':'billing_identification', 'type':None, 'tech':'Generic'},
'060d':{'hex':'060d', 'name':'source_network_id', 'type':None, 'tech':'Generic'},
'060e':{'hex':'060e', 'name':'dest_network_id', 'type':None, 'tech':'Generic'},
'060f':{'hex':'060f', 'name':'source_node_id', 'type':None, 'tech':'Generic'},
'0610':{'hex':'0610', 'name':'dest_node_id', 'type':None, 'tech':'Generic'},
'0611':{'hex':'0611', 'name':'dest_addr_np_resolution', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'0612':{'hex':'0612', 'name':'dest_addr_np_information', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'0613':{'hex':'0613', 'name':'dest_addr_np_country', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'1101':{'hex':'1101', 'name':'PDC_MessageClass', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 75
'1102':{'hex':'1102', 'name':'PDC_PresentationOption', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
'1103':{'hex':'1103', 'name':'PDC_AlertMechanism', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
'1104':{'hex':'1104', 'name':'PDC_Teleservice', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
'1105':{'hex':'1105', 'name':'PDC_MultiPartMessage', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
'1106':{'hex':'1106', 'name':'PDC_PredefinedMsg', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 78
'1201':{'hex':'1201', 'name':'display_time', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.26, page 148
'1203':{'hex':'1203', 'name':'sms_signal', 'type':'integer', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.40, page 158
'1204':{'hex':'1204', 'name':'ms_validity', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.27, page 149
'1304':{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'type':None, 'tech':'CDMA'}, # v4 page 85
'1306':{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'type':None, 'tech':'CDMA'}, # v4 page 86
'130c':{'hex':'130c', 'name':'alert_on_message_delivery', 'type':None, 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.41, page 159
'1380':{'hex':'1380', 'name':'its_reply_type', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.42, page 159
'1383':{'hex':'1383', 'name':'its_session_info', 'type':'hex', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.43, page 160
'1402':{'hex':'1402', 'name':'operator_id', 'type':None, 'tech':'vendor extension'},
'1403':{'hex':'1403', 'name':'tariff', 'type':None, 'tech':'Mobile Network Code vendor extension'},
'1450':{'hex':'1450', 'name':'mcc', 'type':None, 'tech':'Mobile Country Code vendor extension'},
'1451':{'hex':'1451', 'name':'mnc', 'type':None, 'tech':'Mobile Network Code vendor extension'}
}
def optional_parameter_tag_name_by_hex(x):
return optional_parameter_tag_by_hex.get(x,{}).get('name')
def optional_parameter_tag_type_by_hex(x):
return optional_parameter_tag_by_hex.get(x,{}).get('type')
optional_parameter_tag_by_name = {
'dest_addr_subunit' :{'hex':'0005', 'name':'dest_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.1, page 134
'dest_network_type' :{'hex':'0006', 'name':'dest_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.3, page 135
'dest_bearer_type' :{'hex':'0007', 'name':'dest_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.5, page 136
'dest_telematics_id' :{'hex':'0008', 'name':'dest_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.7, page 137
'source_addr_subunit' :{'hex':'000d', 'name':'source_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.2, page 134
'source_network_type' :{'hex':'000e', 'name':'source_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.4, page 135
'source_bearer_type' :{'hex':'000f', 'name':'source_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.6, page 136
'source_telematics_id' :{'hex':'0010', 'name':'source_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.8, page 137
'qos_time_to_live' :{'hex':'0017', 'name':'qos_time_to_live', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.9, page 138
'payload_type' :{'hex':'0019', 'name':'payload_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.10, page 138
'additional_status_info_text' :{'hex':'001d', 'name':'additional_status_info_text', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.11, page 139
'receipted_message_id' :{'hex':'001e', 'name':'receipted_message_id', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.12, page 139
'ms_msg_wait_facilities' :{'hex':'0030', 'name':'ms_msg_wait_facilities', 'type':'bitmask', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.13, page 140
'PVCY_AuthenticationStr' :{'hex':'0101', 'name':'PVCY_AuthenticationStr', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 58-62
'privacy_indicator' :{'hex':'0201', 'name':'privacy_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.14, page 141
'source_subaddress' :{'hex':'0202', 'name':'source_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.15, page 142
'dest_subaddress' :{'hex':'0203', 'name':'dest_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.16, page 143
'user_message_reference' :{'hex':'0204', 'name':'user_message_reference', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.17, page 143
'user_response_code' :{'hex':'0205', 'name':'user_response_code', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.18, page 144
'source_port' :{'hex':'020a', 'name':'source_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.20, page 145
'destination_port' :{'hex':'020b', 'name':'destination_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.21, page 145
'sar_msg_ref_num' :{'hex':'020c', 'name':'sar_msg_ref_num', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.22, page 146
'language_indicator' :{'hex':'020d', 'name':'language_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.19, page 144
'sar_total_segments' :{'hex':'020e', 'name':'sar_total_segments', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.23, page 147
'sar_segment_seqnum' :{'hex':'020f', 'name':'sar_segment_seqnum', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.24, page 147
'sc_interface_version' :{'hex':'0210', 'name':'sc_interface_version', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.25, page 148
'CC_CBN' :{'hex':'0301', 'name':'CC_CBN', 'type':None, 'tech':'V4'}, # v4 page 70
'callback_num_pres_ind' :{'hex':'0302', 'name':'callback_num_pres_ind', 'type':'bitmask', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.37, page 156
'callback_num_atag' :{'hex':'0303', 'name':'callback_num_atag', 'type':'hex', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.38, page 157
'number_of_messages' :{'hex':'0304', 'name':'number_of_messages', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.39, page 158
'callback_num' :{'hex':'0381', 'name':'callback_num', 'type':'hex', 'tech':'CDMA, TDMA, GSM, iDEN'}, # SMPP v3.4, section 5.3.2.36, page 155
'dpf_result' :{'hex':'0420', 'name':'dpf_result', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.28, page 149
'set_dpf' :{'hex':'0421', 'name':'set_dpf', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.29, page 150
'ms_availability_status' :{'hex':'0422', 'name':'ms_availability_status', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.30, page 151
'network_error_code' :{'hex':'0423', 'name':'network_error_code', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.31, page 152
'message_payload' :{'hex':'0424', 'name':'message_payload', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.32, page 153
'delivery_failure_reason' :{'hex':'0425', 'name':'delivery_failure_reason', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.33, page 153
'more_messages_to_send' :{'hex':'0426', 'name':'more_messages_to_send', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.34, page 154
'message_state' :{'hex':'0427', 'name':'message_state', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.35, page 154
'congestion_state' :{'hex':'0428', 'name':'congestion_state', 'type':None, 'tech':'Generic'},
'ussd_service_op' :{'hex':'0501', 'name':'ussd_service_op', 'type':'hex', 'tech':'GSM (USSD)'}, # SMPP v3.4, section 5.3.2.44, page 161
'broadcast_channel_indicator' :{'hex':'0600', 'name':'broadcast_channel_indicator', 'type':None, 'tech':'GSM'},
'broadcast_content_type' :{'hex':'0601', 'name':'broadcast_content_type', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_content_type_info' :{'hex':'0602', 'name':'broadcast_content_type_info', 'type':None, 'tech':'CDMA, TDMA'},
'broadcast_message_class' :{'hex':'0603', 'name':'broadcast_message_class', 'type':None, 'tech':'GSM'},
'broadcast_rep_num' :{'hex':'0604', 'name':'broadcast_rep_num', 'type':None, 'tech':'GSM'},
'broadcast_frequency_interval':{'hex':'0605', 'name':'broadcast_frequency_interval', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_area_identifier' :{'hex':'0606', 'name':'broadcast_area_identifier', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_error_status' :{'hex':'0607', 'name':'broadcast_error_status', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_area_success' :{'hex':'0608', 'name':'broadcast_area_success', 'type':None, 'tech':'GSM'},
'broadcast_end_time' :{'hex':'0609', 'name':'broadcast_end_time', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_service_group' :{'hex':'060a', 'name':'broadcast_service_group', 'type':None, 'tech':'CDMA, TDMA'},
'billing_identification' :{'hex':'060b', 'name':'billing_identification', 'type':None, 'tech':'Generic'},
'source_network_id' :{'hex':'060d', 'name':'source_network_id', 'type':None, 'tech':'Generic'},
'dest_network_id' :{'hex':'060e', 'name':'dest_network_id', 'type':None, 'tech':'Generic'},
'source_node_id' :{'hex':'060f', 'name':'source_node_id', 'type':None, 'tech':'Generic'},
'dest_node_id' :{'hex':'0610', 'name':'dest_node_id', 'type':None, 'tech':'Generic'},
'dest_addr_np_resolution' :{'hex':'0611', 'name':'dest_addr_np_resolution', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'dest_addr_np_information' :{'hex':'0612', 'name':'dest_addr_np_information', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'dest_addr_np_country' :{'hex':'0613', 'name':'dest_addr_np_country', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'PDC_MessageClass' :{'hex':'1101', 'name':'PDC_MessageClass', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 75
'PDC_PresentationOption' :{'hex':'1102', 'name':'PDC_PresentationOption', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
'PDC_AlertMechanism' :{'hex':'1103', 'name':'PDC_AlertMechanism', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
'PDC_Teleservice' :{'hex':'1104', 'name':'PDC_Teleservice', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
'PDC_MultiPartMessage' :{'hex':'1105', 'name':'PDC_MultiPartMessage', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
'PDC_PredefinedMsg' :{'hex':'1106', 'name':'PDC_PredefinedMsg', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 78
'display_time' :{'hex':'1201', 'name':'display_time', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.26, page 148
'sms_signal' :{'hex':'1203', 'name':'sms_signal', 'type':'integer', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.40, page 158
'ms_validity' :{'hex':'1204', 'name':'ms_validity', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.27, page 149
'IS95A_AlertOnDelivery' :{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'type':None, 'tech':'CDMA'}, # v4 page 85
'IS95A_LanguageIndicator' :{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'type':None, 'tech':'CDMA'}, # v4 page 86
'alert_on_message_delivery' :{'hex':'130c', 'name':'alert_on_message_delivery', 'type':None, 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.41, page 159
'its_reply_type' :{'hex':'1380', 'name':'its_reply_type', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.42, page 159
'its_session_info' :{'hex':'1383', 'name':'its_session_info', 'type':'hex', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.43, page 160
'operator_id' :{'hex':'1402', 'name':'operator_id', 'type':None, 'tech':'vendor extension'},
'tariff' :{'hex':'1403', 'name':'tariff', 'type':None, 'tech':'Mobile Network Code vendor extension'},
'mcc' :{'hex':'1450', 'name':'mcc', 'type':None, 'tech':'Mobile Country Code vendor extension'},
'mnc' :{'hex':'1451', 'name':'mnc', 'type':None, 'tech':'Mobile Network Code vendor extension'}
}
def optional_parameter_tag_hex_by_name(n):
return optional_parameter_tag_by_name.get(n,{}).get('hex')
#### Decoding functions #######################################################
def unpack_pdu(pdu_bin):
return decode_pdu(binascii.b2a_hex(pdu_bin))
def decode_pdu(pdu_hex):
hex_ref = [pdu_hex]
pdu = {}
pdu['header'] = decode_header(hex_ref)
command = pdu['header'].get('command_id', None)
if command != None:
body = decode_body(command, hex_ref)
if len(body) > 0:
pdu['body'] = body
return pdu
def decode_header(hex_ref):
pdu_hex = hex_ref[0]
header = {}
(command_length, command_id, command_status, sequence_number, hex_ref[0]) = \
(pdu_hex[0:8], pdu_hex[8:16], pdu_hex[16:24], pdu_hex[24:32], pdu_hex[32: ])
length = int(command_length, 16)
command = command_id_name_by_hex(command_id)
status = command_status_name_by_hex(command_status)
sequence = int(sequence_number, 16)
header = {}
header['command_length'] = length
header['command_id'] = command
header['command_status'] = status
header['sequence_number'] = sequence
return header
def decode_body(command, hex_ref):
body = {}
if command != None:
fields = mandatory_parameter_list_by_command_name(command)
mandatory = decode_mandatory_parameters(fields, hex_ref)
if len(mandatory) > 0:
body['mandatory_parameters'] = mandatory
optional = decode_optional_parameters(hex_ref)
if len(optional) > 0:
body['optional_parameters'] = optional
return body
def decode_mandatory_parameters(fields, hex_ref):
mandatory_parameters = {}
if len(hex_ref[0]) > 1:
for field in fields:
old = len(hex_ref[0])
data = ''
octet = ''
count = 0
if field['var'] == True or field['var'] == False:
while (len(hex_ref[0]) > 1
and (count < field['min']
or (count < field['max']
and octet != '00'))):
octet = octpop(hex_ref)
data += octet
count += 1
elif field['type'] == 'string':
count = mandatory_parameters[field['var']]
for i in range(count):
if len(hex_ref[0]) > 1:
data += octpop(hex_ref)
else:
count = mandatory_parameters[field['var']]
if field['map'] != None:
- print field, data
+ #print field, data
mandatory_parameters[field['name']] = maps.get(field['map']+'_by_hex',{data:data})[data]
else:
mandatory_parameters[field['name']] = decode_hex_type(data, field['type'], count, hex_ref)
- print field['type'], (old - len(hex_ref[0]))/2, repr(data), field['name'], mandatory_parameters[field['name']]
+ #print field['type'], (old - len(hex_ref[0]))/2, repr(data), field['name'], mandatory_parameters[field['name']]
return mandatory_parameters
def decode_optional_parameters(hex_ref):
optional_parameters = []
hex = hex_ref[0]
while len(hex) > 0:
(tag_hex, length_hex, rest) = (hex[0:4], hex[4:8], hex[8: ])
tag = optional_parameter_tag_name_by_hex(tag_hex)
if tag == None:
tag = tag_hex
length = int(length_hex, 16)
(value_hex, tail) = (rest[0:length*2], rest[length*2: ])
if len(value_hex) == 0:
value = None
else:
value = decode_hex_type(value_hex, optional_parameter_tag_type_by_hex(tag_hex))
hex = tail
optional_parameters.append({'tag':tag, 'length':length, 'value':value})
return optional_parameters
def decode_hex_type(hex, type, count=0, hex_ref=['']):
if type == 'integer':
return int(hex, 16)
elif type == 'string':
return binascii.b2a_qp(binascii.a2b_hex(re.sub('00','',hex)))
elif (type == 'dest_address'
or type == 'unsuccess_sme'):
list = []
fields = mandatory_parameter_list_by_command_name(type)
for i in range(count):
item = decode_mandatory_parameters(fields, hex_ref)
if item.get('dest_flag', None) == 1: # 'dest_address' only
subfields = mandatory_parameter_list_by_command_name('sme_dest_address')
rest = decode_mandatory_parameters(subfields, hex_ref)
item.update(rest)
elif item.get('dest_flag', None) == 2: # 'dest_address' only
subfields = mandatory_parameter_list_by_command_name('distribution_list')
rest = decode_mandatory_parameters(subfields, hex_ref)
item.update(rest)
list.append(item)
return list
else:
return hex
def octpop(hex_ref):
octet = None
if len(hex_ref[0]) > 1:
(octet, hex_ref[0]) = (hex_ref[0][0:2], hex_ref[0][2: ])
return octet
#### Encoding functions #######################################################
def pack_pdu(pdu_obj):
return binascii.a2b_hex(encode_pdu(pdu_obj))
def encode_pdu(pdu_obj):
header = pdu_obj.get('header', {})
body = pdu_obj.get('body', {})
mandatory = body.get('mandatory_parameters', {})
optional = body.get('optional_parameters', [])
body_hex = ''
fields = mandatory_parameter_list_by_command_name(header['command_id'])
body_hex += encode_mandatory_parameters(mandatory, fields)
for opt in optional:
body_hex += encode_optional_parameter(opt['tag'], opt['value'])
actual_length = 16 + len(body_hex)/2
command_length = '%08x' % actual_length
command_id = command_id_hex_by_name(header['command_id'])
command_status = command_status_hex_by_name(header['command_status'])
sequence_number = '%08x' % header['sequence_number']
pdu_hex = command_length + command_id + command_status + sequence_number + body_hex
return pdu_hex
def encode_mandatory_parameters(mandatory_obj, fields):
mandatory_hex = ''
for field in fields:
param = mandatory_obj[field['name']]
mandatory_hex += encode_param_type(param, field['type'], field['min'], field['max'])
return mandatory_hex
def encode_optional_parameter(tag, value):
optional_hex = ''
tag_hex = optional_parameter_tag_hex_by_name(tag)
if tag_hex != None:
value_hex = '%02x' % value #TODO need encoding mapping
length_hex = '%04x' % (len(value_hex)/2)
optional_hex = tag_hex + length_hex + value_hex
return optional_hex
def encode_param_type(param, type, min=0, max=None):
if type == 'integer':
return '%02x' % int(param)
elif type == 'string':
hex = binascii.b2a_hex(binascii.a2b_qp(str(param))) + '00'
- print 'xxx', hex
+ #print 'xxx', hex
return hex
else:
return '00'
|
dmaclay/python-smpp
|
bfbcd8e38438f3ed20d589046c4e404385ffcd70
|
can encode bind
|
diff --git a/smpp/pdu.py b/smpp/pdu.py
index 0f2e503..eac188d 100644
--- a/smpp/pdu.py
+++ b/smpp/pdu.py
@@ -1,967 +1,987 @@
import binascii
import re
try:
import json
except:
import simplejson as json
maps = {} # Inserting certain referenced dicts in here means they can be declared in the same order as in the spec.
# SMPP PDU Definition - SMPP v3.4, section 4, page 45
mandatory_parameter_lists = {
'bind_transmitter':[ # SMPP v3.4, section 4.1.1, table 4-1, page 46
{'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None},
{'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'map':None},
{'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'map':None},
{'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'string', 'map':None},
{'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'map':None}
],
'bind_transmitter_resp':[ # SMPP v3.4, section 4.1.2, table 4-2, page 47
{'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None}
],
'bind_receiver':[ # SMPP v3.4, section 4.1.3, table 4-3, page 48
{'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None},
{'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'map':None},
{'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'map':None},
{'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'string', 'map':None},
{'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'map':None}
],
'bind_receiver_resp':[ # SMPP v3.4, section 4.1.4, table 4-4, page 50
{'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None}
],
'bind_transceiver':[ # SMPP v3.4, section 4.1.5, table 4-5, page 51
{'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None},
{'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'map':None},
{'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'map':None},
{'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'string', 'map':None},
{'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'map':None}
],
'bind_transceiver_resp':[ # SMPP v3.4, section 4.1.6, table 4-6, page 52
{'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None}
],
'outbind':[ # SMPP v3.4, section 4.1.7.1, page 54
{'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None},
{'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'map':None}
],
'unbind':[ # SMPP v3.4, section 4.2.1, table 4-7, page 56
],
'unbind_resp':[ # SMPP v3.4, section 4.2.2, table 4-8, page 56
],
'generic_nack':[ # SMPP v3.4, section 4.3.1, table 4-9, page 57
],
'submit_sm':[ # SMPP v3.4, section 4.4.1, table 4-10, page 59-61
{'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
{'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
{'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'map':None}
],
'submit_sm_resp':[ # SMPP v3.4, section 4.4.2, table 4-11, page 67
{'name':'message_id', 'min':0, 'max':65, 'var':True, 'type':'string', 'map':None}
],
'submit_multi':[ # SMPP v3.4, section 4.5.1, table 4-12, page 69-71
{'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'number_of_dests', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'dest_address', 'min':0, 'max':0, 'var':'number_of_dests', 'type':'dest_address', 'map':None},
{'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
{'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
{'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'map':None}
],
'dest_address':[ # SMPP v3.4, section 4.5.1.1, table 4-13, page 75
{'name':'dest_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None}
# 'sme_dest_address' or 'distribution_list' goes here
],
'sme_dest_address':[ # SMPP v3.4, section 4.5.1.1, table 4-14, page 75
{'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None}
],
'distribution_list':[ # SMPP v3.4, section 4.5.1.2, table 4-15, page 75
{'name':'dl_name', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None}
],
'submit_multi_resp':[ # SMPP v3.4, section 4.5.2, table 4-16, page 76
{'name':'message_id', 'min':0, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'no_unsuccess', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'unsuccess_sme', 'min':0, 'max':0, 'var':'no_unsuccess', 'type':'unsuccess_sme', 'map':None}
],
'unsuccess_sme':[ # SMPP v3.4, section 4.5.2.1, table 4-17, page 77
{'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'error_status_code', 'min':4, 'max':4, 'var':False, 'type':'integer', 'map':None}
],
'deliver_sm':[ # SMPP v3.4, section 4.6.1, table 4-18, page 79-81
{'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'schedule_delivery_time', 'min':1, 'max':1, 'var':False, 'type':'string', 'map':None},
{'name':'validity_period', 'min':1, 'max':1, 'var':False, 'type':'string', 'map':None},
{'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'map':None}
],
'deliver_sm_resp':[ # SMPP v3.4, section 4.6.2, table 4-19, page 85
{'name':'message_id', 'min':1, 'max':1, 'var':False, 'type':'string', 'map':None}
],
'data_sm':[ # SMPP v3.4, section 4.7.1, table 4-20, page 87-88
{'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'destination_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None}
],
'data_sm_resp':[ # SMPP v3.4, section 4.7.2, table 4-21, page 93
{'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None}
],
'query_sm':[ # SMPP v3.4, section 4.8.1, table 4-22, page 95
{'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None}
],
'query_sm_resp':[ # SMPP v3.4, section 4.7.2, table 4-21, page 93
{'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'final_date', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
{'name':'message_state', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'error_code', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None}
],
'cancel_sm':[ # SMPP v3.4, section 4.9.1, table 4-24, page 98-99
{'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'map':None},
{'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None}
],
'cancel_sm_resp':[ # SMPP v3.4, section 4.9.2, table 4-25, page 100
],
'replace_sm':[ # SMPP v3.4, section 4.10.1, table 4-26, page 102-103
{'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
{'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
{'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'map':None}
],
'replace_sm_resp':[ # SMPP v3.4, section 4.10.2, table 4-27, page 104
],
'enquire_link':[ # SMPP v3.4, section 4.11.1, table 4-28, page 106
],
'enquire_link_resp':[ # SMPP v3.4, section 4.11.2, table 4-29, page 106
],
'alert_notification':[ # SMPP v3.4, section 4.12.1, table 4-30, page 108
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'esme_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'esme_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'esme_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
]
}
def mandatory_parameter_list_by_command_name(command_name):
return mandatory_parameter_lists.get(command_name,[])
# Command IDs - SMPP v3.4, section 5.1.2.1, table 5-1, page 110-111
command_id_by_hex = {
'80000000':{'hex':'80000000', 'name':'generic_nack'},
'00000001':{'hex':'00000001', 'name':'bind_receiver'},
'80000001':{'hex':'80000001', 'name':'bind_receiver_resp'},
'00000002':{'hex':'00000002', 'name':'bind_transmitter'},
'80000002':{'hex':'80000002', 'name':'bind_transmitter_resp'},
'00000003':{'hex':'00000003', 'name':'query_sm'},
'80000003':{'hex':'80000003', 'name':'query_sm_resp'},
'00000004':{'hex':'00000004', 'name':'submit_sm'},
'80000004':{'hex':'80000004', 'name':'submit_sm_resp'},
'00000005':{'hex':'00000005', 'name':'deliver_sm'},
'80000005':{'hex':'80000005', 'name':'deliver_sm_resp'},
'00000006':{'hex':'00000006', 'name':'unbind'},
'80000006':{'hex':'80000006', 'name':'unbind_resp'},
'00000007':{'hex':'00000007', 'name':'replace_sm'},
'80000007':{'hex':'80000007', 'name':'replace_sm_resp'},
'00000008':{'hex':'00000008', 'name':'cancel_sm'},
'80000008':{'hex':'80000008', 'name':'cancel_sm_resp'},
'00000009':{'hex':'00000009', 'name':'bind_transceiver'},
'80000009':{'hex':'80000009', 'name':'bind_transceiver_resp'},
'0000000b':{'hex':'0000000b', 'name':'outbind'},
'00000015':{'hex':'00000015', 'name':'enquire_link'},
'80000015':{'hex':'80000015', 'name':'enquire_link_resp'},
'00000021':{'hex':'00000021', 'name':'submit_multi'},
'80000021':{'hex':'80000021', 'name':'submit_multi_resp'},
'00000102':{'hex':'00000102', 'name':'alert_notification'},
'00000103':{'hex':'00000103', 'name':'data_sm'},
'80000103':{'hex':'80000103', 'name':'data_sm_resp'},
# v4 codes
'80010000':{'hex':'80010000', 'name':'generic_nack_v4'},
'00010001':{'hex':'00010001', 'name':'bind_receiver_v4'},
'80010001':{'hex':'80010001', 'name':'bind_receiver_resp_v4'},
'00010002':{'hex':'00010002', 'name':'bind_transmitter_v4'},
'80010002':{'hex':'80010002', 'name':'bind_transmitter_resp_v4'},
'00010003':{'hex':'00010003', 'name':'query_sm_v4'},
'80010003':{'hex':'80010003', 'name':'query_sm_resp_v4'},
'00010004':{'hex':'00010004', 'name':'submit_sm_v4'},
'80010004':{'hex':'80010004', 'name':'submit_sm_resp_v4'},
'00010005':{'hex':'00010005', 'name':'deliver_sm_v4'},
'80010005':{'hex':'80010005', 'name':'deliver_sm_resp_v4'},
'00010006':{'hex':'00010006', 'name':'unbind_v4'},
'80010006':{'hex':'80010006', 'name':'unbind_resp_v4'},
'00010007':{'hex':'00010007', 'name':'replace_sm_v4'},
'80010007':{'hex':'80010007', 'name':'replace_sm_resp_v4'},
'00010008':{'hex':'00010008', 'name':'cancel_sm_v4'},
'80010008':{'hex':'80010008', 'name':'cancel_sm_resp_v4'},
'00010009':{'hex':'00010009', 'name':'delivery_receipt_v4'},
'80010009':{'hex':'80010009', 'name':'delivery_receipt_resp_v4'},
'0001000a':{'hex':'0001000a', 'name':'enquire_link_v4'},
'8001000a':{'hex':'8001000a', 'name':'enquire_link_resp_v4'},
'0001000b':{'hex':'0001000b', 'name':'outbind_v4'},
}
def command_id_name_by_hex(x):
return command_id_by_hex.get(x,{}).get('name')
command_id_by_name = {
'generic_nack' :{'hex':'80000000', 'name':'generic_nack'},
'bind_receiver' :{'hex':'00000001', 'name':'bind_receiver'},
'bind_receiver_resp' :{'hex':'80000001', 'name':'bind_receiver_resp'},
'bind_transmitter' :{'hex':'00000002', 'name':'bind_transmitter'},
'bind_transmitter_resp' :{'hex':'80000002', 'name':'bind_transmitter_resp'},
'query_sm' :{'hex':'00000003', 'name':'query_sm'},
'query_sm_resp' :{'hex':'80000003', 'name':'query_sm_resp'},
'submit_sm' :{'hex':'00000004', 'name':'submit_sm'},
'submit_sm_resp' :{'hex':'80000004', 'name':'submit_sm_resp'},
'deliver_sm' :{'hex':'00000005', 'name':'deliver_sm'},
'deliver_sm_resp' :{'hex':'80000005', 'name':'deliver_sm_resp'},
'unbind' :{'hex':'00000006', 'name':'unbind'},
'unbind_resp' :{'hex':'80000006', 'name':'unbind_resp'},
'replace_sm' :{'hex':'00000007', 'name':'replace_sm'},
'replace_sm_resp' :{'hex':'80000007', 'name':'replace_sm_resp'},
'cancel_sm' :{'hex':'00000008', 'name':'cancel_sm'},
'cancel_sm_resp' :{'hex':'80000008', 'name':'cancel_sm_resp'},
'bind_transceiver' :{'hex':'00000009', 'name':'bind_transceiver'},
'bind_transceiver_resp' :{'hex':'80000009', 'name':'bind_transceiver_resp'},
'outbind' :{'hex':'0000000b', 'name':'outbind'},
'enquire_link' :{'hex':'00000015', 'name':'enquire_link'},
'enquire_link_resp' :{'hex':'80000015', 'name':'enquire_link_resp'},
'submit_multi' :{'hex':'00000021', 'name':'submit_multi'},
'submit_multi_resp' :{'hex':'80000021', 'name':'submit_multi_resp'},
'alert_notification' :{'hex':'00000102', 'name':'alert_notification'},
'data_sm' :{'hex':'00000103', 'name':'data_sm'},
'data_sm_resp' :{'hex':'80000103', 'name':'data_sm_resp'},
# v4 codes
'generic_nack_v4' :{'hex':'80010000', 'name':'generic_nack_v4'},
'bind_receiver_v4' :{'hex':'00010001', 'name':'bind_receiver_v4'},
'bind_receiver_resp_v4' :{'hex':'80010001', 'name':'bind_receiver_resp_v4'},
'bind_transmitter_v4' :{'hex':'00010002', 'name':'bind_transmitter_v4'},
'bind_transmitter_resp_v4':{'hex':'80010002', 'name':'bind_transmitter_resp_v4'},
'query_sm_v4' :{'hex':'00010003', 'name':'query_sm_v4'},
'query_sm_resp_v4' :{'hex':'80010003', 'name':'query_sm_resp_v4'},
'submit_sm_v4' :{'hex':'00010004', 'name':'submit_sm_v4'},
'submit_sm_resp_v4' :{'hex':'80010004', 'name':'submit_sm_resp_v4'},
'deliver_sm_v4' :{'hex':'00010005', 'name':'deliver_sm_v4'},
'deliver_sm_resp_v4' :{'hex':'80010005', 'name':'deliver_sm_resp_v4'},
'unbind_v4' :{'hex':'00010006', 'name':'unbind_v4'},
'unbind_resp_v4' :{'hex':'80010006', 'name':'unbind_resp_v4'},
'replace_sm_v4' :{'hex':'00010007', 'name':'replace_sm_v4'},
'replace_sm_resp_v4' :{'hex':'80010007', 'name':'replace_sm_resp_v4'},
'cancel_sm_v4' :{'hex':'00010008', 'name':'cancel_sm_v4'},
'cancel_sm_resp_v4' :{'hex':'80010008', 'name':'cancel_sm_resp_v4'},
'delivery_receipt_v4' :{'hex':'00010009', 'name':'delivery_receipt_v4'},
'delivery_receipt_resp_v4':{'hex':'80010009', 'name':'delivery_receipt_resp_v4'},
'enquire_link_v4' :{'hex':'0001000a', 'name':'enquire_link_v4'},
'enquire_link_resp_v4' :{'hex':'8001000a', 'name':'enquire_link_resp_v4'},
'outbind_v4' :{'hex':'0001000b', 'name':'outbind_v4'}
}
def command_id_hex_by_name(n):
return command_id_by_name.get(n,{}).get('hex')
# SMPP Error Codes (ESME) - SMPP v3.4, section 5.1.3, table 5-2, page 112-114
command_status_by_hex = {
'00000000':{'hex':'00000000', 'name':'ESME_ROK', 'description':'No error'},
'00000001':{'hex':'00000001', 'name':'ESME_RINVMSGLEN', 'description':'Message Length is invalid'},
'00000002':{'hex':'00000002', 'name':'ESME_RINVCMDLEN', 'description':'Command Length is invalid'},
'00000003':{'hex':'00000003', 'name':'ESME_RINVCMDID', 'description':'Invalid Command ID'},
'00000004':{'hex':'00000004', 'name':'ESME_RINVBNDSTS', 'description':'Incorrect BIND Status for given command'},
'00000005':{'hex':'00000005', 'name':'ESME_RALYBND', 'description':'ESME Already in bound state'},
'00000006':{'hex':'00000006', 'name':'ESME_RINVPRTFLG', 'description':'Invalid priority flag'},
'00000007':{'hex':'00000007', 'name':'ESME_RINVREGDLVFLG', 'description':'Invalid registered delivery flag'},
'00000008':{'hex':'00000008', 'name':'ESME_RSYSERR', 'description':'System Error'},
'0000000a':{'hex':'0000000a', 'name':'ESME_RINVSRCADR', 'description':'Invalid source address'},
'0000000b':{'hex':'0000000b', 'name':'ESME_RINVDSTADR', 'description':'Invalid destination address'},
'0000000c':{'hex':'0000000c', 'name':'ESME_RINVMSGID', 'description':'Message ID is invalid'},
'0000000d':{'hex':'0000000d', 'name':'ESME_RBINDFAIL', 'description':'Bind failed'},
'0000000e':{'hex':'0000000e', 'name':'ESME_RINVPASWD', 'description':'Invalid password'},
'0000000f':{'hex':'0000000f', 'name':'ESME_RINVSYSID', 'description':'Invalid System ID'},
'00000011':{'hex':'00000011', 'name':'ESME_RCANCELFAIL', 'description':'Cancel SM Failed'},
'00000013':{'hex':'00000013', 'name':'ESME_RREPLACEFAIL', 'description':'Replace SM Failed'},
'00000014':{'hex':'00000014', 'name':'ESME_RMSGQFUL', 'description':'Message queue full'},
'00000015':{'hex':'00000015', 'name':'ESME_RINVSERTYP', 'description':'Invalid service type'},
'00000033':{'hex':'00000033', 'name':'ESME_RINVNUMDESTS', 'description':'Invalid number of destinations'},
'00000034':{'hex':'00000034', 'name':'ESME_RINVDLNAME', 'description':'Invalid distribution list name'},
'00000040':{'hex':'00000040', 'name':'ESME_RINVDESTFLAG', 'description':'Destination flag is invalid (submit_multi)'},
'00000042':{'hex':'00000042', 'name':'ESME_RINVSUBREP', 'description':"Invalid `submit with replace' request (i.e. submit_sm with replace_if_present_flag set)"},
'00000043':{'hex':'00000043', 'name':'ESME_RINVESMCLASS', 'description':'Invalid esm_class field data'},
'00000044':{'hex':'00000044', 'name':'ESME_RCNTSUBDL', 'description':'Cannot submit to distribution list'},
'00000045':{'hex':'00000045', 'name':'ESME_RSUBMITFAIL', 'description':'submit_sm or submit_multi failed'},
'00000048':{'hex':'00000048', 'name':'ESME_RINVSRCTON', 'description':'Invalid source address TON'},
'00000049':{'hex':'00000049', 'name':'ESME_RINVSRCNPI', 'description':'Invalid source address NPI'},
'00000050':{'hex':'00000050', 'name':'ESME_RINVDSTTON', 'description':'Invalid destination address TON'},
'00000051':{'hex':'00000051', 'name':'ESME_RINVDSTNPI', 'description':'Invalid destination address NPI'},
'00000053':{'hex':'00000053', 'name':'ESME_RINVSYSTYP', 'description':'Invalid system_type field'},
'00000054':{'hex':'00000054', 'name':'ESME_RINVREPFLAG', 'description':'Invalid replace_if_present flag'},
'00000055':{'hex':'00000055', 'name':'ESME_RINVNUMMSGS', 'description':'Invalid number of messages'},
'00000058':{'hex':'00000058', 'name':'ESME_RTHROTTLED', 'description':'Throttling error (ESME has exceeded allowed message limits)'},
'00000061':{'hex':'00000061', 'name':'ESME_RINVSCHED', 'description':'Invalid scheduled delivery time'},
'00000062':{'hex':'00000062', 'name':'ESME_RINVEXPIRY', 'description':'Invalid message validity period (expiry time)'},
'00000063':{'hex':'00000063', 'name':'ESME_RINVDFTMSGID', 'description':'Predefined message invalid or not found'},
'00000064':{'hex':'00000064', 'name':'ESME_RX_T_APPN', 'description':'ESME Receiver Temporary App Error Code'},
'00000065':{'hex':'00000065', 'name':'ESME_RX_P_APPN', 'description':'ESME Receiver Permanent App Error Code'},
'00000066':{'hex':'00000066', 'name':'ESME_RX_R_APPN', 'description':'ESME Receiver Reject Message Error Code'},
'00000067':{'hex':'00000067', 'name':'ESME_RQUERYFAIL', 'description':'query_sm request failed'},
'000000c0':{'hex':'000000c0', 'name':'ESME_RINVOPTPARSTREAM', 'description':'Error in the optional part of the PDU Body'},
'000000c1':{'hex':'000000c1', 'name':'ESME_ROPTPARNOTALLWD', 'description':'Optional paramenter not allowed'},
'000000c2':{'hex':'000000c2', 'name':'ESME_RINVPARLEN', 'description':'Invalid parameter length'},
'000000c3':{'hex':'000000c3', 'name':'ESME_RMISSINGOPTPARAM', 'description':'Expected optional parameter missing'},
'000000c4':{'hex':'000000c4', 'name':'ESME_RINVOPTPARAMVAL', 'description':'Invalid optional parameter value'},
'000000fe':{'hex':'000000fe', 'name':'ESME_RDELIVERYFAILURE', 'description':'Delivery Failure (used for data_sm_resp)'},
'000000ff':{'hex':'000000ff', 'name':'ESME_RUNKNOWNERR', 'description':'Unknown error'}
}
def command_status_name_by_hex(x):
return command_status_by_hex.get(x,{}).get('name')
command_status_by_name = {
'ESME_ROK' :{'hex':'00000000', 'name':'ESME_ROK', 'description':'No error'},
'ESME_RINVMSGLEN' :{'hex':'00000001', 'name':'ESME_RINVMSGLEN', 'description':'Message Length is invalid'},
'ESME_RINVCMDLEN' :{'hex':'00000002', 'name':'ESME_RINVCMDLEN', 'description':'Command Length is invalid'},
'ESME_RINVCMDID' :{'hex':'00000003', 'name':'ESME_RINVCMDID', 'description':'Invalid Command ID'},
'ESME_RINVBNDSTS' :{'hex':'00000004', 'name':'ESME_RINVBNDSTS', 'description':'Incorrect BIND Status for given command'},
'ESME_RALYBND' :{'hex':'00000005', 'name':'ESME_RALYBND', 'description':'ESME Already in bound state'},
'ESME_RINVPRTFLG' :{'hex':'00000006', 'name':'ESME_RINVPRTFLG', 'description':'Invalid priority flag'},
'ESME_RINVREGDLVFLG' :{'hex':'00000007', 'name':'ESME_RINVREGDLVFLG', 'description':'Invalid registered delivery flag'},
'ESME_RSYSERR' :{'hex':'00000008', 'name':'ESME_RSYSERR', 'description':'System Error'},
'ESME_RINVSRCADR' :{'hex':'0000000a', 'name':'ESME_RINVSRCADR', 'description':'Invalid source address'},
'ESME_RINVDSTADR' :{'hex':'0000000b', 'name':'ESME_RINVDSTADR', 'description':'Invalid destination address'},
'ESME_RINVMSGID' :{'hex':'0000000c', 'name':'ESME_RINVMSGID', 'description':'Message ID is invalid'},
'ESME_RBINDFAIL' :{'hex':'0000000d', 'name':'ESME_RBINDFAIL', 'description':'Bind failed'},
'ESME_RINVPASWD' :{'hex':'0000000e', 'name':'ESME_RINVPASWD', 'description':'Invalid password'},
'ESME_RINVSYSID' :{'hex':'0000000f', 'name':'ESME_RINVSYSID', 'description':'Invalid System ID'},
'ESME_RCANCELFAIL' :{'hex':'00000011', 'name':'ESME_RCANCELFAIL', 'description':'Cancel SM Failed'},
'ESME_RREPLACEFAIL' :{'hex':'00000013', 'name':'ESME_RREPLACEFAIL', 'description':'Replace SM Failed'},
'ESME_RMSGQFUL' :{'hex':'00000014', 'name':'ESME_RMSGQFUL', 'description':'Message queue full'},
'ESME_RINVSERTYP' :{'hex':'00000015', 'name':'ESME_RINVSERTYP', 'description':'Invalid service type'},
'ESME_RINVNUMDESTS' :{'hex':'00000033', 'name':'ESME_RINVNUMDESTS', 'description':'Invalid number of destinations'},
'ESME_RINVDLNAME' :{'hex':'00000034', 'name':'ESME_RINVDLNAME', 'description':'Invalid distribution list name'},
'ESME_RINVDESTFLAG' :{'hex':'00000040', 'name':'ESME_RINVDESTFLAG', 'description':'Destination flag is invalid (submit_multi)'},
'ESME_RINVSUBREP' :{'hex':'00000042', 'name':'ESME_RINVSUBREP', 'description':"Invalid `submit with replace' request (i.e. submit_sm with replace_if_present_flag set)"},
'ESME_RINVESMCLASS' :{'hex':'00000043', 'name':'ESME_RINVESMCLASS', 'description':'Invalid esm_class field data'},
'ESME_RCNTSUBDL' :{'hex':'00000044', 'name':'ESME_RCNTSUBDL', 'description':'Cannot submit to distribution list'},
'ESME_RSUBMITFAIL' :{'hex':'00000045', 'name':'ESME_RSUBMITFAIL', 'description':'submit_sm or submit_multi failed'},
'ESME_RINVSRCTON' :{'hex':'00000048', 'name':'ESME_RINVSRCTON', 'description':'Invalid source address TON'},
'ESME_RINVSRCNPI' :{'hex':'00000049', 'name':'ESME_RINVSRCNPI', 'description':'Invalid source address NPI'},
'ESME_RINVDSTTON' :{'hex':'00000050', 'name':'ESME_RINVDSTTON', 'description':'Invalid destination address TON'},
'ESME_RINVDSTNPI' :{'hex':'00000051', 'name':'ESME_RINVDSTNPI', 'description':'Invalid destination address NPI'},
'ESME_RINVSYSTYP' :{'hex':'00000053', 'name':'ESME_RINVSYSTYP', 'description':'Invalid system_type field'},
'ESME_RINVREPFLAG' :{'hex':'00000054', 'name':'ESME_RINVREPFLAG', 'description':'Invalid replace_if_present flag'},
'ESME_RINVNUMMSGS' :{'hex':'00000055', 'name':'ESME_RINVNUMMSGS', 'description':'Invalid number of messages'},
'ESME_RTHROTTLED' :{'hex':'00000058', 'name':'ESME_RTHROTTLED', 'description':'Throttling error (ESME has exceeded allowed message limits)'},
'ESME_RINVSCHED' :{'hex':'00000061', 'name':'ESME_RINVSCHED', 'description':'Invalid scheduled delivery time'},
'ESME_RINVEXPIRY' :{'hex':'00000062', 'name':'ESME_RINVEXPIRY', 'description':'Invalid message validity period (expiry time)'},
'ESME_RINVDFTMSGID' :{'hex':'00000063', 'name':'ESME_RINVDFTMSGID', 'description':'Predefined message invalid or not found'},
'ESME_RX_T_APPN' :{'hex':'00000064', 'name':'ESME_RX_T_APPN', 'description':'ESME Receiver Temporary App Error Code'},
'ESME_RX_P_APPN' :{'hex':'00000065', 'name':'ESME_RX_P_APPN', 'description':'ESME Receiver Permanent App Error Code'},
'ESME_RX_R_APPN' :{'hex':'00000066', 'name':'ESME_RX_R_APPN', 'description':'ESME Receiver Reject Message Error Code'},
'ESME_RQUERYFAIL' :{'hex':'00000067', 'name':'ESME_RQUERYFAIL', 'description':'query_sm request failed'},
'ESME_RINVOPTPARSTREAM':{'hex':'000000c0', 'name':'ESME_RINVOPTPARSTREAM', 'description':'Error in the optional part of the PDU Body'},
'ESME_ROPTPARNOTALLWD' :{'hex':'000000c1', 'name':'ESME_ROPTPARNOTALLWD', 'description':'Optional paramenter not allowed'},
'ESME_RINVPARLEN' :{'hex':'000000c2', 'name':'ESME_RINVPARLEN', 'description':'Invalid parameter length'},
'ESME_RMISSINGOPTPARAM':{'hex':'000000c3', 'name':'ESME_RMISSINGOPTPARAM', 'description':'Expected optional parameter missing'},
'ESME_RINVOPTPARAMVAL' :{'hex':'000000c4', 'name':'ESME_RINVOPTPARAMVAL', 'description':'Invalid optional parameter value'},
'ESME_RDELIVERYFAILURE':{'hex':'000000fe', 'name':'ESME_RDELIVERYFAILURE', 'description':'Delivery Failure (used for data_sm_resp)'},
'ESME_RUNKNOWNERR' :{'hex':'000000ff', 'name':'ESME_RUNKNOWNERR', 'description':'Unknown error'}
}
def command_status_hex_by_name(n):
return command_status_by_name.get(n,{}).get('hex')
# Type of Number (TON) - SMPP v3.4, section 5.2.5, table 5-3, page 117
maps['addr_ton_by_name'] = {
+ '' :'00',
'unknown' :'00',
'international' :'01',
'national' :'02',
'network_specific' :'03',
'subscriber_number':'04',
'alphanumeric' :'05',
'abbreviated' :'06'
}
maps['addr_ton_by_hex'] = {
'00':'unknown',
'01':'international',
'02':'national',
'03':'network_specific',
'04':'subscriber_number',
'05':'alphanumeric',
'06':'abbreviated'
}
# Numberic Plan Indicator (NPI) - SMPP v3.4, section 5.2.6, table 5-4, page 118
maps['addr_npi_by_name'] = {
+ '' :'00',
'unknown' :'00',
'ISDN' :'01',
'data' :'03',
'telex' :'04',
'land_mobile':'06',
'national' :'08',
'private' :'09',
'ERMES' :'0a',
'internet' :'0e',
'WAP' :'12'
}
maps['addr_npi_by_hex'] = {
'00':'unknown',
'01':'ISDN',
'03':'data',
'04':'telex',
'06':'land_mobile',
'08':'national',
'09':'private',
'0a':'ERMES',
'0e':'internet',
'12':'WAP'
}
# ESM Class bits - SMPP v3.4, section 5.2.12, page 121
maps['esm_class_bits'] = {
'mode_mask' :'03',
'type_mask' :'3c',
'feature_mask' :'c0',
'mode_default' :'00',
'mode_datagram' :'01',
'mode_forward' :'02',
'mode_store_and_forward' :'03',
'type_default' :'00',
'type_delivery_receipt' :'04',
'type_delivery_ack' :'08',
'type_0011' :'0a',
'type_user_ack' :'10',
'type_0101' :'14',
'type_conversation_abort' :'18',
'type_0111' :'1a',
'type_intermed_deliv_notif' :'20',
'type_1001' :'24',
'type_1010' :'28',
'type_1011' :'2a',
'type_1100' :'30',
'type_1101' :'34',
'type_1110' :'38',
'type_1111' :'3a',
'feature_none' :'00',
'feature_UDHI' :'40',
'feature_reply_path' :'80',
'feature_UDHI_and_reply_path':'c0'
}
# Registered Delivery bits - SMPP v3.4, section 5.2.17, page 124
maps['registered_delivery_bits'] = {
'receipt_mask' :'03',
'ack_mask' :'0c',
'intermed_notif_mask' :'80',
'receipt_none' :'00',
'receipt_always' :'01',
'receipt_on_fail' :'02',
'receipt_res' :'03',
'ack_none' :'00',
'ack_delivery' :'04',
'ack_user' :'08',
'ack_delivery_and_user':'0c',
'intermed_notif_none' :'00',
'intermed_notif' :'10'
}
# submit_multi dest_flag constants - SMPP v3.4, section 5.2.25, page 129
#maps['dest_flag_by_name'] = {
#'SME Address' :1,
#'Distribution List Name':2
#}
# Message State codes returned in query_sm_resp PDUs - SMPP v3.4, section 5.2.28, table 5-6, page 130
maps['message_state_by_name'] = {
'ENROUTE' :1,
'DELIVERED' :2,
'EXPIRED' :3,
'DELETED' :4,
'UNDELIVERABLE':5,
'ACCEPTED' :6,
'UNKNOWN' :7,
'REJECTED' :8
}
# Facility Code bits for SMPP v4
maps['facility_code_bits'] = {
'GF_PVCY' :'00000001',
'GF_SUBADDR':'00000002',
'NF_CC' :'00080000',
'NF_PDC' :'00010000',
'NF_IS136' :'00020000',
'NF_IS95A' :'00040000'
}
# Optional Parameter Tags - SMPP v3.4, section 5.3.2, Table 5-7, page 132-133
optional_parameter_tag_by_hex = {
'0005':{'hex':'0005', 'name':'dest_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.1, page 134
'0006':{'hex':'0006', 'name':'dest_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.3, page 135
'0007':{'hex':'0007', 'name':'dest_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.5, page 136
'0008':{'hex':'0008', 'name':'dest_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.7, page 137
'000d':{'hex':'000d', 'name':'source_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.2, page 134
'000e':{'hex':'000e', 'name':'source_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.4, page 135
'000f':{'hex':'000f', 'name':'source_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.6, page 136
'0010':{'hex':'0010', 'name':'source_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.8, page 137
'0017':{'hex':'0017', 'name':'qos_time_to_live', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.9, page 138
'0019':{'hex':'0019', 'name':'payload_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.10, page 138
'001d':{'hex':'001d', 'name':'additional_status_info_text', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.11, page 139
'001e':{'hex':'001e', 'name':'receipted_message_id', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.12, page 139
'0030':{'hex':'0030', 'name':'ms_msg_wait_facilities', 'type':'bitmask', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.13, page 140
'0101':{'hex':'0101', 'name':'PVCY_AuthenticationStr', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 58-62
'0201':{'hex':'0201', 'name':'privacy_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.14, page 141
'0202':{'hex':'0202', 'name':'source_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.15, page 142
'0203':{'hex':'0203', 'name':'dest_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.16, page 143
'0204':{'hex':'0204', 'name':'user_message_reference', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.17, page 143
'0205':{'hex':'0205', 'name':'user_response_code', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.18, page 144
'020a':{'hex':'020a', 'name':'source_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.20, page 145
'020b':{'hex':'020b', 'name':'destination_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.21, page 145
'020c':{'hex':'020c', 'name':'sar_msg_ref_num', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.22, page 146
'020d':{'hex':'020d', 'name':'language_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.19, page 144
'020e':{'hex':'020e', 'name':'sar_total_segments', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.23, page 147
'020f':{'hex':'020f', 'name':'sar_segment_seqnum', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.24, page 147
'0210':{'hex':'0210', 'name':'sc_interface_version', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.25, page 148
'0301':{'hex':'0301', 'name':'CC_CBN', 'type':None, 'tech':'V4'}, # v4 page 70
'0302':{'hex':'0302', 'name':'callback_num_pres_ind', 'type':'bitmask', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.37, page 156
'0303':{'hex':'0303', 'name':'callback_num_atag', 'type':'hex', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.38, page 157
'0304':{'hex':'0304', 'name':'number_of_messages', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.39, page 158
'0381':{'hex':'0381', 'name':'callback_num', 'type':'hex', 'tech':'CDMA, TDMA, GSM, iDEN'}, # SMPP v3.4, section 5.3.2.36, page 155
'0420':{'hex':'0420', 'name':'dpf_result', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.28, page 149
'0421':{'hex':'0421', 'name':'set_dpf', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.29, page 150
'0422':{'hex':'0422', 'name':'ms_availability_status', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.30, page 151
'0423':{'hex':'0423', 'name':'network_error_code', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.31, page 152
'0424':{'hex':'0424', 'name':'message_payload', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.32, page 153
'0425':{'hex':'0425', 'name':'delivery_failure_reason', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.33, page 153
'0426':{'hex':'0426', 'name':'more_messages_to_send', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.34, page 154
'0427':{'hex':'0427', 'name':'message_state', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.35, page 154
'0428':{'hex':'0428', 'name':'congestion_state', 'type':None, 'tech':'Generic'},
'0501':{'hex':'0501', 'name':'ussd_service_op', 'type':'hex', 'tech':'GSM (USSD)'}, # SMPP v3.4, section 5.3.2.44, page 161
'0600':{'hex':'0600', 'name':'broadcast_channel_indicator', 'type':None, 'tech':'GSM'},
'0601':{'hex':'0601', 'name':'broadcast_content_type', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'0602':{'hex':'0602', 'name':'broadcast_content_type_info', 'type':None, 'tech':'CDMA, TDMA'},
'0603':{'hex':'0603', 'name':'broadcast_message_class', 'type':None, 'tech':'GSM'},
'0604':{'hex':'0604', 'name':'broadcast_rep_num', 'type':None, 'tech':'GSM'},
'0605':{'hex':'0605', 'name':'broadcast_frequency_interval', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'0606':{'hex':'0606', 'name':'broadcast_area_identifier', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'0607':{'hex':'0607', 'name':'broadcast_error_status', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'0608':{'hex':'0608', 'name':'broadcast_area_success', 'type':None, 'tech':'GSM'},
'0609':{'hex':'0609', 'name':'broadcast_end_time', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'060a':{'hex':'060a', 'name':'broadcast_service_group', 'type':None, 'tech':'CDMA, TDMA'},
'060b':{'hex':'060b', 'name':'billing_identification', 'type':None, 'tech':'Generic'},
'060d':{'hex':'060d', 'name':'source_network_id', 'type':None, 'tech':'Generic'},
'060e':{'hex':'060e', 'name':'dest_network_id', 'type':None, 'tech':'Generic'},
'060f':{'hex':'060f', 'name':'source_node_id', 'type':None, 'tech':'Generic'},
'0610':{'hex':'0610', 'name':'dest_node_id', 'type':None, 'tech':'Generic'},
'0611':{'hex':'0611', 'name':'dest_addr_np_resolution', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'0612':{'hex':'0612', 'name':'dest_addr_np_information', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'0613':{'hex':'0613', 'name':'dest_addr_np_country', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'1101':{'hex':'1101', 'name':'PDC_MessageClass', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 75
'1102':{'hex':'1102', 'name':'PDC_PresentationOption', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
'1103':{'hex':'1103', 'name':'PDC_AlertMechanism', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
'1104':{'hex':'1104', 'name':'PDC_Teleservice', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
'1105':{'hex':'1105', 'name':'PDC_MultiPartMessage', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
'1106':{'hex':'1106', 'name':'PDC_PredefinedMsg', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 78
'1201':{'hex':'1201', 'name':'display_time', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.26, page 148
'1203':{'hex':'1203', 'name':'sms_signal', 'type':'integer', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.40, page 158
'1204':{'hex':'1204', 'name':'ms_validity', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.27, page 149
'1304':{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'type':None, 'tech':'CDMA'}, # v4 page 85
'1306':{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'type':None, 'tech':'CDMA'}, # v4 page 86
'130c':{'hex':'130c', 'name':'alert_on_message_delivery', 'type':None, 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.41, page 159
'1380':{'hex':'1380', 'name':'its_reply_type', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.42, page 159
'1383':{'hex':'1383', 'name':'its_session_info', 'type':'hex', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.43, page 160
'1402':{'hex':'1402', 'name':'operator_id', 'type':None, 'tech':'vendor extension'},
'1403':{'hex':'1403', 'name':'tariff', 'type':None, 'tech':'Mobile Network Code vendor extension'},
'1450':{'hex':'1450', 'name':'mcc', 'type':None, 'tech':'Mobile Country Code vendor extension'},
'1451':{'hex':'1451', 'name':'mnc', 'type':None, 'tech':'Mobile Network Code vendor extension'}
}
def optional_parameter_tag_name_by_hex(x):
return optional_parameter_tag_by_hex.get(x,{}).get('name')
def optional_parameter_tag_type_by_hex(x):
return optional_parameter_tag_by_hex.get(x,{}).get('type')
optional_parameter_tag_by_name = {
'dest_addr_subunit' :{'hex':'0005', 'name':'dest_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.1, page 134
'dest_network_type' :{'hex':'0006', 'name':'dest_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.3, page 135
'dest_bearer_type' :{'hex':'0007', 'name':'dest_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.5, page 136
'dest_telematics_id' :{'hex':'0008', 'name':'dest_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.7, page 137
'source_addr_subunit' :{'hex':'000d', 'name':'source_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.2, page 134
'source_network_type' :{'hex':'000e', 'name':'source_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.4, page 135
'source_bearer_type' :{'hex':'000f', 'name':'source_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.6, page 136
'source_telematics_id' :{'hex':'0010', 'name':'source_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.8, page 137
'qos_time_to_live' :{'hex':'0017', 'name':'qos_time_to_live', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.9, page 138
'payload_type' :{'hex':'0019', 'name':'payload_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.10, page 138
'additional_status_info_text' :{'hex':'001d', 'name':'additional_status_info_text', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.11, page 139
'receipted_message_id' :{'hex':'001e', 'name':'receipted_message_id', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.12, page 139
'ms_msg_wait_facilities' :{'hex':'0030', 'name':'ms_msg_wait_facilities', 'type':'bitmask', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.13, page 140
'PVCY_AuthenticationStr' :{'hex':'0101', 'name':'PVCY_AuthenticationStr', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 58-62
'privacy_indicator' :{'hex':'0201', 'name':'privacy_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.14, page 141
'source_subaddress' :{'hex':'0202', 'name':'source_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.15, page 142
'dest_subaddress' :{'hex':'0203', 'name':'dest_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.16, page 143
'user_message_reference' :{'hex':'0204', 'name':'user_message_reference', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.17, page 143
'user_response_code' :{'hex':'0205', 'name':'user_response_code', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.18, page 144
'source_port' :{'hex':'020a', 'name':'source_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.20, page 145
'destination_port' :{'hex':'020b', 'name':'destination_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.21, page 145
'sar_msg_ref_num' :{'hex':'020c', 'name':'sar_msg_ref_num', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.22, page 146
'language_indicator' :{'hex':'020d', 'name':'language_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.19, page 144
'sar_total_segments' :{'hex':'020e', 'name':'sar_total_segments', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.23, page 147
'sar_segment_seqnum' :{'hex':'020f', 'name':'sar_segment_seqnum', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.24, page 147
'sc_interface_version' :{'hex':'0210', 'name':'sc_interface_version', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.25, page 148
'CC_CBN' :{'hex':'0301', 'name':'CC_CBN', 'type':None, 'tech':'V4'}, # v4 page 70
'callback_num_pres_ind' :{'hex':'0302', 'name':'callback_num_pres_ind', 'type':'bitmask', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.37, page 156
'callback_num_atag' :{'hex':'0303', 'name':'callback_num_atag', 'type':'hex', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.38, page 157
'number_of_messages' :{'hex':'0304', 'name':'number_of_messages', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.39, page 158
'callback_num' :{'hex':'0381', 'name':'callback_num', 'type':'hex', 'tech':'CDMA, TDMA, GSM, iDEN'}, # SMPP v3.4, section 5.3.2.36, page 155
'dpf_result' :{'hex':'0420', 'name':'dpf_result', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.28, page 149
'set_dpf' :{'hex':'0421', 'name':'set_dpf', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.29, page 150
'ms_availability_status' :{'hex':'0422', 'name':'ms_availability_status', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.30, page 151
'network_error_code' :{'hex':'0423', 'name':'network_error_code', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.31, page 152
'message_payload' :{'hex':'0424', 'name':'message_payload', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.32, page 153
'delivery_failure_reason' :{'hex':'0425', 'name':'delivery_failure_reason', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.33, page 153
'more_messages_to_send' :{'hex':'0426', 'name':'more_messages_to_send', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.34, page 154
'message_state' :{'hex':'0427', 'name':'message_state', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.35, page 154
'congestion_state' :{'hex':'0428', 'name':'congestion_state', 'type':None, 'tech':'Generic'},
'ussd_service_op' :{'hex':'0501', 'name':'ussd_service_op', 'type':'hex', 'tech':'GSM (USSD)'}, # SMPP v3.4, section 5.3.2.44, page 161
'broadcast_channel_indicator' :{'hex':'0600', 'name':'broadcast_channel_indicator', 'type':None, 'tech':'GSM'},
'broadcast_content_type' :{'hex':'0601', 'name':'broadcast_content_type', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_content_type_info' :{'hex':'0602', 'name':'broadcast_content_type_info', 'type':None, 'tech':'CDMA, TDMA'},
'broadcast_message_class' :{'hex':'0603', 'name':'broadcast_message_class', 'type':None, 'tech':'GSM'},
'broadcast_rep_num' :{'hex':'0604', 'name':'broadcast_rep_num', 'type':None, 'tech':'GSM'},
'broadcast_frequency_interval':{'hex':'0605', 'name':'broadcast_frequency_interval', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_area_identifier' :{'hex':'0606', 'name':'broadcast_area_identifier', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_error_status' :{'hex':'0607', 'name':'broadcast_error_status', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_area_success' :{'hex':'0608', 'name':'broadcast_area_success', 'type':None, 'tech':'GSM'},
'broadcast_end_time' :{'hex':'0609', 'name':'broadcast_end_time', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_service_group' :{'hex':'060a', 'name':'broadcast_service_group', 'type':None, 'tech':'CDMA, TDMA'},
'billing_identification' :{'hex':'060b', 'name':'billing_identification', 'type':None, 'tech':'Generic'},
'source_network_id' :{'hex':'060d', 'name':'source_network_id', 'type':None, 'tech':'Generic'},
'dest_network_id' :{'hex':'060e', 'name':'dest_network_id', 'type':None, 'tech':'Generic'},
'source_node_id' :{'hex':'060f', 'name':'source_node_id', 'type':None, 'tech':'Generic'},
'dest_node_id' :{'hex':'0610', 'name':'dest_node_id', 'type':None, 'tech':'Generic'},
'dest_addr_np_resolution' :{'hex':'0611', 'name':'dest_addr_np_resolution', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'dest_addr_np_information' :{'hex':'0612', 'name':'dest_addr_np_information', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'dest_addr_np_country' :{'hex':'0613', 'name':'dest_addr_np_country', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'PDC_MessageClass' :{'hex':'1101', 'name':'PDC_MessageClass', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 75
'PDC_PresentationOption' :{'hex':'1102', 'name':'PDC_PresentationOption', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
'PDC_AlertMechanism' :{'hex':'1103', 'name':'PDC_AlertMechanism', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
'PDC_Teleservice' :{'hex':'1104', 'name':'PDC_Teleservice', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
'PDC_MultiPartMessage' :{'hex':'1105', 'name':'PDC_MultiPartMessage', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
'PDC_PredefinedMsg' :{'hex':'1106', 'name':'PDC_PredefinedMsg', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 78
'display_time' :{'hex':'1201', 'name':'display_time', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.26, page 148
'sms_signal' :{'hex':'1203', 'name':'sms_signal', 'type':'integer', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.40, page 158
'ms_validity' :{'hex':'1204', 'name':'ms_validity', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.27, page 149
'IS95A_AlertOnDelivery' :{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'type':None, 'tech':'CDMA'}, # v4 page 85
'IS95A_LanguageIndicator' :{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'type':None, 'tech':'CDMA'}, # v4 page 86
'alert_on_message_delivery' :{'hex':'130c', 'name':'alert_on_message_delivery', 'type':None, 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.41, page 159
'its_reply_type' :{'hex':'1380', 'name':'its_reply_type', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.42, page 159
'its_session_info' :{'hex':'1383', 'name':'its_session_info', 'type':'hex', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.43, page 160
'operator_id' :{'hex':'1402', 'name':'operator_id', 'type':None, 'tech':'vendor extension'},
'tariff' :{'hex':'1403', 'name':'tariff', 'type':None, 'tech':'Mobile Network Code vendor extension'},
'mcc' :{'hex':'1450', 'name':'mcc', 'type':None, 'tech':'Mobile Country Code vendor extension'},
'mnc' :{'hex':'1451', 'name':'mnc', 'type':None, 'tech':'Mobile Network Code vendor extension'}
}
def optional_parameter_tag_hex_by_name(n):
return optional_parameter_tag_by_name.get(n,{}).get('hex')
#### Decoding functions #######################################################
def unpack_pdu(pdu_bin):
- #return binascii.b2a_hex(pdu_bin)
return decode_pdu(binascii.b2a_hex(pdu_bin))
def decode_pdu(pdu_hex):
hex_ref = [pdu_hex]
pdu = {}
pdu['header'] = decode_header(hex_ref)
command = pdu['header'].get('command_id', None)
if command != None:
body = decode_body(command, hex_ref)
if len(body) > 0:
pdu['body'] = body
return pdu
def decode_header(hex_ref):
pdu_hex = hex_ref[0]
header = {}
(command_length, command_id, command_status, sequence_number, hex_ref[0]) = \
(pdu_hex[0:8], pdu_hex[8:16], pdu_hex[16:24], pdu_hex[24:32], pdu_hex[32: ])
length = int(command_length, 16)
command = command_id_name_by_hex(command_id)
status = command_status_name_by_hex(command_status)
sequence = int(sequence_number, 16)
header = {}
header['command_length'] = length
header['command_id'] = command
header['command_status'] = status
header['sequence_number'] = sequence
return header
def decode_body(command, hex_ref):
body = {}
if command != None:
fields = mandatory_parameter_list_by_command_name(command)
mandatory = decode_mandatory_parameters(fields, hex_ref)
if len(mandatory) > 0:
body['mandatory_parameters'] = mandatory
optional = decode_optional_parameters(hex_ref)
if len(optional) > 0:
body['optional_parameters'] = optional
return body
def decode_mandatory_parameters(fields, hex_ref):
mandatory_parameters = {}
if len(hex_ref[0]) > 1:
for field in fields:
+ old = len(hex_ref[0])
data = ''
octet = ''
count = 0
if field['var'] == True or field['var'] == False:
while (len(hex_ref[0]) > 1
and (count < field['min']
or (count < field['max']
and octet != '00'))):
octet = octpop(hex_ref)
data += octet
count += 1
elif field['type'] == 'string':
count = mandatory_parameters[field['var']]
for i in range(count):
if len(hex_ref[0]) > 1:
data += octpop(hex_ref)
else:
count = mandatory_parameters[field['var']]
if field['map'] != None:
+ print field, data
mandatory_parameters[field['name']] = maps.get(field['map']+'_by_hex',{data:data})[data]
else:
mandatory_parameters[field['name']] = decode_hex_type(data, field['type'], count, hex_ref)
+ print field['type'], (old - len(hex_ref[0]))/2, repr(data), field['name'], mandatory_parameters[field['name']]
return mandatory_parameters
def decode_optional_parameters(hex_ref):
optional_parameters = []
hex = hex_ref[0]
while len(hex) > 0:
(tag_hex, length_hex, rest) = (hex[0:4], hex[4:8], hex[8: ])
tag = optional_parameter_tag_name_by_hex(tag_hex)
if tag == None:
tag = tag_hex
length = int(length_hex, 16)
(value_hex, tail) = (rest[0:length*2], rest[length*2: ])
if len(value_hex) == 0:
value = None
else:
value = decode_hex_type(value_hex, optional_parameter_tag_type_by_hex(tag_hex))
hex = tail
optional_parameters.append({'tag':tag, 'length':length, 'value':value})
return optional_parameters
def decode_hex_type(hex, type, count=0, hex_ref=['']):
if type == 'integer':
return int(hex, 16)
elif type == 'string':
return binascii.b2a_qp(binascii.a2b_hex(re.sub('00','',hex)))
elif (type == 'dest_address'
or type == 'unsuccess_sme'):
list = []
fields = mandatory_parameter_list_by_command_name(type)
for i in range(count):
item = decode_mandatory_parameters(fields, hex_ref)
if item.get('dest_flag', None) == 1: # 'dest_address' only
subfields = mandatory_parameter_list_by_command_name('sme_dest_address')
rest = decode_mandatory_parameters(subfields, hex_ref)
item.update(rest)
elif item.get('dest_flag', None) == 2: # 'dest_address' only
subfields = mandatory_parameter_list_by_command_name('distribution_list')
rest = decode_mandatory_parameters(subfields, hex_ref)
item.update(rest)
list.append(item)
return list
else:
return hex
def octpop(hex_ref):
octet = None
if len(hex_ref[0]) > 1:
(octet, hex_ref[0]) = (hex_ref[0][0:2], hex_ref[0][2: ])
return octet
#### Encoding functions #######################################################
-def pack_pdu(command='bind_transmitter', status='ESME_ROK', sequence=0, body_hex=''):
- length = 16 + len(body_hex)/2
- command_length = '%08x' % length
- command_id = command_id_hex_by_name(command)
- command_status = command_status_hex_by_name(status)
- sequence_number = '%08x' % sequence
+def pack_pdu(pdu_obj):
+ return binascii.a2b_hex(encode_pdu(pdu_obj))
+
+
+def encode_pdu(pdu_obj):
+ header = pdu_obj.get('header', {})
+ body = pdu_obj.get('body', {})
+ mandatory = body.get('mandatory_parameters', {})
+ optional = body.get('optional_parameters', [])
+ body_hex = ''
+ fields = mandatory_parameter_list_by_command_name(header['command_id'])
+ body_hex += encode_mandatory_parameters(mandatory, fields)
+ for opt in optional:
+ body_hex += encode_optional_parameter(opt['tag'], opt['value'])
+ actual_length = 16 + len(body_hex)/2
+ command_length = '%08x' % actual_length
+ command_id = command_id_hex_by_name(header['command_id'])
+ command_status = command_status_hex_by_name(header['command_status'])
+ sequence_number = '%08x' % header['sequence_number']
pdu_hex = command_length + command_id + command_status + sequence_number + body_hex
- return binascii.a2b_hex(pdu_hex)
+ return pdu_hex
-def encode_mandatory_parameters(fields, json):
+def encode_mandatory_parameters(mandatory_obj, fields):
mandatory_hex = ''
+ for field in fields:
+ param = mandatory_obj[field['name']]
+ mandatory_hex += encode_param_type(param, field['type'], field['min'], field['max'])
return mandatory_hex
def encode_optional_parameter(tag, value):
optional_hex = ''
tag_hex = optional_parameter_tag_hex_by_name(tag)
if tag_hex != None:
value_hex = '%02x' % value #TODO need encoding mapping
length_hex = '%04x' % (len(value_hex)/2)
optional_hex = tag_hex + length_hex + value_hex
return optional_hex
-def json_to_pdu(json):
- header = json.get('header', {})
- body_hex = ''
- body = json.get('body', {})
- for opt in body.get('optional_parameters',[]):
- body_hex += encode_optional_parameter(opt['tag'], opt['value'])
- return pack_pdu(header['command_id'], header['command_status'], header['sequence_number'], body_hex)
-
-
+def encode_param_type(param, type, min=0, max=None):
+ if type == 'integer':
+ return '%02x' % int(param)
+ elif type == 'string':
+ hex = binascii.b2a_hex(binascii.a2b_qp(str(param))) + '00'
+ print 'xxx', hex
+ return hex
+ else:
+ return '00'
|
dmaclay/python-smpp
|
152bc28725edd4e88fcb5174c79e3b9e7931500b
|
can encode bind
|
diff --git a/tests.py b/tests.py
index 7470655..9436781 100644
--- a/tests.py
+++ b/tests.py
@@ -1,53 +1,122 @@
from smpp.esme import *
+def prettydump(pdu_hex):
+ return json.dumps(unpack_pdu(binascii.a2b_hex(hexclean(x))), indent=4, sort_keys=True)
+
+def hexclean(dirtyhex):
+ return re.sub(r'\s','',re.sub(r'#.*\n','\n',dirtyhex))
+
+lines = "\n==================================================================\n"
+
+
print ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>"
#esme = ESME()
#esme.connect_SMSC('localhost')
#esme.bind_SMSC()
#esme.disconnect_SMSC()
-
print ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>"
-print "\n==============================================================="
-test_bin = binascii.a2b_hex(re.sub(' ','','00 00 00 3C 00 00 00 04 00 00 00 00 00 00 00 05 00 02 08 35 35 35 00 01 01 35 35 35 35 35 35 35 35 35 00 00 00 00 00 00 00 00 00 00 0F 48 65 6C 6C 6F 20 77 69 6B 69 70 65 64 69 61 00000000 001d00026566'))
-print json.dumps(unpack_pdu(test_bin), indent=4, sort_keys=True)
+x = '''
+ 0000003C # command_length
+ 00000004 # command_id
+ 00000000 # command_status
+ 00000005 # sequence_number
+ 00
+ 02
+ 08
+ 35353500
+ 01
+ 01
+ 35353535353535353500
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 0F
+ 48656C6C6F2077696B697065646961
+ 00000000
+ 001d00026566
+'''
+print lines, prettydump(x)
+
-print "\n==============================================================="
-test_bin = binascii.a2b_hex(re.sub(' ','','00000000 00000021 00000000 00000000 00 00 00 00 02 0101016500 026600 00 00 00 00 00 00 00 00 00 00 000500020000 0000000400000000'))
-print json.dumps(unpack_pdu(test_bin), indent=4, sort_keys=True)
+x = '''
+ 00000000 # command_length
+ 00000021 # command_id
+ 00000000 # command_status
+ 00000000 # sequence_number
+ 00
+ 00
+ 00
+ 00
+ 02
+ 01 01 01 6500
+ 02 6600
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 00
+ 0005 0002 0000
+ 0000 0004 00000000
+'''
+print lines, prettydump(x)
-print "\n==============================================================="
-test_bin = binascii.a2b_hex(re.sub(' ','','00000000 80000021 00000000 00000000 00 02 01016565650000000000 01016666660000000000'))
-print json.dumps(unpack_pdu(test_bin), indent=4, sort_keys=True)
-print "\n==============================================================="
-test_bin = pack_pdu('generic_nack','ESME_ROK',1,'001d000b6162636465666768696a6b')
-print json.dumps(unpack_pdu(test_bin), indent=4, sort_keys=True)
+x = '''
+ 00000000
+ 80000021
+ 00000000
+ 00000000
+ 00
+ 02
+ 01016565650000000000
+ 01016666660000000000
+'''
+print lines, prettydump(x)
-print "\n==============================================================="
-test_bin = pack_pdu()
-print json.dumps(unpack_pdu(test_bin), indent=4, sort_keys=True)
-j = {
+
+b = {
'header': {
'command_length': 16,
'command_id': 'bind_transmitter',
'command_status': 'ESME_ROK',
'sequence_number': 0
},
'body': {
+ 'mandatory_parameters': {
+ 'system_id':'eee',
+ 'password':'fff',
+ 'system_type':'',
+ 'interface_version':'',
+ 'addr_ton':1,
+ 'addr_npi':1,
+ 'address_range':'',
+ },
'optional_parameters': [
{
'tag':'payload_type',
'value':0
}
]
}
}
-json_to_pdu(j)
+
+print json.dumps(unpack_pdu(pack_pdu(b)), indent=4, sort_keys=True)
|
dmaclay/python-smpp
|
d0f216e3a4e3ed25e43d4d01bcf6b18b49da93ef
|
can encode bind
|
diff --git a/smpp/esme.py b/smpp/esme.py
index 8dc1525..75497e7 100644
--- a/smpp/esme.py
+++ b/smpp/esme.py
@@ -1,29 +1,29 @@
import socket
from pdu import *
class ESME:
def __init__(self):
self.conn = None
def connect_SMSC(self, host='127.0.0.1', port=2775):
self.conn = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
self.conn.connect((host, port))
def disconnect_SMSC(self):
self.conn.close()
def bind_SMSC(self):
- out_hex = re.sub(' ','','00 00 00 2F 00 00 00 02 00 00 00 00 00 00 00 01 53 4D 50 50 33 54 45 53 54 00 73 65 63 72 65 74 30 38 00 53 55 42 4D 49 54 31 00 00 01 01 00')
+ out_hex = re.sub(r'\s','','''00 00 00 2F 00 00 00 02 00 00 00 00 00 00 00 01 53 4D 50 50 33 54 45 53 54 00 73 65 63 72 65 74 30 38 00 53 55 42 4D 49 54 31 00 00 01 01 00''')
print '<<<< bind_SMSC out_hex >>>>', out_hex
out_bin = binascii.a2b_hex(out_hex)
self.conn.send(out_bin)
length_bin = self.conn.recv(4)
length = int(binascii.b2a_hex(length_bin),16)
rest_bin = self.conn.recv(length-4)
unpack_pdu(length_bin + rest_bin)
|
dmaclay/python-smpp
|
02f692c4de936bef9ae405824f697f33295bf4de
|
eventually
|
diff --git a/README b/README
index e69de29..71757c9 100644
--- a/README
+++ b/README
@@ -0,0 +1,2 @@
+
+ coming soon ... ish
\ No newline at end of file
|
dmaclay/python-smpp
|
70c197d60f17a6292df3cd9fdaa66cd8c9af2f7f
|
cleanup
|
diff --git a/smpp/esme.py b/smpp/esme.py
index 1de7bf9..8dc1525 100644
--- a/smpp/esme.py
+++ b/smpp/esme.py
@@ -1,34 +1,29 @@
import socket
from pdu import *
class ESME:
def __init__(self):
self.conn = None
def connect_SMSC(self, host='127.0.0.1', port=2775):
self.conn = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
self.conn.connect((host, port))
def disconnect_SMSC(self):
self.conn.close()
def bind_SMSC(self):
out_hex = re.sub(' ','','00 00 00 2F 00 00 00 02 00 00 00 00 00 00 00 01 53 4D 50 50 33 54 45 53 54 00 73 65 63 72 65 74 30 38 00 53 55 42 4D 49 54 31 00 00 01 01 00')
print '<<<< bind_SMSC out_hex >>>>', out_hex
out_bin = binascii.a2b_hex(out_hex)
self.conn.send(out_bin)
length_bin = self.conn.recv(4)
length = int(binascii.b2a_hex(length_bin),16)
rest_bin = self.conn.recv(length-4)
unpack_pdu(length_bin + rest_bin)
-#esme = ESME()
-#esme.connect_SMSC('localhost')
-#esme.bind_SMSC()
-#esme.disconnect_SMSC()
-
|
dmaclay/python-smpp
|
25e452d2d1a2e72878f99b1a4d39ef386b13dd78
|
cleanup
|
diff --git a/tests.py b/tests.py
index 39f4fde..7470655 100644
--- a/tests.py
+++ b/tests.py
@@ -1,45 +1,53 @@
from smpp.esme import *
-#esme = ESME()
-#esme.connect_SMSC()
-
-#print str(binascii.a2b_hex(re.sub(' ','','00 00 00 3C 00 00 00 04 00 00 00 00 00 00 00 05 00 02 08 35 35 35 00 01 01 35 35 35 35 35 35 35 35 35 00 00 00 00 00 00 00 00 00 00 0F 48 65 6C 6C 6F 20 77 69 6B 69 70 65 64 69 61')))
+print ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>"
+#esme = ESME()
+#esme.connect_SMSC('localhost')
+#esme.bind_SMSC()
+#esme.disconnect_SMSC()
print ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>"
+print "\n==============================================================="
test_bin = binascii.a2b_hex(re.sub(' ','','00 00 00 3C 00 00 00 04 00 00 00 00 00 00 00 05 00 02 08 35 35 35 00 01 01 35 35 35 35 35 35 35 35 35 00 00 00 00 00 00 00 00 00 00 0F 48 65 6C 6C 6F 20 77 69 6B 69 70 65 64 69 61 00000000 001d00026566'))
-unpack_pdu(test_bin)
+print json.dumps(unpack_pdu(test_bin), indent=4, sort_keys=True)
+print "\n==============================================================="
test_bin = binascii.a2b_hex(re.sub(' ','','00000000 00000021 00000000 00000000 00 00 00 00 02 0101016500 026600 00 00 00 00 00 00 00 00 00 00 000500020000 0000000400000000'))
-print unpack_pdu(test_bin)
+print json.dumps(unpack_pdu(test_bin), indent=4, sort_keys=True)
+print "\n==============================================================="
test_bin = binascii.a2b_hex(re.sub(' ','','00000000 80000021 00000000 00000000 00 02 01016565650000000000 01016666660000000000'))
-print unpack_pdu(test_bin)
+print json.dumps(unpack_pdu(test_bin), indent=4, sort_keys=True)
+
+print "\n==============================================================="
+test_bin = pack_pdu('generic_nack','ESME_ROK',1,'001d000b6162636465666768696a6b')
+print json.dumps(unpack_pdu(test_bin), indent=4, sort_keys=True)
-pack_pdu('generic_nack','ESME_ROK',1,'00112233445566778899')
-pack_pdu()
-print unpack_pdu(pack_pdu())
+print "\n==============================================================="
+test_bin = pack_pdu()
+print json.dumps(unpack_pdu(test_bin), indent=4, sort_keys=True)
j = {
'header': {
'command_length': 16,
'command_id': 'bind_transmitter',
'command_status': 'ESME_ROK',
'sequence_number': 0
},
'body': {
'optional_parameters': [
{
'tag':'payload_type',
'value':0
}
]
}
}
json_to_pdu(j)
|
dmaclay/python-smpp
|
1f6c87b41fa8cba67ecda20524a61127a6ea38e5
|
cleanup
|
diff --git a/smpp/pdu.py b/smpp/pdu.py
index 549345b..0f2e503 100644
--- a/smpp/pdu.py
+++ b/smpp/pdu.py
@@ -1,964 +1,967 @@
import binascii
import re
+try:
+ import json
+except:
+ import simplejson as json
+
+
maps = {} # Inserting certain referenced dicts in here means they can be declared in the same order as in the spec.
# SMPP PDU Definition - SMPP v3.4, section 4, page 45
mandatory_parameter_lists = {
'bind_transmitter':[ # SMPP v3.4, section 4.1.1, table 4-1, page 46
{'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None},
{'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'map':None},
{'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'map':None},
{'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'string', 'map':None},
{'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'map':None}
],
'bind_transmitter_resp':[ # SMPP v3.4, section 4.1.2, table 4-2, page 47
{'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None}
],
'bind_receiver':[ # SMPP v3.4, section 4.1.3, table 4-3, page 48
{'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None},
{'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'map':None},
{'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'map':None},
{'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'string', 'map':None},
{'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'map':None}
],
'bind_receiver_resp':[ # SMPP v3.4, section 4.1.4, table 4-4, page 50
{'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None}
],
'bind_transceiver':[ # SMPP v3.4, section 4.1.5, table 4-5, page 51
{'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None},
{'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'map':None},
{'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'map':None},
{'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'string', 'map':None},
{'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'map':None}
],
'bind_transceiver_resp':[ # SMPP v3.4, section 4.1.6, table 4-6, page 52
{'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None}
],
'outbind':[ # SMPP v3.4, section 4.1.7.1, page 54
{'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None},
{'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'map':None}
],
'unbind':[ # SMPP v3.4, section 4.2.1, table 4-7, page 56
],
'unbind_resp':[ # SMPP v3.4, section 4.2.2, table 4-8, page 56
],
'generic_nack':[ # SMPP v3.4, section 4.3.1, table 4-9, page 57
],
'submit_sm':[ # SMPP v3.4, section 4.4.1, table 4-10, page 59-61
{'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
{'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
{'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'map':None}
],
'submit_sm_resp':[ # SMPP v3.4, section 4.4.2, table 4-11, page 67
{'name':'message_id', 'min':0, 'max':65, 'var':True, 'type':'string', 'map':None}
],
'submit_multi':[ # SMPP v3.4, section 4.5.1, table 4-12, page 69-71
{'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'number_of_dests', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'dest_address', 'min':0, 'max':0, 'var':'number_of_dests', 'type':'dest_address', 'map':None},
{'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
{'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
{'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'map':None}
],
'dest_address':[ # SMPP v3.4, section 4.5.1.1, table 4-13, page 75
{'name':'dest_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None}
# 'sme_dest_address' or 'distribution_list' goes here
],
'sme_dest_address':[ # SMPP v3.4, section 4.5.1.1, table 4-14, page 75
{'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None}
],
'distribution_list':[ # SMPP v3.4, section 4.5.1.2, table 4-15, page 75
{'name':'dl_name', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None}
],
'submit_multi_resp':[ # SMPP v3.4, section 4.5.2, table 4-16, page 76
{'name':'message_id', 'min':0, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'no_unsuccess', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'unsuccess_sme', 'min':0, 'max':0, 'var':'no_unsuccess', 'type':'unsuccess_sme', 'map':None}
],
'unsuccess_sme':[ # SMPP v3.4, section 4.5.2.1, table 4-17, page 77
{'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'error_status_code', 'min':4, 'max':4, 'var':False, 'type':'integer', 'map':None}
],
'deliver_sm':[ # SMPP v3.4, section 4.6.1, table 4-18, page 79-81
{'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'schedule_delivery_time', 'min':1, 'max':1, 'var':False, 'type':'string', 'map':None},
{'name':'validity_period', 'min':1, 'max':1, 'var':False, 'type':'string', 'map':None},
{'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'map':None}
],
'deliver_sm_resp':[ # SMPP v3.4, section 4.6.2, table 4-19, page 85
{'name':'message_id', 'min':1, 'max':1, 'var':False, 'type':'string', 'map':None}
],
'data_sm':[ # SMPP v3.4, section 4.7.1, table 4-20, page 87-88
{'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'destination_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None}
],
'data_sm_resp':[ # SMPP v3.4, section 4.7.2, table 4-21, page 93
{'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None}
],
'query_sm':[ # SMPP v3.4, section 4.8.1, table 4-22, page 95
{'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None}
],
'query_sm_resp':[ # SMPP v3.4, section 4.7.2, table 4-21, page 93
{'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'final_date', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
{'name':'message_state', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'error_code', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None}
],
'cancel_sm':[ # SMPP v3.4, section 4.9.1, table 4-24, page 98-99
{'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'map':None},
{'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None}
],
'cancel_sm_resp':[ # SMPP v3.4, section 4.9.2, table 4-25, page 100
],
'replace_sm':[ # SMPP v3.4, section 4.10.1, table 4-26, page 102-103
{'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
{'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
{'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'map':None}
],
'replace_sm_resp':[ # SMPP v3.4, section 4.10.2, table 4-27, page 104
],
'enquire_link':[ # SMPP v3.4, section 4.11.1, table 4-28, page 106
],
'enquire_link_resp':[ # SMPP v3.4, section 4.11.2, table 4-29, page 106
],
'alert_notification':[ # SMPP v3.4, section 4.12.1, table 4-30, page 108
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'esme_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'esme_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'esme_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
]
}
def mandatory_parameter_list_by_command_name(command_name):
return mandatory_parameter_lists.get(command_name,[])
# Command IDs - SMPP v3.4, section 5.1.2.1, table 5-1, page 110-111
command_id_by_hex = {
'80000000':{'hex':'80000000', 'name':'generic_nack'},
'00000001':{'hex':'00000001', 'name':'bind_receiver'},
'80000001':{'hex':'80000001', 'name':'bind_receiver_resp'},
'00000002':{'hex':'00000002', 'name':'bind_transmitter'},
'80000002':{'hex':'80000002', 'name':'bind_transmitter_resp'},
'00000003':{'hex':'00000003', 'name':'query_sm'},
'80000003':{'hex':'80000003', 'name':'query_sm_resp'},
'00000004':{'hex':'00000004', 'name':'submit_sm'},
'80000004':{'hex':'80000004', 'name':'submit_sm_resp'},
'00000005':{'hex':'00000005', 'name':'deliver_sm'},
'80000005':{'hex':'80000005', 'name':'deliver_sm_resp'},
'00000006':{'hex':'00000006', 'name':'unbind'},
'80000006':{'hex':'80000006', 'name':'unbind_resp'},
'00000007':{'hex':'00000007', 'name':'replace_sm'},
'80000007':{'hex':'80000007', 'name':'replace_sm_resp'},
'00000008':{'hex':'00000008', 'name':'cancel_sm'},
'80000008':{'hex':'80000008', 'name':'cancel_sm_resp'},
'00000009':{'hex':'00000009', 'name':'bind_transceiver'},
'80000009':{'hex':'80000009', 'name':'bind_transceiver_resp'},
'0000000b':{'hex':'0000000b', 'name':'outbind'},
'00000015':{'hex':'00000015', 'name':'enquire_link'},
'80000015':{'hex':'80000015', 'name':'enquire_link_resp'},
'00000021':{'hex':'00000021', 'name':'submit_multi'},
'80000021':{'hex':'80000021', 'name':'submit_multi_resp'},
'00000102':{'hex':'00000102', 'name':'alert_notification'},
'00000103':{'hex':'00000103', 'name':'data_sm'},
'80000103':{'hex':'80000103', 'name':'data_sm_resp'},
# v4 codes
'80010000':{'hex':'80010000', 'name':'generic_nack_v4'},
'00010001':{'hex':'00010001', 'name':'bind_receiver_v4'},
'80010001':{'hex':'80010001', 'name':'bind_receiver_resp_v4'},
'00010002':{'hex':'00010002', 'name':'bind_transmitter_v4'},
'80010002':{'hex':'80010002', 'name':'bind_transmitter_resp_v4'},
'00010003':{'hex':'00010003', 'name':'query_sm_v4'},
'80010003':{'hex':'80010003', 'name':'query_sm_resp_v4'},
'00010004':{'hex':'00010004', 'name':'submit_sm_v4'},
'80010004':{'hex':'80010004', 'name':'submit_sm_resp_v4'},
'00010005':{'hex':'00010005', 'name':'deliver_sm_v4'},
'80010005':{'hex':'80010005', 'name':'deliver_sm_resp_v4'},
'00010006':{'hex':'00010006', 'name':'unbind_v4'},
'80010006':{'hex':'80010006', 'name':'unbind_resp_v4'},
'00010007':{'hex':'00010007', 'name':'replace_sm_v4'},
'80010007':{'hex':'80010007', 'name':'replace_sm_resp_v4'},
'00010008':{'hex':'00010008', 'name':'cancel_sm_v4'},
'80010008':{'hex':'80010008', 'name':'cancel_sm_resp_v4'},
'00010009':{'hex':'00010009', 'name':'delivery_receipt_v4'},
'80010009':{'hex':'80010009', 'name':'delivery_receipt_resp_v4'},
'0001000a':{'hex':'0001000a', 'name':'enquire_link_v4'},
'8001000a':{'hex':'8001000a', 'name':'enquire_link_resp_v4'},
'0001000b':{'hex':'0001000b', 'name':'outbind_v4'},
}
def command_id_name_by_hex(x):
return command_id_by_hex.get(x,{}).get('name')
command_id_by_name = {
'generic_nack' :{'hex':'80000000', 'name':'generic_nack'},
'bind_receiver' :{'hex':'00000001', 'name':'bind_receiver'},
'bind_receiver_resp' :{'hex':'80000001', 'name':'bind_receiver_resp'},
'bind_transmitter' :{'hex':'00000002', 'name':'bind_transmitter'},
'bind_transmitter_resp' :{'hex':'80000002', 'name':'bind_transmitter_resp'},
'query_sm' :{'hex':'00000003', 'name':'query_sm'},
'query_sm_resp' :{'hex':'80000003', 'name':'query_sm_resp'},
'submit_sm' :{'hex':'00000004', 'name':'submit_sm'},
'submit_sm_resp' :{'hex':'80000004', 'name':'submit_sm_resp'},
'deliver_sm' :{'hex':'00000005', 'name':'deliver_sm'},
'deliver_sm_resp' :{'hex':'80000005', 'name':'deliver_sm_resp'},
'unbind' :{'hex':'00000006', 'name':'unbind'},
'unbind_resp' :{'hex':'80000006', 'name':'unbind_resp'},
'replace_sm' :{'hex':'00000007', 'name':'replace_sm'},
'replace_sm_resp' :{'hex':'80000007', 'name':'replace_sm_resp'},
'cancel_sm' :{'hex':'00000008', 'name':'cancel_sm'},
'cancel_sm_resp' :{'hex':'80000008', 'name':'cancel_sm_resp'},
'bind_transceiver' :{'hex':'00000009', 'name':'bind_transceiver'},
'bind_transceiver_resp' :{'hex':'80000009', 'name':'bind_transceiver_resp'},
'outbind' :{'hex':'0000000b', 'name':'outbind'},
'enquire_link' :{'hex':'00000015', 'name':'enquire_link'},
'enquire_link_resp' :{'hex':'80000015', 'name':'enquire_link_resp'},
'submit_multi' :{'hex':'00000021', 'name':'submit_multi'},
'submit_multi_resp' :{'hex':'80000021', 'name':'submit_multi_resp'},
'alert_notification' :{'hex':'00000102', 'name':'alert_notification'},
'data_sm' :{'hex':'00000103', 'name':'data_sm'},
'data_sm_resp' :{'hex':'80000103', 'name':'data_sm_resp'},
# v4 codes
'generic_nack_v4' :{'hex':'80010000', 'name':'generic_nack_v4'},
'bind_receiver_v4' :{'hex':'00010001', 'name':'bind_receiver_v4'},
'bind_receiver_resp_v4' :{'hex':'80010001', 'name':'bind_receiver_resp_v4'},
'bind_transmitter_v4' :{'hex':'00010002', 'name':'bind_transmitter_v4'},
'bind_transmitter_resp_v4':{'hex':'80010002', 'name':'bind_transmitter_resp_v4'},
'query_sm_v4' :{'hex':'00010003', 'name':'query_sm_v4'},
'query_sm_resp_v4' :{'hex':'80010003', 'name':'query_sm_resp_v4'},
'submit_sm_v4' :{'hex':'00010004', 'name':'submit_sm_v4'},
'submit_sm_resp_v4' :{'hex':'80010004', 'name':'submit_sm_resp_v4'},
'deliver_sm_v4' :{'hex':'00010005', 'name':'deliver_sm_v4'},
'deliver_sm_resp_v4' :{'hex':'80010005', 'name':'deliver_sm_resp_v4'},
'unbind_v4' :{'hex':'00010006', 'name':'unbind_v4'},
'unbind_resp_v4' :{'hex':'80010006', 'name':'unbind_resp_v4'},
'replace_sm_v4' :{'hex':'00010007', 'name':'replace_sm_v4'},
'replace_sm_resp_v4' :{'hex':'80010007', 'name':'replace_sm_resp_v4'},
'cancel_sm_v4' :{'hex':'00010008', 'name':'cancel_sm_v4'},
'cancel_sm_resp_v4' :{'hex':'80010008', 'name':'cancel_sm_resp_v4'},
'delivery_receipt_v4' :{'hex':'00010009', 'name':'delivery_receipt_v4'},
'delivery_receipt_resp_v4':{'hex':'80010009', 'name':'delivery_receipt_resp_v4'},
'enquire_link_v4' :{'hex':'0001000a', 'name':'enquire_link_v4'},
'enquire_link_resp_v4' :{'hex':'8001000a', 'name':'enquire_link_resp_v4'},
'outbind_v4' :{'hex':'0001000b', 'name':'outbind_v4'}
}
def command_id_hex_by_name(n):
return command_id_by_name.get(n,{}).get('hex')
# SMPP Error Codes (ESME) - SMPP v3.4, section 5.1.3, table 5-2, page 112-114
command_status_by_hex = {
'00000000':{'hex':'00000000', 'name':'ESME_ROK', 'description':'No error'},
'00000001':{'hex':'00000001', 'name':'ESME_RINVMSGLEN', 'description':'Message Length is invalid'},
'00000002':{'hex':'00000002', 'name':'ESME_RINVCMDLEN', 'description':'Command Length is invalid'},
'00000003':{'hex':'00000003', 'name':'ESME_RINVCMDID', 'description':'Invalid Command ID'},
'00000004':{'hex':'00000004', 'name':'ESME_RINVBNDSTS', 'description':'Incorrect BIND Status for given command'},
'00000005':{'hex':'00000005', 'name':'ESME_RALYBND', 'description':'ESME Already in bound state'},
'00000006':{'hex':'00000006', 'name':'ESME_RINVPRTFLG', 'description':'Invalid priority flag'},
'00000007':{'hex':'00000007', 'name':'ESME_RINVREGDLVFLG', 'description':'Invalid registered delivery flag'},
'00000008':{'hex':'00000008', 'name':'ESME_RSYSERR', 'description':'System Error'},
'0000000a':{'hex':'0000000a', 'name':'ESME_RINVSRCADR', 'description':'Invalid source address'},
'0000000b':{'hex':'0000000b', 'name':'ESME_RINVDSTADR', 'description':'Invalid destination address'},
'0000000c':{'hex':'0000000c', 'name':'ESME_RINVMSGID', 'description':'Message ID is invalid'},
'0000000d':{'hex':'0000000d', 'name':'ESME_RBINDFAIL', 'description':'Bind failed'},
'0000000e':{'hex':'0000000e', 'name':'ESME_RINVPASWD', 'description':'Invalid password'},
'0000000f':{'hex':'0000000f', 'name':'ESME_RINVSYSID', 'description':'Invalid System ID'},
'00000011':{'hex':'00000011', 'name':'ESME_RCANCELFAIL', 'description':'Cancel SM Failed'},
'00000013':{'hex':'00000013', 'name':'ESME_RREPLACEFAIL', 'description':'Replace SM Failed'},
'00000014':{'hex':'00000014', 'name':'ESME_RMSGQFUL', 'description':'Message queue full'},
'00000015':{'hex':'00000015', 'name':'ESME_RINVSERTYP', 'description':'Invalid service type'},
'00000033':{'hex':'00000033', 'name':'ESME_RINVNUMDESTS', 'description':'Invalid number of destinations'},
'00000034':{'hex':'00000034', 'name':'ESME_RINVDLNAME', 'description':'Invalid distribution list name'},
'00000040':{'hex':'00000040', 'name':'ESME_RINVDESTFLAG', 'description':'Destination flag is invalid (submit_multi)'},
'00000042':{'hex':'00000042', 'name':'ESME_RINVSUBREP', 'description':"Invalid `submit with replace' request (i.e. submit_sm with replace_if_present_flag set)"},
'00000043':{'hex':'00000043', 'name':'ESME_RINVESMCLASS', 'description':'Invalid esm_class field data'},
'00000044':{'hex':'00000044', 'name':'ESME_RCNTSUBDL', 'description':'Cannot submit to distribution list'},
'00000045':{'hex':'00000045', 'name':'ESME_RSUBMITFAIL', 'description':'submit_sm or submit_multi failed'},
'00000048':{'hex':'00000048', 'name':'ESME_RINVSRCTON', 'description':'Invalid source address TON'},
'00000049':{'hex':'00000049', 'name':'ESME_RINVSRCNPI', 'description':'Invalid source address NPI'},
'00000050':{'hex':'00000050', 'name':'ESME_RINVDSTTON', 'description':'Invalid destination address TON'},
'00000051':{'hex':'00000051', 'name':'ESME_RINVDSTNPI', 'description':'Invalid destination address NPI'},
'00000053':{'hex':'00000053', 'name':'ESME_RINVSYSTYP', 'description':'Invalid system_type field'},
'00000054':{'hex':'00000054', 'name':'ESME_RINVREPFLAG', 'description':'Invalid replace_if_present flag'},
'00000055':{'hex':'00000055', 'name':'ESME_RINVNUMMSGS', 'description':'Invalid number of messages'},
'00000058':{'hex':'00000058', 'name':'ESME_RTHROTTLED', 'description':'Throttling error (ESME has exceeded allowed message limits)'},
'00000061':{'hex':'00000061', 'name':'ESME_RINVSCHED', 'description':'Invalid scheduled delivery time'},
'00000062':{'hex':'00000062', 'name':'ESME_RINVEXPIRY', 'description':'Invalid message validity period (expiry time)'},
'00000063':{'hex':'00000063', 'name':'ESME_RINVDFTMSGID', 'description':'Predefined message invalid or not found'},
'00000064':{'hex':'00000064', 'name':'ESME_RX_T_APPN', 'description':'ESME Receiver Temporary App Error Code'},
'00000065':{'hex':'00000065', 'name':'ESME_RX_P_APPN', 'description':'ESME Receiver Permanent App Error Code'},
'00000066':{'hex':'00000066', 'name':'ESME_RX_R_APPN', 'description':'ESME Receiver Reject Message Error Code'},
'00000067':{'hex':'00000067', 'name':'ESME_RQUERYFAIL', 'description':'query_sm request failed'},
'000000c0':{'hex':'000000c0', 'name':'ESME_RINVOPTPARSTREAM', 'description':'Error in the optional part of the PDU Body'},
'000000c1':{'hex':'000000c1', 'name':'ESME_ROPTPARNOTALLWD', 'description':'Optional paramenter not allowed'},
'000000c2':{'hex':'000000c2', 'name':'ESME_RINVPARLEN', 'description':'Invalid parameter length'},
'000000c3':{'hex':'000000c3', 'name':'ESME_RMISSINGOPTPARAM', 'description':'Expected optional parameter missing'},
'000000c4':{'hex':'000000c4', 'name':'ESME_RINVOPTPARAMVAL', 'description':'Invalid optional parameter value'},
'000000fe':{'hex':'000000fe', 'name':'ESME_RDELIVERYFAILURE', 'description':'Delivery Failure (used for data_sm_resp)'},
'000000ff':{'hex':'000000ff', 'name':'ESME_RUNKNOWNERR', 'description':'Unknown error'}
}
def command_status_name_by_hex(x):
return command_status_by_hex.get(x,{}).get('name')
command_status_by_name = {
'ESME_ROK' :{'hex':'00000000', 'name':'ESME_ROK', 'description':'No error'},
'ESME_RINVMSGLEN' :{'hex':'00000001', 'name':'ESME_RINVMSGLEN', 'description':'Message Length is invalid'},
'ESME_RINVCMDLEN' :{'hex':'00000002', 'name':'ESME_RINVCMDLEN', 'description':'Command Length is invalid'},
'ESME_RINVCMDID' :{'hex':'00000003', 'name':'ESME_RINVCMDID', 'description':'Invalid Command ID'},
'ESME_RINVBNDSTS' :{'hex':'00000004', 'name':'ESME_RINVBNDSTS', 'description':'Incorrect BIND Status for given command'},
'ESME_RALYBND' :{'hex':'00000005', 'name':'ESME_RALYBND', 'description':'ESME Already in bound state'},
'ESME_RINVPRTFLG' :{'hex':'00000006', 'name':'ESME_RINVPRTFLG', 'description':'Invalid priority flag'},
'ESME_RINVREGDLVFLG' :{'hex':'00000007', 'name':'ESME_RINVREGDLVFLG', 'description':'Invalid registered delivery flag'},
'ESME_RSYSERR' :{'hex':'00000008', 'name':'ESME_RSYSERR', 'description':'System Error'},
'ESME_RINVSRCADR' :{'hex':'0000000a', 'name':'ESME_RINVSRCADR', 'description':'Invalid source address'},
'ESME_RINVDSTADR' :{'hex':'0000000b', 'name':'ESME_RINVDSTADR', 'description':'Invalid destination address'},
'ESME_RINVMSGID' :{'hex':'0000000c', 'name':'ESME_RINVMSGID', 'description':'Message ID is invalid'},
'ESME_RBINDFAIL' :{'hex':'0000000d', 'name':'ESME_RBINDFAIL', 'description':'Bind failed'},
'ESME_RINVPASWD' :{'hex':'0000000e', 'name':'ESME_RINVPASWD', 'description':'Invalid password'},
'ESME_RINVSYSID' :{'hex':'0000000f', 'name':'ESME_RINVSYSID', 'description':'Invalid System ID'},
'ESME_RCANCELFAIL' :{'hex':'00000011', 'name':'ESME_RCANCELFAIL', 'description':'Cancel SM Failed'},
'ESME_RREPLACEFAIL' :{'hex':'00000013', 'name':'ESME_RREPLACEFAIL', 'description':'Replace SM Failed'},
'ESME_RMSGQFUL' :{'hex':'00000014', 'name':'ESME_RMSGQFUL', 'description':'Message queue full'},
'ESME_RINVSERTYP' :{'hex':'00000015', 'name':'ESME_RINVSERTYP', 'description':'Invalid service type'},
'ESME_RINVNUMDESTS' :{'hex':'00000033', 'name':'ESME_RINVNUMDESTS', 'description':'Invalid number of destinations'},
'ESME_RINVDLNAME' :{'hex':'00000034', 'name':'ESME_RINVDLNAME', 'description':'Invalid distribution list name'},
'ESME_RINVDESTFLAG' :{'hex':'00000040', 'name':'ESME_RINVDESTFLAG', 'description':'Destination flag is invalid (submit_multi)'},
'ESME_RINVSUBREP' :{'hex':'00000042', 'name':'ESME_RINVSUBREP', 'description':"Invalid `submit with replace' request (i.e. submit_sm with replace_if_present_flag set)"},
'ESME_RINVESMCLASS' :{'hex':'00000043', 'name':'ESME_RINVESMCLASS', 'description':'Invalid esm_class field data'},
'ESME_RCNTSUBDL' :{'hex':'00000044', 'name':'ESME_RCNTSUBDL', 'description':'Cannot submit to distribution list'},
'ESME_RSUBMITFAIL' :{'hex':'00000045', 'name':'ESME_RSUBMITFAIL', 'description':'submit_sm or submit_multi failed'},
'ESME_RINVSRCTON' :{'hex':'00000048', 'name':'ESME_RINVSRCTON', 'description':'Invalid source address TON'},
'ESME_RINVSRCNPI' :{'hex':'00000049', 'name':'ESME_RINVSRCNPI', 'description':'Invalid source address NPI'},
'ESME_RINVDSTTON' :{'hex':'00000050', 'name':'ESME_RINVDSTTON', 'description':'Invalid destination address TON'},
'ESME_RINVDSTNPI' :{'hex':'00000051', 'name':'ESME_RINVDSTNPI', 'description':'Invalid destination address NPI'},
'ESME_RINVSYSTYP' :{'hex':'00000053', 'name':'ESME_RINVSYSTYP', 'description':'Invalid system_type field'},
'ESME_RINVREPFLAG' :{'hex':'00000054', 'name':'ESME_RINVREPFLAG', 'description':'Invalid replace_if_present flag'},
'ESME_RINVNUMMSGS' :{'hex':'00000055', 'name':'ESME_RINVNUMMSGS', 'description':'Invalid number of messages'},
'ESME_RTHROTTLED' :{'hex':'00000058', 'name':'ESME_RTHROTTLED', 'description':'Throttling error (ESME has exceeded allowed message limits)'},
'ESME_RINVSCHED' :{'hex':'00000061', 'name':'ESME_RINVSCHED', 'description':'Invalid scheduled delivery time'},
'ESME_RINVEXPIRY' :{'hex':'00000062', 'name':'ESME_RINVEXPIRY', 'description':'Invalid message validity period (expiry time)'},
'ESME_RINVDFTMSGID' :{'hex':'00000063', 'name':'ESME_RINVDFTMSGID', 'description':'Predefined message invalid or not found'},
'ESME_RX_T_APPN' :{'hex':'00000064', 'name':'ESME_RX_T_APPN', 'description':'ESME Receiver Temporary App Error Code'},
'ESME_RX_P_APPN' :{'hex':'00000065', 'name':'ESME_RX_P_APPN', 'description':'ESME Receiver Permanent App Error Code'},
'ESME_RX_R_APPN' :{'hex':'00000066', 'name':'ESME_RX_R_APPN', 'description':'ESME Receiver Reject Message Error Code'},
'ESME_RQUERYFAIL' :{'hex':'00000067', 'name':'ESME_RQUERYFAIL', 'description':'query_sm request failed'},
'ESME_RINVOPTPARSTREAM':{'hex':'000000c0', 'name':'ESME_RINVOPTPARSTREAM', 'description':'Error in the optional part of the PDU Body'},
'ESME_ROPTPARNOTALLWD' :{'hex':'000000c1', 'name':'ESME_ROPTPARNOTALLWD', 'description':'Optional paramenter not allowed'},
'ESME_RINVPARLEN' :{'hex':'000000c2', 'name':'ESME_RINVPARLEN', 'description':'Invalid parameter length'},
'ESME_RMISSINGOPTPARAM':{'hex':'000000c3', 'name':'ESME_RMISSINGOPTPARAM', 'description':'Expected optional parameter missing'},
'ESME_RINVOPTPARAMVAL' :{'hex':'000000c4', 'name':'ESME_RINVOPTPARAMVAL', 'description':'Invalid optional parameter value'},
'ESME_RDELIVERYFAILURE':{'hex':'000000fe', 'name':'ESME_RDELIVERYFAILURE', 'description':'Delivery Failure (used for data_sm_resp)'},
'ESME_RUNKNOWNERR' :{'hex':'000000ff', 'name':'ESME_RUNKNOWNERR', 'description':'Unknown error'}
}
def command_status_hex_by_name(n):
return command_status_by_name.get(n,{}).get('hex')
# Type of Number (TON) - SMPP v3.4, section 5.2.5, table 5-3, page 117
maps['addr_ton_by_name'] = {
'unknown' :'00',
'international' :'01',
'national' :'02',
'network_specific' :'03',
'subscriber_number':'04',
'alphanumeric' :'05',
'abbreviated' :'06'
}
maps['addr_ton_by_hex'] = {
'00':'unknown',
'01':'international',
'02':'national',
'03':'network_specific',
'04':'subscriber_number',
'05':'alphanumeric',
'06':'abbreviated'
}
# Numberic Plan Indicator (NPI) - SMPP v3.4, section 5.2.6, table 5-4, page 118
maps['addr_npi_by_name'] = {
'unknown' :'00',
'ISDN' :'01',
'data' :'03',
'telex' :'04',
'land_mobile':'06',
'national' :'08',
'private' :'09',
'ERMES' :'0a',
'internet' :'0e',
'WAP' :'12'
}
maps['addr_npi_by_hex'] = {
'00':'unknown',
'01':'ISDN',
'03':'data',
'04':'telex',
'06':'land_mobile',
'08':'national',
'09':'private',
'0a':'ERMES',
'0e':'internet',
'12':'WAP'
}
# ESM Class bits - SMPP v3.4, section 5.2.12, page 121
maps['esm_class_bits'] = {
'mode_mask' :'03',
'type_mask' :'3c',
'feature_mask' :'c0',
'mode_default' :'00',
'mode_datagram' :'01',
'mode_forward' :'02',
'mode_store_and_forward' :'03',
'type_default' :'00',
'type_delivery_receipt' :'04',
'type_delivery_ack' :'08',
'type_0011' :'0a',
'type_user_ack' :'10',
'type_0101' :'14',
'type_conversation_abort' :'18',
'type_0111' :'1a',
'type_intermed_deliv_notif' :'20',
'type_1001' :'24',
'type_1010' :'28',
'type_1011' :'2a',
'type_1100' :'30',
'type_1101' :'34',
'type_1110' :'38',
'type_1111' :'3a',
'feature_none' :'00',
'feature_UDHI' :'40',
'feature_reply_path' :'80',
'feature_UDHI_and_reply_path':'c0'
}
# Registered Delivery bits - SMPP v3.4, section 5.2.17, page 124
maps['registered_delivery_bits'] = {
'receipt_mask' :'03',
'ack_mask' :'0c',
'intermed_notif_mask' :'80',
'receipt_none' :'00',
'receipt_always' :'01',
'receipt_on_fail' :'02',
'receipt_res' :'03',
'ack_none' :'00',
'ack_delivery' :'04',
'ack_user' :'08',
'ack_delivery_and_user':'0c',
'intermed_notif_none' :'00',
'intermed_notif' :'10'
}
# submit_multi dest_flag constants - SMPP v3.4, section 5.2.25, page 129
#maps['dest_flag_by_name'] = {
#'SME Address' :1,
#'Distribution List Name':2
#}
# Message State codes returned in query_sm_resp PDUs - SMPP v3.4, section 5.2.28, table 5-6, page 130
maps['message_state_by_name'] = {
'ENROUTE' :1,
'DELIVERED' :2,
'EXPIRED' :3,
'DELETED' :4,
'UNDELIVERABLE':5,
'ACCEPTED' :6,
'UNKNOWN' :7,
'REJECTED' :8
}
# Facility Code bits for SMPP v4
maps['facility_code_bits'] = {
'GF_PVCY' :'00000001',
'GF_SUBADDR':'00000002',
'NF_CC' :'00080000',
'NF_PDC' :'00010000',
'NF_IS136' :'00020000',
'NF_IS95A' :'00040000'
}
# Optional Parameter Tags - SMPP v3.4, section 5.3.2, Table 5-7, page 132-133
optional_parameter_tag_by_hex = {
'0005':{'hex':'0005', 'name':'dest_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.1, page 134
'0006':{'hex':'0006', 'name':'dest_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.3, page 135
'0007':{'hex':'0007', 'name':'dest_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.5, page 136
'0008':{'hex':'0008', 'name':'dest_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.7, page 137
'000d':{'hex':'000d', 'name':'source_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.2, page 134
'000e':{'hex':'000e', 'name':'source_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.4, page 135
'000f':{'hex':'000f', 'name':'source_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.6, page 136
'0010':{'hex':'0010', 'name':'source_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.8, page 137
'0017':{'hex':'0017', 'name':'qos_time_to_live', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.9, page 138
'0019':{'hex':'0019', 'name':'payload_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.10, page 138
'001d':{'hex':'001d', 'name':'additional_status_info_text', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.11, page 139
'001e':{'hex':'001e', 'name':'receipted_message_id', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.12, page 139
'0030':{'hex':'0030', 'name':'ms_msg_wait_facilities', 'type':'bitmask', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.13, page 140
'0101':{'hex':'0101', 'name':'PVCY_AuthenticationStr', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 58-62
'0201':{'hex':'0201', 'name':'privacy_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.14, page 141
'0202':{'hex':'0202', 'name':'source_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.15, page 142
'0203':{'hex':'0203', 'name':'dest_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.16, page 143
'0204':{'hex':'0204', 'name':'user_message_reference', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.17, page 143
'0205':{'hex':'0205', 'name':'user_response_code', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.18, page 144
'020a':{'hex':'020a', 'name':'source_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.20, page 145
'020b':{'hex':'020b', 'name':'destination_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.21, page 145
'020c':{'hex':'020c', 'name':'sar_msg_ref_num', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.22, page 146
'020d':{'hex':'020d', 'name':'language_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.19, page 144
'020e':{'hex':'020e', 'name':'sar_total_segments', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.23, page 147
'020f':{'hex':'020f', 'name':'sar_segment_seqnum', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.24, page 147
'0210':{'hex':'0210', 'name':'sc_interface_version', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.25, page 148
'0301':{'hex':'0301', 'name':'CC_CBN', 'type':None, 'tech':'V4'}, # v4 page 70
'0302':{'hex':'0302', 'name':'callback_num_pres_ind', 'type':'bitmask', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.37, page 156
'0303':{'hex':'0303', 'name':'callback_num_atag', 'type':'hex', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.38, page 157
'0304':{'hex':'0304', 'name':'number_of_messages', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.39, page 158
'0381':{'hex':'0381', 'name':'callback_num', 'type':'hex', 'tech':'CDMA, TDMA, GSM, iDEN'}, # SMPP v3.4, section 5.3.2.36, page 155
'0420':{'hex':'0420', 'name':'dpf_result', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.28, page 149
'0421':{'hex':'0421', 'name':'set_dpf', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.29, page 150
'0422':{'hex':'0422', 'name':'ms_availability_status', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.30, page 151
'0423':{'hex':'0423', 'name':'network_error_code', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.31, page 152
'0424':{'hex':'0424', 'name':'message_payload', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.32, page 153
'0425':{'hex':'0425', 'name':'delivery_failure_reason', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.33, page 153
'0426':{'hex':'0426', 'name':'more_messages_to_send', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.34, page 154
'0427':{'hex':'0427', 'name':'message_state', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.35, page 154
'0428':{'hex':'0428', 'name':'congestion_state', 'type':None, 'tech':'Generic'},
'0501':{'hex':'0501', 'name':'ussd_service_op', 'type':'hex', 'tech':'GSM (USSD)'}, # SMPP v3.4, section 5.3.2.44, page 161
'0600':{'hex':'0600', 'name':'broadcast_channel_indicator', 'type':None, 'tech':'GSM'},
'0601':{'hex':'0601', 'name':'broadcast_content_type', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'0602':{'hex':'0602', 'name':'broadcast_content_type_info', 'type':None, 'tech':'CDMA, TDMA'},
'0603':{'hex':'0603', 'name':'broadcast_message_class', 'type':None, 'tech':'GSM'},
'0604':{'hex':'0604', 'name':'broadcast_rep_num', 'type':None, 'tech':'GSM'},
'0605':{'hex':'0605', 'name':'broadcast_frequency_interval', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'0606':{'hex':'0606', 'name':'broadcast_area_identifier', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'0607':{'hex':'0607', 'name':'broadcast_error_status', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'0608':{'hex':'0608', 'name':'broadcast_area_success', 'type':None, 'tech':'GSM'},
'0609':{'hex':'0609', 'name':'broadcast_end_time', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'060a':{'hex':'060a', 'name':'broadcast_service_group', 'type':None, 'tech':'CDMA, TDMA'},
'060b':{'hex':'060b', 'name':'billing_identification', 'type':None, 'tech':'Generic'},
'060d':{'hex':'060d', 'name':'source_network_id', 'type':None, 'tech':'Generic'},
'060e':{'hex':'060e', 'name':'dest_network_id', 'type':None, 'tech':'Generic'},
'060f':{'hex':'060f', 'name':'source_node_id', 'type':None, 'tech':'Generic'},
'0610':{'hex':'0610', 'name':'dest_node_id', 'type':None, 'tech':'Generic'},
'0611':{'hex':'0611', 'name':'dest_addr_np_resolution', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'0612':{'hex':'0612', 'name':'dest_addr_np_information', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'0613':{'hex':'0613', 'name':'dest_addr_np_country', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'1101':{'hex':'1101', 'name':'PDC_MessageClass', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 75
'1102':{'hex':'1102', 'name':'PDC_PresentationOption', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
'1103':{'hex':'1103', 'name':'PDC_AlertMechanism', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
'1104':{'hex':'1104', 'name':'PDC_Teleservice', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
'1105':{'hex':'1105', 'name':'PDC_MultiPartMessage', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
'1106':{'hex':'1106', 'name':'PDC_PredefinedMsg', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 78
'1201':{'hex':'1201', 'name':'display_time', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.26, page 148
'1203':{'hex':'1203', 'name':'sms_signal', 'type':'integer', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.40, page 158
'1204':{'hex':'1204', 'name':'ms_validity', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.27, page 149
'1304':{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'type':None, 'tech':'CDMA'}, # v4 page 85
'1306':{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'type':None, 'tech':'CDMA'}, # v4 page 86
'130c':{'hex':'130c', 'name':'alert_on_message_delivery', 'type':None, 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.41, page 159
'1380':{'hex':'1380', 'name':'its_reply_type', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.42, page 159
'1383':{'hex':'1383', 'name':'its_session_info', 'type':'hex', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.43, page 160
'1402':{'hex':'1402', 'name':'operator_id', 'type':None, 'tech':'vendor extension'},
'1403':{'hex':'1403', 'name':'tariff', 'type':None, 'tech':'Mobile Network Code vendor extension'},
'1450':{'hex':'1450', 'name':'mcc', 'type':None, 'tech':'Mobile Country Code vendor extension'},
'1451':{'hex':'1451', 'name':'mnc', 'type':None, 'tech':'Mobile Network Code vendor extension'}
}
def optional_parameter_tag_name_by_hex(x):
return optional_parameter_tag_by_hex.get(x,{}).get('name')
def optional_parameter_tag_type_by_hex(x):
return optional_parameter_tag_by_hex.get(x,{}).get('type')
optional_parameter_tag_by_name = {
'dest_addr_subunit' :{'hex':'0005', 'name':'dest_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.1, page 134
'dest_network_type' :{'hex':'0006', 'name':'dest_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.3, page 135
'dest_bearer_type' :{'hex':'0007', 'name':'dest_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.5, page 136
'dest_telematics_id' :{'hex':'0008', 'name':'dest_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.7, page 137
'source_addr_subunit' :{'hex':'000d', 'name':'source_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.2, page 134
'source_network_type' :{'hex':'000e', 'name':'source_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.4, page 135
'source_bearer_type' :{'hex':'000f', 'name':'source_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.6, page 136
'source_telematics_id' :{'hex':'0010', 'name':'source_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.8, page 137
'qos_time_to_live' :{'hex':'0017', 'name':'qos_time_to_live', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.9, page 138
'payload_type' :{'hex':'0019', 'name':'payload_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.10, page 138
'additional_status_info_text' :{'hex':'001d', 'name':'additional_status_info_text', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.11, page 139
'receipted_message_id' :{'hex':'001e', 'name':'receipted_message_id', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.12, page 139
'ms_msg_wait_facilities' :{'hex':'0030', 'name':'ms_msg_wait_facilities', 'type':'bitmask', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.13, page 140
'PVCY_AuthenticationStr' :{'hex':'0101', 'name':'PVCY_AuthenticationStr', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 58-62
'privacy_indicator' :{'hex':'0201', 'name':'privacy_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.14, page 141
'source_subaddress' :{'hex':'0202', 'name':'source_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.15, page 142
'dest_subaddress' :{'hex':'0203', 'name':'dest_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.16, page 143
'user_message_reference' :{'hex':'0204', 'name':'user_message_reference', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.17, page 143
'user_response_code' :{'hex':'0205', 'name':'user_response_code', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.18, page 144
'source_port' :{'hex':'020a', 'name':'source_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.20, page 145
'destination_port' :{'hex':'020b', 'name':'destination_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.21, page 145
'sar_msg_ref_num' :{'hex':'020c', 'name':'sar_msg_ref_num', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.22, page 146
'language_indicator' :{'hex':'020d', 'name':'language_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.19, page 144
'sar_total_segments' :{'hex':'020e', 'name':'sar_total_segments', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.23, page 147
'sar_segment_seqnum' :{'hex':'020f', 'name':'sar_segment_seqnum', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.24, page 147
'sc_interface_version' :{'hex':'0210', 'name':'sc_interface_version', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.25, page 148
'CC_CBN' :{'hex':'0301', 'name':'CC_CBN', 'type':None, 'tech':'V4'}, # v4 page 70
'callback_num_pres_ind' :{'hex':'0302', 'name':'callback_num_pres_ind', 'type':'bitmask', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.37, page 156
'callback_num_atag' :{'hex':'0303', 'name':'callback_num_atag', 'type':'hex', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.38, page 157
'number_of_messages' :{'hex':'0304', 'name':'number_of_messages', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.39, page 158
'callback_num' :{'hex':'0381', 'name':'callback_num', 'type':'hex', 'tech':'CDMA, TDMA, GSM, iDEN'}, # SMPP v3.4, section 5.3.2.36, page 155
'dpf_result' :{'hex':'0420', 'name':'dpf_result', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.28, page 149
'set_dpf' :{'hex':'0421', 'name':'set_dpf', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.29, page 150
'ms_availability_status' :{'hex':'0422', 'name':'ms_availability_status', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.30, page 151
'network_error_code' :{'hex':'0423', 'name':'network_error_code', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.31, page 152
'message_payload' :{'hex':'0424', 'name':'message_payload', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.32, page 153
'delivery_failure_reason' :{'hex':'0425', 'name':'delivery_failure_reason', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.33, page 153
'more_messages_to_send' :{'hex':'0426', 'name':'more_messages_to_send', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.34, page 154
'message_state' :{'hex':'0427', 'name':'message_state', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.35, page 154
'congestion_state' :{'hex':'0428', 'name':'congestion_state', 'type':None, 'tech':'Generic'},
'ussd_service_op' :{'hex':'0501', 'name':'ussd_service_op', 'type':'hex', 'tech':'GSM (USSD)'}, # SMPP v3.4, section 5.3.2.44, page 161
'broadcast_channel_indicator' :{'hex':'0600', 'name':'broadcast_channel_indicator', 'type':None, 'tech':'GSM'},
'broadcast_content_type' :{'hex':'0601', 'name':'broadcast_content_type', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_content_type_info' :{'hex':'0602', 'name':'broadcast_content_type_info', 'type':None, 'tech':'CDMA, TDMA'},
'broadcast_message_class' :{'hex':'0603', 'name':'broadcast_message_class', 'type':None, 'tech':'GSM'},
'broadcast_rep_num' :{'hex':'0604', 'name':'broadcast_rep_num', 'type':None, 'tech':'GSM'},
'broadcast_frequency_interval':{'hex':'0605', 'name':'broadcast_frequency_interval', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_area_identifier' :{'hex':'0606', 'name':'broadcast_area_identifier', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_error_status' :{'hex':'0607', 'name':'broadcast_error_status', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_area_success' :{'hex':'0608', 'name':'broadcast_area_success', 'type':None, 'tech':'GSM'},
'broadcast_end_time' :{'hex':'0609', 'name':'broadcast_end_time', 'type':None, 'tech':'CDMA, TDMA, GSM'},
'broadcast_service_group' :{'hex':'060a', 'name':'broadcast_service_group', 'type':None, 'tech':'CDMA, TDMA'},
'billing_identification' :{'hex':'060b', 'name':'billing_identification', 'type':None, 'tech':'Generic'},
'source_network_id' :{'hex':'060d', 'name':'source_network_id', 'type':None, 'tech':'Generic'},
'dest_network_id' :{'hex':'060e', 'name':'dest_network_id', 'type':None, 'tech':'Generic'},
'source_node_id' :{'hex':'060f', 'name':'source_node_id', 'type':None, 'tech':'Generic'},
'dest_node_id' :{'hex':'0610', 'name':'dest_node_id', 'type':None, 'tech':'Generic'},
'dest_addr_np_resolution' :{'hex':'0611', 'name':'dest_addr_np_resolution', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'dest_addr_np_information' :{'hex':'0612', 'name':'dest_addr_np_information', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'dest_addr_np_country' :{'hex':'0613', 'name':'dest_addr_np_country', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
'PDC_MessageClass' :{'hex':'1101', 'name':'PDC_MessageClass', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 75
'PDC_PresentationOption' :{'hex':'1102', 'name':'PDC_PresentationOption', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
'PDC_AlertMechanism' :{'hex':'1103', 'name':'PDC_AlertMechanism', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
'PDC_Teleservice' :{'hex':'1104', 'name':'PDC_Teleservice', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
'PDC_MultiPartMessage' :{'hex':'1105', 'name':'PDC_MultiPartMessage', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
'PDC_PredefinedMsg' :{'hex':'1106', 'name':'PDC_PredefinedMsg', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 78
'display_time' :{'hex':'1201', 'name':'display_time', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.26, page 148
'sms_signal' :{'hex':'1203', 'name':'sms_signal', 'type':'integer', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.40, page 158
'ms_validity' :{'hex':'1204', 'name':'ms_validity', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.27, page 149
'IS95A_AlertOnDelivery' :{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'type':None, 'tech':'CDMA'}, # v4 page 85
'IS95A_LanguageIndicator' :{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'type':None, 'tech':'CDMA'}, # v4 page 86
'alert_on_message_delivery' :{'hex':'130c', 'name':'alert_on_message_delivery', 'type':None, 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.41, page 159
'its_reply_type' :{'hex':'1380', 'name':'its_reply_type', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.42, page 159
'its_session_info' :{'hex':'1383', 'name':'its_session_info', 'type':'hex', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.43, page 160
'operator_id' :{'hex':'1402', 'name':'operator_id', 'type':None, 'tech':'vendor extension'},
'tariff' :{'hex':'1403', 'name':'tariff', 'type':None, 'tech':'Mobile Network Code vendor extension'},
'mcc' :{'hex':'1450', 'name':'mcc', 'type':None, 'tech':'Mobile Country Code vendor extension'},
'mnc' :{'hex':'1451', 'name':'mnc', 'type':None, 'tech':'Mobile Network Code vendor extension'}
}
def optional_parameter_tag_hex_by_name(n):
return optional_parameter_tag_by_name.get(n,{}).get('hex')
#### Decoding functions #######################################################
def unpack_pdu(pdu_bin):
#return binascii.b2a_hex(pdu_bin)
return decode_pdu(binascii.b2a_hex(pdu_bin))
def decode_pdu(pdu_hex):
- print '\n===================================================='
hex_ref = [pdu_hex]
pdu = {}
pdu['header'] = decode_header(hex_ref)
command = pdu['header'].get('command_id', None)
if command != None:
- pdu['body'] = decode_body(command, hex_ref)
- print '====================================================\n'
+ body = decode_body(command, hex_ref)
+ if len(body) > 0:
+ pdu['body'] = body
return pdu
def decode_header(hex_ref):
pdu_hex = hex_ref[0]
header = {}
(command_length, command_id, command_status, sequence_number, hex_ref[0]) = \
(pdu_hex[0:8], pdu_hex[8:16], pdu_hex[16:24], pdu_hex[24:32], pdu_hex[32: ])
length = int(command_length, 16)
command = command_id_name_by_hex(command_id)
status = command_status_name_by_hex(command_status)
sequence = int(sequence_number, 16)
header = {}
header['command_length'] = length
header['command_id'] = command
header['command_status'] = status
header['sequence_number'] = sequence
- print 'h==>', 'command_length', ':', repr(header['command_length'])
- print 'h==>', 'command_id', ':', repr(header['command_id'])
- print 'h==>', 'command_status', ':', repr(header['command_status'])
- print 'h==>', 'sequence_number', ':', repr(header['sequence_number'])
return header
def decode_body(command, hex_ref):
body = {}
- body['mandatory_parameters'] = None
if command != None:
fields = mandatory_parameter_list_by_command_name(command)
- body['mandatory_parameters'] = decode_mandatory_parameters(fields, hex_ref)
- body['optional_parameters'] = decode_optional_parameters(hex_ref)
+ mandatory = decode_mandatory_parameters(fields, hex_ref)
+ if len(mandatory) > 0:
+ body['mandatory_parameters'] = mandatory
+ optional = decode_optional_parameters(hex_ref)
+ if len(optional) > 0:
+ body['optional_parameters'] = optional
return body
def decode_mandatory_parameters(fields, hex_ref):
mandatory_parameters = {}
if len(hex_ref[0]) > 1:
for field in fields:
data = ''
octet = ''
count = 0
if field['var'] == True or field['var'] == False:
while (len(hex_ref[0]) > 1
and (count < field['min']
or (count < field['max']
and octet != '00'))):
octet = octpop(hex_ref)
data += octet
count += 1
elif field['type'] == 'string':
count = mandatory_parameters[field['var']]
for i in range(count):
if len(hex_ref[0]) > 1:
data += octpop(hex_ref)
else:
count = mandatory_parameters[field['var']]
if field['map'] != None:
mandatory_parameters[field['name']] = maps.get(field['map']+'_by_hex',{data:data})[data]
else:
mandatory_parameters[field['name']] = decode_hex_type(data, field['type'], count, hex_ref)
- print 'm==>', field['name'], ':', repr(mandatory_parameters[field['name']])
return mandatory_parameters
def decode_optional_parameters(hex_ref):
optional_parameters = []
hex = hex_ref[0]
while len(hex) > 0:
(tag_hex, length_hex, rest) = (hex[0:4], hex[4:8], hex[8: ])
tag = optional_parameter_tag_name_by_hex(tag_hex)
if tag == None:
tag = tag_hex
length = int(length_hex, 16)
(value_hex, tail) = (rest[0:length*2], rest[length*2: ])
if len(value_hex) == 0:
value = None
else:
value = decode_hex_type(value_hex, optional_parameter_tag_type_by_hex(tag_hex))
hex = tail
optional_parameters.append({'tag':tag, 'length':length, 'value':value})
- print 'o==>', tag, '[', length, ']', ':', repr(value)
return optional_parameters
def decode_hex_type(hex, type, count=0, hex_ref=['']):
if type == 'integer':
return int(hex, 16)
elif type == 'string':
return binascii.b2a_qp(binascii.a2b_hex(re.sub('00','',hex)))
elif (type == 'dest_address'
or type == 'unsuccess_sme'):
list = []
fields = mandatory_parameter_list_by_command_name(type)
for i in range(count):
item = decode_mandatory_parameters(fields, hex_ref)
if item.get('dest_flag', None) == 1: # 'dest_address' only
subfields = mandatory_parameter_list_by_command_name('sme_dest_address')
rest = decode_mandatory_parameters(subfields, hex_ref)
item.update(rest)
elif item.get('dest_flag', None) == 2: # 'dest_address' only
subfields = mandatory_parameter_list_by_command_name('distribution_list')
rest = decode_mandatory_parameters(subfields, hex_ref)
item.update(rest)
list.append(item)
return list
else:
return hex
def octpop(hex_ref):
octet = None
if len(hex_ref[0]) > 1:
(octet, hex_ref[0]) = (hex_ref[0][0:2], hex_ref[0][2: ])
return octet
#### Encoding functions #######################################################
def pack_pdu(command='bind_transmitter', status='ESME_ROK', sequence=0, body_hex=''):
length = 16 + len(body_hex)/2
command_length = '%08x' % length
command_id = command_id_hex_by_name(command)
command_status = command_status_hex_by_name(status)
sequence_number = '%08x' % sequence
pdu_hex = command_length + command_id + command_status + sequence_number + body_hex
return binascii.a2b_hex(pdu_hex)
def encode_mandatory_parameters(fields, json):
mandatory_hex = ''
return mandatory_hex
def encode_optional_parameter(tag, value):
optional_hex = ''
tag_hex = optional_parameter_tag_hex_by_name(tag)
if tag_hex != None:
value_hex = '%02x' % value #TODO need encoding mapping
length_hex = '%04x' % (len(value_hex)/2)
optional_hex = tag_hex + length_hex + value_hex
return optional_hex
def json_to_pdu(json):
header = json.get('header', {})
body_hex = ''
body = json.get('body', {})
for opt in body.get('optional_parameters',[]):
body_hex += encode_optional_parameter(opt['tag'], opt['value'])
return pack_pdu(header['command_id'], header['command_status'], header['sequence_number'], body_hex)
|
dmaclay/python-smpp
|
723840104bceccc584e353d63177c0276b180f47
|
optional parameters to first tier of types done
|
diff --git a/tests.py b/tests.py
index 91a43cd..39f4fde 100644
--- a/tests.py
+++ b/tests.py
@@ -1,45 +1,45 @@
from smpp.esme import *
#esme = ESME()
#esme.connect_SMSC()
#print str(binascii.a2b_hex(re.sub(' ','','00 00 00 3C 00 00 00 04 00 00 00 00 00 00 00 05 00 02 08 35 35 35 00 01 01 35 35 35 35 35 35 35 35 35 00 00 00 00 00 00 00 00 00 00 0F 48 65 6C 6C 6F 20 77 69 6B 69 70 65 64 69 61')))
print ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>"
test_bin = binascii.a2b_hex(re.sub(' ','','00 00 00 3C 00 00 00 04 00 00 00 00 00 00 00 05 00 02 08 35 35 35 00 01 01 35 35 35 35 35 35 35 35 35 00 00 00 00 00 00 00 00 00 00 0F 48 65 6C 6C 6F 20 77 69 6B 69 70 65 64 69 61 00000000 001d00026566'))
unpack_pdu(test_bin)
-test_bin = binascii.a2b_hex(re.sub(' ','','00000000 00000021 00000000 00000000 00 00 00 00 02 0101016500 026600 00 00 00 00 00 00 00 00 00 00 0000000000000000000000000000000000000000000000000000000000 00000000 00000000 0000'))
+test_bin = binascii.a2b_hex(re.sub(' ','','00000000 00000021 00000000 00000000 00 00 00 00 02 0101016500 026600 00 00 00 00 00 00 00 00 00 00 000500020000 0000000400000000'))
print unpack_pdu(test_bin)
test_bin = binascii.a2b_hex(re.sub(' ','','00000000 80000021 00000000 00000000 00 02 01016565650000000000 01016666660000000000'))
print unpack_pdu(test_bin)
pack_pdu('generic_nack','ESME_ROK',1,'00112233445566778899')
pack_pdu()
print unpack_pdu(pack_pdu())
j = {
'header': {
'command_length': 16,
'command_id': 'bind_transmitter',
'command_status': 'ESME_ROK',
'sequence_number': 0
},
'body': {
'optional_parameters': [
{
'tag':'payload_type',
'value':0
}
]
}
}
json_to_pdu(j)
|
dmaclay/python-smpp
|
f224e4e4686abfc2f8ddf1b25b5a7b00d71e7cc5
|
optional parameters to first tier of types done
|
diff --git a/smpp/pdu.py b/smpp/pdu.py
index 0fdf158..549345b 100644
--- a/smpp/pdu.py
+++ b/smpp/pdu.py
@@ -77,872 +77,888 @@ mandatory_parameter_lists = {
'submit_sm_resp':[ # SMPP v3.4, section 4.4.2, table 4-11, page 67
{'name':'message_id', 'min':0, 'max':65, 'var':True, 'type':'string', 'map':None}
],
'submit_multi':[ # SMPP v3.4, section 4.5.1, table 4-12, page 69-71
{'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'number_of_dests', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'dest_address', 'min':0, 'max':0, 'var':'number_of_dests', 'type':'dest_address', 'map':None},
{'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
{'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
{'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'map':None}
],
'dest_address':[ # SMPP v3.4, section 4.5.1.1, table 4-13, page 75
{'name':'dest_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None}
# 'sme_dest_address' or 'distribution_list' goes here
],
'sme_dest_address':[ # SMPP v3.4, section 4.5.1.1, table 4-14, page 75
{'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None}
],
'distribution_list':[ # SMPP v3.4, section 4.5.1.2, table 4-15, page 75
{'name':'dl_name', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None}
],
'submit_multi_resp':[ # SMPP v3.4, section 4.5.2, table 4-16, page 76
{'name':'message_id', 'min':0, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'no_unsuccess', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'unsuccess_sme', 'min':0, 'max':0, 'var':'no_unsuccess', 'type':'unsuccess_sme', 'map':None}
],
'unsuccess_sme':[ # SMPP v3.4, section 4.5.2.1, table 4-17, page 77
{'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'error_status_code', 'min':4, 'max':4, 'var':False, 'type':'integer', 'map':None}
],
'deliver_sm':[ # SMPP v3.4, section 4.6.1, table 4-18, page 79-81
{'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'schedule_delivery_time', 'min':1, 'max':1, 'var':False, 'type':'string', 'map':None},
{'name':'validity_period', 'min':1, 'max':1, 'var':False, 'type':'string', 'map':None},
{'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'map':None}
],
'deliver_sm_resp':[ # SMPP v3.4, section 4.6.2, table 4-19, page 85
{'name':'message_id', 'min':1, 'max':1, 'var':False, 'type':'string', 'map':None}
],
'data_sm':[ # SMPP v3.4, section 4.7.1, table 4-20, page 87-88
{'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'destination_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None}
],
'data_sm_resp':[ # SMPP v3.4, section 4.7.2, table 4-21, page 93
{'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None}
],
'query_sm':[ # SMPP v3.4, section 4.8.1, table 4-22, page 95
{'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None}
],
'query_sm_resp':[ # SMPP v3.4, section 4.7.2, table 4-21, page 93
{'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'final_date', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
{'name':'message_state', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'error_code', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None}
],
'cancel_sm':[ # SMPP v3.4, section 4.9.1, table 4-24, page 98-99
{'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'map':None},
{'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None}
],
'cancel_sm_resp':[ # SMPP v3.4, section 4.9.2, table 4-25, page 100
],
'replace_sm':[ # SMPP v3.4, section 4.10.1, table 4-26, page 102-103
{'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
{'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
{'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
{'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
{'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'map':None}
],
'replace_sm_resp':[ # SMPP v3.4, section 4.10.2, table 4-27, page 104
],
'enquire_link':[ # SMPP v3.4, section 4.11.1, table 4-28, page 106
],
'enquire_link_resp':[ # SMPP v3.4, section 4.11.2, table 4-29, page 106
],
'alert_notification':[ # SMPP v3.4, section 4.12.1, table 4-30, page 108
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'source_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
{'name':'esme_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
{'name':'esme_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
{'name':'esme_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
]
}
def mandatory_parameter_list_by_command_name(command_name):
return mandatory_parameter_lists.get(command_name,[])
# Command IDs - SMPP v3.4, section 5.1.2.1, table 5-1, page 110-111
command_id_by_hex = {
'80000000':{'hex':'80000000', 'name':'generic_nack'},
'00000001':{'hex':'00000001', 'name':'bind_receiver'},
'80000001':{'hex':'80000001', 'name':'bind_receiver_resp'},
'00000002':{'hex':'00000002', 'name':'bind_transmitter'},
'80000002':{'hex':'80000002', 'name':'bind_transmitter_resp'},
'00000003':{'hex':'00000003', 'name':'query_sm'},
'80000003':{'hex':'80000003', 'name':'query_sm_resp'},
'00000004':{'hex':'00000004', 'name':'submit_sm'},
'80000004':{'hex':'80000004', 'name':'submit_sm_resp'},
'00000005':{'hex':'00000005', 'name':'deliver_sm'},
'80000005':{'hex':'80000005', 'name':'deliver_sm_resp'},
'00000006':{'hex':'00000006', 'name':'unbind'},
'80000006':{'hex':'80000006', 'name':'unbind_resp'},
'00000007':{'hex':'00000007', 'name':'replace_sm'},
'80000007':{'hex':'80000007', 'name':'replace_sm_resp'},
'00000008':{'hex':'00000008', 'name':'cancel_sm'},
'80000008':{'hex':'80000008', 'name':'cancel_sm_resp'},
'00000009':{'hex':'00000009', 'name':'bind_transceiver'},
'80000009':{'hex':'80000009', 'name':'bind_transceiver_resp'},
'0000000b':{'hex':'0000000b', 'name':'outbind'},
'00000015':{'hex':'00000015', 'name':'enquire_link'},
'80000015':{'hex':'80000015', 'name':'enquire_link_resp'},
'00000021':{'hex':'00000021', 'name':'submit_multi'},
'80000021':{'hex':'80000021', 'name':'submit_multi_resp'},
'00000102':{'hex':'00000102', 'name':'alert_notification'},
'00000103':{'hex':'00000103', 'name':'data_sm'},
'80000103':{'hex':'80000103', 'name':'data_sm_resp'},
# v4 codes
'80010000':{'hex':'80010000', 'name':'generic_nack_v4'},
'00010001':{'hex':'00010001', 'name':'bind_receiver_v4'},
'80010001':{'hex':'80010001', 'name':'bind_receiver_resp_v4'},
'00010002':{'hex':'00010002', 'name':'bind_transmitter_v4'},
'80010002':{'hex':'80010002', 'name':'bind_transmitter_resp_v4'},
'00010003':{'hex':'00010003', 'name':'query_sm_v4'},
'80010003':{'hex':'80010003', 'name':'query_sm_resp_v4'},
'00010004':{'hex':'00010004', 'name':'submit_sm_v4'},
'80010004':{'hex':'80010004', 'name':'submit_sm_resp_v4'},
'00010005':{'hex':'00010005', 'name':'deliver_sm_v4'},
'80010005':{'hex':'80010005', 'name':'deliver_sm_resp_v4'},
'00010006':{'hex':'00010006', 'name':'unbind_v4'},
'80010006':{'hex':'80010006', 'name':'unbind_resp_v4'},
'00010007':{'hex':'00010007', 'name':'replace_sm_v4'},
'80010007':{'hex':'80010007', 'name':'replace_sm_resp_v4'},
'00010008':{'hex':'00010008', 'name':'cancel_sm_v4'},
'80010008':{'hex':'80010008', 'name':'cancel_sm_resp_v4'},
'00010009':{'hex':'00010009', 'name':'delivery_receipt_v4'},
'80010009':{'hex':'80010009', 'name':'delivery_receipt_resp_v4'},
'0001000a':{'hex':'0001000a', 'name':'enquire_link_v4'},
'8001000a':{'hex':'8001000a', 'name':'enquire_link_resp_v4'},
'0001000b':{'hex':'0001000b', 'name':'outbind_v4'},
}
def command_id_name_by_hex(x):
return command_id_by_hex.get(x,{}).get('name')
command_id_by_name = {
'generic_nack' :{'hex':'80000000', 'name':'generic_nack'},
'bind_receiver' :{'hex':'00000001', 'name':'bind_receiver'},
'bind_receiver_resp' :{'hex':'80000001', 'name':'bind_receiver_resp'},
'bind_transmitter' :{'hex':'00000002', 'name':'bind_transmitter'},
'bind_transmitter_resp' :{'hex':'80000002', 'name':'bind_transmitter_resp'},
'query_sm' :{'hex':'00000003', 'name':'query_sm'},
'query_sm_resp' :{'hex':'80000003', 'name':'query_sm_resp'},
'submit_sm' :{'hex':'00000004', 'name':'submit_sm'},
'submit_sm_resp' :{'hex':'80000004', 'name':'submit_sm_resp'},
'deliver_sm' :{'hex':'00000005', 'name':'deliver_sm'},
'deliver_sm_resp' :{'hex':'80000005', 'name':'deliver_sm_resp'},
'unbind' :{'hex':'00000006', 'name':'unbind'},
'unbind_resp' :{'hex':'80000006', 'name':'unbind_resp'},
'replace_sm' :{'hex':'00000007', 'name':'replace_sm'},
'replace_sm_resp' :{'hex':'80000007', 'name':'replace_sm_resp'},
'cancel_sm' :{'hex':'00000008', 'name':'cancel_sm'},
'cancel_sm_resp' :{'hex':'80000008', 'name':'cancel_sm_resp'},
'bind_transceiver' :{'hex':'00000009', 'name':'bind_transceiver'},
'bind_transceiver_resp' :{'hex':'80000009', 'name':'bind_transceiver_resp'},
'outbind' :{'hex':'0000000b', 'name':'outbind'},
'enquire_link' :{'hex':'00000015', 'name':'enquire_link'},
'enquire_link_resp' :{'hex':'80000015', 'name':'enquire_link_resp'},
'submit_multi' :{'hex':'00000021', 'name':'submit_multi'},
'submit_multi_resp' :{'hex':'80000021', 'name':'submit_multi_resp'},
'alert_notification' :{'hex':'00000102', 'name':'alert_notification'},
'data_sm' :{'hex':'00000103', 'name':'data_sm'},
'data_sm_resp' :{'hex':'80000103', 'name':'data_sm_resp'},
# v4 codes
'generic_nack_v4' :{'hex':'80010000', 'name':'generic_nack_v4'},
'bind_receiver_v4' :{'hex':'00010001', 'name':'bind_receiver_v4'},
'bind_receiver_resp_v4' :{'hex':'80010001', 'name':'bind_receiver_resp_v4'},
'bind_transmitter_v4' :{'hex':'00010002', 'name':'bind_transmitter_v4'},
'bind_transmitter_resp_v4':{'hex':'80010002', 'name':'bind_transmitter_resp_v4'},
'query_sm_v4' :{'hex':'00010003', 'name':'query_sm_v4'},
'query_sm_resp_v4' :{'hex':'80010003', 'name':'query_sm_resp_v4'},
'submit_sm_v4' :{'hex':'00010004', 'name':'submit_sm_v4'},
'submit_sm_resp_v4' :{'hex':'80010004', 'name':'submit_sm_resp_v4'},
'deliver_sm_v4' :{'hex':'00010005', 'name':'deliver_sm_v4'},
'deliver_sm_resp_v4' :{'hex':'80010005', 'name':'deliver_sm_resp_v4'},
'unbind_v4' :{'hex':'00010006', 'name':'unbind_v4'},
'unbind_resp_v4' :{'hex':'80010006', 'name':'unbind_resp_v4'},
'replace_sm_v4' :{'hex':'00010007', 'name':'replace_sm_v4'},
'replace_sm_resp_v4' :{'hex':'80010007', 'name':'replace_sm_resp_v4'},
'cancel_sm_v4' :{'hex':'00010008', 'name':'cancel_sm_v4'},
'cancel_sm_resp_v4' :{'hex':'80010008', 'name':'cancel_sm_resp_v4'},
'delivery_receipt_v4' :{'hex':'00010009', 'name':'delivery_receipt_v4'},
'delivery_receipt_resp_v4':{'hex':'80010009', 'name':'delivery_receipt_resp_v4'},
'enquire_link_v4' :{'hex':'0001000a', 'name':'enquire_link_v4'},
'enquire_link_resp_v4' :{'hex':'8001000a', 'name':'enquire_link_resp_v4'},
'outbind_v4' :{'hex':'0001000b', 'name':'outbind_v4'}
}
def command_id_hex_by_name(n):
return command_id_by_name.get(n,{}).get('hex')
# SMPP Error Codes (ESME) - SMPP v3.4, section 5.1.3, table 5-2, page 112-114
command_status_by_hex = {
'00000000':{'hex':'00000000', 'name':'ESME_ROK', 'description':'No error'},
'00000001':{'hex':'00000001', 'name':'ESME_RINVMSGLEN', 'description':'Message Length is invalid'},
'00000002':{'hex':'00000002', 'name':'ESME_RINVCMDLEN', 'description':'Command Length is invalid'},
'00000003':{'hex':'00000003', 'name':'ESME_RINVCMDID', 'description':'Invalid Command ID'},
'00000004':{'hex':'00000004', 'name':'ESME_RINVBNDSTS', 'description':'Incorrect BIND Status for given command'},
'00000005':{'hex':'00000005', 'name':'ESME_RALYBND', 'description':'ESME Already in bound state'},
'00000006':{'hex':'00000006', 'name':'ESME_RINVPRTFLG', 'description':'Invalid priority flag'},
'00000007':{'hex':'00000007', 'name':'ESME_RINVREGDLVFLG', 'description':'Invalid registered delivery flag'},
'00000008':{'hex':'00000008', 'name':'ESME_RSYSERR', 'description':'System Error'},
'0000000a':{'hex':'0000000a', 'name':'ESME_RINVSRCADR', 'description':'Invalid source address'},
'0000000b':{'hex':'0000000b', 'name':'ESME_RINVDSTADR', 'description':'Invalid destination address'},
'0000000c':{'hex':'0000000c', 'name':'ESME_RINVMSGID', 'description':'Message ID is invalid'},
'0000000d':{'hex':'0000000d', 'name':'ESME_RBINDFAIL', 'description':'Bind failed'},
'0000000e':{'hex':'0000000e', 'name':'ESME_RINVPASWD', 'description':'Invalid password'},
'0000000f':{'hex':'0000000f', 'name':'ESME_RINVSYSID', 'description':'Invalid System ID'},
'00000011':{'hex':'00000011', 'name':'ESME_RCANCELFAIL', 'description':'Cancel SM Failed'},
'00000013':{'hex':'00000013', 'name':'ESME_RREPLACEFAIL', 'description':'Replace SM Failed'},
'00000014':{'hex':'00000014', 'name':'ESME_RMSGQFUL', 'description':'Message queue full'},
'00000015':{'hex':'00000015', 'name':'ESME_RINVSERTYP', 'description':'Invalid service type'},
'00000033':{'hex':'00000033', 'name':'ESME_RINVNUMDESTS', 'description':'Invalid number of destinations'},
'00000034':{'hex':'00000034', 'name':'ESME_RINVDLNAME', 'description':'Invalid distribution list name'},
'00000040':{'hex':'00000040', 'name':'ESME_RINVDESTFLAG', 'description':'Destination flag is invalid (submit_multi)'},
'00000042':{'hex':'00000042', 'name':'ESME_RINVSUBREP', 'description':"Invalid `submit with replace' request (i.e. submit_sm with replace_if_present_flag set)"},
'00000043':{'hex':'00000043', 'name':'ESME_RINVESMCLASS', 'description':'Invalid esm_class field data'},
'00000044':{'hex':'00000044', 'name':'ESME_RCNTSUBDL', 'description':'Cannot submit to distribution list'},
'00000045':{'hex':'00000045', 'name':'ESME_RSUBMITFAIL', 'description':'submit_sm or submit_multi failed'},
'00000048':{'hex':'00000048', 'name':'ESME_RINVSRCTON', 'description':'Invalid source address TON'},
'00000049':{'hex':'00000049', 'name':'ESME_RINVSRCNPI', 'description':'Invalid source address NPI'},
'00000050':{'hex':'00000050', 'name':'ESME_RINVDSTTON', 'description':'Invalid destination address TON'},
'00000051':{'hex':'00000051', 'name':'ESME_RINVDSTNPI', 'description':'Invalid destination address NPI'},
'00000053':{'hex':'00000053', 'name':'ESME_RINVSYSTYP', 'description':'Invalid system_type field'},
'00000054':{'hex':'00000054', 'name':'ESME_RINVREPFLAG', 'description':'Invalid replace_if_present flag'},
'00000055':{'hex':'00000055', 'name':'ESME_RINVNUMMSGS', 'description':'Invalid number of messages'},
'00000058':{'hex':'00000058', 'name':'ESME_RTHROTTLED', 'description':'Throttling error (ESME has exceeded allowed message limits)'},
'00000061':{'hex':'00000061', 'name':'ESME_RINVSCHED', 'description':'Invalid scheduled delivery time'},
'00000062':{'hex':'00000062', 'name':'ESME_RINVEXPIRY', 'description':'Invalid message validity period (expiry time)'},
'00000063':{'hex':'00000063', 'name':'ESME_RINVDFTMSGID', 'description':'Predefined message invalid or not found'},
'00000064':{'hex':'00000064', 'name':'ESME_RX_T_APPN', 'description':'ESME Receiver Temporary App Error Code'},
'00000065':{'hex':'00000065', 'name':'ESME_RX_P_APPN', 'description':'ESME Receiver Permanent App Error Code'},
'00000066':{'hex':'00000066', 'name':'ESME_RX_R_APPN', 'description':'ESME Receiver Reject Message Error Code'},
'00000067':{'hex':'00000067', 'name':'ESME_RQUERYFAIL', 'description':'query_sm request failed'},
'000000c0':{'hex':'000000c0', 'name':'ESME_RINVOPTPARSTREAM', 'description':'Error in the optional part of the PDU Body'},
'000000c1':{'hex':'000000c1', 'name':'ESME_ROPTPARNOTALLWD', 'description':'Optional paramenter not allowed'},
'000000c2':{'hex':'000000c2', 'name':'ESME_RINVPARLEN', 'description':'Invalid parameter length'},
'000000c3':{'hex':'000000c3', 'name':'ESME_RMISSINGOPTPARAM', 'description':'Expected optional parameter missing'},
'000000c4':{'hex':'000000c4', 'name':'ESME_RINVOPTPARAMVAL', 'description':'Invalid optional parameter value'},
'000000fe':{'hex':'000000fe', 'name':'ESME_RDELIVERYFAILURE', 'description':'Delivery Failure (used for data_sm_resp)'},
'000000ff':{'hex':'000000ff', 'name':'ESME_RUNKNOWNERR', 'description':'Unknown error'}
}
def command_status_name_by_hex(x):
return command_status_by_hex.get(x,{}).get('name')
command_status_by_name = {
'ESME_ROK' :{'hex':'00000000', 'name':'ESME_ROK', 'description':'No error'},
'ESME_RINVMSGLEN' :{'hex':'00000001', 'name':'ESME_RINVMSGLEN', 'description':'Message Length is invalid'},
'ESME_RINVCMDLEN' :{'hex':'00000002', 'name':'ESME_RINVCMDLEN', 'description':'Command Length is invalid'},
'ESME_RINVCMDID' :{'hex':'00000003', 'name':'ESME_RINVCMDID', 'description':'Invalid Command ID'},
'ESME_RINVBNDSTS' :{'hex':'00000004', 'name':'ESME_RINVBNDSTS', 'description':'Incorrect BIND Status for given command'},
'ESME_RALYBND' :{'hex':'00000005', 'name':'ESME_RALYBND', 'description':'ESME Already in bound state'},
'ESME_RINVPRTFLG' :{'hex':'00000006', 'name':'ESME_RINVPRTFLG', 'description':'Invalid priority flag'},
'ESME_RINVREGDLVFLG' :{'hex':'00000007', 'name':'ESME_RINVREGDLVFLG', 'description':'Invalid registered delivery flag'},
'ESME_RSYSERR' :{'hex':'00000008', 'name':'ESME_RSYSERR', 'description':'System Error'},
'ESME_RINVSRCADR' :{'hex':'0000000a', 'name':'ESME_RINVSRCADR', 'description':'Invalid source address'},
'ESME_RINVDSTADR' :{'hex':'0000000b', 'name':'ESME_RINVDSTADR', 'description':'Invalid destination address'},
'ESME_RINVMSGID' :{'hex':'0000000c', 'name':'ESME_RINVMSGID', 'description':'Message ID is invalid'},
'ESME_RBINDFAIL' :{'hex':'0000000d', 'name':'ESME_RBINDFAIL', 'description':'Bind failed'},
'ESME_RINVPASWD' :{'hex':'0000000e', 'name':'ESME_RINVPASWD', 'description':'Invalid password'},
'ESME_RINVSYSID' :{'hex':'0000000f', 'name':'ESME_RINVSYSID', 'description':'Invalid System ID'},
'ESME_RCANCELFAIL' :{'hex':'00000011', 'name':'ESME_RCANCELFAIL', 'description':'Cancel SM Failed'},
'ESME_RREPLACEFAIL' :{'hex':'00000013', 'name':'ESME_RREPLACEFAIL', 'description':'Replace SM Failed'},
'ESME_RMSGQFUL' :{'hex':'00000014', 'name':'ESME_RMSGQFUL', 'description':'Message queue full'},
'ESME_RINVSERTYP' :{'hex':'00000015', 'name':'ESME_RINVSERTYP', 'description':'Invalid service type'},
'ESME_RINVNUMDESTS' :{'hex':'00000033', 'name':'ESME_RINVNUMDESTS', 'description':'Invalid number of destinations'},
'ESME_RINVDLNAME' :{'hex':'00000034', 'name':'ESME_RINVDLNAME', 'description':'Invalid distribution list name'},
'ESME_RINVDESTFLAG' :{'hex':'00000040', 'name':'ESME_RINVDESTFLAG', 'description':'Destination flag is invalid (submit_multi)'},
'ESME_RINVSUBREP' :{'hex':'00000042', 'name':'ESME_RINVSUBREP', 'description':"Invalid `submit with replace' request (i.e. submit_sm with replace_if_present_flag set)"},
'ESME_RINVESMCLASS' :{'hex':'00000043', 'name':'ESME_RINVESMCLASS', 'description':'Invalid esm_class field data'},
'ESME_RCNTSUBDL' :{'hex':'00000044', 'name':'ESME_RCNTSUBDL', 'description':'Cannot submit to distribution list'},
'ESME_RSUBMITFAIL' :{'hex':'00000045', 'name':'ESME_RSUBMITFAIL', 'description':'submit_sm or submit_multi failed'},
'ESME_RINVSRCTON' :{'hex':'00000048', 'name':'ESME_RINVSRCTON', 'description':'Invalid source address TON'},
'ESME_RINVSRCNPI' :{'hex':'00000049', 'name':'ESME_RINVSRCNPI', 'description':'Invalid source address NPI'},
'ESME_RINVDSTTON' :{'hex':'00000050', 'name':'ESME_RINVDSTTON', 'description':'Invalid destination address TON'},
'ESME_RINVDSTNPI' :{'hex':'00000051', 'name':'ESME_RINVDSTNPI', 'description':'Invalid destination address NPI'},
'ESME_RINVSYSTYP' :{'hex':'00000053', 'name':'ESME_RINVSYSTYP', 'description':'Invalid system_type field'},
'ESME_RINVREPFLAG' :{'hex':'00000054', 'name':'ESME_RINVREPFLAG', 'description':'Invalid replace_if_present flag'},
'ESME_RINVNUMMSGS' :{'hex':'00000055', 'name':'ESME_RINVNUMMSGS', 'description':'Invalid number of messages'},
'ESME_RTHROTTLED' :{'hex':'00000058', 'name':'ESME_RTHROTTLED', 'description':'Throttling error (ESME has exceeded allowed message limits)'},
'ESME_RINVSCHED' :{'hex':'00000061', 'name':'ESME_RINVSCHED', 'description':'Invalid scheduled delivery time'},
'ESME_RINVEXPIRY' :{'hex':'00000062', 'name':'ESME_RINVEXPIRY', 'description':'Invalid message validity period (expiry time)'},
'ESME_RINVDFTMSGID' :{'hex':'00000063', 'name':'ESME_RINVDFTMSGID', 'description':'Predefined message invalid or not found'},
'ESME_RX_T_APPN' :{'hex':'00000064', 'name':'ESME_RX_T_APPN', 'description':'ESME Receiver Temporary App Error Code'},
'ESME_RX_P_APPN' :{'hex':'00000065', 'name':'ESME_RX_P_APPN', 'description':'ESME Receiver Permanent App Error Code'},
'ESME_RX_R_APPN' :{'hex':'00000066', 'name':'ESME_RX_R_APPN', 'description':'ESME Receiver Reject Message Error Code'},
'ESME_RQUERYFAIL' :{'hex':'00000067', 'name':'ESME_RQUERYFAIL', 'description':'query_sm request failed'},
'ESME_RINVOPTPARSTREAM':{'hex':'000000c0', 'name':'ESME_RINVOPTPARSTREAM', 'description':'Error in the optional part of the PDU Body'},
'ESME_ROPTPARNOTALLWD' :{'hex':'000000c1', 'name':'ESME_ROPTPARNOTALLWD', 'description':'Optional paramenter not allowed'},
'ESME_RINVPARLEN' :{'hex':'000000c2', 'name':'ESME_RINVPARLEN', 'description':'Invalid parameter length'},
'ESME_RMISSINGOPTPARAM':{'hex':'000000c3', 'name':'ESME_RMISSINGOPTPARAM', 'description':'Expected optional parameter missing'},
'ESME_RINVOPTPARAMVAL' :{'hex':'000000c4', 'name':'ESME_RINVOPTPARAMVAL', 'description':'Invalid optional parameter value'},
'ESME_RDELIVERYFAILURE':{'hex':'000000fe', 'name':'ESME_RDELIVERYFAILURE', 'description':'Delivery Failure (used for data_sm_resp)'},
'ESME_RUNKNOWNERR' :{'hex':'000000ff', 'name':'ESME_RUNKNOWNERR', 'description':'Unknown error'}
}
def command_status_hex_by_name(n):
return command_status_by_name.get(n,{}).get('hex')
# Type of Number (TON) - SMPP v3.4, section 5.2.5, table 5-3, page 117
maps['addr_ton_by_name'] = {
'unknown' :'00',
'international' :'01',
'national' :'02',
'network_specific' :'03',
'subscriber_number':'04',
'alphanumeric' :'05',
'abbreviated' :'06'
}
maps['addr_ton_by_hex'] = {
'00':'unknown',
'01':'international',
'02':'national',
'03':'network_specific',
'04':'subscriber_number',
'05':'alphanumeric',
'06':'abbreviated'
}
# Numberic Plan Indicator (NPI) - SMPP v3.4, section 5.2.6, table 5-4, page 118
maps['addr_npi_by_name'] = {
'unknown' :'00',
'ISDN' :'01',
'data' :'03',
'telex' :'04',
'land_mobile':'06',
'national' :'08',
'private' :'09',
'ERMES' :'0a',
'internet' :'0e',
'WAP' :'12'
}
maps['addr_npi_by_hex'] = {
'00':'unknown',
'01':'ISDN',
'03':'data',
'04':'telex',
'06':'land_mobile',
'08':'national',
'09':'private',
'0a':'ERMES',
'0e':'internet',
'12':'WAP'
}
# ESM Class bits - SMPP v3.4, section 5.2.12, page 121
maps['esm_class_bits'] = {
'mode_mask' :'03',
'type_mask' :'3c',
'feature_mask' :'c0',
'mode_default' :'00',
'mode_datagram' :'01',
'mode_forward' :'02',
'mode_store_and_forward' :'03',
'type_default' :'00',
'type_delivery_receipt' :'04',
'type_delivery_ack' :'08',
'type_0011' :'0a',
'type_user_ack' :'10',
'type_0101' :'14',
'type_conversation_abort' :'18',
'type_0111' :'1a',
'type_intermed_deliv_notif' :'20',
'type_1001' :'24',
'type_1010' :'28',
'type_1011' :'2a',
'type_1100' :'30',
'type_1101' :'34',
'type_1110' :'38',
'type_1111' :'3a',
'feature_none' :'00',
'feature_UDHI' :'40',
'feature_reply_path' :'80',
'feature_UDHI_and_reply_path':'c0'
}
# Registered Delivery bits - SMPP v3.4, section 5.2.17, page 124
maps['registered_delivery_bits'] = {
'receipt_mask' :'03',
'ack_mask' :'0c',
'intermed_notif_mask' :'80',
'receipt_none' :'00',
'receipt_always' :'01',
'receipt_on_fail' :'02',
'receipt_res' :'03',
'ack_none' :'00',
'ack_delivery' :'04',
'ack_user' :'08',
'ack_delivery_and_user':'0c',
'intermed_notif_none' :'00',
'intermed_notif' :'10'
}
# submit_multi dest_flag constants - SMPP v3.4, section 5.2.25, page 129
#maps['dest_flag_by_name'] = {
#'SME Address' :1,
#'Distribution List Name':2
#}
# Message State codes returned in query_sm_resp PDUs - SMPP v3.4, section 5.2.28, table 5-6, page 130
maps['message_state_by_name'] = {
'ENROUTE' :1,
'DELIVERED' :2,
'EXPIRED' :3,
'DELETED' :4,
'UNDELIVERABLE':5,
'ACCEPTED' :6,
'UNKNOWN' :7,
'REJECTED' :8
}
# Facility Code bits for SMPP v4
maps['facility_code_bits'] = {
'GF_PVCY' :'00000001',
'GF_SUBADDR':'00000002',
'NF_CC' :'00080000',
'NF_PDC' :'00010000',
'NF_IS136' :'00020000',
'NF_IS95A' :'00040000'
}
# Optional Parameter Tags - SMPP v3.4, section 5.3.2, Table 5-7, page 132-133
optional_parameter_tag_by_hex = {
- '0005':{'hex':'0005', 'name':'dest_addr_subunit', 'type':'integer', 'technology':'GSM'},
- '0006':{'hex':'0006', 'name':'dest_network_type', 'type':'integer', 'technology':'Generic'},
- '0007':{'hex':'0007', 'name':'dest_bearer_type', 'type':'integer', 'technology':'Generic'},
- '0008':{'hex':'0008', 'name':'dest_telematics_id', 'type':'integer', 'technology':'GSM'},
-
- '000d':{'hex':'000d', 'name':'source_addr_subunit', 'type':'integer', 'technology':'GSM'},
- '000e':{'hex':'000e', 'name':'source_network_type', 'type':'integer', 'technology':'Generic'},
- '000f':{'hex':'000f', 'name':'source_bearer_type', 'type':'integer', 'technology':'Generic'},
- '0010':{'hex':'0010', 'name':'source_telematics_id', 'type':'integer', 'technology':'GSM'},
-
- '0017':{'hex':'0017', 'name':'qos_time_to_live', 'type':'integer', 'technology':'Generic'},
- '0019':{'hex':'0019', 'name':'payload_type', 'type':'integer', 'technology':'Generic'},
- '001d':{'hex':'001d', 'name':'additional_status_info_text', 'type':'string' , 'technology':'Generic'},
- '001e':{'hex':'001e', 'name':'receipted_message_id', 'type':'string' , 'technology':'Generic'},
- '0030':{'hex':'0030', 'name':'ms_msg_wait_facilities', 'type':'bitmask', 'technology':'GSM'},
-
- '0101':{'hex':'0101', 'name':'PVCY_AuthenticationStr', 'type':None, 'technology':'? (J-Phone)'}, # v4 page 58-62
-
- '0201':{'hex':'0201', 'name':'privacy_indicator', 'type':'integer', 'technology':'CDMA,TDMA'},
- '0202':{'hex':'0202', 'name':'source_subaddress', 'type':'hex', 'technology':'CDMA,TDMA'},
- '0203':{'hex':'0203', 'name':'dest_subaddress', 'type':'hex', 'technology':'CDMA,TDMA'},
- '0204':{'hex':'0204', 'name':'user_message_reference', 'type':'integer', 'technology':'Generic'},
- '0205':{'hex':'0205', 'name':'user_response_code', 'type':'integer', 'technology':'CDMA,TDMA'},
- '020a':{'hex':'020a', 'name':'source_port', 'type':'integer', 'technology':'WAP'},
- '020b':{'hex':'020b', 'name':'destination_port', 'type':'integer', 'technology':'WAP'},
- '020c':{'hex':'020c', 'name':'sar_msg_ref_num', 'type':'integer', 'technology':'Generic'},
- '020d':{'hex':'020d', 'name':'language_indicator', 'type':'integer', 'technology':'CDMA,TDMA'},
- '020e':{'hex':'020e', 'name':'sar_total_segments', 'type':'integer', 'technology':'Generic'},
- '020f':{'hex':'020f', 'name':'sar_segment_seqnum', 'type':'integer', 'technology':'Generic'},
- '0210':{'hex':'0210', 'name':'sc_interface_version', 'type':'integer', 'technology':'Generic'},
-
- '0301':{'hex':'0301', 'name':'CC_CBN', 'type':None, 'technology':'V4'}, # v4 page 70
- '0302':{'hex':'0302', 'name':'callback_num_pres_ind', 'type':'bitmask', 'technology':'TDMA'},
- '0303':{'hex':'0303', 'name':'callback_num_atag', 'type':'hex', 'technology':'TDMA'},
- '0304':{'hex':'0304', 'name':'number_of_messages', 'type':'integer', 'technology':'CDMA'},
- '0381':{'hex':'0381', 'name':'callback_num', 'type':'hex', 'technology':'CDMA,TDMA,GSM,iDEN'},
-
- '0420':{'hex':'0420', 'name':'dpf_result', 'type':'integer', 'technology':'Generic'},
- '0421':{'hex':'0421', 'name':'set_dpf', 'type':'integer', 'technology':'Generic'},
- '0422':{'hex':'0422', 'name':'ms_availability_status', 'type':'integer', 'technology':'Generic'},
- '0423':{'hex':'0423', 'name':'network_error_code', 'type':'hex', 'technology':'Generic'},
- '0424':{'hex':'0424', 'name':'message_payload', 'type':'hex', 'technology':'Generic'},
- '0425':{'hex':'0425', 'name':'delivery_failure_reason', 'type':'integer', 'technology':'Generic'},
- '0426':{'hex':'0426', 'name':'more_messages_to_send', 'type':'integer', 'technology':'GSM'},
- '0427':{'hex':'0427', 'name':'message_state', 'type':'integer', 'technology':'Generic'},
- '0428':{'hex':'0428', 'name':'congestion_state', 'type':'integer', 'technology':'Generic'},
-
- '0501':{'hex':'0501', 'name':'ussd_service_op', 'type':'hex', 'technology':'GSM (USSD)'},
-
- '0600':{'hex':'0600', 'name':'broadcast_channel_indicator', 'type':'integer', 'technology':'GSM'},
- '0601':{'hex':'0601', 'name':'broadcast_content_type', 'type':'integer', 'technology':'CDMA, TDMA, GSM'},
- '0602':{'hex':'0602', 'name':'broadcast_content_type_info', 'type':'integer', 'technology':'CDMA, TDMA'},
- '0603':{'hex':'0603', 'name':'broadcast_message_class', 'type':'integer', 'technology':'GSM'},
- '0604':{'hex':'0604', 'name':'broadcast_rep_num', 'type':'integer', 'technology':'GSM'},
- '0605':{'hex':'0605', 'name':'broadcast_frequency_interval', 'type':'integer', 'technology':'CDMA, TDMA, GSM'},
- '0606':{'hex':'0606', 'name':'broadcast_area_identifier', 'type':'integer', 'technology':'CDMA, TDMA, GSM'},
- '0607':{'hex':'0607', 'name':'broadcast_error_status', 'type':'integer', 'technology':'CDMA, TDMA, GSM'},
- '0608':{'hex':'0608', 'name':'broadcast_area_success', 'type':'integer', 'technology':'GSM'},
- '0609':{'hex':'0609', 'name':'broadcast_end_time', 'type':'integer', 'technology':'CDMA, TDMA, GSM'},
- '060a':{'hex':'060a', 'name':'broadcast_service_group', 'type':'integer', 'technology':'CDMA, TDMA'},
- '060b':{'hex':'060b', 'name':'billing_identification', 'type':'integer', 'technology':'Generic'},
- '060d':{'hex':'060d', 'name':'source_network_id', 'type':'integer', 'technology':'Generic'},
- '060e':{'hex':'060e', 'name':'dest_network_id', 'type':'integer', 'technology':'Generic'},
- '060f':{'hex':'060f', 'name':'source_node_id', 'type':'integer', 'technology':'Generic'},
- '0610':{'hex':'0610', 'name':'dest_node_id', 'type':'integer', 'technology':'Generic'},
- '0611':{'hex':'0611', 'name':'dest_addr_np_resolution', 'type':'integer', 'technology':'CDMA, TDMA (US Only)'},
- '0612':{'hex':'0612', 'name':'dest_addr_np_information', 'type':'integer', 'technology':'CDMA, TDMA (US Only)'},
- '0613':{'hex':'0613', 'name':'dest_addr_np_country', 'type':'integer', 'technology':'CDMA, TDMA (US Only)'},
-
- '1201':{'hex':'1201', 'name':'display_time', 'type':'integer', 'technology':'CDMA,TDMA'},
- '1203':{'hex':'1203', 'name':'sms_signal', 'type':'integer', 'technology':'TDMA'},
- '1204':{'hex':'1204', 'name':'ms_validity', 'type':'integer', 'technology':'CDMA,TDMA'},
-
- '1304':{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'type':None, 'technology':'CDMA'}, # v4 page 85
- '1306':{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'type':None, 'technology':'CDMA'}, # v4 page 86
- '130c':{'hex':'130c', 'name':'alert_on_message_delivery', 'type':'integer', 'technology':'CDMA'},
- '1380':{'hex':'1380', 'name':'its_reply_type', 'type':'integer', 'technology':'CDMA'},
- '1383':{'hex':'1383', 'name':'its_session_info', 'type':'hex', 'technology':'CDMA Korean [KORITS]'},
-
- '1402':{'hex':'1402', 'name':'operator_id', 'type':'integer', 'technology':'vendor extension'},
- '1403':{'hex':'1403', 'name':'tariff', 'type':'integer', 'technology':'Mobile Network Code vendor extension'},
- '1450':{'hex':'1450', 'name':'mcc', 'type':'integer', 'technology':'Mobile Country Code vendor extension'},
- '1451':{'hex':'1451', 'name':'mnc', 'type':'integer', 'technology':'Mobile Network Code vendor extension'},
-
- '1101':{'hex':'1101', 'name':'PDC_MessageClass', 'type':None, 'technology':'? (J-Phone)'}, # v4 page 75
- '1102':{'hex':'1102', 'name':'PDC_PresentationOption', 'type':None, 'technology':'? (J-Phone)'}, # v4 page 76
- '1103':{'hex':'1103', 'name':'PDC_AlertMechanism', 'type':None, 'technology':'? (J-Phone)'}, # v4 page 76
- '1104':{'hex':'1104', 'name':'PDC_Teleservice', 'type':None, 'technology':'? (J-Phone)'}, # v4 page 77
- '1105':{'hex':'1105', 'name':'PDC_MultiPartMessage', 'type':None, 'technology':'? (J-Phone)'}, # v4 page 77
- '1106':{'hex':'1106', 'name':'PDC_PredefinedMsg', 'type':None, 'technology':'? (J-Phone)'} # v4 page 78
+ '0005':{'hex':'0005', 'name':'dest_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.1, page 134
+ '0006':{'hex':'0006', 'name':'dest_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.3, page 135
+ '0007':{'hex':'0007', 'name':'dest_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.5, page 136
+ '0008':{'hex':'0008', 'name':'dest_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.7, page 137
+
+ '000d':{'hex':'000d', 'name':'source_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.2, page 134
+ '000e':{'hex':'000e', 'name':'source_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.4, page 135
+ '000f':{'hex':'000f', 'name':'source_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.6, page 136
+ '0010':{'hex':'0010', 'name':'source_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.8, page 137
+
+ '0017':{'hex':'0017', 'name':'qos_time_to_live', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.9, page 138
+ '0019':{'hex':'0019', 'name':'payload_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.10, page 138
+
+ '001d':{'hex':'001d', 'name':'additional_status_info_text', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.11, page 139
+ '001e':{'hex':'001e', 'name':'receipted_message_id', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.12, page 139
+
+ '0030':{'hex':'0030', 'name':'ms_msg_wait_facilities', 'type':'bitmask', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.13, page 140
+
+ '0101':{'hex':'0101', 'name':'PVCY_AuthenticationStr', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 58-62
+
+ '0201':{'hex':'0201', 'name':'privacy_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.14, page 141
+ '0202':{'hex':'0202', 'name':'source_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.15, page 142
+ '0203':{'hex':'0203', 'name':'dest_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.16, page 143
+ '0204':{'hex':'0204', 'name':'user_message_reference', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.17, page 143
+ '0205':{'hex':'0205', 'name':'user_response_code', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.18, page 144
+
+ '020a':{'hex':'020a', 'name':'source_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.20, page 145
+ '020b':{'hex':'020b', 'name':'destination_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.21, page 145
+ '020c':{'hex':'020c', 'name':'sar_msg_ref_num', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.22, page 146
+ '020d':{'hex':'020d', 'name':'language_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.19, page 144
+ '020e':{'hex':'020e', 'name':'sar_total_segments', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.23, page 147
+ '020f':{'hex':'020f', 'name':'sar_segment_seqnum', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.24, page 147
+ '0210':{'hex':'0210', 'name':'sc_interface_version', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.25, page 148
+
+ '0301':{'hex':'0301', 'name':'CC_CBN', 'type':None, 'tech':'V4'}, # v4 page 70
+ '0302':{'hex':'0302', 'name':'callback_num_pres_ind', 'type':'bitmask', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.37, page 156
+ '0303':{'hex':'0303', 'name':'callback_num_atag', 'type':'hex', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.38, page 157
+ '0304':{'hex':'0304', 'name':'number_of_messages', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.39, page 158
+ '0381':{'hex':'0381', 'name':'callback_num', 'type':'hex', 'tech':'CDMA, TDMA, GSM, iDEN'}, # SMPP v3.4, section 5.3.2.36, page 155
+
+ '0420':{'hex':'0420', 'name':'dpf_result', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.28, page 149
+ '0421':{'hex':'0421', 'name':'set_dpf', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.29, page 150
+ '0422':{'hex':'0422', 'name':'ms_availability_status', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.30, page 151
+ '0423':{'hex':'0423', 'name':'network_error_code', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.31, page 152
+ '0424':{'hex':'0424', 'name':'message_payload', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.32, page 153
+ '0425':{'hex':'0425', 'name':'delivery_failure_reason', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.33, page 153
+ '0426':{'hex':'0426', 'name':'more_messages_to_send', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.34, page 154
+ '0427':{'hex':'0427', 'name':'message_state', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.35, page 154
+ '0428':{'hex':'0428', 'name':'congestion_state', 'type':None, 'tech':'Generic'},
+
+ '0501':{'hex':'0501', 'name':'ussd_service_op', 'type':'hex', 'tech':'GSM (USSD)'}, # SMPP v3.4, section 5.3.2.44, page 161
+
+ '0600':{'hex':'0600', 'name':'broadcast_channel_indicator', 'type':None, 'tech':'GSM'},
+ '0601':{'hex':'0601', 'name':'broadcast_content_type', 'type':None, 'tech':'CDMA, TDMA, GSM'},
+ '0602':{'hex':'0602', 'name':'broadcast_content_type_info', 'type':None, 'tech':'CDMA, TDMA'},
+ '0603':{'hex':'0603', 'name':'broadcast_message_class', 'type':None, 'tech':'GSM'},
+ '0604':{'hex':'0604', 'name':'broadcast_rep_num', 'type':None, 'tech':'GSM'},
+ '0605':{'hex':'0605', 'name':'broadcast_frequency_interval', 'type':None, 'tech':'CDMA, TDMA, GSM'},
+ '0606':{'hex':'0606', 'name':'broadcast_area_identifier', 'type':None, 'tech':'CDMA, TDMA, GSM'},
+ '0607':{'hex':'0607', 'name':'broadcast_error_status', 'type':None, 'tech':'CDMA, TDMA, GSM'},
+ '0608':{'hex':'0608', 'name':'broadcast_area_success', 'type':None, 'tech':'GSM'},
+ '0609':{'hex':'0609', 'name':'broadcast_end_time', 'type':None, 'tech':'CDMA, TDMA, GSM'},
+ '060a':{'hex':'060a', 'name':'broadcast_service_group', 'type':None, 'tech':'CDMA, TDMA'},
+ '060b':{'hex':'060b', 'name':'billing_identification', 'type':None, 'tech':'Generic'},
+
+ '060d':{'hex':'060d', 'name':'source_network_id', 'type':None, 'tech':'Generic'},
+ '060e':{'hex':'060e', 'name':'dest_network_id', 'type':None, 'tech':'Generic'},
+ '060f':{'hex':'060f', 'name':'source_node_id', 'type':None, 'tech':'Generic'},
+ '0610':{'hex':'0610', 'name':'dest_node_id', 'type':None, 'tech':'Generic'},
+ '0611':{'hex':'0611', 'name':'dest_addr_np_resolution', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
+ '0612':{'hex':'0612', 'name':'dest_addr_np_information', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
+ '0613':{'hex':'0613', 'name':'dest_addr_np_country', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
+
+ '1101':{'hex':'1101', 'name':'PDC_MessageClass', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 75
+ '1102':{'hex':'1102', 'name':'PDC_PresentationOption', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
+ '1103':{'hex':'1103', 'name':'PDC_AlertMechanism', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
+ '1104':{'hex':'1104', 'name':'PDC_Teleservice', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
+ '1105':{'hex':'1105', 'name':'PDC_MultiPartMessage', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
+ '1106':{'hex':'1106', 'name':'PDC_PredefinedMsg', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 78
+
+ '1201':{'hex':'1201', 'name':'display_time', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.26, page 148
+
+ '1203':{'hex':'1203', 'name':'sms_signal', 'type':'integer', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.40, page 158
+ '1204':{'hex':'1204', 'name':'ms_validity', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.27, page 149
+
+ '1304':{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'type':None, 'tech':'CDMA'}, # v4 page 85
+ '1306':{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'type':None, 'tech':'CDMA'}, # v4 page 86
+
+ '130c':{'hex':'130c', 'name':'alert_on_message_delivery', 'type':None, 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.41, page 159
+
+ '1380':{'hex':'1380', 'name':'its_reply_type', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.42, page 159
+ '1383':{'hex':'1383', 'name':'its_session_info', 'type':'hex', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.43, page 160
+
+ '1402':{'hex':'1402', 'name':'operator_id', 'type':None, 'tech':'vendor extension'},
+ '1403':{'hex':'1403', 'name':'tariff', 'type':None, 'tech':'Mobile Network Code vendor extension'},
+ '1450':{'hex':'1450', 'name':'mcc', 'type':None, 'tech':'Mobile Country Code vendor extension'},
+ '1451':{'hex':'1451', 'name':'mnc', 'type':None, 'tech':'Mobile Network Code vendor extension'}
}
def optional_parameter_tag_name_by_hex(x):
return optional_parameter_tag_by_hex.get(x,{}).get('name')
def optional_parameter_tag_type_by_hex(x):
return optional_parameter_tag_by_hex.get(x,{}).get('type')
optional_parameter_tag_by_name = {
- 'dest_addr_subunit' :{'hex':'0005', 'name':'dest_addr_subunit', 'technology':'GSM'},
- 'dest_network_type' :{'hex':'0006', 'name':'dest_network_type', 'technology':'Generic'},
- 'dest_bearer_type' :{'hex':'0007', 'name':'dest_bearer_type', 'technology':'Generic'},
- 'dest_telematics_id' :{'hex':'0008', 'name':'dest_telematics_id', 'technology':'GSM'},
-
- 'source_addr_subunit' :{'hex':'000d', 'name':'source_addr_subunit', 'technology':'GSM'},
- 'source_network_type' :{'hex':'000e', 'name':'source_network_type', 'technology':'Generic'},
- 'source_bearer_type' :{'hex':'000f', 'name':'source_bearer_type', 'technology':'Generic'},
- 'source_telematics_id' :{'hex':'0010', 'name':'source_telematics_id', 'technology':'GSM'},
-
- 'qos_time_to_live' :{'hex':'0017', 'name':'qos_time_to_live', 'technology':'Generic'},
- 'payload_type' :{'hex':'0019', 'name':'payload_type', 'technology':'Generic'},
- 'additional_status_info_text' :{'hex':'001d', 'name':'additional_status_info_text', 'technology':'Generic'},
- 'receipted_message_id' :{'hex':'001e', 'name':'receipted_message_id', 'technology':'Generic'},
- 'ms_msg_wait_facilities' :{'hex':'0030', 'name':'ms_msg_wait_facilities', 'technology':'GSM'},
-
- 'PVCY_AuthenticationStr' :{'hex':'0101', 'name':'PVCY_AuthenticationStr', 'technology':'? (J-Phone)'}, # v4 page 58-62
-
- 'privacy_indicator' :{'hex':'0201', 'name':'privacy_indicator', 'technology':'CDMA,TDMA'},
- 'source_subaddress' :{'hex':'0202', 'name':'source_subaddress', 'technology':'CDMA,TDMA'}, # v4 page 65-67
- 'dest_subaddress' :{'hex':'0203', 'name':'dest_subaddress', 'technology':'CDMA,TDMA'}, # v4 page 65-67
- 'user_message_reference' :{'hex':'0204', 'name':'user_message_reference', 'technology':'Generic'},
- 'user_response_code' :{'hex':'0205', 'name':'user_response_code', 'technology':'CDMA,TDMA'},
- 'source_port' :{'hex':'020a', 'name':'source_port', 'technology':'WAP'},
- 'destination_port' :{'hex':'020b', 'name':'destination_port', 'technology':'WAP'},
- 'sar_msg_ref_num' :{'hex':'020c', 'name':'sar_msg_ref_num', 'technology':'Generic'},
- 'language_indicator' :{'hex':'020d', 'name':'language_indicator', 'technology':'CDMA,TDMA'},
- 'sar_total_segments' :{'hex':'020e', 'name':'sar_total_segments', 'technology':'Generic'},
- 'sar_segment_seqnum' :{'hex':'020f', 'name':'sar_segment_seqnum', 'technology':'Generic'},
- 'sc_interface_version' :{'hex':'0210', 'name':'sc_interface_version', 'technology':'Generic'},
-
- 'CC_CBN' :{'hex':'0301', 'name':'CC_CBN', 'technology':'V4'}, # v4 page 70
- 'callback_num_pres_ind' :{'hex':'0302', 'name':'callback_num_pres_ind', 'technology':'TDMA'}, # v4 page 71
- 'callback_num_atag' :{'hex':'0303', 'name':'callback_num_atag', 'technology':'TDMA'}, # v4 page 71
- 'number_of_messages' :{'hex':'0304', 'name':'number_of_messages', 'technology':'CDMA'}, # v4 page 72
- 'callback_num' :{'hex':'0381', 'name':'callback_num', 'technology':'CDMA,TDMA,GSM,iDEN'},
-
- 'dpf_result' :{'hex':'0420', 'name':'dpf_result', 'technology':'Generic'},
- 'set_dpf' :{'hex':'0421', 'name':'set_dpf', 'technology':'Generic'},
- 'ms_availability_status' :{'hex':'0422', 'name':'ms_availability_status', 'technology':'Generic'},
- 'network_error_code' :{'hex':'0423', 'name':'network_error_code', 'technology':'Generic'},
- 'message_payload' :{'hex':'0424', 'name':'message_payload', 'technology':'Generic'},
- 'delivery_failure_reason' :{'hex':'0425', 'name':'delivery_failure_reason', 'technology':'Generic'},
- 'more_messages_to_send' :{'hex':'0426', 'name':'more_messages_to_send', 'technology':'GSM'},
- 'message_state' :{'hex':'0427', 'name':'message_state', 'technology':'Generic'},
- 'congestion_state' :{'hex':'0428', 'name':'congestion_state', 'technology':'Generic'},
-
- 'ussd_service_op' :{'hex':'0501', 'name':'ussd_service_op', 'technology':'GSM (USSD)'},
-
- 'broadcast_channel_indicator' :{'hex':'0600', 'name':'broadcast_channel_indicator', 'technology':'GSM'},
- 'broadcast_content_type' :{'hex':'0601', 'name':'broadcast_content_type', 'technology':'CDMA, TDMA, GSM'},
- 'broadcast_content_type_info' :{'hex':'0602', 'name':'broadcast_content_type_info', 'technology':'CDMA, TDMA'},
- 'broadcast_message_class' :{'hex':'0603', 'name':'broadcast_message_class', 'technology':'GSM'},
- 'broadcast_rep_num' :{'hex':'0604', 'name':'broadcast_rep_num', 'technology':'GSM'},
- 'broadcast_frequency_interval':{'hex':'0605', 'name':'broadcast_frequency_interval', 'technology':'CDMA, TDMA, GSM'},
- 'broadcast_area_identifier' :{'hex':'0606', 'name':'broadcast_area_identifier', 'technology':'CDMA, TDMA, GSM'},
- 'broadcast_error_status' :{'hex':'0607', 'name':'broadcast_error_status', 'technology':'CDMA, TDMA, GSM'},
- 'broadcast_area_success' :{'hex':'0608', 'name':'broadcast_area_success', 'technology':'GSM'},
- 'broadcast_end_time' :{'hex':'0609', 'name':'broadcast_end_time', 'technology':'CDMA, TDMA, GSM'},
- 'broadcast_service_group' :{'hex':'060a', 'name':'broadcast_service_group', 'technology':'CDMA, TDMA'},
- 'billing_identification' :{'hex':'060b', 'name':'billing_identification', 'technology':'Generic'},
- 'source_network_id' :{'hex':'060d', 'name':'source_network_id', 'technology':'Generic'},
- 'dest_network_id' :{'hex':'060e', 'name':'dest_network_id', 'technology':'Generic'},
- 'source_node_id' :{'hex':'060f', 'name':'source_node_id', 'technology':'Generic'},
- 'dest_node_id' :{'hex':'0610', 'name':'dest_node_id', 'technology':'Generic'},
- 'dest_addr_np_resolution' :{'hex':'0611', 'name':'dest_addr_np_resolution', 'technology':'CDMA, TDMA (US Only)'},
- 'dest_addr_np_information' :{'hex':'0612', 'name':'dest_addr_np_information', 'technology':'CDMA, TDMA (US Only)'},
- 'dest_addr_np_country' :{'hex':'0613', 'name':'dest_addr_np_country', 'technology':'CDMA, TDMA (US Only)'},
-
- 'display_time' :{'hex':'1201', 'name':'display_time', 'technology':'CDMA,TDMA'},
- 'sms_signal' :{'hex':'1203', 'name':'sms_signal', 'technology':'TDMA'},
- 'ms_validity' :{'hex':'1204', 'name':'ms_validity', 'technology':'CDMA,TDMA'},
-
- 'IS95A_AlertOnDelivery' :{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'technology':'CDMA'}, # v4 page 85
- 'IS95A_LanguageIndicator' :{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'technology':'CDMA'}, # v4 page 86
- 'alert_on_message_delivery' :{'hex':'130c', 'name':'alert_on_message_delivery', 'technology':'CDMA'},
- 'its_reply_type' :{'hex':'1380', 'name':'its_reply_type', 'technology':'CDMA'},
- 'its_session_info' :{'hex':'1383', 'name':'its_session_info', 'technology':'CDMA Korean [KORITS]'},
-
- 'operator_id' :{'hex':'1402', 'name':'operator_id', 'technology':'vendor extension'},
- 'tariff' :{'hex':'1403', 'name':'tariff', 'technology':'Mobile Network Code vendor extension'},
- 'mcc' :{'hex':'1450', 'name':'mcc', 'technology':'Mobile Country Code vendor extension'},
- 'mnc' :{'hex':'1451', 'name':'mnc', 'technology':'Mobile Network Code vendor extension'},
-
- 'PDC_MessageClass' :{'hex':'1101', 'name':'PDC_MessageClass', 'technology':'? (J-Phone)'}, # v4 page 75
- 'PDC_PresentationOption' :{'hex':'1102', 'name':'PDC_PresentationOption', 'technology':'? (J-Phone)'}, # v4 page 76
- 'PDC_AlertMechanism' :{'hex':'1103', 'name':'PDC_AlertMechanism', 'technology':'? (J-Phone)'}, # v4 page 76
- 'PDC_Teleservice' :{'hex':'1104', 'name':'PDC_Teleservice', 'technology':'? (J-Phone)'}, # v4 page 77
- 'PDC_MultiPartMessage' :{'hex':'1105', 'name':'PDC_MultiPartMessage', 'technology':'? (J-Phone)'}, # v4 page 77
- 'PDC_PredefinedMsg' :{'hex':'1106', 'name':'PDC_PredefinedMsg', 'technology':'? (J-Phone)'} # v4 page 78
+ 'dest_addr_subunit' :{'hex':'0005', 'name':'dest_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.1, page 134
+ 'dest_network_type' :{'hex':'0006', 'name':'dest_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.3, page 135
+ 'dest_bearer_type' :{'hex':'0007', 'name':'dest_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.5, page 136
+ 'dest_telematics_id' :{'hex':'0008', 'name':'dest_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.7, page 137
+
+ 'source_addr_subunit' :{'hex':'000d', 'name':'source_addr_subunit', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.2, page 134
+ 'source_network_type' :{'hex':'000e', 'name':'source_network_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.4, page 135
+ 'source_bearer_type' :{'hex':'000f', 'name':'source_bearer_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.6, page 136
+ 'source_telematics_id' :{'hex':'0010', 'name':'source_telematics_id', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.8, page 137
+
+ 'qos_time_to_live' :{'hex':'0017', 'name':'qos_time_to_live', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.9, page 138
+ 'payload_type' :{'hex':'0019', 'name':'payload_type', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.10, page 138
+
+ 'additional_status_info_text' :{'hex':'001d', 'name':'additional_status_info_text', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.11, page 139
+ 'receipted_message_id' :{'hex':'001e', 'name':'receipted_message_id', 'type':'string', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.12, page 139
+
+ 'ms_msg_wait_facilities' :{'hex':'0030', 'name':'ms_msg_wait_facilities', 'type':'bitmask', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.13, page 140
+
+ 'PVCY_AuthenticationStr' :{'hex':'0101', 'name':'PVCY_AuthenticationStr', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 58-62
+
+ 'privacy_indicator' :{'hex':'0201', 'name':'privacy_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.14, page 141
+ 'source_subaddress' :{'hex':'0202', 'name':'source_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.15, page 142
+ 'dest_subaddress' :{'hex':'0203', 'name':'dest_subaddress', 'type':'hex', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.16, page 143
+ 'user_message_reference' :{'hex':'0204', 'name':'user_message_reference', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.17, page 143
+ 'user_response_code' :{'hex':'0205', 'name':'user_response_code', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.18, page 144
+
+ 'source_port' :{'hex':'020a', 'name':'source_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.20, page 145
+ 'destination_port' :{'hex':'020b', 'name':'destination_port', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.21, page 145
+ 'sar_msg_ref_num' :{'hex':'020c', 'name':'sar_msg_ref_num', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.22, page 146
+ 'language_indicator' :{'hex':'020d', 'name':'language_indicator', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.19, page 144
+ 'sar_total_segments' :{'hex':'020e', 'name':'sar_total_segments', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.23, page 147
+ 'sar_segment_seqnum' :{'hex':'020f', 'name':'sar_segment_seqnum', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.24, page 147
+ 'sc_interface_version' :{'hex':'0210', 'name':'sc_interface_version', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.25, page 148
+
+ 'CC_CBN' :{'hex':'0301', 'name':'CC_CBN', 'type':None, 'tech':'V4'}, # v4 page 70
+ 'callback_num_pres_ind' :{'hex':'0302', 'name':'callback_num_pres_ind', 'type':'bitmask', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.37, page 156
+ 'callback_num_atag' :{'hex':'0303', 'name':'callback_num_atag', 'type':'hex', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.38, page 157
+ 'number_of_messages' :{'hex':'0304', 'name':'number_of_messages', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.39, page 158
+ 'callback_num' :{'hex':'0381', 'name':'callback_num', 'type':'hex', 'tech':'CDMA, TDMA, GSM, iDEN'}, # SMPP v3.4, section 5.3.2.36, page 155
+
+ 'dpf_result' :{'hex':'0420', 'name':'dpf_result', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.28, page 149
+ 'set_dpf' :{'hex':'0421', 'name':'set_dpf', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.29, page 150
+ 'ms_availability_status' :{'hex':'0422', 'name':'ms_availability_status', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.30, page 151
+ 'network_error_code' :{'hex':'0423', 'name':'network_error_code', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.31, page 152
+ 'message_payload' :{'hex':'0424', 'name':'message_payload', 'type':'hex', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.32, page 153
+ 'delivery_failure_reason' :{'hex':'0425', 'name':'delivery_failure_reason', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.33, page 153
+ 'more_messages_to_send' :{'hex':'0426', 'name':'more_messages_to_send', 'type':'integer', 'tech':'GSM'}, # SMPP v3.4, section 5.3.2.34, page 154
+ 'message_state' :{'hex':'0427', 'name':'message_state', 'type':'integer', 'tech':'Generic'}, # SMPP v3.4, section 5.3.2.35, page 154
+ 'congestion_state' :{'hex':'0428', 'name':'congestion_state', 'type':None, 'tech':'Generic'},
+
+ 'ussd_service_op' :{'hex':'0501', 'name':'ussd_service_op', 'type':'hex', 'tech':'GSM (USSD)'}, # SMPP v3.4, section 5.3.2.44, page 161
+
+ 'broadcast_channel_indicator' :{'hex':'0600', 'name':'broadcast_channel_indicator', 'type':None, 'tech':'GSM'},
+ 'broadcast_content_type' :{'hex':'0601', 'name':'broadcast_content_type', 'type':None, 'tech':'CDMA, TDMA, GSM'},
+ 'broadcast_content_type_info' :{'hex':'0602', 'name':'broadcast_content_type_info', 'type':None, 'tech':'CDMA, TDMA'},
+ 'broadcast_message_class' :{'hex':'0603', 'name':'broadcast_message_class', 'type':None, 'tech':'GSM'},
+ 'broadcast_rep_num' :{'hex':'0604', 'name':'broadcast_rep_num', 'type':None, 'tech':'GSM'},
+ 'broadcast_frequency_interval':{'hex':'0605', 'name':'broadcast_frequency_interval', 'type':None, 'tech':'CDMA, TDMA, GSM'},
+ 'broadcast_area_identifier' :{'hex':'0606', 'name':'broadcast_area_identifier', 'type':None, 'tech':'CDMA, TDMA, GSM'},
+ 'broadcast_error_status' :{'hex':'0607', 'name':'broadcast_error_status', 'type':None, 'tech':'CDMA, TDMA, GSM'},
+ 'broadcast_area_success' :{'hex':'0608', 'name':'broadcast_area_success', 'type':None, 'tech':'GSM'},
+ 'broadcast_end_time' :{'hex':'0609', 'name':'broadcast_end_time', 'type':None, 'tech':'CDMA, TDMA, GSM'},
+ 'broadcast_service_group' :{'hex':'060a', 'name':'broadcast_service_group', 'type':None, 'tech':'CDMA, TDMA'},
+ 'billing_identification' :{'hex':'060b', 'name':'billing_identification', 'type':None, 'tech':'Generic'},
+
+ 'source_network_id' :{'hex':'060d', 'name':'source_network_id', 'type':None, 'tech':'Generic'},
+ 'dest_network_id' :{'hex':'060e', 'name':'dest_network_id', 'type':None, 'tech':'Generic'},
+ 'source_node_id' :{'hex':'060f', 'name':'source_node_id', 'type':None, 'tech':'Generic'},
+ 'dest_node_id' :{'hex':'0610', 'name':'dest_node_id', 'type':None, 'tech':'Generic'},
+ 'dest_addr_np_resolution' :{'hex':'0611', 'name':'dest_addr_np_resolution', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
+ 'dest_addr_np_information' :{'hex':'0612', 'name':'dest_addr_np_information', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
+ 'dest_addr_np_country' :{'hex':'0613', 'name':'dest_addr_np_country', 'type':None, 'tech':'CDMA, TDMA (US Only)'},
+
+ 'PDC_MessageClass' :{'hex':'1101', 'name':'PDC_MessageClass', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 75
+ 'PDC_PresentationOption' :{'hex':'1102', 'name':'PDC_PresentationOption', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
+ 'PDC_AlertMechanism' :{'hex':'1103', 'name':'PDC_AlertMechanism', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 76
+ 'PDC_Teleservice' :{'hex':'1104', 'name':'PDC_Teleservice', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
+ 'PDC_MultiPartMessage' :{'hex':'1105', 'name':'PDC_MultiPartMessage', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 77
+ 'PDC_PredefinedMsg' :{'hex':'1106', 'name':'PDC_PredefinedMsg', 'type':None, 'tech':'? (J-Phone)'}, # v4 page 78
+
+ 'display_time' :{'hex':'1201', 'name':'display_time', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.26, page 148
+
+ 'sms_signal' :{'hex':'1203', 'name':'sms_signal', 'type':'integer', 'tech':'TDMA'}, # SMPP v3.4, section 5.3.2.40, page 158
+ 'ms_validity' :{'hex':'1204', 'name':'ms_validity', 'type':'integer', 'tech':'CDMA, TDMA'}, # SMPP v3.4, section 5.3.2.27, page 149
+
+ 'IS95A_AlertOnDelivery' :{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'type':None, 'tech':'CDMA'}, # v4 page 85
+ 'IS95A_LanguageIndicator' :{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'type':None, 'tech':'CDMA'}, # v4 page 86
+
+ 'alert_on_message_delivery' :{'hex':'130c', 'name':'alert_on_message_delivery', 'type':None, 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.41, page 159
+
+ 'its_reply_type' :{'hex':'1380', 'name':'its_reply_type', 'type':'integer', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.42, page 159
+ 'its_session_info' :{'hex':'1383', 'name':'its_session_info', 'type':'hex', 'tech':'CDMA'}, # SMPP v3.4, section 5.3.2.43, page 160
+
+ 'operator_id' :{'hex':'1402', 'name':'operator_id', 'type':None, 'tech':'vendor extension'},
+ 'tariff' :{'hex':'1403', 'name':'tariff', 'type':None, 'tech':'Mobile Network Code vendor extension'},
+ 'mcc' :{'hex':'1450', 'name':'mcc', 'type':None, 'tech':'Mobile Country Code vendor extension'},
+ 'mnc' :{'hex':'1451', 'name':'mnc', 'type':None, 'tech':'Mobile Network Code vendor extension'}
}
def optional_parameter_tag_hex_by_name(n):
return optional_parameter_tag_by_name.get(n,{}).get('hex')
#### Decoding functions #######################################################
def unpack_pdu(pdu_bin):
#return binascii.b2a_hex(pdu_bin)
return decode_pdu(binascii.b2a_hex(pdu_bin))
def decode_pdu(pdu_hex):
print '\n===================================================='
hex_ref = [pdu_hex]
pdu = {}
pdu['header'] = decode_header(hex_ref)
command = pdu['header'].get('command_id', None)
if command != None:
pdu['body'] = decode_body(command, hex_ref)
print '====================================================\n'
return pdu
def decode_header(hex_ref):
pdu_hex = hex_ref[0]
header = {}
(command_length, command_id, command_status, sequence_number, hex_ref[0]) = \
(pdu_hex[0:8], pdu_hex[8:16], pdu_hex[16:24], pdu_hex[24:32], pdu_hex[32: ])
length = int(command_length, 16)
command = command_id_name_by_hex(command_id)
status = command_status_name_by_hex(command_status)
sequence = int(sequence_number, 16)
header = {}
header['command_length'] = length
header['command_id'] = command
header['command_status'] = status
header['sequence_number'] = sequence
print 'h==>', 'command_length', ':', repr(header['command_length'])
print 'h==>', 'command_id', ':', repr(header['command_id'])
print 'h==>', 'command_status', ':', repr(header['command_status'])
print 'h==>', 'sequence_number', ':', repr(header['sequence_number'])
return header
def decode_body(command, hex_ref):
body = {}
body['mandatory_parameters'] = None
if command != None:
fields = mandatory_parameter_list_by_command_name(command)
body['mandatory_parameters'] = decode_mandatory_parameters(fields, hex_ref)
body['optional_parameters'] = decode_optional_parameters(hex_ref)
return body
def decode_mandatory_parameters(fields, hex_ref):
mandatory_parameters = {}
if len(hex_ref[0]) > 1:
for field in fields:
data = ''
octet = ''
count = 0
if field['var'] == True or field['var'] == False:
while (len(hex_ref[0]) > 1
and (count < field['min']
or (count < field['max']
and octet != '00'))):
octet = octpop(hex_ref)
data += octet
count += 1
elif field['type'] == 'string':
count = mandatory_parameters[field['var']]
for i in range(count):
if len(hex_ref[0]) > 1:
data += octpop(hex_ref)
else:
count = mandatory_parameters[field['var']]
if field['map'] != None:
mandatory_parameters[field['name']] = maps.get(field['map']+'_by_hex',{data:data})[data]
else:
mandatory_parameters[field['name']] = decode_hex_type(data, field['type'], count, hex_ref)
print 'm==>', field['name'], ':', repr(mandatory_parameters[field['name']])
return mandatory_parameters
def decode_optional_parameters(hex_ref):
optional_parameters = []
hex = hex_ref[0]
while len(hex) > 0:
(tag_hex, length_hex, rest) = (hex[0:4], hex[4:8], hex[8: ])
tag = optional_parameter_tag_name_by_hex(tag_hex)
+ if tag == None:
+ tag = tag_hex
length = int(length_hex, 16)
(value_hex, tail) = (rest[0:length*2], rest[length*2: ])
if len(value_hex) == 0:
value = None
else:
value = decode_hex_type(value_hex, optional_parameter_tag_type_by_hex(tag_hex))
hex = tail
optional_parameters.append({'tag':tag, 'length':length, 'value':value})
print 'o==>', tag, '[', length, ']', ':', repr(value)
return optional_parameters
def decode_hex_type(hex, type, count=0, hex_ref=['']):
if type == 'integer':
return int(hex, 16)
elif type == 'string':
return binascii.b2a_qp(binascii.a2b_hex(re.sub('00','',hex)))
elif (type == 'dest_address'
or type == 'unsuccess_sme'):
list = []
fields = mandatory_parameter_list_by_command_name(type)
for i in range(count):
item = decode_mandatory_parameters(fields, hex_ref)
if item.get('dest_flag', None) == 1: # 'dest_address' only
subfields = mandatory_parameter_list_by_command_name('sme_dest_address')
rest = decode_mandatory_parameters(subfields, hex_ref)
item.update(rest)
elif item.get('dest_flag', None) == 2: # 'dest_address' only
subfields = mandatory_parameter_list_by_command_name('distribution_list')
rest = decode_mandatory_parameters(subfields, hex_ref)
item.update(rest)
list.append(item)
return list
else:
return hex
def octpop(hex_ref):
octet = None
if len(hex_ref[0]) > 1:
(octet, hex_ref[0]) = (hex_ref[0][0:2], hex_ref[0][2: ])
return octet
#### Encoding functions #######################################################
def pack_pdu(command='bind_transmitter', status='ESME_ROK', sequence=0, body_hex=''):
length = 16 + len(body_hex)/2
command_length = '%08x' % length
command_id = command_id_hex_by_name(command)
command_status = command_status_hex_by_name(status)
sequence_number = '%08x' % sequence
pdu_hex = command_length + command_id + command_status + sequence_number + body_hex
return binascii.a2b_hex(pdu_hex)
def encode_mandatory_parameters(fields, json):
mandatory_hex = ''
return mandatory_hex
def encode_optional_parameter(tag, value):
optional_hex = ''
tag_hex = optional_parameter_tag_hex_by_name(tag)
if tag_hex != None:
value_hex = '%02x' % value #TODO need encoding mapping
length_hex = '%04x' % (len(value_hex)/2)
optional_hex = tag_hex + length_hex + value_hex
return optional_hex
def json_to_pdu(json):
header = json.get('header', {})
body_hex = ''
body = json.get('body', {})
for opt in body.get('optional_parameters',[]):
body_hex += encode_optional_parameter(opt['tag'], opt['value'])
return pack_pdu(header['command_id'], header['command_status'], header['sequence_number'], body_hex)
|
dmaclay/python-smpp
|
48316dbfc26ce8030ac3116f88a843421c76f5a2
|
optional parameter value types
|
diff --git a/smpp/pdu.py b/smpp/pdu.py
index 390b2ea..0fdf158 100644
--- a/smpp/pdu.py
+++ b/smpp/pdu.py
@@ -1,945 +1,948 @@
import binascii
import re
maps = {} # Inserting certain referenced dicts in here means they can be declared in the same order as in the spec.
# SMPP PDU Definition - SMPP v3.4, section 4, page 45
mandatory_parameter_lists = {
'bind_transmitter':[ # SMPP v3.4, section 4.1.1, table 4-1, page 46
- {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':'addr_ton_by_hex'},
- {'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':'addr_npi_by_hex'},
- {'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'hex_map':None}
+ {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None},
+ {'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'map':None},
+ {'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'map':None},
+ {'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'string', 'map':None},
+ {'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
+ {'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
+ {'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'map':None}
],
'bind_transmitter_resp':[ # SMPP v3.4, section 4.1.2, table 4-2, page 47
- {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None}
+ {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None}
],
'bind_receiver':[ # SMPP v3.4, section 4.1.3, table 4-3, page 48
- {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':'addr_ton_by_hex'},
- {'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':'addr_npi_by_hex'},
- {'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'hex_map':None}
+ {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None},
+ {'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'map':None},
+ {'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'map':None},
+ {'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'string', 'map':None},
+ {'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
+ {'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
+ {'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'map':None}
],
'bind_receiver_resp':[ # SMPP v3.4, section 4.1.4, table 4-4, page 50
- {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None}
+ {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None}
],
'bind_transceiver':[ # SMPP v3.4, section 4.1.5, table 4-5, page 51
- {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':'addr_ton_by_hex'},
- {'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':'addr_npi_by_hex'},
- {'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'hex_map':None}
+ {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None},
+ {'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'map':None},
+ {'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'map':None},
+ {'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'string', 'map':None},
+ {'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
+ {'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
+ {'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'map':None}
],
'bind_transceiver_resp':[ # SMPP v3.4, section 4.1.6, table 4-6, page 52
- {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None}
+ {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None}
],
'outbind':[ # SMPP v3.4, section 4.1.7.1, page 54
- {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'hex_map':None}
+ {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'map':None},
+ {'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'map':None}
],
'unbind':[ # SMPP v3.4, section 4.2.1, table 4-7, page 56
],
'unbind_resp':[ # SMPP v3.4, section 4.2.2, table 4-8, page 56
],
'generic_nack':[ # SMPP v3.4, section 4.3.1, table 4-9, page 57
],
'submit_sm':[ # SMPP v3.4, section 4.4.1, table 4-10, page 59-61
- {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'hex_map':None}
+ {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'map':None},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
+ {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
+ {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
+ {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
+ {'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
+ {'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
+ {'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
+ {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'map':None}
],
'submit_sm_resp':[ # SMPP v3.4, section 4.4.2, table 4-11, page 67
- {'name':'message_id', 'min':0, 'max':65, 'var':True, 'type':'string', 'hex_map':None}
+ {'name':'message_id', 'min':0, 'max':65, 'var':True, 'type':'string', 'map':None}
],
'submit_multi':[ # SMPP v3.4, section 4.5.1, table 4-12, page 69-71
- {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'number_of_dests', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'dest_address', 'min':0, 'max':0, 'var':'number_of_dests', 'type':'dest_address', 'hex_map':None},
- {'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'hex_map':None}
+ {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'map':None},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
+ {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
+ {'name':'number_of_dests', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'dest_address', 'min':0, 'max':0, 'var':'number_of_dests', 'type':'dest_address', 'map':None},
+ {'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
+ {'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
+ {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'map':None}
],
'dest_address':[ # SMPP v3.4, section 4.5.1.1, table 4-13, page 75
- {'name':'dest_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None}
+ {'name':'dest_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None}
# 'sme_dest_address' or 'distribution_list' goes here
],
'sme_dest_address':[ # SMPP v3.4, section 4.5.1.1, table 4-14, page 75
- {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None}
+ {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
+ {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
+ {'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None}
],
'distribution_list':[ # SMPP v3.4, section 4.5.1.2, table 4-15, page 75
- {'name':'dl_name', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None}
+ {'name':'dl_name', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None}
],
'submit_multi_resp':[ # SMPP v3.4, section 4.5.2, table 4-16, page 76
- {'name':'message_id', 'min':0, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'no_unsuccess', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'unsuccess_sme', 'min':0, 'max':0, 'var':'no_unsuccess', 'type':'unsuccess_sme', 'hex_map':None}
+ {'name':'message_id', 'min':0, 'max':65, 'var':True, 'type':'string', 'map':None},
+ {'name':'no_unsuccess', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'unsuccess_sme', 'min':0, 'max':0, 'var':'no_unsuccess', 'type':'unsuccess_sme', 'map':None}
],
'unsuccess_sme':[ # SMPP v3.4, section 4.5.2.1, table 4-17, page 77
- {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'error_status_code', 'min':4, 'max':4, 'var':False, 'type':'integer', 'hex_map':None}
+ {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
+ {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
+ {'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
+ {'name':'error_status_code', 'min':4, 'max':4, 'var':False, 'type':'integer', 'map':None}
],
'deliver_sm':[ # SMPP v3.4, section 4.6.1, table 4-18, page 79-81
- {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'schedule_delivery_time', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'validity_period', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'hex_map':None}
+ {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'map':None},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
+ {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
+ {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
+ {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
+ {'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
+ {'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'schedule_delivery_time', 'min':1, 'max':1, 'var':False, 'type':'string', 'map':None},
+ {'name':'validity_period', 'min':1, 'max':1, 'var':False, 'type':'string', 'map':None},
+ {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'map':None}
],
'deliver_sm_resp':[ # SMPP v3.4, section 4.6.2, table 4-19, page 85
- {'name':'message_id', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None}
+ {'name':'message_id', 'min':1, 'max':1, 'var':False, 'type':'string', 'map':None}
],
'data_sm':[ # SMPP v3.4, section 4.7.1, table 4-20, page 87-88
- {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'source_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'destination_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None}
+ {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'map':None},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
+ {'name':'source_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
+ {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
+ {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
+ {'name':'destination_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
+ {'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None}
],
'data_sm_resp':[ # SMPP v3.4, section 4.7.2, table 4-21, page 93
- {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None}
+ {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None}
],
'query_sm':[ # SMPP v3.4, section 4.8.1, table 4-22, page 95
- {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None}
+ {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
+ {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None}
],
'query_sm_resp':[ # SMPP v3.4, section 4.7.2, table 4-21, page 93
- {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'final_date', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'message_state', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'error_code', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None}
+ {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
+ {'name':'final_date', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
+ {'name':'message_state', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'error_code', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None}
],
'cancel_sm':[ # SMPP v3.4, section 4.9.1, table 4-24, page 98-99
- {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None}
+ {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'map':None},
+ {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
+ {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
+ {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
+ {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
+ {'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None}
],
'cancel_sm_resp':[ # SMPP v3.4, section 4.9.2, table 4-25, page 100
],
'replace_sm':[ # SMPP v3.4, section 4.10.1, table 4-26, page 102-103
- {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'hex_map':None}
+ {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
+ {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'map':None},
+ {'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
+ {'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'map':None},
+ {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':None},
+ {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'map':None}
],
'replace_sm_resp':[ # SMPP v3.4, section 4.10.2, table 4-27, page 104
],
'enquire_link':[ # SMPP v3.4, section 4.11.1, table 4-28, page 106
],
'enquire_link_resp':[ # SMPP v3.4, section 4.11.2, table 4-29, page 106
],
'alert_notification':[ # SMPP v3.4, section 4.12.1, table 4-30, page 108
- {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'source_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'esme_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'esme_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'esme_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
+ {'name':'source_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
+ {'name':'esme_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_ton'},
+ {'name':'esme_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'map':'addr_npi'},
+ {'name':'esme_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'map':None},
]
}
def mandatory_parameter_list_by_command_name(command_name):
return mandatory_parameter_lists.get(command_name,[])
# Command IDs - SMPP v3.4, section 5.1.2.1, table 5-1, page 110-111
command_id_by_hex = {
'80000000':{'hex':'80000000', 'name':'generic_nack'},
'00000001':{'hex':'00000001', 'name':'bind_receiver'},
'80000001':{'hex':'80000001', 'name':'bind_receiver_resp'},
'00000002':{'hex':'00000002', 'name':'bind_transmitter'},
'80000002':{'hex':'80000002', 'name':'bind_transmitter_resp'},
'00000003':{'hex':'00000003', 'name':'query_sm'},
'80000003':{'hex':'80000003', 'name':'query_sm_resp'},
'00000004':{'hex':'00000004', 'name':'submit_sm'},
'80000004':{'hex':'80000004', 'name':'submit_sm_resp'},
'00000005':{'hex':'00000005', 'name':'deliver_sm'},
'80000005':{'hex':'80000005', 'name':'deliver_sm_resp'},
'00000006':{'hex':'00000006', 'name':'unbind'},
'80000006':{'hex':'80000006', 'name':'unbind_resp'},
'00000007':{'hex':'00000007', 'name':'replace_sm'},
'80000007':{'hex':'80000007', 'name':'replace_sm_resp'},
'00000008':{'hex':'00000008', 'name':'cancel_sm'},
'80000008':{'hex':'80000008', 'name':'cancel_sm_resp'},
'00000009':{'hex':'00000009', 'name':'bind_transceiver'},
'80000009':{'hex':'80000009', 'name':'bind_transceiver_resp'},
'0000000b':{'hex':'0000000b', 'name':'outbind'},
'00000015':{'hex':'00000015', 'name':'enquire_link'},
'80000015':{'hex':'80000015', 'name':'enquire_link_resp'},
'00000021':{'hex':'00000021', 'name':'submit_multi'},
'80000021':{'hex':'80000021', 'name':'submit_multi_resp'},
'00000102':{'hex':'00000102', 'name':'alert_notification'},
'00000103':{'hex':'00000103', 'name':'data_sm'},
'80000103':{'hex':'80000103', 'name':'data_sm_resp'},
# v4 codes
'80010000':{'hex':'80010000', 'name':'generic_nack_v4'},
'00010001':{'hex':'00010001', 'name':'bind_receiver_v4'},
'80010001':{'hex':'80010001', 'name':'bind_receiver_resp_v4'},
'00010002':{'hex':'00010002', 'name':'bind_transmitter_v4'},
'80010002':{'hex':'80010002', 'name':'bind_transmitter_resp_v4'},
'00010003':{'hex':'00010003', 'name':'query_sm_v4'},
'80010003':{'hex':'80010003', 'name':'query_sm_resp_v4'},
'00010004':{'hex':'00010004', 'name':'submit_sm_v4'},
'80010004':{'hex':'80010004', 'name':'submit_sm_resp_v4'},
'00010005':{'hex':'00010005', 'name':'deliver_sm_v4'},
'80010005':{'hex':'80010005', 'name':'deliver_sm_resp_v4'},
'00010006':{'hex':'00010006', 'name':'unbind_v4'},
'80010006':{'hex':'80010006', 'name':'unbind_resp_v4'},
'00010007':{'hex':'00010007', 'name':'replace_sm_v4'},
'80010007':{'hex':'80010007', 'name':'replace_sm_resp_v4'},
'00010008':{'hex':'00010008', 'name':'cancel_sm_v4'},
'80010008':{'hex':'80010008', 'name':'cancel_sm_resp_v4'},
'00010009':{'hex':'00010009', 'name':'delivery_receipt_v4'},
'80010009':{'hex':'80010009', 'name':'delivery_receipt_resp_v4'},
'0001000a':{'hex':'0001000a', 'name':'enquire_link_v4'},
'8001000a':{'hex':'8001000a', 'name':'enquire_link_resp_v4'},
'0001000b':{'hex':'0001000b', 'name':'outbind_v4'},
}
def command_id_name_by_hex(x):
return command_id_by_hex.get(x,{}).get('name')
command_id_by_name = {
'generic_nack' :{'hex':'80000000', 'name':'generic_nack'},
'bind_receiver' :{'hex':'00000001', 'name':'bind_receiver'},
'bind_receiver_resp' :{'hex':'80000001', 'name':'bind_receiver_resp'},
'bind_transmitter' :{'hex':'00000002', 'name':'bind_transmitter'},
'bind_transmitter_resp' :{'hex':'80000002', 'name':'bind_transmitter_resp'},
'query_sm' :{'hex':'00000003', 'name':'query_sm'},
'query_sm_resp' :{'hex':'80000003', 'name':'query_sm_resp'},
'submit_sm' :{'hex':'00000004', 'name':'submit_sm'},
'submit_sm_resp' :{'hex':'80000004', 'name':'submit_sm_resp'},
'deliver_sm' :{'hex':'00000005', 'name':'deliver_sm'},
'deliver_sm_resp' :{'hex':'80000005', 'name':'deliver_sm_resp'},
'unbind' :{'hex':'00000006', 'name':'unbind'},
'unbind_resp' :{'hex':'80000006', 'name':'unbind_resp'},
'replace_sm' :{'hex':'00000007', 'name':'replace_sm'},
'replace_sm_resp' :{'hex':'80000007', 'name':'replace_sm_resp'},
'cancel_sm' :{'hex':'00000008', 'name':'cancel_sm'},
'cancel_sm_resp' :{'hex':'80000008', 'name':'cancel_sm_resp'},
'bind_transceiver' :{'hex':'00000009', 'name':'bind_transceiver'},
'bind_transceiver_resp' :{'hex':'80000009', 'name':'bind_transceiver_resp'},
'outbind' :{'hex':'0000000b', 'name':'outbind'},
'enquire_link' :{'hex':'00000015', 'name':'enquire_link'},
'enquire_link_resp' :{'hex':'80000015', 'name':'enquire_link_resp'},
'submit_multi' :{'hex':'00000021', 'name':'submit_multi'},
'submit_multi_resp' :{'hex':'80000021', 'name':'submit_multi_resp'},
'alert_notification' :{'hex':'00000102', 'name':'alert_notification'},
'data_sm' :{'hex':'00000103', 'name':'data_sm'},
'data_sm_resp' :{'hex':'80000103', 'name':'data_sm_resp'},
# v4 codes
'generic_nack_v4' :{'hex':'80010000', 'name':'generic_nack_v4'},
'bind_receiver_v4' :{'hex':'00010001', 'name':'bind_receiver_v4'},
'bind_receiver_resp_v4' :{'hex':'80010001', 'name':'bind_receiver_resp_v4'},
'bind_transmitter_v4' :{'hex':'00010002', 'name':'bind_transmitter_v4'},
'bind_transmitter_resp_v4':{'hex':'80010002', 'name':'bind_transmitter_resp_v4'},
'query_sm_v4' :{'hex':'00010003', 'name':'query_sm_v4'},
'query_sm_resp_v4' :{'hex':'80010003', 'name':'query_sm_resp_v4'},
'submit_sm_v4' :{'hex':'00010004', 'name':'submit_sm_v4'},
'submit_sm_resp_v4' :{'hex':'80010004', 'name':'submit_sm_resp_v4'},
'deliver_sm_v4' :{'hex':'00010005', 'name':'deliver_sm_v4'},
'deliver_sm_resp_v4' :{'hex':'80010005', 'name':'deliver_sm_resp_v4'},
'unbind_v4' :{'hex':'00010006', 'name':'unbind_v4'},
'unbind_resp_v4' :{'hex':'80010006', 'name':'unbind_resp_v4'},
'replace_sm_v4' :{'hex':'00010007', 'name':'replace_sm_v4'},
'replace_sm_resp_v4' :{'hex':'80010007', 'name':'replace_sm_resp_v4'},
'cancel_sm_v4' :{'hex':'00010008', 'name':'cancel_sm_v4'},
'cancel_sm_resp_v4' :{'hex':'80010008', 'name':'cancel_sm_resp_v4'},
'delivery_receipt_v4' :{'hex':'00010009', 'name':'delivery_receipt_v4'},
'delivery_receipt_resp_v4':{'hex':'80010009', 'name':'delivery_receipt_resp_v4'},
'enquire_link_v4' :{'hex':'0001000a', 'name':'enquire_link_v4'},
'enquire_link_resp_v4' :{'hex':'8001000a', 'name':'enquire_link_resp_v4'},
'outbind_v4' :{'hex':'0001000b', 'name':'outbind_v4'}
}
def command_id_hex_by_name(n):
return command_id_by_name.get(n,{}).get('hex')
# SMPP Error Codes (ESME) - SMPP v3.4, section 5.1.3, table 5-2, page 112-114
command_status_by_hex = {
'00000000':{'hex':'00000000', 'name':'ESME_ROK', 'description':'No error'},
'00000001':{'hex':'00000001', 'name':'ESME_RINVMSGLEN', 'description':'Message Length is invalid'},
'00000002':{'hex':'00000002', 'name':'ESME_RINVCMDLEN', 'description':'Command Length is invalid'},
'00000003':{'hex':'00000003', 'name':'ESME_RINVCMDID', 'description':'Invalid Command ID'},
'00000004':{'hex':'00000004', 'name':'ESME_RINVBNDSTS', 'description':'Incorrect BIND Status for given command'},
'00000005':{'hex':'00000005', 'name':'ESME_RALYBND', 'description':'ESME Already in bound state'},
'00000006':{'hex':'00000006', 'name':'ESME_RINVPRTFLG', 'description':'Invalid priority flag'},
'00000007':{'hex':'00000007', 'name':'ESME_RINVREGDLVFLG', 'description':'Invalid registered delivery flag'},
'00000008':{'hex':'00000008', 'name':'ESME_RSYSERR', 'description':'System Error'},
'0000000a':{'hex':'0000000a', 'name':'ESME_RINVSRCADR', 'description':'Invalid source address'},
'0000000b':{'hex':'0000000b', 'name':'ESME_RINVDSTADR', 'description':'Invalid destination address'},
'0000000c':{'hex':'0000000c', 'name':'ESME_RINVMSGID', 'description':'Message ID is invalid'},
'0000000d':{'hex':'0000000d', 'name':'ESME_RBINDFAIL', 'description':'Bind failed'},
'0000000e':{'hex':'0000000e', 'name':'ESME_RINVPASWD', 'description':'Invalid password'},
'0000000f':{'hex':'0000000f', 'name':'ESME_RINVSYSID', 'description':'Invalid System ID'},
'00000011':{'hex':'00000011', 'name':'ESME_RCANCELFAIL', 'description':'Cancel SM Failed'},
'00000013':{'hex':'00000013', 'name':'ESME_RREPLACEFAIL', 'description':'Replace SM Failed'},
'00000014':{'hex':'00000014', 'name':'ESME_RMSGQFUL', 'description':'Message queue full'},
'00000015':{'hex':'00000015', 'name':'ESME_RINVSERTYP', 'description':'Invalid service type'},
'00000033':{'hex':'00000033', 'name':'ESME_RINVNUMDESTS', 'description':'Invalid number of destinations'},
'00000034':{'hex':'00000034', 'name':'ESME_RINVDLNAME', 'description':'Invalid distribution list name'},
'00000040':{'hex':'00000040', 'name':'ESME_RINVDESTFLAG', 'description':'Destination flag is invalid (submit_multi)'},
'00000042':{'hex':'00000042', 'name':'ESME_RINVSUBREP', 'description':"Invalid `submit with replace' request (i.e. submit_sm with replace_if_present_flag set)"},
'00000043':{'hex':'00000043', 'name':'ESME_RINVESMCLASS', 'description':'Invalid esm_class field data'},
'00000044':{'hex':'00000044', 'name':'ESME_RCNTSUBDL', 'description':'Cannot submit to distribution list'},
'00000045':{'hex':'00000045', 'name':'ESME_RSUBMITFAIL', 'description':'submit_sm or submit_multi failed'},
'00000048':{'hex':'00000048', 'name':'ESME_RINVSRCTON', 'description':'Invalid source address TON'},
'00000049':{'hex':'00000049', 'name':'ESME_RINVSRCNPI', 'description':'Invalid source address NPI'},
'00000050':{'hex':'00000050', 'name':'ESME_RINVDSTTON', 'description':'Invalid destination address TON'},
'00000051':{'hex':'00000051', 'name':'ESME_RINVDSTNPI', 'description':'Invalid destination address NPI'},
'00000053':{'hex':'00000053', 'name':'ESME_RINVSYSTYP', 'description':'Invalid system_type field'},
'00000054':{'hex':'00000054', 'name':'ESME_RINVREPFLAG', 'description':'Invalid replace_if_present flag'},
'00000055':{'hex':'00000055', 'name':'ESME_RINVNUMMSGS', 'description':'Invalid number of messages'},
'00000058':{'hex':'00000058', 'name':'ESME_RTHROTTLED', 'description':'Throttling error (ESME has exceeded allowed message limits)'},
'00000061':{'hex':'00000061', 'name':'ESME_RINVSCHED', 'description':'Invalid scheduled delivery time'},
'00000062':{'hex':'00000062', 'name':'ESME_RINVEXPIRY', 'description':'Invalid message validity period (expiry time)'},
'00000063':{'hex':'00000063', 'name':'ESME_RINVDFTMSGID', 'description':'Predefined message invalid or not found'},
'00000064':{'hex':'00000064', 'name':'ESME_RX_T_APPN', 'description':'ESME Receiver Temporary App Error Code'},
'00000065':{'hex':'00000065', 'name':'ESME_RX_P_APPN', 'description':'ESME Receiver Permanent App Error Code'},
'00000066':{'hex':'00000066', 'name':'ESME_RX_R_APPN', 'description':'ESME Receiver Reject Message Error Code'},
'00000067':{'hex':'00000067', 'name':'ESME_RQUERYFAIL', 'description':'query_sm request failed'},
'000000c0':{'hex':'000000c0', 'name':'ESME_RINVOPTPARSTREAM', 'description':'Error in the optional part of the PDU Body'},
'000000c1':{'hex':'000000c1', 'name':'ESME_ROPTPARNOTALLWD', 'description':'Optional paramenter not allowed'},
'000000c2':{'hex':'000000c2', 'name':'ESME_RINVPARLEN', 'description':'Invalid parameter length'},
'000000c3':{'hex':'000000c3', 'name':'ESME_RMISSINGOPTPARAM', 'description':'Expected optional parameter missing'},
'000000c4':{'hex':'000000c4', 'name':'ESME_RINVOPTPARAMVAL', 'description':'Invalid optional parameter value'},
'000000fe':{'hex':'000000fe', 'name':'ESME_RDELIVERYFAILURE', 'description':'Delivery Failure (used for data_sm_resp)'},
'000000ff':{'hex':'000000ff', 'name':'ESME_RUNKNOWNERR', 'description':'Unknown error'}
}
def command_status_name_by_hex(x):
return command_status_by_hex.get(x,{}).get('name')
command_status_by_name = {
'ESME_ROK' :{'hex':'00000000', 'name':'ESME_ROK', 'description':'No error'},
'ESME_RINVMSGLEN' :{'hex':'00000001', 'name':'ESME_RINVMSGLEN', 'description':'Message Length is invalid'},
'ESME_RINVCMDLEN' :{'hex':'00000002', 'name':'ESME_RINVCMDLEN', 'description':'Command Length is invalid'},
'ESME_RINVCMDID' :{'hex':'00000003', 'name':'ESME_RINVCMDID', 'description':'Invalid Command ID'},
'ESME_RINVBNDSTS' :{'hex':'00000004', 'name':'ESME_RINVBNDSTS', 'description':'Incorrect BIND Status for given command'},
'ESME_RALYBND' :{'hex':'00000005', 'name':'ESME_RALYBND', 'description':'ESME Already in bound state'},
'ESME_RINVPRTFLG' :{'hex':'00000006', 'name':'ESME_RINVPRTFLG', 'description':'Invalid priority flag'},
'ESME_RINVREGDLVFLG' :{'hex':'00000007', 'name':'ESME_RINVREGDLVFLG', 'description':'Invalid registered delivery flag'},
'ESME_RSYSERR' :{'hex':'00000008', 'name':'ESME_RSYSERR', 'description':'System Error'},
'ESME_RINVSRCADR' :{'hex':'0000000a', 'name':'ESME_RINVSRCADR', 'description':'Invalid source address'},
'ESME_RINVDSTADR' :{'hex':'0000000b', 'name':'ESME_RINVDSTADR', 'description':'Invalid destination address'},
'ESME_RINVMSGID' :{'hex':'0000000c', 'name':'ESME_RINVMSGID', 'description':'Message ID is invalid'},
'ESME_RBINDFAIL' :{'hex':'0000000d', 'name':'ESME_RBINDFAIL', 'description':'Bind failed'},
'ESME_RINVPASWD' :{'hex':'0000000e', 'name':'ESME_RINVPASWD', 'description':'Invalid password'},
'ESME_RINVSYSID' :{'hex':'0000000f', 'name':'ESME_RINVSYSID', 'description':'Invalid System ID'},
'ESME_RCANCELFAIL' :{'hex':'00000011', 'name':'ESME_RCANCELFAIL', 'description':'Cancel SM Failed'},
'ESME_RREPLACEFAIL' :{'hex':'00000013', 'name':'ESME_RREPLACEFAIL', 'description':'Replace SM Failed'},
'ESME_RMSGQFUL' :{'hex':'00000014', 'name':'ESME_RMSGQFUL', 'description':'Message queue full'},
'ESME_RINVSERTYP' :{'hex':'00000015', 'name':'ESME_RINVSERTYP', 'description':'Invalid service type'},
'ESME_RINVNUMDESTS' :{'hex':'00000033', 'name':'ESME_RINVNUMDESTS', 'description':'Invalid number of destinations'},
'ESME_RINVDLNAME' :{'hex':'00000034', 'name':'ESME_RINVDLNAME', 'description':'Invalid distribution list name'},
'ESME_RINVDESTFLAG' :{'hex':'00000040', 'name':'ESME_RINVDESTFLAG', 'description':'Destination flag is invalid (submit_multi)'},
'ESME_RINVSUBREP' :{'hex':'00000042', 'name':'ESME_RINVSUBREP', 'description':"Invalid `submit with replace' request (i.e. submit_sm with replace_if_present_flag set)"},
'ESME_RINVESMCLASS' :{'hex':'00000043', 'name':'ESME_RINVESMCLASS', 'description':'Invalid esm_class field data'},
'ESME_RCNTSUBDL' :{'hex':'00000044', 'name':'ESME_RCNTSUBDL', 'description':'Cannot submit to distribution list'},
'ESME_RSUBMITFAIL' :{'hex':'00000045', 'name':'ESME_RSUBMITFAIL', 'description':'submit_sm or submit_multi failed'},
'ESME_RINVSRCTON' :{'hex':'00000048', 'name':'ESME_RINVSRCTON', 'description':'Invalid source address TON'},
'ESME_RINVSRCNPI' :{'hex':'00000049', 'name':'ESME_RINVSRCNPI', 'description':'Invalid source address NPI'},
'ESME_RINVDSTTON' :{'hex':'00000050', 'name':'ESME_RINVDSTTON', 'description':'Invalid destination address TON'},
'ESME_RINVDSTNPI' :{'hex':'00000051', 'name':'ESME_RINVDSTNPI', 'description':'Invalid destination address NPI'},
'ESME_RINVSYSTYP' :{'hex':'00000053', 'name':'ESME_RINVSYSTYP', 'description':'Invalid system_type field'},
'ESME_RINVREPFLAG' :{'hex':'00000054', 'name':'ESME_RINVREPFLAG', 'description':'Invalid replace_if_present flag'},
'ESME_RINVNUMMSGS' :{'hex':'00000055', 'name':'ESME_RINVNUMMSGS', 'description':'Invalid number of messages'},
'ESME_RTHROTTLED' :{'hex':'00000058', 'name':'ESME_RTHROTTLED', 'description':'Throttling error (ESME has exceeded allowed message limits)'},
'ESME_RINVSCHED' :{'hex':'00000061', 'name':'ESME_RINVSCHED', 'description':'Invalid scheduled delivery time'},
'ESME_RINVEXPIRY' :{'hex':'00000062', 'name':'ESME_RINVEXPIRY', 'description':'Invalid message validity period (expiry time)'},
'ESME_RINVDFTMSGID' :{'hex':'00000063', 'name':'ESME_RINVDFTMSGID', 'description':'Predefined message invalid or not found'},
'ESME_RX_T_APPN' :{'hex':'00000064', 'name':'ESME_RX_T_APPN', 'description':'ESME Receiver Temporary App Error Code'},
'ESME_RX_P_APPN' :{'hex':'00000065', 'name':'ESME_RX_P_APPN', 'description':'ESME Receiver Permanent App Error Code'},
'ESME_RX_R_APPN' :{'hex':'00000066', 'name':'ESME_RX_R_APPN', 'description':'ESME Receiver Reject Message Error Code'},
'ESME_RQUERYFAIL' :{'hex':'00000067', 'name':'ESME_RQUERYFAIL', 'description':'query_sm request failed'},
'ESME_RINVOPTPARSTREAM':{'hex':'000000c0', 'name':'ESME_RINVOPTPARSTREAM', 'description':'Error in the optional part of the PDU Body'},
'ESME_ROPTPARNOTALLWD' :{'hex':'000000c1', 'name':'ESME_ROPTPARNOTALLWD', 'description':'Optional paramenter not allowed'},
'ESME_RINVPARLEN' :{'hex':'000000c2', 'name':'ESME_RINVPARLEN', 'description':'Invalid parameter length'},
'ESME_RMISSINGOPTPARAM':{'hex':'000000c3', 'name':'ESME_RMISSINGOPTPARAM', 'description':'Expected optional parameter missing'},
'ESME_RINVOPTPARAMVAL' :{'hex':'000000c4', 'name':'ESME_RINVOPTPARAMVAL', 'description':'Invalid optional parameter value'},
'ESME_RDELIVERYFAILURE':{'hex':'000000fe', 'name':'ESME_RDELIVERYFAILURE', 'description':'Delivery Failure (used for data_sm_resp)'},
'ESME_RUNKNOWNERR' :{'hex':'000000ff', 'name':'ESME_RUNKNOWNERR', 'description':'Unknown error'}
}
def command_status_hex_by_name(n):
return command_status_by_name.get(n,{}).get('hex')
# Type of Number (TON) - SMPP v3.4, section 5.2.5, table 5-3, page 117
maps['addr_ton_by_name'] = {
'unknown' :'00',
'international' :'01',
'national' :'02',
'network_specific' :'03',
'subscriber_number':'04',
'alphanumeric' :'05',
'abbreviated' :'06'
}
maps['addr_ton_by_hex'] = {
'00':'unknown',
'01':'international',
'02':'national',
'03':'network_specific',
'04':'subscriber_number',
'05':'alphanumeric',
'06':'abbreviated'
}
# Numberic Plan Indicator (NPI) - SMPP v3.4, section 5.2.6, table 5-4, page 118
maps['addr_npi_by_name'] = {
'unknown' :'00',
'ISDN' :'01',
'data' :'03',
'telex' :'04',
'land_mobile':'06',
'national' :'08',
'private' :'09',
'ERMES' :'0a',
'internet' :'0e',
'WAP' :'12'
}
maps['addr_npi_by_hex'] = {
'00':'unknown',
'01':'ISDN',
'03':'data',
'04':'telex',
'06':'land_mobile',
'08':'national',
'09':'private',
'0a':'ERMES',
'0e':'internet',
'12':'WAP'
}
# ESM Class bits - SMPP v3.4, section 5.2.12, page 121
maps['esm_class_bits'] = {
'mode_mask' :'03',
'type_mask' :'3c',
'feature_mask' :'c0',
'mode_default' :'00',
'mode_datagram' :'01',
'mode_forward' :'02',
'mode_store_and_forward' :'03',
'type_default' :'00',
'type_delivery_receipt' :'04',
'type_delivery_ack' :'08',
'type_0011' :'0a',
'type_user_ack' :'10',
'type_0101' :'14',
'type_conversation_abort' :'18',
'type_0111' :'1a',
'type_intermed_deliv_notif' :'20',
'type_1001' :'24',
'type_1010' :'28',
'type_1011' :'2a',
'type_1100' :'30',
'type_1101' :'34',
'type_1110' :'38',
'type_1111' :'3a',
'feature_none' :'00',
'feature_UDHI' :'40',
'feature_reply_path' :'80',
'feature_UDHI_and_reply_path':'c0'
}
# Registered Delivery bits - SMPP v3.4, section 5.2.17, page 124
maps['registered_delivery_bits'] = {
'receipt_mask' :'03',
'ack_mask' :'0c',
'intermed_notif_mask' :'80',
'receipt_none' :'00',
'receipt_always' :'01',
'receipt_on_fail' :'02',
'receipt_res' :'03',
'ack_none' :'00',
'ack_delivery' :'04',
'ack_user' :'08',
'ack_delivery_and_user':'0c',
'intermed_notif_none' :'00',
'intermed_notif' :'10'
}
# submit_multi dest_flag constants - SMPP v3.4, section 5.2.25, page 129
#maps['dest_flag_by_name'] = {
#'SME Address' :1,
#'Distribution List Name':2
#}
# Message State codes returned in query_sm_resp PDUs - SMPP v3.4, section 5.2.28, table 5-6, page 130
maps['message_state_by_name'] = {
'ENROUTE' :1,
'DELIVERED' :2,
'EXPIRED' :3,
'DELETED' :4,
'UNDELIVERABLE':5,
'ACCEPTED' :6,
'UNKNOWN' :7,
'REJECTED' :8
}
# Facility Code bits for SMPP v4
maps['facility_code_bits'] = {
'GF_PVCY' :'00000001',
'GF_SUBADDR':'00000002',
'NF_CC' :'00080000',
'NF_PDC' :'00010000',
'NF_IS136' :'00020000',
'NF_IS95A' :'00040000'
}
# Optional Parameter Tags - SMPP v3.4, section 5.3.2, Table 5-7, page 132-133
optional_parameter_tag_by_hex = {
- '0005':{'hex':'0005', 'name':'dest_addr_subunit', 'technology':'GSM'},
- '0006':{'hex':'0006', 'name':'dest_network_type', 'technology':'Generic'},
- '0007':{'hex':'0007', 'name':'dest_bearer_type', 'technology':'Generic'},
- '0008':{'hex':'0008', 'name':'dest_telematics_id', 'technology':'GSM'},
-
- '000d':{'hex':'000d', 'name':'source_addr_subunit', 'technology':'GSM'},
- '000e':{'hex':'000e', 'name':'source_network_type', 'technology':'Generic'},
- '000f':{'hex':'000f', 'name':'source_bearer_type', 'technology':'Generic'},
- '0010':{'hex':'0010', 'name':'source_telematics_id', 'technology':'GSM'},
-
- '0017':{'hex':'0017', 'name':'qos_time_to_live', 'technology':'Generic'},
- '0019':{'hex':'0019', 'name':'payload_type', 'technology':'Generic'},
- '001d':{'hex':'001d', 'name':'additional_status_info_text', 'technology':'Generic'},
- '001e':{'hex':'001e', 'name':'receipted_message_id', 'technology':'Generic'},
- '0030':{'hex':'0030', 'name':'ms_msg_wait_facilities', 'technology':'GSM'},
-
- '0101':{'hex':'0101', 'name':'PVCY_AuthenticationStr', 'technology':'? (J-Phone)'}, # v4 page 58-62
-
- '0201':{'hex':'0201', 'name':'privacy_indicator', 'technology':'CDMA,TDMA'},
- '0202':{'hex':'0202', 'name':'source_subaddress', 'technology':'CDMA,TDMA'}, # v4 page 65-67
- '0203':{'hex':'0203', 'name':'dest_subaddress', 'technology':'CDMA,TDMA'}, # v4 page 65-67
- '0204':{'hex':'0204', 'name':'user_message_reference', 'technology':'Generic'},
- '0205':{'hex':'0205', 'name':'user_response_code', 'technology':'CDMA,TDMA'},
- '020a':{'hex':'020a', 'name':'source_port', 'technology':'WAP'},
- '020b':{'hex':'020b', 'name':'destination_port', 'technology':'WAP'},
- '020c':{'hex':'020c', 'name':'sar_msg_ref_num', 'technology':'Generic'},
- '020d':{'hex':'020d', 'name':'language_indicator', 'technology':'CDMA,TDMA'},
- '020e':{'hex':'020e', 'name':'sar_total_segments', 'technology':'Generic'},
- '020f':{'hex':'020f', 'name':'sar_segment_seqnum', 'technology':'Generic'},
- '0210':{'hex':'0210', 'name':'sc_interface_version', 'technology':'Generic'},
-
- '0301':{'hex':'0301', 'name':'CC_CBN', 'technology':'V4'}, # v4 page 70
- '0302':{'hex':'0302', 'name':'callback_num_pres_ind', 'technology':'TDMA'}, # v4 page 71
- '0303':{'hex':'0303', 'name':'callback_num_atag', 'technology':'TDMA'}, # v4 page 71
- '0304':{'hex':'0304', 'name':'number_of_messages', 'technology':'CDMA'}, # v4 page 72
- '0381':{'hex':'0381', 'name':'callback_num', 'technology':'CDMA,TDMA,GSM,iDEN'},
-
- '0420':{'hex':'0420', 'name':'dpf_result', 'technology':'Generic'},
- '0421':{'hex':'0421', 'name':'set_dpf', 'technology':'Generic'},
- '0422':{'hex':'0422', 'name':'ms_availability_status', 'technology':'Generic'},
- '0423':{'hex':'0423', 'name':'network_error_code', 'technology':'Generic'},
- '0424':{'hex':'0424', 'name':'message_payload', 'technology':'Generic'},
- '0425':{'hex':'0425', 'name':'delivery_failure_reason', 'technology':'Generic'},
- '0426':{'hex':'0426', 'name':'more_messages_to_send', 'technology':'GSM'},
- '0427':{'hex':'0427', 'name':'message_state', 'technology':'Generic'},
- '0428':{'hex':'0428', 'name':'congestion_state', 'technology':'Generic'},
-
- '0501':{'hex':'0501', 'name':'ussd_service_op', 'technology':'GSM (USSD)'},
-
- '0600':{'hex':'0600', 'name':'broadcast_channel_indicator', 'technology':'GSM'},
- '0601':{'hex':'0601', 'name':'broadcast_content_type', 'technology':'CDMA, TDMA, GSM'},
- '0602':{'hex':'0602', 'name':'broadcast_content_type_info', 'technology':'CDMA, TDMA'},
- '0603':{'hex':'0603', 'name':'broadcast_message_class', 'technology':'GSM'},
- '0604':{'hex':'0604', 'name':'broadcast_rep_num', 'technology':'GSM'},
- '0605':{'hex':'0605', 'name':'broadcast_frequency_interval', 'technology':'CDMA, TDMA, GSM'},
- '0606':{'hex':'0606', 'name':'broadcast_area_identifier', 'technology':'CDMA, TDMA, GSM'},
- '0607':{'hex':'0607', 'name':'broadcast_error_status', 'technology':'CDMA, TDMA, GSM'},
- '0608':{'hex':'0608', 'name':'broadcast_area_success', 'technology':'GSM'},
- '0609':{'hex':'0609', 'name':'broadcast_end_time', 'technology':'CDMA, TDMA, GSM'},
- '060a':{'hex':'060a', 'name':'broadcast_service_group', 'technology':'CDMA, TDMA'},
- '060b':{'hex':'060b', 'name':'billing_identification', 'technology':'Generic'},
- '060d':{'hex':'060d', 'name':'source_network_id', 'technology':'Generic'},
- '060e':{'hex':'060e', 'name':'dest_network_id', 'technology':'Generic'},
- '060f':{'hex':'060f', 'name':'source_node_id', 'technology':'Generic'},
- '0610':{'hex':'0610', 'name':'dest_node_id', 'technology':'Generic'},
- '0611':{'hex':'0611', 'name':'dest_addr_np_resolution', 'technology':'CDMA, TDMA (US Only)'},
- '0612':{'hex':'0612', 'name':'dest_addr_np_information', 'technology':'CDMA, TDMA (US Only)'},
- '0613':{'hex':'0613', 'name':'dest_addr_np_country', 'technology':'CDMA, TDMA (US Only)'},
-
- '1201':{'hex':'1201', 'name':'display_time', 'technology':'CDMA,TDMA'},
- '1203':{'hex':'1203', 'name':'sms_signal', 'technology':'TDMA'},
- '1204':{'hex':'1204', 'name':'ms_validity', 'technology':'CDMA,TDMA'},
-
- '1304':{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'technology':'CDMA'}, # v4 page 85
- '1306':{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'technology':'CDMA'}, # v4 page 86
- '130c':{'hex':'130c', 'name':'alert_on_message_delivery', 'technology':'CDMA'},
- '1380':{'hex':'1380', 'name':'its_reply_type', 'technology':'CDMA'},
- '1383':{'hex':'1383', 'name':'its_session_info', 'technology':'CDMA Korean [KORITS]'},
-
- '1402':{'hex':'1402', 'name':'operator_id', 'technology':'vendor extension'},
- '1403':{'hex':'1403', 'name':'tariff', 'technology':'Mobile Network Code vendor extension'},
- '1450':{'hex':'1450', 'name':'mcc', 'technology':'Mobile Country Code vendor extension'},
- '1451':{'hex':'1451', 'name':'mnc', 'technology':'Mobile Network Code vendor extension'},
-
- '1101':{'hex':'1101', 'name':'PDC_MessageClass', 'technology':'? (J-Phone)'}, # v4 page 75
- '1102':{'hex':'1102', 'name':'PDC_PresentationOption', 'technology':'? (J-Phone)'}, # v4 page 76
- '1103':{'hex':'1103', 'name':'PDC_AlertMechanism', 'technology':'? (J-Phone)'}, # v4 page 76
- '1104':{'hex':'1104', 'name':'PDC_Teleservice', 'technology':'? (J-Phone)'}, # v4 page 77
- '1105':{'hex':'1105', 'name':'PDC_MultiPartMessage', 'technology':'? (J-Phone)'}, # v4 page 77
- '1106':{'hex':'1106', 'name':'PDC_PredefinedMsg', 'technology':'? (J-Phone)'} # v4 page 78
+ '0005':{'hex':'0005', 'name':'dest_addr_subunit', 'type':'integer', 'technology':'GSM'},
+ '0006':{'hex':'0006', 'name':'dest_network_type', 'type':'integer', 'technology':'Generic'},
+ '0007':{'hex':'0007', 'name':'dest_bearer_type', 'type':'integer', 'technology':'Generic'},
+ '0008':{'hex':'0008', 'name':'dest_telematics_id', 'type':'integer', 'technology':'GSM'},
+
+ '000d':{'hex':'000d', 'name':'source_addr_subunit', 'type':'integer', 'technology':'GSM'},
+ '000e':{'hex':'000e', 'name':'source_network_type', 'type':'integer', 'technology':'Generic'},
+ '000f':{'hex':'000f', 'name':'source_bearer_type', 'type':'integer', 'technology':'Generic'},
+ '0010':{'hex':'0010', 'name':'source_telematics_id', 'type':'integer', 'technology':'GSM'},
+
+ '0017':{'hex':'0017', 'name':'qos_time_to_live', 'type':'integer', 'technology':'Generic'},
+ '0019':{'hex':'0019', 'name':'payload_type', 'type':'integer', 'technology':'Generic'},
+ '001d':{'hex':'001d', 'name':'additional_status_info_text', 'type':'string' , 'technology':'Generic'},
+ '001e':{'hex':'001e', 'name':'receipted_message_id', 'type':'string' , 'technology':'Generic'},
+ '0030':{'hex':'0030', 'name':'ms_msg_wait_facilities', 'type':'bitmask', 'technology':'GSM'},
+
+ '0101':{'hex':'0101', 'name':'PVCY_AuthenticationStr', 'type':None, 'technology':'? (J-Phone)'}, # v4 page 58-62
+
+ '0201':{'hex':'0201', 'name':'privacy_indicator', 'type':'integer', 'technology':'CDMA,TDMA'},
+ '0202':{'hex':'0202', 'name':'source_subaddress', 'type':'hex', 'technology':'CDMA,TDMA'},
+ '0203':{'hex':'0203', 'name':'dest_subaddress', 'type':'hex', 'technology':'CDMA,TDMA'},
+ '0204':{'hex':'0204', 'name':'user_message_reference', 'type':'integer', 'technology':'Generic'},
+ '0205':{'hex':'0205', 'name':'user_response_code', 'type':'integer', 'technology':'CDMA,TDMA'},
+ '020a':{'hex':'020a', 'name':'source_port', 'type':'integer', 'technology':'WAP'},
+ '020b':{'hex':'020b', 'name':'destination_port', 'type':'integer', 'technology':'WAP'},
+ '020c':{'hex':'020c', 'name':'sar_msg_ref_num', 'type':'integer', 'technology':'Generic'},
+ '020d':{'hex':'020d', 'name':'language_indicator', 'type':'integer', 'technology':'CDMA,TDMA'},
+ '020e':{'hex':'020e', 'name':'sar_total_segments', 'type':'integer', 'technology':'Generic'},
+ '020f':{'hex':'020f', 'name':'sar_segment_seqnum', 'type':'integer', 'technology':'Generic'},
+ '0210':{'hex':'0210', 'name':'sc_interface_version', 'type':'integer', 'technology':'Generic'},
+
+ '0301':{'hex':'0301', 'name':'CC_CBN', 'type':None, 'technology':'V4'}, # v4 page 70
+ '0302':{'hex':'0302', 'name':'callback_num_pres_ind', 'type':'bitmask', 'technology':'TDMA'},
+ '0303':{'hex':'0303', 'name':'callback_num_atag', 'type':'hex', 'technology':'TDMA'},
+ '0304':{'hex':'0304', 'name':'number_of_messages', 'type':'integer', 'technology':'CDMA'},
+ '0381':{'hex':'0381', 'name':'callback_num', 'type':'hex', 'technology':'CDMA,TDMA,GSM,iDEN'},
+
+ '0420':{'hex':'0420', 'name':'dpf_result', 'type':'integer', 'technology':'Generic'},
+ '0421':{'hex':'0421', 'name':'set_dpf', 'type':'integer', 'technology':'Generic'},
+ '0422':{'hex':'0422', 'name':'ms_availability_status', 'type':'integer', 'technology':'Generic'},
+ '0423':{'hex':'0423', 'name':'network_error_code', 'type':'hex', 'technology':'Generic'},
+ '0424':{'hex':'0424', 'name':'message_payload', 'type':'hex', 'technology':'Generic'},
+ '0425':{'hex':'0425', 'name':'delivery_failure_reason', 'type':'integer', 'technology':'Generic'},
+ '0426':{'hex':'0426', 'name':'more_messages_to_send', 'type':'integer', 'technology':'GSM'},
+ '0427':{'hex':'0427', 'name':'message_state', 'type':'integer', 'technology':'Generic'},
+ '0428':{'hex':'0428', 'name':'congestion_state', 'type':'integer', 'technology':'Generic'},
+
+ '0501':{'hex':'0501', 'name':'ussd_service_op', 'type':'hex', 'technology':'GSM (USSD)'},
+
+ '0600':{'hex':'0600', 'name':'broadcast_channel_indicator', 'type':'integer', 'technology':'GSM'},
+ '0601':{'hex':'0601', 'name':'broadcast_content_type', 'type':'integer', 'technology':'CDMA, TDMA, GSM'},
+ '0602':{'hex':'0602', 'name':'broadcast_content_type_info', 'type':'integer', 'technology':'CDMA, TDMA'},
+ '0603':{'hex':'0603', 'name':'broadcast_message_class', 'type':'integer', 'technology':'GSM'},
+ '0604':{'hex':'0604', 'name':'broadcast_rep_num', 'type':'integer', 'technology':'GSM'},
+ '0605':{'hex':'0605', 'name':'broadcast_frequency_interval', 'type':'integer', 'technology':'CDMA, TDMA, GSM'},
+ '0606':{'hex':'0606', 'name':'broadcast_area_identifier', 'type':'integer', 'technology':'CDMA, TDMA, GSM'},
+ '0607':{'hex':'0607', 'name':'broadcast_error_status', 'type':'integer', 'technology':'CDMA, TDMA, GSM'},
+ '0608':{'hex':'0608', 'name':'broadcast_area_success', 'type':'integer', 'technology':'GSM'},
+ '0609':{'hex':'0609', 'name':'broadcast_end_time', 'type':'integer', 'technology':'CDMA, TDMA, GSM'},
+ '060a':{'hex':'060a', 'name':'broadcast_service_group', 'type':'integer', 'technology':'CDMA, TDMA'},
+ '060b':{'hex':'060b', 'name':'billing_identification', 'type':'integer', 'technology':'Generic'},
+ '060d':{'hex':'060d', 'name':'source_network_id', 'type':'integer', 'technology':'Generic'},
+ '060e':{'hex':'060e', 'name':'dest_network_id', 'type':'integer', 'technology':'Generic'},
+ '060f':{'hex':'060f', 'name':'source_node_id', 'type':'integer', 'technology':'Generic'},
+ '0610':{'hex':'0610', 'name':'dest_node_id', 'type':'integer', 'technology':'Generic'},
+ '0611':{'hex':'0611', 'name':'dest_addr_np_resolution', 'type':'integer', 'technology':'CDMA, TDMA (US Only)'},
+ '0612':{'hex':'0612', 'name':'dest_addr_np_information', 'type':'integer', 'technology':'CDMA, TDMA (US Only)'},
+ '0613':{'hex':'0613', 'name':'dest_addr_np_country', 'type':'integer', 'technology':'CDMA, TDMA (US Only)'},
+
+ '1201':{'hex':'1201', 'name':'display_time', 'type':'integer', 'technology':'CDMA,TDMA'},
+ '1203':{'hex':'1203', 'name':'sms_signal', 'type':'integer', 'technology':'TDMA'},
+ '1204':{'hex':'1204', 'name':'ms_validity', 'type':'integer', 'technology':'CDMA,TDMA'},
+
+ '1304':{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'type':None, 'technology':'CDMA'}, # v4 page 85
+ '1306':{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'type':None, 'technology':'CDMA'}, # v4 page 86
+ '130c':{'hex':'130c', 'name':'alert_on_message_delivery', 'type':'integer', 'technology':'CDMA'},
+ '1380':{'hex':'1380', 'name':'its_reply_type', 'type':'integer', 'technology':'CDMA'},
+ '1383':{'hex':'1383', 'name':'its_session_info', 'type':'hex', 'technology':'CDMA Korean [KORITS]'},
+
+ '1402':{'hex':'1402', 'name':'operator_id', 'type':'integer', 'technology':'vendor extension'},
+ '1403':{'hex':'1403', 'name':'tariff', 'type':'integer', 'technology':'Mobile Network Code vendor extension'},
+ '1450':{'hex':'1450', 'name':'mcc', 'type':'integer', 'technology':'Mobile Country Code vendor extension'},
+ '1451':{'hex':'1451', 'name':'mnc', 'type':'integer', 'technology':'Mobile Network Code vendor extension'},
+
+ '1101':{'hex':'1101', 'name':'PDC_MessageClass', 'type':None, 'technology':'? (J-Phone)'}, # v4 page 75
+ '1102':{'hex':'1102', 'name':'PDC_PresentationOption', 'type':None, 'technology':'? (J-Phone)'}, # v4 page 76
+ '1103':{'hex':'1103', 'name':'PDC_AlertMechanism', 'type':None, 'technology':'? (J-Phone)'}, # v4 page 76
+ '1104':{'hex':'1104', 'name':'PDC_Teleservice', 'type':None, 'technology':'? (J-Phone)'}, # v4 page 77
+ '1105':{'hex':'1105', 'name':'PDC_MultiPartMessage', 'type':None, 'technology':'? (J-Phone)'}, # v4 page 77
+ '1106':{'hex':'1106', 'name':'PDC_PredefinedMsg', 'type':None, 'technology':'? (J-Phone)'} # v4 page 78
}
def optional_parameter_tag_name_by_hex(x):
return optional_parameter_tag_by_hex.get(x,{}).get('name')
+def optional_parameter_tag_type_by_hex(x):
+ return optional_parameter_tag_by_hex.get(x,{}).get('type')
+
optional_parameter_tag_by_name = {
'dest_addr_subunit' :{'hex':'0005', 'name':'dest_addr_subunit', 'technology':'GSM'},
'dest_network_type' :{'hex':'0006', 'name':'dest_network_type', 'technology':'Generic'},
'dest_bearer_type' :{'hex':'0007', 'name':'dest_bearer_type', 'technology':'Generic'},
'dest_telematics_id' :{'hex':'0008', 'name':'dest_telematics_id', 'technology':'GSM'},
'source_addr_subunit' :{'hex':'000d', 'name':'source_addr_subunit', 'technology':'GSM'},
'source_network_type' :{'hex':'000e', 'name':'source_network_type', 'technology':'Generic'},
'source_bearer_type' :{'hex':'000f', 'name':'source_bearer_type', 'technology':'Generic'},
'source_telematics_id' :{'hex':'0010', 'name':'source_telematics_id', 'technology':'GSM'},
'qos_time_to_live' :{'hex':'0017', 'name':'qos_time_to_live', 'technology':'Generic'},
'payload_type' :{'hex':'0019', 'name':'payload_type', 'technology':'Generic'},
'additional_status_info_text' :{'hex':'001d', 'name':'additional_status_info_text', 'technology':'Generic'},
'receipted_message_id' :{'hex':'001e', 'name':'receipted_message_id', 'technology':'Generic'},
'ms_msg_wait_facilities' :{'hex':'0030', 'name':'ms_msg_wait_facilities', 'technology':'GSM'},
'PVCY_AuthenticationStr' :{'hex':'0101', 'name':'PVCY_AuthenticationStr', 'technology':'? (J-Phone)'}, # v4 page 58-62
'privacy_indicator' :{'hex':'0201', 'name':'privacy_indicator', 'technology':'CDMA,TDMA'},
'source_subaddress' :{'hex':'0202', 'name':'source_subaddress', 'technology':'CDMA,TDMA'}, # v4 page 65-67
'dest_subaddress' :{'hex':'0203', 'name':'dest_subaddress', 'technology':'CDMA,TDMA'}, # v4 page 65-67
'user_message_reference' :{'hex':'0204', 'name':'user_message_reference', 'technology':'Generic'},
'user_response_code' :{'hex':'0205', 'name':'user_response_code', 'technology':'CDMA,TDMA'},
'source_port' :{'hex':'020a', 'name':'source_port', 'technology':'WAP'},
'destination_port' :{'hex':'020b', 'name':'destination_port', 'technology':'WAP'},
'sar_msg_ref_num' :{'hex':'020c', 'name':'sar_msg_ref_num', 'technology':'Generic'},
'language_indicator' :{'hex':'020d', 'name':'language_indicator', 'technology':'CDMA,TDMA'},
'sar_total_segments' :{'hex':'020e', 'name':'sar_total_segments', 'technology':'Generic'},
'sar_segment_seqnum' :{'hex':'020f', 'name':'sar_segment_seqnum', 'technology':'Generic'},
'sc_interface_version' :{'hex':'0210', 'name':'sc_interface_version', 'technology':'Generic'},
'CC_CBN' :{'hex':'0301', 'name':'CC_CBN', 'technology':'V4'}, # v4 page 70
'callback_num_pres_ind' :{'hex':'0302', 'name':'callback_num_pres_ind', 'technology':'TDMA'}, # v4 page 71
'callback_num_atag' :{'hex':'0303', 'name':'callback_num_atag', 'technology':'TDMA'}, # v4 page 71
'number_of_messages' :{'hex':'0304', 'name':'number_of_messages', 'technology':'CDMA'}, # v4 page 72
'callback_num' :{'hex':'0381', 'name':'callback_num', 'technology':'CDMA,TDMA,GSM,iDEN'},
'dpf_result' :{'hex':'0420', 'name':'dpf_result', 'technology':'Generic'},
'set_dpf' :{'hex':'0421', 'name':'set_dpf', 'technology':'Generic'},
'ms_availability_status' :{'hex':'0422', 'name':'ms_availability_status', 'technology':'Generic'},
'network_error_code' :{'hex':'0423', 'name':'network_error_code', 'technology':'Generic'},
'message_payload' :{'hex':'0424', 'name':'message_payload', 'technology':'Generic'},
'delivery_failure_reason' :{'hex':'0425', 'name':'delivery_failure_reason', 'technology':'Generic'},
'more_messages_to_send' :{'hex':'0426', 'name':'more_messages_to_send', 'technology':'GSM'},
'message_state' :{'hex':'0427', 'name':'message_state', 'technology':'Generic'},
'congestion_state' :{'hex':'0428', 'name':'congestion_state', 'technology':'Generic'},
'ussd_service_op' :{'hex':'0501', 'name':'ussd_service_op', 'technology':'GSM (USSD)'},
'broadcast_channel_indicator' :{'hex':'0600', 'name':'broadcast_channel_indicator', 'technology':'GSM'},
'broadcast_content_type' :{'hex':'0601', 'name':'broadcast_content_type', 'technology':'CDMA, TDMA, GSM'},
'broadcast_content_type_info' :{'hex':'0602', 'name':'broadcast_content_type_info', 'technology':'CDMA, TDMA'},
'broadcast_message_class' :{'hex':'0603', 'name':'broadcast_message_class', 'technology':'GSM'},
'broadcast_rep_num' :{'hex':'0604', 'name':'broadcast_rep_num', 'technology':'GSM'},
'broadcast_frequency_interval':{'hex':'0605', 'name':'broadcast_frequency_interval', 'technology':'CDMA, TDMA, GSM'},
'broadcast_area_identifier' :{'hex':'0606', 'name':'broadcast_area_identifier', 'technology':'CDMA, TDMA, GSM'},
'broadcast_error_status' :{'hex':'0607', 'name':'broadcast_error_status', 'technology':'CDMA, TDMA, GSM'},
'broadcast_area_success' :{'hex':'0608', 'name':'broadcast_area_success', 'technology':'GSM'},
'broadcast_end_time' :{'hex':'0609', 'name':'broadcast_end_time', 'technology':'CDMA, TDMA, GSM'},
'broadcast_service_group' :{'hex':'060a', 'name':'broadcast_service_group', 'technology':'CDMA, TDMA'},
'billing_identification' :{'hex':'060b', 'name':'billing_identification', 'technology':'Generic'},
'source_network_id' :{'hex':'060d', 'name':'source_network_id', 'technology':'Generic'},
'dest_network_id' :{'hex':'060e', 'name':'dest_network_id', 'technology':'Generic'},
'source_node_id' :{'hex':'060f', 'name':'source_node_id', 'technology':'Generic'},
'dest_node_id' :{'hex':'0610', 'name':'dest_node_id', 'technology':'Generic'},
'dest_addr_np_resolution' :{'hex':'0611', 'name':'dest_addr_np_resolution', 'technology':'CDMA, TDMA (US Only)'},
'dest_addr_np_information' :{'hex':'0612', 'name':'dest_addr_np_information', 'technology':'CDMA, TDMA (US Only)'},
'dest_addr_np_country' :{'hex':'0613', 'name':'dest_addr_np_country', 'technology':'CDMA, TDMA (US Only)'},
'display_time' :{'hex':'1201', 'name':'display_time', 'technology':'CDMA,TDMA'},
'sms_signal' :{'hex':'1203', 'name':'sms_signal', 'technology':'TDMA'},
'ms_validity' :{'hex':'1204', 'name':'ms_validity', 'technology':'CDMA,TDMA'},
'IS95A_AlertOnDelivery' :{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'technology':'CDMA'}, # v4 page 85
'IS95A_LanguageIndicator' :{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'technology':'CDMA'}, # v4 page 86
'alert_on_message_delivery' :{'hex':'130c', 'name':'alert_on_message_delivery', 'technology':'CDMA'},
'its_reply_type' :{'hex':'1380', 'name':'its_reply_type', 'technology':'CDMA'},
'its_session_info' :{'hex':'1383', 'name':'its_session_info', 'technology':'CDMA Korean [KORITS]'},
'operator_id' :{'hex':'1402', 'name':'operator_id', 'technology':'vendor extension'},
'tariff' :{'hex':'1403', 'name':'tariff', 'technology':'Mobile Network Code vendor extension'},
'mcc' :{'hex':'1450', 'name':'mcc', 'technology':'Mobile Country Code vendor extension'},
'mnc' :{'hex':'1451', 'name':'mnc', 'technology':'Mobile Network Code vendor extension'},
'PDC_MessageClass' :{'hex':'1101', 'name':'PDC_MessageClass', 'technology':'? (J-Phone)'}, # v4 page 75
'PDC_PresentationOption' :{'hex':'1102', 'name':'PDC_PresentationOption', 'technology':'? (J-Phone)'}, # v4 page 76
'PDC_AlertMechanism' :{'hex':'1103', 'name':'PDC_AlertMechanism', 'technology':'? (J-Phone)'}, # v4 page 76
'PDC_Teleservice' :{'hex':'1104', 'name':'PDC_Teleservice', 'technology':'? (J-Phone)'}, # v4 page 77
'PDC_MultiPartMessage' :{'hex':'1105', 'name':'PDC_MultiPartMessage', 'technology':'? (J-Phone)'}, # v4 page 77
'PDC_PredefinedMsg' :{'hex':'1106', 'name':'PDC_PredefinedMsg', 'technology':'? (J-Phone)'} # v4 page 78
}
def optional_parameter_tag_hex_by_name(n):
return optional_parameter_tag_by_name.get(n,{}).get('hex')
#### Decoding functions #######################################################
def unpack_pdu(pdu_bin):
#return binascii.b2a_hex(pdu_bin)
return decode_pdu(binascii.b2a_hex(pdu_bin))
def decode_pdu(pdu_hex):
print '\n===================================================='
hex_ref = [pdu_hex]
pdu = {}
pdu['header'] = decode_header(hex_ref)
command = pdu['header'].get('command_id', None)
if command != None:
pdu['body'] = decode_body(command, hex_ref)
print '====================================================\n'
return pdu
def decode_header(hex_ref):
pdu_hex = hex_ref[0]
header = {}
(command_length, command_id, command_status, sequence_number, hex_ref[0]) = \
(pdu_hex[0:8], pdu_hex[8:16], pdu_hex[16:24], pdu_hex[24:32], pdu_hex[32: ])
length = int(command_length, 16)
command = command_id_name_by_hex(command_id)
status = command_status_name_by_hex(command_status)
sequence = int(sequence_number, 16)
header = {}
header['command_length'] = length
header['command_id'] = command
header['command_status'] = status
header['sequence_number'] = sequence
print 'h==>', 'command_length', ':', repr(header['command_length'])
print 'h==>', 'command_id', ':', repr(header['command_id'])
print 'h==>', 'command_status', ':', repr(header['command_status'])
print 'h==>', 'sequence_number', ':', repr(header['sequence_number'])
return header
def decode_body(command, hex_ref):
body = {}
body['mandatory_parameters'] = None
if command != None:
fields = mandatory_parameter_list_by_command_name(command)
body['mandatory_parameters'] = decode_mandatory_parameters(fields, hex_ref)
body['optional_parameters'] = decode_optional_parameters(hex_ref)
return body
def decode_mandatory_parameters(fields, hex_ref):
mandatory_parameters = {}
if len(hex_ref[0]) > 1:
for field in fields:
data = ''
octet = ''
count = 0
if field['var'] == True or field['var'] == False:
while (len(hex_ref[0]) > 1
and (count < field['min']
or (count < field['max']
and octet != '00'))):
octet = octpop(hex_ref)
data += octet
count += 1
elif field['type'] == 'string':
count = mandatory_parameters[field['var']]
for i in range(count):
if len(hex_ref[0]) > 1:
data += octpop(hex_ref)
else:
count = mandatory_parameters[field['var']]
- if field['hex_map'] != None:
- mandatory_parameters[field['name']] = maps.get(field['hex_map'],{data:data})[data]
+ if field['map'] != None:
+ mandatory_parameters[field['name']] = maps.get(field['map']+'_by_hex',{data:data})[data]
else:
mandatory_parameters[field['name']] = decode_hex_type(data, field['type'], count, hex_ref)
print 'm==>', field['name'], ':', repr(mandatory_parameters[field['name']])
return mandatory_parameters
def decode_optional_parameters(hex_ref):
optional_parameters = []
- data = hex_ref[0]
- while len(data) > 0:
- (tag_hex, length_hex, rest) = (data[0:4], data[4:8], data[8: ])
+ hex = hex_ref[0]
+ while len(hex) > 0:
+ (tag_hex, length_hex, rest) = (hex[0:4], hex[4:8], hex[8: ])
tag = optional_parameter_tag_name_by_hex(tag_hex)
length = int(length_hex, 16)
(value_hex, tail) = (rest[0:length*2], rest[length*2: ])
if len(value_hex) == 0:
- value = 0 #TODO remove after testing
+ value = None
else:
- value = int(value_hex, 16) #TODO need decoding mapping
- data = tail
+ value = decode_hex_type(value_hex, optional_parameter_tag_type_by_hex(tag_hex))
+ hex = tail
optional_parameters.append({'tag':tag, 'length':length, 'value':value})
print 'o==>', tag, '[', length, ']', ':', repr(value)
return optional_parameters
-def decode_hex_type(data, type, count=0, hex_ref=['']):
+def decode_hex_type(hex, type, count=0, hex_ref=['']):
if type == 'integer':
- return int(data, 16)
+ return int(hex, 16)
elif type == 'string':
- return binascii.b2a_qp(binascii.a2b_hex(re.sub('00','',data)))
+ return binascii.b2a_qp(binascii.a2b_hex(re.sub('00','',hex)))
elif (type == 'dest_address'
or type == 'unsuccess_sme'):
list = []
fields = mandatory_parameter_list_by_command_name(type)
for i in range(count):
item = decode_mandatory_parameters(fields, hex_ref)
if item.get('dest_flag', None) == 1: # 'dest_address' only
subfields = mandatory_parameter_list_by_command_name('sme_dest_address')
rest = decode_mandatory_parameters(subfields, hex_ref)
item.update(rest)
elif item.get('dest_flag', None) == 2: # 'dest_address' only
subfields = mandatory_parameter_list_by_command_name('distribution_list')
rest = decode_mandatory_parameters(subfields, hex_ref)
item.update(rest)
list.append(item)
return list
else:
- return data
+ return hex
def octpop(hex_ref):
octet = None
if len(hex_ref[0]) > 1:
(octet, hex_ref[0]) = (hex_ref[0][0:2], hex_ref[0][2: ])
return octet
#### Encoding functions #######################################################
def pack_pdu(command='bind_transmitter', status='ESME_ROK', sequence=0, body_hex=''):
length = 16 + len(body_hex)/2
command_length = '%08x' % length
command_id = command_id_hex_by_name(command)
command_status = command_status_hex_by_name(status)
sequence_number = '%08x' % sequence
pdu_hex = command_length + command_id + command_status + sequence_number + body_hex
return binascii.a2b_hex(pdu_hex)
def encode_mandatory_parameters(fields, json):
mandatory_hex = ''
return mandatory_hex
def encode_optional_parameter(tag, value):
optional_hex = ''
tag_hex = optional_parameter_tag_hex_by_name(tag)
if tag_hex != None:
value_hex = '%02x' % value #TODO need encoding mapping
length_hex = '%04x' % (len(value_hex)/2)
optional_hex = tag_hex + length_hex + value_hex
return optional_hex
def json_to_pdu(json):
header = json.get('header', {})
body_hex = ''
body = json.get('body', {})
for opt in body.get('optional_parameters',[]):
body_hex += encode_optional_parameter(opt['tag'], opt['value'])
return pack_pdu(header['command_id'], header['command_status'], header['sequence_number'], body_hex)
|
dmaclay/python-smpp
|
0653b3993dc043015da176af15192cd9fe855c67
|
optional parameter value types
|
diff --git a/tests.py b/tests.py
index 755ff8d..91a43cd 100644
--- a/tests.py
+++ b/tests.py
@@ -1,45 +1,45 @@
from smpp.esme import *
#esme = ESME()
#esme.connect_SMSC()
#print str(binascii.a2b_hex(re.sub(' ','','00 00 00 3C 00 00 00 04 00 00 00 00 00 00 00 05 00 02 08 35 35 35 00 01 01 35 35 35 35 35 35 35 35 35 00 00 00 00 00 00 00 00 00 00 0F 48 65 6C 6C 6F 20 77 69 6B 69 70 65 64 69 61')))
print ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>"
-test_bin = binascii.a2b_hex(re.sub(' ','','00 00 00 3C 00 00 00 04 00 00 00 00 00 00 00 05 00 02 08 35 35 35 00 01 01 35 35 35 35 35 35 35 35 35 00 00 00 00 00 00 00 00 00 00 0F 48 65 6C 6C 6F 20 77 69 6B 69 70 65 64 69 61 00000000 00000000'))
+test_bin = binascii.a2b_hex(re.sub(' ','','00 00 00 3C 00 00 00 04 00 00 00 00 00 00 00 05 00 02 08 35 35 35 00 01 01 35 35 35 35 35 35 35 35 35 00 00 00 00 00 00 00 00 00 00 0F 48 65 6C 6C 6F 20 77 69 6B 69 70 65 64 69 61 00000000 001d00026566'))
unpack_pdu(test_bin)
test_bin = binascii.a2b_hex(re.sub(' ','','00000000 00000021 00000000 00000000 00 00 00 00 02 0101016500 026600 00 00 00 00 00 00 00 00 00 00 0000000000000000000000000000000000000000000000000000000000 00000000 00000000 0000'))
print unpack_pdu(test_bin)
test_bin = binascii.a2b_hex(re.sub(' ','','00000000 80000021 00000000 00000000 00 02 01016565650000000000 01016666660000000000'))
print unpack_pdu(test_bin)
pack_pdu('generic_nack','ESME_ROK',1,'00112233445566778899')
pack_pdu()
print unpack_pdu(pack_pdu())
j = {
'header': {
'command_length': 16,
'command_id': 'bind_transmitter',
'command_status': 'ESME_ROK',
'sequence_number': 0
},
'body': {
'optional_parameters': [
{
'tag':'payload_type',
'value':0
}
]
}
}
json_to_pdu(j)
|
dmaclay/python-smpp
|
6c6bcd7fd5e1bb6da6a9d8d9c4b739ec16f864e0
|
|icleanup<esc>:wq
|
diff --git a/tests.py b/tests.py
index 6acf1f5..755ff8d 100644
--- a/tests.py
+++ b/tests.py
@@ -1,30 +1,45 @@
from smpp.esme import *
#esme = ESME()
#esme.connect_SMSC()
#print str(binascii.a2b_hex(re.sub(' ','','00 00 00 3C 00 00 00 04 00 00 00 00 00 00 00 05 00 02 08 35 35 35 00 01 01 35 35 35 35 35 35 35 35 35 00 00 00 00 00 00 00 00 00 00 0F 48 65 6C 6C 6F 20 77 69 6B 69 70 65 64 69 61')))
print ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>"
test_bin = binascii.a2b_hex(re.sub(' ','','00 00 00 3C 00 00 00 04 00 00 00 00 00 00 00 05 00 02 08 35 35 35 00 01 01 35 35 35 35 35 35 35 35 35 00 00 00 00 00 00 00 00 00 00 0F 48 65 6C 6C 6F 20 77 69 6B 69 70 65 64 69 61 00000000 00000000'))
unpack_pdu(test_bin)
test_bin = binascii.a2b_hex(re.sub(' ','','00000000 00000021 00000000 00000000 00 00 00 00 02 0101016500 026600 00 00 00 00 00 00 00 00 00 00 0000000000000000000000000000000000000000000000000000000000 00000000 00000000 0000'))
-unpack_pdu(test_bin)
+print unpack_pdu(test_bin)
-test_bin = binascii.a2b_hex(re.sub(' ','','00000000 80000021 00000000 00000000 00 02 01010000000000 01010000000000'))
-unpack_pdu(test_bin)
+test_bin = binascii.a2b_hex(re.sub(' ','','00000000 80000021 00000000 00000000 00 02 01016565650000000000 01016666660000000000'))
+print unpack_pdu(test_bin)
pack_pdu('generic_nack','ESME_ROK',1,'00112233445566778899')
pack_pdu()
-unpack_pdu(pack_pdu())
-
-
-j = {'status': 'ESME_ROK', 'body': {'optional_parameters':[{'tag':'payload_type', 'value':0}]}, 'length': 16, 'sequence': 0, 'command': 'bind_transmitter'}
+print unpack_pdu(pack_pdu())
+
+
+j = {
+ 'header': {
+ 'command_length': 16,
+ 'command_id': 'bind_transmitter',
+ 'command_status': 'ESME_ROK',
+ 'sequence_number': 0
+ },
+ 'body': {
+ 'optional_parameters': [
+ {
+ 'tag':'payload_type',
+ 'value':0
+ }
+ ]
+ }
+}
json_to_pdu(j)
|
dmaclay/python-smpp
|
1e9481e7e0871d1f4c78c2b0e1f2cae6e0f34162
|
cleanup
|
diff --git a/smpp/pdu.py b/smpp/pdu.py
index 6963f8f..390b2ea 100644
--- a/smpp/pdu.py
+++ b/smpp/pdu.py
@@ -268,674 +268,678 @@ command_id_by_hex = {
'80010009':{'hex':'80010009', 'name':'delivery_receipt_resp_v4'},
'0001000a':{'hex':'0001000a', 'name':'enquire_link_v4'},
'8001000a':{'hex':'8001000a', 'name':'enquire_link_resp_v4'},
'0001000b':{'hex':'0001000b', 'name':'outbind_v4'},
}
def command_id_name_by_hex(x):
return command_id_by_hex.get(x,{}).get('name')
command_id_by_name = {
'generic_nack' :{'hex':'80000000', 'name':'generic_nack'},
'bind_receiver' :{'hex':'00000001', 'name':'bind_receiver'},
'bind_receiver_resp' :{'hex':'80000001', 'name':'bind_receiver_resp'},
'bind_transmitter' :{'hex':'00000002', 'name':'bind_transmitter'},
'bind_transmitter_resp' :{'hex':'80000002', 'name':'bind_transmitter_resp'},
'query_sm' :{'hex':'00000003', 'name':'query_sm'},
'query_sm_resp' :{'hex':'80000003', 'name':'query_sm_resp'},
'submit_sm' :{'hex':'00000004', 'name':'submit_sm'},
'submit_sm_resp' :{'hex':'80000004', 'name':'submit_sm_resp'},
'deliver_sm' :{'hex':'00000005', 'name':'deliver_sm'},
'deliver_sm_resp' :{'hex':'80000005', 'name':'deliver_sm_resp'},
'unbind' :{'hex':'00000006', 'name':'unbind'},
'unbind_resp' :{'hex':'80000006', 'name':'unbind_resp'},
'replace_sm' :{'hex':'00000007', 'name':'replace_sm'},
'replace_sm_resp' :{'hex':'80000007', 'name':'replace_sm_resp'},
'cancel_sm' :{'hex':'00000008', 'name':'cancel_sm'},
'cancel_sm_resp' :{'hex':'80000008', 'name':'cancel_sm_resp'},
'bind_transceiver' :{'hex':'00000009', 'name':'bind_transceiver'},
'bind_transceiver_resp' :{'hex':'80000009', 'name':'bind_transceiver_resp'},
'outbind' :{'hex':'0000000b', 'name':'outbind'},
'enquire_link' :{'hex':'00000015', 'name':'enquire_link'},
'enquire_link_resp' :{'hex':'80000015', 'name':'enquire_link_resp'},
'submit_multi' :{'hex':'00000021', 'name':'submit_multi'},
'submit_multi_resp' :{'hex':'80000021', 'name':'submit_multi_resp'},
'alert_notification' :{'hex':'00000102', 'name':'alert_notification'},
'data_sm' :{'hex':'00000103', 'name':'data_sm'},
'data_sm_resp' :{'hex':'80000103', 'name':'data_sm_resp'},
# v4 codes
'generic_nack_v4' :{'hex':'80010000', 'name':'generic_nack_v4'},
'bind_receiver_v4' :{'hex':'00010001', 'name':'bind_receiver_v4'},
'bind_receiver_resp_v4' :{'hex':'80010001', 'name':'bind_receiver_resp_v4'},
'bind_transmitter_v4' :{'hex':'00010002', 'name':'bind_transmitter_v4'},
'bind_transmitter_resp_v4':{'hex':'80010002', 'name':'bind_transmitter_resp_v4'},
'query_sm_v4' :{'hex':'00010003', 'name':'query_sm_v4'},
'query_sm_resp_v4' :{'hex':'80010003', 'name':'query_sm_resp_v4'},
'submit_sm_v4' :{'hex':'00010004', 'name':'submit_sm_v4'},
'submit_sm_resp_v4' :{'hex':'80010004', 'name':'submit_sm_resp_v4'},
'deliver_sm_v4' :{'hex':'00010005', 'name':'deliver_sm_v4'},
'deliver_sm_resp_v4' :{'hex':'80010005', 'name':'deliver_sm_resp_v4'},
'unbind_v4' :{'hex':'00010006', 'name':'unbind_v4'},
'unbind_resp_v4' :{'hex':'80010006', 'name':'unbind_resp_v4'},
'replace_sm_v4' :{'hex':'00010007', 'name':'replace_sm_v4'},
'replace_sm_resp_v4' :{'hex':'80010007', 'name':'replace_sm_resp_v4'},
'cancel_sm_v4' :{'hex':'00010008', 'name':'cancel_sm_v4'},
'cancel_sm_resp_v4' :{'hex':'80010008', 'name':'cancel_sm_resp_v4'},
'delivery_receipt_v4' :{'hex':'00010009', 'name':'delivery_receipt_v4'},
'delivery_receipt_resp_v4':{'hex':'80010009', 'name':'delivery_receipt_resp_v4'},
'enquire_link_v4' :{'hex':'0001000a', 'name':'enquire_link_v4'},
'enquire_link_resp_v4' :{'hex':'8001000a', 'name':'enquire_link_resp_v4'},
'outbind_v4' :{'hex':'0001000b', 'name':'outbind_v4'}
}
def command_id_hex_by_name(n):
return command_id_by_name.get(n,{}).get('hex')
# SMPP Error Codes (ESME) - SMPP v3.4, section 5.1.3, table 5-2, page 112-114
command_status_by_hex = {
'00000000':{'hex':'00000000', 'name':'ESME_ROK', 'description':'No error'},
'00000001':{'hex':'00000001', 'name':'ESME_RINVMSGLEN', 'description':'Message Length is invalid'},
'00000002':{'hex':'00000002', 'name':'ESME_RINVCMDLEN', 'description':'Command Length is invalid'},
'00000003':{'hex':'00000003', 'name':'ESME_RINVCMDID', 'description':'Invalid Command ID'},
'00000004':{'hex':'00000004', 'name':'ESME_RINVBNDSTS', 'description':'Incorrect BIND Status for given command'},
'00000005':{'hex':'00000005', 'name':'ESME_RALYBND', 'description':'ESME Already in bound state'},
'00000006':{'hex':'00000006', 'name':'ESME_RINVPRTFLG', 'description':'Invalid priority flag'},
'00000007':{'hex':'00000007', 'name':'ESME_RINVREGDLVFLG', 'description':'Invalid registered delivery flag'},
'00000008':{'hex':'00000008', 'name':'ESME_RSYSERR', 'description':'System Error'},
'0000000a':{'hex':'0000000a', 'name':'ESME_RINVSRCADR', 'description':'Invalid source address'},
'0000000b':{'hex':'0000000b', 'name':'ESME_RINVDSTADR', 'description':'Invalid destination address'},
'0000000c':{'hex':'0000000c', 'name':'ESME_RINVMSGID', 'description':'Message ID is invalid'},
'0000000d':{'hex':'0000000d', 'name':'ESME_RBINDFAIL', 'description':'Bind failed'},
'0000000e':{'hex':'0000000e', 'name':'ESME_RINVPASWD', 'description':'Invalid password'},
'0000000f':{'hex':'0000000f', 'name':'ESME_RINVSYSID', 'description':'Invalid System ID'},
'00000011':{'hex':'00000011', 'name':'ESME_RCANCELFAIL', 'description':'Cancel SM Failed'},
'00000013':{'hex':'00000013', 'name':'ESME_RREPLACEFAIL', 'description':'Replace SM Failed'},
'00000014':{'hex':'00000014', 'name':'ESME_RMSGQFUL', 'description':'Message queue full'},
'00000015':{'hex':'00000015', 'name':'ESME_RINVSERTYP', 'description':'Invalid service type'},
'00000033':{'hex':'00000033', 'name':'ESME_RINVNUMDESTS', 'description':'Invalid number of destinations'},
'00000034':{'hex':'00000034', 'name':'ESME_RINVDLNAME', 'description':'Invalid distribution list name'},
'00000040':{'hex':'00000040', 'name':'ESME_RINVDESTFLAG', 'description':'Destination flag is invalid (submit_multi)'},
'00000042':{'hex':'00000042', 'name':'ESME_RINVSUBREP', 'description':"Invalid `submit with replace' request (i.e. submit_sm with replace_if_present_flag set)"},
'00000043':{'hex':'00000043', 'name':'ESME_RINVESMCLASS', 'description':'Invalid esm_class field data'},
'00000044':{'hex':'00000044', 'name':'ESME_RCNTSUBDL', 'description':'Cannot submit to distribution list'},
'00000045':{'hex':'00000045', 'name':'ESME_RSUBMITFAIL', 'description':'submit_sm or submit_multi failed'},
'00000048':{'hex':'00000048', 'name':'ESME_RINVSRCTON', 'description':'Invalid source address TON'},
'00000049':{'hex':'00000049', 'name':'ESME_RINVSRCNPI', 'description':'Invalid source address NPI'},
'00000050':{'hex':'00000050', 'name':'ESME_RINVDSTTON', 'description':'Invalid destination address TON'},
'00000051':{'hex':'00000051', 'name':'ESME_RINVDSTNPI', 'description':'Invalid destination address NPI'},
'00000053':{'hex':'00000053', 'name':'ESME_RINVSYSTYP', 'description':'Invalid system_type field'},
'00000054':{'hex':'00000054', 'name':'ESME_RINVREPFLAG', 'description':'Invalid replace_if_present flag'},
'00000055':{'hex':'00000055', 'name':'ESME_RINVNUMMSGS', 'description':'Invalid number of messages'},
'00000058':{'hex':'00000058', 'name':'ESME_RTHROTTLED', 'description':'Throttling error (ESME has exceeded allowed message limits)'},
'00000061':{'hex':'00000061', 'name':'ESME_RINVSCHED', 'description':'Invalid scheduled delivery time'},
'00000062':{'hex':'00000062', 'name':'ESME_RINVEXPIRY', 'description':'Invalid message validity period (expiry time)'},
'00000063':{'hex':'00000063', 'name':'ESME_RINVDFTMSGID', 'description':'Predefined message invalid or not found'},
'00000064':{'hex':'00000064', 'name':'ESME_RX_T_APPN', 'description':'ESME Receiver Temporary App Error Code'},
'00000065':{'hex':'00000065', 'name':'ESME_RX_P_APPN', 'description':'ESME Receiver Permanent App Error Code'},
'00000066':{'hex':'00000066', 'name':'ESME_RX_R_APPN', 'description':'ESME Receiver Reject Message Error Code'},
'00000067':{'hex':'00000067', 'name':'ESME_RQUERYFAIL', 'description':'query_sm request failed'},
'000000c0':{'hex':'000000c0', 'name':'ESME_RINVOPTPARSTREAM', 'description':'Error in the optional part of the PDU Body'},
'000000c1':{'hex':'000000c1', 'name':'ESME_ROPTPARNOTALLWD', 'description':'Optional paramenter not allowed'},
'000000c2':{'hex':'000000c2', 'name':'ESME_RINVPARLEN', 'description':'Invalid parameter length'},
'000000c3':{'hex':'000000c3', 'name':'ESME_RMISSINGOPTPARAM', 'description':'Expected optional parameter missing'},
'000000c4':{'hex':'000000c4', 'name':'ESME_RINVOPTPARAMVAL', 'description':'Invalid optional parameter value'},
'000000fe':{'hex':'000000fe', 'name':'ESME_RDELIVERYFAILURE', 'description':'Delivery Failure (used for data_sm_resp)'},
'000000ff':{'hex':'000000ff', 'name':'ESME_RUNKNOWNERR', 'description':'Unknown error'}
}
def command_status_name_by_hex(x):
return command_status_by_hex.get(x,{}).get('name')
command_status_by_name = {
'ESME_ROK' :{'hex':'00000000', 'name':'ESME_ROK', 'description':'No error'},
'ESME_RINVMSGLEN' :{'hex':'00000001', 'name':'ESME_RINVMSGLEN', 'description':'Message Length is invalid'},
'ESME_RINVCMDLEN' :{'hex':'00000002', 'name':'ESME_RINVCMDLEN', 'description':'Command Length is invalid'},
'ESME_RINVCMDID' :{'hex':'00000003', 'name':'ESME_RINVCMDID', 'description':'Invalid Command ID'},
'ESME_RINVBNDSTS' :{'hex':'00000004', 'name':'ESME_RINVBNDSTS', 'description':'Incorrect BIND Status for given command'},
'ESME_RALYBND' :{'hex':'00000005', 'name':'ESME_RALYBND', 'description':'ESME Already in bound state'},
'ESME_RINVPRTFLG' :{'hex':'00000006', 'name':'ESME_RINVPRTFLG', 'description':'Invalid priority flag'},
'ESME_RINVREGDLVFLG' :{'hex':'00000007', 'name':'ESME_RINVREGDLVFLG', 'description':'Invalid registered delivery flag'},
'ESME_RSYSERR' :{'hex':'00000008', 'name':'ESME_RSYSERR', 'description':'System Error'},
'ESME_RINVSRCADR' :{'hex':'0000000a', 'name':'ESME_RINVSRCADR', 'description':'Invalid source address'},
'ESME_RINVDSTADR' :{'hex':'0000000b', 'name':'ESME_RINVDSTADR', 'description':'Invalid destination address'},
'ESME_RINVMSGID' :{'hex':'0000000c', 'name':'ESME_RINVMSGID', 'description':'Message ID is invalid'},
'ESME_RBINDFAIL' :{'hex':'0000000d', 'name':'ESME_RBINDFAIL', 'description':'Bind failed'},
'ESME_RINVPASWD' :{'hex':'0000000e', 'name':'ESME_RINVPASWD', 'description':'Invalid password'},
'ESME_RINVSYSID' :{'hex':'0000000f', 'name':'ESME_RINVSYSID', 'description':'Invalid System ID'},
'ESME_RCANCELFAIL' :{'hex':'00000011', 'name':'ESME_RCANCELFAIL', 'description':'Cancel SM Failed'},
'ESME_RREPLACEFAIL' :{'hex':'00000013', 'name':'ESME_RREPLACEFAIL', 'description':'Replace SM Failed'},
'ESME_RMSGQFUL' :{'hex':'00000014', 'name':'ESME_RMSGQFUL', 'description':'Message queue full'},
'ESME_RINVSERTYP' :{'hex':'00000015', 'name':'ESME_RINVSERTYP', 'description':'Invalid service type'},
'ESME_RINVNUMDESTS' :{'hex':'00000033', 'name':'ESME_RINVNUMDESTS', 'description':'Invalid number of destinations'},
'ESME_RINVDLNAME' :{'hex':'00000034', 'name':'ESME_RINVDLNAME', 'description':'Invalid distribution list name'},
'ESME_RINVDESTFLAG' :{'hex':'00000040', 'name':'ESME_RINVDESTFLAG', 'description':'Destination flag is invalid (submit_multi)'},
'ESME_RINVSUBREP' :{'hex':'00000042', 'name':'ESME_RINVSUBREP', 'description':"Invalid `submit with replace' request (i.e. submit_sm with replace_if_present_flag set)"},
'ESME_RINVESMCLASS' :{'hex':'00000043', 'name':'ESME_RINVESMCLASS', 'description':'Invalid esm_class field data'},
'ESME_RCNTSUBDL' :{'hex':'00000044', 'name':'ESME_RCNTSUBDL', 'description':'Cannot submit to distribution list'},
'ESME_RSUBMITFAIL' :{'hex':'00000045', 'name':'ESME_RSUBMITFAIL', 'description':'submit_sm or submit_multi failed'},
'ESME_RINVSRCTON' :{'hex':'00000048', 'name':'ESME_RINVSRCTON', 'description':'Invalid source address TON'},
'ESME_RINVSRCNPI' :{'hex':'00000049', 'name':'ESME_RINVSRCNPI', 'description':'Invalid source address NPI'},
'ESME_RINVDSTTON' :{'hex':'00000050', 'name':'ESME_RINVDSTTON', 'description':'Invalid destination address TON'},
'ESME_RINVDSTNPI' :{'hex':'00000051', 'name':'ESME_RINVDSTNPI', 'description':'Invalid destination address NPI'},
'ESME_RINVSYSTYP' :{'hex':'00000053', 'name':'ESME_RINVSYSTYP', 'description':'Invalid system_type field'},
'ESME_RINVREPFLAG' :{'hex':'00000054', 'name':'ESME_RINVREPFLAG', 'description':'Invalid replace_if_present flag'},
'ESME_RINVNUMMSGS' :{'hex':'00000055', 'name':'ESME_RINVNUMMSGS', 'description':'Invalid number of messages'},
'ESME_RTHROTTLED' :{'hex':'00000058', 'name':'ESME_RTHROTTLED', 'description':'Throttling error (ESME has exceeded allowed message limits)'},
'ESME_RINVSCHED' :{'hex':'00000061', 'name':'ESME_RINVSCHED', 'description':'Invalid scheduled delivery time'},
'ESME_RINVEXPIRY' :{'hex':'00000062', 'name':'ESME_RINVEXPIRY', 'description':'Invalid message validity period (expiry time)'},
'ESME_RINVDFTMSGID' :{'hex':'00000063', 'name':'ESME_RINVDFTMSGID', 'description':'Predefined message invalid or not found'},
'ESME_RX_T_APPN' :{'hex':'00000064', 'name':'ESME_RX_T_APPN', 'description':'ESME Receiver Temporary App Error Code'},
'ESME_RX_P_APPN' :{'hex':'00000065', 'name':'ESME_RX_P_APPN', 'description':'ESME Receiver Permanent App Error Code'},
'ESME_RX_R_APPN' :{'hex':'00000066', 'name':'ESME_RX_R_APPN', 'description':'ESME Receiver Reject Message Error Code'},
'ESME_RQUERYFAIL' :{'hex':'00000067', 'name':'ESME_RQUERYFAIL', 'description':'query_sm request failed'},
'ESME_RINVOPTPARSTREAM':{'hex':'000000c0', 'name':'ESME_RINVOPTPARSTREAM', 'description':'Error in the optional part of the PDU Body'},
'ESME_ROPTPARNOTALLWD' :{'hex':'000000c1', 'name':'ESME_ROPTPARNOTALLWD', 'description':'Optional paramenter not allowed'},
'ESME_RINVPARLEN' :{'hex':'000000c2', 'name':'ESME_RINVPARLEN', 'description':'Invalid parameter length'},
'ESME_RMISSINGOPTPARAM':{'hex':'000000c3', 'name':'ESME_RMISSINGOPTPARAM', 'description':'Expected optional parameter missing'},
'ESME_RINVOPTPARAMVAL' :{'hex':'000000c4', 'name':'ESME_RINVOPTPARAMVAL', 'description':'Invalid optional parameter value'},
'ESME_RDELIVERYFAILURE':{'hex':'000000fe', 'name':'ESME_RDELIVERYFAILURE', 'description':'Delivery Failure (used for data_sm_resp)'},
'ESME_RUNKNOWNERR' :{'hex':'000000ff', 'name':'ESME_RUNKNOWNERR', 'description':'Unknown error'}
}
def command_status_hex_by_name(n):
return command_status_by_name.get(n,{}).get('hex')
# Type of Number (TON) - SMPP v3.4, section 5.2.5, table 5-3, page 117
maps['addr_ton_by_name'] = {
'unknown' :'00',
'international' :'01',
'national' :'02',
'network_specific' :'03',
'subscriber_number':'04',
'alphanumeric' :'05',
'abbreviated' :'06'
}
maps['addr_ton_by_hex'] = {
'00':'unknown',
'01':'international',
'02':'national',
'03':'network_specific',
'04':'subscriber_number',
'05':'alphanumeric',
'06':'abbreviated'
}
# Numberic Plan Indicator (NPI) - SMPP v3.4, section 5.2.6, table 5-4, page 118
maps['addr_npi_by_name'] = {
'unknown' :'00',
'ISDN' :'01',
'data' :'03',
'telex' :'04',
'land_mobile':'06',
'national' :'08',
'private' :'09',
'ERMES' :'0a',
'internet' :'0e',
'WAP' :'12'
}
maps['addr_npi_by_hex'] = {
'00':'unknown',
'01':'ISDN',
'03':'data',
'04':'telex',
'06':'land_mobile',
'08':'national',
'09':'private',
'0a':'ERMES',
'0e':'internet',
'12':'WAP'
}
# ESM Class bits - SMPP v3.4, section 5.2.12, page 121
maps['esm_class_bits'] = {
'mode_mask' :'03',
'type_mask' :'3c',
'feature_mask' :'c0',
'mode_default' :'00',
'mode_datagram' :'01',
'mode_forward' :'02',
'mode_store_and_forward' :'03',
'type_default' :'00',
'type_delivery_receipt' :'04',
'type_delivery_ack' :'08',
'type_0011' :'0a',
'type_user_ack' :'10',
'type_0101' :'14',
'type_conversation_abort' :'18',
'type_0111' :'1a',
'type_intermed_deliv_notif' :'20',
'type_1001' :'24',
'type_1010' :'28',
'type_1011' :'2a',
'type_1100' :'30',
'type_1101' :'34',
'type_1110' :'38',
'type_1111' :'3a',
'feature_none' :'00',
'feature_UDHI' :'40',
'feature_reply_path' :'80',
'feature_UDHI_and_reply_path':'c0'
}
# Registered Delivery bits - SMPP v3.4, section 5.2.17, page 124
maps['registered_delivery_bits'] = {
'receipt_mask' :'03',
'ack_mask' :'0c',
'intermed_notif_mask' :'80',
'receipt_none' :'00',
'receipt_always' :'01',
'receipt_on_fail' :'02',
'receipt_res' :'03',
'ack_none' :'00',
'ack_delivery' :'04',
'ack_user' :'08',
'ack_delivery_and_user':'0c',
'intermed_notif_none' :'00',
'intermed_notif' :'10'
}
# submit_multi dest_flag constants - SMPP v3.4, section 5.2.25, page 129
#maps['dest_flag_by_name'] = {
#'SME Address' :1,
#'Distribution List Name':2
#}
# Message State codes returned in query_sm_resp PDUs - SMPP v3.4, section 5.2.28, table 5-6, page 130
maps['message_state_by_name'] = {
'ENROUTE' :1,
'DELIVERED' :2,
'EXPIRED' :3,
'DELETED' :4,
'UNDELIVERABLE':5,
'ACCEPTED' :6,
'UNKNOWN' :7,
'REJECTED' :8
}
# Facility Code bits for SMPP v4
maps['facility_code_bits'] = {
'GF_PVCY' :'00000001',
'GF_SUBADDR':'00000002',
'NF_CC' :'00080000',
'NF_PDC' :'00010000',
'NF_IS136' :'00020000',
'NF_IS95A' :'00040000'
}
# Optional Parameter Tags - SMPP v3.4, section 5.3.2, Table 5-7, page 132-133
optional_parameter_tag_by_hex = {
'0005':{'hex':'0005', 'name':'dest_addr_subunit', 'technology':'GSM'},
'0006':{'hex':'0006', 'name':'dest_network_type', 'technology':'Generic'},
'0007':{'hex':'0007', 'name':'dest_bearer_type', 'technology':'Generic'},
'0008':{'hex':'0008', 'name':'dest_telematics_id', 'technology':'GSM'},
'000d':{'hex':'000d', 'name':'source_addr_subunit', 'technology':'GSM'},
'000e':{'hex':'000e', 'name':'source_network_type', 'technology':'Generic'},
'000f':{'hex':'000f', 'name':'source_bearer_type', 'technology':'Generic'},
'0010':{'hex':'0010', 'name':'source_telematics_id', 'technology':'GSM'},
'0017':{'hex':'0017', 'name':'qos_time_to_live', 'technology':'Generic'},
'0019':{'hex':'0019', 'name':'payload_type', 'technology':'Generic'},
'001d':{'hex':'001d', 'name':'additional_status_info_text', 'technology':'Generic'},
'001e':{'hex':'001e', 'name':'receipted_message_id', 'technology':'Generic'},
'0030':{'hex':'0030', 'name':'ms_msg_wait_facilities', 'technology':'GSM'},
'0101':{'hex':'0101', 'name':'PVCY_AuthenticationStr', 'technology':'? (J-Phone)'}, # v4 page 58-62
'0201':{'hex':'0201', 'name':'privacy_indicator', 'technology':'CDMA,TDMA'},
'0202':{'hex':'0202', 'name':'source_subaddress', 'technology':'CDMA,TDMA'}, # v4 page 65-67
'0203':{'hex':'0203', 'name':'dest_subaddress', 'technology':'CDMA,TDMA'}, # v4 page 65-67
'0204':{'hex':'0204', 'name':'user_message_reference', 'technology':'Generic'},
'0205':{'hex':'0205', 'name':'user_response_code', 'technology':'CDMA,TDMA'},
'020a':{'hex':'020a', 'name':'source_port', 'technology':'WAP'},
'020b':{'hex':'020b', 'name':'destination_port', 'technology':'WAP'},
'020c':{'hex':'020c', 'name':'sar_msg_ref_num', 'technology':'Generic'},
'020d':{'hex':'020d', 'name':'language_indicator', 'technology':'CDMA,TDMA'},
'020e':{'hex':'020e', 'name':'sar_total_segments', 'technology':'Generic'},
'020f':{'hex':'020f', 'name':'sar_segment_seqnum', 'technology':'Generic'},
'0210':{'hex':'0210', 'name':'sc_interface_version', 'technology':'Generic'},
'0301':{'hex':'0301', 'name':'CC_CBN', 'technology':'V4'}, # v4 page 70
'0302':{'hex':'0302', 'name':'callback_num_pres_ind', 'technology':'TDMA'}, # v4 page 71
'0303':{'hex':'0303', 'name':'callback_num_atag', 'technology':'TDMA'}, # v4 page 71
'0304':{'hex':'0304', 'name':'number_of_messages', 'technology':'CDMA'}, # v4 page 72
'0381':{'hex':'0381', 'name':'callback_num', 'technology':'CDMA,TDMA,GSM,iDEN'},
'0420':{'hex':'0420', 'name':'dpf_result', 'technology':'Generic'},
'0421':{'hex':'0421', 'name':'set_dpf', 'technology':'Generic'},
'0422':{'hex':'0422', 'name':'ms_availability_status', 'technology':'Generic'},
'0423':{'hex':'0423', 'name':'network_error_code', 'technology':'Generic'},
'0424':{'hex':'0424', 'name':'message_payload', 'technology':'Generic'},
'0425':{'hex':'0425', 'name':'delivery_failure_reason', 'technology':'Generic'},
'0426':{'hex':'0426', 'name':'more_messages_to_send', 'technology':'GSM'},
'0427':{'hex':'0427', 'name':'message_state', 'technology':'Generic'},
'0428':{'hex':'0428', 'name':'congestion_state', 'technology':'Generic'},
'0501':{'hex':'0501', 'name':'ussd_service_op', 'technology':'GSM (USSD)'},
'0600':{'hex':'0600', 'name':'broadcast_channel_indicator', 'technology':'GSM'},
'0601':{'hex':'0601', 'name':'broadcast_content_type', 'technology':'CDMA, TDMA, GSM'},
'0602':{'hex':'0602', 'name':'broadcast_content_type_info', 'technology':'CDMA, TDMA'},
'0603':{'hex':'0603', 'name':'broadcast_message_class', 'technology':'GSM'},
'0604':{'hex':'0604', 'name':'broadcast_rep_num', 'technology':'GSM'},
'0605':{'hex':'0605', 'name':'broadcast_frequency_interval', 'technology':'CDMA, TDMA, GSM'},
'0606':{'hex':'0606', 'name':'broadcast_area_identifier', 'technology':'CDMA, TDMA, GSM'},
'0607':{'hex':'0607', 'name':'broadcast_error_status', 'technology':'CDMA, TDMA, GSM'},
'0608':{'hex':'0608', 'name':'broadcast_area_success', 'technology':'GSM'},
'0609':{'hex':'0609', 'name':'broadcast_end_time', 'technology':'CDMA, TDMA, GSM'},
'060a':{'hex':'060a', 'name':'broadcast_service_group', 'technology':'CDMA, TDMA'},
'060b':{'hex':'060b', 'name':'billing_identification', 'technology':'Generic'},
'060d':{'hex':'060d', 'name':'source_network_id', 'technology':'Generic'},
'060e':{'hex':'060e', 'name':'dest_network_id', 'technology':'Generic'},
'060f':{'hex':'060f', 'name':'source_node_id', 'technology':'Generic'},
'0610':{'hex':'0610', 'name':'dest_node_id', 'technology':'Generic'},
'0611':{'hex':'0611', 'name':'dest_addr_np_resolution', 'technology':'CDMA, TDMA (US Only)'},
'0612':{'hex':'0612', 'name':'dest_addr_np_information', 'technology':'CDMA, TDMA (US Only)'},
'0613':{'hex':'0613', 'name':'dest_addr_np_country', 'technology':'CDMA, TDMA (US Only)'},
'1201':{'hex':'1201', 'name':'display_time', 'technology':'CDMA,TDMA'},
'1203':{'hex':'1203', 'name':'sms_signal', 'technology':'TDMA'},
'1204':{'hex':'1204', 'name':'ms_validity', 'technology':'CDMA,TDMA'},
'1304':{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'technology':'CDMA'}, # v4 page 85
'1306':{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'technology':'CDMA'}, # v4 page 86
'130c':{'hex':'130c', 'name':'alert_on_message_delivery', 'technology':'CDMA'},
'1380':{'hex':'1380', 'name':'its_reply_type', 'technology':'CDMA'},
'1383':{'hex':'1383', 'name':'its_session_info', 'technology':'CDMA Korean [KORITS]'},
'1402':{'hex':'1402', 'name':'operator_id', 'technology':'vendor extension'},
'1403':{'hex':'1403', 'name':'tariff', 'technology':'Mobile Network Code vendor extension'},
'1450':{'hex':'1450', 'name':'mcc', 'technology':'Mobile Country Code vendor extension'},
'1451':{'hex':'1451', 'name':'mnc', 'technology':'Mobile Network Code vendor extension'},
'1101':{'hex':'1101', 'name':'PDC_MessageClass', 'technology':'? (J-Phone)'}, # v4 page 75
'1102':{'hex':'1102', 'name':'PDC_PresentationOption', 'technology':'? (J-Phone)'}, # v4 page 76
'1103':{'hex':'1103', 'name':'PDC_AlertMechanism', 'technology':'? (J-Phone)'}, # v4 page 76
'1104':{'hex':'1104', 'name':'PDC_Teleservice', 'technology':'? (J-Phone)'}, # v4 page 77
'1105':{'hex':'1105', 'name':'PDC_MultiPartMessage', 'technology':'? (J-Phone)'}, # v4 page 77
'1106':{'hex':'1106', 'name':'PDC_PredefinedMsg', 'technology':'? (J-Phone)'} # v4 page 78
}
def optional_parameter_tag_name_by_hex(x):
return optional_parameter_tag_by_hex.get(x,{}).get('name')
optional_parameter_tag_by_name = {
'dest_addr_subunit' :{'hex':'0005', 'name':'dest_addr_subunit', 'technology':'GSM'},
'dest_network_type' :{'hex':'0006', 'name':'dest_network_type', 'technology':'Generic'},
'dest_bearer_type' :{'hex':'0007', 'name':'dest_bearer_type', 'technology':'Generic'},
'dest_telematics_id' :{'hex':'0008', 'name':'dest_telematics_id', 'technology':'GSM'},
'source_addr_subunit' :{'hex':'000d', 'name':'source_addr_subunit', 'technology':'GSM'},
'source_network_type' :{'hex':'000e', 'name':'source_network_type', 'technology':'Generic'},
'source_bearer_type' :{'hex':'000f', 'name':'source_bearer_type', 'technology':'Generic'},
'source_telematics_id' :{'hex':'0010', 'name':'source_telematics_id', 'technology':'GSM'},
'qos_time_to_live' :{'hex':'0017', 'name':'qos_time_to_live', 'technology':'Generic'},
'payload_type' :{'hex':'0019', 'name':'payload_type', 'technology':'Generic'},
'additional_status_info_text' :{'hex':'001d', 'name':'additional_status_info_text', 'technology':'Generic'},
'receipted_message_id' :{'hex':'001e', 'name':'receipted_message_id', 'technology':'Generic'},
'ms_msg_wait_facilities' :{'hex':'0030', 'name':'ms_msg_wait_facilities', 'technology':'GSM'},
'PVCY_AuthenticationStr' :{'hex':'0101', 'name':'PVCY_AuthenticationStr', 'technology':'? (J-Phone)'}, # v4 page 58-62
'privacy_indicator' :{'hex':'0201', 'name':'privacy_indicator', 'technology':'CDMA,TDMA'},
'source_subaddress' :{'hex':'0202', 'name':'source_subaddress', 'technology':'CDMA,TDMA'}, # v4 page 65-67
'dest_subaddress' :{'hex':'0203', 'name':'dest_subaddress', 'technology':'CDMA,TDMA'}, # v4 page 65-67
'user_message_reference' :{'hex':'0204', 'name':'user_message_reference', 'technology':'Generic'},
'user_response_code' :{'hex':'0205', 'name':'user_response_code', 'technology':'CDMA,TDMA'},
'source_port' :{'hex':'020a', 'name':'source_port', 'technology':'WAP'},
'destination_port' :{'hex':'020b', 'name':'destination_port', 'technology':'WAP'},
'sar_msg_ref_num' :{'hex':'020c', 'name':'sar_msg_ref_num', 'technology':'Generic'},
'language_indicator' :{'hex':'020d', 'name':'language_indicator', 'technology':'CDMA,TDMA'},
'sar_total_segments' :{'hex':'020e', 'name':'sar_total_segments', 'technology':'Generic'},
'sar_segment_seqnum' :{'hex':'020f', 'name':'sar_segment_seqnum', 'technology':'Generic'},
'sc_interface_version' :{'hex':'0210', 'name':'sc_interface_version', 'technology':'Generic'},
'CC_CBN' :{'hex':'0301', 'name':'CC_CBN', 'technology':'V4'}, # v4 page 70
'callback_num_pres_ind' :{'hex':'0302', 'name':'callback_num_pres_ind', 'technology':'TDMA'}, # v4 page 71
'callback_num_atag' :{'hex':'0303', 'name':'callback_num_atag', 'technology':'TDMA'}, # v4 page 71
'number_of_messages' :{'hex':'0304', 'name':'number_of_messages', 'technology':'CDMA'}, # v4 page 72
'callback_num' :{'hex':'0381', 'name':'callback_num', 'technology':'CDMA,TDMA,GSM,iDEN'},
'dpf_result' :{'hex':'0420', 'name':'dpf_result', 'technology':'Generic'},
'set_dpf' :{'hex':'0421', 'name':'set_dpf', 'technology':'Generic'},
'ms_availability_status' :{'hex':'0422', 'name':'ms_availability_status', 'technology':'Generic'},
'network_error_code' :{'hex':'0423', 'name':'network_error_code', 'technology':'Generic'},
'message_payload' :{'hex':'0424', 'name':'message_payload', 'technology':'Generic'},
'delivery_failure_reason' :{'hex':'0425', 'name':'delivery_failure_reason', 'technology':'Generic'},
'more_messages_to_send' :{'hex':'0426', 'name':'more_messages_to_send', 'technology':'GSM'},
'message_state' :{'hex':'0427', 'name':'message_state', 'technology':'Generic'},
'congestion_state' :{'hex':'0428', 'name':'congestion_state', 'technology':'Generic'},
'ussd_service_op' :{'hex':'0501', 'name':'ussd_service_op', 'technology':'GSM (USSD)'},
'broadcast_channel_indicator' :{'hex':'0600', 'name':'broadcast_channel_indicator', 'technology':'GSM'},
'broadcast_content_type' :{'hex':'0601', 'name':'broadcast_content_type', 'technology':'CDMA, TDMA, GSM'},
'broadcast_content_type_info' :{'hex':'0602', 'name':'broadcast_content_type_info', 'technology':'CDMA, TDMA'},
'broadcast_message_class' :{'hex':'0603', 'name':'broadcast_message_class', 'technology':'GSM'},
'broadcast_rep_num' :{'hex':'0604', 'name':'broadcast_rep_num', 'technology':'GSM'},
'broadcast_frequency_interval':{'hex':'0605', 'name':'broadcast_frequency_interval', 'technology':'CDMA, TDMA, GSM'},
'broadcast_area_identifier' :{'hex':'0606', 'name':'broadcast_area_identifier', 'technology':'CDMA, TDMA, GSM'},
'broadcast_error_status' :{'hex':'0607', 'name':'broadcast_error_status', 'technology':'CDMA, TDMA, GSM'},
'broadcast_area_success' :{'hex':'0608', 'name':'broadcast_area_success', 'technology':'GSM'},
'broadcast_end_time' :{'hex':'0609', 'name':'broadcast_end_time', 'technology':'CDMA, TDMA, GSM'},
'broadcast_service_group' :{'hex':'060a', 'name':'broadcast_service_group', 'technology':'CDMA, TDMA'},
'billing_identification' :{'hex':'060b', 'name':'billing_identification', 'technology':'Generic'},
'source_network_id' :{'hex':'060d', 'name':'source_network_id', 'technology':'Generic'},
'dest_network_id' :{'hex':'060e', 'name':'dest_network_id', 'technology':'Generic'},
'source_node_id' :{'hex':'060f', 'name':'source_node_id', 'technology':'Generic'},
'dest_node_id' :{'hex':'0610', 'name':'dest_node_id', 'technology':'Generic'},
'dest_addr_np_resolution' :{'hex':'0611', 'name':'dest_addr_np_resolution', 'technology':'CDMA, TDMA (US Only)'},
'dest_addr_np_information' :{'hex':'0612', 'name':'dest_addr_np_information', 'technology':'CDMA, TDMA (US Only)'},
'dest_addr_np_country' :{'hex':'0613', 'name':'dest_addr_np_country', 'technology':'CDMA, TDMA (US Only)'},
'display_time' :{'hex':'1201', 'name':'display_time', 'technology':'CDMA,TDMA'},
'sms_signal' :{'hex':'1203', 'name':'sms_signal', 'technology':'TDMA'},
'ms_validity' :{'hex':'1204', 'name':'ms_validity', 'technology':'CDMA,TDMA'},
'IS95A_AlertOnDelivery' :{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'technology':'CDMA'}, # v4 page 85
'IS95A_LanguageIndicator' :{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'technology':'CDMA'}, # v4 page 86
'alert_on_message_delivery' :{'hex':'130c', 'name':'alert_on_message_delivery', 'technology':'CDMA'},
'its_reply_type' :{'hex':'1380', 'name':'its_reply_type', 'technology':'CDMA'},
'its_session_info' :{'hex':'1383', 'name':'its_session_info', 'technology':'CDMA Korean [KORITS]'},
'operator_id' :{'hex':'1402', 'name':'operator_id', 'technology':'vendor extension'},
'tariff' :{'hex':'1403', 'name':'tariff', 'technology':'Mobile Network Code vendor extension'},
'mcc' :{'hex':'1450', 'name':'mcc', 'technology':'Mobile Country Code vendor extension'},
'mnc' :{'hex':'1451', 'name':'mnc', 'technology':'Mobile Network Code vendor extension'},
'PDC_MessageClass' :{'hex':'1101', 'name':'PDC_MessageClass', 'technology':'? (J-Phone)'}, # v4 page 75
'PDC_PresentationOption' :{'hex':'1102', 'name':'PDC_PresentationOption', 'technology':'? (J-Phone)'}, # v4 page 76
'PDC_AlertMechanism' :{'hex':'1103', 'name':'PDC_AlertMechanism', 'technology':'? (J-Phone)'}, # v4 page 76
'PDC_Teleservice' :{'hex':'1104', 'name':'PDC_Teleservice', 'technology':'? (J-Phone)'}, # v4 page 77
'PDC_MultiPartMessage' :{'hex':'1105', 'name':'PDC_MultiPartMessage', 'technology':'? (J-Phone)'}, # v4 page 77
'PDC_PredefinedMsg' :{'hex':'1106', 'name':'PDC_PredefinedMsg', 'technology':'? (J-Phone)'} # v4 page 78
}
def optional_parameter_tag_hex_by_name(n):
return optional_parameter_tag_by_name.get(n,{}).get('hex')
-def octpop(hex_ref):
- octet = None
- if len(hex_ref[0]) > 1:
- (octet, hex_ref[0]) = (hex_ref[0][0:2], hex_ref[0][2: ])
- return octet
-
+#### Decoding functions #######################################################
-def decode_hex_type(data, type, count=0, hex_ref=['']):
- if type == 'integer':
- return int(data, 16)
- elif type == 'string':
- return binascii.b2a_qp(binascii.a2b_hex(re.sub('00','',data)))
- elif (type == 'dest_address'
- or type == 'unsuccess_sme'):
- list = []
- fields = mandatory_parameter_list_by_command_name(type)
- for i in range(count):
- (item, hex_ref[0]) = decode_mandatory_parameters(fields, hex_ref)
- if item.get('dest_flag', None) == 1:
- subfields = mandatory_parameter_list_by_command_name('sme_dest_address')
- (rest, hex_ref[0]) = decode_mandatory_parameters(subfields, hex_ref)
- item.update(rest)
- elif item.get('dest_flag', None) == 2:
- subfields = mandatory_parameter_list_by_command_name('distribution_list')
- (rest, hex_ref[0]) = decode_mandatory_parameters(subfields, hex_ref)
- item.update(rest)
- list.append(item)
- return list
- else:
- return data
+def unpack_pdu(pdu_bin):
+ #return binascii.b2a_hex(pdu_bin)
+ return decode_pdu(binascii.b2a_hex(pdu_bin))
-def decode_body(command, body_hex):
- body = {}
- body['mandatory_parameters'] = None
+def decode_pdu(pdu_hex):
+ print '\n===================================================='
+ hex_ref = [pdu_hex]
+ pdu = {}
+ pdu['header'] = decode_header(hex_ref)
+ command = pdu['header'].get('command_id', None)
if command != None:
- fields = mandatory_parameter_list_by_command_name(command)
- (body['mandatory_parameters'], optional_parameters_hex) = \
- decode_mandatory_parameters(fields, [body_hex])
- body['optional_parameters'] = decode_optional_parameters(optional_parameters_hex)
- return body
+ pdu['body'] = decode_body(command, hex_ref)
+ print '====================================================\n'
+ return pdu
-def unpack_pdu(pdu_bin):
- pdu_hex = binascii.b2a_hex(pdu_bin)
- (command_length, command_id, command_status, sequence_number, body_hex) = \
+def decode_header(hex_ref):
+ pdu_hex = hex_ref[0]
+ header = {}
+ (command_length, command_id, command_status, sequence_number, hex_ref[0]) = \
(pdu_hex[0:8], pdu_hex[8:16], pdu_hex[16:24], pdu_hex[24:32], pdu_hex[32: ])
length = int(command_length, 16)
command = command_id_name_by_hex(command_id)
status = command_status_name_by_hex(command_status)
sequence = int(sequence_number, 16)
-
- print '\n--------incoming--------'
- print command_length, length
- print command_id, command
- print command_status, status
- print sequence_number, sequence
- print body_hex
- print pdu_hex
- print '------------------------\n'
-
- pdu = {}
- pdu['length'] = length
- pdu['command'] = command
- pdu['status'] = status
- pdu['sequence'] = sequence
- pdu['body'] = decode_body(command, body_hex)
- print pdu
- return pdu
-
-
-def pack_pdu(command='bind_transmitter', status='ESME_ROK', sequence=0, body_hex=''):
- length = 16 + len(body_hex)/2
- command_length = '%08x' % length
- command_id = command_id_hex_by_name(command)
- command_status = command_status_hex_by_name(status)
- sequence_number = '%08x' % sequence
- pdu_hex = command_length + command_id + command_status + sequence_number + body_hex
-
- print '\n--------outgoing--------'
- print command_length, length
- print command_id, command
- print command_status, status
- print sequence_number, sequence
- print body_hex
- print pdu_hex
- print '------------------------\n'
-
- return binascii.a2b_hex(pdu_hex)
+ header = {}
+ header['command_length'] = length
+ header['command_id'] = command
+ header['command_status'] = status
+ header['sequence_number'] = sequence
+ print 'h==>', 'command_length', ':', repr(header['command_length'])
+ print 'h==>', 'command_id', ':', repr(header['command_id'])
+ print 'h==>', 'command_status', ':', repr(header['command_status'])
+ print 'h==>', 'sequence_number', ':', repr(header['sequence_number'])
+ return header
+
+
+def decode_body(command, hex_ref):
+ body = {}
+ body['mandatory_parameters'] = None
+ if command != None:
+ fields = mandatory_parameter_list_by_command_name(command)
+ body['mandatory_parameters'] = decode_mandatory_parameters(fields, hex_ref)
+ body['optional_parameters'] = decode_optional_parameters(hex_ref)
+ return body
def decode_mandatory_parameters(fields, hex_ref):
mandatory_parameters = {}
- #print "<<<< mand & opt hex >>>", repr(hex_ref[0])
if len(hex_ref[0]) > 1:
for field in fields:
data = ''
octet = ''
count = 0
if field['var'] == True or field['var'] == False:
while (len(hex_ref[0]) > 1
and (count < field['min']
or (count < field['max']
and octet != '00'))):
octet = octpop(hex_ref)
data += octet
count += 1
elif field['type'] == 'string':
count = mandatory_parameters[field['var']]
for i in range(count):
if len(hex_ref[0]) > 1:
data += octpop(hex_ref)
else:
count = mandatory_parameters[field['var']]
- print '>', count, '<', data, '>', field['name']
if field['hex_map'] != None:
mandatory_parameters[field['name']] = maps.get(field['hex_map'],{data:data})[data]
else:
mandatory_parameters[field['name']] = decode_hex_type(data, field['type'], count, hex_ref)
- return (mandatory_parameters, hex_ref[0])
-
-
-def encode_mandatory_parameters(fields, json):
- mandatory_hex = ''
- return mandatory_hex
+ print 'm==>', field['name'], ':', repr(mandatory_parameters[field['name']])
+ return mandatory_parameters
-def decode_optional_parameters(optional_parameters_hex):
+def decode_optional_parameters(hex_ref):
optional_parameters = []
- data = optional_parameters_hex
+ data = hex_ref[0]
while len(data) > 0:
(tag_hex, length_hex, rest) = (data[0:4], data[4:8], data[8: ])
tag = optional_parameter_tag_name_by_hex(tag_hex)
length = int(length_hex, 16)
(value_hex, tail) = (rest[0:length*2], rest[length*2: ])
if len(value_hex) == 0:
value = 0 #TODO remove after testing
else:
value = int(value_hex, 16) #TODO need decoding mapping
data = tail
optional_parameters.append({'tag':tag, 'length':length, 'value':value})
+ print 'o==>', tag, '[', length, ']', ':', repr(value)
return optional_parameters
+def decode_hex_type(data, type, count=0, hex_ref=['']):
+ if type == 'integer':
+ return int(data, 16)
+ elif type == 'string':
+ return binascii.b2a_qp(binascii.a2b_hex(re.sub('00','',data)))
+ elif (type == 'dest_address'
+ or type == 'unsuccess_sme'):
+ list = []
+ fields = mandatory_parameter_list_by_command_name(type)
+ for i in range(count):
+ item = decode_mandatory_parameters(fields, hex_ref)
+ if item.get('dest_flag', None) == 1: # 'dest_address' only
+ subfields = mandatory_parameter_list_by_command_name('sme_dest_address')
+ rest = decode_mandatory_parameters(subfields, hex_ref)
+ item.update(rest)
+ elif item.get('dest_flag', None) == 2: # 'dest_address' only
+ subfields = mandatory_parameter_list_by_command_name('distribution_list')
+ rest = decode_mandatory_parameters(subfields, hex_ref)
+ item.update(rest)
+ list.append(item)
+ return list
+ else:
+ return data
+
+
+def octpop(hex_ref):
+ octet = None
+ if len(hex_ref[0]) > 1:
+ (octet, hex_ref[0]) = (hex_ref[0][0:2], hex_ref[0][2: ])
+ return octet
+
+
+#### Encoding functions #######################################################
+
+def pack_pdu(command='bind_transmitter', status='ESME_ROK', sequence=0, body_hex=''):
+ length = 16 + len(body_hex)/2
+ command_length = '%08x' % length
+ command_id = command_id_hex_by_name(command)
+ command_status = command_status_hex_by_name(status)
+ sequence_number = '%08x' % sequence
+ pdu_hex = command_length + command_id + command_status + sequence_number + body_hex
+ return binascii.a2b_hex(pdu_hex)
+
+
+def encode_mandatory_parameters(fields, json):
+ mandatory_hex = ''
+ return mandatory_hex
+
+
def encode_optional_parameter(tag, value):
optional_hex = ''
tag_hex = optional_parameter_tag_hex_by_name(tag)
if tag_hex != None:
value_hex = '%02x' % value #TODO need encoding mapping
length_hex = '%04x' % (len(value_hex)/2)
optional_hex = tag_hex + length_hex + value_hex
return optional_hex
def json_to_pdu(json):
+ header = json.get('header', {})
body_hex = ''
body = json.get('body', {})
for opt in body.get('optional_parameters',[]):
body_hex += encode_optional_parameter(opt['tag'], opt['value'])
- return pack_pdu(json['command'], json['status'], json['sequence'], body_hex)
+ return pack_pdu(header['command_id'], header['command_status'], header['sequence_number'], body_hex)
|
dmaclay/python-smpp
|
51e26d84b6760833d6ab4dea0defd21d34904bfa
|
decoding pretty much complete - needs testing
|
diff --git a/smpp/pdu.py b/smpp/pdu.py
index eb57792..885e84d 100644
--- a/smpp/pdu.py
+++ b/smpp/pdu.py
@@ -43,891 +43,899 @@ mandatory_parameter_lists = {
],
'bind_transceiver_resp':[ # SMPP v3.4, section 4.1.6, table 4-6, page 52
{'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None}
],
'outbind':[ # SMPP v3.4, section 4.1.7.1, page 54
{'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None},
{'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'hex_map':None}
],
'unbind':[ # SMPP v3.4, section 4.2.1, table 4-7, page 56
],
'unbind_resp':[ # SMPP v3.4, section 4.2.2, table 4-8, page 56
],
'generic_nack':[ # SMPP v3.4, section 4.3.1, table 4-9, page 57
],
'submit_sm':[ # SMPP v3.4, section 4.4.1, table 4-10, page 59-61
{'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
{'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
{'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
{'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
{'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
{'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
{'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'hex_map':None}
],
'submit_sm_resp':[ # SMPP v3.4, section 4.4.2, table 4-11, page 67
{'name':'message_id', 'min':0, 'max':65, 'var':True, 'type':'string', 'hex_map':None}
],
'submit_multi':[ # SMPP v3.4, section 4.5.1, table 4-12, page 69-71
{'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
{'name':'number_of_dests', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'dest_address', 'min':0, 'max':0, 'var':'number_of_dests', 'type':'dest_address', 'hex_map':None},
{'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
{'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
{'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'hex_map':None}
],
'dest_address':[ # SMPP v3.4, section 4.5.1.1, table 4-13, page 75
{'name':'dest_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None}
# 'sme_dest_address' or 'distribution_list' goes here
],
'sme_dest_address':[ # SMPP v3.4, section 4.5.1.1, table 4-14, page 75
{'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
{'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
{'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None}
],
'distribution_list':[ # SMPP v3.4, section 4.5.1.2, table 4-15, page 75
{'name':'dl_name', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None}
],
'submit_multi_resp':[ # SMPP v3.4, section 4.5.2, table 4-16, page 76
{'name':'message_id', 'min':0, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
{'name':'no_unsuccess', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'unsuccess_sme', 'min':0, 'max':0, 'var':'no_unsuccess', 'type':'unsuccess_sme', 'hex_map':None}
],
'unsuccess_sme':[ # SMPP v3.4, section 4.5.2.1, table 4-17, page 77
{'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
{'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
{'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
{'name':'error_status_code', 'min':4, 'max':4, 'var':False, 'type':'integer', 'hex_map':None}
],
'deliver_sm':[ # SMPP v3.4, section 4.6.1, table 4-18, page 79-81
{'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
{'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
{'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
{'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
{'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'schedule_delivery_time', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None},
{'name':'validity_period', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None},
{'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'hex_map':None}
],
'deliver_sm_resp':[ # SMPP v3.4, section 4.6.2, table 4-19, page 85
{'name':'message_id', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None}
],
'data_sm':[ # SMPP v3.4, section 4.7.1, table 4-20, page 87-88
{'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
{'name':'source_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
{'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
{'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
{'name':'destination_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
{'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None}
],
'data_sm_resp':[ # SMPP v3.4, section 4.7.2, table 4-21, page 93
{'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None}
],
'query_sm':[ # SMPP v3.4, section 4.8.1, table 4-22, page 95
{'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None}
],
'query_sm_resp':[ # SMPP v3.4, section 4.7.2, table 4-21, page 93
{'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
{'name':'final_date', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
{'name':'message_state', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'error_code', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None}
],
'cancel_sm':[ # SMPP v3.4, section 4.9.1, table 4-24, page 98-99
{'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
{'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
{'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
{'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
{'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None}
],
'cancel_sm_resp':[ # SMPP v3.4, section 4.9.2, table 4-25, page 100
],
'replace_sm':[ # SMPP v3.4, section 4.10.1, table 4-26, page 102-103
{'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
{'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
{'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
{'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'hex_map':None}
],
'replace_sm_resp':[ # SMPP v3.4, section 4.10.2, table 4-27, page 104
],
'enquire_link':[ # SMPP v3.4, section 4.11.1, table 4-28, page 106
],
'enquire_link_resp':[ # SMPP v3.4, section 4.11.2, table 4-29, page 106
],
'alert_notification':[ # SMPP v3.4, section 4.12.1, table 4-30, page 108
{'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
{'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
{'name':'source_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
{'name':'esme_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
{'name':'esme_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
{'name':'esme_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
]
}
def mandatory_parameter_list_by_command_name(command_name):
return mandatory_parameter_lists.get(command_name,[])
# Command IDs - SMPP v3.4, section 5.1.2.1, table 5-1, page 110-111
command_id_by_hex = {
'80000000':{'hex':'80000000', 'name':'generic_nack'},
'00000001':{'hex':'00000001', 'name':'bind_receiver'},
'80000001':{'hex':'80000001', 'name':'bind_receiver_resp'},
'00000002':{'hex':'00000002', 'name':'bind_transmitter'},
'80000002':{'hex':'80000002', 'name':'bind_transmitter_resp'},
'00000003':{'hex':'00000003', 'name':'query_sm'},
'80000003':{'hex':'80000003', 'name':'query_sm_resp'},
'00000004':{'hex':'00000004', 'name':'submit_sm'},
'80000004':{'hex':'80000004', 'name':'submit_sm_resp'},
'00000005':{'hex':'00000005', 'name':'deliver_sm'},
'80000005':{'hex':'80000005', 'name':'deliver_sm_resp'},
'00000006':{'hex':'00000006', 'name':'unbind'},
'80000006':{'hex':'80000006', 'name':'unbind_resp'},
'00000007':{'hex':'00000007', 'name':'replace_sm'},
'80000007':{'hex':'80000007', 'name':'replace_sm_resp'},
'00000008':{'hex':'00000008', 'name':'cancel_sm'},
'80000008':{'hex':'80000008', 'name':'cancel_sm_resp'},
'00000009':{'hex':'00000009', 'name':'bind_transceiver'},
'80000009':{'hex':'80000009', 'name':'bind_transceiver_resp'},
'0000000b':{'hex':'0000000b', 'name':'outbind'},
'00000015':{'hex':'00000015', 'name':'enquire_link'},
'80000015':{'hex':'80000015', 'name':'enquire_link_resp'},
'00000021':{'hex':'00000021', 'name':'submit_multi'},
'80000021':{'hex':'80000021', 'name':'submit_multi_resp'},
'00000102':{'hex':'00000102', 'name':'alert_notification'},
'00000103':{'hex':'00000103', 'name':'data_sm'},
'80000103':{'hex':'80000103', 'name':'data_sm_resp'},
# v4 codes
'80010000':{'hex':'80010000', 'name':'generic_nack_v4'},
'00010001':{'hex':'00010001', 'name':'bind_receiver_v4'},
'80010001':{'hex':'80010001', 'name':'bind_receiver_resp_v4'},
'00010002':{'hex':'00010002', 'name':'bind_transmitter_v4'},
'80010002':{'hex':'80010002', 'name':'bind_transmitter_resp_v4'},
'00010003':{'hex':'00010003', 'name':'query_sm_v4'},
'80010003':{'hex':'80010003', 'name':'query_sm_resp_v4'},
'00010004':{'hex':'00010004', 'name':'submit_sm_v4'},
'80010004':{'hex':'80010004', 'name':'submit_sm_resp_v4'},
'00010005':{'hex':'00010005', 'name':'deliver_sm_v4'},
'80010005':{'hex':'80010005', 'name':'deliver_sm_resp_v4'},
'00010006':{'hex':'00010006', 'name':'unbind_v4'},
'80010006':{'hex':'80010006', 'name':'unbind_resp_v4'},
'00010007':{'hex':'00010007', 'name':'replace_sm_v4'},
'80010007':{'hex':'80010007', 'name':'replace_sm_resp_v4'},
'00010008':{'hex':'00010008', 'name':'cancel_sm_v4'},
'80010008':{'hex':'80010008', 'name':'cancel_sm_resp_v4'},
'00010009':{'hex':'00010009', 'name':'delivery_receipt_v4'},
'80010009':{'hex':'80010009', 'name':'delivery_receipt_resp_v4'},
'0001000a':{'hex':'0001000a', 'name':'enquire_link_v4'},
'8001000a':{'hex':'8001000a', 'name':'enquire_link_resp_v4'},
'0001000b':{'hex':'0001000b', 'name':'outbind_v4'},
}
def command_id_name_by_hex(x):
return command_id_by_hex.get(x,{}).get('name')
command_id_by_name = {
'generic_nack' :{'hex':'80000000', 'name':'generic_nack'},
'bind_receiver' :{'hex':'00000001', 'name':'bind_receiver'},
'bind_receiver_resp' :{'hex':'80000001', 'name':'bind_receiver_resp'},
'bind_transmitter' :{'hex':'00000002', 'name':'bind_transmitter'},
'bind_transmitter_resp' :{'hex':'80000002', 'name':'bind_transmitter_resp'},
'query_sm' :{'hex':'00000003', 'name':'query_sm'},
'query_sm_resp' :{'hex':'80000003', 'name':'query_sm_resp'},
'submit_sm' :{'hex':'00000004', 'name':'submit_sm'},
'submit_sm_resp' :{'hex':'80000004', 'name':'submit_sm_resp'},
'deliver_sm' :{'hex':'00000005', 'name':'deliver_sm'},
'deliver_sm_resp' :{'hex':'80000005', 'name':'deliver_sm_resp'},
'unbind' :{'hex':'00000006', 'name':'unbind'},
'unbind_resp' :{'hex':'80000006', 'name':'unbind_resp'},
'replace_sm' :{'hex':'00000007', 'name':'replace_sm'},
'replace_sm_resp' :{'hex':'80000007', 'name':'replace_sm_resp'},
'cancel_sm' :{'hex':'00000008', 'name':'cancel_sm'},
'cancel_sm_resp' :{'hex':'80000008', 'name':'cancel_sm_resp'},
'bind_transceiver' :{'hex':'00000009', 'name':'bind_transceiver'},
'bind_transceiver_resp' :{'hex':'80000009', 'name':'bind_transceiver_resp'},
'outbind' :{'hex':'0000000b', 'name':'outbind'},
'enquire_link' :{'hex':'00000015', 'name':'enquire_link'},
'enquire_link_resp' :{'hex':'80000015', 'name':'enquire_link_resp'},
'submit_multi' :{'hex':'00000021', 'name':'submit_multi'},
'submit_multi_resp' :{'hex':'80000021', 'name':'submit_multi_resp'},
'alert_notification' :{'hex':'00000102', 'name':'alert_notification'},
'data_sm' :{'hex':'00000103', 'name':'data_sm'},
'data_sm_resp' :{'hex':'80000103', 'name':'data_sm_resp'},
# v4 codes
'generic_nack_v4' :{'hex':'80010000', 'name':'generic_nack_v4'},
'bind_receiver_v4' :{'hex':'00010001', 'name':'bind_receiver_v4'},
'bind_receiver_resp_v4' :{'hex':'80010001', 'name':'bind_receiver_resp_v4'},
'bind_transmitter_v4' :{'hex':'00010002', 'name':'bind_transmitter_v4'},
'bind_transmitter_resp_v4':{'hex':'80010002', 'name':'bind_transmitter_resp_v4'},
'query_sm_v4' :{'hex':'00010003', 'name':'query_sm_v4'},
'query_sm_resp_v4' :{'hex':'80010003', 'name':'query_sm_resp_v4'},
'submit_sm_v4' :{'hex':'00010004', 'name':'submit_sm_v4'},
'submit_sm_resp_v4' :{'hex':'80010004', 'name':'submit_sm_resp_v4'},
'deliver_sm_v4' :{'hex':'00010005', 'name':'deliver_sm_v4'},
'deliver_sm_resp_v4' :{'hex':'80010005', 'name':'deliver_sm_resp_v4'},
'unbind_v4' :{'hex':'00010006', 'name':'unbind_v4'},
'unbind_resp_v4' :{'hex':'80010006', 'name':'unbind_resp_v4'},
'replace_sm_v4' :{'hex':'00010007', 'name':'replace_sm_v4'},
'replace_sm_resp_v4' :{'hex':'80010007', 'name':'replace_sm_resp_v4'},
'cancel_sm_v4' :{'hex':'00010008', 'name':'cancel_sm_v4'},
'cancel_sm_resp_v4' :{'hex':'80010008', 'name':'cancel_sm_resp_v4'},
'delivery_receipt_v4' :{'hex':'00010009', 'name':'delivery_receipt_v4'},
'delivery_receipt_resp_v4':{'hex':'80010009', 'name':'delivery_receipt_resp_v4'},
'enquire_link_v4' :{'hex':'0001000a', 'name':'enquire_link_v4'},
'enquire_link_resp_v4' :{'hex':'8001000a', 'name':'enquire_link_resp_v4'},
'outbind_v4' :{'hex':'0001000b', 'name':'outbind_v4'}
}
def command_id_hex_by_name(n):
return command_id_by_name.get(n,{}).get('hex')
# SMPP Error Codes (ESME) - SMPP v3.4, section 5.1.3, table 5-2, page 112-114
command_status_by_hex = {
'00000000':{'hex':'00000000', 'name':'ESME_ROK', 'description':'No error'},
'00000001':{'hex':'00000001', 'name':'ESME_RINVMSGLEN', 'description':'Message Length is invalid'},
'00000002':{'hex':'00000002', 'name':'ESME_RINVCMDLEN', 'description':'Command Length is invalid'},
'00000003':{'hex':'00000003', 'name':'ESME_RINVCMDID', 'description':'Invalid Command ID'},
'00000004':{'hex':'00000004', 'name':'ESME_RINVBNDSTS', 'description':'Incorrect BIND Status for given command'},
'00000005':{'hex':'00000005', 'name':'ESME_RALYBND', 'description':'ESME Already in bound state'},
'00000006':{'hex':'00000006', 'name':'ESME_RINVPRTFLG', 'description':'Invalid priority flag'},
'00000007':{'hex':'00000007', 'name':'ESME_RINVREGDLVFLG', 'description':'Invalid registered delivery flag'},
'00000008':{'hex':'00000008', 'name':'ESME_RSYSERR', 'description':'System Error'},
'0000000a':{'hex':'0000000a', 'name':'ESME_RINVSRCADR', 'description':'Invalid source address'},
'0000000b':{'hex':'0000000b', 'name':'ESME_RINVDSTADR', 'description':'Invalid destination address'},
'0000000c':{'hex':'0000000c', 'name':'ESME_RINVMSGID', 'description':'Message ID is invalid'},
'0000000d':{'hex':'0000000d', 'name':'ESME_RBINDFAIL', 'description':'Bind failed'},
'0000000e':{'hex':'0000000e', 'name':'ESME_RINVPASWD', 'description':'Invalid password'},
'0000000f':{'hex':'0000000f', 'name':'ESME_RINVSYSID', 'description':'Invalid System ID'},
'00000011':{'hex':'00000011', 'name':'ESME_RCANCELFAIL', 'description':'Cancel SM Failed'},
'00000013':{'hex':'00000013', 'name':'ESME_RREPLACEFAIL', 'description':'Replace SM Failed'},
'00000014':{'hex':'00000014', 'name':'ESME_RMSGQFUL', 'description':'Message queue full'},
'00000015':{'hex':'00000015', 'name':'ESME_RINVSERTYP', 'description':'Invalid service type'},
'00000033':{'hex':'00000033', 'name':'ESME_RINVNUMDESTS', 'description':'Invalid number of destinations'},
'00000034':{'hex':'00000034', 'name':'ESME_RINVDLNAME', 'description':'Invalid distribution list name'},
'00000040':{'hex':'00000040', 'name':'ESME_RINVDESTFLAG', 'description':'Destination flag is invalid (submit_multi)'},
'00000042':{'hex':'00000042', 'name':'ESME_RINVSUBREP', 'description':"Invalid `submit with replace' request (i.e. submit_sm with replace_if_present_flag set)"},
'00000043':{'hex':'00000043', 'name':'ESME_RINVESMCLASS', 'description':'Invalid esm_class field data'},
'00000044':{'hex':'00000044', 'name':'ESME_RCNTSUBDL', 'description':'Cannot submit to distribution list'},
'00000045':{'hex':'00000045', 'name':'ESME_RSUBMITFAIL', 'description':'submit_sm or submit_multi failed'},
'00000048':{'hex':'00000048', 'name':'ESME_RINVSRCTON', 'description':'Invalid source address TON'},
'00000049':{'hex':'00000049', 'name':'ESME_RINVSRCNPI', 'description':'Invalid source address NPI'},
'00000050':{'hex':'00000050', 'name':'ESME_RINVDSTTON', 'description':'Invalid destination address TON'},
'00000051':{'hex':'00000051', 'name':'ESME_RINVDSTNPI', 'description':'Invalid destination address NPI'},
'00000053':{'hex':'00000053', 'name':'ESME_RINVSYSTYP', 'description':'Invalid system_type field'},
'00000054':{'hex':'00000054', 'name':'ESME_RINVREPFLAG', 'description':'Invalid replace_if_present flag'},
'00000055':{'hex':'00000055', 'name':'ESME_RINVNUMMSGS', 'description':'Invalid number of messages'},
'00000058':{'hex':'00000058', 'name':'ESME_RTHROTTLED', 'description':'Throttling error (ESME has exceeded allowed message limits)'},
'00000061':{'hex':'00000061', 'name':'ESME_RINVSCHED', 'description':'Invalid scheduled delivery time'},
'00000062':{'hex':'00000062', 'name':'ESME_RINVEXPIRY', 'description':'Invalid message validity period (expiry time)'},
'00000063':{'hex':'00000063', 'name':'ESME_RINVDFTMSGID', 'description':'Predefined message invalid or not found'},
'00000064':{'hex':'00000064', 'name':'ESME_RX_T_APPN', 'description':'ESME Receiver Temporary App Error Code'},
'00000065':{'hex':'00000065', 'name':'ESME_RX_P_APPN', 'description':'ESME Receiver Permanent App Error Code'},
'00000066':{'hex':'00000066', 'name':'ESME_RX_R_APPN', 'description':'ESME Receiver Reject Message Error Code'},
'00000067':{'hex':'00000067', 'name':'ESME_RQUERYFAIL', 'description':'query_sm request failed'},
'000000c0':{'hex':'000000c0', 'name':'ESME_RINVOPTPARSTREAM', 'description':'Error in the optional part of the PDU Body'},
'000000c1':{'hex':'000000c1', 'name':'ESME_ROPTPARNOTALLWD', 'description':'Optional paramenter not allowed'},
'000000c2':{'hex':'000000c2', 'name':'ESME_RINVPARLEN', 'description':'Invalid parameter length'},
'000000c3':{'hex':'000000c3', 'name':'ESME_RMISSINGOPTPARAM', 'description':'Expected optional parameter missing'},
'000000c4':{'hex':'000000c4', 'name':'ESME_RINVOPTPARAMVAL', 'description':'Invalid optional parameter value'},
'000000fe':{'hex':'000000fe', 'name':'ESME_RDELIVERYFAILURE', 'description':'Delivery Failure (used for data_sm_resp)'},
'000000ff':{'hex':'000000ff', 'name':'ESME_RUNKNOWNERR', 'description':'Unknown error'}
}
def command_status_name_by_hex(x):
return command_status_by_hex.get(x,{}).get('name')
command_status_by_name = {
'ESME_ROK' :{'hex':'00000000', 'name':'ESME_ROK', 'description':'No error'},
'ESME_RINVMSGLEN' :{'hex':'00000001', 'name':'ESME_RINVMSGLEN', 'description':'Message Length is invalid'},
'ESME_RINVCMDLEN' :{'hex':'00000002', 'name':'ESME_RINVCMDLEN', 'description':'Command Length is invalid'},
'ESME_RINVCMDID' :{'hex':'00000003', 'name':'ESME_RINVCMDID', 'description':'Invalid Command ID'},
'ESME_RINVBNDSTS' :{'hex':'00000004', 'name':'ESME_RINVBNDSTS', 'description':'Incorrect BIND Status for given command'},
'ESME_RALYBND' :{'hex':'00000005', 'name':'ESME_RALYBND', 'description':'ESME Already in bound state'},
'ESME_RINVPRTFLG' :{'hex':'00000006', 'name':'ESME_RINVPRTFLG', 'description':'Invalid priority flag'},
'ESME_RINVREGDLVFLG' :{'hex':'00000007', 'name':'ESME_RINVREGDLVFLG', 'description':'Invalid registered delivery flag'},
'ESME_RSYSERR' :{'hex':'00000008', 'name':'ESME_RSYSERR', 'description':'System Error'},
'ESME_RINVSRCADR' :{'hex':'0000000a', 'name':'ESME_RINVSRCADR', 'description':'Invalid source address'},
'ESME_RINVDSTADR' :{'hex':'0000000b', 'name':'ESME_RINVDSTADR', 'description':'Invalid destination address'},
'ESME_RINVMSGID' :{'hex':'0000000c', 'name':'ESME_RINVMSGID', 'description':'Message ID is invalid'},
'ESME_RBINDFAIL' :{'hex':'0000000d', 'name':'ESME_RBINDFAIL', 'description':'Bind failed'},
'ESME_RINVPASWD' :{'hex':'0000000e', 'name':'ESME_RINVPASWD', 'description':'Invalid password'},
'ESME_RINVSYSID' :{'hex':'0000000f', 'name':'ESME_RINVSYSID', 'description':'Invalid System ID'},
'ESME_RCANCELFAIL' :{'hex':'00000011', 'name':'ESME_RCANCELFAIL', 'description':'Cancel SM Failed'},
'ESME_RREPLACEFAIL' :{'hex':'00000013', 'name':'ESME_RREPLACEFAIL', 'description':'Replace SM Failed'},
'ESME_RMSGQFUL' :{'hex':'00000014', 'name':'ESME_RMSGQFUL', 'description':'Message queue full'},
'ESME_RINVSERTYP' :{'hex':'00000015', 'name':'ESME_RINVSERTYP', 'description':'Invalid service type'},
'ESME_RINVNUMDESTS' :{'hex':'00000033', 'name':'ESME_RINVNUMDESTS', 'description':'Invalid number of destinations'},
'ESME_RINVDLNAME' :{'hex':'00000034', 'name':'ESME_RINVDLNAME', 'description':'Invalid distribution list name'},
'ESME_RINVDESTFLAG' :{'hex':'00000040', 'name':'ESME_RINVDESTFLAG', 'description':'Destination flag is invalid (submit_multi)'},
'ESME_RINVSUBREP' :{'hex':'00000042', 'name':'ESME_RINVSUBREP', 'description':"Invalid `submit with replace' request (i.e. submit_sm with replace_if_present_flag set)"},
'ESME_RINVESMCLASS' :{'hex':'00000043', 'name':'ESME_RINVESMCLASS', 'description':'Invalid esm_class field data'},
'ESME_RCNTSUBDL' :{'hex':'00000044', 'name':'ESME_RCNTSUBDL', 'description':'Cannot submit to distribution list'},
'ESME_RSUBMITFAIL' :{'hex':'00000045', 'name':'ESME_RSUBMITFAIL', 'description':'submit_sm or submit_multi failed'},
'ESME_RINVSRCTON' :{'hex':'00000048', 'name':'ESME_RINVSRCTON', 'description':'Invalid source address TON'},
'ESME_RINVSRCNPI' :{'hex':'00000049', 'name':'ESME_RINVSRCNPI', 'description':'Invalid source address NPI'},
'ESME_RINVDSTTON' :{'hex':'00000050', 'name':'ESME_RINVDSTTON', 'description':'Invalid destination address TON'},
'ESME_RINVDSTNPI' :{'hex':'00000051', 'name':'ESME_RINVDSTNPI', 'description':'Invalid destination address NPI'},
'ESME_RINVSYSTYP' :{'hex':'00000053', 'name':'ESME_RINVSYSTYP', 'description':'Invalid system_type field'},
'ESME_RINVREPFLAG' :{'hex':'00000054', 'name':'ESME_RINVREPFLAG', 'description':'Invalid replace_if_present flag'},
'ESME_RINVNUMMSGS' :{'hex':'00000055', 'name':'ESME_RINVNUMMSGS', 'description':'Invalid number of messages'},
'ESME_RTHROTTLED' :{'hex':'00000058', 'name':'ESME_RTHROTTLED', 'description':'Throttling error (ESME has exceeded allowed message limits)'},
'ESME_RINVSCHED' :{'hex':'00000061', 'name':'ESME_RINVSCHED', 'description':'Invalid scheduled delivery time'},
'ESME_RINVEXPIRY' :{'hex':'00000062', 'name':'ESME_RINVEXPIRY', 'description':'Invalid message validity period (expiry time)'},
'ESME_RINVDFTMSGID' :{'hex':'00000063', 'name':'ESME_RINVDFTMSGID', 'description':'Predefined message invalid or not found'},
'ESME_RX_T_APPN' :{'hex':'00000064', 'name':'ESME_RX_T_APPN', 'description':'ESME Receiver Temporary App Error Code'},
'ESME_RX_P_APPN' :{'hex':'00000065', 'name':'ESME_RX_P_APPN', 'description':'ESME Receiver Permanent App Error Code'},
'ESME_RX_R_APPN' :{'hex':'00000066', 'name':'ESME_RX_R_APPN', 'description':'ESME Receiver Reject Message Error Code'},
'ESME_RQUERYFAIL' :{'hex':'00000067', 'name':'ESME_RQUERYFAIL', 'description':'query_sm request failed'},
'ESME_RINVOPTPARSTREAM':{'hex':'000000c0', 'name':'ESME_RINVOPTPARSTREAM', 'description':'Error in the optional part of the PDU Body'},
'ESME_ROPTPARNOTALLWD' :{'hex':'000000c1', 'name':'ESME_ROPTPARNOTALLWD', 'description':'Optional paramenter not allowed'},
'ESME_RINVPARLEN' :{'hex':'000000c2', 'name':'ESME_RINVPARLEN', 'description':'Invalid parameter length'},
'ESME_RMISSINGOPTPARAM':{'hex':'000000c3', 'name':'ESME_RMISSINGOPTPARAM', 'description':'Expected optional parameter missing'},
'ESME_RINVOPTPARAMVAL' :{'hex':'000000c4', 'name':'ESME_RINVOPTPARAMVAL', 'description':'Invalid optional parameter value'},
'ESME_RDELIVERYFAILURE':{'hex':'000000fe', 'name':'ESME_RDELIVERYFAILURE', 'description':'Delivery Failure (used for data_sm_resp)'},
'ESME_RUNKNOWNERR' :{'hex':'000000ff', 'name':'ESME_RUNKNOWNERR', 'description':'Unknown error'}
}
def command_status_hex_by_name(n):
return command_status_by_name.get(n,{}).get('hex')
# Type of Number (TON) - SMPP v3.4, section 5.2.5, table 5-3, page 117
maps['addr_ton_by_name'] = {
'unknown' :'00',
'international' :'01',
'national' :'02',
'network_specific' :'03',
'subscriber_number':'04',
'alphanumeric' :'05',
'abbreviated' :'06'
}
maps['addr_ton_by_hex'] = {
'00':'unknown',
'01':'international',
'02':'national',
'03':'network_specific',
'04':'subscriber_number',
'05':'alphanumeric',
'06':'abbreviated'
}
# Numberic Plan Indicator (NPI) - SMPP v3.4, section 5.2.6, table 5-4, page 118
maps['addr_npi_by_name'] = {
'unknown' :'00',
'ISDN' :'01',
'data' :'03',
'telex' :'04',
'land_mobile':'06',
'national' :'08',
'private' :'09',
'ERMES' :'0a',
'internet' :'0e',
'WAP' :'12'
}
maps['addr_npi_by_hex'] = {
'00':'unknown',
'01':'ISDN',
'03':'data',
'04':'telex',
'06':'land_mobile',
'08':'national',
'09':'private',
'0a':'ERMES',
'0e':'internet',
'12':'WAP'
}
# ESM Class bits - SMPP v3.4, section 5.2.12, page 121
maps['esm_class_bits'] = {
'mode_mask' :'03',
'type_mask' :'3c',
'feature_mask' :'c0',
'mode_default' :'00',
'mode_datagram' :'01',
'mode_forward' :'02',
'mode_store_and_forward' :'03',
'type_default' :'00',
'type_delivery_receipt' :'04',
'type_delivery_ack' :'08',
'type_0011' :'0a',
'type_user_ack' :'10',
'type_0101' :'14',
'type_conversation_abort' :'18',
'type_0111' :'1a',
'type_intermed_deliv_notif' :'20',
'type_1001' :'24',
'type_1010' :'28',
'type_1011' :'2a',
'type_1100' :'30',
'type_1101' :'34',
'type_1110' :'38',
'type_1111' :'3a',
'feature_none' :'00',
'feature_UDHI' :'40',
'feature_reply_path' :'80',
'feature_UDHI_and_reply_path':'c0'
}
# Registered Delivery bits - SMPP v3.4, section 5.2.17, page 124
maps['registered_delivery_bits'] = {
'receipt_mask' :'03',
'ack_mask' :'0c',
'intermed_notif_mask' :'80',
'receipt_none' :'00',
'receipt_always' :'01',
'receipt_on_fail' :'02',
'receipt_res' :'03',
'ack_none' :'00',
'ack_delivery' :'04',
'ack_user' :'08',
'ack_delivery_and_user':'0c',
'intermed_notif_none' :'00',
'intermed_notif' :'10'
}
# submit_multi dest_flag constants - SMPP v3.4, section 5.2.25, page 129
-maps['dest_flag_by_name'] = {
- 'SME_Address':1,
- 'dist_list' :2
-}
+#maps['dest_flag_by_name'] = {
+ #'SME Address' :1,
+ #'Distribution List Name':2
+#}
# Message State codes returned in query_sm_resp PDUs - SMPP v3.4, section 5.2.28, table 5-6, page 130
maps['message_state_by_name'] = {
'ENROUTE' :1,
'DELIVERED' :2,
'EXPIRED' :3,
'DELETED' :4,
'UNDELIVERABLE':5,
'ACCEPTED' :6,
'UNKNOWN' :7,
'REJECTED' :8
}
# Facility Code bits for SMPP v4
maps['facility_code_bits'] = {
'GF_PVCY' :'00000001',
'GF_SUBADDR':'00000002',
'NF_CC' :'00080000',
'NF_PDC' :'00010000',
'NF_IS136' :'00020000',
'NF_IS95A' :'00040000'
}
# Optional Parameter Tags - SMPP v3.4, section 5.3.2, Table 5-7, page 132-133
optional_parameter_tag_by_hex = {
'0005':{'hex':'0005', 'name':'dest_addr_subunit', 'technology':'GSM'},
'0006':{'hex':'0006', 'name':'dest_network_type', 'technology':'Generic'},
'0007':{'hex':'0007', 'name':'dest_bearer_type', 'technology':'Generic'},
'0008':{'hex':'0008', 'name':'dest_telematics_id', 'technology':'GSM'},
'000d':{'hex':'000d', 'name':'source_addr_subunit', 'technology':'GSM'},
'000e':{'hex':'000e', 'name':'source_network_type', 'technology':'Generic'},
'000f':{'hex':'000f', 'name':'source_bearer_type', 'technology':'Generic'},
'0010':{'hex':'0010', 'name':'source_telematics_id', 'technology':'GSM'},
'0017':{'hex':'0017', 'name':'qos_time_to_live', 'technology':'Generic'},
'0019':{'hex':'0019', 'name':'payload_type', 'technology':'Generic'},
'001d':{'hex':'001d', 'name':'additional_status_info_text', 'technology':'Generic'},
'001e':{'hex':'001e', 'name':'receipted_message_id', 'technology':'Generic'},
'0030':{'hex':'0030', 'name':'ms_msg_wait_facilities', 'technology':'GSM'},
'0101':{'hex':'0101', 'name':'PVCY_AuthenticationStr', 'technology':'? (J-Phone)'}, # v4 page 58-62
'0201':{'hex':'0201', 'name':'privacy_indicator', 'technology':'CDMA,TDMA'},
'0202':{'hex':'0202', 'name':'source_subaddress', 'technology':'CDMA,TDMA'}, # v4 page 65-67
'0203':{'hex':'0203', 'name':'dest_subaddress', 'technology':'CDMA,TDMA'}, # v4 page 65-67
'0204':{'hex':'0204', 'name':'user_message_reference', 'technology':'Generic'},
'0205':{'hex':'0205', 'name':'user_response_code', 'technology':'CDMA,TDMA'},
'020a':{'hex':'020a', 'name':'source_port', 'technology':'WAP'},
'020b':{'hex':'020b', 'name':'destination_port', 'technology':'WAP'},
'020c':{'hex':'020c', 'name':'sar_msg_ref_num', 'technology':'Generic'},
'020d':{'hex':'020d', 'name':'language_indicator', 'technology':'CDMA,TDMA'},
'020e':{'hex':'020e', 'name':'sar_total_segments', 'technology':'Generic'},
'020f':{'hex':'020f', 'name':'sar_segment_seqnum', 'technology':'Generic'},
'0210':{'hex':'0210', 'name':'sc_interface_version', 'technology':'Generic'},
'0301':{'hex':'0301', 'name':'CC_CBN', 'technology':'V4'}, # v4 page 70
'0302':{'hex':'0302', 'name':'callback_num_pres_ind', 'technology':'TDMA'}, # v4 page 71
'0303':{'hex':'0303', 'name':'callback_num_atag', 'technology':'TDMA'}, # v4 page 71
'0304':{'hex':'0304', 'name':'number_of_messages', 'technology':'CDMA'}, # v4 page 72
'0381':{'hex':'0381', 'name':'callback_num', 'technology':'CDMA,TDMA,GSM,iDEN'},
'0420':{'hex':'0420', 'name':'dpf_result', 'technology':'Generic'},
'0421':{'hex':'0421', 'name':'set_dpf', 'technology':'Generic'},
'0422':{'hex':'0422', 'name':'ms_availability_status', 'technology':'Generic'},
'0423':{'hex':'0423', 'name':'network_error_code', 'technology':'Generic'},
'0424':{'hex':'0424', 'name':'message_payload', 'technology':'Generic'},
'0425':{'hex':'0425', 'name':'delivery_failure_reason', 'technology':'Generic'},
'0426':{'hex':'0426', 'name':'more_messages_to_send', 'technology':'GSM'},
'0427':{'hex':'0427', 'name':'message_state', 'technology':'Generic'},
'0428':{'hex':'0428', 'name':'congestion_state', 'technology':'Generic'},
'0501':{'hex':'0501', 'name':'ussd_service_op', 'technology':'GSM (USSD)'},
'0600':{'hex':'0600', 'name':'broadcast_channel_indicator', 'technology':'GSM'},
'0601':{'hex':'0601', 'name':'broadcast_content_type', 'technology':'CDMA, TDMA, GSM'},
'0602':{'hex':'0602', 'name':'broadcast_content_type_info', 'technology':'CDMA, TDMA'},
'0603':{'hex':'0603', 'name':'broadcast_message_class', 'technology':'GSM'},
'0604':{'hex':'0604', 'name':'broadcast_rep_num', 'technology':'GSM'},
'0605':{'hex':'0605', 'name':'broadcast_frequency_interval', 'technology':'CDMA, TDMA, GSM'},
'0606':{'hex':'0606', 'name':'broadcast_area_identifier', 'technology':'CDMA, TDMA, GSM'},
'0607':{'hex':'0607', 'name':'broadcast_error_status', 'technology':'CDMA, TDMA, GSM'},
'0608':{'hex':'0608', 'name':'broadcast_area_success', 'technology':'GSM'},
'0609':{'hex':'0609', 'name':'broadcast_end_time', 'technology':'CDMA, TDMA, GSM'},
'060a':{'hex':'060a', 'name':'broadcast_service_group', 'technology':'CDMA, TDMA'},
'060b':{'hex':'060b', 'name':'billing_identification', 'technology':'Generic'},
'060d':{'hex':'060d', 'name':'source_network_id', 'technology':'Generic'},
'060e':{'hex':'060e', 'name':'dest_network_id', 'technology':'Generic'},
'060f':{'hex':'060f', 'name':'source_node_id', 'technology':'Generic'},
'0610':{'hex':'0610', 'name':'dest_node_id', 'technology':'Generic'},
'0611':{'hex':'0611', 'name':'dest_addr_np_resolution', 'technology':'CDMA, TDMA (US Only)'},
'0612':{'hex':'0612', 'name':'dest_addr_np_information', 'technology':'CDMA, TDMA (US Only)'},
'0613':{'hex':'0613', 'name':'dest_addr_np_country', 'technology':'CDMA, TDMA (US Only)'},
'1201':{'hex':'1201', 'name':'display_time', 'technology':'CDMA,TDMA'},
'1203':{'hex':'1203', 'name':'sms_signal', 'technology':'TDMA'},
'1204':{'hex':'1204', 'name':'ms_validity', 'technology':'CDMA,TDMA'},
'1304':{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'technology':'CDMA'}, # v4 page 85
'1306':{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'technology':'CDMA'}, # v4 page 86
'130c':{'hex':'130c', 'name':'alert_on_message_delivery', 'technology':'CDMA'},
'1380':{'hex':'1380', 'name':'its_reply_type', 'technology':'CDMA'},
'1383':{'hex':'1383', 'name':'its_session_info', 'technology':'CDMA Korean [KORITS]'},
'1402':{'hex':'1402', 'name':'operator_id', 'technology':'vendor extension'},
'1403':{'hex':'1403', 'name':'tariff', 'technology':'Mobile Network Code vendor extension'},
'1450':{'hex':'1450', 'name':'mcc', 'technology':'Mobile Country Code vendor extension'},
'1451':{'hex':'1451', 'name':'mnc', 'technology':'Mobile Network Code vendor extension'},
'1101':{'hex':'1101', 'name':'PDC_MessageClass', 'technology':'? (J-Phone)'}, # v4 page 75
'1102':{'hex':'1102', 'name':'PDC_PresentationOption', 'technology':'? (J-Phone)'}, # v4 page 76
'1103':{'hex':'1103', 'name':'PDC_AlertMechanism', 'technology':'? (J-Phone)'}, # v4 page 76
'1104':{'hex':'1104', 'name':'PDC_Teleservice', 'technology':'? (J-Phone)'}, # v4 page 77
'1105':{'hex':'1105', 'name':'PDC_MultiPartMessage', 'technology':'? (J-Phone)'}, # v4 page 77
'1106':{'hex':'1106', 'name':'PDC_PredefinedMsg', 'technology':'? (J-Phone)'} # v4 page 78
}
def optional_parameter_tag_name_by_hex(x):
return optional_parameter_tag_by_hex.get(x,{}).get('name')
optional_parameter_tag_by_name = {
'dest_addr_subunit' :{'hex':'0005', 'name':'dest_addr_subunit', 'technology':'GSM'},
'dest_network_type' :{'hex':'0006', 'name':'dest_network_type', 'technology':'Generic'},
'dest_bearer_type' :{'hex':'0007', 'name':'dest_bearer_type', 'technology':'Generic'},
'dest_telematics_id' :{'hex':'0008', 'name':'dest_telematics_id', 'technology':'GSM'},
'source_addr_subunit' :{'hex':'000d', 'name':'source_addr_subunit', 'technology':'GSM'},
'source_network_type' :{'hex':'000e', 'name':'source_network_type', 'technology':'Generic'},
'source_bearer_type' :{'hex':'000f', 'name':'source_bearer_type', 'technology':'Generic'},
'source_telematics_id' :{'hex':'0010', 'name':'source_telematics_id', 'technology':'GSM'},
'qos_time_to_live' :{'hex':'0017', 'name':'qos_time_to_live', 'technology':'Generic'},
'payload_type' :{'hex':'0019', 'name':'payload_type', 'technology':'Generic'},
'additional_status_info_text' :{'hex':'001d', 'name':'additional_status_info_text', 'technology':'Generic'},
'receipted_message_id' :{'hex':'001e', 'name':'receipted_message_id', 'technology':'Generic'},
'ms_msg_wait_facilities' :{'hex':'0030', 'name':'ms_msg_wait_facilities', 'technology':'GSM'},
'PVCY_AuthenticationStr' :{'hex':'0101', 'name':'PVCY_AuthenticationStr', 'technology':'? (J-Phone)'}, # v4 page 58-62
'privacy_indicator' :{'hex':'0201', 'name':'privacy_indicator', 'technology':'CDMA,TDMA'},
'source_subaddress' :{'hex':'0202', 'name':'source_subaddress', 'technology':'CDMA,TDMA'}, # v4 page 65-67
'dest_subaddress' :{'hex':'0203', 'name':'dest_subaddress', 'technology':'CDMA,TDMA'}, # v4 page 65-67
'user_message_reference' :{'hex':'0204', 'name':'user_message_reference', 'technology':'Generic'},
'user_response_code' :{'hex':'0205', 'name':'user_response_code', 'technology':'CDMA,TDMA'},
'source_port' :{'hex':'020a', 'name':'source_port', 'technology':'WAP'},
'destination_port' :{'hex':'020b', 'name':'destination_port', 'technology':'WAP'},
'sar_msg_ref_num' :{'hex':'020c', 'name':'sar_msg_ref_num', 'technology':'Generic'},
'language_indicator' :{'hex':'020d', 'name':'language_indicator', 'technology':'CDMA,TDMA'},
'sar_total_segments' :{'hex':'020e', 'name':'sar_total_segments', 'technology':'Generic'},
'sar_segment_seqnum' :{'hex':'020f', 'name':'sar_segment_seqnum', 'technology':'Generic'},
'sc_interface_version' :{'hex':'0210', 'name':'sc_interface_version', 'technology':'Generic'},
'CC_CBN' :{'hex':'0301', 'name':'CC_CBN', 'technology':'V4'}, # v4 page 70
'callback_num_pres_ind' :{'hex':'0302', 'name':'callback_num_pres_ind', 'technology':'TDMA'}, # v4 page 71
'callback_num_atag' :{'hex':'0303', 'name':'callback_num_atag', 'technology':'TDMA'}, # v4 page 71
'number_of_messages' :{'hex':'0304', 'name':'number_of_messages', 'technology':'CDMA'}, # v4 page 72
'callback_num' :{'hex':'0381', 'name':'callback_num', 'technology':'CDMA,TDMA,GSM,iDEN'},
'dpf_result' :{'hex':'0420', 'name':'dpf_result', 'technology':'Generic'},
'set_dpf' :{'hex':'0421', 'name':'set_dpf', 'technology':'Generic'},
'ms_availability_status' :{'hex':'0422', 'name':'ms_availability_status', 'technology':'Generic'},
'network_error_code' :{'hex':'0423', 'name':'network_error_code', 'technology':'Generic'},
'message_payload' :{'hex':'0424', 'name':'message_payload', 'technology':'Generic'},
'delivery_failure_reason' :{'hex':'0425', 'name':'delivery_failure_reason', 'technology':'Generic'},
'more_messages_to_send' :{'hex':'0426', 'name':'more_messages_to_send', 'technology':'GSM'},
'message_state' :{'hex':'0427', 'name':'message_state', 'technology':'Generic'},
'congestion_state' :{'hex':'0428', 'name':'congestion_state', 'technology':'Generic'},
'ussd_service_op' :{'hex':'0501', 'name':'ussd_service_op', 'technology':'GSM (USSD)'},
'broadcast_channel_indicator' :{'hex':'0600', 'name':'broadcast_channel_indicator', 'technology':'GSM'},
'broadcast_content_type' :{'hex':'0601', 'name':'broadcast_content_type', 'technology':'CDMA, TDMA, GSM'},
'broadcast_content_type_info' :{'hex':'0602', 'name':'broadcast_content_type_info', 'technology':'CDMA, TDMA'},
'broadcast_message_class' :{'hex':'0603', 'name':'broadcast_message_class', 'technology':'GSM'},
'broadcast_rep_num' :{'hex':'0604', 'name':'broadcast_rep_num', 'technology':'GSM'},
'broadcast_frequency_interval':{'hex':'0605', 'name':'broadcast_frequency_interval', 'technology':'CDMA, TDMA, GSM'},
'broadcast_area_identifier' :{'hex':'0606', 'name':'broadcast_area_identifier', 'technology':'CDMA, TDMA, GSM'},
'broadcast_error_status' :{'hex':'0607', 'name':'broadcast_error_status', 'technology':'CDMA, TDMA, GSM'},
'broadcast_area_success' :{'hex':'0608', 'name':'broadcast_area_success', 'technology':'GSM'},
'broadcast_end_time' :{'hex':'0609', 'name':'broadcast_end_time', 'technology':'CDMA, TDMA, GSM'},
'broadcast_service_group' :{'hex':'060a', 'name':'broadcast_service_group', 'technology':'CDMA, TDMA'},
'billing_identification' :{'hex':'060b', 'name':'billing_identification', 'technology':'Generic'},
'source_network_id' :{'hex':'060d', 'name':'source_network_id', 'technology':'Generic'},
'dest_network_id' :{'hex':'060e', 'name':'dest_network_id', 'technology':'Generic'},
'source_node_id' :{'hex':'060f', 'name':'source_node_id', 'technology':'Generic'},
'dest_node_id' :{'hex':'0610', 'name':'dest_node_id', 'technology':'Generic'},
'dest_addr_np_resolution' :{'hex':'0611', 'name':'dest_addr_np_resolution', 'technology':'CDMA, TDMA (US Only)'},
'dest_addr_np_information' :{'hex':'0612', 'name':'dest_addr_np_information', 'technology':'CDMA, TDMA (US Only)'},
'dest_addr_np_country' :{'hex':'0613', 'name':'dest_addr_np_country', 'technology':'CDMA, TDMA (US Only)'},
'display_time' :{'hex':'1201', 'name':'display_time', 'technology':'CDMA,TDMA'},
'sms_signal' :{'hex':'1203', 'name':'sms_signal', 'technology':'TDMA'},
'ms_validity' :{'hex':'1204', 'name':'ms_validity', 'technology':'CDMA,TDMA'},
'IS95A_AlertOnDelivery' :{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'technology':'CDMA'}, # v4 page 85
'IS95A_LanguageIndicator' :{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'technology':'CDMA'}, # v4 page 86
'alert_on_message_delivery' :{'hex':'130c', 'name':'alert_on_message_delivery', 'technology':'CDMA'},
'its_reply_type' :{'hex':'1380', 'name':'its_reply_type', 'technology':'CDMA'},
'its_session_info' :{'hex':'1383', 'name':'its_session_info', 'technology':'CDMA Korean [KORITS]'},
'operator_id' :{'hex':'1402', 'name':'operator_id', 'technology':'vendor extension'},
'tariff' :{'hex':'1403', 'name':'tariff', 'technology':'Mobile Network Code vendor extension'},
'mcc' :{'hex':'1450', 'name':'mcc', 'technology':'Mobile Country Code vendor extension'},
'mnc' :{'hex':'1451', 'name':'mnc', 'technology':'Mobile Network Code vendor extension'},
'PDC_MessageClass' :{'hex':'1101', 'name':'PDC_MessageClass', 'technology':'? (J-Phone)'}, # v4 page 75
'PDC_PresentationOption' :{'hex':'1102', 'name':'PDC_PresentationOption', 'technology':'? (J-Phone)'}, # v4 page 76
'PDC_AlertMechanism' :{'hex':'1103', 'name':'PDC_AlertMechanism', 'technology':'? (J-Phone)'}, # v4 page 76
'PDC_Teleservice' :{'hex':'1104', 'name':'PDC_Teleservice', 'technology':'? (J-Phone)'}, # v4 page 77
'PDC_MultiPartMessage' :{'hex':'1105', 'name':'PDC_MultiPartMessage', 'technology':'? (J-Phone)'}, # v4 page 77
'PDC_PredefinedMsg' :{'hex':'1106', 'name':'PDC_PredefinedMsg', 'technology':'? (J-Phone)'} # v4 page 78
}
def optional_parameter_tag_hex_by_name(n):
return optional_parameter_tag_by_name.get(n,{}).get('hex')
def octpop(hex_ref):
octet = None
if len(hex_ref[0]) > 1:
(octet, hex_ref[0]) = (hex_ref[0][0:2], hex_ref[0][2: ])
return octet
def decode_hex_type(data, type, count=0, hex_ref=['']):
if type == 'integer':
return int(data, 16)
elif type == 'string':
return binascii.b2a_qp(binascii.a2b_hex(re.sub('00','',data)))
- elif type == 'dest_address' \
- or type == 'unsuccess_sme':
+ elif (type == 'dest_address'
+ or type == 'unsuccess_sme'):
list = []
fields = mandatory_parameter_list_by_command_name(type)
for i in range(count):
(element, hex_ref[0]) = decode_mandatory_parameters(fields, hex_ref)
+ if element.get('dest_flag', None) == 1:
+ subfields = mandatory_parameter_list_by_command_name('sme_dest_address')
+ (rest, hex_ref[0]) = decode_mandatory_parameters(subfields, hex_ref)
+ element = dict(element, **rest)
+ elif element.get('dest_flag', None) == 2:
+ subfields = mandatory_parameter_list_by_command_name('distribution_list')
+ (rest, hex_ref[0]) = decode_mandatory_parameters(subfields, hex_ref)
+ element = dict(element, **rest)
list.append(element)
return list
else:
return data
def decode_body(command, body_hex):
body = {}
body['mandatory_parameters'] = None
if command != None:
fields = mandatory_parameter_list_by_command_name(command)
(body['mandatory_parameters'], optional_parameters_hex) = \
decode_mandatory_parameters(fields, [body_hex])
body['optional_parameters'] = decode_optional_parameters(optional_parameters_hex)
return body
def unpack_pdu(pdu_bin):
pdu_hex = binascii.b2a_hex(pdu_bin)
(command_length, command_id, command_status, sequence_number, body_hex) = \
(pdu_hex[0:8], pdu_hex[8:16], pdu_hex[16:24], pdu_hex[24:32], pdu_hex[32: ])
length = int(command_length, 16)
command = command_id_name_by_hex(command_id)
status = command_status_name_by_hex(command_status)
sequence = int(sequence_number, 16)
print '\n--------incoming--------'
print command_length, length
print command_id, command
print command_status, status
print sequence_number, sequence
print body_hex
print pdu_hex
print '------------------------\n'
pdu = {}
pdu['length'] = length
pdu['command'] = command
pdu['status'] = status
pdu['sequence'] = sequence
pdu['body'] = decode_body(command, body_hex)
print pdu
return pdu
def pack_pdu(command='bind_transmitter', status='ESME_ROK', sequence=0, body_hex=''):
length = 16 + len(body_hex)/2
command_length = '%08x' % length
command_id = command_id_hex_by_name(command)
command_status = command_status_hex_by_name(status)
sequence_number = '%08x' % sequence
pdu_hex = command_length + command_id + command_status + sequence_number + body_hex
print '\n--------outgoing--------'
print command_length, length
print command_id, command
print command_status, status
print sequence_number, sequence
print body_hex
print pdu_hex
print '------------------------\n'
return binascii.a2b_hex(pdu_hex)
def decode_mandatory_parameters(fields, hex_ref):
mandatory_parameters = {}
- print "<<<< mand & opt hex >>>", repr(hex_ref[0])
+ #print "<<<< mand & opt hex >>>", repr(hex_ref[0])
if len(hex_ref[0]) > 1:
for field in fields:
data = ''
octet = ''
count = 0
if field['var'] == True or field['var'] == False:
while (len(hex_ref[0]) > 1
and (count < field['min']
or (count < field['max']
and (octet != '00')))):
octet = octpop(hex_ref)
data += octet
count += 1
elif field['type'] == 'string':
count = mandatory_parameters[field['var']]
for i in range(count):
if len(hex_ref[0]) > 1:
data += octpop(hex_ref)
else:
count = mandatory_parameters[field['var']]
- print '>', count, data
+ print '>', count, '<', data, '>', field['name']
if field['hex_map'] != None:
mandatory_parameters[field['name']] = maps.get(field['hex_map'],{data:data})[data]
else:
mandatory_parameters[field['name']] = decode_hex_type(data, field['type'], count, hex_ref)
return (mandatory_parameters, hex_ref[0])
def encode_mandatory_parameters(fields, json):
mandatory_hex = ''
return mandatory_hex
def decode_optional_parameters(optional_parameters_hex):
optional_parameters = []
data = optional_parameters_hex
while len(data) > 0:
(tag_hex, length_hex, rest) = (data[0:4], data[4:8], data[8: ])
tag = optional_parameter_tag_name_by_hex(tag_hex)
length = int(length_hex, 16)
(value_hex, tail) = (rest[0:length*2], rest[length*2: ])
if len(value_hex) == 0:
value = 0 #TODO remove after testing
else:
value = int(value_hex, 16) #TODO need decoding mapping
data = tail
optional_parameters.append({'tag':tag, 'length':length, 'value':value})
return optional_parameters
def encode_optional_parameter(tag, value):
optional_hex = ''
tag_hex = optional_parameter_tag_hex_by_name(tag)
if tag_hex != None:
value_hex = '%02x' % value #TODO need encoding mapping
length_hex = '%04x' % (len(value_hex)/2)
optional_hex = tag_hex + length_hex + value_hex
return optional_hex
def json_to_pdu(json):
body_hex = ''
body = json.get('body', {})
for opt in body.get('optional_parameters',[]):
body_hex += encode_optional_parameter(opt['tag'], opt['value'])
return pack_pdu(json['command'], json['status'], json['sequence'], body_hex)
|
dmaclay/python-smpp
|
f30e2e467bd00f0f951697d98f21adb19cc1bb84
|
decoding pretty much complete - needs testing
|
diff --git a/tests.py b/tests.py
index 45645f3..6acf1f5 100644
--- a/tests.py
+++ b/tests.py
@@ -1,30 +1,30 @@
from smpp.esme import *
#esme = ESME()
#esme.connect_SMSC()
#print str(binascii.a2b_hex(re.sub(' ','','00 00 00 3C 00 00 00 04 00 00 00 00 00 00 00 05 00 02 08 35 35 35 00 01 01 35 35 35 35 35 35 35 35 35 00 00 00 00 00 00 00 00 00 00 0F 48 65 6C 6C 6F 20 77 69 6B 69 70 65 64 69 61')))
print ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>"
test_bin = binascii.a2b_hex(re.sub(' ','','00 00 00 3C 00 00 00 04 00 00 00 00 00 00 00 05 00 02 08 35 35 35 00 01 01 35 35 35 35 35 35 35 35 35 00 00 00 00 00 00 00 00 00 00 0F 48 65 6C 6C 6F 20 77 69 6B 69 70 65 64 69 61 00000000 00000000'))
unpack_pdu(test_bin)
-test_bin = binascii.a2b_hex(re.sub(' ','','00000000 00000021 00000000 00000000 00 00 00 00 01 01 00 00 00 00 00 00 00 00 00 00 0000000000000000000000000000000000000000000000000000000000 00000000 00000000 0000'))
+test_bin = binascii.a2b_hex(re.sub(' ','','00000000 00000021 00000000 00000000 00 00 00 00 02 0101016500 026600 00 00 00 00 00 00 00 00 00 00 0000000000000000000000000000000000000000000000000000000000 00000000 00000000 0000'))
unpack_pdu(test_bin)
-test_bin = binascii.a2b_hex(re.sub(' ','','00000000 80000021 00000000 00000000 00 01 01010000000000 00000000 00000000'))
+test_bin = binascii.a2b_hex(re.sub(' ','','00000000 80000021 00000000 00000000 00 02 01010000000000 01010000000000'))
unpack_pdu(test_bin)
pack_pdu('generic_nack','ESME_ROK',1,'00112233445566778899')
pack_pdu()
unpack_pdu(pack_pdu())
j = {'status': 'ESME_ROK', 'body': {'optional_parameters':[{'tag':'payload_type', 'value':0}]}, 'length': 16, 'sequence': 0, 'command': 'bind_transmitter'}
json_to_pdu(j)
|
dmaclay/python-smpp
|
d8fc5e43b646c9dde550c9673e01872c9b156d81
|
nested decoding
|
diff --git a/smpp/esme.py b/smpp/esme.py
index 435835b..1de7bf9 100644
--- a/smpp/esme.py
+++ b/smpp/esme.py
@@ -1,34 +1,34 @@
import socket
from pdu import *
class ESME:
def __init__(self):
self.conn = None
def connect_SMSC(self, host='127.0.0.1', port=2775):
self.conn = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
self.conn.connect((host, port))
def disconnect_SMSC(self):
self.conn.close()
def bind_SMSC(self):
out_hex = re.sub(' ','','00 00 00 2F 00 00 00 02 00 00 00 00 00 00 00 01 53 4D 50 50 33 54 45 53 54 00 73 65 63 72 65 74 30 38 00 53 55 42 4D 49 54 31 00 00 01 01 00')
print '<<<< bind_SMSC out_hex >>>>', out_hex
out_bin = binascii.a2b_hex(out_hex)
self.conn.send(out_bin)
length_bin = self.conn.recv(4)
length = int(binascii.b2a_hex(length_bin),16)
rest_bin = self.conn.recv(length-4)
unpack_pdu(length_bin + rest_bin)
-esme = ESME()
-esme.connect_SMSC('localhost')
-esme.bind_SMSC()
-esme.disconnect_SMSC()
+#esme = ESME()
+#esme.connect_SMSC('localhost')
+#esme.bind_SMSC()
+#esme.disconnect_SMSC()
|
dmaclay/python-smpp
|
b1095aa3a556d2c932fe0ca7b8ed672172921d85
|
nested decoding
|
diff --git a/tests.py b/tests.py
index 5f8eec5..45645f3 100644
--- a/tests.py
+++ b/tests.py
@@ -1,25 +1,30 @@
from smpp.esme import *
#esme = ESME()
#esme.connect_SMSC()
#print str(binascii.a2b_hex(re.sub(' ','','00 00 00 3C 00 00 00 04 00 00 00 00 00 00 00 05 00 02 08 35 35 35 00 01 01 35 35 35 35 35 35 35 35 35 00 00 00 00 00 00 00 00 00 00 0F 48 65 6C 6C 6F 20 77 69 6B 69 70 65 64 69 61')))
print ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>"
test_bin = binascii.a2b_hex(re.sub(' ','','00 00 00 3C 00 00 00 04 00 00 00 00 00 00 00 05 00 02 08 35 35 35 00 01 01 35 35 35 35 35 35 35 35 35 00 00 00 00 00 00 00 00 00 00 0F 48 65 6C 6C 6F 20 77 69 6B 69 70 65 64 69 61 00000000 00000000'))
unpack_pdu(test_bin)
+test_bin = binascii.a2b_hex(re.sub(' ','','00000000 00000021 00000000 00000000 00 00 00 00 01 01 00 00 00 00 00 00 00 00 00 00 0000000000000000000000000000000000000000000000000000000000 00000000 00000000 0000'))
+unpack_pdu(test_bin)
+
+test_bin = binascii.a2b_hex(re.sub(' ','','00000000 80000021 00000000 00000000 00 01 01010000000000 00000000 00000000'))
+unpack_pdu(test_bin)
pack_pdu('generic_nack','ESME_ROK',1,'00112233445566778899')
pack_pdu()
unpack_pdu(pack_pdu())
j = {'status': 'ESME_ROK', 'body': {'optional_parameters':[{'tag':'payload_type', 'value':0}]}, 'length': 16, 'sequence': 0, 'command': 'bind_transmitter'}
json_to_pdu(j)
|
dmaclay/python-smpp
|
14b3ca465a4e064fd430c2094f3a3d20acd97764
|
nested decoding
|
diff --git a/smpp/pdu.py b/smpp/pdu.py
index 605f92e..eb57792 100644
--- a/smpp/pdu.py
+++ b/smpp/pdu.py
@@ -1,919 +1,933 @@
import binascii
import re
maps = {} # Inserting certain referenced dicts in here means they can be declared in the same order as in the spec.
# SMPP PDU Definition - SMPP v3.4, section 4, page 45
mandatory_parameter_lists = {
'bind_transmitter':[ # SMPP v3.4, section 4.1.1, table 4-1, page 46
- {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':'addr_ton_by_hex'},
- {'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':'addr_npi_by_hex'},
- {'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'hex_map':None}
+ {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None},
+ {'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':'addr_ton_by_hex'},
+ {'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':'addr_npi_by_hex'},
+ {'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'hex_map':None}
],
'bind_transmitter_resp':[ # SMPP v3.4, section 4.1.2, table 4-2, page 47
- {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None}
+ {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None}
],
'bind_receiver':[ # SMPP v3.4, section 4.1.3, table 4-3, page 48
- {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':'addr_ton_by_hex'},
- {'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':'addr_npi_by_hex'},
- {'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'hex_map':None}
+ {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None},
+ {'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':'addr_ton_by_hex'},
+ {'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':'addr_npi_by_hex'},
+ {'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'hex_map':None}
],
'bind_receiver_resp':[ # SMPP v3.4, section 4.1.4, table 4-4, page 50
- {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None}
+ {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None}
],
'bind_transceiver':[ # SMPP v3.4, section 4.1.5, table 4-5, page 51
- {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':'addr_ton_by_hex'},
- {'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':'addr_npi_by_hex'},
- {'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'hex_map':None}
+ {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None},
+ {'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':'addr_ton_by_hex'},
+ {'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':'addr_npi_by_hex'},
+ {'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'hex_map':None}
],
'bind_transceiver_resp':[ # SMPP v3.4, section 4.1.6, table 4-6, page 52
- {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None}
+ {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None}
],
'outbind':[ # SMPP v3.4, section 4.1.7.1, page 54
- {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'hex_map':None}
+ {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'hex_map':None}
],
'unbind':[ # SMPP v3.4, section 4.2.1, table 4-7, page 56
],
'unbind_resp':[ # SMPP v3.4, section 4.2.2, table 4-8, page 56
],
'generic_nack':[ # SMPP v3.4, section 4.3.1, table 4-9, page 57
],
'submit_sm':[ # SMPP v3.4, section 4.4.1, table 4-10, page 59-61
- {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'hex_map':None}
+ {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
+ {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
+ {'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
+ {'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
+ {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'hex_map':None}
],
'submit_sm_resp':[ # SMPP v3.4, section 4.4.2, table 4-11, page 67
- {'name':'message_id', 'min':0, 'max':65, 'var':True, 'type':'string', 'hex_map':None}
+ {'name':'message_id', 'min':0, 'max':65, 'var':True, 'type':'string', 'hex_map':None}
],
'submit_multi':[ # SMPP v3.4, section 4.5.1, table 4-12, page 69-71
- {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'number_of_dests', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'dest_address', 'min':2, 'max':24, 'var':True, 'type':'dest_address', 'hex_map':None},
- {'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'hex_map':None}
+ {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
+ {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'number_of_dests', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'dest_address', 'min':0, 'max':0, 'var':'number_of_dests', 'type':'dest_address', 'hex_map':None},
+ {'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
+ {'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
+ {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'hex_map':None}
],
'dest_address':[ # SMPP v3.4, section 4.5.1.1, table 4-13, page 75
- {'name':'dest_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None}
+ {'name':'dest_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None}
# 'sme_dest_address' or 'distribution_list' goes here
],
'sme_dest_address':[ # SMPP v3.4, section 4.5.1.1, table 4-14, page 75
- {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None}
+ {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
+ {'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None}
],
'distribution_list':[ # SMPP v3.4, section 4.5.1.2, table 4-15, page 75
- {'name':'dl_name', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None}
+ {'name':'dl_name', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None}
],
'submit_multi_resp':[ # SMPP v3.4, section 4.5.2, table 4-16, page 76
- {'name':'message_id', 'min':0, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'no_unsuccess', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'unsuccess_sme', 'min':7, 'max':27, 'var':True, 'type':'unsuccess_sme', 'hex_map':None}
+ {'name':'message_id', 'min':0, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'no_unsuccess', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'unsuccess_sme', 'min':0, 'max':0, 'var':'no_unsuccess', 'type':'unsuccess_sme', 'hex_map':None}
+ ],
+ 'unsuccess_sme':[ # SMPP v3.4, section 4.5.2.1, table 4-17, page 77
+ {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
+ {'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'error_status_code', 'min':4, 'max':4, 'var':False, 'type':'integer', 'hex_map':None}
],
'deliver_sm':[ # SMPP v3.4, section 4.6.1, table 4-18, page 79-81
- {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'schedule_delivery_time', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'validity_period', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'hex_map':None}
+ {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
+ {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
+ {'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'schedule_delivery_time', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None},
+ {'name':'validity_period', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None},
+ {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'hex_map':None}
],
'deliver_sm_resp':[ # SMPP v3.4, section 4.6.2, table 4-19, page 85
- {'name':'message_id', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None}
+ {'name':'message_id', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None}
],
'data_sm':[ # SMPP v3.4, section 4.7.1, table 4-20, page 87-88
- {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'source_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'destination_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None}
+ {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
+ {'name':'source_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
+ {'name':'destination_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None}
],
'data_sm_resp':[ # SMPP v3.4, section 4.7.2, table 4-21, page 93
- {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None}
+ {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None}
],
'query_sm':[ # SMPP v3.4, section 4.8.1, table 4-22, page 95
- {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None}
+ {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
+ {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None}
],
'query_sm_resp':[ # SMPP v3.4, section 4.7.2, table 4-21, page 93
- {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'final_date', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'message_state', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'error_code', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None}
+ {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'final_date', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
+ {'name':'message_state', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'error_code', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None}
],
'cancel_sm':[ # SMPP v3.4, section 4.9.1, table 4-24, page 98-99
- {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None}
+ {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
+ {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
+ {'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None}
],
'cancel_sm_resp':[ # SMPP v3.4, section 4.9.2, table 4-25, page 100
],
'replace_sm':[ # SMPP v3.4, section 4.10.1, table 4-26, page 102-103
- {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'hex_map':None}
+ {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
+ {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
+ {'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
+ {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'hex_map':None}
],
'replace_sm_resp':[ # SMPP v3.4, section 4.10.2, table 4-27, page 104
],
'enquire_link':[ # SMPP v3.4, section 4.11.1, table 4-28, page 106
],
'enquire_link_resp':[ # SMPP v3.4, section 4.11.2, table 4-29, page 106
],
'alert_notification':[ # SMPP v3.4, section 4.12.1, table 4-30, page 108
- {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'source_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'esme_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'esme_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'esme_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
+ {'name':'source_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'esme_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'esme_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
+ {'name':'esme_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
]
}
def mandatory_parameter_list_by_command_name(command_name):
return mandatory_parameter_lists.get(command_name,[])
# Command IDs - SMPP v3.4, section 5.1.2.1, table 5-1, page 110-111
command_id_by_hex = {
'80000000':{'hex':'80000000', 'name':'generic_nack'},
'00000001':{'hex':'00000001', 'name':'bind_receiver'},
'80000001':{'hex':'80000001', 'name':'bind_receiver_resp'},
'00000002':{'hex':'00000002', 'name':'bind_transmitter'},
'80000002':{'hex':'80000002', 'name':'bind_transmitter_resp'},
'00000003':{'hex':'00000003', 'name':'query_sm'},
'80000003':{'hex':'80000003', 'name':'query_sm_resp'},
'00000004':{'hex':'00000004', 'name':'submit_sm'},
'80000004':{'hex':'80000004', 'name':'submit_sm_resp'},
'00000005':{'hex':'00000005', 'name':'deliver_sm'},
'80000005':{'hex':'80000005', 'name':'deliver_sm_resp'},
'00000006':{'hex':'00000006', 'name':'unbind'},
'80000006':{'hex':'80000006', 'name':'unbind_resp'},
'00000007':{'hex':'00000007', 'name':'replace_sm'},
'80000007':{'hex':'80000007', 'name':'replace_sm_resp'},
'00000008':{'hex':'00000008', 'name':'cancel_sm'},
'80000008':{'hex':'80000008', 'name':'cancel_sm_resp'},
'00000009':{'hex':'00000009', 'name':'bind_transceiver'},
'80000009':{'hex':'80000009', 'name':'bind_transceiver_resp'},
'0000000b':{'hex':'0000000b', 'name':'outbind'},
'00000015':{'hex':'00000015', 'name':'enquire_link'},
'80000015':{'hex':'80000015', 'name':'enquire_link_resp'},
'00000021':{'hex':'00000021', 'name':'submit_multi'},
'80000021':{'hex':'80000021', 'name':'submit_multi_resp'},
'00000102':{'hex':'00000102', 'name':'alert_notification'},
'00000103':{'hex':'00000103', 'name':'data_sm'},
'80000103':{'hex':'80000103', 'name':'data_sm_resp'},
# v4 codes
'80010000':{'hex':'80010000', 'name':'generic_nack_v4'},
'00010001':{'hex':'00010001', 'name':'bind_receiver_v4'},
'80010001':{'hex':'80010001', 'name':'bind_receiver_resp_v4'},
'00010002':{'hex':'00010002', 'name':'bind_transmitter_v4'},
'80010002':{'hex':'80010002', 'name':'bind_transmitter_resp_v4'},
'00010003':{'hex':'00010003', 'name':'query_sm_v4'},
'80010003':{'hex':'80010003', 'name':'query_sm_resp_v4'},
'00010004':{'hex':'00010004', 'name':'submit_sm_v4'},
'80010004':{'hex':'80010004', 'name':'submit_sm_resp_v4'},
'00010005':{'hex':'00010005', 'name':'deliver_sm_v4'},
'80010005':{'hex':'80010005', 'name':'deliver_sm_resp_v4'},
'00010006':{'hex':'00010006', 'name':'unbind_v4'},
'80010006':{'hex':'80010006', 'name':'unbind_resp_v4'},
'00010007':{'hex':'00010007', 'name':'replace_sm_v4'},
'80010007':{'hex':'80010007', 'name':'replace_sm_resp_v4'},
'00010008':{'hex':'00010008', 'name':'cancel_sm_v4'},
'80010008':{'hex':'80010008', 'name':'cancel_sm_resp_v4'},
'00010009':{'hex':'00010009', 'name':'delivery_receipt_v4'},
'80010009':{'hex':'80010009', 'name':'delivery_receipt_resp_v4'},
'0001000a':{'hex':'0001000a', 'name':'enquire_link_v4'},
'8001000a':{'hex':'8001000a', 'name':'enquire_link_resp_v4'},
'0001000b':{'hex':'0001000b', 'name':'outbind_v4'},
}
def command_id_name_by_hex(x):
return command_id_by_hex.get(x,{}).get('name')
command_id_by_name = {
'generic_nack' :{'hex':'80000000', 'name':'generic_nack'},
'bind_receiver' :{'hex':'00000001', 'name':'bind_receiver'},
'bind_receiver_resp' :{'hex':'80000001', 'name':'bind_receiver_resp'},
'bind_transmitter' :{'hex':'00000002', 'name':'bind_transmitter'},
'bind_transmitter_resp' :{'hex':'80000002', 'name':'bind_transmitter_resp'},
'query_sm' :{'hex':'00000003', 'name':'query_sm'},
'query_sm_resp' :{'hex':'80000003', 'name':'query_sm_resp'},
'submit_sm' :{'hex':'00000004', 'name':'submit_sm'},
'submit_sm_resp' :{'hex':'80000004', 'name':'submit_sm_resp'},
'deliver_sm' :{'hex':'00000005', 'name':'deliver_sm'},
'deliver_sm_resp' :{'hex':'80000005', 'name':'deliver_sm_resp'},
'unbind' :{'hex':'00000006', 'name':'unbind'},
'unbind_resp' :{'hex':'80000006', 'name':'unbind_resp'},
'replace_sm' :{'hex':'00000007', 'name':'replace_sm'},
'replace_sm_resp' :{'hex':'80000007', 'name':'replace_sm_resp'},
'cancel_sm' :{'hex':'00000008', 'name':'cancel_sm'},
'cancel_sm_resp' :{'hex':'80000008', 'name':'cancel_sm_resp'},
'bind_transceiver' :{'hex':'00000009', 'name':'bind_transceiver'},
'bind_transceiver_resp' :{'hex':'80000009', 'name':'bind_transceiver_resp'},
'outbind' :{'hex':'0000000b', 'name':'outbind'},
'enquire_link' :{'hex':'00000015', 'name':'enquire_link'},
'enquire_link_resp' :{'hex':'80000015', 'name':'enquire_link_resp'},
'submit_multi' :{'hex':'00000021', 'name':'submit_multi'},
'submit_multi_resp' :{'hex':'80000021', 'name':'submit_multi_resp'},
'alert_notification' :{'hex':'00000102', 'name':'alert_notification'},
'data_sm' :{'hex':'00000103', 'name':'data_sm'},
'data_sm_resp' :{'hex':'80000103', 'name':'data_sm_resp'},
# v4 codes
'generic_nack_v4' :{'hex':'80010000', 'name':'generic_nack_v4'},
'bind_receiver_v4' :{'hex':'00010001', 'name':'bind_receiver_v4'},
'bind_receiver_resp_v4' :{'hex':'80010001', 'name':'bind_receiver_resp_v4'},
'bind_transmitter_v4' :{'hex':'00010002', 'name':'bind_transmitter_v4'},
'bind_transmitter_resp_v4':{'hex':'80010002', 'name':'bind_transmitter_resp_v4'},
'query_sm_v4' :{'hex':'00010003', 'name':'query_sm_v4'},
'query_sm_resp_v4' :{'hex':'80010003', 'name':'query_sm_resp_v4'},
'submit_sm_v4' :{'hex':'00010004', 'name':'submit_sm_v4'},
'submit_sm_resp_v4' :{'hex':'80010004', 'name':'submit_sm_resp_v4'},
'deliver_sm_v4' :{'hex':'00010005', 'name':'deliver_sm_v4'},
'deliver_sm_resp_v4' :{'hex':'80010005', 'name':'deliver_sm_resp_v4'},
'unbind_v4' :{'hex':'00010006', 'name':'unbind_v4'},
'unbind_resp_v4' :{'hex':'80010006', 'name':'unbind_resp_v4'},
'replace_sm_v4' :{'hex':'00010007', 'name':'replace_sm_v4'},
'replace_sm_resp_v4' :{'hex':'80010007', 'name':'replace_sm_resp_v4'},
'cancel_sm_v4' :{'hex':'00010008', 'name':'cancel_sm_v4'},
'cancel_sm_resp_v4' :{'hex':'80010008', 'name':'cancel_sm_resp_v4'},
'delivery_receipt_v4' :{'hex':'00010009', 'name':'delivery_receipt_v4'},
'delivery_receipt_resp_v4':{'hex':'80010009', 'name':'delivery_receipt_resp_v4'},
'enquire_link_v4' :{'hex':'0001000a', 'name':'enquire_link_v4'},
'enquire_link_resp_v4' :{'hex':'8001000a', 'name':'enquire_link_resp_v4'},
'outbind_v4' :{'hex':'0001000b', 'name':'outbind_v4'}
}
def command_id_hex_by_name(n):
return command_id_by_name.get(n,{}).get('hex')
# SMPP Error Codes (ESME) - SMPP v3.4, section 5.1.3, table 5-2, page 112-114
command_status_by_hex = {
'00000000':{'hex':'00000000', 'name':'ESME_ROK', 'description':'No error'},
'00000001':{'hex':'00000001', 'name':'ESME_RINVMSGLEN', 'description':'Message Length is invalid'},
'00000002':{'hex':'00000002', 'name':'ESME_RINVCMDLEN', 'description':'Command Length is invalid'},
'00000003':{'hex':'00000003', 'name':'ESME_RINVCMDID', 'description':'Invalid Command ID'},
'00000004':{'hex':'00000004', 'name':'ESME_RINVBNDSTS', 'description':'Incorrect BIND Status for given command'},
'00000005':{'hex':'00000005', 'name':'ESME_RALYBND', 'description':'ESME Already in bound state'},
'00000006':{'hex':'00000006', 'name':'ESME_RINVPRTFLG', 'description':'Invalid priority flag'},
'00000007':{'hex':'00000007', 'name':'ESME_RINVREGDLVFLG', 'description':'Invalid registered delivery flag'},
'00000008':{'hex':'00000008', 'name':'ESME_RSYSERR', 'description':'System Error'},
'0000000a':{'hex':'0000000a', 'name':'ESME_RINVSRCADR', 'description':'Invalid source address'},
'0000000b':{'hex':'0000000b', 'name':'ESME_RINVDSTADR', 'description':'Invalid destination address'},
'0000000c':{'hex':'0000000c', 'name':'ESME_RINVMSGID', 'description':'Message ID is invalid'},
'0000000d':{'hex':'0000000d', 'name':'ESME_RBINDFAIL', 'description':'Bind failed'},
'0000000e':{'hex':'0000000e', 'name':'ESME_RINVPASWD', 'description':'Invalid password'},
'0000000f':{'hex':'0000000f', 'name':'ESME_RINVSYSID', 'description':'Invalid System ID'},
'00000011':{'hex':'00000011', 'name':'ESME_RCANCELFAIL', 'description':'Cancel SM Failed'},
'00000013':{'hex':'00000013', 'name':'ESME_RREPLACEFAIL', 'description':'Replace SM Failed'},
'00000014':{'hex':'00000014', 'name':'ESME_RMSGQFUL', 'description':'Message queue full'},
'00000015':{'hex':'00000015', 'name':'ESME_RINVSERTYP', 'description':'Invalid service type'},
'00000033':{'hex':'00000033', 'name':'ESME_RINVNUMDESTS', 'description':'Invalid number of destinations'},
'00000034':{'hex':'00000034', 'name':'ESME_RINVDLNAME', 'description':'Invalid distribution list name'},
'00000040':{'hex':'00000040', 'name':'ESME_RINVDESTFLAG', 'description':'Destination flag is invalid (submit_multi)'},
'00000042':{'hex':'00000042', 'name':'ESME_RINVSUBREP', 'description':"Invalid `submit with replace' request (i.e. submit_sm with replace_if_present_flag set)"},
'00000043':{'hex':'00000043', 'name':'ESME_RINVESMCLASS', 'description':'Invalid esm_class field data'},
'00000044':{'hex':'00000044', 'name':'ESME_RCNTSUBDL', 'description':'Cannot submit to distribution list'},
'00000045':{'hex':'00000045', 'name':'ESME_RSUBMITFAIL', 'description':'submit_sm or submit_multi failed'},
'00000048':{'hex':'00000048', 'name':'ESME_RINVSRCTON', 'description':'Invalid source address TON'},
'00000049':{'hex':'00000049', 'name':'ESME_RINVSRCNPI', 'description':'Invalid source address NPI'},
'00000050':{'hex':'00000050', 'name':'ESME_RINVDSTTON', 'description':'Invalid destination address TON'},
'00000051':{'hex':'00000051', 'name':'ESME_RINVDSTNPI', 'description':'Invalid destination address NPI'},
'00000053':{'hex':'00000053', 'name':'ESME_RINVSYSTYP', 'description':'Invalid system_type field'},
'00000054':{'hex':'00000054', 'name':'ESME_RINVREPFLAG', 'description':'Invalid replace_if_present flag'},
'00000055':{'hex':'00000055', 'name':'ESME_RINVNUMMSGS', 'description':'Invalid number of messages'},
'00000058':{'hex':'00000058', 'name':'ESME_RTHROTTLED', 'description':'Throttling error (ESME has exceeded allowed message limits)'},
'00000061':{'hex':'00000061', 'name':'ESME_RINVSCHED', 'description':'Invalid scheduled delivery time'},
'00000062':{'hex':'00000062', 'name':'ESME_RINVEXPIRY', 'description':'Invalid message validity period (expiry time)'},
'00000063':{'hex':'00000063', 'name':'ESME_RINVDFTMSGID', 'description':'Predefined message invalid or not found'},
'00000064':{'hex':'00000064', 'name':'ESME_RX_T_APPN', 'description':'ESME Receiver Temporary App Error Code'},
'00000065':{'hex':'00000065', 'name':'ESME_RX_P_APPN', 'description':'ESME Receiver Permanent App Error Code'},
'00000066':{'hex':'00000066', 'name':'ESME_RX_R_APPN', 'description':'ESME Receiver Reject Message Error Code'},
'00000067':{'hex':'00000067', 'name':'ESME_RQUERYFAIL', 'description':'query_sm request failed'},
'000000c0':{'hex':'000000c0', 'name':'ESME_RINVOPTPARSTREAM', 'description':'Error in the optional part of the PDU Body'},
'000000c1':{'hex':'000000c1', 'name':'ESME_ROPTPARNOTALLWD', 'description':'Optional paramenter not allowed'},
'000000c2':{'hex':'000000c2', 'name':'ESME_RINVPARLEN', 'description':'Invalid parameter length'},
'000000c3':{'hex':'000000c3', 'name':'ESME_RMISSINGOPTPARAM', 'description':'Expected optional parameter missing'},
'000000c4':{'hex':'000000c4', 'name':'ESME_RINVOPTPARAMVAL', 'description':'Invalid optional parameter value'},
'000000fe':{'hex':'000000fe', 'name':'ESME_RDELIVERYFAILURE', 'description':'Delivery Failure (used for data_sm_resp)'},
'000000ff':{'hex':'000000ff', 'name':'ESME_RUNKNOWNERR', 'description':'Unknown error'}
}
def command_status_name_by_hex(x):
return command_status_by_hex.get(x,{}).get('name')
command_status_by_name = {
'ESME_ROK' :{'hex':'00000000', 'name':'ESME_ROK', 'description':'No error'},
'ESME_RINVMSGLEN' :{'hex':'00000001', 'name':'ESME_RINVMSGLEN', 'description':'Message Length is invalid'},
'ESME_RINVCMDLEN' :{'hex':'00000002', 'name':'ESME_RINVCMDLEN', 'description':'Command Length is invalid'},
'ESME_RINVCMDID' :{'hex':'00000003', 'name':'ESME_RINVCMDID', 'description':'Invalid Command ID'},
'ESME_RINVBNDSTS' :{'hex':'00000004', 'name':'ESME_RINVBNDSTS', 'description':'Incorrect BIND Status for given command'},
'ESME_RALYBND' :{'hex':'00000005', 'name':'ESME_RALYBND', 'description':'ESME Already in bound state'},
'ESME_RINVPRTFLG' :{'hex':'00000006', 'name':'ESME_RINVPRTFLG', 'description':'Invalid priority flag'},
'ESME_RINVREGDLVFLG' :{'hex':'00000007', 'name':'ESME_RINVREGDLVFLG', 'description':'Invalid registered delivery flag'},
'ESME_RSYSERR' :{'hex':'00000008', 'name':'ESME_RSYSERR', 'description':'System Error'},
'ESME_RINVSRCADR' :{'hex':'0000000a', 'name':'ESME_RINVSRCADR', 'description':'Invalid source address'},
'ESME_RINVDSTADR' :{'hex':'0000000b', 'name':'ESME_RINVDSTADR', 'description':'Invalid destination address'},
'ESME_RINVMSGID' :{'hex':'0000000c', 'name':'ESME_RINVMSGID', 'description':'Message ID is invalid'},
'ESME_RBINDFAIL' :{'hex':'0000000d', 'name':'ESME_RBINDFAIL', 'description':'Bind failed'},
'ESME_RINVPASWD' :{'hex':'0000000e', 'name':'ESME_RINVPASWD', 'description':'Invalid password'},
'ESME_RINVSYSID' :{'hex':'0000000f', 'name':'ESME_RINVSYSID', 'description':'Invalid System ID'},
'ESME_RCANCELFAIL' :{'hex':'00000011', 'name':'ESME_RCANCELFAIL', 'description':'Cancel SM Failed'},
'ESME_RREPLACEFAIL' :{'hex':'00000013', 'name':'ESME_RREPLACEFAIL', 'description':'Replace SM Failed'},
'ESME_RMSGQFUL' :{'hex':'00000014', 'name':'ESME_RMSGQFUL', 'description':'Message queue full'},
'ESME_RINVSERTYP' :{'hex':'00000015', 'name':'ESME_RINVSERTYP', 'description':'Invalid service type'},
'ESME_RINVNUMDESTS' :{'hex':'00000033', 'name':'ESME_RINVNUMDESTS', 'description':'Invalid number of destinations'},
'ESME_RINVDLNAME' :{'hex':'00000034', 'name':'ESME_RINVDLNAME', 'description':'Invalid distribution list name'},
'ESME_RINVDESTFLAG' :{'hex':'00000040', 'name':'ESME_RINVDESTFLAG', 'description':'Destination flag is invalid (submit_multi)'},
'ESME_RINVSUBREP' :{'hex':'00000042', 'name':'ESME_RINVSUBREP', 'description':"Invalid `submit with replace' request (i.e. submit_sm with replace_if_present_flag set)"},
'ESME_RINVESMCLASS' :{'hex':'00000043', 'name':'ESME_RINVESMCLASS', 'description':'Invalid esm_class field data'},
'ESME_RCNTSUBDL' :{'hex':'00000044', 'name':'ESME_RCNTSUBDL', 'description':'Cannot submit to distribution list'},
'ESME_RSUBMITFAIL' :{'hex':'00000045', 'name':'ESME_RSUBMITFAIL', 'description':'submit_sm or submit_multi failed'},
'ESME_RINVSRCTON' :{'hex':'00000048', 'name':'ESME_RINVSRCTON', 'description':'Invalid source address TON'},
'ESME_RINVSRCNPI' :{'hex':'00000049', 'name':'ESME_RINVSRCNPI', 'description':'Invalid source address NPI'},
'ESME_RINVDSTTON' :{'hex':'00000050', 'name':'ESME_RINVDSTTON', 'description':'Invalid destination address TON'},
'ESME_RINVDSTNPI' :{'hex':'00000051', 'name':'ESME_RINVDSTNPI', 'description':'Invalid destination address NPI'},
'ESME_RINVSYSTYP' :{'hex':'00000053', 'name':'ESME_RINVSYSTYP', 'description':'Invalid system_type field'},
'ESME_RINVREPFLAG' :{'hex':'00000054', 'name':'ESME_RINVREPFLAG', 'description':'Invalid replace_if_present flag'},
'ESME_RINVNUMMSGS' :{'hex':'00000055', 'name':'ESME_RINVNUMMSGS', 'description':'Invalid number of messages'},
'ESME_RTHROTTLED' :{'hex':'00000058', 'name':'ESME_RTHROTTLED', 'description':'Throttling error (ESME has exceeded allowed message limits)'},
'ESME_RINVSCHED' :{'hex':'00000061', 'name':'ESME_RINVSCHED', 'description':'Invalid scheduled delivery time'},
'ESME_RINVEXPIRY' :{'hex':'00000062', 'name':'ESME_RINVEXPIRY', 'description':'Invalid message validity period (expiry time)'},
'ESME_RINVDFTMSGID' :{'hex':'00000063', 'name':'ESME_RINVDFTMSGID', 'description':'Predefined message invalid or not found'},
'ESME_RX_T_APPN' :{'hex':'00000064', 'name':'ESME_RX_T_APPN', 'description':'ESME Receiver Temporary App Error Code'},
'ESME_RX_P_APPN' :{'hex':'00000065', 'name':'ESME_RX_P_APPN', 'description':'ESME Receiver Permanent App Error Code'},
'ESME_RX_R_APPN' :{'hex':'00000066', 'name':'ESME_RX_R_APPN', 'description':'ESME Receiver Reject Message Error Code'},
'ESME_RQUERYFAIL' :{'hex':'00000067', 'name':'ESME_RQUERYFAIL', 'description':'query_sm request failed'},
'ESME_RINVOPTPARSTREAM':{'hex':'000000c0', 'name':'ESME_RINVOPTPARSTREAM', 'description':'Error in the optional part of the PDU Body'},
'ESME_ROPTPARNOTALLWD' :{'hex':'000000c1', 'name':'ESME_ROPTPARNOTALLWD', 'description':'Optional paramenter not allowed'},
'ESME_RINVPARLEN' :{'hex':'000000c2', 'name':'ESME_RINVPARLEN', 'description':'Invalid parameter length'},
'ESME_RMISSINGOPTPARAM':{'hex':'000000c3', 'name':'ESME_RMISSINGOPTPARAM', 'description':'Expected optional parameter missing'},
'ESME_RINVOPTPARAMVAL' :{'hex':'000000c4', 'name':'ESME_RINVOPTPARAMVAL', 'description':'Invalid optional parameter value'},
'ESME_RDELIVERYFAILURE':{'hex':'000000fe', 'name':'ESME_RDELIVERYFAILURE', 'description':'Delivery Failure (used for data_sm_resp)'},
'ESME_RUNKNOWNERR' :{'hex':'000000ff', 'name':'ESME_RUNKNOWNERR', 'description':'Unknown error'}
}
def command_status_hex_by_name(n):
return command_status_by_name.get(n,{}).get('hex')
# Type of Number (TON) - SMPP v3.4, section 5.2.5, table 5-3, page 117
maps['addr_ton_by_name'] = {
'unknown' :'00',
'international' :'01',
'national' :'02',
'network_specific' :'03',
'subscriber_number':'04',
'alphanumeric' :'05',
'abbreviated' :'06'
}
maps['addr_ton_by_hex'] = {
'00':'unknown',
'01':'international',
'02':'national',
'03':'network_specific',
'04':'subscriber_number',
'05':'alphanumeric',
'06':'abbreviated'
}
# Numberic Plan Indicator (NPI) - SMPP v3.4, section 5.2.6, table 5-4, page 118
maps['addr_npi_by_name'] = {
'unknown' :'00',
'ISDN' :'01',
'data' :'03',
'telex' :'04',
'land_mobile':'06',
'national' :'08',
'private' :'09',
'ERMES' :'0a',
'internet' :'0e',
'WAP' :'12'
}
maps['addr_npi_by_hex'] = {
'00':'unknown',
'01':'ISDN',
'03':'data',
'04':'telex',
'06':'land_mobile',
'08':'national',
'09':'private',
'0a':'ERMES',
'0e':'internet',
'12':'WAP'
}
# ESM Class bits - SMPP v3.4, section 5.2.12, page 121
maps['esm_class_bits'] = {
'mode_mask' :'03',
'type_mask' :'3c',
'feature_mask' :'c0',
'mode_default' :'00',
'mode_datagram' :'01',
'mode_forward' :'02',
'mode_store_and_forward' :'03',
'type_default' :'00',
'type_delivery_receipt' :'04',
'type_delivery_ack' :'08',
'type_0011' :'0a',
'type_user_ack' :'10',
'type_0101' :'14',
'type_conversation_abort' :'18',
'type_0111' :'1a',
'type_intermed_deliv_notif' :'20',
'type_1001' :'24',
'type_1010' :'28',
'type_1011' :'2a',
'type_1100' :'30',
'type_1101' :'34',
'type_1110' :'38',
'type_1111' :'3a',
'feature_none' :'00',
'feature_UDHI' :'40',
'feature_reply_path' :'80',
'feature_UDHI_and_reply_path':'c0'
}
# Registered Delivery bits - SMPP v3.4, section 5.2.17, page 124
maps['registered_delivery_bits'] = {
'receipt_mask' :'03',
'ack_mask' :'0c',
'intermed_notif_mask' :'80',
'receipt_none' :'00',
'receipt_always' :'01',
'receipt_on_fail' :'02',
'receipt_res' :'03',
'ack_none' :'00',
'ack_delivery' :'04',
'ack_user' :'08',
'ack_delivery_and_user':'0c',
'intermed_notif_none' :'00',
'intermed_notif' :'10'
}
# submit_multi dest_flag constants - SMPP v3.4, section 5.2.25, page 129
maps['dest_flag_by_name'] = {
'SME_Address':1,
'dist_list' :2
}
# Message State codes returned in query_sm_resp PDUs - SMPP v3.4, section 5.2.28, table 5-6, page 130
maps['message_state_by_name'] = {
'ENROUTE' :1,
'DELIVERED' :2,
'EXPIRED' :3,
'DELETED' :4,
'UNDELIVERABLE':5,
'ACCEPTED' :6,
'UNKNOWN' :7,
'REJECTED' :8
}
# Facility Code bits for SMPP v4
maps['facility_code_bits'] = {
'GF_PVCY' :'00000001',
'GF_SUBADDR':'00000002',
'NF_CC' :'00080000',
'NF_PDC' :'00010000',
'NF_IS136' :'00020000',
'NF_IS95A' :'00040000'
}
# Optional Parameter Tags - SMPP v3.4, section 5.3.2, Table 5-7, page 132-133
optional_parameter_tag_by_hex = {
'0005':{'hex':'0005', 'name':'dest_addr_subunit', 'technology':'GSM'},
'0006':{'hex':'0006', 'name':'dest_network_type', 'technology':'Generic'},
'0007':{'hex':'0007', 'name':'dest_bearer_type', 'technology':'Generic'},
'0008':{'hex':'0008', 'name':'dest_telematics_id', 'technology':'GSM'},
'000d':{'hex':'000d', 'name':'source_addr_subunit', 'technology':'GSM'},
'000e':{'hex':'000e', 'name':'source_network_type', 'technology':'Generic'},
'000f':{'hex':'000f', 'name':'source_bearer_type', 'technology':'Generic'},
'0010':{'hex':'0010', 'name':'source_telematics_id', 'technology':'GSM'},
'0017':{'hex':'0017', 'name':'qos_time_to_live', 'technology':'Generic'},
'0019':{'hex':'0019', 'name':'payload_type', 'technology':'Generic'},
'001d':{'hex':'001d', 'name':'additional_status_info_text', 'technology':'Generic'},
'001e':{'hex':'001e', 'name':'receipted_message_id', 'technology':'Generic'},
'0030':{'hex':'0030', 'name':'ms_msg_wait_facilities', 'technology':'GSM'},
'0101':{'hex':'0101', 'name':'PVCY_AuthenticationStr', 'technology':'? (J-Phone)'}, # v4 page 58-62
'0201':{'hex':'0201', 'name':'privacy_indicator', 'technology':'CDMA,TDMA'},
'0202':{'hex':'0202', 'name':'source_subaddress', 'technology':'CDMA,TDMA'}, # v4 page 65-67
'0203':{'hex':'0203', 'name':'dest_subaddress', 'technology':'CDMA,TDMA'}, # v4 page 65-67
'0204':{'hex':'0204', 'name':'user_message_reference', 'technology':'Generic'},
'0205':{'hex':'0205', 'name':'user_response_code', 'technology':'CDMA,TDMA'},
'020a':{'hex':'020a', 'name':'source_port', 'technology':'WAP'},
'020b':{'hex':'020b', 'name':'destination_port', 'technology':'WAP'},
'020c':{'hex':'020c', 'name':'sar_msg_ref_num', 'technology':'Generic'},
'020d':{'hex':'020d', 'name':'language_indicator', 'technology':'CDMA,TDMA'},
'020e':{'hex':'020e', 'name':'sar_total_segments', 'technology':'Generic'},
'020f':{'hex':'020f', 'name':'sar_segment_seqnum', 'technology':'Generic'},
'0210':{'hex':'0210', 'name':'sc_interface_version', 'technology':'Generic'},
'0301':{'hex':'0301', 'name':'CC_CBN', 'technology':'V4'}, # v4 page 70
'0302':{'hex':'0302', 'name':'callback_num_pres_ind', 'technology':'TDMA'}, # v4 page 71
'0303':{'hex':'0303', 'name':'callback_num_atag', 'technology':'TDMA'}, # v4 page 71
'0304':{'hex':'0304', 'name':'number_of_messages', 'technology':'CDMA'}, # v4 page 72
'0381':{'hex':'0381', 'name':'callback_num', 'technology':'CDMA,TDMA,GSM,iDEN'},
'0420':{'hex':'0420', 'name':'dpf_result', 'technology':'Generic'},
'0421':{'hex':'0421', 'name':'set_dpf', 'technology':'Generic'},
'0422':{'hex':'0422', 'name':'ms_availability_status', 'technology':'Generic'},
'0423':{'hex':'0423', 'name':'network_error_code', 'technology':'Generic'},
'0424':{'hex':'0424', 'name':'message_payload', 'technology':'Generic'},
'0425':{'hex':'0425', 'name':'delivery_failure_reason', 'technology':'Generic'},
'0426':{'hex':'0426', 'name':'more_messages_to_send', 'technology':'GSM'},
'0427':{'hex':'0427', 'name':'message_state', 'technology':'Generic'},
'0428':{'hex':'0428', 'name':'congestion_state', 'technology':'Generic'},
'0501':{'hex':'0501', 'name':'ussd_service_op', 'technology':'GSM (USSD)'},
'0600':{'hex':'0600', 'name':'broadcast_channel_indicator', 'technology':'GSM'},
'0601':{'hex':'0601', 'name':'broadcast_content_type', 'technology':'CDMA, TDMA, GSM'},
'0602':{'hex':'0602', 'name':'broadcast_content_type_info', 'technology':'CDMA, TDMA'},
'0603':{'hex':'0603', 'name':'broadcast_message_class', 'technology':'GSM'},
'0604':{'hex':'0604', 'name':'broadcast_rep_num', 'technology':'GSM'},
'0605':{'hex':'0605', 'name':'broadcast_frequency_interval', 'technology':'CDMA, TDMA, GSM'},
'0606':{'hex':'0606', 'name':'broadcast_area_identifier', 'technology':'CDMA, TDMA, GSM'},
'0607':{'hex':'0607', 'name':'broadcast_error_status', 'technology':'CDMA, TDMA, GSM'},
'0608':{'hex':'0608', 'name':'broadcast_area_success', 'technology':'GSM'},
'0609':{'hex':'0609', 'name':'broadcast_end_time', 'technology':'CDMA, TDMA, GSM'},
'060a':{'hex':'060a', 'name':'broadcast_service_group', 'technology':'CDMA, TDMA'},
'060b':{'hex':'060b', 'name':'billing_identification', 'technology':'Generic'},
'060d':{'hex':'060d', 'name':'source_network_id', 'technology':'Generic'},
'060e':{'hex':'060e', 'name':'dest_network_id', 'technology':'Generic'},
'060f':{'hex':'060f', 'name':'source_node_id', 'technology':'Generic'},
'0610':{'hex':'0610', 'name':'dest_node_id', 'technology':'Generic'},
'0611':{'hex':'0611', 'name':'dest_addr_np_resolution', 'technology':'CDMA, TDMA (US Only)'},
'0612':{'hex':'0612', 'name':'dest_addr_np_information', 'technology':'CDMA, TDMA (US Only)'},
'0613':{'hex':'0613', 'name':'dest_addr_np_country', 'technology':'CDMA, TDMA (US Only)'},
'1201':{'hex':'1201', 'name':'display_time', 'technology':'CDMA,TDMA'},
'1203':{'hex':'1203', 'name':'sms_signal', 'technology':'TDMA'},
'1204':{'hex':'1204', 'name':'ms_validity', 'technology':'CDMA,TDMA'},
'1304':{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'technology':'CDMA'}, # v4 page 85
'1306':{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'technology':'CDMA'}, # v4 page 86
'130c':{'hex':'130c', 'name':'alert_on_message_delivery', 'technology':'CDMA'},
'1380':{'hex':'1380', 'name':'its_reply_type', 'technology':'CDMA'},
'1383':{'hex':'1383', 'name':'its_session_info', 'technology':'CDMA Korean [KORITS]'},
'1402':{'hex':'1402', 'name':'operator_id', 'technology':'vendor extension'},
'1403':{'hex':'1403', 'name':'tariff', 'technology':'Mobile Network Code vendor extension'},
'1450':{'hex':'1450', 'name':'mcc', 'technology':'Mobile Country Code vendor extension'},
'1451':{'hex':'1451', 'name':'mnc', 'technology':'Mobile Network Code vendor extension'},
'1101':{'hex':'1101', 'name':'PDC_MessageClass', 'technology':'? (J-Phone)'}, # v4 page 75
'1102':{'hex':'1102', 'name':'PDC_PresentationOption', 'technology':'? (J-Phone)'}, # v4 page 76
'1103':{'hex':'1103', 'name':'PDC_AlertMechanism', 'technology':'? (J-Phone)'}, # v4 page 76
'1104':{'hex':'1104', 'name':'PDC_Teleservice', 'technology':'? (J-Phone)'}, # v4 page 77
'1105':{'hex':'1105', 'name':'PDC_MultiPartMessage', 'technology':'? (J-Phone)'}, # v4 page 77
'1106':{'hex':'1106', 'name':'PDC_PredefinedMsg', 'technology':'? (J-Phone)'} # v4 page 78
}
def optional_parameter_tag_name_by_hex(x):
return optional_parameter_tag_by_hex.get(x,{}).get('name')
optional_parameter_tag_by_name = {
'dest_addr_subunit' :{'hex':'0005', 'name':'dest_addr_subunit', 'technology':'GSM'},
'dest_network_type' :{'hex':'0006', 'name':'dest_network_type', 'technology':'Generic'},
'dest_bearer_type' :{'hex':'0007', 'name':'dest_bearer_type', 'technology':'Generic'},
'dest_telematics_id' :{'hex':'0008', 'name':'dest_telematics_id', 'technology':'GSM'},
'source_addr_subunit' :{'hex':'000d', 'name':'source_addr_subunit', 'technology':'GSM'},
'source_network_type' :{'hex':'000e', 'name':'source_network_type', 'technology':'Generic'},
'source_bearer_type' :{'hex':'000f', 'name':'source_bearer_type', 'technology':'Generic'},
'source_telematics_id' :{'hex':'0010', 'name':'source_telematics_id', 'technology':'GSM'},
'qos_time_to_live' :{'hex':'0017', 'name':'qos_time_to_live', 'technology':'Generic'},
'payload_type' :{'hex':'0019', 'name':'payload_type', 'technology':'Generic'},
'additional_status_info_text' :{'hex':'001d', 'name':'additional_status_info_text', 'technology':'Generic'},
'receipted_message_id' :{'hex':'001e', 'name':'receipted_message_id', 'technology':'Generic'},
'ms_msg_wait_facilities' :{'hex':'0030', 'name':'ms_msg_wait_facilities', 'technology':'GSM'},
'PVCY_AuthenticationStr' :{'hex':'0101', 'name':'PVCY_AuthenticationStr', 'technology':'? (J-Phone)'}, # v4 page 58-62
'privacy_indicator' :{'hex':'0201', 'name':'privacy_indicator', 'technology':'CDMA,TDMA'},
'source_subaddress' :{'hex':'0202', 'name':'source_subaddress', 'technology':'CDMA,TDMA'}, # v4 page 65-67
'dest_subaddress' :{'hex':'0203', 'name':'dest_subaddress', 'technology':'CDMA,TDMA'}, # v4 page 65-67
'user_message_reference' :{'hex':'0204', 'name':'user_message_reference', 'technology':'Generic'},
'user_response_code' :{'hex':'0205', 'name':'user_response_code', 'technology':'CDMA,TDMA'},
'source_port' :{'hex':'020a', 'name':'source_port', 'technology':'WAP'},
'destination_port' :{'hex':'020b', 'name':'destination_port', 'technology':'WAP'},
'sar_msg_ref_num' :{'hex':'020c', 'name':'sar_msg_ref_num', 'technology':'Generic'},
'language_indicator' :{'hex':'020d', 'name':'language_indicator', 'technology':'CDMA,TDMA'},
'sar_total_segments' :{'hex':'020e', 'name':'sar_total_segments', 'technology':'Generic'},
'sar_segment_seqnum' :{'hex':'020f', 'name':'sar_segment_seqnum', 'technology':'Generic'},
'sc_interface_version' :{'hex':'0210', 'name':'sc_interface_version', 'technology':'Generic'},
'CC_CBN' :{'hex':'0301', 'name':'CC_CBN', 'technology':'V4'}, # v4 page 70
'callback_num_pres_ind' :{'hex':'0302', 'name':'callback_num_pres_ind', 'technology':'TDMA'}, # v4 page 71
'callback_num_atag' :{'hex':'0303', 'name':'callback_num_atag', 'technology':'TDMA'}, # v4 page 71
'number_of_messages' :{'hex':'0304', 'name':'number_of_messages', 'technology':'CDMA'}, # v4 page 72
'callback_num' :{'hex':'0381', 'name':'callback_num', 'technology':'CDMA,TDMA,GSM,iDEN'},
'dpf_result' :{'hex':'0420', 'name':'dpf_result', 'technology':'Generic'},
'set_dpf' :{'hex':'0421', 'name':'set_dpf', 'technology':'Generic'},
'ms_availability_status' :{'hex':'0422', 'name':'ms_availability_status', 'technology':'Generic'},
'network_error_code' :{'hex':'0423', 'name':'network_error_code', 'technology':'Generic'},
'message_payload' :{'hex':'0424', 'name':'message_payload', 'technology':'Generic'},
'delivery_failure_reason' :{'hex':'0425', 'name':'delivery_failure_reason', 'technology':'Generic'},
'more_messages_to_send' :{'hex':'0426', 'name':'more_messages_to_send', 'technology':'GSM'},
'message_state' :{'hex':'0427', 'name':'message_state', 'technology':'Generic'},
'congestion_state' :{'hex':'0428', 'name':'congestion_state', 'technology':'Generic'},
'ussd_service_op' :{'hex':'0501', 'name':'ussd_service_op', 'technology':'GSM (USSD)'},
'broadcast_channel_indicator' :{'hex':'0600', 'name':'broadcast_channel_indicator', 'technology':'GSM'},
'broadcast_content_type' :{'hex':'0601', 'name':'broadcast_content_type', 'technology':'CDMA, TDMA, GSM'},
'broadcast_content_type_info' :{'hex':'0602', 'name':'broadcast_content_type_info', 'technology':'CDMA, TDMA'},
'broadcast_message_class' :{'hex':'0603', 'name':'broadcast_message_class', 'technology':'GSM'},
'broadcast_rep_num' :{'hex':'0604', 'name':'broadcast_rep_num', 'technology':'GSM'},
'broadcast_frequency_interval':{'hex':'0605', 'name':'broadcast_frequency_interval', 'technology':'CDMA, TDMA, GSM'},
'broadcast_area_identifier' :{'hex':'0606', 'name':'broadcast_area_identifier', 'technology':'CDMA, TDMA, GSM'},
'broadcast_error_status' :{'hex':'0607', 'name':'broadcast_error_status', 'technology':'CDMA, TDMA, GSM'},
'broadcast_area_success' :{'hex':'0608', 'name':'broadcast_area_success', 'technology':'GSM'},
'broadcast_end_time' :{'hex':'0609', 'name':'broadcast_end_time', 'technology':'CDMA, TDMA, GSM'},
'broadcast_service_group' :{'hex':'060a', 'name':'broadcast_service_group', 'technology':'CDMA, TDMA'},
'billing_identification' :{'hex':'060b', 'name':'billing_identification', 'technology':'Generic'},
'source_network_id' :{'hex':'060d', 'name':'source_network_id', 'technology':'Generic'},
'dest_network_id' :{'hex':'060e', 'name':'dest_network_id', 'technology':'Generic'},
'source_node_id' :{'hex':'060f', 'name':'source_node_id', 'technology':'Generic'},
'dest_node_id' :{'hex':'0610', 'name':'dest_node_id', 'technology':'Generic'},
'dest_addr_np_resolution' :{'hex':'0611', 'name':'dest_addr_np_resolution', 'technology':'CDMA, TDMA (US Only)'},
'dest_addr_np_information' :{'hex':'0612', 'name':'dest_addr_np_information', 'technology':'CDMA, TDMA (US Only)'},
'dest_addr_np_country' :{'hex':'0613', 'name':'dest_addr_np_country', 'technology':'CDMA, TDMA (US Only)'},
'display_time' :{'hex':'1201', 'name':'display_time', 'technology':'CDMA,TDMA'},
'sms_signal' :{'hex':'1203', 'name':'sms_signal', 'technology':'TDMA'},
'ms_validity' :{'hex':'1204', 'name':'ms_validity', 'technology':'CDMA,TDMA'},
'IS95A_AlertOnDelivery' :{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'technology':'CDMA'}, # v4 page 85
'IS95A_LanguageIndicator' :{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'technology':'CDMA'}, # v4 page 86
'alert_on_message_delivery' :{'hex':'130c', 'name':'alert_on_message_delivery', 'technology':'CDMA'},
'its_reply_type' :{'hex':'1380', 'name':'its_reply_type', 'technology':'CDMA'},
'its_session_info' :{'hex':'1383', 'name':'its_session_info', 'technology':'CDMA Korean [KORITS]'},
'operator_id' :{'hex':'1402', 'name':'operator_id', 'technology':'vendor extension'},
'tariff' :{'hex':'1403', 'name':'tariff', 'technology':'Mobile Network Code vendor extension'},
'mcc' :{'hex':'1450', 'name':'mcc', 'technology':'Mobile Country Code vendor extension'},
'mnc' :{'hex':'1451', 'name':'mnc', 'technology':'Mobile Network Code vendor extension'},
'PDC_MessageClass' :{'hex':'1101', 'name':'PDC_MessageClass', 'technology':'? (J-Phone)'}, # v4 page 75
'PDC_PresentationOption' :{'hex':'1102', 'name':'PDC_PresentationOption', 'technology':'? (J-Phone)'}, # v4 page 76
'PDC_AlertMechanism' :{'hex':'1103', 'name':'PDC_AlertMechanism', 'technology':'? (J-Phone)'}, # v4 page 76
'PDC_Teleservice' :{'hex':'1104', 'name':'PDC_Teleservice', 'technology':'? (J-Phone)'}, # v4 page 77
'PDC_MultiPartMessage' :{'hex':'1105', 'name':'PDC_MultiPartMessage', 'technology':'? (J-Phone)'}, # v4 page 77
'PDC_PredefinedMsg' :{'hex':'1106', 'name':'PDC_PredefinedMsg', 'technology':'? (J-Phone)'} # v4 page 78
}
def optional_parameter_tag_hex_by_name(n):
return optional_parameter_tag_by_name.get(n,{}).get('hex')
def octpop(hex_ref):
octet = None
if len(hex_ref[0]) > 1:
(octet, hex_ref[0]) = (hex_ref[0][0:2], hex_ref[0][2: ])
return octet
-def decode_hex_type(data, hex_type, hex_ref=['']):
- if hex_type == 'integer':
+def decode_hex_type(data, type, count=0, hex_ref=['']):
+ if type == 'integer':
return int(data, 16)
- elif hex_type == 'string':
+ elif type == 'string':
return binascii.b2a_qp(binascii.a2b_hex(re.sub('00','',data)))
- elif hex_type == 'dest_address':
- return data #TODO need a better function here
- elif hex_type == 'unsuccess_sme':
- return data #TODO need a better function here
+ elif type == 'dest_address' \
+ or type == 'unsuccess_sme':
+ list = []
+ fields = mandatory_parameter_list_by_command_name(type)
+ for i in range(count):
+ (element, hex_ref[0]) = decode_mandatory_parameters(fields, hex_ref)
+ list.append(element)
+ return list
else:
return data
def decode_body(command, body_hex):
body = {}
body['mandatory_parameters'] = None
if command != None:
fields = mandatory_parameter_list_by_command_name(command)
(body['mandatory_parameters'], optional_parameters_hex) = \
decode_mandatory_parameters(fields, [body_hex])
body['optional_parameters'] = decode_optional_parameters(optional_parameters_hex)
return body
def unpack_pdu(pdu_bin):
pdu_hex = binascii.b2a_hex(pdu_bin)
(command_length, command_id, command_status, sequence_number, body_hex) = \
(pdu_hex[0:8], pdu_hex[8:16], pdu_hex[16:24], pdu_hex[24:32], pdu_hex[32: ])
length = int(command_length, 16)
command = command_id_name_by_hex(command_id)
status = command_status_name_by_hex(command_status)
sequence = int(sequence_number, 16)
print '\n--------incoming--------'
print command_length, length
print command_id, command
print command_status, status
print sequence_number, sequence
print body_hex
print pdu_hex
print '------------------------\n'
pdu = {}
pdu['length'] = length
pdu['command'] = command
pdu['status'] = status
pdu['sequence'] = sequence
pdu['body'] = decode_body(command, body_hex)
print pdu
return pdu
def pack_pdu(command='bind_transmitter', status='ESME_ROK', sequence=0, body_hex=''):
length = 16 + len(body_hex)/2
command_length = '%08x' % length
command_id = command_id_hex_by_name(command)
command_status = command_status_hex_by_name(status)
sequence_number = '%08x' % sequence
pdu_hex = command_length + command_id + command_status + sequence_number + body_hex
print '\n--------outgoing--------'
print command_length, length
print command_id, command
print command_status, status
print sequence_number, sequence
print body_hex
print pdu_hex
print '------------------------\n'
return binascii.a2b_hex(pdu_hex)
def decode_mandatory_parameters(fields, hex_ref):
mandatory_parameters = {}
- print "<<<< mand hex >>>", repr(hex_ref[0])
+ print "<<<< mand & opt hex >>>", repr(hex_ref[0])
if len(hex_ref[0]) > 1:
for field in fields:
data = ''
octet = ''
count = 0
- if field['var'] != True and field['var'] != False:
- for i in range(mandatory_parameters[field['var']]):
- if len(hex_ref[0]) > 1:
- data += octpop(hex_ref)
- else:
+ if field['var'] == True or field['var'] == False:
while (len(hex_ref[0]) > 1
and (count < field['min']
or (count < field['max']
and (octet != '00')))):
octet = octpop(hex_ref)
data += octet
count += 1
+ elif field['type'] == 'string':
+ count = mandatory_parameters[field['var']]
+ for i in range(count):
+ if len(hex_ref[0]) > 1:
+ data += octpop(hex_ref)
+ else:
+ count = mandatory_parameters[field['var']]
+ print '>', count, data
if field['hex_map'] != None:
mandatory_parameters[field['name']] = maps.get(field['hex_map'],{data:data})[data]
else:
- mandatory_parameters[field['name']] = decode_hex_type(data, field['type'])
+ mandatory_parameters[field['name']] = decode_hex_type(data, field['type'], count, hex_ref)
return (mandatory_parameters, hex_ref[0])
def encode_mandatory_parameters(fields, json):
mandatory_hex = ''
return mandatory_hex
def decode_optional_parameters(optional_parameters_hex):
optional_parameters = []
data = optional_parameters_hex
while len(data) > 0:
(tag_hex, length_hex, rest) = (data[0:4], data[4:8], data[8: ])
tag = optional_parameter_tag_name_by_hex(tag_hex)
length = int(length_hex, 16)
(value_hex, tail) = (rest[0:length*2], rest[length*2: ])
if len(value_hex) == 0:
value = 0 #TODO remove after testing
else:
value = int(value_hex, 16) #TODO need decoding mapping
data = tail
optional_parameters.append({'tag':tag, 'length':length, 'value':value})
return optional_parameters
def encode_optional_parameter(tag, value):
optional_hex = ''
tag_hex = optional_parameter_tag_hex_by_name(tag)
if tag_hex != None:
value_hex = '%02x' % value #TODO need encoding mapping
length_hex = '%04x' % (len(value_hex)/2)
optional_hex = tag_hex + length_hex + value_hex
return optional_hex
def json_to_pdu(json):
body_hex = ''
body = json.get('body', {})
for opt in body.get('optional_parameters',[]):
body_hex += encode_optional_parameter(opt['tag'], opt['value'])
return pack_pdu(json['command'], json['status'], json['sequence'], body_hex)
|
dmaclay/python-smpp
|
759e7c0be82da9856b30ea3396a37d9e74ed3dad
|
Mappings now ordered by spec page no.
|
diff --git a/smpp/pdu.py b/smpp/pdu.py
index cf231d6..605f92e 100644
--- a/smpp/pdu.py
+++ b/smpp/pdu.py
@@ -1,917 +1,919 @@
import binascii
import re
maps = {} # Inserting certain referenced dicts in here means they can be declared in the same order as in the spec.
+# SMPP PDU Definition - SMPP v3.4, section 4, page 45
+
+mandatory_parameter_lists = {
+ 'bind_transmitter':[ # SMPP v3.4, section 4.1.1, table 4-1, page 46
+ {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None},
+ {'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':'addr_ton_by_hex'},
+ {'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':'addr_npi_by_hex'},
+ {'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'hex_map':None}
+ ],
+ 'bind_transmitter_resp':[ # SMPP v3.4, section 4.1.2, table 4-2, page 47
+ {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None}
+ ],
+ 'bind_receiver':[ # SMPP v3.4, section 4.1.3, table 4-3, page 48
+ {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None},
+ {'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':'addr_ton_by_hex'},
+ {'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':'addr_npi_by_hex'},
+ {'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'hex_map':None}
+ ],
+ 'bind_receiver_resp':[ # SMPP v3.4, section 4.1.4, table 4-4, page 50
+ {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None}
+ ],
+ 'bind_transceiver':[ # SMPP v3.4, section 4.1.5, table 4-5, page 51
+ {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None},
+ {'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':'addr_ton_by_hex'},
+ {'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':'addr_npi_by_hex'},
+ {'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'hex_map':None}
+ ],
+ 'bind_transceiver_resp':[ # SMPP v3.4, section 4.1.6, table 4-6, page 52
+ {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None}
+ ],
+ 'outbind':[ # SMPP v3.4, section 4.1.7.1, page 54
+ {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'hex_map':None}
+ ],
+ 'unbind':[ # SMPP v3.4, section 4.2.1, table 4-7, page 56
+ ],
+ 'unbind_resp':[ # SMPP v3.4, section 4.2.2, table 4-8, page 56
+ ],
+ 'generic_nack':[ # SMPP v3.4, section 4.3.1, table 4-9, page 57
+ ],
+ 'submit_sm':[ # SMPP v3.4, section 4.4.1, table 4-10, page 59-61
+ {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
+ {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
+ {'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
+ {'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
+ {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'hex_map':None}
+ ],
+ 'submit_sm_resp':[ # SMPP v3.4, section 4.4.2, table 4-11, page 67
+ {'name':'message_id', 'min':0, 'max':65, 'var':True, 'type':'string', 'hex_map':None}
+ ],
+ 'submit_multi':[ # SMPP v3.4, section 4.5.1, table 4-12, page 69-71
+ {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
+ {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'number_of_dests', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'dest_address', 'min':2, 'max':24, 'var':True, 'type':'dest_address', 'hex_map':None},
+ {'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
+ {'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
+ {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'hex_map':None}
+ ],
+ 'dest_address':[ # SMPP v3.4, section 4.5.1.1, table 4-13, page 75
+ {'name':'dest_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None}
+ # 'sme_dest_address' or 'distribution_list' goes here
+ ],
+ 'sme_dest_address':[ # SMPP v3.4, section 4.5.1.1, table 4-14, page 75
+ {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
+ {'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None}
+ ],
+ 'distribution_list':[ # SMPP v3.4, section 4.5.1.2, table 4-15, page 75
+ {'name':'dl_name', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None}
+ ],
+ 'submit_multi_resp':[ # SMPP v3.4, section 4.5.2, table 4-16, page 76
+ {'name':'message_id', 'min':0, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'no_unsuccess', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'unsuccess_sme', 'min':7, 'max':27, 'var':True, 'type':'unsuccess_sme', 'hex_map':None}
+ ],
+ 'deliver_sm':[ # SMPP v3.4, section 4.6.1, table 4-18, page 79-81
+ {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
+ {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
+ {'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'schedule_delivery_time', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None},
+ {'name':'validity_period', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None},
+ {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'hex_map':None}
+ ],
+ 'deliver_sm_resp':[ # SMPP v3.4, section 4.6.2, table 4-19, page 85
+ {'name':'message_id', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None}
+ ],
+ 'data_sm':[ # SMPP v3.4, section 4.7.1, table 4-20, page 87-88
+ {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
+ {'name':'source_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
+ {'name':'destination_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None}
+ ],
+ 'data_sm_resp':[ # SMPP v3.4, section 4.7.2, table 4-21, page 93
+ {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None}
+ ],
+ 'query_sm':[ # SMPP v3.4, section 4.8.1, table 4-22, page 95
+ {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
+ {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None}
+ ],
+ 'query_sm_resp':[ # SMPP v3.4, section 4.7.2, table 4-21, page 93
+ {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'final_date', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
+ {'name':'message_state', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'error_code', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None}
+ ],
+ 'cancel_sm':[ # SMPP v3.4, section 4.9.1, table 4-24, page 98-99
+ {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
+ {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
+ {'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None}
+ ],
+ 'cancel_sm_resp':[ # SMPP v3.4, section 4.9.2, table 4-25, page 100
+ ],
+ 'replace_sm':[ # SMPP v3.4, section 4.10.1, table 4-26, page 102-103
+ {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
+ {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
+ {'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
+ {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'hex_map':None}
+ ],
+ 'replace_sm_resp':[ # SMPP v3.4, section 4.10.2, table 4-27, page 104
+ ],
+ 'enquire_link':[ # SMPP v3.4, section 4.11.1, table 4-28, page 106
+ ],
+ 'enquire_link_resp':[ # SMPP v3.4, section 4.11.2, table 4-29, page 106
+ ],
+ 'alert_notification':[ # SMPP v3.4, section 4.12.1, table 4-30, page 108
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
+ {'name':'source_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'esme_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'esme_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
+ {'name':'esme_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
+ ]
+}
+def mandatory_parameter_list_by_command_name(command_name):
+ return mandatory_parameter_lists.get(command_name,[])
+
+
+# Command IDs - SMPP v3.4, section 5.1.2.1, table 5-1, page 110-111
+
+command_id_by_hex = {
+ '80000000':{'hex':'80000000', 'name':'generic_nack'},
+ '00000001':{'hex':'00000001', 'name':'bind_receiver'},
+ '80000001':{'hex':'80000001', 'name':'bind_receiver_resp'},
+ '00000002':{'hex':'00000002', 'name':'bind_transmitter'},
+ '80000002':{'hex':'80000002', 'name':'bind_transmitter_resp'},
+ '00000003':{'hex':'00000003', 'name':'query_sm'},
+ '80000003':{'hex':'80000003', 'name':'query_sm_resp'},
+ '00000004':{'hex':'00000004', 'name':'submit_sm'},
+ '80000004':{'hex':'80000004', 'name':'submit_sm_resp'},
+ '00000005':{'hex':'00000005', 'name':'deliver_sm'},
+ '80000005':{'hex':'80000005', 'name':'deliver_sm_resp'},
+ '00000006':{'hex':'00000006', 'name':'unbind'},
+ '80000006':{'hex':'80000006', 'name':'unbind_resp'},
+ '00000007':{'hex':'00000007', 'name':'replace_sm'},
+ '80000007':{'hex':'80000007', 'name':'replace_sm_resp'},
+ '00000008':{'hex':'00000008', 'name':'cancel_sm'},
+ '80000008':{'hex':'80000008', 'name':'cancel_sm_resp'},
+ '00000009':{'hex':'00000009', 'name':'bind_transceiver'},
+ '80000009':{'hex':'80000009', 'name':'bind_transceiver_resp'},
+ '0000000b':{'hex':'0000000b', 'name':'outbind'},
+ '00000015':{'hex':'00000015', 'name':'enquire_link'},
+ '80000015':{'hex':'80000015', 'name':'enquire_link_resp'},
+ '00000021':{'hex':'00000021', 'name':'submit_multi'},
+ '80000021':{'hex':'80000021', 'name':'submit_multi_resp'},
+ '00000102':{'hex':'00000102', 'name':'alert_notification'},
+ '00000103':{'hex':'00000103', 'name':'data_sm'},
+ '80000103':{'hex':'80000103', 'name':'data_sm_resp'},
+
+ # v4 codes
+
+ '80010000':{'hex':'80010000', 'name':'generic_nack_v4'},
+ '00010001':{'hex':'00010001', 'name':'bind_receiver_v4'},
+ '80010001':{'hex':'80010001', 'name':'bind_receiver_resp_v4'},
+ '00010002':{'hex':'00010002', 'name':'bind_transmitter_v4'},
+ '80010002':{'hex':'80010002', 'name':'bind_transmitter_resp_v4'},
+ '00010003':{'hex':'00010003', 'name':'query_sm_v4'},
+ '80010003':{'hex':'80010003', 'name':'query_sm_resp_v4'},
+ '00010004':{'hex':'00010004', 'name':'submit_sm_v4'},
+ '80010004':{'hex':'80010004', 'name':'submit_sm_resp_v4'},
+ '00010005':{'hex':'00010005', 'name':'deliver_sm_v4'},
+ '80010005':{'hex':'80010005', 'name':'deliver_sm_resp_v4'},
+ '00010006':{'hex':'00010006', 'name':'unbind_v4'},
+ '80010006':{'hex':'80010006', 'name':'unbind_resp_v4'},
+ '00010007':{'hex':'00010007', 'name':'replace_sm_v4'},
+ '80010007':{'hex':'80010007', 'name':'replace_sm_resp_v4'},
+ '00010008':{'hex':'00010008', 'name':'cancel_sm_v4'},
+ '80010008':{'hex':'80010008', 'name':'cancel_sm_resp_v4'},
+ '00010009':{'hex':'00010009', 'name':'delivery_receipt_v4'},
+ '80010009':{'hex':'80010009', 'name':'delivery_receipt_resp_v4'},
+ '0001000a':{'hex':'0001000a', 'name':'enquire_link_v4'},
+ '8001000a':{'hex':'8001000a', 'name':'enquire_link_resp_v4'},
+ '0001000b':{'hex':'0001000b', 'name':'outbind_v4'},
+}
+def command_id_name_by_hex(x):
+ return command_id_by_hex.get(x,{}).get('name')
+
+
+command_id_by_name = {
+ 'generic_nack' :{'hex':'80000000', 'name':'generic_nack'},
+ 'bind_receiver' :{'hex':'00000001', 'name':'bind_receiver'},
+ 'bind_receiver_resp' :{'hex':'80000001', 'name':'bind_receiver_resp'},
+ 'bind_transmitter' :{'hex':'00000002', 'name':'bind_transmitter'},
+ 'bind_transmitter_resp' :{'hex':'80000002', 'name':'bind_transmitter_resp'},
+ 'query_sm' :{'hex':'00000003', 'name':'query_sm'},
+ 'query_sm_resp' :{'hex':'80000003', 'name':'query_sm_resp'},
+ 'submit_sm' :{'hex':'00000004', 'name':'submit_sm'},
+ 'submit_sm_resp' :{'hex':'80000004', 'name':'submit_sm_resp'},
+ 'deliver_sm' :{'hex':'00000005', 'name':'deliver_sm'},
+ 'deliver_sm_resp' :{'hex':'80000005', 'name':'deliver_sm_resp'},
+ 'unbind' :{'hex':'00000006', 'name':'unbind'},
+ 'unbind_resp' :{'hex':'80000006', 'name':'unbind_resp'},
+ 'replace_sm' :{'hex':'00000007', 'name':'replace_sm'},
+ 'replace_sm_resp' :{'hex':'80000007', 'name':'replace_sm_resp'},
+ 'cancel_sm' :{'hex':'00000008', 'name':'cancel_sm'},
+ 'cancel_sm_resp' :{'hex':'80000008', 'name':'cancel_sm_resp'},
+ 'bind_transceiver' :{'hex':'00000009', 'name':'bind_transceiver'},
+ 'bind_transceiver_resp' :{'hex':'80000009', 'name':'bind_transceiver_resp'},
+ 'outbind' :{'hex':'0000000b', 'name':'outbind'},
+ 'enquire_link' :{'hex':'00000015', 'name':'enquire_link'},
+ 'enquire_link_resp' :{'hex':'80000015', 'name':'enquire_link_resp'},
+ 'submit_multi' :{'hex':'00000021', 'name':'submit_multi'},
+ 'submit_multi_resp' :{'hex':'80000021', 'name':'submit_multi_resp'},
+ 'alert_notification' :{'hex':'00000102', 'name':'alert_notification'},
+ 'data_sm' :{'hex':'00000103', 'name':'data_sm'},
+ 'data_sm_resp' :{'hex':'80000103', 'name':'data_sm_resp'},
+
+ # v4 codes
+
+ 'generic_nack_v4' :{'hex':'80010000', 'name':'generic_nack_v4'},
+ 'bind_receiver_v4' :{'hex':'00010001', 'name':'bind_receiver_v4'},
+ 'bind_receiver_resp_v4' :{'hex':'80010001', 'name':'bind_receiver_resp_v4'},
+ 'bind_transmitter_v4' :{'hex':'00010002', 'name':'bind_transmitter_v4'},
+ 'bind_transmitter_resp_v4':{'hex':'80010002', 'name':'bind_transmitter_resp_v4'},
+ 'query_sm_v4' :{'hex':'00010003', 'name':'query_sm_v4'},
+ 'query_sm_resp_v4' :{'hex':'80010003', 'name':'query_sm_resp_v4'},
+ 'submit_sm_v4' :{'hex':'00010004', 'name':'submit_sm_v4'},
+ 'submit_sm_resp_v4' :{'hex':'80010004', 'name':'submit_sm_resp_v4'},
+ 'deliver_sm_v4' :{'hex':'00010005', 'name':'deliver_sm_v4'},
+ 'deliver_sm_resp_v4' :{'hex':'80010005', 'name':'deliver_sm_resp_v4'},
+ 'unbind_v4' :{'hex':'00010006', 'name':'unbind_v4'},
+ 'unbind_resp_v4' :{'hex':'80010006', 'name':'unbind_resp_v4'},
+ 'replace_sm_v4' :{'hex':'00010007', 'name':'replace_sm_v4'},
+ 'replace_sm_resp_v4' :{'hex':'80010007', 'name':'replace_sm_resp_v4'},
+ 'cancel_sm_v4' :{'hex':'00010008', 'name':'cancel_sm_v4'},
+ 'cancel_sm_resp_v4' :{'hex':'80010008', 'name':'cancel_sm_resp_v4'},
+ 'delivery_receipt_v4' :{'hex':'00010009', 'name':'delivery_receipt_v4'},
+ 'delivery_receipt_resp_v4':{'hex':'80010009', 'name':'delivery_receipt_resp_v4'},
+ 'enquire_link_v4' :{'hex':'0001000a', 'name':'enquire_link_v4'},
+ 'enquire_link_resp_v4' :{'hex':'8001000a', 'name':'enquire_link_resp_v4'},
+ 'outbind_v4' :{'hex':'0001000b', 'name':'outbind_v4'}
+}
+def command_id_hex_by_name(n):
+ return command_id_by_name.get(n,{}).get('hex')
+
+
# SMPP Error Codes (ESME) - SMPP v3.4, section 5.1.3, table 5-2, page 112-114
command_status_by_hex = {
'00000000':{'hex':'00000000', 'name':'ESME_ROK', 'description':'No error'},
'00000001':{'hex':'00000001', 'name':'ESME_RINVMSGLEN', 'description':'Message Length is invalid'},
'00000002':{'hex':'00000002', 'name':'ESME_RINVCMDLEN', 'description':'Command Length is invalid'},
'00000003':{'hex':'00000003', 'name':'ESME_RINVCMDID', 'description':'Invalid Command ID'},
'00000004':{'hex':'00000004', 'name':'ESME_RINVBNDSTS', 'description':'Incorrect BIND Status for given command'},
'00000005':{'hex':'00000005', 'name':'ESME_RALYBND', 'description':'ESME Already in bound state'},
'00000006':{'hex':'00000006', 'name':'ESME_RINVPRTFLG', 'description':'Invalid priority flag'},
'00000007':{'hex':'00000007', 'name':'ESME_RINVREGDLVFLG', 'description':'Invalid registered delivery flag'},
'00000008':{'hex':'00000008', 'name':'ESME_RSYSERR', 'description':'System Error'},
'0000000a':{'hex':'0000000a', 'name':'ESME_RINVSRCADR', 'description':'Invalid source address'},
'0000000b':{'hex':'0000000b', 'name':'ESME_RINVDSTADR', 'description':'Invalid destination address'},
'0000000c':{'hex':'0000000c', 'name':'ESME_RINVMSGID', 'description':'Message ID is invalid'},
'0000000d':{'hex':'0000000d', 'name':'ESME_RBINDFAIL', 'description':'Bind failed'},
'0000000e':{'hex':'0000000e', 'name':'ESME_RINVPASWD', 'description':'Invalid password'},
'0000000f':{'hex':'0000000f', 'name':'ESME_RINVSYSID', 'description':'Invalid System ID'},
'00000011':{'hex':'00000011', 'name':'ESME_RCANCELFAIL', 'description':'Cancel SM Failed'},
'00000013':{'hex':'00000013', 'name':'ESME_RREPLACEFAIL', 'description':'Replace SM Failed'},
'00000014':{'hex':'00000014', 'name':'ESME_RMSGQFUL', 'description':'Message queue full'},
'00000015':{'hex':'00000015', 'name':'ESME_RINVSERTYP', 'description':'Invalid service type'},
'00000033':{'hex':'00000033', 'name':'ESME_RINVNUMDESTS', 'description':'Invalid number of destinations'},
'00000034':{'hex':'00000034', 'name':'ESME_RINVDLNAME', 'description':'Invalid distribution list name'},
'00000040':{'hex':'00000040', 'name':'ESME_RINVDESTFLAG', 'description':'Destination flag is invalid (submit_multi)'},
'00000042':{'hex':'00000042', 'name':'ESME_RINVSUBREP', 'description':"Invalid `submit with replace' request (i.e. submit_sm with replace_if_present_flag set)"},
'00000043':{'hex':'00000043', 'name':'ESME_RINVESMCLASS', 'description':'Invalid esm_class field data'},
'00000044':{'hex':'00000044', 'name':'ESME_RCNTSUBDL', 'description':'Cannot submit to distribution list'},
'00000045':{'hex':'00000045', 'name':'ESME_RSUBMITFAIL', 'description':'submit_sm or submit_multi failed'},
'00000048':{'hex':'00000048', 'name':'ESME_RINVSRCTON', 'description':'Invalid source address TON'},
'00000049':{'hex':'00000049', 'name':'ESME_RINVSRCNPI', 'description':'Invalid source address NPI'},
'00000050':{'hex':'00000050', 'name':'ESME_RINVDSTTON', 'description':'Invalid destination address TON'},
'00000051':{'hex':'00000051', 'name':'ESME_RINVDSTNPI', 'description':'Invalid destination address NPI'},
'00000053':{'hex':'00000053', 'name':'ESME_RINVSYSTYP', 'description':'Invalid system_type field'},
'00000054':{'hex':'00000054', 'name':'ESME_RINVREPFLAG', 'description':'Invalid replace_if_present flag'},
'00000055':{'hex':'00000055', 'name':'ESME_RINVNUMMSGS', 'description':'Invalid number of messages'},
'00000058':{'hex':'00000058', 'name':'ESME_RTHROTTLED', 'description':'Throttling error (ESME has exceeded allowed message limits)'},
'00000061':{'hex':'00000061', 'name':'ESME_RINVSCHED', 'description':'Invalid scheduled delivery time'},
'00000062':{'hex':'00000062', 'name':'ESME_RINVEXPIRY', 'description':'Invalid message validity period (expiry time)'},
'00000063':{'hex':'00000063', 'name':'ESME_RINVDFTMSGID', 'description':'Predefined message invalid or not found'},
'00000064':{'hex':'00000064', 'name':'ESME_RX_T_APPN', 'description':'ESME Receiver Temporary App Error Code'},
'00000065':{'hex':'00000065', 'name':'ESME_RX_P_APPN', 'description':'ESME Receiver Permanent App Error Code'},
'00000066':{'hex':'00000066', 'name':'ESME_RX_R_APPN', 'description':'ESME Receiver Reject Message Error Code'},
'00000067':{'hex':'00000067', 'name':'ESME_RQUERYFAIL', 'description':'query_sm request failed'},
'000000c0':{'hex':'000000c0', 'name':'ESME_RINVOPTPARSTREAM', 'description':'Error in the optional part of the PDU Body'},
'000000c1':{'hex':'000000c1', 'name':'ESME_ROPTPARNOTALLWD', 'description':'Optional paramenter not allowed'},
'000000c2':{'hex':'000000c2', 'name':'ESME_RINVPARLEN', 'description':'Invalid parameter length'},
'000000c3':{'hex':'000000c3', 'name':'ESME_RMISSINGOPTPARAM', 'description':'Expected optional parameter missing'},
'000000c4':{'hex':'000000c4', 'name':'ESME_RINVOPTPARAMVAL', 'description':'Invalid optional parameter value'},
'000000fe':{'hex':'000000fe', 'name':'ESME_RDELIVERYFAILURE', 'description':'Delivery Failure (used for data_sm_resp)'},
'000000ff':{'hex':'000000ff', 'name':'ESME_RUNKNOWNERR', 'description':'Unknown error'}
}
def command_status_name_by_hex(x):
return command_status_by_hex.get(x,{}).get('name')
command_status_by_name = {
'ESME_ROK' :{'hex':'00000000', 'name':'ESME_ROK', 'description':'No error'},
'ESME_RINVMSGLEN' :{'hex':'00000001', 'name':'ESME_RINVMSGLEN', 'description':'Message Length is invalid'},
'ESME_RINVCMDLEN' :{'hex':'00000002', 'name':'ESME_RINVCMDLEN', 'description':'Command Length is invalid'},
'ESME_RINVCMDID' :{'hex':'00000003', 'name':'ESME_RINVCMDID', 'description':'Invalid Command ID'},
'ESME_RINVBNDSTS' :{'hex':'00000004', 'name':'ESME_RINVBNDSTS', 'description':'Incorrect BIND Status for given command'},
'ESME_RALYBND' :{'hex':'00000005', 'name':'ESME_RALYBND', 'description':'ESME Already in bound state'},
'ESME_RINVPRTFLG' :{'hex':'00000006', 'name':'ESME_RINVPRTFLG', 'description':'Invalid priority flag'},
'ESME_RINVREGDLVFLG' :{'hex':'00000007', 'name':'ESME_RINVREGDLVFLG', 'description':'Invalid registered delivery flag'},
'ESME_RSYSERR' :{'hex':'00000008', 'name':'ESME_RSYSERR', 'description':'System Error'},
'ESME_RINVSRCADR' :{'hex':'0000000a', 'name':'ESME_RINVSRCADR', 'description':'Invalid source address'},
'ESME_RINVDSTADR' :{'hex':'0000000b', 'name':'ESME_RINVDSTADR', 'description':'Invalid destination address'},
'ESME_RINVMSGID' :{'hex':'0000000c', 'name':'ESME_RINVMSGID', 'description':'Message ID is invalid'},
'ESME_RBINDFAIL' :{'hex':'0000000d', 'name':'ESME_RBINDFAIL', 'description':'Bind failed'},
'ESME_RINVPASWD' :{'hex':'0000000e', 'name':'ESME_RINVPASWD', 'description':'Invalid password'},
'ESME_RINVSYSID' :{'hex':'0000000f', 'name':'ESME_RINVSYSID', 'description':'Invalid System ID'},
'ESME_RCANCELFAIL' :{'hex':'00000011', 'name':'ESME_RCANCELFAIL', 'description':'Cancel SM Failed'},
'ESME_RREPLACEFAIL' :{'hex':'00000013', 'name':'ESME_RREPLACEFAIL', 'description':'Replace SM Failed'},
'ESME_RMSGQFUL' :{'hex':'00000014', 'name':'ESME_RMSGQFUL', 'description':'Message queue full'},
'ESME_RINVSERTYP' :{'hex':'00000015', 'name':'ESME_RINVSERTYP', 'description':'Invalid service type'},
'ESME_RINVNUMDESTS' :{'hex':'00000033', 'name':'ESME_RINVNUMDESTS', 'description':'Invalid number of destinations'},
'ESME_RINVDLNAME' :{'hex':'00000034', 'name':'ESME_RINVDLNAME', 'description':'Invalid distribution list name'},
'ESME_RINVDESTFLAG' :{'hex':'00000040', 'name':'ESME_RINVDESTFLAG', 'description':'Destination flag is invalid (submit_multi)'},
'ESME_RINVSUBREP' :{'hex':'00000042', 'name':'ESME_RINVSUBREP', 'description':"Invalid `submit with replace' request (i.e. submit_sm with replace_if_present_flag set)"},
'ESME_RINVESMCLASS' :{'hex':'00000043', 'name':'ESME_RINVESMCLASS', 'description':'Invalid esm_class field data'},
'ESME_RCNTSUBDL' :{'hex':'00000044', 'name':'ESME_RCNTSUBDL', 'description':'Cannot submit to distribution list'},
'ESME_RSUBMITFAIL' :{'hex':'00000045', 'name':'ESME_RSUBMITFAIL', 'description':'submit_sm or submit_multi failed'},
'ESME_RINVSRCTON' :{'hex':'00000048', 'name':'ESME_RINVSRCTON', 'description':'Invalid source address TON'},
'ESME_RINVSRCNPI' :{'hex':'00000049', 'name':'ESME_RINVSRCNPI', 'description':'Invalid source address NPI'},
'ESME_RINVDSTTON' :{'hex':'00000050', 'name':'ESME_RINVDSTTON', 'description':'Invalid destination address TON'},
'ESME_RINVDSTNPI' :{'hex':'00000051', 'name':'ESME_RINVDSTNPI', 'description':'Invalid destination address NPI'},
'ESME_RINVSYSTYP' :{'hex':'00000053', 'name':'ESME_RINVSYSTYP', 'description':'Invalid system_type field'},
'ESME_RINVREPFLAG' :{'hex':'00000054', 'name':'ESME_RINVREPFLAG', 'description':'Invalid replace_if_present flag'},
'ESME_RINVNUMMSGS' :{'hex':'00000055', 'name':'ESME_RINVNUMMSGS', 'description':'Invalid number of messages'},
'ESME_RTHROTTLED' :{'hex':'00000058', 'name':'ESME_RTHROTTLED', 'description':'Throttling error (ESME has exceeded allowed message limits)'},
'ESME_RINVSCHED' :{'hex':'00000061', 'name':'ESME_RINVSCHED', 'description':'Invalid scheduled delivery time'},
'ESME_RINVEXPIRY' :{'hex':'00000062', 'name':'ESME_RINVEXPIRY', 'description':'Invalid message validity period (expiry time)'},
'ESME_RINVDFTMSGID' :{'hex':'00000063', 'name':'ESME_RINVDFTMSGID', 'description':'Predefined message invalid or not found'},
'ESME_RX_T_APPN' :{'hex':'00000064', 'name':'ESME_RX_T_APPN', 'description':'ESME Receiver Temporary App Error Code'},
'ESME_RX_P_APPN' :{'hex':'00000065', 'name':'ESME_RX_P_APPN', 'description':'ESME Receiver Permanent App Error Code'},
'ESME_RX_R_APPN' :{'hex':'00000066', 'name':'ESME_RX_R_APPN', 'description':'ESME Receiver Reject Message Error Code'},
'ESME_RQUERYFAIL' :{'hex':'00000067', 'name':'ESME_RQUERYFAIL', 'description':'query_sm request failed'},
'ESME_RINVOPTPARSTREAM':{'hex':'000000c0', 'name':'ESME_RINVOPTPARSTREAM', 'description':'Error in the optional part of the PDU Body'},
'ESME_ROPTPARNOTALLWD' :{'hex':'000000c1', 'name':'ESME_ROPTPARNOTALLWD', 'description':'Optional paramenter not allowed'},
'ESME_RINVPARLEN' :{'hex':'000000c2', 'name':'ESME_RINVPARLEN', 'description':'Invalid parameter length'},
'ESME_RMISSINGOPTPARAM':{'hex':'000000c3', 'name':'ESME_RMISSINGOPTPARAM', 'description':'Expected optional parameter missing'},
'ESME_RINVOPTPARAMVAL' :{'hex':'000000c4', 'name':'ESME_RINVOPTPARAMVAL', 'description':'Invalid optional parameter value'},
'ESME_RDELIVERYFAILURE':{'hex':'000000fe', 'name':'ESME_RDELIVERYFAILURE', 'description':'Delivery Failure (used for data_sm_resp)'},
'ESME_RUNKNOWNERR' :{'hex':'000000ff', 'name':'ESME_RUNKNOWNERR', 'description':'Unknown error'}
}
def command_status_hex_by_name(n):
return command_status_by_name.get(n,{}).get('hex')
# Type of Number (TON) - SMPP v3.4, section 5.2.5, table 5-3, page 117
maps['addr_ton_by_name'] = {
'unknown' :'00',
'international' :'01',
'national' :'02',
'network_specific' :'03',
'subscriber_number':'04',
'alphanumeric' :'05',
'abbreviated' :'06'
}
maps['addr_ton_by_hex'] = {
'00':'unknown',
'01':'international',
'02':'national',
'03':'network_specific',
'04':'subscriber_number',
'05':'alphanumeric',
'06':'abbreviated'
}
# Numberic Plan Indicator (NPI) - SMPP v3.4, section 5.2.6, table 5-4, page 118
maps['addr_npi_by_name'] = {
'unknown' :'00',
'ISDN' :'01',
'data' :'03',
'telex' :'04',
'land_mobile':'06',
'national' :'08',
'private' :'09',
'ERMES' :'0a',
'internet' :'0e',
'WAP' :'12'
}
maps['addr_npi_by_hex'] = {
'00':'unknown',
'01':'ISDN',
'03':'data',
'04':'telex',
'06':'land_mobile',
'08':'national',
'09':'private',
'0a':'ERMES',
'0e':'internet',
'12':'WAP'
}
# ESM Class bits - SMPP v3.4, section 5.2.12, page 121
maps['esm_class_bits'] = {
'mode_mask' :'03',
'type_mask' :'3c',
'feature_mask' :'c0',
'mode_default' :'00',
'mode_datagram' :'01',
'mode_forward' :'02',
'mode_store_and_forward' :'03',
'type_default' :'00',
'type_delivery_receipt' :'04',
'type_delivery_ack' :'08',
'type_0011' :'0a',
'type_user_ack' :'10',
'type_0101' :'14',
'type_conversation_abort' :'18',
'type_0111' :'1a',
'type_intermed_deliv_notif' :'20',
'type_1001' :'24',
'type_1010' :'28',
'type_1011' :'2a',
'type_1100' :'30',
'type_1101' :'34',
'type_1110' :'38',
'type_1111' :'3a',
'feature_none' :'00',
'feature_UDHI' :'40',
'feature_reply_path' :'80',
'feature_UDHI_and_reply_path':'c0'
}
# Registered Delivery bits - SMPP v3.4, section 5.2.17, page 124
maps['registered_delivery_bits'] = {
'receipt_mask' :'03',
'ack_mask' :'0c',
'intermed_notif_mask' :'80',
'receipt_none' :'00',
'receipt_always' :'01',
'receipt_on_fail' :'02',
'receipt_res' :'03',
'ack_none' :'00',
'ack_delivery' :'04',
'ack_user' :'08',
'ack_delivery_and_user':'0c',
'intermed_notif_none' :'00',
'intermed_notif' :'10'
}
# submit_multi dest_flag constants - SMPP v3.4, section 5.2.25, page 129
maps['dest_flag_by_name'] = {
'SME_Address':1,
'dist_list' :2
}
# Message State codes returned in query_sm_resp PDUs - SMPP v3.4, section 5.2.28, table 5-6, page 130
maps['message_state_by_name'] = {
'ENROUTE' :1,
'DELIVERED' :2,
'EXPIRED' :3,
'DELETED' :4,
'UNDELIVERABLE':5,
'ACCEPTED' :6,
'UNKNOWN' :7,
'REJECTED' :8
}
# Facility Code bits for SMPP v4
maps['facility_code_bits'] = {
'GF_PVCY' :'00000001',
'GF_SUBADDR':'00000002',
'NF_CC' :'00080000',
'NF_PDC' :'00010000',
'NF_IS136' :'00020000',
'NF_IS95A' :'00040000'
}
# Optional Parameter Tags - SMPP v3.4, section 5.3.2, Table 5-7, page 132-133
optional_parameter_tag_by_hex = {
'0005':{'hex':'0005', 'name':'dest_addr_subunit', 'technology':'GSM'},
'0006':{'hex':'0006', 'name':'dest_network_type', 'technology':'Generic'},
'0007':{'hex':'0007', 'name':'dest_bearer_type', 'technology':'Generic'},
'0008':{'hex':'0008', 'name':'dest_telematics_id', 'technology':'GSM'},
'000d':{'hex':'000d', 'name':'source_addr_subunit', 'technology':'GSM'},
'000e':{'hex':'000e', 'name':'source_network_type', 'technology':'Generic'},
'000f':{'hex':'000f', 'name':'source_bearer_type', 'technology':'Generic'},
'0010':{'hex':'0010', 'name':'source_telematics_id', 'technology':'GSM'},
'0017':{'hex':'0017', 'name':'qos_time_to_live', 'technology':'Generic'},
'0019':{'hex':'0019', 'name':'payload_type', 'technology':'Generic'},
'001d':{'hex':'001d', 'name':'additional_status_info_text', 'technology':'Generic'},
'001e':{'hex':'001e', 'name':'receipted_message_id', 'technology':'Generic'},
'0030':{'hex':'0030', 'name':'ms_msg_wait_facilities', 'technology':'GSM'},
'0101':{'hex':'0101', 'name':'PVCY_AuthenticationStr', 'technology':'? (J-Phone)'}, # v4 page 58-62
'0201':{'hex':'0201', 'name':'privacy_indicator', 'technology':'CDMA,TDMA'},
'0202':{'hex':'0202', 'name':'source_subaddress', 'technology':'CDMA,TDMA'}, # v4 page 65-67
'0203':{'hex':'0203', 'name':'dest_subaddress', 'technology':'CDMA,TDMA'}, # v4 page 65-67
'0204':{'hex':'0204', 'name':'user_message_reference', 'technology':'Generic'},
'0205':{'hex':'0205', 'name':'user_response_code', 'technology':'CDMA,TDMA'},
'020a':{'hex':'020a', 'name':'source_port', 'technology':'WAP'},
'020b':{'hex':'020b', 'name':'destination_port', 'technology':'WAP'},
'020c':{'hex':'020c', 'name':'sar_msg_ref_num', 'technology':'Generic'},
'020d':{'hex':'020d', 'name':'language_indicator', 'technology':'CDMA,TDMA'},
'020e':{'hex':'020e', 'name':'sar_total_segments', 'technology':'Generic'},
'020f':{'hex':'020f', 'name':'sar_segment_seqnum', 'technology':'Generic'},
'0210':{'hex':'0210', 'name':'sc_interface_version', 'technology':'Generic'},
'0301':{'hex':'0301', 'name':'CC_CBN', 'technology':'V4'}, # v4 page 70
'0302':{'hex':'0302', 'name':'callback_num_pres_ind', 'technology':'TDMA'}, # v4 page 71
'0303':{'hex':'0303', 'name':'callback_num_atag', 'technology':'TDMA'}, # v4 page 71
'0304':{'hex':'0304', 'name':'number_of_messages', 'technology':'CDMA'}, # v4 page 72
'0381':{'hex':'0381', 'name':'callback_num', 'technology':'CDMA,TDMA,GSM,iDEN'},
'0420':{'hex':'0420', 'name':'dpf_result', 'technology':'Generic'},
'0421':{'hex':'0421', 'name':'set_dpf', 'technology':'Generic'},
'0422':{'hex':'0422', 'name':'ms_availability_status', 'technology':'Generic'},
'0423':{'hex':'0423', 'name':'network_error_code', 'technology':'Generic'},
'0424':{'hex':'0424', 'name':'message_payload', 'technology':'Generic'},
'0425':{'hex':'0425', 'name':'delivery_failure_reason', 'technology':'Generic'},
'0426':{'hex':'0426', 'name':'more_messages_to_send', 'technology':'GSM'},
'0427':{'hex':'0427', 'name':'message_state', 'technology':'Generic'},
'0428':{'hex':'0428', 'name':'congestion_state', 'technology':'Generic'},
'0501':{'hex':'0501', 'name':'ussd_service_op', 'technology':'GSM (USSD)'},
'0600':{'hex':'0600', 'name':'broadcast_channel_indicator', 'technology':'GSM'},
'0601':{'hex':'0601', 'name':'broadcast_content_type', 'technology':'CDMA, TDMA, GSM'},
'0602':{'hex':'0602', 'name':'broadcast_content_type_info', 'technology':'CDMA, TDMA'},
'0603':{'hex':'0603', 'name':'broadcast_message_class', 'technology':'GSM'},
'0604':{'hex':'0604', 'name':'broadcast_rep_num', 'technology':'GSM'},
'0605':{'hex':'0605', 'name':'broadcast_frequency_interval', 'technology':'CDMA, TDMA, GSM'},
'0606':{'hex':'0606', 'name':'broadcast_area_identifier', 'technology':'CDMA, TDMA, GSM'},
'0607':{'hex':'0607', 'name':'broadcast_error_status', 'technology':'CDMA, TDMA, GSM'},
'0608':{'hex':'0608', 'name':'broadcast_area_success', 'technology':'GSM'},
'0609':{'hex':'0609', 'name':'broadcast_end_time', 'technology':'CDMA, TDMA, GSM'},
'060a':{'hex':'060a', 'name':'broadcast_service_group', 'technology':'CDMA, TDMA'},
'060b':{'hex':'060b', 'name':'billing_identification', 'technology':'Generic'},
'060d':{'hex':'060d', 'name':'source_network_id', 'technology':'Generic'},
'060e':{'hex':'060e', 'name':'dest_network_id', 'technology':'Generic'},
'060f':{'hex':'060f', 'name':'source_node_id', 'technology':'Generic'},
'0610':{'hex':'0610', 'name':'dest_node_id', 'technology':'Generic'},
'0611':{'hex':'0611', 'name':'dest_addr_np_resolution', 'technology':'CDMA, TDMA (US Only)'},
'0612':{'hex':'0612', 'name':'dest_addr_np_information', 'technology':'CDMA, TDMA (US Only)'},
'0613':{'hex':'0613', 'name':'dest_addr_np_country', 'technology':'CDMA, TDMA (US Only)'},
'1201':{'hex':'1201', 'name':'display_time', 'technology':'CDMA,TDMA'},
'1203':{'hex':'1203', 'name':'sms_signal', 'technology':'TDMA'},
'1204':{'hex':'1204', 'name':'ms_validity', 'technology':'CDMA,TDMA'},
'1304':{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'technology':'CDMA'}, # v4 page 85
'1306':{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'technology':'CDMA'}, # v4 page 86
'130c':{'hex':'130c', 'name':'alert_on_message_delivery', 'technology':'CDMA'},
'1380':{'hex':'1380', 'name':'its_reply_type', 'technology':'CDMA'},
'1383':{'hex':'1383', 'name':'its_session_info', 'technology':'CDMA Korean [KORITS]'},
'1402':{'hex':'1402', 'name':'operator_id', 'technology':'vendor extension'},
'1403':{'hex':'1403', 'name':'tariff', 'technology':'Mobile Network Code vendor extension'},
'1450':{'hex':'1450', 'name':'mcc', 'technology':'Mobile Country Code vendor extension'},
'1451':{'hex':'1451', 'name':'mnc', 'technology':'Mobile Network Code vendor extension'},
'1101':{'hex':'1101', 'name':'PDC_MessageClass', 'technology':'? (J-Phone)'}, # v4 page 75
'1102':{'hex':'1102', 'name':'PDC_PresentationOption', 'technology':'? (J-Phone)'}, # v4 page 76
'1103':{'hex':'1103', 'name':'PDC_AlertMechanism', 'technology':'? (J-Phone)'}, # v4 page 76
'1104':{'hex':'1104', 'name':'PDC_Teleservice', 'technology':'? (J-Phone)'}, # v4 page 77
'1105':{'hex':'1105', 'name':'PDC_MultiPartMessage', 'technology':'? (J-Phone)'}, # v4 page 77
'1106':{'hex':'1106', 'name':'PDC_PredefinedMsg', 'technology':'? (J-Phone)'} # v4 page 78
}
def optional_parameter_tag_name_by_hex(x):
return optional_parameter_tag_by_hex.get(x,{}).get('name')
optional_parameter_tag_by_name = {
'dest_addr_subunit' :{'hex':'0005', 'name':'dest_addr_subunit', 'technology':'GSM'},
'dest_network_type' :{'hex':'0006', 'name':'dest_network_type', 'technology':'Generic'},
'dest_bearer_type' :{'hex':'0007', 'name':'dest_bearer_type', 'technology':'Generic'},
'dest_telematics_id' :{'hex':'0008', 'name':'dest_telematics_id', 'technology':'GSM'},
'source_addr_subunit' :{'hex':'000d', 'name':'source_addr_subunit', 'technology':'GSM'},
'source_network_type' :{'hex':'000e', 'name':'source_network_type', 'technology':'Generic'},
'source_bearer_type' :{'hex':'000f', 'name':'source_bearer_type', 'technology':'Generic'},
'source_telematics_id' :{'hex':'0010', 'name':'source_telematics_id', 'technology':'GSM'},
'qos_time_to_live' :{'hex':'0017', 'name':'qos_time_to_live', 'technology':'Generic'},
'payload_type' :{'hex':'0019', 'name':'payload_type', 'technology':'Generic'},
'additional_status_info_text' :{'hex':'001d', 'name':'additional_status_info_text', 'technology':'Generic'},
'receipted_message_id' :{'hex':'001e', 'name':'receipted_message_id', 'technology':'Generic'},
'ms_msg_wait_facilities' :{'hex':'0030', 'name':'ms_msg_wait_facilities', 'technology':'GSM'},
'PVCY_AuthenticationStr' :{'hex':'0101', 'name':'PVCY_AuthenticationStr', 'technology':'? (J-Phone)'}, # v4 page 58-62
'privacy_indicator' :{'hex':'0201', 'name':'privacy_indicator', 'technology':'CDMA,TDMA'},
'source_subaddress' :{'hex':'0202', 'name':'source_subaddress', 'technology':'CDMA,TDMA'}, # v4 page 65-67
'dest_subaddress' :{'hex':'0203', 'name':'dest_subaddress', 'technology':'CDMA,TDMA'}, # v4 page 65-67
'user_message_reference' :{'hex':'0204', 'name':'user_message_reference', 'technology':'Generic'},
'user_response_code' :{'hex':'0205', 'name':'user_response_code', 'technology':'CDMA,TDMA'},
'source_port' :{'hex':'020a', 'name':'source_port', 'technology':'WAP'},
'destination_port' :{'hex':'020b', 'name':'destination_port', 'technology':'WAP'},
'sar_msg_ref_num' :{'hex':'020c', 'name':'sar_msg_ref_num', 'technology':'Generic'},
'language_indicator' :{'hex':'020d', 'name':'language_indicator', 'technology':'CDMA,TDMA'},
'sar_total_segments' :{'hex':'020e', 'name':'sar_total_segments', 'technology':'Generic'},
'sar_segment_seqnum' :{'hex':'020f', 'name':'sar_segment_seqnum', 'technology':'Generic'},
'sc_interface_version' :{'hex':'0210', 'name':'sc_interface_version', 'technology':'Generic'},
'CC_CBN' :{'hex':'0301', 'name':'CC_CBN', 'technology':'V4'}, # v4 page 70
'callback_num_pres_ind' :{'hex':'0302', 'name':'callback_num_pres_ind', 'technology':'TDMA'}, # v4 page 71
'callback_num_atag' :{'hex':'0303', 'name':'callback_num_atag', 'technology':'TDMA'}, # v4 page 71
'number_of_messages' :{'hex':'0304', 'name':'number_of_messages', 'technology':'CDMA'}, # v4 page 72
'callback_num' :{'hex':'0381', 'name':'callback_num', 'technology':'CDMA,TDMA,GSM,iDEN'},
'dpf_result' :{'hex':'0420', 'name':'dpf_result', 'technology':'Generic'},
'set_dpf' :{'hex':'0421', 'name':'set_dpf', 'technology':'Generic'},
'ms_availability_status' :{'hex':'0422', 'name':'ms_availability_status', 'technology':'Generic'},
'network_error_code' :{'hex':'0423', 'name':'network_error_code', 'technology':'Generic'},
'message_payload' :{'hex':'0424', 'name':'message_payload', 'technology':'Generic'},
'delivery_failure_reason' :{'hex':'0425', 'name':'delivery_failure_reason', 'technology':'Generic'},
'more_messages_to_send' :{'hex':'0426', 'name':'more_messages_to_send', 'technology':'GSM'},
'message_state' :{'hex':'0427', 'name':'message_state', 'technology':'Generic'},
'congestion_state' :{'hex':'0428', 'name':'congestion_state', 'technology':'Generic'},
'ussd_service_op' :{'hex':'0501', 'name':'ussd_service_op', 'technology':'GSM (USSD)'},
'broadcast_channel_indicator' :{'hex':'0600', 'name':'broadcast_channel_indicator', 'technology':'GSM'},
'broadcast_content_type' :{'hex':'0601', 'name':'broadcast_content_type', 'technology':'CDMA, TDMA, GSM'},
'broadcast_content_type_info' :{'hex':'0602', 'name':'broadcast_content_type_info', 'technology':'CDMA, TDMA'},
'broadcast_message_class' :{'hex':'0603', 'name':'broadcast_message_class', 'technology':'GSM'},
'broadcast_rep_num' :{'hex':'0604', 'name':'broadcast_rep_num', 'technology':'GSM'},
'broadcast_frequency_interval':{'hex':'0605', 'name':'broadcast_frequency_interval', 'technology':'CDMA, TDMA, GSM'},
'broadcast_area_identifier' :{'hex':'0606', 'name':'broadcast_area_identifier', 'technology':'CDMA, TDMA, GSM'},
- 'broadcast_error_status' :{'hex':'0607', 'name':'broadcast_error_status', 'technology':'CDMA, TDMA, GSM'},
- 'broadcast_area_success' :{'hex':'0608', 'name':'broadcast_area_success', 'technology':'GSM'},
- 'broadcast_end_time' :{'hex':'0609', 'name':'broadcast_end_time', 'technology':'CDMA, TDMA, GSM'},
- 'broadcast_service_group' :{'hex':'060a', 'name':'broadcast_service_group', 'technology':'CDMA, TDMA'},
- 'billing_identification' :{'hex':'060b', 'name':'billing_identification', 'technology':'Generic'},
- 'source_network_id' :{'hex':'060d', 'name':'source_network_id', 'technology':'Generic'},
- 'dest_network_id' :{'hex':'060e', 'name':'dest_network_id', 'technology':'Generic'},
- 'source_node_id' :{'hex':'060f', 'name':'source_node_id', 'technology':'Generic'},
- 'dest_node_id' :{'hex':'0610', 'name':'dest_node_id', 'technology':'Generic'},
- 'dest_addr_np_resolution' :{'hex':'0611', 'name':'dest_addr_np_resolution', 'technology':'CDMA, TDMA (US Only)'},
- 'dest_addr_np_information' :{'hex':'0612', 'name':'dest_addr_np_information', 'technology':'CDMA, TDMA (US Only)'},
- 'dest_addr_np_country' :{'hex':'0613', 'name':'dest_addr_np_country', 'technology':'CDMA, TDMA (US Only)'},
-
- 'display_time' :{'hex':'1201', 'name':'display_time', 'technology':'CDMA,TDMA'},
- 'sms_signal' :{'hex':'1203', 'name':'sms_signal', 'technology':'TDMA'},
- 'ms_validity' :{'hex':'1204', 'name':'ms_validity', 'technology':'CDMA,TDMA'},
-
- 'IS95A_AlertOnDelivery' :{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'technology':'CDMA'}, # v4 page 85
- 'IS95A_LanguageIndicator' :{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'technology':'CDMA'}, # v4 page 86
- 'alert_on_message_delivery' :{'hex':'130c', 'name':'alert_on_message_delivery', 'technology':'CDMA'},
- 'its_reply_type' :{'hex':'1380', 'name':'its_reply_type', 'technology':'CDMA'},
- 'its_session_info' :{'hex':'1383', 'name':'its_session_info', 'technology':'CDMA Korean [KORITS]'},
-
- 'operator_id' :{'hex':'1402', 'name':'operator_id', 'technology':'vendor extension'},
- 'tariff' :{'hex':'1403', 'name':'tariff', 'technology':'Mobile Network Code vendor extension'},
- 'mcc' :{'hex':'1450', 'name':'mcc', 'technology':'Mobile Country Code vendor extension'},
- 'mnc' :{'hex':'1451', 'name':'mnc', 'technology':'Mobile Network Code vendor extension'},
-
- 'PDC_MessageClass' :{'hex':'1101', 'name':'PDC_MessageClass', 'technology':'? (J-Phone)'}, # v4 page 75
- 'PDC_PresentationOption' :{'hex':'1102', 'name':'PDC_PresentationOption', 'technology':'? (J-Phone)'}, # v4 page 76
- 'PDC_AlertMechanism' :{'hex':'1103', 'name':'PDC_AlertMechanism', 'technology':'? (J-Phone)'}, # v4 page 76
- 'PDC_Teleservice' :{'hex':'1104', 'name':'PDC_Teleservice', 'technology':'? (J-Phone)'}, # v4 page 77
- 'PDC_MultiPartMessage' :{'hex':'1105', 'name':'PDC_MultiPartMessage', 'technology':'? (J-Phone)'}, # v4 page 77
- 'PDC_PredefinedMsg' :{'hex':'1106', 'name':'PDC_PredefinedMsg', 'technology':'? (J-Phone)'} # v4 page 78
-}
-def optional_parameter_tag_hex_by_name(n):
- return optional_parameter_tag_by_name.get(n,{}).get('hex')
-
-
-# Command IDs - SMPP v3.4, section 5.1.2.1, table 5-1, page 110-111
-
-command_id_by_hex = {
- '80000000':{'hex':'80000000', 'name':'generic_nack'},
- '00000001':{'hex':'00000001', 'name':'bind_receiver'},
- '80000001':{'hex':'80000001', 'name':'bind_receiver_resp'},
- '00000002':{'hex':'00000002', 'name':'bind_transmitter'},
- '80000002':{'hex':'80000002', 'name':'bind_transmitter_resp'},
- '00000003':{'hex':'00000003', 'name':'query_sm'},
- '80000003':{'hex':'80000003', 'name':'query_sm_resp'},
- '00000004':{'hex':'00000004', 'name':'submit_sm'},
- '80000004':{'hex':'80000004', 'name':'submit_sm_resp'},
- '00000005':{'hex':'00000005', 'name':'deliver_sm'},
- '80000005':{'hex':'80000005', 'name':'deliver_sm_resp'},
- '00000006':{'hex':'00000006', 'name':'unbind'},
- '80000006':{'hex':'80000006', 'name':'unbind_resp'},
- '00000007':{'hex':'00000007', 'name':'replace_sm'},
- '80000007':{'hex':'80000007', 'name':'replace_sm_resp'},
- '00000008':{'hex':'00000008', 'name':'cancel_sm'},
- '80000008':{'hex':'80000008', 'name':'cancel_sm_resp'},
- '00000009':{'hex':'00000009', 'name':'bind_transceiver'},
- '80000009':{'hex':'80000009', 'name':'bind_transceiver_resp'},
- '0000000b':{'hex':'0000000b', 'name':'outbind'},
- '00000015':{'hex':'00000015', 'name':'enquire_link'},
- '80000015':{'hex':'80000015', 'name':'enquire_link_resp'},
- '00000021':{'hex':'00000021', 'name':'submit_multi'},
- '80000021':{'hex':'80000021', 'name':'submit_multi_resp'},
- '00000102':{'hex':'00000102', 'name':'alert_notification'},
- '00000103':{'hex':'00000103', 'name':'data_sm'},
- '80000103':{'hex':'80000103', 'name':'data_sm_resp'},
-
- # v4 codes
-
- '80010000':{'hex':'80010000', 'name':'generic_nack_v4'},
- '00010001':{'hex':'00010001', 'name':'bind_receiver_v4'},
- '80010001':{'hex':'80010001', 'name':'bind_receiver_resp_v4'},
- '00010002':{'hex':'00010002', 'name':'bind_transmitter_v4'},
- '80010002':{'hex':'80010002', 'name':'bind_transmitter_resp_v4'},
- '00010003':{'hex':'00010003', 'name':'query_sm_v4'},
- '80010003':{'hex':'80010003', 'name':'query_sm_resp_v4'},
- '00010004':{'hex':'00010004', 'name':'submit_sm_v4'},
- '80010004':{'hex':'80010004', 'name':'submit_sm_resp_v4'},
- '00010005':{'hex':'00010005', 'name':'deliver_sm_v4'},
- '80010005':{'hex':'80010005', 'name':'deliver_sm_resp_v4'},
- '00010006':{'hex':'00010006', 'name':'unbind_v4'},
- '80010006':{'hex':'80010006', 'name':'unbind_resp_v4'},
- '00010007':{'hex':'00010007', 'name':'replace_sm_v4'},
- '80010007':{'hex':'80010007', 'name':'replace_sm_resp_v4'},
- '00010008':{'hex':'00010008', 'name':'cancel_sm_v4'},
- '80010008':{'hex':'80010008', 'name':'cancel_sm_resp_v4'},
- '00010009':{'hex':'00010009', 'name':'delivery_receipt_v4'},
- '80010009':{'hex':'80010009', 'name':'delivery_receipt_resp_v4'},
- '0001000a':{'hex':'0001000a', 'name':'enquire_link_v4'},
- '8001000a':{'hex':'8001000a', 'name':'enquire_link_resp_v4'},
- '0001000b':{'hex':'0001000b', 'name':'outbind_v4'},
-}
-def command_id_name_by_hex(x):
- return command_id_by_hex.get(x,{}).get('name')
-
-
-command_id_by_name = {
- 'generic_nack' :{'hex':'80000000', 'name':'generic_nack'},
- 'bind_receiver' :{'hex':'00000001', 'name':'bind_receiver'},
- 'bind_receiver_resp' :{'hex':'80000001', 'name':'bind_receiver_resp'},
- 'bind_transmitter' :{'hex':'00000002', 'name':'bind_transmitter'},
- 'bind_transmitter_resp' :{'hex':'80000002', 'name':'bind_transmitter_resp'},
- 'query_sm' :{'hex':'00000003', 'name':'query_sm'},
- 'query_sm_resp' :{'hex':'80000003', 'name':'query_sm_resp'},
- 'submit_sm' :{'hex':'00000004', 'name':'submit_sm'},
- 'submit_sm_resp' :{'hex':'80000004', 'name':'submit_sm_resp'},
- 'deliver_sm' :{'hex':'00000005', 'name':'deliver_sm'},
- 'deliver_sm_resp' :{'hex':'80000005', 'name':'deliver_sm_resp'},
- 'unbind' :{'hex':'00000006', 'name':'unbind'},
- 'unbind_resp' :{'hex':'80000006', 'name':'unbind_resp'},
- 'replace_sm' :{'hex':'00000007', 'name':'replace_sm'},
- 'replace_sm_resp' :{'hex':'80000007', 'name':'replace_sm_resp'},
- 'cancel_sm' :{'hex':'00000008', 'name':'cancel_sm'},
- 'cancel_sm_resp' :{'hex':'80000008', 'name':'cancel_sm_resp'},
- 'bind_transceiver' :{'hex':'00000009', 'name':'bind_transceiver'},
- 'bind_transceiver_resp' :{'hex':'80000009', 'name':'bind_transceiver_resp'},
- 'outbind' :{'hex':'0000000b', 'name':'outbind'},
- 'enquire_link' :{'hex':'00000015', 'name':'enquire_link'},
- 'enquire_link_resp' :{'hex':'80000015', 'name':'enquire_link_resp'},
- 'submit_multi' :{'hex':'00000021', 'name':'submit_multi'},
- 'submit_multi_resp' :{'hex':'80000021', 'name':'submit_multi_resp'},
- 'alert_notification' :{'hex':'00000102', 'name':'alert_notification'},
- 'data_sm' :{'hex':'00000103', 'name':'data_sm'},
- 'data_sm_resp' :{'hex':'80000103', 'name':'data_sm_resp'},
+ 'broadcast_error_status' :{'hex':'0607', 'name':'broadcast_error_status', 'technology':'CDMA, TDMA, GSM'},
+ 'broadcast_area_success' :{'hex':'0608', 'name':'broadcast_area_success', 'technology':'GSM'},
+ 'broadcast_end_time' :{'hex':'0609', 'name':'broadcast_end_time', 'technology':'CDMA, TDMA, GSM'},
+ 'broadcast_service_group' :{'hex':'060a', 'name':'broadcast_service_group', 'technology':'CDMA, TDMA'},
+ 'billing_identification' :{'hex':'060b', 'name':'billing_identification', 'technology':'Generic'},
+ 'source_network_id' :{'hex':'060d', 'name':'source_network_id', 'technology':'Generic'},
+ 'dest_network_id' :{'hex':'060e', 'name':'dest_network_id', 'technology':'Generic'},
+ 'source_node_id' :{'hex':'060f', 'name':'source_node_id', 'technology':'Generic'},
+ 'dest_node_id' :{'hex':'0610', 'name':'dest_node_id', 'technology':'Generic'},
+ 'dest_addr_np_resolution' :{'hex':'0611', 'name':'dest_addr_np_resolution', 'technology':'CDMA, TDMA (US Only)'},
+ 'dest_addr_np_information' :{'hex':'0612', 'name':'dest_addr_np_information', 'technology':'CDMA, TDMA (US Only)'},
+ 'dest_addr_np_country' :{'hex':'0613', 'name':'dest_addr_np_country', 'technology':'CDMA, TDMA (US Only)'},
- # v4 codes
+ 'display_time' :{'hex':'1201', 'name':'display_time', 'technology':'CDMA,TDMA'},
+ 'sms_signal' :{'hex':'1203', 'name':'sms_signal', 'technology':'TDMA'},
+ 'ms_validity' :{'hex':'1204', 'name':'ms_validity', 'technology':'CDMA,TDMA'},
- 'generic_nack_v4' :{'hex':'80010000', 'name':'generic_nack_v4'},
- 'bind_receiver_v4' :{'hex':'00010001', 'name':'bind_receiver_v4'},
- 'bind_receiver_resp_v4' :{'hex':'80010001', 'name':'bind_receiver_resp_v4'},
- 'bind_transmitter_v4' :{'hex':'00010002', 'name':'bind_transmitter_v4'},
- 'bind_transmitter_resp_v4':{'hex':'80010002', 'name':'bind_transmitter_resp_v4'},
- 'query_sm_v4' :{'hex':'00010003', 'name':'query_sm_v4'},
- 'query_sm_resp_v4' :{'hex':'80010003', 'name':'query_sm_resp_v4'},
- 'submit_sm_v4' :{'hex':'00010004', 'name':'submit_sm_v4'},
- 'submit_sm_resp_v4' :{'hex':'80010004', 'name':'submit_sm_resp_v4'},
- 'deliver_sm_v4' :{'hex':'00010005', 'name':'deliver_sm_v4'},
- 'deliver_sm_resp_v4' :{'hex':'80010005', 'name':'deliver_sm_resp_v4'},
- 'unbind_v4' :{'hex':'00010006', 'name':'unbind_v4'},
- 'unbind_resp_v4' :{'hex':'80010006', 'name':'unbind_resp_v4'},
- 'replace_sm_v4' :{'hex':'00010007', 'name':'replace_sm_v4'},
- 'replace_sm_resp_v4' :{'hex':'80010007', 'name':'replace_sm_resp_v4'},
- 'cancel_sm_v4' :{'hex':'00010008', 'name':'cancel_sm_v4'},
- 'cancel_sm_resp_v4' :{'hex':'80010008', 'name':'cancel_sm_resp_v4'},
- 'delivery_receipt_v4' :{'hex':'00010009', 'name':'delivery_receipt_v4'},
- 'delivery_receipt_resp_v4':{'hex':'80010009', 'name':'delivery_receipt_resp_v4'},
- 'enquire_link_v4' :{'hex':'0001000a', 'name':'enquire_link_v4'},
- 'enquire_link_resp_v4' :{'hex':'8001000a', 'name':'enquire_link_resp_v4'},
- 'outbind_v4' :{'hex':'0001000b', 'name':'outbind_v4'}
-}
-def command_id_hex_by_name(n):
- return command_id_by_name.get(n,{}).get('hex')
+ 'IS95A_AlertOnDelivery' :{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'technology':'CDMA'}, # v4 page 85
+ 'IS95A_LanguageIndicator' :{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'technology':'CDMA'}, # v4 page 86
+ 'alert_on_message_delivery' :{'hex':'130c', 'name':'alert_on_message_delivery', 'technology':'CDMA'},
+ 'its_reply_type' :{'hex':'1380', 'name':'its_reply_type', 'technology':'CDMA'},
+ 'its_session_info' :{'hex':'1383', 'name':'its_session_info', 'technology':'CDMA Korean [KORITS]'},
+ 'operator_id' :{'hex':'1402', 'name':'operator_id', 'technology':'vendor extension'},
+ 'tariff' :{'hex':'1403', 'name':'tariff', 'technology':'Mobile Network Code vendor extension'},
+ 'mcc' :{'hex':'1450', 'name':'mcc', 'technology':'Mobile Country Code vendor extension'},
+ 'mnc' :{'hex':'1451', 'name':'mnc', 'technology':'Mobile Network Code vendor extension'},
-mandatory_parameter_lists = {
- 'bind_transmitter':[ # SMPP v3.4, section 4.1.1, table 4-1, page 46
- {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':'addr_ton_by_hex'},
- {'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':'addr_npi_by_hex'},
- {'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'hex_map':None}
- ],
- 'bind_transmitter_resp':[ # SMPP v3.4, section 4.1.2, table 4-2, page 47
- {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None}
- ],
- 'bind_receiver':[ # SMPP v3.4, section 4.1.3, table 4-3, page 48
- {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':'addr_ton_by_hex'},
- {'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':'addr_npi_by_hex'},
- {'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'hex_map':None}
- ],
- 'bind_receiver_resp':[ # SMPP v3.4, section 4.1.4, table 4-4, page 50
- {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None}
- ],
- 'bind_transceiver':[ # SMPP v3.4, section 4.1.5, table 4-5, page 51
- {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':'addr_ton_by_hex'},
- {'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':'addr_npi_by_hex'},
- {'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'hex_map':None}
- ],
- 'bind_transceiver_resp':[ # SMPP v3.4, section 4.1.6, table 4-6, page 52
- {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None}
- ],
- 'outbind':[ # SMPP v3.4, section 4.1.7.1, page 54
- {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'hex_map':None}
- ],
- 'unbind':[ # SMPP v3.4, section 4.2.1, table 4-7, page 56
- ],
- 'unbind_resp':[ # SMPP v3.4, section 4.2.2, table 4-8, page 56
- ],
- 'generic_nack':[ # SMPP v3.4, section 4.3.1, table 4-9, page 57
- ],
- 'submit_sm':[ # SMPP v3.4, section 4.4.1, table 4-10, page 59-61
- {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'hex_map':None}
- ],
- 'submit_sm_resp':[ # SMPP v3.4, section 4.4.2, table 4-11, page 67
- {'name':'message_id', 'min':0, 'max':65, 'var':True, 'type':'string', 'hex_map':None}
- ],
- 'submit_multi':[ # SMPP v3.4, section 4.5.1, table 4-12, page 69-71
- {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'number_of_dests', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'dest_address', 'min':2, 'max':24, 'var':True, 'type':'dest_address', 'hex_map':None},
- {'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'hex_map':None}
- ],
- 'dest_address':[ # SMPP v3.4, section 4.5.1.1, table 4-13, page 75
- {'name':'dest_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None}
- # 'sme_dest_address' or 'distribution_list' goes here
- ],
- 'sme_dest_address':[ # SMPP v3.4, section 4.5.1.1, table 4-14, page 75
- {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None}
- ],
- 'distribution_list':[ # SMPP v3.4, section 4.5.1.2, table 4-15, page 75
- {'name':'dl_name', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None}
- ],
- 'submit_multi_resp':[ # SMPP v3.4, section 4.5.2, table 4-16, page 76
- {'name':'message_id', 'min':0, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'no_unsuccess', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'unsuccess_sme', 'min':7, 'max':27, 'var':True, 'type':'unsuccess_sme', 'hex_map':None}
- ],
- 'deliver_sm':[ # SMPP v3.4, section 4.6.1, table 4-18, page 79-81
- {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'schedule_delivery_time', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'validity_period', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'hex_map':None}
- ],
- 'deliver_sm_resp':[ # SMPP v3.4, section 4.6.2, table 4-19, page 85
- {'name':'message_id', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None}
- ],
- 'data_sm':[ # SMPP v3.4, section 4.7.1, table 4-20, page 87-88
- {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'source_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'destination_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None}
- ],
- 'data_sm_resp':[ # SMPP v3.4, section 4.7.2, table 4-21, page 93
- {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None}
- ],
- 'query_sm':[ # SMPP v3.4, section 4.8.1, table 4-22, page 95
- {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None}
- ],
- 'query_sm_resp':[ # SMPP v3.4, section 4.7.2, table 4-21, page 93
- {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'final_date', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'message_state', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'error_code', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None}
- ],
- 'cancel_sm':[ # SMPP v3.4, section 4.9.1, table 4-24, page 98-99
- {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None}
- ],
- 'cancel_sm_resp':[ # SMPP v3.4, section 4.9.2, table 4-25, page 100
- ],
- 'replace_sm':[ # SMPP v3.4, section 4.10.1, table 4-26, page 102-103
- {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
- {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'hex_map':None}
- ],
- 'replace_sm_resp':[ # SMPP v3.4, section 4.10.2, table 4-27, page 104
- ],
- 'enquire_link':[ # SMPP v3.4, section 4.11.1, table 4-28, page 106
- ],
- 'enquire_link_resp':[ # SMPP v3.4, section 4.11.2, table 4-29, page 106
- ],
- 'alert_notification':[ # SMPP v3.4, section 4.12.1, table 4-30, page 108
- {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'source_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'esme_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
- {'name':'esme_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
- {'name':'esme_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
- ]
+ 'PDC_MessageClass' :{'hex':'1101', 'name':'PDC_MessageClass', 'technology':'? (J-Phone)'}, # v4 page 75
+ 'PDC_PresentationOption' :{'hex':'1102', 'name':'PDC_PresentationOption', 'technology':'? (J-Phone)'}, # v4 page 76
+ 'PDC_AlertMechanism' :{'hex':'1103', 'name':'PDC_AlertMechanism', 'technology':'? (J-Phone)'}, # v4 page 76
+ 'PDC_Teleservice' :{'hex':'1104', 'name':'PDC_Teleservice', 'technology':'? (J-Phone)'}, # v4 page 77
+ 'PDC_MultiPartMessage' :{'hex':'1105', 'name':'PDC_MultiPartMessage', 'technology':'? (J-Phone)'}, # v4 page 77
+ 'PDC_PredefinedMsg' :{'hex':'1106', 'name':'PDC_PredefinedMsg', 'technology':'? (J-Phone)'} # v4 page 78
}
-def mandatory_parameter_list_by_command_name(command_name):
- return mandatory_parameter_lists.get(command_name,[])
+def optional_parameter_tag_hex_by_name(n):
+ return optional_parameter_tag_by_name.get(n,{}).get('hex')
def octpop(hex_ref):
octet = None
if len(hex_ref[0]) > 1:
(octet, hex_ref[0]) = (hex_ref[0][0:2], hex_ref[0][2: ])
return octet
def decode_hex_type(data, hex_type, hex_ref=['']):
if hex_type == 'integer':
return int(data, 16)
elif hex_type == 'string':
return binascii.b2a_qp(binascii.a2b_hex(re.sub('00','',data)))
elif hex_type == 'dest_address':
return data #TODO need a better function here
elif hex_type == 'unsuccess_sme':
return data #TODO need a better function here
else:
return data
def decode_body(command, body_hex):
body = {}
body['mandatory_parameters'] = None
if command != None:
fields = mandatory_parameter_list_by_command_name(command)
(body['mandatory_parameters'], optional_parameters_hex) = \
decode_mandatory_parameters(fields, [body_hex])
body['optional_parameters'] = decode_optional_parameters(optional_parameters_hex)
return body
def unpack_pdu(pdu_bin):
pdu_hex = binascii.b2a_hex(pdu_bin)
(command_length, command_id, command_status, sequence_number, body_hex) = \
(pdu_hex[0:8], pdu_hex[8:16], pdu_hex[16:24], pdu_hex[24:32], pdu_hex[32: ])
length = int(command_length, 16)
command = command_id_name_by_hex(command_id)
status = command_status_name_by_hex(command_status)
sequence = int(sequence_number, 16)
print '\n--------incoming--------'
print command_length, length
print command_id, command
print command_status, status
print sequence_number, sequence
print body_hex
print pdu_hex
print '------------------------\n'
pdu = {}
pdu['length'] = length
pdu['command'] = command
pdu['status'] = status
pdu['sequence'] = sequence
pdu['body'] = decode_body(command, body_hex)
print pdu
return pdu
def pack_pdu(command='bind_transmitter', status='ESME_ROK', sequence=0, body_hex=''):
length = 16 + len(body_hex)/2
command_length = '%08x' % length
command_id = command_id_hex_by_name(command)
command_status = command_status_hex_by_name(status)
sequence_number = '%08x' % sequence
pdu_hex = command_length + command_id + command_status + sequence_number + body_hex
print '\n--------outgoing--------'
print command_length, length
print command_id, command
print command_status, status
print sequence_number, sequence
print body_hex
print pdu_hex
print '------------------------\n'
return binascii.a2b_hex(pdu_hex)
def decode_mandatory_parameters(fields, hex_ref):
mandatory_parameters = {}
print "<<<< mand hex >>>", repr(hex_ref[0])
if len(hex_ref[0]) > 1:
for field in fields:
data = ''
octet = ''
count = 0
if field['var'] != True and field['var'] != False:
for i in range(mandatory_parameters[field['var']]):
if len(hex_ref[0]) > 1:
data += octpop(hex_ref)
else:
while (len(hex_ref[0]) > 1
and (count < field['min']
or (count < field['max']
and (octet != '00')))):
octet = octpop(hex_ref)
data += octet
count += 1
if field['hex_map'] != None:
mandatory_parameters[field['name']] = maps.get(field['hex_map'],{data:data})[data]
else:
mandatory_parameters[field['name']] = decode_hex_type(data, field['type'])
return (mandatory_parameters, hex_ref[0])
def encode_mandatory_parameters(fields, json):
mandatory_hex = ''
return mandatory_hex
def decode_optional_parameters(optional_parameters_hex):
optional_parameters = []
data = optional_parameters_hex
while len(data) > 0:
(tag_hex, length_hex, rest) = (data[0:4], data[4:8], data[8: ])
tag = optional_parameter_tag_name_by_hex(tag_hex)
length = int(length_hex, 16)
(value_hex, tail) = (rest[0:length*2], rest[length*2: ])
if len(value_hex) == 0:
value = 0 #TODO remove after testing
else:
value = int(value_hex, 16) #TODO need decoding mapping
data = tail
optional_parameters.append({'tag':tag, 'length':length, 'value':value})
return optional_parameters
def encode_optional_parameter(tag, value):
optional_hex = ''
tag_hex = optional_parameter_tag_hex_by_name(tag)
if tag_hex != None:
value_hex = '%02x' % value #TODO need encoding mapping
length_hex = '%04x' % (len(value_hex)/2)
optional_hex = tag_hex + length_hex + value_hex
return optional_hex
def json_to_pdu(json):
body_hex = ''
body = json.get('body', {})
for opt in body.get('optional_parameters',[]):
body_hex += encode_optional_parameter(opt['tag'], opt['value'])
return pack_pdu(json['command'], json['status'], json['sequence'], body_hex)
|
dmaclay/python-smpp
|
1c9efbc33e0a3b19386787bb88064353fc4dc2f1
|
put most small tables into master map
|
diff --git a/smpp/pdu.py b/smpp/pdu.py
index f943aac..cf231d6 100644
--- a/smpp/pdu.py
+++ b/smpp/pdu.py
@@ -1,915 +1,917 @@
import binascii
import re
+maps = {} # Inserting certain referenced dicts in here means they can be declared in the same order as in the spec.
+
# SMPP Error Codes (ESME) - SMPP v3.4, section 5.1.3, table 5-2, page 112-114
command_status_by_hex = {
'00000000':{'hex':'00000000', 'name':'ESME_ROK', 'description':'No error'},
'00000001':{'hex':'00000001', 'name':'ESME_RINVMSGLEN', 'description':'Message Length is invalid'},
'00000002':{'hex':'00000002', 'name':'ESME_RINVCMDLEN', 'description':'Command Length is invalid'},
'00000003':{'hex':'00000003', 'name':'ESME_RINVCMDID', 'description':'Invalid Command ID'},
'00000004':{'hex':'00000004', 'name':'ESME_RINVBNDSTS', 'description':'Incorrect BIND Status for given command'},
'00000005':{'hex':'00000005', 'name':'ESME_RALYBND', 'description':'ESME Already in bound state'},
'00000006':{'hex':'00000006', 'name':'ESME_RINVPRTFLG', 'description':'Invalid priority flag'},
'00000007':{'hex':'00000007', 'name':'ESME_RINVREGDLVFLG', 'description':'Invalid registered delivery flag'},
'00000008':{'hex':'00000008', 'name':'ESME_RSYSERR', 'description':'System Error'},
'0000000a':{'hex':'0000000a', 'name':'ESME_RINVSRCADR', 'description':'Invalid source address'},
'0000000b':{'hex':'0000000b', 'name':'ESME_RINVDSTADR', 'description':'Invalid destination address'},
'0000000c':{'hex':'0000000c', 'name':'ESME_RINVMSGID', 'description':'Message ID is invalid'},
'0000000d':{'hex':'0000000d', 'name':'ESME_RBINDFAIL', 'description':'Bind failed'},
'0000000e':{'hex':'0000000e', 'name':'ESME_RINVPASWD', 'description':'Invalid password'},
'0000000f':{'hex':'0000000f', 'name':'ESME_RINVSYSID', 'description':'Invalid System ID'},
'00000011':{'hex':'00000011', 'name':'ESME_RCANCELFAIL', 'description':'Cancel SM Failed'},
'00000013':{'hex':'00000013', 'name':'ESME_RREPLACEFAIL', 'description':'Replace SM Failed'},
'00000014':{'hex':'00000014', 'name':'ESME_RMSGQFUL', 'description':'Message queue full'},
'00000015':{'hex':'00000015', 'name':'ESME_RINVSERTYP', 'description':'Invalid service type'},
'00000033':{'hex':'00000033', 'name':'ESME_RINVNUMDESTS', 'description':'Invalid number of destinations'},
'00000034':{'hex':'00000034', 'name':'ESME_RINVDLNAME', 'description':'Invalid distribution list name'},
'00000040':{'hex':'00000040', 'name':'ESME_RINVDESTFLAG', 'description':'Destination flag is invalid (submit_multi)'},
'00000042':{'hex':'00000042', 'name':'ESME_RINVSUBREP', 'description':"Invalid `submit with replace' request (i.e. submit_sm with replace_if_present_flag set)"},
'00000043':{'hex':'00000043', 'name':'ESME_RINVESMCLASS', 'description':'Invalid esm_class field data'},
'00000044':{'hex':'00000044', 'name':'ESME_RCNTSUBDL', 'description':'Cannot submit to distribution list'},
'00000045':{'hex':'00000045', 'name':'ESME_RSUBMITFAIL', 'description':'submit_sm or submit_multi failed'},
'00000048':{'hex':'00000048', 'name':'ESME_RINVSRCTON', 'description':'Invalid source address TON'},
'00000049':{'hex':'00000049', 'name':'ESME_RINVSRCNPI', 'description':'Invalid source address NPI'},
'00000050':{'hex':'00000050', 'name':'ESME_RINVDSTTON', 'description':'Invalid destination address TON'},
'00000051':{'hex':'00000051', 'name':'ESME_RINVDSTNPI', 'description':'Invalid destination address NPI'},
'00000053':{'hex':'00000053', 'name':'ESME_RINVSYSTYP', 'description':'Invalid system_type field'},
'00000054':{'hex':'00000054', 'name':'ESME_RINVREPFLAG', 'description':'Invalid replace_if_present flag'},
'00000055':{'hex':'00000055', 'name':'ESME_RINVNUMMSGS', 'description':'Invalid number of messages'},
'00000058':{'hex':'00000058', 'name':'ESME_RTHROTTLED', 'description':'Throttling error (ESME has exceeded allowed message limits)'},
'00000061':{'hex':'00000061', 'name':'ESME_RINVSCHED', 'description':'Invalid scheduled delivery time'},
'00000062':{'hex':'00000062', 'name':'ESME_RINVEXPIRY', 'description':'Invalid message validity period (expiry time)'},
'00000063':{'hex':'00000063', 'name':'ESME_RINVDFTMSGID', 'description':'Predefined message invalid or not found'},
'00000064':{'hex':'00000064', 'name':'ESME_RX_T_APPN', 'description':'ESME Receiver Temporary App Error Code'},
'00000065':{'hex':'00000065', 'name':'ESME_RX_P_APPN', 'description':'ESME Receiver Permanent App Error Code'},
'00000066':{'hex':'00000066', 'name':'ESME_RX_R_APPN', 'description':'ESME Receiver Reject Message Error Code'},
'00000067':{'hex':'00000067', 'name':'ESME_RQUERYFAIL', 'description':'query_sm request failed'},
'000000c0':{'hex':'000000c0', 'name':'ESME_RINVOPTPARSTREAM', 'description':'Error in the optional part of the PDU Body'},
'000000c1':{'hex':'000000c1', 'name':'ESME_ROPTPARNOTALLWD', 'description':'Optional paramenter not allowed'},
'000000c2':{'hex':'000000c2', 'name':'ESME_RINVPARLEN', 'description':'Invalid parameter length'},
'000000c3':{'hex':'000000c3', 'name':'ESME_RMISSINGOPTPARAM', 'description':'Expected optional parameter missing'},
'000000c4':{'hex':'000000c4', 'name':'ESME_RINVOPTPARAMVAL', 'description':'Invalid optional parameter value'},
'000000fe':{'hex':'000000fe', 'name':'ESME_RDELIVERYFAILURE', 'description':'Delivery Failure (used for data_sm_resp)'},
'000000ff':{'hex':'000000ff', 'name':'ESME_RUNKNOWNERR', 'description':'Unknown error'}
}
def command_status_name_by_hex(x):
return command_status_by_hex.get(x,{}).get('name')
command_status_by_name = {
'ESME_ROK' :{'hex':'00000000', 'name':'ESME_ROK', 'description':'No error'},
'ESME_RINVMSGLEN' :{'hex':'00000001', 'name':'ESME_RINVMSGLEN', 'description':'Message Length is invalid'},
'ESME_RINVCMDLEN' :{'hex':'00000002', 'name':'ESME_RINVCMDLEN', 'description':'Command Length is invalid'},
'ESME_RINVCMDID' :{'hex':'00000003', 'name':'ESME_RINVCMDID', 'description':'Invalid Command ID'},
'ESME_RINVBNDSTS' :{'hex':'00000004', 'name':'ESME_RINVBNDSTS', 'description':'Incorrect BIND Status for given command'},
'ESME_RALYBND' :{'hex':'00000005', 'name':'ESME_RALYBND', 'description':'ESME Already in bound state'},
'ESME_RINVPRTFLG' :{'hex':'00000006', 'name':'ESME_RINVPRTFLG', 'description':'Invalid priority flag'},
'ESME_RINVREGDLVFLG' :{'hex':'00000007', 'name':'ESME_RINVREGDLVFLG', 'description':'Invalid registered delivery flag'},
'ESME_RSYSERR' :{'hex':'00000008', 'name':'ESME_RSYSERR', 'description':'System Error'},
'ESME_RINVSRCADR' :{'hex':'0000000a', 'name':'ESME_RINVSRCADR', 'description':'Invalid source address'},
'ESME_RINVDSTADR' :{'hex':'0000000b', 'name':'ESME_RINVDSTADR', 'description':'Invalid destination address'},
'ESME_RINVMSGID' :{'hex':'0000000c', 'name':'ESME_RINVMSGID', 'description':'Message ID is invalid'},
'ESME_RBINDFAIL' :{'hex':'0000000d', 'name':'ESME_RBINDFAIL', 'description':'Bind failed'},
'ESME_RINVPASWD' :{'hex':'0000000e', 'name':'ESME_RINVPASWD', 'description':'Invalid password'},
'ESME_RINVSYSID' :{'hex':'0000000f', 'name':'ESME_RINVSYSID', 'description':'Invalid System ID'},
'ESME_RCANCELFAIL' :{'hex':'00000011', 'name':'ESME_RCANCELFAIL', 'description':'Cancel SM Failed'},
'ESME_RREPLACEFAIL' :{'hex':'00000013', 'name':'ESME_RREPLACEFAIL', 'description':'Replace SM Failed'},
'ESME_RMSGQFUL' :{'hex':'00000014', 'name':'ESME_RMSGQFUL', 'description':'Message queue full'},
'ESME_RINVSERTYP' :{'hex':'00000015', 'name':'ESME_RINVSERTYP', 'description':'Invalid service type'},
'ESME_RINVNUMDESTS' :{'hex':'00000033', 'name':'ESME_RINVNUMDESTS', 'description':'Invalid number of destinations'},
'ESME_RINVDLNAME' :{'hex':'00000034', 'name':'ESME_RINVDLNAME', 'description':'Invalid distribution list name'},
'ESME_RINVDESTFLAG' :{'hex':'00000040', 'name':'ESME_RINVDESTFLAG', 'description':'Destination flag is invalid (submit_multi)'},
'ESME_RINVSUBREP' :{'hex':'00000042', 'name':'ESME_RINVSUBREP', 'description':"Invalid `submit with replace' request (i.e. submit_sm with replace_if_present_flag set)"},
'ESME_RINVESMCLASS' :{'hex':'00000043', 'name':'ESME_RINVESMCLASS', 'description':'Invalid esm_class field data'},
'ESME_RCNTSUBDL' :{'hex':'00000044', 'name':'ESME_RCNTSUBDL', 'description':'Cannot submit to distribution list'},
'ESME_RSUBMITFAIL' :{'hex':'00000045', 'name':'ESME_RSUBMITFAIL', 'description':'submit_sm or submit_multi failed'},
'ESME_RINVSRCTON' :{'hex':'00000048', 'name':'ESME_RINVSRCTON', 'description':'Invalid source address TON'},
'ESME_RINVSRCNPI' :{'hex':'00000049', 'name':'ESME_RINVSRCNPI', 'description':'Invalid source address NPI'},
'ESME_RINVDSTTON' :{'hex':'00000050', 'name':'ESME_RINVDSTTON', 'description':'Invalid destination address TON'},
'ESME_RINVDSTNPI' :{'hex':'00000051', 'name':'ESME_RINVDSTNPI', 'description':'Invalid destination address NPI'},
'ESME_RINVSYSTYP' :{'hex':'00000053', 'name':'ESME_RINVSYSTYP', 'description':'Invalid system_type field'},
'ESME_RINVREPFLAG' :{'hex':'00000054', 'name':'ESME_RINVREPFLAG', 'description':'Invalid replace_if_present flag'},
'ESME_RINVNUMMSGS' :{'hex':'00000055', 'name':'ESME_RINVNUMMSGS', 'description':'Invalid number of messages'},
'ESME_RTHROTTLED' :{'hex':'00000058', 'name':'ESME_RTHROTTLED', 'description':'Throttling error (ESME has exceeded allowed message limits)'},
'ESME_RINVSCHED' :{'hex':'00000061', 'name':'ESME_RINVSCHED', 'description':'Invalid scheduled delivery time'},
'ESME_RINVEXPIRY' :{'hex':'00000062', 'name':'ESME_RINVEXPIRY', 'description':'Invalid message validity period (expiry time)'},
'ESME_RINVDFTMSGID' :{'hex':'00000063', 'name':'ESME_RINVDFTMSGID', 'description':'Predefined message invalid or not found'},
'ESME_RX_T_APPN' :{'hex':'00000064', 'name':'ESME_RX_T_APPN', 'description':'ESME Receiver Temporary App Error Code'},
'ESME_RX_P_APPN' :{'hex':'00000065', 'name':'ESME_RX_P_APPN', 'description':'ESME Receiver Permanent App Error Code'},
'ESME_RX_R_APPN' :{'hex':'00000066', 'name':'ESME_RX_R_APPN', 'description':'ESME Receiver Reject Message Error Code'},
'ESME_RQUERYFAIL' :{'hex':'00000067', 'name':'ESME_RQUERYFAIL', 'description':'query_sm request failed'},
'ESME_RINVOPTPARSTREAM':{'hex':'000000c0', 'name':'ESME_RINVOPTPARSTREAM', 'description':'Error in the optional part of the PDU Body'},
'ESME_ROPTPARNOTALLWD' :{'hex':'000000c1', 'name':'ESME_ROPTPARNOTALLWD', 'description':'Optional paramenter not allowed'},
'ESME_RINVPARLEN' :{'hex':'000000c2', 'name':'ESME_RINVPARLEN', 'description':'Invalid parameter length'},
'ESME_RMISSINGOPTPARAM':{'hex':'000000c3', 'name':'ESME_RMISSINGOPTPARAM', 'description':'Expected optional parameter missing'},
'ESME_RINVOPTPARAMVAL' :{'hex':'000000c4', 'name':'ESME_RINVOPTPARAMVAL', 'description':'Invalid optional parameter value'},
'ESME_RDELIVERYFAILURE':{'hex':'000000fe', 'name':'ESME_RDELIVERYFAILURE', 'description':'Delivery Failure (used for data_sm_resp)'},
'ESME_RUNKNOWNERR' :{'hex':'000000ff', 'name':'ESME_RUNKNOWNERR', 'description':'Unknown error'}
}
def command_status_hex_by_name(n):
return command_status_by_name.get(n,{}).get('hex')
# Type of Number (TON) - SMPP v3.4, section 5.2.5, table 5-3, page 117
-addr_ton_by_name = {
+maps['addr_ton_by_name'] = {
'unknown' :'00',
'international' :'01',
'national' :'02',
'network_specific' :'03',
'subscriber_number':'04',
'alphanumeric' :'05',
'abbreviated' :'06'
}
-addr_ton_by_hex = {
+maps['addr_ton_by_hex'] = {
'00':'unknown',
'01':'international',
'02':'national',
'03':'network_specific',
'04':'subscriber_number',
'05':'alphanumeric',
'06':'abbreviated'
}
# Numberic Plan Indicator (NPI) - SMPP v3.4, section 5.2.6, table 5-4, page 118
-addr_npi_by_name = {
+maps['addr_npi_by_name'] = {
'unknown' :'00',
'ISDN' :'01',
'data' :'03',
'telex' :'04',
'land_mobile':'06',
'national' :'08',
'private' :'09',
'ERMES' :'0a',
'internet' :'0e',
'WAP' :'12'
}
-addr_npi_by_hex = {
+maps['addr_npi_by_hex'] = {
'00':'unknown',
'01':'ISDN',
'03':'data',
'04':'telex',
'06':'land_mobile',
'08':'national',
'09':'private',
'0a':'ERMES',
'0e':'internet',
'12':'WAP'
}
# ESM Class bits - SMPP v3.4, section 5.2.12, page 121
-esm_class_bits = {
+maps['esm_class_bits'] = {
'mode_mask' :'03',
'type_mask' :'3c',
'feature_mask' :'c0',
'mode_default' :'00',
'mode_datagram' :'01',
'mode_forward' :'02',
'mode_store_and_forward' :'03',
'type_default' :'00',
'type_delivery_receipt' :'04',
'type_delivery_ack' :'08',
'type_0011' :'0a',
'type_user_ack' :'10',
'type_0101' :'14',
'type_conversation_abort' :'18',
'type_0111' :'1a',
'type_intermed_deliv_notif' :'20',
'type_1001' :'24',
'type_1010' :'28',
'type_1011' :'2a',
'type_1100' :'30',
'type_1101' :'34',
'type_1110' :'38',
'type_1111' :'3a',
'feature_none' :'00',
'feature_UDHI' :'40',
'feature_reply_path' :'80',
'feature_UDHI_and_reply_path':'c0'
}
# Registered Delivery bits - SMPP v3.4, section 5.2.17, page 124
-registered_delivery_bits = {
+maps['registered_delivery_bits'] = {
'receipt_mask' :'03',
'ack_mask' :'0c',
'intermed_notif_mask' :'80',
'receipt_none' :'00',
'receipt_always' :'01',
'receipt_on_fail' :'02',
'receipt_res' :'03',
'ack_none' :'00',
'ack_delivery' :'04',
'ack_user' :'08',
'ack_delivery_and_user':'0c',
'intermed_notif_none' :'00',
'intermed_notif' :'10'
}
# submit_multi dest_flag constants - SMPP v3.4, section 5.2.25, page 129
-dest_flag_by_name = {
+maps['dest_flag_by_name'] = {
'SME_Address':1,
'dist_list' :2
}
# Message State codes returned in query_sm_resp PDUs - SMPP v3.4, section 5.2.28, table 5-6, page 130
-message_state_by_name = {
+maps['message_state_by_name'] = {
'ENROUTE' :1,
'DELIVERED' :2,
'EXPIRED' :3,
'DELETED' :4,
'UNDELIVERABLE':5,
'ACCEPTED' :6,
'UNKNOWN' :7,
'REJECTED' :8
}
# Facility Code bits for SMPP v4
-facility_code_bits = {
+maps['facility_code_bits'] = {
'GF_PVCY' :'00000001',
'GF_SUBADDR':'00000002',
'NF_CC' :'00080000',
'NF_PDC' :'00010000',
'NF_IS136' :'00020000',
'NF_IS95A' :'00040000'
}
# Optional Parameter Tags - SMPP v3.4, section 5.3.2, Table 5-7, page 132-133
optional_parameter_tag_by_hex = {
'0005':{'hex':'0005', 'name':'dest_addr_subunit', 'technology':'GSM'},
'0006':{'hex':'0006', 'name':'dest_network_type', 'technology':'Generic'},
'0007':{'hex':'0007', 'name':'dest_bearer_type', 'technology':'Generic'},
'0008':{'hex':'0008', 'name':'dest_telematics_id', 'technology':'GSM'},
'000d':{'hex':'000d', 'name':'source_addr_subunit', 'technology':'GSM'},
'000e':{'hex':'000e', 'name':'source_network_type', 'technology':'Generic'},
'000f':{'hex':'000f', 'name':'source_bearer_type', 'technology':'Generic'},
'0010':{'hex':'0010', 'name':'source_telematics_id', 'technology':'GSM'},
'0017':{'hex':'0017', 'name':'qos_time_to_live', 'technology':'Generic'},
'0019':{'hex':'0019', 'name':'payload_type', 'technology':'Generic'},
'001d':{'hex':'001d', 'name':'additional_status_info_text', 'technology':'Generic'},
'001e':{'hex':'001e', 'name':'receipted_message_id', 'technology':'Generic'},
'0030':{'hex':'0030', 'name':'ms_msg_wait_facilities', 'technology':'GSM'},
'0101':{'hex':'0101', 'name':'PVCY_AuthenticationStr', 'technology':'? (J-Phone)'}, # v4 page 58-62
'0201':{'hex':'0201', 'name':'privacy_indicator', 'technology':'CDMA,TDMA'},
'0202':{'hex':'0202', 'name':'source_subaddress', 'technology':'CDMA,TDMA'}, # v4 page 65-67
'0203':{'hex':'0203', 'name':'dest_subaddress', 'technology':'CDMA,TDMA'}, # v4 page 65-67
'0204':{'hex':'0204', 'name':'user_message_reference', 'technology':'Generic'},
'0205':{'hex':'0205', 'name':'user_response_code', 'technology':'CDMA,TDMA'},
'020a':{'hex':'020a', 'name':'source_port', 'technology':'WAP'},
'020b':{'hex':'020b', 'name':'destination_port', 'technology':'WAP'},
'020c':{'hex':'020c', 'name':'sar_msg_ref_num', 'technology':'Generic'},
'020d':{'hex':'020d', 'name':'language_indicator', 'technology':'CDMA,TDMA'},
'020e':{'hex':'020e', 'name':'sar_total_segments', 'technology':'Generic'},
'020f':{'hex':'020f', 'name':'sar_segment_seqnum', 'technology':'Generic'},
'0210':{'hex':'0210', 'name':'sc_interface_version', 'technology':'Generic'},
'0301':{'hex':'0301', 'name':'CC_CBN', 'technology':'V4'}, # v4 page 70
'0302':{'hex':'0302', 'name':'callback_num_pres_ind', 'technology':'TDMA'}, # v4 page 71
'0303':{'hex':'0303', 'name':'callback_num_atag', 'technology':'TDMA'}, # v4 page 71
'0304':{'hex':'0304', 'name':'number_of_messages', 'technology':'CDMA'}, # v4 page 72
'0381':{'hex':'0381', 'name':'callback_num', 'technology':'CDMA,TDMA,GSM,iDEN'},
'0420':{'hex':'0420', 'name':'dpf_result', 'technology':'Generic'},
'0421':{'hex':'0421', 'name':'set_dpf', 'technology':'Generic'},
'0422':{'hex':'0422', 'name':'ms_availability_status', 'technology':'Generic'},
'0423':{'hex':'0423', 'name':'network_error_code', 'technology':'Generic'},
'0424':{'hex':'0424', 'name':'message_payload', 'technology':'Generic'},
'0425':{'hex':'0425', 'name':'delivery_failure_reason', 'technology':'Generic'},
'0426':{'hex':'0426', 'name':'more_messages_to_send', 'technology':'GSM'},
'0427':{'hex':'0427', 'name':'message_state', 'technology':'Generic'},
'0428':{'hex':'0428', 'name':'congestion_state', 'technology':'Generic'},
'0501':{'hex':'0501', 'name':'ussd_service_op', 'technology':'GSM (USSD)'},
'0600':{'hex':'0600', 'name':'broadcast_channel_indicator', 'technology':'GSM'},
'0601':{'hex':'0601', 'name':'broadcast_content_type', 'technology':'CDMA, TDMA, GSM'},
'0602':{'hex':'0602', 'name':'broadcast_content_type_info', 'technology':'CDMA, TDMA'},
'0603':{'hex':'0603', 'name':'broadcast_message_class', 'technology':'GSM'},
'0604':{'hex':'0604', 'name':'broadcast_rep_num', 'technology':'GSM'},
'0605':{'hex':'0605', 'name':'broadcast_frequency_interval', 'technology':'CDMA, TDMA, GSM'},
'0606':{'hex':'0606', 'name':'broadcast_area_identifier', 'technology':'CDMA, TDMA, GSM'},
'0607':{'hex':'0607', 'name':'broadcast_error_status', 'technology':'CDMA, TDMA, GSM'},
'0608':{'hex':'0608', 'name':'broadcast_area_success', 'technology':'GSM'},
'0609':{'hex':'0609', 'name':'broadcast_end_time', 'technology':'CDMA, TDMA, GSM'},
'060a':{'hex':'060a', 'name':'broadcast_service_group', 'technology':'CDMA, TDMA'},
'060b':{'hex':'060b', 'name':'billing_identification', 'technology':'Generic'},
'060d':{'hex':'060d', 'name':'source_network_id', 'technology':'Generic'},
'060e':{'hex':'060e', 'name':'dest_network_id', 'technology':'Generic'},
'060f':{'hex':'060f', 'name':'source_node_id', 'technology':'Generic'},
'0610':{'hex':'0610', 'name':'dest_node_id', 'technology':'Generic'},
'0611':{'hex':'0611', 'name':'dest_addr_np_resolution', 'technology':'CDMA, TDMA (US Only)'},
'0612':{'hex':'0612', 'name':'dest_addr_np_information', 'technology':'CDMA, TDMA (US Only)'},
'0613':{'hex':'0613', 'name':'dest_addr_np_country', 'technology':'CDMA, TDMA (US Only)'},
'1201':{'hex':'1201', 'name':'display_time', 'technology':'CDMA,TDMA'},
'1203':{'hex':'1203', 'name':'sms_signal', 'technology':'TDMA'},
'1204':{'hex':'1204', 'name':'ms_validity', 'technology':'CDMA,TDMA'},
'1304':{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'technology':'CDMA'}, # v4 page 85
'1306':{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'technology':'CDMA'}, # v4 page 86
'130c':{'hex':'130c', 'name':'alert_on_message_delivery', 'technology':'CDMA'},
'1380':{'hex':'1380', 'name':'its_reply_type', 'technology':'CDMA'},
'1383':{'hex':'1383', 'name':'its_session_info', 'technology':'CDMA Korean [KORITS]'},
'1402':{'hex':'1402', 'name':'operator_id', 'technology':'vendor extension'},
'1403':{'hex':'1403', 'name':'tariff', 'technology':'Mobile Network Code vendor extension'},
'1450':{'hex':'1450', 'name':'mcc', 'technology':'Mobile Country Code vendor extension'},
'1451':{'hex':'1451', 'name':'mnc', 'technology':'Mobile Network Code vendor extension'},
'1101':{'hex':'1101', 'name':'PDC_MessageClass', 'technology':'? (J-Phone)'}, # v4 page 75
'1102':{'hex':'1102', 'name':'PDC_PresentationOption', 'technology':'? (J-Phone)'}, # v4 page 76
'1103':{'hex':'1103', 'name':'PDC_AlertMechanism', 'technology':'? (J-Phone)'}, # v4 page 76
'1104':{'hex':'1104', 'name':'PDC_Teleservice', 'technology':'? (J-Phone)'}, # v4 page 77
'1105':{'hex':'1105', 'name':'PDC_MultiPartMessage', 'technology':'? (J-Phone)'}, # v4 page 77
'1106':{'hex':'1106', 'name':'PDC_PredefinedMsg', 'technology':'? (J-Phone)'} # v4 page 78
}
def optional_parameter_tag_name_by_hex(x):
return optional_parameter_tag_by_hex.get(x,{}).get('name')
optional_parameter_tag_by_name = {
'dest_addr_subunit' :{'hex':'0005', 'name':'dest_addr_subunit', 'technology':'GSM'},
'dest_network_type' :{'hex':'0006', 'name':'dest_network_type', 'technology':'Generic'},
'dest_bearer_type' :{'hex':'0007', 'name':'dest_bearer_type', 'technology':'Generic'},
'dest_telematics_id' :{'hex':'0008', 'name':'dest_telematics_id', 'technology':'GSM'},
'source_addr_subunit' :{'hex':'000d', 'name':'source_addr_subunit', 'technology':'GSM'},
'source_network_type' :{'hex':'000e', 'name':'source_network_type', 'technology':'Generic'},
'source_bearer_type' :{'hex':'000f', 'name':'source_bearer_type', 'technology':'Generic'},
'source_telematics_id' :{'hex':'0010', 'name':'source_telematics_id', 'technology':'GSM'},
'qos_time_to_live' :{'hex':'0017', 'name':'qos_time_to_live', 'technology':'Generic'},
'payload_type' :{'hex':'0019', 'name':'payload_type', 'technology':'Generic'},
'additional_status_info_text' :{'hex':'001d', 'name':'additional_status_info_text', 'technology':'Generic'},
'receipted_message_id' :{'hex':'001e', 'name':'receipted_message_id', 'technology':'Generic'},
'ms_msg_wait_facilities' :{'hex':'0030', 'name':'ms_msg_wait_facilities', 'technology':'GSM'},
'PVCY_AuthenticationStr' :{'hex':'0101', 'name':'PVCY_AuthenticationStr', 'technology':'? (J-Phone)'}, # v4 page 58-62
'privacy_indicator' :{'hex':'0201', 'name':'privacy_indicator', 'technology':'CDMA,TDMA'},
'source_subaddress' :{'hex':'0202', 'name':'source_subaddress', 'technology':'CDMA,TDMA'}, # v4 page 65-67
'dest_subaddress' :{'hex':'0203', 'name':'dest_subaddress', 'technology':'CDMA,TDMA'}, # v4 page 65-67
'user_message_reference' :{'hex':'0204', 'name':'user_message_reference', 'technology':'Generic'},
'user_response_code' :{'hex':'0205', 'name':'user_response_code', 'technology':'CDMA,TDMA'},
'source_port' :{'hex':'020a', 'name':'source_port', 'technology':'WAP'},
'destination_port' :{'hex':'020b', 'name':'destination_port', 'technology':'WAP'},
'sar_msg_ref_num' :{'hex':'020c', 'name':'sar_msg_ref_num', 'technology':'Generic'},
'language_indicator' :{'hex':'020d', 'name':'language_indicator', 'technology':'CDMA,TDMA'},
'sar_total_segments' :{'hex':'020e', 'name':'sar_total_segments', 'technology':'Generic'},
'sar_segment_seqnum' :{'hex':'020f', 'name':'sar_segment_seqnum', 'technology':'Generic'},
'sc_interface_version' :{'hex':'0210', 'name':'sc_interface_version', 'technology':'Generic'},
'CC_CBN' :{'hex':'0301', 'name':'CC_CBN', 'technology':'V4'}, # v4 page 70
'callback_num_pres_ind' :{'hex':'0302', 'name':'callback_num_pres_ind', 'technology':'TDMA'}, # v4 page 71
'callback_num_atag' :{'hex':'0303', 'name':'callback_num_atag', 'technology':'TDMA'}, # v4 page 71
'number_of_messages' :{'hex':'0304', 'name':'number_of_messages', 'technology':'CDMA'}, # v4 page 72
'callback_num' :{'hex':'0381', 'name':'callback_num', 'technology':'CDMA,TDMA,GSM,iDEN'},
'dpf_result' :{'hex':'0420', 'name':'dpf_result', 'technology':'Generic'},
'set_dpf' :{'hex':'0421', 'name':'set_dpf', 'technology':'Generic'},
'ms_availability_status' :{'hex':'0422', 'name':'ms_availability_status', 'technology':'Generic'},
'network_error_code' :{'hex':'0423', 'name':'network_error_code', 'technology':'Generic'},
'message_payload' :{'hex':'0424', 'name':'message_payload', 'technology':'Generic'},
'delivery_failure_reason' :{'hex':'0425', 'name':'delivery_failure_reason', 'technology':'Generic'},
'more_messages_to_send' :{'hex':'0426', 'name':'more_messages_to_send', 'technology':'GSM'},
'message_state' :{'hex':'0427', 'name':'message_state', 'technology':'Generic'},
'congestion_state' :{'hex':'0428', 'name':'congestion_state', 'technology':'Generic'},
'ussd_service_op' :{'hex':'0501', 'name':'ussd_service_op', 'technology':'GSM (USSD)'},
'broadcast_channel_indicator' :{'hex':'0600', 'name':'broadcast_channel_indicator', 'technology':'GSM'},
'broadcast_content_type' :{'hex':'0601', 'name':'broadcast_content_type', 'technology':'CDMA, TDMA, GSM'},
'broadcast_content_type_info' :{'hex':'0602', 'name':'broadcast_content_type_info', 'technology':'CDMA, TDMA'},
'broadcast_message_class' :{'hex':'0603', 'name':'broadcast_message_class', 'technology':'GSM'},
'broadcast_rep_num' :{'hex':'0604', 'name':'broadcast_rep_num', 'technology':'GSM'},
'broadcast_frequency_interval':{'hex':'0605', 'name':'broadcast_frequency_interval', 'technology':'CDMA, TDMA, GSM'},
'broadcast_area_identifier' :{'hex':'0606', 'name':'broadcast_area_identifier', 'technology':'CDMA, TDMA, GSM'},
'broadcast_error_status' :{'hex':'0607', 'name':'broadcast_error_status', 'technology':'CDMA, TDMA, GSM'},
'broadcast_area_success' :{'hex':'0608', 'name':'broadcast_area_success', 'technology':'GSM'},
'broadcast_end_time' :{'hex':'0609', 'name':'broadcast_end_time', 'technology':'CDMA, TDMA, GSM'},
'broadcast_service_group' :{'hex':'060a', 'name':'broadcast_service_group', 'technology':'CDMA, TDMA'},
'billing_identification' :{'hex':'060b', 'name':'billing_identification', 'technology':'Generic'},
'source_network_id' :{'hex':'060d', 'name':'source_network_id', 'technology':'Generic'},
'dest_network_id' :{'hex':'060e', 'name':'dest_network_id', 'technology':'Generic'},
'source_node_id' :{'hex':'060f', 'name':'source_node_id', 'technology':'Generic'},
'dest_node_id' :{'hex':'0610', 'name':'dest_node_id', 'technology':'Generic'},
'dest_addr_np_resolution' :{'hex':'0611', 'name':'dest_addr_np_resolution', 'technology':'CDMA, TDMA (US Only)'},
'dest_addr_np_information' :{'hex':'0612', 'name':'dest_addr_np_information', 'technology':'CDMA, TDMA (US Only)'},
'dest_addr_np_country' :{'hex':'0613', 'name':'dest_addr_np_country', 'technology':'CDMA, TDMA (US Only)'},
'display_time' :{'hex':'1201', 'name':'display_time', 'technology':'CDMA,TDMA'},
'sms_signal' :{'hex':'1203', 'name':'sms_signal', 'technology':'TDMA'},
'ms_validity' :{'hex':'1204', 'name':'ms_validity', 'technology':'CDMA,TDMA'},
'IS95A_AlertOnDelivery' :{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'technology':'CDMA'}, # v4 page 85
'IS95A_LanguageIndicator' :{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'technology':'CDMA'}, # v4 page 86
'alert_on_message_delivery' :{'hex':'130c', 'name':'alert_on_message_delivery', 'technology':'CDMA'},
'its_reply_type' :{'hex':'1380', 'name':'its_reply_type', 'technology':'CDMA'},
'its_session_info' :{'hex':'1383', 'name':'its_session_info', 'technology':'CDMA Korean [KORITS]'},
'operator_id' :{'hex':'1402', 'name':'operator_id', 'technology':'vendor extension'},
'tariff' :{'hex':'1403', 'name':'tariff', 'technology':'Mobile Network Code vendor extension'},
'mcc' :{'hex':'1450', 'name':'mcc', 'technology':'Mobile Country Code vendor extension'},
'mnc' :{'hex':'1451', 'name':'mnc', 'technology':'Mobile Network Code vendor extension'},
'PDC_MessageClass' :{'hex':'1101', 'name':'PDC_MessageClass', 'technology':'? (J-Phone)'}, # v4 page 75
'PDC_PresentationOption' :{'hex':'1102', 'name':'PDC_PresentationOption', 'technology':'? (J-Phone)'}, # v4 page 76
'PDC_AlertMechanism' :{'hex':'1103', 'name':'PDC_AlertMechanism', 'technology':'? (J-Phone)'}, # v4 page 76
'PDC_Teleservice' :{'hex':'1104', 'name':'PDC_Teleservice', 'technology':'? (J-Phone)'}, # v4 page 77
'PDC_MultiPartMessage' :{'hex':'1105', 'name':'PDC_MultiPartMessage', 'technology':'? (J-Phone)'}, # v4 page 77
'PDC_PredefinedMsg' :{'hex':'1106', 'name':'PDC_PredefinedMsg', 'technology':'? (J-Phone)'} # v4 page 78
}
def optional_parameter_tag_hex_by_name(n):
return optional_parameter_tag_by_name.get(n,{}).get('hex')
# Command IDs - SMPP v3.4, section 5.1.2.1, table 5-1, page 110-111
command_id_by_hex = {
'80000000':{'hex':'80000000', 'name':'generic_nack'},
'00000001':{'hex':'00000001', 'name':'bind_receiver'},
'80000001':{'hex':'80000001', 'name':'bind_receiver_resp'},
'00000002':{'hex':'00000002', 'name':'bind_transmitter'},
'80000002':{'hex':'80000002', 'name':'bind_transmitter_resp'},
'00000003':{'hex':'00000003', 'name':'query_sm'},
'80000003':{'hex':'80000003', 'name':'query_sm_resp'},
'00000004':{'hex':'00000004', 'name':'submit_sm'},
'80000004':{'hex':'80000004', 'name':'submit_sm_resp'},
'00000005':{'hex':'00000005', 'name':'deliver_sm'},
'80000005':{'hex':'80000005', 'name':'deliver_sm_resp'},
'00000006':{'hex':'00000006', 'name':'unbind'},
'80000006':{'hex':'80000006', 'name':'unbind_resp'},
'00000007':{'hex':'00000007', 'name':'replace_sm'},
'80000007':{'hex':'80000007', 'name':'replace_sm_resp'},
'00000008':{'hex':'00000008', 'name':'cancel_sm'},
'80000008':{'hex':'80000008', 'name':'cancel_sm_resp'},
'00000009':{'hex':'00000009', 'name':'bind_transceiver'},
'80000009':{'hex':'80000009', 'name':'bind_transceiver_resp'},
'0000000b':{'hex':'0000000b', 'name':'outbind'},
'00000015':{'hex':'00000015', 'name':'enquire_link'},
'80000015':{'hex':'80000015', 'name':'enquire_link_resp'},
'00000021':{'hex':'00000021', 'name':'submit_multi'},
'80000021':{'hex':'80000021', 'name':'submit_multi_resp'},
'00000102':{'hex':'00000102', 'name':'alert_notification'},
'00000103':{'hex':'00000103', 'name':'data_sm'},
'80000103':{'hex':'80000103', 'name':'data_sm_resp'},
# v4 codes
'80010000':{'hex':'80010000', 'name':'generic_nack_v4'},
'00010001':{'hex':'00010001', 'name':'bind_receiver_v4'},
'80010001':{'hex':'80010001', 'name':'bind_receiver_resp_v4'},
'00010002':{'hex':'00010002', 'name':'bind_transmitter_v4'},
'80010002':{'hex':'80010002', 'name':'bind_transmitter_resp_v4'},
'00010003':{'hex':'00010003', 'name':'query_sm_v4'},
'80010003':{'hex':'80010003', 'name':'query_sm_resp_v4'},
'00010004':{'hex':'00010004', 'name':'submit_sm_v4'},
'80010004':{'hex':'80010004', 'name':'submit_sm_resp_v4'},
'00010005':{'hex':'00010005', 'name':'deliver_sm_v4'},
'80010005':{'hex':'80010005', 'name':'deliver_sm_resp_v4'},
'00010006':{'hex':'00010006', 'name':'unbind_v4'},
'80010006':{'hex':'80010006', 'name':'unbind_resp_v4'},
'00010007':{'hex':'00010007', 'name':'replace_sm_v4'},
'80010007':{'hex':'80010007', 'name':'replace_sm_resp_v4'},
'00010008':{'hex':'00010008', 'name':'cancel_sm_v4'},
'80010008':{'hex':'80010008', 'name':'cancel_sm_resp_v4'},
'00010009':{'hex':'00010009', 'name':'delivery_receipt_v4'},
'80010009':{'hex':'80010009', 'name':'delivery_receipt_resp_v4'},
'0001000a':{'hex':'0001000a', 'name':'enquire_link_v4'},
'8001000a':{'hex':'8001000a', 'name':'enquire_link_resp_v4'},
'0001000b':{'hex':'0001000b', 'name':'outbind_v4'},
}
def command_id_name_by_hex(x):
return command_id_by_hex.get(x,{}).get('name')
command_id_by_name = {
'generic_nack' :{'hex':'80000000', 'name':'generic_nack'},
'bind_receiver' :{'hex':'00000001', 'name':'bind_receiver'},
'bind_receiver_resp' :{'hex':'80000001', 'name':'bind_receiver_resp'},
'bind_transmitter' :{'hex':'00000002', 'name':'bind_transmitter'},
'bind_transmitter_resp' :{'hex':'80000002', 'name':'bind_transmitter_resp'},
'query_sm' :{'hex':'00000003', 'name':'query_sm'},
'query_sm_resp' :{'hex':'80000003', 'name':'query_sm_resp'},
'submit_sm' :{'hex':'00000004', 'name':'submit_sm'},
'submit_sm_resp' :{'hex':'80000004', 'name':'submit_sm_resp'},
'deliver_sm' :{'hex':'00000005', 'name':'deliver_sm'},
'deliver_sm_resp' :{'hex':'80000005', 'name':'deliver_sm_resp'},
'unbind' :{'hex':'00000006', 'name':'unbind'},
'unbind_resp' :{'hex':'80000006', 'name':'unbind_resp'},
'replace_sm' :{'hex':'00000007', 'name':'replace_sm'},
'replace_sm_resp' :{'hex':'80000007', 'name':'replace_sm_resp'},
'cancel_sm' :{'hex':'00000008', 'name':'cancel_sm'},
'cancel_sm_resp' :{'hex':'80000008', 'name':'cancel_sm_resp'},
'bind_transceiver' :{'hex':'00000009', 'name':'bind_transceiver'},
'bind_transceiver_resp' :{'hex':'80000009', 'name':'bind_transceiver_resp'},
'outbind' :{'hex':'0000000b', 'name':'outbind'},
'enquire_link' :{'hex':'00000015', 'name':'enquire_link'},
'enquire_link_resp' :{'hex':'80000015', 'name':'enquire_link_resp'},
'submit_multi' :{'hex':'00000021', 'name':'submit_multi'},
'submit_multi_resp' :{'hex':'80000021', 'name':'submit_multi_resp'},
'alert_notification' :{'hex':'00000102', 'name':'alert_notification'},
'data_sm' :{'hex':'00000103', 'name':'data_sm'},
'data_sm_resp' :{'hex':'80000103', 'name':'data_sm_resp'},
# v4 codes
'generic_nack_v4' :{'hex':'80010000', 'name':'generic_nack_v4'},
'bind_receiver_v4' :{'hex':'00010001', 'name':'bind_receiver_v4'},
'bind_receiver_resp_v4' :{'hex':'80010001', 'name':'bind_receiver_resp_v4'},
'bind_transmitter_v4' :{'hex':'00010002', 'name':'bind_transmitter_v4'},
'bind_transmitter_resp_v4':{'hex':'80010002', 'name':'bind_transmitter_resp_v4'},
'query_sm_v4' :{'hex':'00010003', 'name':'query_sm_v4'},
'query_sm_resp_v4' :{'hex':'80010003', 'name':'query_sm_resp_v4'},
'submit_sm_v4' :{'hex':'00010004', 'name':'submit_sm_v4'},
'submit_sm_resp_v4' :{'hex':'80010004', 'name':'submit_sm_resp_v4'},
'deliver_sm_v4' :{'hex':'00010005', 'name':'deliver_sm_v4'},
'deliver_sm_resp_v4' :{'hex':'80010005', 'name':'deliver_sm_resp_v4'},
'unbind_v4' :{'hex':'00010006', 'name':'unbind_v4'},
'unbind_resp_v4' :{'hex':'80010006', 'name':'unbind_resp_v4'},
'replace_sm_v4' :{'hex':'00010007', 'name':'replace_sm_v4'},
'replace_sm_resp_v4' :{'hex':'80010007', 'name':'replace_sm_resp_v4'},
'cancel_sm_v4' :{'hex':'00010008', 'name':'cancel_sm_v4'},
'cancel_sm_resp_v4' :{'hex':'80010008', 'name':'cancel_sm_resp_v4'},
'delivery_receipt_v4' :{'hex':'00010009', 'name':'delivery_receipt_v4'},
'delivery_receipt_resp_v4':{'hex':'80010009', 'name':'delivery_receipt_resp_v4'},
'enquire_link_v4' :{'hex':'0001000a', 'name':'enquire_link_v4'},
'enquire_link_resp_v4' :{'hex':'8001000a', 'name':'enquire_link_resp_v4'},
'outbind_v4' :{'hex':'0001000b', 'name':'outbind_v4'}
}
def command_id_hex_by_name(n):
return command_id_by_name.get(n,{}).get('hex')
mandatory_parameter_lists = {
'bind_transmitter':[ # SMPP v3.4, section 4.1.1, table 4-1, page 46
{'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None},
{'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'hex_map':None},
{'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'hex_map':None},
{'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':addr_ton_by_hex},
- {'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':addr_npi_by_hex},
+ {'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':'addr_ton_by_hex'},
+ {'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':'addr_npi_by_hex'},
{'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'hex_map':None}
],
'bind_transmitter_resp':[ # SMPP v3.4, section 4.1.2, table 4-2, page 47
{'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None}
],
'bind_receiver':[ # SMPP v3.4, section 4.1.3, table 4-3, page 48
{'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None},
{'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'hex_map':None},
{'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'hex_map':None},
{'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':addr_ton_by_hex},
- {'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':addr_npi_by_hex},
+ {'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':'addr_ton_by_hex'},
+ {'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':'addr_npi_by_hex'},
{'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'hex_map':None}
],
'bind_receiver_resp':[ # SMPP v3.4, section 4.1.4, table 4-4, page 50
{'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None}
],
'bind_transceiver':[ # SMPP v3.4, section 4.1.5, table 4-5, page 51
{'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None},
{'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'hex_map':None},
{'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'hex_map':None},
{'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None},
- {'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':addr_ton_by_hex},
- {'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':addr_npi_by_hex},
+ {'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':'addr_ton_by_hex'},
+ {'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':'addr_npi_by_hex'},
{'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'hex_map':None}
],
'bind_transceiver_resp':[ # SMPP v3.4, section 4.1.6, table 4-6, page 52
{'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None}
],
'outbind':[ # SMPP v3.4, section 4.1.7.1, page 54
{'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None},
{'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'hex_map':None}
],
'unbind':[ # SMPP v3.4, section 4.2.1, table 4-7, page 56
],
'unbind_resp':[ # SMPP v3.4, section 4.2.2, table 4-8, page 56
],
'generic_nack':[ # SMPP v3.4, section 4.3.1, table 4-9, page 57
],
'submit_sm':[ # SMPP v3.4, section 4.4.1, table 4-10, page 59-61
{'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_ton_by_hex},
- {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_npi_by_hex},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_ton_by_hex},
- {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_npi_by_hex},
+ {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
{'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
{'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
{'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
{'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'hex_map':None}
],
'submit_sm_resp':[ # SMPP v3.4, section 4.4.2, table 4-11, page 67
{'name':'message_id', 'min':0, 'max':65, 'var':True, 'type':'string', 'hex_map':None}
],
'submit_multi':[ # SMPP v3.4, section 4.5.1, table 4-12, page 69-71
{'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_ton_by_hex},
- {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_npi_by_hex},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
{'name':'number_of_dests', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'dest_address', 'min':2, 'max':24, 'var':True, 'type':'dest_address', 'hex_map':None},
{'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
{'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
{'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'hex_map':None}
],
'dest_address':[ # SMPP v3.4, section 4.5.1.1, table 4-13, page 75
{'name':'dest_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None}
# 'sme_dest_address' or 'distribution_list' goes here
],
'sme_dest_address':[ # SMPP v3.4, section 4.5.1.1, table 4-14, page 75
- {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_ton_by_hex},
- {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_npi_by_hex},
+ {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
{'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None}
],
'distribution_list':[ # SMPP v3.4, section 4.5.1.2, table 4-15, page 75
{'name':'dl_name', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None}
],
'submit_multi_resp':[ # SMPP v3.4, section 4.5.2, table 4-16, page 76
{'name':'message_id', 'min':0, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
{'name':'no_unsuccess', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'unsuccess_sme', 'min':7, 'max':27, 'var':True, 'type':'unsuccess_sme', 'hex_map':None}
],
'deliver_sm':[ # SMPP v3.4, section 4.6.1, table 4-18, page 79-81
{'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_ton_by_hex},
- {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_npi_by_hex},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_ton_by_hex},
- {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_npi_by_hex},
+ {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
{'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
{'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'schedule_delivery_time', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None},
{'name':'validity_period', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None},
{'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'hex_map':None}
],
'deliver_sm_resp':[ # SMPP v3.4, section 4.6.2, table 4-19, page 85
{'name':'message_id', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None}
],
'data_sm':[ # SMPP v3.4, section 4.7.1, table 4-20, page 87-88
{'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_ton_by_hex},
- {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_npi_by_hex},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
{'name':'source_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_ton_by_hex},
- {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_npi_by_hex},
+ {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
{'name':'destination_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
{'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None}
],
'data_sm_resp':[ # SMPP v3.4, section 4.7.2, table 4-21, page 93
{'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None}
],
'query_sm':[ # SMPP v3.4, section 4.8.1, table 4-22, page 95
{'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_ton_by_hex},
- {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_npi_by_hex},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None}
],
'query_sm_resp':[ # SMPP v3.4, section 4.7.2, table 4-21, page 93
{'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
{'name':'final_date', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
{'name':'message_state', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'error_code', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None}
],
'cancel_sm':[ # SMPP v3.4, section 4.9.1, table 4-24, page 98-99
{'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
{'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_ton_by_hex},
- {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_npi_by_hex},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_ton_by_hex},
- {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_npi_by_hex},
+ {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
{'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None}
],
'cancel_sm_resp':[ # SMPP v3.4, section 4.9.2, table 4-25, page 100
],
'replace_sm':[ # SMPP v3.4, section 4.10.1, table 4-26, page 102-103
{'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_ton_by_hex},
- {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_npi_by_hex},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
{'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
{'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
{'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
{'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
{'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'hex_map':None}
],
'replace_sm_resp':[ # SMPP v3.4, section 4.10.2, table 4-27, page 104
],
'enquire_link':[ # SMPP v3.4, section 4.11.1, table 4-28, page 106
],
'enquire_link_resp':[ # SMPP v3.4, section 4.11.2, table 4-29, page 106
],
'alert_notification':[ # SMPP v3.4, section 4.12.1, table 4-30, page 108
- {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_ton_by_hex},
- {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_npi_by_hex},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
{'name':'source_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
- {'name':'esme_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_ton_by_hex},
- {'name':'esme_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_npi_by_hex},
+ {'name':'esme_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_ton_by_hex'},
+ {'name':'esme_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':'addr_npi_by_hex'},
{'name':'esme_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
]
}
def mandatory_parameter_list_by_command_name(command_name):
return mandatory_parameter_lists.get(command_name,[])
def octpop(hex_ref):
octet = None
if len(hex_ref[0]) > 1:
(octet, hex_ref[0]) = (hex_ref[0][0:2], hex_ref[0][2: ])
return octet
def decode_hex_type(data, hex_type, hex_ref=['']):
if hex_type == 'integer':
return int(data, 16)
elif hex_type == 'string':
return binascii.b2a_qp(binascii.a2b_hex(re.sub('00','',data)))
elif hex_type == 'dest_address':
return data #TODO need a better function here
elif hex_type == 'unsuccess_sme':
return data #TODO need a better function here
else:
return data
def decode_body(command, body_hex):
body = {}
body['mandatory_parameters'] = None
if command != None:
fields = mandatory_parameter_list_by_command_name(command)
(body['mandatory_parameters'], optional_parameters_hex) = \
decode_mandatory_parameters(fields, [body_hex])
body['optional_parameters'] = decode_optional_parameters(optional_parameters_hex)
return body
def unpack_pdu(pdu_bin):
pdu_hex = binascii.b2a_hex(pdu_bin)
(command_length, command_id, command_status, sequence_number, body_hex) = \
(pdu_hex[0:8], pdu_hex[8:16], pdu_hex[16:24], pdu_hex[24:32], pdu_hex[32: ])
length = int(command_length, 16)
command = command_id_name_by_hex(command_id)
status = command_status_name_by_hex(command_status)
sequence = int(sequence_number, 16)
print '\n--------incoming--------'
print command_length, length
print command_id, command
print command_status, status
print sequence_number, sequence
print body_hex
print pdu_hex
print '------------------------\n'
pdu = {}
pdu['length'] = length
pdu['command'] = command
pdu['status'] = status
pdu['sequence'] = sequence
pdu['body'] = decode_body(command, body_hex)
print pdu
return pdu
def pack_pdu(command='bind_transmitter', status='ESME_ROK', sequence=0, body_hex=''):
length = 16 + len(body_hex)/2
command_length = '%08x' % length
command_id = command_id_hex_by_name(command)
command_status = command_status_hex_by_name(status)
sequence_number = '%08x' % sequence
pdu_hex = command_length + command_id + command_status + sequence_number + body_hex
print '\n--------outgoing--------'
print command_length, length
print command_id, command
print command_status, status
print sequence_number, sequence
print body_hex
print pdu_hex
print '------------------------\n'
return binascii.a2b_hex(pdu_hex)
def decode_mandatory_parameters(fields, hex_ref):
mandatory_parameters = {}
print "<<<< mand hex >>>", repr(hex_ref[0])
if len(hex_ref[0]) > 1:
for field in fields:
data = ''
octet = ''
count = 0
if field['var'] != True and field['var'] != False:
for i in range(mandatory_parameters[field['var']]):
if len(hex_ref[0]) > 1:
data += octpop(hex_ref)
else:
while (len(hex_ref[0]) > 1
and (count < field['min']
or (count < field['max']
and (octet != '00')))):
octet = octpop(hex_ref)
data += octet
count += 1
if field['hex_map'] != None:
- mandatory_parameters[field['name']] = field.get('hex_map',{data:data})[data]
+ mandatory_parameters[field['name']] = maps.get(field['hex_map'],{data:data})[data]
else:
mandatory_parameters[field['name']] = decode_hex_type(data, field['type'])
return (mandatory_parameters, hex_ref[0])
def encode_mandatory_parameters(fields, json):
mandatory_hex = ''
return mandatory_hex
def decode_optional_parameters(optional_parameters_hex):
optional_parameters = []
data = optional_parameters_hex
while len(data) > 0:
(tag_hex, length_hex, rest) = (data[0:4], data[4:8], data[8: ])
tag = optional_parameter_tag_name_by_hex(tag_hex)
length = int(length_hex, 16)
(value_hex, tail) = (rest[0:length*2], rest[length*2: ])
if len(value_hex) == 0:
value = 0 #TODO remove after testing
else:
value = int(value_hex, 16) #TODO need decoding mapping
data = tail
optional_parameters.append({'tag':tag, 'length':length, 'value':value})
return optional_parameters
def encode_optional_parameter(tag, value):
optional_hex = ''
tag_hex = optional_parameter_tag_hex_by_name(tag)
if tag_hex != None:
value_hex = '%02x' % value #TODO need encoding mapping
length_hex = '%04x' % (len(value_hex)/2)
optional_hex = tag_hex + length_hex + value_hex
return optional_hex
def json_to_pdu(json):
body_hex = ''
body = json.get('body', {})
for opt in body.get('optional_parameters',[]):
body_hex += encode_optional_parameter(opt['tag'], opt['value'])
return pack_pdu(json['command'], json['status'], json['sequence'], body_hex)
|
dmaclay/python-smpp
|
daac274eb9696cb6fe35b542577a1a328484e19f
|
major refactoring - dropping unecessarily indirect functions
|
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..c4e79a4
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,4 @@
+*.swp
+*.pyc
+*.egg-info
+
diff --git a/LICENCE b/LICENCE
new file mode 100644
index 0000000..08cd4b2
--- /dev/null
+++ b/LICENCE
@@ -0,0 +1,18 @@
+Copyright (c) Praekelt Foundation and individual contributors.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+ 1. Redistributions of source code must retain the above copyright notice,
+ this list of conditions and the following disclaimer.
+
+ 2. Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+
+ 3. Neither the name of the Praekelt Foundation nor the names of its
+ contributors may be used to endorse or promote products derived from
+ this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
diff --git a/README b/README
new file mode 100644
index 0000000..e69de29
diff --git a/smpp/__init__.py b/smpp/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/smpp/esme.py b/smpp/esme.py
new file mode 100644
index 0000000..435835b
--- /dev/null
+++ b/smpp/esme.py
@@ -0,0 +1,34 @@
+import socket
+
+from pdu import *
+
+
+class ESME:
+
+ def __init__(self):
+ self.conn = None
+
+ def connect_SMSC(self, host='127.0.0.1', port=2775):
+ self.conn = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+ self.conn.connect((host, port))
+
+ def disconnect_SMSC(self):
+ self.conn.close()
+
+
+ def bind_SMSC(self):
+ out_hex = re.sub(' ','','00 00 00 2F 00 00 00 02 00 00 00 00 00 00 00 01 53 4D 50 50 33 54 45 53 54 00 73 65 63 72 65 74 30 38 00 53 55 42 4D 49 54 31 00 00 01 01 00')
+ print '<<<< bind_SMSC out_hex >>>>', out_hex
+ out_bin = binascii.a2b_hex(out_hex)
+ self.conn.send(out_bin)
+ length_bin = self.conn.recv(4)
+ length = int(binascii.b2a_hex(length_bin),16)
+ rest_bin = self.conn.recv(length-4)
+ unpack_pdu(length_bin + rest_bin)
+
+
+esme = ESME()
+esme.connect_SMSC('localhost')
+esme.bind_SMSC()
+esme.disconnect_SMSC()
+
diff --git a/smpp/pdu.py b/smpp/pdu.py
new file mode 100644
index 0000000..f943aac
--- /dev/null
+++ b/smpp/pdu.py
@@ -0,0 +1,915 @@
+import binascii
+import re
+
+
+
+# SMPP Error Codes (ESME) - SMPP v3.4, section 5.1.3, table 5-2, page 112-114
+
+command_status_by_hex = {
+ '00000000':{'hex':'00000000', 'name':'ESME_ROK', 'description':'No error'},
+ '00000001':{'hex':'00000001', 'name':'ESME_RINVMSGLEN', 'description':'Message Length is invalid'},
+ '00000002':{'hex':'00000002', 'name':'ESME_RINVCMDLEN', 'description':'Command Length is invalid'},
+ '00000003':{'hex':'00000003', 'name':'ESME_RINVCMDID', 'description':'Invalid Command ID'},
+ '00000004':{'hex':'00000004', 'name':'ESME_RINVBNDSTS', 'description':'Incorrect BIND Status for given command'},
+ '00000005':{'hex':'00000005', 'name':'ESME_RALYBND', 'description':'ESME Already in bound state'},
+ '00000006':{'hex':'00000006', 'name':'ESME_RINVPRTFLG', 'description':'Invalid priority flag'},
+ '00000007':{'hex':'00000007', 'name':'ESME_RINVREGDLVFLG', 'description':'Invalid registered delivery flag'},
+ '00000008':{'hex':'00000008', 'name':'ESME_RSYSERR', 'description':'System Error'},
+ '0000000a':{'hex':'0000000a', 'name':'ESME_RINVSRCADR', 'description':'Invalid source address'},
+ '0000000b':{'hex':'0000000b', 'name':'ESME_RINVDSTADR', 'description':'Invalid destination address'},
+ '0000000c':{'hex':'0000000c', 'name':'ESME_RINVMSGID', 'description':'Message ID is invalid'},
+ '0000000d':{'hex':'0000000d', 'name':'ESME_RBINDFAIL', 'description':'Bind failed'},
+ '0000000e':{'hex':'0000000e', 'name':'ESME_RINVPASWD', 'description':'Invalid password'},
+ '0000000f':{'hex':'0000000f', 'name':'ESME_RINVSYSID', 'description':'Invalid System ID'},
+ '00000011':{'hex':'00000011', 'name':'ESME_RCANCELFAIL', 'description':'Cancel SM Failed'},
+ '00000013':{'hex':'00000013', 'name':'ESME_RREPLACEFAIL', 'description':'Replace SM Failed'},
+ '00000014':{'hex':'00000014', 'name':'ESME_RMSGQFUL', 'description':'Message queue full'},
+ '00000015':{'hex':'00000015', 'name':'ESME_RINVSERTYP', 'description':'Invalid service type'},
+ '00000033':{'hex':'00000033', 'name':'ESME_RINVNUMDESTS', 'description':'Invalid number of destinations'},
+ '00000034':{'hex':'00000034', 'name':'ESME_RINVDLNAME', 'description':'Invalid distribution list name'},
+ '00000040':{'hex':'00000040', 'name':'ESME_RINVDESTFLAG', 'description':'Destination flag is invalid (submit_multi)'},
+ '00000042':{'hex':'00000042', 'name':'ESME_RINVSUBREP', 'description':"Invalid `submit with replace' request (i.e. submit_sm with replace_if_present_flag set)"},
+ '00000043':{'hex':'00000043', 'name':'ESME_RINVESMCLASS', 'description':'Invalid esm_class field data'},
+ '00000044':{'hex':'00000044', 'name':'ESME_RCNTSUBDL', 'description':'Cannot submit to distribution list'},
+ '00000045':{'hex':'00000045', 'name':'ESME_RSUBMITFAIL', 'description':'submit_sm or submit_multi failed'},
+ '00000048':{'hex':'00000048', 'name':'ESME_RINVSRCTON', 'description':'Invalid source address TON'},
+ '00000049':{'hex':'00000049', 'name':'ESME_RINVSRCNPI', 'description':'Invalid source address NPI'},
+ '00000050':{'hex':'00000050', 'name':'ESME_RINVDSTTON', 'description':'Invalid destination address TON'},
+ '00000051':{'hex':'00000051', 'name':'ESME_RINVDSTNPI', 'description':'Invalid destination address NPI'},
+ '00000053':{'hex':'00000053', 'name':'ESME_RINVSYSTYP', 'description':'Invalid system_type field'},
+ '00000054':{'hex':'00000054', 'name':'ESME_RINVREPFLAG', 'description':'Invalid replace_if_present flag'},
+ '00000055':{'hex':'00000055', 'name':'ESME_RINVNUMMSGS', 'description':'Invalid number of messages'},
+ '00000058':{'hex':'00000058', 'name':'ESME_RTHROTTLED', 'description':'Throttling error (ESME has exceeded allowed message limits)'},
+ '00000061':{'hex':'00000061', 'name':'ESME_RINVSCHED', 'description':'Invalid scheduled delivery time'},
+ '00000062':{'hex':'00000062', 'name':'ESME_RINVEXPIRY', 'description':'Invalid message validity period (expiry time)'},
+ '00000063':{'hex':'00000063', 'name':'ESME_RINVDFTMSGID', 'description':'Predefined message invalid or not found'},
+ '00000064':{'hex':'00000064', 'name':'ESME_RX_T_APPN', 'description':'ESME Receiver Temporary App Error Code'},
+ '00000065':{'hex':'00000065', 'name':'ESME_RX_P_APPN', 'description':'ESME Receiver Permanent App Error Code'},
+ '00000066':{'hex':'00000066', 'name':'ESME_RX_R_APPN', 'description':'ESME Receiver Reject Message Error Code'},
+ '00000067':{'hex':'00000067', 'name':'ESME_RQUERYFAIL', 'description':'query_sm request failed'},
+ '000000c0':{'hex':'000000c0', 'name':'ESME_RINVOPTPARSTREAM', 'description':'Error in the optional part of the PDU Body'},
+ '000000c1':{'hex':'000000c1', 'name':'ESME_ROPTPARNOTALLWD', 'description':'Optional paramenter not allowed'},
+ '000000c2':{'hex':'000000c2', 'name':'ESME_RINVPARLEN', 'description':'Invalid parameter length'},
+ '000000c3':{'hex':'000000c3', 'name':'ESME_RMISSINGOPTPARAM', 'description':'Expected optional parameter missing'},
+ '000000c4':{'hex':'000000c4', 'name':'ESME_RINVOPTPARAMVAL', 'description':'Invalid optional parameter value'},
+ '000000fe':{'hex':'000000fe', 'name':'ESME_RDELIVERYFAILURE', 'description':'Delivery Failure (used for data_sm_resp)'},
+ '000000ff':{'hex':'000000ff', 'name':'ESME_RUNKNOWNERR', 'description':'Unknown error'}
+}
+def command_status_name_by_hex(x):
+ return command_status_by_hex.get(x,{}).get('name')
+
+command_status_by_name = {
+ 'ESME_ROK' :{'hex':'00000000', 'name':'ESME_ROK', 'description':'No error'},
+ 'ESME_RINVMSGLEN' :{'hex':'00000001', 'name':'ESME_RINVMSGLEN', 'description':'Message Length is invalid'},
+ 'ESME_RINVCMDLEN' :{'hex':'00000002', 'name':'ESME_RINVCMDLEN', 'description':'Command Length is invalid'},
+ 'ESME_RINVCMDID' :{'hex':'00000003', 'name':'ESME_RINVCMDID', 'description':'Invalid Command ID'},
+ 'ESME_RINVBNDSTS' :{'hex':'00000004', 'name':'ESME_RINVBNDSTS', 'description':'Incorrect BIND Status for given command'},
+ 'ESME_RALYBND' :{'hex':'00000005', 'name':'ESME_RALYBND', 'description':'ESME Already in bound state'},
+ 'ESME_RINVPRTFLG' :{'hex':'00000006', 'name':'ESME_RINVPRTFLG', 'description':'Invalid priority flag'},
+ 'ESME_RINVREGDLVFLG' :{'hex':'00000007', 'name':'ESME_RINVREGDLVFLG', 'description':'Invalid registered delivery flag'},
+ 'ESME_RSYSERR' :{'hex':'00000008', 'name':'ESME_RSYSERR', 'description':'System Error'},
+ 'ESME_RINVSRCADR' :{'hex':'0000000a', 'name':'ESME_RINVSRCADR', 'description':'Invalid source address'},
+ 'ESME_RINVDSTADR' :{'hex':'0000000b', 'name':'ESME_RINVDSTADR', 'description':'Invalid destination address'},
+ 'ESME_RINVMSGID' :{'hex':'0000000c', 'name':'ESME_RINVMSGID', 'description':'Message ID is invalid'},
+ 'ESME_RBINDFAIL' :{'hex':'0000000d', 'name':'ESME_RBINDFAIL', 'description':'Bind failed'},
+ 'ESME_RINVPASWD' :{'hex':'0000000e', 'name':'ESME_RINVPASWD', 'description':'Invalid password'},
+ 'ESME_RINVSYSID' :{'hex':'0000000f', 'name':'ESME_RINVSYSID', 'description':'Invalid System ID'},
+ 'ESME_RCANCELFAIL' :{'hex':'00000011', 'name':'ESME_RCANCELFAIL', 'description':'Cancel SM Failed'},
+ 'ESME_RREPLACEFAIL' :{'hex':'00000013', 'name':'ESME_RREPLACEFAIL', 'description':'Replace SM Failed'},
+ 'ESME_RMSGQFUL' :{'hex':'00000014', 'name':'ESME_RMSGQFUL', 'description':'Message queue full'},
+ 'ESME_RINVSERTYP' :{'hex':'00000015', 'name':'ESME_RINVSERTYP', 'description':'Invalid service type'},
+ 'ESME_RINVNUMDESTS' :{'hex':'00000033', 'name':'ESME_RINVNUMDESTS', 'description':'Invalid number of destinations'},
+ 'ESME_RINVDLNAME' :{'hex':'00000034', 'name':'ESME_RINVDLNAME', 'description':'Invalid distribution list name'},
+ 'ESME_RINVDESTFLAG' :{'hex':'00000040', 'name':'ESME_RINVDESTFLAG', 'description':'Destination flag is invalid (submit_multi)'},
+ 'ESME_RINVSUBREP' :{'hex':'00000042', 'name':'ESME_RINVSUBREP', 'description':"Invalid `submit with replace' request (i.e. submit_sm with replace_if_present_flag set)"},
+ 'ESME_RINVESMCLASS' :{'hex':'00000043', 'name':'ESME_RINVESMCLASS', 'description':'Invalid esm_class field data'},
+ 'ESME_RCNTSUBDL' :{'hex':'00000044', 'name':'ESME_RCNTSUBDL', 'description':'Cannot submit to distribution list'},
+ 'ESME_RSUBMITFAIL' :{'hex':'00000045', 'name':'ESME_RSUBMITFAIL', 'description':'submit_sm or submit_multi failed'},
+ 'ESME_RINVSRCTON' :{'hex':'00000048', 'name':'ESME_RINVSRCTON', 'description':'Invalid source address TON'},
+ 'ESME_RINVSRCNPI' :{'hex':'00000049', 'name':'ESME_RINVSRCNPI', 'description':'Invalid source address NPI'},
+ 'ESME_RINVDSTTON' :{'hex':'00000050', 'name':'ESME_RINVDSTTON', 'description':'Invalid destination address TON'},
+ 'ESME_RINVDSTNPI' :{'hex':'00000051', 'name':'ESME_RINVDSTNPI', 'description':'Invalid destination address NPI'},
+ 'ESME_RINVSYSTYP' :{'hex':'00000053', 'name':'ESME_RINVSYSTYP', 'description':'Invalid system_type field'},
+ 'ESME_RINVREPFLAG' :{'hex':'00000054', 'name':'ESME_RINVREPFLAG', 'description':'Invalid replace_if_present flag'},
+ 'ESME_RINVNUMMSGS' :{'hex':'00000055', 'name':'ESME_RINVNUMMSGS', 'description':'Invalid number of messages'},
+ 'ESME_RTHROTTLED' :{'hex':'00000058', 'name':'ESME_RTHROTTLED', 'description':'Throttling error (ESME has exceeded allowed message limits)'},
+ 'ESME_RINVSCHED' :{'hex':'00000061', 'name':'ESME_RINVSCHED', 'description':'Invalid scheduled delivery time'},
+ 'ESME_RINVEXPIRY' :{'hex':'00000062', 'name':'ESME_RINVEXPIRY', 'description':'Invalid message validity period (expiry time)'},
+ 'ESME_RINVDFTMSGID' :{'hex':'00000063', 'name':'ESME_RINVDFTMSGID', 'description':'Predefined message invalid or not found'},
+ 'ESME_RX_T_APPN' :{'hex':'00000064', 'name':'ESME_RX_T_APPN', 'description':'ESME Receiver Temporary App Error Code'},
+ 'ESME_RX_P_APPN' :{'hex':'00000065', 'name':'ESME_RX_P_APPN', 'description':'ESME Receiver Permanent App Error Code'},
+ 'ESME_RX_R_APPN' :{'hex':'00000066', 'name':'ESME_RX_R_APPN', 'description':'ESME Receiver Reject Message Error Code'},
+ 'ESME_RQUERYFAIL' :{'hex':'00000067', 'name':'ESME_RQUERYFAIL', 'description':'query_sm request failed'},
+ 'ESME_RINVOPTPARSTREAM':{'hex':'000000c0', 'name':'ESME_RINVOPTPARSTREAM', 'description':'Error in the optional part of the PDU Body'},
+ 'ESME_ROPTPARNOTALLWD' :{'hex':'000000c1', 'name':'ESME_ROPTPARNOTALLWD', 'description':'Optional paramenter not allowed'},
+ 'ESME_RINVPARLEN' :{'hex':'000000c2', 'name':'ESME_RINVPARLEN', 'description':'Invalid parameter length'},
+ 'ESME_RMISSINGOPTPARAM':{'hex':'000000c3', 'name':'ESME_RMISSINGOPTPARAM', 'description':'Expected optional parameter missing'},
+ 'ESME_RINVOPTPARAMVAL' :{'hex':'000000c4', 'name':'ESME_RINVOPTPARAMVAL', 'description':'Invalid optional parameter value'},
+ 'ESME_RDELIVERYFAILURE':{'hex':'000000fe', 'name':'ESME_RDELIVERYFAILURE', 'description':'Delivery Failure (used for data_sm_resp)'},
+ 'ESME_RUNKNOWNERR' :{'hex':'000000ff', 'name':'ESME_RUNKNOWNERR', 'description':'Unknown error'}
+}
+def command_status_hex_by_name(n):
+ return command_status_by_name.get(n,{}).get('hex')
+
+
+# Type of Number (TON) - SMPP v3.4, section 5.2.5, table 5-3, page 117
+
+addr_ton_by_name = {
+ 'unknown' :'00',
+ 'international' :'01',
+ 'national' :'02',
+ 'network_specific' :'03',
+ 'subscriber_number':'04',
+ 'alphanumeric' :'05',
+ 'abbreviated' :'06'
+}
+
+addr_ton_by_hex = {
+ '00':'unknown',
+ '01':'international',
+ '02':'national',
+ '03':'network_specific',
+ '04':'subscriber_number',
+ '05':'alphanumeric',
+ '06':'abbreviated'
+}
+
+
+# Numberic Plan Indicator (NPI) - SMPP v3.4, section 5.2.6, table 5-4, page 118
+
+addr_npi_by_name = {
+ 'unknown' :'00',
+ 'ISDN' :'01',
+ 'data' :'03',
+ 'telex' :'04',
+ 'land_mobile':'06',
+ 'national' :'08',
+ 'private' :'09',
+ 'ERMES' :'0a',
+ 'internet' :'0e',
+ 'WAP' :'12'
+}
+
+addr_npi_by_hex = {
+ '00':'unknown',
+ '01':'ISDN',
+ '03':'data',
+ '04':'telex',
+ '06':'land_mobile',
+ '08':'national',
+ '09':'private',
+ '0a':'ERMES',
+ '0e':'internet',
+ '12':'WAP'
+}
+
+
+# ESM Class bits - SMPP v3.4, section 5.2.12, page 121
+
+esm_class_bits = {
+ 'mode_mask' :'03',
+ 'type_mask' :'3c',
+ 'feature_mask' :'c0',
+
+ 'mode_default' :'00',
+ 'mode_datagram' :'01',
+ 'mode_forward' :'02',
+ 'mode_store_and_forward' :'03',
+
+ 'type_default' :'00',
+ 'type_delivery_receipt' :'04',
+ 'type_delivery_ack' :'08',
+ 'type_0011' :'0a',
+ 'type_user_ack' :'10',
+ 'type_0101' :'14',
+ 'type_conversation_abort' :'18',
+ 'type_0111' :'1a',
+ 'type_intermed_deliv_notif' :'20',
+ 'type_1001' :'24',
+ 'type_1010' :'28',
+ 'type_1011' :'2a',
+ 'type_1100' :'30',
+ 'type_1101' :'34',
+ 'type_1110' :'38',
+ 'type_1111' :'3a',
+
+ 'feature_none' :'00',
+ 'feature_UDHI' :'40',
+ 'feature_reply_path' :'80',
+ 'feature_UDHI_and_reply_path':'c0'
+}
+
+
+# Registered Delivery bits - SMPP v3.4, section 5.2.17, page 124
+
+registered_delivery_bits = {
+ 'receipt_mask' :'03',
+ 'ack_mask' :'0c',
+ 'intermed_notif_mask' :'80',
+
+ 'receipt_none' :'00',
+ 'receipt_always' :'01',
+ 'receipt_on_fail' :'02',
+ 'receipt_res' :'03',
+
+ 'ack_none' :'00',
+ 'ack_delivery' :'04',
+ 'ack_user' :'08',
+ 'ack_delivery_and_user':'0c',
+
+ 'intermed_notif_none' :'00',
+ 'intermed_notif' :'10'
+}
+
+
+# submit_multi dest_flag constants - SMPP v3.4, section 5.2.25, page 129
+dest_flag_by_name = {
+ 'SME_Address':1,
+ 'dist_list' :2
+}
+
+
+# Message State codes returned in query_sm_resp PDUs - SMPP v3.4, section 5.2.28, table 5-6, page 130
+message_state_by_name = {
+ 'ENROUTE' :1,
+ 'DELIVERED' :2,
+ 'EXPIRED' :3,
+ 'DELETED' :4,
+ 'UNDELIVERABLE':5,
+ 'ACCEPTED' :6,
+ 'UNKNOWN' :7,
+ 'REJECTED' :8
+}
+
+
+# Facility Code bits for SMPP v4
+
+facility_code_bits = {
+ 'GF_PVCY' :'00000001',
+ 'GF_SUBADDR':'00000002',
+ 'NF_CC' :'00080000',
+ 'NF_PDC' :'00010000',
+ 'NF_IS136' :'00020000',
+ 'NF_IS95A' :'00040000'
+}
+
+
+# Optional Parameter Tags - SMPP v3.4, section 5.3.2, Table 5-7, page 132-133
+
+optional_parameter_tag_by_hex = {
+ '0005':{'hex':'0005', 'name':'dest_addr_subunit', 'technology':'GSM'},
+ '0006':{'hex':'0006', 'name':'dest_network_type', 'technology':'Generic'},
+ '0007':{'hex':'0007', 'name':'dest_bearer_type', 'technology':'Generic'},
+ '0008':{'hex':'0008', 'name':'dest_telematics_id', 'technology':'GSM'},
+
+ '000d':{'hex':'000d', 'name':'source_addr_subunit', 'technology':'GSM'},
+ '000e':{'hex':'000e', 'name':'source_network_type', 'technology':'Generic'},
+ '000f':{'hex':'000f', 'name':'source_bearer_type', 'technology':'Generic'},
+ '0010':{'hex':'0010', 'name':'source_telematics_id', 'technology':'GSM'},
+
+ '0017':{'hex':'0017', 'name':'qos_time_to_live', 'technology':'Generic'},
+ '0019':{'hex':'0019', 'name':'payload_type', 'technology':'Generic'},
+ '001d':{'hex':'001d', 'name':'additional_status_info_text', 'technology':'Generic'},
+ '001e':{'hex':'001e', 'name':'receipted_message_id', 'technology':'Generic'},
+ '0030':{'hex':'0030', 'name':'ms_msg_wait_facilities', 'technology':'GSM'},
+
+ '0101':{'hex':'0101', 'name':'PVCY_AuthenticationStr', 'technology':'? (J-Phone)'}, # v4 page 58-62
+
+ '0201':{'hex':'0201', 'name':'privacy_indicator', 'technology':'CDMA,TDMA'},
+ '0202':{'hex':'0202', 'name':'source_subaddress', 'technology':'CDMA,TDMA'}, # v4 page 65-67
+ '0203':{'hex':'0203', 'name':'dest_subaddress', 'technology':'CDMA,TDMA'}, # v4 page 65-67
+ '0204':{'hex':'0204', 'name':'user_message_reference', 'technology':'Generic'},
+ '0205':{'hex':'0205', 'name':'user_response_code', 'technology':'CDMA,TDMA'},
+ '020a':{'hex':'020a', 'name':'source_port', 'technology':'WAP'},
+ '020b':{'hex':'020b', 'name':'destination_port', 'technology':'WAP'},
+ '020c':{'hex':'020c', 'name':'sar_msg_ref_num', 'technology':'Generic'},
+ '020d':{'hex':'020d', 'name':'language_indicator', 'technology':'CDMA,TDMA'},
+ '020e':{'hex':'020e', 'name':'sar_total_segments', 'technology':'Generic'},
+ '020f':{'hex':'020f', 'name':'sar_segment_seqnum', 'technology':'Generic'},
+ '0210':{'hex':'0210', 'name':'sc_interface_version', 'technology':'Generic'},
+
+ '0301':{'hex':'0301', 'name':'CC_CBN', 'technology':'V4'}, # v4 page 70
+ '0302':{'hex':'0302', 'name':'callback_num_pres_ind', 'technology':'TDMA'}, # v4 page 71
+ '0303':{'hex':'0303', 'name':'callback_num_atag', 'technology':'TDMA'}, # v4 page 71
+ '0304':{'hex':'0304', 'name':'number_of_messages', 'technology':'CDMA'}, # v4 page 72
+ '0381':{'hex':'0381', 'name':'callback_num', 'technology':'CDMA,TDMA,GSM,iDEN'},
+
+ '0420':{'hex':'0420', 'name':'dpf_result', 'technology':'Generic'},
+ '0421':{'hex':'0421', 'name':'set_dpf', 'technology':'Generic'},
+ '0422':{'hex':'0422', 'name':'ms_availability_status', 'technology':'Generic'},
+ '0423':{'hex':'0423', 'name':'network_error_code', 'technology':'Generic'},
+ '0424':{'hex':'0424', 'name':'message_payload', 'technology':'Generic'},
+ '0425':{'hex':'0425', 'name':'delivery_failure_reason', 'technology':'Generic'},
+ '0426':{'hex':'0426', 'name':'more_messages_to_send', 'technology':'GSM'},
+ '0427':{'hex':'0427', 'name':'message_state', 'technology':'Generic'},
+ '0428':{'hex':'0428', 'name':'congestion_state', 'technology':'Generic'},
+
+ '0501':{'hex':'0501', 'name':'ussd_service_op', 'technology':'GSM (USSD)'},
+
+ '0600':{'hex':'0600', 'name':'broadcast_channel_indicator', 'technology':'GSM'},
+ '0601':{'hex':'0601', 'name':'broadcast_content_type', 'technology':'CDMA, TDMA, GSM'},
+ '0602':{'hex':'0602', 'name':'broadcast_content_type_info', 'technology':'CDMA, TDMA'},
+ '0603':{'hex':'0603', 'name':'broadcast_message_class', 'technology':'GSM'},
+ '0604':{'hex':'0604', 'name':'broadcast_rep_num', 'technology':'GSM'},
+ '0605':{'hex':'0605', 'name':'broadcast_frequency_interval', 'technology':'CDMA, TDMA, GSM'},
+ '0606':{'hex':'0606', 'name':'broadcast_area_identifier', 'technology':'CDMA, TDMA, GSM'},
+ '0607':{'hex':'0607', 'name':'broadcast_error_status', 'technology':'CDMA, TDMA, GSM'},
+ '0608':{'hex':'0608', 'name':'broadcast_area_success', 'technology':'GSM'},
+ '0609':{'hex':'0609', 'name':'broadcast_end_time', 'technology':'CDMA, TDMA, GSM'},
+ '060a':{'hex':'060a', 'name':'broadcast_service_group', 'technology':'CDMA, TDMA'},
+ '060b':{'hex':'060b', 'name':'billing_identification', 'technology':'Generic'},
+ '060d':{'hex':'060d', 'name':'source_network_id', 'technology':'Generic'},
+ '060e':{'hex':'060e', 'name':'dest_network_id', 'technology':'Generic'},
+ '060f':{'hex':'060f', 'name':'source_node_id', 'technology':'Generic'},
+ '0610':{'hex':'0610', 'name':'dest_node_id', 'technology':'Generic'},
+ '0611':{'hex':'0611', 'name':'dest_addr_np_resolution', 'technology':'CDMA, TDMA (US Only)'},
+ '0612':{'hex':'0612', 'name':'dest_addr_np_information', 'technology':'CDMA, TDMA (US Only)'},
+ '0613':{'hex':'0613', 'name':'dest_addr_np_country', 'technology':'CDMA, TDMA (US Only)'},
+
+ '1201':{'hex':'1201', 'name':'display_time', 'technology':'CDMA,TDMA'},
+ '1203':{'hex':'1203', 'name':'sms_signal', 'technology':'TDMA'},
+ '1204':{'hex':'1204', 'name':'ms_validity', 'technology':'CDMA,TDMA'},
+
+ '1304':{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'technology':'CDMA'}, # v4 page 85
+ '1306':{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'technology':'CDMA'}, # v4 page 86
+ '130c':{'hex':'130c', 'name':'alert_on_message_delivery', 'technology':'CDMA'},
+ '1380':{'hex':'1380', 'name':'its_reply_type', 'technology':'CDMA'},
+ '1383':{'hex':'1383', 'name':'its_session_info', 'technology':'CDMA Korean [KORITS]'},
+
+ '1402':{'hex':'1402', 'name':'operator_id', 'technology':'vendor extension'},
+ '1403':{'hex':'1403', 'name':'tariff', 'technology':'Mobile Network Code vendor extension'},
+ '1450':{'hex':'1450', 'name':'mcc', 'technology':'Mobile Country Code vendor extension'},
+ '1451':{'hex':'1451', 'name':'mnc', 'technology':'Mobile Network Code vendor extension'},
+
+ '1101':{'hex':'1101', 'name':'PDC_MessageClass', 'technology':'? (J-Phone)'}, # v4 page 75
+ '1102':{'hex':'1102', 'name':'PDC_PresentationOption', 'technology':'? (J-Phone)'}, # v4 page 76
+ '1103':{'hex':'1103', 'name':'PDC_AlertMechanism', 'technology':'? (J-Phone)'}, # v4 page 76
+ '1104':{'hex':'1104', 'name':'PDC_Teleservice', 'technology':'? (J-Phone)'}, # v4 page 77
+ '1105':{'hex':'1105', 'name':'PDC_MultiPartMessage', 'technology':'? (J-Phone)'}, # v4 page 77
+ '1106':{'hex':'1106', 'name':'PDC_PredefinedMsg', 'technology':'? (J-Phone)'} # v4 page 78
+}
+def optional_parameter_tag_name_by_hex(x):
+ return optional_parameter_tag_by_hex.get(x,{}).get('name')
+
+
+optional_parameter_tag_by_name = {
+ 'dest_addr_subunit' :{'hex':'0005', 'name':'dest_addr_subunit', 'technology':'GSM'},
+ 'dest_network_type' :{'hex':'0006', 'name':'dest_network_type', 'technology':'Generic'},
+ 'dest_bearer_type' :{'hex':'0007', 'name':'dest_bearer_type', 'technology':'Generic'},
+ 'dest_telematics_id' :{'hex':'0008', 'name':'dest_telematics_id', 'technology':'GSM'},
+
+ 'source_addr_subunit' :{'hex':'000d', 'name':'source_addr_subunit', 'technology':'GSM'},
+ 'source_network_type' :{'hex':'000e', 'name':'source_network_type', 'technology':'Generic'},
+ 'source_bearer_type' :{'hex':'000f', 'name':'source_bearer_type', 'technology':'Generic'},
+ 'source_telematics_id' :{'hex':'0010', 'name':'source_telematics_id', 'technology':'GSM'},
+
+ 'qos_time_to_live' :{'hex':'0017', 'name':'qos_time_to_live', 'technology':'Generic'},
+ 'payload_type' :{'hex':'0019', 'name':'payload_type', 'technology':'Generic'},
+ 'additional_status_info_text' :{'hex':'001d', 'name':'additional_status_info_text', 'technology':'Generic'},
+ 'receipted_message_id' :{'hex':'001e', 'name':'receipted_message_id', 'technology':'Generic'},
+ 'ms_msg_wait_facilities' :{'hex':'0030', 'name':'ms_msg_wait_facilities', 'technology':'GSM'},
+
+ 'PVCY_AuthenticationStr' :{'hex':'0101', 'name':'PVCY_AuthenticationStr', 'technology':'? (J-Phone)'}, # v4 page 58-62
+
+ 'privacy_indicator' :{'hex':'0201', 'name':'privacy_indicator', 'technology':'CDMA,TDMA'},
+ 'source_subaddress' :{'hex':'0202', 'name':'source_subaddress', 'technology':'CDMA,TDMA'}, # v4 page 65-67
+ 'dest_subaddress' :{'hex':'0203', 'name':'dest_subaddress', 'technology':'CDMA,TDMA'}, # v4 page 65-67
+ 'user_message_reference' :{'hex':'0204', 'name':'user_message_reference', 'technology':'Generic'},
+ 'user_response_code' :{'hex':'0205', 'name':'user_response_code', 'technology':'CDMA,TDMA'},
+ 'source_port' :{'hex':'020a', 'name':'source_port', 'technology':'WAP'},
+ 'destination_port' :{'hex':'020b', 'name':'destination_port', 'technology':'WAP'},
+ 'sar_msg_ref_num' :{'hex':'020c', 'name':'sar_msg_ref_num', 'technology':'Generic'},
+ 'language_indicator' :{'hex':'020d', 'name':'language_indicator', 'technology':'CDMA,TDMA'},
+ 'sar_total_segments' :{'hex':'020e', 'name':'sar_total_segments', 'technology':'Generic'},
+ 'sar_segment_seqnum' :{'hex':'020f', 'name':'sar_segment_seqnum', 'technology':'Generic'},
+ 'sc_interface_version' :{'hex':'0210', 'name':'sc_interface_version', 'technology':'Generic'},
+
+ 'CC_CBN' :{'hex':'0301', 'name':'CC_CBN', 'technology':'V4'}, # v4 page 70
+ 'callback_num_pres_ind' :{'hex':'0302', 'name':'callback_num_pres_ind', 'technology':'TDMA'}, # v4 page 71
+ 'callback_num_atag' :{'hex':'0303', 'name':'callback_num_atag', 'technology':'TDMA'}, # v4 page 71
+ 'number_of_messages' :{'hex':'0304', 'name':'number_of_messages', 'technology':'CDMA'}, # v4 page 72
+ 'callback_num' :{'hex':'0381', 'name':'callback_num', 'technology':'CDMA,TDMA,GSM,iDEN'},
+
+ 'dpf_result' :{'hex':'0420', 'name':'dpf_result', 'technology':'Generic'},
+ 'set_dpf' :{'hex':'0421', 'name':'set_dpf', 'technology':'Generic'},
+ 'ms_availability_status' :{'hex':'0422', 'name':'ms_availability_status', 'technology':'Generic'},
+ 'network_error_code' :{'hex':'0423', 'name':'network_error_code', 'technology':'Generic'},
+ 'message_payload' :{'hex':'0424', 'name':'message_payload', 'technology':'Generic'},
+ 'delivery_failure_reason' :{'hex':'0425', 'name':'delivery_failure_reason', 'technology':'Generic'},
+ 'more_messages_to_send' :{'hex':'0426', 'name':'more_messages_to_send', 'technology':'GSM'},
+ 'message_state' :{'hex':'0427', 'name':'message_state', 'technology':'Generic'},
+ 'congestion_state' :{'hex':'0428', 'name':'congestion_state', 'technology':'Generic'},
+
+ 'ussd_service_op' :{'hex':'0501', 'name':'ussd_service_op', 'technology':'GSM (USSD)'},
+
+ 'broadcast_channel_indicator' :{'hex':'0600', 'name':'broadcast_channel_indicator', 'technology':'GSM'},
+ 'broadcast_content_type' :{'hex':'0601', 'name':'broadcast_content_type', 'technology':'CDMA, TDMA, GSM'},
+ 'broadcast_content_type_info' :{'hex':'0602', 'name':'broadcast_content_type_info', 'technology':'CDMA, TDMA'},
+ 'broadcast_message_class' :{'hex':'0603', 'name':'broadcast_message_class', 'technology':'GSM'},
+ 'broadcast_rep_num' :{'hex':'0604', 'name':'broadcast_rep_num', 'technology':'GSM'},
+ 'broadcast_frequency_interval':{'hex':'0605', 'name':'broadcast_frequency_interval', 'technology':'CDMA, TDMA, GSM'},
+ 'broadcast_area_identifier' :{'hex':'0606', 'name':'broadcast_area_identifier', 'technology':'CDMA, TDMA, GSM'},
+ 'broadcast_error_status' :{'hex':'0607', 'name':'broadcast_error_status', 'technology':'CDMA, TDMA, GSM'},
+ 'broadcast_area_success' :{'hex':'0608', 'name':'broadcast_area_success', 'technology':'GSM'},
+ 'broadcast_end_time' :{'hex':'0609', 'name':'broadcast_end_time', 'technology':'CDMA, TDMA, GSM'},
+ 'broadcast_service_group' :{'hex':'060a', 'name':'broadcast_service_group', 'technology':'CDMA, TDMA'},
+ 'billing_identification' :{'hex':'060b', 'name':'billing_identification', 'technology':'Generic'},
+ 'source_network_id' :{'hex':'060d', 'name':'source_network_id', 'technology':'Generic'},
+ 'dest_network_id' :{'hex':'060e', 'name':'dest_network_id', 'technology':'Generic'},
+ 'source_node_id' :{'hex':'060f', 'name':'source_node_id', 'technology':'Generic'},
+ 'dest_node_id' :{'hex':'0610', 'name':'dest_node_id', 'technology':'Generic'},
+ 'dest_addr_np_resolution' :{'hex':'0611', 'name':'dest_addr_np_resolution', 'technology':'CDMA, TDMA (US Only)'},
+ 'dest_addr_np_information' :{'hex':'0612', 'name':'dest_addr_np_information', 'technology':'CDMA, TDMA (US Only)'},
+ 'dest_addr_np_country' :{'hex':'0613', 'name':'dest_addr_np_country', 'technology':'CDMA, TDMA (US Only)'},
+
+ 'display_time' :{'hex':'1201', 'name':'display_time', 'technology':'CDMA,TDMA'},
+ 'sms_signal' :{'hex':'1203', 'name':'sms_signal', 'technology':'TDMA'},
+ 'ms_validity' :{'hex':'1204', 'name':'ms_validity', 'technology':'CDMA,TDMA'},
+
+ 'IS95A_AlertOnDelivery' :{'hex':'1304', 'name':'IS95A_AlertOnDelivery', 'technology':'CDMA'}, # v4 page 85
+ 'IS95A_LanguageIndicator' :{'hex':'1306', 'name':'IS95A_LanguageIndicator', 'technology':'CDMA'}, # v4 page 86
+ 'alert_on_message_delivery' :{'hex':'130c', 'name':'alert_on_message_delivery', 'technology':'CDMA'},
+ 'its_reply_type' :{'hex':'1380', 'name':'its_reply_type', 'technology':'CDMA'},
+ 'its_session_info' :{'hex':'1383', 'name':'its_session_info', 'technology':'CDMA Korean [KORITS]'},
+
+ 'operator_id' :{'hex':'1402', 'name':'operator_id', 'technology':'vendor extension'},
+ 'tariff' :{'hex':'1403', 'name':'tariff', 'technology':'Mobile Network Code vendor extension'},
+ 'mcc' :{'hex':'1450', 'name':'mcc', 'technology':'Mobile Country Code vendor extension'},
+ 'mnc' :{'hex':'1451', 'name':'mnc', 'technology':'Mobile Network Code vendor extension'},
+
+ 'PDC_MessageClass' :{'hex':'1101', 'name':'PDC_MessageClass', 'technology':'? (J-Phone)'}, # v4 page 75
+ 'PDC_PresentationOption' :{'hex':'1102', 'name':'PDC_PresentationOption', 'technology':'? (J-Phone)'}, # v4 page 76
+ 'PDC_AlertMechanism' :{'hex':'1103', 'name':'PDC_AlertMechanism', 'technology':'? (J-Phone)'}, # v4 page 76
+ 'PDC_Teleservice' :{'hex':'1104', 'name':'PDC_Teleservice', 'technology':'? (J-Phone)'}, # v4 page 77
+ 'PDC_MultiPartMessage' :{'hex':'1105', 'name':'PDC_MultiPartMessage', 'technology':'? (J-Phone)'}, # v4 page 77
+ 'PDC_PredefinedMsg' :{'hex':'1106', 'name':'PDC_PredefinedMsg', 'technology':'? (J-Phone)'} # v4 page 78
+}
+def optional_parameter_tag_hex_by_name(n):
+ return optional_parameter_tag_by_name.get(n,{}).get('hex')
+
+
+# Command IDs - SMPP v3.4, section 5.1.2.1, table 5-1, page 110-111
+
+command_id_by_hex = {
+ '80000000':{'hex':'80000000', 'name':'generic_nack'},
+ '00000001':{'hex':'00000001', 'name':'bind_receiver'},
+ '80000001':{'hex':'80000001', 'name':'bind_receiver_resp'},
+ '00000002':{'hex':'00000002', 'name':'bind_transmitter'},
+ '80000002':{'hex':'80000002', 'name':'bind_transmitter_resp'},
+ '00000003':{'hex':'00000003', 'name':'query_sm'},
+ '80000003':{'hex':'80000003', 'name':'query_sm_resp'},
+ '00000004':{'hex':'00000004', 'name':'submit_sm'},
+ '80000004':{'hex':'80000004', 'name':'submit_sm_resp'},
+ '00000005':{'hex':'00000005', 'name':'deliver_sm'},
+ '80000005':{'hex':'80000005', 'name':'deliver_sm_resp'},
+ '00000006':{'hex':'00000006', 'name':'unbind'},
+ '80000006':{'hex':'80000006', 'name':'unbind_resp'},
+ '00000007':{'hex':'00000007', 'name':'replace_sm'},
+ '80000007':{'hex':'80000007', 'name':'replace_sm_resp'},
+ '00000008':{'hex':'00000008', 'name':'cancel_sm'},
+ '80000008':{'hex':'80000008', 'name':'cancel_sm_resp'},
+ '00000009':{'hex':'00000009', 'name':'bind_transceiver'},
+ '80000009':{'hex':'80000009', 'name':'bind_transceiver_resp'},
+ '0000000b':{'hex':'0000000b', 'name':'outbind'},
+ '00000015':{'hex':'00000015', 'name':'enquire_link'},
+ '80000015':{'hex':'80000015', 'name':'enquire_link_resp'},
+ '00000021':{'hex':'00000021', 'name':'submit_multi'},
+ '80000021':{'hex':'80000021', 'name':'submit_multi_resp'},
+ '00000102':{'hex':'00000102', 'name':'alert_notification'},
+ '00000103':{'hex':'00000103', 'name':'data_sm'},
+ '80000103':{'hex':'80000103', 'name':'data_sm_resp'},
+
+ # v4 codes
+
+ '80010000':{'hex':'80010000', 'name':'generic_nack_v4'},
+ '00010001':{'hex':'00010001', 'name':'bind_receiver_v4'},
+ '80010001':{'hex':'80010001', 'name':'bind_receiver_resp_v4'},
+ '00010002':{'hex':'00010002', 'name':'bind_transmitter_v4'},
+ '80010002':{'hex':'80010002', 'name':'bind_transmitter_resp_v4'},
+ '00010003':{'hex':'00010003', 'name':'query_sm_v4'},
+ '80010003':{'hex':'80010003', 'name':'query_sm_resp_v4'},
+ '00010004':{'hex':'00010004', 'name':'submit_sm_v4'},
+ '80010004':{'hex':'80010004', 'name':'submit_sm_resp_v4'},
+ '00010005':{'hex':'00010005', 'name':'deliver_sm_v4'},
+ '80010005':{'hex':'80010005', 'name':'deliver_sm_resp_v4'},
+ '00010006':{'hex':'00010006', 'name':'unbind_v4'},
+ '80010006':{'hex':'80010006', 'name':'unbind_resp_v4'},
+ '00010007':{'hex':'00010007', 'name':'replace_sm_v4'},
+ '80010007':{'hex':'80010007', 'name':'replace_sm_resp_v4'},
+ '00010008':{'hex':'00010008', 'name':'cancel_sm_v4'},
+ '80010008':{'hex':'80010008', 'name':'cancel_sm_resp_v4'},
+ '00010009':{'hex':'00010009', 'name':'delivery_receipt_v4'},
+ '80010009':{'hex':'80010009', 'name':'delivery_receipt_resp_v4'},
+ '0001000a':{'hex':'0001000a', 'name':'enquire_link_v4'},
+ '8001000a':{'hex':'8001000a', 'name':'enquire_link_resp_v4'},
+ '0001000b':{'hex':'0001000b', 'name':'outbind_v4'},
+}
+def command_id_name_by_hex(x):
+ return command_id_by_hex.get(x,{}).get('name')
+
+
+command_id_by_name = {
+ 'generic_nack' :{'hex':'80000000', 'name':'generic_nack'},
+ 'bind_receiver' :{'hex':'00000001', 'name':'bind_receiver'},
+ 'bind_receiver_resp' :{'hex':'80000001', 'name':'bind_receiver_resp'},
+ 'bind_transmitter' :{'hex':'00000002', 'name':'bind_transmitter'},
+ 'bind_transmitter_resp' :{'hex':'80000002', 'name':'bind_transmitter_resp'},
+ 'query_sm' :{'hex':'00000003', 'name':'query_sm'},
+ 'query_sm_resp' :{'hex':'80000003', 'name':'query_sm_resp'},
+ 'submit_sm' :{'hex':'00000004', 'name':'submit_sm'},
+ 'submit_sm_resp' :{'hex':'80000004', 'name':'submit_sm_resp'},
+ 'deliver_sm' :{'hex':'00000005', 'name':'deliver_sm'},
+ 'deliver_sm_resp' :{'hex':'80000005', 'name':'deliver_sm_resp'},
+ 'unbind' :{'hex':'00000006', 'name':'unbind'},
+ 'unbind_resp' :{'hex':'80000006', 'name':'unbind_resp'},
+ 'replace_sm' :{'hex':'00000007', 'name':'replace_sm'},
+ 'replace_sm_resp' :{'hex':'80000007', 'name':'replace_sm_resp'},
+ 'cancel_sm' :{'hex':'00000008', 'name':'cancel_sm'},
+ 'cancel_sm_resp' :{'hex':'80000008', 'name':'cancel_sm_resp'},
+ 'bind_transceiver' :{'hex':'00000009', 'name':'bind_transceiver'},
+ 'bind_transceiver_resp' :{'hex':'80000009', 'name':'bind_transceiver_resp'},
+ 'outbind' :{'hex':'0000000b', 'name':'outbind'},
+ 'enquire_link' :{'hex':'00000015', 'name':'enquire_link'},
+ 'enquire_link_resp' :{'hex':'80000015', 'name':'enquire_link_resp'},
+ 'submit_multi' :{'hex':'00000021', 'name':'submit_multi'},
+ 'submit_multi_resp' :{'hex':'80000021', 'name':'submit_multi_resp'},
+ 'alert_notification' :{'hex':'00000102', 'name':'alert_notification'},
+ 'data_sm' :{'hex':'00000103', 'name':'data_sm'},
+ 'data_sm_resp' :{'hex':'80000103', 'name':'data_sm_resp'},
+
+ # v4 codes
+
+ 'generic_nack_v4' :{'hex':'80010000', 'name':'generic_nack_v4'},
+ 'bind_receiver_v4' :{'hex':'00010001', 'name':'bind_receiver_v4'},
+ 'bind_receiver_resp_v4' :{'hex':'80010001', 'name':'bind_receiver_resp_v4'},
+ 'bind_transmitter_v4' :{'hex':'00010002', 'name':'bind_transmitter_v4'},
+ 'bind_transmitter_resp_v4':{'hex':'80010002', 'name':'bind_transmitter_resp_v4'},
+ 'query_sm_v4' :{'hex':'00010003', 'name':'query_sm_v4'},
+ 'query_sm_resp_v4' :{'hex':'80010003', 'name':'query_sm_resp_v4'},
+ 'submit_sm_v4' :{'hex':'00010004', 'name':'submit_sm_v4'},
+ 'submit_sm_resp_v4' :{'hex':'80010004', 'name':'submit_sm_resp_v4'},
+ 'deliver_sm_v4' :{'hex':'00010005', 'name':'deliver_sm_v4'},
+ 'deliver_sm_resp_v4' :{'hex':'80010005', 'name':'deliver_sm_resp_v4'},
+ 'unbind_v4' :{'hex':'00010006', 'name':'unbind_v4'},
+ 'unbind_resp_v4' :{'hex':'80010006', 'name':'unbind_resp_v4'},
+ 'replace_sm_v4' :{'hex':'00010007', 'name':'replace_sm_v4'},
+ 'replace_sm_resp_v4' :{'hex':'80010007', 'name':'replace_sm_resp_v4'},
+ 'cancel_sm_v4' :{'hex':'00010008', 'name':'cancel_sm_v4'},
+ 'cancel_sm_resp_v4' :{'hex':'80010008', 'name':'cancel_sm_resp_v4'},
+ 'delivery_receipt_v4' :{'hex':'00010009', 'name':'delivery_receipt_v4'},
+ 'delivery_receipt_resp_v4':{'hex':'80010009', 'name':'delivery_receipt_resp_v4'},
+ 'enquire_link_v4' :{'hex':'0001000a', 'name':'enquire_link_v4'},
+ 'enquire_link_resp_v4' :{'hex':'8001000a', 'name':'enquire_link_resp_v4'},
+ 'outbind_v4' :{'hex':'0001000b', 'name':'outbind_v4'}
+}
+def command_id_hex_by_name(n):
+ return command_id_by_name.get(n,{}).get('hex')
+
+
+mandatory_parameter_lists = {
+ 'bind_transmitter':[ # SMPP v3.4, section 4.1.1, table 4-1, page 46
+ {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None},
+ {'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':addr_ton_by_hex},
+ {'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':addr_npi_by_hex},
+ {'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'hex_map':None}
+ ],
+ 'bind_transmitter_resp':[ # SMPP v3.4, section 4.1.2, table 4-2, page 47
+ {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None}
+ ],
+ 'bind_receiver':[ # SMPP v3.4, section 4.1.3, table 4-3, page 48
+ {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None},
+ {'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':addr_ton_by_hex},
+ {'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':addr_npi_by_hex},
+ {'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'hex_map':None}
+ ],
+ 'bind_receiver_resp':[ # SMPP v3.4, section 4.1.4, table 4-4, page 50
+ {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None}
+ ],
+ 'bind_transceiver':[ # SMPP v3.4, section 4.1.5, table 4-5, page 51
+ {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'system_type', 'min':1, 'max':13, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'interface_version', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None},
+ {'name':'addr_ton', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':addr_ton_by_hex},
+ {'name':'addr_npi', 'min':1, 'max':1, 'var':False, 'type':None, 'hex_map':addr_npi_by_hex},
+ {'name':'address_range', 'min':1, 'max':41, 'var':True, 'type':'string', 'hex_map':None}
+ ],
+ 'bind_transceiver_resp':[ # SMPP v3.4, section 4.1.6, table 4-6, page 52
+ {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None}
+ ],
+ 'outbind':[ # SMPP v3.4, section 4.1.7.1, page 54
+ {'name':'system_id', 'min':1, 'max':16, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'password', 'min':1, 'max':9, 'var':True, 'type':'string', 'hex_map':None}
+ ],
+ 'unbind':[ # SMPP v3.4, section 4.2.1, table 4-7, page 56
+ ],
+ 'unbind_resp':[ # SMPP v3.4, section 4.2.2, table 4-8, page 56
+ ],
+ 'generic_nack':[ # SMPP v3.4, section 4.3.1, table 4-9, page 57
+ ],
+ 'submit_sm':[ # SMPP v3.4, section 4.4.1, table 4-10, page 59-61
+ {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_ton_by_hex},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_npi_by_hex},
+ {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_ton_by_hex},
+ {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_npi_by_hex},
+ {'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
+ {'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
+ {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'hex_map':None}
+ ],
+ 'submit_sm_resp':[ # SMPP v3.4, section 4.4.2, table 4-11, page 67
+ {'name':'message_id', 'min':0, 'max':65, 'var':True, 'type':'string', 'hex_map':None}
+ ],
+ 'submit_multi':[ # SMPP v3.4, section 4.5.1, table 4-12, page 69-71
+ {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_ton_by_hex},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_npi_by_hex},
+ {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'number_of_dests', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'dest_address', 'min':2, 'max':24, 'var':True, 'type':'dest_address', 'hex_map':None},
+ {'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
+ {'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
+ {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'hex_map':None}
+ ],
+ 'dest_address':[ # SMPP v3.4, section 4.5.1.1, table 4-13, page 75
+ {'name':'dest_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None}
+ # 'sme_dest_address' or 'distribution_list' goes here
+ ],
+ 'sme_dest_address':[ # SMPP v3.4, section 4.5.1.1, table 4-14, page 75
+ {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_ton_by_hex},
+ {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_npi_by_hex},
+ {'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None}
+ ],
+ 'distribution_list':[ # SMPP v3.4, section 4.5.1.2, table 4-15, page 75
+ {'name':'dl_name', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None}
+ ],
+ 'submit_multi_resp':[ # SMPP v3.4, section 4.5.2, table 4-16, page 76
+ {'name':'message_id', 'min':0, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'no_unsuccess', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'unsuccess_sme', 'min':7, 'max':27, 'var':True, 'type':'unsuccess_sme', 'hex_map':None}
+ ],
+ 'deliver_sm':[ # SMPP v3.4, section 4.6.1, table 4-18, page 79-81
+ {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_ton_by_hex},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_npi_by_hex},
+ {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_ton_by_hex},
+ {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_npi_by_hex},
+ {'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'protocol_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'priority_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'schedule_delivery_time', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None},
+ {'name':'validity_period', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None},
+ {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'hex_map':None}
+ ],
+ 'deliver_sm_resp':[ # SMPP v3.4, section 4.6.2, table 4-19, page 85
+ {'name':'message_id', 'min':1, 'max':1, 'var':False, 'type':'string', 'hex_map':None}
+ ],
+ 'data_sm':[ # SMPP v3.4, section 4.7.1, table 4-20, page 87-88
+ {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_ton_by_hex},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_npi_by_hex},
+ {'name':'source_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_ton_by_hex},
+ {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_npi_by_hex},
+ {'name':'destination_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'esm_class', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None}
+ ],
+ 'data_sm_resp':[ # SMPP v3.4, section 4.7.2, table 4-21, page 93
+ {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None}
+ ],
+ 'query_sm':[ # SMPP v3.4, section 4.8.1, table 4-22, page 95
+ {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_ton_by_hex},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_npi_by_hex},
+ {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None}
+ ],
+ 'query_sm_resp':[ # SMPP v3.4, section 4.7.2, table 4-21, page 93
+ {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'final_date', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
+ {'name':'message_state', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'error_code', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None}
+ ],
+ 'cancel_sm':[ # SMPP v3.4, section 4.9.1, table 4-24, page 98-99
+ {'name':'service_type', 'min':1, 'max':6, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_ton_by_hex},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_npi_by_hex},
+ {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'dest_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_ton_by_hex},
+ {'name':'dest_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_npi_by_hex},
+ {'name':'destination_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None}
+ ],
+ 'cancel_sm_resp':[ # SMPP v3.4, section 4.9.2, table 4-25, page 100
+ ],
+ 'replace_sm':[ # SMPP v3.4, section 4.10.1, table 4-26, page 102-103
+ {'name':'message_id', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_ton_by_hex},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_npi_by_hex},
+ {'name':'source_addr', 'min':1, 'max':21, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'schedule_delivery_time', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
+ {'name':'validity_period', 'min':1, 'max':17, 'var':False, 'type':'string', 'hex_map':None},
+ {'name':'registered_delivery', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'replace_if_present_flag', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'data_coding', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'sm_default_msg_id', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'sm_length', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':None},
+ {'name':'short_message', 'min':0, 'max':254, 'var':'sm_length', 'type':'string', 'hex_map':None}
+ ],
+ 'replace_sm_resp':[ # SMPP v3.4, section 4.10.2, table 4-27, page 104
+ ],
+ 'enquire_link':[ # SMPP v3.4, section 4.11.1, table 4-28, page 106
+ ],
+ 'enquire_link_resp':[ # SMPP v3.4, section 4.11.2, table 4-29, page 106
+ ],
+ 'alert_notification':[ # SMPP v3.4, section 4.12.1, table 4-30, page 108
+ {'name':'source_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_ton_by_hex},
+ {'name':'source_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_npi_by_hex},
+ {'name':'source_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
+ {'name':'esme_addr_ton', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_ton_by_hex},
+ {'name':'esme_addr_npi', 'min':1, 'max':1, 'var':False, 'type':'integer', 'hex_map':addr_npi_by_hex},
+ {'name':'esme_addr', 'min':1, 'max':65, 'var':True, 'type':'string', 'hex_map':None},
+ ]
+}
+def mandatory_parameter_list_by_command_name(command_name):
+ return mandatory_parameter_lists.get(command_name,[])
+
+
+def octpop(hex_ref):
+ octet = None
+ if len(hex_ref[0]) > 1:
+ (octet, hex_ref[0]) = (hex_ref[0][0:2], hex_ref[0][2: ])
+ return octet
+
+
+def decode_hex_type(data, hex_type, hex_ref=['']):
+ if hex_type == 'integer':
+ return int(data, 16)
+ elif hex_type == 'string':
+ return binascii.b2a_qp(binascii.a2b_hex(re.sub('00','',data)))
+ elif hex_type == 'dest_address':
+ return data #TODO need a better function here
+ elif hex_type == 'unsuccess_sme':
+ return data #TODO need a better function here
+ else:
+ return data
+
+
+def decode_body(command, body_hex):
+ body = {}
+ body['mandatory_parameters'] = None
+ if command != None:
+ fields = mandatory_parameter_list_by_command_name(command)
+ (body['mandatory_parameters'], optional_parameters_hex) = \
+ decode_mandatory_parameters(fields, [body_hex])
+ body['optional_parameters'] = decode_optional_parameters(optional_parameters_hex)
+ return body
+
+
+def unpack_pdu(pdu_bin):
+ pdu_hex = binascii.b2a_hex(pdu_bin)
+ (command_length, command_id, command_status, sequence_number, body_hex) = \
+ (pdu_hex[0:8], pdu_hex[8:16], pdu_hex[16:24], pdu_hex[24:32], pdu_hex[32: ])
+ length = int(command_length, 16)
+ command = command_id_name_by_hex(command_id)
+ status = command_status_name_by_hex(command_status)
+ sequence = int(sequence_number, 16)
+
+ print '\n--------incoming--------'
+ print command_length, length
+ print command_id, command
+ print command_status, status
+ print sequence_number, sequence
+ print body_hex
+ print pdu_hex
+ print '------------------------\n'
+
+ pdu = {}
+ pdu['length'] = length
+ pdu['command'] = command
+ pdu['status'] = status
+ pdu['sequence'] = sequence
+ pdu['body'] = decode_body(command, body_hex)
+ print pdu
+ return pdu
+
+
+def pack_pdu(command='bind_transmitter', status='ESME_ROK', sequence=0, body_hex=''):
+ length = 16 + len(body_hex)/2
+ command_length = '%08x' % length
+ command_id = command_id_hex_by_name(command)
+ command_status = command_status_hex_by_name(status)
+ sequence_number = '%08x' % sequence
+ pdu_hex = command_length + command_id + command_status + sequence_number + body_hex
+
+ print '\n--------outgoing--------'
+ print command_length, length
+ print command_id, command
+ print command_status, status
+ print sequence_number, sequence
+ print body_hex
+ print pdu_hex
+ print '------------------------\n'
+
+ return binascii.a2b_hex(pdu_hex)
+
+
+def decode_mandatory_parameters(fields, hex_ref):
+ mandatory_parameters = {}
+ print "<<<< mand hex >>>", repr(hex_ref[0])
+ if len(hex_ref[0]) > 1:
+ for field in fields:
+ data = ''
+ octet = ''
+ count = 0
+ if field['var'] != True and field['var'] != False:
+ for i in range(mandatory_parameters[field['var']]):
+ if len(hex_ref[0]) > 1:
+ data += octpop(hex_ref)
+ else:
+ while (len(hex_ref[0]) > 1
+ and (count < field['min']
+ or (count < field['max']
+ and (octet != '00')))):
+ octet = octpop(hex_ref)
+ data += octet
+ count += 1
+ if field['hex_map'] != None:
+ mandatory_parameters[field['name']] = field.get('hex_map',{data:data})[data]
+ else:
+ mandatory_parameters[field['name']] = decode_hex_type(data, field['type'])
+ return (mandatory_parameters, hex_ref[0])
+
+
+def encode_mandatory_parameters(fields, json):
+ mandatory_hex = ''
+ return mandatory_hex
+
+
+def decode_optional_parameters(optional_parameters_hex):
+ optional_parameters = []
+ data = optional_parameters_hex
+ while len(data) > 0:
+ (tag_hex, length_hex, rest) = (data[0:4], data[4:8], data[8: ])
+ tag = optional_parameter_tag_name_by_hex(tag_hex)
+ length = int(length_hex, 16)
+ (value_hex, tail) = (rest[0:length*2], rest[length*2: ])
+ if len(value_hex) == 0:
+ value = 0 #TODO remove after testing
+ else:
+ value = int(value_hex, 16) #TODO need decoding mapping
+ data = tail
+ optional_parameters.append({'tag':tag, 'length':length, 'value':value})
+ return optional_parameters
+
+
+def encode_optional_parameter(tag, value):
+ optional_hex = ''
+ tag_hex = optional_parameter_tag_hex_by_name(tag)
+ if tag_hex != None:
+ value_hex = '%02x' % value #TODO need encoding mapping
+ length_hex = '%04x' % (len(value_hex)/2)
+ optional_hex = tag_hex + length_hex + value_hex
+ return optional_hex
+
+
+def json_to_pdu(json):
+ body_hex = ''
+ body = json.get('body', {})
+ for opt in body.get('optional_parameters',[]):
+ body_hex += encode_optional_parameter(opt['tag'], opt['value'])
+ return pack_pdu(json['command'], json['status'], json['sequence'], body_hex)
+
+
diff --git a/tests.py b/tests.py
new file mode 100644
index 0000000..5f8eec5
--- /dev/null
+++ b/tests.py
@@ -0,0 +1,25 @@
+
+from smpp.esme import *
+
+#esme = ESME()
+#esme.connect_SMSC()
+
+#print str(binascii.a2b_hex(re.sub(' ','','00 00 00 3C 00 00 00 04 00 00 00 00 00 00 00 05 00 02 08 35 35 35 00 01 01 35 35 35 35 35 35 35 35 35 00 00 00 00 00 00 00 00 00 00 0F 48 65 6C 6C 6F 20 77 69 6B 69 70 65 64 69 61')))
+
+
+
+
+print ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>"
+
+test_bin = binascii.a2b_hex(re.sub(' ','','00 00 00 3C 00 00 00 04 00 00 00 00 00 00 00 05 00 02 08 35 35 35 00 01 01 35 35 35 35 35 35 35 35 35 00 00 00 00 00 00 00 00 00 00 0F 48 65 6C 6C 6F 20 77 69 6B 69 70 65 64 69 61 00000000 00000000'))
+unpack_pdu(test_bin)
+
+
+pack_pdu('generic_nack','ESME_ROK',1,'00112233445566778899')
+pack_pdu()
+unpack_pdu(pack_pdu())
+
+
+j = {'status': 'ESME_ROK', 'body': {'optional_parameters':[{'tag':'payload_type', 'value':0}]}, 'length': 16, 'sequence': 0, 'command': 'bind_transmitter'}
+
+json_to_pdu(j)
|
aereal/dotfiles
|
f22d196a5f367c0d747a8601484cf24d663798d7
|
fix(zsh): use `--tmux` option only running on normal terminal
|
diff --git a/.zshrc b/.zshrc
index c7a8aee..1fe9cb6 100644
--- a/.zshrc
+++ b/.zshrc
@@ -1,372 +1,375 @@
bindkey -v
# function load path {{{
typeset -Ua fpath
fpath=(
$HOME/.zsh.d/functions(N-/)
$HOMEBREW_PATH/share/zsh-completions(N-/)
$HOMEBREW_PATH/share/zsh/site-functions(N-/)
$HOMEBREW_PATH/share/zsh/functions(N-/)
$HOMEBREW_PATH/opt/docker-completion/share/zsh/site-functions(N-/)
$HOMEBREW_PATH/opt/docker-compose-completion/share/zsh/site-functions(N-/)
$fpath
)
# }}}
# fundamental options {{{
export REPORTTIME=1
setopt extended_glob
# }}}
# history {{{
HISTFILE=$HOME/.zsh_history
HISTSIZE=10000000
SAVEHIST=$HISTSIZE
set \
extended_history \
hist_ignore_dups \
hist_ignore_space \
inc_append_history \
share_history \
no_flow_control \
hist_save_no_dups \
hist_ignore_all_dups
autoload history-search-end
zle -N history-beginning-search-backward-end history-search-end
zle -N history-beginning-search-forward-end history-search-end
bindkey -v "^N" history-beginning-search-forward-end
bindkey -v "^P" history-beginning-search-backward-end
bindkey -v "^R" history-incremental-pattern-search-backward
bindkey -v "^S" history-incremental-pattern-search-forward
# }}}
# color {{{
autoload -Uz colors; colors
[[ -f "$HOME/.dircolors" ]] && source "$HOME/.dircolors"
# }}}
# completion {{{
zmodload -i zsh/complist
autoload -U compinit && compinit -C
setopt \
complete_in_word \
glob_complete \
hist_expand \
no_beep \
numeric_glob_sort
# Format {{{
zstyle ':completion:*' format '%F{magenta}-- %d --%f'
zstyle ':completion:*' group-name ''
zstyle ':completion:*:options' description yes
zstyle ':completion:*:options' auto-description '%d'
zstyle ':completion:*:corrections' format ' %F{yellow}-- %d (errors: %e) --%f'
zstyle ':completion:*:descriptions' format ' %F{magenta}-- %d --%f'
zstyle ':completion:*:messages' format ' %F{blue}-- %d --%f'
zstyle ':completion:*:warnings' format ' %F{red}-- no matches found --%f'
zstyle ':completion:*:default' list-prompt '%S%M matches%s'
# Show selected candidate
zstyle ':completion:*:default' menu select=2
zstyle ':completion:*:default' list-colors "${(s.:.)LS_COLORS}"
# Fuzzy match
zstyle ':completion:*' matcher-list 'm:{a-z}={A-Z} r:|[._-]=*'
zstyle ':completion:*' completer _oldlist _complete _match _ignored _approximate _prefix
# sudo
zstyle ':completion:sudo:*' environ PATH="$SUDO_PATH:$PATH"
# Directory candidates order
zstyle ':completion:*:cd:*' tag-order local-directories path-directories
# Ignore current directory from directory candidates
zstyle ':completion:*' ignore-parents parent pwd
# Process candidates
zstyle ':completion:*:*:*:*:processes' command 'ps -u $USER -o pid,user,comm -w'
zstyle ':completion:*:*:kill:*:processes' list-colors '=(#b) #([0-9]#) ([0-9a-z-]#)*=01;36=0=01'
zstyle ':completion:*:*:kill:*' menu yes select
zstyle ':completion:*:*:kill:*' force-list always
zstyle ':completion:*:*:kill:*' insert-ids single
# Show man candidates with section
zstyle ':completion:*:manuals' separate-sections true
# }}}
# key mapping {{{
bindkey -M menuselect 'h' vi-backward-char
bindkey -M menuselect 'l' vi-forward-char
bindkey -M menuselect 'j' vi-down-line-or-history
bindkey -M menuselect 'k' vi-up-line-or-history
# }}}
# }}}
# url-quote-magic {{{
autoload -Uz url-quote-magic
zle -N self-insert url-quote-magic
# }}}
# expand backslash to tilde {{{
# Originally from: https://github.com/cho45/dotfiles/blob/64ea90d17aaf6c46a2cb090f2e12a6e3d7df6034/.zshrc#L245
expand-to-home-or-complete() { # {{{
if [ "$LBUFFER" = "" -o "$LBUFFER[-1]" = " " ]; then
LBUFFER+="~/"
else
zle self-insert
fi
} # }}}
zle -N expand-to-home-or-complete
bindkey -v "\\" expand-to-home-or-complete
# }}}
# ghq {{{
__widget_cd_repo() {
local selected_repo=$( ghq list | fzf )
if [[ -n "$selected_repo" ]]; then
BUFFER="pushd $(ghq root)/${selected_repo}"
zle accept-line
fi
zle -R -c
}
zle -N __widget_cd_repo
bindkey -v "^]^G" __widget_cd_repo
# }}}
# git {{{
__widget_git_recent_branches() {
local selected_branch=$( \
git for-each-ref --sort=-committerdate --format="%(refname) %(committerdate:relative)" -- refs/heads \
| sed -E 's/refs\/heads\///' \
| fzf --query "$LBUFFER" \
| cut -f1 \
)
if [[ -n "$selected_branch" ]]; then
BUFFER="git checkout ${selected_branch}"
zle accept-line
fi
zle -R -c
}
zle -N __widget_git_recent_branches
bindkey -v "^]gr" __widget_git_recent_branches
# }}}
# tmux: split window with vim-like key mappings {{{
# vertical split {{{
tmux_vsplit() {
BUFFER="tmux split-window -d -p 50 -h '$BUFFER'" # TODO: escape
zle accept-line
}
zle -N tmux_vsplit
bindkey -v "^Wv" tmux_vsplit
# }}}
# horizontal split {{{
tmux_split() {
BUFFER="tmux split-window -d -p 50 -v '$BUFFER'" # TODO: escape
zle accept-line
}
zle -N tmux_split
bindkey -v "^Ws" tmux_split
# }}}
# }}}
# alias {{{
alias :q=exit
if whence eza >/dev/null 2>&1; then
alias l='eza -aF'
alias ls='eza -aF'
alias ll='eza -alF'
else
if whence gls >/dev/null; then
alias l='gls --color=auto -AF'
alias ls='gls --color=auto -AF'
alias ll='gls --color=auto -AFl'
else
alias l='ls -GAF'
alias ls='ls -GAF'
alias ll='ls -GAFl'
fi
fi
whence hub >/dev/null 2>&1 && alias git=hub
# }}}
# abbrev {{{
setopt extended_glob
typeset -A abbreviations
abbreviations=(
'Ig' '| rg'
'It' '| tail'
'Ij' '| jq'
'DC' 'docker-compose'
)
magic-abbrev-expand() {
local MATCH
LBUFFER=${LBUFFER%%(#m)[-_a-zA-Z0-9]#}
LBUFFER+=${abbreviations[$MATCH]:-$MATCH}
zle self-insert
}
no-magic-abbrev-expand() {
LBUFFER+=' '
}
zle -N magic-abbrev-expand
zle -N no-magic-abbrev-expand
bindkey -v " " magic-abbrev-expand
bindkey -v "^x " no-magic-abbrev-expand
# }}}
# prompt {{{
setopt \
prompt_subst \
prompt_percent \
transient_rprompt
autoload -U promptinit && promptinit
autoload -Uz vcs_info
zstyle ':vcs_info:*' max-exports 4
zstyle ':vcs_info:(git|svn):*' formats '%R' '%S' '%b' '%s'
zstyle ':vcs_info:(git|svn):*' actionformats '%R' '%S' '%b|%a' '%s'
zstyle ':vcs_info:*' formats '%R' '%S' '%s:%b' '%s'
zstyle ':vcs_info:*' actionformats '%R' '%S' '%s:%b|%a' '%s'
__configure_prompt() {
local ok_yuno="%F{yellow}ââ¹â¡â¹â%f"
local bad_yuno="%F{red}â>ï¹<â%f"
local command_line="[%D{%Y-%m-%d} %*] %(?.${ok_yuno}.${bad_yuno}) < "
psvar=()
STY= LANG=en_US.UTF-8 vcs_info
repos=`print -nD "$vcs_info_msg_0_"`
if [[ -n "$vcs_info_msg_1_" ]]; then
vcs="$vcs_info_msg_3_"
else
vcs=''
fi
[[ -n "$repos" ]] && psvar[2]="$repos"
[[ -n "$vcs_info_msg_1_" ]] && psvar[3]="$vcs_info_msg_1_"
[[ -n "$vcs_info_msg_2_" ]] && psvar[1]="$vcs_info_msg_2_"
local psdirs='[%F{yellow}%3(v|%32<..<%3v%<<|%60<..<%~%<<)%f]'
local psvcs='%3(v|[%25<\<<%F{yellow}%2v%f@%F{blue}%1v%f%<<]|)'
local git_is_dirty git_local_changes git_upstream_changes
if git rev-parse --is-inside-work-tree &>/dev/null; then
command git diff --no-ext-diff --quiet --exit-code || git_is_dirty='%F{yellow}*%f'
local git_upstream_status=$(command git rev-list --left-right --count ...@{u} 2>/dev/null)
git_upstream_status=(${(ps:\t:)git_upstream_status})
local left=${git_upstream_status[1]} right=${git_upstream_status[2]}
(( ${left:-0} > 0 )) && git_local_changes='%F{green}â¡%f'
(( ${right:-0} > 0 )) && git_upstream_changes='%F{red}â£%f'
fi
export PROMPT="${command_line}"
export RPROMPT="${psdirs}${git_is_dirty}${git_local_changes}${git_upstream_changes}${psvcs}"
}
autoload -Uz add-zsh-hooks
add-zsh-hook precmd __configure_prompt
# }}}
# Show anyenv version {{{
notify_llenv_version() {
for llenv in rbenv plenv ndenv pyenv; do
llenv_root="${HOME}/.${llenv}" # XXX
if whence $llenv >/dev/null && [[ "$(${llenv} version-origin)" != "$llenv_root/version" ]]; then
echo "$fg[yellow]${llenv} changed version: $(${llenv} version-name)$reset_color"
fi
done
}
add-zsh-hook chpwd notify_llenv_version
# }}}
# Update current window name {{{
update_window_title() { # {{{
emulate -L zsh
local -a cmd
cmd=(${(z)2})
case $cmd[1] in
*=*) # PLENV_VERSION=5.14.2 plenv exec perl -v => plenv
echo -n "k$cmd[2]:t\\"
return
;;
ls|gls|clear|pwd)
echo -n "k$ZSH_NAME\\"
return
;;
sudo|cd)
echo -n "k$cmd[1] $cmd[2]:t\\"
return
;;
*)
echo -n "k$cmd[1]:t\\"
return
;;
esac
local -A jt
jt=(${(kv)jobtexts})
$cmd >>(read num rest cmd=(${(z)${(e):-\$jt$num}}) echo -n "k$cmd[1]:t\\") 2>/dev/null
} # }}}
if [ "$TMUX" ] && [ "$TERM_PROGRAM" != "vscode" ]; then
add-zsh-hook preexec update_window_title
fi
# }}}
# direnv {{{
if whence direnv >/dev/null; then
eval "$(direnv hook zsh)"
fi
# }}}
# syntax highlight {{{
if [[ -f "$HOMEBREW_PATH/share/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh" ]]; then
source $HOMEBREW_PATH/share/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh
fi
# }}}
# substring-search {{{
if [[ -f "$HOMEBREW_PATH/opt/zsh-history-substring-search/zsh-history-substring-search.zsh" ]]; then
source $HOMEBREW_PATH/opt/zsh-history-substring-search/zsh-history-substring-search.zsh
bindkey -M vicmd "k" history-substring-search-up
bindkey -M vicmd "j" history-substring-search-down
fi
# }}}
if ! ssh-add -l 2>/dev/null; then
echo '---> Add SSH private key'
ssh-add
fi
if [[ -f '/usr/local/Caskroom/google-cloud-sdk/latest/google-cloud-sdk/completion.zsh.inc' ]]; then
source '/usr/local/Caskroom/google-cloud-sdk/latest/google-cloud-sdk/completion.zsh.inc'
fi
if whence op >/dev/null; then
eval "$(op completion zsh)"
compdef _op op
fi
+FZF_DEFAULT_OPTS='--layout reverse'
+
# tmux {{{
if whence tmux >/dev/null && [ -z "$TMUX" ] && [ "$TERM_PROGRAM" != "vscode" ]; then
if $(tmux has-session 2>/dev/null); then
tmux attach-session -t "${HOST%%.*}"
else
tmux new-session -s "${HOST%%.*}"
fi
+ FZF_DEFAULT_OPTS="$FZF_DEFAULT_OPTS --tmux"
fi
# }}}
-export FZF_DEFAULT_OPTS='--tmux --layout reverse'
+export FZF_DEFAULT_OPTS
# vim:set foldmethod=marker:
|
aereal/dotfiles
|
bcc73cd256dbdaab64fd0d5599e00759e932bcb5
|
fix(zsh): use tmux popup
|
diff --git a/.zshrc b/.zshrc
index 9d1a3bf..c7a8aee 100644
--- a/.zshrc
+++ b/.zshrc
@@ -1,370 +1,372 @@
bindkey -v
# function load path {{{
typeset -Ua fpath
fpath=(
$HOME/.zsh.d/functions(N-/)
$HOMEBREW_PATH/share/zsh-completions(N-/)
$HOMEBREW_PATH/share/zsh/site-functions(N-/)
$HOMEBREW_PATH/share/zsh/functions(N-/)
$HOMEBREW_PATH/opt/docker-completion/share/zsh/site-functions(N-/)
$HOMEBREW_PATH/opt/docker-compose-completion/share/zsh/site-functions(N-/)
$fpath
)
# }}}
# fundamental options {{{
export REPORTTIME=1
setopt extended_glob
# }}}
# history {{{
HISTFILE=$HOME/.zsh_history
HISTSIZE=10000000
SAVEHIST=$HISTSIZE
set \
extended_history \
hist_ignore_dups \
hist_ignore_space \
inc_append_history \
share_history \
no_flow_control \
hist_save_no_dups \
hist_ignore_all_dups
autoload history-search-end
zle -N history-beginning-search-backward-end history-search-end
zle -N history-beginning-search-forward-end history-search-end
bindkey -v "^N" history-beginning-search-forward-end
bindkey -v "^P" history-beginning-search-backward-end
bindkey -v "^R" history-incremental-pattern-search-backward
bindkey -v "^S" history-incremental-pattern-search-forward
# }}}
# color {{{
autoload -Uz colors; colors
[[ -f "$HOME/.dircolors" ]] && source "$HOME/.dircolors"
# }}}
# completion {{{
zmodload -i zsh/complist
autoload -U compinit && compinit -C
setopt \
complete_in_word \
glob_complete \
hist_expand \
no_beep \
numeric_glob_sort
# Format {{{
zstyle ':completion:*' format '%F{magenta}-- %d --%f'
zstyle ':completion:*' group-name ''
zstyle ':completion:*:options' description yes
zstyle ':completion:*:options' auto-description '%d'
zstyle ':completion:*:corrections' format ' %F{yellow}-- %d (errors: %e) --%f'
zstyle ':completion:*:descriptions' format ' %F{magenta}-- %d --%f'
zstyle ':completion:*:messages' format ' %F{blue}-- %d --%f'
zstyle ':completion:*:warnings' format ' %F{red}-- no matches found --%f'
zstyle ':completion:*:default' list-prompt '%S%M matches%s'
# Show selected candidate
zstyle ':completion:*:default' menu select=2
zstyle ':completion:*:default' list-colors "${(s.:.)LS_COLORS}"
# Fuzzy match
zstyle ':completion:*' matcher-list 'm:{a-z}={A-Z} r:|[._-]=*'
zstyle ':completion:*' completer _oldlist _complete _match _ignored _approximate _prefix
# sudo
zstyle ':completion:sudo:*' environ PATH="$SUDO_PATH:$PATH"
# Directory candidates order
zstyle ':completion:*:cd:*' tag-order local-directories path-directories
# Ignore current directory from directory candidates
zstyle ':completion:*' ignore-parents parent pwd
# Process candidates
zstyle ':completion:*:*:*:*:processes' command 'ps -u $USER -o pid,user,comm -w'
zstyle ':completion:*:*:kill:*:processes' list-colors '=(#b) #([0-9]#) ([0-9a-z-]#)*=01;36=0=01'
zstyle ':completion:*:*:kill:*' menu yes select
zstyle ':completion:*:*:kill:*' force-list always
zstyle ':completion:*:*:kill:*' insert-ids single
# Show man candidates with section
zstyle ':completion:*:manuals' separate-sections true
# }}}
# key mapping {{{
bindkey -M menuselect 'h' vi-backward-char
bindkey -M menuselect 'l' vi-forward-char
bindkey -M menuselect 'j' vi-down-line-or-history
bindkey -M menuselect 'k' vi-up-line-or-history
# }}}
# }}}
# url-quote-magic {{{
autoload -Uz url-quote-magic
zle -N self-insert url-quote-magic
# }}}
# expand backslash to tilde {{{
# Originally from: https://github.com/cho45/dotfiles/blob/64ea90d17aaf6c46a2cb090f2e12a6e3d7df6034/.zshrc#L245
expand-to-home-or-complete() { # {{{
if [ "$LBUFFER" = "" -o "$LBUFFER[-1]" = " " ]; then
LBUFFER+="~/"
else
zle self-insert
fi
} # }}}
zle -N expand-to-home-or-complete
bindkey -v "\\" expand-to-home-or-complete
# }}}
# ghq {{{
__widget_cd_repo() {
local selected_repo=$( ghq list | fzf )
if [[ -n "$selected_repo" ]]; then
BUFFER="pushd $(ghq root)/${selected_repo}"
zle accept-line
fi
zle -R -c
}
zle -N __widget_cd_repo
bindkey -v "^]^G" __widget_cd_repo
# }}}
# git {{{
__widget_git_recent_branches() {
local selected_branch=$( \
git for-each-ref --sort=-committerdate --format="%(refname) %(committerdate:relative)" -- refs/heads \
| sed -E 's/refs\/heads\///' \
| fzf --query "$LBUFFER" \
| cut -f1 \
)
if [[ -n "$selected_branch" ]]; then
BUFFER="git checkout ${selected_branch}"
zle accept-line
fi
zle -R -c
}
zle -N __widget_git_recent_branches
bindkey -v "^]gr" __widget_git_recent_branches
# }}}
# tmux: split window with vim-like key mappings {{{
# vertical split {{{
tmux_vsplit() {
BUFFER="tmux split-window -d -p 50 -h '$BUFFER'" # TODO: escape
zle accept-line
}
zle -N tmux_vsplit
bindkey -v "^Wv" tmux_vsplit
# }}}
# horizontal split {{{
tmux_split() {
BUFFER="tmux split-window -d -p 50 -v '$BUFFER'" # TODO: escape
zle accept-line
}
zle -N tmux_split
bindkey -v "^Ws" tmux_split
# }}}
# }}}
# alias {{{
alias :q=exit
if whence eza >/dev/null 2>&1; then
alias l='eza -aF'
alias ls='eza -aF'
alias ll='eza -alF'
else
if whence gls >/dev/null; then
alias l='gls --color=auto -AF'
alias ls='gls --color=auto -AF'
alias ll='gls --color=auto -AFl'
else
alias l='ls -GAF'
alias ls='ls -GAF'
alias ll='ls -GAFl'
fi
fi
whence hub >/dev/null 2>&1 && alias git=hub
# }}}
# abbrev {{{
setopt extended_glob
typeset -A abbreviations
abbreviations=(
'Ig' '| rg'
'It' '| tail'
'Ij' '| jq'
'DC' 'docker-compose'
)
magic-abbrev-expand() {
local MATCH
LBUFFER=${LBUFFER%%(#m)[-_a-zA-Z0-9]#}
LBUFFER+=${abbreviations[$MATCH]:-$MATCH}
zle self-insert
}
no-magic-abbrev-expand() {
LBUFFER+=' '
}
zle -N magic-abbrev-expand
zle -N no-magic-abbrev-expand
bindkey -v " " magic-abbrev-expand
bindkey -v "^x " no-magic-abbrev-expand
# }}}
# prompt {{{
setopt \
prompt_subst \
prompt_percent \
transient_rprompt
autoload -U promptinit && promptinit
autoload -Uz vcs_info
zstyle ':vcs_info:*' max-exports 4
zstyle ':vcs_info:(git|svn):*' formats '%R' '%S' '%b' '%s'
zstyle ':vcs_info:(git|svn):*' actionformats '%R' '%S' '%b|%a' '%s'
zstyle ':vcs_info:*' formats '%R' '%S' '%s:%b' '%s'
zstyle ':vcs_info:*' actionformats '%R' '%S' '%s:%b|%a' '%s'
__configure_prompt() {
local ok_yuno="%F{yellow}ââ¹â¡â¹â%f"
local bad_yuno="%F{red}â>ï¹<â%f"
local command_line="[%D{%Y-%m-%d} %*] %(?.${ok_yuno}.${bad_yuno}) < "
psvar=()
STY= LANG=en_US.UTF-8 vcs_info
repos=`print -nD "$vcs_info_msg_0_"`
if [[ -n "$vcs_info_msg_1_" ]]; then
vcs="$vcs_info_msg_3_"
else
vcs=''
fi
[[ -n "$repos" ]] && psvar[2]="$repos"
[[ -n "$vcs_info_msg_1_" ]] && psvar[3]="$vcs_info_msg_1_"
[[ -n "$vcs_info_msg_2_" ]] && psvar[1]="$vcs_info_msg_2_"
local psdirs='[%F{yellow}%3(v|%32<..<%3v%<<|%60<..<%~%<<)%f]'
local psvcs='%3(v|[%25<\<<%F{yellow}%2v%f@%F{blue}%1v%f%<<]|)'
local git_is_dirty git_local_changes git_upstream_changes
if git rev-parse --is-inside-work-tree &>/dev/null; then
command git diff --no-ext-diff --quiet --exit-code || git_is_dirty='%F{yellow}*%f'
local git_upstream_status=$(command git rev-list --left-right --count ...@{u} 2>/dev/null)
git_upstream_status=(${(ps:\t:)git_upstream_status})
local left=${git_upstream_status[1]} right=${git_upstream_status[2]}
(( ${left:-0} > 0 )) && git_local_changes='%F{green}â¡%f'
(( ${right:-0} > 0 )) && git_upstream_changes='%F{red}â£%f'
fi
export PROMPT="${command_line}"
export RPROMPT="${psdirs}${git_is_dirty}${git_local_changes}${git_upstream_changes}${psvcs}"
}
autoload -Uz add-zsh-hooks
add-zsh-hook precmd __configure_prompt
# }}}
# Show anyenv version {{{
notify_llenv_version() {
for llenv in rbenv plenv ndenv pyenv; do
llenv_root="${HOME}/.${llenv}" # XXX
if whence $llenv >/dev/null && [[ "$(${llenv} version-origin)" != "$llenv_root/version" ]]; then
echo "$fg[yellow]${llenv} changed version: $(${llenv} version-name)$reset_color"
fi
done
}
add-zsh-hook chpwd notify_llenv_version
# }}}
# Update current window name {{{
update_window_title() { # {{{
emulate -L zsh
local -a cmd
cmd=(${(z)2})
case $cmd[1] in
*=*) # PLENV_VERSION=5.14.2 plenv exec perl -v => plenv
echo -n "k$cmd[2]:t\\"
return
;;
ls|gls|clear|pwd)
echo -n "k$ZSH_NAME\\"
return
;;
sudo|cd)
echo -n "k$cmd[1] $cmd[2]:t\\"
return
;;
*)
echo -n "k$cmd[1]:t\\"
return
;;
esac
local -A jt
jt=(${(kv)jobtexts})
$cmd >>(read num rest cmd=(${(z)${(e):-\$jt$num}}) echo -n "k$cmd[1]:t\\") 2>/dev/null
} # }}}
if [ "$TMUX" ] && [ "$TERM_PROGRAM" != "vscode" ]; then
add-zsh-hook preexec update_window_title
fi
# }}}
# direnv {{{
if whence direnv >/dev/null; then
eval "$(direnv hook zsh)"
fi
# }}}
# syntax highlight {{{
if [[ -f "$HOMEBREW_PATH/share/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh" ]]; then
source $HOMEBREW_PATH/share/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh
fi
# }}}
# substring-search {{{
if [[ -f "$HOMEBREW_PATH/opt/zsh-history-substring-search/zsh-history-substring-search.zsh" ]]; then
source $HOMEBREW_PATH/opt/zsh-history-substring-search/zsh-history-substring-search.zsh
bindkey -M vicmd "k" history-substring-search-up
bindkey -M vicmd "j" history-substring-search-down
fi
# }}}
if ! ssh-add -l 2>/dev/null; then
echo '---> Add SSH private key'
ssh-add
fi
if [[ -f '/usr/local/Caskroom/google-cloud-sdk/latest/google-cloud-sdk/completion.zsh.inc' ]]; then
source '/usr/local/Caskroom/google-cloud-sdk/latest/google-cloud-sdk/completion.zsh.inc'
fi
if whence op >/dev/null; then
eval "$(op completion zsh)"
compdef _op op
fi
# tmux {{{
if whence tmux >/dev/null && [ -z "$TMUX" ] && [ "$TERM_PROGRAM" != "vscode" ]; then
if $(tmux has-session 2>/dev/null); then
tmux attach-session -t "${HOST%%.*}"
else
tmux new-session -s "${HOST%%.*}"
fi
fi
# }}}
+export FZF_DEFAULT_OPTS='--tmux --layout reverse'
+
# vim:set foldmethod=marker:
|
aereal/dotfiles
|
a3c605b0c724ddc8f6b3f85270da6c5c168df1a3
|
fix(zsh): use fzf
|
diff --git a/.zshrc b/.zshrc
index e1aa411..9d1a3bf 100644
--- a/.zshrc
+++ b/.zshrc
@@ -1,370 +1,370 @@
bindkey -v
# function load path {{{
typeset -Ua fpath
fpath=(
$HOME/.zsh.d/functions(N-/)
$HOMEBREW_PATH/share/zsh-completions(N-/)
$HOMEBREW_PATH/share/zsh/site-functions(N-/)
$HOMEBREW_PATH/share/zsh/functions(N-/)
$HOMEBREW_PATH/opt/docker-completion/share/zsh/site-functions(N-/)
$HOMEBREW_PATH/opt/docker-compose-completion/share/zsh/site-functions(N-/)
$fpath
)
# }}}
# fundamental options {{{
export REPORTTIME=1
setopt extended_glob
# }}}
# history {{{
HISTFILE=$HOME/.zsh_history
HISTSIZE=10000000
SAVEHIST=$HISTSIZE
set \
extended_history \
hist_ignore_dups \
hist_ignore_space \
inc_append_history \
share_history \
no_flow_control \
hist_save_no_dups \
hist_ignore_all_dups
autoload history-search-end
zle -N history-beginning-search-backward-end history-search-end
zle -N history-beginning-search-forward-end history-search-end
bindkey -v "^N" history-beginning-search-forward-end
bindkey -v "^P" history-beginning-search-backward-end
bindkey -v "^R" history-incremental-pattern-search-backward
bindkey -v "^S" history-incremental-pattern-search-forward
# }}}
# color {{{
autoload -Uz colors; colors
[[ -f "$HOME/.dircolors" ]] && source "$HOME/.dircolors"
# }}}
# completion {{{
zmodload -i zsh/complist
autoload -U compinit && compinit -C
setopt \
complete_in_word \
glob_complete \
hist_expand \
no_beep \
numeric_glob_sort
# Format {{{
zstyle ':completion:*' format '%F{magenta}-- %d --%f'
zstyle ':completion:*' group-name ''
zstyle ':completion:*:options' description yes
zstyle ':completion:*:options' auto-description '%d'
zstyle ':completion:*:corrections' format ' %F{yellow}-- %d (errors: %e) --%f'
zstyle ':completion:*:descriptions' format ' %F{magenta}-- %d --%f'
zstyle ':completion:*:messages' format ' %F{blue}-- %d --%f'
zstyle ':completion:*:warnings' format ' %F{red}-- no matches found --%f'
zstyle ':completion:*:default' list-prompt '%S%M matches%s'
# Show selected candidate
zstyle ':completion:*:default' menu select=2
zstyle ':completion:*:default' list-colors "${(s.:.)LS_COLORS}"
# Fuzzy match
zstyle ':completion:*' matcher-list 'm:{a-z}={A-Z} r:|[._-]=*'
zstyle ':completion:*' completer _oldlist _complete _match _ignored _approximate _prefix
# sudo
zstyle ':completion:sudo:*' environ PATH="$SUDO_PATH:$PATH"
# Directory candidates order
zstyle ':completion:*:cd:*' tag-order local-directories path-directories
# Ignore current directory from directory candidates
zstyle ':completion:*' ignore-parents parent pwd
# Process candidates
zstyle ':completion:*:*:*:*:processes' command 'ps -u $USER -o pid,user,comm -w'
zstyle ':completion:*:*:kill:*:processes' list-colors '=(#b) #([0-9]#) ([0-9a-z-]#)*=01;36=0=01'
zstyle ':completion:*:*:kill:*' menu yes select
zstyle ':completion:*:*:kill:*' force-list always
zstyle ':completion:*:*:kill:*' insert-ids single
# Show man candidates with section
zstyle ':completion:*:manuals' separate-sections true
# }}}
# key mapping {{{
bindkey -M menuselect 'h' vi-backward-char
bindkey -M menuselect 'l' vi-forward-char
bindkey -M menuselect 'j' vi-down-line-or-history
bindkey -M menuselect 'k' vi-up-line-or-history
# }}}
# }}}
# url-quote-magic {{{
autoload -Uz url-quote-magic
zle -N self-insert url-quote-magic
# }}}
# expand backslash to tilde {{{
# Originally from: https://github.com/cho45/dotfiles/blob/64ea90d17aaf6c46a2cb090f2e12a6e3d7df6034/.zshrc#L245
expand-to-home-or-complete() { # {{{
if [ "$LBUFFER" = "" -o "$LBUFFER[-1]" = " " ]; then
LBUFFER+="~/"
else
zle self-insert
fi
} # }}}
zle -N expand-to-home-or-complete
bindkey -v "\\" expand-to-home-or-complete
# }}}
# ghq {{{
__widget_cd_repo() {
- local selected_repo=$( ghq list | peco )
+ local selected_repo=$( ghq list | fzf )
if [[ -n "$selected_repo" ]]; then
BUFFER="pushd $(ghq root)/${selected_repo}"
zle accept-line
fi
zle -R -c
}
zle -N __widget_cd_repo
bindkey -v "^]^G" __widget_cd_repo
# }}}
# git {{{
__widget_git_recent_branches() {
local selected_branch=$( \
git for-each-ref --sort=-committerdate --format="%(refname) %(committerdate:relative)" -- refs/heads \
| sed -E 's/refs\/heads\///' \
- | peco --query "$LBUFFER" \
+ | fzf --query "$LBUFFER" \
| cut -f1 \
)
if [[ -n "$selected_branch" ]]; then
BUFFER="git checkout ${selected_branch}"
zle accept-line
fi
zle -R -c
}
zle -N __widget_git_recent_branches
bindkey -v "^]gr" __widget_git_recent_branches
# }}}
# tmux: split window with vim-like key mappings {{{
# vertical split {{{
tmux_vsplit() {
BUFFER="tmux split-window -d -p 50 -h '$BUFFER'" # TODO: escape
zle accept-line
}
zle -N tmux_vsplit
bindkey -v "^Wv" tmux_vsplit
# }}}
# horizontal split {{{
tmux_split() {
BUFFER="tmux split-window -d -p 50 -v '$BUFFER'" # TODO: escape
zle accept-line
}
zle -N tmux_split
bindkey -v "^Ws" tmux_split
# }}}
# }}}
# alias {{{
alias :q=exit
if whence eza >/dev/null 2>&1; then
alias l='eza -aF'
alias ls='eza -aF'
alias ll='eza -alF'
else
if whence gls >/dev/null; then
alias l='gls --color=auto -AF'
alias ls='gls --color=auto -AF'
alias ll='gls --color=auto -AFl'
else
alias l='ls -GAF'
alias ls='ls -GAF'
alias ll='ls -GAFl'
fi
fi
whence hub >/dev/null 2>&1 && alias git=hub
# }}}
# abbrev {{{
setopt extended_glob
typeset -A abbreviations
abbreviations=(
'Ig' '| rg'
'It' '| tail'
'Ij' '| jq'
'DC' 'docker-compose'
)
magic-abbrev-expand() {
local MATCH
LBUFFER=${LBUFFER%%(#m)[-_a-zA-Z0-9]#}
LBUFFER+=${abbreviations[$MATCH]:-$MATCH}
zle self-insert
}
no-magic-abbrev-expand() {
LBUFFER+=' '
}
zle -N magic-abbrev-expand
zle -N no-magic-abbrev-expand
bindkey -v " " magic-abbrev-expand
bindkey -v "^x " no-magic-abbrev-expand
# }}}
# prompt {{{
setopt \
prompt_subst \
prompt_percent \
transient_rprompt
autoload -U promptinit && promptinit
autoload -Uz vcs_info
zstyle ':vcs_info:*' max-exports 4
zstyle ':vcs_info:(git|svn):*' formats '%R' '%S' '%b' '%s'
zstyle ':vcs_info:(git|svn):*' actionformats '%R' '%S' '%b|%a' '%s'
zstyle ':vcs_info:*' formats '%R' '%S' '%s:%b' '%s'
zstyle ':vcs_info:*' actionformats '%R' '%S' '%s:%b|%a' '%s'
__configure_prompt() {
local ok_yuno="%F{yellow}ââ¹â¡â¹â%f"
local bad_yuno="%F{red}â>ï¹<â%f"
local command_line="[%D{%Y-%m-%d} %*] %(?.${ok_yuno}.${bad_yuno}) < "
psvar=()
STY= LANG=en_US.UTF-8 vcs_info
repos=`print -nD "$vcs_info_msg_0_"`
if [[ -n "$vcs_info_msg_1_" ]]; then
vcs="$vcs_info_msg_3_"
else
vcs=''
fi
[[ -n "$repos" ]] && psvar[2]="$repos"
[[ -n "$vcs_info_msg_1_" ]] && psvar[3]="$vcs_info_msg_1_"
[[ -n "$vcs_info_msg_2_" ]] && psvar[1]="$vcs_info_msg_2_"
local psdirs='[%F{yellow}%3(v|%32<..<%3v%<<|%60<..<%~%<<)%f]'
local psvcs='%3(v|[%25<\<<%F{yellow}%2v%f@%F{blue}%1v%f%<<]|)'
local git_is_dirty git_local_changes git_upstream_changes
if git rev-parse --is-inside-work-tree &>/dev/null; then
command git diff --no-ext-diff --quiet --exit-code || git_is_dirty='%F{yellow}*%f'
local git_upstream_status=$(command git rev-list --left-right --count ...@{u} 2>/dev/null)
git_upstream_status=(${(ps:\t:)git_upstream_status})
local left=${git_upstream_status[1]} right=${git_upstream_status[2]}
(( ${left:-0} > 0 )) && git_local_changes='%F{green}â¡%f'
(( ${right:-0} > 0 )) && git_upstream_changes='%F{red}â£%f'
fi
export PROMPT="${command_line}"
export RPROMPT="${psdirs}${git_is_dirty}${git_local_changes}${git_upstream_changes}${psvcs}"
}
autoload -Uz add-zsh-hooks
add-zsh-hook precmd __configure_prompt
# }}}
# Show anyenv version {{{
notify_llenv_version() {
for llenv in rbenv plenv ndenv pyenv; do
llenv_root="${HOME}/.${llenv}" # XXX
if whence $llenv >/dev/null && [[ "$(${llenv} version-origin)" != "$llenv_root/version" ]]; then
echo "$fg[yellow]${llenv} changed version: $(${llenv} version-name)$reset_color"
fi
done
}
add-zsh-hook chpwd notify_llenv_version
# }}}
# Update current window name {{{
update_window_title() { # {{{
emulate -L zsh
local -a cmd
cmd=(${(z)2})
case $cmd[1] in
*=*) # PLENV_VERSION=5.14.2 plenv exec perl -v => plenv
echo -n "k$cmd[2]:t\\"
return
;;
ls|gls|clear|pwd)
echo -n "k$ZSH_NAME\\"
return
;;
sudo|cd)
echo -n "k$cmd[1] $cmd[2]:t\\"
return
;;
*)
echo -n "k$cmd[1]:t\\"
return
;;
esac
local -A jt
jt=(${(kv)jobtexts})
$cmd >>(read num rest cmd=(${(z)${(e):-\$jt$num}}) echo -n "k$cmd[1]:t\\") 2>/dev/null
} # }}}
if [ "$TMUX" ] && [ "$TERM_PROGRAM" != "vscode" ]; then
add-zsh-hook preexec update_window_title
fi
# }}}
# direnv {{{
if whence direnv >/dev/null; then
eval "$(direnv hook zsh)"
fi
# }}}
# syntax highlight {{{
if [[ -f "$HOMEBREW_PATH/share/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh" ]]; then
source $HOMEBREW_PATH/share/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh
fi
# }}}
# substring-search {{{
if [[ -f "$HOMEBREW_PATH/opt/zsh-history-substring-search/zsh-history-substring-search.zsh" ]]; then
source $HOMEBREW_PATH/opt/zsh-history-substring-search/zsh-history-substring-search.zsh
bindkey -M vicmd "k" history-substring-search-up
bindkey -M vicmd "j" history-substring-search-down
fi
# }}}
if ! ssh-add -l 2>/dev/null; then
echo '---> Add SSH private key'
ssh-add
fi
if [[ -f '/usr/local/Caskroom/google-cloud-sdk/latest/google-cloud-sdk/completion.zsh.inc' ]]; then
source '/usr/local/Caskroom/google-cloud-sdk/latest/google-cloud-sdk/completion.zsh.inc'
fi
if whence op >/dev/null; then
eval "$(op completion zsh)"
compdef _op op
fi
# tmux {{{
if whence tmux >/dev/null && [ -z "$TMUX" ] && [ "$TERM_PROGRAM" != "vscode" ]; then
if $(tmux has-session 2>/dev/null); then
tmux attach-session -t "${HOST%%.*}"
else
tmux new-session -s "${HOST%%.*}"
fi
fi
# }}}
# vim:set foldmethod=marker:
|
aereal/dotfiles
|
2b5f12cf0cfd466e1f9ec483c84acc11406bb582
|
feat(zsh): add mise shims
|
diff --git a/.zshenv b/.zshenv
index c000672..158aae6 100644
--- a/.zshenv
+++ b/.zshenv
@@ -1,104 +1,105 @@
# to avoid overwritten PATH via /usr/libexec/path_helper
# refs. https://github.com/Homebrew/homebrew-core/pull/32074#issuecomment-421381869
unsetopt GLOBAL_RCS
# environment
export LC_ALL=ja_JP.UTF-8
export DEVEL_PATH=$HOME/devel
export EDITOR=vim
export HOMEBREW_PATH=/usr/local
export HOMEBREW_NO_AUTO_UPDATE=1
export HOMEBREW_NO_ENV_HINTS=1
export HOMEBREW_NO_INSECURE_REDIRECT=1
export HOMEBREW_UPDATE_REPORT_ONLY_INSTALLED=1
if [[ -f $HOMEBREW_PATH/bin/bat ]]; then
export HOMEBREW_BAT=1
fi
path=(
$HOME/bin(N-/)
$DEVEL_PATH/bin(N-/)
$HOME/.mysqlenv/bin(N-/)
$HOME/.mysqlenv/shims(N-/)
$HOME/.pyenv/bin(N-/)
$HOME/.pyenv/shims(N-/)
$HOME/.rbenv/bin(N-/)
$HOME/.rbenv/shims(N-/)
$HOME/.plenv/bin(N-/)
$HOME/.plenv/shims(N-/)
$HOME/.ndenv/bin(N-/)
$HOME/.ndenv/shims(N-/)
$HOME/.cargo/bin(N-/)
$GOPATH/bin(N-/)
$HOME/.local/share/aquaproj-aqua/bin(N-/)
$HOME/.rd/bin(N-/)
+ $HOME/.local/share/mise/shims(N-/)
$HOMEBREW_PATH/opt/node@20/bin(N-/)
$HOMEBREW_PATH/Caskroom/google-cloud-sdk/latest/google-cloud-sdk/bin(N-/)
$HOMEBREW_PATH/opt/perl/bin(N-/)
$HOMEBREW_PATH/lib/ruby/gems/2.7.0/bin(N-/)
$HOMEBREW_PATH/opt/ruby/bin(N-/)
$HOMEBREW_PATH/opt/mysql-client/bin(N-/)
$HOMEBREW_PATH/opt/[email protected]/bin(N-/)
$HOMEBREW_PATH/opt/coreutils/libexec/gnubin(N-/)
$HOMEBREW_PATH/bin(N-/)
/usr/local/go/bin(N-/)
/mnt/c/Windows(N-/)
/mnt/c/Windows/System32/OpenSSH(N-/)
/mnt/c/Users/trast/AppData/Local/Programs/Microsoft\ VS\ Code/bin(N-/)
/usr/bin(N-/)
/usr/sbin(N-/)
/bin(N-/)
/sbin(N-/)
)
typeset -U manpath
manpath=(
$HOMEBREW_PATH/share/man(N-/)
$HOMEBREW_PATH/opt/coreutils/libexec/gnuman(N-/)
/usr/share/man(N-/)
)
export PAGER=less
export LESS='--LONG-PROMPT --RAW-CONTROL-CHARS'
if whence code 2>&1 >/dev/null; then
EDITOR='code --wait'
fi
if whence code 2>&1 >/dev/null; then
EDITOR='code --wait'
fi
MACVIM_APP=
local -a macvim_app_candidates=(
/opt/homebrew-cask/Caskroom/macvim-kaoriya/*/MacVim.app(N-/)
$HOMEBREW_PATH/opt/macvim/MacVim.app(N-/)
$HOME/Applications/MacVim.app(N-/)
/Applications/MacVim.app(N-/)
)
if (( $#macvim_app_candidates > 0 )); then
MACVIM_APP="$macvim_app_candidates[1]"
fi
export MACVIM_APP
if [[ -x /usr/libexec/java_home ]] && /usr/libexec/java_home >/dev/null 2>&1; then
export JAVA_HOME="$(/usr/libexec/java_home -v 1.8)"
fi
RUBY_CONFIGURE_OPTS=""
openssl_dir="$HOMEBREW_PATH/opt/[email protected]"
if [[ -d "$openssl_dir" ]]; then
RUBY_CONFIGURE_OPTS="${RUBY_CONFIGURE_OPTS} --with-openssl-dir=${openssl_dir}"
fi
readline_dir="$HOMEBREW_PATH/opt/readline"
if [[ -d "$readline_dir" ]]; then
RUBY_CONFIGURE_OPTS="${RUBY_CONFIGURE_OPTS} --with-readline-dir=${readline_dir}"
fi
export RUBY_CONFIGURE_OPTS
rover_env="$HOME/.rover/env"
if [[ -f "$rover_env" ]]; then
. $rover_env
fi
|
aereal/dotfiles
|
47b73c278aed8b0dc17633d663c60dc2883d8a48
|
feat: more medetai commands
|
diff --git a/.gitconfig b/.gitconfig
index 93ba97f..dcbe434 100644
--- a/.gitconfig
+++ b/.gitconfig
@@ -1,112 +1,116 @@
[user]
email = [email protected]
name = aereal
[gui]
encoding = utf-8
[github]
user = aereal
[alias]
abort-rebase = rebase --abort
branch-name = name-rev --name-only
ci = commit -v
co = checkout
continue-rebase = rebase --continue
cp = cherry-pick
df = diff
ds = diff --staged
fdf = diff --function-context
fetch-pulls = fetch origin +refs/pull/*:refs/remotes/pull/*
fix = commit --amend
gr = grep
interactive-rebase = rebase --interactive
network = log --graph --all --decorate --oneline
onelog = log --oneline
squashed-merge = merge --squash
st = status --branch --short --untracked-files=normal --ignore-submodules=dirty
ls = ls-files
delete-branch = branch -d
current-branch = symbolic-ref --short HEAD
curret-remote-branch = rev-parse --abbrev-ref --symbolic-full-name @{u}
hard-revert-merge-commit = reset --hard ORIG_HEAD
medetai = !git rev-list HEAD | rg -P '(.)\\1\\1'
+ medetai4 = !git rev-list HEAD | rg -P '(.)\\1\\1\\1'
+ medetai5 = !git rev-list HEAD | rg -P '(.)\\1\\1\\1\\1'
+ medetai6 = !git rev-list HEAD | rg -P '(.)\\1\\1\\1\\1\\1'
+ medetai7 = !git rev-list HEAD | rg -P '(.)\\1\\1\\1\\1\\1\\1'
pr = pull-request
recently-added = log --grep \"Revert\" --invert-grep --diff-filter=A --format=\"\" --name-only
[color]
branch = true
diff = true
grep = true
interactive = true
pager = true
status = true
[color "branch"]
current = green reverse
local = green
remote = yellow
[color "status"]
changed = green
untracked = cyan
updated = yellow
[i18n]
commitencoding= utf-8
[core]
quotepath = false
whitespace = cr-at-eol
pager = $PAGER
precomposeunicode = true
excludesfile = ~/.global.gitignore
[push]
default = simple
autoSetupRemote = true
[branch]
autosetuprebase = always
[grep]
lineNumber = true
patternType = perl
[rebase]
stat = true
[diff "gzip"]
textconv = gzcat
[log]
date = iso
[merge]
stat = true
[interactive]
singlekey = true
[ghq]
root = /Users/aereal/devel/src
[diff]
algorithm = histogram
[include]
path = ~/.secret.gitconfig
[advice]
statusHints = false
[pager]
log = git-diff-highlight | less
show = git-diff-highlight | less
diff = git-diff-highlight | less
grep = false
[url "[email protected]:"]
pushInsteadOf = https://github.com/
pushInsteadOf = git://github.com/
[pull]
rebase = true
[init]
defaultBranch = main
|
aereal/dotfiles
|
efcf090c3e5430478c53d083dc2f165412bbc3df
|
feat(zsh): add WSL-related paths
|
diff --git a/.zshenv b/.zshenv
index 87f9c95..c000672 100644
--- a/.zshenv
+++ b/.zshenv
@@ -1,100 +1,104 @@
# to avoid overwritten PATH via /usr/libexec/path_helper
# refs. https://github.com/Homebrew/homebrew-core/pull/32074#issuecomment-421381869
unsetopt GLOBAL_RCS
# environment
export LC_ALL=ja_JP.UTF-8
export DEVEL_PATH=$HOME/devel
export EDITOR=vim
export HOMEBREW_PATH=/usr/local
export HOMEBREW_NO_AUTO_UPDATE=1
export HOMEBREW_NO_ENV_HINTS=1
export HOMEBREW_NO_INSECURE_REDIRECT=1
export HOMEBREW_UPDATE_REPORT_ONLY_INSTALLED=1
if [[ -f $HOMEBREW_PATH/bin/bat ]]; then
export HOMEBREW_BAT=1
fi
path=(
$HOME/bin(N-/)
$DEVEL_PATH/bin(N-/)
$HOME/.mysqlenv/bin(N-/)
$HOME/.mysqlenv/shims(N-/)
$HOME/.pyenv/bin(N-/)
$HOME/.pyenv/shims(N-/)
$HOME/.rbenv/bin(N-/)
$HOME/.rbenv/shims(N-/)
$HOME/.plenv/bin(N-/)
$HOME/.plenv/shims(N-/)
$HOME/.ndenv/bin(N-/)
$HOME/.ndenv/shims(N-/)
$HOME/.cargo/bin(N-/)
$GOPATH/bin(N-/)
$HOME/.local/share/aquaproj-aqua/bin(N-/)
$HOME/.rd/bin(N-/)
$HOMEBREW_PATH/opt/node@20/bin(N-/)
$HOMEBREW_PATH/Caskroom/google-cloud-sdk/latest/google-cloud-sdk/bin(N-/)
$HOMEBREW_PATH/opt/perl/bin(N-/)
$HOMEBREW_PATH/lib/ruby/gems/2.7.0/bin(N-/)
$HOMEBREW_PATH/opt/ruby/bin(N-/)
$HOMEBREW_PATH/opt/mysql-client/bin(N-/)
$HOMEBREW_PATH/opt/[email protected]/bin(N-/)
$HOMEBREW_PATH/opt/coreutils/libexec/gnubin(N-/)
$HOMEBREW_PATH/bin(N-/)
+ /usr/local/go/bin(N-/)
+ /mnt/c/Windows(N-/)
+ /mnt/c/Windows/System32/OpenSSH(N-/)
+ /mnt/c/Users/trast/AppData/Local/Programs/Microsoft\ VS\ Code/bin(N-/)
/usr/bin(N-/)
/usr/sbin(N-/)
/bin(N-/)
/sbin(N-/)
)
typeset -U manpath
manpath=(
$HOMEBREW_PATH/share/man(N-/)
$HOMEBREW_PATH/opt/coreutils/libexec/gnuman(N-/)
/usr/share/man(N-/)
)
export PAGER=less
export LESS='--LONG-PROMPT --RAW-CONTROL-CHARS'
if whence code 2>&1 >/dev/null; then
EDITOR='code --wait'
fi
if whence code 2>&1 >/dev/null; then
EDITOR='code --wait'
fi
MACVIM_APP=
local -a macvim_app_candidates=(
/opt/homebrew-cask/Caskroom/macvim-kaoriya/*/MacVim.app(N-/)
$HOMEBREW_PATH/opt/macvim/MacVim.app(N-/)
$HOME/Applications/MacVim.app(N-/)
/Applications/MacVim.app(N-/)
)
if (( $#macvim_app_candidates > 0 )); then
MACVIM_APP="$macvim_app_candidates[1]"
fi
export MACVIM_APP
if [[ -x /usr/libexec/java_home ]] && /usr/libexec/java_home >/dev/null 2>&1; then
export JAVA_HOME="$(/usr/libexec/java_home -v 1.8)"
fi
RUBY_CONFIGURE_OPTS=""
openssl_dir="$HOMEBREW_PATH/opt/[email protected]"
if [[ -d "$openssl_dir" ]]; then
RUBY_CONFIGURE_OPTS="${RUBY_CONFIGURE_OPTS} --with-openssl-dir=${openssl_dir}"
fi
readline_dir="$HOMEBREW_PATH/opt/readline"
if [[ -d "$readline_dir" ]]; then
RUBY_CONFIGURE_OPTS="${RUBY_CONFIGURE_OPTS} --with-readline-dir=${readline_dir}"
fi
export RUBY_CONFIGURE_OPTS
rover_env="$HOME/.rover/env"
if [[ -f "$rover_env" ]]; then
. $rover_env
fi
|
aereal/dotfiles
|
a8d623c06f7c0f135723517d7bbc202c175cd596
|
fix: install at once
|
diff --git a/brew.bash b/brew.bash
index b40b42e..feb7af8 100644
--- a/brew.bash
+++ b/brew.bash
@@ -1,69 +1,69 @@
#!/bin/bash
set -e
brew_install() {
brew install $@ || :
}
brew update
export HOMEBREW_NO_AUTO_UPDATE=1
-# essentials
-brew_install awscli
-brew_install bat
-brew_install colordiff
-brew_install coreutils
-brew_install curl
-brew_install direnv
-brew_install docker-completion
-brew_install docker-compose-completion
-brew_install envchain
-brew_install exa
brew_install --HEAD motemen/furoshiki2/furoshiki2
brew_install git --with-curl
-brew_install gnu-tar
-brew_install go
-brew_install hub
-brew_install jq
-brew_install mackerelio/mackerel-agent/mackerel-agent
-brew_install mackerelio/mackerel-agent/mkr
-brew_install neovim
-brew_install peco
-brew_install proctools
-brew_install pstree
-brew_install reattach-to-user-namespace
-brew_install ripgrep
-brew_install slackcat
-brew_install sshuttle
-brew_install telnet
-brew_install tig
-brew_install tmux
-brew_install tree
brew_install zsh --without-etcdir
-brew_install zsh-completions
-brew_install zsh-history-substring-search
-brew_install zsh-syntax-highlighting
+brew install \
+ awscli \
+ bat \
+ colordiff \
+ coreutils \
+ curl \
+ direnv \
+ docker-completion \
+ docker-compose-completion \
+ envchain \
+ exa \
+ gnu-tar \
+ go \
+ hub \
+ jq \
+ mackerelio/mackerel-agent/mackerel-agent \
+ mackerelio/mackerel-agent/mkr \
+ neovim \
+ peco \
+ proctools \
+ pstree \
+ reattach-to-user-namespace \
+ ripgrep \
+ slackcat \
+ sshuttle \
+ telnet \
+ tig \
+ tmux \
+ tree \
+ zsh-completions \
+ zsh-history-substring-search \
+ zsh-syntax-highlighting \
# extra
brew_install graphviz
brew_install mysql-client
brew_install openssl
brew_install itchyny/rexdep/rexdep
# casks
brew install --cask alfred
brew install --cask docker
brew install --cask dropbox
brew install --cask homebrew/cask-versions/google-chrome-dev
brew install --cask gyazo
brew install --cask iterm2
brew install --cask karabiner-elements
brew install --cask mattr-slate
brew install --cask slack
brew install --cask visual-studio-code
# JDK-related
brew install --cask homebrew/cask-versions/java8
brew_install sbt
|
aereal/dotfiles
|
047168acfbfb41ea1a5c9f37bce7840031c5fba5
|
feat(ghostty): add ghostty config
|
diff --git a/.config/ghostty/config b/.config/ghostty/config
new file mode 100644
index 0000000..0250e01
--- /dev/null
+++ b/.config/ghostty/config
@@ -0,0 +1,10 @@
+font-family = "Cascadia Code"
+font-family = "HackGen Console"
+font-size = 18
+theme = /Applications/Ghostty.app/Contents/Resources/ghostty/themes/OneHalfLight
+cursor-style-blink = true
+background-opacity = 0.6
+background-blur = 5
+copy-on-select = false
+macos-titlebar-style = transparent
+macos-option-as-alt = true
|
aereal/dotfiles
|
9ef6ecdde350418f0f7c1c9e2f99c10dbe9f1d7f
|
fix(brew): cask is integrated
|
diff --git a/brew.bash b/brew.bash
index 58f8302..b40b42e 100644
--- a/brew.bash
+++ b/brew.bash
@@ -1,69 +1,69 @@
#!/bin/bash
set -e
brew_install() {
brew install $@ || :
}
brew update
export HOMEBREW_NO_AUTO_UPDATE=1
# essentials
brew_install awscli
brew_install bat
brew_install colordiff
brew_install coreutils
brew_install curl
brew_install direnv
brew_install docker-completion
brew_install docker-compose-completion
brew_install envchain
brew_install exa
brew_install --HEAD motemen/furoshiki2/furoshiki2
brew_install git --with-curl
brew_install gnu-tar
brew_install go
brew_install hub
brew_install jq
brew_install mackerelio/mackerel-agent/mackerel-agent
brew_install mackerelio/mackerel-agent/mkr
brew_install neovim
brew_install peco
brew_install proctools
brew_install pstree
brew_install reattach-to-user-namespace
brew_install ripgrep
brew_install slackcat
brew_install sshuttle
brew_install telnet
brew_install tig
brew_install tmux
brew_install tree
brew_install zsh --without-etcdir
brew_install zsh-completions
brew_install zsh-history-substring-search
brew_install zsh-syntax-highlighting
# extra
brew_install graphviz
brew_install mysql-client
brew_install openssl
brew_install itchyny/rexdep/rexdep
# casks
-brew cask install alfred
-brew cask install docker
-brew cask install dropbox
-brew cask install homebrew/cask-versions/google-chrome-dev
-brew cask install gyazo
-brew cask install iterm2
-brew cask install karabiner-elements
-brew cask install mattr-slate
-brew cask install slack
-brew cask install visual-studio-code
+brew install --cask alfred
+brew install --cask docker
+brew install --cask dropbox
+brew install --cask homebrew/cask-versions/google-chrome-dev
+brew install --cask gyazo
+brew install --cask iterm2
+brew install --cask karabiner-elements
+brew install --cask mattr-slate
+brew install --cask slack
+brew install --cask visual-studio-code
# JDK-related
-brew cask install homebrew/cask-versions/java8
+brew install --cask homebrew/cask-versions/java8
brew_install sbt
|
aereal/dotfiles
|
2eccc751b16b9bc5079c6d95715af5f8f03023d9
|
fix(zsh): use eza
|
diff --git a/.zshrc b/.zshrc
index 6974e50..e1aa411 100644
--- a/.zshrc
+++ b/.zshrc
@@ -1,370 +1,370 @@
bindkey -v
# function load path {{{
typeset -Ua fpath
fpath=(
$HOME/.zsh.d/functions(N-/)
$HOMEBREW_PATH/share/zsh-completions(N-/)
$HOMEBREW_PATH/share/zsh/site-functions(N-/)
$HOMEBREW_PATH/share/zsh/functions(N-/)
$HOMEBREW_PATH/opt/docker-completion/share/zsh/site-functions(N-/)
$HOMEBREW_PATH/opt/docker-compose-completion/share/zsh/site-functions(N-/)
$fpath
)
# }}}
# fundamental options {{{
export REPORTTIME=1
setopt extended_glob
# }}}
# history {{{
HISTFILE=$HOME/.zsh_history
HISTSIZE=10000000
SAVEHIST=$HISTSIZE
set \
extended_history \
hist_ignore_dups \
hist_ignore_space \
inc_append_history \
share_history \
no_flow_control \
hist_save_no_dups \
hist_ignore_all_dups
autoload history-search-end
zle -N history-beginning-search-backward-end history-search-end
zle -N history-beginning-search-forward-end history-search-end
bindkey -v "^N" history-beginning-search-forward-end
bindkey -v "^P" history-beginning-search-backward-end
bindkey -v "^R" history-incremental-pattern-search-backward
bindkey -v "^S" history-incremental-pattern-search-forward
# }}}
# color {{{
autoload -Uz colors; colors
[[ -f "$HOME/.dircolors" ]] && source "$HOME/.dircolors"
# }}}
# completion {{{
zmodload -i zsh/complist
autoload -U compinit && compinit -C
setopt \
complete_in_word \
glob_complete \
hist_expand \
no_beep \
numeric_glob_sort
# Format {{{
zstyle ':completion:*' format '%F{magenta}-- %d --%f'
zstyle ':completion:*' group-name ''
zstyle ':completion:*:options' description yes
zstyle ':completion:*:options' auto-description '%d'
zstyle ':completion:*:corrections' format ' %F{yellow}-- %d (errors: %e) --%f'
zstyle ':completion:*:descriptions' format ' %F{magenta}-- %d --%f'
zstyle ':completion:*:messages' format ' %F{blue}-- %d --%f'
zstyle ':completion:*:warnings' format ' %F{red}-- no matches found --%f'
zstyle ':completion:*:default' list-prompt '%S%M matches%s'
# Show selected candidate
zstyle ':completion:*:default' menu select=2
zstyle ':completion:*:default' list-colors "${(s.:.)LS_COLORS}"
# Fuzzy match
zstyle ':completion:*' matcher-list 'm:{a-z}={A-Z} r:|[._-]=*'
zstyle ':completion:*' completer _oldlist _complete _match _ignored _approximate _prefix
# sudo
zstyle ':completion:sudo:*' environ PATH="$SUDO_PATH:$PATH"
# Directory candidates order
zstyle ':completion:*:cd:*' tag-order local-directories path-directories
# Ignore current directory from directory candidates
zstyle ':completion:*' ignore-parents parent pwd
# Process candidates
zstyle ':completion:*:*:*:*:processes' command 'ps -u $USER -o pid,user,comm -w'
zstyle ':completion:*:*:kill:*:processes' list-colors '=(#b) #([0-9]#) ([0-9a-z-]#)*=01;36=0=01'
zstyle ':completion:*:*:kill:*' menu yes select
zstyle ':completion:*:*:kill:*' force-list always
zstyle ':completion:*:*:kill:*' insert-ids single
# Show man candidates with section
zstyle ':completion:*:manuals' separate-sections true
# }}}
# key mapping {{{
bindkey -M menuselect 'h' vi-backward-char
bindkey -M menuselect 'l' vi-forward-char
bindkey -M menuselect 'j' vi-down-line-or-history
bindkey -M menuselect 'k' vi-up-line-or-history
# }}}
# }}}
# url-quote-magic {{{
autoload -Uz url-quote-magic
zle -N self-insert url-quote-magic
# }}}
# expand backslash to tilde {{{
# Originally from: https://github.com/cho45/dotfiles/blob/64ea90d17aaf6c46a2cb090f2e12a6e3d7df6034/.zshrc#L245
expand-to-home-or-complete() { # {{{
if [ "$LBUFFER" = "" -o "$LBUFFER[-1]" = " " ]; then
LBUFFER+="~/"
else
zle self-insert
fi
} # }}}
zle -N expand-to-home-or-complete
bindkey -v "\\" expand-to-home-or-complete
# }}}
# ghq {{{
__widget_cd_repo() {
local selected_repo=$( ghq list | peco )
if [[ -n "$selected_repo" ]]; then
BUFFER="pushd $(ghq root)/${selected_repo}"
zle accept-line
fi
zle -R -c
}
zle -N __widget_cd_repo
bindkey -v "^]^G" __widget_cd_repo
# }}}
# git {{{
__widget_git_recent_branches() {
local selected_branch=$( \
git for-each-ref --sort=-committerdate --format="%(refname) %(committerdate:relative)" -- refs/heads \
| sed -E 's/refs\/heads\///' \
| peco --query "$LBUFFER" \
| cut -f1 \
)
if [[ -n "$selected_branch" ]]; then
BUFFER="git checkout ${selected_branch}"
zle accept-line
fi
zle -R -c
}
zle -N __widget_git_recent_branches
bindkey -v "^]gr" __widget_git_recent_branches
# }}}
# tmux: split window with vim-like key mappings {{{
# vertical split {{{
tmux_vsplit() {
BUFFER="tmux split-window -d -p 50 -h '$BUFFER'" # TODO: escape
zle accept-line
}
zle -N tmux_vsplit
bindkey -v "^Wv" tmux_vsplit
# }}}
# horizontal split {{{
tmux_split() {
BUFFER="tmux split-window -d -p 50 -v '$BUFFER'" # TODO: escape
zle accept-line
}
zle -N tmux_split
bindkey -v "^Ws" tmux_split
# }}}
# }}}
# alias {{{
alias :q=exit
-if whence exa >/dev/null 2>&1; then
- alias l='exa -aF'
- alias ls='exa -aF'
- alias ll='exa -alF'
+if whence eza >/dev/null 2>&1; then
+ alias l='eza -aF'
+ alias ls='eza -aF'
+ alias ll='eza -alF'
else
if whence gls >/dev/null; then
alias l='gls --color=auto -AF'
alias ls='gls --color=auto -AF'
alias ll='gls --color=auto -AFl'
else
alias l='ls -GAF'
alias ls='ls -GAF'
alias ll='ls -GAFl'
fi
fi
whence hub >/dev/null 2>&1 && alias git=hub
# }}}
# abbrev {{{
setopt extended_glob
typeset -A abbreviations
abbreviations=(
'Ig' '| rg'
'It' '| tail'
'Ij' '| jq'
'DC' 'docker-compose'
)
magic-abbrev-expand() {
local MATCH
LBUFFER=${LBUFFER%%(#m)[-_a-zA-Z0-9]#}
LBUFFER+=${abbreviations[$MATCH]:-$MATCH}
zle self-insert
}
no-magic-abbrev-expand() {
LBUFFER+=' '
}
zle -N magic-abbrev-expand
zle -N no-magic-abbrev-expand
bindkey -v " " magic-abbrev-expand
bindkey -v "^x " no-magic-abbrev-expand
# }}}
# prompt {{{
setopt \
prompt_subst \
prompt_percent \
transient_rprompt
autoload -U promptinit && promptinit
autoload -Uz vcs_info
zstyle ':vcs_info:*' max-exports 4
zstyle ':vcs_info:(git|svn):*' formats '%R' '%S' '%b' '%s'
zstyle ':vcs_info:(git|svn):*' actionformats '%R' '%S' '%b|%a' '%s'
zstyle ':vcs_info:*' formats '%R' '%S' '%s:%b' '%s'
zstyle ':vcs_info:*' actionformats '%R' '%S' '%s:%b|%a' '%s'
__configure_prompt() {
local ok_yuno="%F{yellow}ââ¹â¡â¹â%f"
local bad_yuno="%F{red}â>ï¹<â%f"
local command_line="[%D{%Y-%m-%d} %*] %(?.${ok_yuno}.${bad_yuno}) < "
psvar=()
STY= LANG=en_US.UTF-8 vcs_info
repos=`print -nD "$vcs_info_msg_0_"`
if [[ -n "$vcs_info_msg_1_" ]]; then
vcs="$vcs_info_msg_3_"
else
vcs=''
fi
[[ -n "$repos" ]] && psvar[2]="$repos"
[[ -n "$vcs_info_msg_1_" ]] && psvar[3]="$vcs_info_msg_1_"
[[ -n "$vcs_info_msg_2_" ]] && psvar[1]="$vcs_info_msg_2_"
local psdirs='[%F{yellow}%3(v|%32<..<%3v%<<|%60<..<%~%<<)%f]'
local psvcs='%3(v|[%25<\<<%F{yellow}%2v%f@%F{blue}%1v%f%<<]|)'
local git_is_dirty git_local_changes git_upstream_changes
if git rev-parse --is-inside-work-tree &>/dev/null; then
command git diff --no-ext-diff --quiet --exit-code || git_is_dirty='%F{yellow}*%f'
local git_upstream_status=$(command git rev-list --left-right --count ...@{u} 2>/dev/null)
git_upstream_status=(${(ps:\t:)git_upstream_status})
local left=${git_upstream_status[1]} right=${git_upstream_status[2]}
(( ${left:-0} > 0 )) && git_local_changes='%F{green}â¡%f'
(( ${right:-0} > 0 )) && git_upstream_changes='%F{red}â£%f'
fi
export PROMPT="${command_line}"
export RPROMPT="${psdirs}${git_is_dirty}${git_local_changes}${git_upstream_changes}${psvcs}"
}
autoload -Uz add-zsh-hooks
add-zsh-hook precmd __configure_prompt
# }}}
# Show anyenv version {{{
notify_llenv_version() {
for llenv in rbenv plenv ndenv pyenv; do
llenv_root="${HOME}/.${llenv}" # XXX
if whence $llenv >/dev/null && [[ "$(${llenv} version-origin)" != "$llenv_root/version" ]]; then
echo "$fg[yellow]${llenv} changed version: $(${llenv} version-name)$reset_color"
fi
done
}
add-zsh-hook chpwd notify_llenv_version
# }}}
# Update current window name {{{
update_window_title() { # {{{
emulate -L zsh
local -a cmd
cmd=(${(z)2})
case $cmd[1] in
*=*) # PLENV_VERSION=5.14.2 plenv exec perl -v => plenv
echo -n "k$cmd[2]:t\\"
return
;;
ls|gls|clear|pwd)
echo -n "k$ZSH_NAME\\"
return
;;
sudo|cd)
echo -n "k$cmd[1] $cmd[2]:t\\"
return
;;
*)
echo -n "k$cmd[1]:t\\"
return
;;
esac
local -A jt
jt=(${(kv)jobtexts})
$cmd >>(read num rest cmd=(${(z)${(e):-\$jt$num}}) echo -n "k$cmd[1]:t\\") 2>/dev/null
} # }}}
if [ "$TMUX" ] && [ "$TERM_PROGRAM" != "vscode" ]; then
add-zsh-hook preexec update_window_title
fi
# }}}
# direnv {{{
if whence direnv >/dev/null; then
eval "$(direnv hook zsh)"
fi
# }}}
# syntax highlight {{{
if [[ -f "$HOMEBREW_PATH/share/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh" ]]; then
source $HOMEBREW_PATH/share/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh
fi
# }}}
# substring-search {{{
if [[ -f "$HOMEBREW_PATH/opt/zsh-history-substring-search/zsh-history-substring-search.zsh" ]]; then
source $HOMEBREW_PATH/opt/zsh-history-substring-search/zsh-history-substring-search.zsh
bindkey -M vicmd "k" history-substring-search-up
bindkey -M vicmd "j" history-substring-search-down
fi
# }}}
if ! ssh-add -l 2>/dev/null; then
echo '---> Add SSH private key'
ssh-add
fi
if [[ -f '/usr/local/Caskroom/google-cloud-sdk/latest/google-cloud-sdk/completion.zsh.inc' ]]; then
source '/usr/local/Caskroom/google-cloud-sdk/latest/google-cloud-sdk/completion.zsh.inc'
fi
if whence op >/dev/null; then
eval "$(op completion zsh)"
compdef _op op
fi
# tmux {{{
if whence tmux >/dev/null && [ -z "$TMUX" ] && [ "$TERM_PROGRAM" != "vscode" ]; then
if $(tmux has-session 2>/dev/null); then
tmux attach-session -t "${HOST%%.*}"
else
tmux new-session -s "${HOST%%.*}"
fi
fi
# }}}
# vim:set foldmethod=marker:
|
aereal/dotfiles
|
7cc948ee21b202ff1874e51e141b04c3c067ec2e
|
fix(zsh): use mysql-client
|
diff --git a/.zshenv b/.zshenv
index 6f1f65b..87f9c95 100644
--- a/.zshenv
+++ b/.zshenv
@@ -1,100 +1,100 @@
# to avoid overwritten PATH via /usr/libexec/path_helper
# refs. https://github.com/Homebrew/homebrew-core/pull/32074#issuecomment-421381869
unsetopt GLOBAL_RCS
# environment
export LC_ALL=ja_JP.UTF-8
export DEVEL_PATH=$HOME/devel
export EDITOR=vim
export HOMEBREW_PATH=/usr/local
export HOMEBREW_NO_AUTO_UPDATE=1
export HOMEBREW_NO_ENV_HINTS=1
export HOMEBREW_NO_INSECURE_REDIRECT=1
export HOMEBREW_UPDATE_REPORT_ONLY_INSTALLED=1
if [[ -f $HOMEBREW_PATH/bin/bat ]]; then
export HOMEBREW_BAT=1
fi
path=(
$HOME/bin(N-/)
$DEVEL_PATH/bin(N-/)
$HOME/.mysqlenv/bin(N-/)
$HOME/.mysqlenv/shims(N-/)
$HOME/.pyenv/bin(N-/)
$HOME/.pyenv/shims(N-/)
$HOME/.rbenv/bin(N-/)
$HOME/.rbenv/shims(N-/)
$HOME/.plenv/bin(N-/)
$HOME/.plenv/shims(N-/)
$HOME/.ndenv/bin(N-/)
$HOME/.ndenv/shims(N-/)
$HOME/.cargo/bin(N-/)
$GOPATH/bin(N-/)
$HOME/.local/share/aquaproj-aqua/bin(N-/)
$HOME/.rd/bin(N-/)
$HOMEBREW_PATH/opt/node@20/bin(N-/)
$HOMEBREW_PATH/Caskroom/google-cloud-sdk/latest/google-cloud-sdk/bin(N-/)
$HOMEBREW_PATH/opt/perl/bin(N-/)
$HOMEBREW_PATH/lib/ruby/gems/2.7.0/bin(N-/)
$HOMEBREW_PATH/opt/ruby/bin(N-/)
$HOMEBREW_PATH/opt/mysql-client/bin(N-/)
- $HOMEBREW_PATH/opt/[email protected]/bin(N-/)
+ $HOMEBREW_PATH/opt/[email protected]/bin(N-/)
$HOMEBREW_PATH/opt/coreutils/libexec/gnubin(N-/)
$HOMEBREW_PATH/bin(N-/)
/usr/bin(N-/)
/usr/sbin(N-/)
/bin(N-/)
/sbin(N-/)
)
typeset -U manpath
manpath=(
$HOMEBREW_PATH/share/man(N-/)
$HOMEBREW_PATH/opt/coreutils/libexec/gnuman(N-/)
/usr/share/man(N-/)
)
export PAGER=less
export LESS='--LONG-PROMPT --RAW-CONTROL-CHARS'
if whence code 2>&1 >/dev/null; then
EDITOR='code --wait'
fi
if whence code 2>&1 >/dev/null; then
EDITOR='code --wait'
fi
MACVIM_APP=
local -a macvim_app_candidates=(
/opt/homebrew-cask/Caskroom/macvim-kaoriya/*/MacVim.app(N-/)
$HOMEBREW_PATH/opt/macvim/MacVim.app(N-/)
$HOME/Applications/MacVim.app(N-/)
/Applications/MacVim.app(N-/)
)
if (( $#macvim_app_candidates > 0 )); then
MACVIM_APP="$macvim_app_candidates[1]"
fi
export MACVIM_APP
if [[ -x /usr/libexec/java_home ]] && /usr/libexec/java_home >/dev/null 2>&1; then
export JAVA_HOME="$(/usr/libexec/java_home -v 1.8)"
fi
RUBY_CONFIGURE_OPTS=""
openssl_dir="$HOMEBREW_PATH/opt/[email protected]"
if [[ -d "$openssl_dir" ]]; then
RUBY_CONFIGURE_OPTS="${RUBY_CONFIGURE_OPTS} --with-openssl-dir=${openssl_dir}"
fi
readline_dir="$HOMEBREW_PATH/opt/readline"
if [[ -d "$readline_dir" ]]; then
RUBY_CONFIGURE_OPTS="${RUBY_CONFIGURE_OPTS} --with-readline-dir=${readline_dir}"
fi
export RUBY_CONFIGURE_OPTS
rover_env="$HOME/.rover/env"
if [[ -f "$rover_env" ]]; then
. $rover_env
fi
|
aereal/dotfiles
|
bf66a32a2f23b6901f413854c1a0f45060d9e898
|
fix(git): update mail
|
diff --git a/.gitconfig b/.gitconfig
index 58ff696..93ba97f 100644
--- a/.gitconfig
+++ b/.gitconfig
@@ -1,112 +1,112 @@
[user]
- email = [email protected]
+ email = [email protected]
name = aereal
[gui]
encoding = utf-8
[github]
user = aereal
[alias]
abort-rebase = rebase --abort
branch-name = name-rev --name-only
ci = commit -v
co = checkout
continue-rebase = rebase --continue
cp = cherry-pick
df = diff
ds = diff --staged
fdf = diff --function-context
fetch-pulls = fetch origin +refs/pull/*:refs/remotes/pull/*
fix = commit --amend
gr = grep
interactive-rebase = rebase --interactive
network = log --graph --all --decorate --oneline
onelog = log --oneline
squashed-merge = merge --squash
st = status --branch --short --untracked-files=normal --ignore-submodules=dirty
ls = ls-files
delete-branch = branch -d
current-branch = symbolic-ref --short HEAD
curret-remote-branch = rev-parse --abbrev-ref --symbolic-full-name @{u}
hard-revert-merge-commit = reset --hard ORIG_HEAD
medetai = !git rev-list HEAD | rg -P '(.)\\1\\1'
pr = pull-request
recently-added = log --grep \"Revert\" --invert-grep --diff-filter=A --format=\"\" --name-only
[color]
branch = true
diff = true
grep = true
interactive = true
pager = true
status = true
[color "branch"]
current = green reverse
local = green
remote = yellow
[color "status"]
changed = green
untracked = cyan
updated = yellow
[i18n]
commitencoding= utf-8
[core]
quotepath = false
whitespace = cr-at-eol
pager = $PAGER
precomposeunicode = true
excludesfile = ~/.global.gitignore
[push]
default = simple
autoSetupRemote = true
[branch]
autosetuprebase = always
[grep]
lineNumber = true
patternType = perl
[rebase]
stat = true
[diff "gzip"]
textconv = gzcat
[log]
date = iso
[merge]
stat = true
[interactive]
singlekey = true
[ghq]
root = /Users/aereal/devel/src
[diff]
algorithm = histogram
[include]
path = ~/.secret.gitconfig
[advice]
statusHints = false
[pager]
log = git-diff-highlight | less
show = git-diff-highlight | less
diff = git-diff-highlight | less
grep = false
[url "[email protected]:"]
pushInsteadOf = https://github.com/
pushInsteadOf = git://github.com/
[pull]
rebase = true
[init]
defaultBranch = main
|
aereal/dotfiles
|
01018fe5230577e1d8109a218edfe6a0b67614eb
|
feat: add ~/.rd/bin
|
diff --git a/.zshenv b/.zshenv
index 51f202f..6f1f65b 100644
--- a/.zshenv
+++ b/.zshenv
@@ -1,99 +1,100 @@
# to avoid overwritten PATH via /usr/libexec/path_helper
# refs. https://github.com/Homebrew/homebrew-core/pull/32074#issuecomment-421381869
unsetopt GLOBAL_RCS
# environment
export LC_ALL=ja_JP.UTF-8
export DEVEL_PATH=$HOME/devel
export EDITOR=vim
export HOMEBREW_PATH=/usr/local
export HOMEBREW_NO_AUTO_UPDATE=1
export HOMEBREW_NO_ENV_HINTS=1
export HOMEBREW_NO_INSECURE_REDIRECT=1
export HOMEBREW_UPDATE_REPORT_ONLY_INSTALLED=1
if [[ -f $HOMEBREW_PATH/bin/bat ]]; then
export HOMEBREW_BAT=1
fi
path=(
$HOME/bin(N-/)
$DEVEL_PATH/bin(N-/)
$HOME/.mysqlenv/bin(N-/)
$HOME/.mysqlenv/shims(N-/)
$HOME/.pyenv/bin(N-/)
$HOME/.pyenv/shims(N-/)
$HOME/.rbenv/bin(N-/)
$HOME/.rbenv/shims(N-/)
$HOME/.plenv/bin(N-/)
$HOME/.plenv/shims(N-/)
$HOME/.ndenv/bin(N-/)
$HOME/.ndenv/shims(N-/)
$HOME/.cargo/bin(N-/)
$GOPATH/bin(N-/)
$HOME/.local/share/aquaproj-aqua/bin(N-/)
+ $HOME/.rd/bin(N-/)
$HOMEBREW_PATH/opt/node@20/bin(N-/)
$HOMEBREW_PATH/Caskroom/google-cloud-sdk/latest/google-cloud-sdk/bin(N-/)
$HOMEBREW_PATH/opt/perl/bin(N-/)
$HOMEBREW_PATH/lib/ruby/gems/2.7.0/bin(N-/)
$HOMEBREW_PATH/opt/ruby/bin(N-/)
$HOMEBREW_PATH/opt/mysql-client/bin(N-/)
$HOMEBREW_PATH/opt/[email protected]/bin(N-/)
$HOMEBREW_PATH/opt/coreutils/libexec/gnubin(N-/)
$HOMEBREW_PATH/bin(N-/)
/usr/bin(N-/)
/usr/sbin(N-/)
/bin(N-/)
/sbin(N-/)
)
typeset -U manpath
manpath=(
$HOMEBREW_PATH/share/man(N-/)
$HOMEBREW_PATH/opt/coreutils/libexec/gnuman(N-/)
/usr/share/man(N-/)
)
export PAGER=less
export LESS='--LONG-PROMPT --RAW-CONTROL-CHARS'
if whence code 2>&1 >/dev/null; then
EDITOR='code --wait'
fi
if whence code 2>&1 >/dev/null; then
EDITOR='code --wait'
fi
MACVIM_APP=
local -a macvim_app_candidates=(
/opt/homebrew-cask/Caskroom/macvim-kaoriya/*/MacVim.app(N-/)
$HOMEBREW_PATH/opt/macvim/MacVim.app(N-/)
$HOME/Applications/MacVim.app(N-/)
/Applications/MacVim.app(N-/)
)
if (( $#macvim_app_candidates > 0 )); then
MACVIM_APP="$macvim_app_candidates[1]"
fi
export MACVIM_APP
if [[ -x /usr/libexec/java_home ]] && /usr/libexec/java_home >/dev/null 2>&1; then
export JAVA_HOME="$(/usr/libexec/java_home -v 1.8)"
fi
RUBY_CONFIGURE_OPTS=""
openssl_dir="$HOMEBREW_PATH/opt/[email protected]"
if [[ -d "$openssl_dir" ]]; then
RUBY_CONFIGURE_OPTS="${RUBY_CONFIGURE_OPTS} --with-openssl-dir=${openssl_dir}"
fi
readline_dir="$HOMEBREW_PATH/opt/readline"
if [[ -d "$readline_dir" ]]; then
RUBY_CONFIGURE_OPTS="${RUBY_CONFIGURE_OPTS} --with-readline-dir=${readline_dir}"
fi
export RUBY_CONFIGURE_OPTS
rover_env="$HOME/.rover/env"
if [[ -f "$rover_env" ]]; then
. $rover_env
fi
|
aereal/dotfiles
|
9b998aecc73f1fc0c573a54debb0d9ca92f40f9a
|
feat: add node@20 path
|
diff --git a/.zshenv b/.zshenv
index 283da9c..51f202f 100644
--- a/.zshenv
+++ b/.zshenv
@@ -1,98 +1,99 @@
# to avoid overwritten PATH via /usr/libexec/path_helper
# refs. https://github.com/Homebrew/homebrew-core/pull/32074#issuecomment-421381869
unsetopt GLOBAL_RCS
# environment
export LC_ALL=ja_JP.UTF-8
export DEVEL_PATH=$HOME/devel
export EDITOR=vim
export HOMEBREW_PATH=/usr/local
export HOMEBREW_NO_AUTO_UPDATE=1
export HOMEBREW_NO_ENV_HINTS=1
export HOMEBREW_NO_INSECURE_REDIRECT=1
export HOMEBREW_UPDATE_REPORT_ONLY_INSTALLED=1
if [[ -f $HOMEBREW_PATH/bin/bat ]]; then
export HOMEBREW_BAT=1
fi
path=(
$HOME/bin(N-/)
$DEVEL_PATH/bin(N-/)
$HOME/.mysqlenv/bin(N-/)
$HOME/.mysqlenv/shims(N-/)
$HOME/.pyenv/bin(N-/)
$HOME/.pyenv/shims(N-/)
$HOME/.rbenv/bin(N-/)
$HOME/.rbenv/shims(N-/)
$HOME/.plenv/bin(N-/)
$HOME/.plenv/shims(N-/)
$HOME/.ndenv/bin(N-/)
$HOME/.ndenv/shims(N-/)
$HOME/.cargo/bin(N-/)
$GOPATH/bin(N-/)
$HOME/.local/share/aquaproj-aqua/bin(N-/)
+ $HOMEBREW_PATH/opt/node@20/bin(N-/)
$HOMEBREW_PATH/Caskroom/google-cloud-sdk/latest/google-cloud-sdk/bin(N-/)
$HOMEBREW_PATH/opt/perl/bin(N-/)
$HOMEBREW_PATH/lib/ruby/gems/2.7.0/bin(N-/)
$HOMEBREW_PATH/opt/ruby/bin(N-/)
$HOMEBREW_PATH/opt/mysql-client/bin(N-/)
$HOMEBREW_PATH/opt/[email protected]/bin(N-/)
$HOMEBREW_PATH/opt/coreutils/libexec/gnubin(N-/)
$HOMEBREW_PATH/bin(N-/)
/usr/bin(N-/)
/usr/sbin(N-/)
/bin(N-/)
/sbin(N-/)
)
typeset -U manpath
manpath=(
$HOMEBREW_PATH/share/man(N-/)
$HOMEBREW_PATH/opt/coreutils/libexec/gnuman(N-/)
/usr/share/man(N-/)
)
export PAGER=less
export LESS='--LONG-PROMPT --RAW-CONTROL-CHARS'
if whence code 2>&1 >/dev/null; then
EDITOR='code --wait'
fi
if whence code 2>&1 >/dev/null; then
EDITOR='code --wait'
fi
MACVIM_APP=
local -a macvim_app_candidates=(
/opt/homebrew-cask/Caskroom/macvim-kaoriya/*/MacVim.app(N-/)
$HOMEBREW_PATH/opt/macvim/MacVim.app(N-/)
$HOME/Applications/MacVim.app(N-/)
/Applications/MacVim.app(N-/)
)
if (( $#macvim_app_candidates > 0 )); then
MACVIM_APP="$macvim_app_candidates[1]"
fi
export MACVIM_APP
if [[ -x /usr/libexec/java_home ]] && /usr/libexec/java_home >/dev/null 2>&1; then
export JAVA_HOME="$(/usr/libexec/java_home -v 1.8)"
fi
RUBY_CONFIGURE_OPTS=""
openssl_dir="$HOMEBREW_PATH/opt/[email protected]"
if [[ -d "$openssl_dir" ]]; then
RUBY_CONFIGURE_OPTS="${RUBY_CONFIGURE_OPTS} --with-openssl-dir=${openssl_dir}"
fi
readline_dir="$HOMEBREW_PATH/opt/readline"
if [[ -d "$readline_dir" ]]; then
RUBY_CONFIGURE_OPTS="${RUBY_CONFIGURE_OPTS} --with-readline-dir=${readline_dir}"
fi
export RUBY_CONFIGURE_OPTS
rover_env="$HOME/.rover/env"
if [[ -f "$rover_env" ]]; then
. $rover_env
fi
|
aereal/dotfiles
|
069fbb2c0748c47611bae6a2db314a6a4d755c41
|
feat(zsh): enable completion for op
|
diff --git a/.zshrc b/.zshrc
index 6e15d44..6974e50 100644
--- a/.zshrc
+++ b/.zshrc
@@ -1,365 +1,370 @@
bindkey -v
# function load path {{{
typeset -Ua fpath
fpath=(
$HOME/.zsh.d/functions(N-/)
$HOMEBREW_PATH/share/zsh-completions(N-/)
$HOMEBREW_PATH/share/zsh/site-functions(N-/)
$HOMEBREW_PATH/share/zsh/functions(N-/)
$HOMEBREW_PATH/opt/docker-completion/share/zsh/site-functions(N-/)
$HOMEBREW_PATH/opt/docker-compose-completion/share/zsh/site-functions(N-/)
$fpath
)
# }}}
# fundamental options {{{
export REPORTTIME=1
setopt extended_glob
# }}}
# history {{{
HISTFILE=$HOME/.zsh_history
HISTSIZE=10000000
SAVEHIST=$HISTSIZE
set \
extended_history \
hist_ignore_dups \
hist_ignore_space \
inc_append_history \
share_history \
no_flow_control \
hist_save_no_dups \
hist_ignore_all_dups
autoload history-search-end
zle -N history-beginning-search-backward-end history-search-end
zle -N history-beginning-search-forward-end history-search-end
bindkey -v "^N" history-beginning-search-forward-end
bindkey -v "^P" history-beginning-search-backward-end
bindkey -v "^R" history-incremental-pattern-search-backward
bindkey -v "^S" history-incremental-pattern-search-forward
# }}}
# color {{{
autoload -Uz colors; colors
[[ -f "$HOME/.dircolors" ]] && source "$HOME/.dircolors"
# }}}
# completion {{{
zmodload -i zsh/complist
autoload -U compinit && compinit -C
setopt \
complete_in_word \
glob_complete \
hist_expand \
no_beep \
numeric_glob_sort
# Format {{{
zstyle ':completion:*' format '%F{magenta}-- %d --%f'
zstyle ':completion:*' group-name ''
zstyle ':completion:*:options' description yes
zstyle ':completion:*:options' auto-description '%d'
zstyle ':completion:*:corrections' format ' %F{yellow}-- %d (errors: %e) --%f'
zstyle ':completion:*:descriptions' format ' %F{magenta}-- %d --%f'
zstyle ':completion:*:messages' format ' %F{blue}-- %d --%f'
zstyle ':completion:*:warnings' format ' %F{red}-- no matches found --%f'
zstyle ':completion:*:default' list-prompt '%S%M matches%s'
# Show selected candidate
zstyle ':completion:*:default' menu select=2
zstyle ':completion:*:default' list-colors "${(s.:.)LS_COLORS}"
# Fuzzy match
zstyle ':completion:*' matcher-list 'm:{a-z}={A-Z} r:|[._-]=*'
zstyle ':completion:*' completer _oldlist _complete _match _ignored _approximate _prefix
# sudo
zstyle ':completion:sudo:*' environ PATH="$SUDO_PATH:$PATH"
# Directory candidates order
zstyle ':completion:*:cd:*' tag-order local-directories path-directories
# Ignore current directory from directory candidates
zstyle ':completion:*' ignore-parents parent pwd
# Process candidates
zstyle ':completion:*:*:*:*:processes' command 'ps -u $USER -o pid,user,comm -w'
zstyle ':completion:*:*:kill:*:processes' list-colors '=(#b) #([0-9]#) ([0-9a-z-]#)*=01;36=0=01'
zstyle ':completion:*:*:kill:*' menu yes select
zstyle ':completion:*:*:kill:*' force-list always
zstyle ':completion:*:*:kill:*' insert-ids single
# Show man candidates with section
zstyle ':completion:*:manuals' separate-sections true
# }}}
# key mapping {{{
bindkey -M menuselect 'h' vi-backward-char
bindkey -M menuselect 'l' vi-forward-char
bindkey -M menuselect 'j' vi-down-line-or-history
bindkey -M menuselect 'k' vi-up-line-or-history
# }}}
# }}}
# url-quote-magic {{{
autoload -Uz url-quote-magic
zle -N self-insert url-quote-magic
# }}}
# expand backslash to tilde {{{
# Originally from: https://github.com/cho45/dotfiles/blob/64ea90d17aaf6c46a2cb090f2e12a6e3d7df6034/.zshrc#L245
expand-to-home-or-complete() { # {{{
if [ "$LBUFFER" = "" -o "$LBUFFER[-1]" = " " ]; then
LBUFFER+="~/"
else
zle self-insert
fi
} # }}}
zle -N expand-to-home-or-complete
bindkey -v "\\" expand-to-home-or-complete
# }}}
# ghq {{{
__widget_cd_repo() {
local selected_repo=$( ghq list | peco )
if [[ -n "$selected_repo" ]]; then
BUFFER="pushd $(ghq root)/${selected_repo}"
zle accept-line
fi
zle -R -c
}
zle -N __widget_cd_repo
bindkey -v "^]^G" __widget_cd_repo
# }}}
# git {{{
__widget_git_recent_branches() {
local selected_branch=$( \
git for-each-ref --sort=-committerdate --format="%(refname) %(committerdate:relative)" -- refs/heads \
| sed -E 's/refs\/heads\///' \
| peco --query "$LBUFFER" \
| cut -f1 \
)
if [[ -n "$selected_branch" ]]; then
BUFFER="git checkout ${selected_branch}"
zle accept-line
fi
zle -R -c
}
zle -N __widget_git_recent_branches
bindkey -v "^]gr" __widget_git_recent_branches
# }}}
# tmux: split window with vim-like key mappings {{{
# vertical split {{{
tmux_vsplit() {
BUFFER="tmux split-window -d -p 50 -h '$BUFFER'" # TODO: escape
zle accept-line
}
zle -N tmux_vsplit
bindkey -v "^Wv" tmux_vsplit
# }}}
# horizontal split {{{
tmux_split() {
BUFFER="tmux split-window -d -p 50 -v '$BUFFER'" # TODO: escape
zle accept-line
}
zle -N tmux_split
bindkey -v "^Ws" tmux_split
# }}}
# }}}
# alias {{{
alias :q=exit
if whence exa >/dev/null 2>&1; then
alias l='exa -aF'
alias ls='exa -aF'
alias ll='exa -alF'
else
if whence gls >/dev/null; then
alias l='gls --color=auto -AF'
alias ls='gls --color=auto -AF'
alias ll='gls --color=auto -AFl'
else
alias l='ls -GAF'
alias ls='ls -GAF'
alias ll='ls -GAFl'
fi
fi
whence hub >/dev/null 2>&1 && alias git=hub
# }}}
# abbrev {{{
setopt extended_glob
typeset -A abbreviations
abbreviations=(
'Ig' '| rg'
'It' '| tail'
'Ij' '| jq'
'DC' 'docker-compose'
)
magic-abbrev-expand() {
local MATCH
LBUFFER=${LBUFFER%%(#m)[-_a-zA-Z0-9]#}
LBUFFER+=${abbreviations[$MATCH]:-$MATCH}
zle self-insert
}
no-magic-abbrev-expand() {
LBUFFER+=' '
}
zle -N magic-abbrev-expand
zle -N no-magic-abbrev-expand
bindkey -v " " magic-abbrev-expand
bindkey -v "^x " no-magic-abbrev-expand
# }}}
# prompt {{{
setopt \
prompt_subst \
prompt_percent \
transient_rprompt
autoload -U promptinit && promptinit
autoload -Uz vcs_info
zstyle ':vcs_info:*' max-exports 4
zstyle ':vcs_info:(git|svn):*' formats '%R' '%S' '%b' '%s'
zstyle ':vcs_info:(git|svn):*' actionformats '%R' '%S' '%b|%a' '%s'
zstyle ':vcs_info:*' formats '%R' '%S' '%s:%b' '%s'
zstyle ':vcs_info:*' actionformats '%R' '%S' '%s:%b|%a' '%s'
__configure_prompt() {
local ok_yuno="%F{yellow}ââ¹â¡â¹â%f"
local bad_yuno="%F{red}â>ï¹<â%f"
local command_line="[%D{%Y-%m-%d} %*] %(?.${ok_yuno}.${bad_yuno}) < "
psvar=()
STY= LANG=en_US.UTF-8 vcs_info
repos=`print -nD "$vcs_info_msg_0_"`
if [[ -n "$vcs_info_msg_1_" ]]; then
vcs="$vcs_info_msg_3_"
else
vcs=''
fi
[[ -n "$repos" ]] && psvar[2]="$repos"
[[ -n "$vcs_info_msg_1_" ]] && psvar[3]="$vcs_info_msg_1_"
[[ -n "$vcs_info_msg_2_" ]] && psvar[1]="$vcs_info_msg_2_"
local psdirs='[%F{yellow}%3(v|%32<..<%3v%<<|%60<..<%~%<<)%f]'
local psvcs='%3(v|[%25<\<<%F{yellow}%2v%f@%F{blue}%1v%f%<<]|)'
local git_is_dirty git_local_changes git_upstream_changes
if git rev-parse --is-inside-work-tree &>/dev/null; then
command git diff --no-ext-diff --quiet --exit-code || git_is_dirty='%F{yellow}*%f'
local git_upstream_status=$(command git rev-list --left-right --count ...@{u} 2>/dev/null)
git_upstream_status=(${(ps:\t:)git_upstream_status})
local left=${git_upstream_status[1]} right=${git_upstream_status[2]}
(( ${left:-0} > 0 )) && git_local_changes='%F{green}â¡%f'
(( ${right:-0} > 0 )) && git_upstream_changes='%F{red}â£%f'
fi
export PROMPT="${command_line}"
export RPROMPT="${psdirs}${git_is_dirty}${git_local_changes}${git_upstream_changes}${psvcs}"
}
autoload -Uz add-zsh-hooks
add-zsh-hook precmd __configure_prompt
# }}}
# Show anyenv version {{{
notify_llenv_version() {
for llenv in rbenv plenv ndenv pyenv; do
llenv_root="${HOME}/.${llenv}" # XXX
if whence $llenv >/dev/null && [[ "$(${llenv} version-origin)" != "$llenv_root/version" ]]; then
echo "$fg[yellow]${llenv} changed version: $(${llenv} version-name)$reset_color"
fi
done
}
add-zsh-hook chpwd notify_llenv_version
# }}}
# Update current window name {{{
update_window_title() { # {{{
emulate -L zsh
local -a cmd
cmd=(${(z)2})
case $cmd[1] in
*=*) # PLENV_VERSION=5.14.2 plenv exec perl -v => plenv
echo -n "k$cmd[2]:t\\"
return
;;
ls|gls|clear|pwd)
echo -n "k$ZSH_NAME\\"
return
;;
sudo|cd)
echo -n "k$cmd[1] $cmd[2]:t\\"
return
;;
*)
echo -n "k$cmd[1]:t\\"
return
;;
esac
local -A jt
jt=(${(kv)jobtexts})
$cmd >>(read num rest cmd=(${(z)${(e):-\$jt$num}}) echo -n "k$cmd[1]:t\\") 2>/dev/null
} # }}}
if [ "$TMUX" ] && [ "$TERM_PROGRAM" != "vscode" ]; then
add-zsh-hook preexec update_window_title
fi
# }}}
# direnv {{{
if whence direnv >/dev/null; then
eval "$(direnv hook zsh)"
fi
# }}}
# syntax highlight {{{
if [[ -f "$HOMEBREW_PATH/share/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh" ]]; then
source $HOMEBREW_PATH/share/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh
fi
# }}}
# substring-search {{{
if [[ -f "$HOMEBREW_PATH/opt/zsh-history-substring-search/zsh-history-substring-search.zsh" ]]; then
source $HOMEBREW_PATH/opt/zsh-history-substring-search/zsh-history-substring-search.zsh
bindkey -M vicmd "k" history-substring-search-up
bindkey -M vicmd "j" history-substring-search-down
fi
# }}}
if ! ssh-add -l 2>/dev/null; then
echo '---> Add SSH private key'
ssh-add
fi
if [[ -f '/usr/local/Caskroom/google-cloud-sdk/latest/google-cloud-sdk/completion.zsh.inc' ]]; then
source '/usr/local/Caskroom/google-cloud-sdk/latest/google-cloud-sdk/completion.zsh.inc'
fi
+if whence op >/dev/null; then
+ eval "$(op completion zsh)"
+ compdef _op op
+fi
+
# tmux {{{
if whence tmux >/dev/null && [ -z "$TMUX" ] && [ "$TERM_PROGRAM" != "vscode" ]; then
if $(tmux has-session 2>/dev/null); then
tmux attach-session -t "${HOST%%.*}"
else
tmux new-session -s "${HOST%%.*}"
fi
fi
# }}}
# vim:set foldmethod=marker:
|
aereal/dotfiles
|
39fa95b9feb5b715a5b5192529c76759f3a39ef3
|
fix: change hot key
|
diff --git a/.hammerspoon/init.lua b/.hammerspoon/init.lua
index 6a1b05e..18316bb 100644
--- a/.hammerspoon/init.lua
+++ b/.hammerspoon/init.lua
@@ -1,48 +1,48 @@
hs.window.animationDuration = 0
-viKey = hs.hotkey.modal.new('ctrl-cmd', 'delete', 'hammerspoon')
+viKey = hs.hotkey.modal.new('ctrl-cmd-option', 'space', 'hammerspoon')
function viKey:entered() hs.alert'Enter' end
function viKey:exited() hs.alert'Exit' end
viKey:bind('', 'escape', function() viKey:exit() end)
units = {
enter = { x = 0.0, y = 0.0, w = 1.0, h = 1.0 },
spc = { x = 0.125, y = 0.125, w = 0.75, h = 0.75 },
h = { x = 0.0, y = 0.0, w = 0.5, h = 1.0 },
l = { x = 0.5, y = 0.0, w = 0.5, h = 1.0 },
j = { x = 0.0, y = 0.5, w = 1.0, h = 0.5 },
k = { x = 0.0, y = 0.0, w = 1.0, h = 0.5 },
i = { x = 0.0, y = 0.0, w = 0.5, h = 0.5 },
o = { x = 0.5, y = 0.0, w = 0.5, h = 0.5 },
n = { x = 0.0, y = 0.5, w = 0.5, h = 0.5 },
m = { x = 0.5, y = 0.5, w = 0.5, h = 0.5 },
}
viKey:bind('', 'return', function()
hs.window.focusedWindow():move(units.enter)
end)
viKey:bind('', 'space', function()
hs.window.focusedWindow():move(units.spc)
end)
viKey:bind('', 'h', function()
hs.window.focusedWindow():move(units.h)
end)
viKey:bind('', 'l', function()
hs.window.focusedWindow():move(units.l)
end)
viKey:bind('', 'j', function()
hs.window.focusedWindow():move(units.j)
end)
viKey:bind('', 'k', function()
hs.window.focusedWindow():move(units.k)
end)
viKey:bind('', 'i', function()
hs.window.focusedWindow():move(units.i)
end)
viKey:bind('', 'o', function()
hs.window.focusedWindow():move(units.o)
end)
viKey:bind('', 'n', function()
hs.window.focusedWindow():move(units.n)
end)
viKey:bind('', 'm', function()
hs.window.focusedWindow():move(units.m)
end)
|
aereal/dotfiles
|
ecbc1d83208473506893f3acc988609fa394697a
|
fix(zsh): suppress error message
|
diff --git a/.zshenv b/.zshenv
index 2571207..283da9c 100644
--- a/.zshenv
+++ b/.zshenv
@@ -1,98 +1,98 @@
# to avoid overwritten PATH via /usr/libexec/path_helper
# refs. https://github.com/Homebrew/homebrew-core/pull/32074#issuecomment-421381869
unsetopt GLOBAL_RCS
# environment
export LC_ALL=ja_JP.UTF-8
export DEVEL_PATH=$HOME/devel
export EDITOR=vim
export HOMEBREW_PATH=/usr/local
export HOMEBREW_NO_AUTO_UPDATE=1
export HOMEBREW_NO_ENV_HINTS=1
export HOMEBREW_NO_INSECURE_REDIRECT=1
export HOMEBREW_UPDATE_REPORT_ONLY_INSTALLED=1
if [[ -f $HOMEBREW_PATH/bin/bat ]]; then
export HOMEBREW_BAT=1
fi
path=(
$HOME/bin(N-/)
$DEVEL_PATH/bin(N-/)
$HOME/.mysqlenv/bin(N-/)
$HOME/.mysqlenv/shims(N-/)
$HOME/.pyenv/bin(N-/)
$HOME/.pyenv/shims(N-/)
$HOME/.rbenv/bin(N-/)
$HOME/.rbenv/shims(N-/)
$HOME/.plenv/bin(N-/)
$HOME/.plenv/shims(N-/)
$HOME/.ndenv/bin(N-/)
$HOME/.ndenv/shims(N-/)
$HOME/.cargo/bin(N-/)
$GOPATH/bin(N-/)
$HOME/.local/share/aquaproj-aqua/bin(N-/)
$HOMEBREW_PATH/Caskroom/google-cloud-sdk/latest/google-cloud-sdk/bin(N-/)
$HOMEBREW_PATH/opt/perl/bin(N-/)
$HOMEBREW_PATH/lib/ruby/gems/2.7.0/bin(N-/)
$HOMEBREW_PATH/opt/ruby/bin(N-/)
$HOMEBREW_PATH/opt/mysql-client/bin(N-/)
$HOMEBREW_PATH/opt/[email protected]/bin(N-/)
$HOMEBREW_PATH/opt/coreutils/libexec/gnubin(N-/)
$HOMEBREW_PATH/bin(N-/)
/usr/bin(N-/)
/usr/sbin(N-/)
/bin(N-/)
/sbin(N-/)
)
typeset -U manpath
manpath=(
$HOMEBREW_PATH/share/man(N-/)
$HOMEBREW_PATH/opt/coreutils/libexec/gnuman(N-/)
/usr/share/man(N-/)
)
export PAGER=less
export LESS='--LONG-PROMPT --RAW-CONTROL-CHARS'
if whence code 2>&1 >/dev/null; then
EDITOR='code --wait'
fi
if whence code 2>&1 >/dev/null; then
EDITOR='code --wait'
fi
MACVIM_APP=
local -a macvim_app_candidates=(
/opt/homebrew-cask/Caskroom/macvim-kaoriya/*/MacVim.app(N-/)
$HOMEBREW_PATH/opt/macvim/MacVim.app(N-/)
$HOME/Applications/MacVim.app(N-/)
/Applications/MacVim.app(N-/)
)
if (( $#macvim_app_candidates > 0 )); then
MACVIM_APP="$macvim_app_candidates[1]"
fi
export MACVIM_APP
-if [[ -x /usr/libexec/java_home ]] && /usr/libexec/java_home 2>&1 >/dev/null; then
+if [[ -x /usr/libexec/java_home ]] && /usr/libexec/java_home >/dev/null 2>&1; then
export JAVA_HOME="$(/usr/libexec/java_home -v 1.8)"
fi
RUBY_CONFIGURE_OPTS=""
openssl_dir="$HOMEBREW_PATH/opt/[email protected]"
if [[ -d "$openssl_dir" ]]; then
RUBY_CONFIGURE_OPTS="${RUBY_CONFIGURE_OPTS} --with-openssl-dir=${openssl_dir}"
fi
readline_dir="$HOMEBREW_PATH/opt/readline"
if [[ -d "$readline_dir" ]]; then
RUBY_CONFIGURE_OPTS="${RUBY_CONFIGURE_OPTS} --with-readline-dir=${readline_dir}"
fi
export RUBY_CONFIGURE_OPTS
rover_env="$HOME/.rover/env"
if [[ -f "$rover_env" ]]; then
. $rover_env
fi
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.