/**************************************************************************** * apps/netutils/ftpc/ftpc_internal.h * * Copyright (C) 2011, 2014 Gregory Nutt. All rights reserved. * Author: Gregory Nutt * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * 3. Neither the name NuttX nor the names of its contributors may be * used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. * ****************************************************************************/ #ifndef __APPS_NETUTILS_FTPC_FTPC_INTERNAL_H #define __APPS_NETUTILS_FTPC_FTPC_INTERNAL_H /**************************************************************************** * Included Files ****************************************************************************/ #include "ftpc_config.h" #include #include #include #include #include #include #include #include #include "netutils/ftpc.h" /**************************************************************************** * Pre-processor Definitions ****************************************************************************/ /* MISC definitions *********************************************************/ #define ISO_NL 0x0a #define ISO_CR 0x0d /* Telnet-related definitions */ #define TELNET_DM 242 #define TELNET_IP 244 #define TELNET_IAC 255 #define TELNET_WILL 251 #define TELNET_WONT 252 #define TELNET_DO 253 #define TELNET_DONT 254 /* Session flag bits ********************************************************/ #define FTPC_FLAG_PASSIVE (1 << 0) /* Passive mode requested */ #define FTPC_SESSION_FLAGS (0x0001) /* Persist throughout the session */ #define FTPC_FLAG_CONNECTED (1 << 1) /* Connected to host */ #define FTPC_FLAG_LOGGEDIN (1 << 2) /* Logged in to host */ #define FTPC_STATE_FLAGS (0x0006) /* State of connection */ #define FTPC_FLAG_MDTM (1 << 3) /* Host supports MDTM command */ #define FTPC_FLAG_SIZE (1 << 4) /* Host supports SIZE command */ #define FTPC_FLAG_PASV (1 << 5) /* Host supports PASV command */ #define FTPC_FLAG_STOU (1 << 6) /* Host supports STOU command */ #define FTPC_FLAG_CHMOD (1 << 7) /* Host supports SITE CHMOD command */ #define FTPC_FLAG_IDLE (1 << 8) /* Host supports SITE IDLE command */ #define FTPC_HOSTCAP_FLAGS (0x01f8) /* Host capabilities */ #define FTPC_FLAG_INTERRUPT (1 << 9) /* Transfer interrupted */ #define FTPC_FLAG_PUT (1 << 10) /* Transfer is a PUT operation (upload) */ #define FTPC_XFER_FLAGS (0x0600) /* Transfer related */ /* These are the bits to be set/cleared when the flags are reset */ #define FTPC_FLAGS_CLEAR (FTPC_STATE_FLAGS | FTPC_XFER_FLAGS) #define FTPC_FLAGS_SET FTPC_HOSTCAP_FLAGS /* Macros to set bits */ #define FTPC_SET_CONNECTED(s) do { (s)->flags |= FTPC_FLAG_CONNECTED; } while (0) #define FTPC_SET_LOGGEDIN(s) do { (s)->flags |= FTPC_FLAG_LOGGEDIN; } while (0) #define FTPC_SET_MDTM(s) do { (s)->flags |= FTPC_FLAG_MDTM; } while (0) #define FTPC_SET_SIZE(s) do { (s)->flags |= FTPC_FLAG_SIZE; } while (0) #define FTPC_SET_PASV(s) do { (s)->flags |= FTPC_FLAG_PASV; } while (0) #define FTPC_SET_STOU(s) do { (s)->flags |= FTPC_FLAG_STOU; } while (0) #define FTPC_SET_CHMOD(s) do { (s)->flags |= FTPC_FLAG_CHMOD; } while (0) #define FTPC_SET_IDLE(s) do { (s)->flags |= FTPC_FLAG_IDLE; } while (0) #define FTPC_SET_INTERRUPT(s) do { (s)->flags |= FTPC_FLAG_INTERRUPT; } while (0) #define FTPC_SET_PUT(s) do { (s)->flags |= FTPC_FLAG_PUT; } while (0) #define FTPC_SET_PASSIVE(s) do { (s)->flags |= FTPC_FLAG_PASSIVE; } while (0) /* Macros to clear bits */ #define FTPC_CLR_CONNECTED(s) do { (s)->flags &= ~FTPC_FLAG_CONNECTED; } while (0) #define FTPC_CLR_LOGGEDIN(s) do { (s)->flags &= ~FTPC_FLAG_LOGGEDIN; } while (0) #define FTPC_CLR_MDTM(s) do { (s)->flags &= ~FTPC_FLAG_MDTM; } while (0) #define FTPC_CLR_SIZE(s) do { (s)->flags &= ~FTPC_FLAG_SIZE; } while (0) #define FTPC_CLR_PASV(s) do { (s)->flags &= ~FTPC_FLAG_PASV; } while (0) #define FTPC_CLR_STOU(s) do { (s)->flags &= ~FTPC_FLAG_STOU; } while (0) #define FTPC_CLR_CHMOD(s) do { (s)->flags &= ~FTPC_FLAG_CHMOD; } while (0) #define FTPC_CLR_IDLE(s) do { (s)->flags &= ~FTPC_FLAG_IDLE; } while (0) #define FTPC_CLR_INTERRUPT(s) do { (s)->flags &= ~FTPC_FLAG_INTERRUPT; } while (0) #define FTPC_CLR_PUT(s) do { (s)->flags &= ~FTPC_FLAG_PUT; } while (0) #define FTPC_CLR_PASSIVE(s) do { (s)->flags &= ~FTPC_FLAG_PASSIVE; } while (0) /* Macros to test bits */ #define FTPC_IS_CONNECTED(s) (((s)->flags & FTPC_FLAG_CONNECTED) != 0) #define FTPC_IS_LOGGEDIN(s) (((s)->flags & FTPC_FLAG_LOGGEDIN) != 0) #define FTPC_HAS_MDTM(s) (((s)->flags & FTPC_FLAG_MDTM) != 0) #define FTPC_HAS_SIZE(s) (((s)->flags & FTPC_FLAG_SIZE) != 0) #define FTPC_HAS_PASV(s) (((s)->flags & FTPC_FLAG_PASV) != 0) #define FTPC_HAS_STOU(s) (((s)->flags & FTPC_FLAG_STOU) != 0) #define FTPC_HAS_CHMOD(s) (((s)->flags & FTPC_FLAG_CHMOD) != 0) #define FTPC_HAS_IDLE(s) (((s)->flags & FTPC_FLAG_IDLE) != 0) #define FTPC_INTERRUPTED(s) (((s)->flags & FTPC_FLAG_INTERRUPT) != 0) #define FTPC_IS_PUT(s) (((s)->flags & FTPC_FLAG_PUT) != 0) #define FTPC_IS_PASSIVE(s) (((s)->flags & FTPC_FLAG_PASSIVE) != 0) /**************************************************************************** * Public Types ****************************************************************************/ /* This structure represents the state of one socket connection */ struct ftpc_socket_s { int sd; /* Socket descriptor */ FILE *instream; /* Incoming stream */ FILE *outstream; /* Outgoing stream */ union ftpc_sockaddr_u laddr; /* Local Address */ bool connected; /* True: socket is connected */ }; /* This structure represents the state of an FTP connection */ struct ftpc_session_s { union ftpc_sockaddr_u server; /* Server/proxy socket address */ struct ftpc_socket_s cmd; /* FTP command channel */ struct ftpc_socket_s data; /* FTP data channel */ struct ftpc_socket_s dacceptor; /* FTP data listener (accepts data connection in active mode) */ struct wdog_s wdog; /* Timer */ FAR char *uname; /* Login uname */ FAR char *pwd; /* Login pwd */ FAR char *initrdir; /* Initial remote directory */ FAR char *homerdir; /* Remote home directory (currdir on startup) */ FAR char *currdir; /* Remote current directory */ FAR char *homeldir; /* Local home directory (PWD on startup) */ pid_t pid; /* Task ID of FTP client */ uint8_t xfrmode; /* Previous data transfer type (See FTPC_XFRMODE_* defines) */ uint16_t flags; /* Connection flags (see FTPC_FLAGS_* defines) */ uint16_t code; /* Last 3-digit reply code */ uint32_t replytimeo; /* Server reply timeout (ticks) */ uint32_t conntimeo; /* Connection timeout (ticks) */ off_t offset; /* Transfer file offset */ off_t size; /* Number of bytes transferred */ char reply[CONFIG_FTP_MAXREPLY + 1]; /* Last reply string from server */ char buffer[CONFIG_FTP_BUFSIZE]; /* Used to buffer file data during transfers */ }; /* There is not yet any want to change the local working directly (an lcd * command), but the following definition is provided to reserve the name * for the storage location for the local current working directory. */ #define curldir homeldir /**************************************************************************** * Public Data ****************************************************************************/ #ifdef __cplusplus #define EXTERN extern "C" extern "C" { #else #define EXTERN extern #endif /**************************************************************************** * Inline Functions/Function-like Macros ****************************************************************************/ #define ftpc_sockconnected(s) \ ((s) && (s)->connected) #define ftpc_connected(s) \ (FTPC_IS_CONNECTED(session) && ftpc_sockconnected(&session->cmd)) #define ftpc_loggedin(s) \ (ftpc_connected(s) && FTPC_IS_LOGGEDIN(s)) #define ftpc_sockgetc(s) \ fgetc((s)->instream) #define ftpc_sockflush(s) \ fflush((s)->outstream) #define ftpc_sockvprintf(s,f,ap) \ vfprintf((s)->outstream,f,ap) /**************************************************************************** * Public Function Prototypes ****************************************************************************/ /* Low-level string management */ EXTERN void ftpc_stripcrlf(FAR char *str); EXTERN void ftpc_stripslash(FAR char *str); EXTERN FAR char *ftpc_dequote(FAR const char *hostname); /* Connection helpers */ EXTERN int ftpc_reconnect(FAR struct ftpc_session_s *session); EXTERN int ftpc_relogin(FAR struct ftpc_session_s *session); /* FTP helpers */ EXTERN void ftpc_reset(struct ftpc_session_s *session); EXTERN int ftpc_cmd(struct ftpc_session_s *session, const char *cmd, ...); EXTERN int fptc_getreply(struct ftpc_session_s *session); EXTERN FAR const char *ftpc_lpwd(void); EXTERN int ftpc_xfrmode(struct ftpc_session_s *session, uint8_t xfrmode); EXTERN FAR char *ftpc_absrpath(FAR struct ftpc_session_s *session, FAR const char *relpath); EXTERN FAR char *ftpc_abslpath(FAR struct ftpc_session_s *session, FAR const char *relpath); /* Socket helpers */ EXTERN int ftpc_sockinit(FAR struct ftpc_socket_s *sock, sa_family_t family); EXTERN void ftpc_sockclose(FAR struct ftpc_socket_s *sock); EXTERN int ftpc_sockconnect(FAR struct ftpc_socket_s *sock, FAR struct sockaddr *addr); EXTERN int ftpc_sockgetsockname(FAR struct ftpc_socket_s *sock, FAR union ftpc_sockaddr_u *addr); EXTERN int ftpc_sockaccept(FAR struct ftpc_socket_s *acceptor, FAR struct ftpc_socket_s *sock); EXTERN int ftpc_socklisten(FAR struct ftpc_socket_s *sock); EXTERN void ftpc_sockcopy(FAR struct ftpc_socket_s *dest, FAR const struct ftpc_socket_s *src); /* Socket I/O helpers */ EXTERN int ftpc_sockprintf(FAR struct ftpc_socket_s *sock, const char *fmt, ...); EXTERN void ftpc_timeout(wdparm_t arg); /* Transfer helpers */ EXTERN int ftpc_xfrinit(FAR struct ftpc_session_s *session); EXTERN int ftpc_recvtext(FAR struct ftpc_session_s *session, FAR FILE *rinstream, FAR FILE *loutstream); EXTERN int ftpc_waitdata(FAR struct ftpc_session_s *session, FAR FILE *stream, bool rdwait); EXTERN void ftpc_xfrreset(struct ftpc_session_s *session); EXTERN int ftpc_xfrabort(FAR struct ftpc_session_s *session, FAR FILE *stream); #undef EXTERN #ifdef __cplusplus } #endif #endif /* __APPS_NETUTILS_FTPC_FTPC_INTERNAL_H */