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
36 #include "ocresource.h"
37 #include "ocresourcehandler.h"
38 #include "ocobserve.h"
39 #include "occollection.h"
40 #include "oic_malloc.h"
41 #include "oic_string.h"
44 #include "ocpayload.h"
45 #include "secureresourcemanager.h"
47 #include "cainterface.h"
48 #include "rdpayload.h"
49 #include "ocpayload.h"
52 #include "rd_server.h"
55 #ifdef ROUTING_GATEWAY
56 #include "routingmanager.h"
60 #define TAG "OIC_RI_RESOURCE"
62 #define VERIFY_SUCCESS(op, successCode) { if (op != successCode) \
63 {OIC_LOG_V(FATAL, TAG, "%s failed!!", #op); goto exit;} }
65 #define VERIFY_NON_NULL(arg, logLevel, retVal) { if (!(arg)) { OIC_LOG((logLevel), \
66 TAG, #arg " is NULL"); return (retVal); } }
68 #include "platform_features.h"
70 extern OCResource *headResource;
71 static OCPlatformInfo savedPlatformInfo = {0};
72 static OCDeviceInfo savedDeviceInfo = {0};
75 * Prepares a Payload for response.
77 static OCStackResult BuildVirtualResourceResponse(const OCResource *resourcePtr,
78 OCDiscoveryPayload* payload,
82 //-----------------------------------------------------------------------------
83 // Default resource entity handler function
84 //-----------------------------------------------------------------------------
85 OCEntityHandlerResult defaultResourceEHandler(OCEntityHandlerFlag flag,
86 OCEntityHandlerRequest * request, void* callbackParam)
88 //TODO ("Implement me!!!!");
89 // TODO: remove silence unused param warnings
93 return OC_EH_OK; // Making sure that the Default EH and the Vendor EH have matching signatures
96 /* This method will retrieve the port at which the secure resource is hosted */
97 static OCStackResult GetSecurePortInfo(OCDevAddr *endpoint, uint16_t *port)
101 if (endpoint->adapter == OC_ADAPTER_IP)
103 if (endpoint->flags & OC_IP_USE_V6)
105 p = caglobals.ip.u6s.port;
107 else if (endpoint->flags & OC_IP_USE_V4)
109 p = caglobals.ip.u4s.port;
118 /* This method will retrieve the tcp port */
119 static OCStackResult GetTCPPortInfo(OCDevAddr *endpoint, uint16_t *port)
123 if (endpoint->adapter == OC_ADAPTER_IP)
125 if (endpoint->flags & OC_IP_USE_V4)
127 p = caglobals.tcp.ipv4.port;
129 else if (endpoint->flags & OC_IP_USE_V6)
131 p = caglobals.tcp.ipv6.port;
141 * Function will extract 0, 1 or 2 filters from query.
142 * More than 2 filters or unsupported filters will result in error.
143 * If both filters are of the same supported type, the 2nd one will be picked.
144 * Resource and device filters in the SAME query are NOT validated
145 * and resources will likely not clear filters.
147 static OCStackResult ExtractFiltersFromQuery(char *query, char **filterOne, char **filterTwo)
152 char *restOfQuery = NULL;
153 int numKeyValuePairsParsed = 0;
158 OIC_LOG_V(INFO, TAG, "Extracting params from %s", query);
160 char *keyValuePair = strtok_r (query, OC_QUERY_SEPARATOR, &restOfQuery);
164 if (numKeyValuePairsParsed >= 2)
166 OIC_LOG(ERROR, TAG, "More than 2 queries params in URI.");
167 return OC_STACK_INVALID_QUERY;
170 key = strtok_r(keyValuePair, OC_KEY_VALUE_DELIMITER, &value);
174 return OC_STACK_INVALID_QUERY;
176 else if (strncasecmp(key, OC_RSRVD_INTERFACE, sizeof(OC_RSRVD_INTERFACE) - 1) == 0)
178 *filterOne = value; // if
180 else if (strncasecmp(key, OC_RSRVD_RESOURCE_TYPE, sizeof(OC_RSRVD_INTERFACE) - 1) == 0)
182 *filterTwo = value; // rt
186 OIC_LOG_V(ERROR, TAG, "Unsupported query key: %s", key);
187 return OC_STACK_INVALID_QUERY;
189 ++numKeyValuePairsParsed;
191 keyValuePair = strtok_r(NULL, OC_QUERY_SEPARATOR, &restOfQuery);
194 OIC_LOG_V(INFO, TAG, "Extracted params if: %s and rt: %s.", *filterOne, *filterTwo);
198 static OCVirtualResources GetTypeOfVirtualURI(const char *uriInRequest)
200 if (strcmp(uriInRequest, OC_RSRVD_WELL_KNOWN_URI) == 0)
202 return OC_WELL_KNOWN_URI;
204 else if (strcmp(uriInRequest, OC_RSRVD_DEVICE_URI) == 0)
206 return OC_DEVICE_URI;
208 else if (strcmp(uriInRequest, OC_RSRVD_PLATFORM_URI) == 0)
210 return OC_PLATFORM_URI;
212 else if (strcmp(uriInRequest, OC_RSRVD_RESOURCE_TYPES_URI) == 0)
214 return OC_RESOURCE_TYPES_URI;
216 #ifdef ROUTING_GATEWAY
217 else if (0 == strcmp(uriInRequest, OC_RSRVD_GATEWAY_URI))
219 return OC_GATEWAY_URI;
223 else if (strcmp(uriInRequest, OC_RSRVD_PRESENCE_URI) == 0)
227 #endif //WITH_PRESENCE
228 return OC_UNKNOWN_URI;
231 static OCStackResult getQueryParamsForFiltering (OCVirtualResources uri, char *query,
232 char **filterOne, char **filterTwo)
234 if(!filterOne || !filterTwo)
236 return OC_STACK_INVALID_PARAM;
243 if (uri == OC_PRESENCE)
245 //Nothing needs to be done, except for pass a OC_PRESENCE query through as OC_STACK_OK.
246 OIC_LOG(INFO, TAG, "OC_PRESENCE Request for virtual resource.");
251 OCStackResult result = OC_STACK_OK;
255 result = ExtractFiltersFromQuery(query, filterOne, filterTwo);
261 OCStackResult BuildResponseRepresentation(const OCResource *resourcePtr,
262 OCRepPayload** payload)
264 OCRepPayload *tempPayload = OCRepPayloadCreate();
268 OCRepPayloadDestroy(tempPayload);
269 return OC_STACK_INVALID_PARAM;
274 return OC_STACK_NO_MEMORY;
277 OCRepPayloadSetUri(tempPayload, resourcePtr->uri);
279 OCResourceType *resType = resourcePtr->rsrcType;
282 OCRepPayloadAddResourceType(tempPayload, resType->resourcetypename);
283 resType = resType->next;
286 OCResourceInterface *resInterface = resourcePtr->rsrcInterface;
289 OCRepPayloadAddInterface(tempPayload, resInterface->name);
290 resInterface = resInterface->next;
293 OCAttribute *resAttrib = resourcePtr->rsrcAttributes;
296 OCRepPayloadSetPropString(tempPayload, resAttrib->attrName,
297 resAttrib->attrValue);
298 resAttrib = resAttrib->next;
303 *payload = tempPayload;
307 OCRepPayloadAppend(*payload, tempPayload);
313 OCStackResult BuildVirtualResourceResponse(const OCResource *resourcePtr,
314 OCDiscoveryPayload *payload, OCDevAddr *devAddr, bool rdResponse)
316 if (!resourcePtr || !payload)
318 return OC_STACK_INVALID_PARAM;
320 uint16_t securePort = 0;
321 if (resourcePtr->resourceProperties & OC_SECURE)
323 if (GetSecurePortInfo(devAddr, &securePort) != OC_STACK_OK)
331 securePort = devAddr->port;
334 uint16_t tcpPort = 0;
336 if (GetTCPPortInfo(devAddr, &tcpPort) != OC_STACK_OK)
340 OCDiscoveryPayloadAddResource(payload, resourcePtr, securePort, tcpPort);
342 OCDiscoveryPayloadAddResource(payload, resourcePtr, securePort);
348 uint8_t IsCollectionResource (OCResource *resource)
355 if(resource->rsrcChildResourcesHead != NULL)
363 OCResource *FindResourceByUri(const char* resourceUri)
370 OCResource * pointer = headResource;
373 if (strcmp(resourceUri, pointer->uri) == 0)
377 pointer = pointer->next;
379 OIC_LOG_V(INFO, TAG, "Resource %s not found", resourceUri);
384 OCStackResult DetermineResourceHandling (const OCServerRequest *request,
385 ResourceHandling *handling,
386 OCResource **resource)
388 if(!request || !handling || !resource)
390 return OC_STACK_INVALID_PARAM;
393 OIC_LOG_V(INFO, TAG, "DetermineResourceHandling for %s", request->resourceUrl);
395 // Check if virtual resource
396 if (GetTypeOfVirtualURI(request->resourceUrl) != OC_UNKNOWN_URI)
398 OIC_LOG_V (INFO, TAG, "%s is virtual", request->resourceUrl);
399 *handling = OC_RESOURCE_VIRTUAL;
400 *resource = headResource;
403 if (strlen((const char*)(request->resourceUrl)) == 0)
405 // Resource URL not specified
406 *handling = OC_RESOURCE_NOT_SPECIFIED;
407 return OC_STACK_NO_RESOURCE;
411 OCResource *resourcePtr = FindResourceByUri((const char*)request->resourceUrl);
412 *resource = resourcePtr;
415 if(defaultDeviceHandler)
417 *handling = OC_RESOURCE_DEFAULT_DEVICE_ENTITYHANDLER;
421 // Resource does not exist
422 // and default device handler does not exist
423 *handling = OC_RESOURCE_NOT_SPECIFIED;
424 return OC_STACK_NO_RESOURCE;
427 if (IsCollectionResource (resourcePtr))
429 // Collection resource
430 if (resourcePtr->entityHandler != defaultResourceEHandler)
432 *handling = OC_RESOURCE_COLLECTION_WITH_ENTITYHANDLER;
437 *handling = OC_RESOURCE_COLLECTION_DEFAULT_ENTITYHANDLER;
443 // Resource not a collection
444 if (resourcePtr->entityHandler != defaultResourceEHandler)
446 *handling = OC_RESOURCE_NOT_COLLECTION_WITH_ENTITYHANDLER;
451 *handling = OC_RESOURCE_NOT_COLLECTION_DEFAULT_ENTITYHANDLER;
458 OCStackResult EntityHandlerCodeToOCStackCode(OCEntityHandlerResult ehResult)
460 OCStackResult result;
465 result = OC_STACK_OK;
468 result = OC_STACK_SLOW_RESOURCE;
471 result = OC_STACK_ERROR;
473 case OC_EH_FORBIDDEN:
474 result = OC_STACK_RESOURCE_ERROR;
476 case OC_EH_RESOURCE_CREATED:
477 result = OC_STACK_RESOURCE_CREATED;
479 case OC_EH_RESOURCE_DELETED:
480 result = OC_STACK_RESOURCE_DELETED;
483 result = OC_STACK_RESOURCE_CHANGED;
485 case OC_EH_RESOURCE_NOT_FOUND:
486 result = OC_STACK_NO_RESOURCE;
489 result = OC_STACK_ERROR;
495 static bool resourceMatchesRTFilter(OCResource *resource, char *resourceTypeFilter)
502 // Null or empty is analogous to no filter.
503 if (resourceTypeFilter == NULL || *resourceTypeFilter == 0)
508 OCResourceType *resourceTypePtr = resource->rsrcType;
510 while (resourceTypePtr)
512 if (strcmp (resourceTypePtr->resourcetypename, resourceTypeFilter) == 0)
516 resourceTypePtr = resourceTypePtr->next;
519 OIC_LOG_V(INFO, TAG, "%s does not contain rt=%s.", resource->uri, resourceTypeFilter);
523 static bool resourceMatchesIFFilter(OCResource *resource, char *interfaceFilter)
530 // Null or empty is analogous to no filter.
531 if (interfaceFilter == NULL || *interfaceFilter == 0)
536 OCResourceInterface *interfacePtr = resource->rsrcInterface;
540 if ((strcmp (interfacePtr->name, interfaceFilter) == 0) &&
541 (strcmp (OC_RSRVD_INTERFACE_LL, interfaceFilter) == 0 ||
542 strcmp (OC_RSRVD_INTERFACE_DEFAULT, interfaceFilter) == 0))
546 interfacePtr = interfacePtr->next;
549 OIC_LOG_V(INFO, TAG, "%s does not contain if=%s.", resource->uri, interfaceFilter);
554 * If the filters are null, they will be assumed to NOT be present
555 * and the resource will not be matched against them.
556 * Function will return true if all non null AND non empty filters passed in find a match.
558 static bool includeThisResourceInResponse(OCResource *resource,
559 char *interfaceFilter,
560 char *resourceTypeFilter)
564 OIC_LOG(ERROR, TAG, "Invalid resource");
568 if (resource->resourceProperties & OC_EXPLICIT_DISCOVERABLE)
571 * At least one valid filter should be available to
572 * include the resource in discovery response
574 if (!(resourceTypeFilter && *resourceTypeFilter))
576 OIC_LOG_V(INFO, TAG, "%s no query string for EXPLICIT_DISCOVERABLE \
577 resource", resource->uri);
581 else if ( !(resource->resourceProperties & OC_ACTIVE) ||
582 !(resource->resourceProperties & OC_DISCOVERABLE))
584 OIC_LOG_V(INFO, TAG, "%s not ACTIVE or DISCOVERABLE", resource->uri);
588 return resourceMatchesIFFilter(resource, interfaceFilter) &&
589 resourceMatchesRTFilter(resource, resourceTypeFilter);
593 OCStackResult SendNonPersistantDiscoveryResponse(OCServerRequest *request, OCResource *resource,
594 OCPayload *discoveryPayload, OCEntityHandlerResult ehResult)
596 OCEntityHandlerResponse response = {0};
598 response.ehResult = ehResult;
599 response.payload = discoveryPayload;
600 response.persistentBufferFlag = 0;
601 response.requestHandle = (OCRequestHandle) request;
602 response.resourceHandle = (OCResourceHandle) resource;
604 return OCDoResponse(&response);
608 static OCStackResult checkResourceExistsAtRD(const char *interfaceType, const char *resourceType,
609 OCResource **payload, OCDevAddr *devAddr)
611 OCResourceCollectionPayload *repPayload;
614 return OC_STACK_ERROR;
616 if (OCRDCheckPublishedResource(interfaceType, resourceType, &repPayload, devAddr) == OC_STACK_OK)
620 return OC_STACK_ERROR;
622 OCResource *ptr = ((OCResource *) OICCalloc(1, sizeof(OCResource)));
625 return OC_STACK_NO_MEMORY;
628 ptr->uri = OICStrdup(repPayload->setLinks->href);
631 return OC_STACK_NO_MEMORY;
633 OCStringLL *rt = repPayload->setLinks->rt;
636 OCResourceType *temp = (OCResourceType *) OICCalloc(1, sizeof(OCResourceType));
640 return OC_STACK_NO_MEMORY;
643 temp->resourcetypename = OICStrdup(rt->value);
646 ptr->rsrcType = temp;
650 OCResourceType *type = ptr->rsrcType;
660 OCStringLL *itf = repPayload->setLinks->itf;
663 OCResourceInterface *temp = (OCResourceInterface *) OICCalloc(1, sizeof(OCResourceInterface));
668 return OC_STACK_NO_MEMORY;
671 temp->name = OICStrdup(itf->value);
672 if (!ptr->rsrcInterface)
674 ptr->rsrcInterface = temp;
678 OCResourceInterface *type = ptr->rsrcInterface;
688 ptr->resourceProperties = (OCResourceProperty) repPayload->tags->bitmap;
690 OCFreeCollectionResource(repPayload);
696 OIC_LOG_V(ERROR, TAG, "The resource type or interface type doe not exist \
697 on the resource directory");
699 return OC_STACK_ERROR;
703 static OCStackResult HandleVirtualResource (OCServerRequest *request, OCResource* resource)
705 if (!request || !resource)
707 return OC_STACK_INVALID_PARAM;
710 OCStackResult discoveryResult = OC_STACK_ERROR;
711 OCPayload* payload = NULL;
713 OIC_LOG(INFO, TAG, "Entering HandleVirtualResource");
715 OCVirtualResources virtualUriInRequest = GetTypeOfVirtualURI (request->resourceUrl);
717 // Step 1: Generate the response to discovery request
718 if (virtualUriInRequest == OC_WELL_KNOWN_URI)
720 if (request->method == OC_REST_PUT || request->method == OC_REST_POST || request->method == OC_REST_DELETE)
722 OIC_LOG_V(ERROR, TAG, "Resource : %s not permitted for method: %d", request->resourceUrl, request->method);
723 return OC_STACK_UNAUTHORIZED_REQ;
726 char *interfaceQuery = NULL;
727 char *resourceTypeQuery = NULL;
729 discoveryResult = getQueryParamsForFiltering (virtualUriInRequest, request->query,
730 &interfaceQuery, &resourceTypeQuery);
731 bool interfaceQueryAllocated = false;
732 if (!interfaceQuery && !resourceTypeQuery)
734 interfaceQueryAllocated = true;
735 interfaceQuery = OICStrdup(OC_RSRVD_INTERFACE_LL);
738 if (discoveryResult == OC_STACK_OK)
740 payload = (OCPayload *)OCDiscoveryPayloadCreate();
744 OCDiscoveryPayload *discPayload = (OCDiscoveryPayload *)payload;
745 discPayload->sid = (char *)OICCalloc(1, UUID_STRING_SIZE);
746 VERIFY_NON_NULL(discPayload->sid, ERROR, OC_STACK_NO_MEMORY);
748 const char* uid = OCGetServerInstanceIDString();
751 memcpy(discPayload->sid, uid, UUID_STRING_SIZE);
754 if (!resourceTypeQuery && interfaceQuery && (0 == strcmp(interfaceQuery, OC_RSRVD_INTERFACE_LL)))
756 for (; resource && discoveryResult == OC_STACK_OK; resource = resource->next)
759 if (resource->resourceProperties & OC_DISCOVERABLE)
766 discoveryResult = BuildVirtualResourceResponse(resource,
767 discPayload, &request->devAddr, false);
773 if (interfaceQuery && (0 != strcmp(interfaceQuery, OC_RSRVD_INTERFACE_LL)))
775 discPayload->uri = OICStrdup(OC_RSRVD_WELL_KNOWN_URI);
776 VERIFY_NON_NULL(discPayload->uri, ERROR, OC_STACK_NO_MEMORY);
777 if (savedDeviceInfo.deviceName)
779 discPayload->name = OICStrdup(savedDeviceInfo.deviceName);
780 VERIFY_NON_NULL(discPayload->name, ERROR, OC_STACK_NO_MEMORY);
782 discPayload->type = (OCStringLL*)OICCalloc(1, sizeof(OCStringLL));
783 VERIFY_NON_NULL(discPayload->type, ERROR, OC_STACK_NO_MEMORY);
784 discPayload->type->value = OICStrdup(OC_RSRVD_RESOURCE_TYPE_RES);
785 VERIFY_NON_NULL(discPayload->type->value, ERROR, OC_STACK_NO_MEMORY);
786 OCResourcePayloadAddStringLL(&discPayload->iface, OC_RSRVD_INTERFACE_LL);
787 OCResourcePayloadAddStringLL(&discPayload->iface, OC_RSRVD_INTERFACE_DEFAULT);
788 VERIFY_NON_NULL(discPayload->iface, ERROR, OC_STACK_NO_MEMORY);
790 bool foundResourceAtRD = false;
791 for (;resource && discoveryResult == OC_STACK_OK; resource = resource->next)
794 if (strcmp(resource->uri, OC_RSRVD_RD_URI) == 0)
796 OCResource *resource1 = NULL;
798 discoveryResult = checkResourceExistsAtRD(interfaceQuery,
799 resourceTypeQuery, &resource1, &devAddr);
800 if (discoveryResult != OC_STACK_OK)
804 discoveryResult = BuildVirtualResourceResponse(resource1,
805 discPayload, &devAddr, true);
808 discPayload->baseURI = OICStrdup(devAddr.addr);
810 OICFree(resource1->uri);
811 for (OCResourceType *rsrcRt = resource1->rsrcType, *rsrcRtNext = NULL; rsrcRt; )
813 rsrcRtNext = rsrcRt->next;
814 OICFree(rsrcRt->resourcetypename);
819 for (OCResourceInterface *rsrcPtr = resource1->rsrcInterface, *rsrcNext = NULL; rsrcPtr; )
821 rsrcNext = rsrcPtr->next;
822 OICFree(rsrcPtr->name);
826 foundResourceAtRD = true;
829 if (!foundResourceAtRD && includeThisResourceInResponse(resource, interfaceQuery, resourceTypeQuery))
831 discoveryResult = BuildVirtualResourceResponse(resource,
832 discPayload, &request->devAddr, false);
835 // Set discoveryResult appropriately if no 'valid' resources are available
836 if (discPayload->resources == NULL && !foundResourceAtRD)
838 discoveryResult = OC_STACK_NO_RESOURCE;
844 discoveryResult = OC_STACK_NO_MEMORY;
849 OIC_LOG_V(ERROR, TAG, "Error (%d) parsing query.", discoveryResult);
851 if (interfaceQueryAllocated)
853 OICFree(interfaceQuery);
856 else if (virtualUriInRequest == OC_DEVICE_URI)
858 if (request->method == OC_REST_PUT || request->method == OC_REST_POST || request->method == OC_REST_DELETE)
860 OIC_LOG_V(ERROR, TAG, "Resource : %s not permitted for method: %d", request->resourceUrl, request->method);
861 return OC_STACK_UNAUTHORIZED_REQ;
864 const char* deviceId = OCGetServerInstanceIDString();
867 discoveryResult = OC_STACK_ERROR;
871 char *dataModelVersions = OCCreateString(savedDeviceInfo.dataModelVersions);
872 if (!dataModelVersions)
874 discoveryResult = OC_STACK_NO_MEMORY;
878 payload = (OCPayload*) OCDevicePayloadCreate(deviceId, savedDeviceInfo.deviceName,
879 savedDeviceInfo.types, savedDeviceInfo.specVersion, dataModelVersions);
882 discoveryResult = OC_STACK_NO_MEMORY;
886 discoveryResult = OC_STACK_OK;
888 OICFree(dataModelVersions);
892 else if (virtualUriInRequest == OC_PLATFORM_URI)
894 if (request->method == OC_REST_PUT || request->method == OC_REST_POST || request->method == OC_REST_DELETE)
896 OIC_LOG_V(ERROR, TAG, "Resource : %s not permitted for method: %d", request->resourceUrl, request->method);
897 return OC_STACK_UNAUTHORIZED_REQ;
900 payload = (OCPayload*)OCPlatformPayloadCreate(&savedPlatformInfo);
903 discoveryResult = OC_STACK_NO_MEMORY;
907 discoveryResult = OC_STACK_OK;
910 #ifdef ROUTING_GATEWAY
911 else if (OC_GATEWAY_URI == virtualUriInRequest)
913 // Received request for a gateway
914 OIC_LOG(INFO, TAG, "Request is for Gateway Virtual Request");
915 discoveryResult = RMHandleGatewayRequest(request, resource);
921 * Step 2: Send the discovery response
923 * Iotivity should respond to discovery requests in below manner:
924 * 1)If query filter matching fails and discovery request is multicast,
925 * it should NOT send any response.
926 * 2)If query filter matching fails and discovery request is unicast,
927 * it should send an error(RESOURCE_NOT_FOUND - 404) response.
928 * 3)If Server does not have any 'DISCOVERABLE' resources and discovery
929 * request is multicast, it should NOT send any response.
930 * 4)If Server does not have any 'DISCOVERABLE' resources and discovery
931 * request is unicast, it should send an error(RESOURCE_NOT_FOUND - 404) response.
935 if ((virtualUriInRequest == OC_PRESENCE) &&
936 (resource->resourceProperties & OC_ACTIVE))
938 // Presence uses observer notification api to respond via SendPresenceNotification.
939 SendPresenceNotification(resource->rsrcType, OC_PRESENCE_TRIGGER_CHANGE);
943 #ifdef ROUTING_GATEWAY
944 // Gateway uses the RMHandleGatewayRequest to respond to the request.
945 if (OC_GATEWAY_URI != virtualUriInRequest)
948 if(discoveryResult == OC_STACK_OK)
950 SendNonPersistantDiscoveryResponse(request, resource, payload, OC_EH_OK);
952 else if(((request->devAddr.flags & OC_MULTICAST) == false) &&
953 (request->devAddr.adapter != OC_ADAPTER_RFCOMM_BTEDR) &&
954 (request->devAddr.adapter != OC_ADAPTER_GATT_BTLE))
956 OIC_LOG_V(ERROR, TAG, "Sending a (%d) error to (%d) discovery request",
957 discoveryResult, virtualUriInRequest);
958 SendNonPersistantDiscoveryResponse(request, resource, NULL,
959 (discoveryResult == OC_STACK_NO_RESOURCE) ? OC_EH_RESOURCE_NOT_FOUND : OC_EH_ERROR);
963 // Ignoring the discovery request as per RFC 7252, Section #8.2
964 OIC_LOG(INFO, TAG, "Silently ignoring the request since no useful data to send. ");
968 OCPayloadDestroy(payload);
974 HandleDefaultDeviceEntityHandler (OCServerRequest *request)
978 return OC_STACK_INVALID_PARAM;
981 OCStackResult result = OC_STACK_OK;
982 OCEntityHandlerResult ehResult = OC_EH_ERROR;
983 OCEntityHandlerRequest ehRequest = {0};
985 OIC_LOG(INFO, TAG, "Entering HandleResourceWithDefaultDeviceEntityHandler");
986 result = FormOCEntityHandlerRequest(&ehRequest,
987 (OCRequestHandle) request,
990 (OCResourceHandle) NULL, request->query,
991 PAYLOAD_TYPE_REPRESENTATION,
993 request->payloadSize,
994 request->numRcvdVendorSpecificHeaderOptions,
995 request->rcvdVendorSpecificHeaderOptions,
996 (OCObserveAction)request->observationOption,
999 VERIFY_SUCCESS(result, OC_STACK_OK);
1001 // At this point we know for sure that defaultDeviceHandler exists
1002 ehResult = defaultDeviceHandler(OC_REQUEST_FLAG, &ehRequest,
1003 (char*) request->resourceUrl, defaultDeviceHandlerCallbackParameter);
1004 if(ehResult == OC_EH_SLOW)
1006 OIC_LOG(INFO, TAG, "This is a slow resource");
1007 request->slowFlag = 1;
1009 else if(ehResult == OC_EH_ERROR)
1011 FindAndDeleteServerRequest(request);
1013 result = EntityHandlerCodeToOCStackCode(ehResult);
1015 OCPayloadDestroy(ehRequest.payload);
1019 static OCStackResult
1020 HandleResourceWithEntityHandler (OCServerRequest *request,
1021 OCResource *resource,
1022 uint8_t collectionResource)
1024 if(!request || ! resource)
1026 return OC_STACK_INVALID_PARAM;
1029 OCStackResult result = OC_STACK_ERROR;
1030 OCEntityHandlerResult ehResult = OC_EH_ERROR;
1031 OCEntityHandlerFlag ehFlag = OC_REQUEST_FLAG;
1032 ResourceObserver *resObs = NULL;
1034 OCEntityHandlerRequest ehRequest = {0};
1036 OIC_LOG(INFO, TAG, "Entering HandleResourceWithEntityHandler");
1037 OCPayloadType type = PAYLOAD_TYPE_REPRESENTATION;
1038 // check the security resource
1039 if (request && request->resourceUrl && SRMIsSecurityResourceURI(request->resourceUrl))
1041 type = PAYLOAD_TYPE_SECURITY;
1045 if (request && strcmp(request->resourceUrl, OC_RSRVD_RD_URI) == 0)
1047 type = PAYLOAD_TYPE_RD;
1050 result = FormOCEntityHandlerRequest(&ehRequest,
1051 (OCRequestHandle)request,
1054 (OCResourceHandle)resource,
1058 request->payloadSize,
1059 request->numRcvdVendorSpecificHeaderOptions,
1060 request->rcvdVendorSpecificHeaderOptions,
1061 (OCObserveAction)request->observationOption,
1064 VERIFY_SUCCESS(result, OC_STACK_OK);
1066 if(ehRequest.obsInfo.action == OC_OBSERVE_NO_OPTION)
1068 OIC_LOG(INFO, TAG, "No observation requested");
1069 ehFlag = OC_REQUEST_FLAG;
1071 else if(ehRequest.obsInfo.action == OC_OBSERVE_REGISTER && !collectionResource)
1073 OIC_LOG(INFO, TAG, "Observation registration requested");
1075 ResourceObserver *obs = GetObserverUsingToken (request->requestToken,
1076 request->tokenLength);
1080 OIC_LOG (INFO, TAG, "Observer with this token already present");
1081 OIC_LOG (INFO, TAG, "Possibly re-transmitted CON OBS request");
1082 OIC_LOG (INFO, TAG, "Not adding observer. Not responding to client");
1083 OIC_LOG (INFO, TAG, "The first request for this token is already ACKED.");
1085 // server requests are usually free'd when the response is sent out
1086 // for the request in ocserverrequest.c : HandleSingleResponse()
1087 // Since we are making an early return and not responding, the server request
1088 // needs to be deleted.
1089 FindAndDeleteServerRequest (request);
1093 result = GenerateObserverId(&ehRequest.obsInfo.obsId);
1094 VERIFY_SUCCESS(result, OC_STACK_OK);
1096 result = AddObserver ((const char*)(request->resourceUrl),
1097 (const char *)(request->query),
1098 ehRequest.obsInfo.obsId, request->requestToken, request->tokenLength,
1099 resource, request->qos, request->acceptFormat,
1102 if(result == OC_STACK_OK)
1104 OIC_LOG(INFO, TAG, "Added observer successfully");
1105 request->observeResult = OC_STACK_OK;
1106 ehFlag = (OCEntityHandlerFlag)(OC_REQUEST_FLAG | OC_OBSERVE_FLAG);
1110 // The error in observeResult for the request will be used when responding to this
1111 // request by omitting the observation option/sequence number.
1112 request->observeResult = OC_STACK_ERROR;
1113 OIC_LOG(ERROR, TAG, "Observer Addition failed");
1114 ehFlag = OC_REQUEST_FLAG;
1115 FindAndDeleteServerRequest(request);
1120 else if(ehRequest.obsInfo.action == OC_OBSERVE_DEREGISTER &&
1121 !collectionResource)
1123 OIC_LOG(INFO, TAG, "Deregistering observation requested");
1125 resObs = GetObserverUsingToken (request->requestToken, request->tokenLength);
1129 // Stack does not contain this observation request
1130 // Either token is incorrect or observation list is corrupted
1131 result = OC_STACK_ERROR;
1134 ehRequest.obsInfo.obsId = resObs->observeId;
1135 ehFlag = (OCEntityHandlerFlag)(ehFlag | OC_OBSERVE_FLAG);
1137 result = DeleteObserverUsingToken (request->requestToken, request->tokenLength);
1139 if(result == OC_STACK_OK)
1141 OIC_LOG(INFO, TAG, "Removed observer successfully");
1142 request->observeResult = OC_STACK_OK;
1146 request->observeResult = OC_STACK_ERROR;
1147 OIC_LOG(ERROR, TAG, "Observer Removal failed");
1148 FindAndDeleteServerRequest(request);
1154 result = OC_STACK_ERROR;
1158 ehResult = resource->entityHandler(ehFlag, &ehRequest, resource->entityHandlerCallbackParam);
1159 if(ehResult == OC_EH_SLOW)
1161 OIC_LOG(INFO, TAG, "This is a slow resource");
1162 request->slowFlag = 1;
1164 else if(ehResult == OC_EH_ERROR)
1166 FindAndDeleteServerRequest(request);
1168 result = EntityHandlerCodeToOCStackCode(ehResult);
1170 OCPayloadDestroy(ehRequest.payload);
1174 static OCStackResult
1175 HandleCollectionResourceDefaultEntityHandler (OCServerRequest *request,
1176 OCResource *resource)
1178 if(!request || !resource)
1180 return OC_STACK_INVALID_PARAM;
1183 OCStackResult result = OC_STACK_ERROR;
1184 OCEntityHandlerRequest ehRequest = {0};
1186 result = FormOCEntityHandlerRequest(&ehRequest,
1187 (OCRequestHandle)request,
1190 (OCResourceHandle)resource,
1192 PAYLOAD_TYPE_REPRESENTATION,
1194 request->payloadSize,
1195 request->numRcvdVendorSpecificHeaderOptions,
1196 request->rcvdVendorSpecificHeaderOptions,
1197 (OCObserveAction)request->observationOption,
1200 if(result == OC_STACK_OK)
1202 result = DefaultCollectionEntityHandler (OC_REQUEST_FLAG, &ehRequest);
1205 OCPayloadDestroy(ehRequest.payload);
1210 ProcessRequest(ResourceHandling resHandling, OCResource *resource, OCServerRequest *request)
1212 OCStackResult ret = OC_STACK_OK;
1214 switch (resHandling)
1216 case OC_RESOURCE_VIRTUAL:
1218 ret = HandleVirtualResource (request, resource);
1221 case OC_RESOURCE_DEFAULT_DEVICE_ENTITYHANDLER:
1223 ret = HandleDefaultDeviceEntityHandler(request);
1226 case OC_RESOURCE_NOT_COLLECTION_DEFAULT_ENTITYHANDLER:
1228 OIC_LOG(INFO, TAG, "OC_RESOURCE_NOT_COLLECTION_DEFAULT_ENTITYHANDLER");
1229 return OC_STACK_ERROR;
1231 case OC_RESOURCE_NOT_COLLECTION_WITH_ENTITYHANDLER:
1233 ret = HandleResourceWithEntityHandler (request, resource, 0);
1236 case OC_RESOURCE_COLLECTION_WITH_ENTITYHANDLER:
1238 ret = HandleResourceWithEntityHandler (request, resource, 1);
1241 case OC_RESOURCE_COLLECTION_DEFAULT_ENTITYHANDLER:
1243 ret = HandleCollectionResourceDefaultEntityHandler (request, resource);
1246 case OC_RESOURCE_NOT_SPECIFIED:
1248 ret = OC_STACK_NO_RESOURCE;
1253 OIC_LOG(INFO, TAG, "Invalid Resource Determination");
1254 return OC_STACK_ERROR;
1260 void DeletePlatformInfo()
1262 OIC_LOG(INFO, TAG, "Deleting platform info.");
1264 OICFree(savedPlatformInfo.platformID);
1265 savedPlatformInfo.platformID = NULL;
1267 OICFree(savedPlatformInfo.manufacturerName);
1268 savedPlatformInfo.manufacturerName = NULL;
1270 OICFree(savedPlatformInfo.manufacturerUrl);
1271 savedPlatformInfo.manufacturerUrl = NULL;
1273 OICFree(savedPlatformInfo.modelNumber);
1274 savedPlatformInfo.modelNumber = NULL;
1276 OICFree(savedPlatformInfo.dateOfManufacture);
1277 savedPlatformInfo.dateOfManufacture = NULL;
1279 OICFree(savedPlatformInfo.platformVersion);
1280 savedPlatformInfo.platformVersion = NULL;
1282 OICFree(savedPlatformInfo.operatingSystemVersion);
1283 savedPlatformInfo.operatingSystemVersion = NULL;
1285 OICFree(savedPlatformInfo.hardwareVersion);
1286 savedPlatformInfo.hardwareVersion = NULL;
1288 OICFree(savedPlatformInfo.firmwareVersion);
1289 savedPlatformInfo.firmwareVersion = NULL;
1291 OICFree(savedPlatformInfo.supportUrl);
1292 savedPlatformInfo.supportUrl = NULL;
1294 OICFree(savedPlatformInfo.systemTime);
1295 savedPlatformInfo.systemTime = NULL;
1298 static OCStackResult DeepCopyPlatFormInfo(OCPlatformInfo info)
1300 savedPlatformInfo.platformID = OICStrdup(info.platformID);
1301 savedPlatformInfo.manufacturerName = OICStrdup(info.manufacturerName);
1302 savedPlatformInfo.manufacturerUrl = OICStrdup(info.manufacturerUrl);
1303 savedPlatformInfo.modelNumber = OICStrdup(info.modelNumber);
1304 savedPlatformInfo.dateOfManufacture = OICStrdup(info.dateOfManufacture);
1305 savedPlatformInfo.platformVersion = OICStrdup(info.platformVersion);
1306 savedPlatformInfo.operatingSystemVersion = OICStrdup(info.operatingSystemVersion);
1307 savedPlatformInfo.hardwareVersion = OICStrdup(info.hardwareVersion);
1308 savedPlatformInfo.firmwareVersion = OICStrdup(info.firmwareVersion);
1309 savedPlatformInfo.supportUrl = OICStrdup(info.supportUrl);
1310 savedPlatformInfo.systemTime = OICStrdup(info.systemTime);
1312 if ((!savedPlatformInfo.platformID && info.platformID)||
1313 (!savedPlatformInfo.manufacturerName && info.manufacturerName)||
1314 (!savedPlatformInfo.manufacturerUrl && info.manufacturerUrl)||
1315 (!savedPlatformInfo.modelNumber && info.modelNumber)||
1316 (!savedPlatformInfo.dateOfManufacture && info.dateOfManufacture)||
1317 (!savedPlatformInfo.platformVersion && info.platformVersion)||
1318 (!savedPlatformInfo.operatingSystemVersion && info.operatingSystemVersion)||
1319 (!savedPlatformInfo.hardwareVersion && info.hardwareVersion)||
1320 (!savedPlatformInfo.firmwareVersion && info.firmwareVersion)||
1321 (!savedPlatformInfo.supportUrl && info.supportUrl)||
1322 (!savedPlatformInfo.systemTime && info.systemTime))
1324 DeletePlatformInfo();
1325 return OC_STACK_INVALID_PARAM;
1332 OCStackResult SavePlatformInfo(OCPlatformInfo info)
1334 DeletePlatformInfo();
1336 OCStackResult res = DeepCopyPlatFormInfo(info);
1338 if (res != OC_STACK_OK)
1340 OIC_LOG_V(ERROR, TAG, "Failed to save platform info. errno(%d)", res);
1344 OIC_LOG(INFO, TAG, "Platform info saved.");
1350 void DeleteDeviceInfo()
1352 OIC_LOG(INFO, TAG, "Deleting device info.");
1354 OICFree(savedDeviceInfo.deviceName);
1355 OCFreeOCStringLL(savedDeviceInfo.types);
1356 OICFree(savedDeviceInfo.specVersion);
1357 OCFreeOCStringLL(savedDeviceInfo.dataModelVersions);
1358 savedDeviceInfo.deviceName = NULL;
1359 savedDeviceInfo.specVersion = NULL;
1360 savedDeviceInfo.dataModelVersions = NULL;
1363 static OCStackResult DeepCopyDeviceInfo(OCDeviceInfo info)
1365 savedDeviceInfo.deviceName = OICStrdup(info.deviceName);
1367 if(!savedDeviceInfo.deviceName && info.deviceName)
1370 return OC_STACK_NO_MEMORY;
1375 savedDeviceInfo.types = CloneOCStringLL(info.types);
1376 OCStringLL *type = info.types;
1380 if (type && type->value && 0 == strcmp(type->value, OC_RSRVD_RESOURCE_TYPE_DEVICE))
1388 // Append the oic.wk.d at the start of rt link parameter value.
1389 OCStringLL *dest = (OCStringLL*)OICCalloc (1, sizeof (OCStringLL));
1393 return OC_STACK_NO_MEMORY;
1395 dest->value = OICStrdup (OC_RSRVD_RESOURCE_TYPE_DEVICE);
1399 return OC_STACK_NO_MEMORY;
1401 dest->next = savedDeviceInfo.types;
1402 savedDeviceInfo.types = dest;
1404 if(!savedDeviceInfo.types && info.types)
1407 return OC_STACK_NO_MEMORY;
1411 if (info.specVersion)
1413 savedDeviceInfo.specVersion = OICStrdup(info.specVersion);
1414 if(!savedDeviceInfo.specVersion && info.specVersion)
1417 return OC_STACK_NO_MEMORY;
1422 savedDeviceInfo.specVersion = OICStrdup(OC_SPEC_VERSION);
1423 if(!savedDeviceInfo.specVersion && OC_SPEC_VERSION)
1426 return OC_STACK_NO_MEMORY;
1430 if (info.dataModelVersions)
1432 savedDeviceInfo.dataModelVersions = CloneOCStringLL(info.dataModelVersions);
1433 if(!savedDeviceInfo.dataModelVersions && info.dataModelVersions)
1436 return OC_STACK_NO_MEMORY;
1441 savedDeviceInfo.dataModelVersions = (OCStringLL *)OICCalloc(1,sizeof(OCStringLL));
1442 if (!savedDeviceInfo.dataModelVersions)
1444 return OC_STACK_NO_MEMORY;
1446 savedDeviceInfo.dataModelVersions->value = OICStrdup(OC_DATA_MODEL_VERSION);
1447 if(!savedDeviceInfo.dataModelVersions->value && OC_DATA_MODEL_VERSION)
1450 return OC_STACK_NO_MEMORY;
1457 OCStackResult SaveDeviceInfo(OCDeviceInfo info)
1459 OCStackResult res = OC_STACK_OK;
1463 res = DeepCopyDeviceInfo(info);
1465 VERIFY_SUCCESS(res, OC_STACK_OK);
1467 if (OCGetServerInstanceIDString() == NULL)
1469 OIC_LOG(INFO, TAG, "Device ID generation failed");
1470 res = OC_STACK_ERROR;
1474 OIC_LOG(INFO, TAG, "Device initialized successfully.");