path: root/src/Server.cpp

// Copyright 2017 Paul Nettle. 
// 
// This file is part of Gobbledegook. 
// 
// Gobbledegook is free software: you can redistribute it and/or modify 
// it under the terms of the GNU General Public License as published by 
// the Free Software Foundation, either version 3 of the License, or 
// (at your option) any later version. 
// 
// Gobbledegook is distributed in the hope that it will be useful, 
// but WITHOUT ANY WARRANTY; without even the implied warranty of 
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the 
// GNU General Public License for more details. 
// 
// You should have received a copy of the GNU General Public License 
// along with Gobbledegook.  If not, see <http://www.gnu.org/licenses/>. 
 
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
// 
// >> 
// >>>  INSIDE THIS FILE 
// >> 
// 
// This is the money file. This is your server description and complete implementation. If you want to add or remove a Bluetooth 
// service, alter its behavior, add or remove characteristics or descriptors (and more), then this is your new home. 
// 
// >> 
// >>>  DISCUSSION 
// >> 
// 
// The use of the term 'server', as it is used here, refers a collection of BlueZ services, characteristics & Descripors (plus 
// a little more.) 
// 
// Our server needs to be described in two ways. Why two? Well, think about it like this: We're communicating with Bluetooth 
// clients through BlueZ, and we're communicating with BlueZ through D-Bus. In essence, BlueZ and D-Bus are acting as tunnels, one 
// inside the other. 
// 
// Here are those two descriptions in a bit more detail: 
// 
// 1. We need to describe ourselves as a citizen on D-Bus: The objects we implement, interfaces we provide, methods we handle, etc. 
// 
//    To accomplish this, we need to build an XML description (called an 'Introspection' for the curious readers) of our DBus 
//    object hierarchy. The code for the XML generation starts in DBusObject.cpp (see `generateIntrospectionXML`) and carries on 
//    throughout the other DBus* files (and even a few Gatt* files). 
// 
// 2. We also need to describe ourselves as a Bluetooth citizen: The services we provide, our characteristics and descriptors. 
// 
//    To accomplish this, BlueZ requires us to implement a standard D-Bus interface ('org.freedesktop.DBus.ObjectManager'). This 
//    interface includes a D-Bus method 'GetManagedObjects', which is just a standardized way for somebody (say... BlueZ) to ask a 
//    D-Bus entity (say... this server) to enumerate itself. This is how BlueZ figures out what services we offer. BlueZ will 
//    essentially forward this information to Bluetooth clients. 
// 
// Although these two descriptions work at different levels, the two need to be kept in sync. In addition, we will also need to act 
// on the messages we receive from our Bluetooth clients (through BlueZ, through D-Bus.) This means that we'll have yet another 
// synchronization issue to resolve, which is to ensure that whatever has been asked of us, makes its way to the correct code in 
// our description so we do the right thing. 
// 
// I don't know about you, but when dealing with data and the concepts "multiple" and "kept in sync" come into play, my spidey 
// sense starts to tingle. The best way to ensure sychronization is to remove the need to keep things sychronized. 
// 
// The large code block below defines a description that includes all the information about our server in a way that can be easily 
// used to generate both: (1) the D-Bus object hierarchy and (2) the BlueZ services that occupy that hierarchy. In addition, we'll 
// take that a step further by including the implementation right inside the description. Everything in one place. 
// 
// >> 
// >>>  MANAGING SERVER DATA 
// >> 
// 
// The purpose of the server is to serve data. Your application is responsible for providing that data to the server via two data 
// accessors (a getter and a setter) that implemented in the form of delegates that are passed into the `ggkStart()` method. 
// 
// While the server is running, if data is updated via a write operation from the client the setter delegate will be called. If your 
// application also generates or updates data periodically, it can push those updates to the server via call to 
// `ggkNofifyUpdatedCharacteristic()` or `ggkNofifyUpdatedDescriptor()`. 
// 
// >> 
// >>>  UNDERSTANDING THE UNDERLYING FRAMEWORKS 
// >> 
// 
// The server description below attempts to provide a GATT-based interface in terms of GATT services, characteristics and 
// descriptors. Consider the following sample: 
// 
//     .gattServiceBegin("text", "00000001-1E3C-FAD4-74E2-97A033F1BFAA") 
//         .gattCharacteristicBegin("string", "00000002-1E3C-FAD4-74E2-97A033F1BFAA", {"read", "write", "notify"}) 
// 
//             .onReadValue(CHARACTERISTIC_METHOD_CALLBACK_LAMBDA 
//             { 
//                 // Abbreviated for simplicity 
//                 self.methodReturnValue(pInvocation, myTextString, true); 
//             }) 
// 
//             .onWriteValue(CHARACTERISTIC_METHOD_CALLBACK_LAMBDA 
//             { 
//                 // Abbreviated for simplicity 
//                 myTextString = ... 
//             }) 
// 
//             .gattDescriptorBegin("description", "2901", {"read"}) 
//                 .onReadValue(DESCRIPTOR_METHOD_CALLBACK_LAMBDA 
//                 { 
//                     self.methodReturnValue(pInvocation, "Returns a test string", true); 
//                 }) 
// 
//             .gattDescriptorEnd() 
//         .gattCharacteristicEnd() 
//     .gattServiceEnd() 
// 
// The first thing you may notice abpout the sample is that all of the lines begin with a dot. This is because we're chaining 
// methods together. Each method returns the appropriate type to provide context. For example, The `gattServiceBegin` method returns 
// a reference to a `GattService` object which provides the proper context to create a characteristic within that service. 
// Similarly, the `gattCharacteristicBegin` method returns a reference to a `GattCharacteristic` object which provides the proper 
// context for responding to requests to read the characterisic value or add descriptors to the characteristic. 
// 
// For every `*Begin` method, there is a corresponding `*End` method, which returns us to the previous context. Indentation helps us 
// keep track of where we are. 
// 
// Also note the use of the lambda macros, `CHARACTERISTIC_METHOD_CALLBACK_LAMBDA` and `DESCRIPTOR_METHOD_CALLBACK_LAMBDA`. These 
// macros simplify the process of including our implementation directly in the description. 
// 
// The first parameter to each of the `*Begin` methods is a path node name. As we build our hierarchy, we give each node a name, 
// which gets appended to it's parent's node (which in turns gets appended to its parent's node, etc.) If our root path was 
// "/com/gobbledegook", then our service would have the path "/com/gobbledegook/text" and the characteristic would have the path 
// "/com/gobbledegook/text/string", and the descriptor would have the path "/com/gobbledegook/text/string/description". These paths 
// are important as they act like an addressing mechanism similar to paths on a filesystem or in a URL. 
// 
// The second parameter to each of the `*Begin` methods is a UUID as defined by the Bluetooth standard. These UUIDs effectively 
// refer to an interface. You will see two different kinds of UUIDs: a short UUID ("2901") and a long UUID 
// ("00000002-1E3C-FAD4-74E2-97A033F1BFAA"). 
// 
// For more information on UUDSs, see GattUuid.cpp. 
// 
// In the example above, our non-standard UUIDs ("00000001-1E3C-FAD4-74E2-97A033F1BFAA") are something we generate ourselves. In the 
// case above, we have created a custom service that simply stores a mutable text string. When the client enumerates our services 
// they'll see this UUID and, assuming we've documented our interface behind this UUID for client authors, they can use our service 
// to read and write a text string maintained on our server. 
// 
// The third parameter (which only applies to dharacteristics and descriptors) are a set of flags. You will find the current set of 
// flags for characteristics and descriptors in the "BlueZ D-Bus GATT API description" at: 
// 
//     https://git.kernel.org/pub/scm/bluetooth/bluez.git/plain/doc/gatt-api.txt 
// 
// In addition to these structural methods, there are a small handful of helper methods for performing common operations. These 
// helper methods are available within a method (such as `onReadValue`) through the use of a `self` reference. The `self` reference 
// refers to the object at which the method is invoked (either a `GattCharacteristic` object or a `GattDescriptor` object.) 
// 
//     methodReturnValue and methodReturnVariant 
//         These methods provide a means for returning values from Characteristics and Descriptors. The `-Value` form accept a set 
//         of common types (int, string, etc.) If you need to provide a custom return type, you can do so by building your own 
//         GVariant (which is a GLib construct) and using the `-Variant` form of the method. 
// 
//     sendChangeNotificationValue and sendChangeNotificationVariant 
//         These methods provide a means for notifying changes for Characteristics. The `-Value` form accept a set of common types 
//         (int, string, etc.) If you need to notify a custom return type, you can do so by building your own GVariant (which is a 
//         GLib construct) and using the `-Variant` form of the method. 
// 
// For information about GVariants (what they are and how to work with them), see the GLib documentation at: 
// 
//     https://www.freedesktop.org/software/gstreamer-sdk/data/docs/latest/glib/glib-GVariantType.html 
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
 
