service/notification/src/provider/NSProviderSubscription.c

   1 //******************************************************************\r
   2 //\r
   3 // Copyright 2016 Samsung Electronics All Rights Reserved.\r
   4 //\r
   5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=\r
   6 //\r
   7 // Licensed under the Apache License, Version 2.0 (the "License");\r
   8 // you may not use this file except in compliance with the License.\r
   9 // You may obtain a copy of the License at\r
  10 //\r
  11 //      http://www.apache.org/licenses/LICENSE-2.0\r
  12 //\r
  13 // Unless required by applicable law or agreed to in writing, software\r
  14 // distributed under the License is distributed on an "AS IS" BASIS,\r
  15 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  16 // See the License for the specific language governing permissions and\r
  17 // limitations under the License.\r
  18 //\r
  19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=\r
  20 \r
  21 #include "NSProviderSubscription.h"\r
  22 #include "NSProviderListener.h"\r
  23 \r
  24 NSCacheList * consumerSubList;\r
  25 \r
  26 NSResult NSInitSubscriptionList()\r
  27 {\r
  28     NS_LOG(DEBUG, "NSInitSubscriptionList - IN");\r
  29 \r
  30     consumerSubList = NSProviderStorageCreate();\r
  31     NS_VERIFY_NOT_NULL(consumerSubList, NS_FAIL);\r
  32     consumerSubList->cacheType = NS_PROVIDER_CACHE_SUBSCRIBER;\r
  33 \r
  34     NS_LOG(DEBUG, "NSInitSubscriptionList - OUT");\r
  35     return NS_OK;\r
  36 }\r
  37 \r
  38 NSResult NSSetSubscriptionAccessPolicy(bool policy)\r
  39 {\r
  40     NS_LOG(DEBUG, "NSSetSubscriptionAcceptPolicy - IN");\r
  41 \r
  42     if (policy == NS_POLICY_PROVIDER)\r
  43     {\r
  44         NS_LOG(DEBUG, "Place Provider as a subscription accepter");\r
  45     }\r
  46     else if (policy == NS_POLICY_CONSUMER)\r
  47     {\r
  48         NS_LOG(DEBUG, "Place Consumer as a subscription accepter");\r
  49     }\r
  50 \r
  51     NSSetPolicy(policy);\r
  52 \r
  53     NS_LOG(DEBUG, "NSSetSubscriptionAcceptPolicy - OUT");\r
  54     return NS_OK;\r
  55 }\r
  56 \r
  57 NSResult NSSendAccessPolicyResponse(OCEntityHandlerRequest *entityHandlerRequest)\r
  58 {\r
  59     NS_LOG(DEBUG, "NSSendAccessPolicyResponse - IN");\r
  60 \r
  61     // put notification resource\r
  62     OCResourceHandle notificationResourceHandle = NULL;\r
  63     if (NSPutNotificationResource(NSGetPolicy(), &notificationResourceHandle)\r
  64             != NS_OK)\r
  65     {\r
  66         NS_LOG(ERROR, "Fail to put notification resource");\r
  67         return NS_ERROR;\r
  68     }\r
  69 \r
  70     // make response for the Get Request\r
  71     OCEntityHandlerResponse response;\r
  72     response.numSendVendorSpecificHeaderOptions = 0;\r
  73     memset(response.sendVendorSpecificHeaderOptions, 0,\r
  74             sizeof response.sendVendorSpecificHeaderOptions);\r
  75     memset(response.resourceUri, 0, sizeof response.resourceUri);\r
  76 \r
  77     OCRepPayload* payload = OCRepPayloadCreate();\r
  78     if (!payload)\r
  79     {\r
  80         NS_LOG(ERROR, "payload is NULL");\r
  81         return NS_ERROR;\r
  82     }\r
  83 \r
  84     NS_LOG_V(INFO_PRIVATE, "NS Provider ID: %s", NSGetProviderInfo()->providerId);\r
  85 \r
  86     char * copyReq = OICStrdup(entityHandlerRequest->query);\r
  87     char * reqInterface = NSGetValueFromQuery(copyReq, NS_QUERY_INTERFACE);\r
  88 \r
  89     if (reqInterface && strcmp(reqInterface, NS_INTERFACE_BASELINE) == 0)\r
  90     {\r
  91         OCResourcePayloadAddStringLL(&payload->interfaces, NS_INTERFACE_BASELINE);\r
  92         OCResourcePayloadAddStringLL(&payload->interfaces, NS_INTERFACE_READ);\r
  93         OCResourcePayloadAddStringLL(&payload->types, NS_ROOT_TYPE);\r
  94     }\r
  95 \r
  96     NSOICFree(copyReq);\r
  97     OCRepPayloadSetUri(payload, NS_ROOT_URI);\r
  98     OCRepPayloadSetPropString(payload, NS_ATTRIBUTE_PROVIDER_ID, NSGetProviderInfo()->providerId);\r
  99     OCRepPayloadSetPropString(payload, NS_ATTRIBUTE_VERSION, VERSION);\r
 100     OCRepPayloadSetPropBool(payload, NS_ATTRIBUTE_POLICY, NSGetPolicy());\r
 101     OCRepPayloadSetPropString(payload, NS_ATTRIBUTE_MESSAGE, NS_COLLECTION_MESSAGE_URI);\r
 102     OCRepPayloadSetPropString(payload, NS_ATTRIBUTE_SYNC, NS_COLLECTION_SYNC_URI);\r
 103     OCRepPayloadSetPropString(payload, NS_ATTRIBUTE_TOPIC, NS_COLLECTION_TOPIC_URI);\r
 104 \r
 105     response.requestHandle = entityHandlerRequest->requestHandle;\r
 106     response.resourceHandle = entityHandlerRequest->resource;\r
 107     response.persistentBufferFlag = 0;\r
 108     response.ehResult = OC_EH_OK;\r
 109     response.payload = (OCPayload *) payload;\r
 110 \r
 111     // Send Response\r
 112     if (OCDoResponse(&response) != OC_STACK_OK)\r
 113     {\r
 114         NS_LOG(ERROR, "Fail to AccessPolicy send response");\r
 115         OCRepPayloadDestroy(payload);\r
 116         return NS_ERROR;\r
 117     }\r
 118     OCRepPayloadDestroy(payload);\r
 119     NSFreeOCEntityHandlerRequest(entityHandlerRequest);\r
 120 \r
 121     NS_LOG(DEBUG, "NSSendAccessPolicyResponse - OUT");\r
 122     return NS_OK;\r
 123 }\r
 124 \r
 125 void NSHandleSubscription(OCEntityHandlerRequest *entityHandlerRequest, NSResourceType resourceType)\r
 126 {\r
 127     NS_LOG(DEBUG, "NSHandleSubscription - IN");\r
 128 \r
 129     char * copyReq = OICStrdup(entityHandlerRequest->query);\r
 130     char * id = NSGetValueFromQuery(copyReq, NS_QUERY_CONSUMER_ID);\r
 131 \r
 132     if (!id)\r
 133     {\r
 134         NSOICFree(copyReq);\r
 135         NSFreeOCEntityHandlerRequest(entityHandlerRequest);\r
 136         NS_LOG(ERROR, "Invalid ConsumerID");\r
 137         return;\r
 138     }\r
 139 \r
 140     NS_LOG_V(INFO_PRIVATE, "consumerId = %s", id);\r
 141     if (resourceType == NS_RESOURCE_MESSAGE)\r
 142     {\r
 143         NS_LOG(DEBUG, "resourceType == NS_RESOURCE_MESSAGE");\r
 144         NSCacheElement * element = (NSCacheElement *) OICMalloc(sizeof(NSCacheElement));\r
 145         NS_VERIFY_NOT_NULL_V(element);\r
 146         NSCacheSubData * subData = (NSCacheSubData *) OICMalloc(sizeof(NSCacheSubData));\r
 147         NS_VERIFY_NOT_NULL_V(subData);\r
 148 \r
 149         OICStrcpy(subData->id, UUID_STRING_SIZE, id);\r
 150         NS_LOG_V(INFO_PRIVATE, "SubList ID = [%s]", subData->id);\r
 151 \r
 152         NS_LOG_V(INFO_PRIVATE, "Consumer Address: %s", entityHandlerRequest->devAddr.addr);\r
 153 \r
 154         subData->remote_messageObId = subData->messageObId = 0;\r
 155 \r
 156         bool iSRemoteServer = false;\r
 157 \r
 158 #if(defined WITH_CLOUD)\r
 159         iSRemoteServer = NSIsRemoteServerAddress(entityHandlerRequest->devAddr.addr);\r
 160         if (iSRemoteServer)\r
 161         {\r
 162             NS_LOG(DEBUG, "Requested by remote server");\r
 163             subData->remote_messageObId = entityHandlerRequest->obsInfo.obsId;\r
 164             NS_LOG_V(DEBUG, "SubList message observation ID = [%d]", subData->remote_messageObId);\r
 165         }\r
 166 #endif\r
 167 \r
 168         if (!iSRemoteServer)\r
 169         {\r
 170             NS_LOG(DEBUG, "Requested by local consumer");\r
 171             subData->messageObId = entityHandlerRequest->obsInfo.obsId;\r
 172             NS_LOG_V(DEBUG, "SubList message observation ID = [%d]", subData->messageObId);\r
 173         }\r
 174 \r
 175         subData->isWhite = false;\r
 176         subData->remote_syncObId = 0;\r
 177         subData->syncObId = 0;\r
 178 \r
 179         element->data = (void*) subData;\r
 180         element->next = NULL;\r
 181 \r
 182         if (NSProviderStorageWrite(consumerSubList, element) != NS_OK)\r
 183         {\r
 184             NS_LOG(DEBUG, "fail to write cache");\r
 185         }\r
 186 \r
 187         bool currPolicy = NSGetPolicy();\r
 188         NSAskAcceptanceToUser(NSCopyOCEntityHandlerRequest(entityHandlerRequest));\r
 189 \r
 190         if (currPolicy == NS_POLICY_PROVIDER)\r
 191         {\r
 192             NS_LOG(DEBUG, "NSGetSubscriptionAccepter == NS_ACCEPTER_PROVIDER");\r
 193         }\r
 194         else if (currPolicy == NS_POLICY_CONSUMER)\r
 195         {\r
 196             NS_LOG(DEBUG, "NSGetSubscriptionAccepter == NS_ACCEPTER_CONSUMER");\r
 197             NSSendConsumerSubResponse(NSCopyOCEntityHandlerRequest(entityHandlerRequest));\r
 198         }\r
 199 \r
 200         NSFreeOCEntityHandlerRequest(entityHandlerRequest);\r
 201     }\r
 202     else if (resourceType == NS_RESOURCE_SYNC)\r
 203     {\r
 204         NS_LOG(DEBUG, "resourceType == NS_RESOURCE_SYNC");\r
 205         NSCacheElement * element = (NSCacheElement *) OICMalloc(sizeof(NSCacheElement));\r
 206         NS_VERIFY_NOT_NULL_V(element);\r
 207         NSCacheSubData * subData = (NSCacheSubData *) OICMalloc(sizeof(NSCacheSubData));\r
 208         NS_VERIFY_NOT_NULL_V(subData);\r
 209 \r
 210         OICStrcpy(subData->id, UUID_STRING_SIZE, id);\r
 211         NS_LOG_V(INFO_PRIVATE, "SubList ID = [%s]", subData->id);\r
 212 \r
 213         NS_LOG_V(INFO_PRIVATE, "Consumer Address: %s", entityHandlerRequest->devAddr.addr);\r
 214 \r
 215         subData->remote_syncObId = subData->syncObId = 0;\r
 216         bool isRemoteServer = false;\r
 217 \r
 218 #if (defined WITH_CLOUD)\r
 219         isRemoteServer = NSIsRemoteServerAddress(entityHandlerRequest->devAddr.addr);\r
 220         if (isRemoteServer)\r
 221         {\r
 222             NS_LOG(DEBUG, "Requested by remote server");\r
 223             subData->remote_syncObId = entityHandlerRequest->obsInfo.obsId;\r
 224             NS_LOG_V(DEBUG, "SubList sync observation ID = [%d]", subData->remote_syncObId);\r
 225         }\r
 226 #endif\r
 227 \r
 228         if (!isRemoteServer)\r
 229         {\r
 230             NS_LOG(DEBUG, "Requested by local consumer");\r
 231             subData->syncObId = entityHandlerRequest->obsInfo.obsId;\r
 232             NS_LOG_V(DEBUG, "SubList sync observation ID = [%d]", subData->syncObId);\r
 233         }\r
 234 \r
 235         subData->isWhite = false;\r
 236         subData->messageObId = 0;\r
 237         subData->remote_messageObId = 0;\r
 238 \r
 239         element->data = (void*) subData;\r
 240         element->next = NULL;\r
 241 \r
 242         if (NS_OK != NSProviderStorageWrite(consumerSubList, element))\r
 243         {\r
 244             NS_LOG(ERROR, "Fail to write cache");\r
 245         }\r
 246 \r
 247         NSFreeOCEntityHandlerRequest(entityHandlerRequest);\r
 248     }\r
 249     NSOICFree(copyReq);\r
 250 \r
 251     NS_LOG(DEBUG, "NSHandleSubscription - OUT");\r
 252 }\r
 253 \r
 254 void NSHandleUnsubscription(OCEntityHandlerRequest *entityHandlerRequest)\r
 255 {\r
 256     NS_LOG(DEBUG, "NSHandleUnsubscription - IN");\r
 257 \r
 258     consumerSubList->cacheType = NS_PROVIDER_CACHE_SUBSCRIBER_OBSERVE_ID;\r
 259 \r
 260     while (NSProviderStorageDelete(consumerSubList, (char *)\r
 261             &(entityHandlerRequest->obsInfo.obsId)) != NS_FAIL);\r
 262 \r
 263     consumerSubList->cacheType = NS_PROVIDER_CACHE_SUBSCRIBER;\r
 264     NSFreeOCEntityHandlerRequest(entityHandlerRequest);\r
 265     NS_LOG(DEBUG, "NSHandleUnsubscription - OUT");\r
 266 }\r
 267 \r
 268 void NSAskAcceptanceToUser(OCEntityHandlerRequest *entityHandlerRequest)\r
 269 {\r
 270     NS_LOG(DEBUG, "NSAskAcceptanceToUser - IN");\r
 271 \r
 272     NSPushQueue(CALLBACK_RESPONSE_SCHEDULER, TASK_CB_SUBSCRIPTION, entityHandlerRequest);\r
 273 \r
 274     NS_LOG(DEBUG, "NSAskAcceptanceToUser - OUT");\r
 275 }\r
 276 \r
 277 NSResult NSSendResponse(const char * id, bool accepted)\r
 278 {\r
 279     NS_LOG(DEBUG, "NSSendResponse - IN");\r
 280 \r
 281     OCRepPayload* payload = OCRepPayloadCreate();\r
 282     if (!payload)\r
 283     {\r
 284         NS_LOG(ERROR, "fail to create playload");\r
 285         return NS_ERROR;\r
 286     }\r
 287 \r
 288     OCResourceHandle rHandle = NULL;\r
 289     if (NSPutMessageResource(NULL, &rHandle) != NS_OK)\r
 290     {\r
 291         NS_LOG(ERROR, "Fail to put notification resource");\r
 292         return NS_ERROR;\r
 293     }\r
 294 \r
 295     OCRepPayloadSetUri(payload, NS_COLLECTION_MESSAGE_URI);\r
 296     (accepted) ? OCRepPayloadSetPropInt(payload, NS_ATTRIBUTE_MESSAGE_ID, NS_ALLOW)\r
 297         : OCRepPayloadSetPropInt(payload, NS_ATTRIBUTE_MESSAGE_ID, NS_DENY);\r
 298     OCRepPayloadSetPropString(payload, NS_ATTRIBUTE_PROVIDER_ID, NSGetProviderInfo()->providerId);\r
 299 \r
 300     NSCacheElement * element = NSProviderStorageRead(consumerSubList, id);\r
 301 \r
 302     if (element == NULL)\r
 303     {\r
 304         NS_LOG(ERROR, "element is NULL");\r
 305         return NS_ERROR;\r
 306     }\r
 307 \r
 308     NSCacheSubData * subData = (NSCacheSubData*) element->data;\r
 309 \r
 310     if (OCNotifyListOfObservers(rHandle, (OCObservationId*)&subData->messageObId, 1,\r
 311             payload, OC_LOW_QOS) != OC_STACK_OK)\r
 312     {\r
 313         NS_LOG(ERROR, "fail to send Acceptance");\r
 314         OCRepPayloadDestroy(payload);\r
 315         return NS_ERROR;\r
 316 \r
 317     }\r
 318 \r
 319     OCRepPayloadDestroy(payload);\r
 320     NS_LOG(DEBUG, "NSSendResponse - OUT");\r
 321     return NS_OK;\r
 322 }\r
 323 \r
 324 NSResult NSSendConsumerSubResponse(OCEntityHandlerRequest * entityHandlerRequest)\r
 325 {\r
 326     NS_LOG(DEBUG, "NSSendSubscriptionResponse - IN");\r
 327 \r
 328     if (!entityHandlerRequest)\r
 329     {\r
 330         NS_LOG(ERROR, "Invalid request pointer");\r
 331         return NS_ERROR;\r
 332     }\r
 333 \r
 334     char * copyReq = OICStrdup(entityHandlerRequest->query);\r
 335     char * id = NSGetValueFromQuery(copyReq, NS_QUERY_CONSUMER_ID);\r
 336 \r
 337     if (!id)\r
 338     {\r
 339         NSOICFree(copyReq);\r
 340         NSFreeOCEntityHandlerRequest(entityHandlerRequest);\r
 341         NS_LOG(ERROR, "Invalid ConsumerID");\r
 342         return NS_ERROR;\r
 343     }\r
 344 \r
 345     NSCacheUpdateSubScriptionState(consumerSubList, id, true);\r
 346     NSSendResponse(id, true);\r
 347     NSOICFree(copyReq);\r
 348     NSFreeOCEntityHandlerRequest(entityHandlerRequest);\r
 349     NS_LOG(DEBUG, "NSSendSubscriptionResponse - OUT");\r
 350     return NS_OK;\r
 351 }\r
 352 \r
 353 #ifdef WITH_MQ\r
 354 void NSProviderMQSubscription(NSMQTopicAddress * topicAddr)\r
 355 {\r
 356     char * serverUri = topicAddr->serverAddr;\r
 357     char * topicName = topicAddr->topicName;\r
 358 \r
 359     NS_LOG_V(DEBUG, "input Topic Name2 : %s", topicAddr->topicName);\r
 360 \r
 361     OCDevAddr * addr = NSChangeAddress(serverUri);\r
 362     OCCallbackData cbdata = { NULL, NULL, NULL };\r
 363     cbdata.cb = NSProviderGetMQResponseCB;\r
 364     cbdata.context = OICStrdup(topicName);\r
 365     cbdata.cd = NSOICFree;\r
 366 \r
 367     char requestUri[100] = "coap+tcp://";\r
 368 \r
 369     NS_LOG_V(DEBUG, "requestUri1 = %s", requestUri);\r
 370     OICStrcat(requestUri, strlen(requestUri)+strlen(serverUri)+1, serverUri);\r
 371     NS_LOG_V(DEBUG, "requestUri2 = %s", requestUri);\r
 372     OICStrcat(requestUri, strlen(requestUri)+ strlen("/oic/ps") + 1, "/oic/ps");\r
 373     NS_LOG_V(DEBUG, "requestUri3 = %s", requestUri);\r
 374     OCStackResult ret = OCDoResource(NULL, OC_REST_GET, requestUri, addr,\r
 375                                      NULL, CT_DEFAULT, OC_HIGH_QOS, &cbdata, NULL, 0);\r
 376 \r
 377     NSOCResultToSuccess(ret);\r
 378 \r
 379     NSOICFree(topicAddr->serverAddr);\r
 380     NSOICFree(topicAddr->topicName);\r
 381     NSOICFree(topicAddr);\r
 382 }\r
 383 #endif\r
 384 \r
 385 void * NSSubScriptionSchedule(void *ptr)\r
 386 {\r
 387     if (ptr == NULL)\r
 388     {\r
 389         NS_LOG(DEBUG, "Create NSSubScriptionSchedule");\r
 390     }\r
 391 \r
 392     while (NSIsRunning[SUBSCRIPTION_SCHEDULER])\r
 393     {\r
 394         sem_wait(&NSSemaphore[SUBSCRIPTION_SCHEDULER]);\r
 395         pthread_mutex_lock(&NSMutex[SUBSCRIPTION_SCHEDULER]);\r
 396 \r
 397         if (NSHeadMsg[SUBSCRIPTION_SCHEDULER] != NULL)\r
 398         {\r
 399             NSTask *node = NSHeadMsg[SUBSCRIPTION_SCHEDULER];\r
 400             NSHeadMsg[SUBSCRIPTION_SCHEDULER] = node->nextTask;\r
 401 \r
 402             switch (node->taskType)\r
 403             {\r
 404                 case TASK_SEND_POLICY:\r
 405                     NS_LOG(DEBUG, "CASE TASK_SEND_POLICY : ");\r
 406                     NSSendAccessPolicyResponse((OCEntityHandlerRequest*) node->taskData);\r
 407                     break;\r
 408 \r
 409                 case TASK_RECV_SUBSCRIPTION:\r
 410                     NS_LOG(DEBUG, "CASE TASK_RECV_SUBSCRIPTION : ");\r
 411                     NSHandleSubscription((OCEntityHandlerRequest*) node->taskData,\r
 412                             NS_RESOURCE_MESSAGE);\r
 413                     break;\r
 414 \r
 415                 case TASK_RECV_UNSUBSCRIPTION:\r
 416                     NS_LOG(DEBUG, "CASE TASK_RECV_UNSUBSCRIPTION : ");\r
 417                     NSHandleUnsubscription((OCEntityHandlerRequest*) node->taskData);\r
 418                     break;\r
 419 \r
 420                 case TASK_SEND_ALLOW:\r
 421                 {\r
 422                     NS_LOG(DEBUG, "CASE TASK_SEND_ALLOW : ");\r
 423                     char * consumerId = (char *) node->taskData;\r
 424 \r
 425                     NSCacheUpdateSubScriptionState(consumerSubList, consumerId, true);\r
 426                     NSSendResponse(consumerId, true);\r
 427                     NSOICFree(consumerId);\r
 428                     break;\r
 429                 }\r
 430                 case TASK_SEND_DENY:\r
 431                 {\r
 432                     NS_LOG(DEBUG, "CASE TASK_SEND_DENY : ");\r
 433                     char * consumerId = (char *) node->taskData;\r
 434 \r
 435                     NSCacheUpdateSubScriptionState(consumerSubList, consumerId, false);\r
 436                     NSSendResponse(consumerId, false);\r
 437                     NSOICFree(consumerId);\r
 438 \r
 439                     break;\r
 440                 }\r
 441                 case TASK_SYNC_SUBSCRIPTION:\r
 442                     NS_LOG(DEBUG, "CASE TASK_SYNC_SUBSCRIPTION : ");\r
 443                     NSHandleSubscription((OCEntityHandlerRequest*) node->taskData,\r
 444                             NS_RESOURCE_SYNC);\r
 445                     break;\r
 446 #ifdef WITH_MQ\r
 447                 case TASK_MQ_REQ_SUBSCRIBE:\r
 448                     NS_LOG(DEBUG, "CASE TASK_MQ_REQ_SUBSCRIBE : ");\r
 449                     NSProviderMQSubscription((NSMQTopicAddress*) node->taskData);\r
 450                     break;\r
 451 #endif\r
 452                 default:\r
 453                     break;\r
 454 \r
 455             }\r
 456             NSOICFree(node);\r
 457         }\r
 458 \r
 459         pthread_mutex_unlock(&NSMutex[SUBSCRIPTION_SCHEDULER]);\r
 460 \r
 461     }\r
 462     NS_LOG(INFO, "Destroy NSSubScriptionSchedule");\r
 463     return NULL;\r
 464 }\r