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 if (strnlen(query, MAX_QUERY_LENGTH) >= MAX_QUERY_LENGTH)
159 OIC_LOG(ERROR, TAG, "Query exceeds maximum length.");
160 return OC_STACK_INVALID_QUERY;
163 char *keyValuePair = strtok_r (query, OC_QUERY_SEPARATOR, &restOfQuery);
167 if (numKeyValuePairsParsed >= 2)
169 OIC_LOG(ERROR, TAG, "More than 2 queries params in URI.");
170 return OC_STACK_INVALID_QUERY;
173 key = strtok_r(keyValuePair, OC_KEY_VALUE_DELIMITER, &value);
177 return OC_STACK_INVALID_QUERY;
179 else if (strncasecmp(key, OC_RSRVD_INTERFACE, sizeof(OC_RSRVD_INTERFACE) - 1) == 0)
181 *filterOne = value; // if
183 else if (strncasecmp(key, OC_RSRVD_RESOURCE_TYPE, sizeof(OC_RSRVD_INTERFACE) - 1) == 0)
185 *filterTwo = value; // rt
189 OIC_LOG_V(ERROR, TAG, "Unsupported query key: %s", key);
190 return OC_STACK_INVALID_QUERY;
192 ++numKeyValuePairsParsed;
194 keyValuePair = strtok_r(NULL, OC_QUERY_SEPARATOR, &restOfQuery);
197 OIC_LOG_V(INFO, TAG, "Extracted params if: %s and rt: %s.", *filterOne, *filterTwo);
201 static OCVirtualResources GetTypeOfVirtualURI(const char *uriInRequest)
203 if (strcmp(uriInRequest, OC_RSRVD_WELL_KNOWN_URI) == 0)
205 return OC_WELL_KNOWN_URI;
207 else if (strcmp(uriInRequest, OC_RSRVD_DEVICE_URI) == 0)
209 return OC_DEVICE_URI;
211 else if (strcmp(uriInRequest, OC_RSRVD_PLATFORM_URI) == 0)
213 return OC_PLATFORM_URI;
215 else if (strcmp(uriInRequest, OC_RSRVD_RESOURCE_TYPES_URI) == 0)
217 return OC_RESOURCE_TYPES_URI;
219 #ifdef ROUTING_GATEWAY
220 else if (0 == strcmp(uriInRequest, OC_RSRVD_GATEWAY_URI))
222 return OC_GATEWAY_URI;
226 else if (strcmp(uriInRequest, OC_RSRVD_PRESENCE_URI) == 0)
230 #endif //WITH_PRESENCE
231 return OC_UNKNOWN_URI;
234 static OCStackResult getQueryParamsForFiltering (OCVirtualResources uri, char *query,
235 char **filterOne, char **filterTwo)
237 if(!filterOne || !filterTwo)
239 return OC_STACK_INVALID_PARAM;
246 if (uri == OC_PRESENCE)
248 //Nothing needs to be done, except for pass a OC_PRESENCE query through as OC_STACK_OK.
249 OIC_LOG(INFO, TAG, "OC_PRESENCE Request for virtual resource.");
254 OCStackResult result = OC_STACK_OK;
258 result = ExtractFiltersFromQuery(query, filterOne, filterTwo);
264 OCStackResult BuildResponseRepresentation(const OCResource *resourcePtr,
265 OCRepPayload** payload)
267 OCRepPayload *tempPayload = OCRepPayloadCreate();
271 OCRepPayloadDestroy(tempPayload);
272 return OC_STACK_INVALID_PARAM;
277 return OC_STACK_NO_MEMORY;
280 OCRepPayloadSetUri(tempPayload, resourcePtr->uri);
282 OCResourceType *resType = resourcePtr->rsrcType;
285 OCRepPayloadAddResourceType(tempPayload, resType->resourcetypename);
286 resType = resType->next;
289 OCResourceInterface *resInterface = resourcePtr->rsrcInterface;
292 OCRepPayloadAddInterface(tempPayload, resInterface->name);
293 resInterface = resInterface->next;
296 OCAttribute *resAttrib = resourcePtr->rsrcAttributes;
299 OCRepPayloadSetPropString(tempPayload, resAttrib->attrName,
300 resAttrib->attrValue);
301 resAttrib = resAttrib->next;
306 *payload = tempPayload;
310 OCRepPayloadAppend(*payload, tempPayload);
316 OCStackResult BuildVirtualResourceResponse(const OCResource *resourcePtr,
317 OCDiscoveryPayload *payload, OCDevAddr *devAddr, bool rdResponse)
319 if (!resourcePtr || !payload)
321 return OC_STACK_INVALID_PARAM;
323 uint16_t securePort = 0;
324 if (resourcePtr->resourceProperties & OC_SECURE)
326 if (GetSecurePortInfo(devAddr, &securePort) != OC_STACK_OK)
334 securePort = devAddr->port;
337 uint16_t tcpPort = 0;
339 if (GetTCPPortInfo(devAddr, &tcpPort) != OC_STACK_OK)
345 OCDiscoveryPayloadAddResource(payload, resourcePtr, securePort, tcpPort);
349 uint8_t IsCollectionResource (OCResource *resource)
356 if(resource->rsrcChildResourcesHead != NULL)
364 OCResource *FindResourceByUri(const char* resourceUri)
371 OCResource * pointer = headResource;
374 if (strcmp(resourceUri, pointer->uri) == 0)
378 pointer = pointer->next;
380 OIC_LOG_V(INFO, TAG, "Resource %s not found", resourceUri);
385 OCStackResult DetermineResourceHandling (const OCServerRequest *request,
386 ResourceHandling *handling,
387 OCResource **resource)
389 if(!request || !handling || !resource)
391 return OC_STACK_INVALID_PARAM;
394 OIC_LOG_V(INFO, TAG, "DetermineResourceHandling for %s", request->resourceUrl);
396 // Check if virtual resource
397 if (GetTypeOfVirtualURI(request->resourceUrl) != OC_UNKNOWN_URI)
399 OIC_LOG_V (INFO, TAG, "%s is virtual", request->resourceUrl);
400 *handling = OC_RESOURCE_VIRTUAL;
401 *resource = headResource;
404 if (strlen((const char*)(request->resourceUrl)) == 0)
406 // Resource URL not specified
407 *handling = OC_RESOURCE_NOT_SPECIFIED;
408 return OC_STACK_NO_RESOURCE;
412 OCResource *resourcePtr = FindResourceByUri((const char*)request->resourceUrl);
413 *resource = resourcePtr;
416 if(defaultDeviceHandler)
418 *handling = OC_RESOURCE_DEFAULT_DEVICE_ENTITYHANDLER;
422 // Resource does not exist
423 // and default device handler does not exist
424 *handling = OC_RESOURCE_NOT_SPECIFIED;
425 return OC_STACK_NO_RESOURCE;
428 if (IsCollectionResource (resourcePtr))
430 // Collection resource
431 if (resourcePtr->entityHandler != defaultResourceEHandler)
433 *handling = OC_RESOURCE_COLLECTION_WITH_ENTITYHANDLER;
438 *handling = OC_RESOURCE_COLLECTION_DEFAULT_ENTITYHANDLER;
444 // Resource not a collection
445 if (resourcePtr->entityHandler != defaultResourceEHandler)
447 *handling = OC_RESOURCE_NOT_COLLECTION_WITH_ENTITYHANDLER;
452 *handling = OC_RESOURCE_NOT_COLLECTION_DEFAULT_ENTITYHANDLER;
459 OCStackResult EntityHandlerCodeToOCStackCode(OCEntityHandlerResult ehResult)
461 OCStackResult result;
466 result = OC_STACK_OK;
469 result = OC_STACK_SLOW_RESOURCE;
472 result = OC_STACK_ERROR;
474 case OC_EH_FORBIDDEN:
475 result = OC_STACK_RESOURCE_ERROR;
477 case OC_EH_RESOURCE_CREATED:
478 result = OC_STACK_RESOURCE_CREATED;
480 case OC_EH_RESOURCE_DELETED:
481 result = OC_STACK_RESOURCE_DELETED;
484 result = OC_STACK_RESOURCE_CHANGED;
486 case OC_EH_RESOURCE_NOT_FOUND:
487 result = OC_STACK_NO_RESOURCE;
490 result = OC_STACK_ERROR;
496 static bool resourceMatchesRTFilter(OCResource *resource, char *resourceTypeFilter)
503 // Null or empty is analogous to no filter.
504 if (resourceTypeFilter == NULL || *resourceTypeFilter == 0)
509 OCResourceType *resourceTypePtr = resource->rsrcType;
511 while (resourceTypePtr)
513 if (strcmp (resourceTypePtr->resourcetypename, resourceTypeFilter) == 0)
517 resourceTypePtr = resourceTypePtr->next;
520 OIC_LOG_V(INFO, TAG, "%s does not contain rt=%s.", resource->uri, resourceTypeFilter);
524 static bool resourceMatchesIFFilter(OCResource *resource, char *interfaceFilter)
531 // Null or empty is analogous to no filter.
532 if (interfaceFilter == NULL || *interfaceFilter == 0)
537 OCResourceInterface *interfacePtr = resource->rsrcInterface;
541 if ((strcmp (interfacePtr->name, interfaceFilter) == 0) &&
542 (strcmp (OC_RSRVD_INTERFACE_LL, interfaceFilter) == 0 ||
543 strcmp (OC_RSRVD_INTERFACE_DEFAULT, interfaceFilter) == 0))
547 interfacePtr = interfacePtr->next;
550 OIC_LOG_V(INFO, TAG, "%s does not contain if=%s.", resource->uri, interfaceFilter);
555 * If the filters are null, they will be assumed to NOT be present
556 * and the resource will not be matched against them.
557 * Function will return true if all non null AND non empty filters passed in find a match.
559 static bool includeThisResourceInResponse(OCResource *resource,
560 char *interfaceFilter,
561 char *resourceTypeFilter)
565 OIC_LOG(ERROR, TAG, "Invalid resource");
569 if (resource->resourceProperties & OC_EXPLICIT_DISCOVERABLE)
572 * At least one valid filter should be available to
573 * include the resource in discovery response
575 if (!(resourceTypeFilter && *resourceTypeFilter))
577 OIC_LOG_V(INFO, TAG, "%s no query string for EXPLICIT_DISCOVERABLE \
578 resource", resource->uri);
582 else if ( !(resource->resourceProperties & OC_ACTIVE) ||
583 !(resource->resourceProperties & OC_DISCOVERABLE))
585 OIC_LOG_V(INFO, TAG, "%s not ACTIVE or DISCOVERABLE", resource->uri);
589 return resourceMatchesIFFilter(resource, interfaceFilter) &&
590 resourceMatchesRTFilter(resource, resourceTypeFilter);
594 OCStackResult SendNonPersistantDiscoveryResponse(OCServerRequest *request, OCResource *resource,
595 OCPayload *discoveryPayload, OCEntityHandlerResult ehResult)
597 OCEntityHandlerResponse response = {0};
599 response.ehResult = ehResult;
600 response.payload = discoveryPayload;
601 response.persistentBufferFlag = 0;
602 response.requestHandle = (OCRequestHandle) request;
603 response.resourceHandle = (OCResourceHandle) resource;
605 return OCDoResponse(&response);
609 static OCStackResult checkResourceExistsAtRD(const char *interfaceType, const char *resourceType,
610 OCResource **payload, OCDevAddr *devAddr)
612 OCResourceCollectionPayload *repPayload;
615 return OC_STACK_ERROR;
617 if (OCRDCheckPublishedResource(interfaceType, resourceType, &repPayload, devAddr) == OC_STACK_OK)
621 return OC_STACK_ERROR;
623 OCResource *ptr = ((OCResource *) OICCalloc(1, sizeof(OCResource)));
626 return OC_STACK_NO_MEMORY;
629 ptr->uri = OICStrdup(repPayload->setLinks->href);
632 return OC_STACK_NO_MEMORY;
634 OCStringLL *rt = repPayload->setLinks->rt;
637 OCResourceType *temp = (OCResourceType *) OICCalloc(1, sizeof(OCResourceType));
641 return OC_STACK_NO_MEMORY;
644 temp->resourcetypename = OICStrdup(rt->value);
647 ptr->rsrcType = temp;
651 OCResourceType *type = ptr->rsrcType;
661 OCStringLL *itf = repPayload->setLinks->itf;
664 OCResourceInterface *temp = (OCResourceInterface *) OICCalloc(1, sizeof(OCResourceInterface));
669 return OC_STACK_NO_MEMORY;
672 temp->name = OICStrdup(itf->value);
673 if (!ptr->rsrcInterface)
675 ptr->rsrcInterface = temp;
679 OCResourceInterface *type = ptr->rsrcInterface;
689 ptr->resourceProperties = (OCResourceProperty) repPayload->tags->bitmap;
691 OCFreeCollectionResource(repPayload);
697 OIC_LOG_V(ERROR, TAG, "The resource type or interface type doe not exist \
698 on the resource directory");
700 return OC_STACK_ERROR;
704 static OCStackResult HandleVirtualResource (OCServerRequest *request, OCResource* resource)
706 if (!request || !resource)
708 return OC_STACK_INVALID_PARAM;
711 OCStackResult discoveryResult = OC_STACK_ERROR;
712 OCPayload* payload = NULL;
714 OIC_LOG(INFO, TAG, "Entering HandleVirtualResource");
716 OCVirtualResources virtualUriInRequest = GetTypeOfVirtualURI (request->resourceUrl);
718 // Step 1: Generate the response to discovery request
719 if (virtualUriInRequest == OC_WELL_KNOWN_URI)
721 if (request->method == OC_REST_PUT || request->method == OC_REST_POST || request->method == OC_REST_DELETE)
723 OIC_LOG_V(ERROR, TAG, "Resource : %s not permitted for method: %d", request->resourceUrl, request->method);
724 return OC_STACK_UNAUTHORIZED_REQ;
727 char *interfaceQuery = NULL;
728 char *resourceTypeQuery = NULL;
730 discoveryResult = getQueryParamsForFiltering (virtualUriInRequest, request->query,
731 &interfaceQuery, &resourceTypeQuery);
732 bool interfaceQueryAllocated = false;
733 if (!interfaceQuery && !resourceTypeQuery)
735 interfaceQueryAllocated = true;
736 interfaceQuery = OICStrdup(OC_RSRVD_INTERFACE_LL);
739 if (discoveryResult == OC_STACK_OK)
741 payload = (OCPayload *)OCDiscoveryPayloadCreate();
745 OCDiscoveryPayload *discPayload = (OCDiscoveryPayload *)payload;
746 discPayload->sid = (char *)OICCalloc(1, UUID_STRING_SIZE);
747 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->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 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 result = OC_STACK_OK;
1112 // The error in observeResult for the request will be used when responding to this
1113 // request by omitting the observation option/sequence number.
1114 request->observeResult = OC_STACK_ERROR;
1115 OIC_LOG(ERROR, TAG, "Observer Addition failed");
1116 ehFlag = OC_REQUEST_FLAG;
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;
1143 // There should be no observe option header for de-registration response.
1144 // Set as an invalid value here so we can detect it later and remove the field in response.
1145 request->observationOption = MAX_SEQUENCE_NUMBER + 1;
1149 result = OC_STACK_OK;
1150 request->observeResult = OC_STACK_ERROR;
1151 OIC_LOG(ERROR, TAG, "Observer Removal failed");
1156 result = OC_STACK_ERROR;
1160 ehResult = resource->entityHandler(ehFlag, &ehRequest, resource->entityHandlerCallbackParam);
1161 if(ehResult == OC_EH_SLOW)
1163 OIC_LOG(INFO, TAG, "This is a slow resource");
1164 request->slowFlag = 1;
1166 else if(ehResult == OC_EH_ERROR)
1168 FindAndDeleteServerRequest(request);
1170 result = EntityHandlerCodeToOCStackCode(ehResult);
1172 OCPayloadDestroy(ehRequest.payload);
1176 static OCStackResult
1177 HandleCollectionResourceDefaultEntityHandler (OCServerRequest *request,
1178 OCResource *resource)
1180 if(!request || !resource)
1182 return OC_STACK_INVALID_PARAM;
1185 OCStackResult result = OC_STACK_ERROR;
1186 OCEntityHandlerRequest ehRequest = {0};
1188 result = FormOCEntityHandlerRequest(&ehRequest,
1189 (OCRequestHandle)request,
1192 (OCResourceHandle)resource,
1194 PAYLOAD_TYPE_REPRESENTATION,
1196 request->payloadSize,
1197 request->numRcvdVendorSpecificHeaderOptions,
1198 request->rcvdVendorSpecificHeaderOptions,
1199 (OCObserveAction)request->observationOption,
1202 if(result == OC_STACK_OK)
1204 result = DefaultCollectionEntityHandler (OC_REQUEST_FLAG, &ehRequest);
1207 OCPayloadDestroy(ehRequest.payload);
1212 ProcessRequest(ResourceHandling resHandling, OCResource *resource, OCServerRequest *request)
1214 OCStackResult ret = OC_STACK_OK;
1216 switch (resHandling)
1218 case OC_RESOURCE_VIRTUAL:
1220 ret = HandleVirtualResource (request, resource);
1223 case OC_RESOURCE_DEFAULT_DEVICE_ENTITYHANDLER:
1225 ret = HandleDefaultDeviceEntityHandler(request);
1228 case OC_RESOURCE_NOT_COLLECTION_DEFAULT_ENTITYHANDLER:
1230 OIC_LOG(INFO, TAG, "OC_RESOURCE_NOT_COLLECTION_DEFAULT_ENTITYHANDLER");
1231 return OC_STACK_ERROR;
1233 case OC_RESOURCE_NOT_COLLECTION_WITH_ENTITYHANDLER:
1235 ret = HandleResourceWithEntityHandler (request, resource, 0);
1238 case OC_RESOURCE_COLLECTION_WITH_ENTITYHANDLER:
1240 ret = HandleResourceWithEntityHandler (request, resource, 1);
1243 case OC_RESOURCE_COLLECTION_DEFAULT_ENTITYHANDLER:
1245 ret = HandleCollectionResourceDefaultEntityHandler (request, resource);
1248 case OC_RESOURCE_NOT_SPECIFIED:
1250 ret = OC_STACK_NO_RESOURCE;
1255 OIC_LOG(INFO, TAG, "Invalid Resource Determination");
1256 return OC_STACK_ERROR;
1262 void DeletePlatformInfo()
1264 OIC_LOG(INFO, TAG, "Deleting platform info.");
1266 OICFree(savedPlatformInfo.platformID);
1267 savedPlatformInfo.platformID = NULL;
1269 OICFree(savedPlatformInfo.manufacturerName);
1270 savedPlatformInfo.manufacturerName = NULL;
1272 OICFree(savedPlatformInfo.manufacturerUrl);
1273 savedPlatformInfo.manufacturerUrl = NULL;
1275 OICFree(savedPlatformInfo.modelNumber);
1276 savedPlatformInfo.modelNumber = NULL;
1278 OICFree(savedPlatformInfo.dateOfManufacture);
1279 savedPlatformInfo.dateOfManufacture = NULL;
1281 OICFree(savedPlatformInfo.platformVersion);
1282 savedPlatformInfo.platformVersion = NULL;
1284 OICFree(savedPlatformInfo.operatingSystemVersion);
1285 savedPlatformInfo.operatingSystemVersion = NULL;
1287 OICFree(savedPlatformInfo.hardwareVersion);
1288 savedPlatformInfo.hardwareVersion = NULL;
1290 OICFree(savedPlatformInfo.firmwareVersion);
1291 savedPlatformInfo.firmwareVersion = NULL;
1293 OICFree(savedPlatformInfo.supportUrl);
1294 savedPlatformInfo.supportUrl = NULL;
1296 OICFree(savedPlatformInfo.systemTime);
1297 savedPlatformInfo.systemTime = NULL;
1300 static OCStackResult DeepCopyPlatFormInfo(OCPlatformInfo info)
1302 savedPlatformInfo.platformID = OICStrdup(info.platformID);
1303 savedPlatformInfo.manufacturerName = OICStrdup(info.manufacturerName);
1304 savedPlatformInfo.manufacturerUrl = OICStrdup(info.manufacturerUrl);
1305 savedPlatformInfo.modelNumber = OICStrdup(info.modelNumber);
1306 savedPlatformInfo.dateOfManufacture = OICStrdup(info.dateOfManufacture);
1307 savedPlatformInfo.platformVersion = OICStrdup(info.platformVersion);
1308 savedPlatformInfo.operatingSystemVersion = OICStrdup(info.operatingSystemVersion);
1309 savedPlatformInfo.hardwareVersion = OICStrdup(info.hardwareVersion);
1310 savedPlatformInfo.firmwareVersion = OICStrdup(info.firmwareVersion);
1311 savedPlatformInfo.supportUrl = OICStrdup(info.supportUrl);
1312 savedPlatformInfo.systemTime = OICStrdup(info.systemTime);
1314 if ((!savedPlatformInfo.platformID && info.platformID)||
1315 (!savedPlatformInfo.manufacturerName && info.manufacturerName)||
1316 (!savedPlatformInfo.manufacturerUrl && info.manufacturerUrl)||
1317 (!savedPlatformInfo.modelNumber && info.modelNumber)||
1318 (!savedPlatformInfo.dateOfManufacture && info.dateOfManufacture)||
1319 (!savedPlatformInfo.platformVersion && info.platformVersion)||
1320 (!savedPlatformInfo.operatingSystemVersion && info.operatingSystemVersion)||
1321 (!savedPlatformInfo.hardwareVersion && info.hardwareVersion)||
1322 (!savedPlatformInfo.firmwareVersion && info.firmwareVersion)||
1323 (!savedPlatformInfo.supportUrl && info.supportUrl)||
1324 (!savedPlatformInfo.systemTime && info.systemTime))
1326 DeletePlatformInfo();
1327 return OC_STACK_INVALID_PARAM;
1334 OCStackResult SavePlatformInfo(OCPlatformInfo info)
1336 DeletePlatformInfo();
1338 OCStackResult res = DeepCopyPlatFormInfo(info);
1340 if (res != OC_STACK_OK)
1342 OIC_LOG_V(ERROR, TAG, "Failed to save platform info. errno(%d)", res);
1346 OIC_LOG(INFO, TAG, "Platform info saved.");
1352 void DeleteDeviceInfo()
1354 OIC_LOG(INFO, TAG, "Deleting device info.");
1356 OICFree(savedDeviceInfo.deviceName);
1357 OCFreeOCStringLL(savedDeviceInfo.types);
1358 OICFree(savedDeviceInfo.specVersion);
1359 OCFreeOCStringLL(savedDeviceInfo.dataModelVersions);
1360 savedDeviceInfo.deviceName = NULL;
1361 savedDeviceInfo.specVersion = NULL;
1362 savedDeviceInfo.dataModelVersions = NULL;
1365 static OCStackResult DeepCopyDeviceInfo(OCDeviceInfo info)
1367 savedDeviceInfo.deviceName = OICStrdup(info.deviceName);
1369 if(!savedDeviceInfo.deviceName && info.deviceName)
1372 return OC_STACK_NO_MEMORY;
1377 savedDeviceInfo.types = CloneOCStringLL(info.types);
1378 OCStringLL *type = info.types;
1382 if (type && type->value && 0 == strcmp(type->value, OC_RSRVD_RESOURCE_TYPE_DEVICE))
1390 // Append the oic.wk.d at the start of rt link parameter value.
1391 OCStringLL *dest = (OCStringLL*)OICCalloc (1, sizeof (OCStringLL));
1395 return OC_STACK_NO_MEMORY;
1397 dest->value = OICStrdup (OC_RSRVD_RESOURCE_TYPE_DEVICE);
1401 return OC_STACK_NO_MEMORY;
1403 dest->next = savedDeviceInfo.types;
1404 savedDeviceInfo.types = dest;
1406 if(!savedDeviceInfo.types && info.types)
1409 return OC_STACK_NO_MEMORY;
1413 if (info.specVersion)
1415 savedDeviceInfo.specVersion = OICStrdup(info.specVersion);
1416 if(!savedDeviceInfo.specVersion && info.specVersion)
1419 return OC_STACK_NO_MEMORY;
1424 savedDeviceInfo.specVersion = OICStrdup(OC_SPEC_VERSION);
1425 if(!savedDeviceInfo.specVersion && OC_SPEC_VERSION)
1428 return OC_STACK_NO_MEMORY;
1432 if (info.dataModelVersions)
1434 savedDeviceInfo.dataModelVersions = CloneOCStringLL(info.dataModelVersions);
1435 if(!savedDeviceInfo.dataModelVersions && info.dataModelVersions)
1438 return OC_STACK_NO_MEMORY;
1443 savedDeviceInfo.dataModelVersions = (OCStringLL *)OICCalloc(1,sizeof(OCStringLL));
1444 if (!savedDeviceInfo.dataModelVersions)
1446 return OC_STACK_NO_MEMORY;
1448 savedDeviceInfo.dataModelVersions->value = OICStrdup(OC_DATA_MODEL_VERSION);
1449 if(!savedDeviceInfo.dataModelVersions->value && OC_DATA_MODEL_VERSION)
1452 return OC_STACK_NO_MEMORY;
1459 OCStackResult SaveDeviceInfo(OCDeviceInfo info)
1461 OCStackResult res = OC_STACK_OK;
1465 res = DeepCopyDeviceInfo(info);
1467 VERIFY_SUCCESS(res, OC_STACK_OK);
1469 if (OCGetServerInstanceIDString() == NULL)
1471 OIC_LOG(INFO, TAG, "Device ID generation failed");
1472 res = OC_STACK_ERROR;
1476 OIC_LOG(INFO, TAG, "Device initialized successfully.");