resource/src/InProcServerWrapper.cpp

   1 //******************************************************************
   2 //
   3 // Copyright 2014 Intel Mobile Communications GmbH 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 <random>
  22 #include <cstring>
  23 #include <cstdlib>
  24 #include <iostream>
  25 #include <algorithm>
  26 #include <map>
  27 #include <sstream>
  28 #include <string>
  29
  30 #include <InProcServerWrapper.h>
  31 #include <InitializeException.h>
  32 #include <OCResourceRequest.h>
  33 #include <OCResourceResponse.h>
  34 #include <ocstack.h>
  35 #include <OCApi.h>
  36 #include <oic_malloc.h>
  37 #include <OCPlatform.h>
  38 #include <OCUtilities.h>
  39
  40 using namespace std;
  41 using namespace OC;
  42
  43 namespace OC
  44 {
  45     namespace details
  46     {
  47         std::mutex serverWrapperLock;
  48         std::map <OCResourceHandle, OC::EntityHandler>  entityHandlerMap;
  49         std::map <OCResourceHandle, std::string> resourceUriMap;
  50         EntityHandler defaultDeviceEntityHandler = 0;
  51     }
  52 }
  53
  54 void formResourceRequest(OCEntityHandlerFlag flag,
  55                          OCEntityHandlerRequest * entityHandlerRequest,
  56                          std::shared_ptr<OCResourceRequest> pRequest)
  57 {
  58     if(pRequest && entityHandlerRequest)
  59     {
  60         pRequest->setRequestHandle(entityHandlerRequest->requestHandle);
  61         pRequest->setResourceHandle(entityHandlerRequest->resource);
  62     }
  63
  64     if(flag & OC_REQUEST_FLAG)
  65     {
  66         pRequest->setRequestHandlerFlag(OC::RequestHandlerFlag::RequestFlag);
  67
  68         if(entityHandlerRequest)
  69         {
  70             if(entityHandlerRequest->query)
  71             {
  72                 OC::Utilities::QueryParamsKeyVal qp = OC::Utilities::getQueryParams(
  73                         entityHandlerRequest->query);
  74
  75                 if(qp.size() > 0)
  76                 {
  77                     pRequest->setQueryParams(qp);
  78                 }
  79             }
  80             if(entityHandlerRequest->numRcvdVendorSpecificHeaderOptions != 0)
  81             {
  82                 //Set the header options here.
  83                 uint16_t optionID;
  84                 std::string optionData;
  85                 HeaderOptions headerOptions;
  86
  87                 for(int i = 0;
  88                     i < entityHandlerRequest->numRcvdVendorSpecificHeaderOptions;
  89                     i++)
  90                 {
  91                     optionID = entityHandlerRequest->rcvdVendorSpecificHeaderOptions[i].optionID;
  92                     optionData = reinterpret_cast<const char*>
  93                              (entityHandlerRequest->rcvdVendorSpecificHeaderOptions[i].optionData);
  94                     HeaderOption::OCHeaderOption headerOption(optionID, optionData);
  95                     headerOptions.push_back(headerOption);
  96                 }
  97                 pRequest->setHeaderOptions(headerOptions);
  98             }
  99
 100             if(OC_REST_GET == entityHandlerRequest->method)
 101             {
 102                 pRequest->setRequestType(OC::PlatformCommands::GET);
 103             }
 104             else if(OC_REST_PUT == entityHandlerRequest->method)
 105             {
 106                 pRequest->setRequestType(OC::PlatformCommands::PUT);
 107                 pRequest->setPayload(entityHandlerRequest->payload);
 108             }
 109             else if(OC_REST_POST == entityHandlerRequest->method)
 110             {
 111                 pRequest->setRequestType(OC::PlatformCommands::POST);
 112                 pRequest->setPayload(entityHandlerRequest->payload);
 113             }
 114             else if(OC_REST_DELETE == entityHandlerRequest->method)
 115             {
 116                 pRequest->setRequestType(OC::PlatformCommands::DELETE);
 117             }
 118         }
 119     }
 120
 121     if(flag & OC_OBSERVE_FLAG)
 122     {
 123         pRequest->setRequestHandlerFlag(
 124                    OC::RequestHandlerFlag::RequestFlag | OC::RequestHandlerFlag::ObserverFlag);
 125
 126         if(entityHandlerRequest)
 127         {
 128             OC::ObservationInfo observationInfo;
 129             observationInfo.action = (OC::ObserveAction) entityHandlerRequest->obsInfo.action;
 130             observationInfo.obsId = entityHandlerRequest->obsInfo.obsId;
 131             pRequest->setObservationInfo(observationInfo);
 132         }
 133     }
 134 }
 135
 136 OCEntityHandlerResult DefaultEntityHandlerWrapper(OCEntityHandlerFlag flag,
 137                                                   OCEntityHandlerRequest * entityHandlerRequest,
 138                                                   char* uri,
 139                                                   void * callbackParam)
 140 {
 141     OCEntityHandlerResult result = OC_EH_ERROR;
 142
 143     OC::oclog() << "In Default device entity handler wrapper";
 144
 145     if(NULL == entityHandlerRequest)
 146     {
 147         oclog() << "Entity handler request is NULL.";
 148         return OC_EH_ERROR;
 149     }
 150
 151     auto pRequest = std::make_shared<OC::OCResourceRequest>();
 152
 153     formResourceRequest(flag, entityHandlerRequest, pRequest);
 154
 155     pRequest->setResourceUri(std::string(uri));
 156
 157     EntityHandler defHandler;
 158     {
 159         std::lock_guard<std::mutex> lock(OC::details::serverWrapperLock);
 160         defHandler = OC::details::defaultDeviceEntityHandler;
 161     }
 162
 163     if(defHandler)
 164     {
 165         result = defHandler(pRequest);
 166     }
 167     else
 168     {
 169         oclog() << "Default device entity handler was not set.";
 170         return OC_EH_ERROR;
 171     }
 172
 173     return result;
 174 }
 175
 176
 177 OCEntityHandlerResult EntityHandlerWrapper(OCEntityHandlerFlag flag,
 178                                            OCEntityHandlerRequest * entityHandlerRequest,
 179                                            void* callbackParam)
 180 {
 181     OCEntityHandlerResult result = OC_EH_ERROR;
 182
 183     oclog() << "\nIn entity handler wrapper: " << endl;
 184
 185     if(NULL == entityHandlerRequest)
 186     {
 187         oclog() << "Entity handler request is NULL."  << endl;
 188         return OC_EH_ERROR;
 189     }
 190
 191     auto pRequest = std::make_shared<OC::OCResourceRequest>();
 192
 193     formResourceRequest(flag, entityHandlerRequest, pRequest);
 194
 195     std::map <OCResourceHandle, std::string>::iterator resourceUriEntry;
 196     std::map <OCResourceHandle, std::string>::iterator resourceUriEnd;
 197     {
 198         std::lock_guard<std::mutex> lock(OC::details::serverWrapperLock);
 199         resourceUriEntry = OC::details::resourceUriMap.find(entityHandlerRequest->resource);
 200         resourceUriEnd = OC::details::resourceUriMap.end();
 201     }
 202     // Finding the corresponding URI for a resource handle and set the URI in the request
 203     if(resourceUriEntry != resourceUriEnd)
 204     {
 205         pRequest->setResourceUri(resourceUriEntry->second);
 206     }
 207     else
 208     {
 209         oclog() << "Resource handle not found; Resource URI not set in request";
 210         return OC_EH_ERROR;
 211     }
 212
 213     std::map <OCResourceHandle, OC::EntityHandler>::iterator entityHandlerEntry;
 214     std::map <OCResourceHandle, OC::EntityHandler>::iterator entityHandlerEnd;
 215     {
 216         // Finding the corresponding CPP Application entityHandler for a given resource
 217         std::lock_guard<std::mutex> lock(OC::details::serverWrapperLock);
 218         entityHandlerEntry = OC::details::entityHandlerMap.find(entityHandlerRequest->resource);
 219         entityHandlerEnd = OC::details::entityHandlerMap.end();
 220     }
 221
 222     if(entityHandlerEntry != entityHandlerEnd)
 223     {
 224         // Call CPP Application Entity Handler
 225         if(entityHandlerEntry->second)
 226         {
 227             result = entityHandlerEntry->second(pRequest);
 228         }
 229         else
 230         {
 231             oclog() << "C stack should not call again for parent resource\n";
 232             return OC_EH_ERROR;
 233         }
 234     }
 235     else
 236     {
 237         oclog() << "No entity handler found."  << endl;
 238         return OC_EH_ERROR;
 239     }
 240
 241     return result;
 242 }
 243
 244 namespace OC
 245 {
 246     InProcServerWrapper::InProcServerWrapper(
 247         std::weak_ptr<std::recursive_mutex> csdkLock, PlatformConfig cfg)
 248      : m_csdkLock(csdkLock)
 249     {
 250         OCMode initType;
 251
 252         if(cfg.mode == ModeType::Server)
 253         {
 254             initType = OC_SERVER;
 255         }
 256         else if (cfg.mode == ModeType::Both)
 257         {
 258             initType = OC_CLIENT_SERVER;
 259         }
 260         else
 261         {
 262             throw InitializeException(OC::InitException::NOT_CONFIGURED_AS_SERVER,
 263                                          OC_STACK_INVALID_PARAM);
 264         }
 265
 266         OCTransportFlags serverFlags =
 267                             static_cast<OCTransportFlags>(cfg.serverConnectivity & CT_MASK_FLAGS);
 268         OCTransportFlags clientFlags =
 269                             static_cast<OCTransportFlags>(cfg.clientConnectivity & CT_MASK_FLAGS);
 270         OCStackResult result = OCInit1(initType, serverFlags, clientFlags);
 271
 272         if(OC_STACK_OK != result)
 273         {
 274             throw InitializeException(OC::InitException::STACK_INIT_ERROR, result);
 275         }
 276
 277         m_threadRun = true;
 278         m_processThread = std::thread(&InProcServerWrapper::processFunc, this);
 279     }
 280
 281     void InProcServerWrapper::processFunc()
 282     {
 283         auto cLock = m_csdkLock.lock();
 284         while(cLock && m_threadRun)
 285         {
 286             OCStackResult result;
 287
 288             {
 289                 std::lock_guard<std::recursive_mutex> lock(*cLock);
 290                 result = OCProcess();
 291             }
 292
 293             if(OC_STACK_ERROR == result)
 294             {
 295                 oclog() << "OCProcess failed with result " << result <<std::flush;
 296                 // ...the value of variable result is simply ignored for now.
 297             }
 298
 299             std::this_thread::sleep_for(std::chrono::milliseconds(10));
 300         }
 301     }
 302
 303     OCStackResult InProcServerWrapper::registerDeviceInfo(const OCDeviceInfo deviceInfo)
 304     {
 305         auto cLock = m_csdkLock.lock();
 306         OCStackResult result = OC_STACK_ERROR;
 307         if(cLock)
 308         {
 309             std::lock_guard<std::recursive_mutex> lock(*cLock);
 310             result = OCSetDeviceInfo(deviceInfo);
 311         }
 312         return result;
 313     }
 314
 315      OCStackResult InProcServerWrapper::registerPlatformInfo(const OCPlatformInfo platformInfo)
 316     {
 317         auto cLock = m_csdkLock.lock();
 318         OCStackResult result = OC_STACK_ERROR;
 319         if(cLock)
 320         {
 321             std::lock_guard<std::recursive_mutex> lock(*cLock);
 322             result = OCSetPlatformInfo(platformInfo);
 323         }
 324         return result;
 325     }
 326
 327     OCStackResult InProcServerWrapper::registerResource(
 328                     OCResourceHandle& resourceHandle,
 329                     std::string& resourceURI,
 330                     const std::string& resourceTypeName,
 331                     const std::string& resourceInterface,
 332                     EntityHandler& eHandler,
 333                     uint8_t resourceProperties)
 334
 335     {
 336         OCStackResult result = OC_STACK_ERROR;
 337
 338         auto cLock = m_csdkLock.lock();
 339
 340         if(cLock)
 341         {
 342             std::lock_guard<std::recursive_mutex> lock(*cLock);
 343
 344             if(NULL != eHandler)
 345             {
 346                 result = OCCreateResource(&resourceHandle, // OCResourceHandle *handle
 347                             resourceTypeName.c_str(), // const char * resourceTypeName
 348                             resourceInterface.c_str(), //const char * resourceInterfaceName //TODO fix this
 349                             resourceURI.c_str(), // const char * uri
 350                             EntityHandlerWrapper, // OCEntityHandler entityHandler
 351                             NULL,
 352                             resourceProperties // uint8_t resourceProperties
 353                             );
 354             }
 355             else
 356             {
 357                 result = OCCreateResource(&resourceHandle, // OCResourceHandle *handle
 358                             resourceTypeName.c_str(), // const char * resourceTypeName
 359                             resourceInterface.c_str(), //const char * resourceInterfaceName //TODO fix this
 360                             resourceURI.c_str(), // const char * uri
 361                             NULL, // OCEntityHandler entityHandler
 362                             NULL,
 363                             resourceProperties // uint8_t resourceProperties
 364                             );
 365             }
 366
 367             if(result != OC_STACK_OK)
 368             {
 369                 resourceHandle = (OCResourceHandle) 0;
 370             }
 371             else
 372             {
 373                 std::lock_guard<std::mutex> lock(OC::details::serverWrapperLock);
 374                 OC::details::entityHandlerMap[resourceHandle] = eHandler;
 375                 OC::details::resourceUriMap[resourceHandle] = resourceURI;
 376             }
 377         }
 378         else
 379         {
 380             result = OC_STACK_ERROR;
 381         }
 382
 383         return result;
 384     }
 385
 386
 387
 388     OCStackResult InProcServerWrapper::setDefaultDeviceEntityHandler
 389                                         (EntityHandler entityHandler)
 390     {
 391         OCStackResult result = OC_STACK_ERROR;
 392
 393         {
 394             std::lock_guard<std::mutex> lock(OC::details::serverWrapperLock);
 395             OC::details::defaultDeviceEntityHandler = entityHandler;
 396         }
 397
 398         if(entityHandler)
 399         {
 400             result = OCSetDefaultDeviceEntityHandler(DefaultEntityHandlerWrapper, NULL);
 401         }
 402         else
 403         {
 404             // If Null passed we unset
 405             result = OCSetDefaultDeviceEntityHandler(NULL, NULL);
 406         }
 407
 408         return result;
 409     }
 410
 411     OCStackResult InProcServerWrapper::unregisterResource(const OCResourceHandle& resourceHandle)
 412     {
 413         auto cLock = m_csdkLock.lock();
 414         OCStackResult result = OC_STACK_ERROR;
 415
 416         if(cLock)
 417         {
 418             std::lock_guard<std::recursive_mutex> lock(*cLock);
 419             result = OCDeleteResource(resourceHandle);
 420
 421             if(result == OC_STACK_OK)
 422             {
 423                 std::lock_guard<std::mutex> lock(OC::details::serverWrapperLock);
 424                 OC::details::resourceUriMap.erase(resourceHandle);
 425             }
 426             else
 427             {
 428                 throw OCException(OC::Exception::RESOURCE_UNREG_FAILED, result);
 429             }
 430         }
 431         else
 432         {
 433             result = OC_STACK_ERROR;
 434         }
 435
 436         return result;
 437     }
 438
 439     OCStackResult InProcServerWrapper::bindTypeToResource(const OCResourceHandle& resourceHandle,
 440                      const std::string& resourceTypeName)
 441     {
 442         auto cLock = m_csdkLock.lock();
 443         OCStackResult result;
 444         if(cLock)
 445         {
 446             std::lock_guard<std::recursive_mutex> lock(*cLock);
 447             result = OCBindResourceTypeToResource(resourceHandle, resourceTypeName.c_str());
 448         }
 449         else
 450         {
 451             result = OC_STACK_ERROR;
 452         }
 453
 454         if (result != OC_STACK_OK)
 455         {
 456             throw OCException(OC::Exception::BIND_TYPE_FAILED, result);
 457         }
 458         return result;
 459     }
 460
 461     OCStackResult InProcServerWrapper::bindInterfaceToResource(
 462                      const OCResourceHandle& resourceHandle,
 463                      const std::string& resourceInterfaceName)
 464     {
 465         auto cLock = m_csdkLock.lock();
 466         OCStackResult result;
 467         if(cLock)
 468         {
 469             std::lock_guard<std::recursive_mutex> lock(*cLock);
 470             result = OCBindResourceInterfaceToResource(resourceHandle,
 471                         resourceInterfaceName.c_str());
 472         }
 473         else
 474         {
 475             result = OC_STACK_ERROR;
 476         }
 477
 478         if (result != OC_STACK_OK)
 479         {
 480             throw OCException(OC::Exception::BIND_INTERFACE_FAILED, result);
 481         }
 482         return result;
 483     }
 484
 485     OCStackResult InProcServerWrapper::startPresence(const unsigned int seconds)
 486     {
 487         auto cLock = m_csdkLock.lock();
 488         OCStackResult result = OC_STACK_ERROR;
 489         if(cLock)
 490         {
 491             std::lock_guard<std::recursive_mutex> lock(*cLock);
 492             result = OCStartPresence(seconds);
 493         }
 494
 495         if(result != OC_STACK_OK)
 496         {
 497             throw OCException(OC::Exception::START_PRESENCE_FAILED, result);
 498         }
 499         return result;
 500     }
 501
 502     OCStackResult InProcServerWrapper::stopPresence()
 503     {
 504         auto cLock = m_csdkLock.lock();
 505         OCStackResult result = OC_STACK_ERROR;
 506         if(cLock)
 507         {
 508             std::lock_guard<std::recursive_mutex> lock(*cLock);
 509             result = OCStopPresence();
 510         }
 511
 512         if(result != OC_STACK_OK)
 513         {
 514             throw OCException(OC::Exception::END_PRESENCE_FAILED, result);
 515         }
 516         return result;
 517     }
 518
 519     OCStackResult InProcServerWrapper::sendResponse(
 520         const std::shared_ptr<OCResourceResponse> pResponse)
 521     {
 522         auto cLock = m_csdkLock.lock();
 523         OCStackResult result = OC_STACK_ERROR;
 524
 525         if(!pResponse)
 526         {
 527             result = OC_STACK_MALFORMED_RESPONSE;
 528             throw OCException(OC::Exception::STR_NULL_RESPONSE, OC_STACK_MALFORMED_RESPONSE);
 529         }
 530         else
 531         {
 532             OCEntityHandlerResponse response;
 533 //            OCRepPayload* payLoad = pResponse->getPayload();
 534             HeaderOptions serverHeaderOptions = pResponse->getHeaderOptions();
 535
 536             response.requestHandle = pResponse->getRequestHandle();
 537             response.resourceHandle = pResponse->getResourceHandle();
 538             response.ehResult = pResponse->getResponseResult();
 539
 540             response.payload = reinterpret_cast<OCPayload*>(pResponse->getPayload());
 541
 542             response.persistentBufferFlag = 0;
 543
 544             response.numSendVendorSpecificHeaderOptions = serverHeaderOptions.size();
 545             int i = 0;
 546             for (auto it=serverHeaderOptions.begin(); it != serverHeaderOptions.end(); ++it)
 547             {
 548                 response.sendVendorSpecificHeaderOptions[i].protocolID = OC_COAP_ID;
 549                 response.sendVendorSpecificHeaderOptions[i].optionID =
 550                     static_cast<uint16_t>(it->getOptionID());
 551                 response.sendVendorSpecificHeaderOptions[i].optionLength =
 552                     (it->getOptionData()).length() + 1;
 553                 std::string optionData = it->getOptionData();
 554                 std::copy(optionData.begin(),
 555                          optionData.end(),
 556                          response.sendVendorSpecificHeaderOptions[i].optionData);
 557                 response.sendVendorSpecificHeaderOptions[i].optionData[it->getOptionData().length()]
 558                     = '\0';
 559                 i++;
 560             }
 561
 562             if(OC_EH_RESOURCE_CREATED == response.ehResult)
 563             {
 564                 pResponse->getNewResourceUri().copy(response.resourceUri,
 565                         sizeof (response.resourceUri) - 1);
 566                 response.resourceUri[pResponse->getNewResourceUri().length()] = '\0';
 567             }
 568
 569             if(cLock)
 570             {
 571                 std::lock_guard<std::recursive_mutex> lock(*cLock);
 572                 result = OCDoResponse(&response);
 573             }
 574             else
 575             {
 576                 OICFree(response.payload);
 577                 result = OC_STACK_ERROR;
 578             }
 579
 580             if(result != OC_STACK_OK)
 581             {
 582                 oclog() << "Error sending response\n";
 583             }
 584             return result;
 585         }
 586     }
 587
 588     InProcServerWrapper::~InProcServerWrapper()
 589     {
 590         if(m_processThread.joinable())
 591         {
 592             m_threadRun = false;
 593             m_processThread.join();
 594         }
 595
 596         OCStop();
 597     }
 598 }
 599