doubango/tinySMS/src/tpdu/tsms_tpdu_report.c
c732d49e
 #if HAVE_CRT
 #define _CRTDBG_MAP_ALLOC 
 #include <stdlib.h> 
 #include <crtdbg.h>
 #endif //HAVE_CRT
 /*
74ca6d11
 * Copyright (C) 2020, University of the Basque Country (UPV/EHU)
c732d49e
 * Contact for licensing options: <licensing-mcpttclient(at)mcopenplatform(dot)com>
 *
 * The original file was part of Open Source Doubango Framework
 * Copyright (C) 2010-2011 Mamadou Diop.
 * Copyright (C) 2012 Doubango Telecom <http://doubango.org>
 *
 * This file is part of Open Source Doubango Framework.
 *
 * DOUBANGO is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * DOUBANGO is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with DOUBANGO.
 *
 */
 
 /**@file tsms_tpdu_report.c
  * @brief SMS TPDU SMS-DELIVER-REPORT and SMS-SUBMIT-REPORT message as per 3GPP TS 23.040 section 9.2.2.1a and 9.2.2.2a.
  *
  * @author Mamadou Diop <diopmamadou(at)doubango.org>
  *
 
  */
 #include "tinysms/tpdu/tsms_tpdu_report.h"
 
 #include "tsk_string.h"
 #include "tsk_memory.h"
 #include "tsk_debug.h"
 
 #include <string.h> /* memcpy */
 
 #define TSMS_ERROR_TOO_SHORT()\
 	TSK_DEBUG_ERROR("SMS-DELIVER-REPORT/MS-SUBMIT-REPORT == Data too short.");\
 	failed = tsk_true;\
 	goto bail;
 
 tsms_tpdu_message_t* _tsms_tpdu_report_deserialize_2(const void* data, tsk_size_t size, tsk_bool_t error)
 {
 	/* You don't need to test data and test, this is an internal function called by tsms_tpdu_message_deserialize() */
 	tsms_tpdu_report_t* self = tsms_tpdu_report_create(tsk_null, tsk_false, error);
 	tsk_bool_t failed = tsk_false;
 //	tsk_size_t any_len;
 	const uint8_t* pdata = data;
 	const uint8_t* pend = pdata + size;
 
 	/* SMSC address */
 #if TSMS_TPDU_APPEND_SMSC && 0
 	if(!(self->smsc = tsms_address_deserialize(data, size, tsms_addr_smsc, &any_len)) || !any_len){
 		TSK_DEBUG_ERROR("SMS-DELIVER == Failed to parse SMSC address");
 		failed = tsk_true;
 		goto bail;
 	}
 	else{
 		if((pdata += any_len) >= pend){
 			TSMS_ERROR_TOO_SHORT();
 		}
 	}
 #endif
 
 	/* SMS-DELIVER-REPORT/MS-SUBMIT-REPORT (both ACK and ERROR) first Octect:
 		- TP-Message-Type-Indicator(2b)
 		- TP-User-Data-Header-Indication(1b)
 
 		+----+----+----+----+----+----+----+----+
 		|    |UDHI|    |	|	 |    | MTI	    |
 		+----+----+----+----+----+----+----+----+
 	*/
 	TSMS_TPDU_MESSAGE(self)->mti = *pdata & 0x03;
 	self->udhi = (*pdata & 0x40)>>6;
 	if((++pdata) >= pend){
 		TSMS_ERROR_TOO_SHORT();
 	}
 	
 	if(self->error){ /* FIXME ==> should comes from RP layer */
 		/* 3GPP TS 23.040 ==> 9.2.3.22 TP-Failure-Cause(TP-FCS) */
 		//tsk_buffer_append(output, &self->fcs, 1); /*0x00-0xFF ==> 1o*/
 	}
 	
 	/* 3GPP TS 23.040 ==> 9.2.3.27 TP-Parameter-Indicator (TP-PI) 
 	* 1o 
 	bit 7			bit 6		bit 5		bit 4		bit 3		bit 2	bit 1	bit 0
 	Extension bit	Reserved	Reserved	Reserved	Reserved	TP UDL	TP DCS	TP PID
 	*/
 	self->pi = *pdata;
 	if((++pdata) >= pend){
 		TSMS_ERROR_TOO_SHORT();
 	}
 
 	if(TSMS_TPDU_MESSAGE(self)->mti == tsms_tpdu_mti_submit_report_mt){
 		/* 3GPP TS 23.040 ==> TP-Service-Centre-Time-Stamp (TP-SCTS) 
 		* 7o */
 		if((pend - pdata)<7){
 			TSMS_ERROR_TOO_SHORT();
 		}
 		memcpy(self->scts, pdata, 7);
 		pdata += 7;	
 	}
 	
 	if(self->pi & 0x01){ /* bit 0 */
 		/* 3GPP TS 23.040 ==> 9.2.3.9 TP-Protocol-Identifier (TP-PID) 
 		* 1o */
 		TSMS_TPDU_MESSAGE(self)->pid = *pdata;
 		if((++pdata) >= pend){
 			TSMS_ERROR_TOO_SHORT();
 		}
 	}
 	
 	if(self->pi & 0x02){ /* bit 1 */
 		/* 3GPP TS 23.040 ==> 9.2.3.10 TP-Data-Coding-Scheme (TP-DCS) 
 		* 1o */
 		TSMS_TPDU_MESSAGE(self)->dcs = *pdata;
 		if((++pdata) >= pend){
 			TSMS_ERROR_TOO_SHORT();
 		}
 	}
 	
 	if(self->pi & 0x04){ /* bit 2 */
 		/* 3GPP TS 23.040 ==> 9.2.3.16 TP-User-Data-Length (TP-UDL) 
 		* 1o */
 		TSMS_TPDU_MESSAGE(self)->udl = *pdata;
 		pdata++;
 
 		/* 3GPP TS 23.040 ==> 9.2.3.24 TP-User Data (TP-UD) */
 		if((pend-pdata) > 0){
 			TSMS_TPDU_MESSAGE(self)->ud = tsk_buffer_create(pdata, (pend-pdata));
 		}
 	}	
 
 bail:
 	if(failed){
 		TSK_OBJECT_SAFE_FREE(self);
 	}
 	return TSMS_TPDU_MESSAGE(self);
 }
 
 tsms_tpdu_message_t* _tsms_tpdu_report_deserialize(const void* data, tsk_size_t size)
 {
 	return _tsms_tpdu_report_deserialize_2(data, size, tsk_false);
 }
 
 int _tsms_tpdu_report_serialize(const tsms_tpdu_report_t* self, tsk_buffer_t* output)
 {
 	uint8_t _1byte;
 
 	if(!self){
 		return -1;
 	}
 
 	/* SMSC address */
 #if TSMS_TPDU_APPEND_SMSC
 	tsms_address_serialize(self->smsc, output);
 #endif
 
 	/* SMS-DELIVER-REPORT/MS-SUBMIT-REPORT (both ACK and ERROR) first Octect:
 		- TP-Message-Type-Indicator(2b)
 		- TP-User-Data-Header-Indication(1b)
 
 		+----+----+----+----+----+----+----+----+
 		|    |UDHI|    |	|	 |    | MTI	    |
 		+----+----+----+----+----+----+----+----+
 	*/
 	_1byte = (TSMS_TPDU_MESSAGE(self)->mti & 0xF3); /*2b*/
 	_1byte |= ((uint8_t)self->udhi) << 6; /*1b*/
 	tsk_buffer_append(output, &_1byte, 1);
 	
 	if(self->error){
 		/* 3GPP TS 23.040 ==> 9.2.3.22 TP-Failure-Cause(TP-FCS) */
 		tsk_buffer_append(output, &self->fcs, 1); /*0x00-0xFF ==> 1o*/
 	}
 	
 	/* 3GPP TS 23.040 ==> 9.2.3.27 TP-Parameter-Indicator (TP-PI)
 		bit 7			bit 6		bit 5		bit 4		bit 3		bit 2	bit 1	bit 0
 		Extension bit	Reserved	Reserved	Reserved	Reserved	TP UDL	TP DCS	TP PID
 		As we are the serializer, we know which field should be added or not ==> append our own TP-PI field
 	*/
 	_1byte = self->pi | 0x07 /* Bits 2,1 and 0 to '1' */;
 	tsk_buffer_append(output, &_1byte, 1); /* 1o*/
 	
 	if(TSMS_TPDU_MESSAGE(self)->mti == tsms_tpdu_mti_submit_report_mt){
 		/* 3GPP TS 23.040 ==> TP-Service-Centre-Time-Stamp (TP-SCTS) */
 		tsk_buffer_append(output, self->scts, sizeof(self->scts)); /*7o*/
 	}
 	
 	/* 3GPP TS 23.040 ==> 9.2.3.9 TP-Protocol-Identifier (TP-PID) */
 	tsk_buffer_append(output, &TSMS_TPDU_MESSAGE(self)->pid, 1); /*1o*/
 	
 	/* 3GPP TS 23.040 ==> 9.2.3.10 TP-Data-Coding-Scheme (TP-DCS) */
 	tsk_buffer_append(output, &TSMS_TPDU_MESSAGE(self)->dcs, 1); /*1o*/	
 	
 	/* 3GPP TS 23.040 ==> 9.2.3.16 TP-User-Data-Length (TP-UDL) */
 	tsk_buffer_append(output, &TSMS_TPDU_MESSAGE(self)->udl, 1); /*1o*/
 	
 	/* 3GPP TS 23.040 ==> 9.2.3.24 TP-User Data (TP-UD) */
 	tsk_buffer_append(output, TSK_BUFFER_DATA(TSMS_TPDU_MESSAGE(self)->ud), TSK_BUFFER_SIZE(TSMS_TPDU_MESSAGE(self)->ud)); 
 
 	return 0;
 }
 
 tsms_tpdu_report_t* tsms_tpdu_report_create(const tsms_address_string_t smsc, tsk_bool_t submit, tsk_bool_t error)
 {
 	tsms_tpdu_report_t* ret = tsk_null;
 	
 	if(!(ret = tsk_object_new(tsms_tpdu_report_def_t, smsc, submit, error))){
 		goto bail;
 	}
 	
 bail:
 	return ret;
 }
 
 
 int tsms_tpdu_report_set_fcs(tsms_tpdu_report_t* self, uint8_t code)
 {
 	if(self){
 		tsms_tpdu_report_t* report = self;
 		report->fcs = code;
 		return 0;
 	}
 	return -1;
 }
 
 //=================================================================================================
 //	SMS TPDU SMS-DELIVER-REPORT/SMS-SUBMIT-REPORT object definition
 //
 static tsk_object_t* tsms_tpdu_report_ctor(tsk_object_t * self, va_list * app)
 {
 	tsms_tpdu_report_t *report = self;
 	if(report){
 		const char* smsc;
 		tsk_bool_t error, submit;
 		
 		smsc = va_arg(*app, const char*);
 		submit = va_arg(*app, tsk_bool_t);	
 		error = va_arg(*app, tsk_bool_t);		
 		
 		/* init base*/
 		tsms_tpdu_message_init(TSMS_TPDU_MESSAGE(report), submit?tsms_tpdu_mti_submit_report_mt
 			:tsms_tpdu_mti_deliver_report_mo);
 		/* init self */
 		if(smsc){
 			report->smsc = tsms_address_smsc_create((const uint8_t*)smsc);
 		}
 		report->error = error;
 		
 		/*init self*/
 		if(report->error){
 			report->fcs = TSMS_TPDU_DEFAULT_FCS;
 		}
 	}
 	else{
 		TSK_DEBUG_ERROR("Null");
 	}
 	return self;
 }
 
 static tsk_object_t* tsms_tpdu_report_dtor(tsk_object_t * self)
 { 
 	tsms_tpdu_report_t *report = self;
 	if(report){
 		/*deinit base*/
 		tsms_tpdu_message_deinit(TSMS_TPDU_MESSAGE(report));
 		/*deinit self*/
 		TSK_OBJECT_SAFE_FREE(report->smsc);
 	}
 	else{
 		TSK_DEBUG_ERROR("Null");
 	}
 	return self;
 }
 
 static const tsk_object_def_t tsms_tpdu_report_def_s = 
 {
 	sizeof(tsms_tpdu_report_t),
 	tsms_tpdu_report_ctor, 
 	tsms_tpdu_report_dtor,
 	tsk_null, 
 };
 const tsk_object_def_t *tsms_tpdu_report_def_t = &tsms_tpdu_report_def_s;