service/notification/src/consumer/NSConsumerInternalTaskController.c

   1 //******************************************************************
   2 //
   3 // Copyright 2016 Samsung Electronics All Rights Reserved.
   4 //
   5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
   6 //
   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
  10 //
  11 //      http://www.apache.org/licenses/LICENSE-2.0
  12 //
  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.
  18 //
  19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  20
  21 #include "NSConstants.h"
  22 #include "NSConsumerCommon.h"
  23 #include "NSConsumerInternalTaskController.h"
  24 #include "NSStructs.h"
  25
  26 #include "oic_malloc.h"
  27 #include "oic_string.h"
  28
  29 NSCacheList ** NSGetMessageCacheList()
  30 {
  31     static NSCacheList * messageCache = NULL;
  32     return & messageCache;
  33 }
  34
  35 void NSSetMessageCacheList(NSCacheList * cache)
  36 {
  37     *(NSGetMessageCacheList()) = cache;
  38 }
  39
  40 NSCacheList ** NSGetProviderCacheList()
  41 {
  42     static NSCacheList * providerCache = NULL;
  43     return & providerCache;
  44 }
  45
  46 void NSSetProviderCacheList(NSCacheList * cache)
  47 {
  48     *(NSGetProviderCacheList()) = cache;
  49 }
  50
  51 void NSDestroyMessageCacheList()
  52 {
  53     NSCacheList * cache = *(NSGetMessageCacheList());
  54     if (cache)
  55     {
  56         NSStorageDestroy(cache);
  57     }
  58
  59     NSSetMessageCacheList(NULL);
  60 }
  61
  62 void NSDestroyProviderCacheList()
  63 {
  64     NSCacheList * cache = *(NSGetProviderCacheList());
  65     if (cache)
  66     {
  67         NSStorageDestroy(cache);
  68     }
  69
  70     NSSetProviderCacheList(NULL);
  71 }
  72
  73 NSMessage * NSMessageCacheFind(const char * messageId)
  74 {
  75     NS_VERIFY_NOT_NULL(messageId, NULL);
  76
  77     NSCacheList * MessageCache = *(NSGetMessageCacheList());
  78     if (!MessageCache)
  79     {
  80         NS_LOG(DEBUG, "Message Cache Init");
  81         MessageCache = NSStorageCreate();
  82         NS_VERIFY_NOT_NULL(MessageCache, NULL);
  83
  84         MessageCache->cacheType = NS_CONSUMER_CACHE_MESSAGE;
  85         NSSetMessageCacheList(MessageCache);
  86     }
  87
  88     NSCacheElement * cacheElement = NSStorageRead(MessageCache, messageId);
  89     NS_VERIFY_NOT_NULL(cacheElement, NULL);
  90
  91     return NSCopyMessage(((NSStoreMessage *) cacheElement->data)->msg);
  92 }
  93
  94 NSProvider_internal * NSProviderCacheFind(const char * providerId)
  95 {
  96     NS_VERIFY_NOT_NULL(providerId, NULL);
  97
  98     NSCacheList * ProviderCache = *(NSGetProviderCacheList());
  99     if (!ProviderCache)
 100     {
 101         NS_LOG(DEBUG, "Provider Cache Init");
 102         ProviderCache = NSStorageCreate();
 103         NS_VERIFY_NOT_NULL(ProviderCache, NULL);
 104
 105         ProviderCache->cacheType = NS_CONSUMER_CACHE_PROVIDER;
 106         NSSetProviderCacheList(ProviderCache);
 107     }
 108
 109     NSCacheElement * cacheElement = NSStorageRead(ProviderCache, providerId);
 110     NS_VERIFY_NOT_NULL(cacheElement, NULL);
 111
 112     return NSCopyProvider_internal((NSProvider_internal *) cacheElement->data);
 113 }
 114
 115 NSProvider_internal * NSFindProviderFromAddr(OCDevAddr * addr)
 116 {
 117     NS_VERIFY_NOT_NULL(addr, NULL);
 118
 119     NSCacheList * ProviderCache = *(NSGetProviderCacheList());
 120     if (!ProviderCache)
 121     {
 122         NS_LOG(DEBUG, "Provider Cache does not intialized.");
 123         return NULL;
 124     }
 125
 126     NSCacheElement * cacheElement =
 127             NSGetProviderFromAddr(ProviderCache, addr->addr, addr->port);
 128
 129     NS_VERIFY_NOT_NULL(cacheElement, NULL);
 130
 131     return NSCopyProvider_internal((NSProvider_internal *) cacheElement->data);
 132 }
 133
 134 void NSRemoveCacheElementMessage(NSCacheElement * obj)
 135 {
 136     NSRemoveMessage(((NSStoreMessage *)obj->data)->msg);
 137     NSOICFree(obj->data);
 138     NSOICFree(obj);
 139 }
 140
 141 NSResult NSMessageCacheUpdate(NSMessage * msg, NSSyncType type)
 142 {
 143     NS_VERIFY_NOT_NULL(msg, NS_ERROR);
 144
 145     NSCacheList * MessageCache = *(NSGetMessageCacheList());
 146     if (!MessageCache)
 147     {
 148         NS_LOG(DEBUG, "Message Cache Init");
 149         MessageCache = NSStorageCreate();
 150         NS_VERIFY_NOT_NULL(MessageCache, NS_ERROR);
 151
 152         MessageCache->cacheType = NS_CONSUMER_CACHE_MESSAGE;
 153         NSSetMessageCacheList(MessageCache);
 154     }
 155
 156     NSStoreMessage * sMsg = (NSStoreMessage *)OICMalloc(sizeof(NSStoreMessage));
 157     NS_VERIFY_NOT_NULL(sMsg, NS_ERROR);
 158
 159     NSCacheElement * obj = (NSCacheElement *)OICMalloc(sizeof(NSCacheElement));
 160     NS_VERIFY_NOT_NULL_WITH_POST_CLEANING(obj, NS_ERROR, NSOICFree(sMsg));
 161
 162     sMsg->status = type;
 163     sMsg->msg = NSCopyMessage(msg);
 164
 165     obj->data = (NSCacheData *) sMsg;
 166     obj->next = NULL;
 167
 168     NS_LOG(DEBUG, "try to write to storage");
 169     NSResult ret = NSStorageWrite(MessageCache, obj);
 170     NS_VERIFY_NOT_NULL_WITH_POST_CLEANING(ret == NS_OK ? (void *) 1 : NULL,
 171             NS_ERROR, NSRemoveCacheElementMessage(obj));
 172
 173     NSRemoveCacheElementMessage(obj);
 174
 175     NS_LOG(DEBUG, "Update message done");
 176     return NS_OK;
 177 }
 178
 179 NSResult NSProviderCacheUpdate(NSProvider_internal * provider)
 180 {
 181     NSCacheList * ProviderCache = *(NSGetProviderCacheList());
 182     if (!ProviderCache)
 183     {
 184         NS_LOG(DEBUG, "Provider Cache Init");
 185         ProviderCache = NSStorageCreate();
 186         NS_VERIFY_NOT_NULL(ProviderCache, NS_ERROR);
 187
 188         ProviderCache->cacheType = NS_CONSUMER_CACHE_PROVIDER;
 189         NSSetProviderCacheList(ProviderCache);
 190     }
 191
 192     NS_VERIFY_NOT_NULL(provider, NS_ERROR);
 193
 194     NSCacheElement * obj = (NSCacheElement *)OICMalloc(sizeof(NSCacheElement));
 195     NS_VERIFY_NOT_NULL(obj, NS_ERROR);
 196
 197     obj->data = (NSCacheData *) provider;
 198     obj->next = NULL;
 199
 200     NS_LOG(DEBUG, "try to write to storage");
 201     NSResult ret = NSStorageWrite(ProviderCache, obj);
 202     NS_VERIFY_NOT_NULL_WITH_POST_CLEANING(ret == NS_OK ? (void *) 1 : NULL,
 203             NS_ERROR, NSOICFree(obj));
 204
 205     return NS_OK;
 206 }
 207
 208 void NSCancelAllSubscription()
 209 {
 210     NSCacheList * ProviderCache = *(NSGetProviderCacheList());
 211     if (!ProviderCache)
 212     {
 213         NS_LOG(DEBUG, "Provider Cache Init");
 214         ProviderCache = NSStorageCreate();
 215         NS_VERIFY_NOT_NULL_V(ProviderCache);
 216
 217         ProviderCache->cacheType = NS_CONSUMER_CACHE_PROVIDER;
 218         NSSetProviderCacheList(ProviderCache);
 219     }
 220
 221     NSCacheElement * obj = NULL;
 222     while ((obj = NSPopProviderCacheList(ProviderCache)))
 223     {
 224         NS_LOG(DEBUG, "build NSTask");
 225         NSTask * task = NSMakeTask(TASK_CONSUMER_REQ_SUBSCRIBE_CANCEL, (void *) obj->data);
 226         NS_VERIFY_NOT_NULL_V(task);
 227
 228         NSConsumerPushEvent(task);
 229     }
 230 }
 231
 232 void NSConsumerHandleProviderDiscovered(NSProvider_internal * provider)
 233 {
 234     NS_VERIFY_NOT_NULL_V(provider);
 235
 236     bool isAdded = true;
 237     bool isSubscribing = false;
 238     NSProvider_internal * providerCacheData = NSProviderCacheFind(provider->providerId);
 239
 240     if (providerCacheData == NULL)
 241     {
 242         isAdded = false;
 243     }
 244     else
 245     {
 246         providerCacheData->accessPolicy = provider->accessPolicy;
 247         NSProviderConnectionInfo * infos = providerCacheData->connection;
 248         OCTransportAdapter newAdapter = provider->connection->addr->adapter;
 249         while (infos)
 250         {
 251             isSubscribing |= infos->isSubscribing;
 252             if (infos->addr->adapter == newAdapter && infos->isSubscribing == true)
 253             {
 254                 NS_LOG_V(DEBUG, "This provider already discovered : %s:%d",
 255                          infos->addr->addr, infos->addr->port);
 256                 NS_LOG_V(DEBUG, "Subscription : %d", infos->isSubscribing);
 257                 return;
 258             }
 259             infos = infos->next;
 260         }
 261     }
 262
 263     NSResult ret = NSProviderCacheUpdate(provider);
 264     NS_VERIFY_NOT_NULL_V(ret == NS_OK ? (void *) 1 : NULL);
 265
 266     if (isAdded == false)
 267     {
 268         NS_LOG(DEBUG, "New provider is discovered");
 269     }
 270     else
 271     {
 272         provider = providerCacheData;
 273         NS_LOG(DEBUG, "provider's connection is updated.");
 274     }
 275
 276     if (provider->accessPolicy == NS_SELECTION_CONSUMER && isSubscribing == false)
 277     {
 278         NS_LOG(DEBUG, "accepter is NS_ACCEPTER_CONSUMER, Callback to user");
 279         NSProvider * providerForCb = NSCopyProvider(provider);
 280         NSDiscoveredProvider(providerForCb);
 281     }
 282     else
 283     {
 284         NS_LOG(DEBUG, "accepter is NS_ACCEPTER_PROVIDER, request subscribe");
 285         NSProvider_internal * subProvider = NSCopyProvider_internal(provider);
 286         NSTask * task = NSMakeTask(TASK_CONSUMER_REQ_SUBSCRIBE, (void *) subProvider);
 287         NS_VERIFY_NOT_NULL_V(task);
 288
 289         NSConsumerPushEvent(task);
 290     }
 291
 292     NSRemoveProvider_internal(providerCacheData);
 293 }
 294
 295 void NSConsumerHandleProviderDeleted(NSProvider_internal * provider)
 296 {
 297     NS_VERIFY_NOT_NULL_V(provider);
 298
 299     NSCacheList * providerCache = *(NSGetProviderCacheList());
 300     NS_VERIFY_NOT_NULL_V(providerCache);
 301
 302     NSResult ret = NSStorageDelete(providerCache, provider->providerId);
 303     NS_VERIFY_NOT_NULL_V(ret == NS_OK ? (void *)1 : NULL);
 304 }
 305
 306 void NSConsumerHandleSubscribeSucceed(NSProvider_internal * provider)
 307 {
 308     NS_VERIFY_NOT_NULL_V(provider);
 309
 310     NSResult ret = NSProviderCacheUpdate(provider);
 311     NS_VERIFY_NOT_NULL_V(ret == NS_OK ? (void *) 1 : NULL);
 312 }
 313
 314 void NSConsumerHandleRecvProviderChanged(NSMessage * msg)
 315 {
 316     NS_VERIFY_NOT_NULL_V(msg);
 317
 318     NS_LOG_V(DEBUG, "confirmed by : %s", msg->providerId);
 319     NSProvider_internal * provider = NSProviderCacheFind(msg->providerId);
 320     NS_VERIFY_NOT_NULL_V(provider);
 321
 322     if (provider->connection->next == NULL && provider->accessPolicy == NS_SELECTION_CONSUMER)
 323     {
 324         NS_LOG(DEBUG, "call back to user");
 325         NSProvider * prov = NSCopyProvider(provider);
 326         NSProviderChanged(prov, (NSResponse) msg->messageId);
 327         NSRemoveProvider_internal(provider);
 328     }
 329 }
 330
 331 void NSConsumerHandleRecvMessage(NSMessage * msg)
 332 {
 333     NS_VERIFY_NOT_NULL_V(msg);
 334
 335     NSResult ret = NSMessageCacheUpdate(msg, NS_SYNC_UNREAD);
 336     NS_VERIFY_NOT_NULL_V(ret == NS_OK ? (void *) 1 : NULL);
 337
 338     NSMessagePost((NSMessage *) msg);
 339 }
 340
 341 void NSConsumerHandleRecvSyncInfo(NSSyncInfo * sync)
 342 {
 343     NS_VERIFY_NOT_NULL_V(sync);
 344
 345     char msgId[NS_DEVICE_ID_LENGTH] = { 0, };
 346     snprintf(msgId, NS_DEVICE_ID_LENGTH, "%lld", (long long int)sync->messageId);
 347
 348     NSMessage * msg = NSMessageCacheFind(msgId);
 349     NS_VERIFY_NOT_NULL_V(msg);
 350
 351     NSResult ret = NSMessageCacheUpdate(msg, sync->state);
 352     NS_VERIFY_NOT_NULL_V(ret == NS_OK ? (void *) 1 : NULL);
 353     NSRemoveMessage(msg);
 354
 355     NSNotificationSync(sync);
 356 }
 357
 358 void NSConsumerHandleMakeSyncInfo(NSSyncInfo * sync)
 359 {
 360     NS_VERIFY_NOT_NULL_V(sync);
 361
 362     NSProvider_internal * provider = NSProviderCacheFind(sync->providerId);
 363     NS_VERIFY_NOT_NULL_V (provider);
 364
 365     NSProviderConnectionInfo * connections = NSCopyProviderConnections(provider->connection);
 366     NS_VERIFY_NOT_NULL_V (connections);
 367
 368     NSSyncInfo_internal * syncInfo = (NSSyncInfo_internal *)OICMalloc(sizeof(NSSyncInfo_internal));
 369     NS_VERIFY_NOT_NULL_WITH_POST_CLEANING_V(syncInfo, NSRemoveConnections(connections));
 370
 371     OICStrcpy(syncInfo->providerId, sizeof(char) * NS_DEVICE_ID_LENGTH, sync->providerId);
 372     syncInfo->messageId = sync->messageId;
 373     syncInfo->state = sync->state;
 374     syncInfo->connection = connections;
 375
 376     NSTask * syncTask = NSMakeTask(TASK_SEND_SYNCINFO, (void *) syncInfo);
 377     NS_VERIFY_NOT_NULL_WITH_POST_CLEANING_V(syncTask, NSOICFree(syncInfo));
 378
 379     NSConsumerPushEvent(syncTask);
 380 }
 381
 382 void NSConsumerHandleGetTopicUri(NSMessage * msg)
 383 {
 384     NS_VERIFY_NOT_NULL_V(msg);
 385
 386     NSProvider_internal * provider = NSProviderCacheFind(msg->providerId);
 387     NS_VERIFY_NOT_NULL_V(provider);
 388
 389     NSTask * topicTask = NSMakeTask(TASK_CONSUMER_REQ_TOPIC_LIST, (void *) provider);
 390     NS_VERIFY_NOT_NULL_WITH_POST_CLEANING_V(topicTask, NSRemoveProvider_internal(provider));
 391
 392     NSConsumerPushEvent(topicTask);
 393 }
 394
 395 void NSConsumerHandleRecvTopicLL(NSProvider_internal * provider)
 396 {
 397     NS_VERIFY_NOT_NULL_V(provider);
 398
 399     NSResult ret = NSProviderCacheUpdate(provider);
 400     NS_VERIFY_NOT_NULL_V(ret == NS_OK ? (void *) 1 : NULL);
 401
 402     NS_LOG(DEBUG, "call back to user");
 403     NSProvider * prov = NSCopyProvider(provider);
 404     NSProviderChanged((NSProvider *) prov, (NSResponse) NS_TOPIC);
 405 }
 406
 407 void NSConsumerInternalTaskProcessing(NSTask * task)
 408 {
 409     NS_VERIFY_NOT_NULL_V(task);
 410
 411     NS_LOG_V(DEBUG, "Receive Event : %d", (int)task->taskType);
 412     switch (task->taskType)
 413     {
 414         case TASK_CONSUMER_SENT_REQ_OBSERVE:
 415         {
 416             NS_LOG(DEBUG, "Receive Subscribe succeed from provider.");
 417             NSConsumerHandleSubscribeSucceed((NSProvider_internal *)task->taskData);
 418             NSRemoveProvider_internal((NSProvider_internal *)task->taskData);
 419             break;
 420         }
 421         case TASK_CONSUMER_RECV_PROVIDER_CHANGED:
 422         {
 423             NS_LOG(DEBUG, "Receive Provider Changed");
 424             NSConsumerHandleRecvProviderChanged((NSMessage *)task->taskData);
 425             NSRemoveMessage((NSMessage *)task->taskData);
 426             break;
 427         }
 428         case TASK_CONSUMER_RECV_MESSAGE:
 429         {
 430             NS_LOG(DEBUG, "Receive New Notification");
 431             NSConsumerHandleRecvMessage((NSMessage *)task->taskData);
 432             NSRemoveMessage((NSMessage *)task->taskData);
 433             break;
 434         }
 435         case TASK_CONSUMER_PROVIDER_DISCOVERED:
 436         {
 437             NS_LOG(DEBUG, "Receive New Provider is discovered.");
 438             NSConsumerHandleProviderDiscovered((NSProvider_internal *)task->taskData);
 439             NSRemoveProvider_internal((NSProvider_internal *)task->taskData);
 440             break;
 441         }
 442         case TASK_RECV_SYNCINFO:
 443         {
 444             NS_LOG(DEBUG, "Receive SyncInfo.");
 445             NSConsumerHandleRecvSyncInfo((NSSyncInfo *)task->taskData);
 446             NSOICFree(task->taskData);
 447             break;
 448         }
 449         case TASK_MAKE_SYNCINFO:
 450         {
 451             NS_LOG(DEBUG, "Make SyncInfo, get Provider's Addr");
 452             NSConsumerHandleMakeSyncInfo((NSSyncInfo *)task->taskData);
 453             NSOICFree(task->taskData);
 454             break;
 455         }
 456         case TASK_CONSUMER_REQ_TOPIC_URI:
 457         {
 458             NS_LOG(DEBUG, "Request Topic Uri");
 459             NSConsumerHandleGetTopicUri((NSMessage *)task->taskData);
 460             NSRemoveMessage((NSMessage *)task->taskData);
 461             break;
 462         }
 463         case TASK_CONSUMER_RECV_TOPIC_LIST:
 464         {
 465             NS_LOG(DEBUG, "Receive Topic List");
 466             NSConsumerHandleRecvTopicLL((NSProvider_internal *)task->taskData);
 467             NSRemoveProvider_internal((NSProvider_internal *)task->taskData);
 468             break;
 469         }
 470         case TASK_CONSUMER_REQ_SUBSCRIBE_CANCEL:
 471         {
 472             NS_LOG(DEBUG, "Make Subscribe cancel from provider.");
 473             NSConsumerHandleProviderDeleted((NSProvider_internal *)task->taskData);
 474             NSRemoveProvider_internal((NSProvider_internal *)task->taskData);
 475             break;
 476         }
 477         default :
 478         {
 479             NS_LOG(ERROR, "Unknown TASK Type");
 480             return ;
 481         }
 482     }
 483     NSOICFree(task);
 484 }