SFML - Simple and Fast Multimedia Library

SFML 2.6.2
Loading...
Searching...
No Matches
Ftp.hpp
Go to the documentation of this file.
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2023 Laurent Gomila (laurent@sfml-dev.org)
5//
6// This software is provided 'as-is', without any express or implied warranty.
7// In no event will the authors be held liable for any damages arising from the use of this software.
8//
9// Permission is granted to anyone to use this software for any purpose,
10// including commercial applications, and to alter it and redistribute it freely,
11// subject to the following restrictions:
12//
13// 1. The origin of this software must not be misrepresented;
14// you must not claim that you wrote the original software.
15// If you use this software in a product, an acknowledgment
16// in the product documentation would be appreciated but is not required.
17//
18// 2. Altered source versions must be plainly marked as such,
19// and must not be misrepresented as being the original software.
20//
21// 3. This notice may not be removed or altered from any source distribution.
22//
24
25#ifndef SFML_FTP_HPP
26#define SFML_FTP_HPP
27
29// Headers
31#include <SFML/Network/Export.hpp>
32#include <SFML/Network/TcpSocket.hpp>
33#include <SFML/System/NonCopyable.hpp>
34#include <SFML/System/Time.hpp>
35#include <string>
36#include <vector>
37
38
39namespace sf
40{
41class IpAddress;
42
47 class SFML_NETWORK_API Ftp : NonCopyable
48{
49public:
50
55 enum TransferMode
56 {
57 Binary,
58 Ascii,
59 Ebcdic
60 };
61
66 class SFML_NETWORK_API Response
67 {
68 public:
69
74 enum Status
75 {
76 // 1xx: the requested action is being initiated,
77 // expect another reply before proceeding with a new command
78 RestartMarkerReply = 110,
79 ServiceReadySoon = 120,
80 DataConnectionAlreadyOpened = 125,
81 OpeningDataConnection = 150,
82
83 // 2xx: the requested action has been successfully completed
84 Ok = 200,
85 PointlessCommand = 202,
86 SystemStatus = 211,
87 DirectoryStatus = 212,
88 FileStatus = 213,
89 HelpMessage = 214,
90 SystemType = 215,
91 ServiceReady = 220,
92 ClosingConnection = 221,
93 DataConnectionOpened = 225,
94 ClosingDataConnection = 226,
95 EnteringPassiveMode = 227,
96 LoggedIn = 230,
97 FileActionOk = 250,
98 DirectoryOk = 257,
99
100 // 3xx: the command has been accepted, but the requested action
101 // is dormant, pending receipt of further information
102 NeedPassword = 331,
103 NeedAccountToLogIn = 332,
104 NeedInformation = 350,
105
106 // 4xx: the command was not accepted and the requested action did not take place,
107 // but the error condition is temporary and the action may be requested again
108 ServiceUnavailable = 421,
109 DataConnectionUnavailable = 425,
110 TransferAborted = 426,
111 FileActionAborted = 450,
112 LocalError = 451,
113 InsufficientStorageSpace = 452,
114
115 // 5xx: the command was not accepted and
116 // the requested action did not take place
117 CommandUnknown = 500,
118 ParametersUnknown = 501,
119 CommandNotImplemented = 502,
120 BadCommandSequence = 503,
121 ParameterNotImplemented = 504,
122 NotLoggedIn = 530,
123 NeedAccountToStore = 532,
124 FileUnavailable = 550,
125 PageTypeUnknown = 551,
126 NotEnoughMemory = 552,
127 FilenameNotAllowed = 553,
128
129 // 10xx: SFML custom codes
130 InvalidResponse = 1000,
131 ConnectionFailed = 1001,
132 ConnectionClosed = 1002,
133 InvalidFile = 1003
134 };
135
146 explicit Response(Status code = InvalidResponse, const std::string& message = "");
147
157 bool isOk() const;
158
165 Status getStatus() const;
166
173 const std::string& getMessage() const;
174
175 private:
176
178 // Member data
180 Status m_status;
181 std::string m_message;
182 };
183
188 class SFML_NETWORK_API DirectoryResponse : public Response
189 {
190 public:
191
198 DirectoryResponse(const Response& response);
199
206 const std::string& getDirectory() const;
207
208 private:
209
211 // Member data
213 std::string m_directory;
214 };
215
216
221 class SFML_NETWORK_API ListingResponse : public Response
222 {
223 public:
224
232 ListingResponse(const Response& response, const std::string& data);
233
240 const std::vector<std::string>& getListing() const;
241
242 private:
243
245 // Member data
247 std::vector<std::string> m_listing;
248 };
249
250
258 ~Ftp();
259
281 Response connect(const IpAddress& server, unsigned short port = 21, Time timeout = Time::Zero);
282
291 Response disconnect();
292
302 Response login();
303
316 Response login(const std::string& name, const std::string& password);
317
327 Response keepAlive();
328
340 DirectoryResponse getWorkingDirectory();
341
357 ListingResponse getDirectoryListing(const std::string& directory = "");
358
371 Response changeDirectory(const std::string& directory);
372
381 Response parentDirectory();
382
396 Response createDirectory(const std::string& name);
397
413 Response deleteDirectory(const std::string& name);
414
429 Response renameFile(const std::string& file, const std::string& newName);
430
446 Response deleteFile(const std::string& name);
447
468 Response download(const std::string& remoteFile, const std::string& localPath, TransferMode mode = Binary);
469
491 Response upload(const std::string& localFile, const std::string& remotePath, TransferMode mode = Binary, bool append = false);
492
509 Response sendCommand(const std::string& command, const std::string& parameter = "");
510
511private:
512
522 Response getResponse();
523
529 class DataChannel;
530
531 friend class DataChannel;
532
534 // Member data
536 TcpSocket m_commandSocket;
537 std::string m_receiveBuffer;
538};
539
540} // namespace sf
541
542
543#endif // SFML_FTP_HPP
544
545
Export.hpp
SFML_NETWORK_API
#define SFML_NETWORK_API
Definition Network/Export.hpp:43
NonCopyable.hpp
TcpSocket.hpp
Time.hpp
sf::Ftp::DirectoryResponse
Specialization of FTP response returning a directory.
Definition Ftp.hpp:189
sf::Ftp::DirectoryResponse::DirectoryResponse
DirectoryResponse(const Response &response)
Default constructor.
sf::Ftp::DirectoryResponse::getDirectory
const std::string & getDirectory() const
Get the directory returned in the response.
sf::Ftp::ListingResponse
Specialization of FTP response returning a filename listing.
Definition Ftp.hpp:222
sf::Ftp::ListingResponse::getListing
const std::vector< std::string > & getListing() const
Return the array of directory/file names.
sf::Ftp::ListingResponse::ListingResponse
ListingResponse(const Response &response, const std::string &data)
Default constructor.
sf::Ftp::Response
Define a FTP response.
Definition Ftp.hpp:67
sf::Ftp::Response::isOk
bool isOk() const
Check if the status code means a success.
sf::Ftp::Response::getStatus
Status getStatus() const
Get the status code of the response.
sf::Ftp::Response::getMessage
const std::string & getMessage() const
Get the full message contained in the response.
sf::Ftp::Response::Response
Response(Status code=InvalidResponse, const std::string &message="")
Default constructor.
sf::Ftp::Response::Status
Status
Status codes possibly returned by a FTP response.
Definition Ftp.hpp:75
sf::Ftp::Response::NeedInformation
@ NeedInformation
Requested file action pending further information.
Definition Ftp.hpp:104
sf::Ftp::Response::FilenameNotAllowed
@ FilenameNotAllowed
Requested action not taken, file name not allowed.
Definition Ftp.hpp:127
sf::Ftp::Response::DirectoryOk
@ DirectoryOk
PATHNAME created.
Definition Ftp.hpp:98
sf::Ftp::Response::RestartMarkerReply
@ RestartMarkerReply
Restart marker reply.
Definition Ftp.hpp:78
sf::Ftp::Response::NeedAccountToStore
@ NeedAccountToStore
Need account for storing files.
Definition Ftp.hpp:123
sf::Ftp::Response::ServiceReadySoon
@ ServiceReadySoon
Service ready in N minutes.
Definition Ftp.hpp:79
sf::Ftp::Response::CommandNotImplemented
@ CommandNotImplemented
Command not implemented.
Definition Ftp.hpp:119
sf::Ftp::Response::PointlessCommand
@ PointlessCommand
Command not implemented.
Definition Ftp.hpp:85
sf::Ftp::Response::FileUnavailable
@ FileUnavailable
Requested action not taken, file unavailable.
Definition Ftp.hpp:124
sf::Ftp::Response::ServiceUnavailable
@ ServiceUnavailable
Service not available, closing control connection.
Definition Ftp.hpp:108
sf::Ftp::Response::EnteringPassiveMode
@ EnteringPassiveMode
Entering passive mode.
Definition Ftp.hpp:95
sf::Ftp::Response::ConnectionFailed
@ ConnectionFailed
Not part of the FTP standard, generated by SFML when the low-level socket connection with the server ...
Definition Ftp.hpp:131
sf::Ftp::Response::LoggedIn
@ LoggedIn
User logged in, proceed. Logged out if appropriate.
Definition Ftp.hpp:96
sf::Ftp::Response::InvalidResponse
@ InvalidResponse
Not part of the FTP standard, generated by SFML when a received response cannot be parsed.
Definition Ftp.hpp:130
sf::Ftp::Response::InsufficientStorageSpace
@ InsufficientStorageSpace
Requested action not taken; insufficient storage space in system, file unavailable.
Definition Ftp.hpp:113
sf::Ftp::Response::DataConnectionUnavailable
@ DataConnectionUnavailable
Can't open data connection.
Definition Ftp.hpp:109
sf::Ftp::Response::CommandUnknown
@ CommandUnknown
Syntax error, command unrecognized.
Definition Ftp.hpp:117
sf::Ftp::Response::SystemType
@ SystemType
NAME system type, where NAME is an official system name from the list in the Assigned Numbers documen...
Definition Ftp.hpp:90
sf::Ftp::Response::OpeningDataConnection
@ OpeningDataConnection
File status ok, about to open data connection.
Definition Ftp.hpp:81
sf::Ftp::Response::TransferAborted
@ TransferAborted
Connection closed, transfer aborted.
Definition Ftp.hpp:110
sf::Ftp::Response::HelpMessage
@ HelpMessage
Help message.
Definition Ftp.hpp:89
sf::Ftp::Response::DirectoryStatus
@ DirectoryStatus
Directory status.
Definition Ftp.hpp:87
sf::Ftp::Response::ParameterNotImplemented
@ ParameterNotImplemented
Command not implemented for that parameter.
Definition Ftp.hpp:121
sf::Ftp::Response::NeedPassword
@ NeedPassword
User name ok, need password.
Definition Ftp.hpp:102
sf::Ftp::Response::SystemStatus
@ SystemStatus
System status, or system help reply.
Definition Ftp.hpp:86
sf::Ftp::Response::NeedAccountToLogIn
@ NeedAccountToLogIn
Need account for login.
Definition Ftp.hpp:103
sf::Ftp::Response::Ok
@ Ok
Command ok.
Definition Ftp.hpp:84
sf::Ftp::Response::ClosingConnection
@ ClosingConnection
Service closing control connection.
Definition Ftp.hpp:92
sf::Ftp::Response::ClosingDataConnection
@ ClosingDataConnection
Closing data connection, requested file action successful.
Definition Ftp.hpp:94
sf::Ftp::Response::BadCommandSequence
@ BadCommandSequence
Bad sequence of commands.
Definition Ftp.hpp:120
sf::Ftp::Response::ConnectionClosed
@ ConnectionClosed
Not part of the FTP standard, generated by SFML when the low-level socket connection is unexpectedly ...
Definition Ftp.hpp:132
sf::Ftp::Response::PageTypeUnknown
@ PageTypeUnknown
Requested action aborted, page type unknown.
Definition Ftp.hpp:125
sf::Ftp::Response::DataConnectionOpened
@ DataConnectionOpened
Data connection open, no transfer in progress.
Definition Ftp.hpp:93
sf::Ftp::Response::LocalError
@ LocalError
Requested action aborted, local error in processing.
Definition Ftp.hpp:112
sf::Ftp::Response::ServiceReady
@ ServiceReady
Service ready for new user.
Definition Ftp.hpp:91
sf::Ftp::Response::FileStatus
@ FileStatus
File status.
Definition Ftp.hpp:88
sf::Ftp::Response::InvalidFile
@ InvalidFile
Not part of the FTP standard, generated by SFML when a local file cannot be read or written.
Definition Ftp.hpp:133
sf::Ftp::Response::NotEnoughMemory
@ NotEnoughMemory
Requested file action aborted, exceeded storage allocation.
Definition Ftp.hpp:126
sf::Ftp::Response::ParametersUnknown
@ ParametersUnknown
Syntax error in parameters or arguments.
Definition Ftp.hpp:118
sf::Ftp::Response::FileActionAborted
@ FileActionAborted
Requested file action not taken.
Definition Ftp.hpp:111
sf::Ftp::Response::FileActionOk
@ FileActionOk
Requested file action ok.
Definition Ftp.hpp:97
sf::Ftp::Response::DataConnectionAlreadyOpened
@ DataConnectionAlreadyOpened
Data connection already opened, transfer starting.
Definition Ftp.hpp:80
sf::Ftp::Response::NotLoggedIn
@ NotLoggedIn
Not logged in.
Definition Ftp.hpp:122
sf::Ftp
A FTP client.
Definition Ftp.hpp:48
sf::Ftp::upload
Response upload(const std::string &localFile, const std::string &remotePath, TransferMode mode=Binary, bool append=false)
Upload a file to the server.
sf::Ftp::TransferMode
TransferMode
Enumeration of transfer modes.
Definition Ftp.hpp:56
sf::Ftp::Binary
@ Binary
Binary mode (file is transfered as a sequence of bytes)
Definition Ftp.hpp:57
sf::Ftp::Ebcdic
@ Ebcdic
Text mode using EBCDIC encoding.
Definition Ftp.hpp:59
sf::Ftp::Ascii
@ Ascii
Text mode using ASCII encoding.
Definition Ftp.hpp:58
sf::Ftp::download
Response download(const std::string &remoteFile, const std::string &localPath, TransferMode mode=Binary)
Download a file from the server.
sf::Ftp::createDirectory
Response createDirectory(const std::string &name)
Create a new directory.
sf::Ftp::deleteDirectory
Response deleteDirectory(const std::string &name)
Remove an existing directory.
sf::Ftp::~Ftp
~Ftp()
Destructor.
sf::Ftp::sendCommand
Response sendCommand(const std::string &command, const std::string &parameter="")
Send a command to the FTP server.
sf::Ftp::login
Response login()
Log in using an anonymous account.
sf::Ftp::getWorkingDirectory
DirectoryResponse getWorkingDirectory()
Get the current working directory.
sf::Ftp::changeDirectory
Response changeDirectory(const std::string &directory)
Change the current working directory.
sf::Ftp::deleteFile
Response deleteFile(const std::string &name)
Remove an existing file.
sf::Ftp::DataChannel
friend class DataChannel
Definition Ftp.hpp:531
sf::Ftp::getDirectoryListing
ListingResponse getDirectoryListing(const std::string &directory="")
Get the contents of the given directory.
sf::Ftp::renameFile
Response renameFile(const std::string &file, const std::string &newName)
Rename an existing file.
sf::Ftp::login
Response login(const std::string &name, const std::string &password)
Log in using a username and a password.
sf::Ftp::keepAlive
Response keepAlive()
Send a null command to keep the connection alive.
sf::Ftp::disconnect
Response disconnect()
Close the connection with the server.
sf::Ftp::parentDirectory
Response parentDirectory()
Go to the parent directory of the current one.
sf::Ftp::connect
Response connect(const IpAddress &server, unsigned short port=21, Time timeout=Time::Zero)
Connect to the specified FTP server.
sf::IpAddress
Encapsulate an IPv4 network address.
Definition IpAddress.hpp:45
sf::NonCopyable::NonCopyable
NonCopyable()
Default constructor.
Definition NonCopyable.hpp:53
sf::TcpSocket
Specialized socket using the TCP protocol.
Definition TcpSocket.hpp:47
sf::Time
Represents a time value.
Definition Time.hpp:41
sf::Time::Zero
static const Time Zero
Predefined "zero" time value.
Definition Time.hpp:85
sf
Definition AlResource.hpp:35