1 //******************************************************************
3 // Copyright 2014 Intel Mobile Communications GmbH All Rights Reserved.
5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
7 // Licensed under the Apache License, Version 2.0 (the "License");
8 // you may not use this file except in compliance with the License.
9 // You may obtain a copy of the License at
11 // http://www.apache.org/licenses/LICENSE-2.0
13 // Unless required by applicable law or agreed to in writing, software
14 // distributed under the License is distributed on an "AS IS" BASIS,
15 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 // See the License for the specific language governing permissions and
17 // limitations under the License.
19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
21 // Defining _POSIX_C_SOURCE macro with 200112L (or greater) as value
22 // causes header files to expose definitions
23 // corresponding to the POSIX.1-2001 base
24 // specification (excluding the XSI extension).
25 // For POSIX.1-2001 base specification,
26 // Refer http://pubs.opengroup.org/onlinepubs/009695399/
27 #define _POSIX_C_SOURCE 200112L
28 #include "occollection.h"
31 #include "ocstackinternal.h"
32 #include "ocresourcehandler.h"
35 #include "oic_malloc.h"
36 #include "oic_string.h"
37 #include "ocpayload.h"
38 #include "payload_logging.h"
43 #define WITH_GROUPACTION 1
47 #define TAG "OIC_RI_COLLECTION"
49 #define NUM_PARAM_IN_QUERY 2 // The expected number of parameters in a query
50 #define NUM_FIELDS_IN_QUERY 2 // The expected number of fields in a query
52 static OCStackResult CheckRTParamSupport(const OCResource* resource, const char* rtPtr)
54 if (!resource || !rtPtr)
56 return OC_STACK_INVALID_PARAM;
59 OCResourceType* rTPointer = resource->rsrcType;
62 if (strcmp(rTPointer->resourcetypename, rtPtr) == 0)
67 rTPointer = rTPointer->next;
69 return OC_STACK_ERROR;
72 static OCStackResult CheckIFParamSupport(const OCResource* resource, const char* ifPtr)
74 if (!resource || !ifPtr)
76 return OC_STACK_INVALID_PARAM;
79 OCResourceInterface* iFPointer = resource->rsrcInterface;
82 if (strcmp(iFPointer->name, ifPtr) == 0)
87 iFPointer = iFPointer->next;
89 return OC_STACK_ERROR;
93 ValidateQuery (const char *query, OCResourceHandle resource,
94 OCStackIfTypes *ifParam, char **rtParam)
96 uint8_t numFields = 0;
99 //TODO: Query and URL validation is being done for virtual resource case
100 // using ValidateUrlQuery function. We should be able to merge it with this
102 OC_LOG(INFO, TAG, "Entering ValidateQuery");
106 return OC_STACK_ERROR;
109 if (!ifParam || !rtParam)
111 return OC_STACK_INVALID_PARAM;
116 // Query string is empty
117 OC_LOG(INFO, TAG, "Empty query string, use default IF and RT");
118 *ifParam = STACK_IF_DEFAULT;
119 *rtParam = (char *) OCGetResourceTypeName (resource, 0);
123 // Break the query string to validate it and determine IF and RT parameters
124 // Validate there are atmost 2 parameters in string and that one is 'if' and other 'rt'
125 // separated by token '&' or ';'. Stack will accept both the versions.
127 char *endStr, *ifPtr = NULL, *rtPtr = NULL;
128 char *token = strtok_r ((char *)query, OC_QUERY_SEPARATOR , &endStr);
130 // External loop breaks query string into fields using the & separator
131 while (token != NULL)
135 char *innerToken = strtok_r (token, "=", &endToken);
138 // Internal loop parses the field to extract values (parameters) assigned to each field
139 while (innerToken != NULL)
142 if (strncmp (innerToken, OC_RSRVD_INTERFACE, sizeof(OC_RSRVD_INTERFACE)) == 0)
144 // Determine the value of IF parameter
145 innerToken = strtok_r (NULL, "=", &endToken);
148 else if (strcmp (innerToken, OC_RSRVD_RESOURCE_TYPE) == 0)
150 // Determine the value of RT parameter
151 innerToken = strtok_r (NULL, "=", &endToken);
156 innerToken = strtok_r (NULL, "=", &endToken);
159 if (numParam != NUM_PARAM_IN_QUERY)
161 // Query parameter should be of the form if=<string>. String should not have & or =
162 return OC_STACK_INVALID_QUERY;
164 token = strtok_r (NULL, OC_QUERY_SEPARATOR, &endStr);
167 if (numFields > NUM_FIELDS_IN_QUERY)
169 // current release supports one IF value, one RT value and no other params
170 return OC_STACK_INVALID_QUERY;
175 if (CheckIFParamSupport((OCResource *)resource, ifPtr) != OC_STACK_OK)
177 return OC_STACK_INVALID_QUERY;
179 if (strcmp (ifPtr, OC_RSRVD_INTERFACE_DEFAULT) == 0)
181 *ifParam = STACK_IF_DEFAULT;
183 else if (strcmp (ifPtr, OC_RSRVD_INTERFACE_LL) == 0)
185 *ifParam = STACK_IF_LL;
187 else if (strcmp (ifPtr, OC_RSRVD_INTERFACE_BATCH) == 0)
189 *ifParam = STACK_IF_BATCH;
191 else if (strcmp (ifPtr, OC_RSRVD_INTERFACE_GROUP) == 0)
193 *ifParam = STACK_IF_GROUP;
197 return OC_STACK_ERROR;
202 // IF not specified in query, use default IF
203 *ifParam = STACK_IF_DEFAULT;
208 if (CheckRTParamSupport((OCResource *)resource, rtPtr) == OC_STACK_OK)
214 return OC_STACK_INVALID_QUERY;
219 // RT not specified in query. Use the first resource type for the resource as default.
220 *rtParam = (char *) OCGetResourceTypeName (resource, 0);
222 OC_LOG_V(INFO, TAG, "Query params: IF = %d, RT = %s", *ifParam, *rtParam);
228 HandleLinkedListInterface(OCEntityHandlerRequest *ehRequest,
236 return OC_STACK_INVALID_PARAM;
239 OCResource *collResource = (OCResource *)ehRequest->resource;
241 OCRepPayload* payload = NULL;
242 OCStackResult ret = BuildResponseRepresentation(collResource, &payload);
243 if (ret == OC_STACK_OK)
245 for (size_t i = 0; i < MAX_CONTAINED_RESOURCES && ret == OC_STACK_OK; i++)
249 OCResource* temp = collResource->rsrcResources[i];
252 //TODO : Add resource type filtering once collections
253 // start supporting queries.
254 ret = BuildResponseRepresentation(temp, &payload);
260 if (ret == OC_STACK_OK)
262 OCEntityHandlerResponse response = {0};
263 response.ehResult = OC_EH_OK;
264 response.payload = (OCPayload*)payload;
265 response.persistentBufferFlag = 0;
266 response.requestHandle = (OCRequestHandle) ehRequest->requestHandle;
267 response.resourceHandle = (OCResourceHandle) collResource;
268 ret = OCDoResponse(&response);
270 OCRepPayloadDestroy(payload);
275 HandleBatchInterface(OCEntityHandlerRequest *ehRequest)
279 return OC_STACK_INVALID_PARAM;
282 OCResource * collResource = (OCResource *) ehRequest->resource;
284 OCRepPayload* payload = OCRepPayloadCreate();
287 return OC_STACK_NO_MEMORY;
292 OCRepPayloadSetUri(payload, collResource->uri);
295 OCEntityHandlerResponse response = {0};
296 response.ehResult = OC_EH_OK;
297 response.payload = (OCPayload*)payload;
298 response.persistentBufferFlag = 0;
299 response.requestHandle = (OCRequestHandle) ehRequest->requestHandle;
300 response.resourceHandle = (OCResourceHandle) collResource;
301 OCStackResult stackRet = OCDoResponse(&response);
303 if (stackRet == OC_STACK_OK)
305 for (uint8_t i = 0; i < MAX_CONTAINED_RESOURCES; i++)
307 OCResource* temp = collResource->rsrcResources[i];
310 // Note that all entity handlers called through a collection
311 // will get the same pointer to ehRequest, the only difference
312 // is ehRequest->resource
313 ehRequest->resource = (OCResourceHandle) temp;
315 OCEntityHandlerResult ehResult = temp->entityHandler(OC_REQUEST_FLAG, ehRequest,
316 temp->entityHandlerCallbackParam);
318 // The default collection handler is returning as OK
319 if (stackRet != OC_STACK_SLOW_RESOURCE)
321 stackRet = OC_STACK_OK;
323 // if a single resource is slow, then entire response will be treated
325 if (ehResult == OC_EH_SLOW)
327 OC_LOG(INFO, TAG, "This is a slow resource");
328 ((OCServerRequest *)ehRequest->requestHandle)->slowFlag = 1;
329 stackRet = EntityHandlerCodeToOCStackCode(ehResult);
337 ehRequest->resource = (OCResourceHandle) collResource;
342 uint8_t GetNumOfResourcesInCollection (OCResource *resource)
347 for (uint8_t i = 0; i < MAX_CONTAINED_RESOURCES; i++)
349 if (resource->rsrcResources[i])
363 OCStackResult DefaultCollectionEntityHandler (OCEntityHandlerFlag flag,
364 OCEntityHandlerRequest *ehRequest)
366 if (!ehRequest || !ehRequest->query)
368 return OC_STACK_INVALID_PARAM;
371 OC_LOG_V(INFO, TAG, "DefaultCollectionEntityHandler with query %s", ehRequest->query);
373 if (flag != OC_REQUEST_FLAG)
375 return OC_STACK_ERROR;
378 OCStackIfTypes ifQueryParam = STACK_IF_INVALID;
379 char *rtQueryParam = NULL;
380 OCStackResult result = ValidateQuery (ehRequest->query,
381 ehRequest->resource, &ifQueryParam, &rtQueryParam);
383 if (result != OC_STACK_OK)
388 switch (ehRequest->method)
391 switch (ifQueryParam)
393 case STACK_IF_DEFAULT:
394 // Get attributes of collection resource and properties of contained resources
395 // M1 release does not support attributes for collection resource, so the GET
396 // operation is same as the GET on LL interface.
397 OC_LOG(INFO, TAG, "STACK_IF_DEFAULT");
398 return HandleLinkedListInterface(ehRequest, STACK_RES_DISCOVERY_NOFILTER, NULL);
401 OC_LOG(INFO, TAG, "STACK_IF_LL");
402 return HandleLinkedListInterface(ehRequest, STACK_RES_DISCOVERY_NOFILTER, NULL);
405 OC_LOG(INFO, TAG, "STACK_IF_BATCH");
406 ((OCServerRequest *)ehRequest->requestHandle)->ehResponseHandler =
407 HandleAggregateResponse;
409 ((OCServerRequest *)ehRequest->requestHandle)->numResponses =
410 GetNumOfResourcesInCollection((OCResource *)ehRequest->resource) + 1;
412 return HandleBatchInterface(ehRequest);
415 return BuildCollectionGroupActionCBORResponse(OC_REST_GET/*flag*/,
416 (OCResource *) ehRequest->resource, ehRequest);
419 return OC_STACK_ERROR;
423 switch (ifQueryParam)
425 case STACK_IF_DEFAULT:
426 // M1 release does not support PUT on default interface
427 return OC_STACK_ERROR;
430 // LL interface only supports GET
431 return OC_STACK_ERROR;
434 ((OCServerRequest *)ehRequest->requestHandle)->ehResponseHandler =
435 HandleAggregateResponse;
436 ((OCServerRequest *)ehRequest->requestHandle)->numResponses =
437 GetNumOfResourcesInCollection((OCResource *)ehRequest->resource) + 1;
438 return HandleBatchInterface(ehRequest);
441 OC_LOG(INFO, TAG, "IF_COLLECTION PUT with request ::\n");
442 OC_LOG_PAYLOAD(INFO, ehRequest->payload);
443 return BuildCollectionGroupActionCBORResponse(OC_REST_PUT/*flag*/,
444 (OCResource *) ehRequest->resource, ehRequest);
447 return OC_STACK_ERROR;
451 switch (ifQueryParam)
453 case STACK_IF_DEFAULT:
454 // M1 release does not support POST on default interface
455 return OC_STACK_ERROR;
458 // LL interface only supports GET
459 return OC_STACK_ERROR;
462 ((OCServerRequest *)ehRequest->requestHandle)->ehResponseHandler =
463 HandleAggregateResponse;
464 ((OCServerRequest *)ehRequest->requestHandle)->numResponses =
465 GetNumOfResourcesInCollection((OCResource *)ehRequest->resource) + 1;
466 return HandleBatchInterface(ehRequest);
469 OC_LOG(INFO, TAG, "IF_COLLECTION POST with request ::\n");
470 OC_LOG_PAYLOAD(INFO, ehRequest->payload);
471 return BuildCollectionGroupActionCBORResponse(OC_REST_POST/*flag*/,
472 (OCResource *) ehRequest->resource, ehRequest);
475 return OC_STACK_ERROR;
479 // TODO implement DELETE accordingly to the desired behavior
480 return OC_STACK_ERROR;
483 return OC_STACK_ERROR;