summaryrefslogtreecommitdiff
path: root/src/lib/upnp/Discovery.hxx
blob: 8af1c1ae652071930ad6373d32d91600e64d90a4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
/*
 * Copyright 2003-2018 The Music Player Daemon Project
 * http://www.musicpd.org
 *
 * This program 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 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef _UPNPPDISC_H_X_INCLUDED_
#define _UPNPPDISC_H_X_INCLUDED_

#include "Compat.hxx"
#include "Callback.hxx"
#include "Device.hxx"
#include "lib/curl/Init.hxx"
#include "lib/curl/Handler.hxx"
#include "lib/curl/Request.hxx"
#include "thread/Mutex.hxx"
#include "event/DeferEvent.hxx"
#include "util/Compiler.h"

#include <upnp.h>

#include <boost/intrusive/list.hpp>

#include <list>
#include <vector>
#include <string>
#include <memory>
#include <chrono>

#if UPNP_VERSION < 10800
#define UpnpDiscovery Upnp_Discovery
#endif

class ContentDirectoryService;

class UPnPDiscoveryListener {
public:
	virtual void FoundUPnP(const ContentDirectoryService &service) = 0;
	virtual void LostUPnP(const ContentDirectoryService &service) = 0;
};

/**
 * Manage UPnP discovery and maintain a directory of active devices. Singleton.
 *
 * We are only interested in MediaServers with a ContentDirectory service
 * for now, but this could be made more general, by removing the filtering.
 */
class UPnPDeviceDirectory final : UpnpCallback {
	/**
	 * Descriptor for one device having a Content Directory
	 * service found on the network.
	 */
	class ContentDirectoryDescriptor {
	public:
		std::string id;

		UPnPDevice device;

		/**
		 * The time stamp when this device expires.
		 */
		std::chrono::steady_clock::time_point expires;

		ContentDirectoryDescriptor() = default;

		ContentDirectoryDescriptor(std::string &&_id,
					   std::chrono::steady_clock::time_point last,
					   std::chrono::steady_clock::duration exp) noexcept
			:id(std::move(_id)),
			 expires(last + exp + std::chrono::seconds(20)) {}

		void Parse(const std::string &url, const char *description) {
			device.Parse(url, description);
		}
	};

	class Downloader final
		: public boost::intrusive::list_base_hook<boost::intrusive::link_mode<boost::intrusive::normal_link>>,
		CurlResponseHandler {

		DeferEvent defer_start_event;

		UPnPDeviceDirectory &parent;

		std::string id;
		const std::string url;
		const std::chrono::steady_clock::duration expires;

		CurlRequest request;

		std::string data;

	public:
		Downloader(UPnPDeviceDirectory &_parent,
			   const UpnpDiscovery &disco);

		void Start() noexcept {
			defer_start_event.Schedule();
		}

		void Destroy() noexcept;

	private:
		void OnDeferredStart() noexcept {
			try {
				request.Start();
			} catch (...) {
				OnError(std::current_exception());
			}
		}

		/* virtual methods from CurlResponseHandler */
		void OnHeaders(unsigned status,
			       std::multimap<std::string, std::string> &&headers) override;
		void OnData(ConstBuffer<void> data) override;
		void OnEnd() override;
		void OnError(std::exception_ptr e) noexcept override;
	};

	CurlInit curl;

	const UpnpClient_Handle handle;
	UPnPDiscoveryListener *const listener;

	Mutex mutex;

	/**
	 * Protected by #mutex.
	 */
	boost::intrusive::list<Downloader,
			       boost::intrusive::constant_time_size<false>> downloaders;

	/**
	 * Protected by #mutex.
	 */
	std::list<ContentDirectoryDescriptor> directories;

	/**
	 * The UPnP device search timeout, which should actually be
	 * called delay because it's the base of a random delay that
	 * the devices apply to avoid responding all at the same time.
	 */
	int search_timeout = 2;

	/**
	 * The time stamp of the last search.
	 */
	std::chrono::steady_clock::time_point last_search = std::chrono::steady_clock::time_point();

public:
	UPnPDeviceDirectory(EventLoop &event_loop, UpnpClient_Handle _handle,
			    UPnPDiscoveryListener *_listener=nullptr);
	~UPnPDeviceDirectory() noexcept;

	UPnPDeviceDirectory(const UPnPDeviceDirectory &) = delete;
	UPnPDeviceDirectory& operator=(const UPnPDeviceDirectory &) = delete;

	EventLoop &GetEventLoop() noexcept;

	void Start();

	/** Retrieve the directory services currently seen on the network */
	std::vector<ContentDirectoryService> GetDirectories();

	/**
	 * Get server by friendly name.
	 */
	ContentDirectoryService GetServer(const char *friendly_name);

private:
	void Search();

	/**
	 * Look at the devices and get rid of those which have not
	 * been seen for too long. We do this when listing the top
	 * directory.
	 *
	 * Caller must lock #mutex.
	 */
	void ExpireDevices();

	void LockAdd(ContentDirectoryDescriptor &&d);
	void LockRemove(const std::string &id);

	int OnAlive(const UpnpDiscovery *disco) noexcept;
	int OnByeBye(const UpnpDiscovery *disco) noexcept;

	/* virtual methods from class UpnpCallback */
	int Invoke(Upnp_EventType et, const void *evp) noexcept override;
};


#endif /* _UPNPPDISC_H_X_INCLUDED_ */