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;
332 uint16_t tcpPort = 0;
333 if (GetTCPPortInfo(devAddr, &tcpPort) != OC_STACK_OK)
337 OCDiscoveryPayloadAddResource(payload, resourcePtr, securePort, tcpPort);
339 OCDiscoveryPayloadAddResource(payload, resourcePtr, securePort);
345 uint8_t IsCollectionResource (OCResource *resource)
352 if(resource->rsrcChildResourcesHead != NULL)
360 OCResource *FindResourceByUri(const char* resourceUri)
367 OCResource * pointer = headResource;
370 if (strcmp(resourceUri, pointer->uri) == 0)
374 pointer = pointer->next;
376 OIC_LOG_V(INFO, TAG, "Resource %s not found", resourceUri);
381 OCStackResult DetermineResourceHandling (const OCServerRequest *request,
382 ResourceHandling *handling,
383 OCResource **resource)
385 if(!request || !handling || !resource)
387 return OC_STACK_INVALID_PARAM;
390 OIC_LOG_V(INFO, TAG, "DetermineResourceHandling for %s", request->resourceUrl);
392 // Check if virtual resource
393 if (GetTypeOfVirtualURI(request->resourceUrl) != OC_UNKNOWN_URI)
395 OIC_LOG_V (INFO, TAG, "%s is virtual", request->resourceUrl);
396 *handling = OC_RESOURCE_VIRTUAL;
397 *resource = headResource;
400 if (strlen((const char*)(request->resourceUrl)) == 0)
402 // Resource URL not specified
403 *handling = OC_RESOURCE_NOT_SPECIFIED;
404 return OC_STACK_NO_RESOURCE;
408 OCResource *resourcePtr = FindResourceByUri((const char*)request->resourceUrl);
409 *resource = resourcePtr;
412 if(defaultDeviceHandler)
414 *handling = OC_RESOURCE_DEFAULT_DEVICE_ENTITYHANDLER;
418 // Resource does not exist
419 // and default device handler does not exist
420 *handling = OC_RESOURCE_NOT_SPECIFIED;
421 return OC_STACK_NO_RESOURCE;
424 if (IsCollectionResource (resourcePtr))
426 // Collection resource
427 if (resourcePtr->entityHandler != defaultResourceEHandler)
429 *handling = OC_RESOURCE_COLLECTION_WITH_ENTITYHANDLER;
434 *handling = OC_RESOURCE_COLLECTION_DEFAULT_ENTITYHANDLER;
440 // Resource not a collection
441 if (resourcePtr->entityHandler != defaultResourceEHandler)
443 *handling = OC_RESOURCE_NOT_COLLECTION_WITH_ENTITYHANDLER;
448 *handling = OC_RESOURCE_NOT_COLLECTION_DEFAULT_ENTITYHANDLER;
455 OCStackResult EntityHandlerCodeToOCStackCode(OCEntityHandlerResult ehResult)
457 OCStackResult result;
462 result = OC_STACK_OK;
465 result = OC_STACK_SLOW_RESOURCE;
468 result = OC_STACK_ERROR;
470 case OC_EH_FORBIDDEN:
471 result = OC_STACK_RESOURCE_ERROR;
473 case OC_EH_RESOURCE_CREATED:
474 result = OC_STACK_RESOURCE_CREATED;
476 case OC_EH_RESOURCE_DELETED:
477 result = OC_STACK_RESOURCE_DELETED;
479 case OC_EH_RESOURCE_NOT_FOUND:
480 result = OC_STACK_NO_RESOURCE;
483 result = OC_STACK_ERROR;
489 static bool resourceMatchesRTFilter(OCResource *resource, char *resourceTypeFilter)
496 // Null or empty is analogous to no filter.
497 if (resourceTypeFilter == NULL || *resourceTypeFilter == 0)
502 OCResourceType *resourceTypePtr = resource->rsrcType;
504 while (resourceTypePtr)
506 if (strcmp (resourceTypePtr->resourcetypename, resourceTypeFilter) == 0)
510 resourceTypePtr = resourceTypePtr->next;
513 OIC_LOG_V(INFO, TAG, "%s does not contain rt=%s.", resource->uri, resourceTypeFilter);
517 static bool resourceMatchesIFFilter(OCResource *resource, char *interfaceFilter)
524 // Null or empty is analogous to no filter.
525 if (interfaceFilter == NULL || *interfaceFilter == 0)
530 OCResourceInterface *interfacePtr = resource->rsrcInterface;
534 if ((strcmp (interfacePtr->name, interfaceFilter) == 0) &&
535 (strcmp (OC_RSRVD_INTERFACE_LL, interfaceFilter) == 0 ||
536 strcmp (OC_RSRVD_INTERFACE_DEFAULT, interfaceFilter) == 0))
540 interfacePtr = interfacePtr->next;
543 OIC_LOG_V(INFO, TAG, "%s does not contain if=%s.", resource->uri, interfaceFilter);
548 * If the filters are null, they will be assumed to NOT be present
549 * and the resource will not be matched against them.
550 * Function will return true if all non null AND non empty filters passed in find a match.
552 static bool includeThisResourceInResponse(OCResource *resource,
553 char *interfaceFilter,
554 char *resourceTypeFilter)
558 OIC_LOG(ERROR, TAG, "Invalid resource");
562 if (resource->resourceProperties & OC_EXPLICIT_DISCOVERABLE)
565 * At least one valid filter should be available to
566 * include the resource in discovery response
568 if (!(resourceTypeFilter && *resourceTypeFilter))
570 OIC_LOG_V(INFO, TAG, "%s no query string for EXPLICIT_DISCOVERABLE \
571 resource", resource->uri);
575 else if ( !(resource->resourceProperties & OC_ACTIVE) ||
576 !(resource->resourceProperties & OC_DISCOVERABLE))
578 OIC_LOG_V(INFO, TAG, "%s not ACTIVE or DISCOVERABLE", resource->uri);
582 return resourceMatchesIFFilter(resource, interfaceFilter) &&
583 resourceMatchesRTFilter(resource, resourceTypeFilter);
587 OCStackResult SendNonPersistantDiscoveryResponse(OCServerRequest *request, OCResource *resource,
588 OCPayload *discoveryPayload, OCEntityHandlerResult ehResult)
590 OCEntityHandlerResponse response = {0};
592 response.ehResult = ehResult;
593 response.payload = discoveryPayload;
594 response.persistentBufferFlag = 0;
595 response.requestHandle = (OCRequestHandle) request;
596 response.resourceHandle = (OCResourceHandle) resource;
598 return OCDoResponse(&response);
602 static OCStackResult checkResourceExistsAtRD(const char *interfaceType, const char *resourceType,
603 OCResource **payload, OCDevAddr *devAddr)
605 OCResourceCollectionPayload *repPayload;
608 return OC_STACK_ERROR;
610 if (OCRDCheckPublishedResource(interfaceType, resourceType, &repPayload, devAddr) == OC_STACK_OK)
614 return OC_STACK_ERROR;
616 OCResource *ptr = ((OCResource *) OICCalloc(1, sizeof(OCResource)));
619 return OC_STACK_NO_MEMORY;
622 ptr->uri = OICStrdup(repPayload->setLinks->href);
625 return OC_STACK_NO_MEMORY;
627 OCStringLL *rt = repPayload->setLinks->rt;
630 OCResourceType *temp = (OCResourceType *) OICCalloc(1, sizeof(OCResourceType));
634 return OC_STACK_NO_MEMORY;
637 temp->resourcetypename = OICStrdup(rt->value);
640 ptr->rsrcType = temp;
644 OCResourceType *type = ptr->rsrcType;
654 OCStringLL *itf = repPayload->setLinks->itf;
657 OCResourceInterface *temp = (OCResourceInterface *) OICCalloc(1, sizeof(OCResourceInterface));
662 return OC_STACK_NO_MEMORY;
665 temp->name = OICStrdup(itf->value);
666 if (!ptr->rsrcInterface)
668 ptr->rsrcInterface = temp;
672 OCResourceInterface *type = ptr->rsrcInterface;
682 ptr->resourceProperties = (OCResourceProperty) repPayload->tags->bitmap;
684 OCFreeCollectionResource(repPayload);
690 OIC_LOG_V(ERROR, TAG, "The resource type or interface type doe not exist \
691 on the resource directory");
693 return OC_STACK_ERROR;
697 static OCStackResult HandleVirtualResource (OCServerRequest *request, OCResource* resource)
699 if (!request || !resource)
701 return OC_STACK_INVALID_PARAM;
704 OCStackResult discoveryResult = OC_STACK_ERROR;
706 bool bMulticast = false; // Was the discovery request a multicast request?
707 OCPayload* payload = NULL;
709 OIC_LOG(INFO, TAG, "Entering HandleVirtualResource");
711 OCVirtualResources virtualUriInRequest = GetTypeOfVirtualURI (request->resourceUrl);
713 // Step 1: Generate the response to discovery request
714 if (virtualUriInRequest == OC_WELL_KNOWN_URI)
716 if (request->method == OC_REST_PUT || request->method == OC_REST_POST || request->method == OC_REST_DELETE)
718 OIC_LOG_V(ERROR, TAG, "Resource : %s not permitted for method: %d", request->resourceUrl, request->method);
719 return OC_STACK_UNAUTHORIZED_REQ;
722 char *interfaceQuery = NULL;
723 char *resourceTypeQuery = NULL;
725 discoveryResult = getQueryParamsForFiltering (virtualUriInRequest, request->query,
726 &interfaceQuery, &resourceTypeQuery);
727 bool interfaceQueryAllocated = false;
728 if (!interfaceQuery && !resourceTypeQuery)
730 interfaceQueryAllocated = true;
731 interfaceQuery = OICStrdup(OC_RSRVD_INTERFACE_LL);
734 if (discoveryResult == OC_STACK_OK)
736 payload = (OCPayload *)OCDiscoveryPayloadCreate();
740 OCDiscoveryPayload *discPayload = (OCDiscoveryPayload *)payload;
741 discPayload->sid = (char *)OICCalloc(1, UUID_STRING_SIZE);
742 VERIFY_NON_NULL(discPayload->sid, ERROR, OC_STACK_NO_MEMORY);
744 const char* uid = OCGetServerInstanceIDString();
747 memcpy(discPayload->sid, uid, UUID_STRING_SIZE);
750 if (!resourceTypeQuery && interfaceQuery && (0 == strcmp(interfaceQuery, OC_RSRVD_INTERFACE_LL)))
752 for (; resource && discoveryResult == OC_STACK_OK; resource = resource->next)
755 if (resource->resourceProperties & OC_DISCOVERABLE)
762 discoveryResult = BuildVirtualResourceResponse(resource,
763 discPayload, &request->devAddr, false);
769 if (interfaceQuery && (0 != strcmp(interfaceQuery, OC_RSRVD_INTERFACE_LL)))
771 discPayload->uri = OICStrdup(OC_RSRVD_WELL_KNOWN_URI);
772 VERIFY_NON_NULL(discPayload->uri, ERROR, OC_STACK_NO_MEMORY);
773 if (savedDeviceInfo.deviceName)
775 discPayload->name = OICStrdup(savedDeviceInfo.deviceName);
776 VERIFY_NON_NULL(discPayload->name, ERROR, OC_STACK_NO_MEMORY);
778 discPayload->type = (OCStringLL*)OICCalloc(1, sizeof(OCStringLL));
779 VERIFY_NON_NULL(discPayload->type, ERROR, OC_STACK_NO_MEMORY);
780 discPayload->type->value = OICStrdup(OC_RSRVD_RESOURCE_TYPE_RES);
781 VERIFY_NON_NULL(discPayload->type->value, ERROR, OC_STACK_NO_MEMORY);
782 OCResourcePayloadAddStringLL(&discPayload->interface, OC_RSRVD_INTERFACE_LL);
783 OCResourcePayloadAddStringLL(&discPayload->interface, OC_RSRVD_INTERFACE_DEFAULT);
784 VERIFY_NON_NULL(discPayload->interface, ERROR, OC_STACK_NO_MEMORY);
786 bool foundResourceAtRD = false;
787 for (;resource && discoveryResult == OC_STACK_OK; resource = resource->next)
790 if (strcmp(resource->uri, OC_RSRVD_RD_URI) == 0)
792 OCResource *resource1 = NULL;
794 discoveryResult = checkResourceExistsAtRD(interfaceQuery,
795 resourceTypeQuery, &resource1, &devAddr);
796 if (discoveryResult != OC_STACK_OK)
800 discoveryResult = BuildVirtualResourceResponse(resource1,
801 discPayload, &devAddr, true);
804 discPayload->baseURI = OICStrdup(devAddr.addr);
806 OICFree(resource1->uri);
807 for (OCResourceType *rsrcRt = resource1->rsrcType, *rsrcRtNext = NULL; rsrcRt; )
809 rsrcRtNext = rsrcRt->next;
810 OICFree(rsrcRt->resourcetypename);
815 for (OCResourceInterface *rsrcPtr = resource1->rsrcInterface, *rsrcNext = NULL; rsrcPtr; )
817 rsrcNext = rsrcPtr->next;
818 OICFree(rsrcPtr->name);
822 foundResourceAtRD = true;
825 if (!foundResourceAtRD && includeThisResourceInResponse(resource, interfaceQuery, resourceTypeQuery))
827 discoveryResult = BuildVirtualResourceResponse(resource,
828 discPayload, &request->devAddr, false);
831 // Set discoveryResult appropriately if no 'valid' resources are available
832 if (discPayload->resources == NULL && !foundResourceAtRD)
834 discoveryResult = OC_STACK_NO_RESOURCE;
840 discoveryResult = OC_STACK_NO_MEMORY;
845 OIC_LOG_V(ERROR, TAG, "Error (%d) parsing query.", discoveryResult);
847 if (interfaceQueryAllocated)
849 OICFree(interfaceQuery);
852 else if (virtualUriInRequest == OC_DEVICE_URI)
854 if (request->method == OC_REST_PUT || request->method == OC_REST_POST || request->method == OC_REST_DELETE)
856 OIC_LOG_V(ERROR, TAG, "Resource : %s not permitted for method: %d", request->resourceUrl, request->method);
857 return OC_STACK_UNAUTHORIZED_REQ;
860 const char* deviceId = OCGetServerInstanceIDString();
863 discoveryResult = OC_STACK_ERROR;
867 char *dataModelVersions = OCCreateString(savedDeviceInfo.dataModelVersions);
868 if (!dataModelVersions)
870 discoveryResult = OC_STACK_NO_MEMORY;
874 payload = (OCPayload*) OCDevicePayloadCreate(deviceId, savedDeviceInfo.deviceName,
875 savedDeviceInfo.types, savedDeviceInfo.specVersion, dataModelVersions);
878 discoveryResult = OC_STACK_NO_MEMORY;
882 discoveryResult = OC_STACK_OK;
884 OICFree(dataModelVersions);
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,
995 VERIFY_SUCCESS(result, OC_STACK_OK);
997 // At this point we know for sure that defaultDeviceHandler exists
998 ehResult = defaultDeviceHandler(OC_REQUEST_FLAG, &ehRequest,
999 (char*) request->resourceUrl, defaultDeviceHandlerCallbackParameter);
1000 if(ehResult == OC_EH_SLOW)
1002 OIC_LOG(INFO, TAG, "This is a slow resource");
1003 request->slowFlag = 1;
1005 else if(ehResult == OC_EH_ERROR)
1007 FindAndDeleteServerRequest(request);
1009 result = EntityHandlerCodeToOCStackCode(ehResult);
1011 OCPayloadDestroy(ehRequest.payload);
1015 static OCStackResult
1016 HandleResourceWithEntityHandler (OCServerRequest *request,
1017 OCResource *resource,
1018 uint8_t collectionResource)
1020 if(!request || ! resource)
1022 return OC_STACK_INVALID_PARAM;
1025 OCStackResult result = OC_STACK_ERROR;
1026 OCEntityHandlerResult ehResult = OC_EH_ERROR;
1027 OCEntityHandlerFlag ehFlag = OC_REQUEST_FLAG;
1028 ResourceObserver *resObs = NULL;
1030 OCEntityHandlerRequest ehRequest = {0};
1032 OIC_LOG(INFO, TAG, "Entering HandleResourceWithEntityHandler");
1033 OCPayloadType type = PAYLOAD_TYPE_REPRESENTATION;
1034 // check the security resource
1035 if (request && request->resourceUrl && SRMIsSecurityResourceURI(request->resourceUrl))
1037 type = PAYLOAD_TYPE_SECURITY;
1041 if (request && strcmp(request->resourceUrl, OC_RSRVD_RD_URI) == 0)
1043 type = PAYLOAD_TYPE_RD;
1046 result = FormOCEntityHandlerRequest(&ehRequest,
1047 (OCRequestHandle)request,
1050 (OCResourceHandle)resource,
1054 request->payloadSize,
1055 request->numRcvdVendorSpecificHeaderOptions,
1056 request->rcvdVendorSpecificHeaderOptions,
1057 (OCObserveAction)request->observationOption,
1060 VERIFY_SUCCESS(result, OC_STACK_OK);
1062 if(ehRequest.obsInfo.action == OC_OBSERVE_NO_OPTION)
1064 OIC_LOG(INFO, TAG, "No observation requested");
1065 ehFlag = OC_REQUEST_FLAG;
1067 else if(ehRequest.obsInfo.action == OC_OBSERVE_REGISTER && !collectionResource)
1069 OIC_LOG(INFO, TAG, "Observation registration requested");
1071 ResourceObserver *obs = GetObserverUsingToken (request->requestToken,
1072 request->tokenLength);
1076 OIC_LOG (INFO, TAG, "Observer with this token already present");
1077 OIC_LOG (INFO, TAG, "Possibly re-transmitted CON OBS request");
1078 OIC_LOG (INFO, TAG, "Not adding observer. Not responding to client");
1079 OIC_LOG (INFO, TAG, "The first request for this token is already ACKED.");
1081 // server requests are usually free'd when the response is sent out
1082 // for the request in ocserverrequest.c : HandleSingleResponse()
1083 // Since we are making an early return and not responding, the server request
1084 // needs to be deleted.
1085 FindAndDeleteServerRequest (request);
1089 result = GenerateObserverId(&ehRequest.obsInfo.obsId);
1090 VERIFY_SUCCESS(result, OC_STACK_OK);
1092 result = AddObserver ((const char*)(request->resourceUrl),
1093 (const char *)(request->query),
1094 ehRequest.obsInfo.obsId, request->requestToken, request->tokenLength,
1095 resource, request->qos, request->acceptFormat,
1098 if(result == OC_STACK_OK)
1100 OIC_LOG(INFO, TAG, "Added observer successfully");
1101 request->observeResult = OC_STACK_OK;
1102 ehFlag = (OCEntityHandlerFlag)(OC_REQUEST_FLAG | OC_OBSERVE_FLAG);
1106 result = OC_STACK_OK;
1108 // The error in observeResult for the request will be used when responding to this
1109 // request by omitting the observation option/sequence number.
1110 request->observeResult = OC_STACK_ERROR;
1111 OIC_LOG(ERROR, TAG, "Observer Addition failed");
1112 ehFlag = OC_REQUEST_FLAG;
1116 else if(ehRequest.obsInfo.action == OC_OBSERVE_DEREGISTER &&
1117 !collectionResource)
1119 OIC_LOG(INFO, TAG, "Deregistering observation requested");
1121 resObs = GetObserverUsingToken (request->requestToken, request->tokenLength);
1125 // Stack does not contain this observation request
1126 // Either token is incorrect or observation list is corrupted
1127 result = OC_STACK_ERROR;
1130 ehRequest.obsInfo.obsId = resObs->observeId;
1131 ehFlag = (OCEntityHandlerFlag)(ehFlag | OC_OBSERVE_FLAG);
1133 result = DeleteObserverUsingToken (request->requestToken, request->tokenLength);
1135 if(result == OC_STACK_OK)
1137 OIC_LOG(INFO, TAG, "Removed observer successfully");
1138 request->observeResult = OC_STACK_OK;
1142 result = OC_STACK_OK;
1143 request->observeResult = OC_STACK_ERROR;
1144 OIC_LOG(ERROR, TAG, "Observer Removal failed");
1149 result = OC_STACK_ERROR;
1153 ehResult = resource->entityHandler(ehFlag, &ehRequest, resource->entityHandlerCallbackParam);
1154 if(ehResult == OC_EH_SLOW)
1156 OIC_LOG(INFO, TAG, "This is a slow resource");
1157 request->slowFlag = 1;
1159 else if(ehResult == OC_EH_ERROR)
1161 FindAndDeleteServerRequest(request);
1163 result = EntityHandlerCodeToOCStackCode(ehResult);
1165 OCPayloadDestroy(ehRequest.payload);
1169 static OCStackResult
1170 HandleCollectionResourceDefaultEntityHandler (OCServerRequest *request,
1171 OCResource *resource)
1173 if(!request || !resource)
1175 return OC_STACK_INVALID_PARAM;
1178 OCStackResult result = OC_STACK_ERROR;
1179 OCEntityHandlerRequest ehRequest = {0};
1181 result = FormOCEntityHandlerRequest(&ehRequest,
1182 (OCRequestHandle)request,
1185 (OCResourceHandle)resource,
1187 PAYLOAD_TYPE_REPRESENTATION,
1189 request->payloadSize,
1190 request->numRcvdVendorSpecificHeaderOptions,
1191 request->rcvdVendorSpecificHeaderOptions,
1192 (OCObserveAction)request->observationOption,
1195 if(result == OC_STACK_OK)
1197 result = DefaultCollectionEntityHandler (OC_REQUEST_FLAG, &ehRequest);
1200 OCPayloadDestroy(ehRequest.payload);
1205 ProcessRequest(ResourceHandling resHandling, OCResource *resource, OCServerRequest *request)
1207 OCStackResult ret = OC_STACK_OK;
1209 switch (resHandling)
1211 case OC_RESOURCE_VIRTUAL:
1213 ret = HandleVirtualResource (request, resource);
1216 case OC_RESOURCE_DEFAULT_DEVICE_ENTITYHANDLER:
1218 ret = HandleDefaultDeviceEntityHandler(request);
1221 case OC_RESOURCE_NOT_COLLECTION_DEFAULT_ENTITYHANDLER:
1223 OIC_LOG(INFO, TAG, "OC_RESOURCE_NOT_COLLECTION_DEFAULT_ENTITYHANDLER");
1224 return OC_STACK_ERROR;
1226 case OC_RESOURCE_NOT_COLLECTION_WITH_ENTITYHANDLER:
1228 ret = HandleResourceWithEntityHandler (request, resource, 0);
1231 case OC_RESOURCE_COLLECTION_WITH_ENTITYHANDLER:
1233 ret = HandleResourceWithEntityHandler (request, resource, 1);
1236 case OC_RESOURCE_COLLECTION_DEFAULT_ENTITYHANDLER:
1238 ret = HandleCollectionResourceDefaultEntityHandler (request, resource);
1241 case OC_RESOURCE_NOT_SPECIFIED:
1243 ret = OC_STACK_NO_RESOURCE;
1248 OIC_LOG(INFO, TAG, "Invalid Resource Determination");
1249 return OC_STACK_ERROR;
1255 void DeletePlatformInfo()
1257 OIC_LOG(INFO, TAG, "Deleting platform info.");
1259 OICFree(savedPlatformInfo.platformID);
1260 savedPlatformInfo.platformID = NULL;
1262 OICFree(savedPlatformInfo.manufacturerName);
1263 savedPlatformInfo.manufacturerName = NULL;
1265 OICFree(savedPlatformInfo.manufacturerUrl);
1266 savedPlatformInfo.manufacturerUrl = NULL;
1268 OICFree(savedPlatformInfo.modelNumber);
1269 savedPlatformInfo.modelNumber = NULL;
1271 OICFree(savedPlatformInfo.dateOfManufacture);
1272 savedPlatformInfo.dateOfManufacture = NULL;
1274 OICFree(savedPlatformInfo.platformVersion);
1275 savedPlatformInfo.platformVersion = NULL;
1277 OICFree(savedPlatformInfo.operatingSystemVersion);
1278 savedPlatformInfo.operatingSystemVersion = NULL;
1280 OICFree(savedPlatformInfo.hardwareVersion);
1281 savedPlatformInfo.hardwareVersion = NULL;
1283 OICFree(savedPlatformInfo.firmwareVersion);
1284 savedPlatformInfo.firmwareVersion = NULL;
1286 OICFree(savedPlatformInfo.supportUrl);
1287 savedPlatformInfo.supportUrl = NULL;
1289 OICFree(savedPlatformInfo.systemTime);
1290 savedPlatformInfo.systemTime = NULL;
1293 static OCStackResult DeepCopyPlatFormInfo(OCPlatformInfo info)
1295 savedPlatformInfo.platformID = OICStrdup(info.platformID);
1296 savedPlatformInfo.manufacturerName = OICStrdup(info.manufacturerName);
1297 savedPlatformInfo.manufacturerUrl = OICStrdup(info.manufacturerUrl);
1298 savedPlatformInfo.modelNumber = OICStrdup(info.modelNumber);
1299 savedPlatformInfo.dateOfManufacture = OICStrdup(info.dateOfManufacture);
1300 savedPlatformInfo.platformVersion = OICStrdup(info.platformVersion);
1301 savedPlatformInfo.operatingSystemVersion = OICStrdup(info.operatingSystemVersion);
1302 savedPlatformInfo.hardwareVersion = OICStrdup(info.hardwareVersion);
1303 savedPlatformInfo.firmwareVersion = OICStrdup(info.firmwareVersion);
1304 savedPlatformInfo.supportUrl = OICStrdup(info.supportUrl);
1305 savedPlatformInfo.systemTime = OICStrdup(info.systemTime);
1307 if ((!savedPlatformInfo.platformID && info.platformID)||
1308 (!savedPlatformInfo.manufacturerName && info.manufacturerName)||
1309 (!savedPlatformInfo.manufacturerUrl && info.manufacturerUrl)||
1310 (!savedPlatformInfo.modelNumber && info.modelNumber)||
1311 (!savedPlatformInfo.dateOfManufacture && info.dateOfManufacture)||
1312 (!savedPlatformInfo.platformVersion && info.platformVersion)||
1313 (!savedPlatformInfo.operatingSystemVersion && info.operatingSystemVersion)||
1314 (!savedPlatformInfo.hardwareVersion && info.hardwareVersion)||
1315 (!savedPlatformInfo.firmwareVersion && info.firmwareVersion)||
1316 (!savedPlatformInfo.supportUrl && info.supportUrl)||
1317 (!savedPlatformInfo.systemTime && info.systemTime))
1319 DeletePlatformInfo();
1320 return OC_STACK_INVALID_PARAM;
1327 OCStackResult SavePlatformInfo(OCPlatformInfo info)
1329 DeletePlatformInfo();
1331 OCStackResult res = DeepCopyPlatFormInfo(info);
1333 if (res != OC_STACK_OK)
1335 OIC_LOG_V(ERROR, TAG, "Failed to save platform info. errno(%d)", res);
1339 OIC_LOG(INFO, TAG, "Platform info saved.");
1345 void DeleteDeviceInfo()
1347 OIC_LOG(INFO, TAG, "Deleting device info.");
1349 OICFree(savedDeviceInfo.deviceName);
1350 OCFreeOCStringLL(savedDeviceInfo.types);
1351 OICFree(savedDeviceInfo.specVersion);
1352 OCFreeOCStringLL(savedDeviceInfo.dataModelVersions);
1353 savedDeviceInfo.deviceName = NULL;
1354 savedDeviceInfo.specVersion = NULL;
1355 savedDeviceInfo.dataModelVersions = NULL;
1358 static OCStackResult DeepCopyDeviceInfo(OCDeviceInfo info)
1360 savedDeviceInfo.deviceName = OICStrdup(info.deviceName);
1362 if(!savedDeviceInfo.deviceName && info.deviceName)
1365 return OC_STACK_NO_MEMORY;
1370 savedDeviceInfo.types = CloneOCStringLL(info.types);
1371 if(!savedDeviceInfo.types && info.types)
1374 return OC_STACK_NO_MEMORY;
1378 if (info.specVersion)
1380 savedDeviceInfo.specVersion = OICStrdup(info.specVersion);
1381 if(!savedDeviceInfo.specVersion && info.specVersion)
1384 return OC_STACK_NO_MEMORY;
1389 savedDeviceInfo.specVersion = OICStrdup(OC_SPEC_VERSION);
1390 if(!savedDeviceInfo.specVersion && OC_SPEC_VERSION)
1393 return OC_STACK_NO_MEMORY;
1397 if (info.dataModelVersions)
1399 savedDeviceInfo.dataModelVersions = CloneOCStringLL(info.dataModelVersions);
1400 if(!savedDeviceInfo.dataModelVersions && info.dataModelVersions)
1403 return OC_STACK_NO_MEMORY;
1408 savedDeviceInfo.dataModelVersions = (OCStringLL *)OICCalloc(1,sizeof(OCStringLL));
1409 if (!savedDeviceInfo.dataModelVersions)
1411 return OC_STACK_NO_MEMORY;
1413 savedDeviceInfo.dataModelVersions->value = OICStrdup(OC_DATA_MODEL_VERSION);
1414 if(!savedDeviceInfo.dataModelVersions->value && OC_DATA_MODEL_VERSION)
1417 return OC_STACK_NO_MEMORY;
1424 OCStackResult SaveDeviceInfo(OCDeviceInfo info)
1426 OCStackResult res = OC_STACK_OK;
1430 res = DeepCopyDeviceInfo(info);
1432 VERIFY_SUCCESS(res, OC_STACK_OK);
1434 if (OCGetServerInstanceIDString() == NULL)
1436 OIC_LOG(INFO, TAG, "Device ID generation failed");
1437 res = OC_STACK_ERROR;
1441 OIC_LOG(INFO, TAG, "Device initialized successfully.");