OpenTTD

tcp_content.h
Go to the documentation of this file.
1 /* $Id: tcp_content.h 25597 2013-07-13 09:26:11Z rubidium $ */
2
3 /*
4 * This file is part of OpenTTD.
5 * 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.
6 * 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.
7 * 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/>.
8 */
9
14 #ifndef NETWORK_CORE_TCP_CONTENT_H
15 #define NETWORK_CORE_TCP_CONTENT_H
16
17 #include "os_abstraction.h"
18 #include "tcp.h"
19 #include "packet.h"
20 #include "../../debug.h"
21
22 #ifdef ENABLE_NETWORK
23
25 enum ContentType {
26 CONTENT_TYPE_BEGIN = 1,
27 CONTENT_TYPE_BASE_GRAPHICS = 1,
28 CONTENT_TYPE_NEWGRF = 2,
29 CONTENT_TYPE_AI = 3,
30 CONTENT_TYPE_AI_LIBRARY = 4,
31 CONTENT_TYPE_SCENARIO = 5,
32 CONTENT_TYPE_HEIGHTMAP = 6,
33 CONTENT_TYPE_BASE_SOUNDS = 7,
34 CONTENT_TYPE_BASE_MUSIC = 8,
35 CONTENT_TYPE_GAME = 9,
36 CONTENT_TYPE_GAME_LIBRARY = 10,
37 CONTENT_TYPE_END,
38 };
39
41 enum PacketContentType {
42 PACKET_CONTENT_CLIENT_INFO_LIST,
43 PACKET_CONTENT_CLIENT_INFO_ID,
44 PACKET_CONTENT_CLIENT_INFO_EXTID,
45 PACKET_CONTENT_CLIENT_INFO_EXTID_MD5,
46 PACKET_CONTENT_SERVER_INFO,
47 PACKET_CONTENT_CLIENT_CONTENT,
48 PACKET_CONTENT_SERVER_CONTENT,
49 PACKET_CONTENT_END,
50 };
51
53 enum ContentID {
54 INVALID_CONTENT_ID = UINT32_MAX,
55 };
56
58 struct ContentInfo {
60 enum State {
61 UNSELECTED,
62 SELECTED,
63 AUTOSELECTED,
64 ALREADY_HERE,
65 DOES_NOT_EXIST,
66 INVALID,
67 };
68
69 ContentType type;
70 ContentID id;
71 uint32 filesize;
72 char filename[48];
73 char name[32];
74 char version[16];
75 char url[96];
76 char description[512];
77 uint32 unique_id;
78 byte md5sum[16];
79 uint8 dependency_count;
80 ContentID *dependencies;
81 uint8 tag_count;
82 char (*tags)[32];
83 State state;
84 bool upgrade;
85
86 ContentInfo();
87 ~ContentInfo();
88
89 void TransferFrom(ContentInfo *other);
90
91 size_t Size() const;
92 bool IsSelected() const;
93 bool IsValid() const;
94 #ifndef OPENTTD_MSU
95 const char *GetTextfile(TextfileType type) const;
96 #endif /* OPENTTD_MSU */
97 };
98
100 class NetworkContentSocketHandler : public NetworkTCPSocketHandler {
101 protected:
102 NetworkAddress client_addr;
103 virtual void Close();
104
105 bool ReceiveInvalidPacket(PacketContentType type);
106
114 virtual bool Receive_CLIENT_INFO_LIST(Packet *p);
115
123 virtual bool Receive_CLIENT_INFO_ID(Packet *p);
124
137 virtual bool Receive_CLIENT_INFO_EXTID(Packet *p);
138
152 virtual bool Receive_CLIENT_INFO_EXTID_MD5(Packet *p);
153
170 virtual bool Receive_SERVER_INFO(Packet *p);
171
179 virtual bool Receive_CLIENT_CONTENT(Packet *p);
180
191 virtual bool Receive_SERVER_CONTENT(Packet *p);
192
193 bool HandlePacket(Packet *p);
194 public:
200 NetworkContentSocketHandler(SOCKET s = INVALID_SOCKET, const NetworkAddress &address = NetworkAddress()) :
201 NetworkTCPSocketHandler(s),
202 client_addr(address)
203 {
204 }
205
207 virtual ~NetworkContentSocketHandler() { this->Close(); }
208
209 bool ReceivePackets();
210 };
211
212 #ifndef OPENTTD_MSU
213 Subdirectory GetContentInfoSubDir(ContentType type);
214 #endif /* OPENTTD_MSU */
215
216 #endif /* ENABLE_NETWORK */
217
218 #endif /* NETWORK_CORE_TCP_CONTENT_H */
CONTENT_TYPE_END
Helper to mark the end of the types.
Definition: tcp_content.h:37
CONTENT_TYPE_BASE_GRAPHICS
The content consists of base graphics.
Definition: tcp_content.h:27
ContentInfo::IsSelected
bool IsSelected() const
Is the state either selected or autoselected?
Definition: tcp_content.cpp:77
ContentInfo::filename
char filename[48]
Filename (for the .tar.gz; only valid on download)
Definition: tcp_content.h:72
ContentInfo::unique_id
uint32 unique_id
Unique ID; either GRF ID or shortname.
Definition: tcp_content.h:77
Packet
Internal entity of a packet.
Definition: packet.h:44
PACKET_CONTENT_CLIENT_INFO_EXTID
Queries the content server for information about a list of external IDs.
Definition: tcp_content.h:44
os_abstraction.h
Network stuff has many things that needs to be included and/or implemented by default.
ContentInfo::State
State
The state the content can be in.
Definition: tcp_content.h:60
Subdirectory
Subdirectory
The different kinds of subdirectories OpenTTD uses.
Definition: fileio_type.h:110
NetworkContentSocketHandler
Base socket handler for all Content TCP sockets.
Definition: tcp_content.h:100
ContentInfo::filesize
uint32 filesize
Size of the file.
Definition: tcp_content.h:71
CONTENT_TYPE_SCENARIO
The content consists of a scenario.
Definition: tcp_content.h:31
NetworkTCPSocketHandler
Base socket handler for all TCP sockets.
Definition: tcp.h:31
ContentInfo::dependency_count
uint8 dependency_count
Number of dependencies.
Definition: tcp_content.h:79
ContentInfo::tags
char(* tags)[32]
Malloced array of tags (strings)
Definition: tcp_content.h:82
NetworkAddress
Wrapper for (un)resolved network addresses; there&#39;s no reason to transform a numeric IP to a string a...
Definition: address.h:31
ContentInfo::dependencies
ContentID * dependencies
Malloced array of dependencies (unique server side ids)
Definition: tcp_content.h:80
ContentInfo::AUTOSELECTED
The content has been selected as dependency.
Definition: tcp_content.h:63
NetworkContentSocketHandler::~NetworkContentSocketHandler
virtual ~NetworkContentSocketHandler()
On destructing of this class, the socket needs to be closed.
Definition: tcp_content.h:207
ContentID
ContentID
Unique identifier for the content.
Definition: tcp_content.h:53
ContentInfo::UNSELECTED
The content has not been selected.
Definition: tcp_content.h:61
PACKET_CONTENT_CLIENT_INFO_ID
Queries the content server for information about a list of internal IDs.
Definition: tcp_content.h:43
ContentInfo::DOES_NOT_EXIST
The content does not exist in the content system.
Definition: tcp_content.h:65
ContentInfo::name
char name[32]
Name of the content.
Definition: tcp_content.h:73
CONTENT_TYPE_GAME
The content consists of a game script.
Definition: tcp_content.h:35
ContentInfo::INVALID
The content&#39;s invalid.
Definition: tcp_content.h:66
ContentInfo::tag_count
uint8 tag_count
Number of tags.
Definition: tcp_content.h:81
ContentInfo::version
char version[16]
Version of the content.
Definition: tcp_content.h:74
GetContentInfoSubDir
Subdirectory GetContentInfoSubDir(ContentType type)
Helper to get the subdirectory a ContentInfo is located in.
Definition: tcp_content.cpp:249
PACKET_CONTENT_SERVER_INFO
Reply of content server with information about content.
Definition: tcp_content.h:46
ContentInfo::Size
size_t Size() const
Get the size of the data as send over the network.
Definition: tcp_content.cpp:61
ContentInfo::ALREADY_HERE
The content is already at the client side.
Definition: tcp_content.h:64
ContentInfo::id
ContentID id
Unique (server side) ID for the content.
Definition: tcp_content.h:70
ContentInfo::ContentInfo
ContentInfo()
Clear everything in the struct.
Definition: tcp_content.cpp:30
ContentInfo::state
State state
Whether the content info is selected (for download)
Definition: tcp_content.h:83
ContentInfo::TransferFrom
void TransferFrom(ContentInfo *other)
Copy data from other ContentInfo and take ownership of allocated stuff.
Definition: tcp_content.cpp:46
TextfileType
TextfileType
Additional text files accompanying Tar archives.
Definition: textfile_type.h:16
PACKET_CONTENT_CLIENT_INFO_LIST
Queries the content server for a list of info of a given content type.
Definition: tcp_content.h:42
ContentInfo::md5sum
byte md5sum[16]
The MD5 checksum.
Definition: tcp_content.h:78
CONTENT_TYPE_GAME_LIBRARY
The content consists of a GS library.
Definition: tcp_content.h:36
CONTENT_TYPE_NEWGRF
The content consists of a NewGRF.
Definition: tcp_content.h:28
ContentType
ContentType
The values in the enum are important; they are used as database &#39;keys&#39;.
Definition: tcp_content.h:25
PacketContentType
PacketContentType
Enum with all types of TCP content packets.
Definition: tcp_content.h:41
NetworkContentSocketHandler::client_addr
NetworkAddress client_addr
The address we&#39;re connected to.
Definition: tcp_content.h:102
PACKET_CONTENT_CLIENT_INFO_EXTID_MD5
Queries the content server for information about a list of external IDs and MD5.
Definition: tcp_content.h:45
CONTENT_TYPE_AI_LIBRARY
The content consists of an AI library.
Definition: tcp_content.h:30
INVALID_CONTENT_ID
Sentinel for invalid content.
Definition: tcp_content.h:54
PACKET_CONTENT_CLIENT_CONTENT
Request a content file given an internal ID.
Definition: tcp_content.h:47
ContentInfo::~ContentInfo
~ContentInfo()
Free everything allocated.
Definition: tcp_content.cpp:36
CONTENT_TYPE_HEIGHTMAP
The content consists of a heightmap.
Definition: tcp_content.h:32
CONTENT_TYPE_AI
The content consists of an AI.
Definition: tcp_content.h:29
ContentInfo::GetTextfile
const char * GetTextfile(TextfileType type) const
Search a textfile file next to this file in the content list.
Definition: tcp_content.cpp:105
ContentInfo::type
ContentType type
Type of content.
Definition: tcp_content.h:69
ContentInfo::upgrade
bool upgrade
This item is an upgrade.
Definition: tcp_content.h:84
CONTENT_TYPE_BEGIN
Helper to mark the begin of the types.
Definition: tcp_content.h:26
CONTENT_TYPE_BASE_MUSIC
The content consists of base music.
Definition: tcp_content.h:34
packet.h
Basic functions to create, fill and read packets.
ContentInfo::SELECTED
The content has been manually selected.
Definition: tcp_content.h:62
NetworkContentSocketHandler::NetworkContentSocketHandler
NetworkContentSocketHandler(SOCKET s=INVALID_SOCKET, const NetworkAddress &address=NetworkAddress())
Create a new cs socket handler for a given cs.
Definition: tcp_content.h:200
tcp.h
Basic functions to receive and send TCP packets.
ContentInfo::url
char url[96]
URL related to the content.
Definition: tcp_content.h:75
PACKET_CONTENT_END
Must ALWAYS be on the end of this list!! (period)
Definition: tcp_content.h:49
ContentInfo::description
char description[512]
Description of the content.
Definition: tcp_content.h:76
ContentInfo
Container for all important information about a piece of content.
Definition: tcp_content.h:58
ContentInfo::IsValid
bool IsValid() const
Is the information from this content info valid?
Definition: tcp_content.cpp:94
PACKET_CONTENT_SERVER_CONTENT
Reply with the content of the given ID.
Definition: tcp_content.h:48
CONTENT_TYPE_BASE_SOUNDS
The content consists of base sounds.
Definition: tcp_content.h:33