anthill_smpp_ruby 0.5.1

data/lib/smpp_encoder.rb

@@ -0,0 +1,495 @@
+#
+#   Copyright 2007 Majoron.com (developers@majoron.com)
+#   Original sources are available at www.majoron.com
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#
+
+module Majoron
+
+  module AntHill
+  	module SMPP
+  		class SMPPEncoder < AntHill::BinaryEncoder
+  
+  			# Constructor
+  			def initialize()
+  				super()
+  			end
+  
+  			#std::vector<unsigned char>& encodePacket(SMPPPDU* poPDU)
+  
+  			# A methods to encode header
+  			def encode_header(header)
+  				encode_unsigned32(header.command_length)
+  				encode_unsigned32(header.command_id)
+  				encode_unsigned32(header.command_status)
+  				encode_unsigned32(header.sequence_number)
+  			end
+  
+  			# A methods to encode mandatory fields
+  			def encode_system_id(system_id)
+  				encode_cstring(system_id)
+  			end
+  
+  			def encode_password(password)
+  				encode_cstring(password)
+  			end
+  
+  			def encode_system_type(system_type)
+  				encode_cstring(system_type)
+  			end
+  
+  			def encode_interface_version(interface_version)
+  				encode_uchar(interface_version)
+  			end
+  
+  			def encode_addr_ton(addr_ton)
+  				encode_uchar(addr_ton)
+  			end
+  
+  			def encode_addr_npi(addr_npi)
+  				encode_uchar(addr_npi)
+  			end
+  
+  			def encode_address_range(address_range)
+  				encode_cstring(address_range)
+  			end
+  
+  			def encode_service_type(service_type)
+  				encode_cstring(service_type)
+  			end
+  
+  			def encode_source_addr_ton(source_addr_ton)
+  				encode_uchar(source_addr_ton)
+  			end
+  
+  			def encode_source_addr_npi(source_addr_npi)
+  				encode_uchar(source_addr_npi)
+  			end
+  
+  			def encode_source_addr21(source_addr)
+  				encode_cstring(source_addr)
+  			end
+  
+  			def encode_source_addr65(source_addr)
+  				encode_cstring(source_addr)
+  			end
+  
+  			def encode_dest_addr_ton(dest_addr_ton)
+  				encode_uchar(dest_addr_ton)
+  			end
+  
+  			def encode_dest_addr_npi(dest_addr_npi)
+  				encode_uchar(dest_addr_npi)
+  			end
+  
+  			def encode_dest_addr21(dest_addr)
+  				encode_cstring(dest_addr)
+  			end
+  
+  			def encode_dest_addr65(dest_addr)
+  				encode_cstring(dest_addr)
+  			end
+  
+  			def encode_esm_class(esm_class)
+  				encode_uchar(esm_class)
+  			end
+  
+  			def encode_protocol_id(protocol_id)
+  				encode_uchar(protocol_id)
+  			end
+  
+  			def encode_priority_flag(priority_flag)
+  				encode_uchar(priority_flag)
+  			end
+  
+  			def encode_schedule_delivery_time(schedule_delivery_time)
+  				encode_cstring(schedule_delivery_time)
+  			end
+  
+  			def encode_validity_period(validity_period)
+  				encode_cstring(validity_period)
+  			end
+  
+  			def encode_registered_delivery(registered_delivery)
+  				encode_uchar(registered_delivery)
+  			end
+  
+  			def encode_replace_if_present_flag(replace_if_present_flag)
+  				encode_uchar(replace_if_present_flag)
+  			end
+  
+  			def encode_data_coding(data_coding)
+  				encode_uchar(data_coding)
+  			end
+  
+  			def encode_sm_default_msg_id(sm_default_msg_id)
+  				encode_uchar(sm_default_msg_id)
+  			end
+  
+  			def encode_sm_length(sm_length)
+  				encode_uchar(sm_length)
+  			end
+  
+  			def encode_short_message(short_message)
+  				encode_binary(short_message)
+  			end
+  
+  			def encode_message_id(message_id)
+  				encode_cstring(message_id)
+  			end
+  
+  			def encode_esme_addr_ton(esme_addr_ton)
+  				encode_uchar(esme_addr_ton)
+  			end
+  
+  			def encode_esme_addr_npi(esme_addr_npi)
+  				encode_uchar(esme_addr_npi)
+  			end
+  
+  			def encode_esme_addr(esme_addr)
+  				encode_cstring(esme_addr)
+  			end
+  
+  			def encode_number_of_dest(number_of_dest)
+  				encode_uchar(number_of_dest)
+  			end
+  
+  			def encode_dest_addresses(dest_addresses)
+  				0.upto(dest_addresses.size() - 1) do |i|
+  					encode_uchar(dest_addresses[i].dest_flag)
+  					if dest_addresses[i].dest_flag == DestFlag::SME_ADDRESS
+  						encode_uchar(dest_addresses[i].address().ton())
+  						encode_uchar(dest_addresses[i].address().npi())
+  						encode_cstring(dest_addresses[i].address().address())
+  					elsif dest_addresses[i].dest_flag == DestFlag::DISTR_LIST_NAME
+  						encode_cstring(dest_addresses[i].distr_list_name())
+  					else
+  						raise sprintf(CodecErrors::ENCODER_INV_DSTFLAG, @offset, dest_addresses[i].dest_flag())
+  					end
+  				end
+  			end
+  
+  			def encode_no_unsuccess(no_unsuccess)
+  				encode_uchar(no_unsuccess)
+  			end
+  
+  			def encode_unsuccess_smes(unsuccess_smes)
+  				0.upto(unsuccess_smes.size() - 1) do |i|
+  					encode_uchar(unsuccess_smes[i].sme_address().ton())
+  					encode_uchar(unsuccess_smes[i].sme_address().npi())
+  					encode_cstring(unsuccess_smes[i].sme_address().address())
+  					encode_unsigned32(unsuccess_smes[i].error_status_code())
+  				end
+  			end
+  
+  			def encode_final_date(final_date)
+  				encode_cstring(final_date)
+  			end
+  
+  			def encode_error_code(error_code)
+  				encode_uchar(error_code)
+  			end
+  
+  			def encode_message_state(message_state)
+  				encode_uchar(message_state)
+  			end
+  
+  			def encode_broadcast_area_identifier(broadcast_area_identifier, len)
+  				0.upto(broadcast_area_identifier.size() - 1) do |i|
+  					encode_binary_tlv(OptTags::TAG_BROADCAST_AREA_IDENTIFIER, broadcast_area_identifier[i].value(), len[i])
+  				end
+  			end
+  
+  			def encode_broadcast_area_identifier_single(broadcast_area_identifier, len)
+  				encode_binary_tlv(OptTags::TAG_BROADCAST_AREA_IDENTIFIER, broadcast_area_identifier.value(), len)
+  			end
+  
+  			def encode_broadcast_rep_num(broadcast_rep_num, len)
+  				encode_uint16_tlv(OptTags::TAG_BROADCAST_REP_NUM, broadcast_rep_num, len)
+  			end
+  
+  			def encode_broadcast_frequency_interval(broadcast_frequency_interval, len)
+  				encode_binary_tlv(OptTags::TAG_BROADCAST_FREQUENCY_INTERVAL, broadcast_frequency_interval, len)
+  			end
+  
+  			def encode_broadcast_area_success(broadcast_area_success, len)
+  				encode_uchar_tlv(OptTags::TAG_BROADCAST_AREA_SUCCESS, broadcast_area_success, len)
+  			end
+  
+  			# A methods to encode optional fields
+  			def encode_sc_interface_version(sc_interface_version, len)
+  				encode_uchar_tlv(OptTags::TAG_SC_INTERFACE_VERSION, sc_interface_version, len)
+  			end
+  
+  			def encode_ms_availability_status(ms_availability_status, len)
+  				encode_uchar_tlv(OptTags::TAG_MS_AVAILABILITY_STATUS, ms_availability_status, len)
+  			end
+  
+  			def encode_alert_on_msg_delivery(alert_on_msg_delivery, len)
+  				encode_uchar_tlv(OptTags::TAG_ALERT_ON_MESSAGE_DELIVERY, alert_on_msg_delivery, len)
+  			end
+  
+  			def encode_broadcast_channel_indicator(broadcast_channel_indicator, len)
+  				encode_uchar_tlv(OptTags::TAG_BROADCAST_CHANNEL_INDICATOR, broadcast_channel_indicator, len)
+  			end
+  
+  			def encode_broadcast_content_type_info(broadcast_content_type_info, len)
+  				encode_binary_tlv(OptTags::TAG_BROADCAST_CONTENT_TYPE_INFO, broadcast_content_type_info, len)
+  			end
+  
+  			def encode_broadcast_message_class(broadcast_message_class, len)
+  				encode_uchar_tlv(OptTags::TAG_BROADCAST_MESSAGE_CLASS, broadcast_message_class, len)
+  			end
+  
+  			def encode_broadcast_service_group(broadcast_service_group, len)
+  				encode_binary_tlv(OptTags::TAG_BROADCAST_SERVICE_GROUP, broadcast_service_group, len)
+  			end
+  
+  			def encode_callback_num(callback_num, len)
+  				encode_binary_tlv(OptTags::TAG_CALLBACK_NUM, callback_num, len)
+  			end
+  
+  			def encode_callback_num_atag(callback_num_atag, len)
+  				encode_binary_tlv(OptTags::TAG_CALLBACK_NUM_ATAG, callback_num_atag, len)
+  			end
+  
+  			def encode_callback_num_pres_ind(callback_num_pres_ind, len)
+  				encode_uchar_tlv(OptTags::TAG_CALLBACK_NUM_PRES_IND, callback_num_pres_ind, len)
+  			end
+  
+  			def encode_dest_addr_subunit(dest_addr_subunit, len)
+  				encode_uchar_tlv(OptTags::TAG_DEST_ADDR_SUBUNIT, dest_addr_subunit, len)
+  			end
+  
+  			def encode_dest_subaddress(dest_subaddress, len)
+  				encode_binary_tlv(OptTags::TAG_DEST_SUBADDRESS, dest_subaddress, len)
+  			end
+  
+  			def encode_display_time(display_time, len)
+  				encode_uchar_tlv(OptTags::TAG_DISPLAY_TIME, display_time, len)
+  			end
+  
+  			def encode_language_indicator(language_indicator, len)
+  				encode_uchar_tlv(OptTags::TAG_LANGUAGE_INDICATOR, language_indicator, len)
+  			end
+  
+  			def encode_message_payload(message_payload, len)
+  				encode_binary_tlv(OptTags::TAG_MESSAGE_PAYLOAD, message_payload, len)
+  			end
+  
+  			def encode_ms_validity(ms_validity, len)
+  				encode_uchar_tlv(OptTags::TAG_MS_VALIDITY, ms_validity, len)
+  			end
+  
+  			def encode_payload_type(payload_type, len)
+  				encode_uchar_tlv(OptTags::TAG_PAYLOAD_TYPE, payload_type, len)
+  			end
+  
+  			def encode_privacy_indicator(privacy_indicator, len)
+  				encode_uchar_tlv(OptTags::TAG_PRIVACY_INDICATOR, privacy_indicator, len)
+  			end
+  
+  			def encode_sms_signal(sms_signal, len)
+  				encode_uint16_tlv(OptTags::TAG_SMS_SIGNAL, sms_signal, len)
+  			end
+  
+  			def encode_source_addr_subunit(source_addr_subunit, len)
+  				encode_uchar_tlv(OptTags::TAG_SOURCE_ADDR_SUBUNIT, source_addr_subunit, len)
+  			end
+  
+  			def encode_source_port(source_port, len)
+  				encode_uint16_tlv(OptTags::TAG_SOURCE_PORT, source_port, len)
+  			end
+  
+  			def encode_source_subaddress(source_subaddress, len)
+  				encode_binary_tlv(OptTags::TAG_SOURCE_SUBADDRESS, source_subaddress, len)
+  			end
+  
+  			def encode_user_message_reference(user_message_reference, len)
+  				encode_uint16_tlv(OptTags::TAG_USER_MESSAGE_REFERENCE, user_message_reference, len)
+  			end
+  
+  			def encode_broadcast_error_status(broadcast_error_status, len)
+  				encode_uint32_tlv(OptTags::TAG_BROADCAST_ERROR_STATUS, broadcast_error_status, len)
+  			end
+  
+  			def encode_failed_broadcast_area_identifier(failed_broadcast_area_identifier, len)
+  				0.upto(failed_broadcast_area_identifier.size() - 1) do |i|
+  					encode_binary_tlv(OptTags::TAG_BROADCAST_AREA_IDENTIFIER, failed_broadcast_area_identifier[i].value(), len[i])
+  				end
+  			end
+  
+  			def encode_failed_broadcast_area_identifier_single(failed_broadcast_area_identifier, len)
+  				encode_binary_tlv(OptTags::TAG_BROADCAST_AREA_IDENTIFIER, failed_broadcast_area_identifier.value(), len)
+  			end
+  
+  			def encode_broadcast_content_type(broadcast_content_type, len)
+  				encode_binary_tlv(OptTags::TAG_BROADCAST_CONTENT_TYPE, broadcast_content_type, len)
+  			end
+  
+  			def encode_source_network_type(source_network_type, len)
+  				encode_uchar_tlv(OptTags::TAG_SOURCE_NETWORK_TYPE, source_network_type, len)
+  			end
+  
+  			def encode_source_bearer_type(source_bearer_type, len)
+  				encode_uchar_tlv(OptTags::TAG_SOURCE_BEARER_TYPE, source_bearer_type, len)
+  			end
+  
+  			def encode_source_telematics_id(source_telematics_id, len)
+  				encode_uchar_tlv(OptTags::TAG_SOURCE_TELEMATICS_ID, source_telematics_id, len)
+  			end
+  
+  			def encode_destination_port(destination_port, len)
+  				encode_uint16_tlv(OptTags::TAG_DESTINATION_PORT, destination_port, len)
+  			end
+  
+  			def encode_dest_network_type(dest_network_type, len)
+  				encode_uchar_tlv(OptTags::TAG_DEST_NETWORK_TYPE, dest_network_type, len)
+  			end
+  
+  			def encode_dest_bearer_type(dest_bearer_type, len)
+  				encode_uchar_tlv(OptTags::TAG_DEST_BEARER_TYPE, dest_bearer_type, len)
+  			end
+  
+  			def encode_dest_telematics_id(dest_telematics_id, len)
+  				encode_uchar_tlv(OptTags::TAG_DEST_TELEMATICS_ID, dest_telematics_id, len)
+  			end
+  
+  			def encode_sar_msg_ref_num(sar_msg_ref_num, len)
+  				encode_uint16_tlv(OptTags::TAG_SAR_MSG_REF_NUM, sar_msg_ref_num, len)
+  			end
+  
+  			def encode_sar_total_segments(sar_total_segments, len)
+  				encode_uchar_tlv(OptTags::TAG_SAR_TOTAL_SEGMENTS, sar_total_segments, len)
+  			end
+  
+  			def encode_sar_segment_seqnum(sar_segment_seqnum, len)
+  				encode_uchar_tlv(OptTags::TAG_SAR_SEGMENT_SEQNUM, sar_segment_seqnum, len)
+  			end
+  
+  			def encode_more_messages_to_send(more_messages_to_send, len)
+  				encode_uchar_tlv(OptTags::TAG_MORE_MESSAGES_TO_SEND, more_messages_to_send, len)
+  			end
+  
+  			def encode_qos_time_to_live(qos_time_to_live, len)
+  				encode_uint32_tlv(OptTags::TAG_QOS_TIME_TO_LIVE, qos_time_to_live, len)
+  			end
+  
+  			def encode_set_dpf(set_dpf, len)
+  				encode_uchar_tlv(OptTags::TAG_SET_DPF, set_dpf, len)
+  			end
+  
+  			def encode_receipted_message_id(receipted_message_id, len)
+  				encode_cstring_tlv(OptTags::TAG_RECEIPTED_MESSAGE_ID, receipted_message_id, len)
+  			end
+  
+  			def encode_message_state_tlv(message_state_tlv, len)
+  				encode_uchar_tlv(OptTags::TAG_MESSAGE_STATE, message_state_tlv, len)
+  			end
+  
+  			def encode_network_error_code(network_error_code, len)
+  				encode_unsigned16(OptTags::TAG_NETWORK_ERROR_CODE)
+  				encode_unsigned16(len)
+  				encode_uchar(network_error_code.network_code())
+  				encode_unsigned16(network_error_code.error_code())
+  			end
+  
+  			def encode_ms_msg_wait_facilities(ms_msg_wait_facilities, len)
+  				encode_uchar_tlv(OptTags::TAG_MS_MSG_WAIT_FACILITIES, ms_msg_wait_facilities, len)
+  			end
+  
+  			def encode_number_of_messages(number_of_messages, len)
+  				encode_uchar_tlv(OptTags::TAG_NUMBER_OF_MESSAGES, number_of_messages, len)
+  			end
+  
+  			def encode_its_reply_type(its_reply_type, len)
+  				encode_uchar_tlv(OptTags::TAG_ITS_REPLY_TYPE, its_reply_type, len)
+  			end
+  
+  			def encode_its_session_info(its_session_info, len)
+  				encode_uint16_tlv(OptTags::TAG_ITS_SESSION_INFO, its_session_info, len)
+  			end
+  
+  			def encode_user_response_code(user_response_code, len)
+  				encode_uchar_tlv(OptTags::TAG_USER_RESPONSE_CODE, user_response_code, len)
+  			end
+  
+  			def encode_delivery_failure_reason(delivery_failure_reason, len)
+  				encode_uchar_tlv(OptTags::TAG_DELIVERY_FAILURE_REASON, delivery_failure_reason, len)
+  			end
+  
+  			def encode_additional_status_info_text(additional_status_info_text, len)
+  				encode_binary_tlv(OptTags::TAG_ADDITIONAL_STATUS_INFO_TEXT, additional_status_info_text, len)
+  			end
+  
+  			def encode_dpf_result(dpf_result, len)
+  				encode_uchar_tlv(OptTags::TAG_DPF_RESULT, dpf_result, len)
+  			end
+  
+  			def encode_broadcast_end_time(broadcast_end_time, len)
+  				encode_cstring_tlv(OptTags::TAG_BROADCAST_END_TIME, broadcast_end_time, len)
+  			end
+  
+  			def encode_ussd_service_op(ussd_service_op, len)
+  				encode_uchar_tlv(OptTags::TAG_USSD_SERVICE_OP, ussd_service_op, len)
+  			end
+  
+  			# Method to encode command length for pdu
+  			def encode_command_length()
+  				sizeof = 4
+  				shift = SMPPOffset::COMMAND_LENGTH_POS
+  				len = sprintf("%c%c%c%c", @offset >> 24, @offset >> 16, @offset >> 8, @offset & 0xff)
+  
+  				0.upto(sizeof - 1) do |i|
+  					@buffer[shift + i] = len[i]
+  				end
+  			end
+  
+  
+  		private
+  			# Auxiliary methods to encode
+  			def encode_uchar_tlv(tag, value, len)
+  				encode_unsigned16(tag)
+  				encode_unsigned16(len)
+  				encode_uchar(value)
+  			end
+  
+  			def encode_uint16_tlv(tag, value, len)
+  				encode_unsigned16(tag)
+  				encode_unsigned16(len)
+  				encode_unsigned16(value)
+  			end
+  
+  			def encode_uint32_tlv(tag, value, len)
+  				encode_unsigned16(tag)
+  				encode_unsigned16(len)
+  				encode_unsigned32(value)
+  			end
+  
+  			def encode_cstring_tlv(tag, value, len)
+  				encode_unsigned16(tag)
+  				encode_unsigned16(len)
+  				encode_cstring(value)
+  			end
+  
+  			def encode_binary_tlv(tag, value, len)
+  				encode_unsigned16(tag)
+  				encode_unsigned16(len)
+  				encode_binary(value)
+  			end
+  		end
+  
+  	end
+  end
+end