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 * Function will extract 0, 1 or 2 filters from query.
116 * More than 2 filters or unsupported filters will result in error.
117 * If both filters are of the same supported type, the 2nd one will be picked.
118 * Resource and device filters in the SAME query are NOT validated
119 * and resources will likely not clear filters.
121 static OCStackResult ExtractFiltersFromQuery(char *query, char **filterOne, char **filterTwo)
126 char *restOfQuery = NULL;
127 int numKeyValuePairsParsed = 0;
132 OIC_LOG_V(INFO, TAG, "Extracting params from %s", query);
134 char *keyValuePair = strtok_r (query, OC_QUERY_SEPARATOR, &restOfQuery);
138 if (numKeyValuePairsParsed >= 2)
140 OIC_LOG(ERROR, TAG, "More than 2 queries params in URI.");
141 return OC_STACK_INVALID_QUERY;
144 key = strtok_r(keyValuePair, OC_KEY_VALUE_DELIMITER, &value);
148 return OC_STACK_INVALID_QUERY;
150 else if (strncasecmp(key, OC_RSRVD_INTERFACE, sizeof(OC_RSRVD_INTERFACE) - 1) == 0)
152 *filterOne = value; // if
154 else if (strncasecmp(key, OC_RSRVD_RESOURCE_TYPE, sizeof(OC_RSRVD_INTERFACE) - 1) == 0)
156 *filterTwo = value; // rt
160 OIC_LOG_V(ERROR, TAG, "Unsupported query key: %s", key);
161 return OC_STACK_INVALID_QUERY;
163 ++numKeyValuePairsParsed;
165 keyValuePair = strtok_r(NULL, OC_QUERY_SEPARATOR, &restOfQuery);
168 OIC_LOG_V(INFO, TAG, "Extracted params if: %s and rt: %s.", *filterOne, *filterTwo);
172 static OCVirtualResources GetTypeOfVirtualURI(const char *uriInRequest)
174 if (strcmp(uriInRequest, OC_RSRVD_WELL_KNOWN_URI) == 0)
176 return OC_WELL_KNOWN_URI;
178 else if (strcmp(uriInRequest, OC_RSRVD_DEVICE_URI) == 0)
180 return OC_DEVICE_URI;
182 else if (strcmp(uriInRequest, OC_RSRVD_PLATFORM_URI) == 0)
184 return OC_PLATFORM_URI;
186 else if (strcmp(uriInRequest, OC_RSRVD_RESOURCE_TYPES_URI) == 0)
188 return OC_RESOURCE_TYPES_URI;
190 #ifdef ROUTING_GATEWAY
191 else if (0 == strcmp(uriInRequest, OC_RSRVD_GATEWAY_URI))
193 return OC_GATEWAY_URI;
197 else if (strcmp(uriInRequest, OC_RSRVD_PRESENCE_URI) == 0)
201 #endif //WITH_PRESENCE
202 return OC_UNKNOWN_URI;
205 static OCStackResult getQueryParamsForFiltering (OCVirtualResources uri, char *query,
206 char **filterOne, char **filterTwo)
208 if(!filterOne || !filterTwo)
210 return OC_STACK_INVALID_PARAM;
217 if (uri == OC_PRESENCE)
219 //Nothing needs to be done, except for pass a OC_PRESENCE query through as OC_STACK_OK.
220 OIC_LOG(INFO, TAG, "OC_PRESENCE Request for virtual resource.");
225 OCStackResult result = OC_STACK_OK;
229 result = ExtractFiltersFromQuery(query, filterOne, filterTwo);
235 OCStackResult BuildResponseRepresentation(const OCResource *resourcePtr,
236 OCRepPayload** payload)
238 OCRepPayload *tempPayload = OCRepPayloadCreate();
242 OCRepPayloadDestroy(tempPayload);
243 return OC_STACK_INVALID_PARAM;
248 return OC_STACK_NO_MEMORY;
251 OCRepPayloadSetUri(tempPayload, resourcePtr->uri);
253 OCResourceType *resType = resourcePtr->rsrcType;
256 OCRepPayloadAddResourceType(tempPayload, resType->resourcetypename);
257 resType = resType->next;
260 OCResourceInterface *resInterface = resourcePtr->rsrcInterface;
263 OCRepPayloadAddInterface(tempPayload, resInterface->name);
264 resInterface = resInterface->next;
267 OCAttribute *resAttrib = resourcePtr->rsrcAttributes;
270 OCRepPayloadSetPropString(tempPayload, resAttrib->attrName,
271 resAttrib->attrValue);
272 resAttrib = resAttrib->next;
277 *payload = tempPayload;
281 OCRepPayloadAppend(*payload, tempPayload);
287 OCStackResult BuildVirtualResourceResponse(const OCResource *resourcePtr,
288 OCDiscoveryPayload *payload, OCDevAddr *devAddr, bool rdResponse)
290 if (!resourcePtr || !payload)
292 return OC_STACK_INVALID_PARAM;
295 if (resourcePtr->resourceProperties & OC_SECURE)
297 if (GetSecurePortInfo(devAddr, &port) != OC_STACK_OK)
305 port = devAddr->port;
308 OCDiscoveryPayloadAddResource(payload, resourcePtr, port);
312 uint8_t IsCollectionResource (OCResource *resource)
319 if(resource->rsrcChildResourcesHead != NULL)
327 OCResource *FindResourceByUri(const char* resourceUri)
334 OCResource * pointer = headResource;
337 if (strcmp(resourceUri, pointer->uri) == 0)
341 pointer = pointer->next;
343 OIC_LOG_V(INFO, TAG, "Resource %s not found", resourceUri);
348 OCStackResult DetermineResourceHandling (const OCServerRequest *request,
349 ResourceHandling *handling,
350 OCResource **resource)
352 if(!request || !handling || !resource)
354 return OC_STACK_INVALID_PARAM;
357 OIC_LOG_V(INFO, TAG, "DetermineResourceHandling for %s", request->resourceUrl);
359 // Check if virtual resource
360 if (GetTypeOfVirtualURI(request->resourceUrl) != OC_UNKNOWN_URI)
362 OIC_LOG_V (INFO, TAG, "%s is virtual", request->resourceUrl);
363 *handling = OC_RESOURCE_VIRTUAL;
364 *resource = headResource;
367 if (strlen((const char*)(request->resourceUrl)) == 0)
369 // Resource URL not specified
370 *handling = OC_RESOURCE_NOT_SPECIFIED;
371 return OC_STACK_NO_RESOURCE;
375 OCResource *resourcePtr = FindResourceByUri((const char*)request->resourceUrl);
376 *resource = resourcePtr;
379 if(defaultDeviceHandler)
381 *handling = OC_RESOURCE_DEFAULT_DEVICE_ENTITYHANDLER;
385 // Resource does not exist
386 // and default device handler does not exist
387 *handling = OC_RESOURCE_NOT_SPECIFIED;
388 return OC_STACK_NO_RESOURCE;
391 if (IsCollectionResource (resourcePtr))
393 // Collection resource
394 if (resourcePtr->entityHandler != defaultResourceEHandler)
396 *handling = OC_RESOURCE_COLLECTION_WITH_ENTITYHANDLER;
401 *handling = OC_RESOURCE_COLLECTION_DEFAULT_ENTITYHANDLER;
407 // Resource not a collection
408 if (resourcePtr->entityHandler != defaultResourceEHandler)
410 *handling = OC_RESOURCE_NOT_COLLECTION_WITH_ENTITYHANDLER;
415 *handling = OC_RESOURCE_NOT_COLLECTION_DEFAULT_ENTITYHANDLER;
422 OCStackResult EntityHandlerCodeToOCStackCode(OCEntityHandlerResult ehResult)
424 OCStackResult result;
429 result = OC_STACK_OK;
432 result = OC_STACK_SLOW_RESOURCE;
435 result = OC_STACK_ERROR;
437 case OC_EH_FORBIDDEN:
438 result = OC_STACK_RESOURCE_ERROR;
440 case OC_EH_RESOURCE_CREATED:
441 result = OC_STACK_RESOURCE_CREATED;
443 case OC_EH_RESOURCE_DELETED:
444 result = OC_STACK_RESOURCE_DELETED;
446 case OC_EH_RESOURCE_NOT_FOUND:
447 result = OC_STACK_NO_RESOURCE;
450 result = OC_STACK_ERROR;
456 static bool resourceMatchesRTFilter(OCResource *resource, char *resourceTypeFilter)
463 // Null or empty is analogous to no filter.
464 if (resourceTypeFilter == NULL || *resourceTypeFilter == 0)
469 OCResourceType *resourceTypePtr = resource->rsrcType;
471 while (resourceTypePtr)
473 if (strcmp (resourceTypePtr->resourcetypename, resourceTypeFilter) == 0)
477 resourceTypePtr = resourceTypePtr->next;
480 OIC_LOG_V(INFO, TAG, "%s does not contain rt=%s.", resource->uri, resourceTypeFilter);
484 static bool resourceMatchesIFFilter(OCResource *resource, char *interfaceFilter)
491 // Null or empty is analogous to no filter.
492 if (interfaceFilter == NULL || *interfaceFilter == 0)
497 OCResourceInterface *interfacePtr = resource->rsrcInterface;
501 if ((strcmp (interfacePtr->name, interfaceFilter) == 0) &&
502 (strcmp (OC_RSRVD_INTERFACE_LL, interfaceFilter) == 0 ||
503 strcmp (OC_RSRVD_INTERFACE_DEFAULT, interfaceFilter) == 0))
507 interfacePtr = interfacePtr->next;
510 OIC_LOG_V(INFO, TAG, "%s does not contain if=%s.", resource->uri, interfaceFilter);
515 * If the filters are null, they will be assumed to NOT be present
516 * and the resource will not be matched against them.
517 * Function will return true if all non null AND non empty filters passed in find a match.
519 static bool includeThisResourceInResponse(OCResource *resource,
520 char *interfaceFilter,
521 char *resourceTypeFilter)
525 OIC_LOG(ERROR, TAG, "Invalid resource");
529 if (resource->resourceProperties & OC_EXPLICIT_DISCOVERABLE)
532 * At least one valid filter should be available to
533 * include the resource in discovery response
535 if (!(resourceTypeFilter && *resourceTypeFilter))
537 OIC_LOG_V(INFO, TAG, "%s no query string for EXPLICIT_DISCOVERABLE \
538 resource", resource->uri);
542 else if ( !(resource->resourceProperties & OC_ACTIVE) ||
543 !(resource->resourceProperties & OC_DISCOVERABLE))
545 OIC_LOG_V(INFO, TAG, "%s not ACTIVE or DISCOVERABLE", resource->uri);
549 return resourceMatchesIFFilter(resource, interfaceFilter) &&
550 resourceMatchesRTFilter(resource, resourceTypeFilter);
554 OCStackResult SendNonPersistantDiscoveryResponse(OCServerRequest *request, OCResource *resource,
555 OCPayload *discoveryPayload, OCEntityHandlerResult ehResult)
557 OCEntityHandlerResponse response = {0};
559 response.ehResult = ehResult;
560 response.payload = discoveryPayload;
561 response.persistentBufferFlag = 0;
562 response.requestHandle = (OCRequestHandle) request;
563 response.resourceHandle = (OCResourceHandle) resource;
565 return OCDoResponse(&response);
569 static OCStackResult checkResourceExistsAtRD(const char *interfaceType, const char *resourceType,
570 OCResource **payload, OCDevAddr *devAddr)
572 OCResourceCollectionPayload *repPayload;
575 return OC_STACK_ERROR;
577 if (OCRDCheckPublishedResource(interfaceType, resourceType, &repPayload, devAddr) == OC_STACK_OK)
581 return OC_STACK_ERROR;
583 OCResource *ptr = ((OCResource *) OICCalloc(1, sizeof(OCResource)));
586 return OC_STACK_NO_MEMORY;
589 ptr->uri = OICStrdup(repPayload->setLinks->href);
592 return OC_STACK_NO_MEMORY;
594 OCStringLL *rt = repPayload->setLinks->rt;
597 OCResourceType *temp = (OCResourceType *) OICCalloc(1, sizeof(OCResourceType));
601 return OC_STACK_NO_MEMORY;
604 temp->resourcetypename = OICStrdup(rt->value);
607 ptr->rsrcType = temp;
611 OCResourceType *type = ptr->rsrcType;
621 OCStringLL *itf = repPayload->setLinks->itf;
624 OCResourceInterface *temp = (OCResourceInterface *) OICCalloc(1, sizeof(OCResourceInterface));
629 return OC_STACK_NO_MEMORY;
632 temp->name = OICStrdup(itf->value);
633 if (!ptr->rsrcInterface)
635 ptr->rsrcInterface = temp;
639 OCResourceInterface *type = ptr->rsrcInterface;
649 ptr->resourceProperties = (OCResourceProperty) repPayload->tags->bitmap;
651 OCFreeCollectionResource(repPayload);
657 OIC_LOG_V(ERROR, TAG, "The resource type or interface type doe not exist \
658 on the resource directory");
660 return OC_STACK_ERROR;
664 static OCStackResult HandleVirtualResource (OCServerRequest *request, OCResource* resource)
666 if (!request || !resource)
668 return OC_STACK_INVALID_PARAM;
671 OCStackResult discoveryResult = OC_STACK_ERROR;
673 bool bMulticast = false; // Was the discovery request a multicast request?
674 OCPayload* payload = NULL;
676 OIC_LOG(INFO, TAG, "Entering HandleVirtualResource");
678 OCVirtualResources virtualUriInRequest = GetTypeOfVirtualURI (request->resourceUrl);
680 // Step 1: Generate the response to discovery request
681 if (virtualUriInRequest == OC_WELL_KNOWN_URI)
683 char *interfaceQuery = NULL;
684 char *resourceTypeQuery = NULL;
686 discoveryResult = getQueryParamsForFiltering (virtualUriInRequest, request->query,
687 &interfaceQuery, &resourceTypeQuery);
688 bool interfaceQueryAllocated = false;
689 if (!interfaceQuery && !resourceTypeQuery)
691 interfaceQueryAllocated = true;
692 interfaceQuery = OICStrdup(OC_RSRVD_INTERFACE_LL);
695 if (discoveryResult == OC_STACK_OK)
697 payload = (OCPayload *)OCDiscoveryPayloadCreate();
701 OCDiscoveryPayload *discPayload = (OCDiscoveryPayload *)payload;
702 discPayload->sid = (char *)OICCalloc(1, UUID_STRING_SIZE);
703 VERIFY_NON_NULL(discPayload->sid, ERROR, OC_STACK_NO_MEMORY);
704 memcpy(discPayload->sid, OCGetServerInstanceIDString(), UUID_STRING_SIZE);
705 if (!resourceTypeQuery && interfaceQuery && (0 == strcmp(interfaceQuery, OC_RSRVD_INTERFACE_LL)))
707 for (; resource && discoveryResult == OC_STACK_OK; resource = resource->next)
710 if (resource->resourceProperties & OC_EXPLICIT_DISCOVERABLE)
712 if (resourceTypeQuery && resourceMatchesRTFilter(resource, resourceTypeQuery))
717 if (resource->resourceProperties & OC_DISCOVERABLE)
724 discoveryResult = BuildVirtualResourceResponse(resource,
725 discPayload, &request->devAddr, false);
731 if ((interfaceQuery && (0 != strcmp(interfaceQuery, OC_RSRVD_INTERFACE_LL))) ||
734 discPayload->uri = OICStrdup(OC_RSRVD_WELL_KNOWN_URI);
735 VERIFY_NON_NULL(discPayload->uri, ERROR, OC_STACK_NO_MEMORY);
736 if (savedDeviceInfo.deviceName)
738 discPayload->name = OICStrdup(savedDeviceInfo.deviceName);
739 VERIFY_NON_NULL(discPayload->name, ERROR, OC_STACK_NO_MEMORY);
741 discPayload->type = OICStrdup(OC_RSRVD_RESOURCE_TYPE_RES);
742 VERIFY_NON_NULL(discPayload->type, ERROR, OC_STACK_NO_MEMORY);
743 OCResourcePayloadAddStringLL(&discPayload->interface, OC_RSRVD_INTERFACE_LL);
744 OCResourcePayloadAddStringLL(&discPayload->interface, OC_RSRVD_INTERFACE_DEFAULT);
745 VERIFY_NON_NULL(discPayload->interface, ERROR, OC_STACK_NO_MEMORY);
747 bool foundResourceAtRD = false;
748 for (;resource && discoveryResult == OC_STACK_OK; resource = resource->next)
751 if (strcmp(resource->uri, OC_RSRVD_RD_URI) == 0)
753 OCResource *resource1 = NULL;
755 discoveryResult = checkResourceExistsAtRD(interfaceQuery,
756 resourceTypeQuery, &resource1, &devAddr);
757 if (discoveryResult != OC_STACK_OK)
761 discoveryResult = BuildVirtualResourceResponse(resource1,
762 discPayload, &devAddr, true);
765 discPayload->baseURI = OICStrdup(devAddr.addr);
767 OICFree(resource1->uri);
768 for (OCResourceType *rsrcRt = resource1->rsrcType, *rsrcRtNext = NULL; rsrcRt; )
770 rsrcRtNext = rsrcRt->next;
771 OICFree(rsrcRt->resourcetypename);
776 for (OCResourceInterface *rsrcPtr = resource1->rsrcInterface, *rsrcNext = NULL; rsrcPtr; )
778 rsrcNext = rsrcPtr->next;
779 OICFree(rsrcPtr->name);
783 foundResourceAtRD = true;
786 if (!foundResourceAtRD && includeThisResourceInResponse(resource, interfaceQuery, resourceTypeQuery))
788 discoveryResult = BuildVirtualResourceResponse(resource,
789 discPayload, &request->devAddr, false);
792 // Set discoveryResult appropriately if no 'valid' resources are available
793 if (discPayload->resources == NULL && !foundResourceAtRD)
795 discoveryResult = OC_STACK_NO_RESOURCE;
801 discoveryResult = OC_STACK_NO_MEMORY;
806 OIC_LOG_V(ERROR, TAG, "Error (%d) parsing query.", discoveryResult);
808 if (interfaceQueryAllocated)
810 OICFree(interfaceQuery);
813 else if (virtualUriInRequest == OC_DEVICE_URI)
815 const char* deviceId = OCGetServerInstanceIDString();
818 discoveryResult = OC_STACK_ERROR;
822 payload = (OCPayload*) OCDevicePayloadCreate(deviceId, savedDeviceInfo.deviceName,
823 savedDeviceInfo.types, OC_SPEC_VERSION, OC_DATA_MODEL_VERSION);
826 discoveryResult = OC_STACK_NO_MEMORY;
830 discoveryResult = OC_STACK_OK;
834 else if (virtualUriInRequest == OC_PLATFORM_URI)
836 payload = (OCPayload*)OCPlatformPayloadCreate(&savedPlatformInfo);
839 discoveryResult = OC_STACK_NO_MEMORY;
843 discoveryResult = OC_STACK_OK;
846 #ifdef ROUTING_GATEWAY
847 else if (OC_GATEWAY_URI == virtualUriInRequest)
849 // Received request for a gateway
850 OIC_LOG(INFO, TAG, "Request is for Gateway Virtual Request");
851 discoveryResult = RMHandleGatewayRequest(request, resource);
857 * Step 2: Send the discovery response
859 * Iotivity should respond to discovery requests in below manner:
860 * 1)If query filter matching fails and discovery request is multicast,
861 * it should NOT send any response.
862 * 2)If query filter matching fails and discovery request is unicast,
863 * it should send an error(RESOURCE_NOT_FOUND - 404) response.
864 * 3)If Server does not have any 'DISCOVERABLE' resources and discovery
865 * request is multicast, it should NOT send any response.
866 * 4)If Server does not have any 'DISCOVERABLE' resources and discovery
867 * request is unicast, it should send an error(RESOURCE_NOT_FOUND - 404) response.
871 if ((virtualUriInRequest == OC_PRESENCE) &&
872 (resource->resourceProperties & OC_ACTIVE))
874 // Presence uses observer notification api to respond via SendPresenceNotification.
875 SendPresenceNotification(resource->rsrcType, OC_PRESENCE_TRIGGER_CHANGE);
879 #ifdef ROUTING_GATEWAY
880 // Gateway uses the RMHandleGatewayRequest to respond to the request.
881 if (OC_GATEWAY_URI != virtualUriInRequest)
884 if(discoveryResult == OC_STACK_OK)
886 SendNonPersistantDiscoveryResponse(request, resource, payload, OC_EH_OK);
888 else if(bMulticast == false && (request->devAddr.adapter != OC_ADAPTER_RFCOMM_BTEDR) &&
889 (request->devAddr.adapter != OC_ADAPTER_GATT_BTLE))
891 OIC_LOG_V(ERROR, TAG, "Sending a (%d) error to (%d) \
892 discovery request", discoveryResult, virtualUriInRequest);
893 SendNonPersistantDiscoveryResponse(request, resource, NULL,
894 (discoveryResult == OC_STACK_NO_RESOURCE) ? OC_EH_RESOURCE_NOT_FOUND : OC_EH_ERROR);
898 // Ignoring the discovery request as per RFC 7252, Section #8.2
899 OIC_LOG(INFO, TAG, "Silently ignoring the request since device does not have \
900 any useful data to send");
904 OCPayloadDestroy(payload);
910 HandleDefaultDeviceEntityHandler (OCServerRequest *request)
914 return OC_STACK_INVALID_PARAM;
917 OCStackResult result = OC_STACK_OK;
918 OCEntityHandlerResult ehResult = OC_EH_ERROR;
919 OCEntityHandlerRequest ehRequest = {0};
921 OIC_LOG(INFO, TAG, "Entering HandleResourceWithDefaultDeviceEntityHandler");
922 result = FormOCEntityHandlerRequest(&ehRequest,
923 (OCRequestHandle) request,
926 (OCResourceHandle) NULL, request->query,
927 PAYLOAD_TYPE_REPRESENTATION,
929 request->payloadSize,
930 request->numRcvdVendorSpecificHeaderOptions,
931 request->rcvdVendorSpecificHeaderOptions,
932 (OCObserveAction)request->observationOption,
934 VERIFY_SUCCESS(result, OC_STACK_OK);
936 // At this point we know for sure that defaultDeviceHandler exists
937 ehResult = defaultDeviceHandler(OC_REQUEST_FLAG, &ehRequest,
938 (char*) request->resourceUrl, defaultDeviceHandlerCallbackParameter);
939 if(ehResult == OC_EH_SLOW)
941 OIC_LOG(INFO, TAG, "This is a slow resource");
942 request->slowFlag = 1;
944 else if(ehResult == OC_EH_ERROR)
946 FindAndDeleteServerRequest(request);
948 result = EntityHandlerCodeToOCStackCode(ehResult);
950 OCPayloadDestroy(ehRequest.payload);
955 HandleResourceWithEntityHandler (OCServerRequest *request,
956 OCResource *resource,
957 uint8_t collectionResource)
959 if(!request || ! resource)
961 return OC_STACK_INVALID_PARAM;
964 OCStackResult result = OC_STACK_ERROR;
965 OCEntityHandlerResult ehResult = OC_EH_ERROR;
966 OCEntityHandlerFlag ehFlag = OC_REQUEST_FLAG;
967 ResourceObserver *resObs = NULL;
969 OCEntityHandlerRequest ehRequest = {0};
971 OIC_LOG(INFO, TAG, "Entering HandleResourceWithEntityHandler");
972 OCPayloadType type = PAYLOAD_TYPE_REPRESENTATION;
973 // check the security resource
974 if (request && request->resourceUrl && SRMIsSecurityResourceURI(request->resourceUrl))
976 type = PAYLOAD_TYPE_SECURITY;
980 if (request && strcmp(request->resourceUrl, OC_RSRVD_RD_URI) == 0)
982 type = PAYLOAD_TYPE_RD;
985 result = FormOCEntityHandlerRequest(&ehRequest,
986 (OCRequestHandle)request,
989 (OCResourceHandle)resource,
993 request->payloadSize,
994 request->numRcvdVendorSpecificHeaderOptions,
995 request->rcvdVendorSpecificHeaderOptions,
996 (OCObserveAction)request->observationOption,
998 VERIFY_SUCCESS(result, OC_STACK_OK);
1000 if(ehRequest.obsInfo.action == OC_OBSERVE_NO_OPTION)
1002 OIC_LOG(INFO, TAG, "No observation requested");
1003 ehFlag = OC_REQUEST_FLAG;
1005 else if(ehRequest.obsInfo.action == OC_OBSERVE_REGISTER && !collectionResource)
1007 OIC_LOG(INFO, TAG, "Observation registration requested");
1009 ResourceObserver *obs = GetObserverUsingToken (request->requestToken,
1010 request->tokenLength);
1014 OIC_LOG (INFO, TAG, "Observer with this token already present");
1015 OIC_LOG (INFO, TAG, "Possibly re-transmitted CON OBS request");
1016 OIC_LOG (INFO, TAG, "Not adding observer. Not responding to client");
1017 OIC_LOG (INFO, TAG, "The first request for this token is already ACKED.");
1019 // server requests are usually free'd when the response is sent out
1020 // for the request in ocserverrequest.c : HandleSingleResponse()
1021 // Since we are making an early return and not responding, the server request
1022 // needs to be deleted.
1023 FindAndDeleteServerRequest (request);
1027 result = GenerateObserverId(&ehRequest.obsInfo.obsId);
1028 VERIFY_SUCCESS(result, OC_STACK_OK);
1030 result = AddObserver ((const char*)(request->resourceUrl),
1031 (const char *)(request->query),
1032 ehRequest.obsInfo.obsId, request->requestToken, request->tokenLength,
1033 resource, request->qos, request->acceptFormat,
1036 if(result == OC_STACK_OK)
1038 OIC_LOG(INFO, TAG, "Added observer successfully");
1039 request->observeResult = OC_STACK_OK;
1040 ehFlag = (OCEntityHandlerFlag)(OC_REQUEST_FLAG | OC_OBSERVE_FLAG);
1044 result = OC_STACK_OK;
1046 // The error in observeResult for the request will be used when responding to this
1047 // request by omitting the observation option/sequence number.
1048 request->observeResult = OC_STACK_ERROR;
1049 OIC_LOG(ERROR, TAG, "Observer Addition failed");
1050 ehFlag = OC_REQUEST_FLAG;
1054 else if(ehRequest.obsInfo.action == OC_OBSERVE_DEREGISTER &&
1055 !collectionResource)
1057 OIC_LOG(INFO, TAG, "Deregistering observation requested");
1059 resObs = GetObserverUsingToken (request->requestToken, request->tokenLength);
1063 // Stack does not contain this observation request
1064 // Either token is incorrect or observation list is corrupted
1065 result = OC_STACK_ERROR;
1068 ehRequest.obsInfo.obsId = resObs->observeId;
1069 ehFlag = (OCEntityHandlerFlag)(ehFlag | OC_OBSERVE_FLAG);
1071 result = DeleteObserverUsingToken (request->requestToken, request->tokenLength);
1073 if(result == OC_STACK_OK)
1075 OIC_LOG(INFO, TAG, "Removed observer successfully");
1076 request->observeResult = OC_STACK_OK;
1080 result = OC_STACK_OK;
1081 request->observeResult = OC_STACK_ERROR;
1082 OIC_LOG(ERROR, TAG, "Observer Removal failed");
1087 result = OC_STACK_ERROR;
1091 ehResult = resource->entityHandler(ehFlag, &ehRequest, resource->entityHandlerCallbackParam);
1092 if(ehResult == OC_EH_SLOW)
1094 OIC_LOG(INFO, TAG, "This is a slow resource");
1095 request->slowFlag = 1;
1097 else if(ehResult == OC_EH_ERROR)
1099 FindAndDeleteServerRequest(request);
1101 result = EntityHandlerCodeToOCStackCode(ehResult);
1103 OCPayloadDestroy(ehRequest.payload);
1107 static OCStackResult
1108 HandleCollectionResourceDefaultEntityHandler (OCServerRequest *request,
1109 OCResource *resource)
1111 if(!request || !resource)
1113 return OC_STACK_INVALID_PARAM;
1116 OCStackResult result = OC_STACK_ERROR;
1117 OCEntityHandlerRequest ehRequest = {0};
1119 result = FormOCEntityHandlerRequest(&ehRequest,
1120 (OCRequestHandle)request,
1123 (OCResourceHandle)resource,
1125 PAYLOAD_TYPE_REPRESENTATION,
1127 request->payloadSize,
1128 request->numRcvdVendorSpecificHeaderOptions,
1129 request->rcvdVendorSpecificHeaderOptions,
1130 (OCObserveAction)request->observationOption,
1131 (OCObservationId)0);
1132 if(result == OC_STACK_OK)
1134 result = DefaultCollectionEntityHandler (OC_REQUEST_FLAG, &ehRequest);
1137 OCPayloadDestroy(ehRequest.payload);
1142 ProcessRequest(ResourceHandling resHandling, OCResource *resource, OCServerRequest *request)
1144 OCStackResult ret = OC_STACK_OK;
1146 switch (resHandling)
1148 case OC_RESOURCE_VIRTUAL:
1150 ret = HandleVirtualResource (request, resource);
1153 case OC_RESOURCE_DEFAULT_DEVICE_ENTITYHANDLER:
1155 ret = HandleDefaultDeviceEntityHandler(request);
1158 case OC_RESOURCE_NOT_COLLECTION_DEFAULT_ENTITYHANDLER:
1160 OIC_LOG(INFO, TAG, "OC_RESOURCE_NOT_COLLECTION_DEFAULT_ENTITYHANDLER");
1161 return OC_STACK_ERROR;
1163 case OC_RESOURCE_NOT_COLLECTION_WITH_ENTITYHANDLER:
1165 ret = HandleResourceWithEntityHandler (request, resource, 0);
1168 case OC_RESOURCE_COLLECTION_WITH_ENTITYHANDLER:
1170 ret = HandleResourceWithEntityHandler (request, resource, 1);
1173 case OC_RESOURCE_COLLECTION_DEFAULT_ENTITYHANDLER:
1175 ret = HandleCollectionResourceDefaultEntityHandler (request, resource);
1178 case OC_RESOURCE_NOT_SPECIFIED:
1180 ret = OC_STACK_NO_RESOURCE;
1185 OIC_LOG(INFO, TAG, "Invalid Resource Determination");
1186 return OC_STACK_ERROR;
1192 void DeletePlatformInfo()
1194 OIC_LOG(INFO, TAG, "Deleting platform info.");
1196 OICFree(savedPlatformInfo.platformID);
1197 savedPlatformInfo.platformID = NULL;
1199 OICFree(savedPlatformInfo.manufacturerName);
1200 savedPlatformInfo.manufacturerName = NULL;
1202 OICFree(savedPlatformInfo.manufacturerUrl);
1203 savedPlatformInfo.manufacturerUrl = NULL;
1205 OICFree(savedPlatformInfo.modelNumber);
1206 savedPlatformInfo.modelNumber = NULL;
1208 OICFree(savedPlatformInfo.dateOfManufacture);
1209 savedPlatformInfo.dateOfManufacture = NULL;
1211 OICFree(savedPlatformInfo.platformVersion);
1212 savedPlatformInfo.platformVersion = NULL;
1214 OICFree(savedPlatformInfo.operatingSystemVersion);
1215 savedPlatformInfo.operatingSystemVersion = NULL;
1217 OICFree(savedPlatformInfo.hardwareVersion);
1218 savedPlatformInfo.hardwareVersion = NULL;
1220 OICFree(savedPlatformInfo.firmwareVersion);
1221 savedPlatformInfo.firmwareVersion = NULL;
1223 OICFree(savedPlatformInfo.supportUrl);
1224 savedPlatformInfo.supportUrl = NULL;
1226 OICFree(savedPlatformInfo.systemTime);
1227 savedPlatformInfo.systemTime = NULL;
1230 static OCStackResult DeepCopyPlatFormInfo(OCPlatformInfo info)
1232 savedPlatformInfo.platformID = OICStrdup(info.platformID);
1233 savedPlatformInfo.manufacturerName = OICStrdup(info.manufacturerName);
1234 savedPlatformInfo.manufacturerUrl = OICStrdup(info.manufacturerUrl);
1235 savedPlatformInfo.modelNumber = OICStrdup(info.modelNumber);
1236 savedPlatformInfo.dateOfManufacture = OICStrdup(info.dateOfManufacture);
1237 savedPlatformInfo.platformVersion = OICStrdup(info.platformVersion);
1238 savedPlatformInfo.operatingSystemVersion = OICStrdup(info.operatingSystemVersion);
1239 savedPlatformInfo.hardwareVersion = OICStrdup(info.hardwareVersion);
1240 savedPlatformInfo.firmwareVersion = OICStrdup(info.firmwareVersion);
1241 savedPlatformInfo.supportUrl = OICStrdup(info.supportUrl);
1242 savedPlatformInfo.systemTime = OICStrdup(info.systemTime);
1244 if ((!savedPlatformInfo.platformID && info.platformID)||
1245 (!savedPlatformInfo.manufacturerName && info.manufacturerName)||
1246 (!savedPlatformInfo.manufacturerUrl && info.manufacturerUrl)||
1247 (!savedPlatformInfo.modelNumber && info.modelNumber)||
1248 (!savedPlatformInfo.dateOfManufacture && info.dateOfManufacture)||
1249 (!savedPlatformInfo.platformVersion && info.platformVersion)||
1250 (!savedPlatformInfo.operatingSystemVersion && info.operatingSystemVersion)||
1251 (!savedPlatformInfo.hardwareVersion && info.hardwareVersion)||
1252 (!savedPlatformInfo.firmwareVersion && info.firmwareVersion)||
1253 (!savedPlatformInfo.supportUrl && info.supportUrl)||
1254 (!savedPlatformInfo.systemTime && info.systemTime))
1256 DeletePlatformInfo();
1257 return OC_STACK_INVALID_PARAM;
1264 OCStackResult SavePlatformInfo(OCPlatformInfo info)
1266 DeletePlatformInfo();
1268 OCStackResult res = DeepCopyPlatFormInfo(info);
1270 if (res != OC_STACK_OK)
1272 OIC_LOG_V(ERROR, TAG, "Failed to save platform info. errno(%d)", res);
1276 OIC_LOG(INFO, TAG, "Platform info saved.");
1282 void DeleteDeviceInfo()
1284 OIC_LOG(INFO, TAG, "Deleting device info.");
1286 OICFree(savedDeviceInfo.deviceName);
1287 OCFreeOCStringLL(savedDeviceInfo.types);
1288 savedDeviceInfo.deviceName = NULL;
1292 static OCStackResult DeepCopyDeviceInfo(OCDeviceInfo info)
1294 savedDeviceInfo.deviceName = OICStrdup(info.deviceName);
1296 if(!savedDeviceInfo.deviceName && info.deviceName)
1299 return OC_STACK_NO_MEMORY;
1304 savedDeviceInfo.types = CloneOCStringLL(info.types);
1305 if(!savedDeviceInfo.types && info.types)
1308 return OC_STACK_NO_MEMORY;
1314 OCStackResult SaveDeviceInfo(OCDeviceInfo info)
1316 OCStackResult res = OC_STACK_OK;
1320 res = DeepCopyDeviceInfo(info);
1322 VERIFY_SUCCESS(res, OC_STACK_OK);
1324 if (OCGetServerInstanceIDString() == NULL)
1326 OIC_LOG(INFO, TAG, "Device ID generation failed");
1327 res = OC_STACK_ERROR;
1331 OIC_LOG(INFO, TAG, "Device initialized successfully.");