resource: simpleserverHQ supports security PS
[iotivity.git] / resource / examples / simpleserverHQ.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 ///
22 /// This sample provides steps to define an interface for a resource
23 /// (properties and methods) and host this resource on the server.
24 ///
25
26 #include "iotivity_config.h"
27 #include <functional>
28
29 #ifdef HAVE_PTHREAD_H
30 #include <pthread.h>
31 #endif
32 #include <mutex>
33 #include <condition_variable>
34
35 #include "OCPlatform.h"
36 #include "OCApi.h"
37
38 #ifdef HAVE_WINDOWS_H
39 #include <windows.h>
40 #endif
41
42 #include "ocpayload.h"
43
44 using namespace OC;
45 using namespace std;
46 namespace PH = std::placeholders;
47
48 static const char* SVR_DB_FILE_NAME = "./oic_svr_db_server.dat";
49 int gObservation = 0;
50 void * ChangeLightRepresentation (void *param);
51
52 // Set of strings for each of platform Info fields
53 std::string  gPlatformId = "0A3E0D6F-DBF5-404E-8719-D6880042463A";
54 std::string  gManufacturerName = "OCF";
55 std::string  gManufacturerLink = "https://www.iotivity.org";
56 std::string  gModelNumber = "myModelNumber";
57 std::string  gDateOfManufacture = "2016-01-15";
58 std::string  gPlatformVersion = "myPlatformVersion";
59 std::string  gOperatingSystemVersion = "myOS";
60 std::string  gHardwareVersion = "myHardwareVersion";
61 std::string  gFirmwareVersion = "1.0";
62 std::string  gSupportLink = "https://www.iotivity.org";
63 std::string  gSystemTime = "2016-01-15T11.01";
64
65 // Set of strings for each of device info fields
66 std::string  deviceName = "IoTivity Simple Server HQ";
67 std::string  specVersion = "ocf.1.1.0";
68 std::vector<std::string> dataModelVersions = {"ocf.res.1.1.0"};
69 std::string  protocolIndependentID = "88b3584f-d7bc-4e56-9210-0e8b305202c3";
70
71 // OCPlatformInfo Contains all the platform info to be stored
72 OCPlatformInfo platformInfo;
73
74 // Specifies where to notify all observers or list of observers
75 // 0 - notifies all observers
76 // 1 - notifies list of observers
77 int isListOfObservers = 0;
78
79 /// This class represents a single resource named 'lightResource'. This resource has
80 /// two simple properties named 'state' and 'power'
81
82 class LightResource
83 {
84
85 public:
86     /// Access this property from a TB client
87     std::string m_name;
88     bool m_state;
89     int m_power;
90     std::string m_lightUri;
91     OCResourceHandle m_resourceHandle;
92     OCRepresentation m_lightRep;
93     ObservationIds m_interestedObservers;
94
95 public:
96     /// Constructor
97     LightResource(PlatformConfig& /*cfg*/)
98         :m_name("John's light"), m_state(false), m_power(0), m_lightUri("/a/light") {
99         // Initialize representation
100         m_lightRep.setUri(m_lightUri);
101
102         m_lightRep.setValue("state", m_state);
103         m_lightRep.setValue("power", m_power);
104         m_lightRep.setValue("name", m_name);
105     }
106
107     /* Note that this does not need to be a member function: for classes you do not have
108     access to, you can accomplish this with a free function: */
109
110     /// This function internally calls registerResource API.
111     void createResource()
112     {
113         std::string resourceURI = m_lightUri; // URI of the resource
114         // resource type name. In this case, it is light
115         std::string resourceTypeName = "core.light";
116         std::string resourceInterface = DEFAULT_INTERFACE; // resource interface.
117
118         // OCResourceProperty is defined ocstack.h
119         uint8_t resourceProperty = OC_DISCOVERABLE | OC_OBSERVABLE;
120
121         EntityHandler cb = std::bind(&LightResource::entityHandler, this,PH::_1);
122
123         // This will internally create and register the resource.
124         OCStackResult result = OCPlatform::registerResource(
125                                     m_resourceHandle, resourceURI, resourceTypeName,
126                                     resourceInterface, cb, resourceProperty);
127
128         if (OC_STACK_OK != result)
129         {
130             cout << "Resource creation was unsuccessful\n";
131         }
132     }
133
134     OCStackResult createResource1()
135     {
136         std::string resourceURI = "/a/light1"; // URI of the resource
137         std::string resourceTypeName = "core.light"; // resource type name. In this case, it is light
138         std::string resourceInterface = DEFAULT_INTERFACE; // resource interface.
139
140         // OCResourceProperty is defined ocstack.h
141         uint8_t resourceProperty = OC_DISCOVERABLE | OC_OBSERVABLE;
142
143         EntityHandler cb = std::bind(&LightResource::entityHandler, this,PH::_1);
144
145         OCResourceHandle resHandle;
146
147         // This will internally create and register the resource.
148         OCStackResult result = OCPlatform::registerResource(
149                                     resHandle, resourceURI, resourceTypeName,
150                                     resourceInterface, cb, resourceProperty);
151
152         if (OC_STACK_OK != result)
153         {
154             cout << "Resource creation was unsuccessful\n";
155         }
156
157         return result;
158     }
159
160     OCResourceHandle getHandle()
161     {
162         return m_resourceHandle;
163     }
164
165     // Puts representation.
166     // Gets values from the representation and
167     // updates the internal state
168     void put(OCRepresentation& rep)
169     {
170         try {
171             if (rep.getValue("state", m_state))
172             {
173                 cout << "\t\t\t\t" << "state: " << m_state << endl;
174             }
175             else
176             {
177                 cout << "\t\t\t\t" << "state not found in the representation" << endl;
178             }
179
180             if (rep.getValue("power", m_power))
181             {
182                 cout << "\t\t\t\t" << "power: " << m_power << endl;
183             }
184             else
185             {
186                 cout << "\t\t\t\t" << "power not found in the representation" << endl;
187             }
188         }
189         catch (exception& e)
190         {
191             cout << e.what() << endl;
192         }
193
194     }
195
196     // Post representation.
197     // Post can create new resource or simply act like put.
198     // Gets values from the representation and
199     // updates the internal state
200     OCRepresentation post(OCRepresentation& rep)
201     {
202         static int first = 1;
203
204         std::cout << "In POST\n";
205
206         // for the first time it tries to create a resource
207         if(first)
208         {
209             std::cout << "In POST/First\n";
210
211             first = 0;
212
213             if(OC_STACK_OK == createResource1())
214             {
215                 std::cout << "Created a new resource\n";
216                 OCRepresentation rep1;
217                 rep1.setValue("createduri", std::string("/a/light1"));
218
219                 return rep1;
220             }
221         }
222
223         // from second time onwards it just puts
224         put(rep);
225         return get();
226     }
227
228
229     // gets the updated representation.
230     // Updates the representation with latest internal state before
231     // sending out.
232     OCRepresentation get()
233     {
234         m_lightRep.setValue("state", m_state);
235         m_lightRep.setValue("power", m_power);
236
237         return m_lightRep;
238     }
239
240     void addType(const std::string& type) const
241     {
242         OCStackResult result = OCPlatform::bindTypeToResource(m_resourceHandle, type);
243         if (OC_STACK_OK != result)
244         {
245             cout << "Binding TypeName to Resource was unsuccessful\n";
246         }
247     }
248
249     void addInterface(const std::string& iface) const
250     {
251         OCStackResult result = OCPlatform::bindInterfaceToResource(m_resourceHandle, iface);
252         if (OC_STACK_OK != result)
253         {
254             cout << "Binding TypeName to Resource was unsuccessful\n";
255         }
256     }
257
258 private:
259
260 OCStackResult sendResponse(std::shared_ptr<OCResourceRequest> pRequest)
261 {
262     auto pResponse = std::make_shared<OC::OCResourceResponse>();
263     pResponse->setRequestHandle(pRequest->getRequestHandle());
264     pResponse->setResourceHandle(pRequest->getResourceHandle());
265     pResponse->setResourceRepresentation(get());
266
267     pResponse->setResponseResult(OC_EH_OK);
268
269     return OCPlatform::sendResponse(pResponse);
270 }
271
272 OCStackResult sendPostResponse(std::shared_ptr<OCResourceRequest> pRequest)
273 {
274     auto pResponse = std::make_shared<OC::OCResourceResponse>();
275     pResponse->setRequestHandle(pRequest->getRequestHandle());
276     pResponse->setResourceHandle(pRequest->getResourceHandle());
277
278     OCRepresentation rep = pRequest->getResourceRepresentation();
279     OCRepresentation rep_post = post(rep);
280
281     pResponse->setResourceRepresentation(rep_post);
282
283     pResponse->setResponseResult(OC_EH_OK);
284
285     return OCPlatform::sendResponse(pResponse);
286 }
287
288 // This is just a sample implementation of entity handler.
289 // Entity handler can be implemented in several ways by the manufacturer
290 OCEntityHandlerResult entityHandler(std::shared_ptr<OCResourceRequest> request)
291 {
292     cout << "\tIn Server CPP entity handler:\n";
293     OCEntityHandlerResult ehResult = OC_EH_ERROR;
294
295     if(request)
296     {
297         // Get the request type and request flag
298         std::string requestType = request->getRequestType();
299         int requestFlag = request->getRequestHandlerFlag();
300
301         if(requestFlag & RequestHandlerFlag::RequestFlag)
302         {
303             cout << "\t\trequestFlag : Request\n";
304
305             // If the request type is GET
306             if(requestType == "GET")
307             {
308                 cout << "\t\t\trequestType : GET\n";
309                 if(OC_STACK_OK == sendResponse(request))
310                 {
311                     ehResult = OC_EH_OK;
312                 }
313             }
314             else if(requestType == "PUT")
315             {
316                 cout << "\t\t\trequestType : PUT\n";
317
318                 OCRepresentation rep = request->getResourceRepresentation();
319                 // Do related operations related to PUT request
320                 // Update the lightResource
321                 put(rep);
322                 if(OC_STACK_OK == sendResponse(request))
323                 {
324                     ehResult = OC_EH_OK;
325                 }
326             }
327             else if(requestType == "POST")
328             {
329                 cout << "\t\t\trequestType : POST\n";
330                 if(OC_STACK_OK == sendPostResponse(request))
331                 {
332                     ehResult = OC_EH_OK;
333                 }
334             }
335             else if(requestType == "DELETE")
336             {
337                 // DELETE request operations
338             }
339         }
340
341         if(requestFlag & RequestHandlerFlag::ObserverFlag)
342         {
343             ObservationInfo observationInfo = request->getObservationInfo();
344             if(ObserveAction::ObserveRegister == observationInfo.action)
345             {
346                 m_interestedObservers.push_back(observationInfo.obsId);
347             }
348             else if(ObserveAction::ObserveUnregister == observationInfo.action)
349             {
350                 m_interestedObservers.erase(std::remove(
351                                                             m_interestedObservers.begin(),
352                                                             m_interestedObservers.end(),
353                                                             observationInfo.obsId),
354                                                             m_interestedObservers.end());
355             }
356
357             pthread_t threadId;
358
359             cout << "\t\trequestFlag : Observer\n";
360             gObservation = 1;
361             static int startedThread = 0;
362
363             // Observation happens on a different thread in ChangeLightRepresentation function.
364             // If we have not created the thread already, we will create one here.
365             if(!startedThread)
366             {
367                 pthread_create (&threadId, NULL, ChangeLightRepresentation, (void *)this);
368                 startedThread = 1;
369             }
370             ehResult = OC_EH_OK;
371         }
372     }
373     else
374     {
375         std::cout << "Request invalid" << std::endl;
376     }
377
378     return ehResult;
379 }
380
381 };
382
383 // ChangeLightRepresentaion is an observation function,
384 // which notifies any changes to the resource to stack
385 // via notifyObservers
386 void * ChangeLightRepresentation (void *param)
387 {
388     LightResource* lightPtr = (LightResource*) param;
389
390     // This function continuously monitors for the changes
391     while (1)
392     {
393         sleep (3);
394
395         if (gObservation)
396         {
397             // If under observation if there are any changes to the light resource
398             // we call notifyObservors
399             //
400             // For demostration we are changing the power value and notifying.
401             lightPtr->m_power += 10;
402
403             cout << "\nPower updated to : " << lightPtr->m_power << endl;
404             cout << "Notifying observers with resource handle: " << lightPtr->getHandle() << endl;
405
406             OCStackResult result = OC_STACK_OK;
407
408             if(isListOfObservers)
409             {
410                 std::shared_ptr<OCResourceResponse> resourceResponse =
411                             std::make_shared<OCResourceResponse>();
412
413                 resourceResponse->setResourceRepresentation(lightPtr->get(), DEFAULT_INTERFACE);
414
415                 result = OCPlatform::notifyListOfObservers(
416                                                             lightPtr->getHandle(),
417                                                             lightPtr->m_interestedObservers,
418                                                             resourceResponse,
419                                                             OC::QualityOfService::HighQos);
420             }
421             else
422             {
423                 result = OCPlatform::notifyAllObservers(lightPtr->getHandle(),
424                                                             OC::QualityOfService::HighQos);
425             }
426
427             if(OC_STACK_NO_OBSERVERS == result)
428             {
429                 cout << "No More observers, stopping notifications" << endl;
430                 gObservation = 0;
431             }
432         }
433     }
434
435     return NULL;
436 }
437
438 void DeletePlatformInfo()
439 {
440     delete[] platformInfo.platformID;
441     delete[] platformInfo.manufacturerName;
442     delete[] platformInfo.manufacturerUrl;
443     delete[] platformInfo.modelNumber;
444     delete[] platformInfo.dateOfManufacture;
445     delete[] platformInfo.platformVersion;
446     delete[] platformInfo.operatingSystemVersion;
447     delete[] platformInfo.hardwareVersion;
448     delete[] platformInfo.firmwareVersion;
449     delete[] platformInfo.supportUrl;
450     delete[] platformInfo.systemTime;
451 }
452
453 void DuplicateString(char ** targetString, std::string sourceString)
454 {
455     *targetString = new char[sourceString.length() + 1];
456     strncpy(*targetString, sourceString.c_str(), (sourceString.length() + 1));
457 }
458
459 OCStackResult SetPlatformInfo(std::string platformID, std::string manufacturerName,
460         std::string manufacturerUrl, std::string modelNumber, std::string dateOfManufacture,
461         std::string platformVersion, std::string operatingSystemVersion,
462         std::string hardwareVersion, std::string firmwareVersion, std::string supportUrl,
463         std::string systemTime)
464 {
465     DuplicateString(&platformInfo.platformID, platformID);
466     DuplicateString(&platformInfo.manufacturerName, manufacturerName);
467     DuplicateString(&platformInfo.manufacturerUrl, manufacturerUrl);
468     DuplicateString(&platformInfo.modelNumber, modelNumber);
469     DuplicateString(&platformInfo.dateOfManufacture, dateOfManufacture);
470     DuplicateString(&platformInfo.platformVersion, platformVersion);
471     DuplicateString(&platformInfo.operatingSystemVersion, operatingSystemVersion);
472     DuplicateString(&platformInfo.hardwareVersion, hardwareVersion);
473     DuplicateString(&platformInfo.firmwareVersion, firmwareVersion);
474     DuplicateString(&platformInfo.supportUrl, supportUrl);
475     DuplicateString(&platformInfo.systemTime, systemTime);
476
477     return OC_STACK_OK;
478 }
479
480 OCStackResult SetDeviceInfo()
481 {
482     OCStackResult result = OCPlatform::setPropertyValue(PAYLOAD_TYPE_DEVICE, OC_RSRVD_DEVICE_NAME,
483                                                         deviceName);
484     if (result != OC_STACK_OK)
485     {
486         cout << "Failed to set device name" << endl;
487         return result;
488     }
489
490     result = OCPlatform::setPropertyValue(PAYLOAD_TYPE_DEVICE, OC_RSRVD_DATA_MODEL_VERSION,
491                                           dataModelVersions);
492     if (result != OC_STACK_OK)
493     {
494         cout << "Failed to set data model versions" << endl;
495         return result;
496     }
497
498     result = OCPlatform::setPropertyValue(PAYLOAD_TYPE_DEVICE, OC_RSRVD_SPEC_VERSION, specVersion);
499     if (result != OC_STACK_OK)
500     {
501         cout << "Failed to set spec version" << endl;
502         return result;
503     }
504
505     result = OCPlatform::setPropertyValue(PAYLOAD_TYPE_DEVICE, OC_RSRVD_PROTOCOL_INDEPENDENT_ID,
506                                           protocolIndependentID);
507     if (result != OC_STACK_OK)
508     {
509         cout << "Failed to set piid" << endl;
510         return result;
511     }
512
513     return OC_STACK_OK;
514 }
515
516 void PrintUsage()
517 {
518     std::cout << std::endl;
519     std::cout << "Usage : simpleserverHQ <ObserveType>\n";
520     std::cout << "   ObserveType : 0 - Observe All\n";
521     std::cout << "   ObserveType : 1 - Observe List of observers\n\n";
522 }
523
524 static FILE* override_fopen(const char* path, const char* mode)
525 {
526     char const * filename = path;
527     if (0 == strcmp(path, OC_SECURITY_DB_DAT_FILE_NAME))
528     {
529         filename = SVR_DB_FILE_NAME;
530     }
531     return fopen(filename, mode);
532 }
533
534 int main(int argc, char* argv[])
535 {
536     PrintUsage();
537     OCPersistentStorage ps {override_fopen, fread, fwrite, fclose, unlink };
538
539     if (argc == 1)
540     {
541         isListOfObservers = 0;
542     }
543     else if (argc == 2)
544     {
545         int value = atoi(argv[1]);
546         if (value == 1)
547             isListOfObservers = 1;
548         else
549             isListOfObservers = 0;
550     }
551     else
552     {
553         return -1;
554     }
555
556     // Create PlatformConfig object
557     PlatformConfig cfg {
558         OC::ServiceType::InProc,
559         OC::ModeType::Server,
560         "0.0.0.0", // By setting to "0.0.0.0", it binds to all available interfaces
561         0,         // Uses randomly available port
562         OC::QualityOfService::LowQos,
563         &ps
564     };
565
566     OCPlatform::Configure(cfg);
567     std::cout << "Starting server & setting platform info\n";
568
569     OCStackResult result = SetPlatformInfo(gPlatformId, gManufacturerName, gManufacturerLink,
570             gModelNumber, gDateOfManufacture, gPlatformVersion, gOperatingSystemVersion,
571             gHardwareVersion, gFirmwareVersion, gSupportLink, gSystemTime);
572
573     result = OCPlatform::registerPlatformInfo(platformInfo);
574
575     if (result != OC_STACK_OK)
576     {
577         std::cout << "Platform Registration failed\n";
578         return -1;
579     }
580
581     result = SetDeviceInfo();
582
583     if (result != OC_STACK_OK)
584     {
585         std::cout << "Device Registration failed\n";
586         return -1;
587     }
588
589     try
590     {
591         // Create the instance of the resource class
592         // (in this case instance of class 'LightResource').
593         LightResource myLight(cfg);
594
595         // Invoke createResource function of class light.
596         myLight.createResource();
597
598         myLight.addType(std::string("core.brightlight"));
599         myLight.addInterface(std::string(LINK_INTERFACE));
600
601         DeletePlatformInfo();
602
603         // A condition variable will free the mutex it is given, then do a non-
604         // intensive block until 'notify' is called on it.  In this case, since we
605         // don't ever call cv.notify, this should be a non-processor intensive version
606         // of while(true);
607         std::mutex blocker;
608         std::condition_variable cv;
609         std::unique_lock<std::mutex> lock(blocker);
610         cv.wait(lock, []{return false;});
611     }
612     catch(OCException& e)
613     {
614         oclog() << "Exception in main: "<< e.what();
615     }
616
617     // No explicit call to stop the platform.
618     // When OCPlatform destructor is invoked, internally we do platform cleanup
619
620     return 0;
621 }
622