OpenTTD Source: src/network/network_content.h Source File

OpenTTD Source 1.11.0-RC1

network_content.h
Go to the documentation of this file.
1 /*
2 * This file is part of OpenTTD.
3 * OpenTTD 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, version 2.
4 * OpenTTD 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.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
7
10 #ifndef NETWORK_CONTENT_H
11 #define NETWORK_CONTENT_H
12
13 #include "core/tcp_content.h"
14 #include "core/tcp_http.h"
15
17 typedef std::vector<ContentInfo *> ContentVector;
19 typedef std::vector<const ContentInfo *> ConstContentVector;
20
22 typedef ContentInfo **ContentIterator;
24 typedef const ContentInfo * const * ConstContentIterator;
25
27 struct ContentCallback {
32 virtual void OnConnect(bool success) {}
33
37 virtual void OnDisconnect() {}
38
43 virtual void OnReceiveContentInfo(const ContentInfo *ci) {}
44
50 virtual void OnDownloadProgress(const ContentInfo *ci, int bytes) {}
51
56 virtual void OnDownloadComplete(ContentID cid) {}
57
59 virtual ~ContentCallback() {}
60 };
61
65 class ClientNetworkContentSocketHandler : public NetworkContentSocketHandler, ContentCallback, HTTPCallback {
66 protected:
67 typedef std::vector<ContentID> ContentIDList;
68 std::vector<ContentCallback *> callbacks;
69 ContentIDList requested;
70 ContentVector infos;
71 std::vector<char> http_response;
72 int http_response_index;
73
74 FILE *curFile;
75 ContentInfo *curInfo;
76 bool isConnecting;
77 std::chrono::steady_clock::time_point lastActivity;
78
79 friend class NetworkContentConnecter;
80
81 bool Receive_SERVER_INFO(Packet *p) override;
82 bool Receive_SERVER_CONTENT(Packet *p) override;
83
84 ContentInfo *GetContent(ContentID cid);
85 void DownloadContentInfo(ContentID cid);
86
87 void OnConnect(bool success) override;
88 void OnDisconnect() override;
89 void OnReceiveContentInfo(const ContentInfo *ci) override;
90 void OnDownloadProgress(const ContentInfo *ci, int bytes) override;
91 void OnDownloadComplete(ContentID cid) override;
92
93 void OnFailure() override;
94 void OnReceiveData(const char *data, size_t length) override;
95
96 bool BeforeDownload();
97 void AfterDownload();
98
99 void DownloadSelectedContentHTTP(const ContentIDList &content);
100 void DownloadSelectedContentFallback(const ContentIDList &content);
101 public:
103 static constexpr std::chrono::seconds IDLE_TIMEOUT = std::chrono::seconds(60);
104
105 ClientNetworkContentSocketHandler();
106 ~ClientNetworkContentSocketHandler();
107
108 void Connect();
109 void SendReceive();
110 void Close() override;
111
112 void RequestContentList(ContentType type);
113 void RequestContentList(uint count, const ContentID *content_ids);
114 void RequestContentList(ContentVector *cv, bool send_md5sum = true);
115
116 void DownloadSelectedContent(uint &files, uint &bytes, bool fallback = false);
117
118 void Select(ContentID cid);
119 void Unselect(ContentID cid);
120 void SelectAll();
121 void SelectUpgrade();
122 void UnselectAll();
123 void ToggleSelectedState(const ContentInfo *ci);
124
125 void ReverseLookupDependency(ConstContentVector &parents, const ContentInfo *child) const;
126 void ReverseLookupTreeDependency(ConstContentVector &tree, const ContentInfo *child) const;
127 void CheckDependencyState(ContentInfo *ci);
128
130 uint Length() const { return (uint)this->infos.size(); }
132 ConstContentIterator Begin() const { return this->infos.data(); }
134 ConstContentIterator Get(uint32 index) const { return this->infos.data() + index; }
136 ConstContentIterator End() const { return this->Begin() + this->Length(); }
137
138 void Clear();
139
141 void AddCallback(ContentCallback *cb) { include(this->callbacks, cb); }
143 void RemoveCallback(ContentCallback *cb) { this->callbacks.erase(std::find(this->callbacks.begin(), this->callbacks.end(), cb)); }
144 };
145
146 extern ClientNetworkContentSocketHandler _network_content_client;
147
148 void ShowNetworkContentListWindow(ContentVector *cv = nullptr, ContentType type1 = CONTENT_TYPE_END, ContentType type2 = CONTENT_TYPE_END);
149
150 void ShowMissingContentWindow(const struct GRFConfig *list);
151
152 #endif /* NETWORK_CONTENT_H */
ContentCallback
Callbacks for notifying others about incoming data.
Definition: network_content.h:27
ClientNetworkContentSocketHandler::OnConnect
void OnConnect(bool success) override
Callback for when the connection has finished.
Definition: network_content.cpp:1043
NetworkContentSocketHandler
Base socket handler for all Content TCP sockets.
Definition: tcp_content.h:96
ClientNetworkContentSocketHandler::ReverseLookupDependency
void ReverseLookupDependency(ConstContentVector &parents, const ContentInfo *child) const
Reverse lookup the dependencies of (direct) parents over a given child.
Definition: network_content.cpp:904
ClientNetworkContentSocketHandler::End
ConstContentIterator End() const
Get the end of the content inf iterator.
Definition: network_content.h:136
ClientNetworkContentSocketHandler::SendReceive
void SendReceive()
Check whether we received/can send some data from/to the content server and when that's the case hand...
Definition: network_content.cpp:779
HTTPCallback
Callback for when the HTTP handler has something to tell us.
Definition: tcp_http.h:18
tcp_http.h
ContentType
ContentType
The values in the enum are important; they are used as database 'keys'.
Definition: tcp_content.h:21
ClientNetworkContentSocketHandler::Length
uint Length() const
Get the number of content items we know locally.
Definition: network_content.h:130
ClientNetworkContentSocketHandler::lastActivity
std::chrono::steady_clock::time_point lastActivity
The last time there was network activity.
Definition: network_content.h:77
ClientNetworkContentSocketHandler::http_response_index
int http_response_index
Where we are, in the response, with handling it.
Definition: network_content.h:72
_network_content_client
ClientNetworkContentSocketHandler _network_content_client
The client we use to connect to the server.
Definition: network_content.cpp:35
ShowNetworkContentListWindow
void ShowNetworkContentListWindow(ContentVector *cv=nullptr, ContentType type1=CONTENT_TYPE_END, ContentType type2=CONTENT_TYPE_END)
Show the content list window with a given set of content.
Definition: network_content_gui.cpp:1138
ContentCallback::OnConnect
virtual void OnConnect(bool success)
Callback for when the connection has finished.
Definition: network_content.h:32
ContentVector
std::vector< ContentInfo * > ContentVector
Vector with content info.
Definition: network_content.h:17
ShowMissingContentWindow
void ShowMissingContentWindow(const GRFConfig *list)
Show the content list window with all missing grfs from the given list.
Definition: newgrf_gui.cpp:1543
include
bool include(std::vector< T > &vec, const T &item)
Helper function to append an item to a vector if it is not already contained Consider using std::set,...
Definition: smallvec_type.hpp:27
ClientNetworkContentSocketHandler::CheckDependencyState
void CheckDependencyState(ContentInfo *ci)
Check the dependencies (recursively) of this content info.
Definition: network_content.cpp:945
ClientNetworkContentSocketHandler
Socket handler for the content server connection.
Definition: network_content.h:65
ContentCallback::OnDownloadComplete
virtual void OnDownloadComplete(ContentID cid)
We have finished downloading a file.
Definition: network_content.h:56
ClientNetworkContentSocketHandler::Clear
void Clear()
Clear all downloaded content information.
Definition: network_content.cpp:1033
ClientNetworkContentSocketHandler::isConnecting
bool isConnecting
Whether we're connecting.
Definition: network_content.h:76
ConstContentIterator
const typedef ContentInfo *const * ConstContentIterator
Iterator for the constant content vector.
Definition: network_content.h:24
ClientNetworkContentSocketHandler::curInfo
ContentInfo * curInfo
Information about the currently downloaded file.
Definition: network_content.h:75
ClientNetworkContentSocketHandler::DownloadSelectedContentHTTP
void DownloadSelectedContentHTTP(const ContentIDList &content)
Initiate downloading the content over HTTP.
Definition: network_content.cpp:327
ClientNetworkContentSocketHandler::RequestContentList
void RequestContentList(ContentType type)
Request the content list for the given type.
Definition: network_content.cpp:185
ContentCallback::OnReceiveContentInfo
virtual void OnReceiveContentInfo(const ContentInfo *ci)
We received a content info.
Definition: network_content.h:43
tcp_content.h
ClientNetworkContentSocketHandler::OnDisconnect
void OnDisconnect() override
Callback for when the connection got disconnected.
Definition: network_content.cpp:1053
GRFConfig
Information about GRF, used in the game and (part of it) in savegames.
Definition: newgrf_config.h:152
ClientNetworkContentSocketHandler::infos
ContentVector infos
All content info we received.
Definition: network_content.h:70
ClientNetworkContentSocketHandler::DownloadContentInfo
void DownloadContentInfo(ContentID cid)
Download information of a given Content ID if not already tried.
Definition: network_content.cpp:802
ClientNetworkContentSocketHandler::~ClientNetworkContentSocketHandler
~ClientNetworkContentSocketHandler()
Clear up the mess ;)
Definition: network_content.cpp:720
ClientNetworkContentSocketHandler::UnselectAll
void UnselectAll()
Unselect everything that we've not downloaded so far.
Definition: network_content.cpp:874
ContentInfo
Container for all important information about a piece of content.
Definition: tcp_content.h:54
ClientNetworkContentSocketHandler::OnReceiveData
void OnReceiveData(const char *data, size_t length) override
We're receiving data.
Definition: network_content.cpp:581
ClientNetworkContentSocketHandler::Unselect
void Unselect(ContentID cid)
Unselect a specific content id.
Definition: network_content.cpp:842
ContentIterator
ContentInfo ** ContentIterator
Iterator for the content vector.
Definition: network_content.h:22
ClientNetworkContentSocketHandler::OnFailure
void OnFailure() override
An error has occurred and the connection has been closed.
Definition: network_content.cpp:561
ClientNetworkContentSocketHandler::Close
void Close() override
Disconnect from the content server.
Definition: network_content.cpp:767
ClientNetworkContentSocketHandler::IDLE_TIMEOUT
static constexpr std::chrono::seconds IDLE_TIMEOUT
The idle timeout; when to close the connection because it's idle.
Definition: network_content.h:103
ClientNetworkContentSocketHandler::curFile
FILE * curFile
Currently downloaded file.
Definition: network_content.h:74
ClientNetworkContentSocketHandler::OnDownloadComplete
void OnDownloadComplete(ContentID cid) override
We have finished downloading a file.
Definition: network_content.cpp:1081
ClientNetworkContentSocketHandler::OnDownloadProgress
void OnDownloadProgress(const ContentInfo *ci, int bytes) override
We have progress in the download of a file.
Definition: network_content.cpp:1072
ClientNetworkContentSocketHandler::RemoveCallback
void RemoveCallback(ContentCallback *cb)
Remove a callback.
Definition: network_content.h:143
Packet
Internal entity of a packet.
Definition: packet.h:40
ClientNetworkContentSocketHandler::DownloadSelectedContent
void DownloadSelectedContent(uint &files, uint &bytes, bool fallback=false)
Actually begin downloading the content we selected.
Definition: network_content.cpp:292
ClientNetworkContentSocketHandler::http_response
std::vector< char > http_response
The HTTP response to the requests we've been doing.
Definition: network_content.h:71
ClientNetworkContentSocketHandler::ContentIDList
std::vector< ContentID > ContentIDList
List of content IDs to (possibly) select.
Definition: network_content.h:67
ClientNetworkContentSocketHandler::ReverseLookupTreeDependency
void ReverseLookupTreeDependency(ConstContentVector &tree, const ContentInfo *child) const
Reverse lookup the dependencies of all parents over a given child.
Definition: network_content.cpp:923
ClientNetworkContentSocketHandler::Connect
void Connect()
Connect with the content server.
Definition: network_content.cpp:757
ClientNetworkContentSocketHandler::ToggleSelectedState
void ToggleSelectedState(const ContentInfo *ci)
Toggle the state of a content info and check its dependencies.
Definition: network_content.cpp:882
ClientNetworkContentSocketHandler::callbacks
std::vector< ContentCallback * > callbacks
Callbacks to notify "the world".
Definition: network_content.h:68
ClientNetworkContentSocketHandler::Select
void Select(ContentID cid)
Select a specific content id.
Definition: network_content.cpp:829
ClientNetworkContentSocketHandler::requested
ContentIDList requested
ContentIDs we already requested (so we don't do it again)
Definition: network_content.h:69
NetworkContentConnecter
Connect to the content server.
Definition: network_content.cpp:729
ClientNetworkContentSocketHandler::DownloadSelectedContentFallback
void DownloadSelectedContentFallback(const ContentIDList &content)
Initiate downloading the content over the fallback protocol.
Definition: network_content.cpp:355
ClientNetworkContentSocketHandler::AddCallback
void AddCallback(ContentCallback *cb)
Add a callback to this class.
Definition: network_content.h:141
ClientNetworkContentSocketHandler::OnReceiveContentInfo
void OnReceiveContentInfo(const ContentInfo *ci) override
We received a content info.
Definition: network_content.cpp:1062
ClientNetworkContentSocketHandler::SelectAll
void SelectAll()
Select everything we can select.
Definition: network_content.cpp:852
ContentID
ContentID
Unique identifier for the content.
Definition: tcp_content.h:49
ClientNetworkContentSocketHandler::Get
ConstContentIterator Get(uint32 index) const
Get the nth position of the content inf iterator.
Definition: network_content.h:134
ClientNetworkContentSocketHandler::BeforeDownload
bool BeforeDownload()
Handle the opening of the file before downloading.
Definition: network_content.cpp:502
ClientNetworkContentSocketHandler::Receive_SERVER_INFO
bool Receive_SERVER_INFO(Packet *p) override
Server sending list of content info: byte type (invalid ID == does not exist) uint32 id uint32 file_s...
Definition: network_content.cpp:52
ClientNetworkContentSocketHandler::SelectUpgrade
void SelectUpgrade()
Select everything that's an update for something we've got.
Definition: network_content.cpp:863
ClientNetworkContentSocketHandler::AfterDownload
void AfterDownload()
Handle the closing and extracting of a file after downloading it has been done.
Definition: network_content.cpp:527
ClientNetworkContentSocketHandler::ClientNetworkContentSocketHandler
ClientNetworkContentSocketHandler()
Create a socket handler to handle the connection.
Definition: network_content.cpp:709
ContentCallback::OnDisconnect
virtual void OnDisconnect()
Callback for when the connection got disconnected.
Definition: network_content.h:37
ClientNetworkContentSocketHandler::GetContent
ContentInfo * GetContent(ContentID cid)
Get the content info based on a ContentID.
Definition: network_content.cpp:816
ContentCallback::~ContentCallback
virtual ~ContentCallback()
Silentium.
Definition: network_content.h:59
ConstContentVector
std::vector< const ContentInfo * > ConstContentVector
Vector with constant content info.
Definition: network_content.h:19
ClientNetworkContentSocketHandler::Receive_SERVER_CONTENT
bool Receive_SERVER_CONTENT(Packet *p) override
Server sending list of content info: uint32 unique id uint32 file size (0 == does not exist) string f...
Definition: network_content.cpp:462
CONTENT_TYPE_END
@ CONTENT_TYPE_END
Helper to mark the end of the types.
Definition: tcp_content.h:33
ClientNetworkContentSocketHandler::Begin
ConstContentIterator Begin() const
Get the begin of the content inf iterator.
Definition: network_content.h:132
ContentCallback::OnDownloadProgress
virtual void OnDownloadProgress(const ContentInfo *ci, int bytes)
We have progress in the download of a file.
Definition: network_content.h:50