mon/mon_resp_decode.c

   1 /*
   2  * Copyright (c) 2018, JANET(UK)
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  *
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * 3. Neither the name of JANET(UK) nor the names of its contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  24  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
  25  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  26  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  27  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  29  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  31  * OF THE POSSIBILITY OF SUCH DAMAGE.
  32  *
  33  */
  34
  35
  36 #include <talloc.h>
  37 #include <jansson.h>
  38
  39 #include <mon_internal.h>
  40
  41 /* Monitoring response decoder */
  42
  43 /**
  44  * Decode a JSON response
  45  *
  46  * Expected format:
  47  * {
  48  *   "code": 0,
  49  *   "message": "success",
  50  *   "payload": {
  51  *     "serial": 12345,
  52  *     ...
  53  *   }
  54  * }
  55  *
  56  * Caller must free the return value with MON_REQ_free().
  57  *
  58  * @param mem_ctx talloc context for the returned struct
  59  * @param resp_json reference to JSON request object
  60  * @return decoded request struct or NULL on failure
  61  */
  62 MON_RESP *mon_resp_decode(TALLOC_CTX *mem_ctx, json_t *resp_json)
  63 {
  64   TALLOC_CTX *tmp_ctx = talloc_new(NULL);
  65   MON_RESP *resp = NULL;
  66   json_t *jcode = NULL;
  67   json_t *jmessage = NULL;
  68   json_t *jpayload = NULL;
  69
  70   if (! json_is_object(resp_json))
  71     goto cleanup;
  72
  73   /* Get the response code, which is an integer */
  74   jcode = json_object_get(resp_json, "code");
  75   if (! json_is_integer(jcode))
  76     goto cleanup;
  77
  78   /* Get the response message, which is a string */
  79   jmessage = json_object_get(resp_json, "message");
  80   if (! json_is_string(jmessage))
  81     goto cleanup;
  82
  83   /* Get the payload if we have one */
  84   jpayload = json_object_get(resp_json, "payload");
  85
  86   /* Get a response in the tmp_ctx context. The payload may be null. */
  87   resp = mon_resp_new(tmp_ctx,
  88                       (MON_RESP_CODE) json_integer_value(jcode),
  89                       json_string_value(jmessage),
  90                       jpayload);
  91   if (resp == NULL)
  92     goto cleanup;
  93
  94   /* Success! Put the request in the caller's talloc context */
  95   talloc_steal(mem_ctx, resp);
  96
  97 cleanup:
  98   talloc_free(tmp_ctx);
  99   if (resp_json)
 100     json_decref(resp_json);
 101
 102   return resp;
 103 }