text: /*####COPYRIGHTBEGIN####
   -------------------------------------------
   Copyright (C) 2005 Steve Karg
  
   This program 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 2
   of the License, or (at your option) any later version.
  
   This program 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 this program; if not, write to:
   The Free Software Foundation, Inc.
   59 Temple Place - Suite 330
   Boston, MA  02111-1307, USA.
  
   As a special exception, if other files instantiate templates or
   use macros or inline functions from this file, or you compile
   this file and link it with other works to produce a work based
   on this file, this file does not by itself cause the resulting
   work to be covered by the GNU General Public License. However
   the source code for this file must still be made available in
   accordance with section (3) of the GNU General Public License.
  
   This exception does not invalidate any other reasons why a work
   based on this file might be covered by the GNU General Public
   License.
   -------------------------------------------
  ####COPYRIGHTEND####*/
  #include <stdint.h>
  #include "bacenum.h"
  #include "bacdcode.h"
  #include "bacdef.h"
  #include "rp.h"
  
  /** @file rp.c  Encode/Decode Read Property and RP ACKs */
  
  #if BACNET_SVC_RP_A
  /* encode service */
  int rp_encode_apdu(
      uint8_t * apdu,
      uint8_t invoke_id,
      BACNET_READ_PROPERTY_DATA * rpdata)
  {
      int len = 0;        /* length of each encoding */
      int apdu_len = 0;   /* total length of the apdu, return value */
  
      if (apdu) {
          apdu[0] = PDU_TYPE_CONFIRMED_SERVICE_REQUEST;
          apdu[1] = encode_max_segs_max_apdu(0, MAX_APDU);
          apdu[2] = invoke_id;
          apdu[3] = SERVICE_CONFIRMED_READ_PROPERTY;      /* service choice */
          apdu_len = 4;
          if (rpdata->object_type <= BACNET_MAX_OBJECT) {
              /* check bounds so that we could create malformed
                 messages for testing */
              len =
                  encode_context_object_id(&apdu[apdu_len], 0,
                  rpdata->object_type, rpdata->object_instance);
              apdu_len += len;
          }
          if (rpdata->object_property <= MAX_BACNET_PROPERTY_ID) {
              /* check bounds so that we could create malformed
                 messages for testing */
              len =
                  encode_context_enumerated(&apdu[apdu_len], 1,
                  rpdata->object_property);
              apdu_len += len;
          }
          /* optional array index */
          if (rpdata->array_index != BACNET_ARRAY_ALL) {
              len =
                  encode_context_unsigned(&apdu[apdu_len], 2,
                  rpdata->array_index);
              apdu_len += len;
          }
      }
  
      return apdu_len;
  }
  #endif
  
  /* decode the service request only */
  int rp_decode_service_request(
      uint8_t * apdu,
      unsigned apdu_len,
      BACNET_READ_PROPERTY_DATA * rpdata)
  {
      unsigned len = 0;
      uint8_t tag_number = 0;
      uint32_t len_value_type = 0;
      uint16_t type = 0;  /* for decoding */
      uint32_t property = 0;      /* for decoding */
      uint32_t array_value = 0;   /* for decoding */
  
      /* check for value pointers */
      if (rpdata != NULL) {
          /* Must have at least 2 tags, an object id and a property identifier
           * of at least 1 byte in length to have any chance of parsing */
          if (apdu_len < 7) {
              rpdata->error_code = ERROR_CODE_REJECT_MISSING_REQUIRED_PARAMETER;
              return BACNET_STATUS_REJECT;
          }
  
          /* Tag 0: Object ID          */
          if (!decode_is_context_tag(&apdu[len++], 0)) {
              rpdata->error_code = ERROR_CODE_REJECT_INVALID_TAG;
              return BACNET_STATUS_REJECT;
          }
          len += decode_object_id(&apdu[len], &type, &rpdata->object_instance);
          rpdata->object_type = (BACNET_OBJECT_TYPE) type;
          /* Tag 1: Property ID */
          len +=
              decode_tag_number_and_value(&apdu[len], &tag_number,
              &len_value_type);
          if (tag_number != 1) {
              rpdata->error_code = ERROR_CODE_REJECT_INVALID_TAG;
              return BACNET_STATUS_REJECT;
          }
          len += decode_enumerated(&apdu[len], len_value_type, &property);
          rpdata->object_property = (BACNET_PROPERTY_ID) property;
          /* Tag 2: Optional Array Index */
          if (len < apdu_len) {
              len +=
                  decode_tag_number_and_value(&apdu[len], &tag_number,
                  &len_value_type);
              if ((tag_number == 2) && (len < apdu_len)) {
                  len +=
                      decode_unsigned(&apdu[len], len_value_type, &array_value);
                  rpdata->array_index = array_value;
              } else {
                  rpdata->error_code = ERROR_CODE_REJECT_INVALID_TAG;
                  return BACNET_STATUS_REJECT;
              }
          } else
              rpdata->array_index = BACNET_ARRAY_ALL;
      }
  
      if (len < apdu_len) {
          /* If something left over now, we have an invalid request */
          rpdata->error_code = ERROR_CODE_REJECT_TOO_MANY_ARGUMENTS;
          return BACNET_STATUS_REJECT;
      }
  
      return (int) len;
  }
  
  /* alternate method to encode the ack without extra buffer */
  int rp_ack_encode_apdu_init(
      uint8_t * apdu,
      uint8_t invoke_id,
      BACNET_READ_PROPERTY_DATA * rpdata)
  {
      int len = 0;        /* length of each encoding */
      int apdu_len = 0;   /* total length of the apdu, return value */
  
      if (apdu) {
          apdu[0] = PDU_TYPE_COMPLEX_ACK; /* complex ACK service */
          apdu[1] = invoke_id;    /* original invoke id from request */
          apdu[2] = SERVICE_CONFIRMED_READ_PROPERTY;      /* service choice */
          apdu_len = 3;
  
          /* service ack follows */
          len =
              encode_context_object_id(&apdu[apdu_len], 0, rpdata->object_type,
              rpdata->object_instance);
          apdu_len += len;
          len =
              encode_context_enumerated(&apdu[apdu_len], 1,
              rpdata->object_property);
          apdu_len += len;
          /* context 2 array index is optional */
          if (rpdata->array_index != BACNET_ARRAY_ALL) {
              len =
                  encode_context_unsigned(&apdu[apdu_len], 2,
                  rpdata->array_index);
              apdu_len += len;
          }
          len = encode_opening_tag(&apdu[apdu_len], 3);
          apdu_len += len;
      }
  
      return apdu_len;
  }
  
  /* note: encode the application tagged data yourself */
  int rp_ack_encode_apdu_object_property_end(
      uint8_t * apdu)
  {
      int apdu_len = 0;   /* total length of the apdu, return value */
  
      if (apdu) {
          apdu_len = encode_closing_tag(&apdu[0], 3);
      }
  
      return apdu_len;
  }
  
  int rp_ack_encode_apdu(
      uint8_t * apdu,
      uint8_t invoke_id,
      BACNET_READ_PROPERTY_DATA * rpdata)
  {
      int len = 0;        /* length of each encoding */
      int apdu_len = 0;   /* total length of the apdu, return value */
  
      if (apdu) {
          /* Do the initial encoding */
          apdu_len = rp_ack_encode_apdu_init(apdu, invoke_id, rpdata);
          /* propertyValue */
          for (len = 0; len < rpdata->application_data_len; len++) {
              apdu[apdu_len++] = rpdata->application_data[len];
          }
          apdu_len += encode_closing_tag(&apdu[apdu_len], 3);
      }
  
      return apdu_len;
  }
  
  
  #if BACNET_SVC_RP_A
  /** Decode the ReadProperty reply and store the result for one Property in a
   *  BACNET_READ_PROPERTY_DATA structure.
   *  This leaves the value(s) in the application_data buffer to be decoded later;
   *  the application_data field points into the apdu buffer (is not allocated).
   *
   * @param apdu [in] The apdu portion of the ACK reply.
   * @param apdu_len [in] The total length of the apdu.
   * @param rpdata [out] The structure holding the partially decoded result.
   * @return Number of decoded bytes (could be less than apdu_len),
   * 			or -1 on decoding error.
   */
  int rp_ack_decode_service_request(
      uint8_t * apdu,
      int apdu_len,       /* total length of the apdu */
      BACNET_READ_PROPERTY_DATA * rpdata)
  {
      uint8_t tag_number = 0;
      uint32_t len_value_type = 0;
      int tag_len = 0;    /* length of tag decode */
      int len = 0;        /* total length of decodes */
      uint16_t object = 0;        /* object type */
      uint32_t property = 0;      /* for decoding */
      uint32_t array_value = 0;   /* for decoding */
  
      /* FIXME: check apdu_len against the len during decode   */
      /* Tag 0: Object ID */
      if (!decode_is_context_tag(&apdu[0], 0))
          return -1;
      len = 1;
      len += decode_object_id(&apdu[len], &object, &rpdata->object_instance);
      rpdata->object_type = (BACNET_OBJECT_TYPE) object;
      /* Tag 1: Property ID */
      len +=
          decode_tag_number_and_value(&apdu[len], &tag_number, &len_value_type);
      if (tag_number != 1)
          return -1;
      len += decode_enumerated(&apdu[len], len_value_type, &property);
      rpdata->object_property = (BACNET_PROPERTY_ID) property;
      /* Tag 2: Optional Array Index */
      tag_len =
          decode_tag_number_and_value(&apdu[len], &tag_number, &len_value_type);
      if (tag_number == 2) {
          len += tag_len;
          len += decode_unsigned(&apdu[len], len_value_type, &array_value);
          rpdata->array_index = array_value;
      } else
          rpdata->array_index = BACNET_ARRAY_ALL;
      /* Tag 3: opening context tag */
      if (decode_is_opening_tag_number(&apdu[len], 3)) {
          /* a tag number of 3 is not extended so only one octet */
          len++;
          /* don't decode the application tag number or its data here */
          rpdata->application_data = &apdu[len];
          rpdata->application_data_len = apdu_len - len - 1 /*closing tag */ ;
          /* len includes the data and the closing tag */
          len = apdu_len;
      } else {
          return -1;
      }
  
      return len;
  }
  #endif
  
  #ifdef TEST
  #include <assert.h>
  #include <string.h>
  #include "ctest.h"
  
  int rp_decode_apdu(
      uint8_t * apdu,
      unsigned apdu_len,
      uint8_t * invoke_id,
      BACNET_READ_PROPERTY_DATA * rpdata)
  {
      int len = 0;
      unsigned offset = 0;
  
      if (!apdu)
          return -1;
      /* optional checking - most likely was already done prior to this call */
      if (apdu[0] != PDU_TYPE_CONFIRMED_SERVICE_REQUEST)
          return -1;
      /*  apdu[1] = encode_max_segs_max_apdu(0, MAX_APDU); */
      *invoke_id = apdu[2];       /* invoke id - filled in by net layer */
      if (apdu[3] != SERVICE_CONFIRMED_READ_PROPERTY)
          return -1;
      offset = 4;
  
      if (apdu_len > offset) {
          len =
              rp_decode_service_request(&apdu[offset], apdu_len - offset,
              rpdata);
      }
  
      return len;
  }
  
  int rp_ack_decode_apdu(
      uint8_t * apdu,
      int apdu_len,       /* total length of the apdu */
      uint8_t * invoke_id,
      BACNET_READ_PROPERTY_DATA * rpdata)
  {
      int len = 0;
      int offset = 0;
  
      if (!apdu)
          return -1;
      /* optional checking - most likely was already done prior to this call */
      if (apdu[0] != PDU_TYPE_COMPLEX_ACK)
          return -1;
      *invoke_id = apdu[1];
      if (apdu[2] != SERVICE_CONFIRMED_READ_PROPERTY)
          return -1;
      offset = 3;
      if (apdu_len > offset) {
          len =
              rp_ack_decode_service_request(&apdu[offset], apdu_len - offset,
              rpdata);
      }
  
      return len;
  }
  
  void testReadPropertyAck(
      Test * pTest)
  {
      uint8_t apdu[480] = { 0 };
      uint8_t apdu2[480] = { 0 };
      int len = 0;
      int apdu_len = 0;
      uint8_t invoke_id = 1;
      uint8_t test_invoke_id = 0;
      BACNET_READ_PROPERTY_DATA rpdata;
      BACNET_READ_PROPERTY_DATA test_data;
      BACNET_OBJECT_TYPE object_type = OBJECT_DEVICE;
      uint32_t object_instance = 0;
      uint16_t object = 0;
  
      rpdata.object_type = OBJECT_DEVICE;
      rpdata.object_instance = 1;
      rpdata.object_property = PROP_OBJECT_IDENTIFIER;
      rpdata.array_index = BACNET_ARRAY_ALL;
  
      rpdata.application_data_len =
          encode_bacnet_object_id(&apdu2[0], rpdata.object_type,
          rpdata.object_instance);
      rpdata.application_data = &apdu2[0];
  
      len = rp_ack_encode_apdu(&apdu[0], invoke_id, &rpdata);
      ct_test(pTest, len != 0);
      ct_test(pTest, len != -1);
      apdu_len = len;
      len = rp_ack_decode_apdu(&apdu[0], apdu_len,        /* total length of the apdu */
          &test_invoke_id, &test_data);
      ct_test(pTest, len != -1);
      ct_test(pTest, test_invoke_id == invoke_id);
  
      ct_test(pTest, test_data.object_type == rpdata.object_type);
      ct_test(pTest, test_data.object_instance == rpdata.object_instance);
      ct_test(pTest, test_data.object_property == rpdata.object_property);
      ct_test(pTest, test_data.array_index == rpdata.array_index);
      ct_test(pTest,
          test_data.application_data_len == rpdata.application_data_len);
  
      /* since object property == object_id, decode the application data using
         the appropriate decode function */
      len =
          decode_object_id(test_data.application_data, &object,
          &object_instance);
      object_type = object;
      ct_test(pTest, object_type == rpdata.object_type);
      ct_test(pTest, object_instance == rpdata.object_instance);
  }
  
  void testReadProperty(
      Test * pTest)
  {
      uint8_t apdu[480] = { 0 };
      int len = 0;
      int apdu_len = 0;
      uint8_t invoke_id = 128;
      uint8_t test_invoke_id = 0;
      BACNET_READ_PROPERTY_DATA rpdata;
      BACNET_READ_PROPERTY_DATA test_data;
  
      rpdata.object_type = OBJECT_DEVICE;
      rpdata.object_instance = 1;
      rpdata.object_property = PROP_OBJECT_IDENTIFIER;
      rpdata.array_index = BACNET_ARRAY_ALL;
      len = rp_encode_apdu(&apdu[0], invoke_id, &rpdata);
      ct_test(pTest, len != 0);
      apdu_len = len;
  
      len = rp_decode_apdu(&apdu[0], apdu_len, &test_invoke_id, &test_data);
      ct_test(pTest, len != -1);
      ct_test(pTest, test_data.object_type == rpdata.object_type);
      ct_test(pTest, test_data.object_instance == rpdata.object_instance);
      ct_test(pTest, test_data.object_property == rpdata.object_property);
      ct_test(pTest, test_data.array_index == rpdata.array_index);
  
      return;
  }
  
  #ifdef TEST_READ_PROPERTY
  int main(
      void)
  {
      Test *pTest;
      bool rc;
  
      pTest = ct_create("BACnet ReadProperty", NULL);
      /* individual tests */
      rc = ct_addTestFunction(pTest, testReadProperty);
      assert(rc);
      rc = ct_addTestFunction(pTest, testReadPropertyAck);
      assert(rc);
  
      ct_setStream(pTest, stdout);
      ct_run(pTest);
      (void) ct_report(pTest);
      ct_destroy(pTest);
  
      return 0;
  }
  #endif /* TEST_READ_PROPERTY */
  #endif /* TEST */
  