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
35 #include "ocresource.h"
36 #include "ocresourcehandler.h"
37 #include "ocobserve.h"
38 #include "occollection.h"
39 #include "oic_malloc.h"
40 #include "oic_string.h"
43 #include "ocpayload.h"
44 #include "secureresourcemanager.h"
46 #include "cainterface.h"
47 #include "rdpayload.h"
48 #include "ocpayload.h"
51 #include "rd_server.h"
54 #ifdef ROUTING_GATEWAY
55 #include "routingmanager.h"
59 #define TAG "OIC_RI_RESOURCE"
61 #define VERIFY_SUCCESS(op, successCode) { if (op != successCode) \
62 {OIC_LOG_V(FATAL, TAG, "%s failed!!", #op); goto exit;} }
64 #define VERIFY_NON_NULL(arg, logLevel, retVal) { if (!(arg)) { OIC_LOG((logLevel), \
65 TAG, #arg " is NULL"); return (retVal); } }
67 extern OCResource *headResource;
68 static OCPlatformInfo savedPlatformInfo = {0};
69 static OCDeviceInfo savedDeviceInfo = {0};
72 * Prepares a Payload for response.
74 static OCStackResult BuildVirtualResourceResponse(const OCResource *resourcePtr,
75 OCDiscoveryPayload* payload,
79 //-----------------------------------------------------------------------------
80 // Default resource entity handler function
81 //-----------------------------------------------------------------------------
82 OCEntityHandlerResult defaultResourceEHandler(OCEntityHandlerFlag flag,
83 OCEntityHandlerRequest * request, void* callbackParam)
85 //TODO ("Implement me!!!!");
86 // TODO: remove silence unused param warnings
90 return OC_EH_OK; // Making sure that the Default EH and the Vendor EH have matching signatures
93 /* This method will retrieve the port at which the secure resource is hosted */
94 static OCStackResult GetSecurePortInfo(OCDevAddr *endpoint, uint16_t *port)
98 if (endpoint->adapter == OC_ADAPTER_IP)
100 if (endpoint->flags & OC_IP_USE_V6)
102 p = caglobals.ip.u6s.port;
104 else if (endpoint->flags & OC_IP_USE_V4)
106 p = caglobals.ip.u4s.port;
115 /* This method will retrieve the tcp port */
116 static OCStackResult GetTCPPortInfo(OCDevAddr *endpoint, uint16_t *port)
120 if (endpoint->adapter == OC_ADAPTER_IP)
122 if (endpoint->flags & OC_IP_USE_V4)
124 p = caglobals.tcp.ipv4.port;
126 else if (endpoint->flags & OC_IP_USE_V6)
128 p = caglobals.tcp.ipv6.port;
138 * Function will extract 0, 1 or 2 filters from query.
139 * More than 2 filters or unsupported filters will result in error.
140 * If both filters are of the same supported type, the 2nd one will be picked.
141 * Resource and device filters in the SAME query are NOT validated
142 * and resources will likely not clear filters.
144 static OCStackResult ExtractFiltersFromQuery(char *query, char **filterOne, char **filterTwo)
149 char *restOfQuery = NULL;
150 int numKeyValuePairsParsed = 0;
155 OIC_LOG_V(INFO, TAG, "Extracting params from %s", query);
157 char *keyValuePair = strtok_r (query, OC_QUERY_SEPARATOR, &restOfQuery);
161 if (numKeyValuePairsParsed >= 2)
163 OIC_LOG(ERROR, TAG, "More than 2 queries params in URI.");
164 return OC_STACK_INVALID_QUERY;
167 key = strtok_r(keyValuePair, OC_KEY_VALUE_DELIMITER, &value);
171 return OC_STACK_INVALID_QUERY;
173 else if (strncasecmp(key, OC_RSRVD_INTERFACE, sizeof(OC_RSRVD_INTERFACE) - 1) == 0)
175 *filterOne = value; // if
177 else if (strncasecmp(key, OC_RSRVD_RESOURCE_TYPE, sizeof(OC_RSRVD_INTERFACE) - 1) == 0)
179 *filterTwo = value; // rt
183 OIC_LOG_V(ERROR, TAG, "Unsupported query key: %s", key);
184 return OC_STACK_INVALID_QUERY;
186 ++numKeyValuePairsParsed;
188 keyValuePair = strtok_r(NULL, OC_QUERY_SEPARATOR, &restOfQuery);
191 OIC_LOG_V(INFO, TAG, "Extracted params if: %s and rt: %s.", *filterOne, *filterTwo);
195 static OCVirtualResources GetTypeOfVirtualURI(const char *uriInRequest)
197 if (strcmp(uriInRequest, OC_RSRVD_WELL_KNOWN_URI) == 0)
199 return OC_WELL_KNOWN_URI;
201 else if (strcmp(uriInRequest, OC_RSRVD_DEVICE_URI) == 0)
203 return OC_DEVICE_URI;
205 else if (strcmp(uriInRequest, OC_RSRVD_PLATFORM_URI) == 0)
207 return OC_PLATFORM_URI;
209 else if (strcmp(uriInRequest, OC_RSRVD_RESOURCE_TYPES_URI) == 0)
211 return OC_RESOURCE_TYPES_URI;
213 #ifdef ROUTING_GATEWAY
214 else if (0 == strcmp(uriInRequest, OC_RSRVD_GATEWAY_URI))
216 return OC_GATEWAY_URI;
220 else if (strcmp(uriInRequest, OC_RSRVD_PRESENCE_URI) == 0)
224 #endif //WITH_PRESENCE
225 return OC_UNKNOWN_URI;
228 static OCStackResult getQueryParamsForFiltering (OCVirtualResources uri, char *query,
229 char **filterOne, char **filterTwo)
231 if(!filterOne || !filterTwo)
233 return OC_STACK_INVALID_PARAM;
240 if (uri == OC_PRESENCE)
242 //Nothing needs to be done, except for pass a OC_PRESENCE query through as OC_STACK_OK.
243 OIC_LOG(INFO, TAG, "OC_PRESENCE Request for virtual resource.");
248 OCStackResult result = OC_STACK_OK;
252 result = ExtractFiltersFromQuery(query, filterOne, filterTwo);
258 OCStackResult BuildResponseRepresentation(const OCResource *resourcePtr,
259 OCRepPayload** payload)
261 OCRepPayload *tempPayload = OCRepPayloadCreate();
265 OCRepPayloadDestroy(tempPayload);
266 return OC_STACK_INVALID_PARAM;
271 return OC_STACK_NO_MEMORY;
274 OCRepPayloadSetUri(tempPayload, resourcePtr->uri);
276 OCResourceType *resType = resourcePtr->rsrcType;
279 OCRepPayloadAddResourceType(tempPayload, resType->resourcetypename);
280 resType = resType->next;
283 OCResourceInterface *resInterface = resourcePtr->rsrcInterface;
286 OCRepPayloadAddInterface(tempPayload, resInterface->name);
287 resInterface = resInterface->next;
290 OCAttribute *resAttrib = resourcePtr->rsrcAttributes;
293 OCRepPayloadSetPropString(tempPayload, resAttrib->attrName,
294 resAttrib->attrValue);
295 resAttrib = resAttrib->next;
300 *payload = tempPayload;
304 OCRepPayloadAppend(*payload, tempPayload);
310 OCStackResult BuildVirtualResourceResponse(const OCResource *resourcePtr,
311 OCDiscoveryPayload *payload, OCDevAddr *devAddr, bool rdResponse)
313 if (!resourcePtr || !payload)
315 return OC_STACK_INVALID_PARAM;
317 uint16_t securePort = 0;
318 if (resourcePtr->resourceProperties & OC_SECURE)
320 if (GetSecurePortInfo(devAddr, &securePort) != OC_STACK_OK)
328 securePort = devAddr->port;
331 uint16_t tcpPort = 0;
333 if (GetTCPPortInfo(devAddr, &tcpPort) != OC_STACK_OK)
339 OCDiscoveryPayloadAddResource(payload, resourcePtr, securePort, tcpPort);
343 uint8_t IsCollectionResource (OCResource *resource)
350 if(resource->rsrcChildResourcesHead != NULL)
358 OCResource *FindResourceByUri(const char* resourceUri)
365 OCResource * pointer = headResource;
368 if (strcmp(resourceUri, pointer->uri) == 0)
372 pointer = pointer->next;
374 OIC_LOG_V(INFO, TAG, "Resource %s not found", resourceUri);
379 OCStackResult DetermineResourceHandling (const OCServerRequest *request,
380 ResourceHandling *handling,
381 OCResource **resource)
383 if(!request || !handling || !resource)
385 return OC_STACK_INVALID_PARAM;
388 OIC_LOG_V(INFO, TAG, "DetermineResourceHandling for %s", request->resourceUrl);
390 // Check if virtual resource
391 if (GetTypeOfVirtualURI(request->resourceUrl) != OC_UNKNOWN_URI)
393 OIC_LOG_V (INFO, TAG, "%s is virtual", request->resourceUrl);
394 *handling = OC_RESOURCE_VIRTUAL;
395 *resource = headResource;
398 if (strlen((const char*)(request->resourceUrl)) == 0)
400 // Resource URL not specified
401 *handling = OC_RESOURCE_NOT_SPECIFIED;
402 return OC_STACK_NO_RESOURCE;
406 OCResource *resourcePtr = FindResourceByUri((const char*)request->resourceUrl);
407 *resource = resourcePtr;
410 if(defaultDeviceHandler)
412 *handling = OC_RESOURCE_DEFAULT_DEVICE_ENTITYHANDLER;
416 // Resource does not exist
417 // and default device handler does not exist
418 *handling = OC_RESOURCE_NOT_SPECIFIED;
419 return OC_STACK_NO_RESOURCE;
422 if (IsCollectionResource (resourcePtr))
424 // Collection resource
425 if (resourcePtr->entityHandler != defaultResourceEHandler)
427 *handling = OC_RESOURCE_COLLECTION_WITH_ENTITYHANDLER;
432 *handling = OC_RESOURCE_COLLECTION_DEFAULT_ENTITYHANDLER;
438 // Resource not a collection
439 if (resourcePtr->entityHandler != defaultResourceEHandler)
441 *handling = OC_RESOURCE_NOT_COLLECTION_WITH_ENTITYHANDLER;
446 *handling = OC_RESOURCE_NOT_COLLECTION_DEFAULT_ENTITYHANDLER;
453 OCStackResult EntityHandlerCodeToOCStackCode(OCEntityHandlerResult ehResult)
455 OCStackResult result;
460 result = OC_STACK_OK;
463 result = OC_STACK_SLOW_RESOURCE;
466 result = OC_STACK_ERROR;
468 case OC_EH_FORBIDDEN:
469 result = OC_STACK_RESOURCE_ERROR;
471 case OC_EH_RESOURCE_CREATED:
472 result = OC_STACK_RESOURCE_CREATED;
474 case OC_EH_RESOURCE_DELETED:
475 result = OC_STACK_RESOURCE_DELETED;
477 case OC_EH_RESOURCE_NOT_FOUND:
478 result = OC_STACK_NO_RESOURCE;
481 result = OC_STACK_ERROR;
487 static bool resourceMatchesRTFilter(OCResource *resource, char *resourceTypeFilter)
494 // Null or empty is analogous to no filter.
495 if (resourceTypeFilter == NULL || *resourceTypeFilter == 0)
500 OCResourceType *resourceTypePtr = resource->rsrcType;
502 while (resourceTypePtr)
504 if (strcmp (resourceTypePtr->resourcetypename, resourceTypeFilter) == 0)
508 resourceTypePtr = resourceTypePtr->next;
511 OIC_LOG_V(INFO, TAG, "%s does not contain rt=%s.", resource->uri, resourceTypeFilter);
515 static bool resourceMatchesIFFilter(OCResource *resource, char *interfaceFilter)
522 // Null or empty is analogous to no filter.
523 if (interfaceFilter == NULL || *interfaceFilter == 0)
528 OCResourceInterface *interfacePtr = resource->rsrcInterface;
532 if ((strcmp (interfacePtr->name, interfaceFilter) == 0) &&
533 (strcmp (OC_RSRVD_INTERFACE_LL, interfaceFilter) == 0 ||
534 strcmp (OC_RSRVD_INTERFACE_DEFAULT, interfaceFilter) == 0))
538 interfacePtr = interfacePtr->next;
541 OIC_LOG_V(INFO, TAG, "%s does not contain if=%s.", resource->uri, interfaceFilter);
546 * If the filters are null, they will be assumed to NOT be present
547 * and the resource will not be matched against them.
548 * Function will return true if all non null AND non empty filters passed in find a match.
550 static bool includeThisResourceInResponse(OCResource *resource,
551 char *interfaceFilter,
552 char *resourceTypeFilter)
556 OIC_LOG(ERROR, TAG, "Invalid resource");
560 if (resource->resourceProperties & OC_EXPLICIT_DISCOVERABLE)
563 * At least one valid filter should be available to
564 * include the resource in discovery response
566 if (!(resourceTypeFilter && *resourceTypeFilter))
568 OIC_LOG_V(INFO, TAG, "%s no query string for EXPLICIT_DISCOVERABLE \
569 resource", resource->uri);
573 else if ( !(resource->resourceProperties & OC_ACTIVE) ||
574 !(resource->resourceProperties & OC_DISCOVERABLE))
576 OIC_LOG_V(INFO, TAG, "%s not ACTIVE or DISCOVERABLE", resource->uri);
580 return resourceMatchesIFFilter(resource, interfaceFilter) &&
581 resourceMatchesRTFilter(resource, resourceTypeFilter);
585 OCStackResult SendNonPersistantDiscoveryResponse(OCServerRequest *request, OCResource *resource,
586 OCPayload *discoveryPayload, OCEntityHandlerResult ehResult)
588 OCEntityHandlerResponse response = {0};
590 response.ehResult = ehResult;
591 response.payload = discoveryPayload;
592 response.persistentBufferFlag = 0;
593 response.requestHandle = (OCRequestHandle) request;
594 response.resourceHandle = (OCResourceHandle) resource;
596 return OCDoResponse(&response);
600 static OCStackResult checkResourceExistsAtRD(const char *interfaceType, const char *resourceType,
601 OCResource **payload, OCDevAddr *devAddr)
603 OCResourceCollectionPayload *repPayload;
606 return OC_STACK_ERROR;
608 if (OCRDCheckPublishedResource(interfaceType, resourceType, &repPayload, devAddr) == OC_STACK_OK)
612 return OC_STACK_ERROR;
614 OCResource *ptr = ((OCResource *) OICCalloc(1, sizeof(OCResource)));
617 return OC_STACK_NO_MEMORY;
620 ptr->uri = OICStrdup(repPayload->setLinks->href);
623 return OC_STACK_NO_MEMORY;
625 OCStringLL *rt = repPayload->setLinks->rt;
628 OCResourceType *temp = (OCResourceType *) OICCalloc(1, sizeof(OCResourceType));
632 return OC_STACK_NO_MEMORY;
635 temp->resourcetypename = OICStrdup(rt->value);
638 ptr->rsrcType = temp;
642 OCResourceType *type = ptr->rsrcType;
652 OCStringLL *itf = repPayload->setLinks->itf;
655 OCResourceInterface *temp = (OCResourceInterface *) OICCalloc(1, sizeof(OCResourceInterface));
660 return OC_STACK_NO_MEMORY;
663 temp->name = OICStrdup(itf->value);
664 if (!ptr->rsrcInterface)
666 ptr->rsrcInterface = temp;
670 OCResourceInterface *type = ptr->rsrcInterface;
680 ptr->resourceProperties = (OCResourceProperty) repPayload->tags->bitmap;
682 OCFreeCollectionResource(repPayload);
688 OIC_LOG_V(ERROR, TAG, "The resource type or interface type doe not exist \
689 on the resource directory");
691 return OC_STACK_ERROR;
695 static OCStackResult HandleVirtualResource (OCServerRequest *request, OCResource* resource)
697 if (!request || !resource)
699 return OC_STACK_INVALID_PARAM;
702 OCStackResult discoveryResult = OC_STACK_ERROR;
704 bool bMulticast = false; // Was the discovery request a multicast request?
705 OCPayload* payload = NULL;
707 OIC_LOG(INFO, TAG, "Entering HandleVirtualResource");
709 OCVirtualResources virtualUriInRequest = GetTypeOfVirtualURI (request->resourceUrl);
711 // Step 1: Generate the response to discovery request
712 if (virtualUriInRequest == OC_WELL_KNOWN_URI)
714 if (request->method == OC_REST_PUT || request->method == OC_REST_POST || request->method == OC_REST_DELETE)
716 OIC_LOG_V(ERROR, TAG, "Resource : %s not permitted for method: %d", request->resourceUrl, request->method);
717 return OC_STACK_UNAUTHORIZED_REQ;
720 char *interfaceQuery = NULL;
721 char *resourceTypeQuery = NULL;
723 discoveryResult = getQueryParamsForFiltering (virtualUriInRequest, request->query,
724 &interfaceQuery, &resourceTypeQuery);
725 bool interfaceQueryAllocated = false;
726 if (!interfaceQuery && !resourceTypeQuery)
728 interfaceQueryAllocated = true;
729 interfaceQuery = OICStrdup(OC_RSRVD_INTERFACE_LL);
732 if (discoveryResult == OC_STACK_OK)
734 payload = (OCPayload *)OCDiscoveryPayloadCreate();
738 OCDiscoveryPayload *discPayload = (OCDiscoveryPayload *)payload;
739 discPayload->sid = (char *)OICCalloc(1, UUID_STRING_SIZE);
740 VERIFY_NON_NULL(discPayload->sid, ERROR, OC_STACK_NO_MEMORY);
742 const char* uid = OCGetServerInstanceIDString();
745 memcpy(discPayload->sid, uid, UUID_STRING_SIZE);
748 if (!resourceTypeQuery && interfaceQuery && (0 == strcmp(interfaceQuery, OC_RSRVD_INTERFACE_LL)))
750 for (; resource && discoveryResult == OC_STACK_OK; resource = resource->next)
753 if (resource->resourceProperties & OC_EXPLICIT_DISCOVERABLE)
755 if (resourceTypeQuery && resourceMatchesRTFilter(resource, resourceTypeQuery))
760 if (resource->resourceProperties & OC_DISCOVERABLE)
767 discoveryResult = BuildVirtualResourceResponse(resource,
768 discPayload, &request->devAddr, false);
774 if ((interfaceQuery && (0 != strcmp(interfaceQuery, OC_RSRVD_INTERFACE_LL))) ||
777 discPayload->uri = OICStrdup(OC_RSRVD_WELL_KNOWN_URI);
778 VERIFY_NON_NULL(discPayload->uri, ERROR, OC_STACK_NO_MEMORY);
779 if (savedDeviceInfo.deviceName)
781 discPayload->name = OICStrdup(savedDeviceInfo.deviceName);
782 VERIFY_NON_NULL(discPayload->name, ERROR, OC_STACK_NO_MEMORY);
784 discPayload->type = OICStrdup(OC_RSRVD_RESOURCE_TYPE_RES);
785 VERIFY_NON_NULL(discPayload->type, ERROR, OC_STACK_NO_MEMORY);
786 OCResourcePayloadAddStringLL(&discPayload->interface, OC_RSRVD_INTERFACE_LL);
787 OCResourcePayloadAddStringLL(&discPayload->interface, OC_RSRVD_INTERFACE_DEFAULT);
788 VERIFY_NON_NULL(discPayload->interface, 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 payload = (OCPayload*) OCDevicePayloadCreate(deviceId, savedDeviceInfo.deviceName,
872 savedDeviceInfo.types, savedDeviceInfo.specVersion, savedDeviceInfo.dataModleVersion);
875 discoveryResult = OC_STACK_NO_MEMORY;
879 discoveryResult = OC_STACK_OK;
883 else if (virtualUriInRequest == OC_PLATFORM_URI)
885 if (request->method == OC_REST_PUT || request->method == OC_REST_POST || request->method == OC_REST_DELETE)
887 OIC_LOG_V(ERROR, TAG, "Resource : %s not permitted for method: %d", request->resourceUrl, request->method);
888 return OC_STACK_UNAUTHORIZED_REQ;
891 payload = (OCPayload*)OCPlatformPayloadCreate(&savedPlatformInfo);
894 discoveryResult = OC_STACK_NO_MEMORY;
898 discoveryResult = OC_STACK_OK;
901 #ifdef ROUTING_GATEWAY
902 else if (OC_GATEWAY_URI == virtualUriInRequest)
904 // Received request for a gateway
905 OIC_LOG(INFO, TAG, "Request is for Gateway Virtual Request");
906 discoveryResult = RMHandleGatewayRequest(request, resource);
912 * Step 2: Send the discovery response
914 * Iotivity should respond to discovery requests in below manner:
915 * 1)If query filter matching fails and discovery request is multicast,
916 * it should NOT send any response.
917 * 2)If query filter matching fails and discovery request is unicast,
918 * it should send an error(RESOURCE_NOT_FOUND - 404) response.
919 * 3)If Server does not have any 'DISCOVERABLE' resources and discovery
920 * request is multicast, it should NOT send any response.
921 * 4)If Server does not have any 'DISCOVERABLE' resources and discovery
922 * request is unicast, it should send an error(RESOURCE_NOT_FOUND - 404) response.
926 if ((virtualUriInRequest == OC_PRESENCE) &&
927 (resource->resourceProperties & OC_ACTIVE))
929 // Presence uses observer notification api to respond via SendPresenceNotification.
930 SendPresenceNotification(resource->rsrcType, OC_PRESENCE_TRIGGER_CHANGE);
934 #ifdef ROUTING_GATEWAY
935 // Gateway uses the RMHandleGatewayRequest to respond to the request.
936 if (OC_GATEWAY_URI != virtualUriInRequest)
939 if(discoveryResult == OC_STACK_OK)
941 SendNonPersistantDiscoveryResponse(request, resource, payload, OC_EH_OK);
943 else if(bMulticast == false && (request->devAddr.adapter != OC_ADAPTER_RFCOMM_BTEDR) &&
944 (request->devAddr.adapter != OC_ADAPTER_GATT_BTLE))
946 OIC_LOG_V(ERROR, TAG, "Sending a (%d) error to (%d) \
947 discovery request", discoveryResult, virtualUriInRequest);
948 SendNonPersistantDiscoveryResponse(request, resource, NULL,
949 (discoveryResult == OC_STACK_NO_RESOURCE) ? OC_EH_RESOURCE_NOT_FOUND : OC_EH_ERROR);
953 // Ignoring the discovery request as per RFC 7252, Section #8.2
954 OIC_LOG(INFO, TAG, "Silently ignoring the request since device does not have \
955 any useful data to send");
959 OCPayloadDestroy(payload);
965 HandleDefaultDeviceEntityHandler (OCServerRequest *request)
969 return OC_STACK_INVALID_PARAM;
972 OCStackResult result = OC_STACK_OK;
973 OCEntityHandlerResult ehResult = OC_EH_ERROR;
974 OCEntityHandlerRequest ehRequest = {0};
976 OIC_LOG(INFO, TAG, "Entering HandleResourceWithDefaultDeviceEntityHandler");
977 result = FormOCEntityHandlerRequest(&ehRequest,
978 (OCRequestHandle) request,
981 (OCResourceHandle) NULL, request->query,
982 PAYLOAD_TYPE_REPRESENTATION,
984 request->payloadSize,
985 request->numRcvdVendorSpecificHeaderOptions,
986 request->rcvdVendorSpecificHeaderOptions,
987 (OCObserveAction)request->observationOption,
989 VERIFY_SUCCESS(result, OC_STACK_OK);
991 // At this point we know for sure that defaultDeviceHandler exists
992 ehResult = defaultDeviceHandler(OC_REQUEST_FLAG, &ehRequest,
993 (char*) request->resourceUrl, defaultDeviceHandlerCallbackParameter);
994 if(ehResult == OC_EH_SLOW)
996 OIC_LOG(INFO, TAG, "This is a slow resource");
997 request->slowFlag = 1;
999 else if(ehResult == OC_EH_ERROR)
1001 FindAndDeleteServerRequest(request);
1003 result = EntityHandlerCodeToOCStackCode(ehResult);
1005 OCPayloadDestroy(ehRequest.payload);
1009 static OCStackResult
1010 HandleResourceWithEntityHandler (OCServerRequest *request,
1011 OCResource *resource,
1012 uint8_t collectionResource)
1014 if(!request || ! resource)
1016 return OC_STACK_INVALID_PARAM;
1019 OCStackResult result = OC_STACK_ERROR;
1020 OCEntityHandlerResult ehResult = OC_EH_ERROR;
1021 OCEntityHandlerFlag ehFlag = OC_REQUEST_FLAG;
1022 ResourceObserver *resObs = NULL;
1024 OCEntityHandlerRequest ehRequest = {0};
1026 OIC_LOG(INFO, TAG, "Entering HandleResourceWithEntityHandler");
1027 OCPayloadType type = PAYLOAD_TYPE_REPRESENTATION;
1028 // check the security resource
1029 if (request && request->resourceUrl && SRMIsSecurityResourceURI(request->resourceUrl))
1031 type = PAYLOAD_TYPE_SECURITY;
1035 if (request && strcmp(request->resourceUrl, OC_RSRVD_RD_URI) == 0)
1037 type = PAYLOAD_TYPE_RD;
1040 result = FormOCEntityHandlerRequest(&ehRequest,
1041 (OCRequestHandle)request,
1044 (OCResourceHandle)resource,
1048 request->payloadSize,
1049 request->numRcvdVendorSpecificHeaderOptions,
1050 request->rcvdVendorSpecificHeaderOptions,
1051 (OCObserveAction)request->observationOption,
1053 VERIFY_SUCCESS(result, OC_STACK_OK);
1055 if(ehRequest.obsInfo.action == OC_OBSERVE_NO_OPTION)
1057 OIC_LOG(INFO, TAG, "No observation requested");
1058 ehFlag = OC_REQUEST_FLAG;
1060 else if(ehRequest.obsInfo.action == OC_OBSERVE_REGISTER && !collectionResource)
1062 OIC_LOG(INFO, TAG, "Observation registration requested");
1064 ResourceObserver *obs = GetObserverUsingToken (request->requestToken,
1065 request->tokenLength);
1069 OIC_LOG (INFO, TAG, "Observer with this token already present");
1070 OIC_LOG (INFO, TAG, "Possibly re-transmitted CON OBS request");
1071 OIC_LOG (INFO, TAG, "Not adding observer. Not responding to client");
1072 OIC_LOG (INFO, TAG, "The first request for this token is already ACKED.");
1074 // server requests are usually free'd when the response is sent out
1075 // for the request in ocserverrequest.c : HandleSingleResponse()
1076 // Since we are making an early return and not responding, the server request
1077 // needs to be deleted.
1078 FindAndDeleteServerRequest (request);
1082 result = GenerateObserverId(&ehRequest.obsInfo.obsId);
1083 VERIFY_SUCCESS(result, OC_STACK_OK);
1085 result = AddObserver ((const char*)(request->resourceUrl),
1086 (const char *)(request->query),
1087 ehRequest.obsInfo.obsId, request->requestToken, request->tokenLength,
1088 resource, request->qos, request->acceptFormat,
1091 if(result == OC_STACK_OK)
1093 OIC_LOG(INFO, TAG, "Added observer successfully");
1094 request->observeResult = OC_STACK_OK;
1095 ehFlag = (OCEntityHandlerFlag)(OC_REQUEST_FLAG | OC_OBSERVE_FLAG);
1099 // The error in observeResult for the request will be used when responding to this
1100 // request by omitting the observation option/sequence number.
1101 request->observeResult = OC_STACK_ERROR;
1102 OIC_LOG(ERROR, TAG, "Observer Addition failed");
1103 ehFlag = OC_REQUEST_FLAG;
1104 FindAndDeleteServerRequest(request);
1109 else if(ehRequest.obsInfo.action == OC_OBSERVE_DEREGISTER &&
1110 !collectionResource)
1112 OIC_LOG(INFO, TAG, "Deregistering observation requested");
1114 resObs = GetObserverUsingToken (request->requestToken, request->tokenLength);
1118 // Stack does not contain this observation request
1119 // Either token is incorrect or observation list is corrupted
1120 result = OC_STACK_ERROR;
1123 ehRequest.obsInfo.obsId = resObs->observeId;
1124 ehFlag = (OCEntityHandlerFlag)(ehFlag | OC_OBSERVE_FLAG);
1126 result = DeleteObserverUsingToken (request->requestToken, request->tokenLength);
1128 if(result == OC_STACK_OK)
1130 OIC_LOG(INFO, TAG, "Removed observer successfully");
1131 request->observeResult = OC_STACK_OK;
1135 request->observeResult = OC_STACK_ERROR;
1136 OIC_LOG(ERROR, TAG, "Observer Removal failed");
1137 FindAndDeleteServerRequest(request);
1143 result = OC_STACK_ERROR;
1147 ehResult = resource->entityHandler(ehFlag, &ehRequest, resource->entityHandlerCallbackParam);
1148 if(ehResult == OC_EH_SLOW)
1150 OIC_LOG(INFO, TAG, "This is a slow resource");
1151 request->slowFlag = 1;
1153 else if(ehResult == OC_EH_ERROR)
1155 FindAndDeleteServerRequest(request);
1157 result = EntityHandlerCodeToOCStackCode(ehResult);
1159 OCPayloadDestroy(ehRequest.payload);
1163 static OCStackResult
1164 HandleCollectionResourceDefaultEntityHandler (OCServerRequest *request,
1165 OCResource *resource)
1167 if(!request || !resource)
1169 return OC_STACK_INVALID_PARAM;
1172 OCStackResult result = OC_STACK_ERROR;
1173 OCEntityHandlerRequest ehRequest = {0};
1175 result = FormOCEntityHandlerRequest(&ehRequest,
1176 (OCRequestHandle)request,
1179 (OCResourceHandle)resource,
1181 PAYLOAD_TYPE_REPRESENTATION,
1183 request->payloadSize,
1184 request->numRcvdVendorSpecificHeaderOptions,
1185 request->rcvdVendorSpecificHeaderOptions,
1186 (OCObserveAction)request->observationOption,
1187 (OCObservationId)0);
1188 if(result == OC_STACK_OK)
1190 result = DefaultCollectionEntityHandler (OC_REQUEST_FLAG, &ehRequest);
1193 OCPayloadDestroy(ehRequest.payload);
1198 ProcessRequest(ResourceHandling resHandling, OCResource *resource, OCServerRequest *request)
1200 OCStackResult ret = OC_STACK_OK;
1202 switch (resHandling)
1204 case OC_RESOURCE_VIRTUAL:
1206 ret = HandleVirtualResource (request, resource);
1209 case OC_RESOURCE_DEFAULT_DEVICE_ENTITYHANDLER:
1211 ret = HandleDefaultDeviceEntityHandler(request);
1214 case OC_RESOURCE_NOT_COLLECTION_DEFAULT_ENTITYHANDLER:
1216 OIC_LOG(INFO, TAG, "OC_RESOURCE_NOT_COLLECTION_DEFAULT_ENTITYHANDLER");
1217 return OC_STACK_ERROR;
1219 case OC_RESOURCE_NOT_COLLECTION_WITH_ENTITYHANDLER:
1221 ret = HandleResourceWithEntityHandler (request, resource, 0);
1224 case OC_RESOURCE_COLLECTION_WITH_ENTITYHANDLER:
1226 ret = HandleResourceWithEntityHandler (request, resource, 1);
1229 case OC_RESOURCE_COLLECTION_DEFAULT_ENTITYHANDLER:
1231 ret = HandleCollectionResourceDefaultEntityHandler (request, resource);
1234 case OC_RESOURCE_NOT_SPECIFIED:
1236 ret = OC_STACK_NO_RESOURCE;
1241 OIC_LOG(INFO, TAG, "Invalid Resource Determination");
1242 return OC_STACK_ERROR;
1248 void DeletePlatformInfo()
1250 OIC_LOG(INFO, TAG, "Deleting platform info.");
1252 OICFree(savedPlatformInfo.platformID);
1253 savedPlatformInfo.platformID = NULL;
1255 OICFree(savedPlatformInfo.manufacturerName);
1256 savedPlatformInfo.manufacturerName = NULL;
1258 OICFree(savedPlatformInfo.manufacturerUrl);
1259 savedPlatformInfo.manufacturerUrl = NULL;
1261 OICFree(savedPlatformInfo.modelNumber);
1262 savedPlatformInfo.modelNumber = NULL;
1264 OICFree(savedPlatformInfo.dateOfManufacture);
1265 savedPlatformInfo.dateOfManufacture = NULL;
1267 OICFree(savedPlatformInfo.platformVersion);
1268 savedPlatformInfo.platformVersion = NULL;
1270 OICFree(savedPlatformInfo.operatingSystemVersion);
1271 savedPlatformInfo.operatingSystemVersion = NULL;
1273 OICFree(savedPlatformInfo.hardwareVersion);
1274 savedPlatformInfo.hardwareVersion = NULL;
1276 OICFree(savedPlatformInfo.firmwareVersion);
1277 savedPlatformInfo.firmwareVersion = NULL;
1279 OICFree(savedPlatformInfo.supportUrl);
1280 savedPlatformInfo.supportUrl = NULL;
1282 OICFree(savedPlatformInfo.systemTime);
1283 savedPlatformInfo.systemTime = NULL;
1286 static OCStackResult DeepCopyPlatFormInfo(OCPlatformInfo info)
1288 savedPlatformInfo.platformID = OICStrdup(info.platformID);
1289 savedPlatformInfo.manufacturerName = OICStrdup(info.manufacturerName);
1290 savedPlatformInfo.manufacturerUrl = OICStrdup(info.manufacturerUrl);
1291 savedPlatformInfo.modelNumber = OICStrdup(info.modelNumber);
1292 savedPlatformInfo.dateOfManufacture = OICStrdup(info.dateOfManufacture);
1293 savedPlatformInfo.platformVersion = OICStrdup(info.platformVersion);
1294 savedPlatformInfo.operatingSystemVersion = OICStrdup(info.operatingSystemVersion);
1295 savedPlatformInfo.hardwareVersion = OICStrdup(info.hardwareVersion);
1296 savedPlatformInfo.firmwareVersion = OICStrdup(info.firmwareVersion);
1297 savedPlatformInfo.supportUrl = OICStrdup(info.supportUrl);
1298 savedPlatformInfo.systemTime = OICStrdup(info.systemTime);
1300 if ((!savedPlatformInfo.platformID && info.platformID)||
1301 (!savedPlatformInfo.manufacturerName && info.manufacturerName)||
1302 (!savedPlatformInfo.manufacturerUrl && info.manufacturerUrl)||
1303 (!savedPlatformInfo.modelNumber && info.modelNumber)||
1304 (!savedPlatformInfo.dateOfManufacture && info.dateOfManufacture)||
1305 (!savedPlatformInfo.platformVersion && info.platformVersion)||
1306 (!savedPlatformInfo.operatingSystemVersion && info.operatingSystemVersion)||
1307 (!savedPlatformInfo.hardwareVersion && info.hardwareVersion)||
1308 (!savedPlatformInfo.firmwareVersion && info.firmwareVersion)||
1309 (!savedPlatformInfo.supportUrl && info.supportUrl)||
1310 (!savedPlatformInfo.systemTime && info.systemTime))
1312 DeletePlatformInfo();
1313 return OC_STACK_INVALID_PARAM;
1320 OCStackResult SavePlatformInfo(OCPlatformInfo info)
1322 DeletePlatformInfo();
1324 OCStackResult res = DeepCopyPlatFormInfo(info);
1326 if (res != OC_STACK_OK)
1328 OIC_LOG_V(ERROR, TAG, "Failed to save platform info. errno(%d)", res);
1332 OIC_LOG(INFO, TAG, "Platform info saved.");
1338 void DeleteDeviceInfo()
1340 OIC_LOG(INFO, TAG, "Deleting device info.");
1342 OICFree(savedDeviceInfo.deviceName);
1343 OCFreeOCStringLL(savedDeviceInfo.types);
1344 OICFree(savedDeviceInfo.specVersion);
1345 OICFree(savedDeviceInfo.dataModleVersion);
1346 savedDeviceInfo.deviceName = NULL;
1347 savedDeviceInfo.specVersion = NULL;
1348 savedDeviceInfo.dataModleVersion = NULL;
1351 static OCStackResult DeepCopyDeviceInfo(OCDeviceInfo info)
1353 savedDeviceInfo.deviceName = OICStrdup(info.deviceName);
1355 if(!savedDeviceInfo.deviceName && info.deviceName)
1358 return OC_STACK_NO_MEMORY;
1363 savedDeviceInfo.types = CloneOCStringLL(info.types);
1364 if(!savedDeviceInfo.types && info.types)
1367 return OC_STACK_NO_MEMORY;
1371 if (info.specVersion)
1373 savedDeviceInfo.specVersion = OICStrdup(info.specVersion);
1374 if(!savedDeviceInfo.specVersion && info.specVersion)
1377 return OC_STACK_NO_MEMORY;
1382 savedDeviceInfo.specVersion = OICStrdup(OC_SPEC_VERSION);
1383 if(!savedDeviceInfo.specVersion && OC_SPEC_VERSION)
1386 return OC_STACK_NO_MEMORY;
1390 if (info.dataModleVersion)
1392 savedDeviceInfo.dataModleVersion = OICStrdup(info.dataModleVersion);
1393 if(!savedDeviceInfo.dataModleVersion && info.dataModleVersion)
1396 return OC_STACK_NO_MEMORY;
1401 savedDeviceInfo.dataModleVersion = OICStrdup(OC_DATA_MODEL_VERSION);
1402 if(!savedDeviceInfo.dataModleVersion && OC_DATA_MODEL_VERSION)
1405 return OC_STACK_NO_MEMORY;
1412 OCStackResult SaveDeviceInfo(OCDeviceInfo info)
1414 OCStackResult res = OC_STACK_OK;
1418 res = DeepCopyDeviceInfo(info);
1420 VERIFY_SUCCESS(res, OC_STACK_OK);
1422 if (OCGetServerInstanceIDString() == NULL)
1424 OIC_LOG(INFO, TAG, "Device ID generation failed");
1425 res = OC_STACK_ERROR;
1429 OIC_LOG(INFO, TAG, "Device initialized successfully.");