#include <algorithm>
 
#include "Server.h"
#include "ServerUtils.h"
#include "Utils.h"
#include "Globals.h"
#include "DBusObject.h"
#include "DBusInterface.h"
#include "GattProperty.h"
#include "GattService.h"
#include "GattUuid.h"
#include "GattCharacteristic.h"
#include "GattDescriptor.h"
#include "Logger.h"
 
namespace ggk {
 
// There's a good chance there will be a bunch of unused parameters from the lambda macros 
#if defined(__GNUC__) && defined(__clang__)
	#pragma clang diagnostic push
	#pragma clang diagnostic ignored "-Wunused-parameter"
#endif
#if defined(__GNUC__) && !defined(__clang__)
	#pragma GCC diagnostic push
	#pragma GCC diagnostic ignored "-Wunused-parameter"
#endif
 
// --------------------------------------------------------------------------------------------------------------------------------- 
// Globals 
// --------------------------------------------------------------------------------------------------------------------------------- 
 
// Our one and only server. It's global. 
std::shared_ptr<Server> TheServer = nullptr;
 
// --------------------------------------------------------------------------------------------------------------------------------- 
// Object implementation 
// --------------------------------------------------------------------------------------------------------------------------------- 
 
// Our constructor builds our entire server description 
// 
// serviceName: The name of our server (collectino of services) 
// 
//     This is used to build the path for our Bluetooth services. It also provides the base for the D-Bus owned name (see 
//     getOwnedName.) 
// 
//     This value will be stored as lower-case only. 
// 
//     Retrieve this value using the `getName()` method. 
// 
// advertisingName: The name for this controller, as advertised over LE 
// 
//     IMPORTANT: Setting the advertisingName will change the system-wide name of the device. If that's not what you want, set 
//     BOTH advertisingName and advertisingShortName to as empty string ("") to prevent setting the advertising 
//     name. 
// 
//     Retrieve this value using the `getAdvertisingName()` method. 
// 
// advertisingShortName: The short name for this controller, as advertised over LE 
// 
//     According to the spec, the short name is used in case the full name doesn't fit within Extended Inquiry Response (EIR) or 
//     Advertising Data (AD). 
// 
//     IMPORTANT: Setting the advertisingName will change the system-wide name of the device. If that's not what you want, set 
//     BOTH advertisingName and advertisingShortName to as empty string ("") to prevent setting the advertising 
//     name. 
// 
//     Retrieve this value using the `getAdvertisingShortName()` method. 
// 
Server::Server(const std::string &serviceName, const std::string &advertisingName, const std::string &advertisingShortName, 
	GGKServerDataGetter getter, GGKServerDataSetter setter)
{
	// Save our names 
	this->serviceName = serviceName;
	std::transform(this->serviceName.begin(), this->serviceName.end(), this->serviceName.begin(), ::tolower);
	this->advertisingName = advertisingName;
	this->advertisingShortName = advertisingShortName;
 
	// Register getter & setter for server data 
	dataGetter = getter;
	dataSetter = setter;
 
	// Adapter configuration flags - set these flags based on how you want the adapter configured 
	enableBREDR = false;
	enableSecureConnection = false;
	enableConnectable = true;
	enableAdvertising = true;
	enableBondable = false;
 
	// 
	// Define the server 
	// 
 
	// Create the root D-Bus object and push it into the list 
	objects.push_back(DBusObject(DBusObjectPath() + "com" + getServiceName()));
 
	// We're going to build off of this object, so we need to get a reference to the instance of the object as it resides in the 
	// list (and not the object that would be added to the list.) 
	objects.back()
 
	// Service: Device Information (0x180A) 
	// 
	// See: https://www.bluetooth.com/specifications/gatt/viewer?attributeXmlFile=org.bluetooth.service.device_information.xml 
	.gattServiceBegin("device", "180A")
 
		// Characteristic: Manufacturer Name String (0x2A29) 
		// 
		// See: https://www.bluetooth.com/specifications/gatt/viewer?attributeXmlFile=org.bluetooth.characteristic.manufacturer_name_string.xml 
		.gattCharacteristicBegin("mfgr_name", "2A29", {"read"})
 
			// Standard characteristic "ReadValue" method call 
			.onReadValue(CHARACTERISTIC_METHOD_CALLBACK_LAMBDA
			{
				self.methodReturnValue(pInvocation, "thenautilus", true);
			})
 
		.gattCharacteristicEnd()
 
		// Characteristic: Model Number String (0x2A24) 
		// 
		// See: https://www.bluetooth.com/specifications/gatt/viewer?attributeXmlFile=org.bluetooth.characteristic.model_number_string.xml 
		.gattCharacteristicBegin("model_num", "2A24", {"read"})
 
			// Standard characteristic "ReadValue" method call 
			.onReadValue(CHARACTERISTIC_METHOD_CALLBACK_LAMBDA
			{
				self.methodReturnValue(pInvocation, "thermo-store", true);
			})
 
		.gattCharacteristicEnd()
 
	.gattServiceEnd()
 
	// Thermo store service 
	.gattServiceBegin("thermo", "11111111-2222-3333-4444-000000000000")
 
		// Characteristic: String value 
          .gattCharacteristicBegin("temperature", "11111111-2222-3333-4444-000000000001", {"read","write"})
 
			// Standard characteristic "ReadValue" method call 
			.onReadValue(CHARACTERISTIC_METHOD_CALLBACK_LAMBDA
			{
                          const char *fake_temp = "0";
                          self.methodReturnValue(pInvocation, fake_temp, true);
			})
 
			// Standard characteristic "WriteValue" method call 
			.onWriteValue(CHARACTERISTIC_METHOD_CALLBACK_LAMBDA
			{
                          GVariant *pValue = g_variant_get_child_value(pParameters, 0);
                          self.setDataPointer("temperature", Utils::stringFromGVariantByteArray(pValue).c_str());
			})
 
			// GATT Descriptor: Characteristic User Description (0x2901) 
			//  
			// See: https://www.bluetooth.com/specifications/gatt/viewer?attributeXmlFile=org.bluetooth.descriptor.gatt.characteristic_user_description.xml 
			.gattDescriptorBegin("description", "2901", {"read"})
 
				// Standard descriptor "ReadValue" method call 
				.onReadValue(DESCRIPTOR_METHOD_CALLBACK_LAMBDA
				{
					const char *pDescription = "temperature in a room";
					self.methodReturnValue(pInvocation, pDescription, true);
				})
 
			.gattDescriptorEnd()
 
		.gattCharacteristicEnd()
          
		// Characteristic: String value 
		.gattCharacteristicBegin("time_to_next_reading", "11111111-2222-3333-4444-000000000002", {"read"})
 
			// Standard characteristic "ReadValue" method call 
			.onReadValue(CHARACTERISTIC_METHOD_CALLBACK_LAMBDA
			{
				const char *time = self.getDataPointer<const char*>("time-to-next-sample", "");
				self.methodReturnValue(pInvocation, time, true);
			})
 
			// GATT Descriptor: Characteristic User Description (0x2901) 
			//  
			// See: https://www.bluetooth.com/specifications/gatt/viewer?attributeXmlFile=org.bluetooth.descriptor.gatt.characteristic_user_description.xml 
			.gattDescriptorBegin("description", "2901", {"read"})
 
				// Standard descriptor "ReadValue" method call 
				.onReadValue(DESCRIPTOR_METHOD_CALLBACK_LAMBDA
				{
					const char *pDescription = "time (in seconds) to wait before sending the next temperature reading";
					self.methodReturnValue(pInvocation, pDescription, true);
				})
 
			.gattDescriptorEnd()
 
		.gattCharacteristicEnd()
          
          .gattServiceEnd()
          ; // << -- NOTE THE SEMICOLON 
 
	//  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  - 
	//                                                ____ _____ ___  _____ 
	//                                               / ___|_   _/ _ \|  _  | 
	//                                               \___ \ | || | | | |_) | 
	//                                                ___) || || |_| |  __/ 
	//                                               |____/ |_| \___/|_| 
	// 
	// You probably shouldn't mess with stuff beyond this point. It is required to meet BlueZ's requirements for a GATT Service. 
	// 
	// >> 
	// >>  WHAT IT IS 
	// >> 
	// 
	// From the BlueZ D-Bus GATT API description (https://git.kernel.org/pub/scm/bluetooth/bluez.git/plain/doc/gatt-api.txt): 
	// 
	//     "To make service registration simple, BlueZ requires that all objects that belong to a GATT service be grouped under a 
	//     D-Bus Object Manager that solely manages the objects of that service. Hence, the standard DBus.ObjectManager interface 
	//     must be available on the root service path." 
	// 
	// The code below does exactly that. Notice that we're doing much of the same work that our Server description does except that 
	// instead of defining our own interfaces, we're following a pre-defined standard. 
	// 
	// The object types and method names used in the code below may look unfamiliar compared to what you're used to seeing in the 
	// Server desecription. That's because the server description uses higher level types that define a more GATT-oriented framework 
	// to build your GATT services. That higher level functionality was built using a set of lower-level D-Bus-oriented framework, 
	// which is used in the code below. 
	//  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  - 
 
	// Create the root object and push it into the list. We're going to build off of this object, so we need to get a reference 
	// to the instance of the object as it resides in the list (and not the object that would be added to the list.) 
	// 
	// This is a non-published object (as specified by the 'false' parameter in the DBusObject constructor.) This way, we can 
	// include this within our server hieararchy (i.e., within the `objects` list) but it won't be exposed by BlueZ as a Bluetooth 
	// service to clietns. 
	objects.push_back(DBusObject(DBusObjectPath(), false));
 
	// Get a reference to the new object as it resides in the list 
	DBusObject &objectManager = objects.back();
 
	// Create an interface of the standard type 'org.freedesktop.DBus.ObjectManager' 
	// 
	// See: https://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-objectmanager 
	auto omInterface = std::make_shared<DBusInterface>(objectManager, "org.freedesktop.DBus.ObjectManager");
 
	// Add the interface to the object manager 
	objectManager.addInterface(omInterface);
 
	// Finally, we setup the interface. We do this by adding the `GetManagedObjects` method as specified by D-Bus for the 
	// 'org.freedesktop.DBus.ObjectManager' interface. 
	const char *pInArgs[] = { nullptr };
	const char *pOutArgs = "a{oa{sa{sv}}}";
	omInterface->addMethod("GetManagedObjects", pInArgs, pOutArgs, INTERFACE_METHOD_CALLBACK_LAMBDA
	{
		ServerUtils::getManagedObjects(pInvocation);
	});
}
 
// --------------------------------------------------------------------------------------------------------------------------------- 
// Utilitarian 
// --------------------------------------------------------------------------------------------------------------------------------- 
 
// Find a D-Bus interface within the given D-Bus object 
// 
// If the interface was found, it is returned, otherwise nullptr is returned 
std::shared_ptr<const DBusInterface> Server::findInterface(const DBusObjectPath &objectPath, const std::string &interfaceName) const
{
	for (const DBusObject &object : objects)
	{
		std::shared_ptr<const DBusInterface> pInterface = object.findInterface(objectPath, interfaceName);
		if (pInterface != nullptr)
		{
			return pInterface;
		}
	}
 
	return nullptr;
}
 
// Find and call a D-Bus method within the given D-Bus object on the given D-Bus interface 
// 
// If the method was called, this method returns true, otherwise false. There is no result from the method call itself. 
bool Server::callMethod(const DBusObjectPath &objectPath, const std::string &interfaceName, const std::string &methodName, GDBusConnection *pConnection, GVariant *pParameters, GDBusMethodInvocation *pInvocation, gpointer pUserData) const
{
	for (const DBusObject &object : objects)
	{
		if (object.callMethod(objectPath, interfaceName, methodName, pConnection, pParameters, pInvocation, pUserData))
		{
			return true;
		}
	}
 
	return false;
}
 
// Find a GATT Property within the given D-Bus object on the given D-Bus interface 
// 
// If the property was found, it is returned, otherwise nullptr is returned 
const GattProperty *Server::findProperty(const DBusObjectPath &objectPath, const std::string &interfaceName, const std::string &propertyName) const
{
	std::shared_ptr<const DBusInterface> pInterface = findInterface(objectPath, interfaceName);
 
	// Try each of the GattInterface types that support properties? 
	if (std::shared_ptr<const GattInterface> pGattInterface = TRY_GET_CONST_INTERFACE_OF_TYPE(pInterface, GattInterface))
	{
		return pGattInterface->findProperty(propertyName);
	}
	else if (std::shared_ptr<const GattService> pGattInterface = TRY_GET_CONST_INTERFACE_OF_TYPE(pInterface, GattService))
	{
		return pGattInterface->findProperty(propertyName);
	}
	else if (std::shared_ptr<const GattCharacteristic> pGattInterface = TRY_GET_CONST_INTERFACE_OF_TYPE(pInterface, GattCharacteristic))
	{
		return pGattInterface->findProperty(propertyName);
	}
 
	return nullptr;
}
 
}; // namespace ggk