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
29 #include "ocresource.h"
30 #include "ocresourcehandler.h"
31 #include "ocobserve.h"
32 #include "occollection.h"
33 #include "oic_malloc.h"
34 #include "oic_string.h"
37 #include "ocpayload.h"
38 #include "secureresourcemanager.h"
40 #include "cainterface.h"
41 #include "rdpayload.h"
42 #include "ocpayload.h"
45 #include "rd_server.h"
48 #ifdef ROUTING_GATEWAY
49 #include "routingmanager.h"
53 #define TAG "OIC_RI_RESOURCE"
55 #define VERIFY_SUCCESS(op, successCode) { if (op != successCode) \
56 {OIC_LOG_V(FATAL, TAG, "%s failed!!", #op); goto exit;} }
58 #define VERIFY_NON_NULL(arg, logLevel, retVal) { if (!(arg)) { OIC_LOG((logLevel), \
59 TAG, #arg " is NULL"); return (retVal); } }
61 extern OCResource *headResource;
62 static OCPlatformInfo savedPlatformInfo = {0};
63 static OCDeviceInfo savedDeviceInfo = {0};
66 * Prepares a Payload for response.
68 static OCStackResult BuildVirtualResourceResponse(const OCResource *resourcePtr,
69 OCDiscoveryPayload* payload,
73 //-----------------------------------------------------------------------------
74 // Default resource entity handler function
75 //-----------------------------------------------------------------------------
76 OCEntityHandlerResult defaultResourceEHandler(OCEntityHandlerFlag flag,
77 OCEntityHandlerRequest * request, void* callbackParam)
79 //TODO ("Implement me!!!!");
80 // TODO: remove silence unused param warnings
84 return OC_EH_OK; // Making sure that the Default EH and the Vendor EH have matching signatures
87 /* This method will retrieve the port at which the secure resource is hosted */
88 static OCStackResult GetSecurePortInfo(OCDevAddr *endpoint, uint16_t *port)
92 if (endpoint->adapter == OC_ADAPTER_IP)
94 if (endpoint->flags & OC_IP_USE_V6)
96 p = caglobals.ip.u6s.port;
98 else if (endpoint->flags & OC_IP_USE_V4)
100 p = caglobals.ip.u4s.port;
109 * Function will extract 0, 1 or 2 filters from query.
110 * More than 2 filters or unsupported filters will result in error.
111 * If both filters are of the same supported type, the 2nd one will be picked.
112 * Resource and device filters in the SAME query are NOT validated
113 * and resources will likely not clear filters.
115 static OCStackResult ExtractFiltersFromQuery(char *query, char **filterOne, char **filterTwo)
120 char *restOfQuery = NULL;
121 int numKeyValuePairsParsed = 0;
126 OIC_LOG_V(INFO, TAG, "Extracting params from %s", query);
128 char *keyValuePair = strtok_r (query, OC_QUERY_SEPARATOR, &restOfQuery);
132 if (numKeyValuePairsParsed >= 2)
134 OIC_LOG(ERROR, TAG, "More than 2 queries params in URI.");
135 return OC_STACK_INVALID_QUERY;
138 key = strtok_r(keyValuePair, OC_KEY_VALUE_DELIMITER, &value);
142 return OC_STACK_INVALID_QUERY;
144 else if (strcmp (key, OC_RSRVD_INTERFACE) == 0)
146 *filterOne = value; // if
148 else if (strcmp (key, OC_RSRVD_RESOURCE_TYPE) == 0)
150 *filterTwo = value; // rt
154 OIC_LOG_V(ERROR, TAG, "Unsupported query key: %s", key);
155 return OC_STACK_INVALID_QUERY;
157 ++numKeyValuePairsParsed;
159 keyValuePair = strtok_r(NULL, OC_QUERY_SEPARATOR, &restOfQuery);
162 OIC_LOG_V(INFO, TAG, "Extracted params %s and %s.", *filterOne, *filterTwo);
166 static OCVirtualResources GetTypeOfVirtualURI(const char *uriInRequest)
168 if (strcmp(uriInRequest, OC_RSRVD_WELL_KNOWN_URI) == 0)
170 return OC_WELL_KNOWN_URI;
172 else if (strcmp(uriInRequest, OC_RSRVD_DEVICE_URI) == 0)
174 return OC_DEVICE_URI;
176 else if (strcmp(uriInRequest, OC_RSRVD_PLATFORM_URI) == 0)
178 return OC_PLATFORM_URI;
180 else if (strcmp(uriInRequest, OC_RSRVD_RESOURCE_TYPES_URI) == 0)
182 return OC_RESOURCE_TYPES_URI;
184 #ifdef ROUTING_GATEWAY
185 else if (0 == strcmp(uriInRequest, OC_RSRVD_GATEWAY_URI))
187 return OC_GATEWAY_URI;
191 else if (strcmp(uriInRequest, OC_RSRVD_PRESENCE_URI) == 0)
195 #endif //WITH_PRESENCE
196 return OC_UNKNOWN_URI;
199 static OCStackResult getQueryParamsForFiltering (OCVirtualResources uri, char *query,
200 char **filterOne, char **filterTwo)
202 if(!filterOne || !filterTwo)
204 return OC_STACK_INVALID_PARAM;
211 if (uri == OC_PRESENCE)
213 //Nothing needs to be done, except for pass a OC_PRESENCE query through as OC_STACK_OK.
214 OIC_LOG(INFO, TAG, "OC_PRESENCE Request for virtual resource.");
219 OCStackResult result = OC_STACK_OK;
223 result = ExtractFiltersFromQuery(query, filterOne, filterTwo);
229 OCStackResult BuildResponseRepresentation(const OCResource *resourcePtr,
230 OCRepPayload** payload)
232 OCRepPayload *tempPayload = OCRepPayloadCreate();
236 OCRepPayloadDestroy(tempPayload);
237 return OC_STACK_INVALID_PARAM;
242 return OC_STACK_NO_MEMORY;
245 OCRepPayloadSetUri(tempPayload, resourcePtr->uri);
247 OCResourceType *resType = resourcePtr->rsrcType;
250 OCRepPayloadAddResourceType(tempPayload, resType->resourcetypename);
251 resType = resType->next;
254 OCResourceInterface *resInterface = resourcePtr->rsrcInterface;
257 OCRepPayloadAddInterface(tempPayload, resInterface->name);
258 resInterface = resInterface->next;
261 OCAttribute *resAttrib = resourcePtr->rsrcAttributes;
264 OCRepPayloadSetPropString(tempPayload, resAttrib->attrName,
265 resAttrib->attrValue);
266 resAttrib = resAttrib->next;
271 *payload = tempPayload;
275 OCRepPayloadAppend(*payload, tempPayload);
281 OCStackResult BuildVirtualResourceResponse(const OCResource *resourcePtr,
282 OCDiscoveryPayload *payload, OCDevAddr *devAddr, bool rdResponse)
284 if (!resourcePtr || !payload)
286 return OC_STACK_INVALID_PARAM;
289 if (resourcePtr->resourceProperties & OC_SECURE)
291 if (GetSecurePortInfo(devAddr, &port) != OC_STACK_OK)
299 port = devAddr->port;
302 OCDiscoveryPayloadAddResource(payload, resourcePtr, port);
306 uint8_t IsCollectionResource (OCResource *resource)
313 if(resource->rsrcChildResourcesHead != NULL)
321 OCResource *FindResourceByUri(const char* resourceUri)
328 OCResource * pointer = headResource;
331 if (strcmp(resourceUri, pointer->uri) == 0)
335 pointer = pointer->next;
337 OIC_LOG_V(INFO, TAG, "Resource %s not found", resourceUri);
342 OCStackResult DetermineResourceHandling (const OCServerRequest *request,
343 ResourceHandling *handling,
344 OCResource **resource)
346 if(!request || !handling || !resource)
348 return OC_STACK_INVALID_PARAM;
351 OIC_LOG_V(INFO, TAG, "DetermineResourceHandling for %s", request->resourceUrl);
353 // Check if virtual resource
354 if (GetTypeOfVirtualURI(request->resourceUrl) != OC_UNKNOWN_URI)
356 OIC_LOG_V (INFO, TAG, "%s is virtual", request->resourceUrl);
357 *handling = OC_RESOURCE_VIRTUAL;
358 *resource = headResource;
361 if (strlen((const char*)(request->resourceUrl)) == 0)
363 // Resource URL not specified
364 *handling = OC_RESOURCE_NOT_SPECIFIED;
365 return OC_STACK_NO_RESOURCE;
369 OCResource *resourcePtr = FindResourceByUri((const char*)request->resourceUrl);
370 *resource = resourcePtr;
373 if(defaultDeviceHandler)
375 *handling = OC_RESOURCE_DEFAULT_DEVICE_ENTITYHANDLER;
379 // Resource does not exist
380 // and default device handler does not exist
381 *handling = OC_RESOURCE_NOT_SPECIFIED;
382 return OC_STACK_NO_RESOURCE;
385 if (IsCollectionResource (resourcePtr))
387 // Collection resource
388 if (resourcePtr->entityHandler != defaultResourceEHandler)
390 *handling = OC_RESOURCE_COLLECTION_WITH_ENTITYHANDLER;
395 *handling = OC_RESOURCE_COLLECTION_DEFAULT_ENTITYHANDLER;
401 // Resource not a collection
402 if (resourcePtr->entityHandler != defaultResourceEHandler)
404 *handling = OC_RESOURCE_NOT_COLLECTION_WITH_ENTITYHANDLER;
409 *handling = OC_RESOURCE_NOT_COLLECTION_DEFAULT_ENTITYHANDLER;
416 OCStackResult EntityHandlerCodeToOCStackCode(OCEntityHandlerResult ehResult)
418 OCStackResult result;
423 result = OC_STACK_OK;
426 result = OC_STACK_SLOW_RESOURCE;
429 result = OC_STACK_ERROR;
431 case OC_EH_FORBIDDEN:
432 result = OC_STACK_RESOURCE_ERROR;
434 case OC_EH_RESOURCE_CREATED:
435 result = OC_STACK_RESOURCE_CREATED;
437 case OC_EH_RESOURCE_DELETED:
438 result = OC_STACK_RESOURCE_DELETED;
440 case OC_EH_RESOURCE_NOT_FOUND:
441 result = OC_STACK_NO_RESOURCE;
444 result = OC_STACK_ERROR;
450 static bool resourceMatchesRTFilter(OCResource *resource, char *resourceTypeFilter)
457 // Null or empty is analogous to no filter.
458 if (resourceTypeFilter == NULL || *resourceTypeFilter == 0)
463 OCResourceType *resourceTypePtr = resource->rsrcType;
465 while (resourceTypePtr)
467 if (strcmp (resourceTypePtr->resourcetypename, resourceTypeFilter) == 0)
471 resourceTypePtr = resourceTypePtr->next;
474 OIC_LOG_V(INFO, TAG, "%s does not contain rt=%s.", resource->uri, resourceTypeFilter);
478 static bool resourceMatchesIFFilter(OCResource *resource, char *interfaceFilter)
485 // Null or empty is analogous to no filter.
486 if (interfaceFilter == NULL || *interfaceFilter == 0)
491 OCResourceInterface *interfacePtr = resource->rsrcInterface;
495 if (strcmp (interfacePtr->name, interfaceFilter) == 0)
499 interfacePtr = interfacePtr->next;
502 OIC_LOG_V(INFO, TAG, "%s does not contain if=%s.", resource->uri, interfaceFilter);
507 * If the filters are null, they will be assumed to NOT be present
508 * and the resource will not be matched against them.
509 * Function will return true if all non null AND non empty filters passed in find a match.
511 static bool includeThisResourceInResponse(OCResource *resource,
512 char *interfaceFilter,
513 char *resourceTypeFilter)
517 OIC_LOG(ERROR, TAG, "Invalid resource");
521 if ( resource->resourceProperties & OC_EXPLICIT_DISCOVERABLE)
524 * At least one valid filter should be available to
525 * include the resource in discovery response
527 if (!((interfaceFilter && *interfaceFilter ) ||
528 (resourceTypeFilter && *resourceTypeFilter)))
530 OIC_LOG_V(INFO, TAG, "%s no query string for EXPLICIT_DISCOVERABLE \
531 resource", resource->uri);
535 else if ( !(resource->resourceProperties & OC_ACTIVE) ||
536 !(resource->resourceProperties & OC_DISCOVERABLE))
538 OIC_LOG_V(INFO, TAG, "%s not ACTIVE or DISCOVERABLE", resource->uri);
542 return resourceMatchesIFFilter(resource, interfaceFilter) &&
543 resourceMatchesRTFilter(resource, resourceTypeFilter);
547 OCStackResult SendNonPersistantDiscoveryResponse(OCServerRequest *request, OCResource *resource,
548 OCPayload *discoveryPayload, OCEntityHandlerResult ehResult)
550 OCEntityHandlerResponse response = {0};
552 response.ehResult = ehResult;
553 response.payload = discoveryPayload;
554 response.persistentBufferFlag = 0;
555 response.requestHandle = (OCRequestHandle) request;
556 response.resourceHandle = (OCResourceHandle) resource;
558 return OCDoResponse(&response);
562 static OCStackResult checkResourceExistsAtRD(const char *interfaceType, const char *resourceType,
563 OCResource **payload, OCDevAddr *devAddr)
565 OCResourceCollectionPayload *repPayload;
568 return OC_STACK_ERROR;
570 if (OCRDCheckPublishedResource(interfaceType, resourceType, &repPayload, devAddr) == OC_STACK_OK)
574 return OC_STACK_ERROR;
576 OCResource *ptr = ((OCResource *) OICCalloc(1, sizeof(OCResource)));
579 return OC_STACK_NO_MEMORY;
582 ptr->uri = OICStrdup(repPayload->setLinks->href);
585 return OC_STACK_NO_MEMORY;
587 OCStringLL *rt = repPayload->setLinks->rt;
590 OCResourceType *temp = (OCResourceType *) OICCalloc(1, sizeof(OCResourceType));
594 return OC_STACK_NO_MEMORY;
597 temp->resourcetypename = OICStrdup(rt->value);
600 ptr->rsrcType = temp;
604 OCResourceType *type = ptr->rsrcType;
614 OCStringLL *itf = repPayload->setLinks->itf;
617 OCResourceInterface *temp = (OCResourceInterface *) OICCalloc(1, sizeof(OCResourceInterface));
622 return OC_STACK_NO_MEMORY;
625 temp->name = OICStrdup(itf->value);
626 if (!ptr->rsrcInterface)
628 ptr->rsrcInterface = temp;
632 OCResourceInterface *type = ptr->rsrcInterface;
642 ptr->resourceProperties = (OCResourceProperty) repPayload->tags->bitmap;
644 OCFreeCollectionResource(repPayload);
650 OIC_LOG_V(ERROR, TAG, "The resource type or interface type doe not exist \
651 on the resource directory");
653 return OC_STACK_ERROR;
657 static OCStackResult HandleVirtualResource (OCServerRequest *request, OCResource* resource)
659 if (!request || !resource)
661 return OC_STACK_INVALID_PARAM;
664 OCStackResult discoveryResult = OC_STACK_ERROR;
666 bool bMulticast = false; // Was the discovery request a multicast request?
667 OCPayload* payload = NULL;
669 OIC_LOG(INFO, TAG, "Entering HandleVirtualResource");
671 OCVirtualResources virtualUriInRequest = GetTypeOfVirtualURI (request->resourceUrl);
673 // Step 1: Generate the response to discovery request
674 if (virtualUriInRequest == OC_WELL_KNOWN_URI)
676 char *interfaceQuery = NULL;
677 char *resourceTypeQuery = NULL;
679 discoveryResult = getQueryParamsForFiltering (virtualUriInRequest, request->query,
680 &interfaceQuery, &resourceTypeQuery);
682 if (discoveryResult == OC_STACK_OK)
684 payload = (OCPayload *)OCDiscoveryPayloadCreate();
688 ((OCDiscoveryPayload*)payload)->sid = (char *)OICCalloc(1, UUID_STRING_SIZE);
689 VERIFY_NON_NULL(((OCDiscoveryPayload*)payload)->sid, ERROR, OC_STACK_NO_MEMORY);
690 memcpy(((OCDiscoveryPayload*)payload)->sid, OCGetServerInstanceIDString(), UUID_STRING_SIZE);
692 if (interfaceQuery && 0 == strcmp(OC_RSRVD_INTERFACE_LL, interfaceQuery))
694 for (; resource && discoveryResult == OC_STACK_OK; resource = resource->next)
696 discoveryResult = BuildVirtualResourceResponse(resource,
697 (OCDiscoveryPayload *)payload, &request->devAddr, false);
702 bool foundResourceAtRD = false;
703 for (;resource && discoveryResult == OC_STACK_OK; resource = resource->next)
706 if (strcmp(resource->uri, OC_RSRVD_RD_URI) == 0)
708 OCResource *resource1 = NULL;
710 discoveryResult = checkResourceExistsAtRD(interfaceQuery,
711 resourceTypeQuery, &resource1, &devAddr);
712 if (discoveryResult != OC_STACK_OK)
716 discoveryResult = BuildVirtualResourceResponse(resource1,
717 (OCDiscoveryPayload*)payload, &devAddr, true);
720 ((OCDiscoveryPayload*)payload)->baseURI = OICStrdup(devAddr.addr);
722 OCDiscoveryResourceDestroy(resource1);
723 foundResourceAtRD = true;
726 if (!foundResourceAtRD && includeThisResourceInResponse(resource, interfaceQuery, resourceTypeQuery))
728 discoveryResult = BuildVirtualResourceResponse(resource,
729 (OCDiscoveryPayload*)payload, &request->devAddr, false);
732 // Set discoveryResult appropriately if no 'valid' resources are available
733 if (((OCDiscoveryPayload*)payload)->resources == NULL && !foundResourceAtRD)
735 discoveryResult = OC_STACK_NO_RESOURCE;
741 discoveryResult = OC_STACK_NO_MEMORY;
746 OIC_LOG_V(ERROR, TAG, "Error (%d) parsing query.", discoveryResult);
749 else if (virtualUriInRequest == OC_DEVICE_URI)
751 const char* deviceId = OCGetServerInstanceIDString();
754 discoveryResult = OC_STACK_ERROR;
758 payload = (OCPayload*) OCDevicePayloadCreate(deviceId, savedDeviceInfo.deviceName,
759 savedDeviceInfo.types, OC_SPEC_VERSION, OC_DATA_MODEL_VERSION);
762 discoveryResult = OC_STACK_NO_MEMORY;
766 discoveryResult = OC_STACK_OK;
770 else if (virtualUriInRequest == OC_PLATFORM_URI)
772 payload = (OCPayload*)OCPlatformPayloadCreate(&savedPlatformInfo);
775 discoveryResult = OC_STACK_NO_MEMORY;
779 discoveryResult = OC_STACK_OK;
782 #ifdef ROUTING_GATEWAY
783 else if (OC_GATEWAY_URI == virtualUriInRequest)
785 // Received request for a gateway
786 OIC_LOG(INFO, TAG, "Request is for Gateway Virtual Request");
787 discoveryResult = RMHandleGatewayRequest(request, resource);
793 * Step 2: Send the discovery response
795 * Iotivity should respond to discovery requests in below manner:
796 * 1)If query filter matching fails and discovery request is multicast,
797 * it should NOT send any response.
798 * 2)If query filter matching fails and discovery request is unicast,
799 * it should send an error(RESOURCE_NOT_FOUND - 404) response.
800 * 3)If Server does not have any 'DISCOVERABLE' resources and discovery
801 * request is multicast, it should NOT send any response.
802 * 4)If Server does not have any 'DISCOVERABLE' resources and discovery
803 * request is unicast, it should send an error(RESOURCE_NOT_FOUND - 404) response.
807 if ((virtualUriInRequest == OC_PRESENCE) &&
808 (resource->resourceProperties & OC_ACTIVE))
810 // Presence uses observer notification api to respond via SendPresenceNotification.
811 SendPresenceNotification(resource->rsrcType, OC_PRESENCE_TRIGGER_CHANGE);
815 #ifdef ROUTING_GATEWAY
816 // Gateway uses the RMHandleGatewayRequest to respond to the request.
817 if (OC_GATEWAY_URI != virtualUriInRequest)
820 if(discoveryResult == OC_STACK_OK)
822 SendNonPersistantDiscoveryResponse(request, resource, payload, OC_EH_OK);
824 else if(bMulticast == false && (request->devAddr.adapter != OC_ADAPTER_RFCOMM_BTEDR) &&
825 (request->devAddr.adapter != OC_ADAPTER_GATT_BTLE))
827 OIC_LOG_V(ERROR, TAG, "Sending a (%d) error to (%d) \
828 discovery request", discoveryResult, virtualUriInRequest);
829 SendNonPersistantDiscoveryResponse(request, resource, NULL,
830 (discoveryResult == OC_STACK_NO_RESOURCE) ? OC_EH_RESOURCE_NOT_FOUND : OC_EH_ERROR);
834 // Ignoring the discovery request as per RFC 7252, Section #8.2
835 OIC_LOG(INFO, TAG, "Silently ignoring the request since device does not have \
836 any useful data to send");
840 OCPayloadDestroy(payload);
846 HandleDefaultDeviceEntityHandler (OCServerRequest *request)
850 return OC_STACK_INVALID_PARAM;
853 OCStackResult result = OC_STACK_OK;
854 OCEntityHandlerResult ehResult = OC_EH_ERROR;
855 OCEntityHandlerRequest ehRequest = {0};
857 OIC_LOG(INFO, TAG, "Entering HandleResourceWithDefaultDeviceEntityHandler");
858 result = FormOCEntityHandlerRequest(&ehRequest,
859 (OCRequestHandle) request,
862 (OCResourceHandle) NULL, request->query,
863 PAYLOAD_TYPE_REPRESENTATION,
865 request->payloadSize,
866 request->numRcvdVendorSpecificHeaderOptions,
867 request->rcvdVendorSpecificHeaderOptions,
868 (OCObserveAction)request->observationOption,
870 VERIFY_SUCCESS(result, OC_STACK_OK);
872 // At this point we know for sure that defaultDeviceHandler exists
873 ehResult = defaultDeviceHandler(OC_REQUEST_FLAG, &ehRequest,
874 (char*) request->resourceUrl, defaultDeviceHandlerCallbackParameter);
875 if(ehResult == OC_EH_SLOW)
877 OIC_LOG(INFO, TAG, "This is a slow resource");
878 request->slowFlag = 1;
880 else if(ehResult == OC_EH_ERROR)
882 FindAndDeleteServerRequest(request);
884 result = EntityHandlerCodeToOCStackCode(ehResult);
886 OCPayloadDestroy(ehRequest.payload);
891 HandleResourceWithEntityHandler (OCServerRequest *request,
892 OCResource *resource,
893 uint8_t collectionResource)
895 if(!request || ! resource)
897 return OC_STACK_INVALID_PARAM;
900 OCStackResult result = OC_STACK_ERROR;
901 OCEntityHandlerResult ehResult = OC_EH_ERROR;
902 OCEntityHandlerFlag ehFlag = OC_REQUEST_FLAG;
903 ResourceObserver *resObs = NULL;
905 OCEntityHandlerRequest ehRequest = {0};
907 OIC_LOG(INFO, TAG, "Entering HandleResourceWithEntityHandler");
908 OCPayloadType type = PAYLOAD_TYPE_REPRESENTATION;
909 // check the security resource
910 if (request && request->resourceUrl && SRMIsSecurityResourceURI(request->resourceUrl))
912 type = PAYLOAD_TYPE_SECURITY;
916 if (request && strcmp(request->resourceUrl, OC_RSRVD_RD_URI) == 0)
918 type = PAYLOAD_TYPE_RD;
921 result = FormOCEntityHandlerRequest(&ehRequest,
922 (OCRequestHandle)request,
925 (OCResourceHandle)resource,
929 request->payloadSize,
930 request->numRcvdVendorSpecificHeaderOptions,
931 request->rcvdVendorSpecificHeaderOptions,
932 (OCObserveAction)request->observationOption,
934 VERIFY_SUCCESS(result, OC_STACK_OK);
936 if(ehRequest.obsInfo.action == OC_OBSERVE_NO_OPTION)
938 OIC_LOG(INFO, TAG, "No observation requested");
939 ehFlag = OC_REQUEST_FLAG;
941 else if(ehRequest.obsInfo.action == OC_OBSERVE_REGISTER && !collectionResource)
943 OIC_LOG(INFO, TAG, "Observation registration requested");
945 ResourceObserver *obs = GetObserverUsingToken (request->requestToken,
946 request->tokenLength);
950 OIC_LOG (INFO, TAG, "Observer with this token already present");
951 OIC_LOG (INFO, TAG, "Possibly re-transmitted CON OBS request");
952 OIC_LOG (INFO, TAG, "Not adding observer. Not responding to client");
953 OIC_LOG (INFO, TAG, "The first request for this token is already ACKED.");
955 // server requests are usually free'd when the response is sent out
956 // for the request in ocserverrequest.c : HandleSingleResponse()
957 // Since we are making an early return and not responding, the server request
958 // needs to be deleted.
959 FindAndDeleteServerRequest (request);
963 result = GenerateObserverId(&ehRequest.obsInfo.obsId);
964 VERIFY_SUCCESS(result, OC_STACK_OK);
966 result = AddObserver ((const char*)(request->resourceUrl),
967 (const char *)(request->query),
968 ehRequest.obsInfo.obsId, request->requestToken, request->tokenLength,
969 resource, request->qos, request->acceptFormat,
972 if(result == OC_STACK_OK)
974 OIC_LOG(INFO, TAG, "Added observer successfully");
975 request->observeResult = OC_STACK_OK;
976 ehFlag = (OCEntityHandlerFlag)(OC_REQUEST_FLAG | OC_OBSERVE_FLAG);
980 result = OC_STACK_OK;
982 // The error in observeResult for the request will be used when responding to this
983 // request by omitting the observation option/sequence number.
984 request->observeResult = OC_STACK_ERROR;
985 OIC_LOG(ERROR, TAG, "Observer Addition failed");
986 ehFlag = OC_REQUEST_FLAG;
990 else if(ehRequest.obsInfo.action == OC_OBSERVE_DEREGISTER &&
993 OIC_LOG(INFO, TAG, "Deregistering observation requested");
995 resObs = GetObserverUsingToken (request->requestToken, request->tokenLength);
999 // Stack does not contain this observation request
1000 // Either token is incorrect or observation list is corrupted
1001 result = OC_STACK_ERROR;
1004 ehRequest.obsInfo.obsId = resObs->observeId;
1005 ehFlag = (OCEntityHandlerFlag)(ehFlag | OC_OBSERVE_FLAG);
1007 result = DeleteObserverUsingToken (request->requestToken, request->tokenLength);
1009 if(result == OC_STACK_OK)
1011 OIC_LOG(INFO, TAG, "Removed observer successfully");
1012 request->observeResult = OC_STACK_OK;
1016 result = OC_STACK_OK;
1017 request->observeResult = OC_STACK_ERROR;
1018 OIC_LOG(ERROR, TAG, "Observer Removal failed");
1023 result = OC_STACK_ERROR;
1027 ehResult = resource->entityHandler(ehFlag, &ehRequest, resource->entityHandlerCallbackParam);
1028 if(ehResult == OC_EH_SLOW)
1030 OIC_LOG(INFO, TAG, "This is a slow resource");
1031 request->slowFlag = 1;
1033 else if(ehResult == OC_EH_ERROR)
1035 FindAndDeleteServerRequest(request);
1037 result = EntityHandlerCodeToOCStackCode(ehResult);
1039 OCPayloadDestroy(ehRequest.payload);
1043 static OCStackResult
1044 HandleCollectionResourceDefaultEntityHandler (OCServerRequest *request,
1045 OCResource *resource)
1047 if(!request || !resource)
1049 return OC_STACK_INVALID_PARAM;
1052 OCStackResult result = OC_STACK_ERROR;
1053 OCEntityHandlerRequest ehRequest = {0};
1055 result = FormOCEntityHandlerRequest(&ehRequest,
1056 (OCRequestHandle)request,
1059 (OCResourceHandle)resource,
1061 PAYLOAD_TYPE_REPRESENTATION,
1063 request->payloadSize,
1064 request->numRcvdVendorSpecificHeaderOptions,
1065 request->rcvdVendorSpecificHeaderOptions,
1066 (OCObserveAction)request->observationOption,
1067 (OCObservationId)0);
1068 if(result == OC_STACK_OK)
1070 result = DefaultCollectionEntityHandler (OC_REQUEST_FLAG, &ehRequest);
1073 OCPayloadDestroy(ehRequest.payload);
1078 ProcessRequest(ResourceHandling resHandling, OCResource *resource, OCServerRequest *request)
1080 OCStackResult ret = OC_STACK_OK;
1082 switch (resHandling)
1084 case OC_RESOURCE_VIRTUAL:
1086 ret = HandleVirtualResource (request, resource);
1089 case OC_RESOURCE_DEFAULT_DEVICE_ENTITYHANDLER:
1091 ret = HandleDefaultDeviceEntityHandler(request);
1094 case OC_RESOURCE_NOT_COLLECTION_DEFAULT_ENTITYHANDLER:
1096 OIC_LOG(INFO, TAG, "OC_RESOURCE_NOT_COLLECTION_DEFAULT_ENTITYHANDLER");
1097 return OC_STACK_ERROR;
1099 case OC_RESOURCE_NOT_COLLECTION_WITH_ENTITYHANDLER:
1101 ret = HandleResourceWithEntityHandler (request, resource, 0);
1104 case OC_RESOURCE_COLLECTION_WITH_ENTITYHANDLER:
1106 ret = HandleResourceWithEntityHandler (request, resource, 1);
1109 case OC_RESOURCE_COLLECTION_DEFAULT_ENTITYHANDLER:
1111 ret = HandleCollectionResourceDefaultEntityHandler (request, resource);
1114 case OC_RESOURCE_NOT_SPECIFIED:
1116 ret = OC_STACK_NO_RESOURCE;
1121 OIC_LOG(INFO, TAG, "Invalid Resource Determination");
1122 return OC_STACK_ERROR;
1128 void DeletePlatformInfo()
1130 OIC_LOG(INFO, TAG, "Deleting platform info.");
1132 OICFree(savedPlatformInfo.platformID);
1133 savedPlatformInfo.platformID = NULL;
1135 OICFree(savedPlatformInfo.manufacturerName);
1136 savedPlatformInfo.manufacturerName = NULL;
1138 OICFree(savedPlatformInfo.manufacturerUrl);
1139 savedPlatformInfo.manufacturerUrl = NULL;
1141 OICFree(savedPlatformInfo.modelNumber);
1142 savedPlatformInfo.modelNumber = NULL;
1144 OICFree(savedPlatformInfo.dateOfManufacture);
1145 savedPlatformInfo.dateOfManufacture = NULL;
1147 OICFree(savedPlatformInfo.platformVersion);
1148 savedPlatformInfo.platformVersion = NULL;
1150 OICFree(savedPlatformInfo.operatingSystemVersion);
1151 savedPlatformInfo.operatingSystemVersion = NULL;
1153 OICFree(savedPlatformInfo.hardwareVersion);
1154 savedPlatformInfo.hardwareVersion = NULL;
1156 OICFree(savedPlatformInfo.firmwareVersion);
1157 savedPlatformInfo.firmwareVersion = NULL;
1159 OICFree(savedPlatformInfo.supportUrl);
1160 savedPlatformInfo.supportUrl = NULL;
1162 OICFree(savedPlatformInfo.systemTime);
1163 savedPlatformInfo.systemTime = NULL;
1166 static OCStackResult DeepCopyPlatFormInfo(OCPlatformInfo info)
1168 savedPlatformInfo.platformID = OICStrdup(info.platformID);
1169 savedPlatformInfo.manufacturerName = OICStrdup(info.manufacturerName);
1170 savedPlatformInfo.manufacturerUrl = OICStrdup(info.manufacturerUrl);
1171 savedPlatformInfo.modelNumber = OICStrdup(info.modelNumber);
1172 savedPlatformInfo.dateOfManufacture = OICStrdup(info.dateOfManufacture);
1173 savedPlatformInfo.platformVersion = OICStrdup(info.platformVersion);
1174 savedPlatformInfo.operatingSystemVersion = OICStrdup(info.operatingSystemVersion);
1175 savedPlatformInfo.hardwareVersion = OICStrdup(info.hardwareVersion);
1176 savedPlatformInfo.firmwareVersion = OICStrdup(info.firmwareVersion);
1177 savedPlatformInfo.supportUrl = OICStrdup(info.supportUrl);
1178 savedPlatformInfo.systemTime = OICStrdup(info.systemTime);
1180 if ((!savedPlatformInfo.platformID && info.platformID)||
1181 (!savedPlatformInfo.manufacturerName && info.manufacturerName)||
1182 (!savedPlatformInfo.manufacturerUrl && info.manufacturerUrl)||
1183 (!savedPlatformInfo.modelNumber && info.modelNumber)||
1184 (!savedPlatformInfo.dateOfManufacture && info.dateOfManufacture)||
1185 (!savedPlatformInfo.platformVersion && info.platformVersion)||
1186 (!savedPlatformInfo.operatingSystemVersion && info.operatingSystemVersion)||
1187 (!savedPlatformInfo.hardwareVersion && info.hardwareVersion)||
1188 (!savedPlatformInfo.firmwareVersion && info.firmwareVersion)||
1189 (!savedPlatformInfo.supportUrl && info.supportUrl)||
1190 (!savedPlatformInfo.systemTime && info.systemTime))
1192 DeletePlatformInfo();
1193 return OC_STACK_INVALID_PARAM;
1200 OCStackResult SavePlatformInfo(OCPlatformInfo info)
1202 DeletePlatformInfo();
1204 OCStackResult res = DeepCopyPlatFormInfo(info);
1206 if (res != OC_STACK_OK)
1208 OIC_LOG_V(ERROR, TAG, "Failed to save platform info. errno(%d)", res);
1212 OIC_LOG(INFO, TAG, "Platform info saved.");
1218 void DeleteDeviceInfo()
1220 OIC_LOG(INFO, TAG, "Deleting device info.");
1222 OICFree(savedDeviceInfo.deviceName);
1223 OCFreeOCStringLL(savedDeviceInfo.types);
1224 savedDeviceInfo.deviceName = NULL;
1228 static OCStackResult DeepCopyDeviceInfo(OCDeviceInfo info)
1230 savedDeviceInfo.deviceName = OICStrdup(info.deviceName);
1232 if(!savedDeviceInfo.deviceName && info.deviceName)
1235 return OC_STACK_NO_MEMORY;
1240 savedDeviceInfo.types = CloneOCStringLL(info.types);
1241 if(!savedDeviceInfo.types && info.types)
1244 return OC_STACK_NO_MEMORY;
1250 OCStackResult SaveDeviceInfo(OCDeviceInfo info)
1252 OCStackResult res = OC_STACK_OK;
1256 res = DeepCopyDeviceInfo(info);
1258 VERIFY_SUCCESS(res, OC_STACK_OK);
1260 if (OCGetServerInstanceIDString() == NULL)
1262 OIC_LOG(INFO, TAG, "Device ID generation failed");
1263 res = OC_STACK_ERROR;
1267 OIC_LOG(INFO, TAG, "Device initialized successfully.");