[thirdparty/squid.git] / src / clients / forward.h

/*
 * Copyright (C) 1996-2025 The Squid Software Foundation and contributors
 *
 * Squid software is distributed under GPLv2+ license and includes
 * contributions from numerous individuals and organizations.
 * Please see the COPYING and CONTRIBUTORS files for details.
 */

#ifndef SQUID_SRC_CLIENTS_FORWARD_H
#define SQUID_SRC_CLIENTS_FORWARD_H

#include "sbuf/forward.h"

class FwdState;
class HttpRequest;

namespace Http
{
class Tunneler;
class TunnelerAnswer;
}

namespace Ftp
{

/// A new FTP Gateway job
void StartGateway(FwdState *const fwdState);

/// A new FTP Relay job
void StartRelay(FwdState *const fwdState);

/** Construct an URI with leading / in PATH portion for use by CWD command
 *  possibly others. FTP encodes absolute paths as beginning with '/'
 *  after the initial URI path delimiter, which happens to be / itself.
 *  This makes FTP absolute URI appear as:  ftp:host:port//root/path
 *  To encompass older software which compacts multiple // to / in transit
 *  We use standard URI-encoding on the second / making it
 *  ftp:host:port/%2froot/path  AKA 'the FTP %2f hack'.
 *
 * TODO: Should be an AnyP::Uri member
 */
const SBuf &UrlWith2f(HttpRequest *);

} // namespace Ftp

#endif /* SQUID_SRC_CLIENTS_FORWARD_H */
Commit	Line	Data
	1	/*
	2	* Copyright (C) 1996-2025 The Squid Software Foundation and contributors
	3	*
	4	* Squid software is distributed under GPLv2+ license and includes
	5	* contributions from numerous individuals and organizations.
	6	* Please see the COPYING and CONTRIBUTORS files for details.
	7	*/
	8
	9	#ifndef SQUID_SRC_CLIENTS_FORWARD_H
	10	#define SQUID_SRC_CLIENTS_FORWARD_H
	11
	12	#include "sbuf/forward.h"
	13
	14	class FwdState;
	15	class HttpRequest;
	16
	17	namespace Http
	18	{
	19	class Tunneler;
	20	class TunnelerAnswer;
	21	}
	22
	23	namespace Ftp
	24	{
	25
	26	/// A new FTP Gateway job
	27	void StartGateway(FwdState *const fwdState);
	28
	29	/// A new FTP Relay job
	30	void StartRelay(FwdState *const fwdState);
	31
	32	/** Construct an URI with leading / in PATH portion for use by CWD command
	33	* possibly others. FTP encodes absolute paths as beginning with '/'
	34	* after the initial URI path delimiter, which happens to be / itself.
	35	* This makes FTP absolute URI appear as: ftp:host:port//root/path
	36	* To encompass older software which compacts multiple // to / in transit
	37	* We use standard URI-encoding on the second / making it
	38	* ftp:host:port/%2froot/path AKA 'the FTP %2f hack'.
	39	*
	40	* TODO: Should be an AnyP::Uri member
	41	*/
	42	const SBuf &UrlWith2f(HttpRequest *);
	43
	44	} // namespace Ftp
	45
	46	#endif /* SQUID_SRC_CLIENTS_FORWARD_H */
	47