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;
482 case OC_EH_RESOURCE_NOT_FOUND:
483 result = OC_STACK_NO_RESOURCE;
486 result = OC_STACK_ERROR;
492 static bool resourceMatchesRTFilter(OCResource *resource, char *resourceTypeFilter)
499 // Null or empty is analogous to no filter.
500 if (resourceTypeFilter == NULL || *resourceTypeFilter == 0)
505 OCResourceType *resourceTypePtr = resource->rsrcType;
507 while (resourceTypePtr)
509 if (strcmp (resourceTypePtr->resourcetypename, resourceTypeFilter) == 0)
513 resourceTypePtr = resourceTypePtr->next;
516 OIC_LOG_V(INFO, TAG, "%s does not contain rt=%s.", resource->uri, resourceTypeFilter);
520 static bool resourceMatchesIFFilter(OCResource *resource, char *interfaceFilter)
527 // Null or empty is analogous to no filter.
528 if (interfaceFilter == NULL || *interfaceFilter == 0)
533 OCResourceInterface *interfacePtr = resource->rsrcInterface;
537 if ((strcmp (interfacePtr->name, interfaceFilter) == 0) &&
538 (strcmp (OC_RSRVD_INTERFACE_LL, interfaceFilter) == 0 ||
539 strcmp (OC_RSRVD_INTERFACE_DEFAULT, interfaceFilter) == 0))
543 interfacePtr = interfacePtr->next;
546 OIC_LOG_V(INFO, TAG, "%s does not contain if=%s.", resource->uri, interfaceFilter);
551 * If the filters are null, they will be assumed to NOT be present
552 * and the resource will not be matched against them.
553 * Function will return true if all non null AND non empty filters passed in find a match.
555 static bool includeThisResourceInResponse(OCResource *resource,
556 char *interfaceFilter,
557 char *resourceTypeFilter)
561 OIC_LOG(ERROR, TAG, "Invalid resource");
565 if (resource->resourceProperties & OC_EXPLICIT_DISCOVERABLE)
568 * At least one valid filter should be available to
569 * include the resource in discovery response
571 if (!(resourceTypeFilter && *resourceTypeFilter))
573 OIC_LOG_V(INFO, TAG, "%s no query string for EXPLICIT_DISCOVERABLE \
574 resource", resource->uri);
578 else if ( !(resource->resourceProperties & OC_ACTIVE) ||
579 !(resource->resourceProperties & OC_DISCOVERABLE))
581 OIC_LOG_V(INFO, TAG, "%s not ACTIVE or DISCOVERABLE", resource->uri);
585 return resourceMatchesIFFilter(resource, interfaceFilter) &&
586 resourceMatchesRTFilter(resource, resourceTypeFilter);
590 OCStackResult SendNonPersistantDiscoveryResponse(OCServerRequest *request, OCResource *resource,
591 OCPayload *discoveryPayload, OCEntityHandlerResult ehResult)
593 OCEntityHandlerResponse response = {0};
595 response.ehResult = ehResult;
596 response.payload = discoveryPayload;
597 response.persistentBufferFlag = 0;
598 response.requestHandle = (OCRequestHandle) request;
599 response.resourceHandle = (OCResourceHandle) resource;
601 return OCDoResponse(&response);
605 static OCStackResult checkResourceExistsAtRD(const char *interfaceType, const char *resourceType,
606 OCResource **payload, OCDevAddr *devAddr)
608 OCResourceCollectionPayload *repPayload;
611 return OC_STACK_ERROR;
613 if (OCRDCheckPublishedResource(interfaceType, resourceType, &repPayload, devAddr) == OC_STACK_OK)
617 return OC_STACK_ERROR;
619 OCResource *ptr = ((OCResource *) OICCalloc(1, sizeof(OCResource)));
622 return OC_STACK_NO_MEMORY;
625 ptr->uri = OICStrdup(repPayload->setLinks->href);
628 return OC_STACK_NO_MEMORY;
630 OCStringLL *rt = repPayload->setLinks->rt;
633 OCResourceType *temp = (OCResourceType *) OICCalloc(1, sizeof(OCResourceType));
637 return OC_STACK_NO_MEMORY;
640 temp->resourcetypename = OICStrdup(rt->value);
643 ptr->rsrcType = temp;
647 OCResourceType *type = ptr->rsrcType;
657 OCStringLL *itf = repPayload->setLinks->itf;
660 OCResourceInterface *temp = (OCResourceInterface *) OICCalloc(1, sizeof(OCResourceInterface));
665 return OC_STACK_NO_MEMORY;
668 temp->name = OICStrdup(itf->value);
669 if (!ptr->rsrcInterface)
671 ptr->rsrcInterface = temp;
675 OCResourceInterface *type = ptr->rsrcInterface;
685 ptr->resourceProperties = (OCResourceProperty) repPayload->tags->bitmap;
687 OCFreeCollectionResource(repPayload);
693 OIC_LOG_V(ERROR, TAG, "The resource type or interface type doe not exist \
694 on the resource directory");
696 return OC_STACK_ERROR;
700 static OCStackResult HandleVirtualResource (OCServerRequest *request, OCResource* resource)
702 if (!request || !resource)
704 return OC_STACK_INVALID_PARAM;
707 OCStackResult discoveryResult = OC_STACK_ERROR;
709 bool bMulticast = false; // Was the discovery request a multicast request?
710 OCPayload* payload = NULL;
712 OIC_LOG(INFO, TAG, "Entering HandleVirtualResource");
714 OCVirtualResources virtualUriInRequest = GetTypeOfVirtualURI (request->resourceUrl);
716 // Step 1: Generate the response to discovery request
717 if (virtualUriInRequest == OC_WELL_KNOWN_URI)
719 if (request->method == OC_REST_PUT || request->method == OC_REST_POST || request->method == OC_REST_DELETE)
721 OIC_LOG_V(ERROR, TAG, "Resource : %s not permitted for method: %d", request->resourceUrl, request->method);
722 return OC_STACK_UNAUTHORIZED_REQ;
725 char *interfaceQuery = NULL;
726 char *resourceTypeQuery = NULL;
728 discoveryResult = getQueryParamsForFiltering (virtualUriInRequest, request->query,
729 &interfaceQuery, &resourceTypeQuery);
730 bool interfaceQueryAllocated = false;
731 if (!interfaceQuery && !resourceTypeQuery)
733 interfaceQueryAllocated = true;
734 interfaceQuery = OICStrdup(OC_RSRVD_INTERFACE_LL);
737 if (discoveryResult == OC_STACK_OK)
739 payload = (OCPayload *)OCDiscoveryPayloadCreate();
743 OCDiscoveryPayload *discPayload = (OCDiscoveryPayload *)payload;
744 discPayload->sid = (char *)OICCalloc(1, UUID_STRING_SIZE);
745 VERIFY_NON_NULL(discPayload->sid, ERROR, OC_STACK_NO_MEMORY);
747 const char* uid = OCGetServerInstanceIDString();
750 memcpy(discPayload->sid, uid, UUID_STRING_SIZE);
753 if (!resourceTypeQuery && interfaceQuery && (0 == strcmp(interfaceQuery, OC_RSRVD_INTERFACE_LL)))
755 for (; resource && discoveryResult == OC_STACK_OK; resource = resource->next)
758 if (resource->resourceProperties & OC_EXPLICIT_DISCOVERABLE)
760 if (resourceTypeQuery && resourceMatchesRTFilter(resource, resourceTypeQuery))
765 if (resource->resourceProperties & OC_DISCOVERABLE)
772 discoveryResult = BuildVirtualResourceResponse(resource,
773 discPayload, &request->devAddr, false);
779 if ((interfaceQuery && (0 != strcmp(interfaceQuery, OC_RSRVD_INTERFACE_LL))) ||
782 discPayload->uri = OICStrdup(OC_RSRVD_WELL_KNOWN_URI);
783 VERIFY_NON_NULL(discPayload->uri, ERROR, OC_STACK_NO_MEMORY);
784 if (savedDeviceInfo.deviceName)
786 discPayload->name = OICStrdup(savedDeviceInfo.deviceName);
787 VERIFY_NON_NULL(discPayload->name, ERROR, OC_STACK_NO_MEMORY);
789 discPayload->type = OICStrdup(OC_RSRVD_RESOURCE_TYPE_RES);
790 VERIFY_NON_NULL(discPayload->type, ERROR, OC_STACK_NO_MEMORY);
791 OCResourcePayloadAddStringLL(&discPayload->iface, OC_RSRVD_INTERFACE_LL);
792 OCResourcePayloadAddStringLL(&discPayload->iface, OC_RSRVD_INTERFACE_DEFAULT);
793 VERIFY_NON_NULL(discPayload->iface, ERROR, OC_STACK_NO_MEMORY);
795 bool foundResourceAtRD = false;
796 for (;resource && discoveryResult == OC_STACK_OK; resource = resource->next)
799 if (strcmp(resource->uri, OC_RSRVD_RD_URI) == 0)
801 OCResource *resource1 = NULL;
803 discoveryResult = checkResourceExistsAtRD(interfaceQuery,
804 resourceTypeQuery, &resource1, &devAddr);
805 if (discoveryResult != OC_STACK_OK)
809 discoveryResult = BuildVirtualResourceResponse(resource1,
810 discPayload, &devAddr, true);
813 discPayload->baseURI = OICStrdup(devAddr.addr);
815 OICFree(resource1->uri);
816 for (OCResourceType *rsrcRt = resource1->rsrcType, *rsrcRtNext = NULL; rsrcRt; )
818 rsrcRtNext = rsrcRt->next;
819 OICFree(rsrcRt->resourcetypename);
824 for (OCResourceInterface *rsrcPtr = resource1->rsrcInterface, *rsrcNext = NULL; rsrcPtr; )
826 rsrcNext = rsrcPtr->next;
827 OICFree(rsrcPtr->name);
831 foundResourceAtRD = true;
834 if (!foundResourceAtRD && includeThisResourceInResponse(resource, interfaceQuery, resourceTypeQuery))
836 discoveryResult = BuildVirtualResourceResponse(resource,
837 discPayload, &request->devAddr, false);
840 // Set discoveryResult appropriately if no 'valid' resources are available
841 if (discPayload->resources == NULL && !foundResourceAtRD)
843 discoveryResult = OC_STACK_NO_RESOURCE;
849 discoveryResult = OC_STACK_NO_MEMORY;
854 OIC_LOG_V(ERROR, TAG, "Error (%d) parsing query.", discoveryResult);
856 if (interfaceQueryAllocated)
858 OICFree(interfaceQuery);
861 else if (virtualUriInRequest == OC_DEVICE_URI)
863 if (request->method == OC_REST_PUT || request->method == OC_REST_POST || request->method == OC_REST_DELETE)
865 OIC_LOG_V(ERROR, TAG, "Resource : %s not permitted for method: %d", request->resourceUrl, request->method);
866 return OC_STACK_UNAUTHORIZED_REQ;
869 const char* deviceId = OCGetServerInstanceIDString();
872 discoveryResult = OC_STACK_ERROR;
876 payload = (OCPayload*) OCDevicePayloadCreate(deviceId, savedDeviceInfo.deviceName,
877 savedDeviceInfo.types, savedDeviceInfo.specVersion, savedDeviceInfo.dataModleVersion);
880 discoveryResult = OC_STACK_NO_MEMORY;
884 discoveryResult = OC_STACK_OK;
888 else if (virtualUriInRequest == OC_PLATFORM_URI)
890 if (request->method == OC_REST_PUT || request->method == OC_REST_POST || request->method == OC_REST_DELETE)
892 OIC_LOG_V(ERROR, TAG, "Resource : %s not permitted for method: %d", request->resourceUrl, request->method);
893 return OC_STACK_UNAUTHORIZED_REQ;
896 payload = (OCPayload*)OCPlatformPayloadCreate(&savedPlatformInfo);
899 discoveryResult = OC_STACK_NO_MEMORY;
903 discoveryResult = OC_STACK_OK;
906 #ifdef ROUTING_GATEWAY
907 else if (OC_GATEWAY_URI == virtualUriInRequest)
909 // Received request for a gateway
910 OIC_LOG(INFO, TAG, "Request is for Gateway Virtual Request");
911 discoveryResult = RMHandleGatewayRequest(request, resource);
917 * Step 2: Send the discovery response
919 * Iotivity should respond to discovery requests in below manner:
920 * 1)If query filter matching fails and discovery request is multicast,
921 * it should NOT send any response.
922 * 2)If query filter matching fails and discovery request is unicast,
923 * it should send an error(RESOURCE_NOT_FOUND - 404) response.
924 * 3)If Server does not have any 'DISCOVERABLE' resources and discovery
925 * request is multicast, it should NOT send any response.
926 * 4)If Server does not have any 'DISCOVERABLE' resources and discovery
927 * request is unicast, it should send an error(RESOURCE_NOT_FOUND - 404) response.
931 if ((virtualUriInRequest == OC_PRESENCE) &&
932 (resource->resourceProperties & OC_ACTIVE))
934 // Presence uses observer notification api to respond via SendPresenceNotification.
935 SendPresenceNotification(resource->rsrcType, OC_PRESENCE_TRIGGER_CHANGE);
939 #ifdef ROUTING_GATEWAY
940 // Gateway uses the RMHandleGatewayRequest to respond to the request.
941 if (OC_GATEWAY_URI != virtualUriInRequest)
944 if(discoveryResult == OC_STACK_OK)
946 SendNonPersistantDiscoveryResponse(request, resource, payload, OC_EH_OK);
948 else if(bMulticast == false && (request->devAddr.adapter != OC_ADAPTER_RFCOMM_BTEDR) &&
949 (request->devAddr.adapter != OC_ADAPTER_GATT_BTLE))
951 OIC_LOG_V(ERROR, TAG, "Sending a (%d) error to (%d) \
952 discovery request", discoveryResult, virtualUriInRequest);
953 SendNonPersistantDiscoveryResponse(request, resource, NULL,
954 (discoveryResult == OC_STACK_NO_RESOURCE) ? OC_EH_RESOURCE_NOT_FOUND : OC_EH_ERROR);
958 // Ignoring the discovery request as per RFC 7252, Section #8.2
959 OIC_LOG(INFO, TAG, "Silently ignoring the request since device does not have \
960 any useful data to send");
964 OCPayloadDestroy(payload);
970 HandleDefaultDeviceEntityHandler (OCServerRequest *request)
974 return OC_STACK_INVALID_PARAM;
977 OCStackResult result = OC_STACK_OK;
978 OCEntityHandlerResult ehResult = OC_EH_ERROR;
979 OCEntityHandlerRequest ehRequest = {0};
981 OIC_LOG(INFO, TAG, "Entering HandleResourceWithDefaultDeviceEntityHandler");
982 result = FormOCEntityHandlerRequest(&ehRequest,
983 (OCRequestHandle) request,
986 (OCResourceHandle) NULL, request->query,
987 PAYLOAD_TYPE_REPRESENTATION,
989 request->payloadSize,
990 request->numRcvdVendorSpecificHeaderOptions,
991 request->rcvdVendorSpecificHeaderOptions,
992 (OCObserveAction)request->observationOption,
994 VERIFY_SUCCESS(result, OC_STACK_OK);
996 // At this point we know for sure that defaultDeviceHandler exists
997 ehResult = defaultDeviceHandler(OC_REQUEST_FLAG, &ehRequest,
998 (char*) request->resourceUrl, defaultDeviceHandlerCallbackParameter);
999 if(ehResult == OC_EH_SLOW)
1001 OIC_LOG(INFO, TAG, "This is a slow resource");
1002 request->slowFlag = 1;
1004 else if(ehResult == OC_EH_ERROR)
1006 FindAndDeleteServerRequest(request);
1008 result = EntityHandlerCodeToOCStackCode(ehResult);
1010 OCPayloadDestroy(ehRequest.payload);
1014 static OCStackResult
1015 HandleResourceWithEntityHandler (OCServerRequest *request,
1016 OCResource *resource,
1017 uint8_t collectionResource)
1019 if(!request || ! resource)
1021 return OC_STACK_INVALID_PARAM;
1024 OCStackResult result = OC_STACK_ERROR;
1025 OCEntityHandlerResult ehResult = OC_EH_ERROR;
1026 OCEntityHandlerFlag ehFlag = OC_REQUEST_FLAG;
1027 ResourceObserver *resObs = NULL;
1029 OCEntityHandlerRequest ehRequest = {0};
1031 OIC_LOG(INFO, TAG, "Entering HandleResourceWithEntityHandler");
1032 OCPayloadType type = PAYLOAD_TYPE_REPRESENTATION;
1033 // check the security resource
1034 if (request && request->resourceUrl && SRMIsSecurityResourceURI(request->resourceUrl))
1036 type = PAYLOAD_TYPE_SECURITY;
1040 if (request && strcmp(request->resourceUrl, OC_RSRVD_RD_URI) == 0)
1042 type = PAYLOAD_TYPE_RD;
1045 result = FormOCEntityHandlerRequest(&ehRequest,
1046 (OCRequestHandle)request,
1049 (OCResourceHandle)resource,
1053 request->payloadSize,
1054 request->numRcvdVendorSpecificHeaderOptions,
1055 request->rcvdVendorSpecificHeaderOptions,
1056 (OCObserveAction)request->observationOption,
1058 VERIFY_SUCCESS(result, OC_STACK_OK);
1060 if(ehRequest.obsInfo.action == OC_OBSERVE_NO_OPTION)
1062 OIC_LOG(INFO, TAG, "No observation requested");
1063 ehFlag = OC_REQUEST_FLAG;
1065 else if(ehRequest.obsInfo.action == OC_OBSERVE_REGISTER && !collectionResource)
1067 OIC_LOG(INFO, TAG, "Observation registration requested");
1069 ResourceObserver *obs = GetObserverUsingToken (request->requestToken,
1070 request->tokenLength);
1074 OIC_LOG (INFO, TAG, "Observer with this token already present");
1075 OIC_LOG (INFO, TAG, "Possibly re-transmitted CON OBS request");
1076 OIC_LOG (INFO, TAG, "Not adding observer. Not responding to client");
1077 OIC_LOG (INFO, TAG, "The first request for this token is already ACKED.");
1079 // server requests are usually free'd when the response is sent out
1080 // for the request in ocserverrequest.c : HandleSingleResponse()
1081 // Since we are making an early return and not responding, the server request
1082 // needs to be deleted.
1083 FindAndDeleteServerRequest (request);
1087 result = GenerateObserverId(&ehRequest.obsInfo.obsId);
1088 VERIFY_SUCCESS(result, OC_STACK_OK);
1090 result = AddObserver ((const char*)(request->resourceUrl),
1091 (const char *)(request->query),
1092 ehRequest.obsInfo.obsId, request->requestToken, request->tokenLength,
1093 resource, request->qos, request->acceptFormat,
1096 if(result == OC_STACK_OK)
1098 OIC_LOG(INFO, TAG, "Added observer successfully");
1099 request->observeResult = OC_STACK_OK;
1100 ehFlag = (OCEntityHandlerFlag)(OC_REQUEST_FLAG | OC_OBSERVE_FLAG);
1104 // The error in observeResult for the request will be used when responding to this
1105 // request by omitting the observation option/sequence number.
1106 request->observeResult = OC_STACK_ERROR;
1107 OIC_LOG(ERROR, TAG, "Observer Addition failed");
1108 ehFlag = OC_REQUEST_FLAG;
1109 FindAndDeleteServerRequest(request);
1114 else if(ehRequest.obsInfo.action == OC_OBSERVE_DEREGISTER &&
1115 !collectionResource)
1117 OIC_LOG(INFO, TAG, "Deregistering observation requested");
1119 resObs = GetObserverUsingToken (request->requestToken, request->tokenLength);
1123 // Stack does not contain this observation request
1124 // Either token is incorrect or observation list is corrupted
1125 result = OC_STACK_ERROR;
1128 ehRequest.obsInfo.obsId = resObs->observeId;
1129 ehFlag = (OCEntityHandlerFlag)(ehFlag | OC_OBSERVE_FLAG);
1131 result = DeleteObserverUsingToken (request->requestToken, request->tokenLength);
1133 if(result == OC_STACK_OK)
1135 OIC_LOG(INFO, TAG, "Removed observer successfully");
1136 request->observeResult = OC_STACK_OK;
1140 request->observeResult = OC_STACK_ERROR;
1141 OIC_LOG(ERROR, TAG, "Observer Removal failed");
1142 FindAndDeleteServerRequest(request);
1148 result = OC_STACK_ERROR;
1152 ehResult = resource->entityHandler(ehFlag, &ehRequest, resource->entityHandlerCallbackParam);
1153 if(ehResult == OC_EH_SLOW)
1155 OIC_LOG(INFO, TAG, "This is a slow resource");
1156 request->slowFlag = 1;
1158 else if(ehResult == OC_EH_ERROR)
1160 FindAndDeleteServerRequest(request);
1162 result = EntityHandlerCodeToOCStackCode(ehResult);
1164 OCPayloadDestroy(ehRequest.payload);
1168 static OCStackResult
1169 HandleCollectionResourceDefaultEntityHandler (OCServerRequest *request,
1170 OCResource *resource)
1172 if(!request || !resource)
1174 return OC_STACK_INVALID_PARAM;
1177 OCStackResult result = OC_STACK_ERROR;
1178 OCEntityHandlerRequest ehRequest = {0};
1180 result = FormOCEntityHandlerRequest(&ehRequest,
1181 (OCRequestHandle)request,
1184 (OCResourceHandle)resource,
1186 PAYLOAD_TYPE_REPRESENTATION,
1188 request->payloadSize,
1189 request->numRcvdVendorSpecificHeaderOptions,
1190 request->rcvdVendorSpecificHeaderOptions,
1191 (OCObserveAction)request->observationOption,
1192 (OCObservationId)0);
1193 if(result == OC_STACK_OK)
1195 result = DefaultCollectionEntityHandler (OC_REQUEST_FLAG, &ehRequest);
1198 OCPayloadDestroy(ehRequest.payload);
1203 ProcessRequest(ResourceHandling resHandling, OCResource *resource, OCServerRequest *request)
1205 OCStackResult ret = OC_STACK_OK;
1207 switch (resHandling)
1209 case OC_RESOURCE_VIRTUAL:
1211 ret = HandleVirtualResource (request, resource);
1214 case OC_RESOURCE_DEFAULT_DEVICE_ENTITYHANDLER:
1216 ret = HandleDefaultDeviceEntityHandler(request);
1219 case OC_RESOURCE_NOT_COLLECTION_DEFAULT_ENTITYHANDLER:
1221 OIC_LOG(INFO, TAG, "OC_RESOURCE_NOT_COLLECTION_DEFAULT_ENTITYHANDLER");
1222 return OC_STACK_ERROR;
1224 case OC_RESOURCE_NOT_COLLECTION_WITH_ENTITYHANDLER:
1226 ret = HandleResourceWithEntityHandler (request, resource, 0);
1229 case OC_RESOURCE_COLLECTION_WITH_ENTITYHANDLER:
1231 ret = HandleResourceWithEntityHandler (request, resource, 1);
1234 case OC_RESOURCE_COLLECTION_DEFAULT_ENTITYHANDLER:
1236 ret = HandleCollectionResourceDefaultEntityHandler (request, resource);
1239 case OC_RESOURCE_NOT_SPECIFIED:
1241 ret = OC_STACK_NO_RESOURCE;
1246 OIC_LOG(INFO, TAG, "Invalid Resource Determination");
1247 return OC_STACK_ERROR;
1253 void DeletePlatformInfo()
1255 OIC_LOG(INFO, TAG, "Deleting platform info.");
1257 OICFree(savedPlatformInfo.platformID);
1258 savedPlatformInfo.platformID = NULL;
1260 OICFree(savedPlatformInfo.manufacturerName);
1261 savedPlatformInfo.manufacturerName = NULL;
1263 OICFree(savedPlatformInfo.manufacturerUrl);
1264 savedPlatformInfo.manufacturerUrl = NULL;
1266 OICFree(savedPlatformInfo.modelNumber);
1267 savedPlatformInfo.modelNumber = NULL;
1269 OICFree(savedPlatformInfo.dateOfManufacture);
1270 savedPlatformInfo.dateOfManufacture = NULL;
1272 OICFree(savedPlatformInfo.platformVersion);
1273 savedPlatformInfo.platformVersion = NULL;
1275 OICFree(savedPlatformInfo.operatingSystemVersion);
1276 savedPlatformInfo.operatingSystemVersion = NULL;
1278 OICFree(savedPlatformInfo.hardwareVersion);
1279 savedPlatformInfo.hardwareVersion = NULL;
1281 OICFree(savedPlatformInfo.firmwareVersion);
1282 savedPlatformInfo.firmwareVersion = NULL;
1284 OICFree(savedPlatformInfo.supportUrl);
1285 savedPlatformInfo.supportUrl = NULL;
1287 OICFree(savedPlatformInfo.systemTime);
1288 savedPlatformInfo.systemTime = NULL;
1291 static OCStackResult DeepCopyPlatFormInfo(OCPlatformInfo info)
1293 savedPlatformInfo.platformID = OICStrdup(info.platformID);
1294 savedPlatformInfo.manufacturerName = OICStrdup(info.manufacturerName);
1295 savedPlatformInfo.manufacturerUrl = OICStrdup(info.manufacturerUrl);
1296 savedPlatformInfo.modelNumber = OICStrdup(info.modelNumber);
1297 savedPlatformInfo.dateOfManufacture = OICStrdup(info.dateOfManufacture);
1298 savedPlatformInfo.platformVersion = OICStrdup(info.platformVersion);
1299 savedPlatformInfo.operatingSystemVersion = OICStrdup(info.operatingSystemVersion);
1300 savedPlatformInfo.hardwareVersion = OICStrdup(info.hardwareVersion);
1301 savedPlatformInfo.firmwareVersion = OICStrdup(info.firmwareVersion);
1302 savedPlatformInfo.supportUrl = OICStrdup(info.supportUrl);
1303 savedPlatformInfo.systemTime = OICStrdup(info.systemTime);
1305 if ((!savedPlatformInfo.platformID && info.platformID)||
1306 (!savedPlatformInfo.manufacturerName && info.manufacturerName)||
1307 (!savedPlatformInfo.manufacturerUrl && info.manufacturerUrl)||
1308 (!savedPlatformInfo.modelNumber && info.modelNumber)||
1309 (!savedPlatformInfo.dateOfManufacture && info.dateOfManufacture)||
1310 (!savedPlatformInfo.platformVersion && info.platformVersion)||
1311 (!savedPlatformInfo.operatingSystemVersion && info.operatingSystemVersion)||
1312 (!savedPlatformInfo.hardwareVersion && info.hardwareVersion)||
1313 (!savedPlatformInfo.firmwareVersion && info.firmwareVersion)||
1314 (!savedPlatformInfo.supportUrl && info.supportUrl)||
1315 (!savedPlatformInfo.systemTime && info.systemTime))
1317 DeletePlatformInfo();
1318 return OC_STACK_INVALID_PARAM;
1325 OCStackResult SavePlatformInfo(OCPlatformInfo info)
1327 DeletePlatformInfo();
1329 OCStackResult res = DeepCopyPlatFormInfo(info);
1331 if (res != OC_STACK_OK)
1333 OIC_LOG_V(ERROR, TAG, "Failed to save platform info. errno(%d)", res);
1337 OIC_LOG(INFO, TAG, "Platform info saved.");
1343 void DeleteDeviceInfo()
1345 OIC_LOG(INFO, TAG, "Deleting device info.");
1347 OICFree(savedDeviceInfo.deviceName);
1348 OCFreeOCStringLL(savedDeviceInfo.types);
1349 OICFree(savedDeviceInfo.specVersion);
1350 OICFree(savedDeviceInfo.dataModleVersion);
1351 savedDeviceInfo.deviceName = NULL;
1352 savedDeviceInfo.specVersion = NULL;
1353 savedDeviceInfo.dataModleVersion = NULL;
1356 static OCStackResult DeepCopyDeviceInfo(OCDeviceInfo info)
1358 savedDeviceInfo.deviceName = OICStrdup(info.deviceName);
1360 if(!savedDeviceInfo.deviceName && info.deviceName)
1363 return OC_STACK_NO_MEMORY;
1368 savedDeviceInfo.types = CloneOCStringLL(info.types);
1369 if(!savedDeviceInfo.types && info.types)
1372 return OC_STACK_NO_MEMORY;
1376 if (info.specVersion)
1378 savedDeviceInfo.specVersion = OICStrdup(info.specVersion);
1379 if(!savedDeviceInfo.specVersion && info.specVersion)
1382 return OC_STACK_NO_MEMORY;
1387 savedDeviceInfo.specVersion = OICStrdup(OC_SPEC_VERSION);
1388 if(!savedDeviceInfo.specVersion && OC_SPEC_VERSION)
1391 return OC_STACK_NO_MEMORY;
1395 if (info.dataModleVersion)
1397 savedDeviceInfo.dataModleVersion = OICStrdup(info.dataModleVersion);
1398 if(!savedDeviceInfo.dataModleVersion && info.dataModleVersion)
1401 return OC_STACK_NO_MEMORY;
1406 savedDeviceInfo.dataModleVersion = OICStrdup(OC_DATA_MODEL_VERSION);
1407 if(!savedDeviceInfo.dataModleVersion && OC_DATA_MODEL_VERSION)
1410 return OC_STACK_NO_MEMORY;
1417 OCStackResult SaveDeviceInfo(OCDeviceInfo info)
1419 OCStackResult res = OC_STACK_OK;
1423 res = DeepCopyDeviceInfo(info);
1425 VERIFY_SUCCESS(res, OC_STACK_OK);
1427 if (OCGetServerInstanceIDString() == NULL)
1429 OIC_LOG(INFO, TAG, "Device ID generation failed");
1430 res = OC_STACK_ERROR;
1434 OIC_LOG(INFO, TAG, "Device initialized successfully.");